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