1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * TUN - Universal TUN/TAP device driver.
6 * $Id: tun.c,v 1.15 2002/03/01 02:44:24 maxk Exp $
13 * Add TUNSETLINK ioctl to set the link encapsulation
16 * Use eth_random_addr() for tap MAC address.
19 * Fixes in packet dropping, queue length setting and queue wakeup.
20 * Increased default tx queue length.
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"
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>
73 #include <linux/uaccess.h>
74 #include <linux/proc_fs.h>
76 static void tun_default_link_ksettings(struct net_device *dev,
77 struct ethtool_link_ksettings *cmd);
79 #define TUN_RX_PAD (NET_IP_ALIGN + NET_SKB_PAD)
81 /* TUN device flags */
83 /* IFF_ATTACH_QUEUE is never stored in device flags,
84 * overload it to mean fasync when stored there.
86 #define TUN_FASYNC IFF_ATTACH_QUEUE
87 /* High bits in flags field are unused. */
88 #define TUN_VNET_LE 0x80000000
89 #define TUN_VNET_BE 0x40000000
91 #define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
92 IFF_MULTI_QUEUE | IFF_NAPI | IFF_NAPI_FRAGS)
94 #define GOODCOPY_LEN 128
96 #define FLT_EXACT_COUNT 8
98 unsigned int count; /* Number of addrs. Zero means disabled */
99 u32 mask[2]; /* Mask of the hashed addrs */
100 unsigned char addr[FLT_EXACT_COUNT][ETH_ALEN];
103 /* MAX_TAP_QUEUES 256 is chosen to allow rx/tx queues to be equal
104 * to max number of VCPUs in guest. */
105 #define MAX_TAP_QUEUES 256
106 #define MAX_TAP_FLOWS 4096
108 #define TUN_FLOW_EXPIRE (3 * HZ)
110 /* A tun_file connects an open character device to a tuntap netdevice. It
111 * also contains all socket related structures (except sock_fprog and tap_filter)
112 * to serve as one transmit queue for tuntap device. The sock_fprog and
113 * tap_filter were kept in tun_struct since they were used for filtering for the
114 * netdevice not for a specific queue (at least I didn't see the requirement for
118 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
119 * other can only be read while rcu_read_lock or rtnl_lock is held.
123 struct socket socket;
124 struct tun_struct __rcu *tun;
125 struct fasync_struct *fasync;
126 /* only used for fasnyc */
130 unsigned int ifindex;
132 struct napi_struct napi;
134 bool napi_frags_enabled;
135 struct mutex napi_mutex; /* Protects access to the above napi */
136 struct list_head next;
137 struct tun_struct *detached;
138 struct ptr_ring tx_ring;
139 struct xdp_rxq_info xdp_rxq;
147 struct tun_flow_entry {
148 struct hlist_node hash_link;
150 struct tun_struct *tun;
155 unsigned long updated ____cacheline_aligned_in_smp;
158 #define TUN_NUM_FLOW_ENTRIES 1024
159 #define TUN_MASK_FLOW_ENTRIES (TUN_NUM_FLOW_ENTRIES - 1)
163 struct bpf_prog *prog;
166 /* Since the socket were moved to tun_file, to preserve the behavior of persist
167 * device, socket filter, sndbuf and vnet header size were restore when the
168 * file were attached to a persist device.
171 struct tun_file __rcu *tfiles[MAX_TAP_QUEUES];
172 unsigned int numqueues;
177 struct net_device *dev;
178 netdev_features_t set_features;
179 #define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
185 struct tap_filter txflt;
186 struct sock_fprog fprog;
187 /* protected by rtnl lock */
188 bool filter_attached;
191 struct hlist_head flows[TUN_NUM_FLOW_ENTRIES];
192 struct timer_list flow_gc_timer;
193 unsigned long ageing_time;
194 unsigned int numdisabled;
195 struct list_head disabled;
199 atomic_long_t rx_frame_errors;
200 struct bpf_prog __rcu *xdp_prog;
201 struct tun_prog __rcu *steering_prog;
202 struct tun_prog __rcu *filter_prog;
203 struct ethtool_link_ksettings link_ksettings;
211 static int tun_napi_receive(struct napi_struct *napi, int budget)
213 struct tun_file *tfile = container_of(napi, struct tun_file, napi);
214 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
215 struct sk_buff_head process_queue;
219 __skb_queue_head_init(&process_queue);
221 spin_lock(&queue->lock);
222 skb_queue_splice_tail_init(queue, &process_queue);
223 spin_unlock(&queue->lock);
225 while (received < budget && (skb = __skb_dequeue(&process_queue))) {
226 napi_gro_receive(napi, skb);
230 if (!skb_queue_empty(&process_queue)) {
231 spin_lock(&queue->lock);
232 skb_queue_splice(&process_queue, queue);
233 spin_unlock(&queue->lock);
239 static int tun_napi_poll(struct napi_struct *napi, int budget)
241 unsigned int received;
243 received = tun_napi_receive(napi, budget);
245 if (received < budget)
246 napi_complete_done(napi, received);
251 static void tun_napi_init(struct tun_struct *tun, struct tun_file *tfile,
252 bool napi_en, bool napi_frags)
254 tfile->napi_enabled = napi_en;
255 tfile->napi_frags_enabled = napi_en && napi_frags;
257 netif_tx_napi_add(tun->dev, &tfile->napi, tun_napi_poll,
259 napi_enable(&tfile->napi);
263 static void tun_napi_disable(struct tun_file *tfile)
265 if (tfile->napi_enabled)
266 napi_disable(&tfile->napi);
269 static void tun_napi_del(struct tun_file *tfile)
271 if (tfile->napi_enabled)
272 netif_napi_del(&tfile->napi);
275 static bool tun_napi_frags_enabled(const struct tun_file *tfile)
277 return tfile->napi_frags_enabled;
280 #ifdef CONFIG_TUN_VNET_CROSS_LE
281 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
283 return tun->flags & TUN_VNET_BE ? false :
284 virtio_legacy_is_little_endian();
287 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
289 int be = !!(tun->flags & TUN_VNET_BE);
291 if (put_user(be, argp))
297 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
301 if (get_user(be, argp))
305 tun->flags |= TUN_VNET_BE;
307 tun->flags &= ~TUN_VNET_BE;
312 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
314 return virtio_legacy_is_little_endian();
317 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
322 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
326 #endif /* CONFIG_TUN_VNET_CROSS_LE */
328 static inline bool tun_is_little_endian(struct tun_struct *tun)
330 return tun->flags & TUN_VNET_LE ||
331 tun_legacy_is_little_endian(tun);
334 static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
336 return __virtio16_to_cpu(tun_is_little_endian(tun), val);
339 static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
341 return __cpu_to_virtio16(tun_is_little_endian(tun), val);
344 static inline u32 tun_hashfn(u32 rxhash)
346 return rxhash & TUN_MASK_FLOW_ENTRIES;
349 static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
351 struct tun_flow_entry *e;
353 hlist_for_each_entry_rcu(e, head, hash_link) {
354 if (e->rxhash == rxhash)
360 static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
361 struct hlist_head *head,
362 u32 rxhash, u16 queue_index)
364 struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
367 netif_info(tun, tx_queued, tun->dev,
368 "create flow: hash %u index %u\n",
369 rxhash, queue_index);
370 e->updated = jiffies;
373 e->queue_index = queue_index;
375 hlist_add_head_rcu(&e->hash_link, head);
381 static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
383 netif_info(tun, tx_queued, tun->dev, "delete flow: hash %u index %u\n",
384 e->rxhash, e->queue_index);
385 hlist_del_rcu(&e->hash_link);
390 static void tun_flow_flush(struct tun_struct *tun)
394 spin_lock_bh(&tun->lock);
395 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
396 struct tun_flow_entry *e;
397 struct hlist_node *n;
399 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
400 tun_flow_delete(tun, e);
402 spin_unlock_bh(&tun->lock);
405 static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
409 spin_lock_bh(&tun->lock);
410 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
411 struct tun_flow_entry *e;
412 struct hlist_node *n;
414 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
415 if (e->queue_index == queue_index)
416 tun_flow_delete(tun, e);
419 spin_unlock_bh(&tun->lock);
422 static void tun_flow_cleanup(struct timer_list *t)
424 struct tun_struct *tun = from_timer(tun, t, flow_gc_timer);
425 unsigned long delay = tun->ageing_time;
426 unsigned long next_timer = jiffies + delay;
427 unsigned long count = 0;
430 spin_lock(&tun->lock);
431 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
432 struct tun_flow_entry *e;
433 struct hlist_node *n;
435 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
436 unsigned long this_timer;
438 this_timer = e->updated + delay;
439 if (time_before_eq(this_timer, jiffies)) {
440 tun_flow_delete(tun, e);
444 if (time_before(this_timer, next_timer))
445 next_timer = this_timer;
450 mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
451 spin_unlock(&tun->lock);
454 static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
455 struct tun_file *tfile)
457 struct hlist_head *head;
458 struct tun_flow_entry *e;
459 unsigned long delay = tun->ageing_time;
460 u16 queue_index = tfile->queue_index;
462 head = &tun->flows[tun_hashfn(rxhash)];
466 e = tun_flow_find(head, rxhash);
468 /* TODO: keep queueing to old queue until it's empty? */
469 if (READ_ONCE(e->queue_index) != queue_index)
470 WRITE_ONCE(e->queue_index, queue_index);
471 if (e->updated != jiffies)
472 e->updated = jiffies;
473 sock_rps_record_flow_hash(e->rps_rxhash);
475 spin_lock_bh(&tun->lock);
476 if (!tun_flow_find(head, rxhash) &&
477 tun->flow_count < MAX_TAP_FLOWS)
478 tun_flow_create(tun, head, rxhash, queue_index);
480 if (!timer_pending(&tun->flow_gc_timer))
481 mod_timer(&tun->flow_gc_timer,
482 round_jiffies_up(jiffies + delay));
483 spin_unlock_bh(&tun->lock);
489 /* Save the hash received in the stack receive path and update the
490 * flow_hash table accordingly.
492 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry *e, u32 hash)
494 if (unlikely(e->rps_rxhash != hash))
495 e->rps_rxhash = hash;
498 /* We try to identify a flow through its rxhash. The reason that
499 * we do not check rxq no. is because some cards(e.g 82599), chooses
500 * the rxq based on the txq where the last packet of the flow comes. As
501 * the userspace application move between processors, we may get a
502 * different rxq no. here.
504 static u16 tun_automq_select_queue(struct tun_struct *tun, struct sk_buff *skb)
506 struct tun_flow_entry *e;
510 numqueues = READ_ONCE(tun->numqueues);
512 txq = __skb_get_hash_symmetric(skb);
513 e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
515 tun_flow_save_rps_rxhash(e, txq);
516 txq = e->queue_index;
518 /* use multiply and shift instead of expensive divide */
519 txq = ((u64)txq * numqueues) >> 32;
525 static u16 tun_ebpf_select_queue(struct tun_struct *tun, struct sk_buff *skb)
527 struct tun_prog *prog;
531 numqueues = READ_ONCE(tun->numqueues);
535 prog = rcu_dereference(tun->steering_prog);
537 ret = bpf_prog_run_clear_cb(prog->prog, skb);
539 return ret % numqueues;
542 static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb,
543 struct net_device *sb_dev)
545 struct tun_struct *tun = netdev_priv(dev);
549 if (rcu_dereference(tun->steering_prog))
550 ret = tun_ebpf_select_queue(tun, skb);
552 ret = tun_automq_select_queue(tun, skb);
558 static inline bool tun_not_capable(struct tun_struct *tun)
560 const struct cred *cred = current_cred();
561 struct net *net = dev_net(tun->dev);
563 return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
564 (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
565 !ns_capable(net->user_ns, CAP_NET_ADMIN);
568 static void tun_set_real_num_queues(struct tun_struct *tun)
570 netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
571 netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
574 static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
576 tfile->detached = tun;
577 list_add_tail(&tfile->next, &tun->disabled);
581 static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
583 struct tun_struct *tun = tfile->detached;
585 tfile->detached = NULL;
586 list_del_init(&tfile->next);
591 void tun_ptr_free(void *ptr)
595 if (tun_is_xdp_frame(ptr)) {
596 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
598 xdp_return_frame(xdpf);
600 __skb_array_destroy_skb(ptr);
603 EXPORT_SYMBOL_GPL(tun_ptr_free);
605 static void tun_queue_purge(struct tun_file *tfile)
609 while ((ptr = ptr_ring_consume(&tfile->tx_ring)) != NULL)
612 skb_queue_purge(&tfile->sk.sk_write_queue);
613 skb_queue_purge(&tfile->sk.sk_error_queue);
616 static void __tun_detach(struct tun_file *tfile, bool clean)
618 struct tun_file *ntfile;
619 struct tun_struct *tun;
621 tun = rtnl_dereference(tfile->tun);
624 tun_napi_disable(tfile);
628 if (tun && !tfile->detached) {
629 u16 index = tfile->queue_index;
630 BUG_ON(index >= tun->numqueues);
632 rcu_assign_pointer(tun->tfiles[index],
633 tun->tfiles[tun->numqueues - 1]);
634 ntfile = rtnl_dereference(tun->tfiles[index]);
635 ntfile->queue_index = index;
636 rcu_assign_pointer(tun->tfiles[tun->numqueues - 1],
641 RCU_INIT_POINTER(tfile->tun, NULL);
642 sock_put(&tfile->sk);
644 tun_disable_queue(tun, tfile);
647 tun_flow_delete_by_queue(tun, tun->numqueues + 1);
648 /* Drop read queue */
649 tun_queue_purge(tfile);
650 tun_set_real_num_queues(tun);
651 } else if (tfile->detached && clean) {
652 tun = tun_enable_queue(tfile);
653 sock_put(&tfile->sk);
657 if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
658 netif_carrier_off(tun->dev);
660 if (!(tun->flags & IFF_PERSIST) &&
661 tun->dev->reg_state == NETREG_REGISTERED)
662 unregister_netdevice(tun->dev);
665 xdp_rxq_info_unreg(&tfile->xdp_rxq);
666 ptr_ring_cleanup(&tfile->tx_ring, tun_ptr_free);
667 sock_put(&tfile->sk);
671 static void tun_detach(struct tun_file *tfile, bool clean)
673 struct tun_struct *tun;
674 struct net_device *dev;
677 tun = rtnl_dereference(tfile->tun);
678 dev = tun ? tun->dev : NULL;
679 __tun_detach(tfile, clean);
681 netdev_state_change(dev);
685 static void tun_detach_all(struct net_device *dev)
687 struct tun_struct *tun = netdev_priv(dev);
688 struct tun_file *tfile, *tmp;
689 int i, n = tun->numqueues;
691 for (i = 0; i < n; i++) {
692 tfile = rtnl_dereference(tun->tfiles[i]);
694 tun_napi_disable(tfile);
695 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
696 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
697 RCU_INIT_POINTER(tfile->tun, NULL);
700 list_for_each_entry(tfile, &tun->disabled, next) {
701 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
702 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
703 RCU_INIT_POINTER(tfile->tun, NULL);
705 BUG_ON(tun->numqueues != 0);
708 for (i = 0; i < n; i++) {
709 tfile = rtnl_dereference(tun->tfiles[i]);
711 /* Drop read queue */
712 tun_queue_purge(tfile);
713 xdp_rxq_info_unreg(&tfile->xdp_rxq);
714 sock_put(&tfile->sk);
716 list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
717 tun_enable_queue(tfile);
718 tun_queue_purge(tfile);
719 xdp_rxq_info_unreg(&tfile->xdp_rxq);
720 sock_put(&tfile->sk);
722 BUG_ON(tun->numdisabled != 0);
724 if (tun->flags & IFF_PERSIST)
725 module_put(THIS_MODULE);
728 static int tun_attach(struct tun_struct *tun, struct file *file,
729 bool skip_filter, bool napi, bool napi_frags,
732 struct tun_file *tfile = file->private_data;
733 struct net_device *dev = tun->dev;
736 err = security_tun_dev_attach(tfile->socket.sk, tun->security);
741 if (rtnl_dereference(tfile->tun) && !tfile->detached)
745 if (!(tun->flags & IFF_MULTI_QUEUE) && tun->numqueues == 1)
749 if (!tfile->detached &&
750 tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
755 /* Re-attach the filter to persist device */
756 if (!skip_filter && (tun->filter_attached == true)) {
757 lock_sock(tfile->socket.sk);
758 err = sk_attach_filter(&tun->fprog, tfile->socket.sk);
759 release_sock(tfile->socket.sk);
764 if (!tfile->detached &&
765 ptr_ring_resize(&tfile->tx_ring, dev->tx_queue_len,
766 GFP_KERNEL, tun_ptr_free)) {
771 tfile->queue_index = tun->numqueues;
772 tfile->socket.sk->sk_shutdown &= ~RCV_SHUTDOWN;
774 if (tfile->detached) {
775 /* Re-attach detached tfile, updating XDP queue_index */
776 WARN_ON(!xdp_rxq_info_is_reg(&tfile->xdp_rxq));
778 if (tfile->xdp_rxq.queue_index != tfile->queue_index)
779 tfile->xdp_rxq.queue_index = tfile->queue_index;
781 /* Setup XDP RX-queue info, for new tfile getting attached */
782 err = xdp_rxq_info_reg(&tfile->xdp_rxq,
783 tun->dev, tfile->queue_index, 0);
786 err = xdp_rxq_info_reg_mem_model(&tfile->xdp_rxq,
787 MEM_TYPE_PAGE_SHARED, NULL);
789 xdp_rxq_info_unreg(&tfile->xdp_rxq);
795 if (tfile->detached) {
796 tun_enable_queue(tfile);
798 sock_hold(&tfile->sk);
799 tun_napi_init(tun, tfile, napi, napi_frags);
802 if (rtnl_dereference(tun->xdp_prog))
803 sock_set_flag(&tfile->sk, SOCK_XDP);
805 /* device is allowed to go away first, so no need to hold extra
809 /* Publish tfile->tun and tun->tfiles only after we've fully
810 * initialized tfile; otherwise we risk using half-initialized
814 rcu_assign_pointer(tfile->tun, tun);
815 rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
817 tun_set_real_num_queues(tun);
822 static struct tun_struct *tun_get(struct tun_file *tfile)
824 struct tun_struct *tun;
827 tun = rcu_dereference(tfile->tun);
835 static void tun_put(struct tun_struct *tun)
841 static void addr_hash_set(u32 *mask, const u8 *addr)
843 int n = ether_crc(ETH_ALEN, addr) >> 26;
844 mask[n >> 5] |= (1 << (n & 31));
847 static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
849 int n = ether_crc(ETH_ALEN, addr) >> 26;
850 return mask[n >> 5] & (1 << (n & 31));
853 static int update_filter(struct tap_filter *filter, void __user *arg)
855 struct { u8 u[ETH_ALEN]; } *addr;
856 struct tun_filter uf;
857 int err, alen, n, nexact;
859 if (copy_from_user(&uf, arg, sizeof(uf)))
868 alen = ETH_ALEN * uf.count;
869 addr = memdup_user(arg + sizeof(uf), alen);
871 return PTR_ERR(addr);
873 /* The filter is updated without holding any locks. Which is
874 * perfectly safe. We disable it first and in the worst
875 * case we'll accept a few undesired packets. */
879 /* Use first set of addresses as an exact filter */
880 for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
881 memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
885 /* Remaining multicast addresses are hashed,
886 * unicast will leave the filter disabled. */
887 memset(filter->mask, 0, sizeof(filter->mask));
888 for (; n < uf.count; n++) {
889 if (!is_multicast_ether_addr(addr[n].u)) {
890 err = 0; /* no filter */
893 addr_hash_set(filter->mask, addr[n].u);
896 /* For ALLMULTI just set the mask to all ones.
897 * This overrides the mask populated above. */
898 if ((uf.flags & TUN_FLT_ALLMULTI))
899 memset(filter->mask, ~0, sizeof(filter->mask));
901 /* Now enable the filter */
903 filter->count = nexact;
905 /* Return the number of exact filters */
912 /* Returns: 0 - drop, !=0 - accept */
913 static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
915 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
917 struct ethhdr *eh = (struct ethhdr *) skb->data;
921 for (i = 0; i < filter->count; i++)
922 if (ether_addr_equal(eh->h_dest, filter->addr[i]))
925 /* Inexact match (multicast only) */
926 if (is_multicast_ether_addr(eh->h_dest))
927 return addr_hash_test(filter->mask, eh->h_dest);
933 * Checks whether the packet is accepted or not.
934 * Returns: 0 - drop, !=0 - accept
936 static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
941 return run_filter(filter, skb);
944 /* Network device part of the driver */
946 static const struct ethtool_ops tun_ethtool_ops;
948 /* Net device detach from fd. */
949 static void tun_net_uninit(struct net_device *dev)
954 /* Net device open. */
955 static int tun_net_open(struct net_device *dev)
957 netif_tx_start_all_queues(dev);
962 /* Net device close. */
963 static int tun_net_close(struct net_device *dev)
965 netif_tx_stop_all_queues(dev);
969 /* Net device start xmit */
970 static void tun_automq_xmit(struct tun_struct *tun, struct sk_buff *skb)
973 if (tun->numqueues == 1 && static_branch_unlikely(&rps_needed)) {
974 /* Select queue was not called for the skbuff, so we extract the
975 * RPS hash and save it into the flow_table here.
977 struct tun_flow_entry *e;
980 rxhash = __skb_get_hash_symmetric(skb);
981 e = tun_flow_find(&tun->flows[tun_hashfn(rxhash)], rxhash);
983 tun_flow_save_rps_rxhash(e, rxhash);
988 static unsigned int run_ebpf_filter(struct tun_struct *tun,
992 struct tun_prog *prog = rcu_dereference(tun->filter_prog);
995 len = bpf_prog_run_clear_cb(prog->prog, skb);
1000 /* Net device start xmit */
1001 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
1003 struct tun_struct *tun = netdev_priv(dev);
1004 int txq = skb->queue_mapping;
1005 struct tun_file *tfile;
1009 tfile = rcu_dereference(tun->tfiles[txq]);
1011 /* Drop packet if interface is not attached */
1015 if (!rcu_dereference(tun->steering_prog))
1016 tun_automq_xmit(tun, skb);
1018 netif_info(tun, tx_queued, tun->dev, "%s %d\n", __func__, skb->len);
1020 /* Drop if the filter does not like it.
1021 * This is a noop if the filter is disabled.
1022 * Filter can be enabled only for the TAP devices. */
1023 if (!check_filter(&tun->txflt, skb))
1026 if (tfile->socket.sk->sk_filter &&
1027 sk_filter(tfile->socket.sk, skb))
1030 len = run_ebpf_filter(tun, skb, len);
1031 if (len == 0 || pskb_trim(skb, len))
1034 if (unlikely(skb_orphan_frags_rx(skb, GFP_ATOMIC)))
1037 skb_tx_timestamp(skb);
1039 /* Orphan the skb - required as we might hang on to it
1040 * for indefinite time.
1046 if (ptr_ring_produce(&tfile->tx_ring, skb))
1049 /* Notify and wake up reader process */
1050 if (tfile->flags & TUN_FASYNC)
1051 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1052 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1055 return NETDEV_TX_OK;
1058 atomic_long_inc(&dev->tx_dropped);
1062 return NET_XMIT_DROP;
1065 static void tun_net_mclist(struct net_device *dev)
1068 * This callback is supposed to deal with mc filter in
1069 * _rx_ path and has nothing to do with the _tx_ path.
1070 * In rx path we always accept everything userspace gives us.
1074 static netdev_features_t tun_net_fix_features(struct net_device *dev,
1075 netdev_features_t features)
1077 struct tun_struct *tun = netdev_priv(dev);
1079 return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
1082 static void tun_set_headroom(struct net_device *dev, int new_hr)
1084 struct tun_struct *tun = netdev_priv(dev);
1086 if (new_hr < NET_SKB_PAD)
1087 new_hr = NET_SKB_PAD;
1089 tun->align = new_hr;
1093 tun_net_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats)
1095 struct tun_struct *tun = netdev_priv(dev);
1097 dev_get_tstats64(dev, stats);
1099 stats->rx_frame_errors +=
1100 (unsigned long)atomic_long_read(&tun->rx_frame_errors);
1103 static int tun_xdp_set(struct net_device *dev, struct bpf_prog *prog,
1104 struct netlink_ext_ack *extack)
1106 struct tun_struct *tun = netdev_priv(dev);
1107 struct tun_file *tfile;
1108 struct bpf_prog *old_prog;
1111 old_prog = rtnl_dereference(tun->xdp_prog);
1112 rcu_assign_pointer(tun->xdp_prog, prog);
1114 bpf_prog_put(old_prog);
1116 for (i = 0; i < tun->numqueues; i++) {
1117 tfile = rtnl_dereference(tun->tfiles[i]);
1119 sock_set_flag(&tfile->sk, SOCK_XDP);
1121 sock_reset_flag(&tfile->sk, SOCK_XDP);
1123 list_for_each_entry(tfile, &tun->disabled, next) {
1125 sock_set_flag(&tfile->sk, SOCK_XDP);
1127 sock_reset_flag(&tfile->sk, SOCK_XDP);
1133 static int tun_xdp(struct net_device *dev, struct netdev_bpf *xdp)
1135 switch (xdp->command) {
1136 case XDP_SETUP_PROG:
1137 return tun_xdp_set(dev, xdp->prog, xdp->extack);
1143 static int tun_net_change_carrier(struct net_device *dev, bool new_carrier)
1146 struct tun_struct *tun = netdev_priv(dev);
1148 if (!tun->numqueues)
1151 netif_carrier_on(dev);
1153 netif_carrier_off(dev);
1158 static const struct net_device_ops tun_netdev_ops = {
1159 .ndo_uninit = tun_net_uninit,
1160 .ndo_open = tun_net_open,
1161 .ndo_stop = tun_net_close,
1162 .ndo_start_xmit = tun_net_xmit,
1163 .ndo_fix_features = tun_net_fix_features,
1164 .ndo_select_queue = tun_select_queue,
1165 .ndo_set_rx_headroom = tun_set_headroom,
1166 .ndo_get_stats64 = tun_net_get_stats64,
1167 .ndo_change_carrier = tun_net_change_carrier,
1170 static void __tun_xdp_flush_tfile(struct tun_file *tfile)
1172 /* Notify and wake up reader process */
1173 if (tfile->flags & TUN_FASYNC)
1174 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1175 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1178 static int tun_xdp_xmit(struct net_device *dev, int n,
1179 struct xdp_frame **frames, u32 flags)
1181 struct tun_struct *tun = netdev_priv(dev);
1182 struct tun_file *tfile;
1188 if (unlikely(flags & ~XDP_XMIT_FLAGS_MASK))
1194 numqueues = READ_ONCE(tun->numqueues);
1197 return -ENXIO; /* Caller will free/return all frames */
1200 tfile = rcu_dereference(tun->tfiles[smp_processor_id() %
1202 if (unlikely(!tfile))
1205 spin_lock(&tfile->tx_ring.producer_lock);
1206 for (i = 0; i < n; i++) {
1207 struct xdp_frame *xdp = frames[i];
1208 /* Encode the XDP flag into lowest bit for consumer to differ
1209 * XDP buffer from sk_buff.
1211 void *frame = tun_xdp_to_ptr(xdp);
1213 if (__ptr_ring_produce(&tfile->tx_ring, frame)) {
1214 atomic_long_inc(&dev->tx_dropped);
1215 xdp_return_frame_rx_napi(xdp);
1219 spin_unlock(&tfile->tx_ring.producer_lock);
1221 if (flags & XDP_XMIT_FLUSH)
1222 __tun_xdp_flush_tfile(tfile);
1228 static int tun_xdp_tx(struct net_device *dev, struct xdp_buff *xdp)
1230 struct xdp_frame *frame = xdp_convert_buff_to_frame(xdp);
1232 if (unlikely(!frame))
1235 return tun_xdp_xmit(dev, 1, &frame, XDP_XMIT_FLUSH);
1238 static const struct net_device_ops tap_netdev_ops = {
1239 .ndo_uninit = tun_net_uninit,
1240 .ndo_open = tun_net_open,
1241 .ndo_stop = tun_net_close,
1242 .ndo_start_xmit = tun_net_xmit,
1243 .ndo_fix_features = tun_net_fix_features,
1244 .ndo_set_rx_mode = tun_net_mclist,
1245 .ndo_set_mac_address = eth_mac_addr,
1246 .ndo_validate_addr = eth_validate_addr,
1247 .ndo_select_queue = tun_select_queue,
1248 .ndo_features_check = passthru_features_check,
1249 .ndo_set_rx_headroom = tun_set_headroom,
1250 .ndo_get_stats64 = dev_get_tstats64,
1252 .ndo_xdp_xmit = tun_xdp_xmit,
1253 .ndo_change_carrier = tun_net_change_carrier,
1256 static void tun_flow_init(struct tun_struct *tun)
1260 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
1261 INIT_HLIST_HEAD(&tun->flows[i]);
1263 tun->ageing_time = TUN_FLOW_EXPIRE;
1264 timer_setup(&tun->flow_gc_timer, tun_flow_cleanup, 0);
1265 mod_timer(&tun->flow_gc_timer,
1266 round_jiffies_up(jiffies + tun->ageing_time));
1269 static void tun_flow_uninit(struct tun_struct *tun)
1271 del_timer_sync(&tun->flow_gc_timer);
1272 tun_flow_flush(tun);
1276 #define MAX_MTU 65535
1278 /* Initialize net device. */
1279 static void tun_net_init(struct net_device *dev)
1281 struct tun_struct *tun = netdev_priv(dev);
1283 switch (tun->flags & TUN_TYPE_MASK) {
1285 dev->netdev_ops = &tun_netdev_ops;
1286 dev->header_ops = &ip_tunnel_header_ops;
1288 /* Point-to-Point TUN Device */
1289 dev->hard_header_len = 0;
1293 /* Zero header length */
1294 dev->type = ARPHRD_NONE;
1295 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
1299 dev->netdev_ops = &tap_netdev_ops;
1300 /* Ethernet TAP Device */
1302 dev->priv_flags &= ~IFF_TX_SKB_SHARING;
1303 dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
1305 eth_hw_addr_random(dev);
1310 dev->min_mtu = MIN_MTU;
1311 dev->max_mtu = MAX_MTU - dev->hard_header_len;
1314 static bool tun_sock_writeable(struct tun_struct *tun, struct tun_file *tfile)
1316 struct sock *sk = tfile->socket.sk;
1318 return (tun->dev->flags & IFF_UP) && sock_writeable(sk);
1321 /* Character device part */
1324 static __poll_t tun_chr_poll(struct file *file, poll_table *wait)
1326 struct tun_file *tfile = file->private_data;
1327 struct tun_struct *tun = tun_get(tfile);
1334 sk = tfile->socket.sk;
1336 poll_wait(file, sk_sleep(sk), wait);
1338 if (!ptr_ring_empty(&tfile->tx_ring))
1339 mask |= EPOLLIN | EPOLLRDNORM;
1341 /* Make sure SOCKWQ_ASYNC_NOSPACE is set if not writable to
1342 * guarantee EPOLLOUT to be raised by either here or
1343 * tun_sock_write_space(). Then process could get notification
1344 * after it writes to a down device and meets -EIO.
1346 if (tun_sock_writeable(tun, tfile) ||
1347 (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
1348 tun_sock_writeable(tun, tfile)))
1349 mask |= EPOLLOUT | EPOLLWRNORM;
1351 if (tun->dev->reg_state != NETREG_REGISTERED)
1358 static struct sk_buff *tun_napi_alloc_frags(struct tun_file *tfile,
1360 const struct iov_iter *it)
1362 struct sk_buff *skb;
1367 if (it->nr_segs > MAX_SKB_FRAGS + 1)
1368 return ERR_PTR(-EMSGSIZE);
1371 skb = napi_get_frags(&tfile->napi);
1374 return ERR_PTR(-ENOMEM);
1376 linear = iov_iter_single_seg_count(it);
1377 err = __skb_grow(skb, linear);
1382 skb->data_len = len - linear;
1383 skb->truesize += skb->data_len;
1385 for (i = 1; i < it->nr_segs; i++) {
1386 size_t fragsz = it->iov[i].iov_len;
1390 if (fragsz == 0 || fragsz > PAGE_SIZE) {
1394 frag = netdev_alloc_frag(fragsz);
1399 page = virt_to_head_page(frag);
1400 skb_fill_page_desc(skb, i - 1, page,
1401 frag - page_address(page), fragsz);
1406 /* frees skb and all frags allocated with napi_alloc_frag() */
1407 napi_free_frags(&tfile->napi);
1408 return ERR_PTR(err);
1411 /* prepad is the amount to reserve at front. len is length after that.
1412 * linear is a hint as to how much to copy (usually headers). */
1413 static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
1414 size_t prepad, size_t len,
1415 size_t linear, int noblock)
1417 struct sock *sk = tfile->socket.sk;
1418 struct sk_buff *skb;
1421 /* Under a page? Don't bother with paged skb. */
1422 if (prepad + len < PAGE_SIZE || !linear)
1425 skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
1428 return ERR_PTR(err);
1430 skb_reserve(skb, prepad);
1431 skb_put(skb, linear);
1432 skb->data_len = len - linear;
1433 skb->len += len - linear;
1438 static void tun_rx_batched(struct tun_struct *tun, struct tun_file *tfile,
1439 struct sk_buff *skb, int more)
1441 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1442 struct sk_buff_head process_queue;
1443 u32 rx_batched = tun->rx_batched;
1446 if (!rx_batched || (!more && skb_queue_empty(queue))) {
1448 skb_record_rx_queue(skb, tfile->queue_index);
1449 netif_receive_skb(skb);
1454 spin_lock(&queue->lock);
1455 if (!more || skb_queue_len(queue) == rx_batched) {
1456 __skb_queue_head_init(&process_queue);
1457 skb_queue_splice_tail_init(queue, &process_queue);
1460 __skb_queue_tail(queue, skb);
1462 spin_unlock(&queue->lock);
1465 struct sk_buff *nskb;
1468 while ((nskb = __skb_dequeue(&process_queue))) {
1469 skb_record_rx_queue(nskb, tfile->queue_index);
1470 netif_receive_skb(nskb);
1472 skb_record_rx_queue(skb, tfile->queue_index);
1473 netif_receive_skb(skb);
1478 static bool tun_can_build_skb(struct tun_struct *tun, struct tun_file *tfile,
1479 int len, int noblock, bool zerocopy)
1481 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
1484 if (tfile->socket.sk->sk_sndbuf != INT_MAX)
1493 if (SKB_DATA_ALIGN(len + TUN_RX_PAD) +
1494 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
1500 static struct sk_buff *__tun_build_skb(struct tun_file *tfile,
1501 struct page_frag *alloc_frag, char *buf,
1502 int buflen, int len, int pad)
1504 struct sk_buff *skb = build_skb(buf, buflen);
1507 return ERR_PTR(-ENOMEM);
1509 skb_reserve(skb, pad);
1511 skb_set_owner_w(skb, tfile->socket.sk);
1513 get_page(alloc_frag->page);
1514 alloc_frag->offset += buflen;
1519 static int tun_xdp_act(struct tun_struct *tun, struct bpf_prog *xdp_prog,
1520 struct xdp_buff *xdp, u32 act)
1526 err = xdp_do_redirect(tun->dev, xdp, xdp_prog);
1531 err = tun_xdp_tx(tun->dev, xdp);
1538 bpf_warn_invalid_xdp_action(act);
1541 trace_xdp_exception(tun->dev, xdp_prog, act);
1544 atomic_long_inc(&tun->dev->rx_dropped);
1551 static struct sk_buff *tun_build_skb(struct tun_struct *tun,
1552 struct tun_file *tfile,
1553 struct iov_iter *from,
1554 struct virtio_net_hdr *hdr,
1555 int len, int *skb_xdp)
1557 struct page_frag *alloc_frag = ¤t->task_frag;
1558 struct bpf_prog *xdp_prog;
1559 int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
1562 int pad = TUN_RX_PAD;
1566 xdp_prog = rcu_dereference(tun->xdp_prog);
1568 pad += XDP_PACKET_HEADROOM;
1569 buflen += SKB_DATA_ALIGN(len + pad);
1572 alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
1573 if (unlikely(!skb_page_frag_refill(buflen, alloc_frag, GFP_KERNEL)))
1574 return ERR_PTR(-ENOMEM);
1576 buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
1577 copied = copy_page_from_iter(alloc_frag->page,
1578 alloc_frag->offset + pad,
1581 return ERR_PTR(-EFAULT);
1583 /* There's a small window that XDP may be set after the check
1584 * of xdp_prog above, this should be rare and for simplicity
1585 * we do XDP on skb in case the headroom is not enough.
1587 if (hdr->gso_type || !xdp_prog) {
1589 return __tun_build_skb(tfile, alloc_frag, buf, buflen, len,
1597 xdp_prog = rcu_dereference(tun->xdp_prog);
1599 struct xdp_buff xdp;
1602 xdp.data_hard_start = buf;
1603 xdp.data = buf + pad;
1604 xdp_set_data_meta_invalid(&xdp);
1605 xdp.data_end = xdp.data + len;
1606 xdp.rxq = &tfile->xdp_rxq;
1607 xdp.frame_sz = buflen;
1609 act = bpf_prog_run_xdp(xdp_prog, &xdp);
1610 if (act == XDP_REDIRECT || act == XDP_TX) {
1611 get_page(alloc_frag->page);
1612 alloc_frag->offset += buflen;
1614 err = tun_xdp_act(tun, xdp_prog, &xdp, act);
1616 if (act == XDP_REDIRECT || act == XDP_TX)
1617 put_page(alloc_frag->page);
1621 if (err == XDP_REDIRECT)
1623 if (err != XDP_PASS)
1626 pad = xdp.data - xdp.data_hard_start;
1627 len = xdp.data_end - xdp.data;
1632 return __tun_build_skb(tfile, alloc_frag, buf, buflen, len, pad);
1640 /* Get packet from user space buffer */
1641 static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
1642 void *msg_control, struct iov_iter *from,
1643 int noblock, bool more)
1645 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1646 struct sk_buff *skb;
1647 size_t total_len = iov_iter_count(from);
1648 size_t len = total_len, align = tun->align, linear;
1649 struct virtio_net_hdr gso = { 0 };
1652 bool zerocopy = false;
1656 bool frags = tun_napi_frags_enabled(tfile);
1658 if (!(tun->flags & IFF_NO_PI)) {
1659 if (len < sizeof(pi))
1663 if (!copy_from_iter_full(&pi, sizeof(pi), from))
1667 if (tun->flags & IFF_VNET_HDR) {
1668 int vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1670 if (len < vnet_hdr_sz)
1674 if (!copy_from_iter_full(&gso, sizeof(gso), from))
1677 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
1678 tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1679 gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
1681 if (tun16_to_cpu(tun, gso.hdr_len) > len)
1683 iov_iter_advance(from, vnet_hdr_sz - sizeof(gso));
1686 if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
1687 align += NET_IP_ALIGN;
1688 if (unlikely(len < ETH_HLEN ||
1689 (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
1693 good_linear = SKB_MAX_HEAD(align);
1696 struct iov_iter i = *from;
1698 /* There are 256 bytes to be copied in skb, so there is
1699 * enough room for skb expand head in case it is used.
1700 * The rest of the buffer is mapped from userspace.
1702 copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
1703 if (copylen > good_linear)
1704 copylen = good_linear;
1706 iov_iter_advance(&i, copylen);
1707 if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
1711 if (!frags && tun_can_build_skb(tun, tfile, len, noblock, zerocopy)) {
1712 /* For the packet that is not easy to be processed
1713 * (e.g gso or jumbo packet), we will do it at after
1714 * skb was created with generic XDP routine.
1716 skb = tun_build_skb(tun, tfile, from, &gso, len, &skb_xdp);
1718 atomic_long_inc(&tun->dev->rx_dropped);
1719 return PTR_ERR(skb);
1726 if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1727 linear = good_linear;
1729 linear = tun16_to_cpu(tun, gso.hdr_len);
1733 mutex_lock(&tfile->napi_mutex);
1734 skb = tun_napi_alloc_frags(tfile, copylen, from);
1735 /* tun_napi_alloc_frags() enforces a layout for the skb.
1736 * If zerocopy is enabled, then this layout will be
1737 * overwritten by zerocopy_sg_from_iter().
1741 skb = tun_alloc_skb(tfile, align, copylen, linear,
1746 if (PTR_ERR(skb) != -EAGAIN)
1747 atomic_long_inc(&tun->dev->rx_dropped);
1749 mutex_unlock(&tfile->napi_mutex);
1750 return PTR_ERR(skb);
1754 err = zerocopy_sg_from_iter(skb, from);
1756 err = skb_copy_datagram_from_iter(skb, 0, from, len);
1761 atomic_long_inc(&tun->dev->rx_dropped);
1764 tfile->napi.skb = NULL;
1765 mutex_unlock(&tfile->napi_mutex);
1772 if (virtio_net_hdr_to_skb(skb, &gso, tun_is_little_endian(tun))) {
1773 atomic_long_inc(&tun->rx_frame_errors);
1776 tfile->napi.skb = NULL;
1777 mutex_unlock(&tfile->napi_mutex);
1783 switch (tun->flags & TUN_TYPE_MASK) {
1785 if (tun->flags & IFF_NO_PI) {
1786 u8 ip_version = skb->len ? (skb->data[0] >> 4) : 0;
1788 switch (ip_version) {
1790 pi.proto = htons(ETH_P_IP);
1793 pi.proto = htons(ETH_P_IPV6);
1796 atomic_long_inc(&tun->dev->rx_dropped);
1802 skb_reset_mac_header(skb);
1803 skb->protocol = pi.proto;
1804 skb->dev = tun->dev;
1807 if (frags && !pskb_may_pull(skb, ETH_HLEN)) {
1811 skb->protocol = eth_type_trans(skb, tun->dev);
1815 /* copy skb_ubuf_info for callback when skb has no error */
1817 skb_zcopy_init(skb, msg_control);
1818 } else if (msg_control) {
1819 struct ubuf_info *uarg = msg_control;
1820 uarg->callback(NULL, uarg, false);
1823 skb_reset_network_header(skb);
1824 skb_probe_transport_header(skb);
1825 skb_record_rx_queue(skb, tfile->queue_index);
1828 struct bpf_prog *xdp_prog;
1833 xdp_prog = rcu_dereference(tun->xdp_prog);
1835 ret = do_xdp_generic(xdp_prog, skb);
1836 if (ret != XDP_PASS) {
1840 tfile->napi.skb = NULL;
1841 mutex_unlock(&tfile->napi_mutex);
1850 /* Compute the costly rx hash only if needed for flow updates.
1851 * We may get a very small possibility of OOO during switching, not
1852 * worth to optimize.
1854 if (!rcu_access_pointer(tun->steering_prog) && tun->numqueues > 1 &&
1856 rxhash = __skb_get_hash_symmetric(skb);
1859 if (unlikely(!(tun->dev->flags & IFF_UP))) {
1868 /* Exercise flow dissector code path. */
1869 skb_push(skb, ETH_HLEN);
1870 headlen = eth_get_headlen(tun->dev, skb->data,
1873 if (unlikely(headlen > skb_headlen(skb))) {
1874 atomic_long_inc(&tun->dev->rx_dropped);
1875 napi_free_frags(&tfile->napi);
1877 mutex_unlock(&tfile->napi_mutex);
1883 napi_gro_frags(&tfile->napi);
1885 mutex_unlock(&tfile->napi_mutex);
1886 } else if (tfile->napi_enabled) {
1887 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1890 spin_lock_bh(&queue->lock);
1891 __skb_queue_tail(queue, skb);
1892 queue_len = skb_queue_len(queue);
1893 spin_unlock(&queue->lock);
1895 if (!more || queue_len > NAPI_POLL_WEIGHT)
1896 napi_schedule(&tfile->napi);
1899 } else if (!IS_ENABLED(CONFIG_4KSTACKS)) {
1900 tun_rx_batched(tun, tfile, skb, more);
1907 dev_sw_netstats_rx_add(tun->dev, len);
1911 tun_flow_update(tun, rxhash, tfile);
1916 static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
1918 struct file *file = iocb->ki_filp;
1919 struct tun_file *tfile = file->private_data;
1920 struct tun_struct *tun = tun_get(tfile);
1927 if ((file->f_flags & O_NONBLOCK) || (iocb->ki_flags & IOCB_NOWAIT))
1930 result = tun_get_user(tun, tfile, NULL, from, noblock, false);
1936 static ssize_t tun_put_user_xdp(struct tun_struct *tun,
1937 struct tun_file *tfile,
1938 struct xdp_frame *xdp_frame,
1939 struct iov_iter *iter)
1941 int vnet_hdr_sz = 0;
1942 size_t size = xdp_frame->len;
1945 if (tun->flags & IFF_VNET_HDR) {
1946 struct virtio_net_hdr gso = { 0 };
1948 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1949 if (unlikely(iov_iter_count(iter) < vnet_hdr_sz))
1951 if (unlikely(copy_to_iter(&gso, sizeof(gso), iter) !=
1954 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
1957 ret = copy_to_iter(xdp_frame->data, size, iter) + vnet_hdr_sz;
1960 dev_sw_netstats_tx_add(tun->dev, 1, ret);
1966 /* Put packet to the user space buffer */
1967 static ssize_t tun_put_user(struct tun_struct *tun,
1968 struct tun_file *tfile,
1969 struct sk_buff *skb,
1970 struct iov_iter *iter)
1972 struct tun_pi pi = { 0, skb->protocol };
1974 int vlan_offset = 0;
1976 int vnet_hdr_sz = 0;
1978 if (skb_vlan_tag_present(skb))
1979 vlan_hlen = VLAN_HLEN;
1981 if (tun->flags & IFF_VNET_HDR)
1982 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1984 total = skb->len + vlan_hlen + vnet_hdr_sz;
1986 if (!(tun->flags & IFF_NO_PI)) {
1987 if (iov_iter_count(iter) < sizeof(pi))
1990 total += sizeof(pi);
1991 if (iov_iter_count(iter) < total) {
1992 /* Packet will be striped */
1993 pi.flags |= TUN_PKT_STRIP;
1996 if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
2001 struct virtio_net_hdr gso;
2003 if (iov_iter_count(iter) < vnet_hdr_sz)
2006 if (virtio_net_hdr_from_skb(skb, &gso,
2007 tun_is_little_endian(tun), true,
2009 struct skb_shared_info *sinfo = skb_shinfo(skb);
2010 pr_err("unexpected GSO type: "
2011 "0x%x, gso_size %d, hdr_len %d\n",
2012 sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
2013 tun16_to_cpu(tun, gso.hdr_len));
2014 print_hex_dump(KERN_ERR, "tun: ",
2017 min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
2022 if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
2025 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2032 veth.h_vlan_proto = skb->vlan_proto;
2033 veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
2035 vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
2037 ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
2038 if (ret || !iov_iter_count(iter))
2041 ret = copy_to_iter(&veth, sizeof(veth), iter);
2042 if (ret != sizeof(veth) || !iov_iter_count(iter))
2046 skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
2049 /* caller is in process context, */
2051 dev_sw_netstats_tx_add(tun->dev, 1, skb->len + vlan_hlen);
2057 static void *tun_ring_recv(struct tun_file *tfile, int noblock, int *err)
2059 DECLARE_WAITQUEUE(wait, current);
2063 ptr = ptr_ring_consume(&tfile->tx_ring);
2071 add_wait_queue(&tfile->socket.wq.wait, &wait);
2074 set_current_state(TASK_INTERRUPTIBLE);
2075 ptr = ptr_ring_consume(&tfile->tx_ring);
2078 if (signal_pending(current)) {
2079 error = -ERESTARTSYS;
2082 if (tfile->socket.sk->sk_shutdown & RCV_SHUTDOWN) {
2090 __set_current_state(TASK_RUNNING);
2091 remove_wait_queue(&tfile->socket.wq.wait, &wait);
2098 static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
2099 struct iov_iter *to,
2100 int noblock, void *ptr)
2105 if (!iov_iter_count(to)) {
2111 /* Read frames from ring */
2112 ptr = tun_ring_recv(tfile, noblock, &err);
2117 if (tun_is_xdp_frame(ptr)) {
2118 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2120 ret = tun_put_user_xdp(tun, tfile, xdpf, to);
2121 xdp_return_frame(xdpf);
2123 struct sk_buff *skb = ptr;
2125 ret = tun_put_user(tun, tfile, skb, to);
2126 if (unlikely(ret < 0))
2135 static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
2137 struct file *file = iocb->ki_filp;
2138 struct tun_file *tfile = file->private_data;
2139 struct tun_struct *tun = tun_get(tfile);
2140 ssize_t len = iov_iter_count(to), ret;
2146 if ((file->f_flags & O_NONBLOCK) || (iocb->ki_flags & IOCB_NOWAIT))
2149 ret = tun_do_read(tun, tfile, to, noblock, NULL);
2150 ret = min_t(ssize_t, ret, len);
2157 static void tun_prog_free(struct rcu_head *rcu)
2159 struct tun_prog *prog = container_of(rcu, struct tun_prog, rcu);
2161 bpf_prog_destroy(prog->prog);
2165 static int __tun_set_ebpf(struct tun_struct *tun,
2166 struct tun_prog __rcu **prog_p,
2167 struct bpf_prog *prog)
2169 struct tun_prog *old, *new = NULL;
2172 new = kmalloc(sizeof(*new), GFP_KERNEL);
2178 spin_lock_bh(&tun->lock);
2179 old = rcu_dereference_protected(*prog_p,
2180 lockdep_is_held(&tun->lock));
2181 rcu_assign_pointer(*prog_p, new);
2182 spin_unlock_bh(&tun->lock);
2185 call_rcu(&old->rcu, tun_prog_free);
2190 static void tun_free_netdev(struct net_device *dev)
2192 struct tun_struct *tun = netdev_priv(dev);
2194 BUG_ON(!(list_empty(&tun->disabled)));
2196 free_percpu(dev->tstats);
2197 /* We clear tstats so that tun_set_iff() can tell if
2198 * tun_free_netdev() has been called from register_netdevice().
2202 tun_flow_uninit(tun);
2203 security_tun_dev_free_security(tun->security);
2204 __tun_set_ebpf(tun, &tun->steering_prog, NULL);
2205 __tun_set_ebpf(tun, &tun->filter_prog, NULL);
2208 static void tun_setup(struct net_device *dev)
2210 struct tun_struct *tun = netdev_priv(dev);
2212 tun->owner = INVALID_UID;
2213 tun->group = INVALID_GID;
2214 tun_default_link_ksettings(dev, &tun->link_ksettings);
2216 dev->ethtool_ops = &tun_ethtool_ops;
2217 dev->needs_free_netdev = true;
2218 dev->priv_destructor = tun_free_netdev;
2219 /* We prefer our own queue length */
2220 dev->tx_queue_len = TUN_READQ_SIZE;
2223 /* Trivial set of netlink ops to allow deleting tun or tap
2224 * device with netlink.
2226 static int tun_validate(struct nlattr *tb[], struct nlattr *data[],
2227 struct netlink_ext_ack *extack)
2229 NL_SET_ERR_MSG(extack,
2230 "tun/tap creation via rtnetlink is not supported.");
2234 static size_t tun_get_size(const struct net_device *dev)
2236 BUILD_BUG_ON(sizeof(u32) != sizeof(uid_t));
2237 BUILD_BUG_ON(sizeof(u32) != sizeof(gid_t));
2239 return nla_total_size(sizeof(uid_t)) + /* OWNER */
2240 nla_total_size(sizeof(gid_t)) + /* GROUP */
2241 nla_total_size(sizeof(u8)) + /* TYPE */
2242 nla_total_size(sizeof(u8)) + /* PI */
2243 nla_total_size(sizeof(u8)) + /* VNET_HDR */
2244 nla_total_size(sizeof(u8)) + /* PERSIST */
2245 nla_total_size(sizeof(u8)) + /* MULTI_QUEUE */
2246 nla_total_size(sizeof(u32)) + /* NUM_QUEUES */
2247 nla_total_size(sizeof(u32)) + /* NUM_DISABLED_QUEUES */
2251 static int tun_fill_info(struct sk_buff *skb, const struct net_device *dev)
2253 struct tun_struct *tun = netdev_priv(dev);
2255 if (nla_put_u8(skb, IFLA_TUN_TYPE, tun->flags & TUN_TYPE_MASK))
2256 goto nla_put_failure;
2257 if (uid_valid(tun->owner) &&
2258 nla_put_u32(skb, IFLA_TUN_OWNER,
2259 from_kuid_munged(current_user_ns(), tun->owner)))
2260 goto nla_put_failure;
2261 if (gid_valid(tun->group) &&
2262 nla_put_u32(skb, IFLA_TUN_GROUP,
2263 from_kgid_munged(current_user_ns(), tun->group)))
2264 goto nla_put_failure;
2265 if (nla_put_u8(skb, IFLA_TUN_PI, !(tun->flags & IFF_NO_PI)))
2266 goto nla_put_failure;
2267 if (nla_put_u8(skb, IFLA_TUN_VNET_HDR, !!(tun->flags & IFF_VNET_HDR)))
2268 goto nla_put_failure;
2269 if (nla_put_u8(skb, IFLA_TUN_PERSIST, !!(tun->flags & IFF_PERSIST)))
2270 goto nla_put_failure;
2271 if (nla_put_u8(skb, IFLA_TUN_MULTI_QUEUE,
2272 !!(tun->flags & IFF_MULTI_QUEUE)))
2273 goto nla_put_failure;
2274 if (tun->flags & IFF_MULTI_QUEUE) {
2275 if (nla_put_u32(skb, IFLA_TUN_NUM_QUEUES, tun->numqueues))
2276 goto nla_put_failure;
2277 if (nla_put_u32(skb, IFLA_TUN_NUM_DISABLED_QUEUES,
2279 goto nla_put_failure;
2288 static struct rtnl_link_ops tun_link_ops __read_mostly = {
2290 .priv_size = sizeof(struct tun_struct),
2292 .validate = tun_validate,
2293 .get_size = tun_get_size,
2294 .fill_info = tun_fill_info,
2297 static void tun_sock_write_space(struct sock *sk)
2299 struct tun_file *tfile;
2300 wait_queue_head_t *wqueue;
2302 if (!sock_writeable(sk))
2305 if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
2308 wqueue = sk_sleep(sk);
2309 if (wqueue && waitqueue_active(wqueue))
2310 wake_up_interruptible_sync_poll(wqueue, EPOLLOUT |
2311 EPOLLWRNORM | EPOLLWRBAND);
2313 tfile = container_of(sk, struct tun_file, sk);
2314 kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
2317 static void tun_put_page(struct tun_page *tpage)
2320 __page_frag_cache_drain(tpage->page, tpage->count);
2323 static int tun_xdp_one(struct tun_struct *tun,
2324 struct tun_file *tfile,
2325 struct xdp_buff *xdp, int *flush,
2326 struct tun_page *tpage)
2328 unsigned int datasize = xdp->data_end - xdp->data;
2329 struct tun_xdp_hdr *hdr = xdp->data_hard_start;
2330 struct virtio_net_hdr *gso = &hdr->gso;
2331 struct bpf_prog *xdp_prog;
2332 struct sk_buff *skb = NULL;
2333 u32 rxhash = 0, act;
2334 int buflen = hdr->buflen;
2336 bool skb_xdp = false;
2339 xdp_prog = rcu_dereference(tun->xdp_prog);
2341 if (gso->gso_type) {
2345 xdp_set_data_meta_invalid(xdp);
2346 xdp->rxq = &tfile->xdp_rxq;
2347 xdp->frame_sz = buflen;
2349 act = bpf_prog_run_xdp(xdp_prog, xdp);
2350 err = tun_xdp_act(tun, xdp_prog, xdp, act);
2352 put_page(virt_to_head_page(xdp->data));
2365 page = virt_to_head_page(xdp->data);
2366 if (tpage->page == page) {
2369 tun_put_page(tpage);
2378 skb = build_skb(xdp->data_hard_start, buflen);
2384 skb_reserve(skb, xdp->data - xdp->data_hard_start);
2385 skb_put(skb, xdp->data_end - xdp->data);
2387 if (virtio_net_hdr_to_skb(skb, gso, tun_is_little_endian(tun))) {
2388 atomic_long_inc(&tun->rx_frame_errors);
2394 skb->protocol = eth_type_trans(skb, tun->dev);
2395 skb_reset_network_header(skb);
2396 skb_probe_transport_header(skb);
2397 skb_record_rx_queue(skb, tfile->queue_index);
2400 err = do_xdp_generic(xdp_prog, skb);
2401 if (err != XDP_PASS)
2405 if (!rcu_dereference(tun->steering_prog) && tun->numqueues > 1 &&
2407 rxhash = __skb_get_hash_symmetric(skb);
2409 netif_receive_skb(skb);
2411 /* No need to disable preemption here since this function is
2412 * always called with bh disabled
2414 dev_sw_netstats_rx_add(tun->dev, datasize);
2417 tun_flow_update(tun, rxhash, tfile);
2423 static int tun_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
2426 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2427 struct tun_struct *tun = tun_get(tfile);
2428 struct tun_msg_ctl *ctl = m->msg_control;
2429 struct xdp_buff *xdp;
2434 if (ctl && (ctl->type == TUN_MSG_PTR)) {
2435 struct tun_page tpage;
2439 memset(&tpage, 0, sizeof(tpage));
2444 for (i = 0; i < n; i++) {
2445 xdp = &((struct xdp_buff *)ctl->ptr)[i];
2446 tun_xdp_one(tun, tfile, xdp, &flush, &tpage);
2455 tun_put_page(&tpage);
2461 ret = tun_get_user(tun, tfile, ctl ? ctl->ptr : NULL, &m->msg_iter,
2462 m->msg_flags & MSG_DONTWAIT,
2463 m->msg_flags & MSG_MORE);
2469 static int tun_recvmsg(struct socket *sock, struct msghdr *m, size_t total_len,
2472 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2473 struct tun_struct *tun = tun_get(tfile);
2474 void *ptr = m->msg_control;
2482 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
2486 if (flags & MSG_ERRQUEUE) {
2487 ret = sock_recv_errqueue(sock->sk, m, total_len,
2488 SOL_PACKET, TUN_TX_TIMESTAMP);
2491 ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT, ptr);
2492 if (ret > (ssize_t)total_len) {
2493 m->msg_flags |= MSG_TRUNC;
2494 ret = flags & MSG_TRUNC ? ret : total_len;
2507 static int tun_ptr_peek_len(void *ptr)
2510 if (tun_is_xdp_frame(ptr)) {
2511 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2515 return __skb_array_len_with_tag(ptr);
2521 static int tun_peek_len(struct socket *sock)
2523 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2524 struct tun_struct *tun;
2527 tun = tun_get(tfile);
2531 ret = PTR_RING_PEEK_CALL(&tfile->tx_ring, tun_ptr_peek_len);
2537 /* Ops structure to mimic raw sockets with tun */
2538 static const struct proto_ops tun_socket_ops = {
2539 .peek_len = tun_peek_len,
2540 .sendmsg = tun_sendmsg,
2541 .recvmsg = tun_recvmsg,
2544 static struct proto tun_proto = {
2546 .owner = THIS_MODULE,
2547 .obj_size = sizeof(struct tun_file),
2550 static int tun_flags(struct tun_struct *tun)
2552 return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
2555 static ssize_t tun_show_flags(struct device *dev, struct device_attribute *attr,
2558 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2559 return sprintf(buf, "0x%x\n", tun_flags(tun));
2562 static ssize_t tun_show_owner(struct device *dev, struct device_attribute *attr,
2565 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2566 return uid_valid(tun->owner)?
2567 sprintf(buf, "%u\n",
2568 from_kuid_munged(current_user_ns(), tun->owner)):
2569 sprintf(buf, "-1\n");
2572 static ssize_t tun_show_group(struct device *dev, struct device_attribute *attr,
2575 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2576 return gid_valid(tun->group) ?
2577 sprintf(buf, "%u\n",
2578 from_kgid_munged(current_user_ns(), tun->group)):
2579 sprintf(buf, "-1\n");
2582 static DEVICE_ATTR(tun_flags, 0444, tun_show_flags, NULL);
2583 static DEVICE_ATTR(owner, 0444, tun_show_owner, NULL);
2584 static DEVICE_ATTR(group, 0444, tun_show_group, NULL);
2586 static struct attribute *tun_dev_attrs[] = {
2587 &dev_attr_tun_flags.attr,
2588 &dev_attr_owner.attr,
2589 &dev_attr_group.attr,
2593 static const struct attribute_group tun_attr_group = {
2594 .attrs = tun_dev_attrs
2597 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
2599 struct tun_struct *tun;
2600 struct tun_file *tfile = file->private_data;
2601 struct net_device *dev;
2604 if (tfile->detached)
2607 if ((ifr->ifr_flags & IFF_NAPI_FRAGS)) {
2608 if (!capable(CAP_NET_ADMIN))
2611 if (!(ifr->ifr_flags & IFF_NAPI) ||
2612 (ifr->ifr_flags & TUN_TYPE_MASK) != IFF_TAP)
2616 dev = __dev_get_by_name(net, ifr->ifr_name);
2618 if (ifr->ifr_flags & IFF_TUN_EXCL)
2620 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
2621 tun = netdev_priv(dev);
2622 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
2623 tun = netdev_priv(dev);
2627 if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
2628 !!(tun->flags & IFF_MULTI_QUEUE))
2631 if (tun_not_capable(tun))
2633 err = security_tun_dev_open(tun->security);
2637 err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER,
2638 ifr->ifr_flags & IFF_NAPI,
2639 ifr->ifr_flags & IFF_NAPI_FRAGS, true);
2643 if (tun->flags & IFF_MULTI_QUEUE &&
2644 (tun->numqueues + tun->numdisabled > 1)) {
2645 /* One or more queue has already been attached, no need
2646 * to initialize the device again.
2648 netdev_state_change(dev);
2652 tun->flags = (tun->flags & ~TUN_FEATURES) |
2653 (ifr->ifr_flags & TUN_FEATURES);
2655 netdev_state_change(dev);
2658 unsigned long flags = 0;
2659 int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
2662 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
2664 err = security_tun_dev_create();
2669 if (ifr->ifr_flags & IFF_TUN) {
2673 } else if (ifr->ifr_flags & IFF_TAP) {
2681 name = ifr->ifr_name;
2683 dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
2684 NET_NAME_UNKNOWN, tun_setup, queues,
2690 dev_net_set(dev, net);
2691 dev->rtnl_link_ops = &tun_link_ops;
2692 dev->ifindex = tfile->ifindex;
2693 dev->sysfs_groups[0] = &tun_attr_group;
2695 tun = netdev_priv(dev);
2698 tun->txflt.count = 0;
2699 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
2701 tun->align = NET_SKB_PAD;
2702 tun->filter_attached = false;
2703 tun->sndbuf = tfile->socket.sk->sk_sndbuf;
2704 tun->rx_batched = 0;
2705 RCU_INIT_POINTER(tun->steering_prog, NULL);
2707 dev->tstats = netdev_alloc_pcpu_stats(struct pcpu_sw_netstats);
2713 spin_lock_init(&tun->lock);
2715 err = security_tun_dev_alloc_security(&tun->security);
2722 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
2723 TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
2724 NETIF_F_HW_VLAN_STAG_TX;
2725 dev->features = dev->hw_features | NETIF_F_LLTX;
2726 dev->vlan_features = dev->features &
2727 ~(NETIF_F_HW_VLAN_CTAG_TX |
2728 NETIF_F_HW_VLAN_STAG_TX);
2730 tun->flags = (tun->flags & ~TUN_FEATURES) |
2731 (ifr->ifr_flags & TUN_FEATURES);
2733 INIT_LIST_HEAD(&tun->disabled);
2734 err = tun_attach(tun, file, false, ifr->ifr_flags & IFF_NAPI,
2735 ifr->ifr_flags & IFF_NAPI_FRAGS, false);
2739 err = register_netdevice(tun->dev);
2742 /* free_netdev() won't check refcnt, to aovid race
2743 * with dev_put() we need publish tun after registration.
2745 rcu_assign_pointer(tfile->tun, tun);
2748 netif_carrier_on(tun->dev);
2750 /* Make sure persistent devices do not get stuck in
2753 if (netif_running(tun->dev))
2754 netif_tx_wake_all_queues(tun->dev);
2756 strcpy(ifr->ifr_name, tun->dev->name);
2760 tun_detach_all(dev);
2761 /* We are here because register_netdevice() has failed.
2762 * If register_netdevice() already called tun_free_netdev()
2763 * while dealing with the error, dev->stats has been cleared.
2769 tun_flow_uninit(tun);
2770 security_tun_dev_free_security(tun->security);
2772 free_percpu(dev->tstats);
2778 static void tun_get_iff(struct tun_struct *tun, struct ifreq *ifr)
2780 strcpy(ifr->ifr_name, tun->dev->name);
2782 ifr->ifr_flags = tun_flags(tun);
2786 /* This is like a cut-down ethtool ops, except done via tun fd so no
2787 * privs required. */
2788 static int set_offload(struct tun_struct *tun, unsigned long arg)
2790 netdev_features_t features = 0;
2792 if (arg & TUN_F_CSUM) {
2793 features |= NETIF_F_HW_CSUM;
2796 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
2797 if (arg & TUN_F_TSO_ECN) {
2798 features |= NETIF_F_TSO_ECN;
2799 arg &= ~TUN_F_TSO_ECN;
2801 if (arg & TUN_F_TSO4)
2802 features |= NETIF_F_TSO;
2803 if (arg & TUN_F_TSO6)
2804 features |= NETIF_F_TSO6;
2805 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
2811 /* This gives the user a way to test for new features in future by
2812 * trying to set them. */
2816 tun->set_features = features;
2817 tun->dev->wanted_features &= ~TUN_USER_FEATURES;
2818 tun->dev->wanted_features |= features;
2819 netdev_update_features(tun->dev);
2824 static void tun_detach_filter(struct tun_struct *tun, int n)
2827 struct tun_file *tfile;
2829 for (i = 0; i < n; i++) {
2830 tfile = rtnl_dereference(tun->tfiles[i]);
2831 lock_sock(tfile->socket.sk);
2832 sk_detach_filter(tfile->socket.sk);
2833 release_sock(tfile->socket.sk);
2836 tun->filter_attached = false;
2839 static int tun_attach_filter(struct tun_struct *tun)
2842 struct tun_file *tfile;
2844 for (i = 0; i < tun->numqueues; i++) {
2845 tfile = rtnl_dereference(tun->tfiles[i]);
2846 lock_sock(tfile->socket.sk);
2847 ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
2848 release_sock(tfile->socket.sk);
2850 tun_detach_filter(tun, i);
2855 tun->filter_attached = true;
2859 static void tun_set_sndbuf(struct tun_struct *tun)
2861 struct tun_file *tfile;
2864 for (i = 0; i < tun->numqueues; i++) {
2865 tfile = rtnl_dereference(tun->tfiles[i]);
2866 tfile->socket.sk->sk_sndbuf = tun->sndbuf;
2870 static int tun_set_queue(struct file *file, struct ifreq *ifr)
2872 struct tun_file *tfile = file->private_data;
2873 struct tun_struct *tun;
2878 if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
2879 tun = tfile->detached;
2884 ret = security_tun_dev_attach_queue(tun->security);
2887 ret = tun_attach(tun, file, false, tun->flags & IFF_NAPI,
2888 tun->flags & IFF_NAPI_FRAGS, true);
2889 } else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
2890 tun = rtnl_dereference(tfile->tun);
2891 if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
2894 __tun_detach(tfile, false);
2899 netdev_state_change(tun->dev);
2906 static int tun_set_ebpf(struct tun_struct *tun, struct tun_prog __rcu **prog_p,
2909 struct bpf_prog *prog;
2912 if (copy_from_user(&fd, data, sizeof(fd)))
2918 prog = bpf_prog_get_type(fd, BPF_PROG_TYPE_SOCKET_FILTER);
2920 return PTR_ERR(prog);
2923 return __tun_set_ebpf(tun, prog_p, prog);
2926 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
2927 unsigned long arg, int ifreq_len)
2929 struct tun_file *tfile = file->private_data;
2930 struct net *net = sock_net(&tfile->sk);
2931 struct tun_struct *tun;
2932 void __user* argp = (void __user*)arg;
2933 unsigned int ifindex, carrier;
2941 bool do_notify = false;
2943 if (cmd == TUNSETIFF || cmd == TUNSETQUEUE ||
2944 (_IOC_TYPE(cmd) == SOCK_IOC_TYPE && cmd != SIOCGSKNS)) {
2945 if (copy_from_user(&ifr, argp, ifreq_len))
2948 memset(&ifr, 0, sizeof(ifr));
2950 if (cmd == TUNGETFEATURES) {
2951 /* Currently this just means: "what IFF flags are valid?".
2952 * This is needed because we never checked for invalid flags on
2955 return put_user(IFF_TUN | IFF_TAP | TUN_FEATURES,
2956 (unsigned int __user*)argp);
2957 } else if (cmd == TUNSETQUEUE) {
2958 return tun_set_queue(file, &ifr);
2959 } else if (cmd == SIOCGSKNS) {
2960 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
2962 return open_related_ns(&net->ns, get_net_ns);
2968 tun = tun_get(tfile);
2969 if (cmd == TUNSETIFF) {
2974 ifr.ifr_name[IFNAMSIZ-1] = '\0';
2976 ret = tun_set_iff(net, file, &ifr);
2981 if (copy_to_user(argp, &ifr, ifreq_len))
2985 if (cmd == TUNSETIFINDEX) {
2991 if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
2995 tfile->ifindex = ifindex;
3003 netif_info(tun, drv, tun->dev, "tun_chr_ioctl cmd %u\n", cmd);
3005 net = dev_net(tun->dev);
3009 tun_get_iff(tun, &ifr);
3011 if (tfile->detached)
3012 ifr.ifr_flags |= IFF_DETACH_QUEUE;
3013 if (!tfile->socket.sk->sk_filter)
3014 ifr.ifr_flags |= IFF_NOFILTER;
3016 if (copy_to_user(argp, &ifr, ifreq_len))
3021 /* Disable/Enable checksum */
3023 /* [unimplemented] */
3024 netif_info(tun, drv, tun->dev, "ignored: set checksum %s\n",
3025 arg ? "disabled" : "enabled");
3029 /* Disable/Enable persist mode. Keep an extra reference to the
3030 * module to prevent the module being unprobed.
3032 if (arg && !(tun->flags & IFF_PERSIST)) {
3033 tun->flags |= IFF_PERSIST;
3034 __module_get(THIS_MODULE);
3037 if (!arg && (tun->flags & IFF_PERSIST)) {
3038 tun->flags &= ~IFF_PERSIST;
3039 module_put(THIS_MODULE);
3043 netif_info(tun, drv, tun->dev, "persist %s\n",
3044 arg ? "enabled" : "disabled");
3048 /* Set owner of the device */
3049 owner = make_kuid(current_user_ns(), arg);
3050 if (!uid_valid(owner)) {
3056 netif_info(tun, drv, tun->dev, "owner set to %u\n",
3057 from_kuid(&init_user_ns, tun->owner));
3061 /* Set group of the device */
3062 group = make_kgid(current_user_ns(), arg);
3063 if (!gid_valid(group)) {
3069 netif_info(tun, drv, tun->dev, "group set to %u\n",
3070 from_kgid(&init_user_ns, tun->group));
3074 /* Only allow setting the type when the interface is down */
3075 if (tun->dev->flags & IFF_UP) {
3076 netif_info(tun, drv, tun->dev,
3077 "Linktype set failed because interface is up\n");
3080 ret = call_netdevice_notifiers(NETDEV_PRE_TYPE_CHANGE,
3082 ret = notifier_to_errno(ret);
3084 netif_info(tun, drv, tun->dev,
3085 "Refused to change device type\n");
3088 tun->dev->type = (int) arg;
3089 netif_info(tun, drv, tun->dev, "linktype set to %d\n",
3091 call_netdevice_notifiers(NETDEV_POST_TYPE_CHANGE,
3097 tun->msg_enable = (u32)arg;
3101 ret = set_offload(tun, arg);
3104 case TUNSETTXFILTER:
3105 /* Can be set only for TAPs */
3107 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3109 ret = update_filter(&tun->txflt, (void __user *)arg);
3113 /* Get hw address */
3114 memcpy(ifr.ifr_hwaddr.sa_data, tun->dev->dev_addr, ETH_ALEN);
3115 ifr.ifr_hwaddr.sa_family = tun->dev->type;
3116 if (copy_to_user(argp, &ifr, ifreq_len))
3121 /* Set hw address */
3122 ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr, NULL);
3126 sndbuf = tfile->socket.sk->sk_sndbuf;
3127 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
3132 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
3141 tun->sndbuf = sndbuf;
3142 tun_set_sndbuf(tun);
3145 case TUNGETVNETHDRSZ:
3146 vnet_hdr_sz = tun->vnet_hdr_sz;
3147 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
3151 case TUNSETVNETHDRSZ:
3152 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
3156 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
3161 tun->vnet_hdr_sz = vnet_hdr_sz;
3165 le = !!(tun->flags & TUN_VNET_LE);
3166 if (put_user(le, (int __user *)argp))
3171 if (get_user(le, (int __user *)argp)) {
3176 tun->flags |= TUN_VNET_LE;
3178 tun->flags &= ~TUN_VNET_LE;
3182 ret = tun_get_vnet_be(tun, argp);
3186 ret = tun_set_vnet_be(tun, argp);
3189 case TUNATTACHFILTER:
3190 /* Can be set only for TAPs */
3192 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3195 if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
3198 ret = tun_attach_filter(tun);
3201 case TUNDETACHFILTER:
3202 /* Can be set only for TAPs */
3204 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3207 tun_detach_filter(tun, tun->numqueues);
3212 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3215 if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
3220 case TUNSETSTEERINGEBPF:
3221 ret = tun_set_ebpf(tun, &tun->steering_prog, argp);
3224 case TUNSETFILTEREBPF:
3225 ret = tun_set_ebpf(tun, &tun->filter_prog, argp);
3230 if (copy_from_user(&carrier, argp, sizeof(carrier)))
3233 ret = tun_net_change_carrier(tun->dev, (bool)carrier);
3236 case TUNGETDEVNETNS:
3238 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
3240 ret = open_related_ns(&net->ns, get_net_ns);
3249 netdev_state_change(tun->dev);
3258 static long tun_chr_ioctl(struct file *file,
3259 unsigned int cmd, unsigned long arg)
3261 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
3264 #ifdef CONFIG_COMPAT
3265 static long tun_chr_compat_ioctl(struct file *file,
3266 unsigned int cmd, unsigned long arg)
3271 case TUNSETTXFILTER:
3276 arg = (unsigned long)compat_ptr(arg);
3279 arg = (compat_ulong_t)arg;
3284 * compat_ifreq is shorter than ifreq, so we must not access beyond
3285 * the end of that structure. All fields that are used in this
3286 * driver are compatible though, we don't need to convert the
3289 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
3291 #endif /* CONFIG_COMPAT */
3293 static int tun_chr_fasync(int fd, struct file *file, int on)
3295 struct tun_file *tfile = file->private_data;
3298 if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
3302 __f_setown(file, task_pid(current), PIDTYPE_TGID, 0);
3303 tfile->flags |= TUN_FASYNC;
3305 tfile->flags &= ~TUN_FASYNC;
3311 static int tun_chr_open(struct inode *inode, struct file * file)
3313 struct net *net = current->nsproxy->net_ns;
3314 struct tun_file *tfile;
3316 tfile = (struct tun_file *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
3320 if (ptr_ring_init(&tfile->tx_ring, 0, GFP_KERNEL)) {
3321 sk_free(&tfile->sk);
3325 mutex_init(&tfile->napi_mutex);
3326 RCU_INIT_POINTER(tfile->tun, NULL);
3330 init_waitqueue_head(&tfile->socket.wq.wait);
3332 tfile->socket.file = file;
3333 tfile->socket.ops = &tun_socket_ops;
3335 sock_init_data(&tfile->socket, &tfile->sk);
3337 tfile->sk.sk_write_space = tun_sock_write_space;
3338 tfile->sk.sk_sndbuf = INT_MAX;
3340 file->private_data = tfile;
3341 INIT_LIST_HEAD(&tfile->next);
3343 sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
3348 static int tun_chr_close(struct inode *inode, struct file *file)
3350 struct tun_file *tfile = file->private_data;
3352 tun_detach(tfile, true);
3357 #ifdef CONFIG_PROC_FS
3358 static void tun_chr_show_fdinfo(struct seq_file *m, struct file *file)
3360 struct tun_file *tfile = file->private_data;
3361 struct tun_struct *tun;
3364 memset(&ifr, 0, sizeof(ifr));
3367 tun = tun_get(tfile);
3369 tun_get_iff(tun, &ifr);
3375 seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
3379 static const struct file_operations tun_fops = {
3380 .owner = THIS_MODULE,
3381 .llseek = no_llseek,
3382 .read_iter = tun_chr_read_iter,
3383 .write_iter = tun_chr_write_iter,
3384 .poll = tun_chr_poll,
3385 .unlocked_ioctl = tun_chr_ioctl,
3386 #ifdef CONFIG_COMPAT
3387 .compat_ioctl = tun_chr_compat_ioctl,
3389 .open = tun_chr_open,
3390 .release = tun_chr_close,
3391 .fasync = tun_chr_fasync,
3392 #ifdef CONFIG_PROC_FS
3393 .show_fdinfo = tun_chr_show_fdinfo,
3397 static struct miscdevice tun_miscdev = {
3400 .nodename = "net/tun",
3404 /* ethtool interface */
3406 static void tun_default_link_ksettings(struct net_device *dev,
3407 struct ethtool_link_ksettings *cmd)
3409 ethtool_link_ksettings_zero_link_mode(cmd, supported);
3410 ethtool_link_ksettings_zero_link_mode(cmd, advertising);
3411 cmd->base.speed = SPEED_10;
3412 cmd->base.duplex = DUPLEX_FULL;
3413 cmd->base.port = PORT_TP;
3414 cmd->base.phy_address = 0;
3415 cmd->base.autoneg = AUTONEG_DISABLE;
3418 static int tun_get_link_ksettings(struct net_device *dev,
3419 struct ethtool_link_ksettings *cmd)
3421 struct tun_struct *tun = netdev_priv(dev);
3423 memcpy(cmd, &tun->link_ksettings, sizeof(*cmd));
3427 static int tun_set_link_ksettings(struct net_device *dev,
3428 const struct ethtool_link_ksettings *cmd)
3430 struct tun_struct *tun = netdev_priv(dev);
3432 memcpy(&tun->link_ksettings, cmd, sizeof(*cmd));
3436 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
3438 struct tun_struct *tun = netdev_priv(dev);
3440 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
3441 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
3443 switch (tun->flags & TUN_TYPE_MASK) {
3445 strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
3448 strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
3453 static u32 tun_get_msglevel(struct net_device *dev)
3455 struct tun_struct *tun = netdev_priv(dev);
3457 return tun->msg_enable;
3460 static void tun_set_msglevel(struct net_device *dev, u32 value)
3462 struct tun_struct *tun = netdev_priv(dev);
3464 tun->msg_enable = value;
3467 static int tun_get_coalesce(struct net_device *dev,
3468 struct ethtool_coalesce *ec)
3470 struct tun_struct *tun = netdev_priv(dev);
3472 ec->rx_max_coalesced_frames = tun->rx_batched;
3477 static int tun_set_coalesce(struct net_device *dev,
3478 struct ethtool_coalesce *ec)
3480 struct tun_struct *tun = netdev_priv(dev);
3482 if (ec->rx_max_coalesced_frames > NAPI_POLL_WEIGHT)
3483 tun->rx_batched = NAPI_POLL_WEIGHT;
3485 tun->rx_batched = ec->rx_max_coalesced_frames;
3490 static const struct ethtool_ops tun_ethtool_ops = {
3491 .supported_coalesce_params = ETHTOOL_COALESCE_RX_MAX_FRAMES,
3492 .get_drvinfo = tun_get_drvinfo,
3493 .get_msglevel = tun_get_msglevel,
3494 .set_msglevel = tun_set_msglevel,
3495 .get_link = ethtool_op_get_link,
3496 .get_ts_info = ethtool_op_get_ts_info,
3497 .get_coalesce = tun_get_coalesce,
3498 .set_coalesce = tun_set_coalesce,
3499 .get_link_ksettings = tun_get_link_ksettings,
3500 .set_link_ksettings = tun_set_link_ksettings,
3503 static int tun_queue_resize(struct tun_struct *tun)
3505 struct net_device *dev = tun->dev;
3506 struct tun_file *tfile;
3507 struct ptr_ring **rings;
3508 int n = tun->numqueues + tun->numdisabled;
3511 rings = kmalloc_array(n, sizeof(*rings), GFP_KERNEL);
3515 for (i = 0; i < tun->numqueues; i++) {
3516 tfile = rtnl_dereference(tun->tfiles[i]);
3517 rings[i] = &tfile->tx_ring;
3519 list_for_each_entry(tfile, &tun->disabled, next)
3520 rings[i++] = &tfile->tx_ring;
3522 ret = ptr_ring_resize_multiple(rings, n,
3523 dev->tx_queue_len, GFP_KERNEL,
3530 static int tun_device_event(struct notifier_block *unused,
3531 unsigned long event, void *ptr)
3533 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
3534 struct tun_struct *tun = netdev_priv(dev);
3537 if (dev->rtnl_link_ops != &tun_link_ops)
3541 case NETDEV_CHANGE_TX_QUEUE_LEN:
3542 if (tun_queue_resize(tun))
3546 for (i = 0; i < tun->numqueues; i++) {
3547 struct tun_file *tfile;
3549 tfile = rtnl_dereference(tun->tfiles[i]);
3550 tfile->socket.sk->sk_write_space(tfile->socket.sk);
3560 static struct notifier_block tun_notifier_block __read_mostly = {
3561 .notifier_call = tun_device_event,
3564 static int __init tun_init(void)
3568 pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
3570 ret = rtnl_link_register(&tun_link_ops);
3572 pr_err("Can't register link_ops\n");
3576 ret = misc_register(&tun_miscdev);
3578 pr_err("Can't register misc device %d\n", TUN_MINOR);
3582 ret = register_netdevice_notifier(&tun_notifier_block);
3584 pr_err("Can't register netdevice notifier\n");
3591 misc_deregister(&tun_miscdev);
3593 rtnl_link_unregister(&tun_link_ops);
3598 static void tun_cleanup(void)
3600 misc_deregister(&tun_miscdev);
3601 rtnl_link_unregister(&tun_link_ops);
3602 unregister_netdevice_notifier(&tun_notifier_block);
3605 /* Get an underlying socket object from tun file. Returns error unless file is
3606 * attached to a device. The returned object works like a packet socket, it
3607 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
3608 * holding a reference to the file for as long as the socket is in use. */
3609 struct socket *tun_get_socket(struct file *file)
3611 struct tun_file *tfile;
3612 if (file->f_op != &tun_fops)
3613 return ERR_PTR(-EINVAL);
3614 tfile = file->private_data;
3616 return ERR_PTR(-EBADFD);
3617 return &tfile->socket;
3619 EXPORT_SYMBOL_GPL(tun_get_socket);
3621 struct ptr_ring *tun_get_tx_ring(struct file *file)
3623 struct tun_file *tfile;
3625 if (file->f_op != &tun_fops)
3626 return ERR_PTR(-EINVAL);
3627 tfile = file->private_data;
3629 return ERR_PTR(-EBADFD);
3630 return &tfile->tx_ring;
3632 EXPORT_SYMBOL_GPL(tun_get_tx_ring);
3634 module_init(tun_init);
3635 module_exit(tun_cleanup);
3636 MODULE_DESCRIPTION(DRV_DESCRIPTION);
3637 MODULE_AUTHOR(DRV_COPYRIGHT);
3638 MODULE_LICENSE("GPL");
3639 MODULE_ALIAS_MISCDEV(TUN_MINOR);
3640 MODULE_ALIAS("devname:net/tun");