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