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/icmp6.h>
25 #include "byte-order.h"
27 #include "dynamic-string.h"
31 #include "openvswitch/tunnel.h"
37 format_odp_key_attr(const struct nlattr *a, struct ds *ds);
39 /* The interface between userspace and kernel uses an "OVS_*" prefix.
40 * Since this is fairly non-specific for the OVS userspace components,
41 * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
42 * interactions with the datapath.
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_SET_PRIORITY: return 4;
68 case OVS_ACTION_ATTR_POP_PRIORITY: return 0;
69 case OVS_ACTION_ATTR_SAMPLE: return -2;
71 case OVS_ACTION_ATTR_UNSPEC:
72 case __OVS_ACTION_ATTR_MAX:
80 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
82 size_t len = nl_attr_get_size(a);
84 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
86 const uint8_t *unspec;
89 unspec = nl_attr_get(a);
90 for (i = 0; i < len; i++) {
91 ds_put_char(ds, i ? ' ': '(');
92 ds_put_format(ds, "%02x", unspec[i]);
99 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
101 static const struct nl_policy ovs_sample_policy[] = {
102 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
103 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
105 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
107 const struct nlattr *nla_acts;
110 ds_put_cstr(ds, "sample");
112 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
113 ds_put_cstr(ds, "(error)");
117 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
120 ds_put_format(ds, "(sample=%.1f%%,", percentage);
122 ds_put_cstr(ds, "actions(");
123 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
124 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
125 format_odp_actions(ds, nla_acts, len);
126 ds_put_format(ds, "))");
130 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
132 static const struct nl_policy ovs_userspace_policy[] = {
133 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
134 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
136 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
138 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
139 ds_put_cstr(ds, "userspace(error)");
143 ds_put_format(ds, "userspace(pid=%"PRIu32,
144 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
146 if (a[OVS_USERSPACE_ATTR_USERDATA]) {
147 uint64_t userdata = nl_attr_get_u64(a[OVS_USERSPACE_ATTR_USERDATA]);
148 struct user_action_cookie cookie;
150 memcpy(&cookie, &userdata, sizeof cookie);
152 if (cookie.type == USER_ACTION_COOKIE_CONTROLLER) {
153 ds_put_format(ds, ",controller,length=%"PRIu32,
155 } else if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
156 ds_put_format(ds, ",sFlow,n_output=%"PRIu8","
157 "vid=%"PRIu16",pcp=%"PRIu8",ifindex=%"PRIu32,
158 cookie.n_output, vlan_tci_to_vid(cookie.vlan_tci),
159 vlan_tci_to_pcp(cookie.vlan_tci), cookie.data);
161 ds_put_format(ds, ",userdata=0x%"PRIx64, userdata);
165 ds_put_char(ds, ')');
170 format_odp_action(struct ds *ds, const struct nlattr *a)
173 enum ovs_action_attr type = nl_attr_type(a);
175 expected_len = odp_action_len(nl_attr_type(a));
176 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
177 ds_put_format(ds, "bad length %zu, expected %d for: ",
178 nl_attr_get_size(a), expected_len);
179 format_generic_odp_action(ds, a);
185 case OVS_ACTION_ATTR_OUTPUT:
186 ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
188 case OVS_ACTION_ATTR_USERSPACE:
189 format_odp_userspace_action(ds, a);
191 case OVS_ACTION_ATTR_SET:
192 ds_put_cstr(ds, "set(");
193 format_odp_key_attr(nl_attr_get(a), ds);
194 ds_put_cstr(ds, ")");
196 case OVS_ACTION_ATTR_PUSH:
197 ds_put_cstr(ds, "push(");
198 format_odp_key_attr(nl_attr_get(a), ds);
199 ds_put_cstr(ds, ")");
201 case OVS_ACTION_ATTR_POP:
202 if (nl_attr_get_u16(a) == OVS_KEY_ATTR_8021Q) {
203 ds_put_cstr(ds, "pop(vlan)");
205 ds_put_format(ds, "pop(key%"PRIu16")", nl_attr_get_u16(a));
208 case OVS_ACTION_ATTR_SET_PRIORITY:
209 ds_put_format(ds, "set_priority(%#"PRIx32")", nl_attr_get_u32(a));
211 case OVS_ACTION_ATTR_POP_PRIORITY:
212 ds_put_cstr(ds, "pop_priority");
214 case OVS_ACTION_ATTR_SAMPLE:
215 format_odp_sample_action(ds, a);
217 case OVS_ACTION_ATTR_UNSPEC:
218 case __OVS_ACTION_ATTR_MAX:
220 format_generic_odp_action(ds, a);
226 format_odp_actions(struct ds *ds, const struct nlattr *actions,
230 const struct nlattr *a;
233 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
235 ds_put_char(ds, ',');
237 format_odp_action(ds, a);
240 if (left == actions_len) {
241 ds_put_cstr(ds, "<empty>");
243 ds_put_format(ds, ",***%u leftover bytes***", left);
246 ds_put_cstr(ds, "drop");
250 /* Returns the correct length of the payload for a flow key attribute of the
251 * specified 'type', or -1 if 'type' is unknown. */
253 odp_flow_key_attr_len(uint16_t type)
255 if (type > OVS_KEY_ATTR_MAX) {
259 switch ((enum ovs_key_attr) type) {
260 case OVS_KEY_ATTR_TUN_ID: return 8;
261 case OVS_KEY_ATTR_IN_PORT: return 4;
262 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
263 case OVS_KEY_ATTR_8021Q: return sizeof(struct ovs_key_8021q);
264 case OVS_KEY_ATTR_ETHERTYPE: return 2;
265 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
266 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
267 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
268 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
269 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
270 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
271 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
272 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
274 case OVS_KEY_ATTR_UNSPEC:
275 case __OVS_KEY_ATTR_MAX:
284 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
286 size_t len = nl_attr_get_size(a);
288 ds_put_format(ds, "key%"PRId16, nl_attr_type(a));
290 const uint8_t *unspec;
293 unspec = nl_attr_get(a);
294 for (i = 0; i < len; i++) {
295 ds_put_char(ds, i ? ' ': '(');
296 ds_put_format(ds, "%02x", unspec[i]);
298 ds_put_char(ds, ')');
303 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
305 const struct ovs_key_ethernet *eth_key;
306 const struct ovs_key_8021q *q_key;
307 const struct ovs_key_ipv4 *ipv4_key;
308 const struct ovs_key_ipv6 *ipv6_key;
309 const struct ovs_key_tcp *tcp_key;
310 const struct ovs_key_udp *udp_key;
311 const struct ovs_key_icmp *icmp_key;
312 const struct ovs_key_icmpv6 *icmpv6_key;
313 const struct ovs_key_arp *arp_key;
314 const struct ovs_key_nd *nd_key;
316 if (nl_attr_get_size(a) != odp_flow_key_attr_len(nl_attr_type(a))) {
317 ds_put_format(ds, "bad length %zu, expected %d for: ",
319 odp_flow_key_attr_len(nl_attr_type(a)));
320 format_generic_odp_key(a, ds);
324 switch (nl_attr_type(a)) {
325 case OVS_KEY_ATTR_TUN_ID:
326 ds_put_format(ds, "tun_id(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
329 case OVS_KEY_ATTR_IN_PORT:
330 ds_put_format(ds, "in_port(%"PRIu32")", nl_attr_get_u32(a));
333 case OVS_KEY_ATTR_ETHERNET:
334 eth_key = nl_attr_get(a);
335 ds_put_format(ds, "eth(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
336 ETH_ADDR_ARGS(eth_key->eth_src),
337 ETH_ADDR_ARGS(eth_key->eth_dst));
340 case OVS_KEY_ATTR_8021Q:
341 q_key = nl_attr_get(a);
342 ds_put_cstr(ds, "vlan(");
343 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
344 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(q_key->q_tpid));
346 ds_put_format(ds, "vid=%"PRIu16",pcp=%d)",
347 vlan_tci_to_vid(q_key->q_tci),
348 vlan_tci_to_pcp(q_key->q_tci));
351 case OVS_KEY_ATTR_ETHERTYPE:
352 ds_put_format(ds, "eth_type(0x%04"PRIx16")",
353 ntohs(nl_attr_get_be16(a)));
356 case OVS_KEY_ATTR_IPV4:
357 ipv4_key = nl_attr_get(a);
358 ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT","
359 "proto=%"PRId8",tos=%"PRIu8")",
360 IP_ARGS(&ipv4_key->ipv4_src),
361 IP_ARGS(&ipv4_key->ipv4_dst),
362 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos);
365 case OVS_KEY_ATTR_IPV6: {
366 char src_str[INET6_ADDRSTRLEN];
367 char dst_str[INET6_ADDRSTRLEN];
369 ipv6_key = nl_attr_get(a);
370 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
371 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
373 ds_put_format(ds, "ipv6(src=%s,dst=%s,proto=%"PRId8",tos=%"PRIu8")",
374 src_str, dst_str, ipv6_key->ipv6_proto,
379 case OVS_KEY_ATTR_TCP:
380 tcp_key = nl_attr_get(a);
381 ds_put_format(ds, "tcp(src=%"PRIu16",dst=%"PRIu16")",
382 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
385 case OVS_KEY_ATTR_UDP:
386 udp_key = nl_attr_get(a);
387 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16")",
388 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
391 case OVS_KEY_ATTR_ICMP:
392 icmp_key = nl_attr_get(a);
393 ds_put_format(ds, "icmp(type=%"PRIu8",code=%"PRIu8")",
394 icmp_key->icmp_type, icmp_key->icmp_code);
397 case OVS_KEY_ATTR_ICMPV6:
398 icmpv6_key = nl_attr_get(a);
399 ds_put_format(ds, "icmpv6(type=%"PRIu8",code=%"PRIu8")",
400 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
403 case OVS_KEY_ATTR_ARP:
404 arp_key = nl_attr_get(a);
405 ds_put_format(ds, "arp(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
406 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
407 IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
408 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
409 ETH_ADDR_ARGS(arp_key->arp_tha));
412 case OVS_KEY_ATTR_ND: {
413 char target[INET6_ADDRSTRLEN];
415 nd_key = nl_attr_get(a);
416 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
418 ds_put_format(ds, "nd(target=%s", target);
419 if (!eth_addr_is_zero(nd_key->nd_sll)) {
420 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
421 ETH_ADDR_ARGS(nd_key->nd_sll));
423 if (!eth_addr_is_zero(nd_key->nd_tll)) {
424 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
425 ETH_ADDR_ARGS(nd_key->nd_tll));
427 ds_put_char(ds, ')');
432 format_generic_odp_key(a, ds);
437 /* Appends to 'ds' a string representation of the 'key_len' bytes of
438 * OVS_KEY_ATTR_* attributes in 'key'. */
440 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
443 const struct nlattr *a;
446 NL_ATTR_FOR_EACH (a, left, key, key_len) {
448 ds_put_char(ds, ',');
450 format_odp_key_attr(a, ds);
453 if (left == key_len) {
454 ds_put_cstr(ds, "<empty>");
456 ds_put_format(ds, ",***%u leftover bytes***", left);
459 ds_put_cstr(ds, "<empty>");
464 put_nd_key(int n, const char *nd_target_s,
465 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
467 struct ovs_key_nd nd_key;
469 memset(&nd_key, 0, sizeof nd_key);
470 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
474 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
477 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
479 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
484 parse_odp_key_attr(const char *s, struct ofpbuf *key)
486 /* Many of the sscanf calls in this function use oversized destination
487 * fields because some sscanf() implementations truncate the range of %i
488 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
489 * value of 0x7fff. The other alternatives are to allow only a single
490 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
493 * The tun_id parser has to use an alternative approach because there is no
494 * type larger than 64 bits. */
500 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
501 tun_id_s, &n) > 0 && n > 0) {
502 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
503 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
509 unsigned long long int in_port;
512 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
513 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
519 struct ovs_key_ethernet eth_key;
523 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
524 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
525 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
526 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
527 ð_key, sizeof eth_key);
533 uint16_t tpid = ETH_TYPE_VLAN;
538 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n",
539 &vid, &pcp, &n) > 0 && n > 0) ||
540 (sscanf(s, "vlan(tpid=%"SCNi16",vid=%"SCNi16",pcp=%i)%n",
541 &tpid, &vid, &pcp, &n) > 0 && n > 0)) {
542 struct ovs_key_8021q q_key;
544 q_key.q_tpid = htons(tpid);
545 q_key.q_tci = htons((vid << VLAN_VID_SHIFT) |
546 (pcp << VLAN_PCP_SHIFT));
547 nl_msg_put_unspec(key, OVS_KEY_ATTR_8021Q, &q_key, sizeof q_key);
556 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
557 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
569 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
570 "proto=%i,tos=%i)%n",
571 IP_SCAN_ARGS(&ipv4_src),
572 IP_SCAN_ARGS(&ipv4_dst), &ipv4_proto, &ipv4_tos, &n) > 0
574 struct ovs_key_ipv4 ipv4_key;
576 memset(&ipv4_key, 0, sizeof ipv4_key);
577 ipv4_key.ipv4_src = ipv4_src;
578 ipv4_key.ipv4_dst = ipv4_dst;
579 ipv4_key.ipv4_proto = ipv4_proto;
580 ipv4_key.ipv4_tos = ipv4_tos;
581 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
582 &ipv4_key, sizeof ipv4_key);
588 char ipv6_src_s[IPV6_SCAN_LEN + 1];
589 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
594 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
595 "proto=%i,tos=%i)%n",
596 ipv6_src_s, ipv6_dst_s,
597 &ipv6_proto, &ipv6_tos, &n) > 0 && n > 0) {
598 struct ovs_key_ipv6 ipv6_key;
600 memset(&ipv6_key, 0, sizeof ipv6_key);
601 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
602 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
605 ipv6_key.ipv6_proto = ipv6_proto;
606 ipv6_key.ipv6_tos = ipv6_tos;
607 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
608 &ipv6_key, sizeof ipv6_key);
618 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
620 struct ovs_key_tcp tcp_key;
622 tcp_key.tcp_src = htons(tcp_src);
623 tcp_key.tcp_dst = htons(tcp_dst);
624 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
634 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
636 struct ovs_key_udp udp_key;
638 udp_key.udp_src = htons(udp_src);
639 udp_key.udp_dst = htons(udp_dst);
640 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
650 if (sscanf(s, "icmp(type=%i,code=%i)%n",
651 &icmp_type, &icmp_code, &n) > 0
653 struct ovs_key_icmp icmp_key;
655 icmp_key.icmp_type = icmp_type;
656 icmp_key.icmp_code = icmp_code;
657 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
658 &icmp_key, sizeof icmp_key);
664 struct ovs_key_icmpv6 icmpv6_key;
667 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
668 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
670 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
671 &icmpv6_key, sizeof icmpv6_key);
680 uint8_t arp_sha[ETH_ADDR_LEN];
681 uint8_t arp_tha[ETH_ADDR_LEN];
684 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
685 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
686 IP_SCAN_ARGS(&arp_sip),
687 IP_SCAN_ARGS(&arp_tip),
689 ETH_ADDR_SCAN_ARGS(arp_sha),
690 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
691 struct ovs_key_arp arp_key;
693 memset(&arp_key, 0, sizeof arp_key);
694 arp_key.arp_sip = arp_sip;
695 arp_key.arp_tip = arp_tip;
696 arp_key.arp_op = htons(arp_op);
697 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
698 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
699 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
705 char nd_target_s[IPV6_SCAN_LEN + 1];
706 uint8_t nd_sll[ETH_ADDR_LEN];
707 uint8_t nd_tll[ETH_ADDR_LEN];
710 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
711 nd_target_s, &n) > 0 && n > 0) {
712 return put_nd_key(n, nd_target_s, NULL, NULL, key);
714 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
715 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
717 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
719 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
720 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
722 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
724 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
725 "tll="ETH_ADDR_SCAN_FMT")%n",
726 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
727 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
729 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
736 /* Parses the string representation of a datapath flow key, in the
737 * format output by odp_flow_key_format(). Returns 0 if successful,
738 * otherwise a positive errno value. On success, the flow key is
739 * appended to 'key' as a series of Netlink attributes. On failure, no
740 * data is appended to 'key'. Either way, 'key''s data might be
743 * On success, the attributes appended to 'key' are individually syntactically
744 * valid, but they may not be valid as a sequence. 'key' might, for example,
745 * be missing an "in_port" key, have duplicated keys, or have keys in the wrong
746 * order. odp_flow_key_to_flow() will detect those errors. */
748 odp_flow_key_from_string(const char *s, struct ofpbuf *key)
750 const size_t old_size = key->size;
754 s += strspn(s, ", \t\r\n");
759 retval = parse_odp_key_attr(s, key);
761 key->size = old_size;
770 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
772 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
774 struct ovs_key_ethernet *eth_key;
776 if (flow->tun_id != htonll(0)) {
777 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
780 if (flow->in_port != OFPP_NONE) {
781 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
782 ofp_port_to_odp_port(flow->in_port));
785 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
787 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
788 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
790 if (flow->vlan_tci != htons(0)) {
791 struct ovs_key_8021q *q_key;
793 q_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_8021Q,
795 q_key->q_tpid = htons(ETH_TYPE_VLAN);
796 q_key->q_tci = flow->vlan_tci & ~htons(VLAN_CFI);
799 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
803 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
805 if (flow->dl_type == htons(ETH_TYPE_IP)) {
806 struct ovs_key_ipv4 *ipv4_key;
808 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
810 memset(ipv4_key, 0, sizeof *ipv4_key);
811 ipv4_key->ipv4_src = flow->nw_src;
812 ipv4_key->ipv4_dst = flow->nw_dst;
813 ipv4_key->ipv4_proto = flow->nw_proto;
814 ipv4_key->ipv4_tos = flow->nw_tos;
815 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
816 struct ovs_key_ipv6 *ipv6_key;
818 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
820 memset(ipv6_key, 0, sizeof *ipv6_key);
821 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
822 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
823 ipv6_key->ipv6_proto = flow->nw_proto;
824 ipv6_key->ipv6_tos = flow->nw_tos;
825 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
826 struct ovs_key_arp *arp_key;
828 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
830 memset(arp_key, 0, sizeof *arp_key);
831 arp_key->arp_sip = flow->nw_src;
832 arp_key->arp_tip = flow->nw_dst;
833 arp_key->arp_op = htons(flow->nw_proto);
834 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
835 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
838 if (flow->dl_type == htons(ETH_TYPE_IP)
839 || flow->dl_type == htons(ETH_TYPE_IPV6)) {
841 if (flow->nw_proto == IPPROTO_TCP) {
842 struct ovs_key_tcp *tcp_key;
844 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
846 tcp_key->tcp_src = flow->tp_src;
847 tcp_key->tcp_dst = flow->tp_dst;
848 } else if (flow->nw_proto == IPPROTO_UDP) {
849 struct ovs_key_udp *udp_key;
851 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
853 udp_key->udp_src = flow->tp_src;
854 udp_key->udp_dst = flow->tp_dst;
855 } else if (flow->dl_type == htons(ETH_TYPE_IP)
856 && flow->nw_proto == IPPROTO_ICMP) {
857 struct ovs_key_icmp *icmp_key;
859 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
861 icmp_key->icmp_type = ntohs(flow->tp_src);
862 icmp_key->icmp_code = ntohs(flow->tp_dst);
863 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
864 && flow->nw_proto == IPPROTO_ICMPV6) {
865 struct ovs_key_icmpv6 *icmpv6_key;
867 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
869 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
870 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
872 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
873 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
874 struct ovs_key_nd *nd_key;
876 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
878 memcpy(nd_key->nd_target, &flow->nd_target,
879 sizeof nd_key->nd_target);
880 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
881 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
887 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
888 * structure in 'flow'. Returns 0 if successful, otherwise EINVAL. */
890 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
893 const struct nlattr *nla;
894 enum ovs_key_attr prev_type;
897 memset(flow, 0, sizeof *flow);
898 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
899 flow->in_port = OFPP_NONE;
901 prev_type = OVS_KEY_ATTR_UNSPEC;
902 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
903 const struct ovs_key_ethernet *eth_key;
904 const struct ovs_key_8021q *q_key;
905 const struct ovs_key_ipv4 *ipv4_key;
906 const struct ovs_key_ipv6 *ipv6_key;
907 const struct ovs_key_tcp *tcp_key;
908 const struct ovs_key_udp *udp_key;
909 const struct ovs_key_icmp *icmp_key;
910 const struct ovs_key_icmpv6 *icmpv6_key;
911 const struct ovs_key_arp *arp_key;
912 const struct ovs_key_nd *nd_key;
914 uint16_t type = nl_attr_type(nla);
915 int len = odp_flow_key_attr_len(type);
917 if (nl_attr_get_size(nla) != len && len != -1) {
921 #define TRANSITION(PREV_TYPE, TYPE) (((PREV_TYPE) << 16) | (TYPE))
922 switch (TRANSITION(prev_type, type)) {
923 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_TUN_ID):
924 flow->tun_id = nl_attr_get_be64(nla);
927 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_IN_PORT):
928 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_IN_PORT):
929 if (nl_attr_get_u32(nla) >= UINT16_MAX) {
932 flow->in_port = odp_port_to_ofp_port(nl_attr_get_u32(nla));
935 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_ETHERNET):
936 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_ETHERNET):
937 case TRANSITION(OVS_KEY_ATTR_IN_PORT, OVS_KEY_ATTR_ETHERNET):
938 eth_key = nl_attr_get(nla);
939 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
940 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
943 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_8021Q):
944 q_key = nl_attr_get(nla);
945 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
946 /* Only standard 0x8100 VLANs currently supported. */
949 if (q_key->q_tci & htons(VLAN_CFI)) {
952 flow->vlan_tci = q_key->q_tci | htons(VLAN_CFI);
955 case TRANSITION(OVS_KEY_ATTR_8021Q, OVS_KEY_ATTR_ETHERTYPE):
956 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_ETHERTYPE):
957 flow->dl_type = nl_attr_get_be16(nla);
958 if (ntohs(flow->dl_type) < 1536) {
963 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV4):
964 if (flow->dl_type != htons(ETH_TYPE_IP)) {
967 ipv4_key = nl_attr_get(nla);
968 flow->nw_src = ipv4_key->ipv4_src;
969 flow->nw_dst = ipv4_key->ipv4_dst;
970 flow->nw_proto = ipv4_key->ipv4_proto;
971 flow->nw_tos = ipv4_key->ipv4_tos;
972 if (flow->nw_tos & IP_ECN_MASK) {
977 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV6):
978 if (flow->dl_type != htons(ETH_TYPE_IPV6)) {
981 ipv6_key = nl_attr_get(nla);
982 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
983 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
984 flow->nw_proto = ipv6_key->ipv6_proto;
985 flow->nw_tos = ipv6_key->ipv6_tos;
986 if (flow->nw_tos & IP_ECN_MASK) {
991 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_TCP):
992 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_TCP):
993 if (flow->nw_proto != IPPROTO_TCP) {
996 tcp_key = nl_attr_get(nla);
997 flow->tp_src = tcp_key->tcp_src;
998 flow->tp_dst = tcp_key->tcp_dst;
1001 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_UDP):
1002 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_UDP):
1003 if (flow->nw_proto != IPPROTO_UDP) {
1006 udp_key = nl_attr_get(nla);
1007 flow->tp_src = udp_key->udp_src;
1008 flow->tp_dst = udp_key->udp_dst;
1011 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_ICMP):
1012 if (flow->nw_proto != IPPROTO_ICMP) {
1015 icmp_key = nl_attr_get(nla);
1016 flow->tp_src = htons(icmp_key->icmp_type);
1017 flow->tp_dst = htons(icmp_key->icmp_code);
1020 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_ICMPV6):
1021 if (flow->nw_proto != IPPROTO_ICMPV6) {
1024 icmpv6_key = nl_attr_get(nla);
1025 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1026 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1029 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_ARP):
1030 if (flow->dl_type != htons(ETH_TYPE_ARP)) {
1033 arp_key = nl_attr_get(nla);
1034 flow->nw_src = arp_key->arp_sip;
1035 flow->nw_dst = arp_key->arp_tip;
1036 if (arp_key->arp_op & htons(0xff00)) {
1039 flow->nw_proto = ntohs(arp_key->arp_op);
1040 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1041 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1044 case TRANSITION(OVS_KEY_ATTR_ICMPV6, OVS_KEY_ATTR_ND):
1045 if (flow->tp_src != htons(ND_NEIGHBOR_SOLICIT)
1046 && flow->tp_src != htons(ND_NEIGHBOR_ADVERT)) {
1049 nd_key = nl_attr_get(nla);
1050 memcpy(&flow->nd_target, nd_key->nd_target, sizeof flow->nd_target);
1051 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1052 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1065 switch (prev_type) {
1066 case OVS_KEY_ATTR_UNSPEC:
1069 case OVS_KEY_ATTR_TUN_ID:
1070 case OVS_KEY_ATTR_IN_PORT:
1073 case OVS_KEY_ATTR_ETHERNET:
1074 case OVS_KEY_ATTR_8021Q:
1077 case OVS_KEY_ATTR_ETHERTYPE:
1078 if (flow->dl_type == htons(ETH_TYPE_IP)
1079 || flow->dl_type == htons(ETH_TYPE_IPV6)
1080 || flow->dl_type == htons(ETH_TYPE_ARP)) {
1085 case OVS_KEY_ATTR_IPV4:
1086 if (flow->nw_proto == IPPROTO_TCP
1087 || flow->nw_proto == IPPROTO_UDP
1088 || flow->nw_proto == IPPROTO_ICMP) {
1093 case OVS_KEY_ATTR_IPV6:
1094 if (flow->nw_proto == IPPROTO_TCP
1095 || flow->nw_proto == IPPROTO_UDP
1096 || flow->nw_proto == IPPROTO_ICMPV6) {
1101 case OVS_KEY_ATTR_ICMPV6:
1102 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
1103 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
1108 case OVS_KEY_ATTR_TCP:
1109 case OVS_KEY_ATTR_UDP:
1110 case OVS_KEY_ATTR_ICMP:
1111 case OVS_KEY_ATTR_ARP:
1112 case OVS_KEY_ATTR_ND:
1115 case __OVS_KEY_ATTR_MAX: