lib/odp-util.c

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