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_SAMPLE: return -2;
70 case OVS_ACTION_ATTR_UNSPEC:
71 case __OVS_ACTION_ATTR_MAX:
79 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
81 size_t len = nl_attr_get_size(a);
83 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
85 const uint8_t *unspec;
88 unspec = nl_attr_get(a);
89 for (i = 0; i < len; i++) {
90 ds_put_char(ds, i ? ' ': '(');
91 ds_put_format(ds, "%02x", unspec[i]);
98 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
100 static const struct nl_policy ovs_sample_policy[] = {
101 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
102 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
104 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
106 const struct nlattr *nla_acts;
109 ds_put_cstr(ds, "sample");
111 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
112 ds_put_cstr(ds, "(error)");
116 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
119 ds_put_format(ds, "(sample=%.1f%%,", percentage);
121 ds_put_cstr(ds, "actions(");
122 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
123 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
124 format_odp_actions(ds, nla_acts, len);
125 ds_put_format(ds, "))");
129 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
131 static const struct nl_policy ovs_userspace_policy[] = {
132 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
133 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
135 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
137 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
138 ds_put_cstr(ds, "userspace(error)");
142 ds_put_format(ds, "userspace(pid=%"PRIu32,
143 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
145 if (a[OVS_USERSPACE_ATTR_USERDATA]) {
146 uint64_t userdata = nl_attr_get_u64(a[OVS_USERSPACE_ATTR_USERDATA]);
147 struct user_action_cookie cookie;
149 memcpy(&cookie, &userdata, sizeof cookie);
151 if (cookie.type == USER_ACTION_COOKIE_CONTROLLER) {
152 ds_put_format(ds, ",controller,length=%"PRIu32,
154 } else if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
155 ds_put_format(ds, ",sFlow,n_output=%"PRIu8","
156 "vid=%"PRIu16",pcp=%"PRIu8",ifindex=%"PRIu32,
157 cookie.n_output, vlan_tci_to_vid(cookie.vlan_tci),
158 vlan_tci_to_pcp(cookie.vlan_tci), cookie.data);
160 ds_put_format(ds, ",userdata=0x%"PRIx64, userdata);
164 ds_put_char(ds, ')');
169 format_odp_action(struct ds *ds, const struct nlattr *a)
172 enum ovs_action_attr type = nl_attr_type(a);
174 expected_len = odp_action_len(nl_attr_type(a));
175 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
176 ds_put_format(ds, "bad length %zu, expected %d for: ",
177 nl_attr_get_size(a), expected_len);
178 format_generic_odp_action(ds, a);
184 case OVS_ACTION_ATTR_OUTPUT:
185 ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
187 case OVS_ACTION_ATTR_USERSPACE:
188 format_odp_userspace_action(ds, a);
190 case OVS_ACTION_ATTR_SET:
191 ds_put_cstr(ds, "set(");
192 format_odp_key_attr(nl_attr_get(a), ds);
193 ds_put_cstr(ds, ")");
195 case OVS_ACTION_ATTR_PUSH:
196 ds_put_cstr(ds, "push(");
197 format_odp_key_attr(nl_attr_get(a), ds);
198 ds_put_cstr(ds, ")");
200 case OVS_ACTION_ATTR_POP:
201 if (nl_attr_get_u16(a) == OVS_KEY_ATTR_8021Q) {
202 ds_put_cstr(ds, "pop(vlan)");
204 ds_put_format(ds, "pop(key%"PRIu16")", nl_attr_get_u16(a));
207 case OVS_ACTION_ATTR_SAMPLE:
208 format_odp_sample_action(ds, a);
210 case OVS_ACTION_ATTR_UNSPEC:
211 case __OVS_ACTION_ATTR_MAX:
213 format_generic_odp_action(ds, a);
219 format_odp_actions(struct ds *ds, const struct nlattr *actions,
223 const struct nlattr *a;
226 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
228 ds_put_char(ds, ',');
230 format_odp_action(ds, a);
233 if (left == actions_len) {
234 ds_put_cstr(ds, "<empty>");
236 ds_put_format(ds, ",***%u leftover bytes***", left);
239 ds_put_cstr(ds, "drop");
243 /* Returns the correct length of the payload for a flow key attribute of the
244 * specified 'type', or -1 if 'type' is unknown. */
246 odp_flow_key_attr_len(uint16_t type)
248 if (type > OVS_KEY_ATTR_MAX) {
252 switch ((enum ovs_key_attr) type) {
253 case OVS_KEY_ATTR_PRIORITY: return 4;
254 case OVS_KEY_ATTR_TUN_ID: return 8;
255 case OVS_KEY_ATTR_IN_PORT: return 4;
256 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
257 case OVS_KEY_ATTR_8021Q: return sizeof(struct ovs_key_8021q);
258 case OVS_KEY_ATTR_ETHERTYPE: return 2;
259 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
260 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
261 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
262 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
263 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
264 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
265 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
266 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
268 case OVS_KEY_ATTR_UNSPEC:
269 case __OVS_KEY_ATTR_MAX:
278 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
280 size_t len = nl_attr_get_size(a);
282 ds_put_format(ds, "key%"PRId16, nl_attr_type(a));
284 const uint8_t *unspec;
287 unspec = nl_attr_get(a);
288 for (i = 0; i < len; i++) {
289 ds_put_char(ds, i ? ' ': '(');
290 ds_put_format(ds, "%02x", unspec[i]);
292 ds_put_char(ds, ')');
297 ovs_frag_type_to_string(enum ovs_frag_type type)
300 case OVS_FRAG_TYPE_NONE:
302 case OVS_FRAG_TYPE_FIRST:
304 case OVS_FRAG_TYPE_LATER:
306 case __OVS_FRAG_TYPE_MAX:
313 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
315 const struct ovs_key_ethernet *eth_key;
316 const struct ovs_key_8021q *q_key;
317 const struct ovs_key_ipv4 *ipv4_key;
318 const struct ovs_key_ipv6 *ipv6_key;
319 const struct ovs_key_tcp *tcp_key;
320 const struct ovs_key_udp *udp_key;
321 const struct ovs_key_icmp *icmp_key;
322 const struct ovs_key_icmpv6 *icmpv6_key;
323 const struct ovs_key_arp *arp_key;
324 const struct ovs_key_nd *nd_key;
326 if (nl_attr_get_size(a) != odp_flow_key_attr_len(nl_attr_type(a))) {
327 ds_put_format(ds, "bad length %zu, expected %d for: ",
329 odp_flow_key_attr_len(nl_attr_type(a)));
330 format_generic_odp_key(a, ds);
334 switch (nl_attr_type(a)) {
335 case OVS_KEY_ATTR_PRIORITY:
336 ds_put_format(ds, "priority(%"PRIu32")", nl_attr_get_u32(a));
339 case OVS_KEY_ATTR_TUN_ID:
340 ds_put_format(ds, "tun_id(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
343 case OVS_KEY_ATTR_IN_PORT:
344 ds_put_format(ds, "in_port(%"PRIu32")", nl_attr_get_u32(a));
347 case OVS_KEY_ATTR_ETHERNET:
348 eth_key = nl_attr_get(a);
349 ds_put_format(ds, "eth(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
350 ETH_ADDR_ARGS(eth_key->eth_src),
351 ETH_ADDR_ARGS(eth_key->eth_dst));
354 case OVS_KEY_ATTR_8021Q:
355 q_key = nl_attr_get(a);
356 ds_put_cstr(ds, "vlan(");
357 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
358 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(q_key->q_tpid));
360 ds_put_format(ds, "vid=%"PRIu16",pcp=%d)",
361 vlan_tci_to_vid(q_key->q_tci),
362 vlan_tci_to_pcp(q_key->q_tci));
365 case OVS_KEY_ATTR_ETHERTYPE:
366 ds_put_format(ds, "eth_type(0x%04"PRIx16")",
367 ntohs(nl_attr_get_be16(a)));
370 case OVS_KEY_ATTR_IPV4:
371 ipv4_key = nl_attr_get(a);
372 ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT","
373 "proto=%"PRId8",tos=%"PRIu8",frag=%s)",
374 IP_ARGS(&ipv4_key->ipv4_src),
375 IP_ARGS(&ipv4_key->ipv4_dst),
376 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
377 ovs_frag_type_to_string(ipv4_key->ipv4_frag));
380 case OVS_KEY_ATTR_IPV6: {
381 char src_str[INET6_ADDRSTRLEN];
382 char dst_str[INET6_ADDRSTRLEN];
384 ipv6_key = nl_attr_get(a);
385 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
386 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
388 ds_put_format(ds, "ipv6(src=%s,dst=%s,label=%#"PRIx32",proto=%"PRId8
389 ",tos=%"PRIu8",frag=%s)",
390 src_str, dst_str, ntohl(ipv6_key->ipv6_label),
391 ipv6_key->ipv6_proto, ipv6_key->ipv6_tos,
392 ovs_frag_type_to_string(ipv6_key->ipv6_frag));
396 case OVS_KEY_ATTR_TCP:
397 tcp_key = nl_attr_get(a);
398 ds_put_format(ds, "tcp(src=%"PRIu16",dst=%"PRIu16")",
399 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
402 case OVS_KEY_ATTR_UDP:
403 udp_key = nl_attr_get(a);
404 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16")",
405 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
408 case OVS_KEY_ATTR_ICMP:
409 icmp_key = nl_attr_get(a);
410 ds_put_format(ds, "icmp(type=%"PRIu8",code=%"PRIu8")",
411 icmp_key->icmp_type, icmp_key->icmp_code);
414 case OVS_KEY_ATTR_ICMPV6:
415 icmpv6_key = nl_attr_get(a);
416 ds_put_format(ds, "icmpv6(type=%"PRIu8",code=%"PRIu8")",
417 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
420 case OVS_KEY_ATTR_ARP:
421 arp_key = nl_attr_get(a);
422 ds_put_format(ds, "arp(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
423 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
424 IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
425 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
426 ETH_ADDR_ARGS(arp_key->arp_tha));
429 case OVS_KEY_ATTR_ND: {
430 char target[INET6_ADDRSTRLEN];
432 nd_key = nl_attr_get(a);
433 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
435 ds_put_format(ds, "nd(target=%s", target);
436 if (!eth_addr_is_zero(nd_key->nd_sll)) {
437 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
438 ETH_ADDR_ARGS(nd_key->nd_sll));
440 if (!eth_addr_is_zero(nd_key->nd_tll)) {
441 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
442 ETH_ADDR_ARGS(nd_key->nd_tll));
444 ds_put_char(ds, ')');
449 format_generic_odp_key(a, ds);
454 /* Appends to 'ds' a string representation of the 'key_len' bytes of
455 * OVS_KEY_ATTR_* attributes in 'key'. */
457 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
460 const struct nlattr *a;
463 NL_ATTR_FOR_EACH (a, left, key, key_len) {
465 ds_put_char(ds, ',');
467 format_odp_key_attr(a, ds);
470 if (left == key_len) {
471 ds_put_cstr(ds, "<empty>");
473 ds_put_format(ds, ",***%u leftover bytes***", left);
476 ds_put_cstr(ds, "<empty>");
481 put_nd_key(int n, const char *nd_target_s,
482 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
484 struct ovs_key_nd nd_key;
486 memset(&nd_key, 0, sizeof nd_key);
487 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
491 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
494 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
496 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
501 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
503 if (!strcasecmp(s, "no")) {
504 *type = OVS_FRAG_TYPE_NONE;
505 } else if (!strcasecmp(s, "first")) {
506 *type = OVS_FRAG_TYPE_FIRST;
507 } else if (!strcasecmp(s, "later")) {
508 *type = OVS_FRAG_TYPE_LATER;
516 parse_odp_key_attr(const char *s, struct ofpbuf *key)
518 /* Many of the sscanf calls in this function use oversized destination
519 * fields because some sscanf() implementations truncate the range of %i
520 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
521 * value of 0x7fff. The other alternatives are to allow only a single
522 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
525 * The tun_id parser has to use an alternative approach because there is no
526 * type larger than 64 bits. */
529 unsigned long long int priority;
532 if (sscanf(s, "priority(%lli)%n", &priority, &n) > 0 && n > 0) {
533 nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
542 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
543 tun_id_s, &n) > 0 && n > 0) {
544 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
545 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
551 unsigned long long int in_port;
554 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
555 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
561 struct ovs_key_ethernet eth_key;
565 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
566 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
567 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
568 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
569 ð_key, sizeof eth_key);
575 uint16_t tpid = ETH_TYPE_VLAN;
580 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n",
581 &vid, &pcp, &n) > 0 && n > 0) ||
582 (sscanf(s, "vlan(tpid=%"SCNi16",vid=%"SCNi16",pcp=%i)%n",
583 &tpid, &vid, &pcp, &n) > 0 && n > 0)) {
584 struct ovs_key_8021q q_key;
586 q_key.q_tpid = htons(tpid);
587 q_key.q_tci = htons((vid << VLAN_VID_SHIFT) |
588 (pcp << VLAN_PCP_SHIFT));
589 nl_msg_put_unspec(key, OVS_KEY_ATTR_8021Q, &q_key, sizeof q_key);
598 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
599 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
610 enum ovs_frag_type ipv4_frag;
613 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
614 "proto=%i,tos=%i,frag=%7[a-z])%n",
615 IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
616 &ipv4_proto, &ipv4_tos, frag, &n) > 0
618 && ovs_frag_type_from_string(frag, &ipv4_frag)) {
619 struct ovs_key_ipv4 ipv4_key;
621 memset(&ipv4_key, 0, sizeof ipv4_key);
622 ipv4_key.ipv4_src = ipv4_src;
623 ipv4_key.ipv4_dst = ipv4_dst;
624 ipv4_key.ipv4_proto = ipv4_proto;
625 ipv4_key.ipv4_tos = ipv4_tos;
626 ipv4_key.ipv4_frag = ipv4_frag;
627 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
628 &ipv4_key, sizeof ipv4_key);
634 char ipv6_src_s[IPV6_SCAN_LEN + 1];
635 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
640 enum ovs_frag_type ipv6_frag;
643 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
644 "label=%i,proto=%i,tos=%i,frag=%7[a-z])%n",
645 ipv6_src_s, ipv6_dst_s, &ipv6_label,
646 &ipv6_proto, &ipv6_tos, frag, &n) > 0
648 && ovs_frag_type_from_string(frag, &ipv6_frag)) {
649 struct ovs_key_ipv6 ipv6_key;
651 memset(&ipv6_key, 0, sizeof ipv6_key);
652 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
653 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
656 ipv6_key.ipv6_label = htonl(ipv6_label);
657 ipv6_key.ipv6_proto = ipv6_proto;
658 ipv6_key.ipv6_tos = ipv6_tos;
659 ipv6_key.ipv6_frag = ipv6_frag;
660 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
661 &ipv6_key, sizeof ipv6_key);
671 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
673 struct ovs_key_tcp tcp_key;
675 tcp_key.tcp_src = htons(tcp_src);
676 tcp_key.tcp_dst = htons(tcp_dst);
677 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
687 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
689 struct ovs_key_udp udp_key;
691 udp_key.udp_src = htons(udp_src);
692 udp_key.udp_dst = htons(udp_dst);
693 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
703 if (sscanf(s, "icmp(type=%i,code=%i)%n",
704 &icmp_type, &icmp_code, &n) > 0
706 struct ovs_key_icmp icmp_key;
708 icmp_key.icmp_type = icmp_type;
709 icmp_key.icmp_code = icmp_code;
710 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
711 &icmp_key, sizeof icmp_key);
717 struct ovs_key_icmpv6 icmpv6_key;
720 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
721 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
723 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
724 &icmpv6_key, sizeof icmpv6_key);
733 uint8_t arp_sha[ETH_ADDR_LEN];
734 uint8_t arp_tha[ETH_ADDR_LEN];
737 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
738 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
739 IP_SCAN_ARGS(&arp_sip),
740 IP_SCAN_ARGS(&arp_tip),
742 ETH_ADDR_SCAN_ARGS(arp_sha),
743 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
744 struct ovs_key_arp arp_key;
746 memset(&arp_key, 0, sizeof arp_key);
747 arp_key.arp_sip = arp_sip;
748 arp_key.arp_tip = arp_tip;
749 arp_key.arp_op = htons(arp_op);
750 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
751 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
752 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
758 char nd_target_s[IPV6_SCAN_LEN + 1];
759 uint8_t nd_sll[ETH_ADDR_LEN];
760 uint8_t nd_tll[ETH_ADDR_LEN];
763 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
764 nd_target_s, &n) > 0 && n > 0) {
765 return put_nd_key(n, nd_target_s, NULL, NULL, key);
767 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
768 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
770 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
772 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
773 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
775 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
777 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
778 "tll="ETH_ADDR_SCAN_FMT")%n",
779 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
780 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
782 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
789 /* Parses the string representation of a datapath flow key, in the
790 * format output by odp_flow_key_format(). Returns 0 if successful,
791 * otherwise a positive errno value. On success, the flow key is
792 * appended to 'key' as a series of Netlink attributes. On failure, no
793 * data is appended to 'key'. Either way, 'key''s data might be
796 * On success, the attributes appended to 'key' are individually syntactically
797 * valid, but they may not be valid as a sequence. 'key' might, for example,
798 * be missing an "in_port" key, have duplicated keys, or have keys in the wrong
799 * order. odp_flow_key_to_flow() will detect those errors. */
801 odp_flow_key_from_string(const char *s, struct ofpbuf *key)
803 const size_t old_size = key->size;
807 s += strspn(s, ", \t\r\n");
812 retval = parse_odp_key_attr(s, key);
814 key->size = old_size;
824 tos_frag_to_odp_frag(uint8_t tos_frag)
826 return (tos_frag & FLOW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
827 : tos_frag & FLOW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
828 : OVS_FRAG_TYPE_NONE);
831 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
833 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
835 struct ovs_key_ethernet *eth_key;
837 if (flow->priority) {
838 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, flow->priority);
841 if (flow->tun_id != htonll(0)) {
842 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
845 if (flow->in_port != OFPP_NONE) {
846 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
847 ofp_port_to_odp_port(flow->in_port));
850 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
852 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
853 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
855 if (flow->vlan_tci != htons(0)) {
856 struct ovs_key_8021q *q_key;
858 q_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_8021Q,
860 q_key->q_tpid = htons(ETH_TYPE_VLAN);
861 q_key->q_tci = flow->vlan_tci & ~htons(VLAN_CFI);
864 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
868 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
870 if (flow->dl_type == htons(ETH_TYPE_IP)) {
871 struct ovs_key_ipv4 *ipv4_key;
873 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
875 memset(ipv4_key, 0, sizeof *ipv4_key);
876 ipv4_key->ipv4_src = flow->nw_src;
877 ipv4_key->ipv4_dst = flow->nw_dst;
878 ipv4_key->ipv4_proto = flow->nw_proto;
879 ipv4_key->ipv4_tos = flow->tos_frag & IP_DSCP_MASK;
880 ipv4_key->ipv4_frag = tos_frag_to_odp_frag(flow->tos_frag);
881 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
882 struct ovs_key_ipv6 *ipv6_key;
884 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
886 memset(ipv6_key, 0, sizeof *ipv6_key);
887 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
888 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
889 ipv6_key->ipv6_label = flow->ipv6_label;
890 ipv6_key->ipv6_proto = flow->nw_proto;
891 ipv6_key->ipv6_tos = flow->tos_frag & IP_DSCP_MASK;
892 ipv6_key->ipv6_frag = tos_frag_to_odp_frag(flow->tos_frag);
893 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
894 struct ovs_key_arp *arp_key;
896 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
898 memset(arp_key, 0, sizeof *arp_key);
899 arp_key->arp_sip = flow->nw_src;
900 arp_key->arp_tip = flow->nw_dst;
901 arp_key->arp_op = htons(flow->nw_proto);
902 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
903 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
906 if ((flow->dl_type == htons(ETH_TYPE_IP)
907 || flow->dl_type == htons(ETH_TYPE_IPV6))
908 && !(flow->tos_frag & FLOW_FRAG_LATER)) {
910 if (flow->nw_proto == IPPROTO_TCP) {
911 struct ovs_key_tcp *tcp_key;
913 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
915 tcp_key->tcp_src = flow->tp_src;
916 tcp_key->tcp_dst = flow->tp_dst;
917 } else if (flow->nw_proto == IPPROTO_UDP) {
918 struct ovs_key_udp *udp_key;
920 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
922 udp_key->udp_src = flow->tp_src;
923 udp_key->udp_dst = flow->tp_dst;
924 } else if (flow->dl_type == htons(ETH_TYPE_IP)
925 && flow->nw_proto == IPPROTO_ICMP) {
926 struct ovs_key_icmp *icmp_key;
928 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
930 icmp_key->icmp_type = ntohs(flow->tp_src);
931 icmp_key->icmp_code = ntohs(flow->tp_dst);
932 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
933 && flow->nw_proto == IPPROTO_ICMPV6) {
934 struct ovs_key_icmpv6 *icmpv6_key;
936 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
938 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
939 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
941 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
942 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
943 struct ovs_key_nd *nd_key;
945 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
947 memcpy(nd_key->nd_target, &flow->nd_target,
948 sizeof nd_key->nd_target);
949 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
950 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
957 odp_to_tos_frag(uint8_t odp_tos, uint8_t odp_frag, struct flow *flow)
959 if (odp_tos & ~IP_DSCP_MASK || odp_frag > OVS_FRAG_TYPE_LATER) {
963 flow->tos_frag = odp_tos;
964 if (odp_frag != OVS_FRAG_TYPE_NONE) {
965 flow->tos_frag |= FLOW_FRAG_ANY;
966 if (odp_frag == OVS_FRAG_TYPE_LATER) {
967 flow->tos_frag |= FLOW_FRAG_LATER;
973 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
974 * structure in 'flow'. Returns 0 if successful, otherwise EINVAL. */
976 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
979 const struct nlattr *nla;
980 enum ovs_key_attr prev_type;
983 memset(flow, 0, sizeof *flow);
984 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
985 flow->in_port = OFPP_NONE;
987 prev_type = OVS_KEY_ATTR_UNSPEC;
988 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
989 const struct ovs_key_ethernet *eth_key;
990 const struct ovs_key_8021q *q_key;
991 const struct ovs_key_ipv4 *ipv4_key;
992 const struct ovs_key_ipv6 *ipv6_key;
993 const struct ovs_key_tcp *tcp_key;
994 const struct ovs_key_udp *udp_key;
995 const struct ovs_key_icmp *icmp_key;
996 const struct ovs_key_icmpv6 *icmpv6_key;
997 const struct ovs_key_arp *arp_key;
998 const struct ovs_key_nd *nd_key;
1000 uint16_t type = nl_attr_type(nla);
1001 int len = odp_flow_key_attr_len(type);
1003 if (nl_attr_get_size(nla) != len && len != -1) {
1007 #define TRANSITION(PREV_TYPE, TYPE) (((PREV_TYPE) << 16) | (TYPE))
1008 switch (TRANSITION(prev_type, type)) {
1009 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_PRIORITY):
1010 flow->priority = nl_attr_get_u32(nla);
1013 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_TUN_ID):
1014 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_TUN_ID):
1015 flow->tun_id = nl_attr_get_be64(nla);
1018 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_IN_PORT):
1019 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_IN_PORT):
1020 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_IN_PORT):
1021 if (nl_attr_get_u32(nla) >= UINT16_MAX) {
1024 flow->in_port = odp_port_to_ofp_port(nl_attr_get_u32(nla));
1027 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_ETHERNET):
1028 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_ETHERNET):
1029 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_ETHERNET):
1030 case TRANSITION(OVS_KEY_ATTR_IN_PORT, OVS_KEY_ATTR_ETHERNET):
1031 eth_key = nl_attr_get(nla);
1032 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
1033 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
1036 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_8021Q):
1037 q_key = nl_attr_get(nla);
1038 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
1039 /* Only standard 0x8100 VLANs currently supported. */
1042 if (q_key->q_tci & htons(VLAN_CFI)) {
1045 flow->vlan_tci = q_key->q_tci | htons(VLAN_CFI);
1048 case TRANSITION(OVS_KEY_ATTR_8021Q, OVS_KEY_ATTR_ETHERTYPE):
1049 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_ETHERTYPE):
1050 flow->dl_type = nl_attr_get_be16(nla);
1051 if (ntohs(flow->dl_type) < 1536) {
1056 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV4):
1057 if (flow->dl_type != htons(ETH_TYPE_IP)) {
1060 ipv4_key = nl_attr_get(nla);
1061 flow->nw_src = ipv4_key->ipv4_src;
1062 flow->nw_dst = ipv4_key->ipv4_dst;
1063 flow->nw_proto = ipv4_key->ipv4_proto;
1064 if (!odp_to_tos_frag(ipv4_key->ipv4_tos, ipv4_key->ipv4_frag,
1070 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV6):
1071 if (flow->dl_type != htons(ETH_TYPE_IPV6)) {
1074 ipv6_key = nl_attr_get(nla);
1075 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
1076 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
1077 flow->ipv6_label = ipv6_key->ipv6_label;
1078 flow->nw_proto = ipv6_key->ipv6_proto;
1079 if (!odp_to_tos_frag(ipv6_key->ipv6_tos, ipv6_key->ipv6_frag,
1085 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_TCP):
1086 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_TCP):
1087 if (flow->nw_proto != IPPROTO_TCP) {
1090 tcp_key = nl_attr_get(nla);
1091 flow->tp_src = tcp_key->tcp_src;
1092 flow->tp_dst = tcp_key->tcp_dst;
1095 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_UDP):
1096 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_UDP):
1097 if (flow->nw_proto != IPPROTO_UDP) {
1100 udp_key = nl_attr_get(nla);
1101 flow->tp_src = udp_key->udp_src;
1102 flow->tp_dst = udp_key->udp_dst;
1105 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_ICMP):
1106 if (flow->nw_proto != IPPROTO_ICMP) {
1109 icmp_key = nl_attr_get(nla);
1110 flow->tp_src = htons(icmp_key->icmp_type);
1111 flow->tp_dst = htons(icmp_key->icmp_code);
1114 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_ICMPV6):
1115 if (flow->nw_proto != IPPROTO_ICMPV6) {
1118 icmpv6_key = nl_attr_get(nla);
1119 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1120 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1123 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_ARP):
1124 if (flow->dl_type != htons(ETH_TYPE_ARP)) {
1127 arp_key = nl_attr_get(nla);
1128 flow->nw_src = arp_key->arp_sip;
1129 flow->nw_dst = arp_key->arp_tip;
1130 if (arp_key->arp_op & htons(0xff00)) {
1133 flow->nw_proto = ntohs(arp_key->arp_op);
1134 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1135 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1138 case TRANSITION(OVS_KEY_ATTR_ICMPV6, OVS_KEY_ATTR_ND):
1139 if (flow->tp_src != htons(ND_NEIGHBOR_SOLICIT)
1140 && flow->tp_src != htons(ND_NEIGHBOR_ADVERT)) {
1143 nd_key = nl_attr_get(nla);
1144 memcpy(&flow->nd_target, nd_key->nd_target, sizeof flow->nd_target);
1145 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1146 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1159 switch (prev_type) {
1160 case OVS_KEY_ATTR_UNSPEC:
1163 case OVS_KEY_ATTR_PRIORITY:
1164 case OVS_KEY_ATTR_TUN_ID:
1165 case OVS_KEY_ATTR_IN_PORT:
1168 case OVS_KEY_ATTR_ETHERNET:
1169 case OVS_KEY_ATTR_8021Q:
1172 case OVS_KEY_ATTR_ETHERTYPE:
1173 if (flow->dl_type == htons(ETH_TYPE_IP)
1174 || flow->dl_type == htons(ETH_TYPE_IPV6)
1175 || flow->dl_type == htons(ETH_TYPE_ARP)) {
1180 case OVS_KEY_ATTR_IPV4:
1181 if (flow->tos_frag & FLOW_FRAG_LATER) {
1184 if (flow->nw_proto == IPPROTO_TCP
1185 || flow->nw_proto == IPPROTO_UDP
1186 || flow->nw_proto == IPPROTO_ICMP) {
1191 case OVS_KEY_ATTR_IPV6:
1192 if (flow->tos_frag & FLOW_FRAG_LATER) {
1195 if (flow->nw_proto == IPPROTO_TCP
1196 || flow->nw_proto == IPPROTO_UDP
1197 || flow->nw_proto == IPPROTO_ICMPV6) {
1202 case OVS_KEY_ATTR_ICMPV6:
1203 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
1204 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT)
1205 || flow->tos_frag & FLOW_FRAG_LATER) {
1210 case OVS_KEY_ATTR_TCP:
1211 case OVS_KEY_ATTR_UDP:
1212 case OVS_KEY_ATTR_ICMP:
1213 case OVS_KEY_ATTR_ND:
1214 if (flow->tos_frag & FLOW_FRAG_LATER) {
1219 case OVS_KEY_ATTR_ARP:
1222 case __OVS_KEY_ATTR_MAX: