1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * TUN - Universal TUN/TAP device driver.
4 * Copyright (C) 1999-2002 Maxim Krasnyansky <maxk@qualcomm.com>
6 * $Id: tun.c,v 1.15 2002/03/01 02:44:24 maxk Exp $
12 * Mike Kershaw <dragorn@kismetwireless.net> 2005/08/14
13 * Add TUNSETLINK ioctl to set the link encapsulation
15 * Mark Smith <markzzzsmith@yahoo.com.au>
16 * Use eth_random_addr() for tap MAC address.
18 * Harald Roelle <harald.roelle@ifi.lmu.de> 2004/04/20
19 * Fixes in packet dropping, queue length setting and queue wakeup.
20 * Increased default tx queue length.
24 * Daniel Podlejski <underley@underley.eu.org>
25 * Modifications for 2.3.99-pre5 kernel.
28 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
30 #define DRV_NAME "tun"
31 #define DRV_VERSION "1.6"
32 #define DRV_DESCRIPTION "Universal TUN/TAP device driver"
33 #define DRV_COPYRIGHT "(C) 1999-2004 Max Krasnyansky <maxk@qualcomm.com>"
35 #include <linux/module.h>
36 #include <linux/errno.h>
37 #include <linux/kernel.h>
38 #include <linux/sched/signal.h>
39 #include <linux/major.h>
40 #include <linux/slab.h>
41 #include <linux/poll.h>
42 #include <linux/fcntl.h>
43 #include <linux/init.h>
44 #include <linux/skbuff.h>
45 #include <linux/netdevice.h>
46 #include <linux/etherdevice.h>
47 #include <linux/miscdevice.h>
48 #include <linux/ethtool.h>
49 #include <linux/rtnetlink.h>
50 #include <linux/compat.h>
52 #include <linux/if_arp.h>
53 #include <linux/if_ether.h>
54 #include <linux/if_tun.h>
55 #include <linux/if_vlan.h>
56 #include <linux/crc32.h>
57 #include <linux/math.h>
58 #include <linux/nsproxy.h>
59 #include <linux/virtio_net.h>
60 #include <linux/rcupdate.h>
61 #include <net/net_namespace.h>
62 #include <net/netns/generic.h>
63 #include <net/rtnetlink.h>
66 #include <net/ip_tunnels.h>
67 #include <linux/seq_file.h>
68 #include <linux/uio.h>
69 #include <linux/skb_array.h>
70 #include <linux/bpf.h>
71 #include <linux/bpf_trace.h>
72 #include <linux/mutex.h>
73 #include <linux/ieee802154.h>
74 #include <uapi/linux/if_ltalk.h>
75 #include <uapi/linux/if_fddi.h>
76 #include <uapi/linux/if_hippi.h>
77 #include <uapi/linux/if_fc.h>
80 #include <net/6lowpan.h>
83 #include <linux/uaccess.h>
84 #include <linux/proc_fs.h>
86 static void tun_default_link_ksettings(struct net_device
*dev
,
87 struct ethtool_link_ksettings
*cmd
);
89 #define TUN_RX_PAD (NET_IP_ALIGN + NET_SKB_PAD)
91 /* TUN device flags */
93 /* IFF_ATTACH_QUEUE is never stored in device flags,
94 * overload it to mean fasync when stored there.
96 #define TUN_FASYNC IFF_ATTACH_QUEUE
97 /* High bits in flags field are unused. */
98 #define TUN_VNET_LE 0x80000000
99 #define TUN_VNET_BE 0x40000000
101 #define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
102 IFF_MULTI_QUEUE | IFF_NAPI | IFF_NAPI_FRAGS)
104 #define GOODCOPY_LEN 128
106 #define FLT_EXACT_COUNT 8
108 unsigned int count
; /* Number of addrs. Zero means disabled */
109 u32 mask
[2]; /* Mask of the hashed addrs */
110 unsigned char addr
[FLT_EXACT_COUNT
][ETH_ALEN
];
113 /* MAX_TAP_QUEUES 256 is chosen to allow rx/tx queues to be equal
114 * to max number of VCPUs in guest. */
115 #define MAX_TAP_QUEUES 256
116 #define MAX_TAP_FLOWS 4096
118 #define TUN_FLOW_EXPIRE (3 * HZ)
120 /* A tun_file connects an open character device to a tuntap netdevice. It
121 * also contains all socket related structures (except sock_fprog and tap_filter)
122 * to serve as one transmit queue for tuntap device. The sock_fprog and
123 * tap_filter were kept in tun_struct since they were used for filtering for the
124 * netdevice not for a specific queue (at least I didn't see the requirement for
128 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
129 * other can only be read while rcu_read_lock or rtnl_lock is held.
133 struct socket socket
;
134 struct tun_struct __rcu
*tun
;
135 struct fasync_struct
*fasync
;
136 /* only used for fasnyc */
140 unsigned int ifindex
;
142 struct napi_struct napi
;
144 bool napi_frags_enabled
;
145 struct mutex napi_mutex
; /* Protects access to the above napi */
146 struct list_head next
;
147 struct tun_struct
*detached
;
148 struct ptr_ring tx_ring
;
149 struct xdp_rxq_info xdp_rxq
;
157 struct tun_flow_entry
{
158 struct hlist_node hash_link
;
160 struct tun_struct
*tun
;
165 unsigned long updated ____cacheline_aligned_in_smp
;
168 #define TUN_NUM_FLOW_ENTRIES 1024
169 #define TUN_MASK_FLOW_ENTRIES (TUN_NUM_FLOW_ENTRIES - 1)
173 struct bpf_prog
*prog
;
176 /* Since the socket were moved to tun_file, to preserve the behavior of persist
177 * device, socket filter, sndbuf and vnet header size were restore when the
178 * file were attached to a persist device.
181 struct tun_file __rcu
*tfiles
[MAX_TAP_QUEUES
];
182 unsigned int numqueues
;
187 struct net_device
*dev
;
188 netdev_features_t set_features
;
189 #define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
190 NETIF_F_TSO6 | NETIF_F_GSO_UDP_L4)
195 struct tap_filter txflt
;
196 struct sock_fprog fprog
;
197 /* protected by rtnl lock */
198 bool filter_attached
;
201 struct hlist_head flows
[TUN_NUM_FLOW_ENTRIES
];
202 struct timer_list flow_gc_timer
;
203 unsigned long ageing_time
;
204 unsigned int numdisabled
;
205 struct list_head disabled
;
209 atomic_long_t rx_frame_errors
;
210 struct bpf_prog __rcu
*xdp_prog
;
211 struct tun_prog __rcu
*steering_prog
;
212 struct tun_prog __rcu
*filter_prog
;
213 struct ethtool_link_ksettings link_ksettings
;
224 static void tun_flow_init(struct tun_struct
*tun
);
225 static void tun_flow_uninit(struct tun_struct
*tun
);
227 static int tun_napi_receive(struct napi_struct
*napi
, int budget
)
229 struct tun_file
*tfile
= container_of(napi
, struct tun_file
, napi
);
230 struct sk_buff_head
*queue
= &tfile
->sk
.sk_write_queue
;
231 struct sk_buff_head process_queue
;
235 __skb_queue_head_init(&process_queue
);
237 spin_lock(&queue
->lock
);
238 skb_queue_splice_tail_init(queue
, &process_queue
);
239 spin_unlock(&queue
->lock
);
241 while (received
< budget
&& (skb
= __skb_dequeue(&process_queue
))) {
242 napi_gro_receive(napi
, skb
);
246 if (!skb_queue_empty(&process_queue
)) {
247 spin_lock(&queue
->lock
);
248 skb_queue_splice(&process_queue
, queue
);
249 spin_unlock(&queue
->lock
);
255 static int tun_napi_poll(struct napi_struct
*napi
, int budget
)
257 unsigned int received
;
259 received
= tun_napi_receive(napi
, budget
);
261 if (received
< budget
)
262 napi_complete_done(napi
, received
);
267 static void tun_napi_init(struct tun_struct
*tun
, struct tun_file
*tfile
,
268 bool napi_en
, bool napi_frags
)
270 tfile
->napi_enabled
= napi_en
;
271 tfile
->napi_frags_enabled
= napi_en
&& napi_frags
;
273 netif_napi_add_tx(tun
->dev
, &tfile
->napi
, tun_napi_poll
);
274 napi_enable(&tfile
->napi
);
278 static void tun_napi_enable(struct tun_file
*tfile
)
280 if (tfile
->napi_enabled
)
281 napi_enable(&tfile
->napi
);
284 static void tun_napi_disable(struct tun_file
*tfile
)
286 if (tfile
->napi_enabled
)
287 napi_disable(&tfile
->napi
);
290 static void tun_napi_del(struct tun_file
*tfile
)
292 if (tfile
->napi_enabled
)
293 netif_napi_del(&tfile
->napi
);
296 static bool tun_napi_frags_enabled(const struct tun_file
*tfile
)
298 return tfile
->napi_frags_enabled
;
301 #ifdef CONFIG_TUN_VNET_CROSS_LE
302 static inline bool tun_legacy_is_little_endian(struct tun_struct
*tun
)
304 return tun
->flags
& TUN_VNET_BE
? false :
305 virtio_legacy_is_little_endian();
308 static long tun_get_vnet_be(struct tun_struct
*tun
, int __user
*argp
)
310 int be
= !!(tun
->flags
& TUN_VNET_BE
);
312 if (put_user(be
, argp
))
318 static long tun_set_vnet_be(struct tun_struct
*tun
, int __user
*argp
)
322 if (get_user(be
, argp
))
326 tun
->flags
|= TUN_VNET_BE
;
328 tun
->flags
&= ~TUN_VNET_BE
;
333 static inline bool tun_legacy_is_little_endian(struct tun_struct
*tun
)
335 return virtio_legacy_is_little_endian();
338 static long tun_get_vnet_be(struct tun_struct
*tun
, int __user
*argp
)
343 static long tun_set_vnet_be(struct tun_struct
*tun
, int __user
*argp
)
347 #endif /* CONFIG_TUN_VNET_CROSS_LE */
349 static inline bool tun_is_little_endian(struct tun_struct
*tun
)
351 return tun
->flags
& TUN_VNET_LE
||
352 tun_legacy_is_little_endian(tun
);
355 static inline u16
tun16_to_cpu(struct tun_struct
*tun
, __virtio16 val
)
357 return __virtio16_to_cpu(tun_is_little_endian(tun
), val
);
360 static inline __virtio16
cpu_to_tun16(struct tun_struct
*tun
, u16 val
)
362 return __cpu_to_virtio16(tun_is_little_endian(tun
), val
);
365 static inline u32
tun_hashfn(u32 rxhash
)
367 return rxhash
& TUN_MASK_FLOW_ENTRIES
;
370 static struct tun_flow_entry
*tun_flow_find(struct hlist_head
*head
, u32 rxhash
)
372 struct tun_flow_entry
*e
;
374 hlist_for_each_entry_rcu(e
, head
, hash_link
) {
375 if (e
->rxhash
== rxhash
)
381 static struct tun_flow_entry
*tun_flow_create(struct tun_struct
*tun
,
382 struct hlist_head
*head
,
383 u32 rxhash
, u16 queue_index
)
385 struct tun_flow_entry
*e
= kmalloc(sizeof(*e
), GFP_ATOMIC
);
388 netif_info(tun
, tx_queued
, tun
->dev
,
389 "create flow: hash %u index %u\n",
390 rxhash
, queue_index
);
391 e
->updated
= jiffies
;
394 e
->queue_index
= queue_index
;
396 hlist_add_head_rcu(&e
->hash_link
, head
);
402 static void tun_flow_delete(struct tun_struct
*tun
, struct tun_flow_entry
*e
)
404 netif_info(tun
, tx_queued
, tun
->dev
, "delete flow: hash %u index %u\n",
405 e
->rxhash
, e
->queue_index
);
406 hlist_del_rcu(&e
->hash_link
);
411 static void tun_flow_flush(struct tun_struct
*tun
)
415 spin_lock_bh(&tun
->lock
);
416 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
417 struct tun_flow_entry
*e
;
418 struct hlist_node
*n
;
420 hlist_for_each_entry_safe(e
, n
, &tun
->flows
[i
], hash_link
)
421 tun_flow_delete(tun
, e
);
423 spin_unlock_bh(&tun
->lock
);
426 static void tun_flow_delete_by_queue(struct tun_struct
*tun
, u16 queue_index
)
430 spin_lock_bh(&tun
->lock
);
431 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
432 struct tun_flow_entry
*e
;
433 struct hlist_node
*n
;
435 hlist_for_each_entry_safe(e
, n
, &tun
->flows
[i
], hash_link
) {
436 if (e
->queue_index
== queue_index
)
437 tun_flow_delete(tun
, e
);
440 spin_unlock_bh(&tun
->lock
);
443 static void tun_flow_cleanup(struct timer_list
*t
)
445 struct tun_struct
*tun
= from_timer(tun
, t
, flow_gc_timer
);
446 unsigned long delay
= tun
->ageing_time
;
447 unsigned long next_timer
= jiffies
+ delay
;
448 unsigned long count
= 0;
451 spin_lock(&tun
->lock
);
452 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
453 struct tun_flow_entry
*e
;
454 struct hlist_node
*n
;
456 hlist_for_each_entry_safe(e
, n
, &tun
->flows
[i
], hash_link
) {
457 unsigned long this_timer
;
459 this_timer
= e
->updated
+ delay
;
460 if (time_before_eq(this_timer
, jiffies
)) {
461 tun_flow_delete(tun
, e
);
465 if (time_before(this_timer
, next_timer
))
466 next_timer
= this_timer
;
471 mod_timer(&tun
->flow_gc_timer
, round_jiffies_up(next_timer
));
472 spin_unlock(&tun
->lock
);
475 static void tun_flow_update(struct tun_struct
*tun
, u32 rxhash
,
476 struct tun_file
*tfile
)
478 struct hlist_head
*head
;
479 struct tun_flow_entry
*e
;
480 unsigned long delay
= tun
->ageing_time
;
481 u16 queue_index
= tfile
->queue_index
;
483 head
= &tun
->flows
[tun_hashfn(rxhash
)];
487 e
= tun_flow_find(head
, rxhash
);
489 /* TODO: keep queueing to old queue until it's empty? */
490 if (READ_ONCE(e
->queue_index
) != queue_index
)
491 WRITE_ONCE(e
->queue_index
, queue_index
);
492 if (e
->updated
!= jiffies
)
493 e
->updated
= jiffies
;
494 sock_rps_record_flow_hash(e
->rps_rxhash
);
496 spin_lock_bh(&tun
->lock
);
497 if (!tun_flow_find(head
, rxhash
) &&
498 tun
->flow_count
< MAX_TAP_FLOWS
)
499 tun_flow_create(tun
, head
, rxhash
, queue_index
);
501 if (!timer_pending(&tun
->flow_gc_timer
))
502 mod_timer(&tun
->flow_gc_timer
,
503 round_jiffies_up(jiffies
+ delay
));
504 spin_unlock_bh(&tun
->lock
);
510 /* Save the hash received in the stack receive path and update the
511 * flow_hash table accordingly.
513 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry
*e
, u32 hash
)
515 if (unlikely(e
->rps_rxhash
!= hash
))
516 e
->rps_rxhash
= hash
;
519 /* We try to identify a flow through its rxhash. The reason that
520 * we do not check rxq no. is because some cards(e.g 82599), chooses
521 * the rxq based on the txq where the last packet of the flow comes. As
522 * the userspace application move between processors, we may get a
523 * different rxq no. here.
525 static u16
tun_automq_select_queue(struct tun_struct
*tun
, struct sk_buff
*skb
)
527 struct tun_flow_entry
*e
;
530 numqueues
= READ_ONCE(tun
->numqueues
);
532 txq
= __skb_get_hash_symmetric(skb
);
533 e
= tun_flow_find(&tun
->flows
[tun_hashfn(txq
)], txq
);
535 tun_flow_save_rps_rxhash(e
, txq
);
536 txq
= e
->queue_index
;
538 txq
= reciprocal_scale(txq
, numqueues
);
544 static u16
tun_ebpf_select_queue(struct tun_struct
*tun
, struct sk_buff
*skb
)
546 struct tun_prog
*prog
;
550 numqueues
= READ_ONCE(tun
->numqueues
);
554 prog
= rcu_dereference(tun
->steering_prog
);
556 ret
= bpf_prog_run_clear_cb(prog
->prog
, skb
);
558 return ret
% numqueues
;
561 static u16
tun_select_queue(struct net_device
*dev
, struct sk_buff
*skb
,
562 struct net_device
*sb_dev
)
564 struct tun_struct
*tun
= netdev_priv(dev
);
568 if (rcu_dereference(tun
->steering_prog
))
569 ret
= tun_ebpf_select_queue(tun
, skb
);
571 ret
= tun_automq_select_queue(tun
, skb
);
577 static inline bool tun_not_capable(struct tun_struct
*tun
)
579 const struct cred
*cred
= current_cred();
580 struct net
*net
= dev_net(tun
->dev
);
582 return ((uid_valid(tun
->owner
) && !uid_eq(cred
->euid
, tun
->owner
)) ||
583 (gid_valid(tun
->group
) && !in_egroup_p(tun
->group
))) &&
584 !ns_capable(net
->user_ns
, CAP_NET_ADMIN
);
587 static void tun_set_real_num_queues(struct tun_struct
*tun
)
589 netif_set_real_num_tx_queues(tun
->dev
, tun
->numqueues
);
590 netif_set_real_num_rx_queues(tun
->dev
, tun
->numqueues
);
593 static void tun_disable_queue(struct tun_struct
*tun
, struct tun_file
*tfile
)
595 tfile
->detached
= tun
;
596 list_add_tail(&tfile
->next
, &tun
->disabled
);
600 static struct tun_struct
*tun_enable_queue(struct tun_file
*tfile
)
602 struct tun_struct
*tun
= tfile
->detached
;
604 tfile
->detached
= NULL
;
605 list_del_init(&tfile
->next
);
610 void tun_ptr_free(void *ptr
)
614 if (tun_is_xdp_frame(ptr
)) {
615 struct xdp_frame
*xdpf
= tun_ptr_to_xdp(ptr
);
617 xdp_return_frame(xdpf
);
619 __skb_array_destroy_skb(ptr
);
622 EXPORT_SYMBOL_GPL(tun_ptr_free
);
624 static void tun_queue_purge(struct tun_file
*tfile
)
628 while ((ptr
= ptr_ring_consume(&tfile
->tx_ring
)) != NULL
)
631 skb_queue_purge(&tfile
->sk
.sk_write_queue
);
632 skb_queue_purge(&tfile
->sk
.sk_error_queue
);
635 static void __tun_detach(struct tun_file
*tfile
, bool clean
)
637 struct tun_file
*ntfile
;
638 struct tun_struct
*tun
;
640 tun
= rtnl_dereference(tfile
->tun
);
643 if (!tfile
->detached
)
644 tun_napi_disable(tfile
);
648 if (tun
&& !tfile
->detached
) {
649 u16 index
= tfile
->queue_index
;
650 BUG_ON(index
>= tun
->numqueues
);
652 rcu_assign_pointer(tun
->tfiles
[index
],
653 tun
->tfiles
[tun
->numqueues
- 1]);
654 ntfile
= rtnl_dereference(tun
->tfiles
[index
]);
655 ntfile
->queue_index
= index
;
656 ntfile
->xdp_rxq
.queue_index
= index
;
657 rcu_assign_pointer(tun
->tfiles
[tun
->numqueues
- 1],
662 RCU_INIT_POINTER(tfile
->tun
, NULL
);
663 sock_put(&tfile
->sk
);
665 tun_disable_queue(tun
, tfile
);
666 tun_napi_disable(tfile
);
670 tun_flow_delete_by_queue(tun
, tun
->numqueues
+ 1);
671 /* Drop read queue */
672 tun_queue_purge(tfile
);
673 tun_set_real_num_queues(tun
);
674 } else if (tfile
->detached
&& clean
) {
675 tun
= tun_enable_queue(tfile
);
676 sock_put(&tfile
->sk
);
680 if (tun
&& tun
->numqueues
== 0 && tun
->numdisabled
== 0) {
681 netif_carrier_off(tun
->dev
);
683 if (!(tun
->flags
& IFF_PERSIST
) &&
684 tun
->dev
->reg_state
== NETREG_REGISTERED
)
685 unregister_netdevice(tun
->dev
);
688 xdp_rxq_info_unreg(&tfile
->xdp_rxq
);
689 ptr_ring_cleanup(&tfile
->tx_ring
, tun_ptr_free
);
693 static void tun_detach(struct tun_file
*tfile
, bool clean
)
695 struct tun_struct
*tun
;
696 struct net_device
*dev
;
699 tun
= rtnl_dereference(tfile
->tun
);
700 dev
= tun
? tun
->dev
: NULL
;
701 __tun_detach(tfile
, clean
);
703 netdev_state_change(dev
);
707 sock_put(&tfile
->sk
);
710 static void tun_detach_all(struct net_device
*dev
)
712 struct tun_struct
*tun
= netdev_priv(dev
);
713 struct tun_file
*tfile
, *tmp
;
714 int i
, n
= tun
->numqueues
;
716 for (i
= 0; i
< n
; i
++) {
717 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
719 tun_napi_disable(tfile
);
720 tfile
->socket
.sk
->sk_shutdown
= RCV_SHUTDOWN
;
721 tfile
->socket
.sk
->sk_data_ready(tfile
->socket
.sk
);
722 RCU_INIT_POINTER(tfile
->tun
, NULL
);
725 list_for_each_entry(tfile
, &tun
->disabled
, next
) {
726 tfile
->socket
.sk
->sk_shutdown
= RCV_SHUTDOWN
;
727 tfile
->socket
.sk
->sk_data_ready(tfile
->socket
.sk
);
728 RCU_INIT_POINTER(tfile
->tun
, NULL
);
730 BUG_ON(tun
->numqueues
!= 0);
733 for (i
= 0; i
< n
; i
++) {
734 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
736 /* Drop read queue */
737 tun_queue_purge(tfile
);
738 xdp_rxq_info_unreg(&tfile
->xdp_rxq
);
739 sock_put(&tfile
->sk
);
741 list_for_each_entry_safe(tfile
, tmp
, &tun
->disabled
, next
) {
743 tun_enable_queue(tfile
);
744 tun_queue_purge(tfile
);
745 xdp_rxq_info_unreg(&tfile
->xdp_rxq
);
746 sock_put(&tfile
->sk
);
748 BUG_ON(tun
->numdisabled
!= 0);
750 if (tun
->flags
& IFF_PERSIST
)
751 module_put(THIS_MODULE
);
754 static int tun_attach(struct tun_struct
*tun
, struct file
*file
,
755 bool skip_filter
, bool napi
, bool napi_frags
,
758 struct tun_file
*tfile
= file
->private_data
;
759 struct net_device
*dev
= tun
->dev
;
762 err
= security_tun_dev_attach(tfile
->socket
.sk
, tun
->security
);
767 if (rtnl_dereference(tfile
->tun
) && !tfile
->detached
)
771 if (!(tun
->flags
& IFF_MULTI_QUEUE
) && tun
->numqueues
== 1)
775 if (!tfile
->detached
&&
776 tun
->numqueues
+ tun
->numdisabled
== MAX_TAP_QUEUES
)
781 /* Re-attach the filter to persist device */
782 if (!skip_filter
&& (tun
->filter_attached
== true)) {
783 lock_sock(tfile
->socket
.sk
);
784 err
= sk_attach_filter(&tun
->fprog
, tfile
->socket
.sk
);
785 release_sock(tfile
->socket
.sk
);
790 if (!tfile
->detached
&&
791 ptr_ring_resize(&tfile
->tx_ring
, dev
->tx_queue_len
,
792 GFP_KERNEL
, tun_ptr_free
)) {
797 tfile
->queue_index
= tun
->numqueues
;
798 tfile
->socket
.sk
->sk_shutdown
&= ~RCV_SHUTDOWN
;
800 if (tfile
->detached
) {
801 /* Re-attach detached tfile, updating XDP queue_index */
802 WARN_ON(!xdp_rxq_info_is_reg(&tfile
->xdp_rxq
));
804 if (tfile
->xdp_rxq
.queue_index
!= tfile
->queue_index
)
805 tfile
->xdp_rxq
.queue_index
= tfile
->queue_index
;
807 /* Setup XDP RX-queue info, for new tfile getting attached */
808 err
= xdp_rxq_info_reg(&tfile
->xdp_rxq
,
809 tun
->dev
, tfile
->queue_index
, 0);
812 err
= xdp_rxq_info_reg_mem_model(&tfile
->xdp_rxq
,
813 MEM_TYPE_PAGE_SHARED
, NULL
);
815 xdp_rxq_info_unreg(&tfile
->xdp_rxq
);
821 if (tfile
->detached
) {
822 tun_enable_queue(tfile
);
823 tun_napi_enable(tfile
);
825 sock_hold(&tfile
->sk
);
826 tun_napi_init(tun
, tfile
, napi
, napi_frags
);
829 if (rtnl_dereference(tun
->xdp_prog
))
830 sock_set_flag(&tfile
->sk
, SOCK_XDP
);
832 /* device is allowed to go away first, so no need to hold extra
836 /* Publish tfile->tun and tun->tfiles only after we've fully
837 * initialized tfile; otherwise we risk using half-initialized
841 rcu_assign_pointer(tfile
->tun
, tun
);
842 rcu_assign_pointer(tun
->tfiles
[tun
->numqueues
], tfile
);
844 tun_set_real_num_queues(tun
);
849 static struct tun_struct
*tun_get(struct tun_file
*tfile
)
851 struct tun_struct
*tun
;
854 tun
= rcu_dereference(tfile
->tun
);
862 static void tun_put(struct tun_struct
*tun
)
868 static void addr_hash_set(u32
*mask
, const u8
*addr
)
870 int n
= ether_crc(ETH_ALEN
, addr
) >> 26;
871 mask
[n
>> 5] |= (1 << (n
& 31));
874 static unsigned int addr_hash_test(const u32
*mask
, const u8
*addr
)
876 int n
= ether_crc(ETH_ALEN
, addr
) >> 26;
877 return mask
[n
>> 5] & (1 << (n
& 31));
880 static int update_filter(struct tap_filter
*filter
, void __user
*arg
)
882 struct { u8 u
[ETH_ALEN
]; } *addr
;
883 struct tun_filter uf
;
884 int err
, alen
, n
, nexact
;
886 if (copy_from_user(&uf
, arg
, sizeof(uf
)))
895 alen
= ETH_ALEN
* uf
.count
;
896 addr
= memdup_user(arg
+ sizeof(uf
), alen
);
898 return PTR_ERR(addr
);
900 /* The filter is updated without holding any locks. Which is
901 * perfectly safe. We disable it first and in the worst
902 * case we'll accept a few undesired packets. */
906 /* Use first set of addresses as an exact filter */
907 for (n
= 0; n
< uf
.count
&& n
< FLT_EXACT_COUNT
; n
++)
908 memcpy(filter
->addr
[n
], addr
[n
].u
, ETH_ALEN
);
912 /* Remaining multicast addresses are hashed,
913 * unicast will leave the filter disabled. */
914 memset(filter
->mask
, 0, sizeof(filter
->mask
));
915 for (; n
< uf
.count
; n
++) {
916 if (!is_multicast_ether_addr(addr
[n
].u
)) {
917 err
= 0; /* no filter */
920 addr_hash_set(filter
->mask
, addr
[n
].u
);
923 /* For ALLMULTI just set the mask to all ones.
924 * This overrides the mask populated above. */
925 if ((uf
.flags
& TUN_FLT_ALLMULTI
))
926 memset(filter
->mask
, ~0, sizeof(filter
->mask
));
928 /* Now enable the filter */
930 filter
->count
= nexact
;
932 /* Return the number of exact filters */
939 /* Returns: 0 - drop, !=0 - accept */
940 static int run_filter(struct tap_filter
*filter
, const struct sk_buff
*skb
)
942 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
944 struct ethhdr
*eh
= (struct ethhdr
*) skb
->data
;
948 for (i
= 0; i
< filter
->count
; i
++)
949 if (ether_addr_equal(eh
->h_dest
, filter
->addr
[i
]))
952 /* Inexact match (multicast only) */
953 if (is_multicast_ether_addr(eh
->h_dest
))
954 return addr_hash_test(filter
->mask
, eh
->h_dest
);
960 * Checks whether the packet is accepted or not.
961 * Returns: 0 - drop, !=0 - accept
963 static int check_filter(struct tap_filter
*filter
, const struct sk_buff
*skb
)
968 return run_filter(filter
, skb
);
971 /* Network device part of the driver */
973 static const struct ethtool_ops tun_ethtool_ops
;
975 static int tun_net_init(struct net_device
*dev
)
977 struct tun_struct
*tun
= netdev_priv(dev
);
978 struct ifreq
*ifr
= tun
->ifr
;
981 spin_lock_init(&tun
->lock
);
983 err
= security_tun_dev_alloc_security(&tun
->security
);
989 dev
->pcpu_stat_type
= NETDEV_PCPU_STAT_TSTATS
;
990 dev
->hw_features
= NETIF_F_SG
| NETIF_F_FRAGLIST
|
991 TUN_USER_FEATURES
| NETIF_F_HW_VLAN_CTAG_TX
|
992 NETIF_F_HW_VLAN_STAG_TX
;
993 dev
->features
= dev
->hw_features
;
994 dev
->vlan_features
= dev
->features
&
995 ~(NETIF_F_HW_VLAN_CTAG_TX
|
996 NETIF_F_HW_VLAN_STAG_TX
);
999 tun
->flags
= (tun
->flags
& ~TUN_FEATURES
) |
1000 (ifr
->ifr_flags
& TUN_FEATURES
);
1002 INIT_LIST_HEAD(&tun
->disabled
);
1003 err
= tun_attach(tun
, tun
->file
, false, ifr
->ifr_flags
& IFF_NAPI
,
1004 ifr
->ifr_flags
& IFF_NAPI_FRAGS
, false);
1006 tun_flow_uninit(tun
);
1007 security_tun_dev_free_security(tun
->security
);
1013 /* Net device detach from fd. */
1014 static void tun_net_uninit(struct net_device
*dev
)
1016 tun_detach_all(dev
);
1019 /* Net device open. */
1020 static int tun_net_open(struct net_device
*dev
)
1022 netif_tx_start_all_queues(dev
);
1027 /* Net device close. */
1028 static int tun_net_close(struct net_device
*dev
)
1030 netif_tx_stop_all_queues(dev
);
1034 /* Net device start xmit */
1035 static void tun_automq_xmit(struct tun_struct
*tun
, struct sk_buff
*skb
)
1038 if (tun
->numqueues
== 1 && static_branch_unlikely(&rps_needed
)) {
1039 /* Select queue was not called for the skbuff, so we extract the
1040 * RPS hash and save it into the flow_table here.
1042 struct tun_flow_entry
*e
;
1045 rxhash
= __skb_get_hash_symmetric(skb
);
1046 e
= tun_flow_find(&tun
->flows
[tun_hashfn(rxhash
)], rxhash
);
1048 tun_flow_save_rps_rxhash(e
, rxhash
);
1053 static unsigned int run_ebpf_filter(struct tun_struct
*tun
,
1054 struct sk_buff
*skb
,
1057 struct tun_prog
*prog
= rcu_dereference(tun
->filter_prog
);
1060 len
= bpf_prog_run_clear_cb(prog
->prog
, skb
);
1065 /* Net device start xmit */
1066 static netdev_tx_t
tun_net_xmit(struct sk_buff
*skb
, struct net_device
*dev
)
1068 struct tun_struct
*tun
= netdev_priv(dev
);
1069 enum skb_drop_reason drop_reason
;
1070 int txq
= skb
->queue_mapping
;
1071 struct netdev_queue
*queue
;
1072 struct tun_file
*tfile
;
1076 tfile
= rcu_dereference(tun
->tfiles
[txq
]);
1078 /* Drop packet if interface is not attached */
1080 drop_reason
= SKB_DROP_REASON_DEV_READY
;
1084 if (!rcu_dereference(tun
->steering_prog
))
1085 tun_automq_xmit(tun
, skb
);
1087 netif_info(tun
, tx_queued
, tun
->dev
, "%s %d\n", __func__
, skb
->len
);
1089 /* Drop if the filter does not like it.
1090 * This is a noop if the filter is disabled.
1091 * Filter can be enabled only for the TAP devices. */
1092 if (!check_filter(&tun
->txflt
, skb
)) {
1093 drop_reason
= SKB_DROP_REASON_TAP_TXFILTER
;
1097 if (tfile
->socket
.sk
->sk_filter
&&
1098 sk_filter(tfile
->socket
.sk
, skb
)) {
1099 drop_reason
= SKB_DROP_REASON_SOCKET_FILTER
;
1103 len
= run_ebpf_filter(tun
, skb
, len
);
1105 drop_reason
= SKB_DROP_REASON_TAP_FILTER
;
1109 if (pskb_trim(skb
, len
)) {
1110 drop_reason
= SKB_DROP_REASON_NOMEM
;
1114 if (unlikely(skb_orphan_frags_rx(skb
, GFP_ATOMIC
))) {
1115 drop_reason
= SKB_DROP_REASON_SKB_UCOPY_FAULT
;
1119 skb_tx_timestamp(skb
);
1121 /* Orphan the skb - required as we might hang on to it
1122 * for indefinite time.
1128 if (ptr_ring_produce(&tfile
->tx_ring
, skb
)) {
1129 drop_reason
= SKB_DROP_REASON_FULL_RING
;
1133 /* dev->lltx requires to do our own update of trans_start */
1134 queue
= netdev_get_tx_queue(dev
, txq
);
1135 txq_trans_cond_update(queue
);
1137 /* Notify and wake up reader process */
1138 if (tfile
->flags
& TUN_FASYNC
)
1139 kill_fasync(&tfile
->fasync
, SIGIO
, POLL_IN
);
1140 tfile
->socket
.sk
->sk_data_ready(tfile
->socket
.sk
);
1143 return NETDEV_TX_OK
;
1146 dev_core_stats_tx_dropped_inc(dev
);
1148 kfree_skb_reason(skb
, drop_reason
);
1150 return NET_XMIT_DROP
;
1153 static void tun_net_mclist(struct net_device
*dev
)
1156 * This callback is supposed to deal with mc filter in
1157 * _rx_ path and has nothing to do with the _tx_ path.
1158 * In rx path we always accept everything userspace gives us.
1162 static netdev_features_t
tun_net_fix_features(struct net_device
*dev
,
1163 netdev_features_t features
)
1165 struct tun_struct
*tun
= netdev_priv(dev
);
1167 return (features
& tun
->set_features
) | (features
& ~TUN_USER_FEATURES
);
1170 static void tun_set_headroom(struct net_device
*dev
, int new_hr
)
1172 struct tun_struct
*tun
= netdev_priv(dev
);
1174 if (new_hr
< NET_SKB_PAD
)
1175 new_hr
= NET_SKB_PAD
;
1177 tun
->align
= new_hr
;
1181 tun_net_get_stats64(struct net_device
*dev
, struct rtnl_link_stats64
*stats
)
1183 struct tun_struct
*tun
= netdev_priv(dev
);
1185 dev_get_tstats64(dev
, stats
);
1187 stats
->rx_frame_errors
+=
1188 (unsigned long)atomic_long_read(&tun
->rx_frame_errors
);
1191 static int tun_xdp_set(struct net_device
*dev
, struct bpf_prog
*prog
,
1192 struct netlink_ext_ack
*extack
)
1194 struct tun_struct
*tun
= netdev_priv(dev
);
1195 struct tun_file
*tfile
;
1196 struct bpf_prog
*old_prog
;
1199 old_prog
= rtnl_dereference(tun
->xdp_prog
);
1200 rcu_assign_pointer(tun
->xdp_prog
, prog
);
1202 bpf_prog_put(old_prog
);
1204 for (i
= 0; i
< tun
->numqueues
; i
++) {
1205 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
1207 sock_set_flag(&tfile
->sk
, SOCK_XDP
);
1209 sock_reset_flag(&tfile
->sk
, SOCK_XDP
);
1211 list_for_each_entry(tfile
, &tun
->disabled
, next
) {
1213 sock_set_flag(&tfile
->sk
, SOCK_XDP
);
1215 sock_reset_flag(&tfile
->sk
, SOCK_XDP
);
1221 static int tun_xdp(struct net_device
*dev
, struct netdev_bpf
*xdp
)
1223 switch (xdp
->command
) {
1224 case XDP_SETUP_PROG
:
1225 return tun_xdp_set(dev
, xdp
->prog
, xdp
->extack
);
1231 static int tun_net_change_carrier(struct net_device
*dev
, bool new_carrier
)
1234 struct tun_struct
*tun
= netdev_priv(dev
);
1236 if (!tun
->numqueues
)
1239 netif_carrier_on(dev
);
1241 netif_carrier_off(dev
);
1246 static const struct net_device_ops tun_netdev_ops
= {
1247 .ndo_init
= tun_net_init
,
1248 .ndo_uninit
= tun_net_uninit
,
1249 .ndo_open
= tun_net_open
,
1250 .ndo_stop
= tun_net_close
,
1251 .ndo_start_xmit
= tun_net_xmit
,
1252 .ndo_fix_features
= tun_net_fix_features
,
1253 .ndo_select_queue
= tun_select_queue
,
1254 .ndo_set_rx_headroom
= tun_set_headroom
,
1255 .ndo_get_stats64
= tun_net_get_stats64
,
1256 .ndo_change_carrier
= tun_net_change_carrier
,
1259 static void __tun_xdp_flush_tfile(struct tun_file
*tfile
)
1261 /* Notify and wake up reader process */
1262 if (tfile
->flags
& TUN_FASYNC
)
1263 kill_fasync(&tfile
->fasync
, SIGIO
, POLL_IN
);
1264 tfile
->socket
.sk
->sk_data_ready(tfile
->socket
.sk
);
1267 static int tun_xdp_xmit(struct net_device
*dev
, int n
,
1268 struct xdp_frame
**frames
, u32 flags
)
1270 struct tun_struct
*tun
= netdev_priv(dev
);
1271 struct tun_file
*tfile
;
1276 if (unlikely(flags
& ~XDP_XMIT_FLAGS_MASK
))
1282 numqueues
= READ_ONCE(tun
->numqueues
);
1285 return -ENXIO
; /* Caller will free/return all frames */
1288 tfile
= rcu_dereference(tun
->tfiles
[smp_processor_id() %
1290 if (unlikely(!tfile
))
1293 spin_lock(&tfile
->tx_ring
.producer_lock
);
1294 for (i
= 0; i
< n
; i
++) {
1295 struct xdp_frame
*xdp
= frames
[i
];
1296 /* Encode the XDP flag into lowest bit for consumer to differ
1297 * XDP buffer from sk_buff.
1299 void *frame
= tun_xdp_to_ptr(xdp
);
1301 if (__ptr_ring_produce(&tfile
->tx_ring
, frame
)) {
1302 dev_core_stats_tx_dropped_inc(dev
);
1307 spin_unlock(&tfile
->tx_ring
.producer_lock
);
1309 if (flags
& XDP_XMIT_FLUSH
)
1310 __tun_xdp_flush_tfile(tfile
);
1316 static int tun_xdp_tx(struct net_device
*dev
, struct xdp_buff
*xdp
)
1318 struct xdp_frame
*frame
= xdp_convert_buff_to_frame(xdp
);
1321 if (unlikely(!frame
))
1324 nxmit
= tun_xdp_xmit(dev
, 1, &frame
, XDP_XMIT_FLUSH
);
1326 xdp_return_frame_rx_napi(frame
);
1330 static const struct net_device_ops tap_netdev_ops
= {
1331 .ndo_init
= tun_net_init
,
1332 .ndo_uninit
= tun_net_uninit
,
1333 .ndo_open
= tun_net_open
,
1334 .ndo_stop
= tun_net_close
,
1335 .ndo_start_xmit
= tun_net_xmit
,
1336 .ndo_fix_features
= tun_net_fix_features
,
1337 .ndo_set_rx_mode
= tun_net_mclist
,
1338 .ndo_set_mac_address
= eth_mac_addr
,
1339 .ndo_validate_addr
= eth_validate_addr
,
1340 .ndo_select_queue
= tun_select_queue
,
1341 .ndo_features_check
= passthru_features_check
,
1342 .ndo_set_rx_headroom
= tun_set_headroom
,
1344 .ndo_xdp_xmit
= tun_xdp_xmit
,
1345 .ndo_change_carrier
= tun_net_change_carrier
,
1348 static void tun_flow_init(struct tun_struct
*tun
)
1352 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++)
1353 INIT_HLIST_HEAD(&tun
->flows
[i
]);
1355 tun
->ageing_time
= TUN_FLOW_EXPIRE
;
1356 timer_setup(&tun
->flow_gc_timer
, tun_flow_cleanup
, 0);
1357 mod_timer(&tun
->flow_gc_timer
,
1358 round_jiffies_up(jiffies
+ tun
->ageing_time
));
1361 static void tun_flow_uninit(struct tun_struct
*tun
)
1363 del_timer_sync(&tun
->flow_gc_timer
);
1364 tun_flow_flush(tun
);
1368 #define MAX_MTU 65535
1370 /* Initialize net device. */
1371 static void tun_net_initialize(struct net_device
*dev
)
1373 struct tun_struct
*tun
= netdev_priv(dev
);
1375 switch (tun
->flags
& TUN_TYPE_MASK
) {
1377 dev
->netdev_ops
= &tun_netdev_ops
;
1378 dev
->header_ops
= &ip_tunnel_header_ops
;
1380 /* Point-to-Point TUN Device */
1381 dev
->hard_header_len
= 0;
1385 /* Zero header length */
1386 dev
->type
= ARPHRD_NONE
;
1387 dev
->flags
= IFF_POINTOPOINT
| IFF_NOARP
| IFF_MULTICAST
;
1391 dev
->netdev_ops
= &tap_netdev_ops
;
1392 /* Ethernet TAP Device */
1394 dev
->priv_flags
&= ~IFF_TX_SKB_SHARING
;
1395 dev
->priv_flags
|= IFF_LIVE_ADDR_CHANGE
;
1397 eth_hw_addr_random(dev
);
1399 /* Currently tun does not support XDP, only tap does. */
1400 dev
->xdp_features
= NETDEV_XDP_ACT_BASIC
|
1401 NETDEV_XDP_ACT_REDIRECT
|
1402 NETDEV_XDP_ACT_NDO_XMIT
;
1407 dev
->min_mtu
= MIN_MTU
;
1408 dev
->max_mtu
= MAX_MTU
- dev
->hard_header_len
;
1411 static bool tun_sock_writeable(struct tun_struct
*tun
, struct tun_file
*tfile
)
1413 struct sock
*sk
= tfile
->socket
.sk
;
1415 return (tun
->dev
->flags
& IFF_UP
) && sock_writeable(sk
);
1418 /* Character device part */
1421 static __poll_t
tun_chr_poll(struct file
*file
, poll_table
*wait
)
1423 struct tun_file
*tfile
= file
->private_data
;
1424 struct tun_struct
*tun
= tun_get(tfile
);
1431 sk
= tfile
->socket
.sk
;
1433 poll_wait(file
, sk_sleep(sk
), wait
);
1435 if (!ptr_ring_empty(&tfile
->tx_ring
))
1436 mask
|= EPOLLIN
| EPOLLRDNORM
;
1438 /* Make sure SOCKWQ_ASYNC_NOSPACE is set if not writable to
1439 * guarantee EPOLLOUT to be raised by either here or
1440 * tun_sock_write_space(). Then process could get notification
1441 * after it writes to a down device and meets -EIO.
1443 if (tun_sock_writeable(tun
, tfile
) ||
1444 (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE
, &sk
->sk_socket
->flags
) &&
1445 tun_sock_writeable(tun
, tfile
)))
1446 mask
|= EPOLLOUT
| EPOLLWRNORM
;
1448 if (tun
->dev
->reg_state
!= NETREG_REGISTERED
)
1455 static struct sk_buff
*tun_napi_alloc_frags(struct tun_file
*tfile
,
1457 const struct iov_iter
*it
)
1459 struct sk_buff
*skb
;
1464 if (it
->nr_segs
> MAX_SKB_FRAGS
+ 1 ||
1465 len
> (ETH_MAX_MTU
- NET_SKB_PAD
- NET_IP_ALIGN
))
1466 return ERR_PTR(-EMSGSIZE
);
1469 skb
= napi_get_frags(&tfile
->napi
);
1472 return ERR_PTR(-ENOMEM
);
1474 linear
= iov_iter_single_seg_count(it
);
1475 err
= __skb_grow(skb
, linear
);
1480 skb
->data_len
= len
- linear
;
1481 skb
->truesize
+= skb
->data_len
;
1483 for (i
= 1; i
< it
->nr_segs
; i
++) {
1484 const struct iovec
*iov
= iter_iov(it
);
1485 size_t fragsz
= iov
->iov_len
;
1489 if (fragsz
== 0 || fragsz
> PAGE_SIZE
) {
1493 frag
= netdev_alloc_frag(fragsz
);
1498 page
= virt_to_head_page(frag
);
1499 skb_fill_page_desc(skb
, i
- 1, page
,
1500 frag
- page_address(page
), fragsz
);
1505 /* frees skb and all frags allocated with napi_alloc_frag() */
1506 napi_free_frags(&tfile
->napi
);
1507 return ERR_PTR(err
);
1510 /* prepad is the amount to reserve at front. len is length after that.
1511 * linear is a hint as to how much to copy (usually headers). */
1512 static struct sk_buff
*tun_alloc_skb(struct tun_file
*tfile
,
1513 size_t prepad
, size_t len
,
1514 size_t linear
, int noblock
)
1516 struct sock
*sk
= tfile
->socket
.sk
;
1517 struct sk_buff
*skb
;
1520 /* Under a page? Don't bother with paged skb. */
1521 if (prepad
+ len
< PAGE_SIZE
)
1524 if (len
- linear
> MAX_SKB_FRAGS
* (PAGE_SIZE
<< PAGE_ALLOC_COSTLY_ORDER
))
1525 linear
= len
- MAX_SKB_FRAGS
* (PAGE_SIZE
<< PAGE_ALLOC_COSTLY_ORDER
);
1526 skb
= sock_alloc_send_pskb(sk
, prepad
+ linear
, len
- linear
, noblock
,
1527 &err
, PAGE_ALLOC_COSTLY_ORDER
);
1529 return ERR_PTR(err
);
1531 skb_reserve(skb
, prepad
);
1532 skb_put(skb
, linear
);
1533 skb
->data_len
= len
- linear
;
1534 skb
->len
+= len
- linear
;
1539 static void tun_rx_batched(struct tun_struct
*tun
, struct tun_file
*tfile
,
1540 struct sk_buff
*skb
, int more
)
1542 struct sk_buff_head
*queue
= &tfile
->sk
.sk_write_queue
;
1543 struct sk_buff_head process_queue
;
1544 u32 rx_batched
= tun
->rx_batched
;
1547 if (!rx_batched
|| (!more
&& skb_queue_empty(queue
))) {
1549 skb_record_rx_queue(skb
, tfile
->queue_index
);
1550 netif_receive_skb(skb
);
1555 spin_lock(&queue
->lock
);
1556 if (!more
|| skb_queue_len(queue
) == rx_batched
) {
1557 __skb_queue_head_init(&process_queue
);
1558 skb_queue_splice_tail_init(queue
, &process_queue
);
1561 __skb_queue_tail(queue
, skb
);
1563 spin_unlock(&queue
->lock
);
1566 struct sk_buff
*nskb
;
1569 while ((nskb
= __skb_dequeue(&process_queue
))) {
1570 skb_record_rx_queue(nskb
, tfile
->queue_index
);
1571 netif_receive_skb(nskb
);
1573 skb_record_rx_queue(skb
, tfile
->queue_index
);
1574 netif_receive_skb(skb
);
1579 static bool tun_can_build_skb(struct tun_struct
*tun
, struct tun_file
*tfile
,
1580 int len
, int noblock
, bool zerocopy
)
1582 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
1585 if (tfile
->socket
.sk
->sk_sndbuf
!= INT_MAX
)
1594 if (SKB_DATA_ALIGN(len
+ TUN_RX_PAD
+ XDP_PACKET_HEADROOM
) +
1595 SKB_DATA_ALIGN(sizeof(struct skb_shared_info
)) > PAGE_SIZE
)
1601 static struct sk_buff
*__tun_build_skb(struct tun_file
*tfile
,
1602 struct page_frag
*alloc_frag
, char *buf
,
1603 int buflen
, int len
, int pad
)
1605 struct sk_buff
*skb
= build_skb(buf
, buflen
);
1608 return ERR_PTR(-ENOMEM
);
1610 skb_reserve(skb
, pad
);
1612 skb_set_owner_w(skb
, tfile
->socket
.sk
);
1614 get_page(alloc_frag
->page
);
1615 alloc_frag
->offset
+= buflen
;
1620 static int tun_xdp_act(struct tun_struct
*tun
, struct bpf_prog
*xdp_prog
,
1621 struct xdp_buff
*xdp
, u32 act
)
1627 err
= xdp_do_redirect(tun
->dev
, xdp
, xdp_prog
);
1629 dev_core_stats_rx_dropped_inc(tun
->dev
);
1632 dev_sw_netstats_rx_add(tun
->dev
, xdp
->data_end
- xdp
->data
);
1635 err
= tun_xdp_tx(tun
->dev
, xdp
);
1637 dev_core_stats_rx_dropped_inc(tun
->dev
);
1640 dev_sw_netstats_rx_add(tun
->dev
, xdp
->data_end
- xdp
->data
);
1645 bpf_warn_invalid_xdp_action(tun
->dev
, xdp_prog
, act
);
1648 trace_xdp_exception(tun
->dev
, xdp_prog
, act
);
1651 dev_core_stats_rx_dropped_inc(tun
->dev
);
1658 static struct sk_buff
*tun_build_skb(struct tun_struct
*tun
,
1659 struct tun_file
*tfile
,
1660 struct iov_iter
*from
,
1661 struct virtio_net_hdr
*hdr
,
1662 int len
, int *skb_xdp
)
1664 struct page_frag
*alloc_frag
= ¤t
->task_frag
;
1665 struct bpf_net_context __bpf_net_ctx
, *bpf_net_ctx
;
1666 struct bpf_prog
*xdp_prog
;
1667 int buflen
= SKB_DATA_ALIGN(sizeof(struct skb_shared_info
));
1670 int pad
= TUN_RX_PAD
;
1674 xdp_prog
= rcu_dereference(tun
->xdp_prog
);
1676 pad
+= XDP_PACKET_HEADROOM
;
1677 buflen
+= SKB_DATA_ALIGN(len
+ pad
);
1680 alloc_frag
->offset
= ALIGN((u64
)alloc_frag
->offset
, SMP_CACHE_BYTES
);
1681 if (unlikely(!skb_page_frag_refill(buflen
, alloc_frag
, GFP_KERNEL
)))
1682 return ERR_PTR(-ENOMEM
);
1684 buf
= (char *)page_address(alloc_frag
->page
) + alloc_frag
->offset
;
1685 copied
= copy_page_from_iter(alloc_frag
->page
,
1686 alloc_frag
->offset
+ pad
,
1689 return ERR_PTR(-EFAULT
);
1691 /* There's a small window that XDP may be set after the check
1692 * of xdp_prog above, this should be rare and for simplicity
1693 * we do XDP on skb in case the headroom is not enough.
1695 if (hdr
->gso_type
|| !xdp_prog
) {
1697 return __tun_build_skb(tfile
, alloc_frag
, buf
, buflen
, len
,
1705 bpf_net_ctx
= bpf_net_ctx_set(&__bpf_net_ctx
);
1706 xdp_prog
= rcu_dereference(tun
->xdp_prog
);
1708 struct xdp_buff xdp
;
1711 xdp_init_buff(&xdp
, buflen
, &tfile
->xdp_rxq
);
1712 xdp_prepare_buff(&xdp
, buf
, pad
, len
, false);
1714 act
= bpf_prog_run_xdp(xdp_prog
, &xdp
);
1715 if (act
== XDP_REDIRECT
|| act
== XDP_TX
) {
1716 get_page(alloc_frag
->page
);
1717 alloc_frag
->offset
+= buflen
;
1719 err
= tun_xdp_act(tun
, xdp_prog
, &xdp
, act
);
1721 if (act
== XDP_REDIRECT
|| act
== XDP_TX
)
1722 put_page(alloc_frag
->page
);
1726 if (err
== XDP_REDIRECT
)
1728 if (err
!= XDP_PASS
)
1731 pad
= xdp
.data
- xdp
.data_hard_start
;
1732 len
= xdp
.data_end
- xdp
.data
;
1734 bpf_net_ctx_clear(bpf_net_ctx
);
1738 return __tun_build_skb(tfile
, alloc_frag
, buf
, buflen
, len
, pad
);
1741 bpf_net_ctx_clear(bpf_net_ctx
);
1747 /* Get packet from user space buffer */
1748 static ssize_t
tun_get_user(struct tun_struct
*tun
, struct tun_file
*tfile
,
1749 void *msg_control
, struct iov_iter
*from
,
1750 int noblock
, bool more
)
1752 struct tun_pi pi
= { 0, cpu_to_be16(ETH_P_IP
) };
1753 struct sk_buff
*skb
;
1754 size_t total_len
= iov_iter_count(from
);
1755 size_t len
= total_len
, align
= tun
->align
, linear
;
1756 struct virtio_net_hdr gso
= { 0 };
1759 bool zerocopy
= false;
1763 bool frags
= tun_napi_frags_enabled(tfile
);
1764 enum skb_drop_reason drop_reason
= SKB_DROP_REASON_NOT_SPECIFIED
;
1766 if (!(tun
->flags
& IFF_NO_PI
)) {
1767 if (len
< sizeof(pi
))
1771 if (!copy_from_iter_full(&pi
, sizeof(pi
), from
))
1775 if (tun
->flags
& IFF_VNET_HDR
) {
1776 int vnet_hdr_sz
= READ_ONCE(tun
->vnet_hdr_sz
);
1778 if (len
< vnet_hdr_sz
)
1782 if (!copy_from_iter_full(&gso
, sizeof(gso
), from
))
1785 if ((gso
.flags
& VIRTIO_NET_HDR_F_NEEDS_CSUM
) &&
1786 tun16_to_cpu(tun
, gso
.csum_start
) + tun16_to_cpu(tun
, gso
.csum_offset
) + 2 > tun16_to_cpu(tun
, gso
.hdr_len
))
1787 gso
.hdr_len
= cpu_to_tun16(tun
, tun16_to_cpu(tun
, gso
.csum_start
) + tun16_to_cpu(tun
, gso
.csum_offset
) + 2);
1789 if (tun16_to_cpu(tun
, gso
.hdr_len
) > len
)
1791 iov_iter_advance(from
, vnet_hdr_sz
- sizeof(gso
));
1794 if ((tun
->flags
& TUN_TYPE_MASK
) == IFF_TAP
) {
1795 align
+= NET_IP_ALIGN
;
1796 if (unlikely(len
< ETH_HLEN
||
1797 (gso
.hdr_len
&& tun16_to_cpu(tun
, gso
.hdr_len
) < ETH_HLEN
)))
1801 good_linear
= SKB_MAX_HEAD(align
);
1804 struct iov_iter i
= *from
;
1806 /* There are 256 bytes to be copied in skb, so there is
1807 * enough room for skb expand head in case it is used.
1808 * The rest of the buffer is mapped from userspace.
1810 copylen
= gso
.hdr_len
? tun16_to_cpu(tun
, gso
.hdr_len
) : GOODCOPY_LEN
;
1811 if (copylen
> good_linear
)
1812 copylen
= good_linear
;
1814 iov_iter_advance(&i
, copylen
);
1815 if (iov_iter_npages(&i
, INT_MAX
) <= MAX_SKB_FRAGS
)
1819 if (!frags
&& tun_can_build_skb(tun
, tfile
, len
, noblock
, zerocopy
)) {
1820 /* For the packet that is not easy to be processed
1821 * (e.g gso or jumbo packet), we will do it at after
1822 * skb was created with generic XDP routine.
1824 skb
= tun_build_skb(tun
, tfile
, from
, &gso
, len
, &skb_xdp
);
1825 err
= PTR_ERR_OR_ZERO(skb
);
1833 if (tun16_to_cpu(tun
, gso
.hdr_len
) > good_linear
)
1834 linear
= good_linear
;
1836 linear
= tun16_to_cpu(tun
, gso
.hdr_len
);
1840 mutex_lock(&tfile
->napi_mutex
);
1841 skb
= tun_napi_alloc_frags(tfile
, copylen
, from
);
1842 /* tun_napi_alloc_frags() enforces a layout for the skb.
1843 * If zerocopy is enabled, then this layout will be
1844 * overwritten by zerocopy_sg_from_iter().
1849 linear
= min_t(size_t, good_linear
, copylen
);
1851 skb
= tun_alloc_skb(tfile
, align
, copylen
, linear
,
1855 err
= PTR_ERR_OR_ZERO(skb
);
1860 err
= zerocopy_sg_from_iter(skb
, from
);
1862 err
= skb_copy_datagram_from_iter(skb
, 0, from
, len
);
1866 drop_reason
= SKB_DROP_REASON_SKB_UCOPY_FAULT
;
1871 if (virtio_net_hdr_to_skb(skb
, &gso
, tun_is_little_endian(tun
))) {
1872 atomic_long_inc(&tun
->rx_frame_errors
);
1877 switch (tun
->flags
& TUN_TYPE_MASK
) {
1879 if (tun
->flags
& IFF_NO_PI
) {
1880 u8 ip_version
= skb
->len
? (skb
->data
[0] >> 4) : 0;
1882 switch (ip_version
) {
1884 pi
.proto
= htons(ETH_P_IP
);
1887 pi
.proto
= htons(ETH_P_IPV6
);
1895 skb_reset_mac_header(skb
);
1896 skb
->protocol
= pi
.proto
;
1897 skb
->dev
= tun
->dev
;
1900 if (frags
&& !pskb_may_pull(skb
, ETH_HLEN
)) {
1902 drop_reason
= SKB_DROP_REASON_HDR_TRUNC
;
1905 skb
->protocol
= eth_type_trans(skb
, tun
->dev
);
1909 /* copy skb_ubuf_info for callback when skb has no error */
1911 skb_zcopy_init(skb
, msg_control
);
1912 } else if (msg_control
) {
1913 struct ubuf_info
*uarg
= msg_control
;
1914 uarg
->ops
->complete(NULL
, uarg
, false);
1917 skb_reset_network_header(skb
);
1918 skb_probe_transport_header(skb
);
1919 skb_record_rx_queue(skb
, tfile
->queue_index
);
1922 struct bpf_prog
*xdp_prog
;
1927 xdp_prog
= rcu_dereference(tun
->xdp_prog
);
1929 ret
= do_xdp_generic(xdp_prog
, &skb
);
1930 if (ret
!= XDP_PASS
) {
1940 /* Compute the costly rx hash only if needed for flow updates.
1941 * We may get a very small possibility of OOO during switching, not
1942 * worth to optimize.
1944 if (!rcu_access_pointer(tun
->steering_prog
) && tun
->numqueues
> 1 &&
1946 rxhash
= __skb_get_hash_symmetric(skb
);
1949 if (unlikely(!(tun
->dev
->flags
& IFF_UP
))) {
1952 drop_reason
= SKB_DROP_REASON_DEV_READY
;
1959 /* Exercise flow dissector code path. */
1960 skb_push(skb
, ETH_HLEN
);
1961 headlen
= eth_get_headlen(tun
->dev
, skb
->data
,
1964 if (unlikely(headlen
> skb_headlen(skb
))) {
1967 dev_core_stats_rx_dropped_inc(tun
->dev
);
1969 napi_free_frags(&tfile
->napi
);
1971 mutex_unlock(&tfile
->napi_mutex
);
1975 if (likely(napi_schedule_prep(&tfile
->napi
))) {
1977 napi_gro_frags(&tfile
->napi
);
1978 napi_complete(&tfile
->napi
);
1984 mutex_unlock(&tfile
->napi_mutex
);
1985 } else if (tfile
->napi_enabled
) {
1986 struct sk_buff_head
*queue
= &tfile
->sk
.sk_write_queue
;
1989 spin_lock_bh(&queue
->lock
);
1991 if (unlikely(tfile
->detached
)) {
1992 spin_unlock_bh(&queue
->lock
);
1998 __skb_queue_tail(queue
, skb
);
1999 queue_len
= skb_queue_len(queue
);
2000 spin_unlock(&queue
->lock
);
2002 if (!more
|| queue_len
> NAPI_POLL_WEIGHT
)
2003 napi_schedule(&tfile
->napi
);
2006 } else if (!IS_ENABLED(CONFIG_4KSTACKS
)) {
2007 tun_rx_batched(tun
, tfile
, skb
, more
);
2014 dev_sw_netstats_rx_add(tun
->dev
, len
);
2018 tun_flow_update(tun
, rxhash
, tfile
);
2024 dev_core_stats_rx_dropped_inc(tun
->dev
);
2027 if (!IS_ERR_OR_NULL(skb
))
2028 kfree_skb_reason(skb
, drop_reason
);
2032 tfile
->napi
.skb
= NULL
;
2033 mutex_unlock(&tfile
->napi_mutex
);
2036 return err
?: total_len
;
2039 static ssize_t
tun_chr_write_iter(struct kiocb
*iocb
, struct iov_iter
*from
)
2041 struct file
*file
= iocb
->ki_filp
;
2042 struct tun_file
*tfile
= file
->private_data
;
2043 struct tun_struct
*tun
= tun_get(tfile
);
2050 if ((file
->f_flags
& O_NONBLOCK
) || (iocb
->ki_flags
& IOCB_NOWAIT
))
2053 result
= tun_get_user(tun
, tfile
, NULL
, from
, noblock
, false);
2059 static ssize_t
tun_put_user_xdp(struct tun_struct
*tun
,
2060 struct tun_file
*tfile
,
2061 struct xdp_frame
*xdp_frame
,
2062 struct iov_iter
*iter
)
2064 int vnet_hdr_sz
= 0;
2065 size_t size
= xdp_frame
->len
;
2068 if (tun
->flags
& IFF_VNET_HDR
) {
2069 struct virtio_net_hdr gso
= { 0 };
2071 vnet_hdr_sz
= READ_ONCE(tun
->vnet_hdr_sz
);
2072 if (unlikely(iov_iter_count(iter
) < vnet_hdr_sz
))
2074 if (unlikely(copy_to_iter(&gso
, sizeof(gso
), iter
) !=
2077 iov_iter_advance(iter
, vnet_hdr_sz
- sizeof(gso
));
2080 ret
= copy_to_iter(xdp_frame
->data
, size
, iter
) + vnet_hdr_sz
;
2083 dev_sw_netstats_tx_add(tun
->dev
, 1, ret
);
2089 /* Put packet to the user space buffer */
2090 static ssize_t
tun_put_user(struct tun_struct
*tun
,
2091 struct tun_file
*tfile
,
2092 struct sk_buff
*skb
,
2093 struct iov_iter
*iter
)
2095 struct tun_pi pi
= { 0, skb
->protocol
};
2097 int vlan_offset
= 0;
2099 int vnet_hdr_sz
= 0;
2101 if (skb_vlan_tag_present(skb
))
2102 vlan_hlen
= VLAN_HLEN
;
2104 if (tun
->flags
& IFF_VNET_HDR
)
2105 vnet_hdr_sz
= READ_ONCE(tun
->vnet_hdr_sz
);
2107 total
= skb
->len
+ vlan_hlen
+ vnet_hdr_sz
;
2109 if (!(tun
->flags
& IFF_NO_PI
)) {
2110 if (iov_iter_count(iter
) < sizeof(pi
))
2113 total
+= sizeof(pi
);
2114 if (iov_iter_count(iter
) < total
) {
2115 /* Packet will be striped */
2116 pi
.flags
|= TUN_PKT_STRIP
;
2119 if (copy_to_iter(&pi
, sizeof(pi
), iter
) != sizeof(pi
))
2124 struct virtio_net_hdr gso
;
2126 if (iov_iter_count(iter
) < vnet_hdr_sz
)
2129 if (virtio_net_hdr_from_skb(skb
, &gso
,
2130 tun_is_little_endian(tun
), true,
2132 struct skb_shared_info
*sinfo
= skb_shinfo(skb
);
2134 if (net_ratelimit()) {
2135 netdev_err(tun
->dev
, "unexpected GSO type: 0x%x, gso_size %d, hdr_len %d\n",
2136 sinfo
->gso_type
, tun16_to_cpu(tun
, gso
.gso_size
),
2137 tun16_to_cpu(tun
, gso
.hdr_len
));
2138 print_hex_dump(KERN_ERR
, "tun: ",
2141 min((int)tun16_to_cpu(tun
, gso
.hdr_len
), 64), true);
2147 if (copy_to_iter(&gso
, sizeof(gso
), iter
) != sizeof(gso
))
2150 iov_iter_advance(iter
, vnet_hdr_sz
- sizeof(gso
));
2157 veth
.h_vlan_proto
= skb
->vlan_proto
;
2158 veth
.h_vlan_TCI
= htons(skb_vlan_tag_get(skb
));
2160 vlan_offset
= offsetof(struct vlan_ethhdr
, h_vlan_proto
);
2162 ret
= skb_copy_datagram_iter(skb
, 0, iter
, vlan_offset
);
2163 if (ret
|| !iov_iter_count(iter
))
2166 ret
= copy_to_iter(&veth
, sizeof(veth
), iter
);
2167 if (ret
!= sizeof(veth
) || !iov_iter_count(iter
))
2171 skb_copy_datagram_iter(skb
, vlan_offset
, iter
, skb
->len
- vlan_offset
);
2174 /* caller is in process context, */
2176 dev_sw_netstats_tx_add(tun
->dev
, 1, skb
->len
+ vlan_hlen
);
2182 static void *tun_ring_recv(struct tun_file
*tfile
, int noblock
, int *err
)
2184 DECLARE_WAITQUEUE(wait
, current
);
2188 ptr
= ptr_ring_consume(&tfile
->tx_ring
);
2196 add_wait_queue(&tfile
->socket
.wq
.wait
, &wait
);
2199 set_current_state(TASK_INTERRUPTIBLE
);
2200 ptr
= ptr_ring_consume(&tfile
->tx_ring
);
2203 if (signal_pending(current
)) {
2204 error
= -ERESTARTSYS
;
2207 if (tfile
->socket
.sk
->sk_shutdown
& RCV_SHUTDOWN
) {
2215 __set_current_state(TASK_RUNNING
);
2216 remove_wait_queue(&tfile
->socket
.wq
.wait
, &wait
);
2223 static ssize_t
tun_do_read(struct tun_struct
*tun
, struct tun_file
*tfile
,
2224 struct iov_iter
*to
,
2225 int noblock
, void *ptr
)
2230 if (!iov_iter_count(to
)) {
2236 /* Read frames from ring */
2237 ptr
= tun_ring_recv(tfile
, noblock
, &err
);
2242 if (tun_is_xdp_frame(ptr
)) {
2243 struct xdp_frame
*xdpf
= tun_ptr_to_xdp(ptr
);
2245 ret
= tun_put_user_xdp(tun
, tfile
, xdpf
, to
);
2246 xdp_return_frame(xdpf
);
2248 struct sk_buff
*skb
= ptr
;
2250 ret
= tun_put_user(tun
, tfile
, skb
, to
);
2251 if (unlikely(ret
< 0))
2260 static ssize_t
tun_chr_read_iter(struct kiocb
*iocb
, struct iov_iter
*to
)
2262 struct file
*file
= iocb
->ki_filp
;
2263 struct tun_file
*tfile
= file
->private_data
;
2264 struct tun_struct
*tun
= tun_get(tfile
);
2265 ssize_t len
= iov_iter_count(to
), ret
;
2271 if ((file
->f_flags
& O_NONBLOCK
) || (iocb
->ki_flags
& IOCB_NOWAIT
))
2274 ret
= tun_do_read(tun
, tfile
, to
, noblock
, NULL
);
2275 ret
= min_t(ssize_t
, ret
, len
);
2282 static void tun_prog_free(struct rcu_head
*rcu
)
2284 struct tun_prog
*prog
= container_of(rcu
, struct tun_prog
, rcu
);
2286 bpf_prog_destroy(prog
->prog
);
2290 static int __tun_set_ebpf(struct tun_struct
*tun
,
2291 struct tun_prog __rcu
**prog_p
,
2292 struct bpf_prog
*prog
)
2294 struct tun_prog
*old
, *new = NULL
;
2297 new = kmalloc(sizeof(*new), GFP_KERNEL
);
2303 spin_lock_bh(&tun
->lock
);
2304 old
= rcu_dereference_protected(*prog_p
,
2305 lockdep_is_held(&tun
->lock
));
2306 rcu_assign_pointer(*prog_p
, new);
2307 spin_unlock_bh(&tun
->lock
);
2310 call_rcu(&old
->rcu
, tun_prog_free
);
2315 static void tun_free_netdev(struct net_device
*dev
)
2317 struct tun_struct
*tun
= netdev_priv(dev
);
2319 BUG_ON(!(list_empty(&tun
->disabled
)));
2321 tun_flow_uninit(tun
);
2322 security_tun_dev_free_security(tun
->security
);
2323 __tun_set_ebpf(tun
, &tun
->steering_prog
, NULL
);
2324 __tun_set_ebpf(tun
, &tun
->filter_prog
, NULL
);
2327 static void tun_setup(struct net_device
*dev
)
2329 struct tun_struct
*tun
= netdev_priv(dev
);
2331 tun
->owner
= INVALID_UID
;
2332 tun
->group
= INVALID_GID
;
2333 tun_default_link_ksettings(dev
, &tun
->link_ksettings
);
2335 dev
->ethtool_ops
= &tun_ethtool_ops
;
2336 dev
->needs_free_netdev
= true;
2337 dev
->priv_destructor
= tun_free_netdev
;
2338 /* We prefer our own queue length */
2339 dev
->tx_queue_len
= TUN_READQ_SIZE
;
2342 /* Trivial set of netlink ops to allow deleting tun or tap
2343 * device with netlink.
2345 static int tun_validate(struct nlattr
*tb
[], struct nlattr
*data
[],
2346 struct netlink_ext_ack
*extack
)
2348 NL_SET_ERR_MSG(extack
,
2349 "tun/tap creation via rtnetlink is not supported.");
2353 static size_t tun_get_size(const struct net_device
*dev
)
2355 BUILD_BUG_ON(sizeof(u32
) != sizeof(uid_t
));
2356 BUILD_BUG_ON(sizeof(u32
) != sizeof(gid_t
));
2358 return nla_total_size(sizeof(uid_t
)) + /* OWNER */
2359 nla_total_size(sizeof(gid_t
)) + /* GROUP */
2360 nla_total_size(sizeof(u8
)) + /* TYPE */
2361 nla_total_size(sizeof(u8
)) + /* PI */
2362 nla_total_size(sizeof(u8
)) + /* VNET_HDR */
2363 nla_total_size(sizeof(u8
)) + /* PERSIST */
2364 nla_total_size(sizeof(u8
)) + /* MULTI_QUEUE */
2365 nla_total_size(sizeof(u32
)) + /* NUM_QUEUES */
2366 nla_total_size(sizeof(u32
)) + /* NUM_DISABLED_QUEUES */
2370 static int tun_fill_info(struct sk_buff
*skb
, const struct net_device
*dev
)
2372 struct tun_struct
*tun
= netdev_priv(dev
);
2374 if (nla_put_u8(skb
, IFLA_TUN_TYPE
, tun
->flags
& TUN_TYPE_MASK
))
2375 goto nla_put_failure
;
2376 if (uid_valid(tun
->owner
) &&
2377 nla_put_u32(skb
, IFLA_TUN_OWNER
,
2378 from_kuid_munged(current_user_ns(), tun
->owner
)))
2379 goto nla_put_failure
;
2380 if (gid_valid(tun
->group
) &&
2381 nla_put_u32(skb
, IFLA_TUN_GROUP
,
2382 from_kgid_munged(current_user_ns(), tun
->group
)))
2383 goto nla_put_failure
;
2384 if (nla_put_u8(skb
, IFLA_TUN_PI
, !(tun
->flags
& IFF_NO_PI
)))
2385 goto nla_put_failure
;
2386 if (nla_put_u8(skb
, IFLA_TUN_VNET_HDR
, !!(tun
->flags
& IFF_VNET_HDR
)))
2387 goto nla_put_failure
;
2388 if (nla_put_u8(skb
, IFLA_TUN_PERSIST
, !!(tun
->flags
& IFF_PERSIST
)))
2389 goto nla_put_failure
;
2390 if (nla_put_u8(skb
, IFLA_TUN_MULTI_QUEUE
,
2391 !!(tun
->flags
& IFF_MULTI_QUEUE
)))
2392 goto nla_put_failure
;
2393 if (tun
->flags
& IFF_MULTI_QUEUE
) {
2394 if (nla_put_u32(skb
, IFLA_TUN_NUM_QUEUES
, tun
->numqueues
))
2395 goto nla_put_failure
;
2396 if (nla_put_u32(skb
, IFLA_TUN_NUM_DISABLED_QUEUES
,
2398 goto nla_put_failure
;
2407 static struct rtnl_link_ops tun_link_ops __read_mostly
= {
2409 .priv_size
= sizeof(struct tun_struct
),
2411 .validate
= tun_validate
,
2412 .get_size
= tun_get_size
,
2413 .fill_info
= tun_fill_info
,
2416 static void tun_sock_write_space(struct sock
*sk
)
2418 struct tun_file
*tfile
;
2419 wait_queue_head_t
*wqueue
;
2421 if (!sock_writeable(sk
))
2424 if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE
, &sk
->sk_socket
->flags
))
2427 wqueue
= sk_sleep(sk
);
2428 if (wqueue
&& waitqueue_active(wqueue
))
2429 wake_up_interruptible_sync_poll(wqueue
, EPOLLOUT
|
2430 EPOLLWRNORM
| EPOLLWRBAND
);
2432 tfile
= container_of(sk
, struct tun_file
, sk
);
2433 kill_fasync(&tfile
->fasync
, SIGIO
, POLL_OUT
);
2436 static void tun_put_page(struct tun_page
*tpage
)
2439 __page_frag_cache_drain(tpage
->page
, tpage
->count
);
2442 static int tun_xdp_one(struct tun_struct
*tun
,
2443 struct tun_file
*tfile
,
2444 struct xdp_buff
*xdp
, int *flush
,
2445 struct tun_page
*tpage
)
2447 unsigned int datasize
= xdp
->data_end
- xdp
->data
;
2448 struct tun_xdp_hdr
*hdr
= xdp
->data_hard_start
;
2449 struct virtio_net_hdr
*gso
= &hdr
->gso
;
2450 struct bpf_prog
*xdp_prog
;
2451 struct sk_buff
*skb
= NULL
;
2452 struct sk_buff_head
*queue
;
2453 u32 rxhash
= 0, act
;
2454 int buflen
= hdr
->buflen
;
2456 bool skb_xdp
= false;
2459 if (unlikely(datasize
< ETH_HLEN
))
2462 xdp_prog
= rcu_dereference(tun
->xdp_prog
);
2464 if (gso
->gso_type
) {
2469 xdp_init_buff(xdp
, buflen
, &tfile
->xdp_rxq
);
2470 xdp_set_data_meta_invalid(xdp
);
2472 act
= bpf_prog_run_xdp(xdp_prog
, xdp
);
2473 ret
= tun_xdp_act(tun
, xdp_prog
, xdp
, act
);
2475 put_page(virt_to_head_page(xdp
->data
));
2488 page
= virt_to_head_page(xdp
->data
);
2489 if (tpage
->page
== page
) {
2492 tun_put_page(tpage
);
2501 skb
= build_skb(xdp
->data_hard_start
, buflen
);
2507 skb_reserve(skb
, xdp
->data
- xdp
->data_hard_start
);
2508 skb_put(skb
, xdp
->data_end
- xdp
->data
);
2510 if (virtio_net_hdr_to_skb(skb
, gso
, tun_is_little_endian(tun
))) {
2511 atomic_long_inc(&tun
->rx_frame_errors
);
2517 skb
->protocol
= eth_type_trans(skb
, tun
->dev
);
2518 skb_reset_network_header(skb
);
2519 skb_probe_transport_header(skb
);
2520 skb_record_rx_queue(skb
, tfile
->queue_index
);
2523 ret
= do_xdp_generic(xdp_prog
, &skb
);
2524 if (ret
!= XDP_PASS
) {
2530 if (!rcu_dereference(tun
->steering_prog
) && tun
->numqueues
> 1 &&
2532 rxhash
= __skb_get_hash_symmetric(skb
);
2534 if (tfile
->napi_enabled
) {
2535 queue
= &tfile
->sk
.sk_write_queue
;
2536 spin_lock(&queue
->lock
);
2538 if (unlikely(tfile
->detached
)) {
2539 spin_unlock(&queue
->lock
);
2544 __skb_queue_tail(queue
, skb
);
2545 spin_unlock(&queue
->lock
);
2548 netif_receive_skb(skb
);
2552 /* No need to disable preemption here since this function is
2553 * always called with bh disabled
2555 dev_sw_netstats_rx_add(tun
->dev
, datasize
);
2558 tun_flow_update(tun
, rxhash
, tfile
);
2564 static int tun_sendmsg(struct socket
*sock
, struct msghdr
*m
, size_t total_len
)
2567 struct tun_file
*tfile
= container_of(sock
, struct tun_file
, socket
);
2568 struct tun_struct
*tun
= tun_get(tfile
);
2569 struct tun_msg_ctl
*ctl
= m
->msg_control
;
2570 struct xdp_buff
*xdp
;
2575 if (m
->msg_controllen
== sizeof(struct tun_msg_ctl
) &&
2576 ctl
&& ctl
->type
== TUN_MSG_PTR
) {
2577 struct bpf_net_context __bpf_net_ctx
, *bpf_net_ctx
;
2578 struct tun_page tpage
;
2580 int flush
= 0, queued
= 0;
2582 memset(&tpage
, 0, sizeof(tpage
));
2586 bpf_net_ctx
= bpf_net_ctx_set(&__bpf_net_ctx
);
2588 for (i
= 0; i
< n
; i
++) {
2589 xdp
= &((struct xdp_buff
*)ctl
->ptr
)[i
];
2590 ret
= tun_xdp_one(tun
, tfile
, xdp
, &flush
, &tpage
);
2598 if (tfile
->napi_enabled
&& queued
> 0)
2599 napi_schedule(&tfile
->napi
);
2601 bpf_net_ctx_clear(bpf_net_ctx
);
2605 tun_put_page(&tpage
);
2611 ret
= tun_get_user(tun
, tfile
, ctl
? ctl
->ptr
: NULL
, &m
->msg_iter
,
2612 m
->msg_flags
& MSG_DONTWAIT
,
2613 m
->msg_flags
& MSG_MORE
);
2619 static int tun_recvmsg(struct socket
*sock
, struct msghdr
*m
, size_t total_len
,
2622 struct tun_file
*tfile
= container_of(sock
, struct tun_file
, socket
);
2623 struct tun_struct
*tun
= tun_get(tfile
);
2624 void *ptr
= m
->msg_control
;
2632 if (flags
& ~(MSG_DONTWAIT
|MSG_TRUNC
|MSG_ERRQUEUE
)) {
2636 if (flags
& MSG_ERRQUEUE
) {
2637 ret
= sock_recv_errqueue(sock
->sk
, m
, total_len
,
2638 SOL_PACKET
, TUN_TX_TIMESTAMP
);
2641 ret
= tun_do_read(tun
, tfile
, &m
->msg_iter
, flags
& MSG_DONTWAIT
, ptr
);
2642 if (ret
> (ssize_t
)total_len
) {
2643 m
->msg_flags
|= MSG_TRUNC
;
2644 ret
= flags
& MSG_TRUNC
? ret
: total_len
;
2657 static int tun_ptr_peek_len(void *ptr
)
2660 if (tun_is_xdp_frame(ptr
)) {
2661 struct xdp_frame
*xdpf
= tun_ptr_to_xdp(ptr
);
2665 return __skb_array_len_with_tag(ptr
);
2671 static int tun_peek_len(struct socket
*sock
)
2673 struct tun_file
*tfile
= container_of(sock
, struct tun_file
, socket
);
2674 struct tun_struct
*tun
;
2677 tun
= tun_get(tfile
);
2681 ret
= PTR_RING_PEEK_CALL(&tfile
->tx_ring
, tun_ptr_peek_len
);
2687 /* Ops structure to mimic raw sockets with tun */
2688 static const struct proto_ops tun_socket_ops
= {
2689 .peek_len
= tun_peek_len
,
2690 .sendmsg
= tun_sendmsg
,
2691 .recvmsg
= tun_recvmsg
,
2694 static struct proto tun_proto
= {
2696 .owner
= THIS_MODULE
,
2697 .obj_size
= sizeof(struct tun_file
),
2700 static int tun_flags(struct tun_struct
*tun
)
2702 return tun
->flags
& (TUN_FEATURES
| IFF_PERSIST
| IFF_TUN
| IFF_TAP
);
2705 static ssize_t
tun_flags_show(struct device
*dev
, struct device_attribute
*attr
,
2708 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
2709 return sysfs_emit(buf
, "0x%x\n", tun_flags(tun
));
2712 static ssize_t
owner_show(struct device
*dev
, struct device_attribute
*attr
,
2715 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
2716 return uid_valid(tun
->owner
)?
2717 sysfs_emit(buf
, "%u\n",
2718 from_kuid_munged(current_user_ns(), tun
->owner
)) :
2719 sysfs_emit(buf
, "-1\n");
2722 static ssize_t
group_show(struct device
*dev
, struct device_attribute
*attr
,
2725 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
2726 return gid_valid(tun
->group
) ?
2727 sysfs_emit(buf
, "%u\n",
2728 from_kgid_munged(current_user_ns(), tun
->group
)) :
2729 sysfs_emit(buf
, "-1\n");
2732 static DEVICE_ATTR_RO(tun_flags
);
2733 static DEVICE_ATTR_RO(owner
);
2734 static DEVICE_ATTR_RO(group
);
2736 static struct attribute
*tun_dev_attrs
[] = {
2737 &dev_attr_tun_flags
.attr
,
2738 &dev_attr_owner
.attr
,
2739 &dev_attr_group
.attr
,
2743 static const struct attribute_group tun_attr_group
= {
2744 .attrs
= tun_dev_attrs
2747 static int tun_set_iff(struct net
*net
, struct file
*file
, struct ifreq
*ifr
)
2749 struct tun_struct
*tun
;
2750 struct tun_file
*tfile
= file
->private_data
;
2751 struct net_device
*dev
;
2754 if (tfile
->detached
)
2757 if ((ifr
->ifr_flags
& IFF_NAPI_FRAGS
)) {
2758 if (!capable(CAP_NET_ADMIN
))
2761 if (!(ifr
->ifr_flags
& IFF_NAPI
) ||
2762 (ifr
->ifr_flags
& TUN_TYPE_MASK
) != IFF_TAP
)
2766 dev
= __dev_get_by_name(net
, ifr
->ifr_name
);
2768 if (ifr
->ifr_flags
& IFF_TUN_EXCL
)
2770 if ((ifr
->ifr_flags
& IFF_TUN
) && dev
->netdev_ops
== &tun_netdev_ops
)
2771 tun
= netdev_priv(dev
);
2772 else if ((ifr
->ifr_flags
& IFF_TAP
) && dev
->netdev_ops
== &tap_netdev_ops
)
2773 tun
= netdev_priv(dev
);
2777 if (!!(ifr
->ifr_flags
& IFF_MULTI_QUEUE
) !=
2778 !!(tun
->flags
& IFF_MULTI_QUEUE
))
2781 if (tun_not_capable(tun
))
2783 err
= security_tun_dev_open(tun
->security
);
2787 err
= tun_attach(tun
, file
, ifr
->ifr_flags
& IFF_NOFILTER
,
2788 ifr
->ifr_flags
& IFF_NAPI
,
2789 ifr
->ifr_flags
& IFF_NAPI_FRAGS
, true);
2793 if (tun
->flags
& IFF_MULTI_QUEUE
&&
2794 (tun
->numqueues
+ tun
->numdisabled
> 1)) {
2795 /* One or more queue has already been attached, no need
2796 * to initialize the device again.
2798 netdev_state_change(dev
);
2802 tun
->flags
= (tun
->flags
& ~TUN_FEATURES
) |
2803 (ifr
->ifr_flags
& TUN_FEATURES
);
2805 netdev_state_change(dev
);
2808 unsigned long flags
= 0;
2809 int queues
= ifr
->ifr_flags
& IFF_MULTI_QUEUE
?
2812 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
2814 err
= security_tun_dev_create();
2819 if (ifr
->ifr_flags
& IFF_TUN
) {
2823 } else if (ifr
->ifr_flags
& IFF_TAP
) {
2831 name
= ifr
->ifr_name
;
2833 dev
= alloc_netdev_mqs(sizeof(struct tun_struct
), name
,
2834 NET_NAME_UNKNOWN
, tun_setup
, queues
,
2840 dev_net_set(dev
, net
);
2841 dev
->rtnl_link_ops
= &tun_link_ops
;
2842 dev
->ifindex
= tfile
->ifindex
;
2843 dev
->sysfs_groups
[0] = &tun_attr_group
;
2845 tun
= netdev_priv(dev
);
2848 tun
->txflt
.count
= 0;
2849 tun
->vnet_hdr_sz
= sizeof(struct virtio_net_hdr
);
2851 tun
->align
= NET_SKB_PAD
;
2852 tun
->filter_attached
= false;
2853 tun
->sndbuf
= tfile
->socket
.sk
->sk_sndbuf
;
2854 tun
->rx_batched
= 0;
2855 RCU_INIT_POINTER(tun
->steering_prog
, NULL
);
2860 tun_net_initialize(dev
);
2862 err
= register_netdevice(tun
->dev
);
2867 /* free_netdev() won't check refcnt, to avoid race
2868 * with dev_put() we need publish tun after registration.
2870 rcu_assign_pointer(tfile
->tun
, tun
);
2873 if (ifr
->ifr_flags
& IFF_NO_CARRIER
)
2874 netif_carrier_off(tun
->dev
);
2876 netif_carrier_on(tun
->dev
);
2878 /* Make sure persistent devices do not get stuck in
2881 if (netif_running(tun
->dev
))
2882 netif_tx_wake_all_queues(tun
->dev
);
2884 strcpy(ifr
->ifr_name
, tun
->dev
->name
);
2888 static void tun_get_iff(struct tun_struct
*tun
, struct ifreq
*ifr
)
2890 strcpy(ifr
->ifr_name
, tun
->dev
->name
);
2892 ifr
->ifr_flags
= tun_flags(tun
);
2896 /* This is like a cut-down ethtool ops, except done via tun fd so no
2897 * privs required. */
2898 static int set_offload(struct tun_struct
*tun
, unsigned long arg
)
2900 netdev_features_t features
= 0;
2902 if (arg
& TUN_F_CSUM
) {
2903 features
|= NETIF_F_HW_CSUM
;
2906 if (arg
& (TUN_F_TSO4
|TUN_F_TSO6
)) {
2907 if (arg
& TUN_F_TSO_ECN
) {
2908 features
|= NETIF_F_TSO_ECN
;
2909 arg
&= ~TUN_F_TSO_ECN
;
2911 if (arg
& TUN_F_TSO4
)
2912 features
|= NETIF_F_TSO
;
2913 if (arg
& TUN_F_TSO6
)
2914 features
|= NETIF_F_TSO6
;
2915 arg
&= ~(TUN_F_TSO4
|TUN_F_TSO6
);
2920 /* TODO: for now USO4 and USO6 should work simultaneously */
2921 if (arg
& TUN_F_USO4
&& arg
& TUN_F_USO6
) {
2922 features
|= NETIF_F_GSO_UDP_L4
;
2923 arg
&= ~(TUN_F_USO4
| TUN_F_USO6
);
2927 /* This gives the user a way to test for new features in future by
2928 * trying to set them. */
2932 tun
->set_features
= features
;
2933 tun
->dev
->wanted_features
&= ~TUN_USER_FEATURES
;
2934 tun
->dev
->wanted_features
|= features
;
2935 netdev_update_features(tun
->dev
);
2940 static void tun_detach_filter(struct tun_struct
*tun
, int n
)
2943 struct tun_file
*tfile
;
2945 for (i
= 0; i
< n
; i
++) {
2946 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
2947 lock_sock(tfile
->socket
.sk
);
2948 sk_detach_filter(tfile
->socket
.sk
);
2949 release_sock(tfile
->socket
.sk
);
2952 tun
->filter_attached
= false;
2955 static int tun_attach_filter(struct tun_struct
*tun
)
2958 struct tun_file
*tfile
;
2960 for (i
= 0; i
< tun
->numqueues
; i
++) {
2961 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
2962 lock_sock(tfile
->socket
.sk
);
2963 ret
= sk_attach_filter(&tun
->fprog
, tfile
->socket
.sk
);
2964 release_sock(tfile
->socket
.sk
);
2966 tun_detach_filter(tun
, i
);
2971 tun
->filter_attached
= true;
2975 static void tun_set_sndbuf(struct tun_struct
*tun
)
2977 struct tun_file
*tfile
;
2980 for (i
= 0; i
< tun
->numqueues
; i
++) {
2981 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
2982 tfile
->socket
.sk
->sk_sndbuf
= tun
->sndbuf
;
2986 static int tun_set_queue(struct file
*file
, struct ifreq
*ifr
)
2988 struct tun_file
*tfile
= file
->private_data
;
2989 struct tun_struct
*tun
;
2994 if (ifr
->ifr_flags
& IFF_ATTACH_QUEUE
) {
2995 tun
= tfile
->detached
;
3000 ret
= security_tun_dev_attach_queue(tun
->security
);
3003 ret
= tun_attach(tun
, file
, false, tun
->flags
& IFF_NAPI
,
3004 tun
->flags
& IFF_NAPI_FRAGS
, true);
3005 } else if (ifr
->ifr_flags
& IFF_DETACH_QUEUE
) {
3006 tun
= rtnl_dereference(tfile
->tun
);
3007 if (!tun
|| !(tun
->flags
& IFF_MULTI_QUEUE
) || tfile
->detached
)
3010 __tun_detach(tfile
, false);
3015 netdev_state_change(tun
->dev
);
3022 static int tun_set_ebpf(struct tun_struct
*tun
, struct tun_prog __rcu
**prog_p
,
3025 struct bpf_prog
*prog
;
3028 if (copy_from_user(&fd
, data
, sizeof(fd
)))
3034 prog
= bpf_prog_get_type(fd
, BPF_PROG_TYPE_SOCKET_FILTER
);
3036 return PTR_ERR(prog
);
3039 return __tun_set_ebpf(tun
, prog_p
, prog
);
3042 /* Return correct value for tun->dev->addr_len based on tun->dev->type. */
3043 static unsigned char tun_get_addr_len(unsigned short type
)
3047 case ARPHRD_TUNNEL6
:
3048 return sizeof(struct in6_addr
);
3055 case ARPHRD_IEEE802154
:
3056 case ARPHRD_IEEE802154_MONITOR
:
3057 return IEEE802154_EXTENDED_ADDR_LEN
;
3058 case ARPHRD_PHONET_PIPE
:
3062 case ARPHRD_6LOWPAN
:
3063 return EUI64_ADDR_LEN
;
3068 case ARPHRD_IEEE802
:
3071 return ROSE_ADDR_LEN
;
3073 return AX25_ADDR_LEN
;
3074 case ARPHRD_LOCALTLK
:
3081 static long __tun_chr_ioctl(struct file
*file
, unsigned int cmd
,
3082 unsigned long arg
, int ifreq_len
)
3084 struct tun_file
*tfile
= file
->private_data
;
3085 struct net
*net
= sock_net(&tfile
->sk
);
3086 struct tun_struct
*tun
;
3087 void __user
* argp
= (void __user
*)arg
;
3088 unsigned int carrier
;
3097 bool do_notify
= false;
3099 if (cmd
== TUNSETIFF
|| cmd
== TUNSETQUEUE
||
3100 (_IOC_TYPE(cmd
) == SOCK_IOC_TYPE
&& cmd
!= SIOCGSKNS
)) {
3101 if (copy_from_user(&ifr
, argp
, ifreq_len
))
3104 memset(&ifr
, 0, sizeof(ifr
));
3106 if (cmd
== TUNGETFEATURES
) {
3107 /* Currently this just means: "what IFF flags are valid?".
3108 * This is needed because we never checked for invalid flags on
3111 return put_user(IFF_TUN
| IFF_TAP
| IFF_NO_CARRIER
|
3112 TUN_FEATURES
, (unsigned int __user
*)argp
);
3113 } else if (cmd
== TUNSETQUEUE
) {
3114 return tun_set_queue(file
, &ifr
);
3115 } else if (cmd
== SIOCGSKNS
) {
3116 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
3118 return open_related_ns(&net
->ns
, get_net_ns
);
3123 tun
= tun_get(tfile
);
3124 if (cmd
== TUNSETIFF
) {
3129 ifr
.ifr_name
[IFNAMSIZ
-1] = '\0';
3131 ret
= tun_set_iff(net
, file
, &ifr
);
3136 if (copy_to_user(argp
, &ifr
, ifreq_len
))
3140 if (cmd
== TUNSETIFINDEX
) {
3146 if (copy_from_user(&ifindex
, argp
, sizeof(ifindex
)))
3152 tfile
->ifindex
= ifindex
;
3160 netif_info(tun
, drv
, tun
->dev
, "tun_chr_ioctl cmd %u\n", cmd
);
3162 net
= dev_net(tun
->dev
);
3166 tun_get_iff(tun
, &ifr
);
3168 if (tfile
->detached
)
3169 ifr
.ifr_flags
|= IFF_DETACH_QUEUE
;
3170 if (!tfile
->socket
.sk
->sk_filter
)
3171 ifr
.ifr_flags
|= IFF_NOFILTER
;
3173 if (copy_to_user(argp
, &ifr
, ifreq_len
))
3178 /* Disable/Enable checksum */
3180 /* [unimplemented] */
3181 netif_info(tun
, drv
, tun
->dev
, "ignored: set checksum %s\n",
3182 arg
? "disabled" : "enabled");
3186 /* Disable/Enable persist mode. Keep an extra reference to the
3187 * module to prevent the module being unprobed.
3189 if (arg
&& !(tun
->flags
& IFF_PERSIST
)) {
3190 tun
->flags
|= IFF_PERSIST
;
3191 __module_get(THIS_MODULE
);
3194 if (!arg
&& (tun
->flags
& IFF_PERSIST
)) {
3195 tun
->flags
&= ~IFF_PERSIST
;
3196 module_put(THIS_MODULE
);
3200 netif_info(tun
, drv
, tun
->dev
, "persist %s\n",
3201 arg
? "enabled" : "disabled");
3205 /* Set owner of the device */
3206 owner
= make_kuid(current_user_ns(), arg
);
3207 if (!uid_valid(owner
)) {
3213 netif_info(tun
, drv
, tun
->dev
, "owner set to %u\n",
3214 from_kuid(&init_user_ns
, tun
->owner
));
3218 /* Set group of the device */
3219 group
= make_kgid(current_user_ns(), arg
);
3220 if (!gid_valid(group
)) {
3226 netif_info(tun
, drv
, tun
->dev
, "group set to %u\n",
3227 from_kgid(&init_user_ns
, tun
->group
));
3231 /* Only allow setting the type when the interface is down */
3232 if (tun
->dev
->flags
& IFF_UP
) {
3233 netif_info(tun
, drv
, tun
->dev
,
3234 "Linktype set failed because interface is up\n");
3237 ret
= call_netdevice_notifiers(NETDEV_PRE_TYPE_CHANGE
,
3239 ret
= notifier_to_errno(ret
);
3241 netif_info(tun
, drv
, tun
->dev
,
3242 "Refused to change device type\n");
3245 tun
->dev
->type
= (int) arg
;
3246 tun
->dev
->addr_len
= tun_get_addr_len(tun
->dev
->type
);
3247 netif_info(tun
, drv
, tun
->dev
, "linktype set to %d\n",
3249 call_netdevice_notifiers(NETDEV_POST_TYPE_CHANGE
,
3255 tun
->msg_enable
= (u32
)arg
;
3259 ret
= set_offload(tun
, arg
);
3262 case TUNSETTXFILTER
:
3263 /* Can be set only for TAPs */
3265 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
3267 ret
= update_filter(&tun
->txflt
, (void __user
*)arg
);
3271 /* Get hw address */
3272 dev_get_mac_address(&ifr
.ifr_hwaddr
, net
, tun
->dev
->name
);
3273 if (copy_to_user(argp
, &ifr
, ifreq_len
))
3278 /* Set hw address */
3279 ret
= dev_set_mac_address_user(tun
->dev
, &ifr
.ifr_hwaddr
, NULL
);
3283 sndbuf
= tfile
->socket
.sk
->sk_sndbuf
;
3284 if (copy_to_user(argp
, &sndbuf
, sizeof(sndbuf
)))
3289 if (copy_from_user(&sndbuf
, argp
, sizeof(sndbuf
))) {
3298 tun
->sndbuf
= sndbuf
;
3299 tun_set_sndbuf(tun
);
3302 case TUNGETVNETHDRSZ
:
3303 vnet_hdr_sz
= tun
->vnet_hdr_sz
;
3304 if (copy_to_user(argp
, &vnet_hdr_sz
, sizeof(vnet_hdr_sz
)))
3308 case TUNSETVNETHDRSZ
:
3309 if (copy_from_user(&vnet_hdr_sz
, argp
, sizeof(vnet_hdr_sz
))) {
3313 if (vnet_hdr_sz
< (int)sizeof(struct virtio_net_hdr
)) {
3318 tun
->vnet_hdr_sz
= vnet_hdr_sz
;
3322 le
= !!(tun
->flags
& TUN_VNET_LE
);
3323 if (put_user(le
, (int __user
*)argp
))
3328 if (get_user(le
, (int __user
*)argp
)) {
3333 tun
->flags
|= TUN_VNET_LE
;
3335 tun
->flags
&= ~TUN_VNET_LE
;
3339 ret
= tun_get_vnet_be(tun
, argp
);
3343 ret
= tun_set_vnet_be(tun
, argp
);
3346 case TUNATTACHFILTER
:
3347 /* Can be set only for TAPs */
3349 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
3352 if (copy_from_user(&tun
->fprog
, argp
, sizeof(tun
->fprog
)))
3355 ret
= tun_attach_filter(tun
);
3358 case TUNDETACHFILTER
:
3359 /* Can be set only for TAPs */
3361 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
3364 tun_detach_filter(tun
, tun
->numqueues
);
3369 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
3372 if (copy_to_user(argp
, &tun
->fprog
, sizeof(tun
->fprog
)))
3377 case TUNSETSTEERINGEBPF
:
3378 ret
= tun_set_ebpf(tun
, &tun
->steering_prog
, argp
);
3381 case TUNSETFILTEREBPF
:
3382 ret
= tun_set_ebpf(tun
, &tun
->filter_prog
, argp
);
3387 if (copy_from_user(&carrier
, argp
, sizeof(carrier
)))
3390 ret
= tun_net_change_carrier(tun
->dev
, (bool)carrier
);
3393 case TUNGETDEVNETNS
:
3395 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
3397 ret
= open_related_ns(&net
->ns
, get_net_ns
);
3406 netdev_state_change(tun
->dev
);
3415 static long tun_chr_ioctl(struct file
*file
,
3416 unsigned int cmd
, unsigned long arg
)
3418 return __tun_chr_ioctl(file
, cmd
, arg
, sizeof (struct ifreq
));
3421 #ifdef CONFIG_COMPAT
3422 static long tun_chr_compat_ioctl(struct file
*file
,
3423 unsigned int cmd
, unsigned long arg
)
3428 case TUNSETTXFILTER
:
3433 arg
= (unsigned long)compat_ptr(arg
);
3436 arg
= (compat_ulong_t
)arg
;
3441 * compat_ifreq is shorter than ifreq, so we must not access beyond
3442 * the end of that structure. All fields that are used in this
3443 * driver are compatible though, we don't need to convert the
3446 return __tun_chr_ioctl(file
, cmd
, arg
, sizeof(struct compat_ifreq
));
3448 #endif /* CONFIG_COMPAT */
3450 static int tun_chr_fasync(int fd
, struct file
*file
, int on
)
3452 struct tun_file
*tfile
= file
->private_data
;
3456 ret
= file_f_owner_allocate(file
);
3461 if ((ret
= fasync_helper(fd
, file
, on
, &tfile
->fasync
)) < 0)
3465 __f_setown(file
, task_pid(current
), PIDTYPE_TGID
, 0);
3466 tfile
->flags
|= TUN_FASYNC
;
3468 tfile
->flags
&= ~TUN_FASYNC
;
3474 static int tun_chr_open(struct inode
*inode
, struct file
* file
)
3476 struct net
*net
= current
->nsproxy
->net_ns
;
3477 struct tun_file
*tfile
;
3479 tfile
= (struct tun_file
*)sk_alloc(net
, AF_UNSPEC
, GFP_KERNEL
,
3483 if (ptr_ring_init(&tfile
->tx_ring
, 0, GFP_KERNEL
)) {
3484 sk_free(&tfile
->sk
);
3488 mutex_init(&tfile
->napi_mutex
);
3489 RCU_INIT_POINTER(tfile
->tun
, NULL
);
3493 init_waitqueue_head(&tfile
->socket
.wq
.wait
);
3495 tfile
->socket
.file
= file
;
3496 tfile
->socket
.ops
= &tun_socket_ops
;
3498 sock_init_data_uid(&tfile
->socket
, &tfile
->sk
, current_fsuid());
3500 tfile
->sk
.sk_write_space
= tun_sock_write_space
;
3501 tfile
->sk
.sk_sndbuf
= INT_MAX
;
3503 file
->private_data
= tfile
;
3504 INIT_LIST_HEAD(&tfile
->next
);
3506 sock_set_flag(&tfile
->sk
, SOCK_ZEROCOPY
);
3508 /* tun groks IOCB_NOWAIT just fine, mark it as such */
3509 file
->f_mode
|= FMODE_NOWAIT
;
3513 static int tun_chr_close(struct inode
*inode
, struct file
*file
)
3515 struct tun_file
*tfile
= file
->private_data
;
3517 tun_detach(tfile
, true);
3522 #ifdef CONFIG_PROC_FS
3523 static void tun_chr_show_fdinfo(struct seq_file
*m
, struct file
*file
)
3525 struct tun_file
*tfile
= file
->private_data
;
3526 struct tun_struct
*tun
;
3529 memset(&ifr
, 0, sizeof(ifr
));
3532 tun
= tun_get(tfile
);
3534 tun_get_iff(tun
, &ifr
);
3540 seq_printf(m
, "iff:\t%s\n", ifr
.ifr_name
);
3544 static const struct file_operations tun_fops
= {
3545 .owner
= THIS_MODULE
,
3546 .read_iter
= tun_chr_read_iter
,
3547 .write_iter
= tun_chr_write_iter
,
3548 .poll
= tun_chr_poll
,
3549 .unlocked_ioctl
= tun_chr_ioctl
,
3550 #ifdef CONFIG_COMPAT
3551 .compat_ioctl
= tun_chr_compat_ioctl
,
3553 .open
= tun_chr_open
,
3554 .release
= tun_chr_close
,
3555 .fasync
= tun_chr_fasync
,
3556 #ifdef CONFIG_PROC_FS
3557 .show_fdinfo
= tun_chr_show_fdinfo
,
3561 static struct miscdevice tun_miscdev
= {
3564 .nodename
= "net/tun",
3568 /* ethtool interface */
3570 static void tun_default_link_ksettings(struct net_device
*dev
,
3571 struct ethtool_link_ksettings
*cmd
)
3573 ethtool_link_ksettings_zero_link_mode(cmd
, supported
);
3574 ethtool_link_ksettings_zero_link_mode(cmd
, advertising
);
3575 cmd
->base
.speed
= SPEED_10000
;
3576 cmd
->base
.duplex
= DUPLEX_FULL
;
3577 cmd
->base
.port
= PORT_TP
;
3578 cmd
->base
.phy_address
= 0;
3579 cmd
->base
.autoneg
= AUTONEG_DISABLE
;
3582 static int tun_get_link_ksettings(struct net_device
*dev
,
3583 struct ethtool_link_ksettings
*cmd
)
3585 struct tun_struct
*tun
= netdev_priv(dev
);
3587 memcpy(cmd
, &tun
->link_ksettings
, sizeof(*cmd
));
3591 static int tun_set_link_ksettings(struct net_device
*dev
,
3592 const struct ethtool_link_ksettings
*cmd
)
3594 struct tun_struct
*tun
= netdev_priv(dev
);
3596 memcpy(&tun
->link_ksettings
, cmd
, sizeof(*cmd
));
3600 static void tun_get_drvinfo(struct net_device
*dev
, struct ethtool_drvinfo
*info
)
3602 struct tun_struct
*tun
= netdev_priv(dev
);
3604 strscpy(info
->driver
, DRV_NAME
, sizeof(info
->driver
));
3605 strscpy(info
->version
, DRV_VERSION
, sizeof(info
->version
));
3607 switch (tun
->flags
& TUN_TYPE_MASK
) {
3609 strscpy(info
->bus_info
, "tun", sizeof(info
->bus_info
));
3612 strscpy(info
->bus_info
, "tap", sizeof(info
->bus_info
));
3617 static u32
tun_get_msglevel(struct net_device
*dev
)
3619 struct tun_struct
*tun
= netdev_priv(dev
);
3621 return tun
->msg_enable
;
3624 static void tun_set_msglevel(struct net_device
*dev
, u32 value
)
3626 struct tun_struct
*tun
= netdev_priv(dev
);
3628 tun
->msg_enable
= value
;
3631 static int tun_get_coalesce(struct net_device
*dev
,
3632 struct ethtool_coalesce
*ec
,
3633 struct kernel_ethtool_coalesce
*kernel_coal
,
3634 struct netlink_ext_ack
*extack
)
3636 struct tun_struct
*tun
= netdev_priv(dev
);
3638 ec
->rx_max_coalesced_frames
= tun
->rx_batched
;
3643 static int tun_set_coalesce(struct net_device
*dev
,
3644 struct ethtool_coalesce
*ec
,
3645 struct kernel_ethtool_coalesce
*kernel_coal
,
3646 struct netlink_ext_ack
*extack
)
3648 struct tun_struct
*tun
= netdev_priv(dev
);
3650 if (ec
->rx_max_coalesced_frames
> NAPI_POLL_WEIGHT
)
3651 tun
->rx_batched
= NAPI_POLL_WEIGHT
;
3653 tun
->rx_batched
= ec
->rx_max_coalesced_frames
;
3658 static void tun_get_channels(struct net_device
*dev
,
3659 struct ethtool_channels
*channels
)
3661 struct tun_struct
*tun
= netdev_priv(dev
);
3663 channels
->combined_count
= tun
->numqueues
;
3664 channels
->max_combined
= tun
->flags
& IFF_MULTI_QUEUE
? MAX_TAP_QUEUES
: 1;
3667 static const struct ethtool_ops tun_ethtool_ops
= {
3668 .supported_coalesce_params
= ETHTOOL_COALESCE_RX_MAX_FRAMES
,
3669 .get_drvinfo
= tun_get_drvinfo
,
3670 .get_msglevel
= tun_get_msglevel
,
3671 .set_msglevel
= tun_set_msglevel
,
3672 .get_link
= ethtool_op_get_link
,
3673 .get_channels
= tun_get_channels
,
3674 .get_ts_info
= ethtool_op_get_ts_info
,
3675 .get_coalesce
= tun_get_coalesce
,
3676 .set_coalesce
= tun_set_coalesce
,
3677 .get_link_ksettings
= tun_get_link_ksettings
,
3678 .set_link_ksettings
= tun_set_link_ksettings
,
3681 static int tun_queue_resize(struct tun_struct
*tun
)
3683 struct net_device
*dev
= tun
->dev
;
3684 struct tun_file
*tfile
;
3685 struct ptr_ring
**rings
;
3686 int n
= tun
->numqueues
+ tun
->numdisabled
;
3689 rings
= kmalloc_array(n
, sizeof(*rings
), GFP_KERNEL
);
3693 for (i
= 0; i
< tun
->numqueues
; i
++) {
3694 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
3695 rings
[i
] = &tfile
->tx_ring
;
3697 list_for_each_entry(tfile
, &tun
->disabled
, next
)
3698 rings
[i
++] = &tfile
->tx_ring
;
3700 ret
= ptr_ring_resize_multiple(rings
, n
,
3701 dev
->tx_queue_len
, GFP_KERNEL
,
3708 static int tun_device_event(struct notifier_block
*unused
,
3709 unsigned long event
, void *ptr
)
3711 struct net_device
*dev
= netdev_notifier_info_to_dev(ptr
);
3712 struct tun_struct
*tun
= netdev_priv(dev
);
3715 if (dev
->rtnl_link_ops
!= &tun_link_ops
)
3719 case NETDEV_CHANGE_TX_QUEUE_LEN
:
3720 if (tun_queue_resize(tun
))
3724 for (i
= 0; i
< tun
->numqueues
; i
++) {
3725 struct tun_file
*tfile
;
3727 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
3728 tfile
->socket
.sk
->sk_write_space(tfile
->socket
.sk
);
3738 static struct notifier_block tun_notifier_block __read_mostly
= {
3739 .notifier_call
= tun_device_event
,
3742 static int __init
tun_init(void)
3746 pr_info("%s, %s\n", DRV_DESCRIPTION
, DRV_VERSION
);
3748 ret
= rtnl_link_register(&tun_link_ops
);
3750 pr_err("Can't register link_ops\n");
3754 ret
= misc_register(&tun_miscdev
);
3756 pr_err("Can't register misc device %d\n", TUN_MINOR
);
3760 ret
= register_netdevice_notifier(&tun_notifier_block
);
3762 pr_err("Can't register netdevice notifier\n");
3769 misc_deregister(&tun_miscdev
);
3771 rtnl_link_unregister(&tun_link_ops
);
3776 static void __exit
tun_cleanup(void)
3778 misc_deregister(&tun_miscdev
);
3779 rtnl_link_unregister(&tun_link_ops
);
3780 unregister_netdevice_notifier(&tun_notifier_block
);
3783 /* Get an underlying socket object from tun file. Returns error unless file is
3784 * attached to a device. The returned object works like a packet socket, it
3785 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
3786 * holding a reference to the file for as long as the socket is in use. */
3787 struct socket
*tun_get_socket(struct file
*file
)
3789 struct tun_file
*tfile
;
3790 if (file
->f_op
!= &tun_fops
)
3791 return ERR_PTR(-EINVAL
);
3792 tfile
= file
->private_data
;
3794 return ERR_PTR(-EBADFD
);
3795 return &tfile
->socket
;
3797 EXPORT_SYMBOL_GPL(tun_get_socket
);
3799 struct ptr_ring
*tun_get_tx_ring(struct file
*file
)
3801 struct tun_file
*tfile
;
3803 if (file
->f_op
!= &tun_fops
)
3804 return ERR_PTR(-EINVAL
);
3805 tfile
= file
->private_data
;
3807 return ERR_PTR(-EBADFD
);
3808 return &tfile
->tx_ring
;
3810 EXPORT_SYMBOL_GPL(tun_get_tx_ring
);
3812 module_init(tun_init
);
3813 module_exit(tun_cleanup
);
3814 MODULE_DESCRIPTION(DRV_DESCRIPTION
);
3815 MODULE_AUTHOR(DRV_COPYRIGHT
);
3816 MODULE_LICENSE("GPL");
3817 MODULE_ALIAS_MISCDEV(TUN_MINOR
);
3818 MODULE_ALIAS("devname:net/tun");