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>
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 /* A tun_file connects an open character device to a tuntap netdevice. It
119 * also contains all socket related structures (except sock_fprog and tap_filter)
120 * to serve as one transmit queue for tuntap device. The sock_fprog and
121 * tap_filter were kept in tun_struct since they were used for filtering for the
122 * netdevice not for a specific queue (at least I didn't see the requirement for
126 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
127 * other can only be read while rcu_read_lock or rtnl_lock is held.
131 struct socket socket;
132 struct tun_struct __rcu *tun;
133 struct fasync_struct *fasync;
134 /* only used for fasnyc */
138 unsigned int ifindex;
140 struct napi_struct napi;
142 bool napi_frags_enabled;
143 struct mutex napi_mutex; /* Protects access to the above napi */
144 struct list_head next;
145 struct tun_struct *detached;
146 struct ptr_ring tx_ring;
147 struct xdp_rxq_info xdp_rxq;
155 struct tun_flow_entry {
156 struct hlist_node hash_link;
158 struct tun_struct *tun;
163 unsigned long updated ____cacheline_aligned_in_smp;
166 #define TUN_NUM_FLOW_ENTRIES 1024
167 #define TUN_MASK_FLOW_ENTRIES (TUN_NUM_FLOW_ENTRIES - 1)
171 struct bpf_prog *prog;
174 /* Since the socket were moved to tun_file, to preserve the behavior of persist
175 * device, socket filter, sndbuf and vnet header size were restore when the
176 * file were attached to a persist device.
179 struct tun_file __rcu *tfiles[MAX_TAP_QUEUES];
180 unsigned int numqueues;
185 struct net_device *dev;
186 netdev_features_t set_features;
187 #define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
193 struct tap_filter txflt;
194 struct sock_fprog fprog;
195 /* protected by rtnl lock */
196 bool filter_attached;
199 struct hlist_head flows[TUN_NUM_FLOW_ENTRIES];
200 struct timer_list flow_gc_timer;
201 unsigned long ageing_time;
202 unsigned int numdisabled;
203 struct list_head disabled;
207 atomic_long_t rx_frame_errors;
208 struct bpf_prog __rcu *xdp_prog;
209 struct tun_prog __rcu *steering_prog;
210 struct tun_prog __rcu *filter_prog;
211 struct ethtool_link_ksettings link_ksettings;
219 static int tun_napi_receive(struct napi_struct *napi, int budget)
221 struct tun_file *tfile = container_of(napi, struct tun_file, napi);
222 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
223 struct sk_buff_head process_queue;
227 __skb_queue_head_init(&process_queue);
229 spin_lock(&queue->lock);
230 skb_queue_splice_tail_init(queue, &process_queue);
231 spin_unlock(&queue->lock);
233 while (received < budget && (skb = __skb_dequeue(&process_queue))) {
234 napi_gro_receive(napi, skb);
238 if (!skb_queue_empty(&process_queue)) {
239 spin_lock(&queue->lock);
240 skb_queue_splice(&process_queue, queue);
241 spin_unlock(&queue->lock);
247 static int tun_napi_poll(struct napi_struct *napi, int budget)
249 unsigned int received;
251 received = tun_napi_receive(napi, budget);
253 if (received < budget)
254 napi_complete_done(napi, received);
259 static void tun_napi_init(struct tun_struct *tun, struct tun_file *tfile,
260 bool napi_en, bool napi_frags)
262 tfile->napi_enabled = napi_en;
263 tfile->napi_frags_enabled = napi_en && napi_frags;
265 netif_tx_napi_add(tun->dev, &tfile->napi, tun_napi_poll,
267 napi_enable(&tfile->napi);
271 static void tun_napi_disable(struct tun_file *tfile)
273 if (tfile->napi_enabled)
274 napi_disable(&tfile->napi);
277 static void tun_napi_del(struct tun_file *tfile)
279 if (tfile->napi_enabled)
280 netif_napi_del(&tfile->napi);
283 static bool tun_napi_frags_enabled(const struct tun_file *tfile)
285 return tfile->napi_frags_enabled;
288 #ifdef CONFIG_TUN_VNET_CROSS_LE
289 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
291 return tun->flags & TUN_VNET_BE ? false :
292 virtio_legacy_is_little_endian();
295 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
297 int be = !!(tun->flags & TUN_VNET_BE);
299 if (put_user(be, argp))
305 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
309 if (get_user(be, argp))
313 tun->flags |= TUN_VNET_BE;
315 tun->flags &= ~TUN_VNET_BE;
320 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
322 return virtio_legacy_is_little_endian();
325 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
330 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
334 #endif /* CONFIG_TUN_VNET_CROSS_LE */
336 static inline bool tun_is_little_endian(struct tun_struct *tun)
338 return tun->flags & TUN_VNET_LE ||
339 tun_legacy_is_little_endian(tun);
342 static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
344 return __virtio16_to_cpu(tun_is_little_endian(tun), val);
347 static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
349 return __cpu_to_virtio16(tun_is_little_endian(tun), val);
352 static inline u32 tun_hashfn(u32 rxhash)
354 return rxhash & TUN_MASK_FLOW_ENTRIES;
357 static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
359 struct tun_flow_entry *e;
361 hlist_for_each_entry_rcu(e, head, hash_link) {
362 if (e->rxhash == rxhash)
368 static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
369 struct hlist_head *head,
370 u32 rxhash, u16 queue_index)
372 struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
375 netif_info(tun, tx_queued, tun->dev,
376 "create flow: hash %u index %u\n",
377 rxhash, queue_index);
378 e->updated = jiffies;
381 e->queue_index = queue_index;
383 hlist_add_head_rcu(&e->hash_link, head);
389 static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
391 netif_info(tun, tx_queued, tun->dev, "delete flow: hash %u index %u\n",
392 e->rxhash, e->queue_index);
393 hlist_del_rcu(&e->hash_link);
398 static void tun_flow_flush(struct tun_struct *tun)
402 spin_lock_bh(&tun->lock);
403 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
404 struct tun_flow_entry *e;
405 struct hlist_node *n;
407 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
408 tun_flow_delete(tun, e);
410 spin_unlock_bh(&tun->lock);
413 static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
417 spin_lock_bh(&tun->lock);
418 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
419 struct tun_flow_entry *e;
420 struct hlist_node *n;
422 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
423 if (e->queue_index == queue_index)
424 tun_flow_delete(tun, e);
427 spin_unlock_bh(&tun->lock);
430 static void tun_flow_cleanup(struct timer_list *t)
432 struct tun_struct *tun = from_timer(tun, t, flow_gc_timer);
433 unsigned long delay = tun->ageing_time;
434 unsigned long next_timer = jiffies + delay;
435 unsigned long count = 0;
438 spin_lock(&tun->lock);
439 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
440 struct tun_flow_entry *e;
441 struct hlist_node *n;
443 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
444 unsigned long this_timer;
446 this_timer = e->updated + delay;
447 if (time_before_eq(this_timer, jiffies)) {
448 tun_flow_delete(tun, e);
452 if (time_before(this_timer, next_timer))
453 next_timer = this_timer;
458 mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
459 spin_unlock(&tun->lock);
462 static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
463 struct tun_file *tfile)
465 struct hlist_head *head;
466 struct tun_flow_entry *e;
467 unsigned long delay = tun->ageing_time;
468 u16 queue_index = tfile->queue_index;
470 head = &tun->flows[tun_hashfn(rxhash)];
474 e = tun_flow_find(head, rxhash);
476 /* TODO: keep queueing to old queue until it's empty? */
477 if (READ_ONCE(e->queue_index) != queue_index)
478 WRITE_ONCE(e->queue_index, queue_index);
479 if (e->updated != jiffies)
480 e->updated = jiffies;
481 sock_rps_record_flow_hash(e->rps_rxhash);
483 spin_lock_bh(&tun->lock);
484 if (!tun_flow_find(head, rxhash) &&
485 tun->flow_count < MAX_TAP_FLOWS)
486 tun_flow_create(tun, head, rxhash, queue_index);
488 if (!timer_pending(&tun->flow_gc_timer))
489 mod_timer(&tun->flow_gc_timer,
490 round_jiffies_up(jiffies + delay));
491 spin_unlock_bh(&tun->lock);
497 /* Save the hash received in the stack receive path and update the
498 * flow_hash table accordingly.
500 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry *e, u32 hash)
502 if (unlikely(e->rps_rxhash != hash))
503 e->rps_rxhash = hash;
506 /* We try to identify a flow through its rxhash. The reason that
507 * we do not check rxq no. is because some cards(e.g 82599), chooses
508 * the rxq based on the txq where the last packet of the flow comes. As
509 * the userspace application move between processors, we may get a
510 * different rxq no. here.
512 static u16 tun_automq_select_queue(struct tun_struct *tun, struct sk_buff *skb)
514 struct tun_flow_entry *e;
518 numqueues = READ_ONCE(tun->numqueues);
520 txq = __skb_get_hash_symmetric(skb);
521 e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
523 tun_flow_save_rps_rxhash(e, txq);
524 txq = e->queue_index;
526 /* use multiply and shift instead of expensive divide */
527 txq = ((u64)txq * numqueues) >> 32;
533 static u16 tun_ebpf_select_queue(struct tun_struct *tun, struct sk_buff *skb)
535 struct tun_prog *prog;
539 numqueues = READ_ONCE(tun->numqueues);
543 prog = rcu_dereference(tun->steering_prog);
545 ret = bpf_prog_run_clear_cb(prog->prog, skb);
547 return ret % numqueues;
550 static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb,
551 struct net_device *sb_dev)
553 struct tun_struct *tun = netdev_priv(dev);
557 if (rcu_dereference(tun->steering_prog))
558 ret = tun_ebpf_select_queue(tun, skb);
560 ret = tun_automq_select_queue(tun, skb);
566 static inline bool tun_not_capable(struct tun_struct *tun)
568 const struct cred *cred = current_cred();
569 struct net *net = dev_net(tun->dev);
571 return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
572 (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
573 !ns_capable(net->user_ns, CAP_NET_ADMIN);
576 static void tun_set_real_num_queues(struct tun_struct *tun)
578 netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
579 netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
582 static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
584 tfile->detached = tun;
585 list_add_tail(&tfile->next, &tun->disabled);
589 static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
591 struct tun_struct *tun = tfile->detached;
593 tfile->detached = NULL;
594 list_del_init(&tfile->next);
599 void tun_ptr_free(void *ptr)
603 if (tun_is_xdp_frame(ptr)) {
604 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
606 xdp_return_frame(xdpf);
608 __skb_array_destroy_skb(ptr);
611 EXPORT_SYMBOL_GPL(tun_ptr_free);
613 static void tun_queue_purge(struct tun_file *tfile)
617 while ((ptr = ptr_ring_consume(&tfile->tx_ring)) != NULL)
620 skb_queue_purge(&tfile->sk.sk_write_queue);
621 skb_queue_purge(&tfile->sk.sk_error_queue);
624 static void __tun_detach(struct tun_file *tfile, bool clean)
626 struct tun_file *ntfile;
627 struct tun_struct *tun;
629 tun = rtnl_dereference(tfile->tun);
632 tun_napi_disable(tfile);
636 if (tun && !tfile->detached) {
637 u16 index = tfile->queue_index;
638 BUG_ON(index >= tun->numqueues);
640 rcu_assign_pointer(tun->tfiles[index],
641 tun->tfiles[tun->numqueues - 1]);
642 ntfile = rtnl_dereference(tun->tfiles[index]);
643 ntfile->queue_index = index;
644 rcu_assign_pointer(tun->tfiles[tun->numqueues - 1],
649 RCU_INIT_POINTER(tfile->tun, NULL);
650 sock_put(&tfile->sk);
652 tun_disable_queue(tun, tfile);
655 tun_flow_delete_by_queue(tun, tun->numqueues + 1);
656 /* Drop read queue */
657 tun_queue_purge(tfile);
658 tun_set_real_num_queues(tun);
659 } else if (tfile->detached && clean) {
660 tun = tun_enable_queue(tfile);
661 sock_put(&tfile->sk);
665 if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
666 netif_carrier_off(tun->dev);
668 if (!(tun->flags & IFF_PERSIST) &&
669 tun->dev->reg_state == NETREG_REGISTERED)
670 unregister_netdevice(tun->dev);
673 xdp_rxq_info_unreg(&tfile->xdp_rxq);
674 ptr_ring_cleanup(&tfile->tx_ring, tun_ptr_free);
675 sock_put(&tfile->sk);
679 static void tun_detach(struct tun_file *tfile, bool clean)
681 struct tun_struct *tun;
682 struct net_device *dev;
685 tun = rtnl_dereference(tfile->tun);
686 dev = tun ? tun->dev : NULL;
687 __tun_detach(tfile, clean);
689 netdev_state_change(dev);
693 static void tun_detach_all(struct net_device *dev)
695 struct tun_struct *tun = netdev_priv(dev);
696 struct tun_file *tfile, *tmp;
697 int i, n = tun->numqueues;
699 for (i = 0; i < n; i++) {
700 tfile = rtnl_dereference(tun->tfiles[i]);
702 tun_napi_disable(tfile);
703 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
704 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
705 RCU_INIT_POINTER(tfile->tun, NULL);
708 list_for_each_entry(tfile, &tun->disabled, next) {
709 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
710 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
711 RCU_INIT_POINTER(tfile->tun, NULL);
713 BUG_ON(tun->numqueues != 0);
716 for (i = 0; i < n; i++) {
717 tfile = rtnl_dereference(tun->tfiles[i]);
719 /* Drop read queue */
720 tun_queue_purge(tfile);
721 xdp_rxq_info_unreg(&tfile->xdp_rxq);
722 sock_put(&tfile->sk);
724 list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
725 tun_enable_queue(tfile);
726 tun_queue_purge(tfile);
727 xdp_rxq_info_unreg(&tfile->xdp_rxq);
728 sock_put(&tfile->sk);
730 BUG_ON(tun->numdisabled != 0);
732 if (tun->flags & IFF_PERSIST)
733 module_put(THIS_MODULE);
736 static int tun_attach(struct tun_struct *tun, struct file *file,
737 bool skip_filter, bool napi, bool napi_frags,
740 struct tun_file *tfile = file->private_data;
741 struct net_device *dev = tun->dev;
744 err = security_tun_dev_attach(tfile->socket.sk, tun->security);
749 if (rtnl_dereference(tfile->tun) && !tfile->detached)
753 if (!(tun->flags & IFF_MULTI_QUEUE) && tun->numqueues == 1)
757 if (!tfile->detached &&
758 tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
763 /* Re-attach the filter to persist device */
764 if (!skip_filter && (tun->filter_attached == true)) {
765 lock_sock(tfile->socket.sk);
766 err = sk_attach_filter(&tun->fprog, tfile->socket.sk);
767 release_sock(tfile->socket.sk);
772 if (!tfile->detached &&
773 ptr_ring_resize(&tfile->tx_ring, dev->tx_queue_len,
774 GFP_KERNEL, tun_ptr_free)) {
779 tfile->queue_index = tun->numqueues;
780 tfile->socket.sk->sk_shutdown &= ~RCV_SHUTDOWN;
782 if (tfile->detached) {
783 /* Re-attach detached tfile, updating XDP queue_index */
784 WARN_ON(!xdp_rxq_info_is_reg(&tfile->xdp_rxq));
786 if (tfile->xdp_rxq.queue_index != tfile->queue_index)
787 tfile->xdp_rxq.queue_index = tfile->queue_index;
789 /* Setup XDP RX-queue info, for new tfile getting attached */
790 err = xdp_rxq_info_reg(&tfile->xdp_rxq,
791 tun->dev, tfile->queue_index, 0);
794 err = xdp_rxq_info_reg_mem_model(&tfile->xdp_rxq,
795 MEM_TYPE_PAGE_SHARED, NULL);
797 xdp_rxq_info_unreg(&tfile->xdp_rxq);
803 if (tfile->detached) {
804 tun_enable_queue(tfile);
806 sock_hold(&tfile->sk);
807 tun_napi_init(tun, tfile, napi, napi_frags);
810 if (rtnl_dereference(tun->xdp_prog))
811 sock_set_flag(&tfile->sk, SOCK_XDP);
813 /* device is allowed to go away first, so no need to hold extra
817 /* Publish tfile->tun and tun->tfiles only after we've fully
818 * initialized tfile; otherwise we risk using half-initialized
822 rcu_assign_pointer(tfile->tun, tun);
823 rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
825 tun_set_real_num_queues(tun);
830 static struct tun_struct *tun_get(struct tun_file *tfile)
832 struct tun_struct *tun;
835 tun = rcu_dereference(tfile->tun);
843 static void tun_put(struct tun_struct *tun)
849 static void addr_hash_set(u32 *mask, const u8 *addr)
851 int n = ether_crc(ETH_ALEN, addr) >> 26;
852 mask[n >> 5] |= (1 << (n & 31));
855 static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
857 int n = ether_crc(ETH_ALEN, addr) >> 26;
858 return mask[n >> 5] & (1 << (n & 31));
861 static int update_filter(struct tap_filter *filter, void __user *arg)
863 struct { u8 u[ETH_ALEN]; } *addr;
864 struct tun_filter uf;
865 int err, alen, n, nexact;
867 if (copy_from_user(&uf, arg, sizeof(uf)))
876 alen = ETH_ALEN * uf.count;
877 addr = memdup_user(arg + sizeof(uf), alen);
879 return PTR_ERR(addr);
881 /* The filter is updated without holding any locks. Which is
882 * perfectly safe. We disable it first and in the worst
883 * case we'll accept a few undesired packets. */
887 /* Use first set of addresses as an exact filter */
888 for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
889 memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
893 /* Remaining multicast addresses are hashed,
894 * unicast will leave the filter disabled. */
895 memset(filter->mask, 0, sizeof(filter->mask));
896 for (; n < uf.count; n++) {
897 if (!is_multicast_ether_addr(addr[n].u)) {
898 err = 0; /* no filter */
901 addr_hash_set(filter->mask, addr[n].u);
904 /* For ALLMULTI just set the mask to all ones.
905 * This overrides the mask populated above. */
906 if ((uf.flags & TUN_FLT_ALLMULTI))
907 memset(filter->mask, ~0, sizeof(filter->mask));
909 /* Now enable the filter */
911 filter->count = nexact;
913 /* Return the number of exact filters */
920 /* Returns: 0 - drop, !=0 - accept */
921 static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
923 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
925 struct ethhdr *eh = (struct ethhdr *) skb->data;
929 for (i = 0; i < filter->count; i++)
930 if (ether_addr_equal(eh->h_dest, filter->addr[i]))
933 /* Inexact match (multicast only) */
934 if (is_multicast_ether_addr(eh->h_dest))
935 return addr_hash_test(filter->mask, eh->h_dest);
941 * Checks whether the packet is accepted or not.
942 * Returns: 0 - drop, !=0 - accept
944 static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
949 return run_filter(filter, skb);
952 /* Network device part of the driver */
954 static const struct ethtool_ops tun_ethtool_ops;
956 /* Net device detach from fd. */
957 static void tun_net_uninit(struct net_device *dev)
962 /* Net device open. */
963 static int tun_net_open(struct net_device *dev)
965 netif_tx_start_all_queues(dev);
970 /* Net device close. */
971 static int tun_net_close(struct net_device *dev)
973 netif_tx_stop_all_queues(dev);
977 /* Net device start xmit */
978 static void tun_automq_xmit(struct tun_struct *tun, struct sk_buff *skb)
981 if (tun->numqueues == 1 && static_branch_unlikely(&rps_needed)) {
982 /* Select queue was not called for the skbuff, so we extract the
983 * RPS hash and save it into the flow_table here.
985 struct tun_flow_entry *e;
988 rxhash = __skb_get_hash_symmetric(skb);
989 e = tun_flow_find(&tun->flows[tun_hashfn(rxhash)], rxhash);
991 tun_flow_save_rps_rxhash(e, rxhash);
996 static unsigned int run_ebpf_filter(struct tun_struct *tun,
1000 struct tun_prog *prog = rcu_dereference(tun->filter_prog);
1003 len = bpf_prog_run_clear_cb(prog->prog, skb);
1008 /* Net device start xmit */
1009 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
1011 struct tun_struct *tun = netdev_priv(dev);
1012 int txq = skb->queue_mapping;
1013 struct tun_file *tfile;
1017 tfile = rcu_dereference(tun->tfiles[txq]);
1019 /* Drop packet if interface is not attached */
1023 if (!rcu_dereference(tun->steering_prog))
1024 tun_automq_xmit(tun, skb);
1026 netif_info(tun, tx_queued, tun->dev, "%s %d\n", __func__, skb->len);
1028 /* Drop if the filter does not like it.
1029 * This is a noop if the filter is disabled.
1030 * Filter can be enabled only for the TAP devices. */
1031 if (!check_filter(&tun->txflt, skb))
1034 if (tfile->socket.sk->sk_filter &&
1035 sk_filter(tfile->socket.sk, skb))
1038 len = run_ebpf_filter(tun, skb, len);
1039 if (len == 0 || pskb_trim(skb, len))
1042 if (unlikely(skb_orphan_frags_rx(skb, GFP_ATOMIC)))
1045 skb_tx_timestamp(skb);
1047 /* Orphan the skb - required as we might hang on to it
1048 * for indefinite time.
1054 if (ptr_ring_produce(&tfile->tx_ring, skb))
1057 /* Notify and wake up reader process */
1058 if (tfile->flags & TUN_FASYNC)
1059 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1060 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1063 return NETDEV_TX_OK;
1066 atomic_long_inc(&dev->tx_dropped);
1070 return NET_XMIT_DROP;
1073 static void tun_net_mclist(struct net_device *dev)
1076 * This callback is supposed to deal with mc filter in
1077 * _rx_ path and has nothing to do with the _tx_ path.
1078 * In rx path we always accept everything userspace gives us.
1082 static netdev_features_t tun_net_fix_features(struct net_device *dev,
1083 netdev_features_t features)
1085 struct tun_struct *tun = netdev_priv(dev);
1087 return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
1090 static void tun_set_headroom(struct net_device *dev, int new_hr)
1092 struct tun_struct *tun = netdev_priv(dev);
1094 if (new_hr < NET_SKB_PAD)
1095 new_hr = NET_SKB_PAD;
1097 tun->align = new_hr;
1101 tun_net_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats)
1103 struct tun_struct *tun = netdev_priv(dev);
1105 dev_get_tstats64(dev, stats);
1107 stats->rx_frame_errors +=
1108 (unsigned long)atomic_long_read(&tun->rx_frame_errors);
1111 static int tun_xdp_set(struct net_device *dev, struct bpf_prog *prog,
1112 struct netlink_ext_ack *extack)
1114 struct tun_struct *tun = netdev_priv(dev);
1115 struct tun_file *tfile;
1116 struct bpf_prog *old_prog;
1119 old_prog = rtnl_dereference(tun->xdp_prog);
1120 rcu_assign_pointer(tun->xdp_prog, prog);
1122 bpf_prog_put(old_prog);
1124 for (i = 0; i < tun->numqueues; i++) {
1125 tfile = rtnl_dereference(tun->tfiles[i]);
1127 sock_set_flag(&tfile->sk, SOCK_XDP);
1129 sock_reset_flag(&tfile->sk, SOCK_XDP);
1131 list_for_each_entry(tfile, &tun->disabled, next) {
1133 sock_set_flag(&tfile->sk, SOCK_XDP);
1135 sock_reset_flag(&tfile->sk, SOCK_XDP);
1141 static int tun_xdp(struct net_device *dev, struct netdev_bpf *xdp)
1143 switch (xdp->command) {
1144 case XDP_SETUP_PROG:
1145 return tun_xdp_set(dev, xdp->prog, xdp->extack);
1151 static int tun_net_change_carrier(struct net_device *dev, bool new_carrier)
1154 struct tun_struct *tun = netdev_priv(dev);
1156 if (!tun->numqueues)
1159 netif_carrier_on(dev);
1161 netif_carrier_off(dev);
1166 static const struct net_device_ops tun_netdev_ops = {
1167 .ndo_uninit = tun_net_uninit,
1168 .ndo_open = tun_net_open,
1169 .ndo_stop = tun_net_close,
1170 .ndo_start_xmit = tun_net_xmit,
1171 .ndo_fix_features = tun_net_fix_features,
1172 .ndo_select_queue = tun_select_queue,
1173 .ndo_set_rx_headroom = tun_set_headroom,
1174 .ndo_get_stats64 = tun_net_get_stats64,
1175 .ndo_change_carrier = tun_net_change_carrier,
1178 static void __tun_xdp_flush_tfile(struct tun_file *tfile)
1180 /* Notify and wake up reader process */
1181 if (tfile->flags & TUN_FASYNC)
1182 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1183 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1186 static int tun_xdp_xmit(struct net_device *dev, int n,
1187 struct xdp_frame **frames, u32 flags)
1189 struct tun_struct *tun = netdev_priv(dev);
1190 struct tun_file *tfile;
1195 if (unlikely(flags & ~XDP_XMIT_FLAGS_MASK))
1201 numqueues = READ_ONCE(tun->numqueues);
1204 return -ENXIO; /* Caller will free/return all frames */
1207 tfile = rcu_dereference(tun->tfiles[smp_processor_id() %
1209 if (unlikely(!tfile))
1212 spin_lock(&tfile->tx_ring.producer_lock);
1213 for (i = 0; i < n; i++) {
1214 struct xdp_frame *xdp = frames[i];
1215 /* Encode the XDP flag into lowest bit for consumer to differ
1216 * XDP buffer from sk_buff.
1218 void *frame = tun_xdp_to_ptr(xdp);
1220 if (__ptr_ring_produce(&tfile->tx_ring, frame)) {
1221 atomic_long_inc(&dev->tx_dropped);
1226 spin_unlock(&tfile->tx_ring.producer_lock);
1228 if (flags & XDP_XMIT_FLUSH)
1229 __tun_xdp_flush_tfile(tfile);
1235 static int tun_xdp_tx(struct net_device *dev, struct xdp_buff *xdp)
1237 struct xdp_frame *frame = xdp_convert_buff_to_frame(xdp);
1240 if (unlikely(!frame))
1243 nxmit = tun_xdp_xmit(dev, 1, &frame, XDP_XMIT_FLUSH);
1245 xdp_return_frame_rx_napi(frame);
1249 static const struct net_device_ops tap_netdev_ops = {
1250 .ndo_uninit = tun_net_uninit,
1251 .ndo_open = tun_net_open,
1252 .ndo_stop = tun_net_close,
1253 .ndo_start_xmit = tun_net_xmit,
1254 .ndo_fix_features = tun_net_fix_features,
1255 .ndo_set_rx_mode = tun_net_mclist,
1256 .ndo_set_mac_address = eth_mac_addr,
1257 .ndo_validate_addr = eth_validate_addr,
1258 .ndo_select_queue = tun_select_queue,
1259 .ndo_features_check = passthru_features_check,
1260 .ndo_set_rx_headroom = tun_set_headroom,
1261 .ndo_get_stats64 = dev_get_tstats64,
1263 .ndo_xdp_xmit = tun_xdp_xmit,
1264 .ndo_change_carrier = tun_net_change_carrier,
1267 static void tun_flow_init(struct tun_struct *tun)
1271 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
1272 INIT_HLIST_HEAD(&tun->flows[i]);
1274 tun->ageing_time = TUN_FLOW_EXPIRE;
1275 timer_setup(&tun->flow_gc_timer, tun_flow_cleanup, 0);
1276 mod_timer(&tun->flow_gc_timer,
1277 round_jiffies_up(jiffies + tun->ageing_time));
1280 static void tun_flow_uninit(struct tun_struct *tun)
1282 del_timer_sync(&tun->flow_gc_timer);
1283 tun_flow_flush(tun);
1287 #define MAX_MTU 65535
1289 /* Initialize net device. */
1290 static void tun_net_init(struct net_device *dev)
1292 struct tun_struct *tun = netdev_priv(dev);
1294 switch (tun->flags & TUN_TYPE_MASK) {
1296 dev->netdev_ops = &tun_netdev_ops;
1297 dev->header_ops = &ip_tunnel_header_ops;
1299 /* Point-to-Point TUN Device */
1300 dev->hard_header_len = 0;
1304 /* Zero header length */
1305 dev->type = ARPHRD_NONE;
1306 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
1310 dev->netdev_ops = &tap_netdev_ops;
1311 /* Ethernet TAP Device */
1313 dev->priv_flags &= ~IFF_TX_SKB_SHARING;
1314 dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
1316 eth_hw_addr_random(dev);
1321 dev->min_mtu = MIN_MTU;
1322 dev->max_mtu = MAX_MTU - dev->hard_header_len;
1325 static bool tun_sock_writeable(struct tun_struct *tun, struct tun_file *tfile)
1327 struct sock *sk = tfile->socket.sk;
1329 return (tun->dev->flags & IFF_UP) && sock_writeable(sk);
1332 /* Character device part */
1335 static __poll_t tun_chr_poll(struct file *file, poll_table *wait)
1337 struct tun_file *tfile = file->private_data;
1338 struct tun_struct *tun = tun_get(tfile);
1345 sk = tfile->socket.sk;
1347 poll_wait(file, sk_sleep(sk), wait);
1349 if (!ptr_ring_empty(&tfile->tx_ring))
1350 mask |= EPOLLIN | EPOLLRDNORM;
1352 /* Make sure SOCKWQ_ASYNC_NOSPACE is set if not writable to
1353 * guarantee EPOLLOUT to be raised by either here or
1354 * tun_sock_write_space(). Then process could get notification
1355 * after it writes to a down device and meets -EIO.
1357 if (tun_sock_writeable(tun, tfile) ||
1358 (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
1359 tun_sock_writeable(tun, tfile)))
1360 mask |= EPOLLOUT | EPOLLWRNORM;
1362 if (tun->dev->reg_state != NETREG_REGISTERED)
1369 static struct sk_buff *tun_napi_alloc_frags(struct tun_file *tfile,
1371 const struct iov_iter *it)
1373 struct sk_buff *skb;
1378 if (it->nr_segs > MAX_SKB_FRAGS + 1)
1379 return ERR_PTR(-EMSGSIZE);
1382 skb = napi_get_frags(&tfile->napi);
1385 return ERR_PTR(-ENOMEM);
1387 linear = iov_iter_single_seg_count(it);
1388 err = __skb_grow(skb, linear);
1393 skb->data_len = len - linear;
1394 skb->truesize += skb->data_len;
1396 for (i = 1; i < it->nr_segs; i++) {
1397 size_t fragsz = it->iov[i].iov_len;
1401 if (fragsz == 0 || fragsz > PAGE_SIZE) {
1405 frag = netdev_alloc_frag(fragsz);
1410 page = virt_to_head_page(frag);
1411 skb_fill_page_desc(skb, i - 1, page,
1412 frag - page_address(page), fragsz);
1417 /* frees skb and all frags allocated with napi_alloc_frag() */
1418 napi_free_frags(&tfile->napi);
1419 return ERR_PTR(err);
1422 /* prepad is the amount to reserve at front. len is length after that.
1423 * linear is a hint as to how much to copy (usually headers). */
1424 static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
1425 size_t prepad, size_t len,
1426 size_t linear, int noblock)
1428 struct sock *sk = tfile->socket.sk;
1429 struct sk_buff *skb;
1432 /* Under a page? Don't bother with paged skb. */
1433 if (prepad + len < PAGE_SIZE || !linear)
1436 skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
1439 return ERR_PTR(err);
1441 skb_reserve(skb, prepad);
1442 skb_put(skb, linear);
1443 skb->data_len = len - linear;
1444 skb->len += len - linear;
1449 static void tun_rx_batched(struct tun_struct *tun, struct tun_file *tfile,
1450 struct sk_buff *skb, int more)
1452 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1453 struct sk_buff_head process_queue;
1454 u32 rx_batched = tun->rx_batched;
1457 if (!rx_batched || (!more && skb_queue_empty(queue))) {
1459 skb_record_rx_queue(skb, tfile->queue_index);
1460 netif_receive_skb(skb);
1465 spin_lock(&queue->lock);
1466 if (!more || skb_queue_len(queue) == rx_batched) {
1467 __skb_queue_head_init(&process_queue);
1468 skb_queue_splice_tail_init(queue, &process_queue);
1471 __skb_queue_tail(queue, skb);
1473 spin_unlock(&queue->lock);
1476 struct sk_buff *nskb;
1479 while ((nskb = __skb_dequeue(&process_queue))) {
1480 skb_record_rx_queue(nskb, tfile->queue_index);
1481 netif_receive_skb(nskb);
1483 skb_record_rx_queue(skb, tfile->queue_index);
1484 netif_receive_skb(skb);
1489 static bool tun_can_build_skb(struct tun_struct *tun, struct tun_file *tfile,
1490 int len, int noblock, bool zerocopy)
1492 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
1495 if (tfile->socket.sk->sk_sndbuf != INT_MAX)
1504 if (SKB_DATA_ALIGN(len + TUN_RX_PAD) +
1505 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
1511 static struct sk_buff *__tun_build_skb(struct tun_file *tfile,
1512 struct page_frag *alloc_frag, char *buf,
1513 int buflen, int len, int pad)
1515 struct sk_buff *skb = build_skb(buf, buflen);
1518 return ERR_PTR(-ENOMEM);
1520 skb_reserve(skb, pad);
1522 skb_set_owner_w(skb, tfile->socket.sk);
1524 get_page(alloc_frag->page);
1525 alloc_frag->offset += buflen;
1530 static int tun_xdp_act(struct tun_struct *tun, struct bpf_prog *xdp_prog,
1531 struct xdp_buff *xdp, u32 act)
1537 err = xdp_do_redirect(tun->dev, xdp, xdp_prog);
1542 err = tun_xdp_tx(tun->dev, xdp);
1549 bpf_warn_invalid_xdp_action(act);
1552 trace_xdp_exception(tun->dev, xdp_prog, act);
1555 atomic_long_inc(&tun->dev->rx_dropped);
1562 static struct sk_buff *tun_build_skb(struct tun_struct *tun,
1563 struct tun_file *tfile,
1564 struct iov_iter *from,
1565 struct virtio_net_hdr *hdr,
1566 int len, int *skb_xdp)
1568 struct page_frag *alloc_frag = ¤t->task_frag;
1569 struct bpf_prog *xdp_prog;
1570 int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
1573 int pad = TUN_RX_PAD;
1577 xdp_prog = rcu_dereference(tun->xdp_prog);
1579 pad += XDP_PACKET_HEADROOM;
1580 buflen += SKB_DATA_ALIGN(len + pad);
1583 alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
1584 if (unlikely(!skb_page_frag_refill(buflen, alloc_frag, GFP_KERNEL)))
1585 return ERR_PTR(-ENOMEM);
1587 buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
1588 copied = copy_page_from_iter(alloc_frag->page,
1589 alloc_frag->offset + pad,
1592 return ERR_PTR(-EFAULT);
1594 /* There's a small window that XDP may be set after the check
1595 * of xdp_prog above, this should be rare and for simplicity
1596 * we do XDP on skb in case the headroom is not enough.
1598 if (hdr->gso_type || !xdp_prog) {
1600 return __tun_build_skb(tfile, alloc_frag, buf, buflen, len,
1608 xdp_prog = rcu_dereference(tun->xdp_prog);
1610 struct xdp_buff xdp;
1613 xdp_init_buff(&xdp, buflen, &tfile->xdp_rxq);
1614 xdp_prepare_buff(&xdp, buf, pad, len, false);
1616 act = bpf_prog_run_xdp(xdp_prog, &xdp);
1617 if (act == XDP_REDIRECT || act == XDP_TX) {
1618 get_page(alloc_frag->page);
1619 alloc_frag->offset += buflen;
1621 err = tun_xdp_act(tun, xdp_prog, &xdp, act);
1623 if (act == XDP_REDIRECT || act == XDP_TX)
1624 put_page(alloc_frag->page);
1628 if (err == XDP_REDIRECT)
1630 if (err != XDP_PASS)
1633 pad = xdp.data - xdp.data_hard_start;
1634 len = xdp.data_end - xdp.data;
1639 return __tun_build_skb(tfile, alloc_frag, buf, buflen, len, pad);
1647 /* Get packet from user space buffer */
1648 static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
1649 void *msg_control, struct iov_iter *from,
1650 int noblock, bool more)
1652 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1653 struct sk_buff *skb;
1654 size_t total_len = iov_iter_count(from);
1655 size_t len = total_len, align = tun->align, linear;
1656 struct virtio_net_hdr gso = { 0 };
1659 bool zerocopy = false;
1663 bool frags = tun_napi_frags_enabled(tfile);
1665 if (!(tun->flags & IFF_NO_PI)) {
1666 if (len < sizeof(pi))
1670 if (!copy_from_iter_full(&pi, sizeof(pi), from))
1674 if (tun->flags & IFF_VNET_HDR) {
1675 int vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1677 if (len < vnet_hdr_sz)
1681 if (!copy_from_iter_full(&gso, sizeof(gso), from))
1684 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
1685 tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1686 gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
1688 if (tun16_to_cpu(tun, gso.hdr_len) > len)
1690 iov_iter_advance(from, vnet_hdr_sz - sizeof(gso));
1693 if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
1694 align += NET_IP_ALIGN;
1695 if (unlikely(len < ETH_HLEN ||
1696 (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
1700 good_linear = SKB_MAX_HEAD(align);
1703 struct iov_iter i = *from;
1705 /* There are 256 bytes to be copied in skb, so there is
1706 * enough room for skb expand head in case it is used.
1707 * The rest of the buffer is mapped from userspace.
1709 copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
1710 if (copylen > good_linear)
1711 copylen = good_linear;
1713 iov_iter_advance(&i, copylen);
1714 if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
1718 if (!frags && tun_can_build_skb(tun, tfile, len, noblock, zerocopy)) {
1719 /* For the packet that is not easy to be processed
1720 * (e.g gso or jumbo packet), we will do it at after
1721 * skb was created with generic XDP routine.
1723 skb = tun_build_skb(tun, tfile, from, &gso, len, &skb_xdp);
1725 atomic_long_inc(&tun->dev->rx_dropped);
1726 return PTR_ERR(skb);
1733 if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1734 linear = good_linear;
1736 linear = tun16_to_cpu(tun, gso.hdr_len);
1740 mutex_lock(&tfile->napi_mutex);
1741 skb = tun_napi_alloc_frags(tfile, copylen, from);
1742 /* tun_napi_alloc_frags() enforces a layout for the skb.
1743 * If zerocopy is enabled, then this layout will be
1744 * overwritten by zerocopy_sg_from_iter().
1748 skb = tun_alloc_skb(tfile, align, copylen, linear,
1753 if (PTR_ERR(skb) != -EAGAIN)
1754 atomic_long_inc(&tun->dev->rx_dropped);
1756 mutex_unlock(&tfile->napi_mutex);
1757 return PTR_ERR(skb);
1761 err = zerocopy_sg_from_iter(skb, from);
1763 err = skb_copy_datagram_from_iter(skb, 0, from, len);
1768 atomic_long_inc(&tun->dev->rx_dropped);
1771 tfile->napi.skb = NULL;
1772 mutex_unlock(&tfile->napi_mutex);
1779 if (virtio_net_hdr_to_skb(skb, &gso, tun_is_little_endian(tun))) {
1780 atomic_long_inc(&tun->rx_frame_errors);
1783 tfile->napi.skb = NULL;
1784 mutex_unlock(&tfile->napi_mutex);
1790 switch (tun->flags & TUN_TYPE_MASK) {
1792 if (tun->flags & IFF_NO_PI) {
1793 u8 ip_version = skb->len ? (skb->data[0] >> 4) : 0;
1795 switch (ip_version) {
1797 pi.proto = htons(ETH_P_IP);
1800 pi.proto = htons(ETH_P_IPV6);
1803 atomic_long_inc(&tun->dev->rx_dropped);
1809 skb_reset_mac_header(skb);
1810 skb->protocol = pi.proto;
1811 skb->dev = tun->dev;
1814 if (frags && !pskb_may_pull(skb, ETH_HLEN)) {
1818 skb->protocol = eth_type_trans(skb, tun->dev);
1822 /* copy skb_ubuf_info for callback when skb has no error */
1824 skb_zcopy_init(skb, msg_control);
1825 } else if (msg_control) {
1826 struct ubuf_info *uarg = msg_control;
1827 uarg->callback(NULL, uarg, false);
1830 skb_reset_network_header(skb);
1831 skb_probe_transport_header(skb);
1832 skb_record_rx_queue(skb, tfile->queue_index);
1835 struct bpf_prog *xdp_prog;
1840 xdp_prog = rcu_dereference(tun->xdp_prog);
1842 ret = do_xdp_generic(xdp_prog, skb);
1843 if (ret != XDP_PASS) {
1847 tfile->napi.skb = NULL;
1848 mutex_unlock(&tfile->napi_mutex);
1857 /* Compute the costly rx hash only if needed for flow updates.
1858 * We may get a very small possibility of OOO during switching, not
1859 * worth to optimize.
1861 if (!rcu_access_pointer(tun->steering_prog) && tun->numqueues > 1 &&
1863 rxhash = __skb_get_hash_symmetric(skb);
1866 if (unlikely(!(tun->dev->flags & IFF_UP))) {
1875 /* Exercise flow dissector code path. */
1876 skb_push(skb, ETH_HLEN);
1877 headlen = eth_get_headlen(tun->dev, skb->data,
1880 if (unlikely(headlen > skb_headlen(skb))) {
1881 atomic_long_inc(&tun->dev->rx_dropped);
1882 napi_free_frags(&tfile->napi);
1884 mutex_unlock(&tfile->napi_mutex);
1890 napi_gro_frags(&tfile->napi);
1892 mutex_unlock(&tfile->napi_mutex);
1893 } else if (tfile->napi_enabled) {
1894 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1897 spin_lock_bh(&queue->lock);
1898 __skb_queue_tail(queue, skb);
1899 queue_len = skb_queue_len(queue);
1900 spin_unlock(&queue->lock);
1902 if (!more || queue_len > NAPI_POLL_WEIGHT)
1903 napi_schedule(&tfile->napi);
1906 } else if (!IS_ENABLED(CONFIG_4KSTACKS)) {
1907 tun_rx_batched(tun, tfile, skb, more);
1914 dev_sw_netstats_rx_add(tun->dev, len);
1918 tun_flow_update(tun, rxhash, tfile);
1923 static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
1925 struct file *file = iocb->ki_filp;
1926 struct tun_file *tfile = file->private_data;
1927 struct tun_struct *tun = tun_get(tfile);
1934 if ((file->f_flags & O_NONBLOCK) || (iocb->ki_flags & IOCB_NOWAIT))
1937 result = tun_get_user(tun, tfile, NULL, from, noblock, false);
1943 static ssize_t tun_put_user_xdp(struct tun_struct *tun,
1944 struct tun_file *tfile,
1945 struct xdp_frame *xdp_frame,
1946 struct iov_iter *iter)
1948 int vnet_hdr_sz = 0;
1949 size_t size = xdp_frame->len;
1952 if (tun->flags & IFF_VNET_HDR) {
1953 struct virtio_net_hdr gso = { 0 };
1955 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1956 if (unlikely(iov_iter_count(iter) < vnet_hdr_sz))
1958 if (unlikely(copy_to_iter(&gso, sizeof(gso), iter) !=
1961 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
1964 ret = copy_to_iter(xdp_frame->data, size, iter) + vnet_hdr_sz;
1967 dev_sw_netstats_tx_add(tun->dev, 1, ret);
1973 /* Put packet to the user space buffer */
1974 static ssize_t tun_put_user(struct tun_struct *tun,
1975 struct tun_file *tfile,
1976 struct sk_buff *skb,
1977 struct iov_iter *iter)
1979 struct tun_pi pi = { 0, skb->protocol };
1981 int vlan_offset = 0;
1983 int vnet_hdr_sz = 0;
1985 if (skb_vlan_tag_present(skb))
1986 vlan_hlen = VLAN_HLEN;
1988 if (tun->flags & IFF_VNET_HDR)
1989 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1991 total = skb->len + vlan_hlen + vnet_hdr_sz;
1993 if (!(tun->flags & IFF_NO_PI)) {
1994 if (iov_iter_count(iter) < sizeof(pi))
1997 total += sizeof(pi);
1998 if (iov_iter_count(iter) < total) {
1999 /* Packet will be striped */
2000 pi.flags |= TUN_PKT_STRIP;
2003 if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
2008 struct virtio_net_hdr gso;
2010 if (iov_iter_count(iter) < vnet_hdr_sz)
2013 if (virtio_net_hdr_from_skb(skb, &gso,
2014 tun_is_little_endian(tun), true,
2016 struct skb_shared_info *sinfo = skb_shinfo(skb);
2017 pr_err("unexpected GSO type: "
2018 "0x%x, gso_size %d, hdr_len %d\n",
2019 sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
2020 tun16_to_cpu(tun, gso.hdr_len));
2021 print_hex_dump(KERN_ERR, "tun: ",
2024 min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
2029 if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
2032 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2039 veth.h_vlan_proto = skb->vlan_proto;
2040 veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
2042 vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
2044 ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
2045 if (ret || !iov_iter_count(iter))
2048 ret = copy_to_iter(&veth, sizeof(veth), iter);
2049 if (ret != sizeof(veth) || !iov_iter_count(iter))
2053 skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
2056 /* caller is in process context, */
2058 dev_sw_netstats_tx_add(tun->dev, 1, skb->len + vlan_hlen);
2064 static void *tun_ring_recv(struct tun_file *tfile, int noblock, int *err)
2066 DECLARE_WAITQUEUE(wait, current);
2070 ptr = ptr_ring_consume(&tfile->tx_ring);
2078 add_wait_queue(&tfile->socket.wq.wait, &wait);
2081 set_current_state(TASK_INTERRUPTIBLE);
2082 ptr = ptr_ring_consume(&tfile->tx_ring);
2085 if (signal_pending(current)) {
2086 error = -ERESTARTSYS;
2089 if (tfile->socket.sk->sk_shutdown & RCV_SHUTDOWN) {
2097 __set_current_state(TASK_RUNNING);
2098 remove_wait_queue(&tfile->socket.wq.wait, &wait);
2105 static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
2106 struct iov_iter *to,
2107 int noblock, void *ptr)
2112 if (!iov_iter_count(to)) {
2118 /* Read frames from ring */
2119 ptr = tun_ring_recv(tfile, noblock, &err);
2124 if (tun_is_xdp_frame(ptr)) {
2125 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2127 ret = tun_put_user_xdp(tun, tfile, xdpf, to);
2128 xdp_return_frame(xdpf);
2130 struct sk_buff *skb = ptr;
2132 ret = tun_put_user(tun, tfile, skb, to);
2133 if (unlikely(ret < 0))
2142 static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
2144 struct file *file = iocb->ki_filp;
2145 struct tun_file *tfile = file->private_data;
2146 struct tun_struct *tun = tun_get(tfile);
2147 ssize_t len = iov_iter_count(to), ret;
2153 if ((file->f_flags & O_NONBLOCK) || (iocb->ki_flags & IOCB_NOWAIT))
2156 ret = tun_do_read(tun, tfile, to, noblock, NULL);
2157 ret = min_t(ssize_t, ret, len);
2164 static void tun_prog_free(struct rcu_head *rcu)
2166 struct tun_prog *prog = container_of(rcu, struct tun_prog, rcu);
2168 bpf_prog_destroy(prog->prog);
2172 static int __tun_set_ebpf(struct tun_struct *tun,
2173 struct tun_prog __rcu **prog_p,
2174 struct bpf_prog *prog)
2176 struct tun_prog *old, *new = NULL;
2179 new = kmalloc(sizeof(*new), GFP_KERNEL);
2185 spin_lock_bh(&tun->lock);
2186 old = rcu_dereference_protected(*prog_p,
2187 lockdep_is_held(&tun->lock));
2188 rcu_assign_pointer(*prog_p, new);
2189 spin_unlock_bh(&tun->lock);
2192 call_rcu(&old->rcu, tun_prog_free);
2197 static void tun_free_netdev(struct net_device *dev)
2199 struct tun_struct *tun = netdev_priv(dev);
2201 BUG_ON(!(list_empty(&tun->disabled)));
2203 free_percpu(dev->tstats);
2204 /* We clear tstats so that tun_set_iff() can tell if
2205 * tun_free_netdev() has been called from register_netdevice().
2209 tun_flow_uninit(tun);
2210 security_tun_dev_free_security(tun->security);
2211 __tun_set_ebpf(tun, &tun->steering_prog, NULL);
2212 __tun_set_ebpf(tun, &tun->filter_prog, NULL);
2215 static void tun_setup(struct net_device *dev)
2217 struct tun_struct *tun = netdev_priv(dev);
2219 tun->owner = INVALID_UID;
2220 tun->group = INVALID_GID;
2221 tun_default_link_ksettings(dev, &tun->link_ksettings);
2223 dev->ethtool_ops = &tun_ethtool_ops;
2224 dev->needs_free_netdev = true;
2225 dev->priv_destructor = tun_free_netdev;
2226 /* We prefer our own queue length */
2227 dev->tx_queue_len = TUN_READQ_SIZE;
2230 /* Trivial set of netlink ops to allow deleting tun or tap
2231 * device with netlink.
2233 static int tun_validate(struct nlattr *tb[], struct nlattr *data[],
2234 struct netlink_ext_ack *extack)
2236 NL_SET_ERR_MSG(extack,
2237 "tun/tap creation via rtnetlink is not supported.");
2241 static size_t tun_get_size(const struct net_device *dev)
2243 BUILD_BUG_ON(sizeof(u32) != sizeof(uid_t));
2244 BUILD_BUG_ON(sizeof(u32) != sizeof(gid_t));
2246 return nla_total_size(sizeof(uid_t)) + /* OWNER */
2247 nla_total_size(sizeof(gid_t)) + /* GROUP */
2248 nla_total_size(sizeof(u8)) + /* TYPE */
2249 nla_total_size(sizeof(u8)) + /* PI */
2250 nla_total_size(sizeof(u8)) + /* VNET_HDR */
2251 nla_total_size(sizeof(u8)) + /* PERSIST */
2252 nla_total_size(sizeof(u8)) + /* MULTI_QUEUE */
2253 nla_total_size(sizeof(u32)) + /* NUM_QUEUES */
2254 nla_total_size(sizeof(u32)) + /* NUM_DISABLED_QUEUES */
2258 static int tun_fill_info(struct sk_buff *skb, const struct net_device *dev)
2260 struct tun_struct *tun = netdev_priv(dev);
2262 if (nla_put_u8(skb, IFLA_TUN_TYPE, tun->flags & TUN_TYPE_MASK))
2263 goto nla_put_failure;
2264 if (uid_valid(tun->owner) &&
2265 nla_put_u32(skb, IFLA_TUN_OWNER,
2266 from_kuid_munged(current_user_ns(), tun->owner)))
2267 goto nla_put_failure;
2268 if (gid_valid(tun->group) &&
2269 nla_put_u32(skb, IFLA_TUN_GROUP,
2270 from_kgid_munged(current_user_ns(), tun->group)))
2271 goto nla_put_failure;
2272 if (nla_put_u8(skb, IFLA_TUN_PI, !(tun->flags & IFF_NO_PI)))
2273 goto nla_put_failure;
2274 if (nla_put_u8(skb, IFLA_TUN_VNET_HDR, !!(tun->flags & IFF_VNET_HDR)))
2275 goto nla_put_failure;
2276 if (nla_put_u8(skb, IFLA_TUN_PERSIST, !!(tun->flags & IFF_PERSIST)))
2277 goto nla_put_failure;
2278 if (nla_put_u8(skb, IFLA_TUN_MULTI_QUEUE,
2279 !!(tun->flags & IFF_MULTI_QUEUE)))
2280 goto nla_put_failure;
2281 if (tun->flags & IFF_MULTI_QUEUE) {
2282 if (nla_put_u32(skb, IFLA_TUN_NUM_QUEUES, tun->numqueues))
2283 goto nla_put_failure;
2284 if (nla_put_u32(skb, IFLA_TUN_NUM_DISABLED_QUEUES,
2286 goto nla_put_failure;
2295 static struct rtnl_link_ops tun_link_ops __read_mostly = {
2297 .priv_size = sizeof(struct tun_struct),
2299 .validate = tun_validate,
2300 .get_size = tun_get_size,
2301 .fill_info = tun_fill_info,
2304 static void tun_sock_write_space(struct sock *sk)
2306 struct tun_file *tfile;
2307 wait_queue_head_t *wqueue;
2309 if (!sock_writeable(sk))
2312 if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
2315 wqueue = sk_sleep(sk);
2316 if (wqueue && waitqueue_active(wqueue))
2317 wake_up_interruptible_sync_poll(wqueue, EPOLLOUT |
2318 EPOLLWRNORM | EPOLLWRBAND);
2320 tfile = container_of(sk, struct tun_file, sk);
2321 kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
2324 static void tun_put_page(struct tun_page *tpage)
2327 __page_frag_cache_drain(tpage->page, tpage->count);
2330 static int tun_xdp_one(struct tun_struct *tun,
2331 struct tun_file *tfile,
2332 struct xdp_buff *xdp, int *flush,
2333 struct tun_page *tpage)
2335 unsigned int datasize = xdp->data_end - xdp->data;
2336 struct tun_xdp_hdr *hdr = xdp->data_hard_start;
2337 struct virtio_net_hdr *gso = &hdr->gso;
2338 struct bpf_prog *xdp_prog;
2339 struct sk_buff *skb = NULL;
2340 u32 rxhash = 0, act;
2341 int buflen = hdr->buflen;
2343 bool skb_xdp = false;
2346 xdp_prog = rcu_dereference(tun->xdp_prog);
2348 if (gso->gso_type) {
2353 xdp_init_buff(xdp, buflen, &tfile->xdp_rxq);
2354 xdp_set_data_meta_invalid(xdp);
2356 act = bpf_prog_run_xdp(xdp_prog, xdp);
2357 err = tun_xdp_act(tun, xdp_prog, xdp, act);
2359 put_page(virt_to_head_page(xdp->data));
2372 page = virt_to_head_page(xdp->data);
2373 if (tpage->page == page) {
2376 tun_put_page(tpage);
2385 skb = build_skb(xdp->data_hard_start, buflen);
2391 skb_reserve(skb, xdp->data - xdp->data_hard_start);
2392 skb_put(skb, xdp->data_end - xdp->data);
2394 if (virtio_net_hdr_to_skb(skb, gso, tun_is_little_endian(tun))) {
2395 atomic_long_inc(&tun->rx_frame_errors);
2401 skb->protocol = eth_type_trans(skb, tun->dev);
2402 skb_reset_network_header(skb);
2403 skb_probe_transport_header(skb);
2404 skb_record_rx_queue(skb, tfile->queue_index);
2407 err = do_xdp_generic(xdp_prog, skb);
2408 if (err != XDP_PASS)
2412 if (!rcu_dereference(tun->steering_prog) && tun->numqueues > 1 &&
2414 rxhash = __skb_get_hash_symmetric(skb);
2416 netif_receive_skb(skb);
2418 /* No need to disable preemption here since this function is
2419 * always called with bh disabled
2421 dev_sw_netstats_rx_add(tun->dev, datasize);
2424 tun_flow_update(tun, rxhash, tfile);
2430 static int tun_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
2433 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2434 struct tun_struct *tun = tun_get(tfile);
2435 struct tun_msg_ctl *ctl = m->msg_control;
2436 struct xdp_buff *xdp;
2441 if (ctl && (ctl->type == TUN_MSG_PTR)) {
2442 struct tun_page tpage;
2446 memset(&tpage, 0, sizeof(tpage));
2451 for (i = 0; i < n; i++) {
2452 xdp = &((struct xdp_buff *)ctl->ptr)[i];
2453 tun_xdp_one(tun, tfile, xdp, &flush, &tpage);
2462 tun_put_page(&tpage);
2468 ret = tun_get_user(tun, tfile, ctl ? ctl->ptr : NULL, &m->msg_iter,
2469 m->msg_flags & MSG_DONTWAIT,
2470 m->msg_flags & MSG_MORE);
2476 static int tun_recvmsg(struct socket *sock, struct msghdr *m, size_t total_len,
2479 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2480 struct tun_struct *tun = tun_get(tfile);
2481 void *ptr = m->msg_control;
2489 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
2493 if (flags & MSG_ERRQUEUE) {
2494 ret = sock_recv_errqueue(sock->sk, m, total_len,
2495 SOL_PACKET, TUN_TX_TIMESTAMP);
2498 ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT, ptr);
2499 if (ret > (ssize_t)total_len) {
2500 m->msg_flags |= MSG_TRUNC;
2501 ret = flags & MSG_TRUNC ? ret : total_len;
2514 static int tun_ptr_peek_len(void *ptr)
2517 if (tun_is_xdp_frame(ptr)) {
2518 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2522 return __skb_array_len_with_tag(ptr);
2528 static int tun_peek_len(struct socket *sock)
2530 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2531 struct tun_struct *tun;
2534 tun = tun_get(tfile);
2538 ret = PTR_RING_PEEK_CALL(&tfile->tx_ring, tun_ptr_peek_len);
2544 /* Ops structure to mimic raw sockets with tun */
2545 static const struct proto_ops tun_socket_ops = {
2546 .peek_len = tun_peek_len,
2547 .sendmsg = tun_sendmsg,
2548 .recvmsg = tun_recvmsg,
2551 static struct proto tun_proto = {
2553 .owner = THIS_MODULE,
2554 .obj_size = sizeof(struct tun_file),
2557 static int tun_flags(struct tun_struct *tun)
2559 return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
2562 static ssize_t tun_flags_show(struct device *dev, struct device_attribute *attr,
2565 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2566 return sprintf(buf, "0x%x\n", tun_flags(tun));
2569 static ssize_t owner_show(struct device *dev, struct device_attribute *attr,
2572 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2573 return uid_valid(tun->owner)?
2574 sprintf(buf, "%u\n",
2575 from_kuid_munged(current_user_ns(), tun->owner)):
2576 sprintf(buf, "-1\n");
2579 static ssize_t group_show(struct device *dev, struct device_attribute *attr,
2582 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2583 return gid_valid(tun->group) ?
2584 sprintf(buf, "%u\n",
2585 from_kgid_munged(current_user_ns(), tun->group)):
2586 sprintf(buf, "-1\n");
2589 static DEVICE_ATTR_RO(tun_flags);
2590 static DEVICE_ATTR_RO(owner);
2591 static DEVICE_ATTR_RO(group);
2593 static struct attribute *tun_dev_attrs[] = {
2594 &dev_attr_tun_flags.attr,
2595 &dev_attr_owner.attr,
2596 &dev_attr_group.attr,
2600 static const struct attribute_group tun_attr_group = {
2601 .attrs = tun_dev_attrs
2604 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
2606 struct tun_struct *tun;
2607 struct tun_file *tfile = file->private_data;
2608 struct net_device *dev;
2611 if (tfile->detached)
2614 if ((ifr->ifr_flags & IFF_NAPI_FRAGS)) {
2615 if (!capable(CAP_NET_ADMIN))
2618 if (!(ifr->ifr_flags & IFF_NAPI) ||
2619 (ifr->ifr_flags & TUN_TYPE_MASK) != IFF_TAP)
2623 dev = __dev_get_by_name(net, ifr->ifr_name);
2625 if (ifr->ifr_flags & IFF_TUN_EXCL)
2627 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
2628 tun = netdev_priv(dev);
2629 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
2630 tun = netdev_priv(dev);
2634 if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
2635 !!(tun->flags & IFF_MULTI_QUEUE))
2638 if (tun_not_capable(tun))
2640 err = security_tun_dev_open(tun->security);
2644 err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER,
2645 ifr->ifr_flags & IFF_NAPI,
2646 ifr->ifr_flags & IFF_NAPI_FRAGS, true);
2650 if (tun->flags & IFF_MULTI_QUEUE &&
2651 (tun->numqueues + tun->numdisabled > 1)) {
2652 /* One or more queue has already been attached, no need
2653 * to initialize the device again.
2655 netdev_state_change(dev);
2659 tun->flags = (tun->flags & ~TUN_FEATURES) |
2660 (ifr->ifr_flags & TUN_FEATURES);
2662 netdev_state_change(dev);
2665 unsigned long flags = 0;
2666 int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
2669 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
2671 err = security_tun_dev_create();
2676 if (ifr->ifr_flags & IFF_TUN) {
2680 } else if (ifr->ifr_flags & IFF_TAP) {
2688 name = ifr->ifr_name;
2690 dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
2691 NET_NAME_UNKNOWN, tun_setup, queues,
2697 dev_net_set(dev, net);
2698 dev->rtnl_link_ops = &tun_link_ops;
2699 dev->ifindex = tfile->ifindex;
2700 dev->sysfs_groups[0] = &tun_attr_group;
2702 tun = netdev_priv(dev);
2705 tun->txflt.count = 0;
2706 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
2708 tun->align = NET_SKB_PAD;
2709 tun->filter_attached = false;
2710 tun->sndbuf = tfile->socket.sk->sk_sndbuf;
2711 tun->rx_batched = 0;
2712 RCU_INIT_POINTER(tun->steering_prog, NULL);
2714 dev->tstats = netdev_alloc_pcpu_stats(struct pcpu_sw_netstats);
2720 spin_lock_init(&tun->lock);
2722 err = security_tun_dev_alloc_security(&tun->security);
2729 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
2730 TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
2731 NETIF_F_HW_VLAN_STAG_TX;
2732 dev->features = dev->hw_features | NETIF_F_LLTX;
2733 dev->vlan_features = dev->features &
2734 ~(NETIF_F_HW_VLAN_CTAG_TX |
2735 NETIF_F_HW_VLAN_STAG_TX);
2737 tun->flags = (tun->flags & ~TUN_FEATURES) |
2738 (ifr->ifr_flags & TUN_FEATURES);
2740 INIT_LIST_HEAD(&tun->disabled);
2741 err = tun_attach(tun, file, false, ifr->ifr_flags & IFF_NAPI,
2742 ifr->ifr_flags & IFF_NAPI_FRAGS, false);
2746 err = register_netdevice(tun->dev);
2749 /* free_netdev() won't check refcnt, to avoid race
2750 * with dev_put() we need publish tun after registration.
2752 rcu_assign_pointer(tfile->tun, tun);
2755 netif_carrier_on(tun->dev);
2757 /* Make sure persistent devices do not get stuck in
2760 if (netif_running(tun->dev))
2761 netif_tx_wake_all_queues(tun->dev);
2763 strcpy(ifr->ifr_name, tun->dev->name);
2767 tun_detach_all(dev);
2768 /* We are here because register_netdevice() has failed.
2769 * If register_netdevice() already called tun_free_netdev()
2770 * while dealing with the error, dev->stats has been cleared.
2776 tun_flow_uninit(tun);
2777 security_tun_dev_free_security(tun->security);
2779 free_percpu(dev->tstats);
2785 static void tun_get_iff(struct tun_struct *tun, struct ifreq *ifr)
2787 strcpy(ifr->ifr_name, tun->dev->name);
2789 ifr->ifr_flags = tun_flags(tun);
2793 /* This is like a cut-down ethtool ops, except done via tun fd so no
2794 * privs required. */
2795 static int set_offload(struct tun_struct *tun, unsigned long arg)
2797 netdev_features_t features = 0;
2799 if (arg & TUN_F_CSUM) {
2800 features |= NETIF_F_HW_CSUM;
2803 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
2804 if (arg & TUN_F_TSO_ECN) {
2805 features |= NETIF_F_TSO_ECN;
2806 arg &= ~TUN_F_TSO_ECN;
2808 if (arg & TUN_F_TSO4)
2809 features |= NETIF_F_TSO;
2810 if (arg & TUN_F_TSO6)
2811 features |= NETIF_F_TSO6;
2812 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
2818 /* This gives the user a way to test for new features in future by
2819 * trying to set them. */
2823 tun->set_features = features;
2824 tun->dev->wanted_features &= ~TUN_USER_FEATURES;
2825 tun->dev->wanted_features |= features;
2826 netdev_update_features(tun->dev);
2831 static void tun_detach_filter(struct tun_struct *tun, int n)
2834 struct tun_file *tfile;
2836 for (i = 0; i < n; i++) {
2837 tfile = rtnl_dereference(tun->tfiles[i]);
2838 lock_sock(tfile->socket.sk);
2839 sk_detach_filter(tfile->socket.sk);
2840 release_sock(tfile->socket.sk);
2843 tun->filter_attached = false;
2846 static int tun_attach_filter(struct tun_struct *tun)
2849 struct tun_file *tfile;
2851 for (i = 0; i < tun->numqueues; i++) {
2852 tfile = rtnl_dereference(tun->tfiles[i]);
2853 lock_sock(tfile->socket.sk);
2854 ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
2855 release_sock(tfile->socket.sk);
2857 tun_detach_filter(tun, i);
2862 tun->filter_attached = true;
2866 static void tun_set_sndbuf(struct tun_struct *tun)
2868 struct tun_file *tfile;
2871 for (i = 0; i < tun->numqueues; i++) {
2872 tfile = rtnl_dereference(tun->tfiles[i]);
2873 tfile->socket.sk->sk_sndbuf = tun->sndbuf;
2877 static int tun_set_queue(struct file *file, struct ifreq *ifr)
2879 struct tun_file *tfile = file->private_data;
2880 struct tun_struct *tun;
2885 if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
2886 tun = tfile->detached;
2891 ret = security_tun_dev_attach_queue(tun->security);
2894 ret = tun_attach(tun, file, false, tun->flags & IFF_NAPI,
2895 tun->flags & IFF_NAPI_FRAGS, true);
2896 } else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
2897 tun = rtnl_dereference(tfile->tun);
2898 if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
2901 __tun_detach(tfile, false);
2906 netdev_state_change(tun->dev);
2913 static int tun_set_ebpf(struct tun_struct *tun, struct tun_prog __rcu **prog_p,
2916 struct bpf_prog *prog;
2919 if (copy_from_user(&fd, data, sizeof(fd)))
2925 prog = bpf_prog_get_type(fd, BPF_PROG_TYPE_SOCKET_FILTER);
2927 return PTR_ERR(prog);
2930 return __tun_set_ebpf(tun, prog_p, prog);
2933 /* Return correct value for tun->dev->addr_len based on tun->dev->type. */
2934 static unsigned char tun_get_addr_len(unsigned short type)
2938 case ARPHRD_TUNNEL6:
2939 return sizeof(struct in6_addr);
2946 case ARPHRD_IEEE802154:
2947 case ARPHRD_IEEE802154_MONITOR:
2948 return IEEE802154_EXTENDED_ADDR_LEN;
2949 case ARPHRD_PHONET_PIPE:
2953 case ARPHRD_6LOWPAN:
2954 return EUI64_ADDR_LEN;
2959 case ARPHRD_IEEE802:
2962 return ROSE_ADDR_LEN;
2964 return AX25_ADDR_LEN;
2965 case ARPHRD_LOCALTLK:
2972 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
2973 unsigned long arg, int ifreq_len)
2975 struct tun_file *tfile = file->private_data;
2976 struct net *net = sock_net(&tfile->sk);
2977 struct tun_struct *tun;
2978 void __user* argp = (void __user*)arg;
2979 unsigned int ifindex, carrier;
2987 bool do_notify = false;
2989 if (cmd == TUNSETIFF || cmd == TUNSETQUEUE ||
2990 (_IOC_TYPE(cmd) == SOCK_IOC_TYPE && cmd != SIOCGSKNS)) {
2991 if (copy_from_user(&ifr, argp, ifreq_len))
2994 memset(&ifr, 0, sizeof(ifr));
2996 if (cmd == TUNGETFEATURES) {
2997 /* Currently this just means: "what IFF flags are valid?".
2998 * This is needed because we never checked for invalid flags on
3001 return put_user(IFF_TUN | IFF_TAP | TUN_FEATURES,
3002 (unsigned int __user*)argp);
3003 } else if (cmd == TUNSETQUEUE) {
3004 return tun_set_queue(file, &ifr);
3005 } else if (cmd == SIOCGSKNS) {
3006 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
3008 return open_related_ns(&net->ns, get_net_ns);
3013 tun = tun_get(tfile);
3014 if (cmd == TUNSETIFF) {
3019 ifr.ifr_name[IFNAMSIZ-1] = '\0';
3021 ret = tun_set_iff(net, file, &ifr);
3026 if (copy_to_user(argp, &ifr, ifreq_len))
3030 if (cmd == TUNSETIFINDEX) {
3036 if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
3040 tfile->ifindex = ifindex;
3048 netif_info(tun, drv, tun->dev, "tun_chr_ioctl cmd %u\n", cmd);
3050 net = dev_net(tun->dev);
3054 tun_get_iff(tun, &ifr);
3056 if (tfile->detached)
3057 ifr.ifr_flags |= IFF_DETACH_QUEUE;
3058 if (!tfile->socket.sk->sk_filter)
3059 ifr.ifr_flags |= IFF_NOFILTER;
3061 if (copy_to_user(argp, &ifr, ifreq_len))
3066 /* Disable/Enable checksum */
3068 /* [unimplemented] */
3069 netif_info(tun, drv, tun->dev, "ignored: set checksum %s\n",
3070 arg ? "disabled" : "enabled");
3074 /* Disable/Enable persist mode. Keep an extra reference to the
3075 * module to prevent the module being unprobed.
3077 if (arg && !(tun->flags & IFF_PERSIST)) {
3078 tun->flags |= IFF_PERSIST;
3079 __module_get(THIS_MODULE);
3082 if (!arg && (tun->flags & IFF_PERSIST)) {
3083 tun->flags &= ~IFF_PERSIST;
3084 module_put(THIS_MODULE);
3088 netif_info(tun, drv, tun->dev, "persist %s\n",
3089 arg ? "enabled" : "disabled");
3093 /* Set owner of the device */
3094 owner = make_kuid(current_user_ns(), arg);
3095 if (!uid_valid(owner)) {
3101 netif_info(tun, drv, tun->dev, "owner set to %u\n",
3102 from_kuid(&init_user_ns, tun->owner));
3106 /* Set group of the device */
3107 group = make_kgid(current_user_ns(), arg);
3108 if (!gid_valid(group)) {
3114 netif_info(tun, drv, tun->dev, "group set to %u\n",
3115 from_kgid(&init_user_ns, tun->group));
3119 /* Only allow setting the type when the interface is down */
3120 if (tun->dev->flags & IFF_UP) {
3121 netif_info(tun, drv, tun->dev,
3122 "Linktype set failed because interface is up\n");
3125 ret = call_netdevice_notifiers(NETDEV_PRE_TYPE_CHANGE,
3127 ret = notifier_to_errno(ret);
3129 netif_info(tun, drv, tun->dev,
3130 "Refused to change device type\n");
3133 tun->dev->type = (int) arg;
3134 tun->dev->addr_len = tun_get_addr_len(tun->dev->type);
3135 netif_info(tun, drv, tun->dev, "linktype set to %d\n",
3137 call_netdevice_notifiers(NETDEV_POST_TYPE_CHANGE,
3143 tun->msg_enable = (u32)arg;
3147 ret = set_offload(tun, arg);
3150 case TUNSETTXFILTER:
3151 /* Can be set only for TAPs */
3153 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3155 ret = update_filter(&tun->txflt, (void __user *)arg);
3159 /* Get hw address */
3160 dev_get_mac_address(&ifr.ifr_hwaddr, net, tun->dev->name);
3161 if (copy_to_user(argp, &ifr, ifreq_len))
3166 /* Set hw address */
3167 ret = dev_set_mac_address_user(tun->dev, &ifr.ifr_hwaddr, NULL);
3171 sndbuf = tfile->socket.sk->sk_sndbuf;
3172 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
3177 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
3186 tun->sndbuf = sndbuf;
3187 tun_set_sndbuf(tun);
3190 case TUNGETVNETHDRSZ:
3191 vnet_hdr_sz = tun->vnet_hdr_sz;
3192 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
3196 case TUNSETVNETHDRSZ:
3197 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
3201 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
3206 tun->vnet_hdr_sz = vnet_hdr_sz;
3210 le = !!(tun->flags & TUN_VNET_LE);
3211 if (put_user(le, (int __user *)argp))
3216 if (get_user(le, (int __user *)argp)) {
3221 tun->flags |= TUN_VNET_LE;
3223 tun->flags &= ~TUN_VNET_LE;
3227 ret = tun_get_vnet_be(tun, argp);
3231 ret = tun_set_vnet_be(tun, argp);
3234 case TUNATTACHFILTER:
3235 /* Can be set only for TAPs */
3237 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3240 if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
3243 ret = tun_attach_filter(tun);
3246 case TUNDETACHFILTER:
3247 /* Can be set only for TAPs */
3249 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3252 tun_detach_filter(tun, tun->numqueues);
3257 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3260 if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
3265 case TUNSETSTEERINGEBPF:
3266 ret = tun_set_ebpf(tun, &tun->steering_prog, argp);
3269 case TUNSETFILTEREBPF:
3270 ret = tun_set_ebpf(tun, &tun->filter_prog, argp);
3275 if (copy_from_user(&carrier, argp, sizeof(carrier)))
3278 ret = tun_net_change_carrier(tun->dev, (bool)carrier);
3281 case TUNGETDEVNETNS:
3283 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
3285 ret = open_related_ns(&net->ns, get_net_ns);
3294 netdev_state_change(tun->dev);
3303 static long tun_chr_ioctl(struct file *file,
3304 unsigned int cmd, unsigned long arg)
3306 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
3309 #ifdef CONFIG_COMPAT
3310 static long tun_chr_compat_ioctl(struct file *file,
3311 unsigned int cmd, unsigned long arg)
3316 case TUNSETTXFILTER:
3321 arg = (unsigned long)compat_ptr(arg);
3324 arg = (compat_ulong_t)arg;
3329 * compat_ifreq is shorter than ifreq, so we must not access beyond
3330 * the end of that structure. All fields that are used in this
3331 * driver are compatible though, we don't need to convert the
3334 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
3336 #endif /* CONFIG_COMPAT */
3338 static int tun_chr_fasync(int fd, struct file *file, int on)
3340 struct tun_file *tfile = file->private_data;
3343 if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
3347 __f_setown(file, task_pid(current), PIDTYPE_TGID, 0);
3348 tfile->flags |= TUN_FASYNC;
3350 tfile->flags &= ~TUN_FASYNC;
3356 static int tun_chr_open(struct inode *inode, struct file * file)
3358 struct net *net = current->nsproxy->net_ns;
3359 struct tun_file *tfile;
3361 tfile = (struct tun_file *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
3365 if (ptr_ring_init(&tfile->tx_ring, 0, GFP_KERNEL)) {
3366 sk_free(&tfile->sk);
3370 mutex_init(&tfile->napi_mutex);
3371 RCU_INIT_POINTER(tfile->tun, NULL);
3375 init_waitqueue_head(&tfile->socket.wq.wait);
3377 tfile->socket.file = file;
3378 tfile->socket.ops = &tun_socket_ops;
3380 sock_init_data(&tfile->socket, &tfile->sk);
3382 tfile->sk.sk_write_space = tun_sock_write_space;
3383 tfile->sk.sk_sndbuf = INT_MAX;
3385 file->private_data = tfile;
3386 INIT_LIST_HEAD(&tfile->next);
3388 sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
3393 static int tun_chr_close(struct inode *inode, struct file *file)
3395 struct tun_file *tfile = file->private_data;
3397 tun_detach(tfile, true);
3402 #ifdef CONFIG_PROC_FS
3403 static void tun_chr_show_fdinfo(struct seq_file *m, struct file *file)
3405 struct tun_file *tfile = file->private_data;
3406 struct tun_struct *tun;
3409 memset(&ifr, 0, sizeof(ifr));
3412 tun = tun_get(tfile);
3414 tun_get_iff(tun, &ifr);
3420 seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
3424 static const struct file_operations tun_fops = {
3425 .owner = THIS_MODULE,
3426 .llseek = no_llseek,
3427 .read_iter = tun_chr_read_iter,
3428 .write_iter = tun_chr_write_iter,
3429 .poll = tun_chr_poll,
3430 .unlocked_ioctl = tun_chr_ioctl,
3431 #ifdef CONFIG_COMPAT
3432 .compat_ioctl = tun_chr_compat_ioctl,
3434 .open = tun_chr_open,
3435 .release = tun_chr_close,
3436 .fasync = tun_chr_fasync,
3437 #ifdef CONFIG_PROC_FS
3438 .show_fdinfo = tun_chr_show_fdinfo,
3442 static struct miscdevice tun_miscdev = {
3445 .nodename = "net/tun",
3449 /* ethtool interface */
3451 static void tun_default_link_ksettings(struct net_device *dev,
3452 struct ethtool_link_ksettings *cmd)
3454 ethtool_link_ksettings_zero_link_mode(cmd, supported);
3455 ethtool_link_ksettings_zero_link_mode(cmd, advertising);
3456 cmd->base.speed = SPEED_10;
3457 cmd->base.duplex = DUPLEX_FULL;
3458 cmd->base.port = PORT_TP;
3459 cmd->base.phy_address = 0;
3460 cmd->base.autoneg = AUTONEG_DISABLE;
3463 static int tun_get_link_ksettings(struct net_device *dev,
3464 struct ethtool_link_ksettings *cmd)
3466 struct tun_struct *tun = netdev_priv(dev);
3468 memcpy(cmd, &tun->link_ksettings, sizeof(*cmd));
3472 static int tun_set_link_ksettings(struct net_device *dev,
3473 const struct ethtool_link_ksettings *cmd)
3475 struct tun_struct *tun = netdev_priv(dev);
3477 memcpy(&tun->link_ksettings, cmd, sizeof(*cmd));
3481 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
3483 struct tun_struct *tun = netdev_priv(dev);
3485 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
3486 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
3488 switch (tun->flags & TUN_TYPE_MASK) {
3490 strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
3493 strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
3498 static u32 tun_get_msglevel(struct net_device *dev)
3500 struct tun_struct *tun = netdev_priv(dev);
3502 return tun->msg_enable;
3505 static void tun_set_msglevel(struct net_device *dev, u32 value)
3507 struct tun_struct *tun = netdev_priv(dev);
3509 tun->msg_enable = value;
3512 static int tun_get_coalesce(struct net_device *dev,
3513 struct ethtool_coalesce *ec)
3515 struct tun_struct *tun = netdev_priv(dev);
3517 ec->rx_max_coalesced_frames = tun->rx_batched;
3522 static int tun_set_coalesce(struct net_device *dev,
3523 struct ethtool_coalesce *ec)
3525 struct tun_struct *tun = netdev_priv(dev);
3527 if (ec->rx_max_coalesced_frames > NAPI_POLL_WEIGHT)
3528 tun->rx_batched = NAPI_POLL_WEIGHT;
3530 tun->rx_batched = ec->rx_max_coalesced_frames;
3535 static const struct ethtool_ops tun_ethtool_ops = {
3536 .supported_coalesce_params = ETHTOOL_COALESCE_RX_MAX_FRAMES,
3537 .get_drvinfo = tun_get_drvinfo,
3538 .get_msglevel = tun_get_msglevel,
3539 .set_msglevel = tun_set_msglevel,
3540 .get_link = ethtool_op_get_link,
3541 .get_ts_info = ethtool_op_get_ts_info,
3542 .get_coalesce = tun_get_coalesce,
3543 .set_coalesce = tun_set_coalesce,
3544 .get_link_ksettings = tun_get_link_ksettings,
3545 .set_link_ksettings = tun_set_link_ksettings,
3548 static int tun_queue_resize(struct tun_struct *tun)
3550 struct net_device *dev = tun->dev;
3551 struct tun_file *tfile;
3552 struct ptr_ring **rings;
3553 int n = tun->numqueues + tun->numdisabled;
3556 rings = kmalloc_array(n, sizeof(*rings), GFP_KERNEL);
3560 for (i = 0; i < tun->numqueues; i++) {
3561 tfile = rtnl_dereference(tun->tfiles[i]);
3562 rings[i] = &tfile->tx_ring;
3564 list_for_each_entry(tfile, &tun->disabled, next)
3565 rings[i++] = &tfile->tx_ring;
3567 ret = ptr_ring_resize_multiple(rings, n,
3568 dev->tx_queue_len, GFP_KERNEL,
3575 static int tun_device_event(struct notifier_block *unused,
3576 unsigned long event, void *ptr)
3578 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
3579 struct tun_struct *tun = netdev_priv(dev);
3582 if (dev->rtnl_link_ops != &tun_link_ops)
3586 case NETDEV_CHANGE_TX_QUEUE_LEN:
3587 if (tun_queue_resize(tun))
3591 for (i = 0; i < tun->numqueues; i++) {
3592 struct tun_file *tfile;
3594 tfile = rtnl_dereference(tun->tfiles[i]);
3595 tfile->socket.sk->sk_write_space(tfile->socket.sk);
3605 static struct notifier_block tun_notifier_block __read_mostly = {
3606 .notifier_call = tun_device_event,
3609 static int __init tun_init(void)
3613 pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
3615 ret = rtnl_link_register(&tun_link_ops);
3617 pr_err("Can't register link_ops\n");
3621 ret = misc_register(&tun_miscdev);
3623 pr_err("Can't register misc device %d\n", TUN_MINOR);
3627 ret = register_netdevice_notifier(&tun_notifier_block);
3629 pr_err("Can't register netdevice notifier\n");
3636 misc_deregister(&tun_miscdev);
3638 rtnl_link_unregister(&tun_link_ops);
3643 static void tun_cleanup(void)
3645 misc_deregister(&tun_miscdev);
3646 rtnl_link_unregister(&tun_link_ops);
3647 unregister_netdevice_notifier(&tun_notifier_block);
3650 /* Get an underlying socket object from tun file. Returns error unless file is
3651 * attached to a device. The returned object works like a packet socket, it
3652 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
3653 * holding a reference to the file for as long as the socket is in use. */
3654 struct socket *tun_get_socket(struct file *file)
3656 struct tun_file *tfile;
3657 if (file->f_op != &tun_fops)
3658 return ERR_PTR(-EINVAL);
3659 tfile = file->private_data;
3661 return ERR_PTR(-EBADFD);
3662 return &tfile->socket;
3664 EXPORT_SYMBOL_GPL(tun_get_socket);
3666 struct ptr_ring *tun_get_tx_ring(struct file *file)
3668 struct tun_file *tfile;
3670 if (file->f_op != &tun_fops)
3671 return ERR_PTR(-EINVAL);
3672 tfile = file->private_data;
3674 return ERR_PTR(-EBADFD);
3675 return &tfile->tx_ring;
3677 EXPORT_SYMBOL_GPL(tun_get_tx_ring);
3679 module_init(tun_init);
3680 module_exit(tun_cleanup);
3681 MODULE_DESCRIPTION(DRV_DESCRIPTION);
3682 MODULE_AUTHOR(DRV_COPYRIGHT);
3683 MODULE_LICENSE("GPL");
3684 MODULE_ALIAS_MISCDEV(TUN_MINOR);
3685 MODULE_ALIAS("devname:net/tun");