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 <netinet/in.h>
  23 #include <netinet/icmp6.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include "byte-order.h"
  27 #include "coverage.h"
  28 #include "dynamic-string.h"
  29 #include "flow.h"
  30 #include "netlink.h"
  31 #include "ofpbuf.h"
  32 #include "openvswitch/tunnel.h"
  33 #include "packets.h"
  34 #include "timeval.h"
  35 #include "util.h"
  36 #include "vlog.h"
  37
  38 VLOG_DEFINE_THIS_MODULE(odp_util);
  39
  40 /* The interface between userspace and kernel uses an "OVS_*" prefix.
  41  * Since this is fairly non-specific for the OVS userspace components,
  42  * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
  43  * interactions with the datapath.
  44  */
  45
  46 static void format_odp_key_attr(const struct nlattr *a, struct ds *ds);
  47
  48 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
  49  * 'type':
  50  *
  51  *   - For an action whose argument has a fixed length, returned that
  52  *     nonnegative length in bytes.
  53  *
  54  *   - For an action with a variable-length argument, returns -2.
  55  *
  56  *   - For an invalid 'type', returns -1. */
  57 static int
  58 odp_action_len(uint16_t type)
  59 {
  60     if (type > OVS_ACTION_ATTR_MAX) {
  61         return -1;
  62     }
  63
  64     switch ((enum ovs_action_attr) type) {
  65     case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
  66     case OVS_ACTION_ATTR_USERSPACE: return -2;
  67     case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
  68     case OVS_ACTION_ATTR_POP_VLAN: return 0;
  69     case OVS_ACTION_ATTR_SET: return -2;
  70     case OVS_ACTION_ATTR_SAMPLE: return -2;
  71
  72     case OVS_ACTION_ATTR_UNSPEC:
  73     case __OVS_ACTION_ATTR_MAX:
  74         return -1;
  75     }
  76
  77     return -1;
  78 }
  79
  80 static const char *
  81 ovs_key_attr_to_string(enum ovs_key_attr attr)
  82 {
  83     static char unknown_attr[3 + INT_STRLEN(unsigned int) + 1];
  84
  85     switch (attr) {
  86     case OVS_KEY_ATTR_UNSPEC: return "unspec";
  87     case OVS_KEY_ATTR_ENCAP: return "encap";
  88     case OVS_KEY_ATTR_PRIORITY: return "priority";
  89     case OVS_KEY_ATTR_TUN_ID: return "tun_id";
  90     case OVS_KEY_ATTR_IN_PORT: return "in_port";
  91     case OVS_KEY_ATTR_ETHERNET: return "eth";
  92     case OVS_KEY_ATTR_VLAN: return "vlan";
  93     case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
  94     case OVS_KEY_ATTR_IPV4: return "ipv4";
  95     case OVS_KEY_ATTR_IPV6: return "ipv6";
  96     case OVS_KEY_ATTR_TCP: return "tcp";
  97     case OVS_KEY_ATTR_UDP: return "udp";
  98     case OVS_KEY_ATTR_ICMP: return "icmp";
  99     case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
 100     case OVS_KEY_ATTR_ARP: return "arp";
 101     case OVS_KEY_ATTR_ND: return "nd";
 102
 103     case __OVS_KEY_ATTR_MAX:
 104     default:
 105         snprintf(unknown_attr, sizeof unknown_attr, "key%u",
 106                  (unsigned int) attr);
 107         return unknown_attr;
 108     }
 109 }
 110
 111 static void
 112 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
 113 {
 114     size_t len = nl_attr_get_size(a);
 115
 116     ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
 117     if (len) {
 118         const uint8_t *unspec;
 119         unsigned int i;
 120
 121         unspec = nl_attr_get(a);
 122         for (i = 0; i < len; i++) {
 123             ds_put_char(ds, i ? ' ': '(');
 124             ds_put_format(ds, "%02x", unspec[i]);
 125         }
 126         ds_put_char(ds, ')');
 127     }
 128 }
 129
 130 static void
 131 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
 132 {
 133     static const struct nl_policy ovs_sample_policy[] = {
 134         [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
 135         [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
 136     };
 137     struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
 138     double percentage;
 139     const struct nlattr *nla_acts;
 140     int len;
 141
 142     ds_put_cstr(ds, "sample");
 143
 144     if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
 145         ds_put_cstr(ds, "(error)");
 146         return;
 147     }
 148
 149     percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
 150                         UINT32_MAX;
 151
 152     ds_put_format(ds, "(sample=%.1f%%,", percentage);
 153
 154     ds_put_cstr(ds, "actions(");
 155     nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
 156     len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
 157     format_odp_actions(ds, nla_acts, len);
 158     ds_put_format(ds, "))");
 159 }
 160
 161 static void
 162 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
 163 {
 164     static const struct nl_policy ovs_userspace_policy[] = {
 165         [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
 166         [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
 167     };
 168     struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
 169
 170     if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
 171         ds_put_cstr(ds, "userspace(error)");
 172         return;
 173     }
 174
 175     ds_put_format(ds, "userspace(pid=%"PRIu32,
 176                   nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
 177
 178     if (a[OVS_USERSPACE_ATTR_USERDATA]) {
 179         uint64_t userdata = nl_attr_get_u64(a[OVS_USERSPACE_ATTR_USERDATA]);
 180         struct user_action_cookie cookie;
 181
 182         memcpy(&cookie, &userdata, sizeof cookie);
 183
 184         if (cookie.type == USER_ACTION_COOKIE_CONTROLLER) {
 185             ds_put_format(ds, ",controller,length=%"PRIu32,
 186                           cookie.data);
 187         } else if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
 188             ds_put_format(ds, ",sFlow,n_output=%"PRIu8","
 189                           "vid=%"PRIu16",pcp=%"PRIu8",ifindex=%"PRIu32,
 190                           cookie.n_output, vlan_tci_to_vid(cookie.vlan_tci),
 191                           vlan_tci_to_pcp(cookie.vlan_tci), cookie.data);
 192         } else {
 193             ds_put_format(ds, ",userdata=0x%"PRIx64, userdata);
 194         }
 195     }
 196
 197     ds_put_char(ds, ')');
 198 }
 199
 200 static void
 201 format_odp_action(struct ds *ds, const struct nlattr *a)
 202 {
 203     int expected_len;
 204     enum ovs_action_attr type = nl_attr_type(a);
 205     const struct ovs_action_push_vlan *vlan;
 206
 207     expected_len = odp_action_len(nl_attr_type(a));
 208     if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
 209         ds_put_format(ds, "bad length %zu, expected %d for: ",
 210                       nl_attr_get_size(a), expected_len);
 211         format_generic_odp_action(ds, a);
 212         return;
 213     }
 214
 215     switch (type) {
 216     case OVS_ACTION_ATTR_OUTPUT:
 217         ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
 218         break;
 219     case OVS_ACTION_ATTR_USERSPACE:
 220         format_odp_userspace_action(ds, a);
 221         break;
 222     case OVS_ACTION_ATTR_SET:
 223         ds_put_cstr(ds, "set(");
 224         format_odp_key_attr(nl_attr_get(a), ds);
 225         ds_put_cstr(ds, ")");
 226         break;
 227     case OVS_ACTION_ATTR_PUSH_VLAN:
 228         vlan = nl_attr_get(a);
 229         ds_put_cstr(ds, "push_vlan(");
 230         if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
 231             ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
 232         }
 233         ds_put_format(ds, "vid=%"PRIu16",pcp=%d)",
 234                       vlan_tci_to_vid(vlan->vlan_tci),
 235                       vlan_tci_to_pcp(vlan->vlan_tci));
 236         break;
 237     case OVS_ACTION_ATTR_POP_VLAN:
 238         ds_put_cstr(ds, "pop_vlan");
 239         break;
 240     case OVS_ACTION_ATTR_SAMPLE:
 241         format_odp_sample_action(ds, a);
 242         break;
 243     case OVS_ACTION_ATTR_UNSPEC:
 244     case __OVS_ACTION_ATTR_MAX:
 245     default:
 246         format_generic_odp_action(ds, a);
 247         break;
 248     }
 249 }
 250
 251 void
 252 format_odp_actions(struct ds *ds, const struct nlattr *actions,
 253                    size_t actions_len)
 254 {
 255     if (actions_len) {
 256         const struct nlattr *a;
 257         unsigned int left;
 258
 259         NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
 260             if (a != actions) {
 261                 ds_put_char(ds, ',');
 262             }
 263             format_odp_action(ds, a);
 264         }
 265         if (left) {
 266             if (left == actions_len) {
 267                 ds_put_cstr(ds, "<empty>");
 268             }
 269             ds_put_format(ds, ",***%u leftover bytes***", left);
 270         }
 271     } else {
 272         ds_put_cstr(ds, "drop");
 273     }
 274 }
 275 \f
 276 /* Returns the correct length of the payload for a flow key attribute of the
 277  * specified 'type', -1 if 'type' is unknown, or -2 if the attribute's payload
 278  * is variable length. */
 279 static int
 280 odp_flow_key_attr_len(uint16_t type)
 281 {
 282     if (type > OVS_KEY_ATTR_MAX) {
 283         return -1;
 284     }
 285
 286     switch ((enum ovs_key_attr) type) {
 287     case OVS_KEY_ATTR_ENCAP: return -2;
 288     case OVS_KEY_ATTR_PRIORITY: return 4;
 289     case OVS_KEY_ATTR_TUN_ID: return 8;
 290     case OVS_KEY_ATTR_IN_PORT: return 4;
 291     case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
 292     case OVS_KEY_ATTR_VLAN: return sizeof(ovs_be16);
 293     case OVS_KEY_ATTR_ETHERTYPE: return 2;
 294     case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
 295     case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
 296     case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
 297     case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
 298     case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
 299     case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
 300     case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
 301     case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
 302
 303     case OVS_KEY_ATTR_UNSPEC:
 304     case __OVS_KEY_ATTR_MAX:
 305         return -1;
 306     }
 307
 308     return -1;
 309 }
 310
 311 static void
 312 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
 313 {
 314     size_t len = nl_attr_get_size(a);
 315     if (len) {
 316         const uint8_t *unspec;
 317         unsigned int i;
 318
 319         unspec = nl_attr_get(a);
 320         for (i = 0; i < len; i++) {
 321             ds_put_char(ds, i ? ' ': '(');
 322             ds_put_format(ds, "%02x", unspec[i]);
 323         }
 324         ds_put_char(ds, ')');
 325     }
 326 }
 327
 328 static const char *
 329 ovs_frag_type_to_string(enum ovs_frag_type type)
 330 {
 331     switch (type) {
 332     case OVS_FRAG_TYPE_NONE:
 333         return "no";
 334     case OVS_FRAG_TYPE_FIRST:
 335         return "first";
 336     case OVS_FRAG_TYPE_LATER:
 337         return "later";
 338     case __OVS_FRAG_TYPE_MAX:
 339     default:
 340         return "<error>";
 341     }
 342 }
 343
 344 static void
 345 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
 346 {
 347     const struct ovs_key_ethernet *eth_key;
 348     const struct ovs_key_ipv4 *ipv4_key;
 349     const struct ovs_key_ipv6 *ipv6_key;
 350     const struct ovs_key_tcp *tcp_key;
 351     const struct ovs_key_udp *udp_key;
 352     const struct ovs_key_icmp *icmp_key;
 353     const struct ovs_key_icmpv6 *icmpv6_key;
 354     const struct ovs_key_arp *arp_key;
 355     const struct ovs_key_nd *nd_key;
 356     enum ovs_key_attr attr = nl_attr_type(a);
 357     int expected_len;
 358
 359     ds_put_cstr(ds, ovs_key_attr_to_string(attr));
 360     expected_len = odp_flow_key_attr_len(nl_attr_type(a));
 361     if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
 362         ds_put_format(ds, "(bad length %zu, expected %d)",
 363                       nl_attr_get_size(a),
 364                       odp_flow_key_attr_len(nl_attr_type(a)));
 365         format_generic_odp_key(a, ds);
 366         return;
 367     }
 368
 369     switch (attr) {
 370     case OVS_KEY_ATTR_ENCAP:
 371         ds_put_cstr(ds, "(");
 372         if (nl_attr_get_size(a)) {
 373             odp_flow_key_format(nl_attr_get(a), nl_attr_get_size(a), ds);
 374         }
 375         ds_put_char(ds, ')');
 376         break;
 377
 378     case OVS_KEY_ATTR_PRIORITY:
 379         ds_put_format(ds, "(%"PRIu32")", nl_attr_get_u32(a));
 380         break;
 381
 382     case OVS_KEY_ATTR_TUN_ID:
 383         ds_put_format(ds, "(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
 384         break;
 385
 386     case OVS_KEY_ATTR_IN_PORT:
 387         ds_put_format(ds, "(%"PRIu32")", nl_attr_get_u32(a));
 388         break;
 389
 390     case OVS_KEY_ATTR_ETHERNET:
 391         eth_key = nl_attr_get(a);
 392         ds_put_format(ds, "(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
 393                       ETH_ADDR_ARGS(eth_key->eth_src),
 394                       ETH_ADDR_ARGS(eth_key->eth_dst));
 395         break;
 396
 397     case OVS_KEY_ATTR_VLAN:
 398         ds_put_format(ds, "(vid=%"PRIu16",pcp=%d)",
 399                       vlan_tci_to_vid(nl_attr_get_be16(a)),
 400                       vlan_tci_to_pcp(nl_attr_get_be16(a)));
 401         break;
 402
 403     case OVS_KEY_ATTR_ETHERTYPE:
 404         ds_put_format(ds, "(0x%04"PRIx16")",
 405                       ntohs(nl_attr_get_be16(a)));
 406         break;
 407
 408     case OVS_KEY_ATTR_IPV4:
 409         ipv4_key = nl_attr_get(a);
 410         ds_put_format(ds, "(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
 411                       ",tos=%#"PRIx8",ttl=%"PRIu8",frag=%s)",
 412                       IP_ARGS(&ipv4_key->ipv4_src),
 413                       IP_ARGS(&ipv4_key->ipv4_dst),
 414                       ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
 415                       ipv4_key->ipv4_ttl,
 416                       ovs_frag_type_to_string(ipv4_key->ipv4_frag));
 417         break;
 418
 419     case OVS_KEY_ATTR_IPV6: {
 420         char src_str[INET6_ADDRSTRLEN];
 421         char dst_str[INET6_ADDRSTRLEN];
 422
 423         ipv6_key = nl_attr_get(a);
 424         inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
 425         inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
 426
 427         ds_put_format(ds, "(src=%s,dst=%s,label=%#"PRIx32",proto=%"PRIu8
 428                       ",tclass=%#"PRIx8",hlimit=%"PRIu8",frag=%s)",
 429                       src_str, dst_str, ntohl(ipv6_key->ipv6_label),
 430                       ipv6_key->ipv6_proto, ipv6_key->ipv6_tclass,
 431                       ipv6_key->ipv6_hlimit,
 432                       ovs_frag_type_to_string(ipv6_key->ipv6_frag));
 433         break;
 434     }
 435
 436     case OVS_KEY_ATTR_TCP:
 437         tcp_key = nl_attr_get(a);
 438         ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
 439                       ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
 440         break;
 441
 442     case OVS_KEY_ATTR_UDP:
 443         udp_key = nl_attr_get(a);
 444         ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
 445                       ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
 446         break;
 447
 448     case OVS_KEY_ATTR_ICMP:
 449         icmp_key = nl_attr_get(a);
 450         ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
 451                       icmp_key->icmp_type, icmp_key->icmp_code);
 452         break;
 453
 454     case OVS_KEY_ATTR_ICMPV6:
 455         icmpv6_key = nl_attr_get(a);
 456         ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
 457                       icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
 458         break;
 459
 460     case OVS_KEY_ATTR_ARP:
 461         arp_key = nl_attr_get(a);
 462         ds_put_format(ds, "(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
 463                       "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
 464                       IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
 465                       ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
 466                       ETH_ADDR_ARGS(arp_key->arp_tha));
 467         break;
 468
 469     case OVS_KEY_ATTR_ND: {
 470         char target[INET6_ADDRSTRLEN];
 471
 472         nd_key = nl_attr_get(a);
 473         inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
 474
 475         ds_put_format(ds, "(target=%s", target);
 476         if (!eth_addr_is_zero(nd_key->nd_sll)) {
 477             ds_put_format(ds, ",sll="ETH_ADDR_FMT,
 478                           ETH_ADDR_ARGS(nd_key->nd_sll));
 479         }
 480         if (!eth_addr_is_zero(nd_key->nd_tll)) {
 481             ds_put_format(ds, ",tll="ETH_ADDR_FMT,
 482                           ETH_ADDR_ARGS(nd_key->nd_tll));
 483         }
 484         ds_put_char(ds, ')');
 485         break;
 486     }
 487
 488     case OVS_KEY_ATTR_UNSPEC:
 489     case __OVS_KEY_ATTR_MAX:
 490     default:
 491         format_generic_odp_key(a, ds);
 492         break;
 493     }
 494 }
 495
 496 /* Appends to 'ds' a string representation of the 'key_len' bytes of
 497  * OVS_KEY_ATTR_* attributes in 'key'. */
 498 void
 499 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
 500 {
 501     if (key_len) {
 502         const struct nlattr *a;
 503         unsigned int left;
 504
 505         NL_ATTR_FOR_EACH (a, left, key, key_len) {
 506             if (a != key) {
 507                 ds_put_char(ds, ',');
 508             }
 509             format_odp_key_attr(a, ds);
 510         }
 511         if (left) {
 512             if (left == key_len) {
 513                 ds_put_cstr(ds, "<empty>");
 514             }
 515             ds_put_format(ds, ",***%u leftover bytes***", left);
 516         }
 517     } else {
 518         ds_put_cstr(ds, "<empty>");
 519     }
 520 }
 521
 522 static int
 523 put_nd_key(int n, const char *nd_target_s,
 524            const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
 525 {
 526     struct ovs_key_nd nd_key;
 527
 528     memset(&nd_key, 0, sizeof nd_key);
 529     if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
 530         return -EINVAL;
 531     }
 532     if (nd_sll) {
 533         memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
 534     }
 535     if (nd_tll) {
 536         memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
 537     }
 538     nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
 539     return n;
 540 }
 541
 542 static bool
 543 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
 544 {
 545     if (!strcasecmp(s, "no")) {
 546         *type = OVS_FRAG_TYPE_NONE;
 547     } else if (!strcasecmp(s, "first")) {
 548         *type = OVS_FRAG_TYPE_FIRST;
 549     } else if (!strcasecmp(s, "later")) {
 550         *type = OVS_FRAG_TYPE_LATER;
 551     } else {
 552         return false;
 553     }
 554     return true;
 555 }
 556
 557 static int
 558 parse_odp_key_attr(const char *s, struct ofpbuf *key)
 559 {
 560     /* Many of the sscanf calls in this function use oversized destination
 561      * fields because some sscanf() implementations truncate the range of %i
 562      * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
 563      * value of 0x7fff.  The other alternatives are to allow only a single
 564      * radix (e.g. decimal or hexadecimal) or to write more sophisticated
 565      * parsers.
 566      *
 567      * The tun_id parser has to use an alternative approach because there is no
 568      * type larger than 64 bits. */
 569
 570     {
 571         unsigned long long int priority;
 572         int n = -1;
 573
 574         if (sscanf(s, "priority(%lli)%n", &priority, &n) > 0 && n > 0) {
 575             nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
 576             return n;
 577         }
 578     }
 579
 580     {
 581         char tun_id_s[32];
 582         int n = -1;
 583
 584         if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
 585                    tun_id_s, &n) > 0 && n > 0) {
 586             uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
 587             nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
 588             return n;
 589         }
 590     }
 591
 592     {
 593         unsigned long long int in_port;
 594         int n = -1;
 595
 596         if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
 597             nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
 598             return n;
 599         }
 600     }
 601
 602     {
 603         struct ovs_key_ethernet eth_key;
 604         int n = -1;
 605
 606         if (sscanf(s,
 607                    "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
 608                    ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
 609                    ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
 610             nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
 611                               &eth_key, sizeof eth_key);
 612             return n;
 613         }
 614     }
 615
 616     {
 617         uint16_t vid;
 618         int pcp;
 619         int n = -1;
 620
 621         if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n", &vid, &pcp, &n) > 0
 622              && n > 0)) {
 623             nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
 624                             htons((vid << VLAN_VID_SHIFT) |
 625                                   (pcp << VLAN_PCP_SHIFT)));
 626             return n;
 627         }
 628     }
 629
 630     {
 631         int eth_type;
 632         int n = -1;
 633
 634         if (sscanf(s, "eth_type(%i)%n", &eth_type, &n) > 0 && n > 0) {
 635             nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
 636             return n;
 637         }
 638     }
 639
 640     {
 641         ovs_be32 ipv4_src;
 642         ovs_be32 ipv4_dst;
 643         int ipv4_proto;
 644         int ipv4_tos;
 645         int ipv4_ttl;
 646         char frag[8];
 647         enum ovs_frag_type ipv4_frag;
 648         int n = -1;
 649
 650         if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
 651                    "proto=%i,tos=%i,ttl=%i,frag=%7[a-z])%n",
 652                    IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
 653                    &ipv4_proto, &ipv4_tos, &ipv4_ttl, frag, &n) > 0
 654             && n > 0
 655             && ovs_frag_type_from_string(frag, &ipv4_frag)) {
 656             struct ovs_key_ipv4 ipv4_key;
 657
 658             ipv4_key.ipv4_src = ipv4_src;
 659             ipv4_key.ipv4_dst = ipv4_dst;
 660             ipv4_key.ipv4_proto = ipv4_proto;
 661             ipv4_key.ipv4_tos = ipv4_tos;
 662             ipv4_key.ipv4_ttl = ipv4_ttl;
 663             ipv4_key.ipv4_frag = ipv4_frag;
 664             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
 665                               &ipv4_key, sizeof ipv4_key);
 666             return n;
 667         }
 668     }
 669
 670     {
 671         char ipv6_src_s[IPV6_SCAN_LEN + 1];
 672         char ipv6_dst_s[IPV6_SCAN_LEN + 1];
 673         int ipv6_label;
 674         int ipv6_proto;
 675         int ipv6_tclass;
 676         int ipv6_hlimit;
 677         char frag[8];
 678         enum ovs_frag_type ipv6_frag;
 679         int n = -1;
 680
 681         if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
 682                    "label=%i,proto=%i,tclass=%i,hlimit=%i,frag=%7[a-z])%n",
 683                    ipv6_src_s, ipv6_dst_s, &ipv6_label,
 684                    &ipv6_proto, &ipv6_tclass, &ipv6_hlimit, frag, &n) > 0
 685             && n > 0
 686             && ovs_frag_type_from_string(frag, &ipv6_frag)) {
 687             struct ovs_key_ipv6 ipv6_key;
 688
 689             if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
 690                 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
 691                 return -EINVAL;
 692             }
 693             ipv6_key.ipv6_label = htonl(ipv6_label);
 694             ipv6_key.ipv6_proto = ipv6_proto;
 695             ipv6_key.ipv6_tclass = ipv6_tclass;
 696             ipv6_key.ipv6_hlimit = ipv6_hlimit;
 697             ipv6_key.ipv6_frag = ipv6_frag;
 698             nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
 699                               &ipv6_key, sizeof ipv6_key);
 700             return n;
 701         }
 702     }
 703
 704     {
 705         int tcp_src;
 706         int tcp_dst;
 707         int n = -1;
 708
 709         if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
 710             && n > 0) {
 711             struct ovs_key_tcp tcp_key;
 712
 713             tcp_key.tcp_src = htons(tcp_src);
 714             tcp_key.tcp_dst = htons(tcp_dst);
 715             nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
 716             return n;
 717         }
 718     }
 719
 720     {
 721         int udp_src;
 722         int udp_dst;
 723         int n = -1;
 724
 725         if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
 726             && n > 0) {
 727             struct ovs_key_udp udp_key;
 728
 729             udp_key.udp_src = htons(udp_src);
 730             udp_key.udp_dst = htons(udp_dst);
 731             nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
 732             return n;
 733         }
 734     }
 735
 736     {
 737         int icmp_type;
 738         int icmp_code;
 739         int n = -1;
 740
 741         if (sscanf(s, "icmp(type=%i,code=%i)%n",
 742                    &icmp_type, &icmp_code, &n) > 0
 743             && n > 0) {
 744             struct ovs_key_icmp icmp_key;
 745
 746             icmp_key.icmp_type = icmp_type;
 747             icmp_key.icmp_code = icmp_code;
 748             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
 749                               &icmp_key, sizeof icmp_key);
 750             return n;
 751         }
 752     }
 753
 754     {
 755         struct ovs_key_icmpv6 icmpv6_key;
 756         int n = -1;
 757
 758         if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
 759                    &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
 760             && n > 0) {
 761             nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
 762                               &icmpv6_key, sizeof icmpv6_key);
 763             return n;
 764         }
 765     }
 766
 767     {
 768         ovs_be32 arp_sip;
 769         ovs_be32 arp_tip;
 770         int arp_op;
 771         uint8_t arp_sha[ETH_ADDR_LEN];
 772         uint8_t arp_tha[ETH_ADDR_LEN];
 773         int n = -1;
 774
 775         if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
 776                    "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
 777                    IP_SCAN_ARGS(&arp_sip),
 778                    IP_SCAN_ARGS(&arp_tip),
 779                    &arp_op,
 780                    ETH_ADDR_SCAN_ARGS(arp_sha),
 781                    ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
 782             struct ovs_key_arp arp_key;
 783
 784             memset(&arp_key, 0, sizeof arp_key);
 785             arp_key.arp_sip = arp_sip;
 786             arp_key.arp_tip = arp_tip;
 787             arp_key.arp_op = htons(arp_op);
 788             memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
 789             memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
 790             nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
 791             return n;
 792         }
 793     }
 794
 795     {
 796         char nd_target_s[IPV6_SCAN_LEN + 1];
 797         uint8_t nd_sll[ETH_ADDR_LEN];
 798         uint8_t nd_tll[ETH_ADDR_LEN];
 799         int n = -1;
 800
 801         if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
 802                    nd_target_s, &n) > 0 && n > 0) {
 803             return put_nd_key(n, nd_target_s, NULL, NULL, key);
 804         }
 805         if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
 806                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
 807             && n > 0) {
 808             return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
 809         }
 810         if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
 811                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
 812             && n > 0) {
 813             return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
 814         }
 815         if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
 816                    "tll="ETH_ADDR_SCAN_FMT")%n",
 817                    nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
 818                    ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
 819             && n > 0) {
 820             return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
 821         }
 822     }
 823
 824     if (!strncmp(s, "encap(", 6)) {
 825         const char *start = s;
 826         size_t encap;
 827
 828         encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
 829
 830         s += 6;
 831         for (;;) {
 832             int retval;
 833
 834             s += strspn(s, ", \t\r\n");
 835             if (!*s) {
 836                 return -EINVAL;
 837             } else if (*s == ')') {
 838                 break;
 839             }
 840
 841             retval = parse_odp_key_attr(s, key);
 842             if (retval < 0) {
 843                 return retval;
 844             }
 845             s += retval;
 846         }
 847         s++;
 848
 849         nl_msg_end_nested(key, encap);
 850
 851         return s - start;
 852     }
 853
 854     return -EINVAL;
 855 }
 856
 857 /* Parses the string representation of a datapath flow key, in the
 858  * format output by odp_flow_key_format().  Returns 0 if successful,
 859  * otherwise a positive errno value.  On success, the flow key is
 860  * appended to 'key' as a series of Netlink attributes.  On failure, no
 861  * data is appended to 'key'.  Either way, 'key''s data might be
 862  * reallocated.
 863  *
 864  * On success, the attributes appended to 'key' are individually syntactically
 865  * valid, but they may not be valid as a sequence.  'key' might, for example,
 866  * have duplicated keys.  odp_flow_key_to_flow() will detect those errors. */
 867 int
 868 odp_flow_key_from_string(const char *s, struct ofpbuf *key)
 869 {
 870     const size_t old_size = key->size;
 871     for (;;) {
 872         int retval;
 873
 874         s += strspn(s, ", \t\r\n");
 875         if (!*s) {
 876             return 0;
 877         }
 878
 879         retval = parse_odp_key_attr(s, key);
 880         if (retval < 0) {
 881             key->size = old_size;
 882             return -retval;
 883         }
 884         s += retval;
 885     }
 886
 887     return 0;
 888 }
 889
 890 static uint8_t
 891 ovs_to_odp_frag(uint8_t ovs_frag)
 892 {
 893     return (ovs_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
 894             : ovs_frag & FLOW_NW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
 895             : OVS_FRAG_TYPE_NONE);
 896 }
 897
 898 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
 899 void
 900 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
 901 {
 902     struct ovs_key_ethernet *eth_key;
 903     size_t encap;
 904
 905     if (flow->priority) {
 906         nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, flow->priority);
 907     }
 908
 909     if (flow->tun_id != htonll(0)) {
 910         nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
 911     }
 912
 913     if (flow->in_port != OFPP_NONE) {
 914         nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
 915                        ofp_port_to_odp_port(flow->in_port));
 916     }
 917
 918     eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
 919                                        sizeof *eth_key);
 920     memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
 921     memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
 922
 923     if (flow->vlan_tci != htons(0)) {
 924         nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
 925         nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN,
 926                         flow->vlan_tci & ~htons(VLAN_CFI));
 927         encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
 928     } else {
 929         encap = 0;
 930     }
 931
 932     if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
 933         goto unencap;
 934     }
 935
 936     nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
 937
 938     if (flow->dl_type == htons(ETH_TYPE_IP)) {
 939         struct ovs_key_ipv4 *ipv4_key;
 940
 941         ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
 942                                             sizeof *ipv4_key);
 943         ipv4_key->ipv4_src = flow->nw_src;
 944         ipv4_key->ipv4_dst = flow->nw_dst;
 945         ipv4_key->ipv4_proto = flow->nw_proto;
 946         ipv4_key->ipv4_tos = flow->nw_tos;
 947         ipv4_key->ipv4_ttl = flow->nw_ttl;
 948         ipv4_key->ipv4_frag = ovs_to_odp_frag(flow->nw_frag);
 949     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 950         struct ovs_key_ipv6 *ipv6_key;
 951
 952         ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
 953                                             sizeof *ipv6_key);
 954         memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
 955         memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
 956         ipv6_key->ipv6_label = flow->ipv6_label;
 957         ipv6_key->ipv6_proto = flow->nw_proto;
 958         ipv6_key->ipv6_tclass = flow->nw_tos;
 959         ipv6_key->ipv6_hlimit = flow->nw_ttl;
 960         ipv6_key->ipv6_frag = ovs_to_odp_frag(flow->nw_frag);
 961     } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
 962         struct ovs_key_arp *arp_key;
 963
 964         arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
 965                                            sizeof *arp_key);
 966         memset(arp_key, 0, sizeof *arp_key);
 967         arp_key->arp_sip = flow->nw_src;
 968         arp_key->arp_tip = flow->nw_dst;
 969         arp_key->arp_op = htons(flow->nw_proto);
 970         memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
 971         memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
 972     }
 973
 974     if ((flow->dl_type == htons(ETH_TYPE_IP)
 975          || flow->dl_type == htons(ETH_TYPE_IPV6))
 976         && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
 977
 978         if (flow->nw_proto == IPPROTO_TCP) {
 979             struct ovs_key_tcp *tcp_key;
 980
 981             tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
 982                                                sizeof *tcp_key);
 983             tcp_key->tcp_src = flow->tp_src;
 984             tcp_key->tcp_dst = flow->tp_dst;
 985         } else if (flow->nw_proto == IPPROTO_UDP) {
 986             struct ovs_key_udp *udp_key;
 987
 988             udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
 989                                                sizeof *udp_key);
 990             udp_key->udp_src = flow->tp_src;
 991             udp_key->udp_dst = flow->tp_dst;
 992         } else if (flow->dl_type == htons(ETH_TYPE_IP)
 993                 && flow->nw_proto == IPPROTO_ICMP) {
 994             struct ovs_key_icmp *icmp_key;
 995
 996             icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
 997                                                 sizeof *icmp_key);
 998             icmp_key->icmp_type = ntohs(flow->tp_src);
 999             icmp_key->icmp_code = ntohs(flow->tp_dst);
1000         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
1001                 && flow->nw_proto == IPPROTO_ICMPV6) {
1002             struct ovs_key_icmpv6 *icmpv6_key;
1003
1004             icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
1005                                                   sizeof *icmpv6_key);
1006             icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
1007             icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
1008
1009             if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
1010                     || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
1011                 struct ovs_key_nd *nd_key;
1012
1013                 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
1014                                                     sizeof *nd_key);
1015                 memcpy(nd_key->nd_target, &flow->nd_target,
1016                         sizeof nd_key->nd_target);
1017                 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
1018                 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
1019             }
1020         }
1021     }
1022
1023 unencap:
1024     if (encap) {
1025         nl_msg_end_nested(buf, encap);
1026     }
1027 }
1028
1029 static void
1030 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
1031                        uint32_t attrs,
1032                        const struct nlattr *key, size_t key_len)
1033 {
1034     struct ds s;
1035     int i;
1036
1037     if (VLOG_DROP_WARN(rl)) {
1038         return;
1039     }
1040
1041     ds_init(&s);
1042     ds_put_format(&s, "%s:", title);
1043     for (i = 0; i < 32; i++) {
1044         if (attrs & (1u << i)) {
1045             ds_put_format(&s, " %s", ovs_key_attr_to_string(i));
1046         }
1047     }
1048
1049     ds_put_cstr(&s, ": ");
1050     odp_flow_key_format(key, key_len, &s);
1051
1052     VLOG_WARN("%s", ds_cstr(&s));
1053     ds_destroy(&s);
1054 }
1055
1056 static bool
1057 odp_to_ovs_frag(uint8_t odp_frag, struct flow *flow)
1058 {
1059     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1060
1061     if (odp_frag > OVS_FRAG_TYPE_LATER) {
1062         VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key",
1063                     odp_frag);
1064         return false;
1065     }
1066
1067     if (odp_frag != OVS_FRAG_TYPE_NONE) {
1068         flow->nw_frag |= FLOW_NW_FRAG_ANY;
1069         if (odp_frag == OVS_FRAG_TYPE_LATER) {
1070             flow->nw_frag |= FLOW_NW_FRAG_LATER;
1071         }
1072     }
1073     return true;
1074 }
1075
1076 static int
1077 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
1078                    const struct nlattr *attrs[], uint64_t *present_attrsp)
1079 {
1080     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1081     const struct nlattr *nla;
1082     uint64_t present_attrs;
1083     size_t left;
1084
1085     present_attrs = 0;
1086     NL_ATTR_FOR_EACH (nla, left, key, key_len) {
1087         uint16_t type = nl_attr_type(nla);
1088         size_t len = nl_attr_get_size(nla);
1089         int expected_len = odp_flow_key_attr_len(type);
1090
1091         if (len != expected_len && expected_len != -2) {
1092             if (expected_len == -1) {
1093                 VLOG_ERR_RL(&rl, "unknown attribute %"PRIu16" in flow key",
1094                             type);
1095             } else {
1096                 VLOG_ERR_RL(&rl, "attribute %s has length %zu but should have "
1097                             "length %d", ovs_key_attr_to_string(type),
1098                             len, expected_len);
1099             }
1100             return EINVAL;
1101         } else if (present_attrs & (UINT64_C(1) << type)) {
1102             VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
1103                         ovs_key_attr_to_string(type));
1104             return EINVAL;
1105         }
1106
1107         present_attrs |= UINT64_C(1) << type;
1108         attrs[type] = nla;
1109     }
1110     if (left) {
1111         VLOG_ERR_RL(&rl, "trailing garbage in flow key");
1112         return EINVAL;
1113     }
1114
1115     *present_attrsp = present_attrs;
1116     return 0;
1117 }
1118
1119 static int
1120 check_expectations(uint64_t present_attrs, uint64_t expected_attrs,
1121                    const struct nlattr *key, size_t key_len)
1122 {
1123     uint64_t missing_attrs;
1124     uint64_t extra_attrs;
1125
1126     missing_attrs = expected_attrs & ~present_attrs;
1127     if (missing_attrs) {
1128         static struct vlog_rate_limit miss_rl = VLOG_RATE_LIMIT_INIT(10, 10);
1129         log_odp_key_attributes(&miss_rl, "expected but not present",
1130                                missing_attrs, key, key_len);
1131         return EINVAL;
1132     }
1133
1134     extra_attrs = present_attrs & ~expected_attrs;
1135     if (extra_attrs) {
1136         static struct vlog_rate_limit extra_rl = VLOG_RATE_LIMIT_INIT(10, 10);
1137         log_odp_key_attributes(&extra_rl, "present but not expected",
1138                                extra_attrs, key, key_len);
1139         return EINVAL;
1140     }
1141
1142     return 0;
1143 }
1144
1145 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
1146  * structure in 'flow'.  Returns 0 if successful, otherwise EINVAL. */
1147 int
1148 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
1149                      struct flow *flow)
1150 {
1151     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1152     const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
1153     uint64_t expected_attrs;
1154     uint64_t present_attrs;
1155     int error;
1156
1157     memset(flow, 0, sizeof *flow);
1158
1159     error = parse_flow_nlattrs(key, key_len, attrs, &present_attrs);
1160     if (error) {
1161         return error;
1162     }
1163
1164     expected_attrs = 0;
1165
1166     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
1167         flow->priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
1168         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
1169     }
1170
1171     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUN_ID)) {
1172         flow->tun_id = nl_attr_get_be64(attrs[OVS_KEY_ATTR_TUN_ID]);
1173         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUN_ID;
1174     }
1175
1176     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
1177         uint32_t in_port = nl_attr_get_u32(attrs[OVS_KEY_ATTR_IN_PORT]);
1178         if (in_port >= UINT16_MAX || in_port >= OFPP_MAX) {
1179             VLOG_ERR_RL(&rl, "in_port %"PRIu32" out of supported range",
1180                         in_port);
1181             return EINVAL;
1182         }
1183         flow->in_port = odp_port_to_ofp_port(in_port);
1184         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
1185     } else {
1186         flow->in_port = OFPP_NONE;
1187     }
1188
1189     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
1190         const struct ovs_key_ethernet *eth_key;
1191
1192         eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
1193         memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
1194         memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
1195     } else {
1196         VLOG_ERR_RL(&rl, "missing Ethernet attribute in flow key");
1197         return EINVAL;
1198     }
1199     expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
1200
1201     if ((present_attrs & ~expected_attrs)
1202         == ((UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE) |
1203             (UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
1204             (UINT64_C(1) << OVS_KEY_ATTR_ENCAP))
1205         && (nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE])
1206             == htons(ETH_TYPE_VLAN))) {
1207         const struct nlattr *encap = attrs[OVS_KEY_ATTR_ENCAP];
1208         const struct nlattr *vlan = attrs[OVS_KEY_ATTR_VLAN];
1209
1210         flow->vlan_tci = nl_attr_get_be16(vlan);
1211         if (flow->vlan_tci & htons(VLAN_CFI)) {
1212             return EINVAL;
1213         }
1214         flow->vlan_tci |= htons(VLAN_CFI);
1215
1216         error = parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
1217                                    attrs, &present_attrs);
1218         if (error) {
1219             return error;
1220         }
1221         expected_attrs = 0;
1222     }
1223
1224     if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
1225         flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
1226         if (ntohs(flow->dl_type) < 1536) {
1227             VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
1228                         ntohs(flow->dl_type));
1229             return EINVAL;
1230         }
1231         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
1232     } else {
1233         flow->dl_type = htons(FLOW_DL_TYPE_NONE);
1234     }
1235
1236     if (flow->dl_type == htons(ETH_TYPE_IP)) {
1237         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
1238         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
1239             const struct ovs_key_ipv4 *ipv4_key;
1240
1241             ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
1242             flow->nw_src = ipv4_key->ipv4_src;
1243             flow->nw_dst = ipv4_key->ipv4_dst;
1244             flow->nw_proto = ipv4_key->ipv4_proto;
1245             flow->nw_tos = ipv4_key->ipv4_tos;
1246             flow->nw_ttl = ipv4_key->ipv4_ttl;
1247             if (!odp_to_ovs_frag(ipv4_key->ipv4_frag, flow)) {
1248                 return EINVAL;
1249             }
1250         }
1251     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1252         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
1253         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
1254             const struct ovs_key_ipv6 *ipv6_key;
1255
1256             ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
1257             memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
1258             memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
1259             flow->ipv6_label = ipv6_key->ipv6_label;
1260             flow->nw_proto = ipv6_key->ipv6_proto;
1261             flow->nw_tos = ipv6_key->ipv6_tclass;
1262             flow->nw_ttl = ipv6_key->ipv6_hlimit;
1263             if (!odp_to_ovs_frag(ipv6_key->ipv6_frag, flow)) {
1264                 return EINVAL;
1265             }
1266         }
1267     } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
1268         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
1269         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
1270             const struct ovs_key_arp *arp_key;
1271
1272             arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
1273             flow->nw_src = arp_key->arp_sip;
1274             flow->nw_dst = arp_key->arp_tip;
1275             if (arp_key->arp_op & htons(0xff00)) {
1276                 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
1277                             "key", ntohs(arp_key->arp_op));
1278                 return EINVAL;
1279             }
1280             flow->nw_proto = ntohs(arp_key->arp_op);
1281             memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1282             memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1283         }
1284     }
1285
1286     if (flow->nw_proto == IPPROTO_TCP
1287         && (flow->dl_type == htons(ETH_TYPE_IP) ||
1288             flow->dl_type == htons(ETH_TYPE_IPV6))
1289         && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1290         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
1291         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
1292             const struct ovs_key_tcp *tcp_key;
1293
1294             tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
1295             flow->tp_src = tcp_key->tcp_src;
1296             flow->tp_dst = tcp_key->tcp_dst;
1297         }
1298     } else if (flow->nw_proto == IPPROTO_UDP
1299                && (flow->dl_type == htons(ETH_TYPE_IP) ||
1300                    flow->dl_type == htons(ETH_TYPE_IPV6))
1301                && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1302         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
1303         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
1304             const struct ovs_key_udp *udp_key;
1305
1306             udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
1307             flow->tp_src = udp_key->udp_src;
1308             flow->tp_dst = udp_key->udp_dst;
1309         }
1310     } else if (flow->nw_proto == IPPROTO_ICMP
1311                && flow->dl_type == htons(ETH_TYPE_IP)
1312                && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1313         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
1314         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
1315             const struct ovs_key_icmp *icmp_key;
1316
1317             icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
1318             flow->tp_src = htons(icmp_key->icmp_type);
1319             flow->tp_dst = htons(icmp_key->icmp_code);
1320         }
1321     } else if (flow->nw_proto == IPPROTO_ICMPV6
1322                && flow->dl_type == htons(ETH_TYPE_IPV6)
1323                && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1324         expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
1325         if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
1326             const struct ovs_key_icmpv6 *icmpv6_key;
1327
1328             icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
1329             flow->tp_src = htons(icmpv6_key->icmpv6_type);
1330             flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1331
1332             if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1333                 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
1334                 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
1335                 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
1336                     const struct ovs_key_nd *nd_key;
1337
1338                     nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
1339                     memcpy(&flow->nd_target, nd_key->nd_target,
1340                            sizeof flow->nd_target);
1341                     memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1342                     memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1343                 }
1344             }
1345         }
1346     }
1347
1348     return check_expectations(present_attrs, expected_attrs, key, key_len);
1349 }