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