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