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