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_MAX:
2597         default:
2598             format_unknown_key(ds, a, ma);
2599         }
2600         ofpbuf_clear(&ofp);
2601     }
2602
2603     /* Flags can have a valid mask even if the attribute is not set, so
2604      * we need to collect these separately. */
2605     if (mask_attr) {
2606         NL_NESTED_FOR_EACH(a, left, mask_attr) {
2607             switch (nl_attr_type(a)) {
2608             case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
2609                 mask_flags |= FLOW_TNL_F_DONT_FRAGMENT;
2610                 break;
2611             case OVS_TUNNEL_KEY_ATTR_CSUM:
2612                 mask_flags |= FLOW_TNL_F_CSUM;
2613                 break;
2614             case OVS_TUNNEL_KEY_ATTR_OAM:
2615                 mask_flags |= FLOW_TNL_F_OAM;
2616                 break;
2617             }
2618         }
2619     }
2620
2621     format_tun_flags(ds, "flags", flags, mask_attr ? &mask_flags : NULL,
2622                      verbose);
2623     ds_chomp(ds, ',');
2624     ofpbuf_uninit(&ofp);
2625 }
2626
2627 static const char *
2628 odp_ct_state_to_string(uint32_t flag)
2629 {
2630     switch (flag) {
2631     case OVS_CS_F_REPLY_DIR:
2632         return "rpl";
2633     case OVS_CS_F_TRACKED:
2634         return "trk";
2635     case OVS_CS_F_NEW:
2636         return "new";
2637     case OVS_CS_F_ESTABLISHED:
2638         return "est";
2639     case OVS_CS_F_RELATED:
2640         return "rel";
2641     case OVS_CS_F_INVALID:
2642         return "inv";
2643     case OVS_CS_F_SRC_NAT:
2644         return "snat";
2645     case OVS_CS_F_DST_NAT:
2646         return "dnat";
2647     default:
2648         return NULL;
2649     }
2650 }
2651
2652 static void
2653 format_frag(struct ds *ds, const char *name, uint8_t key,
2654             const uint8_t *mask, bool verbose)
2655 {
2656     bool mask_empty = mask && !*mask;
2657
2658     /* ODP frag is an enumeration field; partial masks are not meaningful. */
2659     if (verbose || !mask_empty) {
2660         bool mask_full = !mask || *mask == UINT8_MAX;
2661
2662         if (!mask_full) { /* Partially masked. */
2663             ds_put_format(ds, "error: partial mask not supported for frag (%#"
2664                           PRIx8"),", *mask);
2665         } else {
2666             ds_put_format(ds, "%s=%s,", name, ovs_frag_type_to_string(key));
2667         }
2668     }
2669 }
2670
2671 static bool
2672 mask_empty(const struct nlattr *ma)
2673 {
2674     const void *mask;
2675     size_t n;
2676
2677     if (!ma) {
2678         return true;
2679     }
2680     mask = nl_attr_get(ma);
2681     n = nl_attr_get_size(ma);
2682
2683     return is_all_zeros(mask, n);
2684 }
2685
2686 static void
2687 format_odp_key_attr(const struct nlattr *a, const struct nlattr *ma,
2688                     const struct hmap *portno_names, struct ds *ds,
2689                     bool verbose)
2690 {
2691     enum ovs_key_attr attr = nl_attr_type(a);
2692     char namebuf[OVS_KEY_ATTR_BUFSIZE];
2693     bool is_exact;
2694
2695     is_exact = ma ? odp_mask_attr_is_exact(ma) : true;
2696
2697     ds_put_cstr(ds, ovs_key_attr_to_string(attr, namebuf, sizeof namebuf));
2698
2699     if (!check_attr_len(ds, a, ma, ovs_flow_key_attr_lens,
2700                         OVS_KEY_ATTR_MAX, false)) {
2701         return;
2702     }
2703
2704     ds_put_char(ds, '(');
2705     switch (attr) {
2706     case OVS_KEY_ATTR_ENCAP:
2707         if (ma && nl_attr_get_size(ma) && nl_attr_get_size(a)) {
2708             odp_flow_format(nl_attr_get(a), nl_attr_get_size(a),
2709                             nl_attr_get(ma), nl_attr_get_size(ma), NULL, ds,
2710                             verbose);
2711         } else if (nl_attr_get_size(a)) {
2712             odp_flow_format(nl_attr_get(a), nl_attr_get_size(a), NULL, 0, NULL,
2713                             ds, verbose);
2714         }
2715         break;
2716
2717     case OVS_KEY_ATTR_PRIORITY:
2718     case OVS_KEY_ATTR_SKB_MARK:
2719     case OVS_KEY_ATTR_DP_HASH:
2720     case OVS_KEY_ATTR_RECIRC_ID:
2721         ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2722         if (!is_exact) {
2723             ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2724         }
2725         break;
2726
2727     case OVS_KEY_ATTR_CT_MARK:
2728         if (verbose || !mask_empty(ma)) {
2729             ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2730             if (!is_exact) {
2731                 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2732             }
2733         }
2734         break;
2735
2736     case OVS_KEY_ATTR_CT_STATE:
2737         if (verbose) {
2738                 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2739                 if (!is_exact) {
2740                     ds_put_format(ds, "/%#"PRIx32,
2741                                   mask_empty(ma) ? 0 : nl_attr_get_u32(ma));
2742                 }
2743         } else if (!is_exact) {
2744             format_flags_masked(ds, NULL, odp_ct_state_to_string,
2745                                 nl_attr_get_u32(a),
2746                                 mask_empty(ma) ? 0 : nl_attr_get_u32(ma),
2747                                 UINT32_MAX);
2748         } else {
2749             format_flags(ds, odp_ct_state_to_string, nl_attr_get_u32(a), '|');
2750         }
2751         break;
2752
2753     case OVS_KEY_ATTR_CT_ZONE:
2754         if (verbose || !mask_empty(ma)) {
2755             ds_put_format(ds, "%#"PRIx16, nl_attr_get_u16(a));
2756             if (!is_exact) {
2757                 ds_put_format(ds, "/%#"PRIx16, nl_attr_get_u16(ma));
2758             }
2759         }
2760         break;
2761
2762     case OVS_KEY_ATTR_CT_LABELS: {
2763         const ovs_u128 *value = nl_attr_get(a);
2764         const ovs_u128 *mask = ma ? nl_attr_get(ma) : NULL;
2765
2766         format_u128(ds, value, mask, verbose);
2767         break;
2768     }
2769
2770     case OVS_KEY_ATTR_TUNNEL:
2771         format_odp_tun_attr(a, ma, ds, verbose);
2772         break;
2773
2774     case OVS_KEY_ATTR_IN_PORT:
2775         if (portno_names && verbose && is_exact) {
2776             char *name = odp_portno_names_get(portno_names,
2777                             u32_to_odp(nl_attr_get_u32(a)));
2778             if (name) {
2779                 ds_put_format(ds, "%s", name);
2780             } else {
2781                 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2782             }
2783         } else {
2784             ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2785             if (!is_exact) {
2786                 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2787             }
2788         }
2789         break;
2790
2791     case OVS_KEY_ATTR_ETHERNET: {
2792         const struct ovs_key_ethernet *mask = ma ? nl_attr_get(ma) : NULL;
2793         const struct ovs_key_ethernet *key = nl_attr_get(a);
2794
2795         format_eth(ds, "src", key->eth_src, MASK(mask, eth_src), verbose);
2796         format_eth(ds, "dst", key->eth_dst, MASK(mask, eth_dst), verbose);
2797         ds_chomp(ds, ',');
2798         break;
2799     }
2800     case OVS_KEY_ATTR_VLAN:
2801         format_vlan_tci(ds, nl_attr_get_be16(a),
2802                         ma ? nl_attr_get_be16(ma) : OVS_BE16_MAX, verbose);
2803         break;
2804
2805     case OVS_KEY_ATTR_MPLS: {
2806         const struct ovs_key_mpls *mpls_key = nl_attr_get(a);
2807         const struct ovs_key_mpls *mpls_mask = NULL;
2808         size_t size = nl_attr_get_size(a);
2809
2810         if (!size || size % sizeof *mpls_key) {
2811             ds_put_format(ds, "(bad key length %"PRIuSIZE")", size);
2812             return;
2813         }
2814         if (!is_exact) {
2815             mpls_mask = nl_attr_get(ma);
2816             if (size != nl_attr_get_size(ma)) {
2817                 ds_put_format(ds, "(key length %"PRIuSIZE" != "
2818                               "mask length %"PRIuSIZE")",
2819                               size, nl_attr_get_size(ma));
2820                 return;
2821             }
2822         }
2823         format_mpls(ds, mpls_key, mpls_mask, size / sizeof *mpls_key);
2824         break;
2825     }
2826     case OVS_KEY_ATTR_ETHERTYPE:
2827         ds_put_format(ds, "0x%04"PRIx16, ntohs(nl_attr_get_be16(a)));
2828         if (!is_exact) {
2829             ds_put_format(ds, "/0x%04"PRIx16, ntohs(nl_attr_get_be16(ma)));
2830         }
2831         break;
2832
2833     case OVS_KEY_ATTR_IPV4: {
2834         const struct ovs_key_ipv4 *key = nl_attr_get(a);
2835         const struct ovs_key_ipv4 *mask = ma ? nl_attr_get(ma) : NULL;
2836
2837         format_ipv4(ds, "src", key->ipv4_src, MASK(mask, ipv4_src), verbose);
2838         format_ipv4(ds, "dst", key->ipv4_dst, MASK(mask, ipv4_dst), verbose);
2839         format_u8u(ds, "proto", key->ipv4_proto, MASK(mask, ipv4_proto),
2840                       verbose);
2841         format_u8x(ds, "tos", key->ipv4_tos, MASK(mask, ipv4_tos), verbose);
2842         format_u8u(ds, "ttl", key->ipv4_ttl, MASK(mask, ipv4_ttl), verbose);
2843         format_frag(ds, "frag", key->ipv4_frag, MASK(mask, ipv4_frag),
2844                     verbose);
2845         ds_chomp(ds, ',');
2846         break;
2847     }
2848     case OVS_KEY_ATTR_IPV6: {
2849         const struct ovs_key_ipv6 *key = nl_attr_get(a);
2850         const struct ovs_key_ipv6 *mask = ma ? nl_attr_get(ma) : NULL;
2851
2852         format_ipv6(ds, "src", key->ipv6_src, MASK(mask, ipv6_src), verbose);
2853         format_ipv6(ds, "dst", key->ipv6_dst, MASK(mask, ipv6_dst), verbose);
2854         format_ipv6_label(ds, "label", key->ipv6_label, MASK(mask, ipv6_label),
2855                           verbose);
2856         format_u8u(ds, "proto", key->ipv6_proto, MASK(mask, ipv6_proto),
2857                       verbose);
2858         format_u8x(ds, "tclass", key->ipv6_tclass, MASK(mask, ipv6_tclass),
2859                       verbose);
2860         format_u8u(ds, "hlimit", key->ipv6_hlimit, MASK(mask, ipv6_hlimit),
2861                       verbose);
2862         format_frag(ds, "frag", key->ipv6_frag, MASK(mask, ipv6_frag),
2863                     verbose);
2864         ds_chomp(ds, ',');
2865         break;
2866     }
2867         /* These have the same structure and format. */
2868     case OVS_KEY_ATTR_TCP:
2869     case OVS_KEY_ATTR_UDP:
2870     case OVS_KEY_ATTR_SCTP: {
2871         const struct ovs_key_tcp *key = nl_attr_get(a);
2872         const struct ovs_key_tcp *mask = ma ? nl_attr_get(ma) : NULL;
2873
2874         format_be16(ds, "src", key->tcp_src, MASK(mask, tcp_src), verbose);
2875         format_be16(ds, "dst", key->tcp_dst, MASK(mask, tcp_dst), verbose);
2876         ds_chomp(ds, ',');
2877         break;
2878     }
2879     case OVS_KEY_ATTR_TCP_FLAGS:
2880         if (!is_exact) {
2881             format_flags_masked(ds, NULL, packet_tcp_flag_to_string,
2882                                 ntohs(nl_attr_get_be16(a)),
2883                                 TCP_FLAGS(nl_attr_get_be16(ma)),
2884                                 TCP_FLAGS(OVS_BE16_MAX));
2885         } else {
2886             format_flags(ds, packet_tcp_flag_to_string,
2887                          ntohs(nl_attr_get_be16(a)), '|');
2888         }
2889         break;
2890
2891     case OVS_KEY_ATTR_ICMP: {
2892         const struct ovs_key_icmp *key = nl_attr_get(a);
2893         const struct ovs_key_icmp *mask = ma ? nl_attr_get(ma) : NULL;
2894
2895         format_u8u(ds, "type", key->icmp_type, MASK(mask, icmp_type), verbose);
2896         format_u8u(ds, "code", key->icmp_code, MASK(mask, icmp_code), verbose);
2897         ds_chomp(ds, ',');
2898         break;
2899     }
2900     case OVS_KEY_ATTR_ICMPV6: {
2901         const struct ovs_key_icmpv6 *key = nl_attr_get(a);
2902         const struct ovs_key_icmpv6 *mask = ma ? nl_attr_get(ma) : NULL;
2903
2904         format_u8u(ds, "type", key->icmpv6_type, MASK(mask, icmpv6_type),
2905                    verbose);
2906         format_u8u(ds, "code", key->icmpv6_code, MASK(mask, icmpv6_code),
2907                    verbose);
2908         ds_chomp(ds, ',');
2909         break;
2910     }
2911     case OVS_KEY_ATTR_ARP: {
2912         const struct ovs_key_arp *mask = ma ? nl_attr_get(ma) : NULL;
2913         const struct ovs_key_arp *key = nl_attr_get(a);
2914
2915         format_ipv4(ds, "sip", key->arp_sip, MASK(mask, arp_sip), verbose);
2916         format_ipv4(ds, "tip", key->arp_tip, MASK(mask, arp_tip), verbose);
2917         format_be16(ds, "op", key->arp_op, MASK(mask, arp_op), verbose);
2918         format_eth(ds, "sha", key->arp_sha, MASK(mask, arp_sha), verbose);
2919         format_eth(ds, "tha", key->arp_tha, MASK(mask, arp_tha), verbose);
2920         ds_chomp(ds, ',');
2921         break;
2922     }
2923     case OVS_KEY_ATTR_ND: {
2924         const struct ovs_key_nd *mask = ma ? nl_attr_get(ma) : NULL;
2925         const struct ovs_key_nd *key = nl_attr_get(a);
2926
2927         format_ipv6(ds, "target", key->nd_target, MASK(mask, nd_target),
2928                     verbose);
2929         format_eth(ds, "sll", key->nd_sll, MASK(mask, nd_sll), verbose);
2930         format_eth(ds, "tll", key->nd_tll, MASK(mask, nd_tll), verbose);
2931
2932         ds_chomp(ds, ',');
2933         break;
2934     }
2935     case OVS_KEY_ATTR_UNSPEC:
2936     case __OVS_KEY_ATTR_MAX:
2937     default:
2938         format_generic_odp_key(a, ds);
2939         if (!is_exact) {
2940             ds_put_char(ds, '/');
2941             format_generic_odp_key(ma, ds);
2942         }
2943         break;
2944     }
2945     ds_put_char(ds, ')');
2946 }
2947
2948 static struct nlattr *
2949 generate_all_wildcard_mask(const struct attr_len_tbl tbl[], int max,
2950                            struct ofpbuf *ofp, const struct nlattr *key)
2951 {
2952     const struct nlattr *a;
2953     unsigned int left;
2954     int type = nl_attr_type(key);
2955     int size = nl_attr_get_size(key);
2956
2957     if (odp_key_attr_len(tbl, max, type) != ATTR_LEN_NESTED) {
2958         nl_msg_put_unspec_zero(ofp, type, size);
2959     } else {
2960         size_t nested_mask;
2961
2962         if (tbl[type].next) {
2963             tbl = tbl[type].next;
2964             max = tbl[type].next_max;
2965         }
2966
2967         nested_mask = nl_msg_start_nested(ofp, type);
2968         NL_ATTR_FOR_EACH(a, left, key, nl_attr_get_size(key)) {
2969             generate_all_wildcard_mask(tbl, max, ofp, nl_attr_get(a));
2970         }
2971         nl_msg_end_nested(ofp, nested_mask);
2972     }
2973
2974     return ofp->base;
2975 }
2976
2977 static void
2978 format_u128(struct ds *ds, const ovs_u128 *key, const ovs_u128 *mask,
2979             bool verbose)
2980 {
2981     if (verbose || (mask && !ovs_u128_is_zero(*mask))) {
2982         ovs_be128 value;
2983
2984         value = hton128(*key);
2985         ds_put_hex(ds, &value, sizeof value);
2986         if (mask && !(ovs_u128_is_ones(*mask))) {
2987             value = hton128(*mask);
2988             ds_put_char(ds, '/');
2989             ds_put_hex(ds, &value, sizeof value);
2990         }
2991     }
2992 }
2993
2994 /* Read the string from 's_' as a 128-bit value.  If the string contains
2995  * a "/", the rest of the string will be treated as a 128-bit mask.
2996  *
2997  * If either the value or mask is larger than 64 bits, the string must
2998  * be in hexadecimal.
2999  */
3000 static int
3001 scan_u128(const char *s_, ovs_u128 *value, ovs_u128 *mask)
3002 {
3003     char *s = CONST_CAST(char *, s_);
3004     ovs_be128 be_value;
3005     ovs_be128 be_mask;
3006
3007     if (!parse_int_string(s, (uint8_t *)&be_value, sizeof be_value, &s)) {
3008         *value = ntoh128(be_value);
3009
3010         if (mask) {
3011             int n;
3012
3013             if (ovs_scan(s, "/%n", &n)) {
3014                 int error;
3015
3016                 s += n;
3017                 error = parse_int_string(s, (uint8_t *)&be_mask,
3018                                          sizeof be_mask, &s);
3019                 if (error) {
3020                     return error;
3021                 }
3022                 *mask = ntoh128(be_mask);
3023             } else {
3024                 *mask = OVS_U128_MAX;
3025             }
3026         }
3027         return s - s_;
3028     }
3029
3030     return 0;
3031 }
3032
3033 int
3034 odp_ufid_from_string(const char *s_, ovs_u128 *ufid)
3035 {
3036     const char *s = s_;
3037
3038     if (ovs_scan(s, "ufid:")) {
3039         s += 5;
3040
3041         if (!uuid_from_string_prefix((struct uuid *)ufid, s)) {
3042             return -EINVAL;
3043         }
3044         s += UUID_LEN;
3045
3046         return s - s_;
3047     }
3048
3049     return 0;
3050 }
3051
3052 void
3053 odp_format_ufid(const ovs_u128 *ufid, struct ds *ds)
3054 {
3055     ds_put_format(ds, "ufid:"UUID_FMT, UUID_ARGS((struct uuid *)ufid));
3056 }
3057
3058 /* Appends to 'ds' a string representation of the 'key_len' bytes of
3059  * OVS_KEY_ATTR_* attributes in 'key'. If non-null, additionally formats the
3060  * 'mask_len' bytes of 'mask' which apply to 'key'. If 'portno_names' is
3061  * non-null and 'verbose' is true, translates odp port number to its name. */
3062 void
3063 odp_flow_format(const struct nlattr *key, size_t key_len,
3064                 const struct nlattr *mask, size_t mask_len,
3065                 const struct hmap *portno_names, struct ds *ds, bool verbose)
3066 {
3067     if (key_len) {
3068         const struct nlattr *a;
3069         unsigned int left;
3070         bool has_ethtype_key = false;
3071         const struct nlattr *ma = NULL;
3072         struct ofpbuf ofp;
3073         bool first_field = true;
3074
3075         ofpbuf_init(&ofp, 100);
3076         NL_ATTR_FOR_EACH (a, left, key, key_len) {
3077             bool is_nested_attr;
3078             bool is_wildcard = false;
3079             int attr_type = nl_attr_type(a);
3080
3081             if (attr_type == OVS_KEY_ATTR_ETHERTYPE) {
3082                 has_ethtype_key = true;
3083             }
3084
3085             is_nested_attr = odp_key_attr_len(ovs_flow_key_attr_lens,
3086                                               OVS_KEY_ATTR_MAX, attr_type) ==
3087                              ATTR_LEN_NESTED;
3088
3089             if (mask && mask_len) {
3090                 ma = nl_attr_find__(mask, mask_len, nl_attr_type(a));
3091                 is_wildcard = ma ? odp_mask_attr_is_wildcard(ma) : true;
3092             }
3093
3094             if (verbose || !is_wildcard  || is_nested_attr) {
3095                 if (is_wildcard && !ma) {
3096                     ma = generate_all_wildcard_mask(ovs_flow_key_attr_lens,
3097                                                     OVS_KEY_ATTR_MAX,
3098                                                     &ofp, a);
3099                 }
3100                 if (!first_field) {
3101                     ds_put_char(ds, ',');
3102                 }
3103                 format_odp_key_attr(a, ma, portno_names, ds, verbose);
3104                 first_field = false;
3105             }
3106             ofpbuf_clear(&ofp);
3107         }
3108         ofpbuf_uninit(&ofp);
3109
3110         if (left) {
3111             int i;
3112
3113             if (left == key_len) {
3114                 ds_put_cstr(ds, "<empty>");
3115             }
3116             ds_put_format(ds, ",***%u leftover bytes*** (", left);
3117             for (i = 0; i < left; i++) {
3118                 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
3119             }
3120             ds_put_char(ds, ')');
3121         }
3122         if (!has_ethtype_key) {
3123             ma = nl_attr_find__(mask, mask_len, OVS_KEY_ATTR_ETHERTYPE);
3124             if (ma) {
3125                 ds_put_format(ds, ",eth_type(0/0x%04"PRIx16")",
3126                               ntohs(nl_attr_get_be16(ma)));
3127             }
3128         }
3129     } else {
3130         ds_put_cstr(ds, "<empty>");
3131     }
3132 }
3133
3134 /* Appends to 'ds' a string representation of the 'key_len' bytes of
3135  * OVS_KEY_ATTR_* attributes in 'key'. */
3136 void
3137 odp_flow_key_format(const struct nlattr *key,
3138                     size_t key_len, struct ds *ds)
3139 {
3140     odp_flow_format(key, key_len, NULL, 0, NULL, ds, true);
3141 }
3142
3143 static bool
3144 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
3145 {
3146     if (!strcasecmp(s, "no")) {
3147         *type = OVS_FRAG_TYPE_NONE;
3148     } else if (!strcasecmp(s, "first")) {
3149         *type = OVS_FRAG_TYPE_FIRST;
3150     } else if (!strcasecmp(s, "later")) {
3151         *type = OVS_FRAG_TYPE_LATER;
3152     } else {
3153         return false;
3154     }
3155     return true;
3156 }
3157
3158 /* Parsing. */
3159
3160 static int
3161 scan_eth(const char *s, struct eth_addr *key, struct eth_addr *mask)
3162 {
3163     int n;
3164
3165     if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n",
3166                  ETH_ADDR_SCAN_ARGS(*key), &n)) {
3167         int len = n;
3168
3169         if (mask) {
3170             if (ovs_scan(s + len, "/"ETH_ADDR_SCAN_FMT"%n",
3171                          ETH_ADDR_SCAN_ARGS(*mask), &n)) {
3172                 len += n;
3173             } else {
3174                 memset(mask, 0xff, sizeof *mask);
3175             }
3176         }
3177         return len;
3178     }
3179     return 0;
3180 }
3181
3182 static int
3183 scan_ipv4(const char *s, ovs_be32 *key, ovs_be32 *mask)
3184 {
3185     int n;
3186
3187     if (ovs_scan(s, IP_SCAN_FMT"%n", IP_SCAN_ARGS(key), &n)) {
3188         int len = n;
3189
3190         if (mask) {
3191             if (ovs_scan(s + len, "/"IP_SCAN_FMT"%n",
3192                          IP_SCAN_ARGS(mask), &n)) {
3193                 len += n;
3194             } else {
3195                 *mask = OVS_BE32_MAX;
3196             }
3197         }
3198         return len;
3199     }
3200     return 0;
3201 }
3202
3203 static int
3204 scan_in6_addr(const char *s, struct in6_addr *key, struct in6_addr *mask)
3205 {
3206     int n;
3207     char ipv6_s[IPV6_SCAN_LEN + 1];
3208
3209     if (ovs_scan(s, IPV6_SCAN_FMT"%n", ipv6_s, &n)
3210         && inet_pton(AF_INET6, ipv6_s, key) == 1) {
3211         int len = n;
3212
3213         if (mask) {
3214             if (ovs_scan(s + len, "/"IPV6_SCAN_FMT"%n", ipv6_s, &n)
3215                 && inet_pton(AF_INET6, ipv6_s, mask) == 1) {
3216                 len += n;
3217             } else {
3218                 memset(mask, 0xff, sizeof *mask);
3219             }
3220         }
3221         return len;
3222     }
3223     return 0;
3224 }
3225
3226 static int
3227 scan_ipv6(const char *s, ovs_be32 (*key)[4], ovs_be32 (*mask)[4])
3228 {
3229     return scan_in6_addr(s, key ? (struct in6_addr *) *key : NULL,
3230                          mask ? (struct in6_addr *) *mask : NULL);
3231 }
3232
3233 static int
3234 scan_ipv6_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
3235 {
3236     int key_, mask_;
3237     int n;
3238
3239     if (ovs_scan(s, "%i%n", &key_, &n)
3240         && (key_ & ~IPV6_LABEL_MASK) == 0) {
3241         int len = n;
3242
3243         *key = htonl(key_);
3244         if (mask) {
3245             if (ovs_scan(s + len, "/%i%n", &mask_, &n)
3246                 && (mask_ & ~IPV6_LABEL_MASK) == 0) {
3247                 len += n;
3248                 *mask = htonl(mask_);
3249             } else {
3250                 *mask = htonl(IPV6_LABEL_MASK);
3251             }
3252         }
3253         return len;
3254     }
3255     return 0;
3256 }
3257
3258 static int
3259 scan_u8(const char *s, uint8_t *key, uint8_t *mask)
3260 {
3261     int n;
3262
3263     if (ovs_scan(s, "%"SCNi8"%n", key, &n)) {
3264         int len = n;
3265
3266         if (mask) {
3267             if (ovs_scan(s + len, "/%"SCNi8"%n", mask, &n)) {
3268                 len += n;
3269             } else {
3270                 *mask = UINT8_MAX;
3271             }
3272         }
3273         return len;
3274     }
3275     return 0;
3276 }
3277
3278 static int
3279 scan_u16(const char *s, uint16_t *key, uint16_t *mask)
3280 {
3281     int n;
3282
3283     if (ovs_scan(s, "%"SCNi16"%n", key, &n)) {
3284         int len = n;
3285
3286         if (mask) {
3287             if (ovs_scan(s + len, "/%"SCNi16"%n", mask, &n)) {
3288                 len += n;
3289             } else {
3290                 *mask = UINT16_MAX;
3291             }
3292         }
3293         return len;
3294     }
3295     return 0;
3296 }
3297
3298 static int
3299 scan_u32(const char *s, uint32_t *key, uint32_t *mask)
3300 {
3301     int n;
3302
3303     if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
3304         int len = n;
3305
3306         if (mask) {
3307             if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
3308                 len += n;
3309             } else {
3310                 *mask = UINT32_MAX;
3311             }
3312         }
3313         return len;
3314     }
3315     return 0;
3316 }
3317
3318 static int
3319 scan_be16(const char *s, ovs_be16 *key, ovs_be16 *mask)
3320 {
3321     uint16_t key_, mask_;
3322     int n;
3323
3324     if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
3325         int len = n;
3326
3327         *key = htons(key_);
3328         if (mask) {
3329             if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
3330                 len += n;
3331                 *mask = htons(mask_);
3332             } else {
3333                 *mask = OVS_BE16_MAX;
3334             }
3335         }
3336         return len;
3337     }
3338     return 0;
3339 }
3340
3341 static int
3342 scan_be64(const char *s, ovs_be64 *key, ovs_be64 *mask)
3343 {
3344     uint64_t key_, mask_;
3345     int n;
3346
3347     if (ovs_scan(s, "%"SCNi64"%n", &key_, &n)) {
3348         int len = n;
3349
3350         *key = htonll(key_);
3351         if (mask) {
3352             if (ovs_scan(s + len, "/%"SCNi64"%n", &mask_, &n)) {
3353                 len += n;
3354                 *mask = htonll(mask_);
3355             } else {
3356                 *mask = OVS_BE64_MAX;
3357             }
3358         }
3359         return len;
3360     }
3361     return 0;
3362 }
3363
3364 static int
3365 scan_tun_flags(const char *s, uint16_t *key, uint16_t *mask)
3366 {
3367     uint32_t flags, fmask;
3368     int n;
3369
3370     n = parse_odp_flags(s, flow_tun_flag_to_string, &flags,
3371                         FLOW_TNL_F_MASK, mask ? &fmask : NULL);
3372     if (n >= 0 && s[n] == ')') {
3373         *key = flags;
3374         if (mask) {
3375             *mask = fmask;
3376         }
3377         return n + 1;
3378     }
3379     return 0;
3380 }
3381
3382 static int
3383 scan_tcp_flags(const char *s, ovs_be16 *key, ovs_be16 *mask)
3384 {
3385     uint32_t flags, fmask;
3386     int n;
3387
3388     n = parse_odp_flags(s, packet_tcp_flag_to_string, &flags,
3389                         TCP_FLAGS(OVS_BE16_MAX), mask ? &fmask : NULL);
3390     if (n >= 0) {
3391         *key = htons(flags);
3392         if (mask) {
3393             *mask = htons(fmask);
3394         }
3395         return n;
3396     }
3397     return 0;
3398 }
3399
3400 static uint32_t
3401 ovs_to_odp_ct_state(uint8_t state)
3402 {
3403     uint32_t odp = 0;
3404
3405     if (state & CS_NEW) {
3406         odp |= OVS_CS_F_NEW;
3407     }
3408     if (state & CS_ESTABLISHED) {
3409         odp |= OVS_CS_F_ESTABLISHED;
3410     }
3411     if (state & CS_RELATED) {
3412         odp |= OVS_CS_F_RELATED;
3413     }
3414     if (state & CS_INVALID) {
3415         odp |= OVS_CS_F_INVALID;
3416     }
3417     if (state & CS_REPLY_DIR) {
3418         odp |= OVS_CS_F_REPLY_DIR;
3419     }
3420     if (state & CS_TRACKED) {
3421         odp |= OVS_CS_F_TRACKED;
3422     }
3423     if (state & CS_SRC_NAT) {
3424         odp |= OVS_CS_F_SRC_NAT;
3425     }
3426     if (state & CS_DST_NAT) {
3427         odp |= OVS_CS_F_DST_NAT;
3428     }
3429
3430     return odp;
3431 }
3432
3433 static uint8_t
3434 odp_to_ovs_ct_state(uint32_t flags)
3435 {
3436     uint32_t state = 0;
3437
3438     if (flags & OVS_CS_F_NEW) {
3439         state |= CS_NEW;
3440     }
3441     if (flags & OVS_CS_F_ESTABLISHED) {
3442         state |= CS_ESTABLISHED;
3443     }
3444     if (flags & OVS_CS_F_RELATED) {
3445         state |= CS_RELATED;
3446     }
3447     if (flags & OVS_CS_F_INVALID) {
3448         state |= CS_INVALID;
3449     }
3450     if (flags & OVS_CS_F_REPLY_DIR) {
3451         state |= CS_REPLY_DIR;
3452     }
3453     if (flags & OVS_CS_F_TRACKED) {
3454         state |= CS_TRACKED;
3455     }
3456     if (flags & OVS_CS_F_SRC_NAT) {
3457         state |= CS_SRC_NAT;
3458     }
3459     if (flags & OVS_CS_F_DST_NAT) {
3460         state |= CS_DST_NAT;
3461     }
3462
3463     return state;
3464 }
3465
3466 static int
3467 scan_ct_state(const char *s, uint32_t *key, uint32_t *mask)
3468 {
3469     uint32_t flags, fmask;
3470     int n;
3471
3472     n = parse_flags(s, odp_ct_state_to_string, ')', NULL, NULL, &flags,
3473                     ovs_to_odp_ct_state(CS_SUPPORTED_MASK),
3474                     mask ? &fmask : NULL);
3475
3476     if (n >= 0) {
3477         *key = flags;
3478         if (mask) {
3479             *mask = fmask;
3480         }
3481         return n;
3482     }
3483     return 0;
3484 }
3485
3486 static int
3487 scan_frag(const char *s, uint8_t *key, uint8_t *mask)
3488 {
3489     int n;
3490     char frag[8];
3491     enum ovs_frag_type frag_type;
3492
3493     if (ovs_scan(s, "%7[a-z]%n", frag, &n)
3494         && ovs_frag_type_from_string(frag, &frag_type)) {
3495         int len = n;
3496
3497         *key = frag_type;
3498         if (mask) {
3499             *mask = UINT8_MAX;
3500         }
3501         return len;
3502     }
3503     return 0;
3504 }
3505
3506 static int
3507 scan_port(const char *s, uint32_t *key, uint32_t *mask,
3508           const struct simap *port_names)
3509 {
3510     int n;
3511
3512     if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
3513         int len = n;
3514
3515         if (mask) {
3516             if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
3517                 len += n;
3518             } else {
3519                 *mask = UINT32_MAX;
3520             }
3521         }
3522         return len;
3523     } else if (port_names) {
3524         const struct simap_node *node;
3525         int len;
3526
3527         len = strcspn(s, ")");
3528         node = simap_find_len(port_names, s, len);
3529         if (node) {
3530             *key = node->data;
3531
3532             if (mask) {
3533                 *mask = UINT32_MAX;
3534             }
3535             return len;
3536         }
3537     }
3538     return 0;
3539 }
3540
3541 /* Helper for vlan parsing. */
3542 struct ovs_key_vlan__ {
3543     ovs_be16 tci;
3544 };
3545
3546 static bool
3547 set_be16_bf(ovs_be16 *bf, uint8_t bits, uint8_t offset, uint16_t value)
3548 {
3549     const uint16_t mask = ((1U << bits) - 1) << offset;
3550
3551     if (value >> bits) {
3552         return false;
3553     }
3554
3555     *bf = htons((ntohs(*bf) & ~mask) | (value << offset));
3556     return true;
3557 }
3558
3559 static int
3560 scan_be16_bf(const char *s, ovs_be16 *key, ovs_be16 *mask, uint8_t bits,
3561              uint8_t offset)
3562 {
3563     uint16_t key_, mask_;
3564     int n;
3565
3566     if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
3567         int len = n;
3568
3569         if (set_be16_bf(key, bits, offset, key_)) {
3570             if (mask) {
3571                 if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
3572                     len += n;
3573
3574                     if (!set_be16_bf(mask, bits, offset, mask_)) {
3575                         return 0;
3576                     }
3577                 } else {
3578                     *mask |= htons(((1U << bits) - 1) << offset);
3579                 }
3580             }
3581             return len;
3582         }
3583     }
3584     return 0;
3585 }
3586
3587 static int
3588 scan_vid(const char *s, ovs_be16 *key, ovs_be16 *mask)
3589 {
3590     return scan_be16_bf(s, key, mask, 12, VLAN_VID_SHIFT);
3591 }
3592
3593 static int
3594 scan_pcp(const char *s, ovs_be16 *key, ovs_be16 *mask)
3595 {
3596     return scan_be16_bf(s, key, mask, 3, VLAN_PCP_SHIFT);
3597 }
3598
3599 static int
3600 scan_cfi(const char *s, ovs_be16 *key, ovs_be16 *mask)
3601 {
3602     return scan_be16_bf(s, key, mask, 1, VLAN_CFI_SHIFT);
3603 }
3604
3605 /* For MPLS. */
3606 static bool
3607 set_be32_bf(ovs_be32 *bf, uint8_t bits, uint8_t offset, uint32_t value)
3608 {
3609     const uint32_t mask = ((1U << bits) - 1) << offset;
3610
3611     if (value >> bits) {
3612         return false;
3613     }
3614
3615     *bf = htonl((ntohl(*bf) & ~mask) | (value << offset));
3616     return true;
3617 }
3618
3619 static int
3620 scan_be32_bf(const char *s, ovs_be32 *key, ovs_be32 *mask, uint8_t bits,
3621              uint8_t offset)
3622 {
3623     uint32_t key_, mask_;
3624     int n;
3625
3626     if (ovs_scan(s, "%"SCNi32"%n", &key_, &n)) {
3627         int len = n;
3628
3629         if (set_be32_bf(key, bits, offset, key_)) {
3630             if (mask) {
3631                 if (ovs_scan(s + len, "/%"SCNi32"%n", &mask_, &n)) {
3632                     len += n;
3633
3634                     if (!set_be32_bf(mask, bits, offset, mask_)) {
3635                         return 0;
3636                     }
3637                 } else {
3638                     *mask |= htonl(((1U << bits) - 1) << offset);
3639                 }
3640             }
3641             return len;
3642         }
3643     }
3644     return 0;
3645 }
3646
3647 static int
3648 scan_mpls_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
3649 {
3650     return scan_be32_bf(s, key, mask, 20, MPLS_LABEL_SHIFT);
3651 }
3652
3653 static int
3654 scan_mpls_tc(const char *s, ovs_be32 *key, ovs_be32 *mask)
3655 {
3656     return scan_be32_bf(s, key, mask, 3, MPLS_TC_SHIFT);
3657 }
3658
3659 static int
3660 scan_mpls_ttl(const char *s, ovs_be32 *key, ovs_be32 *mask)
3661 {
3662     return scan_be32_bf(s, key, mask, 8, MPLS_TTL_SHIFT);
3663 }
3664
3665 static int
3666 scan_mpls_bos(const char *s, ovs_be32 *key, ovs_be32 *mask)
3667 {
3668     return scan_be32_bf(s, key, mask, 1, MPLS_BOS_SHIFT);
3669 }
3670
3671 static int
3672 scan_vxlan_gbp(const char *s, uint32_t *key, uint32_t *mask)
3673 {
3674     const char *s_base = s;
3675     ovs_be16 id = 0, id_mask = 0;
3676     uint8_t flags = 0, flags_mask = 0;
3677
3678     if (!strncmp(s, "id=", 3)) {
3679         s += 3;
3680         s += scan_be16(s, &id, mask ? &id_mask : NULL);
3681     }
3682
3683     if (s[0] == ',') {
3684         s++;
3685     }
3686     if (!strncmp(s, "flags=", 6)) {
3687         s += 6;
3688         s += scan_u8(s, &flags, mask ? &flags_mask : NULL);
3689     }
3690
3691     if (!strncmp(s, "))", 2)) {
3692         s += 2;
3693
3694         *key = (flags << 16) | ntohs(id);
3695         if (mask) {
3696             *mask = (flags_mask << 16) | ntohs(id_mask);
3697         }
3698
3699         return s - s_base;
3700     }
3701
3702     return 0;
3703 }
3704
3705 static int
3706 scan_geneve(const char *s, struct geneve_scan *key, struct geneve_scan *mask)
3707 {
3708     const char *s_base = s;
3709     struct geneve_opt *opt = key->d;
3710     struct geneve_opt *opt_mask = mask ? mask->d : NULL;
3711     int len_remain = sizeof key->d;
3712
3713     while (s[0] == '{' && len_remain >= sizeof *opt) {
3714         int data_len = 0;
3715
3716         s++;
3717         len_remain -= sizeof *opt;
3718
3719         if (!strncmp(s, "class=", 6)) {
3720             s += 6;
3721             s += scan_be16(s, &opt->opt_class,
3722                            mask ? &opt_mask->opt_class : NULL);
3723         } else if (mask) {
3724             memset(&opt_mask->opt_class, 0, sizeof opt_mask->opt_class);
3725         }
3726
3727         if (s[0] == ',') {
3728             s++;
3729         }
3730         if (!strncmp(s, "type=", 5)) {
3731             s += 5;
3732             s += scan_u8(s, &opt->type, mask ? &opt_mask->type : NULL);
3733         } else if (mask) {
3734             memset(&opt_mask->type, 0, sizeof opt_mask->type);
3735         }
3736
3737         if (s[0] == ',') {
3738             s++;
3739         }
3740         if (!strncmp(s, "len=", 4)) {
3741             uint8_t opt_len, opt_len_mask;
3742             s += 4;
3743             s += scan_u8(s, &opt_len, mask ? &opt_len_mask : NULL);
3744
3745             if (opt_len > 124 || opt_len % 4 || opt_len > len_remain) {
3746                 return 0;
3747             }
3748             opt->length = opt_len / 4;
3749             if (mask) {
3750                 opt_mask->length = opt_len_mask;
3751             }
3752             data_len = opt_len;
3753         } else if (mask) {
3754             memset(&opt_mask->type, 0, sizeof opt_mask->type);
3755         }
3756
3757         if (s[0] == ',') {
3758             s++;
3759         }
3760         if (parse_int_string(s, (uint8_t *)(opt + 1), data_len, (char **)&s)) {
3761             return 0;
3762         }
3763
3764         if (mask) {
3765             if (s[0] == '/') {
3766                 s++;
3767                 if (parse_int_string(s, (uint8_t *)(opt_mask + 1),
3768                                      data_len, (char **)&s)) {
3769                     return 0;
3770                 }
3771             }
3772             opt_mask->r1 = 0;
3773             opt_mask->r2 = 0;
3774             opt_mask->r3 = 0;
3775         }
3776
3777         if (s[0] == '}') {
3778             s++;
3779             opt += 1 + data_len / 4;
3780             if (mask) {
3781                 opt_mask += 1 + data_len / 4;
3782             }
3783             len_remain -= data_len;
3784         }
3785     }
3786
3787     if (s[0] == ')') {
3788         int len = sizeof key->d - len_remain;
3789
3790         s++;
3791         key->len = len;
3792         if (mask) {
3793             mask->len = len;
3794         }
3795         return s - s_base;
3796     }
3797
3798     return 0;
3799 }
3800
3801 static void
3802 tun_flags_to_attr(struct ofpbuf *a, const void *data_)
3803 {
3804     const uint16_t *flags = data_;
3805
3806     if (*flags & FLOW_TNL_F_DONT_FRAGMENT) {
3807         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
3808     }
3809     if (*flags & FLOW_TNL_F_CSUM) {
3810         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
3811     }
3812     if (*flags & FLOW_TNL_F_OAM) {
3813         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
3814     }
3815 }
3816
3817 static void
3818 vxlan_gbp_to_attr(struct ofpbuf *a, const void *data_)
3819 {
3820     const uint32_t *gbp = data_;
3821
3822     if (*gbp) {
3823         size_t vxlan_opts_ofs;
3824
3825         vxlan_opts_ofs = nl_msg_start_nested(a, OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS);
3826         nl_msg_put_u32(a, OVS_VXLAN_EXT_GBP, *gbp);
3827         nl_msg_end_nested(a, vxlan_opts_ofs);
3828     }
3829 }
3830
3831 static void
3832 geneve_to_attr(struct ofpbuf *a, const void *data_)
3833 {
3834     const struct geneve_scan *geneve = data_;
3835
3836     nl_msg_put_unspec(a, OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, geneve->d,
3837                       geneve->len);
3838 }
3839
3840 #define SCAN_PUT_ATTR(BUF, ATTR, DATA, FUNC)                      \
3841     {                                                             \
3842         unsigned long call_fn = (unsigned long)FUNC;              \
3843         if (call_fn) {                                            \
3844             typedef void (*fn)(struct ofpbuf *, const void *);    \
3845             fn func = FUNC;                                       \
3846             func(BUF, &(DATA));                                   \
3847         } else {                                                  \
3848             nl_msg_put_unspec(BUF, ATTR, &(DATA), sizeof (DATA)); \
3849         }                                                         \
3850     }
3851
3852 #define SCAN_IF(NAME)                           \
3853     if (strncmp(s, NAME, strlen(NAME)) == 0) {  \
3854         const char *start = s;                  \
3855         int len;                                \
3856                                                 \
3857         s += strlen(NAME)
3858
3859 /* Usually no special initialization is needed. */
3860 #define SCAN_BEGIN(NAME, TYPE)                  \
3861     SCAN_IF(NAME);                              \
3862         TYPE skey, smask;                       \
3863         memset(&skey, 0, sizeof skey);          \
3864         memset(&smask, 0, sizeof smask);        \
3865         do {                                    \
3866             len = 0;
3867
3868 /* Init as fully-masked as mask will not be scanned. */
3869 #define SCAN_BEGIN_FULLY_MASKED(NAME, TYPE)     \
3870     SCAN_IF(NAME);                              \
3871         TYPE skey, smask;                       \
3872         memset(&skey, 0, sizeof skey);          \
3873         memset(&smask, 0xff, sizeof smask);     \
3874         do {                                    \
3875             len = 0;
3876
3877 /* VLAN needs special initialization. */
3878 #define SCAN_BEGIN_INIT(NAME, TYPE, KEY_INIT, MASK_INIT)  \
3879     SCAN_IF(NAME);                                        \
3880         TYPE skey = KEY_INIT;                       \
3881         TYPE smask = MASK_INIT;                     \
3882         do {                                        \
3883             len = 0;
3884
3885 /* Scan unnamed entry as 'TYPE' */
3886 #define SCAN_TYPE(TYPE, KEY, MASK)              \
3887     len = scan_##TYPE(s, KEY, MASK);            \
3888     if (len == 0) {                             \
3889         return -EINVAL;                         \
3890     }                                           \
3891     s += len
3892
3893 /* Scan named ('NAME') entry 'FIELD' as 'TYPE'. */
3894 #define SCAN_FIELD(NAME, TYPE, FIELD)                                   \
3895     if (strncmp(s, NAME, strlen(NAME)) == 0) {                          \
3896         s += strlen(NAME);                                              \
3897         SCAN_TYPE(TYPE, &skey.FIELD, mask ? &smask.FIELD : NULL);       \
3898         continue;                                                       \
3899     }
3900
3901 #define SCAN_FINISH()                           \
3902         } while (*s++ == ',' && len != 0);      \
3903         if (s[-1] != ')') {                     \
3904             return -EINVAL;                     \
3905         }
3906
3907 #define SCAN_FINISH_SINGLE()                    \
3908         } while (false);                        \
3909         if (*s++ != ')') {                      \
3910             return -EINVAL;                     \
3911         }
3912
3913 /* Beginning of nested attribute. */
3914 #define SCAN_BEGIN_NESTED(NAME, ATTR)                      \
3915     SCAN_IF(NAME);                                         \
3916         size_t key_offset, mask_offset;                    \
3917         key_offset = nl_msg_start_nested(key, ATTR);       \
3918         if (mask) {                                        \
3919             mask_offset = nl_msg_start_nested(mask, ATTR); \
3920         }                                                  \
3921         do {                                               \
3922             len = 0;
3923
3924 #define SCAN_END_NESTED()                               \
3925         SCAN_FINISH();                                  \
3926         nl_msg_end_nested(key, key_offset);             \
3927         if (mask) {                                     \
3928             nl_msg_end_nested(mask, mask_offset);       \
3929         }                                               \
3930         return s - start;                               \
3931     }
3932
3933 #define SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, FUNC)  \
3934     if (strncmp(s, NAME, strlen(NAME)) == 0) {                \
3935         TYPE skey, smask;                                     \
3936         memset(&skey, 0, sizeof skey);                        \
3937         memset(&smask, 0xff, sizeof smask);                   \
3938         s += strlen(NAME);                                    \
3939         SCAN_TYPE(SCAN_AS, &skey, &smask);                    \
3940         SCAN_PUT(ATTR, FUNC);                                 \
3941         continue;                                             \
3942     }
3943
3944 #define SCAN_FIELD_NESTED(NAME, TYPE, SCAN_AS, ATTR)  \
3945         SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, NULL)
3946
3947 #define SCAN_FIELD_NESTED_FUNC(NAME, TYPE, SCAN_AS, FUNC)  \
3948         SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, 0, FUNC)
3949
3950 #define SCAN_PUT(ATTR, FUNC)                            \
3951         SCAN_PUT_ATTR(key, ATTR, skey, FUNC);           \
3952         if (mask)                                       \
3953             SCAN_PUT_ATTR(mask, ATTR, smask, FUNC);     \
3954
3955 #define SCAN_END(ATTR)                                  \
3956         SCAN_FINISH();                                  \
3957         SCAN_PUT(ATTR, NULL);                           \
3958         return s - start;                               \
3959     }
3960
3961 #define SCAN_BEGIN_ARRAY(NAME, TYPE, CNT)       \
3962     SCAN_IF(NAME);                              \
3963         TYPE skey[CNT], smask[CNT];             \
3964         memset(&skey, 0, sizeof skey);          \
3965         memset(&smask, 0, sizeof smask);        \
3966         int idx = 0, cnt = CNT;                 \
3967         uint64_t fields = 0;                    \
3968         do {                                    \
3969             int field = 0;                      \
3970             len = 0;
3971
3972 /* Scan named ('NAME') entry 'FIELD' as 'TYPE'. */
3973 #define SCAN_FIELD_ARRAY(NAME, TYPE, FIELD)                             \
3974     if (strncmp(s, NAME, strlen(NAME)) == 0) {                          \
3975         if (fields & (1UL << field)) {                                  \
3976             fields = 0;                                                 \
3977             if (++idx == cnt) {                                         \
3978                 break;                                                  \
3979             }                                                           \
3980         }                                                               \
3981         s += strlen(NAME);                                              \
3982         SCAN_TYPE(TYPE, &skey[idx].FIELD, mask ? &smask[idx].FIELD : NULL); \
3983         fields |= 1UL << field;                                         \
3984         continue;                                                       \
3985     }                                                                   \
3986     field++;
3987
3988 #define SCAN_PUT_ATTR_ARRAY(BUF, ATTR, DATA, CNT)                    \
3989     nl_msg_put_unspec(BUF, ATTR, &(DATA), sizeof (DATA)[0] * (CNT)); \
3990
3991 #define SCAN_PUT_ARRAY(ATTR, CNT)                        \
3992     SCAN_PUT_ATTR_ARRAY(key, ATTR, skey, CNT);       \
3993     if (mask) {                                      \
3994         SCAN_PUT_ATTR_ARRAY(mask, ATTR, smask, CNT); \
3995     }
3996
3997 #define SCAN_END_ARRAY(ATTR)             \
3998         SCAN_FINISH();                   \
3999         if (idx == cnt) {                \
4000             return -EINVAL;              \
4001         }                                \
4002         SCAN_PUT_ARRAY(ATTR, idx + 1);   \
4003         return s - start;                \
4004     }
4005
4006 #define SCAN_END_SINGLE(ATTR)                           \
4007         SCAN_FINISH_SINGLE();                           \
4008         SCAN_PUT(ATTR, NULL);                           \
4009         return s - start;                               \
4010     }
4011
4012 #define SCAN_SINGLE(NAME, TYPE, SCAN_AS, ATTR)       \
4013     SCAN_BEGIN(NAME, TYPE) {                         \
4014         SCAN_TYPE(SCAN_AS, &skey, &smask);           \
4015     } SCAN_END_SINGLE(ATTR)
4016
4017 #define SCAN_SINGLE_FULLY_MASKED(NAME, TYPE, SCAN_AS, ATTR) \
4018     SCAN_BEGIN_FULLY_MASKED(NAME, TYPE) {                   \
4019         SCAN_TYPE(SCAN_AS, &skey, NULL);                    \
4020     } SCAN_END_SINGLE(ATTR)
4021
4022 /* scan_port needs one extra argument. */
4023 #define SCAN_SINGLE_PORT(NAME, TYPE, ATTR)  \
4024     SCAN_BEGIN(NAME, TYPE) {                            \
4025         len = scan_port(s, &skey, &smask, port_names);  \
4026         if (len == 0) {                                 \
4027             return -EINVAL;                             \
4028         }                                               \
4029         s += len;                                       \
4030     } SCAN_END_SINGLE(ATTR)
4031
4032 static int
4033 parse_odp_key_mask_attr(const char *s, const struct simap *port_names,
4034                         struct ofpbuf *key, struct ofpbuf *mask)
4035 {
4036     ovs_u128 ufid;
4037     int len;
4038
4039     /* Skip UFID. */
4040     len = odp_ufid_from_string(s, &ufid);
4041     if (len) {
4042         return len;
4043     }
4044
4045     SCAN_SINGLE("skb_priority(", uint32_t, u32, OVS_KEY_ATTR_PRIORITY);
4046     SCAN_SINGLE("skb_mark(", uint32_t, u32, OVS_KEY_ATTR_SKB_MARK);
4047     SCAN_SINGLE_FULLY_MASKED("recirc_id(", uint32_t, u32,
4048                              OVS_KEY_ATTR_RECIRC_ID);
4049     SCAN_SINGLE("dp_hash(", uint32_t, u32, OVS_KEY_ATTR_DP_HASH);
4050
4051     SCAN_SINGLE("ct_state(", uint32_t, ct_state, OVS_KEY_ATTR_CT_STATE);
4052     SCAN_SINGLE("ct_zone(", uint16_t, u16, OVS_KEY_ATTR_CT_ZONE);
4053     SCAN_SINGLE("ct_mark(", uint32_t, u32, OVS_KEY_ATTR_CT_MARK);
4054     SCAN_SINGLE("ct_label(", ovs_u128, u128, OVS_KEY_ATTR_CT_LABELS);
4055
4056     SCAN_BEGIN_NESTED("tunnel(", OVS_KEY_ATTR_TUNNEL) {
4057         SCAN_FIELD_NESTED("tun_id=", ovs_be64, be64, OVS_TUNNEL_KEY_ATTR_ID);
4058         SCAN_FIELD_NESTED("src=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_SRC);
4059         SCAN_FIELD_NESTED("dst=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_DST);
4060         SCAN_FIELD_NESTED("ipv6_src=", struct in6_addr, in6_addr, OVS_TUNNEL_KEY_ATTR_IPV6_SRC);
4061         SCAN_FIELD_NESTED("ipv6_dst=", struct in6_addr, in6_addr, OVS_TUNNEL_KEY_ATTR_IPV6_DST);
4062         SCAN_FIELD_NESTED("tos=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TOS);
4063         SCAN_FIELD_NESTED("ttl=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TTL);
4064         SCAN_FIELD_NESTED("tp_src=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_SRC);
4065         SCAN_FIELD_NESTED("tp_dst=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_DST);
4066         SCAN_FIELD_NESTED_FUNC("vxlan(gbp(", uint32_t, vxlan_gbp, vxlan_gbp_to_attr);
4067         SCAN_FIELD_NESTED_FUNC("geneve(", struct geneve_scan, geneve,
4068                                geneve_to_attr);
4069         SCAN_FIELD_NESTED_FUNC("flags(", uint16_t, tun_flags, tun_flags_to_attr);
4070     } SCAN_END_NESTED();
4071
4072     SCAN_SINGLE_PORT("in_port(", uint32_t, OVS_KEY_ATTR_IN_PORT);
4073
4074     SCAN_BEGIN("eth(", struct ovs_key_ethernet) {
4075         SCAN_FIELD("src=", eth, eth_src);
4076         SCAN_FIELD("dst=", eth, eth_dst);
4077     } SCAN_END(OVS_KEY_ATTR_ETHERNET);
4078
4079     SCAN_BEGIN_INIT("vlan(", struct ovs_key_vlan__,
4080                     { htons(VLAN_CFI) }, { htons(VLAN_CFI) }) {
4081         SCAN_FIELD("vid=", vid, tci);
4082         SCAN_FIELD("pcp=", pcp, tci);
4083         SCAN_FIELD("cfi=", cfi, tci);
4084     } SCAN_END(OVS_KEY_ATTR_VLAN);
4085
4086     SCAN_SINGLE("eth_type(", ovs_be16, be16, OVS_KEY_ATTR_ETHERTYPE);
4087
4088     SCAN_BEGIN_ARRAY("mpls(", struct ovs_key_mpls, FLOW_MAX_MPLS_LABELS) {
4089         SCAN_FIELD_ARRAY("label=", mpls_label, mpls_lse);
4090         SCAN_FIELD_ARRAY("tc=", mpls_tc, mpls_lse);
4091         SCAN_FIELD_ARRAY("ttl=", mpls_ttl, mpls_lse);
4092         SCAN_FIELD_ARRAY("bos=", mpls_bos, mpls_lse);
4093     } SCAN_END_ARRAY(OVS_KEY_ATTR_MPLS);
4094
4095     SCAN_BEGIN("ipv4(", struct ovs_key_ipv4) {
4096         SCAN_FIELD("src=", ipv4, ipv4_src);
4097         SCAN_FIELD("dst=", ipv4, ipv4_dst);
4098         SCAN_FIELD("proto=", u8, ipv4_proto);
4099         SCAN_FIELD("tos=", u8, ipv4_tos);
4100         SCAN_FIELD("ttl=", u8, ipv4_ttl);
4101         SCAN_FIELD("frag=", frag, ipv4_frag);
4102     } SCAN_END(OVS_KEY_ATTR_IPV4);
4103
4104     SCAN_BEGIN("ipv6(", struct ovs_key_ipv6) {
4105         SCAN_FIELD("src=", ipv6, ipv6_src);
4106         SCAN_FIELD("dst=", ipv6, ipv6_dst);
4107         SCAN_FIELD("label=", ipv6_label, ipv6_label);
4108         SCAN_FIELD("proto=", u8, ipv6_proto);
4109         SCAN_FIELD("tclass=", u8, ipv6_tclass);
4110         SCAN_FIELD("hlimit=", u8, ipv6_hlimit);
4111         SCAN_FIELD("frag=", frag, ipv6_frag);
4112     } SCAN_END(OVS_KEY_ATTR_IPV6);
4113
4114     SCAN_BEGIN("tcp(", struct ovs_key_tcp) {
4115         SCAN_FIELD("src=", be16, tcp_src);
4116         SCAN_FIELD("dst=", be16, tcp_dst);
4117     } SCAN_END(OVS_KEY_ATTR_TCP);
4118
4119     SCAN_SINGLE("tcp_flags(", ovs_be16, tcp_flags, OVS_KEY_ATTR_TCP_FLAGS);
4120
4121     SCAN_BEGIN("udp(", struct ovs_key_udp) {
4122         SCAN_FIELD("src=", be16, udp_src);
4123         SCAN_FIELD("dst=", be16, udp_dst);
4124     } SCAN_END(OVS_KEY_ATTR_UDP);
4125
4126     SCAN_BEGIN("sctp(", struct ovs_key_sctp) {
4127         SCAN_FIELD("src=", be16, sctp_src);
4128         SCAN_FIELD("dst=", be16, sctp_dst);
4129     } SCAN_END(OVS_KEY_ATTR_SCTP);
4130
4131     SCAN_BEGIN("icmp(", struct ovs_key_icmp) {
4132         SCAN_FIELD("type=", u8, icmp_type);
4133         SCAN_FIELD("code=", u8, icmp_code);
4134     } SCAN_END(OVS_KEY_ATTR_ICMP);
4135
4136     SCAN_BEGIN("icmpv6(", struct ovs_key_icmpv6) {
4137         SCAN_FIELD("type=", u8, icmpv6_type);
4138         SCAN_FIELD("code=", u8, icmpv6_code);
4139     } SCAN_END(OVS_KEY_ATTR_ICMPV6);
4140
4141     SCAN_BEGIN("arp(", struct ovs_key_arp) {
4142         SCAN_FIELD("sip=", ipv4, arp_sip);
4143         SCAN_FIELD("tip=", ipv4, arp_tip);
4144         SCAN_FIELD("op=", be16, arp_op);
4145         SCAN_FIELD("sha=", eth, arp_sha);
4146         SCAN_FIELD("tha=", eth, arp_tha);
4147     } SCAN_END(OVS_KEY_ATTR_ARP);
4148
4149     SCAN_BEGIN("nd(", struct ovs_key_nd) {
4150         SCAN_FIELD("target=", ipv6, nd_target);
4151         SCAN_FIELD("sll=", eth, nd_sll);
4152         SCAN_FIELD("tll=", eth, nd_tll);
4153     } SCAN_END(OVS_KEY_ATTR_ND);
4154
4155     /* Encap open-coded. */
4156     if (!strncmp(s, "encap(", 6)) {
4157         const char *start = s;
4158         size_t encap, encap_mask = 0;
4159
4160         encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
4161         if (mask) {
4162             encap_mask = nl_msg_start_nested(mask, OVS_KEY_ATTR_ENCAP);
4163         }
4164
4165         s += 6;
4166         for (;;) {
4167             int retval;
4168
4169             s += strspn(s, delimiters);
4170             if (!*s) {
4171                 return -EINVAL;
4172             } else if (*s == ')') {
4173                 break;
4174             }
4175
4176             retval = parse_odp_key_mask_attr(s, port_names, key, mask);
4177             if (retval < 0) {
4178                 return retval;
4179             }
4180             s += retval;
4181         }
4182         s++;
4183
4184         nl_msg_end_nested(key, encap);
4185         if (mask) {
4186             nl_msg_end_nested(mask, encap_mask);
4187         }
4188
4189         return s - start;
4190     }
4191
4192     return -EINVAL;
4193 }
4194
4195 /* Parses the string representation of a datapath flow key, in the
4196  * format output by odp_flow_key_format().  Returns 0 if successful,
4197  * otherwise a positive errno value.  On success, the flow key is
4198  * appended to 'key' as a series of Netlink attributes.  On failure, no
4199  * data is appended to 'key'.  Either way, 'key''s data might be
4200  * reallocated.
4201  *
4202  * If 'port_names' is nonnull, it points to an simap that maps from a port name
4203  * to a port number.  (Port names may be used instead of port numbers in
4204  * in_port.)
4205  *
4206  * On success, the attributes appended to 'key' are individually syntactically
4207  * valid, but they may not be valid as a sequence.  'key' might, for example,
4208  * have duplicated keys.  odp_flow_key_to_flow() will detect those errors. */
4209 int
4210 odp_flow_from_string(const char *s, const struct simap *port_names,
4211                      struct ofpbuf *key, struct ofpbuf *mask)
4212 {
4213     const size_t old_size = key->size;
4214     for (;;) {
4215         int retval;
4216
4217         s += strspn(s, delimiters);
4218         if (!*s) {
4219             return 0;
4220         }
4221
4222         retval = parse_odp_key_mask_attr(s, port_names, key, mask);
4223         if (retval < 0) {
4224             key->size = old_size;
4225             return -retval;
4226         }
4227         s += retval;
4228     }
4229
4230     return 0;
4231 }
4232
4233 static uint8_t
4234 ovs_to_odp_frag(uint8_t nw_frag, bool is_mask)
4235 {
4236     if (is_mask) {
4237         /* Netlink interface 'enum ovs_frag_type' is an 8-bit enumeration type,
4238          * not a set of flags or bitfields. Hence, if the struct flow nw_frag
4239          * mask, which is a set of bits, has the FLOW_NW_FRAG_ANY as zero, we
4240          * must use a zero mask for the netlink frag field, and all ones mask
4241          * otherwise. */
4242         return (nw_frag & FLOW_NW_FRAG_ANY) ? UINT8_MAX : 0;
4243     }
4244     return !(nw_frag & FLOW_NW_FRAG_ANY) ? OVS_FRAG_TYPE_NONE
4245         : nw_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
4246         : OVS_FRAG_TYPE_FIRST;
4247 }
4248
4249 static void get_ethernet_key(const struct flow *, struct ovs_key_ethernet *);
4250 static void put_ethernet_key(const struct ovs_key_ethernet *, struct flow *);
4251 static void get_ipv4_key(const struct flow *, struct ovs_key_ipv4 *,
4252                          bool is_mask);
4253 static void put_ipv4_key(const struct ovs_key_ipv4 *, struct flow *,
4254                          bool is_mask);
4255 static void get_ipv6_key(const struct flow *, struct ovs_key_ipv6 *,
4256                          bool is_mask);
4257 static void put_ipv6_key(const struct ovs_key_ipv6 *, struct flow *,
4258                          bool is_mask);
4259 static void get_arp_key(const struct flow *, struct ovs_key_arp *);
4260 static void put_arp_key(const struct ovs_key_arp *, struct flow *);
4261 static void get_nd_key(const struct flow *, struct ovs_key_nd *);
4262 static void put_nd_key(const struct ovs_key_nd *, struct flow *);
4263
4264 /* These share the same layout. */
4265 union ovs_key_tp {
4266     struct ovs_key_tcp tcp;
4267     struct ovs_key_udp udp;
4268     struct ovs_key_sctp sctp;
4269 };
4270
4271 static void get_tp_key(const struct flow *, union ovs_key_tp *);
4272 static void put_tp_key(const union ovs_key_tp *, struct flow *);
4273
4274 static void
4275 odp_flow_key_from_flow__(const struct odp_flow_key_parms *parms,
4276                          bool export_mask, struct ofpbuf *buf)
4277 {
4278     struct ovs_key_ethernet *eth_key;
4279     size_t encap;
4280     const struct flow *flow = parms->flow;
4281     const struct flow *data = export_mask ? parms->mask : parms->flow;
4282
4283     nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, data->skb_priority);
4284
4285     if (flow_tnl_dst_is_set(&flow->tunnel) || export_mask) {
4286         tun_key_to_attr(buf, &data->tunnel, &parms->flow->tunnel,
4287                         parms->key_buf);
4288     }
4289
4290     nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, data->pkt_mark);
4291
4292     if (parms->support.ct_state) {
4293         nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_STATE,
4294                        ovs_to_odp_ct_state(data->ct_state));
4295     }
4296     if (parms->support.ct_zone) {
4297         nl_msg_put_u16(buf, OVS_KEY_ATTR_CT_ZONE, data->ct_zone);
4298     }
4299     if (parms->support.ct_mark) {
4300         nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_MARK, data->ct_mark);
4301     }
4302     if (parms->support.ct_label) {
4303         nl_msg_put_unspec(buf, OVS_KEY_ATTR_CT_LABELS, &data->ct_label,
4304                           sizeof(data->ct_label));
4305     }
4306     if (parms->support.recirc) {
4307         nl_msg_put_u32(buf, OVS_KEY_ATTR_RECIRC_ID, data->recirc_id);
4308         nl_msg_put_u32(buf, OVS_KEY_ATTR_DP_HASH, data->dp_hash);
4309     }
4310
4311     /* Add an ingress port attribute if this is a mask or 'in_port.odp_port'
4312      * is not the magical value "ODPP_NONE". */
4313     if (export_mask || flow->in_port.odp_port != ODPP_NONE) {
4314         nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, data->in_port.odp_port);
4315     }
4316
4317     eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
4318                                        sizeof *eth_key);
4319     get_ethernet_key(data, eth_key);
4320
4321     if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
4322         if (export_mask) {
4323             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
4324         } else {
4325             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
4326         }
4327         nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, data->vlan_tci);
4328         encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
4329         if (flow->vlan_tci == htons(0)) {
4330             goto unencap;
4331         }
4332     } else {
4333         encap = 0;
4334     }
4335
4336     if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
4337         /* For backwards compatibility with kernels that don't support
4338          * wildcarding, the following convention is used to encode the
4339          * OVS_KEY_ATTR_ETHERTYPE for key and mask:
4340          *
4341          *   key      mask    matches
4342          * -------- --------  -------
4343          *  >0x5ff   0xffff   Specified Ethernet II Ethertype.
4344          *  >0x5ff      0     Any Ethernet II or non-Ethernet II frame.
4345          *  <none>   0xffff   Any non-Ethernet II frame (except valid
4346          *                    802.3 SNAP packet with valid eth_type).
4347          */
4348         if (export_mask) {
4349             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
4350         }
4351         goto unencap;
4352     }
4353
4354     nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, data->dl_type);
4355
4356     if (flow->dl_type == htons(ETH_TYPE_IP)) {
4357         struct ovs_key_ipv4 *ipv4_key;
4358
4359         ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
4360                                             sizeof *ipv4_key);
4361         get_ipv4_key(data, ipv4_key, export_mask);
4362     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
4363         struct ovs_key_ipv6 *ipv6_key;
4364
4365         ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
4366                                             sizeof *ipv6_key);
4367         get_ipv6_key(data, ipv6_key, export_mask);
4368     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
4369                flow->dl_type == htons(ETH_TYPE_RARP)) {
4370         struct ovs_key_arp *arp_key;
4371
4372         arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
4373                                            sizeof *arp_key);
4374         get_arp_key(data, arp_key);
4375     } else if (eth_type_mpls(flow->dl_type)) {
4376         struct ovs_key_mpls *mpls_key;
4377         int i, n;
4378
4379         n = flow_count_mpls_labels(flow, NULL);
4380         if (export_mask) {
4381             n = MIN(n, parms->support.max_mpls_depth);
4382         }
4383         mpls_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_MPLS,
4384                                             n * sizeof *mpls_key);
4385         for (i = 0; i < n; i++) {
4386             mpls_key[i].mpls_lse = data->mpls_lse[i];
4387         }
4388     }
4389
4390     if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4391         if (flow->nw_proto == IPPROTO_TCP) {
4392             union ovs_key_tp *tcp_key;
4393
4394             tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
4395                                                sizeof *tcp_key);
4396             get_tp_key(data, tcp_key);
4397             if (data->tcp_flags) {
4398                 nl_msg_put_be16(buf, OVS_KEY_ATTR_TCP_FLAGS, data->tcp_flags);
4399             }
4400         } else if (flow->nw_proto == IPPROTO_UDP) {
4401             union ovs_key_tp *udp_key;
4402
4403             udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
4404                                                sizeof *udp_key);
4405             get_tp_key(data, udp_key);
4406         } else if (flow->nw_proto == IPPROTO_SCTP) {
4407             union ovs_key_tp *sctp_key;
4408
4409             sctp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_SCTP,
4410                                                sizeof *sctp_key);
4411             get_tp_key(data, sctp_key);
4412         } else if (flow->dl_type == htons(ETH_TYPE_IP)
4413                 && flow->nw_proto == IPPROTO_ICMP) {
4414             struct ovs_key_icmp *icmp_key;
4415
4416             icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
4417                                                 sizeof *icmp_key);
4418             icmp_key->icmp_type = ntohs(data->tp_src);
4419             icmp_key->icmp_code = ntohs(data->tp_dst);
4420         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
4421                 && flow->nw_proto == IPPROTO_ICMPV6) {
4422             struct ovs_key_icmpv6 *icmpv6_key;
4423
4424             icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
4425                                                   sizeof *icmpv6_key);
4426             icmpv6_key->icmpv6_type = ntohs(data->tp_src);
4427             icmpv6_key->icmpv6_code = ntohs(data->tp_dst);
4428
4429             if (is_nd(flow, NULL)
4430                 /* Even though 'tp_src' and 'tp_dst' are 16 bits wide, ICMP
4431                  * type and code are 8 bits wide.  Therefore, an exact match
4432                  * looks like htons(0xff), not htons(0xffff).  See
4433                  * xlate_wc_finish() for details. */
4434                 && (!export_mask || (data->tp_src == htons(0xff)
4435                                      && data->tp_dst == htons(0xff)))) {
4436
4437                 struct ovs_key_nd *nd_key;
4438
4439                 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
4440                                                     sizeof *nd_key);
4441                 memcpy(nd_key->nd_target, &data->nd_target,
4442                         sizeof nd_key->nd_target);
4443                 nd_key->nd_sll = data->arp_sha;
4444                 nd_key->nd_tll = data->arp_tha;
4445             }
4446         }
4447     }
4448
4449 unencap:
4450     if (encap) {
4451         nl_msg_end_nested(buf, encap);
4452     }
4453 }
4454
4455 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'.
4456  *
4457  * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
4458  * capable of being expanded to allow for that much space. */
4459 void
4460 odp_flow_key_from_flow(const struct odp_flow_key_parms *parms,
4461                        struct ofpbuf *buf)
4462 {
4463     odp_flow_key_from_flow__(parms, false, buf);
4464 }
4465
4466 /* Appends a representation of 'mask' as OVS_KEY_ATTR_* attributes to
4467  * 'buf'.
4468  *
4469  * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
4470  * capable of being expanded to allow for that much space. */
4471 void
4472 odp_flow_key_from_mask(const struct odp_flow_key_parms *parms,
4473                        struct ofpbuf *buf)
4474 {
4475     odp_flow_key_from_flow__(parms, true, buf);
4476 }
4477
4478 /* Generate ODP flow key from the given packet metadata */
4479 void
4480 odp_key_from_pkt_metadata(struct ofpbuf *buf, const struct pkt_metadata *md)
4481 {
4482     nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, md->skb_priority);
4483
4484     if (flow_tnl_dst_is_set(&md->tunnel)) {
4485         tun_key_to_attr(buf, &md->tunnel, &md->tunnel, NULL);
4486     }
4487
4488     nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, md->pkt_mark);
4489
4490     if (md->ct_state) {
4491         nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_STATE,
4492                        ovs_to_odp_ct_state(md->ct_state));
4493         if (md->ct_zone) {
4494             nl_msg_put_u16(buf, OVS_KEY_ATTR_CT_ZONE, md->ct_zone);
4495         }
4496         if (md->ct_mark) {
4497             nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_MARK, md->ct_mark);
4498         }
4499         if (!ovs_u128_is_zero(md->ct_label)) {
4500             nl_msg_put_unspec(buf, OVS_KEY_ATTR_CT_LABELS, &md->ct_label,
4501                               sizeof(md->ct_label));
4502         }
4503     }
4504
4505     /* Add an ingress port attribute if 'odp_in_port' is not the magical
4506      * value "ODPP_NONE". */
4507     if (md->in_port.odp_port != ODPP_NONE) {
4508         nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, md->in_port.odp_port);
4509     }
4510 }
4511
4512 /* Generate packet metadata from the given ODP flow key. */
4513 void
4514 odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len,
4515                         struct pkt_metadata *md)
4516 {
4517     const struct nlattr *nla;
4518     size_t left;
4519     uint32_t wanted_attrs = 1u << OVS_KEY_ATTR_PRIORITY |
4520         1u << OVS_KEY_ATTR_SKB_MARK | 1u << OVS_KEY_ATTR_TUNNEL |
4521         1u << OVS_KEY_ATTR_IN_PORT;
4522
4523     pkt_metadata_init(md, ODPP_NONE);
4524
4525     NL_ATTR_FOR_EACH (nla, left, key, key_len) {
4526         uint16_t type = nl_attr_type(nla);
4527         size_t len = nl_attr_get_size(nla);
4528         int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
4529                                             OVS_KEY_ATTR_MAX, type);
4530
4531         if (len != expected_len && expected_len >= 0) {
4532             continue;
4533         }
4534
4535         switch (type) {
4536         case OVS_KEY_ATTR_RECIRC_ID:
4537             md->recirc_id = nl_attr_get_u32(nla);
4538             wanted_attrs &= ~(1u << OVS_KEY_ATTR_RECIRC_ID);
4539             break;
4540         case OVS_KEY_ATTR_DP_HASH:
4541             md->dp_hash = nl_attr_get_u32(nla);
4542             wanted_attrs &= ~(1u << OVS_KEY_ATTR_DP_HASH);
4543             break;
4544         case OVS_KEY_ATTR_PRIORITY:
4545             md->skb_priority = nl_attr_get_u32(nla);
4546             wanted_attrs &= ~(1u << OVS_KEY_ATTR_PRIORITY);
4547             break;
4548         case OVS_KEY_ATTR_SKB_MARK:
4549             md->pkt_mark = nl_attr_get_u32(nla);
4550             wanted_attrs &= ~(1u << OVS_KEY_ATTR_SKB_MARK);
4551             break;
4552         case OVS_KEY_ATTR_CT_STATE:
4553             md->ct_state = odp_to_ovs_ct_state(nl_attr_get_u32(nla));
4554             wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_STATE);
4555             break;
4556         case OVS_KEY_ATTR_CT_ZONE:
4557             md->ct_zone = nl_attr_get_u16(nla);
4558             wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_ZONE);
4559             break;
4560         case OVS_KEY_ATTR_CT_MARK:
4561             md->ct_mark = nl_attr_get_u32(nla);
4562             wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_MARK);
4563             break;
4564         case OVS_KEY_ATTR_CT_LABELS: {
4565             const ovs_u128 *cl = nl_attr_get(nla);
4566
4567             md->ct_label = *cl;
4568             wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_LABELS);
4569             break;
4570         }
4571         case OVS_KEY_ATTR_TUNNEL: {
4572             enum odp_key_fitness res;
4573
4574             res = odp_tun_key_from_attr(nla, true, &md->tunnel);
4575             if (res == ODP_FIT_ERROR) {
4576                 memset(&md->tunnel, 0, sizeof md->tunnel);
4577             } else if (res == ODP_FIT_PERFECT) {
4578                 wanted_attrs &= ~(1u << OVS_KEY_ATTR_TUNNEL);
4579             }
4580             break;
4581         }
4582         case OVS_KEY_ATTR_IN_PORT:
4583             md->in_port.odp_port = nl_attr_get_odp_port(nla);
4584             wanted_attrs &= ~(1u << OVS_KEY_ATTR_IN_PORT);
4585             break;
4586         default:
4587             break;
4588         }
4589
4590         if (!wanted_attrs) {
4591             return; /* Have everything. */
4592         }
4593     }
4594 }
4595
4596 uint32_t
4597 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
4598 {
4599     BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
4600     return hash_bytes32(ALIGNED_CAST(const uint32_t *, key), key_len, 0);
4601 }
4602
4603 static void
4604 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
4605                        uint64_t attrs, int out_of_range_attr,
4606                        const struct nlattr *key, size_t key_len)
4607 {
4608     struct ds s;
4609     int i;
4610
4611     if (VLOG_DROP_DBG(rl)) {
4612         return;
4613     }
4614
4615     ds_init(&s);
4616     for (i = 0; i < 64; i++) {
4617         if (attrs & (UINT64_C(1) << i)) {
4618             char namebuf[OVS_KEY_ATTR_BUFSIZE];
4619
4620             ds_put_format(&s, " %s",
4621                           ovs_key_attr_to_string(i, namebuf, sizeof namebuf));
4622         }
4623     }
4624     if (out_of_range_attr) {
4625         ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
4626     }
4627
4628     ds_put_cstr(&s, ": ");
4629     odp_flow_key_format(key, key_len, &s);
4630
4631     VLOG_DBG("%s:%s", title, ds_cstr(&s));
4632     ds_destroy(&s);
4633 }
4634
4635 static uint8_t
4636 odp_to_ovs_frag(uint8_t odp_frag, bool is_mask)
4637 {
4638     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4639
4640     if (is_mask) {
4641         return odp_frag ? FLOW_NW_FRAG_MASK : 0;
4642     }
4643
4644     if (odp_frag > OVS_FRAG_TYPE_LATER) {
4645         VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
4646         return 0xff; /* Error. */
4647     }
4648
4649     return (odp_frag == OVS_FRAG_TYPE_NONE) ? 0
4650         : (odp_frag == OVS_FRAG_TYPE_FIRST) ? FLOW_NW_FRAG_ANY
4651         :  FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER;
4652 }
4653
4654 static bool
4655 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
4656                    const struct nlattr *attrs[], uint64_t *present_attrsp,
4657                    int *out_of_range_attrp)
4658 {
4659     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4660     const struct nlattr *nla;
4661     uint64_t present_attrs;
4662     size_t left;
4663
4664     BUILD_ASSERT(OVS_KEY_ATTR_MAX < CHAR_BIT * sizeof present_attrs);
4665     present_attrs = 0;
4666     *out_of_range_attrp = 0;
4667     NL_ATTR_FOR_EACH (nla, left, key, key_len) {
4668         uint16_t type = nl_attr_type(nla);
4669         size_t len = nl_attr_get_size(nla);
4670         int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
4671                                             OVS_KEY_ATTR_MAX, type);
4672
4673         if (len != expected_len && expected_len >= 0) {
4674             char namebuf[OVS_KEY_ATTR_BUFSIZE];
4675
4676             VLOG_ERR_RL(&rl, "attribute %s has length %"PRIuSIZE" but should have "
4677                         "length %d", ovs_key_attr_to_string(type, namebuf,
4678                                                             sizeof namebuf),
4679                         len, expected_len);
4680             return false;
4681         }
4682
4683         if (type > OVS_KEY_ATTR_MAX) {
4684             *out_of_range_attrp = type;
4685         } else {
4686             if (present_attrs & (UINT64_C(1) << type)) {
4687                 char namebuf[OVS_KEY_ATTR_BUFSIZE];
4688
4689                 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
4690                             ovs_key_attr_to_string(type,
4691                                                    namebuf, sizeof namebuf));
4692                 return false;
4693             }
4694
4695             present_attrs |= UINT64_C(1) << type;
4696             attrs[type] = nla;
4697         }
4698     }
4699     if (left) {
4700         VLOG_ERR_RL(&rl, "trailing garbage in flow key");
4701         return false;
4702     }
4703
4704     *present_attrsp = present_attrs;
4705     return true;
4706 }
4707
4708 static enum odp_key_fitness
4709 check_expectations(uint64_t present_attrs, int out_of_range_attr,
4710                    uint64_t expected_attrs,
4711                    const struct nlattr *key, size_t key_len)
4712 {
4713     uint64_t missing_attrs;
4714     uint64_t extra_attrs;
4715
4716     missing_attrs = expected_attrs & ~present_attrs;
4717     if (missing_attrs) {
4718         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4719         log_odp_key_attributes(&rl, "expected but not present",
4720                                missing_attrs, 0, key, key_len);
4721         return ODP_FIT_TOO_LITTLE;
4722     }
4723
4724     extra_attrs = present_attrs & ~expected_attrs;
4725     if (extra_attrs || out_of_range_attr) {
4726         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4727         log_odp_key_attributes(&rl, "present but not expected",
4728                                extra_attrs, out_of_range_attr, key, key_len);
4729         return ODP_FIT_TOO_MUCH;
4730     }
4731
4732     return ODP_FIT_PERFECT;
4733 }
4734
4735 static bool
4736 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4737                 uint64_t present_attrs, uint64_t *expected_attrs,
4738                 struct flow *flow, const struct flow *src_flow)
4739 {
4740     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4741     bool is_mask = flow != src_flow;
4742
4743     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
4744         flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
4745         if (!is_mask && ntohs(flow->dl_type) < ETH_TYPE_MIN) {
4746             VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
4747                         ntohs(flow->dl_type));
4748             return false;
4749         }
4750         if (is_mask && ntohs(src_flow->dl_type) < ETH_TYPE_MIN &&
4751             flow->dl_type != htons(0xffff)) {
4752             return false;
4753         }
4754         *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
4755     } else {
4756         if (!is_mask) {
4757             flow->dl_type = htons(FLOW_DL_TYPE_NONE);
4758         } else if (ntohs(src_flow->dl_type) < ETH_TYPE_MIN) {
4759             /* See comments in odp_flow_key_from_flow__(). */
4760             VLOG_ERR_RL(&rl, "mask expected for non-Ethernet II frame");
4761             return false;
4762         }
4763     }
4764     return true;
4765 }
4766
4767 static enum odp_key_fitness
4768 parse_l2_5_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4769                   uint64_t present_attrs, int out_of_range_attr,
4770                   uint64_t expected_attrs, struct flow *flow,
4771                   const struct nlattr *key, size_t key_len,
4772                   const struct flow *src_flow)
4773 {
4774     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4775     bool is_mask = src_flow != flow;
4776     const void *check_start = NULL;
4777     size_t check_len = 0;
4778     enum ovs_key_attr expected_bit = 0xff;
4779
4780     if (eth_type_mpls(src_flow->dl_type)) {
4781         if (!is_mask || present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
4782             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
4783         }
4784         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
4785             size_t size = nl_attr_get_size(attrs[OVS_KEY_ATTR_MPLS]);
4786             const ovs_be32 *mpls_lse = nl_attr_get(attrs[OVS_KEY_ATTR_MPLS]);
4787             int n = size / sizeof(ovs_be32);
4788             int i;
4789
4790             if (!size || size % sizeof(ovs_be32)) {
4791                 return ODP_FIT_ERROR;
4792             }
4793             if (flow->mpls_lse[0] && flow->dl_type != htons(0xffff)) {
4794                 return ODP_FIT_ERROR;
4795             }
4796
4797             for (i = 0; i < n && i < FLOW_MAX_MPLS_LABELS; i++) {
4798                 flow->mpls_lse[i] = mpls_lse[i];
4799             }
4800             if (n > FLOW_MAX_MPLS_LABELS) {
4801                 return ODP_FIT_TOO_MUCH;
4802             }
4803
4804             if (!is_mask) {
4805                 /* BOS may be set only in the innermost label. */
4806                 for (i = 0; i < n - 1; i++) {
4807                     if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
4808                         return ODP_FIT_ERROR;
4809                     }
4810                 }
4811
4812                 /* BOS must be set in the innermost label. */
4813                 if (n < FLOW_MAX_MPLS_LABELS
4814                     && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
4815                     return ODP_FIT_TOO_LITTLE;
4816                 }
4817             }
4818         }
4819
4820         goto done;
4821     } else if (src_flow->dl_type == htons(ETH_TYPE_IP)) {
4822         if (!is_mask) {
4823             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
4824         }
4825         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
4826             const struct ovs_key_ipv4 *ipv4_key;
4827
4828             ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
4829             put_ipv4_key(ipv4_key, flow, is_mask);
4830             if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
4831                 return ODP_FIT_ERROR;
4832             }
4833             if (is_mask) {
4834                 check_start = ipv4_key;
4835                 check_len = sizeof *ipv4_key;
4836                 expected_bit = OVS_KEY_ATTR_IPV4;
4837             }
4838         }
4839     } else if (src_flow->dl_type == htons(ETH_TYPE_IPV6)) {
4840         if (!is_mask) {
4841             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
4842         }
4843         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
4844             const struct ovs_key_ipv6 *ipv6_key;
4845
4846             ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
4847             put_ipv6_key(ipv6_key, flow, is_mask);
4848             if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
4849                 return ODP_FIT_ERROR;
4850             }
4851             if (is_mask) {
4852                 check_start = ipv6_key;
4853                 check_len = sizeof *ipv6_key;
4854                 expected_bit = OVS_KEY_ATTR_IPV6;
4855             }
4856         }
4857     } else if (src_flow->dl_type == htons(ETH_TYPE_ARP) ||
4858                src_flow->dl_type == htons(ETH_TYPE_RARP)) {
4859         if (!is_mask) {
4860             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
4861         }
4862         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
4863             const struct ovs_key_arp *arp_key;
4864
4865             arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
4866             if (!is_mask && (arp_key->arp_op & htons(0xff00))) {
4867                 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
4868                             "key", ntohs(arp_key->arp_op));
4869                 return ODP_FIT_ERROR;
4870             }
4871             put_arp_key(arp_key, flow);
4872             if (is_mask) {
4873                 check_start = arp_key;
4874                 check_len = sizeof *arp_key;
4875                 expected_bit = OVS_KEY_ATTR_ARP;
4876             }
4877         }
4878     } else {
4879         goto done;
4880     }
4881     if (check_len > 0) { /* Happens only when 'is_mask'. */
4882         if (!is_all_zeros(check_start, check_len) &&
4883             flow->dl_type != htons(0xffff)) {
4884             return ODP_FIT_ERROR;
4885         } else {
4886             expected_attrs |= UINT64_C(1) << expected_bit;
4887         }
4888     }
4889
4890     expected_bit = OVS_KEY_ATTR_UNSPEC;
4891     if (src_flow->nw_proto == IPPROTO_TCP
4892         && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4893             src_flow->dl_type == htons(ETH_TYPE_IPV6))
4894         && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4895         if (!is_mask) {
4896             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
4897         }
4898         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
4899             const union ovs_key_tp *tcp_key;
4900
4901             tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
4902             put_tp_key(tcp_key, flow);
4903             expected_bit = OVS_KEY_ATTR_TCP;
4904         }
4905         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS)) {
4906             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS;
4907             flow->tcp_flags = nl_attr_get_be16(attrs[OVS_KEY_ATTR_TCP_FLAGS]);
4908         }
4909     } else if (src_flow->nw_proto == IPPROTO_UDP
4910                && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4911                    src_flow->dl_type == htons(ETH_TYPE_IPV6))
4912                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4913         if (!is_mask) {
4914             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
4915         }
4916         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
4917             const union ovs_key_tp *udp_key;
4918
4919             udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
4920             put_tp_key(udp_key, flow);
4921             expected_bit = OVS_KEY_ATTR_UDP;
4922         }
4923     } else if (src_flow->nw_proto == IPPROTO_SCTP
4924                && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4925                    src_flow->dl_type == htons(ETH_TYPE_IPV6))
4926                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4927         if (!is_mask) {
4928             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SCTP;
4929         }
4930         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SCTP)) {
4931             const union ovs_key_tp *sctp_key;
4932
4933             sctp_key = nl_attr_get(attrs[OVS_KEY_ATTR_SCTP]);
4934             put_tp_key(sctp_key, flow);
4935             expected_bit = OVS_KEY_ATTR_SCTP;
4936         }
4937     } else if (src_flow->nw_proto == IPPROTO_ICMP
4938                && src_flow->dl_type == htons(ETH_TYPE_IP)
4939                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4940         if (!is_mask) {
4941             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
4942         }
4943         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
4944             const struct ovs_key_icmp *icmp_key;
4945
4946             icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
4947             flow->tp_src = htons(icmp_key->icmp_type);
4948             flow->tp_dst = htons(icmp_key->icmp_code);
4949             expected_bit = OVS_KEY_ATTR_ICMP;
4950         }
4951     } else if (src_flow->nw_proto == IPPROTO_ICMPV6
4952                && src_flow->dl_type == htons(ETH_TYPE_IPV6)
4953                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4954         if (!is_mask) {
4955             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
4956         }
4957         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
4958             const struct ovs_key_icmpv6 *icmpv6_key;
4959
4960             icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
4961             flow->tp_src = htons(icmpv6_key->icmpv6_type);
4962             flow->tp_dst = htons(icmpv6_key->icmpv6_code);
4963             expected_bit = OVS_KEY_ATTR_ICMPV6;
4964             if (is_nd(src_flow, NULL)) {
4965                 if (!is_mask) {
4966                     expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4967                 }
4968                 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
4969                     const struct ovs_key_nd *nd_key;
4970
4971                     nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
4972                     memcpy(&flow->nd_target, nd_key->nd_target,
4973                            sizeof flow->nd_target);
4974                     flow->arp_sha = nd_key->nd_sll;
4975                     flow->arp_tha = nd_key->nd_tll;
4976                     if (is_mask) {
4977                         /* Even though 'tp_src' and 'tp_dst' are 16 bits wide,
4978                          * ICMP type and code are 8 bits wide.  Therefore, an
4979                          * exact match looks like htons(0xff), not
4980                          * htons(0xffff).  See xlate_wc_finish() for details.
4981                          * */
4982                         if (!is_all_zeros(nd_key, sizeof *nd_key) &&
4983                             (flow->tp_src != htons(0xff) ||
4984                              flow->tp_dst != htons(0xff))) {
4985                             return ODP_FIT_ERROR;
4986                         } else {
4987                             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4988                         }
4989                     }
4990                 }
4991             }
4992         }
4993     }
4994     if (is_mask && expected_bit != OVS_KEY_ATTR_UNSPEC) {
4995         if ((flow->tp_src || flow->tp_dst) && flow->nw_proto != 0xff) {
4996             return ODP_FIT_ERROR;
4997         } else {
4998             expected_attrs |= UINT64_C(1) << expected_bit;
4999         }
5000     }
5001
5002 done:
5003     return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
5004                               key, key_len);
5005 }
5006
5007 /* Parse 802.1Q header then encapsulated L3 attributes. */
5008 static enum odp_key_fitness
5009 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
5010                    uint64_t present_attrs, int out_of_range_attr,
5011                    uint64_t expected_attrs, struct flow *flow,
5012                    const struct nlattr *key, size_t key_len,
5013                    const struct flow *src_flow)
5014 {
5015     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
5016     bool is_mask = src_flow != flow;
5017
5018     const struct nlattr *encap
5019         = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
5020            ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
5021     enum odp_key_fitness encap_fitness;
5022     enum odp_key_fitness fitness;
5023
5024     /* Calculate fitness of outer attributes. */
5025     if (!is_mask) {
5026         expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
5027                           (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
5028     } else {
5029         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
5030             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
5031         }
5032         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)) {
5033             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_ENCAP);
5034         }
5035     }
5036     fitness = check_expectations(present_attrs, out_of_range_attr,
5037                                  expected_attrs, key, key_len);
5038
5039     /* Set vlan_tci.
5040      * Remove the TPID from dl_type since it's not the real Ethertype.  */
5041     flow->dl_type = htons(0);
5042     flow->vlan_tci = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)
5043                       ? nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN])
5044                       : htons(0));
5045     if (!is_mask) {
5046         if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
5047             return ODP_FIT_TOO_LITTLE;
5048         } else if (flow->vlan_tci == htons(0)) {
5049             /* Corner case for a truncated 802.1Q header. */
5050             if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
5051                 return ODP_FIT_TOO_MUCH;
5052             }
5053             return fitness;
5054         } else if (!(flow->vlan_tci & htons(VLAN_CFI))) {
5055             VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
5056                         "but CFI bit is not set", ntohs(flow->vlan_tci));
5057             return ODP_FIT_ERROR;
5058         }
5059     } else {
5060         if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP))) {
5061             return fitness;
5062         }
5063     }
5064
5065     /* Now parse the encapsulated attributes. */
5066     if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
5067                             attrs, &present_attrs, &out_of_range_attr)) {
5068         return ODP_FIT_ERROR;
5069     }
5070     expected_attrs = 0;
5071
5072     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow, src_flow)) {
5073         return ODP_FIT_ERROR;
5074     }
5075     encap_fitness = parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
5076                                       expected_attrs, flow, key, key_len,
5077                                       src_flow);
5078
5079     /* The overall fitness is the worse of the outer and inner attributes. */
5080     return MAX(fitness, encap_fitness);
5081 }
5082
5083 static enum odp_key_fitness
5084 odp_flow_key_to_flow__(const struct nlattr *key, size_t key_len,
5085                        const struct nlattr *src_key, size_t src_key_len,
5086                        struct flow *flow, const struct flow *src_flow,
5087                        bool udpif)
5088 {
5089     const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
5090     uint64_t expected_attrs;
5091     uint64_t present_attrs;
5092     int out_of_range_attr;
5093     bool is_mask = src_flow != flow;
5094
5095     memset(flow, 0, sizeof *flow);
5096
5097     /* Parse attributes. */
5098     if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
5099                             &out_of_range_attr)) {
5100         return ODP_FIT_ERROR;
5101     }
5102     expected_attrs = 0;
5103
5104     /* Metadata. */
5105     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID)) {
5106         flow->recirc_id = nl_attr_get_u32(attrs[OVS_KEY_ATTR_RECIRC_ID]);
5107         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID;
5108     } else if (is_mask) {
5109         /* Always exact match recirc_id if it is not specified. */
5110         flow->recirc_id = UINT32_MAX;
5111     }
5112
5113     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_DP_HASH)) {
5114         flow->dp_hash = nl_attr_get_u32(attrs[OVS_KEY_ATTR_DP_HASH]);
5115         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_DP_HASH;
5116     }
5117     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
5118         flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
5119         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
5120     }
5121
5122     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK)) {
5123         flow->pkt_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_SKB_MARK]);
5124         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK;
5125     }
5126
5127     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_STATE)) {
5128         uint32_t odp_state = nl_attr_get_u32(attrs[OVS_KEY_ATTR_CT_STATE]);
5129
5130         flow->ct_state = odp_to_ovs_ct_state(odp_state);
5131         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_STATE;
5132     }
5133     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_ZONE)) {
5134         flow->ct_zone = nl_attr_get_u16(attrs[OVS_KEY_ATTR_CT_ZONE]);
5135         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_ZONE;
5136     }
5137     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_MARK)) {
5138         flow->ct_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_CT_MARK]);
5139         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_MARK;
5140     }
5141     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_LABELS)) {
5142         const ovs_u128 *cl = nl_attr_get(attrs[OVS_KEY_ATTR_CT_LABELS]);
5143
5144         flow->ct_label = *cl;
5145         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_LABELS;
5146     }
5147
5148     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUNNEL)) {
5149         enum odp_key_fitness res;
5150
5151         res = odp_tun_key_from_attr__(attrs[OVS_KEY_ATTR_TUNNEL],
5152                                       is_mask ? src_key : NULL,
5153                                       src_key_len, &src_flow->tunnel,
5154                                       &flow->tunnel, udpif);
5155         if (res == ODP_FIT_ERROR) {
5156             return ODP_FIT_ERROR;
5157         } else if (res == ODP_FIT_PERFECT) {
5158             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUNNEL;
5159         }
5160     }
5161
5162     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
5163         flow->in_port.odp_port
5164             = nl_attr_get_odp_port(attrs[OVS_KEY_ATTR_IN_PORT]);
5165         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
5166     } else if (!is_mask) {
5167         flow->in_port.odp_port = ODPP_NONE;
5168     }
5169
5170     /* Ethernet header. */
5171     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
5172         const struct ovs_key_ethernet *eth_key;
5173
5174         eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
5175         put_ethernet_key(eth_key, flow);
5176         if (is_mask) {
5177             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
5178         }
5179     }
5180     if (!is_mask) {
5181         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
5182     }
5183
5184     /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
5185     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow,
5186         src_flow)) {
5187         return ODP_FIT_ERROR;
5188     }
5189
5190     if (is_mask
5191         ? (src_flow->vlan_tci & htons(VLAN_CFI)) != 0
5192         : src_flow->dl_type == htons(ETH_TYPE_VLAN)) {
5193         return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
5194                                   expected_attrs, flow, key, key_len, src_flow);
5195     }
5196     if (is_mask) {
5197         /* A missing VLAN mask means exact match on vlan_tci 0 (== no VLAN). */
5198         flow->vlan_tci = htons(0xffff);
5199         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
5200             flow->vlan_tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
5201             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
5202         }
5203     }
5204     return parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
5205                              expected_attrs, flow, key, key_len, src_flow);
5206 }
5207
5208 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
5209  * structure in 'flow'.  Returns an ODP_FIT_* value that indicates how well
5210  * 'key' fits our expectations for what a flow key should contain.
5211  *
5212  * The 'in_port' will be the datapath's understanding of the port.  The
5213  * caller will need to translate with odp_port_to_ofp_port() if the
5214  * OpenFlow port is needed.
5215  *
5216  * This function doesn't take the packet itself as an argument because none of
5217  * the currently understood OVS_KEY_ATTR_* attributes require it.  Currently,
5218  * it is always possible to infer which additional attribute(s) should appear
5219  * by looking at the attributes for lower-level protocols, e.g. if the network
5220  * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
5221  * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
5222  * must be absent. */
5223 enum odp_key_fitness
5224 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
5225                      struct flow *flow)
5226 {
5227    return odp_flow_key_to_flow__(key, key_len, NULL, 0, flow, flow, false);
5228 }
5229
5230 static enum odp_key_fitness
5231 odp_flow_key_to_mask__(const struct nlattr *mask_key, size_t mask_key_len,
5232                        const struct nlattr *flow_key, size_t flow_key_len,
5233                        struct flow_wildcards *mask,
5234                        const struct flow *src_flow,
5235                        bool udpif)
5236 {
5237     if (mask_key_len) {
5238         return odp_flow_key_to_flow__(mask_key, mask_key_len,
5239                                       flow_key, flow_key_len,
5240                                       &mask->masks, src_flow, udpif);
5241
5242     } else {
5243         /* A missing mask means that the flow should be exact matched.
5244          * Generate an appropriate exact wildcard for the flow. */
5245         flow_wildcards_init_for_packet(mask, src_flow);
5246
5247         return ODP_FIT_PERFECT;
5248     }
5249 }
5250 /* Converts the 'mask_key_len' bytes of OVS_KEY_ATTR_* attributes in 'mask_key'
5251  * to a mask structure in 'mask'.  'flow' must be a previously translated flow
5252  * corresponding to 'mask' and similarly flow_key/flow_key_len must be the
5253  * attributes from that flow.  Returns an ODP_FIT_* value that indicates how
5254  * well 'key' fits our expectations for what a flow key should contain. */
5255 enum odp_key_fitness
5256 odp_flow_key_to_mask(const struct nlattr *mask_key, size_t mask_key_len,
5257                      const struct nlattr *flow_key, size_t flow_key_len,
5258                      struct flow_wildcards *mask, const struct flow *flow)
5259 {
5260     return odp_flow_key_to_mask__(mask_key, mask_key_len,
5261                                   flow_key, flow_key_len,
5262                                   mask, flow, false);
5263 }
5264
5265 /* These functions are similar to their non-"_udpif" variants but output a
5266  * 'flow' that is suitable for fast-path packet processing.
5267  *
5268  * Some fields have different representation for flow setup and per-
5269  * packet processing (i.e. different between ofproto-dpif and userspace
5270  * datapath). In particular, with the non-"_udpif" functions, struct
5271  * tun_metadata is in the per-flow format (using 'present.map' and 'opts.u8');
5272  * with these functions, struct tun_metadata is in the per-packet format
5273  * (using 'present.len' and 'opts.gnv'). */
5274 enum odp_key_fitness
5275 odp_flow_key_to_flow_udpif(const struct nlattr *key, size_t key_len,
5276                            struct flow *flow)
5277 {
5278    return odp_flow_key_to_flow__(key, key_len, NULL, 0, flow, flow, true);
5279 }
5280
5281 enum odp_key_fitness
5282 odp_flow_key_to_mask_udpif(const struct nlattr *mask_key, size_t mask_key_len,
5283                            const struct nlattr *flow_key, size_t flow_key_len,
5284                            struct flow_wildcards *mask,
5285                            const struct flow *flow)
5286 {
5287     return odp_flow_key_to_mask__(mask_key, mask_key_len,
5288                                   flow_key, flow_key_len,
5289                                   mask, flow, true);
5290 }
5291
5292 /* Returns 'fitness' as a string, for use in debug messages. */
5293 const char *
5294 odp_key_fitness_to_string(enum odp_key_fitness fitness)
5295 {
5296     switch (fitness) {
5297     case ODP_FIT_PERFECT:
5298         return "OK";
5299     case ODP_FIT_TOO_MUCH:
5300         return "too_much";
5301     case ODP_FIT_TOO_LITTLE:
5302         return "too_little";
5303     case ODP_FIT_ERROR:
5304         return "error";
5305     default:
5306         return "<unknown>";
5307     }
5308 }
5309
5310 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
5311  * Netlink PID 'pid'.  If 'userdata' is nonnull, adds a userdata attribute
5312  * whose contents are the 'userdata_size' bytes at 'userdata' and returns the
5313  * offset within 'odp_actions' of the start of the cookie.  (If 'userdata' is
5314  * null, then the return value is not meaningful.) */
5315 size_t
5316 odp_put_userspace_action(uint32_t pid,
5317                          const void *userdata, size_t userdata_size,
5318                          odp_port_t tunnel_out_port,
5319                          bool include_actions,
5320                          struct ofpbuf *odp_actions)
5321 {
5322     size_t userdata_ofs;
5323     size_t offset;
5324
5325     offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
5326     nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
5327     if (userdata) {
5328         userdata_ofs = odp_actions->size + NLA_HDRLEN;
5329
5330         /* The OVS kernel module before OVS 1.11 and the upstream Linux kernel
5331          * module before Linux 3.10 required the userdata to be exactly 8 bytes
5332          * long:
5333          *
5334          *   - The kernel rejected shorter userdata with -ERANGE.
5335          *
5336          *   - The kernel silently dropped userdata beyond the first 8 bytes.
5337          *
5338          * Thus, for maximum compatibility, always put at least 8 bytes.  (We
5339          * separately disable features that required more than 8 bytes.) */
5340         memcpy(nl_msg_put_unspec_zero(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
5341                                       MAX(8, userdata_size)),
5342                userdata, userdata_size);
5343     } else {
5344         userdata_ofs = 0;
5345     }
5346     if (tunnel_out_port != ODPP_NONE) {
5347         nl_msg_put_odp_port(odp_actions, OVS_USERSPACE_ATTR_EGRESS_TUN_PORT,
5348                             tunnel_out_port);
5349     }
5350     if (include_actions) {
5351         nl_msg_put_flag(odp_actions, OVS_USERSPACE_ATTR_ACTIONS);
5352     }
5353     nl_msg_end_nested(odp_actions, offset);
5354
5355     return userdata_ofs;
5356 }
5357
5358 void
5359 odp_put_tunnel_action(const struct flow_tnl *tunnel,
5360                       struct ofpbuf *odp_actions)
5361 {
5362     size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
5363     tun_key_to_attr(odp_actions, tunnel, tunnel, NULL);
5364     nl_msg_end_nested(odp_actions, offset);
5365 }
5366
5367 void
5368 odp_put_tnl_push_action(struct ofpbuf *odp_actions,
5369                         struct ovs_action_push_tnl *data)
5370 {
5371     int size = offsetof(struct ovs_action_push_tnl, header);
5372
5373     size += data->header_len;
5374     nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_TUNNEL_PUSH, data, size);
5375 }
5376
5377 \f
5378 /* The commit_odp_actions() function and its helpers. */
5379
5380 static void
5381 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
5382                   const void *key, size_t key_size)
5383 {
5384     size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
5385     nl_msg_put_unspec(odp_actions, key_type, key, key_size);
5386     nl_msg_end_nested(odp_actions, offset);
5387 }
5388
5389 /* Masked set actions have a mask following the data within the netlink
5390  * attribute.  The unmasked bits in the data will be cleared as the data
5391  * is copied to the action. */
5392 void
5393 commit_masked_set_action(struct ofpbuf *odp_actions,
5394                          enum ovs_key_attr key_type,
5395                          const void *key_, const void *mask_, size_t key_size)
5396 {
5397     size_t offset = nl_msg_start_nested(odp_actions,
5398                                         OVS_ACTION_ATTR_SET_MASKED);
5399     char *data = nl_msg_put_unspec_uninit(odp_actions, key_type, key_size * 2);
5400     const char *key = key_, *mask = mask_;
5401
5402     memcpy(data + key_size, mask, key_size);
5403     /* Clear unmasked bits while copying. */
5404     while (key_size--) {
5405         *data++ = *key++ & *mask++;
5406     }
5407     nl_msg_end_nested(odp_actions, offset);
5408 }
5409
5410 /* If any of the flow key data that ODP actions can modify are different in
5411  * 'base->tunnel' and 'flow->tunnel', appends a set_tunnel ODP action to
5412  * 'odp_actions' that change the flow tunneling information in key from
5413  * 'base->tunnel' into 'flow->tunnel', and then changes 'base->tunnel' in the
5414  * same way.  In other words, operates the same as commit_odp_actions(), but
5415  * only on tunneling information. */
5416 void
5417 commit_odp_tunnel_action(const struct flow *flow, struct flow *base,
5418                          struct ofpbuf *odp_actions)
5419 {
5420     /* A valid IPV4_TUNNEL must have non-zero ip_dst; a valid IPv6 tunnel
5421      * must have non-zero ipv6_dst. */
5422     if (flow_tnl_dst_is_set(&flow->tunnel)) {
5423         if (!memcmp(&base->tunnel, &flow->tunnel, sizeof base->tunnel)) {
5424             return;
5425         }
5426         memcpy(&base->tunnel, &flow->tunnel, sizeof base->tunnel);
5427         odp_put_tunnel_action(&base->tunnel, odp_actions);
5428     }
5429 }
5430
5431 static bool
5432 commit(enum ovs_key_attr attr, bool use_masked_set,
5433        const void *key, void *base, void *mask, size_t size,
5434        struct ofpbuf *odp_actions)
5435 {
5436     if (memcmp(key, base, size)) {
5437         bool fully_masked = odp_mask_is_exact(attr, mask, size);
5438
5439         if (use_masked_set && !fully_masked) {
5440             commit_masked_set_action(odp_actions, attr, key, mask, size);
5441         } else {
5442             if (!fully_masked) {
5443                 memset(mask, 0xff, size);
5444             }
5445             commit_set_action(odp_actions, attr, key, size);
5446         }
5447         memcpy(base, key, size);
5448         return true;
5449     } else {
5450         /* Mask bits are set when we have either read or set the corresponding
5451          * values.  Masked bits will be exact-matched, no need to set them
5452          * if the value did not actually change. */
5453         return false;
5454     }
5455 }
5456
5457 static void
5458 get_ethernet_key(const struct flow *flow, struct ovs_key_ethernet *eth)
5459 {
5460     eth->eth_src = flow->dl_src;
5461     eth->eth_dst = flow->dl_dst;
5462 }
5463
5464 static void
5465 put_ethernet_key(const struct ovs_key_ethernet *eth, struct flow *flow)
5466 {
5467     flow->dl_src = eth->eth_src;
5468     flow->dl_dst = eth->eth_dst;
5469 }
5470
5471 static void
5472 commit_set_ether_addr_action(const struct flow *flow, struct flow *base_flow,
5473                              struct ofpbuf *odp_actions,
5474                              struct flow_wildcards *wc,
5475                              bool use_masked)
5476 {
5477     struct ovs_key_ethernet key, base, mask;
5478
5479     get_ethernet_key(flow, &key);
5480     get_ethernet_key(base_flow, &base);
5481     get_ethernet_key(&wc->masks, &mask);
5482
5483     if (commit(OVS_KEY_ATTR_ETHERNET, use_masked,
5484                &key, &base, &mask, sizeof key, odp_actions)) {
5485         put_ethernet_key(&base, base_flow);
5486         put_ethernet_key(&mask, &wc->masks);
5487     }
5488 }
5489
5490 static void
5491 pop_vlan(struct flow *base,
5492          struct ofpbuf *odp_actions, struct flow_wildcards *wc)
5493 {
5494     memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
5495
5496     if (base->vlan_tci & htons(VLAN_CFI)) {
5497         nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
5498         base->vlan_tci = 0;
5499     }
5500 }
5501
5502 static void
5503 commit_vlan_action(ovs_be16 vlan_tci, struct flow *base,
5504                    struct ofpbuf *odp_actions, struct flow_wildcards *wc)
5505 {
5506     if (base->vlan_tci == vlan_tci) {
5507         return;
5508     }
5509
5510     pop_vlan(base, odp_actions, wc);
5511     if (vlan_tci & htons(VLAN_CFI)) {
5512         struct ovs_action_push_vlan vlan;
5513
5514         vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
5515         vlan.vlan_tci = vlan_tci;
5516         nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
5517                           &vlan, sizeof vlan);
5518     }
5519     base->vlan_tci = vlan_tci;
5520 }
5521
5522 /* Wildcarding already done at action translation time. */
5523 static void
5524 commit_mpls_action(const struct flow *flow, struct flow *base,
5525                    struct ofpbuf *odp_actions)
5526 {
5527     int base_n = flow_count_mpls_labels(base, NULL);
5528     int flow_n = flow_count_mpls_labels(flow, NULL);
5529     int common_n = flow_count_common_mpls_labels(flow, flow_n, base, base_n,
5530                                                  NULL);
5531
5532     while (base_n > common_n) {
5533         if (base_n - 1 == common_n && flow_n > common_n) {
5534             /* If there is only one more LSE in base than there are common
5535              * between base and flow; and flow has at least one more LSE than
5536              * is common then the topmost LSE of base may be updated using
5537              * set */
5538             struct ovs_key_mpls mpls_key;
5539
5540             mpls_key.mpls_lse = flow->mpls_lse[flow_n - base_n];
5541             commit_set_action(odp_actions, OVS_KEY_ATTR_MPLS,
5542                               &mpls_key, sizeof mpls_key);
5543             flow_set_mpls_lse(base, 0, mpls_key.mpls_lse);
5544             common_n++;
5545         } else {
5546             /* Otherwise, if there more LSEs in base than are common between
5547              * base and flow then pop the topmost one. */
5548             ovs_be16 dl_type;
5549             bool popped;
5550
5551             /* If all the LSEs are to be popped and this is not the outermost
5552              * LSE then use ETH_TYPE_MPLS as the ethertype parameter of the
5553              * POP_MPLS action instead of flow->dl_type.
5554              *
5555              * This is because the POP_MPLS action requires its ethertype
5556              * argument to be an MPLS ethernet type but in this case
5557              * flow->dl_type will be a non-MPLS ethernet type.
5558              *
5559              * When the final POP_MPLS action occurs it use flow->dl_type and
5560              * the and the resulting packet will have the desired dl_type. */
5561             if ((!eth_type_mpls(flow->dl_type)) && base_n > 1) {
5562                 dl_type = htons(ETH_TYPE_MPLS);
5563             } else {
5564                 dl_type = flow->dl_type;
5565             }
5566             nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_POP_MPLS, dl_type);
5567             popped = flow_pop_mpls(base, base_n, flow->dl_type, NULL);
5568             ovs_assert(popped);
5569             base_n--;
5570         }
5571     }
5572
5573     /* If, after the above popping and setting, there are more LSEs in flow
5574      * than base then some LSEs need to be pushed. */
5575     while (base_n < flow_n) {
5576         struct ovs_action_push_mpls *mpls;
5577
5578         mpls = nl_msg_put_unspec_zero(odp_actions,
5579                                       OVS_ACTION_ATTR_PUSH_MPLS,
5580                                       sizeof *mpls);
5581         mpls->mpls_ethertype = flow->dl_type;
5582         mpls->mpls_lse = flow->mpls_lse[flow_n - base_n - 1];
5583         flow_push_mpls(base, base_n, mpls->mpls_ethertype, NULL);
5584         flow_set_mpls_lse(base, 0, mpls->mpls_lse);
5585         base_n++;
5586     }
5587 }
5588
5589 static void
5590 get_ipv4_key(const struct flow *flow, struct ovs_key_ipv4 *ipv4, bool is_mask)
5591 {
5592     ipv4->ipv4_src = flow->nw_src;
5593     ipv4->ipv4_dst = flow->nw_dst;
5594     ipv4->ipv4_proto = flow->nw_proto;
5595     ipv4->ipv4_tos = flow->nw_tos;
5596     ipv4->ipv4_ttl = flow->nw_ttl;
5597     ipv4->ipv4_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
5598 }
5599
5600 static void
5601 put_ipv4_key(const struct ovs_key_ipv4 *ipv4, struct flow *flow, bool is_mask)
5602 {
5603     flow->nw_src = ipv4->ipv4_src;
5604     flow->nw_dst = ipv4->ipv4_dst;
5605     flow->nw_proto = ipv4->ipv4_proto;
5606     flow->nw_tos = ipv4->ipv4_tos;
5607     flow->nw_ttl = ipv4->ipv4_ttl;
5608     flow->nw_frag = odp_to_ovs_frag(ipv4->ipv4_frag, is_mask);
5609 }
5610
5611 static void
5612 commit_set_ipv4_action(const struct flow *flow, struct flow *base_flow,
5613                        struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5614                        bool use_masked)
5615 {
5616     struct ovs_key_ipv4 key, mask, base;
5617
5618     /* Check that nw_proto and nw_frag remain unchanged. */
5619     ovs_assert(flow->nw_proto == base_flow->nw_proto &&
5620                flow->nw_frag == base_flow->nw_frag);
5621
5622     get_ipv4_key(flow, &key, false);
5623     get_ipv4_key(base_flow, &base, false);
5624     get_ipv4_key(&wc->masks, &mask, true);
5625     mask.ipv4_proto = 0;        /* Not writeable. */
5626     mask.ipv4_frag = 0;         /* Not writable. */
5627
5628     if (commit(OVS_KEY_ATTR_IPV4, use_masked, &key, &base, &mask, sizeof key,
5629                odp_actions)) {
5630         put_ipv4_key(&base, base_flow, false);
5631         if (mask.ipv4_proto != 0) { /* Mask was changed by commit(). */
5632             put_ipv4_key(&mask, &wc->masks, true);
5633         }
5634    }
5635 }
5636
5637 static void
5638 get_ipv6_key(const struct flow *flow, struct ovs_key_ipv6 *ipv6, bool is_mask)
5639 {
5640     memcpy(ipv6->ipv6_src, &flow->ipv6_src, sizeof ipv6->ipv6_src);
5641     memcpy(ipv6->ipv6_dst, &flow->ipv6_dst, sizeof ipv6->ipv6_dst);
5642     ipv6->ipv6_label = flow->ipv6_label;
5643     ipv6->ipv6_proto = flow->nw_proto;
5644     ipv6->ipv6_tclass = flow->nw_tos;
5645     ipv6->ipv6_hlimit = flow->nw_ttl;
5646     ipv6->ipv6_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
5647 }
5648
5649 static void
5650 put_ipv6_key(const struct ovs_key_ipv6 *ipv6, struct flow *flow, bool is_mask)
5651 {
5652     memcpy(&flow->ipv6_src, ipv6->ipv6_src, sizeof flow->ipv6_src);
5653     memcpy(&flow->ipv6_dst, ipv6->ipv6_dst, sizeof flow->ipv6_dst);
5654     flow->ipv6_label = ipv6->ipv6_label;
5655     flow->nw_proto = ipv6->ipv6_proto;
5656     flow->nw_tos = ipv6->ipv6_tclass;
5657     flow->nw_ttl = ipv6->ipv6_hlimit;
5658     flow->nw_frag = odp_to_ovs_frag(ipv6->ipv6_frag, is_mask);
5659 }
5660
5661 static void
5662 commit_set_ipv6_action(const struct flow *flow, struct flow *base_flow,
5663                        struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5664                        bool use_masked)
5665 {
5666     struct ovs_key_ipv6 key, mask, base;
5667
5668     /* Check that nw_proto and nw_frag remain unchanged. */
5669     ovs_assert(flow->nw_proto == base_flow->nw_proto &&
5670                flow->nw_frag == base_flow->nw_frag);
5671
5672     get_ipv6_key(flow, &key, false);
5673     get_ipv6_key(base_flow, &base, false);
5674     get_ipv6_key(&wc->masks, &mask, true);
5675     mask.ipv6_proto = 0;        /* Not writeable. */
5676     mask.ipv6_frag = 0;         /* Not writable. */
5677
5678     if (commit(OVS_KEY_ATTR_IPV6, use_masked, &key, &base, &mask, sizeof key,
5679                odp_actions)) {
5680         put_ipv6_key(&base, base_flow, false);
5681         if (mask.ipv6_proto != 0) { /* Mask was changed by commit(). */
5682             put_ipv6_key(&mask, &wc->masks, true);
5683         }
5684     }
5685 }
5686
5687 static void
5688 get_arp_key(const struct flow *flow, struct ovs_key_arp *arp)
5689 {
5690     /* ARP key has padding, clear it. */
5691     memset(arp, 0, sizeof *arp);
5692
5693     arp->arp_sip = flow->nw_src;
5694     arp->arp_tip = flow->nw_dst;
5695     arp->arp_op = htons(flow->nw_proto);
5696     arp->arp_sha = flow->arp_sha;
5697     arp->arp_tha = flow->arp_tha;
5698 }
5699
5700 static void
5701 put_arp_key(const struct ovs_key_arp *arp, struct flow *flow)
5702 {
5703     flow->nw_src = arp->arp_sip;
5704     flow->nw_dst = arp->arp_tip;
5705     flow->nw_proto = ntohs(arp->arp_op);
5706     flow->arp_sha = arp->arp_sha;
5707     flow->arp_tha = arp->arp_tha;
5708 }
5709
5710 static enum slow_path_reason
5711 commit_set_arp_action(const struct flow *flow, struct flow *base_flow,
5712                       struct ofpbuf *odp_actions, struct flow_wildcards *wc)
5713 {
5714     struct ovs_key_arp key, mask, base;
5715
5716     get_arp_key(flow, &key);
5717     get_arp_key(base_flow, &base);
5718     get_arp_key(&wc->masks, &mask);
5719
5720     if (commit(OVS_KEY_ATTR_ARP, true, &key, &base, &mask, sizeof key,
5721                odp_actions)) {
5722         put_arp_key(&base, base_flow);
5723         put_arp_key(&mask, &wc->masks);
5724         return SLOW_ACTION;
5725     }
5726     return 0;
5727 }
5728
5729 static void
5730 get_icmp_key(const struct flow *flow, struct ovs_key_icmp *icmp)
5731 {
5732     /* icmp_type and icmp_code are stored in tp_src and tp_dst, respectively */
5733     icmp->icmp_type = ntohs(flow->tp_src);
5734     icmp->icmp_code = ntohs(flow->tp_dst);
5735 }
5736
5737 static void
5738 put_icmp_key(const struct ovs_key_icmp *icmp, struct flow *flow)
5739 {
5740     /* icmp_type and icmp_code are stored in tp_src and tp_dst, respectively */
5741     flow->tp_src = htons(icmp->icmp_type);
5742     flow->tp_dst = htons(icmp->icmp_code);
5743 }
5744
5745 static enum slow_path_reason
5746 commit_set_icmp_action(const struct flow *flow, struct flow *base_flow,
5747                        struct ofpbuf *odp_actions, struct flow_wildcards *wc)
5748 {
5749     struct ovs_key_icmp key, mask, base;
5750     enum ovs_key_attr attr;
5751
5752     if (is_icmpv4(flow, NULL)) {
5753         attr = OVS_KEY_ATTR_ICMP;
5754     } else if (is_icmpv6(flow, NULL)) {
5755         attr = OVS_KEY_ATTR_ICMPV6;
5756     } else {
5757         return 0;
5758     }
5759
5760     get_icmp_key(flow, &key);
5761     get_icmp_key(base_flow, &base);
5762     get_icmp_key(&wc->masks, &mask);
5763
5764     if (commit(attr, false, &key, &base, &mask, sizeof key, odp_actions)) {
5765         put_icmp_key(&base, base_flow);
5766         put_icmp_key(&mask, &wc->masks);
5767         return SLOW_ACTION;
5768     }
5769     return 0;
5770 }
5771
5772 static void
5773 get_nd_key(const struct flow *flow, struct ovs_key_nd *nd)
5774 {
5775     memcpy(nd->nd_target, &flow->nd_target, sizeof flow->nd_target);
5776     /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
5777     nd->nd_sll = flow->arp_sha;
5778     nd->nd_tll = flow->arp_tha;
5779 }
5780
5781 static void
5782 put_nd_key(const struct ovs_key_nd *nd, struct flow *flow)
5783 {
5784     memcpy(&flow->nd_target, nd->nd_target, sizeof flow->nd_target);
5785     /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
5786     flow->arp_sha = nd->nd_sll;
5787     flow->arp_tha = nd->nd_tll;
5788 }
5789
5790 static enum slow_path_reason
5791 commit_set_nd_action(const struct flow *flow, struct flow *base_flow,
5792                      struct ofpbuf *odp_actions,
5793                      struct flow_wildcards *wc, bool use_masked)
5794 {
5795     struct ovs_key_nd key, mask, base;
5796
5797     get_nd_key(flow, &key);
5798     get_nd_key(base_flow, &base);
5799     get_nd_key(&wc->masks, &mask);
5800
5801     if (commit(OVS_KEY_ATTR_ND, use_masked, &key, &base, &mask, sizeof key,
5802                odp_actions)) {
5803         put_nd_key(&base, base_flow);
5804         put_nd_key(&mask, &wc->masks);
5805         return SLOW_ACTION;
5806     }
5807
5808     return 0;
5809 }
5810
5811 static enum slow_path_reason
5812 commit_set_nw_action(const struct flow *flow, struct flow *base,
5813                      struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5814                      bool use_masked)
5815 {
5816     /* Check if 'flow' really has an L3 header. */
5817     if (!flow->nw_proto) {
5818         return 0;
5819     }
5820
5821     switch (ntohs(base->dl_type)) {
5822     case ETH_TYPE_IP:
5823         commit_set_ipv4_action(flow, base, odp_actions, wc, use_masked);
5824         break;
5825
5826     case ETH_TYPE_IPV6:
5827         commit_set_ipv6_action(flow, base, odp_actions, wc, use_masked);
5828         return commit_set_nd_action(flow, base, odp_actions, wc, use_masked);
5829
5830     case ETH_TYPE_ARP:
5831         return commit_set_arp_action(flow, base, odp_actions, wc);
5832     }
5833
5834     return 0;
5835 }
5836
5837 /* TCP, UDP, and SCTP keys have the same layout. */
5838 BUILD_ASSERT_DECL(sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_udp) &&
5839                   sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_sctp));
5840
5841 static void
5842 get_tp_key(const struct flow *flow, union ovs_key_tp *tp)
5843 {
5844     tp->tcp.tcp_src = flow->tp_src;
5845     tp->tcp.tcp_dst = flow->tp_dst;
5846 }
5847
5848 static void
5849 put_tp_key(const union ovs_key_tp *tp, struct flow *flow)
5850 {
5851     flow->tp_src = tp->tcp.tcp_src;
5852     flow->tp_dst = tp->tcp.tcp_dst;
5853 }
5854
5855 static void
5856 commit_set_port_action(const struct flow *flow, struct flow *base_flow,
5857                        struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5858                        bool use_masked)
5859 {
5860     enum ovs_key_attr key_type;
5861     union ovs_key_tp key, mask, base;
5862
5863     /* Check if 'flow' really has an L3 header. */
5864     if (!flow->nw_proto) {
5865         return;
5866     }
5867
5868     if (!is_ip_any(base_flow)) {
5869         return;
5870     }
5871
5872     if (flow->nw_proto == IPPROTO_TCP) {
5873         key_type = OVS_KEY_ATTR_TCP;
5874     } else if (flow->nw_proto == IPPROTO_UDP) {
5875         key_type = OVS_KEY_ATTR_UDP;
5876     } else if (flow->nw_proto == IPPROTO_SCTP) {
5877         key_type = OVS_KEY_ATTR_SCTP;
5878     } else {
5879         return;
5880     }
5881
5882     get_tp_key(flow, &key);
5883     get_tp_key(base_flow, &base);
5884     get_tp_key(&wc->masks, &mask);
5885
5886     if (commit(key_type, use_masked, &key, &base, &mask, sizeof key,
5887                odp_actions)) {
5888         put_tp_key(&base, base_flow);
5889         put_tp_key(&mask, &wc->masks);
5890     }
5891 }
5892
5893 static void
5894 commit_set_priority_action(const struct flow *flow, struct flow *base_flow,
5895                            struct ofpbuf *odp_actions,
5896                            struct flow_wildcards *wc,
5897                            bool use_masked)
5898 {
5899     uint32_t key, mask, base;
5900
5901     key = flow->skb_priority;
5902     base = base_flow->skb_priority;
5903     mask = wc->masks.skb_priority;
5904
5905     if (commit(OVS_KEY_ATTR_PRIORITY, use_masked, &key, &base, &mask,
5906                sizeof key, odp_actions)) {
5907         base_flow->skb_priority = base;
5908         wc->masks.skb_priority = mask;
5909     }
5910 }
5911
5912 static void
5913 commit_set_pkt_mark_action(const struct flow *flow, struct flow *base_flow,
5914                            struct ofpbuf *odp_actions,
5915                            struct flow_wildcards *wc,
5916                            bool use_masked)
5917 {
5918     uint32_t key, mask, base;
5919
5920     key = flow->pkt_mark;
5921     base = base_flow->pkt_mark;
5922     mask = wc->masks.pkt_mark;
5923
5924     if (commit(OVS_KEY_ATTR_SKB_MARK, use_masked, &key, &base, &mask,
5925                sizeof key, odp_actions)) {
5926         base_flow->pkt_mark = base;
5927         wc->masks.pkt_mark = mask;
5928     }
5929 }
5930
5931 /* If any of the flow key data that ODP actions can modify are different in
5932  * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
5933  * key from 'base' into 'flow', and then changes 'base' the same way.  Does not
5934  * commit set_tunnel actions.  Users should call commit_odp_tunnel_action()
5935  * in addition to this function if needed.  Sets fields in 'wc' that are
5936  * used as part of the action.
5937  *
5938  * Returns a reason to force processing the flow's packets into the userspace
5939  * slow path, if there is one, otherwise 0. */
5940 enum slow_path_reason
5941 commit_odp_actions(const struct flow *flow, struct flow *base,
5942                    struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5943                    bool use_masked)
5944 {
5945     enum slow_path_reason slow1, slow2;
5946
5947     commit_set_ether_addr_action(flow, base, odp_actions, wc, use_masked);
5948     slow1 = commit_set_nw_action(flow, base, odp_actions, wc, use_masked);
5949     commit_set_port_action(flow, base, odp_actions, wc, use_masked);
5950     slow2 = commit_set_icmp_action(flow, base, odp_actions, wc);
5951     commit_mpls_action(flow, base, odp_actions);
5952     commit_vlan_action(flow->vlan_tci, base, odp_actions, wc);
5953     commit_set_priority_action(flow, base, odp_actions, wc, use_masked);
5954     commit_set_pkt_mark_action(flow, base, odp_actions, wc, use_masked);
5955
5956     return slow1 ? slow1 : slow2;
5957 }