lib/odp-util.c

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