xref: /linux/drivers/net/vrf.c (revision 075196489a3797c2a931de68c438e06f8303dd5c)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * vrf.c: device driver to encapsulate a VRF space
4  *
5  * Copyright (c) 2015 Cumulus Networks. All rights reserved.
6  * Copyright (c) 2015 Shrijeet Mukherjee <shm@cumulusnetworks.com>
7  * Copyright (c) 2015 David Ahern <dsa@cumulusnetworks.com>
8  *
9  * Based on dummy, team and ipvlan drivers
10  */
11 
12 #include <linux/ethtool.h>
13 #include <linux/module.h>
14 #include <linux/kernel.h>
15 #include <linux/netdevice.h>
16 #include <linux/etherdevice.h>
17 #include <linux/ip.h>
18 #include <linux/init.h>
19 #include <linux/moduleparam.h>
20 #include <linux/netfilter.h>
21 #include <linux/rtnetlink.h>
22 #include <net/rtnetlink.h>
23 #include <linux/u64_stats_sync.h>
24 #include <linux/hashtable.h>
25 #include <linux/spinlock_types.h>
26 
27 #include <linux/inetdevice.h>
28 #include <net/arp.h>
29 #include <net/flow.h>
30 #include <net/ip.h>
31 #include <net/ip_fib.h>
32 #include <net/ip6_fib.h>
33 #include <net/ip6_route.h>
34 #include <net/route.h>
35 #include <net/addrconf.h>
36 #include <net/l3mdev.h>
37 #include <net/fib_rules.h>
38 #include <net/netdev_lock.h>
39 #include <net/sch_generic.h>
40 #include <net/netns/generic.h>
41 #include <net/netfilter/nf_conntrack.h>
42 
43 #define DRV_NAME	"vrf"
44 #define DRV_VERSION	"1.1"
45 
46 #define FIB_RULE_PREF  1000       /* default preference for FIB rules */
47 
48 #define HT_MAP_BITS	4
49 #define HASH_INITVAL	((u32)0xcafef00d)
50 
51 struct  vrf_map {
52 	DECLARE_HASHTABLE(ht, HT_MAP_BITS);
53 	spinlock_t vmap_lock;
54 
55 	/* shared_tables:
56 	 * count how many distinct tables do not comply with the strict mode
57 	 * requirement.
58 	 * shared_tables value must be 0 in order to enable the strict mode.
59 	 *
60 	 * example of the evolution of shared_tables:
61 	 *                                                        | time
62 	 * add  vrf0 --> table 100        shared_tables = 0       | t0
63 	 * add  vrf1 --> table 101        shared_tables = 0       | t1
64 	 * add  vrf2 --> table 100        shared_tables = 1       | t2
65 	 * add  vrf3 --> table 100        shared_tables = 1       | t3
66 	 * add  vrf4 --> table 101        shared_tables = 2       v t4
67 	 *
68 	 * shared_tables is a "step function" (or "staircase function")
69 	 * and it is increased by one when the second vrf is associated to a
70 	 * table.
71 	 *
72 	 * at t2, vrf0 and vrf2 are bound to table 100: shared_tables = 1.
73 	 *
74 	 * at t3, another dev (vrf3) is bound to the same table 100 but the
75 	 * value of shared_tables is still 1.
76 	 * This means that no matter how many new vrfs will register on the
77 	 * table 100, the shared_tables will not increase (considering only
78 	 * table 100).
79 	 *
80 	 * at t4, vrf4 is bound to table 101, and shared_tables = 2.
81 	 *
82 	 * Looking at the value of shared_tables we can immediately know if
83 	 * the strict_mode can or cannot be enforced. Indeed, strict_mode
84 	 * can be enforced iff shared_tables = 0.
85 	 *
86 	 * Conversely, shared_tables is decreased when a vrf is de-associated
87 	 * from a table with exactly two associated vrfs.
88 	 */
89 	u32 shared_tables;
90 
91 	bool strict_mode;
92 };
93 
94 struct vrf_map_elem {
95 	struct hlist_node hnode;
96 	struct list_head vrf_list;  /* VRFs registered to this table */
97 
98 	u32 table_id;
99 	int users;
100 	int ifindex;
101 };
102 
103 static unsigned int vrf_net_id;
104 
105 /* per netns vrf data */
106 struct netns_vrf {
107 	/* protected by rtnl lock */
108 	bool add_fib_rules;
109 
110 	struct vrf_map vmap;
111 	struct ctl_table_header	*ctl_hdr;
112 };
113 
114 struct net_vrf {
115 	struct rtable		*rth;
116 	struct rt6_info		*rt6;
117 #if IS_ENABLED(CONFIG_IPV6)
118 	struct fib6_table	*fib6_table;
119 #endif
120 	u32                     tb_id;
121 
122 	struct list_head	me_list;   /* entry in vrf_map_elem */
123 	int			ifindex;
124 };
125 
126 static void vrf_tx_error(struct net_device *vrf_dev, struct sk_buff *skb)
127 {
128 	vrf_dev->stats.tx_errors++;
129 	kfree_skb(skb);
130 }
131 
132 static struct vrf_map *netns_vrf_map(struct net *net)
133 {
134 	struct netns_vrf *nn_vrf = net_generic(net, vrf_net_id);
135 
136 	return &nn_vrf->vmap;
137 }
138 
139 static struct vrf_map *netns_vrf_map_by_dev(struct net_device *dev)
140 {
141 	return netns_vrf_map(dev_net(dev));
142 }
143 
144 static int vrf_map_elem_get_vrf_ifindex(struct vrf_map_elem *me)
145 {
146 	struct list_head *me_head = &me->vrf_list;
147 	struct net_vrf *vrf;
148 
149 	if (list_empty(me_head))
150 		return -ENODEV;
151 
152 	vrf = list_first_entry(me_head, struct net_vrf, me_list);
153 
154 	return vrf->ifindex;
155 }
156 
157 static struct vrf_map_elem *vrf_map_elem_alloc(gfp_t flags)
158 {
159 	struct vrf_map_elem *me;
160 
161 	me = kmalloc_obj(*me, flags);
162 	if (!me)
163 		return NULL;
164 
165 	return me;
166 }
167 
168 static void vrf_map_elem_free(struct vrf_map_elem *me)
169 {
170 	kfree(me);
171 }
172 
173 static void vrf_map_elem_init(struct vrf_map_elem *me, int table_id,
174 			      int ifindex, int users)
175 {
176 	me->table_id = table_id;
177 	me->ifindex = ifindex;
178 	me->users = users;
179 	INIT_LIST_HEAD(&me->vrf_list);
180 }
181 
182 static struct vrf_map_elem *vrf_map_lookup_elem(struct vrf_map *vmap,
183 						u32 table_id)
184 {
185 	struct vrf_map_elem *me;
186 	u32 key;
187 
188 	key = jhash_1word(table_id, HASH_INITVAL);
189 	hash_for_each_possible(vmap->ht, me, hnode, key) {
190 		if (me->table_id == table_id)
191 			return me;
192 	}
193 
194 	return NULL;
195 }
196 
197 static void vrf_map_add_elem(struct vrf_map *vmap, struct vrf_map_elem *me)
198 {
199 	u32 table_id = me->table_id;
200 	u32 key;
201 
202 	key = jhash_1word(table_id, HASH_INITVAL);
203 	hash_add(vmap->ht, &me->hnode, key);
204 }
205 
206 static void vrf_map_del_elem(struct vrf_map_elem *me)
207 {
208 	hash_del(&me->hnode);
209 }
210 
211 static void vrf_map_lock(struct vrf_map *vmap) __acquires(&vmap->vmap_lock)
212 {
213 	spin_lock(&vmap->vmap_lock);
214 }
215 
216 static void vrf_map_unlock(struct vrf_map *vmap) __releases(&vmap->vmap_lock)
217 {
218 	spin_unlock(&vmap->vmap_lock);
219 }
220 
221 /* called with rtnl lock held */
222 static int
223 vrf_map_register_dev(struct net_device *dev, struct netlink_ext_ack *extack)
224 {
225 	struct vrf_map *vmap = netns_vrf_map_by_dev(dev);
226 	struct net_vrf *vrf = netdev_priv(dev);
227 	struct vrf_map_elem *new_me, *me;
228 	u32 table_id = vrf->tb_id;
229 	bool free_new_me = false;
230 	int users;
231 	int res;
232 
233 	/* we pre-allocate elements used in the spin-locked section (so that we
234 	 * keep the spinlock as short as possible).
235 	 */
236 	new_me = vrf_map_elem_alloc(GFP_KERNEL);
237 	if (!new_me)
238 		return -ENOMEM;
239 
240 	vrf_map_elem_init(new_me, table_id, dev->ifindex, 0);
241 
242 	vrf_map_lock(vmap);
243 
244 	me = vrf_map_lookup_elem(vmap, table_id);
245 	if (!me) {
246 		me = new_me;
247 		vrf_map_add_elem(vmap, me);
248 		goto link_vrf;
249 	}
250 
251 	/* we already have an entry in the vrf_map, so it means there is (at
252 	 * least) a vrf registered on the specific table.
253 	 */
254 	free_new_me = true;
255 	if (vmap->strict_mode) {
256 		/* vrfs cannot share the same table */
257 		NL_SET_ERR_MSG(extack, "Table is used by another VRF");
258 		res = -EBUSY;
259 		goto unlock;
260 	}
261 
262 link_vrf:
263 	users = ++me->users;
264 	if (users == 2)
265 		++vmap->shared_tables;
266 
267 	list_add(&vrf->me_list, &me->vrf_list);
268 
269 	res = 0;
270 
271 unlock:
272 	vrf_map_unlock(vmap);
273 
274 	/* clean-up, if needed */
275 	if (free_new_me)
276 		vrf_map_elem_free(new_me);
277 
278 	return res;
279 }
280 
281 /* called with rtnl lock held */
282 static void vrf_map_unregister_dev(struct net_device *dev)
283 {
284 	struct vrf_map *vmap = netns_vrf_map_by_dev(dev);
285 	struct net_vrf *vrf = netdev_priv(dev);
286 	u32 table_id = vrf->tb_id;
287 	struct vrf_map_elem *me;
288 	int users;
289 
290 	vrf_map_lock(vmap);
291 
292 	me = vrf_map_lookup_elem(vmap, table_id);
293 	if (!me)
294 		goto unlock;
295 
296 	list_del(&vrf->me_list);
297 
298 	users = --me->users;
299 	if (users == 1) {
300 		--vmap->shared_tables;
301 	} else if (users == 0) {
302 		vrf_map_del_elem(me);
303 
304 		/* no one will refer to this element anymore */
305 		vrf_map_elem_free(me);
306 	}
307 
308 unlock:
309 	vrf_map_unlock(vmap);
310 }
311 
312 /* return the vrf device index associated with the table_id */
313 static int vrf_ifindex_lookup_by_table_id(struct net *net, u32 table_id)
314 {
315 	struct vrf_map *vmap = netns_vrf_map(net);
316 	struct vrf_map_elem *me;
317 	int ifindex;
318 
319 	vrf_map_lock(vmap);
320 
321 	if (!vmap->strict_mode) {
322 		ifindex = -EPERM;
323 		goto unlock;
324 	}
325 
326 	me = vrf_map_lookup_elem(vmap, table_id);
327 	if (!me) {
328 		ifindex = -ENODEV;
329 		goto unlock;
330 	}
331 
332 	ifindex = vrf_map_elem_get_vrf_ifindex(me);
333 
334 unlock:
335 	vrf_map_unlock(vmap);
336 
337 	return ifindex;
338 }
339 
340 /* by default VRF devices do not have a qdisc and are expected
341  * to be created with only a single queue.
342  */
343 static bool qdisc_tx_is_default(const struct net_device *dev)
344 {
345 	struct netdev_queue *txq;
346 
347 	if (dev->num_tx_queues > 1)
348 		return false;
349 
350 	txq = netdev_get_tx_queue(dev, 0);
351 
352 	return qdisc_txq_has_no_queue(txq);
353 }
354 
355 /* Local traffic destined to local address. Reinsert the packet to rx
356  * path, similar to loopback handling.
357  */
358 static int vrf_local_xmit(struct sk_buff *skb, struct net_device *dev,
359 			  struct dst_entry *dst)
360 {
361 	unsigned int len = skb->len;
362 
363 	skb_orphan(skb);
364 
365 	skb_dst_set(skb, dst);
366 
367 	/* set pkt_type to avoid skb hitting packet taps twice -
368 	 * once on Tx and again in Rx processing
369 	 */
370 	skb->pkt_type = PACKET_LOOPBACK;
371 
372 	skb->protocol = eth_type_trans(skb, dev);
373 
374 	if (likely(__netif_rx(skb) == NET_RX_SUCCESS))
375 		dev_dstats_rx_add(dev, len);
376 	else
377 		dev_dstats_rx_dropped(dev);
378 
379 	return NETDEV_TX_OK;
380 }
381 
382 static void vrf_nf_set_untracked(struct sk_buff *skb)
383 {
384 	if (skb_get_nfct(skb) == 0)
385 		nf_ct_set(skb, NULL, IP_CT_UNTRACKED);
386 }
387 
388 static void vrf_nf_reset_ct(struct sk_buff *skb)
389 {
390 	if (skb_get_nfct(skb) == IP_CT_UNTRACKED)
391 		nf_reset_ct(skb);
392 }
393 
394 #if IS_ENABLED(CONFIG_IPV6)
395 static int vrf_ip6_local_out(struct net *net, struct sock *sk,
396 			     struct sk_buff *skb)
397 {
398 	int err;
399 
400 	vrf_nf_reset_ct(skb);
401 
402 	err = nf_hook(NFPROTO_IPV6, NF_INET_LOCAL_OUT, net,
403 		      sk, skb, NULL, skb_dst(skb)->dev, dst_output);
404 
405 	if (likely(err == 1))
406 		err = dst_output(net, sk, skb);
407 
408 	return err;
409 }
410 
411 static netdev_tx_t vrf_process_v6_outbound(struct sk_buff *skb,
412 					   struct net_device *dev)
413 {
414 	const struct ipv6hdr *iph;
415 	struct net *net = dev_net(skb->dev);
416 	struct flowi6 fl6;
417 	int ret = NET_XMIT_DROP;
418 	struct dst_entry *dst;
419 	struct dst_entry *dst_null = &net->ipv6.ip6_null_entry->dst;
420 
421 	if (!pskb_may_pull(skb, ETH_HLEN + sizeof(struct ipv6hdr)))
422 		goto err;
423 
424 	iph = ipv6_hdr(skb);
425 
426 	memset(&fl6, 0, sizeof(fl6));
427 	/* needed to match OIF rule */
428 	fl6.flowi6_l3mdev = dev->ifindex;
429 	fl6.flowi6_iif = LOOPBACK_IFINDEX;
430 	fl6.daddr = iph->daddr;
431 	fl6.saddr = iph->saddr;
432 	fl6.flowlabel = ip6_flowinfo(iph);
433 	fl6.flowi6_mark = skb->mark;
434 	fl6.flowi6_proto = iph->nexthdr;
435 
436 	dst = ip6_dst_lookup_flow(net, NULL, &fl6, NULL);
437 	if (IS_ERR(dst) || dst == dst_null)
438 		goto err;
439 
440 	skb_dst_drop(skb);
441 
442 	/* if dst.dev is the VRF device again this is locally originated traffic
443 	 * destined to a local address. Short circuit to Rx path.
444 	 */
445 	if (dst->dev == dev)
446 		return vrf_local_xmit(skb, dev, dst);
447 
448 	skb_dst_set(skb, dst);
449 
450 	/* strip the ethernet header added for pass through VRF device */
451 	__skb_pull(skb, skb_network_offset(skb));
452 
453 	memset(IP6CB(skb), 0, sizeof(*IP6CB(skb)));
454 	ret = vrf_ip6_local_out(net, skb->sk, skb);
455 	if (unlikely(net_xmit_eval(ret)))
456 		dev->stats.tx_errors++;
457 	else
458 		ret = NET_XMIT_SUCCESS;
459 
460 	return ret;
461 err:
462 	vrf_tx_error(dev, skb);
463 	return NET_XMIT_DROP;
464 }
465 #else
466 static netdev_tx_t vrf_process_v6_outbound(struct sk_buff *skb,
467 					   struct net_device *dev)
468 {
469 	vrf_tx_error(dev, skb);
470 	return NET_XMIT_DROP;
471 }
472 #endif
473 
474 /* based on ip_local_out; can't use it b/c the dst is switched pointing to us */
475 static int vrf_ip_local_out(struct net *net, struct sock *sk,
476 			    struct sk_buff *skb)
477 {
478 	int err;
479 
480 	vrf_nf_reset_ct(skb);
481 
482 	err = nf_hook(NFPROTO_IPV4, NF_INET_LOCAL_OUT, net, sk,
483 		      skb, NULL, skb_dst(skb)->dev, dst_output);
484 	if (likely(err == 1))
485 		err = dst_output(net, sk, skb);
486 
487 	return err;
488 }
489 
490 static netdev_tx_t vrf_process_v4_outbound(struct sk_buff *skb,
491 					   struct net_device *vrf_dev)
492 {
493 	struct iphdr *ip4h;
494 	int ret = NET_XMIT_DROP;
495 	struct flowi4 fl4;
496 	struct net *net = dev_net(vrf_dev);
497 	struct rtable *rt;
498 
499 	if (!pskb_may_pull(skb, ETH_HLEN + sizeof(struct iphdr)))
500 		goto err;
501 
502 	ip4h = ip_hdr(skb);
503 
504 	memset(&fl4, 0, sizeof(fl4));
505 	/* needed to match OIF rule */
506 	fl4.flowi4_l3mdev = vrf_dev->ifindex;
507 	fl4.flowi4_iif = LOOPBACK_IFINDEX;
508 	fl4.flowi4_dscp = ip4h_dscp(ip4h);
509 	fl4.flowi4_flags = FLOWI_FLAG_ANYSRC;
510 	fl4.flowi4_proto = ip4h->protocol;
511 	fl4.daddr = ip4h->daddr;
512 	fl4.saddr = ip4h->saddr;
513 
514 	rt = ip_route_output_flow(net, &fl4, NULL);
515 	if (IS_ERR(rt))
516 		goto err;
517 
518 	skb_dst_drop(skb);
519 
520 	/* if dst.dev is the VRF device again this is locally originated traffic
521 	 * destined to a local address. Short circuit to Rx path.
522 	 */
523 	if (rt->dst.dev == vrf_dev)
524 		return vrf_local_xmit(skb, vrf_dev, &rt->dst);
525 
526 	skb_dst_set(skb, &rt->dst);
527 
528 	/* strip the ethernet header added for pass through VRF device */
529 	__skb_pull(skb, skb_network_offset(skb));
530 
531 	if (!ip4h->saddr) {
532 		ip4h->saddr = inet_select_addr(skb_dst(skb)->dev, 0,
533 					       RT_SCOPE_LINK);
534 	}
535 
536 	memset(IPCB(skb), 0, sizeof(*IPCB(skb)));
537 	ret = vrf_ip_local_out(dev_net(skb_dst(skb)->dev), skb->sk, skb);
538 	if (unlikely(net_xmit_eval(ret)))
539 		vrf_dev->stats.tx_errors++;
540 	else
541 		ret = NET_XMIT_SUCCESS;
542 
543 out:
544 	return ret;
545 err:
546 	vrf_tx_error(vrf_dev, skb);
547 	goto out;
548 }
549 
550 static netdev_tx_t is_ip_tx_frame(struct sk_buff *skb, struct net_device *dev)
551 {
552 	switch (skb->protocol) {
553 	case htons(ETH_P_IP):
554 		return vrf_process_v4_outbound(skb, dev);
555 	case htons(ETH_P_IPV6):
556 		return vrf_process_v6_outbound(skb, dev);
557 	default:
558 		vrf_tx_error(dev, skb);
559 		return NET_XMIT_DROP;
560 	}
561 }
562 
563 static netdev_tx_t vrf_xmit(struct sk_buff *skb, struct net_device *dev)
564 {
565 	unsigned int len = skb->len;
566 	netdev_tx_t ret;
567 
568 	ret = is_ip_tx_frame(skb, dev);
569 	if (likely(ret == NET_XMIT_SUCCESS || ret == NET_XMIT_CN))
570 		dev_dstats_tx_add(dev, len);
571 	else
572 		dev_dstats_tx_dropped(dev);
573 
574 	return ret;
575 }
576 
577 static void vrf_finish_direct(struct sk_buff *skb)
578 {
579 	struct net_device *vrf_dev = skb->dev;
580 
581 	if (!list_empty(&vrf_dev->ptype_all) &&
582 	    likely(skb_headroom(skb) >= ETH_HLEN)) {
583 		struct ethhdr *eth = skb_push(skb, ETH_HLEN);
584 
585 		ether_addr_copy(eth->h_source, vrf_dev->dev_addr);
586 		eth_zero_addr(eth->h_dest);
587 		eth->h_proto = skb->protocol;
588 
589 		rcu_read_lock_bh();
590 		dev_queue_xmit_nit(skb, vrf_dev);
591 		rcu_read_unlock_bh();
592 
593 		skb_pull(skb, ETH_HLEN);
594 	}
595 
596 	vrf_nf_reset_ct(skb);
597 }
598 
599 #if IS_ENABLED(CONFIG_IPV6)
600 /* modelled after ip6_finish_output2 */
601 static int vrf_finish_output6(struct net *net, struct sock *sk,
602 			      struct sk_buff *skb)
603 {
604 	struct dst_entry *dst = skb_dst(skb);
605 	struct net_device *dev = dst->dev;
606 	const struct in6_addr *nexthop;
607 	struct neighbour *neigh;
608 	int ret;
609 
610 	vrf_nf_reset_ct(skb);
611 
612 	skb->protocol = htons(ETH_P_IPV6);
613 	skb->dev = dev;
614 
615 	rcu_read_lock();
616 	nexthop = rt6_nexthop(dst_rt6_info(dst), &ipv6_hdr(skb)->daddr);
617 	neigh = __ipv6_neigh_lookup_noref(dst->dev, nexthop);
618 	if (unlikely(!neigh))
619 		neigh = __neigh_create(&nd_tbl, nexthop, dst->dev, false);
620 	if (!IS_ERR(neigh)) {
621 		sock_confirm_neigh(skb, neigh);
622 		ret = neigh_output(neigh, skb, false);
623 		rcu_read_unlock();
624 		return ret;
625 	}
626 	rcu_read_unlock();
627 
628 	IP6_INC_STATS(dev_net(dst->dev),
629 		      ip6_dst_idev(dst), IPSTATS_MIB_OUTNOROUTES);
630 	kfree_skb(skb);
631 	return -EINVAL;
632 }
633 
634 /* modelled after ip6_output */
635 static int vrf_output6(struct net *net, struct sock *sk, struct sk_buff *skb)
636 {
637 	return NF_HOOK_COND(NFPROTO_IPV6, NF_INET_POST_ROUTING,
638 			    net, sk, skb, NULL, skb_dst(skb)->dev,
639 			    vrf_finish_output6,
640 			    !(IP6CB(skb)->flags & IP6SKB_REROUTED));
641 }
642 
643 /* set dst on skb to send packet to us via dev_xmit path. Allows
644  * packet to go through device based features such as qdisc, netfilter
645  * hooks and packet sockets with skb->dev set to vrf device.
646  */
647 static struct sk_buff *vrf_ip6_out_redirect(struct net_device *vrf_dev,
648 					    struct sk_buff *skb)
649 {
650 	struct net_vrf *vrf = netdev_priv(vrf_dev);
651 	struct rt6_info *rt6;
652 
653 	rt6 = vrf->rt6;
654 	dst_hold(&rt6->dst);
655 
656 	skb_dst_drop(skb);
657 	skb_dst_set(skb, &rt6->dst);
658 
659 	return skb;
660 }
661 
662 static int vrf_output6_direct_finish(struct net *net, struct sock *sk,
663 				     struct sk_buff *skb)
664 {
665 	vrf_finish_direct(skb);
666 
667 	return vrf_ip6_local_out(net, sk, skb);
668 }
669 
670 static int vrf_output6_direct(struct net *net, struct sock *sk,
671 			      struct sk_buff *skb)
672 {
673 	int err = 1;
674 
675 	skb->protocol = htons(ETH_P_IPV6);
676 
677 	if (!(IPCB(skb)->flags & IPSKB_REROUTED))
678 		err = nf_hook(NFPROTO_IPV6, NF_INET_POST_ROUTING, net, sk, skb,
679 			      NULL, skb->dev, vrf_output6_direct_finish);
680 
681 	if (likely(err == 1))
682 		vrf_finish_direct(skb);
683 
684 	return err;
685 }
686 
687 static int vrf_ip6_out_direct_finish(struct net *net, struct sock *sk,
688 				     struct sk_buff *skb)
689 {
690 	int err;
691 
692 	err = vrf_output6_direct(net, sk, skb);
693 	if (likely(err == 1))
694 		err = vrf_ip6_local_out(net, sk, skb);
695 
696 	return err;
697 }
698 
699 static struct sk_buff *vrf_ip6_out_direct(struct net_device *vrf_dev,
700 					  struct sock *sk,
701 					  struct sk_buff *skb)
702 {
703 	struct net *net = dev_net(vrf_dev);
704 	int err;
705 
706 	skb->dev = vrf_dev;
707 
708 	err = nf_hook(NFPROTO_IPV6, NF_INET_LOCAL_OUT, net, sk,
709 		      skb, NULL, vrf_dev, vrf_ip6_out_direct_finish);
710 
711 	if (likely(err == 1))
712 		err = vrf_output6_direct(net, sk, skb);
713 
714 	if (likely(err == 1))
715 		return skb;
716 
717 	return NULL;
718 }
719 
720 static struct sk_buff *vrf_ip6_out(struct net_device *vrf_dev,
721 				   struct sock *sk,
722 				   struct sk_buff *skb)
723 {
724 	/* don't divert link scope packets */
725 	if (rt6_need_strict(&ipv6_hdr(skb)->daddr))
726 		return skb;
727 
728 	vrf_nf_set_untracked(skb);
729 
730 	if (qdisc_tx_is_default(vrf_dev) ||
731 	    IP6CB(skb)->flags & IP6SKB_XFRM_TRANSFORMED)
732 		return vrf_ip6_out_direct(vrf_dev, sk, skb);
733 
734 	return vrf_ip6_out_redirect(vrf_dev, skb);
735 }
736 
737 /* holding rtnl */
738 static void vrf_rt6_release(struct net_device *dev, struct net_vrf *vrf)
739 {
740 	struct rt6_info *rt6 = vrf->rt6;
741 
742 	if (rt6) {
743 		dst_dev_put(&rt6->dst);
744 		dst_release(&rt6->dst);
745 	}
746 }
747 
748 static int vrf_rt6_create(struct net_device *dev)
749 {
750 	int flags = DST_NOPOLICY | DST_NOXFRM;
751 	struct net_vrf *vrf = netdev_priv(dev);
752 	struct net *net = dev_net(dev);
753 	struct rt6_info *rt6;
754 	int rc = -ENOMEM;
755 
756 	/* IPv6 can be CONFIG enabled and then disabled runtime */
757 	if (!ipv6_mod_enabled())
758 		return 0;
759 
760 	vrf->fib6_table = fib6_new_table(net, vrf->tb_id);
761 	if (!vrf->fib6_table)
762 		goto out;
763 
764 	/* create a dst for routing packets out a VRF device */
765 	rt6 = ip6_dst_alloc(net, dev, flags);
766 	if (!rt6)
767 		goto out;
768 
769 	rt6->dst.output	= vrf_output6;
770 
771 	vrf->rt6 = rt6;
772 
773 	rc = 0;
774 out:
775 	return rc;
776 }
777 #else
778 static struct sk_buff *vrf_ip6_out(struct net_device *vrf_dev,
779 				   struct sock *sk,
780 				   struct sk_buff *skb)
781 {
782 	return skb;
783 }
784 
785 static void vrf_rt6_release(struct net_device *dev, struct net_vrf *vrf)
786 {
787 }
788 
789 static int vrf_rt6_create(struct net_device *dev)
790 {
791 	return 0;
792 }
793 #endif
794 
795 /* modelled after ip_finish_output2 */
796 static int vrf_finish_output(struct net *net, struct sock *sk, struct sk_buff *skb)
797 {
798 	struct dst_entry *dst = skb_dst(skb);
799 	struct rtable *rt = dst_rtable(dst);
800 	struct net_device *dev = dst->dev;
801 	unsigned int hh_len = LL_RESERVED_SPACE(dev);
802 	struct neighbour *neigh;
803 	bool is_v6gw = false;
804 
805 	vrf_nf_reset_ct(skb);
806 
807 	/* Be paranoid, rather than too clever. */
808 	if (unlikely(skb_headroom(skb) < hh_len && dev->header_ops)) {
809 		skb = skb_expand_head(skb, hh_len);
810 		if (!skb) {
811 			dev->stats.tx_errors++;
812 			return -ENOMEM;
813 		}
814 	}
815 
816 	rcu_read_lock();
817 
818 	neigh = ip_neigh_for_gw(rt, skb, &is_v6gw);
819 	if (!IS_ERR(neigh)) {
820 		int ret;
821 
822 		sock_confirm_neigh(skb, neigh);
823 		/* if crossing protocols, can not use the cached header */
824 		ret = neigh_output(neigh, skb, is_v6gw);
825 		rcu_read_unlock();
826 		return ret;
827 	}
828 
829 	rcu_read_unlock();
830 	vrf_tx_error(skb->dev, skb);
831 	return -EINVAL;
832 }
833 
834 static int vrf_output(struct net *net, struct sock *sk, struct sk_buff *skb)
835 {
836 	struct net_device *dev = skb_dst(skb)->dev;
837 
838 	IP_UPD_PO_STATS(net, IPSTATS_MIB_OUT, skb->len);
839 
840 	skb->dev = dev;
841 	skb->protocol = htons(ETH_P_IP);
842 
843 	return NF_HOOK_COND(NFPROTO_IPV4, NF_INET_POST_ROUTING,
844 			    net, sk, skb, NULL, dev,
845 			    vrf_finish_output,
846 			    !(IPCB(skb)->flags & IPSKB_REROUTED));
847 }
848 
849 /* set dst on skb to send packet to us via dev_xmit path. Allows
850  * packet to go through device based features such as qdisc, netfilter
851  * hooks and packet sockets with skb->dev set to vrf device.
852  */
853 static struct sk_buff *vrf_ip_out_redirect(struct net_device *vrf_dev,
854 					   struct sk_buff *skb)
855 {
856 	struct net_vrf *vrf = netdev_priv(vrf_dev);
857 	struct rtable *rth;
858 
859 	rth = vrf->rth;
860 	dst_hold(&rth->dst);
861 
862 	skb_dst_drop(skb);
863 	skb_dst_set(skb, &rth->dst);
864 
865 	return skb;
866 }
867 
868 static int vrf_output_direct_finish(struct net *net, struct sock *sk,
869 				    struct sk_buff *skb)
870 {
871 	vrf_finish_direct(skb);
872 
873 	return vrf_ip_local_out(net, sk, skb);
874 }
875 
876 static int vrf_output_direct(struct net *net, struct sock *sk,
877 			     struct sk_buff *skb)
878 {
879 	int err = 1;
880 
881 	skb->protocol = htons(ETH_P_IP);
882 
883 	if (!(IPCB(skb)->flags & IPSKB_REROUTED))
884 		err = nf_hook(NFPROTO_IPV4, NF_INET_POST_ROUTING, net, sk, skb,
885 			      NULL, skb->dev, vrf_output_direct_finish);
886 
887 	if (likely(err == 1))
888 		vrf_finish_direct(skb);
889 
890 	return err;
891 }
892 
893 static int vrf_ip_out_direct_finish(struct net *net, struct sock *sk,
894 				    struct sk_buff *skb)
895 {
896 	int err;
897 
898 	err = vrf_output_direct(net, sk, skb);
899 	if (likely(err == 1))
900 		err = vrf_ip_local_out(net, sk, skb);
901 
902 	return err;
903 }
904 
905 static struct sk_buff *vrf_ip_out_direct(struct net_device *vrf_dev,
906 					 struct sock *sk,
907 					 struct sk_buff *skb)
908 {
909 	struct net *net = dev_net(vrf_dev);
910 	int err;
911 
912 	skb->dev = vrf_dev;
913 
914 	err = nf_hook(NFPROTO_IPV4, NF_INET_LOCAL_OUT, net, sk,
915 		      skb, NULL, vrf_dev, vrf_ip_out_direct_finish);
916 
917 	if (likely(err == 1))
918 		err = vrf_output_direct(net, sk, skb);
919 
920 	if (likely(err == 1))
921 		return skb;
922 
923 	return NULL;
924 }
925 
926 static struct sk_buff *vrf_ip_out(struct net_device *vrf_dev,
927 				  struct sock *sk,
928 				  struct sk_buff *skb)
929 {
930 	/* don't divert multicast or local broadcast */
931 	if (ipv4_is_multicast(ip_hdr(skb)->daddr) ||
932 	    ipv4_is_lbcast(ip_hdr(skb)->daddr))
933 		return skb;
934 
935 	vrf_nf_set_untracked(skb);
936 
937 	if (qdisc_tx_is_default(vrf_dev) ||
938 	    IPCB(skb)->flags & IPSKB_XFRM_TRANSFORMED)
939 		return vrf_ip_out_direct(vrf_dev, sk, skb);
940 
941 	return vrf_ip_out_redirect(vrf_dev, skb);
942 }
943 
944 /* called with rcu lock held */
945 static struct sk_buff *vrf_l3_out(struct net_device *vrf_dev,
946 				  struct sock *sk,
947 				  struct sk_buff *skb,
948 				  u16 proto)
949 {
950 	switch (proto) {
951 	case AF_INET:
952 		return vrf_ip_out(vrf_dev, sk, skb);
953 	case AF_INET6:
954 		return vrf_ip6_out(vrf_dev, sk, skb);
955 	}
956 
957 	return skb;
958 }
959 
960 /* holding rtnl */
961 static void vrf_rtable_release(struct net_device *dev, struct net_vrf *vrf)
962 {
963 	struct rtable *rth = vrf->rth;
964 
965 	dst_dev_put(&rth->dst);
966 	dst_release(&rth->dst);
967 }
968 
969 static int vrf_rtable_create(struct net_device *dev)
970 {
971 	struct net_vrf *vrf = netdev_priv(dev);
972 	struct rtable *rth;
973 
974 	if (!fib_new_table(dev_net(dev), vrf->tb_id))
975 		return -ENOMEM;
976 
977 	/* create a dst for routing packets out through a VRF device */
978 	rth = rt_dst_alloc(dev, 0, RTN_UNICAST, 1);
979 	if (!rth)
980 		return -ENOMEM;
981 
982 	rth->dst.output	= vrf_output;
983 
984 	vrf->rth = rth;
985 
986 	return 0;
987 }
988 
989 /**************************** device handling ********************/
990 
991 /* cycle interface to flush neighbor cache and move routes across tables */
992 static void cycle_netdev(struct net_device *dev,
993 			 struct netlink_ext_ack *extack)
994 {
995 	unsigned int flags = dev->flags;
996 	int ret;
997 
998 	if (!netif_running(dev))
999 		return;
1000 
1001 	ret = dev_change_flags(dev, flags & ~IFF_UP, extack);
1002 	if (ret >= 0)
1003 		ret = dev_change_flags(dev, flags, extack);
1004 
1005 	if (ret < 0) {
1006 		netdev_err(dev,
1007 			   "Failed to cycle device %s; route tables might be wrong!\n",
1008 			   dev->name);
1009 	}
1010 }
1011 
1012 static int do_vrf_add_slave(struct net_device *dev, struct net_device *port_dev,
1013 			    struct netlink_ext_ack *extack)
1014 {
1015 	int ret;
1016 
1017 	/* do not allow loopback device to be enslaved to a VRF.
1018 	 * The vrf device acts as the loopback for the vrf.
1019 	 */
1020 	if (port_dev == dev_net(dev)->loopback_dev) {
1021 		NL_SET_ERR_MSG(extack,
1022 			       "Can not enslave loopback device to a VRF");
1023 		return -EOPNOTSUPP;
1024 	}
1025 
1026 	port_dev->priv_flags |= IFF_L3MDEV_SLAVE;
1027 	ret = netdev_master_upper_dev_link(port_dev, dev, NULL, NULL, extack);
1028 	if (ret < 0)
1029 		goto err;
1030 
1031 	cycle_netdev(port_dev, extack);
1032 
1033 	return 0;
1034 
1035 err:
1036 	port_dev->priv_flags &= ~IFF_L3MDEV_SLAVE;
1037 	return ret;
1038 }
1039 
1040 static int vrf_add_slave(struct net_device *dev, struct net_device *port_dev,
1041 			 struct netlink_ext_ack *extack)
1042 {
1043 	if (netif_is_l3_master(port_dev)) {
1044 		NL_SET_ERR_MSG(extack,
1045 			       "Can not enslave an L3 master device to a VRF");
1046 		return -EINVAL;
1047 	}
1048 
1049 	if (netif_is_l3_slave(port_dev))
1050 		return -EINVAL;
1051 
1052 	return do_vrf_add_slave(dev, port_dev, extack);
1053 }
1054 
1055 /* inverse of do_vrf_add_slave */
1056 static int do_vrf_del_slave(struct net_device *dev, struct net_device *port_dev)
1057 {
1058 	netdev_upper_dev_unlink(port_dev, dev);
1059 	port_dev->priv_flags &= ~IFF_L3MDEV_SLAVE;
1060 
1061 	cycle_netdev(port_dev, NULL);
1062 
1063 	return 0;
1064 }
1065 
1066 static int vrf_del_slave(struct net_device *dev, struct net_device *port_dev)
1067 {
1068 	return do_vrf_del_slave(dev, port_dev);
1069 }
1070 
1071 static void vrf_dev_uninit(struct net_device *dev)
1072 {
1073 	struct net_vrf *vrf = netdev_priv(dev);
1074 
1075 	vrf_rtable_release(dev, vrf);
1076 	vrf_rt6_release(dev, vrf);
1077 }
1078 
1079 static int vrf_dev_init(struct net_device *dev)
1080 {
1081 	struct net_vrf *vrf = netdev_priv(dev);
1082 
1083 	/* create the default dst which points back to us */
1084 	if (vrf_rtable_create(dev) != 0)
1085 		goto out_nomem;
1086 
1087 	if (vrf_rt6_create(dev) != 0)
1088 		goto out_rth;
1089 
1090 	dev->flags = IFF_MASTER | IFF_NOARP;
1091 
1092 	/* similarly, oper state is irrelevant; set to up to avoid confusion */
1093 	dev->operstate = IF_OPER_UP;
1094 	netdev_lockdep_set_classes(dev);
1095 	return 0;
1096 
1097 out_rth:
1098 	vrf_rtable_release(dev, vrf);
1099 out_nomem:
1100 	return -ENOMEM;
1101 }
1102 
1103 static const struct net_device_ops vrf_netdev_ops = {
1104 	.ndo_init		= vrf_dev_init,
1105 	.ndo_uninit		= vrf_dev_uninit,
1106 	.ndo_start_xmit		= vrf_xmit,
1107 	.ndo_set_mac_address	= eth_mac_addr,
1108 	.ndo_add_slave		= vrf_add_slave,
1109 	.ndo_del_slave		= vrf_del_slave,
1110 };
1111 
1112 static u32 vrf_fib_table(const struct net_device *dev)
1113 {
1114 	struct net_vrf *vrf = netdev_priv(dev);
1115 
1116 	return vrf->tb_id;
1117 }
1118 
1119 static int vrf_rcv_finish(struct net *net, struct sock *sk, struct sk_buff *skb)
1120 {
1121 	kfree_skb(skb);
1122 	return 0;
1123 }
1124 
1125 static struct sk_buff *vrf_rcv_nfhook(u8 pf, unsigned int hook,
1126 				      struct sk_buff *skb,
1127 				      struct net_device *dev)
1128 {
1129 	struct net *net = dev_net(dev);
1130 
1131 	if (nf_hook(pf, hook, net, NULL, skb, dev, NULL, vrf_rcv_finish) != 1)
1132 		skb = NULL;    /* kfree_skb(skb) handled by nf code */
1133 
1134 	return skb;
1135 }
1136 
1137 static int vrf_prepare_mac_header(struct sk_buff *skb,
1138 				  struct net_device *vrf_dev, u16 proto)
1139 {
1140 	struct ethhdr *eth;
1141 	int err;
1142 
1143 	/* in general, we do not know if there is enough space in the head of
1144 	 * the packet for hosting the mac header.
1145 	 */
1146 	err = skb_cow_head(skb, LL_RESERVED_SPACE(vrf_dev));
1147 	if (unlikely(err))
1148 		/* no space in the skb head */
1149 		return -ENOBUFS;
1150 
1151 	__skb_push(skb, ETH_HLEN);
1152 	eth = (struct ethhdr *)skb->data;
1153 
1154 	skb_reset_mac_header(skb);
1155 	skb_reset_mac_len(skb);
1156 
1157 	/* we set the ethernet destination and the source addresses to the
1158 	 * address of the VRF device.
1159 	 */
1160 	ether_addr_copy(eth->h_dest, vrf_dev->dev_addr);
1161 	ether_addr_copy(eth->h_source, vrf_dev->dev_addr);
1162 	eth->h_proto = htons(proto);
1163 
1164 	/* the destination address of the Ethernet frame corresponds to the
1165 	 * address set on the VRF interface; therefore, the packet is intended
1166 	 * to be processed locally.
1167 	 */
1168 	skb->protocol = eth->h_proto;
1169 	skb->pkt_type = PACKET_HOST;
1170 
1171 	skb_postpush_rcsum(skb, skb->data, ETH_HLEN);
1172 
1173 	skb_pull_inline(skb, ETH_HLEN);
1174 
1175 	return 0;
1176 }
1177 
1178 /* prepare and add the mac header to the packet if it was not set previously.
1179  * In this way, packet sniffers such as tcpdump can parse the packet correctly.
1180  * If the mac header was already set, the original mac header is left
1181  * untouched and the function returns immediately.
1182  */
1183 static int vrf_add_mac_header_if_unset(struct sk_buff *skb,
1184 				       struct net_device *vrf_dev,
1185 				       u16 proto, struct net_device *orig_dev)
1186 {
1187 	if (skb_mac_header_was_set(skb) && dev_has_header(orig_dev))
1188 		return 0;
1189 
1190 	return vrf_prepare_mac_header(skb, vrf_dev, proto);
1191 }
1192 
1193 #if IS_ENABLED(CONFIG_IPV6)
1194 /* neighbor handling is done with actual device; do not want
1195  * to flip skb->dev for those ndisc packets. This really fails
1196  * for multiple next protocols (e.g., NEXTHDR_HOP). But it is
1197  * a start.
1198  */
1199 static bool ipv6_ndisc_frame(const struct sk_buff *skb)
1200 {
1201 	const struct ipv6hdr *iph = ipv6_hdr(skb);
1202 	bool rc = false;
1203 
1204 	if (iph->nexthdr == NEXTHDR_ICMP) {
1205 		const struct icmp6hdr *icmph;
1206 		struct icmp6hdr _icmph;
1207 
1208 		icmph = skb_header_pointer(skb, sizeof(*iph),
1209 					   sizeof(_icmph), &_icmph);
1210 		if (!icmph)
1211 			goto out;
1212 
1213 		switch (icmph->icmp6_type) {
1214 		case NDISC_ROUTER_SOLICITATION:
1215 		case NDISC_ROUTER_ADVERTISEMENT:
1216 		case NDISC_NEIGHBOUR_SOLICITATION:
1217 		case NDISC_NEIGHBOUR_ADVERTISEMENT:
1218 		case NDISC_REDIRECT:
1219 			rc = true;
1220 			break;
1221 		}
1222 	}
1223 
1224 out:
1225 	return rc;
1226 }
1227 
1228 static struct rt6_info *vrf_ip6_route_lookup(struct net *net,
1229 					     const struct net_device *dev,
1230 					     struct flowi6 *fl6,
1231 					     int ifindex,
1232 					     const struct sk_buff *skb,
1233 					     int flags)
1234 {
1235 	struct net_vrf *vrf = netdev_priv(dev);
1236 
1237 	return ip6_pol_route(net, vrf->fib6_table, ifindex, fl6, skb, flags);
1238 }
1239 
1240 static void vrf_ip6_input_dst(struct sk_buff *skb, struct net_device *vrf_dev,
1241 			      int ifindex)
1242 {
1243 	const struct ipv6hdr *iph = ipv6_hdr(skb);
1244 	struct flowi6 fl6 = {
1245 		.flowi6_iif     = ifindex,
1246 		.flowi6_mark    = skb->mark,
1247 		.flowi6_proto   = iph->nexthdr,
1248 		.daddr          = iph->daddr,
1249 		.saddr          = iph->saddr,
1250 		.flowlabel      = ip6_flowinfo(iph),
1251 	};
1252 	struct net *net = dev_net(vrf_dev);
1253 	struct rt6_info *rt6;
1254 
1255 	skb_dst_drop(skb);
1256 
1257 	rt6 = vrf_ip6_route_lookup(net, vrf_dev, &fl6, ifindex, skb,
1258 				   RT6_LOOKUP_F_HAS_SADDR | RT6_LOOKUP_F_IFACE);
1259 	if (unlikely(!rt6))
1260 		return;
1261 
1262 	if (unlikely(&rt6->dst == &net->ipv6.ip6_null_entry->dst))
1263 		return;
1264 
1265 	skb_dst_set(skb, &rt6->dst);
1266 }
1267 
1268 static struct sk_buff *vrf_ip6_rcv(struct net_device *vrf_dev,
1269 				   struct sk_buff *skb)
1270 {
1271 	int orig_iif = skb->skb_iif;
1272 	bool need_strict = rt6_need_strict(&ipv6_hdr(skb)->daddr);
1273 	bool is_ndisc = ipv6_ndisc_frame(skb);
1274 
1275 	/* loopback, multicast & non-ND link-local traffic; do not push through
1276 	 * packet taps again. Reset pkt_type for upper layers to process skb.
1277 	 * For non-loopback strict packets, determine the dst using the original
1278 	 * ifindex.
1279 	 */
1280 	if (skb->pkt_type == PACKET_LOOPBACK || (need_strict && !is_ndisc)) {
1281 		skb->dev = vrf_dev;
1282 		skb->skb_iif = vrf_dev->ifindex;
1283 		IP6CB(skb)->flags |= IP6SKB_L3SLAVE;
1284 
1285 		if (skb->pkt_type == PACKET_LOOPBACK)
1286 			skb->pkt_type = PACKET_HOST;
1287 		else
1288 			vrf_ip6_input_dst(skb, vrf_dev, orig_iif);
1289 
1290 		goto out;
1291 	}
1292 
1293 	/* if packet is NDISC then keep the ingress interface */
1294 	if (!is_ndisc) {
1295 		struct net_device *orig_dev = skb->dev;
1296 
1297 		dev_dstats_rx_add(vrf_dev, skb->len);
1298 		skb->dev = vrf_dev;
1299 		skb->skb_iif = vrf_dev->ifindex;
1300 
1301 		if (!list_empty(&vrf_dev->ptype_all)) {
1302 			int err;
1303 
1304 			err = vrf_add_mac_header_if_unset(skb, vrf_dev,
1305 							  ETH_P_IPV6,
1306 							  orig_dev);
1307 			if (likely(!err)) {
1308 				skb_push(skb, skb->mac_len);
1309 				dev_queue_xmit_nit(skb, vrf_dev);
1310 				skb_pull(skb, skb->mac_len);
1311 			}
1312 		}
1313 
1314 		IP6CB(skb)->flags |= IP6SKB_L3SLAVE;
1315 	}
1316 
1317 	if (need_strict)
1318 		vrf_ip6_input_dst(skb, vrf_dev, orig_iif);
1319 
1320 	skb = vrf_rcv_nfhook(NFPROTO_IPV6, NF_INET_PRE_ROUTING, skb, vrf_dev);
1321 out:
1322 	return skb;
1323 }
1324 
1325 #else
1326 static struct sk_buff *vrf_ip6_rcv(struct net_device *vrf_dev,
1327 				   struct sk_buff *skb)
1328 {
1329 	return skb;
1330 }
1331 #endif
1332 
1333 static struct sk_buff *vrf_ip_rcv(struct net_device *vrf_dev,
1334 				  struct sk_buff *skb)
1335 {
1336 	struct net_device *orig_dev = skb->dev;
1337 
1338 	skb->dev = vrf_dev;
1339 	skb->skb_iif = vrf_dev->ifindex;
1340 	IPCB(skb)->flags |= IPSKB_L3SLAVE;
1341 
1342 	if (ipv4_is_multicast(ip_hdr(skb)->daddr))
1343 		goto out;
1344 
1345 	/* loopback traffic; do not push through packet taps again.
1346 	 * Reset pkt_type for upper layers to process skb
1347 	 */
1348 	if (skb->pkt_type == PACKET_LOOPBACK) {
1349 		skb->pkt_type = PACKET_HOST;
1350 		goto out;
1351 	}
1352 
1353 	dev_dstats_rx_add(vrf_dev, skb->len);
1354 
1355 	if (!list_empty(&vrf_dev->ptype_all)) {
1356 		int err;
1357 
1358 		err = vrf_add_mac_header_if_unset(skb, vrf_dev, ETH_P_IP,
1359 						  orig_dev);
1360 		if (likely(!err)) {
1361 			skb_push(skb, skb->mac_len);
1362 			dev_queue_xmit_nit(skb, vrf_dev);
1363 			skb_pull(skb, skb->mac_len);
1364 		}
1365 	}
1366 
1367 	skb = vrf_rcv_nfhook(NFPROTO_IPV4, NF_INET_PRE_ROUTING, skb, vrf_dev);
1368 out:
1369 	return skb;
1370 }
1371 
1372 /* called with rcu lock held */
1373 static struct sk_buff *vrf_l3_rcv(struct net_device *vrf_dev,
1374 				  struct sk_buff *skb,
1375 				  u16 proto)
1376 {
1377 	switch (proto) {
1378 	case AF_INET:
1379 		return vrf_ip_rcv(vrf_dev, skb);
1380 	case AF_INET6:
1381 		return vrf_ip6_rcv(vrf_dev, skb);
1382 	}
1383 
1384 	return skb;
1385 }
1386 
1387 #if IS_ENABLED(CONFIG_IPV6)
1388 /* send to link-local or multicast address via interface enslaved to
1389  * VRF device. Force lookup to VRF table without changing flow struct
1390  * Note: Caller to this function must hold rcu_read_lock() and no refcnt
1391  * is taken on the dst by this function.
1392  */
1393 static struct dst_entry *vrf_link_scope_lookup(const struct net_device *dev,
1394 					      struct flowi6 *fl6)
1395 {
1396 	struct net *net = dev_net(dev);
1397 	int flags = RT6_LOOKUP_F_IFACE | RT6_LOOKUP_F_DST_NOREF;
1398 	struct dst_entry *dst = NULL;
1399 	struct rt6_info *rt;
1400 
1401 	/* VRF device does not have a link-local address and
1402 	 * sending packets to link-local or mcast addresses over
1403 	 * a VRF device does not make sense
1404 	 */
1405 	if (fl6->flowi6_oif == dev->ifindex) {
1406 		dst = &net->ipv6.ip6_null_entry->dst;
1407 		return dst;
1408 	}
1409 
1410 	if (!ipv6_addr_any(&fl6->saddr))
1411 		flags |= RT6_LOOKUP_F_HAS_SADDR;
1412 
1413 	rt = vrf_ip6_route_lookup(net, dev, fl6, fl6->flowi6_oif, NULL, flags);
1414 	if (rt)
1415 		dst = &rt->dst;
1416 
1417 	return dst;
1418 }
1419 #endif
1420 
1421 static const struct l3mdev_ops vrf_l3mdev_ops = {
1422 	.l3mdev_fib_table	= vrf_fib_table,
1423 	.l3mdev_l3_rcv		= vrf_l3_rcv,
1424 	.l3mdev_l3_out		= vrf_l3_out,
1425 #if IS_ENABLED(CONFIG_IPV6)
1426 	.l3mdev_link_scope_lookup = vrf_link_scope_lookup,
1427 #endif
1428 };
1429 
1430 static void vrf_get_drvinfo(struct net_device *dev,
1431 			    struct ethtool_drvinfo *info)
1432 {
1433 	strscpy(info->driver, DRV_NAME, sizeof(info->driver));
1434 	strscpy(info->version, DRV_VERSION, sizeof(info->version));
1435 }
1436 
1437 static const struct ethtool_ops vrf_ethtool_ops = {
1438 	.get_drvinfo	= vrf_get_drvinfo,
1439 };
1440 
1441 static inline size_t vrf_fib_rule_nl_size(void)
1442 {
1443 	size_t sz;
1444 
1445 	sz  = NLMSG_ALIGN(sizeof(struct fib_rule_hdr));
1446 	sz += nla_total_size(sizeof(u8));	/* FRA_L3MDEV */
1447 	sz += nla_total_size(sizeof(u32));	/* FRA_PRIORITY */
1448 	sz += nla_total_size(sizeof(u8));       /* FRA_PROTOCOL */
1449 
1450 	return sz;
1451 }
1452 
1453 static int vrf_fib_rule(const struct net_device *dev, __u8 family, bool add_it)
1454 {
1455 	struct fib_rule_hdr *frh;
1456 	struct nlmsghdr *nlh;
1457 	struct sk_buff *skb;
1458 	int err;
1459 
1460 	if ((family == AF_INET6 || family == RTNL_FAMILY_IP6MR) &&
1461 	    !ipv6_mod_enabled())
1462 		return 0;
1463 
1464 	skb = nlmsg_new(vrf_fib_rule_nl_size(), GFP_KERNEL);
1465 	if (!skb)
1466 		return -ENOMEM;
1467 
1468 	nlh = nlmsg_put(skb, 0, 0, 0, sizeof(*frh), 0);
1469 	if (!nlh)
1470 		goto nla_put_failure;
1471 
1472 	/* rule only needs to appear once */
1473 	nlh->nlmsg_flags |= NLM_F_EXCL;
1474 
1475 	frh = nlmsg_data(nlh);
1476 	memset(frh, 0, sizeof(*frh));
1477 	frh->family = family;
1478 	frh->action = FR_ACT_TO_TBL;
1479 
1480 	if (nla_put_u8(skb, FRA_PROTOCOL, RTPROT_KERNEL))
1481 		goto nla_put_failure;
1482 
1483 	if (nla_put_u8(skb, FRA_L3MDEV, 1))
1484 		goto nla_put_failure;
1485 
1486 	if (nla_put_u32(skb, FRA_PRIORITY, FIB_RULE_PREF))
1487 		goto nla_put_failure;
1488 
1489 	nlmsg_end(skb, nlh);
1490 
1491 	if (add_it) {
1492 		err = fib_newrule(dev_net(dev), skb, nlh, NULL, true);
1493 		if (err == -EEXIST)
1494 			err = 0;
1495 	} else {
1496 		err = fib_delrule(dev_net(dev), skb, nlh, NULL, true);
1497 		if (err == -ENOENT)
1498 			err = 0;
1499 	}
1500 	nlmsg_free(skb);
1501 
1502 	return err;
1503 
1504 nla_put_failure:
1505 	nlmsg_free(skb);
1506 
1507 	return -EMSGSIZE;
1508 }
1509 
1510 static int vrf_add_fib_rules(const struct net_device *dev)
1511 {
1512 	int err;
1513 
1514 	err = vrf_fib_rule(dev, AF_INET,  true);
1515 	if (err < 0)
1516 		goto out_err;
1517 
1518 	err = vrf_fib_rule(dev, AF_INET6, true);
1519 	if (err < 0)
1520 		goto ipv6_err;
1521 
1522 #if IS_ENABLED(CONFIG_IP_MROUTE_MULTIPLE_TABLES)
1523 	err = vrf_fib_rule(dev, RTNL_FAMILY_IPMR, true);
1524 	if (err < 0)
1525 		goto ipmr_err;
1526 #endif
1527 
1528 #if IS_ENABLED(CONFIG_IPV6_MROUTE_MULTIPLE_TABLES)
1529 	err = vrf_fib_rule(dev, RTNL_FAMILY_IP6MR, true);
1530 	if (err < 0)
1531 		goto ip6mr_err;
1532 #endif
1533 
1534 	return 0;
1535 
1536 #if IS_ENABLED(CONFIG_IPV6_MROUTE_MULTIPLE_TABLES)
1537 ip6mr_err:
1538 	vrf_fib_rule(dev, RTNL_FAMILY_IPMR,  false);
1539 #endif
1540 
1541 #if IS_ENABLED(CONFIG_IP_MROUTE_MULTIPLE_TABLES)
1542 ipmr_err:
1543 	vrf_fib_rule(dev, AF_INET6,  false);
1544 #endif
1545 
1546 ipv6_err:
1547 	vrf_fib_rule(dev, AF_INET,  false);
1548 
1549 out_err:
1550 	netdev_err(dev, "Failed to add FIB rules.\n");
1551 	return err;
1552 }
1553 
1554 static void vrf_setup(struct net_device *dev)
1555 {
1556 	ether_setup(dev);
1557 
1558 	/* Initialize the device structure. */
1559 	dev->netdev_ops = &vrf_netdev_ops;
1560 	dev->l3mdev_ops = &vrf_l3mdev_ops;
1561 	dev->ethtool_ops = &vrf_ethtool_ops;
1562 	dev->needs_free_netdev = true;
1563 
1564 	/* Fill in device structure with ethernet-generic values. */
1565 	eth_hw_addr_random(dev);
1566 
1567 	/* don't acquire vrf device's netif_tx_lock when transmitting */
1568 	dev->lltx = true;
1569 
1570 	/* don't allow vrf devices to change network namespaces. */
1571 	dev->netns_immutable = true;
1572 
1573 	/* does not make sense for a VLAN to be added to a vrf device */
1574 	dev->features   |= NETIF_F_VLAN_CHALLENGED;
1575 
1576 	/* enable offload features */
1577 	dev->features   |= NETIF_F_GSO_SOFTWARE;
1578 	dev->features   |= NETIF_F_RXCSUM | NETIF_F_HW_CSUM | NETIF_F_SCTP_CRC;
1579 	dev->features   |= NETIF_F_SG | NETIF_F_FRAGLIST | NETIF_F_HIGHDMA;
1580 
1581 	dev->hw_features = dev->features;
1582 	dev->hw_enc_features = dev->features;
1583 
1584 	/* default to no qdisc; user can add if desired */
1585 	dev->priv_flags |= IFF_NO_QUEUE;
1586 	dev->priv_flags |= IFF_NO_RX_HANDLER;
1587 	dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
1588 
1589 	/* VRF devices do not care about MTU, but if the MTU is set
1590 	 * too low then the ipv4 and ipv6 protocols are disabled
1591 	 * which breaks networking.
1592 	 */
1593 	dev->min_mtu = IPV6_MIN_MTU;
1594 	dev->max_mtu = IP6_MAX_MTU;
1595 	dev->mtu = dev->max_mtu;
1596 
1597 	dev->pcpu_stat_type = NETDEV_PCPU_STAT_DSTATS;
1598 }
1599 
1600 static int vrf_validate(struct nlattr *tb[], struct nlattr *data[],
1601 			struct netlink_ext_ack *extack)
1602 {
1603 	if (tb[IFLA_ADDRESS]) {
1604 		if (nla_len(tb[IFLA_ADDRESS]) != ETH_ALEN) {
1605 			NL_SET_ERR_MSG(extack, "Invalid hardware address");
1606 			return -EINVAL;
1607 		}
1608 		if (!is_valid_ether_addr(nla_data(tb[IFLA_ADDRESS]))) {
1609 			NL_SET_ERR_MSG(extack, "Invalid hardware address");
1610 			return -EADDRNOTAVAIL;
1611 		}
1612 	}
1613 	return 0;
1614 }
1615 
1616 static void vrf_dellink(struct net_device *dev, struct list_head *head)
1617 {
1618 	struct net_device *port_dev;
1619 	struct list_head *iter;
1620 
1621 	netdev_for_each_lower_dev(dev, port_dev, iter)
1622 		vrf_del_slave(dev, port_dev);
1623 
1624 	vrf_map_unregister_dev(dev);
1625 
1626 	unregister_netdevice_queue(dev, head);
1627 }
1628 
1629 static int vrf_newlink(struct net_device *dev,
1630 		       struct rtnl_newlink_params *params,
1631 		       struct netlink_ext_ack *extack)
1632 {
1633 	struct net_vrf *vrf = netdev_priv(dev);
1634 	struct nlattr **data = params->data;
1635 	struct netns_vrf *nn_vrf;
1636 	bool *add_fib_rules;
1637 	struct net *net;
1638 	int err;
1639 
1640 	if (!data || !data[IFLA_VRF_TABLE]) {
1641 		NL_SET_ERR_MSG(extack, "VRF table id is missing");
1642 		return -EINVAL;
1643 	}
1644 
1645 	vrf->tb_id = nla_get_u32(data[IFLA_VRF_TABLE]);
1646 	if (vrf->tb_id == RT_TABLE_UNSPEC) {
1647 		NL_SET_ERR_MSG_ATTR(extack, data[IFLA_VRF_TABLE],
1648 				    "Invalid VRF table id");
1649 		return -EINVAL;
1650 	}
1651 
1652 	dev->priv_flags |= IFF_L3MDEV_MASTER;
1653 
1654 	err = register_netdevice(dev);
1655 	if (err)
1656 		goto out;
1657 
1658 	/* mapping between table_id and vrf;
1659 	 * note: such binding could not be done in the dev init function
1660 	 * because dev->ifindex id is not available yet.
1661 	 */
1662 	vrf->ifindex = dev->ifindex;
1663 
1664 	err = vrf_map_register_dev(dev, extack);
1665 	if (err) {
1666 		unregister_netdevice(dev);
1667 		goto out;
1668 	}
1669 
1670 	net = dev_net(dev);
1671 	nn_vrf = net_generic(net, vrf_net_id);
1672 
1673 	add_fib_rules = &nn_vrf->add_fib_rules;
1674 	if (*add_fib_rules) {
1675 		err = vrf_add_fib_rules(dev);
1676 		if (err) {
1677 			vrf_map_unregister_dev(dev);
1678 			unregister_netdevice(dev);
1679 			goto out;
1680 		}
1681 		*add_fib_rules = false;
1682 	}
1683 
1684 out:
1685 	return err;
1686 }
1687 
1688 static size_t vrf_nl_getsize(const struct net_device *dev)
1689 {
1690 	return nla_total_size(sizeof(u32));  /* IFLA_VRF_TABLE */
1691 }
1692 
1693 static int vrf_fillinfo(struct sk_buff *skb,
1694 			const struct net_device *dev)
1695 {
1696 	struct net_vrf *vrf = netdev_priv(dev);
1697 
1698 	return nla_put_u32(skb, IFLA_VRF_TABLE, vrf->tb_id);
1699 }
1700 
1701 static size_t vrf_get_slave_size(const struct net_device *bond_dev,
1702 				 const struct net_device *slave_dev)
1703 {
1704 	return nla_total_size(sizeof(u32));  /* IFLA_VRF_PORT_TABLE */
1705 }
1706 
1707 static int vrf_fill_slave_info(struct sk_buff *skb,
1708 			       const struct net_device *vrf_dev,
1709 			       const struct net_device *slave_dev)
1710 {
1711 	struct net_vrf *vrf = netdev_priv(vrf_dev);
1712 
1713 	if (nla_put_u32(skb, IFLA_VRF_PORT_TABLE, vrf->tb_id))
1714 		return -EMSGSIZE;
1715 
1716 	return 0;
1717 }
1718 
1719 static const struct nla_policy vrf_nl_policy[IFLA_VRF_MAX + 1] = {
1720 	[IFLA_VRF_TABLE] = { .type = NLA_U32 },
1721 };
1722 
1723 static struct rtnl_link_ops vrf_link_ops __read_mostly = {
1724 	.kind		= DRV_NAME,
1725 	.priv_size	= sizeof(struct net_vrf),
1726 
1727 	.get_size	= vrf_nl_getsize,
1728 	.policy		= vrf_nl_policy,
1729 	.validate	= vrf_validate,
1730 	.fill_info	= vrf_fillinfo,
1731 
1732 	.get_slave_size  = vrf_get_slave_size,
1733 	.fill_slave_info = vrf_fill_slave_info,
1734 
1735 	.newlink	= vrf_newlink,
1736 	.dellink	= vrf_dellink,
1737 	.setup		= vrf_setup,
1738 	.maxtype	= IFLA_VRF_MAX,
1739 };
1740 
1741 static int vrf_device_event(struct notifier_block *unused,
1742 			    unsigned long event, void *ptr)
1743 {
1744 	struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1745 
1746 	/* only care about unregister events to drop slave references */
1747 	if (event == NETDEV_UNREGISTER) {
1748 		struct net_device *vrf_dev;
1749 
1750 		if (!netif_is_l3_slave(dev))
1751 			goto out;
1752 
1753 		vrf_dev = netdev_master_upper_dev_get(dev);
1754 		vrf_del_slave(vrf_dev, dev);
1755 	}
1756 out:
1757 	return NOTIFY_DONE;
1758 }
1759 
1760 static struct notifier_block vrf_notifier_block __read_mostly = {
1761 	.notifier_call = vrf_device_event,
1762 };
1763 
1764 static int vrf_map_init(struct vrf_map *vmap)
1765 {
1766 	spin_lock_init(&vmap->vmap_lock);
1767 	hash_init(vmap->ht);
1768 
1769 	vmap->strict_mode = false;
1770 
1771 	return 0;
1772 }
1773 
1774 #ifdef CONFIG_SYSCTL
1775 static bool vrf_strict_mode(struct vrf_map *vmap)
1776 {
1777 	bool strict_mode;
1778 
1779 	vrf_map_lock(vmap);
1780 	strict_mode = vmap->strict_mode;
1781 	vrf_map_unlock(vmap);
1782 
1783 	return strict_mode;
1784 }
1785 
1786 static int vrf_strict_mode_change(struct vrf_map *vmap, bool new_mode)
1787 {
1788 	bool *cur_mode;
1789 	int res = 0;
1790 
1791 	vrf_map_lock(vmap);
1792 
1793 	cur_mode = &vmap->strict_mode;
1794 	if (*cur_mode == new_mode)
1795 		goto unlock;
1796 
1797 	if (*cur_mode) {
1798 		/* disable strict mode */
1799 		*cur_mode = false;
1800 	} else {
1801 		if (vmap->shared_tables) {
1802 			/* we cannot allow strict_mode because there are some
1803 			 * vrfs that share one or more tables.
1804 			 */
1805 			res = -EBUSY;
1806 			goto unlock;
1807 		}
1808 
1809 		/* no tables are shared among vrfs, so we can go back
1810 		 * to 1:1 association between a vrf with its table.
1811 		 */
1812 		*cur_mode = true;
1813 	}
1814 
1815 unlock:
1816 	vrf_map_unlock(vmap);
1817 
1818 	return res;
1819 }
1820 
1821 static int vrf_shared_table_handler(const struct ctl_table *table, int write,
1822 				    void *buffer, size_t *lenp, loff_t *ppos)
1823 {
1824 	struct net *net = (struct net *)table->extra1;
1825 	struct vrf_map *vmap = netns_vrf_map(net);
1826 	int proc_strict_mode = 0;
1827 	struct ctl_table tmp = {
1828 		.procname	= table->procname,
1829 		.data		= &proc_strict_mode,
1830 		.maxlen		= sizeof(int),
1831 		.mode		= table->mode,
1832 		.extra1		= SYSCTL_ZERO,
1833 		.extra2		= SYSCTL_ONE,
1834 	};
1835 	int ret;
1836 
1837 	if (!write)
1838 		proc_strict_mode = vrf_strict_mode(vmap);
1839 
1840 	ret = proc_dointvec_minmax(&tmp, write, buffer, lenp, ppos);
1841 
1842 	if (write && ret == 0)
1843 		ret = vrf_strict_mode_change(vmap, (bool)proc_strict_mode);
1844 
1845 	return ret;
1846 }
1847 
1848 static const struct ctl_table vrf_table[] = {
1849 	{
1850 		.procname	= "strict_mode",
1851 		.data		= NULL,
1852 		.maxlen		= sizeof(int),
1853 		.mode		= 0644,
1854 		.proc_handler	= vrf_shared_table_handler,
1855 		/* set by the vrf_netns_init */
1856 		.extra1		= NULL,
1857 	},
1858 };
1859 
1860 static int vrf_netns_init_sysctl(struct net *net, struct netns_vrf *nn_vrf)
1861 {
1862 	struct ctl_table *table;
1863 
1864 	table = kmemdup(vrf_table, sizeof(vrf_table), GFP_KERNEL);
1865 	if (!table)
1866 		return -ENOMEM;
1867 
1868 	/* init the extra1 parameter with the reference to current netns */
1869 	table[0].extra1 = net;
1870 
1871 	nn_vrf->ctl_hdr = register_net_sysctl_sz(net, "net/vrf", table,
1872 						 ARRAY_SIZE(vrf_table));
1873 	if (!nn_vrf->ctl_hdr) {
1874 		kfree(table);
1875 		return -ENOMEM;
1876 	}
1877 
1878 	return 0;
1879 }
1880 
1881 static void vrf_netns_exit_sysctl(struct net *net)
1882 {
1883 	struct netns_vrf *nn_vrf = net_generic(net, vrf_net_id);
1884 	const struct ctl_table *table;
1885 
1886 	table = nn_vrf->ctl_hdr->ctl_table_arg;
1887 	unregister_net_sysctl_table(nn_vrf->ctl_hdr);
1888 	kfree(table);
1889 }
1890 #else
1891 static int vrf_netns_init_sysctl(struct net *net, struct netns_vrf *nn_vrf)
1892 {
1893 	return 0;
1894 }
1895 
1896 static void vrf_netns_exit_sysctl(struct net *net)
1897 {
1898 }
1899 #endif
1900 
1901 /* Initialize per network namespace state */
1902 static int __net_init vrf_netns_init(struct net *net)
1903 {
1904 	struct netns_vrf *nn_vrf = net_generic(net, vrf_net_id);
1905 
1906 	nn_vrf->add_fib_rules = true;
1907 	vrf_map_init(&nn_vrf->vmap);
1908 
1909 	return vrf_netns_init_sysctl(net, nn_vrf);
1910 }
1911 
1912 static void __net_exit vrf_netns_exit(struct net *net)
1913 {
1914 	vrf_netns_exit_sysctl(net);
1915 }
1916 
1917 static struct pernet_operations vrf_net_ops __net_initdata = {
1918 	.init = vrf_netns_init,
1919 	.exit = vrf_netns_exit,
1920 	.id   = &vrf_net_id,
1921 	.size = sizeof(struct netns_vrf),
1922 };
1923 
1924 static int __init vrf_init_module(void)
1925 {
1926 	int rc;
1927 
1928 	register_netdevice_notifier(&vrf_notifier_block);
1929 
1930 	rc = register_pernet_subsys(&vrf_net_ops);
1931 	if (rc < 0)
1932 		goto error;
1933 
1934 	rc = l3mdev_table_lookup_register(L3MDEV_TYPE_VRF,
1935 					  vrf_ifindex_lookup_by_table_id);
1936 	if (rc < 0)
1937 		goto unreg_pernet;
1938 
1939 	rc = rtnl_link_register(&vrf_link_ops);
1940 	if (rc < 0)
1941 		goto table_lookup_unreg;
1942 
1943 	return 0;
1944 
1945 table_lookup_unreg:
1946 	l3mdev_table_lookup_unregister(L3MDEV_TYPE_VRF,
1947 				       vrf_ifindex_lookup_by_table_id);
1948 
1949 unreg_pernet:
1950 	unregister_pernet_subsys(&vrf_net_ops);
1951 
1952 error:
1953 	unregister_netdevice_notifier(&vrf_notifier_block);
1954 	return rc;
1955 }
1956 
1957 module_init(vrf_init_module);
1958 MODULE_AUTHOR("Shrijeet Mukherjee, David Ahern");
1959 MODULE_DESCRIPTION("Device driver to instantiate VRF domains");
1960 MODULE_LICENSE("GPL");
1961 MODULE_ALIAS_RTNL_LINK(DRV_NAME);
1962 MODULE_VERSION(DRV_VERSION);
1963