2 * Copyright (c) 2007-2014 Nicira, Inc.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of version 2 of the GNU General Public
6 * License as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24 #include <linux/uaccess.h>
25 #include <linux/netdevice.h>
26 #include <linux/etherdevice.h>
27 #include <linux/if_ether.h>
28 #include <linux/if_vlan.h>
29 #include <net/llc_pdu.h>
30 #include <linux/kernel.h>
31 #include <linux/jhash.h>
32 #include <linux/jiffies.h>
33 #include <linux/llc.h>
34 #include <linux/module.h>
36 #include <linux/rcupdate.h>
37 #include <linux/if_arp.h>
39 #include <linux/ipv6.h>
40 #include <linux/sctp.h>
41 #include <linux/tcp.h>
42 #include <linux/udp.h>
43 #include <linux/icmp.h>
44 #include <linux/icmpv6.h>
45 #include <linux/rculist.h>
46 #include <net/geneve.h>
48 #include <net/ip_tunnels.h>
50 #include <net/ndisc.h>
52 #include "flow_netlink.h"
54 static void update_range(struct sw_flow_match *match,
55 size_t offset, size_t size, bool is_mask)
57 struct sw_flow_key_range *range;
58 size_t start = rounddown(offset, sizeof(long));
59 size_t end = roundup(offset + size, sizeof(long));
62 range = &match->range;
64 range = &match->mask->range;
66 if (range->start == range->end) {
72 if (range->start > start)
79 #define SW_FLOW_KEY_PUT(match, field, value, is_mask) \
81 update_range(match, offsetof(struct sw_flow_key, field), \
82 sizeof((match)->key->field), is_mask); \
84 (match)->mask->key.field = value; \
86 (match)->key->field = value; \
89 #define SW_FLOW_KEY_MEMCPY_OFFSET(match, offset, value_p, len, is_mask) \
91 update_range(match, offset, len, is_mask); \
93 memcpy((u8 *)&(match)->mask->key + offset, value_p, len);\
95 memcpy((u8 *)(match)->key + offset, value_p, len); \
98 #define SW_FLOW_KEY_MEMCPY(match, field, value_p, len, is_mask) \
99 SW_FLOW_KEY_MEMCPY_OFFSET(match, offsetof(struct sw_flow_key, field), \
100 value_p, len, is_mask)
102 #define SW_FLOW_KEY_MEMSET_FIELD(match, field, value, is_mask) \
104 update_range(match, offsetof(struct sw_flow_key, field), \
105 sizeof((match)->key->field), is_mask); \
107 memset((u8 *)&(match)->mask->key.field, value, \
108 sizeof((match)->mask->key.field)); \
110 memset((u8 *)&(match)->key->field, value, \
111 sizeof((match)->key->field)); \
114 static bool match_validate(const struct sw_flow_match *match,
115 u64 key_attrs, u64 mask_attrs, bool log)
117 u64 key_expected = 1ULL << OVS_KEY_ATTR_ETHERNET;
118 u64 mask_allowed = key_attrs; /* At most allow all key attributes */
120 /* The following mask attributes allowed only if they
121 * pass the validation tests.
123 mask_allowed &= ~((1ULL << OVS_KEY_ATTR_IPV4)
124 | (1ULL << OVS_KEY_ATTR_IPV6)
125 | (1ULL << OVS_KEY_ATTR_TCP)
126 | (1ULL << OVS_KEY_ATTR_TCP_FLAGS)
127 | (1ULL << OVS_KEY_ATTR_UDP)
128 | (1ULL << OVS_KEY_ATTR_SCTP)
129 | (1ULL << OVS_KEY_ATTR_ICMP)
130 | (1ULL << OVS_KEY_ATTR_ICMPV6)
131 | (1ULL << OVS_KEY_ATTR_ARP)
132 | (1ULL << OVS_KEY_ATTR_ND)
133 | (1ULL << OVS_KEY_ATTR_MPLS));
135 /* Always allowed mask fields. */
136 mask_allowed |= ((1ULL << OVS_KEY_ATTR_TUNNEL)
137 | (1ULL << OVS_KEY_ATTR_IN_PORT)
138 | (1ULL << OVS_KEY_ATTR_ETHERTYPE));
140 /* Check key attributes. */
141 if (match->key->eth.type == htons(ETH_P_ARP)
142 || match->key->eth.type == htons(ETH_P_RARP)) {
143 key_expected |= 1ULL << OVS_KEY_ATTR_ARP;
144 if (match->mask && (match->mask->key.eth.type == htons(0xffff)))
145 mask_allowed |= 1ULL << OVS_KEY_ATTR_ARP;
149 if (eth_p_mpls(match->key->eth.type)) {
150 key_expected |= 1ULL << OVS_KEY_ATTR_MPLS;
151 if (match->mask && (match->mask->key.eth.type == htons(0xffff)))
152 mask_allowed |= 1ULL << OVS_KEY_ATTR_MPLS;
155 if (match->key->eth.type == htons(ETH_P_IP)) {
156 key_expected |= 1ULL << OVS_KEY_ATTR_IPV4;
157 if (match->mask && (match->mask->key.eth.type == htons(0xffff)))
158 mask_allowed |= 1ULL << OVS_KEY_ATTR_IPV4;
160 if (match->key->ip.frag != OVS_FRAG_TYPE_LATER) {
161 if (match->key->ip.proto == IPPROTO_UDP) {
162 key_expected |= 1ULL << OVS_KEY_ATTR_UDP;
163 if (match->mask && (match->mask->key.ip.proto == 0xff))
164 mask_allowed |= 1ULL << OVS_KEY_ATTR_UDP;
167 if (match->key->ip.proto == IPPROTO_SCTP) {
168 key_expected |= 1ULL << OVS_KEY_ATTR_SCTP;
169 if (match->mask && (match->mask->key.ip.proto == 0xff))
170 mask_allowed |= 1ULL << OVS_KEY_ATTR_SCTP;
173 if (match->key->ip.proto == IPPROTO_TCP) {
174 key_expected |= 1ULL << OVS_KEY_ATTR_TCP;
175 key_expected |= 1ULL << OVS_KEY_ATTR_TCP_FLAGS;
176 if (match->mask && (match->mask->key.ip.proto == 0xff)) {
177 mask_allowed |= 1ULL << OVS_KEY_ATTR_TCP;
178 mask_allowed |= 1ULL << OVS_KEY_ATTR_TCP_FLAGS;
182 if (match->key->ip.proto == IPPROTO_ICMP) {
183 key_expected |= 1ULL << OVS_KEY_ATTR_ICMP;
184 if (match->mask && (match->mask->key.ip.proto == 0xff))
185 mask_allowed |= 1ULL << OVS_KEY_ATTR_ICMP;
190 if (match->key->eth.type == htons(ETH_P_IPV6)) {
191 key_expected |= 1ULL << OVS_KEY_ATTR_IPV6;
192 if (match->mask && (match->mask->key.eth.type == htons(0xffff)))
193 mask_allowed |= 1ULL << OVS_KEY_ATTR_IPV6;
195 if (match->key->ip.frag != OVS_FRAG_TYPE_LATER) {
196 if (match->key->ip.proto == IPPROTO_UDP) {
197 key_expected |= 1ULL << OVS_KEY_ATTR_UDP;
198 if (match->mask && (match->mask->key.ip.proto == 0xff))
199 mask_allowed |= 1ULL << OVS_KEY_ATTR_UDP;
202 if (match->key->ip.proto == IPPROTO_SCTP) {
203 key_expected |= 1ULL << OVS_KEY_ATTR_SCTP;
204 if (match->mask && (match->mask->key.ip.proto == 0xff))
205 mask_allowed |= 1ULL << OVS_KEY_ATTR_SCTP;
208 if (match->key->ip.proto == IPPROTO_TCP) {
209 key_expected |= 1ULL << OVS_KEY_ATTR_TCP;
210 key_expected |= 1ULL << OVS_KEY_ATTR_TCP_FLAGS;
211 if (match->mask && (match->mask->key.ip.proto == 0xff)) {
212 mask_allowed |= 1ULL << OVS_KEY_ATTR_TCP;
213 mask_allowed |= 1ULL << OVS_KEY_ATTR_TCP_FLAGS;
217 if (match->key->ip.proto == IPPROTO_ICMPV6) {
218 key_expected |= 1ULL << OVS_KEY_ATTR_ICMPV6;
219 if (match->mask && (match->mask->key.ip.proto == 0xff))
220 mask_allowed |= 1ULL << OVS_KEY_ATTR_ICMPV6;
222 if (match->key->tp.src ==
223 htons(NDISC_NEIGHBOUR_SOLICITATION) ||
224 match->key->tp.src == htons(NDISC_NEIGHBOUR_ADVERTISEMENT)) {
225 key_expected |= 1ULL << OVS_KEY_ATTR_ND;
226 if (match->mask && (match->mask->key.tp.src == htons(0xff)))
227 mask_allowed |= 1ULL << OVS_KEY_ATTR_ND;
233 if ((key_attrs & key_expected) != key_expected) {
234 /* Key attributes check failed. */
236 "Missing expected key attributes (key_attrs=%llx, expected=%llx).",
237 (unsigned long long)key_attrs,
238 (unsigned long long)key_expected);
242 if ((mask_attrs & mask_allowed) != mask_attrs) {
243 /* Mask attributes check failed. */
245 "Contain more than allowed mask fields (mask_attrs=%llx, mask_allowed=%llx).",
246 (unsigned long long)mask_attrs,
247 (unsigned long long)mask_allowed);
254 size_t ovs_tun_key_attr_size(void)
256 /* Whenever adding new OVS_TUNNEL_KEY_ FIELDS, we should consider
257 * updating this function.
259 return nla_total_size(8) /* OVS_TUNNEL_KEY_ATTR_ID */
260 + nla_total_size(4) /* OVS_TUNNEL_KEY_ATTR_IPV4_SRC */
261 + nla_total_size(4) /* OVS_TUNNEL_KEY_ATTR_IPV4_DST */
262 + nla_total_size(1) /* OVS_TUNNEL_KEY_ATTR_TOS */
263 + nla_total_size(1) /* OVS_TUNNEL_KEY_ATTR_TTL */
264 + nla_total_size(0) /* OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT */
265 + nla_total_size(0) /* OVS_TUNNEL_KEY_ATTR_CSUM */
266 + nla_total_size(0) /* OVS_TUNNEL_KEY_ATTR_OAM */
267 + nla_total_size(256) /* OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS */
268 + nla_total_size(2) /* OVS_TUNNEL_KEY_ATTR_TP_SRC */
269 + nla_total_size(2); /* OVS_TUNNEL_KEY_ATTR_TP_DST */
272 size_t ovs_key_attr_size(void)
274 /* Whenever adding new OVS_KEY_ FIELDS, we should consider
275 * updating this function.
277 BUILD_BUG_ON(OVS_KEY_ATTR_TUNNEL_INFO != 22);
279 return nla_total_size(4) /* OVS_KEY_ATTR_PRIORITY */
280 + nla_total_size(0) /* OVS_KEY_ATTR_TUNNEL */
281 + ovs_tun_key_attr_size()
282 + nla_total_size(4) /* OVS_KEY_ATTR_IN_PORT */
283 + nla_total_size(4) /* OVS_KEY_ATTR_SKB_MARK */
284 + nla_total_size(4) /* OVS_KEY_ATTR_DP_HASH */
285 + nla_total_size(4) /* OVS_KEY_ATTR_RECIRC_ID */
286 + nla_total_size(12) /* OVS_KEY_ATTR_ETHERNET */
287 + nla_total_size(2) /* OVS_KEY_ATTR_ETHERTYPE */
288 + nla_total_size(4) /* OVS_KEY_ATTR_VLAN */
289 + nla_total_size(0) /* OVS_KEY_ATTR_ENCAP */
290 + nla_total_size(2) /* OVS_KEY_ATTR_ETHERTYPE */
291 + nla_total_size(40) /* OVS_KEY_ATTR_IPV6 */
292 + nla_total_size(2) /* OVS_KEY_ATTR_ICMPV6 */
293 + nla_total_size(28); /* OVS_KEY_ATTR_ND */
296 /* The size of the argument for each %OVS_KEY_ATTR_* Netlink attribute. */
297 static const int ovs_key_lens[OVS_KEY_ATTR_MAX + 1] = {
298 [OVS_KEY_ATTR_ENCAP] = -1,
299 [OVS_KEY_ATTR_PRIORITY] = sizeof(u32),
300 [OVS_KEY_ATTR_IN_PORT] = sizeof(u32),
301 [OVS_KEY_ATTR_SKB_MARK] = sizeof(u32),
302 [OVS_KEY_ATTR_ETHERNET] = sizeof(struct ovs_key_ethernet),
303 [OVS_KEY_ATTR_VLAN] = sizeof(__be16),
304 [OVS_KEY_ATTR_ETHERTYPE] = sizeof(__be16),
305 [OVS_KEY_ATTR_IPV4] = sizeof(struct ovs_key_ipv4),
306 [OVS_KEY_ATTR_IPV6] = sizeof(struct ovs_key_ipv6),
307 [OVS_KEY_ATTR_TCP] = sizeof(struct ovs_key_tcp),
308 [OVS_KEY_ATTR_TCP_FLAGS] = sizeof(__be16),
309 [OVS_KEY_ATTR_UDP] = sizeof(struct ovs_key_udp),
310 [OVS_KEY_ATTR_SCTP] = sizeof(struct ovs_key_sctp),
311 [OVS_KEY_ATTR_ICMP] = sizeof(struct ovs_key_icmp),
312 [OVS_KEY_ATTR_ICMPV6] = sizeof(struct ovs_key_icmpv6),
313 [OVS_KEY_ATTR_ARP] = sizeof(struct ovs_key_arp),
314 [OVS_KEY_ATTR_ND] = sizeof(struct ovs_key_nd),
315 [OVS_KEY_ATTR_DP_HASH] = sizeof(u32),
316 [OVS_KEY_ATTR_RECIRC_ID] = sizeof(u32),
317 [OVS_KEY_ATTR_TUNNEL] = -1,
318 [OVS_KEY_ATTR_MPLS] = sizeof(struct ovs_key_mpls),
321 static bool is_all_zero(const u8 *fp, size_t size)
328 for (i = 0; i < size; i++)
335 static int __parse_flow_nlattrs(const struct nlattr *attr,
336 const struct nlattr *a[],
337 u64 *attrsp, bool log, bool nz)
339 const struct nlattr *nla;
344 nla_for_each_nested(nla, attr, rem) {
345 u16 type = nla_type(nla);
348 if (type > OVS_KEY_ATTR_MAX) {
350 "Unknown key attribute (type=%d, max=%d).",
351 type, OVS_KEY_ATTR_MAX);
355 if (attrs & (1ULL << type)) {
356 OVS_NLERR(log, "Duplicate key attribute (type %d).",
361 expected_len = ovs_key_lens[type];
362 if (nla_len(nla) != expected_len && expected_len != -1) {
363 OVS_NLERR(log, "Key attribute has unexpected length "
364 "(type=%d, length=%d, expected=%d).", type,
365 nla_len(nla), expected_len);
369 if (!nz || !is_all_zero(nla_data(nla), expected_len)) {
370 attrs |= 1ULL << type;
375 OVS_NLERR(log, "Message has %d unknown bytes.", rem);
383 static int parse_flow_mask_nlattrs(const struct nlattr *attr,
384 const struct nlattr *a[], u64 *attrsp,
387 return __parse_flow_nlattrs(attr, a, attrsp, log, true);
390 static int parse_flow_nlattrs(const struct nlattr *attr,
391 const struct nlattr *a[], u64 *attrsp,
394 return __parse_flow_nlattrs(attr, a, attrsp, log, false);
397 static int ipv4_tun_from_nlattr(const struct nlattr *attr,
398 struct sw_flow_match *match, bool is_mask,
404 __be16 tun_flags = 0;
406 nla_for_each_nested(a, attr, rem) {
407 int type = nla_type(a);
408 static const u32 ovs_tunnel_key_lens[OVS_TUNNEL_KEY_ATTR_MAX + 1] = {
409 [OVS_TUNNEL_KEY_ATTR_ID] = sizeof(u64),
410 [OVS_TUNNEL_KEY_ATTR_IPV4_SRC] = sizeof(u32),
411 [OVS_TUNNEL_KEY_ATTR_IPV4_DST] = sizeof(u32),
412 [OVS_TUNNEL_KEY_ATTR_TOS] = 1,
413 [OVS_TUNNEL_KEY_ATTR_TTL] = 1,
414 [OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT] = 0,
415 [OVS_TUNNEL_KEY_ATTR_CSUM] = 0,
416 [OVS_TUNNEL_KEY_ATTR_TP_SRC] = sizeof(u16),
417 [OVS_TUNNEL_KEY_ATTR_TP_DST] = sizeof(u16),
418 [OVS_TUNNEL_KEY_ATTR_OAM] = 0,
419 [OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS] = -1,
422 if (type > OVS_TUNNEL_KEY_ATTR_MAX) {
424 "Unknown tunnel attribute (type=%d, max=%d).",
425 type, OVS_TUNNEL_KEY_ATTR_MAX);
429 if (ovs_tunnel_key_lens[type] != nla_len(a) &&
430 ovs_tunnel_key_lens[type] != -1) {
432 "Tunnel attribute has unexpected length "
433 "(type=%d, length=%d, expected=%d).",
435 ovs_tunnel_key_lens[type]);
440 case OVS_TUNNEL_KEY_ATTR_ID:
441 SW_FLOW_KEY_PUT(match, tun_key.tun_id,
442 nla_get_be64(a), is_mask);
443 tun_flags |= TUNNEL_KEY;
445 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
446 SW_FLOW_KEY_PUT(match, tun_key.ipv4_src,
447 nla_get_be32(a), is_mask);
449 case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
450 SW_FLOW_KEY_PUT(match, tun_key.ipv4_dst,
451 nla_get_be32(a), is_mask);
453 case OVS_TUNNEL_KEY_ATTR_TOS:
454 SW_FLOW_KEY_PUT(match, tun_key.ipv4_tos,
455 nla_get_u8(a), is_mask);
457 case OVS_TUNNEL_KEY_ATTR_TTL:
458 SW_FLOW_KEY_PUT(match, tun_key.ipv4_ttl,
459 nla_get_u8(a), is_mask);
462 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
463 tun_flags |= TUNNEL_DONT_FRAGMENT;
465 case OVS_TUNNEL_KEY_ATTR_CSUM:
466 tun_flags |= TUNNEL_CSUM;
468 case OVS_TUNNEL_KEY_ATTR_TP_SRC:
469 SW_FLOW_KEY_PUT(match, tun_key.tp_src,
470 nla_get_be16(a), is_mask);
472 case OVS_TUNNEL_KEY_ATTR_TP_DST:
473 SW_FLOW_KEY_PUT(match, tun_key.tp_dst,
474 nla_get_be16(a), is_mask);
476 case OVS_TUNNEL_KEY_ATTR_OAM:
477 tun_flags |= TUNNEL_OAM;
479 case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS:
480 tun_flags |= TUNNEL_OPTIONS_PRESENT;
481 if (nla_len(a) > sizeof(match->key->tun_opts)) {
482 OVS_NLERR(log, "Geneve option too long "
483 "(len %d, max %zu).",
485 sizeof(match->key->tun_opts));
489 if (nla_len(a) % 4 != 0) {
490 OVS_NLERR(log, "Geneve option length is not "
491 "a multiple of 4 (len %d).",
496 /* We need to record the length of the options passed
497 * down, otherwise packets with the same format but
498 * additional options will be silently matched.
501 SW_FLOW_KEY_PUT(match, tun_opts_len, nla_len(a),
504 /* This is somewhat unusual because it looks at
505 * both the key and mask while parsing the
506 * attributes (and by extension assumes the key
507 * is parsed first). Normally, we would verify
508 * that each is the correct length and that the
509 * attributes line up in the validate function.
510 * However, that is difficult because this is
511 * variable length and we won't have the
514 if (match->key->tun_opts_len != nla_len(a)) {
516 "Geneve option key length (%d)"
517 " is different from mask length (%d).",
518 match->key->tun_opts_len,
523 SW_FLOW_KEY_PUT(match, tun_opts_len, 0xff,
527 SW_FLOW_KEY_MEMCPY_OFFSET(match,
528 (unsigned long)GENEVE_OPTS((struct sw_flow_key *)0,
530 nla_data(a), nla_len(a), is_mask);
533 OVS_NLERR(log, "Unknown IPv4 tunnel attribute (%d).",
539 SW_FLOW_KEY_PUT(match, tun_key.tun_flags, tun_flags, is_mask);
542 OVS_NLERR(log, "IPv4 tunnel attribute has %d unknown bytes.",
548 if (!match->key->tun_key.ipv4_dst) {
550 "IPv4 tunnel destination address is zero.");
555 OVS_NLERR(log, "IPv4 tunnel TTL not specified.");
563 static int __ipv4_tun_to_nlattr(struct sk_buff *skb,
564 const struct ovs_key_ipv4_tunnel *output,
565 const struct geneve_opt *tun_opts,
566 int swkey_tun_opts_len)
568 if (output->tun_flags & TUNNEL_KEY &&
569 nla_put_be64(skb, OVS_TUNNEL_KEY_ATTR_ID, output->tun_id))
571 if (output->ipv4_src &&
572 nla_put_be32(skb, OVS_TUNNEL_KEY_ATTR_IPV4_SRC, output->ipv4_src))
574 if (output->ipv4_dst &&
575 nla_put_be32(skb, OVS_TUNNEL_KEY_ATTR_IPV4_DST, output->ipv4_dst))
577 if (output->ipv4_tos &&
578 nla_put_u8(skb, OVS_TUNNEL_KEY_ATTR_TOS, output->ipv4_tos))
580 if (nla_put_u8(skb, OVS_TUNNEL_KEY_ATTR_TTL, output->ipv4_ttl))
582 if ((output->tun_flags & TUNNEL_DONT_FRAGMENT) &&
583 nla_put_flag(skb, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT))
585 if ((output->tun_flags & TUNNEL_CSUM) &&
586 nla_put_flag(skb, OVS_TUNNEL_KEY_ATTR_CSUM))
588 if (output->tp_src &&
589 nla_put_be16(skb, OVS_TUNNEL_KEY_ATTR_TP_SRC, output->tp_src))
591 if (output->tp_dst &&
592 nla_put_be16(skb, OVS_TUNNEL_KEY_ATTR_TP_DST, output->tp_dst))
594 if ((output->tun_flags & TUNNEL_OAM) &&
595 nla_put_flag(skb, OVS_TUNNEL_KEY_ATTR_OAM))
598 nla_put(skb, OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS,
599 swkey_tun_opts_len, tun_opts))
606 static int ipv4_tun_to_nlattr(struct sk_buff *skb,
607 const struct ovs_key_ipv4_tunnel *output,
608 const struct geneve_opt *tun_opts,
609 int swkey_tun_opts_len)
614 nla = nla_nest_start(skb, OVS_KEY_ATTR_TUNNEL);
618 err = __ipv4_tun_to_nlattr(skb, output, tun_opts, swkey_tun_opts_len);
622 nla_nest_end(skb, nla);
626 int ovs_nla_put_egress_tunnel_key(struct sk_buff *skb,
627 const struct ovs_tunnel_info *egress_tun_info)
629 return __ipv4_tun_to_nlattr(skb, &egress_tun_info->tunnel,
630 egress_tun_info->options,
631 egress_tun_info->options_len);
634 static int metadata_from_nlattrs(struct sw_flow_match *match, u64 *attrs,
635 const struct nlattr **a, bool is_mask,
638 if (*attrs & (1ULL << OVS_KEY_ATTR_DP_HASH)) {
639 u32 hash_val = nla_get_u32(a[OVS_KEY_ATTR_DP_HASH]);
641 SW_FLOW_KEY_PUT(match, ovs_flow_hash, hash_val, is_mask);
642 *attrs &= ~(1ULL << OVS_KEY_ATTR_DP_HASH);
645 if (*attrs & (1ULL << OVS_KEY_ATTR_RECIRC_ID)) {
646 u32 recirc_id = nla_get_u32(a[OVS_KEY_ATTR_RECIRC_ID]);
648 SW_FLOW_KEY_PUT(match, recirc_id, recirc_id, is_mask);
649 *attrs &= ~(1ULL << OVS_KEY_ATTR_RECIRC_ID);
652 if (*attrs & (1ULL << OVS_KEY_ATTR_PRIORITY)) {
653 SW_FLOW_KEY_PUT(match, phy.priority,
654 nla_get_u32(a[OVS_KEY_ATTR_PRIORITY]), is_mask);
655 *attrs &= ~(1ULL << OVS_KEY_ATTR_PRIORITY);
658 if (*attrs & (1ULL << OVS_KEY_ATTR_IN_PORT)) {
659 u32 in_port = nla_get_u32(a[OVS_KEY_ATTR_IN_PORT]);
662 in_port = 0xffffffff; /* Always exact match in_port. */
663 } else if (in_port >= DP_MAX_PORTS) {
665 "Input port (%d) exceeds maximum allowable (%d).",
666 in_port, DP_MAX_PORTS);
670 SW_FLOW_KEY_PUT(match, phy.in_port, in_port, is_mask);
671 *attrs &= ~(1ULL << OVS_KEY_ATTR_IN_PORT);
672 } else if (!is_mask) {
673 SW_FLOW_KEY_PUT(match, phy.in_port, DP_MAX_PORTS, is_mask);
676 if (*attrs & (1ULL << OVS_KEY_ATTR_SKB_MARK)) {
677 uint32_t mark = nla_get_u32(a[OVS_KEY_ATTR_SKB_MARK]);
679 SW_FLOW_KEY_PUT(match, phy.skb_mark, mark, is_mask);
680 *attrs &= ~(1ULL << OVS_KEY_ATTR_SKB_MARK);
682 if (*attrs & (1ULL << OVS_KEY_ATTR_TUNNEL)) {
683 if (ipv4_tun_from_nlattr(a[OVS_KEY_ATTR_TUNNEL], match,
686 *attrs &= ~(1ULL << OVS_KEY_ATTR_TUNNEL);
691 static int ovs_key_from_nlattrs(struct sw_flow_match *match, u64 attrs,
692 const struct nlattr **a, bool is_mask,
697 err = metadata_from_nlattrs(match, &attrs, a, is_mask, log);
701 if (attrs & (1ULL << OVS_KEY_ATTR_ETHERNET)) {
702 const struct ovs_key_ethernet *eth_key;
704 eth_key = nla_data(a[OVS_KEY_ATTR_ETHERNET]);
705 SW_FLOW_KEY_MEMCPY(match, eth.src,
706 eth_key->eth_src, ETH_ALEN, is_mask);
707 SW_FLOW_KEY_MEMCPY(match, eth.dst,
708 eth_key->eth_dst, ETH_ALEN, is_mask);
709 attrs &= ~(1ULL << OVS_KEY_ATTR_ETHERNET);
712 if (attrs & (1ULL << OVS_KEY_ATTR_VLAN)) {
715 tci = nla_get_be16(a[OVS_KEY_ATTR_VLAN]);
716 if (!(tci & htons(VLAN_TAG_PRESENT))) {
719 "VLAN TCI mask does not have exact match for VLAN_TAG_PRESENT bit.");
722 "VLAN TCI does not have VLAN_TAG_PRESENT bit set.");
727 SW_FLOW_KEY_PUT(match, eth.tci, tci, is_mask);
728 attrs &= ~(1ULL << OVS_KEY_ATTR_VLAN);
731 if (attrs & (1ULL << OVS_KEY_ATTR_ETHERTYPE)) {
734 eth_type = nla_get_be16(a[OVS_KEY_ATTR_ETHERTYPE]);
736 /* Always exact match EtherType. */
737 eth_type = htons(0xffff);
738 } else if (ntohs(eth_type) < ETH_P_802_3_MIN) {
740 "EtherType is less than minimum (type=%x, min=%x).",
741 ntohs(eth_type), ETH_P_802_3_MIN);
745 SW_FLOW_KEY_PUT(match, eth.type, eth_type, is_mask);
746 attrs &= ~(1ULL << OVS_KEY_ATTR_ETHERTYPE);
747 } else if (!is_mask) {
748 SW_FLOW_KEY_PUT(match, eth.type, htons(ETH_P_802_2), is_mask);
751 if (attrs & (1ULL << OVS_KEY_ATTR_IPV4)) {
752 const struct ovs_key_ipv4 *ipv4_key;
754 ipv4_key = nla_data(a[OVS_KEY_ATTR_IPV4]);
755 if (!is_mask && ipv4_key->ipv4_frag > OVS_FRAG_TYPE_MAX) {
757 "Unknown IPv4 fragment type (value=%d, max=%d).",
758 ipv4_key->ipv4_frag, OVS_FRAG_TYPE_MAX);
761 SW_FLOW_KEY_PUT(match, ip.proto,
762 ipv4_key->ipv4_proto, is_mask);
763 SW_FLOW_KEY_PUT(match, ip.tos,
764 ipv4_key->ipv4_tos, is_mask);
765 SW_FLOW_KEY_PUT(match, ip.ttl,
766 ipv4_key->ipv4_ttl, is_mask);
767 SW_FLOW_KEY_PUT(match, ip.frag,
768 ipv4_key->ipv4_frag, is_mask);
769 SW_FLOW_KEY_PUT(match, ipv4.addr.src,
770 ipv4_key->ipv4_src, is_mask);
771 SW_FLOW_KEY_PUT(match, ipv4.addr.dst,
772 ipv4_key->ipv4_dst, is_mask);
773 attrs &= ~(1ULL << OVS_KEY_ATTR_IPV4);
776 if (attrs & (1ULL << OVS_KEY_ATTR_IPV6)) {
777 const struct ovs_key_ipv6 *ipv6_key;
779 ipv6_key = nla_data(a[OVS_KEY_ATTR_IPV6]);
780 if (!is_mask && ipv6_key->ipv6_frag > OVS_FRAG_TYPE_MAX) {
782 "Unknown IPv6 fragment type (value=%d, max=%d).",
783 ipv6_key->ipv6_frag, OVS_FRAG_TYPE_MAX);
786 if (ipv6_key->ipv6_label & htonl(0xFFF00000)) {
788 "Invalid IPv6 flow label value (value=%x, max=%x).",
789 ntohl(ipv6_key->ipv6_label), (1 << 20) - 1);
792 SW_FLOW_KEY_PUT(match, ipv6.label,
793 ipv6_key->ipv6_label, is_mask);
794 SW_FLOW_KEY_PUT(match, ip.proto,
795 ipv6_key->ipv6_proto, is_mask);
796 SW_FLOW_KEY_PUT(match, ip.tos,
797 ipv6_key->ipv6_tclass, is_mask);
798 SW_FLOW_KEY_PUT(match, ip.ttl,
799 ipv6_key->ipv6_hlimit, is_mask);
800 SW_FLOW_KEY_PUT(match, ip.frag,
801 ipv6_key->ipv6_frag, is_mask);
802 SW_FLOW_KEY_MEMCPY(match, ipv6.addr.src,
804 sizeof(match->key->ipv6.addr.src),
806 SW_FLOW_KEY_MEMCPY(match, ipv6.addr.dst,
808 sizeof(match->key->ipv6.addr.dst),
811 attrs &= ~(1ULL << OVS_KEY_ATTR_IPV6);
814 if (attrs & (1ULL << OVS_KEY_ATTR_ARP)) {
815 const struct ovs_key_arp *arp_key;
817 arp_key = nla_data(a[OVS_KEY_ATTR_ARP]);
818 if (!is_mask && (arp_key->arp_op & htons(0xff00))) {
819 OVS_NLERR(log, "Unknown ARP opcode (opcode=%d).",
824 SW_FLOW_KEY_PUT(match, ipv4.addr.src,
825 arp_key->arp_sip, is_mask);
826 SW_FLOW_KEY_PUT(match, ipv4.addr.dst,
827 arp_key->arp_tip, is_mask);
828 SW_FLOW_KEY_PUT(match, ip.proto,
829 ntohs(arp_key->arp_op), is_mask);
830 SW_FLOW_KEY_MEMCPY(match, ipv4.arp.sha,
831 arp_key->arp_sha, ETH_ALEN, is_mask);
832 SW_FLOW_KEY_MEMCPY(match, ipv4.arp.tha,
833 arp_key->arp_tha, ETH_ALEN, is_mask);
835 attrs &= ~(1ULL << OVS_KEY_ATTR_ARP);
838 if (attrs & (1ULL << OVS_KEY_ATTR_MPLS)) {
839 const struct ovs_key_mpls *mpls_key;
841 mpls_key = nla_data(a[OVS_KEY_ATTR_MPLS]);
842 SW_FLOW_KEY_PUT(match, mpls.top_lse,
843 mpls_key->mpls_lse, is_mask);
845 attrs &= ~(1ULL << OVS_KEY_ATTR_MPLS);
848 if (attrs & (1ULL << OVS_KEY_ATTR_TCP)) {
849 const struct ovs_key_tcp *tcp_key;
851 tcp_key = nla_data(a[OVS_KEY_ATTR_TCP]);
852 SW_FLOW_KEY_PUT(match, tp.src, tcp_key->tcp_src, is_mask);
853 SW_FLOW_KEY_PUT(match, tp.dst, tcp_key->tcp_dst, is_mask);
854 attrs &= ~(1ULL << OVS_KEY_ATTR_TCP);
857 if (attrs & (1ULL << OVS_KEY_ATTR_TCP_FLAGS)) {
858 SW_FLOW_KEY_PUT(match, tp.flags,
859 nla_get_be16(a[OVS_KEY_ATTR_TCP_FLAGS]),
861 attrs &= ~(1ULL << OVS_KEY_ATTR_TCP_FLAGS);
864 if (attrs & (1ULL << OVS_KEY_ATTR_UDP)) {
865 const struct ovs_key_udp *udp_key;
867 udp_key = nla_data(a[OVS_KEY_ATTR_UDP]);
868 SW_FLOW_KEY_PUT(match, tp.src, udp_key->udp_src, is_mask);
869 SW_FLOW_KEY_PUT(match, tp.dst, udp_key->udp_dst, is_mask);
870 attrs &= ~(1ULL << OVS_KEY_ATTR_UDP);
873 if (attrs & (1ULL << OVS_KEY_ATTR_SCTP)) {
874 const struct ovs_key_sctp *sctp_key;
876 sctp_key = nla_data(a[OVS_KEY_ATTR_SCTP]);
877 SW_FLOW_KEY_PUT(match, tp.src, sctp_key->sctp_src, is_mask);
878 SW_FLOW_KEY_PUT(match, tp.dst, sctp_key->sctp_dst, is_mask);
879 attrs &= ~(1ULL << OVS_KEY_ATTR_SCTP);
882 if (attrs & (1ULL << OVS_KEY_ATTR_ICMP)) {
883 const struct ovs_key_icmp *icmp_key;
885 icmp_key = nla_data(a[OVS_KEY_ATTR_ICMP]);
886 SW_FLOW_KEY_PUT(match, tp.src,
887 htons(icmp_key->icmp_type), is_mask);
888 SW_FLOW_KEY_PUT(match, tp.dst,
889 htons(icmp_key->icmp_code), is_mask);
890 attrs &= ~(1ULL << OVS_KEY_ATTR_ICMP);
893 if (attrs & (1ULL << OVS_KEY_ATTR_ICMPV6)) {
894 const struct ovs_key_icmpv6 *icmpv6_key;
896 icmpv6_key = nla_data(a[OVS_KEY_ATTR_ICMPV6]);
897 SW_FLOW_KEY_PUT(match, tp.src,
898 htons(icmpv6_key->icmpv6_type), is_mask);
899 SW_FLOW_KEY_PUT(match, tp.dst,
900 htons(icmpv6_key->icmpv6_code), is_mask);
901 attrs &= ~(1ULL << OVS_KEY_ATTR_ICMPV6);
904 if (attrs & (1ULL << OVS_KEY_ATTR_ND)) {
905 const struct ovs_key_nd *nd_key;
907 nd_key = nla_data(a[OVS_KEY_ATTR_ND]);
908 SW_FLOW_KEY_MEMCPY(match, ipv6.nd.target,
910 sizeof(match->key->ipv6.nd.target),
912 SW_FLOW_KEY_MEMCPY(match, ipv6.nd.sll,
913 nd_key->nd_sll, ETH_ALEN, is_mask);
914 SW_FLOW_KEY_MEMCPY(match, ipv6.nd.tll,
915 nd_key->nd_tll, ETH_ALEN, is_mask);
916 attrs &= ~(1ULL << OVS_KEY_ATTR_ND);
920 OVS_NLERR(log, "Unknown key attributes (%llx).",
921 (unsigned long long)attrs);
928 static void nlattr_set(struct nlattr *attr, u8 val, bool is_attr_mask_key)
933 /* The nlattr stream should already have been validated */
934 nla_for_each_nested(nla, attr, rem) {
935 /* We assume that ovs_key_lens[type] == -1 means that type is a
938 if (is_attr_mask_key && ovs_key_lens[nla_type(nla)] == -1)
939 nlattr_set(nla, val, false);
941 memset(nla_data(nla), val, nla_len(nla));
945 static void mask_set_nlattr(struct nlattr *attr, u8 val)
947 nlattr_set(attr, val, true);
951 * ovs_nla_get_match - parses Netlink attributes into a flow key and
952 * mask. In case the 'mask' is NULL, the flow is treated as exact match
953 * flow. Otherwise, it is treated as a wildcarded flow, except the mask
954 * does not include any don't care bit.
955 * @match: receives the extracted flow match information.
956 * @key: Netlink attribute holding nested %OVS_KEY_ATTR_* Netlink attribute
957 * sequence. The fields should of the packet that triggered the creation
959 * @mask: Optional. Netlink attribute holding nested %OVS_KEY_ATTR_* Netlink
960 * attribute specifies the mask field of the wildcarded flow.
961 * @log: Boolean to allow kernel error logging. Normally true, but when
962 * probing for feature compatibility this should be passed in as false to
963 * suppress unnecessary error logging.
965 int ovs_nla_get_match(struct sw_flow_match *match,
966 const struct nlattr *nla_key,
967 const struct nlattr *nla_mask,
970 const struct nlattr *a[OVS_KEY_ATTR_MAX + 1];
971 const struct nlattr *encap;
972 struct nlattr *newmask = NULL;
975 bool encap_valid = false;
978 err = parse_flow_nlattrs(nla_key, a, &key_attrs, log);
982 if ((key_attrs & (1ULL << OVS_KEY_ATTR_ETHERNET)) &&
983 (key_attrs & (1ULL << OVS_KEY_ATTR_ETHERTYPE)) &&
984 (nla_get_be16(a[OVS_KEY_ATTR_ETHERTYPE]) == htons(ETH_P_8021Q))) {
987 if (!((key_attrs & (1ULL << OVS_KEY_ATTR_VLAN)) &&
988 (key_attrs & (1ULL << OVS_KEY_ATTR_ENCAP)))) {
989 OVS_NLERR(log, "Invalid Vlan frame.");
993 key_attrs &= ~(1ULL << OVS_KEY_ATTR_ETHERTYPE);
994 tci = nla_get_be16(a[OVS_KEY_ATTR_VLAN]);
995 encap = a[OVS_KEY_ATTR_ENCAP];
996 key_attrs &= ~(1ULL << OVS_KEY_ATTR_ENCAP);
999 if (tci & htons(VLAN_TAG_PRESENT)) {
1000 err = parse_flow_nlattrs(encap, a, &key_attrs, log);
1004 /* Corner case for truncated 802.1Q header. */
1005 if (nla_len(encap)) {
1007 "Truncated 802.1Q header has non-zero encap attribute.");
1012 "Encap attribute is set for a non-VLAN frame.");
1017 err = ovs_key_from_nlattrs(match, key_attrs, a, false, log);
1024 /* Create an exact match mask. We need to set to 0xff
1025 * all the 'match->mask' fields that have been touched
1026 * in 'match->key'. We cannot simply memset
1027 * 'match->mask', because padding bytes and fields not
1028 * specified in 'match->key' should be left to 0.
1029 * Instead, we use a stream of netlink attributes,
1030 * copied from 'key' and set to 0xff: ovs_key_from_nlattrs()
1031 * will take care of filling 'match->mask'
1034 newmask = kmemdup(nla_key,
1035 nla_total_size(nla_len(nla_key)),
1040 mask_set_nlattr(newmask, 0xff);
1042 /* The userspace does not send tunnel attributes that
1043 * are 0, but we should not wildcard them nonetheless.
1045 if (match->key->tun_key.ipv4_dst)
1046 SW_FLOW_KEY_MEMSET_FIELD(match, tun_key,
1052 err = parse_flow_mask_nlattrs(nla_mask, a, &mask_attrs, log);
1056 /* Always match on tci. */
1057 SW_FLOW_KEY_PUT(match, eth.tci, htons(0xffff), true);
1059 if (mask_attrs & 1ULL << OVS_KEY_ATTR_ENCAP) {
1060 __be16 eth_type = 0;
1065 "Encap mask attribute is set for non-VLAN frame.");
1070 mask_attrs &= ~(1ULL << OVS_KEY_ATTR_ENCAP);
1071 if (a[OVS_KEY_ATTR_ETHERTYPE])
1072 eth_type = nla_get_be16(a[OVS_KEY_ATTR_ETHERTYPE]);
1074 if (eth_type == htons(0xffff)) {
1075 mask_attrs &= ~(1ULL << OVS_KEY_ATTR_ETHERTYPE);
1076 encap = a[OVS_KEY_ATTR_ENCAP];
1077 err = parse_flow_mask_nlattrs(encap, a,
1083 "VLAN frames must have an exact match on the TPID (mask=%x).",
1089 if (a[OVS_KEY_ATTR_VLAN])
1090 tci = nla_get_be16(a[OVS_KEY_ATTR_VLAN]);
1092 if (!(tci & htons(VLAN_TAG_PRESENT))) {
1094 "VLAN tag present bit must have an exact match (tci_mask=%x).",
1101 err = ovs_key_from_nlattrs(match, mask_attrs, a, true, log);
1106 if (!match_validate(match, key_attrs, mask_attrs, log))
1115 * ovs_nla_get_flow_metadata - parses Netlink attributes into a flow key.
1116 * @key: Receives extracted in_port, priority, tun_key and skb_mark.
1117 * @attr: Netlink attribute holding nested %OVS_KEY_ATTR_* Netlink attribute
1119 * @log: Boolean to allow kernel error logging. Normally true, but when
1120 * probing for feature compatibility this should be passed in as false to
1121 * suppress unnecessary error logging.
1123 * This parses a series of Netlink attributes that form a flow key, which must
1124 * take the same form accepted by flow_from_nlattrs(), but only enough of it to
1125 * get the metadata, that is, the parts of the flow key that cannot be
1126 * extracted from the packet itself.
1128 int ovs_nla_get_flow_metadata(const struct nlattr *attr,
1129 struct sw_flow_key *key,
1132 const struct nlattr *a[OVS_KEY_ATTR_MAX + 1];
1133 struct sw_flow_match match;
1137 err = parse_flow_nlattrs(attr, a, &attrs, log);
1141 memset(&match, 0, sizeof(match));
1144 memset(key, 0, OVS_SW_FLOW_KEY_METADATA_SIZE);
1145 key->phy.in_port = DP_MAX_PORTS;
1147 return metadata_from_nlattrs(&match, &attrs, a, false, log);
1150 int ovs_nla_put_flow(const struct sw_flow_key *swkey,
1151 const struct sw_flow_key *output, struct sk_buff *skb)
1153 struct ovs_key_ethernet *eth_key;
1154 struct nlattr *nla, *encap;
1155 bool is_mask = (swkey != output);
1157 if (nla_put_u32(skb, OVS_KEY_ATTR_DP_HASH, output->ovs_flow_hash))
1158 goto nla_put_failure;
1160 if (nla_put_u32(skb, OVS_KEY_ATTR_RECIRC_ID, output->recirc_id))
1161 goto nla_put_failure;
1163 if (nla_put_u32(skb, OVS_KEY_ATTR_PRIORITY, output->phy.priority))
1164 goto nla_put_failure;
1166 if ((swkey->tun_key.ipv4_dst || is_mask)) {
1167 const struct geneve_opt *opts = NULL;
1169 if (output->tun_key.tun_flags & TUNNEL_OPTIONS_PRESENT)
1170 opts = GENEVE_OPTS(output, swkey->tun_opts_len);
1172 if (ipv4_tun_to_nlattr(skb, &output->tun_key, opts,
1173 swkey->tun_opts_len))
1174 goto nla_put_failure;
1177 if (swkey->phy.in_port == DP_MAX_PORTS) {
1178 if (is_mask && (output->phy.in_port == 0xffff))
1179 if (nla_put_u32(skb, OVS_KEY_ATTR_IN_PORT, 0xffffffff))
1180 goto nla_put_failure;
1183 upper_u16 = !is_mask ? 0 : 0xffff;
1185 if (nla_put_u32(skb, OVS_KEY_ATTR_IN_PORT,
1186 (upper_u16 << 16) | output->phy.in_port))
1187 goto nla_put_failure;
1190 if (nla_put_u32(skb, OVS_KEY_ATTR_SKB_MARK, output->phy.skb_mark))
1191 goto nla_put_failure;
1193 nla = nla_reserve(skb, OVS_KEY_ATTR_ETHERNET, sizeof(*eth_key));
1195 goto nla_put_failure;
1197 eth_key = nla_data(nla);
1198 ether_addr_copy(eth_key->eth_src, output->eth.src);
1199 ether_addr_copy(eth_key->eth_dst, output->eth.dst);
1201 if (swkey->eth.tci || swkey->eth.type == htons(ETH_P_8021Q)) {
1203 eth_type = !is_mask ? htons(ETH_P_8021Q) : htons(0xffff);
1204 if (nla_put_be16(skb, OVS_KEY_ATTR_ETHERTYPE, eth_type) ||
1205 nla_put_be16(skb, OVS_KEY_ATTR_VLAN, output->eth.tci))
1206 goto nla_put_failure;
1207 encap = nla_nest_start(skb, OVS_KEY_ATTR_ENCAP);
1208 if (!swkey->eth.tci)
1213 if (swkey->eth.type == htons(ETH_P_802_2)) {
1215 * Ethertype 802.2 is represented in the netlink with omitted
1216 * OVS_KEY_ATTR_ETHERTYPE in the flow key attribute, and
1217 * 0xffff in the mask attribute. Ethertype can also
1220 if (is_mask && output->eth.type)
1221 if (nla_put_be16(skb, OVS_KEY_ATTR_ETHERTYPE,
1223 goto nla_put_failure;
1227 if (nla_put_be16(skb, OVS_KEY_ATTR_ETHERTYPE, output->eth.type))
1228 goto nla_put_failure;
1230 if (swkey->eth.type == htons(ETH_P_IP)) {
1231 struct ovs_key_ipv4 *ipv4_key;
1233 nla = nla_reserve(skb, OVS_KEY_ATTR_IPV4, sizeof(*ipv4_key));
1235 goto nla_put_failure;
1236 ipv4_key = nla_data(nla);
1237 ipv4_key->ipv4_src = output->ipv4.addr.src;
1238 ipv4_key->ipv4_dst = output->ipv4.addr.dst;
1239 ipv4_key->ipv4_proto = output->ip.proto;
1240 ipv4_key->ipv4_tos = output->ip.tos;
1241 ipv4_key->ipv4_ttl = output->ip.ttl;
1242 ipv4_key->ipv4_frag = output->ip.frag;
1243 } else if (swkey->eth.type == htons(ETH_P_IPV6)) {
1244 struct ovs_key_ipv6 *ipv6_key;
1246 nla = nla_reserve(skb, OVS_KEY_ATTR_IPV6, sizeof(*ipv6_key));
1248 goto nla_put_failure;
1249 ipv6_key = nla_data(nla);
1250 memcpy(ipv6_key->ipv6_src, &output->ipv6.addr.src,
1251 sizeof(ipv6_key->ipv6_src));
1252 memcpy(ipv6_key->ipv6_dst, &output->ipv6.addr.dst,
1253 sizeof(ipv6_key->ipv6_dst));
1254 ipv6_key->ipv6_label = output->ipv6.label;
1255 ipv6_key->ipv6_proto = output->ip.proto;
1256 ipv6_key->ipv6_tclass = output->ip.tos;
1257 ipv6_key->ipv6_hlimit = output->ip.ttl;
1258 ipv6_key->ipv6_frag = output->ip.frag;
1259 } else if (swkey->eth.type == htons(ETH_P_ARP) ||
1260 swkey->eth.type == htons(ETH_P_RARP)) {
1261 struct ovs_key_arp *arp_key;
1263 nla = nla_reserve(skb, OVS_KEY_ATTR_ARP, sizeof(*arp_key));
1265 goto nla_put_failure;
1266 arp_key = nla_data(nla);
1267 memset(arp_key, 0, sizeof(struct ovs_key_arp));
1268 arp_key->arp_sip = output->ipv4.addr.src;
1269 arp_key->arp_tip = output->ipv4.addr.dst;
1270 arp_key->arp_op = htons(output->ip.proto);
1271 ether_addr_copy(arp_key->arp_sha, output->ipv4.arp.sha);
1272 ether_addr_copy(arp_key->arp_tha, output->ipv4.arp.tha);
1273 } else if (eth_p_mpls(swkey->eth.type)) {
1274 struct ovs_key_mpls *mpls_key;
1276 nla = nla_reserve(skb, OVS_KEY_ATTR_MPLS, sizeof(*mpls_key));
1278 goto nla_put_failure;
1279 mpls_key = nla_data(nla);
1280 mpls_key->mpls_lse = output->mpls.top_lse;
1283 if ((swkey->eth.type == htons(ETH_P_IP) ||
1284 swkey->eth.type == htons(ETH_P_IPV6)) &&
1285 swkey->ip.frag != OVS_FRAG_TYPE_LATER) {
1287 if (swkey->ip.proto == IPPROTO_TCP) {
1288 struct ovs_key_tcp *tcp_key;
1290 nla = nla_reserve(skb, OVS_KEY_ATTR_TCP, sizeof(*tcp_key));
1292 goto nla_put_failure;
1293 tcp_key = nla_data(nla);
1294 tcp_key->tcp_src = output->tp.src;
1295 tcp_key->tcp_dst = output->tp.dst;
1296 if (nla_put_be16(skb, OVS_KEY_ATTR_TCP_FLAGS,
1298 goto nla_put_failure;
1299 } else if (swkey->ip.proto == IPPROTO_UDP) {
1300 struct ovs_key_udp *udp_key;
1302 nla = nla_reserve(skb, OVS_KEY_ATTR_UDP, sizeof(*udp_key));
1304 goto nla_put_failure;
1305 udp_key = nla_data(nla);
1306 udp_key->udp_src = output->tp.src;
1307 udp_key->udp_dst = output->tp.dst;
1308 } else if (swkey->ip.proto == IPPROTO_SCTP) {
1309 struct ovs_key_sctp *sctp_key;
1311 nla = nla_reserve(skb, OVS_KEY_ATTR_SCTP, sizeof(*sctp_key));
1313 goto nla_put_failure;
1314 sctp_key = nla_data(nla);
1315 sctp_key->sctp_src = output->tp.src;
1316 sctp_key->sctp_dst = output->tp.dst;
1317 } else if (swkey->eth.type == htons(ETH_P_IP) &&
1318 swkey->ip.proto == IPPROTO_ICMP) {
1319 struct ovs_key_icmp *icmp_key;
1321 nla = nla_reserve(skb, OVS_KEY_ATTR_ICMP, sizeof(*icmp_key));
1323 goto nla_put_failure;
1324 icmp_key = nla_data(nla);
1325 icmp_key->icmp_type = ntohs(output->tp.src);
1326 icmp_key->icmp_code = ntohs(output->tp.dst);
1327 } else if (swkey->eth.type == htons(ETH_P_IPV6) &&
1328 swkey->ip.proto == IPPROTO_ICMPV6) {
1329 struct ovs_key_icmpv6 *icmpv6_key;
1331 nla = nla_reserve(skb, OVS_KEY_ATTR_ICMPV6,
1332 sizeof(*icmpv6_key));
1334 goto nla_put_failure;
1335 icmpv6_key = nla_data(nla);
1336 icmpv6_key->icmpv6_type = ntohs(output->tp.src);
1337 icmpv6_key->icmpv6_code = ntohs(output->tp.dst);
1339 if (icmpv6_key->icmpv6_type == NDISC_NEIGHBOUR_SOLICITATION ||
1340 icmpv6_key->icmpv6_type == NDISC_NEIGHBOUR_ADVERTISEMENT) {
1341 struct ovs_key_nd *nd_key;
1343 nla = nla_reserve(skb, OVS_KEY_ATTR_ND, sizeof(*nd_key));
1345 goto nla_put_failure;
1346 nd_key = nla_data(nla);
1347 memcpy(nd_key->nd_target, &output->ipv6.nd.target,
1348 sizeof(nd_key->nd_target));
1349 ether_addr_copy(nd_key->nd_sll, output->ipv6.nd.sll);
1350 ether_addr_copy(nd_key->nd_tll, output->ipv6.nd.tll);
1357 nla_nest_end(skb, encap);
1365 #define MAX_ACTIONS_BUFSIZE (32 * 1024)
1367 static struct sw_flow_actions *nla_alloc_flow_actions(int size, bool log)
1369 struct sw_flow_actions *sfa;
1371 if (size > MAX_ACTIONS_BUFSIZE) {
1372 OVS_NLERR(log, "Flow action size (%u bytes) exceeds maximum "
1373 "(%u bytes)", size, MAX_ACTIONS_BUFSIZE);
1374 return ERR_PTR(-EINVAL);
1377 sfa = kmalloc(sizeof(*sfa) + size, GFP_KERNEL);
1379 return ERR_PTR(-ENOMEM);
1381 sfa->actions_len = 0;
1385 /* RCU callback used by ovs_nla_free_flow_actions. */
1386 static void rcu_free_acts_callback(struct rcu_head *rcu)
1388 struct sw_flow_actions *sf_acts = container_of(rcu,
1389 struct sw_flow_actions, rcu);
1393 /* Schedules 'sf_acts' to be freed after the next RCU grace period.
1394 * The caller must hold rcu_read_lock for this to be sensible.
1396 void ovs_nla_free_flow_actions(struct sw_flow_actions *sf_acts)
1398 call_rcu(&sf_acts->rcu, rcu_free_acts_callback);
1401 static struct nlattr *reserve_sfa_size(struct sw_flow_actions **sfa,
1402 int attr_len, bool log)
1405 struct sw_flow_actions *acts;
1407 int req_size = NLA_ALIGN(attr_len);
1408 int next_offset = offsetof(struct sw_flow_actions, actions) +
1409 (*sfa)->actions_len;
1411 if (req_size <= (ksize(*sfa) - next_offset))
1414 new_acts_size = ksize(*sfa) * 2;
1416 if (new_acts_size > MAX_ACTIONS_BUFSIZE) {
1417 if ((MAX_ACTIONS_BUFSIZE - next_offset) < req_size)
1418 return ERR_PTR(-EMSGSIZE);
1419 new_acts_size = MAX_ACTIONS_BUFSIZE;
1422 acts = nla_alloc_flow_actions(new_acts_size, log);
1424 return (void *)acts;
1426 memcpy(acts->actions, (*sfa)->actions, (*sfa)->actions_len);
1427 acts->actions_len = (*sfa)->actions_len;
1432 (*sfa)->actions_len += req_size;
1433 return (struct nlattr *) ((unsigned char *)(*sfa) + next_offset);
1436 static struct nlattr *__add_action(struct sw_flow_actions **sfa, int attrtype,
1437 void *data, int len, bool log)
1441 a = reserve_sfa_size(sfa, nla_attr_size(len), log);
1445 a->nla_type = attrtype;
1446 a->nla_len = nla_attr_size(len);
1449 memcpy(nla_data(a), data, len);
1450 memset((unsigned char *) a + a->nla_len, 0, nla_padlen(len));
1455 static int add_action(struct sw_flow_actions **sfa, int attrtype,
1456 void *data, int len, bool log)
1460 a = __add_action(sfa, attrtype, data, len, log);
1467 static inline int add_nested_action_start(struct sw_flow_actions **sfa,
1468 int attrtype, bool log)
1470 int used = (*sfa)->actions_len;
1473 err = add_action(sfa, attrtype, NULL, 0, log);
1480 static inline void add_nested_action_end(struct sw_flow_actions *sfa,
1483 struct nlattr *a = (struct nlattr *) ((unsigned char *)sfa->actions +
1486 a->nla_len = sfa->actions_len - st_offset;
1489 static int __ovs_nla_copy_actions(const struct nlattr *attr,
1490 const struct sw_flow_key *key,
1491 int depth, struct sw_flow_actions **sfa,
1492 __be16 eth_type, __be16 vlan_tci, bool log);
1494 static int validate_and_copy_sample(const struct nlattr *attr,
1495 const struct sw_flow_key *key, int depth,
1496 struct sw_flow_actions **sfa,
1497 __be16 eth_type, __be16 vlan_tci, bool log)
1499 const struct nlattr *attrs[OVS_SAMPLE_ATTR_MAX + 1];
1500 const struct nlattr *probability, *actions;
1501 const struct nlattr *a;
1502 int rem, start, err, st_acts;
1504 memset(attrs, 0, sizeof(attrs));
1505 nla_for_each_nested(a, attr, rem) {
1506 int type = nla_type(a);
1507 if (!type || type > OVS_SAMPLE_ATTR_MAX || attrs[type])
1514 probability = attrs[OVS_SAMPLE_ATTR_PROBABILITY];
1515 if (!probability || nla_len(probability) != sizeof(u32))
1518 actions = attrs[OVS_SAMPLE_ATTR_ACTIONS];
1519 if (!actions || (nla_len(actions) && nla_len(actions) < NLA_HDRLEN))
1522 /* validation done, copy sample action. */
1523 start = add_nested_action_start(sfa, OVS_ACTION_ATTR_SAMPLE, log);
1526 err = add_action(sfa, OVS_SAMPLE_ATTR_PROBABILITY,
1527 nla_data(probability), sizeof(u32), log);
1530 st_acts = add_nested_action_start(sfa, OVS_SAMPLE_ATTR_ACTIONS, log);
1534 err = __ovs_nla_copy_actions(actions, key, depth + 1, sfa,
1535 eth_type, vlan_tci, log);
1539 add_nested_action_end(*sfa, st_acts);
1540 add_nested_action_end(*sfa, start);
1545 static int validate_tp_port(const struct sw_flow_key *flow_key,
1548 if ((eth_type == htons(ETH_P_IP) || eth_type == htons(ETH_P_IPV6)) &&
1549 (flow_key->tp.src || flow_key->tp.dst))
1555 void ovs_match_init(struct sw_flow_match *match,
1556 struct sw_flow_key *key,
1557 struct sw_flow_mask *mask)
1559 memset(match, 0, sizeof(*match));
1563 memset(key, 0, sizeof(*key));
1566 memset(&mask->key, 0, sizeof(mask->key));
1567 mask->range.start = mask->range.end = 0;
1571 static int validate_and_copy_set_tun(const struct nlattr *attr,
1572 struct sw_flow_actions **sfa, bool log)
1574 struct sw_flow_match match;
1575 struct sw_flow_key key;
1576 struct ovs_tunnel_info *tun_info;
1580 ovs_match_init(&match, &key, NULL);
1581 err = ipv4_tun_from_nlattr(nla_data(attr), &match, false, log);
1585 if (key.tun_opts_len) {
1586 struct geneve_opt *option = GENEVE_OPTS(&key,
1588 int opts_len = key.tun_opts_len;
1589 bool crit_opt = false;
1591 while (opts_len > 0) {
1594 if (opts_len < sizeof(*option))
1597 len = sizeof(*option) + option->length * 4;
1601 crit_opt |= !!(option->type & GENEVE_CRIT_OPT_TYPE);
1603 option = (struct geneve_opt *)((u8 *)option + len);
1607 key.tun_key.tun_flags |= crit_opt ? TUNNEL_CRIT_OPT : 0;
1610 start = add_nested_action_start(sfa, OVS_ACTION_ATTR_SET, log);
1614 a = __add_action(sfa, OVS_KEY_ATTR_TUNNEL_INFO, NULL,
1615 sizeof(*tun_info) + key.tun_opts_len, log);
1619 tun_info = nla_data(a);
1620 tun_info->tunnel = key.tun_key;
1621 tun_info->options_len = key.tun_opts_len;
1623 if (tun_info->options_len) {
1624 /* We need to store the options in the action itself since
1625 * everything else will go away after flow setup. We can append
1626 * it to tun_info and then point there.
1628 memcpy((tun_info + 1), GENEVE_OPTS(&key, key.tun_opts_len),
1630 tun_info->options = (struct geneve_opt *)(tun_info + 1);
1632 tun_info->options = NULL;
1635 add_nested_action_end(*sfa, start);
1640 static int validate_set(const struct nlattr *a,
1641 const struct sw_flow_key *flow_key,
1642 struct sw_flow_actions **sfa,
1643 bool *set_tun, __be16 eth_type, bool log)
1645 const struct nlattr *ovs_key = nla_data(a);
1646 int key_type = nla_type(ovs_key);
1648 /* There can be only one key in a action */
1649 if (nla_total_size(nla_len(ovs_key)) != nla_len(a))
1652 if (key_type > OVS_KEY_ATTR_MAX ||
1653 (ovs_key_lens[key_type] != nla_len(ovs_key) &&
1654 ovs_key_lens[key_type] != -1))
1658 const struct ovs_key_ipv4 *ipv4_key;
1659 const struct ovs_key_ipv6 *ipv6_key;
1662 case OVS_KEY_ATTR_PRIORITY:
1663 case OVS_KEY_ATTR_SKB_MARK:
1664 case OVS_KEY_ATTR_ETHERNET:
1667 case OVS_KEY_ATTR_TUNNEL:
1669 err = validate_and_copy_set_tun(a, sfa, log);
1674 case OVS_KEY_ATTR_IPV4:
1675 if (eth_type != htons(ETH_P_IP))
1678 if (!flow_key->ip.proto)
1681 ipv4_key = nla_data(ovs_key);
1682 if (ipv4_key->ipv4_proto != flow_key->ip.proto)
1685 if (ipv4_key->ipv4_frag != flow_key->ip.frag)
1690 case OVS_KEY_ATTR_IPV6:
1691 if (eth_type != htons(ETH_P_IPV6))
1694 if (!flow_key->ip.proto)
1697 ipv6_key = nla_data(ovs_key);
1698 if (ipv6_key->ipv6_proto != flow_key->ip.proto)
1701 if (ipv6_key->ipv6_frag != flow_key->ip.frag)
1704 if (ntohl(ipv6_key->ipv6_label) & 0xFFF00000)
1709 case OVS_KEY_ATTR_TCP:
1710 if (flow_key->ip.proto != IPPROTO_TCP)
1713 return validate_tp_port(flow_key, eth_type);
1715 case OVS_KEY_ATTR_UDP:
1716 if (flow_key->ip.proto != IPPROTO_UDP)
1719 return validate_tp_port(flow_key, eth_type);
1721 case OVS_KEY_ATTR_MPLS:
1722 if (!eth_p_mpls(eth_type))
1726 case OVS_KEY_ATTR_SCTP:
1727 if (flow_key->ip.proto != IPPROTO_SCTP)
1730 return validate_tp_port(flow_key, eth_type);
1739 static int validate_userspace(const struct nlattr *attr)
1741 static const struct nla_policy userspace_policy[OVS_USERSPACE_ATTR_MAX + 1] = {
1742 [OVS_USERSPACE_ATTR_PID] = {.type = NLA_U32 },
1743 [OVS_USERSPACE_ATTR_USERDATA] = {.type = NLA_UNSPEC },
1744 [OVS_USERSPACE_ATTR_EGRESS_TUN_PORT] = {.type = NLA_U32 },
1746 struct nlattr *a[OVS_USERSPACE_ATTR_MAX + 1];
1749 error = nla_parse_nested(a, OVS_USERSPACE_ATTR_MAX,
1750 attr, userspace_policy);
1754 if (!a[OVS_USERSPACE_ATTR_PID] ||
1755 !nla_get_u32(a[OVS_USERSPACE_ATTR_PID]))
1761 static int copy_action(const struct nlattr *from,
1762 struct sw_flow_actions **sfa, bool log)
1764 int totlen = NLA_ALIGN(from->nla_len);
1767 to = reserve_sfa_size(sfa, from->nla_len, log);
1771 memcpy(to, from, totlen);
1775 static int __ovs_nla_copy_actions(const struct nlattr *attr,
1776 const struct sw_flow_key *key,
1777 int depth, struct sw_flow_actions **sfa,
1778 __be16 eth_type, __be16 vlan_tci, bool log)
1780 const struct nlattr *a;
1783 if (depth >= SAMPLE_ACTION_DEPTH)
1786 nla_for_each_nested(a, attr, rem) {
1787 /* Expected argument lengths, (u32)-1 for variable length. */
1788 static const u32 action_lens[OVS_ACTION_ATTR_MAX + 1] = {
1789 [OVS_ACTION_ATTR_OUTPUT] = sizeof(u32),
1790 [OVS_ACTION_ATTR_RECIRC] = sizeof(u32),
1791 [OVS_ACTION_ATTR_USERSPACE] = (u32)-1,
1792 [OVS_ACTION_ATTR_PUSH_MPLS] = sizeof(struct ovs_action_push_mpls),
1793 [OVS_ACTION_ATTR_POP_MPLS] = sizeof(__be16),
1794 [OVS_ACTION_ATTR_PUSH_VLAN] = sizeof(struct ovs_action_push_vlan),
1795 [OVS_ACTION_ATTR_POP_VLAN] = 0,
1796 [OVS_ACTION_ATTR_SET] = (u32)-1,
1797 [OVS_ACTION_ATTR_SAMPLE] = (u32)-1,
1798 [OVS_ACTION_ATTR_HASH] = sizeof(struct ovs_action_hash)
1800 const struct ovs_action_push_vlan *vlan;
1801 int type = nla_type(a);
1804 if (type > OVS_ACTION_ATTR_MAX ||
1805 (action_lens[type] != nla_len(a) &&
1806 action_lens[type] != (u32)-1))
1811 case OVS_ACTION_ATTR_UNSPEC:
1814 case OVS_ACTION_ATTR_USERSPACE:
1815 err = validate_userspace(a);
1820 case OVS_ACTION_ATTR_OUTPUT:
1821 if (nla_get_u32(a) >= DP_MAX_PORTS)
1825 case OVS_ACTION_ATTR_HASH: {
1826 const struct ovs_action_hash *act_hash = nla_data(a);
1828 switch (act_hash->hash_alg) {
1829 case OVS_HASH_ALG_L4:
1838 case OVS_ACTION_ATTR_POP_VLAN:
1839 vlan_tci = htons(0);
1842 case OVS_ACTION_ATTR_PUSH_VLAN:
1844 if (vlan->vlan_tpid != htons(ETH_P_8021Q))
1846 if (!(vlan->vlan_tci & htons(VLAN_TAG_PRESENT)))
1848 vlan_tci = vlan->vlan_tci;
1851 case OVS_ACTION_ATTR_RECIRC:
1854 case OVS_ACTION_ATTR_PUSH_MPLS: {
1855 const struct ovs_action_push_mpls *mpls = nla_data(a);
1857 if (!eth_p_mpls(mpls->mpls_ethertype))
1859 /* Prohibit push MPLS other than to a white list
1860 * for packets that have a known tag order.
1862 if (vlan_tci & htons(VLAN_TAG_PRESENT) ||
1863 (eth_type != htons(ETH_P_IP) &&
1864 eth_type != htons(ETH_P_IPV6) &&
1865 eth_type != htons(ETH_P_ARP) &&
1866 eth_type != htons(ETH_P_RARP) &&
1867 !eth_p_mpls(eth_type)))
1869 eth_type = mpls->mpls_ethertype;
1873 case OVS_ACTION_ATTR_POP_MPLS:
1874 if (vlan_tci & htons(VLAN_TAG_PRESENT) ||
1875 !eth_p_mpls(eth_type))
1878 /* Disallow subsequent L2.5+ set and mpls_pop actions
1879 * as there is no check here to ensure that the new
1880 * eth_type is valid and thus set actions could
1881 * write off the end of the packet or otherwise
1884 * Support for these actions is planned using packet
1887 eth_type = htons(0);
1890 case OVS_ACTION_ATTR_SET:
1891 err = validate_set(a, key, sfa, &skip_copy, eth_type,
1897 case OVS_ACTION_ATTR_SAMPLE:
1898 err = validate_and_copy_sample(a, key, depth, sfa,
1899 eth_type, vlan_tci, log);
1909 err = copy_action(a, sfa, log);
1921 int ovs_nla_copy_actions(const struct nlattr *attr,
1922 const struct sw_flow_key *key,
1923 struct sw_flow_actions **sfa, bool log)
1927 *sfa = nla_alloc_flow_actions(nla_len(attr), log);
1929 return PTR_ERR(*sfa);
1931 err = __ovs_nla_copy_actions(attr, key, 0, sfa, key->eth.type,
1939 static int sample_action_to_attr(const struct nlattr *attr, struct sk_buff *skb)
1941 const struct nlattr *a;
1942 struct nlattr *start;
1945 start = nla_nest_start(skb, OVS_ACTION_ATTR_SAMPLE);
1949 nla_for_each_nested(a, attr, rem) {
1950 int type = nla_type(a);
1951 struct nlattr *st_sample;
1954 case OVS_SAMPLE_ATTR_PROBABILITY:
1955 if (nla_put(skb, OVS_SAMPLE_ATTR_PROBABILITY,
1956 sizeof(u32), nla_data(a)))
1959 case OVS_SAMPLE_ATTR_ACTIONS:
1960 st_sample = nla_nest_start(skb, OVS_SAMPLE_ATTR_ACTIONS);
1963 err = ovs_nla_put_actions(nla_data(a), nla_len(a), skb);
1966 nla_nest_end(skb, st_sample);
1971 nla_nest_end(skb, start);
1975 static int set_action_to_attr(const struct nlattr *a, struct sk_buff *skb)
1977 const struct nlattr *ovs_key = nla_data(a);
1978 int key_type = nla_type(ovs_key);
1979 struct nlattr *start;
1983 case OVS_KEY_ATTR_TUNNEL_INFO: {
1984 struct ovs_tunnel_info *tun_info = nla_data(ovs_key);
1986 start = nla_nest_start(skb, OVS_ACTION_ATTR_SET);
1990 err = ipv4_tun_to_nlattr(skb, &tun_info->tunnel,
1991 tun_info->options_len ?
1992 tun_info->options : NULL,
1993 tun_info->options_len);
1996 nla_nest_end(skb, start);
2000 if (nla_put(skb, OVS_ACTION_ATTR_SET, nla_len(a), ovs_key))
2008 int ovs_nla_put_actions(const struct nlattr *attr, int len, struct sk_buff *skb)
2010 const struct nlattr *a;
2013 nla_for_each_attr(a, attr, len, rem) {
2014 int type = nla_type(a);
2017 case OVS_ACTION_ATTR_SET:
2018 err = set_action_to_attr(a, skb);
2023 case OVS_ACTION_ATTR_SAMPLE:
2024 err = sample_action_to_attr(a, skb);
2029 if (nla_put(skb, type, nla_len(a), nla_data(a)))