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",proto=%"PRIu8
373 ",tos=%#"PRIx8",ttl=%"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,
378 ovs_frag_type_to_string(ipv4_key->ipv4_frag));
381 case OVS_KEY_ATTR_IPV6: {
382 char src_str[INET6_ADDRSTRLEN];
383 char dst_str[INET6_ADDRSTRLEN];
385 ipv6_key = nl_attr_get(a);
386 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
387 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
389 ds_put_format(ds, "ipv6(src=%s,dst=%s,label=%#"PRIx32",proto=%"PRIu8
390 ",tos=%#"PRIx8",hlimit=%"PRIu8",frag=%s)",
391 src_str, dst_str, ntohl(ipv6_key->ipv6_label),
392 ipv6_key->ipv6_proto, ipv6_key->ipv6_tos,
393 ipv6_key->ipv6_hlimit,
394 ovs_frag_type_to_string(ipv6_key->ipv6_frag));
398 case OVS_KEY_ATTR_TCP:
399 tcp_key = nl_attr_get(a);
400 ds_put_format(ds, "tcp(src=%"PRIu16",dst=%"PRIu16")",
401 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
404 case OVS_KEY_ATTR_UDP:
405 udp_key = nl_attr_get(a);
406 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16")",
407 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
410 case OVS_KEY_ATTR_ICMP:
411 icmp_key = nl_attr_get(a);
412 ds_put_format(ds, "icmp(type=%"PRIu8",code=%"PRIu8")",
413 icmp_key->icmp_type, icmp_key->icmp_code);
416 case OVS_KEY_ATTR_ICMPV6:
417 icmpv6_key = nl_attr_get(a);
418 ds_put_format(ds, "icmpv6(type=%"PRIu8",code=%"PRIu8")",
419 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
422 case OVS_KEY_ATTR_ARP:
423 arp_key = nl_attr_get(a);
424 ds_put_format(ds, "arp(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
425 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
426 IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
427 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
428 ETH_ADDR_ARGS(arp_key->arp_tha));
431 case OVS_KEY_ATTR_ND: {
432 char target[INET6_ADDRSTRLEN];
434 nd_key = nl_attr_get(a);
435 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
437 ds_put_format(ds, "nd(target=%s", target);
438 if (!eth_addr_is_zero(nd_key->nd_sll)) {
439 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
440 ETH_ADDR_ARGS(nd_key->nd_sll));
442 if (!eth_addr_is_zero(nd_key->nd_tll)) {
443 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
444 ETH_ADDR_ARGS(nd_key->nd_tll));
446 ds_put_char(ds, ')');
451 format_generic_odp_key(a, ds);
456 /* Appends to 'ds' a string representation of the 'key_len' bytes of
457 * OVS_KEY_ATTR_* attributes in 'key'. */
459 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
462 const struct nlattr *a;
465 NL_ATTR_FOR_EACH (a, left, key, key_len) {
467 ds_put_char(ds, ',');
469 format_odp_key_attr(a, ds);
472 if (left == key_len) {
473 ds_put_cstr(ds, "<empty>");
475 ds_put_format(ds, ",***%u leftover bytes***", left);
478 ds_put_cstr(ds, "<empty>");
483 put_nd_key(int n, const char *nd_target_s,
484 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
486 struct ovs_key_nd nd_key;
488 memset(&nd_key, 0, sizeof nd_key);
489 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
493 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
496 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
498 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
503 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
505 if (!strcasecmp(s, "no")) {
506 *type = OVS_FRAG_TYPE_NONE;
507 } else if (!strcasecmp(s, "first")) {
508 *type = OVS_FRAG_TYPE_FIRST;
509 } else if (!strcasecmp(s, "later")) {
510 *type = OVS_FRAG_TYPE_LATER;
518 parse_odp_key_attr(const char *s, struct ofpbuf *key)
520 /* Many of the sscanf calls in this function use oversized destination
521 * fields because some sscanf() implementations truncate the range of %i
522 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
523 * value of 0x7fff. The other alternatives are to allow only a single
524 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
527 * The tun_id parser has to use an alternative approach because there is no
528 * type larger than 64 bits. */
531 unsigned long long int priority;
534 if (sscanf(s, "priority(%lli)%n", &priority, &n) > 0 && n > 0) {
535 nl_msg_put_u32(key, OVS_KEY_ATTR_PRIORITY, priority);
544 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
545 tun_id_s, &n) > 0 && n > 0) {
546 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
547 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
553 unsigned long long int in_port;
556 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
557 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
563 struct ovs_key_ethernet eth_key;
567 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
568 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
569 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
570 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
571 ð_key, sizeof eth_key);
577 uint16_t tpid = ETH_TYPE_VLAN;
582 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n",
583 &vid, &pcp, &n) > 0 && n > 0) ||
584 (sscanf(s, "vlan(tpid=%"SCNi16",vid=%"SCNi16",pcp=%i)%n",
585 &tpid, &vid, &pcp, &n) > 0 && n > 0)) {
586 struct ovs_key_8021q q_key;
588 q_key.q_tpid = htons(tpid);
589 q_key.q_tci = htons((vid << VLAN_VID_SHIFT) |
590 (pcp << VLAN_PCP_SHIFT));
591 nl_msg_put_unspec(key, OVS_KEY_ATTR_8021Q, &q_key, sizeof q_key);
600 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
601 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
613 enum ovs_frag_type ipv4_frag;
616 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
617 "proto=%i,tos=%i,ttl=%i,frag=%7[a-z])%n",
618 IP_SCAN_ARGS(&ipv4_src), IP_SCAN_ARGS(&ipv4_dst),
619 &ipv4_proto, &ipv4_tos, &ipv4_ttl, frag, &n) > 0
621 && ovs_frag_type_from_string(frag, &ipv4_frag)) {
622 struct ovs_key_ipv4 ipv4_key;
624 ipv4_key.ipv4_src = ipv4_src;
625 ipv4_key.ipv4_dst = ipv4_dst;
626 ipv4_key.ipv4_proto = ipv4_proto;
627 ipv4_key.ipv4_tos = ipv4_tos;
628 ipv4_key.ipv4_ttl = ipv4_ttl;
629 ipv4_key.ipv4_frag = ipv4_frag;
630 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
631 &ipv4_key, sizeof ipv4_key);
637 char ipv6_src_s[IPV6_SCAN_LEN + 1];
638 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
644 enum ovs_frag_type ipv6_frag;
647 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
648 "label=%i,proto=%i,tos=%i,hlimit=%i,frag=%7[a-z])%n",
649 ipv6_src_s, ipv6_dst_s, &ipv6_label,
650 &ipv6_proto, &ipv6_tos, &ipv6_hlimit, frag, &n) > 0
652 && ovs_frag_type_from_string(frag, &ipv6_frag)) {
653 struct ovs_key_ipv6 ipv6_key;
655 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
656 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
659 ipv6_key.ipv6_label = htonl(ipv6_label);
660 ipv6_key.ipv6_proto = ipv6_proto;
661 ipv6_key.ipv6_tos = ipv6_tos;
662 ipv6_key.ipv6_hlimit = ipv6_hlimit;
663 ipv6_key.ipv6_frag = ipv6_frag;
664 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
665 &ipv6_key, sizeof ipv6_key);
675 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
677 struct ovs_key_tcp tcp_key;
679 tcp_key.tcp_src = htons(tcp_src);
680 tcp_key.tcp_dst = htons(tcp_dst);
681 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
691 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
693 struct ovs_key_udp udp_key;
695 udp_key.udp_src = htons(udp_src);
696 udp_key.udp_dst = htons(udp_dst);
697 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
707 if (sscanf(s, "icmp(type=%i,code=%i)%n",
708 &icmp_type, &icmp_code, &n) > 0
710 struct ovs_key_icmp icmp_key;
712 icmp_key.icmp_type = icmp_type;
713 icmp_key.icmp_code = icmp_code;
714 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
715 &icmp_key, sizeof icmp_key);
721 struct ovs_key_icmpv6 icmpv6_key;
724 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
725 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
727 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
728 &icmpv6_key, sizeof icmpv6_key);
737 uint8_t arp_sha[ETH_ADDR_LEN];
738 uint8_t arp_tha[ETH_ADDR_LEN];
741 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
742 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
743 IP_SCAN_ARGS(&arp_sip),
744 IP_SCAN_ARGS(&arp_tip),
746 ETH_ADDR_SCAN_ARGS(arp_sha),
747 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
748 struct ovs_key_arp arp_key;
750 memset(&arp_key, 0, sizeof arp_key);
751 arp_key.arp_sip = arp_sip;
752 arp_key.arp_tip = arp_tip;
753 arp_key.arp_op = htons(arp_op);
754 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
755 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
756 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
762 char nd_target_s[IPV6_SCAN_LEN + 1];
763 uint8_t nd_sll[ETH_ADDR_LEN];
764 uint8_t nd_tll[ETH_ADDR_LEN];
767 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
768 nd_target_s, &n) > 0 && n > 0) {
769 return put_nd_key(n, nd_target_s, NULL, NULL, key);
771 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
772 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
774 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
776 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
777 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
779 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
781 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
782 "tll="ETH_ADDR_SCAN_FMT")%n",
783 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
784 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
786 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
793 /* Parses the string representation of a datapath flow key, in the
794 * format output by odp_flow_key_format(). Returns 0 if successful,
795 * otherwise a positive errno value. On success, the flow key is
796 * appended to 'key' as a series of Netlink attributes. On failure, no
797 * data is appended to 'key'. Either way, 'key''s data might be
800 * On success, the attributes appended to 'key' are individually syntactically
801 * valid, but they may not be valid as a sequence. 'key' might, for example,
802 * be missing an "in_port" key, have duplicated keys, or have keys in the wrong
803 * order. odp_flow_key_to_flow() will detect those errors. */
805 odp_flow_key_from_string(const char *s, struct ofpbuf *key)
807 const size_t old_size = key->size;
811 s += strspn(s, ", \t\r\n");
816 retval = parse_odp_key_attr(s, key);
818 key->size = old_size;
828 ovs_to_odp_frag(uint8_t ovs_frag)
830 return (ovs_frag & FLOW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
831 : ovs_frag & FLOW_FRAG_ANY ? OVS_FRAG_TYPE_FIRST
832 : OVS_FRAG_TYPE_NONE);
835 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
837 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
839 struct ovs_key_ethernet *eth_key;
841 if (flow->priority) {
842 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, flow->priority);
845 if (flow->tun_id != htonll(0)) {
846 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
849 if (flow->in_port != OFPP_NONE) {
850 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
851 ofp_port_to_odp_port(flow->in_port));
854 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
856 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
857 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
859 if (flow->vlan_tci != htons(0)) {
860 struct ovs_key_8021q *q_key;
862 q_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_8021Q,
864 q_key->q_tpid = htons(ETH_TYPE_VLAN);
865 q_key->q_tci = flow->vlan_tci & ~htons(VLAN_CFI);
868 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
872 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
874 if (flow->dl_type == htons(ETH_TYPE_IP)) {
875 struct ovs_key_ipv4 *ipv4_key;
877 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
879 ipv4_key->ipv4_src = flow->nw_src;
880 ipv4_key->ipv4_dst = flow->nw_dst;
881 ipv4_key->ipv4_proto = flow->nw_proto;
882 ipv4_key->ipv4_tos = flow->tos;
883 ipv4_key->ipv4_ttl = flow->nw_ttl;
884 ipv4_key->ipv4_frag = ovs_to_odp_frag(flow->frag);
885 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
886 struct ovs_key_ipv6 *ipv6_key;
888 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
890 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
891 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
892 ipv6_key->ipv6_label = flow->ipv6_label;
893 ipv6_key->ipv6_proto = flow->nw_proto;
894 ipv6_key->ipv6_tos = flow->tos;
895 ipv6_key->ipv6_hlimit = flow->nw_ttl;
896 ipv6_key->ipv6_frag = ovs_to_odp_frag(flow->frag);
897 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
898 struct ovs_key_arp *arp_key;
900 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
902 memset(arp_key, 0, sizeof *arp_key);
903 arp_key->arp_sip = flow->nw_src;
904 arp_key->arp_tip = flow->nw_dst;
905 arp_key->arp_op = htons(flow->nw_proto);
906 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
907 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
910 if ((flow->dl_type == htons(ETH_TYPE_IP)
911 || flow->dl_type == htons(ETH_TYPE_IPV6))
912 && !(flow->frag & FLOW_FRAG_LATER)) {
914 if (flow->nw_proto == IPPROTO_TCP) {
915 struct ovs_key_tcp *tcp_key;
917 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
919 tcp_key->tcp_src = flow->tp_src;
920 tcp_key->tcp_dst = flow->tp_dst;
921 } else if (flow->nw_proto == IPPROTO_UDP) {
922 struct ovs_key_udp *udp_key;
924 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
926 udp_key->udp_src = flow->tp_src;
927 udp_key->udp_dst = flow->tp_dst;
928 } else if (flow->dl_type == htons(ETH_TYPE_IP)
929 && flow->nw_proto == IPPROTO_ICMP) {
930 struct ovs_key_icmp *icmp_key;
932 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
934 icmp_key->icmp_type = ntohs(flow->tp_src);
935 icmp_key->icmp_code = ntohs(flow->tp_dst);
936 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
937 && flow->nw_proto == IPPROTO_ICMPV6) {
938 struct ovs_key_icmpv6 *icmpv6_key;
940 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
942 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
943 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
945 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
946 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
947 struct ovs_key_nd *nd_key;
949 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
951 memcpy(nd_key->nd_target, &flow->nd_target,
952 sizeof nd_key->nd_target);
953 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
954 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
961 odp_to_ovs_frag(uint8_t odp_frag, struct flow *flow)
963 if (odp_frag > OVS_FRAG_TYPE_LATER) {
967 if (odp_frag != OVS_FRAG_TYPE_NONE) {
968 flow->frag |= FLOW_FRAG_ANY;
969 if (odp_frag == OVS_FRAG_TYPE_LATER) {
970 flow->frag |= FLOW_FRAG_LATER;
976 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
977 * structure in 'flow'. Returns 0 if successful, otherwise EINVAL. */
979 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
982 const struct nlattr *nla;
983 enum ovs_key_attr prev_type;
986 memset(flow, 0, sizeof *flow);
987 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
988 flow->in_port = OFPP_NONE;
990 prev_type = OVS_KEY_ATTR_UNSPEC;
991 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
992 const struct ovs_key_ethernet *eth_key;
993 const struct ovs_key_8021q *q_key;
994 const struct ovs_key_ipv4 *ipv4_key;
995 const struct ovs_key_ipv6 *ipv6_key;
996 const struct ovs_key_tcp *tcp_key;
997 const struct ovs_key_udp *udp_key;
998 const struct ovs_key_icmp *icmp_key;
999 const struct ovs_key_icmpv6 *icmpv6_key;
1000 const struct ovs_key_arp *arp_key;
1001 const struct ovs_key_nd *nd_key;
1003 uint16_t type = nl_attr_type(nla);
1004 int len = odp_flow_key_attr_len(type);
1006 if (nl_attr_get_size(nla) != len && len != -1) {
1010 #define TRANSITION(PREV_TYPE, TYPE) (((PREV_TYPE) << 16) | (TYPE))
1011 switch (TRANSITION(prev_type, type)) {
1012 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_PRIORITY):
1013 flow->priority = nl_attr_get_u32(nla);
1016 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_TUN_ID):
1017 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_TUN_ID):
1018 flow->tun_id = nl_attr_get_be64(nla);
1021 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_IN_PORT):
1022 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_IN_PORT):
1023 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_IN_PORT):
1024 if (nl_attr_get_u32(nla) >= UINT16_MAX) {
1027 flow->in_port = odp_port_to_ofp_port(nl_attr_get_u32(nla));
1030 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_ETHERNET):
1031 case TRANSITION(OVS_KEY_ATTR_PRIORITY, OVS_KEY_ATTR_ETHERNET):
1032 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_ETHERNET):
1033 case TRANSITION(OVS_KEY_ATTR_IN_PORT, OVS_KEY_ATTR_ETHERNET):
1034 eth_key = nl_attr_get(nla);
1035 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
1036 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
1039 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_8021Q):
1040 q_key = nl_attr_get(nla);
1041 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
1042 /* Only standard 0x8100 VLANs currently supported. */
1045 if (q_key->q_tci & htons(VLAN_CFI)) {
1048 flow->vlan_tci = q_key->q_tci | htons(VLAN_CFI);
1051 case TRANSITION(OVS_KEY_ATTR_8021Q, OVS_KEY_ATTR_ETHERTYPE):
1052 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_ETHERTYPE):
1053 flow->dl_type = nl_attr_get_be16(nla);
1054 if (ntohs(flow->dl_type) < 1536) {
1059 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV4):
1060 if (flow->dl_type != htons(ETH_TYPE_IP)) {
1063 ipv4_key = nl_attr_get(nla);
1064 flow->nw_src = ipv4_key->ipv4_src;
1065 flow->nw_dst = ipv4_key->ipv4_dst;
1066 flow->nw_proto = ipv4_key->ipv4_proto;
1067 flow->tos = ipv4_key->ipv4_tos;
1068 flow->nw_ttl = ipv4_key->ipv4_ttl;
1069 if (!odp_to_ovs_frag(ipv4_key->ipv4_frag, flow)) {
1074 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV6):
1075 if (flow->dl_type != htons(ETH_TYPE_IPV6)) {
1078 ipv6_key = nl_attr_get(nla);
1079 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
1080 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
1081 flow->ipv6_label = ipv6_key->ipv6_label;
1082 flow->nw_proto = ipv6_key->ipv6_proto;
1083 flow->tos = ipv6_key->ipv6_tos;
1084 flow->nw_ttl = ipv6_key->ipv6_hlimit;
1085 if (!odp_to_ovs_frag(ipv6_key->ipv6_frag, flow)) {
1090 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_TCP):
1091 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_TCP):
1092 if (flow->nw_proto != IPPROTO_TCP) {
1095 tcp_key = nl_attr_get(nla);
1096 flow->tp_src = tcp_key->tcp_src;
1097 flow->tp_dst = tcp_key->tcp_dst;
1100 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_UDP):
1101 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_UDP):
1102 if (flow->nw_proto != IPPROTO_UDP) {
1105 udp_key = nl_attr_get(nla);
1106 flow->tp_src = udp_key->udp_src;
1107 flow->tp_dst = udp_key->udp_dst;
1110 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_ICMP):
1111 if (flow->nw_proto != IPPROTO_ICMP) {
1114 icmp_key = nl_attr_get(nla);
1115 flow->tp_src = htons(icmp_key->icmp_type);
1116 flow->tp_dst = htons(icmp_key->icmp_code);
1119 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_ICMPV6):
1120 if (flow->nw_proto != IPPROTO_ICMPV6) {
1123 icmpv6_key = nl_attr_get(nla);
1124 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1125 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1128 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_ARP):
1129 if (flow->dl_type != htons(ETH_TYPE_ARP)) {
1132 arp_key = nl_attr_get(nla);
1133 flow->nw_src = arp_key->arp_sip;
1134 flow->nw_dst = arp_key->arp_tip;
1135 if (arp_key->arp_op & htons(0xff00)) {
1138 flow->nw_proto = ntohs(arp_key->arp_op);
1139 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1140 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1143 case TRANSITION(OVS_KEY_ATTR_ICMPV6, OVS_KEY_ATTR_ND):
1144 if (flow->tp_src != htons(ND_NEIGHBOR_SOLICIT)
1145 && flow->tp_src != htons(ND_NEIGHBOR_ADVERT)) {
1148 nd_key = nl_attr_get(nla);
1149 memcpy(&flow->nd_target, nd_key->nd_target, sizeof flow->nd_target);
1150 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1151 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1164 switch (prev_type) {
1165 case OVS_KEY_ATTR_UNSPEC:
1168 case OVS_KEY_ATTR_PRIORITY:
1169 case OVS_KEY_ATTR_TUN_ID:
1170 case OVS_KEY_ATTR_IN_PORT:
1173 case OVS_KEY_ATTR_ETHERNET:
1174 case OVS_KEY_ATTR_8021Q:
1177 case OVS_KEY_ATTR_ETHERTYPE:
1178 if (flow->dl_type == htons(ETH_TYPE_IP)
1179 || flow->dl_type == htons(ETH_TYPE_IPV6)
1180 || flow->dl_type == htons(ETH_TYPE_ARP)) {
1185 case OVS_KEY_ATTR_IPV4:
1186 if (flow->frag & FLOW_FRAG_LATER) {
1189 if (flow->nw_proto == IPPROTO_TCP
1190 || flow->nw_proto == IPPROTO_UDP
1191 || flow->nw_proto == IPPROTO_ICMP) {
1196 case OVS_KEY_ATTR_IPV6:
1197 if (flow->frag & FLOW_FRAG_LATER) {
1200 if (flow->nw_proto == IPPROTO_TCP
1201 || flow->nw_proto == IPPROTO_UDP
1202 || flow->nw_proto == IPPROTO_ICMPV6) {
1207 case OVS_KEY_ATTR_ICMPV6:
1208 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
1209 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT)
1210 || flow->frag & FLOW_FRAG_LATER) {
1215 case OVS_KEY_ATTR_TCP:
1216 case OVS_KEY_ATTR_UDP:
1217 case OVS_KEY_ATTR_ICMP:
1218 case OVS_KEY_ATTR_ND:
1219 if (flow->frag & FLOW_FRAG_LATER) {
1224 case OVS_KEY_ATTR_ARP:
1227 case __OVS_KEY_ATTR_MAX: