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)];
103 const struct nlattr *nla_acts;
106 ds_put_cstr(ds, "sample");
108 ofpbuf_use_const(&buf, nl_attr_get(attr), nl_attr_get_size(attr));
109 if (!nl_policy_parse(&buf, 0, ovs_sample_policy, a,
110 ARRAY_SIZE(ovs_sample_policy))) {
111 ds_put_cstr(ds, "(error)");
115 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
118 ds_put_format(ds, "(sample=%.1f%%,", percentage);
120 ds_put_cstr(ds, "actions(");
121 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
122 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
123 format_odp_actions(ds, nla_acts, len);
124 ds_put_format(ds, "))");
128 format_odp_action(struct ds *ds, const struct nlattr *a)
132 struct user_action_cookie cookie;
135 if (nl_attr_get_size(a) != odp_action_len(nl_attr_type(a)) &&
136 nl_attr_type(a) != OVS_ACTION_ATTR_SAMPLE) {
137 ds_put_format(ds, "bad length %zu, expected %d for: ",
138 nl_attr_get_size(a), odp_action_len(nl_attr_type(a)));
139 format_generic_odp_action(ds, a);
143 switch (nl_attr_type(a)) {
144 case OVS_ACTION_ATTR_OUTPUT:
145 ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
147 case OVS_ACTION_ATTR_USERSPACE:
148 data = nl_attr_get_u64(a);
149 memcpy(&cookie, &data, sizeof(cookie));
151 if (cookie.type == USER_ACTION_COOKIE_CONTROLLER) {
152 ds_put_format(ds, "userspace(controller,length=%"PRIu32")",
154 } else if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
155 ds_put_format(ds, "userspace(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, "userspace(unknown,data=0x%"PRIx64")",
164 case OVS_ACTION_ATTR_SET_TUNNEL:
165 ds_put_format(ds, "set_tunnel(%#"PRIx64")",
166 ntohll(nl_attr_get_be64(a)));
168 case OVS_ACTION_ATTR_PUSH_VLAN:
169 ds_put_format(ds, "push_vlan(vid=%"PRIu16",pcp=%d)",
170 vlan_tci_to_vid(nl_attr_get_be16(a)),
171 vlan_tci_to_pcp(nl_attr_get_be16(a)));
173 case OVS_ACTION_ATTR_POP_VLAN:
174 ds_put_format(ds, "pop_vlan");
176 case OVS_ACTION_ATTR_SET_DL_SRC:
177 eth = nl_attr_get_unspec(a, ETH_ADDR_LEN);
178 ds_put_format(ds, "set_dl_src("ETH_ADDR_FMT")", ETH_ADDR_ARGS(eth));
180 case OVS_ACTION_ATTR_SET_DL_DST:
181 eth = nl_attr_get_unspec(a, ETH_ADDR_LEN);
182 ds_put_format(ds, "set_dl_dst("ETH_ADDR_FMT")", ETH_ADDR_ARGS(eth));
184 case OVS_ACTION_ATTR_SET_NW_SRC:
185 ip = nl_attr_get_be32(a);
186 ds_put_format(ds, "set_nw_src("IP_FMT")", IP_ARGS(&ip));
188 case OVS_ACTION_ATTR_SET_NW_DST:
189 ip = nl_attr_get_be32(a);
190 ds_put_format(ds, "set_nw_dst("IP_FMT")", IP_ARGS(&ip));
192 case OVS_ACTION_ATTR_SET_NW_TOS:
193 ds_put_format(ds, "set_nw_tos(%"PRIu8")", nl_attr_get_u8(a));
195 case OVS_ACTION_ATTR_SET_TP_SRC:
196 ds_put_format(ds, "set_tp_src(%"PRIu16")", ntohs(nl_attr_get_be16(a)));
198 case OVS_ACTION_ATTR_SET_TP_DST:
199 ds_put_format(ds, "set_tp_dst(%"PRIu16")", ntohs(nl_attr_get_be16(a)));
201 case OVS_ACTION_ATTR_SET_PRIORITY:
202 ds_put_format(ds, "set_priority(%#"PRIx32")", nl_attr_get_u32(a));
204 case OVS_ACTION_ATTR_POP_PRIORITY:
205 ds_put_cstr(ds, "pop_priority");
207 case OVS_ACTION_ATTR_SAMPLE:
208 format_odp_sample_action(ds, a);
211 format_generic_odp_action(ds, a);
217 format_odp_actions(struct ds *ds, const struct nlattr *actions,
221 const struct nlattr *a;
224 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
226 ds_put_char(ds, ',');
228 format_odp_action(ds, a);
231 if (left == actions_len) {
232 ds_put_cstr(ds, "<empty>");
234 ds_put_format(ds, ",***%u leftover bytes***", left);
237 ds_put_cstr(ds, "drop");
241 /* Returns the correct length of the payload for a flow key attribute of the
242 * specified 'type', or -1 if 'type' is unknown. */
244 odp_flow_key_attr_len(uint16_t type)
246 if (type > OVS_KEY_ATTR_MAX) {
250 switch ((enum ovs_key_type) type) {
251 case OVS_KEY_ATTR_TUN_ID: return 8;
252 case OVS_KEY_ATTR_IN_PORT: return 4;
253 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
254 case OVS_KEY_ATTR_8021Q: return sizeof(struct ovs_key_8021q);
255 case OVS_KEY_ATTR_ETHERTYPE: return 2;
256 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
257 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
258 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
259 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
260 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
261 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
262 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
263 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
265 case OVS_KEY_ATTR_UNSPEC:
266 case __OVS_KEY_ATTR_MAX:
275 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
277 size_t len = nl_attr_get_size(a);
279 ds_put_format(ds, "key%"PRId16, nl_attr_type(a));
281 const uint8_t *unspec;
284 unspec = nl_attr_get(a);
285 for (i = 0; i < len; i++) {
286 ds_put_char(ds, i ? ' ': '(');
287 ds_put_format(ds, "%02x", unspec[i]);
289 ds_put_char(ds, ')');
294 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
296 const struct ovs_key_ethernet *eth_key;
297 const struct ovs_key_8021q *q_key;
298 const struct ovs_key_ipv4 *ipv4_key;
299 const struct ovs_key_ipv6 *ipv6_key;
300 const struct ovs_key_tcp *tcp_key;
301 const struct ovs_key_udp *udp_key;
302 const struct ovs_key_icmp *icmp_key;
303 const struct ovs_key_icmpv6 *icmpv6_key;
304 const struct ovs_key_arp *arp_key;
305 const struct ovs_key_nd *nd_key;
307 if (nl_attr_get_size(a) != odp_flow_key_attr_len(nl_attr_type(a))) {
308 ds_put_format(ds, "bad length %zu, expected %d for: ",
310 odp_flow_key_attr_len(nl_attr_type(a)));
311 format_generic_odp_key(a, ds);
315 switch (nl_attr_type(a)) {
316 case OVS_KEY_ATTR_TUN_ID:
317 ds_put_format(ds, "tun_id(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
320 case OVS_KEY_ATTR_IN_PORT:
321 ds_put_format(ds, "in_port(%"PRIu32")", nl_attr_get_u32(a));
324 case OVS_KEY_ATTR_ETHERNET:
325 eth_key = nl_attr_get(a);
326 ds_put_format(ds, "eth(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
327 ETH_ADDR_ARGS(eth_key->eth_src),
328 ETH_ADDR_ARGS(eth_key->eth_dst));
331 case OVS_KEY_ATTR_8021Q:
332 q_key = nl_attr_get(a);
333 ds_put_cstr(ds, "vlan(");
334 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
335 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(q_key->q_tpid));
337 ds_put_format(ds, "vid=%"PRIu16",pcp=%d)",
338 vlan_tci_to_vid(q_key->q_tci),
339 vlan_tci_to_pcp(q_key->q_tci));
342 case OVS_KEY_ATTR_ETHERTYPE:
343 ds_put_format(ds, "eth_type(0x%04"PRIx16")",
344 ntohs(nl_attr_get_be16(a)));
347 case OVS_KEY_ATTR_IPV4:
348 ipv4_key = nl_attr_get(a);
349 ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT","
350 "proto=%"PRId8",tos=%"PRIu8")",
351 IP_ARGS(&ipv4_key->ipv4_src),
352 IP_ARGS(&ipv4_key->ipv4_dst),
353 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos);
356 case OVS_KEY_ATTR_IPV6: {
357 char src_str[INET6_ADDRSTRLEN];
358 char dst_str[INET6_ADDRSTRLEN];
360 ipv6_key = nl_attr_get(a);
361 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
362 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
364 ds_put_format(ds, "ipv6(src=%s,dst=%s,proto=%"PRId8",tos=%"PRIu8")",
365 src_str, dst_str, ipv6_key->ipv6_proto,
370 case OVS_KEY_ATTR_TCP:
371 tcp_key = nl_attr_get(a);
372 ds_put_format(ds, "tcp(src=%"PRIu16",dst=%"PRIu16")",
373 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
376 case OVS_KEY_ATTR_UDP:
377 udp_key = nl_attr_get(a);
378 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16")",
379 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
382 case OVS_KEY_ATTR_ICMP:
383 icmp_key = nl_attr_get(a);
384 ds_put_format(ds, "icmp(type=%"PRIu8",code=%"PRIu8")",
385 icmp_key->icmp_type, icmp_key->icmp_code);
388 case OVS_KEY_ATTR_ICMPV6:
389 icmpv6_key = nl_attr_get(a);
390 ds_put_format(ds, "icmpv6(type=%"PRIu8",code=%"PRIu8")",
391 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
394 case OVS_KEY_ATTR_ARP:
395 arp_key = nl_attr_get(a);
396 ds_put_format(ds, "arp(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
397 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
398 IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
399 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
400 ETH_ADDR_ARGS(arp_key->arp_tha));
403 case OVS_KEY_ATTR_ND: {
404 char target[INET6_ADDRSTRLEN];
406 nd_key = nl_attr_get(a);
407 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
409 ds_put_format(ds, "nd(target=%s", target);
410 if (!eth_addr_is_zero(nd_key->nd_sll)) {
411 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
412 ETH_ADDR_ARGS(nd_key->nd_sll));
414 if (!eth_addr_is_zero(nd_key->nd_tll)) {
415 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
416 ETH_ADDR_ARGS(nd_key->nd_tll));
418 ds_put_char(ds, ')');
423 format_generic_odp_key(a, ds);
428 /* Appends to 'ds' a string representation of the 'key_len' bytes of
429 * OVS_KEY_ATTR_* attributes in 'key'. */
431 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
434 const struct nlattr *a;
437 NL_ATTR_FOR_EACH (a, left, key, key_len) {
439 ds_put_char(ds, ',');
441 format_odp_key_attr(a, ds);
444 if (left == key_len) {
445 ds_put_cstr(ds, "<empty>");
447 ds_put_format(ds, ",***%u leftover bytes***", left);
450 ds_put_cstr(ds, "<empty>");
455 put_nd_key(int n, const char *nd_target_s,
456 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
458 struct ovs_key_nd nd_key;
460 memset(&nd_key, 0, sizeof nd_key);
461 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
465 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
468 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
470 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
475 parse_odp_key_attr(const char *s, struct ofpbuf *key)
477 /* Many of the sscanf calls in this function use oversized destination
478 * fields because some sscanf() implementations truncate the range of %i
479 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
480 * value of 0x7fff. The other alternatives are to allow only a single
481 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
484 * The tun_id parser has to use an alternative approach because there is no
485 * type larger than 64 bits. */
491 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
492 tun_id_s, &n) > 0 && n > 0) {
493 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
494 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
500 unsigned long long int in_port;
503 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
504 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
510 struct ovs_key_ethernet eth_key;
514 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
515 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
516 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
517 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
518 ð_key, sizeof eth_key);
524 uint16_t tpid = ETH_TYPE_VLAN;
529 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n",
530 &vid, &pcp, &n) > 0 && n > 0) ||
531 (sscanf(s, "vlan(tpid=%"SCNi16",vid=%"SCNi16",pcp=%i)%n",
532 &tpid, &vid, &pcp, &n) > 0 && n > 0)) {
533 struct ovs_key_8021q q_key;
535 q_key.q_tpid = htons(tpid);
536 q_key.q_tci = htons((vid << VLAN_VID_SHIFT) |
537 (pcp << VLAN_PCP_SHIFT));
538 nl_msg_put_unspec(key, OVS_KEY_ATTR_8021Q, &q_key, sizeof q_key);
547 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
548 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
560 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
561 "proto=%i,tos=%i)%n",
562 IP_SCAN_ARGS(&ipv4_src),
563 IP_SCAN_ARGS(&ipv4_dst), &ipv4_proto, &ipv4_tos, &n) > 0
565 struct ovs_key_ipv4 ipv4_key;
567 memset(&ipv4_key, 0, sizeof ipv4_key);
568 ipv4_key.ipv4_src = ipv4_src;
569 ipv4_key.ipv4_dst = ipv4_dst;
570 ipv4_key.ipv4_proto = ipv4_proto;
571 ipv4_key.ipv4_tos = ipv4_tos;
572 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
573 &ipv4_key, sizeof ipv4_key);
579 char ipv6_src_s[IPV6_SCAN_LEN + 1];
580 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
585 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
586 "proto=%i,tos=%i)%n",
587 ipv6_src_s, ipv6_dst_s,
588 &ipv6_proto, &ipv6_tos, &n) > 0 && n > 0) {
589 struct ovs_key_ipv6 ipv6_key;
591 memset(&ipv6_key, 0, sizeof ipv6_key);
592 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
593 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
596 ipv6_key.ipv6_proto = ipv6_proto;
597 ipv6_key.ipv6_tos = ipv6_tos;
598 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
599 &ipv6_key, sizeof ipv6_key);
609 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
611 struct ovs_key_tcp tcp_key;
613 tcp_key.tcp_src = htons(tcp_src);
614 tcp_key.tcp_dst = htons(tcp_dst);
615 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
625 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
627 struct ovs_key_udp udp_key;
629 udp_key.udp_src = htons(udp_src);
630 udp_key.udp_dst = htons(udp_dst);
631 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
641 if (sscanf(s, "icmp(type=%i,code=%i)%n",
642 &icmp_type, &icmp_code, &n) > 0
644 struct ovs_key_icmp icmp_key;
646 icmp_key.icmp_type = icmp_type;
647 icmp_key.icmp_code = icmp_code;
648 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
649 &icmp_key, sizeof icmp_key);
655 struct ovs_key_icmpv6 icmpv6_key;
658 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
659 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
661 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
662 &icmpv6_key, sizeof icmpv6_key);
671 uint8_t arp_sha[ETH_ADDR_LEN];
672 uint8_t arp_tha[ETH_ADDR_LEN];
675 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
676 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
677 IP_SCAN_ARGS(&arp_sip),
678 IP_SCAN_ARGS(&arp_tip),
680 ETH_ADDR_SCAN_ARGS(arp_sha),
681 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
682 struct ovs_key_arp arp_key;
684 memset(&arp_key, 0, sizeof arp_key);
685 arp_key.arp_sip = arp_sip;
686 arp_key.arp_tip = arp_tip;
687 arp_key.arp_op = htons(arp_op);
688 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
689 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
690 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
696 char nd_target_s[IPV6_SCAN_LEN + 1];
697 uint8_t nd_sll[ETH_ADDR_LEN];
698 uint8_t nd_tll[ETH_ADDR_LEN];
701 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
702 nd_target_s, &n) > 0 && n > 0) {
703 return put_nd_key(n, nd_target_s, NULL, NULL, key);
705 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
706 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
708 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
710 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
711 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
713 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
715 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
716 "tll="ETH_ADDR_SCAN_FMT")%n",
717 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
718 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
720 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
727 /* Parses the string representation of a datapath flow key, in the
728 * format output by odp_flow_key_format(). Returns 0 if successful,
729 * otherwise a positive errno value. On success, the flow key is
730 * appended to 'key' as a series of Netlink attributes. On failure, no
731 * data is appended to 'key'. Either way, 'key''s data might be
734 * On success, the attributes appended to 'key' are individually syntactically
735 * valid, but they may not be valid as a sequence. 'key' might, for example,
736 * be missing an "in_port" key, have duplicated keys, or have keys in the wrong
737 * order. odp_flow_key_to_flow() will detect those errors. */
739 odp_flow_key_from_string(const char *s, struct ofpbuf *key)
741 const size_t old_size = key->size;
745 s += strspn(s, ", \t\r\n");
750 retval = parse_odp_key_attr(s, key);
752 key->size = old_size;
761 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
763 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
765 struct ovs_key_ethernet *eth_key;
767 if (flow->tun_id != htonll(0)) {
768 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
771 if (flow->in_port != OFPP_NONE) {
772 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
773 ofp_port_to_odp_port(flow->in_port));
776 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
778 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
779 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
781 if (flow->vlan_tci != htons(0)) {
782 struct ovs_key_8021q *q_key;
784 q_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_8021Q,
786 q_key->q_tpid = htons(ETH_TYPE_VLAN);
787 q_key->q_tci = flow->vlan_tci & ~htons(VLAN_CFI);
790 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
794 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
796 if (flow->dl_type == htons(ETH_TYPE_IP)) {
797 struct ovs_key_ipv4 *ipv4_key;
799 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
801 memset(ipv4_key, 0, sizeof *ipv4_key);
802 ipv4_key->ipv4_src = flow->nw_src;
803 ipv4_key->ipv4_dst = flow->nw_dst;
804 ipv4_key->ipv4_proto = flow->nw_proto;
805 ipv4_key->ipv4_tos = flow->nw_tos;
806 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
807 struct ovs_key_ipv6 *ipv6_key;
809 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
811 memset(ipv6_key, 0, sizeof *ipv6_key);
812 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
813 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
814 ipv6_key->ipv6_proto = flow->nw_proto;
815 ipv6_key->ipv6_tos = flow->nw_tos;
816 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
817 struct ovs_key_arp *arp_key;
819 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
821 memset(arp_key, 0, sizeof *arp_key);
822 arp_key->arp_sip = flow->nw_src;
823 arp_key->arp_tip = flow->nw_dst;
824 arp_key->arp_op = htons(flow->nw_proto);
825 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
826 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
829 if (flow->dl_type == htons(ETH_TYPE_IP)
830 || flow->dl_type == htons(ETH_TYPE_IPV6)) {
832 if (flow->nw_proto == IPPROTO_TCP) {
833 struct ovs_key_tcp *tcp_key;
835 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
837 tcp_key->tcp_src = flow->tp_src;
838 tcp_key->tcp_dst = flow->tp_dst;
839 } else if (flow->nw_proto == IPPROTO_UDP) {
840 struct ovs_key_udp *udp_key;
842 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
844 udp_key->udp_src = flow->tp_src;
845 udp_key->udp_dst = flow->tp_dst;
846 } else if (flow->dl_type == htons(ETH_TYPE_IP)
847 && flow->nw_proto == IPPROTO_ICMP) {
848 struct ovs_key_icmp *icmp_key;
850 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
852 icmp_key->icmp_type = ntohs(flow->tp_src);
853 icmp_key->icmp_code = ntohs(flow->tp_dst);
854 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
855 && flow->nw_proto == IPPROTO_ICMPV6) {
856 struct ovs_key_icmpv6 *icmpv6_key;
858 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
860 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
861 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
863 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
864 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
865 struct ovs_key_nd *nd_key;
867 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
869 memcpy(nd_key->nd_target, &flow->nd_target,
870 sizeof nd_key->nd_target);
871 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
872 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
878 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
879 * structure in 'flow'. Returns 0 if successful, otherwise EINVAL. */
881 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
884 const struct nlattr *nla;
885 enum ovs_key_type prev_type;
888 memset(flow, 0, sizeof *flow);
889 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
890 flow->in_port = OFPP_NONE;
892 prev_type = OVS_KEY_ATTR_UNSPEC;
893 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
894 const struct ovs_key_ethernet *eth_key;
895 const struct ovs_key_8021q *q_key;
896 const struct ovs_key_ipv4 *ipv4_key;
897 const struct ovs_key_ipv6 *ipv6_key;
898 const struct ovs_key_tcp *tcp_key;
899 const struct ovs_key_udp *udp_key;
900 const struct ovs_key_icmp *icmp_key;
901 const struct ovs_key_icmpv6 *icmpv6_key;
902 const struct ovs_key_arp *arp_key;
903 const struct ovs_key_nd *nd_key;
905 uint16_t type = nl_attr_type(nla);
906 int len = odp_flow_key_attr_len(type);
908 if (nl_attr_get_size(nla) != len && len != -1) {
912 #define TRANSITION(PREV_TYPE, TYPE) (((PREV_TYPE) << 16) | (TYPE))
913 switch (TRANSITION(prev_type, type)) {
914 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_TUN_ID):
915 flow->tun_id = nl_attr_get_be64(nla);
918 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_IN_PORT):
919 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_IN_PORT):
920 if (nl_attr_get_u32(nla) >= UINT16_MAX) {
923 flow->in_port = odp_port_to_ofp_port(nl_attr_get_u32(nla));
926 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_ETHERNET):
927 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_ETHERNET):
928 case TRANSITION(OVS_KEY_ATTR_IN_PORT, OVS_KEY_ATTR_ETHERNET):
929 eth_key = nl_attr_get(nla);
930 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
931 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
934 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_8021Q):
935 q_key = nl_attr_get(nla);
936 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
937 /* Only standard 0x8100 VLANs currently supported. */
940 if (q_key->q_tci & htons(VLAN_CFI)) {
943 flow->vlan_tci = q_key->q_tci | htons(VLAN_CFI);
946 case TRANSITION(OVS_KEY_ATTR_8021Q, OVS_KEY_ATTR_ETHERTYPE):
947 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_ETHERTYPE):
948 flow->dl_type = nl_attr_get_be16(nla);
949 if (ntohs(flow->dl_type) < 1536) {
954 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV4):
955 if (flow->dl_type != htons(ETH_TYPE_IP)) {
958 ipv4_key = nl_attr_get(nla);
959 flow->nw_src = ipv4_key->ipv4_src;
960 flow->nw_dst = ipv4_key->ipv4_dst;
961 flow->nw_proto = ipv4_key->ipv4_proto;
962 flow->nw_tos = ipv4_key->ipv4_tos;
963 if (flow->nw_tos & IP_ECN_MASK) {
968 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV6):
969 if (flow->dl_type != htons(ETH_TYPE_IPV6)) {
972 ipv6_key = nl_attr_get(nla);
973 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
974 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
975 flow->nw_proto = ipv6_key->ipv6_proto;
976 flow->nw_tos = ipv6_key->ipv6_tos;
977 if (flow->nw_tos & IP_ECN_MASK) {
982 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_TCP):
983 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_TCP):
984 if (flow->nw_proto != IPPROTO_TCP) {
987 tcp_key = nl_attr_get(nla);
988 flow->tp_src = tcp_key->tcp_src;
989 flow->tp_dst = tcp_key->tcp_dst;
992 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_UDP):
993 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_UDP):
994 if (flow->nw_proto != IPPROTO_UDP) {
997 udp_key = nl_attr_get(nla);
998 flow->tp_src = udp_key->udp_src;
999 flow->tp_dst = udp_key->udp_dst;
1002 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_ICMP):
1003 if (flow->nw_proto != IPPROTO_ICMP) {
1006 icmp_key = nl_attr_get(nla);
1007 flow->tp_src = htons(icmp_key->icmp_type);
1008 flow->tp_dst = htons(icmp_key->icmp_code);
1011 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_ICMPV6):
1012 if (flow->nw_proto != IPPROTO_ICMPV6) {
1015 icmpv6_key = nl_attr_get(nla);
1016 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1017 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1020 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_ARP):
1021 if (flow->dl_type != htons(ETH_TYPE_ARP)) {
1024 arp_key = nl_attr_get(nla);
1025 flow->nw_src = arp_key->arp_sip;
1026 flow->nw_dst = arp_key->arp_tip;
1027 if (arp_key->arp_op & htons(0xff00)) {
1030 flow->nw_proto = ntohs(arp_key->arp_op);
1031 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1032 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1035 case TRANSITION(OVS_KEY_ATTR_ICMPV6, OVS_KEY_ATTR_ND):
1036 if (flow->tp_src != htons(ND_NEIGHBOR_SOLICIT)
1037 && flow->tp_src != htons(ND_NEIGHBOR_ADVERT)) {
1040 nd_key = nl_attr_get(nla);
1041 memcpy(&flow->nd_target, nd_key->nd_target, sizeof flow->nd_target);
1042 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1043 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1056 switch (prev_type) {
1057 case OVS_KEY_ATTR_UNSPEC:
1060 case OVS_KEY_ATTR_TUN_ID:
1061 case OVS_KEY_ATTR_IN_PORT:
1064 case OVS_KEY_ATTR_ETHERNET:
1065 case OVS_KEY_ATTR_8021Q:
1068 case OVS_KEY_ATTR_ETHERTYPE:
1069 if (flow->dl_type == htons(ETH_TYPE_IP)
1070 || flow->dl_type == htons(ETH_TYPE_IPV6)
1071 || flow->dl_type == htons(ETH_TYPE_ARP)) {
1076 case OVS_KEY_ATTR_IPV4:
1077 if (flow->nw_proto == IPPROTO_TCP
1078 || flow->nw_proto == IPPROTO_UDP
1079 || flow->nw_proto == IPPROTO_ICMP) {
1084 case OVS_KEY_ATTR_IPV6:
1085 if (flow->nw_proto == IPPROTO_TCP
1086 || flow->nw_proto == IPPROTO_UDP
1087 || flow->nw_proto == IPPROTO_ICMPV6) {
1092 case OVS_KEY_ATTR_ICMPV6:
1093 if (flow->icmp_type == htons(ND_NEIGHBOR_SOLICIT)
1094 || flow->icmp_type == htons(ND_NEIGHBOR_ADVERT)) {
1099 case OVS_KEY_ATTR_TCP:
1100 case OVS_KEY_ATTR_UDP:
1101 case OVS_KEY_ATTR_ICMP:
1102 case OVS_KEY_ATTR_ARP:
1103 case OVS_KEY_ATTR_ND:
1106 case __OVS_KEY_ATTR_MAX: