2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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.
18 #include <arpa/inet.h>
23 #include <netinet/in.h>
24 #include <netinet/icmp6.h>
27 #include "byte-order.h"
29 #include "dynamic-string.h"
39 VLOG_DEFINE_THIS_MODULE(odp_util);
41 /* The interface between userspace and kernel uses an "OVS_*" prefix.
42 * Since this is fairly non-specific for the OVS userspace components,
43 * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
44 * interactions with the datapath.
47 /* The set of characters that may separate one action or one key attribute
49 static const char *delimiters = ", \t\r\n";
51 static int parse_odp_key_attr(const char *, const struct simap *port_names,
53 static void format_odp_key_attr(const struct nlattr *a, struct ds *ds);
55 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
58 * - For an action whose argument has a fixed length, returned that
59 * nonnegative length in bytes.
61 * - For an action with a variable-length argument, returns -2.
63 * - For an invalid 'type', returns -1. */
65 odp_action_len(uint16_t type)
67 if (type > OVS_ACTION_ATTR_MAX) {
71 switch ((enum ovs_action_attr) type) {
72 case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
73 case OVS_ACTION_ATTR_USERSPACE: return -2;
74 case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
75 case OVS_ACTION_ATTR_POP_VLAN: return 0;
76 case OVS_ACTION_ATTR_SET: return -2;
77 case OVS_ACTION_ATTR_SAMPLE: return -2;
79 case OVS_ACTION_ATTR_UNSPEC:
80 case __OVS_ACTION_ATTR_MAX:
88 ovs_key_attr_to_string(enum ovs_key_attr attr)
90 static char unknown_attr[3 + INT_STRLEN(unsigned int) + 1];
93 case OVS_KEY_ATTR_UNSPEC: return "unspec";
94 case OVS_KEY_ATTR_ENCAP: return "encap";
95 case OVS_KEY_ATTR_PRIORITY: return "skb_priority";
96 case OVS_KEY_ATTR_SKB_MARK: return "skb_mark";
97 case OVS_KEY_ATTR_TUN_ID: return "tun_id";
98 case OVS_KEY_ATTR_TUNNEL: return "tunnel";
99 case OVS_KEY_ATTR_IN_PORT: return "in_port";
100 case OVS_KEY_ATTR_ETHERNET: return "eth";
101 case OVS_KEY_ATTR_VLAN: return "vlan";
102 case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
103 case OVS_KEY_ATTR_IPV4: return "ipv4";
104 case OVS_KEY_ATTR_IPV6: return "ipv6";
105 case OVS_KEY_ATTR_TCP: return "tcp";
106 case OVS_KEY_ATTR_UDP: return "udp";
107 case OVS_KEY_ATTR_ICMP: return "icmp";
108 case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
109 case OVS_KEY_ATTR_ARP: return "arp";
110 case OVS_KEY_ATTR_ND: return "nd";
112 case __OVS_KEY_ATTR_MAX:
114 snprintf(unknown_attr, sizeof unknown_attr, "key%u",
115 (unsigned int) attr);
121 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
123 size_t len = nl_attr_get_size(a);
125 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
127 const uint8_t *unspec;
130 unspec = nl_attr_get(a);
131 for (i = 0; i < len; i++) {
132 ds_put_char(ds, i ? ' ': '(');
133 ds_put_format(ds, "%02x", unspec[i]);
135 ds_put_char(ds, ')');
140 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
142 static const struct nl_policy ovs_sample_policy[] = {
143 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
144 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
146 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
148 const struct nlattr *nla_acts;
151 ds_put_cstr(ds, "sample");
153 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
154 ds_put_cstr(ds, "(error)");
158 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
161 ds_put_format(ds, "(sample=%.1f%%,", percentage);
163 ds_put_cstr(ds, "actions(");
164 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
165 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
166 format_odp_actions(ds, nla_acts, len);
167 ds_put_format(ds, "))");
171 slow_path_reason_to_string(uint32_t data)
173 enum slow_path_reason bit = (enum slow_path_reason) data;
184 case SLOW_CONTROLLER:
194 parse_flags(const char *s, const char *(*bit_to_string)(uint32_t),
205 while (s[n] != ')') {
206 unsigned long long int flags;
210 if (sscanf(&s[n], "%lli%n", &flags, &n0) > 0 && n0 > 0) {
211 n += n0 + (s[n + n0] == ',');
216 for (bit = 1; bit; bit <<= 1) {
217 const char *name = bit_to_string(bit);
225 if (!strncmp(s + n, name, len) &&
226 (s[n + len] == ',' || s[n + len] == ')')) {
228 n += len + (s[n + len] == ',');
244 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
246 static const struct nl_policy ovs_userspace_policy[] = {
247 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
248 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
250 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
252 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
253 ds_put_cstr(ds, "userspace(error)");
257 ds_put_format(ds, "userspace(pid=%"PRIu32,
258 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
260 if (a[OVS_USERSPACE_ATTR_USERDATA]) {
261 uint64_t userdata = nl_attr_get_u64(a[OVS_USERSPACE_ATTR_USERDATA]);
262 union user_action_cookie cookie;
264 memcpy(&cookie, &userdata, sizeof cookie);
266 switch (cookie.type) {
267 case USER_ACTION_COOKIE_SFLOW:
268 ds_put_format(ds, ",sFlow("
269 "vid=%"PRIu16",pcp=%"PRIu8",output=%"PRIu32")",
270 vlan_tci_to_vid(cookie.sflow.vlan_tci),
271 vlan_tci_to_pcp(cookie.sflow.vlan_tci),
272 cookie.sflow.output);
275 case USER_ACTION_COOKIE_SLOW_PATH:
276 ds_put_cstr(ds, ",slow_path(");
277 format_flags(ds, slow_path_reason_to_string,
278 cookie.slow_path.reason, ',');
279 ds_put_format(ds, ")");
282 case USER_ACTION_COOKIE_UNSPEC:
284 ds_put_format(ds, ",userdata=0x%"PRIx64, userdata);
289 ds_put_char(ds, ')');
293 format_vlan_tci(struct ds *ds, ovs_be16 vlan_tci)
295 ds_put_format(ds, "vid=%"PRIu16",pcp=%d",
296 vlan_tci_to_vid(vlan_tci),
297 vlan_tci_to_pcp(vlan_tci));
298 if (!(vlan_tci & htons(VLAN_CFI))) {
299 ds_put_cstr(ds, ",cfi=0");
304 format_odp_action(struct ds *ds, const struct nlattr *a)
307 enum ovs_action_attr type = nl_attr_type(a);
308 const struct ovs_action_push_vlan *vlan;
310 expected_len = odp_action_len(nl_attr_type(a));
311 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
312 ds_put_format(ds, "bad length %zu, expected %d for: ",
313 nl_attr_get_size(a), expected_len);
314 format_generic_odp_action(ds, a);
319 case OVS_ACTION_ATTR_OUTPUT:
320 ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
322 case OVS_ACTION_ATTR_USERSPACE:
323 format_odp_userspace_action(ds, a);
325 case OVS_ACTION_ATTR_SET:
326 ds_put_cstr(ds, "set(");
327 format_odp_key_attr(nl_attr_get(a), ds);
328 ds_put_cstr(ds, ")");
330 case OVS_ACTION_ATTR_PUSH_VLAN:
331 vlan = nl_attr_get(a);
332 ds_put_cstr(ds, "push_vlan(");
333 if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
334 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
336 format_vlan_tci(ds, vlan->vlan_tci);
337 ds_put_char(ds, ')');
339 case OVS_ACTION_ATTR_POP_VLAN:
340 ds_put_cstr(ds, "pop_vlan");
342 case OVS_ACTION_ATTR_SAMPLE:
343 format_odp_sample_action(ds, a);
345 case OVS_ACTION_ATTR_UNSPEC:
346 case __OVS_ACTION_ATTR_MAX:
348 format_generic_odp_action(ds, a);
354 format_odp_actions(struct ds *ds, const struct nlattr *actions,
358 const struct nlattr *a;
361 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
363 ds_put_char(ds, ',');
365 format_odp_action(ds, a);
370 if (left == actions_len) {
371 ds_put_cstr(ds, "<empty>");
373 ds_put_format(ds, ",***%u leftover bytes*** (", left);
374 for (i = 0; i < left; i++) {
375 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
377 ds_put_char(ds, ')');
380 ds_put_cstr(ds, "drop");
385 parse_odp_action(const char *s, const struct simap *port_names,
386 struct ofpbuf *actions)
388 /* Many of the sscanf calls in this function use oversized destination
389 * fields because some sscanf() implementations truncate the range of %i
390 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
391 * value of 0x7fff. The other alternatives are to allow only a single
392 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
395 * The tun_id parser has to use an alternative approach because there is no
396 * type larger than 64 bits. */
399 unsigned long long int port;
402 if (sscanf(s, "%lli%n", &port, &n) > 0 && n > 0) {
403 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
409 int len = strcspn(s, delimiters);
410 struct simap_node *node;
412 node = simap_find_len(port_names, s, len);
414 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, node->data);
420 unsigned long long int pid;
421 unsigned long long int output;
426 if (sscanf(s, "userspace(pid=%lli)%n", &pid, &n) > 0 && n > 0) {
427 odp_put_userspace_action(pid, NULL, actions);
429 } else if (sscanf(s, "userspace(pid=%lli,sFlow(vid=%i,"
430 "pcp=%i,output=%lli))%n",
431 &pid, &vid, &pcp, &output, &n) > 0 && n > 0) {
432 union user_action_cookie cookie;
435 tci = vid | (pcp << VLAN_PCP_SHIFT);
440 cookie.type = USER_ACTION_COOKIE_SFLOW;
441 cookie.sflow.vlan_tci = htons(tci);
442 cookie.sflow.output = output;
443 odp_put_userspace_action(pid, &cookie, actions);
445 } else if (sscanf(s, "userspace(pid=%lli,slow_path%n", &pid, &n) > 0
447 union user_action_cookie cookie;
450 cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
451 cookie.slow_path.unused = 0;
452 cookie.slow_path.reason = 0;
454 res = parse_flags(&s[n], slow_path_reason_to_string,
455 &cookie.slow_path.reason);
465 odp_put_userspace_action(pid, &cookie, actions);
467 } else if (sscanf(s, "userspace(pid=%lli,userdata="
468 "%31[x0123456789abcdefABCDEF])%n", &pid, userdata_s,
470 union user_action_cookie cookie;
473 userdata = strtoull(userdata_s, NULL, 0);
474 memcpy(&cookie, &userdata, sizeof cookie);
475 odp_put_userspace_action(pid, &cookie, actions);
480 if (!strncmp(s, "set(", 4)) {
484 start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
485 retval = parse_odp_key_attr(s + 4, port_names, actions);
489 if (s[retval + 4] != ')') {
492 nl_msg_end_nested(actions, start_ofs);
497 struct ovs_action_push_vlan push;
498 int tpid = ETH_TYPE_VLAN;
503 if ((sscanf(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n) > 0
505 || (sscanf(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
506 &vid, &pcp, &cfi, &n) > 0 && n > 0)
507 || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
508 &tpid, &vid, &pcp, &n) > 0 && n > 0)
509 || (sscanf(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
510 &tpid, &vid, &pcp, &cfi, &n) > 0 && n > 0)) {
511 push.vlan_tpid = htons(tpid);
512 push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
513 | (pcp << VLAN_PCP_SHIFT)
514 | (cfi ? VLAN_CFI : 0));
515 nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
522 if (!strncmp(s, "pop_vlan", 8)) {
523 nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
531 if (sscanf(s, "sample(sample=%lf%%,actions(%n", &percentage, &n) > 0
532 && percentage >= 0. && percentage <= 100.0
534 size_t sample_ofs, actions_ofs;
537 probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
538 sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
539 nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
540 (probability <= 0 ? 0
541 : probability >= UINT32_MAX ? UINT32_MAX
544 actions_ofs = nl_msg_start_nested(actions,
545 OVS_SAMPLE_ATTR_ACTIONS);
549 n += strspn(s + n, delimiters);
554 retval = parse_odp_action(s + n, port_names, actions);
560 nl_msg_end_nested(actions, actions_ofs);
561 nl_msg_end_nested(actions, sample_ofs);
563 return s[n + 1] == ')' ? n + 2 : -EINVAL;
570 /* Parses the string representation of datapath actions, in the format output
571 * by format_odp_action(). Returns 0 if successful, otherwise a positive errno
572 * value. On success, the ODP actions are appended to 'actions' as a series of
573 * Netlink attributes. On failure, no data is appended to 'actions'. Either
574 * way, 'actions''s data might be reallocated. */
576 odp_actions_from_string(const char *s, const struct simap *port_names,
577 struct ofpbuf *actions)
581 if (!strcasecmp(s, "drop")) {
585 old_size = actions->size;
589 s += strspn(s, delimiters);
594 retval = parse_odp_action(s, port_names, actions);
595 if (retval < 0 || !strchr(delimiters, s[retval])) {
596 actions->size = old_size;
605 /* Returns the correct length of the payload for a flow key attribute of the
606 * specified 'type', -1 if 'type' is unknown, or -2 if the attribute's payload
607 * is variable length. */
609 odp_flow_key_attr_len(uint16_t type)
611 if (type > OVS_KEY_ATTR_MAX) {
615 switch ((enum ovs_key_attr) type) {
616 case OVS_KEY_ATTR_ENCAP: return -2;
617 case OVS_KEY_ATTR_PRIORITY: return 4;
618 case OVS_KEY_ATTR_SKB_MARK: return 4;
619 case OVS_KEY_ATTR_TUN_ID: return 8;
620 case OVS_KEY_ATTR_TUNNEL: return -2;
621 case OVS_KEY_ATTR_IN_PORT: return 4;
622 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
623 case OVS_KEY_ATTR_VLAN: return sizeof(ovs_be16);
624 case OVS_KEY_ATTR_ETHERTYPE: return 2;
625 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
626 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
627 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
628 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
629 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
630 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
631 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
632 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
634 case OVS_KEY_ATTR_UNSPEC:
635 case __OVS_KEY_ATTR_MAX:
643 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
645 size_t len = nl_attr_get_size(a);
647 const uint8_t *unspec;
650 unspec = nl_attr_get(a);
651 for (i = 0; i < len; i++) {
652 ds_put_char(ds, i ? ' ': '(');
653 ds_put_format(ds, "%02x", unspec[i]);
655 ds_put_char(ds, ')');
660 ovs_frag_type_to_string(enum ovs_frag_type type)
663 case OVS_FRAG_TYPE_NONE:
665 case OVS_FRAG_TYPE_FIRST:
667 case OVS_FRAG_TYPE_LATER:
669 case __OVS_FRAG_TYPE_MAX:
676 tunnel_key_attr_len(int type)
679 case OVS_TUNNEL_KEY_ATTR_ID: return 8;
680 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC: return 4;
681 case OVS_TUNNEL_KEY_ATTR_IPV4_DST: return 4;
682 case OVS_TUNNEL_KEY_ATTR_TOS: return 1;
683 case OVS_TUNNEL_KEY_ATTR_TTL: return 1;
684 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT: return 0;
685 case OVS_TUNNEL_KEY_ATTR_CSUM: return 0;
686 case __OVS_TUNNEL_KEY_ATTR_MAX:
692 static enum odp_key_fitness
693 tun_key_from_attr(const struct nlattr *attr, struct flow_tnl *tun)
696 const struct nlattr *a;
698 bool unknown = false;
700 NL_NESTED_FOR_EACH(a, left, attr) {
701 uint16_t type = nl_attr_type(a);
702 size_t len = nl_attr_get_size(a);
703 int expected_len = tunnel_key_attr_len(type);
705 if (len != expected_len && expected_len >= 0) {
706 return ODP_FIT_ERROR;
710 case OVS_TUNNEL_KEY_ATTR_ID:
711 tun->tun_id = nl_attr_get_be64(a);
712 tun->flags |= FLOW_TNL_F_KEY;
714 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
715 tun->ip_src = nl_attr_get_be32(a);
717 case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
718 tun->ip_dst = nl_attr_get_be32(a);
720 case OVS_TUNNEL_KEY_ATTR_TOS:
721 tun->ip_tos = nl_attr_get_u8(a);
723 case OVS_TUNNEL_KEY_ATTR_TTL:
724 tun->ip_ttl = nl_attr_get_u8(a);
727 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
728 tun->flags |= FLOW_TNL_F_DONT_FRAGMENT;
730 case OVS_TUNNEL_KEY_ATTR_CSUM:
731 tun->flags |= FLOW_TNL_F_CSUM;
734 /* Allow this to show up as unexpected, if there are unknown
735 * tunnel attribute, eventually resulting in ODP_FIT_TOO_MUCH. */
742 return ODP_FIT_ERROR;
745 return ODP_FIT_TOO_MUCH;
747 return ODP_FIT_PERFECT;
751 tun_key_to_attr(struct ofpbuf *a, const struct flow_tnl *tun_key)
755 tun_key_ofs = nl_msg_start_nested(a, OVS_KEY_ATTR_TUNNEL);
757 if (tun_key->flags & FLOW_TNL_F_KEY) {
758 nl_msg_put_be64(a, OVS_TUNNEL_KEY_ATTR_ID, tun_key->tun_id);
760 if (tun_key->ip_src) {
761 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_SRC, tun_key->ip_src);
763 if (tun_key->ip_dst) {
764 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_DST, tun_key->ip_dst);
766 if (tun_key->ip_tos) {
767 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TOS, tun_key->ip_tos);
769 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TTL, tun_key->ip_ttl);
770 if (tun_key->flags & FLOW_TNL_F_DONT_FRAGMENT) {
771 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
773 if (tun_key->flags & FLOW_TNL_F_CSUM) {
774 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
777 nl_msg_end_nested(a, tun_key_ofs);
781 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
783 const struct ovs_key_ethernet *eth_key;
784 const struct ovs_key_ipv4 *ipv4_key;
785 const struct ovs_key_ipv6 *ipv6_key;
786 const struct ovs_key_tcp *tcp_key;
787 const struct ovs_key_udp *udp_key;
788 const struct ovs_key_icmp *icmp_key;
789 const struct ovs_key_icmpv6 *icmpv6_key;
790 const struct ovs_key_arp *arp_key;
791 const struct ovs_key_nd *nd_key;
792 struct flow_tnl tun_key;
793 enum ovs_key_attr attr = nl_attr_type(a);
796 ds_put_cstr(ds, ovs_key_attr_to_string(attr));
797 expected_len = odp_flow_key_attr_len(nl_attr_type(a));
798 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
799 ds_put_format(ds, "(bad length %zu, expected %d)",
801 odp_flow_key_attr_len(nl_attr_type(a)));
802 format_generic_odp_key(a, ds);
807 case OVS_KEY_ATTR_ENCAP:
808 ds_put_cstr(ds, "(");
809 if (nl_attr_get_size(a)) {
810 odp_flow_key_format(nl_attr_get(a), nl_attr_get_size(a), ds);
812 ds_put_char(ds, ')');
815 case OVS_KEY_ATTR_PRIORITY:
816 ds_put_format(ds, "(%#"PRIx32")", nl_attr_get_u32(a));
819 case OVS_KEY_ATTR_SKB_MARK:
820 ds_put_format(ds, "(%#"PRIx32")", nl_attr_get_u32(a));
823 case OVS_KEY_ATTR_TUN_ID:
824 ds_put_format(ds, "(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
827 case OVS_KEY_ATTR_TUNNEL:
828 memset(&tun_key, 0, sizeof tun_key);
829 if (tun_key_from_attr(a, &tun_key) == ODP_FIT_ERROR) {
830 ds_put_format(ds, "(error)");
832 ds_put_format(ds, "(tun_id=0x%"PRIx64",src="IP_FMT",dst="IP_FMT","
833 "tos=0x%"PRIx8",ttl=%"PRIu8",flags(",
834 ntohll(tun_key.tun_id),
835 IP_ARGS(tun_key.ip_src),
836 IP_ARGS(tun_key.ip_dst),
837 tun_key.ip_tos, tun_key.ip_ttl);
839 format_flags(ds, flow_tun_flag_to_string,
840 (uint32_t) tun_key.flags, ',');
841 ds_put_format(ds, "))");
845 case OVS_KEY_ATTR_IN_PORT:
846 ds_put_format(ds, "(%"PRIu32")", nl_attr_get_u32(a));
849 case OVS_KEY_ATTR_ETHERNET:
850 eth_key = nl_attr_get(a);
851 ds_put_format(ds, "(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
852 ETH_ADDR_ARGS(eth_key->eth_src),
853 ETH_ADDR_ARGS(eth_key->eth_dst));
856 case OVS_KEY_ATTR_VLAN:
857 ds_put_char(ds, '(');
858 format_vlan_tci(ds, nl_attr_get_be16(a));
859 ds_put_char(ds, ')');
862 case OVS_KEY_ATTR_ETHERTYPE:
863 ds_put_format(ds, "(0x%04"PRIx16")",
864 ntohs(nl_attr_get_be16(a)));
867 case OVS_KEY_ATTR_IPV4:
868 ipv4_key = nl_attr_get(a);
869 ds_put_format(ds, "(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
870 ",tos=%#"PRIx8",ttl=%"PRIu8",frag=%s)",
871 IP_ARGS(ipv4_key->ipv4_src),
872 IP_ARGS(ipv4_key->ipv4_dst),
873 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
875 ovs_frag_type_to_string(ipv4_key->ipv4_frag));
878 case OVS_KEY_ATTR_IPV6: {
879 char src_str[INET6_ADDRSTRLEN];
880 char dst_str[INET6_ADDRSTRLEN];
882 ipv6_key = nl_attr_get(a);
883 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
884 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
886 ds_put_format(ds, "(src=%s,dst=%s,label=%#"PRIx32",proto=%"PRIu8
887 ",tclass=%#"PRIx8",hlimit=%"PRIu8",frag=%s)",
888 src_str, dst_str, ntohl(ipv6_key->ipv6_label),
889 ipv6_key->ipv6_proto, ipv6_key->ipv6_tclass,
890 ipv6_key->ipv6_hlimit,
891 ovs_frag_type_to_string(ipv6_key->ipv6_frag));
895 case OVS_KEY_ATTR_TCP:
896 tcp_key = nl_attr_get(a);
897 ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
898 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
901 case OVS_KEY_ATTR_UDP:
902 udp_key = nl_attr_get(a);
903 ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
904 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
907 case OVS_KEY_ATTR_ICMP:
908 icmp_key = nl_attr_get(a);
909 ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
910 icmp_key->icmp_type, icmp_key->icmp_code);
913 case OVS_KEY_ATTR_ICMPV6:
914 icmpv6_key = nl_attr_get(a);
915 ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
916 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
919 case OVS_KEY_ATTR_ARP:
920 arp_key = nl_attr_get(a);
921 ds_put_format(ds, "(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
922 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
923 IP_ARGS(arp_key->arp_sip), IP_ARGS(arp_key->arp_tip),
924 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
925 ETH_ADDR_ARGS(arp_key->arp_tha));
928 case OVS_KEY_ATTR_ND: {
929 char target[INET6_ADDRSTRLEN];
931 nd_key = nl_attr_get(a);
932 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
934 ds_put_format(ds, "(target=%s", target);
935 if (!eth_addr_is_zero(nd_key->nd_sll)) {
936 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
937 ETH_ADDR_ARGS(nd_key->nd_sll));
939 if (!eth_addr_is_zero(nd_key->nd_tll)) {
940 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
941 ETH_ADDR_ARGS(nd_key->nd_tll));
943 ds_put_char(ds, ')');
947 case OVS_KEY_ATTR_UNSPEC:
948 case __OVS_KEY_ATTR_MAX:
950 format_generic_odp_key(a, ds);
955 /* Appends to 'ds' a string representation of the 'key_len' bytes of
956 * OVS_KEY_ATTR_* attributes in 'key'. */
958 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
961 const struct nlattr *a;
964 NL_ATTR_FOR_EACH (a, left, key, key_len) {
966 ds_put_char(ds, ',');
968 format_odp_key_attr(a, ds);
973 if (left == key_len) {
974 ds_put_cstr(ds, "<empty>");
976 ds_put_format(ds, ",***%u leftover bytes*** (", left);
977 for (i = 0; i < left; i++) {
978 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
980 ds_put_char(ds, ')');
983 ds_put_cstr(ds, "<empty>");
988 put_nd_key(int n, const char *nd_target_s,
989 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
991 struct ovs_key_nd nd_key;
993 memset(&nd_key, 0, sizeof nd_key);
994 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
998 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
1001 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
1003 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
1008 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
1010 if (!strcasecmp(s, "no")) {
1011 *type = OVS_FRAG_TYPE_NONE;
1012 } else if (!strcasecmp(s, "first")) {
1013 *type = OVS_FRAG_TYPE_FIRST;
1014 } else if (!strcasecmp(s, "later")) {
1015 *type = OVS_FRAG_TYPE_LATER;
1023 parse_odp_key_attr(const char *s, const struct simap *port_names,
1026 /* Many of the sscanf calls in this function use oversized destination
1027 * fields because some sscanf() implementations truncate the range of %i
1028 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
1029 * value of 0x7fff. The other alternatives are to allow only a single
1030 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
1033 * The tun_id parser has to use an alternative approach because there is no
1034 * type larger than 64 bits. */
1037 unsigned long long int priority;
1040 if (sscanf(s, "skb_priority(%llx)%n", &priority, &n) > 0 && n > 0) {
1041 nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
1047 unsigned long long int mark;
1050 if (sscanf(s, "skb_mark(%llx)%n", &mark, &n) > 0 && n > 0) {
1051 nl_msg_put_u32(key, OVS_KEY_ATTR_SKB_MARK, mark);
1060 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
1061 tun_id_s, &n) > 0 && n > 0) {
1062 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
1063 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
1071 struct flow_tnl tun_key;
1074 if (sscanf(s, "tunnel(tun_id=%31[x0123456789abcdefABCDEF],"
1075 "src="IP_SCAN_FMT",dst="IP_SCAN_FMT
1076 ",tos=%i,ttl=%i,flags%n", tun_id_s,
1077 IP_SCAN_ARGS(&tun_key.ip_src),
1078 IP_SCAN_ARGS(&tun_key.ip_dst), &tos, &ttl,
1083 tun_key.tun_id = htonll(strtoull(tun_id_s, NULL, 0));
1084 tun_key.ip_tos = tos;
1085 tun_key.ip_ttl = ttl;
1086 res = parse_flags(&s[n], flow_tun_flag_to_string, &flags);
1087 tun_key.flags = (uint16_t) flags;
1097 tun_key_to_attr(key, &tun_key);
1103 unsigned long long int in_port;
1106 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
1107 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
1112 if (port_names && !strncmp(s, "in_port(", 8)) {
1114 const struct simap_node *node;
1118 name_len = strcspn(s, ")");
1119 node = simap_find_len(port_names, name, name_len);
1121 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, node->data);
1122 return 8 + name_len + 1;
1127 struct ovs_key_ethernet eth_key;
1131 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
1132 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
1133 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
1134 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
1135 ð_key, sizeof eth_key);
1146 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n", &vid, &pcp, &n) > 0
1148 nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1149 htons((vid << VLAN_VID_SHIFT) |
1150 (pcp << VLAN_PCP_SHIFT) |
1153 } else if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i,cfi=%i)%n",
1154 &vid, &pcp, &cfi, &n) > 0
1156 nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1157 htons((vid << VLAN_VID_SHIFT) |
1158 (pcp << VLAN_PCP_SHIFT) |
1159 (cfi ? VLAN_CFI : 0)));
1168 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
1169 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
1181 enum ovs_frag_type ipv4_frag;
1184 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
1185 "proto=%i,tos=%i,ttl=%i,frag=%7[a-z])%n",
1186 IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
1187 &ipv4_proto, &ipv4_tos, &ipv4_ttl, frag, &n) > 0
1189 && ovs_frag_type_from_string(frag, &ipv4_frag)) {
1190 struct ovs_key_ipv4 ipv4_key;
1192 ipv4_key.ipv4_src = ipv4_src;
1193 ipv4_key.ipv4_dst = ipv4_dst;
1194 ipv4_key.ipv4_proto = ipv4_proto;
1195 ipv4_key.ipv4_tos = ipv4_tos;
1196 ipv4_key.ipv4_ttl = ipv4_ttl;
1197 ipv4_key.ipv4_frag = ipv4_frag;
1198 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
1199 &ipv4_key, sizeof ipv4_key);
1205 char ipv6_src_s[IPV6_SCAN_LEN + 1];
1206 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
1212 enum ovs_frag_type ipv6_frag;
1215 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
1216 "label=%i,proto=%i,tclass=%i,hlimit=%i,frag=%7[a-z])%n",
1217 ipv6_src_s, ipv6_dst_s, &ipv6_label,
1218 &ipv6_proto, &ipv6_tclass, &ipv6_hlimit, frag, &n) > 0
1220 && ovs_frag_type_from_string(frag, &ipv6_frag)) {
1221 struct ovs_key_ipv6 ipv6_key;
1223 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
1224 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
1227 ipv6_key.ipv6_label = htonl(ipv6_label);
1228 ipv6_key.ipv6_proto = ipv6_proto;
1229 ipv6_key.ipv6_tclass = ipv6_tclass;
1230 ipv6_key.ipv6_hlimit = ipv6_hlimit;
1231 ipv6_key.ipv6_frag = ipv6_frag;
1232 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
1233 &ipv6_key, sizeof ipv6_key);
1243 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
1245 struct ovs_key_tcp tcp_key;
1247 tcp_key.tcp_src = htons(tcp_src);
1248 tcp_key.tcp_dst = htons(tcp_dst);
1249 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
1259 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
1261 struct ovs_key_udp udp_key;
1263 udp_key.udp_src = htons(udp_src);
1264 udp_key.udp_dst = htons(udp_dst);
1265 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
1275 if (sscanf(s, "icmp(type=%i,code=%i)%n",
1276 &icmp_type, &icmp_code, &n) > 0
1278 struct ovs_key_icmp icmp_key;
1280 icmp_key.icmp_type = icmp_type;
1281 icmp_key.icmp_code = icmp_code;
1282 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
1283 &icmp_key, sizeof icmp_key);
1289 struct ovs_key_icmpv6 icmpv6_key;
1292 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
1293 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
1295 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
1296 &icmpv6_key, sizeof icmpv6_key);
1305 uint8_t arp_sha[ETH_ADDR_LEN];
1306 uint8_t arp_tha[ETH_ADDR_LEN];
1309 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
1310 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
1311 IP_SCAN_ARGS(&arp_sip),
1312 IP_SCAN_ARGS(&arp_tip),
1314 ETH_ADDR_SCAN_ARGS(arp_sha),
1315 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
1316 struct ovs_key_arp arp_key;
1318 memset(&arp_key, 0, sizeof arp_key);
1319 arp_key.arp_sip = arp_sip;
1320 arp_key.arp_tip = arp_tip;
1321 arp_key.arp_op = htons(arp_op);
1322 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
1323 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
1324 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
1330 char nd_target_s[IPV6_SCAN_LEN + 1];
1331 uint8_t nd_sll[ETH_ADDR_LEN];
1332 uint8_t nd_tll[ETH_ADDR_LEN];
1335 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
1336 nd_target_s, &n) > 0 && n > 0) {
1337 return put_nd_key(n, nd_target_s, NULL, NULL, key);
1339 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
1340 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
1342 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
1344 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
1345 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
1347 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
1349 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
1350 "tll="ETH_ADDR_SCAN_FMT")%n",
1351 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
1352 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
1354 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
1358 if (!strncmp(s, "encap(", 6)) {
1359 const char *start = s;
1362 encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
1368 s += strspn(s, ", \t\r\n");
1371 } else if (*s == ')') {
1375 retval = parse_odp_key_attr(s, port_names, key);
1383 nl_msg_end_nested(key, encap);
1391 /* Parses the string representation of a datapath flow key, in the
1392 * format output by odp_flow_key_format(). Returns 0 if successful,
1393 * otherwise a positive errno value. On success, the flow key is
1394 * appended to 'key' as a series of Netlink attributes. On failure, no
1395 * data is appended to 'key'. Either way, 'key''s data might be
1398 * If 'port_names' is nonnull, it points to an simap that maps from a port name
1399 * to a port number. (Port names may be used instead of port numbers in
1402 * On success, the attributes appended to 'key' are individually syntactically
1403 * valid, but they may not be valid as a sequence. 'key' might, for example,
1404 * have duplicated keys. odp_flow_key_to_flow() will detect those errors. */
1406 odp_flow_key_from_string(const char *s, const struct simap *port_names,
1409 const size_t old_size = key->size;
1413 s += strspn(s, delimiters);
1418 retval = parse_odp_key_attr(s, port_names, key);
1420 key->size = old_size;
1430 ovs_to_odp_frag(uint8_t nw_frag)
1432 return (nw_frag == 0 ? OVS_FRAG_TYPE_NONE
1433 : nw_frag == FLOW_NW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
1434 : OVS_FRAG_TYPE_LATER);
1437 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'.
1438 * 'flow->in_port' is ignored (since it is likely to be an OpenFlow port
1439 * number rather than a datapath port number). Instead, if 'odp_in_port'
1440 * is anything other than OVSP_NONE, it is included in 'buf' as the input
1443 * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
1444 * capable of being expanded to allow for that much space. */
1446 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow,
1447 uint32_t odp_in_port)
1449 struct ovs_key_ethernet *eth_key;
1452 if (flow->skb_priority) {
1453 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, flow->skb_priority);
1456 if (flow->tunnel.ip_dst) {
1457 tun_key_to_attr(buf, &flow->tunnel);
1458 } else if (flow->tunnel.tun_id != htonll(0)) {
1459 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tunnel.tun_id);
1462 if (flow->skb_mark) {
1463 nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, flow->skb_mark);
1466 if (odp_in_port != OVSP_NONE) {
1467 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT, odp_in_port);
1470 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
1472 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
1473 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
1475 if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
1476 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
1477 nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, flow->vlan_tci);
1478 encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
1479 if (flow->vlan_tci == htons(0)) {
1486 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
1490 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
1492 if (flow->dl_type == htons(ETH_TYPE_IP)) {
1493 struct ovs_key_ipv4 *ipv4_key;
1495 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
1497 ipv4_key->ipv4_src = flow->nw_src;
1498 ipv4_key->ipv4_dst = flow->nw_dst;
1499 ipv4_key->ipv4_proto = flow->nw_proto;
1500 ipv4_key->ipv4_tos = flow->nw_tos;
1501 ipv4_key->ipv4_ttl = flow->nw_ttl;
1502 ipv4_key->ipv4_frag = ovs_to_odp_frag(flow->nw_frag);
1503 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1504 struct ovs_key_ipv6 *ipv6_key;
1506 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
1508 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
1509 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
1510 ipv6_key->ipv6_label = flow->ipv6_label;
1511 ipv6_key->ipv6_proto = flow->nw_proto;
1512 ipv6_key->ipv6_tclass = flow->nw_tos;
1513 ipv6_key->ipv6_hlimit = flow->nw_ttl;
1514 ipv6_key->ipv6_frag = ovs_to_odp_frag(flow->nw_frag);
1515 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1516 flow->dl_type == htons(ETH_TYPE_RARP)) {
1517 struct ovs_key_arp *arp_key;
1519 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
1521 memset(arp_key, 0, sizeof *arp_key);
1522 arp_key->arp_sip = flow->nw_src;
1523 arp_key->arp_tip = flow->nw_dst;
1524 arp_key->arp_op = htons(flow->nw_proto);
1525 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
1526 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
1529 if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1530 if (flow->nw_proto == IPPROTO_TCP) {
1531 struct ovs_key_tcp *tcp_key;
1533 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
1535 tcp_key->tcp_src = flow->tp_src;
1536 tcp_key->tcp_dst = flow->tp_dst;
1537 } else if (flow->nw_proto == IPPROTO_UDP) {
1538 struct ovs_key_udp *udp_key;
1540 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
1542 udp_key->udp_src = flow->tp_src;
1543 udp_key->udp_dst = flow->tp_dst;
1544 } else if (flow->dl_type == htons(ETH_TYPE_IP)
1545 && flow->nw_proto == IPPROTO_ICMP) {
1546 struct ovs_key_icmp *icmp_key;
1548 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
1550 icmp_key->icmp_type = ntohs(flow->tp_src);
1551 icmp_key->icmp_code = ntohs(flow->tp_dst);
1552 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
1553 && flow->nw_proto == IPPROTO_ICMPV6) {
1554 struct ovs_key_icmpv6 *icmpv6_key;
1556 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
1557 sizeof *icmpv6_key);
1558 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
1559 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
1561 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
1562 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
1563 struct ovs_key_nd *nd_key;
1565 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
1567 memcpy(nd_key->nd_target, &flow->nd_target,
1568 sizeof nd_key->nd_target);
1569 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
1570 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
1577 nl_msg_end_nested(buf, encap);
1582 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
1584 BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
1585 return hash_words((const uint32_t *) key, key_len / sizeof(uint32_t), 0);
1589 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
1590 uint64_t attrs, int out_of_range_attr,
1591 const struct nlattr *key, size_t key_len)
1596 if (VLOG_DROP_DBG(rl)) {
1601 for (i = 0; i < 64; i++) {
1602 if (attrs & (UINT64_C(1) << i)) {
1603 ds_put_format(&s, " %s", ovs_key_attr_to_string(i));
1606 if (out_of_range_attr) {
1607 ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
1610 ds_put_cstr(&s, ": ");
1611 odp_flow_key_format(key, key_len, &s);
1613 VLOG_DBG("%s:%s", title, ds_cstr(&s));
1618 odp_to_ovs_frag(uint8_t odp_frag, struct flow *flow)
1620 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1622 if (odp_frag > OVS_FRAG_TYPE_LATER) {
1623 VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
1627 if (odp_frag != OVS_FRAG_TYPE_NONE) {
1628 flow->nw_frag |= FLOW_NW_FRAG_ANY;
1629 if (odp_frag == OVS_FRAG_TYPE_LATER) {
1630 flow->nw_frag |= FLOW_NW_FRAG_LATER;
1637 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
1638 const struct nlattr *attrs[], uint64_t *present_attrsp,
1639 int *out_of_range_attrp)
1641 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
1642 const struct nlattr *nla;
1643 uint64_t present_attrs;
1647 *out_of_range_attrp = 0;
1648 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
1649 uint16_t type = nl_attr_type(nla);
1650 size_t len = nl_attr_get_size(nla);
1651 int expected_len = odp_flow_key_attr_len(type);
1653 if (len != expected_len && expected_len >= 0) {
1654 VLOG_ERR_RL(&rl, "attribute %s has length %zu but should have "
1655 "length %d", ovs_key_attr_to_string(type),
1660 if (type >= CHAR_BIT * sizeof present_attrs) {
1661 *out_of_range_attrp = type;
1663 if (present_attrs & (UINT64_C(1) << type)) {
1664 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
1665 ovs_key_attr_to_string(type));
1669 present_attrs |= UINT64_C(1) << type;
1674 VLOG_ERR_RL(&rl, "trailing garbage in flow key");
1678 *present_attrsp = present_attrs;
1682 static enum odp_key_fitness
1683 check_expectations(uint64_t present_attrs, int out_of_range_attr,
1684 uint64_t expected_attrs,
1685 const struct nlattr *key, size_t key_len)
1687 uint64_t missing_attrs;
1688 uint64_t extra_attrs;
1690 missing_attrs = expected_attrs & ~present_attrs;
1691 if (missing_attrs) {
1692 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
1693 log_odp_key_attributes(&rl, "expected but not present",
1694 missing_attrs, 0, key, key_len);
1695 return ODP_FIT_TOO_LITTLE;
1698 extra_attrs = present_attrs & ~expected_attrs;
1699 if (extra_attrs || out_of_range_attr) {
1700 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
1701 log_odp_key_attributes(&rl, "present but not expected",
1702 extra_attrs, out_of_range_attr, key, key_len);
1703 return ODP_FIT_TOO_MUCH;
1706 return ODP_FIT_PERFECT;
1710 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
1711 uint64_t present_attrs, uint64_t *expected_attrs,
1714 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1716 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
1717 flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
1718 if (ntohs(flow->dl_type) < 1536) {
1719 VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
1720 ntohs(flow->dl_type));
1723 *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
1725 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
1730 static enum odp_key_fitness
1731 parse_l3_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
1732 uint64_t present_attrs, int out_of_range_attr,
1733 uint64_t expected_attrs, struct flow *flow,
1734 const struct nlattr *key, size_t key_len)
1736 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1738 if (flow->dl_type == htons(ETH_TYPE_IP)) {
1739 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
1740 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
1741 const struct ovs_key_ipv4 *ipv4_key;
1743 ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
1744 flow->nw_src = ipv4_key->ipv4_src;
1745 flow->nw_dst = ipv4_key->ipv4_dst;
1746 flow->nw_proto = ipv4_key->ipv4_proto;
1747 flow->nw_tos = ipv4_key->ipv4_tos;
1748 flow->nw_ttl = ipv4_key->ipv4_ttl;
1749 if (!odp_to_ovs_frag(ipv4_key->ipv4_frag, flow)) {
1750 return ODP_FIT_ERROR;
1753 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
1754 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
1755 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
1756 const struct ovs_key_ipv6 *ipv6_key;
1758 ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
1759 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
1760 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
1761 flow->ipv6_label = ipv6_key->ipv6_label;
1762 flow->nw_proto = ipv6_key->ipv6_proto;
1763 flow->nw_tos = ipv6_key->ipv6_tclass;
1764 flow->nw_ttl = ipv6_key->ipv6_hlimit;
1765 if (!odp_to_ovs_frag(ipv6_key->ipv6_frag, flow)) {
1766 return ODP_FIT_ERROR;
1769 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
1770 flow->dl_type == htons(ETH_TYPE_RARP)) {
1771 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
1772 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
1773 const struct ovs_key_arp *arp_key;
1775 arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
1776 flow->nw_src = arp_key->arp_sip;
1777 flow->nw_dst = arp_key->arp_tip;
1778 if (arp_key->arp_op & htons(0xff00)) {
1779 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
1780 "key", ntohs(arp_key->arp_op));
1781 return ODP_FIT_ERROR;
1783 flow->nw_proto = ntohs(arp_key->arp_op);
1784 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1785 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1789 if (flow->nw_proto == IPPROTO_TCP
1791 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1792 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
1793 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
1794 const struct ovs_key_tcp *tcp_key;
1796 tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
1797 flow->tp_src = tcp_key->tcp_src;
1798 flow->tp_dst = tcp_key->tcp_dst;
1800 } else if (flow->nw_proto == IPPROTO_UDP
1802 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1803 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
1804 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
1805 const struct ovs_key_udp *udp_key;
1807 udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
1808 flow->tp_src = udp_key->udp_src;
1809 flow->tp_dst = udp_key->udp_dst;
1811 } else if (flow->nw_proto == IPPROTO_ICMP
1812 && flow->dl_type == htons(ETH_TYPE_IP)
1813 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1814 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
1815 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
1816 const struct ovs_key_icmp *icmp_key;
1818 icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
1819 flow->tp_src = htons(icmp_key->icmp_type);
1820 flow->tp_dst = htons(icmp_key->icmp_code);
1822 } else if (flow->nw_proto == IPPROTO_ICMPV6
1823 && flow->dl_type == htons(ETH_TYPE_IPV6)
1824 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
1825 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
1826 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
1827 const struct ovs_key_icmpv6 *icmpv6_key;
1829 icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
1830 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1831 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1833 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1834 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
1835 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
1836 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
1837 const struct ovs_key_nd *nd_key;
1839 nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
1840 memcpy(&flow->nd_target, nd_key->nd_target,
1841 sizeof flow->nd_target);
1842 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1843 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1849 return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
1853 /* Parse 802.1Q header then encapsulated L3 attributes. */
1854 static enum odp_key_fitness
1855 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
1856 uint64_t present_attrs, int out_of_range_attr,
1857 uint64_t expected_attrs, struct flow *flow,
1858 const struct nlattr *key, size_t key_len)
1860 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1862 const struct nlattr *encap
1863 = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
1864 ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
1865 enum odp_key_fitness encap_fitness;
1866 enum odp_key_fitness fitness;
1869 /* Calulate fitness of outer attributes. */
1870 expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
1871 (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
1872 fitness = check_expectations(present_attrs, out_of_range_attr,
1873 expected_attrs, key, key_len);
1875 /* Get the VLAN TCI value. */
1876 if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
1877 return ODP_FIT_TOO_LITTLE;
1879 tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
1880 if (tci == htons(0)) {
1881 /* Corner case for a truncated 802.1Q header. */
1882 if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
1883 return ODP_FIT_TOO_MUCH;
1886 } else if (!(tci & htons(VLAN_CFI))) {
1887 VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
1888 "but CFI bit is not set", ntohs(tci));
1889 return ODP_FIT_ERROR;
1893 * Remove the TPID from dl_type since it's not the real Ethertype. */
1894 flow->vlan_tci = tci;
1895 flow->dl_type = htons(0);
1897 /* Now parse the encapsulated attributes. */
1898 if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
1899 attrs, &present_attrs, &out_of_range_attr)) {
1900 return ODP_FIT_ERROR;
1904 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow)) {
1905 return ODP_FIT_ERROR;
1907 encap_fitness = parse_l3_onward(attrs, present_attrs, out_of_range_attr,
1908 expected_attrs, flow, key, key_len);
1910 /* The overall fitness is the worse of the outer and inner attributes. */
1911 return MAX(fitness, encap_fitness);
1914 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
1915 * structure in 'flow'. Returns an ODP_FIT_* value that indicates how well
1916 * 'key' fits our expectations for what a flow key should contain.
1918 * The 'in_port' will be the datapath's understanding of the port. The
1919 * caller will need to translate with odp_port_to_ofp_port() if the
1920 * OpenFlow port is needed.
1922 * This function doesn't take the packet itself as an argument because none of
1923 * the currently understood OVS_KEY_ATTR_* attributes require it. Currently,
1924 * it is always possible to infer which additional attribute(s) should appear
1925 * by looking at the attributes for lower-level protocols, e.g. if the network
1926 * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
1927 * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
1928 * must be absent. */
1929 enum odp_key_fitness
1930 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
1933 const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
1934 uint64_t expected_attrs;
1935 uint64_t present_attrs;
1936 int out_of_range_attr;
1938 memset(flow, 0, sizeof *flow);
1940 /* Parse attributes. */
1941 if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
1942 &out_of_range_attr)) {
1943 return ODP_FIT_ERROR;
1948 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
1949 flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
1950 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
1953 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK)) {
1954 flow->skb_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_SKB_MARK]);
1955 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK;
1958 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUN_ID)) {
1959 flow->tunnel.tun_id = nl_attr_get_be64(attrs[OVS_KEY_ATTR_TUN_ID]);
1960 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUN_ID;
1963 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUNNEL)) {
1964 enum odp_key_fitness res;
1966 res = tun_key_from_attr(attrs[OVS_KEY_ATTR_TUNNEL], &flow->tunnel);
1967 if (res == ODP_FIT_ERROR) {
1968 return ODP_FIT_ERROR;
1969 } else if (res == ODP_FIT_PERFECT) {
1970 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUNNEL;
1974 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
1975 flow->in_port = nl_attr_get_u32(attrs[OVS_KEY_ATTR_IN_PORT]);
1976 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
1978 flow->in_port = OVSP_NONE;
1981 /* Ethernet header. */
1982 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
1983 const struct ovs_key_ethernet *eth_key;
1985 eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
1986 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
1987 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
1989 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
1991 /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
1992 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow)) {
1993 return ODP_FIT_ERROR;
1996 if (flow->dl_type == htons(ETH_TYPE_VLAN)) {
1997 return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
1998 expected_attrs, flow, key, key_len);
2000 return parse_l3_onward(attrs, present_attrs, out_of_range_attr,
2001 expected_attrs, flow, key, key_len);
2004 /* Returns 'fitness' as a string, for use in debug messages. */
2006 odp_key_fitness_to_string(enum odp_key_fitness fitness)
2009 case ODP_FIT_PERFECT:
2011 case ODP_FIT_TOO_MUCH:
2013 case ODP_FIT_TOO_LITTLE:
2014 return "too_little";
2022 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
2023 * Netlink PID 'pid'. If 'cookie' is nonnull, adds a userdata attribute whose
2024 * contents contains 'cookie' and returns the offset within 'odp_actions' of
2025 * the start of the cookie. (If 'cookie' is null, then the return value is not
2028 odp_put_userspace_action(uint32_t pid, const union user_action_cookie *cookie,
2029 struct ofpbuf *odp_actions)
2033 offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
2034 nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
2036 nl_msg_put_unspec(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
2037 cookie, sizeof *cookie);
2039 nl_msg_end_nested(odp_actions, offset);
2041 return cookie ? odp_actions->size - NLA_ALIGN(sizeof *cookie) : 0;
2045 odp_put_tunnel_action(const struct flow_tnl *tunnel,
2046 struct ofpbuf *odp_actions)
2048 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
2049 tun_key_to_attr(odp_actions, tunnel);
2050 nl_msg_end_nested(odp_actions, offset);
2053 /* The commit_odp_actions() function and its helpers. */
2056 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
2057 const void *key, size_t key_size)
2059 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
2060 nl_msg_put_unspec(odp_actions, key_type, key, key_size);
2061 nl_msg_end_nested(odp_actions, offset);
2064 /* If any of the flow key data that ODP actions can modify are different in
2065 * 'base->tunnel' and 'flow->tunnel', appends a set_tunnel ODP action to
2066 * 'odp_actions' that change the flow tunneling information in key from
2067 * 'base->tunnel' into 'flow->tunnel', and then changes 'base->tunnel' in the
2068 * same way. In other words, operates the same as commit_odp_actions(), but
2069 * only on tunneling information. */
2071 commit_odp_tunnel_action(const struct flow *flow, struct flow *base,
2072 struct ofpbuf *odp_actions)
2074 if (!memcmp(&base->tunnel, &flow->tunnel, sizeof base->tunnel)) {
2077 memcpy(&base->tunnel, &flow->tunnel, sizeof base->tunnel);
2079 /* A valid IPV4_TUNNEL must have non-zero ip_dst. */
2080 if (flow->tunnel.ip_dst) {
2081 odp_put_tunnel_action(&base->tunnel, odp_actions);
2083 commit_set_action(odp_actions, OVS_KEY_ATTR_TUN_ID,
2084 &base->tunnel.tun_id, sizeof base->tunnel.tun_id);
2089 commit_set_ether_addr_action(const struct flow *flow, struct flow *base,
2090 struct ofpbuf *odp_actions)
2092 struct ovs_key_ethernet eth_key;
2094 if (eth_addr_equals(base->dl_src, flow->dl_src) &&
2095 eth_addr_equals(base->dl_dst, flow->dl_dst)) {
2099 memcpy(base->dl_src, flow->dl_src, ETH_ADDR_LEN);
2100 memcpy(base->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
2102 memcpy(eth_key.eth_src, base->dl_src, ETH_ADDR_LEN);
2103 memcpy(eth_key.eth_dst, base->dl_dst, ETH_ADDR_LEN);
2105 commit_set_action(odp_actions, OVS_KEY_ATTR_ETHERNET,
2106 ð_key, sizeof(eth_key));
2110 commit_vlan_action(const struct flow *flow, struct flow *base,
2111 struct ofpbuf *odp_actions)
2113 if (base->vlan_tci == flow->vlan_tci) {
2117 if (base->vlan_tci & htons(VLAN_CFI)) {
2118 nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
2121 if (flow->vlan_tci & htons(VLAN_CFI)) {
2122 struct ovs_action_push_vlan vlan;
2124 vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
2125 vlan.vlan_tci = flow->vlan_tci;
2126 nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
2127 &vlan, sizeof vlan);
2129 base->vlan_tci = flow->vlan_tci;
2133 commit_set_ipv4_action(const struct flow *flow, struct flow *base,
2134 struct ofpbuf *odp_actions)
2136 struct ovs_key_ipv4 ipv4_key;
2138 if (base->nw_src == flow->nw_src &&
2139 base->nw_dst == flow->nw_dst &&
2140 base->nw_tos == flow->nw_tos &&
2141 base->nw_ttl == flow->nw_ttl &&
2142 base->nw_frag == flow->nw_frag) {
2146 ipv4_key.ipv4_src = base->nw_src = flow->nw_src;
2147 ipv4_key.ipv4_dst = base->nw_dst = flow->nw_dst;
2148 ipv4_key.ipv4_tos = base->nw_tos = flow->nw_tos;
2149 ipv4_key.ipv4_ttl = base->nw_ttl = flow->nw_ttl;
2150 ipv4_key.ipv4_proto = base->nw_proto;
2151 ipv4_key.ipv4_frag = ovs_to_odp_frag(base->nw_frag);
2153 commit_set_action(odp_actions, OVS_KEY_ATTR_IPV4,
2154 &ipv4_key, sizeof(ipv4_key));
2158 commit_set_ipv6_action(const struct flow *flow, struct flow *base,
2159 struct ofpbuf *odp_actions)
2161 struct ovs_key_ipv6 ipv6_key;
2163 if (ipv6_addr_equals(&base->ipv6_src, &flow->ipv6_src) &&
2164 ipv6_addr_equals(&base->ipv6_dst, &flow->ipv6_dst) &&
2165 base->ipv6_label == flow->ipv6_label &&
2166 base->nw_tos == flow->nw_tos &&
2167 base->nw_ttl == flow->nw_ttl &&
2168 base->nw_frag == flow->nw_frag) {
2172 base->ipv6_src = flow->ipv6_src;
2173 memcpy(&ipv6_key.ipv6_src, &base->ipv6_src, sizeof(ipv6_key.ipv6_src));
2174 base->ipv6_dst = flow->ipv6_dst;
2175 memcpy(&ipv6_key.ipv6_dst, &base->ipv6_dst, sizeof(ipv6_key.ipv6_dst));
2177 ipv6_key.ipv6_label = base->ipv6_label = flow->ipv6_label;
2178 ipv6_key.ipv6_tclass = base->nw_tos = flow->nw_tos;
2179 ipv6_key.ipv6_hlimit = base->nw_ttl = flow->nw_ttl;
2180 ipv6_key.ipv6_proto = base->nw_proto;
2181 ipv6_key.ipv6_frag = ovs_to_odp_frag(base->nw_frag);
2183 commit_set_action(odp_actions, OVS_KEY_ATTR_IPV6,
2184 &ipv6_key, sizeof(ipv6_key));
2188 commit_set_nw_action(const struct flow *flow, struct flow *base,
2189 struct ofpbuf *odp_actions)
2191 /* Check if flow really have an IP header. */
2192 if (!flow->nw_proto) {
2196 if (base->dl_type == htons(ETH_TYPE_IP)) {
2197 commit_set_ipv4_action(flow, base, odp_actions);
2198 } else if (base->dl_type == htons(ETH_TYPE_IPV6)) {
2199 commit_set_ipv6_action(flow, base, odp_actions);
2204 commit_set_port_action(const struct flow *flow, struct flow *base,
2205 struct ofpbuf *odp_actions)
2207 if (!base->tp_src && !base->tp_dst) {
2211 if (base->tp_src == flow->tp_src &&
2212 base->tp_dst == flow->tp_dst) {
2216 if (flow->nw_proto == IPPROTO_TCP) {
2217 struct ovs_key_tcp port_key;
2219 port_key.tcp_src = base->tp_src = flow->tp_src;
2220 port_key.tcp_dst = base->tp_dst = flow->tp_dst;
2222 commit_set_action(odp_actions, OVS_KEY_ATTR_TCP,
2223 &port_key, sizeof(port_key));
2225 } else if (flow->nw_proto == IPPROTO_UDP) {
2226 struct ovs_key_udp port_key;
2228 port_key.udp_src = base->tp_src = flow->tp_src;
2229 port_key.udp_dst = base->tp_dst = flow->tp_dst;
2231 commit_set_action(odp_actions, OVS_KEY_ATTR_UDP,
2232 &port_key, sizeof(port_key));
2237 commit_set_priority_action(const struct flow *flow, struct flow *base,
2238 struct ofpbuf *odp_actions)
2240 if (base->skb_priority == flow->skb_priority) {
2243 base->skb_priority = flow->skb_priority;
2245 commit_set_action(odp_actions, OVS_KEY_ATTR_PRIORITY,
2246 &base->skb_priority, sizeof(base->skb_priority));
2250 commit_set_skb_mark_action(const struct flow *flow, struct flow *base,
2251 struct ofpbuf *odp_actions)
2253 if (base->skb_mark == flow->skb_mark) {
2256 base->skb_mark = flow->skb_mark;
2258 commit_set_action(odp_actions, OVS_KEY_ATTR_SKB_MARK,
2259 &base->skb_mark, sizeof(base->skb_mark));
2261 /* If any of the flow key data that ODP actions can modify are different in
2262 * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
2263 * key from 'base' into 'flow', and then changes 'base' the same way. Does not
2264 * commit set_tunnel actions. Users should call commit_odp_tunnel_action()
2265 * in addition to this function if needed. */
2267 commit_odp_actions(const struct flow *flow, struct flow *base,
2268 struct ofpbuf *odp_actions)
2270 commit_set_ether_addr_action(flow, base, odp_actions);
2271 commit_vlan_action(flow, base, odp_actions);
2272 commit_set_nw_action(flow, base, odp_actions);
2273 commit_set_port_action(flow, base, odp_actions);
2274 commit_set_priority_action(flow, base, odp_actions);
2275 commit_set_skb_mark_action(flow, base, odp_actions);