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