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>
74 #include <linux/seq_file.h>
75 #include <linux/uio.h>
76 #include <linux/skb_array.h>
77 #include <linux/bpf.h>
78 #include <linux/bpf_trace.h>
79 #include <linux/mutex.h>
81 #include <linux/uaccess.h>
82 #include <linux/proc_fs.h>
84 static void tun_default_link_ksettings(struct net_device *dev,
85 struct ethtool_link_ksettings *cmd);
87 /* Uncomment to enable debugging */
88 /* #define TUN_DEBUG 1 */
93 #define tun_debug(level, tun, fmt, args...) \
96 netdev_printk(level, tun->dev, fmt, ##args); \
98 #define DBG1(level, fmt, args...) \
101 printk(level fmt, ##args); \
104 #define tun_debug(level, tun, fmt, args...) \
107 netdev_printk(level, tun->dev, fmt, ##args); \
109 #define DBG1(level, fmt, args...) \
112 printk(level fmt, ##args); \
116 #define TUN_HEADROOM 256
117 #define TUN_RX_PAD (NET_IP_ALIGN + NET_SKB_PAD)
119 /* TUN device flags */
121 /* IFF_ATTACH_QUEUE is never stored in device flags,
122 * overload it to mean fasync when stored there.
124 #define TUN_FASYNC IFF_ATTACH_QUEUE
125 /* High bits in flags field are unused. */
126 #define TUN_VNET_LE 0x80000000
127 #define TUN_VNET_BE 0x40000000
129 #define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
130 IFF_MULTI_QUEUE | IFF_NAPI | IFF_NAPI_FRAGS)
132 #define GOODCOPY_LEN 128
134 #define FLT_EXACT_COUNT 8
136 unsigned int count; /* Number of addrs. Zero means disabled */
137 u32 mask[2]; /* Mask of the hashed addrs */
138 unsigned char addr[FLT_EXACT_COUNT][ETH_ALEN];
141 /* MAX_TAP_QUEUES 256 is chosen to allow rx/tx queues to be equal
142 * to max number of VCPUs in guest. */
143 #define MAX_TAP_QUEUES 256
144 #define MAX_TAP_FLOWS 4096
146 #define TUN_FLOW_EXPIRE (3 * HZ)
148 struct tun_pcpu_stats {
153 struct u64_stats_sync syncp;
159 /* A tun_file connects an open character device to a tuntap netdevice. It
160 * also contains all socket related structures (except sock_fprog and tap_filter)
161 * to serve as one transmit queue for tuntap device. The sock_fprog and
162 * tap_filter were kept in tun_struct since they were used for filtering for the
163 * netdevice not for a specific queue (at least I didn't see the requirement for
167 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
168 * other can only be read while rcu_read_lock or rtnl_lock is held.
172 struct socket socket;
174 struct tun_struct __rcu *tun;
175 struct fasync_struct *fasync;
176 /* only used for fasnyc */
180 unsigned int ifindex;
182 struct napi_struct napi;
184 struct mutex napi_mutex; /* Protects access to the above napi */
185 struct list_head next;
186 struct tun_struct *detached;
187 struct ptr_ring tx_ring;
188 struct xdp_rxq_info xdp_rxq;
191 struct tun_flow_entry {
192 struct hlist_node hash_link;
194 struct tun_struct *tun;
199 unsigned long updated;
202 #define TUN_NUM_FLOW_ENTRIES 1024
203 #define TUN_MASK_FLOW_ENTRIES (TUN_NUM_FLOW_ENTRIES - 1)
207 struct bpf_prog *prog;
210 /* Since the socket were moved to tun_file, to preserve the behavior of persist
211 * device, socket filter, sndbuf and vnet header size were restore when the
212 * file were attached to a persist device.
215 struct tun_file __rcu *tfiles[MAX_TAP_QUEUES];
216 unsigned int numqueues;
221 struct net_device *dev;
222 netdev_features_t set_features;
223 #define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
229 struct tap_filter txflt;
230 struct sock_fprog fprog;
231 /* protected by rtnl lock */
232 bool filter_attached;
237 struct hlist_head flows[TUN_NUM_FLOW_ENTRIES];
238 struct timer_list flow_gc_timer;
239 unsigned long ageing_time;
240 unsigned int numdisabled;
241 struct list_head disabled;
245 struct tun_pcpu_stats __percpu *pcpu_stats;
246 struct bpf_prog __rcu *xdp_prog;
247 struct tun_prog __rcu *steering_prog;
248 struct tun_prog __rcu *filter_prog;
249 struct ethtool_link_ksettings link_ksettings;
257 bool tun_is_xdp_frame(void *ptr)
259 return (unsigned long)ptr & TUN_XDP_FLAG;
261 EXPORT_SYMBOL(tun_is_xdp_frame);
263 void *tun_xdp_to_ptr(void *ptr)
265 return (void *)((unsigned long)ptr | TUN_XDP_FLAG);
267 EXPORT_SYMBOL(tun_xdp_to_ptr);
269 void *tun_ptr_to_xdp(void *ptr)
271 return (void *)((unsigned long)ptr & ~TUN_XDP_FLAG);
273 EXPORT_SYMBOL(tun_ptr_to_xdp);
275 static int tun_napi_receive(struct napi_struct *napi, int budget)
277 struct tun_file *tfile = container_of(napi, struct tun_file, napi);
278 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
279 struct sk_buff_head process_queue;
283 __skb_queue_head_init(&process_queue);
285 spin_lock(&queue->lock);
286 skb_queue_splice_tail_init(queue, &process_queue);
287 spin_unlock(&queue->lock);
289 while (received < budget && (skb = __skb_dequeue(&process_queue))) {
290 napi_gro_receive(napi, skb);
294 if (!skb_queue_empty(&process_queue)) {
295 spin_lock(&queue->lock);
296 skb_queue_splice(&process_queue, queue);
297 spin_unlock(&queue->lock);
303 static int tun_napi_poll(struct napi_struct *napi, int budget)
305 unsigned int received;
307 received = tun_napi_receive(napi, budget);
309 if (received < budget)
310 napi_complete_done(napi, received);
315 static void tun_napi_init(struct tun_struct *tun, struct tun_file *tfile,
318 tfile->napi_enabled = napi_en;
320 netif_napi_add(tun->dev, &tfile->napi, tun_napi_poll,
322 napi_enable(&tfile->napi);
323 mutex_init(&tfile->napi_mutex);
327 static void tun_napi_disable(struct tun_struct *tun, struct tun_file *tfile)
329 if (tfile->napi_enabled)
330 napi_disable(&tfile->napi);
333 static void tun_napi_del(struct tun_struct *tun, struct tun_file *tfile)
335 if (tfile->napi_enabled)
336 netif_napi_del(&tfile->napi);
339 static bool tun_napi_frags_enabled(const struct tun_struct *tun)
341 return READ_ONCE(tun->flags) & IFF_NAPI_FRAGS;
344 #ifdef CONFIG_TUN_VNET_CROSS_LE
345 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
347 return tun->flags & TUN_VNET_BE ? false :
348 virtio_legacy_is_little_endian();
351 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
353 int be = !!(tun->flags & TUN_VNET_BE);
355 if (put_user(be, argp))
361 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
365 if (get_user(be, argp))
369 tun->flags |= TUN_VNET_BE;
371 tun->flags &= ~TUN_VNET_BE;
376 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
378 return virtio_legacy_is_little_endian();
381 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
386 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
390 #endif /* CONFIG_TUN_VNET_CROSS_LE */
392 static inline bool tun_is_little_endian(struct tun_struct *tun)
394 return tun->flags & TUN_VNET_LE ||
395 tun_legacy_is_little_endian(tun);
398 static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
400 return __virtio16_to_cpu(tun_is_little_endian(tun), val);
403 static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
405 return __cpu_to_virtio16(tun_is_little_endian(tun), val);
408 static inline u32 tun_hashfn(u32 rxhash)
410 return rxhash & TUN_MASK_FLOW_ENTRIES;
413 static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
415 struct tun_flow_entry *e;
417 hlist_for_each_entry_rcu(e, head, hash_link) {
418 if (e->rxhash == rxhash)
424 static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
425 struct hlist_head *head,
426 u32 rxhash, u16 queue_index)
428 struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
431 tun_debug(KERN_INFO, tun, "create flow: hash %u index %u\n",
432 rxhash, queue_index);
433 e->updated = jiffies;
436 e->queue_index = queue_index;
438 hlist_add_head_rcu(&e->hash_link, head);
444 static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
446 tun_debug(KERN_INFO, tun, "delete flow: hash %u index %u\n",
447 e->rxhash, e->queue_index);
448 hlist_del_rcu(&e->hash_link);
453 static void tun_flow_flush(struct tun_struct *tun)
457 spin_lock_bh(&tun->lock);
458 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
459 struct tun_flow_entry *e;
460 struct hlist_node *n;
462 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
463 tun_flow_delete(tun, e);
465 spin_unlock_bh(&tun->lock);
468 static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
472 spin_lock_bh(&tun->lock);
473 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
474 struct tun_flow_entry *e;
475 struct hlist_node *n;
477 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
478 if (e->queue_index == queue_index)
479 tun_flow_delete(tun, e);
482 spin_unlock_bh(&tun->lock);
485 static void tun_flow_cleanup(struct timer_list *t)
487 struct tun_struct *tun = from_timer(tun, t, flow_gc_timer);
488 unsigned long delay = tun->ageing_time;
489 unsigned long next_timer = jiffies + delay;
490 unsigned long count = 0;
493 tun_debug(KERN_INFO, tun, "tun_flow_cleanup\n");
495 spin_lock(&tun->lock);
496 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
497 struct tun_flow_entry *e;
498 struct hlist_node *n;
500 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
501 unsigned long this_timer;
503 this_timer = e->updated + delay;
504 if (time_before_eq(this_timer, jiffies)) {
505 tun_flow_delete(tun, e);
509 if (time_before(this_timer, next_timer))
510 next_timer = this_timer;
515 mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
516 spin_unlock(&tun->lock);
519 static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
520 struct tun_file *tfile)
522 struct hlist_head *head;
523 struct tun_flow_entry *e;
524 unsigned long delay = tun->ageing_time;
525 u16 queue_index = tfile->queue_index;
530 head = &tun->flows[tun_hashfn(rxhash)];
534 e = tun_flow_find(head, rxhash);
536 /* TODO: keep queueing to old queue until it's empty? */
537 e->queue_index = queue_index;
538 e->updated = jiffies;
539 sock_rps_record_flow_hash(e->rps_rxhash);
541 spin_lock_bh(&tun->lock);
542 if (!tun_flow_find(head, rxhash) &&
543 tun->flow_count < MAX_TAP_FLOWS)
544 tun_flow_create(tun, head, rxhash, queue_index);
546 if (!timer_pending(&tun->flow_gc_timer))
547 mod_timer(&tun->flow_gc_timer,
548 round_jiffies_up(jiffies + delay));
549 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 struct net_device *sb_dev,
612 select_queue_fallback_t fallback)
614 struct tun_struct *tun = netdev_priv(dev);
618 if (rcu_dereference(tun->steering_prog))
619 ret = tun_ebpf_select_queue(tun, skb);
621 ret = tun_automq_select_queue(tun, skb);
627 static inline bool tun_not_capable(struct tun_struct *tun)
629 const struct cred *cred = current_cred();
630 struct net *net = dev_net(tun->dev);
632 return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
633 (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
634 !ns_capable(net->user_ns, CAP_NET_ADMIN);
637 static void tun_set_real_num_queues(struct tun_struct *tun)
639 netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
640 netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
643 static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
645 tfile->detached = tun;
646 list_add_tail(&tfile->next, &tun->disabled);
650 static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
652 struct tun_struct *tun = tfile->detached;
654 tfile->detached = NULL;
655 list_del_init(&tfile->next);
660 void tun_ptr_free(void *ptr)
664 if (tun_is_xdp_frame(ptr)) {
665 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
667 xdp_return_frame(xdpf);
669 __skb_array_destroy_skb(ptr);
672 EXPORT_SYMBOL_GPL(tun_ptr_free);
674 static void tun_queue_purge(struct tun_file *tfile)
678 while ((ptr = ptr_ring_consume(&tfile->tx_ring)) != NULL)
681 skb_queue_purge(&tfile->sk.sk_write_queue);
682 skb_queue_purge(&tfile->sk.sk_error_queue);
685 static void __tun_detach(struct tun_file *tfile, bool clean)
687 struct tun_file *ntfile;
688 struct tun_struct *tun;
690 tun = rtnl_dereference(tfile->tun);
693 tun_napi_disable(tun, tfile);
694 tun_napi_del(tun, tfile);
697 if (tun && !tfile->detached) {
698 u16 index = tfile->queue_index;
699 BUG_ON(index >= tun->numqueues);
701 rcu_assign_pointer(tun->tfiles[index],
702 tun->tfiles[tun->numqueues - 1]);
703 ntfile = rtnl_dereference(tun->tfiles[index]);
704 ntfile->queue_index = index;
708 RCU_INIT_POINTER(tfile->tun, NULL);
709 sock_put(&tfile->sk);
711 tun_disable_queue(tun, tfile);
714 tun_flow_delete_by_queue(tun, tun->numqueues + 1);
715 /* Drop read queue */
716 tun_queue_purge(tfile);
717 tun_set_real_num_queues(tun);
718 } else if (tfile->detached && clean) {
719 tun = tun_enable_queue(tfile);
720 sock_put(&tfile->sk);
724 if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
725 netif_carrier_off(tun->dev);
727 if (!(tun->flags & IFF_PERSIST) &&
728 tun->dev->reg_state == NETREG_REGISTERED)
729 unregister_netdevice(tun->dev);
732 xdp_rxq_info_unreg(&tfile->xdp_rxq);
733 ptr_ring_cleanup(&tfile->tx_ring, tun_ptr_free);
734 sock_put(&tfile->sk);
738 static void tun_detach(struct tun_file *tfile, bool clean)
740 struct tun_struct *tun;
741 struct net_device *dev;
744 tun = rtnl_dereference(tfile->tun);
745 dev = tun ? tun->dev : NULL;
746 __tun_detach(tfile, clean);
748 netdev_state_change(dev);
752 static void tun_detach_all(struct net_device *dev)
754 struct tun_struct *tun = netdev_priv(dev);
755 struct tun_file *tfile, *tmp;
756 int i, n = tun->numqueues;
758 for (i = 0; i < n; i++) {
759 tfile = rtnl_dereference(tun->tfiles[i]);
761 tun_napi_disable(tun, tfile);
762 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
763 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
764 RCU_INIT_POINTER(tfile->tun, NULL);
767 list_for_each_entry(tfile, &tun->disabled, next) {
768 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
769 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
770 RCU_INIT_POINTER(tfile->tun, NULL);
772 BUG_ON(tun->numqueues != 0);
775 for (i = 0; i < n; i++) {
776 tfile = rtnl_dereference(tun->tfiles[i]);
777 tun_napi_del(tun, tfile);
778 /* Drop read queue */
779 tun_queue_purge(tfile);
780 xdp_rxq_info_unreg(&tfile->xdp_rxq);
781 sock_put(&tfile->sk);
783 list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
784 tun_enable_queue(tfile);
785 tun_queue_purge(tfile);
786 xdp_rxq_info_unreg(&tfile->xdp_rxq);
787 sock_put(&tfile->sk);
789 BUG_ON(tun->numdisabled != 0);
791 if (tun->flags & IFF_PERSIST)
792 module_put(THIS_MODULE);
795 static int tun_attach(struct tun_struct *tun, struct file *file,
796 bool skip_filter, bool napi)
798 struct tun_file *tfile = file->private_data;
799 struct net_device *dev = tun->dev;
802 err = security_tun_dev_attach(tfile->socket.sk, tun->security);
807 if (rtnl_dereference(tfile->tun) && !tfile->detached)
811 if (!(tun->flags & IFF_MULTI_QUEUE) && tun->numqueues == 1)
815 if (!tfile->detached &&
816 tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
821 /* Re-attach the filter to persist device */
822 if (!skip_filter && (tun->filter_attached == true)) {
823 lock_sock(tfile->socket.sk);
824 err = sk_attach_filter(&tun->fprog, tfile->socket.sk);
825 release_sock(tfile->socket.sk);
830 if (!tfile->detached &&
831 ptr_ring_resize(&tfile->tx_ring, dev->tx_queue_len,
832 GFP_KERNEL, tun_ptr_free)) {
837 tfile->queue_index = tun->numqueues;
838 tfile->socket.sk->sk_shutdown &= ~RCV_SHUTDOWN;
840 if (tfile->detached) {
841 /* Re-attach detached tfile, updating XDP queue_index */
842 WARN_ON(!xdp_rxq_info_is_reg(&tfile->xdp_rxq));
844 if (tfile->xdp_rxq.queue_index != tfile->queue_index)
845 tfile->xdp_rxq.queue_index = tfile->queue_index;
847 /* Setup XDP RX-queue info, for new tfile getting attached */
848 err = xdp_rxq_info_reg(&tfile->xdp_rxq,
849 tun->dev, tfile->queue_index);
852 err = xdp_rxq_info_reg_mem_model(&tfile->xdp_rxq,
853 MEM_TYPE_PAGE_SHARED, NULL);
855 xdp_rxq_info_unreg(&tfile->xdp_rxq);
861 rcu_assign_pointer(tfile->tun, tun);
862 rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
865 if (tfile->detached) {
866 tun_enable_queue(tfile);
868 sock_hold(&tfile->sk);
869 tun_napi_init(tun, tfile, napi);
872 tun_set_real_num_queues(tun);
874 /* device is allowed to go away first, so no need to hold extra
882 static struct tun_struct *tun_get(struct tun_file *tfile)
884 struct tun_struct *tun;
887 tun = rcu_dereference(tfile->tun);
895 static void tun_put(struct tun_struct *tun)
901 static void addr_hash_set(u32 *mask, const u8 *addr)
903 int n = ether_crc(ETH_ALEN, addr) >> 26;
904 mask[n >> 5] |= (1 << (n & 31));
907 static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
909 int n = ether_crc(ETH_ALEN, addr) >> 26;
910 return mask[n >> 5] & (1 << (n & 31));
913 static int update_filter(struct tap_filter *filter, void __user *arg)
915 struct { u8 u[ETH_ALEN]; } *addr;
916 struct tun_filter uf;
917 int err, alen, n, nexact;
919 if (copy_from_user(&uf, arg, sizeof(uf)))
928 alen = ETH_ALEN * uf.count;
929 addr = memdup_user(arg + sizeof(uf), alen);
931 return PTR_ERR(addr);
933 /* The filter is updated without holding any locks. Which is
934 * perfectly safe. We disable it first and in the worst
935 * case we'll accept a few undesired packets. */
939 /* Use first set of addresses as an exact filter */
940 for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
941 memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
945 /* Remaining multicast addresses are hashed,
946 * unicast will leave the filter disabled. */
947 memset(filter->mask, 0, sizeof(filter->mask));
948 for (; n < uf.count; n++) {
949 if (!is_multicast_ether_addr(addr[n].u)) {
950 err = 0; /* no filter */
953 addr_hash_set(filter->mask, addr[n].u);
956 /* For ALLMULTI just set the mask to all ones.
957 * This overrides the mask populated above. */
958 if ((uf.flags & TUN_FLT_ALLMULTI))
959 memset(filter->mask, ~0, sizeof(filter->mask));
961 /* Now enable the filter */
963 filter->count = nexact;
965 /* Return the number of exact filters */
972 /* Returns: 0 - drop, !=0 - accept */
973 static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
975 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
977 struct ethhdr *eh = (struct ethhdr *) skb->data;
981 for (i = 0; i < filter->count; i++)
982 if (ether_addr_equal(eh->h_dest, filter->addr[i]))
985 /* Inexact match (multicast only) */
986 if (is_multicast_ether_addr(eh->h_dest))
987 return addr_hash_test(filter->mask, eh->h_dest);
993 * Checks whether the packet is accepted or not.
994 * Returns: 0 - drop, !=0 - accept
996 static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
1001 return run_filter(filter, skb);
1004 /* Network device part of the driver */
1006 static const struct ethtool_ops tun_ethtool_ops;
1008 /* Net device detach from fd. */
1009 static void tun_net_uninit(struct net_device *dev)
1011 tun_detach_all(dev);
1014 /* Net device open. */
1015 static int tun_net_open(struct net_device *dev)
1017 struct tun_struct *tun = netdev_priv(dev);
1020 netif_tx_start_all_queues(dev);
1022 for (i = 0; i < tun->numqueues; i++) {
1023 struct tun_file *tfile;
1025 tfile = rtnl_dereference(tun->tfiles[i]);
1026 tfile->socket.sk->sk_write_space(tfile->socket.sk);
1032 /* Net device close. */
1033 static int tun_net_close(struct net_device *dev)
1035 netif_tx_stop_all_queues(dev);
1039 /* Net device start xmit */
1040 static void tun_automq_xmit(struct tun_struct *tun, struct sk_buff *skb)
1043 if (tun->numqueues == 1 && static_key_false(&rps_needed)) {
1044 /* Select queue was not called for the skbuff, so we extract the
1045 * RPS hash and save it into the flow_table here.
1049 rxhash = __skb_get_hash_symmetric(skb);
1051 struct tun_flow_entry *e;
1052 e = tun_flow_find(&tun->flows[tun_hashfn(rxhash)],
1055 tun_flow_save_rps_rxhash(e, rxhash);
1061 static unsigned int run_ebpf_filter(struct tun_struct *tun,
1062 struct sk_buff *skb,
1065 struct tun_prog *prog = rcu_dereference(tun->filter_prog);
1068 len = bpf_prog_run_clear_cb(prog->prog, skb);
1073 /* Net device start xmit */
1074 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
1076 struct tun_struct *tun = netdev_priv(dev);
1077 int txq = skb->queue_mapping;
1078 struct tun_file *tfile;
1082 tfile = rcu_dereference(tun->tfiles[txq]);
1084 /* Drop packet if interface is not attached */
1085 if (txq >= tun->numqueues)
1088 if (!rcu_dereference(tun->steering_prog))
1089 tun_automq_xmit(tun, skb);
1091 tun_debug(KERN_INFO, tun, "tun_net_xmit %d\n", skb->len);
1095 /* Drop if the filter does not like it.
1096 * This is a noop if the filter is disabled.
1097 * Filter can be enabled only for the TAP devices. */
1098 if (!check_filter(&tun->txflt, skb))
1101 if (tfile->socket.sk->sk_filter &&
1102 sk_filter(tfile->socket.sk, skb))
1105 len = run_ebpf_filter(tun, skb, len);
1106 if (len == 0 || pskb_trim(skb, len))
1109 if (unlikely(skb_orphan_frags_rx(skb, GFP_ATOMIC)))
1112 skb_tx_timestamp(skb);
1114 /* Orphan the skb - required as we might hang on to it
1115 * for indefinite time.
1121 if (ptr_ring_produce(&tfile->tx_ring, skb))
1124 /* Notify and wake up reader process */
1125 if (tfile->flags & TUN_FASYNC)
1126 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1127 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1130 return NETDEV_TX_OK;
1133 this_cpu_inc(tun->pcpu_stats->tx_dropped);
1137 return NET_XMIT_DROP;
1140 static void tun_net_mclist(struct net_device *dev)
1143 * This callback is supposed to deal with mc filter in
1144 * _rx_ path and has nothing to do with the _tx_ path.
1145 * In rx path we always accept everything userspace gives us.
1149 static netdev_features_t tun_net_fix_features(struct net_device *dev,
1150 netdev_features_t features)
1152 struct tun_struct *tun = netdev_priv(dev);
1154 return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
1156 #ifdef CONFIG_NET_POLL_CONTROLLER
1157 static void tun_poll_controller(struct net_device *dev)
1160 * Tun only receives frames when:
1161 * 1) the char device endpoint gets data from user space
1162 * 2) the tun socket gets a sendmsg call from user space
1163 * If NAPI is not enabled, since both of those are synchronous
1164 * operations, we are guaranteed never to have pending data when we poll
1165 * for it so there is nothing to do here but return.
1166 * We need this though so netpoll recognizes us as an interface that
1167 * supports polling, which enables bridge devices in virt setups to
1168 * still use netconsole
1169 * If NAPI is enabled, however, we need to schedule polling for all
1170 * queues unless we are using napi_gro_frags(), which we call in
1171 * process context and not in NAPI context.
1173 struct tun_struct *tun = netdev_priv(dev);
1175 if (tun->flags & IFF_NAPI) {
1176 struct tun_file *tfile;
1179 if (tun_napi_frags_enabled(tun))
1183 for (i = 0; i < tun->numqueues; i++) {
1184 tfile = rcu_dereference(tun->tfiles[i]);
1185 if (tfile->napi_enabled)
1186 napi_schedule(&tfile->napi);
1194 static void tun_set_headroom(struct net_device *dev, int new_hr)
1196 struct tun_struct *tun = netdev_priv(dev);
1198 if (new_hr < NET_SKB_PAD)
1199 new_hr = NET_SKB_PAD;
1201 tun->align = new_hr;
1205 tun_net_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats)
1207 u32 rx_dropped = 0, tx_dropped = 0, rx_frame_errors = 0;
1208 struct tun_struct *tun = netdev_priv(dev);
1209 struct tun_pcpu_stats *p;
1212 for_each_possible_cpu(i) {
1213 u64 rxpackets, rxbytes, txpackets, txbytes;
1216 p = per_cpu_ptr(tun->pcpu_stats, i);
1218 start = u64_stats_fetch_begin(&p->syncp);
1219 rxpackets = p->rx_packets;
1220 rxbytes = p->rx_bytes;
1221 txpackets = p->tx_packets;
1222 txbytes = p->tx_bytes;
1223 } while (u64_stats_fetch_retry(&p->syncp, start));
1225 stats->rx_packets += rxpackets;
1226 stats->rx_bytes += rxbytes;
1227 stats->tx_packets += txpackets;
1228 stats->tx_bytes += txbytes;
1231 rx_dropped += p->rx_dropped;
1232 rx_frame_errors += p->rx_frame_errors;
1233 tx_dropped += p->tx_dropped;
1235 stats->rx_dropped = rx_dropped;
1236 stats->rx_frame_errors = rx_frame_errors;
1237 stats->tx_dropped = tx_dropped;
1240 static int tun_xdp_set(struct net_device *dev, struct bpf_prog *prog,
1241 struct netlink_ext_ack *extack)
1243 struct tun_struct *tun = netdev_priv(dev);
1244 struct bpf_prog *old_prog;
1246 old_prog = rtnl_dereference(tun->xdp_prog);
1247 rcu_assign_pointer(tun->xdp_prog, prog);
1249 bpf_prog_put(old_prog);
1254 static u32 tun_xdp_query(struct net_device *dev)
1256 struct tun_struct *tun = netdev_priv(dev);
1257 const struct bpf_prog *xdp_prog;
1259 xdp_prog = rtnl_dereference(tun->xdp_prog);
1261 return xdp_prog->aux->id;
1266 static int tun_xdp(struct net_device *dev, struct netdev_bpf *xdp)
1268 switch (xdp->command) {
1269 case XDP_SETUP_PROG:
1270 return tun_xdp_set(dev, xdp->prog, xdp->extack);
1271 case XDP_QUERY_PROG:
1272 xdp->prog_id = tun_xdp_query(dev);
1279 static const struct net_device_ops tun_netdev_ops = {
1280 .ndo_uninit = tun_net_uninit,
1281 .ndo_open = tun_net_open,
1282 .ndo_stop = tun_net_close,
1283 .ndo_start_xmit = tun_net_xmit,
1284 .ndo_fix_features = tun_net_fix_features,
1285 .ndo_select_queue = tun_select_queue,
1286 #ifdef CONFIG_NET_POLL_CONTROLLER
1287 .ndo_poll_controller = tun_poll_controller,
1289 .ndo_set_rx_headroom = tun_set_headroom,
1290 .ndo_get_stats64 = tun_net_get_stats64,
1293 static void __tun_xdp_flush_tfile(struct tun_file *tfile)
1295 /* Notify and wake up reader process */
1296 if (tfile->flags & TUN_FASYNC)
1297 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1298 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1301 static int tun_xdp_xmit(struct net_device *dev, int n,
1302 struct xdp_frame **frames, u32 flags)
1304 struct tun_struct *tun = netdev_priv(dev);
1305 struct tun_file *tfile;
1311 if (unlikely(flags & ~XDP_XMIT_FLAGS_MASK))
1316 numqueues = READ_ONCE(tun->numqueues);
1319 return -ENXIO; /* Caller will free/return all frames */
1322 tfile = rcu_dereference(tun->tfiles[smp_processor_id() %
1325 spin_lock(&tfile->tx_ring.producer_lock);
1326 for (i = 0; i < n; i++) {
1327 struct xdp_frame *xdp = frames[i];
1328 /* Encode the XDP flag into lowest bit for consumer to differ
1329 * XDP buffer from sk_buff.
1331 void *frame = tun_xdp_to_ptr(xdp);
1333 if (__ptr_ring_produce(&tfile->tx_ring, frame)) {
1334 this_cpu_inc(tun->pcpu_stats->tx_dropped);
1335 xdp_return_frame_rx_napi(xdp);
1339 spin_unlock(&tfile->tx_ring.producer_lock);
1341 if (flags & XDP_XMIT_FLUSH)
1342 __tun_xdp_flush_tfile(tfile);
1348 static int tun_xdp_tx(struct net_device *dev, struct xdp_buff *xdp)
1350 struct xdp_frame *frame = convert_to_xdp_frame(xdp);
1352 if (unlikely(!frame))
1355 return tun_xdp_xmit(dev, 1, &frame, XDP_XMIT_FLUSH);
1358 static const struct net_device_ops tap_netdev_ops = {
1359 .ndo_uninit = tun_net_uninit,
1360 .ndo_open = tun_net_open,
1361 .ndo_stop = tun_net_close,
1362 .ndo_start_xmit = tun_net_xmit,
1363 .ndo_fix_features = tun_net_fix_features,
1364 .ndo_set_rx_mode = tun_net_mclist,
1365 .ndo_set_mac_address = eth_mac_addr,
1366 .ndo_validate_addr = eth_validate_addr,
1367 .ndo_select_queue = tun_select_queue,
1368 #ifdef CONFIG_NET_POLL_CONTROLLER
1369 .ndo_poll_controller = tun_poll_controller,
1371 .ndo_features_check = passthru_features_check,
1372 .ndo_set_rx_headroom = tun_set_headroom,
1373 .ndo_get_stats64 = tun_net_get_stats64,
1375 .ndo_xdp_xmit = tun_xdp_xmit,
1378 static void tun_flow_init(struct tun_struct *tun)
1382 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
1383 INIT_HLIST_HEAD(&tun->flows[i]);
1385 tun->ageing_time = TUN_FLOW_EXPIRE;
1386 timer_setup(&tun->flow_gc_timer, tun_flow_cleanup, 0);
1387 mod_timer(&tun->flow_gc_timer,
1388 round_jiffies_up(jiffies + tun->ageing_time));
1391 static void tun_flow_uninit(struct tun_struct *tun)
1393 del_timer_sync(&tun->flow_gc_timer);
1394 tun_flow_flush(tun);
1398 #define MAX_MTU 65535
1400 /* Initialize net device. */
1401 static void tun_net_init(struct net_device *dev)
1403 struct tun_struct *tun = netdev_priv(dev);
1405 switch (tun->flags & TUN_TYPE_MASK) {
1407 dev->netdev_ops = &tun_netdev_ops;
1409 /* Point-to-Point TUN Device */
1410 dev->hard_header_len = 0;
1414 /* Zero header length */
1415 dev->type = ARPHRD_NONE;
1416 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
1420 dev->netdev_ops = &tap_netdev_ops;
1421 /* Ethernet TAP Device */
1423 dev->priv_flags &= ~IFF_TX_SKB_SHARING;
1424 dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
1426 eth_hw_addr_random(dev);
1431 dev->min_mtu = MIN_MTU;
1432 dev->max_mtu = MAX_MTU - dev->hard_header_len;
1435 static bool tun_sock_writeable(struct tun_struct *tun, struct tun_file *tfile)
1437 struct sock *sk = tfile->socket.sk;
1439 return (tun->dev->flags & IFF_UP) && sock_writeable(sk);
1442 /* Character device part */
1445 static __poll_t tun_chr_poll(struct file *file, poll_table *wait)
1447 struct tun_file *tfile = file->private_data;
1448 struct tun_struct *tun = tun_get(tfile);
1455 sk = tfile->socket.sk;
1457 tun_debug(KERN_INFO, tun, "tun_chr_poll\n");
1459 poll_wait(file, sk_sleep(sk), wait);
1461 if (!ptr_ring_empty(&tfile->tx_ring))
1462 mask |= EPOLLIN | EPOLLRDNORM;
1464 /* Make sure SOCKWQ_ASYNC_NOSPACE is set if not writable to
1465 * guarantee EPOLLOUT to be raised by either here or
1466 * tun_sock_write_space(). Then process could get notification
1467 * after it writes to a down device and meets -EIO.
1469 if (tun_sock_writeable(tun, tfile) ||
1470 (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
1471 tun_sock_writeable(tun, tfile)))
1472 mask |= EPOLLOUT | EPOLLWRNORM;
1474 if (tun->dev->reg_state != NETREG_REGISTERED)
1481 static struct sk_buff *tun_napi_alloc_frags(struct tun_file *tfile,
1483 const struct iov_iter *it)
1485 struct sk_buff *skb;
1490 if (it->nr_segs > MAX_SKB_FRAGS + 1)
1491 return ERR_PTR(-ENOMEM);
1494 skb = napi_get_frags(&tfile->napi);
1497 return ERR_PTR(-ENOMEM);
1499 linear = iov_iter_single_seg_count(it);
1500 err = __skb_grow(skb, linear);
1505 skb->data_len = len - linear;
1506 skb->truesize += skb->data_len;
1508 for (i = 1; i < it->nr_segs; i++) {
1509 struct page_frag *pfrag = ¤t->task_frag;
1510 size_t fragsz = it->iov[i].iov_len;
1512 if (fragsz == 0 || fragsz > PAGE_SIZE) {
1517 if (!skb_page_frag_refill(fragsz, pfrag, GFP_KERNEL)) {
1522 skb_fill_page_desc(skb, i - 1, pfrag->page,
1523 pfrag->offset, fragsz);
1524 page_ref_inc(pfrag->page);
1525 pfrag->offset += fragsz;
1530 /* frees skb and all frags allocated with napi_alloc_frag() */
1531 napi_free_frags(&tfile->napi);
1532 return ERR_PTR(err);
1535 /* prepad is the amount to reserve at front. len is length after that.
1536 * linear is a hint as to how much to copy (usually headers). */
1537 static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
1538 size_t prepad, size_t len,
1539 size_t linear, int noblock)
1541 struct sock *sk = tfile->socket.sk;
1542 struct sk_buff *skb;
1545 /* Under a page? Don't bother with paged skb. */
1546 if (prepad + len < PAGE_SIZE || !linear)
1549 skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
1552 return ERR_PTR(err);
1554 skb_reserve(skb, prepad);
1555 skb_put(skb, linear);
1556 skb->data_len = len - linear;
1557 skb->len += len - linear;
1562 static void tun_rx_batched(struct tun_struct *tun, struct tun_file *tfile,
1563 struct sk_buff *skb, int more)
1565 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1566 struct sk_buff_head process_queue;
1567 u32 rx_batched = tun->rx_batched;
1570 if (!rx_batched || (!more && skb_queue_empty(queue))) {
1572 netif_receive_skb(skb);
1577 spin_lock(&queue->lock);
1578 if (!more || skb_queue_len(queue) == rx_batched) {
1579 __skb_queue_head_init(&process_queue);
1580 skb_queue_splice_tail_init(queue, &process_queue);
1583 __skb_queue_tail(queue, skb);
1585 spin_unlock(&queue->lock);
1588 struct sk_buff *nskb;
1591 while ((nskb = __skb_dequeue(&process_queue)))
1592 netif_receive_skb(nskb);
1593 netif_receive_skb(skb);
1598 static bool tun_can_build_skb(struct tun_struct *tun, struct tun_file *tfile,
1599 int len, int noblock, bool zerocopy)
1601 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
1604 if (tfile->socket.sk->sk_sndbuf != INT_MAX)
1613 if (SKB_DATA_ALIGN(len + TUN_RX_PAD) +
1614 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
1620 static struct sk_buff *tun_build_skb(struct tun_struct *tun,
1621 struct tun_file *tfile,
1622 struct iov_iter *from,
1623 struct virtio_net_hdr *hdr,
1624 int len, int *skb_xdp)
1626 struct page_frag *alloc_frag = ¤t->task_frag;
1627 struct sk_buff *skb;
1628 struct bpf_prog *xdp_prog;
1629 int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
1630 unsigned int delta = 0;
1633 int err, pad = TUN_RX_PAD;
1636 xdp_prog = rcu_dereference(tun->xdp_prog);
1638 pad += TUN_HEADROOM;
1639 buflen += SKB_DATA_ALIGN(len + pad);
1642 alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
1643 if (unlikely(!skb_page_frag_refill(buflen, alloc_frag, GFP_KERNEL)))
1644 return ERR_PTR(-ENOMEM);
1646 buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
1647 copied = copy_page_from_iter(alloc_frag->page,
1648 alloc_frag->offset + pad,
1651 return ERR_PTR(-EFAULT);
1653 /* There's a small window that XDP may be set after the check
1654 * of xdp_prog above, this should be rare and for simplicity
1655 * we do XDP on skb in case the headroom is not enough.
1657 if (hdr->gso_type || !xdp_prog)
1664 xdp_prog = rcu_dereference(tun->xdp_prog);
1665 if (xdp_prog && !*skb_xdp) {
1666 struct xdp_buff xdp;
1670 xdp.data_hard_start = buf;
1671 xdp.data = buf + pad;
1672 xdp_set_data_meta_invalid(&xdp);
1673 xdp.data_end = xdp.data + len;
1674 xdp.rxq = &tfile->xdp_rxq;
1675 orig_data = xdp.data;
1676 act = bpf_prog_run_xdp(xdp_prog, &xdp);
1680 get_page(alloc_frag->page);
1681 alloc_frag->offset += buflen;
1682 err = xdp_do_redirect(tun->dev, &xdp, xdp_prog);
1690 get_page(alloc_frag->page);
1691 alloc_frag->offset += buflen;
1692 if (tun_xdp_tx(tun->dev, &xdp) < 0)
1698 delta = orig_data - xdp.data;
1699 len = xdp.data_end - xdp.data;
1702 bpf_warn_invalid_xdp_action(act);
1705 trace_xdp_exception(tun->dev, xdp_prog, act);
1712 skb = build_skb(buf, buflen);
1716 return ERR_PTR(-ENOMEM);
1719 skb_reserve(skb, pad - delta);
1721 get_page(alloc_frag->page);
1722 alloc_frag->offset += buflen;
1730 put_page(alloc_frag->page);
1734 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1738 /* Get packet from user space buffer */
1739 static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
1740 void *msg_control, struct iov_iter *from,
1741 int noblock, bool more)
1743 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1744 struct sk_buff *skb;
1745 size_t total_len = iov_iter_count(from);
1746 size_t len = total_len, align = tun->align, linear;
1747 struct virtio_net_hdr gso = { 0 };
1748 struct tun_pcpu_stats *stats;
1751 bool zerocopy = false;
1755 bool frags = tun_napi_frags_enabled(tun);
1757 if (!(tun->dev->flags & IFF_UP))
1760 if (!(tun->flags & IFF_NO_PI)) {
1761 if (len < sizeof(pi))
1765 if (!copy_from_iter_full(&pi, sizeof(pi), from))
1769 if (tun->flags & IFF_VNET_HDR) {
1770 int vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1772 if (len < vnet_hdr_sz)
1776 if (!copy_from_iter_full(&gso, sizeof(gso), from))
1779 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
1780 tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1781 gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
1783 if (tun16_to_cpu(tun, gso.hdr_len) > len)
1785 iov_iter_advance(from, vnet_hdr_sz - sizeof(gso));
1788 if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
1789 align += NET_IP_ALIGN;
1790 if (unlikely(len < ETH_HLEN ||
1791 (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
1795 good_linear = SKB_MAX_HEAD(align);
1798 struct iov_iter i = *from;
1800 /* There are 256 bytes to be copied in skb, so there is
1801 * enough room for skb expand head in case it is used.
1802 * The rest of the buffer is mapped from userspace.
1804 copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
1805 if (copylen > good_linear)
1806 copylen = good_linear;
1808 iov_iter_advance(&i, copylen);
1809 if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
1813 if (!frags && tun_can_build_skb(tun, tfile, len, noblock, zerocopy)) {
1814 /* For the packet that is not easy to be processed
1815 * (e.g gso or jumbo packet), we will do it at after
1816 * skb was created with generic XDP routine.
1818 skb = tun_build_skb(tun, tfile, from, &gso, len, &skb_xdp);
1820 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1821 return PTR_ERR(skb);
1828 if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1829 linear = good_linear;
1831 linear = tun16_to_cpu(tun, gso.hdr_len);
1835 mutex_lock(&tfile->napi_mutex);
1836 skb = tun_napi_alloc_frags(tfile, copylen, from);
1837 /* tun_napi_alloc_frags() enforces a layout for the skb.
1838 * If zerocopy is enabled, then this layout will be
1839 * overwritten by zerocopy_sg_from_iter().
1843 skb = tun_alloc_skb(tfile, align, copylen, linear,
1848 if (PTR_ERR(skb) != -EAGAIN)
1849 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1851 mutex_unlock(&tfile->napi_mutex);
1852 return PTR_ERR(skb);
1856 err = zerocopy_sg_from_iter(skb, from);
1858 err = skb_copy_datagram_from_iter(skb, 0, from, len);
1861 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1864 tfile->napi.skb = NULL;
1865 mutex_unlock(&tfile->napi_mutex);
1872 if (virtio_net_hdr_to_skb(skb, &gso, tun_is_little_endian(tun))) {
1873 this_cpu_inc(tun->pcpu_stats->rx_frame_errors);
1876 tfile->napi.skb = NULL;
1877 mutex_unlock(&tfile->napi_mutex);
1883 switch (tun->flags & TUN_TYPE_MASK) {
1885 if (tun->flags & IFF_NO_PI) {
1886 u8 ip_version = skb->len ? (skb->data[0] >> 4) : 0;
1888 switch (ip_version) {
1890 pi.proto = htons(ETH_P_IP);
1893 pi.proto = htons(ETH_P_IPV6);
1896 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1902 skb_reset_mac_header(skb);
1903 skb->protocol = pi.proto;
1904 skb->dev = tun->dev;
1908 skb->protocol = eth_type_trans(skb, tun->dev);
1912 /* copy skb_ubuf_info for callback when skb has no error */
1914 skb_shinfo(skb)->destructor_arg = msg_control;
1915 skb_shinfo(skb)->tx_flags |= SKBTX_DEV_ZEROCOPY;
1916 skb_shinfo(skb)->tx_flags |= SKBTX_SHARED_FRAG;
1917 } else if (msg_control) {
1918 struct ubuf_info *uarg = msg_control;
1919 uarg->callback(uarg, false);
1922 skb_reset_network_header(skb);
1923 skb_probe_transport_header(skb, 0);
1926 struct bpf_prog *xdp_prog;
1931 xdp_prog = rcu_dereference(tun->xdp_prog);
1933 ret = do_xdp_generic(xdp_prog, skb);
1934 if (ret != XDP_PASS) {
1944 /* Compute the costly rx hash only if needed for flow updates.
1945 * We may get a very small possibility of OOO during switching, not
1946 * worth to optimize.
1948 if (!rcu_access_pointer(tun->steering_prog) && tun->numqueues > 1 &&
1950 rxhash = __skb_get_hash_symmetric(skb);
1953 /* Exercise flow dissector code path. */
1954 u32 headlen = eth_get_headlen(skb->data, skb_headlen(skb));
1956 if (unlikely(headlen > skb_headlen(skb))) {
1957 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1958 napi_free_frags(&tfile->napi);
1959 mutex_unlock(&tfile->napi_mutex);
1965 napi_gro_frags(&tfile->napi);
1967 mutex_unlock(&tfile->napi_mutex);
1968 } else if (tfile->napi_enabled) {
1969 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1972 spin_lock_bh(&queue->lock);
1973 __skb_queue_tail(queue, skb);
1974 queue_len = skb_queue_len(queue);
1975 spin_unlock(&queue->lock);
1977 if (!more || queue_len > NAPI_POLL_WEIGHT)
1978 napi_schedule(&tfile->napi);
1981 } else if (!IS_ENABLED(CONFIG_4KSTACKS)) {
1982 tun_rx_batched(tun, tfile, skb, more);
1987 stats = get_cpu_ptr(tun->pcpu_stats);
1988 u64_stats_update_begin(&stats->syncp);
1989 stats->rx_packets++;
1990 stats->rx_bytes += len;
1991 u64_stats_update_end(&stats->syncp);
1995 tun_flow_update(tun, rxhash, tfile);
2000 static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
2002 struct file *file = iocb->ki_filp;
2003 struct tun_file *tfile = file->private_data;
2004 struct tun_struct *tun = tun_get(tfile);
2010 result = tun_get_user(tun, tfile, NULL, from,
2011 file->f_flags & O_NONBLOCK, false);
2017 static ssize_t tun_put_user_xdp(struct tun_struct *tun,
2018 struct tun_file *tfile,
2019 struct xdp_frame *xdp_frame,
2020 struct iov_iter *iter)
2022 int vnet_hdr_sz = 0;
2023 size_t size = xdp_frame->len;
2024 struct tun_pcpu_stats *stats;
2027 if (tun->flags & IFF_VNET_HDR) {
2028 struct virtio_net_hdr gso = { 0 };
2030 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2031 if (unlikely(iov_iter_count(iter) < vnet_hdr_sz))
2033 if (unlikely(copy_to_iter(&gso, sizeof(gso), iter) !=
2036 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2039 ret = copy_to_iter(xdp_frame->data, size, iter) + vnet_hdr_sz;
2041 stats = get_cpu_ptr(tun->pcpu_stats);
2042 u64_stats_update_begin(&stats->syncp);
2043 stats->tx_packets++;
2044 stats->tx_bytes += ret;
2045 u64_stats_update_end(&stats->syncp);
2046 put_cpu_ptr(tun->pcpu_stats);
2051 /* Put packet to the user space buffer */
2052 static ssize_t tun_put_user(struct tun_struct *tun,
2053 struct tun_file *tfile,
2054 struct sk_buff *skb,
2055 struct iov_iter *iter)
2057 struct tun_pi pi = { 0, skb->protocol };
2058 struct tun_pcpu_stats *stats;
2060 int vlan_offset = 0;
2062 int vnet_hdr_sz = 0;
2064 if (skb_vlan_tag_present(skb))
2065 vlan_hlen = VLAN_HLEN;
2067 if (tun->flags & IFF_VNET_HDR)
2068 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2070 total = skb->len + vlan_hlen + vnet_hdr_sz;
2072 if (!(tun->flags & IFF_NO_PI)) {
2073 if (iov_iter_count(iter) < sizeof(pi))
2076 total += sizeof(pi);
2077 if (iov_iter_count(iter) < total) {
2078 /* Packet will be striped */
2079 pi.flags |= TUN_PKT_STRIP;
2082 if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
2087 struct virtio_net_hdr gso;
2089 if (iov_iter_count(iter) < vnet_hdr_sz)
2092 if (virtio_net_hdr_from_skb(skb, &gso,
2093 tun_is_little_endian(tun), true,
2095 struct skb_shared_info *sinfo = skb_shinfo(skb);
2096 pr_err("unexpected GSO type: "
2097 "0x%x, gso_size %d, hdr_len %d\n",
2098 sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
2099 tun16_to_cpu(tun, gso.hdr_len));
2100 print_hex_dump(KERN_ERR, "tun: ",
2103 min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
2108 if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
2111 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2118 veth.h_vlan_proto = skb->vlan_proto;
2119 veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
2121 vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
2123 ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
2124 if (ret || !iov_iter_count(iter))
2127 ret = copy_to_iter(&veth, sizeof(veth), iter);
2128 if (ret != sizeof(veth) || !iov_iter_count(iter))
2132 skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
2135 /* caller is in process context, */
2136 stats = get_cpu_ptr(tun->pcpu_stats);
2137 u64_stats_update_begin(&stats->syncp);
2138 stats->tx_packets++;
2139 stats->tx_bytes += skb->len + vlan_hlen;
2140 u64_stats_update_end(&stats->syncp);
2141 put_cpu_ptr(tun->pcpu_stats);
2146 static void *tun_ring_recv(struct tun_file *tfile, int noblock, int *err)
2148 DECLARE_WAITQUEUE(wait, current);
2152 ptr = ptr_ring_consume(&tfile->tx_ring);
2160 add_wait_queue(&tfile->wq.wait, &wait);
2161 current->state = TASK_INTERRUPTIBLE;
2164 ptr = ptr_ring_consume(&tfile->tx_ring);
2167 if (signal_pending(current)) {
2168 error = -ERESTARTSYS;
2171 if (tfile->socket.sk->sk_shutdown & RCV_SHUTDOWN) {
2179 current->state = TASK_RUNNING;
2180 remove_wait_queue(&tfile->wq.wait, &wait);
2187 static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
2188 struct iov_iter *to,
2189 int noblock, void *ptr)
2194 tun_debug(KERN_INFO, tun, "tun_do_read\n");
2196 if (!iov_iter_count(to)) {
2202 /* Read frames from ring */
2203 ptr = tun_ring_recv(tfile, noblock, &err);
2208 if (tun_is_xdp_frame(ptr)) {
2209 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2211 ret = tun_put_user_xdp(tun, tfile, xdpf, to);
2212 xdp_return_frame(xdpf);
2214 struct sk_buff *skb = ptr;
2216 ret = tun_put_user(tun, tfile, skb, to);
2217 if (unlikely(ret < 0))
2226 static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
2228 struct file *file = iocb->ki_filp;
2229 struct tun_file *tfile = file->private_data;
2230 struct tun_struct *tun = tun_get(tfile);
2231 ssize_t len = iov_iter_count(to), ret;
2235 ret = tun_do_read(tun, tfile, to, file->f_flags & O_NONBLOCK, NULL);
2236 ret = min_t(ssize_t, ret, len);
2243 static void tun_prog_free(struct rcu_head *rcu)
2245 struct tun_prog *prog = container_of(rcu, struct tun_prog, rcu);
2247 bpf_prog_destroy(prog->prog);
2251 static int __tun_set_ebpf(struct tun_struct *tun,
2252 struct tun_prog __rcu **prog_p,
2253 struct bpf_prog *prog)
2255 struct tun_prog *old, *new = NULL;
2258 new = kmalloc(sizeof(*new), GFP_KERNEL);
2264 spin_lock_bh(&tun->lock);
2265 old = rcu_dereference_protected(*prog_p,
2266 lockdep_is_held(&tun->lock));
2267 rcu_assign_pointer(*prog_p, new);
2268 spin_unlock_bh(&tun->lock);
2271 call_rcu(&old->rcu, tun_prog_free);
2276 static void tun_free_netdev(struct net_device *dev)
2278 struct tun_struct *tun = netdev_priv(dev);
2280 BUG_ON(!(list_empty(&tun->disabled)));
2281 free_percpu(tun->pcpu_stats);
2282 tun_flow_uninit(tun);
2283 security_tun_dev_free_security(tun->security);
2284 __tun_set_ebpf(tun, &tun->steering_prog, NULL);
2285 __tun_set_ebpf(tun, &tun->filter_prog, NULL);
2288 static void tun_setup(struct net_device *dev)
2290 struct tun_struct *tun = netdev_priv(dev);
2292 tun->owner = INVALID_UID;
2293 tun->group = INVALID_GID;
2294 tun_default_link_ksettings(dev, &tun->link_ksettings);
2296 dev->ethtool_ops = &tun_ethtool_ops;
2297 dev->needs_free_netdev = true;
2298 dev->priv_destructor = tun_free_netdev;
2299 /* We prefer our own queue length */
2300 dev->tx_queue_len = TUN_READQ_SIZE;
2303 /* Trivial set of netlink ops to allow deleting tun or tap
2304 * device with netlink.
2306 static int tun_validate(struct nlattr *tb[], struct nlattr *data[],
2307 struct netlink_ext_ack *extack)
2312 static size_t tun_get_size(const struct net_device *dev)
2314 BUILD_BUG_ON(sizeof(u32) != sizeof(uid_t));
2315 BUILD_BUG_ON(sizeof(u32) != sizeof(gid_t));
2317 return nla_total_size(sizeof(uid_t)) + /* OWNER */
2318 nla_total_size(sizeof(gid_t)) + /* GROUP */
2319 nla_total_size(sizeof(u8)) + /* TYPE */
2320 nla_total_size(sizeof(u8)) + /* PI */
2321 nla_total_size(sizeof(u8)) + /* VNET_HDR */
2322 nla_total_size(sizeof(u8)) + /* PERSIST */
2323 nla_total_size(sizeof(u8)) + /* MULTI_QUEUE */
2324 nla_total_size(sizeof(u32)) + /* NUM_QUEUES */
2325 nla_total_size(sizeof(u32)) + /* NUM_DISABLED_QUEUES */
2329 static int tun_fill_info(struct sk_buff *skb, const struct net_device *dev)
2331 struct tun_struct *tun = netdev_priv(dev);
2333 if (nla_put_u8(skb, IFLA_TUN_TYPE, tun->flags & TUN_TYPE_MASK))
2334 goto nla_put_failure;
2335 if (uid_valid(tun->owner) &&
2336 nla_put_u32(skb, IFLA_TUN_OWNER,
2337 from_kuid_munged(current_user_ns(), tun->owner)))
2338 goto nla_put_failure;
2339 if (gid_valid(tun->group) &&
2340 nla_put_u32(skb, IFLA_TUN_GROUP,
2341 from_kgid_munged(current_user_ns(), tun->group)))
2342 goto nla_put_failure;
2343 if (nla_put_u8(skb, IFLA_TUN_PI, !(tun->flags & IFF_NO_PI)))
2344 goto nla_put_failure;
2345 if (nla_put_u8(skb, IFLA_TUN_VNET_HDR, !!(tun->flags & IFF_VNET_HDR)))
2346 goto nla_put_failure;
2347 if (nla_put_u8(skb, IFLA_TUN_PERSIST, !!(tun->flags & IFF_PERSIST)))
2348 goto nla_put_failure;
2349 if (nla_put_u8(skb, IFLA_TUN_MULTI_QUEUE,
2350 !!(tun->flags & IFF_MULTI_QUEUE)))
2351 goto nla_put_failure;
2352 if (tun->flags & IFF_MULTI_QUEUE) {
2353 if (nla_put_u32(skb, IFLA_TUN_NUM_QUEUES, tun->numqueues))
2354 goto nla_put_failure;
2355 if (nla_put_u32(skb, IFLA_TUN_NUM_DISABLED_QUEUES,
2357 goto nla_put_failure;
2366 static struct rtnl_link_ops tun_link_ops __read_mostly = {
2368 .priv_size = sizeof(struct tun_struct),
2370 .validate = tun_validate,
2371 .get_size = tun_get_size,
2372 .fill_info = tun_fill_info,
2375 static void tun_sock_write_space(struct sock *sk)
2377 struct tun_file *tfile;
2378 wait_queue_head_t *wqueue;
2380 if (!sock_writeable(sk))
2383 if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
2386 wqueue = sk_sleep(sk);
2387 if (wqueue && waitqueue_active(wqueue))
2388 wake_up_interruptible_sync_poll(wqueue, EPOLLOUT |
2389 EPOLLWRNORM | EPOLLWRBAND);
2391 tfile = container_of(sk, struct tun_file, sk);
2392 kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
2395 static int tun_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
2398 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2399 struct tun_struct *tun = tun_get(tfile);
2404 ret = tun_get_user(tun, tfile, m->msg_control, &m->msg_iter,
2405 m->msg_flags & MSG_DONTWAIT,
2406 m->msg_flags & MSG_MORE);
2411 static int tun_recvmsg(struct socket *sock, struct msghdr *m, size_t total_len,
2414 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2415 struct tun_struct *tun = tun_get(tfile);
2416 void *ptr = m->msg_control;
2424 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
2428 if (flags & MSG_ERRQUEUE) {
2429 ret = sock_recv_errqueue(sock->sk, m, total_len,
2430 SOL_PACKET, TUN_TX_TIMESTAMP);
2433 ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT, ptr);
2434 if (ret > (ssize_t)total_len) {
2435 m->msg_flags |= MSG_TRUNC;
2436 ret = flags & MSG_TRUNC ? ret : total_len;
2449 static int tun_ptr_peek_len(void *ptr)
2452 if (tun_is_xdp_frame(ptr)) {
2453 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2457 return __skb_array_len_with_tag(ptr);
2463 static int tun_peek_len(struct socket *sock)
2465 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2466 struct tun_struct *tun;
2469 tun = tun_get(tfile);
2473 ret = PTR_RING_PEEK_CALL(&tfile->tx_ring, tun_ptr_peek_len);
2479 /* Ops structure to mimic raw sockets with tun */
2480 static const struct proto_ops tun_socket_ops = {
2481 .peek_len = tun_peek_len,
2482 .sendmsg = tun_sendmsg,
2483 .recvmsg = tun_recvmsg,
2486 static struct proto tun_proto = {
2488 .owner = THIS_MODULE,
2489 .obj_size = sizeof(struct tun_file),
2492 static int tun_flags(struct tun_struct *tun)
2494 return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
2497 static ssize_t tun_show_flags(struct device *dev, struct device_attribute *attr,
2500 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2501 return sprintf(buf, "0x%x\n", tun_flags(tun));
2504 static ssize_t tun_show_owner(struct device *dev, struct device_attribute *attr,
2507 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2508 return uid_valid(tun->owner)?
2509 sprintf(buf, "%u\n",
2510 from_kuid_munged(current_user_ns(), tun->owner)):
2511 sprintf(buf, "-1\n");
2514 static ssize_t tun_show_group(struct device *dev, struct device_attribute *attr,
2517 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2518 return gid_valid(tun->group) ?
2519 sprintf(buf, "%u\n",
2520 from_kgid_munged(current_user_ns(), tun->group)):
2521 sprintf(buf, "-1\n");
2524 static DEVICE_ATTR(tun_flags, 0444, tun_show_flags, NULL);
2525 static DEVICE_ATTR(owner, 0444, tun_show_owner, NULL);
2526 static DEVICE_ATTR(group, 0444, tun_show_group, NULL);
2528 static struct attribute *tun_dev_attrs[] = {
2529 &dev_attr_tun_flags.attr,
2530 &dev_attr_owner.attr,
2531 &dev_attr_group.attr,
2535 static const struct attribute_group tun_attr_group = {
2536 .attrs = tun_dev_attrs
2539 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
2541 struct tun_struct *tun;
2542 struct tun_file *tfile = file->private_data;
2543 struct net_device *dev;
2546 if (tfile->detached)
2549 if ((ifr->ifr_flags & IFF_NAPI_FRAGS)) {
2550 if (!capable(CAP_NET_ADMIN))
2553 if (!(ifr->ifr_flags & IFF_NAPI) ||
2554 (ifr->ifr_flags & TUN_TYPE_MASK) != IFF_TAP)
2558 dev = __dev_get_by_name(net, ifr->ifr_name);
2560 if (ifr->ifr_flags & IFF_TUN_EXCL)
2562 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
2563 tun = netdev_priv(dev);
2564 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
2565 tun = netdev_priv(dev);
2569 if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
2570 !!(tun->flags & IFF_MULTI_QUEUE))
2573 if (tun_not_capable(tun))
2575 err = security_tun_dev_open(tun->security);
2579 err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER,
2580 ifr->ifr_flags & IFF_NAPI);
2584 if (tun->flags & IFF_MULTI_QUEUE &&
2585 (tun->numqueues + tun->numdisabled > 1)) {
2586 /* One or more queue has already been attached, no need
2587 * to initialize the device again.
2589 netdev_state_change(dev);
2593 tun->flags = (tun->flags & ~TUN_FEATURES) |
2594 (ifr->ifr_flags & TUN_FEATURES);
2596 netdev_state_change(dev);
2599 unsigned long flags = 0;
2600 int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
2603 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
2605 err = security_tun_dev_create();
2610 if (ifr->ifr_flags & IFF_TUN) {
2614 } else if (ifr->ifr_flags & IFF_TAP) {
2622 name = ifr->ifr_name;
2624 dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
2625 NET_NAME_UNKNOWN, tun_setup, queues,
2630 err = dev_get_valid_name(net, dev, name);
2634 dev_net_set(dev, net);
2635 dev->rtnl_link_ops = &tun_link_ops;
2636 dev->ifindex = tfile->ifindex;
2637 dev->sysfs_groups[0] = &tun_attr_group;
2639 tun = netdev_priv(dev);
2642 tun->txflt.count = 0;
2643 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
2645 tun->align = NET_SKB_PAD;
2646 tun->filter_attached = false;
2647 tun->sndbuf = tfile->socket.sk->sk_sndbuf;
2648 tun->rx_batched = 0;
2649 RCU_INIT_POINTER(tun->steering_prog, NULL);
2651 tun->pcpu_stats = netdev_alloc_pcpu_stats(struct tun_pcpu_stats);
2652 if (!tun->pcpu_stats) {
2657 spin_lock_init(&tun->lock);
2659 err = security_tun_dev_alloc_security(&tun->security);
2666 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
2667 TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
2668 NETIF_F_HW_VLAN_STAG_TX;
2669 dev->features = dev->hw_features | NETIF_F_LLTX;
2670 dev->vlan_features = dev->features &
2671 ~(NETIF_F_HW_VLAN_CTAG_TX |
2672 NETIF_F_HW_VLAN_STAG_TX);
2674 tun->flags = (tun->flags & ~TUN_FEATURES) |
2675 (ifr->ifr_flags & TUN_FEATURES);
2677 INIT_LIST_HEAD(&tun->disabled);
2678 err = tun_attach(tun, file, false, ifr->ifr_flags & IFF_NAPI);
2682 err = register_netdevice(tun->dev);
2687 netif_carrier_on(tun->dev);
2689 tun_debug(KERN_INFO, tun, "tun_set_iff\n");
2691 /* Make sure persistent devices do not get stuck in
2694 if (netif_running(tun->dev))
2695 netif_tx_wake_all_queues(tun->dev);
2697 strcpy(ifr->ifr_name, tun->dev->name);
2701 tun_detach_all(dev);
2702 /* register_netdevice() already called tun_free_netdev() */
2706 tun_flow_uninit(tun);
2707 security_tun_dev_free_security(tun->security);
2709 free_percpu(tun->pcpu_stats);
2715 static void tun_get_iff(struct net *net, struct tun_struct *tun,
2718 tun_debug(KERN_INFO, tun, "tun_get_iff\n");
2720 strcpy(ifr->ifr_name, tun->dev->name);
2722 ifr->ifr_flags = tun_flags(tun);
2726 /* This is like a cut-down ethtool ops, except done via tun fd so no
2727 * privs required. */
2728 static int set_offload(struct tun_struct *tun, unsigned long arg)
2730 netdev_features_t features = 0;
2732 if (arg & TUN_F_CSUM) {
2733 features |= NETIF_F_HW_CSUM;
2736 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
2737 if (arg & TUN_F_TSO_ECN) {
2738 features |= NETIF_F_TSO_ECN;
2739 arg &= ~TUN_F_TSO_ECN;
2741 if (arg & TUN_F_TSO4)
2742 features |= NETIF_F_TSO;
2743 if (arg & TUN_F_TSO6)
2744 features |= NETIF_F_TSO6;
2745 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
2751 /* This gives the user a way to test for new features in future by
2752 * trying to set them. */
2756 tun->set_features = features;
2757 tun->dev->wanted_features &= ~TUN_USER_FEATURES;
2758 tun->dev->wanted_features |= features;
2759 netdev_update_features(tun->dev);
2764 static void tun_detach_filter(struct tun_struct *tun, int n)
2767 struct tun_file *tfile;
2769 for (i = 0; i < n; i++) {
2770 tfile = rtnl_dereference(tun->tfiles[i]);
2771 lock_sock(tfile->socket.sk);
2772 sk_detach_filter(tfile->socket.sk);
2773 release_sock(tfile->socket.sk);
2776 tun->filter_attached = false;
2779 static int tun_attach_filter(struct tun_struct *tun)
2782 struct tun_file *tfile;
2784 for (i = 0; i < tun->numqueues; i++) {
2785 tfile = rtnl_dereference(tun->tfiles[i]);
2786 lock_sock(tfile->socket.sk);
2787 ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
2788 release_sock(tfile->socket.sk);
2790 tun_detach_filter(tun, i);
2795 tun->filter_attached = true;
2799 static void tun_set_sndbuf(struct tun_struct *tun)
2801 struct tun_file *tfile;
2804 for (i = 0; i < tun->numqueues; i++) {
2805 tfile = rtnl_dereference(tun->tfiles[i]);
2806 tfile->socket.sk->sk_sndbuf = tun->sndbuf;
2810 static int tun_set_queue(struct file *file, struct ifreq *ifr)
2812 struct tun_file *tfile = file->private_data;
2813 struct tun_struct *tun;
2818 if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
2819 tun = tfile->detached;
2824 ret = security_tun_dev_attach_queue(tun->security);
2827 ret = tun_attach(tun, file, false, tun->flags & IFF_NAPI);
2828 } else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
2829 tun = rtnl_dereference(tfile->tun);
2830 if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
2833 __tun_detach(tfile, false);
2838 netdev_state_change(tun->dev);
2845 static int tun_set_ebpf(struct tun_struct *tun, struct tun_prog **prog_p,
2848 struct bpf_prog *prog;
2851 if (copy_from_user(&fd, data, sizeof(fd)))
2857 prog = bpf_prog_get_type(fd, BPF_PROG_TYPE_SOCKET_FILTER);
2859 return PTR_ERR(prog);
2862 return __tun_set_ebpf(tun, prog_p, prog);
2865 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
2866 unsigned long arg, int ifreq_len)
2868 struct tun_file *tfile = file->private_data;
2869 struct net *net = sock_net(&tfile->sk);
2870 struct tun_struct *tun;
2871 void __user* argp = (void __user*)arg;
2877 unsigned int ifindex;
2880 bool do_notify = false;
2882 if (cmd == TUNSETIFF || cmd == TUNSETQUEUE ||
2883 (_IOC_TYPE(cmd) == SOCK_IOC_TYPE && cmd != SIOCGSKNS)) {
2884 if (copy_from_user(&ifr, argp, ifreq_len))
2887 memset(&ifr, 0, sizeof(ifr));
2889 if (cmd == TUNGETFEATURES) {
2890 /* Currently this just means: "what IFF flags are valid?".
2891 * This is needed because we never checked for invalid flags on
2894 return put_user(IFF_TUN | IFF_TAP | TUN_FEATURES,
2895 (unsigned int __user*)argp);
2896 } else if (cmd == TUNSETQUEUE) {
2897 return tun_set_queue(file, &ifr);
2898 } else if (cmd == SIOCGSKNS) {
2899 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
2901 return open_related_ns(&net->ns, get_net_ns);
2907 tun = tun_get(tfile);
2908 if (cmd == TUNSETIFF) {
2913 ifr.ifr_name[IFNAMSIZ-1] = '\0';
2915 ret = tun_set_iff(net, file, &ifr);
2920 if (copy_to_user(argp, &ifr, ifreq_len))
2924 if (cmd == TUNSETIFINDEX) {
2930 if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
2934 tfile->ifindex = ifindex;
2942 tun_debug(KERN_INFO, tun, "tun_chr_ioctl cmd %u\n", cmd);
2947 tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
2949 if (tfile->detached)
2950 ifr.ifr_flags |= IFF_DETACH_QUEUE;
2951 if (!tfile->socket.sk->sk_filter)
2952 ifr.ifr_flags |= IFF_NOFILTER;
2954 if (copy_to_user(argp, &ifr, ifreq_len))
2959 /* Disable/Enable checksum */
2961 /* [unimplemented] */
2962 tun_debug(KERN_INFO, tun, "ignored: set checksum %s\n",
2963 arg ? "disabled" : "enabled");
2967 /* Disable/Enable persist mode. Keep an extra reference to the
2968 * module to prevent the module being unprobed.
2970 if (arg && !(tun->flags & IFF_PERSIST)) {
2971 tun->flags |= IFF_PERSIST;
2972 __module_get(THIS_MODULE);
2975 if (!arg && (tun->flags & IFF_PERSIST)) {
2976 tun->flags &= ~IFF_PERSIST;
2977 module_put(THIS_MODULE);
2981 tun_debug(KERN_INFO, tun, "persist %s\n",
2982 arg ? "enabled" : "disabled");
2986 /* Set owner of the device */
2987 owner = make_kuid(current_user_ns(), arg);
2988 if (!uid_valid(owner)) {
2994 tun_debug(KERN_INFO, tun, "owner set to %u\n",
2995 from_kuid(&init_user_ns, tun->owner));
2999 /* Set group of the device */
3000 group = make_kgid(current_user_ns(), arg);
3001 if (!gid_valid(group)) {
3007 tun_debug(KERN_INFO, tun, "group set to %u\n",
3008 from_kgid(&init_user_ns, tun->group));
3012 /* Only allow setting the type when the interface is down */
3013 if (tun->dev->flags & IFF_UP) {
3014 tun_debug(KERN_INFO, tun,
3015 "Linktype set failed because interface is up\n");
3018 tun->dev->type = (int) arg;
3019 tun_debug(KERN_INFO, tun, "linktype set to %d\n",
3031 ret = set_offload(tun, arg);
3034 case TUNSETTXFILTER:
3035 /* Can be set only for TAPs */
3037 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3039 ret = update_filter(&tun->txflt, (void __user *)arg);
3043 /* Get hw address */
3044 memcpy(ifr.ifr_hwaddr.sa_data, tun->dev->dev_addr, ETH_ALEN);
3045 ifr.ifr_hwaddr.sa_family = tun->dev->type;
3046 if (copy_to_user(argp, &ifr, ifreq_len))
3051 /* Set hw address */
3052 tun_debug(KERN_DEBUG, tun, "set hw address: %pM\n",
3053 ifr.ifr_hwaddr.sa_data);
3055 ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr);
3059 sndbuf = tfile->socket.sk->sk_sndbuf;
3060 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
3065 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
3074 tun->sndbuf = sndbuf;
3075 tun_set_sndbuf(tun);
3078 case TUNGETVNETHDRSZ:
3079 vnet_hdr_sz = tun->vnet_hdr_sz;
3080 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
3084 case TUNSETVNETHDRSZ:
3085 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
3089 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
3094 tun->vnet_hdr_sz = vnet_hdr_sz;
3098 le = !!(tun->flags & TUN_VNET_LE);
3099 if (put_user(le, (int __user *)argp))
3104 if (get_user(le, (int __user *)argp)) {
3109 tun->flags |= TUN_VNET_LE;
3111 tun->flags &= ~TUN_VNET_LE;
3115 ret = tun_get_vnet_be(tun, argp);
3119 ret = tun_set_vnet_be(tun, argp);
3122 case TUNATTACHFILTER:
3123 /* Can be set only for TAPs */
3125 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3128 if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
3131 ret = tun_attach_filter(tun);
3134 case TUNDETACHFILTER:
3135 /* Can be set only for TAPs */
3137 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3140 tun_detach_filter(tun, tun->numqueues);
3145 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3148 if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
3153 case TUNSETSTEERINGEBPF:
3154 ret = tun_set_ebpf(tun, &tun->steering_prog, argp);
3157 case TUNSETFILTEREBPF:
3158 ret = tun_set_ebpf(tun, &tun->filter_prog, argp);
3167 netdev_state_change(tun->dev);
3176 static long tun_chr_ioctl(struct file *file,
3177 unsigned int cmd, unsigned long arg)
3179 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
3182 #ifdef CONFIG_COMPAT
3183 static long tun_chr_compat_ioctl(struct file *file,
3184 unsigned int cmd, unsigned long arg)
3189 case TUNSETTXFILTER:
3194 arg = (unsigned long)compat_ptr(arg);
3197 arg = (compat_ulong_t)arg;
3202 * compat_ifreq is shorter than ifreq, so we must not access beyond
3203 * the end of that structure. All fields that are used in this
3204 * driver are compatible though, we don't need to convert the
3207 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
3209 #endif /* CONFIG_COMPAT */
3211 static int tun_chr_fasync(int fd, struct file *file, int on)
3213 struct tun_file *tfile = file->private_data;
3216 if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
3220 __f_setown(file, task_pid(current), PIDTYPE_TGID, 0);
3221 tfile->flags |= TUN_FASYNC;
3223 tfile->flags &= ~TUN_FASYNC;
3229 static int tun_chr_open(struct inode *inode, struct file * file)
3231 struct net *net = current->nsproxy->net_ns;
3232 struct tun_file *tfile;
3234 DBG1(KERN_INFO, "tunX: tun_chr_open\n");
3236 tfile = (struct tun_file *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
3240 if (ptr_ring_init(&tfile->tx_ring, 0, GFP_KERNEL)) {
3241 sk_free(&tfile->sk);
3245 RCU_INIT_POINTER(tfile->tun, NULL);
3249 init_waitqueue_head(&tfile->wq.wait);
3250 RCU_INIT_POINTER(tfile->socket.wq, &tfile->wq);
3252 tfile->socket.file = file;
3253 tfile->socket.ops = &tun_socket_ops;
3255 sock_init_data(&tfile->socket, &tfile->sk);
3257 tfile->sk.sk_write_space = tun_sock_write_space;
3258 tfile->sk.sk_sndbuf = INT_MAX;
3260 file->private_data = tfile;
3261 INIT_LIST_HEAD(&tfile->next);
3263 sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
3268 static int tun_chr_close(struct inode *inode, struct file *file)
3270 struct tun_file *tfile = file->private_data;
3272 tun_detach(tfile, true);
3277 #ifdef CONFIG_PROC_FS
3278 static void tun_chr_show_fdinfo(struct seq_file *m, struct file *file)
3280 struct tun_file *tfile = file->private_data;
3281 struct tun_struct *tun;
3284 memset(&ifr, 0, sizeof(ifr));
3287 tun = tun_get(tfile);
3289 tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
3295 seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
3299 static const struct file_operations tun_fops = {
3300 .owner = THIS_MODULE,
3301 .llseek = no_llseek,
3302 .read_iter = tun_chr_read_iter,
3303 .write_iter = tun_chr_write_iter,
3304 .poll = tun_chr_poll,
3305 .unlocked_ioctl = tun_chr_ioctl,
3306 #ifdef CONFIG_COMPAT
3307 .compat_ioctl = tun_chr_compat_ioctl,
3309 .open = tun_chr_open,
3310 .release = tun_chr_close,
3311 .fasync = tun_chr_fasync,
3312 #ifdef CONFIG_PROC_FS
3313 .show_fdinfo = tun_chr_show_fdinfo,
3317 static struct miscdevice tun_miscdev = {
3320 .nodename = "net/tun",
3324 /* ethtool interface */
3326 static void tun_default_link_ksettings(struct net_device *dev,
3327 struct ethtool_link_ksettings *cmd)
3329 ethtool_link_ksettings_zero_link_mode(cmd, supported);
3330 ethtool_link_ksettings_zero_link_mode(cmd, advertising);
3331 cmd->base.speed = SPEED_10;
3332 cmd->base.duplex = DUPLEX_FULL;
3333 cmd->base.port = PORT_TP;
3334 cmd->base.phy_address = 0;
3335 cmd->base.autoneg = AUTONEG_DISABLE;
3338 static int tun_get_link_ksettings(struct net_device *dev,
3339 struct ethtool_link_ksettings *cmd)
3341 struct tun_struct *tun = netdev_priv(dev);
3343 memcpy(cmd, &tun->link_ksettings, sizeof(*cmd));
3347 static int tun_set_link_ksettings(struct net_device *dev,
3348 const struct ethtool_link_ksettings *cmd)
3350 struct tun_struct *tun = netdev_priv(dev);
3352 memcpy(&tun->link_ksettings, cmd, sizeof(*cmd));
3356 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
3358 struct tun_struct *tun = netdev_priv(dev);
3360 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
3361 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
3363 switch (tun->flags & TUN_TYPE_MASK) {
3365 strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
3368 strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
3373 static u32 tun_get_msglevel(struct net_device *dev)
3376 struct tun_struct *tun = netdev_priv(dev);
3383 static void tun_set_msglevel(struct net_device *dev, u32 value)
3386 struct tun_struct *tun = netdev_priv(dev);
3391 static int tun_get_coalesce(struct net_device *dev,
3392 struct ethtool_coalesce *ec)
3394 struct tun_struct *tun = netdev_priv(dev);
3396 ec->rx_max_coalesced_frames = tun->rx_batched;
3401 static int tun_set_coalesce(struct net_device *dev,
3402 struct ethtool_coalesce *ec)
3404 struct tun_struct *tun = netdev_priv(dev);
3406 if (ec->rx_max_coalesced_frames > NAPI_POLL_WEIGHT)
3407 tun->rx_batched = NAPI_POLL_WEIGHT;
3409 tun->rx_batched = ec->rx_max_coalesced_frames;
3414 static const struct ethtool_ops tun_ethtool_ops = {
3415 .get_drvinfo = tun_get_drvinfo,
3416 .get_msglevel = tun_get_msglevel,
3417 .set_msglevel = tun_set_msglevel,
3418 .get_link = ethtool_op_get_link,
3419 .get_ts_info = ethtool_op_get_ts_info,
3420 .get_coalesce = tun_get_coalesce,
3421 .set_coalesce = tun_set_coalesce,
3422 .get_link_ksettings = tun_get_link_ksettings,
3423 .set_link_ksettings = tun_set_link_ksettings,
3426 static int tun_queue_resize(struct tun_struct *tun)
3428 struct net_device *dev = tun->dev;
3429 struct tun_file *tfile;
3430 struct ptr_ring **rings;
3431 int n = tun->numqueues + tun->numdisabled;
3434 rings = kmalloc_array(n, sizeof(*rings), GFP_KERNEL);
3438 for (i = 0; i < tun->numqueues; i++) {
3439 tfile = rtnl_dereference(tun->tfiles[i]);
3440 rings[i] = &tfile->tx_ring;
3442 list_for_each_entry(tfile, &tun->disabled, next)
3443 rings[i++] = &tfile->tx_ring;
3445 ret = ptr_ring_resize_multiple(rings, n,
3446 dev->tx_queue_len, GFP_KERNEL,
3453 static int tun_device_event(struct notifier_block *unused,
3454 unsigned long event, void *ptr)
3456 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
3457 struct tun_struct *tun = netdev_priv(dev);
3459 if (dev->rtnl_link_ops != &tun_link_ops)
3463 case NETDEV_CHANGE_TX_QUEUE_LEN:
3464 if (tun_queue_resize(tun))
3474 static struct notifier_block tun_notifier_block __read_mostly = {
3475 .notifier_call = tun_device_event,
3478 static int __init tun_init(void)
3482 pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
3484 ret = rtnl_link_register(&tun_link_ops);
3486 pr_err("Can't register link_ops\n");
3490 ret = misc_register(&tun_miscdev);
3492 pr_err("Can't register misc device %d\n", TUN_MINOR);
3496 ret = register_netdevice_notifier(&tun_notifier_block);
3498 pr_err("Can't register netdevice notifier\n");
3505 misc_deregister(&tun_miscdev);
3507 rtnl_link_unregister(&tun_link_ops);
3512 static void tun_cleanup(void)
3514 misc_deregister(&tun_miscdev);
3515 rtnl_link_unregister(&tun_link_ops);
3516 unregister_netdevice_notifier(&tun_notifier_block);
3519 /* Get an underlying socket object from tun file. Returns error unless file is
3520 * attached to a device. The returned object works like a packet socket, it
3521 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
3522 * holding a reference to the file for as long as the socket is in use. */
3523 struct socket *tun_get_socket(struct file *file)
3525 struct tun_file *tfile;
3526 if (file->f_op != &tun_fops)
3527 return ERR_PTR(-EINVAL);
3528 tfile = file->private_data;
3530 return ERR_PTR(-EBADFD);
3531 return &tfile->socket;
3533 EXPORT_SYMBOL_GPL(tun_get_socket);
3535 struct ptr_ring *tun_get_tx_ring(struct file *file)
3537 struct tun_file *tfile;
3539 if (file->f_op != &tun_fops)
3540 return ERR_PTR(-EINVAL);
3541 tfile = file->private_data;
3543 return ERR_PTR(-EBADFD);
3544 return &tfile->tx_ring;
3546 EXPORT_SYMBOL_GPL(tun_get_tx_ring);
3548 module_init(tun_init);
3549 module_exit(tun_cleanup);
3550 MODULE_DESCRIPTION(DRV_DESCRIPTION);
3551 MODULE_AUTHOR(DRV_COPYRIGHT);
3552 MODULE_LICENSE("GPL");
3553 MODULE_ALIAS_MISCDEV(TUN_MINOR);
3554 MODULE_ALIAS("devname:net/tun");