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 enum odp_key_fitness
1354 odp_tun_key_from_attr(const struct nlattr *attr, struct flow_tnl *tun)
1355 {
1356     unsigned int left;
1357     const struct nlattr *a;
1358     bool ttl = false;
1359     bool unknown = false;
1360
1361     NL_NESTED_FOR_EACH(a, left, attr) {
1362         uint16_t type = nl_attr_type(a);
1363         size_t len = nl_attr_get_size(a);
1364         int expected_len = odp_key_attr_len(ovs_tun_key_attr_lens,
1365                                             OVS_TUNNEL_ATTR_MAX, type);
1366
1367         if (len != expected_len && expected_len >= 0) {
1368             return ODP_FIT_ERROR;
1369         }
1370
1371         switch (type) {
1372         case OVS_TUNNEL_KEY_ATTR_ID:
1373             tun->tun_id = nl_attr_get_be64(a);
1374             tun->flags |= FLOW_TNL_F_KEY;
1375             break;
1376         case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
1377             tun->ip_src = nl_attr_get_be32(a);
1378             break;
1379         case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
1380             tun->ip_dst = nl_attr_get_be32(a);
1381             break;
1382         case OVS_TUNNEL_KEY_ATTR_TOS:
1383             tun->ip_tos = nl_attr_get_u8(a);
1384             break;
1385         case OVS_TUNNEL_KEY_ATTR_TTL:
1386             tun->ip_ttl = nl_attr_get_u8(a);
1387             ttl = true;
1388             break;
1389         case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
1390             tun->flags |= FLOW_TNL_F_DONT_FRAGMENT;
1391             break;
1392         case OVS_TUNNEL_KEY_ATTR_CSUM:
1393             tun->flags |= FLOW_TNL_F_CSUM;
1394             break;
1395         case OVS_TUNNEL_KEY_ATTR_TP_SRC:
1396             tun->tp_src = nl_attr_get_be16(a);
1397             break;
1398         case OVS_TUNNEL_KEY_ATTR_TP_DST:
1399             tun->tp_dst = nl_attr_get_be16(a);
1400             break;
1401         case OVS_TUNNEL_KEY_ATTR_OAM:
1402             tun->flags |= FLOW_TNL_F_OAM;
1403             break;
1404         case OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS: {
1405             static const struct nl_policy vxlan_opts_policy[] = {
1406                 [OVS_VXLAN_EXT_GBP] = { .type = NL_A_U32 },
1407             };
1408             struct nlattr *ext[ARRAY_SIZE(vxlan_opts_policy)];
1409
1410             if (!nl_parse_nested(a, vxlan_opts_policy, ext, ARRAY_SIZE(ext))) {
1411                 return ODP_FIT_ERROR;
1412             }
1413
1414             if (ext[OVS_VXLAN_EXT_GBP]) {
1415                 uint32_t gbp = nl_attr_get_u32(ext[OVS_VXLAN_EXT_GBP]);
1416
1417                 tun->gbp_id = htons(gbp & 0xFFFF);
1418                 tun->gbp_flags = (gbp >> 16) & 0xFF;
1419             }
1420
1421             break;
1422         }
1423         case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS: {
1424             if (parse_geneve_opts(a)) {
1425                 return ODP_FIT_ERROR;
1426             }
1427             /* It is necessary to reproduce options exactly (including order)
1428              * so it's easiest to just echo them back. */
1429             unknown = true;
1430             break;
1431         }
1432         default:
1433             /* Allow this to show up as unexpected, if there are unknown
1434              * tunnel attribute, eventually resulting in ODP_FIT_TOO_MUCH. */
1435             unknown = true;
1436             break;
1437         }
1438     }
1439
1440     if (!ttl) {
1441         return ODP_FIT_ERROR;
1442     }
1443     if (unknown) {
1444         return ODP_FIT_TOO_MUCH;
1445     }
1446     return ODP_FIT_PERFECT;
1447 }
1448
1449 static void
1450 tun_key_to_attr(struct ofpbuf *a, const struct flow_tnl *tun_key)
1451 {
1452     size_t tun_key_ofs;
1453
1454     tun_key_ofs = nl_msg_start_nested(a, OVS_KEY_ATTR_TUNNEL);
1455
1456     /* tun_id != 0 without FLOW_TNL_F_KEY is valid if tun_key is a mask. */
1457     if (tun_key->tun_id || tun_key->flags & FLOW_TNL_F_KEY) {
1458         nl_msg_put_be64(a, OVS_TUNNEL_KEY_ATTR_ID, tun_key->tun_id);
1459     }
1460     if (tun_key->ip_src) {
1461         nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_SRC, tun_key->ip_src);
1462     }
1463     if (tun_key->ip_dst) {
1464         nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_DST, tun_key->ip_dst);
1465     }
1466     if (tun_key->ip_tos) {
1467         nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TOS, tun_key->ip_tos);
1468     }
1469     nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TTL, tun_key->ip_ttl);
1470     if (tun_key->flags & FLOW_TNL_F_DONT_FRAGMENT) {
1471         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
1472     }
1473     if (tun_key->flags & FLOW_TNL_F_CSUM) {
1474         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
1475     }
1476     if (tun_key->tp_src) {
1477         nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_SRC, tun_key->tp_src);
1478     }
1479     if (tun_key->tp_dst) {
1480         nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_DST, tun_key->tp_dst);
1481     }
1482     if (tun_key->flags & FLOW_TNL_F_OAM) {
1483         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
1484     }
1485     if (tun_key->gbp_flags || tun_key->gbp_id) {
1486         size_t vxlan_opts_ofs;
1487
1488         vxlan_opts_ofs = nl_msg_start_nested(a, OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS);
1489         nl_msg_put_u32(a, OVS_VXLAN_EXT_GBP,
1490                        (tun_key->gbp_flags << 16) | ntohs(tun_key->gbp_id));
1491         nl_msg_end_nested(a, vxlan_opts_ofs);
1492     }
1493
1494     nl_msg_end_nested(a, tun_key_ofs);
1495 }
1496
1497 static bool
1498 odp_mask_attr_is_wildcard(const struct nlattr *ma)
1499 {
1500     return is_all_zeros(nl_attr_get(ma), nl_attr_get_size(ma));
1501 }
1502
1503 static bool
1504 odp_mask_is_exact(enum ovs_key_attr attr, const void *mask, size_t size)
1505 {
1506     if (attr == OVS_KEY_ATTR_TCP_FLAGS) {
1507         return TCP_FLAGS(*(ovs_be16 *)mask) == TCP_FLAGS(OVS_BE16_MAX);
1508     }
1509     if (attr == OVS_KEY_ATTR_IPV6) {
1510         const struct ovs_key_ipv6 *ipv6_mask = mask;
1511
1512         return
1513             ((ipv6_mask->ipv6_label & htonl(IPV6_LABEL_MASK))
1514              == htonl(IPV6_LABEL_MASK))
1515             && ipv6_mask->ipv6_proto == UINT8_MAX
1516             && ipv6_mask->ipv6_tclass == UINT8_MAX
1517             && ipv6_mask->ipv6_hlimit == UINT8_MAX
1518             && ipv6_mask->ipv6_frag == UINT8_MAX
1519             && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_src)
1520             && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_dst);
1521     }
1522     if (attr == OVS_KEY_ATTR_TUNNEL) {
1523         return false;
1524     }
1525
1526     if (attr == OVS_KEY_ATTR_ARP) {
1527         /* ARP key has padding, ignore it. */
1528         BUILD_ASSERT_DECL(sizeof(struct ovs_key_arp) == 24);
1529         BUILD_ASSERT_DECL(offsetof(struct ovs_key_arp, arp_tha) == 10 + 6);
1530         size = offsetof(struct ovs_key_arp, arp_tha) + ETH_ADDR_LEN;
1531         ovs_assert(((uint16_t *)mask)[size/2] == 0);
1532     }
1533
1534     return is_all_ones(mask, size);
1535 }
1536
1537 static bool
1538 odp_mask_attr_is_exact(const struct nlattr *ma)
1539 {
1540     enum ovs_key_attr attr = nl_attr_type(ma);
1541     const void *mask;
1542     size_t size;
1543
1544     if (attr == OVS_KEY_ATTR_TUNNEL) {
1545         return false;
1546     } else {
1547         mask = nl_attr_get(ma);
1548         size = nl_attr_get_size(ma);
1549     }
1550
1551     return odp_mask_is_exact(attr, mask, size);
1552 }
1553
1554 void
1555 odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
1556                      char *port_name)
1557 {
1558     struct odp_portno_names *odp_portno_names;
1559
1560     odp_portno_names = xmalloc(sizeof *odp_portno_names);
1561     odp_portno_names->port_no = port_no;
1562     odp_portno_names->name = xstrdup(port_name);
1563     hmap_insert(portno_names, &odp_portno_names->hmap_node,
1564                 hash_odp_port(port_no));
1565 }
1566
1567 static char *
1568 odp_portno_names_get(const struct hmap *portno_names, odp_port_t port_no)
1569 {
1570     struct odp_portno_names *odp_portno_names;
1571
1572     HMAP_FOR_EACH_IN_BUCKET (odp_portno_names, hmap_node,
1573                              hash_odp_port(port_no), portno_names) {
1574         if (odp_portno_names->port_no == port_no) {
1575             return odp_portno_names->name;
1576         }
1577     }
1578     return NULL;
1579 }
1580
1581 void
1582 odp_portno_names_destroy(struct hmap *portno_names)
1583 {
1584     struct odp_portno_names *odp_portno_names, *odp_portno_names_next;
1585     HMAP_FOR_EACH_SAFE (odp_portno_names, odp_portno_names_next,
1586                         hmap_node, portno_names) {
1587         hmap_remove(portno_names, &odp_portno_names->hmap_node);
1588         free(odp_portno_names->name);
1589         free(odp_portno_names);
1590     }
1591 }
1592
1593 /* Format helpers. */
1594
1595 static void
1596 format_eth(struct ds *ds, const char *name, const uint8_t key[ETH_ADDR_LEN],
1597            const uint8_t (*mask)[ETH_ADDR_LEN], bool verbose)
1598 {
1599     bool mask_empty = mask && eth_addr_is_zero(*mask);
1600
1601     if (verbose || !mask_empty) {
1602         bool mask_full = !mask || eth_mask_is_exact(*mask);
1603
1604         if (mask_full) {
1605             ds_put_format(ds, "%s="ETH_ADDR_FMT",", name, ETH_ADDR_ARGS(key));
1606         } else {
1607             ds_put_format(ds, "%s=", name);
1608             eth_format_masked(key, *mask, ds);
1609             ds_put_char(ds, ',');
1610         }
1611     }
1612 }
1613
1614 static void
1615 format_be64(struct ds *ds, const char *name, ovs_be64 key,
1616             const ovs_be64 *mask, bool verbose)
1617 {
1618     bool mask_empty = mask && !*mask;
1619
1620     if (verbose || !mask_empty) {
1621         bool mask_full = !mask || *mask == OVS_BE64_MAX;
1622
1623         ds_put_format(ds, "%s=0x%"PRIx64, name, ntohll(key));
1624         if (!mask_full) { /* Partially masked. */
1625             ds_put_format(ds, "/%#"PRIx64, ntohll(*mask));
1626         }
1627         ds_put_char(ds, ',');
1628     }
1629 }
1630
1631 static void
1632 format_ipv4(struct ds *ds, const char *name, ovs_be32 key,
1633             const ovs_be32 *mask, bool verbose)
1634 {
1635     bool mask_empty = mask && !*mask;
1636
1637     if (verbose || !mask_empty) {
1638         bool mask_full = !mask || *mask == OVS_BE32_MAX;
1639
1640         ds_put_format(ds, "%s="IP_FMT, name, IP_ARGS(key));
1641         if (!mask_full) { /* Partially masked. */
1642             ds_put_format(ds, "/"IP_FMT, IP_ARGS(*mask));
1643         }
1644         ds_put_char(ds, ',');
1645     }
1646 }
1647
1648 static void
1649 format_ipv6(struct ds *ds, const char *name, const ovs_be32 key_[4],
1650             const ovs_be32 (*mask_)[4], bool verbose)
1651 {
1652     char buf[INET6_ADDRSTRLEN];
1653     const struct in6_addr *key = (const struct in6_addr *)key_;
1654     const struct in6_addr *mask = mask_ ? (const struct in6_addr *)*mask_
1655         : NULL;
1656     bool mask_empty = mask && ipv6_mask_is_any(mask);
1657
1658     if (verbose || !mask_empty) {
1659         bool mask_full = !mask || ipv6_mask_is_exact(mask);
1660
1661         inet_ntop(AF_INET6, key, buf, sizeof buf);
1662         ds_put_format(ds, "%s=%s", name, buf);
1663         if (!mask_full) { /* Partially masked. */
1664             inet_ntop(AF_INET6, mask, buf, sizeof buf);
1665             ds_put_format(ds, "/%s", buf);
1666         }
1667         ds_put_char(ds, ',');
1668     }
1669 }
1670
1671 static void
1672 format_ipv6_label(struct ds *ds, const char *name, ovs_be32 key,
1673                   const ovs_be32 *mask, bool verbose)
1674 {
1675     bool mask_empty = mask && !*mask;
1676
1677     if (verbose || !mask_empty) {
1678         bool mask_full = !mask
1679             || (*mask & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK);
1680
1681         ds_put_format(ds, "%s=%#"PRIx32, name, ntohl(key));
1682         if (!mask_full) { /* Partially masked. */
1683             ds_put_format(ds, "/%#"PRIx32, ntohl(*mask));
1684         }
1685         ds_put_char(ds, ',');
1686     }
1687 }
1688
1689 static void
1690 format_u8x(struct ds *ds, const char *name, uint8_t key,
1691            const uint8_t *mask, bool verbose)
1692 {
1693     bool mask_empty = mask && !*mask;
1694
1695     if (verbose || !mask_empty) {
1696         bool mask_full = !mask || *mask == UINT8_MAX;
1697
1698         ds_put_format(ds, "%s=%#"PRIx8, name, key);
1699         if (!mask_full) { /* Partially masked. */
1700             ds_put_format(ds, "/%#"PRIx8, *mask);
1701         }
1702         ds_put_char(ds, ',');
1703     }
1704 }
1705
1706 static void
1707 format_u8u(struct ds *ds, const char *name, uint8_t key,
1708            const uint8_t *mask, bool verbose)
1709 {
1710     bool mask_empty = mask && !*mask;
1711
1712     if (verbose || !mask_empty) {
1713         bool mask_full = !mask || *mask == UINT8_MAX;
1714
1715         ds_put_format(ds, "%s=%"PRIu8, name, key);
1716         if (!mask_full) { /* Partially masked. */
1717             ds_put_format(ds, "/%#"PRIx8, *mask);
1718         }
1719         ds_put_char(ds, ',');
1720     }
1721 }
1722
1723 static void
1724 format_be16(struct ds *ds, const char *name, ovs_be16 key,
1725             const ovs_be16 *mask, bool verbose)
1726 {
1727     bool mask_empty = mask && !*mask;
1728
1729     if (verbose || !mask_empty) {
1730         bool mask_full = !mask || *mask == OVS_BE16_MAX;
1731
1732         ds_put_format(ds, "%s=%"PRIu16, name, ntohs(key));
1733         if (!mask_full) { /* Partially masked. */
1734             ds_put_format(ds, "/%#"PRIx16, ntohs(*mask));
1735         }
1736         ds_put_char(ds, ',');
1737     }
1738 }
1739
1740 static void
1741 format_be16x(struct ds *ds, const char *name, ovs_be16 key,
1742              const ovs_be16 *mask, bool verbose)
1743 {
1744     bool mask_empty = mask && !*mask;
1745
1746     if (verbose || !mask_empty) {
1747         bool mask_full = !mask || *mask == OVS_BE16_MAX;
1748
1749         ds_put_format(ds, "%s=%#"PRIx16, name, ntohs(key));
1750         if (!mask_full) { /* Partially masked. */
1751             ds_put_format(ds, "/%#"PRIx16, ntohs(*mask));
1752         }
1753         ds_put_char(ds, ',');
1754     }
1755 }
1756
1757 static void
1758 format_tun_flags(struct ds *ds, const char *name, uint16_t key,
1759                  const uint16_t *mask, bool verbose)
1760 {
1761     bool mask_empty = mask && !*mask;
1762
1763     if (verbose || !mask_empty) {
1764         bool mask_full = !mask || (*mask & FLOW_TNL_F_MASK) == FLOW_TNL_F_MASK;
1765
1766         ds_put_cstr(ds, name);
1767         ds_put_char(ds, '(');
1768         if (!mask_full) { /* Partially masked. */
1769             format_flags_masked(ds, NULL, flow_tun_flag_to_string, key, *mask);
1770         } else { /* Fully masked. */
1771             format_flags(ds, flow_tun_flag_to_string, key, ',');
1772         }
1773         ds_put_cstr(ds, "),");
1774     }
1775 }
1776
1777 static bool
1778 check_attr_len(struct ds *ds, const struct nlattr *a, const struct nlattr *ma,
1779                const struct attr_len_tbl tbl[], int max_len, bool need_key)
1780 {
1781     int expected_len;
1782
1783     expected_len = odp_key_attr_len(tbl, max_len, nl_attr_type(a));
1784     if (expected_len != ATTR_LEN_VARIABLE &&
1785         expected_len != ATTR_LEN_NESTED) {
1786
1787         bool bad_key_len = nl_attr_get_size(a) != expected_len;
1788         bool bad_mask_len = ma && nl_attr_get_size(ma) != expected_len;
1789
1790         if (bad_key_len || bad_mask_len) {
1791             if (need_key) {
1792                 ds_put_format(ds, "key%u", nl_attr_type(a));
1793             }
1794             if (bad_key_len) {
1795                 ds_put_format(ds, "(bad key length %"PRIuSIZE", expected %d)(",
1796                               nl_attr_get_size(a), expected_len);
1797             }
1798             format_generic_odp_key(a, ds);
1799             if (ma) {
1800                 ds_put_char(ds, '/');
1801                 if (bad_mask_len) {
1802                     ds_put_format(ds, "(bad mask length %"PRIuSIZE", expected %d)(",
1803                                   nl_attr_get_size(ma), expected_len);
1804                 }
1805                 format_generic_odp_key(ma, ds);
1806             }
1807             ds_put_char(ds, ')');
1808             return false;
1809         }
1810     }
1811
1812     return true;
1813 }
1814
1815 static void
1816 format_unknown_key(struct ds *ds, const struct nlattr *a,
1817                    const struct nlattr *ma)
1818 {
1819     ds_put_format(ds, "key%u(", nl_attr_type(a));
1820     format_generic_odp_key(a, ds);
1821     if (ma && !odp_mask_attr_is_exact(ma)) {
1822         ds_put_char(ds, '/');
1823         format_generic_odp_key(ma, ds);
1824     }
1825     ds_put_cstr(ds, "),");
1826 }
1827
1828 static void
1829 format_odp_tun_vxlan_opt(const struct nlattr *attr,
1830                          const struct nlattr *mask_attr, struct ds *ds,
1831                          bool verbose)
1832 {
1833     unsigned int left;
1834     const struct nlattr *a;
1835     struct ofpbuf ofp;
1836
1837     ofpbuf_init(&ofp, 100);
1838     NL_NESTED_FOR_EACH(a, left, attr) {
1839         uint16_t type = nl_attr_type(a);
1840         const struct nlattr *ma = NULL;
1841
1842         if (mask_attr) {
1843             ma = nl_attr_find__(nl_attr_get(mask_attr),
1844                                 nl_attr_get_size(mask_attr), type);
1845             if (!ma) {
1846                 ma = generate_all_wildcard_mask(ovs_vxlan_ext_attr_lens,
1847                                                 OVS_VXLAN_EXT_MAX,
1848                                                 &ofp, a);
1849             }
1850         }
1851
1852         if (!check_attr_len(ds, a, ma, ovs_vxlan_ext_attr_lens,
1853                             OVS_VXLAN_EXT_MAX, true)) {
1854             continue;
1855         }
1856
1857         switch (type) {
1858         case OVS_VXLAN_EXT_GBP: {
1859             uint32_t key = nl_attr_get_u32(a);
1860             ovs_be16 id, id_mask;
1861             uint8_t flags, flags_mask;
1862
1863             id = htons(key & 0xFFFF);
1864             flags = (key >> 16) & 0xFF;
1865             if (ma) {
1866                 uint32_t mask = nl_attr_get_u32(ma);
1867                 id_mask = htons(mask & 0xFFFF);
1868                 flags_mask = (mask >> 16) & 0xFF;
1869             }
1870
1871             ds_put_cstr(ds, "gbp(");
1872             format_be16(ds, "id", id, ma ? &id_mask : NULL, verbose);
1873             format_u8x(ds, "flags", flags, ma ? &flags_mask : NULL, verbose);
1874             ds_chomp(ds, ',');
1875             ds_put_cstr(ds, "),");
1876             break;
1877         }
1878
1879         default:
1880             format_unknown_key(ds, a, ma);
1881         }
1882         ofpbuf_clear(&ofp);
1883     }
1884
1885     ds_chomp(ds, ',');
1886     ofpbuf_uninit(&ofp);
1887 }
1888
1889 #define MASK(PTR, FIELD) PTR ? &PTR->FIELD : NULL
1890
1891 static void
1892 format_odp_tun_geneve(const struct nlattr *attr,
1893                       const struct nlattr *mask_attr, struct ds *ds,
1894                       bool verbose)
1895 {
1896     int opts_len = nl_attr_get_size(attr);
1897     const struct geneve_opt *opt = nl_attr_get(attr);
1898     const struct geneve_opt *mask = mask_attr ?
1899                                     nl_attr_get(mask_attr) : NULL;
1900
1901     if (mask && nl_attr_get_size(attr) != nl_attr_get_size(mask_attr)) {
1902         ds_put_format(ds, "value len %"PRIuSIZE" different from mask len %"PRIuSIZE,
1903                       nl_attr_get_size(attr), nl_attr_get_size(mask_attr));
1904         return;
1905     }
1906
1907     while (opts_len > 0) {
1908         unsigned int len;
1909         uint8_t data_len, data_len_mask;
1910
1911         if (opts_len < sizeof *opt) {
1912             ds_put_format(ds, "opt len %u less than minimum %"PRIuSIZE,
1913                           opts_len, sizeof *opt);
1914             return;
1915         }
1916
1917         data_len = opt->length * 4;
1918         if (mask) {
1919             if (mask->length == 0x1f) {
1920                 data_len_mask = UINT8_MAX;
1921             } else {
1922                 data_len_mask = mask->length;
1923             }
1924         }
1925         len = sizeof *opt + data_len;
1926         if (len > opts_len) {
1927             ds_put_format(ds, "opt len %u greater than remaining %u",
1928                           len, opts_len);
1929             return;
1930         }
1931
1932         ds_put_char(ds, '{');
1933         format_be16x(ds, "class", opt->opt_class, MASK(mask, opt_class),
1934                     verbose);
1935         format_u8x(ds, "type", opt->type, MASK(mask, type), verbose);
1936         format_u8u(ds, "len", data_len, mask ? &data_len_mask : NULL, verbose);
1937         if (verbose || !mask || !is_all_zeros(mask + 1, data_len)) {
1938             ds_put_hex(ds, opt + 1, data_len);
1939             if (mask && !is_all_ones(mask + 1, data_len)) {
1940                 ds_put_char(ds, '/');
1941                 ds_put_hex(ds, mask + 1, data_len);
1942             }
1943         } else {
1944             ds_chomp(ds, ',');
1945         }
1946         ds_put_char(ds, '}');
1947
1948         opt += len / sizeof(*opt);
1949         if (mask) {
1950             mask += len / sizeof(*opt);
1951         }
1952         opts_len -= len;
1953     };
1954 }
1955
1956 static void
1957 format_odp_tun_attr(const struct nlattr *attr, const struct nlattr *mask_attr,
1958                     struct ds *ds, bool verbose)
1959 {
1960     unsigned int left;
1961     const struct nlattr *a;
1962     uint16_t flags = 0;
1963     uint16_t mask_flags = 0;
1964     struct ofpbuf ofp;
1965
1966     ofpbuf_init(&ofp, 100);
1967     NL_NESTED_FOR_EACH(a, left, attr) {
1968         enum ovs_tunnel_key_attr type = nl_attr_type(a);
1969         const struct nlattr *ma = NULL;
1970
1971         if (mask_attr) {
1972             ma = nl_attr_find__(nl_attr_get(mask_attr),
1973                                 nl_attr_get_size(mask_attr), type);
1974             if (!ma) {
1975                 ma = generate_all_wildcard_mask(ovs_tun_key_attr_lens,
1976                                                 OVS_TUNNEL_KEY_ATTR_MAX,
1977                                                 &ofp, a);
1978             }
1979         }
1980
1981         if (!check_attr_len(ds, a, ma, ovs_tun_key_attr_lens,
1982                             OVS_TUNNEL_KEY_ATTR_MAX, true)) {
1983             continue;
1984         }
1985
1986         switch (type) {
1987         case OVS_TUNNEL_KEY_ATTR_ID:
1988             format_be64(ds, "tun_id", nl_attr_get_be64(a),
1989                         ma ? nl_attr_get(ma) : NULL, verbose);
1990             flags |= FLOW_TNL_F_KEY;
1991             if (ma) {
1992                 mask_flags |= FLOW_TNL_F_KEY;
1993             }
1994             break;
1995         case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
1996             format_ipv4(ds, "src", nl_attr_get_be32(a),
1997                         ma ? nl_attr_get(ma) : NULL, verbose);
1998             break;
1999         case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
2000             format_ipv4(ds, "dst", nl_attr_get_be32(a),
2001                         ma ? nl_attr_get(ma) : NULL, verbose);
2002             break;
2003         case OVS_TUNNEL_KEY_ATTR_TOS:
2004             format_u8x(ds, "tos", nl_attr_get_u8(a),
2005                        ma ? nl_attr_get(ma) : NULL, verbose);
2006             break;
2007         case OVS_TUNNEL_KEY_ATTR_TTL:
2008             format_u8u(ds, "ttl", nl_attr_get_u8(a),
2009                        ma ? nl_attr_get(ma) : NULL, verbose);
2010             break;
2011         case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
2012             flags |= FLOW_TNL_F_DONT_FRAGMENT;
2013             break;
2014         case OVS_TUNNEL_KEY_ATTR_CSUM:
2015             flags |= FLOW_TNL_F_CSUM;
2016             break;
2017         case OVS_TUNNEL_KEY_ATTR_TP_SRC:
2018             format_be16(ds, "tp_src", nl_attr_get_be16(a),
2019                         ma ? nl_attr_get(ma) : NULL, verbose);
2020             break;
2021         case OVS_TUNNEL_KEY_ATTR_TP_DST:
2022             format_be16(ds, "tp_dst", nl_attr_get_be16(a),
2023                         ma ? nl_attr_get(ma) : NULL, verbose);
2024             break;
2025         case OVS_TUNNEL_KEY_ATTR_OAM:
2026             flags |= FLOW_TNL_F_OAM;
2027             break;
2028         case OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS:
2029             ds_put_cstr(ds, "vxlan(");
2030             format_odp_tun_vxlan_opt(a, ma, ds, verbose);
2031             ds_put_cstr(ds, "),");
2032             break;
2033         case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS:
2034             ds_put_cstr(ds, "geneve(");
2035             format_odp_tun_geneve(a, ma, ds, verbose);
2036             ds_put_cstr(ds, "),");
2037             break;
2038         case __OVS_TUNNEL_KEY_ATTR_MAX:
2039         default:
2040             format_unknown_key(ds, a, ma);
2041         }
2042         ofpbuf_clear(&ofp);
2043     }
2044
2045     /* Flags can have a valid mask even if the attribute is not set, so
2046      * we need to collect these separately. */
2047     if (mask_attr) {
2048         NL_NESTED_FOR_EACH(a, left, mask_attr) {
2049             switch (nl_attr_type(a)) {
2050             case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
2051                 mask_flags |= FLOW_TNL_F_DONT_FRAGMENT;
2052                 break;
2053             case OVS_TUNNEL_KEY_ATTR_CSUM:
2054                 mask_flags |= FLOW_TNL_F_CSUM;
2055                 break;
2056             case OVS_TUNNEL_KEY_ATTR_OAM:
2057                 mask_flags |= FLOW_TNL_F_OAM;
2058                 break;
2059             }
2060         }
2061     }
2062
2063     format_tun_flags(ds, "flags", flags, mask_attr ? &mask_flags : NULL,
2064                      verbose);
2065     ds_chomp(ds, ',');
2066     ofpbuf_uninit(&ofp);
2067 }
2068
2069 static void
2070 format_frag(struct ds *ds, const char *name, uint8_t key,
2071             const uint8_t *mask, bool verbose)
2072 {
2073     bool mask_empty = mask && !*mask;
2074
2075     /* ODP frag is an enumeration field; partial masks are not meaningful. */
2076     if (verbose || !mask_empty) {
2077         bool mask_full = !mask || *mask == UINT8_MAX;
2078
2079         if (!mask_full) { /* Partially masked. */
2080             ds_put_format(ds, "error: partial mask not supported for frag (%#"
2081                           PRIx8"),", *mask);
2082         } else {
2083             ds_put_format(ds, "%s=%s,", name, ovs_frag_type_to_string(key));
2084         }
2085     }
2086 }
2087
2088 static void
2089 format_odp_key_attr(const struct nlattr *a, const struct nlattr *ma,
2090                     const struct hmap *portno_names, struct ds *ds,
2091                     bool verbose)
2092 {
2093     enum ovs_key_attr attr = nl_attr_type(a);
2094     char namebuf[OVS_KEY_ATTR_BUFSIZE];
2095     bool is_exact;
2096
2097     is_exact = ma ? odp_mask_attr_is_exact(ma) : true;
2098
2099     ds_put_cstr(ds, ovs_key_attr_to_string(attr, namebuf, sizeof namebuf));
2100
2101     if (!check_attr_len(ds, a, ma, ovs_flow_key_attr_lens,
2102                         OVS_KEY_ATTR_MAX, false)) {
2103         return;
2104     }
2105
2106     ds_put_char(ds, '(');
2107     switch (attr) {
2108     case OVS_KEY_ATTR_ENCAP:
2109         if (ma && nl_attr_get_size(ma) && nl_attr_get_size(a)) {
2110             odp_flow_format(nl_attr_get(a), nl_attr_get_size(a),
2111                             nl_attr_get(ma), nl_attr_get_size(ma), NULL, ds,
2112                             verbose);
2113         } else if (nl_attr_get_size(a)) {
2114             odp_flow_format(nl_attr_get(a), nl_attr_get_size(a), NULL, 0, NULL,
2115                             ds, verbose);
2116         }
2117         break;
2118
2119     case OVS_KEY_ATTR_PRIORITY:
2120     case OVS_KEY_ATTR_SKB_MARK:
2121     case OVS_KEY_ATTR_DP_HASH:
2122     case OVS_KEY_ATTR_RECIRC_ID:
2123         ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2124         if (!is_exact) {
2125             ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2126         }
2127         break;
2128
2129     case OVS_KEY_ATTR_TUNNEL:
2130         format_odp_tun_attr(a, ma, ds, verbose);
2131         break;
2132
2133     case OVS_KEY_ATTR_IN_PORT:
2134         if (portno_names && verbose && is_exact) {
2135             char *name = odp_portno_names_get(portno_names,
2136                             u32_to_odp(nl_attr_get_u32(a)));
2137             if (name) {
2138                 ds_put_format(ds, "%s", name);
2139             } else {
2140                 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2141             }
2142         } else {
2143             ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2144             if (!is_exact) {
2145                 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2146             }
2147         }
2148         break;
2149
2150     case OVS_KEY_ATTR_ETHERNET: {
2151         const struct ovs_key_ethernet *mask = ma ? nl_attr_get(ma) : NULL;
2152         const struct ovs_key_ethernet *key = nl_attr_get(a);
2153
2154         format_eth(ds, "src", key->eth_src, MASK(mask, eth_src), verbose);
2155         format_eth(ds, "dst", key->eth_dst, MASK(mask, eth_dst), verbose);
2156         ds_chomp(ds, ',');
2157         break;
2158     }
2159     case OVS_KEY_ATTR_VLAN:
2160         format_vlan_tci(ds, nl_attr_get_be16(a),
2161                         ma ? nl_attr_get_be16(ma) : OVS_BE16_MAX, verbose);
2162         break;
2163
2164     case OVS_KEY_ATTR_MPLS: {
2165         const struct ovs_key_mpls *mpls_key = nl_attr_get(a);
2166         const struct ovs_key_mpls *mpls_mask = NULL;
2167         size_t size = nl_attr_get_size(a);
2168
2169         if (!size || size % sizeof *mpls_key) {
2170             ds_put_format(ds, "(bad key length %"PRIuSIZE")", size);
2171             return;
2172         }
2173         if (!is_exact) {
2174             mpls_mask = nl_attr_get(ma);
2175             if (size != nl_attr_get_size(ma)) {
2176                 ds_put_format(ds, "(key length %"PRIuSIZE" != "
2177                               "mask length %"PRIuSIZE")",
2178                               size, nl_attr_get_size(ma));
2179                 return;
2180             }
2181         }
2182         format_mpls(ds, mpls_key, mpls_mask, size / sizeof *mpls_key);
2183         break;
2184     }
2185     case OVS_KEY_ATTR_ETHERTYPE:
2186         ds_put_format(ds, "0x%04"PRIx16, ntohs(nl_attr_get_be16(a)));
2187         if (!is_exact) {
2188             ds_put_format(ds, "/0x%04"PRIx16, ntohs(nl_attr_get_be16(ma)));
2189         }
2190         break;
2191
2192     case OVS_KEY_ATTR_IPV4: {
2193         const struct ovs_key_ipv4 *key = nl_attr_get(a);
2194         const struct ovs_key_ipv4 *mask = ma ? nl_attr_get(ma) : NULL;
2195
2196         format_ipv4(ds, "src", key->ipv4_src, MASK(mask, ipv4_src), verbose);
2197         format_ipv4(ds, "dst", key->ipv4_dst, MASK(mask, ipv4_dst), verbose);
2198         format_u8u(ds, "proto", key->ipv4_proto, MASK(mask, ipv4_proto),
2199                       verbose);
2200         format_u8x(ds, "tos", key->ipv4_tos, MASK(mask, ipv4_tos), verbose);
2201         format_u8u(ds, "ttl", key->ipv4_ttl, MASK(mask, ipv4_ttl), verbose);
2202         format_frag(ds, "frag", key->ipv4_frag, MASK(mask, ipv4_frag),
2203                     verbose);
2204         ds_chomp(ds, ',');
2205         break;
2206     }
2207     case OVS_KEY_ATTR_IPV6: {
2208         const struct ovs_key_ipv6 *key = nl_attr_get(a);
2209         const struct ovs_key_ipv6 *mask = ma ? nl_attr_get(ma) : NULL;
2210
2211         format_ipv6(ds, "src", key->ipv6_src, MASK(mask, ipv6_src), verbose);
2212         format_ipv6(ds, "dst", key->ipv6_dst, MASK(mask, ipv6_dst), verbose);
2213         format_ipv6_label(ds, "label", key->ipv6_label, MASK(mask, ipv6_label),
2214                           verbose);
2215         format_u8u(ds, "proto", key->ipv6_proto, MASK(mask, ipv6_proto),
2216                       verbose);
2217         format_u8x(ds, "tclass", key->ipv6_tclass, MASK(mask, ipv6_tclass),
2218                       verbose);
2219         format_u8u(ds, "hlimit", key->ipv6_hlimit, MASK(mask, ipv6_hlimit),
2220                       verbose);
2221         format_frag(ds, "frag", key->ipv6_frag, MASK(mask, ipv6_frag),
2222                     verbose);
2223         ds_chomp(ds, ',');
2224         break;
2225     }
2226         /* These have the same structure and format. */
2227     case OVS_KEY_ATTR_TCP:
2228     case OVS_KEY_ATTR_UDP:
2229     case OVS_KEY_ATTR_SCTP: {
2230         const struct ovs_key_tcp *key = nl_attr_get(a);
2231         const struct ovs_key_tcp *mask = ma ? nl_attr_get(ma) : NULL;
2232
2233         format_be16(ds, "src", key->tcp_src, MASK(mask, tcp_src), verbose);
2234         format_be16(ds, "dst", key->tcp_dst, MASK(mask, tcp_dst), verbose);
2235         ds_chomp(ds, ',');
2236         break;
2237     }
2238     case OVS_KEY_ATTR_TCP_FLAGS:
2239         if (!is_exact) {
2240             format_flags_masked(ds, NULL, packet_tcp_flag_to_string,
2241                                 ntohs(nl_attr_get_be16(a)),
2242                                 ntohs(nl_attr_get_be16(ma)));
2243         } else {
2244             format_flags(ds, packet_tcp_flag_to_string,
2245                          ntohs(nl_attr_get_be16(a)), ',');
2246         }
2247         break;
2248
2249     case OVS_KEY_ATTR_ICMP: {
2250         const struct ovs_key_icmp *key = nl_attr_get(a);
2251         const struct ovs_key_icmp *mask = ma ? nl_attr_get(ma) : NULL;
2252
2253         format_u8u(ds, "type", key->icmp_type, MASK(mask, icmp_type), verbose);
2254         format_u8u(ds, "code", key->icmp_code, MASK(mask, icmp_code), verbose);
2255         ds_chomp(ds, ',');
2256         break;
2257     }
2258     case OVS_KEY_ATTR_ICMPV6: {
2259         const struct ovs_key_icmpv6 *key = nl_attr_get(a);
2260         const struct ovs_key_icmpv6 *mask = ma ? nl_attr_get(ma) : NULL;
2261
2262         format_u8u(ds, "type", key->icmpv6_type, MASK(mask, icmpv6_type),
2263                    verbose);
2264         format_u8u(ds, "code", key->icmpv6_code, MASK(mask, icmpv6_code),
2265                    verbose);
2266         ds_chomp(ds, ',');
2267         break;
2268     }
2269     case OVS_KEY_ATTR_ARP: {
2270         const struct ovs_key_arp *mask = ma ? nl_attr_get(ma) : NULL;
2271         const struct ovs_key_arp *key = nl_attr_get(a);
2272
2273         format_ipv4(ds, "sip", key->arp_sip, MASK(mask, arp_sip), verbose);
2274         format_ipv4(ds, "tip", key->arp_tip, MASK(mask, arp_tip), verbose);
2275         format_be16(ds, "op", key->arp_op, MASK(mask, arp_op), verbose);
2276         format_eth(ds, "sha", key->arp_sha, MASK(mask, arp_sha), verbose);
2277         format_eth(ds, "tha", key->arp_tha, MASK(mask, arp_tha), verbose);
2278         ds_chomp(ds, ',');
2279         break;
2280     }
2281     case OVS_KEY_ATTR_ND: {
2282         const struct ovs_key_nd *mask = ma ? nl_attr_get(ma) : NULL;
2283         const struct ovs_key_nd *key = nl_attr_get(a);
2284
2285         format_ipv6(ds, "target", key->nd_target, MASK(mask, nd_target),
2286                     verbose);
2287         format_eth(ds, "sll", key->nd_sll, MASK(mask, nd_sll), verbose);
2288         format_eth(ds, "tll", key->nd_tll, MASK(mask, nd_tll), verbose);
2289
2290         ds_chomp(ds, ',');
2291         break;
2292     }
2293     case OVS_KEY_ATTR_UNSPEC:
2294     case __OVS_KEY_ATTR_MAX:
2295     default:
2296         format_generic_odp_key(a, ds);
2297         if (!is_exact) {
2298             ds_put_char(ds, '/');
2299             format_generic_odp_key(ma, ds);
2300         }
2301         break;
2302     }
2303     ds_put_char(ds, ')');
2304 }
2305
2306 static struct nlattr *
2307 generate_all_wildcard_mask(const struct attr_len_tbl tbl[], int max,
2308                            struct ofpbuf *ofp, const struct nlattr *key)
2309 {
2310     const struct nlattr *a;
2311     unsigned int left;
2312     int type = nl_attr_type(key);
2313     int size = nl_attr_get_size(key);
2314
2315     if (odp_key_attr_len(tbl, max, type) != ATTR_LEN_NESTED) {
2316         nl_msg_put_unspec_zero(ofp, type, size);
2317     } else {
2318         size_t nested_mask;
2319
2320         if (tbl[type].next) {
2321             tbl = tbl[type].next;
2322             max = tbl[type].next_max;
2323         }
2324
2325         nested_mask = nl_msg_start_nested(ofp, type);
2326         NL_ATTR_FOR_EACH(a, left, key, nl_attr_get_size(key)) {
2327             generate_all_wildcard_mask(tbl, max, ofp, nl_attr_get(a));
2328         }
2329         nl_msg_end_nested(ofp, nested_mask);
2330     }
2331
2332     return ofp->base;
2333 }
2334
2335 int
2336 odp_ufid_from_string(const char *s_, ovs_u128 *ufid)
2337 {
2338     const char *s = s_;
2339
2340     if (ovs_scan(s, "ufid:")) {
2341         s += 5;
2342
2343         if (!uuid_from_string_prefix((struct uuid *)ufid, s)) {
2344             return -EINVAL;
2345         }
2346         s += UUID_LEN;
2347
2348         return s - s_;
2349     }
2350
2351     return 0;
2352 }
2353
2354 void
2355 odp_format_ufid(const ovs_u128 *ufid, struct ds *ds)
2356 {
2357     ds_put_format(ds, "ufid:"UUID_FMT, UUID_ARGS((struct uuid *)ufid));
2358 }
2359
2360 /* Appends to 'ds' a string representation of the 'key_len' bytes of
2361  * OVS_KEY_ATTR_* attributes in 'key'. If non-null, additionally formats the
2362  * 'mask_len' bytes of 'mask' which apply to 'key'. If 'portno_names' is
2363  * non-null and 'verbose' is true, translates odp port number to its name. */
2364 void
2365 odp_flow_format(const struct nlattr *key, size_t key_len,
2366                 const struct nlattr *mask, size_t mask_len,
2367                 const struct hmap *portno_names, struct ds *ds, bool verbose)
2368 {
2369     if (key_len) {
2370         const struct nlattr *a;
2371         unsigned int left;
2372         bool has_ethtype_key = false;
2373         const struct nlattr *ma = NULL;
2374         struct ofpbuf ofp;
2375         bool first_field = true;
2376
2377         ofpbuf_init(&ofp, 100);
2378         NL_ATTR_FOR_EACH (a, left, key, key_len) {
2379             bool is_nested_attr;
2380             bool is_wildcard = false;
2381             int attr_type = nl_attr_type(a);
2382
2383             if (attr_type == OVS_KEY_ATTR_ETHERTYPE) {
2384                 has_ethtype_key = true;
2385             }
2386
2387             is_nested_attr = odp_key_attr_len(ovs_flow_key_attr_lens,
2388                                               OVS_KEY_ATTR_MAX, attr_type) ==
2389                              ATTR_LEN_NESTED;
2390
2391             if (mask && mask_len) {
2392                 ma = nl_attr_find__(mask, mask_len, nl_attr_type(a));
2393                 is_wildcard = ma ? odp_mask_attr_is_wildcard(ma) : true;
2394             }
2395
2396             if (verbose || !is_wildcard  || is_nested_attr) {
2397                 if (is_wildcard && !ma) {
2398                     ma = generate_all_wildcard_mask(ovs_flow_key_attr_lens,
2399                                                     OVS_KEY_ATTR_MAX,
2400                                                     &ofp, a);
2401                 }
2402                 if (!first_field) {
2403                     ds_put_char(ds, ',');
2404                 }
2405                 format_odp_key_attr(a, ma, portno_names, ds, verbose);
2406                 first_field = false;
2407             }
2408             ofpbuf_clear(&ofp);
2409         }
2410         ofpbuf_uninit(&ofp);
2411
2412         if (left) {
2413             int i;
2414
2415             if (left == key_len) {
2416                 ds_put_cstr(ds, "<empty>");
2417             }
2418             ds_put_format(ds, ",***%u leftover bytes*** (", left);
2419             for (i = 0; i < left; i++) {
2420                 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
2421             }
2422             ds_put_char(ds, ')');
2423         }
2424         if (!has_ethtype_key) {
2425             ma = nl_attr_find__(mask, mask_len, OVS_KEY_ATTR_ETHERTYPE);
2426             if (ma) {
2427                 ds_put_format(ds, ",eth_type(0/0x%04"PRIx16")",
2428                               ntohs(nl_attr_get_be16(ma)));
2429             }
2430         }
2431     } else {
2432         ds_put_cstr(ds, "<empty>");
2433     }
2434 }
2435
2436 /* Appends to 'ds' a string representation of the 'key_len' bytes of
2437  * OVS_KEY_ATTR_* attributes in 'key'. */
2438 void
2439 odp_flow_key_format(const struct nlattr *key,
2440                     size_t key_len, struct ds *ds)
2441 {
2442     odp_flow_format(key, key_len, NULL, 0, NULL, ds, true);
2443 }
2444
2445 static bool
2446 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
2447 {
2448     if (!strcasecmp(s, "no")) {
2449         *type = OVS_FRAG_TYPE_NONE;
2450     } else if (!strcasecmp(s, "first")) {
2451         *type = OVS_FRAG_TYPE_FIRST;
2452     } else if (!strcasecmp(s, "later")) {
2453         *type = OVS_FRAG_TYPE_LATER;
2454     } else {
2455         return false;
2456     }
2457     return true;
2458 }
2459
2460 /* Parsing. */
2461
2462 static int
2463 scan_eth(const char *s, uint8_t (*key)[ETH_ADDR_LEN],
2464          uint8_t (*mask)[ETH_ADDR_LEN])
2465 {
2466     int n;
2467
2468     if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(*key), &n)) {
2469         int len = n;
2470
2471         if (mask) {
2472             if (ovs_scan(s + len, "/"ETH_ADDR_SCAN_FMT"%n",
2473                          ETH_ADDR_SCAN_ARGS(*mask), &n)) {
2474                 len += n;
2475             } else {
2476                 memset(mask, 0xff, sizeof *mask);
2477             }
2478         }
2479         return len;
2480     }
2481     return 0;
2482 }
2483
2484 static int
2485 scan_ipv4(const char *s, ovs_be32 *key, ovs_be32 *mask)
2486 {
2487     int n;
2488
2489     if (ovs_scan(s, IP_SCAN_FMT"%n", IP_SCAN_ARGS(key), &n)) {
2490         int len = n;
2491
2492         if (mask) {
2493             if (ovs_scan(s + len, "/"IP_SCAN_FMT"%n",
2494                          IP_SCAN_ARGS(mask), &n)) {
2495                 len += n;
2496             } else {
2497                 *mask = OVS_BE32_MAX;
2498             }
2499         }
2500         return len;
2501     }
2502     return 0;
2503 }
2504
2505 static int
2506 scan_ipv6(const char *s, ovs_be32 (*key)[4], ovs_be32 (*mask)[4])
2507 {
2508     int n;
2509     char ipv6_s[IPV6_SCAN_LEN + 1];
2510
2511     if (ovs_scan(s, IPV6_SCAN_FMT"%n", ipv6_s, &n)
2512         && inet_pton(AF_INET6, ipv6_s, key) == 1) {
2513         int len = n;
2514
2515         if (mask) {
2516             if (ovs_scan(s + len, "/"IPV6_SCAN_FMT"%n", ipv6_s, &n)
2517                 && inet_pton(AF_INET6, ipv6_s, mask) == 1) {
2518                 len += n;
2519             } else {
2520                 memset(mask, 0xff, sizeof *mask);
2521             }
2522         }
2523         return len;
2524     }
2525     return 0;
2526 }
2527
2528 static int
2529 scan_ipv6_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
2530 {
2531     int key_, mask_;
2532     int n;
2533
2534     if (ovs_scan(s, "%i%n", &key_, &n)
2535         && (key_ & ~IPV6_LABEL_MASK) == 0) {
2536         int len = n;
2537
2538         *key = htonl(key_);
2539         if (mask) {
2540             if (ovs_scan(s + len, "/%i%n", &mask_, &n)
2541                 && (mask_ & ~IPV6_LABEL_MASK) == 0) {
2542                 len += n;
2543                 *mask = htonl(mask_);
2544             } else {
2545                 *mask = htonl(IPV6_LABEL_MASK);
2546             }
2547         }
2548         return len;
2549     }
2550     return 0;
2551 }
2552
2553 static int
2554 scan_u8(const char *s, uint8_t *key, uint8_t *mask)
2555 {
2556     int n;
2557
2558     if (ovs_scan(s, "%"SCNi8"%n", key, &n)) {
2559         int len = n;
2560
2561         if (mask) {
2562             if (ovs_scan(s + len, "/%"SCNi8"%n", mask, &n)) {
2563                 len += n;
2564             } else {
2565                 *mask = UINT8_MAX;
2566             }
2567         }
2568         return len;
2569     }
2570     return 0;
2571 }
2572
2573 static int
2574 scan_u32(const char *s, uint32_t *key, uint32_t *mask)
2575 {
2576     int n;
2577
2578     if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
2579         int len = n;
2580
2581         if (mask) {
2582             if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
2583                 len += n;
2584             } else {
2585                 *mask = UINT32_MAX;
2586             }
2587         }
2588         return len;
2589     }
2590     return 0;
2591 }
2592
2593 static int
2594 scan_be16(const char *s, ovs_be16 *key, ovs_be16 *mask)
2595 {
2596     uint16_t key_, mask_;
2597     int n;
2598
2599     if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
2600         int len = n;
2601
2602         *key = htons(key_);
2603         if (mask) {
2604             if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
2605                 len += n;
2606                 *mask = htons(mask_);
2607             } else {
2608                 *mask = OVS_BE16_MAX;
2609             }
2610         }
2611         return len;
2612     }
2613     return 0;
2614 }
2615
2616 static int
2617 scan_be64(const char *s, ovs_be64 *key, ovs_be64 *mask)
2618 {
2619     uint64_t key_, mask_;
2620     int n;
2621
2622     if (ovs_scan(s, "%"SCNi64"%n", &key_, &n)) {
2623         int len = n;
2624
2625         *key = htonll(key_);
2626         if (mask) {
2627             if (ovs_scan(s + len, "/%"SCNi64"%n", &mask_, &n)) {
2628                 len += n;
2629                 *mask = htonll(mask_);
2630             } else {
2631                 *mask = OVS_BE64_MAX;
2632             }
2633         }
2634         return len;
2635     }
2636     return 0;
2637 }
2638
2639 static int
2640 scan_tun_flags(const char *s, uint16_t *key, uint16_t *mask)
2641 {
2642     uint32_t flags, fmask;
2643     int n;
2644
2645     n = parse_flags(s, flow_tun_flag_to_string, &flags,
2646                     FLOW_TNL_F_MASK, mask ? &fmask : NULL);
2647     if (n >= 0 && s[n] == ')') {
2648         *key = flags;
2649         if (mask) {
2650             *mask = fmask;
2651         }
2652         return n + 1;
2653     }
2654     return 0;
2655 }
2656
2657 static int
2658 scan_tcp_flags(const char *s, ovs_be16 *key, ovs_be16 *mask)
2659 {
2660     uint32_t flags, fmask;
2661     int n;
2662
2663     n = parse_flags(s, packet_tcp_flag_to_string, &flags,
2664                     TCP_FLAGS(OVS_BE16_MAX), mask ? &fmask : NULL);
2665     if (n >= 0) {
2666         *key = htons(flags);
2667         if (mask) {
2668             *mask = htons(fmask);
2669         }
2670         return n;
2671     }
2672     return 0;
2673 }
2674
2675 static int
2676 scan_frag(const char *s, uint8_t *key, uint8_t *mask)
2677 {
2678     int n;
2679     char frag[8];
2680     enum ovs_frag_type frag_type;
2681
2682     if (ovs_scan(s, "%7[a-z]%n", frag, &n)
2683         && ovs_frag_type_from_string(frag, &frag_type)) {
2684         int len = n;
2685
2686         *key = frag_type;
2687         if (mask) {
2688             *mask = UINT8_MAX;
2689         }
2690         return len;
2691     }
2692     return 0;
2693 }
2694
2695 static int
2696 scan_port(const char *s, uint32_t *key, uint32_t *mask,
2697           const struct simap *port_names)
2698 {
2699     int n;
2700
2701     if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
2702         int len = n;
2703
2704         if (mask) {
2705             if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
2706                 len += n;
2707             } else {
2708                 *mask = UINT32_MAX;
2709             }
2710         }
2711         return len;
2712     } else if (port_names) {
2713         const struct simap_node *node;
2714         int len;
2715
2716         len = strcspn(s, ")");
2717         node = simap_find_len(port_names, s, len);
2718         if (node) {
2719             *key = node->data;
2720
2721             if (mask) {
2722                 *mask = UINT32_MAX;
2723             }
2724             return len;
2725         }
2726     }
2727     return 0;
2728 }
2729
2730 /* Helper for vlan parsing. */
2731 struct ovs_key_vlan__ {
2732     ovs_be16 tci;
2733 };
2734
2735 static bool
2736 set_be16_bf(ovs_be16 *bf, uint8_t bits, uint8_t offset, uint16_t value)
2737 {
2738     const uint16_t mask = ((1U << bits) - 1) << offset;
2739
2740     if (value >> bits) {
2741         return false;
2742     }
2743
2744     *bf = htons((ntohs(*bf) & ~mask) | (value << offset));
2745     return true;
2746 }
2747
2748 static int
2749 scan_be16_bf(const char *s, ovs_be16 *key, ovs_be16 *mask, uint8_t bits,
2750              uint8_t offset)
2751 {
2752     uint16_t key_, mask_;
2753     int n;
2754
2755     if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
2756         int len = n;
2757
2758         if (set_be16_bf(key, bits, offset, key_)) {
2759             if (mask) {
2760                 if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
2761                     len += n;
2762
2763                     if (!set_be16_bf(mask, bits, offset, mask_)) {
2764                         return 0;
2765                     }
2766                 } else {
2767                     *mask |= htons(((1U << bits) - 1) << offset);
2768                 }
2769             }
2770             return len;
2771         }
2772     }
2773     return 0;
2774 }
2775
2776 static int
2777 scan_vid(const char *s, ovs_be16 *key, ovs_be16 *mask)
2778 {
2779     return scan_be16_bf(s, key, mask, 12, VLAN_VID_SHIFT);
2780 }
2781
2782 static int
2783 scan_pcp(const char *s, ovs_be16 *key, ovs_be16 *mask)
2784 {
2785     return scan_be16_bf(s, key, mask, 3, VLAN_PCP_SHIFT);
2786 }
2787
2788 static int
2789 scan_cfi(const char *s, ovs_be16 *key, ovs_be16 *mask)
2790 {
2791     return scan_be16_bf(s, key, mask, 1, VLAN_CFI_SHIFT);
2792 }
2793
2794 /* For MPLS. */
2795 static bool
2796 set_be32_bf(ovs_be32 *bf, uint8_t bits, uint8_t offset, uint32_t value)
2797 {
2798     const uint32_t mask = ((1U << bits) - 1) << offset;
2799
2800     if (value >> bits) {
2801         return false;
2802     }
2803
2804     *bf = htonl((ntohl(*bf) & ~mask) | (value << offset));
2805     return true;
2806 }
2807
2808 static int
2809 scan_be32_bf(const char *s, ovs_be32 *key, ovs_be32 *mask, uint8_t bits,
2810              uint8_t offset)
2811 {
2812     uint32_t key_, mask_;
2813     int n;
2814
2815     if (ovs_scan(s, "%"SCNi32"%n", &key_, &n)) {
2816         int len = n;
2817
2818         if (set_be32_bf(key, bits, offset, key_)) {
2819             if (mask) {
2820                 if (ovs_scan(s + len, "/%"SCNi32"%n", &mask_, &n)) {
2821                     len += n;
2822
2823                     if (!set_be32_bf(mask, bits, offset, mask_)) {
2824                         return 0;
2825                     }
2826                 } else {
2827                     *mask |= htonl(((1U << bits) - 1) << offset);
2828                 }
2829             }
2830             return len;
2831         }
2832     }
2833     return 0;
2834 }
2835
2836 static int
2837 scan_mpls_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
2838 {
2839     return scan_be32_bf(s, key, mask, 20, MPLS_LABEL_SHIFT);
2840 }
2841
2842 static int
2843 scan_mpls_tc(const char *s, ovs_be32 *key, ovs_be32 *mask)
2844 {
2845     return scan_be32_bf(s, key, mask, 3, MPLS_TC_SHIFT);
2846 }
2847
2848 static int
2849 scan_mpls_ttl(const char *s, ovs_be32 *key, ovs_be32 *mask)
2850 {
2851     return scan_be32_bf(s, key, mask, 8, MPLS_TTL_SHIFT);
2852 }
2853
2854 static int
2855 scan_mpls_bos(const char *s, ovs_be32 *key, ovs_be32 *mask)
2856 {
2857     return scan_be32_bf(s, key, mask, 1, MPLS_BOS_SHIFT);
2858 }
2859
2860 static int
2861 scan_vxlan_gbp(const char *s, uint32_t *key, uint32_t *mask)
2862 {
2863     const char *s_base = s;
2864     ovs_be16 id = 0, id_mask = 0;
2865     uint8_t flags = 0, flags_mask = 0;
2866
2867     if (!strncmp(s, "id=", 3)) {
2868         s += 3;
2869         s += scan_be16(s, &id, mask ? &id_mask : NULL);
2870     }
2871
2872     if (s[0] == ',') {
2873         s++;
2874     }
2875     if (!strncmp(s, "flags=", 6)) {
2876         s += 6;
2877         s += scan_u8(s, &flags, mask ? &flags_mask : NULL);
2878     }
2879
2880     if (!strncmp(s, "))", 2)) {
2881         s += 2;
2882
2883         *key = (flags << 16) | ntohs(id);
2884         if (mask) {
2885             *mask = (flags_mask << 16) | ntohs(id_mask);
2886         }
2887
2888         return s - s_base;
2889     }
2890
2891     return 0;
2892 }
2893
2894 struct geneve_scan {
2895     struct geneve_opt d[63];
2896     int len;
2897 };
2898
2899 static int
2900 scan_geneve(const char *s, struct geneve_scan *key, struct geneve_scan *mask)
2901 {
2902     const char *s_base = s;
2903     struct geneve_opt *opt = key->d;
2904     struct geneve_opt *opt_mask = mask ? mask->d : NULL;
2905     int len_remain = sizeof key->d;
2906
2907     while (s[0] == '{' && len_remain >= sizeof *opt) {
2908         int data_len = 0;
2909
2910         s++;
2911         len_remain -= sizeof *opt;
2912
2913         if (!strncmp(s, "class=", 6)) {
2914             s += 6;
2915             s += scan_be16(s, &opt->opt_class,
2916                            mask ? &opt_mask->opt_class : NULL);
2917         } else if (mask) {
2918             memset(&opt_mask->opt_class, 0, sizeof opt_mask->opt_class);
2919         }
2920
2921         if (s[0] == ',') {
2922             s++;
2923         }
2924         if (!strncmp(s, "type=", 5)) {
2925             s += 5;
2926             s += scan_u8(s, &opt->type, mask ? &opt_mask->type : NULL);
2927         } else if (mask) {
2928             memset(&opt_mask->type, 0, sizeof opt_mask->type);
2929         }
2930
2931         if (s[0] == ',') {
2932             s++;
2933         }
2934         if (!strncmp(s, "len=", 4)) {
2935             uint8_t opt_len, opt_len_mask;
2936             s += 4;
2937             s += scan_u8(s, &opt_len, mask ? &opt_len_mask : NULL);
2938
2939             if (opt_len > 124 || opt_len % 4 || opt_len > len_remain) {
2940                 return 0;
2941             }
2942             opt->length = opt_len / 4;
2943             if (mask) {
2944                 opt_mask->length = opt_len_mask;
2945             }
2946             data_len = opt_len;
2947         } else if (mask) {
2948             memset(&opt_mask->type, 0, sizeof opt_mask->type);
2949         }
2950
2951         if (s[0] == ',') {
2952             s++;
2953         }
2954         if (parse_int_string(s, (uint8_t *)(opt + 1), data_len, (char **)&s)) {
2955             return 0;
2956         }
2957
2958         if (mask) {
2959             if (s[0] == '/') {
2960                 s++;
2961                 if (parse_int_string(s, (uint8_t *)(opt_mask + 1),
2962                                      data_len, (char **)&s)) {
2963                     return 0;
2964                 }
2965             }
2966             opt_mask->r1 = 0;
2967             opt_mask->r2 = 0;
2968             opt_mask->r3 = 0;
2969         }
2970
2971         if (s[0] == '}') {
2972             s++;
2973             opt += 1 + data_len / 4;
2974             if (mask) {
2975                 opt_mask += 1 + data_len / 4;
2976             }
2977             len_remain -= data_len;
2978         }
2979     }
2980
2981     if (s[0] == ')') {
2982         int len = sizeof key->d - len_remain;
2983
2984         s++;
2985         key->len = len;
2986         if (mask) {
2987             mask->len = len;
2988         }
2989         return s - s_base;
2990     }
2991
2992     return 0;
2993 }
2994
2995 static void
2996 tun_flags_to_attr(struct ofpbuf *a, const void *data_)
2997 {
2998     const uint16_t *flags = data_;
2999
3000     if (*flags & FLOW_TNL_F_DONT_FRAGMENT) {
3001         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
3002     }
3003     if (*flags & FLOW_TNL_F_CSUM) {
3004         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
3005     }
3006     if (*flags & FLOW_TNL_F_OAM) {
3007         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
3008     }
3009 }
3010
3011 static void
3012 vxlan_gbp_to_attr(struct ofpbuf *a, const void *data_)
3013 {
3014     const uint32_t *gbp = data_;
3015
3016     if (*gbp) {
3017         size_t vxlan_opts_ofs;
3018
3019         vxlan_opts_ofs = nl_msg_start_nested(a, OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS);
3020         nl_msg_put_u32(a, OVS_VXLAN_EXT_GBP, *gbp);
3021         nl_msg_end_nested(a, vxlan_opts_ofs);
3022     }
3023 }
3024
3025 static void
3026 geneve_to_attr(struct ofpbuf *a, const void *data_)
3027 {
3028     const struct geneve_scan *geneve = data_;
3029
3030     nl_msg_put_unspec(a, OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, geneve->d,
3031                       geneve->len);
3032 }
3033
3034 #define SCAN_PUT_ATTR(BUF, ATTR, DATA, FUNC)                      \
3035     {                                                             \
3036         unsigned long call_fn = (unsigned long)FUNC;              \
3037         if (call_fn) {                                            \
3038             typedef void (*fn)(struct ofpbuf *, const void *);    \
3039             fn func = FUNC;                                       \
3040             func(BUF, &(DATA));                                   \
3041         } else {                                                  \
3042             nl_msg_put_unspec(BUF, ATTR, &(DATA), sizeof (DATA)); \
3043         }                                                         \
3044     }
3045
3046 #define SCAN_IF(NAME)                           \
3047     if (strncmp(s, NAME, strlen(NAME)) == 0) {  \
3048         const char *start = s;                  \
3049         int len;                                \
3050                                                 \
3051         s += strlen(NAME)
3052
3053 /* Usually no special initialization is needed. */
3054 #define SCAN_BEGIN(NAME, TYPE)                  \
3055     SCAN_IF(NAME);                              \
3056         TYPE skey, smask;                       \
3057         memset(&skey, 0, sizeof skey);          \
3058         memset(&smask, 0, sizeof smask);        \
3059         do {                                    \
3060             len = 0;
3061
3062 /* Init as fully-masked as mask will not be scanned. */
3063 #define SCAN_BEGIN_FULLY_MASKED(NAME, TYPE)     \
3064     SCAN_IF(NAME);                              \
3065         TYPE skey, smask;                       \
3066         memset(&skey, 0, sizeof skey);          \
3067         memset(&smask, 0xff, sizeof smask);     \
3068         do {                                    \
3069             len = 0;
3070
3071 /* VLAN needs special initialization. */
3072 #define SCAN_BEGIN_INIT(NAME, TYPE, KEY_INIT, MASK_INIT)  \
3073     SCAN_IF(NAME);                                        \
3074         TYPE skey = KEY_INIT;                       \
3075         TYPE smask = MASK_INIT;                     \
3076         do {                                        \
3077             len = 0;
3078
3079 /* Scan unnamed entry as 'TYPE' */
3080 #define SCAN_TYPE(TYPE, KEY, MASK)              \
3081     len = scan_##TYPE(s, KEY, MASK);            \
3082     if (len == 0) {                             \
3083         return -EINVAL;                         \
3084     }                                           \
3085     s += len
3086
3087 /* Scan named ('NAME') entry 'FIELD' as 'TYPE'. */
3088 #define SCAN_FIELD(NAME, TYPE, FIELD)                                   \
3089     if (strncmp(s, NAME, strlen(NAME)) == 0) {                          \
3090         s += strlen(NAME);                                              \
3091         SCAN_TYPE(TYPE, &skey.FIELD, mask ? &smask.FIELD : NULL);       \
3092         continue;                                                       \
3093     }
3094
3095 #define SCAN_FINISH()                           \
3096         } while (*s++ == ',' && len != 0);      \
3097         if (s[-1] != ')') {                     \
3098             return -EINVAL;                     \
3099         }
3100
3101 #define SCAN_FINISH_SINGLE()                    \
3102         } while (false);                        \
3103         if (*s++ != ')') {                      \
3104             return -EINVAL;                     \
3105         }
3106
3107 /* Beginning of nested attribute. */
3108 #define SCAN_BEGIN_NESTED(NAME, ATTR)                      \
3109     SCAN_IF(NAME);                                         \
3110         size_t key_offset, mask_offset;                    \
3111         key_offset = nl_msg_start_nested(key, ATTR);       \
3112         if (mask) {                                        \
3113             mask_offset = nl_msg_start_nested(mask, ATTR); \
3114         }                                                  \
3115         do {                                               \
3116             len = 0;
3117
3118 #define SCAN_END_NESTED()                               \
3119         SCAN_FINISH();                                  \
3120         nl_msg_end_nested(key, key_offset);             \
3121         if (mask) {                                     \
3122             nl_msg_end_nested(mask, mask_offset);       \
3123         }                                               \
3124         return s - start;                               \
3125     }
3126
3127 #define SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, FUNC)  \
3128     if (strncmp(s, NAME, strlen(NAME)) == 0) {                \
3129         TYPE skey, smask;                                     \
3130         memset(&skey, 0, sizeof skey);                        \
3131         memset(&smask, 0xff, sizeof smask);                   \
3132         s += strlen(NAME);                                    \
3133         SCAN_TYPE(SCAN_AS, &skey, &smask);                    \
3134         SCAN_PUT(ATTR, FUNC);                                 \
3135         continue;                                             \
3136     }
3137
3138 #define SCAN_FIELD_NESTED(NAME, TYPE, SCAN_AS, ATTR)  \
3139         SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, NULL)
3140
3141 #define SCAN_FIELD_NESTED_FUNC(NAME, TYPE, SCAN_AS, FUNC)  \
3142         SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, 0, FUNC)
3143
3144 #define SCAN_PUT(ATTR, FUNC)                            \
3145         if (!mask || !is_all_zeros(&smask, sizeof smask)) { \
3146             SCAN_PUT_ATTR(key, ATTR, skey, FUNC);       \
3147             if (mask) {                                 \
3148                 SCAN_PUT_ATTR(mask, ATTR, smask, FUNC); \
3149             }                                           \
3150         }
3151
3152 #define SCAN_END(ATTR)                                  \
3153         SCAN_FINISH();                                  \
3154         SCAN_PUT(ATTR, NULL);                           \
3155         return s - start;                               \
3156     }
3157
3158 #define SCAN_END_SINGLE(ATTR)                           \
3159         SCAN_FINISH_SINGLE();                           \
3160         SCAN_PUT(ATTR, NULL);                           \
3161         return s - start;                               \
3162     }
3163
3164 #define SCAN_SINGLE(NAME, TYPE, SCAN_AS, ATTR)       \
3165     SCAN_BEGIN(NAME, TYPE) {                         \
3166         SCAN_TYPE(SCAN_AS, &skey, &smask);           \
3167     } SCAN_END_SINGLE(ATTR)
3168
3169 #define SCAN_SINGLE_FULLY_MASKED(NAME, TYPE, SCAN_AS, ATTR) \
3170     SCAN_BEGIN_FULLY_MASKED(NAME, TYPE) {                   \
3171         SCAN_TYPE(SCAN_AS, &skey, NULL);                    \
3172     } SCAN_END_SINGLE(ATTR)
3173
3174 /* scan_port needs one extra argument. */
3175 #define SCAN_SINGLE_PORT(NAME, TYPE, ATTR)  \
3176     SCAN_BEGIN(NAME, TYPE) {                            \
3177         len = scan_port(s, &skey, &smask, port_names);  \
3178         if (len == 0) {                                 \
3179             return -EINVAL;                             \
3180         }                                               \
3181         s += len;                                       \
3182     } SCAN_END_SINGLE(ATTR)
3183
3184 static int
3185 parse_odp_key_mask_attr(const char *s, const struct simap *port_names,
3186                         struct ofpbuf *key, struct ofpbuf *mask)
3187 {
3188     ovs_u128 ufid;
3189     int len;
3190
3191     /* Skip UFID. */
3192     len = odp_ufid_from_string(s, &ufid);
3193     if (len) {
3194         return len;
3195     }
3196
3197     SCAN_SINGLE("skb_priority(", uint32_t, u32, OVS_KEY_ATTR_PRIORITY);
3198     SCAN_SINGLE("skb_mark(", uint32_t, u32, OVS_KEY_ATTR_SKB_MARK);
3199     SCAN_SINGLE_FULLY_MASKED("recirc_id(", uint32_t, u32,
3200                              OVS_KEY_ATTR_RECIRC_ID);
3201     SCAN_SINGLE("dp_hash(", uint32_t, u32, OVS_KEY_ATTR_DP_HASH);
3202
3203     SCAN_BEGIN_NESTED("tunnel(", OVS_KEY_ATTR_TUNNEL) {
3204         SCAN_FIELD_NESTED("tun_id=", ovs_be64, be64, OVS_TUNNEL_KEY_ATTR_ID);
3205         SCAN_FIELD_NESTED("src=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_SRC);
3206         SCAN_FIELD_NESTED("dst=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_DST);
3207         SCAN_FIELD_NESTED("tos=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TOS);
3208         SCAN_FIELD_NESTED("ttl=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TTL);
3209         SCAN_FIELD_NESTED("tp_src=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_SRC);
3210         SCAN_FIELD_NESTED("tp_dst=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_DST);
3211         SCAN_FIELD_NESTED_FUNC("vxlan(gbp(", uint32_t, vxlan_gbp, vxlan_gbp_to_attr);
3212         SCAN_FIELD_NESTED_FUNC("geneve(", struct geneve_scan, geneve,
3213                                geneve_to_attr);
3214         SCAN_FIELD_NESTED_FUNC("flags(", uint16_t, tun_flags, tun_flags_to_attr);
3215     } SCAN_END_NESTED();
3216
3217     SCAN_SINGLE_PORT("in_port(", uint32_t, OVS_KEY_ATTR_IN_PORT);
3218
3219     SCAN_BEGIN("eth(", struct ovs_key_ethernet) {
3220         SCAN_FIELD("src=", eth, eth_src);
3221         SCAN_FIELD("dst=", eth, eth_dst);
3222     } SCAN_END(OVS_KEY_ATTR_ETHERNET);
3223
3224     SCAN_BEGIN_INIT("vlan(", struct ovs_key_vlan__,
3225                     { htons(VLAN_CFI) }, { htons(VLAN_CFI) }) {
3226         SCAN_FIELD("vid=", vid, tci);
3227         SCAN_FIELD("pcp=", pcp, tci);
3228         SCAN_FIELD("cfi=", cfi, tci);
3229     } SCAN_END(OVS_KEY_ATTR_VLAN);
3230
3231     SCAN_SINGLE("eth_type(", ovs_be16, be16, OVS_KEY_ATTR_ETHERTYPE);
3232
3233     SCAN_BEGIN("mpls(", struct ovs_key_mpls) {
3234         SCAN_FIELD("label=", mpls_label, mpls_lse);
3235         SCAN_FIELD("tc=", mpls_tc, mpls_lse);
3236         SCAN_FIELD("ttl=", mpls_ttl, mpls_lse);
3237         SCAN_FIELD("bos=", mpls_bos, mpls_lse);
3238     } SCAN_END(OVS_KEY_ATTR_MPLS);
3239
3240     SCAN_BEGIN("ipv4(", struct ovs_key_ipv4) {
3241         SCAN_FIELD("src=", ipv4, ipv4_src);
3242         SCAN_FIELD("dst=", ipv4, ipv4_dst);
3243         SCAN_FIELD("proto=", u8, ipv4_proto);
3244         SCAN_FIELD("tos=", u8, ipv4_tos);
3245         SCAN_FIELD("ttl=", u8, ipv4_ttl);
3246         SCAN_FIELD("frag=", frag, ipv4_frag);
3247     } SCAN_END(OVS_KEY_ATTR_IPV4);
3248
3249     SCAN_BEGIN("ipv6(", struct ovs_key_ipv6) {
3250         SCAN_FIELD("src=", ipv6, ipv6_src);
3251         SCAN_FIELD("dst=", ipv6, ipv6_dst);
3252         SCAN_FIELD("label=", ipv6_label, ipv6_label);
3253         SCAN_FIELD("proto=", u8, ipv6_proto);
3254         SCAN_FIELD("tclass=", u8, ipv6_tclass);
3255         SCAN_FIELD("hlimit=", u8, ipv6_hlimit);
3256         SCAN_FIELD("frag=", frag, ipv6_frag);
3257     } SCAN_END(OVS_KEY_ATTR_IPV6);
3258
3259     SCAN_BEGIN("tcp(", struct ovs_key_tcp) {
3260         SCAN_FIELD("src=", be16, tcp_src);
3261         SCAN_FIELD("dst=", be16, tcp_dst);
3262     } SCAN_END(OVS_KEY_ATTR_TCP);
3263
3264     SCAN_SINGLE("tcp_flags(", ovs_be16, tcp_flags, OVS_KEY_ATTR_TCP_FLAGS);
3265
3266     SCAN_BEGIN("udp(", struct ovs_key_udp) {
3267         SCAN_FIELD("src=", be16, udp_src);
3268         SCAN_FIELD("dst=", be16, udp_dst);
3269     } SCAN_END(OVS_KEY_ATTR_UDP);
3270
3271     SCAN_BEGIN("sctp(", struct ovs_key_sctp) {
3272         SCAN_FIELD("src=", be16, sctp_src);
3273         SCAN_FIELD("dst=", be16, sctp_dst);
3274     } SCAN_END(OVS_KEY_ATTR_SCTP);
3275
3276     SCAN_BEGIN("icmp(", struct ovs_key_icmp) {
3277         SCAN_FIELD("type=", u8, icmp_type);
3278         SCAN_FIELD("code=", u8, icmp_code);
3279     } SCAN_END(OVS_KEY_ATTR_ICMP);
3280
3281     SCAN_BEGIN("icmpv6(", struct ovs_key_icmpv6) {
3282         SCAN_FIELD("type=", u8, icmpv6_type);
3283         SCAN_FIELD("code=", u8, icmpv6_code);
3284     } SCAN_END(OVS_KEY_ATTR_ICMPV6);
3285
3286     SCAN_BEGIN("arp(", struct ovs_key_arp) {
3287         SCAN_FIELD("sip=", ipv4, arp_sip);
3288         SCAN_FIELD("tip=", ipv4, arp_tip);
3289         SCAN_FIELD("op=", be16, arp_op);
3290         SCAN_FIELD("sha=", eth, arp_sha);
3291         SCAN_FIELD("tha=", eth, arp_tha);
3292     } SCAN_END(OVS_KEY_ATTR_ARP);
3293
3294     SCAN_BEGIN("nd(", struct ovs_key_nd) {
3295         SCAN_FIELD("target=", ipv6, nd_target);
3296         SCAN_FIELD("sll=", eth, nd_sll);
3297         SCAN_FIELD("tll=", eth, nd_tll);
3298     } SCAN_END(OVS_KEY_ATTR_ND);
3299
3300     /* Encap open-coded. */
3301     if (!strncmp(s, "encap(", 6)) {
3302         const char *start = s;
3303         size_t encap, encap_mask = 0;
3304
3305         encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
3306         if (mask) {
3307             encap_mask = nl_msg_start_nested(mask, OVS_KEY_ATTR_ENCAP);
3308         }
3309
3310         s += 6;
3311         for (;;) {
3312             int retval;
3313
3314             s += strspn(s, delimiters);
3315             if (!*s) {
3316                 return -EINVAL;
3317             } else if (*s == ')') {
3318                 break;
3319             }
3320
3321             retval = parse_odp_key_mask_attr(s, port_names, key, mask);
3322             if (retval < 0) {
3323                 return retval;
3324             }
3325             s += retval;
3326         }
3327         s++;
3328
3329         nl_msg_end_nested(key, encap);
3330         if (mask) {
3331             nl_msg_end_nested(mask, encap_mask);
3332         }
3333
3334         return s - start;
3335     }
3336
3337     return -EINVAL;
3338 }
3339
3340 /* Parses the string representation of a datapath flow key, in the
3341  * format output by odp_flow_key_format().  Returns 0 if successful,
3342  * otherwise a positive errno value.  On success, the flow key is
3343  * appended to 'key' as a series of Netlink attributes.  On failure, no
3344  * data is appended to 'key'.  Either way, 'key''s data might be
3345  * reallocated.
3346  *
3347  * If 'port_names' is nonnull, it points to an simap that maps from a port name
3348  * to a port number.  (Port names may be used instead of port numbers in
3349  * in_port.)
3350  *
3351  * On success, the attributes appended to 'key' are individually syntactically
3352  * valid, but they may not be valid as a sequence.  'key' might, for example,
3353  * have duplicated keys.  odp_flow_key_to_flow() will detect those errors. */
3354 int
3355 odp_flow_from_string(const char *s, const struct simap *port_names,
3356                      struct ofpbuf *key, struct ofpbuf *mask)
3357 {
3358     const size_t old_size = key->size;
3359     for (;;) {
3360         int retval;
3361
3362         s += strspn(s, delimiters);
3363         if (!*s) {
3364             return 0;
3365         }
3366
3367         retval = parse_odp_key_mask_attr(s, port_names, key, mask);
3368         if (retval < 0) {
3369             key->size = old_size;
3370             return -retval;
3371         }
3372         s += retval;
3373     }
3374
3375     return 0;
3376 }
3377
3378 static uint8_t
3379 ovs_to_odp_frag(uint8_t nw_frag, bool is_mask)
3380 {
3381     if (is_mask) {
3382         /* Netlink interface 'enum ovs_frag_type' is an 8-bit enumeration type,
3383          * not a set of flags or bitfields. Hence, if the struct flow nw_frag
3384          * mask, which is a set of bits, has the FLOW_NW_FRAG_ANY as zero, we
3385          * must use a zero mask for the netlink frag field, and all ones mask
3386          * otherwise. */
3387         return (nw_frag & FLOW_NW_FRAG_ANY) ? UINT8_MAX : 0;
3388     }
3389     return !(nw_frag & FLOW_NW_FRAG_ANY) ? OVS_FRAG_TYPE_NONE
3390         : nw_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
3391         : OVS_FRAG_TYPE_FIRST;
3392 }
3393
3394 static void get_ethernet_key(const struct flow *, struct ovs_key_ethernet *);
3395 static void put_ethernet_key(const struct ovs_key_ethernet *, struct flow *);
3396 static void get_ipv4_key(const struct flow *, struct ovs_key_ipv4 *,
3397                          bool is_mask);
3398 static void put_ipv4_key(const struct ovs_key_ipv4 *, struct flow *,
3399                          bool is_mask);
3400 static void get_ipv6_key(const struct flow *, struct ovs_key_ipv6 *,
3401                          bool is_mask);
3402 static void put_ipv6_key(const struct ovs_key_ipv6 *, struct flow *,
3403                          bool is_mask);
3404 static void get_arp_key(const struct flow *, struct ovs_key_arp *);
3405 static void put_arp_key(const struct ovs_key_arp *, struct flow *);
3406 static void get_nd_key(const struct flow *, struct ovs_key_nd *);
3407 static void put_nd_key(const struct ovs_key_nd *, struct flow *);
3408
3409 /* These share the same layout. */
3410 union ovs_key_tp {
3411     struct ovs_key_tcp tcp;
3412     struct ovs_key_udp udp;
3413     struct ovs_key_sctp sctp;
3414 };
3415
3416 static void get_tp_key(const struct flow *, union ovs_key_tp *);
3417 static void put_tp_key(const union ovs_key_tp *, struct flow *);
3418
3419 static void
3420 odp_flow_key_from_flow__(const struct odp_flow_key_parms *parms,
3421                          bool export_mask, struct ofpbuf *buf)
3422 {
3423     struct ovs_key_ethernet *eth_key;
3424     size_t encap;
3425     const struct flow *flow = parms->flow;
3426     const struct flow *data = export_mask ? parms->mask : parms->flow;
3427
3428     nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, data->skb_priority);
3429
3430     if (flow->tunnel.ip_dst || export_mask) {
3431         tun_key_to_attr(buf, &data->tunnel);
3432     }
3433
3434     nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, data->pkt_mark);
3435
3436     if (parms->recirc) {
3437         nl_msg_put_u32(buf, OVS_KEY_ATTR_RECIRC_ID, data->recirc_id);
3438         nl_msg_put_u32(buf, OVS_KEY_ATTR_DP_HASH, data->dp_hash);
3439     }
3440
3441     /* Add an ingress port attribute if this is a mask or 'odp_in_port'
3442      * is not the magical value "ODPP_NONE". */
3443     if (export_mask || parms->odp_in_port != ODPP_NONE) {
3444         nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, parms->odp_in_port);
3445     }
3446
3447     eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
3448                                        sizeof *eth_key);
3449     get_ethernet_key(data, eth_key);
3450
3451     if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
3452         if (export_mask) {
3453             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
3454         } else {
3455             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
3456         }
3457         nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, data->vlan_tci);
3458         encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
3459         if (flow->vlan_tci == htons(0)) {
3460             goto unencap;
3461         }
3462     } else {
3463         encap = 0;
3464     }
3465
3466     if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
3467         /* For backwards compatibility with kernels that don't support
3468          * wildcarding, the following convention is used to encode the
3469          * OVS_KEY_ATTR_ETHERTYPE for key and mask:
3470          *
3471          *   key      mask    matches
3472          * -------- --------  -------
3473          *  >0x5ff   0xffff   Specified Ethernet II Ethertype.
3474          *  >0x5ff      0     Any Ethernet II or non-Ethernet II frame.
3475          *  <none>   0xffff   Any non-Ethernet II frame (except valid
3476          *                    802.3 SNAP packet with valid eth_type).
3477          */
3478         if (export_mask) {
3479             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
3480         }
3481         goto unencap;
3482     }
3483
3484     nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, data->dl_type);
3485
3486     if (flow->dl_type == htons(ETH_TYPE_IP)) {
3487         struct ovs_key_ipv4 *ipv4_key;
3488
3489         ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
3490                                             sizeof *ipv4_key);
3491         get_ipv4_key(data, ipv4_key, export_mask);
3492     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
3493         struct ovs_key_ipv6 *ipv6_key;
3494
3495         ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
3496                                             sizeof *ipv6_key);
3497         get_ipv6_key(data, ipv6_key, export_mask);
3498     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
3499                flow->dl_type == htons(ETH_TYPE_RARP)) {
3500         struct ovs_key_arp *arp_key;
3501
3502         arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
3503                                            sizeof *arp_key);
3504         get_arp_key(data, arp_key);
3505     } else if (eth_type_mpls(flow->dl_type)) {
3506         struct ovs_key_mpls *mpls_key;
3507         int i, n;
3508
3509         n = flow_count_mpls_labels(flow, NULL);
3510         if (export_mask) {
3511             n = MIN(n, parms->max_mpls_depth);
3512         }
3513         mpls_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_MPLS,
3514                                             n * sizeof *mpls_key);
3515         for (i = 0; i < n; i++) {
3516             mpls_key[i].mpls_lse = data->mpls_lse[i];
3517         }
3518     }
3519
3520     if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3521         if (flow->nw_proto == IPPROTO_TCP) {
3522             union ovs_key_tp *tcp_key;
3523
3524             tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
3525                                                sizeof *tcp_key);
3526             get_tp_key(data, tcp_key);
3527             if (data->tcp_flags) {
3528                 nl_msg_put_be16(buf, OVS_KEY_ATTR_TCP_FLAGS, data->tcp_flags);
3529             }
3530         } else if (flow->nw_proto == IPPROTO_UDP) {
3531             union ovs_key_tp *udp_key;
3532
3533             udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
3534                                                sizeof *udp_key);
3535             get_tp_key(data, udp_key);
3536         } else if (flow->nw_proto == IPPROTO_SCTP) {
3537             union ovs_key_tp *sctp_key;
3538
3539             sctp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_SCTP,
3540                                                sizeof *sctp_key);
3541             get_tp_key(data, sctp_key);
3542         } else if (flow->dl_type == htons(ETH_TYPE_IP)
3543                 && flow->nw_proto == IPPROTO_ICMP) {
3544             struct ovs_key_icmp *icmp_key;
3545
3546             icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
3547                                                 sizeof *icmp_key);
3548             icmp_key->icmp_type = ntohs(data->tp_src);
3549             icmp_key->icmp_code = ntohs(data->tp_dst);
3550         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
3551                 && flow->nw_proto == IPPROTO_ICMPV6) {
3552             struct ovs_key_icmpv6 *icmpv6_key;
3553
3554             icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
3555                                                   sizeof *icmpv6_key);
3556             icmpv6_key->icmpv6_type = ntohs(data->tp_src);
3557             icmpv6_key->icmpv6_code = ntohs(data->tp_dst);
3558
3559             if (flow->tp_dst == htons(0)
3560                 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
3561                     || flow->tp_src == htons(ND_NEIGHBOR_ADVERT))
3562                 && (!export_mask || (data->tp_src == htons(0xffff)
3563                                      && data->tp_dst == htons(0xffff)))) {
3564
3565                 struct ovs_key_nd *nd_key;
3566
3567                 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
3568                                                     sizeof *nd_key);
3569                 memcpy(nd_key->nd_target, &data->nd_target,
3570                         sizeof nd_key->nd_target);
3571                 memcpy(nd_key->nd_sll, data->arp_sha, ETH_ADDR_LEN);
3572                 memcpy(nd_key->nd_tll, data->arp_tha, ETH_ADDR_LEN);
3573             }
3574         }
3575     }
3576
3577 unencap:
3578     if (encap) {
3579         nl_msg_end_nested(buf, encap);
3580     }
3581 }
3582
3583 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'.
3584  *
3585  * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
3586  * capable of being expanded to allow for that much space. */
3587 void
3588 odp_flow_key_from_flow(const struct odp_flow_key_parms *parms,
3589                        struct ofpbuf *buf)
3590 {
3591     odp_flow_key_from_flow__(parms, false, buf);
3592 }
3593
3594 /* Appends a representation of 'mask' as OVS_KEY_ATTR_* attributes to
3595  * 'buf'.
3596  *
3597  * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
3598  * capable of being expanded to allow for that much space. */
3599 void
3600 odp_flow_key_from_mask(const struct odp_flow_key_parms *parms,
3601                        struct ofpbuf *buf)
3602 {
3603     odp_flow_key_from_flow__(parms, true, buf);
3604 }
3605
3606 /* Generate ODP flow key from the given packet metadata */
3607 void
3608 odp_key_from_pkt_metadata(struct ofpbuf *buf, const struct pkt_metadata *md)
3609 {
3610     nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, md->skb_priority);
3611
3612     if (md->tunnel.ip_dst) {
3613         tun_key_to_attr(buf, &md->tunnel);
3614     }
3615
3616     nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, md->pkt_mark);
3617
3618     /* Add an ingress port attribute if 'odp_in_port' is not the magical
3619      * value "ODPP_NONE". */
3620     if (md->in_port.odp_port != ODPP_NONE) {
3621         nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, md->in_port.odp_port);
3622     }
3623 }
3624
3625 /* Generate packet metadata from the given ODP flow key. */
3626 void
3627 odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len,
3628                         struct pkt_metadata *md)
3629 {
3630     const struct nlattr *nla;
3631     size_t left;
3632     uint32_t wanted_attrs = 1u << OVS_KEY_ATTR_PRIORITY |
3633         1u << OVS_KEY_ATTR_SKB_MARK | 1u << OVS_KEY_ATTR_TUNNEL |
3634         1u << OVS_KEY_ATTR_IN_PORT;
3635
3636     *md = PKT_METADATA_INITIALIZER(ODPP_NONE);
3637
3638     NL_ATTR_FOR_EACH (nla, left, key, key_len) {
3639         uint16_t type = nl_attr_type(nla);
3640         size_t len = nl_attr_get_size(nla);
3641         int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
3642                                             OVS_KEY_ATTR_MAX, type);
3643
3644         if (len != expected_len && expected_len >= 0) {
3645             continue;
3646         }
3647
3648         switch (type) {
3649         case OVS_KEY_ATTR_RECIRC_ID:
3650             md->recirc_id = nl_attr_get_u32(nla);
3651             wanted_attrs &= ~(1u << OVS_KEY_ATTR_RECIRC_ID);
3652             break;
3653         case OVS_KEY_ATTR_DP_HASH:
3654             md->dp_hash = nl_attr_get_u32(nla);
3655             wanted_attrs &= ~(1u << OVS_KEY_ATTR_DP_HASH);
3656             break;
3657         case OVS_KEY_ATTR_PRIORITY:
3658             md->skb_priority = nl_attr_get_u32(nla);
3659             wanted_attrs &= ~(1u << OVS_KEY_ATTR_PRIORITY);
3660             break;
3661         case OVS_KEY_ATTR_SKB_MARK:
3662             md->pkt_mark = nl_attr_get_u32(nla);
3663             wanted_attrs &= ~(1u << OVS_KEY_ATTR_SKB_MARK);
3664             break;
3665         case OVS_KEY_ATTR_TUNNEL: {
3666             enum odp_key_fitness res;
3667
3668             res = odp_tun_key_from_attr(nla, &md->tunnel);
3669             if (res == ODP_FIT_ERROR) {
3670                 memset(&md->tunnel, 0, sizeof md->tunnel);
3671             } else if (res == ODP_FIT_PERFECT) {
3672                 wanted_attrs &= ~(1u << OVS_KEY_ATTR_TUNNEL);
3673             }
3674             break;
3675         }
3676         case OVS_KEY_ATTR_IN_PORT:
3677             md->in_port.odp_port = nl_attr_get_odp_port(nla);
3678             wanted_attrs &= ~(1u << OVS_KEY_ATTR_IN_PORT);
3679             break;
3680         default:
3681             break;
3682         }
3683
3684         if (!wanted_attrs) {
3685             return; /* Have everything. */
3686         }
3687     }
3688 }
3689
3690 uint32_t
3691 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
3692 {
3693     BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
3694     return hash_words(ALIGNED_CAST(const uint32_t *, key),
3695                       key_len / sizeof(uint32_t), 0);
3696 }
3697
3698 static void
3699 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
3700                        uint64_t attrs, int out_of_range_attr,
3701                        const struct nlattr *key, size_t key_len)
3702 {
3703     struct ds s;
3704     int i;
3705
3706     if (VLOG_DROP_DBG(rl)) {
3707         return;
3708     }
3709
3710     ds_init(&s);
3711     for (i = 0; i < 64; i++) {
3712         if (attrs & (UINT64_C(1) << i)) {
3713             char namebuf[OVS_KEY_ATTR_BUFSIZE];
3714
3715             ds_put_format(&s, " %s",
3716                           ovs_key_attr_to_string(i, namebuf, sizeof namebuf));
3717         }
3718     }
3719     if (out_of_range_attr) {
3720         ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
3721     }
3722
3723     ds_put_cstr(&s, ": ");
3724     odp_flow_key_format(key, key_len, &s);
3725
3726     VLOG_DBG("%s:%s", title, ds_cstr(&s));
3727     ds_destroy(&s);
3728 }
3729
3730 static uint8_t
3731 odp_to_ovs_frag(uint8_t odp_frag, bool is_mask)
3732 {
3733     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3734
3735     if (is_mask) {
3736         return odp_frag ? FLOW_NW_FRAG_MASK : 0;
3737     }
3738
3739     if (odp_frag > OVS_FRAG_TYPE_LATER) {
3740         VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
3741         return 0xff; /* Error. */
3742     }
3743
3744     return (odp_frag == OVS_FRAG_TYPE_NONE) ? 0
3745         : (odp_frag == OVS_FRAG_TYPE_FIRST) ? FLOW_NW_FRAG_ANY
3746         :  FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER;
3747 }
3748
3749 static bool
3750 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
3751                    const struct nlattr *attrs[], uint64_t *present_attrsp,
3752                    int *out_of_range_attrp)
3753 {
3754     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3755     const struct nlattr *nla;
3756     uint64_t present_attrs;
3757     size_t left;
3758
3759     BUILD_ASSERT(OVS_KEY_ATTR_MAX < CHAR_BIT * sizeof present_attrs);
3760     present_attrs = 0;
3761     *out_of_range_attrp = 0;
3762     NL_ATTR_FOR_EACH (nla, left, key, key_len) {
3763         uint16_t type = nl_attr_type(nla);
3764         size_t len = nl_attr_get_size(nla);
3765         int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
3766                                             OVS_KEY_ATTR_MAX, type);
3767
3768         if (len != expected_len && expected_len >= 0) {
3769             char namebuf[OVS_KEY_ATTR_BUFSIZE];
3770
3771             VLOG_ERR_RL(&rl, "attribute %s has length %"PRIuSIZE" but should have "
3772                         "length %d", ovs_key_attr_to_string(type, namebuf,
3773                                                             sizeof namebuf),
3774                         len, expected_len);
3775             return false;
3776         }
3777
3778         if (type > OVS_KEY_ATTR_MAX) {
3779             *out_of_range_attrp = type;
3780         } else {
3781             if (present_attrs & (UINT64_C(1) << type)) {
3782                 char namebuf[OVS_KEY_ATTR_BUFSIZE];
3783
3784                 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
3785                             ovs_key_attr_to_string(type,
3786                                                    namebuf, sizeof namebuf));
3787                 return false;
3788             }
3789
3790             present_attrs |= UINT64_C(1) << type;
3791             attrs[type] = nla;
3792         }
3793     }
3794     if (left) {
3795         VLOG_ERR_RL(&rl, "trailing garbage in flow key");
3796         return false;
3797     }
3798
3799     *present_attrsp = present_attrs;
3800     return true;
3801 }
3802
3803 static enum odp_key_fitness
3804 check_expectations(uint64_t present_attrs, int out_of_range_attr,
3805                    uint64_t expected_attrs,
3806                    const struct nlattr *key, size_t key_len)
3807 {
3808     uint64_t missing_attrs;
3809     uint64_t extra_attrs;
3810
3811     missing_attrs = expected_attrs & ~present_attrs;
3812     if (missing_attrs) {
3813         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3814         log_odp_key_attributes(&rl, "expected but not present",
3815                                missing_attrs, 0, key, key_len);
3816         return ODP_FIT_TOO_LITTLE;
3817     }
3818
3819     extra_attrs = present_attrs & ~expected_attrs;
3820     if (extra_attrs || out_of_range_attr) {
3821         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3822         log_odp_key_attributes(&rl, "present but not expected",
3823                                extra_attrs, out_of_range_attr, key, key_len);
3824         return ODP_FIT_TOO_MUCH;
3825     }
3826
3827     return ODP_FIT_PERFECT;
3828 }
3829
3830 static bool
3831 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
3832                 uint64_t present_attrs, uint64_t *expected_attrs,
3833                 struct flow *flow, const struct flow *src_flow)
3834 {
3835     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3836     bool is_mask = flow != src_flow;
3837
3838     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
3839         flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
3840         if (!is_mask && ntohs(flow->dl_type) < ETH_TYPE_MIN) {
3841             VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
3842                         ntohs(flow->dl_type));
3843             return false;
3844         }
3845         if (is_mask && ntohs(src_flow->dl_type) < ETH_TYPE_MIN &&
3846             flow->dl_type != htons(0xffff)) {
3847             return false;
3848         }
3849         *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
3850     } else {
3851         if (!is_mask) {
3852             flow->dl_type = htons(FLOW_DL_TYPE_NONE);
3853         } else if (ntohs(src_flow->dl_type) < ETH_TYPE_MIN) {
3854             /* See comments in odp_flow_key_from_flow__(). */
3855             VLOG_ERR_RL(&rl, "mask expected for non-Ethernet II frame");
3856             return false;
3857         }
3858     }
3859     return true;
3860 }
3861
3862 static enum odp_key_fitness
3863 parse_l2_5_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
3864                   uint64_t present_attrs, int out_of_range_attr,
3865                   uint64_t expected_attrs, struct flow *flow,
3866                   const struct nlattr *key, size_t key_len,
3867                   const struct flow *src_flow)
3868 {
3869     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3870     bool is_mask = src_flow != flow;
3871     const void *check_start = NULL;
3872     size_t check_len = 0;
3873     enum ovs_key_attr expected_bit = 0xff;
3874
3875     if (eth_type_mpls(src_flow->dl_type)) {
3876         if (!is_mask || present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
3877             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
3878         }
3879         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
3880             size_t size = nl_attr_get_size(attrs[OVS_KEY_ATTR_MPLS]);
3881             const ovs_be32 *mpls_lse = nl_attr_get(attrs[OVS_KEY_ATTR_MPLS]);
3882             int n = size / sizeof(ovs_be32);
3883             int i;
3884
3885             if (!size || size % sizeof(ovs_be32)) {
3886                 return ODP_FIT_ERROR;
3887             }
3888             if (flow->mpls_lse[0] && flow->dl_type != htons(0xffff)) {
3889                 return ODP_FIT_ERROR;
3890             }
3891
3892             for (i = 0; i < n && i < FLOW_MAX_MPLS_LABELS; i++) {
3893                 flow->mpls_lse[i] = mpls_lse[i];
3894             }
3895             if (n > FLOW_MAX_MPLS_LABELS) {
3896                 return ODP_FIT_TOO_MUCH;
3897             }
3898
3899             if (!is_mask) {
3900                 /* BOS may be set only in the innermost label. */
3901                 for (i = 0; i < n - 1; i++) {
3902                     if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
3903                         return ODP_FIT_ERROR;
3904                     }
3905                 }
3906
3907                 /* BOS must be set in the innermost label. */
3908                 if (n < FLOW_MAX_MPLS_LABELS
3909                     && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
3910                     return ODP_FIT_TOO_LITTLE;
3911                 }
3912             }
3913         }
3914
3915         goto done;
3916     } else if (src_flow->dl_type == htons(ETH_TYPE_IP)) {
3917         if (!is_mask) {
3918             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
3919         }
3920         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
3921             const struct ovs_key_ipv4 *ipv4_key;
3922
3923             ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
3924             put_ipv4_key(ipv4_key, flow, is_mask);
3925             if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
3926                 return ODP_FIT_ERROR;
3927             }
3928             if (is_mask) {
3929                 check_start = ipv4_key;
3930                 check_len = sizeof *ipv4_key;
3931                 expected_bit = OVS_KEY_ATTR_IPV4;
3932             }
3933         }
3934     } else if (src_flow->dl_type == htons(ETH_TYPE_IPV6)) {
3935         if (!is_mask) {
3936             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
3937         }
3938         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
3939             const struct ovs_key_ipv6 *ipv6_key;
3940
3941             ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
3942             put_ipv6_key(ipv6_key, flow, is_mask);
3943             if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
3944                 return ODP_FIT_ERROR;
3945             }
3946             if (is_mask) {
3947                 check_start = ipv6_key;
3948                 check_len = sizeof *ipv6_key;
3949                 expected_bit = OVS_KEY_ATTR_IPV6;
3950             }
3951         }
3952     } else if (src_flow->dl_type == htons(ETH_TYPE_ARP) ||
3953                src_flow->dl_type == htons(ETH_TYPE_RARP)) {
3954         if (!is_mask) {
3955             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
3956         }
3957         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
3958             const struct ovs_key_arp *arp_key;
3959
3960             arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
3961             if (!is_mask && (arp_key->arp_op & htons(0xff00))) {
3962                 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
3963                             "key", ntohs(arp_key->arp_op));
3964                 return ODP_FIT_ERROR;
3965             }
3966             put_arp_key(arp_key, flow);
3967             if (is_mask) {
3968                 check_start = arp_key;
3969                 check_len = sizeof *arp_key;
3970                 expected_bit = OVS_KEY_ATTR_ARP;
3971             }
3972         }
3973     } else {
3974         goto done;
3975     }
3976     if (check_len > 0) { /* Happens only when 'is_mask'. */
3977         if (!is_all_zeros(check_start, check_len) &&
3978             flow->dl_type != htons(0xffff)) {
3979             return ODP_FIT_ERROR;
3980         } else {
3981             expected_attrs |= UINT64_C(1) << expected_bit;
3982         }
3983     }
3984
3985     expected_bit = OVS_KEY_ATTR_UNSPEC;
3986     if (src_flow->nw_proto == IPPROTO_TCP
3987         && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
3988             src_flow->dl_type == htons(ETH_TYPE_IPV6))
3989         && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3990         if (!is_mask) {
3991             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
3992         }
3993         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
3994             const union ovs_key_tp *tcp_key;
3995
3996             tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
3997             put_tp_key(tcp_key, flow);
3998             expected_bit = OVS_KEY_ATTR_TCP;
3999         }
4000         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS)) {
4001             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS;
4002             flow->tcp_flags = nl_attr_get_be16(attrs[OVS_KEY_ATTR_TCP_FLAGS]);
4003         }
4004     } else if (src_flow->nw_proto == IPPROTO_UDP
4005                && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4006                    src_flow->dl_type == htons(ETH_TYPE_IPV6))
4007                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4008         if (!is_mask) {
4009             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
4010         }
4011         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
4012             const union ovs_key_tp *udp_key;
4013
4014             udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
4015             put_tp_key(udp_key, flow);
4016             expected_bit = OVS_KEY_ATTR_UDP;
4017         }
4018     } else if (src_flow->nw_proto == IPPROTO_SCTP
4019                && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4020                    src_flow->dl_type == htons(ETH_TYPE_IPV6))
4021                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4022         if (!is_mask) {
4023             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SCTP;
4024         }
4025         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SCTP)) {
4026             const union ovs_key_tp *sctp_key;
4027
4028             sctp_key = nl_attr_get(attrs[OVS_KEY_ATTR_SCTP]);
4029             put_tp_key(sctp_key, flow);
4030             expected_bit = OVS_KEY_ATTR_SCTP;
4031         }
4032     } else if (src_flow->nw_proto == IPPROTO_ICMP
4033                && src_flow->dl_type == htons(ETH_TYPE_IP)
4034                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4035         if (!is_mask) {
4036             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
4037         }
4038         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
4039             const struct ovs_key_icmp *icmp_key;
4040
4041             icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
4042             flow->tp_src = htons(icmp_key->icmp_type);
4043             flow->tp_dst = htons(icmp_key->icmp_code);
4044             expected_bit = OVS_KEY_ATTR_ICMP;
4045         }
4046     } else if (src_flow->nw_proto == IPPROTO_ICMPV6
4047                && src_flow->dl_type == htons(ETH_TYPE_IPV6)
4048                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4049         if (!is_mask) {
4050             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
4051         }
4052         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
4053             const struct ovs_key_icmpv6 *icmpv6_key;
4054
4055             icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
4056             flow->tp_src = htons(icmpv6_key->icmpv6_type);
4057             flow->tp_dst = htons(icmpv6_key->icmpv6_code);
4058             expected_bit = OVS_KEY_ATTR_ICMPV6;
4059             if (src_flow->tp_dst == htons(0) &&
4060                 (src_flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
4061                  src_flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
4062                 if (!is_mask) {
4063                     expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4064                 }
4065                 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
4066                     const struct ovs_key_nd *nd_key;
4067
4068                     nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
4069                     memcpy(&flow->nd_target, nd_key->nd_target,
4070                            sizeof flow->nd_target);
4071                     memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
4072                     memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
4073                     if (is_mask) {
4074                         if (!is_all_zeros(nd_key, sizeof *nd_key) &&
4075                             (flow->tp_src != htons(0xffff) ||
4076                              flow->tp_dst != htons(0xffff))) {
4077                             return ODP_FIT_ERROR;
4078                         } else {
4079                             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4080                         }
4081                     }
4082                 }
4083             }
4084         }
4085     }
4086     if (is_mask && expected_bit != OVS_KEY_ATTR_UNSPEC) {
4087         if ((flow->tp_src || flow->tp_dst) && flow->nw_proto != 0xff) {
4088             return ODP_FIT_ERROR;
4089         } else {
4090             expected_attrs |= UINT64_C(1) << expected_bit;
4091         }
4092     }
4093
4094 done:
4095     return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
4096                               key, key_len);
4097 }
4098
4099 /* Parse 802.1Q header then encapsulated L3 attributes. */
4100 static enum odp_key_fitness
4101 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4102                    uint64_t present_attrs, int out_of_range_attr,
4103                    uint64_t expected_attrs, struct flow *flow,
4104                    const struct nlattr *key, size_t key_len,
4105                    const struct flow *src_flow)
4106 {
4107     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4108     bool is_mask = src_flow != flow;
4109
4110     const struct nlattr *encap
4111         = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
4112            ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
4113     enum odp_key_fitness encap_fitness;
4114     enum odp_key_fitness fitness;
4115
4116     /* Calculate fitness of outer attributes. */
4117     if (!is_mask) {
4118         expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
4119                           (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
4120     } else {
4121         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
4122             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
4123         }
4124         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)) {
4125             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_ENCAP);
4126         }
4127     }
4128     fitness = check_expectations(present_attrs, out_of_range_attr,
4129                                  expected_attrs, key, key_len);
4130
4131     /* Set vlan_tci.
4132      * Remove the TPID from dl_type since it's not the real Ethertype.  */
4133     flow->dl_type = htons(0);
4134     flow->vlan_tci = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)
4135                       ? nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN])
4136                       : htons(0));
4137     if (!is_mask) {
4138         if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
4139             return ODP_FIT_TOO_LITTLE;
4140         } else if (flow->vlan_tci == htons(0)) {
4141             /* Corner case for a truncated 802.1Q header. */
4142             if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
4143                 return ODP_FIT_TOO_MUCH;
4144             }
4145             return fitness;
4146         } else if (!(flow->vlan_tci & htons(VLAN_CFI))) {
4147             VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
4148                         "but CFI bit is not set", ntohs(flow->vlan_tci));
4149             return ODP_FIT_ERROR;
4150         }
4151     } else {
4152         if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP))) {
4153             return fitness;
4154         }
4155     }
4156
4157     /* Now parse the encapsulated attributes. */
4158     if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
4159                             attrs, &present_attrs, &out_of_range_attr)) {
4160         return ODP_FIT_ERROR;
4161     }
4162     expected_attrs = 0;
4163
4164     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow, src_flow)) {
4165         return ODP_FIT_ERROR;
4166     }
4167     encap_fitness = parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
4168                                       expected_attrs, flow, key, key_len,
4169                                       src_flow);
4170
4171     /* The overall fitness is the worse of the outer and inner attributes. */
4172     return MAX(fitness, encap_fitness);
4173 }
4174
4175 static enum odp_key_fitness
4176 odp_flow_key_to_flow__(const struct nlattr *key, size_t key_len,
4177                        struct flow *flow, const struct flow *src_flow)
4178 {
4179     const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
4180     uint64_t expected_attrs;
4181     uint64_t present_attrs;
4182     int out_of_range_attr;
4183     bool is_mask = src_flow != flow;
4184
4185     memset(flow, 0, sizeof *flow);
4186
4187     /* Parse attributes. */
4188     if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
4189                             &out_of_range_attr)) {
4190         return ODP_FIT_ERROR;
4191     }
4192     expected_attrs = 0;
4193
4194     /* Metadata. */
4195     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID)) {
4196         flow->recirc_id = nl_attr_get_u32(attrs[OVS_KEY_ATTR_RECIRC_ID]);
4197         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID;
4198     } else if (is_mask) {
4199         /* Always exact match recirc_id if it is not specified. */
4200         flow->recirc_id = UINT32_MAX;
4201     }
4202
4203     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_DP_HASH)) {
4204         flow->dp_hash = nl_attr_get_u32(attrs[OVS_KEY_ATTR_DP_HASH]);
4205         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_DP_HASH;
4206     }
4207     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
4208         flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
4209         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
4210     }
4211
4212     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK)) {
4213         flow->pkt_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_SKB_MARK]);
4214         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK;
4215     }
4216
4217     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUNNEL)) {
4218         enum odp_key_fitness res;
4219
4220         res = odp_tun_key_from_attr(attrs[OVS_KEY_ATTR_TUNNEL], &flow->tunnel);
4221         if (res == ODP_FIT_ERROR) {
4222             return ODP_FIT_ERROR;
4223         } else if (res == ODP_FIT_PERFECT) {
4224             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUNNEL;
4225         }
4226     }
4227
4228     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
4229         flow->in_port.odp_port
4230             = nl_attr_get_odp_port(attrs[OVS_KEY_ATTR_IN_PORT]);
4231         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
4232     } else if (!is_mask) {
4233         flow->in_port.odp_port = ODPP_NONE;
4234     }
4235
4236     /* Ethernet header. */
4237     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
4238         const struct ovs_key_ethernet *eth_key;
4239
4240         eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
4241         put_ethernet_key(eth_key, flow);
4242         if (is_mask) {
4243             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
4244         }
4245     }
4246     if (!is_mask) {
4247         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
4248     }
4249
4250     /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
4251     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow,
4252         src_flow)) {
4253         return ODP_FIT_ERROR;
4254     }
4255
4256     if (is_mask
4257         ? (src_flow->vlan_tci & htons(VLAN_CFI)) != 0
4258         : src_flow->dl_type == htons(ETH_TYPE_VLAN)) {
4259         return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
4260                                   expected_attrs, flow, key, key_len, src_flow);
4261     }
4262     if (is_mask) {
4263         flow->vlan_tci = htons(0xffff);
4264         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
4265             flow->vlan_tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
4266             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
4267         }
4268     }
4269     return parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
4270                              expected_attrs, flow, key, key_len, src_flow);
4271 }
4272
4273 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
4274  * structure in 'flow'.  Returns an ODP_FIT_* value that indicates how well
4275  * 'key' fits our expectations for what a flow key should contain.
4276  *
4277  * The 'in_port' will be the datapath's understanding of the port.  The
4278  * caller will need to translate with odp_port_to_ofp_port() if the
4279  * OpenFlow port is needed.
4280  *
4281  * This function doesn't take the packet itself as an argument because none of
4282  * the currently understood OVS_KEY_ATTR_* attributes require it.  Currently,
4283  * it is always possible to infer which additional attribute(s) should appear
4284  * by looking at the attributes for lower-level protocols, e.g. if the network
4285  * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
4286  * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
4287  * must be absent. */
4288 enum odp_key_fitness
4289 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
4290                      struct flow *flow)
4291 {
4292    return odp_flow_key_to_flow__(key, key_len, flow, flow);
4293 }
4294
4295 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a mask
4296  * structure in 'mask'.  'flow' must be a previously translated flow
4297  * corresponding to 'mask'.  Returns an ODP_FIT_* value that indicates how well
4298  * 'key' fits our expectations for what a flow key should contain. */
4299 enum odp_key_fitness
4300 odp_flow_key_to_mask(const struct nlattr *key, size_t key_len,
4301                      struct flow *mask, const struct flow *flow)
4302 {
4303    return odp_flow_key_to_flow__(key, key_len, mask, flow);
4304 }
4305
4306 /* Returns 'fitness' as a string, for use in debug messages. */
4307 const char *
4308 odp_key_fitness_to_string(enum odp_key_fitness fitness)
4309 {
4310     switch (fitness) {
4311     case ODP_FIT_PERFECT:
4312         return "OK";
4313     case ODP_FIT_TOO_MUCH:
4314         return "too_much";
4315     case ODP_FIT_TOO_LITTLE:
4316         return "too_little";
4317     case ODP_FIT_ERROR:
4318         return "error";
4319     default:
4320         return "<unknown>";
4321     }
4322 }
4323
4324 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
4325  * Netlink PID 'pid'.  If 'userdata' is nonnull, adds a userdata attribute
4326  * whose contents are the 'userdata_size' bytes at 'userdata' and returns the
4327  * offset within 'odp_actions' of the start of the cookie.  (If 'userdata' is
4328  * null, then the return value is not meaningful.) */
4329 size_t
4330 odp_put_userspace_action(uint32_t pid,
4331                          const void *userdata, size_t userdata_size,
4332                          odp_port_t tunnel_out_port,
4333                          struct ofpbuf *odp_actions)
4334 {
4335     size_t userdata_ofs;
4336     size_t offset;
4337
4338     offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
4339     nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
4340     if (userdata) {
4341         userdata_ofs = odp_actions->size + NLA_HDRLEN;
4342
4343         /* The OVS kernel module before OVS 1.11 and the upstream Linux kernel
4344          * module before Linux 3.10 required the userdata to be exactly 8 bytes
4345          * long:
4346          *
4347          *   - The kernel rejected shorter userdata with -ERANGE.
4348          *
4349          *   - The kernel silently dropped userdata beyond the first 8 bytes.
4350          *
4351          * Thus, for maximum compatibility, always put at least 8 bytes.  (We
4352          * separately disable features that required more than 8 bytes.) */
4353         memcpy(nl_msg_put_unspec_zero(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
4354                                       MAX(8, userdata_size)),
4355                userdata, userdata_size);
4356     } else {
4357         userdata_ofs = 0;
4358     }
4359     if (tunnel_out_port != ODPP_NONE) {
4360         nl_msg_put_odp_port(odp_actions, OVS_USERSPACE_ATTR_EGRESS_TUN_PORT,
4361                             tunnel_out_port);
4362     }
4363     nl_msg_end_nested(odp_actions, offset);
4364
4365     return userdata_ofs;
4366 }
4367
4368 void
4369 odp_put_tunnel_action(const struct flow_tnl *tunnel,
4370                       struct ofpbuf *odp_actions)
4371 {
4372     size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
4373     tun_key_to_attr(odp_actions, tunnel);
4374     nl_msg_end_nested(odp_actions, offset);
4375 }
4376
4377 void
4378 odp_put_tnl_push_action(struct ofpbuf *odp_actions,
4379                         struct ovs_action_push_tnl *data)
4380 {
4381     int size = offsetof(struct ovs_action_push_tnl, header);
4382
4383     size += data->header_len;
4384     nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_TUNNEL_PUSH, data, size);
4385 }
4386
4387 \f
4388 /* The commit_odp_actions() function and its helpers. */
4389
4390 static void
4391 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
4392                   const void *key, size_t key_size)
4393 {
4394     size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
4395     nl_msg_put_unspec(odp_actions, key_type, key, key_size);
4396     nl_msg_end_nested(odp_actions, offset);
4397 }
4398
4399 /* Masked set actions have a mask following the data within the netlink
4400  * attribute.  The unmasked bits in the data will be cleared as the data
4401  * is copied to the action. */
4402 void
4403 commit_masked_set_action(struct ofpbuf *odp_actions,
4404                          enum ovs_key_attr key_type,
4405                          const void *key_, const void *mask_, size_t key_size)
4406 {
4407     size_t offset = nl_msg_start_nested(odp_actions,
4408                                         OVS_ACTION_ATTR_SET_MASKED);
4409     char *data = nl_msg_put_unspec_uninit(odp_actions, key_type, key_size * 2);
4410     const char *key = key_, *mask = mask_;
4411
4412     memcpy(data + key_size, mask, key_size);
4413     /* Clear unmasked bits while copying. */
4414     while (key_size--) {
4415         *data++ = *key++ & *mask++;
4416     }
4417     nl_msg_end_nested(odp_actions, offset);
4418 }
4419
4420 /* If any of the flow key data that ODP actions can modify are different in
4421  * 'base->tunnel' and 'flow->tunnel', appends a set_tunnel ODP action to
4422  * 'odp_actions' that change the flow tunneling information in key from
4423  * 'base->tunnel' into 'flow->tunnel', and then changes 'base->tunnel' in the
4424  * same way.  In other words, operates the same as commit_odp_actions(), but
4425  * only on tunneling information. */
4426 void
4427 commit_odp_tunnel_action(const struct flow *flow, struct flow *base,
4428                          struct ofpbuf *odp_actions)
4429 {
4430     /* A valid IPV4_TUNNEL must have non-zero ip_dst. */
4431     if (flow->tunnel.ip_dst) {
4432         if (!memcmp(&base->tunnel, &flow->tunnel, sizeof base->tunnel)) {
4433             return;
4434         }
4435         memcpy(&base->tunnel, &flow->tunnel, sizeof base->tunnel);
4436         odp_put_tunnel_action(&base->tunnel, odp_actions);
4437     }
4438 }
4439
4440 static bool
4441 commit(enum ovs_key_attr attr, bool use_masked_set,
4442        const void *key, void *base, void *mask, size_t size,
4443        struct ofpbuf *odp_actions)
4444 {
4445     if (memcmp(key, base, size)) {
4446         bool fully_masked = odp_mask_is_exact(attr, mask, size);
4447
4448         if (use_masked_set && !fully_masked) {
4449             commit_masked_set_action(odp_actions, attr, key, mask, size);
4450         } else {
4451             if (!fully_masked) {
4452                 memset(mask, 0xff, size);
4453             }
4454             commit_set_action(odp_actions, attr, key, size);
4455         }
4456         memcpy(base, key, size);
4457         return true;
4458     } else {
4459         /* Mask bits are set when we have either read or set the corresponding
4460          * values.  Masked bits will be exact-matched, no need to set them
4461          * if the value did not actually change. */
4462         return false;
4463     }
4464 }
4465
4466 static void
4467 get_ethernet_key(const struct flow *flow, struct ovs_key_ethernet *eth)
4468 {
4469     memcpy(eth->eth_src, flow->dl_src, ETH_ADDR_LEN);
4470     memcpy(eth->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
4471 }
4472
4473 static void
4474 put_ethernet_key(const struct ovs_key_ethernet *eth, struct flow *flow)
4475 {
4476     memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
4477     memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
4478 }
4479
4480 static void
4481 commit_set_ether_addr_action(const struct flow *flow, struct flow *base_flow,
4482                              struct ofpbuf *odp_actions,
4483                              struct flow_wildcards *wc,
4484                              bool use_masked)
4485 {
4486     struct ovs_key_ethernet key, base, mask;
4487
4488     get_ethernet_key(flow, &key);
4489     get_ethernet_key(base_flow, &base);
4490     get_ethernet_key(&wc->masks, &mask);
4491
4492     if (commit(OVS_KEY_ATTR_ETHERNET, use_masked,
4493                &key, &base, &mask, sizeof key, odp_actions)) {
4494         put_ethernet_key(&base, base_flow);
4495         put_ethernet_key(&mask, &wc->masks);
4496     }
4497 }
4498
4499 static void
4500 pop_vlan(struct flow *base,
4501          struct ofpbuf *odp_actions, struct flow_wildcards *wc)
4502 {
4503     memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
4504
4505     if (base->vlan_tci & htons(VLAN_CFI)) {
4506         nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
4507         base->vlan_tci = 0;
4508     }
4509 }
4510
4511 static void
4512 commit_vlan_action(ovs_be16 vlan_tci, struct flow *base,
4513                    struct ofpbuf *odp_actions, struct flow_wildcards *wc)
4514 {
4515     if (base->vlan_tci == vlan_tci) {
4516         return;
4517     }
4518
4519     pop_vlan(base, odp_actions, wc);
4520     if (vlan_tci & htons(VLAN_CFI)) {
4521         struct ovs_action_push_vlan vlan;
4522
4523         vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
4524         vlan.vlan_tci = vlan_tci;
4525         nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
4526                           &vlan, sizeof vlan);
4527     }
4528     base->vlan_tci = vlan_tci;
4529 }
4530
4531 /* Wildcarding already done at action translation time. */
4532 static void
4533 commit_mpls_action(const struct flow *flow, struct flow *base,
4534                    struct ofpbuf *odp_actions)
4535 {
4536     int base_n = flow_count_mpls_labels(base, NULL);
4537     int flow_n = flow_count_mpls_labels(flow, NULL);
4538     int common_n = flow_count_common_mpls_labels(flow, flow_n, base, base_n,
4539                                                  NULL);
4540
4541     while (base_n > common_n) {
4542         if (base_n - 1 == common_n && flow_n > common_n) {
4543             /* If there is only one more LSE in base than there are common
4544              * between base and flow; and flow has at least one more LSE than
4545              * is common then the topmost LSE of base may be updated using
4546              * set */
4547             struct ovs_key_mpls mpls_key;
4548
4549             mpls_key.mpls_lse = flow->mpls_lse[flow_n - base_n];
4550             commit_set_action(odp_actions, OVS_KEY_ATTR_MPLS,
4551                               &mpls_key, sizeof mpls_key);
4552             flow_set_mpls_lse(base, 0, mpls_key.mpls_lse);
4553             common_n++;
4554         } else {
4555             /* Otherwise, if there more LSEs in base than are common between
4556              * base and flow then pop the topmost one. */
4557             ovs_be16 dl_type;
4558             bool popped;
4559
4560             /* If all the LSEs are to be popped and this is not the outermost
4561              * LSE then use ETH_TYPE_MPLS as the ethertype parameter of the
4562              * POP_MPLS action instead of flow->dl_type.
4563              *
4564              * This is because the POP_MPLS action requires its ethertype
4565              * argument to be an MPLS ethernet type but in this case
4566              * flow->dl_type will be a non-MPLS ethernet type.
4567              *
4568              * When the final POP_MPLS action occurs it use flow->dl_type and
4569              * the and the resulting packet will have the desired dl_type. */
4570             if ((!eth_type_mpls(flow->dl_type)) && base_n > 1) {
4571                 dl_type = htons(ETH_TYPE_MPLS);
4572             } else {
4573                 dl_type = flow->dl_type;
4574             }
4575             nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_POP_MPLS, dl_type);
4576             popped = flow_pop_mpls(base, base_n, flow->dl_type, NULL);
4577             ovs_assert(popped);
4578             base_n--;
4579         }
4580     }
4581
4582     /* If, after the above popping and setting, there are more LSEs in flow
4583      * than base then some LSEs need to be pushed. */
4584     while (base_n < flow_n) {
4585         struct ovs_action_push_mpls *mpls;
4586
4587         mpls = nl_msg_put_unspec_zero(odp_actions,
4588                                       OVS_ACTION_ATTR_PUSH_MPLS,
4589                                       sizeof *mpls);
4590         mpls->mpls_ethertype = flow->dl_type;
4591         mpls->mpls_lse = flow->mpls_lse[flow_n - base_n - 1];
4592         flow_push_mpls(base, base_n, mpls->mpls_ethertype, NULL);
4593         flow_set_mpls_lse(base, 0, mpls->mpls_lse);
4594         base_n++;
4595     }
4596 }
4597
4598 static void
4599 get_ipv4_key(const struct flow *flow, struct ovs_key_ipv4 *ipv4, bool is_mask)
4600 {
4601     ipv4->ipv4_src = flow->nw_src;
4602     ipv4->ipv4_dst = flow->nw_dst;
4603     ipv4->ipv4_proto = flow->nw_proto;
4604     ipv4->ipv4_tos = flow->nw_tos;
4605     ipv4->ipv4_ttl = flow->nw_ttl;
4606     ipv4->ipv4_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
4607 }
4608
4609 static void
4610 put_ipv4_key(const struct ovs_key_ipv4 *ipv4, struct flow *flow, bool is_mask)
4611 {
4612     flow->nw_src = ipv4->ipv4_src;
4613     flow->nw_dst = ipv4->ipv4_dst;
4614     flow->nw_proto = ipv4->ipv4_proto;
4615     flow->nw_tos = ipv4->ipv4_tos;
4616     flow->nw_ttl = ipv4->ipv4_ttl;
4617     flow->nw_frag = odp_to_ovs_frag(ipv4->ipv4_frag, is_mask);
4618 }
4619
4620 static void
4621 commit_set_ipv4_action(const struct flow *flow, struct flow *base_flow,
4622                        struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4623                        bool use_masked)
4624 {
4625     struct ovs_key_ipv4 key, mask, base;
4626
4627     /* Check that nw_proto and nw_frag remain unchanged. */
4628     ovs_assert(flow->nw_proto == base_flow->nw_proto &&
4629                flow->nw_frag == base_flow->nw_frag);
4630
4631     get_ipv4_key(flow, &key, false);
4632     get_ipv4_key(base_flow, &base, false);
4633     get_ipv4_key(&wc->masks, &mask, true);
4634     mask.ipv4_proto = 0;        /* Not writeable. */
4635     mask.ipv4_frag = 0;         /* Not writable. */
4636
4637     if (commit(OVS_KEY_ATTR_IPV4, use_masked, &key, &base, &mask, sizeof key,
4638                odp_actions)) {
4639         put_ipv4_key(&base, base_flow, false);
4640         if (mask.ipv4_proto != 0) { /* Mask was changed by commit(). */
4641             put_ipv4_key(&mask, &wc->masks, true);
4642         }
4643    }
4644 }
4645
4646 static void
4647 get_ipv6_key(const struct flow *flow, struct ovs_key_ipv6 *ipv6, bool is_mask)
4648 {
4649     memcpy(ipv6->ipv6_src, &flow->ipv6_src, sizeof ipv6->ipv6_src);
4650     memcpy(ipv6->ipv6_dst, &flow->ipv6_dst, sizeof ipv6->ipv6_dst);
4651     ipv6->ipv6_label = flow->ipv6_label;
4652     ipv6->ipv6_proto = flow->nw_proto;
4653     ipv6->ipv6_tclass = flow->nw_tos;
4654     ipv6->ipv6_hlimit = flow->nw_ttl;
4655     ipv6->ipv6_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
4656 }
4657
4658 static void
4659 put_ipv6_key(const struct ovs_key_ipv6 *ipv6, struct flow *flow, bool is_mask)
4660 {
4661     memcpy(&flow->ipv6_src, ipv6->ipv6_src, sizeof flow->ipv6_src);
4662     memcpy(&flow->ipv6_dst, ipv6->ipv6_dst, sizeof flow->ipv6_dst);
4663     flow->ipv6_label = ipv6->ipv6_label;
4664     flow->nw_proto = ipv6->ipv6_proto;
4665     flow->nw_tos = ipv6->ipv6_tclass;
4666     flow->nw_ttl = ipv6->ipv6_hlimit;
4667     flow->nw_frag = odp_to_ovs_frag(ipv6->ipv6_frag, is_mask);
4668 }
4669
4670 static void
4671 commit_set_ipv6_action(const struct flow *flow, struct flow *base_flow,
4672                        struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4673                        bool use_masked)
4674 {
4675     struct ovs_key_ipv6 key, mask, base;
4676
4677     /* Check that nw_proto and nw_frag remain unchanged. */
4678     ovs_assert(flow->nw_proto == base_flow->nw_proto &&
4679                flow->nw_frag == base_flow->nw_frag);
4680
4681     get_ipv6_key(flow, &key, false);
4682     get_ipv6_key(base_flow, &base, false);
4683     get_ipv6_key(&wc->masks, &mask, true);
4684     mask.ipv6_proto = 0;        /* Not writeable. */
4685     mask.ipv6_frag = 0;         /* Not writable. */
4686
4687     if (commit(OVS_KEY_ATTR_IPV6, use_masked, &key, &base, &mask, sizeof key,
4688                odp_actions)) {
4689         put_ipv6_key(&base, base_flow, false);
4690         if (mask.ipv6_proto != 0) { /* Mask was changed by commit(). */
4691             put_ipv6_key(&mask, &wc->masks, true);
4692         }
4693     }
4694 }
4695
4696 static void
4697 get_arp_key(const struct flow *flow, struct ovs_key_arp *arp)
4698 {
4699     /* ARP key has padding, clear it. */
4700     memset(arp, 0, sizeof *arp);
4701
4702     arp->arp_sip = flow->nw_src;
4703     arp->arp_tip = flow->nw_dst;
4704     arp->arp_op = htons(flow->nw_proto);
4705     memcpy(arp->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
4706     memcpy(arp->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
4707 }
4708
4709 static void
4710 put_arp_key(const struct ovs_key_arp *arp, struct flow *flow)
4711 {
4712     flow->nw_src = arp->arp_sip;
4713     flow->nw_dst = arp->arp_tip;
4714     flow->nw_proto = ntohs(arp->arp_op);
4715     memcpy(flow->arp_sha, arp->arp_sha, ETH_ADDR_LEN);
4716     memcpy(flow->arp_tha, arp->arp_tha, ETH_ADDR_LEN);
4717 }
4718
4719 static enum slow_path_reason
4720 commit_set_arp_action(const struct flow *flow, struct flow *base_flow,
4721                       struct ofpbuf *odp_actions, struct flow_wildcards *wc)
4722 {
4723     struct ovs_key_arp key, mask, base;
4724
4725     get_arp_key(flow, &key);
4726     get_arp_key(base_flow, &base);
4727     get_arp_key(&wc->masks, &mask);
4728
4729     if (commit(OVS_KEY_ATTR_ARP, true, &key, &base, &mask, sizeof key,
4730                odp_actions)) {
4731         put_arp_key(&base, base_flow);
4732         put_arp_key(&mask, &wc->masks);
4733         return SLOW_ACTION;
4734     }
4735     return 0;
4736 }
4737
4738 static void
4739 get_nd_key(const struct flow *flow, struct ovs_key_nd *nd)
4740 {
4741     memcpy(nd->nd_target, &flow->nd_target, sizeof flow->nd_target);
4742     /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
4743     memcpy(nd->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
4744     memcpy(nd->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
4745 }
4746
4747 static void
4748 put_nd_key(const struct ovs_key_nd *nd, struct flow *flow)
4749 {
4750     memcpy(&flow->nd_target, &flow->nd_target, sizeof flow->nd_target);
4751     /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
4752     memcpy(flow->arp_sha, nd->nd_sll, ETH_ADDR_LEN);
4753     memcpy(flow->arp_tha, nd->nd_tll, ETH_ADDR_LEN);
4754 }
4755
4756 static enum slow_path_reason
4757 commit_set_nd_action(const struct flow *flow, struct flow *base_flow,
4758                      struct ofpbuf *odp_actions,
4759                      struct flow_wildcards *wc, bool use_masked)
4760 {
4761     struct ovs_key_nd key, mask, base;
4762
4763     get_nd_key(flow, &key);
4764     get_nd_key(base_flow, &base);
4765     get_nd_key(&wc->masks, &mask);
4766
4767     if (commit(OVS_KEY_ATTR_ND, use_masked, &key, &base, &mask, sizeof key,
4768                odp_actions)) {
4769         put_nd_key(&base, base_flow);
4770         put_nd_key(&mask, &wc->masks);
4771         return SLOW_ACTION;
4772     }
4773
4774     return 0;
4775 }
4776
4777 static enum slow_path_reason
4778 commit_set_nw_action(const struct flow *flow, struct flow *base,
4779                      struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4780                      bool use_masked)
4781 {
4782     /* Check if 'flow' really has an L3 header. */
4783     if (!flow->nw_proto) {
4784         return 0;
4785     }
4786
4787     switch (ntohs(base->dl_type)) {
4788     case ETH_TYPE_IP:
4789         commit_set_ipv4_action(flow, base, odp_actions, wc, use_masked);
4790         break;
4791
4792     case ETH_TYPE_IPV6:
4793         commit_set_ipv6_action(flow, base, odp_actions, wc, use_masked);
4794         return commit_set_nd_action(flow, base, odp_actions, wc, use_masked);
4795
4796     case ETH_TYPE_ARP:
4797         return commit_set_arp_action(flow, base, odp_actions, wc);
4798     }
4799
4800     return 0;
4801 }
4802
4803 /* TCP, UDP, and SCTP keys have the same layout. */
4804 BUILD_ASSERT_DECL(sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_udp) &&
4805                   sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_sctp));
4806
4807 static void
4808 get_tp_key(const struct flow *flow, union ovs_key_tp *tp)
4809 {
4810     tp->tcp.tcp_src = flow->tp_src;
4811     tp->tcp.tcp_dst = flow->tp_dst;
4812 }
4813
4814 static void
4815 put_tp_key(const union ovs_key_tp *tp, struct flow *flow)
4816 {
4817     flow->tp_src = tp->tcp.tcp_src;
4818     flow->tp_dst = tp->tcp.tcp_dst;
4819 }
4820
4821 static void
4822 commit_set_port_action(const struct flow *flow, struct flow *base_flow,
4823                        struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4824                        bool use_masked)
4825 {
4826     enum ovs_key_attr key_type;
4827     union ovs_key_tp key, mask, base;
4828
4829     /* Check if 'flow' really has an L3 header. */
4830     if (!flow->nw_proto) {
4831         return;
4832     }
4833
4834     if (!is_ip_any(base_flow)) {
4835         return;
4836     }
4837
4838     if (flow->nw_proto == IPPROTO_TCP) {
4839         key_type = OVS_KEY_ATTR_TCP;
4840     } else if (flow->nw_proto == IPPROTO_UDP) {
4841         key_type = OVS_KEY_ATTR_UDP;
4842     } else if (flow->nw_proto == IPPROTO_SCTP) {
4843         key_type = OVS_KEY_ATTR_SCTP;
4844     } else {
4845         return;
4846     }
4847
4848     get_tp_key(flow, &key);
4849     get_tp_key(base_flow, &base);
4850     get_tp_key(&wc->masks, &mask);
4851
4852     if (commit(key_type, use_masked, &key, &base, &mask, sizeof key,
4853                odp_actions)) {
4854         put_tp_key(&base, base_flow);
4855         put_tp_key(&mask, &wc->masks);
4856     }
4857 }
4858
4859 static void
4860 commit_set_priority_action(const struct flow *flow, struct flow *base_flow,
4861                            struct ofpbuf *odp_actions,
4862                            struct flow_wildcards *wc,
4863                            bool use_masked)
4864 {
4865     uint32_t key, mask, base;
4866
4867     key = flow->skb_priority;
4868     base = base_flow->skb_priority;
4869     mask = wc->masks.skb_priority;
4870
4871     if (commit(OVS_KEY_ATTR_PRIORITY, use_masked, &key, &base, &mask,
4872                sizeof key, odp_actions)) {
4873         base_flow->skb_priority = base;
4874         wc->masks.skb_priority = mask;
4875     }
4876 }
4877
4878 static void
4879 commit_set_pkt_mark_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->pkt_mark;
4887     base = base_flow->pkt_mark;
4888     mask = wc->masks.pkt_mark;
4889
4890     if (commit(OVS_KEY_ATTR_SKB_MARK, use_masked, &key, &base, &mask,
4891                sizeof key, odp_actions)) {
4892         base_flow->pkt_mark = base;
4893         wc->masks.pkt_mark = mask;
4894     }
4895 }
4896
4897 /* If any of the flow key data that ODP actions can modify are different in
4898  * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
4899  * key from 'base' into 'flow', and then changes 'base' the same way.  Does not
4900  * commit set_tunnel actions.  Users should call commit_odp_tunnel_action()
4901  * in addition to this function if needed.  Sets fields in 'wc' that are
4902  * used as part of the action.
4903  *
4904  * Returns a reason to force processing the flow's packets into the userspace
4905  * slow path, if there is one, otherwise 0. */
4906 enum slow_path_reason
4907 commit_odp_actions(const struct flow *flow, struct flow *base,
4908                    struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4909                    bool use_masked)
4910 {
4911     enum slow_path_reason slow;
4912
4913     commit_set_ether_addr_action(flow, base, odp_actions, wc, use_masked);
4914     slow = commit_set_nw_action(flow, base, odp_actions, wc, use_masked);
4915     commit_set_port_action(flow, base, odp_actions, wc, use_masked);
4916     commit_mpls_action(flow, base, odp_actions);
4917     commit_vlan_action(flow->vlan_tci, base, odp_actions, wc);
4918     commit_set_priority_action(flow, base, odp_actions, wc, use_masked);
4919     commit_set_pkt_mark_action(flow, base, odp_actions, wc, use_masked);
4920
4921     return slow;
4922 }