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 ovs_key_attr_to_string(enum ovs_key_attr attr)
81 static char unknown_attr[3 + INT_STRLEN(unsigned int) + 1];
84 case OVS_KEY_ATTR_UNSPEC: return "unspec";
85 case OVS_KEY_ATTR_PRIORITY: return "priority";
86 case OVS_KEY_ATTR_TUN_ID: return "tun_id";
87 case OVS_KEY_ATTR_IN_PORT: return "in_port";
88 case OVS_KEY_ATTR_ETHERNET: return "eth";
89 case OVS_KEY_ATTR_8021Q: return "vlan";
90 case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
91 case OVS_KEY_ATTR_IPV4: return "ipv4";
92 case OVS_KEY_ATTR_IPV6: return "ipv6";
93 case OVS_KEY_ATTR_TCP: return "tcp";
94 case OVS_KEY_ATTR_UDP: return "udp";
95 case OVS_KEY_ATTR_ICMP: return "icmp";
96 case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
97 case OVS_KEY_ATTR_ARP: return "arp";
98 case OVS_KEY_ATTR_ND: return "nd";
100 case __OVS_KEY_ATTR_MAX:
102 snprintf(unknown_attr, sizeof unknown_attr, "key%u",
103 (unsigned int) attr);
109 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
111 size_t len = nl_attr_get_size(a);
113 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
115 const uint8_t *unspec;
118 unspec = nl_attr_get(a);
119 for (i = 0; i < len; i++) {
120 ds_put_char(ds, i ? ' ': '(');
121 ds_put_format(ds, "%02x", unspec[i]);
123 ds_put_char(ds, ')');
128 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
130 static const struct nl_policy ovs_sample_policy[] = {
131 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
132 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
134 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
136 const struct nlattr *nla_acts;
139 ds_put_cstr(ds, "sample");
141 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
142 ds_put_cstr(ds, "(error)");
146 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
149 ds_put_format(ds, "(sample=%.1f%%,", percentage);
151 ds_put_cstr(ds, "actions(");
152 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
153 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
154 format_odp_actions(ds, nla_acts, len);
155 ds_put_format(ds, "))");
159 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
161 static const struct nl_policy ovs_userspace_policy[] = {
162 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
163 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
165 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
167 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
168 ds_put_cstr(ds, "userspace(error)");
172 ds_put_format(ds, "userspace(pid=%"PRIu32,
173 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
175 if (a[OVS_USERSPACE_ATTR_USERDATA]) {
176 uint64_t userdata = nl_attr_get_u64(a[OVS_USERSPACE_ATTR_USERDATA]);
177 struct user_action_cookie cookie;
179 memcpy(&cookie, &userdata, sizeof cookie);
181 if (cookie.type == USER_ACTION_COOKIE_CONTROLLER) {
182 ds_put_format(ds, ",controller,length=%"PRIu32,
184 } else if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
185 ds_put_format(ds, ",sFlow,n_output=%"PRIu8","
186 "vid=%"PRIu16",pcp=%"PRIu8",ifindex=%"PRIu32,
187 cookie.n_output, vlan_tci_to_vid(cookie.vlan_tci),
188 vlan_tci_to_pcp(cookie.vlan_tci), cookie.data);
190 ds_put_format(ds, ",userdata=0x%"PRIx64, userdata);
194 ds_put_char(ds, ')');
198 format_odp_action(struct ds *ds, const struct nlattr *a)
201 enum ovs_action_attr type = nl_attr_type(a);
203 expected_len = odp_action_len(nl_attr_type(a));
204 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
205 ds_put_format(ds, "bad length %zu, expected %d for: ",
206 nl_attr_get_size(a), expected_len);
207 format_generic_odp_action(ds, a);
213 case OVS_ACTION_ATTR_OUTPUT:
214 ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
216 case OVS_ACTION_ATTR_USERSPACE:
217 format_odp_userspace_action(ds, a);
219 case OVS_ACTION_ATTR_SET:
220 ds_put_cstr(ds, "set(");
221 format_odp_key_attr(nl_attr_get(a), ds);
222 ds_put_cstr(ds, ")");
224 case OVS_ACTION_ATTR_PUSH:
225 ds_put_cstr(ds, "push(");
226 format_odp_key_attr(nl_attr_get(a), ds);
227 ds_put_cstr(ds, ")");
229 case OVS_ACTION_ATTR_POP:
230 ds_put_format(ds, "pop(%s)",
231 ovs_key_attr_to_string(nl_attr_get_u16(a)));
233 case OVS_ACTION_ATTR_SAMPLE:
234 format_odp_sample_action(ds, a);
236 case OVS_ACTION_ATTR_UNSPEC:
237 case __OVS_ACTION_ATTR_MAX:
239 format_generic_odp_action(ds, a);
245 format_odp_actions(struct ds *ds, const struct nlattr *actions,
249 const struct nlattr *a;
252 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
254 ds_put_char(ds, ',');
256 format_odp_action(ds, a);
259 if (left == actions_len) {
260 ds_put_cstr(ds, "<empty>");
262 ds_put_format(ds, ",***%u leftover bytes***", left);
265 ds_put_cstr(ds, "drop");
269 /* Returns the correct length of the payload for a flow key attribute of the
270 * specified 'type', or -1 if 'type' is unknown. */
272 odp_flow_key_attr_len(uint16_t type)
274 if (type > OVS_KEY_ATTR_MAX) {
278 switch ((enum ovs_key_attr) type) {
279 case OVS_KEY_ATTR_PRIORITY: return 4;
280 case OVS_KEY_ATTR_TUN_ID: return 8;
281 case OVS_KEY_ATTR_IN_PORT: return 4;
282 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
283 case OVS_KEY_ATTR_8021Q: return sizeof(struct ovs_key_8021q);
284 case OVS_KEY_ATTR_ETHERTYPE: return 2;
285 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
286 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
287 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
288 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
289 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
290 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
291 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
292 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
294 case OVS_KEY_ATTR_UNSPEC:
295 case __OVS_KEY_ATTR_MAX:
304 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
306 size_t len = nl_attr_get_size(a);
308 ds_put_format(ds, "key%"PRId16, nl_attr_type(a));
310 const uint8_t *unspec;
313 unspec = nl_attr_get(a);
314 for (i = 0; i < len; i++) {
315 ds_put_char(ds, i ? ' ': '(');
316 ds_put_format(ds, "%02x", unspec[i]);
318 ds_put_char(ds, ')');
323 ovs_frag_type_to_string(enum ovs_frag_type type)
326 case OVS_FRAG_TYPE_NONE:
328 case OVS_FRAG_TYPE_FIRST:
330 case OVS_FRAG_TYPE_LATER:
332 case __OVS_FRAG_TYPE_MAX:
339 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
341 const struct ovs_key_ethernet *eth_key;
342 const struct ovs_key_8021q *q_key;
343 const struct ovs_key_ipv4 *ipv4_key;
344 const struct ovs_key_ipv6 *ipv6_key;
345 const struct ovs_key_tcp *tcp_key;
346 const struct ovs_key_udp *udp_key;
347 const struct ovs_key_icmp *icmp_key;
348 const struct ovs_key_icmpv6 *icmpv6_key;
349 const struct ovs_key_arp *arp_key;
350 const struct ovs_key_nd *nd_key;
351 enum ovs_key_attr attr = nl_attr_type(a);
353 if (nl_attr_get_size(a) != odp_flow_key_attr_len(nl_attr_type(a))) {
354 ds_put_format(ds, "bad length %zu, expected %d for: ",
356 odp_flow_key_attr_len(nl_attr_type(a)));
357 format_generic_odp_key(a, ds);
362 case OVS_KEY_ATTR_PRIORITY:
363 ds_put_format(ds, "priority(%"PRIu32")", nl_attr_get_u32(a));
366 case OVS_KEY_ATTR_TUN_ID:
367 ds_put_format(ds, "tun_id(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
370 case OVS_KEY_ATTR_IN_PORT:
371 ds_put_format(ds, "in_port(%"PRIu32")", nl_attr_get_u32(a));
374 case OVS_KEY_ATTR_ETHERNET:
375 eth_key = nl_attr_get(a);
376 ds_put_format(ds, "eth(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
377 ETH_ADDR_ARGS(eth_key->eth_src),
378 ETH_ADDR_ARGS(eth_key->eth_dst));
381 case OVS_KEY_ATTR_8021Q:
382 q_key = nl_attr_get(a);
383 ds_put_cstr(ds, "vlan(");
384 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
385 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(q_key->q_tpid));
387 ds_put_format(ds, "vid=%"PRIu16",pcp=%d)",
388 vlan_tci_to_vid(q_key->q_tci),
389 vlan_tci_to_pcp(q_key->q_tci));
392 case OVS_KEY_ATTR_ETHERTYPE:
393 ds_put_format(ds, "eth_type(0x%04"PRIx16")",
394 ntohs(nl_attr_get_be16(a)));
397 case OVS_KEY_ATTR_IPV4:
398 ipv4_key = nl_attr_get(a);
399 ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
400 ",tos=%#"PRIx8",ttl=%"PRIu8",frag=%s)",
401 IP_ARGS(&ipv4_key->ipv4_src),
402 IP_ARGS(&ipv4_key->ipv4_dst),
403 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos,
405 ovs_frag_type_to_string(ipv4_key->ipv4_frag));
408 case OVS_KEY_ATTR_IPV6: {
409 char src_str[INET6_ADDRSTRLEN];
410 char dst_str[INET6_ADDRSTRLEN];
412 ipv6_key = nl_attr_get(a);
413 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
414 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
416 ds_put_format(ds, "ipv6(src=%s,dst=%s,label=%#"PRIx32",proto=%"PRIu8
417 ",tclass=%#"PRIx8",hlimit=%"PRIu8",frag=%s)",
418 src_str, dst_str, ntohl(ipv6_key->ipv6_label),
419 ipv6_key->ipv6_proto, ipv6_key->ipv6_tclass,
420 ipv6_key->ipv6_hlimit,
421 ovs_frag_type_to_string(ipv6_key->ipv6_frag));
425 case OVS_KEY_ATTR_TCP:
426 tcp_key = nl_attr_get(a);
427 ds_put_format(ds, "tcp(src=%"PRIu16",dst=%"PRIu16")",
428 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
431 case OVS_KEY_ATTR_UDP:
432 udp_key = nl_attr_get(a);
433 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16")",
434 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
437 case OVS_KEY_ATTR_ICMP:
438 icmp_key = nl_attr_get(a);
439 ds_put_format(ds, "icmp(type=%"PRIu8",code=%"PRIu8")",
440 icmp_key->icmp_type, icmp_key->icmp_code);
443 case OVS_KEY_ATTR_ICMPV6:
444 icmpv6_key = nl_attr_get(a);
445 ds_put_format(ds, "icmpv6(type=%"PRIu8",code=%"PRIu8")",
446 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
449 case OVS_KEY_ATTR_ARP:
450 arp_key = nl_attr_get(a);
451 ds_put_format(ds, "arp(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
452 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
453 IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
454 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
455 ETH_ADDR_ARGS(arp_key->arp_tha));
458 case OVS_KEY_ATTR_ND: {
459 char target[INET6_ADDRSTRLEN];
461 nd_key = nl_attr_get(a);
462 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
464 ds_put_format(ds, "nd(target=%s", target);
465 if (!eth_addr_is_zero(nd_key->nd_sll)) {
466 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
467 ETH_ADDR_ARGS(nd_key->nd_sll));
469 if (!eth_addr_is_zero(nd_key->nd_tll)) {
470 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
471 ETH_ADDR_ARGS(nd_key->nd_tll));
473 ds_put_char(ds, ')');
477 case OVS_KEY_ATTR_UNSPEC:
478 case __OVS_KEY_ATTR_MAX:
480 format_generic_odp_key(a, ds);
485 /* Appends to 'ds' a string representation of the 'key_len' bytes of
486 * OVS_KEY_ATTR_* attributes in 'key'. */
488 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
491 const struct nlattr *a;
494 NL_ATTR_FOR_EACH (a, left, key, key_len) {
496 ds_put_char(ds, ',');
498 format_odp_key_attr(a, ds);
501 if (left == key_len) {
502 ds_put_cstr(ds, "<empty>");
504 ds_put_format(ds, ",***%u leftover bytes***", left);
507 ds_put_cstr(ds, "<empty>");
512 put_nd_key(int n, const char *nd_target_s,
513 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
515 struct ovs_key_nd nd_key;
517 memset(&nd_key, 0, sizeof nd_key);
518 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
522 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
525 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
527 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
532 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
534 if (!strcasecmp(s, "no")) {
535 *type = OVS_FRAG_TYPE_NONE;
536 } else if (!strcasecmp(s, "first")) {
537 *type = OVS_FRAG_TYPE_FIRST;
538 } else if (!strcasecmp(s, "later")) {
539 *type = OVS_FRAG_TYPE_LATER;
547 parse_odp_key_attr(const char *s, struct ofpbuf *key)
549 /* Many of the sscanf calls in this function use oversized destination
550 * fields because some sscanf() implementations truncate the range of %i
551 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
552 * value of 0x7fff. The other alternatives are to allow only a single
553 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
556 * The tun_id parser has to use an alternative approach because there is no
557 * type larger than 64 bits. */
560 unsigned long long int priority;
563 if (sscanf(s, "priority(%lli)%n", &priority, &n) > 0 && n > 0) {
564 nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
573 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
574 tun_id_s, &n) > 0 && n > 0) {
575 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
576 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
582 unsigned long long int in_port;
585 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
586 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
592 struct ovs_key_ethernet eth_key;
596 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
597 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
598 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
599 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
600 ð_key, sizeof eth_key);
606 uint16_t tpid = ETH_TYPE_VLAN;
611 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n",
612 &vid, &pcp, &n) > 0 && n > 0) ||
613 (sscanf(s, "vlan(tpid=%"SCNi16",vid=%"SCNi16",pcp=%i)%n",
614 &tpid, &vid, &pcp, &n) > 0 && n > 0)) {
615 struct ovs_key_8021q q_key;
617 q_key.q_tpid = htons(tpid);
618 q_key.q_tci = htons((vid << VLAN_VID_SHIFT) |
619 (pcp << VLAN_PCP_SHIFT));
620 nl_msg_put_unspec(key, OVS_KEY_ATTR_8021Q, &q_key, sizeof q_key);
629 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
630 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
642 enum ovs_frag_type ipv4_frag;
645 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
646 "proto=%i,tos=%i,ttl=%i,frag=%7[a-z])%n",
647 IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
648 &ipv4_proto, &ipv4_tos, &ipv4_ttl, frag, &n) > 0
650 && ovs_frag_type_from_string(frag, &ipv4_frag)) {
651 struct ovs_key_ipv4 ipv4_key;
653 ipv4_key.ipv4_src = ipv4_src;
654 ipv4_key.ipv4_dst = ipv4_dst;
655 ipv4_key.ipv4_proto = ipv4_proto;
656 ipv4_key.ipv4_tos = ipv4_tos;
657 ipv4_key.ipv4_ttl = ipv4_ttl;
658 ipv4_key.ipv4_frag = ipv4_frag;
659 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
660 &ipv4_key, sizeof ipv4_key);
666 char ipv6_src_s[IPV6_SCAN_LEN + 1];
667 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
673 enum ovs_frag_type ipv6_frag;
676 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
677 "label=%i,proto=%i,tclass=%i,hlimit=%i,frag=%7[a-z])%n",
678 ipv6_src_s, ipv6_dst_s, &ipv6_label,
679 &ipv6_proto, &ipv6_tclass, &ipv6_hlimit, frag, &n) > 0
681 && ovs_frag_type_from_string(frag, &ipv6_frag)) {
682 struct ovs_key_ipv6 ipv6_key;
684 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
685 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
688 ipv6_key.ipv6_label = htonl(ipv6_label);
689 ipv6_key.ipv6_proto = ipv6_proto;
690 ipv6_key.ipv6_tclass = ipv6_tclass;
691 ipv6_key.ipv6_hlimit = ipv6_hlimit;
692 ipv6_key.ipv6_frag = ipv6_frag;
693 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
694 &ipv6_key, sizeof ipv6_key);
704 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
706 struct ovs_key_tcp tcp_key;
708 tcp_key.tcp_src = htons(tcp_src);
709 tcp_key.tcp_dst = htons(tcp_dst);
710 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
720 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
722 struct ovs_key_udp udp_key;
724 udp_key.udp_src = htons(udp_src);
725 udp_key.udp_dst = htons(udp_dst);
726 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
736 if (sscanf(s, "icmp(type=%i,code=%i)%n",
737 &icmp_type, &icmp_code, &n) > 0
739 struct ovs_key_icmp icmp_key;
741 icmp_key.icmp_type = icmp_type;
742 icmp_key.icmp_code = icmp_code;
743 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
744 &icmp_key, sizeof icmp_key);
750 struct ovs_key_icmpv6 icmpv6_key;
753 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
754 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
756 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
757 &icmpv6_key, sizeof icmpv6_key);
766 uint8_t arp_sha[ETH_ADDR_LEN];
767 uint8_t arp_tha[ETH_ADDR_LEN];
770 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
771 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
772 IP_SCAN_ARGS(&arp_sip),
773 IP_SCAN_ARGS(&arp_tip),
775 ETH_ADDR_SCAN_ARGS(arp_sha),
776 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
777 struct ovs_key_arp arp_key;
779 memset(&arp_key, 0, sizeof arp_key);
780 arp_key.arp_sip = arp_sip;
781 arp_key.arp_tip = arp_tip;
782 arp_key.arp_op = htons(arp_op);
783 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
784 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
785 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
791 char nd_target_s[IPV6_SCAN_LEN + 1];
792 uint8_t nd_sll[ETH_ADDR_LEN];
793 uint8_t nd_tll[ETH_ADDR_LEN];
796 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
797 nd_target_s, &n) > 0 && n > 0) {
798 return put_nd_key(n, nd_target_s, NULL, NULL, key);
800 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
801 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
803 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
805 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
806 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
808 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
810 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
811 "tll="ETH_ADDR_SCAN_FMT")%n",
812 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
813 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
815 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
822 /* Parses the string representation of a datapath flow key, in the
823 * format output by odp_flow_key_format(). Returns 0 if successful,
824 * otherwise a positive errno value. On success, the flow key is
825 * appended to 'key' as a series of Netlink attributes. On failure, no
826 * data is appended to 'key'. Either way, 'key''s data might be
829 * On success, the attributes appended to 'key' are individually syntactically
830 * valid, but they may not be valid as a sequence. 'key' might, for example,
831 * be missing an "in_port" key, have duplicated keys, or have keys in the wrong
832 * order. odp_flow_key_to_flow() will detect those errors. */
834 odp_flow_key_from_string(const char *s, struct ofpbuf *key)
836 const size_t old_size = key->size;
840 s += strspn(s, ", \t\r\n");
845 retval = parse_odp_key_attr(s, key);
847 key->size = old_size;
857 ovs_to_odp_frag(uint8_t ovs_frag)
859 return (ovs_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
860 : ovs_frag & FLOW_NW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
861 : OVS_FRAG_TYPE_NONE);
864 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
866 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
868 struct ovs_key_ethernet *eth_key;
870 if (flow->priority) {
871 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, flow->priority);
874 if (flow->tun_id != htonll(0)) {
875 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
878 if (flow->in_port != OFPP_NONE) {
879 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
880 ofp_port_to_odp_port(flow->in_port));
883 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
885 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
886 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
888 if (flow->vlan_tci != htons(0)) {
889 struct ovs_key_8021q *q_key;
891 q_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_8021Q,
893 q_key->q_tpid = htons(ETH_TYPE_VLAN);
894 q_key->q_tci = flow->vlan_tci & ~htons(VLAN_CFI);
897 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
901 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
903 if (flow->dl_type == htons(ETH_TYPE_IP)) {
904 struct ovs_key_ipv4 *ipv4_key;
906 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
908 ipv4_key->ipv4_src = flow->nw_src;
909 ipv4_key->ipv4_dst = flow->nw_dst;
910 ipv4_key->ipv4_proto = flow->nw_proto;
911 ipv4_key->ipv4_tos = flow->nw_tos;
912 ipv4_key->ipv4_ttl = flow->nw_ttl;
913 ipv4_key->ipv4_frag = ovs_to_odp_frag(flow->nw_frag);
914 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
915 struct ovs_key_ipv6 *ipv6_key;
917 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
919 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
920 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
921 ipv6_key->ipv6_label = flow->ipv6_label;
922 ipv6_key->ipv6_proto = flow->nw_proto;
923 ipv6_key->ipv6_tclass = flow->nw_tos;
924 ipv6_key->ipv6_hlimit = flow->nw_ttl;
925 ipv6_key->ipv6_frag = ovs_to_odp_frag(flow->nw_frag);
926 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
927 struct ovs_key_arp *arp_key;
929 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
931 memset(arp_key, 0, sizeof *arp_key);
932 arp_key->arp_sip = flow->nw_src;
933 arp_key->arp_tip = flow->nw_dst;
934 arp_key->arp_op = htons(flow->nw_proto);
935 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
936 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
939 if ((flow->dl_type == htons(ETH_TYPE_IP)
940 || flow->dl_type == htons(ETH_TYPE_IPV6))
941 && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
943 if (flow->nw_proto == IPPROTO_TCP) {
944 struct ovs_key_tcp *tcp_key;
946 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
948 tcp_key->tcp_src = flow->tp_src;
949 tcp_key->tcp_dst = flow->tp_dst;
950 } else if (flow->nw_proto == IPPROTO_UDP) {
951 struct ovs_key_udp *udp_key;
953 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
955 udp_key->udp_src = flow->tp_src;
956 udp_key->udp_dst = flow->tp_dst;
957 } else if (flow->dl_type == htons(ETH_TYPE_IP)
958 && flow->nw_proto == IPPROTO_ICMP) {
959 struct ovs_key_icmp *icmp_key;
961 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
963 icmp_key->icmp_type = ntohs(flow->tp_src);
964 icmp_key->icmp_code = ntohs(flow->tp_dst);
965 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
966 && flow->nw_proto == IPPROTO_ICMPV6) {
967 struct ovs_key_icmpv6 *icmpv6_key;
969 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
971 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
972 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
974 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
975 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
976 struct ovs_key_nd *nd_key;
978 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
980 memcpy(nd_key->nd_target, &flow->nd_target,
981 sizeof nd_key->nd_target);
982 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
983 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
990 odp_to_ovs_frag(uint8_t odp_frag, struct flow *flow)
992 if (odp_frag > OVS_FRAG_TYPE_LATER) {
996 if (odp_frag != OVS_FRAG_TYPE_NONE) {
997 flow->nw_frag |= FLOW_NW_FRAG_ANY;
998 if (odp_frag == OVS_FRAG_TYPE_LATER) {
999 flow->nw_frag |= FLOW_NW_FRAG_LATER;
1005 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
1006 * structure in 'flow'. Returns 0 if successful, otherwise EINVAL. */
1008 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
1011 const struct nlattr *nla;
1012 enum ovs_key_attr prev_type;
1015 memset(flow, 0, sizeof *flow);
1016 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
1017 flow->in_port = OFPP_NONE;
1019 prev_type = OVS_KEY_ATTR_UNSPEC;
1020 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
1021 const struct ovs_key_ethernet *eth_key;
1022 const struct ovs_key_8021q *q_key;
1023 const struct ovs_key_ipv4 *ipv4_key;
1024 const struct ovs_key_ipv6 *ipv6_key;
1025 const struct ovs_key_tcp *tcp_key;
1026 const struct ovs_key_udp *udp_key;
1027 const struct ovs_key_icmp *icmp_key;
1028 const struct ovs_key_icmpv6 *icmpv6_key;
1029 const struct ovs_key_arp *arp_key;
1030 const struct ovs_key_nd *nd_key;
1032 uint16_t type = nl_attr_type(nla);
1033 int len = odp_flow_key_attr_len(type);
1035 if (nl_attr_get_size(nla) != len && len != -1) {
1039 #define TRANSITION(PREV_TYPE, TYPE) (((PREV_TYPE) << 16) | (TYPE))
1040 switch (TRANSITION(prev_type, type)) {
1041 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_PRIORITY):
1042 flow->priority = nl_attr_get_u32(nla);
1045 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_TUN_ID):
1046 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_TUN_ID):
1047 flow->tun_id = nl_attr_get_be64(nla);
1050 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_IN_PORT):
1051 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_IN_PORT):
1052 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_IN_PORT):
1053 if (nl_attr_get_u32(nla) >= UINT16_MAX) {
1056 flow->in_port = odp_port_to_ofp_port(nl_attr_get_u32(nla));
1059 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_ETHERNET):
1060 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_ETHERNET):
1061 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_ETHERNET):
1062 case TRANSITION(OVS_KEY_ATTR_IN_PORT, OVS_KEY_ATTR_ETHERNET):
1063 eth_key = nl_attr_get(nla);
1064 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
1065 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
1068 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_8021Q):
1069 q_key = nl_attr_get(nla);
1070 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
1071 /* Only standard 0x8100 VLANs currently supported. */
1074 if (q_key->q_tci & htons(VLAN_CFI)) {
1077 flow->vlan_tci = q_key->q_tci | htons(VLAN_CFI);
1080 case TRANSITION(OVS_KEY_ATTR_8021Q, OVS_KEY_ATTR_ETHERTYPE):
1081 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_ETHERTYPE):
1082 flow->dl_type = nl_attr_get_be16(nla);
1083 if (ntohs(flow->dl_type) < 1536) {
1088 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV4):
1089 if (flow->dl_type != htons(ETH_TYPE_IP)) {
1092 ipv4_key = nl_attr_get(nla);
1093 flow->nw_src = ipv4_key->ipv4_src;
1094 flow->nw_dst = ipv4_key->ipv4_dst;
1095 flow->nw_proto = ipv4_key->ipv4_proto;
1096 flow->nw_tos = ipv4_key->ipv4_tos;
1097 flow->nw_ttl = ipv4_key->ipv4_ttl;
1098 if (!odp_to_ovs_frag(ipv4_key->ipv4_frag, flow)) {
1103 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV6):
1104 if (flow->dl_type != htons(ETH_TYPE_IPV6)) {
1107 ipv6_key = nl_attr_get(nla);
1108 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
1109 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
1110 flow->ipv6_label = ipv6_key->ipv6_label;
1111 flow->nw_proto = ipv6_key->ipv6_proto;
1112 flow->nw_tos = ipv6_key->ipv6_tclass;
1113 flow->nw_ttl = ipv6_key->ipv6_hlimit;
1114 if (!odp_to_ovs_frag(ipv6_key->ipv6_frag, flow)) {
1119 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_TCP):
1120 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_TCP):
1121 if (flow->nw_proto != IPPROTO_TCP) {
1124 tcp_key = nl_attr_get(nla);
1125 flow->tp_src = tcp_key->tcp_src;
1126 flow->tp_dst = tcp_key->tcp_dst;
1129 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_UDP):
1130 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_UDP):
1131 if (flow->nw_proto != IPPROTO_UDP) {
1134 udp_key = nl_attr_get(nla);
1135 flow->tp_src = udp_key->udp_src;
1136 flow->tp_dst = udp_key->udp_dst;
1139 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_ICMP):
1140 if (flow->nw_proto != IPPROTO_ICMP) {
1143 icmp_key = nl_attr_get(nla);
1144 flow->tp_src = htons(icmp_key->icmp_type);
1145 flow->tp_dst = htons(icmp_key->icmp_code);
1148 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_ICMPV6):
1149 if (flow->nw_proto != IPPROTO_ICMPV6) {
1152 icmpv6_key = nl_attr_get(nla);
1153 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1154 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1157 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_ARP):
1158 if (flow->dl_type != htons(ETH_TYPE_ARP)) {
1161 arp_key = nl_attr_get(nla);
1162 flow->nw_src = arp_key->arp_sip;
1163 flow->nw_dst = arp_key->arp_tip;
1164 if (arp_key->arp_op & htons(0xff00)) {
1167 flow->nw_proto = ntohs(arp_key->arp_op);
1168 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1169 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1172 case TRANSITION(OVS_KEY_ATTR_ICMPV6, OVS_KEY_ATTR_ND):
1173 if (flow->tp_src != htons(ND_NEIGHBOR_SOLICIT)
1174 && flow->tp_src != htons(ND_NEIGHBOR_ADVERT)) {
1177 nd_key = nl_attr_get(nla);
1178 memcpy(&flow->nd_target, nd_key->nd_target, sizeof flow->nd_target);
1179 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1180 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1193 switch (prev_type) {
1194 case OVS_KEY_ATTR_UNSPEC:
1197 case OVS_KEY_ATTR_PRIORITY:
1198 case OVS_KEY_ATTR_TUN_ID:
1199 case OVS_KEY_ATTR_IN_PORT:
1202 case OVS_KEY_ATTR_ETHERNET:
1203 case OVS_KEY_ATTR_8021Q:
1206 case OVS_KEY_ATTR_ETHERTYPE:
1207 if (flow->dl_type == htons(ETH_TYPE_IP)
1208 || flow->dl_type == htons(ETH_TYPE_IPV6)
1209 || flow->dl_type == htons(ETH_TYPE_ARP)) {
1214 case OVS_KEY_ATTR_IPV4:
1215 if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1218 if (flow->nw_proto == IPPROTO_TCP
1219 || flow->nw_proto == IPPROTO_UDP
1220 || flow->nw_proto == IPPROTO_ICMP) {
1225 case OVS_KEY_ATTR_IPV6:
1226 if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1229 if (flow->nw_proto == IPPROTO_TCP
1230 || flow->nw_proto == IPPROTO_UDP
1231 || flow->nw_proto == IPPROTO_ICMPV6) {
1236 case OVS_KEY_ATTR_ICMPV6:
1237 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
1238 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT)
1239 || flow->nw_frag & FLOW_NW_FRAG_LATER) {
1244 case OVS_KEY_ATTR_TCP:
1245 case OVS_KEY_ATTR_UDP:
1246 case OVS_KEY_ATTR_ICMP:
1247 case OVS_KEY_ATTR_ND:
1248 if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
1253 case OVS_KEY_ATTR_ARP:
1256 case __OVS_KEY_ATTR_MAX: