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
  28 #include "byte-order.h"
  29 #include "coverage.h"
  30 #include "dpif.h"
  31 #include "dynamic-string.h"
  32 #include "flow.h"
  33 #include "netlink.h"
  34 #include "ofpbuf.h"
  35 #include "packets.h"
  36 #include "simap.h"
  37 #include "timeval.h"
  38 #include "unaligned.h"
  39 #include "util.h"
  40 #include "uuid.h"
  41 #include "openvswitch/vlog.h"
  42
  43 VLOG_DEFINE_THIS_MODULE(odp_util);
  44
  45 /* The interface between userspace and kernel uses an "OVS_*" prefix.
  46  * Since this is fairly non-specific for the OVS userspace components,
  47  * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
  48  * interactions with the datapath.
  49  */
  50
  51 /* The set of characters that may separate one action or one key attribute
  52  * from another. */
  53 static const char *delimiters = ", \t\r\n";
  54
  55 struct attr_len_tbl {
  56     int len;
  57     const struct attr_len_tbl *next;
  58     int next_max;
  59 };
  60 #define ATTR_LEN_INVALID  -1
  61 #define ATTR_LEN_VARIABLE -2
  62 #define ATTR_LEN_NESTED   -3
  63
  64 static int parse_odp_key_mask_attr(const char *, const struct simap *port_names,
  65                               struct ofpbuf *, struct ofpbuf *);
  66 static void format_odp_key_attr(const struct nlattr *a,
  67                                 const struct nlattr *ma,
  68                                 const struct hmap *portno_names, struct ds *ds,
  69                                 bool verbose);
  70
  71 static struct nlattr *generate_all_wildcard_mask(const struct attr_len_tbl tbl[],
  72                                                  int max, struct ofpbuf *,
  73                                                  const struct nlattr *key);
  74 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
  75  * 'type':
  76  *
  77  *   - For an action whose argument has a fixed length, returned that
  78  *     nonnegative length in bytes.
  79  *
  80  *   - For an action with a variable-length argument, returns ATTR_LEN_VARIABLE.
  81  *
  82  *   - For an invalid 'type', returns ATTR_LEN_INVALID. */
  83 static int
  84 odp_action_len(uint16_t type)
  85 {
  86     if (type > OVS_ACTION_ATTR_MAX) {
  87         return -1;
  88     }
  89
  90     switch ((enum ovs_action_attr) type) {
  91     case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
  92     case OVS_ACTION_ATTR_TUNNEL_PUSH: return ATTR_LEN_VARIABLE;
  93     case OVS_ACTION_ATTR_TUNNEL_POP: return sizeof(uint32_t);
  94     case OVS_ACTION_ATTR_USERSPACE: return ATTR_LEN_VARIABLE;
  95     case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
  96     case OVS_ACTION_ATTR_POP_VLAN: return 0;
  97     case OVS_ACTION_ATTR_PUSH_MPLS: return sizeof(struct ovs_action_push_mpls);
  98     case OVS_ACTION_ATTR_POP_MPLS: return sizeof(ovs_be16);
  99     case OVS_ACTION_ATTR_RECIRC: return sizeof(uint32_t);
 100     case OVS_ACTION_ATTR_HASH: return sizeof(struct ovs_action_hash);
 101     case OVS_ACTION_ATTR_SET: return ATTR_LEN_VARIABLE;
 102     case OVS_ACTION_ATTR_SET_MASKED: return ATTR_LEN_VARIABLE;
 103     case OVS_ACTION_ATTR_SAMPLE: return ATTR_LEN_VARIABLE;
 104
 105     case OVS_ACTION_ATTR_UNSPEC:
 106     case __OVS_ACTION_ATTR_MAX:
 107         return ATTR_LEN_INVALID;
 108     }
 109
 110     return ATTR_LEN_INVALID;
 111 }
 112
 113 /* Returns a string form of 'attr'.  The return value is either a statically
 114  * allocated constant string or the 'bufsize'-byte buffer 'namebuf'.  'bufsize'
 115  * should be at least OVS_KEY_ATTR_BUFSIZE. */
 116 enum { OVS_KEY_ATTR_BUFSIZE = 3 + INT_STRLEN(unsigned int) + 1 };
 117 static const char *
 118 ovs_key_attr_to_string(enum ovs_key_attr attr, char *namebuf, size_t bufsize)
 119 {
 120     switch (attr) {
 121     case OVS_KEY_ATTR_UNSPEC: return "unspec";
 122     case OVS_KEY_ATTR_ENCAP: return "encap";
 123     case OVS_KEY_ATTR_PRIORITY: return "skb_priority";
 124     case OVS_KEY_ATTR_SKB_MARK: return "skb_mark";
 125     case OVS_KEY_ATTR_TUNNEL: return "tunnel";
 126     case OVS_KEY_ATTR_IN_PORT: return "in_port";
 127     case OVS_KEY_ATTR_ETHERNET: return "eth";
 128     case OVS_KEY_ATTR_VLAN: return "vlan";
 129     case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
 130     case OVS_KEY_ATTR_IPV4: return "ipv4";
 131     case OVS_KEY_ATTR_IPV6: return "ipv6";
 132     case OVS_KEY_ATTR_TCP: return "tcp";
 133     case OVS_KEY_ATTR_TCP_FLAGS: return "tcp_flags";
 134     case OVS_KEY_ATTR_UDP: return "udp";
 135     case OVS_KEY_ATTR_SCTP: return "sctp";
 136     case OVS_KEY_ATTR_ICMP: return "icmp";
 137     case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
 138     case OVS_KEY_ATTR_ARP: return "arp";
 139     case OVS_KEY_ATTR_ND: return "nd";
 140     case OVS_KEY_ATTR_MPLS: return "mpls";
 141     case OVS_KEY_ATTR_DP_HASH: return "dp_hash";
 142     case OVS_KEY_ATTR_RECIRC_ID: return "recirc_id";
 143
 144     case __OVS_KEY_ATTR_MAX:
 145     default:
 146         snprintf(namebuf, bufsize, "key%u", (unsigned int) attr);
 147         return namebuf;
 148     }
 149 }
 150
 151 static void
 152 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
 153 {
 154     size_t len = nl_attr_get_size(a);
 155
 156     ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
 157     if (len) {
 158         const uint8_t *unspec;
 159         unsigned int i;
 160
 161         unspec = nl_attr_get(a);
 162         for (i = 0; i < len; i++) {
 163             ds_put_char(ds, i ? ' ': '(');
 164             ds_put_format(ds, "%02x", unspec[i]);
 165         }
 166         ds_put_char(ds, ')');
 167     }
 168 }
 169
 170 static void
 171 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
 172 {
 173     static const struct nl_policy ovs_sample_policy[] = {
 174         [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
 175         [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
 176     };
 177     struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
 178     double percentage;
 179     const struct nlattr *nla_acts;
 180     int len;
 181
 182     ds_put_cstr(ds, "sample");
 183
 184     if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
 185         ds_put_cstr(ds, "(error)");
 186         return;
 187     }
 188
 189     percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
 190                         UINT32_MAX;
 191
 192     ds_put_format(ds, "(sample=%.1f%%,", percentage);
 193
 194     ds_put_cstr(ds, "actions(");
 195     nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
 196     len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
 197     format_odp_actions(ds, nla_acts, len);
 198     ds_put_format(ds, "))");
 199 }
 200
 201 static const char *
 202 slow_path_reason_to_string(uint32_t reason)
 203 {
 204     switch ((enum slow_path_reason) reason) {
 205 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return STRING;
 206         SLOW_PATH_REASONS
 207 #undef SPR
 208     }
 209
 210     return NULL;
 211 }
 212
 213 const char *
 214 slow_path_reason_to_explanation(enum slow_path_reason reason)
 215 {
 216     switch (reason) {
 217 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return EXPLANATION;
 218         SLOW_PATH_REASONS
 219 #undef SPR
 220     }
 221
 222     return "<unknown>";
 223 }
 224
 225 static int
 226 parse_flags(const char *s, const char *(*bit_to_string)(uint32_t),
 227             uint32_t *res_flags, uint32_t allowed, uint32_t *res_mask)
 228 {
 229     uint32_t result = 0;
 230     int n;
 231
 232     /* Parse masked flags in numeric format? */
 233     if (res_mask && ovs_scan(s, "%"SCNi32"/%"SCNi32"%n",
 234                              res_flags, res_mask, &n) && n > 0) {
 235         if (*res_flags & ~allowed || *res_mask & ~allowed) {
 236             return -EINVAL;
 237         }
 238         return n;
 239     }
 240
 241     n = 0;
 242
 243     if (res_mask && (*s == '+' || *s == '-')) {
 244         uint32_t flags = 0, mask = 0;
 245
 246         /* Parse masked flags. */
 247         while (s[0] != ')') {
 248             bool set;
 249             uint32_t bit;
 250             int name_len;
 251
 252             if (s[0] == '+') {
 253                 set = true;
 254             } else if (s[0] == '-') {
 255                 set = false;
 256             } else {
 257                 return -EINVAL;
 258             }
 259             s++;
 260             n++;
 261
 262             name_len = strcspn(s, "+-)");
 263
 264             for (bit = 1; bit; bit <<= 1) {
 265                 const char *fname = bit_to_string(bit);
 266                 size_t len;
 267
 268                 if (!fname) {
 269                     continue;
 270                 }
 271
 272                 len = strlen(fname);
 273                 if (len != name_len) {
 274                     continue;
 275                 }
 276                 if (!strncmp(s, fname, len)) {
 277                     if (mask & bit) {
 278                         /* bit already set. */
 279                         return -EINVAL;
 280                     }
 281                     if (!(bit & allowed)) {
 282                         return -EINVAL;
 283                     }
 284                     if (set) {
 285                         flags |= bit;
 286                     }
 287                     mask |= bit;
 288                     break;
 289                 }
 290             }
 291
 292             if (!bit) {
 293                 return -EINVAL; /* Unknown flag name */
 294             }
 295             s += name_len;
 296             n += name_len;
 297         }
 298
 299         *res_flags = flags;
 300         *res_mask = mask;
 301         return n;
 302     }
 303
 304     /* Parse unmasked flags.  If a flag is present, it is set, otherwise
 305      * it is not set. */
 306     while (s[n] != ')') {
 307         unsigned long long int flags;
 308         uint32_t bit;
 309         int n0;
 310
 311         if (ovs_scan(&s[n], "%lli%n", &flags, &n0)) {
 312             if (flags & ~allowed) {
 313                 return -EINVAL;
 314             }
 315             n += n0 + (s[n + n0] == ',');
 316             result |= flags;
 317             continue;
 318         }
 319
 320         for (bit = 1; bit; bit <<= 1) {
 321             const char *name = bit_to_string(bit);
 322             size_t len;
 323
 324             if (!name) {
 325                 continue;
 326             }
 327
 328             len = strlen(name);
 329             if (!strncmp(s + n, name, len) &&
 330                 (s[n + len] == ',' || s[n + len] == ')')) {
 331                 if (!(bit & allowed)) {
 332                     return -EINVAL;
 333                 }
 334                 result |= bit;
 335                 n += len + (s[n + len] == ',');
 336                 break;
 337             }
 338         }
 339
 340         if (!bit) {
 341             return -EINVAL;
 342         }
 343     }
 344
 345     *res_flags = result;
 346     if (res_mask) {
 347         *res_mask = UINT32_MAX;
 348     }
 349     return n;
 350 }
 351
 352 static void
 353 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
 354 {
 355     static const struct nl_policy ovs_userspace_policy[] = {
 356         [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
 357         [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_UNSPEC,
 358                                           .optional = true },
 359         [OVS_USERSPACE_ATTR_EGRESS_TUN_PORT] = { .type = NL_A_U32,
 360                                                  .optional = true },
 361     };
 362     struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
 363     const struct nlattr *userdata_attr;
 364     const struct nlattr *tunnel_out_port_attr;
 365
 366     if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
 367         ds_put_cstr(ds, "userspace(error)");
 368         return;
 369     }
 370
 371     ds_put_format(ds, "userspace(pid=%"PRIu32,
 372                   nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
 373
 374     userdata_attr = a[OVS_USERSPACE_ATTR_USERDATA];
 375
 376     if (userdata_attr) {
 377         const uint8_t *userdata = nl_attr_get(userdata_attr);
 378         size_t userdata_len = nl_attr_get_size(userdata_attr);
 379         bool userdata_unspec = true;
 380         union user_action_cookie cookie;
 381
 382         if (userdata_len >= sizeof cookie.type
 383             && userdata_len <= sizeof cookie) {
 384
 385             memset(&cookie, 0, sizeof cookie);
 386             memcpy(&cookie, userdata, userdata_len);
 387
 388             userdata_unspec = false;
 389
 390             if (userdata_len == sizeof cookie.sflow
 391                 && cookie.type == USER_ACTION_COOKIE_SFLOW) {
 392                 ds_put_format(ds, ",sFlow("
 393                               "vid=%"PRIu16",pcp=%"PRIu8",output=%"PRIu32")",
 394                               vlan_tci_to_vid(cookie.sflow.vlan_tci),
 395                               vlan_tci_to_pcp(cookie.sflow.vlan_tci),
 396                               cookie.sflow.output);
 397             } else if (userdata_len == sizeof cookie.slow_path
 398                        && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
 399                 ds_put_cstr(ds, ",slow_path(");
 400                 format_flags(ds, slow_path_reason_to_string,
 401                              cookie.slow_path.reason, ',');
 402                 ds_put_format(ds, ")");
 403             } else if (userdata_len == sizeof cookie.flow_sample
 404                        && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
 405                 ds_put_format(ds, ",flow_sample(probability=%"PRIu16
 406                               ",collector_set_id=%"PRIu32
 407                               ",obs_domain_id=%"PRIu32
 408                               ",obs_point_id=%"PRIu32")",
 409                               cookie.flow_sample.probability,
 410                               cookie.flow_sample.collector_set_id,
 411                               cookie.flow_sample.obs_domain_id,
 412                               cookie.flow_sample.obs_point_id);
 413             } else if (userdata_len >= sizeof cookie.ipfix
 414                        && cookie.type == USER_ACTION_COOKIE_IPFIX) {
 415                 ds_put_format(ds, ",ipfix(output_port=%"PRIu32")",
 416                               cookie.ipfix.output_odp_port);
 417             } else {
 418                 userdata_unspec = true;
 419             }
 420         }
 421
 422         if (userdata_unspec) {
 423             size_t i;
 424             ds_put_format(ds, ",userdata(");
 425             for (i = 0; i < userdata_len; i++) {
 426                 ds_put_format(ds, "%02x", userdata[i]);
 427             }
 428             ds_put_char(ds, ')');
 429         }
 430     }
 431
 432     tunnel_out_port_attr = a[OVS_USERSPACE_ATTR_EGRESS_TUN_PORT];
 433     if (tunnel_out_port_attr) {
 434         ds_put_format(ds, ",tunnel_out_port=%"PRIu32,
 435                       nl_attr_get_u32(tunnel_out_port_attr));
 436     }
 437
 438     ds_put_char(ds, ')');
 439 }
 440
 441 static void
 442 format_vlan_tci(struct ds *ds, ovs_be16 tci, ovs_be16 mask, bool verbose)
 443 {
 444     if (verbose || vlan_tci_to_vid(tci) || vlan_tci_to_vid(mask)) {
 445         ds_put_format(ds, "vid=%"PRIu16, vlan_tci_to_vid(tci));
 446         if (vlan_tci_to_vid(mask) != VLAN_VID_MASK) { /* Partially masked. */
 447             ds_put_format(ds, "/0x%"PRIx16, vlan_tci_to_vid(mask));
 448         };
 449         ds_put_char(ds, ',');
 450     }
 451     if (verbose || vlan_tci_to_pcp(tci) || vlan_tci_to_pcp(mask)) {
 452         ds_put_format(ds, "pcp=%d", vlan_tci_to_pcp(tci));
 453         if (vlan_tci_to_pcp(mask) != (VLAN_PCP_MASK >> VLAN_PCP_SHIFT)) {
 454             ds_put_format(ds, "/0x%x", vlan_tci_to_pcp(mask));
 455         }
 456         ds_put_char(ds, ',');
 457     }
 458     if (!(tci & htons(VLAN_CFI))) {
 459         ds_put_cstr(ds, "cfi=0");
 460         ds_put_char(ds, ',');
 461     }
 462     ds_chomp(ds, ',');
 463 }
 464
 465 static void
 466 format_mpls_lse(struct ds *ds, ovs_be32 mpls_lse)
 467 {
 468     ds_put_format(ds, "label=%"PRIu32",tc=%d,ttl=%d,bos=%d",
 469                   mpls_lse_to_label(mpls_lse),
 470                   mpls_lse_to_tc(mpls_lse),
 471                   mpls_lse_to_ttl(mpls_lse),
 472                   mpls_lse_to_bos(mpls_lse));
 473 }
 474
 475 static void
 476 format_mpls(struct ds *ds, const struct ovs_key_mpls *mpls_key,
 477             const struct ovs_key_mpls *mpls_mask, int n)
 478 {
 479     if (n == 1) {
 480         ovs_be32 key = mpls_key->mpls_lse;
 481
 482         if (mpls_mask == NULL) {
 483             format_mpls_lse(ds, key);
 484         } else {
 485             ovs_be32 mask = mpls_mask->mpls_lse;
 486
 487             ds_put_format(ds, "label=%"PRIu32"/0x%x,tc=%d/%x,ttl=%d/0x%x,bos=%d/%x",
 488                           mpls_lse_to_label(key), mpls_lse_to_label(mask),
 489                           mpls_lse_to_tc(key), mpls_lse_to_tc(mask),
 490                           mpls_lse_to_ttl(key), mpls_lse_to_ttl(mask),
 491                           mpls_lse_to_bos(key), mpls_lse_to_bos(mask));
 492         }
 493     } else {
 494         int i;
 495
 496         for (i = 0; i < n; i++) {
 497             ds_put_format(ds, "lse%d=%#"PRIx32,
 498                           i, ntohl(mpls_key[i].mpls_lse));
 499             if (mpls_mask) {
 500                 ds_put_format(ds, "/%#"PRIx32, ntohl(mpls_mask[i].mpls_lse));
 501             }
 502             ds_put_char(ds, ',');
 503         }
 504         ds_chomp(ds, ',');
 505     }
 506 }
 507
 508 static void
 509 format_odp_recirc_action(struct ds *ds, uint32_t recirc_id)
 510 {
 511     ds_put_format(ds, "recirc(%#"PRIx32")", recirc_id);
 512 }
 513
 514 static void
 515 format_odp_hash_action(struct ds *ds, const struct ovs_action_hash *hash_act)
 516 {
 517     ds_put_format(ds, "hash(");
 518
 519     if (hash_act->hash_alg == OVS_HASH_ALG_L4) {
 520         ds_put_format(ds, "hash_l4(%"PRIu32")", hash_act->hash_basis);
 521     } else {
 522         ds_put_format(ds, "Unknown hash algorithm(%"PRIu32")",
 523                       hash_act->hash_alg);
 524     }
 525     ds_put_format(ds, ")");
 526 }
 527
 528 static const void *
 529 format_udp_tnl_push_header(struct ds *ds, const struct ip_header *ip)
 530 {
 531     const struct udp_header *udp;
 532
 533     udp = (const struct udp_header *) (ip + 1);
 534     ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16",csum=0x%"PRIx16"),",
 535                   ntohs(udp->udp_src), ntohs(udp->udp_dst),
 536                   ntohs(udp->udp_csum));
 537
 538     return udp + 1;
 539 }
 540
 541 static void
 542 format_odp_tnl_push_header(struct ds *ds, struct ovs_action_push_tnl *data)
 543 {
 544     const struct eth_header *eth;
 545     const struct ip_header *ip;
 546     const void *l3;
 547
 548     eth = (const struct eth_header *)data->header;
 549
 550     l3 = eth + 1;
 551     ip = (const struct ip_header *)l3;
 552
 553     /* Ethernet */
 554     ds_put_format(ds, "header(size=%"PRIu8",type=%"PRIu8",eth(dst=",
 555                   data->header_len, data->tnl_type);
 556     ds_put_format(ds, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth->eth_dst));
 557     ds_put_format(ds, ",src=");
 558     ds_put_format(ds, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth->eth_src));
 559     ds_put_format(ds, ",dl_type=0x%04"PRIx16"),", ntohs(eth->eth_type));
 560
 561     /* IPv4 */
 562     ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
 563                   ",tos=%#"PRIx8",ttl=%"PRIu8",frag=0x%"PRIx16"),",
 564                   IP_ARGS(get_16aligned_be32(&ip->ip_src)),
 565                   IP_ARGS(get_16aligned_be32(&ip->ip_dst)),
 566                   ip->ip_proto, ip->ip_tos,
 567                   ip->ip_ttl,
 568                   ip->ip_frag_off);
 569
 570     if (data->tnl_type == OVS_VPORT_TYPE_VXLAN) {
 571         const struct vxlanhdr *vxh;
 572
 573         vxh = format_udp_tnl_push_header(ds, ip);
 574
 575         ds_put_format(ds, "vxlan(flags=0x%"PRIx32",vni=0x%"PRIx32")",
 576                       ntohl(get_16aligned_be32(&vxh->vx_flags)),
 577                       ntohl(get_16aligned_be32(&vxh->vx_vni)) >> 8);
 578     } else if (data->tnl_type == OVS_VPORT_TYPE_GENEVE) {
 579         const struct genevehdr *gnh;
 580
 581         gnh = format_udp_tnl_push_header(ds, ip);
 582
 583         ds_put_format(ds, "geneve(%svni=0x%"PRIx32")",
 584                       gnh->oam ? "oam," : "",
 585                       ntohl(get_16aligned_be32(&gnh->vni)) >> 8);
 586     } else if (data->tnl_type == OVS_VPORT_TYPE_GRE) {
 587         const struct gre_base_hdr *greh;
 588         ovs_16aligned_be32 *options;
 589         void *l4;
 590
 591         l4 = ((uint8_t *)l3  + sizeof(struct ip_header));
 592         greh = (const struct gre_base_hdr *) l4;
 593
 594         ds_put_format(ds, "gre((flags=0x%"PRIx16",proto=0x%"PRIx16")",
 595                            ntohs(greh->flags), ntohs(greh->protocol));
 596         options = (ovs_16aligned_be32 *)(greh + 1);
 597         if (greh->flags & htons(GRE_CSUM)) {
 598             ds_put_format(ds, ",csum=0x%"PRIx16, ntohs(*((ovs_be16 *)options)));
 599             options++;
 600         }
 601         if (greh->flags & htons(GRE_KEY)) {
 602             ds_put_format(ds, ",key=0x%"PRIx32, ntohl(get_16aligned_be32(options)));
 603             options++;
 604         }
 605         if (greh->flags & htons(GRE_SEQ)) {
 606             ds_put_format(ds, ",seq=0x%"PRIx32, ntohl(get_16aligned_be32(options)));
 607             options++;
 608         }
 609         ds_put_format(ds, ")");
 610     }
 611     ds_put_format(ds, ")");
 612 }
 613
 614 static void
 615 format_odp_tnl_push_action(struct ds *ds, const struct nlattr *attr)
 616 {
 617     struct ovs_action_push_tnl *data;
 618
 619     data = (struct ovs_action_push_tnl *) nl_attr_get(attr);
 620
 621     ds_put_format(ds, "tnl_push(tnl_port(%"PRIu32"),", data->tnl_port);
 622     format_odp_tnl_push_header(ds, data);
 623     ds_put_format(ds, ",out_port(%"PRIu32"))", data->out_port);
 624 }
 625
 626 static void
 627 format_odp_action(struct ds *ds, const struct nlattr *a)
 628 {
 629     int expected_len;
 630     enum ovs_action_attr type = nl_attr_type(a);
 631     const struct ovs_action_push_vlan *vlan;
 632     size_t size;
 633
 634     expected_len = odp_action_len(nl_attr_type(a));
 635     if (expected_len != ATTR_LEN_VARIABLE &&
 636         nl_attr_get_size(a) != expected_len) {
 637         ds_put_format(ds, "bad length %"PRIuSIZE", expected %d for: ",
 638                       nl_attr_get_size(a), expected_len);
 639         format_generic_odp_action(ds, a);
 640         return;
 641     }
 642
 643     switch (type) {
 644     case OVS_ACTION_ATTR_OUTPUT:
 645         ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
 646         break;
 647     case OVS_ACTION_ATTR_TUNNEL_POP:
 648         ds_put_format(ds, "tnl_pop(%"PRIu32")", nl_attr_get_u32(a));
 649         break;
 650     case OVS_ACTION_ATTR_TUNNEL_PUSH:
 651         format_odp_tnl_push_action(ds, a);
 652         break;
 653     case OVS_ACTION_ATTR_USERSPACE:
 654         format_odp_userspace_action(ds, a);
 655         break;
 656     case OVS_ACTION_ATTR_RECIRC:
 657         format_odp_recirc_action(ds, nl_attr_get_u32(a));
 658         break;
 659     case OVS_ACTION_ATTR_HASH:
 660         format_odp_hash_action(ds, nl_attr_get(a));
 661         break;
 662     case OVS_ACTION_ATTR_SET_MASKED:
 663         a = nl_attr_get(a);
 664         size = nl_attr_get_size(a) / 2;
 665         ds_put_cstr(ds, "set(");
 666
 667         /* Masked set action not supported for tunnel key, which is bigger. */
 668         if (size <= sizeof(struct ovs_key_ipv6)) {
 669             struct nlattr attr[1 + DIV_ROUND_UP(sizeof(struct ovs_key_ipv6),
 670                                                 sizeof(struct nlattr))];
 671             struct nlattr mask[1 + DIV_ROUND_UP(sizeof(struct ovs_key_ipv6),
 672                                                 sizeof(struct nlattr))];
 673
 674             mask->nla_type = attr->nla_type = nl_attr_type(a);
 675             mask->nla_len = attr->nla_len = NLA_HDRLEN + size;
 676             memcpy(attr + 1, (char *)(a + 1), size);
 677             memcpy(mask + 1, (char *)(a + 1) + size, size);
 678             format_odp_key_attr(attr, mask, NULL, ds, false);
 679         } else {
 680             format_odp_key_attr(a, NULL, NULL, ds, false);
 681         }
 682         ds_put_cstr(ds, ")");
 683         break;
 684     case OVS_ACTION_ATTR_SET:
 685         ds_put_cstr(ds, "set(");
 686         format_odp_key_attr(nl_attr_get(a), NULL, NULL, ds, true);
 687         ds_put_cstr(ds, ")");
 688         break;
 689     case OVS_ACTION_ATTR_PUSH_VLAN:
 690         vlan = nl_attr_get(a);
 691         ds_put_cstr(ds, "push_vlan(");
 692         if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
 693             ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
 694         }
 695         format_vlan_tci(ds, vlan->vlan_tci, OVS_BE16_MAX, false);
 696         ds_put_char(ds, ')');
 697         break;
 698     case OVS_ACTION_ATTR_POP_VLAN:
 699         ds_put_cstr(ds, "pop_vlan");
 700         break;
 701     case OVS_ACTION_ATTR_PUSH_MPLS: {
 702         const struct ovs_action_push_mpls *mpls = nl_attr_get(a);
 703         ds_put_cstr(ds, "push_mpls(");
 704         format_mpls_lse(ds, mpls->mpls_lse);
 705         ds_put_format(ds, ",eth_type=0x%"PRIx16")", ntohs(mpls->mpls_ethertype));
 706         break;
 707     }
 708     case OVS_ACTION_ATTR_POP_MPLS: {
 709         ovs_be16 ethertype = nl_attr_get_be16(a);
 710         ds_put_format(ds, "pop_mpls(eth_type=0x%"PRIx16")", ntohs(ethertype));
 711         break;
 712     }
 713     case OVS_ACTION_ATTR_SAMPLE:
 714         format_odp_sample_action(ds, a);
 715         break;
 716     case OVS_ACTION_ATTR_UNSPEC:
 717     case __OVS_ACTION_ATTR_MAX:
 718     default:
 719         format_generic_odp_action(ds, a);
 720         break;
 721     }
 722 }
 723
 724 void
 725 format_odp_actions(struct ds *ds, const struct nlattr *actions,
 726                    size_t actions_len)
 727 {
 728     if (actions_len) {
 729         const struct nlattr *a;
 730         unsigned int left;
 731
 732         NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
 733             if (a != actions) {
 734                 ds_put_char(ds, ',');
 735             }
 736             format_odp_action(ds, a);
 737         }
 738         if (left) {
 739             int i;
 740
 741             if (left == actions_len) {
 742                 ds_put_cstr(ds, "<empty>");
 743             }
 744             ds_put_format(ds, ",***%u leftover bytes*** (", left);
 745             for (i = 0; i < left; i++) {
 746                 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
 747             }
 748             ds_put_char(ds, ')');
 749         }
 750     } else {
 751         ds_put_cstr(ds, "drop");
 752     }
 753 }
 754
 755 /* Separate out parse_odp_userspace_action() function. */
 756 static int
 757 parse_odp_userspace_action(const char *s, struct ofpbuf *actions)
 758 {
 759     uint32_t pid;
 760     union user_action_cookie cookie;
 761     struct ofpbuf buf;
 762     odp_port_t tunnel_out_port;
 763     int n = -1;
 764     void *user_data = NULL;
 765     size_t user_data_size = 0;
 766
 767     if (!ovs_scan(s, "userspace(pid=%"SCNi32"%n", &pid, &n)) {
 768         return -EINVAL;
 769     }
 770
 771     {
 772         uint32_t output;
 773         uint32_t probability;
 774         uint32_t collector_set_id;
 775         uint32_t obs_domain_id;
 776         uint32_t obs_point_id;
 777         int vid, pcp;
 778         int n1 = -1;
 779         if (ovs_scan(&s[n], ",sFlow(vid=%i,"
 780                      "pcp=%i,output=%"SCNi32")%n",
 781                      &vid, &pcp, &output, &n1)) {
 782             uint16_t tci;
 783
 784             n += n1;
 785             tci = vid | (pcp << VLAN_PCP_SHIFT);
 786             if (tci) {
 787                 tci |= VLAN_CFI;
 788             }
 789
 790             cookie.type = USER_ACTION_COOKIE_SFLOW;
 791             cookie.sflow.vlan_tci = htons(tci);
 792             cookie.sflow.output = output;
 793             user_data = &cookie;
 794             user_data_size = sizeof cookie.sflow;
 795         } else if (ovs_scan(&s[n], ",slow_path(%n",
 796                             &n1)) {
 797             int res;
 798
 799             n += n1;
 800             cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
 801             cookie.slow_path.unused = 0;
 802             cookie.slow_path.reason = 0;
 803
 804             res = parse_flags(&s[n], slow_path_reason_to_string,
 805                               &cookie.slow_path.reason,
 806                               SLOW_PATH_REASON_MASK, NULL);
 807             if (res < 0 || s[n + res] != ')') {
 808                 return res;
 809             }
 810             n += res + 1;
 811
 812             user_data = &cookie;
 813             user_data_size = sizeof cookie.slow_path;
 814         } else if (ovs_scan(&s[n], ",flow_sample(probability=%"SCNi32","
 815                             "collector_set_id=%"SCNi32","
 816                             "obs_domain_id=%"SCNi32","
 817                             "obs_point_id=%"SCNi32")%n",
 818                             &probability, &collector_set_id,
 819                             &obs_domain_id, &obs_point_id, &n1)) {
 820             n += n1;
 821
 822             cookie.type = USER_ACTION_COOKIE_FLOW_SAMPLE;
 823             cookie.flow_sample.probability = probability;
 824             cookie.flow_sample.collector_set_id = collector_set_id;
 825             cookie.flow_sample.obs_domain_id = obs_domain_id;
 826             cookie.flow_sample.obs_point_id = obs_point_id;
 827             user_data = &cookie;
 828             user_data_size = sizeof cookie.flow_sample;
 829         } else if (ovs_scan(&s[n], ",ipfix(output_port=%"SCNi32")%n",
 830                             &output, &n1) ) {
 831             n += n1;
 832             cookie.type = USER_ACTION_COOKIE_IPFIX;
 833             cookie.ipfix.output_odp_port = u32_to_odp(output);
 834             user_data = &cookie;
 835             user_data_size = sizeof cookie.ipfix;
 836         } else if (ovs_scan(&s[n], ",userdata(%n",
 837                             &n1)) {
 838             char *end;
 839
 840             n += n1;
 841             ofpbuf_init(&buf, 16);
 842             end = ofpbuf_put_hex(&buf, &s[n], NULL);
 843             if (end[0] != ')') {
 844                 return -EINVAL;
 845             }
 846             user_data = buf.data;
 847             user_data_size = buf.size;
 848             n = (end + 1) - s;
 849         }
 850     }
 851
 852     {
 853         int n1 = -1;
 854         if (ovs_scan(&s[n], ",tunnel_out_port=%"SCNi32")%n",
 855                      &tunnel_out_port, &n1)) {
 856             odp_put_userspace_action(pid, user_data, user_data_size, tunnel_out_port, actions);
 857             return n + n1;
 858         } else if (s[n] == ')') {
 859             odp_put_userspace_action(pid, user_data, user_data_size, ODPP_NONE, actions);
 860             return n + 1;
 861         }
 862     }
 863
 864     return -EINVAL;
 865 }
 866
 867 static int
 868 ovs_parse_tnl_push(const char *s, struct ovs_action_push_tnl *data)
 869 {
 870     struct eth_header *eth;
 871     struct ip_header *ip;
 872     struct udp_header *udp;
 873     struct gre_base_hdr *greh;
 874     uint16_t gre_proto, gre_flags, dl_type, udp_src, udp_dst, csum;
 875     ovs_be32 sip, dip;
 876     uint32_t tnl_type = 0, header_len = 0;
 877     void *l3, *l4;
 878     int n = 0;
 879
 880     if (!ovs_scan_len(s, &n, "tnl_push(tnl_port(%"SCNi32"),", &data->tnl_port)) {
 881         return -EINVAL;
 882     }
 883     eth = (struct eth_header *) data->header;
 884     l3 = (data->header + sizeof *eth);
 885     l4 = ((uint8_t *) l3 + sizeof (struct ip_header));
 886     ip = (struct ip_header *) l3;
 887     if (!ovs_scan_len(s, &n, "header(size=%"SCNi32",type=%"SCNi32","
 888                          "eth(dst="ETH_ADDR_SCAN_FMT",",
 889                          &data->header_len,
 890                          &data->tnl_type,
 891                          ETH_ADDR_SCAN_ARGS(eth->eth_dst))) {
 892         return -EINVAL;
 893     }
 894
 895     if (!ovs_scan_len(s, &n, "src="ETH_ADDR_SCAN_FMT",",
 896                   ETH_ADDR_SCAN_ARGS(eth->eth_src))) {
 897         return -EINVAL;
 898     }
 899     if (!ovs_scan_len(s, &n, "dl_type=0x%"SCNx16"),", &dl_type)) {
 900         return -EINVAL;
 901     }
 902     eth->eth_type = htons(dl_type);
 903
 904     /* IPv4 */
 905     if (!ovs_scan_len(s, &n, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT",proto=%"SCNi8
 906                          ",tos=%"SCNi8",ttl=%"SCNi8",frag=0x%"SCNx16"),",
 907                          IP_SCAN_ARGS(&sip),
 908                          IP_SCAN_ARGS(&dip),
 909                          &ip->ip_proto, &ip->ip_tos,
 910                          &ip->ip_ttl, &ip->ip_frag_off)) {
 911         return -EINVAL;
 912     }
 913     put_16aligned_be32(&ip->ip_src, sip);
 914     put_16aligned_be32(&ip->ip_dst, dip);
 915
 916     /* Tunnel header */
 917     udp = (struct udp_header *) l4;
 918     greh = (struct gre_base_hdr *) l4;
 919     if (ovs_scan_len(s, &n, "udp(src=%"SCNi16",dst=%"SCNi16",csum=0x%"SCNx16"),",
 920                          &udp_src, &udp_dst, &csum)) {
 921         uint32_t vx_flags, vni;
 922
 923         udp->udp_src = htons(udp_src);
 924         udp->udp_dst = htons(udp_dst);
 925         udp->udp_len = 0;
 926         udp->udp_csum = htons(csum);
 927
 928         if (ovs_scan_len(s, &n, "vxlan(flags=0x%"SCNx32",vni=0x%"SCNx32"))",
 929                             &vx_flags, &vni)) {
 930             struct vxlanhdr *vxh = (struct vxlanhdr *) (udp + 1);
 931
 932             put_16aligned_be32(&vxh->vx_flags, htonl(vx_flags));
 933             put_16aligned_be32(&vxh->vx_vni, htonl(vni << 8));
 934             tnl_type = OVS_VPORT_TYPE_VXLAN;
 935             header_len = sizeof *eth + sizeof *ip +
 936                          sizeof *udp + sizeof *vxh;
 937         } else if (ovs_scan_len(s, &n, "geneve(")) {
 938             struct genevehdr *gnh = (struct genevehdr *) (udp + 1);
 939
 940             memset(gnh, 0, sizeof *gnh);
 941             if (ovs_scan_len(s, &n, "oam,")) {
 942                 gnh->oam = 1;
 943             }
 944             if (!ovs_scan_len(s, &n, "vni=0x%"SCNx32"))", &vni)) {
 945                 return -EINVAL;
 946             }
 947             gnh->proto_type = htons(ETH_TYPE_TEB);
 948             put_16aligned_be32(&gnh->vni, htonl(vni << 8));
 949             tnl_type = OVS_VPORT_TYPE_GENEVE;
 950             header_len = sizeof *eth + sizeof *ip +
 951                          sizeof *udp + sizeof *gnh;
 952         } else {
 953             return -EINVAL;
 954         }
 955     } else if (ovs_scan_len(s, &n, "gre((flags=0x%"SCNx16",proto=0x%"SCNx16")",
 956                          &gre_flags, &gre_proto)){
 957
 958         tnl_type = OVS_VPORT_TYPE_GRE;
 959         greh->flags = htons(gre_flags);
 960         greh->protocol = htons(gre_proto);
 961         ovs_16aligned_be32 *options = (ovs_16aligned_be32 *) (greh + 1);
 962
 963         if (greh->flags & htons(GRE_CSUM)) {
 964             if (!ovs_scan_len(s, &n, ",csum=0x%"SCNx16, &csum)) {
 965                 return -EINVAL;
 966             }
 967
 968             memset(options, 0, sizeof *options);
 969             *((ovs_be16 *)options) = htons(csum);
 970             options++;
 971         }
 972         if (greh->flags & htons(GRE_KEY)) {
 973             uint32_t key;
 974
 975             if (!ovs_scan_len(s, &n, ",key=0x%"SCNx32, &key)) {
 976                 return -EINVAL;
 977             }
 978
 979             put_16aligned_be32(options, htonl(key));
 980             options++;
 981         }
 982         if (greh->flags & htons(GRE_SEQ)) {
 983             uint32_t seq;
 984
 985             if (!ovs_scan_len(s, &n, ",seq=0x%"SCNx32, &seq)) {
 986                 return -EINVAL;
 987             }
 988             put_16aligned_be32(options, htonl(seq));
 989             options++;
 990         }
 991
 992         if (!ovs_scan_len(s, &n, "))")) {
 993             return -EINVAL;
 994         }
 995
 996         header_len = sizeof *eth + sizeof *ip +
 997                      ((uint8_t *) options - (uint8_t *) greh);
 998     } else {
 999         return -EINVAL;
1000     }
1001
1002     /* check tunnel meta data. */
1003     if (data->tnl_type != tnl_type) {
1004         return -EINVAL;
1005     }
1006     if (data->header_len != header_len) {
1007         return -EINVAL;
1008     }
1009
1010     /* Out port */
1011     if (!ovs_scan_len(s, &n, ",out_port(%"SCNi32"))", &data->out_port)) {
1012         return -EINVAL;
1013     }
1014
1015     return n;
1016 }
1017
1018 static int
1019 parse_odp_action(const char *s, const struct simap *port_names,
1020                  struct ofpbuf *actions)
1021 {
1022     {
1023         uint32_t port;
1024         int n;
1025
1026         if (ovs_scan(s, "%"SCNi32"%n", &port, &n)) {
1027             nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
1028             return n;
1029         }
1030     }
1031
1032     if (port_names) {
1033         int len = strcspn(s, delimiters);
1034         struct simap_node *node;
1035
1036         node = simap_find_len(port_names, s, len);
1037         if (node) {
1038             nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, node->data);
1039             return len;
1040         }
1041     }
1042
1043     {
1044         uint32_t recirc_id;
1045         int n = -1;
1046
1047         if (ovs_scan(s, "recirc(%"PRIu32")%n", &recirc_id, &n)) {
1048             nl_msg_put_u32(actions, OVS_ACTION_ATTR_RECIRC, recirc_id);
1049             return n;
1050         }
1051     }
1052
1053     if (!strncmp(s, "userspace(", 10)) {
1054         return parse_odp_userspace_action(s, actions);
1055     }
1056
1057     if (!strncmp(s, "set(", 4)) {
1058         size_t start_ofs;
1059         int retval;
1060         struct nlattr mask[128 / sizeof(struct nlattr)];
1061         struct ofpbuf maskbuf;
1062         struct nlattr *nested, *key;
1063         size_t size;
1064
1065         /* 'mask' is big enough to hold any key. */
1066         ofpbuf_use_stack(&maskbuf, mask, sizeof mask);
1067
1068         start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
1069         retval = parse_odp_key_mask_attr(s + 4, port_names, actions, &maskbuf);
1070         if (retval < 0) {
1071             return retval;
1072         }
1073         if (s[retval + 4] != ')') {
1074             return -EINVAL;
1075         }
1076
1077         nested = ofpbuf_at_assert(actions, start_ofs, sizeof *nested);
1078         key = nested + 1;
1079
1080         size = nl_attr_get_size(mask);
1081         if (size == nl_attr_get_size(key)) {
1082             /* Change to masked set action if not fully masked. */
1083             if (!is_all_ones(mask + 1, size)) {
1084                 key->nla_len += size;
1085                 ofpbuf_put(actions, mask + 1, size);
1086                 /* 'actions' may have been reallocated by ofpbuf_put(). */
1087                 nested = ofpbuf_at_assert(actions, start_ofs, sizeof *nested);
1088                 nested->nla_type = OVS_ACTION_ATTR_SET_MASKED;
1089             }
1090         }
1091
1092         nl_msg_end_nested(actions, start_ofs);
1093         return retval + 5;
1094     }
1095
1096     {
1097         struct ovs_action_push_vlan push;
1098         int tpid = ETH_TYPE_VLAN;
1099         int vid, pcp;
1100         int cfi = 1;
1101         int n = -1;
1102
1103         if (ovs_scan(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n)
1104             || ovs_scan(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
1105                         &vid, &pcp, &cfi, &n)
1106             || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
1107                         &tpid, &vid, &pcp, &n)
1108             || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
1109                         &tpid, &vid, &pcp, &cfi, &n)) {
1110             push.vlan_tpid = htons(tpid);
1111             push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
1112                                   | (pcp << VLAN_PCP_SHIFT)
1113                                   | (cfi ? VLAN_CFI : 0));
1114             nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
1115                               &push, sizeof push);
1116
1117             return n;
1118         }
1119     }
1120
1121     if (!strncmp(s, "pop_vlan", 8)) {
1122         nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
1123         return 8;
1124     }
1125
1126     {
1127         double percentage;
1128         int n = -1;
1129
1130         if (ovs_scan(s, "sample(sample=%lf%%,actions(%n", &percentage, &n)
1131             && percentage >= 0. && percentage <= 100.0) {
1132             size_t sample_ofs, actions_ofs;
1133             double probability;
1134
1135             probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
1136             sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
1137             nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
1138                            (probability <= 0 ? 0
1139                             : probability >= UINT32_MAX ? UINT32_MAX
1140                             : probability));
1141
1142             actions_ofs = nl_msg_start_nested(actions,
1143                                               OVS_SAMPLE_ATTR_ACTIONS);
1144             for (;;) {
1145                 int retval;
1146
1147                 n += strspn(s + n, delimiters);
1148                 if (s[n] == ')') {
1149                     break;
1150                 }
1151
1152                 retval = parse_odp_action(s + n, port_names, actions);
1153                 if (retval < 0) {
1154                     return retval;
1155                 }
1156                 n += retval;
1157             }
1158             nl_msg_end_nested(actions, actions_ofs);
1159             nl_msg_end_nested(actions, sample_ofs);
1160
1161             return s[n + 1] == ')' ? n + 2 : -EINVAL;
1162         }
1163     }
1164
1165     {
1166         uint32_t port;
1167         int n;
1168
1169         if (ovs_scan(s, "tnl_pop(%"SCNi32")%n", &port, &n)) {
1170             nl_msg_put_u32(actions, OVS_ACTION_ATTR_TUNNEL_POP, port);
1171             return n;
1172         }
1173     }
1174
1175     {
1176         struct ovs_action_push_tnl data;
1177         int n;
1178
1179         n = ovs_parse_tnl_push(s, &data);
1180         if (n > 0) {
1181             odp_put_tnl_push_action(actions, &data);
1182             return n;
1183         } else if (n < 0) {
1184             return n;
1185         }
1186     }
1187     return -EINVAL;
1188 }
1189
1190 /* Parses the string representation of datapath actions, in the format output
1191  * by format_odp_action().  Returns 0 if successful, otherwise a positive errno
1192  * value.  On success, the ODP actions are appended to 'actions' as a series of
1193  * Netlink attributes.  On failure, no data is appended to 'actions'.  Either
1194  * way, 'actions''s data might be reallocated. */
1195 int
1196 odp_actions_from_string(const char *s, const struct simap *port_names,
1197                         struct ofpbuf *actions)
1198 {
1199     size_t old_size;
1200
1201     if (!strcasecmp(s, "drop")) {
1202         return 0;
1203     }
1204
1205     old_size = actions->size;
1206     for (;;) {
1207         int retval;
1208
1209         s += strspn(s, delimiters);
1210         if (!*s) {
1211             return 0;
1212         }
1213
1214         retval = parse_odp_action(s, port_names, actions);
1215         if (retval < 0 || !strchr(delimiters, s[retval])) {
1216             actions->size = old_size;
1217             return -retval;
1218         }
1219         s += retval;
1220     }
1221
1222     return 0;
1223 }
1224 \f
1225 static const struct attr_len_tbl ovs_vxlan_ext_attr_lens[OVS_VXLAN_EXT_MAX + 1] = {
1226     [OVS_VXLAN_EXT_GBP]                 = { .len = 4 },
1227 };
1228
1229 static const struct attr_len_tbl ovs_tun_key_attr_lens[OVS_TUNNEL_KEY_ATTR_MAX + 1] = {
1230     [OVS_TUNNEL_KEY_ATTR_ID]            = { .len = 8 },
1231     [OVS_TUNNEL_KEY_ATTR_IPV4_SRC]      = { .len = 4 },
1232     [OVS_TUNNEL_KEY_ATTR_IPV4_DST]      = { .len = 4 },
1233     [OVS_TUNNEL_KEY_ATTR_TOS]           = { .len = 1 },
1234     [OVS_TUNNEL_KEY_ATTR_TTL]           = { .len = 1 },
1235     [OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT] = { .len = 0 },
1236     [OVS_TUNNEL_KEY_ATTR_CSUM]          = { .len = 0 },
1237     [OVS_TUNNEL_KEY_ATTR_TP_SRC]        = { .len = 2 },
1238     [OVS_TUNNEL_KEY_ATTR_TP_DST]        = { .len = 2 },
1239     [OVS_TUNNEL_KEY_ATTR_OAM]           = { .len = 0 },
1240     [OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS]   = { .len = ATTR_LEN_VARIABLE },
1241     [OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS]    = { .len = ATTR_LEN_NESTED,
1242                                             .next = ovs_vxlan_ext_attr_lens ,
1243                                             .next_max = OVS_VXLAN_EXT_MAX},
1244 };
1245
1246 static const struct attr_len_tbl ovs_flow_key_attr_lens[OVS_KEY_ATTR_MAX + 1] = {
1247     [OVS_KEY_ATTR_ENCAP]     = { .len = ATTR_LEN_NESTED },
1248     [OVS_KEY_ATTR_PRIORITY]  = { .len = 4 },
1249     [OVS_KEY_ATTR_SKB_MARK]  = { .len = 4 },
1250     [OVS_KEY_ATTR_DP_HASH]   = { .len = 4 },
1251     [OVS_KEY_ATTR_RECIRC_ID] = { .len = 4 },
1252     [OVS_KEY_ATTR_TUNNEL]    = { .len = ATTR_LEN_NESTED,
1253                                  .next = ovs_tun_key_attr_lens,
1254                                  .next_max = OVS_TUNNEL_KEY_ATTR_MAX },
1255     [OVS_KEY_ATTR_IN_PORT]   = { .len = 4  },
1256     [OVS_KEY_ATTR_ETHERNET]  = { .len = sizeof(struct ovs_key_ethernet) },
1257     [OVS_KEY_ATTR_VLAN]      = { .len = 2 },
1258     [OVS_KEY_ATTR_ETHERTYPE] = { .len = 2 },
1259     [OVS_KEY_ATTR_MPLS]      = { .len = ATTR_LEN_VARIABLE },
1260     [OVS_KEY_ATTR_IPV4]      = { .len = sizeof(struct ovs_key_ipv4) },
1261     [OVS_KEY_ATTR_IPV6]      = { .len = sizeof(struct ovs_key_ipv6) },
1262     [OVS_KEY_ATTR_TCP]       = { .len = sizeof(struct ovs_key_tcp) },
1263     [OVS_KEY_ATTR_TCP_FLAGS] = { .len = 2 },
1264     [OVS_KEY_ATTR_UDP]       = { .len = sizeof(struct ovs_key_udp) },
1265     [OVS_KEY_ATTR_SCTP]      = { .len = sizeof(struct ovs_key_sctp) },
1266     [OVS_KEY_ATTR_ICMP]      = { .len = sizeof(struct ovs_key_icmp) },
1267     [OVS_KEY_ATTR_ICMPV6]    = { .len = sizeof(struct ovs_key_icmpv6) },
1268     [OVS_KEY_ATTR_ARP]       = { .len = sizeof(struct ovs_key_arp) },
1269     [OVS_KEY_ATTR_ND]        = { .len = sizeof(struct ovs_key_nd) },
1270 };
1271
1272 /* Returns the correct length of the payload for a flow key attribute of the
1273  * specified 'type', ATTR_LEN_INVALID if 'type' is unknown, ATTR_LEN_VARIABLE
1274  * if the attribute's payload is variable length, or ATTR_LEN_NESTED if the
1275  * payload is a nested type. */
1276 static int
1277 odp_key_attr_len(const struct attr_len_tbl tbl[], int max_len, uint16_t type)
1278 {
1279     if (type > max_len) {
1280         return ATTR_LEN_INVALID;
1281     }
1282
1283     return tbl[type].len;
1284 }
1285
1286 static void
1287 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
1288 {
1289     size_t len = nl_attr_get_size(a);
1290     if (len) {
1291         const uint8_t *unspec;
1292         unsigned int i;
1293
1294         unspec = nl_attr_get(a);
1295         for (i = 0; i < len; i++) {
1296             if (i) {
1297                 ds_put_char(ds, ' ');
1298             }
1299             ds_put_format(ds, "%02x", unspec[i]);
1300         }
1301     }
1302 }
1303
1304 static const char *
1305 ovs_frag_type_to_string(enum ovs_frag_type type)
1306 {
1307     switch (type) {
1308     case OVS_FRAG_TYPE_NONE:
1309         return "no";
1310     case OVS_FRAG_TYPE_FIRST:
1311         return "first";
1312     case OVS_FRAG_TYPE_LATER:
1313         return "later";
1314     case __OVS_FRAG_TYPE_MAX:
1315     default:
1316         return "<error>";
1317     }
1318 }
1319
1320 #define GENEVE_OPT(class, type) ((OVS_FORCE uint32_t)(class) << 8 | (type))
1321 static int
1322 parse_geneve_opts(const struct nlattr *attr)
1323 {
1324     int opts_len = nl_attr_get_size(attr);
1325     const struct geneve_opt *opt = nl_attr_get(attr);
1326
1327     while (opts_len > 0) {
1328         int len;
1329
1330         if (opts_len < sizeof(*opt)) {
1331             return -EINVAL;
1332         }
1333
1334         len = sizeof(*opt) + opt->length * 4;
1335         if (len > opts_len) {
1336             return -EINVAL;
1337         }
1338
1339         switch (GENEVE_OPT(opt->opt_class, opt->type)) {
1340         default:
1341             if (opt->type & GENEVE_CRIT_OPT_TYPE) {
1342                 return -EINVAL;
1343             }
1344         };
1345
1346         opt = opt + len / sizeof(*opt);
1347         opts_len -= len;
1348     };
1349
1350     return 0;
1351 }
1352
1353 static enum odp_key_fitness
1354 odp_tun_key_from_attr__(const struct nlattr *attr,
1355                         const struct nlattr *flow_attrs OVS_UNUSED,
1356                         size_t flow_attr_len OVS_UNUSED,
1357                         const struct flow_tnl *src_tun OVS_UNUSED,
1358                         struct flow_tnl *tun)
1359 {
1360     unsigned int left;
1361     const struct nlattr *a;
1362     bool ttl = false;
1363     bool unknown = false;
1364
1365     NL_NESTED_FOR_EACH(a, left, attr) {
1366         uint16_t type = nl_attr_type(a);
1367         size_t len = nl_attr_get_size(a);
1368         int expected_len = odp_key_attr_len(ovs_tun_key_attr_lens,
1369                                             OVS_TUNNEL_ATTR_MAX, type);
1370
1371         if (len != expected_len && expected_len >= 0) {
1372             return ODP_FIT_ERROR;
1373         }
1374
1375         switch (type) {
1376         case OVS_TUNNEL_KEY_ATTR_ID:
1377             tun->tun_id = nl_attr_get_be64(a);
1378             tun->flags |= FLOW_TNL_F_KEY;
1379             break;
1380         case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
1381             tun->ip_src = nl_attr_get_be32(a);
1382             break;
1383         case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
1384             tun->ip_dst = nl_attr_get_be32(a);
1385             break;
1386         case OVS_TUNNEL_KEY_ATTR_TOS:
1387             tun->ip_tos = nl_attr_get_u8(a);
1388             break;
1389         case OVS_TUNNEL_KEY_ATTR_TTL:
1390             tun->ip_ttl = nl_attr_get_u8(a);
1391             ttl = true;
1392             break;
1393         case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
1394             tun->flags |= FLOW_TNL_F_DONT_FRAGMENT;
1395             break;
1396         case OVS_TUNNEL_KEY_ATTR_CSUM:
1397             tun->flags |= FLOW_TNL_F_CSUM;
1398             break;
1399         case OVS_TUNNEL_KEY_ATTR_TP_SRC:
1400             tun->tp_src = nl_attr_get_be16(a);
1401             break;
1402         case OVS_TUNNEL_KEY_ATTR_TP_DST:
1403             tun->tp_dst = nl_attr_get_be16(a);
1404             break;
1405         case OVS_TUNNEL_KEY_ATTR_OAM:
1406             tun->flags |= FLOW_TNL_F_OAM;
1407             break;
1408         case OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS: {
1409             static const struct nl_policy vxlan_opts_policy[] = {
1410                 [OVS_VXLAN_EXT_GBP] = { .type = NL_A_U32 },
1411             };
1412             struct nlattr *ext[ARRAY_SIZE(vxlan_opts_policy)];
1413
1414             if (!nl_parse_nested(a, vxlan_opts_policy, ext, ARRAY_SIZE(ext))) {
1415                 return ODP_FIT_ERROR;
1416             }
1417
1418             if (ext[OVS_VXLAN_EXT_GBP]) {
1419                 uint32_t gbp = nl_attr_get_u32(ext[OVS_VXLAN_EXT_GBP]);
1420
1421                 tun->gbp_id = htons(gbp & 0xFFFF);
1422                 tun->gbp_flags = (gbp >> 16) & 0xFF;
1423             }
1424
1425             break;
1426         }
1427         case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS: {
1428             if (parse_geneve_opts(a)) {
1429                 return ODP_FIT_ERROR;
1430             }
1431             /* It is necessary to reproduce options exactly (including order)
1432              * so it's easiest to just echo them back. */
1433             unknown = true;
1434             break;
1435         }
1436         default:
1437             /* Allow this to show up as unexpected, if there are unknown
1438              * tunnel attribute, eventually resulting in ODP_FIT_TOO_MUCH. */
1439             unknown = true;
1440             break;
1441         }
1442     }
1443
1444     if (!ttl) {
1445         return ODP_FIT_ERROR;
1446     }
1447     if (unknown) {
1448         return ODP_FIT_TOO_MUCH;
1449     }
1450     return ODP_FIT_PERFECT;
1451 }
1452
1453 enum odp_key_fitness
1454 odp_tun_key_from_attr(const struct nlattr *attr, struct flow_tnl *tun)
1455 {
1456     return odp_tun_key_from_attr__(attr, NULL, 0, NULL, tun);
1457 }
1458
1459 static void
1460 tun_key_to_attr(struct ofpbuf *a, const struct flow_tnl *tun_key,
1461                 const struct flow_tnl *tun_flow_key OVS_UNUSED,
1462                 const struct ofpbuf *key_buf OVS_UNUSED)
1463 {
1464     size_t tun_key_ofs;
1465
1466     tun_key_ofs = nl_msg_start_nested(a, OVS_KEY_ATTR_TUNNEL);
1467
1468     /* tun_id != 0 without FLOW_TNL_F_KEY is valid if tun_key is a mask. */
1469     if (tun_key->tun_id || tun_key->flags & FLOW_TNL_F_KEY) {
1470         nl_msg_put_be64(a, OVS_TUNNEL_KEY_ATTR_ID, tun_key->tun_id);
1471     }
1472     if (tun_key->ip_src) {
1473         nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_SRC, tun_key->ip_src);
1474     }
1475     if (tun_key->ip_dst) {
1476         nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_DST, tun_key->ip_dst);
1477     }
1478     if (tun_key->ip_tos) {
1479         nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TOS, tun_key->ip_tos);
1480     }
1481     nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TTL, tun_key->ip_ttl);
1482     if (tun_key->flags & FLOW_TNL_F_DONT_FRAGMENT) {
1483         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
1484     }
1485     if (tun_key->flags & FLOW_TNL_F_CSUM) {
1486         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
1487     }
1488     if (tun_key->tp_src) {
1489         nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_SRC, tun_key->tp_src);
1490     }
1491     if (tun_key->tp_dst) {
1492         nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_DST, tun_key->tp_dst);
1493     }
1494     if (tun_key->flags & FLOW_TNL_F_OAM) {
1495         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
1496     }
1497     if (tun_key->gbp_flags || tun_key->gbp_id) {
1498         size_t vxlan_opts_ofs;
1499
1500         vxlan_opts_ofs = nl_msg_start_nested(a, OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS);
1501         nl_msg_put_u32(a, OVS_VXLAN_EXT_GBP,
1502                        (tun_key->gbp_flags << 16) | ntohs(tun_key->gbp_id));
1503         nl_msg_end_nested(a, vxlan_opts_ofs);
1504     }
1505
1506     nl_msg_end_nested(a, tun_key_ofs);
1507 }
1508
1509 static bool
1510 odp_mask_attr_is_wildcard(const struct nlattr *ma)
1511 {
1512     return is_all_zeros(nl_attr_get(ma), nl_attr_get_size(ma));
1513 }
1514
1515 static bool
1516 odp_mask_is_exact(enum ovs_key_attr attr, const void *mask, size_t size)
1517 {
1518     if (attr == OVS_KEY_ATTR_TCP_FLAGS) {
1519         return TCP_FLAGS(*(ovs_be16 *)mask) == TCP_FLAGS(OVS_BE16_MAX);
1520     }
1521     if (attr == OVS_KEY_ATTR_IPV6) {
1522         const struct ovs_key_ipv6 *ipv6_mask = mask;
1523
1524         return
1525             ((ipv6_mask->ipv6_label & htonl(IPV6_LABEL_MASK))
1526              == htonl(IPV6_LABEL_MASK))
1527             && ipv6_mask->ipv6_proto == UINT8_MAX
1528             && ipv6_mask->ipv6_tclass == UINT8_MAX
1529             && ipv6_mask->ipv6_hlimit == UINT8_MAX
1530             && ipv6_mask->ipv6_frag == UINT8_MAX
1531             && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_src)
1532             && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_dst);
1533     }
1534     if (attr == OVS_KEY_ATTR_TUNNEL) {
1535         return false;
1536     }
1537
1538     if (attr == OVS_KEY_ATTR_ARP) {
1539         /* ARP key has padding, ignore it. */
1540         BUILD_ASSERT_DECL(sizeof(struct ovs_key_arp) == 24);
1541         BUILD_ASSERT_DECL(offsetof(struct ovs_key_arp, arp_tha) == 10 + 6);
1542         size = offsetof(struct ovs_key_arp, arp_tha) + ETH_ADDR_LEN;
1543         ovs_assert(((uint16_t *)mask)[size/2] == 0);
1544     }
1545
1546     return is_all_ones(mask, size);
1547 }
1548
1549 static bool
1550 odp_mask_attr_is_exact(const struct nlattr *ma)
1551 {
1552     enum ovs_key_attr attr = nl_attr_type(ma);
1553     const void *mask;
1554     size_t size;
1555
1556     if (attr == OVS_KEY_ATTR_TUNNEL) {
1557         return false;
1558     } else {
1559         mask = nl_attr_get(ma);
1560         size = nl_attr_get_size(ma);
1561     }
1562
1563     return odp_mask_is_exact(attr, mask, size);
1564 }
1565
1566 void
1567 odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
1568                      char *port_name)
1569 {
1570     struct odp_portno_names *odp_portno_names;
1571
1572     odp_portno_names = xmalloc(sizeof *odp_portno_names);
1573     odp_portno_names->port_no = port_no;
1574     odp_portno_names->name = xstrdup(port_name);
1575     hmap_insert(portno_names, &odp_portno_names->hmap_node,
1576                 hash_odp_port(port_no));
1577 }
1578
1579 static char *
1580 odp_portno_names_get(const struct hmap *portno_names, odp_port_t port_no)
1581 {
1582     struct odp_portno_names *odp_portno_names;
1583
1584     HMAP_FOR_EACH_IN_BUCKET (odp_portno_names, hmap_node,
1585                              hash_odp_port(port_no), portno_names) {
1586         if (odp_portno_names->port_no == port_no) {
1587             return odp_portno_names->name;
1588         }
1589     }
1590     return NULL;
1591 }
1592
1593 void
1594 odp_portno_names_destroy(struct hmap *portno_names)
1595 {
1596     struct odp_portno_names *odp_portno_names, *odp_portno_names_next;
1597     HMAP_FOR_EACH_SAFE (odp_portno_names, odp_portno_names_next,
1598                         hmap_node, portno_names) {
1599         hmap_remove(portno_names, &odp_portno_names->hmap_node);
1600         free(odp_portno_names->name);
1601         free(odp_portno_names);
1602     }
1603 }
1604
1605 /* Format helpers. */
1606
1607 static void
1608 format_eth(struct ds *ds, const char *name, const uint8_t key[ETH_ADDR_LEN],
1609            const uint8_t (*mask)[ETH_ADDR_LEN], bool verbose)
1610 {
1611     bool mask_empty = mask && eth_addr_is_zero(*mask);
1612
1613     if (verbose || !mask_empty) {
1614         bool mask_full = !mask || eth_mask_is_exact(*mask);
1615
1616         if (mask_full) {
1617             ds_put_format(ds, "%s="ETH_ADDR_FMT",", name, ETH_ADDR_ARGS(key));
1618         } else {
1619             ds_put_format(ds, "%s=", name);
1620             eth_format_masked(key, *mask, ds);
1621             ds_put_char(ds, ',');
1622         }
1623     }
1624 }
1625
1626 static void
1627 format_be64(struct ds *ds, const char *name, ovs_be64 key,
1628             const ovs_be64 *mask, bool verbose)
1629 {
1630     bool mask_empty = mask && !*mask;
1631
1632     if (verbose || !mask_empty) {
1633         bool mask_full = !mask || *mask == OVS_BE64_MAX;
1634
1635         ds_put_format(ds, "%s=0x%"PRIx64, name, ntohll(key));
1636         if (!mask_full) { /* Partially masked. */
1637             ds_put_format(ds, "/%#"PRIx64, ntohll(*mask));
1638         }
1639         ds_put_char(ds, ',');
1640     }
1641 }
1642
1643 static void
1644 format_ipv4(struct ds *ds, const char *name, ovs_be32 key,
1645             const ovs_be32 *mask, bool verbose)
1646 {
1647     bool mask_empty = mask && !*mask;
1648
1649     if (verbose || !mask_empty) {
1650         bool mask_full = !mask || *mask == OVS_BE32_MAX;
1651
1652         ds_put_format(ds, "%s="IP_FMT, name, IP_ARGS(key));
1653         if (!mask_full) { /* Partially masked. */
1654             ds_put_format(ds, "/"IP_FMT, IP_ARGS(*mask));
1655         }
1656         ds_put_char(ds, ',');
1657     }
1658 }
1659
1660 static void
1661 format_ipv6(struct ds *ds, const char *name, const ovs_be32 key_[4],
1662             const ovs_be32 (*mask_)[4], bool verbose)
1663 {
1664     char buf[INET6_ADDRSTRLEN];
1665     const struct in6_addr *key = (const struct in6_addr *)key_;
1666     const struct in6_addr *mask = mask_ ? (const struct in6_addr *)*mask_
1667         : NULL;
1668     bool mask_empty = mask && ipv6_mask_is_any(mask);
1669
1670     if (verbose || !mask_empty) {
1671         bool mask_full = !mask || ipv6_mask_is_exact(mask);
1672
1673         inet_ntop(AF_INET6, key, buf, sizeof buf);
1674         ds_put_format(ds, "%s=%s", name, buf);
1675         if (!mask_full) { /* Partially masked. */
1676             inet_ntop(AF_INET6, mask, buf, sizeof buf);
1677             ds_put_format(ds, "/%s", buf);
1678         }
1679         ds_put_char(ds, ',');
1680     }
1681 }
1682
1683 static void
1684 format_ipv6_label(struct ds *ds, const char *name, ovs_be32 key,
1685                   const ovs_be32 *mask, bool verbose)
1686 {
1687     bool mask_empty = mask && !*mask;
1688
1689     if (verbose || !mask_empty) {
1690         bool mask_full = !mask
1691             || (*mask & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK);
1692
1693         ds_put_format(ds, "%s=%#"PRIx32, name, ntohl(key));
1694         if (!mask_full) { /* Partially masked. */
1695             ds_put_format(ds, "/%#"PRIx32, ntohl(*mask));
1696         }
1697         ds_put_char(ds, ',');
1698     }
1699 }
1700
1701 static void
1702 format_u8x(struct ds *ds, const char *name, uint8_t key,
1703            const uint8_t *mask, bool verbose)
1704 {
1705     bool mask_empty = mask && !*mask;
1706
1707     if (verbose || !mask_empty) {
1708         bool mask_full = !mask || *mask == UINT8_MAX;
1709
1710         ds_put_format(ds, "%s=%#"PRIx8, name, key);
1711         if (!mask_full) { /* Partially masked. */
1712             ds_put_format(ds, "/%#"PRIx8, *mask);
1713         }
1714         ds_put_char(ds, ',');
1715     }
1716 }
1717
1718 static void
1719 format_u8u(struct ds *ds, const char *name, uint8_t key,
1720            const uint8_t *mask, bool verbose)
1721 {
1722     bool mask_empty = mask && !*mask;
1723
1724     if (verbose || !mask_empty) {
1725         bool mask_full = !mask || *mask == UINT8_MAX;
1726
1727         ds_put_format(ds, "%s=%"PRIu8, name, key);
1728         if (!mask_full) { /* Partially masked. */
1729             ds_put_format(ds, "/%#"PRIx8, *mask);
1730         }
1731         ds_put_char(ds, ',');
1732     }
1733 }
1734
1735 static void
1736 format_be16(struct ds *ds, const char *name, ovs_be16 key,
1737             const ovs_be16 *mask, bool verbose)
1738 {
1739     bool mask_empty = mask && !*mask;
1740
1741     if (verbose || !mask_empty) {
1742         bool mask_full = !mask || *mask == OVS_BE16_MAX;
1743
1744         ds_put_format(ds, "%s=%"PRIu16, name, ntohs(key));
1745         if (!mask_full) { /* Partially masked. */
1746             ds_put_format(ds, "/%#"PRIx16, ntohs(*mask));
1747         }
1748         ds_put_char(ds, ',');
1749     }
1750 }
1751
1752 static void
1753 format_be16x(struct ds *ds, const char *name, ovs_be16 key,
1754              const ovs_be16 *mask, bool verbose)
1755 {
1756     bool mask_empty = mask && !*mask;
1757
1758     if (verbose || !mask_empty) {
1759         bool mask_full = !mask || *mask == OVS_BE16_MAX;
1760
1761         ds_put_format(ds, "%s=%#"PRIx16, name, ntohs(key));
1762         if (!mask_full) { /* Partially masked. */
1763             ds_put_format(ds, "/%#"PRIx16, ntohs(*mask));
1764         }
1765         ds_put_char(ds, ',');
1766     }
1767 }
1768
1769 static void
1770 format_tun_flags(struct ds *ds, const char *name, uint16_t key,
1771                  const uint16_t *mask, bool verbose)
1772 {
1773     bool mask_empty = mask && !*mask;
1774
1775     if (verbose || !mask_empty) {
1776         bool mask_full = !mask || (*mask & FLOW_TNL_F_MASK) == FLOW_TNL_F_MASK;
1777
1778         ds_put_cstr(ds, name);
1779         ds_put_char(ds, '(');
1780         if (!mask_full) { /* Partially masked. */
1781             format_flags_masked(ds, NULL, flow_tun_flag_to_string, key, *mask);
1782         } else { /* Fully masked. */
1783             format_flags(ds, flow_tun_flag_to_string, key, ',');
1784         }
1785         ds_put_cstr(ds, "),");
1786     }
1787 }
1788
1789 static bool
1790 check_attr_len(struct ds *ds, const struct nlattr *a, const struct nlattr *ma,
1791                const struct attr_len_tbl tbl[], int max_len, bool need_key)
1792 {
1793     int expected_len;
1794
1795     expected_len = odp_key_attr_len(tbl, max_len, nl_attr_type(a));
1796     if (expected_len != ATTR_LEN_VARIABLE &&
1797         expected_len != ATTR_LEN_NESTED) {
1798
1799         bool bad_key_len = nl_attr_get_size(a) != expected_len;
1800         bool bad_mask_len = ma && nl_attr_get_size(ma) != expected_len;
1801
1802         if (bad_key_len || bad_mask_len) {
1803             if (need_key) {
1804                 ds_put_format(ds, "key%u", nl_attr_type(a));
1805             }
1806             if (bad_key_len) {
1807                 ds_put_format(ds, "(bad key length %"PRIuSIZE", expected %d)(",
1808                               nl_attr_get_size(a), expected_len);
1809             }
1810             format_generic_odp_key(a, ds);
1811             if (ma) {
1812                 ds_put_char(ds, '/');
1813                 if (bad_mask_len) {
1814                     ds_put_format(ds, "(bad mask length %"PRIuSIZE", expected %d)(",
1815                                   nl_attr_get_size(ma), expected_len);
1816                 }
1817                 format_generic_odp_key(ma, ds);
1818             }
1819             ds_put_char(ds, ')');
1820             return false;
1821         }
1822     }
1823
1824     return true;
1825 }
1826
1827 static void
1828 format_unknown_key(struct ds *ds, const struct nlattr *a,
1829                    const struct nlattr *ma)
1830 {
1831     ds_put_format(ds, "key%u(", nl_attr_type(a));
1832     format_generic_odp_key(a, ds);
1833     if (ma && !odp_mask_attr_is_exact(ma)) {
1834         ds_put_char(ds, '/');
1835         format_generic_odp_key(ma, ds);
1836     }
1837     ds_put_cstr(ds, "),");
1838 }
1839
1840 static void
1841 format_odp_tun_vxlan_opt(const struct nlattr *attr,
1842                          const struct nlattr *mask_attr, struct ds *ds,
1843                          bool verbose)
1844 {
1845     unsigned int left;
1846     const struct nlattr *a;
1847     struct ofpbuf ofp;
1848
1849     ofpbuf_init(&ofp, 100);
1850     NL_NESTED_FOR_EACH(a, left, attr) {
1851         uint16_t type = nl_attr_type(a);
1852         const struct nlattr *ma = NULL;
1853
1854         if (mask_attr) {
1855             ma = nl_attr_find__(nl_attr_get(mask_attr),
1856                                 nl_attr_get_size(mask_attr), type);
1857             if (!ma) {
1858                 ma = generate_all_wildcard_mask(ovs_vxlan_ext_attr_lens,
1859                                                 OVS_VXLAN_EXT_MAX,
1860                                                 &ofp, a);
1861             }
1862         }
1863
1864         if (!check_attr_len(ds, a, ma, ovs_vxlan_ext_attr_lens,
1865                             OVS_VXLAN_EXT_MAX, true)) {
1866             continue;
1867         }
1868
1869         switch (type) {
1870         case OVS_VXLAN_EXT_GBP: {
1871             uint32_t key = nl_attr_get_u32(a);
1872             ovs_be16 id, id_mask;
1873             uint8_t flags, flags_mask;
1874
1875             id = htons(key & 0xFFFF);
1876             flags = (key >> 16) & 0xFF;
1877             if (ma) {
1878                 uint32_t mask = nl_attr_get_u32(ma);
1879                 id_mask = htons(mask & 0xFFFF);
1880                 flags_mask = (mask >> 16) & 0xFF;
1881             }
1882
1883             ds_put_cstr(ds, "gbp(");
1884             format_be16(ds, "id", id, ma ? &id_mask : NULL, verbose);
1885             format_u8x(ds, "flags", flags, ma ? &flags_mask : NULL, verbose);
1886             ds_chomp(ds, ',');
1887             ds_put_cstr(ds, "),");
1888             break;
1889         }
1890
1891         default:
1892             format_unknown_key(ds, a, ma);
1893         }
1894         ofpbuf_clear(&ofp);
1895     }
1896
1897     ds_chomp(ds, ',');
1898     ofpbuf_uninit(&ofp);
1899 }
1900
1901 #define MASK(PTR, FIELD) PTR ? &PTR->FIELD : NULL
1902
1903 static void
1904 format_odp_tun_geneve(const struct nlattr *attr,
1905                       const struct nlattr *mask_attr, struct ds *ds,
1906                       bool verbose)
1907 {
1908     int opts_len = nl_attr_get_size(attr);
1909     const struct geneve_opt *opt = nl_attr_get(attr);
1910     const struct geneve_opt *mask = mask_attr ?
1911                                     nl_attr_get(mask_attr) : NULL;
1912
1913     if (mask && nl_attr_get_size(attr) != nl_attr_get_size(mask_attr)) {
1914         ds_put_format(ds, "value len %"PRIuSIZE" different from mask len %"PRIuSIZE,
1915                       nl_attr_get_size(attr), nl_attr_get_size(mask_attr));
1916         return;
1917     }
1918
1919     while (opts_len > 0) {
1920         unsigned int len;
1921         uint8_t data_len, data_len_mask;
1922
1923         if (opts_len < sizeof *opt) {
1924             ds_put_format(ds, "opt len %u less than minimum %"PRIuSIZE,
1925                           opts_len, sizeof *opt);
1926             return;
1927         }
1928
1929         data_len = opt->length * 4;
1930         if (mask) {
1931             if (mask->length == 0x1f) {
1932                 data_len_mask = UINT8_MAX;
1933             } else {
1934                 data_len_mask = mask->length;
1935             }
1936         }
1937         len = sizeof *opt + data_len;
1938         if (len > opts_len) {
1939             ds_put_format(ds, "opt len %u greater than remaining %u",
1940                           len, opts_len);
1941             return;
1942         }
1943
1944         ds_put_char(ds, '{');
1945         format_be16x(ds, "class", opt->opt_class, MASK(mask, opt_class),
1946                     verbose);
1947         format_u8x(ds, "type", opt->type, MASK(mask, type), verbose);
1948         format_u8u(ds, "len", data_len, mask ? &data_len_mask : NULL, verbose);
1949         if (verbose || !mask || !is_all_zeros(mask + 1, data_len)) {
1950             ds_put_hex(ds, opt + 1, data_len);
1951             if (mask && !is_all_ones(mask + 1, data_len)) {
1952                 ds_put_char(ds, '/');
1953                 ds_put_hex(ds, mask + 1, data_len);
1954             }
1955         } else {
1956             ds_chomp(ds, ',');
1957         }
1958         ds_put_char(ds, '}');
1959
1960         opt += len / sizeof(*opt);
1961         if (mask) {
1962             mask += len / sizeof(*opt);
1963         }
1964         opts_len -= len;
1965     };
1966 }
1967
1968 static void
1969 format_odp_tun_attr(const struct nlattr *attr, const struct nlattr *mask_attr,
1970                     struct ds *ds, bool verbose)
1971 {
1972     unsigned int left;
1973     const struct nlattr *a;
1974     uint16_t flags = 0;
1975     uint16_t mask_flags = 0;
1976     struct ofpbuf ofp;
1977
1978     ofpbuf_init(&ofp, 100);
1979     NL_NESTED_FOR_EACH(a, left, attr) {
1980         enum ovs_tunnel_key_attr type = nl_attr_type(a);
1981         const struct nlattr *ma = NULL;
1982
1983         if (mask_attr) {
1984             ma = nl_attr_find__(nl_attr_get(mask_attr),
1985                                 nl_attr_get_size(mask_attr), type);
1986             if (!ma) {
1987                 ma = generate_all_wildcard_mask(ovs_tun_key_attr_lens,
1988                                                 OVS_TUNNEL_KEY_ATTR_MAX,
1989                                                 &ofp, a);
1990             }
1991         }
1992
1993         if (!check_attr_len(ds, a, ma, ovs_tun_key_attr_lens,
1994                             OVS_TUNNEL_KEY_ATTR_MAX, true)) {
1995             continue;
1996         }
1997
1998         switch (type) {
1999         case OVS_TUNNEL_KEY_ATTR_ID:
2000             format_be64(ds, "tun_id", nl_attr_get_be64(a),
2001                         ma ? nl_attr_get(ma) : NULL, verbose);
2002             flags |= FLOW_TNL_F_KEY;
2003             if (ma) {
2004                 mask_flags |= FLOW_TNL_F_KEY;
2005             }
2006             break;
2007         case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
2008             format_ipv4(ds, "src", nl_attr_get_be32(a),
2009                         ma ? nl_attr_get(ma) : NULL, verbose);
2010             break;
2011         case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
2012             format_ipv4(ds, "dst", nl_attr_get_be32(a),
2013                         ma ? nl_attr_get(ma) : NULL, verbose);
2014             break;
2015         case OVS_TUNNEL_KEY_ATTR_TOS:
2016             format_u8x(ds, "tos", nl_attr_get_u8(a),
2017                        ma ? nl_attr_get(ma) : NULL, verbose);
2018             break;
2019         case OVS_TUNNEL_KEY_ATTR_TTL:
2020             format_u8u(ds, "ttl", nl_attr_get_u8(a),
2021                        ma ? nl_attr_get(ma) : NULL, verbose);
2022             break;
2023         case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
2024             flags |= FLOW_TNL_F_DONT_FRAGMENT;
2025             break;
2026         case OVS_TUNNEL_KEY_ATTR_CSUM:
2027             flags |= FLOW_TNL_F_CSUM;
2028             break;
2029         case OVS_TUNNEL_KEY_ATTR_TP_SRC:
2030             format_be16(ds, "tp_src", nl_attr_get_be16(a),
2031                         ma ? nl_attr_get(ma) : NULL, verbose);
2032             break;
2033         case OVS_TUNNEL_KEY_ATTR_TP_DST:
2034             format_be16(ds, "tp_dst", nl_attr_get_be16(a),
2035                         ma ? nl_attr_get(ma) : NULL, verbose);
2036             break;
2037         case OVS_TUNNEL_KEY_ATTR_OAM:
2038             flags |= FLOW_TNL_F_OAM;
2039             break;
2040         case OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS:
2041             ds_put_cstr(ds, "vxlan(");
2042             format_odp_tun_vxlan_opt(a, ma, ds, verbose);
2043             ds_put_cstr(ds, "),");
2044             break;
2045         case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS:
2046             ds_put_cstr(ds, "geneve(");
2047             format_odp_tun_geneve(a, ma, ds, verbose);
2048             ds_put_cstr(ds, "),");
2049             break;
2050         case __OVS_TUNNEL_KEY_ATTR_MAX:
2051         default:
2052             format_unknown_key(ds, a, ma);
2053         }
2054         ofpbuf_clear(&ofp);
2055     }
2056
2057     /* Flags can have a valid mask even if the attribute is not set, so
2058      * we need to collect these separately. */
2059     if (mask_attr) {
2060         NL_NESTED_FOR_EACH(a, left, mask_attr) {
2061             switch (nl_attr_type(a)) {
2062             case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
2063                 mask_flags |= FLOW_TNL_F_DONT_FRAGMENT;
2064                 break;
2065             case OVS_TUNNEL_KEY_ATTR_CSUM:
2066                 mask_flags |= FLOW_TNL_F_CSUM;
2067                 break;
2068             case OVS_TUNNEL_KEY_ATTR_OAM:
2069                 mask_flags |= FLOW_TNL_F_OAM;
2070                 break;
2071             }
2072         }
2073     }
2074
2075     format_tun_flags(ds, "flags", flags, mask_attr ? &mask_flags : NULL,
2076                      verbose);
2077     ds_chomp(ds, ',');
2078     ofpbuf_uninit(&ofp);
2079 }
2080
2081 static void
2082 format_frag(struct ds *ds, const char *name, uint8_t key,
2083             const uint8_t *mask, bool verbose)
2084 {
2085     bool mask_empty = mask && !*mask;
2086
2087     /* ODP frag is an enumeration field; partial masks are not meaningful. */
2088     if (verbose || !mask_empty) {
2089         bool mask_full = !mask || *mask == UINT8_MAX;
2090
2091         if (!mask_full) { /* Partially masked. */
2092             ds_put_format(ds, "error: partial mask not supported for frag (%#"
2093                           PRIx8"),", *mask);
2094         } else {
2095             ds_put_format(ds, "%s=%s,", name, ovs_frag_type_to_string(key));
2096         }
2097     }
2098 }
2099
2100 static void
2101 format_odp_key_attr(const struct nlattr *a, const struct nlattr *ma,
2102                     const struct hmap *portno_names, struct ds *ds,
2103                     bool verbose)
2104 {
2105     enum ovs_key_attr attr = nl_attr_type(a);
2106     char namebuf[OVS_KEY_ATTR_BUFSIZE];
2107     bool is_exact;
2108
2109     is_exact = ma ? odp_mask_attr_is_exact(ma) : true;
2110
2111     ds_put_cstr(ds, ovs_key_attr_to_string(attr, namebuf, sizeof namebuf));
2112
2113     if (!check_attr_len(ds, a, ma, ovs_flow_key_attr_lens,
2114                         OVS_KEY_ATTR_MAX, false)) {
2115         return;
2116     }
2117
2118     ds_put_char(ds, '(');
2119     switch (attr) {
2120     case OVS_KEY_ATTR_ENCAP:
2121         if (ma && nl_attr_get_size(ma) && nl_attr_get_size(a)) {
2122             odp_flow_format(nl_attr_get(a), nl_attr_get_size(a),
2123                             nl_attr_get(ma), nl_attr_get_size(ma), NULL, ds,
2124                             verbose);
2125         } else if (nl_attr_get_size(a)) {
2126             odp_flow_format(nl_attr_get(a), nl_attr_get_size(a), NULL, 0, NULL,
2127                             ds, verbose);
2128         }
2129         break;
2130
2131     case OVS_KEY_ATTR_PRIORITY:
2132     case OVS_KEY_ATTR_SKB_MARK:
2133     case OVS_KEY_ATTR_DP_HASH:
2134     case OVS_KEY_ATTR_RECIRC_ID:
2135         ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2136         if (!is_exact) {
2137             ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2138         }
2139         break;
2140
2141     case OVS_KEY_ATTR_TUNNEL:
2142         format_odp_tun_attr(a, ma, ds, verbose);
2143         break;
2144
2145     case OVS_KEY_ATTR_IN_PORT:
2146         if (portno_names && verbose && is_exact) {
2147             char *name = odp_portno_names_get(portno_names,
2148                             u32_to_odp(nl_attr_get_u32(a)));
2149             if (name) {
2150                 ds_put_format(ds, "%s", name);
2151             } else {
2152                 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2153             }
2154         } else {
2155             ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2156             if (!is_exact) {
2157                 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2158             }
2159         }
2160         break;
2161
2162     case OVS_KEY_ATTR_ETHERNET: {
2163         const struct ovs_key_ethernet *mask = ma ? nl_attr_get(ma) : NULL;
2164         const struct ovs_key_ethernet *key = nl_attr_get(a);
2165
2166         format_eth(ds, "src", key->eth_src, MASK(mask, eth_src), verbose);
2167         format_eth(ds, "dst", key->eth_dst, MASK(mask, eth_dst), verbose);
2168         ds_chomp(ds, ',');
2169         break;
2170     }
2171     case OVS_KEY_ATTR_VLAN:
2172         format_vlan_tci(ds, nl_attr_get_be16(a),
2173                         ma ? nl_attr_get_be16(ma) : OVS_BE16_MAX, verbose);
2174         break;
2175
2176     case OVS_KEY_ATTR_MPLS: {
2177         const struct ovs_key_mpls *mpls_key = nl_attr_get(a);
2178         const struct ovs_key_mpls *mpls_mask = NULL;
2179         size_t size = nl_attr_get_size(a);
2180
2181         if (!size || size % sizeof *mpls_key) {
2182             ds_put_format(ds, "(bad key length %"PRIuSIZE")", size);
2183             return;
2184         }
2185         if (!is_exact) {
2186             mpls_mask = nl_attr_get(ma);
2187             if (size != nl_attr_get_size(ma)) {
2188                 ds_put_format(ds, "(key length %"PRIuSIZE" != "
2189                               "mask length %"PRIuSIZE")",
2190                               size, nl_attr_get_size(ma));
2191                 return;
2192             }
2193         }
2194         format_mpls(ds, mpls_key, mpls_mask, size / sizeof *mpls_key);
2195         break;
2196     }
2197     case OVS_KEY_ATTR_ETHERTYPE:
2198         ds_put_format(ds, "0x%04"PRIx16, ntohs(nl_attr_get_be16(a)));
2199         if (!is_exact) {
2200             ds_put_format(ds, "/0x%04"PRIx16, ntohs(nl_attr_get_be16(ma)));
2201         }
2202         break;
2203
2204     case OVS_KEY_ATTR_IPV4: {
2205         const struct ovs_key_ipv4 *key = nl_attr_get(a);
2206         const struct ovs_key_ipv4 *mask = ma ? nl_attr_get(ma) : NULL;
2207
2208         format_ipv4(ds, "src", key->ipv4_src, MASK(mask, ipv4_src), verbose);
2209         format_ipv4(ds, "dst", key->ipv4_dst, MASK(mask, ipv4_dst), verbose);
2210         format_u8u(ds, "proto", key->ipv4_proto, MASK(mask, ipv4_proto),
2211                       verbose);
2212         format_u8x(ds, "tos", key->ipv4_tos, MASK(mask, ipv4_tos), verbose);
2213         format_u8u(ds, "ttl", key->ipv4_ttl, MASK(mask, ipv4_ttl), verbose);
2214         format_frag(ds, "frag", key->ipv4_frag, MASK(mask, ipv4_frag),
2215                     verbose);
2216         ds_chomp(ds, ',');
2217         break;
2218     }
2219     case OVS_KEY_ATTR_IPV6: {
2220         const struct ovs_key_ipv6 *key = nl_attr_get(a);
2221         const struct ovs_key_ipv6 *mask = ma ? nl_attr_get(ma) : NULL;
2222
2223         format_ipv6(ds, "src", key->ipv6_src, MASK(mask, ipv6_src), verbose);
2224         format_ipv6(ds, "dst", key->ipv6_dst, MASK(mask, ipv6_dst), verbose);
2225         format_ipv6_label(ds, "label", key->ipv6_label, MASK(mask, ipv6_label),
2226                           verbose);
2227         format_u8u(ds, "proto", key->ipv6_proto, MASK(mask, ipv6_proto),
2228                       verbose);
2229         format_u8x(ds, "tclass", key->ipv6_tclass, MASK(mask, ipv6_tclass),
2230                       verbose);
2231         format_u8u(ds, "hlimit", key->ipv6_hlimit, MASK(mask, ipv6_hlimit),
2232                       verbose);
2233         format_frag(ds, "frag", key->ipv6_frag, MASK(mask, ipv6_frag),
2234                     verbose);
2235         ds_chomp(ds, ',');
2236         break;
2237     }
2238         /* These have the same structure and format. */
2239     case OVS_KEY_ATTR_TCP:
2240     case OVS_KEY_ATTR_UDP:
2241     case OVS_KEY_ATTR_SCTP: {
2242         const struct ovs_key_tcp *key = nl_attr_get(a);
2243         const struct ovs_key_tcp *mask = ma ? nl_attr_get(ma) : NULL;
2244
2245         format_be16(ds, "src", key->tcp_src, MASK(mask, tcp_src), verbose);
2246         format_be16(ds, "dst", key->tcp_dst, MASK(mask, tcp_dst), verbose);
2247         ds_chomp(ds, ',');
2248         break;
2249     }
2250     case OVS_KEY_ATTR_TCP_FLAGS:
2251         if (!is_exact) {
2252             format_flags_masked(ds, NULL, packet_tcp_flag_to_string,
2253                                 ntohs(nl_attr_get_be16(a)),
2254                                 ntohs(nl_attr_get_be16(ma)));
2255         } else {
2256             format_flags(ds, packet_tcp_flag_to_string,
2257                          ntohs(nl_attr_get_be16(a)), ',');
2258         }
2259         break;
2260
2261     case OVS_KEY_ATTR_ICMP: {
2262         const struct ovs_key_icmp *key = nl_attr_get(a);
2263         const struct ovs_key_icmp *mask = ma ? nl_attr_get(ma) : NULL;
2264
2265         format_u8u(ds, "type", key->icmp_type, MASK(mask, icmp_type), verbose);
2266         format_u8u(ds, "code", key->icmp_code, MASK(mask, icmp_code), verbose);
2267         ds_chomp(ds, ',');
2268         break;
2269     }
2270     case OVS_KEY_ATTR_ICMPV6: {
2271         const struct ovs_key_icmpv6 *key = nl_attr_get(a);
2272         const struct ovs_key_icmpv6 *mask = ma ? nl_attr_get(ma) : NULL;
2273
2274         format_u8u(ds, "type", key->icmpv6_type, MASK(mask, icmpv6_type),
2275                    verbose);
2276         format_u8u(ds, "code", key->icmpv6_code, MASK(mask, icmpv6_code),
2277                    verbose);
2278         ds_chomp(ds, ',');
2279         break;
2280     }
2281     case OVS_KEY_ATTR_ARP: {
2282         const struct ovs_key_arp *mask = ma ? nl_attr_get(ma) : NULL;
2283         const struct ovs_key_arp *key = nl_attr_get(a);
2284
2285         format_ipv4(ds, "sip", key->arp_sip, MASK(mask, arp_sip), verbose);
2286         format_ipv4(ds, "tip", key->arp_tip, MASK(mask, arp_tip), verbose);
2287         format_be16(ds, "op", key->arp_op, MASK(mask, arp_op), verbose);
2288         format_eth(ds, "sha", key->arp_sha, MASK(mask, arp_sha), verbose);
2289         format_eth(ds, "tha", key->arp_tha, MASK(mask, arp_tha), verbose);
2290         ds_chomp(ds, ',');
2291         break;
2292     }
2293     case OVS_KEY_ATTR_ND: {
2294         const struct ovs_key_nd *mask = ma ? nl_attr_get(ma) : NULL;
2295         const struct ovs_key_nd *key = nl_attr_get(a);
2296
2297         format_ipv6(ds, "target", key->nd_target, MASK(mask, nd_target),
2298                     verbose);
2299         format_eth(ds, "sll", key->nd_sll, MASK(mask, nd_sll), verbose);
2300         format_eth(ds, "tll", key->nd_tll, MASK(mask, nd_tll), verbose);
2301
2302         ds_chomp(ds, ',');
2303         break;
2304     }
2305     case OVS_KEY_ATTR_UNSPEC:
2306     case __OVS_KEY_ATTR_MAX:
2307     default:
2308         format_generic_odp_key(a, ds);
2309         if (!is_exact) {
2310             ds_put_char(ds, '/');
2311             format_generic_odp_key(ma, ds);
2312         }
2313         break;
2314     }
2315     ds_put_char(ds, ')');
2316 }
2317
2318 static struct nlattr *
2319 generate_all_wildcard_mask(const struct attr_len_tbl tbl[], int max,
2320                            struct ofpbuf *ofp, const struct nlattr *key)
2321 {
2322     const struct nlattr *a;
2323     unsigned int left;
2324     int type = nl_attr_type(key);
2325     int size = nl_attr_get_size(key);
2326
2327     if (odp_key_attr_len(tbl, max, type) != ATTR_LEN_NESTED) {
2328         nl_msg_put_unspec_zero(ofp, type, size);
2329     } else {
2330         size_t nested_mask;
2331
2332         if (tbl[type].next) {
2333             tbl = tbl[type].next;
2334             max = tbl[type].next_max;
2335         }
2336
2337         nested_mask = nl_msg_start_nested(ofp, type);
2338         NL_ATTR_FOR_EACH(a, left, key, nl_attr_get_size(key)) {
2339             generate_all_wildcard_mask(tbl, max, ofp, nl_attr_get(a));
2340         }
2341         nl_msg_end_nested(ofp, nested_mask);
2342     }
2343
2344     return ofp->base;
2345 }
2346
2347 int
2348 odp_ufid_from_string(const char *s_, ovs_u128 *ufid)
2349 {
2350     const char *s = s_;
2351
2352     if (ovs_scan(s, "ufid:")) {
2353         s += 5;
2354
2355         if (!uuid_from_string_prefix((struct uuid *)ufid, s)) {
2356             return -EINVAL;
2357         }
2358         s += UUID_LEN;
2359
2360         return s - s_;
2361     }
2362
2363     return 0;
2364 }
2365
2366 void
2367 odp_format_ufid(const ovs_u128 *ufid, struct ds *ds)
2368 {
2369     ds_put_format(ds, "ufid:"UUID_FMT, UUID_ARGS((struct uuid *)ufid));
2370 }
2371
2372 /* Appends to 'ds' a string representation of the 'key_len' bytes of
2373  * OVS_KEY_ATTR_* attributes in 'key'. If non-null, additionally formats the
2374  * 'mask_len' bytes of 'mask' which apply to 'key'. If 'portno_names' is
2375  * non-null and 'verbose' is true, translates odp port number to its name. */
2376 void
2377 odp_flow_format(const struct nlattr *key, size_t key_len,
2378                 const struct nlattr *mask, size_t mask_len,
2379                 const struct hmap *portno_names, struct ds *ds, bool verbose)
2380 {
2381     if (key_len) {
2382         const struct nlattr *a;
2383         unsigned int left;
2384         bool has_ethtype_key = false;
2385         const struct nlattr *ma = NULL;
2386         struct ofpbuf ofp;
2387         bool first_field = true;
2388
2389         ofpbuf_init(&ofp, 100);
2390         NL_ATTR_FOR_EACH (a, left, key, key_len) {
2391             bool is_nested_attr;
2392             bool is_wildcard = false;
2393             int attr_type = nl_attr_type(a);
2394
2395             if (attr_type == OVS_KEY_ATTR_ETHERTYPE) {
2396                 has_ethtype_key = true;
2397             }
2398
2399             is_nested_attr = odp_key_attr_len(ovs_flow_key_attr_lens,
2400                                               OVS_KEY_ATTR_MAX, attr_type) ==
2401                              ATTR_LEN_NESTED;
2402
2403             if (mask && mask_len) {
2404                 ma = nl_attr_find__(mask, mask_len, nl_attr_type(a));
2405                 is_wildcard = ma ? odp_mask_attr_is_wildcard(ma) : true;
2406             }
2407
2408             if (verbose || !is_wildcard  || is_nested_attr) {
2409                 if (is_wildcard && !ma) {
2410                     ma = generate_all_wildcard_mask(ovs_flow_key_attr_lens,
2411                                                     OVS_KEY_ATTR_MAX,
2412                                                     &ofp, a);
2413                 }
2414                 if (!first_field) {
2415                     ds_put_char(ds, ',');
2416                 }
2417                 format_odp_key_attr(a, ma, portno_names, ds, verbose);
2418                 first_field = false;
2419             }
2420             ofpbuf_clear(&ofp);
2421         }
2422         ofpbuf_uninit(&ofp);
2423
2424         if (left) {
2425             int i;
2426
2427             if (left == key_len) {
2428                 ds_put_cstr(ds, "<empty>");
2429             }
2430             ds_put_format(ds, ",***%u leftover bytes*** (", left);
2431             for (i = 0; i < left; i++) {
2432                 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
2433             }
2434             ds_put_char(ds, ')');
2435         }
2436         if (!has_ethtype_key) {
2437             ma = nl_attr_find__(mask, mask_len, OVS_KEY_ATTR_ETHERTYPE);
2438             if (ma) {
2439                 ds_put_format(ds, ",eth_type(0/0x%04"PRIx16")",
2440                               ntohs(nl_attr_get_be16(ma)));
2441             }
2442         }
2443     } else {
2444         ds_put_cstr(ds, "<empty>");
2445     }
2446 }
2447
2448 /* Appends to 'ds' a string representation of the 'key_len' bytes of
2449  * OVS_KEY_ATTR_* attributes in 'key'. */
2450 void
2451 odp_flow_key_format(const struct nlattr *key,
2452                     size_t key_len, struct ds *ds)
2453 {
2454     odp_flow_format(key, key_len, NULL, 0, NULL, ds, true);
2455 }
2456
2457 static bool
2458 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
2459 {
2460     if (!strcasecmp(s, "no")) {
2461         *type = OVS_FRAG_TYPE_NONE;
2462     } else if (!strcasecmp(s, "first")) {
2463         *type = OVS_FRAG_TYPE_FIRST;
2464     } else if (!strcasecmp(s, "later")) {
2465         *type = OVS_FRAG_TYPE_LATER;
2466     } else {
2467         return false;
2468     }
2469     return true;
2470 }
2471
2472 /* Parsing. */
2473
2474 static int
2475 scan_eth(const char *s, uint8_t (*key)[ETH_ADDR_LEN],
2476          uint8_t (*mask)[ETH_ADDR_LEN])
2477 {
2478     int n;
2479
2480     if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(*key), &n)) {
2481         int len = n;
2482
2483         if (mask) {
2484             if (ovs_scan(s + len, "/"ETH_ADDR_SCAN_FMT"%n",
2485                          ETH_ADDR_SCAN_ARGS(*mask), &n)) {
2486                 len += n;
2487             } else {
2488                 memset(mask, 0xff, sizeof *mask);
2489             }
2490         }
2491         return len;
2492     }
2493     return 0;
2494 }
2495
2496 static int
2497 scan_ipv4(const char *s, ovs_be32 *key, ovs_be32 *mask)
2498 {
2499     int n;
2500
2501     if (ovs_scan(s, IP_SCAN_FMT"%n", IP_SCAN_ARGS(key), &n)) {
2502         int len = n;
2503
2504         if (mask) {
2505             if (ovs_scan(s + len, "/"IP_SCAN_FMT"%n",
2506                          IP_SCAN_ARGS(mask), &n)) {
2507                 len += n;
2508             } else {
2509                 *mask = OVS_BE32_MAX;
2510             }
2511         }
2512         return len;
2513     }
2514     return 0;
2515 }
2516
2517 static int
2518 scan_ipv6(const char *s, ovs_be32 (*key)[4], ovs_be32 (*mask)[4])
2519 {
2520     int n;
2521     char ipv6_s[IPV6_SCAN_LEN + 1];
2522
2523     if (ovs_scan(s, IPV6_SCAN_FMT"%n", ipv6_s, &n)
2524         && inet_pton(AF_INET6, ipv6_s, key) == 1) {
2525         int len = n;
2526
2527         if (mask) {
2528             if (ovs_scan(s + len, "/"IPV6_SCAN_FMT"%n", ipv6_s, &n)
2529                 && inet_pton(AF_INET6, ipv6_s, mask) == 1) {
2530                 len += n;
2531             } else {
2532                 memset(mask, 0xff, sizeof *mask);
2533             }
2534         }
2535         return len;
2536     }
2537     return 0;
2538 }
2539
2540 static int
2541 scan_ipv6_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
2542 {
2543     int key_, mask_;
2544     int n;
2545
2546     if (ovs_scan(s, "%i%n", &key_, &n)
2547         && (key_ & ~IPV6_LABEL_MASK) == 0) {
2548         int len = n;
2549
2550         *key = htonl(key_);
2551         if (mask) {
2552             if (ovs_scan(s + len, "/%i%n", &mask_, &n)
2553                 && (mask_ & ~IPV6_LABEL_MASK) == 0) {
2554                 len += n;
2555                 *mask = htonl(mask_);
2556             } else {
2557                 *mask = htonl(IPV6_LABEL_MASK);
2558             }
2559         }
2560         return len;
2561     }
2562     return 0;
2563 }
2564
2565 static int
2566 scan_u8(const char *s, uint8_t *key, uint8_t *mask)
2567 {
2568     int n;
2569
2570     if (ovs_scan(s, "%"SCNi8"%n", key, &n)) {
2571         int len = n;
2572
2573         if (mask) {
2574             if (ovs_scan(s + len, "/%"SCNi8"%n", mask, &n)) {
2575                 len += n;
2576             } else {
2577                 *mask = UINT8_MAX;
2578             }
2579         }
2580         return len;
2581     }
2582     return 0;
2583 }
2584
2585 static int
2586 scan_u32(const char *s, uint32_t *key, uint32_t *mask)
2587 {
2588     int n;
2589
2590     if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
2591         int len = n;
2592
2593         if (mask) {
2594             if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
2595                 len += n;
2596             } else {
2597                 *mask = UINT32_MAX;
2598             }
2599         }
2600         return len;
2601     }
2602     return 0;
2603 }
2604
2605 static int
2606 scan_be16(const char *s, ovs_be16 *key, ovs_be16 *mask)
2607 {
2608     uint16_t key_, mask_;
2609     int n;
2610
2611     if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
2612         int len = n;
2613
2614         *key = htons(key_);
2615         if (mask) {
2616             if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
2617                 len += n;
2618                 *mask = htons(mask_);
2619             } else {
2620                 *mask = OVS_BE16_MAX;
2621             }
2622         }
2623         return len;
2624     }
2625     return 0;
2626 }
2627
2628 static int
2629 scan_be64(const char *s, ovs_be64 *key, ovs_be64 *mask)
2630 {
2631     uint64_t key_, mask_;
2632     int n;
2633
2634     if (ovs_scan(s, "%"SCNi64"%n", &key_, &n)) {
2635         int len = n;
2636
2637         *key = htonll(key_);
2638         if (mask) {
2639             if (ovs_scan(s + len, "/%"SCNi64"%n", &mask_, &n)) {
2640                 len += n;
2641                 *mask = htonll(mask_);
2642             } else {
2643                 *mask = OVS_BE64_MAX;
2644             }
2645         }
2646         return len;
2647     }
2648     return 0;
2649 }
2650
2651 static int
2652 scan_tun_flags(const char *s, uint16_t *key, uint16_t *mask)
2653 {
2654     uint32_t flags, fmask;
2655     int n;
2656
2657     n = parse_flags(s, flow_tun_flag_to_string, &flags,
2658                     FLOW_TNL_F_MASK, mask ? &fmask : NULL);
2659     if (n >= 0 && s[n] == ')') {
2660         *key = flags;
2661         if (mask) {
2662             *mask = fmask;
2663         }
2664         return n + 1;
2665     }
2666     return 0;
2667 }
2668
2669 static int
2670 scan_tcp_flags(const char *s, ovs_be16 *key, ovs_be16 *mask)
2671 {
2672     uint32_t flags, fmask;
2673     int n;
2674
2675     n = parse_flags(s, packet_tcp_flag_to_string, &flags,
2676                     TCP_FLAGS(OVS_BE16_MAX), mask ? &fmask : NULL);
2677     if (n >= 0) {
2678         *key = htons(flags);
2679         if (mask) {
2680             *mask = htons(fmask);
2681         }
2682         return n;
2683     }
2684     return 0;
2685 }
2686
2687 static int
2688 scan_frag(const char *s, uint8_t *key, uint8_t *mask)
2689 {
2690     int n;
2691     char frag[8];
2692     enum ovs_frag_type frag_type;
2693
2694     if (ovs_scan(s, "%7[a-z]%n", frag, &n)
2695         && ovs_frag_type_from_string(frag, &frag_type)) {
2696         int len = n;
2697
2698         *key = frag_type;
2699         if (mask) {
2700             *mask = UINT8_MAX;
2701         }
2702         return len;
2703     }
2704     return 0;
2705 }
2706
2707 static int
2708 scan_port(const char *s, uint32_t *key, uint32_t *mask,
2709           const struct simap *port_names)
2710 {
2711     int n;
2712
2713     if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
2714         int len = n;
2715
2716         if (mask) {
2717             if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
2718                 len += n;
2719             } else {
2720                 *mask = UINT32_MAX;
2721             }
2722         }
2723         return len;
2724     } else if (port_names) {
2725         const struct simap_node *node;
2726         int len;
2727
2728         len = strcspn(s, ")");
2729         node = simap_find_len(port_names, s, len);
2730         if (node) {
2731             *key = node->data;
2732
2733             if (mask) {
2734                 *mask = UINT32_MAX;
2735             }
2736             return len;
2737         }
2738     }
2739     return 0;
2740 }
2741
2742 /* Helper for vlan parsing. */
2743 struct ovs_key_vlan__ {
2744     ovs_be16 tci;
2745 };
2746
2747 static bool
2748 set_be16_bf(ovs_be16 *bf, uint8_t bits, uint8_t offset, uint16_t value)
2749 {
2750     const uint16_t mask = ((1U << bits) - 1) << offset;
2751
2752     if (value >> bits) {
2753         return false;
2754     }
2755
2756     *bf = htons((ntohs(*bf) & ~mask) | (value << offset));
2757     return true;
2758 }
2759
2760 static int
2761 scan_be16_bf(const char *s, ovs_be16 *key, ovs_be16 *mask, uint8_t bits,
2762              uint8_t offset)
2763 {
2764     uint16_t key_, mask_;
2765     int n;
2766
2767     if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
2768         int len = n;
2769
2770         if (set_be16_bf(key, bits, offset, key_)) {
2771             if (mask) {
2772                 if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
2773                     len += n;
2774
2775                     if (!set_be16_bf(mask, bits, offset, mask_)) {
2776                         return 0;
2777                     }
2778                 } else {
2779                     *mask |= htons(((1U << bits) - 1) << offset);
2780                 }
2781             }
2782             return len;
2783         }
2784     }
2785     return 0;
2786 }
2787
2788 static int
2789 scan_vid(const char *s, ovs_be16 *key, ovs_be16 *mask)
2790 {
2791     return scan_be16_bf(s, key, mask, 12, VLAN_VID_SHIFT);
2792 }
2793
2794 static int
2795 scan_pcp(const char *s, ovs_be16 *key, ovs_be16 *mask)
2796 {
2797     return scan_be16_bf(s, key, mask, 3, VLAN_PCP_SHIFT);
2798 }
2799
2800 static int
2801 scan_cfi(const char *s, ovs_be16 *key, ovs_be16 *mask)
2802 {
2803     return scan_be16_bf(s, key, mask, 1, VLAN_CFI_SHIFT);
2804 }
2805
2806 /* For MPLS. */
2807 static bool
2808 set_be32_bf(ovs_be32 *bf, uint8_t bits, uint8_t offset, uint32_t value)
2809 {
2810     const uint32_t mask = ((1U << bits) - 1) << offset;
2811
2812     if (value >> bits) {
2813         return false;
2814     }
2815
2816     *bf = htonl((ntohl(*bf) & ~mask) | (value << offset));
2817     return true;
2818 }
2819
2820 static int
2821 scan_be32_bf(const char *s, ovs_be32 *key, ovs_be32 *mask, uint8_t bits,
2822              uint8_t offset)
2823 {
2824     uint32_t key_, mask_;
2825     int n;
2826
2827     if (ovs_scan(s, "%"SCNi32"%n", &key_, &n)) {
2828         int len = n;
2829
2830         if (set_be32_bf(key, bits, offset, key_)) {
2831             if (mask) {
2832                 if (ovs_scan(s + len, "/%"SCNi32"%n", &mask_, &n)) {
2833                     len += n;
2834
2835                     if (!set_be32_bf(mask, bits, offset, mask_)) {
2836                         return 0;
2837                     }
2838                 } else {
2839                     *mask |= htonl(((1U << bits) - 1) << offset);
2840                 }
2841             }
2842             return len;
2843         }
2844     }
2845     return 0;
2846 }
2847
2848 static int
2849 scan_mpls_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
2850 {
2851     return scan_be32_bf(s, key, mask, 20, MPLS_LABEL_SHIFT);
2852 }
2853
2854 static int
2855 scan_mpls_tc(const char *s, ovs_be32 *key, ovs_be32 *mask)
2856 {
2857     return scan_be32_bf(s, key, mask, 3, MPLS_TC_SHIFT);
2858 }
2859
2860 static int
2861 scan_mpls_ttl(const char *s, ovs_be32 *key, ovs_be32 *mask)
2862 {
2863     return scan_be32_bf(s, key, mask, 8, MPLS_TTL_SHIFT);
2864 }
2865
2866 static int
2867 scan_mpls_bos(const char *s, ovs_be32 *key, ovs_be32 *mask)
2868 {
2869     return scan_be32_bf(s, key, mask, 1, MPLS_BOS_SHIFT);
2870 }
2871
2872 static int
2873 scan_vxlan_gbp(const char *s, uint32_t *key, uint32_t *mask)
2874 {
2875     const char *s_base = s;
2876     ovs_be16 id = 0, id_mask = 0;
2877     uint8_t flags = 0, flags_mask = 0;
2878
2879     if (!strncmp(s, "id=", 3)) {
2880         s += 3;
2881         s += scan_be16(s, &id, mask ? &id_mask : NULL);
2882     }
2883
2884     if (s[0] == ',') {
2885         s++;
2886     }
2887     if (!strncmp(s, "flags=", 6)) {
2888         s += 6;
2889         s += scan_u8(s, &flags, mask ? &flags_mask : NULL);
2890     }
2891
2892     if (!strncmp(s, "))", 2)) {
2893         s += 2;
2894
2895         *key = (flags << 16) | ntohs(id);
2896         if (mask) {
2897             *mask = (flags_mask << 16) | ntohs(id_mask);
2898         }
2899
2900         return s - s_base;
2901     }
2902
2903     return 0;
2904 }
2905
2906 struct geneve_scan {
2907     struct geneve_opt d[63];
2908     int len;
2909 };
2910
2911 static int
2912 scan_geneve(const char *s, struct geneve_scan *key, struct geneve_scan *mask)
2913 {
2914     const char *s_base = s;
2915     struct geneve_opt *opt = key->d;
2916     struct geneve_opt *opt_mask = mask ? mask->d : NULL;
2917     int len_remain = sizeof key->d;
2918
2919     while (s[0] == '{' && len_remain >= sizeof *opt) {
2920         int data_len = 0;
2921
2922         s++;
2923         len_remain -= sizeof *opt;
2924
2925         if (!strncmp(s, "class=", 6)) {
2926             s += 6;
2927             s += scan_be16(s, &opt->opt_class,
2928                            mask ? &opt_mask->opt_class : NULL);
2929         } else if (mask) {
2930             memset(&opt_mask->opt_class, 0, sizeof opt_mask->opt_class);
2931         }
2932
2933         if (s[0] == ',') {
2934             s++;
2935         }
2936         if (!strncmp(s, "type=", 5)) {
2937             s += 5;
2938             s += scan_u8(s, &opt->type, mask ? &opt_mask->type : NULL);
2939         } else if (mask) {
2940             memset(&opt_mask->type, 0, sizeof opt_mask->type);
2941         }
2942
2943         if (s[0] == ',') {
2944             s++;
2945         }
2946         if (!strncmp(s, "len=", 4)) {
2947             uint8_t opt_len, opt_len_mask;
2948             s += 4;
2949             s += scan_u8(s, &opt_len, mask ? &opt_len_mask : NULL);
2950
2951             if (opt_len > 124 || opt_len % 4 || opt_len > len_remain) {
2952                 return 0;
2953             }
2954             opt->length = opt_len / 4;
2955             if (mask) {
2956                 opt_mask->length = opt_len_mask;
2957             }
2958             data_len = opt_len;
2959         } else if (mask) {
2960             memset(&opt_mask->type, 0, sizeof opt_mask->type);
2961         }
2962
2963         if (s[0] == ',') {
2964             s++;
2965         }
2966         if (parse_int_string(s, (uint8_t *)(opt + 1), data_len, (char **)&s)) {
2967             return 0;
2968         }
2969
2970         if (mask) {
2971             if (s[0] == '/') {
2972                 s++;
2973                 if (parse_int_string(s, (uint8_t *)(opt_mask + 1),
2974                                      data_len, (char **)&s)) {
2975                     return 0;
2976                 }
2977             }
2978             opt_mask->r1 = 0;
2979             opt_mask->r2 = 0;
2980             opt_mask->r3 = 0;
2981         }
2982
2983         if (s[0] == '}') {
2984             s++;
2985             opt += 1 + data_len / 4;
2986             if (mask) {
2987                 opt_mask += 1 + data_len / 4;
2988             }
2989             len_remain -= data_len;
2990         }
2991     }
2992
2993     if (s[0] == ')') {
2994         int len = sizeof key->d - len_remain;
2995
2996         s++;
2997         key->len = len;
2998         if (mask) {
2999             mask->len = len;
3000         }
3001         return s - s_base;
3002     }
3003
3004     return 0;
3005 }
3006
3007 static void
3008 tun_flags_to_attr(struct ofpbuf *a, const void *data_)
3009 {
3010     const uint16_t *flags = data_;
3011
3012     if (*flags & FLOW_TNL_F_DONT_FRAGMENT) {
3013         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
3014     }
3015     if (*flags & FLOW_TNL_F_CSUM) {
3016         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
3017     }
3018     if (*flags & FLOW_TNL_F_OAM) {
3019         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
3020     }
3021 }
3022
3023 static void
3024 vxlan_gbp_to_attr(struct ofpbuf *a, const void *data_)
3025 {
3026     const uint32_t *gbp = data_;
3027
3028     if (*gbp) {
3029         size_t vxlan_opts_ofs;
3030
3031         vxlan_opts_ofs = nl_msg_start_nested(a, OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS);
3032         nl_msg_put_u32(a, OVS_VXLAN_EXT_GBP, *gbp);
3033         nl_msg_end_nested(a, vxlan_opts_ofs);
3034     }
3035 }
3036
3037 static void
3038 geneve_to_attr(struct ofpbuf *a, const void *data_)
3039 {
3040     const struct geneve_scan *geneve = data_;
3041
3042     nl_msg_put_unspec(a, OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, geneve->d,
3043                       geneve->len);
3044 }
3045
3046 #define SCAN_PUT_ATTR(BUF, ATTR, DATA, FUNC)                      \
3047     {                                                             \
3048         unsigned long call_fn = (unsigned long)FUNC;              \
3049         if (call_fn) {                                            \
3050             typedef void (*fn)(struct ofpbuf *, const void *);    \
3051             fn func = FUNC;                                       \
3052             func(BUF, &(DATA));                                   \
3053         } else {                                                  \
3054             nl_msg_put_unspec(BUF, ATTR, &(DATA), sizeof (DATA)); \
3055         }                                                         \
3056     }
3057
3058 #define SCAN_IF(NAME)                           \
3059     if (strncmp(s, NAME, strlen(NAME)) == 0) {  \
3060         const char *start = s;                  \
3061         int len;                                \
3062                                                 \
3063         s += strlen(NAME)
3064
3065 /* Usually no special initialization is needed. */
3066 #define SCAN_BEGIN(NAME, TYPE)                  \
3067     SCAN_IF(NAME);                              \
3068         TYPE skey, smask;                       \
3069         memset(&skey, 0, sizeof skey);          \
3070         memset(&smask, 0, sizeof smask);        \
3071         do {                                    \
3072             len = 0;
3073
3074 /* Init as fully-masked as mask will not be scanned. */
3075 #define SCAN_BEGIN_FULLY_MASKED(NAME, TYPE)     \
3076     SCAN_IF(NAME);                              \
3077         TYPE skey, smask;                       \
3078         memset(&skey, 0, sizeof skey);          \
3079         memset(&smask, 0xff, sizeof smask);     \
3080         do {                                    \
3081             len = 0;
3082
3083 /* VLAN needs special initialization. */
3084 #define SCAN_BEGIN_INIT(NAME, TYPE, KEY_INIT, MASK_INIT)  \
3085     SCAN_IF(NAME);                                        \
3086         TYPE skey = KEY_INIT;                       \
3087         TYPE smask = MASK_INIT;                     \
3088         do {                                        \
3089             len = 0;
3090
3091 /* Scan unnamed entry as 'TYPE' */
3092 #define SCAN_TYPE(TYPE, KEY, MASK)              \
3093     len = scan_##TYPE(s, KEY, MASK);            \
3094     if (len == 0) {                             \
3095         return -EINVAL;                         \
3096     }                                           \
3097     s += len
3098
3099 /* Scan named ('NAME') entry 'FIELD' as 'TYPE'. */
3100 #define SCAN_FIELD(NAME, TYPE, FIELD)                                   \
3101     if (strncmp(s, NAME, strlen(NAME)) == 0) {                          \
3102         s += strlen(NAME);                                              \
3103         SCAN_TYPE(TYPE, &skey.FIELD, mask ? &smask.FIELD : NULL);       \
3104         continue;                                                       \
3105     }
3106
3107 #define SCAN_FINISH()                           \
3108         } while (*s++ == ',' && len != 0);      \
3109         if (s[-1] != ')') {                     \
3110             return -EINVAL;                     \
3111         }
3112
3113 #define SCAN_FINISH_SINGLE()                    \
3114         } while (false);                        \
3115         if (*s++ != ')') {                      \
3116             return -EINVAL;                     \
3117         }
3118
3119 /* Beginning of nested attribute. */
3120 #define SCAN_BEGIN_NESTED(NAME, ATTR)                      \
3121     SCAN_IF(NAME);                                         \
3122         size_t key_offset, mask_offset;                    \
3123         key_offset = nl_msg_start_nested(key, ATTR);       \
3124         if (mask) {                                        \
3125             mask_offset = nl_msg_start_nested(mask, ATTR); \
3126         }                                                  \
3127         do {                                               \
3128             len = 0;
3129
3130 #define SCAN_END_NESTED()                               \
3131         SCAN_FINISH();                                  \
3132         nl_msg_end_nested(key, key_offset);             \
3133         if (mask) {                                     \
3134             nl_msg_end_nested(mask, mask_offset);       \
3135         }                                               \
3136         return s - start;                               \
3137     }
3138
3139 #define SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, FUNC)  \
3140     if (strncmp(s, NAME, strlen(NAME)) == 0) {                \
3141         TYPE skey, smask;                                     \
3142         memset(&skey, 0, sizeof skey);                        \
3143         memset(&smask, 0xff, sizeof smask);                   \
3144         s += strlen(NAME);                                    \
3145         SCAN_TYPE(SCAN_AS, &skey, &smask);                    \
3146         SCAN_PUT(ATTR, FUNC);                                 \
3147         continue;                                             \
3148     }
3149
3150 #define SCAN_FIELD_NESTED(NAME, TYPE, SCAN_AS, ATTR)  \
3151         SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, NULL)
3152
3153 #define SCAN_FIELD_NESTED_FUNC(NAME, TYPE, SCAN_AS, FUNC)  \
3154         SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, 0, FUNC)
3155
3156 #define SCAN_PUT(ATTR, FUNC)                            \
3157         if (!mask || !is_all_zeros(&smask, sizeof smask)) { \
3158             SCAN_PUT_ATTR(key, ATTR, skey, FUNC);       \
3159             if (mask) {                                 \
3160                 SCAN_PUT_ATTR(mask, ATTR, smask, FUNC); \
3161             }                                           \
3162         }
3163
3164 #define SCAN_END(ATTR)                                  \
3165         SCAN_FINISH();                                  \
3166         SCAN_PUT(ATTR, NULL);                           \
3167         return s - start;                               \
3168     }
3169
3170 #define SCAN_END_SINGLE(ATTR)                           \
3171         SCAN_FINISH_SINGLE();                           \
3172         SCAN_PUT(ATTR, NULL);                           \
3173         return s - start;                               \
3174     }
3175
3176 #define SCAN_SINGLE(NAME, TYPE, SCAN_AS, ATTR)       \
3177     SCAN_BEGIN(NAME, TYPE) {                         \
3178         SCAN_TYPE(SCAN_AS, &skey, &smask);           \
3179     } SCAN_END_SINGLE(ATTR)
3180
3181 #define SCAN_SINGLE_FULLY_MASKED(NAME, TYPE, SCAN_AS, ATTR) \
3182     SCAN_BEGIN_FULLY_MASKED(NAME, TYPE) {                   \
3183         SCAN_TYPE(SCAN_AS, &skey, NULL);                    \
3184     } SCAN_END_SINGLE(ATTR)
3185
3186 /* scan_port needs one extra argument. */
3187 #define SCAN_SINGLE_PORT(NAME, TYPE, ATTR)  \
3188     SCAN_BEGIN(NAME, TYPE) {                            \
3189         len = scan_port(s, &skey, &smask, port_names);  \
3190         if (len == 0) {                                 \
3191             return -EINVAL;                             \
3192         }                                               \
3193         s += len;                                       \
3194     } SCAN_END_SINGLE(ATTR)
3195
3196 static int
3197 parse_odp_key_mask_attr(const char *s, const struct simap *port_names,
3198                         struct ofpbuf *key, struct ofpbuf *mask)
3199 {
3200     ovs_u128 ufid;
3201     int len;
3202
3203     /* Skip UFID. */
3204     len = odp_ufid_from_string(s, &ufid);
3205     if (len) {
3206         return len;
3207     }
3208
3209     SCAN_SINGLE("skb_priority(", uint32_t, u32, OVS_KEY_ATTR_PRIORITY);
3210     SCAN_SINGLE("skb_mark(", uint32_t, u32, OVS_KEY_ATTR_SKB_MARK);
3211     SCAN_SINGLE_FULLY_MASKED("recirc_id(", uint32_t, u32,
3212                              OVS_KEY_ATTR_RECIRC_ID);
3213     SCAN_SINGLE("dp_hash(", uint32_t, u32, OVS_KEY_ATTR_DP_HASH);
3214
3215     SCAN_BEGIN_NESTED("tunnel(", OVS_KEY_ATTR_TUNNEL) {
3216         SCAN_FIELD_NESTED("tun_id=", ovs_be64, be64, OVS_TUNNEL_KEY_ATTR_ID);
3217         SCAN_FIELD_NESTED("src=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_SRC);
3218         SCAN_FIELD_NESTED("dst=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_DST);
3219         SCAN_FIELD_NESTED("tos=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TOS);
3220         SCAN_FIELD_NESTED("ttl=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TTL);
3221         SCAN_FIELD_NESTED("tp_src=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_SRC);
3222         SCAN_FIELD_NESTED("tp_dst=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_DST);
3223         SCAN_FIELD_NESTED_FUNC("vxlan(gbp(", uint32_t, vxlan_gbp, vxlan_gbp_to_attr);
3224         SCAN_FIELD_NESTED_FUNC("geneve(", struct geneve_scan, geneve,
3225                                geneve_to_attr);
3226         SCAN_FIELD_NESTED_FUNC("flags(", uint16_t, tun_flags, tun_flags_to_attr);
3227     } SCAN_END_NESTED();
3228
3229     SCAN_SINGLE_PORT("in_port(", uint32_t, OVS_KEY_ATTR_IN_PORT);
3230
3231     SCAN_BEGIN("eth(", struct ovs_key_ethernet) {
3232         SCAN_FIELD("src=", eth, eth_src);
3233         SCAN_FIELD("dst=", eth, eth_dst);
3234     } SCAN_END(OVS_KEY_ATTR_ETHERNET);
3235
3236     SCAN_BEGIN_INIT("vlan(", struct ovs_key_vlan__,
3237                     { htons(VLAN_CFI) }, { htons(VLAN_CFI) }) {
3238         SCAN_FIELD("vid=", vid, tci);
3239         SCAN_FIELD("pcp=", pcp, tci);
3240         SCAN_FIELD("cfi=", cfi, tci);
3241     } SCAN_END(OVS_KEY_ATTR_VLAN);
3242
3243     SCAN_SINGLE("eth_type(", ovs_be16, be16, OVS_KEY_ATTR_ETHERTYPE);
3244
3245     SCAN_BEGIN("mpls(", struct ovs_key_mpls) {
3246         SCAN_FIELD("label=", mpls_label, mpls_lse);
3247         SCAN_FIELD("tc=", mpls_tc, mpls_lse);
3248         SCAN_FIELD("ttl=", mpls_ttl, mpls_lse);
3249         SCAN_FIELD("bos=", mpls_bos, mpls_lse);
3250     } SCAN_END(OVS_KEY_ATTR_MPLS);
3251
3252     SCAN_BEGIN("ipv4(", struct ovs_key_ipv4) {
3253         SCAN_FIELD("src=", ipv4, ipv4_src);
3254         SCAN_FIELD("dst=", ipv4, ipv4_dst);
3255         SCAN_FIELD("proto=", u8, ipv4_proto);
3256         SCAN_FIELD("tos=", u8, ipv4_tos);
3257         SCAN_FIELD("ttl=", u8, ipv4_ttl);
3258         SCAN_FIELD("frag=", frag, ipv4_frag);
3259     } SCAN_END(OVS_KEY_ATTR_IPV4);
3260
3261     SCAN_BEGIN("ipv6(", struct ovs_key_ipv6) {
3262         SCAN_FIELD("src=", ipv6, ipv6_src);
3263         SCAN_FIELD("dst=", ipv6, ipv6_dst);
3264         SCAN_FIELD("label=", ipv6_label, ipv6_label);
3265         SCAN_FIELD("proto=", u8, ipv6_proto);
3266         SCAN_FIELD("tclass=", u8, ipv6_tclass);
3267         SCAN_FIELD("hlimit=", u8, ipv6_hlimit);
3268         SCAN_FIELD("frag=", frag, ipv6_frag);
3269     } SCAN_END(OVS_KEY_ATTR_IPV6);
3270
3271     SCAN_BEGIN("tcp(", struct ovs_key_tcp) {
3272         SCAN_FIELD("src=", be16, tcp_src);
3273         SCAN_FIELD("dst=", be16, tcp_dst);
3274     } SCAN_END(OVS_KEY_ATTR_TCP);
3275
3276     SCAN_SINGLE("tcp_flags(", ovs_be16, tcp_flags, OVS_KEY_ATTR_TCP_FLAGS);
3277
3278     SCAN_BEGIN("udp(", struct ovs_key_udp) {
3279         SCAN_FIELD("src=", be16, udp_src);
3280         SCAN_FIELD("dst=", be16, udp_dst);
3281     } SCAN_END(OVS_KEY_ATTR_UDP);
3282
3283     SCAN_BEGIN("sctp(", struct ovs_key_sctp) {
3284         SCAN_FIELD("src=", be16, sctp_src);
3285         SCAN_FIELD("dst=", be16, sctp_dst);
3286     } SCAN_END(OVS_KEY_ATTR_SCTP);
3287
3288     SCAN_BEGIN("icmp(", struct ovs_key_icmp) {
3289         SCAN_FIELD("type=", u8, icmp_type);
3290         SCAN_FIELD("code=", u8, icmp_code);
3291     } SCAN_END(OVS_KEY_ATTR_ICMP);
3292
3293     SCAN_BEGIN("icmpv6(", struct ovs_key_icmpv6) {
3294         SCAN_FIELD("type=", u8, icmpv6_type);
3295         SCAN_FIELD("code=", u8, icmpv6_code);
3296     } SCAN_END(OVS_KEY_ATTR_ICMPV6);
3297
3298     SCAN_BEGIN("arp(", struct ovs_key_arp) {
3299         SCAN_FIELD("sip=", ipv4, arp_sip);
3300         SCAN_FIELD("tip=", ipv4, arp_tip);
3301         SCAN_FIELD("op=", be16, arp_op);
3302         SCAN_FIELD("sha=", eth, arp_sha);
3303         SCAN_FIELD("tha=", eth, arp_tha);
3304     } SCAN_END(OVS_KEY_ATTR_ARP);
3305
3306     SCAN_BEGIN("nd(", struct ovs_key_nd) {
3307         SCAN_FIELD("target=", ipv6, nd_target);
3308         SCAN_FIELD("sll=", eth, nd_sll);
3309         SCAN_FIELD("tll=", eth, nd_tll);
3310     } SCAN_END(OVS_KEY_ATTR_ND);
3311
3312     /* Encap open-coded. */
3313     if (!strncmp(s, "encap(", 6)) {
3314         const char *start = s;
3315         size_t encap, encap_mask = 0;
3316
3317         encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
3318         if (mask) {
3319             encap_mask = nl_msg_start_nested(mask, OVS_KEY_ATTR_ENCAP);
3320         }
3321
3322         s += 6;
3323         for (;;) {
3324             int retval;
3325
3326             s += strspn(s, delimiters);
3327             if (!*s) {
3328                 return -EINVAL;
3329             } else if (*s == ')') {
3330                 break;
3331             }
3332
3333             retval = parse_odp_key_mask_attr(s, port_names, key, mask);
3334             if (retval < 0) {
3335                 return retval;
3336             }
3337             s += retval;
3338         }
3339         s++;
3340
3341         nl_msg_end_nested(key, encap);
3342         if (mask) {
3343             nl_msg_end_nested(mask, encap_mask);
3344         }
3345
3346         return s - start;
3347     }
3348
3349     return -EINVAL;
3350 }
3351
3352 /* Parses the string representation of a datapath flow key, in the
3353  * format output by odp_flow_key_format().  Returns 0 if successful,
3354  * otherwise a positive errno value.  On success, the flow key is
3355  * appended to 'key' as a series of Netlink attributes.  On failure, no
3356  * data is appended to 'key'.  Either way, 'key''s data might be
3357  * reallocated.
3358  *
3359  * If 'port_names' is nonnull, it points to an simap that maps from a port name
3360  * to a port number.  (Port names may be used instead of port numbers in
3361  * in_port.)
3362  *
3363  * On success, the attributes appended to 'key' are individually syntactically
3364  * valid, but they may not be valid as a sequence.  'key' might, for example,
3365  * have duplicated keys.  odp_flow_key_to_flow() will detect those errors. */
3366 int
3367 odp_flow_from_string(const char *s, const struct simap *port_names,
3368                      struct ofpbuf *key, struct ofpbuf *mask)
3369 {
3370     const size_t old_size = key->size;
3371     for (;;) {
3372         int retval;
3373
3374         s += strspn(s, delimiters);
3375         if (!*s) {
3376             return 0;
3377         }
3378
3379         retval = parse_odp_key_mask_attr(s, port_names, key, mask);
3380         if (retval < 0) {
3381             key->size = old_size;
3382             return -retval;
3383         }
3384         s += retval;
3385     }
3386
3387     return 0;
3388 }
3389
3390 static uint8_t
3391 ovs_to_odp_frag(uint8_t nw_frag, bool is_mask)
3392 {
3393     if (is_mask) {
3394         /* Netlink interface 'enum ovs_frag_type' is an 8-bit enumeration type,
3395          * not a set of flags or bitfields. Hence, if the struct flow nw_frag
3396          * mask, which is a set of bits, has the FLOW_NW_FRAG_ANY as zero, we
3397          * must use a zero mask for the netlink frag field, and all ones mask
3398          * otherwise. */
3399         return (nw_frag & FLOW_NW_FRAG_ANY) ? UINT8_MAX : 0;
3400     }
3401     return !(nw_frag & FLOW_NW_FRAG_ANY) ? OVS_FRAG_TYPE_NONE
3402         : nw_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
3403         : OVS_FRAG_TYPE_FIRST;
3404 }
3405
3406 static void get_ethernet_key(const struct flow *, struct ovs_key_ethernet *);
3407 static void put_ethernet_key(const struct ovs_key_ethernet *, struct flow *);
3408 static void get_ipv4_key(const struct flow *, struct ovs_key_ipv4 *,
3409                          bool is_mask);
3410 static void put_ipv4_key(const struct ovs_key_ipv4 *, struct flow *,
3411                          bool is_mask);
3412 static void get_ipv6_key(const struct flow *, struct ovs_key_ipv6 *,
3413                          bool is_mask);
3414 static void put_ipv6_key(const struct ovs_key_ipv6 *, struct flow *,
3415                          bool is_mask);
3416 static void get_arp_key(const struct flow *, struct ovs_key_arp *);
3417 static void put_arp_key(const struct ovs_key_arp *, struct flow *);
3418 static void get_nd_key(const struct flow *, struct ovs_key_nd *);
3419 static void put_nd_key(const struct ovs_key_nd *, struct flow *);
3420
3421 /* These share the same layout. */
3422 union ovs_key_tp {
3423     struct ovs_key_tcp tcp;
3424     struct ovs_key_udp udp;
3425     struct ovs_key_sctp sctp;
3426 };
3427
3428 static void get_tp_key(const struct flow *, union ovs_key_tp *);
3429 static void put_tp_key(const union ovs_key_tp *, struct flow *);
3430
3431 static void
3432 odp_flow_key_from_flow__(const struct odp_flow_key_parms *parms,
3433                          bool export_mask, struct ofpbuf *buf)
3434 {
3435     struct ovs_key_ethernet *eth_key;
3436     size_t encap;
3437     const struct flow *flow = parms->flow;
3438     const struct flow *data = export_mask ? parms->mask : parms->flow;
3439
3440     nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, data->skb_priority);
3441
3442     if (flow->tunnel.ip_dst || export_mask) {
3443         tun_key_to_attr(buf, &data->tunnel, &parms->flow->tunnel,
3444                         parms->key_buf);
3445     }
3446
3447     nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, data->pkt_mark);
3448
3449     if (parms->recirc) {
3450         nl_msg_put_u32(buf, OVS_KEY_ATTR_RECIRC_ID, data->recirc_id);
3451         nl_msg_put_u32(buf, OVS_KEY_ATTR_DP_HASH, data->dp_hash);
3452     }
3453
3454     /* Add an ingress port attribute if this is a mask or 'odp_in_port'
3455      * is not the magical value "ODPP_NONE". */
3456     if (export_mask || parms->odp_in_port != ODPP_NONE) {
3457         nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, parms->odp_in_port);
3458     }
3459
3460     eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
3461                                        sizeof *eth_key);
3462     get_ethernet_key(data, eth_key);
3463
3464     if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
3465         if (export_mask) {
3466             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
3467         } else {
3468             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
3469         }
3470         nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, data->vlan_tci);
3471         encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
3472         if (flow->vlan_tci == htons(0)) {
3473             goto unencap;
3474         }
3475     } else {
3476         encap = 0;
3477     }
3478
3479     if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
3480         /* For backwards compatibility with kernels that don't support
3481          * wildcarding, the following convention is used to encode the
3482          * OVS_KEY_ATTR_ETHERTYPE for key and mask:
3483          *
3484          *   key      mask    matches
3485          * -------- --------  -------
3486          *  >0x5ff   0xffff   Specified Ethernet II Ethertype.
3487          *  >0x5ff      0     Any Ethernet II or non-Ethernet II frame.
3488          *  <none>   0xffff   Any non-Ethernet II frame (except valid
3489          *                    802.3 SNAP packet with valid eth_type).
3490          */
3491         if (export_mask) {
3492             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
3493         }
3494         goto unencap;
3495     }
3496
3497     nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, data->dl_type);
3498
3499     if (flow->dl_type == htons(ETH_TYPE_IP)) {
3500         struct ovs_key_ipv4 *ipv4_key;
3501
3502         ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
3503                                             sizeof *ipv4_key);
3504         get_ipv4_key(data, ipv4_key, export_mask);
3505     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
3506         struct ovs_key_ipv6 *ipv6_key;
3507
3508         ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
3509                                             sizeof *ipv6_key);
3510         get_ipv6_key(data, ipv6_key, export_mask);
3511     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
3512                flow->dl_type == htons(ETH_TYPE_RARP)) {
3513         struct ovs_key_arp *arp_key;
3514
3515         arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
3516                                            sizeof *arp_key);
3517         get_arp_key(data, arp_key);
3518     } else if (eth_type_mpls(flow->dl_type)) {
3519         struct ovs_key_mpls *mpls_key;
3520         int i, n;
3521
3522         n = flow_count_mpls_labels(flow, NULL);
3523         if (export_mask) {
3524             n = MIN(n, parms->max_mpls_depth);
3525         }
3526         mpls_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_MPLS,
3527                                             n * sizeof *mpls_key);
3528         for (i = 0; i < n; i++) {
3529             mpls_key[i].mpls_lse = data->mpls_lse[i];
3530         }
3531     }
3532
3533     if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3534         if (flow->nw_proto == IPPROTO_TCP) {
3535             union ovs_key_tp *tcp_key;
3536
3537             tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
3538                                                sizeof *tcp_key);
3539             get_tp_key(data, tcp_key);
3540             if (data->tcp_flags) {
3541                 nl_msg_put_be16(buf, OVS_KEY_ATTR_TCP_FLAGS, data->tcp_flags);
3542             }
3543         } else if (flow->nw_proto == IPPROTO_UDP) {
3544             union ovs_key_tp *udp_key;
3545
3546             udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
3547                                                sizeof *udp_key);
3548             get_tp_key(data, udp_key);
3549         } else if (flow->nw_proto == IPPROTO_SCTP) {
3550             union ovs_key_tp *sctp_key;
3551
3552             sctp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_SCTP,
3553                                                sizeof *sctp_key);
3554             get_tp_key(data, sctp_key);
3555         } else if (flow->dl_type == htons(ETH_TYPE_IP)
3556                 && flow->nw_proto == IPPROTO_ICMP) {
3557             struct ovs_key_icmp *icmp_key;
3558
3559             icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
3560                                                 sizeof *icmp_key);
3561             icmp_key->icmp_type = ntohs(data->tp_src);
3562             icmp_key->icmp_code = ntohs(data->tp_dst);
3563         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
3564                 && flow->nw_proto == IPPROTO_ICMPV6) {
3565             struct ovs_key_icmpv6 *icmpv6_key;
3566
3567             icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
3568                                                   sizeof *icmpv6_key);
3569             icmpv6_key->icmpv6_type = ntohs(data->tp_src);
3570             icmpv6_key->icmpv6_code = ntohs(data->tp_dst);
3571
3572             if (flow->tp_dst == htons(0)
3573                 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
3574                     || flow->tp_src == htons(ND_NEIGHBOR_ADVERT))
3575                 && (!export_mask || (data->tp_src == htons(0xffff)
3576                                      && data->tp_dst == htons(0xffff)))) {
3577
3578                 struct ovs_key_nd *nd_key;
3579
3580                 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
3581                                                     sizeof *nd_key);
3582                 memcpy(nd_key->nd_target, &data->nd_target,
3583                         sizeof nd_key->nd_target);
3584                 memcpy(nd_key->nd_sll, data->arp_sha, ETH_ADDR_LEN);
3585                 memcpy(nd_key->nd_tll, data->arp_tha, ETH_ADDR_LEN);
3586             }
3587         }
3588     }
3589
3590 unencap:
3591     if (encap) {
3592         nl_msg_end_nested(buf, encap);
3593     }
3594 }
3595
3596 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'.
3597  *
3598  * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
3599  * capable of being expanded to allow for that much space. */
3600 void
3601 odp_flow_key_from_flow(const struct odp_flow_key_parms *parms,
3602                        struct ofpbuf *buf)
3603 {
3604     odp_flow_key_from_flow__(parms, false, buf);
3605 }
3606
3607 /* Appends a representation of 'mask' as OVS_KEY_ATTR_* attributes to
3608  * 'buf'.
3609  *
3610  * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
3611  * capable of being expanded to allow for that much space. */
3612 void
3613 odp_flow_key_from_mask(const struct odp_flow_key_parms *parms,
3614                        struct ofpbuf *buf)
3615 {
3616     odp_flow_key_from_flow__(parms, true, buf);
3617 }
3618
3619 /* Generate ODP flow key from the given packet metadata */
3620 void
3621 odp_key_from_pkt_metadata(struct ofpbuf *buf, const struct pkt_metadata *md)
3622 {
3623     nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, md->skb_priority);
3624
3625     if (md->tunnel.ip_dst) {
3626         tun_key_to_attr(buf, &md->tunnel, &md->tunnel, NULL);
3627     }
3628
3629     nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, md->pkt_mark);
3630
3631     /* Add an ingress port attribute if 'odp_in_port' is not the magical
3632      * value "ODPP_NONE". */
3633     if (md->in_port.odp_port != ODPP_NONE) {
3634         nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, md->in_port.odp_port);
3635     }
3636 }
3637
3638 /* Generate packet metadata from the given ODP flow key. */
3639 void
3640 odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len,
3641                         struct pkt_metadata *md)
3642 {
3643     const struct nlattr *nla;
3644     size_t left;
3645     uint32_t wanted_attrs = 1u << OVS_KEY_ATTR_PRIORITY |
3646         1u << OVS_KEY_ATTR_SKB_MARK | 1u << OVS_KEY_ATTR_TUNNEL |
3647         1u << OVS_KEY_ATTR_IN_PORT;
3648
3649     *md = PKT_METADATA_INITIALIZER(ODPP_NONE);
3650
3651     NL_ATTR_FOR_EACH (nla, left, key, key_len) {
3652         uint16_t type = nl_attr_type(nla);
3653         size_t len = nl_attr_get_size(nla);
3654         int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
3655                                             OVS_KEY_ATTR_MAX, type);
3656
3657         if (len != expected_len && expected_len >= 0) {
3658             continue;
3659         }
3660
3661         switch (type) {
3662         case OVS_KEY_ATTR_RECIRC_ID:
3663             md->recirc_id = nl_attr_get_u32(nla);
3664             wanted_attrs &= ~(1u << OVS_KEY_ATTR_RECIRC_ID);
3665             break;
3666         case OVS_KEY_ATTR_DP_HASH:
3667             md->dp_hash = nl_attr_get_u32(nla);
3668             wanted_attrs &= ~(1u << OVS_KEY_ATTR_DP_HASH);
3669             break;
3670         case OVS_KEY_ATTR_PRIORITY:
3671             md->skb_priority = nl_attr_get_u32(nla);
3672             wanted_attrs &= ~(1u << OVS_KEY_ATTR_PRIORITY);
3673             break;
3674         case OVS_KEY_ATTR_SKB_MARK:
3675             md->pkt_mark = nl_attr_get_u32(nla);
3676             wanted_attrs &= ~(1u << OVS_KEY_ATTR_SKB_MARK);
3677             break;
3678         case OVS_KEY_ATTR_TUNNEL: {
3679             enum odp_key_fitness res;
3680
3681             res = odp_tun_key_from_attr(nla, &md->tunnel);
3682             if (res == ODP_FIT_ERROR) {
3683                 memset(&md->tunnel, 0, sizeof md->tunnel);
3684             } else if (res == ODP_FIT_PERFECT) {
3685                 wanted_attrs &= ~(1u << OVS_KEY_ATTR_TUNNEL);
3686             }
3687             break;
3688         }
3689         case OVS_KEY_ATTR_IN_PORT:
3690             md->in_port.odp_port = nl_attr_get_odp_port(nla);
3691             wanted_attrs &= ~(1u << OVS_KEY_ATTR_IN_PORT);
3692             break;
3693         default:
3694             break;
3695         }
3696
3697         if (!wanted_attrs) {
3698             return; /* Have everything. */
3699         }
3700     }
3701 }
3702
3703 uint32_t
3704 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
3705 {
3706     BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
3707     return hash_words(ALIGNED_CAST(const uint32_t *, key),
3708                       key_len / sizeof(uint32_t), 0);
3709 }
3710
3711 static void
3712 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
3713                        uint64_t attrs, int out_of_range_attr,
3714                        const struct nlattr *key, size_t key_len)
3715 {
3716     struct ds s;
3717     int i;
3718
3719     if (VLOG_DROP_DBG(rl)) {
3720         return;
3721     }
3722
3723     ds_init(&s);
3724     for (i = 0; i < 64; i++) {
3725         if (attrs & (UINT64_C(1) << i)) {
3726             char namebuf[OVS_KEY_ATTR_BUFSIZE];
3727
3728             ds_put_format(&s, " %s",
3729                           ovs_key_attr_to_string(i, namebuf, sizeof namebuf));
3730         }
3731     }
3732     if (out_of_range_attr) {
3733         ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
3734     }
3735
3736     ds_put_cstr(&s, ": ");
3737     odp_flow_key_format(key, key_len, &s);
3738
3739     VLOG_DBG("%s:%s", title, ds_cstr(&s));
3740     ds_destroy(&s);
3741 }
3742
3743 static uint8_t
3744 odp_to_ovs_frag(uint8_t odp_frag, bool is_mask)
3745 {
3746     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3747
3748     if (is_mask) {
3749         return odp_frag ? FLOW_NW_FRAG_MASK : 0;
3750     }
3751
3752     if (odp_frag > OVS_FRAG_TYPE_LATER) {
3753         VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
3754         return 0xff; /* Error. */
3755     }
3756
3757     return (odp_frag == OVS_FRAG_TYPE_NONE) ? 0
3758         : (odp_frag == OVS_FRAG_TYPE_FIRST) ? FLOW_NW_FRAG_ANY
3759         :  FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER;
3760 }
3761
3762 static bool
3763 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
3764                    const struct nlattr *attrs[], uint64_t *present_attrsp,
3765                    int *out_of_range_attrp)
3766 {
3767     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3768     const struct nlattr *nla;
3769     uint64_t present_attrs;
3770     size_t left;
3771
3772     BUILD_ASSERT(OVS_KEY_ATTR_MAX < CHAR_BIT * sizeof present_attrs);
3773     present_attrs = 0;
3774     *out_of_range_attrp = 0;
3775     NL_ATTR_FOR_EACH (nla, left, key, key_len) {
3776         uint16_t type = nl_attr_type(nla);
3777         size_t len = nl_attr_get_size(nla);
3778         int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
3779                                             OVS_KEY_ATTR_MAX, type);
3780
3781         if (len != expected_len && expected_len >= 0) {
3782             char namebuf[OVS_KEY_ATTR_BUFSIZE];
3783
3784             VLOG_ERR_RL(&rl, "attribute %s has length %"PRIuSIZE" but should have "
3785                         "length %d", ovs_key_attr_to_string(type, namebuf,
3786                                                             sizeof namebuf),
3787                         len, expected_len);
3788             return false;
3789         }
3790
3791         if (type > OVS_KEY_ATTR_MAX) {
3792             *out_of_range_attrp = type;
3793         } else {
3794             if (present_attrs & (UINT64_C(1) << type)) {
3795                 char namebuf[OVS_KEY_ATTR_BUFSIZE];
3796
3797                 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
3798                             ovs_key_attr_to_string(type,
3799                                                    namebuf, sizeof namebuf));
3800                 return false;
3801             }
3802
3803             present_attrs |= UINT64_C(1) << type;
3804             attrs[type] = nla;
3805         }
3806     }
3807     if (left) {
3808         VLOG_ERR_RL(&rl, "trailing garbage in flow key");
3809         return false;
3810     }
3811
3812     *present_attrsp = present_attrs;
3813     return true;
3814 }
3815
3816 static enum odp_key_fitness
3817 check_expectations(uint64_t present_attrs, int out_of_range_attr,
3818                    uint64_t expected_attrs,
3819                    const struct nlattr *key, size_t key_len)
3820 {
3821     uint64_t missing_attrs;
3822     uint64_t extra_attrs;
3823
3824     missing_attrs = expected_attrs & ~present_attrs;
3825     if (missing_attrs) {
3826         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3827         log_odp_key_attributes(&rl, "expected but not present",
3828                                missing_attrs, 0, key, key_len);
3829         return ODP_FIT_TOO_LITTLE;
3830     }
3831
3832     extra_attrs = present_attrs & ~expected_attrs;
3833     if (extra_attrs || out_of_range_attr) {
3834         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3835         log_odp_key_attributes(&rl, "present but not expected",
3836                                extra_attrs, out_of_range_attr, key, key_len);
3837         return ODP_FIT_TOO_MUCH;
3838     }
3839
3840     return ODP_FIT_PERFECT;
3841 }
3842
3843 static bool
3844 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
3845                 uint64_t present_attrs, uint64_t *expected_attrs,
3846                 struct flow *flow, const struct flow *src_flow)
3847 {
3848     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3849     bool is_mask = flow != src_flow;
3850
3851     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
3852         flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
3853         if (!is_mask && ntohs(flow->dl_type) < ETH_TYPE_MIN) {
3854             VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
3855                         ntohs(flow->dl_type));
3856             return false;
3857         }
3858         if (is_mask && ntohs(src_flow->dl_type) < ETH_TYPE_MIN &&
3859             flow->dl_type != htons(0xffff)) {
3860             return false;
3861         }
3862         *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
3863     } else {
3864         if (!is_mask) {
3865             flow->dl_type = htons(FLOW_DL_TYPE_NONE);
3866         } else if (ntohs(src_flow->dl_type) < ETH_TYPE_MIN) {
3867             /* See comments in odp_flow_key_from_flow__(). */
3868             VLOG_ERR_RL(&rl, "mask expected for non-Ethernet II frame");
3869             return false;
3870         }
3871     }
3872     return true;
3873 }
3874
3875 static enum odp_key_fitness
3876 parse_l2_5_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
3877                   uint64_t present_attrs, int out_of_range_attr,
3878                   uint64_t expected_attrs, struct flow *flow,
3879                   const struct nlattr *key, size_t key_len,
3880                   const struct flow *src_flow)
3881 {
3882     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3883     bool is_mask = src_flow != flow;
3884     const void *check_start = NULL;
3885     size_t check_len = 0;
3886     enum ovs_key_attr expected_bit = 0xff;
3887
3888     if (eth_type_mpls(src_flow->dl_type)) {
3889         if (!is_mask || present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
3890             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
3891         }
3892         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
3893             size_t size = nl_attr_get_size(attrs[OVS_KEY_ATTR_MPLS]);
3894             const ovs_be32 *mpls_lse = nl_attr_get(attrs[OVS_KEY_ATTR_MPLS]);
3895             int n = size / sizeof(ovs_be32);
3896             int i;
3897
3898             if (!size || size % sizeof(ovs_be32)) {
3899                 return ODP_FIT_ERROR;
3900             }
3901             if (flow->mpls_lse[0] && flow->dl_type != htons(0xffff)) {
3902                 return ODP_FIT_ERROR;
3903             }
3904
3905             for (i = 0; i < n && i < FLOW_MAX_MPLS_LABELS; i++) {
3906                 flow->mpls_lse[i] = mpls_lse[i];
3907             }
3908             if (n > FLOW_MAX_MPLS_LABELS) {
3909                 return ODP_FIT_TOO_MUCH;
3910             }
3911
3912             if (!is_mask) {
3913                 /* BOS may be set only in the innermost label. */
3914                 for (i = 0; i < n - 1; i++) {
3915                     if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
3916                         return ODP_FIT_ERROR;
3917                     }
3918                 }
3919
3920                 /* BOS must be set in the innermost label. */
3921                 if (n < FLOW_MAX_MPLS_LABELS
3922                     && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
3923                     return ODP_FIT_TOO_LITTLE;
3924                 }
3925             }
3926         }
3927
3928         goto done;
3929     } else if (src_flow->dl_type == htons(ETH_TYPE_IP)) {
3930         if (!is_mask) {
3931             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
3932         }
3933         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
3934             const struct ovs_key_ipv4 *ipv4_key;
3935
3936             ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
3937             put_ipv4_key(ipv4_key, flow, is_mask);
3938             if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
3939                 return ODP_FIT_ERROR;
3940             }
3941             if (is_mask) {
3942                 check_start = ipv4_key;
3943                 check_len = sizeof *ipv4_key;
3944                 expected_bit = OVS_KEY_ATTR_IPV4;
3945             }
3946         }
3947     } else if (src_flow->dl_type == htons(ETH_TYPE_IPV6)) {
3948         if (!is_mask) {
3949             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
3950         }
3951         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
3952             const struct ovs_key_ipv6 *ipv6_key;
3953
3954             ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
3955             put_ipv6_key(ipv6_key, flow, is_mask);
3956             if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
3957                 return ODP_FIT_ERROR;
3958             }
3959             if (is_mask) {
3960                 check_start = ipv6_key;
3961                 check_len = sizeof *ipv6_key;
3962                 expected_bit = OVS_KEY_ATTR_IPV6;
3963             }
3964         }
3965     } else if (src_flow->dl_type == htons(ETH_TYPE_ARP) ||
3966                src_flow->dl_type == htons(ETH_TYPE_RARP)) {
3967         if (!is_mask) {
3968             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
3969         }
3970         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
3971             const struct ovs_key_arp *arp_key;
3972
3973             arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
3974             if (!is_mask && (arp_key->arp_op & htons(0xff00))) {
3975                 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
3976                             "key", ntohs(arp_key->arp_op));
3977                 return ODP_FIT_ERROR;
3978             }
3979             put_arp_key(arp_key, flow);
3980             if (is_mask) {
3981                 check_start = arp_key;
3982                 check_len = sizeof *arp_key;
3983                 expected_bit = OVS_KEY_ATTR_ARP;
3984             }
3985         }
3986     } else {
3987         goto done;
3988     }
3989     if (check_len > 0) { /* Happens only when 'is_mask'. */
3990         if (!is_all_zeros(check_start, check_len) &&
3991             flow->dl_type != htons(0xffff)) {
3992             return ODP_FIT_ERROR;
3993         } else {
3994             expected_attrs |= UINT64_C(1) << expected_bit;
3995         }
3996     }
3997
3998     expected_bit = OVS_KEY_ATTR_UNSPEC;
3999     if (src_flow->nw_proto == IPPROTO_TCP
4000         && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4001             src_flow->dl_type == htons(ETH_TYPE_IPV6))
4002         && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4003         if (!is_mask) {
4004             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
4005         }
4006         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
4007             const union ovs_key_tp *tcp_key;
4008
4009             tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
4010             put_tp_key(tcp_key, flow);
4011             expected_bit = OVS_KEY_ATTR_TCP;
4012         }
4013         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS)) {
4014             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS;
4015             flow->tcp_flags = nl_attr_get_be16(attrs[OVS_KEY_ATTR_TCP_FLAGS]);
4016         }
4017     } else if (src_flow->nw_proto == IPPROTO_UDP
4018                && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4019                    src_flow->dl_type == htons(ETH_TYPE_IPV6))
4020                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4021         if (!is_mask) {
4022             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
4023         }
4024         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
4025             const union ovs_key_tp *udp_key;
4026
4027             udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
4028             put_tp_key(udp_key, flow);
4029             expected_bit = OVS_KEY_ATTR_UDP;
4030         }
4031     } else if (src_flow->nw_proto == IPPROTO_SCTP
4032                && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4033                    src_flow->dl_type == htons(ETH_TYPE_IPV6))
4034                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4035         if (!is_mask) {
4036             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SCTP;
4037         }
4038         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SCTP)) {
4039             const union ovs_key_tp *sctp_key;
4040
4041             sctp_key = nl_attr_get(attrs[OVS_KEY_ATTR_SCTP]);
4042             put_tp_key(sctp_key, flow);
4043             expected_bit = OVS_KEY_ATTR_SCTP;
4044         }
4045     } else if (src_flow->nw_proto == IPPROTO_ICMP
4046                && src_flow->dl_type == htons(ETH_TYPE_IP)
4047                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4048         if (!is_mask) {
4049             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
4050         }
4051         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
4052             const struct ovs_key_icmp *icmp_key;
4053
4054             icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
4055             flow->tp_src = htons(icmp_key->icmp_type);
4056             flow->tp_dst = htons(icmp_key->icmp_code);
4057             expected_bit = OVS_KEY_ATTR_ICMP;
4058         }
4059     } else if (src_flow->nw_proto == IPPROTO_ICMPV6
4060                && src_flow->dl_type == htons(ETH_TYPE_IPV6)
4061                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4062         if (!is_mask) {
4063             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
4064         }
4065         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
4066             const struct ovs_key_icmpv6 *icmpv6_key;
4067
4068             icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
4069             flow->tp_src = htons(icmpv6_key->icmpv6_type);
4070             flow->tp_dst = htons(icmpv6_key->icmpv6_code);
4071             expected_bit = OVS_KEY_ATTR_ICMPV6;
4072             if (src_flow->tp_dst == htons(0) &&
4073                 (src_flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
4074                  src_flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
4075                 if (!is_mask) {
4076                     expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4077                 }
4078                 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
4079                     const struct ovs_key_nd *nd_key;
4080
4081                     nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
4082                     memcpy(&flow->nd_target, nd_key->nd_target,
4083                            sizeof flow->nd_target);
4084                     memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
4085                     memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
4086                     if (is_mask) {
4087                         if (!is_all_zeros(nd_key, sizeof *nd_key) &&
4088                             (flow->tp_src != htons(0xffff) ||
4089                              flow->tp_dst != htons(0xffff))) {
4090                             return ODP_FIT_ERROR;
4091                         } else {
4092                             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4093                         }
4094                     }
4095                 }
4096             }
4097         }
4098     }
4099     if (is_mask && expected_bit != OVS_KEY_ATTR_UNSPEC) {
4100         if ((flow->tp_src || flow->tp_dst) && flow->nw_proto != 0xff) {
4101             return ODP_FIT_ERROR;
4102         } else {
4103             expected_attrs |= UINT64_C(1) << expected_bit;
4104         }
4105     }
4106
4107 done:
4108     return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
4109                               key, key_len);
4110 }
4111
4112 /* Parse 802.1Q header then encapsulated L3 attributes. */
4113 static enum odp_key_fitness
4114 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4115                    uint64_t present_attrs, int out_of_range_attr,
4116                    uint64_t expected_attrs, struct flow *flow,
4117                    const struct nlattr *key, size_t key_len,
4118                    const struct flow *src_flow)
4119 {
4120     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4121     bool is_mask = src_flow != flow;
4122
4123     const struct nlattr *encap
4124         = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
4125            ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
4126     enum odp_key_fitness encap_fitness;
4127     enum odp_key_fitness fitness;
4128
4129     /* Calculate fitness of outer attributes. */
4130     if (!is_mask) {
4131         expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
4132                           (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
4133     } else {
4134         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
4135             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
4136         }
4137         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)) {
4138             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_ENCAP);
4139         }
4140     }
4141     fitness = check_expectations(present_attrs, out_of_range_attr,
4142                                  expected_attrs, key, key_len);
4143
4144     /* Set vlan_tci.
4145      * Remove the TPID from dl_type since it's not the real Ethertype.  */
4146     flow->dl_type = htons(0);
4147     flow->vlan_tci = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)
4148                       ? nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN])
4149                       : htons(0));
4150     if (!is_mask) {
4151         if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
4152             return ODP_FIT_TOO_LITTLE;
4153         } else if (flow->vlan_tci == htons(0)) {
4154             /* Corner case for a truncated 802.1Q header. */
4155             if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
4156                 return ODP_FIT_TOO_MUCH;
4157             }
4158             return fitness;
4159         } else if (!(flow->vlan_tci & htons(VLAN_CFI))) {
4160             VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
4161                         "but CFI bit is not set", ntohs(flow->vlan_tci));
4162             return ODP_FIT_ERROR;
4163         }
4164     } else {
4165         if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP))) {
4166             return fitness;
4167         }
4168     }
4169
4170     /* Now parse the encapsulated attributes. */
4171     if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
4172                             attrs, &present_attrs, &out_of_range_attr)) {
4173         return ODP_FIT_ERROR;
4174     }
4175     expected_attrs = 0;
4176
4177     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow, src_flow)) {
4178         return ODP_FIT_ERROR;
4179     }
4180     encap_fitness = parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
4181                                       expected_attrs, flow, key, key_len,
4182                                       src_flow);
4183
4184     /* The overall fitness is the worse of the outer and inner attributes. */
4185     return MAX(fitness, encap_fitness);
4186 }
4187
4188 static enum odp_key_fitness
4189 odp_flow_key_to_flow__(const struct nlattr *key, size_t key_len,
4190                        const struct nlattr *src_key, size_t src_key_len,
4191                        struct flow *flow, const struct flow *src_flow)
4192 {
4193     const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
4194     uint64_t expected_attrs;
4195     uint64_t present_attrs;
4196     int out_of_range_attr;
4197     bool is_mask = src_flow != flow;
4198
4199     memset(flow, 0, sizeof *flow);
4200
4201     /* Parse attributes. */
4202     if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
4203                             &out_of_range_attr)) {
4204         return ODP_FIT_ERROR;
4205     }
4206     expected_attrs = 0;
4207
4208     /* Metadata. */
4209     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID)) {
4210         flow->recirc_id = nl_attr_get_u32(attrs[OVS_KEY_ATTR_RECIRC_ID]);
4211         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID;
4212     } else if (is_mask) {
4213         /* Always exact match recirc_id if it is not specified. */
4214         flow->recirc_id = UINT32_MAX;
4215     }
4216
4217     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_DP_HASH)) {
4218         flow->dp_hash = nl_attr_get_u32(attrs[OVS_KEY_ATTR_DP_HASH]);
4219         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_DP_HASH;
4220     }
4221     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
4222         flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
4223         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
4224     }
4225
4226     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK)) {
4227         flow->pkt_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_SKB_MARK]);
4228         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK;
4229     }
4230
4231     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUNNEL)) {
4232         enum odp_key_fitness res;
4233
4234         res = odp_tun_key_from_attr__(attrs[OVS_KEY_ATTR_TUNNEL], src_key,
4235                                       src_key_len, &src_flow->tunnel,
4236                                       &flow->tunnel);
4237         if (res == ODP_FIT_ERROR) {
4238             return ODP_FIT_ERROR;
4239         } else if (res == ODP_FIT_PERFECT) {
4240             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUNNEL;
4241         }
4242     }
4243
4244     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
4245         flow->in_port.odp_port
4246             = nl_attr_get_odp_port(attrs[OVS_KEY_ATTR_IN_PORT]);
4247         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
4248     } else if (!is_mask) {
4249         flow->in_port.odp_port = ODPP_NONE;
4250     }
4251
4252     /* Ethernet header. */
4253     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
4254         const struct ovs_key_ethernet *eth_key;
4255
4256         eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
4257         put_ethernet_key(eth_key, flow);
4258         if (is_mask) {
4259             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
4260         }
4261     }
4262     if (!is_mask) {
4263         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
4264     }
4265
4266     /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
4267     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow,
4268         src_flow)) {
4269         return ODP_FIT_ERROR;
4270     }
4271
4272     if (is_mask
4273         ? (src_flow->vlan_tci & htons(VLAN_CFI)) != 0
4274         : src_flow->dl_type == htons(ETH_TYPE_VLAN)) {
4275         return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
4276                                   expected_attrs, flow, key, key_len, src_flow);
4277     }
4278     if (is_mask) {
4279         flow->vlan_tci = htons(0xffff);
4280         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
4281             flow->vlan_tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
4282             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
4283         }
4284     }
4285     return parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
4286                              expected_attrs, flow, key, key_len, src_flow);
4287 }
4288
4289 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
4290  * structure in 'flow'.  Returns an ODP_FIT_* value that indicates how well
4291  * 'key' fits our expectations for what a flow key should contain.
4292  *
4293  * The 'in_port' will be the datapath's understanding of the port.  The
4294  * caller will need to translate with odp_port_to_ofp_port() if the
4295  * OpenFlow port is needed.
4296  *
4297  * This function doesn't take the packet itself as an argument because none of
4298  * the currently understood OVS_KEY_ATTR_* attributes require it.  Currently,
4299  * it is always possible to infer which additional attribute(s) should appear
4300  * by looking at the attributes for lower-level protocols, e.g. if the network
4301  * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
4302  * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
4303  * must be absent. */
4304 enum odp_key_fitness
4305 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
4306                      struct flow *flow)
4307 {
4308    return odp_flow_key_to_flow__(key, key_len, NULL, 0, flow, flow);
4309 }
4310
4311 /* Converts the 'mask_key_len' bytes of OVS_KEY_ATTR_* attributes in 'mask_key'
4312  * to a mask structure in 'mask'.  'flow' must be a previously translated flow
4313  * corresponding to 'mask' and similarly flow_key/flow_key_len must be the
4314  * attributes from that flow.  Returns an ODP_FIT_* value that indicates how
4315  * well 'key' fits our expectations for what a flow key should contain. */
4316 enum odp_key_fitness
4317 odp_flow_key_to_mask(const struct nlattr *mask_key, size_t mask_key_len,
4318                      const struct nlattr *flow_key, size_t flow_key_len,
4319                      struct flow *mask, const struct flow *flow)
4320 {
4321    return odp_flow_key_to_flow__(mask_key, mask_key_len, flow_key, flow_key_len,
4322                                  mask, flow);
4323 }
4324
4325 /* Returns 'fitness' as a string, for use in debug messages. */
4326 const char *
4327 odp_key_fitness_to_string(enum odp_key_fitness fitness)
4328 {
4329     switch (fitness) {
4330     case ODP_FIT_PERFECT:
4331         return "OK";
4332     case ODP_FIT_TOO_MUCH:
4333         return "too_much";
4334     case ODP_FIT_TOO_LITTLE:
4335         return "too_little";
4336     case ODP_FIT_ERROR:
4337         return "error";
4338     default:
4339         return "<unknown>";
4340     }
4341 }
4342
4343 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
4344  * Netlink PID 'pid'.  If 'userdata' is nonnull, adds a userdata attribute
4345  * whose contents are the 'userdata_size' bytes at 'userdata' and returns the
4346  * offset within 'odp_actions' of the start of the cookie.  (If 'userdata' is
4347  * null, then the return value is not meaningful.) */
4348 size_t
4349 odp_put_userspace_action(uint32_t pid,
4350                          const void *userdata, size_t userdata_size,
4351                          odp_port_t tunnel_out_port,
4352                          struct ofpbuf *odp_actions)
4353 {
4354     size_t userdata_ofs;
4355     size_t offset;
4356
4357     offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
4358     nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
4359     if (userdata) {
4360         userdata_ofs = odp_actions->size + NLA_HDRLEN;
4361
4362         /* The OVS kernel module before OVS 1.11 and the upstream Linux kernel
4363          * module before Linux 3.10 required the userdata to be exactly 8 bytes
4364          * long:
4365          *
4366          *   - The kernel rejected shorter userdata with -ERANGE.
4367          *
4368          *   - The kernel silently dropped userdata beyond the first 8 bytes.
4369          *
4370          * Thus, for maximum compatibility, always put at least 8 bytes.  (We
4371          * separately disable features that required more than 8 bytes.) */
4372         memcpy(nl_msg_put_unspec_zero(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
4373                                       MAX(8, userdata_size)),
4374                userdata, userdata_size);
4375     } else {
4376         userdata_ofs = 0;
4377     }
4378     if (tunnel_out_port != ODPP_NONE) {
4379         nl_msg_put_odp_port(odp_actions, OVS_USERSPACE_ATTR_EGRESS_TUN_PORT,
4380                             tunnel_out_port);
4381     }
4382     nl_msg_end_nested(odp_actions, offset);
4383
4384     return userdata_ofs;
4385 }
4386
4387 void
4388 odp_put_tunnel_action(const struct flow_tnl *tunnel,
4389                       struct ofpbuf *odp_actions)
4390 {
4391     size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
4392     tun_key_to_attr(odp_actions, tunnel, tunnel, NULL);
4393     nl_msg_end_nested(odp_actions, offset);
4394 }
4395
4396 void
4397 odp_put_tnl_push_action(struct ofpbuf *odp_actions,
4398                         struct ovs_action_push_tnl *data)
4399 {
4400     int size = offsetof(struct ovs_action_push_tnl, header);
4401
4402     size += data->header_len;
4403     nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_TUNNEL_PUSH, data, size);
4404 }
4405
4406 \f
4407 /* The commit_odp_actions() function and its helpers. */
4408
4409 static void
4410 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
4411                   const void *key, size_t key_size)
4412 {
4413     size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
4414     nl_msg_put_unspec(odp_actions, key_type, key, key_size);
4415     nl_msg_end_nested(odp_actions, offset);
4416 }
4417
4418 /* Masked set actions have a mask following the data within the netlink
4419  * attribute.  The unmasked bits in the data will be cleared as the data
4420  * is copied to the action. */
4421 void
4422 commit_masked_set_action(struct ofpbuf *odp_actions,
4423                          enum ovs_key_attr key_type,
4424                          const void *key_, const void *mask_, size_t key_size)
4425 {
4426     size_t offset = nl_msg_start_nested(odp_actions,
4427                                         OVS_ACTION_ATTR_SET_MASKED);
4428     char *data = nl_msg_put_unspec_uninit(odp_actions, key_type, key_size * 2);
4429     const char *key = key_, *mask = mask_;
4430
4431     memcpy(data + key_size, mask, key_size);
4432     /* Clear unmasked bits while copying. */
4433     while (key_size--) {
4434         *data++ = *key++ & *mask++;
4435     }
4436     nl_msg_end_nested(odp_actions, offset);
4437 }
4438
4439 /* If any of the flow key data that ODP actions can modify are different in
4440  * 'base->tunnel' and 'flow->tunnel', appends a set_tunnel ODP action to
4441  * 'odp_actions' that change the flow tunneling information in key from
4442  * 'base->tunnel' into 'flow->tunnel', and then changes 'base->tunnel' in the
4443  * same way.  In other words, operates the same as commit_odp_actions(), but
4444  * only on tunneling information. */
4445 void
4446 commit_odp_tunnel_action(const struct flow *flow, struct flow *base,
4447                          struct ofpbuf *odp_actions)
4448 {
4449     /* A valid IPV4_TUNNEL must have non-zero ip_dst. */
4450     if (flow->tunnel.ip_dst) {
4451         if (!memcmp(&base->tunnel, &flow->tunnel, sizeof base->tunnel)) {
4452             return;
4453         }
4454         memcpy(&base->tunnel, &flow->tunnel, sizeof base->tunnel);
4455         odp_put_tunnel_action(&base->tunnel, odp_actions);
4456     }
4457 }
4458
4459 static bool
4460 commit(enum ovs_key_attr attr, bool use_masked_set,
4461        const void *key, void *base, void *mask, size_t size,
4462        struct ofpbuf *odp_actions)
4463 {
4464     if (memcmp(key, base, size)) {
4465         bool fully_masked = odp_mask_is_exact(attr, mask, size);
4466
4467         if (use_masked_set && !fully_masked) {
4468             commit_masked_set_action(odp_actions, attr, key, mask, size);
4469         } else {
4470             if (!fully_masked) {
4471                 memset(mask, 0xff, size);
4472             }
4473             commit_set_action(odp_actions, attr, key, size);
4474         }
4475         memcpy(base, key, size);
4476         return true;
4477     } else {
4478         /* Mask bits are set when we have either read or set the corresponding
4479          * values.  Masked bits will be exact-matched, no need to set them
4480          * if the value did not actually change. */
4481         return false;
4482     }
4483 }
4484
4485 static void
4486 get_ethernet_key(const struct flow *flow, struct ovs_key_ethernet *eth)
4487 {
4488     memcpy(eth->eth_src, flow->dl_src, ETH_ADDR_LEN);
4489     memcpy(eth->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
4490 }
4491
4492 static void
4493 put_ethernet_key(const struct ovs_key_ethernet *eth, struct flow *flow)
4494 {
4495     memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
4496     memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
4497 }
4498
4499 static void
4500 commit_set_ether_addr_action(const struct flow *flow, struct flow *base_flow,
4501                              struct ofpbuf *odp_actions,
4502                              struct flow_wildcards *wc,
4503                              bool use_masked)
4504 {
4505     struct ovs_key_ethernet key, base, mask;
4506
4507     get_ethernet_key(flow, &key);
4508     get_ethernet_key(base_flow, &base);
4509     get_ethernet_key(&wc->masks, &mask);
4510
4511     if (commit(OVS_KEY_ATTR_ETHERNET, use_masked,
4512                &key, &base, &mask, sizeof key, odp_actions)) {
4513         put_ethernet_key(&base, base_flow);
4514         put_ethernet_key(&mask, &wc->masks);
4515     }
4516 }
4517
4518 static void
4519 pop_vlan(struct flow *base,
4520          struct ofpbuf *odp_actions, struct flow_wildcards *wc)
4521 {
4522     memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
4523
4524     if (base->vlan_tci & htons(VLAN_CFI)) {
4525         nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
4526         base->vlan_tci = 0;
4527     }
4528 }
4529
4530 static void
4531 commit_vlan_action(ovs_be16 vlan_tci, struct flow *base,
4532                    struct ofpbuf *odp_actions, struct flow_wildcards *wc)
4533 {
4534     if (base->vlan_tci == vlan_tci) {
4535         return;
4536     }
4537
4538     pop_vlan(base, odp_actions, wc);
4539     if (vlan_tci & htons(VLAN_CFI)) {
4540         struct ovs_action_push_vlan vlan;
4541
4542         vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
4543         vlan.vlan_tci = vlan_tci;
4544         nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
4545                           &vlan, sizeof vlan);
4546     }
4547     base->vlan_tci = vlan_tci;
4548 }
4549
4550 /* Wildcarding already done at action translation time. */
4551 static void
4552 commit_mpls_action(const struct flow *flow, struct flow *base,
4553                    struct ofpbuf *odp_actions)
4554 {
4555     int base_n = flow_count_mpls_labels(base, NULL);
4556     int flow_n = flow_count_mpls_labels(flow, NULL);
4557     int common_n = flow_count_common_mpls_labels(flow, flow_n, base, base_n,
4558                                                  NULL);
4559
4560     while (base_n > common_n) {
4561         if (base_n - 1 == common_n && flow_n > common_n) {
4562             /* If there is only one more LSE in base than there are common
4563              * between base and flow; and flow has at least one more LSE than
4564              * is common then the topmost LSE of base may be updated using
4565              * set */
4566             struct ovs_key_mpls mpls_key;
4567
4568             mpls_key.mpls_lse = flow->mpls_lse[flow_n - base_n];
4569             commit_set_action(odp_actions, OVS_KEY_ATTR_MPLS,
4570                               &mpls_key, sizeof mpls_key);
4571             flow_set_mpls_lse(base, 0, mpls_key.mpls_lse);
4572             common_n++;
4573         } else {
4574             /* Otherwise, if there more LSEs in base than are common between
4575              * base and flow then pop the topmost one. */
4576             ovs_be16 dl_type;
4577             bool popped;
4578
4579             /* If all the LSEs are to be popped and this is not the outermost
4580              * LSE then use ETH_TYPE_MPLS as the ethertype parameter of the
4581              * POP_MPLS action instead of flow->dl_type.
4582              *
4583              * This is because the POP_MPLS action requires its ethertype
4584              * argument to be an MPLS ethernet type but in this case
4585              * flow->dl_type will be a non-MPLS ethernet type.
4586              *
4587              * When the final POP_MPLS action occurs it use flow->dl_type and
4588              * the and the resulting packet will have the desired dl_type. */
4589             if ((!eth_type_mpls(flow->dl_type)) && base_n > 1) {
4590                 dl_type = htons(ETH_TYPE_MPLS);
4591             } else {
4592                 dl_type = flow->dl_type;
4593             }
4594             nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_POP_MPLS, dl_type);
4595             popped = flow_pop_mpls(base, base_n, flow->dl_type, NULL);
4596             ovs_assert(popped);
4597             base_n--;
4598         }
4599     }
4600
4601     /* If, after the above popping and setting, there are more LSEs in flow
4602      * than base then some LSEs need to be pushed. */
4603     while (base_n < flow_n) {
4604         struct ovs_action_push_mpls *mpls;
4605
4606         mpls = nl_msg_put_unspec_zero(odp_actions,
4607                                       OVS_ACTION_ATTR_PUSH_MPLS,
4608                                       sizeof *mpls);
4609         mpls->mpls_ethertype = flow->dl_type;
4610         mpls->mpls_lse = flow->mpls_lse[flow_n - base_n - 1];
4611         flow_push_mpls(base, base_n, mpls->mpls_ethertype, NULL);
4612         flow_set_mpls_lse(base, 0, mpls->mpls_lse);
4613         base_n++;
4614     }
4615 }
4616
4617 static void
4618 get_ipv4_key(const struct flow *flow, struct ovs_key_ipv4 *ipv4, bool is_mask)
4619 {
4620     ipv4->ipv4_src = flow->nw_src;
4621     ipv4->ipv4_dst = flow->nw_dst;
4622     ipv4->ipv4_proto = flow->nw_proto;
4623     ipv4->ipv4_tos = flow->nw_tos;
4624     ipv4->ipv4_ttl = flow->nw_ttl;
4625     ipv4->ipv4_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
4626 }
4627
4628 static void
4629 put_ipv4_key(const struct ovs_key_ipv4 *ipv4, struct flow *flow, bool is_mask)
4630 {
4631     flow->nw_src = ipv4->ipv4_src;
4632     flow->nw_dst = ipv4->ipv4_dst;
4633     flow->nw_proto = ipv4->ipv4_proto;
4634     flow->nw_tos = ipv4->ipv4_tos;
4635     flow->nw_ttl = ipv4->ipv4_ttl;
4636     flow->nw_frag = odp_to_ovs_frag(ipv4->ipv4_frag, is_mask);
4637 }
4638
4639 static void
4640 commit_set_ipv4_action(const struct flow *flow, struct flow *base_flow,
4641                        struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4642                        bool use_masked)
4643 {
4644     struct ovs_key_ipv4 key, mask, base;
4645
4646     /* Check that nw_proto and nw_frag remain unchanged. */
4647     ovs_assert(flow->nw_proto == base_flow->nw_proto &&
4648                flow->nw_frag == base_flow->nw_frag);
4649
4650     get_ipv4_key(flow, &key, false);
4651     get_ipv4_key(base_flow, &base, false);
4652     get_ipv4_key(&wc->masks, &mask, true);
4653     mask.ipv4_proto = 0;        /* Not writeable. */
4654     mask.ipv4_frag = 0;         /* Not writable. */
4655
4656     if (commit(OVS_KEY_ATTR_IPV4, use_masked, &key, &base, &mask, sizeof key,
4657                odp_actions)) {
4658         put_ipv4_key(&base, base_flow, false);
4659         if (mask.ipv4_proto != 0) { /* Mask was changed by commit(). */
4660             put_ipv4_key(&mask, &wc->masks, true);
4661         }
4662    }
4663 }
4664
4665 static void
4666 get_ipv6_key(const struct flow *flow, struct ovs_key_ipv6 *ipv6, bool is_mask)
4667 {
4668     memcpy(ipv6->ipv6_src, &flow->ipv6_src, sizeof ipv6->ipv6_src);
4669     memcpy(ipv6->ipv6_dst, &flow->ipv6_dst, sizeof ipv6->ipv6_dst);
4670     ipv6->ipv6_label = flow->ipv6_label;
4671     ipv6->ipv6_proto = flow->nw_proto;
4672     ipv6->ipv6_tclass = flow->nw_tos;
4673     ipv6->ipv6_hlimit = flow->nw_ttl;
4674     ipv6->ipv6_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
4675 }
4676
4677 static void
4678 put_ipv6_key(const struct ovs_key_ipv6 *ipv6, struct flow *flow, bool is_mask)
4679 {
4680     memcpy(&flow->ipv6_src, ipv6->ipv6_src, sizeof flow->ipv6_src);
4681     memcpy(&flow->ipv6_dst, ipv6->ipv6_dst, sizeof flow->ipv6_dst);
4682     flow->ipv6_label = ipv6->ipv6_label;
4683     flow->nw_proto = ipv6->ipv6_proto;
4684     flow->nw_tos = ipv6->ipv6_tclass;
4685     flow->nw_ttl = ipv6->ipv6_hlimit;
4686     flow->nw_frag = odp_to_ovs_frag(ipv6->ipv6_frag, is_mask);
4687 }
4688
4689 static void
4690 commit_set_ipv6_action(const struct flow *flow, struct flow *base_flow,
4691                        struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4692                        bool use_masked)
4693 {
4694     struct ovs_key_ipv6 key, mask, base;
4695
4696     /* Check that nw_proto and nw_frag remain unchanged. */
4697     ovs_assert(flow->nw_proto == base_flow->nw_proto &&
4698                flow->nw_frag == base_flow->nw_frag);
4699
4700     get_ipv6_key(flow, &key, false);
4701     get_ipv6_key(base_flow, &base, false);
4702     get_ipv6_key(&wc->masks, &mask, true);
4703     mask.ipv6_proto = 0;        /* Not writeable. */
4704     mask.ipv6_frag = 0;         /* Not writable. */
4705
4706     if (commit(OVS_KEY_ATTR_IPV6, use_masked, &key, &base, &mask, sizeof key,
4707                odp_actions)) {
4708         put_ipv6_key(&base, base_flow, false);
4709         if (mask.ipv6_proto != 0) { /* Mask was changed by commit(). */
4710             put_ipv6_key(&mask, &wc->masks, true);
4711         }
4712     }
4713 }
4714
4715 static void
4716 get_arp_key(const struct flow *flow, struct ovs_key_arp *arp)
4717 {
4718     /* ARP key has padding, clear it. */
4719     memset(arp, 0, sizeof *arp);
4720
4721     arp->arp_sip = flow->nw_src;
4722     arp->arp_tip = flow->nw_dst;
4723     arp->arp_op = htons(flow->nw_proto);
4724     memcpy(arp->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
4725     memcpy(arp->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
4726 }
4727
4728 static void
4729 put_arp_key(const struct ovs_key_arp *arp, struct flow *flow)
4730 {
4731     flow->nw_src = arp->arp_sip;
4732     flow->nw_dst = arp->arp_tip;
4733     flow->nw_proto = ntohs(arp->arp_op);
4734     memcpy(flow->arp_sha, arp->arp_sha, ETH_ADDR_LEN);
4735     memcpy(flow->arp_tha, arp->arp_tha, ETH_ADDR_LEN);
4736 }
4737
4738 static enum slow_path_reason
4739 commit_set_arp_action(const struct flow *flow, struct flow *base_flow,
4740                       struct ofpbuf *odp_actions, struct flow_wildcards *wc)
4741 {
4742     struct ovs_key_arp key, mask, base;
4743
4744     get_arp_key(flow, &key);
4745     get_arp_key(base_flow, &base);
4746     get_arp_key(&wc->masks, &mask);
4747
4748     if (commit(OVS_KEY_ATTR_ARP, true, &key, &base, &mask, sizeof key,
4749                odp_actions)) {
4750         put_arp_key(&base, base_flow);
4751         put_arp_key(&mask, &wc->masks);
4752         return SLOW_ACTION;
4753     }
4754     return 0;
4755 }
4756
4757 static void
4758 get_nd_key(const struct flow *flow, struct ovs_key_nd *nd)
4759 {
4760     memcpy(nd->nd_target, &flow->nd_target, sizeof flow->nd_target);
4761     /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
4762     memcpy(nd->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
4763     memcpy(nd->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
4764 }
4765
4766 static void
4767 put_nd_key(const struct ovs_key_nd *nd, struct flow *flow)
4768 {
4769     memcpy(&flow->nd_target, &flow->nd_target, sizeof flow->nd_target);
4770     /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
4771     memcpy(flow->arp_sha, nd->nd_sll, ETH_ADDR_LEN);
4772     memcpy(flow->arp_tha, nd->nd_tll, ETH_ADDR_LEN);
4773 }
4774
4775 static enum slow_path_reason
4776 commit_set_nd_action(const struct flow *flow, struct flow *base_flow,
4777                      struct ofpbuf *odp_actions,
4778                      struct flow_wildcards *wc, bool use_masked)
4779 {
4780     struct ovs_key_nd key, mask, base;
4781
4782     get_nd_key(flow, &key);
4783     get_nd_key(base_flow, &base);
4784     get_nd_key(&wc->masks, &mask);
4785
4786     if (commit(OVS_KEY_ATTR_ND, use_masked, &key, &base, &mask, sizeof key,
4787                odp_actions)) {
4788         put_nd_key(&base, base_flow);
4789         put_nd_key(&mask, &wc->masks);
4790         return SLOW_ACTION;
4791     }
4792
4793     return 0;
4794 }
4795
4796 static enum slow_path_reason
4797 commit_set_nw_action(const struct flow *flow, struct flow *base,
4798                      struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4799                      bool use_masked)
4800 {
4801     /* Check if 'flow' really has an L3 header. */
4802     if (!flow->nw_proto) {
4803         return 0;
4804     }
4805
4806     switch (ntohs(base->dl_type)) {
4807     case ETH_TYPE_IP:
4808         commit_set_ipv4_action(flow, base, odp_actions, wc, use_masked);
4809         break;
4810
4811     case ETH_TYPE_IPV6:
4812         commit_set_ipv6_action(flow, base, odp_actions, wc, use_masked);
4813         return commit_set_nd_action(flow, base, odp_actions, wc, use_masked);
4814
4815     case ETH_TYPE_ARP:
4816         return commit_set_arp_action(flow, base, odp_actions, wc);
4817     }
4818
4819     return 0;
4820 }
4821
4822 /* TCP, UDP, and SCTP keys have the same layout. */
4823 BUILD_ASSERT_DECL(sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_udp) &&
4824                   sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_sctp));
4825
4826 static void
4827 get_tp_key(const struct flow *flow, union ovs_key_tp *tp)
4828 {
4829     tp->tcp.tcp_src = flow->tp_src;
4830     tp->tcp.tcp_dst = flow->tp_dst;
4831 }
4832
4833 static void
4834 put_tp_key(const union ovs_key_tp *tp, struct flow *flow)
4835 {
4836     flow->tp_src = tp->tcp.tcp_src;
4837     flow->tp_dst = tp->tcp.tcp_dst;
4838 }
4839
4840 static void
4841 commit_set_port_action(const struct flow *flow, struct flow *base_flow,
4842                        struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4843                        bool use_masked)
4844 {
4845     enum ovs_key_attr key_type;
4846     union ovs_key_tp key, mask, base;
4847
4848     /* Check if 'flow' really has an L3 header. */
4849     if (!flow->nw_proto) {
4850         return;
4851     }
4852
4853     if (!is_ip_any(base_flow)) {
4854         return;
4855     }
4856
4857     if (flow->nw_proto == IPPROTO_TCP) {
4858         key_type = OVS_KEY_ATTR_TCP;
4859     } else if (flow->nw_proto == IPPROTO_UDP) {
4860         key_type = OVS_KEY_ATTR_UDP;
4861     } else if (flow->nw_proto == IPPROTO_SCTP) {
4862         key_type = OVS_KEY_ATTR_SCTP;
4863     } else {
4864         return;
4865     }
4866
4867     get_tp_key(flow, &key);
4868     get_tp_key(base_flow, &base);
4869     get_tp_key(&wc->masks, &mask);
4870
4871     if (commit(key_type, use_masked, &key, &base, &mask, sizeof key,
4872                odp_actions)) {
4873         put_tp_key(&base, base_flow);
4874         put_tp_key(&mask, &wc->masks);
4875     }
4876 }
4877
4878 static void
4879 commit_set_priority_action(const struct flow *flow, struct flow *base_flow,
4880                            struct ofpbuf *odp_actions,
4881                            struct flow_wildcards *wc,
4882                            bool use_masked)
4883 {
4884     uint32_t key, mask, base;
4885
4886     key = flow->skb_priority;
4887     base = base_flow->skb_priority;
4888     mask = wc->masks.skb_priority;
4889
4890     if (commit(OVS_KEY_ATTR_PRIORITY, use_masked, &key, &base, &mask,
4891                sizeof key, odp_actions)) {
4892         base_flow->skb_priority = base;
4893         wc->masks.skb_priority = mask;
4894     }
4895 }
4896
4897 static void
4898 commit_set_pkt_mark_action(const struct flow *flow, struct flow *base_flow,
4899                            struct ofpbuf *odp_actions,
4900                            struct flow_wildcards *wc,
4901                            bool use_masked)
4902 {
4903     uint32_t key, mask, base;
4904
4905     key = flow->pkt_mark;
4906     base = base_flow->pkt_mark;
4907     mask = wc->masks.pkt_mark;
4908
4909     if (commit(OVS_KEY_ATTR_SKB_MARK, use_masked, &key, &base, &mask,
4910                sizeof key, odp_actions)) {
4911         base_flow->pkt_mark = base;
4912         wc->masks.pkt_mark = mask;
4913     }
4914 }
4915
4916 /* If any of the flow key data that ODP actions can modify are different in
4917  * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
4918  * key from 'base' into 'flow', and then changes 'base' the same way.  Does not
4919  * commit set_tunnel actions.  Users should call commit_odp_tunnel_action()
4920  * in addition to this function if needed.  Sets fields in 'wc' that are
4921  * used as part of the action.
4922  *
4923  * Returns a reason to force processing the flow's packets into the userspace
4924  * slow path, if there is one, otherwise 0. */
4925 enum slow_path_reason
4926 commit_odp_actions(const struct flow *flow, struct flow *base,
4927                    struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4928                    bool use_masked)
4929 {
4930     enum slow_path_reason slow;
4931
4932     commit_set_ether_addr_action(flow, base, odp_actions, wc, use_masked);
4933     slow = commit_set_nw_action(flow, base, odp_actions, wc, use_masked);
4934     commit_set_port_action(flow, base, odp_actions, wc, use_masked);
4935     commit_mpls_action(flow, base, odp_actions);
4936     commit_vlan_action(flow->vlan_tci, base, odp_actions, wc);
4937     commit_set_priority_action(flow, base, odp_actions, wc, use_masked);
4938     commit_set_pkt_mark_action(flow, base, odp_actions, wc, use_masked);
4939
4940     return slow;
4941 }