lib/odp-util.c

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