lib/odp-util.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include <arpa/inet.h>
  19 #include "odp-util.h"
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <math.h>
  23 #include <netinet/in.h>
  24 #include <netinet/icmp6.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include "byte-order.h"
  28 #include "coverage.h"
  29 #include "dynamic-string.h"
  30 #include "flow.h"
  31 #include "netlink.h"
  32 #include "ofpbuf.h"
  33 #include "packets.h"
  34 #include "simap.h"
  35 #include "timeval.h"
  36 #include "util.h"
  37 #include "vlog.h"
  38
  39 VLOG_DEFINE_THIS_MODULE(odp_util);
  40
  41 /* The interface between userspace and kernel uses an "OVS_*" prefix.
  42  * Since this is fairly non-specific for the OVS userspace components,
  43  * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
  44  * interactions with the datapath.
  45  */
  46
  47 /* The set of characters that may separate one action or one key attribute
  48  * from another. */
  49 static const char *delimiters = ", \t\r\n";
  50
  51 static int parse_odp_key_mask_attr(const char *, const struct simap *port_names,
  52                               struct ofpbuf *, struct ofpbuf *);
  53 static void format_odp_key_attr(const struct nlattr *a,
  54                                 const struct nlattr *ma,
  55                                 const struct hmap *portno_names, struct ds *ds,
  56                                 bool verbose);
  57
  58 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
  59  * 'type':
  60  *
  61  *   - For an action whose argument has a fixed length, returned that
  62  *     nonnegative length in bytes.
  63  *
  64  *   - For an action with a variable-length argument, returns -2.
  65  *
  66  *   - For an invalid 'type', returns -1. */
  67 static int
  68 odp_action_len(uint16_t type)
  69 {
  70     if (type > OVS_ACTION_ATTR_MAX) {
  71         return -1;
  72     }
  73
  74     switch ((enum ovs_action_attr) type) {
  75     case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
  76     case OVS_ACTION_ATTR_USERSPACE: return -2;
  77     case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
  78     case OVS_ACTION_ATTR_POP_VLAN: return 0;
  79     case OVS_ACTION_ATTR_PUSH_MPLS: return sizeof(struct ovs_action_push_mpls);
  80     case OVS_ACTION_ATTR_POP_MPLS: return sizeof(ovs_be16);
  81     case OVS_ACTION_ATTR_SET: return -2;
  82     case OVS_ACTION_ATTR_SAMPLE: return -2;
  83
  84     case OVS_ACTION_ATTR_UNSPEC:
  85     case __OVS_ACTION_ATTR_MAX:
  86         return -1;
  87     }
  88
  89     return -1;
  90 }
  91
  92 /* Returns a string form of 'attr'.  The return value is either a statically
  93  * allocated constant string or the 'bufsize'-byte buffer 'namebuf'.  'bufsize'
  94  * should be at least OVS_KEY_ATTR_BUFSIZE. */
  95 enum { OVS_KEY_ATTR_BUFSIZE = 3 + INT_STRLEN(unsigned int) + 1 };
  96 static const char *
  97 ovs_key_attr_to_string(enum ovs_key_attr attr, char *namebuf, size_t bufsize)
  98 {
  99     switch (attr) {
 100     case OVS_KEY_ATTR_UNSPEC: return "unspec";
 101     case OVS_KEY_ATTR_ENCAP: return "encap";
 102     case OVS_KEY_ATTR_PRIORITY: return "skb_priority";
 103     case OVS_KEY_ATTR_SKB_MARK: return "skb_mark";
 104     case OVS_KEY_ATTR_TUNNEL: return "tunnel";
 105     case OVS_KEY_ATTR_IN_PORT: return "in_port";
 106     case OVS_KEY_ATTR_ETHERNET: return "eth";
 107     case OVS_KEY_ATTR_VLAN: return "vlan";
 108     case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
 109     case OVS_KEY_ATTR_IPV4: return "ipv4";
 110     case OVS_KEY_ATTR_IPV6: return "ipv6";
 111     case OVS_KEY_ATTR_TCP: return "tcp";
 112     case OVS_KEY_ATTR_TCP_FLAGS: return "tcp_flags";
 113     case OVS_KEY_ATTR_UDP: return "udp";
 114     case OVS_KEY_ATTR_SCTP: return "sctp";
 115     case OVS_KEY_ATTR_ICMP: return "icmp";
 116     case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
 117     case OVS_KEY_ATTR_ARP: return "arp";
 118     case OVS_KEY_ATTR_ND: return "nd";
 119     case OVS_KEY_ATTR_MPLS: return "mpls";
 120
 121     case __OVS_KEY_ATTR_MAX:
 122     default:
 123         snprintf(namebuf, bufsize, "key%u", (unsigned int) attr);
 124         return namebuf;
 125     }
 126 }
 127
 128 static void
 129 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
 130 {
 131     size_t len = nl_attr_get_size(a);
 132
 133     ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
 134     if (len) {
 135         const uint8_t *unspec;
 136         unsigned int i;
 137
 138         unspec = nl_attr_get(a);
 139         for (i = 0; i < len; i++) {
 140             ds_put_char(ds, i ? ' ': '(');
 141             ds_put_format(ds, "%02x", unspec[i]);
 142         }
 143         ds_put_char(ds, ')');
 144     }
 145 }
 146
 147 static void
 148 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
 149 {
 150     static const struct nl_policy ovs_sample_policy[] = {
 151         { NL_A_NO_ATTR, 0, 0, false }, /* OVS_SAMPLE_ATTR_UNSPEC */
 152         { NL_A_U32, 0, 0, false },     /* OVS_SAMPLE_ATTR_PROBABILITY */
 153         { NL_A_NESTED, 0, 0, false },  /* OVS_SAMPLE_ATTR_ACTIONS */
 154     };
 155     struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
 156     double percentage;
 157     const struct nlattr *nla_acts;
 158     int len;
 159
 160     ds_put_cstr(ds, "sample");
 161
 162     if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
 163         ds_put_cstr(ds, "(error)");
 164         return;
 165     }
 166
 167     percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
 168                         UINT32_MAX;
 169
 170     ds_put_format(ds, "(sample=%.1f%%,", percentage);
 171
 172     ds_put_cstr(ds, "actions(");
 173     nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
 174     len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
 175     format_odp_actions(ds, nla_acts, len);
 176     ds_put_format(ds, "))");
 177 }
 178
 179 static const char *
 180 slow_path_reason_to_string(uint32_t reason)
 181 {
 182     switch ((enum slow_path_reason) reason) {
 183 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return STRING;
 184         SLOW_PATH_REASONS
 185 #undef SPR
 186     }
 187
 188     return NULL;
 189 }
 190
 191 const char *
 192 slow_path_reason_to_explanation(enum slow_path_reason reason)
 193 {
 194     switch (reason) {
 195 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return EXPLANATION;
 196         SLOW_PATH_REASONS
 197 #undef SPR
 198     }
 199
 200     return "<unknown>";
 201 }
 202
 203 static int
 204 parse_flags(const char *s, const char *(*bit_to_string)(uint32_t),
 205             uint32_t *res)
 206 {
 207     uint32_t result = 0;
 208     int n = 0;
 209
 210     if (s[n] != '(') {
 211         return -EINVAL;
 212     }
 213     n++;
 214
 215     while (s[n] != ')') {
 216         unsigned long long int flags;
 217         uint32_t bit;
 218         int n0;
 219
 220         if (sscanf(&s[n], "%lli%n", &flags, &n0) > 0 && n0 > 0) {
 221             n += n0 + (s[n + n0] == ',');
 222             result |= flags;
 223             continue;
 224         }
 225
 226         for (bit = 1; bit; bit <<= 1) {
 227             const char *name = bit_to_string(bit);
 228             size_t len;
 229
 230             if (!name) {
 231                 continue;
 232             }
 233
 234             len = strlen(name);
 235             if (!strncmp(s + n, name, len) &&
 236                 (s[n + len] == ',' || s[n + len] == ')')) {
 237                 result |= bit;
 238                 n += len + (s[n + len] == ',');
 239                 break;
 240             }
 241         }
 242
 243         if (!bit) {
 244             return -EINVAL;
 245         }
 246     }
 247     n++;
 248
 249     *res = result;
 250     return n;
 251 }
 252
 253 static void
 254 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
 255 {
 256     static const struct nl_policy ovs_userspace_policy[] = {
 257         { NL_A_NO_ATTR, 0, 0, false }, /* OVS_USERSPACE_ATTR_UNSPEC */
 258         { NL_A_U32, 0, 0, false },     /* OVS_USERSPACE_ATTR_PID */
 259         { NL_A_UNSPEC, 0, 0, true },   /* OVS_USERSPACE_ATTR_USERDATA */
 260     };
 261     struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
 262     const struct nlattr *userdata_attr;
 263
 264     if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
 265         ds_put_cstr(ds, "userspace(error)");
 266         return;
 267     }
 268
 269     ds_put_format(ds, "userspace(pid=%"PRIu32,
 270                   nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
 271
 272     userdata_attr = a[OVS_USERSPACE_ATTR_USERDATA];
 273
 274     if (userdata_attr) {
 275         const uint8_t *userdata = nl_attr_get(userdata_attr);
 276         size_t userdata_len = nl_attr_get_size(userdata_attr);
 277         bool userdata_unspec = true;
 278         union user_action_cookie cookie;
 279
 280         if (userdata_len >= sizeof cookie.type
 281             && userdata_len <= sizeof cookie) {
 282
 283             memset(&cookie, 0, sizeof cookie);
 284             memcpy(&cookie, userdata, userdata_len);
 285
 286             userdata_unspec = false;
 287
 288             if (userdata_len == sizeof cookie.sflow
 289                 && cookie.type == USER_ACTION_COOKIE_SFLOW) {
 290                 ds_put_format(ds, ",sFlow("
 291                               "vid=%"PRIu16",pcp=%"PRIu8",output=%"PRIu32")",
 292                               vlan_tci_to_vid(cookie.sflow.vlan_tci),
 293                               vlan_tci_to_pcp(cookie.sflow.vlan_tci),
 294                               cookie.sflow.output);
 295             } else if (userdata_len == sizeof cookie.slow_path
 296                        && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
 297                 ds_put_cstr(ds, ",slow_path(");
 298                 format_flags(ds, slow_path_reason_to_string,
 299                              cookie.slow_path.reason, ',');
 300                 ds_put_format(ds, ")");
 301             } else if (userdata_len == sizeof cookie.flow_sample
 302                        && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
 303                 ds_put_format(ds, ",flow_sample(probability=%"PRIu16
 304                               ",collector_set_id=%"PRIu32
 305                               ",obs_domain_id=%"PRIu32
 306                               ",obs_point_id=%"PRIu32")",
 307                               cookie.flow_sample.probability,
 308                               cookie.flow_sample.collector_set_id,
 309                               cookie.flow_sample.obs_domain_id,
 310                               cookie.flow_sample.obs_point_id);
 311             } else if (userdata_len >= sizeof cookie.ipfix
 312                        && cookie.type == USER_ACTION_COOKIE_IPFIX) {
 313                 ds_put_format(ds, ",ipfix");
 314             } else {
 315                 userdata_unspec = true;
 316             }
 317         }
 318
 319         if (userdata_unspec) {
 320             size_t i;
 321             ds_put_format(ds, ",userdata(");
 322             for (i = 0; i < userdata_len; i++) {
 323                 ds_put_format(ds, "%02x", userdata[i]);
 324             }
 325             ds_put_char(ds, ')');
 326         }
 327     }
 328
 329     ds_put_char(ds, ')');
 330 }
 331
 332 static void
 333 format_vlan_tci(struct ds *ds, ovs_be16 vlan_tci)
 334 {
 335     ds_put_format(ds, "vid=%"PRIu16",pcp=%d",
 336                   vlan_tci_to_vid(vlan_tci),
 337                   vlan_tci_to_pcp(vlan_tci));
 338     if (!(vlan_tci & htons(VLAN_CFI))) {
 339         ds_put_cstr(ds, ",cfi=0");
 340     }
 341 }
 342
 343 static void
 344 format_mpls_lse(struct ds *ds, ovs_be32 mpls_lse)
 345 {
 346     ds_put_format(ds, "label=%"PRIu32",tc=%d,ttl=%d,bos=%d",
 347                   mpls_lse_to_label(mpls_lse),
 348                   mpls_lse_to_tc(mpls_lse),
 349                   mpls_lse_to_ttl(mpls_lse),
 350                   mpls_lse_to_bos(mpls_lse));
 351 }
 352
 353 static void
 354 format_mpls(struct ds *ds, const struct ovs_key_mpls *mpls_key,
 355             const struct ovs_key_mpls *mpls_mask)
 356 {
 357     ovs_be32 key = mpls_key->mpls_lse;
 358
 359     if (mpls_mask == NULL) {
 360         format_mpls_lse(ds, key);
 361     } else {
 362         ovs_be32 mask = mpls_mask->mpls_lse;
 363
 364         ds_put_format(ds, "label=%"PRIu32"/0x%x,tc=%d/%x,ttl=%d/0x%x,bos=%d/%x",
 365                   mpls_lse_to_label(key), mpls_lse_to_label(mask),
 366                   mpls_lse_to_tc(key), mpls_lse_to_tc(mask),
 367                   mpls_lse_to_ttl(key), mpls_lse_to_ttl(mask),
 368                   mpls_lse_to_bos(key), mpls_lse_to_bos(mask));
 369     }
 370 }
 371
 372 static void
 373 format_odp_action(struct ds *ds, const struct nlattr *a)
 374 {
 375     int expected_len;
 376     enum ovs_action_attr type = nl_attr_type(a);
 377     const struct ovs_action_push_vlan *vlan;
 378
 379     expected_len = odp_action_len(nl_attr_type(a));
 380     if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
 381         ds_put_format(ds, "bad length %zu, expected %d for: ",
 382                       nl_attr_get_size(a), expected_len);
 383         format_generic_odp_action(ds, a);
 384         return;
 385     }
 386
 387     switch (type) {
 388     case OVS_ACTION_ATTR_OUTPUT:
 389         ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
 390         break;
 391     case OVS_ACTION_ATTR_USERSPACE:
 392         format_odp_userspace_action(ds, a);
 393         break;
 394     case OVS_ACTION_ATTR_SET:
 395         ds_put_cstr(ds, "set(");
 396         format_odp_key_attr(nl_attr_get(a), NULL, NULL, ds, true);
 397         ds_put_cstr(ds, ")");
 398         break;
 399     case OVS_ACTION_ATTR_PUSH_VLAN:
 400         vlan = nl_attr_get(a);
 401         ds_put_cstr(ds, "push_vlan(");
 402         if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
 403             ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
 404         }
 405         format_vlan_tci(ds, vlan->vlan_tci);
 406         ds_put_char(ds, ')');
 407         break;
 408     case OVS_ACTION_ATTR_POP_VLAN:
 409         ds_put_cstr(ds, "pop_vlan");
 410         break;
 411     case OVS_ACTION_ATTR_PUSH_MPLS: {
 412         const struct ovs_action_push_mpls *mpls = nl_attr_get(a);
 413         ds_put_cstr(ds, "push_mpls(");
 414         format_mpls_lse(ds, mpls->mpls_lse);
 415         ds_put_format(ds, ",eth_type=0x%"PRIx16")", ntohs(mpls->mpls_ethertype));
 416         break;
 417     }
 418     case OVS_ACTION_ATTR_POP_MPLS: {
 419         ovs_be16 ethertype = nl_attr_get_be16(a);
 420         ds_put_format(ds, "pop_mpls(eth_type=0x%"PRIx16")", ntohs(ethertype));
 421         break;
 422     }
 423     case OVS_ACTION_ATTR_SAMPLE:
 424         format_odp_sample_action(ds, a);
 425         break;
 426     case OVS_ACTION_ATTR_UNSPEC:
 427     case __OVS_ACTION_ATTR_MAX:
 428     default:
 429         format_generic_odp_action(ds, a);
 430         break;
 431     }
 432 }
 433
 434 void
 435 format_odp_actions(struct ds *ds, const struct nlattr *actions,
 436                    size_t actions_len)
 437 {
 438     if (actions_len) {
 439         const struct nlattr *a;
 440         unsigned int left;
 441
 442         NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
 443             if (a != actions) {
 444                 ds_put_char(ds, ',');
 445             }
 446             format_odp_action(ds, a);
 447         }
 448         if (left) {
 449             int i;
 450
 451             if (left == actions_len) {
 452                 ds_put_cstr(ds, "<empty>");
 453             }
 454             ds_put_format(ds, ",***%u leftover bytes*** (", left);
 455             for (i = 0; i < left; i++) {
 456                 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
 457             }
 458             ds_put_char(ds, ')');
 459         }
 460     } else {
 461         ds_put_cstr(ds, "drop");
 462     }
 463 }
 464
 465 static int
 466 parse_odp_action(const char *s, const struct simap *port_names,
 467                  struct ofpbuf *actions)
 468 {
 469     /* Many of the sscanf calls in this function use oversized destination
 470      * fields because some sscanf() implementations truncate the range of %i
 471      * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
 472      * value of 0x7fff.  The other alternatives are to allow only a single
 473      * radix (e.g. decimal or hexadecimal) or to write more sophisticated
 474      * parsers.
 475      *
 476      * The tun_id parser has to use an alternative approach because there is no
 477      * type larger than 64 bits. */
 478
 479     {
 480         unsigned long long int port;
 481         int n = -1;
 482
 483         if (sscanf(s, "%lli%n", &port, &n) > 0 && n > 0) {
 484             nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
 485             return n;
 486         }
 487     }
 488
 489     if (port_names) {
 490         int len = strcspn(s, delimiters);
 491         struct simap_node *node;
 492
 493         node = simap_find_len(port_names, s, len);
 494         if (node) {
 495             nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, node->data);
 496             return len;
 497         }
 498     }
 499
 500     {
 501         unsigned long long int pid;
 502         unsigned long long int output;
 503         unsigned long long int probability;
 504         unsigned long long int collector_set_id;
 505         unsigned long long int obs_domain_id;
 506         unsigned long long int obs_point_id;
 507         int vid, pcp;
 508         int n = -1;
 509
 510         if (sscanf(s, "userspace(pid=%lli)%n", &pid, &n) > 0 && n > 0) {
 511             odp_put_userspace_action(pid, NULL, 0, actions);
 512             return n;
 513         } else if (sscanf(s, "userspace(pid=%lli,sFlow(vid=%i,"
 514                           "pcp=%i,output=%lli))%n",
 515                           &pid, &vid, &pcp, &output, &n) > 0 && n > 0) {
 516             union user_action_cookie cookie;
 517             uint16_t tci;
 518
 519             tci = vid | (pcp << VLAN_PCP_SHIFT);
 520             if (tci) {
 521                 tci |= VLAN_CFI;
 522             }
 523
 524             cookie.type = USER_ACTION_COOKIE_SFLOW;
 525             cookie.sflow.vlan_tci = htons(tci);
 526             cookie.sflow.output = output;
 527             odp_put_userspace_action(pid, &cookie, sizeof cookie.sflow,
 528                                      actions);
 529             return n;
 530         } else if (sscanf(s, "userspace(pid=%lli,slow_path%n", &pid, &n) > 0
 531                    && n > 0) {
 532             union user_action_cookie cookie;
 533             int res;
 534
 535             cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
 536             cookie.slow_path.unused = 0;
 537             cookie.slow_path.reason = 0;
 538
 539             res = parse_flags(&s[n], slow_path_reason_to_string,
 540                               &cookie.slow_path.reason);
 541             if (res < 0) {
 542                 return res;
 543             }
 544             n += res;
 545             if (s[n] != ')') {
 546                 return -EINVAL;
 547             }
 548             n++;
 549
 550             odp_put_userspace_action(pid, &cookie, sizeof cookie.slow_path,
 551                                      actions);
 552             return n;
 553         } else if (sscanf(s, "userspace(pid=%lli,flow_sample(probability=%lli,"
 554                           "collector_set_id=%lli,obs_domain_id=%lli,"
 555                           "obs_point_id=%lli))%n",
 556                           &pid, &probability, &collector_set_id,
 557                           &obs_domain_id, &obs_point_id, &n) > 0 && n > 0) {
 558             union user_action_cookie cookie;
 559
 560             cookie.type = USER_ACTION_COOKIE_FLOW_SAMPLE;
 561             cookie.flow_sample.probability = probability;
 562             cookie.flow_sample.collector_set_id = collector_set_id;
 563             cookie.flow_sample.obs_domain_id = obs_domain_id;
 564             cookie.flow_sample.obs_point_id = obs_point_id;
 565             odp_put_userspace_action(pid, &cookie, sizeof cookie.flow_sample,
 566                                      actions);
 567             return n;
 568         } else if (sscanf(s, "userspace(pid=%lli,ipfix)%n", &pid, &n) > 0
 569                    && n > 0) {
 570             union user_action_cookie cookie;
 571
 572             cookie.type = USER_ACTION_COOKIE_IPFIX;
 573             odp_put_userspace_action(pid, &cookie, sizeof cookie.ipfix,
 574                                      actions);
 575             return n;
 576         } else if (sscanf(s, "userspace(pid=%lli,userdata(%n", &pid, &n) > 0
 577                    && n > 0) {
 578             struct ofpbuf buf;
 579             char *end;
 580
 581             ofpbuf_init(&buf, 16);
 582             end = ofpbuf_put_hex(&buf, &s[n], NULL);
 583             if (end[0] == ')' && end[1] == ')') {
 584                 odp_put_userspace_action(pid, buf.data, buf.size, actions);
 585                 ofpbuf_uninit(&buf);
 586                 return (end + 2) - s;
 587             }
 588         }
 589     }
 590
 591     if (!strncmp(s, "set(", 4)) {
 592         size_t start_ofs;
 593         int retval;
 594
 595         start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
 596         retval = parse_odp_key_mask_attr(s + 4, port_names, actions, NULL);
 597         if (retval < 0) {
 598             return retval;
 599         }
 600         if (s[retval + 4] != ')') {
 601             return -EINVAL;
 602         }
 603         nl_msg_end_nested(actions, start_ofs);
 604         return retval + 5;
 605     }
 606
 607     {
 608         struct ovs_action_push_vlan push;
 609         int tpid = ETH_TYPE_VLAN;
 610         int vid, pcp;
 611         int cfi = 1;
 612         int n = -1;
 613
 614         if ((sscanf(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n) > 0
 615              && n > 0)
 616             || (sscanf(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
 617                        &vid, &pcp, &cfi, &n) > 0 && n > 0)
 618             || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
 619                        &tpid, &vid, &pcp, &n) > 0 && n > 0)
 620             || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
 621                        &tpid, &vid, &pcp, &cfi, &n) > 0 && n > 0)) {
 622             push.vlan_tpid = htons(tpid);
 623             push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
 624                                   | (pcp << VLAN_PCP_SHIFT)
 625                                   | (cfi ? VLAN_CFI : 0));
 626             nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
 627                               &push, sizeof push);
 628
 629             return n;
 630         }
 631     }
 632
 633     if (!strncmp(s, "pop_vlan", 8)) {
 634         nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
 635         return 8;
 636     }
 637
 638     {
 639         double percentage;
 640         int n = -1;
 641
 642         if (sscanf(s, "sample(sample=%lf%%,actions(%n", &percentage, &n) > 0
 643             && percentage >= 0. && percentage <= 100.0
 644             && n > 0) {
 645             size_t sample_ofs, actions_ofs;
 646             double probability;
 647
 648             probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
 649             sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
 650             nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
 651                            (probability <= 0 ? 0
 652                             : probability >= UINT32_MAX ? UINT32_MAX
 653                             : probability));
 654
 655             actions_ofs = nl_msg_start_nested(actions,
 656                                               OVS_SAMPLE_ATTR_ACTIONS);
 657             for (;;) {
 658                 int retval;
 659
 660                 n += strspn(s + n, delimiters);
 661                 if (s[n] == ')') {
 662                     break;
 663                 }
 664
 665                 retval = parse_odp_action(s + n, port_names, actions);
 666                 if (retval < 0) {
 667                     return retval;
 668                 }
 669                 n += retval;
 670             }
 671             nl_msg_end_nested(actions, actions_ofs);
 672             nl_msg_end_nested(actions, sample_ofs);
 673
 674             return s[n + 1] == ')' ? n + 2 : -EINVAL;
 675         }
 676     }
 677
 678     return -EINVAL;
 679 }
 680
 681 /* Parses the string representation of datapath actions, in the format output
 682  * by format_odp_action().  Returns 0 if successful, otherwise a positive errno
 683  * value.  On success, the ODP actions are appended to 'actions' as a series of
 684  * Netlink attributes.  On failure, no data is appended to 'actions'.  Either
 685  * way, 'actions''s data might be reallocated. */
 686 int
 687 odp_actions_from_string(const char *s, const struct simap *port_names,
 688                         struct ofpbuf *actions)
 689 {
 690     size_t old_size;
 691
 692     if (!strcasecmp(s, "drop")) {
 693         return 0;
 694     }
 695
 696     old_size = actions->size;
 697     for (;;) {
 698         int retval;
 699
 700         s += strspn(s, delimiters);
 701         if (!*s) {
 702             return 0;
 703         }
 704
 705         retval = parse_odp_action(s, port_names, actions);
 706         if (retval < 0 || !strchr(delimiters, s[retval])) {
 707             actions->size = old_size;
 708             return -retval;
 709         }
 710         s += retval;
 711     }
 712
 713     return 0;
 714 }
 715 \f
 716 /* Returns the correct length of the payload for a flow key attribute of the
 717  * specified 'type', -1 if 'type' is unknown, or -2 if the attribute's payload
 718  * is variable length. */
 719 static int
 720 odp_flow_key_attr_len(uint16_t type)
 721 {
 722     if (type > OVS_KEY_ATTR_MAX) {
 723         return -1;
 724     }
 725
 726     switch ((enum ovs_key_attr) type) {
 727     case OVS_KEY_ATTR_ENCAP: return -2;
 728     case OVS_KEY_ATTR_PRIORITY: return 4;
 729     case OVS_KEY_ATTR_SKB_MARK: return 4;
 730     case OVS_KEY_ATTR_TUNNEL: return -2;
 731     case OVS_KEY_ATTR_IN_PORT: return 4;
 732     case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
 733     case OVS_KEY_ATTR_VLAN: return sizeof(ovs_be16);
 734     case OVS_KEY_ATTR_ETHERTYPE: return 2;
 735     case OVS_KEY_ATTR_MPLS: return sizeof(struct ovs_key_mpls);
 736     case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
 737     case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
 738     case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
 739     case OVS_KEY_ATTR_TCP_FLAGS: return 2;
 740     case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
 741     case OVS_KEY_ATTR_SCTP: return sizeof(struct ovs_key_sctp);
 742     case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
 743     case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
 744     case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
 745     case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
 746
 747     case OVS_KEY_ATTR_UNSPEC:
 748     case __OVS_KEY_ATTR_MAX:
 749         return -1;
 750     }
 751
 752     return -1;
 753 }
 754
 755 static void
 756 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
 757 {
 758     size_t len = nl_attr_get_size(a);
 759     if (len) {
 760         const uint8_t *unspec;
 761         unsigned int i;
 762
 763         unspec = nl_attr_get(a);
 764         for (i = 0; i < len; i++) {
 765             if (i) {
 766                 ds_put_char(ds, ' ');
 767             }
 768             ds_put_format(ds, "%02x", unspec[i]);
 769         }
 770     }
 771 }
 772
 773 static const char *
 774 ovs_frag_type_to_string(enum ovs_frag_type type)
 775 {
 776     switch (type) {
 777     case OVS_FRAG_TYPE_NONE:
 778         return "no";
 779     case OVS_FRAG_TYPE_FIRST:
 780         return "first";
 781     case OVS_FRAG_TYPE_LATER:
 782         return "later";
 783     case __OVS_FRAG_TYPE_MAX:
 784     default:
 785         return "<error>";
 786     }
 787 }
 788
 789 static int
 790 tunnel_key_attr_len(int type)
 791 {
 792     switch (type) {
 793     case OVS_TUNNEL_KEY_ATTR_ID: return 8;
 794     case OVS_TUNNEL_KEY_ATTR_IPV4_SRC: return 4;
 795     case OVS_TUNNEL_KEY_ATTR_IPV4_DST: return 4;
 796     case OVS_TUNNEL_KEY_ATTR_TOS: return 1;
 797     case OVS_TUNNEL_KEY_ATTR_TTL: return 1;
 798     case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT: return 0;
 799     case OVS_TUNNEL_KEY_ATTR_CSUM: return 0;
 800     case __OVS_TUNNEL_KEY_ATTR_MAX:
 801         return -1;
 802     }
 803     return -1;
 804 }
 805
 806 enum odp_key_fitness
 807 odp_tun_key_from_attr(const struct nlattr *attr, struct flow_tnl *tun)
 808 {
 809     unsigned int left;
 810     const struct nlattr *a;
 811     bool ttl = false;
 812     bool unknown = false;
 813
 814     NL_NESTED_FOR_EACH(a, left, attr) {
 815         uint16_t type = nl_attr_type(a);
 816         size_t len = nl_attr_get_size(a);
 817         int expected_len = tunnel_key_attr_len(type);
 818
 819         if (len != expected_len && expected_len >= 0) {
 820             return ODP_FIT_ERROR;
 821         }
 822
 823         switch (type) {
 824         case OVS_TUNNEL_KEY_ATTR_ID:
 825             tun->tun_id = nl_attr_get_be64(a);
 826             tun->flags |= FLOW_TNL_F_KEY;
 827             break;
 828         case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
 829             tun->ip_src = nl_attr_get_be32(a);
 830             break;
 831         case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
 832             tun->ip_dst = nl_attr_get_be32(a);
 833             break;
 834         case OVS_TUNNEL_KEY_ATTR_TOS:
 835             tun->ip_tos = nl_attr_get_u8(a);
 836             break;
 837         case OVS_TUNNEL_KEY_ATTR_TTL:
 838             tun->ip_ttl = nl_attr_get_u8(a);
 839             ttl = true;
 840             break;
 841         case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
 842             tun->flags |= FLOW_TNL_F_DONT_FRAGMENT;
 843             break;
 844         case OVS_TUNNEL_KEY_ATTR_CSUM:
 845             tun->flags |= FLOW_TNL_F_CSUM;
 846             break;
 847         default:
 848             /* Allow this to show up as unexpected, if there are unknown
 849              * tunnel attribute, eventually resulting in ODP_FIT_TOO_MUCH. */
 850             unknown = true;
 851             break;
 852         }
 853     }
 854
 855     if (!ttl) {
 856         return ODP_FIT_ERROR;
 857     }
 858     if (unknown) {
 859             return ODP_FIT_TOO_MUCH;
 860     }
 861     return ODP_FIT_PERFECT;
 862 }
 863
 864 static void
 865 tun_key_to_attr(struct ofpbuf *a, const struct flow_tnl *tun_key)
 866 {
 867     size_t tun_key_ofs;
 868
 869     tun_key_ofs = nl_msg_start_nested(a, OVS_KEY_ATTR_TUNNEL);
 870
 871     if (tun_key->flags & FLOW_TNL_F_KEY) {
 872         nl_msg_put_be64(a, OVS_TUNNEL_KEY_ATTR_ID, tun_key->tun_id);
 873     }
 874     if (tun_key->ip_src) {
 875         nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_SRC, tun_key->ip_src);
 876     }
 877     if (tun_key->ip_dst) {
 878         nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_DST, tun_key->ip_dst);
 879     }
 880     if (tun_key->ip_tos) {
 881         nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TOS, tun_key->ip_tos);
 882     }
 883     nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TTL, tun_key->ip_ttl);
 884     if (tun_key->flags & FLOW_TNL_F_DONT_FRAGMENT) {
 885         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
 886     }
 887     if (tun_key->flags & FLOW_TNL_F_CSUM) {
 888         nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
 889     }
 890
 891     nl_msg_end_nested(a, tun_key_ofs);
 892 }
 893
 894 static bool
 895 odp_mask_attr_is_wildcard(const struct nlattr *ma)
 896 {
 897     return is_all_zeros(nl_attr_get(ma), nl_attr_get_size(ma));
 898 }
 899
 900 static bool
 901 odp_mask_attr_is_exact(const struct nlattr *ma)
 902 {
 903     bool is_exact = false;
 904     enum ovs_key_attr attr = nl_attr_type(ma);
 905
 906     if (attr == OVS_KEY_ATTR_TUNNEL) {
 907         /* XXX this is a hack for now. Should change
 908          * the exact match dection to per field
 909          * instead of per attribute.
 910          */
 911         struct flow_tnl tun_mask;
 912         memset(&tun_mask, 0, sizeof tun_mask);
 913         odp_tun_key_from_attr(ma, &tun_mask);
 914         if (tun_mask.flags == (FLOW_TNL_F_KEY
 915                                | FLOW_TNL_F_DONT_FRAGMENT
 916                                | FLOW_TNL_F_CSUM)) {
 917             /* The flags are exact match, check the remaining fields. */
 918             tun_mask.flags = 0xffff;
 919             is_exact = is_all_ones((uint8_t *)&tun_mask,
 920                                    offsetof(struct flow_tnl, ip_ttl));
 921         }
 922     } else {
 923         is_exact = is_all_ones(nl_attr_get(ma), nl_attr_get_size(ma));
 924     }
 925
 926     return is_exact;
 927 }
 928
 929 void
 930 odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
 931                      char *port_name)
 932 {
 933     struct odp_portno_names *odp_portno_names;
 934
 935     odp_portno_names = xmalloc(sizeof *odp_portno_names);
 936     odp_portno_names->port_no = port_no;
 937     odp_portno_names->name = xstrdup(port_name);
 938     hmap_insert(portno_names, &odp_portno_names->hmap_node,
 939                 hash_odp_port(port_no));
 940 }
 941
 942 static char *
 943 odp_portno_names_get(const struct hmap *portno_names, odp_port_t port_no)
 944 {
 945     struct odp_portno_names *odp_portno_names;
 946
 947     HMAP_FOR_EACH_IN_BUCKET (odp_portno_names, hmap_node,
 948                              hash_odp_port(port_no), portno_names) {
 949         if (odp_portno_names->port_no == port_no) {
 950             return odp_portno_names->name;
 951         }
 952     }
 953     return NULL;
 954 }
 955
 956 void
 957 odp_portno_names_destroy(struct hmap *portno_names)
 958 {
 959     struct odp_portno_names *odp_portno_names, *odp_portno_names_next;
 960     HMAP_FOR_EACH_SAFE (odp_portno_names, odp_portno_names_next,
 961                         hmap_node, portno_names) {
 962         hmap_remove(portno_names, &odp_portno_names->hmap_node);
 963         free(odp_portno_names->name);
 964         free(odp_portno_names);
 965     }
 966 }
 967
 968 static void
 969 format_odp_key_attr(const struct nlattr *a, const struct nlattr *ma,
 970                     const struct hmap *portno_names, struct ds *ds,
 971                     bool verbose)
 972 {
 973     struct flow_tnl tun_key;
 974     enum ovs_key_attr attr = nl_attr_type(a);
 975     char namebuf[OVS_KEY_ATTR_BUFSIZE];
 976     int expected_len;
 977     bool is_exact;
 978
 979     is_exact = ma ? odp_mask_attr_is_exact(ma) : true;
 980
 981     ds_put_cstr(ds, ovs_key_attr_to_string(attr, namebuf, sizeof namebuf));
 982
 983     {
 984         expected_len = odp_flow_key_attr_len(nl_attr_type(a));
 985         if (expected_len != -2) {
 986             bool bad_key_len = nl_attr_get_size(a) != expected_len;
 987             bool bad_mask_len = ma && nl_attr_get_size(a) != expected_len;
 988
 989             if (bad_key_len || bad_mask_len) {
 990                 if (bad_key_len) {
 991                     ds_put_format(ds, "(bad key length %zu, expected %d)(",
 992                                   nl_attr_get_size(a),
 993                                   odp_flow_key_attr_len(nl_attr_type(a)));
 994                 }
 995                 format_generic_odp_key(a, ds);
 996                 if (bad_mask_len) {
 997                     ds_put_char(ds, '/');
 998                     ds_put_format(ds, "(bad mask length %zu, expected %d)(",
 999                                   nl_attr_get_size(ma),
1000                                   odp_flow_key_attr_len(nl_attr_type(ma)));
1001                 }
1002                 format_generic_odp_key(ma, ds);
1003                 ds_put_char(ds, ')');
1004                 return;
1005             }
1006         }
1007     }
1008
1009     ds_put_char(ds, '(');
1010     switch (attr) {
1011     case OVS_KEY_ATTR_ENCAP:
1012         if (ma && nl_attr_get_size(ma) && nl_attr_get_size(a)) {
1013             odp_flow_format(nl_attr_get(a), nl_attr_get_size(a),
1014                             nl_attr_get(ma), nl_attr_get_size(ma), NULL, ds,
1015                             verbose);
1016         } else if (nl_attr_get_size(a)) {
1017             odp_flow_format(nl_attr_get(a), nl_attr_get_size(a), NULL, 0, NULL,
1018                             ds, verbose);
1019         }
1020         break;
1021
1022     case OVS_KEY_ATTR_PRIORITY:
1023     case OVS_KEY_ATTR_SKB_MARK:
1024         ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
1025         if (!is_exact) {
1026             ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
1027         }
1028         break;
1029
1030     case OVS_KEY_ATTR_TUNNEL:
1031         memset(&tun_key, 0, sizeof tun_key);
1032         if (odp_tun_key_from_attr(a, &tun_key) == ODP_FIT_ERROR) {
1033             ds_put_format(ds, "error");
1034         } else if (!is_exact) {
1035             struct flow_tnl tun_mask;
1036
1037             memset(&tun_mask, 0, sizeof tun_mask);
1038             odp_tun_key_from_attr(ma, &tun_mask);
1039             ds_put_format(ds, "tun_id=%#"PRIx64"/%#"PRIx64
1040                           ",src="IP_FMT"/"IP_FMT",dst="IP_FMT"/"IP_FMT
1041                           ",tos=%#"PRIx8"/%#"PRIx8",ttl=%"PRIu8"/%#"PRIx8
1042                           ",flags(",
1043                           ntohll(tun_key.tun_id), ntohll(tun_mask.tun_id),
1044                           IP_ARGS(tun_key.ip_src), IP_ARGS(tun_mask.ip_src),
1045                           IP_ARGS(tun_key.ip_dst), IP_ARGS(tun_mask.ip_dst),
1046                           tun_key.ip_tos, tun_mask.ip_tos,
1047                           tun_key.ip_ttl, tun_mask.ip_ttl);
1048
1049             format_flags(ds, flow_tun_flag_to_string, tun_key.flags, ',');
1050
1051             /* XXX This code is correct, but enabling it would break the unit
1052                test. Disable it for now until the input parser is fixed.
1053
1054                 ds_put_char(ds, '/');
1055                 format_flags(ds, flow_tun_flag_to_string, tun_mask.flags, ',');
1056             */
1057             ds_put_char(ds, ')');
1058         } else {
1059             ds_put_format(ds, "tun_id=0x%"PRIx64",src="IP_FMT",dst="IP_FMT","
1060                           "tos=0x%"PRIx8",ttl=%"PRIu8",flags(",
1061                           ntohll(tun_key.tun_id),
1062                           IP_ARGS(tun_key.ip_src),
1063                           IP_ARGS(tun_key.ip_dst),
1064                           tun_key.ip_tos, tun_key.ip_ttl);
1065
1066             format_flags(ds, flow_tun_flag_to_string, tun_key.flags, ',');
1067             ds_put_char(ds, ')');
1068         }
1069         break;
1070
1071     case OVS_KEY_ATTR_IN_PORT:
1072         if (portno_names && verbose && is_exact) {
1073             char *name = odp_portno_names_get(portno_names,
1074                             u32_to_odp(nl_attr_get_u32(a)));
1075             if (name) {
1076                 ds_put_format(ds, "%s", name);
1077             } else {
1078                 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
1079             }
1080         } else {
1081             ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
1082             if (!is_exact) {
1083                 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
1084             }
1085         }
1086         break;
1087
1088     case OVS_KEY_ATTR_ETHERNET:
1089         if (!is_exact) {
1090             const struct ovs_key_ethernet *eth_mask = nl_attr_get(ma);
1091             const struct ovs_key_ethernet *eth_key = nl_attr_get(a);
1092
1093             ds_put_format(ds, "src="ETH_ADDR_FMT"/"ETH_ADDR_FMT
1094                           ",dst="ETH_ADDR_FMT"/"ETH_ADDR_FMT,
1095                           ETH_ADDR_ARGS(eth_key->eth_src),
1096                           ETH_ADDR_ARGS(eth_mask->eth_src),
1097                           ETH_ADDR_ARGS(eth_key->eth_dst),
1098                           ETH_ADDR_ARGS(eth_mask->eth_dst));
1099         } else {
1100             const struct ovs_key_ethernet *eth_key = nl_attr_get(a);
1101
1102             ds_put_format(ds, "src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT,
1103                           ETH_ADDR_ARGS(eth_key->eth_src),
1104                           ETH_ADDR_ARGS(eth_key->eth_dst));
1105         }
1106         break;
1107
1108     case OVS_KEY_ATTR_VLAN:
1109         {
1110             ovs_be16 vlan_tci = nl_attr_get_be16(a);
1111             if (!is_exact) {
1112                 ovs_be16 mask = nl_attr_get_be16(ma);
1113                 ds_put_format(ds, "vid=%"PRIu16"/0x%"PRIx16",pcp=%d/0x%x,cfi=%d/%d",
1114                               vlan_tci_to_vid(vlan_tci),
1115                               vlan_tci_to_vid(mask),
1116                               vlan_tci_to_pcp(vlan_tci),
1117                               vlan_tci_to_pcp(mask),
1118                               vlan_tci_to_cfi(vlan_tci),
1119                               vlan_tci_to_cfi(mask));
1120             } else {
1121                 format_vlan_tci(ds, vlan_tci);
1122             }
1123         }
1124         break;
1125
1126     case OVS_KEY_ATTR_MPLS: {
1127         const struct ovs_key_mpls *mpls_key = nl_attr_get(a);
1128         const struct ovs_key_mpls *mpls_mask = NULL;
1129         if (!is_exact) {
1130             mpls_mask = nl_attr_get(ma);
1131         }
1132         format_mpls(ds, mpls_key, mpls_mask);
1133         break;
1134     }
1135
1136     case OVS_KEY_ATTR_ETHERTYPE:
1137         ds_put_format(ds, "0x%04"PRIx16, ntohs(nl_attr_get_be16(a)));
1138         if (!is_exact) {
1139             ds_put_format(ds, "/0x%04"PRIx16, ntohs(nl_attr_get_be16(ma)));
1140         }
1141         break;
1142
1143     case OVS_KEY_ATTR_IPV4:
1144         if (!is_exact) {
1145             const struct ovs_key_ipv4 *ipv4_key = nl_attr_get(a);
1146             const struct ovs_key_ipv4 *ipv4_mask = nl_attr_get(ma);
1147
1148             ds_put_format(ds, "src="IP_FMT"/"IP_FMT",dst="IP_FMT"/"IP_FMT
1149                           ",proto=%"PRIu8"/%#"PRIx8",tos=%#"PRIx8"/%#"PRIx8
1150                           ",ttl=%"PRIu8"/%#"PRIx8",frag=%s/%#"PRIx8,
1151                           IP_ARGS(ipv4_key->ipv4_src),
1152                           IP_ARGS(ipv4_mask->ipv4_src),
1153                           IP_ARGS(ipv4_key->ipv4_dst),
1154                           IP_ARGS(ipv4_mask->ipv4_dst),
1155                           ipv4_key->ipv4_proto, ipv4_mask->ipv4_proto,
1156                           ipv4_key->ipv4_tos, ipv4_mask->ipv4_tos,
1157                           ipv4_key->ipv4_ttl, ipv4_mask->ipv4_ttl,
1158                           ovs_frag_type_to_string(ipv4_key->ipv4_frag),
1159                           ipv4_mask->ipv4_frag);
1160         } else {
1161             const struct ovs_key_ipv4 *ipv4_key = nl_attr_get(a);
1162
1163             ds_put_format(ds, "src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
1164                           ",tos=%#"PRIx8",ttl=%"PRIu8",frag=%s",
1165                           IP_ARGS(ipv4_key->ipv4_src),
1166                           IP_ARGS(ipv4_key->ipv4_dst),
1167                           ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
1168                           ipv4_key->ipv4_ttl,
1169                           ovs_frag_type_to_string(ipv4_key->ipv4_frag));
1170         }
1171         break;
1172
1173     case OVS_KEY_ATTR_IPV6:
1174         if (!is_exact) {
1175             const struct ovs_key_ipv6 *ipv6_key, *ipv6_mask;
1176             char src_str[INET6_ADDRSTRLEN];
1177             char dst_str[INET6_ADDRSTRLEN];
1178             char src_mask[INET6_ADDRSTRLEN];
1179             char dst_mask[INET6_ADDRSTRLEN];
1180
1181             ipv6_key = nl_attr_get(a);
1182             inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
1183             inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
1184
1185             ipv6_mask = nl_attr_get(ma);
1186             inet_ntop(AF_INET6, ipv6_mask->ipv6_src, src_mask, sizeof src_mask);
1187             inet_ntop(AF_INET6, ipv6_mask->ipv6_dst, dst_mask, sizeof dst_mask);
1188
1189             ds_put_format(ds, "src=%s/%s,dst=%s/%s,label=%#"PRIx32"/%#"PRIx32
1190                           ",proto=%"PRIu8"/%#"PRIx8",tclass=%#"PRIx8"/%#"PRIx8
1191                           ",hlimit=%"PRIu8"/%#"PRIx8",frag=%s/%#"PRIx8,
1192                           src_str, src_mask, dst_str, dst_mask,
1193                           ntohl(ipv6_key->ipv6_label),
1194                           ntohl(ipv6_mask->ipv6_label),
1195                           ipv6_key->ipv6_proto, ipv6_mask->ipv6_proto,
1196                           ipv6_key->ipv6_tclass, ipv6_mask->ipv6_tclass,
1197                           ipv6_key->ipv6_hlimit, ipv6_mask->ipv6_hlimit,
1198                           ovs_frag_type_to_string(ipv6_key->ipv6_frag),
1199                           ipv6_mask->ipv6_frag);
1200         } else {
1201             const struct ovs_key_ipv6 *ipv6_key;
1202             char src_str[INET6_ADDRSTRLEN];
1203             char dst_str[INET6_ADDRSTRLEN];
1204
1205             ipv6_key = nl_attr_get(a);
1206             inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
1207             inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
1208
1209             ds_put_format(ds, "src=%s,dst=%s,label=%#"PRIx32",proto=%"PRIu8
1210                           ",tclass=%#"PRIx8",hlimit=%"PRIu8",frag=%s",
1211                           src_str, dst_str, ntohl(ipv6_key->ipv6_label),
1212                           ipv6_key->ipv6_proto, ipv6_key->ipv6_tclass,
1213                           ipv6_key->ipv6_hlimit,
1214                           ovs_frag_type_to_string(ipv6_key->ipv6_frag));
1215         }
1216         break;
1217
1218     case OVS_KEY_ATTR_TCP:
1219         if (!is_exact) {
1220             const struct ovs_key_tcp *tcp_mask = nl_attr_get(ma);
1221             const struct ovs_key_tcp *tcp_key = nl_attr_get(a);
1222
1223             ds_put_format(ds, "src=%"PRIu16"/%#"PRIx16
1224                           ",dst=%"PRIu16"/%#"PRIx16,
1225                           ntohs(tcp_key->tcp_src), ntohs(tcp_mask->tcp_src),
1226                           ntohs(tcp_key->tcp_dst), ntohs(tcp_mask->tcp_dst));
1227         } else {
1228             const struct ovs_key_tcp *tcp_key = nl_attr_get(a);
1229
1230             ds_put_format(ds, "src=%"PRIu16",dst=%"PRIu16,
1231                           ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
1232         }
1233         break;
1234
1235     case OVS_KEY_ATTR_TCP_FLAGS:
1236         ds_put_format(ds, "0x%03"PRIx16, ntohs(nl_attr_get_be16(a)));
1237         if (!is_exact) {
1238             ds_put_format(ds, "/0x%03"PRIx16, ntohs(nl_attr_get_be16(ma)));
1239         }
1240         break;
1241
1242     case OVS_KEY_ATTR_UDP:
1243         if (!is_exact) {
1244             const struct ovs_key_udp *udp_mask = nl_attr_get(ma);
1245             const struct ovs_key_udp *udp_key = nl_attr_get(a);
1246
1247             ds_put_format(ds, "src=%"PRIu16"/%#"PRIx16
1248                           ",dst=%"PRIu16"/%#"PRIx16,
1249                           ntohs(udp_key->udp_src), ntohs(udp_mask->udp_src),
1250                           ntohs(udp_key->udp_dst), ntohs(udp_mask->udp_dst));
1251         } else {
1252             const struct ovs_key_udp *udp_key = nl_attr_get(a);
1253
1254             ds_put_format(ds, "src=%"PRIu16",dst=%"PRIu16,
1255                           ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
1256         }
1257         break;
1258
1259     case OVS_KEY_ATTR_SCTP:
1260         if (ma) {
1261             const struct ovs_key_sctp *sctp_mask = nl_attr_get(ma);
1262             const struct ovs_key_sctp *sctp_key = nl_attr_get(a);
1263
1264             ds_put_format(ds, "src=%"PRIu16"/%#"PRIx16
1265                           ",dst=%"PRIu16"/%#"PRIx16,
1266                           ntohs(sctp_key->sctp_src), ntohs(sctp_mask->sctp_src),
1267                           ntohs(sctp_key->sctp_dst), ntohs(sctp_mask->sctp_dst));
1268         } else {
1269             const struct ovs_key_sctp *sctp_key = nl_attr_get(a);
1270
1271             ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
1272                           ntohs(sctp_key->sctp_src), ntohs(sctp_key->sctp_dst));
1273         }
1274         break;
1275
1276     case OVS_KEY_ATTR_ICMP:
1277         if (!is_exact) {
1278             const struct ovs_key_icmp *icmp_mask = nl_attr_get(ma);
1279             const struct ovs_key_icmp *icmp_key = nl_attr_get(a);
1280
1281             ds_put_format(ds, "type=%"PRIu8"/%#"PRIx8",code=%"PRIu8"/%#"PRIx8,
1282                           icmp_key->icmp_type, icmp_mask->icmp_type,
1283                           icmp_key->icmp_code, icmp_mask->icmp_code);
1284         } else {
1285             const struct ovs_key_icmp *icmp_key = nl_attr_get(a);
1286
1287             ds_put_format(ds, "type=%"PRIu8",code=%"PRIu8,
1288                           icmp_key->icmp_type, icmp_key->icmp_code);
1289         }
1290         break;
1291
1292     case OVS_KEY_ATTR_ICMPV6:
1293         if (!is_exact) {
1294             const struct ovs_key_icmpv6 *icmpv6_mask = nl_attr_get(ma);
1295             const struct ovs_key_icmpv6 *icmpv6_key = nl_attr_get(a);
1296
1297             ds_put_format(ds, "type=%"PRIu8"/%#"PRIx8",code=%"PRIu8"/%#"PRIx8,
1298                           icmpv6_key->icmpv6_type, icmpv6_mask->icmpv6_type,
1299                           icmpv6_key->icmpv6_code, icmpv6_mask->icmpv6_code);
1300         } else {
1301             const struct ovs_key_icmpv6 *icmpv6_key = nl_attr_get(a);
1302
1303             ds_put_format(ds, "type=%"PRIu8",code=%"PRIu8,
1304                           icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
1305         }
1306         break;
1307
1308     case OVS_KEY_ATTR_ARP:
1309         if (!is_exact) {
1310             const struct ovs_key_arp *arp_mask = nl_attr_get(ma);
1311             const struct ovs_key_arp *arp_key = nl_attr_get(a);
1312
1313             ds_put_format(ds, "sip="IP_FMT"/"IP_FMT",tip="IP_FMT"/"IP_FMT
1314                           ",op=%"PRIu16"/%#"PRIx16
1315                           ",sha="ETH_ADDR_FMT"/"ETH_ADDR_FMT
1316                           ",tha="ETH_ADDR_FMT"/"ETH_ADDR_FMT,
1317                           IP_ARGS(arp_key->arp_sip),
1318                           IP_ARGS(arp_mask->arp_sip),
1319                           IP_ARGS(arp_key->arp_tip),
1320                           IP_ARGS(arp_mask->arp_tip),
1321                           ntohs(arp_key->arp_op), ntohs(arp_mask->arp_op),
1322                           ETH_ADDR_ARGS(arp_key->arp_sha),
1323                           ETH_ADDR_ARGS(arp_mask->arp_sha),
1324                           ETH_ADDR_ARGS(arp_key->arp_tha),
1325                           ETH_ADDR_ARGS(arp_mask->arp_tha));
1326         } else {
1327             const struct ovs_key_arp *arp_key = nl_attr_get(a);
1328
1329             ds_put_format(ds, "sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
1330                           "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT,
1331                           IP_ARGS(arp_key->arp_sip), IP_ARGS(arp_key->arp_tip),
1332                           ntohs(arp_key->arp_op),
1333                           ETH_ADDR_ARGS(arp_key->arp_sha),
1334                           ETH_ADDR_ARGS(arp_key->arp_tha));
1335         }
1336         break;
1337
1338     case OVS_KEY_ATTR_ND: {
1339         const struct ovs_key_nd *nd_key, *nd_mask = NULL;
1340         char target[INET6_ADDRSTRLEN];
1341
1342         nd_key = nl_attr_get(a);
1343         if (!is_exact) {
1344             nd_mask = nl_attr_get(ma);
1345         }
1346
1347         inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
1348         ds_put_format(ds, "target=%s", target);
1349         if (!is_exact) {
1350             inet_ntop(AF_INET6, nd_mask->nd_target, target, sizeof target);
1351             ds_put_format(ds, "/%s", target);
1352         }
1353
1354         if (!eth_addr_is_zero(nd_key->nd_sll)) {
1355             ds_put_format(ds, ",sll="ETH_ADDR_FMT,
1356                           ETH_ADDR_ARGS(nd_key->nd_sll));
1357             if (!is_exact) {
1358                 ds_put_format(ds, "/"ETH_ADDR_FMT,
1359                               ETH_ADDR_ARGS(nd_mask->nd_sll));
1360             }
1361         }
1362         if (!eth_addr_is_zero(nd_key->nd_tll)) {
1363             ds_put_format(ds, ",tll="ETH_ADDR_FMT,
1364                           ETH_ADDR_ARGS(nd_key->nd_tll));
1365             if (!is_exact) {
1366                 ds_put_format(ds, "/"ETH_ADDR_FMT,
1367                               ETH_ADDR_ARGS(nd_mask->nd_tll));
1368             }
1369         }
1370         break;
1371     }
1372
1373     case OVS_KEY_ATTR_UNSPEC:
1374     case __OVS_KEY_ATTR_MAX:
1375     default:
1376         format_generic_odp_key(a, ds);
1377         if (!is_exact) {
1378             ds_put_char(ds, '/');
1379             format_generic_odp_key(ma, ds);
1380         }
1381         break;
1382     }
1383     ds_put_char(ds, ')');
1384 }
1385
1386 static struct nlattr *
1387 generate_all_wildcard_mask(struct ofpbuf *ofp, const struct nlattr *key)
1388 {
1389     const struct nlattr *a;
1390     unsigned int left;
1391     int type = nl_attr_type(key);
1392     int size = nl_attr_get_size(key);
1393
1394     if (odp_flow_key_attr_len(type) >=0) {
1395         nl_msg_put_unspec_zero(ofp, type, size);
1396     } else {
1397         size_t nested_mask;
1398
1399         nested_mask = nl_msg_start_nested(ofp, type);
1400         NL_ATTR_FOR_EACH(a, left, key, nl_attr_get_size(key)) {
1401             generate_all_wildcard_mask(ofp, nl_attr_get(a));
1402         }
1403         nl_msg_end_nested(ofp, nested_mask);
1404     }
1405
1406     return ofp->base;
1407 }
1408
1409 /* Appends to 'ds' a string representation of the 'key_len' bytes of
1410  * OVS_KEY_ATTR_* attributes in 'key'. If non-null, additionally formats the
1411  * 'mask_len' bytes of 'mask' which apply to 'key'. If 'portno_names' is
1412  * non-null and 'verbose' is true, translates odp port number to its name. */
1413 void
1414 odp_flow_format(const struct nlattr *key, size_t key_len,
1415                 const struct nlattr *mask, size_t mask_len,
1416                 const struct hmap *portno_names, struct ds *ds, bool verbose)
1417 {
1418     if (key_len) {
1419         const struct nlattr *a;
1420         unsigned int left;
1421         bool has_ethtype_key = false;
1422         const struct nlattr *ma = NULL;
1423         struct ofpbuf ofp;
1424         bool first_field = true;
1425
1426         ofpbuf_init(&ofp, 100);
1427         NL_ATTR_FOR_EACH (a, left, key, key_len) {
1428             bool is_nested_attr;
1429             bool is_wildcard = false;
1430             int attr_type = nl_attr_type(a);
1431
1432             if (attr_type == OVS_KEY_ATTR_ETHERTYPE) {
1433                 has_ethtype_key = true;
1434             }
1435
1436             is_nested_attr = (odp_flow_key_attr_len(attr_type) == -2);
1437
1438             if (mask && mask_len) {
1439                 ma = nl_attr_find__(mask, mask_len, nl_attr_type(a));
1440                 is_wildcard = ma ? odp_mask_attr_is_wildcard(ma) : true;
1441             }
1442
1443             if (verbose || !is_wildcard  || is_nested_attr) {
1444                 if (is_wildcard && !ma) {
1445                     ma = generate_all_wildcard_mask(&ofp, a);
1446                 }
1447                 if (!first_field) {
1448                     ds_put_char(ds, ',');
1449                 }
1450                 format_odp_key_attr(a, ma, portno_names, ds, verbose);
1451                 first_field = false;
1452             }
1453             ofpbuf_clear(&ofp);
1454         }
1455         ofpbuf_uninit(&ofp);
1456
1457         if (left) {
1458             int i;
1459
1460             if (left == key_len) {
1461                 ds_put_cstr(ds, "<empty>");
1462             }
1463             ds_put_format(ds, ",***%u leftover bytes*** (", left);
1464             for (i = 0; i < left; i++) {
1465                 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
1466             }
1467             ds_put_char(ds, ')');
1468         }
1469         if (!has_ethtype_key) {
1470             ma = nl_attr_find__(mask, mask_len, OVS_KEY_ATTR_ETHERTYPE);
1471             if (ma) {
1472                 ds_put_format(ds, ",eth_type(0/0x%04"PRIx16")",
1473                               ntohs(nl_attr_get_be16(ma)));
1474             }
1475         }
1476     } else {
1477         ds_put_cstr(ds, "<empty>");
1478     }
1479 }
1480
1481 /* Appends to 'ds' a string representation of the 'key_len' bytes of
1482  * OVS_KEY_ATTR_* attributes in 'key'. */
1483 void
1484 odp_flow_key_format(const struct nlattr *key,
1485                     size_t key_len, struct ds *ds)
1486 {
1487     odp_flow_format(key, key_len, NULL, 0, NULL, ds, true);
1488 }
1489
1490 static void
1491 put_nd(struct ovs_key_nd* nd_key, const uint8_t *nd_sll,
1492        const uint8_t *nd_tll, struct ofpbuf *key)
1493 {
1494     if (nd_sll) {
1495         memcpy(nd_key->nd_sll, nd_sll, ETH_ADDR_LEN);
1496     }
1497
1498     if (nd_tll) {
1499         memcpy(nd_key->nd_tll, nd_tll, ETH_ADDR_LEN);
1500     }
1501
1502     nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, nd_key, sizeof *nd_key);
1503 }
1504
1505 static int
1506 put_nd_key(int n, const char *nd_target_s, const uint8_t *nd_sll,
1507            const uint8_t *nd_tll, struct ofpbuf *key)
1508 {
1509     struct ovs_key_nd nd_key;
1510
1511     memset(&nd_key, 0, sizeof nd_key);
1512
1513     if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
1514         return -EINVAL;
1515     }
1516
1517     put_nd(&nd_key, nd_sll, nd_tll, key);
1518     return n;
1519 }
1520
1521 static int
1522 put_nd_mask(int n, const char *nd_target_s,
1523            const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *mask)
1524 {
1525     struct ovs_key_nd nd_mask;
1526
1527     memset(&nd_mask, 0xff, sizeof nd_mask);
1528
1529     if (strlen(nd_target_s) != 0 &&
1530             inet_pton(AF_INET6, nd_target_s, nd_mask.nd_target) != 1) {
1531         return -EINVAL;
1532     }
1533
1534     put_nd(&nd_mask, nd_sll, nd_tll, mask);
1535     return n;
1536 }
1537
1538 static bool
1539 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
1540 {
1541     if (!strcasecmp(s, "no")) {
1542         *type = OVS_FRAG_TYPE_NONE;
1543     } else if (!strcasecmp(s, "first")) {
1544         *type = OVS_FRAG_TYPE_FIRST;
1545     } else if (!strcasecmp(s, "later")) {
1546         *type = OVS_FRAG_TYPE_LATER;
1547     } else {
1548         return false;
1549     }
1550     return true;
1551 }
1552
1553 static ovs_be32
1554 mpls_lse_from_components(int mpls_label, int mpls_tc, int mpls_ttl, int mpls_bos)
1555 {
1556     return (htonl((mpls_label << MPLS_LABEL_SHIFT) |
1557                   (mpls_tc << MPLS_TC_SHIFT)       |
1558                   (mpls_ttl << MPLS_TTL_SHIFT)     |
1559                   (mpls_bos << MPLS_BOS_SHIFT)));
1560 }
1561
1562 static int
1563 parse_odp_key_mask_attr(const char *s, const struct simap *port_names,
1564                         struct ofpbuf *key, struct ofpbuf *mask)
1565 {
1566     /* Many of the sscanf calls in this function use oversized destination
1567      * fields because some sscanf() implementations truncate the range of %i
1568      * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
1569      * value of 0x7fff.  The other alternatives are to allow only a single
1570      * radix (e.g. decimal or hexadecimal) or to write more sophisticated
1571      * parsers.
1572      *
1573      * The tun_id parser has to use an alternative approach because there is no
1574      * type larger than 64 bits. */
1575
1576     {
1577         unsigned long long int priority;
1578         unsigned long long int priority_mask;
1579         int n = -1;
1580
1581         if (mask && sscanf(s, "skb_priority(%lli/%lli)%n", &priority,
1582                    &priority_mask, &n) > 0 && n > 0) {
1583             nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
1584             nl_msg_put_u32(mask, OVS_KEY_ATTR_PRIORITY, priority_mask);
1585             return n;
1586         } else if (sscanf(s, "skb_priority(%lli)%n",
1587                           &priority, &n) > 0 && n > 0) {
1588             nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
1589             if (mask) {
1590                 nl_msg_put_u32(mask, OVS_KEY_ATTR_PRIORITY, UINT32_MAX);
1591             }
1592             return n;
1593         }
1594     }
1595
1596     {
1597         unsigned long long int mark;
1598         unsigned long long int mark_mask;
1599         int n = -1;
1600
1601         if (mask && sscanf(s, "skb_mark(%lli/%lli)%n", &mark,
1602                    &mark_mask, &n) > 0 && n > 0) {
1603             nl_msg_put_u32(key, OVS_KEY_ATTR_SKB_MARK, mark);
1604             nl_msg_put_u32(mask, OVS_KEY_ATTR_SKB_MARK, mark_mask);
1605             return n;
1606         } else if (sscanf(s, "skb_mark(%lli)%n", &mark, &n) > 0 && n > 0) {
1607             nl_msg_put_u32(key, OVS_KEY_ATTR_SKB_MARK, mark);
1608             if (mask) {
1609                 nl_msg_put_u32(mask, OVS_KEY_ATTR_SKB_MARK, UINT32_MAX);
1610             }
1611             return n;
1612         }
1613     }
1614
1615     {
1616         char tun_id_s[32];
1617         int tos, tos_mask, ttl, ttl_mask;
1618         struct flow_tnl tun_key, tun_key_mask;
1619         unsigned long long tun_id_mask;
1620         int n = -1;
1621
1622         if (mask && sscanf(s, "tunnel(tun_id=%31[x0123456789abcdefABCDEF]/%llx,"
1623                    "src="IP_SCAN_FMT"/"IP_SCAN_FMT",dst="IP_SCAN_FMT
1624                    "/"IP_SCAN_FMT",tos=%i/%i,ttl=%i/%i,flags%n",
1625                    tun_id_s, &tun_id_mask,
1626                    IP_SCAN_ARGS(&tun_key.ip_src),
1627                    IP_SCAN_ARGS(&tun_key_mask.ip_src),
1628                    IP_SCAN_ARGS(&tun_key.ip_dst),
1629                    IP_SCAN_ARGS(&tun_key_mask.ip_dst),
1630                    &tos, &tos_mask, &ttl, &ttl_mask,
1631                    &n) > 0 && n > 0) {
1632             int res;
1633             uint32_t flags;
1634
1635             tun_key.tun_id = htonll(strtoull(tun_id_s, NULL, 0));
1636             tun_key_mask.tun_id = htonll(tun_id_mask);
1637             tun_key.ip_tos = tos;
1638             tun_key_mask.ip_tos = tos_mask;
1639             tun_key.ip_ttl = ttl;
1640             tun_key_mask.ip_ttl = ttl_mask;
1641             res = parse_flags(&s[n], flow_tun_flag_to_string, &flags);
1642             tun_key.flags = flags;
1643             tun_key_mask.flags = UINT16_MAX;
1644
1645             if (res < 0) {
1646                 return res;
1647             }
1648             n += res;
1649             if (s[n] != ')') {
1650                 return -EINVAL;
1651             }
1652             n++;
1653             tun_key_to_attr(key, &tun_key);
1654             if (mask) {
1655                 tun_key_to_attr(mask, &tun_key_mask);
1656             }
1657             return n;
1658         } else if (sscanf(s, "tunnel(tun_id=%31[x0123456789abcdefABCDEF],"
1659                    "src="IP_SCAN_FMT",dst="IP_SCAN_FMT
1660                    ",tos=%i,ttl=%i,flags%n", tun_id_s,
1661                     IP_SCAN_ARGS(&tun_key.ip_src),
1662                     IP_SCAN_ARGS(&tun_key.ip_dst), &tos, &ttl,
1663                     &n) > 0 && n > 0) {
1664             int res;
1665             uint32_t flags;
1666
1667             tun_key.tun_id = htonll(strtoull(tun_id_s, NULL, 0));
1668             tun_key.ip_tos = tos;
1669             tun_key.ip_ttl = ttl;
1670             res = parse_flags(&s[n], flow_tun_flag_to_string, &flags);
1671             tun_key.flags = flags;
1672
1673             if (res < 0) {
1674                 return res;
1675             }
1676             n += res;
1677             if (s[n] != ')') {
1678                 return -EINVAL;
1679             }
1680             n++;
1681             tun_key_to_attr(key, &tun_key);
1682
1683             if (mask) {
1684                 memset(&tun_key, 0xff, sizeof tun_key);
1685                 tun_key_to_attr(mask, &tun_key);
1686             }
1687             return n;
1688         }
1689     }
1690
1691     {
1692         unsigned long long int in_port;
1693         unsigned long long int in_port_mask;
1694         int n = -1;
1695
1696         if (mask && sscanf(s, "in_port(%lli/%lli)%n", &in_port,
1697                    &in_port_mask, &n) > 0 && n > 0) {
1698             nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
1699             nl_msg_put_u32(mask, OVS_KEY_ATTR_IN_PORT, in_port_mask);
1700             return n;
1701         } else if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
1702             nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
1703             if (mask) {
1704                 nl_msg_put_u32(mask, OVS_KEY_ATTR_IN_PORT, UINT32_MAX);
1705             }
1706             return n;
1707         }
1708     }
1709
1710
1711     if (port_names && !strncmp(s, "in_port(", 8)) {
1712         const char *name;
1713         const struct simap_node *node;
1714         int name_len;
1715
1716         name = s + 8;
1717         name_len = strcspn(name, ")");
1718         node = simap_find_len(port_names, name, name_len);
1719         if (node) {
1720             nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, node->data);
1721
1722             if (mask) {
1723                 nl_msg_put_u32(mask, OVS_KEY_ATTR_IN_PORT, UINT32_MAX);
1724             }
1725             return 8 + name_len + 1;
1726         }
1727     }
1728
1729     {
1730         struct ovs_key_ethernet eth_key;
1731         struct ovs_key_ethernet eth_key_mask;
1732         int n = -1;
1733
1734         if (mask && sscanf(s,
1735                    "eth(src="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT","
1736                         "dst="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
1737                 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
1738                 ETH_ADDR_SCAN_ARGS(eth_key_mask.eth_src),
1739                 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst),
1740                 ETH_ADDR_SCAN_ARGS(eth_key_mask.eth_dst), &n) > 0 && n > 0) {
1741
1742             nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
1743                               &eth_key, sizeof eth_key);
1744             nl_msg_put_unspec(mask, OVS_KEY_ATTR_ETHERNET,
1745                               &eth_key_mask, sizeof eth_key_mask);
1746             return n;
1747         } else if (sscanf(s,
1748                    "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
1749                    ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
1750                    ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
1751             nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
1752                               &eth_key, sizeof eth_key);
1753
1754             if (mask) {
1755                 memset(&eth_key, 0xff, sizeof eth_key);
1756                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ETHERNET,
1757                               &eth_key, sizeof eth_key);
1758             }
1759             return n;
1760         }
1761     }
1762
1763     {
1764         uint16_t vid, vid_mask;
1765         int pcp, pcp_mask;
1766         int cfi, cfi_mask;
1767         int n = -1;
1768
1769         if (mask && (sscanf(s, "vlan(vid=%"SCNi16"/%"SCNi16",pcp=%i/%i)%n",
1770                             &vid, &vid_mask, &pcp, &pcp_mask, &n) > 0 && n > 0)) {
1771             nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1772                             htons((vid << VLAN_VID_SHIFT) |
1773                                   (pcp << VLAN_PCP_SHIFT) |
1774                                   VLAN_CFI));
1775             nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN,
1776                             htons((vid_mask << VLAN_VID_SHIFT) |
1777                                   (pcp_mask << VLAN_PCP_SHIFT) |
1778                                   (1 << VLAN_CFI_SHIFT)));
1779             return n;
1780         } else if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n",
1781                            &vid, &pcp, &n) > 0 && n > 0)) {
1782             nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1783                             htons((vid << VLAN_VID_SHIFT) |
1784                                   (pcp << VLAN_PCP_SHIFT) |
1785                                   VLAN_CFI));
1786             if (mask) {
1787                 nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN, OVS_BE16_MAX);
1788             }
1789             return n;
1790         } else if (mask && (sscanf(s, "vlan(vid=%"SCNi16"/%"SCNi16",pcp=%i/%i,cfi=%i/%i)%n",
1791                                    &vid, &vid_mask, &pcp, &pcp_mask, &cfi, &cfi_mask, &n) > 0 && n > 0)) {
1792             nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1793                             htons((vid << VLAN_VID_SHIFT) |
1794                                   (pcp << VLAN_PCP_SHIFT) |
1795                                   (cfi ? VLAN_CFI : 0)));
1796             nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN,
1797                             htons((vid_mask << VLAN_VID_SHIFT) |
1798                                   (pcp_mask << VLAN_PCP_SHIFT) |
1799                                   (cfi_mask << VLAN_CFI_SHIFT)));
1800             return n;
1801         } else if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i,cfi=%i)%n",
1802                            &vid, &pcp, &cfi, &n) > 0 && n > 0)) {
1803             nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1804                             htons((vid << VLAN_VID_SHIFT) |
1805                                   (pcp << VLAN_PCP_SHIFT) |
1806                                   (cfi ? VLAN_CFI : 0)));
1807             if (mask) {
1808                 nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN, OVS_BE16_MAX);
1809             }
1810             return n;
1811         }
1812     }
1813
1814     {
1815         int eth_type;
1816         int eth_type_mask;
1817         int n = -1;
1818
1819         if (mask && sscanf(s, "eth_type(%i/%i)%n",
1820                    &eth_type, &eth_type_mask, &n) > 0 && n > 0) {
1821             if (eth_type != 0) {
1822                 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
1823             }
1824             nl_msg_put_be16(mask, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type_mask));
1825             return n;
1826         } else if (sscanf(s, "eth_type(%i)%n", &eth_type, &n) > 0 && n > 0) {
1827             nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
1828             if (mask) {
1829                 nl_msg_put_be16(mask, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
1830             }
1831             return n;
1832         }
1833     }
1834
1835     {
1836         int label, tc, ttl, bos;
1837         int label_mask, tc_mask, ttl_mask, bos_mask;
1838         int n = -1;
1839
1840         if (mask && sscanf(s, "mpls(label=%"SCNi32"/%"SCNi32",tc=%i/%i,ttl=%i/%i,bos=%i/%i)%n",
1841                     &label, &label_mask, &tc, &tc_mask, &ttl, &ttl_mask, &bos, &bos_mask, &n) > 0 && n > 0) {
1842             struct ovs_key_mpls *mpls, *mpls_mask;
1843
1844             mpls = nl_msg_put_unspec_uninit(key, OVS_KEY_ATTR_MPLS,
1845                                             sizeof *mpls);
1846             mpls->mpls_lse = mpls_lse_from_components(label, tc, ttl, bos);
1847
1848             mpls_mask = nl_msg_put_unspec_uninit(mask, OVS_KEY_ATTR_MPLS,
1849                                             sizeof *mpls_mask);
1850             mpls_mask->mpls_lse = mpls_lse_from_components(
1851                                   label_mask, tc_mask, ttl_mask, bos_mask);
1852             return n;
1853         } else if (sscanf(s, "mpls(label=%"SCNi32",tc=%i,ttl=%i,bos=%i)%n",
1854                     &label, &tc, &ttl, &bos, &n) > 0 &&
1855                     n > 0) {
1856             struct ovs_key_mpls *mpls;
1857
1858             mpls = nl_msg_put_unspec_uninit(key, OVS_KEY_ATTR_MPLS,
1859                                             sizeof *mpls);
1860             mpls->mpls_lse = mpls_lse_from_components(label, tc, ttl, bos);
1861             if (mask) {
1862                 mpls = nl_msg_put_unspec_uninit(mask, OVS_KEY_ATTR_MPLS,
1863                                             sizeof *mpls);
1864                 mpls->mpls_lse = OVS_BE32_MAX;
1865             }
1866             return n;
1867         }
1868     }
1869
1870
1871     {
1872         ovs_be32 ipv4_src, ipv4_src_mask;
1873         ovs_be32 ipv4_dst, ipv4_dst_mask;
1874         int ipv4_proto, ipv4_proto_mask;
1875         int ipv4_tos, ipv4_tos_mask;
1876         int ipv4_ttl, ipv4_ttl_mask;
1877         char frag[8];
1878         int  ipv4_frag_mask;
1879         enum ovs_frag_type ipv4_frag;
1880         int n = -1;
1881
1882         if (mask && sscanf(s, "ipv4(src="IP_SCAN_FMT"/"IP_SCAN_FMT","
1883                       "dst="IP_SCAN_FMT"/"IP_SCAN_FMT","
1884                       "proto=%i/%i,tos=%i/%i,ttl=%i/%i,"
1885                       "frag=%7[a-z]/%i)%n",
1886                       IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_src_mask),
1887                       IP_SCAN_ARGS(&ipv4_dst), IP_SCAN_ARGS(&ipv4_dst_mask),
1888                       &ipv4_proto, &ipv4_proto_mask,
1889                       &ipv4_tos, &ipv4_tos_mask, &ipv4_ttl, &ipv4_ttl_mask,
1890                       frag, &ipv4_frag_mask, &n) > 0
1891             && n > 0
1892             && ovs_frag_type_from_string(frag, &ipv4_frag)) {
1893             struct ovs_key_ipv4 ipv4_key;
1894             struct ovs_key_ipv4 ipv4_mask;
1895
1896             ipv4_key.ipv4_src = ipv4_src;
1897             ipv4_key.ipv4_dst = ipv4_dst;
1898             ipv4_key.ipv4_proto = ipv4_proto;
1899             ipv4_key.ipv4_tos = ipv4_tos;
1900             ipv4_key.ipv4_ttl = ipv4_ttl;
1901             ipv4_key.ipv4_frag = ipv4_frag;
1902             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
1903                               &ipv4_key, sizeof ipv4_key);
1904
1905             ipv4_mask.ipv4_src = ipv4_src_mask;
1906             ipv4_mask.ipv4_dst = ipv4_dst_mask;
1907             ipv4_mask.ipv4_proto = ipv4_proto_mask;
1908             ipv4_mask.ipv4_tos = ipv4_tos_mask;
1909             ipv4_mask.ipv4_ttl = ipv4_ttl_mask;
1910             ipv4_mask.ipv4_frag = ipv4_frag_mask;
1911             nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV4,
1912                               &ipv4_mask, sizeof ipv4_mask);
1913             return n;
1914         } else if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
1915                    "proto=%i,tos=%i,ttl=%i,frag=%7[a-z])%n",
1916                    IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
1917                    &ipv4_proto, &ipv4_tos, &ipv4_ttl, frag, &n) > 0
1918             && n > 0
1919             && ovs_frag_type_from_string(frag, &ipv4_frag)) {
1920             struct ovs_key_ipv4 ipv4_key;
1921
1922             ipv4_key.ipv4_src = ipv4_src;
1923             ipv4_key.ipv4_dst = ipv4_dst;
1924             ipv4_key.ipv4_proto = ipv4_proto;
1925             ipv4_key.ipv4_tos = ipv4_tos;
1926             ipv4_key.ipv4_ttl = ipv4_ttl;
1927             ipv4_key.ipv4_frag = ipv4_frag;
1928             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
1929                               &ipv4_key, sizeof ipv4_key);
1930
1931             if (mask) {
1932                 memset(&ipv4_key, 0xff, sizeof ipv4_key);
1933                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV4,
1934                               &ipv4_key, sizeof ipv4_key);
1935             }
1936             return n;
1937         }
1938     }
1939
1940     {
1941         char ipv6_src_s[IPV6_SCAN_LEN + 1];
1942         char ipv6_src_mask_s[IPV6_SCAN_LEN + 1];
1943         char ipv6_dst_s[IPV6_SCAN_LEN + 1];
1944         char ipv6_dst_mask_s[IPV6_SCAN_LEN + 1];
1945         int ipv6_label, ipv6_label_mask;
1946         int ipv6_proto, ipv6_proto_mask;
1947         int ipv6_tclass, ipv6_tclass_mask;
1948         int ipv6_hlimit, ipv6_hlimit_mask;
1949         char frag[8];
1950         enum ovs_frag_type ipv6_frag;
1951         int ipv6_frag_mask;
1952         int n = -1;
1953
1954         if (mask && sscanf(s, "ipv6(src="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT",dst="
1955                    IPV6_SCAN_FMT"/"IPV6_SCAN_FMT","
1956                    "label=%i/%i,proto=%i/%i,tclass=%i/%i,"
1957                    "hlimit=%i/%i,frag=%7[a-z]/%i)%n",
1958                    ipv6_src_s, ipv6_src_mask_s, ipv6_dst_s, ipv6_dst_mask_s,
1959                    &ipv6_label, &ipv6_label_mask, &ipv6_proto,
1960                    &ipv6_proto_mask, &ipv6_tclass, &ipv6_tclass_mask,
1961                    &ipv6_hlimit, &ipv6_hlimit_mask, frag,
1962                    &ipv6_frag_mask, &n) > 0
1963             && n > 0
1964             && ovs_frag_type_from_string(frag, &ipv6_frag)) {
1965             struct ovs_key_ipv6 ipv6_key;
1966             struct ovs_key_ipv6 ipv6_mask;
1967
1968             if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
1969                 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1 ||
1970                 inet_pton(AF_INET6, ipv6_src_mask_s, &ipv6_mask.ipv6_src) != 1 ||
1971                 inet_pton(AF_INET6, ipv6_dst_mask_s, &ipv6_mask.ipv6_dst) != 1) {
1972                 return -EINVAL;
1973             }
1974
1975             ipv6_key.ipv6_label = htonl(ipv6_label);
1976             ipv6_key.ipv6_proto = ipv6_proto;
1977             ipv6_key.ipv6_tclass = ipv6_tclass;
1978             ipv6_key.ipv6_hlimit = ipv6_hlimit;
1979             ipv6_key.ipv6_frag = ipv6_frag;
1980             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
1981                               &ipv6_key, sizeof ipv6_key);
1982
1983             ipv6_mask.ipv6_label = htonl(ipv6_label_mask);
1984             ipv6_mask.ipv6_proto = ipv6_proto_mask;
1985             ipv6_mask.ipv6_tclass = ipv6_tclass_mask;
1986             ipv6_mask.ipv6_hlimit = ipv6_hlimit_mask;
1987             ipv6_mask.ipv6_frag = ipv6_frag_mask;
1988             nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV6,
1989                               &ipv6_mask, sizeof ipv6_mask);
1990             return n;
1991         } else if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
1992                    "label=%i,proto=%i,tclass=%i,hlimit=%i,frag=%7[a-z])%n",
1993                    ipv6_src_s, ipv6_dst_s, &ipv6_label,
1994                    &ipv6_proto, &ipv6_tclass, &ipv6_hlimit, frag, &n) > 0
1995             && n > 0
1996             && ovs_frag_type_from_string(frag, &ipv6_frag)) {
1997             struct ovs_key_ipv6 ipv6_key;
1998
1999             if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
2000                 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
2001                 return -EINVAL;
2002             }
2003             ipv6_key.ipv6_label = htonl(ipv6_label);
2004             ipv6_key.ipv6_proto = ipv6_proto;
2005             ipv6_key.ipv6_tclass = ipv6_tclass;
2006             ipv6_key.ipv6_hlimit = ipv6_hlimit;
2007             ipv6_key.ipv6_frag = ipv6_frag;
2008             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
2009                               &ipv6_key, sizeof ipv6_key);
2010
2011             if (mask) {
2012                 memset(&ipv6_key, 0xff, sizeof ipv6_key);
2013                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV6,
2014                               &ipv6_key, sizeof ipv6_key);
2015             }
2016             return n;
2017         }
2018     }
2019
2020     {
2021         int tcp_src;
2022         int tcp_dst;
2023         int tcp_src_mask;
2024         int tcp_dst_mask;
2025         int n = -1;
2026
2027         if (mask && sscanf(s, "tcp(src=%i/%i,dst=%i/%i)%n",
2028                    &tcp_src, &tcp_src_mask, &tcp_dst, &tcp_dst_mask, &n) > 0
2029             && n > 0) {
2030             struct ovs_key_tcp tcp_key;
2031             struct ovs_key_tcp tcp_mask;
2032
2033             tcp_key.tcp_src = htons(tcp_src);
2034             tcp_key.tcp_dst = htons(tcp_dst);
2035             nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
2036
2037             tcp_mask.tcp_src = htons(tcp_src_mask);
2038             tcp_mask.tcp_dst = htons(tcp_dst_mask);
2039             nl_msg_put_unspec(mask, OVS_KEY_ATTR_TCP,
2040                               &tcp_mask, sizeof tcp_mask);
2041             return n;
2042         } else if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
2043             && n > 0) {
2044             struct ovs_key_tcp tcp_key;
2045
2046             tcp_key.tcp_src = htons(tcp_src);
2047             tcp_key.tcp_dst = htons(tcp_dst);
2048             nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
2049
2050             if (mask) {
2051                 memset(&tcp_key, 0xff, sizeof tcp_key);
2052                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_TCP,
2053                               &tcp_key, sizeof tcp_key);
2054             }
2055             return n;
2056         }
2057     }
2058
2059     {
2060         uint16_t tcp_flags, tcp_flags_mask;
2061         int n = -1;
2062
2063         if (mask && sscanf(s, "tcp_flags(%"SCNi16"/%"SCNi16")%n",
2064                    &tcp_flags, &tcp_flags_mask, &n) > 0 && n > 0) {
2065             nl_msg_put_be16(key, OVS_KEY_ATTR_TCP_FLAGS, htons(tcp_flags));
2066             nl_msg_put_be16(mask, OVS_KEY_ATTR_TCP_FLAGS, htons(tcp_flags_mask));
2067             return n;
2068         } else if (sscanf(s, "tcp_flags(%"SCNi16")%n", &tcp_flags, &n) > 0 && n > 0) {
2069             nl_msg_put_be16(key, OVS_KEY_ATTR_TCP_FLAGS, htons(tcp_flags));
2070             if (mask) {
2071                 nl_msg_put_be16(mask, OVS_KEY_ATTR_TCP_FLAGS,
2072                                 htons(UINT16_MAX));
2073             }
2074             return n;
2075         }
2076     }
2077
2078     {
2079         int udp_src;
2080         int udp_dst;
2081         int udp_src_mask;
2082         int udp_dst_mask;
2083         int n = -1;
2084
2085         if (mask && sscanf(s, "udp(src=%i/%i,dst=%i/%i)%n",
2086                    &udp_src, &udp_src_mask,
2087                    &udp_dst, &udp_dst_mask, &n) > 0 && n > 0) {
2088             struct ovs_key_udp udp_key;
2089             struct ovs_key_udp udp_mask;
2090
2091             udp_key.udp_src = htons(udp_src);
2092             udp_key.udp_dst = htons(udp_dst);
2093             nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
2094
2095             udp_mask.udp_src = htons(udp_src_mask);
2096             udp_mask.udp_dst = htons(udp_dst_mask);
2097             nl_msg_put_unspec(mask, OVS_KEY_ATTR_UDP,
2098                               &udp_mask, sizeof udp_mask);
2099             return n;
2100         }
2101         if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
2102             && n > 0) {
2103             struct ovs_key_udp udp_key;
2104
2105             udp_key.udp_src = htons(udp_src);
2106             udp_key.udp_dst = htons(udp_dst);
2107             nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
2108
2109             if (mask) {
2110                 memset(&udp_key, 0xff, sizeof udp_key);
2111                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
2112             }
2113             return n;
2114         }
2115     }
2116
2117     {
2118         int sctp_src;
2119         int sctp_dst;
2120         int sctp_src_mask;
2121         int sctp_dst_mask;
2122         int n = -1;
2123
2124         if (mask && sscanf(s, "sctp(src=%i/%i,dst=%i/%i)%n",
2125                    &sctp_src, &sctp_src_mask,
2126                    &sctp_dst, &sctp_dst_mask, &n) > 0 && n > 0) {
2127             struct ovs_key_sctp sctp_key;
2128             struct ovs_key_sctp sctp_mask;
2129
2130             sctp_key.sctp_src = htons(sctp_src);
2131             sctp_key.sctp_dst = htons(sctp_dst);
2132             nl_msg_put_unspec(key, OVS_KEY_ATTR_SCTP, &sctp_key, sizeof sctp_key);
2133
2134             sctp_mask.sctp_src = htons(sctp_src_mask);
2135             sctp_mask.sctp_dst = htons(sctp_dst_mask);
2136             nl_msg_put_unspec(mask, OVS_KEY_ATTR_SCTP,
2137                               &sctp_mask, sizeof sctp_mask);
2138             return n;
2139         }
2140         if (sscanf(s, "sctp(src=%i,dst=%i)%n", &sctp_src, &sctp_dst, &n) > 0
2141             && n > 0) {
2142             struct ovs_key_sctp sctp_key;
2143
2144             sctp_key.sctp_src = htons(sctp_src);
2145             sctp_key.sctp_dst = htons(sctp_dst);
2146             nl_msg_put_unspec(key, OVS_KEY_ATTR_SCTP, &sctp_key, sizeof sctp_key);
2147
2148             if (mask) {
2149                 memset(&sctp_key, 0xff, sizeof sctp_key);
2150                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_SCTP, &sctp_key, sizeof sctp_key);
2151             }
2152             return n;
2153         }
2154     }
2155
2156     {
2157         int icmp_type;
2158         int icmp_code;
2159         int icmp_type_mask;
2160         int icmp_code_mask;
2161         int n = -1;
2162
2163         if (mask && sscanf(s, "icmp(type=%i/%i,code=%i/%i)%n",
2164                    &icmp_type, &icmp_type_mask,
2165                    &icmp_code, &icmp_code_mask, &n) > 0 && n > 0) {
2166             struct ovs_key_icmp icmp_key;
2167             struct ovs_key_icmp icmp_mask;
2168
2169             icmp_key.icmp_type = icmp_type;
2170             icmp_key.icmp_code = icmp_code;
2171             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
2172                               &icmp_key, sizeof icmp_key);
2173
2174             icmp_mask.icmp_type = icmp_type_mask;
2175             icmp_mask.icmp_code = icmp_code_mask;
2176             nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMP,
2177                               &icmp_mask, sizeof icmp_mask);
2178             return n;
2179         } else if (sscanf(s, "icmp(type=%i,code=%i)%n",
2180                    &icmp_type, &icmp_code, &n) > 0
2181             && n > 0) {
2182             struct ovs_key_icmp icmp_key;
2183
2184             icmp_key.icmp_type = icmp_type;
2185             icmp_key.icmp_code = icmp_code;
2186             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
2187                               &icmp_key, sizeof icmp_key);
2188             if (mask) {
2189                 memset(&icmp_key, 0xff, sizeof icmp_key);
2190                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMP, &icmp_key,
2191                               sizeof icmp_key);
2192             }
2193             return n;
2194         }
2195     }
2196
2197     {
2198         struct ovs_key_icmpv6 icmpv6_key;
2199         struct ovs_key_icmpv6 icmpv6_mask;
2200         int icmpv6_type_mask;
2201         int icmpv6_code_mask;
2202         int n = -1;
2203
2204         if (mask && sscanf(s, "icmpv6(type=%"SCNi8"/%i,code=%"SCNi8"/%i)%n",
2205                    &icmpv6_key.icmpv6_type, &icmpv6_type_mask,
2206                    &icmpv6_key.icmpv6_code, &icmpv6_code_mask, &n) > 0
2207             && n > 0) {
2208             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
2209                               &icmpv6_key, sizeof icmpv6_key);
2210
2211             icmpv6_mask.icmpv6_type = icmpv6_type_mask;
2212             icmpv6_mask.icmpv6_code = icmpv6_code_mask;
2213             nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMPV6, &icmpv6_mask,
2214                               sizeof icmpv6_mask);
2215             return n;
2216         } else if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
2217                    &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
2218             && n > 0) {
2219             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
2220                               &icmpv6_key, sizeof icmpv6_key);
2221
2222             if (mask) {
2223                 memset(&icmpv6_key, 0xff, sizeof icmpv6_key);
2224                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMPV6, &icmpv6_key,
2225                               sizeof icmpv6_key);
2226             }
2227             return n;
2228         }
2229     }
2230
2231     {
2232         ovs_be32 arp_sip, arp_sip_mask;
2233         ovs_be32 arp_tip, arp_tip_mask;
2234         int arp_op, arp_op_mask;
2235         uint8_t arp_sha[ETH_ADDR_LEN];
2236         uint8_t arp_sha_mask[ETH_ADDR_LEN];
2237         uint8_t arp_tha[ETH_ADDR_LEN];
2238         uint8_t arp_tha_mask[ETH_ADDR_LEN];
2239         int n = -1;
2240
2241         if (mask && sscanf(s, "arp(sip="IP_SCAN_FMT"/"IP_SCAN_FMT","
2242                    "tip="IP_SCAN_FMT"/"IP_SCAN_FMT","
2243                    "op=%i/%i,sha="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT","
2244                    "tha="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2245                    IP_SCAN_ARGS(&arp_sip), IP_SCAN_ARGS(&arp_sip_mask),
2246                    IP_SCAN_ARGS(&arp_tip), IP_SCAN_ARGS(&arp_tip_mask),
2247                    &arp_op, &arp_op_mask,
2248                    ETH_ADDR_SCAN_ARGS(arp_sha),
2249                    ETH_ADDR_SCAN_ARGS(arp_sha_mask),
2250                    ETH_ADDR_SCAN_ARGS(arp_tha),
2251                    ETH_ADDR_SCAN_ARGS(arp_tha_mask), &n) > 0 && n > 0) {
2252             struct ovs_key_arp arp_key;
2253             struct ovs_key_arp arp_mask;
2254
2255             memset(&arp_key, 0, sizeof arp_key);
2256             arp_key.arp_sip = arp_sip;
2257             arp_key.arp_tip = arp_tip;
2258             arp_key.arp_op = htons(arp_op);
2259             memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
2260             memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
2261             nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
2262
2263             arp_mask.arp_sip = arp_sip_mask;
2264             arp_mask.arp_tip = arp_tip_mask;
2265             arp_mask.arp_op = htons(arp_op_mask);
2266             memcpy(arp_mask.arp_sha, arp_sha_mask, ETH_ADDR_LEN);
2267             memcpy(arp_mask.arp_tha, arp_tha_mask, ETH_ADDR_LEN);
2268             nl_msg_put_unspec(mask, OVS_KEY_ATTR_ARP,
2269                               &arp_mask, sizeof arp_mask);
2270             return n;
2271         } else if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
2272                    "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
2273                    IP_SCAN_ARGS(&arp_sip),
2274                    IP_SCAN_ARGS(&arp_tip),
2275                    &arp_op,
2276                    ETH_ADDR_SCAN_ARGS(arp_sha),
2277                    ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
2278             struct ovs_key_arp arp_key;
2279
2280             memset(&arp_key, 0, sizeof arp_key);
2281             arp_key.arp_sip = arp_sip;
2282             arp_key.arp_tip = arp_tip;
2283             arp_key.arp_op = htons(arp_op);
2284             memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
2285             memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
2286             nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
2287
2288             if (mask) {
2289                 memset(&arp_key, 0xff, sizeof arp_key);
2290                 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ARP,
2291                                   &arp_key, sizeof arp_key);
2292             }
2293             return n;
2294         }
2295     }
2296
2297     {
2298         char nd_target_s[IPV6_SCAN_LEN + 1];
2299         char nd_target_mask_s[IPV6_SCAN_LEN + 1];
2300         uint8_t nd_sll[ETH_ADDR_LEN];
2301         uint8_t nd_sll_mask[ETH_ADDR_LEN];
2302         uint8_t nd_tll[ETH_ADDR_LEN];
2303         uint8_t nd_tll_mask[ETH_ADDR_LEN];
2304         int n = -1;
2305
2306         nd_target_mask_s[0] = 0;
2307         memset(nd_sll_mask, 0xff, sizeof nd_sll_mask);
2308         memset(nd_tll_mask, 0xff, sizeof nd_tll_mask);
2309
2310         if (mask && sscanf(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT")%n",
2311                    nd_target_s, nd_target_mask_s, &n) > 0 && n > 0) {
2312                 put_nd_key(n, nd_target_s, NULL, NULL, key);
2313                 put_nd_mask(n, nd_target_mask_s, NULL, NULL, mask);
2314         } else if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
2315                    nd_target_s, &n) > 0 && n > 0) {
2316                 put_nd_key(n, nd_target_s, NULL, NULL, key);
2317                 if (mask) {
2318                     put_nd_mask(n, nd_target_mask_s, NULL, NULL, mask);
2319                 }
2320         } else if (mask && sscanf(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT
2321                          ",sll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2322                    nd_target_s, nd_target_mask_s,
2323                    ETH_ADDR_SCAN_ARGS(nd_sll),
2324                    ETH_ADDR_SCAN_ARGS(nd_sll_mask), &n) > 0 && n > 0) {
2325             put_nd_key(n, nd_target_s, nd_sll, NULL, key);
2326             put_nd_mask(n, nd_target_mask_s, nd_sll_mask, NULL, mask);
2327         } else if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
2328                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
2329             && n > 0) {
2330             put_nd_key(n, nd_target_s, nd_sll, NULL, key);
2331             if (mask) {
2332                 put_nd_mask(n, nd_target_mask_s, nd_sll_mask, NULL, mask);
2333             }
2334         } else if (mask && sscanf(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT
2335                          ",tll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2336                    nd_target_s, nd_target_mask_s,
2337                    ETH_ADDR_SCAN_ARGS(nd_tll),
2338                    ETH_ADDR_SCAN_ARGS(nd_tll_mask), &n) > 0 && n > 0) {
2339             put_nd_key(n, nd_target_s, NULL, nd_tll, key);
2340             put_nd_mask(n, nd_target_mask_s, NULL, nd_tll_mask, mask);
2341         } else if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
2342                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
2343             && n > 0) {
2344             put_nd_key(n, nd_target_s, NULL, nd_tll, key);
2345             if (mask) {
2346                 put_nd_mask(n, nd_target_mask_s, NULL, nd_tll_mask, mask);
2347             }
2348         } else if (mask && sscanf(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT
2349                    ",sll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT","
2350                    "tll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2351                    nd_target_s, nd_target_mask_s,
2352                    ETH_ADDR_SCAN_ARGS(nd_sll), ETH_ADDR_SCAN_ARGS(nd_sll_mask),
2353                    ETH_ADDR_SCAN_ARGS(nd_tll), ETH_ADDR_SCAN_ARGS(nd_tll_mask),
2354                    &n) > 0
2355             && n > 0) {
2356             put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
2357             put_nd_mask(n, nd_target_mask_s, nd_sll_mask, nd_tll_mask, mask);
2358         } else if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
2359                    "tll="ETH_ADDR_SCAN_FMT")%n",
2360                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
2361                    ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
2362             && n > 0) {
2363             put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
2364             if (mask) {
2365                 put_nd_mask(n, nd_target_mask_s,
2366                             nd_sll_mask, nd_tll_mask, mask);
2367             }
2368         }
2369
2370         if (n != -1)
2371             return n;
2372
2373     }
2374
2375     if (!strncmp(s, "encap(", 6)) {
2376         const char *start = s;
2377         size_t encap, encap_mask = 0;
2378
2379         encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
2380         if (mask) {
2381             encap_mask = nl_msg_start_nested(mask, OVS_KEY_ATTR_ENCAP);
2382         }
2383
2384         s += 6;
2385         for (;;) {
2386             int retval;
2387
2388             s += strspn(s, ", \t\r\n");
2389             if (!*s) {
2390                 return -EINVAL;
2391             } else if (*s == ')') {
2392                 break;
2393             }
2394
2395             retval = parse_odp_key_mask_attr(s, port_names, key, mask);
2396             if (retval < 0) {
2397                 return retval;
2398             }
2399             s += retval;
2400         }
2401         s++;
2402
2403         nl_msg_end_nested(key, encap);
2404         if (mask) {
2405             nl_msg_end_nested(mask, encap_mask);
2406         }
2407
2408         return s - start;
2409     }
2410
2411     return -EINVAL;
2412 }
2413
2414 /* Parses the string representation of a datapath flow key, in the
2415  * format output by odp_flow_key_format().  Returns 0 if successful,
2416  * otherwise a positive errno value.  On success, the flow key is
2417  * appended to 'key' as a series of Netlink attributes.  On failure, no
2418  * data is appended to 'key'.  Either way, 'key''s data might be
2419  * reallocated.
2420  *
2421  * If 'port_names' is nonnull, it points to an simap that maps from a port name
2422  * to a port number.  (Port names may be used instead of port numbers in
2423  * in_port.)
2424  *
2425  * On success, the attributes appended to 'key' are individually syntactically
2426  * valid, but they may not be valid as a sequence.  'key' might, for example,
2427  * have duplicated keys.  odp_flow_key_to_flow() will detect those errors. */
2428 int
2429 odp_flow_from_string(const char *s, const struct simap *port_names,
2430                      struct ofpbuf *key, struct ofpbuf *mask)
2431 {
2432     const size_t old_size = key->size;
2433     for (;;) {
2434         int retval;
2435
2436         s += strspn(s, delimiters);
2437         if (!*s) {
2438             return 0;
2439         }
2440
2441         retval = parse_odp_key_mask_attr(s, port_names, key, mask);
2442         if (retval < 0) {
2443             key->size = old_size;
2444             return -retval;
2445         }
2446         s += retval;
2447     }
2448
2449     return 0;
2450 }
2451
2452 static uint8_t
2453 ovs_to_odp_frag(uint8_t nw_frag)
2454 {
2455     return (nw_frag == 0 ? OVS_FRAG_TYPE_NONE
2456           : nw_frag == FLOW_NW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
2457           : OVS_FRAG_TYPE_LATER);
2458 }
2459
2460 static uint8_t
2461 ovs_to_odp_frag_mask(uint8_t nw_frag_mask)
2462 {
2463     uint8_t frag_mask = ~(OVS_FRAG_TYPE_FIRST | OVS_FRAG_TYPE_LATER);
2464
2465     frag_mask |= (nw_frag_mask & FLOW_NW_FRAG_ANY) ? OVS_FRAG_TYPE_FIRST : 0;
2466     frag_mask |= (nw_frag_mask & FLOW_NW_FRAG_LATER) ? OVS_FRAG_TYPE_LATER : 0;
2467
2468     return frag_mask;
2469 }
2470
2471 static void
2472 odp_flow_key_from_flow__(struct ofpbuf *buf, const struct flow *data,
2473                          const struct flow *flow, odp_port_t odp_in_port)
2474 {
2475     bool is_mask;
2476     struct ovs_key_ethernet *eth_key;
2477     size_t encap;
2478
2479     /* We assume that if 'data' and 'flow' are not the same, we should
2480      * treat 'data' as a mask. */
2481     is_mask = (data != flow);
2482
2483     nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, data->skb_priority);
2484
2485     if (flow->tunnel.ip_dst || is_mask) {
2486         tun_key_to_attr(buf, &data->tunnel);
2487     }
2488
2489     nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, data->pkt_mark);
2490
2491     /* Add an ingress port attribute if this is a mask or 'odp_in_port'
2492      * is not the magical value "ODPP_NONE". */
2493     if (is_mask || odp_in_port != ODPP_NONE) {
2494         nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, odp_in_port);
2495     }
2496
2497     eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
2498                                        sizeof *eth_key);
2499     memcpy(eth_key->eth_src, data->dl_src, ETH_ADDR_LEN);
2500     memcpy(eth_key->eth_dst, data->dl_dst, ETH_ADDR_LEN);
2501
2502     if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
2503         if (is_mask) {
2504             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
2505         } else {
2506             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
2507         }
2508         nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, data->vlan_tci);
2509         encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
2510         if (flow->vlan_tci == htons(0)) {
2511             goto unencap;
2512         }
2513     } else {
2514         encap = 0;
2515     }
2516
2517     if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
2518         /* For backwards compatibility with kernels that don't support
2519          * wildcarding, the following convention is used to encode the
2520          * OVS_KEY_ATTR_ETHERTYPE for key and mask:
2521          *
2522          *   key      mask    matches
2523          * -------- --------  -------
2524          *  >0x5ff   0xffff   Specified Ethernet II Ethertype.
2525          *  >0x5ff      0     Any Ethernet II or non-Ethernet II frame.
2526          *  <none>   0xffff   Any non-Ethernet II frame (except valid
2527          *                    802.3 SNAP packet with valid eth_type).
2528          */
2529         if (is_mask) {
2530             nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
2531         }
2532         goto unencap;
2533     }
2534
2535     nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, data->dl_type);
2536
2537     if (flow->dl_type == htons(ETH_TYPE_IP)) {
2538         struct ovs_key_ipv4 *ipv4_key;
2539
2540         ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
2541                                             sizeof *ipv4_key);
2542         ipv4_key->ipv4_src = data->nw_src;
2543         ipv4_key->ipv4_dst = data->nw_dst;
2544         ipv4_key->ipv4_proto = data->nw_proto;
2545         ipv4_key->ipv4_tos = data->nw_tos;
2546         ipv4_key->ipv4_ttl = data->nw_ttl;
2547         ipv4_key->ipv4_frag = is_mask ? ovs_to_odp_frag_mask(data->nw_frag)
2548                                       : ovs_to_odp_frag(data->nw_frag);
2549     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
2550         struct ovs_key_ipv6 *ipv6_key;
2551
2552         ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
2553                                             sizeof *ipv6_key);
2554         memcpy(ipv6_key->ipv6_src, &data->ipv6_src, sizeof ipv6_key->ipv6_src);
2555         memcpy(ipv6_key->ipv6_dst, &data->ipv6_dst, sizeof ipv6_key->ipv6_dst);
2556         ipv6_key->ipv6_label = data->ipv6_label;
2557         ipv6_key->ipv6_proto = data->nw_proto;
2558         ipv6_key->ipv6_tclass = data->nw_tos;
2559         ipv6_key->ipv6_hlimit = data->nw_ttl;
2560         ipv6_key->ipv6_frag = is_mask ? ovs_to_odp_frag_mask(data->nw_frag)
2561                                       : ovs_to_odp_frag(data->nw_frag);
2562     } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
2563                flow->dl_type == htons(ETH_TYPE_RARP)) {
2564         struct ovs_key_arp *arp_key;
2565
2566         arp_key = nl_msg_put_unspec_zero(buf, OVS_KEY_ATTR_ARP,
2567                                          sizeof *arp_key);
2568         arp_key->arp_sip = data->nw_src;
2569         arp_key->arp_tip = data->nw_dst;
2570         arp_key->arp_op = htons(data->nw_proto);
2571         memcpy(arp_key->arp_sha, data->arp_sha, ETH_ADDR_LEN);
2572         memcpy(arp_key->arp_tha, data->arp_tha, ETH_ADDR_LEN);
2573     } else if (eth_type_mpls(flow->dl_type)) {
2574         struct ovs_key_mpls *mpls_key;
2575
2576         mpls_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_MPLS,
2577                                             sizeof *mpls_key);
2578         mpls_key->mpls_lse = data->mpls_lse;
2579     }
2580
2581     if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2582         if (flow->nw_proto == IPPROTO_TCP) {
2583             struct ovs_key_tcp *tcp_key;
2584
2585             tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
2586                                                sizeof *tcp_key);
2587             tcp_key->tcp_src = data->tp_src;
2588             tcp_key->tcp_dst = data->tp_dst;
2589
2590             if (data->tcp_flags) {
2591                 nl_msg_put_be16(buf, OVS_KEY_ATTR_TCP_FLAGS, data->tcp_flags);
2592             }
2593         } else if (flow->nw_proto == IPPROTO_UDP) {
2594             struct ovs_key_udp *udp_key;
2595
2596             udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
2597                                                sizeof *udp_key);
2598             udp_key->udp_src = data->tp_src;
2599             udp_key->udp_dst = data->tp_dst;
2600         } else if (flow->nw_proto == IPPROTO_SCTP) {
2601             struct ovs_key_sctp *sctp_key;
2602
2603             sctp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_SCTP,
2604                                                sizeof *sctp_key);
2605             sctp_key->sctp_src = data->tp_src;
2606             sctp_key->sctp_dst = data->tp_dst;
2607         } else if (flow->dl_type == htons(ETH_TYPE_IP)
2608                 && flow->nw_proto == IPPROTO_ICMP) {
2609             struct ovs_key_icmp *icmp_key;
2610
2611             icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
2612                                                 sizeof *icmp_key);
2613             icmp_key->icmp_type = ntohs(data->tp_src);
2614             icmp_key->icmp_code = ntohs(data->tp_dst);
2615         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
2616                 && flow->nw_proto == IPPROTO_ICMPV6) {
2617             struct ovs_key_icmpv6 *icmpv6_key;
2618
2619             icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
2620                                                   sizeof *icmpv6_key);
2621             icmpv6_key->icmpv6_type = ntohs(data->tp_src);
2622             icmpv6_key->icmpv6_code = ntohs(data->tp_dst);
2623
2624             if (flow->tp_dst == htons(0) &&
2625                 (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
2626                  flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) &&
2627                 (!is_mask || (data->tp_src == htons(0xffff) &&
2628                               data->tp_dst == htons(0xffff)))) {
2629
2630                 struct ovs_key_nd *nd_key;
2631
2632                 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
2633                                                     sizeof *nd_key);
2634                 memcpy(nd_key->nd_target, &data->nd_target,
2635                         sizeof nd_key->nd_target);
2636                 memcpy(nd_key->nd_sll, data->arp_sha, ETH_ADDR_LEN);
2637                 memcpy(nd_key->nd_tll, data->arp_tha, ETH_ADDR_LEN);
2638             }
2639         }
2640     }
2641
2642 unencap:
2643     if (encap) {
2644         nl_msg_end_nested(buf, encap);
2645     }
2646 }
2647
2648 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'.
2649  * 'flow->in_port' is ignored (since it is likely to be an OpenFlow port
2650  * number rather than a datapath port number).  Instead, if 'odp_in_port'
2651  * is anything other than ODPP_NONE, it is included in 'buf' as the input
2652  * port.
2653  *
2654  * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
2655  * capable of being expanded to allow for that much space. */
2656 void
2657 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow,
2658                        odp_port_t odp_in_port)
2659 {
2660     odp_flow_key_from_flow__(buf, flow, flow, odp_in_port);
2661 }
2662
2663 /* Appends a representation of 'mask' as OVS_KEY_ATTR_* attributes to
2664  * 'buf'.  'flow' is used as a template to determine how to interpret
2665  * 'mask'.  For example, the 'dl_type' of 'mask' describes the mask, but
2666  * it doesn't indicate whether the other fields should be interpreted as
2667  * ARP, IPv4, IPv6, etc.
2668  *
2669  * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
2670  * capable of being expanded to allow for that much space. */
2671 void
2672 odp_flow_key_from_mask(struct ofpbuf *buf, const struct flow *mask,
2673                        const struct flow *flow, uint32_t odp_in_port_mask)
2674 {
2675     odp_flow_key_from_flow__(buf, mask, flow, u32_to_odp(odp_in_port_mask));
2676 }
2677
2678 uint32_t
2679 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
2680 {
2681     BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
2682     return hash_words(ALIGNED_CAST(const uint32_t *, key),
2683                       key_len / sizeof(uint32_t), 0);
2684 }
2685
2686 static void
2687 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
2688                        uint64_t attrs, int out_of_range_attr,
2689                        const struct nlattr *key, size_t key_len)
2690 {
2691     struct ds s;
2692     int i;
2693
2694     if (VLOG_DROP_DBG(rl)) {
2695         return;
2696     }
2697
2698     ds_init(&s);
2699     for (i = 0; i < 64; i++) {
2700         if (attrs & (UINT64_C(1) << i)) {
2701             char namebuf[OVS_KEY_ATTR_BUFSIZE];
2702
2703             ds_put_format(&s, " %s",
2704                           ovs_key_attr_to_string(i, namebuf, sizeof namebuf));
2705         }
2706     }
2707     if (out_of_range_attr) {
2708         ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
2709     }
2710
2711     ds_put_cstr(&s, ": ");
2712     odp_flow_key_format(key, key_len, &s);
2713
2714     VLOG_DBG("%s:%s", title, ds_cstr(&s));
2715     ds_destroy(&s);
2716 }
2717
2718 static bool
2719 odp_to_ovs_frag(uint8_t odp_frag, struct flow *flow)
2720 {
2721     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2722
2723     if (odp_frag > OVS_FRAG_TYPE_LATER) {
2724         VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
2725         return false;
2726     }
2727
2728     if (odp_frag != OVS_FRAG_TYPE_NONE) {
2729         flow->nw_frag |= FLOW_NW_FRAG_ANY;
2730         if (odp_frag == OVS_FRAG_TYPE_LATER) {
2731             flow->nw_frag |= FLOW_NW_FRAG_LATER;
2732         }
2733     }
2734     return true;
2735 }
2736
2737 static bool
2738 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
2739                    const struct nlattr *attrs[], uint64_t *present_attrsp,
2740                    int *out_of_range_attrp)
2741 {
2742     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
2743     const struct nlattr *nla;
2744     uint64_t present_attrs;
2745     size_t left;
2746
2747     BUILD_ASSERT(OVS_KEY_ATTR_MAX < CHAR_BIT * sizeof present_attrs);
2748     present_attrs = 0;
2749     *out_of_range_attrp = 0;
2750     NL_ATTR_FOR_EACH (nla, left, key, key_len) {
2751         uint16_t type = nl_attr_type(nla);
2752         size_t len = nl_attr_get_size(nla);
2753         int expected_len = odp_flow_key_attr_len(type);
2754
2755         if (len != expected_len && expected_len >= 0) {
2756             char namebuf[OVS_KEY_ATTR_BUFSIZE];
2757
2758             VLOG_ERR_RL(&rl, "attribute %s has length %zu but should have "
2759                         "length %d", ovs_key_attr_to_string(type, namebuf,
2760                                                             sizeof namebuf),
2761                         len, expected_len);
2762             return false;
2763         }
2764
2765         if (type > OVS_KEY_ATTR_MAX) {
2766             *out_of_range_attrp = type;
2767         } else {
2768             if (present_attrs & (UINT64_C(1) << type)) {
2769                 char namebuf[OVS_KEY_ATTR_BUFSIZE];
2770
2771                 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
2772                             ovs_key_attr_to_string(type,
2773                                                    namebuf, sizeof namebuf));
2774                 return false;
2775             }
2776
2777             present_attrs |= UINT64_C(1) << type;
2778             attrs[type] = nla;
2779         }
2780     }
2781     if (left) {
2782         VLOG_ERR_RL(&rl, "trailing garbage in flow key");
2783         return false;
2784     }
2785
2786     *present_attrsp = present_attrs;
2787     return true;
2788 }
2789
2790 static enum odp_key_fitness
2791 check_expectations(uint64_t present_attrs, int out_of_range_attr,
2792                    uint64_t expected_attrs,
2793                    const struct nlattr *key, size_t key_len)
2794 {
2795     uint64_t missing_attrs;
2796     uint64_t extra_attrs;
2797
2798     missing_attrs = expected_attrs & ~present_attrs;
2799     if (missing_attrs) {
2800         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
2801         log_odp_key_attributes(&rl, "expected but not present",
2802                                missing_attrs, 0, key, key_len);
2803         return ODP_FIT_TOO_LITTLE;
2804     }
2805
2806     extra_attrs = present_attrs & ~expected_attrs;
2807     if (extra_attrs || out_of_range_attr) {
2808         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
2809         log_odp_key_attributes(&rl, "present but not expected",
2810                                extra_attrs, out_of_range_attr, key, key_len);
2811         return ODP_FIT_TOO_MUCH;
2812     }
2813
2814     return ODP_FIT_PERFECT;
2815 }
2816
2817 static bool
2818 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
2819                 uint64_t present_attrs, uint64_t *expected_attrs,
2820                 struct flow *flow, const struct flow *src_flow)
2821 {
2822     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2823     bool is_mask = flow != src_flow;
2824
2825     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
2826         flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
2827         if (!is_mask && ntohs(flow->dl_type) < ETH_TYPE_MIN) {
2828             VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
2829                         ntohs(flow->dl_type));
2830             return false;
2831         }
2832         if (is_mask && ntohs(src_flow->dl_type) < ETH_TYPE_MIN &&
2833             flow->dl_type != htons(0xffff)) {
2834             return false;
2835         }
2836         *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
2837     } else {
2838         if (!is_mask) {
2839             flow->dl_type = htons(FLOW_DL_TYPE_NONE);
2840         } else if (ntohs(src_flow->dl_type) < ETH_TYPE_MIN) {
2841             /* See comments in odp_flow_key_from_flow__(). */
2842             VLOG_ERR_RL(&rl, "mask expected for non-Ethernet II frame");
2843             return false;
2844         }
2845     }
2846     return true;
2847 }
2848
2849 static enum odp_key_fitness
2850 parse_l2_5_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
2851                   uint64_t present_attrs, int out_of_range_attr,
2852                   uint64_t expected_attrs, struct flow *flow,
2853                   const struct nlattr *key, size_t key_len,
2854                   const struct flow *src_flow)
2855 {
2856     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2857     bool is_mask = src_flow != flow;
2858     const void *check_start = NULL;
2859     size_t check_len = 0;
2860     enum ovs_key_attr expected_bit = 0xff;
2861
2862     if (eth_type_mpls(src_flow->dl_type)) {
2863         if (!is_mask) {
2864             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
2865
2866             if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS))) {
2867                 return ODP_FIT_TOO_LITTLE;
2868             }
2869             flow->mpls_lse = nl_attr_get_be32(attrs[OVS_KEY_ATTR_MPLS]);
2870         } else if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
2871             flow->mpls_lse = nl_attr_get_be32(attrs[OVS_KEY_ATTR_MPLS]);
2872
2873             if (flow->mpls_lse != 0 && flow->dl_type != htons(0xffff)) {
2874                 return ODP_FIT_ERROR;
2875             }
2876             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
2877         }
2878         goto done;
2879     } else if (src_flow->dl_type == htons(ETH_TYPE_IP)) {
2880         if (!is_mask) {
2881             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
2882         }
2883         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
2884             const struct ovs_key_ipv4 *ipv4_key;
2885
2886             ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
2887             flow->nw_src = ipv4_key->ipv4_src;
2888             flow->nw_dst = ipv4_key->ipv4_dst;
2889             flow->nw_proto = ipv4_key->ipv4_proto;
2890             flow->nw_tos = ipv4_key->ipv4_tos;
2891             flow->nw_ttl = ipv4_key->ipv4_ttl;
2892             if (is_mask) {
2893                 flow->nw_frag = ipv4_key->ipv4_frag;
2894                 check_start = ipv4_key;
2895                 check_len = sizeof *ipv4_key;
2896                 expected_bit = OVS_KEY_ATTR_IPV4;
2897             } else if (!odp_to_ovs_frag(ipv4_key->ipv4_frag, flow)) {
2898                 return ODP_FIT_ERROR;
2899             }
2900         }
2901     } else if (src_flow->dl_type == htons(ETH_TYPE_IPV6)) {
2902         if (!is_mask) {
2903             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
2904         }
2905         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
2906             const struct ovs_key_ipv6 *ipv6_key;
2907
2908             ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
2909             memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
2910             memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
2911             flow->ipv6_label = ipv6_key->ipv6_label;
2912             flow->nw_proto = ipv6_key->ipv6_proto;
2913             flow->nw_tos = ipv6_key->ipv6_tclass;
2914             flow->nw_ttl = ipv6_key->ipv6_hlimit;
2915             if (is_mask) {
2916                 flow->nw_frag = ipv6_key->ipv6_frag;
2917                 check_start = ipv6_key;
2918                 check_len = sizeof *ipv6_key;
2919                 expected_bit = OVS_KEY_ATTR_IPV6;
2920             } else if (!odp_to_ovs_frag(ipv6_key->ipv6_frag, flow)) {
2921                 return ODP_FIT_ERROR;
2922             }
2923         }
2924     } else if (src_flow->dl_type == htons(ETH_TYPE_ARP) ||
2925                src_flow->dl_type == htons(ETH_TYPE_RARP)) {
2926         if (!is_mask) {
2927             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
2928         }
2929         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
2930             const struct ovs_key_arp *arp_key;
2931
2932             arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
2933             flow->nw_src = arp_key->arp_sip;
2934             flow->nw_dst = arp_key->arp_tip;
2935             if (!is_mask && (arp_key->arp_op & htons(0xff00))) {
2936                 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
2937                             "key", ntohs(arp_key->arp_op));
2938                 return ODP_FIT_ERROR;
2939             }
2940             flow->nw_proto = ntohs(arp_key->arp_op);
2941             memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
2942             memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
2943
2944             if (is_mask) {
2945                 check_start = arp_key;
2946                 check_len = sizeof *arp_key;
2947                 expected_bit = OVS_KEY_ATTR_ARP;
2948             }
2949         }
2950     } else {
2951         goto done;
2952     }
2953     if (is_mask) {
2954         if (!is_all_zeros(check_start, check_len) &&
2955             flow->dl_type != htons(0xffff)) {
2956             return ODP_FIT_ERROR;
2957         } else {
2958             expected_attrs |= UINT64_C(1) << expected_bit;
2959         }
2960     }
2961
2962     expected_bit = OVS_KEY_ATTR_UNSPEC;
2963     if (src_flow->nw_proto == IPPROTO_TCP
2964         && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
2965             src_flow->dl_type == htons(ETH_TYPE_IPV6))
2966         && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2967         if (!is_mask) {
2968             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
2969         }
2970         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
2971             const struct ovs_key_tcp *tcp_key;
2972
2973             tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
2974             flow->tp_src = tcp_key->tcp_src;
2975             flow->tp_dst = tcp_key->tcp_dst;
2976             expected_bit = OVS_KEY_ATTR_TCP;
2977         }
2978         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS)) {
2979             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS;
2980             flow->tcp_flags = nl_attr_get_be16(attrs[OVS_KEY_ATTR_TCP_FLAGS]);
2981         }
2982     } else if (src_flow->nw_proto == IPPROTO_UDP
2983                && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
2984                    src_flow->dl_type == htons(ETH_TYPE_IPV6))
2985                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2986         if (!is_mask) {
2987             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
2988         }
2989         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
2990             const struct ovs_key_udp *udp_key;
2991
2992             udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
2993             flow->tp_src = udp_key->udp_src;
2994             flow->tp_dst = udp_key->udp_dst;
2995             expected_bit = OVS_KEY_ATTR_UDP;
2996         }
2997     } else if (src_flow->nw_proto == IPPROTO_SCTP
2998                && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
2999                    src_flow->dl_type == htons(ETH_TYPE_IPV6))
3000                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3001         if (!is_mask) {
3002             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SCTP;
3003         }
3004         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SCTP)) {
3005             const struct ovs_key_sctp *sctp_key;
3006
3007             sctp_key = nl_attr_get(attrs[OVS_KEY_ATTR_SCTP]);
3008             flow->tp_src = sctp_key->sctp_src;
3009             flow->tp_dst = sctp_key->sctp_dst;
3010             expected_bit = OVS_KEY_ATTR_SCTP;
3011         }
3012     } else if (src_flow->nw_proto == IPPROTO_ICMP
3013                && src_flow->dl_type == htons(ETH_TYPE_IP)
3014                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3015         if (!is_mask) {
3016             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
3017         }
3018         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
3019             const struct ovs_key_icmp *icmp_key;
3020
3021             icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
3022             flow->tp_src = htons(icmp_key->icmp_type);
3023             flow->tp_dst = htons(icmp_key->icmp_code);
3024             expected_bit = OVS_KEY_ATTR_ICMP;
3025         }
3026     } else if (src_flow->nw_proto == IPPROTO_ICMPV6
3027                && src_flow->dl_type == htons(ETH_TYPE_IPV6)
3028                && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3029         if (!is_mask) {
3030             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
3031         }
3032         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
3033             const struct ovs_key_icmpv6 *icmpv6_key;
3034
3035             icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
3036             flow->tp_src = htons(icmpv6_key->icmpv6_type);
3037             flow->tp_dst = htons(icmpv6_key->icmpv6_code);
3038             expected_bit = OVS_KEY_ATTR_ICMPV6;
3039             if (src_flow->tp_dst == htons(0) &&
3040                 (src_flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
3041                  src_flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
3042                 if (!is_mask) {
3043                     expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
3044                 }
3045                 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
3046                     const struct ovs_key_nd *nd_key;
3047
3048                     nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
3049                     memcpy(&flow->nd_target, nd_key->nd_target,
3050                            sizeof flow->nd_target);
3051                     memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
3052                     memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
3053                     if (is_mask) {
3054                         if (!is_all_zeros((const uint8_t *) nd_key,
3055                                           sizeof *nd_key) &&
3056                             (flow->tp_src != htons(0xffff) ||
3057                              flow->tp_dst != htons(0xffff))) {
3058                             return ODP_FIT_ERROR;
3059                         } else {
3060                             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
3061                         }
3062                     }
3063                 }
3064             }
3065         }
3066     }
3067     if (is_mask && expected_bit != OVS_KEY_ATTR_UNSPEC) {
3068         if ((flow->tp_src || flow->tp_dst) && flow->nw_proto != 0xff) {
3069             return ODP_FIT_ERROR;
3070         } else {
3071             expected_attrs |= UINT64_C(1) << expected_bit;
3072         }
3073     }
3074
3075 done:
3076     return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
3077                               key, key_len);
3078 }
3079
3080 /* Parse 802.1Q header then encapsulated L3 attributes. */
3081 static enum odp_key_fitness
3082 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
3083                    uint64_t present_attrs, int out_of_range_attr,
3084                    uint64_t expected_attrs, struct flow *flow,
3085                    const struct nlattr *key, size_t key_len,
3086                    const struct flow *src_flow)
3087 {
3088     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3089     bool is_mask = src_flow != flow;
3090
3091     const struct nlattr *encap
3092         = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
3093            ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
3094     enum odp_key_fitness encap_fitness;
3095     enum odp_key_fitness fitness;
3096     ovs_be16 tci;
3097
3098     /* Calculate fitness of outer attributes. */
3099     if (!is_mask) {
3100         expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
3101                           (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
3102     } else {
3103         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
3104             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
3105         }
3106         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)) {
3107             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_ENCAP);
3108         }
3109     }
3110     fitness = check_expectations(present_attrs, out_of_range_attr,
3111                                  expected_attrs, key, key_len);
3112
3113     /* Get the VLAN TCI value. */
3114     if (!is_mask && !(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
3115         return ODP_FIT_TOO_LITTLE;
3116     } else {
3117         tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
3118         if (!is_mask) {
3119             if (tci == htons(0)) {
3120                 /* Corner case for a truncated 802.1Q header. */
3121                 if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
3122                     return ODP_FIT_TOO_MUCH;
3123                 }
3124                 return fitness;
3125             } else if (!(tci & htons(VLAN_CFI))) {
3126                 VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
3127                             "but CFI bit is not set", ntohs(tci));
3128                 return ODP_FIT_ERROR;
3129             }
3130         }
3131         /* Set vlan_tci.
3132          * Remove the TPID from dl_type since it's not the real Ethertype.  */
3133         flow->dl_type = htons(0);
3134         flow->vlan_tci = tci;
3135     }
3136
3137     if (is_mask && !(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP))) {
3138         return fitness;
3139     }
3140     /* Now parse the encapsulated attributes. */
3141     if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
3142                             attrs, &present_attrs, &out_of_range_attr)) {
3143         return ODP_FIT_ERROR;
3144     }
3145     expected_attrs = 0;
3146
3147     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow, src_flow)) {
3148         return ODP_FIT_ERROR;
3149     }
3150     encap_fitness = parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
3151                                       expected_attrs, flow, key, key_len,
3152                                       src_flow);
3153
3154     /* The overall fitness is the worse of the outer and inner attributes. */
3155     return MAX(fitness, encap_fitness);
3156 }
3157
3158 static enum odp_key_fitness
3159 odp_flow_key_to_flow__(const struct nlattr *key, size_t key_len,
3160                        struct flow *flow, const struct flow *src_flow)
3161 {
3162     const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
3163     uint64_t expected_attrs;
3164     uint64_t present_attrs;
3165     int out_of_range_attr;
3166     bool is_mask = src_flow != flow;
3167
3168     memset(flow, 0, sizeof *flow);
3169
3170     /* Parse attributes. */
3171     if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
3172                             &out_of_range_attr)) {
3173         return ODP_FIT_ERROR;
3174     }
3175     expected_attrs = 0;
3176
3177     /* Metadata. */
3178     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
3179         flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
3180         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
3181     }
3182
3183     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK)) {
3184         flow->pkt_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_SKB_MARK]);
3185         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK;
3186     }
3187
3188     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUNNEL)) {
3189         enum odp_key_fitness res;
3190
3191         res = odp_tun_key_from_attr(attrs[OVS_KEY_ATTR_TUNNEL], &flow->tunnel);
3192         if (res == ODP_FIT_ERROR) {
3193             return ODP_FIT_ERROR;
3194         } else if (res == ODP_FIT_PERFECT) {
3195             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUNNEL;
3196         }
3197     }
3198
3199     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
3200         flow->in_port.odp_port
3201             = nl_attr_get_odp_port(attrs[OVS_KEY_ATTR_IN_PORT]);
3202         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
3203     } else if (!is_mask) {
3204         flow->in_port.odp_port = ODPP_NONE;
3205     }
3206
3207     /* Ethernet header. */
3208     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
3209         const struct ovs_key_ethernet *eth_key;
3210
3211         eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
3212         memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
3213         memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
3214         if (is_mask) {
3215             expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
3216         }
3217     }
3218     if (!is_mask) {
3219         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
3220     }
3221
3222     /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
3223     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow,
3224         src_flow)) {
3225         return ODP_FIT_ERROR;
3226     }
3227
3228     if ((is_mask && (src_flow->vlan_tci & htons(VLAN_CFI))) ||
3229         (!is_mask && src_flow->dl_type == htons(ETH_TYPE_VLAN))) {
3230         return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
3231                                   expected_attrs, flow, key, key_len, src_flow);
3232     }
3233     if (is_mask) {
3234         flow->vlan_tci = htons(0xffff);
3235         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
3236             flow->vlan_tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
3237             expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
3238         }
3239     }
3240     return parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
3241                              expected_attrs, flow, key, key_len, src_flow);
3242 }
3243
3244 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
3245  * structure in 'flow'.  Returns an ODP_FIT_* value that indicates how well
3246  * 'key' fits our expectations for what a flow key should contain.
3247  *
3248  * The 'in_port' will be the datapath's understanding of the port.  The
3249  * caller will need to translate with odp_port_to_ofp_port() if the
3250  * OpenFlow port is needed.
3251  *
3252  * This function doesn't take the packet itself as an argument because none of
3253  * the currently understood OVS_KEY_ATTR_* attributes require it.  Currently,
3254  * it is always possible to infer which additional attribute(s) should appear
3255  * by looking at the attributes for lower-level protocols, e.g. if the network
3256  * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
3257  * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
3258  * must be absent. */
3259 enum odp_key_fitness
3260 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
3261                      struct flow *flow)
3262 {
3263    return odp_flow_key_to_flow__(key, key_len, flow, flow);
3264 }
3265
3266 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a mask
3267  * structure in 'mask'.  'flow' must be a previously translated flow
3268  * corresponding to 'mask'.  Returns an ODP_FIT_* value that indicates how well
3269  * 'key' fits our expectations for what a flow key should contain. */
3270 enum odp_key_fitness
3271 odp_flow_key_to_mask(const struct nlattr *key, size_t key_len,
3272                      struct flow *mask, const struct flow *flow)
3273 {
3274    return odp_flow_key_to_flow__(key, key_len, mask, flow);
3275 }
3276
3277 /* Returns 'fitness' as a string, for use in debug messages. */
3278 const char *
3279 odp_key_fitness_to_string(enum odp_key_fitness fitness)
3280 {
3281     switch (fitness) {
3282     case ODP_FIT_PERFECT:
3283         return "OK";
3284     case ODP_FIT_TOO_MUCH:
3285         return "too_much";
3286     case ODP_FIT_TOO_LITTLE:
3287         return "too_little";
3288     case ODP_FIT_ERROR:
3289         return "error";
3290     default:
3291         return "<unknown>";
3292     }
3293 }
3294
3295 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
3296  * Netlink PID 'pid'.  If 'userdata' is nonnull, adds a userdata attribute
3297  * whose contents are the 'userdata_size' bytes at 'userdata' and returns the
3298  * offset within 'odp_actions' of the start of the cookie.  (If 'userdata' is
3299  * null, then the return value is not meaningful.) */
3300 size_t
3301 odp_put_userspace_action(uint32_t pid,
3302                          const void *userdata, size_t userdata_size,
3303                          struct ofpbuf *odp_actions)
3304 {
3305     size_t userdata_ofs;
3306     size_t offset;
3307
3308     offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
3309     nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
3310     if (userdata) {
3311         userdata_ofs = odp_actions->size + NLA_HDRLEN;
3312
3313         /* The OVS kernel module before OVS 1.11 and the upstream Linux kernel
3314          * module before Linux 3.10 required the userdata to be exactly 8 bytes
3315          * long:
3316          *
3317          *   - The kernel rejected shorter userdata with -ERANGE.
3318          *
3319          *   - The kernel silently dropped userdata beyond the first 8 bytes.
3320          *
3321          * Thus, for maximum compatibility, always put at least 8 bytes.  (We
3322          * separately disable features that required more than 8 bytes.) */
3323         memcpy(nl_msg_put_unspec_zero(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
3324                                       MAX(8, userdata_size)),
3325                userdata, userdata_size);
3326     } else {
3327         userdata_ofs = 0;
3328     }
3329     nl_msg_end_nested(odp_actions, offset);
3330
3331     return userdata_ofs;
3332 }
3333
3334 void
3335 odp_put_tunnel_action(const struct flow_tnl *tunnel,
3336                       struct ofpbuf *odp_actions)
3337 {
3338     size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
3339     tun_key_to_attr(odp_actions, tunnel);
3340     nl_msg_end_nested(odp_actions, offset);
3341 }
3342 \f
3343 /* The commit_odp_actions() function and its helpers. */
3344
3345 static void
3346 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
3347                   const void *key, size_t key_size)
3348 {
3349     size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
3350     nl_msg_put_unspec(odp_actions, key_type, key, key_size);
3351     nl_msg_end_nested(odp_actions, offset);
3352 }
3353
3354 void
3355 odp_put_pkt_mark_action(const uint32_t pkt_mark,
3356                         struct ofpbuf *odp_actions)
3357 {
3358     commit_set_action(odp_actions, OVS_KEY_ATTR_SKB_MARK, &pkt_mark,
3359                       sizeof(pkt_mark));
3360 }
3361
3362 /* If any of the flow key data that ODP actions can modify are different in
3363  * 'base->tunnel' and 'flow->tunnel', appends a set_tunnel ODP action to
3364  * 'odp_actions' that change the flow tunneling information in key from
3365  * 'base->tunnel' into 'flow->tunnel', and then changes 'base->tunnel' in the
3366  * same way.  In other words, operates the same as commit_odp_actions(), but
3367  * only on tunneling information. */
3368 void
3369 commit_odp_tunnel_action(const struct flow *flow, struct flow *base,
3370                          struct ofpbuf *odp_actions)
3371 {
3372     /* A valid IPV4_TUNNEL must have non-zero ip_dst. */
3373     if (flow->tunnel.ip_dst) {
3374         if (!memcmp(&base->tunnel, &flow->tunnel, sizeof base->tunnel)) {
3375             return;
3376         }
3377         memcpy(&base->tunnel, &flow->tunnel, sizeof base->tunnel);
3378         odp_put_tunnel_action(&base->tunnel, odp_actions);
3379     }
3380 }
3381
3382 static void
3383 commit_set_ether_addr_action(const struct flow *flow, struct flow *base,
3384                              struct ofpbuf *odp_actions,
3385                              struct flow_wildcards *wc)
3386 {
3387     struct ovs_key_ethernet eth_key;
3388
3389     if (eth_addr_equals(base->dl_src, flow->dl_src) &&
3390         eth_addr_equals(base->dl_dst, flow->dl_dst)) {
3391         return;
3392     }
3393
3394     memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
3395     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
3396
3397     memcpy(base->dl_src, flow->dl_src, ETH_ADDR_LEN);
3398     memcpy(base->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
3399
3400     memcpy(eth_key.eth_src, base->dl_src, ETH_ADDR_LEN);
3401     memcpy(eth_key.eth_dst, base->dl_dst, ETH_ADDR_LEN);
3402
3403     commit_set_action(odp_actions, OVS_KEY_ATTR_ETHERNET,
3404                       &eth_key, sizeof(eth_key));
3405 }
3406
3407 static void
3408 commit_vlan_action(ovs_be16 vlan_tci, struct flow *base,
3409                    struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3410 {
3411     if (base->vlan_tci == vlan_tci) {
3412         return;
3413     }
3414
3415     memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
3416
3417     if (base->vlan_tci & htons(VLAN_CFI)) {
3418         nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
3419     }
3420
3421     if (vlan_tci & htons(VLAN_CFI)) {
3422         struct ovs_action_push_vlan vlan;
3423
3424         vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
3425         vlan.vlan_tci = vlan_tci;
3426         nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
3427                           &vlan, sizeof vlan);
3428     }
3429     base->vlan_tci = vlan_tci;
3430 }
3431
3432 static void
3433 commit_mpls_action(const struct flow *flow, struct flow *base,
3434                    struct ofpbuf *odp_actions, struct flow_wildcards *wc,
3435                    int *mpls_depth_delta)
3436 {
3437     if (flow->mpls_lse == base->mpls_lse && !*mpls_depth_delta) {
3438         return;
3439     }
3440
3441     memset(&wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
3442
3443     switch (*mpls_depth_delta) {
3444     case -1:
3445         nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_POP_MPLS, flow->dl_type);
3446         break;
3447     case 1: {
3448         struct ovs_action_push_mpls *mpls;
3449
3450         mpls = nl_msg_put_unspec_zero(odp_actions, OVS_ACTION_ATTR_PUSH_MPLS,
3451                                       sizeof *mpls);
3452         mpls->mpls_ethertype = flow->dl_type;
3453         mpls->mpls_lse = flow->mpls_lse;
3454         break;
3455     }
3456     case 0: {
3457         struct ovs_key_mpls mpls_key;
3458
3459         mpls_key.mpls_lse = flow->mpls_lse;
3460         commit_set_action(odp_actions, OVS_KEY_ATTR_MPLS,
3461                           &mpls_key, sizeof(mpls_key));
3462         break;
3463     }
3464     default:
3465         NOT_REACHED();
3466     }
3467
3468     base->dl_type = flow->dl_type;
3469     base->mpls_lse = flow->mpls_lse;
3470     *mpls_depth_delta = 0;
3471 }
3472
3473 static void
3474 commit_set_ipv4_action(const struct flow *flow, struct flow *base,
3475                      struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3476 {
3477     struct ovs_key_ipv4 ipv4_key;
3478
3479     if (base->nw_src == flow->nw_src &&
3480         base->nw_dst == flow->nw_dst &&
3481         base->nw_tos == flow->nw_tos &&
3482         base->nw_ttl == flow->nw_ttl &&
3483         base->nw_frag == flow->nw_frag) {
3484         return;
3485     }
3486
3487     memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
3488     memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
3489     memset(&wc->masks.nw_tos, 0xff, sizeof wc->masks.nw_tos);
3490     memset(&wc->masks.nw_ttl, 0xff, sizeof wc->masks.nw_ttl);
3491     memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
3492     memset(&wc->masks.nw_frag, 0xff, sizeof wc->masks.nw_frag);
3493
3494     ipv4_key.ipv4_src = base->nw_src = flow->nw_src;
3495     ipv4_key.ipv4_dst = base->nw_dst = flow->nw_dst;
3496     ipv4_key.ipv4_tos = base->nw_tos = flow->nw_tos;
3497     ipv4_key.ipv4_ttl = base->nw_ttl = flow->nw_ttl;
3498     ipv4_key.ipv4_proto = base->nw_proto;
3499     ipv4_key.ipv4_frag = ovs_to_odp_frag(base->nw_frag);
3500
3501     commit_set_action(odp_actions, OVS_KEY_ATTR_IPV4,
3502                       &ipv4_key, sizeof(ipv4_key));
3503 }
3504
3505 static void
3506 commit_set_ipv6_action(const struct flow *flow, struct flow *base,
3507                        struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3508 {
3509     struct ovs_key_ipv6 ipv6_key;
3510
3511     if (ipv6_addr_equals(&base->ipv6_src, &flow->ipv6_src) &&
3512         ipv6_addr_equals(&base->ipv6_dst, &flow->ipv6_dst) &&
3513         base->ipv6_label == flow->ipv6_label &&
3514         base->nw_tos == flow->nw_tos &&
3515         base->nw_ttl == flow->nw_ttl &&
3516         base->nw_frag == flow->nw_frag) {
3517         return;
3518     }
3519
3520     memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
3521     memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
3522     memset(&wc->masks.ipv6_label, 0xff, sizeof wc->masks.ipv6_label);
3523     memset(&wc->masks.nw_tos, 0xff, sizeof wc->masks.nw_tos);
3524     memset(&wc->masks.nw_ttl, 0xff, sizeof wc->masks.nw_ttl);
3525     memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
3526     memset(&wc->masks.nw_frag, 0xff, sizeof wc->masks.nw_frag);
3527
3528     base->ipv6_src = flow->ipv6_src;
3529     memcpy(&ipv6_key.ipv6_src, &base->ipv6_src, sizeof(ipv6_key.ipv6_src));
3530     base->ipv6_dst = flow->ipv6_dst;
3531     memcpy(&ipv6_key.ipv6_dst, &base->ipv6_dst, sizeof(ipv6_key.ipv6_dst));
3532
3533     ipv6_key.ipv6_label = base->ipv6_label = flow->ipv6_label;
3534     ipv6_key.ipv6_tclass = base->nw_tos = flow->nw_tos;
3535     ipv6_key.ipv6_hlimit = base->nw_ttl = flow->nw_ttl;
3536     ipv6_key.ipv6_proto = base->nw_proto;
3537     ipv6_key.ipv6_frag = ovs_to_odp_frag(base->nw_frag);
3538
3539     commit_set_action(odp_actions, OVS_KEY_ATTR_IPV6,
3540                       &ipv6_key, sizeof(ipv6_key));
3541 }
3542
3543 static enum slow_path_reason
3544 commit_set_arp_action(const struct flow *flow, struct flow *base,
3545                       struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3546 {
3547     struct ovs_key_arp arp_key;
3548
3549     if (base->nw_src == flow->nw_src &&
3550         base->nw_dst == flow->nw_dst &&
3551         base->nw_proto == flow->nw_proto &&
3552         eth_addr_equals(base->arp_sha, flow->arp_sha) &&
3553         eth_addr_equals(base->arp_tha, flow->arp_tha)) {
3554         return 0;
3555     }
3556
3557     memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
3558     memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
3559     memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
3560     memset(&wc->masks.arp_sha, 0xff, sizeof wc->masks.arp_sha);
3561     memset(&wc->masks.arp_tha, 0xff, sizeof wc->masks.arp_tha);
3562
3563     base->nw_src = flow->nw_src;
3564     base->nw_dst = flow->nw_dst;
3565     base->nw_proto = flow->nw_proto;
3566     memcpy(base->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
3567     memcpy(base->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
3568
3569     arp_key.arp_sip = base->nw_src;
3570     arp_key.arp_tip = base->nw_dst;
3571     arp_key.arp_op = htons(base->nw_proto);
3572     memcpy(arp_key.arp_sha, flow->arp_sha, ETH_ADDR_LEN);
3573     memcpy(arp_key.arp_tha, flow->arp_tha, ETH_ADDR_LEN);
3574
3575     commit_set_action(odp_actions, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
3576
3577     return SLOW_ACTION;
3578 }
3579
3580 static enum slow_path_reason
3581 commit_set_nw_action(const struct flow *flow, struct flow *base,
3582                      struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3583 {
3584     /* Check if 'flow' really has an L3 header. */
3585     if (!flow->nw_proto) {
3586         return 0;
3587     }
3588
3589     switch (ntohs(base->dl_type)) {
3590     case ETH_TYPE_IP:
3591         commit_set_ipv4_action(flow, base, odp_actions, wc);
3592         break;
3593
3594     case ETH_TYPE_IPV6:
3595         commit_set_ipv6_action(flow, base, odp_actions, wc);
3596         break;
3597
3598     case ETH_TYPE_ARP:
3599         return commit_set_arp_action(flow, base, odp_actions, wc);
3600     }
3601
3602     return 0;
3603 }
3604
3605 static void
3606 commit_set_port_action(const struct flow *flow, struct flow *base,
3607                        struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3608 {
3609     if (!is_ip_any(base) || (!base->tp_src && !base->tp_dst)) {
3610         return;
3611     }
3612
3613     if (base->tp_src == flow->tp_src &&
3614         base->tp_dst == flow->tp_dst) {
3615         return;
3616     }
3617
3618     memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
3619     memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
3620
3621     if (flow->nw_proto == IPPROTO_TCP) {
3622         struct ovs_key_tcp port_key;
3623
3624         port_key.tcp_src = base->tp_src = flow->tp_src;
3625         port_key.tcp_dst = base->tp_dst = flow->tp_dst;
3626
3627         commit_set_action(odp_actions, OVS_KEY_ATTR_TCP,
3628                           &port_key, sizeof(port_key));
3629
3630     } else if (flow->nw_proto == IPPROTO_UDP) {
3631         struct ovs_key_udp port_key;
3632
3633         port_key.udp_src = base->tp_src = flow->tp_src;
3634         port_key.udp_dst = base->tp_dst = flow->tp_dst;
3635
3636         commit_set_action(odp_actions, OVS_KEY_ATTR_UDP,
3637                           &port_key, sizeof(port_key));
3638     } else if (flow->nw_proto == IPPROTO_SCTP) {
3639         struct ovs_key_sctp port_key;
3640
3641         port_key.sctp_src = base->tp_src = flow->tp_src;
3642         port_key.sctp_dst = base->tp_dst = flow->tp_dst;
3643
3644         commit_set_action(odp_actions, OVS_KEY_ATTR_SCTP,
3645                           &port_key, sizeof(port_key));
3646     }
3647 }
3648
3649 static void
3650 commit_set_priority_action(const struct flow *flow, struct flow *base,
3651                            struct ofpbuf *odp_actions,
3652                            struct flow_wildcards *wc)
3653 {
3654     if (base->skb_priority == flow->skb_priority) {
3655         return;
3656     }
3657
3658     memset(&wc->masks.skb_priority, 0xff, sizeof wc->masks.skb_priority);
3659     base->skb_priority = flow->skb_priority;
3660
3661     commit_set_action(odp_actions, OVS_KEY_ATTR_PRIORITY,
3662                       &base->skb_priority, sizeof(base->skb_priority));
3663 }
3664
3665 static void
3666 commit_set_pkt_mark_action(const struct flow *flow, struct flow *base,
3667                            struct ofpbuf *odp_actions,
3668                            struct flow_wildcards *wc)
3669 {
3670     if (base->pkt_mark == flow->pkt_mark) {
3671         return;
3672     }
3673
3674     memset(&wc->masks.pkt_mark, 0xff, sizeof wc->masks.pkt_mark);
3675     base->pkt_mark = flow->pkt_mark;
3676
3677     odp_put_pkt_mark_action(base->pkt_mark, odp_actions);
3678 }
3679
3680 /* If any of the flow key data that ODP actions can modify are different in
3681  * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
3682  * key from 'base' into 'flow', and then changes 'base' the same way.  Does not
3683  * commit set_tunnel actions.  Users should call commit_odp_tunnel_action()
3684  * in addition to this function if needed.  Sets fields in 'wc' that are
3685  * used as part of the action.
3686  *
3687  * Returns a reason to force processing the flow's packets into the userspace
3688  * slow path, if there is one, otherwise 0. */
3689 enum slow_path_reason
3690 commit_odp_actions(const struct flow *flow, struct flow *base,
3691                    struct ofpbuf *odp_actions, struct flow_wildcards *wc,
3692                    int *mpls_depth_delta)
3693 {
3694     enum slow_path_reason slow;
3695
3696     commit_set_ether_addr_action(flow, base, odp_actions, wc);
3697     commit_vlan_action(flow->vlan_tci, base, odp_actions, wc);
3698     slow = commit_set_nw_action(flow, base, odp_actions, wc);
3699     commit_set_port_action(flow, base, odp_actions, wc);
3700     /* Committing MPLS actions should occur after committing nw and port
3701      * actions. This is because committing MPLS actions may alter a packet so
3702      * that it is no longer IP and thus nw and port actions are no longer valid.
3703      */
3704     commit_mpls_action(flow, base, odp_actions, wc, mpls_depth_delta);
3705     commit_set_priority_action(flow, base, odp_actions, wc);
3706     commit_set_pkt_mark_action(flow, base, odp_actions, wc);
3707
3708     return slow;
3709 }