1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * TUN - Universal TUN/TAP device driver.
4 * Copyright (C) 1999-2002 Maxim Krasnyansky <maxk@qualcomm.com>
6 * $Id: tun.c,v 1.15 2002/03/01 02:44:24 maxk Exp $
12 * Mike Kershaw <dragorn@kismetwireless.net> 2005/08/14
13 * Add TUNSETLINK ioctl to set the link encapsulation
15 * Mark Smith <markzzzsmith@yahoo.com.au>
16 * Use eth_random_addr() for tap MAC address.
18 * Harald Roelle <harald.roelle@ifi.lmu.de> 2004/04/20
19 * Fixes in packet dropping, queue length setting and queue wakeup.
20 * Increased default tx queue length.
24 * Daniel Podlejski <underley@underley.eu.org>
25 * Modifications for 2.3.99-pre5 kernel.
28 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
30 #define DRV_NAME "tun"
31 #define DRV_VERSION "1.6"
32 #define DRV_DESCRIPTION "Universal TUN/TAP device driver"
33 #define DRV_COPYRIGHT "(C) 1999-2004 Max Krasnyansky <maxk@qualcomm.com>"
35 #include <linux/module.h>
36 #include <linux/errno.h>
37 #include <linux/kernel.h>
38 #include <linux/sched/signal.h>
39 #include <linux/major.h>
40 #include <linux/slab.h>
41 #include <linux/poll.h>
42 #include <linux/fcntl.h>
43 #include <linux/init.h>
44 #include <linux/skbuff.h>
45 #include <linux/netdevice.h>
46 #include <linux/etherdevice.h>
47 #include <linux/miscdevice.h>
48 #include <linux/ethtool.h>
49 #include <linux/rtnetlink.h>
50 #include <linux/compat.h>
52 #include <linux/if_arp.h>
53 #include <linux/if_ether.h>
54 #include <linux/if_tun.h>
55 #include <linux/if_vlan.h>
56 #include <linux/crc32.h>
57 #include <linux/nsproxy.h>
58 #include <linux/virtio_net.h>
59 #include <linux/rcupdate.h>
60 #include <net/net_namespace.h>
61 #include <net/netns/generic.h>
62 #include <net/rtnetlink.h>
65 #include <net/ip_tunnels.h>
66 #include <linux/seq_file.h>
67 #include <linux/uio.h>
68 #include <linux/skb_array.h>
69 #include <linux/bpf.h>
70 #include <linux/bpf_trace.h>
71 #include <linux/mutex.h>
72 #include <linux/ieee802154.h>
73 #include <linux/if_ltalk.h>
74 #include <uapi/linux/if_fddi.h>
75 #include <uapi/linux/if_hippi.h>
76 #include <uapi/linux/if_fc.h>
79 #include <net/6lowpan.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 #define TUN_RX_PAD (NET_IP_ALIGN + NET_SKB_PAD)
89 /* TUN device flags */
91 /* IFF_ATTACH_QUEUE is never stored in device flags,
92 * overload it to mean fasync when stored there.
94 #define TUN_FASYNC IFF_ATTACH_QUEUE
95 /* High bits in flags field are unused. */
96 #define TUN_VNET_LE 0x80000000
97 #define TUN_VNET_BE 0x40000000
99 #define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
100 IFF_MULTI_QUEUE | IFF_NAPI | IFF_NAPI_FRAGS)
102 #define GOODCOPY_LEN 128
104 #define FLT_EXACT_COUNT 8
106 unsigned int count; /* Number of addrs. Zero means disabled */
107 u32 mask[2]; /* Mask of the hashed addrs */
108 unsigned char addr[FLT_EXACT_COUNT][ETH_ALEN];
111 /* MAX_TAP_QUEUES 256 is chosen to allow rx/tx queues to be equal
112 * to max number of VCPUs in guest. */
113 #define MAX_TAP_QUEUES 256
114 #define MAX_TAP_FLOWS 4096
116 #define TUN_FLOW_EXPIRE (3 * HZ)
118 struct tun_pcpu_stats {
119 u64_stats_t rx_packets;
120 u64_stats_t rx_bytes;
121 u64_stats_t tx_packets;
122 u64_stats_t tx_bytes;
123 struct u64_stats_sync syncp;
129 /* A tun_file connects an open character device to a tuntap netdevice. It
130 * also contains all socket related structures (except sock_fprog and tap_filter)
131 * to serve as one transmit queue for tuntap device. The sock_fprog and
132 * tap_filter were kept in tun_struct since they were used for filtering for the
133 * netdevice not for a specific queue (at least I didn't see the requirement for
137 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
138 * other can only be read while rcu_read_lock or rtnl_lock is held.
142 struct socket socket;
143 struct tun_struct __rcu *tun;
144 struct fasync_struct *fasync;
145 /* only used for fasnyc */
149 unsigned int ifindex;
151 struct napi_struct napi;
153 bool napi_frags_enabled;
154 struct mutex napi_mutex; /* Protects access to the above napi */
155 struct list_head next;
156 struct tun_struct *detached;
157 struct ptr_ring tx_ring;
158 struct xdp_rxq_info xdp_rxq;
166 struct tun_flow_entry {
167 struct hlist_node hash_link;
169 struct tun_struct *tun;
174 unsigned long updated ____cacheline_aligned_in_smp;
177 #define TUN_NUM_FLOW_ENTRIES 1024
178 #define TUN_MASK_FLOW_ENTRIES (TUN_NUM_FLOW_ENTRIES - 1)
182 struct bpf_prog *prog;
185 /* Since the socket were moved to tun_file, to preserve the behavior of persist
186 * device, socket filter, sndbuf and vnet header size were restore when the
187 * file were attached to a persist device.
190 struct tun_file __rcu *tfiles[MAX_TAP_QUEUES];
191 unsigned int numqueues;
196 struct net_device *dev;
197 netdev_features_t set_features;
198 #define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
204 struct tap_filter txflt;
205 struct sock_fprog fprog;
206 /* protected by rtnl lock */
207 bool filter_attached;
210 struct hlist_head flows[TUN_NUM_FLOW_ENTRIES];
211 struct timer_list flow_gc_timer;
212 unsigned long ageing_time;
213 unsigned int numdisabled;
214 struct list_head disabled;
218 struct tun_pcpu_stats __percpu *pcpu_stats;
219 struct bpf_prog __rcu *xdp_prog;
220 struct tun_prog __rcu *steering_prog;
221 struct tun_prog __rcu *filter_prog;
222 struct ethtool_link_ksettings link_ksettings;
233 static void tun_flow_init(struct tun_struct *tun);
234 static void tun_flow_uninit(struct tun_struct *tun);
236 static int tun_napi_receive(struct napi_struct *napi, int budget)
238 struct tun_file *tfile = container_of(napi, struct tun_file, napi);
239 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
240 struct sk_buff_head process_queue;
244 __skb_queue_head_init(&process_queue);
246 spin_lock(&queue->lock);
247 skb_queue_splice_tail_init(queue, &process_queue);
248 spin_unlock(&queue->lock);
250 while (received < budget && (skb = __skb_dequeue(&process_queue))) {
251 napi_gro_receive(napi, skb);
255 if (!skb_queue_empty(&process_queue)) {
256 spin_lock(&queue->lock);
257 skb_queue_splice(&process_queue, queue);
258 spin_unlock(&queue->lock);
264 static int tun_napi_poll(struct napi_struct *napi, int budget)
266 unsigned int received;
268 received = tun_napi_receive(napi, budget);
270 if (received < budget)
271 napi_complete_done(napi, received);
276 static void tun_napi_init(struct tun_struct *tun, struct tun_file *tfile,
277 bool napi_en, bool napi_frags)
279 tfile->napi_enabled = napi_en;
280 tfile->napi_frags_enabled = napi_en && napi_frags;
282 netif_tx_napi_add(tun->dev, &tfile->napi, tun_napi_poll,
284 napi_enable(&tfile->napi);
288 static void tun_napi_enable(struct tun_file *tfile)
290 if (tfile->napi_enabled)
291 napi_enable(&tfile->napi);
294 static void tun_napi_disable(struct tun_file *tfile)
296 if (tfile->napi_enabled)
297 napi_disable(&tfile->napi);
300 static void tun_napi_del(struct tun_file *tfile)
302 if (tfile->napi_enabled)
303 netif_napi_del(&tfile->napi);
306 static bool tun_napi_frags_enabled(const struct tun_file *tfile)
308 return tfile->napi_frags_enabled;
311 #ifdef CONFIG_TUN_VNET_CROSS_LE
312 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
314 return tun->flags & TUN_VNET_BE ? false :
315 virtio_legacy_is_little_endian();
318 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
320 int be = !!(tun->flags & TUN_VNET_BE);
322 if (put_user(be, argp))
328 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
332 if (get_user(be, argp))
336 tun->flags |= TUN_VNET_BE;
338 tun->flags &= ~TUN_VNET_BE;
343 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
345 return virtio_legacy_is_little_endian();
348 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
353 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
357 #endif /* CONFIG_TUN_VNET_CROSS_LE */
359 static inline bool tun_is_little_endian(struct tun_struct *tun)
361 return tun->flags & TUN_VNET_LE ||
362 tun_legacy_is_little_endian(tun);
365 static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
367 return __virtio16_to_cpu(tun_is_little_endian(tun), val);
370 static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
372 return __cpu_to_virtio16(tun_is_little_endian(tun), val);
375 static inline u32 tun_hashfn(u32 rxhash)
377 return rxhash & TUN_MASK_FLOW_ENTRIES;
380 static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
382 struct tun_flow_entry *e;
384 hlist_for_each_entry_rcu(e, head, hash_link) {
385 if (e->rxhash == rxhash)
391 static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
392 struct hlist_head *head,
393 u32 rxhash, u16 queue_index)
395 struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
398 netif_info(tun, tx_queued, tun->dev,
399 "create flow: hash %u index %u\n",
400 rxhash, queue_index);
401 e->updated = jiffies;
404 e->queue_index = queue_index;
406 hlist_add_head_rcu(&e->hash_link, head);
412 static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
414 netif_info(tun, tx_queued, tun->dev, "delete flow: hash %u index %u\n",
415 e->rxhash, e->queue_index);
416 hlist_del_rcu(&e->hash_link);
421 static void tun_flow_flush(struct tun_struct *tun)
425 spin_lock_bh(&tun->lock);
426 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
427 struct tun_flow_entry *e;
428 struct hlist_node *n;
430 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
431 tun_flow_delete(tun, e);
433 spin_unlock_bh(&tun->lock);
436 static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
440 spin_lock_bh(&tun->lock);
441 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
442 struct tun_flow_entry *e;
443 struct hlist_node *n;
445 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
446 if (e->queue_index == queue_index)
447 tun_flow_delete(tun, e);
450 spin_unlock_bh(&tun->lock);
453 static void tun_flow_cleanup(struct timer_list *t)
455 struct tun_struct *tun = from_timer(tun, t, flow_gc_timer);
456 unsigned long delay = tun->ageing_time;
457 unsigned long next_timer = jiffies + delay;
458 unsigned long count = 0;
461 spin_lock(&tun->lock);
462 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
463 struct tun_flow_entry *e;
464 struct hlist_node *n;
466 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
467 unsigned long this_timer;
469 this_timer = e->updated + delay;
470 if (time_before_eq(this_timer, jiffies)) {
471 tun_flow_delete(tun, e);
475 if (time_before(this_timer, next_timer))
476 next_timer = this_timer;
481 mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
482 spin_unlock(&tun->lock);
485 static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
486 struct tun_file *tfile)
488 struct hlist_head *head;
489 struct tun_flow_entry *e;
490 unsigned long delay = tun->ageing_time;
491 u16 queue_index = tfile->queue_index;
493 head = &tun->flows[tun_hashfn(rxhash)];
497 e = tun_flow_find(head, rxhash);
499 /* TODO: keep queueing to old queue until it's empty? */
500 if (READ_ONCE(e->queue_index) != queue_index)
501 WRITE_ONCE(e->queue_index, queue_index);
502 if (e->updated != jiffies)
503 e->updated = jiffies;
504 sock_rps_record_flow_hash(e->rps_rxhash);
506 spin_lock_bh(&tun->lock);
507 if (!tun_flow_find(head, rxhash) &&
508 tun->flow_count < MAX_TAP_FLOWS)
509 tun_flow_create(tun, head, rxhash, queue_index);
511 if (!timer_pending(&tun->flow_gc_timer))
512 mod_timer(&tun->flow_gc_timer,
513 round_jiffies_up(jiffies + delay));
514 spin_unlock_bh(&tun->lock);
520 /* Save the hash received in the stack receive path and update the
521 * flow_hash table accordingly.
523 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry *e, u32 hash)
525 if (unlikely(e->rps_rxhash != hash))
526 e->rps_rxhash = hash;
529 /* We try to identify a flow through its rxhash. The reason that
530 * we do not check rxq no. is because some cards(e.g 82599), chooses
531 * the rxq based on the txq where the last packet of the flow comes. As
532 * the userspace application move between processors, we may get a
533 * different rxq no. here.
535 static u16 tun_automq_select_queue(struct tun_struct *tun, struct sk_buff *skb)
537 struct tun_flow_entry *e;
541 numqueues = READ_ONCE(tun->numqueues);
543 txq = __skb_get_hash_symmetric(skb);
544 e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
546 tun_flow_save_rps_rxhash(e, txq);
547 txq = e->queue_index;
549 /* use multiply and shift instead of expensive divide */
550 txq = ((u64)txq * numqueues) >> 32;
556 static u16 tun_ebpf_select_queue(struct tun_struct *tun, struct sk_buff *skb)
558 struct tun_prog *prog;
562 numqueues = READ_ONCE(tun->numqueues);
566 prog = rcu_dereference(tun->steering_prog);
568 ret = bpf_prog_run_clear_cb(prog->prog, skb);
570 return ret % numqueues;
573 static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb,
574 struct net_device *sb_dev)
576 struct tun_struct *tun = netdev_priv(dev);
580 if (rcu_dereference(tun->steering_prog))
581 ret = tun_ebpf_select_queue(tun, skb);
583 ret = tun_automq_select_queue(tun, skb);
589 static inline bool tun_not_capable(struct tun_struct *tun)
591 const struct cred *cred = current_cred();
592 struct net *net = dev_net(tun->dev);
594 return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
595 (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
596 !ns_capable(net->user_ns, CAP_NET_ADMIN);
599 static void tun_set_real_num_queues(struct tun_struct *tun)
601 netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
602 netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
605 static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
607 tfile->detached = tun;
608 list_add_tail(&tfile->next, &tun->disabled);
612 static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
614 struct tun_struct *tun = tfile->detached;
616 tfile->detached = NULL;
617 list_del_init(&tfile->next);
622 void tun_ptr_free(void *ptr)
626 if (tun_is_xdp_frame(ptr)) {
627 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
629 xdp_return_frame(xdpf);
631 __skb_array_destroy_skb(ptr);
634 EXPORT_SYMBOL_GPL(tun_ptr_free);
636 static void tun_queue_purge(struct tun_file *tfile)
640 while ((ptr = ptr_ring_consume(&tfile->tx_ring)) != NULL)
643 skb_queue_purge(&tfile->sk.sk_write_queue);
644 skb_queue_purge(&tfile->sk.sk_error_queue);
647 static void __tun_detach(struct tun_file *tfile, bool clean)
649 struct tun_file *ntfile;
650 struct tun_struct *tun;
652 tun = rtnl_dereference(tfile->tun);
655 if (!tfile->detached)
656 tun_napi_disable(tfile);
660 if (tun && !tfile->detached) {
661 u16 index = tfile->queue_index;
662 BUG_ON(index >= tun->numqueues);
664 rcu_assign_pointer(tun->tfiles[index],
665 tun->tfiles[tun->numqueues - 1]);
666 ntfile = rtnl_dereference(tun->tfiles[index]);
667 ntfile->queue_index = index;
668 rcu_assign_pointer(tun->tfiles[tun->numqueues - 1],
673 RCU_INIT_POINTER(tfile->tun, NULL);
674 sock_put(&tfile->sk);
676 tun_disable_queue(tun, tfile);
677 tun_napi_disable(tfile);
681 tun_flow_delete_by_queue(tun, tun->numqueues + 1);
682 /* Drop read queue */
683 tun_queue_purge(tfile);
684 tun_set_real_num_queues(tun);
685 } else if (tfile->detached && clean) {
686 tun = tun_enable_queue(tfile);
687 sock_put(&tfile->sk);
691 if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
692 netif_carrier_off(tun->dev);
694 if (!(tun->flags & IFF_PERSIST) &&
695 tun->dev->reg_state == NETREG_REGISTERED)
696 unregister_netdevice(tun->dev);
699 xdp_rxq_info_unreg(&tfile->xdp_rxq);
700 ptr_ring_cleanup(&tfile->tx_ring, tun_ptr_free);
701 sock_put(&tfile->sk);
705 static void tun_detach(struct tun_file *tfile, bool clean)
707 struct tun_struct *tun;
708 struct net_device *dev;
711 tun = rtnl_dereference(tfile->tun);
712 dev = tun ? tun->dev : NULL;
713 __tun_detach(tfile, clean);
715 netdev_state_change(dev);
719 static void tun_detach_all(struct net_device *dev)
721 struct tun_struct *tun = netdev_priv(dev);
722 struct tun_file *tfile, *tmp;
723 int i, n = tun->numqueues;
725 for (i = 0; i < n; i++) {
726 tfile = rtnl_dereference(tun->tfiles[i]);
728 tun_napi_disable(tfile);
729 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
730 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
731 RCU_INIT_POINTER(tfile->tun, NULL);
734 list_for_each_entry(tfile, &tun->disabled, next) {
735 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
736 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
737 RCU_INIT_POINTER(tfile->tun, NULL);
739 BUG_ON(tun->numqueues != 0);
742 for (i = 0; i < n; i++) {
743 tfile = rtnl_dereference(tun->tfiles[i]);
745 /* Drop read queue */
746 tun_queue_purge(tfile);
747 xdp_rxq_info_unreg(&tfile->xdp_rxq);
748 sock_put(&tfile->sk);
750 list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
752 tun_enable_queue(tfile);
753 tun_queue_purge(tfile);
754 xdp_rxq_info_unreg(&tfile->xdp_rxq);
755 sock_put(&tfile->sk);
757 BUG_ON(tun->numdisabled != 0);
759 if (tun->flags & IFF_PERSIST)
760 module_put(THIS_MODULE);
763 static int tun_attach(struct tun_struct *tun, struct file *file,
764 bool skip_filter, bool napi, bool napi_frags,
767 struct tun_file *tfile = file->private_data;
768 struct net_device *dev = tun->dev;
771 err = security_tun_dev_attach(tfile->socket.sk, tun->security);
776 if (rtnl_dereference(tfile->tun) && !tfile->detached)
780 if (!(tun->flags & IFF_MULTI_QUEUE) && tun->numqueues == 1)
784 if (!tfile->detached &&
785 tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
790 /* Re-attach the filter to persist device */
791 if (!skip_filter && (tun->filter_attached == true)) {
792 lock_sock(tfile->socket.sk);
793 err = sk_attach_filter(&tun->fprog, tfile->socket.sk);
794 release_sock(tfile->socket.sk);
799 if (!tfile->detached &&
800 ptr_ring_resize(&tfile->tx_ring, dev->tx_queue_len,
801 GFP_KERNEL, tun_ptr_free)) {
806 tfile->queue_index = tun->numqueues;
807 tfile->socket.sk->sk_shutdown &= ~RCV_SHUTDOWN;
809 if (tfile->detached) {
810 /* Re-attach detached tfile, updating XDP queue_index */
811 WARN_ON(!xdp_rxq_info_is_reg(&tfile->xdp_rxq));
813 if (tfile->xdp_rxq.queue_index != tfile->queue_index)
814 tfile->xdp_rxq.queue_index = tfile->queue_index;
816 /* Setup XDP RX-queue info, for new tfile getting attached */
817 err = xdp_rxq_info_reg(&tfile->xdp_rxq,
818 tun->dev, tfile->queue_index);
821 err = xdp_rxq_info_reg_mem_model(&tfile->xdp_rxq,
822 MEM_TYPE_PAGE_SHARED, NULL);
824 xdp_rxq_info_unreg(&tfile->xdp_rxq);
830 if (tfile->detached) {
831 tun_enable_queue(tfile);
832 tun_napi_enable(tfile);
834 sock_hold(&tfile->sk);
835 tun_napi_init(tun, tfile, napi, napi_frags);
838 if (rtnl_dereference(tun->xdp_prog))
839 sock_set_flag(&tfile->sk, SOCK_XDP);
841 /* device is allowed to go away first, so no need to hold extra
845 /* Publish tfile->tun and tun->tfiles only after we've fully
846 * initialized tfile; otherwise we risk using half-initialized
850 rcu_assign_pointer(tfile->tun, tun);
851 rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
853 tun_set_real_num_queues(tun);
858 static struct tun_struct *tun_get(struct tun_file *tfile)
860 struct tun_struct *tun;
863 tun = rcu_dereference(tfile->tun);
871 static void tun_put(struct tun_struct *tun)
877 static void addr_hash_set(u32 *mask, const u8 *addr)
879 int n = ether_crc(ETH_ALEN, addr) >> 26;
880 mask[n >> 5] |= (1 << (n & 31));
883 static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
885 int n = ether_crc(ETH_ALEN, addr) >> 26;
886 return mask[n >> 5] & (1 << (n & 31));
889 static int update_filter(struct tap_filter *filter, void __user *arg)
891 struct { u8 u[ETH_ALEN]; } *addr;
892 struct tun_filter uf;
893 int err, alen, n, nexact;
895 if (copy_from_user(&uf, arg, sizeof(uf)))
904 alen = ETH_ALEN * uf.count;
905 addr = memdup_user(arg + sizeof(uf), alen);
907 return PTR_ERR(addr);
909 /* The filter is updated without holding any locks. Which is
910 * perfectly safe. We disable it first and in the worst
911 * case we'll accept a few undesired packets. */
915 /* Use first set of addresses as an exact filter */
916 for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
917 memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
921 /* Remaining multicast addresses are hashed,
922 * unicast will leave the filter disabled. */
923 memset(filter->mask, 0, sizeof(filter->mask));
924 for (; n < uf.count; n++) {
925 if (!is_multicast_ether_addr(addr[n].u)) {
926 err = 0; /* no filter */
929 addr_hash_set(filter->mask, addr[n].u);
932 /* For ALLMULTI just set the mask to all ones.
933 * This overrides the mask populated above. */
934 if ((uf.flags & TUN_FLT_ALLMULTI))
935 memset(filter->mask, ~0, sizeof(filter->mask));
937 /* Now enable the filter */
939 filter->count = nexact;
941 /* Return the number of exact filters */
948 /* Returns: 0 - drop, !=0 - accept */
949 static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
951 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
953 struct ethhdr *eh = (struct ethhdr *) skb->data;
957 for (i = 0; i < filter->count; i++)
958 if (ether_addr_equal(eh->h_dest, filter->addr[i]))
961 /* Inexact match (multicast only) */
962 if (is_multicast_ether_addr(eh->h_dest))
963 return addr_hash_test(filter->mask, eh->h_dest);
969 * Checks whether the packet is accepted or not.
970 * Returns: 0 - drop, !=0 - accept
972 static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
977 return run_filter(filter, skb);
980 /* Network device part of the driver */
982 static const struct ethtool_ops tun_ethtool_ops;
984 static int tun_net_init(struct net_device *dev)
986 struct tun_struct *tun = netdev_priv(dev);
987 struct ifreq *ifr = tun->ifr;
990 tun->pcpu_stats = netdev_alloc_pcpu_stats(struct tun_pcpu_stats);
991 if (!tun->pcpu_stats)
994 spin_lock_init(&tun->lock);
996 err = security_tun_dev_alloc_security(&tun->security);
998 free_percpu(tun->pcpu_stats);
1004 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
1005 TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
1006 NETIF_F_HW_VLAN_STAG_TX;
1007 dev->features = dev->hw_features | NETIF_F_LLTX;
1008 dev->vlan_features = dev->features &
1009 ~(NETIF_F_HW_VLAN_CTAG_TX |
1010 NETIF_F_HW_VLAN_STAG_TX);
1012 tun->flags = (tun->flags & ~TUN_FEATURES) |
1013 (ifr->ifr_flags & TUN_FEATURES);
1015 INIT_LIST_HEAD(&tun->disabled);
1016 err = tun_attach(tun, tun->file, false, ifr->ifr_flags & IFF_NAPI,
1017 ifr->ifr_flags & IFF_NAPI_FRAGS, false);
1019 tun_flow_uninit(tun);
1020 security_tun_dev_free_security(tun->security);
1021 free_percpu(tun->pcpu_stats);
1027 /* Net device detach from fd. */
1028 static void tun_net_uninit(struct net_device *dev)
1030 tun_detach_all(dev);
1033 /* Net device open. */
1034 static int tun_net_open(struct net_device *dev)
1036 netif_tx_start_all_queues(dev);
1041 /* Net device close. */
1042 static int tun_net_close(struct net_device *dev)
1044 netif_tx_stop_all_queues(dev);
1048 /* Net device start xmit */
1049 static void tun_automq_xmit(struct tun_struct *tun, struct sk_buff *skb)
1052 if (tun->numqueues == 1 && static_branch_unlikely(&rps_needed)) {
1053 /* Select queue was not called for the skbuff, so we extract the
1054 * RPS hash and save it into the flow_table here.
1056 struct tun_flow_entry *e;
1059 rxhash = __skb_get_hash_symmetric(skb);
1060 e = tun_flow_find(&tun->flows[tun_hashfn(rxhash)], rxhash);
1062 tun_flow_save_rps_rxhash(e, rxhash);
1067 static unsigned int run_ebpf_filter(struct tun_struct *tun,
1068 struct sk_buff *skb,
1071 struct tun_prog *prog = rcu_dereference(tun->filter_prog);
1074 len = bpf_prog_run_clear_cb(prog->prog, skb);
1079 /* Net device start xmit */
1080 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
1082 struct tun_struct *tun = netdev_priv(dev);
1083 int txq = skb->queue_mapping;
1084 struct netdev_queue *queue;
1085 struct tun_file *tfile;
1089 tfile = rcu_dereference(tun->tfiles[txq]);
1091 /* Drop packet if interface is not attached */
1095 if (!rcu_dereference(tun->steering_prog))
1096 tun_automq_xmit(tun, skb);
1098 netif_info(tun, tx_queued, tun->dev, "%s %d\n", __func__, skb->len);
1100 /* Drop if the filter does not like it.
1101 * This is a noop if the filter is disabled.
1102 * Filter can be enabled only for the TAP devices. */
1103 if (!check_filter(&tun->txflt, skb))
1106 if (tfile->socket.sk->sk_filter &&
1107 sk_filter(tfile->socket.sk, skb))
1110 len = run_ebpf_filter(tun, skb, len);
1111 if (len == 0 || pskb_trim(skb, len))
1114 if (unlikely(skb_orphan_frags_rx(skb, GFP_ATOMIC)))
1117 skb_tx_timestamp(skb);
1119 /* Orphan the skb - required as we might hang on to it
1120 * for indefinite time.
1126 if (ptr_ring_produce(&tfile->tx_ring, skb))
1129 /* NETIF_F_LLTX requires to do our own update of trans_start */
1130 queue = netdev_get_tx_queue(dev, txq);
1131 queue->trans_start = jiffies;
1133 /* Notify and wake up reader process */
1134 if (tfile->flags & TUN_FASYNC)
1135 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1136 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1139 return NETDEV_TX_OK;
1142 this_cpu_inc(tun->pcpu_stats->tx_dropped);
1146 return NET_XMIT_DROP;
1149 static void tun_net_mclist(struct net_device *dev)
1152 * This callback is supposed to deal with mc filter in
1153 * _rx_ path and has nothing to do with the _tx_ path.
1154 * In rx path we always accept everything userspace gives us.
1158 static netdev_features_t tun_net_fix_features(struct net_device *dev,
1159 netdev_features_t features)
1161 struct tun_struct *tun = netdev_priv(dev);
1163 return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
1166 static void tun_set_headroom(struct net_device *dev, int new_hr)
1168 struct tun_struct *tun = netdev_priv(dev);
1170 if (new_hr < NET_SKB_PAD)
1171 new_hr = NET_SKB_PAD;
1173 tun->align = new_hr;
1177 tun_net_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats)
1179 u32 rx_dropped = 0, tx_dropped = 0, rx_frame_errors = 0;
1180 struct tun_struct *tun = netdev_priv(dev);
1181 struct tun_pcpu_stats *p;
1184 for_each_possible_cpu(i) {
1185 u64 rxpackets, rxbytes, txpackets, txbytes;
1188 p = per_cpu_ptr(tun->pcpu_stats, i);
1190 start = u64_stats_fetch_begin(&p->syncp);
1191 rxpackets = u64_stats_read(&p->rx_packets);
1192 rxbytes = u64_stats_read(&p->rx_bytes);
1193 txpackets = u64_stats_read(&p->tx_packets);
1194 txbytes = u64_stats_read(&p->tx_bytes);
1195 } while (u64_stats_fetch_retry(&p->syncp, start));
1197 stats->rx_packets += rxpackets;
1198 stats->rx_bytes += rxbytes;
1199 stats->tx_packets += txpackets;
1200 stats->tx_bytes += txbytes;
1203 rx_dropped += p->rx_dropped;
1204 rx_frame_errors += p->rx_frame_errors;
1205 tx_dropped += p->tx_dropped;
1207 stats->rx_dropped = rx_dropped;
1208 stats->rx_frame_errors = rx_frame_errors;
1209 stats->tx_dropped = tx_dropped;
1212 static int tun_xdp_set(struct net_device *dev, struct bpf_prog *prog,
1213 struct netlink_ext_ack *extack)
1215 struct tun_struct *tun = netdev_priv(dev);
1216 struct tun_file *tfile;
1217 struct bpf_prog *old_prog;
1220 old_prog = rtnl_dereference(tun->xdp_prog);
1221 rcu_assign_pointer(tun->xdp_prog, prog);
1223 bpf_prog_put(old_prog);
1225 for (i = 0; i < tun->numqueues; i++) {
1226 tfile = rtnl_dereference(tun->tfiles[i]);
1228 sock_set_flag(&tfile->sk, SOCK_XDP);
1230 sock_reset_flag(&tfile->sk, SOCK_XDP);
1232 list_for_each_entry(tfile, &tun->disabled, next) {
1234 sock_set_flag(&tfile->sk, SOCK_XDP);
1236 sock_reset_flag(&tfile->sk, SOCK_XDP);
1242 static int tun_xdp(struct net_device *dev, struct netdev_bpf *xdp)
1244 switch (xdp->command) {
1245 case XDP_SETUP_PROG:
1246 return tun_xdp_set(dev, xdp->prog, xdp->extack);
1252 static int tun_net_change_carrier(struct net_device *dev, bool new_carrier)
1255 struct tun_struct *tun = netdev_priv(dev);
1257 if (!tun->numqueues)
1260 netif_carrier_on(dev);
1262 netif_carrier_off(dev);
1267 static const struct net_device_ops tun_netdev_ops = {
1268 .ndo_init = tun_net_init,
1269 .ndo_uninit = tun_net_uninit,
1270 .ndo_open = tun_net_open,
1271 .ndo_stop = tun_net_close,
1272 .ndo_start_xmit = tun_net_xmit,
1273 .ndo_fix_features = tun_net_fix_features,
1274 .ndo_select_queue = tun_select_queue,
1275 .ndo_set_rx_headroom = tun_set_headroom,
1276 .ndo_get_stats64 = tun_net_get_stats64,
1277 .ndo_change_carrier = tun_net_change_carrier,
1280 static void __tun_xdp_flush_tfile(struct tun_file *tfile)
1282 /* Notify and wake up reader process */
1283 if (tfile->flags & TUN_FASYNC)
1284 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1285 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1288 static int tun_xdp_xmit(struct net_device *dev, int n,
1289 struct xdp_frame **frames, u32 flags)
1291 struct tun_struct *tun = netdev_priv(dev);
1292 struct tun_file *tfile;
1298 if (unlikely(flags & ~XDP_XMIT_FLAGS_MASK))
1304 numqueues = READ_ONCE(tun->numqueues);
1307 return -ENXIO; /* Caller will free/return all frames */
1310 tfile = rcu_dereference(tun->tfiles[smp_processor_id() %
1312 if (unlikely(!tfile))
1315 spin_lock(&tfile->tx_ring.producer_lock);
1316 for (i = 0; i < n; i++) {
1317 struct xdp_frame *xdp = frames[i];
1318 /* Encode the XDP flag into lowest bit for consumer to differ
1319 * XDP buffer from sk_buff.
1321 void *frame = tun_xdp_to_ptr(xdp);
1323 if (__ptr_ring_produce(&tfile->tx_ring, frame)) {
1324 this_cpu_inc(tun->pcpu_stats->tx_dropped);
1325 xdp_return_frame_rx_napi(xdp);
1329 spin_unlock(&tfile->tx_ring.producer_lock);
1331 if (flags & XDP_XMIT_FLUSH)
1332 __tun_xdp_flush_tfile(tfile);
1338 static int tun_xdp_tx(struct net_device *dev, struct xdp_buff *xdp)
1340 struct xdp_frame *frame = xdp_convert_buff_to_frame(xdp);
1342 if (unlikely(!frame))
1345 return tun_xdp_xmit(dev, 1, &frame, XDP_XMIT_FLUSH);
1348 static const struct net_device_ops tap_netdev_ops = {
1349 .ndo_init = tun_net_init,
1350 .ndo_uninit = tun_net_uninit,
1351 .ndo_open = tun_net_open,
1352 .ndo_stop = tun_net_close,
1353 .ndo_start_xmit = tun_net_xmit,
1354 .ndo_fix_features = tun_net_fix_features,
1355 .ndo_set_rx_mode = tun_net_mclist,
1356 .ndo_set_mac_address = eth_mac_addr,
1357 .ndo_validate_addr = eth_validate_addr,
1358 .ndo_select_queue = tun_select_queue,
1359 .ndo_features_check = passthru_features_check,
1360 .ndo_set_rx_headroom = tun_set_headroom,
1361 .ndo_get_stats64 = tun_net_get_stats64,
1363 .ndo_xdp_xmit = tun_xdp_xmit,
1364 .ndo_change_carrier = tun_net_change_carrier,
1367 static void tun_flow_init(struct tun_struct *tun)
1371 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
1372 INIT_HLIST_HEAD(&tun->flows[i]);
1374 tun->ageing_time = TUN_FLOW_EXPIRE;
1375 timer_setup(&tun->flow_gc_timer, tun_flow_cleanup, 0);
1376 mod_timer(&tun->flow_gc_timer,
1377 round_jiffies_up(jiffies + tun->ageing_time));
1380 static void tun_flow_uninit(struct tun_struct *tun)
1382 del_timer_sync(&tun->flow_gc_timer);
1383 tun_flow_flush(tun);
1387 #define MAX_MTU 65535
1389 /* Initialize net device. */
1390 static void tun_net_initialize(struct net_device *dev)
1392 struct tun_struct *tun = netdev_priv(dev);
1394 switch (tun->flags & TUN_TYPE_MASK) {
1396 dev->netdev_ops = &tun_netdev_ops;
1397 dev->header_ops = &ip_tunnel_header_ops;
1399 /* Point-to-Point TUN Device */
1400 dev->hard_header_len = 0;
1404 /* Zero header length */
1405 dev->type = ARPHRD_NONE;
1406 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
1410 dev->netdev_ops = &tap_netdev_ops;
1411 /* Ethernet TAP Device */
1413 dev->priv_flags &= ~IFF_TX_SKB_SHARING;
1414 dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
1416 eth_hw_addr_random(dev);
1421 dev->min_mtu = MIN_MTU;
1422 dev->max_mtu = MAX_MTU - dev->hard_header_len;
1425 static bool tun_sock_writeable(struct tun_struct *tun, struct tun_file *tfile)
1427 struct sock *sk = tfile->socket.sk;
1429 return (tun->dev->flags & IFF_UP) && sock_writeable(sk);
1432 /* Character device part */
1435 static __poll_t tun_chr_poll(struct file *file, poll_table *wait)
1437 struct tun_file *tfile = file->private_data;
1438 struct tun_struct *tun = tun_get(tfile);
1445 sk = tfile->socket.sk;
1447 poll_wait(file, sk_sleep(sk), wait);
1449 if (!ptr_ring_empty(&tfile->tx_ring))
1450 mask |= EPOLLIN | EPOLLRDNORM;
1452 /* Make sure SOCKWQ_ASYNC_NOSPACE is set if not writable to
1453 * guarantee EPOLLOUT to be raised by either here or
1454 * tun_sock_write_space(). Then process could get notification
1455 * after it writes to a down device and meets -EIO.
1457 if (tun_sock_writeable(tun, tfile) ||
1458 (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
1459 tun_sock_writeable(tun, tfile)))
1460 mask |= EPOLLOUT | EPOLLWRNORM;
1462 if (tun->dev->reg_state != NETREG_REGISTERED)
1469 static struct sk_buff *tun_napi_alloc_frags(struct tun_file *tfile,
1471 const struct iov_iter *it)
1473 struct sk_buff *skb;
1478 if (it->nr_segs > MAX_SKB_FRAGS + 1)
1479 return ERR_PTR(-EMSGSIZE);
1482 skb = napi_get_frags(&tfile->napi);
1485 return ERR_PTR(-ENOMEM);
1487 linear = iov_iter_single_seg_count(it);
1488 err = __skb_grow(skb, linear);
1493 skb->data_len = len - linear;
1494 skb->truesize += skb->data_len;
1496 for (i = 1; i < it->nr_segs; i++) {
1497 size_t fragsz = it->iov[i].iov_len;
1501 if (fragsz == 0 || fragsz > PAGE_SIZE) {
1505 frag = netdev_alloc_frag(fragsz);
1510 page = virt_to_head_page(frag);
1511 skb_fill_page_desc(skb, i - 1, page,
1512 frag - page_address(page), 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 skb_record_rx_queue(skb, tfile->queue_index);
1560 netif_receive_skb(skb);
1565 spin_lock(&queue->lock);
1566 if (!more || skb_queue_len(queue) == rx_batched) {
1567 __skb_queue_head_init(&process_queue);
1568 skb_queue_splice_tail_init(queue, &process_queue);
1571 __skb_queue_tail(queue, skb);
1573 spin_unlock(&queue->lock);
1576 struct sk_buff *nskb;
1579 while ((nskb = __skb_dequeue(&process_queue))) {
1580 skb_record_rx_queue(nskb, tfile->queue_index);
1581 netif_receive_skb(nskb);
1583 skb_record_rx_queue(skb, tfile->queue_index);
1584 netif_receive_skb(skb);
1589 static bool tun_can_build_skb(struct tun_struct *tun, struct tun_file *tfile,
1590 int len, int noblock, bool zerocopy)
1592 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
1595 if (tfile->socket.sk->sk_sndbuf != INT_MAX)
1604 if (SKB_DATA_ALIGN(len + TUN_RX_PAD) +
1605 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
1611 static struct sk_buff *__tun_build_skb(struct tun_file *tfile,
1612 struct page_frag *alloc_frag, char *buf,
1613 int buflen, int len, int pad)
1615 struct sk_buff *skb = build_skb(buf, buflen);
1618 return ERR_PTR(-ENOMEM);
1620 skb_reserve(skb, pad);
1622 skb_set_owner_w(skb, tfile->socket.sk);
1624 get_page(alloc_frag->page);
1625 alloc_frag->offset += buflen;
1630 static int tun_xdp_act(struct tun_struct *tun, struct bpf_prog *xdp_prog,
1631 struct xdp_buff *xdp, u32 act)
1637 err = xdp_do_redirect(tun->dev, xdp, xdp_prog);
1642 err = tun_xdp_tx(tun->dev, xdp);
1649 bpf_warn_invalid_xdp_action(act);
1652 trace_xdp_exception(tun->dev, xdp_prog, act);
1655 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1662 static struct sk_buff *tun_build_skb(struct tun_struct *tun,
1663 struct tun_file *tfile,
1664 struct iov_iter *from,
1665 struct virtio_net_hdr *hdr,
1666 int len, int *skb_xdp)
1668 struct page_frag *alloc_frag = ¤t->task_frag;
1669 struct bpf_prog *xdp_prog;
1670 int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
1673 int pad = TUN_RX_PAD;
1677 xdp_prog = rcu_dereference(tun->xdp_prog);
1679 pad += XDP_PACKET_HEADROOM;
1680 buflen += SKB_DATA_ALIGN(len + pad);
1683 alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
1684 if (unlikely(!skb_page_frag_refill(buflen, alloc_frag, GFP_KERNEL)))
1685 return ERR_PTR(-ENOMEM);
1687 buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
1688 copied = copy_page_from_iter(alloc_frag->page,
1689 alloc_frag->offset + pad,
1692 return ERR_PTR(-EFAULT);
1694 /* There's a small window that XDP may be set after the check
1695 * of xdp_prog above, this should be rare and for simplicity
1696 * we do XDP on skb in case the headroom is not enough.
1698 if (hdr->gso_type || !xdp_prog) {
1700 return __tun_build_skb(tfile, alloc_frag, buf, buflen, len,
1708 xdp_prog = rcu_dereference(tun->xdp_prog);
1710 struct xdp_buff xdp;
1713 xdp.data_hard_start = buf;
1714 xdp.data = buf + pad;
1715 xdp_set_data_meta_invalid(&xdp);
1716 xdp.data_end = xdp.data + len;
1717 xdp.rxq = &tfile->xdp_rxq;
1718 xdp.frame_sz = buflen;
1720 act = bpf_prog_run_xdp(xdp_prog, &xdp);
1721 if (act == XDP_REDIRECT || act == XDP_TX) {
1722 get_page(alloc_frag->page);
1723 alloc_frag->offset += buflen;
1725 err = tun_xdp_act(tun, xdp_prog, &xdp, act);
1727 if (act == XDP_REDIRECT || act == XDP_TX)
1728 put_page(alloc_frag->page);
1732 if (err == XDP_REDIRECT)
1734 if (err != XDP_PASS)
1737 pad = xdp.data - xdp.data_hard_start;
1738 len = xdp.data_end - xdp.data;
1743 return __tun_build_skb(tfile, alloc_frag, buf, buflen, len, pad);
1751 /* Get packet from user space buffer */
1752 static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
1753 void *msg_control, struct iov_iter *from,
1754 int noblock, bool more)
1756 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1757 struct sk_buff *skb;
1758 size_t total_len = iov_iter_count(from);
1759 size_t len = total_len, align = tun->align, linear;
1760 struct virtio_net_hdr gso = { 0 };
1761 struct tun_pcpu_stats *stats;
1764 bool zerocopy = false;
1768 bool frags = tun_napi_frags_enabled(tfile);
1770 if (!(tun->flags & IFF_NO_PI)) {
1771 if (len < sizeof(pi))
1775 if (!copy_from_iter_full(&pi, sizeof(pi), from))
1779 if (tun->flags & IFF_VNET_HDR) {
1780 int vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1782 if (len < vnet_hdr_sz)
1786 if (!copy_from_iter_full(&gso, sizeof(gso), from))
1789 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
1790 tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1791 gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
1793 if (tun16_to_cpu(tun, gso.hdr_len) > len)
1795 iov_iter_advance(from, vnet_hdr_sz - sizeof(gso));
1798 if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
1799 align += NET_IP_ALIGN;
1800 if (unlikely(len < ETH_HLEN ||
1801 (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
1805 good_linear = SKB_MAX_HEAD(align);
1808 struct iov_iter i = *from;
1810 /* There are 256 bytes to be copied in skb, so there is
1811 * enough room for skb expand head in case it is used.
1812 * The rest of the buffer is mapped from userspace.
1814 copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
1815 if (copylen > good_linear)
1816 copylen = good_linear;
1818 iov_iter_advance(&i, copylen);
1819 if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
1823 if (!frags && tun_can_build_skb(tun, tfile, len, noblock, zerocopy)) {
1824 /* For the packet that is not easy to be processed
1825 * (e.g gso or jumbo packet), we will do it at after
1826 * skb was created with generic XDP routine.
1828 skb = tun_build_skb(tun, tfile, from, &gso, len, &skb_xdp);
1830 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1831 return PTR_ERR(skb);
1838 if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1839 linear = good_linear;
1841 linear = tun16_to_cpu(tun, gso.hdr_len);
1845 mutex_lock(&tfile->napi_mutex);
1846 skb = tun_napi_alloc_frags(tfile, copylen, from);
1847 /* tun_napi_alloc_frags() enforces a layout for the skb.
1848 * If zerocopy is enabled, then this layout will be
1849 * overwritten by zerocopy_sg_from_iter().
1853 skb = tun_alloc_skb(tfile, align, copylen, linear,
1858 if (PTR_ERR(skb) != -EAGAIN)
1859 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1861 mutex_unlock(&tfile->napi_mutex);
1862 return PTR_ERR(skb);
1866 err = zerocopy_sg_from_iter(skb, from);
1868 err = skb_copy_datagram_from_iter(skb, 0, from, len);
1873 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1876 tfile->napi.skb = NULL;
1877 mutex_unlock(&tfile->napi_mutex);
1884 if (virtio_net_hdr_to_skb(skb, &gso, tun_is_little_endian(tun))) {
1885 this_cpu_inc(tun->pcpu_stats->rx_frame_errors);
1888 tfile->napi.skb = NULL;
1889 mutex_unlock(&tfile->napi_mutex);
1895 switch (tun->flags & TUN_TYPE_MASK) {
1897 if (tun->flags & IFF_NO_PI) {
1898 u8 ip_version = skb->len ? (skb->data[0] >> 4) : 0;
1900 switch (ip_version) {
1902 pi.proto = htons(ETH_P_IP);
1905 pi.proto = htons(ETH_P_IPV6);
1908 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1914 skb_reset_mac_header(skb);
1915 skb->protocol = pi.proto;
1916 skb->dev = tun->dev;
1919 if (frags && !pskb_may_pull(skb, ETH_HLEN)) {
1923 skb->protocol = eth_type_trans(skb, tun->dev);
1927 /* copy skb_ubuf_info for callback when skb has no error */
1929 skb_shinfo(skb)->destructor_arg = msg_control;
1930 skb_shinfo(skb)->tx_flags |= SKBTX_DEV_ZEROCOPY;
1931 skb_shinfo(skb)->tx_flags |= SKBTX_SHARED_FRAG;
1932 } else if (msg_control) {
1933 struct ubuf_info *uarg = msg_control;
1934 uarg->callback(uarg, false);
1937 skb_reset_network_header(skb);
1938 skb_probe_transport_header(skb);
1939 skb_record_rx_queue(skb, tfile->queue_index);
1942 struct bpf_prog *xdp_prog;
1947 xdp_prog = rcu_dereference(tun->xdp_prog);
1949 ret = do_xdp_generic(xdp_prog, skb);
1950 if (ret != XDP_PASS) {
1954 tfile->napi.skb = NULL;
1955 mutex_unlock(&tfile->napi_mutex);
1964 /* Compute the costly rx hash only if needed for flow updates.
1965 * We may get a very small possibility of OOO during switching, not
1966 * worth to optimize.
1968 if (!rcu_access_pointer(tun->steering_prog) && tun->numqueues > 1 &&
1970 rxhash = __skb_get_hash_symmetric(skb);
1973 if (unlikely(!(tun->dev->flags & IFF_UP))) {
1982 /* Exercise flow dissector code path. */
1983 skb_push(skb, ETH_HLEN);
1984 headlen = eth_get_headlen(tun->dev, skb->data,
1987 if (unlikely(headlen > skb_headlen(skb))) {
1988 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1989 napi_free_frags(&tfile->napi);
1991 mutex_unlock(&tfile->napi_mutex);
1997 napi_gro_frags(&tfile->napi);
1999 mutex_unlock(&tfile->napi_mutex);
2000 } else if (tfile->napi_enabled) {
2001 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
2004 spin_lock_bh(&queue->lock);
2005 __skb_queue_tail(queue, skb);
2006 queue_len = skb_queue_len(queue);
2007 spin_unlock(&queue->lock);
2009 if (!more || queue_len > NAPI_POLL_WEIGHT)
2010 napi_schedule(&tfile->napi);
2013 } else if (!IS_ENABLED(CONFIG_4KSTACKS)) {
2014 tun_rx_batched(tun, tfile, skb, more);
2020 stats = get_cpu_ptr(tun->pcpu_stats);
2021 u64_stats_update_begin(&stats->syncp);
2022 u64_stats_inc(&stats->rx_packets);
2023 u64_stats_add(&stats->rx_bytes, len);
2024 u64_stats_update_end(&stats->syncp);
2028 tun_flow_update(tun, rxhash, tfile);
2033 static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
2035 struct file *file = iocb->ki_filp;
2036 struct tun_file *tfile = file->private_data;
2037 struct tun_struct *tun = tun_get(tfile);
2044 if ((file->f_flags & O_NONBLOCK) || (iocb->ki_flags & IOCB_NOWAIT))
2047 result = tun_get_user(tun, tfile, NULL, from, noblock, false);
2053 static ssize_t tun_put_user_xdp(struct tun_struct *tun,
2054 struct tun_file *tfile,
2055 struct xdp_frame *xdp_frame,
2056 struct iov_iter *iter)
2058 int vnet_hdr_sz = 0;
2059 size_t size = xdp_frame->len;
2060 struct tun_pcpu_stats *stats;
2063 if (tun->flags & IFF_VNET_HDR) {
2064 struct virtio_net_hdr gso = { 0 };
2066 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2067 if (unlikely(iov_iter_count(iter) < vnet_hdr_sz))
2069 if (unlikely(copy_to_iter(&gso, sizeof(gso), iter) !=
2072 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2075 ret = copy_to_iter(xdp_frame->data, size, iter) + vnet_hdr_sz;
2077 stats = get_cpu_ptr(tun->pcpu_stats);
2078 u64_stats_update_begin(&stats->syncp);
2079 u64_stats_inc(&stats->tx_packets);
2080 u64_stats_add(&stats->tx_bytes, ret);
2081 u64_stats_update_end(&stats->syncp);
2082 put_cpu_ptr(tun->pcpu_stats);
2087 /* Put packet to the user space buffer */
2088 static ssize_t tun_put_user(struct tun_struct *tun,
2089 struct tun_file *tfile,
2090 struct sk_buff *skb,
2091 struct iov_iter *iter)
2093 struct tun_pi pi = { 0, skb->protocol };
2094 struct tun_pcpu_stats *stats;
2096 int vlan_offset = 0;
2098 int vnet_hdr_sz = 0;
2100 if (skb_vlan_tag_present(skb))
2101 vlan_hlen = VLAN_HLEN;
2103 if (tun->flags & IFF_VNET_HDR)
2104 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2106 total = skb->len + vlan_hlen + vnet_hdr_sz;
2108 if (!(tun->flags & IFF_NO_PI)) {
2109 if (iov_iter_count(iter) < sizeof(pi))
2112 total += sizeof(pi);
2113 if (iov_iter_count(iter) < total) {
2114 /* Packet will be striped */
2115 pi.flags |= TUN_PKT_STRIP;
2118 if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
2123 struct virtio_net_hdr gso;
2125 if (iov_iter_count(iter) < vnet_hdr_sz)
2128 if (virtio_net_hdr_from_skb(skb, &gso,
2129 tun_is_little_endian(tun), true,
2131 struct skb_shared_info *sinfo = skb_shinfo(skb);
2132 pr_err("unexpected GSO type: "
2133 "0x%x, gso_size %d, hdr_len %d\n",
2134 sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
2135 tun16_to_cpu(tun, gso.hdr_len));
2136 print_hex_dump(KERN_ERR, "tun: ",
2139 min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
2144 if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
2147 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2154 veth.h_vlan_proto = skb->vlan_proto;
2155 veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
2157 vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
2159 ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
2160 if (ret || !iov_iter_count(iter))
2163 ret = copy_to_iter(&veth, sizeof(veth), iter);
2164 if (ret != sizeof(veth) || !iov_iter_count(iter))
2168 skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
2171 /* caller is in process context, */
2172 stats = get_cpu_ptr(tun->pcpu_stats);
2173 u64_stats_update_begin(&stats->syncp);
2174 u64_stats_inc(&stats->tx_packets);
2175 u64_stats_add(&stats->tx_bytes, skb->len + vlan_hlen);
2176 u64_stats_update_end(&stats->syncp);
2177 put_cpu_ptr(tun->pcpu_stats);
2182 static void *tun_ring_recv(struct tun_file *tfile, int noblock, int *err)
2184 DECLARE_WAITQUEUE(wait, current);
2188 ptr = ptr_ring_consume(&tfile->tx_ring);
2196 add_wait_queue(&tfile->socket.wq.wait, &wait);
2199 set_current_state(TASK_INTERRUPTIBLE);
2200 ptr = ptr_ring_consume(&tfile->tx_ring);
2203 if (signal_pending(current)) {
2204 error = -ERESTARTSYS;
2207 if (tfile->socket.sk->sk_shutdown & RCV_SHUTDOWN) {
2215 __set_current_state(TASK_RUNNING);
2216 remove_wait_queue(&tfile->socket.wq.wait, &wait);
2223 static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
2224 struct iov_iter *to,
2225 int noblock, void *ptr)
2230 if (!iov_iter_count(to)) {
2236 /* Read frames from ring */
2237 ptr = tun_ring_recv(tfile, noblock, &err);
2242 if (tun_is_xdp_frame(ptr)) {
2243 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2245 ret = tun_put_user_xdp(tun, tfile, xdpf, to);
2246 xdp_return_frame(xdpf);
2248 struct sk_buff *skb = ptr;
2250 ret = tun_put_user(tun, tfile, skb, to);
2251 if (unlikely(ret < 0))
2260 static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
2262 struct file *file = iocb->ki_filp;
2263 struct tun_file *tfile = file->private_data;
2264 struct tun_struct *tun = tun_get(tfile);
2265 ssize_t len = iov_iter_count(to), ret;
2271 if ((file->f_flags & O_NONBLOCK) || (iocb->ki_flags & IOCB_NOWAIT))
2274 ret = tun_do_read(tun, tfile, to, noblock, NULL);
2275 ret = min_t(ssize_t, ret, len);
2282 static void tun_prog_free(struct rcu_head *rcu)
2284 struct tun_prog *prog = container_of(rcu, struct tun_prog, rcu);
2286 bpf_prog_destroy(prog->prog);
2290 static int __tun_set_ebpf(struct tun_struct *tun,
2291 struct tun_prog __rcu **prog_p,
2292 struct bpf_prog *prog)
2294 struct tun_prog *old, *new = NULL;
2297 new = kmalloc(sizeof(*new), GFP_KERNEL);
2303 spin_lock_bh(&tun->lock);
2304 old = rcu_dereference_protected(*prog_p,
2305 lockdep_is_held(&tun->lock));
2306 rcu_assign_pointer(*prog_p, new);
2307 spin_unlock_bh(&tun->lock);
2310 call_rcu(&old->rcu, tun_prog_free);
2315 static void tun_free_netdev(struct net_device *dev)
2317 struct tun_struct *tun = netdev_priv(dev);
2319 BUG_ON(!(list_empty(&tun->disabled)));
2321 free_percpu(tun->pcpu_stats);
2323 tun_flow_uninit(tun);
2324 security_tun_dev_free_security(tun->security);
2325 __tun_set_ebpf(tun, &tun->steering_prog, NULL);
2326 __tun_set_ebpf(tun, &tun->filter_prog, NULL);
2329 static void tun_setup(struct net_device *dev)
2331 struct tun_struct *tun = netdev_priv(dev);
2333 tun->owner = INVALID_UID;
2334 tun->group = INVALID_GID;
2335 tun_default_link_ksettings(dev, &tun->link_ksettings);
2337 dev->ethtool_ops = &tun_ethtool_ops;
2338 dev->needs_free_netdev = true;
2339 dev->priv_destructor = tun_free_netdev;
2340 /* We prefer our own queue length */
2341 dev->tx_queue_len = TUN_READQ_SIZE;
2344 /* Trivial set of netlink ops to allow deleting tun or tap
2345 * device with netlink.
2347 static int tun_validate(struct nlattr *tb[], struct nlattr *data[],
2348 struct netlink_ext_ack *extack)
2350 NL_SET_ERR_MSG(extack,
2351 "tun/tap creation via rtnetlink is not supported.");
2355 static size_t tun_get_size(const struct net_device *dev)
2357 BUILD_BUG_ON(sizeof(u32) != sizeof(uid_t));
2358 BUILD_BUG_ON(sizeof(u32) != sizeof(gid_t));
2360 return nla_total_size(sizeof(uid_t)) + /* OWNER */
2361 nla_total_size(sizeof(gid_t)) + /* GROUP */
2362 nla_total_size(sizeof(u8)) + /* TYPE */
2363 nla_total_size(sizeof(u8)) + /* PI */
2364 nla_total_size(sizeof(u8)) + /* VNET_HDR */
2365 nla_total_size(sizeof(u8)) + /* PERSIST */
2366 nla_total_size(sizeof(u8)) + /* MULTI_QUEUE */
2367 nla_total_size(sizeof(u32)) + /* NUM_QUEUES */
2368 nla_total_size(sizeof(u32)) + /* NUM_DISABLED_QUEUES */
2372 static int tun_fill_info(struct sk_buff *skb, const struct net_device *dev)
2374 struct tun_struct *tun = netdev_priv(dev);
2376 if (nla_put_u8(skb, IFLA_TUN_TYPE, tun->flags & TUN_TYPE_MASK))
2377 goto nla_put_failure;
2378 if (uid_valid(tun->owner) &&
2379 nla_put_u32(skb, IFLA_TUN_OWNER,
2380 from_kuid_munged(current_user_ns(), tun->owner)))
2381 goto nla_put_failure;
2382 if (gid_valid(tun->group) &&
2383 nla_put_u32(skb, IFLA_TUN_GROUP,
2384 from_kgid_munged(current_user_ns(), tun->group)))
2385 goto nla_put_failure;
2386 if (nla_put_u8(skb, IFLA_TUN_PI, !(tun->flags & IFF_NO_PI)))
2387 goto nla_put_failure;
2388 if (nla_put_u8(skb, IFLA_TUN_VNET_HDR, !!(tun->flags & IFF_VNET_HDR)))
2389 goto nla_put_failure;
2390 if (nla_put_u8(skb, IFLA_TUN_PERSIST, !!(tun->flags & IFF_PERSIST)))
2391 goto nla_put_failure;
2392 if (nla_put_u8(skb, IFLA_TUN_MULTI_QUEUE,
2393 !!(tun->flags & IFF_MULTI_QUEUE)))
2394 goto nla_put_failure;
2395 if (tun->flags & IFF_MULTI_QUEUE) {
2396 if (nla_put_u32(skb, IFLA_TUN_NUM_QUEUES, tun->numqueues))
2397 goto nla_put_failure;
2398 if (nla_put_u32(skb, IFLA_TUN_NUM_DISABLED_QUEUES,
2400 goto nla_put_failure;
2409 static struct rtnl_link_ops tun_link_ops __read_mostly = {
2411 .priv_size = sizeof(struct tun_struct),
2413 .validate = tun_validate,
2414 .get_size = tun_get_size,
2415 .fill_info = tun_fill_info,
2418 static void tun_sock_write_space(struct sock *sk)
2420 struct tun_file *tfile;
2421 wait_queue_head_t *wqueue;
2423 if (!sock_writeable(sk))
2426 if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
2429 wqueue = sk_sleep(sk);
2430 if (wqueue && waitqueue_active(wqueue))
2431 wake_up_interruptible_sync_poll(wqueue, EPOLLOUT |
2432 EPOLLWRNORM | EPOLLWRBAND);
2434 tfile = container_of(sk, struct tun_file, sk);
2435 kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
2438 static void tun_put_page(struct tun_page *tpage)
2441 __page_frag_cache_drain(tpage->page, tpage->count);
2444 static int tun_xdp_one(struct tun_struct *tun,
2445 struct tun_file *tfile,
2446 struct xdp_buff *xdp, int *flush,
2447 struct tun_page *tpage)
2449 unsigned int datasize = xdp->data_end - xdp->data;
2450 struct tun_xdp_hdr *hdr = xdp->data_hard_start;
2451 struct virtio_net_hdr *gso = &hdr->gso;
2452 struct tun_pcpu_stats *stats;
2453 struct bpf_prog *xdp_prog;
2454 struct sk_buff *skb = NULL;
2455 u32 rxhash = 0, act;
2456 int buflen = hdr->buflen;
2458 bool skb_xdp = false;
2461 xdp_prog = rcu_dereference(tun->xdp_prog);
2463 if (gso->gso_type) {
2467 xdp_set_data_meta_invalid(xdp);
2468 xdp->rxq = &tfile->xdp_rxq;
2469 xdp->frame_sz = buflen;
2471 act = bpf_prog_run_xdp(xdp_prog, xdp);
2472 err = tun_xdp_act(tun, xdp_prog, xdp, act);
2474 put_page(virt_to_head_page(xdp->data));
2487 page = virt_to_head_page(xdp->data);
2488 if (tpage->page == page) {
2491 tun_put_page(tpage);
2500 skb = build_skb(xdp->data_hard_start, buflen);
2506 skb_reserve(skb, xdp->data - xdp->data_hard_start);
2507 skb_put(skb, xdp->data_end - xdp->data);
2509 if (virtio_net_hdr_to_skb(skb, gso, tun_is_little_endian(tun))) {
2510 this_cpu_inc(tun->pcpu_stats->rx_frame_errors);
2516 skb->protocol = eth_type_trans(skb, tun->dev);
2517 skb_reset_network_header(skb);
2518 skb_probe_transport_header(skb);
2519 skb_record_rx_queue(skb, tfile->queue_index);
2522 err = do_xdp_generic(xdp_prog, skb);
2523 if (err != XDP_PASS)
2527 if (!rcu_dereference(tun->steering_prog) && tun->numqueues > 1 &&
2529 rxhash = __skb_get_hash_symmetric(skb);
2531 netif_receive_skb(skb);
2533 /* No need for get_cpu_ptr() here since this function is
2534 * always called with bh disabled
2536 stats = this_cpu_ptr(tun->pcpu_stats);
2537 u64_stats_update_begin(&stats->syncp);
2538 u64_stats_inc(&stats->rx_packets);
2539 u64_stats_add(&stats->rx_bytes, datasize);
2540 u64_stats_update_end(&stats->syncp);
2543 tun_flow_update(tun, rxhash, tfile);
2549 static int tun_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
2552 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2553 struct tun_struct *tun = tun_get(tfile);
2554 struct tun_msg_ctl *ctl = m->msg_control;
2555 struct xdp_buff *xdp;
2560 if (m->msg_controllen == sizeof(struct tun_msg_ctl) &&
2561 ctl && ctl->type == TUN_MSG_PTR) {
2562 struct tun_page tpage;
2566 memset(&tpage, 0, sizeof(tpage));
2571 for (i = 0; i < n; i++) {
2572 xdp = &((struct xdp_buff *)ctl->ptr)[i];
2573 tun_xdp_one(tun, tfile, xdp, &flush, &tpage);
2582 tun_put_page(&tpage);
2588 ret = tun_get_user(tun, tfile, ctl ? ctl->ptr : NULL, &m->msg_iter,
2589 m->msg_flags & MSG_DONTWAIT,
2590 m->msg_flags & MSG_MORE);
2596 static int tun_recvmsg(struct socket *sock, struct msghdr *m, size_t total_len,
2599 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2600 struct tun_struct *tun = tun_get(tfile);
2601 void *ptr = m->msg_control;
2609 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
2613 if (flags & MSG_ERRQUEUE) {
2614 ret = sock_recv_errqueue(sock->sk, m, total_len,
2615 SOL_PACKET, TUN_TX_TIMESTAMP);
2618 ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT, ptr);
2619 if (ret > (ssize_t)total_len) {
2620 m->msg_flags |= MSG_TRUNC;
2621 ret = flags & MSG_TRUNC ? ret : total_len;
2634 static int tun_ptr_peek_len(void *ptr)
2637 if (tun_is_xdp_frame(ptr)) {
2638 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2642 return __skb_array_len_with_tag(ptr);
2648 static int tun_peek_len(struct socket *sock)
2650 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2651 struct tun_struct *tun;
2654 tun = tun_get(tfile);
2658 ret = PTR_RING_PEEK_CALL(&tfile->tx_ring, tun_ptr_peek_len);
2664 /* Ops structure to mimic raw sockets with tun */
2665 static const struct proto_ops tun_socket_ops = {
2666 .peek_len = tun_peek_len,
2667 .sendmsg = tun_sendmsg,
2668 .recvmsg = tun_recvmsg,
2671 static struct proto tun_proto = {
2673 .owner = THIS_MODULE,
2674 .obj_size = sizeof(struct tun_file),
2677 static int tun_flags(struct tun_struct *tun)
2679 return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
2682 static ssize_t tun_show_flags(struct device *dev, struct device_attribute *attr,
2685 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2686 return sprintf(buf, "0x%x\n", tun_flags(tun));
2689 static ssize_t tun_show_owner(struct device *dev, struct device_attribute *attr,
2692 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2693 return uid_valid(tun->owner)?
2694 sprintf(buf, "%u\n",
2695 from_kuid_munged(current_user_ns(), tun->owner)):
2696 sprintf(buf, "-1\n");
2699 static ssize_t tun_show_group(struct device *dev, struct device_attribute *attr,
2702 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2703 return gid_valid(tun->group) ?
2704 sprintf(buf, "%u\n",
2705 from_kgid_munged(current_user_ns(), tun->group)):
2706 sprintf(buf, "-1\n");
2709 static DEVICE_ATTR(tun_flags, 0444, tun_show_flags, NULL);
2710 static DEVICE_ATTR(owner, 0444, tun_show_owner, NULL);
2711 static DEVICE_ATTR(group, 0444, tun_show_group, NULL);
2713 static struct attribute *tun_dev_attrs[] = {
2714 &dev_attr_tun_flags.attr,
2715 &dev_attr_owner.attr,
2716 &dev_attr_group.attr,
2720 static const struct attribute_group tun_attr_group = {
2721 .attrs = tun_dev_attrs
2724 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
2726 struct tun_struct *tun;
2727 struct tun_file *tfile = file->private_data;
2728 struct net_device *dev;
2731 if (tfile->detached)
2734 if ((ifr->ifr_flags & IFF_NAPI_FRAGS)) {
2735 if (!capable(CAP_NET_ADMIN))
2738 if (!(ifr->ifr_flags & IFF_NAPI) ||
2739 (ifr->ifr_flags & TUN_TYPE_MASK) != IFF_TAP)
2743 dev = __dev_get_by_name(net, ifr->ifr_name);
2745 if (ifr->ifr_flags & IFF_TUN_EXCL)
2747 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
2748 tun = netdev_priv(dev);
2749 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
2750 tun = netdev_priv(dev);
2754 if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
2755 !!(tun->flags & IFF_MULTI_QUEUE))
2758 if (tun_not_capable(tun))
2760 err = security_tun_dev_open(tun->security);
2764 err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER,
2765 ifr->ifr_flags & IFF_NAPI,
2766 ifr->ifr_flags & IFF_NAPI_FRAGS, true);
2770 if (tun->flags & IFF_MULTI_QUEUE &&
2771 (tun->numqueues + tun->numdisabled > 1)) {
2772 /* One or more queue has already been attached, no need
2773 * to initialize the device again.
2775 netdev_state_change(dev);
2779 tun->flags = (tun->flags & ~TUN_FEATURES) |
2780 (ifr->ifr_flags & TUN_FEATURES);
2782 netdev_state_change(dev);
2785 unsigned long flags = 0;
2786 int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
2789 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
2791 err = security_tun_dev_create();
2796 if (ifr->ifr_flags & IFF_TUN) {
2800 } else if (ifr->ifr_flags & IFF_TAP) {
2808 name = ifr->ifr_name;
2810 dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
2811 NET_NAME_UNKNOWN, tun_setup, queues,
2817 dev_net_set(dev, net);
2818 dev->rtnl_link_ops = &tun_link_ops;
2819 dev->ifindex = tfile->ifindex;
2820 dev->sysfs_groups[0] = &tun_attr_group;
2822 tun = netdev_priv(dev);
2825 tun->txflt.count = 0;
2826 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
2828 tun->align = NET_SKB_PAD;
2829 tun->filter_attached = false;
2830 tun->sndbuf = tfile->socket.sk->sk_sndbuf;
2831 tun->rx_batched = 0;
2832 RCU_INIT_POINTER(tun->steering_prog, NULL);
2837 tun_net_initialize(dev);
2839 err = register_netdevice(tun->dev);
2844 /* free_netdev() won't check refcnt, to aovid race
2845 * with dev_put() we need publish tun after registration.
2847 rcu_assign_pointer(tfile->tun, tun);
2850 netif_carrier_on(tun->dev);
2852 /* Make sure persistent devices do not get stuck in
2855 if (netif_running(tun->dev))
2856 netif_tx_wake_all_queues(tun->dev);
2858 strcpy(ifr->ifr_name, tun->dev->name);
2862 static void tun_get_iff(struct tun_struct *tun, struct ifreq *ifr)
2864 strcpy(ifr->ifr_name, tun->dev->name);
2866 ifr->ifr_flags = tun_flags(tun);
2870 /* This is like a cut-down ethtool ops, except done via tun fd so no
2871 * privs required. */
2872 static int set_offload(struct tun_struct *tun, unsigned long arg)
2874 netdev_features_t features = 0;
2876 if (arg & TUN_F_CSUM) {
2877 features |= NETIF_F_HW_CSUM;
2880 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
2881 if (arg & TUN_F_TSO_ECN) {
2882 features |= NETIF_F_TSO_ECN;
2883 arg &= ~TUN_F_TSO_ECN;
2885 if (arg & TUN_F_TSO4)
2886 features |= NETIF_F_TSO;
2887 if (arg & TUN_F_TSO6)
2888 features |= NETIF_F_TSO6;
2889 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
2895 /* This gives the user a way to test for new features in future by
2896 * trying to set them. */
2900 tun->set_features = features;
2901 tun->dev->wanted_features &= ~TUN_USER_FEATURES;
2902 tun->dev->wanted_features |= features;
2903 netdev_update_features(tun->dev);
2908 static void tun_detach_filter(struct tun_struct *tun, int n)
2911 struct tun_file *tfile;
2913 for (i = 0; i < n; i++) {
2914 tfile = rtnl_dereference(tun->tfiles[i]);
2915 lock_sock(tfile->socket.sk);
2916 sk_detach_filter(tfile->socket.sk);
2917 release_sock(tfile->socket.sk);
2920 tun->filter_attached = false;
2923 static int tun_attach_filter(struct tun_struct *tun)
2926 struct tun_file *tfile;
2928 for (i = 0; i < tun->numqueues; i++) {
2929 tfile = rtnl_dereference(tun->tfiles[i]);
2930 lock_sock(tfile->socket.sk);
2931 ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
2932 release_sock(tfile->socket.sk);
2934 tun_detach_filter(tun, i);
2939 tun->filter_attached = true;
2943 static void tun_set_sndbuf(struct tun_struct *tun)
2945 struct tun_file *tfile;
2948 for (i = 0; i < tun->numqueues; i++) {
2949 tfile = rtnl_dereference(tun->tfiles[i]);
2950 tfile->socket.sk->sk_sndbuf = tun->sndbuf;
2954 static int tun_set_queue(struct file *file, struct ifreq *ifr)
2956 struct tun_file *tfile = file->private_data;
2957 struct tun_struct *tun;
2962 if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
2963 tun = tfile->detached;
2968 ret = security_tun_dev_attach_queue(tun->security);
2971 ret = tun_attach(tun, file, false, tun->flags & IFF_NAPI,
2972 tun->flags & IFF_NAPI_FRAGS, true);
2973 } else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
2974 tun = rtnl_dereference(tfile->tun);
2975 if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
2978 __tun_detach(tfile, false);
2983 netdev_state_change(tun->dev);
2990 static int tun_set_ebpf(struct tun_struct *tun, struct tun_prog __rcu **prog_p,
2993 struct bpf_prog *prog;
2996 if (copy_from_user(&fd, data, sizeof(fd)))
3002 prog = bpf_prog_get_type(fd, BPF_PROG_TYPE_SOCKET_FILTER);
3004 return PTR_ERR(prog);
3007 return __tun_set_ebpf(tun, prog_p, prog);
3010 /* Return correct value for tun->dev->addr_len based on tun->dev->type. */
3011 static unsigned char tun_get_addr_len(unsigned short type)
3015 case ARPHRD_TUNNEL6:
3016 return sizeof(struct in6_addr);
3023 case ARPHRD_IEEE802154:
3024 case ARPHRD_IEEE802154_MONITOR:
3025 return IEEE802154_EXTENDED_ADDR_LEN;
3026 case ARPHRD_PHONET_PIPE:
3030 case ARPHRD_6LOWPAN:
3031 return EUI64_ADDR_LEN;
3036 case ARPHRD_IEEE802:
3039 return ROSE_ADDR_LEN;
3041 return AX25_ADDR_LEN;
3042 case ARPHRD_LOCALTLK:
3049 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
3050 unsigned long arg, int ifreq_len)
3052 struct tun_file *tfile = file->private_data;
3053 struct net *net = sock_net(&tfile->sk);
3054 struct tun_struct *tun;
3055 void __user* argp = (void __user*)arg;
3056 unsigned int ifindex, carrier;
3064 bool do_notify = false;
3066 if (cmd == TUNSETIFF || cmd == TUNSETQUEUE ||
3067 (_IOC_TYPE(cmd) == SOCK_IOC_TYPE && cmd != SIOCGSKNS)) {
3068 if (copy_from_user(&ifr, argp, ifreq_len))
3071 memset(&ifr, 0, sizeof(ifr));
3073 if (cmd == TUNGETFEATURES) {
3074 /* Currently this just means: "what IFF flags are valid?".
3075 * This is needed because we never checked for invalid flags on
3078 return put_user(IFF_TUN | IFF_TAP | TUN_FEATURES,
3079 (unsigned int __user*)argp);
3080 } else if (cmd == TUNSETQUEUE) {
3081 return tun_set_queue(file, &ifr);
3082 } else if (cmd == SIOCGSKNS) {
3083 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
3085 return open_related_ns(&net->ns, get_net_ns);
3091 tun = tun_get(tfile);
3092 if (cmd == TUNSETIFF) {
3097 ifr.ifr_name[IFNAMSIZ-1] = '\0';
3099 ret = tun_set_iff(net, file, &ifr);
3104 if (copy_to_user(argp, &ifr, ifreq_len))
3108 if (cmd == TUNSETIFINDEX) {
3114 if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
3118 tfile->ifindex = ifindex;
3126 netif_info(tun, drv, tun->dev, "tun_chr_ioctl cmd %u\n", cmd);
3128 net = dev_net(tun->dev);
3132 tun_get_iff(tun, &ifr);
3134 if (tfile->detached)
3135 ifr.ifr_flags |= IFF_DETACH_QUEUE;
3136 if (!tfile->socket.sk->sk_filter)
3137 ifr.ifr_flags |= IFF_NOFILTER;
3139 if (copy_to_user(argp, &ifr, ifreq_len))
3144 /* Disable/Enable checksum */
3146 /* [unimplemented] */
3147 netif_info(tun, drv, tun->dev, "ignored: set checksum %s\n",
3148 arg ? "disabled" : "enabled");
3152 /* Disable/Enable persist mode. Keep an extra reference to the
3153 * module to prevent the module being unprobed.
3155 if (arg && !(tun->flags & IFF_PERSIST)) {
3156 tun->flags |= IFF_PERSIST;
3157 __module_get(THIS_MODULE);
3160 if (!arg && (tun->flags & IFF_PERSIST)) {
3161 tun->flags &= ~IFF_PERSIST;
3162 module_put(THIS_MODULE);
3166 netif_info(tun, drv, tun->dev, "persist %s\n",
3167 arg ? "enabled" : "disabled");
3171 /* Set owner of the device */
3172 owner = make_kuid(current_user_ns(), arg);
3173 if (!uid_valid(owner)) {
3179 netif_info(tun, drv, tun->dev, "owner set to %u\n",
3180 from_kuid(&init_user_ns, tun->owner));
3184 /* Set group of the device */
3185 group = make_kgid(current_user_ns(), arg);
3186 if (!gid_valid(group)) {
3192 netif_info(tun, drv, tun->dev, "group set to %u\n",
3193 from_kgid(&init_user_ns, tun->group));
3197 /* Only allow setting the type when the interface is down */
3198 if (tun->dev->flags & IFF_UP) {
3199 netif_info(tun, drv, tun->dev,
3200 "Linktype set failed because interface is up\n");
3203 tun->dev->type = (int) arg;
3204 tun->dev->addr_len = tun_get_addr_len(tun->dev->type);
3205 netif_info(tun, drv, tun->dev, "linktype set to %d\n",
3212 tun->msg_enable = (u32)arg;
3216 ret = set_offload(tun, arg);
3219 case TUNSETTXFILTER:
3220 /* Can be set only for TAPs */
3222 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3224 ret = update_filter(&tun->txflt, (void __user *)arg);
3228 /* Get hw address */
3229 dev_get_mac_address(&ifr.ifr_hwaddr, net, tun->dev->name);
3230 if (copy_to_user(argp, &ifr, ifreq_len))
3235 /* Set hw address */
3236 ret = dev_set_mac_address_user(tun->dev, &ifr.ifr_hwaddr, NULL);
3240 sndbuf = tfile->socket.sk->sk_sndbuf;
3241 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
3246 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
3255 tun->sndbuf = sndbuf;
3256 tun_set_sndbuf(tun);
3259 case TUNGETVNETHDRSZ:
3260 vnet_hdr_sz = tun->vnet_hdr_sz;
3261 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
3265 case TUNSETVNETHDRSZ:
3266 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
3270 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
3275 tun->vnet_hdr_sz = vnet_hdr_sz;
3279 le = !!(tun->flags & TUN_VNET_LE);
3280 if (put_user(le, (int __user *)argp))
3285 if (get_user(le, (int __user *)argp)) {
3290 tun->flags |= TUN_VNET_LE;
3292 tun->flags &= ~TUN_VNET_LE;
3296 ret = tun_get_vnet_be(tun, argp);
3300 ret = tun_set_vnet_be(tun, argp);
3303 case TUNATTACHFILTER:
3304 /* Can be set only for TAPs */
3306 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3309 if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
3312 ret = tun_attach_filter(tun);
3315 case TUNDETACHFILTER:
3316 /* Can be set only for TAPs */
3318 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3321 tun_detach_filter(tun, tun->numqueues);
3326 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3329 if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
3334 case TUNSETSTEERINGEBPF:
3335 ret = tun_set_ebpf(tun, &tun->steering_prog, argp);
3338 case TUNSETFILTEREBPF:
3339 ret = tun_set_ebpf(tun, &tun->filter_prog, argp);
3344 if (copy_from_user(&carrier, argp, sizeof(carrier)))
3347 ret = tun_net_change_carrier(tun->dev, (bool)carrier);
3350 case TUNGETDEVNETNS:
3352 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
3354 ret = open_related_ns(&net->ns, get_net_ns);
3363 netdev_state_change(tun->dev);
3372 static long tun_chr_ioctl(struct file *file,
3373 unsigned int cmd, unsigned long arg)
3375 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
3378 #ifdef CONFIG_COMPAT
3379 static long tun_chr_compat_ioctl(struct file *file,
3380 unsigned int cmd, unsigned long arg)
3385 case TUNSETTXFILTER:
3390 arg = (unsigned long)compat_ptr(arg);
3393 arg = (compat_ulong_t)arg;
3398 * compat_ifreq is shorter than ifreq, so we must not access beyond
3399 * the end of that structure. All fields that are used in this
3400 * driver are compatible though, we don't need to convert the
3403 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
3405 #endif /* CONFIG_COMPAT */
3407 static int tun_chr_fasync(int fd, struct file *file, int on)
3409 struct tun_file *tfile = file->private_data;
3412 if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
3416 __f_setown(file, task_pid(current), PIDTYPE_TGID, 0);
3417 tfile->flags |= TUN_FASYNC;
3419 tfile->flags &= ~TUN_FASYNC;
3425 static int tun_chr_open(struct inode *inode, struct file * file)
3427 struct net *net = current->nsproxy->net_ns;
3428 struct tun_file *tfile;
3430 tfile = (struct tun_file *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
3434 if (ptr_ring_init(&tfile->tx_ring, 0, GFP_KERNEL)) {
3435 sk_free(&tfile->sk);
3439 mutex_init(&tfile->napi_mutex);
3440 RCU_INIT_POINTER(tfile->tun, NULL);
3444 init_waitqueue_head(&tfile->socket.wq.wait);
3446 tfile->socket.file = file;
3447 tfile->socket.ops = &tun_socket_ops;
3449 sock_init_data(&tfile->socket, &tfile->sk);
3451 tfile->sk.sk_write_space = tun_sock_write_space;
3452 tfile->sk.sk_sndbuf = INT_MAX;
3454 file->private_data = tfile;
3455 INIT_LIST_HEAD(&tfile->next);
3457 sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
3462 static int tun_chr_close(struct inode *inode, struct file *file)
3464 struct tun_file *tfile = file->private_data;
3466 tun_detach(tfile, true);
3471 #ifdef CONFIG_PROC_FS
3472 static void tun_chr_show_fdinfo(struct seq_file *m, struct file *file)
3474 struct tun_file *tfile = file->private_data;
3475 struct tun_struct *tun;
3478 memset(&ifr, 0, sizeof(ifr));
3481 tun = tun_get(tfile);
3483 tun_get_iff(tun, &ifr);
3489 seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
3493 static const struct file_operations tun_fops = {
3494 .owner = THIS_MODULE,
3495 .llseek = no_llseek,
3496 .read_iter = tun_chr_read_iter,
3497 .write_iter = tun_chr_write_iter,
3498 .poll = tun_chr_poll,
3499 .unlocked_ioctl = tun_chr_ioctl,
3500 #ifdef CONFIG_COMPAT
3501 .compat_ioctl = tun_chr_compat_ioctl,
3503 .open = tun_chr_open,
3504 .release = tun_chr_close,
3505 .fasync = tun_chr_fasync,
3506 #ifdef CONFIG_PROC_FS
3507 .show_fdinfo = tun_chr_show_fdinfo,
3511 static struct miscdevice tun_miscdev = {
3514 .nodename = "net/tun",
3518 /* ethtool interface */
3520 static void tun_default_link_ksettings(struct net_device *dev,
3521 struct ethtool_link_ksettings *cmd)
3523 ethtool_link_ksettings_zero_link_mode(cmd, supported);
3524 ethtool_link_ksettings_zero_link_mode(cmd, advertising);
3525 cmd->base.speed = SPEED_10;
3526 cmd->base.duplex = DUPLEX_FULL;
3527 cmd->base.port = PORT_TP;
3528 cmd->base.phy_address = 0;
3529 cmd->base.autoneg = AUTONEG_DISABLE;
3532 static int tun_get_link_ksettings(struct net_device *dev,
3533 struct ethtool_link_ksettings *cmd)
3535 struct tun_struct *tun = netdev_priv(dev);
3537 memcpy(cmd, &tun->link_ksettings, sizeof(*cmd));
3541 static int tun_set_link_ksettings(struct net_device *dev,
3542 const struct ethtool_link_ksettings *cmd)
3544 struct tun_struct *tun = netdev_priv(dev);
3546 memcpy(&tun->link_ksettings, cmd, sizeof(*cmd));
3550 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
3552 struct tun_struct *tun = netdev_priv(dev);
3554 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
3555 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
3557 switch (tun->flags & TUN_TYPE_MASK) {
3559 strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
3562 strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
3567 static u32 tun_get_msglevel(struct net_device *dev)
3569 struct tun_struct *tun = netdev_priv(dev);
3571 return tun->msg_enable;
3574 static void tun_set_msglevel(struct net_device *dev, u32 value)
3576 struct tun_struct *tun = netdev_priv(dev);
3578 tun->msg_enable = value;
3581 static int tun_get_coalesce(struct net_device *dev,
3582 struct ethtool_coalesce *ec)
3584 struct tun_struct *tun = netdev_priv(dev);
3586 ec->rx_max_coalesced_frames = tun->rx_batched;
3591 static int tun_set_coalesce(struct net_device *dev,
3592 struct ethtool_coalesce *ec)
3594 struct tun_struct *tun = netdev_priv(dev);
3596 if (ec->rx_max_coalesced_frames > NAPI_POLL_WEIGHT)
3597 tun->rx_batched = NAPI_POLL_WEIGHT;
3599 tun->rx_batched = ec->rx_max_coalesced_frames;
3604 static const struct ethtool_ops tun_ethtool_ops = {
3605 .supported_coalesce_params = ETHTOOL_COALESCE_RX_MAX_FRAMES,
3606 .get_drvinfo = tun_get_drvinfo,
3607 .get_msglevel = tun_get_msglevel,
3608 .set_msglevel = tun_set_msglevel,
3609 .get_link = ethtool_op_get_link,
3610 .get_ts_info = ethtool_op_get_ts_info,
3611 .get_coalesce = tun_get_coalesce,
3612 .set_coalesce = tun_set_coalesce,
3613 .get_link_ksettings = tun_get_link_ksettings,
3614 .set_link_ksettings = tun_set_link_ksettings,
3617 static int tun_queue_resize(struct tun_struct *tun)
3619 struct net_device *dev = tun->dev;
3620 struct tun_file *tfile;
3621 struct ptr_ring **rings;
3622 int n = tun->numqueues + tun->numdisabled;
3625 rings = kmalloc_array(n, sizeof(*rings), GFP_KERNEL);
3629 for (i = 0; i < tun->numqueues; i++) {
3630 tfile = rtnl_dereference(tun->tfiles[i]);
3631 rings[i] = &tfile->tx_ring;
3633 list_for_each_entry(tfile, &tun->disabled, next)
3634 rings[i++] = &tfile->tx_ring;
3636 ret = ptr_ring_resize_multiple(rings, n,
3637 dev->tx_queue_len, GFP_KERNEL,
3644 static int tun_device_event(struct notifier_block *unused,
3645 unsigned long event, void *ptr)
3647 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
3648 struct tun_struct *tun = netdev_priv(dev);
3651 if (dev->rtnl_link_ops != &tun_link_ops)
3655 case NETDEV_CHANGE_TX_QUEUE_LEN:
3656 if (tun_queue_resize(tun))
3660 for (i = 0; i < tun->numqueues; i++) {
3661 struct tun_file *tfile;
3663 tfile = rtnl_dereference(tun->tfiles[i]);
3664 tfile->socket.sk->sk_write_space(tfile->socket.sk);
3674 static struct notifier_block tun_notifier_block __read_mostly = {
3675 .notifier_call = tun_device_event,
3678 static int __init tun_init(void)
3682 pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
3684 ret = rtnl_link_register(&tun_link_ops);
3686 pr_err("Can't register link_ops\n");
3690 ret = misc_register(&tun_miscdev);
3692 pr_err("Can't register misc device %d\n", TUN_MINOR);
3696 ret = register_netdevice_notifier(&tun_notifier_block);
3698 pr_err("Can't register netdevice notifier\n");
3705 misc_deregister(&tun_miscdev);
3707 rtnl_link_unregister(&tun_link_ops);
3712 static void tun_cleanup(void)
3714 misc_deregister(&tun_miscdev);
3715 rtnl_link_unregister(&tun_link_ops);
3716 unregister_netdevice_notifier(&tun_notifier_block);
3719 /* Get an underlying socket object from tun file. Returns error unless file is
3720 * attached to a device. The returned object works like a packet socket, it
3721 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
3722 * holding a reference to the file for as long as the socket is in use. */
3723 struct socket *tun_get_socket(struct file *file)
3725 struct tun_file *tfile;
3726 if (file->f_op != &tun_fops)
3727 return ERR_PTR(-EINVAL);
3728 tfile = file->private_data;
3730 return ERR_PTR(-EBADFD);
3731 return &tfile->socket;
3733 EXPORT_SYMBOL_GPL(tun_get_socket);
3735 struct ptr_ring *tun_get_tx_ring(struct file *file)
3737 struct tun_file *tfile;
3739 if (file->f_op != &tun_fops)
3740 return ERR_PTR(-EINVAL);
3741 tfile = file->private_data;
3743 return ERR_PTR(-EBADFD);
3744 return &tfile->tx_ring;
3746 EXPORT_SYMBOL_GPL(tun_get_tx_ring);
3748 module_init(tun_init);
3749 module_exit(tun_cleanup);
3750 MODULE_DESCRIPTION(DRV_DESCRIPTION);
3751 MODULE_AUTHOR(DRV_COPYRIGHT);
3752 MODULE_LICENSE("GPL");
3753 MODULE_ALIAS_MISCDEV(TUN_MINOR);
3754 MODULE_ALIAS("devname:net/tun");