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_SFLOW) {
193 ds_put_format(ds, ",sFlow,n_output=%"PRIu8","
194 "vid=%"PRIu16",pcp=%"PRIu8",ifindex=%"PRIu32,
195 cookie.n_output, vlan_tci_to_vid(cookie.vlan_tci),
196 vlan_tci_to_pcp(cookie.vlan_tci), cookie.data);
198 ds_put_format(ds, ",userdata=0x%"PRIx64, userdata);
202 ds_put_char(ds, ')');
206 format_vlan_tci(struct ds *ds, ovs_be16 vlan_tci)
208 ds_put_format(ds, "vid=%"PRIu16",pcp=%d",
209 vlan_tci_to_vid(vlan_tci),
210 vlan_tci_to_pcp(vlan_tci));
211 if (!(vlan_tci & htons(VLAN_CFI))) {
212 ds_put_cstr(ds, ",cfi=0");
217 format_odp_action(struct ds *ds, const struct nlattr *a)
220 enum ovs_action_attr type = nl_attr_type(a);
221 const struct ovs_action_push_vlan *vlan;
223 expected_len = odp_action_len(nl_attr_type(a));
224 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
225 ds_put_format(ds, "bad length %zu, expected %d for: ",
226 nl_attr_get_size(a), expected_len);
227 format_generic_odp_action(ds, a);
232 case OVS_ACTION_ATTR_OUTPUT:
233 ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
235 case OVS_ACTION_ATTR_USERSPACE:
236 format_odp_userspace_action(ds, a);
238 case OVS_ACTION_ATTR_SET:
239 ds_put_cstr(ds, "set(");
240 format_odp_key_attr(nl_attr_get(a), ds);
241 ds_put_cstr(ds, ")");
243 case OVS_ACTION_ATTR_PUSH_VLAN:
244 vlan = nl_attr_get(a);
245 ds_put_cstr(ds, "push_vlan(");
246 if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
247 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
249 format_vlan_tci(ds, vlan->vlan_tci);
250 ds_put_char(ds, ')');
252 case OVS_ACTION_ATTR_POP_VLAN:
253 ds_put_cstr(ds, "pop_vlan");
255 case OVS_ACTION_ATTR_SAMPLE:
256 format_odp_sample_action(ds, a);
258 case OVS_ACTION_ATTR_UNSPEC:
259 case __OVS_ACTION_ATTR_MAX:
261 format_generic_odp_action(ds, a);
267 format_odp_actions(struct ds *ds, const struct nlattr *actions,
271 const struct nlattr *a;
274 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
276 ds_put_char(ds, ',');
278 format_odp_action(ds, a);
281 if (left == actions_len) {
282 ds_put_cstr(ds, "<empty>");
284 ds_put_format(ds, ",***%u leftover bytes***", left);
287 ds_put_cstr(ds, "drop");
292 parse_odp_action(const char *s, const struct shash *port_names,
293 struct ofpbuf *actions)
295 /* Many of the sscanf calls in this function use oversized destination
296 * fields because some sscanf() implementations truncate the range of %i
297 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
298 * value of 0x7fff. The other alternatives are to allow only a single
299 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
302 * The tun_id parser has to use an alternative approach because there is no
303 * type larger than 64 bits. */
306 unsigned long long int port;
309 if (sscanf(s, "%lli%n", &port, &n) > 0 && n > 0) {
310 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
316 int len = strcspn(s, delimiters);
317 struct shash_node *node;
319 node = shash_find_len(port_names, s, len);
321 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT,
322 (uintptr_t) node->data);
328 unsigned long long int pid;
329 unsigned long long int ifindex;
335 if (sscanf(s, "userspace(pid=%lli)%n", &pid, &n) > 0 && n > 0) {
336 odp_put_userspace_action(pid, NULL, actions);
338 } else if (sscanf(s, "userspace(pid=%lli,sFlow,n_output=%i,vid=%i,"
339 "pcp=%i,ifindex=%lli)%n", &pid, &n_output,
340 &vid, &pcp, &ifindex, &n) > 0 && n > 0) {
341 struct user_action_cookie cookie;
344 tci = vid | (pcp << VLAN_PCP_SHIFT);
349 cookie.type = USER_ACTION_COOKIE_SFLOW;
350 cookie.n_output = n_output;
351 cookie.vlan_tci = htons(tci);
352 cookie.data = ifindex;
353 odp_put_userspace_action(pid, &cookie, actions);
355 } else if (sscanf(s, "userspace(pid=%lli,userdata="
356 "%31[x0123456789abcdefABCDEF])%n", &pid, userdata_s,
358 struct user_action_cookie cookie;
361 userdata = strtoull(userdata_s, NULL, 0);
362 memcpy(&cookie, &userdata, sizeof cookie);
363 odp_put_userspace_action(pid, &cookie, actions);
368 if (!strncmp(s, "set(", 4)) {
372 start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
373 retval = parse_odp_key_attr(s + 4, port_names, actions);
377 if (s[retval + 4] != ')') {
380 nl_msg_end_nested(actions, start_ofs);
385 struct ovs_action_push_vlan push;
386 int tpid = ETH_TYPE_VLAN;
391 if ((sscanf(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n) > 0
393 || (sscanf(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
394 &vid, &pcp, &cfi, &n) > 0 && n > 0)
395 || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
396 &tpid, &vid, &pcp, &n) > 0 && n > 0)
397 || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
398 &tpid, &vid, &pcp, &cfi, &n) > 0 && n > 0)) {
399 push.vlan_tpid = htons(tpid);
400 push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
401 | (pcp << VLAN_PCP_SHIFT)
402 | (cfi ? VLAN_CFI : 0));
403 nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
410 if (!strncmp(s, "pop_vlan", 8)) {
411 nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
419 if (sscanf(s, "sample(sample=%lf%%,actions(%n", &percentage, &n) > 0
420 && percentage >= 0. && percentage <= 100.0
422 size_t sample_ofs, actions_ofs;
425 probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
426 sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
427 nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
428 (probability <= 0 ? 0
429 : probability >= UINT32_MAX ? UINT32_MAX
432 actions_ofs = nl_msg_start_nested(actions,
433 OVS_SAMPLE_ATTR_ACTIONS);
437 s += strspn(s, delimiters);
442 retval = parse_odp_action(s + n, port_names, actions);
449 nl_msg_end_nested(actions, actions_ofs);
450 nl_msg_end_nested(actions, sample_ofs);
452 return s[n + 1] == ')' ? n + 2 : -EINVAL;
459 /* Parses the string representation of datapath actions, in the format output
460 * by format_odp_action(). Returns 0 if successful, otherwise a positive errno
461 * value. On success, the ODP actions are appended to 'actions' as a series of
462 * Netlink attributes. On failure, no data is appended to 'actions'. Either
463 * way, 'actions''s data might be reallocated. */
465 odp_actions_from_string(const char *s, const struct shash *port_names,
466 struct ofpbuf *actions)
470 if (!strcasecmp(s, "drop")) {
474 old_size = actions->size;
478 s += strspn(s, delimiters);
483 retval = parse_odp_action(s, port_names, actions);
484 if (retval < 0 || !strchr(delimiters, s[retval])) {
485 actions->size = old_size;
494 /* Returns the correct length of the payload for a flow key attribute of the
495 * specified 'type', -1 if 'type' is unknown, or -2 if the attribute's payload
496 * is variable length. */
498 odp_flow_key_attr_len(uint16_t type)
500 if (type > OVS_KEY_ATTR_MAX) {
504 switch ((enum ovs_key_attr) type) {
505 case OVS_KEY_ATTR_ENCAP: return -2;
506 case OVS_KEY_ATTR_PRIORITY: return 4;
507 case OVS_KEY_ATTR_TUN_ID: return 8;
508 case OVS_KEY_ATTR_IN_PORT: return 4;
509 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
510 case OVS_KEY_ATTR_VLAN: return sizeof(ovs_be16);
511 case OVS_KEY_ATTR_ETHERTYPE: return 2;
512 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
513 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
514 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
515 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
516 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
517 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
518 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
519 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
521 case OVS_KEY_ATTR_UNSPEC:
522 case __OVS_KEY_ATTR_MAX:
530 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
532 size_t len = nl_attr_get_size(a);
534 const uint8_t *unspec;
537 unspec = nl_attr_get(a);
538 for (i = 0; i < len; i++) {
539 ds_put_char(ds, i ? ' ': '(');
540 ds_put_format(ds, "%02x", unspec[i]);
542 ds_put_char(ds, ')');
547 ovs_frag_type_to_string(enum ovs_frag_type type)
550 case OVS_FRAG_TYPE_NONE:
552 case OVS_FRAG_TYPE_FIRST:
554 case OVS_FRAG_TYPE_LATER:
556 case __OVS_FRAG_TYPE_MAX:
563 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
565 const struct ovs_key_ethernet *eth_key;
566 const struct ovs_key_ipv4 *ipv4_key;
567 const struct ovs_key_ipv6 *ipv6_key;
568 const struct ovs_key_tcp *tcp_key;
569 const struct ovs_key_udp *udp_key;
570 const struct ovs_key_icmp *icmp_key;
571 const struct ovs_key_icmpv6 *icmpv6_key;
572 const struct ovs_key_arp *arp_key;
573 const struct ovs_key_nd *nd_key;
574 enum ovs_key_attr attr = nl_attr_type(a);
577 ds_put_cstr(ds, ovs_key_attr_to_string(attr));
578 expected_len = odp_flow_key_attr_len(nl_attr_type(a));
579 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
580 ds_put_format(ds, "(bad length %zu, expected %d)",
582 odp_flow_key_attr_len(nl_attr_type(a)));
583 format_generic_odp_key(a, ds);
588 case OVS_KEY_ATTR_ENCAP:
589 ds_put_cstr(ds, "(");
590 if (nl_attr_get_size(a)) {
591 odp_flow_key_format(nl_attr_get(a), nl_attr_get_size(a), ds);
593 ds_put_char(ds, ')');
596 case OVS_KEY_ATTR_PRIORITY:
597 ds_put_format(ds, "(%"PRIu32")", nl_attr_get_u32(a));
600 case OVS_KEY_ATTR_TUN_ID:
601 ds_put_format(ds, "(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
604 case OVS_KEY_ATTR_IN_PORT:
605 ds_put_format(ds, "(%"PRIu32")", nl_attr_get_u32(a));
608 case OVS_KEY_ATTR_ETHERNET:
609 eth_key = nl_attr_get(a);
610 ds_put_format(ds, "(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
611 ETH_ADDR_ARGS(eth_key->eth_src),
612 ETH_ADDR_ARGS(eth_key->eth_dst));
615 case OVS_KEY_ATTR_VLAN:
616 ds_put_char(ds, '(');
617 format_vlan_tci(ds, nl_attr_get_be16(a));
618 ds_put_char(ds, ')');
621 case OVS_KEY_ATTR_ETHERTYPE:
622 ds_put_format(ds, "(0x%04"PRIx16")",
623 ntohs(nl_attr_get_be16(a)));
626 case OVS_KEY_ATTR_IPV4:
627 ipv4_key = nl_attr_get(a);
628 ds_put_format(ds, "(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
629 ",tos=%#"PRIx8",ttl=%"PRIu8",frag=%s)",
630 IP_ARGS(&ipv4_key->ipv4_src),
631 IP_ARGS(&ipv4_key->ipv4_dst),
632 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
634 ovs_frag_type_to_string(ipv4_key->ipv4_frag));
637 case OVS_KEY_ATTR_IPV6: {
638 char src_str[INET6_ADDRSTRLEN];
639 char dst_str[INET6_ADDRSTRLEN];
641 ipv6_key = nl_attr_get(a);
642 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
643 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
645 ds_put_format(ds, "(src=%s,dst=%s,label=%#"PRIx32",proto=%"PRIu8
646 ",tclass=%#"PRIx8",hlimit=%"PRIu8",frag=%s)",
647 src_str, dst_str, ntohl(ipv6_key->ipv6_label),
648 ipv6_key->ipv6_proto, ipv6_key->ipv6_tclass,
649 ipv6_key->ipv6_hlimit,
650 ovs_frag_type_to_string(ipv6_key->ipv6_frag));
654 case OVS_KEY_ATTR_TCP:
655 tcp_key = nl_attr_get(a);
656 ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
657 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
660 case OVS_KEY_ATTR_UDP:
661 udp_key = nl_attr_get(a);
662 ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
663 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
666 case OVS_KEY_ATTR_ICMP:
667 icmp_key = nl_attr_get(a);
668 ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
669 icmp_key->icmp_type, icmp_key->icmp_code);
672 case OVS_KEY_ATTR_ICMPV6:
673 icmpv6_key = nl_attr_get(a);
674 ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
675 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
678 case OVS_KEY_ATTR_ARP:
679 arp_key = nl_attr_get(a);
680 ds_put_format(ds, "(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
681 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
682 IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
683 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
684 ETH_ADDR_ARGS(arp_key->arp_tha));
687 case OVS_KEY_ATTR_ND: {
688 char target[INET6_ADDRSTRLEN];
690 nd_key = nl_attr_get(a);
691 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
693 ds_put_format(ds, "(target=%s", target);
694 if (!eth_addr_is_zero(nd_key->nd_sll)) {
695 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
696 ETH_ADDR_ARGS(nd_key->nd_sll));
698 if (!eth_addr_is_zero(nd_key->nd_tll)) {
699 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
700 ETH_ADDR_ARGS(nd_key->nd_tll));
702 ds_put_char(ds, ')');
706 case OVS_KEY_ATTR_UNSPEC:
707 case __OVS_KEY_ATTR_MAX:
709 format_generic_odp_key(a, ds);
714 /* Appends to 'ds' a string representation of the 'key_len' bytes of
715 * OVS_KEY_ATTR_* attributes in 'key'. */
717 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
720 const struct nlattr *a;
723 NL_ATTR_FOR_EACH (a, left, key, key_len) {
725 ds_put_char(ds, ',');
727 format_odp_key_attr(a, ds);
730 if (left == key_len) {
731 ds_put_cstr(ds, "<empty>");
733 ds_put_format(ds, ",***%u leftover bytes***", left);
736 ds_put_cstr(ds, "<empty>");
741 put_nd_key(int n, const char *nd_target_s,
742 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
744 struct ovs_key_nd nd_key;
746 memset(&nd_key, 0, sizeof nd_key);
747 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
751 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
754 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
756 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
761 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
763 if (!strcasecmp(s, "no")) {
764 *type = OVS_FRAG_TYPE_NONE;
765 } else if (!strcasecmp(s, "first")) {
766 *type = OVS_FRAG_TYPE_FIRST;
767 } else if (!strcasecmp(s, "later")) {
768 *type = OVS_FRAG_TYPE_LATER;
776 parse_odp_key_attr(const char *s, const struct shash *port_names,
779 /* Many of the sscanf calls in this function use oversized destination
780 * fields because some sscanf() implementations truncate the range of %i
781 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
782 * value of 0x7fff. The other alternatives are to allow only a single
783 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
786 * The tun_id parser has to use an alternative approach because there is no
787 * type larger than 64 bits. */
790 unsigned long long int priority;
793 if (sscanf(s, "priority(%lli)%n", &priority, &n) > 0 && n > 0) {
794 nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
803 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
804 tun_id_s, &n) > 0 && n > 0) {
805 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
806 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
812 unsigned long long int in_port;
815 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
816 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
821 if (port_names && !strncmp(s, "in_port(", 8)) {
823 const struct shash_node *node;
827 name_len = strcspn(s, ")");
828 node = shash_find_len(port_names, name, name_len);
830 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, (uintptr_t) node->data);
831 return 8 + name_len + 1;
836 struct ovs_key_ethernet eth_key;
840 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
841 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
842 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
843 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
844 ð_key, sizeof eth_key);
855 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n", &vid, &pcp, &n) > 0
857 nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
858 htons((vid << VLAN_VID_SHIFT) |
859 (pcp << VLAN_PCP_SHIFT) |
862 } else if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i,cfi=%i)%n",
863 &vid, &pcp, &cfi, &n) > 0
865 nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
866 htons((vid << VLAN_VID_SHIFT) |
867 (pcp << VLAN_PCP_SHIFT) |
868 (cfi ? VLAN_CFI : 0)));
877 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
878 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
890 enum ovs_frag_type ipv4_frag;
893 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
894 "proto=%i,tos=%i,ttl=%i,frag=%7[a-z])%n",
895 IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
896 &ipv4_proto, &ipv4_tos, &ipv4_ttl, frag, &n) > 0
898 && ovs_frag_type_from_string(frag, &ipv4_frag)) {
899 struct ovs_key_ipv4 ipv4_key;
901 ipv4_key.ipv4_src = ipv4_src;
902 ipv4_key.ipv4_dst = ipv4_dst;
903 ipv4_key.ipv4_proto = ipv4_proto;
904 ipv4_key.ipv4_tos = ipv4_tos;
905 ipv4_key.ipv4_ttl = ipv4_ttl;
906 ipv4_key.ipv4_frag = ipv4_frag;
907 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
908 &ipv4_key, sizeof ipv4_key);
914 char ipv6_src_s[IPV6_SCAN_LEN + 1];
915 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
921 enum ovs_frag_type ipv6_frag;
924 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
925 "label=%i,proto=%i,tclass=%i,hlimit=%i,frag=%7[a-z])%n",
926 ipv6_src_s, ipv6_dst_s, &ipv6_label,
927 &ipv6_proto, &ipv6_tclass, &ipv6_hlimit, frag, &n) > 0
929 && ovs_frag_type_from_string(frag, &ipv6_frag)) {
930 struct ovs_key_ipv6 ipv6_key;
932 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
933 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
936 ipv6_key.ipv6_label = htonl(ipv6_label);
937 ipv6_key.ipv6_proto = ipv6_proto;
938 ipv6_key.ipv6_tclass = ipv6_tclass;
939 ipv6_key.ipv6_hlimit = ipv6_hlimit;
940 ipv6_key.ipv6_frag = ipv6_frag;
941 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
942 &ipv6_key, sizeof ipv6_key);
952 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
954 struct ovs_key_tcp tcp_key;
956 tcp_key.tcp_src = htons(tcp_src);
957 tcp_key.tcp_dst = htons(tcp_dst);
958 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
968 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
970 struct ovs_key_udp udp_key;
972 udp_key.udp_src = htons(udp_src);
973 udp_key.udp_dst = htons(udp_dst);
974 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
984 if (sscanf(s, "icmp(type=%i,code=%i)%n",
985 &icmp_type, &icmp_code, &n) > 0
987 struct ovs_key_icmp icmp_key;
989 icmp_key.icmp_type = icmp_type;
990 icmp_key.icmp_code = icmp_code;
991 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
992 &icmp_key, sizeof icmp_key);
998 struct ovs_key_icmpv6 icmpv6_key;
1001 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
1002 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
1004 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
1005 &icmpv6_key, sizeof icmpv6_key);
1014 uint8_t arp_sha[ETH_ADDR_LEN];
1015 uint8_t arp_tha[ETH_ADDR_LEN];
1018 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
1019 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
1020 IP_SCAN_ARGS(&arp_sip),
1021 IP_SCAN_ARGS(&arp_tip),
1023 ETH_ADDR_SCAN_ARGS(arp_sha),
1024 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
1025 struct ovs_key_arp arp_key;
1027 memset(&arp_key, 0, sizeof arp_key);
1028 arp_key.arp_sip = arp_sip;
1029 arp_key.arp_tip = arp_tip;
1030 arp_key.arp_op = htons(arp_op);
1031 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
1032 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
1033 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
1039 char nd_target_s[IPV6_SCAN_LEN + 1];
1040 uint8_t nd_sll[ETH_ADDR_LEN];
1041 uint8_t nd_tll[ETH_ADDR_LEN];
1044 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
1045 nd_target_s, &n) > 0 && n > 0) {
1046 return put_nd_key(n, nd_target_s, NULL, NULL, key);
1048 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
1049 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
1051 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
1053 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
1054 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
1056 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
1058 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
1059 "tll="ETH_ADDR_SCAN_FMT")%n",
1060 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
1061 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
1063 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
1067 if (!strncmp(s, "encap(", 6)) {
1068 const char *start = s;
1071 encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
1077 s += strspn(s, ", \t\r\n");
1080 } else if (*s == ')') {
1084 retval = parse_odp_key_attr(s, port_names, key);
1092 nl_msg_end_nested(key, encap);
1100 /* Parses the string representation of a datapath flow key, in the
1101 * format output by odp_flow_key_format(). Returns 0 if successful,
1102 * otherwise a positive errno value. On success, the flow key is
1103 * appended to 'key' as a series of Netlink attributes. On failure, no
1104 * data is appended to 'key'. Either way, 'key''s data might be
1107 * If 'port_names' is nonnull, it points to an shash that maps from a port name
1108 * to a port number cast to void *. (Port names may be used instead of port
1109 * numbers in in_port.)
1111 * On success, the attributes appended to 'key' are individually syntactically
1112 * valid, but they may not be valid as a sequence. 'key' might, for example,
1113 * have duplicated keys. odp_flow_key_to_flow() will detect those errors. */
1115 odp_flow_key_from_string(const char *s, const struct shash *port_names,
1118 const size_t old_size = key->size;
1122 s += strspn(s, delimiters);
1127 retval = parse_odp_key_attr(s, port_names, key);
1129 key->size = old_size;
1139 ovs_to_odp_frag(uint8_t ovs_frag)
1141 return (ovs_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
1142 : ovs_frag & FLOW_NW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
1143 : OVS_FRAG_TYPE_NONE);
1146 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
1148 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
1150 struct ovs_key_ethernet *eth_key;
1153 if (flow->skb_priority) {
1154 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, flow->skb_priority);
1157 if (flow->tun_id != htonll(0)) {
1158 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
1161 if (flow->in_port != OFPP_NONE) {
1162 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
1163 ofp_port_to_odp_port(flow->in_port));
1166 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
1168 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
1169 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
1171 if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
1172 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
1173 nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, flow->vlan_tci);
1174 encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
1175 if (flow->vlan_tci == htons(0)) {
1182 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
1186 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
1188 if (flow->dl_type == htons(ETH_TYPE_IP)) {
1189 struct ovs_key_ipv4 *ipv4_key;
1191 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
1193 ipv4_key->ipv4_src = flow->nw_src;
1194 ipv4_key->ipv4_dst = flow->nw_dst;
1195 ipv4_key->ipv4_proto = flow->nw_proto;
1196 ipv4_key->ipv4_tos = flow->nw_tos;
1197 ipv4_key->ipv4_ttl = flow->nw_ttl;
1198 ipv4_key->ipv4_frag = ovs_to_odp_frag(flow->nw_frag);
1199 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1200 struct ovs_key_ipv6 *ipv6_key;
1202 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
1204 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
1205 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
1206 ipv6_key->ipv6_label = flow->ipv6_label;
1207 ipv6_key->ipv6_proto = flow->nw_proto;
1208 ipv6_key->ipv6_tclass = flow->nw_tos;
1209 ipv6_key->ipv6_hlimit = flow->nw_ttl;
1210 ipv6_key->ipv6_frag = ovs_to_odp_frag(flow->nw_frag);
1211 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
1212 struct ovs_key_arp *arp_key;
1214 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
1216 memset(arp_key, 0, sizeof *arp_key);
1217 arp_key->arp_sip = flow->nw_src;
1218 arp_key->arp_tip = flow->nw_dst;
1219 arp_key->arp_op = htons(flow->nw_proto);
1220 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
1221 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
1224 if ((flow->dl_type == htons(ETH_TYPE_IP)
1225 || flow->dl_type == htons(ETH_TYPE_IPV6))
1226 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1228 if (flow->nw_proto == IPPROTO_TCP) {
1229 struct ovs_key_tcp *tcp_key;
1231 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
1233 tcp_key->tcp_src = flow->tp_src;
1234 tcp_key->tcp_dst = flow->tp_dst;
1235 } else if (flow->nw_proto == IPPROTO_UDP) {
1236 struct ovs_key_udp *udp_key;
1238 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
1240 udp_key->udp_src = flow->tp_src;
1241 udp_key->udp_dst = flow->tp_dst;
1242 } else if (flow->dl_type == htons(ETH_TYPE_IP)
1243 && flow->nw_proto == IPPROTO_ICMP) {
1244 struct ovs_key_icmp *icmp_key;
1246 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
1248 icmp_key->icmp_type = ntohs(flow->tp_src);
1249 icmp_key->icmp_code = ntohs(flow->tp_dst);
1250 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
1251 && flow->nw_proto == IPPROTO_ICMPV6) {
1252 struct ovs_key_icmpv6 *icmpv6_key;
1254 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
1255 sizeof *icmpv6_key);
1256 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
1257 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
1259 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
1260 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
1261 struct ovs_key_nd *nd_key;
1263 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
1265 memcpy(nd_key->nd_target, &flow->nd_target,
1266 sizeof nd_key->nd_target);
1267 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
1268 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
1275 nl_msg_end_nested(buf, encap);
1280 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
1282 BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
1283 return hash_words((const uint32_t *) key, key_len / sizeof(uint32_t), 0);
1287 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
1288 uint64_t attrs, int out_of_range_attr,
1289 const struct nlattr *key, size_t key_len)
1294 if (VLOG_DROP_DBG(rl)) {
1299 for (i = 0; i < 64; i++) {
1300 if (attrs & (UINT64_C(1) << i)) {
1301 ds_put_format(&s, " %s", ovs_key_attr_to_string(i));
1304 if (out_of_range_attr) {
1305 ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
1308 ds_put_cstr(&s, ": ");
1309 odp_flow_key_format(key, key_len, &s);
1311 VLOG_DBG("%s:%s", title, ds_cstr(&s));
1316 odp_to_ovs_frag(uint8_t odp_frag, struct flow *flow)
1318 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1320 if (odp_frag > OVS_FRAG_TYPE_LATER) {
1321 VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
1325 if (odp_frag != OVS_FRAG_TYPE_NONE) {
1326 flow->nw_frag |= FLOW_NW_FRAG_ANY;
1327 if (odp_frag == OVS_FRAG_TYPE_LATER) {
1328 flow->nw_frag |= FLOW_NW_FRAG_LATER;
1335 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
1336 const struct nlattr *attrs[], uint64_t *present_attrsp,
1337 int *out_of_range_attrp)
1339 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
1340 const struct nlattr *nla;
1341 uint64_t present_attrs;
1345 *out_of_range_attrp = 0;
1346 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
1347 uint16_t type = nl_attr_type(nla);
1348 size_t len = nl_attr_get_size(nla);
1349 int expected_len = odp_flow_key_attr_len(type);
1351 if (len != expected_len && expected_len >= 0) {
1352 VLOG_ERR_RL(&rl, "attribute %s has length %zu but should have "
1353 "length %d", ovs_key_attr_to_string(type),
1358 if (type >= CHAR_BIT * sizeof present_attrs) {
1359 *out_of_range_attrp = type;
1361 if (present_attrs & (UINT64_C(1) << type)) {
1362 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
1363 ovs_key_attr_to_string(type));
1367 present_attrs |= UINT64_C(1) << type;
1372 VLOG_ERR_RL(&rl, "trailing garbage in flow key");
1376 *present_attrsp = present_attrs;
1380 static enum odp_key_fitness
1381 check_expectations(uint64_t present_attrs, int out_of_range_attr,
1382 uint64_t expected_attrs,
1383 const struct nlattr *key, size_t key_len)
1385 uint64_t missing_attrs;
1386 uint64_t extra_attrs;
1388 missing_attrs = expected_attrs & ~present_attrs;
1389 if (missing_attrs) {
1390 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
1391 log_odp_key_attributes(&rl, "expected but not present",
1392 missing_attrs, 0, key, key_len);
1393 return ODP_FIT_TOO_LITTLE;
1396 extra_attrs = present_attrs & ~expected_attrs;
1397 if (extra_attrs || out_of_range_attr) {
1398 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
1399 log_odp_key_attributes(&rl, "present but not expected",
1400 extra_attrs, out_of_range_attr, key, key_len);
1401 return ODP_FIT_TOO_MUCH;
1404 return ODP_FIT_PERFECT;
1408 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
1409 uint64_t present_attrs, uint64_t *expected_attrs,
1412 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1414 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
1415 flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
1416 if (ntohs(flow->dl_type) < 1536) {
1417 VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
1418 ntohs(flow->dl_type));
1421 *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
1423 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
1428 static enum odp_key_fitness
1429 parse_l3_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
1430 uint64_t present_attrs, int out_of_range_attr,
1431 uint64_t expected_attrs, struct flow *flow,
1432 const struct nlattr *key, size_t key_len)
1434 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1436 if (flow->dl_type == htons(ETH_TYPE_IP)) {
1437 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
1438 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
1439 const struct ovs_key_ipv4 *ipv4_key;
1441 ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
1442 flow->nw_src = ipv4_key->ipv4_src;
1443 flow->nw_dst = ipv4_key->ipv4_dst;
1444 flow->nw_proto = ipv4_key->ipv4_proto;
1445 flow->nw_tos = ipv4_key->ipv4_tos;
1446 flow->nw_ttl = ipv4_key->ipv4_ttl;
1447 if (!odp_to_ovs_frag(ipv4_key->ipv4_frag, flow)) {
1448 return ODP_FIT_ERROR;
1451 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1452 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
1453 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
1454 const struct ovs_key_ipv6 *ipv6_key;
1456 ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
1457 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
1458 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
1459 flow->ipv6_label = ipv6_key->ipv6_label;
1460 flow->nw_proto = ipv6_key->ipv6_proto;
1461 flow->nw_tos = ipv6_key->ipv6_tclass;
1462 flow->nw_ttl = ipv6_key->ipv6_hlimit;
1463 if (!odp_to_ovs_frag(ipv6_key->ipv6_frag, flow)) {
1464 return ODP_FIT_ERROR;
1467 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
1468 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
1469 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
1470 const struct ovs_key_arp *arp_key;
1472 arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
1473 flow->nw_src = arp_key->arp_sip;
1474 flow->nw_dst = arp_key->arp_tip;
1475 if (arp_key->arp_op & htons(0xff00)) {
1476 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
1477 "key", ntohs(arp_key->arp_op));
1478 return ODP_FIT_ERROR;
1480 flow->nw_proto = ntohs(arp_key->arp_op);
1481 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1482 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1486 if (flow->nw_proto == IPPROTO_TCP
1487 && (flow->dl_type == htons(ETH_TYPE_IP) ||
1488 flow->dl_type == htons(ETH_TYPE_IPV6))
1489 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1490 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
1491 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
1492 const struct ovs_key_tcp *tcp_key;
1494 tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
1495 flow->tp_src = tcp_key->tcp_src;
1496 flow->tp_dst = tcp_key->tcp_dst;
1498 } else if (flow->nw_proto == IPPROTO_UDP
1499 && (flow->dl_type == htons(ETH_TYPE_IP) ||
1500 flow->dl_type == htons(ETH_TYPE_IPV6))
1501 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1502 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
1503 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
1504 const struct ovs_key_udp *udp_key;
1506 udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
1507 flow->tp_src = udp_key->udp_src;
1508 flow->tp_dst = udp_key->udp_dst;
1510 } else if (flow->nw_proto == IPPROTO_ICMP
1511 && flow->dl_type == htons(ETH_TYPE_IP)
1512 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1513 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
1514 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
1515 const struct ovs_key_icmp *icmp_key;
1517 icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
1518 flow->tp_src = htons(icmp_key->icmp_type);
1519 flow->tp_dst = htons(icmp_key->icmp_code);
1521 } else if (flow->nw_proto == IPPROTO_ICMPV6
1522 && flow->dl_type == htons(ETH_TYPE_IPV6)
1523 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1524 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
1525 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
1526 const struct ovs_key_icmpv6 *icmpv6_key;
1528 icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
1529 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1530 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1532 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1533 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
1534 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
1535 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
1536 const struct ovs_key_nd *nd_key;
1538 nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
1539 memcpy(&flow->nd_target, nd_key->nd_target,
1540 sizeof flow->nd_target);
1541 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1542 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1548 return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
1552 /* Parse 802.1Q header then encapsulated L3 attributes. */
1553 static enum odp_key_fitness
1554 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
1555 uint64_t present_attrs, int out_of_range_attr,
1556 uint64_t expected_attrs, struct flow *flow,
1557 const struct nlattr *key, size_t key_len)
1559 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1561 const struct nlattr *encap
1562 = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
1563 ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
1564 enum odp_key_fitness encap_fitness;
1565 enum odp_key_fitness fitness;
1568 /* Calulate fitness of outer attributes. */
1569 expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
1570 (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
1571 fitness = check_expectations(present_attrs, out_of_range_attr,
1572 expected_attrs, key, key_len);
1574 /* Get the VLAN TCI value. */
1575 if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
1576 return ODP_FIT_TOO_LITTLE;
1578 tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
1579 if (tci == htons(0)) {
1580 /* Corner case for a truncated 802.1Q header. */
1581 if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
1582 return ODP_FIT_TOO_MUCH;
1585 } else if (!(tci & htons(VLAN_CFI))) {
1586 VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
1587 "but CFI bit is not set", ntohs(tci));
1588 return ODP_FIT_ERROR;
1592 * Remove the TPID from dl_type since it's not the real Ethertype. */
1593 flow->vlan_tci = tci;
1594 flow->dl_type = htons(0);
1596 /* Now parse the encapsulated attributes. */
1597 if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
1598 attrs, &present_attrs, &out_of_range_attr)) {
1599 return ODP_FIT_ERROR;
1603 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow)) {
1604 return ODP_FIT_ERROR;
1606 encap_fitness = parse_l3_onward(attrs, present_attrs, out_of_range_attr,
1607 expected_attrs, flow, key, key_len);
1609 /* The overall fitness is the worse of the outer and inner attributes. */
1610 return MAX(fitness, encap_fitness);
1613 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
1614 * structure in 'flow'. Returns an ODP_FIT_* value that indicates how well
1615 * 'key' fits our expectations for what a flow key should contain.
1617 * This function doesn't take the packet itself as an argument because none of
1618 * the currently understood OVS_KEY_ATTR_* attributes require it. Currently,
1619 * it is always possible to infer which additional attribute(s) should appear
1620 * by looking at the attributes for lower-level protocols, e.g. if the network
1621 * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
1622 * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
1623 * must be absent. */
1624 enum odp_key_fitness
1625 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
1628 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1629 const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
1630 uint64_t expected_attrs;
1631 uint64_t present_attrs;
1632 int out_of_range_attr;
1634 memset(flow, 0, sizeof *flow);
1636 /* Parse attributes. */
1637 if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
1638 &out_of_range_attr)) {
1639 return ODP_FIT_ERROR;
1644 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
1645 flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
1646 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
1649 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUN_ID)) {
1650 flow->tun_id = nl_attr_get_be64(attrs[OVS_KEY_ATTR_TUN_ID]);
1651 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUN_ID;
1654 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
1655 uint32_t in_port = nl_attr_get_u32(attrs[OVS_KEY_ATTR_IN_PORT]);
1656 if (in_port >= UINT16_MAX || in_port >= OFPP_MAX) {
1657 VLOG_ERR_RL(&rl, "in_port %"PRIu32" out of supported range",
1659 return ODP_FIT_ERROR;
1661 flow->in_port = odp_port_to_ofp_port(in_port);
1662 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
1664 flow->in_port = OFPP_NONE;
1667 /* Ethernet header. */
1668 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
1669 const struct ovs_key_ethernet *eth_key;
1671 eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
1672 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
1673 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
1675 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
1677 /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
1678 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow)) {
1679 return ODP_FIT_ERROR;
1682 if (flow->dl_type == htons(ETH_TYPE_VLAN)) {
1683 return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
1684 expected_attrs, flow, key, key_len);
1686 return parse_l3_onward(attrs, present_attrs, out_of_range_attr,
1687 expected_attrs, flow, key, key_len);
1690 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
1691 * Netlink PID 'pid'. If 'cookie' is nonnull, adds a userdata attribute whose
1692 * contents contains 'cookie' and returns the offset within 'odp_actions' of
1693 * the start of the cookie. (If 'cookie' is null, then the return value is not
1696 odp_put_userspace_action(uint32_t pid, const struct user_action_cookie *cookie,
1697 struct ofpbuf *odp_actions)
1701 offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
1702 nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
1704 nl_msg_put_unspec(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
1705 cookie, sizeof *cookie);
1707 nl_msg_end_nested(odp_actions, offset);
1709 return cookie ? odp_actions->size - NLA_ALIGN(sizeof *cookie) : 0;
1712 /* The commit_odp_actions() function and its helpers. */
1715 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
1716 const void *key, size_t key_size)
1718 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
1719 nl_msg_put_unspec(odp_actions, key_type, key, key_size);
1720 nl_msg_end_nested(odp_actions, offset);
1724 commit_set_tun_id_action(const struct flow *flow, struct flow *base,
1725 struct ofpbuf *odp_actions)
1727 if (base->tun_id == flow->tun_id) {
1730 base->tun_id = flow->tun_id;
1732 commit_set_action(odp_actions, OVS_KEY_ATTR_TUN_ID,
1733 &base->tun_id, sizeof(base->tun_id));
1737 commit_set_ether_addr_action(const struct flow *flow, struct flow *base,
1738 struct ofpbuf *odp_actions)
1740 struct ovs_key_ethernet eth_key;
1742 if (eth_addr_equals(base->dl_src, flow->dl_src) &&
1743 eth_addr_equals(base->dl_dst, flow->dl_dst)) {
1747 memcpy(base->dl_src, flow->dl_src, ETH_ADDR_LEN);
1748 memcpy(base->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
1750 memcpy(eth_key.eth_src, base->dl_src, ETH_ADDR_LEN);
1751 memcpy(eth_key.eth_dst, base->dl_dst, ETH_ADDR_LEN);
1753 commit_set_action(odp_actions, OVS_KEY_ATTR_ETHERNET,
1754 ð_key, sizeof(eth_key));
1758 commit_vlan_action(const struct flow *flow, struct flow *base,
1759 struct ofpbuf *odp_actions)
1761 if (base->vlan_tci == flow->vlan_tci) {
1765 if (base->vlan_tci & htons(VLAN_CFI)) {
1766 nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
1769 if (flow->vlan_tci & htons(VLAN_CFI)) {
1770 struct ovs_action_push_vlan vlan;
1772 vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
1773 vlan.vlan_tci = flow->vlan_tci;
1774 nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
1775 &vlan, sizeof vlan);
1777 base->vlan_tci = flow->vlan_tci;
1781 commit_set_nw_action(const struct flow *flow, struct flow *base,
1782 struct ofpbuf *odp_actions)
1784 struct ovs_key_ipv4 ipv4_key;
1786 if (base->dl_type != htons(ETH_TYPE_IP) ||
1787 !base->nw_src || !base->nw_dst) {
1791 if (base->nw_src == flow->nw_src &&
1792 base->nw_dst == flow->nw_dst &&
1793 base->nw_tos == flow->nw_tos &&
1794 base->nw_ttl == flow->nw_ttl &&
1795 base->nw_frag == flow->nw_frag) {
1799 ipv4_key.ipv4_src = base->nw_src = flow->nw_src;
1800 ipv4_key.ipv4_dst = base->nw_dst = flow->nw_dst;
1801 ipv4_key.ipv4_tos = base->nw_tos = flow->nw_tos;
1802 ipv4_key.ipv4_ttl = base->nw_ttl = flow->nw_ttl;
1803 ipv4_key.ipv4_proto = base->nw_proto;
1804 ipv4_key.ipv4_frag = (base->nw_frag == 0 ? OVS_FRAG_TYPE_NONE
1805 : base->nw_frag == FLOW_NW_FRAG_ANY
1806 ? OVS_FRAG_TYPE_FIRST : OVS_FRAG_TYPE_LATER);
1808 commit_set_action(odp_actions, OVS_KEY_ATTR_IPV4,
1809 &ipv4_key, sizeof(ipv4_key));
1813 commit_set_port_action(const struct flow *flow, struct flow *base,
1814 struct ofpbuf *odp_actions)
1816 if (!base->tp_src || !base->tp_dst) {
1820 if (base->tp_src == flow->tp_src &&
1821 base->tp_dst == flow->tp_dst) {
1825 if (flow->nw_proto == IPPROTO_TCP) {
1826 struct ovs_key_tcp port_key;
1828 port_key.tcp_src = base->tp_src = flow->tp_src;
1829 port_key.tcp_dst = base->tp_dst = flow->tp_dst;
1831 commit_set_action(odp_actions, OVS_KEY_ATTR_TCP,
1832 &port_key, sizeof(port_key));
1834 } else if (flow->nw_proto == IPPROTO_UDP) {
1835 struct ovs_key_udp port_key;
1837 port_key.udp_src = base->tp_src = flow->tp_src;
1838 port_key.udp_dst = base->tp_dst = flow->tp_dst;
1840 commit_set_action(odp_actions, OVS_KEY_ATTR_UDP,
1841 &port_key, sizeof(port_key));
1846 commit_set_priority_action(const struct flow *flow, struct flow *base,
1847 struct ofpbuf *odp_actions)
1849 if (base->skb_priority == flow->skb_priority) {
1852 base->skb_priority = flow->skb_priority;
1854 commit_set_action(odp_actions, OVS_KEY_ATTR_PRIORITY,
1855 &base->skb_priority, sizeof(base->skb_priority));
1858 /* If any of the flow key data that ODP actions can modify are different in
1859 * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
1860 * key from 'base' into 'flow', and then changes 'base' the same way. */
1862 commit_odp_actions(const struct flow *flow, struct flow *base,
1863 struct ofpbuf *odp_actions)
1865 commit_set_tun_id_action(flow, base, odp_actions);
1866 commit_set_ether_addr_action(flow, base, odp_actions);
1867 commit_vlan_action(flow, base, odp_actions);
1868 commit_set_nw_action(flow, base, odp_actions);
1869 commit_set_port_action(flow, base, odp_actions);
1870 commit_set_priority_action(flow, base, odp_actions);