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/icmp6.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include "byte-order.h"
  26 #include "coverage.h"
  27 #include "dynamic-string.h"
  28 #include "flow.h"
  29 #include "netlink.h"
  30 #include "openvswitch/tunnel.h"
  31 #include "packets.h"
  32 #include "timeval.h"
  33 #include "util.h"
  34
  35 int
  36 odp_action_len(uint16_t type)
  37 {
  38     if (type > ODP_ACTION_ATTR_MAX) {
  39         return -1;
  40     }
  41
  42     switch ((enum odp_action_type) type) {
  43     case ODP_ACTION_ATTR_OUTPUT: return 4;
  44     case ODP_ACTION_ATTR_USERSPACE: return 8;
  45     case ODP_ACTION_ATTR_SET_DL_TCI: return 2;
  46     case ODP_ACTION_ATTR_STRIP_VLAN: return 0;
  47     case ODP_ACTION_ATTR_SET_DL_SRC: return ETH_ADDR_LEN;
  48     case ODP_ACTION_ATTR_SET_DL_DST: return ETH_ADDR_LEN;
  49     case ODP_ACTION_ATTR_SET_NW_SRC: return 4;
  50     case ODP_ACTION_ATTR_SET_NW_DST: return 4;
  51     case ODP_ACTION_ATTR_SET_NW_TOS: return 1;
  52     case ODP_ACTION_ATTR_SET_TP_SRC: return 2;
  53     case ODP_ACTION_ATTR_SET_TP_DST: return 2;
  54     case ODP_ACTION_ATTR_SET_TUNNEL: return 8;
  55     case ODP_ACTION_ATTR_SET_PRIORITY: return 4;
  56     case ODP_ACTION_ATTR_POP_PRIORITY: return 0;
  57
  58     case ODP_ACTION_ATTR_UNSPEC:
  59     case __ODP_ACTION_ATTR_MAX:
  60         return -1;
  61     }
  62
  63     return -1;
  64 }
  65
  66 static void
  67 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
  68 {
  69     size_t len = nl_attr_get_size(a);
  70
  71     ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
  72     if (len) {
  73         const uint8_t *unspec;
  74         unsigned int i;
  75
  76         unspec = nl_attr_get(a);
  77         for (i = 0; i < len; i++) {
  78             ds_put_char(ds, i ? ' ': '(');
  79             ds_put_format(ds, "%02x", unspec[i]);
  80         }
  81         ds_put_char(ds, ')');
  82     }
  83 }
  84
  85 void
  86 format_odp_action(struct ds *ds, const struct nlattr *a)
  87 {
  88     const uint8_t *eth;
  89     ovs_be32 ip;
  90
  91     if (nl_attr_get_size(a) != odp_action_len(nl_attr_type(a))) {
  92         ds_put_format(ds, "bad length %zu, expected %d for: ",
  93                       nl_attr_get_size(a), odp_action_len(nl_attr_type(a)));
  94         format_generic_odp_action(ds, a);
  95         return;
  96     }
  97
  98     switch (nl_attr_type(a)) {
  99     case ODP_ACTION_ATTR_OUTPUT:
 100         ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
 101         break;
 102     case ODP_ACTION_ATTR_USERSPACE:
 103         ds_put_format(ds, "userspace(%"PRIu64")", nl_attr_get_u64(a));
 104         break;
 105     case ODP_ACTION_ATTR_SET_TUNNEL:
 106         ds_put_format(ds, "set_tunnel(%#"PRIx64")",
 107                       ntohll(nl_attr_get_be64(a)));
 108         break;
 109     case ODP_ACTION_ATTR_SET_DL_TCI:
 110         ds_put_format(ds, "set_tci(vid=%"PRIu16",pcp=%d)",
 111                       vlan_tci_to_vid(nl_attr_get_be16(a)),
 112                       vlan_tci_to_pcp(nl_attr_get_be16(a)));
 113         break;
 114     case ODP_ACTION_ATTR_STRIP_VLAN:
 115         ds_put_format(ds, "strip_vlan");
 116         break;
 117     case ODP_ACTION_ATTR_SET_DL_SRC:
 118         eth = nl_attr_get_unspec(a, ETH_ADDR_LEN);
 119         ds_put_format(ds, "set_dl_src("ETH_ADDR_FMT")", ETH_ADDR_ARGS(eth));
 120         break;
 121     case ODP_ACTION_ATTR_SET_DL_DST:
 122         eth = nl_attr_get_unspec(a, ETH_ADDR_LEN);
 123         ds_put_format(ds, "set_dl_dst("ETH_ADDR_FMT")", ETH_ADDR_ARGS(eth));
 124         break;
 125     case ODP_ACTION_ATTR_SET_NW_SRC:
 126         ip = nl_attr_get_be32(a);
 127         ds_put_format(ds, "set_nw_src("IP_FMT")", IP_ARGS(&ip));
 128         break;
 129     case ODP_ACTION_ATTR_SET_NW_DST:
 130         ip = nl_attr_get_be32(a);
 131         ds_put_format(ds, "set_nw_dst("IP_FMT")", IP_ARGS(&ip));
 132         break;
 133     case ODP_ACTION_ATTR_SET_NW_TOS:
 134         ds_put_format(ds, "set_nw_tos(%"PRIu8")", nl_attr_get_u8(a));
 135         break;
 136     case ODP_ACTION_ATTR_SET_TP_SRC:
 137         ds_put_format(ds, "set_tp_src(%"PRIu16")", ntohs(nl_attr_get_be16(a)));
 138         break;
 139     case ODP_ACTION_ATTR_SET_TP_DST:
 140         ds_put_format(ds, "set_tp_dst(%"PRIu16")", ntohs(nl_attr_get_be16(a)));
 141         break;
 142     case ODP_ACTION_ATTR_SET_PRIORITY:
 143         ds_put_format(ds, "set_priority(%#"PRIx32")", nl_attr_get_u32(a));
 144         break;
 145     case ODP_ACTION_ATTR_POP_PRIORITY:
 146         ds_put_cstr(ds, "pop_priority");
 147         break;
 148     default:
 149         format_generic_odp_action(ds, a);
 150         break;
 151     }
 152 }
 153
 154 void
 155 format_odp_actions(struct ds *ds, const struct nlattr *actions,
 156                    size_t actions_len)
 157 {
 158     if (actions_len) {
 159         const struct nlattr *a;
 160         unsigned int left;
 161
 162         NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
 163             if (a != actions) {
 164                 ds_put_char(ds, ',');
 165             }
 166             format_odp_action(ds, a);
 167         }
 168         if (left) {
 169             if (left == actions_len) {
 170                 ds_put_cstr(ds, "<empty>");
 171             }
 172             ds_put_format(ds, ",***%u leftover bytes***", left);
 173         }
 174     } else {
 175         ds_put_cstr(ds, "drop");
 176     }
 177 }
 178 \f
 179 /* Returns the correct length of the payload for a flow key attribute of the
 180  * specified 'type', or -1 if 'type' is unknown. */
 181 static int
 182 odp_flow_key_attr_len(uint16_t type)
 183 {
 184     if (type > ODP_KEY_ATTR_MAX) {
 185         return -1;
 186     }
 187
 188     switch ((enum odp_key_type) type) {
 189     case ODP_KEY_ATTR_TUN_ID: return 8;
 190     case ODP_KEY_ATTR_IN_PORT: return 4;
 191     case ODP_KEY_ATTR_ETHERNET: return sizeof(struct odp_key_ethernet);
 192     case ODP_KEY_ATTR_8021Q: return sizeof(struct odp_key_8021q);
 193     case ODP_KEY_ATTR_ETHERTYPE: return 2;
 194     case ODP_KEY_ATTR_IPV4: return sizeof(struct odp_key_ipv4);
 195     case ODP_KEY_ATTR_IPV6: return sizeof(struct odp_key_ipv6);
 196     case ODP_KEY_ATTR_TCP: return sizeof(struct odp_key_tcp);
 197     case ODP_KEY_ATTR_UDP: return sizeof(struct odp_key_udp);
 198     case ODP_KEY_ATTR_ICMP: return sizeof(struct odp_key_icmp);
 199     case ODP_KEY_ATTR_ICMPV6: return sizeof(struct odp_key_icmpv6);
 200     case ODP_KEY_ATTR_ARP: return sizeof(struct odp_key_arp);
 201     case ODP_KEY_ATTR_ND: return sizeof(struct odp_key_nd);
 202
 203     case ODP_KEY_ATTR_UNSPEC:
 204     case __ODP_KEY_ATTR_MAX:
 205         return -1;
 206     }
 207
 208     return -1;
 209 }
 210
 211
 212 static void
 213 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
 214 {
 215     size_t len = nl_attr_get_size(a);
 216
 217     ds_put_format(ds, "key%"PRId16, nl_attr_type(a));
 218     if (len) {
 219         const uint8_t *unspec;
 220         unsigned int i;
 221
 222         unspec = nl_attr_get(a);
 223         for (i = 0; i < len; i++) {
 224             ds_put_char(ds, i ? ' ': '(');
 225             ds_put_format(ds, "%02x", unspec[i]);
 226         }
 227         ds_put_char(ds, ')');
 228     }
 229 }
 230
 231 static void
 232 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
 233 {
 234     const struct odp_key_ethernet *eth_key;
 235     const struct odp_key_8021q *q_key;
 236     const struct odp_key_ipv4 *ipv4_key;
 237     const struct odp_key_ipv6 *ipv6_key;
 238     const struct odp_key_tcp *tcp_key;
 239     const struct odp_key_udp *udp_key;
 240     const struct odp_key_icmp *icmp_key;
 241     const struct odp_key_icmpv6 *icmpv6_key;
 242     const struct odp_key_arp *arp_key;
 243     const struct odp_key_nd *nd_key;
 244
 245     if (nl_attr_get_size(a) != odp_flow_key_attr_len(nl_attr_type(a))) {
 246         ds_put_format(ds, "bad length %zu, expected %d for: ",
 247                       nl_attr_get_size(a),
 248                       odp_flow_key_attr_len(nl_attr_type(a)));
 249         format_generic_odp_key(a, ds);
 250         return;
 251     }
 252
 253     switch (nl_attr_type(a)) {
 254     case ODP_KEY_ATTR_TUN_ID:
 255         ds_put_format(ds, "tun_id(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
 256         break;
 257
 258     case ODP_KEY_ATTR_IN_PORT:
 259         ds_put_format(ds, "in_port(%"PRIu32")", nl_attr_get_u32(a));
 260         break;
 261
 262     case ODP_KEY_ATTR_ETHERNET:
 263         eth_key = nl_attr_get(a);
 264         ds_put_format(ds, "eth(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
 265                       ETH_ADDR_ARGS(eth_key->eth_src),
 266                       ETH_ADDR_ARGS(eth_key->eth_dst));
 267         break;
 268
 269     case ODP_KEY_ATTR_8021Q:
 270         q_key = nl_attr_get(a);
 271         ds_put_cstr(ds, "vlan(");
 272         if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
 273             ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(q_key->q_tpid));
 274         }
 275         ds_put_format(ds, "vid%"PRIu16",pcp%d)",
 276                       vlan_tci_to_vid(q_key->q_tci),
 277                       vlan_tci_to_pcp(q_key->q_tci));
 278         break;
 279
 280     case ODP_KEY_ATTR_ETHERTYPE:
 281         ds_put_format(ds, "eth_type(0x%04"PRIx16")",
 282                       ntohs(nl_attr_get_be16(a)));
 283         break;
 284
 285     case ODP_KEY_ATTR_IPV4:
 286         ipv4_key = nl_attr_get(a);
 287         ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT","
 288                       "proto=%"PRId8",tos=%"PRIu8")",
 289                       IP_ARGS(&ipv4_key->ipv4_src),
 290                       IP_ARGS(&ipv4_key->ipv4_dst),
 291                       ipv4_key->ipv4_proto, ipv4_key->ipv4_tos);
 292         break;
 293
 294     case ODP_KEY_ATTR_IPV6: {
 295         char src_str[INET6_ADDRSTRLEN];
 296         char dst_str[INET6_ADDRSTRLEN];
 297
 298         ipv6_key = nl_attr_get(a);
 299         inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
 300         inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
 301
 302         ds_put_format(ds, "ipv6(src=%s,dst=%s,proto=%"PRId8",tos=%"PRIu8")",
 303                       src_str, dst_str, ipv6_key->ipv6_proto,
 304                       ipv6_key->ipv6_tos);
 305         break;
 306     }
 307
 308     case ODP_KEY_ATTR_TCP:
 309         tcp_key = nl_attr_get(a);
 310         ds_put_format(ds, "tcp(src=%"PRIu16",dst=%"PRIu16")",
 311                       ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
 312         break;
 313
 314     case ODP_KEY_ATTR_UDP:
 315         udp_key = nl_attr_get(a);
 316         ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16")",
 317                       ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
 318         break;
 319
 320     case ODP_KEY_ATTR_ICMP:
 321         icmp_key = nl_attr_get(a);
 322         ds_put_format(ds, "icmp(type=%"PRIu8",code=%"PRIu8")",
 323                       icmp_key->icmp_type, icmp_key->icmp_code);
 324         break;
 325
 326     case ODP_KEY_ATTR_ICMPV6:
 327         icmpv6_key = nl_attr_get(a);
 328         ds_put_format(ds, "icmpv6(type=%"PRIu8",code=%"PRIu8")",
 329                       icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
 330         break;
 331
 332     case ODP_KEY_ATTR_ARP:
 333         arp_key = nl_attr_get(a);
 334         ds_put_format(ds, "arp(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
 335                       "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
 336                       IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
 337                       ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
 338                       ETH_ADDR_ARGS(arp_key->arp_tha));
 339         break;
 340
 341     case ODP_KEY_ATTR_ND: {
 342         char target[INET6_ADDRSTRLEN];
 343
 344         nd_key = nl_attr_get(a);
 345         inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
 346
 347         ds_put_format(ds, "nd(target=%s", target);
 348         if (!eth_addr_is_zero(nd_key->nd_sll)) {
 349             ds_put_format(ds, ",sll="ETH_ADDR_FMT,
 350                           ETH_ADDR_ARGS(nd_key->nd_sll));
 351         }
 352         if (!eth_addr_is_zero(nd_key->nd_tll)) {
 353             ds_put_format(ds, ",tll="ETH_ADDR_FMT,
 354                           ETH_ADDR_ARGS(nd_key->nd_tll));
 355         }
 356         ds_put_char(ds, ')');
 357         break;
 358     }
 359
 360     default:
 361         format_generic_odp_key(a, ds);
 362         break;
 363     }
 364 }
 365
 366 /* Appends to 'ds' a string representation of the 'key_len' bytes of
 367  * ODP_KEY_ATTR_* attributes in 'key'. */
 368 void
 369 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
 370 {
 371     if (key_len) {
 372         const struct nlattr *a;
 373         unsigned int left;
 374
 375         NL_ATTR_FOR_EACH (a, left, key, key_len) {
 376             if (a != key) {
 377                 ds_put_char(ds, ',');
 378             }
 379             format_odp_key_attr(a, ds);
 380         }
 381         if (left) {
 382             if (left == key_len) {
 383                 ds_put_cstr(ds, "<empty>");
 384             }
 385             ds_put_format(ds, ",***%u leftover bytes***", left);
 386         }
 387     } else {
 388         ds_put_cstr(ds, "<empty>");
 389     }
 390 }
 391
 392 /* Appends a representation of 'flow' as ODP_KEY_ATTR_* attributes to 'buf'. */
 393 void
 394 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
 395 {
 396     struct odp_key_ethernet *eth_key;
 397
 398     if (flow->tun_id != htonll(0)) {
 399         nl_msg_put_be64(buf, ODP_KEY_ATTR_TUN_ID, flow->tun_id);
 400     }
 401
 402     if (flow->in_port != OFPP_NONE) {
 403         nl_msg_put_u32(buf, ODP_KEY_ATTR_IN_PORT,
 404                        ofp_port_to_odp_port(flow->in_port));
 405     }
 406
 407     eth_key = nl_msg_put_unspec_uninit(buf, ODP_KEY_ATTR_ETHERNET,
 408                                        sizeof *eth_key);
 409     memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
 410     memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
 411
 412     if (flow->vlan_tci != htons(0)) {
 413         struct odp_key_8021q *q_key;
 414
 415         q_key = nl_msg_put_unspec_uninit(buf, ODP_KEY_ATTR_8021Q,
 416                                          sizeof *q_key);
 417         q_key->q_tpid = htons(ETH_TYPE_VLAN);
 418         q_key->q_tci = flow->vlan_tci & ~htons(VLAN_CFI);
 419     }
 420
 421     if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
 422         return;
 423     }
 424
 425     nl_msg_put_be16(buf, ODP_KEY_ATTR_ETHERTYPE, flow->dl_type);
 426
 427     if (flow->dl_type == htons(ETH_TYPE_IP)) {
 428         struct odp_key_ipv4 *ipv4_key;
 429
 430         ipv4_key = nl_msg_put_unspec_uninit(buf, ODP_KEY_ATTR_IPV4,
 431                                             sizeof *ipv4_key);
 432         memset(ipv4_key, 0, sizeof *ipv4_key);
 433         ipv4_key->ipv4_src = flow->nw_src;
 434         ipv4_key->ipv4_dst = flow->nw_dst;
 435         ipv4_key->ipv4_proto = flow->nw_proto;
 436         ipv4_key->ipv4_tos = flow->nw_tos;
 437     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 438         struct odp_key_ipv6 *ipv6_key;
 439
 440         ipv6_key = nl_msg_put_unspec_uninit(buf, ODP_KEY_ATTR_IPV6,
 441                                             sizeof *ipv6_key);
 442         memset(ipv6_key, 0, sizeof *ipv6_key);
 443         memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
 444         memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
 445         ipv6_key->ipv6_proto = flow->nw_proto;
 446         ipv6_key->ipv6_tos = flow->nw_tos;
 447     } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
 448         struct odp_key_arp *arp_key;
 449
 450         arp_key = nl_msg_put_unspec_uninit(buf, ODP_KEY_ATTR_ARP,
 451                                            sizeof *arp_key);
 452         memset(arp_key, 0, sizeof *arp_key);
 453         arp_key->arp_sip = flow->nw_src;
 454         arp_key->arp_tip = flow->nw_dst;
 455         arp_key->arp_op = htons(flow->nw_proto);
 456         memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
 457         memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
 458     }
 459
 460     if (flow->dl_type == htons(ETH_TYPE_IP)
 461             || flow->dl_type == htons(ETH_TYPE_IPV6)) {
 462
 463         if (flow->nw_proto == IPPROTO_TCP) {
 464             struct odp_key_tcp *tcp_key;
 465
 466             tcp_key = nl_msg_put_unspec_uninit(buf, ODP_KEY_ATTR_TCP,
 467                                                sizeof *tcp_key);
 468             tcp_key->tcp_src = flow->tp_src;
 469             tcp_key->tcp_dst = flow->tp_dst;
 470         } else if (flow->nw_proto == IPPROTO_UDP) {
 471             struct odp_key_udp *udp_key;
 472
 473             udp_key = nl_msg_put_unspec_uninit(buf, ODP_KEY_ATTR_UDP,
 474                                                sizeof *udp_key);
 475             udp_key->udp_src = flow->tp_src;
 476             udp_key->udp_dst = flow->tp_dst;
 477         } else if (flow->dl_type == htons(ETH_TYPE_IP)
 478                 && flow->nw_proto == IPPROTO_ICMP) {
 479             struct odp_key_icmp *icmp_key;
 480
 481             icmp_key = nl_msg_put_unspec_uninit(buf, ODP_KEY_ATTR_ICMP,
 482                                                 sizeof *icmp_key);
 483             icmp_key->icmp_type = ntohs(flow->tp_src);
 484             icmp_key->icmp_code = ntohs(flow->tp_dst);
 485         } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
 486                 && flow->nw_proto == IPPROTO_ICMPV6) {
 487             struct odp_key_icmpv6 *icmpv6_key;
 488
 489             icmpv6_key = nl_msg_put_unspec_uninit(buf, ODP_KEY_ATTR_ICMPV6,
 490                                                   sizeof *icmpv6_key);
 491             icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
 492             icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
 493
 494             if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
 495                     || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
 496                 struct odp_key_nd *nd_key;
 497
 498                 nd_key = nl_msg_put_unspec_uninit(buf, ODP_KEY_ATTR_ND,
 499                                                     sizeof *nd_key);
 500                 memcpy(nd_key->nd_target, &flow->nd_target,
 501                         sizeof nd_key->nd_target);
 502                 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
 503                 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
 504             }
 505         }
 506     }
 507 }
 508
 509 /* Converts the 'key_len' bytes of ODP_KEY_ATTR_* attributes in 'key' to a flow
 510  * structure in 'flow'.  Returns 0 if successful, otherwise EINVAL. */
 511 int
 512 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
 513                      struct flow *flow)
 514 {
 515     const struct nlattr *nla;
 516     enum odp_key_type prev_type;
 517     size_t left;
 518
 519     memset(flow, 0, sizeof *flow);
 520     flow->dl_type = htons(FLOW_DL_TYPE_NONE);
 521     flow->in_port = OFPP_NONE;
 522
 523     prev_type = ODP_KEY_ATTR_UNSPEC;
 524     NL_ATTR_FOR_EACH (nla, left, key, key_len) {
 525         const struct odp_key_ethernet *eth_key;
 526         const struct odp_key_8021q *q_key;
 527         const struct odp_key_ipv4 *ipv4_key;
 528         const struct odp_key_ipv6 *ipv6_key;
 529         const struct odp_key_tcp *tcp_key;
 530         const struct odp_key_udp *udp_key;
 531         const struct odp_key_icmp *icmp_key;
 532         const struct odp_key_icmpv6 *icmpv6_key;
 533         const struct odp_key_arp *arp_key;
 534         const struct odp_key_nd *nd_key;
 535
 536         uint16_t type = nl_attr_type(nla);
 537         int len = odp_flow_key_attr_len(type);
 538
 539         if (nl_attr_get_size(nla) != len && len != -1) {
 540             return EINVAL;
 541         }
 542
 543 #define TRANSITION(PREV_TYPE, TYPE) (((PREV_TYPE) << 16) | (TYPE))
 544         switch (TRANSITION(prev_type, type)) {
 545         case TRANSITION(ODP_KEY_ATTR_UNSPEC, ODP_KEY_ATTR_TUN_ID):
 546             flow->tun_id = nl_attr_get_be64(nla);
 547             break;
 548
 549         case TRANSITION(ODP_KEY_ATTR_UNSPEC, ODP_KEY_ATTR_IN_PORT):
 550         case TRANSITION(ODP_KEY_ATTR_TUN_ID, ODP_KEY_ATTR_IN_PORT):
 551             if (nl_attr_get_u32(nla) >= UINT16_MAX) {
 552                 return EINVAL;
 553             }
 554             flow->in_port = odp_port_to_ofp_port(nl_attr_get_u32(nla));
 555             break;
 556
 557         case TRANSITION(ODP_KEY_ATTR_UNSPEC, ODP_KEY_ATTR_ETHERNET):
 558         case TRANSITION(ODP_KEY_ATTR_TUN_ID, ODP_KEY_ATTR_ETHERNET):
 559         case TRANSITION(ODP_KEY_ATTR_IN_PORT, ODP_KEY_ATTR_ETHERNET):
 560             eth_key = nl_attr_get(nla);
 561             memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
 562             memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
 563             break;
 564
 565         case TRANSITION(ODP_KEY_ATTR_ETHERNET, ODP_KEY_ATTR_8021Q):
 566             q_key = nl_attr_get(nla);
 567             if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
 568                 /* Only standard 0x8100 VLANs currently supported. */
 569                 return EINVAL;
 570             }
 571             if (q_key->q_tci & htons(VLAN_CFI)) {
 572                 return EINVAL;
 573             }
 574             flow->vlan_tci = q_key->q_tci | htons(VLAN_CFI);
 575             break;
 576
 577         case TRANSITION(ODP_KEY_ATTR_8021Q, ODP_KEY_ATTR_ETHERTYPE):
 578         case TRANSITION(ODP_KEY_ATTR_ETHERNET, ODP_KEY_ATTR_ETHERTYPE):
 579             flow->dl_type = nl_attr_get_be16(nla);
 580             if (ntohs(flow->dl_type) < 1536) {
 581                 return EINVAL;
 582             }
 583             break;
 584
 585         case TRANSITION(ODP_KEY_ATTR_ETHERTYPE, ODP_KEY_ATTR_IPV4):
 586             if (flow->dl_type != htons(ETH_TYPE_IP)) {
 587                 return EINVAL;
 588             }
 589             ipv4_key = nl_attr_get(nla);
 590             flow->nw_src = ipv4_key->ipv4_src;
 591             flow->nw_dst = ipv4_key->ipv4_dst;
 592             flow->nw_proto = ipv4_key->ipv4_proto;
 593             flow->nw_tos = ipv4_key->ipv4_tos;
 594             if (flow->nw_tos & IP_ECN_MASK) {
 595                 return EINVAL;
 596             }
 597             break;
 598
 599         case TRANSITION(ODP_KEY_ATTR_ETHERTYPE, ODP_KEY_ATTR_IPV6):
 600             if (flow->dl_type != htons(ETH_TYPE_IPV6)) {
 601                 return EINVAL;
 602             }
 603             ipv6_key = nl_attr_get(nla);
 604             memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
 605             memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
 606             flow->nw_proto = ipv6_key->ipv6_proto;
 607             flow->nw_tos = ipv6_key->ipv6_tos;
 608             if (flow->nw_tos & IP_ECN_MASK) {
 609                 return EINVAL;
 610             }
 611             break;
 612
 613         case TRANSITION(ODP_KEY_ATTR_IPV4, ODP_KEY_ATTR_TCP):
 614         case TRANSITION(ODP_KEY_ATTR_IPV6, ODP_KEY_ATTR_TCP):
 615             if (flow->nw_proto != IPPROTO_TCP) {
 616                 return EINVAL;
 617             }
 618             tcp_key = nl_attr_get(nla);
 619             flow->tp_src = tcp_key->tcp_src;
 620             flow->tp_dst = tcp_key->tcp_dst;
 621             break;
 622
 623         case TRANSITION(ODP_KEY_ATTR_IPV4, ODP_KEY_ATTR_UDP):
 624         case TRANSITION(ODP_KEY_ATTR_IPV6, ODP_KEY_ATTR_UDP):
 625             if (flow->nw_proto != IPPROTO_UDP) {
 626                 return EINVAL;
 627             }
 628             udp_key = nl_attr_get(nla);
 629             flow->tp_src = udp_key->udp_src;
 630             flow->tp_dst = udp_key->udp_dst;
 631             break;
 632
 633         case TRANSITION(ODP_KEY_ATTR_IPV4, ODP_KEY_ATTR_ICMP):
 634             if (flow->nw_proto != IPPROTO_ICMP) {
 635                 return EINVAL;
 636             }
 637             icmp_key = nl_attr_get(nla);
 638             flow->tp_src = htons(icmp_key->icmp_type);
 639             flow->tp_dst = htons(icmp_key->icmp_code);
 640             break;
 641
 642         case TRANSITION(ODP_KEY_ATTR_IPV6, ODP_KEY_ATTR_ICMPV6):
 643             if (flow->nw_proto != IPPROTO_ICMPV6) {
 644                 return EINVAL;
 645             }
 646             icmpv6_key = nl_attr_get(nla);
 647             flow->tp_src = htons(icmpv6_key->icmpv6_type);
 648             flow->tp_dst = htons(icmpv6_key->icmpv6_code);
 649             break;
 650
 651         case TRANSITION(ODP_KEY_ATTR_ETHERTYPE, ODP_KEY_ATTR_ARP):
 652             if (flow->dl_type != htons(ETH_TYPE_ARP)) {
 653                 return EINVAL;
 654             }
 655             arp_key = nl_attr_get(nla);
 656             flow->nw_src = arp_key->arp_sip;
 657             flow->nw_dst = arp_key->arp_tip;
 658             if (arp_key->arp_op & htons(0xff00)) {
 659                 return EINVAL;
 660             }
 661             flow->nw_proto = ntohs(arp_key->arp_op);
 662             memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
 663             memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
 664             break;
 665
 666         case TRANSITION(ODP_KEY_ATTR_ICMPV6, ODP_KEY_ATTR_ND):
 667             if (flow->tp_src != htons(ND_NEIGHBOR_SOLICIT)
 668                     && flow->tp_src != htons(ND_NEIGHBOR_ADVERT)) {
 669                 return EINVAL;
 670             }
 671             nd_key = nl_attr_get(nla);
 672             memcpy(&flow->nd_target, nd_key->nd_target, sizeof flow->nd_target);
 673             memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
 674             memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
 675             break;
 676
 677         default:
 678             if (type == ODP_KEY_ATTR_UNSPEC
 679                 || prev_type == ODP_KEY_ATTR_UNSPEC) {
 680                 return EINVAL;
 681             }
 682             return EINVAL;
 683         }
 684
 685         prev_type = type;
 686     }
 687     if (left) {
 688         return EINVAL;
 689     }
 690
 691     switch (prev_type) {
 692     case ODP_KEY_ATTR_UNSPEC:
 693         return EINVAL;
 694
 695     case ODP_KEY_ATTR_TUN_ID:
 696     case ODP_KEY_ATTR_IN_PORT:
 697         return EINVAL;
 698
 699     case ODP_KEY_ATTR_ETHERNET:
 700     case ODP_KEY_ATTR_8021Q:
 701         return 0;
 702
 703     case ODP_KEY_ATTR_ETHERTYPE:
 704         if (flow->dl_type == htons(ETH_TYPE_IP)
 705             || flow->dl_type == htons(ETH_TYPE_IPV6)
 706             || flow->dl_type == htons(ETH_TYPE_ARP)) {
 707             return EINVAL;
 708         }
 709         return 0;
 710
 711     case ODP_KEY_ATTR_IPV4:
 712         if (flow->nw_proto == IPPROTO_TCP
 713             || flow->nw_proto == IPPROTO_UDP
 714             || flow->nw_proto == IPPROTO_ICMP) {
 715             return EINVAL;
 716         }
 717         return 0;
 718
 719     case ODP_KEY_ATTR_IPV6:
 720         if (flow->nw_proto == IPPROTO_TCP
 721             || flow->nw_proto == IPPROTO_UDP
 722             || flow->nw_proto == IPPROTO_ICMPV6) {
 723             return EINVAL;
 724         }
 725         return 0;
 726
 727     case ODP_KEY_ATTR_ICMPV6:
 728         if (flow->icmp_type == htons(ND_NEIGHBOR_SOLICIT)
 729             || flow->icmp_type == htons(ND_NEIGHBOR_ADVERT)) {
 730             return EINVAL;
 731         }
 732         return 0;
 733
 734     case ODP_KEY_ATTR_TCP:
 735     case ODP_KEY_ATTR_UDP:
 736     case ODP_KEY_ATTR_ICMP:
 737     case ODP_KEY_ATTR_ARP:
 738     case ODP_KEY_ATTR_ND:
 739         return 0;
 740
 741     case __ODP_KEY_ATTR_MAX:
 742     default:
 743         NOT_REACHED();
 744     }
 745 }