2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include <arpa/inet.h>
22 #include <netinet/icmp6.h>
25 #include "byte-order.h"
27 #include "dynamic-string.h"
31 #include "openvswitch/tunnel.h"
36 /* The interface between userspace and kernel uses an "OVS_*" prefix.
37 * Since this is fairly non-specific for the OVS userspace components,
38 * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
39 * interactions with the datapath.
43 odp_action_len(uint16_t type)
45 if (type > OVS_ACTION_ATTR_MAX) {
49 switch ((enum ovs_action_type) type) {
50 case OVS_ACTION_ATTR_OUTPUT: return 4;
51 case OVS_ACTION_ATTR_USERSPACE: return 8;
52 case OVS_ACTION_ATTR_PUSH_VLAN: return 2;
53 case OVS_ACTION_ATTR_POP_VLAN: return 0;
54 case OVS_ACTION_ATTR_SET_DL_SRC: return ETH_ADDR_LEN;
55 case OVS_ACTION_ATTR_SET_DL_DST: return ETH_ADDR_LEN;
56 case OVS_ACTION_ATTR_SET_NW_SRC: return 4;
57 case OVS_ACTION_ATTR_SET_NW_DST: return 4;
58 case OVS_ACTION_ATTR_SET_NW_TOS: return 1;
59 case OVS_ACTION_ATTR_SET_TP_SRC: return 2;
60 case OVS_ACTION_ATTR_SET_TP_DST: return 2;
61 case OVS_ACTION_ATTR_SET_TUNNEL: return 8;
62 case OVS_ACTION_ATTR_SET_PRIORITY: return 4;
63 case OVS_ACTION_ATTR_POP_PRIORITY: return 0;
65 case OVS_ACTION_ATTR_SAMPLE:
66 case OVS_ACTION_ATTR_UNSPEC:
67 case __OVS_ACTION_ATTR_MAX:
75 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
77 size_t len = nl_attr_get_size(a);
79 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
81 const uint8_t *unspec;
84 unspec = nl_attr_get(a);
85 for (i = 0; i < len; i++) {
86 ds_put_char(ds, i ? ' ': '(');
87 ds_put_format(ds, "%02x", unspec[i]);
94 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
96 static const struct nl_policy ovs_sample_policy[] = {
97 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
98 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
100 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
102 const struct nlattr *nla_acts;
105 ds_put_cstr(ds, "sample");
107 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
108 ds_put_cstr(ds, "(error)");
112 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
115 ds_put_format(ds, "(sample=%.1f%%,", percentage);
117 ds_put_cstr(ds, "actions(");
118 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
119 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
120 format_odp_actions(ds, nla_acts, len);
121 ds_put_format(ds, "))");
125 format_odp_action(struct ds *ds, const struct nlattr *a)
129 struct user_action_cookie cookie;
132 if (nl_attr_get_size(a) != odp_action_len(nl_attr_type(a)) &&
133 nl_attr_type(a) != OVS_ACTION_ATTR_SAMPLE) {
134 ds_put_format(ds, "bad length %zu, expected %d for: ",
135 nl_attr_get_size(a), odp_action_len(nl_attr_type(a)));
136 format_generic_odp_action(ds, a);
140 switch (nl_attr_type(a)) {
141 case OVS_ACTION_ATTR_OUTPUT:
142 ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
144 case OVS_ACTION_ATTR_USERSPACE:
145 data = nl_attr_get_u64(a);
146 memcpy(&cookie, &data, sizeof(cookie));
148 if (cookie.type == USER_ACTION_COOKIE_CONTROLLER) {
149 ds_put_format(ds, "userspace(controller,length=%"PRIu32")",
151 } else if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
152 ds_put_format(ds, "userspace(sFlow,n_output=%"PRIu8","
153 "vid=%"PRIu16",pcp=%"PRIu8",ifindex=%"PRIu32")",
154 cookie.n_output, vlan_tci_to_vid(cookie.vlan_tci),
155 vlan_tci_to_pcp(cookie.vlan_tci), cookie.data);
157 ds_put_format(ds, "userspace(unknown,data=0x%"PRIx64")",
161 case OVS_ACTION_ATTR_SET_TUNNEL:
162 ds_put_format(ds, "set_tunnel(%#"PRIx64")",
163 ntohll(nl_attr_get_be64(a)));
165 case OVS_ACTION_ATTR_PUSH_VLAN:
166 ds_put_format(ds, "push_vlan(vid=%"PRIu16",pcp=%d)",
167 vlan_tci_to_vid(nl_attr_get_be16(a)),
168 vlan_tci_to_pcp(nl_attr_get_be16(a)));
170 case OVS_ACTION_ATTR_POP_VLAN:
171 ds_put_format(ds, "pop_vlan");
173 case OVS_ACTION_ATTR_SET_DL_SRC:
174 eth = nl_attr_get_unspec(a, ETH_ADDR_LEN);
175 ds_put_format(ds, "set_dl_src("ETH_ADDR_FMT")", ETH_ADDR_ARGS(eth));
177 case OVS_ACTION_ATTR_SET_DL_DST:
178 eth = nl_attr_get_unspec(a, ETH_ADDR_LEN);
179 ds_put_format(ds, "set_dl_dst("ETH_ADDR_FMT")", ETH_ADDR_ARGS(eth));
181 case OVS_ACTION_ATTR_SET_NW_SRC:
182 ip = nl_attr_get_be32(a);
183 ds_put_format(ds, "set_nw_src("IP_FMT")", IP_ARGS(&ip));
185 case OVS_ACTION_ATTR_SET_NW_DST:
186 ip = nl_attr_get_be32(a);
187 ds_put_format(ds, "set_nw_dst("IP_FMT")", IP_ARGS(&ip));
189 case OVS_ACTION_ATTR_SET_NW_TOS:
190 ds_put_format(ds, "set_nw_tos(%"PRIu8")", nl_attr_get_u8(a));
192 case OVS_ACTION_ATTR_SET_TP_SRC:
193 ds_put_format(ds, "set_tp_src(%"PRIu16")", ntohs(nl_attr_get_be16(a)));
195 case OVS_ACTION_ATTR_SET_TP_DST:
196 ds_put_format(ds, "set_tp_dst(%"PRIu16")", ntohs(nl_attr_get_be16(a)));
198 case OVS_ACTION_ATTR_SET_PRIORITY:
199 ds_put_format(ds, "set_priority(%#"PRIx32")", nl_attr_get_u32(a));
201 case OVS_ACTION_ATTR_POP_PRIORITY:
202 ds_put_cstr(ds, "pop_priority");
204 case OVS_ACTION_ATTR_SAMPLE:
205 format_odp_sample_action(ds, a);
208 format_generic_odp_action(ds, a);
214 format_odp_actions(struct ds *ds, const struct nlattr *actions,
218 const struct nlattr *a;
221 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
223 ds_put_char(ds, ',');
225 format_odp_action(ds, a);
228 if (left == actions_len) {
229 ds_put_cstr(ds, "<empty>");
231 ds_put_format(ds, ",***%u leftover bytes***", left);
234 ds_put_cstr(ds, "drop");
238 /* Returns the correct length of the payload for a flow key attribute of the
239 * specified 'type', or -1 if 'type' is unknown. */
241 odp_flow_key_attr_len(uint16_t type)
243 if (type > OVS_KEY_ATTR_MAX) {
247 switch ((enum ovs_key_type) type) {
248 case OVS_KEY_ATTR_TUN_ID: return 8;
249 case OVS_KEY_ATTR_IN_PORT: return 4;
250 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
251 case OVS_KEY_ATTR_8021Q: return sizeof(struct ovs_key_8021q);
252 case OVS_KEY_ATTR_ETHERTYPE: return 2;
253 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
254 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
255 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
256 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
257 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
258 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
259 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
260 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
262 case OVS_KEY_ATTR_UNSPEC:
263 case __OVS_KEY_ATTR_MAX:
272 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
274 size_t len = nl_attr_get_size(a);
276 ds_put_format(ds, "key%"PRId16, nl_attr_type(a));
278 const uint8_t *unspec;
281 unspec = nl_attr_get(a);
282 for (i = 0; i < len; i++) {
283 ds_put_char(ds, i ? ' ': '(');
284 ds_put_format(ds, "%02x", unspec[i]);
286 ds_put_char(ds, ')');
291 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
293 const struct ovs_key_ethernet *eth_key;
294 const struct ovs_key_8021q *q_key;
295 const struct ovs_key_ipv4 *ipv4_key;
296 const struct ovs_key_ipv6 *ipv6_key;
297 const struct ovs_key_tcp *tcp_key;
298 const struct ovs_key_udp *udp_key;
299 const struct ovs_key_icmp *icmp_key;
300 const struct ovs_key_icmpv6 *icmpv6_key;
301 const struct ovs_key_arp *arp_key;
302 const struct ovs_key_nd *nd_key;
304 if (nl_attr_get_size(a) != odp_flow_key_attr_len(nl_attr_type(a))) {
305 ds_put_format(ds, "bad length %zu, expected %d for: ",
307 odp_flow_key_attr_len(nl_attr_type(a)));
308 format_generic_odp_key(a, ds);
312 switch (nl_attr_type(a)) {
313 case OVS_KEY_ATTR_TUN_ID:
314 ds_put_format(ds, "tun_id(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
317 case OVS_KEY_ATTR_IN_PORT:
318 ds_put_format(ds, "in_port(%"PRIu32")", nl_attr_get_u32(a));
321 case OVS_KEY_ATTR_ETHERNET:
322 eth_key = nl_attr_get(a);
323 ds_put_format(ds, "eth(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
324 ETH_ADDR_ARGS(eth_key->eth_src),
325 ETH_ADDR_ARGS(eth_key->eth_dst));
328 case OVS_KEY_ATTR_8021Q:
329 q_key = nl_attr_get(a);
330 ds_put_cstr(ds, "vlan(");
331 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
332 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(q_key->q_tpid));
334 ds_put_format(ds, "vid=%"PRIu16",pcp=%d)",
335 vlan_tci_to_vid(q_key->q_tci),
336 vlan_tci_to_pcp(q_key->q_tci));
339 case OVS_KEY_ATTR_ETHERTYPE:
340 ds_put_format(ds, "eth_type(0x%04"PRIx16")",
341 ntohs(nl_attr_get_be16(a)));
344 case OVS_KEY_ATTR_IPV4:
345 ipv4_key = nl_attr_get(a);
346 ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT","
347 "proto=%"PRId8",tos=%"PRIu8")",
348 IP_ARGS(&ipv4_key->ipv4_src),
349 IP_ARGS(&ipv4_key->ipv4_dst),
350 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos);
353 case OVS_KEY_ATTR_IPV6: {
354 char src_str[INET6_ADDRSTRLEN];
355 char dst_str[INET6_ADDRSTRLEN];
357 ipv6_key = nl_attr_get(a);
358 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
359 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
361 ds_put_format(ds, "ipv6(src=%s,dst=%s,proto=%"PRId8",tos=%"PRIu8")",
362 src_str, dst_str, ipv6_key->ipv6_proto,
367 case OVS_KEY_ATTR_TCP:
368 tcp_key = nl_attr_get(a);
369 ds_put_format(ds, "tcp(src=%"PRIu16",dst=%"PRIu16")",
370 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
373 case OVS_KEY_ATTR_UDP:
374 udp_key = nl_attr_get(a);
375 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16")",
376 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
379 case OVS_KEY_ATTR_ICMP:
380 icmp_key = nl_attr_get(a);
381 ds_put_format(ds, "icmp(type=%"PRIu8",code=%"PRIu8")",
382 icmp_key->icmp_type, icmp_key->icmp_code);
385 case OVS_KEY_ATTR_ICMPV6:
386 icmpv6_key = nl_attr_get(a);
387 ds_put_format(ds, "icmpv6(type=%"PRIu8",code=%"PRIu8")",
388 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
391 case OVS_KEY_ATTR_ARP:
392 arp_key = nl_attr_get(a);
393 ds_put_format(ds, "arp(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
394 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
395 IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
396 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
397 ETH_ADDR_ARGS(arp_key->arp_tha));
400 case OVS_KEY_ATTR_ND: {
401 char target[INET6_ADDRSTRLEN];
403 nd_key = nl_attr_get(a);
404 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
406 ds_put_format(ds, "nd(target=%s", target);
407 if (!eth_addr_is_zero(nd_key->nd_sll)) {
408 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
409 ETH_ADDR_ARGS(nd_key->nd_sll));
411 if (!eth_addr_is_zero(nd_key->nd_tll)) {
412 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
413 ETH_ADDR_ARGS(nd_key->nd_tll));
415 ds_put_char(ds, ')');
420 format_generic_odp_key(a, ds);
425 /* Appends to 'ds' a string representation of the 'key_len' bytes of
426 * OVS_KEY_ATTR_* attributes in 'key'. */
428 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
431 const struct nlattr *a;
434 NL_ATTR_FOR_EACH (a, left, key, key_len) {
436 ds_put_char(ds, ',');
438 format_odp_key_attr(a, ds);
441 if (left == key_len) {
442 ds_put_cstr(ds, "<empty>");
444 ds_put_format(ds, ",***%u leftover bytes***", left);
447 ds_put_cstr(ds, "<empty>");
452 put_nd_key(int n, const char *nd_target_s,
453 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
455 struct ovs_key_nd nd_key;
457 memset(&nd_key, 0, sizeof nd_key);
458 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
462 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
465 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
467 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
472 parse_odp_key_attr(const char *s, struct ofpbuf *key)
474 /* Many of the sscanf calls in this function use oversized destination
475 * fields because some sscanf() implementations truncate the range of %i
476 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
477 * value of 0x7fff. The other alternatives are to allow only a single
478 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
481 * The tun_id parser has to use an alternative approach because there is no
482 * type larger than 64 bits. */
488 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
489 tun_id_s, &n) > 0 && n > 0) {
490 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
491 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
497 unsigned long long int in_port;
500 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
501 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
507 struct ovs_key_ethernet eth_key;
511 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
512 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
513 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
514 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
515 ð_key, sizeof eth_key);
521 uint16_t tpid = ETH_TYPE_VLAN;
526 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n",
527 &vid, &pcp, &n) > 0 && n > 0) ||
528 (sscanf(s, "vlan(tpid=%"SCNi16",vid=%"SCNi16",pcp=%i)%n",
529 &tpid, &vid, &pcp, &n) > 0 && n > 0)) {
530 struct ovs_key_8021q q_key;
532 q_key.q_tpid = htons(tpid);
533 q_key.q_tci = htons((vid << VLAN_VID_SHIFT) |
534 (pcp << VLAN_PCP_SHIFT));
535 nl_msg_put_unspec(key, OVS_KEY_ATTR_8021Q, &q_key, sizeof q_key);
544 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
545 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
557 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
558 "proto=%i,tos=%i)%n",
559 IP_SCAN_ARGS(&ipv4_src),
560 IP_SCAN_ARGS(&ipv4_dst), &ipv4_proto, &ipv4_tos, &n) > 0
562 struct ovs_key_ipv4 ipv4_key;
564 memset(&ipv4_key, 0, sizeof ipv4_key);
565 ipv4_key.ipv4_src = ipv4_src;
566 ipv4_key.ipv4_dst = ipv4_dst;
567 ipv4_key.ipv4_proto = ipv4_proto;
568 ipv4_key.ipv4_tos = ipv4_tos;
569 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
570 &ipv4_key, sizeof ipv4_key);
576 char ipv6_src_s[IPV6_SCAN_LEN + 1];
577 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
582 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
583 "proto=%i,tos=%i)%n",
584 ipv6_src_s, ipv6_dst_s,
585 &ipv6_proto, &ipv6_tos, &n) > 0 && n > 0) {
586 struct ovs_key_ipv6 ipv6_key;
588 memset(&ipv6_key, 0, sizeof ipv6_key);
589 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
590 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
593 ipv6_key.ipv6_proto = ipv6_proto;
594 ipv6_key.ipv6_tos = ipv6_tos;
595 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
596 &ipv6_key, sizeof ipv6_key);
606 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
608 struct ovs_key_tcp tcp_key;
610 tcp_key.tcp_src = htons(tcp_src);
611 tcp_key.tcp_dst = htons(tcp_dst);
612 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
622 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
624 struct ovs_key_udp udp_key;
626 udp_key.udp_src = htons(udp_src);
627 udp_key.udp_dst = htons(udp_dst);
628 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
638 if (sscanf(s, "icmp(type=%i,code=%i)%n",
639 &icmp_type, &icmp_code, &n) > 0
641 struct ovs_key_icmp icmp_key;
643 icmp_key.icmp_type = icmp_type;
644 icmp_key.icmp_code = icmp_code;
645 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
646 &icmp_key, sizeof icmp_key);
652 struct ovs_key_icmpv6 icmpv6_key;
655 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
656 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
658 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
659 &icmpv6_key, sizeof icmpv6_key);
668 uint8_t arp_sha[ETH_ADDR_LEN];
669 uint8_t arp_tha[ETH_ADDR_LEN];
672 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
673 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
674 IP_SCAN_ARGS(&arp_sip),
675 IP_SCAN_ARGS(&arp_tip),
677 ETH_ADDR_SCAN_ARGS(arp_sha),
678 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
679 struct ovs_key_arp arp_key;
681 memset(&arp_key, 0, sizeof arp_key);
682 arp_key.arp_sip = arp_sip;
683 arp_key.arp_tip = arp_tip;
684 arp_key.arp_op = htons(arp_op);
685 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
686 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
687 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
693 char nd_target_s[IPV6_SCAN_LEN + 1];
694 uint8_t nd_sll[ETH_ADDR_LEN];
695 uint8_t nd_tll[ETH_ADDR_LEN];
698 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
699 nd_target_s, &n) > 0 && n > 0) {
700 return put_nd_key(n, nd_target_s, NULL, NULL, key);
702 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
703 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
705 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
707 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
708 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
710 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
712 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
713 "tll="ETH_ADDR_SCAN_FMT")%n",
714 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
715 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
717 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
724 /* Parses the string representation of a datapath flow key, in the
725 * format output by odp_flow_key_format(). Returns 0 if successful,
726 * otherwise a positive errno value. On success, the flow key is
727 * appended to 'key' as a series of Netlink attributes. On failure, no
728 * data is appended to 'key'. Either way, 'key''s data might be
731 * On success, the attributes appended to 'key' are individually syntactically
732 * valid, but they may not be valid as a sequence. 'key' might, for example,
733 * be missing an "in_port" key, have duplicated keys, or have keys in the wrong
734 * order. odp_flow_key_to_flow() will detect those errors. */
736 odp_flow_key_from_string(const char *s, struct ofpbuf *key)
738 const size_t old_size = key->size;
742 s += strspn(s, ", \t\r\n");
747 retval = parse_odp_key_attr(s, key);
749 key->size = old_size;
758 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
760 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
762 struct ovs_key_ethernet *eth_key;
764 if (flow->tun_id != htonll(0)) {
765 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
768 if (flow->in_port != OFPP_NONE) {
769 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
770 ofp_port_to_odp_port(flow->in_port));
773 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
775 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
776 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
778 if (flow->vlan_tci != htons(0)) {
779 struct ovs_key_8021q *q_key;
781 q_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_8021Q,
783 q_key->q_tpid = htons(ETH_TYPE_VLAN);
784 q_key->q_tci = flow->vlan_tci & ~htons(VLAN_CFI);
787 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
791 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
793 if (flow->dl_type == htons(ETH_TYPE_IP)) {
794 struct ovs_key_ipv4 *ipv4_key;
796 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
798 memset(ipv4_key, 0, sizeof *ipv4_key);
799 ipv4_key->ipv4_src = flow->nw_src;
800 ipv4_key->ipv4_dst = flow->nw_dst;
801 ipv4_key->ipv4_proto = flow->nw_proto;
802 ipv4_key->ipv4_tos = flow->nw_tos;
803 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
804 struct ovs_key_ipv6 *ipv6_key;
806 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
808 memset(ipv6_key, 0, sizeof *ipv6_key);
809 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
810 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
811 ipv6_key->ipv6_proto = flow->nw_proto;
812 ipv6_key->ipv6_tos = flow->nw_tos;
813 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
814 struct ovs_key_arp *arp_key;
816 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
818 memset(arp_key, 0, sizeof *arp_key);
819 arp_key->arp_sip = flow->nw_src;
820 arp_key->arp_tip = flow->nw_dst;
821 arp_key->arp_op = htons(flow->nw_proto);
822 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
823 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
826 if (flow->dl_type == htons(ETH_TYPE_IP)
827 || flow->dl_type == htons(ETH_TYPE_IPV6)) {
829 if (flow->nw_proto == IPPROTO_TCP) {
830 struct ovs_key_tcp *tcp_key;
832 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
834 tcp_key->tcp_src = flow->tp_src;
835 tcp_key->tcp_dst = flow->tp_dst;
836 } else if (flow->nw_proto == IPPROTO_UDP) {
837 struct ovs_key_udp *udp_key;
839 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
841 udp_key->udp_src = flow->tp_src;
842 udp_key->udp_dst = flow->tp_dst;
843 } else if (flow->dl_type == htons(ETH_TYPE_IP)
844 && flow->nw_proto == IPPROTO_ICMP) {
845 struct ovs_key_icmp *icmp_key;
847 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
849 icmp_key->icmp_type = ntohs(flow->tp_src);
850 icmp_key->icmp_code = ntohs(flow->tp_dst);
851 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
852 && flow->nw_proto == IPPROTO_ICMPV6) {
853 struct ovs_key_icmpv6 *icmpv6_key;
855 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
857 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
858 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
860 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
861 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
862 struct ovs_key_nd *nd_key;
864 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
866 memcpy(nd_key->nd_target, &flow->nd_target,
867 sizeof nd_key->nd_target);
868 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
869 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
875 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
876 * structure in 'flow'. Returns 0 if successful, otherwise EINVAL. */
878 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
881 const struct nlattr *nla;
882 enum ovs_key_type prev_type;
885 memset(flow, 0, sizeof *flow);
886 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
887 flow->in_port = OFPP_NONE;
889 prev_type = OVS_KEY_ATTR_UNSPEC;
890 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
891 const struct ovs_key_ethernet *eth_key;
892 const struct ovs_key_8021q *q_key;
893 const struct ovs_key_ipv4 *ipv4_key;
894 const struct ovs_key_ipv6 *ipv6_key;
895 const struct ovs_key_tcp *tcp_key;
896 const struct ovs_key_udp *udp_key;
897 const struct ovs_key_icmp *icmp_key;
898 const struct ovs_key_icmpv6 *icmpv6_key;
899 const struct ovs_key_arp *arp_key;
900 const struct ovs_key_nd *nd_key;
902 uint16_t type = nl_attr_type(nla);
903 int len = odp_flow_key_attr_len(type);
905 if (nl_attr_get_size(nla) != len && len != -1) {
909 #define TRANSITION(PREV_TYPE, TYPE) (((PREV_TYPE) << 16) | (TYPE))
910 switch (TRANSITION(prev_type, type)) {
911 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_TUN_ID):
912 flow->tun_id = nl_attr_get_be64(nla);
915 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_IN_PORT):
916 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_IN_PORT):
917 if (nl_attr_get_u32(nla) >= UINT16_MAX) {
920 flow->in_port = odp_port_to_ofp_port(nl_attr_get_u32(nla));
923 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_ETHERNET):
924 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_ETHERNET):
925 case TRANSITION(OVS_KEY_ATTR_IN_PORT, OVS_KEY_ATTR_ETHERNET):
926 eth_key = nl_attr_get(nla);
927 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
928 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
931 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_8021Q):
932 q_key = nl_attr_get(nla);
933 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
934 /* Only standard 0x8100 VLANs currently supported. */
937 if (q_key->q_tci & htons(VLAN_CFI)) {
940 flow->vlan_tci = q_key->q_tci | htons(VLAN_CFI);
943 case TRANSITION(OVS_KEY_ATTR_8021Q, OVS_KEY_ATTR_ETHERTYPE):
944 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_ETHERTYPE):
945 flow->dl_type = nl_attr_get_be16(nla);
946 if (ntohs(flow->dl_type) < 1536) {
951 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV4):
952 if (flow->dl_type != htons(ETH_TYPE_IP)) {
955 ipv4_key = nl_attr_get(nla);
956 flow->nw_src = ipv4_key->ipv4_src;
957 flow->nw_dst = ipv4_key->ipv4_dst;
958 flow->nw_proto = ipv4_key->ipv4_proto;
959 flow->nw_tos = ipv4_key->ipv4_tos;
960 if (flow->nw_tos & IP_ECN_MASK) {
965 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV6):
966 if (flow->dl_type != htons(ETH_TYPE_IPV6)) {
969 ipv6_key = nl_attr_get(nla);
970 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
971 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
972 flow->nw_proto = ipv6_key->ipv6_proto;
973 flow->nw_tos = ipv6_key->ipv6_tos;
974 if (flow->nw_tos & IP_ECN_MASK) {
979 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_TCP):
980 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_TCP):
981 if (flow->nw_proto != IPPROTO_TCP) {
984 tcp_key = nl_attr_get(nla);
985 flow->tp_src = tcp_key->tcp_src;
986 flow->tp_dst = tcp_key->tcp_dst;
989 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_UDP):
990 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_UDP):
991 if (flow->nw_proto != IPPROTO_UDP) {
994 udp_key = nl_attr_get(nla);
995 flow->tp_src = udp_key->udp_src;
996 flow->tp_dst = udp_key->udp_dst;
999 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_ICMP):
1000 if (flow->nw_proto != IPPROTO_ICMP) {
1003 icmp_key = nl_attr_get(nla);
1004 flow->tp_src = htons(icmp_key->icmp_type);
1005 flow->tp_dst = htons(icmp_key->icmp_code);
1008 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_ICMPV6):
1009 if (flow->nw_proto != IPPROTO_ICMPV6) {
1012 icmpv6_key = nl_attr_get(nla);
1013 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1014 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1017 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_ARP):
1018 if (flow->dl_type != htons(ETH_TYPE_ARP)) {
1021 arp_key = nl_attr_get(nla);
1022 flow->nw_src = arp_key->arp_sip;
1023 flow->nw_dst = arp_key->arp_tip;
1024 if (arp_key->arp_op & htons(0xff00)) {
1027 flow->nw_proto = ntohs(arp_key->arp_op);
1028 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1029 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1032 case TRANSITION(OVS_KEY_ATTR_ICMPV6, OVS_KEY_ATTR_ND):
1033 if (flow->tp_src != htons(ND_NEIGHBOR_SOLICIT)
1034 && flow->tp_src != htons(ND_NEIGHBOR_ADVERT)) {
1037 nd_key = nl_attr_get(nla);
1038 memcpy(&flow->nd_target, nd_key->nd_target, sizeof flow->nd_target);
1039 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1040 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1053 switch (prev_type) {
1054 case OVS_KEY_ATTR_UNSPEC:
1057 case OVS_KEY_ATTR_TUN_ID:
1058 case OVS_KEY_ATTR_IN_PORT:
1061 case OVS_KEY_ATTR_ETHERNET:
1062 case OVS_KEY_ATTR_8021Q:
1065 case OVS_KEY_ATTR_ETHERTYPE:
1066 if (flow->dl_type == htons(ETH_TYPE_IP)
1067 || flow->dl_type == htons(ETH_TYPE_IPV6)
1068 || flow->dl_type == htons(ETH_TYPE_ARP)) {
1073 case OVS_KEY_ATTR_IPV4:
1074 if (flow->nw_proto == IPPROTO_TCP
1075 || flow->nw_proto == IPPROTO_UDP
1076 || flow->nw_proto == IPPROTO_ICMP) {
1081 case OVS_KEY_ATTR_IPV6:
1082 if (flow->nw_proto == IPPROTO_TCP
1083 || flow->nw_proto == IPPROTO_UDP
1084 || flow->nw_proto == IPPROTO_ICMPV6) {
1089 case OVS_KEY_ATTR_ICMPV6:
1090 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
1091 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
1096 case OVS_KEY_ATTR_TCP:
1097 case OVS_KEY_ATTR_UDP:
1098 case OVS_KEY_ATTR_ICMP:
1099 case OVS_KEY_ATTR_ARP:
1100 case OVS_KEY_ATTR_ND:
1103 case __OVS_KEY_ATTR_MAX: