2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include <arpa/inet.h>
22 #include <netinet/in.h>
23 #include <netinet/icmp6.h>
26 #include "byte-order.h"
28 #include "dynamic-string.h"
32 #include "openvswitch/tunnel.h"
37 /* The interface between userspace and kernel uses an "OVS_*" prefix.
38 * Since this is fairly non-specific for the OVS userspace components,
39 * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
40 * interactions with the datapath.
43 static void format_odp_key_attr(const struct nlattr *a, struct ds *ds);
45 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
48 * - For an action whose argument has a fixed length, returned that
49 * nonnegative length in bytes.
51 * - For an action with a variable-length argument, returns -2.
53 * - For an invalid 'type', returns -1. */
55 odp_action_len(uint16_t type)
57 if (type > OVS_ACTION_ATTR_MAX) {
61 switch ((enum ovs_action_attr) type) {
62 case OVS_ACTION_ATTR_OUTPUT: return 4;
63 case OVS_ACTION_ATTR_USERSPACE: return -2;
64 case OVS_ACTION_ATTR_PUSH: return -2;
65 case OVS_ACTION_ATTR_POP: return 2;
66 case OVS_ACTION_ATTR_SET: return -2;
67 case OVS_ACTION_ATTR_SAMPLE: return -2;
69 case OVS_ACTION_ATTR_UNSPEC:
70 case __OVS_ACTION_ATTR_MAX:
78 ovs_key_attr_to_string(enum ovs_key_attr attr)
80 static char unknown_attr[3 + INT_STRLEN(unsigned int) + 1];
83 case OVS_KEY_ATTR_UNSPEC: return "unspec";
84 case OVS_KEY_ATTR_PRIORITY: return "priority";
85 case OVS_KEY_ATTR_TUN_ID: return "tun_id";
86 case OVS_KEY_ATTR_IN_PORT: return "in_port";
87 case OVS_KEY_ATTR_ETHERNET: return "eth";
88 case OVS_KEY_ATTR_8021Q: return "vlan";
89 case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
90 case OVS_KEY_ATTR_IPV4: return "ipv4";
91 case OVS_KEY_ATTR_IPV6: return "ipv6";
92 case OVS_KEY_ATTR_TCP: return "tcp";
93 case OVS_KEY_ATTR_UDP: return "udp";
94 case OVS_KEY_ATTR_ICMP: return "icmp";
95 case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
96 case OVS_KEY_ATTR_ARP: return "arp";
97 case OVS_KEY_ATTR_ND: return "nd";
99 case __OVS_KEY_ATTR_MAX:
101 snprintf(unknown_attr, sizeof unknown_attr, "key%u",
102 (unsigned int) attr);
108 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
110 size_t len = nl_attr_get_size(a);
112 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
114 const uint8_t *unspec;
117 unspec = nl_attr_get(a);
118 for (i = 0; i < len; i++) {
119 ds_put_char(ds, i ? ' ': '(');
120 ds_put_format(ds, "%02x", unspec[i]);
122 ds_put_char(ds, ')');
127 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
129 static const struct nl_policy ovs_sample_policy[] = {
130 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
131 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
133 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
135 const struct nlattr *nla_acts;
138 ds_put_cstr(ds, "sample");
140 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
141 ds_put_cstr(ds, "(error)");
145 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
148 ds_put_format(ds, "(sample=%.1f%%,", percentage);
150 ds_put_cstr(ds, "actions(");
151 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
152 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
153 format_odp_actions(ds, nla_acts, len);
154 ds_put_format(ds, "))");
158 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
160 static const struct nl_policy ovs_userspace_policy[] = {
161 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
162 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
164 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
166 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
167 ds_put_cstr(ds, "userspace(error)");
171 ds_put_format(ds, "userspace(pid=%"PRIu32,
172 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
174 if (a[OVS_USERSPACE_ATTR_USERDATA]) {
175 uint64_t userdata = nl_attr_get_u64(a[OVS_USERSPACE_ATTR_USERDATA]);
176 struct user_action_cookie cookie;
178 memcpy(&cookie, &userdata, sizeof cookie);
180 if (cookie.type == USER_ACTION_COOKIE_CONTROLLER) {
181 ds_put_format(ds, ",controller,length=%"PRIu32,
183 } else if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
184 ds_put_format(ds, ",sFlow,n_output=%"PRIu8","
185 "vid=%"PRIu16",pcp=%"PRIu8",ifindex=%"PRIu32,
186 cookie.n_output, vlan_tci_to_vid(cookie.vlan_tci),
187 vlan_tci_to_pcp(cookie.vlan_tci), cookie.data);
189 ds_put_format(ds, ",userdata=0x%"PRIx64, userdata);
193 ds_put_char(ds, ')');
197 format_odp_action(struct ds *ds, const struct nlattr *a)
200 enum ovs_action_attr type = nl_attr_type(a);
202 expected_len = odp_action_len(nl_attr_type(a));
203 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
204 ds_put_format(ds, "bad length %zu, expected %d for: ",
205 nl_attr_get_size(a), expected_len);
206 format_generic_odp_action(ds, a);
212 case OVS_ACTION_ATTR_OUTPUT:
213 ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
215 case OVS_ACTION_ATTR_USERSPACE:
216 format_odp_userspace_action(ds, a);
218 case OVS_ACTION_ATTR_SET:
219 ds_put_cstr(ds, "set(");
220 format_odp_key_attr(nl_attr_get(a), ds);
221 ds_put_cstr(ds, ")");
223 case OVS_ACTION_ATTR_PUSH:
224 ds_put_cstr(ds, "push(");
225 format_odp_key_attr(nl_attr_get(a), ds);
226 ds_put_cstr(ds, ")");
228 case OVS_ACTION_ATTR_POP:
229 ds_put_format(ds, "pop(%s)",
230 ovs_key_attr_to_string(nl_attr_get_u16(a)));
232 case OVS_ACTION_ATTR_SAMPLE:
233 format_odp_sample_action(ds, a);
235 case OVS_ACTION_ATTR_UNSPEC:
236 case __OVS_ACTION_ATTR_MAX:
238 format_generic_odp_action(ds, a);
244 format_odp_actions(struct ds *ds, const struct nlattr *actions,
248 const struct nlattr *a;
251 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
253 ds_put_char(ds, ',');
255 format_odp_action(ds, a);
258 if (left == actions_len) {
259 ds_put_cstr(ds, "<empty>");
261 ds_put_format(ds, ",***%u leftover bytes***", left);
264 ds_put_cstr(ds, "drop");
268 /* Returns the correct length of the payload for a flow key attribute of the
269 * specified 'type', or -1 if 'type' is unknown. */
271 odp_flow_key_attr_len(uint16_t type)
273 if (type > OVS_KEY_ATTR_MAX) {
277 switch ((enum ovs_key_attr) type) {
278 case OVS_KEY_ATTR_PRIORITY: return 4;
279 case OVS_KEY_ATTR_TUN_ID: return 8;
280 case OVS_KEY_ATTR_IN_PORT: return 4;
281 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
282 case OVS_KEY_ATTR_8021Q: return sizeof(struct ovs_key_8021q);
283 case OVS_KEY_ATTR_ETHERTYPE: return 2;
284 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
285 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
286 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
287 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
288 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
289 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
290 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
291 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
293 case OVS_KEY_ATTR_UNSPEC:
294 case __OVS_KEY_ATTR_MAX:
302 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
304 size_t len = nl_attr_get_size(a);
306 const uint8_t *unspec;
309 unspec = nl_attr_get(a);
310 for (i = 0; i < len; i++) {
311 ds_put_char(ds, i ? ' ': '(');
312 ds_put_format(ds, "%02x", unspec[i]);
314 ds_put_char(ds, ')');
319 ovs_frag_type_to_string(enum ovs_frag_type type)
322 case OVS_FRAG_TYPE_NONE:
324 case OVS_FRAG_TYPE_FIRST:
326 case OVS_FRAG_TYPE_LATER:
328 case __OVS_FRAG_TYPE_MAX:
335 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
337 const struct ovs_key_ethernet *eth_key;
338 const struct ovs_key_8021q *q_key;
339 const struct ovs_key_ipv4 *ipv4_key;
340 const struct ovs_key_ipv6 *ipv6_key;
341 const struct ovs_key_tcp *tcp_key;
342 const struct ovs_key_udp *udp_key;
343 const struct ovs_key_icmp *icmp_key;
344 const struct ovs_key_icmpv6 *icmpv6_key;
345 const struct ovs_key_arp *arp_key;
346 const struct ovs_key_nd *nd_key;
347 enum ovs_key_attr attr = nl_attr_type(a);
349 ds_put_cstr(ds, ovs_key_attr_to_string(attr));
350 if (nl_attr_get_size(a) != odp_flow_key_attr_len(nl_attr_type(a))) {
351 ds_put_format(ds, "(bad length %zu, expected %d)",
353 odp_flow_key_attr_len(nl_attr_type(a)));
354 format_generic_odp_key(a, ds);
359 case OVS_KEY_ATTR_PRIORITY:
360 ds_put_format(ds, "(%"PRIu32")", nl_attr_get_u32(a));
363 case OVS_KEY_ATTR_TUN_ID:
364 ds_put_format(ds, "(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
367 case OVS_KEY_ATTR_IN_PORT:
368 ds_put_format(ds, "(%"PRIu32")", nl_attr_get_u32(a));
371 case OVS_KEY_ATTR_ETHERNET:
372 eth_key = nl_attr_get(a);
373 ds_put_format(ds, "(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
374 ETH_ADDR_ARGS(eth_key->eth_src),
375 ETH_ADDR_ARGS(eth_key->eth_dst));
378 case OVS_KEY_ATTR_8021Q:
379 q_key = nl_attr_get(a);
380 ds_put_cstr(ds, "(");
381 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
382 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(q_key->q_tpid));
384 ds_put_format(ds, "vid=%"PRIu16",pcp=%d)",
385 vlan_tci_to_vid(q_key->q_tci),
386 vlan_tci_to_pcp(q_key->q_tci));
389 case OVS_KEY_ATTR_ETHERTYPE:
390 ds_put_format(ds, "(0x%04"PRIx16")",
391 ntohs(nl_attr_get_be16(a)));
394 case OVS_KEY_ATTR_IPV4:
395 ipv4_key = nl_attr_get(a);
396 ds_put_format(ds, "(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
397 ",tos=%#"PRIx8",ttl=%"PRIu8",frag=%s)",
398 IP_ARGS(&ipv4_key->ipv4_src),
399 IP_ARGS(&ipv4_key->ipv4_dst),
400 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
402 ovs_frag_type_to_string(ipv4_key->ipv4_frag));
405 case OVS_KEY_ATTR_IPV6: {
406 char src_str[INET6_ADDRSTRLEN];
407 char dst_str[INET6_ADDRSTRLEN];
409 ipv6_key = nl_attr_get(a);
410 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
411 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
413 ds_put_format(ds, "(src=%s,dst=%s,label=%#"PRIx32",proto=%"PRIu8
414 ",tclass=%#"PRIx8",hlimit=%"PRIu8",frag=%s)",
415 src_str, dst_str, ntohl(ipv6_key->ipv6_label),
416 ipv6_key->ipv6_proto, ipv6_key->ipv6_tclass,
417 ipv6_key->ipv6_hlimit,
418 ovs_frag_type_to_string(ipv6_key->ipv6_frag));
422 case OVS_KEY_ATTR_TCP:
423 tcp_key = nl_attr_get(a);
424 ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
425 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
428 case OVS_KEY_ATTR_UDP:
429 udp_key = nl_attr_get(a);
430 ds_put_format(ds, "(src=%"PRIu16",dst=%"PRIu16")",
431 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
434 case OVS_KEY_ATTR_ICMP:
435 icmp_key = nl_attr_get(a);
436 ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
437 icmp_key->icmp_type, icmp_key->icmp_code);
440 case OVS_KEY_ATTR_ICMPV6:
441 icmpv6_key = nl_attr_get(a);
442 ds_put_format(ds, "(type=%"PRIu8",code=%"PRIu8")",
443 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
446 case OVS_KEY_ATTR_ARP:
447 arp_key = nl_attr_get(a);
448 ds_put_format(ds, "(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
449 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
450 IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
451 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
452 ETH_ADDR_ARGS(arp_key->arp_tha));
455 case OVS_KEY_ATTR_ND: {
456 char target[INET6_ADDRSTRLEN];
458 nd_key = nl_attr_get(a);
459 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
461 ds_put_format(ds, "(target=%s", target);
462 if (!eth_addr_is_zero(nd_key->nd_sll)) {
463 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
464 ETH_ADDR_ARGS(nd_key->nd_sll));
466 if (!eth_addr_is_zero(nd_key->nd_tll)) {
467 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
468 ETH_ADDR_ARGS(nd_key->nd_tll));
470 ds_put_char(ds, ')');
474 case OVS_KEY_ATTR_UNSPEC:
475 case __OVS_KEY_ATTR_MAX:
477 format_generic_odp_key(a, ds);
482 /* Appends to 'ds' a string representation of the 'key_len' bytes of
483 * OVS_KEY_ATTR_* attributes in 'key'. */
485 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
488 const struct nlattr *a;
491 NL_ATTR_FOR_EACH (a, left, key, key_len) {
493 ds_put_char(ds, ',');
495 format_odp_key_attr(a, ds);
498 if (left == key_len) {
499 ds_put_cstr(ds, "<empty>");
501 ds_put_format(ds, ",***%u leftover bytes***", left);
504 ds_put_cstr(ds, "<empty>");
509 put_nd_key(int n, const char *nd_target_s,
510 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
512 struct ovs_key_nd nd_key;
514 memset(&nd_key, 0, sizeof nd_key);
515 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
519 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
522 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
524 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
529 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
531 if (!strcasecmp(s, "no")) {
532 *type = OVS_FRAG_TYPE_NONE;
533 } else if (!strcasecmp(s, "first")) {
534 *type = OVS_FRAG_TYPE_FIRST;
535 } else if (!strcasecmp(s, "later")) {
536 *type = OVS_FRAG_TYPE_LATER;
544 parse_odp_key_attr(const char *s, struct ofpbuf *key)
546 /* Many of the sscanf calls in this function use oversized destination
547 * fields because some sscanf() implementations truncate the range of %i
548 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
549 * value of 0x7fff. The other alternatives are to allow only a single
550 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
553 * The tun_id parser has to use an alternative approach because there is no
554 * type larger than 64 bits. */
557 unsigned long long int priority;
560 if (sscanf(s, "priority(%lli)%n", &priority, &n) > 0 && n > 0) {
561 nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
570 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
571 tun_id_s, &n) > 0 && n > 0) {
572 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
573 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
579 unsigned long long int in_port;
582 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
583 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
589 struct ovs_key_ethernet eth_key;
593 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
594 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
595 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
596 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
597 ð_key, sizeof eth_key);
603 uint16_t tpid = ETH_TYPE_VLAN;
608 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n",
609 &vid, &pcp, &n) > 0 && n > 0) ||
610 (sscanf(s, "vlan(tpid=%"SCNi16",vid=%"SCNi16",pcp=%i)%n",
611 &tpid, &vid, &pcp, &n) > 0 && n > 0)) {
612 struct ovs_key_8021q q_key;
614 q_key.q_tpid = htons(tpid);
615 q_key.q_tci = htons((vid << VLAN_VID_SHIFT) |
616 (pcp << VLAN_PCP_SHIFT));
617 nl_msg_put_unspec(key, OVS_KEY_ATTR_8021Q, &q_key, sizeof q_key);
626 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
627 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
639 enum ovs_frag_type ipv4_frag;
642 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
643 "proto=%i,tos=%i,ttl=%i,frag=%7[a-z])%n",
644 IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
645 &ipv4_proto, &ipv4_tos, &ipv4_ttl, frag, &n) > 0
647 && ovs_frag_type_from_string(frag, &ipv4_frag)) {
648 struct ovs_key_ipv4 ipv4_key;
650 ipv4_key.ipv4_src = ipv4_src;
651 ipv4_key.ipv4_dst = ipv4_dst;
652 ipv4_key.ipv4_proto = ipv4_proto;
653 ipv4_key.ipv4_tos = ipv4_tos;
654 ipv4_key.ipv4_ttl = ipv4_ttl;
655 ipv4_key.ipv4_frag = ipv4_frag;
656 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
657 &ipv4_key, sizeof ipv4_key);
663 char ipv6_src_s[IPV6_SCAN_LEN + 1];
664 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
670 enum ovs_frag_type ipv6_frag;
673 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
674 "label=%i,proto=%i,tclass=%i,hlimit=%i,frag=%7[a-z])%n",
675 ipv6_src_s, ipv6_dst_s, &ipv6_label,
676 &ipv6_proto, &ipv6_tclass, &ipv6_hlimit, frag, &n) > 0
678 && ovs_frag_type_from_string(frag, &ipv6_frag)) {
679 struct ovs_key_ipv6 ipv6_key;
681 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
682 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
685 ipv6_key.ipv6_label = htonl(ipv6_label);
686 ipv6_key.ipv6_proto = ipv6_proto;
687 ipv6_key.ipv6_tclass = ipv6_tclass;
688 ipv6_key.ipv6_hlimit = ipv6_hlimit;
689 ipv6_key.ipv6_frag = ipv6_frag;
690 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
691 &ipv6_key, sizeof ipv6_key);
701 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
703 struct ovs_key_tcp tcp_key;
705 tcp_key.tcp_src = htons(tcp_src);
706 tcp_key.tcp_dst = htons(tcp_dst);
707 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
717 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
719 struct ovs_key_udp udp_key;
721 udp_key.udp_src = htons(udp_src);
722 udp_key.udp_dst = htons(udp_dst);
723 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
733 if (sscanf(s, "icmp(type=%i,code=%i)%n",
734 &icmp_type, &icmp_code, &n) > 0
736 struct ovs_key_icmp icmp_key;
738 icmp_key.icmp_type = icmp_type;
739 icmp_key.icmp_code = icmp_code;
740 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
741 &icmp_key, sizeof icmp_key);
747 struct ovs_key_icmpv6 icmpv6_key;
750 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
751 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
753 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
754 &icmpv6_key, sizeof icmpv6_key);
763 uint8_t arp_sha[ETH_ADDR_LEN];
764 uint8_t arp_tha[ETH_ADDR_LEN];
767 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
768 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
769 IP_SCAN_ARGS(&arp_sip),
770 IP_SCAN_ARGS(&arp_tip),
772 ETH_ADDR_SCAN_ARGS(arp_sha),
773 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
774 struct ovs_key_arp arp_key;
776 memset(&arp_key, 0, sizeof arp_key);
777 arp_key.arp_sip = arp_sip;
778 arp_key.arp_tip = arp_tip;
779 arp_key.arp_op = htons(arp_op);
780 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
781 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
782 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
788 char nd_target_s[IPV6_SCAN_LEN + 1];
789 uint8_t nd_sll[ETH_ADDR_LEN];
790 uint8_t nd_tll[ETH_ADDR_LEN];
793 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
794 nd_target_s, &n) > 0 && n > 0) {
795 return put_nd_key(n, nd_target_s, NULL, NULL, key);
797 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
798 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
800 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
802 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
803 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
805 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
807 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
808 "tll="ETH_ADDR_SCAN_FMT")%n",
809 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
810 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
812 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
819 /* Parses the string representation of a datapath flow key, in the
820 * format output by odp_flow_key_format(). Returns 0 if successful,
821 * otherwise a positive errno value. On success, the flow key is
822 * appended to 'key' as a series of Netlink attributes. On failure, no
823 * data is appended to 'key'. Either way, 'key''s data might be
826 * On success, the attributes appended to 'key' are individually syntactically
827 * valid, but they may not be valid as a sequence. 'key' might, for example,
828 * be missing an "in_port" key, have duplicated keys, or have keys in the wrong
829 * order. odp_flow_key_to_flow() will detect those errors. */
831 odp_flow_key_from_string(const char *s, struct ofpbuf *key)
833 const size_t old_size = key->size;
837 s += strspn(s, ", \t\r\n");
842 retval = parse_odp_key_attr(s, key);
844 key->size = old_size;
854 ovs_to_odp_frag(uint8_t ovs_frag)
856 return (ovs_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
857 : ovs_frag & FLOW_NW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
858 : OVS_FRAG_TYPE_NONE);
861 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
863 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
865 struct ovs_key_ethernet *eth_key;
867 if (flow->priority) {
868 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, flow->priority);
871 if (flow->tun_id != htonll(0)) {
872 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
875 if (flow->in_port != OFPP_NONE) {
876 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
877 ofp_port_to_odp_port(flow->in_port));
880 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
882 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
883 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
885 if (flow->vlan_tci != htons(0)) {
886 struct ovs_key_8021q *q_key;
888 q_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_8021Q,
890 q_key->q_tpid = htons(ETH_TYPE_VLAN);
891 q_key->q_tci = flow->vlan_tci & ~htons(VLAN_CFI);
894 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
898 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
900 if (flow->dl_type == htons(ETH_TYPE_IP)) {
901 struct ovs_key_ipv4 *ipv4_key;
903 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
905 ipv4_key->ipv4_src = flow->nw_src;
906 ipv4_key->ipv4_dst = flow->nw_dst;
907 ipv4_key->ipv4_proto = flow->nw_proto;
908 ipv4_key->ipv4_tos = flow->nw_tos;
909 ipv4_key->ipv4_ttl = flow->nw_ttl;
910 ipv4_key->ipv4_frag = ovs_to_odp_frag(flow->nw_frag);
911 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
912 struct ovs_key_ipv6 *ipv6_key;
914 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
916 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
917 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
918 ipv6_key->ipv6_label = flow->ipv6_label;
919 ipv6_key->ipv6_proto = flow->nw_proto;
920 ipv6_key->ipv6_tclass = flow->nw_tos;
921 ipv6_key->ipv6_hlimit = flow->nw_ttl;
922 ipv6_key->ipv6_frag = ovs_to_odp_frag(flow->nw_frag);
923 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
924 struct ovs_key_arp *arp_key;
926 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
928 memset(arp_key, 0, sizeof *arp_key);
929 arp_key->arp_sip = flow->nw_src;
930 arp_key->arp_tip = flow->nw_dst;
931 arp_key->arp_op = htons(flow->nw_proto);
932 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
933 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
936 if ((flow->dl_type == htons(ETH_TYPE_IP)
937 || flow->dl_type == htons(ETH_TYPE_IPV6))
938 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
940 if (flow->nw_proto == IPPROTO_TCP) {
941 struct ovs_key_tcp *tcp_key;
943 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
945 tcp_key->tcp_src = flow->tp_src;
946 tcp_key->tcp_dst = flow->tp_dst;
947 } else if (flow->nw_proto == IPPROTO_UDP) {
948 struct ovs_key_udp *udp_key;
950 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
952 udp_key->udp_src = flow->tp_src;
953 udp_key->udp_dst = flow->tp_dst;
954 } else if (flow->dl_type == htons(ETH_TYPE_IP)
955 && flow->nw_proto == IPPROTO_ICMP) {
956 struct ovs_key_icmp *icmp_key;
958 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
960 icmp_key->icmp_type = ntohs(flow->tp_src);
961 icmp_key->icmp_code = ntohs(flow->tp_dst);
962 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
963 && flow->nw_proto == IPPROTO_ICMPV6) {
964 struct ovs_key_icmpv6 *icmpv6_key;
966 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
968 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
969 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
971 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
972 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
973 struct ovs_key_nd *nd_key;
975 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
977 memcpy(nd_key->nd_target, &flow->nd_target,
978 sizeof nd_key->nd_target);
979 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
980 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
987 odp_to_ovs_frag(uint8_t odp_frag, struct flow *flow)
989 if (odp_frag > OVS_FRAG_TYPE_LATER) {
993 if (odp_frag != OVS_FRAG_TYPE_NONE) {
994 flow->nw_frag |= FLOW_NW_FRAG_ANY;
995 if (odp_frag == OVS_FRAG_TYPE_LATER) {
996 flow->nw_frag |= FLOW_NW_FRAG_LATER;
1002 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
1003 * structure in 'flow'. Returns 0 if successful, otherwise EINVAL. */
1005 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
1008 const struct nlattr *nla;
1009 enum ovs_key_attr prev_type;
1012 memset(flow, 0, sizeof *flow);
1013 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
1014 flow->in_port = OFPP_NONE;
1016 prev_type = OVS_KEY_ATTR_UNSPEC;
1017 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
1018 const struct ovs_key_ethernet *eth_key;
1019 const struct ovs_key_8021q *q_key;
1020 const struct ovs_key_ipv4 *ipv4_key;
1021 const struct ovs_key_ipv6 *ipv6_key;
1022 const struct ovs_key_tcp *tcp_key;
1023 const struct ovs_key_udp *udp_key;
1024 const struct ovs_key_icmp *icmp_key;
1025 const struct ovs_key_icmpv6 *icmpv6_key;
1026 const struct ovs_key_arp *arp_key;
1027 const struct ovs_key_nd *nd_key;
1029 uint16_t type = nl_attr_type(nla);
1030 int len = odp_flow_key_attr_len(type);
1032 if (nl_attr_get_size(nla) != len && len != -1) {
1036 #define TRANSITION(PREV_TYPE, TYPE) (((PREV_TYPE) << 16) | (TYPE))
1037 switch (TRANSITION(prev_type, type)) {
1038 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_PRIORITY):
1039 flow->priority = nl_attr_get_u32(nla);
1042 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_TUN_ID):
1043 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_TUN_ID):
1044 flow->tun_id = nl_attr_get_be64(nla);
1047 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_IN_PORT):
1048 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_IN_PORT):
1049 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_IN_PORT):
1050 if (nl_attr_get_u32(nla) >= UINT16_MAX) {
1053 flow->in_port = odp_port_to_ofp_port(nl_attr_get_u32(nla));
1056 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_ETHERNET):
1057 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_ETHERNET):
1058 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_ETHERNET):
1059 case TRANSITION(OVS_KEY_ATTR_IN_PORT, OVS_KEY_ATTR_ETHERNET):
1060 eth_key = nl_attr_get(nla);
1061 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
1062 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
1065 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_8021Q):
1066 q_key = nl_attr_get(nla);
1067 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
1068 /* Only standard 0x8100 VLANs currently supported. */
1071 if (q_key->q_tci & htons(VLAN_CFI)) {
1074 flow->vlan_tci = q_key->q_tci | htons(VLAN_CFI);
1077 case TRANSITION(OVS_KEY_ATTR_8021Q, OVS_KEY_ATTR_ETHERTYPE):
1078 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_ETHERTYPE):
1079 flow->dl_type = nl_attr_get_be16(nla);
1080 if (ntohs(flow->dl_type) < 1536) {
1085 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV4):
1086 if (flow->dl_type != htons(ETH_TYPE_IP)) {
1089 ipv4_key = nl_attr_get(nla);
1090 flow->nw_src = ipv4_key->ipv4_src;
1091 flow->nw_dst = ipv4_key->ipv4_dst;
1092 flow->nw_proto = ipv4_key->ipv4_proto;
1093 flow->nw_tos = ipv4_key->ipv4_tos;
1094 flow->nw_ttl = ipv4_key->ipv4_ttl;
1095 if (!odp_to_ovs_frag(ipv4_key->ipv4_frag, flow)) {
1100 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV6):
1101 if (flow->dl_type != htons(ETH_TYPE_IPV6)) {
1104 ipv6_key = nl_attr_get(nla);
1105 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
1106 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
1107 flow->ipv6_label = ipv6_key->ipv6_label;
1108 flow->nw_proto = ipv6_key->ipv6_proto;
1109 flow->nw_tos = ipv6_key->ipv6_tclass;
1110 flow->nw_ttl = ipv6_key->ipv6_hlimit;
1111 if (!odp_to_ovs_frag(ipv6_key->ipv6_frag, flow)) {
1116 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_TCP):
1117 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_TCP):
1118 if (flow->nw_proto != IPPROTO_TCP) {
1121 tcp_key = nl_attr_get(nla);
1122 flow->tp_src = tcp_key->tcp_src;
1123 flow->tp_dst = tcp_key->tcp_dst;
1126 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_UDP):
1127 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_UDP):
1128 if (flow->nw_proto != IPPROTO_UDP) {
1131 udp_key = nl_attr_get(nla);
1132 flow->tp_src = udp_key->udp_src;
1133 flow->tp_dst = udp_key->udp_dst;
1136 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_ICMP):
1137 if (flow->nw_proto != IPPROTO_ICMP) {
1140 icmp_key = nl_attr_get(nla);
1141 flow->tp_src = htons(icmp_key->icmp_type);
1142 flow->tp_dst = htons(icmp_key->icmp_code);
1145 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_ICMPV6):
1146 if (flow->nw_proto != IPPROTO_ICMPV6) {
1149 icmpv6_key = nl_attr_get(nla);
1150 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1151 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1154 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_ARP):
1155 if (flow->dl_type != htons(ETH_TYPE_ARP)) {
1158 arp_key = nl_attr_get(nla);
1159 flow->nw_src = arp_key->arp_sip;
1160 flow->nw_dst = arp_key->arp_tip;
1161 if (arp_key->arp_op & htons(0xff00)) {
1164 flow->nw_proto = ntohs(arp_key->arp_op);
1165 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1166 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1169 case TRANSITION(OVS_KEY_ATTR_ICMPV6, OVS_KEY_ATTR_ND):
1170 if (flow->tp_src != htons(ND_NEIGHBOR_SOLICIT)
1171 && flow->tp_src != htons(ND_NEIGHBOR_ADVERT)) {
1174 nd_key = nl_attr_get(nla);
1175 memcpy(&flow->nd_target, nd_key->nd_target, sizeof flow->nd_target);
1176 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1177 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1190 switch (prev_type) {
1191 case OVS_KEY_ATTR_UNSPEC:
1194 case OVS_KEY_ATTR_PRIORITY:
1195 case OVS_KEY_ATTR_TUN_ID:
1196 case OVS_KEY_ATTR_IN_PORT:
1199 case OVS_KEY_ATTR_ETHERNET:
1200 case OVS_KEY_ATTR_8021Q:
1203 case OVS_KEY_ATTR_ETHERTYPE:
1204 if (flow->dl_type == htons(ETH_TYPE_IP)
1205 || flow->dl_type == htons(ETH_TYPE_IPV6)
1206 || flow->dl_type == htons(ETH_TYPE_ARP)) {
1211 case OVS_KEY_ATTR_IPV4:
1212 if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1215 if (flow->nw_proto == IPPROTO_TCP
1216 || flow->nw_proto == IPPROTO_UDP
1217 || flow->nw_proto == IPPROTO_ICMP) {
1222 case OVS_KEY_ATTR_IPV6:
1223 if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1226 if (flow->nw_proto == IPPROTO_TCP
1227 || flow->nw_proto == IPPROTO_UDP
1228 || flow->nw_proto == IPPROTO_ICMPV6) {
1233 case OVS_KEY_ATTR_ICMPV6:
1234 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
1235 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT)
1236 || flow->nw_frag & FLOW_NW_FRAG_LATER) {
1241 case OVS_KEY_ATTR_TCP:
1242 case OVS_KEY_ATTR_UDP:
1243 case OVS_KEY_ATTR_ICMP:
1244 case OVS_KEY_ATTR_ND:
1245 if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1250 case OVS_KEY_ATTR_ARP:
1253 case __OVS_KEY_ATTR_MAX: