lib/odp-util.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
   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 <arpa/inet.h>
  18 #include <config.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 "openvswitch/tunnel.h"
  34 #include "packets.h"
  35 #include "shash.h"
  36 #include "timeval.h"
  37 #include "util.h"
  38 #include "vlog.h"
  39
  40 VLOG_DEFINE_THIS_MODULE(odp_util);
  41
  42 /* The interface between userspace and kernel uses an "OVS_*" prefix.
  43  * Since this is fairly non-specific for the OVS userspace components,
  44  * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
  45  * interactions with the datapath.
  46  */
  47
  48 /* The set of characters that may separate one action or one key attribute
  49  * from another. */
  50 static const char *delimiters = ", \t\r\n";
  51
  52 static int parse_odp_key_attr(const char *, const struct shash *port_names,
  53                               struct ofpbuf *);
  54 static void format_odp_key_attr(const struct nlattr *a, struct ds *ds);
  55
  56 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
  57  * 'type':
  58  *
  59  *   - For an action whose argument has a fixed length, returned that
  60  *     nonnegative length in bytes.
  61  *
  62  *   - For an action with a variable-length argument, returns -2.
  63  *
  64  *   - For an invalid 'type', returns -1. */
  65 static int
  66 odp_action_len(uint16_t type)
  67 {
  68     if (type > OVS_ACTION_ATTR_MAX) {
  69         return -1;
  70     }
  71
  72     switch ((enum ovs_action_attr) type) {
  73     case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
  74     case OVS_ACTION_ATTR_USERSPACE: return -2;
  75     case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
  76     case OVS_ACTION_ATTR_POP_VLAN: return 0;
  77     case OVS_ACTION_ATTR_SET: return -2;
  78     case OVS_ACTION_ATTR_SAMPLE: return -2;
  79
  80     case OVS_ACTION_ATTR_UNSPEC:
  81     case __OVS_ACTION_ATTR_MAX:
  82         return -1;
  83     }
  84
  85     return -1;
  86 }
  87
  88 static const char *
  89 ovs_key_attr_to_string(enum ovs_key_attr attr)
  90 {
  91     static char unknown_attr[3 + INT_STRLEN(unsigned int) + 1];
  92
  93     switch (attr) {
  94     case OVS_KEY_ATTR_UNSPEC: return "unspec";
  95     case OVS_KEY_ATTR_ENCAP: return "encap";
  96     case OVS_KEY_ATTR_PRIORITY: return "priority";
  97     case OVS_KEY_ATTR_IN_PORT: return "in_port";
  98     case OVS_KEY_ATTR_ETHERNET: return "eth";
  99     case OVS_KEY_ATTR_VLAN: return "vlan";
 100     case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
 101     case OVS_KEY_ATTR_IPV4: return "ipv4";
 102     case OVS_KEY_ATTR_IPV6: return "ipv6";
 103     case OVS_KEY_ATTR_TCP: return "tcp";
 104     case OVS_KEY_ATTR_UDP: return "udp";
 105     case OVS_KEY_ATTR_ICMP: return "icmp";
 106     case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
 107     case OVS_KEY_ATTR_ARP: return "arp";
 108     case OVS_KEY_ATTR_ND: return "nd";
 109     case OVS_KEY_ATTR_TUN_ID: return "tun_id";
 110
 111     case __OVS_KEY_ATTR_MAX:
 112     default:
 113         snprintf(unknown_attr, sizeof unknown_attr, "key%u",
 114                  (unsigned int) attr);
 115         return unknown_attr;
 116     }
 117 }
 118
 119 static void
 120 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
 121 {
 122     size_t len = nl_attr_get_size(a);
 123
 124     ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
 125     if (len) {
 126         const uint8_t *unspec;
 127         unsigned int i;
 128
 129         unspec = nl_attr_get(a);
 130         for (i = 0; i < len; i++) {
 131             ds_put_char(ds, i ? ' ': '(');
 132             ds_put_format(ds, "%02x", unspec[i]);
 133         }
 134         ds_put_char(ds, ')');
 135     }
 136 }
 137
 138 static void
 139 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
 140 {
 141     static const struct nl_policy ovs_sample_policy[] = {
 142         [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
 143         [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
 144     };
 145     struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
 146     double percentage;
 147     const struct nlattr *nla_acts;
 148     int len;
 149
 150     ds_put_cstr(ds, "sample");
 151
 152     if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
 153         ds_put_cstr(ds, "(error)");
 154         return;
 155     }
 156
 157     percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
 158                         UINT32_MAX;
 159
 160     ds_put_format(ds, "(sample=%.1f%%,", percentage);
 161
 162     ds_put_cstr(ds, "actions(");
 163     nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
 164     len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
 165     format_odp_actions(ds, nla_acts, len);
 166     ds_put_format(ds, "))");
 167 }
 168
 169 static void
 170 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
 171 {
 172     static const struct nl_policy ovs_userspace_policy[] = {
 173         [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
 174         [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
 175     };
 176     struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
 177
 178     if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
 179         ds_put_cstr(ds, "userspace(error)");
 180         return;
 181     }
 182
 183     ds_put_format(ds, "userspace(pid=%"PRIu32,
 184                   nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
 185
 186     if (a[OVS_USERSPACE_ATTR_USERDATA]) {
 187         uint64_t userdata = nl_attr_get_u64(a[OVS_USERSPACE_ATTR_USERDATA]);
 188         struct user_action_cookie cookie;
 189
 190         memcpy(&cookie, &userdata, sizeof cookie);
 191
 192         if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
 193             ds_put_format(ds, ",sFlow,n_output=%"PRIu8","
 194                           "vid=%"PRIu16",pcp=%"PRIu8",ifindex=%"PRIu32,
 195                           cookie.n_output, vlan_tci_to_vid(cookie.vlan_tci),
 196                           vlan_tci_to_pcp(cookie.vlan_tci), cookie.data);
 197         } else {
 198             ds_put_format(ds, ",userdata=0x%"PRIx64, userdata);
 199         }
 200     }
 201
 202     ds_put_char(ds, ')');
 203 }
 204
 205 static void
 206 format_vlan_tci(struct ds *ds, ovs_be16 vlan_tci)
 207 {
 208     ds_put_format(ds, "vid=%"PRIu16",pcp=%d",
 209                   vlan_tci_to_vid(vlan_tci),
 210                   vlan_tci_to_pcp(vlan_tci));
 211     if (!(vlan_tci & htons(VLAN_CFI))) {
 212         ds_put_cstr(ds, ",cfi=0");
 213     }
 214 }
 215
 216 static void
 217 format_odp_action(struct ds *ds, const struct nlattr *a)
 218 {
 219     int expected_len;
 220     enum ovs_action_attr type = nl_attr_type(a);
 221     const struct ovs_action_push_vlan *vlan;
 222
 223     expected_len = odp_action_len(nl_attr_type(a));
 224     if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
 225         ds_put_format(ds, "bad length %zu, expected %d for: ",
 226                       nl_attr_get_size(a), expected_len);
 227         format_generic_odp_action(ds, a);
 228         return;
 229     }
 230
 231     switch (type) {
 232     case OVS_ACTION_ATTR_OUTPUT:
 233         ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
 234         break;
 235     case OVS_ACTION_ATTR_USERSPACE:
 236         format_odp_userspace_action(ds, a);
 237         break;
 238     case OVS_ACTION_ATTR_SET:
 239         ds_put_cstr(ds, "set(");
 240         format_odp_key_attr(nl_attr_get(a), ds);
 241         ds_put_cstr(ds, ")");
 242         break;
 243     case OVS_ACTION_ATTR_PUSH_VLAN:
 244         vlan = nl_attr_get(a);
 245         ds_put_cstr(ds, "push_vlan(");
 246         if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
 247             ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
 248         }
 249         format_vlan_tci(ds, vlan->vlan_tci);
 250         ds_put_char(ds, ')');
 251         break;
 252     case OVS_ACTION_ATTR_POP_VLAN:
 253         ds_put_cstr(ds, "pop_vlan");
 254         break;
 255     case OVS_ACTION_ATTR_SAMPLE:
 256         format_odp_sample_action(ds, a);
 257         break;
 258     case OVS_ACTION_ATTR_UNSPEC:
 259     case __OVS_ACTION_ATTR_MAX:
 260     default:
 261         format_generic_odp_action(ds, a);
 262         break;
 263     }
 264 }
 265
 266 void
 267 format_odp_actions(struct ds *ds, const struct nlattr *actions,
 268                    size_t actions_len)
 269 {
 270     if (actions_len) {
 271         const struct nlattr *a;
 272         unsigned int left;
 273
 274         NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
 275             if (a != actions) {
 276                 ds_put_char(ds, ',');
 277             }
 278             format_odp_action(ds, a);
 279         }
 280         if (left) {
 281             if (left == actions_len) {
 282                 ds_put_cstr(ds, "<empty>");
 283             }
 284             ds_put_format(ds, ",***%u leftover bytes***", left);
 285         }
 286     } else {
 287         ds_put_cstr(ds, "drop");
 288     }
 289 }
 290
 291 static int
 292 parse_odp_action(const char *s, const struct shash *port_names,
 293                  struct ofpbuf *actions)
 294 {
 295     /* Many of the sscanf calls in this function use oversized destination
 296      * fields because some sscanf() implementations truncate the range of %i
 297      * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
 298      * value of 0x7fff.  The other alternatives are to allow only a single
 299      * radix (e.g. decimal or hexadecimal) or to write more sophisticated
 300      * parsers.
 301      *
 302      * The tun_id parser has to use an alternative approach because there is no
 303      * type larger than 64 bits. */
 304
 305     {
 306         unsigned long long int port;
 307         int n = -1;
 308
 309         if (sscanf(s, "%lli%n", &port, &n) > 0 && n > 0) {
 310             nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
 311             return n;
 312         }
 313     }
 314
 315     if (port_names) {
 316         int len = strcspn(s, delimiters);
 317         struct shash_node *node;
 318
 319         node = shash_find_len(port_names, s, len);
 320         if (node) {
 321             nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT,
 322                            (uintptr_t) node->data);
 323             return len;
 324         }
 325     }
 326
 327     {
 328         unsigned long long int pid;
 329         unsigned long long int ifindex;
 330         char userdata_s[32];
 331         int n_output;
 332         int vid, pcp;
 333         int n = -1;
 334
 335         if (sscanf(s, "userspace(pid=%lli)%n", &pid, &n) > 0 && n > 0) {
 336             odp_put_userspace_action(pid, NULL, actions);
 337             return n;
 338         } else if (sscanf(s, "userspace(pid=%lli,sFlow,n_output=%i,vid=%i,"
 339                           "pcp=%i,ifindex=%lli)%n", &pid, &n_output,
 340                           &vid, &pcp, &ifindex, &n) > 0 && n > 0) {
 341             struct user_action_cookie cookie;
 342             uint16_t tci;
 343
 344             tci = vid | (pcp << VLAN_PCP_SHIFT);
 345             if (tci) {
 346                 tci |= VLAN_CFI;
 347             }
 348
 349             cookie.type = USER_ACTION_COOKIE_SFLOW;
 350             cookie.n_output = n_output;
 351             cookie.vlan_tci = htons(tci);
 352             cookie.data = ifindex;
 353             odp_put_userspace_action(pid, &cookie, actions);
 354             return n;
 355         } else if (sscanf(s, "userspace(pid=%lli,userdata="
 356                           "%31[x0123456789abcdefABCDEF])%n", &pid, userdata_s,
 357                           &n) > 0 && n > 0) {
 358             struct user_action_cookie cookie;
 359             uint64_t userdata;
 360
 361             userdata = strtoull(userdata_s, NULL, 0);
 362             memcpy(&cookie, &userdata, sizeof cookie);
 363             odp_put_userspace_action(pid, &cookie, actions);
 364             return n;
 365         }
 366     }
 367
 368     if (!strncmp(s, "set(", 4)) {
 369         size_t start_ofs;
 370         int retval;
 371
 372         start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
 373         retval = parse_odp_key_attr(s + 4, port_names, actions);
 374         if (retval < 0) {
 375             return retval;
 376         }
 377         if (s[retval + 4] != ')') {
 378             return -EINVAL;
 379         }
 380         nl_msg_end_nested(actions, start_ofs);
 381         return retval + 5;
 382     }
 383
 384     {
 385         struct ovs_action_push_vlan push;
 386         int tpid = ETH_TYPE_VLAN;
 387         int vid, pcp;
 388         int cfi = 1;
 389         int n = -1;
 390
 391         if ((sscanf(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n) > 0
 392              && n > 0)
 393             || (sscanf(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
 394                        &vid, &pcp, &cfi, &n) > 0 && n > 0)
 395             || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
 396                        &tpid, &vid, &pcp, &n) > 0 && n > 0)
 397             || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
 398                        &tpid, &vid, &pcp, &cfi, &n) > 0 && n > 0)) {
 399             push.vlan_tpid = htons(tpid);
 400             push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
 401                                   | (pcp << VLAN_PCP_SHIFT)
 402                                   | (cfi ? VLAN_CFI : 0));
 403             nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
 404                               &push, sizeof push);
 405
 406             return n;
 407         }
 408     }
 409
 410     if (!strncmp(s, "pop_vlan", 8)) {
 411         nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
 412         return 8;
 413     }
 414
 415     {
 416         double percentage;
 417         int n = -1;
 418
 419         if (sscanf(s, "sample(sample=%lf%%,actions(%n", &percentage, &n) > 0
 420             && percentage >= 0. && percentage <= 100.0
 421             && n > 0) {
 422             size_t sample_ofs, actions_ofs;
 423             double probability;
 424
 425             probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
 426             sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
 427             nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
 428                            (probability <= 0 ? 0
 429                             : probability >= UINT32_MAX ? UINT32_MAX
 430                             : probability));
 431
 432             actions_ofs = nl_msg_start_nested(actions,
 433                                               OVS_SAMPLE_ATTR_ACTIONS);
 434             for (;;) {
 435                 int retval;
 436
 437                 s += strspn(s, delimiters);
 438                 if (s[n] == ')') {
 439                     break;
 440                 }
 441
 442                 retval = parse_odp_action(s + n, port_names, actions);
 443                 if (retval < 0) {
 444                     return retval;
 445                 }
 446                 n += retval;
 447
 448             }
 449             nl_msg_end_nested(actions, actions_ofs);
 450             nl_msg_end_nested(actions, sample_ofs);
 451
 452             return s[n + 1] == ')' ? n + 2 : -EINVAL;
 453         }
 454     }
 455
 456     return -EINVAL;
 457 }
 458
 459 /* Parses the string representation of datapath actions, in the format output
 460  * by format_odp_action().  Returns 0 if successful, otherwise a positive errno
 461  * value.  On success, the ODP actions are appended to 'actions' as a series of
 462  * Netlink attributes.  On failure, no data is appended to 'actions'.  Either
 463  * way, 'actions''s data might be reallocated. */
 464 int
 465 odp_actions_from_string(const char *s, const struct shash *port_names,
 466                         struct ofpbuf *actions)
 467 {
 468     size_t old_size;
 469
 470     if (!strcasecmp(s, "drop")) {
 471         return 0;
 472     }
 473
 474     old_size = actions->size;
 475     for (;;) {
 476         int retval;
 477
 478         s += strspn(s, delimiters);
 479         if (!*s) {
 480             return 0;
 481         }
 482
 483         retval = parse_odp_action(s, port_names, actions);
 484         if (retval < 0 || !strchr(delimiters, s[retval])) {
 485             actions->size = old_size;
 486             return -retval;
 487         }
 488         s += retval;
 489     }
 490
 491     return 0;
 492 }
 493 \f
 494 /* Returns the correct length of the payload for a flow key attribute of the
 495  * specified 'type', -1 if 'type' is unknown, or -2 if the attribute's payload
 496  * is variable length. */
 497 static int
 498 odp_flow_key_attr_len(uint16_t type)
 499 {
 500     if (type > OVS_KEY_ATTR_MAX) {
 501         return -1;
 502     }
 503
 504     switch ((enum ovs_key_attr) type) {
 505     case OVS_KEY_ATTR_ENCAP: return -2;
 506     case OVS_KEY_ATTR_PRIORITY: return 4;
 507     case OVS_KEY_ATTR_TUN_ID: return 8;
 508     case OVS_KEY_ATTR_IN_PORT: return 4;
 509     case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
 510     case OVS_KEY_ATTR_VLAN: return sizeof(ovs_be16);
 511     case OVS_KEY_ATTR_ETHERTYPE: return 2;
 512     case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
 513     case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
 514     case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
 515     case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
 516     case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
 517     case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
 518     case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
 519     case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
 520
 521     case OVS_KEY_ATTR_UNSPEC:
 522     case __OVS_KEY_ATTR_MAX:
 523         return -1;
 524     }
 525
 526     return -1;
 527 }
 528
 529 static void
 530 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
 531 {
 532     size_t len = nl_attr_get_size(a);
 533     if (len) {
 534         const uint8_t *unspec;
 535         unsigned int i;
 536
 537         unspec = nl_attr_get(a);
 538         for (i = 0; i < len; i++) {
 539             ds_put_char(ds, i ? ' ': '(');
 540             ds_put_format(ds, "%02x", unspec[i]);
 541         }
 542         ds_put_char(ds, ')');
 543     }
 544 }
 545
 546 static const char *
 547 ovs_frag_type_to_string(enum ovs_frag_type type)
 548 {
 549     switch (type) {
 550     case OVS_FRAG_TYPE_NONE:
 551         return "no";
 552     case OVS_FRAG_TYPE_FIRST:
 553         return "first";
 554     case OVS_FRAG_TYPE_LATER:
 555         return "later";
 556     case __OVS_FRAG_TYPE_MAX:
 557     default:
 558         return "<error>";
 559     }
 560 }
 561
 562 static void
 563 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
 564 {
 565     const struct ovs_key_ethernet *eth_key;
 566     const struct ovs_key_ipv4 *ipv4_key;
 567     const struct ovs_key_ipv6 *ipv6_key;
 568     const struct ovs_key_tcp *tcp_key;
 569     const struct ovs_key_udp *udp_key;
 570     const struct ovs_key_icmp *icmp_key;
 571     const struct ovs_key_icmpv6 *icmpv6_key;
 572     const struct ovs_key_arp *arp_key;
 573     const struct ovs_key_nd *nd_key;
 574     enum ovs_key_attr attr = nl_attr_type(a);
 575     int expected_len;
 576
 577     ds_put_cstr(ds, ovs_key_attr_to_string(attr));
 578     expected_len = odp_flow_key_attr_len(nl_attr_type(a));
 579     if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
 580         ds_put_format(ds, "(bad length %zu, expected %d)",
 581                       nl_attr_get_size(a),
 582                       odp_flow_key_attr_len(nl_attr_type(a)));
 583         format_generic_odp_key(a, ds);
 584         return;
 585     }
 586
 587     switch (attr) {
 588     case OVS_KEY_ATTR_ENCAP:
 589         ds_put_cstr(ds, "(");
 590         if (nl_attr_get_size(a)) {
 591             odp_flow_key_format(nl_attr_get(a), nl_attr_get_size(a), ds);
 592         }
 593         ds_put_char(ds, ')');
 594         break;
 595
 596     case OVS_KEY_ATTR_PRIORITY:
 597         ds_put_format(ds, "(%"PRIu32")", nl_attr_get_u32(a));
 598         break;
 599
 600     case OVS_KEY_ATTR_TUN_ID:
 601         ds_put_format(ds, "(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
 602         break;
 603
 604     case OVS_KEY_ATTR_IN_PORT:
 605         ds_put_format(ds, "(%"PRIu32")", nl_attr_get_u32(a));
 606         break;
 607
 608     case OVS_KEY_ATTR_ETHERNET:
 609         eth_key = nl_attr_get(a);
 610         ds_put_format(ds, "(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
 611                       ETH_ADDR_ARGS(eth_key->eth_src),
 612                       ETH_ADDR_ARGS(eth_key->eth_dst));
 613         break;
 614
 615     case OVS_KEY_ATTR_VLAN:
 616         ds_put_char(ds, '(');
 617         format_vlan_tci(ds, nl_attr_get_be16(a));
 618         ds_put_char(ds, ')');
 619         break;
 620
 621     case OVS_KEY_ATTR_ETHERTYPE:
 622         ds_put_format(ds, "(0x%04"PRIx16")",
 623                       ntohs(nl_attr_get_be16(a)));
 624         break;
 625
 626     case OVS_KEY_ATTR_IPV4:
 627         ipv4_key = nl_attr_get(a);
 628         ds_put_format(ds, "(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
 629                       ",tos=%#"PRIx8",ttl=%"PRIu8",frag=%s)",
 630                       IP_ARGS(&ipv4_key->ipv4_src),
 631                       IP_ARGS(&ipv4_key->ipv4_dst),
 632                       ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
 633                       ipv4_key->ipv4_ttl,
 634                       ovs_frag_type_to_string(ipv4_key->ipv4_frag));
 635         break;
 636
 637     case OVS_KEY_ATTR_IPV6: {
 638         char src_str[INET6_ADDRSTRLEN];
 639         char dst_str[INET6_ADDRSTRLEN];
 640
 641         ipv6_key = nl_attr_get(a);
 642         inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
 643         inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
 644
 645         ds_put_format(ds, "(src=%s,dst=%s,label=%#"PRIx32",proto=%"PRIu8
 646                       ",tclass=%#"PRIx8",hlimit=%"PRIu8",frag=%s)",
 647                       src_str, dst_str, ntohl(ipv6_key->ipv6_label),
 648                       ipv6_key->ipv6_proto, ipv6_key->ipv6_tclass,
 649                       ipv6_key->ipv6_hlimit,
 650                       ovs_frag_type_to_string(ipv6_key->ipv6_frag));
 651         break;
 652     }
 653
 654     case OVS_KEY_ATTR_TCP:
 655         tcp_key = nl_attr_get(a);
 656         ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
 657                       ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
 658         break;
 659
 660     case OVS_KEY_ATTR_UDP:
 661         udp_key = nl_attr_get(a);
 662         ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
 663                       ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
 664         break;
 665
 666     case OVS_KEY_ATTR_ICMP:
 667         icmp_key = nl_attr_get(a);
 668         ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
 669                       icmp_key->icmp_type, icmp_key->icmp_code);
 670         break;
 671
 672     case OVS_KEY_ATTR_ICMPV6:
 673         icmpv6_key = nl_attr_get(a);
 674         ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
 675                       icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
 676         break;
 677
 678     case OVS_KEY_ATTR_ARP:
 679         arp_key = nl_attr_get(a);
 680         ds_put_format(ds, "(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
 681                       "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
 682                       IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
 683                       ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
 684                       ETH_ADDR_ARGS(arp_key->arp_tha));
 685         break;
 686
 687     case OVS_KEY_ATTR_ND: {
 688         char target[INET6_ADDRSTRLEN];
 689
 690         nd_key = nl_attr_get(a);
 691         inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
 692
 693         ds_put_format(ds, "(target=%s", target);
 694         if (!eth_addr_is_zero(nd_key->nd_sll)) {
 695             ds_put_format(ds, ",sll="ETH_ADDR_FMT,
 696                           ETH_ADDR_ARGS(nd_key->nd_sll));
 697         }
 698         if (!eth_addr_is_zero(nd_key->nd_tll)) {
 699             ds_put_format(ds, ",tll="ETH_ADDR_FMT,
 700                           ETH_ADDR_ARGS(nd_key->nd_tll));
 701         }
 702         ds_put_char(ds, ')');
 703         break;
 704     }
 705
 706     case OVS_KEY_ATTR_UNSPEC:
 707     case __OVS_KEY_ATTR_MAX:
 708     default:
 709         format_generic_odp_key(a, ds);
 710         break;
 711     }
 712 }
 713
 714 /* Appends to 'ds' a string representation of the 'key_len' bytes of
 715  * OVS_KEY_ATTR_* attributes in 'key'. */
 716 void
 717 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
 718 {
 719     if (key_len) {
 720         const struct nlattr *a;
 721         unsigned int left;
 722
 723         NL_ATTR_FOR_EACH (a, left, key, key_len) {
 724             if (a != key) {
 725                 ds_put_char(ds, ',');
 726             }
 727             format_odp_key_attr(a, ds);
 728         }
 729         if (left) {
 730             if (left == key_len) {
 731                 ds_put_cstr(ds, "<empty>");
 732             }
 733             ds_put_format(ds, ",***%u leftover bytes***", left);
 734         }
 735     } else {
 736         ds_put_cstr(ds, "<empty>");
 737     }
 738 }
 739
 740 static int
 741 put_nd_key(int n, const char *nd_target_s,
 742            const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
 743 {
 744     struct ovs_key_nd nd_key;
 745
 746     memset(&nd_key, 0, sizeof nd_key);
 747     if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
 748         return -EINVAL;
 749     }
 750     if (nd_sll) {
 751         memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
 752     }
 753     if (nd_tll) {
 754         memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
 755     }
 756     nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
 757     return n;
 758 }
 759
 760 static bool
 761 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
 762 {
 763     if (!strcasecmp(s, "no")) {
 764         *type = OVS_FRAG_TYPE_NONE;
 765     } else if (!strcasecmp(s, "first")) {
 766         *type = OVS_FRAG_TYPE_FIRST;
 767     } else if (!strcasecmp(s, "later")) {
 768         *type = OVS_FRAG_TYPE_LATER;
 769     } else {
 770         return false;
 771     }
 772     return true;
 773 }
 774
 775 static int
 776 parse_odp_key_attr(const char *s, const struct shash *port_names,
 777                    struct ofpbuf *key)
 778 {
 779     /* Many of the sscanf calls in this function use oversized destination
 780      * fields because some sscanf() implementations truncate the range of %i
 781      * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
 782      * value of 0x7fff.  The other alternatives are to allow only a single
 783      * radix (e.g. decimal or hexadecimal) or to write more sophisticated
 784      * parsers.
 785      *
 786      * The tun_id parser has to use an alternative approach because there is no
 787      * type larger than 64 bits. */
 788
 789     {
 790         unsigned long long int priority;
 791         int n = -1;
 792
 793         if (sscanf(s, "priority(%lli)%n", &priority, &n) > 0 && n > 0) {
 794             nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
 795             return n;
 796         }
 797     }
 798
 799     {
 800         char tun_id_s[32];
 801         int n = -1;
 802
 803         if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
 804                    tun_id_s, &n) > 0 && n > 0) {
 805             uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
 806             nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
 807             return n;
 808         }
 809     }
 810
 811     {
 812         unsigned long long int in_port;
 813         int n = -1;
 814
 815         if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
 816             nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
 817             return n;
 818         }
 819     }
 820
 821     if (port_names && !strncmp(s, "in_port(", 8)) {
 822         const char *name;
 823         const struct shash_node *node;
 824         int name_len;
 825
 826         name = s + 8;
 827         name_len = strcspn(s, ")");
 828         node = shash_find_len(port_names, name, name_len);
 829         if (node) {
 830             nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, (uintptr_t) node->data);
 831             return 8 + name_len + 1;
 832         }
 833     }
 834
 835     {
 836         struct ovs_key_ethernet eth_key;
 837         int n = -1;
 838
 839         if (sscanf(s,
 840                    "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
 841                    ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
 842                    ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
 843             nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
 844                               &eth_key, sizeof eth_key);
 845             return n;
 846         }
 847     }
 848
 849     {
 850         uint16_t vid;
 851         int pcp;
 852         int cfi;
 853         int n = -1;
 854
 855         if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n", &vid, &pcp, &n) > 0
 856              && n > 0)) {
 857             nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
 858                             htons((vid << VLAN_VID_SHIFT) |
 859                                   (pcp << VLAN_PCP_SHIFT) |
 860                                   VLAN_CFI));
 861             return n;
 862         } else if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i,cfi=%i)%n",
 863                            &vid, &pcp, &cfi, &n) > 0
 864              && n > 0)) {
 865             nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
 866                             htons((vid << VLAN_VID_SHIFT) |
 867                                   (pcp << VLAN_PCP_SHIFT) |
 868                                   (cfi ? VLAN_CFI : 0)));
 869             return n;
 870         }
 871     }
 872
 873     {
 874         int eth_type;
 875         int n = -1;
 876
 877         if (sscanf(s, "eth_type(%i)%n", &eth_type, &n) > 0 && n > 0) {
 878             nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
 879             return n;
 880         }
 881     }
 882
 883     {
 884         ovs_be32 ipv4_src;
 885         ovs_be32 ipv4_dst;
 886         int ipv4_proto;
 887         int ipv4_tos;
 888         int ipv4_ttl;
 889         char frag[8];
 890         enum ovs_frag_type ipv4_frag;
 891         int n = -1;
 892
 893         if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
 894                    "proto=%i,tos=%i,ttl=%i,frag=%7[a-z])%n",
 895                    IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
 896                    &ipv4_proto, &ipv4_tos, &ipv4_ttl, frag, &n) > 0
 897             && n > 0
 898             && ovs_frag_type_from_string(frag, &ipv4_frag)) {
 899             struct ovs_key_ipv4 ipv4_key;
 900
 901             ipv4_key.ipv4_src = ipv4_src;
 902             ipv4_key.ipv4_dst = ipv4_dst;
 903             ipv4_key.ipv4_proto = ipv4_proto;
 904             ipv4_key.ipv4_tos = ipv4_tos;
 905             ipv4_key.ipv4_ttl = ipv4_ttl;
 906             ipv4_key.ipv4_frag = ipv4_frag;
 907             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
 908                               &ipv4_key, sizeof ipv4_key);
 909             return n;
 910         }
 911     }
 912
 913     {
 914         char ipv6_src_s[IPV6_SCAN_LEN + 1];
 915         char ipv6_dst_s[IPV6_SCAN_LEN + 1];
 916         int ipv6_label;
 917         int ipv6_proto;
 918         int ipv6_tclass;
 919         int ipv6_hlimit;
 920         char frag[8];
 921         enum ovs_frag_type ipv6_frag;
 922         int n = -1;
 923
 924         if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
 925                    "label=%i,proto=%i,tclass=%i,hlimit=%i,frag=%7[a-z])%n",
 926                    ipv6_src_s, ipv6_dst_s, &ipv6_label,
 927                    &ipv6_proto, &ipv6_tclass, &ipv6_hlimit, frag, &n) > 0
 928             && n > 0
 929             && ovs_frag_type_from_string(frag, &ipv6_frag)) {
 930             struct ovs_key_ipv6 ipv6_key;
 931
 932             if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
 933                 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
 934                 return -EINVAL;
 935             }
 936             ipv6_key.ipv6_label = htonl(ipv6_label);
 937             ipv6_key.ipv6_proto = ipv6_proto;
 938             ipv6_key.ipv6_tclass = ipv6_tclass;
 939             ipv6_key.ipv6_hlimit = ipv6_hlimit;
 940             ipv6_key.ipv6_frag = ipv6_frag;
 941             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
 942                               &ipv6_key, sizeof ipv6_key);
 943             return n;
 944         }
 945     }
 946
 947     {
 948         int tcp_src;
 949         int tcp_dst;
 950         int n = -1;
 951
 952         if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
 953             && n > 0) {
 954             struct ovs_key_tcp tcp_key;
 955
 956             tcp_key.tcp_src = htons(tcp_src);
 957             tcp_key.tcp_dst = htons(tcp_dst);
 958             nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
 959             return n;
 960         }
 961     }
 962
 963     {
 964         int udp_src;
 965         int udp_dst;
 966         int n = -1;
 967
 968         if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
 969             && n > 0) {
 970             struct ovs_key_udp udp_key;
 971
 972             udp_key.udp_src = htons(udp_src);
 973             udp_key.udp_dst = htons(udp_dst);
 974             nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
 975             return n;
 976         }
 977     }
 978
 979     {
 980         int icmp_type;
 981         int icmp_code;
 982         int n = -1;
 983
 984         if (sscanf(s, "icmp(type=%i,code=%i)%n",
 985                    &icmp_type, &icmp_code, &n) > 0
 986             && n > 0) {
 987             struct ovs_key_icmp icmp_key;
 988
 989             icmp_key.icmp_type = icmp_type;
 990             icmp_key.icmp_code = icmp_code;
 991             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
 992                               &icmp_key, sizeof icmp_key);
 993             return n;
 994         }
 995     }
 996
 997     {
 998         struct ovs_key_icmpv6 icmpv6_key;
 999         int n = -1;
1000
1001         if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
1002                    &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
1003             && n > 0) {
1004             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
1005                               &icmpv6_key, sizeof icmpv6_key);
1006             return n;
1007         }
1008     }
1009
1010     {
1011         ovs_be32 arp_sip;
1012         ovs_be32 arp_tip;
1013         int arp_op;
1014         uint8_t arp_sha[ETH_ADDR_LEN];
1015         uint8_t arp_tha[ETH_ADDR_LEN];
1016         int n = -1;
1017
1018         if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
1019                    "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
1020                    IP_SCAN_ARGS(&arp_sip),
1021                    IP_SCAN_ARGS(&arp_tip),
1022                    &arp_op,
1023                    ETH_ADDR_SCAN_ARGS(arp_sha),
1024                    ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
1025             struct ovs_key_arp arp_key;
1026
1027             memset(&arp_key, 0, sizeof arp_key);
1028             arp_key.arp_sip = arp_sip;
1029             arp_key.arp_tip = arp_tip;
1030             arp_key.arp_op = htons(arp_op);
1031             memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
1032             memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
1033             nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
1034             return n;
1035         }
1036     }
1037
1038     {
1039         char nd_target_s[IPV6_SCAN_LEN + 1];
1040         uint8_t nd_sll[ETH_ADDR_LEN];
1041         uint8_t nd_tll[ETH_ADDR_LEN];
1042         int n = -1;
1043
1044         if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
1045                    nd_target_s, &n) > 0 && n > 0) {
1046             return put_nd_key(n, nd_target_s, NULL, NULL, key);
1047         }
1048         if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
1049                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
1050             && n > 0) {
1051             return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
1052         }
1053         if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
1054                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
1055             && n > 0) {
1056             return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
1057         }
1058         if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
1059                    "tll="ETH_ADDR_SCAN_FMT")%n",
1060                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
1061                    ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
1062             && n > 0) {
1063             return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
1064         }
1065     }
1066
1067     if (!strncmp(s, "encap(", 6)) {
1068         const char *start = s;
1069         size_t encap;
1070
1071         encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
1072
1073         s += 6;
1074         for (;;) {
1075             int retval;
1076
1077             s += strspn(s, ", \t\r\n");
1078             if (!*s) {
1079                 return -EINVAL;
1080             } else if (*s == ')') {
1081                 break;
1082             }
1083
1084             retval = parse_odp_key_attr(s, port_names, key);
1085             if (retval < 0) {
1086                 return retval;
1087             }
1088             s += retval;
1089         }
1090         s++;
1091
1092         nl_msg_end_nested(key, encap);
1093
1094         return s - start;
1095     }
1096
1097     return -EINVAL;
1098 }
1099
1100 /* Parses the string representation of a datapath flow key, in the
1101  * format output by odp_flow_key_format().  Returns 0 if successful,
1102  * otherwise a positive errno value.  On success, the flow key is
1103  * appended to 'key' as a series of Netlink attributes.  On failure, no
1104  * data is appended to 'key'.  Either way, 'key''s data might be
1105  * reallocated.
1106  *
1107  * If 'port_names' is nonnull, it points to an shash that maps from a port name
1108  * to a port number cast to void *.  (Port names may be used instead of port
1109  * numbers in in_port.)
1110  *
1111  * On success, the attributes appended to 'key' are individually syntactically
1112  * valid, but they may not be valid as a sequence.  'key' might, for example,
1113  * have duplicated keys.  odp_flow_key_to_flow() will detect those errors. */
1114 int
1115 odp_flow_key_from_string(const char *s, const struct shash *port_names,
1116                          struct ofpbuf *key)
1117 {
1118     const size_t old_size = key->size;
1119     for (;;) {
1120         int retval;
1121
1122         s += strspn(s, delimiters);
1123         if (!*s) {
1124             return 0;
1125         }
1126
1127         retval = parse_odp_key_attr(s, port_names, key);
1128         if (retval < 0) {
1129             key->size = old_size;
1130             return -retval;
1131         }
1132         s += retval;
1133     }
1134
1135     return 0;
1136 }
1137
1138 static uint8_t
1139 ovs_to_odp_frag(uint8_t nw_frag)
1140 {
1141     return (nw_frag == 0 ? OVS_FRAG_TYPE_NONE
1142           : nw_frag == FLOW_NW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
1143           : OVS_FRAG_TYPE_LATER);
1144 }
1145
1146 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
1147 void
1148 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
1149 {
1150     struct ovs_key_ethernet *eth_key;
1151     size_t encap;
1152
1153     if (flow->skb_priority) {
1154         nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, flow->skb_priority);
1155     }
1156
1157     if (flow->tun_id != htonll(0)) {
1158         nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
1159     }
1160
1161     if (flow->in_port != OFPP_NONE) {
1162         nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
1163                        ofp_port_to_odp_port(flow->in_port));
1164     }
1165
1166     eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
1167                                        sizeof *eth_key);
1168     memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
1169     memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
1170
1171     if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
1172         nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
1173         nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, flow->vlan_tci);
1174         encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
1175         if (flow->vlan_tci == htons(0)) {
1176             goto unencap;
1177         }
1178     } else {
1179         encap = 0;
1180     }
1181
1182     if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
1183         goto unencap;
1184     }
1185
1186     nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
1187
1188     if (flow->dl_type == htons(ETH_TYPE_IP)) {
1189         struct ovs_key_ipv4 *ipv4_key;
1190
1191         ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
1192                                             sizeof *ipv4_key);
1193         ipv4_key->ipv4_src = flow->nw_src;
1194         ipv4_key->ipv4_dst = flow->nw_dst;
1195         ipv4_key->ipv4_proto = flow->nw_proto;
1196         ipv4_key->ipv4_tos = flow->nw_tos;
1197         ipv4_key->ipv4_ttl = flow->nw_ttl;
1198         ipv4_key->ipv4_frag = ovs_to_odp_frag(flow->nw_frag);
1199     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1200         struct ovs_key_ipv6 *ipv6_key;
1201
1202         ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
1203                                             sizeof *ipv6_key);
1204         memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
1205         memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
1206         ipv6_key->ipv6_label = flow->ipv6_label;
1207         ipv6_key->ipv6_proto = flow->nw_proto;
1208         ipv6_key->ipv6_tclass = flow->nw_tos;
1209         ipv6_key->ipv6_hlimit = flow->nw_ttl;
1210         ipv6_key->ipv6_frag = ovs_to_odp_frag(flow->nw_frag);
1211     } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
1212         struct ovs_key_arp *arp_key;
1213
1214         arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
1215                                            sizeof *arp_key);
1216         memset(arp_key, 0, sizeof *arp_key);
1217         arp_key->arp_sip = flow->nw_src;
1218         arp_key->arp_tip = flow->nw_dst;
1219         arp_key->arp_op = htons(flow->nw_proto);
1220         memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
1221         memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
1222     }
1223
1224     if ((flow->dl_type == htons(ETH_TYPE_IP)
1225          || flow->dl_type == htons(ETH_TYPE_IPV6))
1226         && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1227
1228         if (flow->nw_proto == IPPROTO_TCP) {
1229             struct ovs_key_tcp *tcp_key;
1230
1231             tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
1232                                                sizeof *tcp_key);
1233             tcp_key->tcp_src = flow->tp_src;
1234             tcp_key->tcp_dst = flow->tp_dst;
1235         } else if (flow->nw_proto == IPPROTO_UDP) {
1236             struct ovs_key_udp *udp_key;
1237
1238             udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
1239                                                sizeof *udp_key);
1240             udp_key->udp_src = flow->tp_src;
1241             udp_key->udp_dst = flow->tp_dst;
1242         } else if (flow->dl_type == htons(ETH_TYPE_IP)
1243                 && flow->nw_proto == IPPROTO_ICMP) {
1244             struct ovs_key_icmp *icmp_key;
1245
1246             icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
1247                                                 sizeof *icmp_key);
1248             icmp_key->icmp_type = ntohs(flow->tp_src);
1249             icmp_key->icmp_code = ntohs(flow->tp_dst);
1250         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
1251                 && flow->nw_proto == IPPROTO_ICMPV6) {
1252             struct ovs_key_icmpv6 *icmpv6_key;
1253
1254             icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
1255                                                   sizeof *icmpv6_key);
1256             icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
1257             icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
1258
1259             if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
1260                     || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
1261                 struct ovs_key_nd *nd_key;
1262
1263                 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
1264                                                     sizeof *nd_key);
1265                 memcpy(nd_key->nd_target, &flow->nd_target,
1266                         sizeof nd_key->nd_target);
1267                 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
1268                 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
1269             }
1270         }
1271     }
1272
1273 unencap:
1274     if (encap) {
1275         nl_msg_end_nested(buf, encap);
1276     }
1277 }
1278
1279 uint32_t
1280 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
1281 {
1282     BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
1283     return hash_words((const uint32_t *) key, key_len / sizeof(uint32_t), 0);
1284 }
1285
1286 static void
1287 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
1288                        uint64_t attrs, int out_of_range_attr,
1289                        const struct nlattr *key, size_t key_len)
1290 {
1291     struct ds s;
1292     int i;
1293
1294     if (VLOG_DROP_DBG(rl)) {
1295         return;
1296     }
1297
1298     ds_init(&s);
1299     for (i = 0; i < 64; i++) {
1300         if (attrs & (UINT64_C(1) << i)) {
1301             ds_put_format(&s, " %s", ovs_key_attr_to_string(i));
1302         }
1303     }
1304     if (out_of_range_attr) {
1305         ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
1306     }
1307
1308     ds_put_cstr(&s, ": ");
1309     odp_flow_key_format(key, key_len, &s);
1310
1311     VLOG_DBG("%s:%s", title, ds_cstr(&s));
1312     ds_destroy(&s);
1313 }
1314
1315 static bool
1316 odp_to_ovs_frag(uint8_t odp_frag, struct flow *flow)
1317 {
1318     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1319
1320     if (odp_frag > OVS_FRAG_TYPE_LATER) {
1321         VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
1322         return false;
1323     }
1324
1325     if (odp_frag != OVS_FRAG_TYPE_NONE) {
1326         flow->nw_frag |= FLOW_NW_FRAG_ANY;
1327         if (odp_frag == OVS_FRAG_TYPE_LATER) {
1328             flow->nw_frag |= FLOW_NW_FRAG_LATER;
1329         }
1330     }
1331     return true;
1332 }
1333
1334 static bool
1335 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
1336                    const struct nlattr *attrs[], uint64_t *present_attrsp,
1337                    int *out_of_range_attrp)
1338 {
1339     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
1340     const struct nlattr *nla;
1341     uint64_t present_attrs;
1342     size_t left;
1343
1344     present_attrs = 0;
1345     *out_of_range_attrp = 0;
1346     NL_ATTR_FOR_EACH (nla, left, key, key_len) {
1347         uint16_t type = nl_attr_type(nla);
1348         size_t len = nl_attr_get_size(nla);
1349         int expected_len = odp_flow_key_attr_len(type);
1350
1351         if (len != expected_len && expected_len >= 0) {
1352             VLOG_ERR_RL(&rl, "attribute %s has length %zu but should have "
1353                         "length %d", ovs_key_attr_to_string(type),
1354                         len, expected_len);
1355             return false;
1356         }
1357
1358         if (type >= CHAR_BIT * sizeof present_attrs) {
1359             *out_of_range_attrp = type;
1360         } else {
1361             if (present_attrs & (UINT64_C(1) << type)) {
1362                 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
1363                             ovs_key_attr_to_string(type));
1364                 return false;
1365             }
1366
1367             present_attrs |= UINT64_C(1) << type;
1368             attrs[type] = nla;
1369         }
1370     }
1371     if (left) {
1372         VLOG_ERR_RL(&rl, "trailing garbage in flow key");
1373         return false;
1374     }
1375
1376     *present_attrsp = present_attrs;
1377     return true;
1378 }
1379
1380 static enum odp_key_fitness
1381 check_expectations(uint64_t present_attrs, int out_of_range_attr,
1382                    uint64_t expected_attrs,
1383                    const struct nlattr *key, size_t key_len)
1384 {
1385     uint64_t missing_attrs;
1386     uint64_t extra_attrs;
1387
1388     missing_attrs = expected_attrs & ~present_attrs;
1389     if (missing_attrs) {
1390         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
1391         log_odp_key_attributes(&rl, "expected but not present",
1392                                missing_attrs, 0, key, key_len);
1393         return ODP_FIT_TOO_LITTLE;
1394     }
1395
1396     extra_attrs = present_attrs & ~expected_attrs;
1397     if (extra_attrs || out_of_range_attr) {
1398         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
1399         log_odp_key_attributes(&rl, "present but not expected",
1400                                extra_attrs, out_of_range_attr, key, key_len);
1401         return ODP_FIT_TOO_MUCH;
1402     }
1403
1404     return ODP_FIT_PERFECT;
1405 }
1406
1407 static bool
1408 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
1409                 uint64_t present_attrs, uint64_t *expected_attrs,
1410                 struct flow *flow)
1411 {
1412     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1413
1414     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
1415         flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
1416         if (ntohs(flow->dl_type) < 1536) {
1417             VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
1418                         ntohs(flow->dl_type));
1419             return false;
1420         }
1421         *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
1422     } else {
1423         flow->dl_type = htons(FLOW_DL_TYPE_NONE);
1424     }
1425     return true;
1426 }
1427
1428 static enum odp_key_fitness
1429 parse_l3_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
1430                 uint64_t present_attrs, int out_of_range_attr,
1431                 uint64_t expected_attrs, struct flow *flow,
1432                 const struct nlattr *key, size_t key_len)
1433 {
1434     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1435
1436     if (flow->dl_type == htons(ETH_TYPE_IP)) {
1437         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
1438         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
1439             const struct ovs_key_ipv4 *ipv4_key;
1440
1441             ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
1442             flow->nw_src = ipv4_key->ipv4_src;
1443             flow->nw_dst = ipv4_key->ipv4_dst;
1444             flow->nw_proto = ipv4_key->ipv4_proto;
1445             flow->nw_tos = ipv4_key->ipv4_tos;
1446             flow->nw_ttl = ipv4_key->ipv4_ttl;
1447             if (!odp_to_ovs_frag(ipv4_key->ipv4_frag, flow)) {
1448                 return ODP_FIT_ERROR;
1449             }
1450         }
1451     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1452         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
1453         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
1454             const struct ovs_key_ipv6 *ipv6_key;
1455
1456             ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
1457             memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
1458             memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
1459             flow->ipv6_label = ipv6_key->ipv6_label;
1460             flow->nw_proto = ipv6_key->ipv6_proto;
1461             flow->nw_tos = ipv6_key->ipv6_tclass;
1462             flow->nw_ttl = ipv6_key->ipv6_hlimit;
1463             if (!odp_to_ovs_frag(ipv6_key->ipv6_frag, flow)) {
1464                 return ODP_FIT_ERROR;
1465             }
1466         }
1467     } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
1468         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
1469         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
1470             const struct ovs_key_arp *arp_key;
1471
1472             arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
1473             flow->nw_src = arp_key->arp_sip;
1474             flow->nw_dst = arp_key->arp_tip;
1475             if (arp_key->arp_op & htons(0xff00)) {
1476                 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
1477                             "key", ntohs(arp_key->arp_op));
1478                 return ODP_FIT_ERROR;
1479             }
1480             flow->nw_proto = ntohs(arp_key->arp_op);
1481             memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1482             memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1483         }
1484     }
1485
1486     if (flow->nw_proto == IPPROTO_TCP
1487         && (flow->dl_type == htons(ETH_TYPE_IP) ||
1488             flow->dl_type == htons(ETH_TYPE_IPV6))
1489         && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1490         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
1491         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
1492             const struct ovs_key_tcp *tcp_key;
1493
1494             tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
1495             flow->tp_src = tcp_key->tcp_src;
1496             flow->tp_dst = tcp_key->tcp_dst;
1497         }
1498     } else if (flow->nw_proto == IPPROTO_UDP
1499                && (flow->dl_type == htons(ETH_TYPE_IP) ||
1500                    flow->dl_type == htons(ETH_TYPE_IPV6))
1501                && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1502         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
1503         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
1504             const struct ovs_key_udp *udp_key;
1505
1506             udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
1507             flow->tp_src = udp_key->udp_src;
1508             flow->tp_dst = udp_key->udp_dst;
1509         }
1510     } else if (flow->nw_proto == IPPROTO_ICMP
1511                && flow->dl_type == htons(ETH_TYPE_IP)
1512                && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1513         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
1514         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
1515             const struct ovs_key_icmp *icmp_key;
1516
1517             icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
1518             flow->tp_src = htons(icmp_key->icmp_type);
1519             flow->tp_dst = htons(icmp_key->icmp_code);
1520         }
1521     } else if (flow->nw_proto == IPPROTO_ICMPV6
1522                && flow->dl_type == htons(ETH_TYPE_IPV6)
1523                && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1524         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
1525         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
1526             const struct ovs_key_icmpv6 *icmpv6_key;
1527
1528             icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
1529             flow->tp_src = htons(icmpv6_key->icmpv6_type);
1530             flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1531
1532             if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1533                 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
1534                 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
1535                 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
1536                     const struct ovs_key_nd *nd_key;
1537
1538                     nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
1539                     memcpy(&flow->nd_target, nd_key->nd_target,
1540                            sizeof flow->nd_target);
1541                     memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1542                     memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1543                 }
1544             }
1545         }
1546     }
1547
1548     return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
1549                               key, key_len);
1550 }
1551
1552 /* Parse 802.1Q header then encapsulated L3 attributes. */
1553 static enum odp_key_fitness
1554 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
1555                    uint64_t present_attrs, int out_of_range_attr,
1556                    uint64_t expected_attrs, struct flow *flow,
1557                    const struct nlattr *key, size_t key_len)
1558 {
1559     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1560
1561     const struct nlattr *encap
1562         = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
1563            ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
1564     enum odp_key_fitness encap_fitness;
1565     enum odp_key_fitness fitness;
1566     ovs_be16 tci;
1567
1568     /* Calulate fitness of outer attributes. */
1569     expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
1570                        (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
1571     fitness = check_expectations(present_attrs, out_of_range_attr,
1572                                  expected_attrs, key, key_len);
1573
1574     /* Get the VLAN TCI value. */
1575     if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
1576         return ODP_FIT_TOO_LITTLE;
1577     }
1578     tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
1579     if (tci == htons(0)) {
1580         /* Corner case for a truncated 802.1Q header. */
1581         if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
1582             return ODP_FIT_TOO_MUCH;
1583         }
1584         return fitness;
1585     } else if (!(tci & htons(VLAN_CFI))) {
1586         VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
1587                     "but CFI bit is not set", ntohs(tci));
1588         return ODP_FIT_ERROR;
1589     }
1590
1591     /* Set vlan_tci.
1592      * Remove the TPID from dl_type since it's not the real Ethertype.  */
1593     flow->vlan_tci = tci;
1594     flow->dl_type = htons(0);
1595
1596     /* Now parse the encapsulated attributes. */
1597     if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
1598                             attrs, &present_attrs, &out_of_range_attr)) {
1599         return ODP_FIT_ERROR;
1600     }
1601     expected_attrs = 0;
1602
1603     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow)) {
1604         return ODP_FIT_ERROR;
1605     }
1606     encap_fitness = parse_l3_onward(attrs, present_attrs, out_of_range_attr,
1607                                     expected_attrs, flow, key, key_len);
1608
1609     /* The overall fitness is the worse of the outer and inner attributes. */
1610     return MAX(fitness, encap_fitness);
1611 }
1612
1613 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
1614  * structure in 'flow'.  Returns an ODP_FIT_* value that indicates how well
1615  * 'key' fits our expectations for what a flow key should contain.
1616  *
1617  * This function doesn't take the packet itself as an argument because none of
1618  * the currently understood OVS_KEY_ATTR_* attributes require it.  Currently,
1619  * it is always possible to infer which additional attribute(s) should appear
1620  * by looking at the attributes for lower-level protocols, e.g. if the network
1621  * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
1622  * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
1623  * must be absent. */
1624 enum odp_key_fitness
1625 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
1626                      struct flow *flow)
1627 {
1628     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1629     const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
1630     uint64_t expected_attrs;
1631     uint64_t present_attrs;
1632     int out_of_range_attr;
1633
1634     memset(flow, 0, sizeof *flow);
1635
1636     /* Parse attributes. */
1637     if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
1638                             &out_of_range_attr)) {
1639         return ODP_FIT_ERROR;
1640     }
1641     expected_attrs = 0;
1642
1643     /* Metadata. */
1644     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
1645         flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
1646         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
1647     }
1648
1649     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUN_ID)) {
1650         flow->tun_id = nl_attr_get_be64(attrs[OVS_KEY_ATTR_TUN_ID]);
1651         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUN_ID;
1652     }
1653
1654     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
1655         uint32_t in_port = nl_attr_get_u32(attrs[OVS_KEY_ATTR_IN_PORT]);
1656         if (in_port >= UINT16_MAX || in_port >= OFPP_MAX) {
1657             VLOG_ERR_RL(&rl, "in_port %"PRIu32" out of supported range",
1658                         in_port);
1659             return ODP_FIT_ERROR;
1660         }
1661         flow->in_port = odp_port_to_ofp_port(in_port);
1662         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
1663     } else {
1664         flow->in_port = OFPP_NONE;
1665     }
1666
1667     /* Ethernet header. */
1668     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
1669         const struct ovs_key_ethernet *eth_key;
1670
1671         eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
1672         memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
1673         memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
1674     }
1675     expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
1676
1677     /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
1678     if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow)) {
1679         return ODP_FIT_ERROR;
1680     }
1681
1682     if (flow->dl_type == htons(ETH_TYPE_VLAN)) {
1683         return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
1684                                   expected_attrs, flow, key, key_len);
1685     }
1686     return parse_l3_onward(attrs, present_attrs, out_of_range_attr,
1687                            expected_attrs, flow, key, key_len);
1688 }
1689
1690 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
1691  * Netlink PID 'pid'.  If 'cookie' is nonnull, adds a userdata attribute whose
1692  * contents contains 'cookie' and returns the offset within 'odp_actions' of
1693  * the start of the cookie.  (If 'cookie' is null, then the return value is not
1694  * meaningful.) */
1695 size_t
1696 odp_put_userspace_action(uint32_t pid, const struct user_action_cookie *cookie,
1697                          struct ofpbuf *odp_actions)
1698 {
1699     size_t offset;
1700
1701     offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
1702     nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
1703     if (cookie) {
1704         nl_msg_put_unspec(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
1705                           cookie, sizeof *cookie);
1706     }
1707     nl_msg_end_nested(odp_actions, offset);
1708
1709     return cookie ? odp_actions->size - NLA_ALIGN(sizeof *cookie) : 0;
1710 }
1711 \f
1712 /* The commit_odp_actions() function and its helpers. */
1713
1714 static void
1715 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
1716                   const void *key, size_t key_size)
1717 {
1718     size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
1719     nl_msg_put_unspec(odp_actions, key_type, key, key_size);
1720     nl_msg_end_nested(odp_actions, offset);
1721 }
1722
1723 static void
1724 commit_set_tun_id_action(const struct flow *flow, struct flow *base,
1725                          struct ofpbuf *odp_actions)
1726 {
1727     if (base->tun_id == flow->tun_id) {
1728         return;
1729     }
1730     base->tun_id = flow->tun_id;
1731
1732     commit_set_action(odp_actions, OVS_KEY_ATTR_TUN_ID,
1733                       &base->tun_id, sizeof(base->tun_id));
1734 }
1735
1736 static void
1737 commit_set_ether_addr_action(const struct flow *flow, struct flow *base,
1738                              struct ofpbuf *odp_actions)
1739 {
1740     struct ovs_key_ethernet eth_key;
1741
1742     if (eth_addr_equals(base->dl_src, flow->dl_src) &&
1743         eth_addr_equals(base->dl_dst, flow->dl_dst)) {
1744         return;
1745     }
1746
1747     memcpy(base->dl_src, flow->dl_src, ETH_ADDR_LEN);
1748     memcpy(base->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
1749
1750     memcpy(eth_key.eth_src, base->dl_src, ETH_ADDR_LEN);
1751     memcpy(eth_key.eth_dst, base->dl_dst, ETH_ADDR_LEN);
1752
1753     commit_set_action(odp_actions, OVS_KEY_ATTR_ETHERNET,
1754                       &eth_key, sizeof(eth_key));
1755 }
1756
1757 static void
1758 commit_vlan_action(const struct flow *flow, struct flow *base,
1759                    struct ofpbuf *odp_actions)
1760 {
1761     if (base->vlan_tci == flow->vlan_tci) {
1762         return;
1763     }
1764
1765     if (base->vlan_tci & htons(VLAN_CFI)) {
1766         nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
1767     }
1768
1769     if (flow->vlan_tci & htons(VLAN_CFI)) {
1770         struct ovs_action_push_vlan vlan;
1771
1772         vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
1773         vlan.vlan_tci = flow->vlan_tci;
1774         nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
1775                           &vlan, sizeof vlan);
1776     }
1777     base->vlan_tci = flow->vlan_tci;
1778 }
1779
1780 static void
1781 commit_set_ipv4_action(const struct flow *flow, struct flow *base,
1782                      struct ofpbuf *odp_actions)
1783 {
1784     struct ovs_key_ipv4 ipv4_key;
1785
1786     if (base->nw_src == flow->nw_src &&
1787         base->nw_dst == flow->nw_dst &&
1788         base->nw_tos == flow->nw_tos &&
1789         base->nw_ttl == flow->nw_ttl &&
1790         base->nw_frag == flow->nw_frag) {
1791         return;
1792     }
1793
1794     ipv4_key.ipv4_src = base->nw_src = flow->nw_src;
1795     ipv4_key.ipv4_dst = base->nw_dst = flow->nw_dst;
1796     ipv4_key.ipv4_tos = base->nw_tos = flow->nw_tos;
1797     ipv4_key.ipv4_ttl = base->nw_ttl = flow->nw_ttl;
1798     ipv4_key.ipv4_proto = base->nw_proto;
1799     ipv4_key.ipv4_frag = ovs_to_odp_frag(base->nw_frag);
1800
1801     commit_set_action(odp_actions, OVS_KEY_ATTR_IPV4,
1802                       &ipv4_key, sizeof(ipv4_key));
1803 }
1804
1805 static void
1806 commit_set_ipv6_action(const struct flow *flow, struct flow *base,
1807                        struct ofpbuf *odp_actions)
1808 {
1809     struct ovs_key_ipv6 ipv6_key;
1810
1811     if (ipv6_addr_equals(&base->ipv6_src, &flow->ipv6_src) &&
1812         ipv6_addr_equals(&base->ipv6_dst, &flow->ipv6_dst) &&
1813         base->ipv6_label == flow->ipv6_label &&
1814         base->nw_tos == flow->nw_tos &&
1815         base->nw_ttl == flow->nw_ttl &&
1816         base->nw_frag == flow->nw_frag) {
1817         return;
1818     }
1819
1820     base->ipv6_src = flow->ipv6_src;
1821     memcpy(&ipv6_key.ipv6_src, &base->ipv6_src, sizeof(ipv6_key.ipv6_src));
1822     base->ipv6_dst = flow->ipv6_dst;
1823     memcpy(&ipv6_key.ipv6_dst, &base->ipv6_dst, sizeof(ipv6_key.ipv6_dst));
1824
1825     ipv6_key.ipv6_label = base->ipv6_label = flow->ipv6_label;
1826     ipv6_key.ipv6_tclass = base->nw_tos = flow->nw_tos;
1827     ipv6_key.ipv6_hlimit = base->nw_ttl = flow->nw_ttl;
1828     ipv6_key.ipv6_proto = base->nw_proto;
1829     ipv6_key.ipv6_frag = ovs_to_odp_frag(base->nw_frag);
1830
1831     commit_set_action(odp_actions, OVS_KEY_ATTR_IPV6,
1832                       &ipv6_key, sizeof(ipv6_key));
1833 }
1834
1835 static void
1836 commit_set_nw_action(const struct flow *flow, struct flow *base,
1837                      struct ofpbuf *odp_actions)
1838 {
1839     /* Check if flow really have an IP header. */
1840     if (!flow->nw_proto) {
1841         return;
1842     }
1843
1844     if (base->dl_type == htons(ETH_TYPE_IP)) {
1845         commit_set_ipv4_action(flow, base, odp_actions);
1846     } else if (base->dl_type == htons(ETH_TYPE_IPV6)) {
1847         commit_set_ipv6_action(flow, base, odp_actions);
1848     }
1849 }
1850
1851 static void
1852 commit_set_port_action(const struct flow *flow, struct flow *base,
1853                        struct ofpbuf *odp_actions)
1854 {
1855     if (!base->tp_src || !base->tp_dst) {
1856         return;
1857     }
1858
1859     if (base->tp_src == flow->tp_src &&
1860         base->tp_dst == flow->tp_dst) {
1861         return;
1862     }
1863
1864     if (flow->nw_proto == IPPROTO_TCP) {
1865         struct ovs_key_tcp port_key;
1866
1867         port_key.tcp_src = base->tp_src = flow->tp_src;
1868         port_key.tcp_dst = base->tp_dst = flow->tp_dst;
1869
1870         commit_set_action(odp_actions, OVS_KEY_ATTR_TCP,
1871                           &port_key, sizeof(port_key));
1872
1873     } else if (flow->nw_proto == IPPROTO_UDP) {
1874         struct ovs_key_udp port_key;
1875
1876         port_key.udp_src = base->tp_src = flow->tp_src;
1877         port_key.udp_dst = base->tp_dst = flow->tp_dst;
1878
1879         commit_set_action(odp_actions, OVS_KEY_ATTR_UDP,
1880                           &port_key, sizeof(port_key));
1881     }
1882 }
1883
1884 static void
1885 commit_set_priority_action(const struct flow *flow, struct flow *base,
1886                            struct ofpbuf *odp_actions)
1887 {
1888     if (base->skb_priority == flow->skb_priority) {
1889         return;
1890     }
1891     base->skb_priority = flow->skb_priority;
1892
1893     commit_set_action(odp_actions, OVS_KEY_ATTR_PRIORITY,
1894                       &base->skb_priority, sizeof(base->skb_priority));
1895 }
1896
1897 /* If any of the flow key data that ODP actions can modify are different in
1898  * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
1899  * key from 'base' into 'flow', and then changes 'base' the same way. */
1900 void
1901 commit_odp_actions(const struct flow *flow, struct flow *base,
1902                    struct ofpbuf *odp_actions)
1903 {
1904     commit_set_tun_id_action(flow, base, odp_actions);
1905     commit_set_ether_addr_action(flow, base, odp_actions);
1906     commit_vlan_action(flow, base, odp_actions);
1907     commit_set_nw_action(flow, base, odp_actions);
1908     commit_set_port_action(flow, base, odp_actions);
1909     commit_set_priority_action(flow, base, odp_actions);
1910 }