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.
42 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
45 * - For an action whose argument has a fixed length, returned that
46 * nonnegative length in bytes.
48 * - For an action with a variable-length argument, returns -2.
50 * - For an invalid 'type', returns -1. */
52 odp_action_len(uint16_t type)
54 if (type > OVS_ACTION_ATTR_MAX) {
58 switch ((enum ovs_action_attr) type) {
59 case OVS_ACTION_ATTR_OUTPUT: return 4;
60 case OVS_ACTION_ATTR_USERSPACE: return -2;
61 case OVS_ACTION_ATTR_PUSH_VLAN: return 2;
62 case OVS_ACTION_ATTR_POP_VLAN: return 0;
63 case OVS_ACTION_ATTR_SET_DL_SRC: return ETH_ADDR_LEN;
64 case OVS_ACTION_ATTR_SET_DL_DST: return ETH_ADDR_LEN;
65 case OVS_ACTION_ATTR_SET_NW_SRC: return 4;
66 case OVS_ACTION_ATTR_SET_NW_DST: return 4;
67 case OVS_ACTION_ATTR_SET_NW_TOS: return 1;
68 case OVS_ACTION_ATTR_SET_TP_SRC: return 2;
69 case OVS_ACTION_ATTR_SET_TP_DST: return 2;
70 case OVS_ACTION_ATTR_SET_TUNNEL: return 8;
71 case OVS_ACTION_ATTR_SET_PRIORITY: return 4;
72 case OVS_ACTION_ATTR_POP_PRIORITY: return 0;
73 case OVS_ACTION_ATTR_SAMPLE: return -2;
75 case OVS_ACTION_ATTR_UNSPEC:
76 case __OVS_ACTION_ATTR_MAX:
84 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
86 size_t len = nl_attr_get_size(a);
88 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
90 const uint8_t *unspec;
93 unspec = nl_attr_get(a);
94 for (i = 0; i < len; i++) {
95 ds_put_char(ds, i ? ' ': '(');
96 ds_put_format(ds, "%02x", unspec[i]);
103 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
105 static const struct nl_policy ovs_sample_policy[] = {
106 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
107 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
109 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
111 const struct nlattr *nla_acts;
114 ds_put_cstr(ds, "sample");
116 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
117 ds_put_cstr(ds, "(error)");
121 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
124 ds_put_format(ds, "(sample=%.1f%%,", percentage);
126 ds_put_cstr(ds, "actions(");
127 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
128 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
129 format_odp_actions(ds, nla_acts, len);
130 ds_put_format(ds, "))");
134 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
136 static const struct nl_policy ovs_userspace_policy[] = {
137 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
138 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
140 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
142 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
143 ds_put_cstr(ds, "userspace(error)");
147 ds_put_format(ds, "userspace(pid=%"PRIu32,
148 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
150 if (a[OVS_USERSPACE_ATTR_USERDATA]) {
151 uint64_t userdata = nl_attr_get_u64(a[OVS_USERSPACE_ATTR_USERDATA]);
152 struct user_action_cookie cookie;
154 memcpy(&cookie, &userdata, sizeof cookie);
156 if (cookie.type == USER_ACTION_COOKIE_CONTROLLER) {
157 ds_put_format(ds, ",controller,length=%"PRIu32,
159 } else if (cookie.type == USER_ACTION_COOKIE_SFLOW) {
160 ds_put_format(ds, ",sFlow,n_output=%"PRIu8","
161 "vid=%"PRIu16",pcp=%"PRIu8",ifindex=%"PRIu32,
162 cookie.n_output, vlan_tci_to_vid(cookie.vlan_tci),
163 vlan_tci_to_pcp(cookie.vlan_tci), cookie.data);
165 ds_put_format(ds, ",userdata=0x%"PRIx64, userdata);
169 ds_put_char(ds, ')');
174 format_odp_action(struct ds *ds, const struct nlattr *a)
180 expected_len = odp_action_len(nl_attr_type(a));
181 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
182 ds_put_format(ds, "bad length %zu, expected %d for: ",
183 nl_attr_get_size(a), expected_len);
184 format_generic_odp_action(ds, a);
188 switch (nl_attr_type(a)) {
189 case OVS_ACTION_ATTR_OUTPUT:
190 ds_put_format(ds, "%"PRIu16, nl_attr_get_u32(a));
192 case OVS_ACTION_ATTR_USERSPACE:
193 format_odp_userspace_action(ds, a);
195 case OVS_ACTION_ATTR_SET_TUNNEL:
196 ds_put_format(ds, "set_tunnel(%#"PRIx64")",
197 ntohll(nl_attr_get_be64(a)));
199 case OVS_ACTION_ATTR_PUSH_VLAN:
200 ds_put_format(ds, "push_vlan(vid=%"PRIu16",pcp=%d)",
201 vlan_tci_to_vid(nl_attr_get_be16(a)),
202 vlan_tci_to_pcp(nl_attr_get_be16(a)));
204 case OVS_ACTION_ATTR_POP_VLAN:
205 ds_put_format(ds, "pop_vlan");
207 case OVS_ACTION_ATTR_SET_DL_SRC:
208 eth = nl_attr_get_unspec(a, ETH_ADDR_LEN);
209 ds_put_format(ds, "set_dl_src("ETH_ADDR_FMT")", ETH_ADDR_ARGS(eth));
211 case OVS_ACTION_ATTR_SET_DL_DST:
212 eth = nl_attr_get_unspec(a, ETH_ADDR_LEN);
213 ds_put_format(ds, "set_dl_dst("ETH_ADDR_FMT")", ETH_ADDR_ARGS(eth));
215 case OVS_ACTION_ATTR_SET_NW_SRC:
216 ip = nl_attr_get_be32(a);
217 ds_put_format(ds, "set_nw_src("IP_FMT")", IP_ARGS(&ip));
219 case OVS_ACTION_ATTR_SET_NW_DST:
220 ip = nl_attr_get_be32(a);
221 ds_put_format(ds, "set_nw_dst("IP_FMT")", IP_ARGS(&ip));
223 case OVS_ACTION_ATTR_SET_NW_TOS:
224 ds_put_format(ds, "set_nw_tos(%"PRIu8")", nl_attr_get_u8(a));
226 case OVS_ACTION_ATTR_SET_TP_SRC:
227 ds_put_format(ds, "set_tp_src(%"PRIu16")", ntohs(nl_attr_get_be16(a)));
229 case OVS_ACTION_ATTR_SET_TP_DST:
230 ds_put_format(ds, "set_tp_dst(%"PRIu16")", ntohs(nl_attr_get_be16(a)));
232 case OVS_ACTION_ATTR_SET_PRIORITY:
233 ds_put_format(ds, "set_priority(%#"PRIx32")", nl_attr_get_u32(a));
235 case OVS_ACTION_ATTR_POP_PRIORITY:
236 ds_put_cstr(ds, "pop_priority");
238 case OVS_ACTION_ATTR_SAMPLE:
239 format_odp_sample_action(ds, a);
242 format_generic_odp_action(ds, a);
248 format_odp_actions(struct ds *ds, const struct nlattr *actions,
252 const struct nlattr *a;
255 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
257 ds_put_char(ds, ',');
259 format_odp_action(ds, a);
262 if (left == actions_len) {
263 ds_put_cstr(ds, "<empty>");
265 ds_put_format(ds, ",***%u leftover bytes***", left);
268 ds_put_cstr(ds, "drop");
272 /* Returns the correct length of the payload for a flow key attribute of the
273 * specified 'type', or -1 if 'type' is unknown. */
275 odp_flow_key_attr_len(uint16_t type)
277 if (type > OVS_KEY_ATTR_MAX) {
281 switch ((enum ovs_key_attr) type) {
282 case OVS_KEY_ATTR_TUN_ID: return 8;
283 case OVS_KEY_ATTR_IN_PORT: return 4;
284 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
285 case OVS_KEY_ATTR_8021Q: return sizeof(struct ovs_key_8021q);
286 case OVS_KEY_ATTR_ETHERTYPE: return 2;
287 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
288 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
289 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
290 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
291 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
292 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
293 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
294 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
296 case OVS_KEY_ATTR_UNSPEC:
297 case __OVS_KEY_ATTR_MAX:
306 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
308 size_t len = nl_attr_get_size(a);
310 ds_put_format(ds, "key%"PRId16, nl_attr_type(a));
312 const uint8_t *unspec;
315 unspec = nl_attr_get(a);
316 for (i = 0; i < len; i++) {
317 ds_put_char(ds, i ? ' ': '(');
318 ds_put_format(ds, "%02x", unspec[i]);
320 ds_put_char(ds, ')');
325 format_odp_key_attr(const struct nlattr *a, struct ds *ds)
327 const struct ovs_key_ethernet *eth_key;
328 const struct ovs_key_8021q *q_key;
329 const struct ovs_key_ipv4 *ipv4_key;
330 const struct ovs_key_ipv6 *ipv6_key;
331 const struct ovs_key_tcp *tcp_key;
332 const struct ovs_key_udp *udp_key;
333 const struct ovs_key_icmp *icmp_key;
334 const struct ovs_key_icmpv6 *icmpv6_key;
335 const struct ovs_key_arp *arp_key;
336 const struct ovs_key_nd *nd_key;
338 if (nl_attr_get_size(a) != odp_flow_key_attr_len(nl_attr_type(a))) {
339 ds_put_format(ds, "bad length %zu, expected %d for: ",
341 odp_flow_key_attr_len(nl_attr_type(a)));
342 format_generic_odp_key(a, ds);
346 switch (nl_attr_type(a)) {
347 case OVS_KEY_ATTR_TUN_ID:
348 ds_put_format(ds, "tun_id(%#"PRIx64")", ntohll(nl_attr_get_be64(a)));
351 case OVS_KEY_ATTR_IN_PORT:
352 ds_put_format(ds, "in_port(%"PRIu32")", nl_attr_get_u32(a));
355 case OVS_KEY_ATTR_ETHERNET:
356 eth_key = nl_attr_get(a);
357 ds_put_format(ds, "eth(src="ETH_ADDR_FMT",dst="ETH_ADDR_FMT")",
358 ETH_ADDR_ARGS(eth_key->eth_src),
359 ETH_ADDR_ARGS(eth_key->eth_dst));
362 case OVS_KEY_ATTR_8021Q:
363 q_key = nl_attr_get(a);
364 ds_put_cstr(ds, "vlan(");
365 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
366 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(q_key->q_tpid));
368 ds_put_format(ds, "vid=%"PRIu16",pcp=%d)",
369 vlan_tci_to_vid(q_key->q_tci),
370 vlan_tci_to_pcp(q_key->q_tci));
373 case OVS_KEY_ATTR_ETHERTYPE:
374 ds_put_format(ds, "eth_type(0x%04"PRIx16")",
375 ntohs(nl_attr_get_be16(a)));
378 case OVS_KEY_ATTR_IPV4:
379 ipv4_key = nl_attr_get(a);
380 ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT","
381 "proto=%"PRId8",tos=%"PRIu8")",
382 IP_ARGS(&ipv4_key->ipv4_src),
383 IP_ARGS(&ipv4_key->ipv4_dst),
384 ipv4_key->ipv4_proto, ipv4_key->ipv4_tos);
387 case OVS_KEY_ATTR_IPV6: {
388 char src_str[INET6_ADDRSTRLEN];
389 char dst_str[INET6_ADDRSTRLEN];
391 ipv6_key = nl_attr_get(a);
392 inet_ntop(AF_INET6, ipv6_key->ipv6_src, src_str, sizeof src_str);
393 inet_ntop(AF_INET6, ipv6_key->ipv6_dst, dst_str, sizeof dst_str);
395 ds_put_format(ds, "ipv6(src=%s,dst=%s,proto=%"PRId8",tos=%"PRIu8")",
396 src_str, dst_str, ipv6_key->ipv6_proto,
401 case OVS_KEY_ATTR_TCP:
402 tcp_key = nl_attr_get(a);
403 ds_put_format(ds, "tcp(src=%"PRIu16",dst=%"PRIu16")",
404 ntohs(tcp_key->tcp_src), ntohs(tcp_key->tcp_dst));
407 case OVS_KEY_ATTR_UDP:
408 udp_key = nl_attr_get(a);
409 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16")",
410 ntohs(udp_key->udp_src), ntohs(udp_key->udp_dst));
413 case OVS_KEY_ATTR_ICMP:
414 icmp_key = nl_attr_get(a);
415 ds_put_format(ds, "icmp(type=%"PRIu8",code=%"PRIu8")",
416 icmp_key->icmp_type, icmp_key->icmp_code);
419 case OVS_KEY_ATTR_ICMPV6:
420 icmpv6_key = nl_attr_get(a);
421 ds_put_format(ds, "icmpv6(type=%"PRIu8",code=%"PRIu8")",
422 icmpv6_key->icmpv6_type, icmpv6_key->icmpv6_code);
425 case OVS_KEY_ATTR_ARP:
426 arp_key = nl_attr_get(a);
427 ds_put_format(ds, "arp(sip="IP_FMT",tip="IP_FMT",op=%"PRIu16","
428 "sha="ETH_ADDR_FMT",tha="ETH_ADDR_FMT")",
429 IP_ARGS(&arp_key->arp_sip), IP_ARGS(&arp_key->arp_tip),
430 ntohs(arp_key->arp_op), ETH_ADDR_ARGS(arp_key->arp_sha),
431 ETH_ADDR_ARGS(arp_key->arp_tha));
434 case OVS_KEY_ATTR_ND: {
435 char target[INET6_ADDRSTRLEN];
437 nd_key = nl_attr_get(a);
438 inet_ntop(AF_INET6, nd_key->nd_target, target, sizeof target);
440 ds_put_format(ds, "nd(target=%s", target);
441 if (!eth_addr_is_zero(nd_key->nd_sll)) {
442 ds_put_format(ds, ",sll="ETH_ADDR_FMT,
443 ETH_ADDR_ARGS(nd_key->nd_sll));
445 if (!eth_addr_is_zero(nd_key->nd_tll)) {
446 ds_put_format(ds, ",tll="ETH_ADDR_FMT,
447 ETH_ADDR_ARGS(nd_key->nd_tll));
449 ds_put_char(ds, ')');
454 format_generic_odp_key(a, ds);
459 /* Appends to 'ds' a string representation of the 'key_len' bytes of
460 * OVS_KEY_ATTR_* attributes in 'key'. */
462 odp_flow_key_format(const struct nlattr *key, size_t key_len, struct ds *ds)
465 const struct nlattr *a;
468 NL_ATTR_FOR_EACH (a, left, key, key_len) {
470 ds_put_char(ds, ',');
472 format_odp_key_attr(a, ds);
475 if (left == key_len) {
476 ds_put_cstr(ds, "<empty>");
478 ds_put_format(ds, ",***%u leftover bytes***", left);
481 ds_put_cstr(ds, "<empty>");
486 put_nd_key(int n, const char *nd_target_s,
487 const uint8_t *nd_sll, const uint8_t *nd_tll, struct ofpbuf *key)
489 struct ovs_key_nd nd_key;
491 memset(&nd_key, 0, sizeof nd_key);
492 if (inet_pton(AF_INET6, nd_target_s, nd_key.nd_target) != 1) {
496 memcpy(nd_key.nd_sll, nd_sll, ETH_ADDR_LEN);
499 memcpy(nd_key.nd_tll, nd_tll, ETH_ADDR_LEN);
501 nl_msg_put_unspec(key, OVS_KEY_ATTR_ND, &nd_key, sizeof nd_key);
506 parse_odp_key_attr(const char *s, struct ofpbuf *key)
508 /* Many of the sscanf calls in this function use oversized destination
509 * fields because some sscanf() implementations truncate the range of %i
510 * directives, so that e.g. "%"SCNi16 interprets input of "0xfedc" as a
511 * value of 0x7fff. The other alternatives are to allow only a single
512 * radix (e.g. decimal or hexadecimal) or to write more sophisticated
515 * The tun_id parser has to use an alternative approach because there is no
516 * type larger than 64 bits. */
522 if (sscanf(s, "tun_id(%31[x0123456789abcdefABCDEF])%n",
523 tun_id_s, &n) > 0 && n > 0) {
524 uint64_t tun_id = strtoull(tun_id_s, NULL, 0);
525 nl_msg_put_be64(key, OVS_KEY_ATTR_TUN_ID, htonll(tun_id));
531 unsigned long long int in_port;
534 if (sscanf(s, "in_port(%lli)%n", &in_port, &n) > 0 && n > 0) {
535 nl_msg_put_u32(key, OVS_KEY_ATTR_IN_PORT, in_port);
541 struct ovs_key_ethernet eth_key;
545 "eth(src="ETH_ADDR_SCAN_FMT",dst="ETH_ADDR_SCAN_FMT")%n",
546 ETH_ADDR_SCAN_ARGS(eth_key.eth_src),
547 ETH_ADDR_SCAN_ARGS(eth_key.eth_dst), &n) > 0 && n > 0) {
548 nl_msg_put_unspec(key, OVS_KEY_ATTR_ETHERNET,
549 ð_key, sizeof eth_key);
555 uint16_t tpid = ETH_TYPE_VLAN;
560 if ((sscanf(s, "vlan(vid=%"SCNi16",pcp=%i)%n",
561 &vid, &pcp, &n) > 0 && n > 0) ||
562 (sscanf(s, "vlan(tpid=%"SCNi16",vid=%"SCNi16",pcp=%i)%n",
563 &tpid, &vid, &pcp, &n) > 0 && n > 0)) {
564 struct ovs_key_8021q q_key;
566 q_key.q_tpid = htons(tpid);
567 q_key.q_tci = htons((vid << VLAN_VID_SHIFT) |
568 (pcp << VLAN_PCP_SHIFT));
569 nl_msg_put_unspec(key, OVS_KEY_ATTR_8021Q, &q_key, sizeof q_key);
578 if (sscanf(s, "eth_type(%i)%n", ð_type, &n) > 0 && n > 0) {
579 nl_msg_put_be16(key, OVS_KEY_ATTR_ETHERTYPE, htons(eth_type));
591 if (sscanf(s, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT","
592 "proto=%i,tos=%i)%n",
593 IP_SCAN_ARGS(&ipv4_src),
594 IP_SCAN_ARGS(&ipv4_dst), &ipv4_proto, &ipv4_tos, &n) > 0
596 struct ovs_key_ipv4 ipv4_key;
598 memset(&ipv4_key, 0, sizeof ipv4_key);
599 ipv4_key.ipv4_src = ipv4_src;
600 ipv4_key.ipv4_dst = ipv4_dst;
601 ipv4_key.ipv4_proto = ipv4_proto;
602 ipv4_key.ipv4_tos = ipv4_tos;
603 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV4,
604 &ipv4_key, sizeof ipv4_key);
610 char ipv6_src_s[IPV6_SCAN_LEN + 1];
611 char ipv6_dst_s[IPV6_SCAN_LEN + 1];
616 if (sscanf(s, "ipv6(src="IPV6_SCAN_FMT",dst="IPV6_SCAN_FMT","
617 "proto=%i,tos=%i)%n",
618 ipv6_src_s, ipv6_dst_s,
619 &ipv6_proto, &ipv6_tos, &n) > 0 && n > 0) {
620 struct ovs_key_ipv6 ipv6_key;
622 memset(&ipv6_key, 0, sizeof ipv6_key);
623 if (inet_pton(AF_INET6, ipv6_src_s, &ipv6_key.ipv6_src) != 1 ||
624 inet_pton(AF_INET6, ipv6_dst_s, &ipv6_key.ipv6_dst) != 1) {
627 ipv6_key.ipv6_proto = ipv6_proto;
628 ipv6_key.ipv6_tos = ipv6_tos;
629 nl_msg_put_unspec(key, OVS_KEY_ATTR_IPV6,
630 &ipv6_key, sizeof ipv6_key);
640 if (sscanf(s, "tcp(src=%i,dst=%i)%n",&tcp_src, &tcp_dst, &n) > 0
642 struct ovs_key_tcp tcp_key;
644 tcp_key.tcp_src = htons(tcp_src);
645 tcp_key.tcp_dst = htons(tcp_dst);
646 nl_msg_put_unspec(key, OVS_KEY_ATTR_TCP, &tcp_key, sizeof tcp_key);
656 if (sscanf(s, "udp(src=%i,dst=%i)%n", &udp_src, &udp_dst, &n) > 0
658 struct ovs_key_udp udp_key;
660 udp_key.udp_src = htons(udp_src);
661 udp_key.udp_dst = htons(udp_dst);
662 nl_msg_put_unspec(key, OVS_KEY_ATTR_UDP, &udp_key, sizeof udp_key);
672 if (sscanf(s, "icmp(type=%i,code=%i)%n",
673 &icmp_type, &icmp_code, &n) > 0
675 struct ovs_key_icmp icmp_key;
677 icmp_key.icmp_type = icmp_type;
678 icmp_key.icmp_code = icmp_code;
679 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMP,
680 &icmp_key, sizeof icmp_key);
686 struct ovs_key_icmpv6 icmpv6_key;
689 if (sscanf(s, "icmpv6(type=%"SCNi8",code=%"SCNi8")%n",
690 &icmpv6_key.icmpv6_type, &icmpv6_key.icmpv6_code,&n) > 0
692 nl_msg_put_unspec(key, OVS_KEY_ATTR_ICMPV6,
693 &icmpv6_key, sizeof icmpv6_key);
702 uint8_t arp_sha[ETH_ADDR_LEN];
703 uint8_t arp_tha[ETH_ADDR_LEN];
706 if (sscanf(s, "arp(sip="IP_SCAN_FMT",tip="IP_SCAN_FMT","
707 "op=%i,sha="ETH_ADDR_SCAN_FMT",tha="ETH_ADDR_SCAN_FMT")%n",
708 IP_SCAN_ARGS(&arp_sip),
709 IP_SCAN_ARGS(&arp_tip),
711 ETH_ADDR_SCAN_ARGS(arp_sha),
712 ETH_ADDR_SCAN_ARGS(arp_tha), &n) > 0 && n > 0) {
713 struct ovs_key_arp arp_key;
715 memset(&arp_key, 0, sizeof arp_key);
716 arp_key.arp_sip = arp_sip;
717 arp_key.arp_tip = arp_tip;
718 arp_key.arp_op = htons(arp_op);
719 memcpy(arp_key.arp_sha, arp_sha, ETH_ADDR_LEN);
720 memcpy(arp_key.arp_tha, arp_tha, ETH_ADDR_LEN);
721 nl_msg_put_unspec(key, OVS_KEY_ATTR_ARP, &arp_key, sizeof arp_key);
727 char nd_target_s[IPV6_SCAN_LEN + 1];
728 uint8_t nd_sll[ETH_ADDR_LEN];
729 uint8_t nd_tll[ETH_ADDR_LEN];
732 if (sscanf(s, "nd(target="IPV6_SCAN_FMT")%n",
733 nd_target_s, &n) > 0 && n > 0) {
734 return put_nd_key(n, nd_target_s, NULL, NULL, key);
736 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT")%n",
737 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll), &n) > 0
739 return put_nd_key(n, nd_target_s, nd_sll, NULL, key);
741 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",tll="ETH_ADDR_SCAN_FMT")%n",
742 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
744 return put_nd_key(n, nd_target_s, NULL, nd_tll, key);
746 if (sscanf(s, "nd(target="IPV6_SCAN_FMT",sll="ETH_ADDR_SCAN_FMT","
747 "tll="ETH_ADDR_SCAN_FMT")%n",
748 nd_target_s, ETH_ADDR_SCAN_ARGS(nd_sll),
749 ETH_ADDR_SCAN_ARGS(nd_tll), &n) > 0
751 return put_nd_key(n, nd_target_s, nd_sll, nd_tll, key);
758 /* Parses the string representation of a datapath flow key, in the
759 * format output by odp_flow_key_format(). Returns 0 if successful,
760 * otherwise a positive errno value. On success, the flow key is
761 * appended to 'key' as a series of Netlink attributes. On failure, no
762 * data is appended to 'key'. Either way, 'key''s data might be
765 * On success, the attributes appended to 'key' are individually syntactically
766 * valid, but they may not be valid as a sequence. 'key' might, for example,
767 * be missing an "in_port" key, have duplicated keys, or have keys in the wrong
768 * order. odp_flow_key_to_flow() will detect those errors. */
770 odp_flow_key_from_string(const char *s, struct ofpbuf *key)
772 const size_t old_size = key->size;
776 s += strspn(s, ", \t\r\n");
781 retval = parse_odp_key_attr(s, key);
783 key->size = old_size;
792 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'. */
794 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow)
796 struct ovs_key_ethernet *eth_key;
798 if (flow->tun_id != htonll(0)) {
799 nl_msg_put_be64(buf, OVS_KEY_ATTR_TUN_ID, flow->tun_id);
802 if (flow->in_port != OFPP_NONE) {
803 nl_msg_put_u32(buf, OVS_KEY_ATTR_IN_PORT,
804 ofp_port_to_odp_port(flow->in_port));
807 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
809 memcpy(eth_key->eth_src, flow->dl_src, ETH_ADDR_LEN);
810 memcpy(eth_key->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
812 if (flow->vlan_tci != htons(0)) {
813 struct ovs_key_8021q *q_key;
815 q_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_8021Q,
817 q_key->q_tpid = htons(ETH_TYPE_VLAN);
818 q_key->q_tci = flow->vlan_tci & ~htons(VLAN_CFI);
821 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
825 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, flow->dl_type);
827 if (flow->dl_type == htons(ETH_TYPE_IP)) {
828 struct ovs_key_ipv4 *ipv4_key;
830 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
832 memset(ipv4_key, 0, sizeof *ipv4_key);
833 ipv4_key->ipv4_src = flow->nw_src;
834 ipv4_key->ipv4_dst = flow->nw_dst;
835 ipv4_key->ipv4_proto = flow->nw_proto;
836 ipv4_key->ipv4_tos = flow->nw_tos;
837 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
838 struct ovs_key_ipv6 *ipv6_key;
840 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
842 memset(ipv6_key, 0, sizeof *ipv6_key);
843 memcpy(ipv6_key->ipv6_src, &flow->ipv6_src, sizeof ipv6_key->ipv6_src);
844 memcpy(ipv6_key->ipv6_dst, &flow->ipv6_dst, sizeof ipv6_key->ipv6_dst);
845 ipv6_key->ipv6_proto = flow->nw_proto;
846 ipv6_key->ipv6_tos = flow->nw_tos;
847 } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
848 struct ovs_key_arp *arp_key;
850 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
852 memset(arp_key, 0, sizeof *arp_key);
853 arp_key->arp_sip = flow->nw_src;
854 arp_key->arp_tip = flow->nw_dst;
855 arp_key->arp_op = htons(flow->nw_proto);
856 memcpy(arp_key->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
857 memcpy(arp_key->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
860 if (flow->dl_type == htons(ETH_TYPE_IP)
861 || flow->dl_type == htons(ETH_TYPE_IPV6)) {
863 if (flow->nw_proto == IPPROTO_TCP) {
864 struct ovs_key_tcp *tcp_key;
866 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
868 tcp_key->tcp_src = flow->tp_src;
869 tcp_key->tcp_dst = flow->tp_dst;
870 } else if (flow->nw_proto == IPPROTO_UDP) {
871 struct ovs_key_udp *udp_key;
873 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
875 udp_key->udp_src = flow->tp_src;
876 udp_key->udp_dst = flow->tp_dst;
877 } else if (flow->dl_type == htons(ETH_TYPE_IP)
878 && flow->nw_proto == IPPROTO_ICMP) {
879 struct ovs_key_icmp *icmp_key;
881 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
883 icmp_key->icmp_type = ntohs(flow->tp_src);
884 icmp_key->icmp_code = ntohs(flow->tp_dst);
885 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
886 && flow->nw_proto == IPPROTO_ICMPV6) {
887 struct ovs_key_icmpv6 *icmpv6_key;
889 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
891 icmpv6_key->icmpv6_type = ntohs(flow->tp_src);
892 icmpv6_key->icmpv6_code = ntohs(flow->tp_dst);
894 if (icmpv6_key->icmpv6_type == ND_NEIGHBOR_SOLICIT
895 || icmpv6_key->icmpv6_type == ND_NEIGHBOR_ADVERT) {
896 struct ovs_key_nd *nd_key;
898 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
900 memcpy(nd_key->nd_target, &flow->nd_target,
901 sizeof nd_key->nd_target);
902 memcpy(nd_key->nd_sll, flow->arp_sha, ETH_ADDR_LEN);
903 memcpy(nd_key->nd_tll, flow->arp_tha, ETH_ADDR_LEN);
909 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
910 * structure in 'flow'. Returns 0 if successful, otherwise EINVAL. */
912 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
915 const struct nlattr *nla;
916 enum ovs_key_attr prev_type;
919 memset(flow, 0, sizeof *flow);
920 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
921 flow->in_port = OFPP_NONE;
923 prev_type = OVS_KEY_ATTR_UNSPEC;
924 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
925 const struct ovs_key_ethernet *eth_key;
926 const struct ovs_key_8021q *q_key;
927 const struct ovs_key_ipv4 *ipv4_key;
928 const struct ovs_key_ipv6 *ipv6_key;
929 const struct ovs_key_tcp *tcp_key;
930 const struct ovs_key_udp *udp_key;
931 const struct ovs_key_icmp *icmp_key;
932 const struct ovs_key_icmpv6 *icmpv6_key;
933 const struct ovs_key_arp *arp_key;
934 const struct ovs_key_nd *nd_key;
936 uint16_t type = nl_attr_type(nla);
937 int len = odp_flow_key_attr_len(type);
939 if (nl_attr_get_size(nla) != len && len != -1) {
943 #define TRANSITION(PREV_TYPE, TYPE) (((PREV_TYPE) << 16) | (TYPE))
944 switch (TRANSITION(prev_type, type)) {
945 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_TUN_ID):
946 flow->tun_id = nl_attr_get_be64(nla);
949 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_IN_PORT):
950 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_IN_PORT):
951 if (nl_attr_get_u32(nla) >= UINT16_MAX) {
954 flow->in_port = odp_port_to_ofp_port(nl_attr_get_u32(nla));
957 case TRANSITION(OVS_KEY_ATTR_UNSPEC, OVS_KEY_ATTR_ETHERNET):
958 case TRANSITION(OVS_KEY_ATTR_TUN_ID, OVS_KEY_ATTR_ETHERNET):
959 case TRANSITION(OVS_KEY_ATTR_IN_PORT, OVS_KEY_ATTR_ETHERNET):
960 eth_key = nl_attr_get(nla);
961 memcpy(flow->dl_src, eth_key->eth_src, ETH_ADDR_LEN);
962 memcpy(flow->dl_dst, eth_key->eth_dst, ETH_ADDR_LEN);
965 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_8021Q):
966 q_key = nl_attr_get(nla);
967 if (q_key->q_tpid != htons(ETH_TYPE_VLAN)) {
968 /* Only standard 0x8100 VLANs currently supported. */
971 if (q_key->q_tci & htons(VLAN_CFI)) {
974 flow->vlan_tci = q_key->q_tci | htons(VLAN_CFI);
977 case TRANSITION(OVS_KEY_ATTR_8021Q, OVS_KEY_ATTR_ETHERTYPE):
978 case TRANSITION(OVS_KEY_ATTR_ETHERNET, OVS_KEY_ATTR_ETHERTYPE):
979 flow->dl_type = nl_attr_get_be16(nla);
980 if (ntohs(flow->dl_type) < 1536) {
985 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV4):
986 if (flow->dl_type != htons(ETH_TYPE_IP)) {
989 ipv4_key = nl_attr_get(nla);
990 flow->nw_src = ipv4_key->ipv4_src;
991 flow->nw_dst = ipv4_key->ipv4_dst;
992 flow->nw_proto = ipv4_key->ipv4_proto;
993 flow->nw_tos = ipv4_key->ipv4_tos;
994 if (flow->nw_tos & IP_ECN_MASK) {
999 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_IPV6):
1000 if (flow->dl_type != htons(ETH_TYPE_IPV6)) {
1003 ipv6_key = nl_attr_get(nla);
1004 memcpy(&flow->ipv6_src, ipv6_key->ipv6_src, sizeof flow->ipv6_src);
1005 memcpy(&flow->ipv6_dst, ipv6_key->ipv6_dst, sizeof flow->ipv6_dst);
1006 flow->nw_proto = ipv6_key->ipv6_proto;
1007 flow->nw_tos = ipv6_key->ipv6_tos;
1008 if (flow->nw_tos & IP_ECN_MASK) {
1013 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_TCP):
1014 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_TCP):
1015 if (flow->nw_proto != IPPROTO_TCP) {
1018 tcp_key = nl_attr_get(nla);
1019 flow->tp_src = tcp_key->tcp_src;
1020 flow->tp_dst = tcp_key->tcp_dst;
1023 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_UDP):
1024 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_UDP):
1025 if (flow->nw_proto != IPPROTO_UDP) {
1028 udp_key = nl_attr_get(nla);
1029 flow->tp_src = udp_key->udp_src;
1030 flow->tp_dst = udp_key->udp_dst;
1033 case TRANSITION(OVS_KEY_ATTR_IPV4, OVS_KEY_ATTR_ICMP):
1034 if (flow->nw_proto != IPPROTO_ICMP) {
1037 icmp_key = nl_attr_get(nla);
1038 flow->tp_src = htons(icmp_key->icmp_type);
1039 flow->tp_dst = htons(icmp_key->icmp_code);
1042 case TRANSITION(OVS_KEY_ATTR_IPV6, OVS_KEY_ATTR_ICMPV6):
1043 if (flow->nw_proto != IPPROTO_ICMPV6) {
1046 icmpv6_key = nl_attr_get(nla);
1047 flow->tp_src = htons(icmpv6_key->icmpv6_type);
1048 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
1051 case TRANSITION(OVS_KEY_ATTR_ETHERTYPE, OVS_KEY_ATTR_ARP):
1052 if (flow->dl_type != htons(ETH_TYPE_ARP)) {
1055 arp_key = nl_attr_get(nla);
1056 flow->nw_src = arp_key->arp_sip;
1057 flow->nw_dst = arp_key->arp_tip;
1058 if (arp_key->arp_op & htons(0xff00)) {
1061 flow->nw_proto = ntohs(arp_key->arp_op);
1062 memcpy(flow->arp_sha, arp_key->arp_sha, ETH_ADDR_LEN);
1063 memcpy(flow->arp_tha, arp_key->arp_tha, ETH_ADDR_LEN);
1066 case TRANSITION(OVS_KEY_ATTR_ICMPV6, OVS_KEY_ATTR_ND):
1067 if (flow->tp_src != htons(ND_NEIGHBOR_SOLICIT)
1068 && flow->tp_src != htons(ND_NEIGHBOR_ADVERT)) {
1071 nd_key = nl_attr_get(nla);
1072 memcpy(&flow->nd_target, nd_key->nd_target, sizeof flow->nd_target);
1073 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
1074 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
1087 switch (prev_type) {
1088 case OVS_KEY_ATTR_UNSPEC:
1091 case OVS_KEY_ATTR_TUN_ID:
1092 case OVS_KEY_ATTR_IN_PORT:
1095 case OVS_KEY_ATTR_ETHERNET:
1096 case OVS_KEY_ATTR_8021Q:
1099 case OVS_KEY_ATTR_ETHERTYPE:
1100 if (flow->dl_type == htons(ETH_TYPE_IP)
1101 || flow->dl_type == htons(ETH_TYPE_IPV6)
1102 || flow->dl_type == htons(ETH_TYPE_ARP)) {
1107 case OVS_KEY_ATTR_IPV4:
1108 if (flow->nw_proto == IPPROTO_TCP
1109 || flow->nw_proto == IPPROTO_UDP
1110 || flow->nw_proto == IPPROTO_ICMP) {
1115 case OVS_KEY_ATTR_IPV6:
1116 if (flow->nw_proto == IPPROTO_TCP
1117 || flow->nw_proto == IPPROTO_UDP
1118 || flow->nw_proto == IPPROTO_ICMPV6) {
1123 case OVS_KEY_ATTR_ICMPV6:
1124 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
1125 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
1130 case OVS_KEY_ATTR_TCP:
1131 case OVS_KEY_ATTR_UDP:
1132 case OVS_KEY_ATTR_ICMP:
1133 case OVS_KEY_ATTR_ARP:
1134 case OVS_KEY_ATTR_ND:
1137 case __OVS_KEY_ATTR_MAX: