xref: /linux/drivers/net/tun.c (revision 397692eab35cbbd83681880c6a2dbcdb9fd84386)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  TUN - Universal TUN/TAP device driver.
4  *  Copyright (C) 1999-2002 Maxim Krasnyansky <maxk@qualcomm.com>
5  *
6  *  $Id: tun.c,v 1.15 2002/03/01 02:44:24 maxk Exp $
7  */
8 
9 /*
10  *  Changes:
11  *
12  *  Mike Kershaw <dragorn@kismetwireless.net> 2005/08/14
13  *    Add TUNSETLINK ioctl to set the link encapsulation
14  *
15  *  Mark Smith <markzzzsmith@yahoo.com.au>
16  *    Use eth_random_addr() for tap MAC address.
17  *
18  *  Harald Roelle <harald.roelle@ifi.lmu.de>  2004/04/20
19  *    Fixes in packet dropping, queue length setting and queue wakeup.
20  *    Increased default tx queue length.
21  *    Added ethtool API.
22  *    Minor cleanups
23  *
24  *  Daniel Podlejski <underley@underley.eu.org>
25  *    Modifications for 2.3.99-pre5 kernel.
26  */
27 
28 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
29 
30 #define DRV_NAME	"tun"
31 #define DRV_VERSION	"1.6"
32 #define DRV_DESCRIPTION	"Universal TUN/TAP device driver"
33 #define DRV_COPYRIGHT	"(C) 1999-2004 Max Krasnyansky <maxk@qualcomm.com>"
34 
35 #include <linux/module.h>
36 #include <linux/errno.h>
37 #include <linux/kernel.h>
38 #include <linux/sched/signal.h>
39 #include <linux/major.h>
40 #include <linux/slab.h>
41 #include <linux/poll.h>
42 #include <linux/fcntl.h>
43 #include <linux/init.h>
44 #include <linux/skbuff.h>
45 #include <linux/netdevice.h>
46 #include <linux/etherdevice.h>
47 #include <linux/miscdevice.h>
48 #include <linux/ethtool.h>
49 #include <linux/rtnetlink.h>
50 #include <linux/compat.h>
51 #include <linux/if.h>
52 #include <linux/if_arp.h>
53 #include <linux/if_ether.h>
54 #include <linux/if_tun.h>
55 #include <linux/if_vlan.h>
56 #include <linux/crc32.h>
57 #include <linux/nsproxy.h>
58 #include <linux/virtio_net.h>
59 #include <linux/rcupdate.h>
60 #include <net/net_namespace.h>
61 #include <net/netns/generic.h>
62 #include <net/rtnetlink.h>
63 #include <net/sock.h>
64 #include <net/xdp.h>
65 #include <linux/seq_file.h>
66 #include <linux/uio.h>
67 #include <linux/skb_array.h>
68 #include <linux/bpf.h>
69 #include <linux/bpf_trace.h>
70 #include <linux/mutex.h>
71 
72 #include <linux/uaccess.h>
73 #include <linux/proc_fs.h>
74 
75 static void tun_default_link_ksettings(struct net_device *dev,
76 				       struct ethtool_link_ksettings *cmd);
77 
78 /* Uncomment to enable debugging */
79 /* #define TUN_DEBUG 1 */
80 
81 #ifdef TUN_DEBUG
82 static int debug;
83 
84 #define tun_debug(level, tun, fmt, args...)			\
85 do {								\
86 	if (tun->debug)						\
87 		netdev_printk(level, tun->dev, fmt, ##args);	\
88 } while (0)
89 #define DBG1(level, fmt, args...)				\
90 do {								\
91 	if (debug == 2)						\
92 		printk(level fmt, ##args);			\
93 } while (0)
94 #else
95 #define tun_debug(level, tun, fmt, args...)			\
96 do {								\
97 	if (0)							\
98 		netdev_printk(level, tun->dev, fmt, ##args);	\
99 } while (0)
100 #define DBG1(level, fmt, args...)				\
101 do {								\
102 	if (0)							\
103 		printk(level fmt, ##args);			\
104 } while (0)
105 #endif
106 
107 #define TUN_RX_PAD (NET_IP_ALIGN + NET_SKB_PAD)
108 
109 /* TUN device flags */
110 
111 /* IFF_ATTACH_QUEUE is never stored in device flags,
112  * overload it to mean fasync when stored there.
113  */
114 #define TUN_FASYNC	IFF_ATTACH_QUEUE
115 /* High bits in flags field are unused. */
116 #define TUN_VNET_LE     0x80000000
117 #define TUN_VNET_BE     0x40000000
118 
119 #define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
120 		      IFF_MULTI_QUEUE | IFF_NAPI | IFF_NAPI_FRAGS)
121 
122 #define GOODCOPY_LEN 128
123 
124 #define FLT_EXACT_COUNT 8
125 struct tap_filter {
126 	unsigned int    count;    /* Number of addrs. Zero means disabled */
127 	u32             mask[2];  /* Mask of the hashed addrs */
128 	unsigned char	addr[FLT_EXACT_COUNT][ETH_ALEN];
129 };
130 
131 /* MAX_TAP_QUEUES 256 is chosen to allow rx/tx queues to be equal
132  * to max number of VCPUs in guest. */
133 #define MAX_TAP_QUEUES 256
134 #define MAX_TAP_FLOWS  4096
135 
136 #define TUN_FLOW_EXPIRE (3 * HZ)
137 
138 struct tun_pcpu_stats {
139 	u64_stats_t rx_packets;
140 	u64_stats_t rx_bytes;
141 	u64_stats_t tx_packets;
142 	u64_stats_t tx_bytes;
143 	struct u64_stats_sync syncp;
144 	u32 rx_dropped;
145 	u32 tx_dropped;
146 	u32 rx_frame_errors;
147 };
148 
149 /* A tun_file connects an open character device to a tuntap netdevice. It
150  * also contains all socket related structures (except sock_fprog and tap_filter)
151  * to serve as one transmit queue for tuntap device. The sock_fprog and
152  * tap_filter were kept in tun_struct since they were used for filtering for the
153  * netdevice not for a specific queue (at least I didn't see the requirement for
154  * this).
155  *
156  * RCU usage:
157  * The tun_file and tun_struct are loosely coupled, the pointer from one to the
158  * other can only be read while rcu_read_lock or rtnl_lock is held.
159  */
160 struct tun_file {
161 	struct sock sk;
162 	struct socket socket;
163 	struct tun_struct __rcu *tun;
164 	struct fasync_struct *fasync;
165 	/* only used for fasnyc */
166 	unsigned int flags;
167 	union {
168 		u16 queue_index;
169 		unsigned int ifindex;
170 	};
171 	struct napi_struct napi;
172 	bool napi_enabled;
173 	bool napi_frags_enabled;
174 	struct mutex napi_mutex;	/* Protects access to the above napi */
175 	struct list_head next;
176 	struct tun_struct *detached;
177 	struct ptr_ring tx_ring;
178 	struct xdp_rxq_info xdp_rxq;
179 };
180 
181 struct tun_page {
182 	struct page *page;
183 	int count;
184 };
185 
186 struct tun_flow_entry {
187 	struct hlist_node hash_link;
188 	struct rcu_head rcu;
189 	struct tun_struct *tun;
190 
191 	u32 rxhash;
192 	u32 rps_rxhash;
193 	int queue_index;
194 	unsigned long updated ____cacheline_aligned_in_smp;
195 };
196 
197 #define TUN_NUM_FLOW_ENTRIES 1024
198 #define TUN_MASK_FLOW_ENTRIES (TUN_NUM_FLOW_ENTRIES - 1)
199 
200 struct tun_prog {
201 	struct rcu_head rcu;
202 	struct bpf_prog *prog;
203 };
204 
205 /* Since the socket were moved to tun_file, to preserve the behavior of persist
206  * device, socket filter, sndbuf and vnet header size were restore when the
207  * file were attached to a persist device.
208  */
209 struct tun_struct {
210 	struct tun_file __rcu	*tfiles[MAX_TAP_QUEUES];
211 	unsigned int            numqueues;
212 	unsigned int 		flags;
213 	kuid_t			owner;
214 	kgid_t			group;
215 
216 	struct net_device	*dev;
217 	netdev_features_t	set_features;
218 #define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
219 			  NETIF_F_TSO6)
220 
221 	int			align;
222 	int			vnet_hdr_sz;
223 	int			sndbuf;
224 	struct tap_filter	txflt;
225 	struct sock_fprog	fprog;
226 	/* protected by rtnl lock */
227 	bool			filter_attached;
228 #ifdef TUN_DEBUG
229 	int debug;
230 #endif
231 	spinlock_t lock;
232 	struct hlist_head flows[TUN_NUM_FLOW_ENTRIES];
233 	struct timer_list flow_gc_timer;
234 	unsigned long ageing_time;
235 	unsigned int numdisabled;
236 	struct list_head disabled;
237 	void *security;
238 	u32 flow_count;
239 	u32 rx_batched;
240 	struct tun_pcpu_stats __percpu *pcpu_stats;
241 	struct bpf_prog __rcu *xdp_prog;
242 	struct tun_prog __rcu *steering_prog;
243 	struct tun_prog __rcu *filter_prog;
244 	struct ethtool_link_ksettings link_ksettings;
245 };
246 
247 struct veth {
248 	__be16 h_vlan_proto;
249 	__be16 h_vlan_TCI;
250 };
251 
252 bool tun_is_xdp_frame(void *ptr)
253 {
254 	return (unsigned long)ptr & TUN_XDP_FLAG;
255 }
256 EXPORT_SYMBOL(tun_is_xdp_frame);
257 
258 void *tun_xdp_to_ptr(void *ptr)
259 {
260 	return (void *)((unsigned long)ptr | TUN_XDP_FLAG);
261 }
262 EXPORT_SYMBOL(tun_xdp_to_ptr);
263 
264 void *tun_ptr_to_xdp(void *ptr)
265 {
266 	return (void *)((unsigned long)ptr & ~TUN_XDP_FLAG);
267 }
268 EXPORT_SYMBOL(tun_ptr_to_xdp);
269 
270 static int tun_napi_receive(struct napi_struct *napi, int budget)
271 {
272 	struct tun_file *tfile = container_of(napi, struct tun_file, napi);
273 	struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
274 	struct sk_buff_head process_queue;
275 	struct sk_buff *skb;
276 	int received = 0;
277 
278 	__skb_queue_head_init(&process_queue);
279 
280 	spin_lock(&queue->lock);
281 	skb_queue_splice_tail_init(queue, &process_queue);
282 	spin_unlock(&queue->lock);
283 
284 	while (received < budget && (skb = __skb_dequeue(&process_queue))) {
285 		napi_gro_receive(napi, skb);
286 		++received;
287 	}
288 
289 	if (!skb_queue_empty(&process_queue)) {
290 		spin_lock(&queue->lock);
291 		skb_queue_splice(&process_queue, queue);
292 		spin_unlock(&queue->lock);
293 	}
294 
295 	return received;
296 }
297 
298 static int tun_napi_poll(struct napi_struct *napi, int budget)
299 {
300 	unsigned int received;
301 
302 	received = tun_napi_receive(napi, budget);
303 
304 	if (received < budget)
305 		napi_complete_done(napi, received);
306 
307 	return received;
308 }
309 
310 static void tun_napi_init(struct tun_struct *tun, struct tun_file *tfile,
311 			  bool napi_en, bool napi_frags)
312 {
313 	tfile->napi_enabled = napi_en;
314 	tfile->napi_frags_enabled = napi_en && napi_frags;
315 	if (napi_en) {
316 		netif_tx_napi_add(tun->dev, &tfile->napi, tun_napi_poll,
317 				  NAPI_POLL_WEIGHT);
318 		napi_enable(&tfile->napi);
319 	}
320 }
321 
322 static void tun_napi_disable(struct tun_file *tfile)
323 {
324 	if (tfile->napi_enabled)
325 		napi_disable(&tfile->napi);
326 }
327 
328 static void tun_napi_del(struct tun_file *tfile)
329 {
330 	if (tfile->napi_enabled)
331 		netif_napi_del(&tfile->napi);
332 }
333 
334 static bool tun_napi_frags_enabled(const struct tun_file *tfile)
335 {
336 	return tfile->napi_frags_enabled;
337 }
338 
339 #ifdef CONFIG_TUN_VNET_CROSS_LE
340 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
341 {
342 	return tun->flags & TUN_VNET_BE ? false :
343 		virtio_legacy_is_little_endian();
344 }
345 
346 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
347 {
348 	int be = !!(tun->flags & TUN_VNET_BE);
349 
350 	if (put_user(be, argp))
351 		return -EFAULT;
352 
353 	return 0;
354 }
355 
356 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
357 {
358 	int be;
359 
360 	if (get_user(be, argp))
361 		return -EFAULT;
362 
363 	if (be)
364 		tun->flags |= TUN_VNET_BE;
365 	else
366 		tun->flags &= ~TUN_VNET_BE;
367 
368 	return 0;
369 }
370 #else
371 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
372 {
373 	return virtio_legacy_is_little_endian();
374 }
375 
376 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
377 {
378 	return -EINVAL;
379 }
380 
381 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
382 {
383 	return -EINVAL;
384 }
385 #endif /* CONFIG_TUN_VNET_CROSS_LE */
386 
387 static inline bool tun_is_little_endian(struct tun_struct *tun)
388 {
389 	return tun->flags & TUN_VNET_LE ||
390 		tun_legacy_is_little_endian(tun);
391 }
392 
393 static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
394 {
395 	return __virtio16_to_cpu(tun_is_little_endian(tun), val);
396 }
397 
398 static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
399 {
400 	return __cpu_to_virtio16(tun_is_little_endian(tun), val);
401 }
402 
403 static inline u32 tun_hashfn(u32 rxhash)
404 {
405 	return rxhash & TUN_MASK_FLOW_ENTRIES;
406 }
407 
408 static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
409 {
410 	struct tun_flow_entry *e;
411 
412 	hlist_for_each_entry_rcu(e, head, hash_link) {
413 		if (e->rxhash == rxhash)
414 			return e;
415 	}
416 	return NULL;
417 }
418 
419 static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
420 					      struct hlist_head *head,
421 					      u32 rxhash, u16 queue_index)
422 {
423 	struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
424 
425 	if (e) {
426 		tun_debug(KERN_INFO, tun, "create flow: hash %u index %u\n",
427 			  rxhash, queue_index);
428 		e->updated = jiffies;
429 		e->rxhash = rxhash;
430 		e->rps_rxhash = 0;
431 		e->queue_index = queue_index;
432 		e->tun = tun;
433 		hlist_add_head_rcu(&e->hash_link, head);
434 		++tun->flow_count;
435 	}
436 	return e;
437 }
438 
439 static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
440 {
441 	tun_debug(KERN_INFO, tun, "delete flow: hash %u index %u\n",
442 		  e->rxhash, e->queue_index);
443 	hlist_del_rcu(&e->hash_link);
444 	kfree_rcu(e, rcu);
445 	--tun->flow_count;
446 }
447 
448 static void tun_flow_flush(struct tun_struct *tun)
449 {
450 	int i;
451 
452 	spin_lock_bh(&tun->lock);
453 	for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
454 		struct tun_flow_entry *e;
455 		struct hlist_node *n;
456 
457 		hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
458 			tun_flow_delete(tun, e);
459 	}
460 	spin_unlock_bh(&tun->lock);
461 }
462 
463 static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
464 {
465 	int i;
466 
467 	spin_lock_bh(&tun->lock);
468 	for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
469 		struct tun_flow_entry *e;
470 		struct hlist_node *n;
471 
472 		hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
473 			if (e->queue_index == queue_index)
474 				tun_flow_delete(tun, e);
475 		}
476 	}
477 	spin_unlock_bh(&tun->lock);
478 }
479 
480 static void tun_flow_cleanup(struct timer_list *t)
481 {
482 	struct tun_struct *tun = from_timer(tun, t, flow_gc_timer);
483 	unsigned long delay = tun->ageing_time;
484 	unsigned long next_timer = jiffies + delay;
485 	unsigned long count = 0;
486 	int i;
487 
488 	tun_debug(KERN_INFO, tun, "tun_flow_cleanup\n");
489 
490 	spin_lock(&tun->lock);
491 	for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
492 		struct tun_flow_entry *e;
493 		struct hlist_node *n;
494 
495 		hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
496 			unsigned long this_timer;
497 
498 			this_timer = e->updated + delay;
499 			if (time_before_eq(this_timer, jiffies)) {
500 				tun_flow_delete(tun, e);
501 				continue;
502 			}
503 			count++;
504 			if (time_before(this_timer, next_timer))
505 				next_timer = this_timer;
506 		}
507 	}
508 
509 	if (count)
510 		mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
511 	spin_unlock(&tun->lock);
512 }
513 
514 static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
515 			    struct tun_file *tfile)
516 {
517 	struct hlist_head *head;
518 	struct tun_flow_entry *e;
519 	unsigned long delay = tun->ageing_time;
520 	u16 queue_index = tfile->queue_index;
521 
522 	head = &tun->flows[tun_hashfn(rxhash)];
523 
524 	rcu_read_lock();
525 
526 	e = tun_flow_find(head, rxhash);
527 	if (likely(e)) {
528 		/* TODO: keep queueing to old queue until it's empty? */
529 		if (READ_ONCE(e->queue_index) != queue_index)
530 			WRITE_ONCE(e->queue_index, queue_index);
531 		if (e->updated != jiffies)
532 			e->updated = jiffies;
533 		sock_rps_record_flow_hash(e->rps_rxhash);
534 	} else {
535 		spin_lock_bh(&tun->lock);
536 		if (!tun_flow_find(head, rxhash) &&
537 		    tun->flow_count < MAX_TAP_FLOWS)
538 			tun_flow_create(tun, head, rxhash, queue_index);
539 
540 		if (!timer_pending(&tun->flow_gc_timer))
541 			mod_timer(&tun->flow_gc_timer,
542 				  round_jiffies_up(jiffies + delay));
543 		spin_unlock_bh(&tun->lock);
544 	}
545 
546 	rcu_read_unlock();
547 }
548 
549 /**
550  * Save the hash received in the stack receive path and update the
551  * flow_hash table accordingly.
552  */
553 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry *e, u32 hash)
554 {
555 	if (unlikely(e->rps_rxhash != hash))
556 		e->rps_rxhash = hash;
557 }
558 
559 /* We try to identify a flow through its rxhash. The reason that
560  * we do not check rxq no. is because some cards(e.g 82599), chooses
561  * the rxq based on the txq where the last packet of the flow comes. As
562  * the userspace application move between processors, we may get a
563  * different rxq no. here.
564  */
565 static u16 tun_automq_select_queue(struct tun_struct *tun, struct sk_buff *skb)
566 {
567 	struct tun_flow_entry *e;
568 	u32 txq = 0;
569 	u32 numqueues = 0;
570 
571 	numqueues = READ_ONCE(tun->numqueues);
572 
573 	txq = __skb_get_hash_symmetric(skb);
574 	e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
575 	if (e) {
576 		tun_flow_save_rps_rxhash(e, txq);
577 		txq = e->queue_index;
578 	} else {
579 		/* use multiply and shift instead of expensive divide */
580 		txq = ((u64)txq * numqueues) >> 32;
581 	}
582 
583 	return txq;
584 }
585 
586 static u16 tun_ebpf_select_queue(struct tun_struct *tun, struct sk_buff *skb)
587 {
588 	struct tun_prog *prog;
589 	u32 numqueues;
590 	u16 ret = 0;
591 
592 	numqueues = READ_ONCE(tun->numqueues);
593 	if (!numqueues)
594 		return 0;
595 
596 	prog = rcu_dereference(tun->steering_prog);
597 	if (prog)
598 		ret = bpf_prog_run_clear_cb(prog->prog, skb);
599 
600 	return ret % numqueues;
601 }
602 
603 static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb,
604 			    struct net_device *sb_dev)
605 {
606 	struct tun_struct *tun = netdev_priv(dev);
607 	u16 ret;
608 
609 	rcu_read_lock();
610 	if (rcu_dereference(tun->steering_prog))
611 		ret = tun_ebpf_select_queue(tun, skb);
612 	else
613 		ret = tun_automq_select_queue(tun, skb);
614 	rcu_read_unlock();
615 
616 	return ret;
617 }
618 
619 static inline bool tun_not_capable(struct tun_struct *tun)
620 {
621 	const struct cred *cred = current_cred();
622 	struct net *net = dev_net(tun->dev);
623 
624 	return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
625 		  (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
626 		!ns_capable(net->user_ns, CAP_NET_ADMIN);
627 }
628 
629 static void tun_set_real_num_queues(struct tun_struct *tun)
630 {
631 	netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
632 	netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
633 }
634 
635 static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
636 {
637 	tfile->detached = tun;
638 	list_add_tail(&tfile->next, &tun->disabled);
639 	++tun->numdisabled;
640 }
641 
642 static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
643 {
644 	struct tun_struct *tun = tfile->detached;
645 
646 	tfile->detached = NULL;
647 	list_del_init(&tfile->next);
648 	--tun->numdisabled;
649 	return tun;
650 }
651 
652 void tun_ptr_free(void *ptr)
653 {
654 	if (!ptr)
655 		return;
656 	if (tun_is_xdp_frame(ptr)) {
657 		struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
658 
659 		xdp_return_frame(xdpf);
660 	} else {
661 		__skb_array_destroy_skb(ptr);
662 	}
663 }
664 EXPORT_SYMBOL_GPL(tun_ptr_free);
665 
666 static void tun_queue_purge(struct tun_file *tfile)
667 {
668 	void *ptr;
669 
670 	while ((ptr = ptr_ring_consume(&tfile->tx_ring)) != NULL)
671 		tun_ptr_free(ptr);
672 
673 	skb_queue_purge(&tfile->sk.sk_write_queue);
674 	skb_queue_purge(&tfile->sk.sk_error_queue);
675 }
676 
677 static void __tun_detach(struct tun_file *tfile, bool clean)
678 {
679 	struct tun_file *ntfile;
680 	struct tun_struct *tun;
681 
682 	tun = rtnl_dereference(tfile->tun);
683 
684 	if (tun && clean) {
685 		tun_napi_disable(tfile);
686 		tun_napi_del(tfile);
687 	}
688 
689 	if (tun && !tfile->detached) {
690 		u16 index = tfile->queue_index;
691 		BUG_ON(index >= tun->numqueues);
692 
693 		rcu_assign_pointer(tun->tfiles[index],
694 				   tun->tfiles[tun->numqueues - 1]);
695 		ntfile = rtnl_dereference(tun->tfiles[index]);
696 		ntfile->queue_index = index;
697 		rcu_assign_pointer(tun->tfiles[tun->numqueues - 1],
698 				   NULL);
699 
700 		--tun->numqueues;
701 		if (clean) {
702 			RCU_INIT_POINTER(tfile->tun, NULL);
703 			sock_put(&tfile->sk);
704 		} else
705 			tun_disable_queue(tun, tfile);
706 
707 		synchronize_net();
708 		tun_flow_delete_by_queue(tun, tun->numqueues + 1);
709 		/* Drop read queue */
710 		tun_queue_purge(tfile);
711 		tun_set_real_num_queues(tun);
712 	} else if (tfile->detached && clean) {
713 		tun = tun_enable_queue(tfile);
714 		sock_put(&tfile->sk);
715 	}
716 
717 	if (clean) {
718 		if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
719 			netif_carrier_off(tun->dev);
720 
721 			if (!(tun->flags & IFF_PERSIST) &&
722 			    tun->dev->reg_state == NETREG_REGISTERED)
723 				unregister_netdevice(tun->dev);
724 		}
725 		if (tun)
726 			xdp_rxq_info_unreg(&tfile->xdp_rxq);
727 		ptr_ring_cleanup(&tfile->tx_ring, tun_ptr_free);
728 		sock_put(&tfile->sk);
729 	}
730 }
731 
732 static void tun_detach(struct tun_file *tfile, bool clean)
733 {
734 	struct tun_struct *tun;
735 	struct net_device *dev;
736 
737 	rtnl_lock();
738 	tun = rtnl_dereference(tfile->tun);
739 	dev = tun ? tun->dev : NULL;
740 	__tun_detach(tfile, clean);
741 	if (dev)
742 		netdev_state_change(dev);
743 	rtnl_unlock();
744 }
745 
746 static void tun_detach_all(struct net_device *dev)
747 {
748 	struct tun_struct *tun = netdev_priv(dev);
749 	struct tun_file *tfile, *tmp;
750 	int i, n = tun->numqueues;
751 
752 	for (i = 0; i < n; i++) {
753 		tfile = rtnl_dereference(tun->tfiles[i]);
754 		BUG_ON(!tfile);
755 		tun_napi_disable(tfile);
756 		tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
757 		tfile->socket.sk->sk_data_ready(tfile->socket.sk);
758 		RCU_INIT_POINTER(tfile->tun, NULL);
759 		--tun->numqueues;
760 	}
761 	list_for_each_entry(tfile, &tun->disabled, next) {
762 		tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
763 		tfile->socket.sk->sk_data_ready(tfile->socket.sk);
764 		RCU_INIT_POINTER(tfile->tun, NULL);
765 	}
766 	BUG_ON(tun->numqueues != 0);
767 
768 	synchronize_net();
769 	for (i = 0; i < n; i++) {
770 		tfile = rtnl_dereference(tun->tfiles[i]);
771 		tun_napi_del(tfile);
772 		/* Drop read queue */
773 		tun_queue_purge(tfile);
774 		xdp_rxq_info_unreg(&tfile->xdp_rxq);
775 		sock_put(&tfile->sk);
776 	}
777 	list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
778 		tun_enable_queue(tfile);
779 		tun_queue_purge(tfile);
780 		xdp_rxq_info_unreg(&tfile->xdp_rxq);
781 		sock_put(&tfile->sk);
782 	}
783 	BUG_ON(tun->numdisabled != 0);
784 
785 	if (tun->flags & IFF_PERSIST)
786 		module_put(THIS_MODULE);
787 }
788 
789 static int tun_attach(struct tun_struct *tun, struct file *file,
790 		      bool skip_filter, bool napi, bool napi_frags,
791 		      bool publish_tun)
792 {
793 	struct tun_file *tfile = file->private_data;
794 	struct net_device *dev = tun->dev;
795 	int err;
796 
797 	err = security_tun_dev_attach(tfile->socket.sk, tun->security);
798 	if (err < 0)
799 		goto out;
800 
801 	err = -EINVAL;
802 	if (rtnl_dereference(tfile->tun) && !tfile->detached)
803 		goto out;
804 
805 	err = -EBUSY;
806 	if (!(tun->flags & IFF_MULTI_QUEUE) && tun->numqueues == 1)
807 		goto out;
808 
809 	err = -E2BIG;
810 	if (!tfile->detached &&
811 	    tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
812 		goto out;
813 
814 	err = 0;
815 
816 	/* Re-attach the filter to persist device */
817 	if (!skip_filter && (tun->filter_attached == true)) {
818 		lock_sock(tfile->socket.sk);
819 		err = sk_attach_filter(&tun->fprog, tfile->socket.sk);
820 		release_sock(tfile->socket.sk);
821 		if (!err)
822 			goto out;
823 	}
824 
825 	if (!tfile->detached &&
826 	    ptr_ring_resize(&tfile->tx_ring, dev->tx_queue_len,
827 			    GFP_KERNEL, tun_ptr_free)) {
828 		err = -ENOMEM;
829 		goto out;
830 	}
831 
832 	tfile->queue_index = tun->numqueues;
833 	tfile->socket.sk->sk_shutdown &= ~RCV_SHUTDOWN;
834 
835 	if (tfile->detached) {
836 		/* Re-attach detached tfile, updating XDP queue_index */
837 		WARN_ON(!xdp_rxq_info_is_reg(&tfile->xdp_rxq));
838 
839 		if (tfile->xdp_rxq.queue_index    != tfile->queue_index)
840 			tfile->xdp_rxq.queue_index = tfile->queue_index;
841 	} else {
842 		/* Setup XDP RX-queue info, for new tfile getting attached */
843 		err = xdp_rxq_info_reg(&tfile->xdp_rxq,
844 				       tun->dev, tfile->queue_index);
845 		if (err < 0)
846 			goto out;
847 		err = xdp_rxq_info_reg_mem_model(&tfile->xdp_rxq,
848 						 MEM_TYPE_PAGE_SHARED, NULL);
849 		if (err < 0) {
850 			xdp_rxq_info_unreg(&tfile->xdp_rxq);
851 			goto out;
852 		}
853 		err = 0;
854 	}
855 
856 	if (tfile->detached) {
857 		tun_enable_queue(tfile);
858 	} else {
859 		sock_hold(&tfile->sk);
860 		tun_napi_init(tun, tfile, napi, napi_frags);
861 	}
862 
863 	if (rtnl_dereference(tun->xdp_prog))
864 		sock_set_flag(&tfile->sk, SOCK_XDP);
865 
866 	/* device is allowed to go away first, so no need to hold extra
867 	 * refcnt.
868 	 */
869 
870 	/* Publish tfile->tun and tun->tfiles only after we've fully
871 	 * initialized tfile; otherwise we risk using half-initialized
872 	 * object.
873 	 */
874 	if (publish_tun)
875 		rcu_assign_pointer(tfile->tun, tun);
876 	rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
877 	tun->numqueues++;
878 	tun_set_real_num_queues(tun);
879 out:
880 	return err;
881 }
882 
883 static struct tun_struct *tun_get(struct tun_file *tfile)
884 {
885 	struct tun_struct *tun;
886 
887 	rcu_read_lock();
888 	tun = rcu_dereference(tfile->tun);
889 	if (tun)
890 		dev_hold(tun->dev);
891 	rcu_read_unlock();
892 
893 	return tun;
894 }
895 
896 static void tun_put(struct tun_struct *tun)
897 {
898 	dev_put(tun->dev);
899 }
900 
901 /* TAP filtering */
902 static void addr_hash_set(u32 *mask, const u8 *addr)
903 {
904 	int n = ether_crc(ETH_ALEN, addr) >> 26;
905 	mask[n >> 5] |= (1 << (n & 31));
906 }
907 
908 static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
909 {
910 	int n = ether_crc(ETH_ALEN, addr) >> 26;
911 	return mask[n >> 5] & (1 << (n & 31));
912 }
913 
914 static int update_filter(struct tap_filter *filter, void __user *arg)
915 {
916 	struct { u8 u[ETH_ALEN]; } *addr;
917 	struct tun_filter uf;
918 	int err, alen, n, nexact;
919 
920 	if (copy_from_user(&uf, arg, sizeof(uf)))
921 		return -EFAULT;
922 
923 	if (!uf.count) {
924 		/* Disabled */
925 		filter->count = 0;
926 		return 0;
927 	}
928 
929 	alen = ETH_ALEN * uf.count;
930 	addr = memdup_user(arg + sizeof(uf), alen);
931 	if (IS_ERR(addr))
932 		return PTR_ERR(addr);
933 
934 	/* The filter is updated without holding any locks. Which is
935 	 * perfectly safe. We disable it first and in the worst
936 	 * case we'll accept a few undesired packets. */
937 	filter->count = 0;
938 	wmb();
939 
940 	/* Use first set of addresses as an exact filter */
941 	for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
942 		memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
943 
944 	nexact = n;
945 
946 	/* Remaining multicast addresses are hashed,
947 	 * unicast will leave the filter disabled. */
948 	memset(filter->mask, 0, sizeof(filter->mask));
949 	for (; n < uf.count; n++) {
950 		if (!is_multicast_ether_addr(addr[n].u)) {
951 			err = 0; /* no filter */
952 			goto free_addr;
953 		}
954 		addr_hash_set(filter->mask, addr[n].u);
955 	}
956 
957 	/* For ALLMULTI just set the mask to all ones.
958 	 * This overrides the mask populated above. */
959 	if ((uf.flags & TUN_FLT_ALLMULTI))
960 		memset(filter->mask, ~0, sizeof(filter->mask));
961 
962 	/* Now enable the filter */
963 	wmb();
964 	filter->count = nexact;
965 
966 	/* Return the number of exact filters */
967 	err = nexact;
968 free_addr:
969 	kfree(addr);
970 	return err;
971 }
972 
973 /* Returns: 0 - drop, !=0 - accept */
974 static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
975 {
976 	/* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
977 	 * at this point. */
978 	struct ethhdr *eh = (struct ethhdr *) skb->data;
979 	int i;
980 
981 	/* Exact match */
982 	for (i = 0; i < filter->count; i++)
983 		if (ether_addr_equal(eh->h_dest, filter->addr[i]))
984 			return 1;
985 
986 	/* Inexact match (multicast only) */
987 	if (is_multicast_ether_addr(eh->h_dest))
988 		return addr_hash_test(filter->mask, eh->h_dest);
989 
990 	return 0;
991 }
992 
993 /*
994  * Checks whether the packet is accepted or not.
995  * Returns: 0 - drop, !=0 - accept
996  */
997 static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
998 {
999 	if (!filter->count)
1000 		return 1;
1001 
1002 	return run_filter(filter, skb);
1003 }
1004 
1005 /* Network device part of the driver */
1006 
1007 static const struct ethtool_ops tun_ethtool_ops;
1008 
1009 /* Net device detach from fd. */
1010 static void tun_net_uninit(struct net_device *dev)
1011 {
1012 	tun_detach_all(dev);
1013 }
1014 
1015 /* Net device open. */
1016 static int tun_net_open(struct net_device *dev)
1017 {
1018 	netif_tx_start_all_queues(dev);
1019 
1020 	return 0;
1021 }
1022 
1023 /* Net device close. */
1024 static int tun_net_close(struct net_device *dev)
1025 {
1026 	netif_tx_stop_all_queues(dev);
1027 	return 0;
1028 }
1029 
1030 /* Net device start xmit */
1031 static void tun_automq_xmit(struct tun_struct *tun, struct sk_buff *skb)
1032 {
1033 #ifdef CONFIG_RPS
1034 	if (tun->numqueues == 1 && static_branch_unlikely(&rps_needed)) {
1035 		/* Select queue was not called for the skbuff, so we extract the
1036 		 * RPS hash and save it into the flow_table here.
1037 		 */
1038 		struct tun_flow_entry *e;
1039 		__u32 rxhash;
1040 
1041 		rxhash = __skb_get_hash_symmetric(skb);
1042 		e = tun_flow_find(&tun->flows[tun_hashfn(rxhash)], rxhash);
1043 		if (e)
1044 			tun_flow_save_rps_rxhash(e, rxhash);
1045 	}
1046 #endif
1047 }
1048 
1049 static unsigned int run_ebpf_filter(struct tun_struct *tun,
1050 				    struct sk_buff *skb,
1051 				    int len)
1052 {
1053 	struct tun_prog *prog = rcu_dereference(tun->filter_prog);
1054 
1055 	if (prog)
1056 		len = bpf_prog_run_clear_cb(prog->prog, skb);
1057 
1058 	return len;
1059 }
1060 
1061 /* Net device start xmit */
1062 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
1063 {
1064 	struct tun_struct *tun = netdev_priv(dev);
1065 	int txq = skb->queue_mapping;
1066 	struct tun_file *tfile;
1067 	int len = skb->len;
1068 
1069 	rcu_read_lock();
1070 	tfile = rcu_dereference(tun->tfiles[txq]);
1071 
1072 	/* Drop packet if interface is not attached */
1073 	if (!tfile)
1074 		goto drop;
1075 
1076 	if (!rcu_dereference(tun->steering_prog))
1077 		tun_automq_xmit(tun, skb);
1078 
1079 	tun_debug(KERN_INFO, tun, "tun_net_xmit %d\n", skb->len);
1080 
1081 	/* Drop if the filter does not like it.
1082 	 * This is a noop if the filter is disabled.
1083 	 * Filter can be enabled only for the TAP devices. */
1084 	if (!check_filter(&tun->txflt, skb))
1085 		goto drop;
1086 
1087 	if (tfile->socket.sk->sk_filter &&
1088 	    sk_filter(tfile->socket.sk, skb))
1089 		goto drop;
1090 
1091 	len = run_ebpf_filter(tun, skb, len);
1092 	if (len == 0 || pskb_trim(skb, len))
1093 		goto drop;
1094 
1095 	if (unlikely(skb_orphan_frags_rx(skb, GFP_ATOMIC)))
1096 		goto drop;
1097 
1098 	skb_tx_timestamp(skb);
1099 
1100 	/* Orphan the skb - required as we might hang on to it
1101 	 * for indefinite time.
1102 	 */
1103 	skb_orphan(skb);
1104 
1105 	nf_reset_ct(skb);
1106 
1107 	if (ptr_ring_produce(&tfile->tx_ring, skb))
1108 		goto drop;
1109 
1110 	/* Notify and wake up reader process */
1111 	if (tfile->flags & TUN_FASYNC)
1112 		kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1113 	tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1114 
1115 	rcu_read_unlock();
1116 	return NETDEV_TX_OK;
1117 
1118 drop:
1119 	this_cpu_inc(tun->pcpu_stats->tx_dropped);
1120 	skb_tx_error(skb);
1121 	kfree_skb(skb);
1122 	rcu_read_unlock();
1123 	return NET_XMIT_DROP;
1124 }
1125 
1126 static void tun_net_mclist(struct net_device *dev)
1127 {
1128 	/*
1129 	 * This callback is supposed to deal with mc filter in
1130 	 * _rx_ path and has nothing to do with the _tx_ path.
1131 	 * In rx path we always accept everything userspace gives us.
1132 	 */
1133 }
1134 
1135 static netdev_features_t tun_net_fix_features(struct net_device *dev,
1136 	netdev_features_t features)
1137 {
1138 	struct tun_struct *tun = netdev_priv(dev);
1139 
1140 	return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
1141 }
1142 
1143 static void tun_set_headroom(struct net_device *dev, int new_hr)
1144 {
1145 	struct tun_struct *tun = netdev_priv(dev);
1146 
1147 	if (new_hr < NET_SKB_PAD)
1148 		new_hr = NET_SKB_PAD;
1149 
1150 	tun->align = new_hr;
1151 }
1152 
1153 static void
1154 tun_net_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats)
1155 {
1156 	u32 rx_dropped = 0, tx_dropped = 0, rx_frame_errors = 0;
1157 	struct tun_struct *tun = netdev_priv(dev);
1158 	struct tun_pcpu_stats *p;
1159 	int i;
1160 
1161 	for_each_possible_cpu(i) {
1162 		u64 rxpackets, rxbytes, txpackets, txbytes;
1163 		unsigned int start;
1164 
1165 		p = per_cpu_ptr(tun->pcpu_stats, i);
1166 		do {
1167 			start = u64_stats_fetch_begin(&p->syncp);
1168 			rxpackets	= u64_stats_read(&p->rx_packets);
1169 			rxbytes		= u64_stats_read(&p->rx_bytes);
1170 			txpackets	= u64_stats_read(&p->tx_packets);
1171 			txbytes		= u64_stats_read(&p->tx_bytes);
1172 		} while (u64_stats_fetch_retry(&p->syncp, start));
1173 
1174 		stats->rx_packets	+= rxpackets;
1175 		stats->rx_bytes		+= rxbytes;
1176 		stats->tx_packets	+= txpackets;
1177 		stats->tx_bytes		+= txbytes;
1178 
1179 		/* u32 counters */
1180 		rx_dropped	+= p->rx_dropped;
1181 		rx_frame_errors	+= p->rx_frame_errors;
1182 		tx_dropped	+= p->tx_dropped;
1183 	}
1184 	stats->rx_dropped  = rx_dropped;
1185 	stats->rx_frame_errors = rx_frame_errors;
1186 	stats->tx_dropped = tx_dropped;
1187 }
1188 
1189 static int tun_xdp_set(struct net_device *dev, struct bpf_prog *prog,
1190 		       struct netlink_ext_ack *extack)
1191 {
1192 	struct tun_struct *tun = netdev_priv(dev);
1193 	struct tun_file *tfile;
1194 	struct bpf_prog *old_prog;
1195 	int i;
1196 
1197 	old_prog = rtnl_dereference(tun->xdp_prog);
1198 	rcu_assign_pointer(tun->xdp_prog, prog);
1199 	if (old_prog)
1200 		bpf_prog_put(old_prog);
1201 
1202 	for (i = 0; i < tun->numqueues; i++) {
1203 		tfile = rtnl_dereference(tun->tfiles[i]);
1204 		if (prog)
1205 			sock_set_flag(&tfile->sk, SOCK_XDP);
1206 		else
1207 			sock_reset_flag(&tfile->sk, SOCK_XDP);
1208 	}
1209 	list_for_each_entry(tfile, &tun->disabled, next) {
1210 		if (prog)
1211 			sock_set_flag(&tfile->sk, SOCK_XDP);
1212 		else
1213 			sock_reset_flag(&tfile->sk, SOCK_XDP);
1214 	}
1215 
1216 	return 0;
1217 }
1218 
1219 static u32 tun_xdp_query(struct net_device *dev)
1220 {
1221 	struct tun_struct *tun = netdev_priv(dev);
1222 	const struct bpf_prog *xdp_prog;
1223 
1224 	xdp_prog = rtnl_dereference(tun->xdp_prog);
1225 	if (xdp_prog)
1226 		return xdp_prog->aux->id;
1227 
1228 	return 0;
1229 }
1230 
1231 static int tun_xdp(struct net_device *dev, struct netdev_bpf *xdp)
1232 {
1233 	switch (xdp->command) {
1234 	case XDP_SETUP_PROG:
1235 		return tun_xdp_set(dev, xdp->prog, xdp->extack);
1236 	case XDP_QUERY_PROG:
1237 		xdp->prog_id = tun_xdp_query(dev);
1238 		return 0;
1239 	default:
1240 		return -EINVAL;
1241 	}
1242 }
1243 
1244 static int tun_net_change_carrier(struct net_device *dev, bool new_carrier)
1245 {
1246 	if (new_carrier) {
1247 		struct tun_struct *tun = netdev_priv(dev);
1248 
1249 		if (!tun->numqueues)
1250 			return -EPERM;
1251 
1252 		netif_carrier_on(dev);
1253 	} else {
1254 		netif_carrier_off(dev);
1255 	}
1256 	return 0;
1257 }
1258 
1259 static const struct net_device_ops tun_netdev_ops = {
1260 	.ndo_uninit		= tun_net_uninit,
1261 	.ndo_open		= tun_net_open,
1262 	.ndo_stop		= tun_net_close,
1263 	.ndo_start_xmit		= tun_net_xmit,
1264 	.ndo_fix_features	= tun_net_fix_features,
1265 	.ndo_select_queue	= tun_select_queue,
1266 	.ndo_set_rx_headroom	= tun_set_headroom,
1267 	.ndo_get_stats64	= tun_net_get_stats64,
1268 	.ndo_change_carrier	= tun_net_change_carrier,
1269 };
1270 
1271 static void __tun_xdp_flush_tfile(struct tun_file *tfile)
1272 {
1273 	/* Notify and wake up reader process */
1274 	if (tfile->flags & TUN_FASYNC)
1275 		kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1276 	tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1277 }
1278 
1279 static int tun_xdp_xmit(struct net_device *dev, int n,
1280 			struct xdp_frame **frames, u32 flags)
1281 {
1282 	struct tun_struct *tun = netdev_priv(dev);
1283 	struct tun_file *tfile;
1284 	u32 numqueues;
1285 	int drops = 0;
1286 	int cnt = n;
1287 	int i;
1288 
1289 	if (unlikely(flags & ~XDP_XMIT_FLAGS_MASK))
1290 		return -EINVAL;
1291 
1292 	rcu_read_lock();
1293 
1294 resample:
1295 	numqueues = READ_ONCE(tun->numqueues);
1296 	if (!numqueues) {
1297 		rcu_read_unlock();
1298 		return -ENXIO; /* Caller will free/return all frames */
1299 	}
1300 
1301 	tfile = rcu_dereference(tun->tfiles[smp_processor_id() %
1302 					    numqueues]);
1303 	if (unlikely(!tfile))
1304 		goto resample;
1305 
1306 	spin_lock(&tfile->tx_ring.producer_lock);
1307 	for (i = 0; i < n; i++) {
1308 		struct xdp_frame *xdp = frames[i];
1309 		/* Encode the XDP flag into lowest bit for consumer to differ
1310 		 * XDP buffer from sk_buff.
1311 		 */
1312 		void *frame = tun_xdp_to_ptr(xdp);
1313 
1314 		if (__ptr_ring_produce(&tfile->tx_ring, frame)) {
1315 			this_cpu_inc(tun->pcpu_stats->tx_dropped);
1316 			xdp_return_frame_rx_napi(xdp);
1317 			drops++;
1318 		}
1319 	}
1320 	spin_unlock(&tfile->tx_ring.producer_lock);
1321 
1322 	if (flags & XDP_XMIT_FLUSH)
1323 		__tun_xdp_flush_tfile(tfile);
1324 
1325 	rcu_read_unlock();
1326 	return cnt - drops;
1327 }
1328 
1329 static int tun_xdp_tx(struct net_device *dev, struct xdp_buff *xdp)
1330 {
1331 	struct xdp_frame *frame = convert_to_xdp_frame(xdp);
1332 
1333 	if (unlikely(!frame))
1334 		return -EOVERFLOW;
1335 
1336 	return tun_xdp_xmit(dev, 1, &frame, XDP_XMIT_FLUSH);
1337 }
1338 
1339 static const struct net_device_ops tap_netdev_ops = {
1340 	.ndo_uninit		= tun_net_uninit,
1341 	.ndo_open		= tun_net_open,
1342 	.ndo_stop		= tun_net_close,
1343 	.ndo_start_xmit		= tun_net_xmit,
1344 	.ndo_fix_features	= tun_net_fix_features,
1345 	.ndo_set_rx_mode	= tun_net_mclist,
1346 	.ndo_set_mac_address	= eth_mac_addr,
1347 	.ndo_validate_addr	= eth_validate_addr,
1348 	.ndo_select_queue	= tun_select_queue,
1349 	.ndo_features_check	= passthru_features_check,
1350 	.ndo_set_rx_headroom	= tun_set_headroom,
1351 	.ndo_get_stats64	= tun_net_get_stats64,
1352 	.ndo_bpf		= tun_xdp,
1353 	.ndo_xdp_xmit		= tun_xdp_xmit,
1354 	.ndo_change_carrier	= tun_net_change_carrier,
1355 };
1356 
1357 static void tun_flow_init(struct tun_struct *tun)
1358 {
1359 	int i;
1360 
1361 	for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
1362 		INIT_HLIST_HEAD(&tun->flows[i]);
1363 
1364 	tun->ageing_time = TUN_FLOW_EXPIRE;
1365 	timer_setup(&tun->flow_gc_timer, tun_flow_cleanup, 0);
1366 	mod_timer(&tun->flow_gc_timer,
1367 		  round_jiffies_up(jiffies + tun->ageing_time));
1368 }
1369 
1370 static void tun_flow_uninit(struct tun_struct *tun)
1371 {
1372 	del_timer_sync(&tun->flow_gc_timer);
1373 	tun_flow_flush(tun);
1374 }
1375 
1376 #define MIN_MTU 68
1377 #define MAX_MTU 65535
1378 
1379 /* Initialize net device. */
1380 static void tun_net_init(struct net_device *dev)
1381 {
1382 	struct tun_struct *tun = netdev_priv(dev);
1383 
1384 	switch (tun->flags & TUN_TYPE_MASK) {
1385 	case IFF_TUN:
1386 		dev->netdev_ops = &tun_netdev_ops;
1387 
1388 		/* Point-to-Point TUN Device */
1389 		dev->hard_header_len = 0;
1390 		dev->addr_len = 0;
1391 		dev->mtu = 1500;
1392 
1393 		/* Zero header length */
1394 		dev->type = ARPHRD_NONE;
1395 		dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
1396 		break;
1397 
1398 	case IFF_TAP:
1399 		dev->netdev_ops = &tap_netdev_ops;
1400 		/* Ethernet TAP Device */
1401 		ether_setup(dev);
1402 		dev->priv_flags &= ~IFF_TX_SKB_SHARING;
1403 		dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
1404 
1405 		eth_hw_addr_random(dev);
1406 
1407 		break;
1408 	}
1409 
1410 	dev->min_mtu = MIN_MTU;
1411 	dev->max_mtu = MAX_MTU - dev->hard_header_len;
1412 }
1413 
1414 static bool tun_sock_writeable(struct tun_struct *tun, struct tun_file *tfile)
1415 {
1416 	struct sock *sk = tfile->socket.sk;
1417 
1418 	return (tun->dev->flags & IFF_UP) && sock_writeable(sk);
1419 }
1420 
1421 /* Character device part */
1422 
1423 /* Poll */
1424 static __poll_t tun_chr_poll(struct file *file, poll_table *wait)
1425 {
1426 	struct tun_file *tfile = file->private_data;
1427 	struct tun_struct *tun = tun_get(tfile);
1428 	struct sock *sk;
1429 	__poll_t mask = 0;
1430 
1431 	if (!tun)
1432 		return EPOLLERR;
1433 
1434 	sk = tfile->socket.sk;
1435 
1436 	tun_debug(KERN_INFO, tun, "tun_chr_poll\n");
1437 
1438 	poll_wait(file, sk_sleep(sk), wait);
1439 
1440 	if (!ptr_ring_empty(&tfile->tx_ring))
1441 		mask |= EPOLLIN | EPOLLRDNORM;
1442 
1443 	/* Make sure SOCKWQ_ASYNC_NOSPACE is set if not writable to
1444 	 * guarantee EPOLLOUT to be raised by either here or
1445 	 * tun_sock_write_space(). Then process could get notification
1446 	 * after it writes to a down device and meets -EIO.
1447 	 */
1448 	if (tun_sock_writeable(tun, tfile) ||
1449 	    (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
1450 	     tun_sock_writeable(tun, tfile)))
1451 		mask |= EPOLLOUT | EPOLLWRNORM;
1452 
1453 	if (tun->dev->reg_state != NETREG_REGISTERED)
1454 		mask = EPOLLERR;
1455 
1456 	tun_put(tun);
1457 	return mask;
1458 }
1459 
1460 static struct sk_buff *tun_napi_alloc_frags(struct tun_file *tfile,
1461 					    size_t len,
1462 					    const struct iov_iter *it)
1463 {
1464 	struct sk_buff *skb;
1465 	size_t linear;
1466 	int err;
1467 	int i;
1468 
1469 	if (it->nr_segs > MAX_SKB_FRAGS + 1)
1470 		return ERR_PTR(-ENOMEM);
1471 
1472 	local_bh_disable();
1473 	skb = napi_get_frags(&tfile->napi);
1474 	local_bh_enable();
1475 	if (!skb)
1476 		return ERR_PTR(-ENOMEM);
1477 
1478 	linear = iov_iter_single_seg_count(it);
1479 	err = __skb_grow(skb, linear);
1480 	if (err)
1481 		goto free;
1482 
1483 	skb->len = len;
1484 	skb->data_len = len - linear;
1485 	skb->truesize += skb->data_len;
1486 
1487 	for (i = 1; i < it->nr_segs; i++) {
1488 		size_t fragsz = it->iov[i].iov_len;
1489 		struct page *page;
1490 		void *frag;
1491 
1492 		if (fragsz == 0 || fragsz > PAGE_SIZE) {
1493 			err = -EINVAL;
1494 			goto free;
1495 		}
1496 		frag = netdev_alloc_frag(fragsz);
1497 		if (!frag) {
1498 			err = -ENOMEM;
1499 			goto free;
1500 		}
1501 		page = virt_to_head_page(frag);
1502 		skb_fill_page_desc(skb, i - 1, page,
1503 				   frag - page_address(page), fragsz);
1504 	}
1505 
1506 	return skb;
1507 free:
1508 	/* frees skb and all frags allocated with napi_alloc_frag() */
1509 	napi_free_frags(&tfile->napi);
1510 	return ERR_PTR(err);
1511 }
1512 
1513 /* prepad is the amount to reserve at front.  len is length after that.
1514  * linear is a hint as to how much to copy (usually headers). */
1515 static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
1516 				     size_t prepad, size_t len,
1517 				     size_t linear, int noblock)
1518 {
1519 	struct sock *sk = tfile->socket.sk;
1520 	struct sk_buff *skb;
1521 	int err;
1522 
1523 	/* Under a page?  Don't bother with paged skb. */
1524 	if (prepad + len < PAGE_SIZE || !linear)
1525 		linear = len;
1526 
1527 	skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
1528 				   &err, 0);
1529 	if (!skb)
1530 		return ERR_PTR(err);
1531 
1532 	skb_reserve(skb, prepad);
1533 	skb_put(skb, linear);
1534 	skb->data_len = len - linear;
1535 	skb->len += len - linear;
1536 
1537 	return skb;
1538 }
1539 
1540 static void tun_rx_batched(struct tun_struct *tun, struct tun_file *tfile,
1541 			   struct sk_buff *skb, int more)
1542 {
1543 	struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1544 	struct sk_buff_head process_queue;
1545 	u32 rx_batched = tun->rx_batched;
1546 	bool rcv = false;
1547 
1548 	if (!rx_batched || (!more && skb_queue_empty(queue))) {
1549 		local_bh_disable();
1550 		skb_record_rx_queue(skb, tfile->queue_index);
1551 		netif_receive_skb(skb);
1552 		local_bh_enable();
1553 		return;
1554 	}
1555 
1556 	spin_lock(&queue->lock);
1557 	if (!more || skb_queue_len(queue) == rx_batched) {
1558 		__skb_queue_head_init(&process_queue);
1559 		skb_queue_splice_tail_init(queue, &process_queue);
1560 		rcv = true;
1561 	} else {
1562 		__skb_queue_tail(queue, skb);
1563 	}
1564 	spin_unlock(&queue->lock);
1565 
1566 	if (rcv) {
1567 		struct sk_buff *nskb;
1568 
1569 		local_bh_disable();
1570 		while ((nskb = __skb_dequeue(&process_queue))) {
1571 			skb_record_rx_queue(nskb, tfile->queue_index);
1572 			netif_receive_skb(nskb);
1573 		}
1574 		skb_record_rx_queue(skb, tfile->queue_index);
1575 		netif_receive_skb(skb);
1576 		local_bh_enable();
1577 	}
1578 }
1579 
1580 static bool tun_can_build_skb(struct tun_struct *tun, struct tun_file *tfile,
1581 			      int len, int noblock, bool zerocopy)
1582 {
1583 	if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
1584 		return false;
1585 
1586 	if (tfile->socket.sk->sk_sndbuf != INT_MAX)
1587 		return false;
1588 
1589 	if (!noblock)
1590 		return false;
1591 
1592 	if (zerocopy)
1593 		return false;
1594 
1595 	if (SKB_DATA_ALIGN(len + TUN_RX_PAD) +
1596 	    SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
1597 		return false;
1598 
1599 	return true;
1600 }
1601 
1602 static struct sk_buff *__tun_build_skb(struct tun_file *tfile,
1603 				       struct page_frag *alloc_frag, char *buf,
1604 				       int buflen, int len, int pad)
1605 {
1606 	struct sk_buff *skb = build_skb(buf, buflen);
1607 
1608 	if (!skb)
1609 		return ERR_PTR(-ENOMEM);
1610 
1611 	skb_reserve(skb, pad);
1612 	skb_put(skb, len);
1613 	skb_set_owner_w(skb, tfile->socket.sk);
1614 
1615 	get_page(alloc_frag->page);
1616 	alloc_frag->offset += buflen;
1617 
1618 	return skb;
1619 }
1620 
1621 static int tun_xdp_act(struct tun_struct *tun, struct bpf_prog *xdp_prog,
1622 		       struct xdp_buff *xdp, u32 act)
1623 {
1624 	int err;
1625 
1626 	switch (act) {
1627 	case XDP_REDIRECT:
1628 		err = xdp_do_redirect(tun->dev, xdp, xdp_prog);
1629 		if (err)
1630 			return err;
1631 		break;
1632 	case XDP_TX:
1633 		err = tun_xdp_tx(tun->dev, xdp);
1634 		if (err < 0)
1635 			return err;
1636 		break;
1637 	case XDP_PASS:
1638 		break;
1639 	default:
1640 		bpf_warn_invalid_xdp_action(act);
1641 		/* fall through */
1642 	case XDP_ABORTED:
1643 		trace_xdp_exception(tun->dev, xdp_prog, act);
1644 		/* fall through */
1645 	case XDP_DROP:
1646 		this_cpu_inc(tun->pcpu_stats->rx_dropped);
1647 		break;
1648 	}
1649 
1650 	return act;
1651 }
1652 
1653 static struct sk_buff *tun_build_skb(struct tun_struct *tun,
1654 				     struct tun_file *tfile,
1655 				     struct iov_iter *from,
1656 				     struct virtio_net_hdr *hdr,
1657 				     int len, int *skb_xdp)
1658 {
1659 	struct page_frag *alloc_frag = &current->task_frag;
1660 	struct bpf_prog *xdp_prog;
1661 	int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
1662 	char *buf;
1663 	size_t copied;
1664 	int pad = TUN_RX_PAD;
1665 	int err = 0;
1666 
1667 	rcu_read_lock();
1668 	xdp_prog = rcu_dereference(tun->xdp_prog);
1669 	if (xdp_prog)
1670 		pad += XDP_PACKET_HEADROOM;
1671 	buflen += SKB_DATA_ALIGN(len + pad);
1672 	rcu_read_unlock();
1673 
1674 	alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
1675 	if (unlikely(!skb_page_frag_refill(buflen, alloc_frag, GFP_KERNEL)))
1676 		return ERR_PTR(-ENOMEM);
1677 
1678 	buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
1679 	copied = copy_page_from_iter(alloc_frag->page,
1680 				     alloc_frag->offset + pad,
1681 				     len, from);
1682 	if (copied != len)
1683 		return ERR_PTR(-EFAULT);
1684 
1685 	/* There's a small window that XDP may be set after the check
1686 	 * of xdp_prog above, this should be rare and for simplicity
1687 	 * we do XDP on skb in case the headroom is not enough.
1688 	 */
1689 	if (hdr->gso_type || !xdp_prog) {
1690 		*skb_xdp = 1;
1691 		return __tun_build_skb(tfile, alloc_frag, buf, buflen, len,
1692 				       pad);
1693 	}
1694 
1695 	*skb_xdp = 0;
1696 
1697 	local_bh_disable();
1698 	rcu_read_lock();
1699 	xdp_prog = rcu_dereference(tun->xdp_prog);
1700 	if (xdp_prog) {
1701 		struct xdp_buff xdp;
1702 		u32 act;
1703 
1704 		xdp.data_hard_start = buf;
1705 		xdp.data = buf + pad;
1706 		xdp_set_data_meta_invalid(&xdp);
1707 		xdp.data_end = xdp.data + len;
1708 		xdp.rxq = &tfile->xdp_rxq;
1709 
1710 		act = bpf_prog_run_xdp(xdp_prog, &xdp);
1711 		if (act == XDP_REDIRECT || act == XDP_TX) {
1712 			get_page(alloc_frag->page);
1713 			alloc_frag->offset += buflen;
1714 		}
1715 		err = tun_xdp_act(tun, xdp_prog, &xdp, act);
1716 		if (err < 0)
1717 			goto err_xdp;
1718 		if (err == XDP_REDIRECT)
1719 			xdp_do_flush();
1720 		if (err != XDP_PASS)
1721 			goto out;
1722 
1723 		pad = xdp.data - xdp.data_hard_start;
1724 		len = xdp.data_end - xdp.data;
1725 	}
1726 	rcu_read_unlock();
1727 	local_bh_enable();
1728 
1729 	return __tun_build_skb(tfile, alloc_frag, buf, buflen, len, pad);
1730 
1731 err_xdp:
1732 	put_page(alloc_frag->page);
1733 out:
1734 	rcu_read_unlock();
1735 	local_bh_enable();
1736 	return NULL;
1737 }
1738 
1739 /* Get packet from user space buffer */
1740 static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
1741 			    void *msg_control, struct iov_iter *from,
1742 			    int noblock, bool more)
1743 {
1744 	struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1745 	struct sk_buff *skb;
1746 	size_t total_len = iov_iter_count(from);
1747 	size_t len = total_len, align = tun->align, linear;
1748 	struct virtio_net_hdr gso = { 0 };
1749 	struct tun_pcpu_stats *stats;
1750 	int good_linear;
1751 	int copylen;
1752 	bool zerocopy = false;
1753 	int err;
1754 	u32 rxhash = 0;
1755 	int skb_xdp = 1;
1756 	bool frags = tun_napi_frags_enabled(tfile);
1757 
1758 	if (!(tun->flags & IFF_NO_PI)) {
1759 		if (len < sizeof(pi))
1760 			return -EINVAL;
1761 		len -= sizeof(pi);
1762 
1763 		if (!copy_from_iter_full(&pi, sizeof(pi), from))
1764 			return -EFAULT;
1765 	}
1766 
1767 	if (tun->flags & IFF_VNET_HDR) {
1768 		int vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1769 
1770 		if (len < vnet_hdr_sz)
1771 			return -EINVAL;
1772 		len -= vnet_hdr_sz;
1773 
1774 		if (!copy_from_iter_full(&gso, sizeof(gso), from))
1775 			return -EFAULT;
1776 
1777 		if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
1778 		    tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1779 			gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
1780 
1781 		if (tun16_to_cpu(tun, gso.hdr_len) > len)
1782 			return -EINVAL;
1783 		iov_iter_advance(from, vnet_hdr_sz - sizeof(gso));
1784 	}
1785 
1786 	if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
1787 		align += NET_IP_ALIGN;
1788 		if (unlikely(len < ETH_HLEN ||
1789 			     (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
1790 			return -EINVAL;
1791 	}
1792 
1793 	good_linear = SKB_MAX_HEAD(align);
1794 
1795 	if (msg_control) {
1796 		struct iov_iter i = *from;
1797 
1798 		/* There are 256 bytes to be copied in skb, so there is
1799 		 * enough room for skb expand head in case it is used.
1800 		 * The rest of the buffer is mapped from userspace.
1801 		 */
1802 		copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
1803 		if (copylen > good_linear)
1804 			copylen = good_linear;
1805 		linear = copylen;
1806 		iov_iter_advance(&i, copylen);
1807 		if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
1808 			zerocopy = true;
1809 	}
1810 
1811 	if (!frags && tun_can_build_skb(tun, tfile, len, noblock, zerocopy)) {
1812 		/* For the packet that is not easy to be processed
1813 		 * (e.g gso or jumbo packet), we will do it at after
1814 		 * skb was created with generic XDP routine.
1815 		 */
1816 		skb = tun_build_skb(tun, tfile, from, &gso, len, &skb_xdp);
1817 		if (IS_ERR(skb)) {
1818 			this_cpu_inc(tun->pcpu_stats->rx_dropped);
1819 			return PTR_ERR(skb);
1820 		}
1821 		if (!skb)
1822 			return total_len;
1823 	} else {
1824 		if (!zerocopy) {
1825 			copylen = len;
1826 			if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1827 				linear = good_linear;
1828 			else
1829 				linear = tun16_to_cpu(tun, gso.hdr_len);
1830 		}
1831 
1832 		if (frags) {
1833 			mutex_lock(&tfile->napi_mutex);
1834 			skb = tun_napi_alloc_frags(tfile, copylen, from);
1835 			/* tun_napi_alloc_frags() enforces a layout for the skb.
1836 			 * If zerocopy is enabled, then this layout will be
1837 			 * overwritten by zerocopy_sg_from_iter().
1838 			 */
1839 			zerocopy = false;
1840 		} else {
1841 			skb = tun_alloc_skb(tfile, align, copylen, linear,
1842 					    noblock);
1843 		}
1844 
1845 		if (IS_ERR(skb)) {
1846 			if (PTR_ERR(skb) != -EAGAIN)
1847 				this_cpu_inc(tun->pcpu_stats->rx_dropped);
1848 			if (frags)
1849 				mutex_unlock(&tfile->napi_mutex);
1850 			return PTR_ERR(skb);
1851 		}
1852 
1853 		if (zerocopy)
1854 			err = zerocopy_sg_from_iter(skb, from);
1855 		else
1856 			err = skb_copy_datagram_from_iter(skb, 0, from, len);
1857 
1858 		if (err) {
1859 			err = -EFAULT;
1860 drop:
1861 			this_cpu_inc(tun->pcpu_stats->rx_dropped);
1862 			kfree_skb(skb);
1863 			if (frags) {
1864 				tfile->napi.skb = NULL;
1865 				mutex_unlock(&tfile->napi_mutex);
1866 			}
1867 
1868 			return err;
1869 		}
1870 	}
1871 
1872 	if (virtio_net_hdr_to_skb(skb, &gso, tun_is_little_endian(tun))) {
1873 		this_cpu_inc(tun->pcpu_stats->rx_frame_errors);
1874 		kfree_skb(skb);
1875 		if (frags) {
1876 			tfile->napi.skb = NULL;
1877 			mutex_unlock(&tfile->napi_mutex);
1878 		}
1879 
1880 		return -EINVAL;
1881 	}
1882 
1883 	switch (tun->flags & TUN_TYPE_MASK) {
1884 	case IFF_TUN:
1885 		if (tun->flags & IFF_NO_PI) {
1886 			u8 ip_version = skb->len ? (skb->data[0] >> 4) : 0;
1887 
1888 			switch (ip_version) {
1889 			case 4:
1890 				pi.proto = htons(ETH_P_IP);
1891 				break;
1892 			case 6:
1893 				pi.proto = htons(ETH_P_IPV6);
1894 				break;
1895 			default:
1896 				this_cpu_inc(tun->pcpu_stats->rx_dropped);
1897 				kfree_skb(skb);
1898 				return -EINVAL;
1899 			}
1900 		}
1901 
1902 		skb_reset_mac_header(skb);
1903 		skb->protocol = pi.proto;
1904 		skb->dev = tun->dev;
1905 		break;
1906 	case IFF_TAP:
1907 		if (!frags)
1908 			skb->protocol = eth_type_trans(skb, tun->dev);
1909 		break;
1910 	}
1911 
1912 	/* copy skb_ubuf_info for callback when skb has no error */
1913 	if (zerocopy) {
1914 		skb_shinfo(skb)->destructor_arg = msg_control;
1915 		skb_shinfo(skb)->tx_flags |= SKBTX_DEV_ZEROCOPY;
1916 		skb_shinfo(skb)->tx_flags |= SKBTX_SHARED_FRAG;
1917 	} else if (msg_control) {
1918 		struct ubuf_info *uarg = msg_control;
1919 		uarg->callback(uarg, false);
1920 	}
1921 
1922 	skb_reset_network_header(skb);
1923 	skb_probe_transport_header(skb);
1924 
1925 	if (skb_xdp) {
1926 		struct bpf_prog *xdp_prog;
1927 		int ret;
1928 
1929 		local_bh_disable();
1930 		rcu_read_lock();
1931 		xdp_prog = rcu_dereference(tun->xdp_prog);
1932 		if (xdp_prog) {
1933 			ret = do_xdp_generic(xdp_prog, skb);
1934 			if (ret != XDP_PASS) {
1935 				rcu_read_unlock();
1936 				local_bh_enable();
1937 				if (frags) {
1938 					tfile->napi.skb = NULL;
1939 					mutex_unlock(&tfile->napi_mutex);
1940 				}
1941 				return total_len;
1942 			}
1943 		}
1944 		rcu_read_unlock();
1945 		local_bh_enable();
1946 	}
1947 
1948 	/* Compute the costly rx hash only if needed for flow updates.
1949 	 * We may get a very small possibility of OOO during switching, not
1950 	 * worth to optimize.
1951 	 */
1952 	if (!rcu_access_pointer(tun->steering_prog) && tun->numqueues > 1 &&
1953 	    !tfile->detached)
1954 		rxhash = __skb_get_hash_symmetric(skb);
1955 
1956 	rcu_read_lock();
1957 	if (unlikely(!(tun->dev->flags & IFF_UP))) {
1958 		err = -EIO;
1959 		rcu_read_unlock();
1960 		goto drop;
1961 	}
1962 
1963 	if (frags) {
1964 		/* Exercise flow dissector code path. */
1965 		u32 headlen = eth_get_headlen(tun->dev, skb->data,
1966 					      skb_headlen(skb));
1967 
1968 		if (unlikely(headlen > skb_headlen(skb))) {
1969 			this_cpu_inc(tun->pcpu_stats->rx_dropped);
1970 			napi_free_frags(&tfile->napi);
1971 			rcu_read_unlock();
1972 			mutex_unlock(&tfile->napi_mutex);
1973 			WARN_ON(1);
1974 			return -ENOMEM;
1975 		}
1976 
1977 		local_bh_disable();
1978 		napi_gro_frags(&tfile->napi);
1979 		local_bh_enable();
1980 		mutex_unlock(&tfile->napi_mutex);
1981 	} else if (tfile->napi_enabled) {
1982 		struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1983 		int queue_len;
1984 
1985 		spin_lock_bh(&queue->lock);
1986 		__skb_queue_tail(queue, skb);
1987 		queue_len = skb_queue_len(queue);
1988 		spin_unlock(&queue->lock);
1989 
1990 		if (!more || queue_len > NAPI_POLL_WEIGHT)
1991 			napi_schedule(&tfile->napi);
1992 
1993 		local_bh_enable();
1994 	} else if (!IS_ENABLED(CONFIG_4KSTACKS)) {
1995 		tun_rx_batched(tun, tfile, skb, more);
1996 	} else {
1997 		netif_rx_ni(skb);
1998 	}
1999 	rcu_read_unlock();
2000 
2001 	stats = get_cpu_ptr(tun->pcpu_stats);
2002 	u64_stats_update_begin(&stats->syncp);
2003 	u64_stats_inc(&stats->rx_packets);
2004 	u64_stats_add(&stats->rx_bytes, len);
2005 	u64_stats_update_end(&stats->syncp);
2006 	put_cpu_ptr(stats);
2007 
2008 	if (rxhash)
2009 		tun_flow_update(tun, rxhash, tfile);
2010 
2011 	return total_len;
2012 }
2013 
2014 static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
2015 {
2016 	struct file *file = iocb->ki_filp;
2017 	struct tun_file *tfile = file->private_data;
2018 	struct tun_struct *tun = tun_get(tfile);
2019 	ssize_t result;
2020 
2021 	if (!tun)
2022 		return -EBADFD;
2023 
2024 	result = tun_get_user(tun, tfile, NULL, from,
2025 			      file->f_flags & O_NONBLOCK, false);
2026 
2027 	tun_put(tun);
2028 	return result;
2029 }
2030 
2031 static ssize_t tun_put_user_xdp(struct tun_struct *tun,
2032 				struct tun_file *tfile,
2033 				struct xdp_frame *xdp_frame,
2034 				struct iov_iter *iter)
2035 {
2036 	int vnet_hdr_sz = 0;
2037 	size_t size = xdp_frame->len;
2038 	struct tun_pcpu_stats *stats;
2039 	size_t ret;
2040 
2041 	if (tun->flags & IFF_VNET_HDR) {
2042 		struct virtio_net_hdr gso = { 0 };
2043 
2044 		vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2045 		if (unlikely(iov_iter_count(iter) < vnet_hdr_sz))
2046 			return -EINVAL;
2047 		if (unlikely(copy_to_iter(&gso, sizeof(gso), iter) !=
2048 			     sizeof(gso)))
2049 			return -EFAULT;
2050 		iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2051 	}
2052 
2053 	ret = copy_to_iter(xdp_frame->data, size, iter) + vnet_hdr_sz;
2054 
2055 	stats = get_cpu_ptr(tun->pcpu_stats);
2056 	u64_stats_update_begin(&stats->syncp);
2057 	u64_stats_inc(&stats->tx_packets);
2058 	u64_stats_add(&stats->tx_bytes, ret);
2059 	u64_stats_update_end(&stats->syncp);
2060 	put_cpu_ptr(tun->pcpu_stats);
2061 
2062 	return ret;
2063 }
2064 
2065 /* Put packet to the user space buffer */
2066 static ssize_t tun_put_user(struct tun_struct *tun,
2067 			    struct tun_file *tfile,
2068 			    struct sk_buff *skb,
2069 			    struct iov_iter *iter)
2070 {
2071 	struct tun_pi pi = { 0, skb->protocol };
2072 	struct tun_pcpu_stats *stats;
2073 	ssize_t total;
2074 	int vlan_offset = 0;
2075 	int vlan_hlen = 0;
2076 	int vnet_hdr_sz = 0;
2077 
2078 	if (skb_vlan_tag_present(skb))
2079 		vlan_hlen = VLAN_HLEN;
2080 
2081 	if (tun->flags & IFF_VNET_HDR)
2082 		vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2083 
2084 	total = skb->len + vlan_hlen + vnet_hdr_sz;
2085 
2086 	if (!(tun->flags & IFF_NO_PI)) {
2087 		if (iov_iter_count(iter) < sizeof(pi))
2088 			return -EINVAL;
2089 
2090 		total += sizeof(pi);
2091 		if (iov_iter_count(iter) < total) {
2092 			/* Packet will be striped */
2093 			pi.flags |= TUN_PKT_STRIP;
2094 		}
2095 
2096 		if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
2097 			return -EFAULT;
2098 	}
2099 
2100 	if (vnet_hdr_sz) {
2101 		struct virtio_net_hdr gso;
2102 
2103 		if (iov_iter_count(iter) < vnet_hdr_sz)
2104 			return -EINVAL;
2105 
2106 		if (virtio_net_hdr_from_skb(skb, &gso,
2107 					    tun_is_little_endian(tun), true,
2108 					    vlan_hlen)) {
2109 			struct skb_shared_info *sinfo = skb_shinfo(skb);
2110 			pr_err("unexpected GSO type: "
2111 			       "0x%x, gso_size %d, hdr_len %d\n",
2112 			       sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
2113 			       tun16_to_cpu(tun, gso.hdr_len));
2114 			print_hex_dump(KERN_ERR, "tun: ",
2115 				       DUMP_PREFIX_NONE,
2116 				       16, 1, skb->head,
2117 				       min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
2118 			WARN_ON_ONCE(1);
2119 			return -EINVAL;
2120 		}
2121 
2122 		if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
2123 			return -EFAULT;
2124 
2125 		iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2126 	}
2127 
2128 	if (vlan_hlen) {
2129 		int ret;
2130 		struct veth veth;
2131 
2132 		veth.h_vlan_proto = skb->vlan_proto;
2133 		veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
2134 
2135 		vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
2136 
2137 		ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
2138 		if (ret || !iov_iter_count(iter))
2139 			goto done;
2140 
2141 		ret = copy_to_iter(&veth, sizeof(veth), iter);
2142 		if (ret != sizeof(veth) || !iov_iter_count(iter))
2143 			goto done;
2144 	}
2145 
2146 	skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
2147 
2148 done:
2149 	/* caller is in process context, */
2150 	stats = get_cpu_ptr(tun->pcpu_stats);
2151 	u64_stats_update_begin(&stats->syncp);
2152 	u64_stats_inc(&stats->tx_packets);
2153 	u64_stats_add(&stats->tx_bytes, skb->len + vlan_hlen);
2154 	u64_stats_update_end(&stats->syncp);
2155 	put_cpu_ptr(tun->pcpu_stats);
2156 
2157 	return total;
2158 }
2159 
2160 static void *tun_ring_recv(struct tun_file *tfile, int noblock, int *err)
2161 {
2162 	DECLARE_WAITQUEUE(wait, current);
2163 	void *ptr = NULL;
2164 	int error = 0;
2165 
2166 	ptr = ptr_ring_consume(&tfile->tx_ring);
2167 	if (ptr)
2168 		goto out;
2169 	if (noblock) {
2170 		error = -EAGAIN;
2171 		goto out;
2172 	}
2173 
2174 	add_wait_queue(&tfile->socket.wq.wait, &wait);
2175 
2176 	while (1) {
2177 		set_current_state(TASK_INTERRUPTIBLE);
2178 		ptr = ptr_ring_consume(&tfile->tx_ring);
2179 		if (ptr)
2180 			break;
2181 		if (signal_pending(current)) {
2182 			error = -ERESTARTSYS;
2183 			break;
2184 		}
2185 		if (tfile->socket.sk->sk_shutdown & RCV_SHUTDOWN) {
2186 			error = -EFAULT;
2187 			break;
2188 		}
2189 
2190 		schedule();
2191 	}
2192 
2193 	__set_current_state(TASK_RUNNING);
2194 	remove_wait_queue(&tfile->socket.wq.wait, &wait);
2195 
2196 out:
2197 	*err = error;
2198 	return ptr;
2199 }
2200 
2201 static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
2202 			   struct iov_iter *to,
2203 			   int noblock, void *ptr)
2204 {
2205 	ssize_t ret;
2206 	int err;
2207 
2208 	tun_debug(KERN_INFO, tun, "tun_do_read\n");
2209 
2210 	if (!iov_iter_count(to)) {
2211 		tun_ptr_free(ptr);
2212 		return 0;
2213 	}
2214 
2215 	if (!ptr) {
2216 		/* Read frames from ring */
2217 		ptr = tun_ring_recv(tfile, noblock, &err);
2218 		if (!ptr)
2219 			return err;
2220 	}
2221 
2222 	if (tun_is_xdp_frame(ptr)) {
2223 		struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2224 
2225 		ret = tun_put_user_xdp(tun, tfile, xdpf, to);
2226 		xdp_return_frame(xdpf);
2227 	} else {
2228 		struct sk_buff *skb = ptr;
2229 
2230 		ret = tun_put_user(tun, tfile, skb, to);
2231 		if (unlikely(ret < 0))
2232 			kfree_skb(skb);
2233 		else
2234 			consume_skb(skb);
2235 	}
2236 
2237 	return ret;
2238 }
2239 
2240 static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
2241 {
2242 	struct file *file = iocb->ki_filp;
2243 	struct tun_file *tfile = file->private_data;
2244 	struct tun_struct *tun = tun_get(tfile);
2245 	ssize_t len = iov_iter_count(to), ret;
2246 
2247 	if (!tun)
2248 		return -EBADFD;
2249 	ret = tun_do_read(tun, tfile, to, file->f_flags & O_NONBLOCK, NULL);
2250 	ret = min_t(ssize_t, ret, len);
2251 	if (ret > 0)
2252 		iocb->ki_pos = ret;
2253 	tun_put(tun);
2254 	return ret;
2255 }
2256 
2257 static void tun_prog_free(struct rcu_head *rcu)
2258 {
2259 	struct tun_prog *prog = container_of(rcu, struct tun_prog, rcu);
2260 
2261 	bpf_prog_destroy(prog->prog);
2262 	kfree(prog);
2263 }
2264 
2265 static int __tun_set_ebpf(struct tun_struct *tun,
2266 			  struct tun_prog __rcu **prog_p,
2267 			  struct bpf_prog *prog)
2268 {
2269 	struct tun_prog *old, *new = NULL;
2270 
2271 	if (prog) {
2272 		new = kmalloc(sizeof(*new), GFP_KERNEL);
2273 		if (!new)
2274 			return -ENOMEM;
2275 		new->prog = prog;
2276 	}
2277 
2278 	spin_lock_bh(&tun->lock);
2279 	old = rcu_dereference_protected(*prog_p,
2280 					lockdep_is_held(&tun->lock));
2281 	rcu_assign_pointer(*prog_p, new);
2282 	spin_unlock_bh(&tun->lock);
2283 
2284 	if (old)
2285 		call_rcu(&old->rcu, tun_prog_free);
2286 
2287 	return 0;
2288 }
2289 
2290 static void tun_free_netdev(struct net_device *dev)
2291 {
2292 	struct tun_struct *tun = netdev_priv(dev);
2293 
2294 	BUG_ON(!(list_empty(&tun->disabled)));
2295 
2296 	free_percpu(tun->pcpu_stats);
2297 	/* We clear pcpu_stats so that tun_set_iff() can tell if
2298 	 * tun_free_netdev() has been called from register_netdevice().
2299 	 */
2300 	tun->pcpu_stats = NULL;
2301 
2302 	tun_flow_uninit(tun);
2303 	security_tun_dev_free_security(tun->security);
2304 	__tun_set_ebpf(tun, &tun->steering_prog, NULL);
2305 	__tun_set_ebpf(tun, &tun->filter_prog, NULL);
2306 }
2307 
2308 static void tun_setup(struct net_device *dev)
2309 {
2310 	struct tun_struct *tun = netdev_priv(dev);
2311 
2312 	tun->owner = INVALID_UID;
2313 	tun->group = INVALID_GID;
2314 	tun_default_link_ksettings(dev, &tun->link_ksettings);
2315 
2316 	dev->ethtool_ops = &tun_ethtool_ops;
2317 	dev->needs_free_netdev = true;
2318 	dev->priv_destructor = tun_free_netdev;
2319 	/* We prefer our own queue length */
2320 	dev->tx_queue_len = TUN_READQ_SIZE;
2321 }
2322 
2323 /* Trivial set of netlink ops to allow deleting tun or tap
2324  * device with netlink.
2325  */
2326 static int tun_validate(struct nlattr *tb[], struct nlattr *data[],
2327 			struct netlink_ext_ack *extack)
2328 {
2329 	NL_SET_ERR_MSG(extack,
2330 		       "tun/tap creation via rtnetlink is not supported.");
2331 	return -EOPNOTSUPP;
2332 }
2333 
2334 static size_t tun_get_size(const struct net_device *dev)
2335 {
2336 	BUILD_BUG_ON(sizeof(u32) != sizeof(uid_t));
2337 	BUILD_BUG_ON(sizeof(u32) != sizeof(gid_t));
2338 
2339 	return nla_total_size(sizeof(uid_t)) + /* OWNER */
2340 	       nla_total_size(sizeof(gid_t)) + /* GROUP */
2341 	       nla_total_size(sizeof(u8)) + /* TYPE */
2342 	       nla_total_size(sizeof(u8)) + /* PI */
2343 	       nla_total_size(sizeof(u8)) + /* VNET_HDR */
2344 	       nla_total_size(sizeof(u8)) + /* PERSIST */
2345 	       nla_total_size(sizeof(u8)) + /* MULTI_QUEUE */
2346 	       nla_total_size(sizeof(u32)) + /* NUM_QUEUES */
2347 	       nla_total_size(sizeof(u32)) + /* NUM_DISABLED_QUEUES */
2348 	       0;
2349 }
2350 
2351 static int tun_fill_info(struct sk_buff *skb, const struct net_device *dev)
2352 {
2353 	struct tun_struct *tun = netdev_priv(dev);
2354 
2355 	if (nla_put_u8(skb, IFLA_TUN_TYPE, tun->flags & TUN_TYPE_MASK))
2356 		goto nla_put_failure;
2357 	if (uid_valid(tun->owner) &&
2358 	    nla_put_u32(skb, IFLA_TUN_OWNER,
2359 			from_kuid_munged(current_user_ns(), tun->owner)))
2360 		goto nla_put_failure;
2361 	if (gid_valid(tun->group) &&
2362 	    nla_put_u32(skb, IFLA_TUN_GROUP,
2363 			from_kgid_munged(current_user_ns(), tun->group)))
2364 		goto nla_put_failure;
2365 	if (nla_put_u8(skb, IFLA_TUN_PI, !(tun->flags & IFF_NO_PI)))
2366 		goto nla_put_failure;
2367 	if (nla_put_u8(skb, IFLA_TUN_VNET_HDR, !!(tun->flags & IFF_VNET_HDR)))
2368 		goto nla_put_failure;
2369 	if (nla_put_u8(skb, IFLA_TUN_PERSIST, !!(tun->flags & IFF_PERSIST)))
2370 		goto nla_put_failure;
2371 	if (nla_put_u8(skb, IFLA_TUN_MULTI_QUEUE,
2372 		       !!(tun->flags & IFF_MULTI_QUEUE)))
2373 		goto nla_put_failure;
2374 	if (tun->flags & IFF_MULTI_QUEUE) {
2375 		if (nla_put_u32(skb, IFLA_TUN_NUM_QUEUES, tun->numqueues))
2376 			goto nla_put_failure;
2377 		if (nla_put_u32(skb, IFLA_TUN_NUM_DISABLED_QUEUES,
2378 				tun->numdisabled))
2379 			goto nla_put_failure;
2380 	}
2381 
2382 	return 0;
2383 
2384 nla_put_failure:
2385 	return -EMSGSIZE;
2386 }
2387 
2388 static struct rtnl_link_ops tun_link_ops __read_mostly = {
2389 	.kind		= DRV_NAME,
2390 	.priv_size	= sizeof(struct tun_struct),
2391 	.setup		= tun_setup,
2392 	.validate	= tun_validate,
2393 	.get_size       = tun_get_size,
2394 	.fill_info      = tun_fill_info,
2395 };
2396 
2397 static void tun_sock_write_space(struct sock *sk)
2398 {
2399 	struct tun_file *tfile;
2400 	wait_queue_head_t *wqueue;
2401 
2402 	if (!sock_writeable(sk))
2403 		return;
2404 
2405 	if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
2406 		return;
2407 
2408 	wqueue = sk_sleep(sk);
2409 	if (wqueue && waitqueue_active(wqueue))
2410 		wake_up_interruptible_sync_poll(wqueue, EPOLLOUT |
2411 						EPOLLWRNORM | EPOLLWRBAND);
2412 
2413 	tfile = container_of(sk, struct tun_file, sk);
2414 	kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
2415 }
2416 
2417 static void tun_put_page(struct tun_page *tpage)
2418 {
2419 	if (tpage->page)
2420 		__page_frag_cache_drain(tpage->page, tpage->count);
2421 }
2422 
2423 static int tun_xdp_one(struct tun_struct *tun,
2424 		       struct tun_file *tfile,
2425 		       struct xdp_buff *xdp, int *flush,
2426 		       struct tun_page *tpage)
2427 {
2428 	unsigned int datasize = xdp->data_end - xdp->data;
2429 	struct tun_xdp_hdr *hdr = xdp->data_hard_start;
2430 	struct virtio_net_hdr *gso = &hdr->gso;
2431 	struct tun_pcpu_stats *stats;
2432 	struct bpf_prog *xdp_prog;
2433 	struct sk_buff *skb = NULL;
2434 	u32 rxhash = 0, act;
2435 	int buflen = hdr->buflen;
2436 	int err = 0;
2437 	bool skb_xdp = false;
2438 	struct page *page;
2439 
2440 	xdp_prog = rcu_dereference(tun->xdp_prog);
2441 	if (xdp_prog) {
2442 		if (gso->gso_type) {
2443 			skb_xdp = true;
2444 			goto build;
2445 		}
2446 		xdp_set_data_meta_invalid(xdp);
2447 		xdp->rxq = &tfile->xdp_rxq;
2448 
2449 		act = bpf_prog_run_xdp(xdp_prog, xdp);
2450 		err = tun_xdp_act(tun, xdp_prog, xdp, act);
2451 		if (err < 0) {
2452 			put_page(virt_to_head_page(xdp->data));
2453 			return err;
2454 		}
2455 
2456 		switch (err) {
2457 		case XDP_REDIRECT:
2458 			*flush = true;
2459 			/* fall through */
2460 		case XDP_TX:
2461 			return 0;
2462 		case XDP_PASS:
2463 			break;
2464 		default:
2465 			page = virt_to_head_page(xdp->data);
2466 			if (tpage->page == page) {
2467 				++tpage->count;
2468 			} else {
2469 				tun_put_page(tpage);
2470 				tpage->page = page;
2471 				tpage->count = 1;
2472 			}
2473 			return 0;
2474 		}
2475 	}
2476 
2477 build:
2478 	skb = build_skb(xdp->data_hard_start, buflen);
2479 	if (!skb) {
2480 		err = -ENOMEM;
2481 		goto out;
2482 	}
2483 
2484 	skb_reserve(skb, xdp->data - xdp->data_hard_start);
2485 	skb_put(skb, xdp->data_end - xdp->data);
2486 
2487 	if (virtio_net_hdr_to_skb(skb, gso, tun_is_little_endian(tun))) {
2488 		this_cpu_inc(tun->pcpu_stats->rx_frame_errors);
2489 		kfree_skb(skb);
2490 		err = -EINVAL;
2491 		goto out;
2492 	}
2493 
2494 	skb->protocol = eth_type_trans(skb, tun->dev);
2495 	skb_reset_network_header(skb);
2496 	skb_probe_transport_header(skb);
2497 
2498 	if (skb_xdp) {
2499 		err = do_xdp_generic(xdp_prog, skb);
2500 		if (err != XDP_PASS)
2501 			goto out;
2502 	}
2503 
2504 	if (!rcu_dereference(tun->steering_prog) && tun->numqueues > 1 &&
2505 	    !tfile->detached)
2506 		rxhash = __skb_get_hash_symmetric(skb);
2507 
2508 	skb_record_rx_queue(skb, tfile->queue_index);
2509 	netif_receive_skb(skb);
2510 
2511 	/* No need for get_cpu_ptr() here since this function is
2512 	 * always called with bh disabled
2513 	 */
2514 	stats = this_cpu_ptr(tun->pcpu_stats);
2515 	u64_stats_update_begin(&stats->syncp);
2516 	u64_stats_inc(&stats->rx_packets);
2517 	u64_stats_add(&stats->rx_bytes, datasize);
2518 	u64_stats_update_end(&stats->syncp);
2519 
2520 	if (rxhash)
2521 		tun_flow_update(tun, rxhash, tfile);
2522 
2523 out:
2524 	return err;
2525 }
2526 
2527 static int tun_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
2528 {
2529 	int ret, i;
2530 	struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2531 	struct tun_struct *tun = tun_get(tfile);
2532 	struct tun_msg_ctl *ctl = m->msg_control;
2533 	struct xdp_buff *xdp;
2534 
2535 	if (!tun)
2536 		return -EBADFD;
2537 
2538 	if (ctl && (ctl->type == TUN_MSG_PTR)) {
2539 		struct tun_page tpage;
2540 		int n = ctl->num;
2541 		int flush = 0;
2542 
2543 		memset(&tpage, 0, sizeof(tpage));
2544 
2545 		local_bh_disable();
2546 		rcu_read_lock();
2547 
2548 		for (i = 0; i < n; i++) {
2549 			xdp = &((struct xdp_buff *)ctl->ptr)[i];
2550 			tun_xdp_one(tun, tfile, xdp, &flush, &tpage);
2551 		}
2552 
2553 		if (flush)
2554 			xdp_do_flush();
2555 
2556 		rcu_read_unlock();
2557 		local_bh_enable();
2558 
2559 		tun_put_page(&tpage);
2560 
2561 		ret = total_len;
2562 		goto out;
2563 	}
2564 
2565 	ret = tun_get_user(tun, tfile, ctl ? ctl->ptr : NULL, &m->msg_iter,
2566 			   m->msg_flags & MSG_DONTWAIT,
2567 			   m->msg_flags & MSG_MORE);
2568 out:
2569 	tun_put(tun);
2570 	return ret;
2571 }
2572 
2573 static int tun_recvmsg(struct socket *sock, struct msghdr *m, size_t total_len,
2574 		       int flags)
2575 {
2576 	struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2577 	struct tun_struct *tun = tun_get(tfile);
2578 	void *ptr = m->msg_control;
2579 	int ret;
2580 
2581 	if (!tun) {
2582 		ret = -EBADFD;
2583 		goto out_free;
2584 	}
2585 
2586 	if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
2587 		ret = -EINVAL;
2588 		goto out_put_tun;
2589 	}
2590 	if (flags & MSG_ERRQUEUE) {
2591 		ret = sock_recv_errqueue(sock->sk, m, total_len,
2592 					 SOL_PACKET, TUN_TX_TIMESTAMP);
2593 		goto out;
2594 	}
2595 	ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT, ptr);
2596 	if (ret > (ssize_t)total_len) {
2597 		m->msg_flags |= MSG_TRUNC;
2598 		ret = flags & MSG_TRUNC ? ret : total_len;
2599 	}
2600 out:
2601 	tun_put(tun);
2602 	return ret;
2603 
2604 out_put_tun:
2605 	tun_put(tun);
2606 out_free:
2607 	tun_ptr_free(ptr);
2608 	return ret;
2609 }
2610 
2611 static int tun_ptr_peek_len(void *ptr)
2612 {
2613 	if (likely(ptr)) {
2614 		if (tun_is_xdp_frame(ptr)) {
2615 			struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2616 
2617 			return xdpf->len;
2618 		}
2619 		return __skb_array_len_with_tag(ptr);
2620 	} else {
2621 		return 0;
2622 	}
2623 }
2624 
2625 static int tun_peek_len(struct socket *sock)
2626 {
2627 	struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2628 	struct tun_struct *tun;
2629 	int ret = 0;
2630 
2631 	tun = tun_get(tfile);
2632 	if (!tun)
2633 		return 0;
2634 
2635 	ret = PTR_RING_PEEK_CALL(&tfile->tx_ring, tun_ptr_peek_len);
2636 	tun_put(tun);
2637 
2638 	return ret;
2639 }
2640 
2641 /* Ops structure to mimic raw sockets with tun */
2642 static const struct proto_ops tun_socket_ops = {
2643 	.peek_len = tun_peek_len,
2644 	.sendmsg = tun_sendmsg,
2645 	.recvmsg = tun_recvmsg,
2646 };
2647 
2648 static struct proto tun_proto = {
2649 	.name		= "tun",
2650 	.owner		= THIS_MODULE,
2651 	.obj_size	= sizeof(struct tun_file),
2652 };
2653 
2654 static int tun_flags(struct tun_struct *tun)
2655 {
2656 	return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
2657 }
2658 
2659 static ssize_t tun_show_flags(struct device *dev, struct device_attribute *attr,
2660 			      char *buf)
2661 {
2662 	struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2663 	return sprintf(buf, "0x%x\n", tun_flags(tun));
2664 }
2665 
2666 static ssize_t tun_show_owner(struct device *dev, struct device_attribute *attr,
2667 			      char *buf)
2668 {
2669 	struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2670 	return uid_valid(tun->owner)?
2671 		sprintf(buf, "%u\n",
2672 			from_kuid_munged(current_user_ns(), tun->owner)):
2673 		sprintf(buf, "-1\n");
2674 }
2675 
2676 static ssize_t tun_show_group(struct device *dev, struct device_attribute *attr,
2677 			      char *buf)
2678 {
2679 	struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2680 	return gid_valid(tun->group) ?
2681 		sprintf(buf, "%u\n",
2682 			from_kgid_munged(current_user_ns(), tun->group)):
2683 		sprintf(buf, "-1\n");
2684 }
2685 
2686 static DEVICE_ATTR(tun_flags, 0444, tun_show_flags, NULL);
2687 static DEVICE_ATTR(owner, 0444, tun_show_owner, NULL);
2688 static DEVICE_ATTR(group, 0444, tun_show_group, NULL);
2689 
2690 static struct attribute *tun_dev_attrs[] = {
2691 	&dev_attr_tun_flags.attr,
2692 	&dev_attr_owner.attr,
2693 	&dev_attr_group.attr,
2694 	NULL
2695 };
2696 
2697 static const struct attribute_group tun_attr_group = {
2698 	.attrs = tun_dev_attrs
2699 };
2700 
2701 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
2702 {
2703 	struct tun_struct *tun;
2704 	struct tun_file *tfile = file->private_data;
2705 	struct net_device *dev;
2706 	int err;
2707 
2708 	if (tfile->detached)
2709 		return -EINVAL;
2710 
2711 	if ((ifr->ifr_flags & IFF_NAPI_FRAGS)) {
2712 		if (!capable(CAP_NET_ADMIN))
2713 			return -EPERM;
2714 
2715 		if (!(ifr->ifr_flags & IFF_NAPI) ||
2716 		    (ifr->ifr_flags & TUN_TYPE_MASK) != IFF_TAP)
2717 			return -EINVAL;
2718 	}
2719 
2720 	dev = __dev_get_by_name(net, ifr->ifr_name);
2721 	if (dev) {
2722 		if (ifr->ifr_flags & IFF_TUN_EXCL)
2723 			return -EBUSY;
2724 		if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
2725 			tun = netdev_priv(dev);
2726 		else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
2727 			tun = netdev_priv(dev);
2728 		else
2729 			return -EINVAL;
2730 
2731 		if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
2732 		    !!(tun->flags & IFF_MULTI_QUEUE))
2733 			return -EINVAL;
2734 
2735 		if (tun_not_capable(tun))
2736 			return -EPERM;
2737 		err = security_tun_dev_open(tun->security);
2738 		if (err < 0)
2739 			return err;
2740 
2741 		err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER,
2742 				 ifr->ifr_flags & IFF_NAPI,
2743 				 ifr->ifr_flags & IFF_NAPI_FRAGS, true);
2744 		if (err < 0)
2745 			return err;
2746 
2747 		if (tun->flags & IFF_MULTI_QUEUE &&
2748 		    (tun->numqueues + tun->numdisabled > 1)) {
2749 			/* One or more queue has already been attached, no need
2750 			 * to initialize the device again.
2751 			 */
2752 			netdev_state_change(dev);
2753 			return 0;
2754 		}
2755 
2756 		tun->flags = (tun->flags & ~TUN_FEATURES) |
2757 			      (ifr->ifr_flags & TUN_FEATURES);
2758 
2759 		netdev_state_change(dev);
2760 	} else {
2761 		char *name;
2762 		unsigned long flags = 0;
2763 		int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
2764 			     MAX_TAP_QUEUES : 1;
2765 
2766 		if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
2767 			return -EPERM;
2768 		err = security_tun_dev_create();
2769 		if (err < 0)
2770 			return err;
2771 
2772 		/* Set dev type */
2773 		if (ifr->ifr_flags & IFF_TUN) {
2774 			/* TUN device */
2775 			flags |= IFF_TUN;
2776 			name = "tun%d";
2777 		} else if (ifr->ifr_flags & IFF_TAP) {
2778 			/* TAP device */
2779 			flags |= IFF_TAP;
2780 			name = "tap%d";
2781 		} else
2782 			return -EINVAL;
2783 
2784 		if (*ifr->ifr_name)
2785 			name = ifr->ifr_name;
2786 
2787 		dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
2788 				       NET_NAME_UNKNOWN, tun_setup, queues,
2789 				       queues);
2790 
2791 		if (!dev)
2792 			return -ENOMEM;
2793 
2794 		dev_net_set(dev, net);
2795 		dev->rtnl_link_ops = &tun_link_ops;
2796 		dev->ifindex = tfile->ifindex;
2797 		dev->sysfs_groups[0] = &tun_attr_group;
2798 
2799 		tun = netdev_priv(dev);
2800 		tun->dev = dev;
2801 		tun->flags = flags;
2802 		tun->txflt.count = 0;
2803 		tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
2804 
2805 		tun->align = NET_SKB_PAD;
2806 		tun->filter_attached = false;
2807 		tun->sndbuf = tfile->socket.sk->sk_sndbuf;
2808 		tun->rx_batched = 0;
2809 		RCU_INIT_POINTER(tun->steering_prog, NULL);
2810 
2811 		tun->pcpu_stats = netdev_alloc_pcpu_stats(struct tun_pcpu_stats);
2812 		if (!tun->pcpu_stats) {
2813 			err = -ENOMEM;
2814 			goto err_free_dev;
2815 		}
2816 
2817 		spin_lock_init(&tun->lock);
2818 
2819 		err = security_tun_dev_alloc_security(&tun->security);
2820 		if (err < 0)
2821 			goto err_free_stat;
2822 
2823 		tun_net_init(dev);
2824 		tun_flow_init(tun);
2825 
2826 		dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
2827 				   TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
2828 				   NETIF_F_HW_VLAN_STAG_TX;
2829 		dev->features = dev->hw_features | NETIF_F_LLTX;
2830 		dev->vlan_features = dev->features &
2831 				     ~(NETIF_F_HW_VLAN_CTAG_TX |
2832 				       NETIF_F_HW_VLAN_STAG_TX);
2833 
2834 		tun->flags = (tun->flags & ~TUN_FEATURES) |
2835 			      (ifr->ifr_flags & TUN_FEATURES);
2836 
2837 		INIT_LIST_HEAD(&tun->disabled);
2838 		err = tun_attach(tun, file, false, ifr->ifr_flags & IFF_NAPI,
2839 				 ifr->ifr_flags & IFF_NAPI_FRAGS, false);
2840 		if (err < 0)
2841 			goto err_free_flow;
2842 
2843 		err = register_netdevice(tun->dev);
2844 		if (err < 0)
2845 			goto err_detach;
2846 		/* free_netdev() won't check refcnt, to aovid race
2847 		 * with dev_put() we need publish tun after registration.
2848 		 */
2849 		rcu_assign_pointer(tfile->tun, tun);
2850 	}
2851 
2852 	netif_carrier_on(tun->dev);
2853 
2854 	tun_debug(KERN_INFO, tun, "tun_set_iff\n");
2855 
2856 	/* Make sure persistent devices do not get stuck in
2857 	 * xoff state.
2858 	 */
2859 	if (netif_running(tun->dev))
2860 		netif_tx_wake_all_queues(tun->dev);
2861 
2862 	strcpy(ifr->ifr_name, tun->dev->name);
2863 	return 0;
2864 
2865 err_detach:
2866 	tun_detach_all(dev);
2867 	/* We are here because register_netdevice() has failed.
2868 	 * If register_netdevice() already called tun_free_netdev()
2869 	 * while dealing with the error, tun->pcpu_stats has been cleared.
2870 	 */
2871 	if (!tun->pcpu_stats)
2872 		goto err_free_dev;
2873 
2874 err_free_flow:
2875 	tun_flow_uninit(tun);
2876 	security_tun_dev_free_security(tun->security);
2877 err_free_stat:
2878 	free_percpu(tun->pcpu_stats);
2879 err_free_dev:
2880 	free_netdev(dev);
2881 	return err;
2882 }
2883 
2884 static void tun_get_iff(struct tun_struct *tun, struct ifreq *ifr)
2885 {
2886 	tun_debug(KERN_INFO, tun, "tun_get_iff\n");
2887 
2888 	strcpy(ifr->ifr_name, tun->dev->name);
2889 
2890 	ifr->ifr_flags = tun_flags(tun);
2891 
2892 }
2893 
2894 /* This is like a cut-down ethtool ops, except done via tun fd so no
2895  * privs required. */
2896 static int set_offload(struct tun_struct *tun, unsigned long arg)
2897 {
2898 	netdev_features_t features = 0;
2899 
2900 	if (arg & TUN_F_CSUM) {
2901 		features |= NETIF_F_HW_CSUM;
2902 		arg &= ~TUN_F_CSUM;
2903 
2904 		if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
2905 			if (arg & TUN_F_TSO_ECN) {
2906 				features |= NETIF_F_TSO_ECN;
2907 				arg &= ~TUN_F_TSO_ECN;
2908 			}
2909 			if (arg & TUN_F_TSO4)
2910 				features |= NETIF_F_TSO;
2911 			if (arg & TUN_F_TSO6)
2912 				features |= NETIF_F_TSO6;
2913 			arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
2914 		}
2915 
2916 		arg &= ~TUN_F_UFO;
2917 	}
2918 
2919 	/* This gives the user a way to test for new features in future by
2920 	 * trying to set them. */
2921 	if (arg)
2922 		return -EINVAL;
2923 
2924 	tun->set_features = features;
2925 	tun->dev->wanted_features &= ~TUN_USER_FEATURES;
2926 	tun->dev->wanted_features |= features;
2927 	netdev_update_features(tun->dev);
2928 
2929 	return 0;
2930 }
2931 
2932 static void tun_detach_filter(struct tun_struct *tun, int n)
2933 {
2934 	int i;
2935 	struct tun_file *tfile;
2936 
2937 	for (i = 0; i < n; i++) {
2938 		tfile = rtnl_dereference(tun->tfiles[i]);
2939 		lock_sock(tfile->socket.sk);
2940 		sk_detach_filter(tfile->socket.sk);
2941 		release_sock(tfile->socket.sk);
2942 	}
2943 
2944 	tun->filter_attached = false;
2945 }
2946 
2947 static int tun_attach_filter(struct tun_struct *tun)
2948 {
2949 	int i, ret = 0;
2950 	struct tun_file *tfile;
2951 
2952 	for (i = 0; i < tun->numqueues; i++) {
2953 		tfile = rtnl_dereference(tun->tfiles[i]);
2954 		lock_sock(tfile->socket.sk);
2955 		ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
2956 		release_sock(tfile->socket.sk);
2957 		if (ret) {
2958 			tun_detach_filter(tun, i);
2959 			return ret;
2960 		}
2961 	}
2962 
2963 	tun->filter_attached = true;
2964 	return ret;
2965 }
2966 
2967 static void tun_set_sndbuf(struct tun_struct *tun)
2968 {
2969 	struct tun_file *tfile;
2970 	int i;
2971 
2972 	for (i = 0; i < tun->numqueues; i++) {
2973 		tfile = rtnl_dereference(tun->tfiles[i]);
2974 		tfile->socket.sk->sk_sndbuf = tun->sndbuf;
2975 	}
2976 }
2977 
2978 static int tun_set_queue(struct file *file, struct ifreq *ifr)
2979 {
2980 	struct tun_file *tfile = file->private_data;
2981 	struct tun_struct *tun;
2982 	int ret = 0;
2983 
2984 	rtnl_lock();
2985 
2986 	if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
2987 		tun = tfile->detached;
2988 		if (!tun) {
2989 			ret = -EINVAL;
2990 			goto unlock;
2991 		}
2992 		ret = security_tun_dev_attach_queue(tun->security);
2993 		if (ret < 0)
2994 			goto unlock;
2995 		ret = tun_attach(tun, file, false, tun->flags & IFF_NAPI,
2996 				 tun->flags & IFF_NAPI_FRAGS, true);
2997 	} else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
2998 		tun = rtnl_dereference(tfile->tun);
2999 		if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
3000 			ret = -EINVAL;
3001 		else
3002 			__tun_detach(tfile, false);
3003 	} else
3004 		ret = -EINVAL;
3005 
3006 	if (ret >= 0)
3007 		netdev_state_change(tun->dev);
3008 
3009 unlock:
3010 	rtnl_unlock();
3011 	return ret;
3012 }
3013 
3014 static int tun_set_ebpf(struct tun_struct *tun, struct tun_prog **prog_p,
3015 			void __user *data)
3016 {
3017 	struct bpf_prog *prog;
3018 	int fd;
3019 
3020 	if (copy_from_user(&fd, data, sizeof(fd)))
3021 		return -EFAULT;
3022 
3023 	if (fd == -1) {
3024 		prog = NULL;
3025 	} else {
3026 		prog = bpf_prog_get_type(fd, BPF_PROG_TYPE_SOCKET_FILTER);
3027 		if (IS_ERR(prog))
3028 			return PTR_ERR(prog);
3029 	}
3030 
3031 	return __tun_set_ebpf(tun, prog_p, prog);
3032 }
3033 
3034 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
3035 			    unsigned long arg, int ifreq_len)
3036 {
3037 	struct tun_file *tfile = file->private_data;
3038 	struct net *net = sock_net(&tfile->sk);
3039 	struct tun_struct *tun;
3040 	void __user* argp = (void __user*)arg;
3041 	unsigned int ifindex, carrier;
3042 	struct ifreq ifr;
3043 	kuid_t owner;
3044 	kgid_t group;
3045 	int sndbuf;
3046 	int vnet_hdr_sz;
3047 	int le;
3048 	int ret;
3049 	bool do_notify = false;
3050 
3051 	if (cmd == TUNSETIFF || cmd == TUNSETQUEUE ||
3052 	    (_IOC_TYPE(cmd) == SOCK_IOC_TYPE && cmd != SIOCGSKNS)) {
3053 		if (copy_from_user(&ifr, argp, ifreq_len))
3054 			return -EFAULT;
3055 	} else {
3056 		memset(&ifr, 0, sizeof(ifr));
3057 	}
3058 	if (cmd == TUNGETFEATURES) {
3059 		/* Currently this just means: "what IFF flags are valid?".
3060 		 * This is needed because we never checked for invalid flags on
3061 		 * TUNSETIFF.
3062 		 */
3063 		return put_user(IFF_TUN | IFF_TAP | TUN_FEATURES,
3064 				(unsigned int __user*)argp);
3065 	} else if (cmd == TUNSETQUEUE) {
3066 		return tun_set_queue(file, &ifr);
3067 	} else if (cmd == SIOCGSKNS) {
3068 		if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
3069 			return -EPERM;
3070 		return open_related_ns(&net->ns, get_net_ns);
3071 	}
3072 
3073 	ret = 0;
3074 	rtnl_lock();
3075 
3076 	tun = tun_get(tfile);
3077 	if (cmd == TUNSETIFF) {
3078 		ret = -EEXIST;
3079 		if (tun)
3080 			goto unlock;
3081 
3082 		ifr.ifr_name[IFNAMSIZ-1] = '\0';
3083 
3084 		ret = tun_set_iff(net, file, &ifr);
3085 
3086 		if (ret)
3087 			goto unlock;
3088 
3089 		if (copy_to_user(argp, &ifr, ifreq_len))
3090 			ret = -EFAULT;
3091 		goto unlock;
3092 	}
3093 	if (cmd == TUNSETIFINDEX) {
3094 		ret = -EPERM;
3095 		if (tun)
3096 			goto unlock;
3097 
3098 		ret = -EFAULT;
3099 		if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
3100 			goto unlock;
3101 
3102 		ret = 0;
3103 		tfile->ifindex = ifindex;
3104 		goto unlock;
3105 	}
3106 
3107 	ret = -EBADFD;
3108 	if (!tun)
3109 		goto unlock;
3110 
3111 	tun_debug(KERN_INFO, tun, "tun_chr_ioctl cmd %u\n", cmd);
3112 
3113 	net = dev_net(tun->dev);
3114 	ret = 0;
3115 	switch (cmd) {
3116 	case TUNGETIFF:
3117 		tun_get_iff(tun, &ifr);
3118 
3119 		if (tfile->detached)
3120 			ifr.ifr_flags |= IFF_DETACH_QUEUE;
3121 		if (!tfile->socket.sk->sk_filter)
3122 			ifr.ifr_flags |= IFF_NOFILTER;
3123 
3124 		if (copy_to_user(argp, &ifr, ifreq_len))
3125 			ret = -EFAULT;
3126 		break;
3127 
3128 	case TUNSETNOCSUM:
3129 		/* Disable/Enable checksum */
3130 
3131 		/* [unimplemented] */
3132 		tun_debug(KERN_INFO, tun, "ignored: set checksum %s\n",
3133 			  arg ? "disabled" : "enabled");
3134 		break;
3135 
3136 	case TUNSETPERSIST:
3137 		/* Disable/Enable persist mode. Keep an extra reference to the
3138 		 * module to prevent the module being unprobed.
3139 		 */
3140 		if (arg && !(tun->flags & IFF_PERSIST)) {
3141 			tun->flags |= IFF_PERSIST;
3142 			__module_get(THIS_MODULE);
3143 			do_notify = true;
3144 		}
3145 		if (!arg && (tun->flags & IFF_PERSIST)) {
3146 			tun->flags &= ~IFF_PERSIST;
3147 			module_put(THIS_MODULE);
3148 			do_notify = true;
3149 		}
3150 
3151 		tun_debug(KERN_INFO, tun, "persist %s\n",
3152 			  arg ? "enabled" : "disabled");
3153 		break;
3154 
3155 	case TUNSETOWNER:
3156 		/* Set owner of the device */
3157 		owner = make_kuid(current_user_ns(), arg);
3158 		if (!uid_valid(owner)) {
3159 			ret = -EINVAL;
3160 			break;
3161 		}
3162 		tun->owner = owner;
3163 		do_notify = true;
3164 		tun_debug(KERN_INFO, tun, "owner set to %u\n",
3165 			  from_kuid(&init_user_ns, tun->owner));
3166 		break;
3167 
3168 	case TUNSETGROUP:
3169 		/* Set group of the device */
3170 		group = make_kgid(current_user_ns(), arg);
3171 		if (!gid_valid(group)) {
3172 			ret = -EINVAL;
3173 			break;
3174 		}
3175 		tun->group = group;
3176 		do_notify = true;
3177 		tun_debug(KERN_INFO, tun, "group set to %u\n",
3178 			  from_kgid(&init_user_ns, tun->group));
3179 		break;
3180 
3181 	case TUNSETLINK:
3182 		/* Only allow setting the type when the interface is down */
3183 		if (tun->dev->flags & IFF_UP) {
3184 			tun_debug(KERN_INFO, tun,
3185 				  "Linktype set failed because interface is up\n");
3186 			ret = -EBUSY;
3187 		} else {
3188 			tun->dev->type = (int) arg;
3189 			tun_debug(KERN_INFO, tun, "linktype set to %d\n",
3190 				  tun->dev->type);
3191 			ret = 0;
3192 		}
3193 		break;
3194 
3195 #ifdef TUN_DEBUG
3196 	case TUNSETDEBUG:
3197 		tun->debug = arg;
3198 		break;
3199 #endif
3200 	case TUNSETOFFLOAD:
3201 		ret = set_offload(tun, arg);
3202 		break;
3203 
3204 	case TUNSETTXFILTER:
3205 		/* Can be set only for TAPs */
3206 		ret = -EINVAL;
3207 		if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3208 			break;
3209 		ret = update_filter(&tun->txflt, (void __user *)arg);
3210 		break;
3211 
3212 	case SIOCGIFHWADDR:
3213 		/* Get hw address */
3214 		memcpy(ifr.ifr_hwaddr.sa_data, tun->dev->dev_addr, ETH_ALEN);
3215 		ifr.ifr_hwaddr.sa_family = tun->dev->type;
3216 		if (copy_to_user(argp, &ifr, ifreq_len))
3217 			ret = -EFAULT;
3218 		break;
3219 
3220 	case SIOCSIFHWADDR:
3221 		/* Set hw address */
3222 		tun_debug(KERN_DEBUG, tun, "set hw address: %pM\n",
3223 			  ifr.ifr_hwaddr.sa_data);
3224 
3225 		ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr, NULL);
3226 		break;
3227 
3228 	case TUNGETSNDBUF:
3229 		sndbuf = tfile->socket.sk->sk_sndbuf;
3230 		if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
3231 			ret = -EFAULT;
3232 		break;
3233 
3234 	case TUNSETSNDBUF:
3235 		if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
3236 			ret = -EFAULT;
3237 			break;
3238 		}
3239 		if (sndbuf <= 0) {
3240 			ret = -EINVAL;
3241 			break;
3242 		}
3243 
3244 		tun->sndbuf = sndbuf;
3245 		tun_set_sndbuf(tun);
3246 		break;
3247 
3248 	case TUNGETVNETHDRSZ:
3249 		vnet_hdr_sz = tun->vnet_hdr_sz;
3250 		if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
3251 			ret = -EFAULT;
3252 		break;
3253 
3254 	case TUNSETVNETHDRSZ:
3255 		if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
3256 			ret = -EFAULT;
3257 			break;
3258 		}
3259 		if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
3260 			ret = -EINVAL;
3261 			break;
3262 		}
3263 
3264 		tun->vnet_hdr_sz = vnet_hdr_sz;
3265 		break;
3266 
3267 	case TUNGETVNETLE:
3268 		le = !!(tun->flags & TUN_VNET_LE);
3269 		if (put_user(le, (int __user *)argp))
3270 			ret = -EFAULT;
3271 		break;
3272 
3273 	case TUNSETVNETLE:
3274 		if (get_user(le, (int __user *)argp)) {
3275 			ret = -EFAULT;
3276 			break;
3277 		}
3278 		if (le)
3279 			tun->flags |= TUN_VNET_LE;
3280 		else
3281 			tun->flags &= ~TUN_VNET_LE;
3282 		break;
3283 
3284 	case TUNGETVNETBE:
3285 		ret = tun_get_vnet_be(tun, argp);
3286 		break;
3287 
3288 	case TUNSETVNETBE:
3289 		ret = tun_set_vnet_be(tun, argp);
3290 		break;
3291 
3292 	case TUNATTACHFILTER:
3293 		/* Can be set only for TAPs */
3294 		ret = -EINVAL;
3295 		if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3296 			break;
3297 		ret = -EFAULT;
3298 		if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
3299 			break;
3300 
3301 		ret = tun_attach_filter(tun);
3302 		break;
3303 
3304 	case TUNDETACHFILTER:
3305 		/* Can be set only for TAPs */
3306 		ret = -EINVAL;
3307 		if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3308 			break;
3309 		ret = 0;
3310 		tun_detach_filter(tun, tun->numqueues);
3311 		break;
3312 
3313 	case TUNGETFILTER:
3314 		ret = -EINVAL;
3315 		if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3316 			break;
3317 		ret = -EFAULT;
3318 		if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
3319 			break;
3320 		ret = 0;
3321 		break;
3322 
3323 	case TUNSETSTEERINGEBPF:
3324 		ret = tun_set_ebpf(tun, &tun->steering_prog, argp);
3325 		break;
3326 
3327 	case TUNSETFILTEREBPF:
3328 		ret = tun_set_ebpf(tun, &tun->filter_prog, argp);
3329 		break;
3330 
3331 	case TUNSETCARRIER:
3332 		ret = -EFAULT;
3333 		if (copy_from_user(&carrier, argp, sizeof(carrier)))
3334 			goto unlock;
3335 
3336 		ret = tun_net_change_carrier(tun->dev, (bool)carrier);
3337 		break;
3338 
3339 	case TUNGETDEVNETNS:
3340 		ret = -EPERM;
3341 		if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
3342 			goto unlock;
3343 		ret = open_related_ns(&net->ns, get_net_ns);
3344 		break;
3345 
3346 	default:
3347 		ret = -EINVAL;
3348 		break;
3349 	}
3350 
3351 	if (do_notify)
3352 		netdev_state_change(tun->dev);
3353 
3354 unlock:
3355 	rtnl_unlock();
3356 	if (tun)
3357 		tun_put(tun);
3358 	return ret;
3359 }
3360 
3361 static long tun_chr_ioctl(struct file *file,
3362 			  unsigned int cmd, unsigned long arg)
3363 {
3364 	return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
3365 }
3366 
3367 #ifdef CONFIG_COMPAT
3368 static long tun_chr_compat_ioctl(struct file *file,
3369 			 unsigned int cmd, unsigned long arg)
3370 {
3371 	switch (cmd) {
3372 	case TUNSETIFF:
3373 	case TUNGETIFF:
3374 	case TUNSETTXFILTER:
3375 	case TUNGETSNDBUF:
3376 	case TUNSETSNDBUF:
3377 	case SIOCGIFHWADDR:
3378 	case SIOCSIFHWADDR:
3379 		arg = (unsigned long)compat_ptr(arg);
3380 		break;
3381 	default:
3382 		arg = (compat_ulong_t)arg;
3383 		break;
3384 	}
3385 
3386 	/*
3387 	 * compat_ifreq is shorter than ifreq, so we must not access beyond
3388 	 * the end of that structure. All fields that are used in this
3389 	 * driver are compatible though, we don't need to convert the
3390 	 * contents.
3391 	 */
3392 	return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
3393 }
3394 #endif /* CONFIG_COMPAT */
3395 
3396 static int tun_chr_fasync(int fd, struct file *file, int on)
3397 {
3398 	struct tun_file *tfile = file->private_data;
3399 	int ret;
3400 
3401 	if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
3402 		goto out;
3403 
3404 	if (on) {
3405 		__f_setown(file, task_pid(current), PIDTYPE_TGID, 0);
3406 		tfile->flags |= TUN_FASYNC;
3407 	} else
3408 		tfile->flags &= ~TUN_FASYNC;
3409 	ret = 0;
3410 out:
3411 	return ret;
3412 }
3413 
3414 static int tun_chr_open(struct inode *inode, struct file * file)
3415 {
3416 	struct net *net = current->nsproxy->net_ns;
3417 	struct tun_file *tfile;
3418 
3419 	DBG1(KERN_INFO, "tunX: tun_chr_open\n");
3420 
3421 	tfile = (struct tun_file *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
3422 					    &tun_proto, 0);
3423 	if (!tfile)
3424 		return -ENOMEM;
3425 	if (ptr_ring_init(&tfile->tx_ring, 0, GFP_KERNEL)) {
3426 		sk_free(&tfile->sk);
3427 		return -ENOMEM;
3428 	}
3429 
3430 	mutex_init(&tfile->napi_mutex);
3431 	RCU_INIT_POINTER(tfile->tun, NULL);
3432 	tfile->flags = 0;
3433 	tfile->ifindex = 0;
3434 
3435 	init_waitqueue_head(&tfile->socket.wq.wait);
3436 
3437 	tfile->socket.file = file;
3438 	tfile->socket.ops = &tun_socket_ops;
3439 
3440 	sock_init_data(&tfile->socket, &tfile->sk);
3441 
3442 	tfile->sk.sk_write_space = tun_sock_write_space;
3443 	tfile->sk.sk_sndbuf = INT_MAX;
3444 
3445 	file->private_data = tfile;
3446 	INIT_LIST_HEAD(&tfile->next);
3447 
3448 	sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
3449 
3450 	return 0;
3451 }
3452 
3453 static int tun_chr_close(struct inode *inode, struct file *file)
3454 {
3455 	struct tun_file *tfile = file->private_data;
3456 
3457 	tun_detach(tfile, true);
3458 
3459 	return 0;
3460 }
3461 
3462 #ifdef CONFIG_PROC_FS
3463 static void tun_chr_show_fdinfo(struct seq_file *m, struct file *file)
3464 {
3465 	struct tun_file *tfile = file->private_data;
3466 	struct tun_struct *tun;
3467 	struct ifreq ifr;
3468 
3469 	memset(&ifr, 0, sizeof(ifr));
3470 
3471 	rtnl_lock();
3472 	tun = tun_get(tfile);
3473 	if (tun)
3474 		tun_get_iff(tun, &ifr);
3475 	rtnl_unlock();
3476 
3477 	if (tun)
3478 		tun_put(tun);
3479 
3480 	seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
3481 }
3482 #endif
3483 
3484 static const struct file_operations tun_fops = {
3485 	.owner	= THIS_MODULE,
3486 	.llseek = no_llseek,
3487 	.read_iter  = tun_chr_read_iter,
3488 	.write_iter = tun_chr_write_iter,
3489 	.poll	= tun_chr_poll,
3490 	.unlocked_ioctl	= tun_chr_ioctl,
3491 #ifdef CONFIG_COMPAT
3492 	.compat_ioctl = tun_chr_compat_ioctl,
3493 #endif
3494 	.open	= tun_chr_open,
3495 	.release = tun_chr_close,
3496 	.fasync = tun_chr_fasync,
3497 #ifdef CONFIG_PROC_FS
3498 	.show_fdinfo = tun_chr_show_fdinfo,
3499 #endif
3500 };
3501 
3502 static struct miscdevice tun_miscdev = {
3503 	.minor = TUN_MINOR,
3504 	.name = "tun",
3505 	.nodename = "net/tun",
3506 	.fops = &tun_fops,
3507 };
3508 
3509 /* ethtool interface */
3510 
3511 static void tun_default_link_ksettings(struct net_device *dev,
3512 				       struct ethtool_link_ksettings *cmd)
3513 {
3514 	ethtool_link_ksettings_zero_link_mode(cmd, supported);
3515 	ethtool_link_ksettings_zero_link_mode(cmd, advertising);
3516 	cmd->base.speed		= SPEED_10;
3517 	cmd->base.duplex	= DUPLEX_FULL;
3518 	cmd->base.port		= PORT_TP;
3519 	cmd->base.phy_address	= 0;
3520 	cmd->base.autoneg	= AUTONEG_DISABLE;
3521 }
3522 
3523 static int tun_get_link_ksettings(struct net_device *dev,
3524 				  struct ethtool_link_ksettings *cmd)
3525 {
3526 	struct tun_struct *tun = netdev_priv(dev);
3527 
3528 	memcpy(cmd, &tun->link_ksettings, sizeof(*cmd));
3529 	return 0;
3530 }
3531 
3532 static int tun_set_link_ksettings(struct net_device *dev,
3533 				  const struct ethtool_link_ksettings *cmd)
3534 {
3535 	struct tun_struct *tun = netdev_priv(dev);
3536 
3537 	memcpy(&tun->link_ksettings, cmd, sizeof(*cmd));
3538 	return 0;
3539 }
3540 
3541 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
3542 {
3543 	struct tun_struct *tun = netdev_priv(dev);
3544 
3545 	strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
3546 	strlcpy(info->version, DRV_VERSION, sizeof(info->version));
3547 
3548 	switch (tun->flags & TUN_TYPE_MASK) {
3549 	case IFF_TUN:
3550 		strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
3551 		break;
3552 	case IFF_TAP:
3553 		strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
3554 		break;
3555 	}
3556 }
3557 
3558 static u32 tun_get_msglevel(struct net_device *dev)
3559 {
3560 #ifdef TUN_DEBUG
3561 	struct tun_struct *tun = netdev_priv(dev);
3562 	return tun->debug;
3563 #else
3564 	return -EOPNOTSUPP;
3565 #endif
3566 }
3567 
3568 static void tun_set_msglevel(struct net_device *dev, u32 value)
3569 {
3570 #ifdef TUN_DEBUG
3571 	struct tun_struct *tun = netdev_priv(dev);
3572 	tun->debug = value;
3573 #endif
3574 }
3575 
3576 static int tun_get_coalesce(struct net_device *dev,
3577 			    struct ethtool_coalesce *ec)
3578 {
3579 	struct tun_struct *tun = netdev_priv(dev);
3580 
3581 	ec->rx_max_coalesced_frames = tun->rx_batched;
3582 
3583 	return 0;
3584 }
3585 
3586 static int tun_set_coalesce(struct net_device *dev,
3587 			    struct ethtool_coalesce *ec)
3588 {
3589 	struct tun_struct *tun = netdev_priv(dev);
3590 
3591 	if (ec->rx_max_coalesced_frames > NAPI_POLL_WEIGHT)
3592 		tun->rx_batched = NAPI_POLL_WEIGHT;
3593 	else
3594 		tun->rx_batched = ec->rx_max_coalesced_frames;
3595 
3596 	return 0;
3597 }
3598 
3599 static const struct ethtool_ops tun_ethtool_ops = {
3600 	.get_drvinfo	= tun_get_drvinfo,
3601 	.get_msglevel	= tun_get_msglevel,
3602 	.set_msglevel	= tun_set_msglevel,
3603 	.get_link	= ethtool_op_get_link,
3604 	.get_ts_info	= ethtool_op_get_ts_info,
3605 	.get_coalesce   = tun_get_coalesce,
3606 	.set_coalesce   = tun_set_coalesce,
3607 	.get_link_ksettings = tun_get_link_ksettings,
3608 	.set_link_ksettings = tun_set_link_ksettings,
3609 };
3610 
3611 static int tun_queue_resize(struct tun_struct *tun)
3612 {
3613 	struct net_device *dev = tun->dev;
3614 	struct tun_file *tfile;
3615 	struct ptr_ring **rings;
3616 	int n = tun->numqueues + tun->numdisabled;
3617 	int ret, i;
3618 
3619 	rings = kmalloc_array(n, sizeof(*rings), GFP_KERNEL);
3620 	if (!rings)
3621 		return -ENOMEM;
3622 
3623 	for (i = 0; i < tun->numqueues; i++) {
3624 		tfile = rtnl_dereference(tun->tfiles[i]);
3625 		rings[i] = &tfile->tx_ring;
3626 	}
3627 	list_for_each_entry(tfile, &tun->disabled, next)
3628 		rings[i++] = &tfile->tx_ring;
3629 
3630 	ret = ptr_ring_resize_multiple(rings, n,
3631 				       dev->tx_queue_len, GFP_KERNEL,
3632 				       tun_ptr_free);
3633 
3634 	kfree(rings);
3635 	return ret;
3636 }
3637 
3638 static int tun_device_event(struct notifier_block *unused,
3639 			    unsigned long event, void *ptr)
3640 {
3641 	struct net_device *dev = netdev_notifier_info_to_dev(ptr);
3642 	struct tun_struct *tun = netdev_priv(dev);
3643 	int i;
3644 
3645 	if (dev->rtnl_link_ops != &tun_link_ops)
3646 		return NOTIFY_DONE;
3647 
3648 	switch (event) {
3649 	case NETDEV_CHANGE_TX_QUEUE_LEN:
3650 		if (tun_queue_resize(tun))
3651 			return NOTIFY_BAD;
3652 		break;
3653 	case NETDEV_UP:
3654 		for (i = 0; i < tun->numqueues; i++) {
3655 			struct tun_file *tfile;
3656 
3657 			tfile = rtnl_dereference(tun->tfiles[i]);
3658 			tfile->socket.sk->sk_write_space(tfile->socket.sk);
3659 		}
3660 		break;
3661 	default:
3662 		break;
3663 	}
3664 
3665 	return NOTIFY_DONE;
3666 }
3667 
3668 static struct notifier_block tun_notifier_block __read_mostly = {
3669 	.notifier_call	= tun_device_event,
3670 };
3671 
3672 static int __init tun_init(void)
3673 {
3674 	int ret = 0;
3675 
3676 	pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
3677 
3678 	ret = rtnl_link_register(&tun_link_ops);
3679 	if (ret) {
3680 		pr_err("Can't register link_ops\n");
3681 		goto err_linkops;
3682 	}
3683 
3684 	ret = misc_register(&tun_miscdev);
3685 	if (ret) {
3686 		pr_err("Can't register misc device %d\n", TUN_MINOR);
3687 		goto err_misc;
3688 	}
3689 
3690 	ret = register_netdevice_notifier(&tun_notifier_block);
3691 	if (ret) {
3692 		pr_err("Can't register netdevice notifier\n");
3693 		goto err_notifier;
3694 	}
3695 
3696 	return  0;
3697 
3698 err_notifier:
3699 	misc_deregister(&tun_miscdev);
3700 err_misc:
3701 	rtnl_link_unregister(&tun_link_ops);
3702 err_linkops:
3703 	return ret;
3704 }
3705 
3706 static void tun_cleanup(void)
3707 {
3708 	misc_deregister(&tun_miscdev);
3709 	rtnl_link_unregister(&tun_link_ops);
3710 	unregister_netdevice_notifier(&tun_notifier_block);
3711 }
3712 
3713 /* Get an underlying socket object from tun file.  Returns error unless file is
3714  * attached to a device.  The returned object works like a packet socket, it
3715  * can be used for sock_sendmsg/sock_recvmsg.  The caller is responsible for
3716  * holding a reference to the file for as long as the socket is in use. */
3717 struct socket *tun_get_socket(struct file *file)
3718 {
3719 	struct tun_file *tfile;
3720 	if (file->f_op != &tun_fops)
3721 		return ERR_PTR(-EINVAL);
3722 	tfile = file->private_data;
3723 	if (!tfile)
3724 		return ERR_PTR(-EBADFD);
3725 	return &tfile->socket;
3726 }
3727 EXPORT_SYMBOL_GPL(tun_get_socket);
3728 
3729 struct ptr_ring *tun_get_tx_ring(struct file *file)
3730 {
3731 	struct tun_file *tfile;
3732 
3733 	if (file->f_op != &tun_fops)
3734 		return ERR_PTR(-EINVAL);
3735 	tfile = file->private_data;
3736 	if (!tfile)
3737 		return ERR_PTR(-EBADFD);
3738 	return &tfile->tx_ring;
3739 }
3740 EXPORT_SYMBOL_GPL(tun_get_tx_ring);
3741 
3742 module_init(tun_init);
3743 module_exit(tun_cleanup);
3744 MODULE_DESCRIPTION(DRV_DESCRIPTION);
3745 MODULE_AUTHOR(DRV_COPYRIGHT);
3746 MODULE_LICENSE("GPL");
3747 MODULE_ALIAS_MISCDEV(TUN_MINOR);
3748 MODULE_ALIAS("devname:net/tun");
3749