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_mask_attr(const char *, const struct simap *port_names,
52 struct ofpbuf *, struct ofpbuf *);
53 static void format_odp_key_attr(const struct nlattr *a,
54 const struct nlattr *ma,
55 const struct hmap *portno_names, struct ds *ds,
58 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
61 * - For an action whose argument has a fixed length, returned that
62 * nonnegative length in bytes.
64 * - For an action with a variable-length argument, returns -2.
66 * - For an invalid 'type', returns -1. */
68 odp_action_len(uint16_t type)
70 if (type > OVS_ACTION_ATTR_MAX) {
74 switch ((enum ovs_action_attr) type) {
75 case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
76 case OVS_ACTION_ATTR_USERSPACE: return -2;
77 case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
78 case OVS_ACTION_ATTR_POP_VLAN: return 0;
79 case OVS_ACTION_ATTR_PUSH_MPLS: return sizeof(struct ovs_action_push_mpls);
80 case OVS_ACTION_ATTR_POP_MPLS: return sizeof(ovs_be16);
81 case OVS_ACTION_ATTR_SET: return -2;
82 case OVS_ACTION_ATTR_SAMPLE: return -2;
84 case OVS_ACTION_ATTR_UNSPEC:
85 case __OVS_ACTION_ATTR_MAX:
92 /* Returns a string form of 'attr'. The return value is either a statically
93 * allocated constant string or the 'bufsize'-byte buffer 'namebuf'. 'bufsize'
94 * should be at least OVS_KEY_ATTR_BUFSIZE. */
95 enum { OVS_KEY_ATTR_BUFSIZE = 3 + INT_STRLEN(unsigned int) + 1 };
97 ovs_key_attr_to_string(enum ovs_key_attr attr, char *namebuf, size_t bufsize)
100 case OVS_KEY_ATTR_UNSPEC: return "unspec";
101 case OVS_KEY_ATTR_ENCAP: return "encap";
102 case OVS_KEY_ATTR_PRIORITY: return "skb_priority";
103 case OVS_KEY_ATTR_SKB_MARK: return "skb_mark";
104 case OVS_KEY_ATTR_TUNNEL: return "tunnel";
105 case OVS_KEY_ATTR_IN_PORT: return "in_port";
106 case OVS_KEY_ATTR_ETHERNET: return "eth";
107 case OVS_KEY_ATTR_VLAN: return "vlan";
108 case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
109 case OVS_KEY_ATTR_IPV4: return "ipv4";
110 case OVS_KEY_ATTR_IPV6: return "ipv6";
111 case OVS_KEY_ATTR_TCP: return "tcp";
112 case OVS_KEY_ATTR_TCP_FLAGS: return "tcp_flags";
113 case OVS_KEY_ATTR_UDP: return "udp";
114 case OVS_KEY_ATTR_SCTP: return "sctp";
115 case OVS_KEY_ATTR_ICMP: return "icmp";
116 case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
117 case OVS_KEY_ATTR_ARP: return "arp";
118 case OVS_KEY_ATTR_ND: return "nd";
119 case OVS_KEY_ATTR_MPLS: return "mpls";
121 case __OVS_KEY_ATTR_MAX:
123 snprintf(namebuf, bufsize, "key%u", (unsigned int) attr);
129 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
131 size_t len = nl_attr_get_size(a);
133 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
135 const uint8_t *unspec;
138 unspec = nl_attr_get(a);
139 for (i = 0; i < len; i++) {
140 ds_put_char(ds, i ? ' ': '(');
141 ds_put_format(ds, "%02x", unspec[i]);
143 ds_put_char(ds, ')');
148 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
150 static const struct nl_policy ovs_sample_policy[] = {
151 { NL_A_NO_ATTR, 0, 0, false }, /* OVS_SAMPLE_ATTR_UNSPEC */
152 { NL_A_U32, 0, 0, false }, /* OVS_SAMPLE_ATTR_PROBABILITY */
153 { NL_A_NESTED, 0, 0, false }, /* OVS_SAMPLE_ATTR_ACTIONS */
155 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
157 const struct nlattr *nla_acts;
160 ds_put_cstr(ds, "sample");
162 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
163 ds_put_cstr(ds, "(error)");
167 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
170 ds_put_format(ds, "(sample=%.1f%%,", percentage);
172 ds_put_cstr(ds, "actions(");
173 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
174 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
175 format_odp_actions(ds, nla_acts, len);
176 ds_put_format(ds, "))");
180 slow_path_reason_to_string(uint32_t reason)
182 switch ((enum slow_path_reason) reason) {
183 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return STRING;
192 slow_path_reason_to_explanation(enum slow_path_reason reason)
195 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return EXPLANATION;
204 parse_flags(const char *s, const char *(*bit_to_string)(uint32_t),
215 while (s[n] != ')') {
216 unsigned long long int flags;
220 if (ovs_scan(&s[n], "%lli%n", &flags, &n0)) {
221 n += n0 + (s[n + n0] == ',');
226 for (bit = 1; bit; bit <<= 1) {
227 const char *name = bit_to_string(bit);
235 if (!strncmp(s + n, name, len) &&
236 (s[n + len] == ',' || s[n + len] == ')')) {
238 n += len + (s[n + len] == ',');
254 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
256 static const struct nl_policy ovs_userspace_policy[] = {
257 { NL_A_NO_ATTR, 0, 0, false }, /* OVS_USERSPACE_ATTR_UNSPEC */
258 { NL_A_U32, 0, 0, false }, /* OVS_USERSPACE_ATTR_PID */
259 { NL_A_UNSPEC, 0, 0, true }, /* OVS_USERSPACE_ATTR_USERDATA */
261 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
262 const struct nlattr *userdata_attr;
264 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
265 ds_put_cstr(ds, "userspace(error)");
269 ds_put_format(ds, "userspace(pid=%"PRIu32,
270 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
272 userdata_attr = a[OVS_USERSPACE_ATTR_USERDATA];
275 const uint8_t *userdata = nl_attr_get(userdata_attr);
276 size_t userdata_len = nl_attr_get_size(userdata_attr);
277 bool userdata_unspec = true;
278 union user_action_cookie cookie;
280 if (userdata_len >= sizeof cookie.type
281 && userdata_len <= sizeof cookie) {
283 memset(&cookie, 0, sizeof cookie);
284 memcpy(&cookie, userdata, userdata_len);
286 userdata_unspec = false;
288 if (userdata_len == sizeof cookie.sflow
289 && cookie.type == USER_ACTION_COOKIE_SFLOW) {
290 ds_put_format(ds, ",sFlow("
291 "vid=%"PRIu16",pcp=%"PRIu8",output=%"PRIu32")",
292 vlan_tci_to_vid(cookie.sflow.vlan_tci),
293 vlan_tci_to_pcp(cookie.sflow.vlan_tci),
294 cookie.sflow.output);
295 } else if (userdata_len == sizeof cookie.slow_path
296 && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
297 ds_put_cstr(ds, ",slow_path(");
298 format_flags(ds, slow_path_reason_to_string,
299 cookie.slow_path.reason, ',');
300 ds_put_format(ds, ")");
301 } else if (userdata_len == sizeof cookie.flow_sample
302 && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
303 ds_put_format(ds, ",flow_sample(probability=%"PRIu16
304 ",collector_set_id=%"PRIu32
305 ",obs_domain_id=%"PRIu32
306 ",obs_point_id=%"PRIu32")",
307 cookie.flow_sample.probability,
308 cookie.flow_sample.collector_set_id,
309 cookie.flow_sample.obs_domain_id,
310 cookie.flow_sample.obs_point_id);
311 } else if (userdata_len >= sizeof cookie.ipfix
312 && cookie.type == USER_ACTION_COOKIE_IPFIX) {
313 ds_put_format(ds, ",ipfix");
315 userdata_unspec = true;
319 if (userdata_unspec) {
321 ds_put_format(ds, ",userdata(");
322 for (i = 0; i < userdata_len; i++) {
323 ds_put_format(ds, "%02x", userdata[i]);
325 ds_put_char(ds, ')');
329 ds_put_char(ds, ')');
333 format_vlan_tci(struct ds *ds, ovs_be16 vlan_tci)
335 ds_put_format(ds, "vid=%"PRIu16",pcp=%d",
336 vlan_tci_to_vid(vlan_tci),
337 vlan_tci_to_pcp(vlan_tci));
338 if (!(vlan_tci & htons(VLAN_CFI))) {
339 ds_put_cstr(ds, ",cfi=0");
344 format_mpls_lse(struct ds *ds, ovs_be32 mpls_lse)
346 ds_put_format(ds, "label=%"PRIu32",tc=%d,ttl=%d,bos=%d",
347 mpls_lse_to_label(mpls_lse),
348 mpls_lse_to_tc(mpls_lse),
349 mpls_lse_to_ttl(mpls_lse),
350 mpls_lse_to_bos(mpls_lse));
354 format_mpls(struct ds *ds, const struct ovs_key_mpls *mpls_key,
355 const struct ovs_key_mpls *mpls_mask)
357 ovs_be32 key = mpls_key->mpls_lse;
359 if (mpls_mask == NULL) {
360 format_mpls_lse(ds, key);
362 ovs_be32 mask = mpls_mask->mpls_lse;
364 ds_put_format(ds, "label=%"PRIu32"/0x%x,tc=%d/%x,ttl=%d/0x%x,bos=%d/%x",
365 mpls_lse_to_label(key), mpls_lse_to_label(mask),
366 mpls_lse_to_tc(key), mpls_lse_to_tc(mask),
367 mpls_lse_to_ttl(key), mpls_lse_to_ttl(mask),
368 mpls_lse_to_bos(key), mpls_lse_to_bos(mask));
373 format_odp_action(struct ds *ds, const struct nlattr *a)
376 enum ovs_action_attr type = nl_attr_type(a);
377 const struct ovs_action_push_vlan *vlan;
379 expected_len = odp_action_len(nl_attr_type(a));
380 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
381 ds_put_format(ds, "bad length %zu, expected %d for: ",
382 nl_attr_get_size(a), expected_len);
383 format_generic_odp_action(ds, a);
388 case OVS_ACTION_ATTR_OUTPUT:
389 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
391 case OVS_ACTION_ATTR_USERSPACE:
392 format_odp_userspace_action(ds, a);
394 case OVS_ACTION_ATTR_SET:
395 ds_put_cstr(ds, "set(");
396 format_odp_key_attr(nl_attr_get(a), NULL, NULL, ds, true);
397 ds_put_cstr(ds, ")");
399 case OVS_ACTION_ATTR_PUSH_VLAN:
400 vlan = nl_attr_get(a);
401 ds_put_cstr(ds, "push_vlan(");
402 if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
403 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
405 format_vlan_tci(ds, vlan->vlan_tci);
406 ds_put_char(ds, ')');
408 case OVS_ACTION_ATTR_POP_VLAN:
409 ds_put_cstr(ds, "pop_vlan");
411 case OVS_ACTION_ATTR_PUSH_MPLS: {
412 const struct ovs_action_push_mpls *mpls = nl_attr_get(a);
413 ds_put_cstr(ds, "push_mpls(");
414 format_mpls_lse(ds, mpls->mpls_lse);
415 ds_put_format(ds, ",eth_type=0x%"PRIx16")", ntohs(mpls->mpls_ethertype));
418 case OVS_ACTION_ATTR_POP_MPLS: {
419 ovs_be16 ethertype = nl_attr_get_be16(a);
420 ds_put_format(ds, "pop_mpls(eth_type=0x%"PRIx16")", ntohs(ethertype));
423 case OVS_ACTION_ATTR_SAMPLE:
424 format_odp_sample_action(ds, a);
426 case OVS_ACTION_ATTR_UNSPEC:
427 case __OVS_ACTION_ATTR_MAX:
429 format_generic_odp_action(ds, a);
435 format_odp_actions(struct ds *ds, const struct nlattr *actions,
439 const struct nlattr *a;
442 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
444 ds_put_char(ds, ',');
446 format_odp_action(ds, a);
451 if (left == actions_len) {
452 ds_put_cstr(ds, "<empty>");
454 ds_put_format(ds, ",***%u leftover bytes*** (", left);
455 for (i = 0; i < left; i++) {
456 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
458 ds_put_char(ds, ')');
461 ds_put_cstr(ds, "drop");
466 parse_odp_action(const char *s, const struct simap *port_names,
467 struct ofpbuf *actions)
473 if (ovs_scan(s, "%"SCNi32"%n", &port, &n)) {
474 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
480 int len = strcspn(s, delimiters);
481 struct simap_node *node;
483 node = simap_find_len(port_names, s, len);
485 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, node->data);
493 uint32_t probability;
494 uint32_t collector_set_id;
495 uint32_t obs_domain_id;
496 uint32_t obs_point_id;
500 if (ovs_scan(s, "userspace(pid=%"SCNi32")%n", &pid, &n)) {
501 odp_put_userspace_action(pid, NULL, 0, actions);
503 } else if (ovs_scan(s, "userspace(pid=%"SCNi32",sFlow(vid=%i,"
504 "pcp=%i,output=%"SCNi32"))%n",
505 &pid, &vid, &pcp, &output, &n)) {
506 union user_action_cookie cookie;
509 tci = vid | (pcp << VLAN_PCP_SHIFT);
514 cookie.type = USER_ACTION_COOKIE_SFLOW;
515 cookie.sflow.vlan_tci = htons(tci);
516 cookie.sflow.output = output;
517 odp_put_userspace_action(pid, &cookie, sizeof cookie.sflow,
520 } else if (ovs_scan(s, "userspace(pid=%"SCNi32",slow_path%n",
522 union user_action_cookie cookie;
525 cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
526 cookie.slow_path.unused = 0;
527 cookie.slow_path.reason = 0;
529 res = parse_flags(&s[n], slow_path_reason_to_string,
530 &cookie.slow_path.reason);
540 odp_put_userspace_action(pid, &cookie, sizeof cookie.slow_path,
543 } else if (ovs_scan(s, "userspace(pid=%"SCNi32","
544 "flow_sample(probability=%"SCNi32","
545 "collector_set_id=%"SCNi32","
546 "obs_domain_id=%"SCNi32","
547 "obs_point_id=%"SCNi32"))%n",
548 &pid, &probability, &collector_set_id,
549 &obs_domain_id, &obs_point_id, &n)) {
550 union user_action_cookie cookie;
552 cookie.type = USER_ACTION_COOKIE_FLOW_SAMPLE;
553 cookie.flow_sample.probability = probability;
554 cookie.flow_sample.collector_set_id = collector_set_id;
555 cookie.flow_sample.obs_domain_id = obs_domain_id;
556 cookie.flow_sample.obs_point_id = obs_point_id;
557 odp_put_userspace_action(pid, &cookie, sizeof cookie.flow_sample,
560 } else if (ovs_scan(s, "userspace(pid=%"SCNi32",ipfix)%n", &pid, &n)) {
561 union user_action_cookie cookie;
563 cookie.type = USER_ACTION_COOKIE_IPFIX;
564 odp_put_userspace_action(pid, &cookie, sizeof cookie.ipfix,
567 } else if (ovs_scan(s, "userspace(pid=%"SCNi32",userdata(%n",
572 ofpbuf_init(&buf, 16);
573 end = ofpbuf_put_hex(&buf, &s[n], NULL);
574 if (end[0] == ')' && end[1] == ')') {
575 odp_put_userspace_action(pid, buf.data, buf.size, actions);
577 return (end + 2) - s;
582 if (!strncmp(s, "set(", 4)) {
586 start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
587 retval = parse_odp_key_mask_attr(s + 4, port_names, actions, NULL);
591 if (s[retval + 4] != ')') {
594 nl_msg_end_nested(actions, start_ofs);
599 struct ovs_action_push_vlan push;
600 int tpid = ETH_TYPE_VLAN;
605 if (ovs_scan(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n)
606 || ovs_scan(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
607 &vid, &pcp, &cfi, &n)
608 || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
609 &tpid, &vid, &pcp, &n)
610 || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
611 &tpid, &vid, &pcp, &cfi, &n)) {
612 push.vlan_tpid = htons(tpid);
613 push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
614 | (pcp << VLAN_PCP_SHIFT)
615 | (cfi ? VLAN_CFI : 0));
616 nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
623 if (!strncmp(s, "pop_vlan", 8)) {
624 nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
632 if (ovs_scan(s, "sample(sample=%lf%%,actions(%n", &percentage, &n)
633 && percentage >= 0. && percentage <= 100.0) {
634 size_t sample_ofs, actions_ofs;
637 probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
638 sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
639 nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
640 (probability <= 0 ? 0
641 : probability >= UINT32_MAX ? UINT32_MAX
644 actions_ofs = nl_msg_start_nested(actions,
645 OVS_SAMPLE_ATTR_ACTIONS);
649 n += strspn(s + n, delimiters);
654 retval = parse_odp_action(s + n, port_names, actions);
660 nl_msg_end_nested(actions, actions_ofs);
661 nl_msg_end_nested(actions, sample_ofs);
663 return s[n + 1] == ')' ? n + 2 : -EINVAL;
670 /* Parses the string representation of datapath actions, in the format output
671 * by format_odp_action(). Returns 0 if successful, otherwise a positive errno
672 * value. On success, the ODP actions are appended to 'actions' as a series of
673 * Netlink attributes. On failure, no data is appended to 'actions'. Either
674 * way, 'actions''s data might be reallocated. */
676 odp_actions_from_string(const char *s, const struct simap *port_names,
677 struct ofpbuf *actions)
681 if (!strcasecmp(s, "drop")) {
685 old_size = actions->size;
689 s += strspn(s, delimiters);
694 retval = parse_odp_action(s, port_names, actions);
695 if (retval < 0 || !strchr(delimiters, s[retval])) {
696 actions->size = old_size;
705 /* Returns the correct length of the payload for a flow key attribute of the
706 * specified 'type', -1 if 'type' is unknown, or -2 if the attribute's payload
707 * is variable length. */
709 odp_flow_key_attr_len(uint16_t type)
711 if (type > OVS_KEY_ATTR_MAX) {
715 switch ((enum ovs_key_attr) type) {
716 case OVS_KEY_ATTR_ENCAP: return -2;
717 case OVS_KEY_ATTR_PRIORITY: return 4;
718 case OVS_KEY_ATTR_SKB_MARK: return 4;
719 case OVS_KEY_ATTR_TUNNEL: return -2;
720 case OVS_KEY_ATTR_IN_PORT: return 4;
721 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
722 case OVS_KEY_ATTR_VLAN: return sizeof(ovs_be16);
723 case OVS_KEY_ATTR_ETHERTYPE: return 2;
724 case OVS_KEY_ATTR_MPLS: return sizeof(struct ovs_key_mpls);
725 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
726 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
727 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
728 case OVS_KEY_ATTR_TCP_FLAGS: return 2;
729 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
730 case OVS_KEY_ATTR_SCTP: return sizeof(struct ovs_key_sctp);
731 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
732 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
733 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
734 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
736 case OVS_KEY_ATTR_UNSPEC:
737 case __OVS_KEY_ATTR_MAX:
745 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
747 size_t len = nl_attr_get_size(a);
749 const uint8_t *unspec;
752 unspec = nl_attr_get(a);
753 for (i = 0; i < len; i++) {
755 ds_put_char(ds, ' ');
757 ds_put_format(ds, "%02x", unspec[i]);
763 ovs_frag_type_to_string(enum ovs_frag_type type)
766 case OVS_FRAG_TYPE_NONE:
768 case OVS_FRAG_TYPE_FIRST:
770 case OVS_FRAG_TYPE_LATER:
772 case __OVS_FRAG_TYPE_MAX:
779 tunnel_key_attr_len(int type)
782 case OVS_TUNNEL_KEY_ATTR_ID: return 8;
783 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC: return 4;
784 case OVS_TUNNEL_KEY_ATTR_IPV4_DST: return 4;
785 case OVS_TUNNEL_KEY_ATTR_TOS: return 1;
786 case OVS_TUNNEL_KEY_ATTR_TTL: return 1;
787 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT: return 0;
788 case OVS_TUNNEL_KEY_ATTR_CSUM: return 0;
789 case __OVS_TUNNEL_KEY_ATTR_MAX:
796 odp_tun_key_from_attr(const struct nlattr *attr, struct flow_tnl *tun)
799 const struct nlattr *a;
801 bool unknown = false;
803 NL_NESTED_FOR_EACH(a, left, attr) {
804 uint16_t type = nl_attr_type(a);
805 size_t len = nl_attr_get_size(a);
806 int expected_len = tunnel_key_attr_len(type);
808 if (len != expected_len && expected_len >= 0) {
809 return ODP_FIT_ERROR;
813 case OVS_TUNNEL_KEY_ATTR_ID:
814 tun->tun_id = nl_attr_get_be64(a);
815 tun->flags |= FLOW_TNL_F_KEY;
817 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
818 tun->ip_src = nl_attr_get_be32(a);
820 case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
821 tun->ip_dst = nl_attr_get_be32(a);
823 case OVS_TUNNEL_KEY_ATTR_TOS:
824 tun->ip_tos = nl_attr_get_u8(a);
826 case OVS_TUNNEL_KEY_ATTR_TTL:
827 tun->ip_ttl = nl_attr_get_u8(a);
830 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
831 tun->flags |= FLOW_TNL_F_DONT_FRAGMENT;
833 case OVS_TUNNEL_KEY_ATTR_CSUM:
834 tun->flags |= FLOW_TNL_F_CSUM;
837 /* Allow this to show up as unexpected, if there are unknown
838 * tunnel attribute, eventually resulting in ODP_FIT_TOO_MUCH. */
845 return ODP_FIT_ERROR;
848 return ODP_FIT_TOO_MUCH;
850 return ODP_FIT_PERFECT;
854 tun_key_to_attr(struct ofpbuf *a, const struct flow_tnl *tun_key)
858 tun_key_ofs = nl_msg_start_nested(a, OVS_KEY_ATTR_TUNNEL);
860 if (tun_key->flags & FLOW_TNL_F_KEY) {
861 nl_msg_put_be64(a, OVS_TUNNEL_KEY_ATTR_ID, tun_key->tun_id);
863 if (tun_key->ip_src) {
864 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_SRC, tun_key->ip_src);
866 if (tun_key->ip_dst) {
867 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_DST, tun_key->ip_dst);
869 if (tun_key->ip_tos) {
870 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TOS, tun_key->ip_tos);
872 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TTL, tun_key->ip_ttl);
873 if (tun_key->flags & FLOW_TNL_F_DONT_FRAGMENT) {
874 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
876 if (tun_key->flags & FLOW_TNL_F_CSUM) {
877 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
880 nl_msg_end_nested(a, tun_key_ofs);
884 odp_mask_attr_is_wildcard(const struct nlattr *ma)
886 return is_all_zeros(nl_attr_get(ma), nl_attr_get_size(ma));
890 odp_mask_attr_is_exact(const struct nlattr *ma)
892 bool is_exact = false;
893 enum ovs_key_attr attr = nl_attr_type(ma);
895 if (attr == OVS_KEY_ATTR_TUNNEL) {
896 /* XXX this is a hack for now. Should change
897 * the exact match dection to per field
898 * instead of per attribute.
900 struct flow_tnl tun_mask;
901 memset(&tun_mask, 0, sizeof tun_mask);
902 odp_tun_key_from_attr(ma, &tun_mask);
903 if (tun_mask.flags == (FLOW_TNL_F_KEY
904 | FLOW_TNL_F_DONT_FRAGMENT
905 | FLOW_TNL_F_CSUM)) {
906 /* The flags are exact match, check the remaining fields. */
907 tun_mask.flags = 0xffff;
908 is_exact = is_all_ones((uint8_t *)&tun_mask,
909 offsetof(struct flow_tnl, ip_ttl));
912 is_exact = is_all_ones(nl_attr_get(ma), nl_attr_get_size(ma));
919 odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
922 struct odp_portno_names *odp_portno_names;
924 odp_portno_names = xmalloc(sizeof *odp_portno_names);
925 odp_portno_names->port_no = port_no;
926 odp_portno_names->name = xstrdup(port_name);
927 hmap_insert(portno_names, &odp_portno_names->hmap_node,
928 hash_odp_port(port_no));
932 odp_portno_names_get(const struct hmap *portno_names, odp_port_t port_no)
934 struct odp_portno_names *odp_portno_names;
936 HMAP_FOR_EACH_IN_BUCKET (odp_portno_names, hmap_node,
937 hash_odp_port(port_no), portno_names) {
938 if (odp_portno_names->port_no == port_no) {
939 return odp_portno_names->name;
946 odp_portno_names_destroy(struct hmap *portno_names)
948 struct odp_portno_names *odp_portno_names, *odp_portno_names_next;
949 HMAP_FOR_EACH_SAFE (odp_portno_names, odp_portno_names_next,
950 hmap_node, portno_names) {
951 hmap_remove(portno_names, &odp_portno_names->hmap_node);
952 free(odp_portno_names->name);
953 free(odp_portno_names);
958 format_odp_key_attr(const struct nlattr *a, const struct nlattr *ma,
959 const struct hmap *portno_names, struct ds *ds,
962 struct flow_tnl tun_key;
963 enum ovs_key_attr attr = nl_attr_type(a);
964 char namebuf[OVS_KEY_ATTR_BUFSIZE];
968 is_exact = ma ? odp_mask_attr_is_exact(ma) : true;
970 ds_put_cstr(ds, ovs_key_attr_to_string(attr, namebuf, sizeof namebuf));
973 expected_len = odp_flow_key_attr_len(nl_attr_type(a));
974 if (expected_len != -2) {
975 bool bad_key_len = nl_attr_get_size(a) != expected_len;
976 bool bad_mask_len = ma && nl_attr_get_size(a) != expected_len;
978 if (bad_key_len || bad_mask_len) {
980 ds_put_format(ds, "(bad key length %zu, expected %d)(",
982 odp_flow_key_attr_len(nl_attr_type(a)));
984 format_generic_odp_key(a, ds);
986 ds_put_char(ds, '/');
987 ds_put_format(ds, "(bad mask length %zu, expected %d)(",
988 nl_attr_get_size(ma),
989 odp_flow_key_attr_len(nl_attr_type(ma)));
991 format_generic_odp_key(ma, ds);
992 ds_put_char(ds, ')');
998 ds_put_char(ds, '(');
1000 case OVS_KEY_ATTR_ENCAP:
1001 if (ma && nl_attr_get_size(ma) && nl_attr_get_size(a)) {
1002 odp_flow_format(nl_attr_get(a), nl_attr_get_size(a),
1003 nl_attr_get(ma), nl_attr_get_size(ma), NULL, ds,
1005 } else if (nl_attr_get_size(a)) {
1006 odp_flow_format(nl_attr_get(a), nl_attr_get_size(a), NULL, 0, NULL,
1011 case OVS_KEY_ATTR_PRIORITY:
1012 case OVS_KEY_ATTR_SKB_MARK:
1013 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
1015 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
1019 case OVS_KEY_ATTR_TUNNEL:
1020 memset(&tun_key, 0, sizeof tun_key);
1021 if (odp_tun_key_from_attr(a, &tun_key) == ODP_FIT_ERROR) {
1022 ds_put_format(ds, "error");
1023 } else if (!is_exact) {
1024 struct flow_tnl tun_mask;
1026 memset(&tun_mask, 0, sizeof tun_mask);
1027 odp_tun_key_from_attr(ma, &tun_mask);
1028 ds_put_format(ds, "tun_id=%#"PRIx64"/%#"PRIx64
1029 ",src="IP_FMT"/"IP_FMT",dst="IP_FMT"/"IP_FMT
1030 ",tos=%#"PRIx8"/%#"PRIx8",ttl=%"PRIu8"/%#"PRIx8
1032 ntohll(tun_key.tun_id), ntohll(tun_mask.tun_id),
1033 IP_ARGS(tun_key.ip_src), IP_ARGS(tun_mask.ip_src),
1034 IP_ARGS(tun_key.ip_dst), IP_ARGS(tun_mask.ip_dst),
1035 tun_key.ip_tos, tun_mask.ip_tos,
1036 tun_key.ip_ttl, tun_mask.ip_ttl);
1038 format_flags(ds, flow_tun_flag_to_string, tun_key.flags, ',');
1040 /* XXX This code is correct, but enabling it would break the unit
1041 test. Disable it for now until the input parser is fixed.
1043 ds_put_char(ds, '/');
1044 format_flags(ds, flow_tun_flag_to_string, tun_mask.flags, ',');
1046 ds_put_char(ds, ')');
1048 ds_put_format(ds, "tun_id=0x%"PRIx64",src="IP_FMT",dst="IP_FMT","
1049 "tos=0x%"PRIx8",ttl=%"PRIu8",flags(",
1050 ntohll(tun_key.tun_id),
1051 IP_ARGS(tun_key.ip_src),
1052 IP_ARGS(tun_key.ip_dst),
1053 tun_key.ip_tos, tun_key.ip_ttl);
1055 format_flags(ds, flow_tun_flag_to_string, tun_key.flags, ',');
1056 ds_put_char(ds, ')');
1060 case OVS_KEY_ATTR_IN_PORT:
1061 if (portno_names && verbose && is_exact) {
1062 char *name = odp_portno_names_get(portno_names,
1063 u32_to_odp(nl_attr_get_u32(a)));
1065 ds_put_format(ds, "%s", name);
1067 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
1070 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
1072 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
1077 case OVS_KEY_ATTR_ETHERNET:
1079 const struct ovs_key_ethernet *eth_mask = nl_attr_get(ma);
1080 const struct ovs_key_ethernet *eth_key = nl_attr_get(a);
1082 ds_put_format(ds, "src="ETH_ADDR_FMT"/"ETH_ADDR_FMT
1083 ",dst="ETH_ADDR_FMT"/"ETH_ADDR_FMT,
1084 ETH_ADDR_ARGS(eth_key->eth_src),
1085 ETH_ADDR_ARGS(eth_mask->eth_src),
1086 ETH_ADDR_ARGS(eth_key->eth_dst),
1087 ETH_ADDR_ARGS(eth_mask->eth_dst));
1089 const struct ovs_key_ethernet *eth_key = nl_attr_get(a);
1091 ds_put_format(ds, "src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT,
1092 ETH_ADDR_ARGS(eth_key->eth_src),
1093 ETH_ADDR_ARGS(eth_key->eth_dst));
1097 case OVS_KEY_ATTR_VLAN:
1099 ovs_be16 vlan_tci = nl_attr_get_be16(a);
1101 ovs_be16 mask = nl_attr_get_be16(ma);
1102 ds_put_format(ds, "vid=%"PRIu16"/0x%"PRIx16",pcp=%d/0x%x,cfi=%d/%d",
1103 vlan_tci_to_vid(vlan_tci),
1104 vlan_tci_to_vid(mask),
1105 vlan_tci_to_pcp(vlan_tci),
1106 vlan_tci_to_pcp(mask),
1107 vlan_tci_to_cfi(vlan_tci),
1108 vlan_tci_to_cfi(mask));
1110 format_vlan_tci(ds, vlan_tci);
1115 case OVS_KEY_ATTR_MPLS: {
1116 const struct ovs_key_mpls *mpls_key = nl_attr_get(a);
1117 const struct ovs_key_mpls *mpls_mask = NULL;
1119 mpls_mask = nl_attr_get(ma);
1121 format_mpls(ds, mpls_key, mpls_mask);
1125 case OVS_KEY_ATTR_ETHERTYPE:
1126 ds_put_format(ds, "0x%04"PRIx16, ntohs(nl_attr_get_be16(a)));
1128 ds_put_format(ds, "/0x%04"PRIx16, ntohs(nl_attr_get_be16(ma)));
1132 case OVS_KEY_ATTR_IPV4:
1134 const struct ovs_key_ipv4 *ipv4_key = nl_attr_get(a);
1135 const struct ovs_key_ipv4 *ipv4_mask = nl_attr_get(ma);
1137 ds_put_format(ds, "src="IP_FMT"/"IP_FMT",dst="IP_FMT"/"IP_FMT
1138 ",proto=%"PRIu8"/%#"PRIx8",tos=%#"PRIx8"/%#"PRIx8
1139 ",ttl=%"PRIu8"/%#"PRIx8",frag=%s/%#"PRIx8,
1140 IP_ARGS(ipv4_key->ipv4_src),
1141 IP_ARGS(ipv4_mask->ipv4_src),
1142 IP_ARGS(ipv4_key->ipv4_dst),
1143 IP_ARGS(ipv4_mask->ipv4_dst),
1144 ipv4_key->ipv4_proto, ipv4_mask->ipv4_proto,
1145 ipv4_key->ipv4_tos, ipv4_mask->ipv4_tos,
1146 ipv4_key->ipv4_ttl, ipv4_mask->ipv4_ttl,
1147 ovs_frag_type_to_string(ipv4_key->ipv4_frag),
1148 ipv4_mask->ipv4_frag);
1150 const struct ovs_key_ipv4 *ipv4_key = nl_attr_get(a);
1152 ds_put_format(ds, "src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
1153 ",tos=%#"PRIx8",ttl=%"PRIu8",frag=%s",
1154 IP_ARGS(ipv4_key->ipv4_src),
1155 IP_ARGS(ipv4_key->ipv4_dst),
1156 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
1158 ovs_frag_type_to_string(ipv4_key->ipv4_frag));
1162 case OVS_KEY_ATTR_IPV6:
1164 const struct ovs_key_ipv6 *ipv6_key, *ipv6_mask;
1165 char src_str[INET6_ADDRSTRLEN];
1166 char dst_str[INET6_ADDRSTRLEN];
1167 char src_mask[INET6_ADDRSTRLEN];
1168 char dst_mask[INET6_ADDRSTRLEN];
1170 ipv6_key = nl_attr_get(a);
1171 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
1172 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
1174 ipv6_mask = nl_attr_get(ma);
1175 inet_ntop(AF_INET6, ipv6_mask->ipv6_src, src_mask, sizeof src_mask);
1176 inet_ntop(AF_INET6, ipv6_mask->ipv6_dst, dst_mask, sizeof dst_mask);
1178 ds_put_format(ds, "src=%s/%s,dst=%s/%s,label=%#"PRIx32"/%#"PRIx32
1179 ",proto=%"PRIu8"/%#"PRIx8",tclass=%#"PRIx8"/%#"PRIx8
1180 ",hlimit=%"PRIu8"/%#"PRIx8",frag=%s/%#"PRIx8,
1181 src_str, src_mask, dst_str, dst_mask,
1182 ntohl(ipv6_key->ipv6_label),
1183 ntohl(ipv6_mask->ipv6_label),
1184 ipv6_key->ipv6_proto, ipv6_mask->ipv6_proto,
1185 ipv6_key->ipv6_tclass, ipv6_mask->ipv6_tclass,
1186 ipv6_key->ipv6_hlimit, ipv6_mask->ipv6_hlimit,
1187 ovs_frag_type_to_string(ipv6_key->ipv6_frag),
1188 ipv6_mask->ipv6_frag);
1190 const struct ovs_key_ipv6 *ipv6_key;
1191 char src_str[INET6_ADDRSTRLEN];
1192 char dst_str[INET6_ADDRSTRLEN];
1194 ipv6_key = nl_attr_get(a);
1195 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
1196 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
1198 ds_put_format(ds, "src=%s,dst=%s,label=%#"PRIx32",proto=%"PRIu8
1199 ",tclass=%#"PRIx8",hlimit=%"PRIu8",frag=%s",
1200 src_str, dst_str, ntohl(ipv6_key->ipv6_label),
1201 ipv6_key->ipv6_proto, ipv6_key->ipv6_tclass,
1202 ipv6_key->ipv6_hlimit,
1203 ovs_frag_type_to_string(ipv6_key->ipv6_frag));
1207 case OVS_KEY_ATTR_TCP:
1209 const struct ovs_key_tcp *tcp_mask = nl_attr_get(ma);
1210 const struct ovs_key_tcp *tcp_key = nl_attr_get(a);
1212 ds_put_format(ds, "src=%"PRIu16"/%#"PRIx16
1213 ",dst=%"PRIu16"/%#"PRIx16,
1214 ntohs(tcp_key->tcp_src), ntohs(tcp_mask->tcp_src),
1215 ntohs(tcp_key->tcp_dst), ntohs(tcp_mask->tcp_dst));
1217 const struct ovs_key_tcp *tcp_key = nl_attr_get(a);
1219 ds_put_format(ds, "src=%"PRIu16",dst=%"PRIu16,
1220 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
1224 case OVS_KEY_ATTR_TCP_FLAGS:
1225 ds_put_format(ds, "0x%03"PRIx16, ntohs(nl_attr_get_be16(a)));
1227 ds_put_format(ds, "/0x%03"PRIx16, ntohs(nl_attr_get_be16(ma)));
1231 case OVS_KEY_ATTR_UDP:
1233 const struct ovs_key_udp *udp_mask = nl_attr_get(ma);
1234 const struct ovs_key_udp *udp_key = nl_attr_get(a);
1236 ds_put_format(ds, "src=%"PRIu16"/%#"PRIx16
1237 ",dst=%"PRIu16"/%#"PRIx16,
1238 ntohs(udp_key->udp_src), ntohs(udp_mask->udp_src),
1239 ntohs(udp_key->udp_dst), ntohs(udp_mask->udp_dst));
1241 const struct ovs_key_udp *udp_key = nl_attr_get(a);
1243 ds_put_format(ds, "src=%"PRIu16",dst=%"PRIu16,
1244 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
1248 case OVS_KEY_ATTR_SCTP:
1250 const struct ovs_key_sctp *sctp_mask = nl_attr_get(ma);
1251 const struct ovs_key_sctp *sctp_key = nl_attr_get(a);
1253 ds_put_format(ds, "src=%"PRIu16"/%#"PRIx16
1254 ",dst=%"PRIu16"/%#"PRIx16,
1255 ntohs(sctp_key->sctp_src), ntohs(sctp_mask->sctp_src),
1256 ntohs(sctp_key->sctp_dst), ntohs(sctp_mask->sctp_dst));
1258 const struct ovs_key_sctp *sctp_key = nl_attr_get(a);
1260 ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
1261 ntohs(sctp_key->sctp_src), ntohs(sctp_key->sctp_dst));
1265 case OVS_KEY_ATTR_ICMP:
1267 const struct ovs_key_icmp *icmp_mask = nl_attr_get(ma);
1268 const struct ovs_key_icmp *icmp_key = nl_attr_get(a);
1270 ds_put_format(ds, "type=%"PRIu8"/%#"PRIx8",code=%"PRIu8"/%#"PRIx8,
1271 icmp_key->icmp_type, icmp_mask->icmp_type,
1272 icmp_key->icmp_code, icmp_mask->icmp_code);
1274 const struct ovs_key_icmp *icmp_key = nl_attr_get(a);
1276 ds_put_format(ds, "type=%"PRIu8",code=%"PRIu8,
1277 icmp_key->icmp_type, icmp_key->icmp_code);
1281 case OVS_KEY_ATTR_ICMPV6:
1283 const struct ovs_key_icmpv6 *icmpv6_mask = nl_attr_get(ma);
1284 const struct ovs_key_icmpv6 *icmpv6_key = nl_attr_get(a);
1286 ds_put_format(ds, "type=%"PRIu8"/%#"PRIx8",code=%"PRIu8"/%#"PRIx8,
1287 icmpv6_key->icmpv6_type, icmpv6_mask->icmpv6_type,
1288 icmpv6_key->icmpv6_code, icmpv6_mask->icmpv6_code);
1290 const struct ovs_key_icmpv6 *icmpv6_key = nl_attr_get(a);
1292 ds_put_format(ds, "type=%"PRIu8",code=%"PRIu8,
1293 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
1297 case OVS_KEY_ATTR_ARP:
1299 const struct ovs_key_arp *arp_mask = nl_attr_get(ma);
1300 const struct ovs_key_arp *arp_key = nl_attr_get(a);
1302 ds_put_format(ds, "sip="IP_FMT"/"IP_FMT",tip="IP_FMT"/"IP_FMT
1303 ",op=%"PRIu16"/%#"PRIx16
1304 ",sha="ETH_ADDR_FMT"/"ETH_ADDR_FMT
1305 ",tha="ETH_ADDR_FMT"/"ETH_ADDR_FMT,
1306 IP_ARGS(arp_key->arp_sip),
1307 IP_ARGS(arp_mask->arp_sip),
1308 IP_ARGS(arp_key->arp_tip),
1309 IP_ARGS(arp_mask->arp_tip),
1310 ntohs(arp_key->arp_op), ntohs(arp_mask->arp_op),
1311 ETH_ADDR_ARGS(arp_key->arp_sha),
1312 ETH_ADDR_ARGS(arp_mask->arp_sha),
1313 ETH_ADDR_ARGS(arp_key->arp_tha),
1314 ETH_ADDR_ARGS(arp_mask->arp_tha));
1316 const struct ovs_key_arp *arp_key = nl_attr_get(a);
1318 ds_put_format(ds, "sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
1319 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT,
1320 IP_ARGS(arp_key->arp_sip), IP_ARGS(arp_key->arp_tip),
1321 ntohs(arp_key->arp_op),
1322 ETH_ADDR_ARGS(arp_key->arp_sha),
1323 ETH_ADDR_ARGS(arp_key->arp_tha));
1327 case OVS_KEY_ATTR_ND: {
1328 const struct ovs_key_nd *nd_key, *nd_mask = NULL;
1329 char target[INET6_ADDRSTRLEN];
1331 nd_key = nl_attr_get(a);
1333 nd_mask = nl_attr_get(ma);
1336 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
1337 ds_put_format(ds, "target=%s", target);
1339 inet_ntop(AF_INET6, nd_mask->nd_target, target, sizeof target);
1340 ds_put_format(ds, "/%s", target);
1343 if (!eth_addr_is_zero(nd_key->nd_sll)) {
1344 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
1345 ETH_ADDR_ARGS(nd_key->nd_sll));
1347 ds_put_format(ds, "/"ETH_ADDR_FMT,
1348 ETH_ADDR_ARGS(nd_mask->nd_sll));
1351 if (!eth_addr_is_zero(nd_key->nd_tll)) {
1352 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
1353 ETH_ADDR_ARGS(nd_key->nd_tll));
1355 ds_put_format(ds, "/"ETH_ADDR_FMT,
1356 ETH_ADDR_ARGS(nd_mask->nd_tll));
1362 case OVS_KEY_ATTR_UNSPEC:
1363 case __OVS_KEY_ATTR_MAX:
1365 format_generic_odp_key(a, ds);
1367 ds_put_char(ds, '/');
1368 format_generic_odp_key(ma, ds);
1372 ds_put_char(ds, ')');
1375 static struct nlattr *
1376 generate_all_wildcard_mask(struct ofpbuf *ofp, const struct nlattr *key)
1378 const struct nlattr *a;
1380 int type = nl_attr_type(key);
1381 int size = nl_attr_get_size(key);
1383 if (odp_flow_key_attr_len(type) >=0) {
1384 nl_msg_put_unspec_zero(ofp, type, size);
1388 nested_mask = nl_msg_start_nested(ofp, type);
1389 NL_ATTR_FOR_EACH(a, left, key, nl_attr_get_size(key)) {
1390 generate_all_wildcard_mask(ofp, nl_attr_get(a));
1392 nl_msg_end_nested(ofp, nested_mask);
1398 /* Appends to 'ds' a string representation of the 'key_len' bytes of
1399 * OVS_KEY_ATTR_* attributes in 'key'. If non-null, additionally formats the
1400 * 'mask_len' bytes of 'mask' which apply to 'key'. If 'portno_names' is
1401 * non-null and 'verbose' is true, translates odp port number to its name. */
1403 odp_flow_format(const struct nlattr *key, size_t key_len,
1404 const struct nlattr *mask, size_t mask_len,
1405 const struct hmap *portno_names, struct ds *ds, bool verbose)
1408 const struct nlattr *a;
1410 bool has_ethtype_key = false;
1411 const struct nlattr *ma = NULL;
1413 bool first_field = true;
1415 ofpbuf_init(&ofp, 100);
1416 NL_ATTR_FOR_EACH (a, left, key, key_len) {
1417 bool is_nested_attr;
1418 bool is_wildcard = false;
1419 int attr_type = nl_attr_type(a);
1421 if (attr_type == OVS_KEY_ATTR_ETHERTYPE) {
1422 has_ethtype_key = true;
1425 is_nested_attr = (odp_flow_key_attr_len(attr_type) == -2);
1427 if (mask && mask_len) {
1428 ma = nl_attr_find__(mask, mask_len, nl_attr_type(a));
1429 is_wildcard = ma ? odp_mask_attr_is_wildcard(ma) : true;
1432 if (verbose || !is_wildcard || is_nested_attr) {
1433 if (is_wildcard && !ma) {
1434 ma = generate_all_wildcard_mask(&ofp, a);
1437 ds_put_char(ds, ',');
1439 format_odp_key_attr(a, ma, portno_names, ds, verbose);
1440 first_field = false;
1444 ofpbuf_uninit(&ofp);
1449 if (left == key_len) {
1450 ds_put_cstr(ds, "<empty>");
1452 ds_put_format(ds, ",***%u leftover bytes*** (", left);
1453 for (i = 0; i < left; i++) {
1454 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
1456 ds_put_char(ds, ')');
1458 if (!has_ethtype_key) {
1459 ma = nl_attr_find__(mask, mask_len, OVS_KEY_ATTR_ETHERTYPE);
1461 ds_put_format(ds, ",eth_type(0/0x%04"PRIx16")",
1462 ntohs(nl_attr_get_be16(ma)));
1466 ds_put_cstr(ds, "<empty>");
1470 /* Appends to 'ds' a string representation of the 'key_len' bytes of
1471 * OVS_KEY_ATTR_* attributes in 'key'. */
1473 odp_flow_key_format(const struct nlattr *key,
1474 size_t key_len, struct ds *ds)
1476 odp_flow_format(key, key_len, NULL, 0, NULL, ds, true);
1480 put_nd(struct ovs_key_nd* nd_key, const uint8_t *nd_sll,
1481 const uint8_t *nd_tll, struct ofpbuf *key)
1484 memcpy(nd_key->nd_sll, nd_sll, ETH_ADDR_LEN);
1488 memcpy(nd_key->nd_tll, nd_tll, ETH_ADDR_LEN);
1491 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, nd_key, sizeof *nd_key);
1495 put_nd_key(int n, const char *nd_target_s, const uint8_t *nd_sll,
1496 const uint8_t *nd_tll, struct ofpbuf *key)
1498 struct ovs_key_nd nd_key;
1500 memset(&nd_key, 0, sizeof nd_key);
1502 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
1506 put_nd(&nd_key, nd_sll, nd_tll, key);
1511 put_nd_mask(int n, const char *nd_target_s,
1512 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *mask)
1514 struct ovs_key_nd nd_mask;
1516 memset(&nd_mask, 0xff, sizeof nd_mask);
1518 if (strlen(nd_target_s) != 0 &&
1519 inet_pton(AF_INET6, nd_target_s, nd_mask.nd_target) != 1) {
1523 put_nd(&nd_mask, nd_sll, nd_tll, mask);
1528 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
1530 if (!strcasecmp(s, "no")) {
1531 *type = OVS_FRAG_TYPE_NONE;
1532 } else if (!strcasecmp(s, "first")) {
1533 *type = OVS_FRAG_TYPE_FIRST;
1534 } else if (!strcasecmp(s, "later")) {
1535 *type = OVS_FRAG_TYPE_LATER;
1543 mpls_lse_from_components(int mpls_label, int mpls_tc, int mpls_ttl, int mpls_bos)
1545 return (htonl((mpls_label << MPLS_LABEL_SHIFT) |
1546 (mpls_tc << MPLS_TC_SHIFT) |
1547 (mpls_ttl << MPLS_TTL_SHIFT) |
1548 (mpls_bos << MPLS_BOS_SHIFT)));
1552 parse_odp_key_mask_attr(const char *s, const struct simap *port_names,
1553 struct ofpbuf *key, struct ofpbuf *mask)
1557 uint32_t priority_mask;
1560 if (mask && ovs_scan(s, "skb_priority(%"SCNi32"/%"SCNi32")%n",
1561 &priority, &priority_mask, &n)) {
1562 nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
1563 nl_msg_put_u32(mask, OVS_KEY_ATTR_PRIORITY, priority_mask);
1565 } else if (ovs_scan(s, "skb_priority(%"SCNi32")%n", &priority, &n)) {
1566 nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
1568 nl_msg_put_u32(mask, OVS_KEY_ATTR_PRIORITY, UINT32_MAX);
1579 if (mask && ovs_scan(s, "skb_mark(%"SCNi32"/%"SCNi32")%n", &mark,
1581 nl_msg_put_u32(key, OVS_KEY_ATTR_SKB_MARK, mark);
1582 nl_msg_put_u32(mask, OVS_KEY_ATTR_SKB_MARK, mark_mask);
1584 } else if (ovs_scan(s, "skb_mark(%"SCNi32")%n", &mark, &n)) {
1585 nl_msg_put_u32(key, OVS_KEY_ATTR_SKB_MARK, mark);
1587 nl_msg_put_u32(mask, OVS_KEY_ATTR_SKB_MARK, UINT32_MAX);
1594 uint64_t tun_id, tun_id_mask;
1595 struct flow_tnl tun_key, tun_key_mask;
1598 if (mask && ovs_scan(s, "tunnel(tun_id=%"SCNi64"/%"SCNi64","
1599 "src="IP_SCAN_FMT"/"IP_SCAN_FMT",dst="IP_SCAN_FMT
1600 "/"IP_SCAN_FMT",tos=%"SCNi8"/%"SCNi8","
1601 "ttl=%"SCNi8"/%"SCNi8",flags%n",
1602 &tun_id, &tun_id_mask,
1603 IP_SCAN_ARGS(&tun_key.ip_src),
1604 IP_SCAN_ARGS(&tun_key_mask.ip_src),
1605 IP_SCAN_ARGS(&tun_key.ip_dst),
1606 IP_SCAN_ARGS(&tun_key_mask.ip_dst),
1607 &tun_key.ip_tos, &tun_key_mask.ip_tos,
1608 &tun_key.ip_ttl, &tun_key_mask.ip_ttl, &n)) {
1612 tun_key.tun_id = htonll(tun_id);
1613 tun_key_mask.tun_id = htonll(tun_id_mask);
1614 res = parse_flags(&s[n], flow_tun_flag_to_string, &flags);
1615 tun_key.flags = flags;
1616 tun_key_mask.flags = UINT16_MAX;
1626 tun_key_to_attr(key, &tun_key);
1628 tun_key_to_attr(mask, &tun_key_mask);
1631 } else if (ovs_scan(s, "tunnel(tun_id=%"SCNi64","
1632 "src="IP_SCAN_FMT",dst="IP_SCAN_FMT
1633 ",tos=%"SCNi8",ttl=%"SCNi8",flags%n", &tun_id,
1634 IP_SCAN_ARGS(&tun_key.ip_src),
1635 IP_SCAN_ARGS(&tun_key.ip_dst),
1636 &tun_key.ip_tos, &tun_key.ip_ttl, &n)) {
1640 tun_key.tun_id = htonll(tun_id);
1641 res = parse_flags(&s[n], flow_tun_flag_to_string, &flags);
1642 tun_key.flags = flags;
1652 tun_key_to_attr(key, &tun_key);
1655 memset(&tun_key, 0xff, sizeof tun_key);
1656 tun_key_to_attr(mask, &tun_key);
1664 uint32_t in_port_mask;
1667 if (mask && ovs_scan(s, "in_port(%"SCNi32"/%"SCNi32")%n",
1668 &in_port, &in_port_mask, &n)) {
1669 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
1670 nl_msg_put_u32(mask, OVS_KEY_ATTR_IN_PORT, in_port_mask);
1672 } else if (ovs_scan(s, "in_port(%"SCNi32")%n", &in_port, &n)) {
1673 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
1675 nl_msg_put_u32(mask, OVS_KEY_ATTR_IN_PORT, UINT32_MAX);
1682 if (port_names && !strncmp(s, "in_port(", 8)) {
1684 const struct simap_node *node;
1688 name_len = strcspn(name, ")");
1689 node = simap_find_len(port_names, name, name_len);
1691 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, node->data);
1694 nl_msg_put_u32(mask, OVS_KEY_ATTR_IN_PORT, UINT32_MAX);
1696 return 8 + name_len + 1;
1701 struct ovs_key_ethernet eth_key;
1702 struct ovs_key_ethernet eth_key_mask;
1705 if (mask && ovs_scan(s,
1706 "eth(src="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT","
1707 "dst="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
1708 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
1709 ETH_ADDR_SCAN_ARGS(eth_key_mask.eth_src),
1710 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst),
1711 ETH_ADDR_SCAN_ARGS(eth_key_mask.eth_dst), &n)) {
1712 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
1713 ð_key, sizeof eth_key);
1714 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ETHERNET,
1715 ð_key_mask, sizeof eth_key_mask);
1717 } else if (ovs_scan(s, "eth(src="ETH_ADDR_SCAN_FMT","
1718 "dst="ETH_ADDR_SCAN_FMT")%n",
1719 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
1720 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n)) {
1721 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
1722 ð_key, sizeof eth_key);
1725 memset(ð_key, 0xff, sizeof eth_key);
1726 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ETHERNET,
1727 ð_key, sizeof eth_key);
1739 if (mask && ovs_scan(s, "vlan(vid=%i/%i,pcp=%i/%i)%n",
1740 &vid, &vid_mask, &pcp, &pcp_mask, &n)) {
1741 nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1742 htons((vid << VLAN_VID_SHIFT) |
1743 (pcp << VLAN_PCP_SHIFT) |
1745 nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN,
1746 htons((vid_mask << VLAN_VID_SHIFT) |
1747 (pcp_mask << VLAN_PCP_SHIFT) |
1748 (1 << VLAN_CFI_SHIFT)));
1750 } else if (ovs_scan(s, "vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n)) {
1751 nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1752 htons((vid << VLAN_VID_SHIFT) |
1753 (pcp << VLAN_PCP_SHIFT) |
1756 nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN, OVS_BE16_MAX);
1760 && ovs_scan(s, "vlan(vid=%i/%i,pcp=%i/%i,cfi=%i/%i)%n",
1761 &vid, &vid_mask, &pcp, &pcp_mask,
1762 &cfi, &cfi_mask, &n)) {
1763 nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1764 htons((vid << VLAN_VID_SHIFT) |
1765 (pcp << VLAN_PCP_SHIFT) |
1766 (cfi ? VLAN_CFI : 0)));
1767 nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN,
1768 htons((vid_mask << VLAN_VID_SHIFT) |
1769 (pcp_mask << VLAN_PCP_SHIFT) |
1770 (cfi_mask << VLAN_CFI_SHIFT)));
1772 } else if (ovs_scan(s, "vlan(vid=%i,pcp=%i,cfi=%i)%n",
1773 &vid, &pcp, &cfi, &n)) {
1774 nl_msg_put_be16(key, OVS_KEY_ATTR_VLAN,
1775 htons((vid << VLAN_VID_SHIFT) |
1776 (pcp << VLAN_PCP_SHIFT) |
1777 (cfi ? VLAN_CFI : 0)));
1779 nl_msg_put_be16(mask, OVS_KEY_ATTR_VLAN, OVS_BE16_MAX);
1790 if (mask && ovs_scan(s, "eth_type(%i/%i)%n",
1791 ð_type, ð_type_mask, &n)) {
1792 if (eth_type != 0) {
1793 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
1795 nl_msg_put_be16(mask, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type_mask));
1797 } else if (ovs_scan(s, "eth_type(%i)%n", ð_type, &n)) {
1798 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
1800 nl_msg_put_be16(mask, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
1807 int label, tc, ttl, bos;
1808 int label_mask, tc_mask, ttl_mask, bos_mask;
1811 if (mask && ovs_scan(s, "mpls(label=%i/%i,tc=%i/%i,"
1812 "ttl=%i/%i,bos=%i/%i)%n",
1813 &label, &label_mask, &tc, &tc_mask,
1814 &ttl, &ttl_mask, &bos, &bos_mask, &n)) {
1815 struct ovs_key_mpls *mpls, *mpls_mask;
1817 mpls = nl_msg_put_unspec_uninit(key, OVS_KEY_ATTR_MPLS,
1819 mpls->mpls_lse = mpls_lse_from_components(label, tc, ttl, bos);
1821 mpls_mask = nl_msg_put_unspec_uninit(mask, OVS_KEY_ATTR_MPLS,
1823 mpls_mask->mpls_lse = mpls_lse_from_components(
1824 label_mask, tc_mask, ttl_mask, bos_mask);
1826 } else if (ovs_scan(s, "mpls(label=%i,tc=%i,ttl=%i,bos=%i)%n",
1827 &label, &tc, &ttl, &bos, &n)) {
1828 struct ovs_key_mpls *mpls;
1830 mpls = nl_msg_put_unspec_uninit(key, OVS_KEY_ATTR_MPLS,
1832 mpls->mpls_lse = mpls_lse_from_components(label, tc, ttl, bos);
1834 mpls = nl_msg_put_unspec_uninit(mask, OVS_KEY_ATTR_MPLS,
1836 mpls->mpls_lse = OVS_BE32_MAX;
1844 struct ovs_key_ipv4 ipv4_key;
1845 struct ovs_key_ipv4 ipv4_mask;
1848 enum ovs_frag_type ipv4_frag;
1852 && ovs_scan(s, "ipv4(src="IP_SCAN_FMT"/"IP_SCAN_FMT","
1853 "dst="IP_SCAN_FMT"/"IP_SCAN_FMT","
1854 "proto=%"SCNi8"/%"SCNi8","
1855 "tos=%"SCNi8"/%"SCNi8","
1856 "ttl=%"SCNi8"/%"SCNi8","
1857 "frag=%7[a-z]/%"SCNi8")%n",
1858 IP_SCAN_ARGS(&ipv4_key.ipv4_src),
1859 IP_SCAN_ARGS(&ipv4_mask.ipv4_src),
1860 IP_SCAN_ARGS(&ipv4_key.ipv4_dst),
1861 IP_SCAN_ARGS(&ipv4_mask.ipv4_dst),
1862 &ipv4_key.ipv4_proto, &ipv4_mask.ipv4_proto,
1863 &ipv4_key.ipv4_tos, &ipv4_mask.ipv4_tos,
1864 &ipv4_key.ipv4_ttl, &ipv4_mask.ipv4_ttl,
1865 frag, &ipv4_mask.ipv4_frag, &n)
1866 && ovs_frag_type_from_string(frag, &ipv4_frag)) {
1867 ipv4_key.ipv4_frag = ipv4_frag;
1868 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
1869 &ipv4_key, sizeof ipv4_key);
1871 nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV4,
1872 &ipv4_mask, sizeof ipv4_mask);
1874 } else if (ovs_scan(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
1875 "proto=%"SCNi8",tos=%"SCNi8",ttl=%"SCNi8","
1877 IP_SCAN_ARGS(&ipv4_key.ipv4_src),
1878 IP_SCAN_ARGS(&ipv4_key.ipv4_dst),
1879 &ipv4_key.ipv4_proto,
1883 && ovs_frag_type_from_string(frag, &ipv4_frag)) {
1884 ipv4_key.ipv4_frag = ipv4_frag;
1885 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
1886 &ipv4_key, sizeof ipv4_key);
1889 memset(&ipv4_key, 0xff, sizeof ipv4_key);
1890 nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV4,
1891 &ipv4_key, sizeof ipv4_key);
1898 char ipv6_src_s[IPV6_SCAN_LEN + 1];
1899 char ipv6_src_mask_s[IPV6_SCAN_LEN + 1];
1900 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
1901 char ipv6_dst_mask_s[IPV6_SCAN_LEN + 1];
1902 int ipv6_label, ipv6_label_mask;
1903 int ipv6_proto, ipv6_proto_mask;
1904 int ipv6_tclass, ipv6_tclass_mask;
1905 int ipv6_hlimit, ipv6_hlimit_mask;
1907 enum ovs_frag_type ipv6_frag;
1911 if (mask && ovs_scan(s, "ipv6(src="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT",dst="
1912 IPV6_SCAN_FMT"/"IPV6_SCAN_FMT","
1913 "label=%i/%i,proto=%i/%i,tclass=%i/%i,"
1914 "hlimit=%i/%i,frag=%7[a-z]/%i)%n",
1915 ipv6_src_s, ipv6_src_mask_s,
1916 ipv6_dst_s, ipv6_dst_mask_s,
1917 &ipv6_label, &ipv6_label_mask, &ipv6_proto,
1918 &ipv6_proto_mask, &ipv6_tclass, &ipv6_tclass_mask,
1919 &ipv6_hlimit, &ipv6_hlimit_mask, frag,
1920 &ipv6_frag_mask, &n)
1921 && ovs_frag_type_from_string(frag, &ipv6_frag)) {
1922 struct ovs_key_ipv6 ipv6_key;
1923 struct ovs_key_ipv6 ipv6_mask;
1925 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
1926 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1 ||
1927 inet_pton(AF_INET6, ipv6_src_mask_s, &ipv6_mask.ipv6_src) != 1 ||
1928 inet_pton(AF_INET6, ipv6_dst_mask_s, &ipv6_mask.ipv6_dst) != 1) {
1932 ipv6_key.ipv6_label = htonl(ipv6_label);
1933 ipv6_key.ipv6_proto = ipv6_proto;
1934 ipv6_key.ipv6_tclass = ipv6_tclass;
1935 ipv6_key.ipv6_hlimit = ipv6_hlimit;
1936 ipv6_key.ipv6_frag = ipv6_frag;
1937 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
1938 &ipv6_key, sizeof ipv6_key);
1940 ipv6_mask.ipv6_label = htonl(ipv6_label_mask);
1941 ipv6_mask.ipv6_proto = ipv6_proto_mask;
1942 ipv6_mask.ipv6_tclass = ipv6_tclass_mask;
1943 ipv6_mask.ipv6_hlimit = ipv6_hlimit_mask;
1944 ipv6_mask.ipv6_frag = ipv6_frag_mask;
1945 nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV6,
1946 &ipv6_mask, sizeof ipv6_mask);
1948 } else if (ovs_scan(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
1949 "label=%i,proto=%i,tclass=%i,hlimit=%i,"
1951 ipv6_src_s, ipv6_dst_s, &ipv6_label,
1952 &ipv6_proto, &ipv6_tclass, &ipv6_hlimit, frag, &n)
1953 && ovs_frag_type_from_string(frag, &ipv6_frag)) {
1954 struct ovs_key_ipv6 ipv6_key;
1956 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
1957 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
1960 ipv6_key.ipv6_label = htonl(ipv6_label);
1961 ipv6_key.ipv6_proto = ipv6_proto;
1962 ipv6_key.ipv6_tclass = ipv6_tclass;
1963 ipv6_key.ipv6_hlimit = ipv6_hlimit;
1964 ipv6_key.ipv6_frag = ipv6_frag;
1965 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
1966 &ipv6_key, sizeof ipv6_key);
1969 memset(&ipv6_key, 0xff, sizeof ipv6_key);
1970 nl_msg_put_unspec(mask, OVS_KEY_ATTR_IPV6,
1971 &ipv6_key, sizeof ipv6_key);
1984 if (mask && ovs_scan(s, "tcp(src=%i/%i,dst=%i/%i)%n",
1985 &tcp_src, &tcp_src_mask, &tcp_dst,
1986 &tcp_dst_mask, &n)) {
1987 struct ovs_key_tcp tcp_key;
1988 struct ovs_key_tcp tcp_mask;
1990 tcp_key.tcp_src = htons(tcp_src);
1991 tcp_key.tcp_dst = htons(tcp_dst);
1992 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
1994 tcp_mask.tcp_src = htons(tcp_src_mask);
1995 tcp_mask.tcp_dst = htons(tcp_dst_mask);
1996 nl_msg_put_unspec(mask, OVS_KEY_ATTR_TCP,
1997 &tcp_mask, sizeof tcp_mask);
1999 } else if (ovs_scan(s, "tcp(src=%i,dst=%i)%n",
2000 &tcp_src, &tcp_dst, &n)) {
2001 struct ovs_key_tcp tcp_key;
2003 tcp_key.tcp_src = htons(tcp_src);
2004 tcp_key.tcp_dst = htons(tcp_dst);
2005 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
2008 memset(&tcp_key, 0xff, sizeof tcp_key);
2009 nl_msg_put_unspec(mask, OVS_KEY_ATTR_TCP,
2010 &tcp_key, sizeof tcp_key);
2017 uint16_t tcp_flags, tcp_flags_mask;
2020 if (mask && ovs_scan(s, "tcp_flags(%"SCNi16"/%"SCNi16")%n",
2021 &tcp_flags, &tcp_flags_mask, &n) > 0 && n > 0) {
2022 nl_msg_put_be16(key, OVS_KEY_ATTR_TCP_FLAGS, htons(tcp_flags));
2023 nl_msg_put_be16(mask, OVS_KEY_ATTR_TCP_FLAGS, htons(tcp_flags_mask));
2025 } else if (ovs_scan(s, "tcp_flags(%"SCNi16")%n", &tcp_flags, &n)) {
2026 nl_msg_put_be16(key, OVS_KEY_ATTR_TCP_FLAGS, htons(tcp_flags));
2028 nl_msg_put_be16(mask, OVS_KEY_ATTR_TCP_FLAGS,
2042 if (mask && ovs_scan(s, "udp(src=%i/%i,dst=%i/%i)%n",
2043 &udp_src, &udp_src_mask,
2044 &udp_dst, &udp_dst_mask, &n)) {
2045 struct ovs_key_udp udp_key;
2046 struct ovs_key_udp udp_mask;
2048 udp_key.udp_src = htons(udp_src);
2049 udp_key.udp_dst = htons(udp_dst);
2050 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
2052 udp_mask.udp_src = htons(udp_src_mask);
2053 udp_mask.udp_dst = htons(udp_dst_mask);
2054 nl_msg_put_unspec(mask, OVS_KEY_ATTR_UDP,
2055 &udp_mask, sizeof udp_mask);
2058 if (ovs_scan(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n)) {
2059 struct ovs_key_udp udp_key;
2061 udp_key.udp_src = htons(udp_src);
2062 udp_key.udp_dst = htons(udp_dst);
2063 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
2066 memset(&udp_key, 0xff, sizeof udp_key);
2067 nl_msg_put_unspec(mask, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
2080 if (mask && ovs_scan(s, "sctp(src=%i/%i,dst=%i/%i)%n",
2081 &sctp_src, &sctp_src_mask,
2082 &sctp_dst, &sctp_dst_mask, &n)) {
2083 struct ovs_key_sctp sctp_key;
2084 struct ovs_key_sctp sctp_mask;
2086 sctp_key.sctp_src = htons(sctp_src);
2087 sctp_key.sctp_dst = htons(sctp_dst);
2088 nl_msg_put_unspec(key, OVS_KEY_ATTR_SCTP, &sctp_key, sizeof sctp_key);
2090 sctp_mask.sctp_src = htons(sctp_src_mask);
2091 sctp_mask.sctp_dst = htons(sctp_dst_mask);
2092 nl_msg_put_unspec(mask, OVS_KEY_ATTR_SCTP,
2093 &sctp_mask, sizeof sctp_mask);
2096 if (ovs_scan(s, "sctp(src=%i,dst=%i)%n", &sctp_src, &sctp_dst, &n)) {
2097 struct ovs_key_sctp sctp_key;
2099 sctp_key.sctp_src = htons(sctp_src);
2100 sctp_key.sctp_dst = htons(sctp_dst);
2101 nl_msg_put_unspec(key, OVS_KEY_ATTR_SCTP, &sctp_key, sizeof sctp_key);
2104 memset(&sctp_key, 0xff, sizeof sctp_key);
2105 nl_msg_put_unspec(mask, OVS_KEY_ATTR_SCTP, &sctp_key, sizeof sctp_key);
2112 struct ovs_key_icmp icmp_key;
2113 struct ovs_key_icmp icmp_mask;
2116 if (mask && ovs_scan(s, "icmp(type=%"SCNi8"/%"SCNi8","
2117 "code=%"SCNi8"/%"SCNi8")%n",
2118 &icmp_key.icmp_type, &icmp_mask.icmp_type,
2119 &icmp_key.icmp_code, &icmp_mask.icmp_code, &n)) {
2120 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
2121 &icmp_key, sizeof icmp_key);
2122 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMP,
2123 &icmp_mask, sizeof icmp_mask);
2125 } else if (ovs_scan(s, "icmp(type=%"SCNi8",code=%"SCNi8")%n",
2126 &icmp_key.icmp_type, &icmp_key.icmp_code, &n)) {
2127 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
2128 &icmp_key, sizeof icmp_key);
2130 memset(&icmp_key, 0xff, sizeof icmp_key);
2131 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMP, &icmp_key,
2139 struct ovs_key_icmpv6 icmpv6_key;
2140 struct ovs_key_icmpv6 icmpv6_mask;
2143 if (mask && ovs_scan(s, "icmpv6(type=%"SCNi8"/%"SCNi8","
2144 "code=%"SCNi8"/%"SCNi8")%n",
2145 &icmpv6_key.icmpv6_type, &icmpv6_mask.icmpv6_type,
2146 &icmpv6_key.icmpv6_code, &icmpv6_mask.icmpv6_code,
2148 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
2149 &icmpv6_key, sizeof icmpv6_key);
2150 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMPV6, &icmpv6_mask,
2151 sizeof icmpv6_mask);
2153 } else if (ovs_scan(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
2154 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,
2156 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
2157 &icmpv6_key, sizeof icmpv6_key);
2160 memset(&icmpv6_key, 0xff, sizeof icmpv6_key);
2161 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ICMPV6, &icmpv6_key,
2169 struct ovs_key_arp arp_key;
2170 struct ovs_key_arp arp_mask;
2171 uint16_t arp_op, arp_op_mask;
2174 if (mask && ovs_scan(s, "arp(sip="IP_SCAN_FMT"/"IP_SCAN_FMT","
2175 "tip="IP_SCAN_FMT"/"IP_SCAN_FMT","
2176 "op=%"SCNi16"/%"SCNi16","
2177 "sha="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT","
2178 "tha="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2179 IP_SCAN_ARGS(&arp_key.arp_sip),
2180 IP_SCAN_ARGS(&arp_mask.arp_sip),
2181 IP_SCAN_ARGS(&arp_key.arp_tip),
2182 IP_SCAN_ARGS(&arp_mask.arp_tip),
2183 &arp_op, &arp_op_mask,
2184 ETH_ADDR_SCAN_ARGS(arp_key.arp_sha),
2185 ETH_ADDR_SCAN_ARGS(arp_mask.arp_sha),
2186 ETH_ADDR_SCAN_ARGS(arp_key.arp_tha),
2187 ETH_ADDR_SCAN_ARGS(arp_mask.arp_tha), &n)) {
2188 arp_key.arp_op = htons(arp_op);
2189 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
2190 arp_mask.arp_op = htons(arp_op_mask);
2191 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ARP,
2192 &arp_mask, sizeof arp_mask);
2194 } else if (ovs_scan(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
2195 "op=%"SCNi16",sha="ETH_ADDR_SCAN_FMT","
2196 "tha="ETH_ADDR_SCAN_FMT")%n",
2197 IP_SCAN_ARGS(&arp_key.arp_sip),
2198 IP_SCAN_ARGS(&arp_key.arp_tip),
2200 ETH_ADDR_SCAN_ARGS(arp_key.arp_sha),
2201 ETH_ADDR_SCAN_ARGS(arp_key.arp_tha), &n)) {
2202 arp_key.arp_op = htons(arp_op);
2203 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
2206 memset(&arp_key, 0xff, sizeof arp_key);
2207 nl_msg_put_unspec(mask, OVS_KEY_ATTR_ARP,
2208 &arp_key, sizeof arp_key);
2215 char nd_target_s[IPV6_SCAN_LEN + 1];
2216 char nd_target_mask_s[IPV6_SCAN_LEN + 1];
2217 uint8_t nd_sll[ETH_ADDR_LEN];
2218 uint8_t nd_sll_mask[ETH_ADDR_LEN];
2219 uint8_t nd_tll[ETH_ADDR_LEN];
2220 uint8_t nd_tll_mask[ETH_ADDR_LEN];
2223 nd_target_mask_s[0] = 0;
2224 memset(nd_sll_mask, 0xff, sizeof nd_sll_mask);
2225 memset(nd_tll_mask, 0xff, sizeof nd_tll_mask);
2227 if (mask && ovs_scan(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT")%n",
2228 nd_target_s, nd_target_mask_s, &n)) {
2229 put_nd_key(n, nd_target_s, NULL, NULL, key);
2230 put_nd_mask(n, nd_target_mask_s, NULL, NULL, mask);
2231 } else if (ovs_scan(s, "nd(target="IPV6_SCAN_FMT")%n",
2233 put_nd_key(n, nd_target_s, NULL, NULL, key);
2235 put_nd_mask(n, nd_target_mask_s, NULL, NULL, mask);
2238 ovs_scan(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT
2239 ",sll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2240 nd_target_s, nd_target_mask_s,
2241 ETH_ADDR_SCAN_ARGS(nd_sll),
2242 ETH_ADDR_SCAN_ARGS(nd_sll_mask), &n)) {
2243 put_nd_key(n, nd_target_s, nd_sll, NULL, key);
2244 put_nd_mask(n, nd_target_mask_s, nd_sll_mask, NULL, mask);
2245 } else if (ovs_scan(s, "nd(target="IPV6_SCAN_FMT","
2246 "sll="ETH_ADDR_SCAN_FMT")%n",
2247 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n)) {
2248 put_nd_key(n, nd_target_s, nd_sll, NULL, key);
2250 put_nd_mask(n, nd_target_mask_s, nd_sll_mask, NULL, mask);
2253 ovs_scan(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT
2254 ",tll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2255 nd_target_s, nd_target_mask_s,
2256 ETH_ADDR_SCAN_ARGS(nd_tll),
2257 ETH_ADDR_SCAN_ARGS(nd_tll_mask), &n)) {
2258 put_nd_key(n, nd_target_s, NULL, nd_tll, key);
2259 put_nd_mask(n, nd_target_mask_s, NULL, nd_tll_mask, mask);
2260 } else if (ovs_scan(s, "nd(target="IPV6_SCAN_FMT","
2261 "tll="ETH_ADDR_SCAN_FMT")%n",
2262 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n)) {
2263 put_nd_key(n, nd_target_s, NULL, nd_tll, key);
2265 put_nd_mask(n, nd_target_mask_s, NULL, nd_tll_mask, mask);
2268 ovs_scan(s, "nd(target="IPV6_SCAN_FMT"/"IPV6_SCAN_FMT
2269 ",sll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT","
2270 "tll="ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT")%n",
2271 nd_target_s, nd_target_mask_s,
2272 ETH_ADDR_SCAN_ARGS(nd_sll),
2273 ETH_ADDR_SCAN_ARGS(nd_sll_mask),
2274 ETH_ADDR_SCAN_ARGS(nd_tll),
2275 ETH_ADDR_SCAN_ARGS(nd_tll_mask),
2277 put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
2278 put_nd_mask(n, nd_target_mask_s, nd_sll_mask, nd_tll_mask, mask);
2279 } else if (ovs_scan(s, "nd(target="IPV6_SCAN_FMT","
2280 "sll="ETH_ADDR_SCAN_FMT","
2281 "tll="ETH_ADDR_SCAN_FMT")%n",
2282 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
2283 ETH_ADDR_SCAN_ARGS(nd_tll), &n)) {
2284 put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
2286 put_nd_mask(n, nd_target_mask_s,
2287 nd_sll_mask, nd_tll_mask, mask);
2296 if (!strncmp(s, "encap(", 6)) {
2297 const char *start = s;
2298 size_t encap, encap_mask = 0;
2300 encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
2302 encap_mask = nl_msg_start_nested(mask, OVS_KEY_ATTR_ENCAP);
2309 s += strspn(s, ", \t\r\n");
2312 } else if (*s == ')') {
2316 retval = parse_odp_key_mask_attr(s, port_names, key, mask);
2324 nl_msg_end_nested(key, encap);
2326 nl_msg_end_nested(mask, encap_mask);
2335 /* Parses the string representation of a datapath flow key, in the
2336 * format output by odp_flow_key_format(). Returns 0 if successful,
2337 * otherwise a positive errno value. On success, the flow key is
2338 * appended to 'key' as a series of Netlink attributes. On failure, no
2339 * data is appended to 'key'. Either way, 'key''s data might be
2342 * If 'port_names' is nonnull, it points to an simap that maps from a port name
2343 * to a port number. (Port names may be used instead of port numbers in
2346 * On success, the attributes appended to 'key' are individually syntactically
2347 * valid, but they may not be valid as a sequence. 'key' might, for example,
2348 * have duplicated keys. odp_flow_key_to_flow() will detect those errors. */
2350 odp_flow_from_string(const char *s, const struct simap *port_names,
2351 struct ofpbuf *key, struct ofpbuf *mask)
2353 const size_t old_size = key->size;
2357 s += strspn(s, delimiters);
2362 retval = parse_odp_key_mask_attr(s, port_names, key, mask);
2364 key->size = old_size;
2374 ovs_to_odp_frag(uint8_t nw_frag)
2376 return (nw_frag == 0 ? OVS_FRAG_TYPE_NONE
2377 : nw_frag == FLOW_NW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
2378 : OVS_FRAG_TYPE_LATER);
2382 ovs_to_odp_frag_mask(uint8_t nw_frag_mask)
2384 uint8_t frag_mask = ~(OVS_FRAG_TYPE_FIRST | OVS_FRAG_TYPE_LATER);
2386 frag_mask |= (nw_frag_mask & FLOW_NW_FRAG_ANY) ? OVS_FRAG_TYPE_FIRST : 0;
2387 frag_mask |= (nw_frag_mask & FLOW_NW_FRAG_LATER) ? OVS_FRAG_TYPE_LATER : 0;
2393 odp_flow_key_from_flow__(struct ofpbuf *buf, const struct flow *data,
2394 const struct flow *flow, odp_port_t odp_in_port)
2397 struct ovs_key_ethernet *eth_key;
2400 /* We assume that if 'data' and 'flow' are not the same, we should
2401 * treat 'data' as a mask. */
2402 is_mask = (data != flow);
2404 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, data->skb_priority);
2406 if (flow->tunnel.ip_dst || is_mask) {
2407 tun_key_to_attr(buf, &data->tunnel);
2410 nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, data->pkt_mark);
2412 /* Add an ingress port attribute if this is a mask or 'odp_in_port'
2413 * is not the magical value "ODPP_NONE". */
2414 if (is_mask || odp_in_port != ODPP_NONE) {
2415 nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, odp_in_port);
2418 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
2420 memcpy(eth_key->eth_src, data->dl_src, ETH_ADDR_LEN);
2421 memcpy(eth_key->eth_dst, data->dl_dst, ETH_ADDR_LEN);
2423 if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
2425 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
2427 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
2429 nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, data->vlan_tci);
2430 encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
2431 if (flow->vlan_tci == htons(0)) {
2438 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
2439 /* For backwards compatibility with kernels that don't support
2440 * wildcarding, the following convention is used to encode the
2441 * OVS_KEY_ATTR_ETHERTYPE for key and mask:
2444 * -------- -------- -------
2445 * >0x5ff 0xffff Specified Ethernet II Ethertype.
2446 * >0x5ff 0 Any Ethernet II or non-Ethernet II frame.
2447 * <none> 0xffff Any non-Ethernet II frame (except valid
2448 * 802.3 SNAP packet with valid eth_type).
2451 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
2456 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, data->dl_type);
2458 if (flow->dl_type == htons(ETH_TYPE_IP)) {
2459 struct ovs_key_ipv4 *ipv4_key;
2461 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
2463 ipv4_key->ipv4_src = data->nw_src;
2464 ipv4_key->ipv4_dst = data->nw_dst;
2465 ipv4_key->ipv4_proto = data->nw_proto;
2466 ipv4_key->ipv4_tos = data->nw_tos;
2467 ipv4_key->ipv4_ttl = data->nw_ttl;
2468 ipv4_key->ipv4_frag = is_mask ? ovs_to_odp_frag_mask(data->nw_frag)
2469 : ovs_to_odp_frag(data->nw_frag);
2470 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
2471 struct ovs_key_ipv6 *ipv6_key;
2473 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
2475 memcpy(ipv6_key->ipv6_src, &data->ipv6_src, sizeof ipv6_key->ipv6_src);
2476 memcpy(ipv6_key->ipv6_dst, &data->ipv6_dst, sizeof ipv6_key->ipv6_dst);
2477 ipv6_key->ipv6_label = data->ipv6_label;
2478 ipv6_key->ipv6_proto = data->nw_proto;
2479 ipv6_key->ipv6_tclass = data->nw_tos;
2480 ipv6_key->ipv6_hlimit = data->nw_ttl;
2481 ipv6_key->ipv6_frag = is_mask ? ovs_to_odp_frag_mask(data->nw_frag)
2482 : ovs_to_odp_frag(data->nw_frag);
2483 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
2484 flow->dl_type == htons(ETH_TYPE_RARP)) {
2485 struct ovs_key_arp *arp_key;
2487 arp_key = nl_msg_put_unspec_zero(buf, OVS_KEY_ATTR_ARP,
2489 arp_key->arp_sip = data->nw_src;
2490 arp_key->arp_tip = data->nw_dst;
2491 arp_key->arp_op = htons(data->nw_proto);
2492 memcpy(arp_key->arp_sha, data->arp_sha, ETH_ADDR_LEN);
2493 memcpy(arp_key->arp_tha, data->arp_tha, ETH_ADDR_LEN);
2494 } else if (eth_type_mpls(flow->dl_type)) {
2495 struct ovs_key_mpls *mpls_key;
2497 mpls_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_MPLS,
2499 mpls_key->mpls_lse = data->mpls_lse;
2502 if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2503 if (flow->nw_proto == IPPROTO_TCP) {
2504 struct ovs_key_tcp *tcp_key;
2506 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
2508 tcp_key->tcp_src = data->tp_src;
2509 tcp_key->tcp_dst = data->tp_dst;
2511 if (data->tcp_flags) {
2512 nl_msg_put_be16(buf, OVS_KEY_ATTR_TCP_FLAGS, data->tcp_flags);
2514 } else if (flow->nw_proto == IPPROTO_UDP) {
2515 struct ovs_key_udp *udp_key;
2517 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
2519 udp_key->udp_src = data->tp_src;
2520 udp_key->udp_dst = data->tp_dst;
2521 } else if (flow->nw_proto == IPPROTO_SCTP) {
2522 struct ovs_key_sctp *sctp_key;
2524 sctp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_SCTP,
2526 sctp_key->sctp_src = data->tp_src;
2527 sctp_key->sctp_dst = data->tp_dst;
2528 } else if (flow->dl_type == htons(ETH_TYPE_IP)
2529 && flow->nw_proto == IPPROTO_ICMP) {
2530 struct ovs_key_icmp *icmp_key;
2532 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
2534 icmp_key->icmp_type = ntohs(data->tp_src);
2535 icmp_key->icmp_code = ntohs(data->tp_dst);
2536 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
2537 && flow->nw_proto == IPPROTO_ICMPV6) {
2538 struct ovs_key_icmpv6 *icmpv6_key;
2540 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
2541 sizeof *icmpv6_key);
2542 icmpv6_key->icmpv6_type = ntohs(data->tp_src);
2543 icmpv6_key->icmpv6_code = ntohs(data->tp_dst);
2545 if (flow->tp_dst == htons(0) &&
2546 (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
2547 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) &&
2548 (!is_mask || (data->tp_src == htons(0xffff) &&
2549 data->tp_dst == htons(0xffff)))) {
2551 struct ovs_key_nd *nd_key;
2553 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
2555 memcpy(nd_key->nd_target, &data->nd_target,
2556 sizeof nd_key->nd_target);
2557 memcpy(nd_key->nd_sll, data->arp_sha, ETH_ADDR_LEN);
2558 memcpy(nd_key->nd_tll, data->arp_tha, ETH_ADDR_LEN);
2565 nl_msg_end_nested(buf, encap);
2569 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'.
2570 * 'flow->in_port' is ignored (since it is likely to be an OpenFlow port
2571 * number rather than a datapath port number). Instead, if 'odp_in_port'
2572 * is anything other than ODPP_NONE, it is included in 'buf' as the input
2575 * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
2576 * capable of being expanded to allow for that much space. */
2578 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow,
2579 odp_port_t odp_in_port)
2581 odp_flow_key_from_flow__(buf, flow, flow, odp_in_port);
2584 /* Appends a representation of 'mask' as OVS_KEY_ATTR_* attributes to
2585 * 'buf'. 'flow' is used as a template to determine how to interpret
2586 * 'mask'. For example, the 'dl_type' of 'mask' describes the mask, but
2587 * it doesn't indicate whether the other fields should be interpreted as
2588 * ARP, IPv4, IPv6, etc.
2590 * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
2591 * capable of being expanded to allow for that much space. */
2593 odp_flow_key_from_mask(struct ofpbuf *buf, const struct flow *mask,
2594 const struct flow *flow, uint32_t odp_in_port_mask)
2596 odp_flow_key_from_flow__(buf, mask, flow, u32_to_odp(odp_in_port_mask));
2600 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
2602 BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
2603 return hash_words(ALIGNED_CAST(const uint32_t *, key),
2604 key_len / sizeof(uint32_t), 0);
2608 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
2609 uint64_t attrs, int out_of_range_attr,
2610 const struct nlattr *key, size_t key_len)
2615 if (VLOG_DROP_DBG(rl)) {
2620 for (i = 0; i < 64; i++) {
2621 if (attrs & (UINT64_C(1) << i)) {
2622 char namebuf[OVS_KEY_ATTR_BUFSIZE];
2624 ds_put_format(&s, " %s",
2625 ovs_key_attr_to_string(i, namebuf, sizeof namebuf));
2628 if (out_of_range_attr) {
2629 ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
2632 ds_put_cstr(&s, ": ");
2633 odp_flow_key_format(key, key_len, &s);
2635 VLOG_DBG("%s:%s", title, ds_cstr(&s));
2640 odp_to_ovs_frag(uint8_t odp_frag, struct flow *flow)
2642 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2644 if (odp_frag > OVS_FRAG_TYPE_LATER) {
2645 VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
2649 if (odp_frag != OVS_FRAG_TYPE_NONE) {
2650 flow->nw_frag |= FLOW_NW_FRAG_ANY;
2651 if (odp_frag == OVS_FRAG_TYPE_LATER) {
2652 flow->nw_frag |= FLOW_NW_FRAG_LATER;
2659 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
2660 const struct nlattr *attrs[], uint64_t *present_attrsp,
2661 int *out_of_range_attrp)
2663 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
2664 const struct nlattr *nla;
2665 uint64_t present_attrs;
2668 BUILD_ASSERT(OVS_KEY_ATTR_MAX < CHAR_BIT * sizeof present_attrs);
2670 *out_of_range_attrp = 0;
2671 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
2672 uint16_t type = nl_attr_type(nla);
2673 size_t len = nl_attr_get_size(nla);
2674 int expected_len = odp_flow_key_attr_len(type);
2676 if (len != expected_len && expected_len >= 0) {
2677 char namebuf[OVS_KEY_ATTR_BUFSIZE];
2679 VLOG_ERR_RL(&rl, "attribute %s has length %zu but should have "
2680 "length %d", ovs_key_attr_to_string(type, namebuf,
2686 if (type > OVS_KEY_ATTR_MAX) {
2687 *out_of_range_attrp = type;
2689 if (present_attrs & (UINT64_C(1) << type)) {
2690 char namebuf[OVS_KEY_ATTR_BUFSIZE];
2692 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
2693 ovs_key_attr_to_string(type,
2694 namebuf, sizeof namebuf));
2698 present_attrs |= UINT64_C(1) << type;
2703 VLOG_ERR_RL(&rl, "trailing garbage in flow key");
2707 *present_attrsp = present_attrs;
2711 static enum odp_key_fitness
2712 check_expectations(uint64_t present_attrs, int out_of_range_attr,
2713 uint64_t expected_attrs,
2714 const struct nlattr *key, size_t key_len)
2716 uint64_t missing_attrs;
2717 uint64_t extra_attrs;
2719 missing_attrs = expected_attrs & ~present_attrs;
2720 if (missing_attrs) {
2721 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
2722 log_odp_key_attributes(&rl, "expected but not present",
2723 missing_attrs, 0, key, key_len);
2724 return ODP_FIT_TOO_LITTLE;
2727 extra_attrs = present_attrs & ~expected_attrs;
2728 if (extra_attrs || out_of_range_attr) {
2729 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
2730 log_odp_key_attributes(&rl, "present but not expected",
2731 extra_attrs, out_of_range_attr, key, key_len);
2732 return ODP_FIT_TOO_MUCH;
2735 return ODP_FIT_PERFECT;
2739 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
2740 uint64_t present_attrs, uint64_t *expected_attrs,
2741 struct flow *flow, const struct flow *src_flow)
2743 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2744 bool is_mask = flow != src_flow;
2746 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
2747 flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
2748 if (!is_mask && ntohs(flow->dl_type) < ETH_TYPE_MIN) {
2749 VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
2750 ntohs(flow->dl_type));
2753 if (is_mask && ntohs(src_flow->dl_type) < ETH_TYPE_MIN &&
2754 flow->dl_type != htons(0xffff)) {
2757 *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
2760 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
2761 } else if (ntohs(src_flow->dl_type) < ETH_TYPE_MIN) {
2762 /* See comments in odp_flow_key_from_flow__(). */
2763 VLOG_ERR_RL(&rl, "mask expected for non-Ethernet II frame");
2770 static enum odp_key_fitness
2771 parse_l2_5_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
2772 uint64_t present_attrs, int out_of_range_attr,
2773 uint64_t expected_attrs, struct flow *flow,
2774 const struct nlattr *key, size_t key_len,
2775 const struct flow *src_flow)
2777 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2778 bool is_mask = src_flow != flow;
2779 const void *check_start = NULL;
2780 size_t check_len = 0;
2781 enum ovs_key_attr expected_bit = 0xff;
2783 if (eth_type_mpls(src_flow->dl_type)) {
2785 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
2787 if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS))) {
2788 return ODP_FIT_TOO_LITTLE;
2790 flow->mpls_lse = nl_attr_get_be32(attrs[OVS_KEY_ATTR_MPLS]);
2791 } else if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
2792 flow->mpls_lse = nl_attr_get_be32(attrs[OVS_KEY_ATTR_MPLS]);
2794 if (flow->mpls_lse != 0 && flow->dl_type != htons(0xffff)) {
2795 return ODP_FIT_ERROR;
2797 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
2800 } else if (src_flow->dl_type == htons(ETH_TYPE_IP)) {
2802 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
2804 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
2805 const struct ovs_key_ipv4 *ipv4_key;
2807 ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
2808 flow->nw_src = ipv4_key->ipv4_src;
2809 flow->nw_dst = ipv4_key->ipv4_dst;
2810 flow->nw_proto = ipv4_key->ipv4_proto;
2811 flow->nw_tos = ipv4_key->ipv4_tos;
2812 flow->nw_ttl = ipv4_key->ipv4_ttl;
2814 flow->nw_frag = ipv4_key->ipv4_frag;
2815 check_start = ipv4_key;
2816 check_len = sizeof *ipv4_key;
2817 expected_bit = OVS_KEY_ATTR_IPV4;
2818 } else if (!odp_to_ovs_frag(ipv4_key->ipv4_frag, flow)) {
2819 return ODP_FIT_ERROR;
2822 } else if (src_flow->dl_type == htons(ETH_TYPE_IPV6)) {
2824 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
2826 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
2827 const struct ovs_key_ipv6 *ipv6_key;
2829 ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
2830 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
2831 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
2832 flow->ipv6_label = ipv6_key->ipv6_label;
2833 flow->nw_proto = ipv6_key->ipv6_proto;
2834 flow->nw_tos = ipv6_key->ipv6_tclass;
2835 flow->nw_ttl = ipv6_key->ipv6_hlimit;
2837 flow->nw_frag = ipv6_key->ipv6_frag;
2838 check_start = ipv6_key;
2839 check_len = sizeof *ipv6_key;
2840 expected_bit = OVS_KEY_ATTR_IPV6;
2841 } else if (!odp_to_ovs_frag(ipv6_key->ipv6_frag, flow)) {
2842 return ODP_FIT_ERROR;
2845 } else if (src_flow->dl_type == htons(ETH_TYPE_ARP) ||
2846 src_flow->dl_type == htons(ETH_TYPE_RARP)) {
2848 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
2850 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
2851 const struct ovs_key_arp *arp_key;
2853 arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
2854 flow->nw_src = arp_key->arp_sip;
2855 flow->nw_dst = arp_key->arp_tip;
2856 if (!is_mask && (arp_key->arp_op & htons(0xff00))) {
2857 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
2858 "key", ntohs(arp_key->arp_op));
2859 return ODP_FIT_ERROR;
2861 flow->nw_proto = ntohs(arp_key->arp_op);
2862 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
2863 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
2866 check_start = arp_key;
2867 check_len = sizeof *arp_key;
2868 expected_bit = OVS_KEY_ATTR_ARP;
2875 if (!is_all_zeros(check_start, check_len) &&
2876 flow->dl_type != htons(0xffff)) {
2877 return ODP_FIT_ERROR;
2879 expected_attrs |= UINT64_C(1) << expected_bit;
2883 expected_bit = OVS_KEY_ATTR_UNSPEC;
2884 if (src_flow->nw_proto == IPPROTO_TCP
2885 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
2886 src_flow->dl_type == htons(ETH_TYPE_IPV6))
2887 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2889 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
2891 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
2892 const struct ovs_key_tcp *tcp_key;
2894 tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
2895 flow->tp_src = tcp_key->tcp_src;
2896 flow->tp_dst = tcp_key->tcp_dst;
2897 expected_bit = OVS_KEY_ATTR_TCP;
2899 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS)) {
2900 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS;
2901 flow->tcp_flags = nl_attr_get_be16(attrs[OVS_KEY_ATTR_TCP_FLAGS]);
2903 } else if (src_flow->nw_proto == IPPROTO_UDP
2904 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
2905 src_flow->dl_type == htons(ETH_TYPE_IPV6))
2906 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2908 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
2910 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
2911 const struct ovs_key_udp *udp_key;
2913 udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
2914 flow->tp_src = udp_key->udp_src;
2915 flow->tp_dst = udp_key->udp_dst;
2916 expected_bit = OVS_KEY_ATTR_UDP;
2918 } else if (src_flow->nw_proto == IPPROTO_SCTP
2919 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
2920 src_flow->dl_type == htons(ETH_TYPE_IPV6))
2921 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2923 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SCTP;
2925 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SCTP)) {
2926 const struct ovs_key_sctp *sctp_key;
2928 sctp_key = nl_attr_get(attrs[OVS_KEY_ATTR_SCTP]);
2929 flow->tp_src = sctp_key->sctp_src;
2930 flow->tp_dst = sctp_key->sctp_dst;
2931 expected_bit = OVS_KEY_ATTR_SCTP;
2933 } else if (src_flow->nw_proto == IPPROTO_ICMP
2934 && src_flow->dl_type == htons(ETH_TYPE_IP)
2935 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2937 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
2939 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
2940 const struct ovs_key_icmp *icmp_key;
2942 icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
2943 flow->tp_src = htons(icmp_key->icmp_type);
2944 flow->tp_dst = htons(icmp_key->icmp_code);
2945 expected_bit = OVS_KEY_ATTR_ICMP;
2947 } else if (src_flow->nw_proto == IPPROTO_ICMPV6
2948 && src_flow->dl_type == htons(ETH_TYPE_IPV6)
2949 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2951 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
2953 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
2954 const struct ovs_key_icmpv6 *icmpv6_key;
2956 icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
2957 flow->tp_src = htons(icmpv6_key->icmpv6_type);
2958 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
2959 expected_bit = OVS_KEY_ATTR_ICMPV6;
2960 if (src_flow->tp_dst == htons(0) &&
2961 (src_flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
2962 src_flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
2964 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
2966 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
2967 const struct ovs_key_nd *nd_key;
2969 nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
2970 memcpy(&flow->nd_target, nd_key->nd_target,
2971 sizeof flow->nd_target);
2972 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
2973 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
2975 if (!is_all_zeros((const uint8_t *) nd_key,
2977 (flow->tp_src != htons(0xffff) ||
2978 flow->tp_dst != htons(0xffff))) {
2979 return ODP_FIT_ERROR;
2981 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
2988 if (is_mask && expected_bit != OVS_KEY_ATTR_UNSPEC) {
2989 if ((flow->tp_src || flow->tp_dst) && flow->nw_proto != 0xff) {
2990 return ODP_FIT_ERROR;
2992 expected_attrs |= UINT64_C(1) << expected_bit;
2997 return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
3001 /* Parse 802.1Q header then encapsulated L3 attributes. */
3002 static enum odp_key_fitness
3003 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
3004 uint64_t present_attrs, int out_of_range_attr,
3005 uint64_t expected_attrs, struct flow *flow,
3006 const struct nlattr *key, size_t key_len,
3007 const struct flow *src_flow)
3009 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3010 bool is_mask = src_flow != flow;
3012 const struct nlattr *encap
3013 = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
3014 ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
3015 enum odp_key_fitness encap_fitness;
3016 enum odp_key_fitness fitness;
3019 /* Calculate fitness of outer attributes. */
3021 expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
3022 (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
3024 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
3025 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
3027 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)) {
3028 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_ENCAP);
3031 fitness = check_expectations(present_attrs, out_of_range_attr,
3032 expected_attrs, key, key_len);
3034 /* Get the VLAN TCI value. */
3035 if (!is_mask && !(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
3036 return ODP_FIT_TOO_LITTLE;
3038 tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
3040 if (tci == htons(0)) {
3041 /* Corner case for a truncated 802.1Q header. */
3042 if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
3043 return ODP_FIT_TOO_MUCH;
3046 } else if (!(tci & htons(VLAN_CFI))) {
3047 VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
3048 "but CFI bit is not set", ntohs(tci));
3049 return ODP_FIT_ERROR;
3053 * Remove the TPID from dl_type since it's not the real Ethertype. */
3054 flow->dl_type = htons(0);
3055 flow->vlan_tci = tci;
3058 if (is_mask && !(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP))) {
3061 /* Now parse the encapsulated attributes. */
3062 if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
3063 attrs, &present_attrs, &out_of_range_attr)) {
3064 return ODP_FIT_ERROR;
3068 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow, src_flow)) {
3069 return ODP_FIT_ERROR;
3071 encap_fitness = parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
3072 expected_attrs, flow, key, key_len,
3075 /* The overall fitness is the worse of the outer and inner attributes. */
3076 return MAX(fitness, encap_fitness);
3079 static enum odp_key_fitness
3080 odp_flow_key_to_flow__(const struct nlattr *key, size_t key_len,
3081 struct flow *flow, const struct flow *src_flow)
3083 const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
3084 uint64_t expected_attrs;
3085 uint64_t present_attrs;
3086 int out_of_range_attr;
3087 bool is_mask = src_flow != flow;
3089 memset(flow, 0, sizeof *flow);
3091 /* Parse attributes. */
3092 if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
3093 &out_of_range_attr)) {
3094 return ODP_FIT_ERROR;
3099 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
3100 flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
3101 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
3104 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK)) {
3105 flow->pkt_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_SKB_MARK]);
3106 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK;
3109 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUNNEL)) {
3110 enum odp_key_fitness res;
3112 res = odp_tun_key_from_attr(attrs[OVS_KEY_ATTR_TUNNEL], &flow->tunnel);
3113 if (res == ODP_FIT_ERROR) {
3114 return ODP_FIT_ERROR;
3115 } else if (res == ODP_FIT_PERFECT) {
3116 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUNNEL;
3120 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
3121 flow->in_port.odp_port
3122 = nl_attr_get_odp_port(attrs[OVS_KEY_ATTR_IN_PORT]);
3123 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
3124 } else if (!is_mask) {
3125 flow->in_port.odp_port = ODPP_NONE;
3128 /* Ethernet header. */
3129 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
3130 const struct ovs_key_ethernet *eth_key;
3132 eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
3133 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
3134 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
3136 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
3140 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
3143 /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
3144 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow,
3146 return ODP_FIT_ERROR;
3149 if ((is_mask && (src_flow->vlan_tci & htons(VLAN_CFI))) ||
3150 (!is_mask && src_flow->dl_type == htons(ETH_TYPE_VLAN))) {
3151 return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
3152 expected_attrs, flow, key, key_len, src_flow);
3155 flow->vlan_tci = htons(0xffff);
3156 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
3157 flow->vlan_tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
3158 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
3161 return parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
3162 expected_attrs, flow, key, key_len, src_flow);
3165 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
3166 * structure in 'flow'. Returns an ODP_FIT_* value that indicates how well
3167 * 'key' fits our expectations for what a flow key should contain.
3169 * The 'in_port' will be the datapath's understanding of the port. The
3170 * caller will need to translate with odp_port_to_ofp_port() if the
3171 * OpenFlow port is needed.
3173 * This function doesn't take the packet itself as an argument because none of
3174 * the currently understood OVS_KEY_ATTR_* attributes require it. Currently,
3175 * it is always possible to infer which additional attribute(s) should appear
3176 * by looking at the attributes for lower-level protocols, e.g. if the network
3177 * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
3178 * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
3179 * must be absent. */
3180 enum odp_key_fitness
3181 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
3184 return odp_flow_key_to_flow__(key, key_len, flow, flow);
3187 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a mask
3188 * structure in 'mask'. 'flow' must be a previously translated flow
3189 * corresponding to 'mask'. Returns an ODP_FIT_* value that indicates how well
3190 * 'key' fits our expectations for what a flow key should contain. */
3191 enum odp_key_fitness
3192 odp_flow_key_to_mask(const struct nlattr *key, size_t key_len,
3193 struct flow *mask, const struct flow *flow)
3195 return odp_flow_key_to_flow__(key, key_len, mask, flow);
3198 /* Returns 'fitness' as a string, for use in debug messages. */
3200 odp_key_fitness_to_string(enum odp_key_fitness fitness)
3203 case ODP_FIT_PERFECT:
3205 case ODP_FIT_TOO_MUCH:
3207 case ODP_FIT_TOO_LITTLE:
3208 return "too_little";
3216 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
3217 * Netlink PID 'pid'. If 'userdata' is nonnull, adds a userdata attribute
3218 * whose contents are the 'userdata_size' bytes at 'userdata' and returns the
3219 * offset within 'odp_actions' of the start of the cookie. (If 'userdata' is
3220 * null, then the return value is not meaningful.) */
3222 odp_put_userspace_action(uint32_t pid,
3223 const void *userdata, size_t userdata_size,
3224 struct ofpbuf *odp_actions)
3226 size_t userdata_ofs;
3229 offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
3230 nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
3232 userdata_ofs = odp_actions->size + NLA_HDRLEN;
3234 /* The OVS kernel module before OVS 1.11 and the upstream Linux kernel
3235 * module before Linux 3.10 required the userdata to be exactly 8 bytes
3238 * - The kernel rejected shorter userdata with -ERANGE.
3240 * - The kernel silently dropped userdata beyond the first 8 bytes.
3242 * Thus, for maximum compatibility, always put at least 8 bytes. (We
3243 * separately disable features that required more than 8 bytes.) */
3244 memcpy(nl_msg_put_unspec_zero(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
3245 MAX(8, userdata_size)),
3246 userdata, userdata_size);
3250 nl_msg_end_nested(odp_actions, offset);
3252 return userdata_ofs;
3256 odp_put_tunnel_action(const struct flow_tnl *tunnel,
3257 struct ofpbuf *odp_actions)
3259 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
3260 tun_key_to_attr(odp_actions, tunnel);
3261 nl_msg_end_nested(odp_actions, offset);
3264 /* The commit_odp_actions() function and its helpers. */
3267 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
3268 const void *key, size_t key_size)
3270 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
3271 nl_msg_put_unspec(odp_actions, key_type, key, key_size);
3272 nl_msg_end_nested(odp_actions, offset);
3276 odp_put_pkt_mark_action(const uint32_t pkt_mark,
3277 struct ofpbuf *odp_actions)
3279 commit_set_action(odp_actions, OVS_KEY_ATTR_SKB_MARK, &pkt_mark,
3283 /* If any of the flow key data that ODP actions can modify are different in
3284 * 'base->tunnel' and 'flow->tunnel', appends a set_tunnel ODP action to
3285 * 'odp_actions' that change the flow tunneling information in key from
3286 * 'base->tunnel' into 'flow->tunnel', and then changes 'base->tunnel' in the
3287 * same way. In other words, operates the same as commit_odp_actions(), but
3288 * only on tunneling information. */
3290 commit_odp_tunnel_action(const struct flow *flow, struct flow *base,
3291 struct ofpbuf *odp_actions)
3293 /* A valid IPV4_TUNNEL must have non-zero ip_dst. */
3294 if (flow->tunnel.ip_dst) {
3295 if (!memcmp(&base->tunnel, &flow->tunnel, sizeof base->tunnel)) {
3298 memcpy(&base->tunnel, &flow->tunnel, sizeof base->tunnel);
3299 odp_put_tunnel_action(&base->tunnel, odp_actions);
3304 commit_set_ether_addr_action(const struct flow *flow, struct flow *base,
3305 struct ofpbuf *odp_actions,
3306 struct flow_wildcards *wc)
3308 struct ovs_key_ethernet eth_key;
3310 if (eth_addr_equals(base->dl_src, flow->dl_src) &&
3311 eth_addr_equals(base->dl_dst, flow->dl_dst)) {
3315 memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
3316 memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
3318 memcpy(base->dl_src, flow->dl_src, ETH_ADDR_LEN);
3319 memcpy(base->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
3321 memcpy(eth_key.eth_src, base->dl_src, ETH_ADDR_LEN);
3322 memcpy(eth_key.eth_dst, base->dl_dst, ETH_ADDR_LEN);
3324 commit_set_action(odp_actions, OVS_KEY_ATTR_ETHERNET,
3325 ð_key, sizeof(eth_key));
3329 commit_vlan_action(ovs_be16 vlan_tci, struct flow *base,
3330 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3332 if (base->vlan_tci == vlan_tci) {
3336 memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
3338 if (base->vlan_tci & htons(VLAN_CFI)) {
3339 nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
3342 if (vlan_tci & htons(VLAN_CFI)) {
3343 struct ovs_action_push_vlan vlan;
3345 vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
3346 vlan.vlan_tci = vlan_tci;
3347 nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
3348 &vlan, sizeof vlan);
3350 base->vlan_tci = vlan_tci;
3354 commit_mpls_action(const struct flow *flow, struct flow *base,
3355 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
3356 int *mpls_depth_delta)
3358 if (flow->mpls_lse == base->mpls_lse && !*mpls_depth_delta) {
3362 memset(&wc->masks.mpls_lse, 0xff, sizeof wc->masks.mpls_lse);
3364 switch (*mpls_depth_delta) {
3366 nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_POP_MPLS, flow->dl_type);
3369 struct ovs_action_push_mpls *mpls;
3371 mpls = nl_msg_put_unspec_zero(odp_actions, OVS_ACTION_ATTR_PUSH_MPLS,
3373 mpls->mpls_ethertype = flow->dl_type;
3374 mpls->mpls_lse = flow->mpls_lse;
3378 struct ovs_key_mpls mpls_key;
3380 mpls_key.mpls_lse = flow->mpls_lse;
3381 commit_set_action(odp_actions, OVS_KEY_ATTR_MPLS,
3382 &mpls_key, sizeof(mpls_key));
3389 base->dl_type = flow->dl_type;
3390 base->mpls_lse = flow->mpls_lse;
3391 *mpls_depth_delta = 0;
3395 commit_set_ipv4_action(const struct flow *flow, struct flow *base,
3396 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3398 struct ovs_key_ipv4 ipv4_key;
3400 if (base->nw_src == flow->nw_src &&
3401 base->nw_dst == flow->nw_dst &&
3402 base->nw_tos == flow->nw_tos &&
3403 base->nw_ttl == flow->nw_ttl &&
3404 base->nw_frag == flow->nw_frag) {
3408 memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
3409 memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
3410 memset(&wc->masks.nw_tos, 0xff, sizeof wc->masks.nw_tos);
3411 memset(&wc->masks.nw_ttl, 0xff, sizeof wc->masks.nw_ttl);
3412 memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
3413 memset(&wc->masks.nw_frag, 0xff, sizeof wc->masks.nw_frag);
3415 ipv4_key.ipv4_src = base->nw_src = flow->nw_src;
3416 ipv4_key.ipv4_dst = base->nw_dst = flow->nw_dst;
3417 ipv4_key.ipv4_tos = base->nw_tos = flow->nw_tos;
3418 ipv4_key.ipv4_ttl = base->nw_ttl = flow->nw_ttl;
3419 ipv4_key.ipv4_proto = base->nw_proto;
3420 ipv4_key.ipv4_frag = ovs_to_odp_frag(base->nw_frag);
3422 commit_set_action(odp_actions, OVS_KEY_ATTR_IPV4,
3423 &ipv4_key, sizeof(ipv4_key));
3427 commit_set_ipv6_action(const struct flow *flow, struct flow *base,
3428 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3430 struct ovs_key_ipv6 ipv6_key;
3432 if (ipv6_addr_equals(&base->ipv6_src, &flow->ipv6_src) &&
3433 ipv6_addr_equals(&base->ipv6_dst, &flow->ipv6_dst) &&
3434 base->ipv6_label == flow->ipv6_label &&
3435 base->nw_tos == flow->nw_tos &&
3436 base->nw_ttl == flow->nw_ttl &&
3437 base->nw_frag == flow->nw_frag) {
3441 memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
3442 memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
3443 memset(&wc->masks.ipv6_label, 0xff, sizeof wc->masks.ipv6_label);
3444 memset(&wc->masks.nw_tos, 0xff, sizeof wc->masks.nw_tos);
3445 memset(&wc->masks.nw_ttl, 0xff, sizeof wc->masks.nw_ttl);
3446 memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
3447 memset(&wc->masks.nw_frag, 0xff, sizeof wc->masks.nw_frag);
3449 base->ipv6_src = flow->ipv6_src;
3450 memcpy(&ipv6_key.ipv6_src, &base->ipv6_src, sizeof(ipv6_key.ipv6_src));
3451 base->ipv6_dst = flow->ipv6_dst;
3452 memcpy(&ipv6_key.ipv6_dst, &base->ipv6_dst, sizeof(ipv6_key.ipv6_dst));
3454 ipv6_key.ipv6_label = base->ipv6_label = flow->ipv6_label;
3455 ipv6_key.ipv6_tclass = base->nw_tos = flow->nw_tos;
3456 ipv6_key.ipv6_hlimit = base->nw_ttl = flow->nw_ttl;
3457 ipv6_key.ipv6_proto = base->nw_proto;
3458 ipv6_key.ipv6_frag = ovs_to_odp_frag(base->nw_frag);
3460 commit_set_action(odp_actions, OVS_KEY_ATTR_IPV6,
3461 &ipv6_key, sizeof(ipv6_key));
3464 static enum slow_path_reason
3465 commit_set_arp_action(const struct flow *flow, struct flow *base,
3466 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3468 struct ovs_key_arp arp_key;
3470 if (base->nw_src == flow->nw_src &&
3471 base->nw_dst == flow->nw_dst &&
3472 base->nw_proto == flow->nw_proto &&
3473 eth_addr_equals(base->arp_sha, flow->arp_sha) &&
3474 eth_addr_equals(base->arp_tha, flow->arp_tha)) {
3478 memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
3479 memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
3480 memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
3481 memset(&wc->masks.arp_sha, 0xff, sizeof wc->masks.arp_sha);
3482 memset(&wc->masks.arp_tha, 0xff, sizeof wc->masks.arp_tha);
3484 base->nw_src = flow->nw_src;
3485 base->nw_dst = flow->nw_dst;
3486 base->nw_proto = flow->nw_proto;
3487 memcpy(base->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
3488 memcpy(base->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
3490 arp_key.arp_sip = base->nw_src;
3491 arp_key.arp_tip = base->nw_dst;
3492 arp_key.arp_op = htons(base->nw_proto);
3493 memcpy(arp_key.arp_sha, flow->arp_sha, ETH_ADDR_LEN);
3494 memcpy(arp_key.arp_tha, flow->arp_tha, ETH_ADDR_LEN);
3496 commit_set_action(odp_actions, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
3501 static enum slow_path_reason
3502 commit_set_nw_action(const struct flow *flow, struct flow *base,
3503 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3505 /* Check if 'flow' really has an L3 header. */
3506 if (!flow->nw_proto) {
3510 switch (ntohs(base->dl_type)) {
3512 commit_set_ipv4_action(flow, base, odp_actions, wc);
3516 commit_set_ipv6_action(flow, base, odp_actions, wc);
3520 return commit_set_arp_action(flow, base, odp_actions, wc);
3527 commit_set_port_action(const struct flow *flow, struct flow *base,
3528 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3530 if (!is_ip_any(base) || (!base->tp_src && !base->tp_dst)) {
3534 if (base->tp_src == flow->tp_src &&
3535 base->tp_dst == flow->tp_dst) {
3539 memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
3540 memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
3542 if (flow->nw_proto == IPPROTO_TCP) {
3543 struct ovs_key_tcp port_key;
3545 port_key.tcp_src = base->tp_src = flow->tp_src;
3546 port_key.tcp_dst = base->tp_dst = flow->tp_dst;
3548 commit_set_action(odp_actions, OVS_KEY_ATTR_TCP,
3549 &port_key, sizeof(port_key));
3551 } else if (flow->nw_proto == IPPROTO_UDP) {
3552 struct ovs_key_udp port_key;
3554 port_key.udp_src = base->tp_src = flow->tp_src;
3555 port_key.udp_dst = base->tp_dst = flow->tp_dst;
3557 commit_set_action(odp_actions, OVS_KEY_ATTR_UDP,
3558 &port_key, sizeof(port_key));
3559 } else if (flow->nw_proto == IPPROTO_SCTP) {
3560 struct ovs_key_sctp port_key;
3562 port_key.sctp_src = base->tp_src = flow->tp_src;
3563 port_key.sctp_dst = base->tp_dst = flow->tp_dst;
3565 commit_set_action(odp_actions, OVS_KEY_ATTR_SCTP,
3566 &port_key, sizeof(port_key));
3571 commit_set_priority_action(const struct flow *flow, struct flow *base,
3572 struct ofpbuf *odp_actions,
3573 struct flow_wildcards *wc)
3575 if (base->skb_priority == flow->skb_priority) {
3579 memset(&wc->masks.skb_priority, 0xff, sizeof wc->masks.skb_priority);
3580 base->skb_priority = flow->skb_priority;
3582 commit_set_action(odp_actions, OVS_KEY_ATTR_PRIORITY,
3583 &base->skb_priority, sizeof(base->skb_priority));
3587 commit_set_pkt_mark_action(const struct flow *flow, struct flow *base,
3588 struct ofpbuf *odp_actions,
3589 struct flow_wildcards *wc)
3591 if (base->pkt_mark == flow->pkt_mark) {
3595 memset(&wc->masks.pkt_mark, 0xff, sizeof wc->masks.pkt_mark);
3596 base->pkt_mark = flow->pkt_mark;
3598 odp_put_pkt_mark_action(base->pkt_mark, odp_actions);
3601 /* If any of the flow key data that ODP actions can modify are different in
3602 * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
3603 * key from 'base' into 'flow', and then changes 'base' the same way. Does not
3604 * commit set_tunnel actions. Users should call commit_odp_tunnel_action()
3605 * in addition to this function if needed. Sets fields in 'wc' that are
3606 * used as part of the action.
3608 * Returns a reason to force processing the flow's packets into the userspace
3609 * slow path, if there is one, otherwise 0. */
3610 enum slow_path_reason
3611 commit_odp_actions(const struct flow *flow, struct flow *base,
3612 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
3613 int *mpls_depth_delta)
3615 enum slow_path_reason slow;
3617 commit_set_ether_addr_action(flow, base, odp_actions, wc);
3618 commit_vlan_action(flow->vlan_tci, base, odp_actions, wc);
3619 slow = commit_set_nw_action(flow, base, odp_actions, wc);
3620 commit_set_port_action(flow, base, odp_actions, wc);
3621 /* Committing MPLS actions should occur after committing nw and port
3622 * actions. This is because committing MPLS actions may alter a packet so
3623 * that it is no longer IP and thus nw and port actions are no longer valid.
3625 commit_mpls_action(flow, base, odp_actions, wc, mpls_depth_delta);
3626 commit_set_priority_action(flow, base, odp_actions, wc);
3627 commit_set_pkt_mark_action(flow, base, odp_actions, wc);