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