2 * TUN - Universal TUN/TAP device driver.
3 * Copyright (C) 1999-2002 Maxim Krasnyansky <maxk@qualcomm.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * $Id: tun.c,v 1.15 2002/03/01 02:44:24 maxk Exp $
21 * Mike Kershaw <dragorn@kismetwireless.net> 2005/08/14
22 * Add TUNSETLINK ioctl to set the link encapsulation
24 * Mark Smith <markzzzsmith@yahoo.com.au>
25 * Use eth_random_addr() for tap MAC address.
27 * Harald Roelle <harald.roelle@ifi.lmu.de> 2004/04/20
28 * Fixes in packet dropping, queue length setting and queue wakeup.
29 * Increased default tx queue length.
33 * Daniel Podlejski <underley@underley.eu.org>
34 * Modifications for 2.3.99-pre5 kernel.
37 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
39 #define DRV_NAME "tun"
40 #define DRV_VERSION "1.6"
41 #define DRV_DESCRIPTION "Universal TUN/TAP device driver"
42 #define DRV_COPYRIGHT "(C) 1999-2004 Max Krasnyansky <maxk@qualcomm.com>"
44 #include <linux/module.h>
45 #include <linux/errno.h>
46 #include <linux/kernel.h>
47 #include <linux/major.h>
48 #include <linux/slab.h>
49 #include <linux/poll.h>
50 #include <linux/fcntl.h>
51 #include <linux/init.h>
52 #include <linux/skbuff.h>
53 #include <linux/netdevice.h>
54 #include <linux/etherdevice.h>
55 #include <linux/miscdevice.h>
56 #include <linux/ethtool.h>
57 #include <linux/rtnetlink.h>
58 #include <linux/compat.h>
60 #include <linux/if_arp.h>
61 #include <linux/if_ether.h>
62 #include <linux/if_tun.h>
63 #include <linux/if_vlan.h>
64 #include <linux/crc32.h>
65 #include <linux/nsproxy.h>
66 #include <linux/virtio_net.h>
67 #include <linux/rcupdate.h>
68 #include <net/net_namespace.h>
69 #include <net/netns/generic.h>
70 #include <net/rtnetlink.h>
72 #include <linux/seq_file.h>
73 #include <linux/uio.h>
75 #include <asm/uaccess.h>
77 /* Uncomment to enable debugging */
78 /* #define TUN_DEBUG 1 */
83 #define tun_debug(level, tun, fmt, args...) \
86 netdev_printk(level, tun->dev, fmt, ##args); \
88 #define DBG1(level, fmt, args...) \
91 printk(level fmt, ##args); \
94 #define tun_debug(level, tun, fmt, args...) \
97 netdev_printk(level, tun->dev, fmt, ##args); \
99 #define DBG1(level, fmt, args...) \
102 printk(level fmt, ##args); \
106 /* TUN device flags */
108 /* IFF_ATTACH_QUEUE is never stored in device flags,
109 * overload it to mean fasync when stored there.
111 #define TUN_FASYNC IFF_ATTACH_QUEUE
112 /* High bits in flags field are unused. */
113 #define TUN_VNET_LE 0x80000000
114 #define TUN_VNET_BE 0x40000000
116 #define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
118 #define GOODCOPY_LEN 128
120 #define FLT_EXACT_COUNT 8
122 unsigned int count
; /* Number of addrs. Zero means disabled */
123 u32 mask
[2]; /* Mask of the hashed addrs */
124 unsigned char addr
[FLT_EXACT_COUNT
][ETH_ALEN
];
127 /* MAX_TAP_QUEUES 256 is chosen to allow rx/tx queues to be equal
128 * to max number of VCPUs in guest. */
129 #define MAX_TAP_QUEUES 256
130 #define MAX_TAP_FLOWS 4096
132 #define TUN_FLOW_EXPIRE (3 * HZ)
134 /* A tun_file connects an open character device to a tuntap netdevice. It
135 * also contains all socket related structures (except sock_fprog and tap_filter)
136 * to serve as one transmit queue for tuntap device. The sock_fprog and
137 * tap_filter were kept in tun_struct since they were used for filtering for the
138 * netdevice not for a specific queue (at least I didn't see the requirement for
142 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
143 * other can only be read while rcu_read_lock or rtnl_lock is held.
147 struct socket socket
;
149 struct tun_struct __rcu
*tun
;
150 struct fasync_struct
*fasync
;
151 /* only used for fasnyc */
155 unsigned int ifindex
;
157 struct list_head next
;
158 struct tun_struct
*detached
;
161 struct tun_flow_entry
{
162 struct hlist_node hash_link
;
164 struct tun_struct
*tun
;
169 unsigned long updated
;
172 #define TUN_NUM_FLOW_ENTRIES 1024
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| \
188 NETIF_F_TSO6|NETIF_F_UFO)
193 struct tap_filter txflt
;
194 struct sock_fprog fprog
;
195 /* protected by rtnl lock */
196 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
;
210 #ifdef CONFIG_TUN_VNET_CROSS_LE
211 static inline bool tun_legacy_is_little_endian(struct tun_struct
*tun
)
213 return tun
->flags
& TUN_VNET_BE
? false :
214 virtio_legacy_is_little_endian();
217 static long tun_get_vnet_be(struct tun_struct
*tun
, int __user
*argp
)
219 int be
= !!(tun
->flags
& TUN_VNET_BE
);
221 if (put_user(be
, argp
))
227 static long tun_set_vnet_be(struct tun_struct
*tun
, int __user
*argp
)
231 if (get_user(be
, argp
))
235 tun
->flags
|= TUN_VNET_BE
;
237 tun
->flags
&= ~TUN_VNET_BE
;
242 static inline bool tun_legacy_is_little_endian(struct tun_struct
*tun
)
244 return virtio_legacy_is_little_endian();
247 static long tun_get_vnet_be(struct tun_struct
*tun
, int __user
*argp
)
252 static long tun_set_vnet_be(struct tun_struct
*tun
, int __user
*argp
)
256 #endif /* CONFIG_TUN_VNET_CROSS_LE */
258 static inline bool tun_is_little_endian(struct tun_struct
*tun
)
260 return tun
->flags
& TUN_VNET_LE
||
261 tun_legacy_is_little_endian(tun
);
264 static inline u16
tun16_to_cpu(struct tun_struct
*tun
, __virtio16 val
)
266 return __virtio16_to_cpu(tun_is_little_endian(tun
), val
);
269 static inline __virtio16
cpu_to_tun16(struct tun_struct
*tun
, u16 val
)
271 return __cpu_to_virtio16(tun_is_little_endian(tun
), val
);
274 static inline u32
tun_hashfn(u32 rxhash
)
276 return rxhash
& 0x3ff;
279 static struct tun_flow_entry
*tun_flow_find(struct hlist_head
*head
, u32 rxhash
)
281 struct tun_flow_entry
*e
;
283 hlist_for_each_entry_rcu(e
, head
, hash_link
) {
284 if (e
->rxhash
== rxhash
)
290 static struct tun_flow_entry
*tun_flow_create(struct tun_struct
*tun
,
291 struct hlist_head
*head
,
292 u32 rxhash
, u16 queue_index
)
294 struct tun_flow_entry
*e
= kmalloc(sizeof(*e
), GFP_ATOMIC
);
297 tun_debug(KERN_INFO
, tun
, "create flow: hash %u index %u\n",
298 rxhash
, queue_index
);
299 e
->updated
= jiffies
;
302 e
->queue_index
= queue_index
;
304 hlist_add_head_rcu(&e
->hash_link
, head
);
310 static void tun_flow_delete(struct tun_struct
*tun
, struct tun_flow_entry
*e
)
312 tun_debug(KERN_INFO
, tun
, "delete flow: hash %u index %u\n",
313 e
->rxhash
, e
->queue_index
);
314 hlist_del_rcu(&e
->hash_link
);
319 static void tun_flow_flush(struct tun_struct
*tun
)
323 spin_lock_bh(&tun
->lock
);
324 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
325 struct tun_flow_entry
*e
;
326 struct hlist_node
*n
;
328 hlist_for_each_entry_safe(e
, n
, &tun
->flows
[i
], hash_link
)
329 tun_flow_delete(tun
, e
);
331 spin_unlock_bh(&tun
->lock
);
334 static void tun_flow_delete_by_queue(struct tun_struct
*tun
, u16 queue_index
)
338 spin_lock_bh(&tun
->lock
);
339 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
340 struct tun_flow_entry
*e
;
341 struct hlist_node
*n
;
343 hlist_for_each_entry_safe(e
, n
, &tun
->flows
[i
], hash_link
) {
344 if (e
->queue_index
== queue_index
)
345 tun_flow_delete(tun
, e
);
348 spin_unlock_bh(&tun
->lock
);
351 static void tun_flow_cleanup(unsigned long data
)
353 struct tun_struct
*tun
= (struct tun_struct
*)data
;
354 unsigned long delay
= tun
->ageing_time
;
355 unsigned long next_timer
= jiffies
+ delay
;
356 unsigned long count
= 0;
359 tun_debug(KERN_INFO
, tun
, "tun_flow_cleanup\n");
361 spin_lock_bh(&tun
->lock
);
362 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
363 struct tun_flow_entry
*e
;
364 struct hlist_node
*n
;
366 hlist_for_each_entry_safe(e
, n
, &tun
->flows
[i
], hash_link
) {
367 unsigned long this_timer
;
369 this_timer
= e
->updated
+ delay
;
370 if (time_before_eq(this_timer
, jiffies
))
371 tun_flow_delete(tun
, e
);
372 else if (time_before(this_timer
, next_timer
))
373 next_timer
= this_timer
;
378 mod_timer(&tun
->flow_gc_timer
, round_jiffies_up(next_timer
));
379 spin_unlock_bh(&tun
->lock
);
382 static void tun_flow_update(struct tun_struct
*tun
, u32 rxhash
,
383 struct tun_file
*tfile
)
385 struct hlist_head
*head
;
386 struct tun_flow_entry
*e
;
387 unsigned long delay
= tun
->ageing_time
;
388 u16 queue_index
= tfile
->queue_index
;
393 head
= &tun
->flows
[tun_hashfn(rxhash
)];
397 /* We may get a very small possibility of OOO during switching, not
398 * worth to optimize.*/
399 if (tun
->numqueues
== 1 || tfile
->detached
)
402 e
= tun_flow_find(head
, rxhash
);
404 /* TODO: keep queueing to old queue until it's empty? */
405 e
->queue_index
= queue_index
;
406 e
->updated
= jiffies
;
407 sock_rps_record_flow_hash(e
->rps_rxhash
);
409 spin_lock_bh(&tun
->lock
);
410 if (!tun_flow_find(head
, rxhash
) &&
411 tun
->flow_count
< MAX_TAP_FLOWS
)
412 tun_flow_create(tun
, head
, rxhash
, queue_index
);
414 if (!timer_pending(&tun
->flow_gc_timer
))
415 mod_timer(&tun
->flow_gc_timer
,
416 round_jiffies_up(jiffies
+ delay
));
417 spin_unlock_bh(&tun
->lock
);
425 * Save the hash received in the stack receive path and update the
426 * flow_hash table accordingly.
428 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry
*e
, u32 hash
)
430 if (unlikely(e
->rps_rxhash
!= hash
))
431 e
->rps_rxhash
= hash
;
434 /* We try to identify a flow through its rxhash first. The reason that
435 * we do not check rxq no. is because some cards(e.g 82599), chooses
436 * the rxq based on the txq where the last packet of the flow comes. As
437 * the userspace application move between processors, we may get a
438 * different rxq no. here. If we could not get rxhash, then we would
439 * hope the rxq no. may help here.
441 static u16
tun_select_queue(struct net_device
*dev
, struct sk_buff
*skb
,
442 void *accel_priv
, select_queue_fallback_t fallback
)
444 struct tun_struct
*tun
= netdev_priv(dev
);
445 struct tun_flow_entry
*e
;
450 numqueues
= ACCESS_ONCE(tun
->numqueues
);
452 txq
= skb_get_hash(skb
);
454 e
= tun_flow_find(&tun
->flows
[tun_hashfn(txq
)], txq
);
456 tun_flow_save_rps_rxhash(e
, txq
);
457 txq
= e
->queue_index
;
459 /* use multiply and shift instead of expensive divide */
460 txq
= ((u64
)txq
* numqueues
) >> 32;
461 } else if (likely(skb_rx_queue_recorded(skb
))) {
462 txq
= skb_get_rx_queue(skb
);
463 while (unlikely(txq
>= numqueues
))
471 static inline bool tun_not_capable(struct tun_struct
*tun
)
473 const struct cred
*cred
= current_cred();
474 struct net
*net
= dev_net(tun
->dev
);
476 return ((uid_valid(tun
->owner
) && !uid_eq(cred
->euid
, tun
->owner
)) ||
477 (gid_valid(tun
->group
) && !in_egroup_p(tun
->group
))) &&
478 !ns_capable(net
->user_ns
, CAP_NET_ADMIN
);
481 static void tun_set_real_num_queues(struct tun_struct
*tun
)
483 netif_set_real_num_tx_queues(tun
->dev
, tun
->numqueues
);
484 netif_set_real_num_rx_queues(tun
->dev
, tun
->numqueues
);
487 static void tun_disable_queue(struct tun_struct
*tun
, struct tun_file
*tfile
)
489 tfile
->detached
= tun
;
490 list_add_tail(&tfile
->next
, &tun
->disabled
);
494 static struct tun_struct
*tun_enable_queue(struct tun_file
*tfile
)
496 struct tun_struct
*tun
= tfile
->detached
;
498 tfile
->detached
= NULL
;
499 list_del_init(&tfile
->next
);
504 static void tun_queue_purge(struct tun_file
*tfile
)
506 skb_queue_purge(&tfile
->sk
.sk_receive_queue
);
507 skb_queue_purge(&tfile
->sk
.sk_error_queue
);
510 static void __tun_detach(struct tun_file
*tfile
, bool clean
)
512 struct tun_file
*ntfile
;
513 struct tun_struct
*tun
;
515 tun
= rtnl_dereference(tfile
->tun
);
517 if (tun
&& !tfile
->detached
) {
518 u16 index
= tfile
->queue_index
;
519 BUG_ON(index
>= tun
->numqueues
);
521 rcu_assign_pointer(tun
->tfiles
[index
],
522 tun
->tfiles
[tun
->numqueues
- 1]);
523 ntfile
= rtnl_dereference(tun
->tfiles
[index
]);
524 ntfile
->queue_index
= index
;
528 RCU_INIT_POINTER(tfile
->tun
, NULL
);
529 sock_put(&tfile
->sk
);
531 tun_disable_queue(tun
, tfile
);
534 tun_flow_delete_by_queue(tun
, tun
->numqueues
+ 1);
535 /* Drop read queue */
536 tun_queue_purge(tfile
);
537 tun_set_real_num_queues(tun
);
538 } else if (tfile
->detached
&& clean
) {
539 tun
= tun_enable_queue(tfile
);
540 sock_put(&tfile
->sk
);
544 if (tun
&& tun
->numqueues
== 0 && tun
->numdisabled
== 0) {
545 netif_carrier_off(tun
->dev
);
547 if (!(tun
->flags
& IFF_PERSIST
) &&
548 tun
->dev
->reg_state
== NETREG_REGISTERED
)
549 unregister_netdevice(tun
->dev
);
551 sock_put(&tfile
->sk
);
555 static void tun_detach(struct tun_file
*tfile
, bool clean
)
558 __tun_detach(tfile
, clean
);
562 static void tun_detach_all(struct net_device
*dev
)
564 struct tun_struct
*tun
= netdev_priv(dev
);
565 struct tun_file
*tfile
, *tmp
;
566 int i
, n
= tun
->numqueues
;
568 for (i
= 0; i
< n
; i
++) {
569 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
571 tfile
->socket
.sk
->sk_data_ready(tfile
->socket
.sk
);
572 RCU_INIT_POINTER(tfile
->tun
, NULL
);
575 list_for_each_entry(tfile
, &tun
->disabled
, next
) {
576 tfile
->socket
.sk
->sk_data_ready(tfile
->socket
.sk
);
577 RCU_INIT_POINTER(tfile
->tun
, NULL
);
579 BUG_ON(tun
->numqueues
!= 0);
582 for (i
= 0; i
< n
; i
++) {
583 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
584 /* Drop read queue */
585 tun_queue_purge(tfile
);
586 sock_put(&tfile
->sk
);
588 list_for_each_entry_safe(tfile
, tmp
, &tun
->disabled
, next
) {
589 tun_enable_queue(tfile
);
590 tun_queue_purge(tfile
);
591 sock_put(&tfile
->sk
);
593 BUG_ON(tun
->numdisabled
!= 0);
595 if (tun
->flags
& IFF_PERSIST
)
596 module_put(THIS_MODULE
);
599 static int tun_attach(struct tun_struct
*tun
, struct file
*file
, bool skip_filter
)
601 struct tun_file
*tfile
= file
->private_data
;
604 err
= security_tun_dev_attach(tfile
->socket
.sk
, tun
->security
);
609 if (rtnl_dereference(tfile
->tun
) && !tfile
->detached
)
613 if (!(tun
->flags
& IFF_MULTI_QUEUE
) && tun
->numqueues
== 1)
617 if (!tfile
->detached
&&
618 tun
->numqueues
+ tun
->numdisabled
== MAX_TAP_QUEUES
)
623 /* Re-attach the filter to persist device */
624 if (!skip_filter
&& (tun
->filter_attached
== true)) {
625 err
= sk_attach_filter(&tun
->fprog
, tfile
->socket
.sk
);
629 tfile
->queue_index
= tun
->numqueues
;
630 rcu_assign_pointer(tfile
->tun
, tun
);
631 rcu_assign_pointer(tun
->tfiles
[tun
->numqueues
], tfile
);
635 tun_enable_queue(tfile
);
637 sock_hold(&tfile
->sk
);
639 tun_set_real_num_queues(tun
);
641 /* device is allowed to go away first, so no need to hold extra
649 static struct tun_struct
*__tun_get(struct tun_file
*tfile
)
651 struct tun_struct
*tun
;
654 tun
= rcu_dereference(tfile
->tun
);
662 static struct tun_struct
*tun_get(struct file
*file
)
664 return __tun_get(file
->private_data
);
667 static void tun_put(struct tun_struct
*tun
)
673 static void addr_hash_set(u32
*mask
, const u8
*addr
)
675 int n
= ether_crc(ETH_ALEN
, addr
) >> 26;
676 mask
[n
>> 5] |= (1 << (n
& 31));
679 static unsigned int addr_hash_test(const u32
*mask
, const u8
*addr
)
681 int n
= ether_crc(ETH_ALEN
, addr
) >> 26;
682 return mask
[n
>> 5] & (1 << (n
& 31));
685 static int update_filter(struct tap_filter
*filter
, void __user
*arg
)
687 struct { u8 u
[ETH_ALEN
]; } *addr
;
688 struct tun_filter uf
;
689 int err
, alen
, n
, nexact
;
691 if (copy_from_user(&uf
, arg
, sizeof(uf
)))
700 alen
= ETH_ALEN
* uf
.count
;
701 addr
= kmalloc(alen
, GFP_KERNEL
);
705 if (copy_from_user(addr
, arg
+ sizeof(uf
), alen
)) {
710 /* The filter is updated without holding any locks. Which is
711 * perfectly safe. We disable it first and in the worst
712 * case we'll accept a few undesired packets. */
716 /* Use first set of addresses as an exact filter */
717 for (n
= 0; n
< uf
.count
&& n
< FLT_EXACT_COUNT
; n
++)
718 memcpy(filter
->addr
[n
], addr
[n
].u
, ETH_ALEN
);
722 /* Remaining multicast addresses are hashed,
723 * unicast will leave the filter disabled. */
724 memset(filter
->mask
, 0, sizeof(filter
->mask
));
725 for (; n
< uf
.count
; n
++) {
726 if (!is_multicast_ether_addr(addr
[n
].u
)) {
727 err
= 0; /* no filter */
730 addr_hash_set(filter
->mask
, addr
[n
].u
);
733 /* For ALLMULTI just set the mask to all ones.
734 * This overrides the mask populated above. */
735 if ((uf
.flags
& TUN_FLT_ALLMULTI
))
736 memset(filter
->mask
, ~0, sizeof(filter
->mask
));
738 /* Now enable the filter */
740 filter
->count
= nexact
;
742 /* Return the number of exact filters */
750 /* Returns: 0 - drop, !=0 - accept */
751 static int run_filter(struct tap_filter
*filter
, const struct sk_buff
*skb
)
753 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
755 struct ethhdr
*eh
= (struct ethhdr
*) skb
->data
;
759 for (i
= 0; i
< filter
->count
; i
++)
760 if (ether_addr_equal(eh
->h_dest
, filter
->addr
[i
]))
763 /* Inexact match (multicast only) */
764 if (is_multicast_ether_addr(eh
->h_dest
))
765 return addr_hash_test(filter
->mask
, eh
->h_dest
);
771 * Checks whether the packet is accepted or not.
772 * Returns: 0 - drop, !=0 - accept
774 static int check_filter(struct tap_filter
*filter
, const struct sk_buff
*skb
)
779 return run_filter(filter
, skb
);
782 /* Network device part of the driver */
784 static const struct ethtool_ops tun_ethtool_ops
;
786 /* Net device detach from fd. */
787 static void tun_net_uninit(struct net_device
*dev
)
792 /* Net device open. */
793 static int tun_net_open(struct net_device
*dev
)
795 netif_tx_start_all_queues(dev
);
799 /* Net device close. */
800 static int tun_net_close(struct net_device
*dev
)
802 netif_tx_stop_all_queues(dev
);
806 /* Net device start xmit */
807 static netdev_tx_t
tun_net_xmit(struct sk_buff
*skb
, struct net_device
*dev
)
809 struct tun_struct
*tun
= netdev_priv(dev
);
810 int txq
= skb
->queue_mapping
;
811 struct tun_file
*tfile
;
815 tfile
= rcu_dereference(tun
->tfiles
[txq
]);
816 numqueues
= ACCESS_ONCE(tun
->numqueues
);
818 /* Drop packet if interface is not attached */
819 if (txq
>= numqueues
)
822 if (numqueues
== 1) {
823 /* Select queue was not called for the skbuff, so we extract the
824 * RPS hash and save it into the flow_table here.
828 rxhash
= skb_get_hash(skb
);
830 struct tun_flow_entry
*e
;
831 e
= tun_flow_find(&tun
->flows
[tun_hashfn(rxhash
)],
834 tun_flow_save_rps_rxhash(e
, rxhash
);
838 tun_debug(KERN_INFO
, tun
, "tun_net_xmit %d\n", skb
->len
);
842 /* Drop if the filter does not like it.
843 * This is a noop if the filter is disabled.
844 * Filter can be enabled only for the TAP devices. */
845 if (!check_filter(&tun
->txflt
, skb
))
848 if (tfile
->socket
.sk
->sk_filter
&&
849 sk_filter(tfile
->socket
.sk
, skb
))
852 /* Limit the number of packets queued by dividing txq length with the
855 if (skb_queue_len(&tfile
->socket
.sk
->sk_receive_queue
) * numqueues
856 >= dev
->tx_queue_len
)
859 if (unlikely(skb_orphan_frags(skb
, GFP_ATOMIC
)))
862 if (skb
->sk
&& sk_fullsock(skb
->sk
)) {
863 sock_tx_timestamp(skb
->sk
, &skb_shinfo(skb
)->tx_flags
);
864 sw_tx_timestamp(skb
);
867 /* Orphan the skb - required as we might hang on to it
868 * for indefinite time.
875 skb_queue_tail(&tfile
->socket
.sk
->sk_receive_queue
, skb
);
877 /* Notify and wake up reader process */
878 if (tfile
->flags
& TUN_FASYNC
)
879 kill_fasync(&tfile
->fasync
, SIGIO
, POLL_IN
);
880 tfile
->socket
.sk
->sk_data_ready(tfile
->socket
.sk
);
886 dev
->stats
.tx_dropped
++;
890 return NET_XMIT_DROP
;
893 static void tun_net_mclist(struct net_device
*dev
)
896 * This callback is supposed to deal with mc filter in
897 * _rx_ path and has nothing to do with the _tx_ path.
898 * In rx path we always accept everything userspace gives us.
903 #define MAX_MTU 65535
906 tun_net_change_mtu(struct net_device
*dev
, int new_mtu
)
908 if (new_mtu
< MIN_MTU
|| new_mtu
+ dev
->hard_header_len
> MAX_MTU
)
914 static netdev_features_t
tun_net_fix_features(struct net_device
*dev
,
915 netdev_features_t features
)
917 struct tun_struct
*tun
= netdev_priv(dev
);
919 return (features
& tun
->set_features
) | (features
& ~TUN_USER_FEATURES
);
921 #ifdef CONFIG_NET_POLL_CONTROLLER
922 static void tun_poll_controller(struct net_device
*dev
)
925 * Tun only receives frames when:
926 * 1) the char device endpoint gets data from user space
927 * 2) the tun socket gets a sendmsg call from user space
928 * Since both of those are synchronous operations, we are guaranteed
929 * never to have pending data when we poll for it
930 * so there is nothing to do here but return.
931 * We need this though so netpoll recognizes us as an interface that
932 * supports polling, which enables bridge devices in virt setups to
933 * still use netconsole
939 static void tun_set_headroom(struct net_device
*dev
, int new_hr
)
941 struct tun_struct
*tun
= netdev_priv(dev
);
943 if (new_hr
< NET_SKB_PAD
)
944 new_hr
= NET_SKB_PAD
;
949 static const struct net_device_ops tun_netdev_ops
= {
950 .ndo_uninit
= tun_net_uninit
,
951 .ndo_open
= tun_net_open
,
952 .ndo_stop
= tun_net_close
,
953 .ndo_start_xmit
= tun_net_xmit
,
954 .ndo_change_mtu
= tun_net_change_mtu
,
955 .ndo_fix_features
= tun_net_fix_features
,
956 .ndo_select_queue
= tun_select_queue
,
957 #ifdef CONFIG_NET_POLL_CONTROLLER
958 .ndo_poll_controller
= tun_poll_controller
,
960 .ndo_set_rx_headroom
= tun_set_headroom
,
963 static const struct net_device_ops tap_netdev_ops
= {
964 .ndo_uninit
= tun_net_uninit
,
965 .ndo_open
= tun_net_open
,
966 .ndo_stop
= tun_net_close
,
967 .ndo_start_xmit
= tun_net_xmit
,
968 .ndo_change_mtu
= tun_net_change_mtu
,
969 .ndo_fix_features
= tun_net_fix_features
,
970 .ndo_set_rx_mode
= tun_net_mclist
,
971 .ndo_set_mac_address
= eth_mac_addr
,
972 .ndo_validate_addr
= eth_validate_addr
,
973 .ndo_select_queue
= tun_select_queue
,
974 #ifdef CONFIG_NET_POLL_CONTROLLER
975 .ndo_poll_controller
= tun_poll_controller
,
977 .ndo_features_check
= passthru_features_check
,
978 .ndo_set_rx_headroom
= tun_set_headroom
,
981 static void tun_flow_init(struct tun_struct
*tun
)
985 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++)
986 INIT_HLIST_HEAD(&tun
->flows
[i
]);
988 tun
->ageing_time
= TUN_FLOW_EXPIRE
;
989 setup_timer(&tun
->flow_gc_timer
, tun_flow_cleanup
, (unsigned long)tun
);
990 mod_timer(&tun
->flow_gc_timer
,
991 round_jiffies_up(jiffies
+ tun
->ageing_time
));
994 static void tun_flow_uninit(struct tun_struct
*tun
)
996 del_timer_sync(&tun
->flow_gc_timer
);
1000 /* Initialize net device. */
1001 static void tun_net_init(struct net_device
*dev
)
1003 struct tun_struct
*tun
= netdev_priv(dev
);
1005 switch (tun
->flags
& TUN_TYPE_MASK
) {
1007 dev
->netdev_ops
= &tun_netdev_ops
;
1009 /* Point-to-Point TUN Device */
1010 dev
->hard_header_len
= 0;
1014 /* Zero header length */
1015 dev
->type
= ARPHRD_NONE
;
1016 dev
->flags
= IFF_POINTOPOINT
| IFF_NOARP
| IFF_MULTICAST
;
1017 dev
->tx_queue_len
= TUN_READQ_SIZE
; /* We prefer our own queue length */
1021 dev
->netdev_ops
= &tap_netdev_ops
;
1022 /* Ethernet TAP Device */
1024 dev
->priv_flags
&= ~IFF_TX_SKB_SHARING
;
1025 dev
->priv_flags
|= IFF_LIVE_ADDR_CHANGE
;
1027 eth_hw_addr_random(dev
);
1029 dev
->tx_queue_len
= TUN_READQ_SIZE
; /* We prefer our own queue length */
1034 /* Character device part */
1037 static unsigned int tun_chr_poll(struct file
*file
, poll_table
*wait
)
1039 struct tun_file
*tfile
= file
->private_data
;
1040 struct tun_struct
*tun
= __tun_get(tfile
);
1042 unsigned int mask
= 0;
1047 sk
= tfile
->socket
.sk
;
1049 tun_debug(KERN_INFO
, tun
, "tun_chr_poll\n");
1051 poll_wait(file
, sk_sleep(sk
), wait
);
1053 if (!skb_queue_empty(&sk
->sk_receive_queue
))
1054 mask
|= POLLIN
| POLLRDNORM
;
1056 if (sock_writeable(sk
) ||
1057 (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE
, &sk
->sk_socket
->flags
) &&
1058 sock_writeable(sk
)))
1059 mask
|= POLLOUT
| POLLWRNORM
;
1061 if (tun
->dev
->reg_state
!= NETREG_REGISTERED
)
1068 /* prepad is the amount to reserve at front. len is length after that.
1069 * linear is a hint as to how much to copy (usually headers). */
1070 static struct sk_buff
*tun_alloc_skb(struct tun_file
*tfile
,
1071 size_t prepad
, size_t len
,
1072 size_t linear
, int noblock
)
1074 struct sock
*sk
= tfile
->socket
.sk
;
1075 struct sk_buff
*skb
;
1078 /* Under a page? Don't bother with paged skb. */
1079 if (prepad
+ len
< PAGE_SIZE
|| !linear
)
1082 skb
= sock_alloc_send_pskb(sk
, prepad
+ linear
, len
- linear
, noblock
,
1085 return ERR_PTR(err
);
1087 skb_reserve(skb
, prepad
);
1088 skb_put(skb
, linear
);
1089 skb
->data_len
= len
- linear
;
1090 skb
->len
+= len
- linear
;
1095 /* Get packet from user space buffer */
1096 static ssize_t
tun_get_user(struct tun_struct
*tun
, struct tun_file
*tfile
,
1097 void *msg_control
, struct iov_iter
*from
,
1100 struct tun_pi pi
= { 0, cpu_to_be16(ETH_P_IP
) };
1101 struct sk_buff
*skb
;
1102 size_t total_len
= iov_iter_count(from
);
1103 size_t len
= total_len
, align
= tun
->align
, linear
;
1104 struct virtio_net_hdr gso
= { 0 };
1107 bool zerocopy
= false;
1112 if (!(tun
->dev
->flags
& IFF_UP
))
1115 if (!(tun
->flags
& IFF_NO_PI
)) {
1116 if (len
< sizeof(pi
))
1120 n
= copy_from_iter(&pi
, sizeof(pi
), from
);
1121 if (n
!= sizeof(pi
))
1125 if (tun
->flags
& IFF_VNET_HDR
) {
1126 if (len
< tun
->vnet_hdr_sz
)
1128 len
-= tun
->vnet_hdr_sz
;
1130 n
= copy_from_iter(&gso
, sizeof(gso
), from
);
1131 if (n
!= sizeof(gso
))
1134 if ((gso
.flags
& VIRTIO_NET_HDR_F_NEEDS_CSUM
) &&
1135 tun16_to_cpu(tun
, gso
.csum_start
) + tun16_to_cpu(tun
, gso
.csum_offset
) + 2 > tun16_to_cpu(tun
, gso
.hdr_len
))
1136 gso
.hdr_len
= cpu_to_tun16(tun
, tun16_to_cpu(tun
, gso
.csum_start
) + tun16_to_cpu(tun
, gso
.csum_offset
) + 2);
1138 if (tun16_to_cpu(tun
, gso
.hdr_len
) > len
)
1140 iov_iter_advance(from
, tun
->vnet_hdr_sz
- sizeof(gso
));
1143 if ((tun
->flags
& TUN_TYPE_MASK
) == IFF_TAP
) {
1144 align
+= NET_IP_ALIGN
;
1145 if (unlikely(len
< ETH_HLEN
||
1146 (gso
.hdr_len
&& tun16_to_cpu(tun
, gso
.hdr_len
) < ETH_HLEN
)))
1150 good_linear
= SKB_MAX_HEAD(align
);
1153 struct iov_iter i
= *from
;
1155 /* There are 256 bytes to be copied in skb, so there is
1156 * enough room for skb expand head in case it is used.
1157 * The rest of the buffer is mapped from userspace.
1159 copylen
= gso
.hdr_len
? tun16_to_cpu(tun
, gso
.hdr_len
) : GOODCOPY_LEN
;
1160 if (copylen
> good_linear
)
1161 copylen
= good_linear
;
1163 iov_iter_advance(&i
, copylen
);
1164 if (iov_iter_npages(&i
, INT_MAX
) <= MAX_SKB_FRAGS
)
1170 if (tun16_to_cpu(tun
, gso
.hdr_len
) > good_linear
)
1171 linear
= good_linear
;
1173 linear
= tun16_to_cpu(tun
, gso
.hdr_len
);
1176 skb
= tun_alloc_skb(tfile
, align
, copylen
, linear
, noblock
);
1178 if (PTR_ERR(skb
) != -EAGAIN
)
1179 tun
->dev
->stats
.rx_dropped
++;
1180 return PTR_ERR(skb
);
1184 err
= zerocopy_sg_from_iter(skb
, from
);
1186 err
= skb_copy_datagram_from_iter(skb
, 0, from
, len
);
1187 if (!err
&& msg_control
) {
1188 struct ubuf_info
*uarg
= msg_control
;
1189 uarg
->callback(uarg
, false);
1194 tun
->dev
->stats
.rx_dropped
++;
1199 if (gso
.flags
& VIRTIO_NET_HDR_F_NEEDS_CSUM
) {
1200 if (!skb_partial_csum_set(skb
, tun16_to_cpu(tun
, gso
.csum_start
),
1201 tun16_to_cpu(tun
, gso
.csum_offset
))) {
1202 tun
->dev
->stats
.rx_frame_errors
++;
1208 switch (tun
->flags
& TUN_TYPE_MASK
) {
1210 if (tun
->flags
& IFF_NO_PI
) {
1211 switch (skb
->data
[0] & 0xf0) {
1213 pi
.proto
= htons(ETH_P_IP
);
1216 pi
.proto
= htons(ETH_P_IPV6
);
1219 tun
->dev
->stats
.rx_dropped
++;
1225 skb_reset_mac_header(skb
);
1226 skb
->protocol
= pi
.proto
;
1227 skb
->dev
= tun
->dev
;
1230 skb
->protocol
= eth_type_trans(skb
, tun
->dev
);
1234 if (gso
.gso_type
!= VIRTIO_NET_HDR_GSO_NONE
) {
1236 switch (gso
.gso_type
& ~VIRTIO_NET_HDR_GSO_ECN
) {
1237 case VIRTIO_NET_HDR_GSO_TCPV4
:
1238 skb_shinfo(skb
)->gso_type
= SKB_GSO_TCPV4
;
1240 case VIRTIO_NET_HDR_GSO_TCPV6
:
1241 skb_shinfo(skb
)->gso_type
= SKB_GSO_TCPV6
;
1243 case VIRTIO_NET_HDR_GSO_UDP
:
1244 skb_shinfo(skb
)->gso_type
= SKB_GSO_UDP
;
1247 tun
->dev
->stats
.rx_frame_errors
++;
1252 if (gso
.gso_type
& VIRTIO_NET_HDR_GSO_ECN
)
1253 skb_shinfo(skb
)->gso_type
|= SKB_GSO_TCP_ECN
;
1255 skb_shinfo(skb
)->gso_size
= tun16_to_cpu(tun
, gso
.gso_size
);
1256 if (skb_shinfo(skb
)->gso_size
== 0) {
1257 tun
->dev
->stats
.rx_frame_errors
++;
1262 /* Header must be checked, and gso_segs computed. */
1263 skb_shinfo(skb
)->gso_type
|= SKB_GSO_DODGY
;
1264 skb_shinfo(skb
)->gso_segs
= 0;
1267 /* copy skb_ubuf_info for callback when skb has no error */
1269 skb_shinfo(skb
)->destructor_arg
= msg_control
;
1270 skb_shinfo(skb
)->tx_flags
|= SKBTX_DEV_ZEROCOPY
;
1271 skb_shinfo(skb
)->tx_flags
|= SKBTX_SHARED_FRAG
;
1274 skb_reset_network_header(skb
);
1275 skb_probe_transport_header(skb
, 0);
1277 rxhash
= skb_get_hash(skb
);
1280 tun
->dev
->stats
.rx_packets
++;
1281 tun
->dev
->stats
.rx_bytes
+= len
;
1283 tun_flow_update(tun
, rxhash
, tfile
);
1287 static ssize_t
tun_chr_write_iter(struct kiocb
*iocb
, struct iov_iter
*from
)
1289 struct file
*file
= iocb
->ki_filp
;
1290 struct tun_struct
*tun
= tun_get(file
);
1291 struct tun_file
*tfile
= file
->private_data
;
1297 result
= tun_get_user(tun
, tfile
, NULL
, from
, file
->f_flags
& O_NONBLOCK
);
1303 /* Put packet to the user space buffer */
1304 static ssize_t
tun_put_user(struct tun_struct
*tun
,
1305 struct tun_file
*tfile
,
1306 struct sk_buff
*skb
,
1307 struct iov_iter
*iter
)
1309 struct tun_pi pi
= { 0, skb
->protocol
};
1311 int vlan_offset
= 0;
1313 int vnet_hdr_sz
= 0;
1315 if (skb_vlan_tag_present(skb
))
1316 vlan_hlen
= VLAN_HLEN
;
1318 if (tun
->flags
& IFF_VNET_HDR
)
1319 vnet_hdr_sz
= tun
->vnet_hdr_sz
;
1321 total
= skb
->len
+ vlan_hlen
+ vnet_hdr_sz
;
1323 if (!(tun
->flags
& IFF_NO_PI
)) {
1324 if (iov_iter_count(iter
) < sizeof(pi
))
1327 total
+= sizeof(pi
);
1328 if (iov_iter_count(iter
) < total
) {
1329 /* Packet will be striped */
1330 pi
.flags
|= TUN_PKT_STRIP
;
1333 if (copy_to_iter(&pi
, sizeof(pi
), iter
) != sizeof(pi
))
1338 struct virtio_net_hdr gso
= { 0 }; /* no info leak */
1339 if (iov_iter_count(iter
) < vnet_hdr_sz
)
1342 if (skb_is_gso(skb
)) {
1343 struct skb_shared_info
*sinfo
= skb_shinfo(skb
);
1345 /* This is a hint as to how much should be linear. */
1346 gso
.hdr_len
= cpu_to_tun16(tun
, skb_headlen(skb
));
1347 gso
.gso_size
= cpu_to_tun16(tun
, sinfo
->gso_size
);
1348 if (sinfo
->gso_type
& SKB_GSO_TCPV4
)
1349 gso
.gso_type
= VIRTIO_NET_HDR_GSO_TCPV4
;
1350 else if (sinfo
->gso_type
& SKB_GSO_TCPV6
)
1351 gso
.gso_type
= VIRTIO_NET_HDR_GSO_TCPV6
;
1352 else if (sinfo
->gso_type
& SKB_GSO_UDP
)
1353 gso
.gso_type
= VIRTIO_NET_HDR_GSO_UDP
;
1355 pr_err("unexpected GSO type: "
1356 "0x%x, gso_size %d, hdr_len %d\n",
1357 sinfo
->gso_type
, tun16_to_cpu(tun
, gso
.gso_size
),
1358 tun16_to_cpu(tun
, gso
.hdr_len
));
1359 print_hex_dump(KERN_ERR
, "tun: ",
1362 min((int)tun16_to_cpu(tun
, gso
.hdr_len
), 64), true);
1366 if (sinfo
->gso_type
& SKB_GSO_TCP_ECN
)
1367 gso
.gso_type
|= VIRTIO_NET_HDR_GSO_ECN
;
1369 gso
.gso_type
= VIRTIO_NET_HDR_GSO_NONE
;
1371 if (skb
->ip_summed
== CHECKSUM_PARTIAL
) {
1372 gso
.flags
= VIRTIO_NET_HDR_F_NEEDS_CSUM
;
1373 gso
.csum_start
= cpu_to_tun16(tun
, skb_checksum_start_offset(skb
) +
1375 gso
.csum_offset
= cpu_to_tun16(tun
, skb
->csum_offset
);
1376 } else if (skb
->ip_summed
== CHECKSUM_UNNECESSARY
) {
1377 gso
.flags
= VIRTIO_NET_HDR_F_DATA_VALID
;
1378 } /* else everything is zero */
1380 if (copy_to_iter(&gso
, sizeof(gso
), iter
) != sizeof(gso
))
1383 iov_iter_advance(iter
, vnet_hdr_sz
- sizeof(gso
));
1389 __be16 h_vlan_proto
;
1393 veth
.h_vlan_proto
= skb
->vlan_proto
;
1394 veth
.h_vlan_TCI
= htons(skb_vlan_tag_get(skb
));
1396 vlan_offset
= offsetof(struct vlan_ethhdr
, h_vlan_proto
);
1398 ret
= skb_copy_datagram_iter(skb
, 0, iter
, vlan_offset
);
1399 if (ret
|| !iov_iter_count(iter
))
1402 ret
= copy_to_iter(&veth
, sizeof(veth
), iter
);
1403 if (ret
!= sizeof(veth
) || !iov_iter_count(iter
))
1407 skb_copy_datagram_iter(skb
, vlan_offset
, iter
, skb
->len
- vlan_offset
);
1410 tun
->dev
->stats
.tx_packets
++;
1411 tun
->dev
->stats
.tx_bytes
+= skb
->len
+ vlan_hlen
;
1416 static ssize_t
tun_do_read(struct tun_struct
*tun
, struct tun_file
*tfile
,
1417 struct iov_iter
*to
,
1420 struct sk_buff
*skb
;
1422 int peeked
, err
, off
= 0;
1424 tun_debug(KERN_INFO
, tun
, "tun_do_read\n");
1426 if (!iov_iter_count(to
))
1429 if (tun
->dev
->reg_state
!= NETREG_REGISTERED
)
1432 /* Read frames from queue */
1433 skb
= __skb_recv_datagram(tfile
->socket
.sk
, noblock
? MSG_DONTWAIT
: 0,
1434 &peeked
, &off
, &err
);
1438 ret
= tun_put_user(tun
, tfile
, skb
, to
);
1439 if (unlikely(ret
< 0))
1447 static ssize_t
tun_chr_read_iter(struct kiocb
*iocb
, struct iov_iter
*to
)
1449 struct file
*file
= iocb
->ki_filp
;
1450 struct tun_file
*tfile
= file
->private_data
;
1451 struct tun_struct
*tun
= __tun_get(tfile
);
1452 ssize_t len
= iov_iter_count(to
), ret
;
1456 ret
= tun_do_read(tun
, tfile
, to
, file
->f_flags
& O_NONBLOCK
);
1457 ret
= min_t(ssize_t
, ret
, len
);
1464 static void tun_free_netdev(struct net_device
*dev
)
1466 struct tun_struct
*tun
= netdev_priv(dev
);
1468 BUG_ON(!(list_empty(&tun
->disabled
)));
1469 tun_flow_uninit(tun
);
1470 security_tun_dev_free_security(tun
->security
);
1474 static void tun_setup(struct net_device
*dev
)
1476 struct tun_struct
*tun
= netdev_priv(dev
);
1478 tun
->owner
= INVALID_UID
;
1479 tun
->group
= INVALID_GID
;
1481 dev
->ethtool_ops
= &tun_ethtool_ops
;
1482 dev
->destructor
= tun_free_netdev
;
1485 /* Trivial set of netlink ops to allow deleting tun or tap
1486 * device with netlink.
1488 static int tun_validate(struct nlattr
*tb
[], struct nlattr
*data
[])
1493 static struct rtnl_link_ops tun_link_ops __read_mostly
= {
1495 .priv_size
= sizeof(struct tun_struct
),
1497 .validate
= tun_validate
,
1500 static void tun_sock_write_space(struct sock
*sk
)
1502 struct tun_file
*tfile
;
1503 wait_queue_head_t
*wqueue
;
1505 if (!sock_writeable(sk
))
1508 if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE
, &sk
->sk_socket
->flags
))
1511 wqueue
= sk_sleep(sk
);
1512 if (wqueue
&& waitqueue_active(wqueue
))
1513 wake_up_interruptible_sync_poll(wqueue
, POLLOUT
|
1514 POLLWRNORM
| POLLWRBAND
);
1516 tfile
= container_of(sk
, struct tun_file
, sk
);
1517 kill_fasync(&tfile
->fasync
, SIGIO
, POLL_OUT
);
1520 static int tun_sendmsg(struct socket
*sock
, struct msghdr
*m
, size_t total_len
)
1523 struct tun_file
*tfile
= container_of(sock
, struct tun_file
, socket
);
1524 struct tun_struct
*tun
= __tun_get(tfile
);
1529 ret
= tun_get_user(tun
, tfile
, m
->msg_control
, &m
->msg_iter
,
1530 m
->msg_flags
& MSG_DONTWAIT
);
1535 static int tun_recvmsg(struct socket
*sock
, struct msghdr
*m
, size_t total_len
,
1538 struct tun_file
*tfile
= container_of(sock
, struct tun_file
, socket
);
1539 struct tun_struct
*tun
= __tun_get(tfile
);
1545 if (flags
& ~(MSG_DONTWAIT
|MSG_TRUNC
|MSG_ERRQUEUE
)) {
1549 if (flags
& MSG_ERRQUEUE
) {
1550 ret
= sock_recv_errqueue(sock
->sk
, m
, total_len
,
1551 SOL_PACKET
, TUN_TX_TIMESTAMP
);
1554 ret
= tun_do_read(tun
, tfile
, &m
->msg_iter
, flags
& MSG_DONTWAIT
);
1555 if (ret
> (ssize_t
)total_len
) {
1556 m
->msg_flags
|= MSG_TRUNC
;
1557 ret
= flags
& MSG_TRUNC
? ret
: total_len
;
1564 /* Ops structure to mimic raw sockets with tun */
1565 static const struct proto_ops tun_socket_ops
= {
1566 .sendmsg
= tun_sendmsg
,
1567 .recvmsg
= tun_recvmsg
,
1570 static struct proto tun_proto
= {
1572 .owner
= THIS_MODULE
,
1573 .obj_size
= sizeof(struct tun_file
),
1576 static int tun_flags(struct tun_struct
*tun
)
1578 return tun
->flags
& (TUN_FEATURES
| IFF_PERSIST
| IFF_TUN
| IFF_TAP
);
1581 static ssize_t
tun_show_flags(struct device
*dev
, struct device_attribute
*attr
,
1584 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
1585 return sprintf(buf
, "0x%x\n", tun_flags(tun
));
1588 static ssize_t
tun_show_owner(struct device
*dev
, struct device_attribute
*attr
,
1591 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
1592 return uid_valid(tun
->owner
)?
1593 sprintf(buf
, "%u\n",
1594 from_kuid_munged(current_user_ns(), tun
->owner
)):
1595 sprintf(buf
, "-1\n");
1598 static ssize_t
tun_show_group(struct device
*dev
, struct device_attribute
*attr
,
1601 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
1602 return gid_valid(tun
->group
) ?
1603 sprintf(buf
, "%u\n",
1604 from_kgid_munged(current_user_ns(), tun
->group
)):
1605 sprintf(buf
, "-1\n");
1608 static DEVICE_ATTR(tun_flags
, 0444, tun_show_flags
, NULL
);
1609 static DEVICE_ATTR(owner
, 0444, tun_show_owner
, NULL
);
1610 static DEVICE_ATTR(group
, 0444, tun_show_group
, NULL
);
1612 static struct attribute
*tun_dev_attrs
[] = {
1613 &dev_attr_tun_flags
.attr
,
1614 &dev_attr_owner
.attr
,
1615 &dev_attr_group
.attr
,
1619 static const struct attribute_group tun_attr_group
= {
1620 .attrs
= tun_dev_attrs
1623 static int tun_set_iff(struct net
*net
, struct file
*file
, struct ifreq
*ifr
)
1625 struct tun_struct
*tun
;
1626 struct tun_file
*tfile
= file
->private_data
;
1627 struct net_device
*dev
;
1630 if (tfile
->detached
)
1633 dev
= __dev_get_by_name(net
, ifr
->ifr_name
);
1635 if (ifr
->ifr_flags
& IFF_TUN_EXCL
)
1637 if ((ifr
->ifr_flags
& IFF_TUN
) && dev
->netdev_ops
== &tun_netdev_ops
)
1638 tun
= netdev_priv(dev
);
1639 else if ((ifr
->ifr_flags
& IFF_TAP
) && dev
->netdev_ops
== &tap_netdev_ops
)
1640 tun
= netdev_priv(dev
);
1644 if (!!(ifr
->ifr_flags
& IFF_MULTI_QUEUE
) !=
1645 !!(tun
->flags
& IFF_MULTI_QUEUE
))
1648 if (tun_not_capable(tun
))
1650 err
= security_tun_dev_open(tun
->security
);
1654 err
= tun_attach(tun
, file
, ifr
->ifr_flags
& IFF_NOFILTER
);
1658 if (tun
->flags
& IFF_MULTI_QUEUE
&&
1659 (tun
->numqueues
+ tun
->numdisabled
> 1)) {
1660 /* One or more queue has already been attached, no need
1661 * to initialize the device again.
1668 unsigned long flags
= 0;
1669 int queues
= ifr
->ifr_flags
& IFF_MULTI_QUEUE
?
1672 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
1674 err
= security_tun_dev_create();
1679 if (ifr
->ifr_flags
& IFF_TUN
) {
1683 } else if (ifr
->ifr_flags
& IFF_TAP
) {
1691 name
= ifr
->ifr_name
;
1693 dev
= alloc_netdev_mqs(sizeof(struct tun_struct
), name
,
1694 NET_NAME_UNKNOWN
, tun_setup
, queues
,
1700 dev_net_set(dev
, net
);
1701 dev
->rtnl_link_ops
= &tun_link_ops
;
1702 dev
->ifindex
= tfile
->ifindex
;
1703 dev
->sysfs_groups
[0] = &tun_attr_group
;
1705 tun
= netdev_priv(dev
);
1708 tun
->txflt
.count
= 0;
1709 tun
->vnet_hdr_sz
= sizeof(struct virtio_net_hdr
);
1711 tun
->align
= NET_SKB_PAD
;
1712 tun
->filter_attached
= false;
1713 tun
->sndbuf
= tfile
->socket
.sk
->sk_sndbuf
;
1715 spin_lock_init(&tun
->lock
);
1717 err
= security_tun_dev_alloc_security(&tun
->security
);
1724 dev
->hw_features
= NETIF_F_SG
| NETIF_F_FRAGLIST
|
1725 TUN_USER_FEATURES
| NETIF_F_HW_VLAN_CTAG_TX
|
1726 NETIF_F_HW_VLAN_STAG_TX
;
1727 dev
->features
= dev
->hw_features
;
1728 dev
->vlan_features
= dev
->features
&
1729 ~(NETIF_F_HW_VLAN_CTAG_TX
|
1730 NETIF_F_HW_VLAN_STAG_TX
);
1732 INIT_LIST_HEAD(&tun
->disabled
);
1733 err
= tun_attach(tun
, file
, false);
1737 err
= register_netdevice(tun
->dev
);
1742 netif_carrier_on(tun
->dev
);
1744 tun_debug(KERN_INFO
, tun
, "tun_set_iff\n");
1746 tun
->flags
= (tun
->flags
& ~TUN_FEATURES
) |
1747 (ifr
->ifr_flags
& TUN_FEATURES
);
1749 /* Make sure persistent devices do not get stuck in
1752 if (netif_running(tun
->dev
))
1753 netif_tx_wake_all_queues(tun
->dev
);
1755 strcpy(ifr
->ifr_name
, tun
->dev
->name
);
1759 tun_detach_all(dev
);
1761 tun_flow_uninit(tun
);
1762 security_tun_dev_free_security(tun
->security
);
1768 static void tun_get_iff(struct net
*net
, struct tun_struct
*tun
,
1771 tun_debug(KERN_INFO
, tun
, "tun_get_iff\n");
1773 strcpy(ifr
->ifr_name
, tun
->dev
->name
);
1775 ifr
->ifr_flags
= tun_flags(tun
);
1779 /* This is like a cut-down ethtool ops, except done via tun fd so no
1780 * privs required. */
1781 static int set_offload(struct tun_struct
*tun
, unsigned long arg
)
1783 netdev_features_t features
= 0;
1785 if (arg
& TUN_F_CSUM
) {
1786 features
|= NETIF_F_HW_CSUM
;
1789 if (arg
& (TUN_F_TSO4
|TUN_F_TSO6
)) {
1790 if (arg
& TUN_F_TSO_ECN
) {
1791 features
|= NETIF_F_TSO_ECN
;
1792 arg
&= ~TUN_F_TSO_ECN
;
1794 if (arg
& TUN_F_TSO4
)
1795 features
|= NETIF_F_TSO
;
1796 if (arg
& TUN_F_TSO6
)
1797 features
|= NETIF_F_TSO6
;
1798 arg
&= ~(TUN_F_TSO4
|TUN_F_TSO6
);
1801 if (arg
& TUN_F_UFO
) {
1802 features
|= NETIF_F_UFO
;
1807 /* This gives the user a way to test for new features in future by
1808 * trying to set them. */
1812 tun
->set_features
= features
;
1813 netdev_update_features(tun
->dev
);
1818 static void tun_detach_filter(struct tun_struct
*tun
, int n
)
1821 struct tun_file
*tfile
;
1823 for (i
= 0; i
< n
; i
++) {
1824 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
1825 sk_detach_filter(tfile
->socket
.sk
);
1828 tun
->filter_attached
= false;
1831 static int tun_attach_filter(struct tun_struct
*tun
)
1834 struct tun_file
*tfile
;
1836 for (i
= 0; i
< tun
->numqueues
; i
++) {
1837 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
1838 ret
= sk_attach_filter(&tun
->fprog
, tfile
->socket
.sk
);
1840 tun_detach_filter(tun
, i
);
1845 tun
->filter_attached
= true;
1849 static void tun_set_sndbuf(struct tun_struct
*tun
)
1851 struct tun_file
*tfile
;
1854 for (i
= 0; i
< tun
->numqueues
; i
++) {
1855 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
1856 tfile
->socket
.sk
->sk_sndbuf
= tun
->sndbuf
;
1860 static int tun_set_queue(struct file
*file
, struct ifreq
*ifr
)
1862 struct tun_file
*tfile
= file
->private_data
;
1863 struct tun_struct
*tun
;
1868 if (ifr
->ifr_flags
& IFF_ATTACH_QUEUE
) {
1869 tun
= tfile
->detached
;
1874 ret
= security_tun_dev_attach_queue(tun
->security
);
1877 ret
= tun_attach(tun
, file
, false);
1878 } else if (ifr
->ifr_flags
& IFF_DETACH_QUEUE
) {
1879 tun
= rtnl_dereference(tfile
->tun
);
1880 if (!tun
|| !(tun
->flags
& IFF_MULTI_QUEUE
) || tfile
->detached
)
1883 __tun_detach(tfile
, false);
1892 static long __tun_chr_ioctl(struct file
*file
, unsigned int cmd
,
1893 unsigned long arg
, int ifreq_len
)
1895 struct tun_file
*tfile
= file
->private_data
;
1896 struct tun_struct
*tun
;
1897 void __user
* argp
= (void __user
*)arg
;
1903 unsigned int ifindex
;
1907 if (cmd
== TUNSETIFF
|| cmd
== TUNSETQUEUE
|| _IOC_TYPE(cmd
) == 0x89) {
1908 if (copy_from_user(&ifr
, argp
, ifreq_len
))
1911 memset(&ifr
, 0, sizeof(ifr
));
1913 if (cmd
== TUNGETFEATURES
) {
1914 /* Currently this just means: "what IFF flags are valid?".
1915 * This is needed because we never checked for invalid flags on
1918 return put_user(IFF_TUN
| IFF_TAP
| TUN_FEATURES
,
1919 (unsigned int __user
*)argp
);
1920 } else if (cmd
== TUNSETQUEUE
)
1921 return tun_set_queue(file
, &ifr
);
1926 tun
= __tun_get(tfile
);
1927 if (cmd
== TUNSETIFF
&& !tun
) {
1928 ifr
.ifr_name
[IFNAMSIZ
-1] = '\0';
1930 ret
= tun_set_iff(sock_net(&tfile
->sk
), file
, &ifr
);
1935 if (copy_to_user(argp
, &ifr
, ifreq_len
))
1939 if (cmd
== TUNSETIFINDEX
) {
1945 if (copy_from_user(&ifindex
, argp
, sizeof(ifindex
)))
1949 tfile
->ifindex
= ifindex
;
1957 tun_debug(KERN_INFO
, tun
, "tun_chr_ioctl cmd %u\n", cmd
);
1962 tun_get_iff(current
->nsproxy
->net_ns
, tun
, &ifr
);
1964 if (tfile
->detached
)
1965 ifr
.ifr_flags
|= IFF_DETACH_QUEUE
;
1966 if (!tfile
->socket
.sk
->sk_filter
)
1967 ifr
.ifr_flags
|= IFF_NOFILTER
;
1969 if (copy_to_user(argp
, &ifr
, ifreq_len
))
1974 /* Disable/Enable checksum */
1976 /* [unimplemented] */
1977 tun_debug(KERN_INFO
, tun
, "ignored: set checksum %s\n",
1978 arg
? "disabled" : "enabled");
1982 /* Disable/Enable persist mode. Keep an extra reference to the
1983 * module to prevent the module being unprobed.
1985 if (arg
&& !(tun
->flags
& IFF_PERSIST
)) {
1986 tun
->flags
|= IFF_PERSIST
;
1987 __module_get(THIS_MODULE
);
1989 if (!arg
&& (tun
->flags
& IFF_PERSIST
)) {
1990 tun
->flags
&= ~IFF_PERSIST
;
1991 module_put(THIS_MODULE
);
1994 tun_debug(KERN_INFO
, tun
, "persist %s\n",
1995 arg
? "enabled" : "disabled");
1999 /* Set owner of the device */
2000 owner
= make_kuid(current_user_ns(), arg
);
2001 if (!uid_valid(owner
)) {
2006 tun_debug(KERN_INFO
, tun
, "owner set to %u\n",
2007 from_kuid(&init_user_ns
, tun
->owner
));
2011 /* Set group of the device */
2012 group
= make_kgid(current_user_ns(), arg
);
2013 if (!gid_valid(group
)) {
2018 tun_debug(KERN_INFO
, tun
, "group set to %u\n",
2019 from_kgid(&init_user_ns
, tun
->group
));
2023 /* Only allow setting the type when the interface is down */
2024 if (tun
->dev
->flags
& IFF_UP
) {
2025 tun_debug(KERN_INFO
, tun
,
2026 "Linktype set failed because interface is up\n");
2029 tun
->dev
->type
= (int) arg
;
2030 tun_debug(KERN_INFO
, tun
, "linktype set to %d\n",
2042 ret
= set_offload(tun
, arg
);
2045 case TUNSETTXFILTER
:
2046 /* Can be set only for TAPs */
2048 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
2050 ret
= update_filter(&tun
->txflt
, (void __user
*)arg
);
2054 /* Get hw address */
2055 memcpy(ifr
.ifr_hwaddr
.sa_data
, tun
->dev
->dev_addr
, ETH_ALEN
);
2056 ifr
.ifr_hwaddr
.sa_family
= tun
->dev
->type
;
2057 if (copy_to_user(argp
, &ifr
, ifreq_len
))
2062 /* Set hw address */
2063 tun_debug(KERN_DEBUG
, tun
, "set hw address: %pM\n",
2064 ifr
.ifr_hwaddr
.sa_data
);
2066 ret
= dev_set_mac_address(tun
->dev
, &ifr
.ifr_hwaddr
);
2070 sndbuf
= tfile
->socket
.sk
->sk_sndbuf
;
2071 if (copy_to_user(argp
, &sndbuf
, sizeof(sndbuf
)))
2076 if (copy_from_user(&sndbuf
, argp
, sizeof(sndbuf
))) {
2081 tun
->sndbuf
= sndbuf
;
2082 tun_set_sndbuf(tun
);
2085 case TUNGETVNETHDRSZ
:
2086 vnet_hdr_sz
= tun
->vnet_hdr_sz
;
2087 if (copy_to_user(argp
, &vnet_hdr_sz
, sizeof(vnet_hdr_sz
)))
2091 case TUNSETVNETHDRSZ
:
2092 if (copy_from_user(&vnet_hdr_sz
, argp
, sizeof(vnet_hdr_sz
))) {
2096 if (vnet_hdr_sz
< (int)sizeof(struct virtio_net_hdr
)) {
2101 tun
->vnet_hdr_sz
= vnet_hdr_sz
;
2105 le
= !!(tun
->flags
& TUN_VNET_LE
);
2106 if (put_user(le
, (int __user
*)argp
))
2111 if (get_user(le
, (int __user
*)argp
)) {
2116 tun
->flags
|= TUN_VNET_LE
;
2118 tun
->flags
&= ~TUN_VNET_LE
;
2122 ret
= tun_get_vnet_be(tun
, argp
);
2126 ret
= tun_set_vnet_be(tun
, argp
);
2129 case TUNATTACHFILTER
:
2130 /* Can be set only for TAPs */
2132 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
2135 if (copy_from_user(&tun
->fprog
, argp
, sizeof(tun
->fprog
)))
2138 ret
= tun_attach_filter(tun
);
2141 case TUNDETACHFILTER
:
2142 /* Can be set only for TAPs */
2144 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
2147 tun_detach_filter(tun
, tun
->numqueues
);
2152 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
2155 if (copy_to_user(argp
, &tun
->fprog
, sizeof(tun
->fprog
)))
2172 static long tun_chr_ioctl(struct file
*file
,
2173 unsigned int cmd
, unsigned long arg
)
2175 return __tun_chr_ioctl(file
, cmd
, arg
, sizeof (struct ifreq
));
2178 #ifdef CONFIG_COMPAT
2179 static long tun_chr_compat_ioctl(struct file
*file
,
2180 unsigned int cmd
, unsigned long arg
)
2185 case TUNSETTXFILTER
:
2190 arg
= (unsigned long)compat_ptr(arg
);
2193 arg
= (compat_ulong_t
)arg
;
2198 * compat_ifreq is shorter than ifreq, so we must not access beyond
2199 * the end of that structure. All fields that are used in this
2200 * driver are compatible though, we don't need to convert the
2203 return __tun_chr_ioctl(file
, cmd
, arg
, sizeof(struct compat_ifreq
));
2205 #endif /* CONFIG_COMPAT */
2207 static int tun_chr_fasync(int fd
, struct file
*file
, int on
)
2209 struct tun_file
*tfile
= file
->private_data
;
2212 if ((ret
= fasync_helper(fd
, file
, on
, &tfile
->fasync
)) < 0)
2216 __f_setown(file
, task_pid(current
), PIDTYPE_PID
, 0);
2217 tfile
->flags
|= TUN_FASYNC
;
2219 tfile
->flags
&= ~TUN_FASYNC
;
2225 static int tun_chr_open(struct inode
*inode
, struct file
* file
)
2227 struct net
*net
= current
->nsproxy
->net_ns
;
2228 struct tun_file
*tfile
;
2230 DBG1(KERN_INFO
, "tunX: tun_chr_open\n");
2232 tfile
= (struct tun_file
*)sk_alloc(net
, AF_UNSPEC
, GFP_KERNEL
,
2236 RCU_INIT_POINTER(tfile
->tun
, NULL
);
2240 init_waitqueue_head(&tfile
->wq
.wait
);
2241 RCU_INIT_POINTER(tfile
->socket
.wq
, &tfile
->wq
);
2243 tfile
->socket
.file
= file
;
2244 tfile
->socket
.ops
= &tun_socket_ops
;
2246 sock_init_data(&tfile
->socket
, &tfile
->sk
);
2248 tfile
->sk
.sk_write_space
= tun_sock_write_space
;
2249 tfile
->sk
.sk_sndbuf
= INT_MAX
;
2251 file
->private_data
= tfile
;
2252 INIT_LIST_HEAD(&tfile
->next
);
2254 sock_set_flag(&tfile
->sk
, SOCK_ZEROCOPY
);
2259 static int tun_chr_close(struct inode
*inode
, struct file
*file
)
2261 struct tun_file
*tfile
= file
->private_data
;
2263 tun_detach(tfile
, true);
2268 #ifdef CONFIG_PROC_FS
2269 static void tun_chr_show_fdinfo(struct seq_file
*m
, struct file
*f
)
2271 struct tun_struct
*tun
;
2274 memset(&ifr
, 0, sizeof(ifr
));
2279 tun_get_iff(current
->nsproxy
->net_ns
, tun
, &ifr
);
2285 seq_printf(m
, "iff:\t%s\n", ifr
.ifr_name
);
2289 static const struct file_operations tun_fops
= {
2290 .owner
= THIS_MODULE
,
2291 .llseek
= no_llseek
,
2292 .read_iter
= tun_chr_read_iter
,
2293 .write_iter
= tun_chr_write_iter
,
2294 .poll
= tun_chr_poll
,
2295 .unlocked_ioctl
= tun_chr_ioctl
,
2296 #ifdef CONFIG_COMPAT
2297 .compat_ioctl
= tun_chr_compat_ioctl
,
2299 .open
= tun_chr_open
,
2300 .release
= tun_chr_close
,
2301 .fasync
= tun_chr_fasync
,
2302 #ifdef CONFIG_PROC_FS
2303 .show_fdinfo
= tun_chr_show_fdinfo
,
2307 static struct miscdevice tun_miscdev
= {
2310 .nodename
= "net/tun",
2314 /* ethtool interface */
2316 static int tun_get_settings(struct net_device
*dev
, struct ethtool_cmd
*cmd
)
2319 cmd
->advertising
= 0;
2320 ethtool_cmd_speed_set(cmd
, SPEED_10
);
2321 cmd
->duplex
= DUPLEX_FULL
;
2322 cmd
->port
= PORT_TP
;
2323 cmd
->phy_address
= 0;
2324 cmd
->transceiver
= XCVR_INTERNAL
;
2325 cmd
->autoneg
= AUTONEG_DISABLE
;
2331 static void tun_get_drvinfo(struct net_device
*dev
, struct ethtool_drvinfo
*info
)
2333 struct tun_struct
*tun
= netdev_priv(dev
);
2335 strlcpy(info
->driver
, DRV_NAME
, sizeof(info
->driver
));
2336 strlcpy(info
->version
, DRV_VERSION
, sizeof(info
->version
));
2338 switch (tun
->flags
& TUN_TYPE_MASK
) {
2340 strlcpy(info
->bus_info
, "tun", sizeof(info
->bus_info
));
2343 strlcpy(info
->bus_info
, "tap", sizeof(info
->bus_info
));
2348 static u32
tun_get_msglevel(struct net_device
*dev
)
2351 struct tun_struct
*tun
= netdev_priv(dev
);
2358 static void tun_set_msglevel(struct net_device
*dev
, u32 value
)
2361 struct tun_struct
*tun
= netdev_priv(dev
);
2366 static const struct ethtool_ops tun_ethtool_ops
= {
2367 .get_settings
= tun_get_settings
,
2368 .get_drvinfo
= tun_get_drvinfo
,
2369 .get_msglevel
= tun_get_msglevel
,
2370 .set_msglevel
= tun_set_msglevel
,
2371 .get_link
= ethtool_op_get_link
,
2372 .get_ts_info
= ethtool_op_get_ts_info
,
2376 static int __init
tun_init(void)
2380 pr_info("%s, %s\n", DRV_DESCRIPTION
, DRV_VERSION
);
2381 pr_info("%s\n", DRV_COPYRIGHT
);
2383 ret
= rtnl_link_register(&tun_link_ops
);
2385 pr_err("Can't register link_ops\n");
2389 ret
= misc_register(&tun_miscdev
);
2391 pr_err("Can't register misc device %d\n", TUN_MINOR
);
2396 rtnl_link_unregister(&tun_link_ops
);
2401 static void tun_cleanup(void)
2403 misc_deregister(&tun_miscdev
);
2404 rtnl_link_unregister(&tun_link_ops
);
2407 /* Get an underlying socket object from tun file. Returns error unless file is
2408 * attached to a device. The returned object works like a packet socket, it
2409 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
2410 * holding a reference to the file for as long as the socket is in use. */
2411 struct socket
*tun_get_socket(struct file
*file
)
2413 struct tun_file
*tfile
;
2414 if (file
->f_op
!= &tun_fops
)
2415 return ERR_PTR(-EINVAL
);
2416 tfile
= file
->private_data
;
2418 return ERR_PTR(-EBADFD
);
2419 return &tfile
->socket
;
2421 EXPORT_SYMBOL_GPL(tun_get_socket
);
2423 module_init(tun_init
);
2424 module_exit(tun_cleanup
);
2425 MODULE_DESCRIPTION(DRV_DESCRIPTION
);
2426 MODULE_AUTHOR(DRV_COPYRIGHT
);
2427 MODULE_LICENSE("GPL");
2428 MODULE_ALIAS_MISCDEV(TUN_MINOR
);
2429 MODULE_ALIAS("devname:net/tun");