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/sched/signal.h>
48 #include <linux/major.h>
49 #include <linux/slab.h>
50 #include <linux/poll.h>
51 #include <linux/fcntl.h>
52 #include <linux/init.h>
53 #include <linux/skbuff.h>
54 #include <linux/netdevice.h>
55 #include <linux/etherdevice.h>
56 #include <linux/miscdevice.h>
57 #include <linux/ethtool.h>
58 #include <linux/rtnetlink.h>
59 #include <linux/compat.h>
61 #include <linux/if_arp.h>
62 #include <linux/if_ether.h>
63 #include <linux/if_tun.h>
64 #include <linux/if_vlan.h>
65 #include <linux/crc32.h>
66 #include <linux/nsproxy.h>
67 #include <linux/virtio_net.h>
68 #include <linux/rcupdate.h>
69 #include <net/net_namespace.h>
70 #include <net/netns/generic.h>
71 #include <net/rtnetlink.h>
73 #include <linux/seq_file.h>
74 #include <linux/uio.h>
75 #include <linux/skb_array.h>
76 #include <linux/bpf.h>
77 #include <linux/bpf_trace.h>
78 #include <linux/mutex.h>
80 #include <linux/uaccess.h>
82 /* Uncomment to enable debugging */
83 /* #define TUN_DEBUG 1 */
88 #define tun_debug(level, tun, fmt, args...) \
91 netdev_printk(level, tun->dev, fmt, ##args); \
93 #define DBG1(level, fmt, args...) \
96 printk(level fmt, ##args); \
99 #define tun_debug(level, tun, fmt, args...) \
102 netdev_printk(level, tun->dev, fmt, ##args); \
104 #define DBG1(level, fmt, args...) \
107 printk(level fmt, ##args); \
111 #define TUN_HEADROOM 256
112 #define TUN_RX_PAD (NET_IP_ALIGN + NET_SKB_PAD)
114 /* TUN device flags */
116 /* IFF_ATTACH_QUEUE is never stored in device flags,
117 * overload it to mean fasync when stored there.
119 #define TUN_FASYNC IFF_ATTACH_QUEUE
120 /* High bits in flags field are unused. */
121 #define TUN_VNET_LE 0x80000000
122 #define TUN_VNET_BE 0x40000000
124 #define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
125 IFF_MULTI_QUEUE | IFF_NAPI | IFF_NAPI_FRAGS)
127 #define GOODCOPY_LEN 128
129 #define FLT_EXACT_COUNT 8
131 unsigned int count; /* Number of addrs. Zero means disabled */
132 u32 mask[2]; /* Mask of the hashed addrs */
133 unsigned char addr[FLT_EXACT_COUNT][ETH_ALEN];
136 /* MAX_TAP_QUEUES 256 is chosen to allow rx/tx queues to be equal
137 * to max number of VCPUs in guest. */
138 #define MAX_TAP_QUEUES 256
139 #define MAX_TAP_FLOWS 4096
141 #define TUN_FLOW_EXPIRE (3 * HZ)
143 struct tun_pcpu_stats {
148 struct u64_stats_sync syncp;
154 /* A tun_file connects an open character device to a tuntap netdevice. It
155 * also contains all socket related structures (except sock_fprog and tap_filter)
156 * to serve as one transmit queue for tuntap device. The sock_fprog and
157 * tap_filter were kept in tun_struct since they were used for filtering for the
158 * netdevice not for a specific queue (at least I didn't see the requirement for
162 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
163 * other can only be read while rcu_read_lock or rtnl_lock is held.
167 struct socket socket;
169 struct tun_struct __rcu *tun;
170 struct fasync_struct *fasync;
171 /* only used for fasnyc */
175 unsigned int ifindex;
177 struct napi_struct napi;
179 struct mutex napi_mutex; /* Protects access to the above napi */
180 struct list_head next;
181 struct tun_struct *detached;
182 struct ptr_ring tx_ring;
183 struct xdp_rxq_info xdp_rxq;
186 struct tun_flow_entry {
187 struct hlist_node hash_link;
189 struct tun_struct *tun;
194 unsigned long updated;
197 #define TUN_NUM_FLOW_ENTRIES 1024
201 struct bpf_prog *prog;
204 /* Since the socket were moved to tun_file, to preserve the behavior of persist
205 * device, socket filter, sndbuf and vnet header size were restore when the
206 * file were attached to a persist device.
209 struct tun_file __rcu *tfiles[MAX_TAP_QUEUES];
210 unsigned int numqueues;
215 struct net_device *dev;
216 netdev_features_t set_features;
217 #define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
223 struct tap_filter txflt;
224 struct sock_fprog fprog;
225 /* protected by rtnl lock */
226 bool filter_attached;
231 struct hlist_head flows[TUN_NUM_FLOW_ENTRIES];
232 struct timer_list flow_gc_timer;
233 unsigned long ageing_time;
234 unsigned int numdisabled;
235 struct list_head disabled;
239 struct tun_pcpu_stats __percpu *pcpu_stats;
240 struct bpf_prog __rcu *xdp_prog;
241 struct tun_prog __rcu *steering_prog;
242 struct tun_prog __rcu *filter_prog;
250 bool tun_is_xdp_buff(void *ptr)
252 return (unsigned long)ptr & TUN_XDP_FLAG;
254 EXPORT_SYMBOL(tun_is_xdp_buff);
256 void *tun_xdp_to_ptr(void *ptr)
258 return (void *)((unsigned long)ptr | TUN_XDP_FLAG);
260 EXPORT_SYMBOL(tun_xdp_to_ptr);
262 void *tun_ptr_to_xdp(void *ptr)
264 return (void *)((unsigned long)ptr & ~TUN_XDP_FLAG);
266 EXPORT_SYMBOL(tun_ptr_to_xdp);
268 static int tun_napi_receive(struct napi_struct *napi, int budget)
270 struct tun_file *tfile = container_of(napi, struct tun_file, napi);
271 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
272 struct sk_buff_head process_queue;
276 __skb_queue_head_init(&process_queue);
278 spin_lock(&queue->lock);
279 skb_queue_splice_tail_init(queue, &process_queue);
280 spin_unlock(&queue->lock);
282 while (received < budget && (skb = __skb_dequeue(&process_queue))) {
283 napi_gro_receive(napi, skb);
287 if (!skb_queue_empty(&process_queue)) {
288 spin_lock(&queue->lock);
289 skb_queue_splice(&process_queue, queue);
290 spin_unlock(&queue->lock);
296 static int tun_napi_poll(struct napi_struct *napi, int budget)
298 unsigned int received;
300 received = tun_napi_receive(napi, budget);
302 if (received < budget)
303 napi_complete_done(napi, received);
308 static void tun_napi_init(struct tun_struct *tun, struct tun_file *tfile,
311 tfile->napi_enabled = napi_en;
313 netif_napi_add(tun->dev, &tfile->napi, tun_napi_poll,
315 napi_enable(&tfile->napi);
316 mutex_init(&tfile->napi_mutex);
320 static void tun_napi_disable(struct tun_struct *tun, struct tun_file *tfile)
322 if (tfile->napi_enabled)
323 napi_disable(&tfile->napi);
326 static void tun_napi_del(struct tun_struct *tun, struct tun_file *tfile)
328 if (tfile->napi_enabled)
329 netif_napi_del(&tfile->napi);
332 static bool tun_napi_frags_enabled(const struct tun_struct *tun)
334 return READ_ONCE(tun->flags) & IFF_NAPI_FRAGS;
337 #ifdef CONFIG_TUN_VNET_CROSS_LE
338 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
340 return tun->flags & TUN_VNET_BE ? false :
341 virtio_legacy_is_little_endian();
344 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
346 int be = !!(tun->flags & TUN_VNET_BE);
348 if (put_user(be, argp))
354 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
358 if (get_user(be, argp))
362 tun->flags |= TUN_VNET_BE;
364 tun->flags &= ~TUN_VNET_BE;
369 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
371 return virtio_legacy_is_little_endian();
374 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
379 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
383 #endif /* CONFIG_TUN_VNET_CROSS_LE */
385 static inline bool tun_is_little_endian(struct tun_struct *tun)
387 return tun->flags & TUN_VNET_LE ||
388 tun_legacy_is_little_endian(tun);
391 static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
393 return __virtio16_to_cpu(tun_is_little_endian(tun), val);
396 static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
398 return __cpu_to_virtio16(tun_is_little_endian(tun), val);
401 static inline u32 tun_hashfn(u32 rxhash)
403 return rxhash & 0x3ff;
406 static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
408 struct tun_flow_entry *e;
410 hlist_for_each_entry_rcu(e, head, hash_link) {
411 if (e->rxhash == rxhash)
417 static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
418 struct hlist_head *head,
419 u32 rxhash, u16 queue_index)
421 struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
424 tun_debug(KERN_INFO, tun, "create flow: hash %u index %u\n",
425 rxhash, queue_index);
426 e->updated = jiffies;
429 e->queue_index = queue_index;
431 hlist_add_head_rcu(&e->hash_link, head);
437 static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
439 tun_debug(KERN_INFO, tun, "delete flow: hash %u index %u\n",
440 e->rxhash, e->queue_index);
441 hlist_del_rcu(&e->hash_link);
446 static void tun_flow_flush(struct tun_struct *tun)
450 spin_lock_bh(&tun->lock);
451 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
452 struct tun_flow_entry *e;
453 struct hlist_node *n;
455 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
456 tun_flow_delete(tun, e);
458 spin_unlock_bh(&tun->lock);
461 static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
465 spin_lock_bh(&tun->lock);
466 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
467 struct tun_flow_entry *e;
468 struct hlist_node *n;
470 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
471 if (e->queue_index == queue_index)
472 tun_flow_delete(tun, e);
475 spin_unlock_bh(&tun->lock);
478 static void tun_flow_cleanup(struct timer_list *t)
480 struct tun_struct *tun = from_timer(tun, t, flow_gc_timer);
481 unsigned long delay = tun->ageing_time;
482 unsigned long next_timer = jiffies + delay;
483 unsigned long count = 0;
486 tun_debug(KERN_INFO, tun, "tun_flow_cleanup\n");
488 spin_lock(&tun->lock);
489 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
490 struct tun_flow_entry *e;
491 struct hlist_node *n;
493 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
494 unsigned long this_timer;
496 this_timer = e->updated + delay;
497 if (time_before_eq(this_timer, jiffies)) {
498 tun_flow_delete(tun, e);
502 if (time_before(this_timer, next_timer))
503 next_timer = this_timer;
508 mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
509 spin_unlock(&tun->lock);
512 static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
513 struct tun_file *tfile)
515 struct hlist_head *head;
516 struct tun_flow_entry *e;
517 unsigned long delay = tun->ageing_time;
518 u16 queue_index = tfile->queue_index;
523 head = &tun->flows[tun_hashfn(rxhash)];
527 /* We may get a very small possibility of OOO during switching, not
528 * worth to optimize.*/
529 if (tun->numqueues == 1 || tfile->detached)
532 e = tun_flow_find(head, rxhash);
534 /* TODO: keep queueing to old queue until it's empty? */
535 e->queue_index = queue_index;
536 e->updated = jiffies;
537 sock_rps_record_flow_hash(e->rps_rxhash);
539 spin_lock_bh(&tun->lock);
540 if (!tun_flow_find(head, rxhash) &&
541 tun->flow_count < MAX_TAP_FLOWS)
542 tun_flow_create(tun, head, rxhash, queue_index);
544 if (!timer_pending(&tun->flow_gc_timer))
545 mod_timer(&tun->flow_gc_timer,
546 round_jiffies_up(jiffies + delay));
547 spin_unlock_bh(&tun->lock);
555 * Save the hash received in the stack receive path and update the
556 * flow_hash table accordingly.
558 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry *e, u32 hash)
560 if (unlikely(e->rps_rxhash != hash))
561 e->rps_rxhash = hash;
564 /* We try to identify a flow through its rxhash first. The reason that
565 * we do not check rxq no. is because some cards(e.g 82599), chooses
566 * the rxq based on the txq where the last packet of the flow comes. As
567 * the userspace application move between processors, we may get a
568 * different rxq no. here. If we could not get rxhash, then we would
569 * hope the rxq no. may help here.
571 static u16 tun_automq_select_queue(struct tun_struct *tun, struct sk_buff *skb)
573 struct tun_flow_entry *e;
577 numqueues = READ_ONCE(tun->numqueues);
579 txq = __skb_get_hash_symmetric(skb);
581 e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
583 tun_flow_save_rps_rxhash(e, txq);
584 txq = e->queue_index;
586 /* use multiply and shift instead of expensive divide */
587 txq = ((u64)txq * numqueues) >> 32;
588 } else if (likely(skb_rx_queue_recorded(skb))) {
589 txq = skb_get_rx_queue(skb);
590 while (unlikely(txq >= numqueues))
597 static u16 tun_ebpf_select_queue(struct tun_struct *tun, struct sk_buff *skb)
599 struct tun_prog *prog;
602 prog = rcu_dereference(tun->steering_prog);
604 ret = bpf_prog_run_clear_cb(prog->prog, skb);
606 return ret % tun->numqueues;
609 static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb,
610 void *accel_priv, select_queue_fallback_t fallback)
612 struct tun_struct *tun = netdev_priv(dev);
616 if (rcu_dereference(tun->steering_prog))
617 ret = tun_ebpf_select_queue(tun, skb);
619 ret = tun_automq_select_queue(tun, skb);
625 static inline bool tun_not_capable(struct tun_struct *tun)
627 const struct cred *cred = current_cred();
628 struct net *net = dev_net(tun->dev);
630 return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
631 (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
632 !ns_capable(net->user_ns, CAP_NET_ADMIN);
635 static void tun_set_real_num_queues(struct tun_struct *tun)
637 netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
638 netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
641 static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
643 tfile->detached = tun;
644 list_add_tail(&tfile->next, &tun->disabled);
648 static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
650 struct tun_struct *tun = tfile->detached;
652 tfile->detached = NULL;
653 list_del_init(&tfile->next);
658 void tun_ptr_free(void *ptr)
662 if (tun_is_xdp_buff(ptr)) {
663 struct xdp_buff *xdp = tun_ptr_to_xdp(ptr);
665 put_page(virt_to_head_page(xdp->data));
667 __skb_array_destroy_skb(ptr);
670 EXPORT_SYMBOL_GPL(tun_ptr_free);
672 static void tun_queue_purge(struct tun_file *tfile)
676 while ((ptr = ptr_ring_consume(&tfile->tx_ring)) != NULL)
679 skb_queue_purge(&tfile->sk.sk_write_queue);
680 skb_queue_purge(&tfile->sk.sk_error_queue);
683 static void tun_cleanup_tx_ring(struct tun_file *tfile)
685 if (tfile->tx_ring.queue) {
686 ptr_ring_cleanup(&tfile->tx_ring, tun_ptr_free);
687 xdp_rxq_info_unreg(&tfile->xdp_rxq);
688 memset(&tfile->tx_ring, 0, sizeof(tfile->tx_ring));
692 static void __tun_detach(struct tun_file *tfile, bool clean)
694 struct tun_file *ntfile;
695 struct tun_struct *tun;
697 tun = rtnl_dereference(tfile->tun);
700 tun_napi_disable(tun, tfile);
701 tun_napi_del(tun, tfile);
704 if (tun && !tfile->detached) {
705 u16 index = tfile->queue_index;
706 BUG_ON(index >= tun->numqueues);
708 rcu_assign_pointer(tun->tfiles[index],
709 tun->tfiles[tun->numqueues - 1]);
710 ntfile = rtnl_dereference(tun->tfiles[index]);
711 ntfile->queue_index = index;
715 RCU_INIT_POINTER(tfile->tun, NULL);
716 sock_put(&tfile->sk);
718 tun_disable_queue(tun, tfile);
721 tun_flow_delete_by_queue(tun, tun->numqueues + 1);
722 /* Drop read queue */
723 tun_queue_purge(tfile);
724 tun_set_real_num_queues(tun);
725 } else if (tfile->detached && clean) {
726 tun = tun_enable_queue(tfile);
727 sock_put(&tfile->sk);
731 if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
732 netif_carrier_off(tun->dev);
734 if (!(tun->flags & IFF_PERSIST) &&
735 tun->dev->reg_state == NETREG_REGISTERED)
736 unregister_netdevice(tun->dev);
738 tun_cleanup_tx_ring(tfile);
739 sock_put(&tfile->sk);
743 static void tun_detach(struct tun_file *tfile, bool clean)
746 __tun_detach(tfile, clean);
750 static void tun_detach_all(struct net_device *dev)
752 struct tun_struct *tun = netdev_priv(dev);
753 struct tun_file *tfile, *tmp;
754 int i, n = tun->numqueues;
756 for (i = 0; i < n; i++) {
757 tfile = rtnl_dereference(tun->tfiles[i]);
759 tun_napi_disable(tun, tfile);
760 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
761 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
762 RCU_INIT_POINTER(tfile->tun, NULL);
765 list_for_each_entry(tfile, &tun->disabled, next) {
766 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
767 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
768 RCU_INIT_POINTER(tfile->tun, NULL);
770 BUG_ON(tun->numqueues != 0);
773 for (i = 0; i < n; i++) {
774 tfile = rtnl_dereference(tun->tfiles[i]);
775 tun_napi_del(tun, tfile);
776 /* Drop read queue */
777 tun_queue_purge(tfile);
778 sock_put(&tfile->sk);
779 tun_cleanup_tx_ring(tfile);
781 list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
782 tun_enable_queue(tfile);
783 tun_queue_purge(tfile);
784 sock_put(&tfile->sk);
785 tun_cleanup_tx_ring(tfile);
787 BUG_ON(tun->numdisabled != 0);
789 if (tun->flags & IFF_PERSIST)
790 module_put(THIS_MODULE);
793 static int tun_attach(struct tun_struct *tun, struct file *file,
794 bool skip_filter, bool napi)
796 struct tun_file *tfile = file->private_data;
797 struct net_device *dev = tun->dev;
800 err = security_tun_dev_attach(tfile->socket.sk, tun->security);
805 if (rtnl_dereference(tfile->tun) && !tfile->detached)
809 if (!(tun->flags & IFF_MULTI_QUEUE) && tun->numqueues == 1)
813 if (!tfile->detached &&
814 tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
819 /* Re-attach the filter to persist device */
820 if (!skip_filter && (tun->filter_attached == true)) {
821 lock_sock(tfile->socket.sk);
822 err = sk_attach_filter(&tun->fprog, tfile->socket.sk);
823 release_sock(tfile->socket.sk);
828 if (!tfile->detached &&
829 ptr_ring_init(&tfile->tx_ring, dev->tx_queue_len, GFP_KERNEL)) {
834 tfile->queue_index = tun->numqueues;
835 tfile->socket.sk->sk_shutdown &= ~RCV_SHUTDOWN;
837 if (tfile->detached) {
838 /* Re-attach detached tfile, updating XDP queue_index */
839 WARN_ON(!xdp_rxq_info_is_reg(&tfile->xdp_rxq));
841 if (tfile->xdp_rxq.queue_index != tfile->queue_index)
842 tfile->xdp_rxq.queue_index = tfile->queue_index;
844 /* Setup XDP RX-queue info, for new tfile getting attached */
845 err = xdp_rxq_info_reg(&tfile->xdp_rxq,
846 tun->dev, tfile->queue_index);
852 rcu_assign_pointer(tfile->tun, tun);
853 rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
856 if (tfile->detached) {
857 tun_enable_queue(tfile);
859 sock_hold(&tfile->sk);
860 tun_napi_init(tun, tfile, napi);
863 tun_set_real_num_queues(tun);
865 /* device is allowed to go away first, so no need to hold extra
873 static struct tun_struct *tun_get(struct tun_file *tfile)
875 struct tun_struct *tun;
878 tun = rcu_dereference(tfile->tun);
886 static void tun_put(struct tun_struct *tun)
892 static void addr_hash_set(u32 *mask, const u8 *addr)
894 int n = ether_crc(ETH_ALEN, addr) >> 26;
895 mask[n >> 5] |= (1 << (n & 31));
898 static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
900 int n = ether_crc(ETH_ALEN, addr) >> 26;
901 return mask[n >> 5] & (1 << (n & 31));
904 static int update_filter(struct tap_filter *filter, void __user *arg)
906 struct { u8 u[ETH_ALEN]; } *addr;
907 struct tun_filter uf;
908 int err, alen, n, nexact;
910 if (copy_from_user(&uf, arg, sizeof(uf)))
919 alen = ETH_ALEN * uf.count;
920 addr = memdup_user(arg + sizeof(uf), alen);
922 return PTR_ERR(addr);
924 /* The filter is updated without holding any locks. Which is
925 * perfectly safe. We disable it first and in the worst
926 * case we'll accept a few undesired packets. */
930 /* Use first set of addresses as an exact filter */
931 for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
932 memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
936 /* Remaining multicast addresses are hashed,
937 * unicast will leave the filter disabled. */
938 memset(filter->mask, 0, sizeof(filter->mask));
939 for (; n < uf.count; n++) {
940 if (!is_multicast_ether_addr(addr[n].u)) {
941 err = 0; /* no filter */
944 addr_hash_set(filter->mask, addr[n].u);
947 /* For ALLMULTI just set the mask to all ones.
948 * This overrides the mask populated above. */
949 if ((uf.flags & TUN_FLT_ALLMULTI))
950 memset(filter->mask, ~0, sizeof(filter->mask));
952 /* Now enable the filter */
954 filter->count = nexact;
956 /* Return the number of exact filters */
963 /* Returns: 0 - drop, !=0 - accept */
964 static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
966 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
968 struct ethhdr *eh = (struct ethhdr *) skb->data;
972 for (i = 0; i < filter->count; i++)
973 if (ether_addr_equal(eh->h_dest, filter->addr[i]))
976 /* Inexact match (multicast only) */
977 if (is_multicast_ether_addr(eh->h_dest))
978 return addr_hash_test(filter->mask, eh->h_dest);
984 * Checks whether the packet is accepted or not.
985 * Returns: 0 - drop, !=0 - accept
987 static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
992 return run_filter(filter, skb);
995 /* Network device part of the driver */
997 static const struct ethtool_ops tun_ethtool_ops;
999 /* Net device detach from fd. */
1000 static void tun_net_uninit(struct net_device *dev)
1002 tun_detach_all(dev);
1005 /* Net device open. */
1006 static int tun_net_open(struct net_device *dev)
1008 struct tun_struct *tun = netdev_priv(dev);
1011 netif_tx_start_all_queues(dev);
1013 for (i = 0; i < tun->numqueues; i++) {
1014 struct tun_file *tfile;
1016 tfile = rtnl_dereference(tun->tfiles[i]);
1017 tfile->socket.sk->sk_write_space(tfile->socket.sk);
1023 /* Net device close. */
1024 static int tun_net_close(struct net_device *dev)
1026 netif_tx_stop_all_queues(dev);
1030 /* Net device start xmit */
1031 static void tun_automq_xmit(struct tun_struct *tun, struct sk_buff *skb)
1034 if (tun->numqueues == 1 && static_key_false(&rps_needed)) {
1035 /* Select queue was not called for the skbuff, so we extract the
1036 * RPS hash and save it into the flow_table here.
1040 rxhash = __skb_get_hash_symmetric(skb);
1042 struct tun_flow_entry *e;
1043 e = tun_flow_find(&tun->flows[tun_hashfn(rxhash)],
1046 tun_flow_save_rps_rxhash(e, rxhash);
1052 static unsigned int run_ebpf_filter(struct tun_struct *tun,
1053 struct sk_buff *skb,
1056 struct tun_prog *prog = rcu_dereference(tun->filter_prog);
1059 len = bpf_prog_run_clear_cb(prog->prog, skb);
1064 /* Net device start xmit */
1065 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
1067 struct tun_struct *tun = netdev_priv(dev);
1068 int txq = skb->queue_mapping;
1069 struct tun_file *tfile;
1073 tfile = rcu_dereference(tun->tfiles[txq]);
1075 /* Drop packet if interface is not attached */
1076 if (txq >= tun->numqueues)
1079 if (!rcu_dereference(tun->steering_prog))
1080 tun_automq_xmit(tun, skb);
1082 tun_debug(KERN_INFO, tun, "tun_net_xmit %d\n", skb->len);
1086 /* Drop if the filter does not like it.
1087 * This is a noop if the filter is disabled.
1088 * Filter can be enabled only for the TAP devices. */
1089 if (!check_filter(&tun->txflt, skb))
1092 if (tfile->socket.sk->sk_filter &&
1093 sk_filter(tfile->socket.sk, skb))
1096 len = run_ebpf_filter(tun, skb, len);
1098 /* Trim extra bytes since we may insert vlan proto & TCI
1099 * in tun_put_user().
1101 len -= skb_vlan_tag_present(skb) ? sizeof(struct veth) : 0;
1102 if (len <= 0 || pskb_trim(skb, len))
1105 if (unlikely(skb_orphan_frags_rx(skb, GFP_ATOMIC)))
1108 skb_tx_timestamp(skb);
1110 /* Orphan the skb - required as we might hang on to it
1111 * for indefinite time.
1117 if (ptr_ring_produce(&tfile->tx_ring, skb))
1120 /* Notify and wake up reader process */
1121 if (tfile->flags & TUN_FASYNC)
1122 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1123 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1126 return NETDEV_TX_OK;
1129 this_cpu_inc(tun->pcpu_stats->tx_dropped);
1133 return NET_XMIT_DROP;
1136 static void tun_net_mclist(struct net_device *dev)
1139 * This callback is supposed to deal with mc filter in
1140 * _rx_ path and has nothing to do with the _tx_ path.
1141 * In rx path we always accept everything userspace gives us.
1145 static netdev_features_t tun_net_fix_features(struct net_device *dev,
1146 netdev_features_t features)
1148 struct tun_struct *tun = netdev_priv(dev);
1150 return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
1152 #ifdef CONFIG_NET_POLL_CONTROLLER
1153 static void tun_poll_controller(struct net_device *dev)
1156 * Tun only receives frames when:
1157 * 1) the char device endpoint gets data from user space
1158 * 2) the tun socket gets a sendmsg call from user space
1159 * If NAPI is not enabled, since both of those are synchronous
1160 * operations, we are guaranteed never to have pending data when we poll
1161 * for it so there is nothing to do here but return.
1162 * We need this though so netpoll recognizes us as an interface that
1163 * supports polling, which enables bridge devices in virt setups to
1164 * still use netconsole
1165 * If NAPI is enabled, however, we need to schedule polling for all
1166 * queues unless we are using napi_gro_frags(), which we call in
1167 * process context and not in NAPI context.
1169 struct tun_struct *tun = netdev_priv(dev);
1171 if (tun->flags & IFF_NAPI) {
1172 struct tun_file *tfile;
1175 if (tun_napi_frags_enabled(tun))
1179 for (i = 0; i < tun->numqueues; i++) {
1180 tfile = rcu_dereference(tun->tfiles[i]);
1181 if (tfile->napi_enabled)
1182 napi_schedule(&tfile->napi);
1190 static void tun_set_headroom(struct net_device *dev, int new_hr)
1192 struct tun_struct *tun = netdev_priv(dev);
1194 if (new_hr < NET_SKB_PAD)
1195 new_hr = NET_SKB_PAD;
1197 tun->align = new_hr;
1201 tun_net_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats)
1203 u32 rx_dropped = 0, tx_dropped = 0, rx_frame_errors = 0;
1204 struct tun_struct *tun = netdev_priv(dev);
1205 struct tun_pcpu_stats *p;
1208 for_each_possible_cpu(i) {
1209 u64 rxpackets, rxbytes, txpackets, txbytes;
1212 p = per_cpu_ptr(tun->pcpu_stats, i);
1214 start = u64_stats_fetch_begin(&p->syncp);
1215 rxpackets = p->rx_packets;
1216 rxbytes = p->rx_bytes;
1217 txpackets = p->tx_packets;
1218 txbytes = p->tx_bytes;
1219 } while (u64_stats_fetch_retry(&p->syncp, start));
1221 stats->rx_packets += rxpackets;
1222 stats->rx_bytes += rxbytes;
1223 stats->tx_packets += txpackets;
1224 stats->tx_bytes += txbytes;
1227 rx_dropped += p->rx_dropped;
1228 rx_frame_errors += p->rx_frame_errors;
1229 tx_dropped += p->tx_dropped;
1231 stats->rx_dropped = rx_dropped;
1232 stats->rx_frame_errors = rx_frame_errors;
1233 stats->tx_dropped = tx_dropped;
1236 static int tun_xdp_set(struct net_device *dev, struct bpf_prog *prog,
1237 struct netlink_ext_ack *extack)
1239 struct tun_struct *tun = netdev_priv(dev);
1240 struct bpf_prog *old_prog;
1242 old_prog = rtnl_dereference(tun->xdp_prog);
1243 rcu_assign_pointer(tun->xdp_prog, prog);
1245 bpf_prog_put(old_prog);
1250 static u32 tun_xdp_query(struct net_device *dev)
1252 struct tun_struct *tun = netdev_priv(dev);
1253 const struct bpf_prog *xdp_prog;
1255 xdp_prog = rtnl_dereference(tun->xdp_prog);
1257 return xdp_prog->aux->id;
1262 static int tun_xdp(struct net_device *dev, struct netdev_bpf *xdp)
1264 switch (xdp->command) {
1265 case XDP_SETUP_PROG:
1266 return tun_xdp_set(dev, xdp->prog, xdp->extack);
1267 case XDP_QUERY_PROG:
1268 xdp->prog_id = tun_xdp_query(dev);
1269 xdp->prog_attached = !!xdp->prog_id;
1276 static const struct net_device_ops tun_netdev_ops = {
1277 .ndo_uninit = tun_net_uninit,
1278 .ndo_open = tun_net_open,
1279 .ndo_stop = tun_net_close,
1280 .ndo_start_xmit = tun_net_xmit,
1281 .ndo_fix_features = tun_net_fix_features,
1282 .ndo_select_queue = tun_select_queue,
1283 #ifdef CONFIG_NET_POLL_CONTROLLER
1284 .ndo_poll_controller = tun_poll_controller,
1286 .ndo_set_rx_headroom = tun_set_headroom,
1287 .ndo_get_stats64 = tun_net_get_stats64,
1290 static int tun_xdp_xmit(struct net_device *dev, struct xdp_buff *xdp)
1292 struct tun_struct *tun = netdev_priv(dev);
1293 struct xdp_buff *buff = xdp->data_hard_start;
1294 int headroom = xdp->data - xdp->data_hard_start;
1295 struct tun_file *tfile;
1299 /* Assure headroom is available and buff is properly aligned */
1300 if (unlikely(headroom < sizeof(*xdp) || tun_is_xdp_buff(xdp)))
1307 numqueues = READ_ONCE(tun->numqueues);
1313 tfile = rcu_dereference(tun->tfiles[smp_processor_id() %
1315 /* Encode the XDP flag into lowest bit for consumer to differ
1316 * XDP buffer from sk_buff.
1318 if (ptr_ring_produce(&tfile->tx_ring, tun_xdp_to_ptr(buff))) {
1319 this_cpu_inc(tun->pcpu_stats->tx_dropped);
1328 static void tun_xdp_flush(struct net_device *dev)
1330 struct tun_struct *tun = netdev_priv(dev);
1331 struct tun_file *tfile;
1336 numqueues = READ_ONCE(tun->numqueues);
1340 tfile = rcu_dereference(tun->tfiles[smp_processor_id() %
1342 /* Notify and wake up reader process */
1343 if (tfile->flags & TUN_FASYNC)
1344 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1345 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1351 static const struct net_device_ops tap_netdev_ops = {
1352 .ndo_uninit = tun_net_uninit,
1353 .ndo_open = tun_net_open,
1354 .ndo_stop = tun_net_close,
1355 .ndo_start_xmit = tun_net_xmit,
1356 .ndo_fix_features = tun_net_fix_features,
1357 .ndo_set_rx_mode = tun_net_mclist,
1358 .ndo_set_mac_address = eth_mac_addr,
1359 .ndo_validate_addr = eth_validate_addr,
1360 .ndo_select_queue = tun_select_queue,
1361 #ifdef CONFIG_NET_POLL_CONTROLLER
1362 .ndo_poll_controller = tun_poll_controller,
1364 .ndo_features_check = passthru_features_check,
1365 .ndo_set_rx_headroom = tun_set_headroom,
1366 .ndo_get_stats64 = tun_net_get_stats64,
1368 .ndo_xdp_xmit = tun_xdp_xmit,
1369 .ndo_xdp_flush = tun_xdp_flush,
1372 static void tun_flow_init(struct tun_struct *tun)
1376 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
1377 INIT_HLIST_HEAD(&tun->flows[i]);
1379 tun->ageing_time = TUN_FLOW_EXPIRE;
1380 timer_setup(&tun->flow_gc_timer, tun_flow_cleanup, 0);
1381 mod_timer(&tun->flow_gc_timer,
1382 round_jiffies_up(jiffies + tun->ageing_time));
1385 static void tun_flow_uninit(struct tun_struct *tun)
1387 del_timer_sync(&tun->flow_gc_timer);
1388 tun_flow_flush(tun);
1392 #define MAX_MTU 65535
1394 /* Initialize net device. */
1395 static void tun_net_init(struct net_device *dev)
1397 struct tun_struct *tun = netdev_priv(dev);
1399 switch (tun->flags & TUN_TYPE_MASK) {
1401 dev->netdev_ops = &tun_netdev_ops;
1403 /* Point-to-Point TUN Device */
1404 dev->hard_header_len = 0;
1408 /* Zero header length */
1409 dev->type = ARPHRD_NONE;
1410 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
1414 dev->netdev_ops = &tap_netdev_ops;
1415 /* Ethernet TAP Device */
1417 dev->priv_flags &= ~IFF_TX_SKB_SHARING;
1418 dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
1420 eth_hw_addr_random(dev);
1425 dev->min_mtu = MIN_MTU;
1426 dev->max_mtu = MAX_MTU - dev->hard_header_len;
1429 /* Character device part */
1432 static __poll_t tun_chr_poll(struct file *file, poll_table *wait)
1434 struct tun_file *tfile = file->private_data;
1435 struct tun_struct *tun = tun_get(tfile);
1442 sk = tfile->socket.sk;
1444 tun_debug(KERN_INFO, tun, "tun_chr_poll\n");
1446 poll_wait(file, sk_sleep(sk), wait);
1448 if (!ptr_ring_empty(&tfile->tx_ring))
1449 mask |= EPOLLIN | EPOLLRDNORM;
1451 if (tun->dev->flags & IFF_UP &&
1452 (sock_writeable(sk) ||
1453 (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
1454 sock_writeable(sk))))
1455 mask |= EPOLLOUT | EPOLLWRNORM;
1457 if (tun->dev->reg_state != NETREG_REGISTERED)
1464 static struct sk_buff *tun_napi_alloc_frags(struct tun_file *tfile,
1466 const struct iov_iter *it)
1468 struct sk_buff *skb;
1473 if (it->nr_segs > MAX_SKB_FRAGS + 1)
1474 return ERR_PTR(-ENOMEM);
1477 skb = napi_get_frags(&tfile->napi);
1480 return ERR_PTR(-ENOMEM);
1482 linear = iov_iter_single_seg_count(it);
1483 err = __skb_grow(skb, linear);
1488 skb->data_len = len - linear;
1489 skb->truesize += skb->data_len;
1491 for (i = 1; i < it->nr_segs; i++) {
1492 struct page_frag *pfrag = ¤t->task_frag;
1493 size_t fragsz = it->iov[i].iov_len;
1495 if (fragsz == 0 || fragsz > PAGE_SIZE) {
1500 if (!skb_page_frag_refill(fragsz, pfrag, GFP_KERNEL)) {
1505 skb_fill_page_desc(skb, i - 1, pfrag->page,
1506 pfrag->offset, fragsz);
1507 page_ref_inc(pfrag->page);
1508 pfrag->offset += fragsz;
1513 /* frees skb and all frags allocated with napi_alloc_frag() */
1514 napi_free_frags(&tfile->napi);
1515 return ERR_PTR(err);
1518 /* prepad is the amount to reserve at front. len is length after that.
1519 * linear is a hint as to how much to copy (usually headers). */
1520 static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
1521 size_t prepad, size_t len,
1522 size_t linear, int noblock)
1524 struct sock *sk = tfile->socket.sk;
1525 struct sk_buff *skb;
1528 /* Under a page? Don't bother with paged skb. */
1529 if (prepad + len < PAGE_SIZE || !linear)
1532 skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
1535 return ERR_PTR(err);
1537 skb_reserve(skb, prepad);
1538 skb_put(skb, linear);
1539 skb->data_len = len - linear;
1540 skb->len += len - linear;
1545 static void tun_rx_batched(struct tun_struct *tun, struct tun_file *tfile,
1546 struct sk_buff *skb, int more)
1548 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1549 struct sk_buff_head process_queue;
1550 u32 rx_batched = tun->rx_batched;
1553 if (!rx_batched || (!more && skb_queue_empty(queue))) {
1555 netif_receive_skb(skb);
1560 spin_lock(&queue->lock);
1561 if (!more || skb_queue_len(queue) == rx_batched) {
1562 __skb_queue_head_init(&process_queue);
1563 skb_queue_splice_tail_init(queue, &process_queue);
1566 __skb_queue_tail(queue, skb);
1568 spin_unlock(&queue->lock);
1571 struct sk_buff *nskb;
1574 while ((nskb = __skb_dequeue(&process_queue)))
1575 netif_receive_skb(nskb);
1576 netif_receive_skb(skb);
1581 static bool tun_can_build_skb(struct tun_struct *tun, struct tun_file *tfile,
1582 int len, int noblock, bool zerocopy)
1584 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
1587 if (tfile->socket.sk->sk_sndbuf != INT_MAX)
1596 if (SKB_DATA_ALIGN(len + TUN_RX_PAD) +
1597 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
1603 static struct sk_buff *tun_build_skb(struct tun_struct *tun,
1604 struct tun_file *tfile,
1605 struct iov_iter *from,
1606 struct virtio_net_hdr *hdr,
1607 int len, int *skb_xdp)
1609 struct page_frag *alloc_frag = ¤t->task_frag;
1610 struct sk_buff *skb;
1611 struct bpf_prog *xdp_prog;
1612 int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
1613 unsigned int delta = 0;
1616 bool xdp_xmit = false;
1617 int err, pad = TUN_RX_PAD;
1620 xdp_prog = rcu_dereference(tun->xdp_prog);
1622 pad += TUN_HEADROOM;
1623 buflen += SKB_DATA_ALIGN(len + pad);
1626 alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
1627 if (unlikely(!skb_page_frag_refill(buflen, alloc_frag, GFP_KERNEL)))
1628 return ERR_PTR(-ENOMEM);
1630 buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
1631 copied = copy_page_from_iter(alloc_frag->page,
1632 alloc_frag->offset + pad,
1635 return ERR_PTR(-EFAULT);
1637 /* There's a small window that XDP may be set after the check
1638 * of xdp_prog above, this should be rare and for simplicity
1639 * we do XDP on skb in case the headroom is not enough.
1641 if (hdr->gso_type || !xdp_prog)
1648 xdp_prog = rcu_dereference(tun->xdp_prog);
1649 if (xdp_prog && !*skb_xdp) {
1650 struct xdp_buff xdp;
1654 xdp.data_hard_start = buf;
1655 xdp.data = buf + pad;
1656 xdp_set_data_meta_invalid(&xdp);
1657 xdp.data_end = xdp.data + len;
1658 xdp.rxq = &tfile->xdp_rxq;
1659 orig_data = xdp.data;
1660 act = bpf_prog_run_xdp(xdp_prog, &xdp);
1664 get_page(alloc_frag->page);
1665 alloc_frag->offset += buflen;
1666 err = xdp_do_redirect(tun->dev, &xdp, xdp_prog);
1677 delta = orig_data - xdp.data;
1680 bpf_warn_invalid_xdp_action(act);
1683 trace_xdp_exception(tun->dev, xdp_prog, act);
1690 skb = build_skb(buf, buflen);
1694 return ERR_PTR(-ENOMEM);
1697 skb_reserve(skb, pad - delta);
1698 skb_put(skb, len + delta);
1699 get_page(alloc_frag->page);
1700 alloc_frag->offset += buflen;
1703 skb->dev = tun->dev;
1704 generic_xdp_tx(skb, xdp_prog);
1716 put_page(alloc_frag->page);
1720 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1724 /* Get packet from user space buffer */
1725 static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
1726 void *msg_control, struct iov_iter *from,
1727 int noblock, bool more)
1729 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1730 struct sk_buff *skb;
1731 size_t total_len = iov_iter_count(from);
1732 size_t len = total_len, align = tun->align, linear;
1733 struct virtio_net_hdr gso = { 0 };
1734 struct tun_pcpu_stats *stats;
1737 bool zerocopy = false;
1741 bool frags = tun_napi_frags_enabled(tun);
1743 if (!(tun->dev->flags & IFF_UP))
1746 if (!(tun->flags & IFF_NO_PI)) {
1747 if (len < sizeof(pi))
1751 if (!copy_from_iter_full(&pi, sizeof(pi), from))
1755 if (tun->flags & IFF_VNET_HDR) {
1756 int vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1758 if (len < vnet_hdr_sz)
1762 if (!copy_from_iter_full(&gso, sizeof(gso), from))
1765 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
1766 tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1767 gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
1769 if (tun16_to_cpu(tun, gso.hdr_len) > len)
1771 iov_iter_advance(from, vnet_hdr_sz - sizeof(gso));
1774 if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
1775 align += NET_IP_ALIGN;
1776 if (unlikely(len < ETH_HLEN ||
1777 (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
1781 good_linear = SKB_MAX_HEAD(align);
1784 struct iov_iter i = *from;
1786 /* There are 256 bytes to be copied in skb, so there is
1787 * enough room for skb expand head in case it is used.
1788 * The rest of the buffer is mapped from userspace.
1790 copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
1791 if (copylen > good_linear)
1792 copylen = good_linear;
1794 iov_iter_advance(&i, copylen);
1795 if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
1799 if (!frags && tun_can_build_skb(tun, tfile, len, noblock, zerocopy)) {
1800 /* For the packet that is not easy to be processed
1801 * (e.g gso or jumbo packet), we will do it at after
1802 * skb was created with generic XDP routine.
1804 skb = tun_build_skb(tun, tfile, from, &gso, len, &skb_xdp);
1806 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1807 return PTR_ERR(skb);
1814 if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1815 linear = good_linear;
1817 linear = tun16_to_cpu(tun, gso.hdr_len);
1821 mutex_lock(&tfile->napi_mutex);
1822 skb = tun_napi_alloc_frags(tfile, copylen, from);
1823 /* tun_napi_alloc_frags() enforces a layout for the skb.
1824 * If zerocopy is enabled, then this layout will be
1825 * overwritten by zerocopy_sg_from_iter().
1829 skb = tun_alloc_skb(tfile, align, copylen, linear,
1834 if (PTR_ERR(skb) != -EAGAIN)
1835 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1837 mutex_unlock(&tfile->napi_mutex);
1838 return PTR_ERR(skb);
1842 err = zerocopy_sg_from_iter(skb, from);
1844 err = skb_copy_datagram_from_iter(skb, 0, from, len);
1847 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1850 tfile->napi.skb = NULL;
1851 mutex_unlock(&tfile->napi_mutex);
1858 if (virtio_net_hdr_to_skb(skb, &gso, tun_is_little_endian(tun))) {
1859 this_cpu_inc(tun->pcpu_stats->rx_frame_errors);
1862 tfile->napi.skb = NULL;
1863 mutex_unlock(&tfile->napi_mutex);
1869 switch (tun->flags & TUN_TYPE_MASK) {
1871 if (tun->flags & IFF_NO_PI) {
1872 u8 ip_version = skb->len ? (skb->data[0] >> 4) : 0;
1874 switch (ip_version) {
1876 pi.proto = htons(ETH_P_IP);
1879 pi.proto = htons(ETH_P_IPV6);
1882 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1888 skb_reset_mac_header(skb);
1889 skb->protocol = pi.proto;
1890 skb->dev = tun->dev;
1894 skb->protocol = eth_type_trans(skb, tun->dev);
1898 /* copy skb_ubuf_info for callback when skb has no error */
1900 skb_shinfo(skb)->destructor_arg = msg_control;
1901 skb_shinfo(skb)->tx_flags |= SKBTX_DEV_ZEROCOPY;
1902 skb_shinfo(skb)->tx_flags |= SKBTX_SHARED_FRAG;
1903 } else if (msg_control) {
1904 struct ubuf_info *uarg = msg_control;
1905 uarg->callback(uarg, false);
1908 skb_reset_network_header(skb);
1909 skb_probe_transport_header(skb, 0);
1912 struct bpf_prog *xdp_prog;
1916 xdp_prog = rcu_dereference(tun->xdp_prog);
1918 ret = do_xdp_generic(xdp_prog, skb);
1919 if (ret != XDP_PASS) {
1928 if (!rcu_dereference(tun->steering_prog))
1929 rxhash = __skb_get_hash_symmetric(skb);
1933 /* Exercise flow dissector code path. */
1934 u32 headlen = eth_get_headlen(skb->data, skb_headlen(skb));
1936 if (unlikely(headlen > skb_headlen(skb))) {
1937 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1938 napi_free_frags(&tfile->napi);
1939 mutex_unlock(&tfile->napi_mutex);
1945 napi_gro_frags(&tfile->napi);
1947 mutex_unlock(&tfile->napi_mutex);
1948 } else if (tfile->napi_enabled) {
1949 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1952 spin_lock_bh(&queue->lock);
1953 __skb_queue_tail(queue, skb);
1954 queue_len = skb_queue_len(queue);
1955 spin_unlock(&queue->lock);
1957 if (!more || queue_len > NAPI_POLL_WEIGHT)
1958 napi_schedule(&tfile->napi);
1961 } else if (!IS_ENABLED(CONFIG_4KSTACKS)) {
1962 tun_rx_batched(tun, tfile, skb, more);
1967 stats = get_cpu_ptr(tun->pcpu_stats);
1968 u64_stats_update_begin(&stats->syncp);
1969 stats->rx_packets++;
1970 stats->rx_bytes += len;
1971 u64_stats_update_end(&stats->syncp);
1975 tun_flow_update(tun, rxhash, tfile);
1980 static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
1982 struct file *file = iocb->ki_filp;
1983 struct tun_file *tfile = file->private_data;
1984 struct tun_struct *tun = tun_get(tfile);
1990 result = tun_get_user(tun, tfile, NULL, from,
1991 file->f_flags & O_NONBLOCK, false);
1997 static ssize_t tun_put_user_xdp(struct tun_struct *tun,
1998 struct tun_file *tfile,
1999 struct xdp_buff *xdp,
2000 struct iov_iter *iter)
2002 int vnet_hdr_sz = 0;
2003 size_t size = xdp->data_end - xdp->data;
2004 struct tun_pcpu_stats *stats;
2007 if (tun->flags & IFF_VNET_HDR) {
2008 struct virtio_net_hdr gso = { 0 };
2010 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2011 if (unlikely(iov_iter_count(iter) < vnet_hdr_sz))
2013 if (unlikely(copy_to_iter(&gso, sizeof(gso), iter) !=
2016 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2019 ret = copy_to_iter(xdp->data, size, iter) + vnet_hdr_sz;
2021 stats = get_cpu_ptr(tun->pcpu_stats);
2022 u64_stats_update_begin(&stats->syncp);
2023 stats->tx_packets++;
2024 stats->tx_bytes += ret;
2025 u64_stats_update_end(&stats->syncp);
2026 put_cpu_ptr(tun->pcpu_stats);
2031 /* Put packet to the user space buffer */
2032 static ssize_t tun_put_user(struct tun_struct *tun,
2033 struct tun_file *tfile,
2034 struct sk_buff *skb,
2035 struct iov_iter *iter)
2037 struct tun_pi pi = { 0, skb->protocol };
2038 struct tun_pcpu_stats *stats;
2040 int vlan_offset = 0;
2042 int vnet_hdr_sz = 0;
2044 if (skb_vlan_tag_present(skb))
2045 vlan_hlen = VLAN_HLEN;
2047 if (tun->flags & IFF_VNET_HDR)
2048 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2050 total = skb->len + vlan_hlen + vnet_hdr_sz;
2052 if (!(tun->flags & IFF_NO_PI)) {
2053 if (iov_iter_count(iter) < sizeof(pi))
2056 total += sizeof(pi);
2057 if (iov_iter_count(iter) < total) {
2058 /* Packet will be striped */
2059 pi.flags |= TUN_PKT_STRIP;
2062 if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
2067 struct virtio_net_hdr gso;
2069 if (iov_iter_count(iter) < vnet_hdr_sz)
2072 if (virtio_net_hdr_from_skb(skb, &gso,
2073 tun_is_little_endian(tun), true)) {
2074 struct skb_shared_info *sinfo = skb_shinfo(skb);
2075 pr_err("unexpected GSO type: "
2076 "0x%x, gso_size %d, hdr_len %d\n",
2077 sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
2078 tun16_to_cpu(tun, gso.hdr_len));
2079 print_hex_dump(KERN_ERR, "tun: ",
2082 min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
2087 if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
2090 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2097 veth.h_vlan_proto = skb->vlan_proto;
2098 veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
2100 vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
2102 ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
2103 if (ret || !iov_iter_count(iter))
2106 ret = copy_to_iter(&veth, sizeof(veth), iter);
2107 if (ret != sizeof(veth) || !iov_iter_count(iter))
2111 skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
2114 /* caller is in process context, */
2115 stats = get_cpu_ptr(tun->pcpu_stats);
2116 u64_stats_update_begin(&stats->syncp);
2117 stats->tx_packets++;
2118 stats->tx_bytes += skb->len + vlan_hlen;
2119 u64_stats_update_end(&stats->syncp);
2120 put_cpu_ptr(tun->pcpu_stats);
2125 static void *tun_ring_recv(struct tun_file *tfile, int noblock, int *err)
2127 DECLARE_WAITQUEUE(wait, current);
2131 ptr = ptr_ring_consume(&tfile->tx_ring);
2139 add_wait_queue(&tfile->wq.wait, &wait);
2140 current->state = TASK_INTERRUPTIBLE;
2143 ptr = ptr_ring_consume(&tfile->tx_ring);
2146 if (signal_pending(current)) {
2147 error = -ERESTARTSYS;
2150 if (tfile->socket.sk->sk_shutdown & RCV_SHUTDOWN) {
2158 current->state = TASK_RUNNING;
2159 remove_wait_queue(&tfile->wq.wait, &wait);
2166 static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
2167 struct iov_iter *to,
2168 int noblock, void *ptr)
2173 tun_debug(KERN_INFO, tun, "tun_do_read\n");
2175 if (!iov_iter_count(to)) {
2181 /* Read frames from ring */
2182 ptr = tun_ring_recv(tfile, noblock, &err);
2187 if (tun_is_xdp_buff(ptr)) {
2188 struct xdp_buff *xdp = tun_ptr_to_xdp(ptr);
2190 ret = tun_put_user_xdp(tun, tfile, xdp, to);
2191 put_page(virt_to_head_page(xdp->data));
2193 struct sk_buff *skb = ptr;
2195 ret = tun_put_user(tun, tfile, skb, to);
2196 if (unlikely(ret < 0))
2205 static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
2207 struct file *file = iocb->ki_filp;
2208 struct tun_file *tfile = file->private_data;
2209 struct tun_struct *tun = tun_get(tfile);
2210 ssize_t len = iov_iter_count(to), ret;
2214 ret = tun_do_read(tun, tfile, to, file->f_flags & O_NONBLOCK, NULL);
2215 ret = min_t(ssize_t, ret, len);
2222 static void tun_prog_free(struct rcu_head *rcu)
2224 struct tun_prog *prog = container_of(rcu, struct tun_prog, rcu);
2226 bpf_prog_destroy(prog->prog);
2230 static int __tun_set_ebpf(struct tun_struct *tun,
2231 struct tun_prog __rcu **prog_p,
2232 struct bpf_prog *prog)
2234 struct tun_prog *old, *new = NULL;
2237 new = kmalloc(sizeof(*new), GFP_KERNEL);
2243 spin_lock_bh(&tun->lock);
2244 old = rcu_dereference_protected(*prog_p,
2245 lockdep_is_held(&tun->lock));
2246 rcu_assign_pointer(*prog_p, new);
2247 spin_unlock_bh(&tun->lock);
2250 call_rcu(&old->rcu, tun_prog_free);
2255 static void tun_free_netdev(struct net_device *dev)
2257 struct tun_struct *tun = netdev_priv(dev);
2259 BUG_ON(!(list_empty(&tun->disabled)));
2260 free_percpu(tun->pcpu_stats);
2261 tun_flow_uninit(tun);
2262 security_tun_dev_free_security(tun->security);
2263 __tun_set_ebpf(tun, &tun->steering_prog, NULL);
2264 __tun_set_ebpf(tun, &tun->filter_prog, NULL);
2267 static void tun_setup(struct net_device *dev)
2269 struct tun_struct *tun = netdev_priv(dev);
2271 tun->owner = INVALID_UID;
2272 tun->group = INVALID_GID;
2274 dev->ethtool_ops = &tun_ethtool_ops;
2275 dev->needs_free_netdev = true;
2276 dev->priv_destructor = tun_free_netdev;
2277 /* We prefer our own queue length */
2278 dev->tx_queue_len = TUN_READQ_SIZE;
2281 /* Trivial set of netlink ops to allow deleting tun or tap
2282 * device with netlink.
2284 static int tun_validate(struct nlattr *tb[], struct nlattr *data[],
2285 struct netlink_ext_ack *extack)
2290 static struct rtnl_link_ops tun_link_ops __read_mostly = {
2292 .priv_size = sizeof(struct tun_struct),
2294 .validate = tun_validate,
2297 static void tun_sock_write_space(struct sock *sk)
2299 struct tun_file *tfile;
2300 wait_queue_head_t *wqueue;
2302 if (!sock_writeable(sk))
2305 if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
2308 wqueue = sk_sleep(sk);
2309 if (wqueue && waitqueue_active(wqueue))
2310 wake_up_interruptible_sync_poll(wqueue, EPOLLOUT |
2311 EPOLLWRNORM | EPOLLWRBAND);
2313 tfile = container_of(sk, struct tun_file, sk);
2314 kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
2317 static int tun_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
2320 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2321 struct tun_struct *tun = tun_get(tfile);
2326 ret = tun_get_user(tun, tfile, m->msg_control, &m->msg_iter,
2327 m->msg_flags & MSG_DONTWAIT,
2328 m->msg_flags & MSG_MORE);
2333 static int tun_recvmsg(struct socket *sock, struct msghdr *m, size_t total_len,
2336 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2337 struct tun_struct *tun = tun_get(tfile);
2338 void *ptr = m->msg_control;
2346 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
2350 if (flags & MSG_ERRQUEUE) {
2351 ret = sock_recv_errqueue(sock->sk, m, total_len,
2352 SOL_PACKET, TUN_TX_TIMESTAMP);
2355 ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT, ptr);
2356 if (ret > (ssize_t)total_len) {
2357 m->msg_flags |= MSG_TRUNC;
2358 ret = flags & MSG_TRUNC ? ret : total_len;
2371 static int tun_ptr_peek_len(void *ptr)
2374 if (tun_is_xdp_buff(ptr)) {
2375 struct xdp_buff *xdp = tun_ptr_to_xdp(ptr);
2377 return xdp->data_end - xdp->data;
2379 return __skb_array_len_with_tag(ptr);
2385 static int tun_peek_len(struct socket *sock)
2387 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2388 struct tun_struct *tun;
2391 tun = tun_get(tfile);
2395 ret = PTR_RING_PEEK_CALL(&tfile->tx_ring, tun_ptr_peek_len);
2401 /* Ops structure to mimic raw sockets with tun */
2402 static const struct proto_ops tun_socket_ops = {
2403 .peek_len = tun_peek_len,
2404 .sendmsg = tun_sendmsg,
2405 .recvmsg = tun_recvmsg,
2408 static struct proto tun_proto = {
2410 .owner = THIS_MODULE,
2411 .obj_size = sizeof(struct tun_file),
2414 static int tun_flags(struct tun_struct *tun)
2416 return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
2419 static ssize_t tun_show_flags(struct device *dev, struct device_attribute *attr,
2422 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2423 return sprintf(buf, "0x%x\n", tun_flags(tun));
2426 static ssize_t tun_show_owner(struct device *dev, struct device_attribute *attr,
2429 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2430 return uid_valid(tun->owner)?
2431 sprintf(buf, "%u\n",
2432 from_kuid_munged(current_user_ns(), tun->owner)):
2433 sprintf(buf, "-1\n");
2436 static ssize_t tun_show_group(struct device *dev, struct device_attribute *attr,
2439 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2440 return gid_valid(tun->group) ?
2441 sprintf(buf, "%u\n",
2442 from_kgid_munged(current_user_ns(), tun->group)):
2443 sprintf(buf, "-1\n");
2446 static DEVICE_ATTR(tun_flags, 0444, tun_show_flags, NULL);
2447 static DEVICE_ATTR(owner, 0444, tun_show_owner, NULL);
2448 static DEVICE_ATTR(group, 0444, tun_show_group, NULL);
2450 static struct attribute *tun_dev_attrs[] = {
2451 &dev_attr_tun_flags.attr,
2452 &dev_attr_owner.attr,
2453 &dev_attr_group.attr,
2457 static const struct attribute_group tun_attr_group = {
2458 .attrs = tun_dev_attrs
2461 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
2463 struct tun_struct *tun;
2464 struct tun_file *tfile = file->private_data;
2465 struct net_device *dev;
2468 if (tfile->detached)
2471 if ((ifr->ifr_flags & IFF_NAPI_FRAGS)) {
2472 if (!capable(CAP_NET_ADMIN))
2475 if (!(ifr->ifr_flags & IFF_NAPI) ||
2476 (ifr->ifr_flags & TUN_TYPE_MASK) != IFF_TAP)
2480 dev = __dev_get_by_name(net, ifr->ifr_name);
2482 if (ifr->ifr_flags & IFF_TUN_EXCL)
2484 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
2485 tun = netdev_priv(dev);
2486 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
2487 tun = netdev_priv(dev);
2491 if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
2492 !!(tun->flags & IFF_MULTI_QUEUE))
2495 if (tun_not_capable(tun))
2497 err = security_tun_dev_open(tun->security);
2501 err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER,
2502 ifr->ifr_flags & IFF_NAPI);
2506 if (tun->flags & IFF_MULTI_QUEUE &&
2507 (tun->numqueues + tun->numdisabled > 1)) {
2508 /* One or more queue has already been attached, no need
2509 * to initialize the device again.
2516 unsigned long flags = 0;
2517 int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
2520 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
2522 err = security_tun_dev_create();
2527 if (ifr->ifr_flags & IFF_TUN) {
2531 } else if (ifr->ifr_flags & IFF_TAP) {
2539 name = ifr->ifr_name;
2541 dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
2542 NET_NAME_UNKNOWN, tun_setup, queues,
2547 err = dev_get_valid_name(net, dev, name);
2551 dev_net_set(dev, net);
2552 dev->rtnl_link_ops = &tun_link_ops;
2553 dev->ifindex = tfile->ifindex;
2554 dev->sysfs_groups[0] = &tun_attr_group;
2556 tun = netdev_priv(dev);
2559 tun->txflt.count = 0;
2560 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
2562 tun->align = NET_SKB_PAD;
2563 tun->filter_attached = false;
2564 tun->sndbuf = tfile->socket.sk->sk_sndbuf;
2565 tun->rx_batched = 0;
2566 RCU_INIT_POINTER(tun->steering_prog, NULL);
2568 tun->pcpu_stats = netdev_alloc_pcpu_stats(struct tun_pcpu_stats);
2569 if (!tun->pcpu_stats) {
2574 spin_lock_init(&tun->lock);
2576 err = security_tun_dev_alloc_security(&tun->security);
2583 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
2584 TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
2585 NETIF_F_HW_VLAN_STAG_TX;
2586 dev->features = dev->hw_features | NETIF_F_LLTX;
2587 dev->vlan_features = dev->features &
2588 ~(NETIF_F_HW_VLAN_CTAG_TX |
2589 NETIF_F_HW_VLAN_STAG_TX);
2591 INIT_LIST_HEAD(&tun->disabled);
2592 err = tun_attach(tun, file, false, ifr->ifr_flags & IFF_NAPI);
2596 err = register_netdevice(tun->dev);
2601 netif_carrier_on(tun->dev);
2603 tun_debug(KERN_INFO, tun, "tun_set_iff\n");
2605 tun->flags = (tun->flags & ~TUN_FEATURES) |
2606 (ifr->ifr_flags & TUN_FEATURES);
2608 /* Make sure persistent devices do not get stuck in
2611 if (netif_running(tun->dev))
2612 netif_tx_wake_all_queues(tun->dev);
2614 strcpy(ifr->ifr_name, tun->dev->name);
2618 tun_detach_all(dev);
2619 /* register_netdevice() already called tun_free_netdev() */
2623 tun_flow_uninit(tun);
2624 security_tun_dev_free_security(tun->security);
2626 free_percpu(tun->pcpu_stats);
2632 static void tun_get_iff(struct net *net, struct tun_struct *tun,
2635 tun_debug(KERN_INFO, tun, "tun_get_iff\n");
2637 strcpy(ifr->ifr_name, tun->dev->name);
2639 ifr->ifr_flags = tun_flags(tun);
2643 /* This is like a cut-down ethtool ops, except done via tun fd so no
2644 * privs required. */
2645 static int set_offload(struct tun_struct *tun, unsigned long arg)
2647 netdev_features_t features = 0;
2649 if (arg & TUN_F_CSUM) {
2650 features |= NETIF_F_HW_CSUM;
2653 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
2654 if (arg & TUN_F_TSO_ECN) {
2655 features |= NETIF_F_TSO_ECN;
2656 arg &= ~TUN_F_TSO_ECN;
2658 if (arg & TUN_F_TSO4)
2659 features |= NETIF_F_TSO;
2660 if (arg & TUN_F_TSO6)
2661 features |= NETIF_F_TSO6;
2662 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
2668 /* This gives the user a way to test for new features in future by
2669 * trying to set them. */
2673 tun->set_features = features;
2674 tun->dev->wanted_features &= ~TUN_USER_FEATURES;
2675 tun->dev->wanted_features |= features;
2676 netdev_update_features(tun->dev);
2681 static void tun_detach_filter(struct tun_struct *tun, int n)
2684 struct tun_file *tfile;
2686 for (i = 0; i < n; i++) {
2687 tfile = rtnl_dereference(tun->tfiles[i]);
2688 lock_sock(tfile->socket.sk);
2689 sk_detach_filter(tfile->socket.sk);
2690 release_sock(tfile->socket.sk);
2693 tun->filter_attached = false;
2696 static int tun_attach_filter(struct tun_struct *tun)
2699 struct tun_file *tfile;
2701 for (i = 0; i < tun->numqueues; i++) {
2702 tfile = rtnl_dereference(tun->tfiles[i]);
2703 lock_sock(tfile->socket.sk);
2704 ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
2705 release_sock(tfile->socket.sk);
2707 tun_detach_filter(tun, i);
2712 tun->filter_attached = true;
2716 static void tun_set_sndbuf(struct tun_struct *tun)
2718 struct tun_file *tfile;
2721 for (i = 0; i < tun->numqueues; i++) {
2722 tfile = rtnl_dereference(tun->tfiles[i]);
2723 tfile->socket.sk->sk_sndbuf = tun->sndbuf;
2727 static int tun_set_queue(struct file *file, struct ifreq *ifr)
2729 struct tun_file *tfile = file->private_data;
2730 struct tun_struct *tun;
2735 if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
2736 tun = tfile->detached;
2741 ret = security_tun_dev_attach_queue(tun->security);
2744 ret = tun_attach(tun, file, false, tun->flags & IFF_NAPI);
2745 } else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
2746 tun = rtnl_dereference(tfile->tun);
2747 if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
2750 __tun_detach(tfile, false);
2759 static int tun_set_ebpf(struct tun_struct *tun, struct tun_prog **prog_p,
2762 struct bpf_prog *prog;
2765 if (copy_from_user(&fd, data, sizeof(fd)))
2771 prog = bpf_prog_get_type(fd, BPF_PROG_TYPE_SOCKET_FILTER);
2773 return PTR_ERR(prog);
2776 return __tun_set_ebpf(tun, prog_p, prog);
2779 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
2780 unsigned long arg, int ifreq_len)
2782 struct tun_file *tfile = file->private_data;
2783 struct tun_struct *tun;
2784 void __user* argp = (void __user*)arg;
2790 unsigned int ifindex;
2794 if (cmd == TUNSETIFF || cmd == TUNSETQUEUE || _IOC_TYPE(cmd) == SOCK_IOC_TYPE) {
2795 if (copy_from_user(&ifr, argp, ifreq_len))
2798 memset(&ifr, 0, sizeof(ifr));
2800 if (cmd == TUNGETFEATURES) {
2801 /* Currently this just means: "what IFF flags are valid?".
2802 * This is needed because we never checked for invalid flags on
2805 return put_user(IFF_TUN | IFF_TAP | TUN_FEATURES,
2806 (unsigned int __user*)argp);
2807 } else if (cmd == TUNSETQUEUE)
2808 return tun_set_queue(file, &ifr);
2813 tun = tun_get(tfile);
2814 if (cmd == TUNSETIFF) {
2819 ifr.ifr_name[IFNAMSIZ-1] = '\0';
2821 ret = tun_set_iff(sock_net(&tfile->sk), file, &ifr);
2826 if (copy_to_user(argp, &ifr, ifreq_len))
2830 if (cmd == TUNSETIFINDEX) {
2836 if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
2840 tfile->ifindex = ifindex;
2848 tun_debug(KERN_INFO, tun, "tun_chr_ioctl cmd %u\n", cmd);
2853 tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
2855 if (tfile->detached)
2856 ifr.ifr_flags |= IFF_DETACH_QUEUE;
2857 if (!tfile->socket.sk->sk_filter)
2858 ifr.ifr_flags |= IFF_NOFILTER;
2860 if (copy_to_user(argp, &ifr, ifreq_len))
2865 /* Disable/Enable checksum */
2867 /* [unimplemented] */
2868 tun_debug(KERN_INFO, tun, "ignored: set checksum %s\n",
2869 arg ? "disabled" : "enabled");
2873 /* Disable/Enable persist mode. Keep an extra reference to the
2874 * module to prevent the module being unprobed.
2876 if (arg && !(tun->flags & IFF_PERSIST)) {
2877 tun->flags |= IFF_PERSIST;
2878 __module_get(THIS_MODULE);
2880 if (!arg && (tun->flags & IFF_PERSIST)) {
2881 tun->flags &= ~IFF_PERSIST;
2882 module_put(THIS_MODULE);
2885 tun_debug(KERN_INFO, tun, "persist %s\n",
2886 arg ? "enabled" : "disabled");
2890 /* Set owner of the device */
2891 owner = make_kuid(current_user_ns(), arg);
2892 if (!uid_valid(owner)) {
2897 tun_debug(KERN_INFO, tun, "owner set to %u\n",
2898 from_kuid(&init_user_ns, tun->owner));
2902 /* Set group of the device */
2903 group = make_kgid(current_user_ns(), arg);
2904 if (!gid_valid(group)) {
2909 tun_debug(KERN_INFO, tun, "group set to %u\n",
2910 from_kgid(&init_user_ns, tun->group));
2914 /* Only allow setting the type when the interface is down */
2915 if (tun->dev->flags & IFF_UP) {
2916 tun_debug(KERN_INFO, tun,
2917 "Linktype set failed because interface is up\n");
2920 tun->dev->type = (int) arg;
2921 tun_debug(KERN_INFO, tun, "linktype set to %d\n",
2933 ret = set_offload(tun, arg);
2936 case TUNSETTXFILTER:
2937 /* Can be set only for TAPs */
2939 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
2941 ret = update_filter(&tun->txflt, (void __user *)arg);
2945 /* Get hw address */
2946 memcpy(ifr.ifr_hwaddr.sa_data, tun->dev->dev_addr, ETH_ALEN);
2947 ifr.ifr_hwaddr.sa_family = tun->dev->type;
2948 if (copy_to_user(argp, &ifr, ifreq_len))
2953 /* Set hw address */
2954 tun_debug(KERN_DEBUG, tun, "set hw address: %pM\n",
2955 ifr.ifr_hwaddr.sa_data);
2957 ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr);
2961 sndbuf = tfile->socket.sk->sk_sndbuf;
2962 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
2967 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
2976 tun->sndbuf = sndbuf;
2977 tun_set_sndbuf(tun);
2980 case TUNGETVNETHDRSZ:
2981 vnet_hdr_sz = tun->vnet_hdr_sz;
2982 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
2986 case TUNSETVNETHDRSZ:
2987 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
2991 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
2996 tun->vnet_hdr_sz = vnet_hdr_sz;
3000 le = !!(tun->flags & TUN_VNET_LE);
3001 if (put_user(le, (int __user *)argp))
3006 if (get_user(le, (int __user *)argp)) {
3011 tun->flags |= TUN_VNET_LE;
3013 tun->flags &= ~TUN_VNET_LE;
3017 ret = tun_get_vnet_be(tun, argp);
3021 ret = tun_set_vnet_be(tun, argp);
3024 case TUNATTACHFILTER:
3025 /* Can be set only for TAPs */
3027 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3030 if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
3033 ret = tun_attach_filter(tun);
3036 case TUNDETACHFILTER:
3037 /* Can be set only for TAPs */
3039 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3042 tun_detach_filter(tun, tun->numqueues);
3047 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3050 if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
3055 case TUNSETSTEERINGEBPF:
3056 ret = tun_set_ebpf(tun, &tun->steering_prog, argp);
3059 case TUNSETFILTEREBPF:
3060 ret = tun_set_ebpf(tun, &tun->filter_prog, argp);
3075 static long tun_chr_ioctl(struct file *file,
3076 unsigned int cmd, unsigned long arg)
3078 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
3081 #ifdef CONFIG_COMPAT
3082 static long tun_chr_compat_ioctl(struct file *file,
3083 unsigned int cmd, unsigned long arg)
3088 case TUNSETTXFILTER:
3093 arg = (unsigned long)compat_ptr(arg);
3096 arg = (compat_ulong_t)arg;
3101 * compat_ifreq is shorter than ifreq, so we must not access beyond
3102 * the end of that structure. All fields that are used in this
3103 * driver are compatible though, we don't need to convert the
3106 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
3108 #endif /* CONFIG_COMPAT */
3110 static int tun_chr_fasync(int fd, struct file *file, int on)
3112 struct tun_file *tfile = file->private_data;
3115 if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
3119 __f_setown(file, task_pid(current), PIDTYPE_PID, 0);
3120 tfile->flags |= TUN_FASYNC;
3122 tfile->flags &= ~TUN_FASYNC;
3128 static int tun_chr_open(struct inode *inode, struct file * file)
3130 struct net *net = current->nsproxy->net_ns;
3131 struct tun_file *tfile;
3133 DBG1(KERN_INFO, "tunX: tun_chr_open\n");
3135 tfile = (struct tun_file *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
3139 RCU_INIT_POINTER(tfile->tun, NULL);
3143 init_waitqueue_head(&tfile->wq.wait);
3144 RCU_INIT_POINTER(tfile->socket.wq, &tfile->wq);
3146 tfile->socket.file = file;
3147 tfile->socket.ops = &tun_socket_ops;
3149 sock_init_data(&tfile->socket, &tfile->sk);
3151 tfile->sk.sk_write_space = tun_sock_write_space;
3152 tfile->sk.sk_sndbuf = INT_MAX;
3154 file->private_data = tfile;
3155 INIT_LIST_HEAD(&tfile->next);
3157 sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
3159 memset(&tfile->tx_ring, 0, sizeof(tfile->tx_ring));
3164 static int tun_chr_close(struct inode *inode, struct file *file)
3166 struct tun_file *tfile = file->private_data;
3168 tun_detach(tfile, true);
3173 #ifdef CONFIG_PROC_FS
3174 static void tun_chr_show_fdinfo(struct seq_file *m, struct file *file)
3176 struct tun_file *tfile = file->private_data;
3177 struct tun_struct *tun;
3180 memset(&ifr, 0, sizeof(ifr));
3183 tun = tun_get(tfile);
3185 tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
3191 seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
3195 static const struct file_operations tun_fops = {
3196 .owner = THIS_MODULE,
3197 .llseek = no_llseek,
3198 .read_iter = tun_chr_read_iter,
3199 .write_iter = tun_chr_write_iter,
3200 .poll = tun_chr_poll,
3201 .unlocked_ioctl = tun_chr_ioctl,
3202 #ifdef CONFIG_COMPAT
3203 .compat_ioctl = tun_chr_compat_ioctl,
3205 .open = tun_chr_open,
3206 .release = tun_chr_close,
3207 .fasync = tun_chr_fasync,
3208 #ifdef CONFIG_PROC_FS
3209 .show_fdinfo = tun_chr_show_fdinfo,
3213 static struct miscdevice tun_miscdev = {
3216 .nodename = "net/tun",
3220 /* ethtool interface */
3222 static int tun_get_link_ksettings(struct net_device *dev,
3223 struct ethtool_link_ksettings *cmd)
3225 ethtool_link_ksettings_zero_link_mode(cmd, supported);
3226 ethtool_link_ksettings_zero_link_mode(cmd, advertising);
3227 cmd->base.speed = SPEED_10;
3228 cmd->base.duplex = DUPLEX_FULL;
3229 cmd->base.port = PORT_TP;
3230 cmd->base.phy_address = 0;
3231 cmd->base.autoneg = AUTONEG_DISABLE;
3235 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
3237 struct tun_struct *tun = netdev_priv(dev);
3239 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
3240 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
3242 switch (tun->flags & TUN_TYPE_MASK) {
3244 strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
3247 strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
3252 static u32 tun_get_msglevel(struct net_device *dev)
3255 struct tun_struct *tun = netdev_priv(dev);
3262 static void tun_set_msglevel(struct net_device *dev, u32 value)
3265 struct tun_struct *tun = netdev_priv(dev);
3270 static int tun_get_coalesce(struct net_device *dev,
3271 struct ethtool_coalesce *ec)
3273 struct tun_struct *tun = netdev_priv(dev);
3275 ec->rx_max_coalesced_frames = tun->rx_batched;
3280 static int tun_set_coalesce(struct net_device *dev,
3281 struct ethtool_coalesce *ec)
3283 struct tun_struct *tun = netdev_priv(dev);
3285 if (ec->rx_max_coalesced_frames > NAPI_POLL_WEIGHT)
3286 tun->rx_batched = NAPI_POLL_WEIGHT;
3288 tun->rx_batched = ec->rx_max_coalesced_frames;
3293 static const struct ethtool_ops tun_ethtool_ops = {
3294 .get_drvinfo = tun_get_drvinfo,
3295 .get_msglevel = tun_get_msglevel,
3296 .set_msglevel = tun_set_msglevel,
3297 .get_link = ethtool_op_get_link,
3298 .get_ts_info = ethtool_op_get_ts_info,
3299 .get_coalesce = tun_get_coalesce,
3300 .set_coalesce = tun_set_coalesce,
3301 .get_link_ksettings = tun_get_link_ksettings,
3304 static int tun_queue_resize(struct tun_struct *tun)
3306 struct net_device *dev = tun->dev;
3307 struct tun_file *tfile;
3308 struct ptr_ring **rings;
3309 int n = tun->numqueues + tun->numdisabled;
3312 rings = kmalloc_array(n, sizeof(*rings), GFP_KERNEL);
3316 for (i = 0; i < tun->numqueues; i++) {
3317 tfile = rtnl_dereference(tun->tfiles[i]);
3318 rings[i] = &tfile->tx_ring;
3320 list_for_each_entry(tfile, &tun->disabled, next)
3321 rings[i++] = &tfile->tx_ring;
3323 ret = ptr_ring_resize_multiple(rings, n,
3324 dev->tx_queue_len, GFP_KERNEL,
3331 static int tun_device_event(struct notifier_block *unused,
3332 unsigned long event, void *ptr)
3334 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
3335 struct tun_struct *tun = netdev_priv(dev);
3337 if (dev->rtnl_link_ops != &tun_link_ops)
3341 case NETDEV_CHANGE_TX_QUEUE_LEN:
3342 if (tun_queue_resize(tun))
3352 static struct notifier_block tun_notifier_block __read_mostly = {
3353 .notifier_call = tun_device_event,
3356 static int __init tun_init(void)
3360 pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
3362 ret = rtnl_link_register(&tun_link_ops);
3364 pr_err("Can't register link_ops\n");
3368 ret = misc_register(&tun_miscdev);
3370 pr_err("Can't register misc device %d\n", TUN_MINOR);
3374 ret = register_netdevice_notifier(&tun_notifier_block);
3376 pr_err("Can't register netdevice notifier\n");
3383 misc_deregister(&tun_miscdev);
3385 rtnl_link_unregister(&tun_link_ops);
3390 static void tun_cleanup(void)
3392 misc_deregister(&tun_miscdev);
3393 rtnl_link_unregister(&tun_link_ops);
3394 unregister_netdevice_notifier(&tun_notifier_block);
3397 /* Get an underlying socket object from tun file. Returns error unless file is
3398 * attached to a device. The returned object works like a packet socket, it
3399 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
3400 * holding a reference to the file for as long as the socket is in use. */
3401 struct socket *tun_get_socket(struct file *file)
3403 struct tun_file *tfile;
3404 if (file->f_op != &tun_fops)
3405 return ERR_PTR(-EINVAL);
3406 tfile = file->private_data;
3408 return ERR_PTR(-EBADFD);
3409 return &tfile->socket;
3411 EXPORT_SYMBOL_GPL(tun_get_socket);
3413 struct ptr_ring *tun_get_tx_ring(struct file *file)
3415 struct tun_file *tfile;
3417 if (file->f_op != &tun_fops)
3418 return ERR_PTR(-EINVAL);
3419 tfile = file->private_data;
3421 return ERR_PTR(-EBADFD);
3422 return &tfile->tx_ring;
3424 EXPORT_SYMBOL_GPL(tun_get_tx_ring);
3426 module_init(tun_init);
3427 module_exit(tun_cleanup);
3428 MODULE_DESCRIPTION(DRV_DESCRIPTION);
3429 MODULE_AUTHOR(DRV_COPYRIGHT);
3430 MODULE_LICENSE("GPL");
3431 MODULE_ALIAS_MISCDEV(TUN_MINOR);
3432 MODULE_ALIAS("devname:net/tun");