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"
38 format_odp_key_attr(const struct nlattr *a, struct ds *ds);
40 /* The interface between userspace and kernel uses an "OVS_*" prefix.
41 * Since this is fairly non-specific for the OVS userspace components,
42 * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
43 * interactions with the datapath.
46 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
49 * - For an action whose argument has a fixed length, returned that
50 * nonnegative length in bytes.
52 * - For an action with a variable-length argument, returns -2.
54 * - For an invalid 'type', returns -1. */
56 odp_action_len(uint16_t type)
58 if (type > OVS_ACTION_ATTR_MAX) {
62 switch ((enum ovs_action_attr) type) {
63 case OVS_ACTION_ATTR_OUTPUT: return 4;
64 case OVS_ACTION_ATTR_USERSPACE: return -2;
65 case OVS_ACTION_ATTR_PUSH: return -2;
66 case OVS_ACTION_ATTR_POP: return 2;
67 case OVS_ACTION_ATTR_SET: return -2;
68 case OVS_ACTION_ATTR_SET_PRIORITY: return 4;
69 case OVS_ACTION_ATTR_POP_PRIORITY: return 0;
70 case OVS_ACTION_ATTR_SAMPLE: return -2;
72 case OVS_ACTION_ATTR_UNSPEC:
73 case __OVS_ACTION_ATTR_MAX:
81 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
83 size_t len = nl_attr_get_size(a);
85 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
87 const uint8_t *unspec;
90 unspec = nl_attr_get(a);
91 for (i = 0; i < len; i++) {
92 ds_put_char(ds, i ? ' ': '(');
93 ds_put_format(ds, "%02x", unspec[i]);
100 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
102 static const struct nl_policy ovs_sample_policy[] = {
103 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
104 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
106 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
108 const struct nlattr *nla_acts;
111 ds_put_cstr(ds, "sample");
113 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
114 ds_put_cstr(ds, "(error)");
118 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
121 ds_put_format(ds, "(sample=%.1f%%,", percentage);
123 ds_put_cstr(ds, "actions(");
124 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
125 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
126 format_odp_actions(ds, nla_acts, len);
127 ds_put_format(ds, "))");
131 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
133 static const struct nl_policy ovs_userspace_policy[] = {
134 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
135 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
137 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
139 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
140 ds_put_cstr(ds, "userspace(error)");
144 ds_put_format(ds, "userspace(pid=%"PRIu32,
145 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
147 if (a[OVS_USERSPACE_ATTR_USERDATA]) {
148 uint64_t userdata = nl_attr_get_u64(a[OVS_USERSPACE_ATTR_USERDATA]);
149 struct user_action_cookie cookie;
151 memcpy(&cookie, &userdata, sizeof cookie);
153 if (cookie.type == USER_ACTION_COOKIE_CONTROLLER) {
154 ds_put_format(ds, ",controller,length=%"PRIu32,
156 } else if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
157 ds_put_format(ds, ",sFlow,n_output=%"PRIu8","
158 "vid=%"PRIu16",pcp=%"PRIu8",ifindex=%"PRIu32,
159 cookie.n_output, vlan_tci_to_vid(cookie.vlan_tci),
160 vlan_tci_to_pcp(cookie.vlan_tci), cookie.data);
162 ds_put_format(ds, ",userdata=0x%"PRIx64, userdata);
166 ds_put_char(ds, ')');
171 format_odp_action(struct ds *ds, const struct nlattr *a)
174 enum ovs_action_attr type = nl_attr_type(a);
176 expected_len = odp_action_len(nl_attr_type(a));
177 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
178 ds_put_format(ds, "bad length %zu, expected %d for: ",
179 nl_attr_get_size(a), expected_len);
180 format_generic_odp_action(ds, a);
186 case OVS_ACTION_ATTR_OUTPUT:
187 ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
189 case OVS_ACTION_ATTR_USERSPACE:
190 format_odp_userspace_action(ds, a);
192 case OVS_ACTION_ATTR_SET:
193 ds_put_cstr(ds, "set(");
194 format_odp_key_attr(nl_attr_get(a), ds);
195 ds_put_cstr(ds, ")");
197 case OVS_ACTION_ATTR_PUSH:
198 ds_put_cstr(ds, "push(");
199 format_odp_key_attr(nl_attr_get(a), ds);
200 ds_put_cstr(ds, ")");
202 case OVS_ACTION_ATTR_POP:
203 if (nl_attr_get_u16(a) == OVS_KEY_ATTR_8021Q) {
204 ds_put_cstr(ds, "pop(vlan)");
206 ds_put_format(ds, "pop(key%"PRIu16")", nl_attr_get_u16(a));
209 case OVS_ACTION_ATTR_SET_PRIORITY:
210 ds_put_format(ds, "set_priority(%#"PRIx32")", nl_attr_get_u32(a));
212 case OVS_ACTION_ATTR_POP_PRIORITY:
213 ds_put_cstr(ds, "pop_priority");
215 case OVS_ACTION_ATTR_SAMPLE:
216 format_odp_sample_action(ds, a);
218 case OVS_ACTION_ATTR_UNSPEC:
219 case __OVS_ACTION_ATTR_MAX:
221 format_generic_odp_action(ds, a);
227 format_odp_actions(struct ds *ds, const struct nlattr *actions,
231 const struct nlattr *a;
234 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
236 ds_put_char(ds, ',');
238 format_odp_action(ds, a);
241 if (left == actions_len) {
242 ds_put_cstr(ds, "<empty>");
244 ds_put_format(ds, ",***%u leftover bytes***", left);
247 ds_put_cstr(ds, "drop");
251 /* Returns the correct length of the payload for a flow key attribute of the
252 * specified 'type', or -1 if 'type' is unknown. */
254 odp_flow_key_attr_len(uint16_t type)
256 if (type > OVS_KEY_ATTR_MAX) {
260 switch ((enum ovs_key_attr) type) {
261 case OVS_KEY_ATTR_TUN_ID: return 8;
262 case OVS_KEY_ATTR_IN_PORT: return 4;
263 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
264 case OVS_KEY_ATTR_8021Q: return sizeof(struct ovs_key_8021q);
265 case OVS_KEY_ATTR_ETHERTYPE: return 2;
266 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
267 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
268 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
269 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
270 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
271 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
272 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
273 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
275 case OVS_KEY_ATTR_UNSPEC:
276 case __OVS_KEY_ATTR_MAX:
285 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
287 size_t len = nl_attr_get_size(a);
289 ds_put_format(ds, "key%"PRId16, nl_attr_type(a));
291 const uint8_t *unspec;
294 unspec = nl_attr_get(a);
295 for (i = 0; i < len; i++) {
296 ds_put_char(ds, i ? ' ': '(');
297 ds_put_format(ds, "%02x", unspec[i]);
299 ds_put_char(ds, ')');
304 ovs_frag_type_to_string(enum ovs_frag_type type)
307 case OVS_FRAG_TYPE_NONE:
309 case OVS_FRAG_TYPE_FIRST:
311 case OVS_FRAG_TYPE_LATER:
313 case __OVS_FRAG_TYPE_MAX:
320 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
322 const struct ovs_key_ethernet *eth_key;
323 const struct ovs_key_8021q *q_key;
324 const struct ovs_key_ipv4 *ipv4_key;
325 const struct ovs_key_ipv6 *ipv6_key;
326 const struct ovs_key_tcp *tcp_key;
327 const struct ovs_key_udp *udp_key;
328 const struct ovs_key_icmp *icmp_key;
329 const struct ovs_key_icmpv6 *icmpv6_key;
330 const struct ovs_key_arp *arp_key;
331 const struct ovs_key_nd *nd_key;
333 if (nl_attr_get_size(a) != odp_flow_key_attr_len(nl_attr_type(a))) {
334 ds_put_format(ds, "bad length %zu, expected %d for: ",
336 odp_flow_key_attr_len(nl_attr_type(a)));
337 format_generic_odp_key(a, ds);
341 switch (nl_attr_type(a)) {
342 case OVS_KEY_ATTR_TUN_ID:
343 ds_put_format(ds, "tun_id(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
346 case OVS_KEY_ATTR_IN_PORT:
347 ds_put_format(ds, "in_port(%"PRIu32")", nl_attr_get_u32(a));
350 case OVS_KEY_ATTR_ETHERNET:
351 eth_key = nl_attr_get(a);
352 ds_put_format(ds, "eth(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
353 ETH_ADDR_ARGS(eth_key->eth_src),
354 ETH_ADDR_ARGS(eth_key->eth_dst));
357 case OVS_KEY_ATTR_8021Q:
358 q_key = nl_attr_get(a);
359 ds_put_cstr(ds, "vlan(");
360 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
361 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(q_key->q_tpid));
363 ds_put_format(ds, "vid=%"PRIu16",pcp=%d)",
364 vlan_tci_to_vid(q_key->q_tci),
365 vlan_tci_to_pcp(q_key->q_tci));
368 case OVS_KEY_ATTR_ETHERTYPE:
369 ds_put_format(ds, "eth_type(0x%04"PRIx16")",
370 ntohs(nl_attr_get_be16(a)));
373 case OVS_KEY_ATTR_IPV4:
374 ipv4_key = nl_attr_get(a);
375 ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT","
376 "proto=%"PRId8",tos=%"PRIu8",frag=%s)",
377 IP_ARGS(&ipv4_key->ipv4_src),
378 IP_ARGS(&ipv4_key->ipv4_dst),
379 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
380 ovs_frag_type_to_string(ipv4_key->ipv4_frag));
383 case OVS_KEY_ATTR_IPV6: {
384 char src_str[INET6_ADDRSTRLEN];
385 char dst_str[INET6_ADDRSTRLEN];
387 ipv6_key = nl_attr_get(a);
388 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
389 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
391 ds_put_format(ds, "ipv6(src=%s,dst=%s,proto=%"PRId8",tos=%"PRIu8","
393 src_str, dst_str, ipv6_key->ipv6_proto,
395 ovs_frag_type_to_string(ipv6_key->ipv6_frag));
399 case OVS_KEY_ATTR_TCP:
400 tcp_key = nl_attr_get(a);
401 ds_put_format(ds, "tcp(src=%"PRIu16",dst=%"PRIu16")",
402 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
405 case OVS_KEY_ATTR_UDP:
406 udp_key = nl_attr_get(a);
407 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16")",
408 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
411 case OVS_KEY_ATTR_ICMP:
412 icmp_key = nl_attr_get(a);
413 ds_put_format(ds, "icmp(type=%"PRIu8",code=%"PRIu8")",
414 icmp_key->icmp_type, icmp_key->icmp_code);
417 case OVS_KEY_ATTR_ICMPV6:
418 icmpv6_key = nl_attr_get(a);
419 ds_put_format(ds, "icmpv6(type=%"PRIu8",code=%"PRIu8")",
420 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
423 case OVS_KEY_ATTR_ARP:
424 arp_key = nl_attr_get(a);
425 ds_put_format(ds, "arp(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
426 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
427 IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
428 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
429 ETH_ADDR_ARGS(arp_key->arp_tha));
432 case OVS_KEY_ATTR_ND: {
433 char target[INET6_ADDRSTRLEN];
435 nd_key = nl_attr_get(a);
436 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
438 ds_put_format(ds, "nd(target=%s", target);
439 if (!eth_addr_is_zero(nd_key->nd_sll)) {
440 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
441 ETH_ADDR_ARGS(nd_key->nd_sll));
443 if (!eth_addr_is_zero(nd_key->nd_tll)) {
444 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
445 ETH_ADDR_ARGS(nd_key->nd_tll));
447 ds_put_char(ds, ')');
452 format_generic_odp_key(a, ds);
457 /* Appends to 'ds' a string representation of the 'key_len' bytes of
458 * OVS_KEY_ATTR_* attributes in 'key'. */
460 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
463 const struct nlattr *a;
466 NL_ATTR_FOR_EACH (a, left, key, key_len) {
468 ds_put_char(ds, ',');
470 format_odp_key_attr(a, ds);
473 if (left == key_len) {
474 ds_put_cstr(ds, "<empty>");
476 ds_put_format(ds, ",***%u leftover bytes***", left);
479 ds_put_cstr(ds, "<empty>");
484 put_nd_key(int n, const char *nd_target_s,
485 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
487 struct ovs_key_nd nd_key;
489 memset(&nd_key, 0, sizeof nd_key);
490 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
494 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
497 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
499 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
504 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
506 if (!strcasecmp(s, "no")) {
507 *type = OVS_FRAG_TYPE_NONE;
508 } else if (!strcasecmp(s, "first")) {
509 *type = OVS_FRAG_TYPE_FIRST;
510 } else if (!strcasecmp(s, "later")) {
511 *type = OVS_FRAG_TYPE_LATER;
519 parse_odp_key_attr(const char *s, struct ofpbuf *key)
521 /* Many of the sscanf calls in this function use oversized destination
522 * fields because some sscanf() implementations truncate the range of %i
523 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
524 * value of 0x7fff. The other alternatives are to allow only a single
525 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
528 * The tun_id parser has to use an alternative approach because there is no
529 * type larger than 64 bits. */
535 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
536 tun_id_s, &n) > 0 && n > 0) {
537 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
538 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
544 unsigned long long int in_port;
547 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
548 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
554 struct ovs_key_ethernet eth_key;
558 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
559 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
560 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
561 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
562 ð_key, sizeof eth_key);
568 uint16_t tpid = ETH_TYPE_VLAN;
573 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n",
574 &vid, &pcp, &n) > 0 && n > 0) ||
575 (sscanf(s, "vlan(tpid=%"SCNi16",vid=%"SCNi16",pcp=%i)%n",
576 &tpid, &vid, &pcp, &n) > 0 && n > 0)) {
577 struct ovs_key_8021q q_key;
579 q_key.q_tpid = htons(tpid);
580 q_key.q_tci = htons((vid << VLAN_VID_SHIFT) |
581 (pcp << VLAN_PCP_SHIFT));
582 nl_msg_put_unspec(key, OVS_KEY_ATTR_8021Q, &q_key, sizeof q_key);
591 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
592 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
603 enum ovs_frag_type ipv4_frag;
606 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
607 "proto=%i,tos=%i,frag=%7[a-z])%n",
608 IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
609 &ipv4_proto, &ipv4_tos, frag, &n) > 0
611 && ovs_frag_type_from_string(frag, &ipv4_frag)) {
612 struct ovs_key_ipv4 ipv4_key;
614 memset(&ipv4_key, 0, sizeof ipv4_key);
615 ipv4_key.ipv4_src = ipv4_src;
616 ipv4_key.ipv4_dst = ipv4_dst;
617 ipv4_key.ipv4_proto = ipv4_proto;
618 ipv4_key.ipv4_tos = ipv4_tos;
619 ipv4_key.ipv4_frag = ipv4_frag;
620 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
621 &ipv4_key, sizeof ipv4_key);
627 char ipv6_src_s[IPV6_SCAN_LEN + 1];
628 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
632 enum ovs_frag_type ipv6_frag;
635 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
636 "proto=%i,tos=%i,frag=%7[a-z])%n",
637 ipv6_src_s, ipv6_dst_s,
638 &ipv6_proto, &ipv6_tos, frag, &n) > 0
640 && ovs_frag_type_from_string(frag, &ipv6_frag)) {
641 struct ovs_key_ipv6 ipv6_key;
643 memset(&ipv6_key, 0, sizeof ipv6_key);
644 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
645 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
648 ipv6_key.ipv6_proto = ipv6_proto;
649 ipv6_key.ipv6_tos = ipv6_tos;
650 ipv6_key.ipv6_frag = ipv6_frag;
651 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
652 &ipv6_key, sizeof ipv6_key);
662 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
664 struct ovs_key_tcp tcp_key;
666 tcp_key.tcp_src = htons(tcp_src);
667 tcp_key.tcp_dst = htons(tcp_dst);
668 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
678 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
680 struct ovs_key_udp udp_key;
682 udp_key.udp_src = htons(udp_src);
683 udp_key.udp_dst = htons(udp_dst);
684 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
694 if (sscanf(s, "icmp(type=%i,code=%i)%n",
695 &icmp_type, &icmp_code, &n) > 0
697 struct ovs_key_icmp icmp_key;
699 icmp_key.icmp_type = icmp_type;
700 icmp_key.icmp_code = icmp_code;
701 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
702 &icmp_key, sizeof icmp_key);
708 struct ovs_key_icmpv6 icmpv6_key;
711 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
712 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
714 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
715 &icmpv6_key, sizeof icmpv6_key);
724 uint8_t arp_sha[ETH_ADDR_LEN];
725 uint8_t arp_tha[ETH_ADDR_LEN];
728 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
729 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
730 IP_SCAN_ARGS(&arp_sip),
731 IP_SCAN_ARGS(&arp_tip),
733 ETH_ADDR_SCAN_ARGS(arp_sha),
734 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
735 struct ovs_key_arp arp_key;
737 memset(&arp_key, 0, sizeof arp_key);
738 arp_key.arp_sip = arp_sip;
739 arp_key.arp_tip = arp_tip;
740 arp_key.arp_op = htons(arp_op);
741 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
742 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
743 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
749 char nd_target_s[IPV6_SCAN_LEN + 1];
750 uint8_t nd_sll[ETH_ADDR_LEN];
751 uint8_t nd_tll[ETH_ADDR_LEN];
754 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
755 nd_target_s, &n) > 0 && n > 0) {
756 return put_nd_key(n, nd_target_s, NULL, NULL, key);
758 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
759 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
761 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
763 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
764 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
766 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
768 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
769 "tll="ETH_ADDR_SCAN_FMT")%n",
770 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
771 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
773 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
780 /* Parses the string representation of a datapath flow key, in the
781 * format output by odp_flow_key_format(). Returns 0 if successful,
782 * otherwise a positive errno value. On success, the flow key is
783 * appended to 'key' as a series of Netlink attributes. On failure, no
784 * data is appended to 'key'. Either way, 'key''s data might be
787 * On success, the attributes appended to 'key' are individually syntactically
788 * valid, but they may not be valid as a sequence. 'key' might, for example,
789 * be missing an "in_port" key, have duplicated keys, or have keys in the wrong
790 * order. odp_flow_key_to_flow() will detect those errors. */
792 odp_flow_key_from_string(const char *s, struct ofpbuf *key)
794 const size_t old_size = key->size;
798 s += strspn(s, ", \t\r\n");
803 retval = parse_odp_key_attr(s, key);
805 key->size = old_size;
815 tos_frag_to_odp_frag(uint8_t tos_frag)
817 return (tos_frag & FLOW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
818 : tos_frag & FLOW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
819 : OVS_FRAG_TYPE_NONE);
822 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
824 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
826 struct ovs_key_ethernet *eth_key;
828 if (flow->tun_id != htonll(0)) {
829 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
832 if (flow->in_port != OFPP_NONE) {
833 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
834 ofp_port_to_odp_port(flow->in_port));
837 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
839 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
840 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
842 if (flow->vlan_tci != htons(0)) {
843 struct ovs_key_8021q *q_key;
845 q_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_8021Q,
847 q_key->q_tpid = htons(ETH_TYPE_VLAN);
848 q_key->q_tci = flow->vlan_tci & ~htons(VLAN_CFI);
851 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
855 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
857 if (flow->dl_type == htons(ETH_TYPE_IP)) {
858 struct ovs_key_ipv4 *ipv4_key;
860 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
862 memset(ipv4_key, 0, sizeof *ipv4_key);
863 ipv4_key->ipv4_src = flow->nw_src;
864 ipv4_key->ipv4_dst = flow->nw_dst;
865 ipv4_key->ipv4_proto = flow->nw_proto;
866 ipv4_key->ipv4_tos = flow->tos_frag & IP_DSCP_MASK;
867 ipv4_key->ipv4_frag = tos_frag_to_odp_frag(flow->tos_frag);
868 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
869 struct ovs_key_ipv6 *ipv6_key;
871 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
873 memset(ipv6_key, 0, sizeof *ipv6_key);
874 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
875 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
876 ipv6_key->ipv6_proto = flow->nw_proto;
877 ipv6_key->ipv6_tos = flow->tos_frag & IP_DSCP_MASK;
878 ipv6_key->ipv6_frag = tos_frag_to_odp_frag(flow->tos_frag);
879 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
880 struct ovs_key_arp *arp_key;
882 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
884 memset(arp_key, 0, sizeof *arp_key);
885 arp_key->arp_sip = flow->nw_src;
886 arp_key->arp_tip = flow->nw_dst;
887 arp_key->arp_op = htons(flow->nw_proto);
888 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
889 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
892 if ((flow->dl_type == htons(ETH_TYPE_IP)
893 || flow->dl_type == htons(ETH_TYPE_IPV6))
894 && !(flow->tos_frag & FLOW_FRAG_LATER)) {
896 if (flow->nw_proto == IPPROTO_TCP) {
897 struct ovs_key_tcp *tcp_key;
899 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
901 tcp_key->tcp_src = flow->tp_src;
902 tcp_key->tcp_dst = flow->tp_dst;
903 } else if (flow->nw_proto == IPPROTO_UDP) {
904 struct ovs_key_udp *udp_key;
906 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
908 udp_key->udp_src = flow->tp_src;
909 udp_key->udp_dst = flow->tp_dst;
910 } else if (flow->dl_type == htons(ETH_TYPE_IP)
911 && flow->nw_proto == IPPROTO_ICMP) {
912 struct ovs_key_icmp *icmp_key;
914 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
916 icmp_key->icmp_type = ntohs(flow->tp_src);
917 icmp_key->icmp_code = ntohs(flow->tp_dst);
918 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
919 && flow->nw_proto == IPPROTO_ICMPV6) {
920 struct ovs_key_icmpv6 *icmpv6_key;
922 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
924 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
925 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
927 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
928 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
929 struct ovs_key_nd *nd_key;
931 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
933 memcpy(nd_key->nd_target, &flow->nd_target,
934 sizeof nd_key->nd_target);
935 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
936 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
943 odp_to_tos_frag(uint8_t odp_tos, uint8_t odp_frag, struct flow *flow)
945 if (odp_tos & ~IP_DSCP_MASK || odp_frag > OVS_FRAG_TYPE_LATER) {
949 flow->tos_frag = odp_tos;
950 if (odp_frag != OVS_FRAG_TYPE_NONE) {
951 flow->tos_frag |= FLOW_FRAG_ANY;
952 if (odp_frag == OVS_FRAG_TYPE_LATER) {
953 flow->tos_frag |= FLOW_FRAG_LATER;
959 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
960 * structure in 'flow'. Returns 0 if successful, otherwise EINVAL. */
962 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
965 const struct nlattr *nla;
966 enum ovs_key_attr prev_type;
969 memset(flow, 0, sizeof *flow);
970 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
971 flow->in_port = OFPP_NONE;
973 prev_type = OVS_KEY_ATTR_UNSPEC;
974 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
975 const struct ovs_key_ethernet *eth_key;
976 const struct ovs_key_8021q *q_key;
977 const struct ovs_key_ipv4 *ipv4_key;
978 const struct ovs_key_ipv6 *ipv6_key;
979 const struct ovs_key_tcp *tcp_key;
980 const struct ovs_key_udp *udp_key;
981 const struct ovs_key_icmp *icmp_key;
982 const struct ovs_key_icmpv6 *icmpv6_key;
983 const struct ovs_key_arp *arp_key;
984 const struct ovs_key_nd *nd_key;
986 uint16_t type = nl_attr_type(nla);
987 int len = odp_flow_key_attr_len(type);
989 if (nl_attr_get_size(nla) != len && len != -1) {
993 #define TRANSITION(PREV_TYPE, TYPE) (((PREV_TYPE) << 16) | (TYPE))
994 switch (TRANSITION(prev_type, type)) {
995 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_TUN_ID):
996 flow->tun_id = nl_attr_get_be64(nla);
999 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_IN_PORT):
1000 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_IN_PORT):
1001 if (nl_attr_get_u32(nla) >= UINT16_MAX) {
1004 flow->in_port = odp_port_to_ofp_port(nl_attr_get_u32(nla));
1007 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_ETHERNET):
1008 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_ETHERNET):
1009 case TRANSITION(OVS_KEY_ATTR_IN_PORT, OVS_KEY_ATTR_ETHERNET):
1010 eth_key = nl_attr_get(nla);
1011 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
1012 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
1015 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_8021Q):
1016 q_key = nl_attr_get(nla);
1017 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
1018 /* Only standard 0x8100 VLANs currently supported. */
1021 if (q_key->q_tci & htons(VLAN_CFI)) {
1024 flow->vlan_tci = q_key->q_tci | htons(VLAN_CFI);
1027 case TRANSITION(OVS_KEY_ATTR_8021Q, OVS_KEY_ATTR_ETHERTYPE):
1028 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_ETHERTYPE):
1029 flow->dl_type = nl_attr_get_be16(nla);
1030 if (ntohs(flow->dl_type) < 1536) {
1035 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV4):
1036 if (flow->dl_type != htons(ETH_TYPE_IP)) {
1039 ipv4_key = nl_attr_get(nla);
1040 flow->nw_src = ipv4_key->ipv4_src;
1041 flow->nw_dst = ipv4_key->ipv4_dst;
1042 flow->nw_proto = ipv4_key->ipv4_proto;
1043 if (!odp_to_tos_frag(ipv4_key->ipv4_tos, ipv4_key->ipv4_frag,
1049 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV6):
1050 if (flow->dl_type != htons(ETH_TYPE_IPV6)) {
1053 ipv6_key = nl_attr_get(nla);
1054 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
1055 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
1056 flow->nw_proto = ipv6_key->ipv6_proto;
1057 if (!odp_to_tos_frag(ipv6_key->ipv6_tos, ipv6_key->ipv6_frag,
1063 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_TCP):
1064 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_TCP):
1065 if (flow->nw_proto != IPPROTO_TCP) {
1068 tcp_key = nl_attr_get(nla);
1069 flow->tp_src = tcp_key->tcp_src;
1070 flow->tp_dst = tcp_key->tcp_dst;
1073 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_UDP):
1074 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_UDP):
1075 if (flow->nw_proto != IPPROTO_UDP) {
1078 udp_key = nl_attr_get(nla);
1079 flow->tp_src = udp_key->udp_src;
1080 flow->tp_dst = udp_key->udp_dst;
1083 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_ICMP):
1084 if (flow->nw_proto != IPPROTO_ICMP) {
1087 icmp_key = nl_attr_get(nla);
1088 flow->tp_src = htons(icmp_key->icmp_type);
1089 flow->tp_dst = htons(icmp_key->icmp_code);
1092 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_ICMPV6):
1093 if (flow->nw_proto != IPPROTO_ICMPV6) {
1096 icmpv6_key = nl_attr_get(nla);
1097 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1098 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1101 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_ARP):
1102 if (flow->dl_type != htons(ETH_TYPE_ARP)) {
1105 arp_key = nl_attr_get(nla);
1106 flow->nw_src = arp_key->arp_sip;
1107 flow->nw_dst = arp_key->arp_tip;
1108 if (arp_key->arp_op & htons(0xff00)) {
1111 flow->nw_proto = ntohs(arp_key->arp_op);
1112 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1113 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1116 case TRANSITION(OVS_KEY_ATTR_ICMPV6, OVS_KEY_ATTR_ND):
1117 if (flow->tp_src != htons(ND_NEIGHBOR_SOLICIT)
1118 && flow->tp_src != htons(ND_NEIGHBOR_ADVERT)) {
1121 nd_key = nl_attr_get(nla);
1122 memcpy(&flow->nd_target, nd_key->nd_target, sizeof flow->nd_target);
1123 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1124 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1137 switch (prev_type) {
1138 case OVS_KEY_ATTR_UNSPEC:
1141 case OVS_KEY_ATTR_TUN_ID:
1142 case OVS_KEY_ATTR_IN_PORT:
1145 case OVS_KEY_ATTR_ETHERNET:
1146 case OVS_KEY_ATTR_8021Q:
1149 case OVS_KEY_ATTR_ETHERTYPE:
1150 if (flow->dl_type == htons(ETH_TYPE_IP)
1151 || flow->dl_type == htons(ETH_TYPE_IPV6)
1152 || flow->dl_type == htons(ETH_TYPE_ARP)) {
1157 case OVS_KEY_ATTR_IPV4:
1158 if (flow->tos_frag & FLOW_FRAG_LATER) {
1161 if (flow->nw_proto == IPPROTO_TCP
1162 || flow->nw_proto == IPPROTO_UDP
1163 || flow->nw_proto == IPPROTO_ICMP) {
1168 case OVS_KEY_ATTR_IPV6:
1169 if (flow->tos_frag & FLOW_FRAG_LATER) {
1172 if (flow->nw_proto == IPPROTO_TCP
1173 || flow->nw_proto == IPPROTO_UDP
1174 || flow->nw_proto == IPPROTO_ICMPV6) {
1179 case OVS_KEY_ATTR_ICMPV6:
1180 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
1181 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT)
1182 || flow->tos_frag & FLOW_FRAG_LATER) {
1187 case OVS_KEY_ATTR_TCP:
1188 case OVS_KEY_ATTR_UDP:
1189 case OVS_KEY_ATTR_ICMP:
1190 case OVS_KEY_ATTR_ND:
1191 if (flow->tos_frag & FLOW_FRAG_LATER) {
1196 case OVS_KEY_ATTR_ARP:
1199 case __OVS_KEY_ATTR_MAX: