2 * TUN - Universal TUN/TAP device driver.
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 $
22 * Add TUNSETLINK ioctl to set the link encapsulation
25 * Use eth_random_addr() for tap MAC address.
28 * Fixes in packet dropping, queue length setting and queue wakeup.
29 * Increased default tx queue length.
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"
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/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>
72 #include <linux/seq_file.h>
73 #include <linux/uio.h>
75 #include <asm/uaccess.h>
77 /* Uncomment to enable debugging */
78 /* #define TUN_DEBUG 1 */
83 #define tun_debug(level, tun, fmt, args...) \
86 netdev_printk(level, tun->dev, fmt, ##args); \
88 #define DBG1(level, fmt, args...) \
91 printk(level fmt, ##args); \
94 #define tun_debug(level, tun, fmt, args...) \
97 netdev_printk(level, tun->dev, fmt, ##args); \
99 #define DBG1(level, fmt, args...) \
102 printk(level fmt, ##args); \
106 /* TUN device flags */
108 /* IFF_ATTACH_QUEUE is never stored in device flags,
109 * overload it to mean fasync when stored there.
111 #define TUN_FASYNC IFF_ATTACH_QUEUE
112 /* High bits in flags field are unused. */
113 #define TUN_VNET_LE 0x80000000
115 #define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
117 #define GOODCOPY_LEN 128
119 #define FLT_EXACT_COUNT 8
121 unsigned int count; /* Number of addrs. Zero means disabled */
122 u32 mask[2]; /* Mask of the hashed addrs */
123 unsigned char addr[FLT_EXACT_COUNT][ETH_ALEN];
126 /* MAX_TAP_QUEUES 256 is chosen to allow rx/tx queues to be equal
127 * to max number of VCPUs in guest. */
128 #define MAX_TAP_QUEUES 256
129 #define MAX_TAP_FLOWS 4096
131 #define TUN_FLOW_EXPIRE (3 * HZ)
133 /* A tun_file connects an open character device to a tuntap netdevice. It
134 * also contains all socket related structures (except sock_fprog and tap_filter)
135 * to serve as one transmit queue for tuntap device. The sock_fprog and
136 * tap_filter were kept in tun_struct since they were used for filtering for the
137 * netdevice not for a specific queue (at least I didn't see the requirement for
141 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
142 * other can only be read while rcu_read_lock or rtnl_lock is held.
146 struct socket socket;
148 struct tun_struct __rcu *tun;
150 struct fasync_struct *fasync;
151 /* only used for fasnyc */
155 unsigned int ifindex;
157 struct list_head next;
158 struct tun_struct *detached;
161 struct tun_flow_entry {
162 struct hlist_node hash_link;
164 struct tun_struct *tun;
169 unsigned long updated;
172 #define TUN_NUM_FLOW_ENTRIES 1024
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.
179 struct tun_file __rcu *tfiles[MAX_TAP_QUEUES];
180 unsigned int numqueues;
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)
192 struct tap_filter txflt;
193 struct sock_fprog fprog;
194 /* protected by rtnl lock */
195 bool filter_attached;
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;
209 static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
211 return __virtio16_to_cpu(tun->flags & TUN_VNET_LE, val);
214 static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
216 return __cpu_to_virtio16(tun->flags & TUN_VNET_LE, val);
219 static inline u32 tun_hashfn(u32 rxhash)
221 return rxhash & 0x3ff;
224 static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
226 struct tun_flow_entry *e;
228 hlist_for_each_entry_rcu(e, head, hash_link) {
229 if (e->rxhash == rxhash)
235 static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
236 struct hlist_head *head,
237 u32 rxhash, u16 queue_index)
239 struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
242 tun_debug(KERN_INFO, tun, "create flow: hash %u index %u\n",
243 rxhash, queue_index);
244 e->updated = jiffies;
247 e->queue_index = queue_index;
249 hlist_add_head_rcu(&e->hash_link, head);
255 static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
257 tun_debug(KERN_INFO, tun, "delete flow: hash %u index %u\n",
258 e->rxhash, e->queue_index);
259 hlist_del_rcu(&e->hash_link);
264 static void tun_flow_flush(struct tun_struct *tun)
268 spin_lock_bh(&tun->lock);
269 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
270 struct tun_flow_entry *e;
271 struct hlist_node *n;
273 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
274 tun_flow_delete(tun, e);
276 spin_unlock_bh(&tun->lock);
279 static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
283 spin_lock_bh(&tun->lock);
284 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
285 struct tun_flow_entry *e;
286 struct hlist_node *n;
288 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
289 if (e->queue_index == queue_index)
290 tun_flow_delete(tun, e);
293 spin_unlock_bh(&tun->lock);
296 static void tun_flow_cleanup(unsigned long data)
298 struct tun_struct *tun = (struct tun_struct *)data;
299 unsigned long delay = tun->ageing_time;
300 unsigned long next_timer = jiffies + delay;
301 unsigned long count = 0;
304 tun_debug(KERN_INFO, tun, "tun_flow_cleanup\n");
306 spin_lock_bh(&tun->lock);
307 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
308 struct tun_flow_entry *e;
309 struct hlist_node *n;
311 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
312 unsigned long this_timer;
314 this_timer = e->updated + delay;
315 if (time_before_eq(this_timer, jiffies))
316 tun_flow_delete(tun, e);
317 else if (time_before(this_timer, next_timer))
318 next_timer = this_timer;
323 mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
324 spin_unlock_bh(&tun->lock);
327 static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
328 struct tun_file *tfile)
330 struct hlist_head *head;
331 struct tun_flow_entry *e;
332 unsigned long delay = tun->ageing_time;
333 u16 queue_index = tfile->queue_index;
338 head = &tun->flows[tun_hashfn(rxhash)];
342 /* We may get a very small possibility of OOO during switching, not
343 * worth to optimize.*/
344 if (tun->numqueues == 1 || tfile->detached)
347 e = tun_flow_find(head, rxhash);
349 /* TODO: keep queueing to old queue until it's empty? */
350 e->queue_index = queue_index;
351 e->updated = jiffies;
352 sock_rps_record_flow_hash(e->rps_rxhash);
354 spin_lock_bh(&tun->lock);
355 if (!tun_flow_find(head, rxhash) &&
356 tun->flow_count < MAX_TAP_FLOWS)
357 tun_flow_create(tun, head, rxhash, queue_index);
359 if (!timer_pending(&tun->flow_gc_timer))
360 mod_timer(&tun->flow_gc_timer,
361 round_jiffies_up(jiffies + delay));
362 spin_unlock_bh(&tun->lock);
370 * Save the hash received in the stack receive path and update the
371 * flow_hash table accordingly.
373 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry *e, u32 hash)
375 if (unlikely(e->rps_rxhash != hash))
376 e->rps_rxhash = hash;
379 /* We try to identify a flow through its rxhash first. The reason that
380 * we do not check rxq no. is because some cards(e.g 82599), chooses
381 * the rxq based on the txq where the last packet of the flow comes. As
382 * the userspace application move between processors, we may get a
383 * different rxq no. here. If we could not get rxhash, then we would
384 * hope the rxq no. may help here.
386 static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb,
387 void *accel_priv, select_queue_fallback_t fallback)
389 struct tun_struct *tun = netdev_priv(dev);
390 struct tun_flow_entry *e;
395 numqueues = ACCESS_ONCE(tun->numqueues);
397 txq = skb_get_hash(skb);
399 e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
401 tun_flow_save_rps_rxhash(e, txq);
402 txq = e->queue_index;
404 /* use multiply and shift instead of expensive divide */
405 txq = ((u64)txq * numqueues) >> 32;
406 } else if (likely(skb_rx_queue_recorded(skb))) {
407 txq = skb_get_rx_queue(skb);
408 while (unlikely(txq >= numqueues))
416 static inline bool tun_not_capable(struct tun_struct *tun)
418 const struct cred *cred = current_cred();
419 struct net *net = dev_net(tun->dev);
421 return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
422 (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
423 !ns_capable(net->user_ns, CAP_NET_ADMIN);
426 static void tun_set_real_num_queues(struct tun_struct *tun)
428 netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
429 netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
432 static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
434 tfile->detached = tun;
435 list_add_tail(&tfile->next, &tun->disabled);
439 static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
441 struct tun_struct *tun = tfile->detached;
443 tfile->detached = NULL;
444 list_del_init(&tfile->next);
449 static void tun_queue_purge(struct tun_file *tfile)
451 skb_queue_purge(&tfile->sk.sk_receive_queue);
452 skb_queue_purge(&tfile->sk.sk_error_queue);
455 static void __tun_detach(struct tun_file *tfile, bool clean)
457 struct tun_file *ntfile;
458 struct tun_struct *tun;
460 tun = rtnl_dereference(tfile->tun);
462 if (tun && !tfile->detached) {
463 u16 index = tfile->queue_index;
464 BUG_ON(index >= tun->numqueues);
466 rcu_assign_pointer(tun->tfiles[index],
467 tun->tfiles[tun->numqueues - 1]);
468 ntfile = rtnl_dereference(tun->tfiles[index]);
469 ntfile->queue_index = index;
473 RCU_INIT_POINTER(tfile->tun, NULL);
474 sock_put(&tfile->sk);
476 tun_disable_queue(tun, tfile);
479 tun_flow_delete_by_queue(tun, tun->numqueues + 1);
480 /* Drop read queue */
481 tun_queue_purge(tfile);
482 tun_set_real_num_queues(tun);
483 } else if (tfile->detached && clean) {
484 tun = tun_enable_queue(tfile);
485 sock_put(&tfile->sk);
489 if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
490 netif_carrier_off(tun->dev);
492 if (!(tun->flags & IFF_PERSIST) &&
493 tun->dev->reg_state == NETREG_REGISTERED)
494 unregister_netdevice(tun->dev);
497 BUG_ON(!test_bit(SOCK_EXTERNALLY_ALLOCATED,
498 &tfile->socket.flags));
499 sk_release_kernel(&tfile->sk);
503 static void tun_detach(struct tun_file *tfile, bool clean)
506 __tun_detach(tfile, clean);
510 static void tun_detach_all(struct net_device *dev)
512 struct tun_struct *tun = netdev_priv(dev);
513 struct tun_file *tfile, *tmp;
514 int i, n = tun->numqueues;
516 for (i = 0; i < n; i++) {
517 tfile = rtnl_dereference(tun->tfiles[i]);
519 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
520 RCU_INIT_POINTER(tfile->tun, NULL);
523 list_for_each_entry(tfile, &tun->disabled, next) {
524 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
525 RCU_INIT_POINTER(tfile->tun, NULL);
527 BUG_ON(tun->numqueues != 0);
530 for (i = 0; i < n; i++) {
531 tfile = rtnl_dereference(tun->tfiles[i]);
532 /* Drop read queue */
533 tun_queue_purge(tfile);
534 sock_put(&tfile->sk);
536 list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
537 tun_enable_queue(tfile);
538 tun_queue_purge(tfile);
539 sock_put(&tfile->sk);
541 BUG_ON(tun->numdisabled != 0);
543 if (tun->flags & IFF_PERSIST)
544 module_put(THIS_MODULE);
547 static int tun_attach(struct tun_struct *tun, struct file *file, bool skip_filter)
549 struct tun_file *tfile = file->private_data;
552 err = security_tun_dev_attach(tfile->socket.sk, tun->security);
557 if (rtnl_dereference(tfile->tun) && !tfile->detached)
561 if (!(tun->flags & IFF_MULTI_QUEUE) && tun->numqueues == 1)
565 if (!tfile->detached &&
566 tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
571 /* Re-attach the filter to persist device */
572 if (!skip_filter && (tun->filter_attached == true)) {
573 err = sk_attach_filter(&tun->fprog, tfile->socket.sk);
577 tfile->queue_index = tun->numqueues;
578 rcu_assign_pointer(tfile->tun, tun);
579 rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
583 tun_enable_queue(tfile);
585 sock_hold(&tfile->sk);
587 tun_set_real_num_queues(tun);
589 /* device is allowed to go away first, so no need to hold extra
597 static struct tun_struct *__tun_get(struct tun_file *tfile)
599 struct tun_struct *tun;
602 tun = rcu_dereference(tfile->tun);
610 static struct tun_struct *tun_get(struct file *file)
612 return __tun_get(file->private_data);
615 static void tun_put(struct tun_struct *tun)
621 static void addr_hash_set(u32 *mask, const u8 *addr)
623 int n = ether_crc(ETH_ALEN, addr) >> 26;
624 mask[n >> 5] |= (1 << (n & 31));
627 static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
629 int n = ether_crc(ETH_ALEN, addr) >> 26;
630 return mask[n >> 5] & (1 << (n & 31));
633 static int update_filter(struct tap_filter *filter, void __user *arg)
635 struct { u8 u[ETH_ALEN]; } *addr;
636 struct tun_filter uf;
637 int err, alen, n, nexact;
639 if (copy_from_user(&uf, arg, sizeof(uf)))
648 alen = ETH_ALEN * uf.count;
649 addr = kmalloc(alen, GFP_KERNEL);
653 if (copy_from_user(addr, arg + sizeof(uf), alen)) {
658 /* The filter is updated without holding any locks. Which is
659 * perfectly safe. We disable it first and in the worst
660 * case we'll accept a few undesired packets. */
664 /* Use first set of addresses as an exact filter */
665 for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
666 memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
670 /* Remaining multicast addresses are hashed,
671 * unicast will leave the filter disabled. */
672 memset(filter->mask, 0, sizeof(filter->mask));
673 for (; n < uf.count; n++) {
674 if (!is_multicast_ether_addr(addr[n].u)) {
675 err = 0; /* no filter */
678 addr_hash_set(filter->mask, addr[n].u);
681 /* For ALLMULTI just set the mask to all ones.
682 * This overrides the mask populated above. */
683 if ((uf.flags & TUN_FLT_ALLMULTI))
684 memset(filter->mask, ~0, sizeof(filter->mask));
686 /* Now enable the filter */
688 filter->count = nexact;
690 /* Return the number of exact filters */
698 /* Returns: 0 - drop, !=0 - accept */
699 static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
701 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
703 struct ethhdr *eh = (struct ethhdr *) skb->data;
707 for (i = 0; i < filter->count; i++)
708 if (ether_addr_equal(eh->h_dest, filter->addr[i]))
711 /* Inexact match (multicast only) */
712 if (is_multicast_ether_addr(eh->h_dest))
713 return addr_hash_test(filter->mask, eh->h_dest);
719 * Checks whether the packet is accepted or not.
720 * Returns: 0 - drop, !=0 - accept
722 static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
727 return run_filter(filter, skb);
730 /* Network device part of the driver */
732 static const struct ethtool_ops tun_ethtool_ops;
734 /* Net device detach from fd. */
735 static void tun_net_uninit(struct net_device *dev)
740 /* Net device open. */
741 static int tun_net_open(struct net_device *dev)
743 netif_tx_start_all_queues(dev);
747 /* Net device close. */
748 static int tun_net_close(struct net_device *dev)
750 netif_tx_stop_all_queues(dev);
754 /* Net device start xmit */
755 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
757 struct tun_struct *tun = netdev_priv(dev);
758 int txq = skb->queue_mapping;
759 struct tun_file *tfile;
763 tfile = rcu_dereference(tun->tfiles[txq]);
764 numqueues = ACCESS_ONCE(tun->numqueues);
766 /* Drop packet if interface is not attached */
767 if (txq >= numqueues)
770 if (numqueues == 1) {
771 /* Select queue was not called for the skbuff, so we extract the
772 * RPS hash and save it into the flow_table here.
776 rxhash = skb_get_hash(skb);
778 struct tun_flow_entry *e;
779 e = tun_flow_find(&tun->flows[tun_hashfn(rxhash)],
782 tun_flow_save_rps_rxhash(e, rxhash);
786 tun_debug(KERN_INFO, tun, "tun_net_xmit %d\n", skb->len);
790 /* Drop if the filter does not like it.
791 * This is a noop if the filter is disabled.
792 * Filter can be enabled only for the TAP devices. */
793 if (!check_filter(&tun->txflt, skb))
796 if (tfile->socket.sk->sk_filter &&
797 sk_filter(tfile->socket.sk, skb))
800 /* Limit the number of packets queued by dividing txq length with the
803 if (skb_queue_len(&tfile->socket.sk->sk_receive_queue) * numqueues
804 >= dev->tx_queue_len)
807 if (unlikely(skb_orphan_frags(skb, GFP_ATOMIC)))
811 sock_tx_timestamp(skb->sk, &skb_shinfo(skb)->tx_flags);
812 sw_tx_timestamp(skb);
815 /* Orphan the skb - required as we might hang on to it
816 * for indefinite time.
823 skb_queue_tail(&tfile->socket.sk->sk_receive_queue, skb);
825 /* Notify and wake up reader process */
826 if (tfile->flags & TUN_FASYNC)
827 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
828 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
834 dev->stats.tx_dropped++;
838 return NET_XMIT_DROP;
841 static void tun_net_mclist(struct net_device *dev)
844 * This callback is supposed to deal with mc filter in
845 * _rx_ path and has nothing to do with the _tx_ path.
846 * In rx path we always accept everything userspace gives us.
851 #define MAX_MTU 65535
854 tun_net_change_mtu(struct net_device *dev, int new_mtu)
856 if (new_mtu < MIN_MTU || new_mtu + dev->hard_header_len > MAX_MTU)
862 static netdev_features_t tun_net_fix_features(struct net_device *dev,
863 netdev_features_t features)
865 struct tun_struct *tun = netdev_priv(dev);
867 return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
869 #ifdef CONFIG_NET_POLL_CONTROLLER
870 static void tun_poll_controller(struct net_device *dev)
873 * Tun only receives frames when:
874 * 1) the char device endpoint gets data from user space
875 * 2) the tun socket gets a sendmsg call from user space
876 * Since both of those are synchronous operations, we are guaranteed
877 * never to have pending data when we poll for it
878 * so there is nothing to do here but return.
879 * We need this though so netpoll recognizes us as an interface that
880 * supports polling, which enables bridge devices in virt setups to
881 * still use netconsole
886 static const struct net_device_ops tun_netdev_ops = {
887 .ndo_uninit = tun_net_uninit,
888 .ndo_open = tun_net_open,
889 .ndo_stop = tun_net_close,
890 .ndo_start_xmit = tun_net_xmit,
891 .ndo_change_mtu = tun_net_change_mtu,
892 .ndo_fix_features = tun_net_fix_features,
893 .ndo_select_queue = tun_select_queue,
894 #ifdef CONFIG_NET_POLL_CONTROLLER
895 .ndo_poll_controller = tun_poll_controller,
899 static const struct net_device_ops tap_netdev_ops = {
900 .ndo_uninit = tun_net_uninit,
901 .ndo_open = tun_net_open,
902 .ndo_stop = tun_net_close,
903 .ndo_start_xmit = tun_net_xmit,
904 .ndo_change_mtu = tun_net_change_mtu,
905 .ndo_fix_features = tun_net_fix_features,
906 .ndo_set_rx_mode = tun_net_mclist,
907 .ndo_set_mac_address = eth_mac_addr,
908 .ndo_validate_addr = eth_validate_addr,
909 .ndo_select_queue = tun_select_queue,
910 #ifdef CONFIG_NET_POLL_CONTROLLER
911 .ndo_poll_controller = tun_poll_controller,
915 static void tun_flow_init(struct tun_struct *tun)
919 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
920 INIT_HLIST_HEAD(&tun->flows[i]);
922 tun->ageing_time = TUN_FLOW_EXPIRE;
923 setup_timer(&tun->flow_gc_timer, tun_flow_cleanup, (unsigned long)tun);
924 mod_timer(&tun->flow_gc_timer,
925 round_jiffies_up(jiffies + tun->ageing_time));
928 static void tun_flow_uninit(struct tun_struct *tun)
930 del_timer_sync(&tun->flow_gc_timer);
934 /* Initialize net device. */
935 static void tun_net_init(struct net_device *dev)
937 struct tun_struct *tun = netdev_priv(dev);
939 switch (tun->flags & TUN_TYPE_MASK) {
941 dev->netdev_ops = &tun_netdev_ops;
943 /* Point-to-Point TUN Device */
944 dev->hard_header_len = 0;
948 /* Zero header length */
949 dev->type = ARPHRD_NONE;
950 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
951 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
955 dev->netdev_ops = &tap_netdev_ops;
956 /* Ethernet TAP Device */
958 dev->priv_flags &= ~IFF_TX_SKB_SHARING;
959 dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
961 eth_hw_addr_random(dev);
963 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
968 /* Character device part */
971 static unsigned int tun_chr_poll(struct file *file, poll_table *wait)
973 struct tun_file *tfile = file->private_data;
974 struct tun_struct *tun = __tun_get(tfile);
976 unsigned int mask = 0;
981 sk = tfile->socket.sk;
983 tun_debug(KERN_INFO, tun, "tun_chr_poll\n");
985 poll_wait(file, sk_sleep(sk), wait);
987 if (!skb_queue_empty(&sk->sk_receive_queue))
988 mask |= POLLIN | POLLRDNORM;
990 if (sock_writeable(sk) ||
991 (!test_and_set_bit(SOCK_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
993 mask |= POLLOUT | POLLWRNORM;
995 if (tun->dev->reg_state != NETREG_REGISTERED)
1002 /* prepad is the amount to reserve at front. len is length after that.
1003 * linear is a hint as to how much to copy (usually headers). */
1004 static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
1005 size_t prepad, size_t len,
1006 size_t linear, int noblock)
1008 struct sock *sk = tfile->socket.sk;
1009 struct sk_buff *skb;
1012 /* Under a page? Don't bother with paged skb. */
1013 if (prepad + len < PAGE_SIZE || !linear)
1016 skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
1019 return ERR_PTR(err);
1021 skb_reserve(skb, prepad);
1022 skb_put(skb, linear);
1023 skb->data_len = len - linear;
1024 skb->len += len - linear;
1029 /* Get packet from user space buffer */
1030 static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
1031 void *msg_control, struct iov_iter *from,
1034 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1035 struct sk_buff *skb;
1036 size_t total_len = iov_iter_count(from);
1037 size_t len = total_len, align = NET_SKB_PAD, linear;
1038 struct virtio_net_hdr gso = { 0 };
1041 bool zerocopy = false;
1046 if (!(tun->flags & IFF_NO_PI)) {
1047 if (len < sizeof(pi))
1051 n = copy_from_iter(&pi, sizeof(pi), from);
1052 if (n != sizeof(pi))
1056 if (tun->flags & IFF_VNET_HDR) {
1057 if (len < tun->vnet_hdr_sz)
1059 len -= tun->vnet_hdr_sz;
1061 n = copy_from_iter(&gso, sizeof(gso), from);
1062 if (n != sizeof(gso))
1065 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
1066 tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1067 gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
1069 if (tun16_to_cpu(tun, gso.hdr_len) > len)
1071 iov_iter_advance(from, tun->vnet_hdr_sz - sizeof(gso));
1074 if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
1075 align += NET_IP_ALIGN;
1076 if (unlikely(len < ETH_HLEN ||
1077 (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
1081 good_linear = SKB_MAX_HEAD(align);
1084 struct iov_iter i = *from;
1086 /* There are 256 bytes to be copied in skb, so there is
1087 * enough room for skb expand head in case it is used.
1088 * The rest of the buffer is mapped from userspace.
1090 copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
1091 if (copylen > good_linear)
1092 copylen = good_linear;
1094 iov_iter_advance(&i, copylen);
1095 if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
1101 if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1102 linear = good_linear;
1104 linear = tun16_to_cpu(tun, gso.hdr_len);
1107 skb = tun_alloc_skb(tfile, align, copylen, linear, noblock);
1109 if (PTR_ERR(skb) != -EAGAIN)
1110 tun->dev->stats.rx_dropped++;
1111 return PTR_ERR(skb);
1115 err = zerocopy_sg_from_iter(skb, from);
1117 err = skb_copy_datagram_from_iter(skb, 0, from, len);
1118 if (!err && msg_control) {
1119 struct ubuf_info *uarg = msg_control;
1120 uarg->callback(uarg, false);
1125 tun->dev->stats.rx_dropped++;
1130 if (gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) {
1131 if (!skb_partial_csum_set(skb, tun16_to_cpu(tun, gso.csum_start),
1132 tun16_to_cpu(tun, gso.csum_offset))) {
1133 tun->dev->stats.rx_frame_errors++;
1139 switch (tun->flags & TUN_TYPE_MASK) {
1141 if (tun->flags & IFF_NO_PI) {
1142 switch (skb->data[0] & 0xf0) {
1144 pi.proto = htons(ETH_P_IP);
1147 pi.proto = htons(ETH_P_IPV6);
1150 tun->dev->stats.rx_dropped++;
1156 skb_reset_mac_header(skb);
1157 skb->protocol = pi.proto;
1158 skb->dev = tun->dev;
1161 skb->protocol = eth_type_trans(skb, tun->dev);
1165 if (gso.gso_type != VIRTIO_NET_HDR_GSO_NONE) {
1167 switch (gso.gso_type & ~VIRTIO_NET_HDR_GSO_ECN) {
1168 case VIRTIO_NET_HDR_GSO_TCPV4:
1169 skb_shinfo(skb)->gso_type = SKB_GSO_TCPV4;
1171 case VIRTIO_NET_HDR_GSO_TCPV6:
1172 skb_shinfo(skb)->gso_type = SKB_GSO_TCPV6;
1174 case VIRTIO_NET_HDR_GSO_UDP:
1175 skb_shinfo(skb)->gso_type = SKB_GSO_UDP;
1178 tun->dev->stats.rx_frame_errors++;
1183 if (gso.gso_type & VIRTIO_NET_HDR_GSO_ECN)
1184 skb_shinfo(skb)->gso_type |= SKB_GSO_TCP_ECN;
1186 skb_shinfo(skb)->gso_size = tun16_to_cpu(tun, gso.gso_size);
1187 if (skb_shinfo(skb)->gso_size == 0) {
1188 tun->dev->stats.rx_frame_errors++;
1193 /* Header must be checked, and gso_segs computed. */
1194 skb_shinfo(skb)->gso_type |= SKB_GSO_DODGY;
1195 skb_shinfo(skb)->gso_segs = 0;
1198 /* copy skb_ubuf_info for callback when skb has no error */
1200 skb_shinfo(skb)->destructor_arg = msg_control;
1201 skb_shinfo(skb)->tx_flags |= SKBTX_DEV_ZEROCOPY;
1202 skb_shinfo(skb)->tx_flags |= SKBTX_SHARED_FRAG;
1205 skb_reset_network_header(skb);
1206 skb_probe_transport_header(skb, 0);
1208 rxhash = skb_get_hash(skb);
1211 tun->dev->stats.rx_packets++;
1212 tun->dev->stats.rx_bytes += len;
1214 tun_flow_update(tun, rxhash, tfile);
1218 static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
1220 struct file *file = iocb->ki_filp;
1221 struct tun_struct *tun = tun_get(file);
1222 struct tun_file *tfile = file->private_data;
1228 result = tun_get_user(tun, tfile, NULL, from, file->f_flags & O_NONBLOCK);
1234 /* Put packet to the user space buffer */
1235 static ssize_t tun_put_user(struct tun_struct *tun,
1236 struct tun_file *tfile,
1237 struct sk_buff *skb,
1238 struct iov_iter *iter)
1240 struct tun_pi pi = { 0, skb->protocol };
1242 int vlan_offset = 0;
1244 int vnet_hdr_sz = 0;
1246 if (skb_vlan_tag_present(skb))
1247 vlan_hlen = VLAN_HLEN;
1249 if (tun->flags & IFF_VNET_HDR)
1250 vnet_hdr_sz = tun->vnet_hdr_sz;
1252 total = skb->len + vlan_hlen + vnet_hdr_sz;
1254 if (!(tun->flags & IFF_NO_PI)) {
1255 if (iov_iter_count(iter) < sizeof(pi))
1258 total += sizeof(pi);
1259 if (iov_iter_count(iter) < total) {
1260 /* Packet will be striped */
1261 pi.flags |= TUN_PKT_STRIP;
1264 if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
1269 struct virtio_net_hdr gso = { 0 }; /* no info leak */
1270 if (iov_iter_count(iter) < vnet_hdr_sz)
1273 if (skb_is_gso(skb)) {
1274 struct skb_shared_info *sinfo = skb_shinfo(skb);
1276 /* This is a hint as to how much should be linear. */
1277 gso.hdr_len = cpu_to_tun16(tun, skb_headlen(skb));
1278 gso.gso_size = cpu_to_tun16(tun, sinfo->gso_size);
1279 if (sinfo->gso_type & SKB_GSO_TCPV4)
1280 gso.gso_type = VIRTIO_NET_HDR_GSO_TCPV4;
1281 else if (sinfo->gso_type & SKB_GSO_TCPV6)
1282 gso.gso_type = VIRTIO_NET_HDR_GSO_TCPV6;
1283 else if (sinfo->gso_type & SKB_GSO_UDP)
1284 gso.gso_type = VIRTIO_NET_HDR_GSO_UDP;
1286 pr_err("unexpected GSO type: "
1287 "0x%x, gso_size %d, hdr_len %d\n",
1288 sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
1289 tun16_to_cpu(tun, gso.hdr_len));
1290 print_hex_dump(KERN_ERR, "tun: ",
1293 min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
1297 if (sinfo->gso_type & SKB_GSO_TCP_ECN)
1298 gso.gso_type |= VIRTIO_NET_HDR_GSO_ECN;
1300 gso.gso_type = VIRTIO_NET_HDR_GSO_NONE;
1302 if (skb->ip_summed == CHECKSUM_PARTIAL) {
1303 gso.flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
1304 gso.csum_start = cpu_to_tun16(tun, skb_checksum_start_offset(skb) +
1306 gso.csum_offset = cpu_to_tun16(tun, skb->csum_offset);
1307 } else if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
1308 gso.flags = VIRTIO_NET_HDR_F_DATA_VALID;
1309 } /* else everything is zero */
1311 if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
1314 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
1320 __be16 h_vlan_proto;
1324 veth.h_vlan_proto = skb->vlan_proto;
1325 veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
1327 vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
1329 ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
1330 if (ret || !iov_iter_count(iter))
1333 ret = copy_to_iter(&veth, sizeof(veth), iter);
1334 if (ret != sizeof(veth) || !iov_iter_count(iter))
1338 skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
1341 tun->dev->stats.tx_packets++;
1342 tun->dev->stats.tx_bytes += skb->len + vlan_hlen;
1347 static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
1348 struct iov_iter *to,
1351 struct sk_buff *skb;
1353 int peeked, err, off = 0;
1355 tun_debug(KERN_INFO, tun, "tun_do_read\n");
1357 if (!iov_iter_count(to))
1360 if (tun->dev->reg_state != NETREG_REGISTERED)
1363 /* Read frames from queue */
1364 skb = __skb_recv_datagram(tfile->socket.sk, noblock ? MSG_DONTWAIT : 0,
1365 &peeked, &off, &err);
1369 ret = tun_put_user(tun, tfile, skb, to);
1370 if (unlikely(ret < 0))
1378 static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
1380 struct file *file = iocb->ki_filp;
1381 struct tun_file *tfile = file->private_data;
1382 struct tun_struct *tun = __tun_get(tfile);
1383 ssize_t len = iov_iter_count(to), ret;
1387 ret = tun_do_read(tun, tfile, to, file->f_flags & O_NONBLOCK);
1388 ret = min_t(ssize_t, ret, len);
1395 static void tun_free_netdev(struct net_device *dev)
1397 struct tun_struct *tun = netdev_priv(dev);
1399 BUG_ON(!(list_empty(&tun->disabled)));
1400 tun_flow_uninit(tun);
1401 security_tun_dev_free_security(tun->security);
1405 static void tun_setup(struct net_device *dev)
1407 struct tun_struct *tun = netdev_priv(dev);
1409 tun->owner = INVALID_UID;
1410 tun->group = INVALID_GID;
1412 dev->ethtool_ops = &tun_ethtool_ops;
1413 dev->destructor = tun_free_netdev;
1416 /* Trivial set of netlink ops to allow deleting tun or tap
1417 * device with netlink.
1419 static int tun_validate(struct nlattr *tb[], struct nlattr *data[])
1424 static struct rtnl_link_ops tun_link_ops __read_mostly = {
1426 .priv_size = sizeof(struct tun_struct),
1428 .validate = tun_validate,
1431 static void tun_sock_write_space(struct sock *sk)
1433 struct tun_file *tfile;
1434 wait_queue_head_t *wqueue;
1436 if (!sock_writeable(sk))
1439 if (!test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sk->sk_socket->flags))
1442 wqueue = sk_sleep(sk);
1443 if (wqueue && waitqueue_active(wqueue))
1444 wake_up_interruptible_sync_poll(wqueue, POLLOUT |
1445 POLLWRNORM | POLLWRBAND);
1447 tfile = container_of(sk, struct tun_file, sk);
1448 kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
1451 static int tun_sendmsg(struct kiocb *iocb, struct socket *sock,
1452 struct msghdr *m, size_t total_len)
1455 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
1456 struct tun_struct *tun = __tun_get(tfile);
1461 ret = tun_get_user(tun, tfile, m->msg_control, &m->msg_iter,
1462 m->msg_flags & MSG_DONTWAIT);
1467 static int tun_recvmsg(struct kiocb *iocb, struct socket *sock,
1468 struct msghdr *m, size_t total_len,
1471 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
1472 struct tun_struct *tun = __tun_get(tfile);
1478 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
1482 if (flags & MSG_ERRQUEUE) {
1483 ret = sock_recv_errqueue(sock->sk, m, total_len,
1484 SOL_PACKET, TUN_TX_TIMESTAMP);
1487 ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT);
1488 if (ret > (ssize_t)total_len) {
1489 m->msg_flags |= MSG_TRUNC;
1490 ret = flags & MSG_TRUNC ? ret : total_len;
1497 static int tun_release(struct socket *sock)
1504 /* Ops structure to mimic raw sockets with tun */
1505 static const struct proto_ops tun_socket_ops = {
1506 .sendmsg = tun_sendmsg,
1507 .recvmsg = tun_recvmsg,
1508 .release = tun_release,
1511 static struct proto tun_proto = {
1513 .owner = THIS_MODULE,
1514 .obj_size = sizeof(struct tun_file),
1517 static int tun_flags(struct tun_struct *tun)
1519 return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
1522 static ssize_t tun_show_flags(struct device *dev, struct device_attribute *attr,
1525 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
1526 return sprintf(buf, "0x%x\n", tun_flags(tun));
1529 static ssize_t tun_show_owner(struct device *dev, struct device_attribute *attr,
1532 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
1533 return uid_valid(tun->owner)?
1534 sprintf(buf, "%u\n",
1535 from_kuid_munged(current_user_ns(), tun->owner)):
1536 sprintf(buf, "-1\n");
1539 static ssize_t tun_show_group(struct device *dev, struct device_attribute *attr,
1542 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
1543 return gid_valid(tun->group) ?
1544 sprintf(buf, "%u\n",
1545 from_kgid_munged(current_user_ns(), tun->group)):
1546 sprintf(buf, "-1\n");
1549 static DEVICE_ATTR(tun_flags, 0444, tun_show_flags, NULL);
1550 static DEVICE_ATTR(owner, 0444, tun_show_owner, NULL);
1551 static DEVICE_ATTR(group, 0444, tun_show_group, NULL);
1553 static struct attribute *tun_dev_attrs[] = {
1554 &dev_attr_tun_flags.attr,
1555 &dev_attr_owner.attr,
1556 &dev_attr_group.attr,
1560 static const struct attribute_group tun_attr_group = {
1561 .attrs = tun_dev_attrs
1564 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
1566 struct tun_struct *tun;
1567 struct tun_file *tfile = file->private_data;
1568 struct net_device *dev;
1571 if (tfile->detached)
1574 dev = __dev_get_by_name(net, ifr->ifr_name);
1576 if (ifr->ifr_flags & IFF_TUN_EXCL)
1578 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
1579 tun = netdev_priv(dev);
1580 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
1581 tun = netdev_priv(dev);
1585 if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
1586 !!(tun->flags & IFF_MULTI_QUEUE))
1589 if (tun_not_capable(tun))
1591 err = security_tun_dev_open(tun->security);
1595 err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER);
1599 if (tun->flags & IFF_MULTI_QUEUE &&
1600 (tun->numqueues + tun->numdisabled > 1)) {
1601 /* One or more queue has already been attached, no need
1602 * to initialize the device again.
1609 unsigned long flags = 0;
1610 int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
1613 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
1615 err = security_tun_dev_create();
1620 if (ifr->ifr_flags & IFF_TUN) {
1624 } else if (ifr->ifr_flags & IFF_TAP) {
1632 name = ifr->ifr_name;
1634 dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
1635 NET_NAME_UNKNOWN, tun_setup, queues,
1641 dev_net_set(dev, net);
1642 dev->rtnl_link_ops = &tun_link_ops;
1643 dev->ifindex = tfile->ifindex;
1644 dev->sysfs_groups[0] = &tun_attr_group;
1646 tun = netdev_priv(dev);
1649 tun->txflt.count = 0;
1650 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
1652 tun->filter_attached = false;
1653 tun->sndbuf = tfile->socket.sk->sk_sndbuf;
1655 spin_lock_init(&tun->lock);
1657 err = security_tun_dev_alloc_security(&tun->security);
1664 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
1665 TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
1666 NETIF_F_HW_VLAN_STAG_TX;
1667 dev->features = dev->hw_features;
1668 dev->vlan_features = dev->features &
1669 ~(NETIF_F_HW_VLAN_CTAG_TX |
1670 NETIF_F_HW_VLAN_STAG_TX);
1672 INIT_LIST_HEAD(&tun->disabled);
1673 err = tun_attach(tun, file, false);
1677 err = register_netdevice(tun->dev);
1682 netif_carrier_on(tun->dev);
1684 tun_debug(KERN_INFO, tun, "tun_set_iff\n");
1686 tun->flags = (tun->flags & ~TUN_FEATURES) |
1687 (ifr->ifr_flags & TUN_FEATURES);
1689 /* Make sure persistent devices do not get stuck in
1692 if (netif_running(tun->dev))
1693 netif_tx_wake_all_queues(tun->dev);
1695 strcpy(ifr->ifr_name, tun->dev->name);
1699 tun_detach_all(dev);
1701 tun_flow_uninit(tun);
1702 security_tun_dev_free_security(tun->security);
1708 static void tun_get_iff(struct net *net, struct tun_struct *tun,
1711 tun_debug(KERN_INFO, tun, "tun_get_iff\n");
1713 strcpy(ifr->ifr_name, tun->dev->name);
1715 ifr->ifr_flags = tun_flags(tun);
1719 /* This is like a cut-down ethtool ops, except done via tun fd so no
1720 * privs required. */
1721 static int set_offload(struct tun_struct *tun, unsigned long arg)
1723 netdev_features_t features = 0;
1725 if (arg & TUN_F_CSUM) {
1726 features |= NETIF_F_HW_CSUM;
1729 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
1730 if (arg & TUN_F_TSO_ECN) {
1731 features |= NETIF_F_TSO_ECN;
1732 arg &= ~TUN_F_TSO_ECN;
1734 if (arg & TUN_F_TSO4)
1735 features |= NETIF_F_TSO;
1736 if (arg & TUN_F_TSO6)
1737 features |= NETIF_F_TSO6;
1738 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
1741 if (arg & TUN_F_UFO) {
1742 features |= NETIF_F_UFO;
1747 /* This gives the user a way to test for new features in future by
1748 * trying to set them. */
1752 tun->set_features = features;
1753 netdev_update_features(tun->dev);
1758 static void tun_detach_filter(struct tun_struct *tun, int n)
1761 struct tun_file *tfile;
1763 for (i = 0; i < n; i++) {
1764 tfile = rtnl_dereference(tun->tfiles[i]);
1765 sk_detach_filter(tfile->socket.sk);
1768 tun->filter_attached = false;
1771 static int tun_attach_filter(struct tun_struct *tun)
1774 struct tun_file *tfile;
1776 for (i = 0; i < tun->numqueues; i++) {
1777 tfile = rtnl_dereference(tun->tfiles[i]);
1778 ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
1780 tun_detach_filter(tun, i);
1785 tun->filter_attached = true;
1789 static void tun_set_sndbuf(struct tun_struct *tun)
1791 struct tun_file *tfile;
1794 for (i = 0; i < tun->numqueues; i++) {
1795 tfile = rtnl_dereference(tun->tfiles[i]);
1796 tfile->socket.sk->sk_sndbuf = tun->sndbuf;
1800 static int tun_set_queue(struct file *file, struct ifreq *ifr)
1802 struct tun_file *tfile = file->private_data;
1803 struct tun_struct *tun;
1808 if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
1809 tun = tfile->detached;
1814 ret = security_tun_dev_attach_queue(tun->security);
1817 ret = tun_attach(tun, file, false);
1818 } else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
1819 tun = rtnl_dereference(tfile->tun);
1820 if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
1823 __tun_detach(tfile, false);
1832 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
1833 unsigned long arg, int ifreq_len)
1835 struct tun_file *tfile = file->private_data;
1836 struct tun_struct *tun;
1837 void __user* argp = (void __user*)arg;
1843 unsigned int ifindex;
1847 if (cmd == TUNSETIFF || cmd == TUNSETQUEUE || _IOC_TYPE(cmd) == 0x89) {
1848 if (copy_from_user(&ifr, argp, ifreq_len))
1851 memset(&ifr, 0, sizeof(ifr));
1853 if (cmd == TUNGETFEATURES) {
1854 /* Currently this just means: "what IFF flags are valid?".
1855 * This is needed because we never checked for invalid flags on
1858 return put_user(IFF_TUN | IFF_TAP | TUN_FEATURES,
1859 (unsigned int __user*)argp);
1860 } else if (cmd == TUNSETQUEUE)
1861 return tun_set_queue(file, &ifr);
1866 tun = __tun_get(tfile);
1867 if (cmd == TUNSETIFF && !tun) {
1868 ifr.ifr_name[IFNAMSIZ-1] = '\0';
1870 ret = tun_set_iff(tfile->net, file, &ifr);
1875 if (copy_to_user(argp, &ifr, ifreq_len))
1879 if (cmd == TUNSETIFINDEX) {
1885 if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
1889 tfile->ifindex = ifindex;
1897 tun_debug(KERN_INFO, tun, "tun_chr_ioctl cmd %u\n", cmd);
1902 tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
1904 if (tfile->detached)
1905 ifr.ifr_flags |= IFF_DETACH_QUEUE;
1906 if (!tfile->socket.sk->sk_filter)
1907 ifr.ifr_flags |= IFF_NOFILTER;
1909 if (copy_to_user(argp, &ifr, ifreq_len))
1914 /* Disable/Enable checksum */
1916 /* [unimplemented] */
1917 tun_debug(KERN_INFO, tun, "ignored: set checksum %s\n",
1918 arg ? "disabled" : "enabled");
1922 /* Disable/Enable persist mode. Keep an extra reference to the
1923 * module to prevent the module being unprobed.
1925 if (arg && !(tun->flags & IFF_PERSIST)) {
1926 tun->flags |= IFF_PERSIST;
1927 __module_get(THIS_MODULE);
1929 if (!arg && (tun->flags & IFF_PERSIST)) {
1930 tun->flags &= ~IFF_PERSIST;
1931 module_put(THIS_MODULE);
1934 tun_debug(KERN_INFO, tun, "persist %s\n",
1935 arg ? "enabled" : "disabled");
1939 /* Set owner of the device */
1940 owner = make_kuid(current_user_ns(), arg);
1941 if (!uid_valid(owner)) {
1946 tun_debug(KERN_INFO, tun, "owner set to %u\n",
1947 from_kuid(&init_user_ns, tun->owner));
1951 /* Set group of the device */
1952 group = make_kgid(current_user_ns(), arg);
1953 if (!gid_valid(group)) {
1958 tun_debug(KERN_INFO, tun, "group set to %u\n",
1959 from_kgid(&init_user_ns, tun->group));
1963 /* Only allow setting the type when the interface is down */
1964 if (tun->dev->flags & IFF_UP) {
1965 tun_debug(KERN_INFO, tun,
1966 "Linktype set failed because interface is up\n");
1969 tun->dev->type = (int) arg;
1970 tun_debug(KERN_INFO, tun, "linktype set to %d\n",
1982 ret = set_offload(tun, arg);
1985 case TUNSETTXFILTER:
1986 /* Can be set only for TAPs */
1988 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
1990 ret = update_filter(&tun->txflt, (void __user *)arg);
1994 /* Get hw address */
1995 memcpy(ifr.ifr_hwaddr.sa_data, tun->dev->dev_addr, ETH_ALEN);
1996 ifr.ifr_hwaddr.sa_family = tun->dev->type;
1997 if (copy_to_user(argp, &ifr, ifreq_len))
2002 /* Set hw address */
2003 tun_debug(KERN_DEBUG, tun, "set hw address: %pM\n",
2004 ifr.ifr_hwaddr.sa_data);
2006 ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr);
2010 sndbuf = tfile->socket.sk->sk_sndbuf;
2011 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
2016 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
2021 tun->sndbuf = sndbuf;
2022 tun_set_sndbuf(tun);
2025 case TUNGETVNETHDRSZ:
2026 vnet_hdr_sz = tun->vnet_hdr_sz;
2027 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
2031 case TUNSETVNETHDRSZ:
2032 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
2036 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
2041 tun->vnet_hdr_sz = vnet_hdr_sz;
2045 le = !!(tun->flags & TUN_VNET_LE);
2046 if (put_user(le, (int __user *)argp))
2051 if (get_user(le, (int __user *)argp)) {
2056 tun->flags |= TUN_VNET_LE;
2058 tun->flags &= ~TUN_VNET_LE;
2061 case TUNATTACHFILTER:
2062 /* Can be set only for TAPs */
2064 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
2067 if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
2070 ret = tun_attach_filter(tun);
2073 case TUNDETACHFILTER:
2074 /* Can be set only for TAPs */
2076 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
2079 tun_detach_filter(tun, tun->numqueues);
2084 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
2087 if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
2104 static long tun_chr_ioctl(struct file *file,
2105 unsigned int cmd, unsigned long arg)
2107 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
2110 #ifdef CONFIG_COMPAT
2111 static long tun_chr_compat_ioctl(struct file *file,
2112 unsigned int cmd, unsigned long arg)
2117 case TUNSETTXFILTER:
2122 arg = (unsigned long)compat_ptr(arg);
2125 arg = (compat_ulong_t)arg;
2130 * compat_ifreq is shorter than ifreq, so we must not access beyond
2131 * the end of that structure. All fields that are used in this
2132 * driver are compatible though, we don't need to convert the
2135 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
2137 #endif /* CONFIG_COMPAT */
2139 static int tun_chr_fasync(int fd, struct file *file, int on)
2141 struct tun_file *tfile = file->private_data;
2144 if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
2148 __f_setown(file, task_pid(current), PIDTYPE_PID, 0);
2149 tfile->flags |= TUN_FASYNC;
2151 tfile->flags &= ~TUN_FASYNC;
2157 static int tun_chr_open(struct inode *inode, struct file * file)
2159 struct tun_file *tfile;
2161 DBG1(KERN_INFO, "tunX: tun_chr_open\n");
2163 tfile = (struct tun_file *)sk_alloc(&init_net, AF_UNSPEC, GFP_KERNEL,
2167 RCU_INIT_POINTER(tfile->tun, NULL);
2168 tfile->net = get_net(current->nsproxy->net_ns);
2172 init_waitqueue_head(&tfile->wq.wait);
2173 RCU_INIT_POINTER(tfile->socket.wq, &tfile->wq);
2175 tfile->socket.file = file;
2176 tfile->socket.ops = &tun_socket_ops;
2178 sock_init_data(&tfile->socket, &tfile->sk);
2179 sk_change_net(&tfile->sk, tfile->net);
2181 tfile->sk.sk_write_space = tun_sock_write_space;
2182 tfile->sk.sk_sndbuf = INT_MAX;
2184 file->private_data = tfile;
2185 set_bit(SOCK_EXTERNALLY_ALLOCATED, &tfile->socket.flags);
2186 INIT_LIST_HEAD(&tfile->next);
2188 sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
2193 static int tun_chr_close(struct inode *inode, struct file *file)
2195 struct tun_file *tfile = file->private_data;
2196 struct net *net = tfile->net;
2198 tun_detach(tfile, true);
2204 #ifdef CONFIG_PROC_FS
2205 static void tun_chr_show_fdinfo(struct seq_file *m, struct file *f)
2207 struct tun_struct *tun;
2210 memset(&ifr, 0, sizeof(ifr));
2215 tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
2221 seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
2225 static const struct file_operations tun_fops = {
2226 .owner = THIS_MODULE,
2227 .llseek = no_llseek,
2228 .read = new_sync_read,
2229 .write = new_sync_write,
2230 .read_iter = tun_chr_read_iter,
2231 .write_iter = tun_chr_write_iter,
2232 .poll = tun_chr_poll,
2233 .unlocked_ioctl = tun_chr_ioctl,
2234 #ifdef CONFIG_COMPAT
2235 .compat_ioctl = tun_chr_compat_ioctl,
2237 .open = tun_chr_open,
2238 .release = tun_chr_close,
2239 .fasync = tun_chr_fasync,
2240 #ifdef CONFIG_PROC_FS
2241 .show_fdinfo = tun_chr_show_fdinfo,
2245 static struct miscdevice tun_miscdev = {
2248 .nodename = "net/tun",
2252 /* ethtool interface */
2254 static int tun_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
2257 cmd->advertising = 0;
2258 ethtool_cmd_speed_set(cmd, SPEED_10);
2259 cmd->duplex = DUPLEX_FULL;
2260 cmd->port = PORT_TP;
2261 cmd->phy_address = 0;
2262 cmd->transceiver = XCVR_INTERNAL;
2263 cmd->autoneg = AUTONEG_DISABLE;
2269 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
2271 struct tun_struct *tun = netdev_priv(dev);
2273 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
2274 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
2276 switch (tun->flags & TUN_TYPE_MASK) {
2278 strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
2281 strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
2286 static u32 tun_get_msglevel(struct net_device *dev)
2289 struct tun_struct *tun = netdev_priv(dev);
2296 static void tun_set_msglevel(struct net_device *dev, u32 value)
2299 struct tun_struct *tun = netdev_priv(dev);
2304 static const struct ethtool_ops tun_ethtool_ops = {
2305 .get_settings = tun_get_settings,
2306 .get_drvinfo = tun_get_drvinfo,
2307 .get_msglevel = tun_get_msglevel,
2308 .set_msglevel = tun_set_msglevel,
2309 .get_link = ethtool_op_get_link,
2310 .get_ts_info = ethtool_op_get_ts_info,
2314 static int __init tun_init(void)
2318 pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
2319 pr_info("%s\n", DRV_COPYRIGHT);
2321 ret = rtnl_link_register(&tun_link_ops);
2323 pr_err("Can't register link_ops\n");
2327 ret = misc_register(&tun_miscdev);
2329 pr_err("Can't register misc device %d\n", TUN_MINOR);
2334 rtnl_link_unregister(&tun_link_ops);
2339 static void tun_cleanup(void)
2341 misc_deregister(&tun_miscdev);
2342 rtnl_link_unregister(&tun_link_ops);
2345 /* Get an underlying socket object from tun file. Returns error unless file is
2346 * attached to a device. The returned object works like a packet socket, it
2347 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
2348 * holding a reference to the file for as long as the socket is in use. */
2349 struct socket *tun_get_socket(struct file *file)
2351 struct tun_file *tfile;
2352 if (file->f_op != &tun_fops)
2353 return ERR_PTR(-EINVAL);
2354 tfile = file->private_data;
2356 return ERR_PTR(-EBADFD);
2357 return &tfile->socket;
2359 EXPORT_SYMBOL_GPL(tun_get_socket);
2361 module_init(tun_init);
2362 module_exit(tun_cleanup);
2363 MODULE_DESCRIPTION(DRV_DESCRIPTION);
2364 MODULE_AUTHOR(DRV_COPYRIGHT);
2365 MODULE_LICENSE("GPL");
2366 MODULE_ALIAS_MISCDEV(TUN_MINOR);
2367 MODULE_ALIAS("devname:net/tun");