2 * TUN - Universal TUN/TAP device driver.
3 * Copyright (C) 1999-2002 Maxim Krasnyansky <maxk@qualcomm.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * $Id: tun.c,v 1.15 2002/03/01 02:44:24 maxk Exp $
21 * Mike Kershaw <dragorn@kismetwireless.net> 2005/08/14
22 * Add TUNSETLINK ioctl to set the link encapsulation
24 * Mark Smith <markzzzsmith@yahoo.com.au>
25 * Use eth_random_addr() for tap MAC address.
27 * Harald Roelle <harald.roelle@ifi.lmu.de> 2004/04/20
28 * Fixes in packet dropping, queue length setting and queue wakeup.
29 * Increased default tx queue length.
33 * Daniel Podlejski <underley@underley.eu.org>
34 * Modifications for 2.3.99-pre5 kernel.
37 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
39 #define DRV_NAME "tun"
40 #define DRV_VERSION "1.6"
41 #define DRV_DESCRIPTION "Universal TUN/TAP device driver"
42 #define DRV_COPYRIGHT "(C) 1999-2004 Max Krasnyansky <maxk@qualcomm.com>"
44 #include <linux/module.h>
45 #include <linux/errno.h>
46 #include <linux/kernel.h>
47 #include <linux/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;
184 int xdp_pending_pkts;
187 struct tun_flow_entry {
188 struct hlist_node hash_link;
190 struct tun_struct *tun;
195 unsigned long updated;
198 #define TUN_NUM_FLOW_ENTRIES 1024
202 struct bpf_prog *prog;
205 /* Since the socket were moved to tun_file, to preserve the behavior of persist
206 * device, socket filter, sndbuf and vnet header size were restore when the
207 * file were attached to a persist device.
210 struct tun_file __rcu *tfiles[MAX_TAP_QUEUES];
211 unsigned int numqueues;
216 struct net_device *dev;
217 netdev_features_t set_features;
218 #define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
224 struct tap_filter txflt;
225 struct sock_fprog fprog;
226 /* protected by rtnl lock */
227 bool filter_attached;
232 struct hlist_head flows[TUN_NUM_FLOW_ENTRIES];
233 struct timer_list flow_gc_timer;
234 unsigned long ageing_time;
235 unsigned int numdisabled;
236 struct list_head disabled;
240 struct tun_pcpu_stats __percpu *pcpu_stats;
241 struct bpf_prog __rcu *xdp_prog;
242 struct tun_prog __rcu *steering_prog;
243 struct tun_prog __rcu *filter_prog;
251 bool tun_is_xdp_buff(void *ptr)
253 return (unsigned long)ptr & TUN_XDP_FLAG;
255 EXPORT_SYMBOL(tun_is_xdp_buff);
257 void *tun_xdp_to_ptr(void *ptr)
259 return (void *)((unsigned long)ptr | TUN_XDP_FLAG);
261 EXPORT_SYMBOL(tun_xdp_to_ptr);
263 void *tun_ptr_to_xdp(void *ptr)
265 return (void *)((unsigned long)ptr & ~TUN_XDP_FLAG);
267 EXPORT_SYMBOL(tun_ptr_to_xdp);
269 static int tun_napi_receive(struct napi_struct *napi, int budget)
271 struct tun_file *tfile = container_of(napi, struct tun_file, napi);
272 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
273 struct sk_buff_head process_queue;
277 __skb_queue_head_init(&process_queue);
279 spin_lock(&queue->lock);
280 skb_queue_splice_tail_init(queue, &process_queue);
281 spin_unlock(&queue->lock);
283 while (received < budget && (skb = __skb_dequeue(&process_queue))) {
284 napi_gro_receive(napi, skb);
288 if (!skb_queue_empty(&process_queue)) {
289 spin_lock(&queue->lock);
290 skb_queue_splice(&process_queue, queue);
291 spin_unlock(&queue->lock);
297 static int tun_napi_poll(struct napi_struct *napi, int budget)
299 unsigned int received;
301 received = tun_napi_receive(napi, budget);
303 if (received < budget)
304 napi_complete_done(napi, received);
309 static void tun_napi_init(struct tun_struct *tun, struct tun_file *tfile,
312 tfile->napi_enabled = napi_en;
314 netif_napi_add(tun->dev, &tfile->napi, tun_napi_poll,
316 napi_enable(&tfile->napi);
317 mutex_init(&tfile->napi_mutex);
321 static void tun_napi_disable(struct tun_struct *tun, struct tun_file *tfile)
323 if (tfile->napi_enabled)
324 napi_disable(&tfile->napi);
327 static void tun_napi_del(struct tun_struct *tun, struct tun_file *tfile)
329 if (tfile->napi_enabled)
330 netif_napi_del(&tfile->napi);
333 static bool tun_napi_frags_enabled(const struct tun_struct *tun)
335 return READ_ONCE(tun->flags) & IFF_NAPI_FRAGS;
338 #ifdef CONFIG_TUN_VNET_CROSS_LE
339 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
341 return tun->flags & TUN_VNET_BE ? false :
342 virtio_legacy_is_little_endian();
345 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
347 int be = !!(tun->flags & TUN_VNET_BE);
349 if (put_user(be, argp))
355 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
359 if (get_user(be, argp))
363 tun->flags |= TUN_VNET_BE;
365 tun->flags &= ~TUN_VNET_BE;
370 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
372 return virtio_legacy_is_little_endian();
375 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
380 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
384 #endif /* CONFIG_TUN_VNET_CROSS_LE */
386 static inline bool tun_is_little_endian(struct tun_struct *tun)
388 return tun->flags & TUN_VNET_LE ||
389 tun_legacy_is_little_endian(tun);
392 static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
394 return __virtio16_to_cpu(tun_is_little_endian(tun), val);
397 static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
399 return __cpu_to_virtio16(tun_is_little_endian(tun), val);
402 static inline u32 tun_hashfn(u32 rxhash)
404 return rxhash & 0x3ff;
407 static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
409 struct tun_flow_entry *e;
411 hlist_for_each_entry_rcu(e, head, hash_link) {
412 if (e->rxhash == rxhash)
418 static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
419 struct hlist_head *head,
420 u32 rxhash, u16 queue_index)
422 struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
425 tun_debug(KERN_INFO, tun, "create flow: hash %u index %u\n",
426 rxhash, queue_index);
427 e->updated = jiffies;
430 e->queue_index = queue_index;
432 hlist_add_head_rcu(&e->hash_link, head);
438 static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
440 tun_debug(KERN_INFO, tun, "delete flow: hash %u index %u\n",
441 e->rxhash, e->queue_index);
442 hlist_del_rcu(&e->hash_link);
447 static void tun_flow_flush(struct tun_struct *tun)
451 spin_lock_bh(&tun->lock);
452 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
453 struct tun_flow_entry *e;
454 struct hlist_node *n;
456 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
457 tun_flow_delete(tun, e);
459 spin_unlock_bh(&tun->lock);
462 static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
466 spin_lock_bh(&tun->lock);
467 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
468 struct tun_flow_entry *e;
469 struct hlist_node *n;
471 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
472 if (e->queue_index == queue_index)
473 tun_flow_delete(tun, e);
476 spin_unlock_bh(&tun->lock);
479 static void tun_flow_cleanup(struct timer_list *t)
481 struct tun_struct *tun = from_timer(tun, t, flow_gc_timer);
482 unsigned long delay = tun->ageing_time;
483 unsigned long next_timer = jiffies + delay;
484 unsigned long count = 0;
487 tun_debug(KERN_INFO, tun, "tun_flow_cleanup\n");
489 spin_lock(&tun->lock);
490 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
491 struct tun_flow_entry *e;
492 struct hlist_node *n;
494 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
495 unsigned long this_timer;
497 this_timer = e->updated + delay;
498 if (time_before_eq(this_timer, jiffies)) {
499 tun_flow_delete(tun, e);
503 if (time_before(this_timer, next_timer))
504 next_timer = this_timer;
509 mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
510 spin_unlock(&tun->lock);
513 static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
514 struct tun_file *tfile)
516 struct hlist_head *head;
517 struct tun_flow_entry *e;
518 unsigned long delay = tun->ageing_time;
519 u16 queue_index = tfile->queue_index;
524 head = &tun->flows[tun_hashfn(rxhash)];
528 /* We may get a very small possibility of OOO during switching, not
529 * worth to optimize.*/
530 if (tun->numqueues == 1 || tfile->detached)
533 e = tun_flow_find(head, rxhash);
535 /* TODO: keep queueing to old queue until it's empty? */
536 e->queue_index = queue_index;
537 e->updated = jiffies;
538 sock_rps_record_flow_hash(e->rps_rxhash);
540 spin_lock_bh(&tun->lock);
541 if (!tun_flow_find(head, rxhash) &&
542 tun->flow_count < MAX_TAP_FLOWS)
543 tun_flow_create(tun, head, rxhash, queue_index);
545 if (!timer_pending(&tun->flow_gc_timer))
546 mod_timer(&tun->flow_gc_timer,
547 round_jiffies_up(jiffies + delay));
548 spin_unlock_bh(&tun->lock);
556 * Save the hash received in the stack receive path and update the
557 * flow_hash table accordingly.
559 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry *e, u32 hash)
561 if (unlikely(e->rps_rxhash != hash))
562 e->rps_rxhash = hash;
565 /* We try to identify a flow through its rxhash first. The reason that
566 * we do not check rxq no. is because some cards(e.g 82599), chooses
567 * the rxq based on the txq where the last packet of the flow comes. As
568 * the userspace application move between processors, we may get a
569 * different rxq no. here. If we could not get rxhash, then we would
570 * hope the rxq no. may help here.
572 static u16 tun_automq_select_queue(struct tun_struct *tun, struct sk_buff *skb)
574 struct tun_flow_entry *e;
578 numqueues = READ_ONCE(tun->numqueues);
580 txq = __skb_get_hash_symmetric(skb);
582 e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
584 tun_flow_save_rps_rxhash(e, txq);
585 txq = e->queue_index;
587 /* use multiply and shift instead of expensive divide */
588 txq = ((u64)txq * numqueues) >> 32;
589 } else if (likely(skb_rx_queue_recorded(skb))) {
590 txq = skb_get_rx_queue(skb);
591 while (unlikely(txq >= numqueues))
598 static u16 tun_ebpf_select_queue(struct tun_struct *tun, struct sk_buff *skb)
600 struct tun_prog *prog;
603 prog = rcu_dereference(tun->steering_prog);
605 ret = bpf_prog_run_clear_cb(prog->prog, skb);
607 return ret % tun->numqueues;
610 static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb,
611 void *accel_priv, select_queue_fallback_t fallback)
613 struct tun_struct *tun = netdev_priv(dev);
617 if (rcu_dereference(tun->steering_prog))
618 ret = tun_ebpf_select_queue(tun, skb);
620 ret = tun_automq_select_queue(tun, skb);
626 static inline bool tun_not_capable(struct tun_struct *tun)
628 const struct cred *cred = current_cred();
629 struct net *net = dev_net(tun->dev);
631 return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
632 (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
633 !ns_capable(net->user_ns, CAP_NET_ADMIN);
636 static void tun_set_real_num_queues(struct tun_struct *tun)
638 netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
639 netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
642 static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
644 tfile->detached = tun;
645 list_add_tail(&tfile->next, &tun->disabled);
649 static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
651 struct tun_struct *tun = tfile->detached;
653 tfile->detached = NULL;
654 list_del_init(&tfile->next);
659 static void tun_ptr_free(void *ptr)
663 if (tun_is_xdp_buff(ptr)) {
664 struct xdp_buff *xdp = tun_ptr_to_xdp(ptr);
666 put_page(virt_to_head_page(xdp->data));
668 __skb_array_destroy_skb(ptr);
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 size_t fragsz = it->iov[i].iov_len;
1493 unsigned long offset;
1497 if (fragsz == 0 || fragsz > PAGE_SIZE) {
1503 data = napi_alloc_frag(fragsz);
1510 page = virt_to_head_page(data);
1511 offset = data - page_address(page);
1512 skb_fill_page_desc(skb, i - 1, page, offset, fragsz);
1517 /* frees skb and all frags allocated with napi_alloc_frag() */
1518 napi_free_frags(&tfile->napi);
1519 return ERR_PTR(err);
1522 /* prepad is the amount to reserve at front. len is length after that.
1523 * linear is a hint as to how much to copy (usually headers). */
1524 static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
1525 size_t prepad, size_t len,
1526 size_t linear, int noblock)
1528 struct sock *sk = tfile->socket.sk;
1529 struct sk_buff *skb;
1532 /* Under a page? Don't bother with paged skb. */
1533 if (prepad + len < PAGE_SIZE || !linear)
1536 skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
1539 return ERR_PTR(err);
1541 skb_reserve(skb, prepad);
1542 skb_put(skb, linear);
1543 skb->data_len = len - linear;
1544 skb->len += len - linear;
1549 static void tun_rx_batched(struct tun_struct *tun, struct tun_file *tfile,
1550 struct sk_buff *skb, int more)
1552 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1553 struct sk_buff_head process_queue;
1554 u32 rx_batched = tun->rx_batched;
1557 if (!rx_batched || (!more && skb_queue_empty(queue))) {
1559 netif_receive_skb(skb);
1564 spin_lock(&queue->lock);
1565 if (!more || skb_queue_len(queue) == rx_batched) {
1566 __skb_queue_head_init(&process_queue);
1567 skb_queue_splice_tail_init(queue, &process_queue);
1570 __skb_queue_tail(queue, skb);
1572 spin_unlock(&queue->lock);
1575 struct sk_buff *nskb;
1578 while ((nskb = __skb_dequeue(&process_queue)))
1579 netif_receive_skb(nskb);
1580 netif_receive_skb(skb);
1585 static bool tun_can_build_skb(struct tun_struct *tun, struct tun_file *tfile,
1586 int len, int noblock, bool zerocopy)
1588 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
1591 if (tfile->socket.sk->sk_sndbuf != INT_MAX)
1600 if (SKB_DATA_ALIGN(len + TUN_RX_PAD) +
1601 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
1607 static struct sk_buff *tun_build_skb(struct tun_struct *tun,
1608 struct tun_file *tfile,
1609 struct iov_iter *from,
1610 struct virtio_net_hdr *hdr,
1611 int len, int *skb_xdp)
1613 struct page_frag *alloc_frag = ¤t->task_frag;
1614 struct sk_buff *skb;
1615 struct bpf_prog *xdp_prog;
1616 int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
1617 unsigned int delta = 0;
1620 bool xdp_xmit = false;
1621 int err, pad = TUN_RX_PAD;
1624 xdp_prog = rcu_dereference(tun->xdp_prog);
1626 pad += TUN_HEADROOM;
1627 buflen += SKB_DATA_ALIGN(len + pad);
1630 alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
1631 if (unlikely(!skb_page_frag_refill(buflen, alloc_frag, GFP_KERNEL)))
1632 return ERR_PTR(-ENOMEM);
1634 buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
1635 copied = copy_page_from_iter(alloc_frag->page,
1636 alloc_frag->offset + pad,
1639 return ERR_PTR(-EFAULT);
1641 /* There's a small window that XDP may be set after the check
1642 * of xdp_prog above, this should be rare and for simplicity
1643 * we do XDP on skb in case the headroom is not enough.
1645 if (hdr->gso_type || !xdp_prog)
1651 xdp_prog = rcu_dereference(tun->xdp_prog);
1652 if (xdp_prog && !*skb_xdp) {
1653 struct xdp_buff xdp;
1657 xdp.data_hard_start = buf;
1658 xdp.data = buf + pad;
1659 xdp_set_data_meta_invalid(&xdp);
1660 xdp.data_end = xdp.data + len;
1661 xdp.rxq = &tfile->xdp_rxq;
1662 orig_data = xdp.data;
1663 act = bpf_prog_run_xdp(xdp_prog, &xdp);
1667 get_page(alloc_frag->page);
1668 alloc_frag->offset += buflen;
1669 ++tfile->xdp_pending_pkts;
1670 err = xdp_do_redirect(tun->dev, &xdp, xdp_prog);
1679 delta = orig_data - xdp.data;
1682 bpf_warn_invalid_xdp_action(act);
1685 trace_xdp_exception(tun->dev, xdp_prog, act);
1692 skb = build_skb(buf, buflen);
1695 return ERR_PTR(-ENOMEM);
1698 skb_reserve(skb, pad - delta);
1699 skb_put(skb, len + delta);
1700 get_page(alloc_frag->page);
1701 alloc_frag->offset += buflen;
1704 skb->dev = tun->dev;
1705 generic_xdp_tx(skb, xdp_prog);
1715 put_page(alloc_frag->page);
1718 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1722 /* Get packet from user space buffer */
1723 static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
1724 void *msg_control, struct iov_iter *from,
1725 int noblock, bool more)
1727 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1728 struct sk_buff *skb;
1729 size_t total_len = iov_iter_count(from);
1730 size_t len = total_len, align = tun->align, linear;
1731 struct virtio_net_hdr gso = { 0 };
1732 struct tun_pcpu_stats *stats;
1735 bool zerocopy = false;
1739 bool frags = tun_napi_frags_enabled(tun);
1741 if (!(tun->dev->flags & IFF_UP))
1744 if (!(tun->flags & IFF_NO_PI)) {
1745 if (len < sizeof(pi))
1749 if (!copy_from_iter_full(&pi, sizeof(pi), from))
1753 if (tun->flags & IFF_VNET_HDR) {
1754 int vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1756 if (len < vnet_hdr_sz)
1760 if (!copy_from_iter_full(&gso, sizeof(gso), from))
1763 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
1764 tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1765 gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
1767 if (tun16_to_cpu(tun, gso.hdr_len) > len)
1769 iov_iter_advance(from, vnet_hdr_sz - sizeof(gso));
1772 if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
1773 align += NET_IP_ALIGN;
1774 if (unlikely(len < ETH_HLEN ||
1775 (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
1779 good_linear = SKB_MAX_HEAD(align);
1782 struct iov_iter i = *from;
1784 /* There are 256 bytes to be copied in skb, so there is
1785 * enough room for skb expand head in case it is used.
1786 * The rest of the buffer is mapped from userspace.
1788 copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
1789 if (copylen > good_linear)
1790 copylen = good_linear;
1792 iov_iter_advance(&i, copylen);
1793 if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
1797 if (!frags && tun_can_build_skb(tun, tfile, len, noblock, zerocopy)) {
1798 /* For the packet that is not easy to be processed
1799 * (e.g gso or jumbo packet), we will do it at after
1800 * skb was created with generic XDP routine.
1802 skb = tun_build_skb(tun, tfile, from, &gso, len, &skb_xdp);
1804 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1805 return PTR_ERR(skb);
1812 if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1813 linear = good_linear;
1815 linear = tun16_to_cpu(tun, gso.hdr_len);
1819 mutex_lock(&tfile->napi_mutex);
1820 skb = tun_napi_alloc_frags(tfile, copylen, from);
1821 /* tun_napi_alloc_frags() enforces a layout for the skb.
1822 * If zerocopy is enabled, then this layout will be
1823 * overwritten by zerocopy_sg_from_iter().
1827 skb = tun_alloc_skb(tfile, align, copylen, linear,
1832 if (PTR_ERR(skb) != -EAGAIN)
1833 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1835 mutex_unlock(&tfile->napi_mutex);
1836 return PTR_ERR(skb);
1840 err = zerocopy_sg_from_iter(skb, from);
1842 err = skb_copy_datagram_from_iter(skb, 0, from, len);
1845 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1848 tfile->napi.skb = NULL;
1849 mutex_unlock(&tfile->napi_mutex);
1856 if (virtio_net_hdr_to_skb(skb, &gso, tun_is_little_endian(tun))) {
1857 this_cpu_inc(tun->pcpu_stats->rx_frame_errors);
1860 tfile->napi.skb = NULL;
1861 mutex_unlock(&tfile->napi_mutex);
1867 switch (tun->flags & TUN_TYPE_MASK) {
1869 if (tun->flags & IFF_NO_PI) {
1870 u8 ip_version = skb->len ? (skb->data[0] >> 4) : 0;
1872 switch (ip_version) {
1874 pi.proto = htons(ETH_P_IP);
1877 pi.proto = htons(ETH_P_IPV6);
1880 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1886 skb_reset_mac_header(skb);
1887 skb->protocol = pi.proto;
1888 skb->dev = tun->dev;
1892 skb->protocol = eth_type_trans(skb, tun->dev);
1896 /* copy skb_ubuf_info for callback when skb has no error */
1898 skb_shinfo(skb)->destructor_arg = msg_control;
1899 skb_shinfo(skb)->tx_flags |= SKBTX_DEV_ZEROCOPY;
1900 skb_shinfo(skb)->tx_flags |= SKBTX_SHARED_FRAG;
1901 } else if (msg_control) {
1902 struct ubuf_info *uarg = msg_control;
1903 uarg->callback(uarg, false);
1906 skb_reset_network_header(skb);
1907 skb_probe_transport_header(skb, 0);
1910 struct bpf_prog *xdp_prog;
1914 xdp_prog = rcu_dereference(tun->xdp_prog);
1916 ret = do_xdp_generic(xdp_prog, skb);
1917 if (ret != XDP_PASS) {
1926 if (!rcu_dereference(tun->steering_prog))
1927 rxhash = __skb_get_hash_symmetric(skb);
1931 /* Exercise flow dissector code path. */
1932 u32 headlen = eth_get_headlen(skb->data, skb_headlen(skb));
1934 if (unlikely(headlen > skb_headlen(skb))) {
1935 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1936 napi_free_frags(&tfile->napi);
1937 mutex_unlock(&tfile->napi_mutex);
1943 napi_gro_frags(&tfile->napi);
1945 mutex_unlock(&tfile->napi_mutex);
1946 } else if (tfile->napi_enabled) {
1947 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1950 spin_lock_bh(&queue->lock);
1951 __skb_queue_tail(queue, skb);
1952 queue_len = skb_queue_len(queue);
1953 spin_unlock(&queue->lock);
1955 if (!more || queue_len > NAPI_POLL_WEIGHT)
1956 napi_schedule(&tfile->napi);
1959 } else if (!IS_ENABLED(CONFIG_4KSTACKS)) {
1960 tun_rx_batched(tun, tfile, skb, more);
1965 stats = get_cpu_ptr(tun->pcpu_stats);
1966 u64_stats_update_begin(&stats->syncp);
1967 stats->rx_packets++;
1968 stats->rx_bytes += len;
1969 u64_stats_update_end(&stats->syncp);
1973 tun_flow_update(tun, rxhash, tfile);
1978 static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
1980 struct file *file = iocb->ki_filp;
1981 struct tun_file *tfile = file->private_data;
1982 struct tun_struct *tun = tun_get(tfile);
1988 result = tun_get_user(tun, tfile, NULL, from,
1989 file->f_flags & O_NONBLOCK, false);
1991 if (tfile->xdp_pending_pkts) {
1992 tfile->xdp_pending_pkts = 0;
2000 static ssize_t tun_put_user_xdp(struct tun_struct *tun,
2001 struct tun_file *tfile,
2002 struct xdp_buff *xdp,
2003 struct iov_iter *iter)
2005 int vnet_hdr_sz = 0;
2006 size_t size = xdp->data_end - xdp->data;
2007 struct tun_pcpu_stats *stats;
2010 if (tun->flags & IFF_VNET_HDR) {
2011 struct virtio_net_hdr gso = { 0 };
2013 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2014 if (unlikely(iov_iter_count(iter) < vnet_hdr_sz))
2016 if (unlikely(copy_to_iter(&gso, sizeof(gso), iter) !=
2019 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2022 ret = copy_to_iter(xdp->data, size, iter) + vnet_hdr_sz;
2024 stats = get_cpu_ptr(tun->pcpu_stats);
2025 u64_stats_update_begin(&stats->syncp);
2026 stats->tx_packets++;
2027 stats->tx_bytes += ret;
2028 u64_stats_update_end(&stats->syncp);
2029 put_cpu_ptr(tun->pcpu_stats);
2034 /* Put packet to the user space buffer */
2035 static ssize_t tun_put_user(struct tun_struct *tun,
2036 struct tun_file *tfile,
2037 struct sk_buff *skb,
2038 struct iov_iter *iter)
2040 struct tun_pi pi = { 0, skb->protocol };
2041 struct tun_pcpu_stats *stats;
2043 int vlan_offset = 0;
2045 int vnet_hdr_sz = 0;
2047 if (skb_vlan_tag_present(skb))
2048 vlan_hlen = VLAN_HLEN;
2050 if (tun->flags & IFF_VNET_HDR)
2051 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2053 total = skb->len + vlan_hlen + vnet_hdr_sz;
2055 if (!(tun->flags & IFF_NO_PI)) {
2056 if (iov_iter_count(iter) < sizeof(pi))
2059 total += sizeof(pi);
2060 if (iov_iter_count(iter) < total) {
2061 /* Packet will be striped */
2062 pi.flags |= TUN_PKT_STRIP;
2065 if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
2070 struct virtio_net_hdr gso;
2072 if (iov_iter_count(iter) < vnet_hdr_sz)
2075 if (virtio_net_hdr_from_skb(skb, &gso,
2076 tun_is_little_endian(tun), true)) {
2077 struct skb_shared_info *sinfo = skb_shinfo(skb);
2078 pr_err("unexpected GSO type: "
2079 "0x%x, gso_size %d, hdr_len %d\n",
2080 sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
2081 tun16_to_cpu(tun, gso.hdr_len));
2082 print_hex_dump(KERN_ERR, "tun: ",
2085 min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
2090 if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
2093 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2100 veth.h_vlan_proto = skb->vlan_proto;
2101 veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
2103 vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
2105 ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
2106 if (ret || !iov_iter_count(iter))
2109 ret = copy_to_iter(&veth, sizeof(veth), iter);
2110 if (ret != sizeof(veth) || !iov_iter_count(iter))
2114 skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
2117 /* caller is in process context, */
2118 stats = get_cpu_ptr(tun->pcpu_stats);
2119 u64_stats_update_begin(&stats->syncp);
2120 stats->tx_packets++;
2121 stats->tx_bytes += skb->len + vlan_hlen;
2122 u64_stats_update_end(&stats->syncp);
2123 put_cpu_ptr(tun->pcpu_stats);
2128 static void *tun_ring_recv(struct tun_file *tfile, int noblock, int *err)
2130 DECLARE_WAITQUEUE(wait, current);
2134 ptr = ptr_ring_consume(&tfile->tx_ring);
2142 add_wait_queue(&tfile->wq.wait, &wait);
2143 current->state = TASK_INTERRUPTIBLE;
2146 ptr = ptr_ring_consume(&tfile->tx_ring);
2149 if (signal_pending(current)) {
2150 error = -ERESTARTSYS;
2153 if (tfile->socket.sk->sk_shutdown & RCV_SHUTDOWN) {
2161 current->state = TASK_RUNNING;
2162 remove_wait_queue(&tfile->wq.wait, &wait);
2169 static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
2170 struct iov_iter *to,
2171 int noblock, void *ptr)
2176 tun_debug(KERN_INFO, tun, "tun_do_read\n");
2178 if (!iov_iter_count(to)) {
2184 /* Read frames from ring */
2185 ptr = tun_ring_recv(tfile, noblock, &err);
2190 if (tun_is_xdp_buff(ptr)) {
2191 struct xdp_buff *xdp = tun_ptr_to_xdp(ptr);
2193 ret = tun_put_user_xdp(tun, tfile, xdp, to);
2194 put_page(virt_to_head_page(xdp->data));
2196 struct sk_buff *skb = ptr;
2198 ret = tun_put_user(tun, tfile, skb, to);
2199 if (unlikely(ret < 0))
2208 static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
2210 struct file *file = iocb->ki_filp;
2211 struct tun_file *tfile = file->private_data;
2212 struct tun_struct *tun = tun_get(tfile);
2213 ssize_t len = iov_iter_count(to), ret;
2217 ret = tun_do_read(tun, tfile, to, file->f_flags & O_NONBLOCK, NULL);
2218 ret = min_t(ssize_t, ret, len);
2225 static void tun_prog_free(struct rcu_head *rcu)
2227 struct tun_prog *prog = container_of(rcu, struct tun_prog, rcu);
2229 bpf_prog_destroy(prog->prog);
2233 static int __tun_set_ebpf(struct tun_struct *tun,
2234 struct tun_prog __rcu **prog_p,
2235 struct bpf_prog *prog)
2237 struct tun_prog *old, *new = NULL;
2240 new = kmalloc(sizeof(*new), GFP_KERNEL);
2246 spin_lock_bh(&tun->lock);
2247 old = rcu_dereference_protected(*prog_p,
2248 lockdep_is_held(&tun->lock));
2249 rcu_assign_pointer(*prog_p, new);
2250 spin_unlock_bh(&tun->lock);
2253 call_rcu(&old->rcu, tun_prog_free);
2258 static void tun_free_netdev(struct net_device *dev)
2260 struct tun_struct *tun = netdev_priv(dev);
2262 BUG_ON(!(list_empty(&tun->disabled)));
2263 free_percpu(tun->pcpu_stats);
2264 tun_flow_uninit(tun);
2265 security_tun_dev_free_security(tun->security);
2266 __tun_set_ebpf(tun, &tun->steering_prog, NULL);
2267 __tun_set_ebpf(tun, &tun->filter_prog, NULL);
2270 static void tun_setup(struct net_device *dev)
2272 struct tun_struct *tun = netdev_priv(dev);
2274 tun->owner = INVALID_UID;
2275 tun->group = INVALID_GID;
2277 dev->ethtool_ops = &tun_ethtool_ops;
2278 dev->needs_free_netdev = true;
2279 dev->priv_destructor = tun_free_netdev;
2280 /* We prefer our own queue length */
2281 dev->tx_queue_len = TUN_READQ_SIZE;
2284 /* Trivial set of netlink ops to allow deleting tun or tap
2285 * device with netlink.
2287 static int tun_validate(struct nlattr *tb[], struct nlattr *data[],
2288 struct netlink_ext_ack *extack)
2293 static struct rtnl_link_ops tun_link_ops __read_mostly = {
2295 .priv_size = sizeof(struct tun_struct),
2297 .validate = tun_validate,
2300 static void tun_sock_write_space(struct sock *sk)
2302 struct tun_file *tfile;
2303 wait_queue_head_t *wqueue;
2305 if (!sock_writeable(sk))
2308 if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
2311 wqueue = sk_sleep(sk);
2312 if (wqueue && waitqueue_active(wqueue))
2313 wake_up_interruptible_sync_poll(wqueue, EPOLLOUT |
2314 EPOLLWRNORM | EPOLLWRBAND);
2316 tfile = container_of(sk, struct tun_file, sk);
2317 kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
2320 static int tun_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
2323 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2324 struct tun_struct *tun = tun_get(tfile);
2329 ret = tun_get_user(tun, tfile, m->msg_control, &m->msg_iter,
2330 m->msg_flags & MSG_DONTWAIT,
2331 m->msg_flags & MSG_MORE);
2333 if (tfile->xdp_pending_pkts >= NAPI_POLL_WEIGHT ||
2334 !(m->msg_flags & MSG_MORE)) {
2335 tfile->xdp_pending_pkts = 0;
2343 static int tun_recvmsg(struct socket *sock, struct msghdr *m, size_t total_len,
2346 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2347 struct tun_struct *tun = tun_get(tfile);
2348 void *ptr = m->msg_control;
2356 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
2360 if (flags & MSG_ERRQUEUE) {
2361 ret = sock_recv_errqueue(sock->sk, m, total_len,
2362 SOL_PACKET, TUN_TX_TIMESTAMP);
2365 ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT, ptr);
2366 if (ret > (ssize_t)total_len) {
2367 m->msg_flags |= MSG_TRUNC;
2368 ret = flags & MSG_TRUNC ? ret : total_len;
2381 static int tun_ptr_peek_len(void *ptr)
2384 if (tun_is_xdp_buff(ptr)) {
2385 struct xdp_buff *xdp = tun_ptr_to_xdp(ptr);
2387 return xdp->data_end - xdp->data;
2389 return __skb_array_len_with_tag(ptr);
2395 static int tun_peek_len(struct socket *sock)
2397 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2398 struct tun_struct *tun;
2401 tun = tun_get(tfile);
2405 ret = PTR_RING_PEEK_CALL(&tfile->tx_ring, tun_ptr_peek_len);
2411 /* Ops structure to mimic raw sockets with tun */
2412 static const struct proto_ops tun_socket_ops = {
2413 .peek_len = tun_peek_len,
2414 .sendmsg = tun_sendmsg,
2415 .recvmsg = tun_recvmsg,
2418 static struct proto tun_proto = {
2420 .owner = THIS_MODULE,
2421 .obj_size = sizeof(struct tun_file),
2424 static int tun_flags(struct tun_struct *tun)
2426 return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
2429 static ssize_t tun_show_flags(struct device *dev, struct device_attribute *attr,
2432 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2433 return sprintf(buf, "0x%x\n", tun_flags(tun));
2436 static ssize_t tun_show_owner(struct device *dev, struct device_attribute *attr,
2439 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2440 return uid_valid(tun->owner)?
2441 sprintf(buf, "%u\n",
2442 from_kuid_munged(current_user_ns(), tun->owner)):
2443 sprintf(buf, "-1\n");
2446 static ssize_t tun_show_group(struct device *dev, struct device_attribute *attr,
2449 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2450 return gid_valid(tun->group) ?
2451 sprintf(buf, "%u\n",
2452 from_kgid_munged(current_user_ns(), tun->group)):
2453 sprintf(buf, "-1\n");
2456 static DEVICE_ATTR(tun_flags, 0444, tun_show_flags, NULL);
2457 static DEVICE_ATTR(owner, 0444, tun_show_owner, NULL);
2458 static DEVICE_ATTR(group, 0444, tun_show_group, NULL);
2460 static struct attribute *tun_dev_attrs[] = {
2461 &dev_attr_tun_flags.attr,
2462 &dev_attr_owner.attr,
2463 &dev_attr_group.attr,
2467 static const struct attribute_group tun_attr_group = {
2468 .attrs = tun_dev_attrs
2471 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
2473 struct tun_struct *tun;
2474 struct tun_file *tfile = file->private_data;
2475 struct net_device *dev;
2478 if (tfile->detached)
2481 if ((ifr->ifr_flags & IFF_NAPI_FRAGS)) {
2482 if (!capable(CAP_NET_ADMIN))
2485 if (!(ifr->ifr_flags & IFF_NAPI) ||
2486 (ifr->ifr_flags & TUN_TYPE_MASK) != IFF_TAP)
2490 dev = __dev_get_by_name(net, ifr->ifr_name);
2492 if (ifr->ifr_flags & IFF_TUN_EXCL)
2494 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
2495 tun = netdev_priv(dev);
2496 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
2497 tun = netdev_priv(dev);
2501 if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
2502 !!(tun->flags & IFF_MULTI_QUEUE))
2505 if (tun_not_capable(tun))
2507 err = security_tun_dev_open(tun->security);
2511 err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER,
2512 ifr->ifr_flags & IFF_NAPI);
2516 if (tun->flags & IFF_MULTI_QUEUE &&
2517 (tun->numqueues + tun->numdisabled > 1)) {
2518 /* One or more queue has already been attached, no need
2519 * to initialize the device again.
2526 unsigned long flags = 0;
2527 int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
2530 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
2532 err = security_tun_dev_create();
2537 if (ifr->ifr_flags & IFF_TUN) {
2541 } else if (ifr->ifr_flags & IFF_TAP) {
2549 name = ifr->ifr_name;
2551 dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
2552 NET_NAME_UNKNOWN, tun_setup, queues,
2557 err = dev_get_valid_name(net, dev, name);
2561 dev_net_set(dev, net);
2562 dev->rtnl_link_ops = &tun_link_ops;
2563 dev->ifindex = tfile->ifindex;
2564 dev->sysfs_groups[0] = &tun_attr_group;
2566 tun = netdev_priv(dev);
2569 tun->txflt.count = 0;
2570 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
2572 tun->align = NET_SKB_PAD;
2573 tun->filter_attached = false;
2574 tun->sndbuf = tfile->socket.sk->sk_sndbuf;
2575 tun->rx_batched = 0;
2576 RCU_INIT_POINTER(tun->steering_prog, NULL);
2578 tun->pcpu_stats = netdev_alloc_pcpu_stats(struct tun_pcpu_stats);
2579 if (!tun->pcpu_stats) {
2584 spin_lock_init(&tun->lock);
2586 err = security_tun_dev_alloc_security(&tun->security);
2593 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
2594 TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
2595 NETIF_F_HW_VLAN_STAG_TX;
2596 dev->features = dev->hw_features | NETIF_F_LLTX;
2597 dev->vlan_features = dev->features &
2598 ~(NETIF_F_HW_VLAN_CTAG_TX |
2599 NETIF_F_HW_VLAN_STAG_TX);
2601 INIT_LIST_HEAD(&tun->disabled);
2602 err = tun_attach(tun, file, false, ifr->ifr_flags & IFF_NAPI);
2606 err = register_netdevice(tun->dev);
2611 netif_carrier_on(tun->dev);
2613 tun_debug(KERN_INFO, tun, "tun_set_iff\n");
2615 tun->flags = (tun->flags & ~TUN_FEATURES) |
2616 (ifr->ifr_flags & TUN_FEATURES);
2618 /* Make sure persistent devices do not get stuck in
2621 if (netif_running(tun->dev))
2622 netif_tx_wake_all_queues(tun->dev);
2624 strcpy(ifr->ifr_name, tun->dev->name);
2628 tun_detach_all(dev);
2629 /* register_netdevice() already called tun_free_netdev() */
2633 tun_flow_uninit(tun);
2634 security_tun_dev_free_security(tun->security);
2636 free_percpu(tun->pcpu_stats);
2642 static void tun_get_iff(struct net *net, struct tun_struct *tun,
2645 tun_debug(KERN_INFO, tun, "tun_get_iff\n");
2647 strcpy(ifr->ifr_name, tun->dev->name);
2649 ifr->ifr_flags = tun_flags(tun);
2653 /* This is like a cut-down ethtool ops, except done via tun fd so no
2654 * privs required. */
2655 static int set_offload(struct tun_struct *tun, unsigned long arg)
2657 netdev_features_t features = 0;
2659 if (arg & TUN_F_CSUM) {
2660 features |= NETIF_F_HW_CSUM;
2663 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
2664 if (arg & TUN_F_TSO_ECN) {
2665 features |= NETIF_F_TSO_ECN;
2666 arg &= ~TUN_F_TSO_ECN;
2668 if (arg & TUN_F_TSO4)
2669 features |= NETIF_F_TSO;
2670 if (arg & TUN_F_TSO6)
2671 features |= NETIF_F_TSO6;
2672 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
2678 /* This gives the user a way to test for new features in future by
2679 * trying to set them. */
2683 tun->set_features = features;
2684 tun->dev->wanted_features &= ~TUN_USER_FEATURES;
2685 tun->dev->wanted_features |= features;
2686 netdev_update_features(tun->dev);
2691 static void tun_detach_filter(struct tun_struct *tun, int n)
2694 struct tun_file *tfile;
2696 for (i = 0; i < n; i++) {
2697 tfile = rtnl_dereference(tun->tfiles[i]);
2698 lock_sock(tfile->socket.sk);
2699 sk_detach_filter(tfile->socket.sk);
2700 release_sock(tfile->socket.sk);
2703 tun->filter_attached = false;
2706 static int tun_attach_filter(struct tun_struct *tun)
2709 struct tun_file *tfile;
2711 for (i = 0; i < tun->numqueues; i++) {
2712 tfile = rtnl_dereference(tun->tfiles[i]);
2713 lock_sock(tfile->socket.sk);
2714 ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
2715 release_sock(tfile->socket.sk);
2717 tun_detach_filter(tun, i);
2722 tun->filter_attached = true;
2726 static void tun_set_sndbuf(struct tun_struct *tun)
2728 struct tun_file *tfile;
2731 for (i = 0; i < tun->numqueues; i++) {
2732 tfile = rtnl_dereference(tun->tfiles[i]);
2733 tfile->socket.sk->sk_sndbuf = tun->sndbuf;
2737 static int tun_set_queue(struct file *file, struct ifreq *ifr)
2739 struct tun_file *tfile = file->private_data;
2740 struct tun_struct *tun;
2745 if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
2746 tun = tfile->detached;
2751 ret = security_tun_dev_attach_queue(tun->security);
2754 ret = tun_attach(tun, file, false, tun->flags & IFF_NAPI);
2755 } else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
2756 tun = rtnl_dereference(tfile->tun);
2757 if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
2760 __tun_detach(tfile, false);
2769 static int tun_set_ebpf(struct tun_struct *tun, struct tun_prog **prog_p,
2772 struct bpf_prog *prog;
2775 if (copy_from_user(&fd, data, sizeof(fd)))
2781 prog = bpf_prog_get_type(fd, BPF_PROG_TYPE_SOCKET_FILTER);
2783 return PTR_ERR(prog);
2786 return __tun_set_ebpf(tun, prog_p, prog);
2789 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
2790 unsigned long arg, int ifreq_len)
2792 struct tun_file *tfile = file->private_data;
2793 struct tun_struct *tun;
2794 void __user* argp = (void __user*)arg;
2800 unsigned int ifindex;
2804 if (cmd == TUNSETIFF || cmd == TUNSETQUEUE || _IOC_TYPE(cmd) == SOCK_IOC_TYPE) {
2805 if (copy_from_user(&ifr, argp, ifreq_len))
2808 memset(&ifr, 0, sizeof(ifr));
2810 if (cmd == TUNGETFEATURES) {
2811 /* Currently this just means: "what IFF flags are valid?".
2812 * This is needed because we never checked for invalid flags on
2815 return put_user(IFF_TUN | IFF_TAP | TUN_FEATURES,
2816 (unsigned int __user*)argp);
2817 } else if (cmd == TUNSETQUEUE)
2818 return tun_set_queue(file, &ifr);
2823 tun = tun_get(tfile);
2824 if (cmd == TUNSETIFF) {
2829 ifr.ifr_name[IFNAMSIZ-1] = '\0';
2831 ret = tun_set_iff(sock_net(&tfile->sk), file, &ifr);
2836 if (copy_to_user(argp, &ifr, ifreq_len))
2840 if (cmd == TUNSETIFINDEX) {
2846 if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
2850 tfile->ifindex = ifindex;
2858 tun_debug(KERN_INFO, tun, "tun_chr_ioctl cmd %u\n", cmd);
2863 tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
2865 if (tfile->detached)
2866 ifr.ifr_flags |= IFF_DETACH_QUEUE;
2867 if (!tfile->socket.sk->sk_filter)
2868 ifr.ifr_flags |= IFF_NOFILTER;
2870 if (copy_to_user(argp, &ifr, ifreq_len))
2875 /* Disable/Enable checksum */
2877 /* [unimplemented] */
2878 tun_debug(KERN_INFO, tun, "ignored: set checksum %s\n",
2879 arg ? "disabled" : "enabled");
2883 /* Disable/Enable persist mode. Keep an extra reference to the
2884 * module to prevent the module being unprobed.
2886 if (arg && !(tun->flags & IFF_PERSIST)) {
2887 tun->flags |= IFF_PERSIST;
2888 __module_get(THIS_MODULE);
2890 if (!arg && (tun->flags & IFF_PERSIST)) {
2891 tun->flags &= ~IFF_PERSIST;
2892 module_put(THIS_MODULE);
2895 tun_debug(KERN_INFO, tun, "persist %s\n",
2896 arg ? "enabled" : "disabled");
2900 /* Set owner of the device */
2901 owner = make_kuid(current_user_ns(), arg);
2902 if (!uid_valid(owner)) {
2907 tun_debug(KERN_INFO, tun, "owner set to %u\n",
2908 from_kuid(&init_user_ns, tun->owner));
2912 /* Set group of the device */
2913 group = make_kgid(current_user_ns(), arg);
2914 if (!gid_valid(group)) {
2919 tun_debug(KERN_INFO, tun, "group set to %u\n",
2920 from_kgid(&init_user_ns, tun->group));
2924 /* Only allow setting the type when the interface is down */
2925 if (tun->dev->flags & IFF_UP) {
2926 tun_debug(KERN_INFO, tun,
2927 "Linktype set failed because interface is up\n");
2930 tun->dev->type = (int) arg;
2931 tun_debug(KERN_INFO, tun, "linktype set to %d\n",
2943 ret = set_offload(tun, arg);
2946 case TUNSETTXFILTER:
2947 /* Can be set only for TAPs */
2949 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
2951 ret = update_filter(&tun->txflt, (void __user *)arg);
2955 /* Get hw address */
2956 memcpy(ifr.ifr_hwaddr.sa_data, tun->dev->dev_addr, ETH_ALEN);
2957 ifr.ifr_hwaddr.sa_family = tun->dev->type;
2958 if (copy_to_user(argp, &ifr, ifreq_len))
2963 /* Set hw address */
2964 tun_debug(KERN_DEBUG, tun, "set hw address: %pM\n",
2965 ifr.ifr_hwaddr.sa_data);
2967 ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr);
2971 sndbuf = tfile->socket.sk->sk_sndbuf;
2972 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
2977 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
2986 tun->sndbuf = sndbuf;
2987 tun_set_sndbuf(tun);
2990 case TUNGETVNETHDRSZ:
2991 vnet_hdr_sz = tun->vnet_hdr_sz;
2992 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
2996 case TUNSETVNETHDRSZ:
2997 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
3001 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
3006 tun->vnet_hdr_sz = vnet_hdr_sz;
3010 le = !!(tun->flags & TUN_VNET_LE);
3011 if (put_user(le, (int __user *)argp))
3016 if (get_user(le, (int __user *)argp)) {
3021 tun->flags |= TUN_VNET_LE;
3023 tun->flags &= ~TUN_VNET_LE;
3027 ret = tun_get_vnet_be(tun, argp);
3031 ret = tun_set_vnet_be(tun, argp);
3034 case TUNATTACHFILTER:
3035 /* Can be set only for TAPs */
3037 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3040 if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
3043 ret = tun_attach_filter(tun);
3046 case TUNDETACHFILTER:
3047 /* Can be set only for TAPs */
3049 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3052 tun_detach_filter(tun, tun->numqueues);
3057 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3060 if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
3065 case TUNSETSTEERINGEBPF:
3066 ret = tun_set_ebpf(tun, &tun->steering_prog, argp);
3069 case TUNSETFILTEREBPF:
3070 ret = tun_set_ebpf(tun, &tun->filter_prog, argp);
3085 static long tun_chr_ioctl(struct file *file,
3086 unsigned int cmd, unsigned long arg)
3088 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
3091 #ifdef CONFIG_COMPAT
3092 static long tun_chr_compat_ioctl(struct file *file,
3093 unsigned int cmd, unsigned long arg)
3098 case TUNSETTXFILTER:
3103 arg = (unsigned long)compat_ptr(arg);
3106 arg = (compat_ulong_t)arg;
3111 * compat_ifreq is shorter than ifreq, so we must not access beyond
3112 * the end of that structure. All fields that are used in this
3113 * driver are compatible though, we don't need to convert the
3116 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
3118 #endif /* CONFIG_COMPAT */
3120 static int tun_chr_fasync(int fd, struct file *file, int on)
3122 struct tun_file *tfile = file->private_data;
3125 if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
3129 __f_setown(file, task_pid(current), PIDTYPE_PID, 0);
3130 tfile->flags |= TUN_FASYNC;
3132 tfile->flags &= ~TUN_FASYNC;
3138 static int tun_chr_open(struct inode *inode, struct file * file)
3140 struct net *net = current->nsproxy->net_ns;
3141 struct tun_file *tfile;
3143 DBG1(KERN_INFO, "tunX: tun_chr_open\n");
3145 tfile = (struct tun_file *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
3149 RCU_INIT_POINTER(tfile->tun, NULL);
3153 init_waitqueue_head(&tfile->wq.wait);
3154 RCU_INIT_POINTER(tfile->socket.wq, &tfile->wq);
3156 tfile->socket.file = file;
3157 tfile->socket.ops = &tun_socket_ops;
3159 sock_init_data(&tfile->socket, &tfile->sk);
3161 tfile->sk.sk_write_space = tun_sock_write_space;
3162 tfile->sk.sk_sndbuf = INT_MAX;
3164 file->private_data = tfile;
3165 INIT_LIST_HEAD(&tfile->next);
3167 sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
3169 memset(&tfile->tx_ring, 0, sizeof(tfile->tx_ring));
3170 tfile->xdp_pending_pkts = 0;
3175 static int tun_chr_close(struct inode *inode, struct file *file)
3177 struct tun_file *tfile = file->private_data;
3179 tun_detach(tfile, true);
3184 #ifdef CONFIG_PROC_FS
3185 static void tun_chr_show_fdinfo(struct seq_file *m, struct file *file)
3187 struct tun_file *tfile = file->private_data;
3188 struct tun_struct *tun;
3191 memset(&ifr, 0, sizeof(ifr));
3194 tun = tun_get(tfile);
3196 tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
3202 seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
3206 static const struct file_operations tun_fops = {
3207 .owner = THIS_MODULE,
3208 .llseek = no_llseek,
3209 .read_iter = tun_chr_read_iter,
3210 .write_iter = tun_chr_write_iter,
3211 .poll = tun_chr_poll,
3212 .unlocked_ioctl = tun_chr_ioctl,
3213 #ifdef CONFIG_COMPAT
3214 .compat_ioctl = tun_chr_compat_ioctl,
3216 .open = tun_chr_open,
3217 .release = tun_chr_close,
3218 .fasync = tun_chr_fasync,
3219 #ifdef CONFIG_PROC_FS
3220 .show_fdinfo = tun_chr_show_fdinfo,
3224 static struct miscdevice tun_miscdev = {
3227 .nodename = "net/tun",
3231 /* ethtool interface */
3233 static int tun_get_link_ksettings(struct net_device *dev,
3234 struct ethtool_link_ksettings *cmd)
3236 ethtool_link_ksettings_zero_link_mode(cmd, supported);
3237 ethtool_link_ksettings_zero_link_mode(cmd, advertising);
3238 cmd->base.speed = SPEED_10;
3239 cmd->base.duplex = DUPLEX_FULL;
3240 cmd->base.port = PORT_TP;
3241 cmd->base.phy_address = 0;
3242 cmd->base.autoneg = AUTONEG_DISABLE;
3246 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
3248 struct tun_struct *tun = netdev_priv(dev);
3250 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
3251 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
3253 switch (tun->flags & TUN_TYPE_MASK) {
3255 strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
3258 strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
3263 static u32 tun_get_msglevel(struct net_device *dev)
3266 struct tun_struct *tun = netdev_priv(dev);
3273 static void tun_set_msglevel(struct net_device *dev, u32 value)
3276 struct tun_struct *tun = netdev_priv(dev);
3281 static int tun_get_coalesce(struct net_device *dev,
3282 struct ethtool_coalesce *ec)
3284 struct tun_struct *tun = netdev_priv(dev);
3286 ec->rx_max_coalesced_frames = tun->rx_batched;
3291 static int tun_set_coalesce(struct net_device *dev,
3292 struct ethtool_coalesce *ec)
3294 struct tun_struct *tun = netdev_priv(dev);
3296 if (ec->rx_max_coalesced_frames > NAPI_POLL_WEIGHT)
3297 tun->rx_batched = NAPI_POLL_WEIGHT;
3299 tun->rx_batched = ec->rx_max_coalesced_frames;
3304 static const struct ethtool_ops tun_ethtool_ops = {
3305 .get_drvinfo = tun_get_drvinfo,
3306 .get_msglevel = tun_get_msglevel,
3307 .set_msglevel = tun_set_msglevel,
3308 .get_link = ethtool_op_get_link,
3309 .get_ts_info = ethtool_op_get_ts_info,
3310 .get_coalesce = tun_get_coalesce,
3311 .set_coalesce = tun_set_coalesce,
3312 .get_link_ksettings = tun_get_link_ksettings,
3315 static int tun_queue_resize(struct tun_struct *tun)
3317 struct net_device *dev = tun->dev;
3318 struct tun_file *tfile;
3319 struct ptr_ring **rings;
3320 int n = tun->numqueues + tun->numdisabled;
3323 rings = kmalloc_array(n, sizeof(*rings), GFP_KERNEL);
3327 for (i = 0; i < tun->numqueues; i++) {
3328 tfile = rtnl_dereference(tun->tfiles[i]);
3329 rings[i] = &tfile->tx_ring;
3331 list_for_each_entry(tfile, &tun->disabled, next)
3332 rings[i++] = &tfile->tx_ring;
3334 ret = ptr_ring_resize_multiple(rings, n,
3335 dev->tx_queue_len, GFP_KERNEL,
3342 static int tun_device_event(struct notifier_block *unused,
3343 unsigned long event, void *ptr)
3345 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
3346 struct tun_struct *tun = netdev_priv(dev);
3348 if (dev->rtnl_link_ops != &tun_link_ops)
3352 case NETDEV_CHANGE_TX_QUEUE_LEN:
3353 if (tun_queue_resize(tun))
3363 static struct notifier_block tun_notifier_block __read_mostly = {
3364 .notifier_call = tun_device_event,
3367 static int __init tun_init(void)
3371 pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
3373 ret = rtnl_link_register(&tun_link_ops);
3375 pr_err("Can't register link_ops\n");
3379 ret = misc_register(&tun_miscdev);
3381 pr_err("Can't register misc device %d\n", TUN_MINOR);
3385 ret = register_netdevice_notifier(&tun_notifier_block);
3387 pr_err("Can't register netdevice notifier\n");
3394 misc_deregister(&tun_miscdev);
3396 rtnl_link_unregister(&tun_link_ops);
3401 static void tun_cleanup(void)
3403 misc_deregister(&tun_miscdev);
3404 rtnl_link_unregister(&tun_link_ops);
3405 unregister_netdevice_notifier(&tun_notifier_block);
3408 /* Get an underlying socket object from tun file. Returns error unless file is
3409 * attached to a device. The returned object works like a packet socket, it
3410 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
3411 * holding a reference to the file for as long as the socket is in use. */
3412 struct socket *tun_get_socket(struct file *file)
3414 struct tun_file *tfile;
3415 if (file->f_op != &tun_fops)
3416 return ERR_PTR(-EINVAL);
3417 tfile = file->private_data;
3419 return ERR_PTR(-EBADFD);
3420 return &tfile->socket;
3422 EXPORT_SYMBOL_GPL(tun_get_socket);
3424 struct ptr_ring *tun_get_tx_ring(struct file *file)
3426 struct tun_file *tfile;
3428 if (file->f_op != &tun_fops)
3429 return ERR_PTR(-EINVAL);
3430 tfile = file->private_data;
3432 return ERR_PTR(-EBADFD);
3433 return &tfile->tx_ring;
3435 EXPORT_SYMBOL_GPL(tun_get_tx_ring);
3437 module_init(tun_init);
3438 module_exit(tun_cleanup);
3439 MODULE_DESCRIPTION(DRV_DESCRIPTION);
3440 MODULE_AUTHOR(DRV_COPYRIGHT);
3441 MODULE_LICENSE("GPL");
3442 MODULE_ALIAS_MISCDEV(TUN_MINOR);
3443 MODULE_ALIAS("devname:net/tun");