2 * TUN - Universal TUN/TAP device driver.
3 * Copyright (C) 1999-2002 Maxim Krasnyansky <maxk@qualcomm.com>
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.
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.
15 * $Id: tun.c,v 1.15 2002/03/01 02:44:24 maxk Exp $
21 * Mike Kershaw <dragorn@kismetwireless.net> 2005/08/14
22 * Add TUNSETLINK ioctl to set the link encapsulation
24 * Mark Smith <markzzzsmith@yahoo.com.au>
25 * Use eth_random_addr() for tap MAC address.
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.
33 * Daniel Podlejski <underley@underley.eu.org>
34 * Modifications for 2.3.99-pre5 kernel.
37 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>"
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>
60 #include <linux/if_arp.h>
61 #include <linux/if_ether.h>
62 #include <linux/if_tun.h>
63 #include <linux/crc32.h>
64 #include <linux/nsproxy.h>
65 #include <linux/virtio_net.h>
66 #include <linux/rcupdate.h>
67 #include <net/net_namespace.h>
68 #include <net/netns/generic.h>
69 #include <net/rtnetlink.h>
72 #include <asm/uaccess.h>
74 /* Uncomment to enable debugging */
75 /* #define TUN_DEBUG 1 */
80 #define tun_debug(level, tun, fmt, args...) \
83 netdev_printk(level, tun->dev, fmt, ##args); \
85 #define DBG1(level, fmt, args...) \
88 printk(level fmt, ##args); \
91 #define tun_debug(level, tun, fmt, args...) \
94 netdev_printk(level, tun->dev, fmt, ##args); \
96 #define DBG1(level, fmt, args...) \
99 printk(level fmt, ##args); \
103 #define GOODCOPY_LEN 128
105 #define FLT_EXACT_COUNT 8
107 unsigned int count; /* Number of addrs. Zero means disabled */
108 u32 mask[2]; /* Mask of the hashed addrs */
109 unsigned char addr[FLT_EXACT_COUNT][ETH_ALEN];
112 /* DEFAULT_MAX_NUM_RSS_QUEUES were choosed to let the rx/tx queues allocated for
113 * the netdevice to be fit in one page. So we can make sure the success of
114 * memory allocation. TODO: increase the limit. */
115 #define MAX_TAP_QUEUES DEFAULT_MAX_NUM_RSS_QUEUES
116 #define MAX_TAP_FLOWS 4096
118 #define TUN_FLOW_EXPIRE (3 * HZ)
120 /* A tun_file connects an open character device to a tuntap netdevice. It
121 * also contains all socket related strctures (except sock_fprog and tap_filter)
122 * to serve as one transmit queue for tuntap device. The sock_fprog and
123 * tap_filter were kept in tun_struct since they were used for filtering for the
124 * netdevice not for a specific queue (at least I didn't see the requirement for
128 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
129 * other can only be read while rcu_read_lock or rtnl_lock is held.
133 struct socket socket;
135 struct tun_struct __rcu *tun;
137 struct fasync_struct *fasync;
138 /* only used for fasnyc */
141 struct list_head next;
142 struct tun_struct *detached;
145 struct tun_flow_entry {
146 struct hlist_node hash_link;
148 struct tun_struct *tun;
152 unsigned long updated;
155 #define TUN_NUM_FLOW_ENTRIES 1024
157 /* Since the socket were moved to tun_file, to preserve the behavior of persist
158 * device, socket filter, sndbuf and vnet header size were restore when the
159 * file were attached to a persist device.
162 struct tun_file __rcu *tfiles[MAX_TAP_QUEUES];
163 unsigned int numqueues;
168 struct net_device *dev;
169 netdev_features_t set_features;
170 #define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
171 NETIF_F_TSO6|NETIF_F_UFO)
175 struct tap_filter txflt;
176 struct sock_fprog fprog;
177 /* protected by rtnl lock */
178 bool filter_attached;
183 struct hlist_head flows[TUN_NUM_FLOW_ENTRIES];
184 struct timer_list flow_gc_timer;
185 unsigned long ageing_time;
186 unsigned int numdisabled;
187 struct list_head disabled;
192 static inline u32 tun_hashfn(u32 rxhash)
194 return rxhash & 0x3ff;
197 static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
199 struct tun_flow_entry *e;
201 hlist_for_each_entry_rcu(e, head, hash_link) {
202 if (e->rxhash == rxhash)
208 static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
209 struct hlist_head *head,
210 u32 rxhash, u16 queue_index)
212 struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
215 tun_debug(KERN_INFO, tun, "create flow: hash %u index %u\n",
216 rxhash, queue_index);
217 e->updated = jiffies;
219 e->queue_index = queue_index;
221 hlist_add_head_rcu(&e->hash_link, head);
227 static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
229 tun_debug(KERN_INFO, tun, "delete flow: hash %u index %u\n",
230 e->rxhash, e->queue_index);
231 hlist_del_rcu(&e->hash_link);
236 static void tun_flow_flush(struct tun_struct *tun)
240 spin_lock_bh(&tun->lock);
241 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
242 struct tun_flow_entry *e;
243 struct hlist_node *n;
245 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
246 tun_flow_delete(tun, e);
248 spin_unlock_bh(&tun->lock);
251 static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
255 spin_lock_bh(&tun->lock);
256 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
257 struct tun_flow_entry *e;
258 struct hlist_node *n;
260 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
261 if (e->queue_index == queue_index)
262 tun_flow_delete(tun, e);
265 spin_unlock_bh(&tun->lock);
268 static void tun_flow_cleanup(unsigned long data)
270 struct tun_struct *tun = (struct tun_struct *)data;
271 unsigned long delay = tun->ageing_time;
272 unsigned long next_timer = jiffies + delay;
273 unsigned long count = 0;
276 tun_debug(KERN_INFO, tun, "tun_flow_cleanup\n");
278 spin_lock_bh(&tun->lock);
279 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
280 struct tun_flow_entry *e;
281 struct hlist_node *n;
283 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
284 unsigned long this_timer;
286 this_timer = e->updated + delay;
287 if (time_before_eq(this_timer, jiffies))
288 tun_flow_delete(tun, e);
289 else if (time_before(this_timer, next_timer))
290 next_timer = this_timer;
295 mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
296 spin_unlock_bh(&tun->lock);
299 static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
300 struct tun_file *tfile)
302 struct hlist_head *head;
303 struct tun_flow_entry *e;
304 unsigned long delay = tun->ageing_time;
305 u16 queue_index = tfile->queue_index;
310 head = &tun->flows[tun_hashfn(rxhash)];
314 /* We may get a very small possibility of OOO during switching, not
315 * worth to optimize.*/
316 if (tun->numqueues == 1 || tfile->detached)
319 e = tun_flow_find(head, rxhash);
321 /* TODO: keep queueing to old queue until it's empty? */
322 e->queue_index = queue_index;
323 e->updated = jiffies;
325 spin_lock_bh(&tun->lock);
326 if (!tun_flow_find(head, rxhash) &&
327 tun->flow_count < MAX_TAP_FLOWS)
328 tun_flow_create(tun, head, rxhash, queue_index);
330 if (!timer_pending(&tun->flow_gc_timer))
331 mod_timer(&tun->flow_gc_timer,
332 round_jiffies_up(jiffies + delay));
333 spin_unlock_bh(&tun->lock);
340 /* We try to identify a flow through its rxhash first. The reason that
341 * we do not check rxq no. is becuase some cards(e.g 82599), chooses
342 * the rxq based on the txq where the last packet of the flow comes. As
343 * the userspace application move between processors, we may get a
344 * different rxq no. here. If we could not get rxhash, then we would
345 * hope the rxq no. may help here.
347 static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb)
349 struct tun_struct *tun = netdev_priv(dev);
350 struct tun_flow_entry *e;
355 numqueues = ACCESS_ONCE(tun->numqueues);
357 txq = skb_get_rxhash(skb);
359 e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
361 txq = e->queue_index;
363 /* use multiply and shift instead of expensive divide */
364 txq = ((u64)txq * numqueues) >> 32;
365 } else if (likely(skb_rx_queue_recorded(skb))) {
366 txq = skb_get_rx_queue(skb);
367 while (unlikely(txq >= numqueues))
375 static inline bool tun_not_capable(struct tun_struct *tun)
377 const struct cred *cred = current_cred();
378 struct net *net = dev_net(tun->dev);
380 return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
381 (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
382 !ns_capable(net->user_ns, CAP_NET_ADMIN);
385 static void tun_set_real_num_queues(struct tun_struct *tun)
387 netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
388 netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
391 static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
393 tfile->detached = tun;
394 list_add_tail(&tfile->next, &tun->disabled);
398 static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
400 struct tun_struct *tun = tfile->detached;
402 tfile->detached = NULL;
403 list_del_init(&tfile->next);
408 static void __tun_detach(struct tun_file *tfile, bool clean)
410 struct tun_file *ntfile;
411 struct tun_struct *tun;
413 tun = rtnl_dereference(tfile->tun);
415 if (tun && !tfile->detached) {
416 u16 index = tfile->queue_index;
417 BUG_ON(index >= tun->numqueues);
419 rcu_assign_pointer(tun->tfiles[index],
420 tun->tfiles[tun->numqueues - 1]);
421 ntfile = rtnl_dereference(tun->tfiles[index]);
422 ntfile->queue_index = index;
426 rcu_assign_pointer(tfile->tun, NULL);
427 sock_put(&tfile->sk);
429 tun_disable_queue(tun, tfile);
432 tun_flow_delete_by_queue(tun, tun->numqueues + 1);
433 /* Drop read queue */
434 skb_queue_purge(&tfile->sk.sk_receive_queue);
435 tun_set_real_num_queues(tun);
436 } else if (tfile->detached && clean) {
437 tun = tun_enable_queue(tfile);
438 sock_put(&tfile->sk);
442 if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
443 netif_carrier_off(tun->dev);
445 if (!(tun->flags & TUN_PERSIST) &&
446 tun->dev->reg_state == NETREG_REGISTERED)
447 unregister_netdevice(tun->dev);
450 BUG_ON(!test_bit(SOCK_EXTERNALLY_ALLOCATED,
451 &tfile->socket.flags));
452 sk_release_kernel(&tfile->sk);
456 static void tun_detach(struct tun_file *tfile, bool clean)
459 __tun_detach(tfile, clean);
463 static void tun_detach_all(struct net_device *dev)
465 struct tun_struct *tun = netdev_priv(dev);
466 struct tun_file *tfile, *tmp;
467 int i, n = tun->numqueues;
469 for (i = 0; i < n; i++) {
470 tfile = rtnl_dereference(tun->tfiles[i]);
472 wake_up_all(&tfile->wq.wait);
473 rcu_assign_pointer(tfile->tun, NULL);
476 list_for_each_entry(tfile, &tun->disabled, next) {
477 wake_up_all(&tfile->wq.wait);
478 rcu_assign_pointer(tfile->tun, NULL);
480 BUG_ON(tun->numqueues != 0);
483 for (i = 0; i < n; i++) {
484 tfile = rtnl_dereference(tun->tfiles[i]);
485 /* Drop read queue */
486 skb_queue_purge(&tfile->sk.sk_receive_queue);
487 sock_put(&tfile->sk);
489 list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
490 tun_enable_queue(tfile);
491 skb_queue_purge(&tfile->sk.sk_receive_queue);
492 sock_put(&tfile->sk);
494 BUG_ON(tun->numdisabled != 0);
496 if (tun->flags & TUN_PERSIST)
497 module_put(THIS_MODULE);
500 static int tun_attach(struct tun_struct *tun, struct file *file)
502 struct tun_file *tfile = file->private_data;
505 err = security_tun_dev_attach(tfile->socket.sk, tun->security);
510 if (rtnl_dereference(tfile->tun) && !tfile->detached)
514 if (!(tun->flags & TUN_TAP_MQ) && tun->numqueues == 1)
518 if (!tfile->detached &&
519 tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
524 /* Re-attach the filter to presist device */
525 if (tun->filter_attached == true) {
526 err = sk_attach_filter(&tun->fprog, tfile->socket.sk);
530 tfile->queue_index = tun->numqueues;
531 rcu_assign_pointer(tfile->tun, tun);
532 rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
536 tun_enable_queue(tfile);
538 sock_hold(&tfile->sk);
540 tun_set_real_num_queues(tun);
542 /* device is allowed to go away first, so no need to hold extra
550 static struct tun_struct *__tun_get(struct tun_file *tfile)
552 struct tun_struct *tun;
555 tun = rcu_dereference(tfile->tun);
563 static struct tun_struct *tun_get(struct file *file)
565 return __tun_get(file->private_data);
568 static void tun_put(struct tun_struct *tun)
574 static void addr_hash_set(u32 *mask, const u8 *addr)
576 int n = ether_crc(ETH_ALEN, addr) >> 26;
577 mask[n >> 5] |= (1 << (n & 31));
580 static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
582 int n = ether_crc(ETH_ALEN, addr) >> 26;
583 return mask[n >> 5] & (1 << (n & 31));
586 static int update_filter(struct tap_filter *filter, void __user *arg)
588 struct { u8 u[ETH_ALEN]; } *addr;
589 struct tun_filter uf;
590 int err, alen, n, nexact;
592 if (copy_from_user(&uf, arg, sizeof(uf)))
601 alen = ETH_ALEN * uf.count;
602 addr = kmalloc(alen, GFP_KERNEL);
606 if (copy_from_user(addr, arg + sizeof(uf), alen)) {
611 /* The filter is updated without holding any locks. Which is
612 * perfectly safe. We disable it first and in the worst
613 * case we'll accept a few undesired packets. */
617 /* Use first set of addresses as an exact filter */
618 for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
619 memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
623 /* Remaining multicast addresses are hashed,
624 * unicast will leave the filter disabled. */
625 memset(filter->mask, 0, sizeof(filter->mask));
626 for (; n < uf.count; n++) {
627 if (!is_multicast_ether_addr(addr[n].u)) {
628 err = 0; /* no filter */
631 addr_hash_set(filter->mask, addr[n].u);
634 /* For ALLMULTI just set the mask to all ones.
635 * This overrides the mask populated above. */
636 if ((uf.flags & TUN_FLT_ALLMULTI))
637 memset(filter->mask, ~0, sizeof(filter->mask));
639 /* Now enable the filter */
641 filter->count = nexact;
643 /* Return the number of exact filters */
651 /* Returns: 0 - drop, !=0 - accept */
652 static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
654 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
656 struct ethhdr *eh = (struct ethhdr *) skb->data;
660 for (i = 0; i < filter->count; i++)
661 if (ether_addr_equal(eh->h_dest, filter->addr[i]))
664 /* Inexact match (multicast only) */
665 if (is_multicast_ether_addr(eh->h_dest))
666 return addr_hash_test(filter->mask, eh->h_dest);
672 * Checks whether the packet is accepted or not.
673 * Returns: 0 - drop, !=0 - accept
675 static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
680 return run_filter(filter, skb);
683 /* Network device part of the driver */
685 static const struct ethtool_ops tun_ethtool_ops;
687 /* Net device detach from fd. */
688 static void tun_net_uninit(struct net_device *dev)
693 /* Net device open. */
694 static int tun_net_open(struct net_device *dev)
696 netif_tx_start_all_queues(dev);
700 /* Net device close. */
701 static int tun_net_close(struct net_device *dev)
703 netif_tx_stop_all_queues(dev);
707 /* Net device start xmit */
708 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
710 struct tun_struct *tun = netdev_priv(dev);
711 int txq = skb->queue_mapping;
712 struct tun_file *tfile;
715 tfile = rcu_dereference(tun->tfiles[txq]);
717 /* Drop packet if interface is not attached */
718 if (txq >= tun->numqueues)
721 tun_debug(KERN_INFO, tun, "tun_net_xmit %d\n", skb->len);
725 /* Drop if the filter does not like it.
726 * This is a noop if the filter is disabled.
727 * Filter can be enabled only for the TAP devices. */
728 if (!check_filter(&tun->txflt, skb))
731 if (tfile->socket.sk->sk_filter &&
732 sk_filter(tfile->socket.sk, skb))
735 /* Limit the number of packets queued by dividing txq length with the
738 if (skb_queue_len(&tfile->socket.sk->sk_receive_queue)
739 >= dev->tx_queue_len / tun->numqueues)
742 /* Orphan the skb - required as we might hang on to it
743 * for indefinite time. */
744 if (unlikely(skb_orphan_frags(skb, GFP_ATOMIC)))
751 skb_queue_tail(&tfile->socket.sk->sk_receive_queue, skb);
753 /* Notify and wake up reader process */
754 if (tfile->flags & TUN_FASYNC)
755 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
756 wake_up_interruptible_poll(&tfile->wq.wait, POLLIN |
757 POLLRDNORM | POLLRDBAND);
763 dev->stats.tx_dropped++;
770 static void tun_net_mclist(struct net_device *dev)
773 * This callback is supposed to deal with mc filter in
774 * _rx_ path and has nothing to do with the _tx_ path.
775 * In rx path we always accept everything userspace gives us.
780 #define MAX_MTU 65535
783 tun_net_change_mtu(struct net_device *dev, int new_mtu)
785 if (new_mtu < MIN_MTU || new_mtu + dev->hard_header_len > MAX_MTU)
791 static netdev_features_t tun_net_fix_features(struct net_device *dev,
792 netdev_features_t features)
794 struct tun_struct *tun = netdev_priv(dev);
796 return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
798 #ifdef CONFIG_NET_POLL_CONTROLLER
799 static void tun_poll_controller(struct net_device *dev)
802 * Tun only receives frames when:
803 * 1) the char device endpoint gets data from user space
804 * 2) the tun socket gets a sendmsg call from user space
805 * Since both of those are syncronous operations, we are guaranteed
806 * never to have pending data when we poll for it
807 * so theres nothing to do here but return.
808 * We need this though so netpoll recognizes us as an interface that
809 * supports polling, which enables bridge devices in virt setups to
810 * still use netconsole
815 static const struct net_device_ops tun_netdev_ops = {
816 .ndo_uninit = tun_net_uninit,
817 .ndo_open = tun_net_open,
818 .ndo_stop = tun_net_close,
819 .ndo_start_xmit = tun_net_xmit,
820 .ndo_change_mtu = tun_net_change_mtu,
821 .ndo_fix_features = tun_net_fix_features,
822 .ndo_select_queue = tun_select_queue,
823 #ifdef CONFIG_NET_POLL_CONTROLLER
824 .ndo_poll_controller = tun_poll_controller,
828 static const struct net_device_ops tap_netdev_ops = {
829 .ndo_uninit = tun_net_uninit,
830 .ndo_open = tun_net_open,
831 .ndo_stop = tun_net_close,
832 .ndo_start_xmit = tun_net_xmit,
833 .ndo_change_mtu = tun_net_change_mtu,
834 .ndo_fix_features = tun_net_fix_features,
835 .ndo_set_rx_mode = tun_net_mclist,
836 .ndo_set_mac_address = eth_mac_addr,
837 .ndo_validate_addr = eth_validate_addr,
838 .ndo_select_queue = tun_select_queue,
839 #ifdef CONFIG_NET_POLL_CONTROLLER
840 .ndo_poll_controller = tun_poll_controller,
844 static int tun_flow_init(struct tun_struct *tun)
848 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
849 INIT_HLIST_HEAD(&tun->flows[i]);
851 tun->ageing_time = TUN_FLOW_EXPIRE;
852 setup_timer(&tun->flow_gc_timer, tun_flow_cleanup, (unsigned long)tun);
853 mod_timer(&tun->flow_gc_timer,
854 round_jiffies_up(jiffies + tun->ageing_time));
859 static void tun_flow_uninit(struct tun_struct *tun)
861 del_timer_sync(&tun->flow_gc_timer);
865 /* Initialize net device. */
866 static void tun_net_init(struct net_device *dev)
868 struct tun_struct *tun = netdev_priv(dev);
870 switch (tun->flags & TUN_TYPE_MASK) {
872 dev->netdev_ops = &tun_netdev_ops;
874 /* Point-to-Point TUN Device */
875 dev->hard_header_len = 0;
879 /* Zero header length */
880 dev->type = ARPHRD_NONE;
881 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
882 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
886 dev->netdev_ops = &tap_netdev_ops;
887 /* Ethernet TAP Device */
889 dev->priv_flags &= ~IFF_TX_SKB_SHARING;
890 dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
892 eth_hw_addr_random(dev);
894 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
899 /* Character device part */
902 static unsigned int tun_chr_poll(struct file *file, poll_table *wait)
904 struct tun_file *tfile = file->private_data;
905 struct tun_struct *tun = __tun_get(tfile);
907 unsigned int mask = 0;
912 sk = tfile->socket.sk;
914 tun_debug(KERN_INFO, tun, "tun_chr_poll\n");
916 poll_wait(file, &tfile->wq.wait, wait);
918 if (!skb_queue_empty(&sk->sk_receive_queue))
919 mask |= POLLIN | POLLRDNORM;
921 if (sock_writeable(sk) ||
922 (!test_and_set_bit(SOCK_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
924 mask |= POLLOUT | POLLWRNORM;
926 if (tun->dev->reg_state != NETREG_REGISTERED)
933 /* prepad is the amount to reserve at front. len is length after that.
934 * linear is a hint as to how much to copy (usually headers). */
935 static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
936 size_t prepad, size_t len,
937 size_t linear, int noblock)
939 struct sock *sk = tfile->socket.sk;
943 /* Under a page? Don't bother with paged skb. */
944 if (prepad + len < PAGE_SIZE || !linear)
947 skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
952 skb_reserve(skb, prepad);
953 skb_put(skb, linear);
954 skb->data_len = len - linear;
955 skb->len += len - linear;
960 /* set skb frags from iovec, this can move to core network code for reuse */
961 static int zerocopy_sg_from_iovec(struct sk_buff *skb, const struct iovec *from,
962 int offset, size_t count)
964 int len = iov_length(from, count) - offset;
965 int copy = skb_headlen(skb);
966 int size, offset1 = 0;
969 /* Skip over from offset */
970 while (count && (offset >= from->iov_len)) {
971 offset -= from->iov_len;
976 /* copy up to skb headlen */
977 while (count && (copy > 0)) {
978 size = min_t(unsigned int, copy, from->iov_len - offset);
979 if (copy_from_user(skb->data + offset1, from->iov_base + offset,
996 struct page *page[MAX_SKB_FRAGS];
999 unsigned long truesize;
1001 len = from->iov_len - offset;
1007 base = (unsigned long)from->iov_base + offset;
1008 size = ((base & ~PAGE_MASK) + len + ~PAGE_MASK) >> PAGE_SHIFT;
1009 if (i + size > MAX_SKB_FRAGS)
1011 num_pages = get_user_pages_fast(base, size, 0, &page[i]);
1012 if (num_pages != size) {
1015 for (j = 0; j < num_pages; j++)
1016 put_page(page[i + j]);
1019 truesize = size * PAGE_SIZE;
1020 skb->data_len += len;
1022 skb->truesize += truesize;
1023 atomic_add(truesize, &skb->sk->sk_wmem_alloc);
1025 int off = base & ~PAGE_MASK;
1026 int size = min_t(int, len, PAGE_SIZE - off);
1027 __skb_fill_page_desc(skb, i, page[i], off, size);
1028 skb_shinfo(skb)->nr_frags++;
1029 /* increase sk_wmem_alloc */
1040 static unsigned long iov_pages(const struct iovec *iv, int offset,
1041 unsigned long nr_segs)
1043 unsigned long seg, base;
1044 int pages = 0, len, size;
1046 while (nr_segs && (offset >= iv->iov_len)) {
1047 offset -= iv->iov_len;
1052 for (seg = 0; seg < nr_segs; seg++) {
1053 base = (unsigned long)iv[seg].iov_base + offset;
1054 len = iv[seg].iov_len - offset;
1055 size = ((base & ~PAGE_MASK) + len + ~PAGE_MASK) >> PAGE_SHIFT;
1063 /* Get packet from user space buffer */
1064 static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
1065 void *msg_control, const struct iovec *iv,
1066 size_t total_len, size_t count, int noblock)
1068 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1069 struct sk_buff *skb;
1070 size_t len = total_len, align = NET_SKB_PAD, linear;
1071 struct virtio_net_hdr gso = { 0 };
1075 bool zerocopy = false;
1079 if (!(tun->flags & TUN_NO_PI)) {
1080 if (len < sizeof(pi))
1084 if (memcpy_fromiovecend((void *)&pi, iv, 0, sizeof(pi)))
1086 offset += sizeof(pi);
1089 if (tun->flags & TUN_VNET_HDR) {
1090 if (len < tun->vnet_hdr_sz)
1092 len -= tun->vnet_hdr_sz;
1094 if (memcpy_fromiovecend((void *)&gso, iv, offset, sizeof(gso)))
1097 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
1098 gso.csum_start + gso.csum_offset + 2 > gso.hdr_len)
1099 gso.hdr_len = gso.csum_start + gso.csum_offset + 2;
1101 if (gso.hdr_len > len)
1103 offset += tun->vnet_hdr_sz;
1106 if ((tun->flags & TUN_TYPE_MASK) == TUN_TAP_DEV) {
1107 align += NET_IP_ALIGN;
1108 if (unlikely(len < ETH_HLEN ||
1109 (gso.hdr_len && gso.hdr_len < ETH_HLEN)))
1113 good_linear = SKB_MAX_HEAD(align);
1116 /* There are 256 bytes to be copied in skb, so there is
1117 * enough room for skb expand head in case it is used.
1118 * The rest of the buffer is mapped from userspace.
1120 copylen = gso.hdr_len ? gso.hdr_len : GOODCOPY_LEN;
1121 if (copylen > good_linear)
1122 copylen = good_linear;
1124 if (iov_pages(iv, offset + copylen, count) <= MAX_SKB_FRAGS)
1130 if (gso.hdr_len > good_linear)
1131 linear = good_linear;
1133 linear = gso.hdr_len;
1136 skb = tun_alloc_skb(tfile, align, copylen, linear, noblock);
1138 if (PTR_ERR(skb) != -EAGAIN)
1139 tun->dev->stats.rx_dropped++;
1140 return PTR_ERR(skb);
1144 err = zerocopy_sg_from_iovec(skb, iv, offset, count);
1146 err = skb_copy_datagram_from_iovec(skb, 0, iv, offset, len);
1147 if (!err && msg_control) {
1148 struct ubuf_info *uarg = msg_control;
1149 uarg->callback(uarg, false);
1154 tun->dev->stats.rx_dropped++;
1159 if (gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) {
1160 if (!skb_partial_csum_set(skb, gso.csum_start,
1162 tun->dev->stats.rx_frame_errors++;
1168 switch (tun->flags & TUN_TYPE_MASK) {
1170 if (tun->flags & TUN_NO_PI) {
1171 switch (skb->data[0] & 0xf0) {
1173 pi.proto = htons(ETH_P_IP);
1176 pi.proto = htons(ETH_P_IPV6);
1179 tun->dev->stats.rx_dropped++;
1185 skb_reset_mac_header(skb);
1186 skb->protocol = pi.proto;
1187 skb->dev = tun->dev;
1190 skb->protocol = eth_type_trans(skb, tun->dev);
1194 if (gso.gso_type != VIRTIO_NET_HDR_GSO_NONE) {
1196 switch (gso.gso_type & ~VIRTIO_NET_HDR_GSO_ECN) {
1197 case VIRTIO_NET_HDR_GSO_TCPV4:
1198 skb_shinfo(skb)->gso_type = SKB_GSO_TCPV4;
1200 case VIRTIO_NET_HDR_GSO_TCPV6:
1201 skb_shinfo(skb)->gso_type = SKB_GSO_TCPV6;
1203 case VIRTIO_NET_HDR_GSO_UDP:
1204 skb_shinfo(skb)->gso_type = SKB_GSO_UDP;
1207 tun->dev->stats.rx_frame_errors++;
1212 if (gso.gso_type & VIRTIO_NET_HDR_GSO_ECN)
1213 skb_shinfo(skb)->gso_type |= SKB_GSO_TCP_ECN;
1215 skb_shinfo(skb)->gso_size = gso.gso_size;
1216 if (skb_shinfo(skb)->gso_size == 0) {
1217 tun->dev->stats.rx_frame_errors++;
1222 /* Header must be checked, and gso_segs computed. */
1223 skb_shinfo(skb)->gso_type |= SKB_GSO_DODGY;
1224 skb_shinfo(skb)->gso_segs = 0;
1227 /* copy skb_ubuf_info for callback when skb has no error */
1229 skb_shinfo(skb)->destructor_arg = msg_control;
1230 skb_shinfo(skb)->tx_flags |= SKBTX_DEV_ZEROCOPY;
1231 skb_shinfo(skb)->tx_flags |= SKBTX_SHARED_FRAG;
1234 skb_reset_network_header(skb);
1235 skb_probe_transport_header(skb, 0);
1237 rxhash = skb_get_rxhash(skb);
1240 tun->dev->stats.rx_packets++;
1241 tun->dev->stats.rx_bytes += len;
1243 tun_flow_update(tun, rxhash, tfile);
1247 static ssize_t tun_chr_aio_write(struct kiocb *iocb, const struct iovec *iv,
1248 unsigned long count, loff_t pos)
1250 struct file *file = iocb->ki_filp;
1251 struct tun_struct *tun = tun_get(file);
1252 struct tun_file *tfile = file->private_data;
1258 tun_debug(KERN_INFO, tun, "tun_chr_write %ld\n", count);
1260 result = tun_get_user(tun, tfile, NULL, iv, iov_length(iv, count),
1261 count, file->f_flags & O_NONBLOCK);
1267 /* Put packet to the user space buffer */
1268 static ssize_t tun_put_user(struct tun_struct *tun,
1269 struct tun_file *tfile,
1270 struct sk_buff *skb,
1271 const struct iovec *iv, int len)
1273 struct tun_pi pi = { 0, skb->protocol };
1276 if (!(tun->flags & TUN_NO_PI)) {
1277 if ((len -= sizeof(pi)) < 0)
1280 if (len < skb->len) {
1281 /* Packet will be striped */
1282 pi.flags |= TUN_PKT_STRIP;
1285 if (memcpy_toiovecend(iv, (void *) &pi, 0, sizeof(pi)))
1287 total += sizeof(pi);
1290 if (tun->flags & TUN_VNET_HDR) {
1291 struct virtio_net_hdr gso = { 0 }; /* no info leak */
1292 if ((len -= tun->vnet_hdr_sz) < 0)
1295 if (skb_is_gso(skb)) {
1296 struct skb_shared_info *sinfo = skb_shinfo(skb);
1298 /* This is a hint as to how much should be linear. */
1299 gso.hdr_len = skb_headlen(skb);
1300 gso.gso_size = sinfo->gso_size;
1301 if (sinfo->gso_type & SKB_GSO_TCPV4)
1302 gso.gso_type = VIRTIO_NET_HDR_GSO_TCPV4;
1303 else if (sinfo->gso_type & SKB_GSO_TCPV6)
1304 gso.gso_type = VIRTIO_NET_HDR_GSO_TCPV6;
1305 else if (sinfo->gso_type & SKB_GSO_UDP)
1306 gso.gso_type = VIRTIO_NET_HDR_GSO_UDP;
1308 pr_err("unexpected GSO type: "
1309 "0x%x, gso_size %d, hdr_len %d\n",
1310 sinfo->gso_type, gso.gso_size,
1312 print_hex_dump(KERN_ERR, "tun: ",
1315 min((int)gso.hdr_len, 64), true);
1319 if (sinfo->gso_type & SKB_GSO_TCP_ECN)
1320 gso.gso_type |= VIRTIO_NET_HDR_GSO_ECN;
1322 gso.gso_type = VIRTIO_NET_HDR_GSO_NONE;
1324 if (skb->ip_summed == CHECKSUM_PARTIAL) {
1325 gso.flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
1326 gso.csum_start = skb_checksum_start_offset(skb);
1327 gso.csum_offset = skb->csum_offset;
1328 } else if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
1329 gso.flags = VIRTIO_NET_HDR_F_DATA_VALID;
1330 } /* else everything is zero */
1332 if (unlikely(memcpy_toiovecend(iv, (void *)&gso, total,
1335 total += tun->vnet_hdr_sz;
1338 len = min_t(int, skb->len, len);
1340 skb_copy_datagram_const_iovec(skb, 0, iv, total, len);
1343 tun->dev->stats.tx_packets++;
1344 tun->dev->stats.tx_bytes += len;
1349 static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
1350 struct kiocb *iocb, const struct iovec *iv,
1351 ssize_t len, int noblock)
1353 DECLARE_WAITQUEUE(wait, current);
1354 struct sk_buff *skb;
1357 tun_debug(KERN_INFO, tun, "tun_do_read\n");
1359 if (unlikely(!noblock))
1360 add_wait_queue(&tfile->wq.wait, &wait);
1362 current->state = TASK_INTERRUPTIBLE;
1364 /* Read frames from the queue */
1365 if (!(skb = skb_dequeue(&tfile->socket.sk->sk_receive_queue))) {
1370 if (signal_pending(current)) {
1374 if (tun->dev->reg_state != NETREG_REGISTERED) {
1379 /* Nothing to read, let's sleep */
1384 ret = tun_put_user(tun, tfile, skb, iv, len);
1389 current->state = TASK_RUNNING;
1390 if (unlikely(!noblock))
1391 remove_wait_queue(&tfile->wq.wait, &wait);
1396 static ssize_t tun_chr_aio_read(struct kiocb *iocb, const struct iovec *iv,
1397 unsigned long count, loff_t pos)
1399 struct file *file = iocb->ki_filp;
1400 struct tun_file *tfile = file->private_data;
1401 struct tun_struct *tun = __tun_get(tfile);
1406 len = iov_length(iv, count);
1412 ret = tun_do_read(tun, tfile, iocb, iv, len,
1413 file->f_flags & O_NONBLOCK);
1414 ret = min_t(ssize_t, ret, len);
1422 static void tun_free_netdev(struct net_device *dev)
1424 struct tun_struct *tun = netdev_priv(dev);
1426 BUG_ON(!(list_empty(&tun->disabled)));
1427 tun_flow_uninit(tun);
1428 security_tun_dev_free_security(tun->security);
1432 static void tun_setup(struct net_device *dev)
1434 struct tun_struct *tun = netdev_priv(dev);
1436 tun->owner = INVALID_UID;
1437 tun->group = INVALID_GID;
1439 dev->ethtool_ops = &tun_ethtool_ops;
1440 dev->destructor = tun_free_netdev;
1443 /* Trivial set of netlink ops to allow deleting tun or tap
1444 * device with netlink.
1446 static int tun_validate(struct nlattr *tb[], struct nlattr *data[])
1451 static struct rtnl_link_ops tun_link_ops __read_mostly = {
1453 .priv_size = sizeof(struct tun_struct),
1455 .validate = tun_validate,
1458 static void tun_sock_write_space(struct sock *sk)
1460 struct tun_file *tfile;
1461 wait_queue_head_t *wqueue;
1463 if (!sock_writeable(sk))
1466 if (!test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sk->sk_socket->flags))
1469 wqueue = sk_sleep(sk);
1470 if (wqueue && waitqueue_active(wqueue))
1471 wake_up_interruptible_sync_poll(wqueue, POLLOUT |
1472 POLLWRNORM | POLLWRBAND);
1474 tfile = container_of(sk, struct tun_file, sk);
1475 kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
1478 static int tun_sendmsg(struct kiocb *iocb, struct socket *sock,
1479 struct msghdr *m, size_t total_len)
1482 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
1483 struct tun_struct *tun = __tun_get(tfile);
1487 ret = tun_get_user(tun, tfile, m->msg_control, m->msg_iov, total_len,
1488 m->msg_iovlen, m->msg_flags & MSG_DONTWAIT);
1494 static int tun_recvmsg(struct kiocb *iocb, struct socket *sock,
1495 struct msghdr *m, size_t total_len,
1498 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
1499 struct tun_struct *tun = __tun_get(tfile);
1505 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC)) {
1509 ret = tun_do_read(tun, tfile, iocb, m->msg_iov, total_len,
1510 flags & MSG_DONTWAIT);
1511 if (ret > total_len) {
1512 m->msg_flags |= MSG_TRUNC;
1513 ret = flags & MSG_TRUNC ? ret : total_len;
1520 static int tun_release(struct socket *sock)
1527 /* Ops structure to mimic raw sockets with tun */
1528 static const struct proto_ops tun_socket_ops = {
1529 .sendmsg = tun_sendmsg,
1530 .recvmsg = tun_recvmsg,
1531 .release = tun_release,
1534 static struct proto tun_proto = {
1536 .owner = THIS_MODULE,
1537 .obj_size = sizeof(struct tun_file),
1540 static int tun_flags(struct tun_struct *tun)
1544 if (tun->flags & TUN_TUN_DEV)
1549 if (tun->flags & TUN_NO_PI)
1552 /* This flag has no real effect. We track the value for backwards
1555 if (tun->flags & TUN_ONE_QUEUE)
1556 flags |= IFF_ONE_QUEUE;
1558 if (tun->flags & TUN_VNET_HDR)
1559 flags |= IFF_VNET_HDR;
1561 if (tun->flags & TUN_TAP_MQ)
1562 flags |= IFF_MULTI_QUEUE;
1567 static ssize_t tun_show_flags(struct device *dev, struct device_attribute *attr,
1570 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
1571 return sprintf(buf, "0x%x\n", tun_flags(tun));
1574 static ssize_t tun_show_owner(struct device *dev, struct device_attribute *attr,
1577 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
1578 return uid_valid(tun->owner)?
1579 sprintf(buf, "%u\n",
1580 from_kuid_munged(current_user_ns(), tun->owner)):
1581 sprintf(buf, "-1\n");
1584 static ssize_t tun_show_group(struct device *dev, struct device_attribute *attr,
1587 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
1588 return gid_valid(tun->group) ?
1589 sprintf(buf, "%u\n",
1590 from_kgid_munged(current_user_ns(), tun->group)):
1591 sprintf(buf, "-1\n");
1594 static DEVICE_ATTR(tun_flags, 0444, tun_show_flags, NULL);
1595 static DEVICE_ATTR(owner, 0444, tun_show_owner, NULL);
1596 static DEVICE_ATTR(group, 0444, tun_show_group, NULL);
1598 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
1600 struct tun_struct *tun;
1601 struct tun_file *tfile = file->private_data;
1602 struct net_device *dev;
1605 if (tfile->detached)
1608 dev = __dev_get_by_name(net, ifr->ifr_name);
1610 if (ifr->ifr_flags & IFF_TUN_EXCL)
1612 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
1613 tun = netdev_priv(dev);
1614 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
1615 tun = netdev_priv(dev);
1619 if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
1620 !!(tun->flags & TUN_TAP_MQ))
1623 if (tun_not_capable(tun))
1625 err = security_tun_dev_open(tun->security);
1629 err = tun_attach(tun, file);
1633 if (tun->flags & TUN_TAP_MQ &&
1634 (tun->numqueues + tun->numdisabled > 1)) {
1635 /* One or more queue has already been attached, no need
1636 * to initialize the device again.
1643 unsigned long flags = 0;
1644 int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
1647 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
1649 err = security_tun_dev_create();
1654 if (ifr->ifr_flags & IFF_TUN) {
1656 flags |= TUN_TUN_DEV;
1658 } else if (ifr->ifr_flags & IFF_TAP) {
1660 flags |= TUN_TAP_DEV;
1666 name = ifr->ifr_name;
1668 dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
1669 tun_setup, queues, queues);
1674 dev_net_set(dev, net);
1675 dev->rtnl_link_ops = &tun_link_ops;
1677 tun = netdev_priv(dev);
1680 tun->txflt.count = 0;
1681 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
1683 tun->filter_attached = false;
1684 tun->sndbuf = tfile->socket.sk->sk_sndbuf;
1686 spin_lock_init(&tun->lock);
1688 err = security_tun_dev_alloc_security(&tun->security);
1694 err = tun_flow_init(tun);
1698 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
1700 dev->features = dev->hw_features;
1701 dev->vlan_features = dev->features;
1703 INIT_LIST_HEAD(&tun->disabled);
1704 err = tun_attach(tun, file);
1708 err = register_netdevice(tun->dev);
1712 if (device_create_file(&tun->dev->dev, &dev_attr_tun_flags) ||
1713 device_create_file(&tun->dev->dev, &dev_attr_owner) ||
1714 device_create_file(&tun->dev->dev, &dev_attr_group))
1715 pr_err("Failed to create tun sysfs files\n");
1718 netif_carrier_on(tun->dev);
1720 tun_debug(KERN_INFO, tun, "tun_set_iff\n");
1722 if (ifr->ifr_flags & IFF_NO_PI)
1723 tun->flags |= TUN_NO_PI;
1725 tun->flags &= ~TUN_NO_PI;
1727 /* This flag has no real effect. We track the value for backwards
1730 if (ifr->ifr_flags & IFF_ONE_QUEUE)
1731 tun->flags |= TUN_ONE_QUEUE;
1733 tun->flags &= ~TUN_ONE_QUEUE;
1735 if (ifr->ifr_flags & IFF_VNET_HDR)
1736 tun->flags |= TUN_VNET_HDR;
1738 tun->flags &= ~TUN_VNET_HDR;
1740 if (ifr->ifr_flags & IFF_MULTI_QUEUE)
1741 tun->flags |= TUN_TAP_MQ;
1743 tun->flags &= ~TUN_TAP_MQ;
1745 /* Make sure persistent devices do not get stuck in
1748 if (netif_running(tun->dev))
1749 netif_tx_wake_all_queues(tun->dev);
1751 strcpy(ifr->ifr_name, tun->dev->name);
1755 tun_detach_all(dev);
1757 tun_flow_uninit(tun);
1758 security_tun_dev_free_security(tun->security);
1764 static void tun_get_iff(struct net *net, struct tun_struct *tun,
1767 tun_debug(KERN_INFO, tun, "tun_get_iff\n");
1769 strcpy(ifr->ifr_name, tun->dev->name);
1771 ifr->ifr_flags = tun_flags(tun);
1775 /* This is like a cut-down ethtool ops, except done via tun fd so no
1776 * privs required. */
1777 static int set_offload(struct tun_struct *tun, unsigned long arg)
1779 netdev_features_t features = 0;
1781 if (arg & TUN_F_CSUM) {
1782 features |= NETIF_F_HW_CSUM;
1785 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
1786 if (arg & TUN_F_TSO_ECN) {
1787 features |= NETIF_F_TSO_ECN;
1788 arg &= ~TUN_F_TSO_ECN;
1790 if (arg & TUN_F_TSO4)
1791 features |= NETIF_F_TSO;
1792 if (arg & TUN_F_TSO6)
1793 features |= NETIF_F_TSO6;
1794 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
1797 if (arg & TUN_F_UFO) {
1798 features |= NETIF_F_UFO;
1803 /* This gives the user a way to test for new features in future by
1804 * trying to set them. */
1808 tun->set_features = features;
1809 netdev_update_features(tun->dev);
1814 static void tun_detach_filter(struct tun_struct *tun, int n)
1817 struct tun_file *tfile;
1819 for (i = 0; i < n; i++) {
1820 tfile = rtnl_dereference(tun->tfiles[i]);
1821 sk_detach_filter(tfile->socket.sk);
1824 tun->filter_attached = false;
1827 static int tun_attach_filter(struct tun_struct *tun)
1830 struct tun_file *tfile;
1832 for (i = 0; i < tun->numqueues; i++) {
1833 tfile = rtnl_dereference(tun->tfiles[i]);
1834 ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
1836 tun_detach_filter(tun, i);
1841 tun->filter_attached = true;
1845 static void tun_set_sndbuf(struct tun_struct *tun)
1847 struct tun_file *tfile;
1850 for (i = 0; i < tun->numqueues; i++) {
1851 tfile = rtnl_dereference(tun->tfiles[i]);
1852 tfile->socket.sk->sk_sndbuf = tun->sndbuf;
1856 static int tun_set_queue(struct file *file, struct ifreq *ifr)
1858 struct tun_file *tfile = file->private_data;
1859 struct tun_struct *tun;
1864 if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
1865 tun = tfile->detached;
1870 ret = security_tun_dev_attach_queue(tun->security);
1873 ret = tun_attach(tun, file);
1874 } else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
1875 tun = rtnl_dereference(tfile->tun);
1876 if (!tun || !(tun->flags & TUN_TAP_MQ) || tfile->detached)
1879 __tun_detach(tfile, false);
1888 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
1889 unsigned long arg, int ifreq_len)
1891 struct tun_file *tfile = file->private_data;
1892 struct tun_struct *tun;
1893 void __user* argp = (void __user*)arg;
1901 #ifdef CONFIG_ANDROID_PARANOID_NETWORK
1902 if (cmd != TUNGETIFF && !capable(CAP_NET_ADMIN)) {
1907 if (cmd == TUNSETIFF || cmd == TUNSETQUEUE || _IOC_TYPE(cmd) == 0x89) {
1908 if (copy_from_user(&ifr, argp, ifreq_len))
1911 memset(&ifr, 0, sizeof(ifr));
1913 if (cmd == TUNGETFEATURES) {
1914 /* Currently this just means: "what IFF flags are valid?".
1915 * This is needed because we never checked for invalid flags on
1917 return put_user(IFF_TUN | IFF_TAP | IFF_NO_PI | IFF_ONE_QUEUE |
1918 IFF_VNET_HDR | IFF_MULTI_QUEUE,
1919 (unsigned int __user*)argp);
1920 } else if (cmd == TUNSETQUEUE)
1921 return tun_set_queue(file, &ifr);
1926 tun = __tun_get(tfile);
1927 if (cmd == TUNSETIFF && !tun) {
1928 ifr.ifr_name[IFNAMSIZ-1] = '\0';
1930 ret = tun_set_iff(tfile->net, file, &ifr);
1935 if (copy_to_user(argp, &ifr, ifreq_len))
1944 tun_debug(KERN_INFO, tun, "tun_chr_ioctl cmd %u\n", cmd);
1949 tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
1951 if (copy_to_user(argp, &ifr, ifreq_len))
1956 /* Disable/Enable checksum */
1958 /* [unimplemented] */
1959 tun_debug(KERN_INFO, tun, "ignored: set checksum %s\n",
1960 arg ? "disabled" : "enabled");
1964 /* Disable/Enable persist mode. Keep an extra reference to the
1965 * module to prevent the module being unprobed.
1967 if (arg && !(tun->flags & TUN_PERSIST)) {
1968 tun->flags |= TUN_PERSIST;
1969 __module_get(THIS_MODULE);
1971 if (!arg && (tun->flags & TUN_PERSIST)) {
1972 tun->flags &= ~TUN_PERSIST;
1973 module_put(THIS_MODULE);
1976 tun_debug(KERN_INFO, tun, "persist %s\n",
1977 arg ? "enabled" : "disabled");
1981 /* Set owner of the device */
1982 owner = make_kuid(current_user_ns(), arg);
1983 if (!uid_valid(owner)) {
1988 tun_debug(KERN_INFO, tun, "owner set to %u\n",
1989 from_kuid(&init_user_ns, tun->owner));
1993 /* Set group of the device */
1994 group = make_kgid(current_user_ns(), arg);
1995 if (!gid_valid(group)) {
2000 tun_debug(KERN_INFO, tun, "group set to %u\n",
2001 from_kgid(&init_user_ns, tun->group));
2005 /* Only allow setting the type when the interface is down */
2006 if (tun->dev->flags & IFF_UP) {
2007 tun_debug(KERN_INFO, tun,
2008 "Linktype set failed because interface is up\n");
2011 tun->dev->type = (int) arg;
2012 tun_debug(KERN_INFO, tun, "linktype set to %d\n",
2024 ret = set_offload(tun, arg);
2027 case TUNSETTXFILTER:
2028 /* Can be set only for TAPs */
2030 if ((tun->flags & TUN_TYPE_MASK) != TUN_TAP_DEV)
2032 ret = update_filter(&tun->txflt, (void __user *)arg);
2036 /* Get hw address */
2037 memcpy(ifr.ifr_hwaddr.sa_data, tun->dev->dev_addr, ETH_ALEN);
2038 ifr.ifr_hwaddr.sa_family = tun->dev->type;
2039 if (copy_to_user(argp, &ifr, ifreq_len))
2044 /* Set hw address */
2045 tun_debug(KERN_DEBUG, tun, "set hw address: %pM\n",
2046 ifr.ifr_hwaddr.sa_data);
2048 ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr);
2052 sndbuf = tfile->socket.sk->sk_sndbuf;
2053 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
2058 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
2063 tun->sndbuf = sndbuf;
2064 tun_set_sndbuf(tun);
2067 case TUNGETVNETHDRSZ:
2068 vnet_hdr_sz = tun->vnet_hdr_sz;
2069 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
2073 case TUNSETVNETHDRSZ:
2074 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
2078 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
2083 tun->vnet_hdr_sz = vnet_hdr_sz;
2086 case TUNATTACHFILTER:
2087 /* Can be set only for TAPs */
2089 if ((tun->flags & TUN_TYPE_MASK) != TUN_TAP_DEV)
2092 if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
2095 ret = tun_attach_filter(tun);
2098 case TUNDETACHFILTER:
2099 /* Can be set only for TAPs */
2101 if ((tun->flags & TUN_TYPE_MASK) != TUN_TAP_DEV)
2104 tun_detach_filter(tun, tun->numqueues);
2119 static long tun_chr_ioctl(struct file *file,
2120 unsigned int cmd, unsigned long arg)
2122 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
2125 #ifdef CONFIG_COMPAT
2126 static long tun_chr_compat_ioctl(struct file *file,
2127 unsigned int cmd, unsigned long arg)
2132 case TUNSETTXFILTER:
2137 arg = (unsigned long)compat_ptr(arg);
2140 arg = (compat_ulong_t)arg;
2145 * compat_ifreq is shorter than ifreq, so we must not access beyond
2146 * the end of that structure. All fields that are used in this
2147 * driver are compatible though, we don't need to convert the
2150 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
2152 #endif /* CONFIG_COMPAT */
2154 static int tun_chr_fasync(int fd, struct file *file, int on)
2156 struct tun_file *tfile = file->private_data;
2159 if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
2163 ret = __f_setown(file, task_pid(current), PIDTYPE_PID, 0);
2166 tfile->flags |= TUN_FASYNC;
2168 tfile->flags &= ~TUN_FASYNC;
2174 static int tun_chr_open(struct inode *inode, struct file * file)
2176 struct tun_file *tfile;
2178 DBG1(KERN_INFO, "tunX: tun_chr_open\n");
2180 tfile = (struct tun_file *)sk_alloc(&init_net, AF_UNSPEC, GFP_KERNEL,
2184 rcu_assign_pointer(tfile->tun, NULL);
2185 tfile->net = get_net(current->nsproxy->net_ns);
2188 rcu_assign_pointer(tfile->socket.wq, &tfile->wq);
2189 init_waitqueue_head(&tfile->wq.wait);
2191 tfile->socket.file = file;
2192 tfile->socket.ops = &tun_socket_ops;
2194 sock_init_data(&tfile->socket, &tfile->sk);
2195 sk_change_net(&tfile->sk, tfile->net);
2197 tfile->sk.sk_write_space = tun_sock_write_space;
2198 tfile->sk.sk_sndbuf = INT_MAX;
2200 file->private_data = tfile;
2201 set_bit(SOCK_EXTERNALLY_ALLOCATED, &tfile->socket.flags);
2202 INIT_LIST_HEAD(&tfile->next);
2204 sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
2209 static int tun_chr_close(struct inode *inode, struct file *file)
2211 struct tun_file *tfile = file->private_data;
2212 struct net *net = tfile->net;
2214 tun_detach(tfile, true);
2220 static const struct file_operations tun_fops = {
2221 .owner = THIS_MODULE,
2222 .llseek = no_llseek,
2223 .read = do_sync_read,
2224 .aio_read = tun_chr_aio_read,
2225 .write = do_sync_write,
2226 .aio_write = tun_chr_aio_write,
2227 .poll = tun_chr_poll,
2228 .unlocked_ioctl = tun_chr_ioctl,
2229 #ifdef CONFIG_COMPAT
2230 .compat_ioctl = tun_chr_compat_ioctl,
2232 .open = tun_chr_open,
2233 .release = tun_chr_close,
2234 .fasync = tun_chr_fasync
2237 static struct miscdevice tun_miscdev = {
2240 .nodename = "net/tun",
2244 /* ethtool interface */
2246 static int tun_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
2249 cmd->advertising = 0;
2250 ethtool_cmd_speed_set(cmd, SPEED_10);
2251 cmd->duplex = DUPLEX_FULL;
2252 cmd->port = PORT_TP;
2253 cmd->phy_address = 0;
2254 cmd->transceiver = XCVR_INTERNAL;
2255 cmd->autoneg = AUTONEG_DISABLE;
2261 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
2263 struct tun_struct *tun = netdev_priv(dev);
2265 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
2266 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
2268 switch (tun->flags & TUN_TYPE_MASK) {
2270 strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
2273 strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
2278 static u32 tun_get_msglevel(struct net_device *dev)
2281 struct tun_struct *tun = netdev_priv(dev);
2288 static void tun_set_msglevel(struct net_device *dev, u32 value)
2291 struct tun_struct *tun = netdev_priv(dev);
2296 static const struct ethtool_ops tun_ethtool_ops = {
2297 .get_settings = tun_get_settings,
2298 .get_drvinfo = tun_get_drvinfo,
2299 .get_msglevel = tun_get_msglevel,
2300 .set_msglevel = tun_set_msglevel,
2301 .get_link = ethtool_op_get_link,
2305 static int __init tun_init(void)
2309 pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
2310 pr_info("%s\n", DRV_COPYRIGHT);
2312 ret = rtnl_link_register(&tun_link_ops);
2314 pr_err("Can't register link_ops\n");
2318 ret = misc_register(&tun_miscdev);
2320 pr_err("Can't register misc device %d\n", TUN_MINOR);
2325 rtnl_link_unregister(&tun_link_ops);
2330 static void tun_cleanup(void)
2332 misc_deregister(&tun_miscdev);
2333 rtnl_link_unregister(&tun_link_ops);
2336 /* Get an underlying socket object from tun file. Returns error unless file is
2337 * attached to a device. The returned object works like a packet socket, it
2338 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
2339 * holding a reference to the file for as long as the socket is in use. */
2340 struct socket *tun_get_socket(struct file *file)
2342 struct tun_file *tfile;
2343 if (file->f_op != &tun_fops)
2344 return ERR_PTR(-EINVAL);
2345 tfile = file->private_data;
2347 return ERR_PTR(-EBADFD);
2348 return &tfile->socket;
2350 EXPORT_SYMBOL_GPL(tun_get_socket);
2352 module_init(tun_init);
2353 module_exit(tun_cleanup);
2354 MODULE_DESCRIPTION(DRV_DESCRIPTION);
2355 MODULE_AUTHOR(DRV_COPYRIGHT);
2356 MODULE_LICENSE("GPL");
2357 MODULE_ALIAS_MISCDEV(TUN_MINOR);
2358 MODULE_ALIAS("devname:net/tun");