2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #include <arpa/inet.h>
23 #include <netinet/in.h>
24 #include <netinet/icmp6.h>
27 #include "byte-order.h"
29 #include "dynamic-string.h"
33 #include "openvswitch/tunnel.h"
40 VLOG_DEFINE_THIS_MODULE(odp_util);
42 /* The interface between userspace and kernel uses an "OVS_*" prefix.
43 * Since this is fairly non-specific for the OVS userspace components,
44 * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
45 * interactions with the datapath.
48 /* The set of characters that may separate one action or one key attribute
50 static const char *delimiters = ", \t\r\n";
52 static int parse_odp_key_attr(const char *, const struct shash *port_names,
54 static void format_odp_key_attr(const struct nlattr *a, struct ds *ds);
56 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
59 * - For an action whose argument has a fixed length, returned that
60 * nonnegative length in bytes.
62 * - For an action with a variable-length argument, returns -2.
64 * - For an invalid 'type', returns -1. */
66 odp_action_len(uint16_t type)
68 if (type > OVS_ACTION_ATTR_MAX) {
72 switch ((enum ovs_action_attr) type) {
73 case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
74 case OVS_ACTION_ATTR_USERSPACE: return -2;
75 case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
76 case OVS_ACTION_ATTR_POP_VLAN: return 0;
77 case OVS_ACTION_ATTR_SET: return -2;
78 case OVS_ACTION_ATTR_SAMPLE: return -2;
80 case OVS_ACTION_ATTR_UNSPEC:
81 case __OVS_ACTION_ATTR_MAX:
89 ovs_key_attr_to_string(enum ovs_key_attr attr)
91 static char unknown_attr[3 + INT_STRLEN(unsigned int) + 1];
94 case OVS_KEY_ATTR_UNSPEC: return "unspec";
95 case OVS_KEY_ATTR_ENCAP: return "encap";
96 case OVS_KEY_ATTR_PRIORITY: return "priority";
97 case OVS_KEY_ATTR_IN_PORT: return "in_port";
98 case OVS_KEY_ATTR_ETHERNET: return "eth";
99 case OVS_KEY_ATTR_VLAN: return "vlan";
100 case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
101 case OVS_KEY_ATTR_IPV4: return "ipv4";
102 case OVS_KEY_ATTR_IPV6: return "ipv6";
103 case OVS_KEY_ATTR_TCP: return "tcp";
104 case OVS_KEY_ATTR_UDP: return "udp";
105 case OVS_KEY_ATTR_ICMP: return "icmp";
106 case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
107 case OVS_KEY_ATTR_ARP: return "arp";
108 case OVS_KEY_ATTR_ND: return "nd";
109 case OVS_KEY_ATTR_TUN_ID: return "tun_id";
111 case __OVS_KEY_ATTR_MAX:
113 snprintf(unknown_attr, sizeof unknown_attr, "key%u",
114 (unsigned int) attr);
120 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
122 size_t len = nl_attr_get_size(a);
124 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
126 const uint8_t *unspec;
129 unspec = nl_attr_get(a);
130 for (i = 0; i < len; i++) {
131 ds_put_char(ds, i ? ' ': '(');
132 ds_put_format(ds, "%02x", unspec[i]);
134 ds_put_char(ds, ')');
139 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
141 static const struct nl_policy ovs_sample_policy[] = {
142 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
143 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
145 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
147 const struct nlattr *nla_acts;
150 ds_put_cstr(ds, "sample");
152 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
153 ds_put_cstr(ds, "(error)");
157 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
160 ds_put_format(ds, "(sample=%.1f%%,", percentage);
162 ds_put_cstr(ds, "actions(");
163 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
164 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
165 format_odp_actions(ds, nla_acts, len);
166 ds_put_format(ds, "))");
170 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
172 static const struct nl_policy ovs_userspace_policy[] = {
173 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
174 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
176 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
178 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
179 ds_put_cstr(ds, "userspace(error)");
183 ds_put_format(ds, "userspace(pid=%"PRIu32,
184 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
186 if (a[OVS_USERSPACE_ATTR_USERDATA]) {
187 uint64_t userdata = nl_attr_get_u64(a[OVS_USERSPACE_ATTR_USERDATA]);
188 struct user_action_cookie cookie;
190 memcpy(&cookie, &userdata, sizeof cookie);
192 if (cookie.type == USER_ACTION_COOKIE_CONTROLLER) {
193 ds_put_format(ds, ",controller,length=%"PRIu32, cookie.data);
194 } else if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
195 ds_put_format(ds, ",sFlow,n_output=%"PRIu8","
196 "vid=%"PRIu16",pcp=%"PRIu8",ifindex=%"PRIu32,
197 cookie.n_output, vlan_tci_to_vid(cookie.vlan_tci),
198 vlan_tci_to_pcp(cookie.vlan_tci), cookie.data);
200 ds_put_format(ds, ",userdata=0x%"PRIx64, userdata);
204 ds_put_char(ds, ')');
208 format_vlan_tci(struct ds *ds, ovs_be16 vlan_tci)
210 ds_put_format(ds, "vid=%"PRIu16",pcp=%d",
211 vlan_tci_to_vid(vlan_tci),
212 vlan_tci_to_pcp(vlan_tci));
213 if (!(vlan_tci & htons(VLAN_CFI))) {
214 ds_put_cstr(ds, ",cfi=0");
219 format_odp_action(struct ds *ds, const struct nlattr *a)
222 enum ovs_action_attr type = nl_attr_type(a);
223 const struct ovs_action_push_vlan *vlan;
225 expected_len = odp_action_len(nl_attr_type(a));
226 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
227 ds_put_format(ds, "bad length %zu, expected %d for: ",
228 nl_attr_get_size(a), expected_len);
229 format_generic_odp_action(ds, a);
234 case OVS_ACTION_ATTR_OUTPUT:
235 ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
237 case OVS_ACTION_ATTR_USERSPACE:
238 format_odp_userspace_action(ds, a);
240 case OVS_ACTION_ATTR_SET:
241 ds_put_cstr(ds, "set(");
242 format_odp_key_attr(nl_attr_get(a), ds);
243 ds_put_cstr(ds, ")");
245 case OVS_ACTION_ATTR_PUSH_VLAN:
246 vlan = nl_attr_get(a);
247 ds_put_cstr(ds, "push_vlan(");
248 if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
249 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
251 format_vlan_tci(ds, vlan->vlan_tci);
252 ds_put_char(ds, ')');
254 case OVS_ACTION_ATTR_POP_VLAN:
255 ds_put_cstr(ds, "pop_vlan");
257 case OVS_ACTION_ATTR_SAMPLE:
258 format_odp_sample_action(ds, a);
260 case OVS_ACTION_ATTR_UNSPEC:
261 case __OVS_ACTION_ATTR_MAX:
263 format_generic_odp_action(ds, a);
269 format_odp_actions(struct ds *ds, const struct nlattr *actions,
273 const struct nlattr *a;
276 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
278 ds_put_char(ds, ',');
280 format_odp_action(ds, a);
283 if (left == actions_len) {
284 ds_put_cstr(ds, "<empty>");
286 ds_put_format(ds, ",***%u leftover bytes***", left);
289 ds_put_cstr(ds, "drop");
294 parse_odp_action(const char *s, const struct shash *port_names,
295 struct ofpbuf *actions)
297 /* Many of the sscanf calls in this function use oversized destination
298 * fields because some sscanf() implementations truncate the range of %i
299 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
300 * value of 0x7fff. The other alternatives are to allow only a single
301 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
304 * The tun_id parser has to use an alternative approach because there is no
305 * type larger than 64 bits. */
308 unsigned long long int port;
311 if (sscanf(s, "%lli%n", &port, &n) > 0 && n > 0) {
312 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
318 int len = strcspn(s, delimiters);
319 struct shash_node *node;
321 node = shash_find_len(port_names, s, len);
323 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT,
324 (uintptr_t) node->data);
330 unsigned long long int pid;
331 unsigned long long int length;
332 unsigned long long int ifindex;
338 if (sscanf(s, "userspace(pid=%lli)%n", &pid, &n) > 0 && n > 0) {
339 odp_put_userspace_action(pid, NULL, actions);
341 } else if (sscanf(s, "userspace(pid=%lli,controller,length=%lli)%n",
342 &pid, &length, &n) > 0 && n > 0) {
343 struct user_action_cookie cookie;
345 cookie.type = USER_ACTION_COOKIE_CONTROLLER;
347 cookie.vlan_tci = htons(0);
348 cookie.data = length;
349 odp_put_userspace_action(pid, &cookie, actions);
351 } else if (sscanf(s, "userspace(pid=%lli,sFlow,n_output=%i,vid=%i,"
352 "pcp=%i,ifindex=%lli)%n", &pid, &n_output,
353 &vid, &pcp, &ifindex, &n) > 0 && n > 0) {
354 struct user_action_cookie cookie;
357 tci = vid | (pcp << VLAN_PCP_SHIFT);
362 cookie.type = USER_ACTION_COOKIE_SFLOW;
363 cookie.n_output = n_output;
364 cookie.vlan_tci = htons(tci);
365 cookie.data = ifindex;
366 odp_put_userspace_action(pid, &cookie, actions);
368 } else if (sscanf(s, "userspace(pid=%lli,userdata="
369 "%31[x0123456789abcdefABCDEF])%n", &pid, userdata_s,
371 struct user_action_cookie cookie;
374 userdata = strtoull(userdata_s, NULL, 0);
375 memcpy(&cookie, &userdata, sizeof cookie);
376 odp_put_userspace_action(pid, &cookie, actions);
381 if (!strncmp(s, "set(", 4)) {
385 start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
386 retval = parse_odp_key_attr(s + 4, port_names, actions);
390 if (s[retval + 4] != ')') {
393 nl_msg_end_nested(actions, start_ofs);
398 struct ovs_action_push_vlan push;
399 int tpid = ETH_TYPE_VLAN;
404 if ((sscanf(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n) > 0
406 || (sscanf(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
407 &vid, &pcp, &cfi, &n) > 0 && n > 0)
408 || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
409 &tpid, &vid, &pcp, &n) > 0 && n > 0)
410 || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
411 &tpid, &vid, &pcp, &cfi, &n) > 0 && n > 0)) {
412 push.vlan_tpid = htons(tpid);
413 push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
414 | (pcp << VLAN_PCP_SHIFT)
415 | (cfi ? VLAN_CFI : 0));
416 nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
423 if (!strncmp(s, "pop_vlan", 8)) {
424 nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
432 if (sscanf(s, "sample(sample=%lf%%,actions(%n", &percentage, &n) > 0
433 && percentage >= 0. && percentage <= 100.0
435 size_t sample_ofs, actions_ofs;
438 probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
439 sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
440 nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
441 (probability <= 0 ? 0
442 : probability >= UINT32_MAX ? UINT32_MAX
445 actions_ofs = nl_msg_start_nested(actions,
446 OVS_SAMPLE_ATTR_ACTIONS);
450 s += strspn(s, delimiters);
455 retval = parse_odp_action(s + n, port_names, actions);
462 nl_msg_end_nested(actions, actions_ofs);
463 nl_msg_end_nested(actions, sample_ofs);
465 return s[n + 1] == ')' ? n + 2 : -EINVAL;
472 /* Parses the string representation of datapath actions, in the format output
473 * by format_odp_action(). Returns 0 if successful, otherwise a positive errno
474 * value. On success, the ODP actions are appended to 'actions' as a series of
475 * Netlink attributes. On failure, no data is appended to 'actions'. Either
476 * way, 'actions''s data might be reallocated. */
478 odp_actions_from_string(const char *s, const struct shash *port_names,
479 struct ofpbuf *actions)
483 if (!strcasecmp(s, "drop")) {
487 old_size = actions->size;
491 s += strspn(s, delimiters);
496 retval = parse_odp_action(s, port_names, actions);
497 if (retval < 0 || !strchr(delimiters, s[retval])) {
498 actions->size = old_size;
507 /* Returns the correct length of the payload for a flow key attribute of the
508 * specified 'type', -1 if 'type' is unknown, or -2 if the attribute's payload
509 * is variable length. */
511 odp_flow_key_attr_len(uint16_t type)
513 if (type > OVS_KEY_ATTR_MAX) {
517 switch ((enum ovs_key_attr) type) {
518 case OVS_KEY_ATTR_ENCAP: return -2;
519 case OVS_KEY_ATTR_PRIORITY: return 4;
520 case OVS_KEY_ATTR_TUN_ID: return 8;
521 case OVS_KEY_ATTR_IN_PORT: return 4;
522 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
523 case OVS_KEY_ATTR_VLAN: return sizeof(ovs_be16);
524 case OVS_KEY_ATTR_ETHERTYPE: return 2;
525 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
526 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
527 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
528 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
529 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
530 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
531 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
532 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
534 case OVS_KEY_ATTR_UNSPEC:
535 case __OVS_KEY_ATTR_MAX:
543 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
545 size_t len = nl_attr_get_size(a);
547 const uint8_t *unspec;
550 unspec = nl_attr_get(a);
551 for (i = 0; i < len; i++) {
552 ds_put_char(ds, i ? ' ': '(');
553 ds_put_format(ds, "%02x", unspec[i]);
555 ds_put_char(ds, ')');
560 ovs_frag_type_to_string(enum ovs_frag_type type)
563 case OVS_FRAG_TYPE_NONE:
565 case OVS_FRAG_TYPE_FIRST:
567 case OVS_FRAG_TYPE_LATER:
569 case __OVS_FRAG_TYPE_MAX:
576 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
578 const struct ovs_key_ethernet *eth_key;
579 const struct ovs_key_ipv4 *ipv4_key;
580 const struct ovs_key_ipv6 *ipv6_key;
581 const struct ovs_key_tcp *tcp_key;
582 const struct ovs_key_udp *udp_key;
583 const struct ovs_key_icmp *icmp_key;
584 const struct ovs_key_icmpv6 *icmpv6_key;
585 const struct ovs_key_arp *arp_key;
586 const struct ovs_key_nd *nd_key;
587 enum ovs_key_attr attr = nl_attr_type(a);
590 ds_put_cstr(ds, ovs_key_attr_to_string(attr));
591 expected_len = odp_flow_key_attr_len(nl_attr_type(a));
592 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
593 ds_put_format(ds, "(bad length %zu, expected %d)",
595 odp_flow_key_attr_len(nl_attr_type(a)));
596 format_generic_odp_key(a, ds);
601 case OVS_KEY_ATTR_ENCAP:
602 ds_put_cstr(ds, "(");
603 if (nl_attr_get_size(a)) {
604 odp_flow_key_format(nl_attr_get(a), nl_attr_get_size(a), ds);
606 ds_put_char(ds, ')');
609 case OVS_KEY_ATTR_PRIORITY:
610 ds_put_format(ds, "(%"PRIu32")", nl_attr_get_u32(a));
613 case OVS_KEY_ATTR_TUN_ID:
614 ds_put_format(ds, "(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
617 case OVS_KEY_ATTR_IN_PORT:
618 ds_put_format(ds, "(%"PRIu32")", nl_attr_get_u32(a));
621 case OVS_KEY_ATTR_ETHERNET:
622 eth_key = nl_attr_get(a);
623 ds_put_format(ds, "(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
624 ETH_ADDR_ARGS(eth_key->eth_src),
625 ETH_ADDR_ARGS(eth_key->eth_dst));
628 case OVS_KEY_ATTR_VLAN:
629 ds_put_char(ds, '(');
630 format_vlan_tci(ds, nl_attr_get_be16(a));
631 ds_put_char(ds, ')');
634 case OVS_KEY_ATTR_ETHERTYPE:
635 ds_put_format(ds, "(0x%04"PRIx16")",
636 ntohs(nl_attr_get_be16(a)));
639 case OVS_KEY_ATTR_IPV4:
640 ipv4_key = nl_attr_get(a);
641 ds_put_format(ds, "(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
642 ",tos=%#"PRIx8",ttl=%"PRIu8",frag=%s)",
643 IP_ARGS(&ipv4_key->ipv4_src),
644 IP_ARGS(&ipv4_key->ipv4_dst),
645 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
647 ovs_frag_type_to_string(ipv4_key->ipv4_frag));
650 case OVS_KEY_ATTR_IPV6: {
651 char src_str[INET6_ADDRSTRLEN];
652 char dst_str[INET6_ADDRSTRLEN];
654 ipv6_key = nl_attr_get(a);
655 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
656 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
658 ds_put_format(ds, "(src=%s,dst=%s,label=%#"PRIx32",proto=%"PRIu8
659 ",tclass=%#"PRIx8",hlimit=%"PRIu8",frag=%s)",
660 src_str, dst_str, ntohl(ipv6_key->ipv6_label),
661 ipv6_key->ipv6_proto, ipv6_key->ipv6_tclass,
662 ipv6_key->ipv6_hlimit,
663 ovs_frag_type_to_string(ipv6_key->ipv6_frag));
667 case OVS_KEY_ATTR_TCP:
668 tcp_key = nl_attr_get(a);
669 ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
670 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
673 case OVS_KEY_ATTR_UDP:
674 udp_key = nl_attr_get(a);
675 ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
676 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
679 case OVS_KEY_ATTR_ICMP:
680 icmp_key = nl_attr_get(a);
681 ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
682 icmp_key->icmp_type, icmp_key->icmp_code);
685 case OVS_KEY_ATTR_ICMPV6:
686 icmpv6_key = nl_attr_get(a);
687 ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
688 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
691 case OVS_KEY_ATTR_ARP:
692 arp_key = nl_attr_get(a);
693 ds_put_format(ds, "(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
694 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
695 IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
696 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
697 ETH_ADDR_ARGS(arp_key->arp_tha));
700 case OVS_KEY_ATTR_ND: {
701 char target[INET6_ADDRSTRLEN];
703 nd_key = nl_attr_get(a);
704 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
706 ds_put_format(ds, "(target=%s", target);
707 if (!eth_addr_is_zero(nd_key->nd_sll)) {
708 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
709 ETH_ADDR_ARGS(nd_key->nd_sll));
711 if (!eth_addr_is_zero(nd_key->nd_tll)) {
712 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
713 ETH_ADDR_ARGS(nd_key->nd_tll));
715 ds_put_char(ds, ')');
719 case OVS_KEY_ATTR_UNSPEC:
720 case __OVS_KEY_ATTR_MAX:
722 format_generic_odp_key(a, ds);
727 /* Appends to 'ds' a string representation of the 'key_len' bytes of
728 * OVS_KEY_ATTR_* attributes in 'key'. */
730 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
733 const struct nlattr *a;
736 NL_ATTR_FOR_EACH (a, left, key, key_len) {
738 ds_put_char(ds, ',');
740 format_odp_key_attr(a, ds);
743 if (left == key_len) {
744 ds_put_cstr(ds, "<empty>");
746 ds_put_format(ds, ",***%u leftover bytes***", left);
749 ds_put_cstr(ds, "<empty>");
754 put_nd_key(int n, const char *nd_target_s,
755 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
757 struct ovs_key_nd nd_key;
759 memset(&nd_key, 0, sizeof nd_key);
760 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
764 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
767 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
769 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
774 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
776 if (!strcasecmp(s, "no")) {
777 *type = OVS_FRAG_TYPE_NONE;
778 } else if (!strcasecmp(s, "first")) {
779 *type = OVS_FRAG_TYPE_FIRST;
780 } else if (!strcasecmp(s, "later")) {
781 *type = OVS_FRAG_TYPE_LATER;
789 parse_odp_key_attr(const char *s, const struct shash *port_names,
792 /* Many of the sscanf calls in this function use oversized destination
793 * fields because some sscanf() implementations truncate the range of %i
794 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
795 * value of 0x7fff. The other alternatives are to allow only a single
796 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
799 * The tun_id parser has to use an alternative approach because there is no
800 * type larger than 64 bits. */
803 unsigned long long int priority;
806 if (sscanf(s, "priority(%lli)%n", &priority, &n) > 0 && n > 0) {
807 nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
816 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
817 tun_id_s, &n) > 0 && n > 0) {
818 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
819 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
825 unsigned long long int in_port;
828 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
829 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
834 if (port_names && !strncmp(s, "in_port(", 8)) {
836 const struct shash_node *node;
840 name_len = strcspn(s, ")");
841 node = shash_find_len(port_names, name, name_len);
843 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, (uintptr_t) node->data);
844 return 8 + name_len + 1;
849 struct ovs_key_ethernet eth_key;
853 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
854 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
855 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
856 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
857 ð_key, sizeof eth_key);
868 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n", &vid, &pcp, &n) > 0
870 nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
871 htons((vid << VLAN_VID_SHIFT) |
872 (pcp << VLAN_PCP_SHIFT) |
875 } else if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i,cfi=%i)%n",
876 &vid, &pcp, &cfi, &n) > 0
878 nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
879 htons((vid << VLAN_VID_SHIFT) |
880 (pcp << VLAN_PCP_SHIFT) |
881 (cfi ? VLAN_CFI : 0)));
890 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
891 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
903 enum ovs_frag_type ipv4_frag;
906 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
907 "proto=%i,tos=%i,ttl=%i,frag=%7[a-z])%n",
908 IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
909 &ipv4_proto, &ipv4_tos, &ipv4_ttl, frag, &n) > 0
911 && ovs_frag_type_from_string(frag, &ipv4_frag)) {
912 struct ovs_key_ipv4 ipv4_key;
914 ipv4_key.ipv4_src = ipv4_src;
915 ipv4_key.ipv4_dst = ipv4_dst;
916 ipv4_key.ipv4_proto = ipv4_proto;
917 ipv4_key.ipv4_tos = ipv4_tos;
918 ipv4_key.ipv4_ttl = ipv4_ttl;
919 ipv4_key.ipv4_frag = ipv4_frag;
920 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
921 &ipv4_key, sizeof ipv4_key);
927 char ipv6_src_s[IPV6_SCAN_LEN + 1];
928 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
934 enum ovs_frag_type ipv6_frag;
937 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
938 "label=%i,proto=%i,tclass=%i,hlimit=%i,frag=%7[a-z])%n",
939 ipv6_src_s, ipv6_dst_s, &ipv6_label,
940 &ipv6_proto, &ipv6_tclass, &ipv6_hlimit, frag, &n) > 0
942 && ovs_frag_type_from_string(frag, &ipv6_frag)) {
943 struct ovs_key_ipv6 ipv6_key;
945 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
946 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
949 ipv6_key.ipv6_label = htonl(ipv6_label);
950 ipv6_key.ipv6_proto = ipv6_proto;
951 ipv6_key.ipv6_tclass = ipv6_tclass;
952 ipv6_key.ipv6_hlimit = ipv6_hlimit;
953 ipv6_key.ipv6_frag = ipv6_frag;
954 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
955 &ipv6_key, sizeof ipv6_key);
965 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
967 struct ovs_key_tcp tcp_key;
969 tcp_key.tcp_src = htons(tcp_src);
970 tcp_key.tcp_dst = htons(tcp_dst);
971 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
981 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
983 struct ovs_key_udp udp_key;
985 udp_key.udp_src = htons(udp_src);
986 udp_key.udp_dst = htons(udp_dst);
987 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
997 if (sscanf(s, "icmp(type=%i,code=%i)%n",
998 &icmp_type, &icmp_code, &n) > 0
1000 struct ovs_key_icmp icmp_key;
1002 icmp_key.icmp_type = icmp_type;
1003 icmp_key.icmp_code = icmp_code;
1004 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
1005 &icmp_key, sizeof icmp_key);
1011 struct ovs_key_icmpv6 icmpv6_key;
1014 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
1015 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
1017 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
1018 &icmpv6_key, sizeof icmpv6_key);
1027 uint8_t arp_sha[ETH_ADDR_LEN];
1028 uint8_t arp_tha[ETH_ADDR_LEN];
1031 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
1032 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
1033 IP_SCAN_ARGS(&arp_sip),
1034 IP_SCAN_ARGS(&arp_tip),
1036 ETH_ADDR_SCAN_ARGS(arp_sha),
1037 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
1038 struct ovs_key_arp arp_key;
1040 memset(&arp_key, 0, sizeof arp_key);
1041 arp_key.arp_sip = arp_sip;
1042 arp_key.arp_tip = arp_tip;
1043 arp_key.arp_op = htons(arp_op);
1044 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
1045 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
1046 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
1052 char nd_target_s[IPV6_SCAN_LEN + 1];
1053 uint8_t nd_sll[ETH_ADDR_LEN];
1054 uint8_t nd_tll[ETH_ADDR_LEN];
1057 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
1058 nd_target_s, &n) > 0 && n > 0) {
1059 return put_nd_key(n, nd_target_s, NULL, NULL, key);
1061 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
1062 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
1064 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
1066 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
1067 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
1069 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
1071 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
1072 "tll="ETH_ADDR_SCAN_FMT")%n",
1073 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
1074 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
1076 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
1080 if (!strncmp(s, "encap(", 6)) {
1081 const char *start = s;
1084 encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
1090 s += strspn(s, ", \t\r\n");
1093 } else if (*s == ')') {
1097 retval = parse_odp_key_attr(s, port_names, key);
1105 nl_msg_end_nested(key, encap);
1113 /* Parses the string representation of a datapath flow key, in the
1114 * format output by odp_flow_key_format(). Returns 0 if successful,
1115 * otherwise a positive errno value. On success, the flow key is
1116 * appended to 'key' as a series of Netlink attributes. On failure, no
1117 * data is appended to 'key'. Either way, 'key''s data might be
1120 * If 'port_names' is nonnull, it points to an shash that maps from a port name
1121 * to a port number cast to void *. (Port names may be used instead of port
1122 * numbers in in_port.)
1124 * On success, the attributes appended to 'key' are individually syntactically
1125 * valid, but they may not be valid as a sequence. 'key' might, for example,
1126 * have duplicated keys. odp_flow_key_to_flow() will detect those errors. */
1128 odp_flow_key_from_string(const char *s, const struct shash *port_names,
1131 const size_t old_size = key->size;
1135 s += strspn(s, delimiters);
1140 retval = parse_odp_key_attr(s, port_names, key);
1142 key->size = old_size;
1152 ovs_to_odp_frag(uint8_t ovs_frag)
1154 return (ovs_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
1155 : ovs_frag & FLOW_NW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
1156 : OVS_FRAG_TYPE_NONE);
1159 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
1161 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
1163 struct ovs_key_ethernet *eth_key;
1166 if (flow->priority) {
1167 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, flow->priority);
1170 if (flow->tun_id != htonll(0)) {
1171 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
1174 if (flow->in_port != OFPP_NONE) {
1175 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
1176 ofp_port_to_odp_port(flow->in_port));
1179 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
1181 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
1182 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
1184 if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
1185 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
1186 nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, flow->vlan_tci);
1187 encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
1188 if (flow->vlan_tci == htons(0)) {
1195 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
1199 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
1201 if (flow->dl_type == htons(ETH_TYPE_IP)) {
1202 struct ovs_key_ipv4 *ipv4_key;
1204 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
1206 ipv4_key->ipv4_src = flow->nw_src;
1207 ipv4_key->ipv4_dst = flow->nw_dst;
1208 ipv4_key->ipv4_proto = flow->nw_proto;
1209 ipv4_key->ipv4_tos = flow->nw_tos;
1210 ipv4_key->ipv4_ttl = flow->nw_ttl;
1211 ipv4_key->ipv4_frag = ovs_to_odp_frag(flow->nw_frag);
1212 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1213 struct ovs_key_ipv6 *ipv6_key;
1215 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
1217 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
1218 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
1219 ipv6_key->ipv6_label = flow->ipv6_label;
1220 ipv6_key->ipv6_proto = flow->nw_proto;
1221 ipv6_key->ipv6_tclass = flow->nw_tos;
1222 ipv6_key->ipv6_hlimit = flow->nw_ttl;
1223 ipv6_key->ipv6_frag = ovs_to_odp_frag(flow->nw_frag);
1224 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
1225 struct ovs_key_arp *arp_key;
1227 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
1229 memset(arp_key, 0, sizeof *arp_key);
1230 arp_key->arp_sip = flow->nw_src;
1231 arp_key->arp_tip = flow->nw_dst;
1232 arp_key->arp_op = htons(flow->nw_proto);
1233 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
1234 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
1237 if ((flow->dl_type == htons(ETH_TYPE_IP)
1238 || flow->dl_type == htons(ETH_TYPE_IPV6))
1239 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1241 if (flow->nw_proto == IPPROTO_TCP) {
1242 struct ovs_key_tcp *tcp_key;
1244 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
1246 tcp_key->tcp_src = flow->tp_src;
1247 tcp_key->tcp_dst = flow->tp_dst;
1248 } else if (flow->nw_proto == IPPROTO_UDP) {
1249 struct ovs_key_udp *udp_key;
1251 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
1253 udp_key->udp_src = flow->tp_src;
1254 udp_key->udp_dst = flow->tp_dst;
1255 } else if (flow->dl_type == htons(ETH_TYPE_IP)
1256 && flow->nw_proto == IPPROTO_ICMP) {
1257 struct ovs_key_icmp *icmp_key;
1259 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
1261 icmp_key->icmp_type = ntohs(flow->tp_src);
1262 icmp_key->icmp_code = ntohs(flow->tp_dst);
1263 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
1264 && flow->nw_proto == IPPROTO_ICMPV6) {
1265 struct ovs_key_icmpv6 *icmpv6_key;
1267 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
1268 sizeof *icmpv6_key);
1269 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
1270 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
1272 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
1273 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
1274 struct ovs_key_nd *nd_key;
1276 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
1278 memcpy(nd_key->nd_target, &flow->nd_target,
1279 sizeof nd_key->nd_target);
1280 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
1281 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
1288 nl_msg_end_nested(buf, encap);
1293 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
1295 const struct nlattr *key, size_t key_len)
1300 if (VLOG_DROP_WARN(rl)) {
1305 ds_put_format(&s, "%s:", title);
1306 for (i = 0; i < 32; i++) {
1307 if (attrs & (1u << i)) {
1308 ds_put_format(&s, " %s", ovs_key_attr_to_string(i));
1312 ds_put_cstr(&s, ": ");
1313 odp_flow_key_format(key, key_len, &s);
1315 VLOG_WARN("%s", ds_cstr(&s));
1320 odp_to_ovs_frag(uint8_t odp_frag, struct flow *flow)
1322 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1324 if (odp_frag > OVS_FRAG_TYPE_LATER) {
1325 VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key",
1330 if (odp_frag != OVS_FRAG_TYPE_NONE) {
1331 flow->nw_frag |= FLOW_NW_FRAG_ANY;
1332 if (odp_frag == OVS_FRAG_TYPE_LATER) {
1333 flow->nw_frag |= FLOW_NW_FRAG_LATER;
1340 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
1341 const struct nlattr *attrs[], uint64_t *present_attrsp)
1343 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1344 const struct nlattr *nla;
1345 uint64_t present_attrs;
1349 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
1350 uint16_t type = nl_attr_type(nla);
1351 size_t len = nl_attr_get_size(nla);
1352 int expected_len = odp_flow_key_attr_len(type);
1354 if (len != expected_len && expected_len != -2) {
1355 if (expected_len == -1) {
1356 VLOG_ERR_RL(&rl, "unknown attribute %"PRIu16" in flow key",
1359 VLOG_ERR_RL(&rl, "attribute %s has length %zu but should have "
1360 "length %d", ovs_key_attr_to_string(type),
1364 } else if (present_attrs & (UINT64_C(1) << type)) {
1365 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
1366 ovs_key_attr_to_string(type));
1370 present_attrs |= UINT64_C(1) << type;
1374 VLOG_ERR_RL(&rl, "trailing garbage in flow key");
1378 *present_attrsp = present_attrs;
1383 check_expectations(uint64_t present_attrs, uint64_t expected_attrs,
1384 const struct nlattr *key, size_t key_len)
1386 uint64_t missing_attrs;
1387 uint64_t extra_attrs;
1389 missing_attrs = expected_attrs & ~present_attrs;
1390 if (missing_attrs) {
1391 static struct vlog_rate_limit miss_rl = VLOG_RATE_LIMIT_INIT(10, 10);
1392 log_odp_key_attributes(&miss_rl, "expected but not present",
1393 missing_attrs, key, key_len);
1397 extra_attrs = present_attrs & ~expected_attrs;
1399 static struct vlog_rate_limit extra_rl = VLOG_RATE_LIMIT_INIT(10, 10);
1400 log_odp_key_attributes(&extra_rl, "present but not expected",
1401 extra_attrs, key, key_len);
1408 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
1409 * structure in 'flow'. Returns 0 if successful, otherwise EINVAL. */
1411 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
1414 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1415 const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
1416 uint64_t expected_attrs;
1417 uint64_t present_attrs;
1420 memset(flow, 0, sizeof *flow);
1422 error = parse_flow_nlattrs(key, key_len, attrs, &present_attrs);
1429 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
1430 flow->priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
1431 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
1434 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUN_ID)) {
1435 flow->tun_id = nl_attr_get_be64(attrs[OVS_KEY_ATTR_TUN_ID]);
1436 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUN_ID;
1439 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
1440 uint32_t in_port = nl_attr_get_u32(attrs[OVS_KEY_ATTR_IN_PORT]);
1441 if (in_port >= UINT16_MAX || in_port >= OFPP_MAX) {
1442 VLOG_ERR_RL(&rl, "in_port %"PRIu32" out of supported range",
1446 flow->in_port = odp_port_to_ofp_port(in_port);
1447 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
1449 flow->in_port = OFPP_NONE;
1452 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
1453 const struct ovs_key_ethernet *eth_key;
1455 eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
1456 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
1457 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
1459 VLOG_ERR_RL(&rl, "missing Ethernet attribute in flow key");
1462 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
1464 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)
1465 && (nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE])
1466 == htons(ETH_TYPE_VLAN))) {
1467 /* The Ethernet type is 0x8100 so there must be a VLAN tag
1468 * and encapsulated protocol information. */
1469 const struct nlattr *encap;
1473 expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE) |
1474 (UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
1475 (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
1476 error = check_expectations(present_attrs, expected_attrs,
1482 encap = attrs[OVS_KEY_ATTR_ENCAP];
1483 tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
1484 if (tci & htons(VLAN_CFI)) {
1485 flow->vlan_tci = tci;
1487 error = parse_flow_nlattrs(nl_attr_get(encap),
1488 nl_attr_get_size(encap),
1489 attrs, &present_attrs);
1494 } else if (tci == htons(0)) {
1495 /* Corner case for a truncated 802.1Q header. */
1496 if (nl_attr_get_size(encap)) {
1500 flow->dl_type = htons(ETH_TYPE_VLAN);
1507 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
1508 flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
1509 if (ntohs(flow->dl_type) < 1536) {
1510 VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
1511 ntohs(flow->dl_type));
1514 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
1516 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
1519 if (flow->dl_type == htons(ETH_TYPE_IP)) {
1520 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
1521 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
1522 const struct ovs_key_ipv4 *ipv4_key;
1524 ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
1525 flow->nw_src = ipv4_key->ipv4_src;
1526 flow->nw_dst = ipv4_key->ipv4_dst;
1527 flow->nw_proto = ipv4_key->ipv4_proto;
1528 flow->nw_tos = ipv4_key->ipv4_tos;
1529 flow->nw_ttl = ipv4_key->ipv4_ttl;
1530 if (!odp_to_ovs_frag(ipv4_key->ipv4_frag, flow)) {
1534 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1535 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
1536 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
1537 const struct ovs_key_ipv6 *ipv6_key;
1539 ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
1540 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
1541 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
1542 flow->ipv6_label = ipv6_key->ipv6_label;
1543 flow->nw_proto = ipv6_key->ipv6_proto;
1544 flow->nw_tos = ipv6_key->ipv6_tclass;
1545 flow->nw_ttl = ipv6_key->ipv6_hlimit;
1546 if (!odp_to_ovs_frag(ipv6_key->ipv6_frag, flow)) {
1550 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
1551 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
1552 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
1553 const struct ovs_key_arp *arp_key;
1555 arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
1556 flow->nw_src = arp_key->arp_sip;
1557 flow->nw_dst = arp_key->arp_tip;
1558 if (arp_key->arp_op & htons(0xff00)) {
1559 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
1560 "key", ntohs(arp_key->arp_op));
1563 flow->nw_proto = ntohs(arp_key->arp_op);
1564 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1565 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1569 if (flow->nw_proto == IPPROTO_TCP
1570 && (flow->dl_type == htons(ETH_TYPE_IP) ||
1571 flow->dl_type == htons(ETH_TYPE_IPV6))
1572 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1573 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
1574 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
1575 const struct ovs_key_tcp *tcp_key;
1577 tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
1578 flow->tp_src = tcp_key->tcp_src;
1579 flow->tp_dst = tcp_key->tcp_dst;
1581 } else if (flow->nw_proto == IPPROTO_UDP
1582 && (flow->dl_type == htons(ETH_TYPE_IP) ||
1583 flow->dl_type == htons(ETH_TYPE_IPV6))
1584 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1585 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
1586 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
1587 const struct ovs_key_udp *udp_key;
1589 udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
1590 flow->tp_src = udp_key->udp_src;
1591 flow->tp_dst = udp_key->udp_dst;
1593 } else if (flow->nw_proto == IPPROTO_ICMP
1594 && flow->dl_type == htons(ETH_TYPE_IP)
1595 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1596 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
1597 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
1598 const struct ovs_key_icmp *icmp_key;
1600 icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
1601 flow->tp_src = htons(icmp_key->icmp_type);
1602 flow->tp_dst = htons(icmp_key->icmp_code);
1604 } else if (flow->nw_proto == IPPROTO_ICMPV6
1605 && flow->dl_type == htons(ETH_TYPE_IPV6)
1606 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1607 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
1608 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
1609 const struct ovs_key_icmpv6 *icmpv6_key;
1611 icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
1612 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1613 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1615 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1616 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
1617 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
1618 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
1619 const struct ovs_key_nd *nd_key;
1621 nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
1622 memcpy(&flow->nd_target, nd_key->nd_target,
1623 sizeof flow->nd_target);
1624 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1625 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1631 return check_expectations(present_attrs, expected_attrs, key, key_len);
1634 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
1635 * Netlink PID 'pid'. If 'cookie' is nonnull, adds a userdata attribute whose
1636 * contents contains 'cookie' and returns the offset within 'odp_actions' of
1637 * the start of the cookie. (If 'cookie' is null, then the return value is not
1640 odp_put_userspace_action(uint32_t pid, const struct user_action_cookie *cookie,
1641 struct ofpbuf *odp_actions)
1645 offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
1646 nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
1648 nl_msg_put_unspec(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
1649 cookie, sizeof *cookie);
1651 nl_msg_end_nested(odp_actions, offset);
1653 return cookie ? odp_actions->size - NLA_ALIGN(sizeof *cookie) : 0;