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