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/major.h>
48 #include <linux/slab.h>
49 #include <linux/poll.h>
50 #include <linux/fcntl.h>
51 #include <linux/init.h>
52 #include <linux/skbuff.h>
53 #include <linux/netdevice.h>
54 #include <linux/etherdevice.h>
55 #include <linux/miscdevice.h>
56 #include <linux/ethtool.h>
57 #include <linux/rtnetlink.h>
58 #include <linux/compat.h>
59 #include <linux/if.h>
60 #include <linux/if_arp.h>
61 #include <linux/if_ether.h>
62 #include <linux/if_tun.h>
63 #include <linux/if_vlan.h>
64 #include <linux/crc32.h>
65 #include <linux/nsproxy.h>
66 #include <linux/virtio_net.h>
67 #include <linux/rcupdate.h>
68 #include <net/net_namespace.h>
69 #include <net/netns/generic.h>
70 #include <net/rtnetlink.h>
71 #include <net/sock.h>
72 #include <linux/seq_file.h>
73 #include <linux/uio.h>
74 
75 #include <asm/uaccess.h>
76 
77 /* Uncomment to enable debugging */
78 /* #define TUN_DEBUG 1 */
79 
80 #ifdef TUN_DEBUG
81 static int debug;
82 
83 #define tun_debug(level, tun, fmt, args...)			\
84 do {								\
85 	if (tun->debug)						\
86 		netdev_printk(level, tun->dev, fmt, ##args);	\
87 } while (0)
88 #define DBG1(level, fmt, args...)				\
89 do {								\
90 	if (debug == 2)						\
91 		printk(level fmt, ##args);			\
92 } while (0)
93 #else
94 #define tun_debug(level, tun, fmt, args...)			\
95 do {								\
96 	if (0)							\
97 		netdev_printk(level, tun->dev, fmt, ##args);	\
98 } while (0)
99 #define DBG1(level, fmt, args...)				\
100 do {								\
101 	if (0)							\
102 		printk(level fmt, ##args);			\
103 } while (0)
104 #endif
105 
106 /* TUN device flags */
107 
108 /* IFF_ATTACH_QUEUE is never stored in device flags,
109  * overload it to mean fasync when stored there.
110  */
111 #define TUN_FASYNC	IFF_ATTACH_QUEUE
112 /* High bits in flags field are unused. */
113 #define TUN_VNET_LE     0x80000000
114 #define TUN_VNET_BE     0x40000000
115 
116 #define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
117 		      IFF_MULTI_QUEUE)
118 #define GOODCOPY_LEN 128
119 
120 #define FLT_EXACT_COUNT 8
121 struct tap_filter {
122 	unsigned int    count;    /* Number of addrs. Zero means disabled */
123 	u32             mask[2];  /* Mask of the hashed addrs */
124 	unsigned char	addr[FLT_EXACT_COUNT][ETH_ALEN];
125 };
126 
127 /* MAX_TAP_QUEUES 256 is chosen to allow rx/tx queues to be equal
128  * to max number of VCPUs in guest. */
129 #define MAX_TAP_QUEUES 256
130 #define MAX_TAP_FLOWS  4096
131 
132 #define TUN_FLOW_EXPIRE (3 * HZ)
133 
134 /* A tun_file connects an open character device to a tuntap netdevice. It
135  * also contains all socket related structures (except sock_fprog and tap_filter)
136  * to serve as one transmit queue for tuntap device. The sock_fprog and
137  * tap_filter were kept in tun_struct since they were used for filtering for the
138  * netdevice not for a specific queue (at least I didn't see the requirement for
139  * this).
140  *
141  * RCU usage:
142  * The tun_file and tun_struct are loosely coupled, the pointer from one to the
143  * other can only be read while rcu_read_lock or rtnl_lock is held.
144  */
145 struct tun_file {
146 	struct sock sk;
147 	struct socket socket;
148 	struct socket_wq wq;
149 	struct tun_struct __rcu *tun;
150 	struct fasync_struct *fasync;
151 	/* only used for fasnyc */
152 	unsigned int flags;
153 	union {
154 		u16 queue_index;
155 		unsigned int ifindex;
156 	};
157 	struct list_head next;
158 	struct tun_struct *detached;
159 };
160 
161 struct tun_flow_entry {
162 	struct hlist_node hash_link;
163 	struct rcu_head rcu;
164 	struct tun_struct *tun;
165 
166 	u32 rxhash;
167 	u32 rps_rxhash;
168 	int queue_index;
169 	unsigned long updated;
170 };
171 
172 #define TUN_NUM_FLOW_ENTRIES 1024
173 
174 /* Since the socket were moved to tun_file, to preserve the behavior of persist
175  * device, socket filter, sndbuf and vnet header size were restore when the
176  * file were attached to a persist device.
177  */
178 struct tun_struct {
179 	struct tun_file __rcu	*tfiles[MAX_TAP_QUEUES];
180 	unsigned int            numqueues;
181 	unsigned int 		flags;
182 	kuid_t			owner;
183 	kgid_t			group;
184 
185 	struct net_device	*dev;
186 	netdev_features_t	set_features;
187 #define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
188 			  NETIF_F_TSO6|NETIF_F_UFO)
189 
190 	int			vnet_hdr_sz;
191 	int			sndbuf;
192 	struct tap_filter	txflt;
193 	struct sock_fprog	fprog;
194 	/* protected by rtnl lock */
195 	bool			filter_attached;
196 #ifdef TUN_DEBUG
197 	int debug;
198 #endif
199 	spinlock_t lock;
200 	struct hlist_head flows[TUN_NUM_FLOW_ENTRIES];
201 	struct timer_list flow_gc_timer;
202 	unsigned long ageing_time;
203 	unsigned int numdisabled;
204 	struct list_head disabled;
205 	void *security;
206 	u32 flow_count;
207 };
208 
209 #ifdef CONFIG_TUN_VNET_CROSS_LE
tun_legacy_is_little_endian(struct tun_struct * tun)210 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
211 {
212 	return tun->flags & TUN_VNET_BE ? false :
213 		virtio_legacy_is_little_endian();
214 }
215 
tun_get_vnet_be(struct tun_struct * tun,int __user * argp)216 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
217 {
218 	int be = !!(tun->flags & TUN_VNET_BE);
219 
220 	if (put_user(be, argp))
221 		return -EFAULT;
222 
223 	return 0;
224 }
225 
tun_set_vnet_be(struct tun_struct * tun,int __user * argp)226 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
227 {
228 	int be;
229 
230 	if (get_user(be, argp))
231 		return -EFAULT;
232 
233 	if (be)
234 		tun->flags |= TUN_VNET_BE;
235 	else
236 		tun->flags &= ~TUN_VNET_BE;
237 
238 	return 0;
239 }
240 #else
tun_legacy_is_little_endian(struct tun_struct * tun)241 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
242 {
243 	return virtio_legacy_is_little_endian();
244 }
245 
tun_get_vnet_be(struct tun_struct * tun,int __user * argp)246 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
247 {
248 	return -EINVAL;
249 }
250 
tun_set_vnet_be(struct tun_struct * tun,int __user * argp)251 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
252 {
253 	return -EINVAL;
254 }
255 #endif /* CONFIG_TUN_VNET_CROSS_LE */
256 
tun_is_little_endian(struct tun_struct * tun)257 static inline bool tun_is_little_endian(struct tun_struct *tun)
258 {
259 	return tun->flags & TUN_VNET_LE ||
260 		tun_legacy_is_little_endian(tun);
261 }
262 
tun16_to_cpu(struct tun_struct * tun,__virtio16 val)263 static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
264 {
265 	return __virtio16_to_cpu(tun_is_little_endian(tun), val);
266 }
267 
cpu_to_tun16(struct tun_struct * tun,u16 val)268 static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
269 {
270 	return __cpu_to_virtio16(tun_is_little_endian(tun), val);
271 }
272 
tun_hashfn(u32 rxhash)273 static inline u32 tun_hashfn(u32 rxhash)
274 {
275 	return rxhash & 0x3ff;
276 }
277 
tun_flow_find(struct hlist_head * head,u32 rxhash)278 static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
279 {
280 	struct tun_flow_entry *e;
281 
282 	hlist_for_each_entry_rcu(e, head, hash_link) {
283 		if (e->rxhash == rxhash)
284 			return e;
285 	}
286 	return NULL;
287 }
288 
tun_flow_create(struct tun_struct * tun,struct hlist_head * head,u32 rxhash,u16 queue_index)289 static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
290 					      struct hlist_head *head,
291 					      u32 rxhash, u16 queue_index)
292 {
293 	struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
294 
295 	if (e) {
296 		tun_debug(KERN_INFO, tun, "create flow: hash %u index %u\n",
297 			  rxhash, queue_index);
298 		e->updated = jiffies;
299 		e->rxhash = rxhash;
300 		e->rps_rxhash = 0;
301 		e->queue_index = queue_index;
302 		e->tun = tun;
303 		hlist_add_head_rcu(&e->hash_link, head);
304 		++tun->flow_count;
305 	}
306 	return e;
307 }
308 
tun_flow_delete(struct tun_struct * tun,struct tun_flow_entry * e)309 static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
310 {
311 	tun_debug(KERN_INFO, tun, "delete flow: hash %u index %u\n",
312 		  e->rxhash, e->queue_index);
313 	hlist_del_rcu(&e->hash_link);
314 	kfree_rcu(e, rcu);
315 	--tun->flow_count;
316 }
317 
tun_flow_flush(struct tun_struct * tun)318 static void tun_flow_flush(struct tun_struct *tun)
319 {
320 	int i;
321 
322 	spin_lock_bh(&tun->lock);
323 	for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
324 		struct tun_flow_entry *e;
325 		struct hlist_node *n;
326 
327 		hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
328 			tun_flow_delete(tun, e);
329 	}
330 	spin_unlock_bh(&tun->lock);
331 }
332 
tun_flow_delete_by_queue(struct tun_struct * tun,u16 queue_index)333 static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
334 {
335 	int i;
336 
337 	spin_lock_bh(&tun->lock);
338 	for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
339 		struct tun_flow_entry *e;
340 		struct hlist_node *n;
341 
342 		hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
343 			if (e->queue_index == queue_index)
344 				tun_flow_delete(tun, e);
345 		}
346 	}
347 	spin_unlock_bh(&tun->lock);
348 }
349 
tun_flow_cleanup(unsigned long data)350 static void tun_flow_cleanup(unsigned long data)
351 {
352 	struct tun_struct *tun = (struct tun_struct *)data;
353 	unsigned long delay = tun->ageing_time;
354 	unsigned long next_timer = jiffies + delay;
355 	unsigned long count = 0;
356 	int i;
357 
358 	tun_debug(KERN_INFO, tun, "tun_flow_cleanup\n");
359 
360 	spin_lock_bh(&tun->lock);
361 	for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
362 		struct tun_flow_entry *e;
363 		struct hlist_node *n;
364 
365 		hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
366 			unsigned long this_timer;
367 			count++;
368 			this_timer = e->updated + delay;
369 			if (time_before_eq(this_timer, jiffies))
370 				tun_flow_delete(tun, e);
371 			else if (time_before(this_timer, next_timer))
372 				next_timer = this_timer;
373 		}
374 	}
375 
376 	if (count)
377 		mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
378 	spin_unlock_bh(&tun->lock);
379 }
380 
tun_flow_update(struct tun_struct * tun,u32 rxhash,struct tun_file * tfile)381 static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
382 			    struct tun_file *tfile)
383 {
384 	struct hlist_head *head;
385 	struct tun_flow_entry *e;
386 	unsigned long delay = tun->ageing_time;
387 	u16 queue_index = tfile->queue_index;
388 
389 	if (!rxhash)
390 		return;
391 	else
392 		head = &tun->flows[tun_hashfn(rxhash)];
393 
394 	rcu_read_lock();
395 
396 	/* We may get a very small possibility of OOO during switching, not
397 	 * worth to optimize.*/
398 	if (tun->numqueues == 1 || tfile->detached)
399 		goto unlock;
400 
401 	e = tun_flow_find(head, rxhash);
402 	if (likely(e)) {
403 		/* TODO: keep queueing to old queue until it's empty? */
404 		e->queue_index = queue_index;
405 		e->updated = jiffies;
406 		sock_rps_record_flow_hash(e->rps_rxhash);
407 	} else {
408 		spin_lock_bh(&tun->lock);
409 		if (!tun_flow_find(head, rxhash) &&
410 		    tun->flow_count < MAX_TAP_FLOWS)
411 			tun_flow_create(tun, head, rxhash, queue_index);
412 
413 		if (!timer_pending(&tun->flow_gc_timer))
414 			mod_timer(&tun->flow_gc_timer,
415 				  round_jiffies_up(jiffies + delay));
416 		spin_unlock_bh(&tun->lock);
417 	}
418 
419 unlock:
420 	rcu_read_unlock();
421 }
422 
423 /**
424  * Save the hash received in the stack receive path and update the
425  * flow_hash table accordingly.
426  */
tun_flow_save_rps_rxhash(struct tun_flow_entry * e,u32 hash)427 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry *e, u32 hash)
428 {
429 	if (unlikely(e->rps_rxhash != hash))
430 		e->rps_rxhash = hash;
431 }
432 
433 /* We try to identify a flow through its rxhash first. The reason that
434  * we do not check rxq no. is because some cards(e.g 82599), chooses
435  * the rxq based on the txq where the last packet of the flow comes. As
436  * the userspace application move between processors, we may get a
437  * different rxq no. here. If we could not get rxhash, then we would
438  * hope the rxq no. may help here.
439  */
tun_select_queue(struct net_device * dev,struct sk_buff * skb,void * accel_priv,select_queue_fallback_t fallback)440 static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb,
441 			    void *accel_priv, select_queue_fallback_t fallback)
442 {
443 	struct tun_struct *tun = netdev_priv(dev);
444 	struct tun_flow_entry *e;
445 	u32 txq = 0;
446 	u32 numqueues = 0;
447 
448 	rcu_read_lock();
449 	numqueues = ACCESS_ONCE(tun->numqueues);
450 
451 	txq = skb_get_hash(skb);
452 	if (txq) {
453 		e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
454 		if (e) {
455 			tun_flow_save_rps_rxhash(e, txq);
456 			txq = e->queue_index;
457 		} else
458 			/* use multiply and shift instead of expensive divide */
459 			txq = ((u64)txq * numqueues) >> 32;
460 	} else if (likely(skb_rx_queue_recorded(skb))) {
461 		txq = skb_get_rx_queue(skb);
462 		while (unlikely(txq >= numqueues))
463 			txq -= numqueues;
464 	}
465 
466 	rcu_read_unlock();
467 	return txq;
468 }
469 
tun_not_capable(struct tun_struct * tun)470 static inline bool tun_not_capable(struct tun_struct *tun)
471 {
472 	const struct cred *cred = current_cred();
473 	struct net *net = dev_net(tun->dev);
474 
475 	return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
476 		  (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
477 		!ns_capable(net->user_ns, CAP_NET_ADMIN);
478 }
479 
tun_set_real_num_queues(struct tun_struct * tun)480 static void tun_set_real_num_queues(struct tun_struct *tun)
481 {
482 	netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
483 	netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
484 }
485 
tun_disable_queue(struct tun_struct * tun,struct tun_file * tfile)486 static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
487 {
488 	tfile->detached = tun;
489 	list_add_tail(&tfile->next, &tun->disabled);
490 	++tun->numdisabled;
491 }
492 
tun_enable_queue(struct tun_file * tfile)493 static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
494 {
495 	struct tun_struct *tun = tfile->detached;
496 
497 	tfile->detached = NULL;
498 	list_del_init(&tfile->next);
499 	--tun->numdisabled;
500 	return tun;
501 }
502 
tun_queue_purge(struct tun_file * tfile)503 static void tun_queue_purge(struct tun_file *tfile)
504 {
505 	skb_queue_purge(&tfile->sk.sk_receive_queue);
506 	skb_queue_purge(&tfile->sk.sk_error_queue);
507 }
508 
__tun_detach(struct tun_file * tfile,bool clean)509 static void __tun_detach(struct tun_file *tfile, bool clean)
510 {
511 	struct tun_file *ntfile;
512 	struct tun_struct *tun;
513 
514 	tun = rtnl_dereference(tfile->tun);
515 
516 	if (tun && !tfile->detached) {
517 		u16 index = tfile->queue_index;
518 		BUG_ON(index >= tun->numqueues);
519 
520 		rcu_assign_pointer(tun->tfiles[index],
521 				   tun->tfiles[tun->numqueues - 1]);
522 		ntfile = rtnl_dereference(tun->tfiles[index]);
523 		ntfile->queue_index = index;
524 
525 		--tun->numqueues;
526 		if (clean) {
527 			RCU_INIT_POINTER(tfile->tun, NULL);
528 			sock_put(&tfile->sk);
529 		} else
530 			tun_disable_queue(tun, tfile);
531 
532 		synchronize_net();
533 		tun_flow_delete_by_queue(tun, tun->numqueues + 1);
534 		/* Drop read queue */
535 		tun_queue_purge(tfile);
536 		tun_set_real_num_queues(tun);
537 	} else if (tfile->detached && clean) {
538 		tun = tun_enable_queue(tfile);
539 		sock_put(&tfile->sk);
540 	}
541 
542 	if (clean) {
543 		if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
544 			netif_carrier_off(tun->dev);
545 
546 			if (!(tun->flags & IFF_PERSIST) &&
547 			    tun->dev->reg_state == NETREG_REGISTERED)
548 				unregister_netdevice(tun->dev);
549 		}
550 		sock_put(&tfile->sk);
551 	}
552 }
553 
tun_detach(struct tun_file * tfile,bool clean)554 static void tun_detach(struct tun_file *tfile, bool clean)
555 {
556 	rtnl_lock();
557 	__tun_detach(tfile, clean);
558 	rtnl_unlock();
559 }
560 
tun_detach_all(struct net_device * dev)561 static void tun_detach_all(struct net_device *dev)
562 {
563 	struct tun_struct *tun = netdev_priv(dev);
564 	struct tun_file *tfile, *tmp;
565 	int i, n = tun->numqueues;
566 
567 	for (i = 0; i < n; i++) {
568 		tfile = rtnl_dereference(tun->tfiles[i]);
569 		BUG_ON(!tfile);
570 		tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
571 		tfile->socket.sk->sk_data_ready(tfile->socket.sk);
572 		RCU_INIT_POINTER(tfile->tun, NULL);
573 		--tun->numqueues;
574 	}
575 	list_for_each_entry(tfile, &tun->disabled, next) {
576 		tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
577 		tfile->socket.sk->sk_data_ready(tfile->socket.sk);
578 		RCU_INIT_POINTER(tfile->tun, NULL);
579 	}
580 	BUG_ON(tun->numqueues != 0);
581 
582 	synchronize_net();
583 	for (i = 0; i < n; i++) {
584 		tfile = rtnl_dereference(tun->tfiles[i]);
585 		/* Drop read queue */
586 		tun_queue_purge(tfile);
587 		sock_put(&tfile->sk);
588 	}
589 	list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
590 		tun_enable_queue(tfile);
591 		tun_queue_purge(tfile);
592 		sock_put(&tfile->sk);
593 	}
594 	BUG_ON(tun->numdisabled != 0);
595 
596 	if (tun->flags & IFF_PERSIST)
597 		module_put(THIS_MODULE);
598 }
599 
tun_attach(struct tun_struct * tun,struct file * file,bool skip_filter)600 static int tun_attach(struct tun_struct *tun, struct file *file, bool skip_filter)
601 {
602 	struct tun_file *tfile = file->private_data;
603 	int err;
604 
605 	err = security_tun_dev_attach(tfile->socket.sk, tun->security);
606 	if (err < 0)
607 		goto out;
608 
609 	err = -EINVAL;
610 	if (rtnl_dereference(tfile->tun) && !tfile->detached)
611 		goto out;
612 
613 	err = -EBUSY;
614 	if (!(tun->flags & IFF_MULTI_QUEUE) && tun->numqueues == 1)
615 		goto out;
616 
617 	err = -E2BIG;
618 	if (!tfile->detached &&
619 	    tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
620 		goto out;
621 
622 	err = 0;
623 
624 	/* Re-attach the filter to persist device */
625 	if (!skip_filter && (tun->filter_attached == true)) {
626 		err = __sk_attach_filter(&tun->fprog, tfile->socket.sk,
627 					 lockdep_rtnl_is_held());
628 		if (!err)
629 			goto out;
630 	}
631 	tfile->queue_index = tun->numqueues;
632 	tfile->socket.sk->sk_shutdown &= ~RCV_SHUTDOWN;
633 	rcu_assign_pointer(tfile->tun, tun);
634 	rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
635 	tun->numqueues++;
636 
637 	if (tfile->detached)
638 		tun_enable_queue(tfile);
639 	else
640 		sock_hold(&tfile->sk);
641 
642 	tun_set_real_num_queues(tun);
643 
644 	/* device is allowed to go away first, so no need to hold extra
645 	 * refcnt.
646 	 */
647 
648 out:
649 	return err;
650 }
651 
__tun_get(struct tun_file * tfile)652 static struct tun_struct *__tun_get(struct tun_file *tfile)
653 {
654 	struct tun_struct *tun;
655 
656 	rcu_read_lock();
657 	tun = rcu_dereference(tfile->tun);
658 	if (tun)
659 		dev_hold(tun->dev);
660 	rcu_read_unlock();
661 
662 	return tun;
663 }
664 
tun_get(struct file * file)665 static struct tun_struct *tun_get(struct file *file)
666 {
667 	return __tun_get(file->private_data);
668 }
669 
tun_put(struct tun_struct * tun)670 static void tun_put(struct tun_struct *tun)
671 {
672 	dev_put(tun->dev);
673 }
674 
675 /* TAP filtering */
addr_hash_set(u32 * mask,const u8 * addr)676 static void addr_hash_set(u32 *mask, const u8 *addr)
677 {
678 	int n = ether_crc(ETH_ALEN, addr) >> 26;
679 	mask[n >> 5] |= (1 << (n & 31));
680 }
681 
addr_hash_test(const u32 * mask,const u8 * addr)682 static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
683 {
684 	int n = ether_crc(ETH_ALEN, addr) >> 26;
685 	return mask[n >> 5] & (1 << (n & 31));
686 }
687 
update_filter(struct tap_filter * filter,void __user * arg)688 static int update_filter(struct tap_filter *filter, void __user *arg)
689 {
690 	struct { u8 u[ETH_ALEN]; } *addr;
691 	struct tun_filter uf;
692 	int err, alen, n, nexact;
693 
694 	if (copy_from_user(&uf, arg, sizeof(uf)))
695 		return -EFAULT;
696 
697 	if (!uf.count) {
698 		/* Disabled */
699 		filter->count = 0;
700 		return 0;
701 	}
702 
703 	alen = ETH_ALEN * uf.count;
704 	addr = kmalloc(alen, GFP_KERNEL);
705 	if (!addr)
706 		return -ENOMEM;
707 
708 	if (copy_from_user(addr, arg + sizeof(uf), alen)) {
709 		err = -EFAULT;
710 		goto done;
711 	}
712 
713 	/* The filter is updated without holding any locks. Which is
714 	 * perfectly safe. We disable it first and in the worst
715 	 * case we'll accept a few undesired packets. */
716 	filter->count = 0;
717 	wmb();
718 
719 	/* Use first set of addresses as an exact filter */
720 	for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
721 		memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
722 
723 	nexact = n;
724 
725 	/* Remaining multicast addresses are hashed,
726 	 * unicast will leave the filter disabled. */
727 	memset(filter->mask, 0, sizeof(filter->mask));
728 	for (; n < uf.count; n++) {
729 		if (!is_multicast_ether_addr(addr[n].u)) {
730 			err = 0; /* no filter */
731 			goto done;
732 		}
733 		addr_hash_set(filter->mask, addr[n].u);
734 	}
735 
736 	/* For ALLMULTI just set the mask to all ones.
737 	 * This overrides the mask populated above. */
738 	if ((uf.flags & TUN_FLT_ALLMULTI))
739 		memset(filter->mask, ~0, sizeof(filter->mask));
740 
741 	/* Now enable the filter */
742 	wmb();
743 	filter->count = nexact;
744 
745 	/* Return the number of exact filters */
746 	err = nexact;
747 
748 done:
749 	kfree(addr);
750 	return err;
751 }
752 
753 /* Returns: 0 - drop, !=0 - accept */
run_filter(struct tap_filter * filter,const struct sk_buff * skb)754 static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
755 {
756 	/* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
757 	 * at this point. */
758 	struct ethhdr *eh = (struct ethhdr *) skb->data;
759 	int i;
760 
761 	/* Exact match */
762 	for (i = 0; i < filter->count; i++)
763 		if (ether_addr_equal(eh->h_dest, filter->addr[i]))
764 			return 1;
765 
766 	/* Inexact match (multicast only) */
767 	if (is_multicast_ether_addr(eh->h_dest))
768 		return addr_hash_test(filter->mask, eh->h_dest);
769 
770 	return 0;
771 }
772 
773 /*
774  * Checks whether the packet is accepted or not.
775  * Returns: 0 - drop, !=0 - accept
776  */
check_filter(struct tap_filter * filter,const struct sk_buff * skb)777 static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
778 {
779 	if (!filter->count)
780 		return 1;
781 
782 	return run_filter(filter, skb);
783 }
784 
785 /* Network device part of the driver */
786 
787 static const struct ethtool_ops tun_ethtool_ops;
788 
789 /* Net device detach from fd. */
tun_net_uninit(struct net_device * dev)790 static void tun_net_uninit(struct net_device *dev)
791 {
792 	tun_detach_all(dev);
793 }
794 
795 /* Net device open. */
tun_net_open(struct net_device * dev)796 static int tun_net_open(struct net_device *dev)
797 {
798 	netif_tx_start_all_queues(dev);
799 	return 0;
800 }
801 
802 /* Net device close. */
tun_net_close(struct net_device * dev)803 static int tun_net_close(struct net_device *dev)
804 {
805 	netif_tx_stop_all_queues(dev);
806 	return 0;
807 }
808 
809 /* Net device start xmit */
tun_net_xmit(struct sk_buff * skb,struct net_device * dev)810 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
811 {
812 	struct tun_struct *tun = netdev_priv(dev);
813 	int txq = skb->queue_mapping;
814 	struct tun_file *tfile;
815 	u32 numqueues = 0;
816 
817 	rcu_read_lock();
818 	tfile = rcu_dereference(tun->tfiles[txq]);
819 	numqueues = ACCESS_ONCE(tun->numqueues);
820 
821 	/* Drop packet if interface is not attached */
822 	if (txq >= numqueues)
823 		goto drop;
824 
825 	if (numqueues == 1) {
826 		/* Select queue was not called for the skbuff, so we extract the
827 		 * RPS hash and save it into the flow_table here.
828 		 */
829 		__u32 rxhash;
830 
831 		rxhash = skb_get_hash(skb);
832 		if (rxhash) {
833 			struct tun_flow_entry *e;
834 			e = tun_flow_find(&tun->flows[tun_hashfn(rxhash)],
835 					rxhash);
836 			if (e)
837 				tun_flow_save_rps_rxhash(e, rxhash);
838 		}
839 	}
840 
841 	tun_debug(KERN_INFO, tun, "tun_net_xmit %d\n", skb->len);
842 
843 	BUG_ON(!tfile);
844 
845 	/* Drop if the filter does not like it.
846 	 * This is a noop if the filter is disabled.
847 	 * Filter can be enabled only for the TAP devices. */
848 	if (!check_filter(&tun->txflt, skb))
849 		goto drop;
850 
851 	if (tfile->socket.sk->sk_filter &&
852 	    sk_filter(tfile->socket.sk, skb))
853 		goto drop;
854 
855 	/* Limit the number of packets queued by dividing txq length with the
856 	 * number of queues.
857 	 */
858 	if (skb_queue_len(&tfile->socket.sk->sk_receive_queue) * numqueues
859 			  >= dev->tx_queue_len)
860 		goto drop;
861 
862 	if (unlikely(skb_orphan_frags(skb, GFP_ATOMIC)))
863 		goto drop;
864 
865 	if (skb->sk && sk_fullsock(skb->sk)) {
866 		sock_tx_timestamp(skb->sk, &skb_shinfo(skb)->tx_flags);
867 		sw_tx_timestamp(skb);
868 	}
869 
870 	/* Orphan the skb - required as we might hang on to it
871 	 * for indefinite time.
872 	 */
873 	skb_orphan(skb);
874 
875 	nf_reset(skb);
876 
877 	/* Enqueue packet */
878 	skb_queue_tail(&tfile->socket.sk->sk_receive_queue, skb);
879 
880 	/* Notify and wake up reader process */
881 	if (tfile->flags & TUN_FASYNC)
882 		kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
883 	tfile->socket.sk->sk_data_ready(tfile->socket.sk);
884 
885 	rcu_read_unlock();
886 	return NETDEV_TX_OK;
887 
888 drop:
889 	dev->stats.tx_dropped++;
890 	skb_tx_error(skb);
891 	kfree_skb(skb);
892 	rcu_read_unlock();
893 	return NET_XMIT_DROP;
894 }
895 
tun_net_mclist(struct net_device * dev)896 static void tun_net_mclist(struct net_device *dev)
897 {
898 	/*
899 	 * This callback is supposed to deal with mc filter in
900 	 * _rx_ path and has nothing to do with the _tx_ path.
901 	 * In rx path we always accept everything userspace gives us.
902 	 */
903 }
904 
905 #define MIN_MTU 68
906 #define MAX_MTU 65535
907 
908 static int
tun_net_change_mtu(struct net_device * dev,int new_mtu)909 tun_net_change_mtu(struct net_device *dev, int new_mtu)
910 {
911 	if (new_mtu < MIN_MTU || new_mtu + dev->hard_header_len > MAX_MTU)
912 		return -EINVAL;
913 	dev->mtu = new_mtu;
914 	return 0;
915 }
916 
tun_net_fix_features(struct net_device * dev,netdev_features_t features)917 static netdev_features_t tun_net_fix_features(struct net_device *dev,
918 	netdev_features_t features)
919 {
920 	struct tun_struct *tun = netdev_priv(dev);
921 
922 	return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
923 }
924 #ifdef CONFIG_NET_POLL_CONTROLLER
tun_poll_controller(struct net_device * dev)925 static void tun_poll_controller(struct net_device *dev)
926 {
927 	/*
928 	 * Tun only receives frames when:
929 	 * 1) the char device endpoint gets data from user space
930 	 * 2) the tun socket gets a sendmsg call from user space
931 	 * Since both of those are synchronous operations, we are guaranteed
932 	 * never to have pending data when we poll for it
933 	 * so there is nothing to do here but return.
934 	 * We need this though so netpoll recognizes us as an interface that
935 	 * supports polling, which enables bridge devices in virt setups to
936 	 * still use netconsole
937 	 */
938 	return;
939 }
940 #endif
941 static const struct net_device_ops tun_netdev_ops = {
942 	.ndo_uninit		= tun_net_uninit,
943 	.ndo_open		= tun_net_open,
944 	.ndo_stop		= tun_net_close,
945 	.ndo_start_xmit		= tun_net_xmit,
946 	.ndo_change_mtu		= tun_net_change_mtu,
947 	.ndo_fix_features	= tun_net_fix_features,
948 	.ndo_select_queue	= tun_select_queue,
949 #ifdef CONFIG_NET_POLL_CONTROLLER
950 	.ndo_poll_controller	= tun_poll_controller,
951 #endif
952 };
953 
954 static const struct net_device_ops tap_netdev_ops = {
955 	.ndo_uninit		= tun_net_uninit,
956 	.ndo_open		= tun_net_open,
957 	.ndo_stop		= tun_net_close,
958 	.ndo_start_xmit		= tun_net_xmit,
959 	.ndo_change_mtu		= tun_net_change_mtu,
960 	.ndo_fix_features	= tun_net_fix_features,
961 	.ndo_set_rx_mode	= tun_net_mclist,
962 	.ndo_set_mac_address	= eth_mac_addr,
963 	.ndo_validate_addr	= eth_validate_addr,
964 	.ndo_select_queue	= tun_select_queue,
965 #ifdef CONFIG_NET_POLL_CONTROLLER
966 	.ndo_poll_controller	= tun_poll_controller,
967 #endif
968 	.ndo_features_check	= passthru_features_check,
969 };
970 
tun_flow_init(struct tun_struct * tun)971 static void tun_flow_init(struct tun_struct *tun)
972 {
973 	int i;
974 
975 	for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
976 		INIT_HLIST_HEAD(&tun->flows[i]);
977 
978 	tun->ageing_time = TUN_FLOW_EXPIRE;
979 	setup_timer(&tun->flow_gc_timer, tun_flow_cleanup, (unsigned long)tun);
980 	mod_timer(&tun->flow_gc_timer,
981 		  round_jiffies_up(jiffies + tun->ageing_time));
982 }
983 
tun_flow_uninit(struct tun_struct * tun)984 static void tun_flow_uninit(struct tun_struct *tun)
985 {
986 	del_timer_sync(&tun->flow_gc_timer);
987 	tun_flow_flush(tun);
988 }
989 
990 /* Initialize net device. */
tun_net_init(struct net_device * dev)991 static void tun_net_init(struct net_device *dev)
992 {
993 	struct tun_struct *tun = netdev_priv(dev);
994 
995 	switch (tun->flags & TUN_TYPE_MASK) {
996 	case IFF_TUN:
997 		dev->netdev_ops = &tun_netdev_ops;
998 
999 		/* Point-to-Point TUN Device */
1000 		dev->hard_header_len = 0;
1001 		dev->addr_len = 0;
1002 		dev->mtu = 1500;
1003 
1004 		/* Zero header length */
1005 		dev->type = ARPHRD_NONE;
1006 		dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
1007 		break;
1008 
1009 	case IFF_TAP:
1010 		dev->netdev_ops = &tap_netdev_ops;
1011 		/* Ethernet TAP Device */
1012 		ether_setup(dev);
1013 		dev->priv_flags &= ~IFF_TX_SKB_SHARING;
1014 		dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
1015 
1016 		eth_hw_addr_random(dev);
1017 
1018 		break;
1019 	}
1020 }
1021 
1022 /* Character device part */
1023 
1024 /* Poll */
tun_chr_poll(struct file * file,poll_table * wait)1025 static unsigned int tun_chr_poll(struct file *file, poll_table *wait)
1026 {
1027 	struct tun_file *tfile = file->private_data;
1028 	struct tun_struct *tun = __tun_get(tfile);
1029 	struct sock *sk;
1030 	unsigned int mask = 0;
1031 
1032 	if (!tun)
1033 		return POLLERR;
1034 
1035 	sk = tfile->socket.sk;
1036 
1037 	tun_debug(KERN_INFO, tun, "tun_chr_poll\n");
1038 
1039 	poll_wait(file, sk_sleep(sk), wait);
1040 
1041 	if (!skb_queue_empty(&sk->sk_receive_queue))
1042 		mask |= POLLIN | POLLRDNORM;
1043 
1044 	if (sock_writeable(sk) ||
1045 	    (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
1046 	     sock_writeable(sk)))
1047 		mask |= POLLOUT | POLLWRNORM;
1048 
1049 	if (tun->dev->reg_state != NETREG_REGISTERED)
1050 		mask = POLLERR;
1051 
1052 	tun_put(tun);
1053 	return mask;
1054 }
1055 
1056 /* prepad is the amount to reserve at front.  len is length after that.
1057  * linear is a hint as to how much to copy (usually headers). */
tun_alloc_skb(struct tun_file * tfile,size_t prepad,size_t len,size_t linear,int noblock)1058 static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
1059 				     size_t prepad, size_t len,
1060 				     size_t linear, int noblock)
1061 {
1062 	struct sock *sk = tfile->socket.sk;
1063 	struct sk_buff *skb;
1064 	int err;
1065 
1066 	/* Under a page?  Don't bother with paged skb. */
1067 	if (prepad + len < PAGE_SIZE || !linear)
1068 		linear = len;
1069 
1070 	skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
1071 				   &err, 0);
1072 	if (!skb)
1073 		return ERR_PTR(err);
1074 
1075 	skb_reserve(skb, prepad);
1076 	skb_put(skb, linear);
1077 	skb->data_len = len - linear;
1078 	skb->len += len - linear;
1079 
1080 	return skb;
1081 }
1082 
1083 /* Get packet from user space buffer */
tun_get_user(struct tun_struct * tun,struct tun_file * tfile,void * msg_control,struct iov_iter * from,int noblock)1084 static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
1085 			    void *msg_control, struct iov_iter *from,
1086 			    int noblock)
1087 {
1088 	struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1089 	struct sk_buff *skb;
1090 	size_t total_len = iov_iter_count(from);
1091 	size_t len = total_len, align = NET_SKB_PAD, linear;
1092 	struct virtio_net_hdr gso = { 0 };
1093 	int good_linear;
1094 	int copylen;
1095 	bool zerocopy = false;
1096 	int err;
1097 	u32 rxhash;
1098 	ssize_t n;
1099 
1100 	if (!(tun->flags & IFF_NO_PI)) {
1101 		if (len < sizeof(pi))
1102 			return -EINVAL;
1103 		len -= sizeof(pi);
1104 
1105 		n = copy_from_iter(&pi, sizeof(pi), from);
1106 		if (n != sizeof(pi))
1107 			return -EFAULT;
1108 	}
1109 
1110 	if (tun->flags & IFF_VNET_HDR) {
1111 		if (len < tun->vnet_hdr_sz)
1112 			return -EINVAL;
1113 		len -= tun->vnet_hdr_sz;
1114 
1115 		n = copy_from_iter(&gso, sizeof(gso), from);
1116 		if (n != sizeof(gso))
1117 			return -EFAULT;
1118 
1119 		if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
1120 		    tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1121 			gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
1122 
1123 		if (tun16_to_cpu(tun, gso.hdr_len) > len)
1124 			return -EINVAL;
1125 		iov_iter_advance(from, tun->vnet_hdr_sz - sizeof(gso));
1126 	}
1127 
1128 	if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
1129 		align += NET_IP_ALIGN;
1130 		if (unlikely(len < ETH_HLEN ||
1131 			     (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
1132 			return -EINVAL;
1133 	}
1134 
1135 	good_linear = SKB_MAX_HEAD(align);
1136 
1137 	if (msg_control) {
1138 		struct iov_iter i = *from;
1139 
1140 		/* There are 256 bytes to be copied in skb, so there is
1141 		 * enough room for skb expand head in case it is used.
1142 		 * The rest of the buffer is mapped from userspace.
1143 		 */
1144 		copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
1145 		if (copylen > good_linear)
1146 			copylen = good_linear;
1147 		linear = copylen;
1148 		iov_iter_advance(&i, copylen);
1149 		if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
1150 			zerocopy = true;
1151 	}
1152 
1153 	if (!zerocopy) {
1154 		copylen = len;
1155 		if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1156 			linear = good_linear;
1157 		else
1158 			linear = tun16_to_cpu(tun, gso.hdr_len);
1159 	}
1160 
1161 	skb = tun_alloc_skb(tfile, align, copylen, linear, noblock);
1162 	if (IS_ERR(skb)) {
1163 		if (PTR_ERR(skb) != -EAGAIN)
1164 			tun->dev->stats.rx_dropped++;
1165 		return PTR_ERR(skb);
1166 	}
1167 
1168 	if (zerocopy)
1169 		err = zerocopy_sg_from_iter(skb, from);
1170 	else {
1171 		err = skb_copy_datagram_from_iter(skb, 0, from, len);
1172 		if (!err && msg_control) {
1173 			struct ubuf_info *uarg = msg_control;
1174 			uarg->callback(uarg, false);
1175 		}
1176 	}
1177 
1178 	if (err) {
1179 		tun->dev->stats.rx_dropped++;
1180 		kfree_skb(skb);
1181 		return -EFAULT;
1182 	}
1183 
1184 	if (gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) {
1185 		if (!skb_partial_csum_set(skb, tun16_to_cpu(tun, gso.csum_start),
1186 					  tun16_to_cpu(tun, gso.csum_offset))) {
1187 			tun->dev->stats.rx_frame_errors++;
1188 			kfree_skb(skb);
1189 			return -EINVAL;
1190 		}
1191 	}
1192 
1193 	switch (tun->flags & TUN_TYPE_MASK) {
1194 	case IFF_TUN:
1195 		if (tun->flags & IFF_NO_PI) {
1196 			switch (skb->data[0] & 0xf0) {
1197 			case 0x40:
1198 				pi.proto = htons(ETH_P_IP);
1199 				break;
1200 			case 0x60:
1201 				pi.proto = htons(ETH_P_IPV6);
1202 				break;
1203 			default:
1204 				tun->dev->stats.rx_dropped++;
1205 				kfree_skb(skb);
1206 				return -EINVAL;
1207 			}
1208 		}
1209 
1210 		skb_reset_mac_header(skb);
1211 		skb->protocol = pi.proto;
1212 		skb->dev = tun->dev;
1213 		break;
1214 	case IFF_TAP:
1215 		skb->protocol = eth_type_trans(skb, tun->dev);
1216 		break;
1217 	}
1218 
1219 	if (gso.gso_type != VIRTIO_NET_HDR_GSO_NONE) {
1220 		pr_debug("GSO!\n");
1221 		switch (gso.gso_type & ~VIRTIO_NET_HDR_GSO_ECN) {
1222 		case VIRTIO_NET_HDR_GSO_TCPV4:
1223 			skb_shinfo(skb)->gso_type = SKB_GSO_TCPV4;
1224 			break;
1225 		case VIRTIO_NET_HDR_GSO_TCPV6:
1226 			skb_shinfo(skb)->gso_type = SKB_GSO_TCPV6;
1227 			break;
1228 		case VIRTIO_NET_HDR_GSO_UDP:
1229 			skb_shinfo(skb)->gso_type = SKB_GSO_UDP;
1230 			break;
1231 		default:
1232 			tun->dev->stats.rx_frame_errors++;
1233 			kfree_skb(skb);
1234 			return -EINVAL;
1235 		}
1236 
1237 		if (gso.gso_type & VIRTIO_NET_HDR_GSO_ECN)
1238 			skb_shinfo(skb)->gso_type |= SKB_GSO_TCP_ECN;
1239 
1240 		skb_shinfo(skb)->gso_size = tun16_to_cpu(tun, gso.gso_size);
1241 		if (skb_shinfo(skb)->gso_size == 0) {
1242 			tun->dev->stats.rx_frame_errors++;
1243 			kfree_skb(skb);
1244 			return -EINVAL;
1245 		}
1246 
1247 		/* Header must be checked, and gso_segs computed. */
1248 		skb_shinfo(skb)->gso_type |= SKB_GSO_DODGY;
1249 		skb_shinfo(skb)->gso_segs = 0;
1250 	}
1251 
1252 	/* copy skb_ubuf_info for callback when skb has no error */
1253 	if (zerocopy) {
1254 		skb_shinfo(skb)->destructor_arg = msg_control;
1255 		skb_shinfo(skb)->tx_flags |= SKBTX_DEV_ZEROCOPY;
1256 		skb_shinfo(skb)->tx_flags |= SKBTX_SHARED_FRAG;
1257 	}
1258 
1259 	skb_reset_network_header(skb);
1260 	skb_probe_transport_header(skb, 0);
1261 
1262 	rxhash = skb_get_hash(skb);
1263 	netif_rx_ni(skb);
1264 
1265 	tun->dev->stats.rx_packets++;
1266 	tun->dev->stats.rx_bytes += len;
1267 
1268 	tun_flow_update(tun, rxhash, tfile);
1269 	return total_len;
1270 }
1271 
tun_chr_write_iter(struct kiocb * iocb,struct iov_iter * from)1272 static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
1273 {
1274 	struct file *file = iocb->ki_filp;
1275 	struct tun_struct *tun = tun_get(file);
1276 	struct tun_file *tfile = file->private_data;
1277 	ssize_t result;
1278 
1279 	if (!tun)
1280 		return -EBADFD;
1281 
1282 	result = tun_get_user(tun, tfile, NULL, from, file->f_flags & O_NONBLOCK);
1283 
1284 	tun_put(tun);
1285 	return result;
1286 }
1287 
1288 /* Put packet to the user space buffer */
tun_put_user(struct tun_struct * tun,struct tun_file * tfile,struct sk_buff * skb,struct iov_iter * iter)1289 static ssize_t tun_put_user(struct tun_struct *tun,
1290 			    struct tun_file *tfile,
1291 			    struct sk_buff *skb,
1292 			    struct iov_iter *iter)
1293 {
1294 	struct tun_pi pi = { 0, skb->protocol };
1295 	ssize_t total;
1296 	int vlan_offset = 0;
1297 	int vlan_hlen = 0;
1298 	int vnet_hdr_sz = 0;
1299 
1300 	if (skb_vlan_tag_present(skb))
1301 		vlan_hlen = VLAN_HLEN;
1302 
1303 	if (tun->flags & IFF_VNET_HDR)
1304 		vnet_hdr_sz = tun->vnet_hdr_sz;
1305 
1306 	total = skb->len + vlan_hlen + vnet_hdr_sz;
1307 
1308 	if (!(tun->flags & IFF_NO_PI)) {
1309 		if (iov_iter_count(iter) < sizeof(pi))
1310 			return -EINVAL;
1311 
1312 		total += sizeof(pi);
1313 		if (iov_iter_count(iter) < total) {
1314 			/* Packet will be striped */
1315 			pi.flags |= TUN_PKT_STRIP;
1316 		}
1317 
1318 		if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
1319 			return -EFAULT;
1320 	}
1321 
1322 	if (vnet_hdr_sz) {
1323 		struct virtio_net_hdr gso = { 0 }; /* no info leak */
1324 		if (iov_iter_count(iter) < vnet_hdr_sz)
1325 			return -EINVAL;
1326 
1327 		if (skb_is_gso(skb)) {
1328 			struct skb_shared_info *sinfo = skb_shinfo(skb);
1329 
1330 			/* This is a hint as to how much should be linear. */
1331 			gso.hdr_len = cpu_to_tun16(tun, skb_headlen(skb));
1332 			gso.gso_size = cpu_to_tun16(tun, sinfo->gso_size);
1333 			if (sinfo->gso_type & SKB_GSO_TCPV4)
1334 				gso.gso_type = VIRTIO_NET_HDR_GSO_TCPV4;
1335 			else if (sinfo->gso_type & SKB_GSO_TCPV6)
1336 				gso.gso_type = VIRTIO_NET_HDR_GSO_TCPV6;
1337 			else if (sinfo->gso_type & SKB_GSO_UDP)
1338 				gso.gso_type = VIRTIO_NET_HDR_GSO_UDP;
1339 			else {
1340 				pr_err("unexpected GSO type: "
1341 				       "0x%x, gso_size %d, hdr_len %d\n",
1342 				       sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
1343 				       tun16_to_cpu(tun, gso.hdr_len));
1344 				print_hex_dump(KERN_ERR, "tun: ",
1345 					       DUMP_PREFIX_NONE,
1346 					       16, 1, skb->head,
1347 					       min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
1348 				WARN_ON_ONCE(1);
1349 				return -EINVAL;
1350 			}
1351 			if (sinfo->gso_type & SKB_GSO_TCP_ECN)
1352 				gso.gso_type |= VIRTIO_NET_HDR_GSO_ECN;
1353 		} else
1354 			gso.gso_type = VIRTIO_NET_HDR_GSO_NONE;
1355 
1356 		if (skb->ip_summed == CHECKSUM_PARTIAL) {
1357 			gso.flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
1358 			gso.csum_start = cpu_to_tun16(tun, skb_checksum_start_offset(skb) +
1359 						      vlan_hlen);
1360 			gso.csum_offset = cpu_to_tun16(tun, skb->csum_offset);
1361 		} else if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
1362 			gso.flags = VIRTIO_NET_HDR_F_DATA_VALID;
1363 		} /* else everything is zero */
1364 
1365 		if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
1366 			return -EFAULT;
1367 
1368 		iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
1369 	}
1370 
1371 	if (vlan_hlen) {
1372 		int ret;
1373 		struct {
1374 			__be16 h_vlan_proto;
1375 			__be16 h_vlan_TCI;
1376 		} veth;
1377 
1378 		veth.h_vlan_proto = skb->vlan_proto;
1379 		veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
1380 
1381 		vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
1382 
1383 		ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
1384 		if (ret || !iov_iter_count(iter))
1385 			goto done;
1386 
1387 		ret = copy_to_iter(&veth, sizeof(veth), iter);
1388 		if (ret != sizeof(veth) || !iov_iter_count(iter))
1389 			goto done;
1390 	}
1391 
1392 	skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
1393 
1394 done:
1395 	tun->dev->stats.tx_packets++;
1396 	tun->dev->stats.tx_bytes += skb->len + vlan_hlen;
1397 
1398 	return total;
1399 }
1400 
tun_do_read(struct tun_struct * tun,struct tun_file * tfile,struct iov_iter * to,int noblock)1401 static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
1402 			   struct iov_iter *to,
1403 			   int noblock)
1404 {
1405 	struct sk_buff *skb;
1406 	ssize_t ret;
1407 	int peeked, err, off = 0;
1408 
1409 	tun_debug(KERN_INFO, tun, "tun_do_read\n");
1410 
1411 	if (!iov_iter_count(to))
1412 		return 0;
1413 
1414 	/* Read frames from queue */
1415 	skb = __skb_recv_datagram(tfile->socket.sk, noblock ? MSG_DONTWAIT : 0,
1416 				  &peeked, &off, &err);
1417 	if (!skb)
1418 		return err;
1419 
1420 	ret = tun_put_user(tun, tfile, skb, to);
1421 	if (unlikely(ret < 0))
1422 		kfree_skb(skb);
1423 	else
1424 		consume_skb(skb);
1425 
1426 	return ret;
1427 }
1428 
tun_chr_read_iter(struct kiocb * iocb,struct iov_iter * to)1429 static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
1430 {
1431 	struct file *file = iocb->ki_filp;
1432 	struct tun_file *tfile = file->private_data;
1433 	struct tun_struct *tun = __tun_get(tfile);
1434 	ssize_t len = iov_iter_count(to), ret;
1435 
1436 	if (!tun)
1437 		return -EBADFD;
1438 	ret = tun_do_read(tun, tfile, to, file->f_flags & O_NONBLOCK);
1439 	ret = min_t(ssize_t, ret, len);
1440 	if (ret > 0)
1441 		iocb->ki_pos = ret;
1442 	tun_put(tun);
1443 	return ret;
1444 }
1445 
tun_free_netdev(struct net_device * dev)1446 static void tun_free_netdev(struct net_device *dev)
1447 {
1448 	struct tun_struct *tun = netdev_priv(dev);
1449 
1450 	BUG_ON(!(list_empty(&tun->disabled)));
1451 	tun_flow_uninit(tun);
1452 	security_tun_dev_free_security(tun->security);
1453 	free_netdev(dev);
1454 }
1455 
tun_setup(struct net_device * dev)1456 static void tun_setup(struct net_device *dev)
1457 {
1458 	struct tun_struct *tun = netdev_priv(dev);
1459 
1460 	tun->owner = INVALID_UID;
1461 	tun->group = INVALID_GID;
1462 
1463 	dev->ethtool_ops = &tun_ethtool_ops;
1464 	dev->destructor = tun_free_netdev;
1465 	/* We prefer our own queue length */
1466 	dev->tx_queue_len = TUN_READQ_SIZE;
1467 }
1468 
1469 /* Trivial set of netlink ops to allow deleting tun or tap
1470  * device with netlink.
1471  */
tun_validate(struct nlattr * tb[],struct nlattr * data[])1472 static int tun_validate(struct nlattr *tb[], struct nlattr *data[])
1473 {
1474 	return -EINVAL;
1475 }
1476 
1477 static struct rtnl_link_ops tun_link_ops __read_mostly = {
1478 	.kind		= DRV_NAME,
1479 	.priv_size	= sizeof(struct tun_struct),
1480 	.setup		= tun_setup,
1481 	.validate	= tun_validate,
1482 };
1483 
tun_sock_write_space(struct sock * sk)1484 static void tun_sock_write_space(struct sock *sk)
1485 {
1486 	struct tun_file *tfile;
1487 	wait_queue_head_t *wqueue;
1488 
1489 	if (!sock_writeable(sk))
1490 		return;
1491 
1492 	if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
1493 		return;
1494 
1495 	wqueue = sk_sleep(sk);
1496 	if (wqueue && waitqueue_active(wqueue))
1497 		wake_up_interruptible_sync_poll(wqueue, POLLOUT |
1498 						POLLWRNORM | POLLWRBAND);
1499 
1500 	tfile = container_of(sk, struct tun_file, sk);
1501 	kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
1502 }
1503 
tun_sendmsg(struct socket * sock,struct msghdr * m,size_t total_len)1504 static int tun_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
1505 {
1506 	int ret;
1507 	struct tun_file *tfile = container_of(sock, struct tun_file, socket);
1508 	struct tun_struct *tun = __tun_get(tfile);
1509 
1510 	if (!tun)
1511 		return -EBADFD;
1512 
1513 	ret = tun_get_user(tun, tfile, m->msg_control, &m->msg_iter,
1514 			   m->msg_flags & MSG_DONTWAIT);
1515 	tun_put(tun);
1516 	return ret;
1517 }
1518 
tun_recvmsg(struct socket * sock,struct msghdr * m,size_t total_len,int flags)1519 static int tun_recvmsg(struct socket *sock, struct msghdr *m, size_t total_len,
1520 		       int flags)
1521 {
1522 	struct tun_file *tfile = container_of(sock, struct tun_file, socket);
1523 	struct tun_struct *tun = __tun_get(tfile);
1524 	int ret;
1525 
1526 	if (!tun)
1527 		return -EBADFD;
1528 
1529 	if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
1530 		ret = -EINVAL;
1531 		goto out;
1532 	}
1533 	if (flags & MSG_ERRQUEUE) {
1534 		ret = sock_recv_errqueue(sock->sk, m, total_len,
1535 					 SOL_PACKET, TUN_TX_TIMESTAMP);
1536 		goto out;
1537 	}
1538 	ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT);
1539 	if (ret > (ssize_t)total_len) {
1540 		m->msg_flags |= MSG_TRUNC;
1541 		ret = flags & MSG_TRUNC ? ret : total_len;
1542 	}
1543 out:
1544 	tun_put(tun);
1545 	return ret;
1546 }
1547 
1548 /* Ops structure to mimic raw sockets with tun */
1549 static const struct proto_ops tun_socket_ops = {
1550 	.sendmsg = tun_sendmsg,
1551 	.recvmsg = tun_recvmsg,
1552 };
1553 
1554 static struct proto tun_proto = {
1555 	.name		= "tun",
1556 	.owner		= THIS_MODULE,
1557 	.obj_size	= sizeof(struct tun_file),
1558 };
1559 
tun_flags(struct tun_struct * tun)1560 static int tun_flags(struct tun_struct *tun)
1561 {
1562 	return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
1563 }
1564 
tun_show_flags(struct device * dev,struct device_attribute * attr,char * buf)1565 static ssize_t tun_show_flags(struct device *dev, struct device_attribute *attr,
1566 			      char *buf)
1567 {
1568 	struct tun_struct *tun = netdev_priv(to_net_dev(dev));
1569 	return sprintf(buf, "0x%x\n", tun_flags(tun));
1570 }
1571 
tun_show_owner(struct device * dev,struct device_attribute * attr,char * buf)1572 static ssize_t tun_show_owner(struct device *dev, struct device_attribute *attr,
1573 			      char *buf)
1574 {
1575 	struct tun_struct *tun = netdev_priv(to_net_dev(dev));
1576 	return uid_valid(tun->owner)?
1577 		sprintf(buf, "%u\n",
1578 			from_kuid_munged(current_user_ns(), tun->owner)):
1579 		sprintf(buf, "-1\n");
1580 }
1581 
tun_show_group(struct device * dev,struct device_attribute * attr,char * buf)1582 static ssize_t tun_show_group(struct device *dev, struct device_attribute *attr,
1583 			      char *buf)
1584 {
1585 	struct tun_struct *tun = netdev_priv(to_net_dev(dev));
1586 	return gid_valid(tun->group) ?
1587 		sprintf(buf, "%u\n",
1588 			from_kgid_munged(current_user_ns(), tun->group)):
1589 		sprintf(buf, "-1\n");
1590 }
1591 
1592 static DEVICE_ATTR(tun_flags, 0444, tun_show_flags, NULL);
1593 static DEVICE_ATTR(owner, 0444, tun_show_owner, NULL);
1594 static DEVICE_ATTR(group, 0444, tun_show_group, NULL);
1595 
1596 static struct attribute *tun_dev_attrs[] = {
1597 	&dev_attr_tun_flags.attr,
1598 	&dev_attr_owner.attr,
1599 	&dev_attr_group.attr,
1600 	NULL
1601 };
1602 
1603 static const struct attribute_group tun_attr_group = {
1604 	.attrs = tun_dev_attrs
1605 };
1606 
tun_set_iff(struct net * net,struct file * file,struct ifreq * ifr)1607 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
1608 {
1609 	struct tun_struct *tun;
1610 	struct tun_file *tfile = file->private_data;
1611 	struct net_device *dev;
1612 	int err;
1613 
1614 	if (tfile->detached)
1615 		return -EINVAL;
1616 
1617 	dev = __dev_get_by_name(net, ifr->ifr_name);
1618 	if (dev) {
1619 		if (ifr->ifr_flags & IFF_TUN_EXCL)
1620 			return -EBUSY;
1621 		if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
1622 			tun = netdev_priv(dev);
1623 		else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
1624 			tun = netdev_priv(dev);
1625 		else
1626 			return -EINVAL;
1627 
1628 		if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
1629 		    !!(tun->flags & IFF_MULTI_QUEUE))
1630 			return -EINVAL;
1631 
1632 		if (tun_not_capable(tun))
1633 			return -EPERM;
1634 		err = security_tun_dev_open(tun->security);
1635 		if (err < 0)
1636 			return err;
1637 
1638 		err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER);
1639 		if (err < 0)
1640 			return err;
1641 
1642 		if (tun->flags & IFF_MULTI_QUEUE &&
1643 		    (tun->numqueues + tun->numdisabled > 1)) {
1644 			/* One or more queue has already been attached, no need
1645 			 * to initialize the device again.
1646 			 */
1647 			return 0;
1648 		}
1649 	}
1650 	else {
1651 		char *name;
1652 		unsigned long flags = 0;
1653 		int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
1654 			     MAX_TAP_QUEUES : 1;
1655 
1656 		if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
1657 			return -EPERM;
1658 		err = security_tun_dev_create();
1659 		if (err < 0)
1660 			return err;
1661 
1662 		/* Set dev type */
1663 		if (ifr->ifr_flags & IFF_TUN) {
1664 			/* TUN device */
1665 			flags |= IFF_TUN;
1666 			name = "tun%d";
1667 		} else if (ifr->ifr_flags & IFF_TAP) {
1668 			/* TAP device */
1669 			flags |= IFF_TAP;
1670 			name = "tap%d";
1671 		} else
1672 			return -EINVAL;
1673 
1674 		if (*ifr->ifr_name)
1675 			name = ifr->ifr_name;
1676 
1677 		dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
1678 				       NET_NAME_UNKNOWN, tun_setup, queues,
1679 				       queues);
1680 
1681 		if (!dev)
1682 			return -ENOMEM;
1683 
1684 		dev_net_set(dev, net);
1685 		dev->rtnl_link_ops = &tun_link_ops;
1686 		dev->ifindex = tfile->ifindex;
1687 		dev->sysfs_groups[0] = &tun_attr_group;
1688 
1689 		tun = netdev_priv(dev);
1690 		tun->dev = dev;
1691 		tun->flags = flags;
1692 		tun->txflt.count = 0;
1693 		tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
1694 
1695 		tun->filter_attached = false;
1696 		tun->sndbuf = tfile->socket.sk->sk_sndbuf;
1697 
1698 		spin_lock_init(&tun->lock);
1699 
1700 		err = security_tun_dev_alloc_security(&tun->security);
1701 		if (err < 0)
1702 			goto err_free_dev;
1703 
1704 		tun_net_init(dev);
1705 		tun_flow_init(tun);
1706 
1707 		dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
1708 				   TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
1709 				   NETIF_F_HW_VLAN_STAG_TX;
1710 		dev->features = dev->hw_features;
1711 		dev->vlan_features = dev->features &
1712 				     ~(NETIF_F_HW_VLAN_CTAG_TX |
1713 				       NETIF_F_HW_VLAN_STAG_TX);
1714 
1715 		INIT_LIST_HEAD(&tun->disabled);
1716 		err = tun_attach(tun, file, false);
1717 		if (err < 0)
1718 			goto err_free_flow;
1719 
1720 		err = register_netdevice(tun->dev);
1721 		if (err < 0)
1722 			goto err_detach;
1723 	}
1724 
1725 	netif_carrier_on(tun->dev);
1726 
1727 	tun_debug(KERN_INFO, tun, "tun_set_iff\n");
1728 
1729 	tun->flags = (tun->flags & ~TUN_FEATURES) |
1730 		(ifr->ifr_flags & TUN_FEATURES);
1731 
1732 	/* Make sure persistent devices do not get stuck in
1733 	 * xoff state.
1734 	 */
1735 	if (netif_running(tun->dev))
1736 		netif_tx_wake_all_queues(tun->dev);
1737 
1738 	strcpy(ifr->ifr_name, tun->dev->name);
1739 	return 0;
1740 
1741 err_detach:
1742 	tun_detach_all(dev);
1743 err_free_flow:
1744 	tun_flow_uninit(tun);
1745 	security_tun_dev_free_security(tun->security);
1746 err_free_dev:
1747 	free_netdev(dev);
1748 	return err;
1749 }
1750 
tun_get_iff(struct net * net,struct tun_struct * tun,struct ifreq * ifr)1751 static void tun_get_iff(struct net *net, struct tun_struct *tun,
1752 		       struct ifreq *ifr)
1753 {
1754 	tun_debug(KERN_INFO, tun, "tun_get_iff\n");
1755 
1756 	strcpy(ifr->ifr_name, tun->dev->name);
1757 
1758 	ifr->ifr_flags = tun_flags(tun);
1759 
1760 }
1761 
1762 /* This is like a cut-down ethtool ops, except done via tun fd so no
1763  * privs required. */
set_offload(struct tun_struct * tun,unsigned long arg)1764 static int set_offload(struct tun_struct *tun, unsigned long arg)
1765 {
1766 	netdev_features_t features = 0;
1767 
1768 	if (arg & TUN_F_CSUM) {
1769 		features |= NETIF_F_HW_CSUM;
1770 		arg &= ~TUN_F_CSUM;
1771 
1772 		if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
1773 			if (arg & TUN_F_TSO_ECN) {
1774 				features |= NETIF_F_TSO_ECN;
1775 				arg &= ~TUN_F_TSO_ECN;
1776 			}
1777 			if (arg & TUN_F_TSO4)
1778 				features |= NETIF_F_TSO;
1779 			if (arg & TUN_F_TSO6)
1780 				features |= NETIF_F_TSO6;
1781 			arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
1782 		}
1783 
1784 		if (arg & TUN_F_UFO) {
1785 			features |= NETIF_F_UFO;
1786 			arg &= ~TUN_F_UFO;
1787 		}
1788 	}
1789 
1790 	/* This gives the user a way to test for new features in future by
1791 	 * trying to set them. */
1792 	if (arg)
1793 		return -EINVAL;
1794 
1795 	tun->set_features = features;
1796 	netdev_update_features(tun->dev);
1797 
1798 	return 0;
1799 }
1800 
tun_detach_filter(struct tun_struct * tun,int n)1801 static void tun_detach_filter(struct tun_struct *tun, int n)
1802 {
1803 	int i;
1804 	struct tun_file *tfile;
1805 
1806 	for (i = 0; i < n; i++) {
1807 		tfile = rtnl_dereference(tun->tfiles[i]);
1808 		__sk_detach_filter(tfile->socket.sk, lockdep_rtnl_is_held());
1809 	}
1810 
1811 	tun->filter_attached = false;
1812 }
1813 
tun_attach_filter(struct tun_struct * tun)1814 static int tun_attach_filter(struct tun_struct *tun)
1815 {
1816 	int i, ret = 0;
1817 	struct tun_file *tfile;
1818 
1819 	for (i = 0; i < tun->numqueues; i++) {
1820 		tfile = rtnl_dereference(tun->tfiles[i]);
1821 		ret = __sk_attach_filter(&tun->fprog, tfile->socket.sk,
1822 					 lockdep_rtnl_is_held());
1823 		if (ret) {
1824 			tun_detach_filter(tun, i);
1825 			return ret;
1826 		}
1827 	}
1828 
1829 	tun->filter_attached = true;
1830 	return ret;
1831 }
1832 
tun_set_sndbuf(struct tun_struct * tun)1833 static void tun_set_sndbuf(struct tun_struct *tun)
1834 {
1835 	struct tun_file *tfile;
1836 	int i;
1837 
1838 	for (i = 0; i < tun->numqueues; i++) {
1839 		tfile = rtnl_dereference(tun->tfiles[i]);
1840 		tfile->socket.sk->sk_sndbuf = tun->sndbuf;
1841 	}
1842 }
1843 
tun_set_queue(struct file * file,struct ifreq * ifr)1844 static int tun_set_queue(struct file *file, struct ifreq *ifr)
1845 {
1846 	struct tun_file *tfile = file->private_data;
1847 	struct tun_struct *tun;
1848 	int ret = 0;
1849 
1850 	rtnl_lock();
1851 
1852 	if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
1853 		tun = tfile->detached;
1854 		if (!tun) {
1855 			ret = -EINVAL;
1856 			goto unlock;
1857 		}
1858 		ret = security_tun_dev_attach_queue(tun->security);
1859 		if (ret < 0)
1860 			goto unlock;
1861 		ret = tun_attach(tun, file, false);
1862 	} else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
1863 		tun = rtnl_dereference(tfile->tun);
1864 		if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
1865 			ret = -EINVAL;
1866 		else
1867 			__tun_detach(tfile, false);
1868 	} else
1869 		ret = -EINVAL;
1870 
1871 unlock:
1872 	rtnl_unlock();
1873 	return ret;
1874 }
1875 
__tun_chr_ioctl(struct file * file,unsigned int cmd,unsigned long arg,int ifreq_len)1876 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
1877 			    unsigned long arg, int ifreq_len)
1878 {
1879 	struct tun_file *tfile = file->private_data;
1880 	struct tun_struct *tun;
1881 	void __user* argp = (void __user*)arg;
1882 	struct ifreq ifr;
1883 	kuid_t owner;
1884 	kgid_t group;
1885 	int sndbuf;
1886 	int vnet_hdr_sz;
1887 	unsigned int ifindex;
1888 	int le;
1889 	int ret;
1890 
1891 	if (cmd == TUNSETIFF || cmd == TUNSETQUEUE || _IOC_TYPE(cmd) == 0x89) {
1892 		if (copy_from_user(&ifr, argp, ifreq_len))
1893 			return -EFAULT;
1894 	} else {
1895 		memset(&ifr, 0, sizeof(ifr));
1896 	}
1897 	if (cmd == TUNGETFEATURES) {
1898 		/* Currently this just means: "what IFF flags are valid?".
1899 		 * This is needed because we never checked for invalid flags on
1900 		 * TUNSETIFF.
1901 		 */
1902 		return put_user(IFF_TUN | IFF_TAP | TUN_FEATURES,
1903 				(unsigned int __user*)argp);
1904 	} else if (cmd == TUNSETQUEUE)
1905 		return tun_set_queue(file, &ifr);
1906 
1907 	ret = 0;
1908 	rtnl_lock();
1909 
1910 	tun = __tun_get(tfile);
1911 	if (cmd == TUNSETIFF && !tun) {
1912 		ifr.ifr_name[IFNAMSIZ-1] = '\0';
1913 
1914 		ret = tun_set_iff(sock_net(&tfile->sk), file, &ifr);
1915 
1916 		if (ret)
1917 			goto unlock;
1918 
1919 		if (copy_to_user(argp, &ifr, ifreq_len))
1920 			ret = -EFAULT;
1921 		goto unlock;
1922 	}
1923 	if (cmd == TUNSETIFINDEX) {
1924 		ret = -EPERM;
1925 		if (tun)
1926 			goto unlock;
1927 
1928 		ret = -EFAULT;
1929 		if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
1930 			goto unlock;
1931 
1932 		ret = 0;
1933 		tfile->ifindex = ifindex;
1934 		goto unlock;
1935 	}
1936 
1937 	ret = -EBADFD;
1938 	if (!tun)
1939 		goto unlock;
1940 
1941 	tun_debug(KERN_INFO, tun, "tun_chr_ioctl cmd %u\n", cmd);
1942 
1943 	ret = 0;
1944 	switch (cmd) {
1945 	case TUNGETIFF:
1946 		tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
1947 
1948 		if (tfile->detached)
1949 			ifr.ifr_flags |= IFF_DETACH_QUEUE;
1950 		if (!tfile->socket.sk->sk_filter)
1951 			ifr.ifr_flags |= IFF_NOFILTER;
1952 
1953 		if (copy_to_user(argp, &ifr, ifreq_len))
1954 			ret = -EFAULT;
1955 		break;
1956 
1957 	case TUNSETNOCSUM:
1958 		/* Disable/Enable checksum */
1959 
1960 		/* [unimplemented] */
1961 		tun_debug(KERN_INFO, tun, "ignored: set checksum %s\n",
1962 			  arg ? "disabled" : "enabled");
1963 		break;
1964 
1965 	case TUNSETPERSIST:
1966 		/* Disable/Enable persist mode. Keep an extra reference to the
1967 		 * module to prevent the module being unprobed.
1968 		 */
1969 		if (arg && !(tun->flags & IFF_PERSIST)) {
1970 			tun->flags |= IFF_PERSIST;
1971 			__module_get(THIS_MODULE);
1972 		}
1973 		if (!arg && (tun->flags & IFF_PERSIST)) {
1974 			tun->flags &= ~IFF_PERSIST;
1975 			module_put(THIS_MODULE);
1976 		}
1977 
1978 		tun_debug(KERN_INFO, tun, "persist %s\n",
1979 			  arg ? "enabled" : "disabled");
1980 		break;
1981 
1982 	case TUNSETOWNER:
1983 		/* Set owner of the device */
1984 		owner = make_kuid(current_user_ns(), arg);
1985 		if (!uid_valid(owner)) {
1986 			ret = -EINVAL;
1987 			break;
1988 		}
1989 		tun->owner = owner;
1990 		tun_debug(KERN_INFO, tun, "owner set to %u\n",
1991 			  from_kuid(&init_user_ns, tun->owner));
1992 		break;
1993 
1994 	case TUNSETGROUP:
1995 		/* Set group of the device */
1996 		group = make_kgid(current_user_ns(), arg);
1997 		if (!gid_valid(group)) {
1998 			ret = -EINVAL;
1999 			break;
2000 		}
2001 		tun->group = group;
2002 		tun_debug(KERN_INFO, tun, "group set to %u\n",
2003 			  from_kgid(&init_user_ns, tun->group));
2004 		break;
2005 
2006 	case TUNSETLINK:
2007 		/* Only allow setting the type when the interface is down */
2008 		if (tun->dev->flags & IFF_UP) {
2009 			tun_debug(KERN_INFO, tun,
2010 				  "Linktype set failed because interface is up\n");
2011 			ret = -EBUSY;
2012 		} else {
2013 			tun->dev->type = (int) arg;
2014 			tun_debug(KERN_INFO, tun, "linktype set to %d\n",
2015 				  tun->dev->type);
2016 			ret = 0;
2017 		}
2018 		break;
2019 
2020 #ifdef TUN_DEBUG
2021 	case TUNSETDEBUG:
2022 		tun->debug = arg;
2023 		break;
2024 #endif
2025 	case TUNSETOFFLOAD:
2026 		ret = set_offload(tun, arg);
2027 		break;
2028 
2029 	case TUNSETTXFILTER:
2030 		/* Can be set only for TAPs */
2031 		ret = -EINVAL;
2032 		if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
2033 			break;
2034 		ret = update_filter(&tun->txflt, (void __user *)arg);
2035 		break;
2036 
2037 	case SIOCGIFHWADDR:
2038 		/* Get hw address */
2039 		memcpy(ifr.ifr_hwaddr.sa_data, tun->dev->dev_addr, ETH_ALEN);
2040 		ifr.ifr_hwaddr.sa_family = tun->dev->type;
2041 		if (copy_to_user(argp, &ifr, ifreq_len))
2042 			ret = -EFAULT;
2043 		break;
2044 
2045 	case SIOCSIFHWADDR:
2046 		/* Set hw address */
2047 		tun_debug(KERN_DEBUG, tun, "set hw address: %pM\n",
2048 			  ifr.ifr_hwaddr.sa_data);
2049 
2050 		ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr);
2051 		break;
2052 
2053 	case TUNGETSNDBUF:
2054 		sndbuf = tfile->socket.sk->sk_sndbuf;
2055 		if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
2056 			ret = -EFAULT;
2057 		break;
2058 
2059 	case TUNSETSNDBUF:
2060 		if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
2061 			ret = -EFAULT;
2062 			break;
2063 		}
2064 
2065 		tun->sndbuf = sndbuf;
2066 		tun_set_sndbuf(tun);
2067 		break;
2068 
2069 	case TUNGETVNETHDRSZ:
2070 		vnet_hdr_sz = tun->vnet_hdr_sz;
2071 		if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
2072 			ret = -EFAULT;
2073 		break;
2074 
2075 	case TUNSETVNETHDRSZ:
2076 		if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
2077 			ret = -EFAULT;
2078 			break;
2079 		}
2080 		if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
2081 			ret = -EINVAL;
2082 			break;
2083 		}
2084 
2085 		tun->vnet_hdr_sz = vnet_hdr_sz;
2086 		break;
2087 
2088 	case TUNGETVNETLE:
2089 		le = !!(tun->flags & TUN_VNET_LE);
2090 		if (put_user(le, (int __user *)argp))
2091 			ret = -EFAULT;
2092 		break;
2093 
2094 	case TUNSETVNETLE:
2095 		if (get_user(le, (int __user *)argp)) {
2096 			ret = -EFAULT;
2097 			break;
2098 		}
2099 		if (le)
2100 			tun->flags |= TUN_VNET_LE;
2101 		else
2102 			tun->flags &= ~TUN_VNET_LE;
2103 		break;
2104 
2105 	case TUNGETVNETBE:
2106 		ret = tun_get_vnet_be(tun, argp);
2107 		break;
2108 
2109 	case TUNSETVNETBE:
2110 		ret = tun_set_vnet_be(tun, argp);
2111 		break;
2112 
2113 	case TUNATTACHFILTER:
2114 		/* Can be set only for TAPs */
2115 		ret = -EINVAL;
2116 		if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
2117 			break;
2118 		ret = -EFAULT;
2119 		if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
2120 			break;
2121 
2122 		ret = tun_attach_filter(tun);
2123 		break;
2124 
2125 	case TUNDETACHFILTER:
2126 		/* Can be set only for TAPs */
2127 		ret = -EINVAL;
2128 		if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
2129 			break;
2130 		ret = 0;
2131 		tun_detach_filter(tun, tun->numqueues);
2132 		break;
2133 
2134 	case TUNGETFILTER:
2135 		ret = -EINVAL;
2136 		if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
2137 			break;
2138 		ret = -EFAULT;
2139 		if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
2140 			break;
2141 		ret = 0;
2142 		break;
2143 
2144 	default:
2145 		ret = -EINVAL;
2146 		break;
2147 	}
2148 
2149 unlock:
2150 	rtnl_unlock();
2151 	if (tun)
2152 		tun_put(tun);
2153 	return ret;
2154 }
2155 
tun_chr_ioctl(struct file * file,unsigned int cmd,unsigned long arg)2156 static long tun_chr_ioctl(struct file *file,
2157 			  unsigned int cmd, unsigned long arg)
2158 {
2159 	return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
2160 }
2161 
2162 #ifdef CONFIG_COMPAT
tun_chr_compat_ioctl(struct file * file,unsigned int cmd,unsigned long arg)2163 static long tun_chr_compat_ioctl(struct file *file,
2164 			 unsigned int cmd, unsigned long arg)
2165 {
2166 	switch (cmd) {
2167 	case TUNSETIFF:
2168 	case TUNGETIFF:
2169 	case TUNSETTXFILTER:
2170 	case TUNGETSNDBUF:
2171 	case TUNSETSNDBUF:
2172 	case SIOCGIFHWADDR:
2173 	case SIOCSIFHWADDR:
2174 		arg = (unsigned long)compat_ptr(arg);
2175 		break;
2176 	default:
2177 		arg = (compat_ulong_t)arg;
2178 		break;
2179 	}
2180 
2181 	/*
2182 	 * compat_ifreq is shorter than ifreq, so we must not access beyond
2183 	 * the end of that structure. All fields that are used in this
2184 	 * driver are compatible though, we don't need to convert the
2185 	 * contents.
2186 	 */
2187 	return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
2188 }
2189 #endif /* CONFIG_COMPAT */
2190 
tun_chr_fasync(int fd,struct file * file,int on)2191 static int tun_chr_fasync(int fd, struct file *file, int on)
2192 {
2193 	struct tun_file *tfile = file->private_data;
2194 	int ret;
2195 
2196 	if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
2197 		goto out;
2198 
2199 	if (on) {
2200 		__f_setown(file, task_pid(current), PIDTYPE_PID, 0);
2201 		tfile->flags |= TUN_FASYNC;
2202 	} else
2203 		tfile->flags &= ~TUN_FASYNC;
2204 	ret = 0;
2205 out:
2206 	return ret;
2207 }
2208 
tun_chr_open(struct inode * inode,struct file * file)2209 static int tun_chr_open(struct inode *inode, struct file * file)
2210 {
2211 	struct net *net = current->nsproxy->net_ns;
2212 	struct tun_file *tfile;
2213 
2214 	DBG1(KERN_INFO, "tunX: tun_chr_open\n");
2215 
2216 	tfile = (struct tun_file *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
2217 					    &tun_proto, 0);
2218 	if (!tfile)
2219 		return -ENOMEM;
2220 	RCU_INIT_POINTER(tfile->tun, NULL);
2221 	tfile->flags = 0;
2222 	tfile->ifindex = 0;
2223 
2224 	init_waitqueue_head(&tfile->wq.wait);
2225 	RCU_INIT_POINTER(tfile->socket.wq, &tfile->wq);
2226 
2227 	tfile->socket.file = file;
2228 	tfile->socket.ops = &tun_socket_ops;
2229 
2230 	sock_init_data(&tfile->socket, &tfile->sk);
2231 
2232 	tfile->sk.sk_write_space = tun_sock_write_space;
2233 	tfile->sk.sk_sndbuf = INT_MAX;
2234 
2235 	file->private_data = tfile;
2236 	INIT_LIST_HEAD(&tfile->next);
2237 
2238 	sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
2239 
2240 	return 0;
2241 }
2242 
tun_chr_close(struct inode * inode,struct file * file)2243 static int tun_chr_close(struct inode *inode, struct file *file)
2244 {
2245 	struct tun_file *tfile = file->private_data;
2246 
2247 	tun_detach(tfile, true);
2248 
2249 	return 0;
2250 }
2251 
2252 #ifdef CONFIG_PROC_FS
tun_chr_show_fdinfo(struct seq_file * m,struct file * f)2253 static void tun_chr_show_fdinfo(struct seq_file *m, struct file *f)
2254 {
2255 	struct tun_struct *tun;
2256 	struct ifreq ifr;
2257 
2258 	memset(&ifr, 0, sizeof(ifr));
2259 
2260 	rtnl_lock();
2261 	tun = tun_get(f);
2262 	if (tun)
2263 		tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
2264 	rtnl_unlock();
2265 
2266 	if (tun)
2267 		tun_put(tun);
2268 
2269 	seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
2270 }
2271 #endif
2272 
2273 static const struct file_operations tun_fops = {
2274 	.owner	= THIS_MODULE,
2275 	.llseek = no_llseek,
2276 	.read_iter  = tun_chr_read_iter,
2277 	.write_iter = tun_chr_write_iter,
2278 	.poll	= tun_chr_poll,
2279 	.unlocked_ioctl	= tun_chr_ioctl,
2280 #ifdef CONFIG_COMPAT
2281 	.compat_ioctl = tun_chr_compat_ioctl,
2282 #endif
2283 	.open	= tun_chr_open,
2284 	.release = tun_chr_close,
2285 	.fasync = tun_chr_fasync,
2286 #ifdef CONFIG_PROC_FS
2287 	.show_fdinfo = tun_chr_show_fdinfo,
2288 #endif
2289 };
2290 
2291 static struct miscdevice tun_miscdev = {
2292 	.minor = TUN_MINOR,
2293 	.name = "tun",
2294 	.nodename = "net/tun",
2295 	.fops = &tun_fops,
2296 };
2297 
2298 /* ethtool interface */
2299 
tun_get_settings(struct net_device * dev,struct ethtool_cmd * cmd)2300 static int tun_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
2301 {
2302 	cmd->supported		= 0;
2303 	cmd->advertising	= 0;
2304 	ethtool_cmd_speed_set(cmd, SPEED_10);
2305 	cmd->duplex		= DUPLEX_FULL;
2306 	cmd->port		= PORT_TP;
2307 	cmd->phy_address	= 0;
2308 	cmd->transceiver	= XCVR_INTERNAL;
2309 	cmd->autoneg		= AUTONEG_DISABLE;
2310 	cmd->maxtxpkt		= 0;
2311 	cmd->maxrxpkt		= 0;
2312 	return 0;
2313 }
2314 
tun_get_drvinfo(struct net_device * dev,struct ethtool_drvinfo * info)2315 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
2316 {
2317 	struct tun_struct *tun = netdev_priv(dev);
2318 
2319 	strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
2320 	strlcpy(info->version, DRV_VERSION, sizeof(info->version));
2321 
2322 	switch (tun->flags & TUN_TYPE_MASK) {
2323 	case IFF_TUN:
2324 		strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
2325 		break;
2326 	case IFF_TAP:
2327 		strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
2328 		break;
2329 	}
2330 }
2331 
tun_get_msglevel(struct net_device * dev)2332 static u32 tun_get_msglevel(struct net_device *dev)
2333 {
2334 #ifdef TUN_DEBUG
2335 	struct tun_struct *tun = netdev_priv(dev);
2336 	return tun->debug;
2337 #else
2338 	return -EOPNOTSUPP;
2339 #endif
2340 }
2341 
tun_set_msglevel(struct net_device * dev,u32 value)2342 static void tun_set_msglevel(struct net_device *dev, u32 value)
2343 {
2344 #ifdef TUN_DEBUG
2345 	struct tun_struct *tun = netdev_priv(dev);
2346 	tun->debug = value;
2347 #endif
2348 }
2349 
2350 static const struct ethtool_ops tun_ethtool_ops = {
2351 	.get_settings	= tun_get_settings,
2352 	.get_drvinfo	= tun_get_drvinfo,
2353 	.get_msglevel	= tun_get_msglevel,
2354 	.set_msglevel	= tun_set_msglevel,
2355 	.get_link	= ethtool_op_get_link,
2356 	.get_ts_info	= ethtool_op_get_ts_info,
2357 };
2358 
2359 
tun_init(void)2360 static int __init tun_init(void)
2361 {
2362 	int ret = 0;
2363 
2364 	pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
2365 	pr_info("%s\n", DRV_COPYRIGHT);
2366 
2367 	ret = rtnl_link_register(&tun_link_ops);
2368 	if (ret) {
2369 		pr_err("Can't register link_ops\n");
2370 		goto err_linkops;
2371 	}
2372 
2373 	ret = misc_register(&tun_miscdev);
2374 	if (ret) {
2375 		pr_err("Can't register misc device %d\n", TUN_MINOR);
2376 		goto err_misc;
2377 	}
2378 	return  0;
2379 err_misc:
2380 	rtnl_link_unregister(&tun_link_ops);
2381 err_linkops:
2382 	return ret;
2383 }
2384 
tun_cleanup(void)2385 static void tun_cleanup(void)
2386 {
2387 	misc_deregister(&tun_miscdev);
2388 	rtnl_link_unregister(&tun_link_ops);
2389 }
2390 
2391 /* Get an underlying socket object from tun file.  Returns error unless file is
2392  * attached to a device.  The returned object works like a packet socket, it
2393  * can be used for sock_sendmsg/sock_recvmsg.  The caller is responsible for
2394  * holding a reference to the file for as long as the socket is in use. */
tun_get_socket(struct file * file)2395 struct socket *tun_get_socket(struct file *file)
2396 {
2397 	struct tun_file *tfile;
2398 	if (file->f_op != &tun_fops)
2399 		return ERR_PTR(-EINVAL);
2400 	tfile = file->private_data;
2401 	if (!tfile)
2402 		return ERR_PTR(-EBADFD);
2403 	return &tfile->socket;
2404 }
2405 EXPORT_SYMBOL_GPL(tun_get_socket);
2406 
2407 module_init(tun_init);
2408 module_exit(tun_cleanup);
2409 MODULE_DESCRIPTION(DRV_DESCRIPTION);
2410 MODULE_AUTHOR(DRV_COPYRIGHT);
2411 MODULE_LICENSE("GPL");
2412 MODULE_ALIAS_MISCDEV(TUN_MINOR);
2413 MODULE_ALIAS("devname:net/tun");
2414