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