lib/odp-util.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include <arpa/inet.h>
  19 #include "odp-util.h"
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <math.h>
  23 #include <netinet/in.h>
  24 #include <netinet/icmp6.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include "byte-order.h"
  28 #include "coverage.h"
  29 #include "dynamic-string.h"
  30 #include "flow.h"
  31 #include "netlink.h"
  32 #include "ofpbuf.h"
  33 #include "packets.h"
  34 #include "simap.h"
  35 #include "timeval.h"
  36 #include "util.h"
  37 #include "vlog.h"
  38
  39 VLOG_DEFINE_THIS_MODULE(odp_util);
  40
  41 /* The interface between userspace and kernel uses an "OVS_*" prefix.
  42  * Since this is fairly non-specific for the OVS userspace components,
  43  * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
  44  * interactions with the datapath.
  45  */
  46
  47 /* The set of characters that may separate one action or one key attribute
  48  * from another. */
  49 static const char *delimiters = ", \t\r\n";
  50
  51 static int parse_odp_key_mask_attr(const char *, const struct simap *port_names,
  52                               struct ofpbuf *, struct ofpbuf *);
  53 static void format_odp_key_attr(const struct nlattr *a,
  54                                 const struct nlattr *ma, struct ds *ds);
  55
  56 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
  57  * 'type':
  58  *
  59  *   - For an action whose argument has a fixed length, returned that
  60  *     nonnegative length in bytes.
  61  *
  62  *   - For an action with a variable-length argument, returns -2.
  63  *
  64  *   - For an invalid 'type', returns -1. */
  65 static int
  66 odp_action_len(uint16_t type)
  67 {
  68     if (type > OVS_ACTION_ATTR_MAX) {
  69         return -1;
  70     }
  71
  72     switch ((enum ovs_action_attr) type) {
  73     case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
  74     case OVS_ACTION_ATTR_USERSPACE: return -2;
  75     case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
  76     case OVS_ACTION_ATTR_POP_VLAN: return 0;
  77     case OVS_ACTION_ATTR_PUSH_MPLS: return sizeof(struct ovs_action_push_mpls);
  78     case OVS_ACTION_ATTR_POP_MPLS: return sizeof(ovs_be16);
  79     case OVS_ACTION_ATTR_SET: return -2;
  80     case OVS_ACTION_ATTR_SAMPLE: return -2;
  81
  82     case OVS_ACTION_ATTR_UNSPEC:
  83     case __OVS_ACTION_ATTR_MAX:
  84         return -1;
  85     }
  86
  87     return -1;
  88 }
  89
  90 /* Returns a string form of 'attr'.  The return value is either a statically
  91  * allocated constant string or the 'bufsize'-byte buffer 'namebuf'.  'bufsize'
  92  * should be at least OVS_KEY_ATTR_BUFSIZE. */
  93 enum { OVS_KEY_ATTR_BUFSIZE = 3 + INT_STRLEN(unsigned int) + 1 };
  94 static const char *
  95 ovs_key_attr_to_string(enum ovs_key_attr attr, char *namebuf, size_t bufsize)
  96 {
  97     switch (attr) {
  98     case OVS_KEY_ATTR_UNSPEC: return "unspec";
  99     case OVS_KEY_ATTR_ENCAP: return "encap";
 100     case OVS_KEY_ATTR_PRIORITY: return "skb_priority";
 101     case OVS_KEY_ATTR_SKB_MARK: return "skb_mark";
 102     case OVS_KEY_ATTR_TUNNEL: return "tunnel";
 103     case OVS_KEY_ATTR_IN_PORT: return "in_port";
 104     case OVS_KEY_ATTR_ETHERNET: return "eth";
 105     case OVS_KEY_ATTR_VLAN: return "vlan";
 106     case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
 107     case OVS_KEY_ATTR_IPV4: return "ipv4";
 108     case OVS_KEY_ATTR_IPV6: return "ipv6";
 109     case OVS_KEY_ATTR_TCP: return "tcp";
 110     case OVS_KEY_ATTR_UDP: return "udp";
 111     case OVS_KEY_ATTR_ICMP: return "icmp";
 112     case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
 113     case OVS_KEY_ATTR_ARP: return "arp";
 114     case OVS_KEY_ATTR_ND: return "nd";
 115     case OVS_KEY_ATTR_MPLS: return "mpls";
 116
 117     case __OVS_KEY_ATTR_MAX:
 118     default:
 119         snprintf(namebuf, bufsize, "key%u", (unsigned int) attr);
 120         return namebuf;
 121     }
 122 }
 123
 124 static void
 125 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
 126 {
 127     size_t len = nl_attr_get_size(a);
 128
 129     ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
 130     if (len) {
 131         const uint8_t *unspec;
 132         unsigned int i;
 133
 134         unspec = nl_attr_get(a);
 135         for (i = 0; i < len; i++) {
 136             ds_put_char(ds, i ? ' ': '(');
 137             ds_put_format(ds, "%02x", unspec[i]);
 138         }
 139         ds_put_char(ds, ')');
 140     }
 141 }
 142
 143 static void
 144 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
 145 {
 146     static const struct nl_policy ovs_sample_policy[] = {
 147         [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
 148         [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
 149     };
 150     struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
 151     double percentage;
 152     const struct nlattr *nla_acts;
 153     int len;
 154
 155     ds_put_cstr(ds, "sample");
 156
 157     if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
 158         ds_put_cstr(ds, "(error)");
 159         return;
 160     }
 161
 162     percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
 163                         UINT32_MAX;
 164
 165     ds_put_format(ds, "(sample=%.1f%%,", percentage);
 166
 167     ds_put_cstr(ds, "actions(");
 168     nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
 169     len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
 170     format_odp_actions(ds, nla_acts, len);
 171     ds_put_format(ds, "))");
 172 }
 173
 174 static const char *
 175 slow_path_reason_to_string(enum slow_path_reason reason)
 176 {
 177     switch (reason) {
 178     case SLOW_CFM:
 179         return "cfm";
 180     case SLOW_LACP:
 181         return "lacp";
 182     case SLOW_STP:
 183         return "stp";
 184     case SLOW_BFD:
 185         return "bfd";
 186     case SLOW_CONTROLLER:
 187         return "controller";
 188     case __SLOW_MAX:
 189     default:
 190         return NULL;
 191     }
 192 }
 193
 194 static enum slow_path_reason
 195 string_to_slow_path_reason(const char *string)
 196 {
 197     enum slow_path_reason i;
 198
 199     for (i = 1; i < __SLOW_MAX; i++) {
 200         if (!strcmp(string, slow_path_reason_to_string(i))) {
 201             return i;
 202         }
 203     }
 204
 205     return 0;
 206 }
 207
 208 static int
 209 parse_flags(const char *s, const char *(*bit_to_string)(uint32_t),
 210             uint32_t *res)
 211 {
 212     uint32_t result = 0;
 213     int n = 0;
 214
 215     if (s[n] != '(') {
 216         return -EINVAL;
 217     }
 218     n++;
 219
 220     while (s[n] != ')') {
 221         unsigned long long int flags;
 222         uint32_t bit;
 223         int n0;
 224
 225         if (sscanf(&s[n], "%lli%n", &flags, &n0) > 0 && n0 > 0) {
 226             n += n0 + (s[n + n0] == ',');
 227             result |= flags;
 228             continue;
 229         }
 230
 231         for (bit = 1; bit; bit <<= 1) {
 232             const char *name = bit_to_string(bit);
 233             size_t len;
 234
 235             if (!name) {
 236                 continue;
 237             }
 238
 239             len = strlen(name);
 240             if (!strncmp(s + n, name, len) &&
 241                 (s[n + len] == ',' || s[n + len] == ')')) {
 242                 result |= bit;
 243                 n += len + (s[n + len] == ',');
 244                 break;
 245             }
 246         }
 247
 248         if (!bit) {
 249             return -EINVAL;
 250         }
 251     }
 252     n++;
 253
 254     *res = result;
 255     return n;
 256 }
 257
 258 static void
 259 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
 260 {
 261     static const struct nl_policy ovs_userspace_policy[] = {
 262         [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
 263         [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_UNSPEC,
 264                                           .optional = true },
 265     };
 266     struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
 267     const struct nlattr *userdata_attr;
 268
 269     if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
 270         ds_put_cstr(ds, "userspace(error)");
 271         return;
 272     }
 273
 274     ds_put_format(ds, "userspace(pid=%"PRIu32,
 275                   nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
 276
 277     userdata_attr = a[OVS_USERSPACE_ATTR_USERDATA];
 278
 279     if (userdata_attr) {
 280         const uint8_t *userdata = nl_attr_get(userdata_attr);
 281         size_t userdata_len = nl_attr_get_size(userdata_attr);
 282         bool userdata_unspec = true;
 283         union user_action_cookie cookie;
 284
 285         if (userdata_len >= sizeof cookie.type
 286             && userdata_len <= sizeof cookie) {
 287
 288             memset(&cookie, 0, sizeof cookie);
 289             memcpy(&cookie, userdata, userdata_len);
 290
 291             userdata_unspec = false;
 292
 293             if (userdata_len == sizeof cookie.sflow
 294                 && cookie.type == USER_ACTION_COOKIE_SFLOW) {
 295                 ds_put_format(ds, ",sFlow("
 296                               "vid=%"PRIu16",pcp=%"PRIu8",output=%"PRIu32")",
 297                               vlan_tci_to_vid(cookie.sflow.vlan_tci),
 298                               vlan_tci_to_pcp(cookie.sflow.vlan_tci),
 299                               cookie.sflow.output);
 300             } else if (userdata_len == sizeof cookie.slow_path
 301                        && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
 302                 const char *reason;
 303                 reason = slow_path_reason_to_string(cookie.slow_path.reason);
 304                 reason = reason ? reason : "";
 305                 ds_put_format(ds, ",slow_path(%s)", reason);
 306             } else if (userdata_len == sizeof cookie.flow_sample
 307                        && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
 308                 ds_put_format(ds, ",flow_sample(probability=%"PRIu16
 309                               ",collector_set_id=%"PRIu32
 310                               ",obs_domain_id=%"PRIu32
 311                               ",obs_point_id=%"PRIu32")",
 312                               cookie.flow_sample.probability,
 313                               cookie.flow_sample.collector_set_id,
 314                               cookie.flow_sample.obs_domain_id,
 315                               cookie.flow_sample.obs_point_id);
 316             } else if (userdata_len == sizeof cookie.ipfix
 317                        && cookie.type == USER_ACTION_COOKIE_IPFIX) {
 318                 ds_put_format(ds, ",ipfix");
 319             } else {
 320                 userdata_unspec = true;
 321             }
 322         }
 323
 324         if (userdata_unspec) {
 325             size_t i;
 326             ds_put_format(ds, ",userdata(");
 327             for (i = 0; i < userdata_len; i++) {
 328                 ds_put_format(ds, "%02x", userdata[i]);
 329             }
 330             ds_put_char(ds, ')');
 331         }
 332     }
 333
 334     ds_put_char(ds, ')');
 335 }
 336
 337 static void
 338 format_vlan_tci(struct ds *ds, ovs_be16 vlan_tci)
 339 {
 340     ds_put_format(ds, "vid=%"PRIu16",pcp=%d",
 341                   vlan_tci_to_vid(vlan_tci),
 342                   vlan_tci_to_pcp(vlan_tci));
 343     if (!(vlan_tci & htons(VLAN_CFI))) {
 344         ds_put_cstr(ds, ",cfi=0");
 345     }
 346 }
 347
 348 static void
 349 format_mpls_lse(struct ds *ds, ovs_be32 mpls_lse)
 350 {
 351     ds_put_format(ds, "label=%"PRIu32",tc=%d,ttl=%d,bos=%d",
 352                   mpls_lse_to_label(mpls_lse),
 353                   mpls_lse_to_tc(mpls_lse),
 354                   mpls_lse_to_ttl(mpls_lse),
 355                   mpls_lse_to_bos(mpls_lse));
 356 }
 357
 358 static void
 359 format_mpls(struct ds *ds, const struct ovs_key_mpls *mpls_key,
 360             const struct ovs_key_mpls *mpls_mask)
 361 {
 362     ovs_be32 key = mpls_key->mpls_lse;
 363
 364     if (mpls_mask == NULL) {
 365         format_mpls_lse(ds, key);
 366     } else {
 367         ovs_be32 mask = mpls_mask->mpls_lse;
 368
 369         ds_put_format(ds, "label=%"PRIu32"/0x%x,tc=%d/%x,ttl=%d/0x%x,bos=%d/%x",
 370                   mpls_lse_to_label(key), mpls_lse_to_label(mask),
 371                   mpls_lse_to_tc(key), mpls_lse_to_tc(mask),
 372                   mpls_lse_to_ttl(key), mpls_lse_to_ttl(mask),
 373                   mpls_lse_to_bos(key), mpls_lse_to_bos(mask));
 374     }
 375 }
 376
 377 static void
 378 format_odp_action(struct ds *ds, const struct nlattr *a)
 379 {
 380     int expected_len;
 381     enum ovs_action_attr type = nl_attr_type(a);
 382     const struct ovs_action_push_vlan *vlan;
 383
 384     expected_len = odp_action_len(nl_attr_type(a));
 385     if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
 386         ds_put_format(ds, "bad length %zu, expected %d for: ",
 387                       nl_attr_get_size(a), expected_len);
 388         format_generic_odp_action(ds, a);
 389         return;
 390     }
 391
 392     switch (type) {
 393     case OVS_ACTION_ATTR_OUTPUT:
 394         ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
 395         break;
 396     case OVS_ACTION_ATTR_USERSPACE:
 397         format_odp_userspace_action(ds, a);
 398         break;
 399     case OVS_ACTION_ATTR_SET:
 400         ds_put_cstr(ds, "set(");
 401         format_odp_key_attr(nl_attr_get(a), NULL, ds);
 402         ds_put_cstr(ds, ")");
 403         break;
 404     case OVS_ACTION_ATTR_PUSH_VLAN:
 405         vlan = nl_attr_get(a);
 406         ds_put_cstr(ds, "push_vlan(");
 407         if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
 408             ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
 409         }
 410         format_vlan_tci(ds, vlan->vlan_tci);
 411         ds_put_char(ds, ')');
 412         break;
 413     case OVS_ACTION_ATTR_POP_VLAN:
 414         ds_put_cstr(ds, "pop_vlan");
 415         break;
 416     case OVS_ACTION_ATTR_PUSH_MPLS: {
 417         const struct ovs_action_push_mpls *mpls = nl_attr_get(a);
 418         ds_put_cstr(ds, "push_mpls(");
 419         format_mpls_lse(ds, mpls->mpls_lse);
 420         ds_put_format(ds, ",eth_type=0x%"PRIx16")", ntohs(mpls->mpls_ethertype));
 421         break;
 422     }
 423     case OVS_ACTION_ATTR_POP_MPLS: {
 424         ovs_be16 ethertype = nl_attr_get_be16(a);
 425         ds_put_format(ds, "pop_mpls(eth_type=0x%"PRIx16")", ntohs(ethertype));
 426         break;
 427     }
 428     case OVS_ACTION_ATTR_SAMPLE:
 429         format_odp_sample_action(ds, a);
 430         break;
 431     case OVS_ACTION_ATTR_UNSPEC:
 432     case __OVS_ACTION_ATTR_MAX:
 433     default:
 434         format_generic_odp_action(ds, a);
 435         break;
 436     }
 437 }
 438
 439 void
 440 format_odp_actions(struct ds *ds, const struct nlattr *actions,
 441                    size_t actions_len)
 442 {
 443     if (actions_len) {
 444         const struct nlattr *a;
 445         unsigned int left;
 446
 447         NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
 448             if (a != actions) {
 449                 ds_put_char(ds, ',');
 450             }
 451             format_odp_action(ds, a);
 452         }
 453         if (left) {
 454             int i;
 455
 456             if (left == actions_len) {
 457                 ds_put_cstr(ds, "<empty>");
 458             }
 459             ds_put_format(ds, ",***%u leftover bytes*** (", left);
 460             for (i = 0; i < left; i++) {
 461                 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
 462             }
 463             ds_put_char(ds, ')');
 464         }
 465     } else {
 466         ds_put_cstr(ds, "drop");
 467     }
 468 }
 469
 470 static int
 471 parse_odp_action(const char *s, const struct simap *port_names,
 472                  struct ofpbuf *actions)
 473 {
 474     /* Many of the sscanf calls in this function use oversized destination
 475      * fields because some sscanf() implementations truncate the range of %i
 476      * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
 477      * value of 0x7fff.  The other alternatives are to allow only a single
 478      * radix (e.g. decimal or hexadecimal) or to write more sophisticated
 479      * parsers.
 480      *
 481      * The tun_id parser has to use an alternative approach because there is no
 482      * type larger than 64 bits. */
 483
 484     {
 485         unsigned long long int port;
 486         int n = -1;
 487
 488         if (sscanf(s, "%lli%n", &port, &n) > 0 && n > 0) {
 489             nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
 490             return n;
 491         }
 492     }
 493
 494     if (port_names) {
 495         int len = strcspn(s, delimiters);
 496         struct simap_node *node;
 497
 498         node = simap_find_len(port_names, s, len);
 499         if (node) {
 500             nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, node->data);
 501             return len;
 502         }
 503     }
 504
 505     {
 506         unsigned long long int pid;
 507         unsigned long long int output;
 508         unsigned long long int probability;
 509         unsigned long long int collector_set_id;
 510         unsigned long long int obs_domain_id;
 511         unsigned long long int obs_point_id;
 512         int vid, pcp;
 513         int n = -1;
 514
 515         if (sscanf(s, "userspace(pid=%lli)%n", &pid, &n) > 0 && n > 0) {
 516             odp_put_userspace_action(pid, NULL, 0, actions);
 517             return n;
 518         } else if (sscanf(s, "userspace(pid=%lli,sFlow(vid=%i,"
 519                           "pcp=%i,output=%lli))%n",
 520                           &pid, &vid, &pcp, &output, &n) > 0 && n > 0) {
 521             union user_action_cookie cookie;
 522             uint16_t tci;
 523
 524             tci = vid | (pcp << VLAN_PCP_SHIFT);
 525             if (tci) {
 526                 tci |= VLAN_CFI;
 527             }
 528
 529             cookie.type = USER_ACTION_COOKIE_SFLOW;
 530             cookie.sflow.vlan_tci = htons(tci);
 531             cookie.sflow.output = output;
 532             odp_put_userspace_action(pid, &cookie, sizeof cookie.sflow,
 533                                      actions);
 534             return n;
 535         } else if (sscanf(s, "userspace(pid=%lli,slow_path(%n", &pid, &n) > 0
 536                    && n > 0) {
 537             union user_action_cookie cookie;
 538             char reason[32];
 539
 540             if (s[n] == ')' && s[n + 1] == ')') {
 541                 reason[0] = '\0';
 542                 n += 2;
 543             } else if (sscanf(s + n, "%31[^)]))", reason) > 0) {
 544                 n += strlen(reason) + 2;
 545             } else {
 546                 return -EINVAL;
 547             }
 548
 549             cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
 550             cookie.slow_path.unused = 0;
 551             cookie.slow_path.reason = string_to_slow_path_reason(reason);
 552
 553             if (reason[0] && !cookie.slow_path.reason) {
 554                 return -EINVAL;
 555             }
 556
 557             odp_put_userspace_action(pid, &cookie, sizeof cookie.slow_path,
 558                                      actions);
 559             return n;
 560         } else if (sscanf(s, "userspace(pid=%lli,flow_sample(probability=%lli,"
 561                           "collector_set_id=%lli,obs_domain_id=%lli,"
 562                           "obs_point_id=%lli))%n",
 563                           &pid, &probability, &collector_set_id,
 564                           &obs_domain_id, &obs_point_id, &n) > 0 && n > 0) {
 565             union user_action_cookie cookie;
 566
 567             cookie.type = USER_ACTION_COOKIE_FLOW_SAMPLE;
 568             cookie.flow_sample.probability = probability;
 569             cookie.flow_sample.collector_set_id = collector_set_id;
 570             cookie.flow_sample.obs_domain_id = obs_domain_id;
 571             cookie.flow_sample.obs_point_id = obs_point_id;
 572             odp_put_userspace_action(pid, &cookie, sizeof cookie.flow_sample,
 573                                      actions);
 574             return n;
 575         } else if (sscanf(s, "userspace(pid=%lli,ipfix)%n", &pid, &n) > 0
 576                    && n > 0) {
 577             union user_action_cookie cookie;
 578
 579             cookie.type = USER_ACTION_COOKIE_IPFIX;
 580             odp_put_userspace_action(pid, &cookie, sizeof cookie.ipfix,
 581                                      actions);
 582             return n;
 583         } else if (sscanf(s, "userspace(pid=%lli,userdata(%n", &pid, &n) > 0
 584                    && n > 0) {
 585             struct ofpbuf buf;
 586             char *end;
 587
 588             ofpbuf_init(&buf, 16);
 589             end = ofpbuf_put_hex(&buf, &s[n], NULL);
 590             if (end[0] == ')' && end[1] == ')') {
 591                 odp_put_userspace_action(pid, buf.data, buf.size, actions);
 592                 ofpbuf_uninit(&buf);
 593                 return (end + 2) - s;
 594             }
 595         }
 596     }
 597
 598     if (!strncmp(s, "set(", 4)) {
 599         size_t start_ofs;
 600         int retval;
 601
 602         start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
 603         retval = parse_odp_key_mask_attr(s + 4, port_names, actions, NULL);
 604         if (retval < 0) {
 605             return retval;
 606         }
 607         if (s[retval + 4] != ')') {
 608             return -EINVAL;
 609         }
 610         nl_msg_end_nested(actions, start_ofs);
 611         return retval + 5;
 612     }
 613
 614     {
 615         struct ovs_action_push_vlan push;
 616         int tpid = ETH_TYPE_VLAN;
 617         int vid, pcp;
 618         int cfi = 1;
 619         int n = -1;
 620
 621         if ((sscanf(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n) > 0
 622              && n > 0)
 623             || (sscanf(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
 624                        &vid, &pcp, &cfi, &n) > 0 && n > 0)
 625             || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
 626                        &tpid, &vid, &pcp, &n) > 0 && n > 0)
 627             || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
 628                        &tpid, &vid, &pcp, &cfi, &n) > 0 && n > 0)) {
 629             push.vlan_tpid = htons(tpid);
 630             push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
 631                                   | (pcp << VLAN_PCP_SHIFT)
 632                                   | (cfi ? VLAN_CFI : 0));
 633             nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
 634                               &push, sizeof push);
 635
 636             return n;
 637         }
 638     }
 639
 640     if (!strncmp(s, "pop_vlan", 8)) {
 641         nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
 642         return 8;
 643     }
 644
 645     {
 646         double percentage;
 647         int n = -1;
 648
 649         if (sscanf(s, "sample(sample=%lf%%,actions(%n", &percentage, &n) > 0
 650             && percentage >= 0. && percentage <= 100.0
 651             && n > 0) {
 652             size_t sample_ofs, actions_ofs;
 653             double probability;
 654
 655             probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
 656             sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
 657             nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
 658                            (probability <= 0 ? 0
 659                             : probability >= UINT32_MAX ? UINT32_MAX
 660                             : probability));
 661
 662             actions_ofs = nl_msg_start_nested(actions,
 663                                               OVS_SAMPLE_ATTR_ACTIONS);
 664             for (;;) {
 665                 int retval;
 666
 667                 n += strspn(s + n, delimiters);
 668                 if (s[n] == ')') {
 669                     break;
 670                 }
 671
 672                 retval = parse_odp_action(s + n, port_names, actions);
 673                 if (retval < 0) {
 674                     return retval;
 675                 }
 676                 n += retval;
 677             }
 678             nl_msg_end_nested(actions, actions_ofs);
 679             nl_msg_end_nested(actions, sample_ofs);
 680
 681             return s[n + 1] == ')' ? n + 2 : -EINVAL;
 682         }
 683     }
 684
 685     return -EINVAL;
 686 }
 687
 688 /* Parses the string representation of datapath actions, in the format output
 689  * by format_odp_action().  Returns 0 if successful, otherwise a positive errno
 690  * value.  On success, the ODP actions are appended to 'actions' as a series of
 691  * Netlink attributes.  On failure, no data is appended to 'actions'.  Either
 692  * way, 'actions''s data might be reallocated. */
 693 int
 694 odp_actions_from_string(const char *s, const struct simap *port_names,
 695                         struct ofpbuf *actions)
 696 {
 697     size_t old_size;
 698
 699     if (!strcasecmp(s, "drop")) {
 700         return 0;
 701     }
 702
 703     old_size = actions->size;
 704     for (;;) {
 705         int retval;
 706
 707         s += strspn(s, delimiters);
 708         if (!*s) {
 709             return 0;
 710         }
 711
 712         retval = parse_odp_action(s, port_names, actions);
 713         if (retval < 0 || !strchr(delimiters, s[retval])) {
 714             actions->size = old_size;
 715             return -retval;
 716         }
 717         s += retval;
 718     }
 719
 720     return 0;
 721 }
 722 \f
 723 /* Returns the correct length of the payload for a flow key attribute of the
 724  * specified 'type', -1 if 'type' is unknown, or -2 if the attribute's payload
 725  * is variable length. */
 726 static int
 727 odp_flow_key_attr_len(uint16_t type)
 728 {
 729     if (type > OVS_KEY_ATTR_MAX) {
 730         return -1;
 731     }
 732
 733     switch ((enum ovs_key_attr) type) {
 734     case OVS_KEY_ATTR_ENCAP: return -2;
 735     case OVS_KEY_ATTR_PRIORITY: return 4;
 736     case OVS_KEY_ATTR_SKB_MARK: return 4;
 737     case OVS_KEY_ATTR_TUNNEL: return -2;
 738     case OVS_KEY_ATTR_IN_PORT: return 4;
 739     case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
 740     case OVS_KEY_ATTR_VLAN: return sizeof(ovs_be16);
 741     case OVS_KEY_ATTR_ETHERTYPE: return 2;
 742     case OVS_KEY_ATTR_MPLS: return sizeof(struct ovs_key_mpls);
 743     case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
 744     case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
 745     case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
 746     case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
 747     case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
 748     case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
 749     case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
 750     case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
 751
 752     case OVS_KEY_ATTR_UNSPEC:
 753     case __OVS_KEY_ATTR_MAX:
 754         return -1;
 755     }
 756
 757     return -1;
 758 }
 759
 760 static void
 761 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
 762 {
 763     size_t len = nl_attr_get_size(a);
 764     if (len) {
 765         const uint8_t *unspec;
 766         unsigned int i;
 767
 768         unspec = nl_attr_get(a);
 769         for (i = 0; i < len; i++) {
 770             if (i) {
 771                 ds_put_char(ds, ' ');
 772             }
 773             ds_put_format(ds, "%02x", unspec[i]);
 774         }
 775     }
 776 }
 777
 778 static const char *
 779 ovs_frag_type_to_string(enum ovs_frag_type type)
 780 {
 781     switch (type) {
 782     case OVS_FRAG_TYPE_NONE:
 783         return "no";
 784     case OVS_FRAG_TYPE_FIRST:
 785         return "first";
 786     case OVS_FRAG_TYPE_LATER:
 787         return "later";
 788     case __OVS_FRAG_TYPE_MAX:
 789     default:
 790         return "<error>";
 791     }
 792 }
 793
 794 static int
 795 tunnel_key_attr_len(int type)
 796 {
 797     switch (type) {
 798     case OVS_TUNNEL_KEY_ATTR_ID: return 8;
 799     case OVS_TUNNEL_KEY_ATTR_IPV4_SRC: return 4;
 800     case OVS_TUNNEL_KEY_ATTR_IPV4_DST: return 4;
 801     case OVS_TUNNEL_KEY_ATTR_TOS: return 1;
 802     case OVS_TUNNEL_KEY_ATTR_TTL: return 1;
 803     case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT: return 0;
 804     case OVS_TUNNEL_KEY_ATTR_CSUM: return 0;
 805     case __OVS_TUNNEL_KEY_ATTR_MAX:
 806         return -1;
 807     }
 808     return -1;
 809 }
 810
 811 enum odp_key_fitness
 812 odp_tun_key_from_attr(const struct nlattr *attr, struct flow_tnl *tun)
 813 {
 814     unsigned int left;
 815     const struct nlattr *a;
 816     bool ttl = false;
 817     bool unknown = false;
 818
 819     NL_NESTED_FOR_EACH(a, left, attr) {
 820         uint16_t type = nl_attr_type(a);
 821         size_t len = nl_attr_get_size(a);
 822         int expected_len = tunnel_key_attr_len(type);
 823
 824         if (len != expected_len && expected_len >= 0) {
 825             return ODP_FIT_ERROR;
 826         }
 827
 828         switch (type) {
 829         case OVS_TUNNEL_KEY_ATTR_ID:
 830             tun->tun_id = nl_attr_get_be64(a);
 831             tun->flags |= FLOW_TNL_F_KEY;
 832             break;
 833         case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
 834             tun->ip_src = nl_attr_get_be32(a);
 835             break;
 836         case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
 837             tun->ip_dst = nl_attr_get_be32(a);
 838             break;
 839         case OVS_TUNNEL_KEY_ATTR_TOS:
 840             tun->ip_tos = nl_attr_get_u8(a);
 841             break;
 842         case OVS_TUNNEL_KEY_ATTR_TTL:
 843             tun->ip_ttl = nl_attr_get_u8(a);
 844             ttl = true;
 845             break;
 846         case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
 847             tun->flags |= FLOW_TNL_F_DONT_FRAGMENT;
 848             break;
 849         case OVS_TUNNEL_KEY_ATTR_CSUM:
 850             tun->flags |= FLOW_TNL_F_CSUM;
 851             break;
 852         default:
 853             /* Allow this to show up as unexpected, if there are unknown
 854              * tunnel attribute, eventually resulting in ODP_FIT_TOO_MUCH. */
 855             unknown = true;
 856             break;
 857         }
 858     }
 859
 860     if (!ttl) {
 861         return ODP_FIT_ERROR;
 862     }
 863     if (unknown) {
 864             return ODP_FIT_TOO_MUCH;
 865     }
 866     return ODP_FIT_PERFECT;
 867 }
 868
 869 static void
 870 tun_key_to_attr(struct ofpbuf *a, const struct flow_tnl *tun_key)
 871 {
 872     size_t tun_key_ofs;
 873
 874     tun_key_ofs = nl_msg_start_nested(a, OVS_KEY_ATTR_TUNNEL);
 875
 876     if (tun_key->flags & FLOW_TNL_F_KEY) {
 877         nl_msg_put_be64(a, OVS_TUNNEL_KEY_ATTR_ID, tun_key->tun_id);
 878     }
 879     if (tun_key->ip_src) {
 880         nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_SRC, tun_key->ip_src);
 881     }
 882     if (tun_key->ip_dst) {
 883         nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_DST, tun_key->ip_dst);
 884     }
 885     if (tun_key->ip_tos) {
 886         nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TOS, tun_key->ip_tos);
 887     }
 888     nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TTL, tun_key->ip_ttl);
 889     if (tun_key->flags & FLOW_TNL_F_DONT_FRAGMENT) {
 890         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
 891     }
 892     if (tun_key->flags & FLOW_TNL_F_CSUM) {
 893         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
 894     }
 895
 896     nl_msg_end_nested(a, tun_key_ofs);
 897 }
 898
 899 static bool
 900 odp_mask_attr_is_exact(const struct nlattr *ma)
 901 {
 902     bool is_exact = false;
 903     enum ovs_key_attr attr = nl_attr_type(ma);
 904
 905     if (attr == OVS_KEY_ATTR_TUNNEL) {
 906         /* XXX this is a hack for now. Should change
 907          * the exact match dection to per field
 908          * instead of per attribute.
 909          */
 910         struct flow_tnl tun_mask;
 911         memset(&tun_mask, 0, sizeof tun_mask);
 912         odp_tun_key_from_attr(ma, &tun_mask);
 913         if (tun_mask.flags == (FLOW_TNL_F_KEY
 914                                | FLOW_TNL_F_DONT_FRAGMENT
 915                                | FLOW_TNL_F_CSUM)) {
 916             /* The flags are exact match, check the remaining fields. */
 917             tun_mask.flags = 0xffff;
 918             is_exact = is_all_ones((uint8_t *)&tun_mask,
 919                                    offsetof(struct flow_tnl, ip_ttl));
 920         }
 921     } else {
 922         is_exact = is_all_ones(nl_attr_get(ma), nl_attr_get_size(ma));
 923     }
 924
 925     return is_exact;
 926 }
 927
 928
 929 static void
 930 format_odp_key_attr(const struct nlattr *a, const struct nlattr *ma,
 931                     struct ds *ds)
 932 {
 933     struct flow_tnl tun_key;
 934     enum ovs_key_attr attr = nl_attr_type(a);
 935     char namebuf[OVS_KEY_ATTR_BUFSIZE];
 936     int expected_len;
 937
 938     if (ma && odp_mask_attr_is_exact(ma)) {
 939         ma = NULL;
 940     }
 941
 942     ds_put_cstr(ds, ovs_key_attr_to_string(attr, namebuf, sizeof namebuf));
 943
 944     {
 945         expected_len = odp_flow_key_attr_len(nl_attr_type(a));
 946         if (expected_len != -2) {
 947             bool bad_key_len = nl_attr_get_size(a) != expected_len;
 948             bool bad_mask_len = ma && nl_attr_get_size(a) != expected_len;
 949
 950             if (bad_key_len || bad_mask_len) {
 951                 if (bad_key_len) {
 952                     ds_put_format(ds, "(bad key length %zu, expected %d)(",
 953                                   nl_attr_get_size(a),
 954                                   odp_flow_key_attr_len(nl_attr_type(a)));
 955                 }
 956                 format_generic_odp_key(a, ds);
 957                 if (bad_mask_len) {
 958                     ds_put_char(ds, '/');
 959                     ds_put_format(ds, "(bad mask length %zu, expected %d)(",
 960                                   nl_attr_get_size(ma),
 961                                   odp_flow_key_attr_len(nl_attr_type(ma)));
 962                 }
 963                 format_generic_odp_key(ma, ds);
 964                 ds_put_char(ds, ')');
 965                 return;
 966             }
 967         }
 968     }
 969
 970     ds_put_char(ds, '(');
 971     switch (attr) {
 972     case OVS_KEY_ATTR_ENCAP:
 973         if (ma && nl_attr_get_size(ma) && nl_attr_get_size(a)) {
 974             odp_flow_format(nl_attr_get(a), nl_attr_get_size(a),
 975                             nl_attr_get(ma), nl_attr_get_size(ma), ds);
 976         } else if (nl_attr_get_size(a)) {
 977             odp_flow_format(nl_attr_get(a), nl_attr_get_size(a), NULL, 0, ds);
 978         }
 979         break;
 980
 981     case OVS_KEY_ATTR_PRIORITY:
 982     case OVS_KEY_ATTR_SKB_MARK:
 983         ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
 984         if (ma) {
 985             ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
 986         }
 987         break;
 988
 989     case OVS_KEY_ATTR_TUNNEL:
 990         memset(&tun_key, 0, sizeof tun_key);
 991         if (odp_tun_key_from_attr(a, &tun_key) == ODP_FIT_ERROR) {
 992             ds_put_format(ds, "error");
 993         } else if (ma) {
 994             struct flow_tnl tun_mask;
 995
 996             memset(&tun_mask, 0, sizeof tun_mask);
 997             odp_tun_key_from_attr(ma, &tun_mask);
 998             ds_put_format(ds, "tun_id=%#"PRIx64"/%#"PRIx64
 999                           ",src="IP_FMT"/"IP_FMT",dst="IP_FMT"/"IP_FMT
1000                           ",tos=%#"PRIx8"/%#"PRIx8",ttl=%"PRIu8"/%#"PRIx8
1001                           ",flags(",
1002                           ntohll(tun_key.tun_id), ntohll(tun_mask.tun_id),
1003                           IP_ARGS(tun_key.ip_src), IP_ARGS(tun_mask.ip_src),
1004                           IP_ARGS(tun_key.ip_dst), IP_ARGS(tun_mask.ip_dst),
1005                           tun_key.ip_tos, tun_mask.ip_tos,
1006                           tun_key.ip_ttl, tun_mask.ip_ttl);
1007
1008             format_flags(ds, flow_tun_flag_to_string, tun_key.flags, ',');
1009
1010             /* XXX This code is correct, but enabling it would break the unit
1011                test. Disable it for now until the input parser is fixed.
1012
1013                 ds_put_char(ds, '/');
1014                 format_flags(ds, flow_tun_flag_to_string, tun_mask.flags, ',');
1015             */
1016             ds_put_char(ds, ')');
1017         } else {
1018             ds_put_format(ds, "tun_id=0x%"PRIx64",src="IP_FMT",dst="IP_FMT","
1019                           "tos=0x%"PRIx8",ttl=%"PRIu8",flags(",
1020                           ntohll(tun_key.tun_id),
1021                           IP_ARGS(tun_key.ip_src),
1022                           IP_ARGS(tun_key.ip_dst),
1023                           tun_key.ip_tos, tun_key.ip_ttl);
1024
1025             format_flags(ds, flow_tun_flag_to_string, tun_key.flags, ',');
1026             ds_put_char(ds, ')');
1027         }
1028         break;
1029
1030     case OVS_KEY_ATTR_IN_PORT:
1031         ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
1032         if (ma) {
1033             ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
1034         }
1035         break;
1036
1037     case OVS_KEY_ATTR_ETHERNET:
1038         if (ma) {
1039             const struct ovs_key_ethernet *eth_mask = nl_attr_get(ma);
1040             const struct ovs_key_ethernet *eth_key = nl_attr_get(a);
1041
1042             ds_put_format(ds, "src="ETH_ADDR_FMT"/"ETH_ADDR_FMT
1043                           ",dst="ETH_ADDR_FMT"/"ETH_ADDR_FMT,
1044                           ETH_ADDR_ARGS(eth_key->eth_src),
1045                           ETH_ADDR_ARGS(eth_mask->eth_src),
1046                           ETH_ADDR_ARGS(eth_key->eth_dst),
1047                           ETH_ADDR_ARGS(eth_mask->eth_dst));
1048         } else {
1049             const struct ovs_key_ethernet *eth_key = nl_attr_get(a);
1050
1051             ds_put_format(ds, "src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT,
1052                           ETH_ADDR_ARGS(eth_key->eth_src),
1053                           ETH_ADDR_ARGS(eth_key->eth_dst));
1054         }
1055         break;
1056
1057     case OVS_KEY_ATTR_VLAN:
1058         {
1059             ovs_be16 vlan_tci = nl_attr_get_be16(a);
1060             if (ma) {
1061                 ovs_be16 mask = nl_attr_get_be16(ma);
1062                 ds_put_format(ds, "vid=%"PRIu16"/%"PRIx16",pcp=%d/0x%x,cfi=%d/%d",
1063                               vlan_tci_to_vid(vlan_tci),
1064                               vlan_tci_to_vid(mask),
1065                               vlan_tci_to_pcp(vlan_tci),
1066                               vlan_tci_to_pcp(mask),
1067                               vlan_tci_to_cfi(vlan_tci),
1068                               vlan_tci_to_cfi(mask));
1069             } else {
1070                 format_vlan_tci(ds, vlan_tci);
1071             }
1072         }
1073         break;
1074
1075     case OVS_KEY_ATTR_MPLS: {
1076         const struct ovs_key_mpls *mpls_key = nl_attr_get(a);
1077         const struct ovs_key_mpls *mpls_mask = NULL;
1078         if (ma) {
1079             mpls_mask = nl_attr_get(ma);
1080         }
1081         format_mpls(ds, mpls_key, mpls_mask);
1082         break;
1083     }
1084
1085     case OVS_KEY_ATTR_ETHERTYPE:
1086         ds_put_format(ds, "0x%04"PRIx16, ntohs(nl_attr_get_be16(a)));
1087         if (ma) {
1088             ds_put_format(ds, "/0x%04"PRIx16, ntohs(nl_attr_get_be16(ma)));
1089         }
1090         break;
1091
1092     case OVS_KEY_ATTR_IPV4:
1093         if (ma) {
1094             const struct ovs_key_ipv4 *ipv4_key = nl_attr_get(a);
1095             const struct ovs_key_ipv4 *ipv4_mask = nl_attr_get(ma);
1096
1097             ds_put_format(ds, "src="IP_FMT"/"IP_FMT",dst="IP_FMT"/"IP_FMT
1098                           ",proto=%"PRIu8"/%#"PRIx8",tos=%#"PRIx8"/%#"PRIx8
1099                           ",ttl=%"PRIu8"/%#"PRIx8",frag=%s/%#"PRIx8,
1100                           IP_ARGS(ipv4_key->ipv4_src),
1101                           IP_ARGS(ipv4_mask->ipv4_src),
1102                           IP_ARGS(ipv4_key->ipv4_dst),
1103                           IP_ARGS(ipv4_mask->ipv4_dst),
1104                           ipv4_key->ipv4_proto, ipv4_mask->ipv4_proto,
1105                           ipv4_key->ipv4_tos, ipv4_mask->ipv4_tos,
1106                           ipv4_key->ipv4_ttl, ipv4_mask->ipv4_ttl,
1107                           ovs_frag_type_to_string(ipv4_key->ipv4_frag),
1108                           ipv4_mask->ipv4_frag);
1109         } else {
1110             const struct ovs_key_ipv4 *ipv4_key = nl_attr_get(a);
1111
1112             ds_put_format(ds, "src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
1113                           ",tos=%#"PRIx8",ttl=%"PRIu8",frag=%s",
1114                           IP_ARGS(ipv4_key->ipv4_src),
1115                           IP_ARGS(ipv4_key->ipv4_dst),
1116                           ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
1117                           ipv4_key->ipv4_ttl,
1118                           ovs_frag_type_to_string(ipv4_key->ipv4_frag));
1119         }
1120         break;
1121
1122     case OVS_KEY_ATTR_IPV6:
1123         if (ma) {
1124             const struct ovs_key_ipv6 *ipv6_key, *ipv6_mask;
1125             char src_str[INET6_ADDRSTRLEN];
1126             char dst_str[INET6_ADDRSTRLEN];
1127             char src_mask[INET6_ADDRSTRLEN];
1128             char dst_mask[INET6_ADDRSTRLEN];
1129
1130             ipv6_key = nl_attr_get(a);
1131             inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
1132             inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
1133
1134             ipv6_mask = nl_attr_get(ma);
1135             inet_ntop(AF_INET6, ipv6_mask->ipv6_src, src_mask, sizeof src_mask);
1136             inet_ntop(AF_INET6, ipv6_mask->ipv6_dst, dst_mask, sizeof dst_mask);
1137
1138             ds_put_format(ds, "src=%s/%s,dst=%s/%s,label=%#"PRIx32"/%#"PRIx32
1139                           ",proto=%"PRIu8"/%#"PRIx8",tclass=%#"PRIx8"/%#"PRIx8
1140                           ",hlimit=%"PRIu8"/%#"PRIx8",frag=%s/%#"PRIx8,
1141                           src_str, src_mask, dst_str, dst_mask,
1142                           ntohl(ipv6_key->ipv6_label),
1143                           ntohl(ipv6_mask->ipv6_label),
1144                           ipv6_key->ipv6_proto, ipv6_mask->ipv6_proto,
1145                           ipv6_key->ipv6_tclass, ipv6_mask->ipv6_tclass,
1146                           ipv6_key->ipv6_hlimit, ipv6_mask->ipv6_hlimit,
1147                           ovs_frag_type_to_string(ipv6_key->ipv6_frag),
1148                           ipv6_mask->ipv6_frag);
1149         } else {
1150             const struct ovs_key_ipv6 *ipv6_key;
1151             char src_str[INET6_ADDRSTRLEN];
1152             char dst_str[INET6_ADDRSTRLEN];
1153
1154             ipv6_key = nl_attr_get(a);
1155             inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
1156             inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
1157
1158             ds_put_format(ds, "src=%s,dst=%s,label=%#"PRIx32",proto=%"PRIu8
1159                           ",tclass=%#"PRIx8",hlimit=%"PRIu8",frag=%s",
1160                           src_str, dst_str, ntohl(ipv6_key->ipv6_label),
1161                           ipv6_key->ipv6_proto, ipv6_key->ipv6_tclass,
1162                           ipv6_key->ipv6_hlimit,
1163                           ovs_frag_type_to_string(ipv6_key->ipv6_frag));
1164         }
1165         break;
1166
1167     case OVS_KEY_ATTR_TCP:
1168         if (ma) {
1169             const struct ovs_key_tcp *tcp_mask = nl_attr_get(ma);
1170             const struct ovs_key_tcp *tcp_key = nl_attr_get(a);
1171
1172             ds_put_format(ds, "src=%"PRIu16"/%#"PRIx16
1173                           ",dst=%"PRIu16"/%#"PRIx16,
1174                           ntohs(tcp_key->tcp_src), ntohs(tcp_mask->tcp_src),
1175                           ntohs(tcp_key->tcp_dst), ntohs(tcp_mask->tcp_dst));
1176         } else {
1177             const struct ovs_key_tcp *tcp_key = nl_attr_get(a);
1178
1179             ds_put_format(ds, "src=%"PRIu16",dst=%"PRIu16,
1180                           ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
1181         }
1182         break;
1183
1184     case OVS_KEY_ATTR_UDP:
1185         if (ma) {
1186             const struct ovs_key_udp *udp_mask = nl_attr_get(ma);
1187             const struct ovs_key_udp *udp_key = nl_attr_get(a);
1188
1189             ds_put_format(ds, "src=%"PRIu16"/%#"PRIx16
1190                           ",dst=%"PRIu16"/%#"PRIx16,
1191                           ntohs(udp_key->udp_src), ntohs(udp_mask->udp_src),
1192                           ntohs(udp_key->udp_dst), ntohs(udp_mask->udp_dst));
1193         } else {
1194             const struct ovs_key_udp *udp_key = nl_attr_get(a);
1195
1196             ds_put_format(ds, "src=%"PRIu16",dst=%"PRIu16,
1197                           ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
1198         }
1199         break;
1200
1201     case OVS_KEY_ATTR_ICMP:
1202         if (ma) {
1203             const struct ovs_key_icmp *icmp_mask = nl_attr_get(ma);
1204             const struct ovs_key_icmp *icmp_key = nl_attr_get(a);
1205
1206             ds_put_format(ds, "type=%"PRIu8"/%#"PRIx8",code=%"PRIu8"/%#"PRIx8,
1207                           icmp_key->icmp_type, icmp_mask->icmp_type,
1208                           icmp_key->icmp_code, icmp_mask->icmp_code);
1209         } else {
1210             const struct ovs_key_icmp *icmp_key = nl_attr_get(a);
1211
1212             ds_put_format(ds, "type=%"PRIu8",code=%"PRIu8,
1213                           icmp_key->icmp_type, icmp_key->icmp_code);
1214         }
1215         break;
1216
1217     case OVS_KEY_ATTR_ICMPV6:
1218         if (ma) {
1219             const struct ovs_key_icmpv6 *icmpv6_mask = nl_attr_get(ma);
1220             const struct ovs_key_icmpv6 *icmpv6_key = nl_attr_get(a);
1221
1222             ds_put_format(ds, "type=%"PRIu8"/%#"PRIx8",code=%"PRIu8"/%#"PRIx8,
1223                           icmpv6_key->icmpv6_type, icmpv6_mask->icmpv6_type,
1224                           icmpv6_key->icmpv6_code, icmpv6_mask->icmpv6_code);
1225         } else {
1226             const struct ovs_key_icmpv6 *icmpv6_key = nl_attr_get(a);
1227
1228             ds_put_format(ds, "type=%"PRIu8",code=%"PRIu8,
1229                           icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
1230         }
1231         break;
1232
1233     case OVS_KEY_ATTR_ARP:
1234         if (ma) {
1235             const struct ovs_key_arp *arp_mask = nl_attr_get(ma);
1236             const struct ovs_key_arp *arp_key = nl_attr_get(a);
1237
1238             ds_put_format(ds, "sip="IP_FMT"/"IP_FMT",tip="IP_FMT"/"IP_FMT
1239                           ",op=%"PRIu16"/%#"PRIx16
1240                           ",sha="ETH_ADDR_FMT"/"ETH_ADDR_FMT
1241                           ",tha="ETH_ADDR_FMT"/"ETH_ADDR_FMT,
1242                           IP_ARGS(arp_key->arp_sip),
1243                           IP_ARGS(arp_mask->arp_sip),
1244                           IP_ARGS(arp_key->arp_tip),
1245                           IP_ARGS(arp_mask->arp_tip),
1246                           ntohs(arp_key->arp_op), ntohs(arp_mask->arp_op),
1247                           ETH_ADDR_ARGS(arp_key->arp_sha),
1248                           ETH_ADDR_ARGS(arp_mask->arp_sha),
1249                           ETH_ADDR_ARGS(arp_key->arp_tha),
1250                           ETH_ADDR_ARGS(arp_mask->arp_tha));
1251         } else {
1252             const struct ovs_key_arp *arp_key = nl_attr_get(a);
1253
1254             ds_put_format(ds, "sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
1255                           "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT,
1256                           IP_ARGS(arp_key->arp_sip), IP_ARGS(arp_key->arp_tip),
1257                           ntohs(arp_key->arp_op),
1258                           ETH_ADDR_ARGS(arp_key->arp_sha),
1259                           ETH_ADDR_ARGS(arp_key->arp_tha));
1260         }
1261         break;
1262
1263     case OVS_KEY_ATTR_ND: {
1264         const struct ovs_key_nd *nd_key, *nd_mask;
1265         char target[INET6_ADDRSTRLEN];
1266
1267         nd_key = nl_attr_get(a);
1268         nd_mask = ma ? nl_attr_get(ma) : NULL;
1269
1270         inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
1271         ds_put_format(ds, "target=%s", target);
1272         if (nd_mask) {
1273             inet_ntop(AF_INET6, nd_mask->nd_target, target, sizeof target);
1274             ds_put_format(ds, "/%s", target);
1275         }
1276
1277         if (!eth_addr_is_zero(nd_key->nd_sll)) {
1278             ds_put_format(ds, ",sll="ETH_ADDR_FMT,
1279                           ETH_ADDR_ARGS(nd_key->nd_sll));
1280             if (nd_mask) {
1281                 ds_put_format(ds, "/"ETH_ADDR_FMT,
1282                               ETH_ADDR_ARGS(nd_mask->nd_sll));
1283             }
1284         }
1285         if (!eth_addr_is_zero(nd_key->nd_tll)) {
1286             ds_put_format(ds, ",tll="ETH_ADDR_FMT,
1287                           ETH_ADDR_ARGS(nd_key->nd_tll));
1288             if (nd_mask) {
1289                 ds_put_format(ds, "/"ETH_ADDR_FMT,
1290                               ETH_ADDR_ARGS(nd_mask->nd_tll));
1291             }
1292         }
1293         break;
1294     }
1295
1296     case OVS_KEY_ATTR_UNSPEC:
1297     case __OVS_KEY_ATTR_MAX:
1298     default:
1299         format_generic_odp_key(a, ds);
1300         if (ma) {
1301             ds_put_char(ds, '/');
1302             format_generic_odp_key(ma, ds);
1303         }
1304         break;
1305     }
1306     ds_put_char(ds, ')');
1307 }
1308
1309 /* Appends to 'ds' a string representation of the 'key_len' bytes of
1310  * OVS_KEY_ATTR_* attributes in 'key'. If non-null, additionally formats the
1311  * 'mask_len' bytes of 'mask' which apply to 'key'. */
1312 void
1313 odp_flow_format(const struct nlattr *key, size_t key_len,
1314                 const struct nlattr *mask, size_t mask_len,
1315                 struct ds *ds)
1316 {
1317     if (key_len) {
1318         const struct nlattr *a;
1319         unsigned int left;
1320         bool has_ethtype_key = false;
1321         const struct nlattr *ma = NULL;
1322
1323         NL_ATTR_FOR_EACH (a, left, key, key_len) {
1324             if (a != key) {
1325                 ds_put_char(ds, ',');
1326             }
1327             if (nl_attr_type(a) == OVS_KEY_ATTR_ETHERTYPE) {
1328                 has_ethtype_key = true;
1329             }
1330             if (mask && mask_len) {
1331                 ma = nl_attr_find__(mask, mask_len, nl_attr_type(a));
1332             }
1333             format_odp_key_attr(a, ma, ds);
1334         }
1335         if (left) {
1336             int i;
1337
1338             if (left == key_len) {
1339                 ds_put_cstr(ds, "<empty>");
1340             }
1341             ds_put_format(ds, ",***%u leftover bytes*** (", left);
1342             for (i = 0; i < left; i++) {
1343                 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
1344             }
1345             ds_put_char(ds, ')');
1346         }
1347         if (!has_ethtype_key) {
1348             ma = nl_attr_find__(mask, mask_len, OVS_KEY_ATTR_ETHERTYPE);
1349             if (ma) {
1350                 ds_put_format(ds, ",eth_type(0/0x%04"PRIx16")",
1351                               ntohs(nl_attr_get_be16(ma)));
1352             }
1353         }
1354     } else {
1355         ds_put_cstr(ds, "<empty>");
1356     }
1357 }
1358
1359 /* Appends to 'ds' a string representation of the 'key_len' bytes of
1360  * OVS_KEY_ATTR_* attributes in 'key'. */
1361 void
1362 odp_flow_key_format(const struct nlattr *key,
1363                     size_t key_len, struct ds *ds)
1364 {
1365     odp_flow_format(key, key_len, NULL, 0, ds);
1366 }
1367
1368 static int
1369 put_nd_key(int n, const char *nd_target_s,
1370            const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
1371 {
1372     struct ovs_key_nd nd_key;
1373
1374     memset(&nd_key, 0, sizeof nd_key);
1375     if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
1376         return -EINVAL;
1377     }
1378     if (nd_sll) {
1379         memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
1380     }
1381     if (nd_tll) {
1382         memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
1383     }
1384     nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
1385     return n;
1386 }
1387
1388 static bool
1389 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
1390 {
1391     if (!strcasecmp(s, "no")) {
1392         *type = OVS_FRAG_TYPE_NONE;
1393     } else if (!strcasecmp(s, "first")) {
1394         *type = OVS_FRAG_TYPE_FIRST;
1395     } else if (!strcasecmp(s, "later")) {
1396         *type = OVS_FRAG_TYPE_LATER;
1397     } else {
1398         return false;
1399     }
1400     return true;
1401 }
1402
1403 static ovs_be32
1404 mpls_lse_from_components(int mpls_label, int mpls_tc, int mpls_ttl, int mpls_bos)
1405 {
1406     return (htonl((mpls_label << MPLS_LABEL_SHIFT) |
1407                   (mpls_tc << MPLS_TC_SHIFT)       |
1408                   (mpls_ttl << MPLS_TTL_SHIFT)     |
1409                   (mpls_bos << MPLS_BOS_SHIFT)));
1410 }
1411
1412 static int
1413 parse_odp_key_mask_attr(const char *s, const struct simap *port_names,
1414                         struct ofpbuf *key, struct ofpbuf *mask)
1415 {
1416     /* Many of the sscanf calls in this function use oversized destination
1417      * fields because some sscanf() implementations truncate the range of %i
1418      * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
1419      * value of 0x7fff.  The other alternatives are to allow only a single
1420      * radix (e.g. decimal or hexadecimal) or to write more sophisticated
1421      * parsers.
1422      *
1423      * The tun_id parser has to use an alternative approach because there is no
1424      * type larger than 64 bits. */
1425
1426     {
1427         unsigned long long int priority;
1428         unsigned long long int priority_mask;
1429         int n = -1;
1430
1431         if (mask && sscanf(s, "skb_priority(%lli/%lli)%n", &priority,
1432                    &priority_mask, &n) > 0 && n > 0) {
1433             nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
1434             nl_msg_put_u32(mask, OVS_KEY_ATTR_PRIORITY, priority_mask);
1435             return n;
1436         } else if (sscanf(s, "skb_priority(%lli)%n",
1437                           &priority, &n) > 0 && n > 0) {
1438             nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
1439             if (mask) {
1440                 nl_msg_put_u32(mask, OVS_KEY_ATTR_PRIORITY, UINT32_MAX);
1441             }
1442             return n;
1443         }
1444     }
1445
1446     {
1447         unsigned long long int mark;
1448         unsigned long long int mark_mask;
1449         int n = -1;
1450
1451         if (mask && sscanf(s, "skb_mark(%lli/%lli)%n", &mark,
1452                    &mark_mask, &n) > 0 && n > 0) {
1453             nl_msg_put_u32(key, OVS_KEY_ATTR_SKB_MARK, mark);
1454             nl_msg_put_u32(mask, OVS_KEY_ATTR_SKB_MARK, mark_mask);
1455             return n;
1456         } else if (sscanf(s, "skb_mark(%lli)%n", &mark, &n) > 0 && n > 0) {
1457             nl_msg_put_u32(key, OVS_KEY_ATTR_SKB_MARK, mark);
1458             if (mask) {
1459                 nl_msg_put_u32(mask, OVS_KEY_ATTR_SKB_MARK, UINT32_MAX);
1460             }
1461             return n;
1462         }
1463     }
1464
1465     {
1466         char tun_id_s[32];
1467         int tos, tos_mask, ttl, ttl_mask;
1468         struct flow_tnl tun_key, tun_key_mask;
1469         unsigned long long tun_id_mask;
1470         int n = -1;
1471
1472         if (mask && sscanf(s, "tunnel(tun_id=%31[x0123456789abcdefABCDEF]/%llx,"
1473                    "src="IP_SCAN_FMT"/"IP_SCAN_FMT",dst="IP_SCAN_FMT
1474                    "/"IP_SCAN_FMT",tos=%i/%i,ttl=%i/%i,flags%n",
1475                    tun_id_s, &tun_id_mask,
1476                    IP_SCAN_ARGS(&tun_key.ip_src),
1477                    IP_SCAN_ARGS(&tun_key_mask.ip_src),
1478                    IP_SCAN_ARGS(&tun_key.ip_dst),
1479                    IP_SCAN_ARGS(&tun_key_mask.ip_dst),
1480                    &tos, &tos_mask, &ttl, &ttl_mask,
1481                    &n) > 0 && n > 0) {
1482             int res;
1483             uint32_t flags;
1484
1485             tun_key.tun_id = htonll(strtoull(tun_id_s, NULL, 0));
1486             tun_key_mask.tun_id = htonll(tun_id_mask);
1487             tun_key.ip_tos = tos;
1488             tun_key_mask.ip_tos = tos_mask;
1489             tun_key.ip_ttl = ttl;
1490             tun_key_mask.ip_ttl = ttl_mask;
1491             res = parse_flags(&s[n], flow_tun_flag_to_string, &flags);
1492             tun_key.flags = flags;
1493             tun_key_mask.flags = UINT16_MAX;
1494
1495             if (res < 0) {
1496                 return res;
1497             }
1498             n += res;
1499             if (s[n] != ')') {
1500                 return -EINVAL;
1501             }
1502             n++;
1503             tun_key_to_attr(key, &tun_key);
1504             if (mask) {
1505                 tun_key_to_attr(mask, &tun_key_mask);
1506             }
1507             return n;
1508         } else if (sscanf(s, "tunnel(tun_id=%31[x0123456789abcdefABCDEF],"
1509                    "src="IP_SCAN_FMT",dst="IP_SCAN_FMT
1510                    ",tos=%i,ttl=%i,flags%n", tun_id_s,
1511                     IP_SCAN_ARGS(&tun_key.ip_src),
1512                     IP_SCAN_ARGS(&tun_key.ip_dst), &tos, &ttl,
1513                     &n) > 0 && n > 0) {
1514             int res;
1515             uint32_t flags;
1516
1517             tun_key.tun_id = htonll(strtoull(tun_id_s, NULL, 0));
1518             tun_key.ip_tos = tos;
1519             tun_key.ip_ttl = ttl;
1520             res = parse_flags(&s[n], flow_tun_flag_to_string, &flags);
1521             tun_key.flags = flags;
1522
1523             if (res < 0) {
1524                 return res;
1525             }
1526             n += res;
1527             if (s[n] != ')') {
1528                 return -EINVAL;
1529             }
1530             n++;
1531             tun_key_to_attr(key, &tun_key);
1532
1533             if (mask) {
1534                 memset(&tun_key, 0xff, sizeof tun_key);
1535                 tun_key_to_attr(mask, &tun_key);
1536             }
1537             return n;
1538         }
1539     }
1540
1541     {
1542         unsigned long long int in_port;
1543         unsigned long long int in_port_mask;
1544         int n = -1;
1545
1546         if (mask && sscanf(s, "in_port(%lli/%lli)%n", &in_port,
1547                    &in_port_mask, &n) > 0 && n > 0) {
1548             nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
1549             nl_msg_put_u32(mask, OVS_KEY_ATTR_IN_PORT, in_port_mask);
1550             return n;
1551         } else if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
1552             nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
1553             if (mask) {
1554                 nl_msg_put_u32(mask, OVS_KEY_ATTR_IN_PORT, UINT32_MAX);
1555             }
1556             return n;
1557         }
1558     }
1559
1560
1561     if (port_names && !strncmp(s, "in_port(", 8)) {
1562         const char *name;
1563         const struct simap_node *node;
1564         int name_len;
1565
1566         name = s + 8;
1567         name_len = strcspn(s, ")");
1568         node = simap_find_len(port_names, name, name_len);
1569         if (node) {
1570             nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, node->data);
1571
1572             if (mask) {
1573                 nl_msg_put_u32(mask, OVS_KEY_ATTR_IN_PORT, UINT32_MAX);
1574             }
1575             return 8 + name_len + 1;
1576         }
1577     }
1578
1579     {
1580         struct ovs_key_ethernet eth_key;
1581         struct ovs_key_ethernet eth_key_mask;
1582         int n = -1;
1583
1584         if (mask && sscanf(s,
1585                    "eth(src="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT","
1586                         "dst="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
1587                 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
1588                 ETH_ADDR_SCAN_ARGS(eth_key_mask.eth_src),
1589                 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst),
1590                 ETH_ADDR_SCAN_ARGS(eth_key_mask.eth_dst), &n) > 0 && n > 0) {
1591
1592             nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
1593                               &eth_key, sizeof eth_key);
1594             nl_msg_put_unspec(mask, OVS_KEY_ATTR_ETHERNET,
1595                               &eth_key_mask, sizeof eth_key_mask);
1596             return n;
1597         } else if (sscanf(s,
1598                    "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
1599                    ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
1600                    ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
1601             nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
1602                               &eth_key, sizeof eth_key);
1603
1604             if (mask) {
1605                 memset(&eth_key, 0xff, sizeof eth_key);
1606                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ETHERNET,
1607                               &eth_key, sizeof eth_key);
1608             }
1609             return n;
1610         }
1611     }
1612
1613     {
1614         uint16_t vid, vid_mask;
1615         int pcp, pcp_mask;
1616         int cfi, cfi_mask;
1617         int n = -1;
1618
1619         if (mask && (sscanf(s, "vlan(vid=%"SCNi16"/%"SCNi16",pcp=%i/%i)%n",
1620                             &vid, &vid_mask, &pcp, &pcp_mask, &n) > 0 && n > 0)) {
1621             nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1622                             htons((vid << VLAN_VID_SHIFT) |
1623                                   (pcp << VLAN_PCP_SHIFT) |
1624                                   VLAN_CFI));
1625             nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN,
1626                             htons((vid_mask << VLAN_VID_SHIFT) |
1627                                   (pcp_mask << VLAN_PCP_SHIFT) |
1628                                   (1 << VLAN_CFI_SHIFT)));
1629             return n;
1630         } else if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n",
1631                            &vid, &pcp, &n) > 0 && n > 0)) {
1632             nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1633                             htons((vid << VLAN_VID_SHIFT) |
1634                                   (pcp << VLAN_PCP_SHIFT) |
1635                                   VLAN_CFI));
1636             if (mask) {
1637                 nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN, htons(UINT16_MAX));
1638             }
1639             return n;
1640         } else if (mask && (sscanf(s, "vlan(vid=%"SCNi16"/%"SCNi16",pcp=%i/%i,cfi=%i/%i)%n",
1641                                    &vid, &vid_mask, &pcp, &pcp_mask, &cfi, &cfi_mask, &n) > 0 && n > 0)) {
1642             nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1643                             htons((vid << VLAN_VID_SHIFT) |
1644                                   (pcp << VLAN_PCP_SHIFT) |
1645                                   (cfi ? VLAN_CFI : 0)));
1646             nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN,
1647                             htons((vid_mask << VLAN_VID_SHIFT) |
1648                                   (pcp_mask << VLAN_PCP_SHIFT) |
1649                                   (cfi_mask << VLAN_CFI_SHIFT)));
1650             return n;
1651         } else if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i,cfi=%i)%n",
1652                            &vid, &pcp, &cfi, &n) > 0 && n > 0)) {
1653             nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1654                             htons((vid << VLAN_VID_SHIFT) |
1655                                   (pcp << VLAN_PCP_SHIFT) |
1656                                   (cfi ? VLAN_CFI : 0)));
1657             if (mask) {
1658                 nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN, htons(UINT16_MAX));
1659             }
1660             return n;
1661         }
1662     }
1663
1664     {
1665         int eth_type;
1666         int eth_type_mask;
1667         int n = -1;
1668
1669         if (mask && sscanf(s, "eth_type(%i/%i)%n",
1670                    &eth_type, &eth_type_mask, &n) > 0 && n > 0) {
1671             if (eth_type != 0) {
1672                 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
1673             }
1674             nl_msg_put_be16(mask, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type_mask));
1675             return n;
1676         } else if (sscanf(s, "eth_type(%i)%n", &eth_type, &n) > 0 && n > 0) {
1677             nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
1678             if (mask) {
1679                 nl_msg_put_be16(mask, OVS_KEY_ATTR_ETHERTYPE,
1680                                 htons(UINT16_MAX));
1681             }
1682             return n;
1683         }
1684     }
1685
1686     {
1687         int label, tc, ttl, bos;
1688         int label_mask, tc_mask, ttl_mask, bos_mask;
1689         int n = -1;
1690
1691         if (mask && sscanf(s, "mpls(label=%"SCNi32"/%"SCNi32",tc=%i/%i,ttl=%i/%i,bos=%i/%i)%n",
1692                     &label, &label_mask, &tc, &tc_mask, &ttl, &ttl_mask, &bos, &bos_mask, &n) > 0 && n > 0) {
1693             struct ovs_key_mpls *mpls, *mpls_mask;
1694
1695             mpls = nl_msg_put_unspec_uninit(key, OVS_KEY_ATTR_MPLS,
1696                                             sizeof *mpls);
1697             mpls->mpls_lse = mpls_lse_from_components(label, tc, ttl, bos);
1698
1699             mpls_mask = nl_msg_put_unspec_uninit(mask, OVS_KEY_ATTR_MPLS,
1700                                             sizeof *mpls_mask);
1701             mpls_mask->mpls_lse = mpls_lse_from_components(
1702                                   label_mask, tc_mask, ttl_mask, bos_mask);
1703             return n;
1704         } else if (sscanf(s, "mpls(label=%"SCNi32",tc=%i,ttl=%i,bos=%i)%n",
1705                     &label, &tc, &ttl, &bos, &n) > 0 &&
1706                     n > 0) {
1707             struct ovs_key_mpls *mpls;
1708
1709             mpls = nl_msg_put_unspec_uninit(key, OVS_KEY_ATTR_MPLS,
1710                                             sizeof *mpls);
1711             mpls->mpls_lse = mpls_lse_from_components(label, tc, ttl, bos);
1712             if (mask) {
1713                 mpls = nl_msg_put_unspec_uninit(mask, OVS_KEY_ATTR_MPLS,
1714                                             sizeof *mpls);
1715                 mpls->mpls_lse = htonl(UINT32_MAX);
1716             }
1717             return n;
1718         }
1719     }
1720
1721
1722     {
1723         ovs_be32 ipv4_src, ipv4_src_mask;
1724         ovs_be32 ipv4_dst, ipv4_dst_mask;
1725         int ipv4_proto, ipv4_proto_mask;
1726         int ipv4_tos, ipv4_tos_mask;
1727         int ipv4_ttl, ipv4_ttl_mask;
1728         char frag[8];
1729         int  ipv4_frag_mask;
1730         enum ovs_frag_type ipv4_frag;
1731         int n = -1;
1732
1733         if (mask && sscanf(s, "ipv4(src="IP_SCAN_FMT"/"IP_SCAN_FMT","
1734                       "dst="IP_SCAN_FMT"/"IP_SCAN_FMT","
1735                       "proto=%i/%i,tos=%i/%i,ttl=%i/%i,"
1736                       "frag=%7[a-z]/%i)%n",
1737                       IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_src_mask),
1738                       IP_SCAN_ARGS(&ipv4_dst), IP_SCAN_ARGS(&ipv4_dst_mask),
1739                       &ipv4_proto, &ipv4_proto_mask,
1740                       &ipv4_tos, &ipv4_tos_mask, &ipv4_ttl, &ipv4_ttl_mask,
1741                       frag, &ipv4_frag_mask, &n) > 0
1742             && n > 0
1743             && ovs_frag_type_from_string(frag, &ipv4_frag)) {
1744             struct ovs_key_ipv4 ipv4_key;
1745             struct ovs_key_ipv4 ipv4_mask;
1746
1747             ipv4_key.ipv4_src = ipv4_src;
1748             ipv4_key.ipv4_dst = ipv4_dst;
1749             ipv4_key.ipv4_proto = ipv4_proto;
1750             ipv4_key.ipv4_tos = ipv4_tos;
1751             ipv4_key.ipv4_ttl = ipv4_ttl;
1752             ipv4_key.ipv4_frag = ipv4_frag;
1753             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
1754                               &ipv4_key, sizeof ipv4_key);
1755
1756             ipv4_mask.ipv4_src = ipv4_src_mask;
1757             ipv4_mask.ipv4_dst = ipv4_dst_mask;
1758             ipv4_mask.ipv4_proto = ipv4_proto_mask;
1759             ipv4_mask.ipv4_tos = ipv4_tos_mask;
1760             ipv4_mask.ipv4_ttl = ipv4_ttl_mask;
1761             ipv4_mask.ipv4_frag = ipv4_frag_mask;
1762             nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV4,
1763                               &ipv4_mask, sizeof ipv4_mask);
1764             return n;
1765         } else if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
1766                    "proto=%i,tos=%i,ttl=%i,frag=%7[a-z])%n",
1767                    IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
1768                    &ipv4_proto, &ipv4_tos, &ipv4_ttl, frag, &n) > 0
1769             && n > 0
1770             && ovs_frag_type_from_string(frag, &ipv4_frag)) {
1771             struct ovs_key_ipv4 ipv4_key;
1772
1773             ipv4_key.ipv4_src = ipv4_src;
1774             ipv4_key.ipv4_dst = ipv4_dst;
1775             ipv4_key.ipv4_proto = ipv4_proto;
1776             ipv4_key.ipv4_tos = ipv4_tos;
1777             ipv4_key.ipv4_ttl = ipv4_ttl;
1778             ipv4_key.ipv4_frag = ipv4_frag;
1779             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
1780                               &ipv4_key, sizeof ipv4_key);
1781
1782             if (mask) {
1783                 memset(&ipv4_key, 0xff, sizeof ipv4_key);
1784                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV4,
1785                               &ipv4_key, sizeof ipv4_key);
1786             }
1787             return n;
1788         }
1789     }
1790
1791     {
1792         char ipv6_src_s[IPV6_SCAN_LEN + 1];
1793         char ipv6_src_mask_s[IPV6_SCAN_LEN + 1];
1794         char ipv6_dst_s[IPV6_SCAN_LEN + 1];
1795         char ipv6_dst_mask_s[IPV6_SCAN_LEN + 1];
1796         int ipv6_label, ipv6_label_mask;
1797         int ipv6_proto, ipv6_proto_mask;
1798         int ipv6_tclass, ipv6_tclass_mask;
1799         int ipv6_hlimit, ipv6_hlimit_mask;
1800         char frag[8];
1801         enum ovs_frag_type ipv6_frag;
1802         int ipv6_frag_mask;
1803         int n = -1;
1804
1805         if (mask && sscanf(s, "ipv6(src="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT",dst="
1806                    IPV6_SCAN_FMT"/"IPV6_SCAN_FMT","
1807                    "label=%i/%i,proto=%i/%i,tclass=%i/%i,"
1808                    "hlimit=%i/%i,frag=%7[a-z]/%i)%n",
1809                    ipv6_src_s, ipv6_src_mask_s, ipv6_dst_s, ipv6_dst_mask_s,
1810                    &ipv6_label, &ipv6_label_mask, &ipv6_proto,
1811                    &ipv6_proto_mask, &ipv6_tclass, &ipv6_tclass_mask,
1812                    &ipv6_hlimit, &ipv6_hlimit_mask, frag,
1813                    &ipv6_frag_mask, &n) > 0
1814             && n > 0
1815             && ovs_frag_type_from_string(frag, &ipv6_frag)) {
1816             struct ovs_key_ipv6 ipv6_key;
1817             struct ovs_key_ipv6 ipv6_mask;
1818
1819             if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
1820                 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1 ||
1821                 inet_pton(AF_INET6, ipv6_src_mask_s, &ipv6_mask.ipv6_src) != 1 ||
1822                 inet_pton(AF_INET6, ipv6_dst_mask_s, &ipv6_mask.ipv6_dst) != 1) {
1823                 return -EINVAL;
1824             }
1825
1826             ipv6_key.ipv6_label = htonl(ipv6_label);
1827             ipv6_key.ipv6_proto = ipv6_proto;
1828             ipv6_key.ipv6_tclass = ipv6_tclass;
1829             ipv6_key.ipv6_hlimit = ipv6_hlimit;
1830             ipv6_key.ipv6_frag = ipv6_frag;
1831             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
1832                               &ipv6_key, sizeof ipv6_key);
1833
1834             ipv6_mask.ipv6_label = htonl(ipv6_label_mask);
1835             ipv6_mask.ipv6_proto = ipv6_proto_mask;
1836             ipv6_mask.ipv6_tclass = ipv6_tclass_mask;
1837             ipv6_mask.ipv6_hlimit = ipv6_hlimit_mask;
1838             ipv6_mask.ipv6_frag = ipv6_frag_mask;
1839             nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV6,
1840                               &ipv6_mask, sizeof ipv6_mask);
1841             return n;
1842         } else if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
1843                    "label=%i,proto=%i,tclass=%i,hlimit=%i,frag=%7[a-z])%n",
1844                    ipv6_src_s, ipv6_dst_s, &ipv6_label,
1845                    &ipv6_proto, &ipv6_tclass, &ipv6_hlimit, frag, &n) > 0
1846             && n > 0
1847             && ovs_frag_type_from_string(frag, &ipv6_frag)) {
1848             struct ovs_key_ipv6 ipv6_key;
1849
1850             if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
1851                 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
1852                 return -EINVAL;
1853             }
1854             ipv6_key.ipv6_label = htonl(ipv6_label);
1855             ipv6_key.ipv6_proto = ipv6_proto;
1856             ipv6_key.ipv6_tclass = ipv6_tclass;
1857             ipv6_key.ipv6_hlimit = ipv6_hlimit;
1858             ipv6_key.ipv6_frag = ipv6_frag;
1859             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
1860                               &ipv6_key, sizeof ipv6_key);
1861
1862             if (mask) {
1863                 memset(&ipv6_key, 0xff, sizeof ipv6_key);
1864                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV6,
1865                               &ipv6_key, sizeof ipv6_key);
1866             }
1867             return n;
1868         }
1869     }
1870
1871     {
1872         int tcp_src;
1873         int tcp_dst;
1874         int tcp_src_mask;
1875         int tcp_dst_mask;
1876         int n = -1;
1877
1878         if (mask && sscanf(s, "tcp(src=%i/%i,dst=%i/%i)%n",
1879                    &tcp_src, &tcp_src_mask, &tcp_dst, &tcp_dst_mask, &n) > 0
1880             && n > 0) {
1881             struct ovs_key_tcp tcp_key;
1882             struct ovs_key_tcp tcp_mask;
1883
1884             tcp_key.tcp_src = htons(tcp_src);
1885             tcp_key.tcp_dst = htons(tcp_dst);
1886             nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
1887
1888             tcp_mask.tcp_src = htons(tcp_src_mask);
1889             tcp_mask.tcp_dst = htons(tcp_dst_mask);
1890             nl_msg_put_unspec(mask, OVS_KEY_ATTR_TCP,
1891                               &tcp_mask, sizeof tcp_mask);
1892             return n;
1893         } else if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
1894             && n > 0) {
1895             struct ovs_key_tcp tcp_key;
1896
1897             tcp_key.tcp_src = htons(tcp_src);
1898             tcp_key.tcp_dst = htons(tcp_dst);
1899             nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
1900
1901             if (mask) {
1902                 memset(&tcp_key, 0xff, sizeof tcp_key);
1903                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_TCP,
1904                               &tcp_key, sizeof tcp_key);
1905             }
1906             return n;
1907         }
1908     }
1909
1910     {
1911         int udp_src;
1912         int udp_dst;
1913         int udp_src_mask;
1914         int udp_dst_mask;
1915         int n = -1;
1916
1917         if (mask && sscanf(s, "udp(src=%i/%i,dst=%i/%i)%n",
1918                    &udp_src, &udp_src_mask,
1919                    &udp_dst, &udp_dst_mask, &n) > 0 && n > 0) {
1920             struct ovs_key_udp udp_key;
1921             struct ovs_key_udp udp_mask;
1922
1923             udp_key.udp_src = htons(udp_src);
1924             udp_key.udp_dst = htons(udp_dst);
1925             nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
1926
1927             udp_mask.udp_src = htons(udp_src_mask);
1928             udp_mask.udp_dst = htons(udp_dst_mask);
1929             nl_msg_put_unspec(mask, OVS_KEY_ATTR_UDP,
1930                               &udp_mask, sizeof udp_mask);
1931             return n;
1932         }
1933         if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
1934             && n > 0) {
1935             struct ovs_key_udp udp_key;
1936
1937             udp_key.udp_src = htons(udp_src);
1938             udp_key.udp_dst = htons(udp_dst);
1939             nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
1940
1941             if (mask) {
1942                 memset(&udp_key, 0xff, sizeof udp_key);
1943                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
1944             }
1945             return n;
1946         }
1947     }
1948
1949     {
1950         int icmp_type;
1951         int icmp_code;
1952         int icmp_type_mask;
1953         int icmp_code_mask;
1954         int n = -1;
1955
1956         if (mask && sscanf(s, "icmp(type=%i/%i,code=%i/%i)%n",
1957                    &icmp_type, &icmp_type_mask,
1958                    &icmp_code, &icmp_code_mask, &n) > 0 && n > 0) {
1959             struct ovs_key_icmp icmp_key;
1960             struct ovs_key_icmp icmp_mask;
1961
1962             icmp_key.icmp_type = icmp_type;
1963             icmp_key.icmp_code = icmp_code;
1964             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
1965                               &icmp_key, sizeof icmp_key);
1966
1967             icmp_mask.icmp_type = icmp_type_mask;
1968             icmp_mask.icmp_code = icmp_code_mask;
1969             nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMP,
1970                               &icmp_mask, sizeof icmp_mask);
1971             return n;
1972         } else if (sscanf(s, "icmp(type=%i,code=%i)%n",
1973                    &icmp_type, &icmp_code, &n) > 0
1974             && n > 0) {
1975             struct ovs_key_icmp icmp_key;
1976
1977             icmp_key.icmp_type = icmp_type;
1978             icmp_key.icmp_code = icmp_code;
1979             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
1980                               &icmp_key, sizeof icmp_key);
1981             if (mask) {
1982                 memset(&icmp_key, 0xff, sizeof icmp_key);
1983                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMP, &icmp_key,
1984                               sizeof icmp_key);
1985             }
1986             return n;
1987         }
1988     }
1989
1990     {
1991         struct ovs_key_icmpv6 icmpv6_key;
1992         struct ovs_key_icmpv6 icmpv6_mask;
1993         int icmpv6_type_mask;
1994         int icmpv6_code_mask;
1995         int n = -1;
1996
1997         if (mask && sscanf(s, "icmpv6(type=%"SCNi8"/%i,code=%"SCNi8"/%i)%n",
1998                    &icmpv6_key.icmpv6_type, &icmpv6_type_mask,
1999                    &icmpv6_key.icmpv6_code, &icmpv6_code_mask, &n) > 0
2000             && n > 0) {
2001             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
2002                               &icmpv6_key, sizeof icmpv6_key);
2003
2004             icmpv6_mask.icmpv6_type = icmpv6_type_mask;
2005             icmpv6_mask.icmpv6_code = icmpv6_code_mask;
2006             nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMPV6, &icmpv6_mask,
2007                               sizeof icmpv6_mask);
2008             return n;
2009         } else if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
2010                    &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
2011             && n > 0) {
2012             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
2013                               &icmpv6_key, sizeof icmpv6_key);
2014
2015             if (mask) {
2016                 memset(&icmpv6_key, 0xff, sizeof icmpv6_key);
2017                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMPV6, &icmpv6_key,
2018                               sizeof icmpv6_key);
2019             }
2020             return n;
2021         }
2022     }
2023
2024     {
2025         ovs_be32 arp_sip, arp_sip_mask;
2026         ovs_be32 arp_tip, arp_tip_mask;
2027         int arp_op, arp_op_mask;
2028         uint8_t arp_sha[ETH_ADDR_LEN];
2029         uint8_t arp_sha_mask[ETH_ADDR_LEN];
2030         uint8_t arp_tha[ETH_ADDR_LEN];
2031         uint8_t arp_tha_mask[ETH_ADDR_LEN];
2032         int n = -1;
2033
2034         if (mask && sscanf(s, "arp(sip="IP_SCAN_FMT"/"IP_SCAN_FMT","
2035                    "tip="IP_SCAN_FMT"/"IP_SCAN_FMT","
2036                    "op=%i/%i,sha="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT","
2037                    "tha="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2038                    IP_SCAN_ARGS(&arp_sip), IP_SCAN_ARGS(&arp_sip_mask),
2039                    IP_SCAN_ARGS(&arp_tip), IP_SCAN_ARGS(&arp_tip_mask),
2040                    &arp_op, &arp_op_mask,
2041                    ETH_ADDR_SCAN_ARGS(arp_sha),
2042                    ETH_ADDR_SCAN_ARGS(arp_sha_mask),
2043                    ETH_ADDR_SCAN_ARGS(arp_tha),
2044                    ETH_ADDR_SCAN_ARGS(arp_tha_mask), &n) > 0 && n > 0) {
2045             struct ovs_key_arp arp_key;
2046             struct ovs_key_arp arp_mask;
2047
2048             memset(&arp_key, 0, sizeof arp_key);
2049             arp_key.arp_sip = arp_sip;
2050             arp_key.arp_tip = arp_tip;
2051             arp_key.arp_op = htons(arp_op);
2052             memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
2053             memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
2054             nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
2055
2056             arp_mask.arp_sip = arp_sip_mask;
2057             arp_mask.arp_tip = arp_tip_mask;
2058             arp_mask.arp_op = htons(arp_op_mask);
2059             memcpy(arp_mask.arp_sha, arp_sha_mask, ETH_ADDR_LEN);
2060             memcpy(arp_mask.arp_tha, arp_tha_mask, ETH_ADDR_LEN);
2061             nl_msg_put_unspec(mask, OVS_KEY_ATTR_ARP,
2062                               &arp_mask, sizeof arp_mask);
2063             return n;
2064         } else if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
2065                    "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
2066                    IP_SCAN_ARGS(&arp_sip),
2067                    IP_SCAN_ARGS(&arp_tip),
2068                    &arp_op,
2069                    ETH_ADDR_SCAN_ARGS(arp_sha),
2070                    ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
2071             struct ovs_key_arp arp_key;
2072
2073             memset(&arp_key, 0, sizeof arp_key);
2074             arp_key.arp_sip = arp_sip;
2075             arp_key.arp_tip = arp_tip;
2076             arp_key.arp_op = htons(arp_op);
2077             memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
2078             memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
2079             nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
2080
2081             if (mask) {
2082                 memset(&arp_key, 0xff, sizeof arp_key);
2083                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ARP,
2084                                   &arp_key, sizeof arp_key);
2085             }
2086             return n;
2087         }
2088     }
2089
2090     {
2091         char nd_target_s[IPV6_SCAN_LEN + 1];
2092         char nd_target_mask_s[IPV6_SCAN_LEN + 1];
2093         uint8_t nd_sll[ETH_ADDR_LEN];
2094         uint8_t nd_sll_mask[ETH_ADDR_LEN];
2095         uint8_t nd_tll[ETH_ADDR_LEN];
2096         uint8_t nd_tll_mask[ETH_ADDR_LEN];
2097         int n = -1;
2098
2099         memset(&nd_target_mask_s[0], 0xff, sizeof nd_target_s);
2100         memset(&nd_sll_mask[0], 0xff, sizeof nd_sll);
2101         memset(&nd_tll_mask [0], 0xff, sizeof nd_tll);
2102
2103         if (mask && sscanf(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT")%n",
2104                    nd_target_s, nd_target_mask_s, &n) > 0 && n > 0) {
2105                 put_nd_key(n, nd_target_s, NULL, NULL, key);
2106                 put_nd_key(n, nd_target_mask_s, NULL, NULL, mask);
2107         } else if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
2108                    nd_target_s, &n) > 0 && n > 0) {
2109                 put_nd_key(n, nd_target_s, NULL, NULL, key);
2110                 if (mask) {
2111                     put_nd_key(n, nd_target_mask_s, NULL, NULL, mask);
2112                 }
2113         } else if (mask && sscanf(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT
2114                          ",sll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2115                    nd_target_s, nd_target_mask_s,
2116                    ETH_ADDR_SCAN_ARGS(nd_sll),
2117                    ETH_ADDR_SCAN_ARGS(nd_sll_mask), &n) > 0 && n > 0) {
2118             put_nd_key(n, nd_target_s, nd_sll, NULL, key);
2119             put_nd_key(n, nd_target_mask_s, nd_sll_mask, NULL, mask);
2120         } else if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
2121                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
2122             && n > 0) {
2123             put_nd_key(n, nd_target_s, nd_sll, NULL, key);
2124             if (mask) {
2125                 put_nd_key(n, nd_target_mask_s, nd_sll_mask, NULL, mask);
2126             }
2127         } else if (mask && sscanf(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT
2128                          ",tll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2129                    nd_target_s, nd_target_mask_s,
2130                    ETH_ADDR_SCAN_ARGS(nd_tll),
2131                    ETH_ADDR_SCAN_ARGS(nd_tll_mask), &n) > 0 && n > 0) {
2132             put_nd_key(n, nd_target_s, NULL, nd_tll, key);
2133             put_nd_key(n, nd_target_mask_s, NULL, nd_tll_mask, mask);
2134         } else if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
2135                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
2136             && n > 0) {
2137             put_nd_key(n, nd_target_s, NULL, nd_tll, key);
2138             if (mask) {
2139                 put_nd_key(n, nd_target_mask_s, NULL, nd_tll_mask, mask);
2140             }
2141         } else if (mask && sscanf(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT
2142                    ",sll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT","
2143                    "tll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2144                    nd_target_s, nd_target_mask_s,
2145                    ETH_ADDR_SCAN_ARGS(nd_sll), ETH_ADDR_SCAN_ARGS(nd_sll_mask),
2146                    ETH_ADDR_SCAN_ARGS(nd_tll), ETH_ADDR_SCAN_ARGS(nd_tll_mask),
2147                    &n) > 0
2148             && n > 0) {
2149             put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
2150             put_nd_key(n, nd_target_mask_s, nd_sll_mask, nd_tll_mask, mask);
2151         } else if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
2152                    "tll="ETH_ADDR_SCAN_FMT")%n",
2153                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
2154                    ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
2155             && n > 0) {
2156             put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
2157             if (mask) {
2158                 put_nd_key(n, nd_target_mask_s, nd_sll_mask, nd_tll_mask, mask);
2159             }
2160         }
2161
2162         if (n != -1)
2163             return n;
2164
2165     }
2166
2167     if (!strncmp(s, "encap(", 6)) {
2168         const char *start = s;
2169         size_t encap, encap_mask = 0;
2170
2171         encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
2172         if (mask) {
2173             encap_mask = nl_msg_start_nested(mask, OVS_KEY_ATTR_ENCAP);
2174         }
2175
2176         s += 6;
2177         for (;;) {
2178             int retval;
2179
2180             s += strspn(s, ", \t\r\n");
2181             if (!*s) {
2182                 return -EINVAL;
2183             } else if (*s == ')') {
2184                 break;
2185             }
2186
2187             retval = parse_odp_key_mask_attr(s, port_names, key, mask);
2188             if (retval < 0) {
2189                 return retval;
2190             }
2191             s += retval;
2192         }
2193         s++;
2194
2195         nl_msg_end_nested(key, encap);
2196         if (mask) {
2197             nl_msg_end_nested(mask, encap_mask);
2198         }
2199
2200         return s - start;
2201     }
2202
2203     return -EINVAL;
2204 }
2205
2206 /* Parses the string representation of a datapath flow key, in the
2207  * format output by odp_flow_key_format().  Returns 0 if successful,
2208  * otherwise a positive errno value.  On success, the flow key is
2209  * appended to 'key' as a series of Netlink attributes.  On failure, no
2210  * data is appended to 'key'.  Either way, 'key''s data might be
2211  * reallocated.
2212  *
2213  * If 'port_names' is nonnull, it points to an simap that maps from a port name
2214  * to a port number.  (Port names may be used instead of port numbers in
2215  * in_port.)
2216  *
2217  * On success, the attributes appended to 'key' are individually syntactically
2218  * valid, but they may not be valid as a sequence.  'key' might, for example,
2219  * have duplicated keys.  odp_flow_key_to_flow() will detect those errors. */
2220 int
2221 odp_flow_from_string(const char *s, const struct simap *port_names,
2222                      struct ofpbuf *key, struct ofpbuf *mask)
2223 {
2224     const size_t old_size = key->size;
2225     for (;;) {
2226         int retval;
2227
2228         s += strspn(s, delimiters);
2229         if (!*s) {
2230             return 0;
2231         }
2232
2233         retval = parse_odp_key_mask_attr(s, port_names, key, mask);
2234         if (retval < 0) {
2235             key->size = old_size;
2236             return -retval;
2237         }
2238         s += retval;
2239     }
2240
2241     return 0;
2242 }
2243
2244 static uint8_t
2245 ovs_to_odp_frag(uint8_t nw_frag)
2246 {
2247     return (nw_frag == 0 ? OVS_FRAG_TYPE_NONE
2248           : nw_frag == FLOW_NW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
2249           : OVS_FRAG_TYPE_LATER);
2250 }
2251
2252 static void
2253 odp_flow_key_from_flow__(struct ofpbuf *buf, const struct flow *data,
2254                          const struct flow *flow, odp_port_t odp_in_port)
2255 {
2256     bool is_mask;
2257     struct ovs_key_ethernet *eth_key;
2258     size_t encap;
2259
2260     /* We assume that if 'data' and 'flow' are not the same, we should
2261      * treat 'data' as a mask. */
2262     is_mask = (data != flow);
2263
2264     if (flow->skb_priority) {
2265         nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, data->skb_priority);
2266     }
2267
2268     if (flow->tunnel.ip_dst) {
2269         tun_key_to_attr(buf, &data->tunnel);
2270     }
2271
2272     if (flow->skb_mark) {
2273         nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, data->skb_mark);
2274     }
2275
2276     /* Add an ingress port attribute if this is a mask or 'odp_in_port'
2277      * is not the magical value "ODPP_NONE". */
2278     if (is_mask || odp_in_port != ODPP_NONE) {
2279         nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, odp_in_port);
2280     }
2281
2282     eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
2283                                        sizeof *eth_key);
2284     memcpy(eth_key->eth_src, data->dl_src, ETH_ADDR_LEN);
2285     memcpy(eth_key->eth_dst, data->dl_dst, ETH_ADDR_LEN);
2286
2287     if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
2288         if (is_mask) {
2289             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(UINT16_MAX));
2290         } else {
2291             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
2292         }
2293         nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, data->vlan_tci);
2294         encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
2295         if (flow->vlan_tci == htons(0)) {
2296             goto unencap;
2297         }
2298     } else {
2299         encap = 0;
2300     }
2301
2302     if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
2303         /* For backwards compatibility with kernels that don't support
2304          * wildcarding, the following convention is used to encode the
2305          * OVS_KEY_ATTR_ETHERTYPE for key and mask:
2306          *
2307          *   key      mask    matches
2308          * -------- --------  -------
2309          *  >0x5ff   0xffff   Specified Ethernet II Ethertype.
2310          *  >0x5ff      0     Any Ethernet II or non-Ethernet II frame.
2311          *  <none>   0xffff   Any non-Ethernet II frame (except valid
2312          *                    802.3 SNAP packet with valid eth_type).
2313          */
2314         if (is_mask) {
2315             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, data->dl_type);
2316         }
2317         goto unencap;
2318     }
2319
2320     nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, data->dl_type);
2321
2322     if (flow->dl_type == htons(ETH_TYPE_IP)) {
2323         struct ovs_key_ipv4 *ipv4_key;
2324
2325         ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
2326                                             sizeof *ipv4_key);
2327         ipv4_key->ipv4_src = data->nw_src;
2328         ipv4_key->ipv4_dst = data->nw_dst;
2329         ipv4_key->ipv4_proto = data->nw_proto;
2330         ipv4_key->ipv4_tos = data->nw_tos;
2331         ipv4_key->ipv4_ttl = data->nw_ttl;
2332         ipv4_key->ipv4_frag = ovs_to_odp_frag(data->nw_frag);
2333     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
2334         struct ovs_key_ipv6 *ipv6_key;
2335
2336         ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
2337                                             sizeof *ipv6_key);
2338         memcpy(ipv6_key->ipv6_src, &data->ipv6_src, sizeof ipv6_key->ipv6_src);
2339         memcpy(ipv6_key->ipv6_dst, &data->ipv6_dst, sizeof ipv6_key->ipv6_dst);
2340         ipv6_key->ipv6_label = data->ipv6_label;
2341         ipv6_key->ipv6_proto = data->nw_proto;
2342         ipv6_key->ipv6_tclass = data->nw_tos;
2343         ipv6_key->ipv6_hlimit = data->nw_ttl;
2344         ipv6_key->ipv6_frag = ovs_to_odp_frag(flow->nw_frag);
2345     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
2346                flow->dl_type == htons(ETH_TYPE_RARP)) {
2347         struct ovs_key_arp *arp_key;
2348
2349         arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
2350                                            sizeof *arp_key);
2351         memset(arp_key, 0, sizeof *arp_key);
2352         arp_key->arp_sip = data->nw_src;
2353         arp_key->arp_tip = data->nw_dst;
2354         arp_key->arp_op = htons(data->nw_proto);
2355         memcpy(arp_key->arp_sha, data->arp_sha, ETH_ADDR_LEN);
2356         memcpy(arp_key->arp_tha, data->arp_tha, ETH_ADDR_LEN);
2357     }
2358
2359     if (flow->mpls_depth) {
2360         struct ovs_key_mpls *mpls_key;
2361
2362         mpls_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_MPLS,
2363                                             sizeof *mpls_key);
2364         mpls_key->mpls_lse = data->mpls_lse;
2365     }
2366
2367     if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2368         if (flow->nw_proto == IPPROTO_TCP) {
2369             struct ovs_key_tcp *tcp_key;
2370
2371             tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
2372                                                sizeof *tcp_key);
2373             tcp_key->tcp_src = data->tp_src;
2374             tcp_key->tcp_dst = data->tp_dst;
2375         } else if (flow->nw_proto == IPPROTO_UDP) {
2376             struct ovs_key_udp *udp_key;
2377
2378             udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
2379                                                sizeof *udp_key);
2380             udp_key->udp_src = data->tp_src;
2381             udp_key->udp_dst = data->tp_dst;
2382         } else if (flow->dl_type == htons(ETH_TYPE_IP)
2383                 && flow->nw_proto == IPPROTO_ICMP) {
2384             struct ovs_key_icmp *icmp_key;
2385
2386             icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
2387                                                 sizeof *icmp_key);
2388             icmp_key->icmp_type = ntohs(data->tp_src);
2389             icmp_key->icmp_code = ntohs(data->tp_dst);
2390         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
2391                 && flow->nw_proto == IPPROTO_ICMPV6) {
2392             struct ovs_key_icmpv6 *icmpv6_key;
2393
2394             icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
2395                                                   sizeof *icmpv6_key);
2396             icmpv6_key->icmpv6_type = ntohs(data->tp_src);
2397             icmpv6_key->icmpv6_code = ntohs(data->tp_dst);
2398
2399             if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
2400                     || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
2401                 struct ovs_key_nd *nd_key;
2402
2403                 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
2404                                                     sizeof *nd_key);
2405                 memcpy(nd_key->nd_target, &data->nd_target,
2406                         sizeof nd_key->nd_target);
2407                 memcpy(nd_key->nd_sll, data->arp_sha, ETH_ADDR_LEN);
2408                 memcpy(nd_key->nd_tll, data->arp_tha, ETH_ADDR_LEN);
2409             }
2410         }
2411     }
2412
2413 unencap:
2414     if (encap) {
2415         nl_msg_end_nested(buf, encap);
2416     }
2417 }
2418
2419 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'.
2420  * 'flow->in_port' is ignored (since it is likely to be an OpenFlow port
2421  * number rather than a datapath port number).  Instead, if 'odp_in_port'
2422  * is anything other than ODPP_NONE, it is included in 'buf' as the input
2423  * port.
2424  *
2425  * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
2426  * capable of being expanded to allow for that much space. */
2427 void
2428 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow,
2429                        odp_port_t odp_in_port)
2430 {
2431     odp_flow_key_from_flow__(buf, flow, flow, odp_in_port);
2432 }
2433
2434 /* Appends a representation of 'mask' as OVS_KEY_ATTR_* attributes to
2435  * 'buf'.  'flow' is used as a template to determine how to interpret
2436  * 'mask'.  For example, the 'dl_type' of 'mask' describes the mask, but
2437  * it doesn't indicate whether the other fields should be interpreted as
2438  * ARP, IPv4, IPv6, etc.
2439  *
2440  * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
2441  * capable of being expanded to allow for that much space. */
2442 void
2443 odp_flow_key_from_mask(struct ofpbuf *buf, const struct flow *mask,
2444                        const struct flow *flow, uint32_t odp_in_port_mask)
2445 {
2446     odp_flow_key_from_flow__(buf, mask, flow, u32_to_odp(odp_in_port_mask));
2447 }
2448
2449 uint32_t
2450 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
2451 {
2452     BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
2453     return hash_words((const uint32_t *) key, key_len / sizeof(uint32_t), 0);
2454 }
2455
2456 static void
2457 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
2458                        uint64_t attrs, int out_of_range_attr,
2459                        const struct nlattr *key, size_t key_len)
2460 {
2461     struct ds s;
2462     int i;
2463
2464     if (VLOG_DROP_DBG(rl)) {
2465         return;
2466     }
2467
2468     ds_init(&s);
2469     for (i = 0; i < 64; i++) {
2470         if (attrs & (UINT64_C(1) << i)) {
2471             char namebuf[OVS_KEY_ATTR_BUFSIZE];
2472
2473             ds_put_format(&s, " %s",
2474                           ovs_key_attr_to_string(i, namebuf, sizeof namebuf));
2475         }
2476     }
2477     if (out_of_range_attr) {
2478         ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
2479     }
2480
2481     ds_put_cstr(&s, ": ");
2482     odp_flow_key_format(key, key_len, &s);
2483
2484     VLOG_DBG("%s:%s", title, ds_cstr(&s));
2485     ds_destroy(&s);
2486 }
2487
2488 static bool
2489 odp_to_ovs_frag(uint8_t odp_frag, struct flow *flow)
2490 {
2491     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2492
2493     if (odp_frag > OVS_FRAG_TYPE_LATER) {
2494         VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
2495         return false;
2496     }
2497
2498     if (odp_frag != OVS_FRAG_TYPE_NONE) {
2499         flow->nw_frag |= FLOW_NW_FRAG_ANY;
2500         if (odp_frag == OVS_FRAG_TYPE_LATER) {
2501             flow->nw_frag |= FLOW_NW_FRAG_LATER;
2502         }
2503     }
2504     return true;
2505 }
2506
2507 static bool
2508 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
2509                    const struct nlattr *attrs[], uint64_t *present_attrsp,
2510                    int *out_of_range_attrp)
2511 {
2512     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
2513     const struct nlattr *nla;
2514     uint64_t present_attrs;
2515     size_t left;
2516
2517     BUILD_ASSERT(OVS_KEY_ATTR_MAX < CHAR_BIT * sizeof present_attrs);
2518     present_attrs = 0;
2519     *out_of_range_attrp = 0;
2520     NL_ATTR_FOR_EACH (nla, left, key, key_len) {
2521         uint16_t type = nl_attr_type(nla);
2522         size_t len = nl_attr_get_size(nla);
2523         int expected_len = odp_flow_key_attr_len(type);
2524
2525         if (len != expected_len && expected_len >= 0) {
2526             char namebuf[OVS_KEY_ATTR_BUFSIZE];
2527
2528             VLOG_ERR_RL(&rl, "attribute %s has length %zu but should have "
2529                         "length %d", ovs_key_attr_to_string(type, namebuf,
2530                                                             sizeof namebuf),
2531                         len, expected_len);
2532             return false;
2533         }
2534
2535         if (type > OVS_KEY_ATTR_MAX) {
2536             *out_of_range_attrp = type;
2537         } else {
2538             if (present_attrs & (UINT64_C(1) << type)) {
2539                 char namebuf[OVS_KEY_ATTR_BUFSIZE];
2540
2541                 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
2542                             ovs_key_attr_to_string(type,
2543                                                    namebuf, sizeof namebuf));
2544                 return false;
2545             }
2546
2547             present_attrs |= UINT64_C(1) << type;
2548             attrs[type] = nla;
2549         }
2550     }
2551     if (left) {
2552         VLOG_ERR_RL(&rl, "trailing garbage in flow key");
2553         return false;
2554     }
2555
2556     *present_attrsp = present_attrs;
2557     return true;
2558 }
2559
2560 static enum odp_key_fitness
2561 check_expectations(uint64_t present_attrs, int out_of_range_attr,
2562                    uint64_t expected_attrs,
2563                    const struct nlattr *key, size_t key_len)
2564 {
2565     uint64_t missing_attrs;
2566     uint64_t extra_attrs;
2567
2568     missing_attrs = expected_attrs & ~present_attrs;
2569     if (missing_attrs) {
2570         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
2571         log_odp_key_attributes(&rl, "expected but not present",
2572                                missing_attrs, 0, key, key_len);
2573         return ODP_FIT_TOO_LITTLE;
2574     }
2575
2576     extra_attrs = present_attrs & ~expected_attrs;
2577     if (extra_attrs || out_of_range_attr) {
2578         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
2579         log_odp_key_attributes(&rl, "present but not expected",
2580                                extra_attrs, out_of_range_attr, key, key_len);
2581         return ODP_FIT_TOO_MUCH;
2582     }
2583
2584     return ODP_FIT_PERFECT;
2585 }
2586
2587 static bool
2588 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
2589                 uint64_t present_attrs, uint64_t *expected_attrs,
2590                 struct flow *flow)
2591 {
2592     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2593
2594     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
2595         flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
2596         if (ntohs(flow->dl_type) < 1536) {
2597             VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
2598                         ntohs(flow->dl_type));
2599             return false;
2600         }
2601         *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
2602     } else {
2603         flow->dl_type = htons(FLOW_DL_TYPE_NONE);
2604     }
2605     return true;
2606 }
2607
2608 static enum odp_key_fitness
2609 parse_l2_5_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
2610                   uint64_t present_attrs, int out_of_range_attr,
2611                   uint64_t expected_attrs, struct flow *flow,
2612                   const struct nlattr *key, size_t key_len)
2613 {
2614     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2615
2616     if (eth_type_mpls(flow->dl_type)) {
2617         expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
2618
2619         if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS))) {
2620             return ODP_FIT_TOO_LITTLE;
2621         }
2622         flow->mpls_lse = nl_attr_get_be32(attrs[OVS_KEY_ATTR_MPLS]);
2623         flow->mpls_depth++;
2624     } else if (flow->dl_type == htons(ETH_TYPE_IP)) {
2625         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
2626         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
2627             const struct ovs_key_ipv4 *ipv4_key;
2628
2629             ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
2630             flow->nw_src = ipv4_key->ipv4_src;
2631             flow->nw_dst = ipv4_key->ipv4_dst;
2632             flow->nw_proto = ipv4_key->ipv4_proto;
2633             flow->nw_tos = ipv4_key->ipv4_tos;
2634             flow->nw_ttl = ipv4_key->ipv4_ttl;
2635             if (!odp_to_ovs_frag(ipv4_key->ipv4_frag, flow)) {
2636                 return ODP_FIT_ERROR;
2637             }
2638         }
2639     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
2640         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
2641         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
2642             const struct ovs_key_ipv6 *ipv6_key;
2643
2644             ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
2645             memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
2646             memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
2647             flow->ipv6_label = ipv6_key->ipv6_label;
2648             flow->nw_proto = ipv6_key->ipv6_proto;
2649             flow->nw_tos = ipv6_key->ipv6_tclass;
2650             flow->nw_ttl = ipv6_key->ipv6_hlimit;
2651             if (!odp_to_ovs_frag(ipv6_key->ipv6_frag, flow)) {
2652                 return ODP_FIT_ERROR;
2653             }
2654         }
2655     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
2656                flow->dl_type == htons(ETH_TYPE_RARP)) {
2657         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
2658         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
2659             const struct ovs_key_arp *arp_key;
2660
2661             arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
2662             flow->nw_src = arp_key->arp_sip;
2663             flow->nw_dst = arp_key->arp_tip;
2664             if (arp_key->arp_op & htons(0xff00)) {
2665                 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
2666                             "key", ntohs(arp_key->arp_op));
2667                 return ODP_FIT_ERROR;
2668             }
2669             flow->nw_proto = ntohs(arp_key->arp_op);
2670             memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
2671             memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
2672         }
2673     }
2674
2675     if (flow->nw_proto == IPPROTO_TCP
2676         && (flow->dl_type == htons(ETH_TYPE_IP) ||
2677             flow->dl_type == htons(ETH_TYPE_IPV6))
2678         && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2679         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
2680         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
2681             const struct ovs_key_tcp *tcp_key;
2682
2683             tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
2684             flow->tp_src = tcp_key->tcp_src;
2685             flow->tp_dst = tcp_key->tcp_dst;
2686         }
2687     } else if (flow->nw_proto == IPPROTO_UDP
2688                && (flow->dl_type == htons(ETH_TYPE_IP) ||
2689                    flow->dl_type == htons(ETH_TYPE_IPV6))
2690                && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2691         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
2692         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
2693             const struct ovs_key_udp *udp_key;
2694
2695             udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
2696             flow->tp_src = udp_key->udp_src;
2697             flow->tp_dst = udp_key->udp_dst;
2698         }
2699     } else if (flow->nw_proto == IPPROTO_ICMP
2700                && flow->dl_type == htons(ETH_TYPE_IP)
2701                && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2702         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
2703         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
2704             const struct ovs_key_icmp *icmp_key;
2705
2706             icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
2707             flow->tp_src = htons(icmp_key->icmp_type);
2708             flow->tp_dst = htons(icmp_key->icmp_code);
2709         }
2710     } else if (flow->nw_proto == IPPROTO_ICMPV6
2711                && flow->dl_type == htons(ETH_TYPE_IPV6)
2712                && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2713         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
2714         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
2715             const struct ovs_key_icmpv6 *icmpv6_key;
2716
2717             icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
2718             flow->tp_src = htons(icmpv6_key->icmpv6_type);
2719             flow->tp_dst = htons(icmpv6_key->icmpv6_code);
2720
2721             if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
2722                 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
2723                 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
2724                 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
2725                     const struct ovs_key_nd *nd_key;
2726
2727                     nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
2728                     memcpy(&flow->nd_target, nd_key->nd_target,
2729                            sizeof flow->nd_target);
2730                     memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
2731                     memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
2732                 }
2733             }
2734         }
2735     }
2736
2737     return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
2738                               key, key_len);
2739 }
2740
2741 /* Parse 802.1Q header then encapsulated L3 attributes. */
2742 static enum odp_key_fitness
2743 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
2744                    uint64_t present_attrs, int out_of_range_attr,
2745                    uint64_t expected_attrs, struct flow *flow,
2746                    const struct nlattr *key, size_t key_len)
2747 {
2748     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2749
2750     const struct nlattr *encap
2751         = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
2752            ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
2753     enum odp_key_fitness encap_fitness;
2754     enum odp_key_fitness fitness;
2755     ovs_be16 tci;
2756
2757     /* Calculate fitness of outer attributes. */
2758     expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
2759                        (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
2760     fitness = check_expectations(present_attrs, out_of_range_attr,
2761                                  expected_attrs, key, key_len);
2762
2763     /* Get the VLAN TCI value. */
2764     if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
2765         return ODP_FIT_TOO_LITTLE;
2766     }
2767     tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
2768     if (tci == htons(0)) {
2769         /* Corner case for a truncated 802.1Q header. */
2770         if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
2771             return ODP_FIT_TOO_MUCH;
2772         }
2773         return fitness;
2774     } else if (!(tci & htons(VLAN_CFI))) {
2775         VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
2776                     "but CFI bit is not set", ntohs(tci));
2777         return ODP_FIT_ERROR;
2778     }
2779
2780     /* Set vlan_tci.
2781      * Remove the TPID from dl_type since it's not the real Ethertype.  */
2782     flow->vlan_tci = tci;
2783     flow->dl_type = htons(0);
2784
2785     /* Now parse the encapsulated attributes. */
2786     if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
2787                             attrs, &present_attrs, &out_of_range_attr)) {
2788         return ODP_FIT_ERROR;
2789     }
2790     expected_attrs = 0;
2791
2792     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow)) {
2793         return ODP_FIT_ERROR;
2794     }
2795     encap_fitness = parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
2796                                       expected_attrs, flow, key, key_len);
2797
2798     /* The overall fitness is the worse of the outer and inner attributes. */
2799     return MAX(fitness, encap_fitness);
2800 }
2801
2802 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
2803  * structure in 'flow'.  Returns an ODP_FIT_* value that indicates how well
2804  * 'key' fits our expectations for what a flow key should contain.
2805  *
2806  * The 'in_port' will be the datapath's understanding of the port.  The
2807  * caller will need to translate with odp_port_to_ofp_port() if the
2808  * OpenFlow port is needed.
2809  *
2810  * This function doesn't take the packet itself as an argument because none of
2811  * the currently understood OVS_KEY_ATTR_* attributes require it.  Currently,
2812  * it is always possible to infer which additional attribute(s) should appear
2813  * by looking at the attributes for lower-level protocols, e.g. if the network
2814  * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
2815  * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
2816  * must be absent. */
2817 enum odp_key_fitness
2818 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
2819                      struct flow *flow)
2820 {
2821     const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
2822     uint64_t expected_attrs;
2823     uint64_t present_attrs;
2824     int out_of_range_attr;
2825
2826     memset(flow, 0, sizeof *flow);
2827
2828     /* Parse attributes. */
2829     if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
2830                             &out_of_range_attr)) {
2831         return ODP_FIT_ERROR;
2832     }
2833     expected_attrs = 0;
2834
2835     /* Metadata. */
2836     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
2837         flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
2838         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
2839     }
2840
2841     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK)) {
2842         flow->skb_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_SKB_MARK]);
2843         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK;
2844     }
2845
2846     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUNNEL)) {
2847         enum odp_key_fitness res;
2848
2849         res = odp_tun_key_from_attr(attrs[OVS_KEY_ATTR_TUNNEL], &flow->tunnel);
2850         if (res == ODP_FIT_ERROR) {
2851             return ODP_FIT_ERROR;
2852         } else if (res == ODP_FIT_PERFECT) {
2853             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUNNEL;
2854         }
2855     }
2856
2857     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
2858         flow->in_port.odp_port
2859             = nl_attr_get_odp_port(attrs[OVS_KEY_ATTR_IN_PORT]);
2860         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
2861     } else {
2862         flow->in_port.odp_port = ODPP_NONE;
2863     }
2864
2865     /* Ethernet header. */
2866     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
2867         const struct ovs_key_ethernet *eth_key;
2868
2869         eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
2870         memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
2871         memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
2872     }
2873     expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
2874
2875     /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
2876     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow)) {
2877         return ODP_FIT_ERROR;
2878     }
2879
2880     if (flow->dl_type == htons(ETH_TYPE_VLAN)) {
2881         return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
2882                                   expected_attrs, flow, key, key_len);
2883     }
2884     return parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
2885                              expected_attrs, flow, key, key_len);
2886 }
2887
2888 /* Returns 'fitness' as a string, for use in debug messages. */
2889 const char *
2890 odp_key_fitness_to_string(enum odp_key_fitness fitness)
2891 {
2892     switch (fitness) {
2893     case ODP_FIT_PERFECT:
2894         return "OK";
2895     case ODP_FIT_TOO_MUCH:
2896         return "too_much";
2897     case ODP_FIT_TOO_LITTLE:
2898         return "too_little";
2899     case ODP_FIT_ERROR:
2900         return "error";
2901     default:
2902         return "<unknown>";
2903     }
2904 }
2905
2906 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
2907  * Netlink PID 'pid'.  If 'userdata' is nonnull, adds a userdata attribute
2908  * whose contents are the 'userdata_size' bytes at 'userdata' and returns the
2909  * offset within 'odp_actions' of the start of the cookie.  (If 'userdata' is
2910  * null, then the return value is not meaningful.) */
2911 size_t
2912 odp_put_userspace_action(uint32_t pid,
2913                          const void *userdata, size_t userdata_size,
2914                          struct ofpbuf *odp_actions)
2915 {
2916     size_t userdata_ofs;
2917     size_t offset;
2918
2919     offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
2920     nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
2921     if (userdata) {
2922         userdata_ofs = odp_actions->size + NLA_HDRLEN;
2923         nl_msg_put_unspec(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
2924                           userdata, userdata_size);
2925     } else {
2926         userdata_ofs = 0;
2927     }
2928     nl_msg_end_nested(odp_actions, offset);
2929
2930     return userdata_ofs;
2931 }
2932
2933 void
2934 odp_put_tunnel_action(const struct flow_tnl *tunnel,
2935                       struct ofpbuf *odp_actions)
2936 {
2937     size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
2938     tun_key_to_attr(odp_actions, tunnel);
2939     nl_msg_end_nested(odp_actions, offset);
2940 }
2941 \f
2942 /* The commit_odp_actions() function and its helpers. */
2943
2944 static void
2945 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
2946                   const void *key, size_t key_size)
2947 {
2948     size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
2949     nl_msg_put_unspec(odp_actions, key_type, key, key_size);
2950     nl_msg_end_nested(odp_actions, offset);
2951 }
2952
2953 void
2954 odp_put_skb_mark_action(const uint32_t skb_mark,
2955                         struct ofpbuf *odp_actions)
2956 {
2957     commit_set_action(odp_actions, OVS_KEY_ATTR_SKB_MARK, &skb_mark,
2958                       sizeof(skb_mark));
2959 }
2960
2961 /* If any of the flow key data that ODP actions can modify are different in
2962  * 'base->tunnel' and 'flow->tunnel', appends a set_tunnel ODP action to
2963  * 'odp_actions' that change the flow tunneling information in key from
2964  * 'base->tunnel' into 'flow->tunnel', and then changes 'base->tunnel' in the
2965  * same way.  In other words, operates the same as commit_odp_actions(), but
2966  * only on tunneling information. */
2967 void
2968 commit_odp_tunnel_action(const struct flow *flow, struct flow *base,
2969                          struct ofpbuf *odp_actions)
2970 {
2971     /* A valid IPV4_TUNNEL must have non-zero ip_dst. */
2972     if (flow->tunnel.ip_dst) {
2973         if (!memcmp(&base->tunnel, &flow->tunnel, sizeof base->tunnel)) {
2974             return;
2975         }
2976         memcpy(&base->tunnel, &flow->tunnel, sizeof base->tunnel);
2977         odp_put_tunnel_action(&base->tunnel, odp_actions);
2978     }
2979 }
2980
2981 static void
2982 commit_set_ether_addr_action(const struct flow *flow, struct flow *base,
2983                              struct ofpbuf *odp_actions,
2984                              struct flow_wildcards *wc)
2985 {
2986     struct ovs_key_ethernet eth_key;
2987
2988     if (eth_addr_equals(base->dl_src, flow->dl_src) &&
2989         eth_addr_equals(base->dl_dst, flow->dl_dst)) {
2990         return;
2991     }
2992
2993     memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
2994     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
2995
2996     memcpy(base->dl_src, flow->dl_src, ETH_ADDR_LEN);
2997     memcpy(base->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
2998
2999     memcpy(eth_key.eth_src, base->dl_src, ETH_ADDR_LEN);
3000     memcpy(eth_key.eth_dst, base->dl_dst, ETH_ADDR_LEN);
3001
3002     commit_set_action(odp_actions, OVS_KEY_ATTR_ETHERNET,
3003                       &eth_key, sizeof(eth_key));
3004 }
3005
3006 static void
3007 commit_vlan_action(const struct flow *flow, struct flow *base,
3008                    struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3009 {
3010     if (base->vlan_tci == flow->vlan_tci) {
3011         return;
3012     }
3013
3014     memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
3015
3016     if (base->vlan_tci & htons(VLAN_CFI)) {
3017         nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
3018     }
3019
3020     if (flow->vlan_tci & htons(VLAN_CFI)) {
3021         struct ovs_action_push_vlan vlan;
3022
3023         vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
3024         vlan.vlan_tci = flow->vlan_tci;
3025         nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
3026                           &vlan, sizeof vlan);
3027     }
3028     base->vlan_tci = flow->vlan_tci;
3029 }
3030
3031 static void
3032 commit_mpls_action(const struct flow *flow, struct flow *base,
3033                    struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3034 {
3035     if (flow->mpls_lse == base->mpls_lse &&
3036         flow->mpls_depth == base->mpls_depth) {
3037         return;
3038     }
3039
3040     memset(&wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
3041
3042     if (flow->mpls_depth < base->mpls_depth) {
3043         if (base->mpls_depth - flow->mpls_depth > 1) {
3044             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3045             VLOG_WARN_RL(&rl, "Multiple mpls_pop actions reduced to "
3046                          " a single mpls_pop action");
3047         }
3048
3049         nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_POP_MPLS, flow->dl_type);
3050     } else if (flow->mpls_depth > base->mpls_depth) {
3051         struct ovs_action_push_mpls *mpls;
3052
3053         if (flow->mpls_depth - base->mpls_depth > 1) {
3054             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3055             VLOG_WARN_RL(&rl, "Multiple mpls_push actions reduced to "
3056                          " a single mpls_push action");
3057         }
3058
3059         mpls = nl_msg_put_unspec_uninit(odp_actions, OVS_ACTION_ATTR_PUSH_MPLS,
3060                                         sizeof *mpls);
3061         memset(mpls, 0, sizeof *mpls);
3062         mpls->mpls_ethertype = flow->dl_type;
3063         mpls->mpls_lse = flow->mpls_lse;
3064     } else {
3065         struct ovs_key_mpls mpls_key;
3066
3067         mpls_key.mpls_lse = flow->mpls_lse;
3068         commit_set_action(odp_actions, OVS_KEY_ATTR_MPLS,
3069                           &mpls_key, sizeof(mpls_key));
3070     }
3071
3072     base->dl_type = flow->dl_type;
3073     base->mpls_lse = flow->mpls_lse;
3074     base->mpls_depth = flow->mpls_depth;
3075 }
3076
3077 static void
3078 commit_set_ipv4_action(const struct flow *flow, struct flow *base,
3079                      struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3080 {
3081     struct ovs_key_ipv4 ipv4_key;
3082
3083     if (base->nw_src == flow->nw_src &&
3084         base->nw_dst == flow->nw_dst &&
3085         base->nw_tos == flow->nw_tos &&
3086         base->nw_ttl == flow->nw_ttl &&
3087         base->nw_frag == flow->nw_frag) {
3088         return;
3089     }
3090
3091     memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
3092     memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
3093     memset(&wc->masks.nw_tos, 0xff, sizeof wc->masks.nw_tos);
3094     memset(&wc->masks.nw_ttl, 0xff, sizeof wc->masks.nw_ttl);
3095     memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
3096     memset(&wc->masks.nw_frag, 0xff, sizeof wc->masks.nw_frag);
3097
3098     ipv4_key.ipv4_src = base->nw_src = flow->nw_src;
3099     ipv4_key.ipv4_dst = base->nw_dst = flow->nw_dst;
3100     ipv4_key.ipv4_tos = base->nw_tos = flow->nw_tos;
3101     ipv4_key.ipv4_ttl = base->nw_ttl = flow->nw_ttl;
3102     ipv4_key.ipv4_proto = base->nw_proto;
3103     ipv4_key.ipv4_frag = ovs_to_odp_frag(base->nw_frag);
3104
3105     commit_set_action(odp_actions, OVS_KEY_ATTR_IPV4,
3106                       &ipv4_key, sizeof(ipv4_key));
3107 }
3108
3109 static void
3110 commit_set_ipv6_action(const struct flow *flow, struct flow *base,
3111                        struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3112 {
3113     struct ovs_key_ipv6 ipv6_key;
3114
3115     if (ipv6_addr_equals(&base->ipv6_src, &flow->ipv6_src) &&
3116         ipv6_addr_equals(&base->ipv6_dst, &flow->ipv6_dst) &&
3117         base->ipv6_label == flow->ipv6_label &&
3118         base->nw_tos == flow->nw_tos &&
3119         base->nw_ttl == flow->nw_ttl &&
3120         base->nw_frag == flow->nw_frag) {
3121         return;
3122     }
3123
3124     memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
3125     memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
3126     memset(&wc->masks.ipv6_label, 0xff, sizeof wc->masks.ipv6_label);
3127     memset(&wc->masks.nw_tos, 0xff, sizeof wc->masks.nw_tos);
3128     memset(&wc->masks.nw_ttl, 0xff, sizeof wc->masks.nw_ttl);
3129     memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
3130     memset(&wc->masks.nw_frag, 0xff, sizeof wc->masks.nw_frag);
3131
3132     base->ipv6_src = flow->ipv6_src;
3133     memcpy(&ipv6_key.ipv6_src, &base->ipv6_src, sizeof(ipv6_key.ipv6_src));
3134     base->ipv6_dst = flow->ipv6_dst;
3135     memcpy(&ipv6_key.ipv6_dst, &base->ipv6_dst, sizeof(ipv6_key.ipv6_dst));
3136
3137     ipv6_key.ipv6_label = base->ipv6_label = flow->ipv6_label;
3138     ipv6_key.ipv6_tclass = base->nw_tos = flow->nw_tos;
3139     ipv6_key.ipv6_hlimit = base->nw_ttl = flow->nw_ttl;
3140     ipv6_key.ipv6_proto = base->nw_proto;
3141     ipv6_key.ipv6_frag = ovs_to_odp_frag(base->nw_frag);
3142
3143     commit_set_action(odp_actions, OVS_KEY_ATTR_IPV6,
3144                       &ipv6_key, sizeof(ipv6_key));
3145 }
3146
3147 static void
3148 commit_set_nw_action(const struct flow *flow, struct flow *base,
3149                      struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3150 {
3151     /* Check if flow really have an IP header. */
3152     if (!flow->nw_proto) {
3153         return;
3154     }
3155
3156     if (base->dl_type == htons(ETH_TYPE_IP)) {
3157         commit_set_ipv4_action(flow, base, odp_actions, wc);
3158     } else if (base->dl_type == htons(ETH_TYPE_IPV6)) {
3159         commit_set_ipv6_action(flow, base, odp_actions, wc);
3160     }
3161 }
3162
3163 static void
3164 commit_set_port_action(const struct flow *flow, struct flow *base,
3165                        struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3166 {
3167     if (!is_ip_any(base) || (!base->tp_src && !base->tp_dst)) {
3168         return;
3169     }
3170
3171     if (base->tp_src == flow->tp_src &&
3172         base->tp_dst == flow->tp_dst) {
3173         return;
3174     }
3175
3176     memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
3177     memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
3178
3179     if (flow->nw_proto == IPPROTO_TCP) {
3180         struct ovs_key_tcp port_key;
3181
3182         port_key.tcp_src = base->tp_src = flow->tp_src;
3183         port_key.tcp_dst = base->tp_dst = flow->tp_dst;
3184
3185         commit_set_action(odp_actions, OVS_KEY_ATTR_TCP,
3186                           &port_key, sizeof(port_key));
3187
3188     } else if (flow->nw_proto == IPPROTO_UDP) {
3189         struct ovs_key_udp port_key;
3190
3191         port_key.udp_src = base->tp_src = flow->tp_src;
3192         port_key.udp_dst = base->tp_dst = flow->tp_dst;
3193
3194         commit_set_action(odp_actions, OVS_KEY_ATTR_UDP,
3195                           &port_key, sizeof(port_key));
3196     }
3197 }
3198
3199 static void
3200 commit_set_priority_action(const struct flow *flow, struct flow *base,
3201                            struct ofpbuf *odp_actions,
3202                            struct flow_wildcards *wc)
3203 {
3204     if (base->skb_priority == flow->skb_priority) {
3205         return;
3206     }
3207
3208     memset(&wc->masks.skb_priority, 0xff, sizeof wc->masks.skb_priority);
3209     base->skb_priority = flow->skb_priority;
3210
3211     commit_set_action(odp_actions, OVS_KEY_ATTR_PRIORITY,
3212                       &base->skb_priority, sizeof(base->skb_priority));
3213 }
3214
3215 static void
3216 commit_set_skb_mark_action(const struct flow *flow, struct flow *base,
3217                            struct ofpbuf *odp_actions,
3218                            struct flow_wildcards *wc)
3219 {
3220     if (base->skb_mark == flow->skb_mark) {
3221         return;
3222     }
3223
3224     memset(&wc->masks.skb_mark, 0xff, sizeof wc->masks.skb_mark);
3225     base->skb_mark = flow->skb_mark;
3226
3227     odp_put_skb_mark_action(base->skb_mark, odp_actions);
3228 }
3229 /* If any of the flow key data that ODP actions can modify are different in
3230  * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
3231  * key from 'base' into 'flow', and then changes 'base' the same way.  Does not
3232  * commit set_tunnel actions.  Users should call commit_odp_tunnel_action()
3233  * in addition to this function if needed.  Sets fields in 'wc' that are
3234  * used as part of the action. */
3235 void
3236 commit_odp_actions(const struct flow *flow, struct flow *base,
3237                    struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3238 {
3239     commit_set_ether_addr_action(flow, base, odp_actions, wc);
3240     commit_vlan_action(flow, base, odp_actions, wc);
3241     commit_set_nw_action(flow, base, odp_actions, wc);
3242     commit_set_port_action(flow, base, odp_actions, wc);
3243     /* Committing MPLS actions should occur after committing nw and port
3244      * actions. This is because committing MPLS actions may alter a packet so
3245      * that it is no longer IP and thus nw and port actions are no longer valid.
3246      */
3247     commit_mpls_action(flow, base, odp_actions, wc);
3248     commit_set_priority_action(flow, base, odp_actions, wc);
3249     commit_set_skb_mark_action(flow, base, odp_actions, wc);
3250 }