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;
222 static void tun_flow_init(struct tun_struct *tun);
223 static void tun_flow_uninit(struct tun_struct *tun);
225 static int tun_napi_receive(struct napi_struct *napi, int budget)
227 struct tun_file *tfile = container_of(napi, struct tun_file, napi);
228 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
229 struct sk_buff_head process_queue;
233 __skb_queue_head_init(&process_queue);
235 spin_lock(&queue->lock);
236 skb_queue_splice_tail_init(queue, &process_queue);
237 spin_unlock(&queue->lock);
239 while (received < budget && (skb = __skb_dequeue(&process_queue))) {
240 napi_gro_receive(napi, skb);
244 if (!skb_queue_empty(&process_queue)) {
245 spin_lock(&queue->lock);
246 skb_queue_splice(&process_queue, queue);
247 spin_unlock(&queue->lock);
253 static int tun_napi_poll(struct napi_struct *napi, int budget)
255 unsigned int received;
257 received = tun_napi_receive(napi, budget);
259 if (received < budget)
260 napi_complete_done(napi, received);
265 static void tun_napi_init(struct tun_struct *tun, struct tun_file *tfile,
266 bool napi_en, bool napi_frags)
268 tfile->napi_enabled = napi_en;
269 tfile->napi_frags_enabled = napi_en && napi_frags;
271 netif_napi_add_tx(tun->dev, &tfile->napi, tun_napi_poll);
272 napi_enable(&tfile->napi);
276 static void tun_napi_disable(struct tun_file *tfile)
278 if (tfile->napi_enabled)
279 napi_disable(&tfile->napi);
282 static void tun_napi_del(struct tun_file *tfile)
284 if (tfile->napi_enabled)
285 netif_napi_del(&tfile->napi);
288 static bool tun_napi_frags_enabled(const struct tun_file *tfile)
290 return tfile->napi_frags_enabled;
293 #ifdef CONFIG_TUN_VNET_CROSS_LE
294 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
296 return tun->flags & TUN_VNET_BE ? false :
297 virtio_legacy_is_little_endian();
300 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
302 int be = !!(tun->flags & TUN_VNET_BE);
304 if (put_user(be, argp))
310 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
314 if (get_user(be, argp))
318 tun->flags |= TUN_VNET_BE;
320 tun->flags &= ~TUN_VNET_BE;
325 static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
327 return virtio_legacy_is_little_endian();
330 static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
335 static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
339 #endif /* CONFIG_TUN_VNET_CROSS_LE */
341 static inline bool tun_is_little_endian(struct tun_struct *tun)
343 return tun->flags & TUN_VNET_LE ||
344 tun_legacy_is_little_endian(tun);
347 static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
349 return __virtio16_to_cpu(tun_is_little_endian(tun), val);
352 static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
354 return __cpu_to_virtio16(tun_is_little_endian(tun), val);
357 static inline u32 tun_hashfn(u32 rxhash)
359 return rxhash & TUN_MASK_FLOW_ENTRIES;
362 static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
364 struct tun_flow_entry *e;
366 hlist_for_each_entry_rcu(e, head, hash_link) {
367 if (e->rxhash == rxhash)
373 static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
374 struct hlist_head *head,
375 u32 rxhash, u16 queue_index)
377 struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
380 netif_info(tun, tx_queued, tun->dev,
381 "create flow: hash %u index %u\n",
382 rxhash, queue_index);
383 e->updated = jiffies;
386 e->queue_index = queue_index;
388 hlist_add_head_rcu(&e->hash_link, head);
394 static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
396 netif_info(tun, tx_queued, tun->dev, "delete flow: hash %u index %u\n",
397 e->rxhash, e->queue_index);
398 hlist_del_rcu(&e->hash_link);
403 static void tun_flow_flush(struct tun_struct *tun)
407 spin_lock_bh(&tun->lock);
408 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
409 struct tun_flow_entry *e;
410 struct hlist_node *n;
412 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
413 tun_flow_delete(tun, e);
415 spin_unlock_bh(&tun->lock);
418 static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
422 spin_lock_bh(&tun->lock);
423 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
424 struct tun_flow_entry *e;
425 struct hlist_node *n;
427 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
428 if (e->queue_index == queue_index)
429 tun_flow_delete(tun, e);
432 spin_unlock_bh(&tun->lock);
435 static void tun_flow_cleanup(struct timer_list *t)
437 struct tun_struct *tun = from_timer(tun, t, flow_gc_timer);
438 unsigned long delay = tun->ageing_time;
439 unsigned long next_timer = jiffies + delay;
440 unsigned long count = 0;
443 spin_lock(&tun->lock);
444 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
445 struct tun_flow_entry *e;
446 struct hlist_node *n;
448 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
449 unsigned long this_timer;
451 this_timer = e->updated + delay;
452 if (time_before_eq(this_timer, jiffies)) {
453 tun_flow_delete(tun, e);
457 if (time_before(this_timer, next_timer))
458 next_timer = this_timer;
463 mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
464 spin_unlock(&tun->lock);
467 static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
468 struct tun_file *tfile)
470 struct hlist_head *head;
471 struct tun_flow_entry *e;
472 unsigned long delay = tun->ageing_time;
473 u16 queue_index = tfile->queue_index;
475 head = &tun->flows[tun_hashfn(rxhash)];
479 e = tun_flow_find(head, rxhash);
481 /* TODO: keep queueing to old queue until it's empty? */
482 if (READ_ONCE(e->queue_index) != queue_index)
483 WRITE_ONCE(e->queue_index, queue_index);
484 if (e->updated != jiffies)
485 e->updated = jiffies;
486 sock_rps_record_flow_hash(e->rps_rxhash);
488 spin_lock_bh(&tun->lock);
489 if (!tun_flow_find(head, rxhash) &&
490 tun->flow_count < MAX_TAP_FLOWS)
491 tun_flow_create(tun, head, rxhash, queue_index);
493 if (!timer_pending(&tun->flow_gc_timer))
494 mod_timer(&tun->flow_gc_timer,
495 round_jiffies_up(jiffies + delay));
496 spin_unlock_bh(&tun->lock);
502 /* Save the hash received in the stack receive path and update the
503 * flow_hash table accordingly.
505 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry *e, u32 hash)
507 if (unlikely(e->rps_rxhash != hash))
508 e->rps_rxhash = hash;
511 /* We try to identify a flow through its rxhash. The reason that
512 * we do not check rxq no. is because some cards(e.g 82599), chooses
513 * the rxq based on the txq where the last packet of the flow comes. As
514 * the userspace application move between processors, we may get a
515 * different rxq no. here.
517 static u16 tun_automq_select_queue(struct tun_struct *tun, struct sk_buff *skb)
519 struct tun_flow_entry *e;
523 numqueues = READ_ONCE(tun->numqueues);
525 txq = __skb_get_hash_symmetric(skb);
526 e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
528 tun_flow_save_rps_rxhash(e, txq);
529 txq = e->queue_index;
531 /* use multiply and shift instead of expensive divide */
532 txq = ((u64)txq * numqueues) >> 32;
538 static u16 tun_ebpf_select_queue(struct tun_struct *tun, struct sk_buff *skb)
540 struct tun_prog *prog;
544 numqueues = READ_ONCE(tun->numqueues);
548 prog = rcu_dereference(tun->steering_prog);
550 ret = bpf_prog_run_clear_cb(prog->prog, skb);
552 return ret % numqueues;
555 static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb,
556 struct net_device *sb_dev)
558 struct tun_struct *tun = netdev_priv(dev);
562 if (rcu_dereference(tun->steering_prog))
563 ret = tun_ebpf_select_queue(tun, skb);
565 ret = tun_automq_select_queue(tun, skb);
571 static inline bool tun_not_capable(struct tun_struct *tun)
573 const struct cred *cred = current_cred();
574 struct net *net = dev_net(tun->dev);
576 return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
577 (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
578 !ns_capable(net->user_ns, CAP_NET_ADMIN);
581 static void tun_set_real_num_queues(struct tun_struct *tun)
583 netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
584 netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
587 static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
589 tfile->detached = tun;
590 list_add_tail(&tfile->next, &tun->disabled);
594 static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
596 struct tun_struct *tun = tfile->detached;
598 tfile->detached = NULL;
599 list_del_init(&tfile->next);
604 void tun_ptr_free(void *ptr)
608 if (tun_is_xdp_frame(ptr)) {
609 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
611 xdp_return_frame(xdpf);
613 __skb_array_destroy_skb(ptr);
616 EXPORT_SYMBOL_GPL(tun_ptr_free);
618 static void tun_queue_purge(struct tun_file *tfile)
622 while ((ptr = ptr_ring_consume(&tfile->tx_ring)) != NULL)
625 skb_queue_purge(&tfile->sk.sk_write_queue);
626 skb_queue_purge(&tfile->sk.sk_error_queue);
629 static void __tun_detach(struct tun_file *tfile, bool clean)
631 struct tun_file *ntfile;
632 struct tun_struct *tun;
634 tun = rtnl_dereference(tfile->tun);
637 tun_napi_disable(tfile);
641 if (tun && !tfile->detached) {
642 u16 index = tfile->queue_index;
643 BUG_ON(index >= tun->numqueues);
645 rcu_assign_pointer(tun->tfiles[index],
646 tun->tfiles[tun->numqueues - 1]);
647 ntfile = rtnl_dereference(tun->tfiles[index]);
648 ntfile->queue_index = index;
649 rcu_assign_pointer(tun->tfiles[tun->numqueues - 1],
654 RCU_INIT_POINTER(tfile->tun, NULL);
655 sock_put(&tfile->sk);
657 tun_disable_queue(tun, tfile);
660 tun_flow_delete_by_queue(tun, tun->numqueues + 1);
661 /* Drop read queue */
662 tun_queue_purge(tfile);
663 tun_set_real_num_queues(tun);
664 } else if (tfile->detached && clean) {
665 tun = tun_enable_queue(tfile);
666 sock_put(&tfile->sk);
670 if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
671 netif_carrier_off(tun->dev);
673 if (!(tun->flags & IFF_PERSIST) &&
674 tun->dev->reg_state == NETREG_REGISTERED)
675 unregister_netdevice(tun->dev);
678 xdp_rxq_info_unreg(&tfile->xdp_rxq);
679 ptr_ring_cleanup(&tfile->tx_ring, tun_ptr_free);
680 sock_put(&tfile->sk);
684 static void tun_detach(struct tun_file *tfile, bool clean)
686 struct tun_struct *tun;
687 struct net_device *dev;
690 tun = rtnl_dereference(tfile->tun);
691 dev = tun ? tun->dev : NULL;
692 __tun_detach(tfile, clean);
694 netdev_state_change(dev);
698 static void tun_detach_all(struct net_device *dev)
700 struct tun_struct *tun = netdev_priv(dev);
701 struct tun_file *tfile, *tmp;
702 int i, n = tun->numqueues;
704 for (i = 0; i < n; i++) {
705 tfile = rtnl_dereference(tun->tfiles[i]);
707 tun_napi_disable(tfile);
708 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
709 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
710 RCU_INIT_POINTER(tfile->tun, NULL);
713 list_for_each_entry(tfile, &tun->disabled, next) {
714 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
715 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
716 RCU_INIT_POINTER(tfile->tun, NULL);
718 BUG_ON(tun->numqueues != 0);
721 for (i = 0; i < n; i++) {
722 tfile = rtnl_dereference(tun->tfiles[i]);
724 /* Drop read queue */
725 tun_queue_purge(tfile);
726 xdp_rxq_info_unreg(&tfile->xdp_rxq);
727 sock_put(&tfile->sk);
729 list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
730 tun_enable_queue(tfile);
731 tun_queue_purge(tfile);
732 xdp_rxq_info_unreg(&tfile->xdp_rxq);
733 sock_put(&tfile->sk);
735 BUG_ON(tun->numdisabled != 0);
737 if (tun->flags & IFF_PERSIST)
738 module_put(THIS_MODULE);
741 static int tun_attach(struct tun_struct *tun, struct file *file,
742 bool skip_filter, bool napi, bool napi_frags,
745 struct tun_file *tfile = file->private_data;
746 struct net_device *dev = tun->dev;
749 err = security_tun_dev_attach(tfile->socket.sk, tun->security);
754 if (rtnl_dereference(tfile->tun) && !tfile->detached)
758 if (!(tun->flags & IFF_MULTI_QUEUE) && tun->numqueues == 1)
762 if (!tfile->detached &&
763 tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
768 /* Re-attach the filter to persist device */
769 if (!skip_filter && (tun->filter_attached == true)) {
770 lock_sock(tfile->socket.sk);
771 err = sk_attach_filter(&tun->fprog, tfile->socket.sk);
772 release_sock(tfile->socket.sk);
777 if (!tfile->detached &&
778 ptr_ring_resize(&tfile->tx_ring, dev->tx_queue_len,
779 GFP_KERNEL, tun_ptr_free)) {
784 tfile->queue_index = tun->numqueues;
785 tfile->socket.sk->sk_shutdown &= ~RCV_SHUTDOWN;
787 if (tfile->detached) {
788 /* Re-attach detached tfile, updating XDP queue_index */
789 WARN_ON(!xdp_rxq_info_is_reg(&tfile->xdp_rxq));
791 if (tfile->xdp_rxq.queue_index != tfile->queue_index)
792 tfile->xdp_rxq.queue_index = tfile->queue_index;
794 /* Setup XDP RX-queue info, for new tfile getting attached */
795 err = xdp_rxq_info_reg(&tfile->xdp_rxq,
796 tun->dev, tfile->queue_index, 0);
799 err = xdp_rxq_info_reg_mem_model(&tfile->xdp_rxq,
800 MEM_TYPE_PAGE_SHARED, NULL);
802 xdp_rxq_info_unreg(&tfile->xdp_rxq);
808 if (tfile->detached) {
809 tun_enable_queue(tfile);
811 sock_hold(&tfile->sk);
812 tun_napi_init(tun, tfile, napi, napi_frags);
815 if (rtnl_dereference(tun->xdp_prog))
816 sock_set_flag(&tfile->sk, SOCK_XDP);
818 /* device is allowed to go away first, so no need to hold extra
822 /* Publish tfile->tun and tun->tfiles only after we've fully
823 * initialized tfile; otherwise we risk using half-initialized
827 rcu_assign_pointer(tfile->tun, tun);
828 rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
830 tun_set_real_num_queues(tun);
835 static struct tun_struct *tun_get(struct tun_file *tfile)
837 struct tun_struct *tun;
840 tun = rcu_dereference(tfile->tun);
848 static void tun_put(struct tun_struct *tun)
854 static void addr_hash_set(u32 *mask, const u8 *addr)
856 int n = ether_crc(ETH_ALEN, addr) >> 26;
857 mask[n >> 5] |= (1 << (n & 31));
860 static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
862 int n = ether_crc(ETH_ALEN, addr) >> 26;
863 return mask[n >> 5] & (1 << (n & 31));
866 static int update_filter(struct tap_filter *filter, void __user *arg)
868 struct { u8 u[ETH_ALEN]; } *addr;
869 struct tun_filter uf;
870 int err, alen, n, nexact;
872 if (copy_from_user(&uf, arg, sizeof(uf)))
881 alen = ETH_ALEN * uf.count;
882 addr = memdup_user(arg + sizeof(uf), alen);
884 return PTR_ERR(addr);
886 /* The filter is updated without holding any locks. Which is
887 * perfectly safe. We disable it first and in the worst
888 * case we'll accept a few undesired packets. */
892 /* Use first set of addresses as an exact filter */
893 for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
894 memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
898 /* Remaining multicast addresses are hashed,
899 * unicast will leave the filter disabled. */
900 memset(filter->mask, 0, sizeof(filter->mask));
901 for (; n < uf.count; n++) {
902 if (!is_multicast_ether_addr(addr[n].u)) {
903 err = 0; /* no filter */
906 addr_hash_set(filter->mask, addr[n].u);
909 /* For ALLMULTI just set the mask to all ones.
910 * This overrides the mask populated above. */
911 if ((uf.flags & TUN_FLT_ALLMULTI))
912 memset(filter->mask, ~0, sizeof(filter->mask));
914 /* Now enable the filter */
916 filter->count = nexact;
918 /* Return the number of exact filters */
925 /* Returns: 0 - drop, !=0 - accept */
926 static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
928 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
930 struct ethhdr *eh = (struct ethhdr *) skb->data;
934 for (i = 0; i < filter->count; i++)
935 if (ether_addr_equal(eh->h_dest, filter->addr[i]))
938 /* Inexact match (multicast only) */
939 if (is_multicast_ether_addr(eh->h_dest))
940 return addr_hash_test(filter->mask, eh->h_dest);
946 * Checks whether the packet is accepted or not.
947 * Returns: 0 - drop, !=0 - accept
949 static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
954 return run_filter(filter, skb);
957 /* Network device part of the driver */
959 static const struct ethtool_ops tun_ethtool_ops;
961 static int tun_net_init(struct net_device *dev)
963 struct tun_struct *tun = netdev_priv(dev);
964 struct ifreq *ifr = tun->ifr;
967 dev->tstats = netdev_alloc_pcpu_stats(struct pcpu_sw_netstats);
971 spin_lock_init(&tun->lock);
973 err = security_tun_dev_alloc_security(&tun->security);
975 free_percpu(dev->tstats);
981 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
982 TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
983 NETIF_F_HW_VLAN_STAG_TX;
984 dev->features = dev->hw_features | NETIF_F_LLTX;
985 dev->vlan_features = dev->features &
986 ~(NETIF_F_HW_VLAN_CTAG_TX |
987 NETIF_F_HW_VLAN_STAG_TX);
989 tun->flags = (tun->flags & ~TUN_FEATURES) |
990 (ifr->ifr_flags & TUN_FEATURES);
992 INIT_LIST_HEAD(&tun->disabled);
993 err = tun_attach(tun, tun->file, false, ifr->ifr_flags & IFF_NAPI,
994 ifr->ifr_flags & IFF_NAPI_FRAGS, false);
996 tun_flow_uninit(tun);
997 security_tun_dev_free_security(tun->security);
998 free_percpu(dev->tstats);
1004 /* Net device detach from fd. */
1005 static void tun_net_uninit(struct net_device *dev)
1007 tun_detach_all(dev);
1010 /* Net device open. */
1011 static int tun_net_open(struct net_device *dev)
1013 netif_tx_start_all_queues(dev);
1018 /* Net device close. */
1019 static int tun_net_close(struct net_device *dev)
1021 netif_tx_stop_all_queues(dev);
1025 /* Net device start xmit */
1026 static void tun_automq_xmit(struct tun_struct *tun, struct sk_buff *skb)
1029 if (tun->numqueues == 1 && static_branch_unlikely(&rps_needed)) {
1030 /* Select queue was not called for the skbuff, so we extract the
1031 * RPS hash and save it into the flow_table here.
1033 struct tun_flow_entry *e;
1036 rxhash = __skb_get_hash_symmetric(skb);
1037 e = tun_flow_find(&tun->flows[tun_hashfn(rxhash)], rxhash);
1039 tun_flow_save_rps_rxhash(e, rxhash);
1044 static unsigned int run_ebpf_filter(struct tun_struct *tun,
1045 struct sk_buff *skb,
1048 struct tun_prog *prog = rcu_dereference(tun->filter_prog);
1051 len = bpf_prog_run_clear_cb(prog->prog, skb);
1056 /* Net device start xmit */
1057 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
1059 struct tun_struct *tun = netdev_priv(dev);
1060 enum skb_drop_reason drop_reason;
1061 int txq = skb->queue_mapping;
1062 struct netdev_queue *queue;
1063 struct tun_file *tfile;
1067 tfile = rcu_dereference(tun->tfiles[txq]);
1069 /* Drop packet if interface is not attached */
1071 drop_reason = SKB_DROP_REASON_DEV_READY;
1075 if (!rcu_dereference(tun->steering_prog))
1076 tun_automq_xmit(tun, skb);
1078 netif_info(tun, tx_queued, tun->dev, "%s %d\n", __func__, skb->len);
1080 /* Drop if the filter does not like it.
1081 * This is a noop if the filter is disabled.
1082 * Filter can be enabled only for the TAP devices. */
1083 if (!check_filter(&tun->txflt, skb)) {
1084 drop_reason = SKB_DROP_REASON_TAP_TXFILTER;
1088 if (tfile->socket.sk->sk_filter &&
1089 sk_filter(tfile->socket.sk, skb)) {
1090 drop_reason = SKB_DROP_REASON_SOCKET_FILTER;
1094 len = run_ebpf_filter(tun, skb, len);
1096 drop_reason = SKB_DROP_REASON_TAP_FILTER;
1100 if (pskb_trim(skb, len)) {
1101 drop_reason = SKB_DROP_REASON_NOMEM;
1105 if (unlikely(skb_orphan_frags_rx(skb, GFP_ATOMIC))) {
1106 drop_reason = SKB_DROP_REASON_SKB_UCOPY_FAULT;
1110 skb_tx_timestamp(skb);
1112 /* Orphan the skb - required as we might hang on to it
1113 * for indefinite time.
1119 if (ptr_ring_produce(&tfile->tx_ring, skb)) {
1120 drop_reason = SKB_DROP_REASON_FULL_RING;
1124 /* NETIF_F_LLTX requires to do our own update of trans_start */
1125 queue = netdev_get_tx_queue(dev, txq);
1126 txq_trans_cond_update(queue);
1128 /* Notify and wake up reader process */
1129 if (tfile->flags & TUN_FASYNC)
1130 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1131 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1134 return NETDEV_TX_OK;
1137 dev_core_stats_tx_dropped_inc(dev);
1139 kfree_skb_reason(skb, drop_reason);
1141 return NET_XMIT_DROP;
1144 static void tun_net_mclist(struct net_device *dev)
1147 * This callback is supposed to deal with mc filter in
1148 * _rx_ path and has nothing to do with the _tx_ path.
1149 * In rx path we always accept everything userspace gives us.
1153 static netdev_features_t tun_net_fix_features(struct net_device *dev,
1154 netdev_features_t features)
1156 struct tun_struct *tun = netdev_priv(dev);
1158 return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
1161 static void tun_set_headroom(struct net_device *dev, int new_hr)
1163 struct tun_struct *tun = netdev_priv(dev);
1165 if (new_hr < NET_SKB_PAD)
1166 new_hr = NET_SKB_PAD;
1168 tun->align = new_hr;
1172 tun_net_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats)
1174 struct tun_struct *tun = netdev_priv(dev);
1176 dev_get_tstats64(dev, stats);
1178 stats->rx_frame_errors +=
1179 (unsigned long)atomic_long_read(&tun->rx_frame_errors);
1182 static int tun_xdp_set(struct net_device *dev, struct bpf_prog *prog,
1183 struct netlink_ext_ack *extack)
1185 struct tun_struct *tun = netdev_priv(dev);
1186 struct tun_file *tfile;
1187 struct bpf_prog *old_prog;
1190 old_prog = rtnl_dereference(tun->xdp_prog);
1191 rcu_assign_pointer(tun->xdp_prog, prog);
1193 bpf_prog_put(old_prog);
1195 for (i = 0; i < tun->numqueues; i++) {
1196 tfile = rtnl_dereference(tun->tfiles[i]);
1198 sock_set_flag(&tfile->sk, SOCK_XDP);
1200 sock_reset_flag(&tfile->sk, SOCK_XDP);
1202 list_for_each_entry(tfile, &tun->disabled, next) {
1204 sock_set_flag(&tfile->sk, SOCK_XDP);
1206 sock_reset_flag(&tfile->sk, SOCK_XDP);
1212 static int tun_xdp(struct net_device *dev, struct netdev_bpf *xdp)
1214 switch (xdp->command) {
1215 case XDP_SETUP_PROG:
1216 return tun_xdp_set(dev, xdp->prog, xdp->extack);
1222 static int tun_net_change_carrier(struct net_device *dev, bool new_carrier)
1225 struct tun_struct *tun = netdev_priv(dev);
1227 if (!tun->numqueues)
1230 netif_carrier_on(dev);
1232 netif_carrier_off(dev);
1237 static const struct net_device_ops tun_netdev_ops = {
1238 .ndo_init = tun_net_init,
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_select_queue = tun_select_queue,
1245 .ndo_set_rx_headroom = tun_set_headroom,
1246 .ndo_get_stats64 = tun_net_get_stats64,
1247 .ndo_change_carrier = tun_net_change_carrier,
1250 static void __tun_xdp_flush_tfile(struct tun_file *tfile)
1252 /* Notify and wake up reader process */
1253 if (tfile->flags & TUN_FASYNC)
1254 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1255 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1258 static int tun_xdp_xmit(struct net_device *dev, int n,
1259 struct xdp_frame **frames, u32 flags)
1261 struct tun_struct *tun = netdev_priv(dev);
1262 struct tun_file *tfile;
1267 if (unlikely(flags & ~XDP_XMIT_FLAGS_MASK))
1273 numqueues = READ_ONCE(tun->numqueues);
1276 return -ENXIO; /* Caller will free/return all frames */
1279 tfile = rcu_dereference(tun->tfiles[smp_processor_id() %
1281 if (unlikely(!tfile))
1284 spin_lock(&tfile->tx_ring.producer_lock);
1285 for (i = 0; i < n; i++) {
1286 struct xdp_frame *xdp = frames[i];
1287 /* Encode the XDP flag into lowest bit for consumer to differ
1288 * XDP buffer from sk_buff.
1290 void *frame = tun_xdp_to_ptr(xdp);
1292 if (__ptr_ring_produce(&tfile->tx_ring, frame)) {
1293 dev_core_stats_tx_dropped_inc(dev);
1298 spin_unlock(&tfile->tx_ring.producer_lock);
1300 if (flags & XDP_XMIT_FLUSH)
1301 __tun_xdp_flush_tfile(tfile);
1307 static int tun_xdp_tx(struct net_device *dev, struct xdp_buff *xdp)
1309 struct xdp_frame *frame = xdp_convert_buff_to_frame(xdp);
1312 if (unlikely(!frame))
1315 nxmit = tun_xdp_xmit(dev, 1, &frame, XDP_XMIT_FLUSH);
1317 xdp_return_frame_rx_napi(frame);
1321 static const struct net_device_ops tap_netdev_ops = {
1322 .ndo_init = tun_net_init,
1323 .ndo_uninit = tun_net_uninit,
1324 .ndo_open = tun_net_open,
1325 .ndo_stop = tun_net_close,
1326 .ndo_start_xmit = tun_net_xmit,
1327 .ndo_fix_features = tun_net_fix_features,
1328 .ndo_set_rx_mode = tun_net_mclist,
1329 .ndo_set_mac_address = eth_mac_addr,
1330 .ndo_validate_addr = eth_validate_addr,
1331 .ndo_select_queue = tun_select_queue,
1332 .ndo_features_check = passthru_features_check,
1333 .ndo_set_rx_headroom = tun_set_headroom,
1334 .ndo_get_stats64 = dev_get_tstats64,
1336 .ndo_xdp_xmit = tun_xdp_xmit,
1337 .ndo_change_carrier = tun_net_change_carrier,
1340 static void tun_flow_init(struct tun_struct *tun)
1344 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
1345 INIT_HLIST_HEAD(&tun->flows[i]);
1347 tun->ageing_time = TUN_FLOW_EXPIRE;
1348 timer_setup(&tun->flow_gc_timer, tun_flow_cleanup, 0);
1349 mod_timer(&tun->flow_gc_timer,
1350 round_jiffies_up(jiffies + tun->ageing_time));
1353 static void tun_flow_uninit(struct tun_struct *tun)
1355 del_timer_sync(&tun->flow_gc_timer);
1356 tun_flow_flush(tun);
1360 #define MAX_MTU 65535
1362 /* Initialize net device. */
1363 static void tun_net_initialize(struct net_device *dev)
1365 struct tun_struct *tun = netdev_priv(dev);
1367 switch (tun->flags & TUN_TYPE_MASK) {
1369 dev->netdev_ops = &tun_netdev_ops;
1370 dev->header_ops = &ip_tunnel_header_ops;
1372 /* Point-to-Point TUN Device */
1373 dev->hard_header_len = 0;
1377 /* Zero header length */
1378 dev->type = ARPHRD_NONE;
1379 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
1383 dev->netdev_ops = &tap_netdev_ops;
1384 /* Ethernet TAP Device */
1386 dev->priv_flags &= ~IFF_TX_SKB_SHARING;
1387 dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
1389 eth_hw_addr_random(dev);
1394 dev->min_mtu = MIN_MTU;
1395 dev->max_mtu = MAX_MTU - dev->hard_header_len;
1398 static bool tun_sock_writeable(struct tun_struct *tun, struct tun_file *tfile)
1400 struct sock *sk = tfile->socket.sk;
1402 return (tun->dev->flags & IFF_UP) && sock_writeable(sk);
1405 /* Character device part */
1408 static __poll_t tun_chr_poll(struct file *file, poll_table *wait)
1410 struct tun_file *tfile = file->private_data;
1411 struct tun_struct *tun = tun_get(tfile);
1418 sk = tfile->socket.sk;
1420 poll_wait(file, sk_sleep(sk), wait);
1422 if (!ptr_ring_empty(&tfile->tx_ring))
1423 mask |= EPOLLIN | EPOLLRDNORM;
1425 /* Make sure SOCKWQ_ASYNC_NOSPACE is set if not writable to
1426 * guarantee EPOLLOUT to be raised by either here or
1427 * tun_sock_write_space(). Then process could get notification
1428 * after it writes to a down device and meets -EIO.
1430 if (tun_sock_writeable(tun, tfile) ||
1431 (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
1432 tun_sock_writeable(tun, tfile)))
1433 mask |= EPOLLOUT | EPOLLWRNORM;
1435 if (tun->dev->reg_state != NETREG_REGISTERED)
1442 static struct sk_buff *tun_napi_alloc_frags(struct tun_file *tfile,
1444 const struct iov_iter *it)
1446 struct sk_buff *skb;
1451 if (it->nr_segs > MAX_SKB_FRAGS + 1)
1452 return ERR_PTR(-EMSGSIZE);
1455 skb = napi_get_frags(&tfile->napi);
1458 return ERR_PTR(-ENOMEM);
1460 linear = iov_iter_single_seg_count(it);
1461 err = __skb_grow(skb, linear);
1466 skb->data_len = len - linear;
1467 skb->truesize += skb->data_len;
1469 for (i = 1; i < it->nr_segs; i++) {
1470 size_t fragsz = it->iov[i].iov_len;
1474 if (fragsz == 0 || fragsz > PAGE_SIZE) {
1478 frag = netdev_alloc_frag(fragsz);
1483 page = virt_to_head_page(frag);
1484 skb_fill_page_desc(skb, i - 1, page,
1485 frag - page_address(page), fragsz);
1490 /* frees skb and all frags allocated with napi_alloc_frag() */
1491 napi_free_frags(&tfile->napi);
1492 return ERR_PTR(err);
1495 /* prepad is the amount to reserve at front. len is length after that.
1496 * linear is a hint as to how much to copy (usually headers). */
1497 static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
1498 size_t prepad, size_t len,
1499 size_t linear, int noblock)
1501 struct sock *sk = tfile->socket.sk;
1502 struct sk_buff *skb;
1505 /* Under a page? Don't bother with paged skb. */
1506 if (prepad + len < PAGE_SIZE || !linear)
1509 skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
1512 return ERR_PTR(err);
1514 skb_reserve(skb, prepad);
1515 skb_put(skb, linear);
1516 skb->data_len = len - linear;
1517 skb->len += len - linear;
1522 static void tun_rx_batched(struct tun_struct *tun, struct tun_file *tfile,
1523 struct sk_buff *skb, int more)
1525 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1526 struct sk_buff_head process_queue;
1527 u32 rx_batched = tun->rx_batched;
1530 if (!rx_batched || (!more && skb_queue_empty(queue))) {
1532 skb_record_rx_queue(skb, tfile->queue_index);
1533 netif_receive_skb(skb);
1538 spin_lock(&queue->lock);
1539 if (!more || skb_queue_len(queue) == rx_batched) {
1540 __skb_queue_head_init(&process_queue);
1541 skb_queue_splice_tail_init(queue, &process_queue);
1544 __skb_queue_tail(queue, skb);
1546 spin_unlock(&queue->lock);
1549 struct sk_buff *nskb;
1552 while ((nskb = __skb_dequeue(&process_queue))) {
1553 skb_record_rx_queue(nskb, tfile->queue_index);
1554 netif_receive_skb(nskb);
1556 skb_record_rx_queue(skb, tfile->queue_index);
1557 netif_receive_skb(skb);
1562 static bool tun_can_build_skb(struct tun_struct *tun, struct tun_file *tfile,
1563 int len, int noblock, bool zerocopy)
1565 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
1568 if (tfile->socket.sk->sk_sndbuf != INT_MAX)
1577 if (SKB_DATA_ALIGN(len + TUN_RX_PAD) +
1578 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
1584 static struct sk_buff *__tun_build_skb(struct tun_file *tfile,
1585 struct page_frag *alloc_frag, char *buf,
1586 int buflen, int len, int pad)
1588 struct sk_buff *skb = build_skb(buf, buflen);
1591 return ERR_PTR(-ENOMEM);
1593 skb_reserve(skb, pad);
1595 skb_set_owner_w(skb, tfile->socket.sk);
1597 get_page(alloc_frag->page);
1598 alloc_frag->offset += buflen;
1603 static int tun_xdp_act(struct tun_struct *tun, struct bpf_prog *xdp_prog,
1604 struct xdp_buff *xdp, u32 act)
1610 err = xdp_do_redirect(tun->dev, xdp, xdp_prog);
1615 err = tun_xdp_tx(tun->dev, xdp);
1622 bpf_warn_invalid_xdp_action(tun->dev, xdp_prog, act);
1625 trace_xdp_exception(tun->dev, xdp_prog, act);
1628 dev_core_stats_rx_dropped_inc(tun->dev);
1635 static struct sk_buff *tun_build_skb(struct tun_struct *tun,
1636 struct tun_file *tfile,
1637 struct iov_iter *from,
1638 struct virtio_net_hdr *hdr,
1639 int len, int *skb_xdp)
1641 struct page_frag *alloc_frag = ¤t->task_frag;
1642 struct bpf_prog *xdp_prog;
1643 int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
1646 int pad = TUN_RX_PAD;
1650 xdp_prog = rcu_dereference(tun->xdp_prog);
1652 pad += XDP_PACKET_HEADROOM;
1653 buflen += SKB_DATA_ALIGN(len + pad);
1656 alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
1657 if (unlikely(!skb_page_frag_refill(buflen, alloc_frag, GFP_KERNEL)))
1658 return ERR_PTR(-ENOMEM);
1660 buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
1661 copied = copy_page_from_iter(alloc_frag->page,
1662 alloc_frag->offset + pad,
1665 return ERR_PTR(-EFAULT);
1667 /* There's a small window that XDP may be set after the check
1668 * of xdp_prog above, this should be rare and for simplicity
1669 * we do XDP on skb in case the headroom is not enough.
1671 if (hdr->gso_type || !xdp_prog) {
1673 return __tun_build_skb(tfile, alloc_frag, buf, buflen, len,
1681 xdp_prog = rcu_dereference(tun->xdp_prog);
1683 struct xdp_buff xdp;
1686 xdp_init_buff(&xdp, buflen, &tfile->xdp_rxq);
1687 xdp_prepare_buff(&xdp, buf, pad, len, false);
1689 act = bpf_prog_run_xdp(xdp_prog, &xdp);
1690 if (act == XDP_REDIRECT || act == XDP_TX) {
1691 get_page(alloc_frag->page);
1692 alloc_frag->offset += buflen;
1694 err = tun_xdp_act(tun, xdp_prog, &xdp, act);
1696 if (act == XDP_REDIRECT || act == XDP_TX)
1697 put_page(alloc_frag->page);
1701 if (err == XDP_REDIRECT)
1703 if (err != XDP_PASS)
1706 pad = xdp.data - xdp.data_hard_start;
1707 len = xdp.data_end - xdp.data;
1712 return __tun_build_skb(tfile, alloc_frag, buf, buflen, len, pad);
1720 /* Get packet from user space buffer */
1721 static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
1722 void *msg_control, struct iov_iter *from,
1723 int noblock, bool more)
1725 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1726 struct sk_buff *skb;
1727 size_t total_len = iov_iter_count(from);
1728 size_t len = total_len, align = tun->align, linear;
1729 struct virtio_net_hdr gso = { 0 };
1732 bool zerocopy = false;
1736 bool frags = tun_napi_frags_enabled(tfile);
1737 enum skb_drop_reason drop_reason;
1739 if (!(tun->flags & IFF_NO_PI)) {
1740 if (len < sizeof(pi))
1744 if (!copy_from_iter_full(&pi, sizeof(pi), from))
1748 if (tun->flags & IFF_VNET_HDR) {
1749 int vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1751 if (len < vnet_hdr_sz)
1755 if (!copy_from_iter_full(&gso, sizeof(gso), from))
1758 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
1759 tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1760 gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
1762 if (tun16_to_cpu(tun, gso.hdr_len) > len)
1764 iov_iter_advance(from, vnet_hdr_sz - sizeof(gso));
1767 if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
1768 align += NET_IP_ALIGN;
1769 if (unlikely(len < ETH_HLEN ||
1770 (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
1774 good_linear = SKB_MAX_HEAD(align);
1777 struct iov_iter i = *from;
1779 /* There are 256 bytes to be copied in skb, so there is
1780 * enough room for skb expand head in case it is used.
1781 * The rest of the buffer is mapped from userspace.
1783 copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
1784 if (copylen > good_linear)
1785 copylen = good_linear;
1787 iov_iter_advance(&i, copylen);
1788 if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
1792 if (!frags && tun_can_build_skb(tun, tfile, len, noblock, zerocopy)) {
1793 /* For the packet that is not easy to be processed
1794 * (e.g gso or jumbo packet), we will do it at after
1795 * skb was created with generic XDP routine.
1797 skb = tun_build_skb(tun, tfile, from, &gso, len, &skb_xdp);
1799 dev_core_stats_rx_dropped_inc(tun->dev);
1800 return PTR_ERR(skb);
1807 if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1808 linear = good_linear;
1810 linear = tun16_to_cpu(tun, gso.hdr_len);
1814 mutex_lock(&tfile->napi_mutex);
1815 skb = tun_napi_alloc_frags(tfile, copylen, from);
1816 /* tun_napi_alloc_frags() enforces a layout for the skb.
1817 * If zerocopy is enabled, then this layout will be
1818 * overwritten by zerocopy_sg_from_iter().
1822 skb = tun_alloc_skb(tfile, align, copylen, linear,
1827 if (PTR_ERR(skb) != -EAGAIN)
1828 dev_core_stats_rx_dropped_inc(tun->dev);
1830 mutex_unlock(&tfile->napi_mutex);
1831 return PTR_ERR(skb);
1835 err = zerocopy_sg_from_iter(skb, from);
1837 err = skb_copy_datagram_from_iter(skb, 0, from, len);
1841 drop_reason = SKB_DROP_REASON_SKB_UCOPY_FAULT;
1843 dev_core_stats_rx_dropped_inc(tun->dev);
1844 kfree_skb_reason(skb, drop_reason);
1846 tfile->napi.skb = NULL;
1847 mutex_unlock(&tfile->napi_mutex);
1854 if (virtio_net_hdr_to_skb(skb, &gso, tun_is_little_endian(tun))) {
1855 atomic_long_inc(&tun->rx_frame_errors);
1858 tfile->napi.skb = NULL;
1859 mutex_unlock(&tfile->napi_mutex);
1865 switch (tun->flags & TUN_TYPE_MASK) {
1867 if (tun->flags & IFF_NO_PI) {
1868 u8 ip_version = skb->len ? (skb->data[0] >> 4) : 0;
1870 switch (ip_version) {
1872 pi.proto = htons(ETH_P_IP);
1875 pi.proto = htons(ETH_P_IPV6);
1878 dev_core_stats_rx_dropped_inc(tun->dev);
1884 skb_reset_mac_header(skb);
1885 skb->protocol = pi.proto;
1886 skb->dev = tun->dev;
1889 if (frags && !pskb_may_pull(skb, ETH_HLEN)) {
1891 drop_reason = SKB_DROP_REASON_HDR_TRUNC;
1894 skb->protocol = eth_type_trans(skb, tun->dev);
1898 /* copy skb_ubuf_info for callback when skb has no error */
1900 skb_zcopy_init(skb, msg_control);
1901 } else if (msg_control) {
1902 struct ubuf_info *uarg = msg_control;
1903 uarg->callback(NULL, uarg, false);
1906 skb_reset_network_header(skb);
1907 skb_probe_transport_header(skb);
1908 skb_record_rx_queue(skb, tfile->queue_index);
1911 struct bpf_prog *xdp_prog;
1916 xdp_prog = rcu_dereference(tun->xdp_prog);
1918 ret = do_xdp_generic(xdp_prog, skb);
1919 if (ret != XDP_PASS) {
1923 tfile->napi.skb = NULL;
1924 mutex_unlock(&tfile->napi_mutex);
1933 /* Compute the costly rx hash only if needed for flow updates.
1934 * We may get a very small possibility of OOO during switching, not
1935 * worth to optimize.
1937 if (!rcu_access_pointer(tun->steering_prog) && tun->numqueues > 1 &&
1939 rxhash = __skb_get_hash_symmetric(skb);
1942 if (unlikely(!(tun->dev->flags & IFF_UP))) {
1945 drop_reason = SKB_DROP_REASON_DEV_READY;
1952 /* Exercise flow dissector code path. */
1953 skb_push(skb, ETH_HLEN);
1954 headlen = eth_get_headlen(tun->dev, skb->data,
1957 if (unlikely(headlen > skb_headlen(skb))) {
1958 dev_core_stats_rx_dropped_inc(tun->dev);
1959 napi_free_frags(&tfile->napi);
1961 mutex_unlock(&tfile->napi_mutex);
1967 napi_gro_frags(&tfile->napi);
1969 mutex_unlock(&tfile->napi_mutex);
1970 } else if (tfile->napi_enabled) {
1971 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1974 spin_lock_bh(&queue->lock);
1975 __skb_queue_tail(queue, skb);
1976 queue_len = skb_queue_len(queue);
1977 spin_unlock(&queue->lock);
1979 if (!more || queue_len > NAPI_POLL_WEIGHT)
1980 napi_schedule(&tfile->napi);
1983 } else if (!IS_ENABLED(CONFIG_4KSTACKS)) {
1984 tun_rx_batched(tun, tfile, skb, more);
1991 dev_sw_netstats_rx_add(tun->dev, len);
1995 tun_flow_update(tun, rxhash, tfile);
2000 static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
2002 struct file *file = iocb->ki_filp;
2003 struct tun_file *tfile = file->private_data;
2004 struct tun_struct *tun = tun_get(tfile);
2011 if ((file->f_flags & O_NONBLOCK) || (iocb->ki_flags & IOCB_NOWAIT))
2014 result = tun_get_user(tun, tfile, NULL, from, noblock, false);
2020 static ssize_t tun_put_user_xdp(struct tun_struct *tun,
2021 struct tun_file *tfile,
2022 struct xdp_frame *xdp_frame,
2023 struct iov_iter *iter)
2025 int vnet_hdr_sz = 0;
2026 size_t size = xdp_frame->len;
2029 if (tun->flags & IFF_VNET_HDR) {
2030 struct virtio_net_hdr gso = { 0 };
2032 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2033 if (unlikely(iov_iter_count(iter) < vnet_hdr_sz))
2035 if (unlikely(copy_to_iter(&gso, sizeof(gso), iter) !=
2038 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2041 ret = copy_to_iter(xdp_frame->data, size, iter) + vnet_hdr_sz;
2044 dev_sw_netstats_tx_add(tun->dev, 1, ret);
2050 /* Put packet to the user space buffer */
2051 static ssize_t tun_put_user(struct tun_struct *tun,
2052 struct tun_file *tfile,
2053 struct sk_buff *skb,
2054 struct iov_iter *iter)
2056 struct tun_pi pi = { 0, skb->protocol };
2058 int vlan_offset = 0;
2060 int vnet_hdr_sz = 0;
2062 if (skb_vlan_tag_present(skb))
2063 vlan_hlen = VLAN_HLEN;
2065 if (tun->flags & IFF_VNET_HDR)
2066 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2068 total = skb->len + vlan_hlen + vnet_hdr_sz;
2070 if (!(tun->flags & IFF_NO_PI)) {
2071 if (iov_iter_count(iter) < sizeof(pi))
2074 total += sizeof(pi);
2075 if (iov_iter_count(iter) < total) {
2076 /* Packet will be striped */
2077 pi.flags |= TUN_PKT_STRIP;
2080 if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
2085 struct virtio_net_hdr gso;
2087 if (iov_iter_count(iter) < vnet_hdr_sz)
2090 if (virtio_net_hdr_from_skb(skb, &gso,
2091 tun_is_little_endian(tun), true,
2093 struct skb_shared_info *sinfo = skb_shinfo(skb);
2094 pr_err("unexpected GSO type: "
2095 "0x%x, gso_size %d, hdr_len %d\n",
2096 sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
2097 tun16_to_cpu(tun, gso.hdr_len));
2098 print_hex_dump(KERN_ERR, "tun: ",
2101 min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
2106 if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
2109 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2116 veth.h_vlan_proto = skb->vlan_proto;
2117 veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
2119 vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
2121 ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
2122 if (ret || !iov_iter_count(iter))
2125 ret = copy_to_iter(&veth, sizeof(veth), iter);
2126 if (ret != sizeof(veth) || !iov_iter_count(iter))
2130 skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
2133 /* caller is in process context, */
2135 dev_sw_netstats_tx_add(tun->dev, 1, skb->len + vlan_hlen);
2141 static void *tun_ring_recv(struct tun_file *tfile, int noblock, int *err)
2143 DECLARE_WAITQUEUE(wait, current);
2147 ptr = ptr_ring_consume(&tfile->tx_ring);
2155 add_wait_queue(&tfile->socket.wq.wait, &wait);
2158 set_current_state(TASK_INTERRUPTIBLE);
2159 ptr = ptr_ring_consume(&tfile->tx_ring);
2162 if (signal_pending(current)) {
2163 error = -ERESTARTSYS;
2166 if (tfile->socket.sk->sk_shutdown & RCV_SHUTDOWN) {
2174 __set_current_state(TASK_RUNNING);
2175 remove_wait_queue(&tfile->socket.wq.wait, &wait);
2182 static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
2183 struct iov_iter *to,
2184 int noblock, void *ptr)
2189 if (!iov_iter_count(to)) {
2195 /* Read frames from ring */
2196 ptr = tun_ring_recv(tfile, noblock, &err);
2201 if (tun_is_xdp_frame(ptr)) {
2202 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2204 ret = tun_put_user_xdp(tun, tfile, xdpf, to);
2205 xdp_return_frame(xdpf);
2207 struct sk_buff *skb = ptr;
2209 ret = tun_put_user(tun, tfile, skb, to);
2210 if (unlikely(ret < 0))
2219 static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
2221 struct file *file = iocb->ki_filp;
2222 struct tun_file *tfile = file->private_data;
2223 struct tun_struct *tun = tun_get(tfile);
2224 ssize_t len = iov_iter_count(to), ret;
2230 if ((file->f_flags & O_NONBLOCK) || (iocb->ki_flags & IOCB_NOWAIT))
2233 ret = tun_do_read(tun, tfile, to, noblock, NULL);
2234 ret = min_t(ssize_t, ret, len);
2241 static void tun_prog_free(struct rcu_head *rcu)
2243 struct tun_prog *prog = container_of(rcu, struct tun_prog, rcu);
2245 bpf_prog_destroy(prog->prog);
2249 static int __tun_set_ebpf(struct tun_struct *tun,
2250 struct tun_prog __rcu **prog_p,
2251 struct bpf_prog *prog)
2253 struct tun_prog *old, *new = NULL;
2256 new = kmalloc(sizeof(*new), GFP_KERNEL);
2262 spin_lock_bh(&tun->lock);
2263 old = rcu_dereference_protected(*prog_p,
2264 lockdep_is_held(&tun->lock));
2265 rcu_assign_pointer(*prog_p, new);
2266 spin_unlock_bh(&tun->lock);
2269 call_rcu(&old->rcu, tun_prog_free);
2274 static void tun_free_netdev(struct net_device *dev)
2276 struct tun_struct *tun = netdev_priv(dev);
2278 BUG_ON(!(list_empty(&tun->disabled)));
2280 free_percpu(dev->tstats);
2281 tun_flow_uninit(tun);
2282 security_tun_dev_free_security(tun->security);
2283 __tun_set_ebpf(tun, &tun->steering_prog, NULL);
2284 __tun_set_ebpf(tun, &tun->filter_prog, NULL);
2287 static void tun_setup(struct net_device *dev)
2289 struct tun_struct *tun = netdev_priv(dev);
2291 tun->owner = INVALID_UID;
2292 tun->group = INVALID_GID;
2293 tun_default_link_ksettings(dev, &tun->link_ksettings);
2295 dev->ethtool_ops = &tun_ethtool_ops;
2296 dev->needs_free_netdev = true;
2297 dev->priv_destructor = tun_free_netdev;
2298 /* We prefer our own queue length */
2299 dev->tx_queue_len = TUN_READQ_SIZE;
2302 /* Trivial set of netlink ops to allow deleting tun or tap
2303 * device with netlink.
2305 static int tun_validate(struct nlattr *tb[], struct nlattr *data[],
2306 struct netlink_ext_ack *extack)
2308 NL_SET_ERR_MSG(extack,
2309 "tun/tap creation via rtnetlink is not supported.");
2313 static size_t tun_get_size(const struct net_device *dev)
2315 BUILD_BUG_ON(sizeof(u32) != sizeof(uid_t));
2316 BUILD_BUG_ON(sizeof(u32) != sizeof(gid_t));
2318 return nla_total_size(sizeof(uid_t)) + /* OWNER */
2319 nla_total_size(sizeof(gid_t)) + /* GROUP */
2320 nla_total_size(sizeof(u8)) + /* TYPE */
2321 nla_total_size(sizeof(u8)) + /* PI */
2322 nla_total_size(sizeof(u8)) + /* VNET_HDR */
2323 nla_total_size(sizeof(u8)) + /* PERSIST */
2324 nla_total_size(sizeof(u8)) + /* MULTI_QUEUE */
2325 nla_total_size(sizeof(u32)) + /* NUM_QUEUES */
2326 nla_total_size(sizeof(u32)) + /* NUM_DISABLED_QUEUES */
2330 static int tun_fill_info(struct sk_buff *skb, const struct net_device *dev)
2332 struct tun_struct *tun = netdev_priv(dev);
2334 if (nla_put_u8(skb, IFLA_TUN_TYPE, tun->flags & TUN_TYPE_MASK))
2335 goto nla_put_failure;
2336 if (uid_valid(tun->owner) &&
2337 nla_put_u32(skb, IFLA_TUN_OWNER,
2338 from_kuid_munged(current_user_ns(), tun->owner)))
2339 goto nla_put_failure;
2340 if (gid_valid(tun->group) &&
2341 nla_put_u32(skb, IFLA_TUN_GROUP,
2342 from_kgid_munged(current_user_ns(), tun->group)))
2343 goto nla_put_failure;
2344 if (nla_put_u8(skb, IFLA_TUN_PI, !(tun->flags & IFF_NO_PI)))
2345 goto nla_put_failure;
2346 if (nla_put_u8(skb, IFLA_TUN_VNET_HDR, !!(tun->flags & IFF_VNET_HDR)))
2347 goto nla_put_failure;
2348 if (nla_put_u8(skb, IFLA_TUN_PERSIST, !!(tun->flags & IFF_PERSIST)))
2349 goto nla_put_failure;
2350 if (nla_put_u8(skb, IFLA_TUN_MULTI_QUEUE,
2351 !!(tun->flags & IFF_MULTI_QUEUE)))
2352 goto nla_put_failure;
2353 if (tun->flags & IFF_MULTI_QUEUE) {
2354 if (nla_put_u32(skb, IFLA_TUN_NUM_QUEUES, tun->numqueues))
2355 goto nla_put_failure;
2356 if (nla_put_u32(skb, IFLA_TUN_NUM_DISABLED_QUEUES,
2358 goto nla_put_failure;
2367 static struct rtnl_link_ops tun_link_ops __read_mostly = {
2369 .priv_size = sizeof(struct tun_struct),
2371 .validate = tun_validate,
2372 .get_size = tun_get_size,
2373 .fill_info = tun_fill_info,
2376 static void tun_sock_write_space(struct sock *sk)
2378 struct tun_file *tfile;
2379 wait_queue_head_t *wqueue;
2381 if (!sock_writeable(sk))
2384 if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
2387 wqueue = sk_sleep(sk);
2388 if (wqueue && waitqueue_active(wqueue))
2389 wake_up_interruptible_sync_poll(wqueue, EPOLLOUT |
2390 EPOLLWRNORM | EPOLLWRBAND);
2392 tfile = container_of(sk, struct tun_file, sk);
2393 kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
2396 static void tun_put_page(struct tun_page *tpage)
2399 __page_frag_cache_drain(tpage->page, tpage->count);
2402 static int tun_xdp_one(struct tun_struct *tun,
2403 struct tun_file *tfile,
2404 struct xdp_buff *xdp, int *flush,
2405 struct tun_page *tpage)
2407 unsigned int datasize = xdp->data_end - xdp->data;
2408 struct tun_xdp_hdr *hdr = xdp->data_hard_start;
2409 struct virtio_net_hdr *gso = &hdr->gso;
2410 struct bpf_prog *xdp_prog;
2411 struct sk_buff *skb = NULL;
2412 struct sk_buff_head *queue;
2413 u32 rxhash = 0, act;
2414 int buflen = hdr->buflen;
2416 bool skb_xdp = false;
2419 xdp_prog = rcu_dereference(tun->xdp_prog);
2421 if (gso->gso_type) {
2426 xdp_init_buff(xdp, buflen, &tfile->xdp_rxq);
2427 xdp_set_data_meta_invalid(xdp);
2429 act = bpf_prog_run_xdp(xdp_prog, xdp);
2430 ret = tun_xdp_act(tun, xdp_prog, xdp, act);
2432 put_page(virt_to_head_page(xdp->data));
2445 page = virt_to_head_page(xdp->data);
2446 if (tpage->page == page) {
2449 tun_put_page(tpage);
2458 skb = build_skb(xdp->data_hard_start, buflen);
2464 skb_reserve(skb, xdp->data - xdp->data_hard_start);
2465 skb_put(skb, xdp->data_end - xdp->data);
2467 if (virtio_net_hdr_to_skb(skb, gso, tun_is_little_endian(tun))) {
2468 atomic_long_inc(&tun->rx_frame_errors);
2474 skb->protocol = eth_type_trans(skb, tun->dev);
2475 skb_reset_network_header(skb);
2476 skb_probe_transport_header(skb);
2477 skb_record_rx_queue(skb, tfile->queue_index);
2480 ret = do_xdp_generic(xdp_prog, skb);
2481 if (ret != XDP_PASS) {
2487 if (!rcu_dereference(tun->steering_prog) && tun->numqueues > 1 &&
2489 rxhash = __skb_get_hash_symmetric(skb);
2491 if (tfile->napi_enabled) {
2492 queue = &tfile->sk.sk_write_queue;
2493 spin_lock(&queue->lock);
2494 __skb_queue_tail(queue, skb);
2495 spin_unlock(&queue->lock);
2498 netif_receive_skb(skb);
2502 /* No need to disable preemption here since this function is
2503 * always called with bh disabled
2505 dev_sw_netstats_rx_add(tun->dev, datasize);
2508 tun_flow_update(tun, rxhash, tfile);
2514 static int tun_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
2517 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2518 struct tun_struct *tun = tun_get(tfile);
2519 struct tun_msg_ctl *ctl = m->msg_control;
2520 struct xdp_buff *xdp;
2525 if (m->msg_controllen == sizeof(struct tun_msg_ctl) &&
2526 ctl && ctl->type == TUN_MSG_PTR) {
2527 struct tun_page tpage;
2529 int flush = 0, queued = 0;
2531 memset(&tpage, 0, sizeof(tpage));
2536 for (i = 0; i < n; i++) {
2537 xdp = &((struct xdp_buff *)ctl->ptr)[i];
2538 ret = tun_xdp_one(tun, tfile, xdp, &flush, &tpage);
2546 if (tfile->napi_enabled && queued > 0)
2547 napi_schedule(&tfile->napi);
2552 tun_put_page(&tpage);
2558 ret = tun_get_user(tun, tfile, ctl ? ctl->ptr : NULL, &m->msg_iter,
2559 m->msg_flags & MSG_DONTWAIT,
2560 m->msg_flags & MSG_MORE);
2566 static int tun_recvmsg(struct socket *sock, struct msghdr *m, size_t total_len,
2569 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2570 struct tun_struct *tun = tun_get(tfile);
2571 void *ptr = m->msg_control;
2579 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
2583 if (flags & MSG_ERRQUEUE) {
2584 ret = sock_recv_errqueue(sock->sk, m, total_len,
2585 SOL_PACKET, TUN_TX_TIMESTAMP);
2588 ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT, ptr);
2589 if (ret > (ssize_t)total_len) {
2590 m->msg_flags |= MSG_TRUNC;
2591 ret = flags & MSG_TRUNC ? ret : total_len;
2604 static int tun_ptr_peek_len(void *ptr)
2607 if (tun_is_xdp_frame(ptr)) {
2608 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
2612 return __skb_array_len_with_tag(ptr);
2618 static int tun_peek_len(struct socket *sock)
2620 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2621 struct tun_struct *tun;
2624 tun = tun_get(tfile);
2628 ret = PTR_RING_PEEK_CALL(&tfile->tx_ring, tun_ptr_peek_len);
2634 /* Ops structure to mimic raw sockets with tun */
2635 static const struct proto_ops tun_socket_ops = {
2636 .peek_len = tun_peek_len,
2637 .sendmsg = tun_sendmsg,
2638 .recvmsg = tun_recvmsg,
2641 static struct proto tun_proto = {
2643 .owner = THIS_MODULE,
2644 .obj_size = sizeof(struct tun_file),
2647 static int tun_flags(struct tun_struct *tun)
2649 return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
2652 static ssize_t tun_flags_show(struct device *dev, struct device_attribute *attr,
2655 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2656 return sprintf(buf, "0x%x\n", tun_flags(tun));
2659 static ssize_t owner_show(struct device *dev, struct device_attribute *attr,
2662 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2663 return uid_valid(tun->owner)?
2664 sprintf(buf, "%u\n",
2665 from_kuid_munged(current_user_ns(), tun->owner)):
2666 sprintf(buf, "-1\n");
2669 static ssize_t group_show(struct device *dev, struct device_attribute *attr,
2672 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
2673 return gid_valid(tun->group) ?
2674 sprintf(buf, "%u\n",
2675 from_kgid_munged(current_user_ns(), tun->group)):
2676 sprintf(buf, "-1\n");
2679 static DEVICE_ATTR_RO(tun_flags);
2680 static DEVICE_ATTR_RO(owner);
2681 static DEVICE_ATTR_RO(group);
2683 static struct attribute *tun_dev_attrs[] = {
2684 &dev_attr_tun_flags.attr,
2685 &dev_attr_owner.attr,
2686 &dev_attr_group.attr,
2690 static const struct attribute_group tun_attr_group = {
2691 .attrs = tun_dev_attrs
2694 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
2696 struct tun_struct *tun;
2697 struct tun_file *tfile = file->private_data;
2698 struct net_device *dev;
2701 if (tfile->detached)
2704 if ((ifr->ifr_flags & IFF_NAPI_FRAGS)) {
2705 if (!capable(CAP_NET_ADMIN))
2708 if (!(ifr->ifr_flags & IFF_NAPI) ||
2709 (ifr->ifr_flags & TUN_TYPE_MASK) != IFF_TAP)
2713 dev = __dev_get_by_name(net, ifr->ifr_name);
2715 if (ifr->ifr_flags & IFF_TUN_EXCL)
2717 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
2718 tun = netdev_priv(dev);
2719 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
2720 tun = netdev_priv(dev);
2724 if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
2725 !!(tun->flags & IFF_MULTI_QUEUE))
2728 if (tun_not_capable(tun))
2730 err = security_tun_dev_open(tun->security);
2734 err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER,
2735 ifr->ifr_flags & IFF_NAPI,
2736 ifr->ifr_flags & IFF_NAPI_FRAGS, true);
2740 if (tun->flags & IFF_MULTI_QUEUE &&
2741 (tun->numqueues + tun->numdisabled > 1)) {
2742 /* One or more queue has already been attached, no need
2743 * to initialize the device again.
2745 netdev_state_change(dev);
2749 tun->flags = (tun->flags & ~TUN_FEATURES) |
2750 (ifr->ifr_flags & TUN_FEATURES);
2752 netdev_state_change(dev);
2755 unsigned long flags = 0;
2756 int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
2759 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
2761 err = security_tun_dev_create();
2766 if (ifr->ifr_flags & IFF_TUN) {
2770 } else if (ifr->ifr_flags & IFF_TAP) {
2778 name = ifr->ifr_name;
2780 dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
2781 NET_NAME_UNKNOWN, tun_setup, queues,
2787 dev_net_set(dev, net);
2788 dev->rtnl_link_ops = &tun_link_ops;
2789 dev->ifindex = tfile->ifindex;
2790 dev->sysfs_groups[0] = &tun_attr_group;
2792 tun = netdev_priv(dev);
2795 tun->txflt.count = 0;
2796 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
2798 tun->align = NET_SKB_PAD;
2799 tun->filter_attached = false;
2800 tun->sndbuf = tfile->socket.sk->sk_sndbuf;
2801 tun->rx_batched = 0;
2802 RCU_INIT_POINTER(tun->steering_prog, NULL);
2807 tun_net_initialize(dev);
2809 err = register_netdevice(tun->dev);
2814 /* free_netdev() won't check refcnt, to avoid race
2815 * with dev_put() we need publish tun after registration.
2817 rcu_assign_pointer(tfile->tun, tun);
2820 netif_carrier_on(tun->dev);
2822 /* Make sure persistent devices do not get stuck in
2825 if (netif_running(tun->dev))
2826 netif_tx_wake_all_queues(tun->dev);
2828 strcpy(ifr->ifr_name, tun->dev->name);
2832 static void tun_get_iff(struct tun_struct *tun, struct ifreq *ifr)
2834 strcpy(ifr->ifr_name, tun->dev->name);
2836 ifr->ifr_flags = tun_flags(tun);
2840 /* This is like a cut-down ethtool ops, except done via tun fd so no
2841 * privs required. */
2842 static int set_offload(struct tun_struct *tun, unsigned long arg)
2844 netdev_features_t features = 0;
2846 if (arg & TUN_F_CSUM) {
2847 features |= NETIF_F_HW_CSUM;
2850 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
2851 if (arg & TUN_F_TSO_ECN) {
2852 features |= NETIF_F_TSO_ECN;
2853 arg &= ~TUN_F_TSO_ECN;
2855 if (arg & TUN_F_TSO4)
2856 features |= NETIF_F_TSO;
2857 if (arg & TUN_F_TSO6)
2858 features |= NETIF_F_TSO6;
2859 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
2865 /* This gives the user a way to test for new features in future by
2866 * trying to set them. */
2870 tun->set_features = features;
2871 tun->dev->wanted_features &= ~TUN_USER_FEATURES;
2872 tun->dev->wanted_features |= features;
2873 netdev_update_features(tun->dev);
2878 static void tun_detach_filter(struct tun_struct *tun, int n)
2881 struct tun_file *tfile;
2883 for (i = 0; i < n; i++) {
2884 tfile = rtnl_dereference(tun->tfiles[i]);
2885 lock_sock(tfile->socket.sk);
2886 sk_detach_filter(tfile->socket.sk);
2887 release_sock(tfile->socket.sk);
2890 tun->filter_attached = false;
2893 static int tun_attach_filter(struct tun_struct *tun)
2896 struct tun_file *tfile;
2898 for (i = 0; i < tun->numqueues; i++) {
2899 tfile = rtnl_dereference(tun->tfiles[i]);
2900 lock_sock(tfile->socket.sk);
2901 ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
2902 release_sock(tfile->socket.sk);
2904 tun_detach_filter(tun, i);
2909 tun->filter_attached = true;
2913 static void tun_set_sndbuf(struct tun_struct *tun)
2915 struct tun_file *tfile;
2918 for (i = 0; i < tun->numqueues; i++) {
2919 tfile = rtnl_dereference(tun->tfiles[i]);
2920 tfile->socket.sk->sk_sndbuf = tun->sndbuf;
2924 static int tun_set_queue(struct file *file, struct ifreq *ifr)
2926 struct tun_file *tfile = file->private_data;
2927 struct tun_struct *tun;
2932 if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
2933 tun = tfile->detached;
2938 ret = security_tun_dev_attach_queue(tun->security);
2941 ret = tun_attach(tun, file, false, tun->flags & IFF_NAPI,
2942 tun->flags & IFF_NAPI_FRAGS, true);
2943 } else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
2944 tun = rtnl_dereference(tfile->tun);
2945 if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
2948 __tun_detach(tfile, false);
2953 netdev_state_change(tun->dev);
2960 static int tun_set_ebpf(struct tun_struct *tun, struct tun_prog __rcu **prog_p,
2963 struct bpf_prog *prog;
2966 if (copy_from_user(&fd, data, sizeof(fd)))
2972 prog = bpf_prog_get_type(fd, BPF_PROG_TYPE_SOCKET_FILTER);
2974 return PTR_ERR(prog);
2977 return __tun_set_ebpf(tun, prog_p, prog);
2980 /* Return correct value for tun->dev->addr_len based on tun->dev->type. */
2981 static unsigned char tun_get_addr_len(unsigned short type)
2985 case ARPHRD_TUNNEL6:
2986 return sizeof(struct in6_addr);
2993 case ARPHRD_IEEE802154:
2994 case ARPHRD_IEEE802154_MONITOR:
2995 return IEEE802154_EXTENDED_ADDR_LEN;
2996 case ARPHRD_PHONET_PIPE:
3000 case ARPHRD_6LOWPAN:
3001 return EUI64_ADDR_LEN;
3006 case ARPHRD_IEEE802:
3009 return ROSE_ADDR_LEN;
3011 return AX25_ADDR_LEN;
3012 case ARPHRD_LOCALTLK:
3019 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
3020 unsigned long arg, int ifreq_len)
3022 struct tun_file *tfile = file->private_data;
3023 struct net *net = sock_net(&tfile->sk);
3024 struct tun_struct *tun;
3025 void __user* argp = (void __user*)arg;
3026 unsigned int ifindex, carrier;
3034 bool do_notify = false;
3036 if (cmd == TUNSETIFF || cmd == TUNSETQUEUE ||
3037 (_IOC_TYPE(cmd) == SOCK_IOC_TYPE && cmd != SIOCGSKNS)) {
3038 if (copy_from_user(&ifr, argp, ifreq_len))
3041 memset(&ifr, 0, sizeof(ifr));
3043 if (cmd == TUNGETFEATURES) {
3044 /* Currently this just means: "what IFF flags are valid?".
3045 * This is needed because we never checked for invalid flags on
3048 return put_user(IFF_TUN | IFF_TAP | TUN_FEATURES,
3049 (unsigned int __user*)argp);
3050 } else if (cmd == TUNSETQUEUE) {
3051 return tun_set_queue(file, &ifr);
3052 } else if (cmd == SIOCGSKNS) {
3053 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
3055 return open_related_ns(&net->ns, get_net_ns);
3060 tun = tun_get(tfile);
3061 if (cmd == TUNSETIFF) {
3066 ifr.ifr_name[IFNAMSIZ-1] = '\0';
3068 ret = tun_set_iff(net, file, &ifr);
3073 if (copy_to_user(argp, &ifr, ifreq_len))
3077 if (cmd == TUNSETIFINDEX) {
3083 if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
3087 tfile->ifindex = ifindex;
3095 netif_info(tun, drv, tun->dev, "tun_chr_ioctl cmd %u\n", cmd);
3097 net = dev_net(tun->dev);
3101 tun_get_iff(tun, &ifr);
3103 if (tfile->detached)
3104 ifr.ifr_flags |= IFF_DETACH_QUEUE;
3105 if (!tfile->socket.sk->sk_filter)
3106 ifr.ifr_flags |= IFF_NOFILTER;
3108 if (copy_to_user(argp, &ifr, ifreq_len))
3113 /* Disable/Enable checksum */
3115 /* [unimplemented] */
3116 netif_info(tun, drv, tun->dev, "ignored: set checksum %s\n",
3117 arg ? "disabled" : "enabled");
3121 /* Disable/Enable persist mode. Keep an extra reference to the
3122 * module to prevent the module being unprobed.
3124 if (arg && !(tun->flags & IFF_PERSIST)) {
3125 tun->flags |= IFF_PERSIST;
3126 __module_get(THIS_MODULE);
3129 if (!arg && (tun->flags & IFF_PERSIST)) {
3130 tun->flags &= ~IFF_PERSIST;
3131 module_put(THIS_MODULE);
3135 netif_info(tun, drv, tun->dev, "persist %s\n",
3136 arg ? "enabled" : "disabled");
3140 /* Set owner of the device */
3141 owner = make_kuid(current_user_ns(), arg);
3142 if (!uid_valid(owner)) {
3148 netif_info(tun, drv, tun->dev, "owner set to %u\n",
3149 from_kuid(&init_user_ns, tun->owner));
3153 /* Set group of the device */
3154 group = make_kgid(current_user_ns(), arg);
3155 if (!gid_valid(group)) {
3161 netif_info(tun, drv, tun->dev, "group set to %u\n",
3162 from_kgid(&init_user_ns, tun->group));
3166 /* Only allow setting the type when the interface is down */
3167 if (tun->dev->flags & IFF_UP) {
3168 netif_info(tun, drv, tun->dev,
3169 "Linktype set failed because interface is up\n");
3172 ret = call_netdevice_notifiers(NETDEV_PRE_TYPE_CHANGE,
3174 ret = notifier_to_errno(ret);
3176 netif_info(tun, drv, tun->dev,
3177 "Refused to change device type\n");
3180 tun->dev->type = (int) arg;
3181 tun->dev->addr_len = tun_get_addr_len(tun->dev->type);
3182 netif_info(tun, drv, tun->dev, "linktype set to %d\n",
3184 call_netdevice_notifiers(NETDEV_POST_TYPE_CHANGE,
3190 tun->msg_enable = (u32)arg;
3194 ret = set_offload(tun, arg);
3197 case TUNSETTXFILTER:
3198 /* Can be set only for TAPs */
3200 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3202 ret = update_filter(&tun->txflt, (void __user *)arg);
3206 /* Get hw address */
3207 dev_get_mac_address(&ifr.ifr_hwaddr, net, tun->dev->name);
3208 if (copy_to_user(argp, &ifr, ifreq_len))
3213 /* Set hw address */
3214 ret = dev_set_mac_address_user(tun->dev, &ifr.ifr_hwaddr, NULL);
3218 sndbuf = tfile->socket.sk->sk_sndbuf;
3219 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
3224 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
3233 tun->sndbuf = sndbuf;
3234 tun_set_sndbuf(tun);
3237 case TUNGETVNETHDRSZ:
3238 vnet_hdr_sz = tun->vnet_hdr_sz;
3239 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
3243 case TUNSETVNETHDRSZ:
3244 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
3248 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
3253 tun->vnet_hdr_sz = vnet_hdr_sz;
3257 le = !!(tun->flags & TUN_VNET_LE);
3258 if (put_user(le, (int __user *)argp))
3263 if (get_user(le, (int __user *)argp)) {
3268 tun->flags |= TUN_VNET_LE;
3270 tun->flags &= ~TUN_VNET_LE;
3274 ret = tun_get_vnet_be(tun, argp);
3278 ret = tun_set_vnet_be(tun, argp);
3281 case TUNATTACHFILTER:
3282 /* Can be set only for TAPs */
3284 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3287 if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
3290 ret = tun_attach_filter(tun);
3293 case TUNDETACHFILTER:
3294 /* Can be set only for TAPs */
3296 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3299 tun_detach_filter(tun, tun->numqueues);
3304 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
3307 if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
3312 case TUNSETSTEERINGEBPF:
3313 ret = tun_set_ebpf(tun, &tun->steering_prog, argp);
3316 case TUNSETFILTEREBPF:
3317 ret = tun_set_ebpf(tun, &tun->filter_prog, argp);
3322 if (copy_from_user(&carrier, argp, sizeof(carrier)))
3325 ret = tun_net_change_carrier(tun->dev, (bool)carrier);
3328 case TUNGETDEVNETNS:
3330 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
3332 ret = open_related_ns(&net->ns, get_net_ns);
3341 netdev_state_change(tun->dev);
3350 static long tun_chr_ioctl(struct file *file,
3351 unsigned int cmd, unsigned long arg)
3353 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
3356 #ifdef CONFIG_COMPAT
3357 static long tun_chr_compat_ioctl(struct file *file,
3358 unsigned int cmd, unsigned long arg)
3363 case TUNSETTXFILTER:
3368 arg = (unsigned long)compat_ptr(arg);
3371 arg = (compat_ulong_t)arg;
3376 * compat_ifreq is shorter than ifreq, so we must not access beyond
3377 * the end of that structure. All fields that are used in this
3378 * driver are compatible though, we don't need to convert the
3381 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
3383 #endif /* CONFIG_COMPAT */
3385 static int tun_chr_fasync(int fd, struct file *file, int on)
3387 struct tun_file *tfile = file->private_data;
3390 if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
3394 __f_setown(file, task_pid(current), PIDTYPE_TGID, 0);
3395 tfile->flags |= TUN_FASYNC;
3397 tfile->flags &= ~TUN_FASYNC;
3403 static int tun_chr_open(struct inode *inode, struct file * file)
3405 struct net *net = current->nsproxy->net_ns;
3406 struct tun_file *tfile;
3408 tfile = (struct tun_file *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
3412 if (ptr_ring_init(&tfile->tx_ring, 0, GFP_KERNEL)) {
3413 sk_free(&tfile->sk);
3417 mutex_init(&tfile->napi_mutex);
3418 RCU_INIT_POINTER(tfile->tun, NULL);
3422 init_waitqueue_head(&tfile->socket.wq.wait);
3424 tfile->socket.file = file;
3425 tfile->socket.ops = &tun_socket_ops;
3427 sock_init_data(&tfile->socket, &tfile->sk);
3429 tfile->sk.sk_write_space = tun_sock_write_space;
3430 tfile->sk.sk_sndbuf = INT_MAX;
3432 file->private_data = tfile;
3433 INIT_LIST_HEAD(&tfile->next);
3435 sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
3440 static int tun_chr_close(struct inode *inode, struct file *file)
3442 struct tun_file *tfile = file->private_data;
3444 tun_detach(tfile, true);
3449 #ifdef CONFIG_PROC_FS
3450 static void tun_chr_show_fdinfo(struct seq_file *m, struct file *file)
3452 struct tun_file *tfile = file->private_data;
3453 struct tun_struct *tun;
3456 memset(&ifr, 0, sizeof(ifr));
3459 tun = tun_get(tfile);
3461 tun_get_iff(tun, &ifr);
3467 seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
3471 static const struct file_operations tun_fops = {
3472 .owner = THIS_MODULE,
3473 .llseek = no_llseek,
3474 .read_iter = tun_chr_read_iter,
3475 .write_iter = tun_chr_write_iter,
3476 .poll = tun_chr_poll,
3477 .unlocked_ioctl = tun_chr_ioctl,
3478 #ifdef CONFIG_COMPAT
3479 .compat_ioctl = tun_chr_compat_ioctl,
3481 .open = tun_chr_open,
3482 .release = tun_chr_close,
3483 .fasync = tun_chr_fasync,
3484 #ifdef CONFIG_PROC_FS
3485 .show_fdinfo = tun_chr_show_fdinfo,
3489 static struct miscdevice tun_miscdev = {
3492 .nodename = "net/tun",
3496 /* ethtool interface */
3498 static void tun_default_link_ksettings(struct net_device *dev,
3499 struct ethtool_link_ksettings *cmd)
3501 ethtool_link_ksettings_zero_link_mode(cmd, supported);
3502 ethtool_link_ksettings_zero_link_mode(cmd, advertising);
3503 cmd->base.speed = SPEED_10;
3504 cmd->base.duplex = DUPLEX_FULL;
3505 cmd->base.port = PORT_TP;
3506 cmd->base.phy_address = 0;
3507 cmd->base.autoneg = AUTONEG_DISABLE;
3510 static int tun_get_link_ksettings(struct net_device *dev,
3511 struct ethtool_link_ksettings *cmd)
3513 struct tun_struct *tun = netdev_priv(dev);
3515 memcpy(cmd, &tun->link_ksettings, sizeof(*cmd));
3519 static int tun_set_link_ksettings(struct net_device *dev,
3520 const struct ethtool_link_ksettings *cmd)
3522 struct tun_struct *tun = netdev_priv(dev);
3524 memcpy(&tun->link_ksettings, cmd, sizeof(*cmd));
3528 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
3530 struct tun_struct *tun = netdev_priv(dev);
3532 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
3533 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
3535 switch (tun->flags & TUN_TYPE_MASK) {
3537 strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
3540 strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
3545 static u32 tun_get_msglevel(struct net_device *dev)
3547 struct tun_struct *tun = netdev_priv(dev);
3549 return tun->msg_enable;
3552 static void tun_set_msglevel(struct net_device *dev, u32 value)
3554 struct tun_struct *tun = netdev_priv(dev);
3556 tun->msg_enable = value;
3559 static int tun_get_coalesce(struct net_device *dev,
3560 struct ethtool_coalesce *ec,
3561 struct kernel_ethtool_coalesce *kernel_coal,
3562 struct netlink_ext_ack *extack)
3564 struct tun_struct *tun = netdev_priv(dev);
3566 ec->rx_max_coalesced_frames = tun->rx_batched;
3571 static int tun_set_coalesce(struct net_device *dev,
3572 struct ethtool_coalesce *ec,
3573 struct kernel_ethtool_coalesce *kernel_coal,
3574 struct netlink_ext_ack *extack)
3576 struct tun_struct *tun = netdev_priv(dev);
3578 if (ec->rx_max_coalesced_frames > NAPI_POLL_WEIGHT)
3579 tun->rx_batched = NAPI_POLL_WEIGHT;
3581 tun->rx_batched = ec->rx_max_coalesced_frames;
3586 static const struct ethtool_ops tun_ethtool_ops = {
3587 .supported_coalesce_params = ETHTOOL_COALESCE_RX_MAX_FRAMES,
3588 .get_drvinfo = tun_get_drvinfo,
3589 .get_msglevel = tun_get_msglevel,
3590 .set_msglevel = tun_set_msglevel,
3591 .get_link = ethtool_op_get_link,
3592 .get_ts_info = ethtool_op_get_ts_info,
3593 .get_coalesce = tun_get_coalesce,
3594 .set_coalesce = tun_set_coalesce,
3595 .get_link_ksettings = tun_get_link_ksettings,
3596 .set_link_ksettings = tun_set_link_ksettings,
3599 static int tun_queue_resize(struct tun_struct *tun)
3601 struct net_device *dev = tun->dev;
3602 struct tun_file *tfile;
3603 struct ptr_ring **rings;
3604 int n = tun->numqueues + tun->numdisabled;
3607 rings = kmalloc_array(n, sizeof(*rings), GFP_KERNEL);
3611 for (i = 0; i < tun->numqueues; i++) {
3612 tfile = rtnl_dereference(tun->tfiles[i]);
3613 rings[i] = &tfile->tx_ring;
3615 list_for_each_entry(tfile, &tun->disabled, next)
3616 rings[i++] = &tfile->tx_ring;
3618 ret = ptr_ring_resize_multiple(rings, n,
3619 dev->tx_queue_len, GFP_KERNEL,
3626 static int tun_device_event(struct notifier_block *unused,
3627 unsigned long event, void *ptr)
3629 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
3630 struct tun_struct *tun = netdev_priv(dev);
3633 if (dev->rtnl_link_ops != &tun_link_ops)
3637 case NETDEV_CHANGE_TX_QUEUE_LEN:
3638 if (tun_queue_resize(tun))
3642 for (i = 0; i < tun->numqueues; i++) {
3643 struct tun_file *tfile;
3645 tfile = rtnl_dereference(tun->tfiles[i]);
3646 tfile->socket.sk->sk_write_space(tfile->socket.sk);
3656 static struct notifier_block tun_notifier_block __read_mostly = {
3657 .notifier_call = tun_device_event,
3660 static int __init tun_init(void)
3664 pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
3666 ret = rtnl_link_register(&tun_link_ops);
3668 pr_err("Can't register link_ops\n");
3672 ret = misc_register(&tun_miscdev);
3674 pr_err("Can't register misc device %d\n", TUN_MINOR);
3678 ret = register_netdevice_notifier(&tun_notifier_block);
3680 pr_err("Can't register netdevice notifier\n");
3687 misc_deregister(&tun_miscdev);
3689 rtnl_link_unregister(&tun_link_ops);
3694 static void tun_cleanup(void)
3696 misc_deregister(&tun_miscdev);
3697 rtnl_link_unregister(&tun_link_ops);
3698 unregister_netdevice_notifier(&tun_notifier_block);
3701 /* Get an underlying socket object from tun file. Returns error unless file is
3702 * attached to a device. The returned object works like a packet socket, it
3703 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
3704 * holding a reference to the file for as long as the socket is in use. */
3705 struct socket *tun_get_socket(struct file *file)
3707 struct tun_file *tfile;
3708 if (file->f_op != &tun_fops)
3709 return ERR_PTR(-EINVAL);
3710 tfile = file->private_data;
3712 return ERR_PTR(-EBADFD);
3713 return &tfile->socket;
3715 EXPORT_SYMBOL_GPL(tun_get_socket);
3717 struct ptr_ring *tun_get_tx_ring(struct file *file)
3719 struct tun_file *tfile;
3721 if (file->f_op != &tun_fops)
3722 return ERR_PTR(-EINVAL);
3723 tfile = file->private_data;
3725 return ERR_PTR(-EBADFD);
3726 return &tfile->tx_ring;
3728 EXPORT_SYMBOL_GPL(tun_get_tx_ring);
3730 module_init(tun_init);
3731 module_exit(tun_cleanup);
3732 MODULE_DESCRIPTION(DRV_DESCRIPTION);
3733 MODULE_AUTHOR(DRV_COPYRIGHT);
3734 MODULE_LICENSE("GPL");
3735 MODULE_ALIAS_MISCDEV(TUN_MINOR);
3736 MODULE_ALIAS("devname:net/tun");