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>
69 #include <net/net_namespace.h>
70 #include <net/netns/generic.h>
71 #include <net/rtnetlink.h>
73 #include <linux/seq_file.h>
74 #include <linux/uio.h>
76 #include <asm/uaccess.h>
78 /* Uncomment to enable debugging */
79 /* #define TUN_DEBUG 1 */
84 #define tun_debug(level, tun, fmt, args...) \
87 netdev_printk(level, tun->dev, fmt, ##args); \
89 #define DBG1(level, fmt, args...) \
92 printk(level fmt, ##args); \
95 #define tun_debug(level, tun, fmt, args...) \
98 netdev_printk(level, tun->dev, fmt, ##args); \
100 #define DBG1(level, fmt, args...) \
103 printk(level fmt, ##args); \
107 /* TUN device flags */
109 /* IFF_ATTACH_QUEUE is never stored in device flags,
110 * overload it to mean fasync when stored there.
112 #define TUN_FASYNC IFF_ATTACH_QUEUE
114 #define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
115 IFF_VNET_LE | IFF_MULTI_QUEUE)
116 #define GOODCOPY_LEN 128
118 #define FLT_EXACT_COUNT 8
120 unsigned int count
; /* Number of addrs. Zero means disabled */
121 u32 mask
[2]; /* Mask of the hashed addrs */
122 unsigned char addr
[FLT_EXACT_COUNT
][ETH_ALEN
];
125 /* DEFAULT_MAX_NUM_RSS_QUEUES were chosen to let the rx/tx queues allocated for
126 * the netdevice to be fit in one page. So we can make sure the success of
127 * memory allocation. TODO: increase the limit. */
128 #define MAX_TAP_QUEUES DEFAULT_MAX_NUM_RSS_QUEUES
129 #define MAX_TAP_FLOWS 4096
131 #define TUN_FLOW_EXPIRE (3 * HZ)
133 /* A tun_file connects an open character device to a tuntap netdevice. It
134 * also contains all socket related structures (except sock_fprog and tap_filter)
135 * to serve as one transmit queue for tuntap device. The sock_fprog and
136 * tap_filter were kept in tun_struct since they were used for filtering for the
137 * netdevice not for a specific queue (at least I didn't see the requirement for
141 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
142 * other can only be read while rcu_read_lock or rtnl_lock is held.
146 struct socket socket
;
148 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| \
192 struct tap_filter txflt
;
193 struct sock_fprog fprog
;
194 /* protected by rtnl lock */
195 bool filter_attached
;
200 struct hlist_head flows
[TUN_NUM_FLOW_ENTRIES
];
201 struct timer_list flow_gc_timer
;
202 unsigned long ageing_time
;
203 unsigned int numdisabled
;
204 struct list_head disabled
;
209 static inline u16
tun16_to_cpu(struct tun_struct
*tun
, __virtio16 val
)
211 return __virtio16_to_cpu(tun
->flags
& IFF_VNET_LE
, val
);
214 static inline __virtio16
cpu_to_tun16(struct tun_struct
*tun
, u16 val
)
216 return __cpu_to_virtio16(tun
->flags
& IFF_VNET_LE
, val
);
219 static inline u32
tun_hashfn(u32 rxhash
)
221 return rxhash
& 0x3ff;
224 static struct tun_flow_entry
*tun_flow_find(struct hlist_head
*head
, u32 rxhash
)
226 struct tun_flow_entry
*e
;
228 hlist_for_each_entry_rcu(e
, head
, hash_link
) {
229 if (e
->rxhash
== rxhash
)
235 static struct tun_flow_entry
*tun_flow_create(struct tun_struct
*tun
,
236 struct hlist_head
*head
,
237 u32 rxhash
, u16 queue_index
)
239 struct tun_flow_entry
*e
= kmalloc(sizeof(*e
), GFP_ATOMIC
);
242 tun_debug(KERN_INFO
, tun
, "create flow: hash %u index %u\n",
243 rxhash
, queue_index
);
244 e
->updated
= jiffies
;
247 e
->queue_index
= queue_index
;
249 hlist_add_head_rcu(&e
->hash_link
, head
);
255 static void tun_flow_delete(struct tun_struct
*tun
, struct tun_flow_entry
*e
)
257 tun_debug(KERN_INFO
, tun
, "delete flow: hash %u index %u\n",
258 e
->rxhash
, e
->queue_index
);
259 sock_rps_reset_flow_hash(e
->rps_rxhash
);
260 hlist_del_rcu(&e
->hash_link
);
265 static void tun_flow_flush(struct tun_struct
*tun
)
269 spin_lock_bh(&tun
->lock
);
270 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
271 struct tun_flow_entry
*e
;
272 struct hlist_node
*n
;
274 hlist_for_each_entry_safe(e
, n
, &tun
->flows
[i
], hash_link
)
275 tun_flow_delete(tun
, e
);
277 spin_unlock_bh(&tun
->lock
);
280 static void tun_flow_delete_by_queue(struct tun_struct
*tun
, u16 queue_index
)
284 spin_lock_bh(&tun
->lock
);
285 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
286 struct tun_flow_entry
*e
;
287 struct hlist_node
*n
;
289 hlist_for_each_entry_safe(e
, n
, &tun
->flows
[i
], hash_link
) {
290 if (e
->queue_index
== queue_index
)
291 tun_flow_delete(tun
, e
);
294 spin_unlock_bh(&tun
->lock
);
297 static void tun_flow_cleanup(unsigned long data
)
299 struct tun_struct
*tun
= (struct tun_struct
*)data
;
300 unsigned long delay
= tun
->ageing_time
;
301 unsigned long next_timer
= jiffies
+ delay
;
302 unsigned long count
= 0;
305 tun_debug(KERN_INFO
, tun
, "tun_flow_cleanup\n");
307 spin_lock_bh(&tun
->lock
);
308 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
309 struct tun_flow_entry
*e
;
310 struct hlist_node
*n
;
312 hlist_for_each_entry_safe(e
, n
, &tun
->flows
[i
], hash_link
) {
313 unsigned long this_timer
;
315 this_timer
= e
->updated
+ delay
;
316 if (time_before_eq(this_timer
, jiffies
))
317 tun_flow_delete(tun
, e
);
318 else if (time_before(this_timer
, next_timer
))
319 next_timer
= this_timer
;
324 mod_timer(&tun
->flow_gc_timer
, round_jiffies_up(next_timer
));
325 spin_unlock_bh(&tun
->lock
);
328 static void tun_flow_update(struct tun_struct
*tun
, u32 rxhash
,
329 struct tun_file
*tfile
)
331 struct hlist_head
*head
;
332 struct tun_flow_entry
*e
;
333 unsigned long delay
= tun
->ageing_time
;
334 u16 queue_index
= tfile
->queue_index
;
339 head
= &tun
->flows
[tun_hashfn(rxhash
)];
343 /* We may get a very small possibility of OOO during switching, not
344 * worth to optimize.*/
345 if (tun
->numqueues
== 1 || tfile
->detached
)
348 e
= tun_flow_find(head
, rxhash
);
350 /* TODO: keep queueing to old queue until it's empty? */
351 e
->queue_index
= queue_index
;
352 e
->updated
= jiffies
;
353 sock_rps_record_flow_hash(e
->rps_rxhash
);
355 spin_lock_bh(&tun
->lock
);
356 if (!tun_flow_find(head
, rxhash
) &&
357 tun
->flow_count
< MAX_TAP_FLOWS
)
358 tun_flow_create(tun
, head
, rxhash
, queue_index
);
360 if (!timer_pending(&tun
->flow_gc_timer
))
361 mod_timer(&tun
->flow_gc_timer
,
362 round_jiffies_up(jiffies
+ delay
));
363 spin_unlock_bh(&tun
->lock
);
371 * Save the hash received in the stack receive path and update the
372 * flow_hash table accordingly.
374 static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry
*e
, u32 hash
)
376 if (unlikely(e
->rps_rxhash
!= hash
)) {
377 sock_rps_reset_flow_hash(e
->rps_rxhash
);
378 e
->rps_rxhash
= hash
;
382 /* We try to identify a flow through its rxhash first. The reason that
383 * we do not check rxq no. is because some cards(e.g 82599), chooses
384 * the rxq based on the txq where the last packet of the flow comes. As
385 * the userspace application move between processors, we may get a
386 * different rxq no. here. If we could not get rxhash, then we would
387 * hope the rxq no. may help here.
389 static u16
tun_select_queue(struct net_device
*dev
, struct sk_buff
*skb
,
390 void *accel_priv
, select_queue_fallback_t fallback
)
392 struct tun_struct
*tun
= netdev_priv(dev
);
393 struct tun_flow_entry
*e
;
398 numqueues
= ACCESS_ONCE(tun
->numqueues
);
400 txq
= skb_get_hash(skb
);
402 e
= tun_flow_find(&tun
->flows
[tun_hashfn(txq
)], txq
);
404 tun_flow_save_rps_rxhash(e
, txq
);
405 txq
= e
->queue_index
;
407 /* use multiply and shift instead of expensive divide */
408 txq
= ((u64
)txq
* numqueues
) >> 32;
409 } else if (likely(skb_rx_queue_recorded(skb
))) {
410 txq
= skb_get_rx_queue(skb
);
411 while (unlikely(txq
>= numqueues
))
419 static inline bool tun_not_capable(struct tun_struct
*tun
)
421 const struct cred
*cred
= current_cred();
422 struct net
*net
= dev_net(tun
->dev
);
424 return ((uid_valid(tun
->owner
) && !uid_eq(cred
->euid
, tun
->owner
)) ||
425 (gid_valid(tun
->group
) && !in_egroup_p(tun
->group
))) &&
426 !ns_capable(net
->user_ns
, CAP_NET_ADMIN
);
429 static void tun_set_real_num_queues(struct tun_struct
*tun
)
431 netif_set_real_num_tx_queues(tun
->dev
, tun
->numqueues
);
432 netif_set_real_num_rx_queues(tun
->dev
, tun
->numqueues
);
435 static void tun_disable_queue(struct tun_struct
*tun
, struct tun_file
*tfile
)
437 tfile
->detached
= tun
;
438 list_add_tail(&tfile
->next
, &tun
->disabled
);
442 static struct tun_struct
*tun_enable_queue(struct tun_file
*tfile
)
444 struct tun_struct
*tun
= tfile
->detached
;
446 tfile
->detached
= NULL
;
447 list_del_init(&tfile
->next
);
452 static void tun_queue_purge(struct tun_file
*tfile
)
454 skb_queue_purge(&tfile
->sk
.sk_receive_queue
);
455 skb_queue_purge(&tfile
->sk
.sk_error_queue
);
458 static void __tun_detach(struct tun_file
*tfile
, bool clean
)
460 struct tun_file
*ntfile
;
461 struct tun_struct
*tun
;
463 tun
= rtnl_dereference(tfile
->tun
);
465 if (tun
&& !tfile
->detached
) {
466 u16 index
= tfile
->queue_index
;
467 BUG_ON(index
>= tun
->numqueues
);
469 rcu_assign_pointer(tun
->tfiles
[index
],
470 tun
->tfiles
[tun
->numqueues
- 1]);
471 ntfile
= rtnl_dereference(tun
->tfiles
[index
]);
472 ntfile
->queue_index
= index
;
476 RCU_INIT_POINTER(tfile
->tun
, NULL
);
477 sock_put(&tfile
->sk
);
479 tun_disable_queue(tun
, tfile
);
482 tun_flow_delete_by_queue(tun
, tun
->numqueues
+ 1);
483 /* Drop read queue */
484 tun_queue_purge(tfile
);
485 tun_set_real_num_queues(tun
);
486 } else if (tfile
->detached
&& clean
) {
487 tun
= tun_enable_queue(tfile
);
488 sock_put(&tfile
->sk
);
492 if (tun
&& tun
->numqueues
== 0 && tun
->numdisabled
== 0) {
493 netif_carrier_off(tun
->dev
);
495 if (!(tun
->flags
& IFF_PERSIST
) &&
496 tun
->dev
->reg_state
== NETREG_REGISTERED
)
497 unregister_netdevice(tun
->dev
);
500 BUG_ON(!test_bit(SOCK_EXTERNALLY_ALLOCATED
,
501 &tfile
->socket
.flags
));
502 sk_release_kernel(&tfile
->sk
);
506 static void tun_detach(struct tun_file
*tfile
, bool clean
)
509 __tun_detach(tfile
, clean
);
513 static void tun_detach_all(struct net_device
*dev
)
515 struct tun_struct
*tun
= netdev_priv(dev
);
516 struct tun_file
*tfile
, *tmp
;
517 int i
, n
= tun
->numqueues
;
519 for (i
= 0; i
< n
; i
++) {
520 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
522 tfile
->socket
.sk
->sk_data_ready(tfile
->socket
.sk
);
523 RCU_INIT_POINTER(tfile
->tun
, NULL
);
526 list_for_each_entry(tfile
, &tun
->disabled
, next
) {
527 tfile
->socket
.sk
->sk_data_ready(tfile
->socket
.sk
);
528 RCU_INIT_POINTER(tfile
->tun
, NULL
);
530 BUG_ON(tun
->numqueues
!= 0);
533 for (i
= 0; i
< n
; i
++) {
534 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
535 /* Drop read queue */
536 tun_queue_purge(tfile
);
537 sock_put(&tfile
->sk
);
539 list_for_each_entry_safe(tfile
, tmp
, &tun
->disabled
, next
) {
540 tun_enable_queue(tfile
);
541 tun_queue_purge(tfile
);
542 sock_put(&tfile
->sk
);
544 BUG_ON(tun
->numdisabled
!= 0);
546 if (tun
->flags
& IFF_PERSIST
)
547 module_put(THIS_MODULE
);
550 static int tun_attach(struct tun_struct
*tun
, struct file
*file
, bool skip_filter
)
552 struct tun_file
*tfile
= file
->private_data
;
555 err
= security_tun_dev_attach(tfile
->socket
.sk
, tun
->security
);
560 if (rtnl_dereference(tfile
->tun
) && !tfile
->detached
)
564 if (!(tun
->flags
& IFF_MULTI_QUEUE
) && tun
->numqueues
== 1)
568 if (!tfile
->detached
&&
569 tun
->numqueues
+ tun
->numdisabled
== MAX_TAP_QUEUES
)
574 /* Re-attach the filter to persist device */
575 if (!skip_filter
&& (tun
->filter_attached
== true)) {
576 err
= sk_attach_filter(&tun
->fprog
, tfile
->socket
.sk
);
580 tfile
->queue_index
= tun
->numqueues
;
581 rcu_assign_pointer(tfile
->tun
, tun
);
582 rcu_assign_pointer(tun
->tfiles
[tun
->numqueues
], tfile
);
586 tun_enable_queue(tfile
);
588 sock_hold(&tfile
->sk
);
590 tun_set_real_num_queues(tun
);
592 /* device is allowed to go away first, so no need to hold extra
600 static struct tun_struct
*__tun_get(struct tun_file
*tfile
)
602 struct tun_struct
*tun
;
605 tun
= rcu_dereference(tfile
->tun
);
613 static struct tun_struct
*tun_get(struct file
*file
)
615 return __tun_get(file
->private_data
);
618 static void tun_put(struct tun_struct
*tun
)
624 static void addr_hash_set(u32
*mask
, const u8
*addr
)
626 int n
= ether_crc(ETH_ALEN
, addr
) >> 26;
627 mask
[n
>> 5] |= (1 << (n
& 31));
630 static unsigned int addr_hash_test(const u32
*mask
, const u8
*addr
)
632 int n
= ether_crc(ETH_ALEN
, addr
) >> 26;
633 return mask
[n
>> 5] & (1 << (n
& 31));
636 static int update_filter(struct tap_filter
*filter
, void __user
*arg
)
638 struct { u8 u
[ETH_ALEN
]; } *addr
;
639 struct tun_filter uf
;
640 int err
, alen
, n
, nexact
;
642 if (copy_from_user(&uf
, arg
, sizeof(uf
)))
651 alen
= ETH_ALEN
* uf
.count
;
652 addr
= kmalloc(alen
, GFP_KERNEL
);
656 if (copy_from_user(addr
, arg
+ sizeof(uf
), alen
)) {
661 /* The filter is updated without holding any locks. Which is
662 * perfectly safe. We disable it first and in the worst
663 * case we'll accept a few undesired packets. */
667 /* Use first set of addresses as an exact filter */
668 for (n
= 0; n
< uf
.count
&& n
< FLT_EXACT_COUNT
; n
++)
669 memcpy(filter
->addr
[n
], addr
[n
].u
, ETH_ALEN
);
673 /* Remaining multicast addresses are hashed,
674 * unicast will leave the filter disabled. */
675 memset(filter
->mask
, 0, sizeof(filter
->mask
));
676 for (; n
< uf
.count
; n
++) {
677 if (!is_multicast_ether_addr(addr
[n
].u
)) {
678 err
= 0; /* no filter */
681 addr_hash_set(filter
->mask
, addr
[n
].u
);
684 /* For ALLMULTI just set the mask to all ones.
685 * This overrides the mask populated above. */
686 if ((uf
.flags
& TUN_FLT_ALLMULTI
))
687 memset(filter
->mask
, ~0, sizeof(filter
->mask
));
689 /* Now enable the filter */
691 filter
->count
= nexact
;
693 /* Return the number of exact filters */
701 /* Returns: 0 - drop, !=0 - accept */
702 static int run_filter(struct tap_filter
*filter
, const struct sk_buff
*skb
)
704 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
706 struct ethhdr
*eh
= (struct ethhdr
*) skb
->data
;
710 for (i
= 0; i
< filter
->count
; i
++)
711 if (ether_addr_equal(eh
->h_dest
, filter
->addr
[i
]))
714 /* Inexact match (multicast only) */
715 if (is_multicast_ether_addr(eh
->h_dest
))
716 return addr_hash_test(filter
->mask
, eh
->h_dest
);
722 * Checks whether the packet is accepted or not.
723 * Returns: 0 - drop, !=0 - accept
725 static int check_filter(struct tap_filter
*filter
, const struct sk_buff
*skb
)
730 return run_filter(filter
, skb
);
733 /* Network device part of the driver */
735 static const struct ethtool_ops tun_ethtool_ops
;
737 /* Net device detach from fd. */
738 static void tun_net_uninit(struct net_device
*dev
)
743 /* Net device open. */
744 static int tun_net_open(struct net_device
*dev
)
746 netif_tx_start_all_queues(dev
);
750 /* Net device close. */
751 static int tun_net_close(struct net_device
*dev
)
753 netif_tx_stop_all_queues(dev
);
757 /* Net device start xmit */
758 static netdev_tx_t
tun_net_xmit(struct sk_buff
*skb
, struct net_device
*dev
)
760 struct tun_struct
*tun
= netdev_priv(dev
);
761 int txq
= skb
->queue_mapping
;
762 struct tun_file
*tfile
;
766 tfile
= rcu_dereference(tun
->tfiles
[txq
]);
767 numqueues
= ACCESS_ONCE(tun
->numqueues
);
769 /* Drop packet if interface is not attached */
770 if (txq
>= numqueues
)
773 if (numqueues
== 1) {
774 /* Select queue was not called for the skbuff, so we extract the
775 * RPS hash and save it into the flow_table here.
779 rxhash
= skb_get_hash(skb
);
781 struct tun_flow_entry
*e
;
782 e
= tun_flow_find(&tun
->flows
[tun_hashfn(rxhash
)],
785 tun_flow_save_rps_rxhash(e
, rxhash
);
789 tun_debug(KERN_INFO
, tun
, "tun_net_xmit %d\n", skb
->len
);
793 /* Drop if the filter does not like it.
794 * This is a noop if the filter is disabled.
795 * Filter can be enabled only for the TAP devices. */
796 if (!check_filter(&tun
->txflt
, skb
))
799 if (tfile
->socket
.sk
->sk_filter
&&
800 sk_filter(tfile
->socket
.sk
, skb
))
803 /* Limit the number of packets queued by dividing txq length with the
806 if (skb_queue_len(&tfile
->socket
.sk
->sk_receive_queue
) * numqueues
807 >= dev
->tx_queue_len
)
810 if (unlikely(skb_orphan_frags(skb
, GFP_ATOMIC
)))
814 sock_tx_timestamp(skb
->sk
, &skb_shinfo(skb
)->tx_flags
);
815 sw_tx_timestamp(skb
);
818 /* Orphan the skb - required as we might hang on to it
819 * for indefinite time.
826 skb_queue_tail(&tfile
->socket
.sk
->sk_receive_queue
, skb
);
828 /* Notify and wake up reader process */
829 if (tfile
->flags
& TUN_FASYNC
)
830 kill_fasync(&tfile
->fasync
, SIGIO
, POLL_IN
);
831 tfile
->socket
.sk
->sk_data_ready(tfile
->socket
.sk
);
837 dev
->stats
.tx_dropped
++;
841 return NET_XMIT_DROP
;
844 static void tun_net_mclist(struct net_device
*dev
)
847 * This callback is supposed to deal with mc filter in
848 * _rx_ path and has nothing to do with the _tx_ path.
849 * In rx path we always accept everything userspace gives us.
854 #define MAX_MTU 65535
857 tun_net_change_mtu(struct net_device
*dev
, int new_mtu
)
859 if (new_mtu
< MIN_MTU
|| new_mtu
+ dev
->hard_header_len
> MAX_MTU
)
865 static netdev_features_t
tun_net_fix_features(struct net_device
*dev
,
866 netdev_features_t features
)
868 struct tun_struct
*tun
= netdev_priv(dev
);
870 return (features
& tun
->set_features
) | (features
& ~TUN_USER_FEATURES
);
872 #ifdef CONFIG_NET_POLL_CONTROLLER
873 static void tun_poll_controller(struct net_device
*dev
)
876 * Tun only receives frames when:
877 * 1) the char device endpoint gets data from user space
878 * 2) the tun socket gets a sendmsg call from user space
879 * Since both of those are synchronous operations, we are guaranteed
880 * never to have pending data when we poll for it
881 * so there is nothing to do here but return.
882 * We need this though so netpoll recognizes us as an interface that
883 * supports polling, which enables bridge devices in virt setups to
884 * still use netconsole
889 static const struct net_device_ops tun_netdev_ops
= {
890 .ndo_uninit
= tun_net_uninit
,
891 .ndo_open
= tun_net_open
,
892 .ndo_stop
= tun_net_close
,
893 .ndo_start_xmit
= tun_net_xmit
,
894 .ndo_change_mtu
= tun_net_change_mtu
,
895 .ndo_fix_features
= tun_net_fix_features
,
896 .ndo_select_queue
= tun_select_queue
,
897 #ifdef CONFIG_NET_POLL_CONTROLLER
898 .ndo_poll_controller
= tun_poll_controller
,
902 static const struct net_device_ops tap_netdev_ops
= {
903 .ndo_uninit
= tun_net_uninit
,
904 .ndo_open
= tun_net_open
,
905 .ndo_stop
= tun_net_close
,
906 .ndo_start_xmit
= tun_net_xmit
,
907 .ndo_change_mtu
= tun_net_change_mtu
,
908 .ndo_fix_features
= tun_net_fix_features
,
909 .ndo_set_rx_mode
= tun_net_mclist
,
910 .ndo_set_mac_address
= eth_mac_addr
,
911 .ndo_validate_addr
= eth_validate_addr
,
912 .ndo_select_queue
= tun_select_queue
,
913 #ifdef CONFIG_NET_POLL_CONTROLLER
914 .ndo_poll_controller
= tun_poll_controller
,
918 static void tun_flow_init(struct tun_struct
*tun
)
922 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++)
923 INIT_HLIST_HEAD(&tun
->flows
[i
]);
925 tun
->ageing_time
= TUN_FLOW_EXPIRE
;
926 setup_timer(&tun
->flow_gc_timer
, tun_flow_cleanup
, (unsigned long)tun
);
927 mod_timer(&tun
->flow_gc_timer
,
928 round_jiffies_up(jiffies
+ tun
->ageing_time
));
931 static void tun_flow_uninit(struct tun_struct
*tun
)
933 del_timer_sync(&tun
->flow_gc_timer
);
937 /* Initialize net device. */
938 static void tun_net_init(struct net_device
*dev
)
940 struct tun_struct
*tun
= netdev_priv(dev
);
942 switch (tun
->flags
& TUN_TYPE_MASK
) {
944 dev
->netdev_ops
= &tun_netdev_ops
;
946 /* Point-to-Point TUN Device */
947 dev
->hard_header_len
= 0;
951 /* Zero header length */
952 dev
->type
= ARPHRD_NONE
;
953 dev
->flags
= IFF_POINTOPOINT
| IFF_NOARP
| IFF_MULTICAST
;
954 dev
->tx_queue_len
= TUN_READQ_SIZE
; /* We prefer our own queue length */
958 dev
->netdev_ops
= &tap_netdev_ops
;
959 /* Ethernet TAP Device */
961 dev
->priv_flags
&= ~IFF_TX_SKB_SHARING
;
962 dev
->priv_flags
|= IFF_LIVE_ADDR_CHANGE
;
964 eth_hw_addr_random(dev
);
966 dev
->tx_queue_len
= TUN_READQ_SIZE
; /* We prefer our own queue length */
971 /* Character device part */
974 static unsigned int tun_chr_poll(struct file
*file
, poll_table
*wait
)
976 struct tun_file
*tfile
= file
->private_data
;
977 struct tun_struct
*tun
= __tun_get(tfile
);
979 unsigned int mask
= 0;
984 sk
= tfile
->socket
.sk
;
986 tun_debug(KERN_INFO
, tun
, "tun_chr_poll\n");
988 poll_wait(file
, sk_sleep(sk
), wait
);
990 if (!skb_queue_empty(&sk
->sk_receive_queue
))
991 mask
|= POLLIN
| POLLRDNORM
;
993 if (sock_writeable(sk
) ||
994 (!test_and_set_bit(SOCK_ASYNC_NOSPACE
, &sk
->sk_socket
->flags
) &&
996 mask
|= POLLOUT
| POLLWRNORM
;
998 if (tun
->dev
->reg_state
!= NETREG_REGISTERED
)
1005 /* prepad is the amount to reserve at front. len is length after that.
1006 * linear is a hint as to how much to copy (usually headers). */
1007 static struct sk_buff
*tun_alloc_skb(struct tun_file
*tfile
,
1008 size_t prepad
, size_t len
,
1009 size_t linear
, int noblock
)
1011 struct sock
*sk
= tfile
->socket
.sk
;
1012 struct sk_buff
*skb
;
1015 /* Under a page? Don't bother with paged skb. */
1016 if (prepad
+ len
< PAGE_SIZE
|| !linear
)
1019 skb
= sock_alloc_send_pskb(sk
, prepad
+ linear
, len
- linear
, noblock
,
1022 return ERR_PTR(err
);
1024 skb_reserve(skb
, prepad
);
1025 skb_put(skb
, linear
);
1026 skb
->data_len
= len
- linear
;
1027 skb
->len
+= len
- linear
;
1032 /* Get packet from user space buffer */
1033 static ssize_t
tun_get_user(struct tun_struct
*tun
, struct tun_file
*tfile
,
1034 void *msg_control
, struct iov_iter
*from
,
1037 struct tun_pi pi
= { 0, cpu_to_be16(ETH_P_IP
) };
1038 struct sk_buff
*skb
;
1039 size_t total_len
= iov_iter_count(from
);
1040 size_t len
= total_len
, align
= NET_SKB_PAD
, linear
;
1041 struct virtio_net_hdr gso
= { 0 };
1044 bool zerocopy
= false;
1049 if (!(tun
->flags
& IFF_NO_PI
)) {
1050 if (len
< sizeof(pi
))
1054 n
= copy_from_iter(&pi
, sizeof(pi
), from
);
1055 if (n
!= sizeof(pi
))
1059 if (tun
->flags
& IFF_VNET_HDR
) {
1060 if (len
< tun
->vnet_hdr_sz
)
1062 len
-= tun
->vnet_hdr_sz
;
1064 n
= copy_from_iter(&gso
, sizeof(gso
), from
);
1065 if (n
!= sizeof(gso
))
1068 if ((gso
.flags
& VIRTIO_NET_HDR_F_NEEDS_CSUM
) &&
1069 tun16_to_cpu(tun
, gso
.csum_start
) + tun16_to_cpu(tun
, gso
.csum_offset
) + 2 > tun16_to_cpu(tun
, gso
.hdr_len
))
1070 gso
.hdr_len
= cpu_to_tun16(tun
, tun16_to_cpu(tun
, gso
.csum_start
) + tun16_to_cpu(tun
, gso
.csum_offset
) + 2);
1072 if (tun16_to_cpu(tun
, gso
.hdr_len
) > len
)
1074 iov_iter_advance(from
, tun
->vnet_hdr_sz
- sizeof(gso
));
1077 if ((tun
->flags
& TUN_TYPE_MASK
) == IFF_TAP
) {
1078 align
+= NET_IP_ALIGN
;
1079 if (unlikely(len
< ETH_HLEN
||
1080 (gso
.hdr_len
&& tun16_to_cpu(tun
, gso
.hdr_len
) < ETH_HLEN
)))
1084 good_linear
= SKB_MAX_HEAD(align
);
1087 struct iov_iter i
= *from
;
1089 /* There are 256 bytes to be copied in skb, so there is
1090 * enough room for skb expand head in case it is used.
1091 * The rest of the buffer is mapped from userspace.
1093 copylen
= gso
.hdr_len
? tun16_to_cpu(tun
, gso
.hdr_len
) : GOODCOPY_LEN
;
1094 if (copylen
> good_linear
)
1095 copylen
= good_linear
;
1097 iov_iter_advance(&i
, copylen
);
1098 if (iov_iter_npages(&i
, INT_MAX
) <= MAX_SKB_FRAGS
)
1104 if (tun16_to_cpu(tun
, gso
.hdr_len
) > good_linear
)
1105 linear
= good_linear
;
1107 linear
= tun16_to_cpu(tun
, gso
.hdr_len
);
1110 skb
= tun_alloc_skb(tfile
, align
, copylen
, linear
, noblock
);
1112 if (PTR_ERR(skb
) != -EAGAIN
)
1113 tun
->dev
->stats
.rx_dropped
++;
1114 return PTR_ERR(skb
);
1118 err
= zerocopy_sg_from_iter(skb
, from
);
1120 err
= skb_copy_datagram_from_iter(skb
, 0, from
, len
);
1121 if (!err
&& msg_control
) {
1122 struct ubuf_info
*uarg
= msg_control
;
1123 uarg
->callback(uarg
, false);
1128 tun
->dev
->stats
.rx_dropped
++;
1133 if (gso
.flags
& VIRTIO_NET_HDR_F_NEEDS_CSUM
) {
1134 if (!skb_partial_csum_set(skb
, tun16_to_cpu(tun
, gso
.csum_start
),
1135 tun16_to_cpu(tun
, gso
.csum_offset
))) {
1136 tun
->dev
->stats
.rx_frame_errors
++;
1142 switch (tun
->flags
& TUN_TYPE_MASK
) {
1144 if (tun
->flags
& IFF_NO_PI
) {
1145 switch (skb
->data
[0] & 0xf0) {
1147 pi
.proto
= htons(ETH_P_IP
);
1150 pi
.proto
= htons(ETH_P_IPV6
);
1153 tun
->dev
->stats
.rx_dropped
++;
1159 skb_reset_mac_header(skb
);
1160 skb
->protocol
= pi
.proto
;
1161 skb
->dev
= tun
->dev
;
1164 skb
->protocol
= eth_type_trans(skb
, tun
->dev
);
1168 skb_reset_network_header(skb
);
1170 if (gso
.gso_type
!= VIRTIO_NET_HDR_GSO_NONE
) {
1172 switch (gso
.gso_type
& ~VIRTIO_NET_HDR_GSO_ECN
) {
1173 case VIRTIO_NET_HDR_GSO_TCPV4
:
1174 skb_shinfo(skb
)->gso_type
= SKB_GSO_TCPV4
;
1176 case VIRTIO_NET_HDR_GSO_TCPV6
:
1177 skb_shinfo(skb
)->gso_type
= SKB_GSO_TCPV6
;
1179 case VIRTIO_NET_HDR_GSO_UDP
:
1185 netdev_warn(tun
->dev
,
1186 "%s: using disabled UFO feature; please fix this program\n",
1189 skb_shinfo(skb
)->gso_type
= SKB_GSO_UDP
;
1190 if (skb
->protocol
== htons(ETH_P_IPV6
))
1191 ipv6_proxy_select_ident(skb
);
1195 tun
->dev
->stats
.rx_frame_errors
++;
1200 if (gso
.gso_type
& VIRTIO_NET_HDR_GSO_ECN
)
1201 skb_shinfo(skb
)->gso_type
|= SKB_GSO_TCP_ECN
;
1203 skb_shinfo(skb
)->gso_size
= tun16_to_cpu(tun
, gso
.gso_size
);
1204 if (skb_shinfo(skb
)->gso_size
== 0) {
1205 tun
->dev
->stats
.rx_frame_errors
++;
1210 /* Header must be checked, and gso_segs computed. */
1211 skb_shinfo(skb
)->gso_type
|= SKB_GSO_DODGY
;
1212 skb_shinfo(skb
)->gso_segs
= 0;
1215 /* copy skb_ubuf_info for callback when skb has no error */
1217 skb_shinfo(skb
)->destructor_arg
= msg_control
;
1218 skb_shinfo(skb
)->tx_flags
|= SKBTX_DEV_ZEROCOPY
;
1219 skb_shinfo(skb
)->tx_flags
|= SKBTX_SHARED_FRAG
;
1222 skb_probe_transport_header(skb
, 0);
1224 rxhash
= skb_get_hash(skb
);
1227 tun
->dev
->stats
.rx_packets
++;
1228 tun
->dev
->stats
.rx_bytes
+= len
;
1230 tun_flow_update(tun
, rxhash
, tfile
);
1234 static ssize_t
tun_chr_write_iter(struct kiocb
*iocb
, struct iov_iter
*from
)
1236 struct file
*file
= iocb
->ki_filp
;
1237 struct tun_struct
*tun
= tun_get(file
);
1238 struct tun_file
*tfile
= file
->private_data
;
1244 result
= tun_get_user(tun
, tfile
, NULL
, from
, file
->f_flags
& O_NONBLOCK
);
1250 /* Put packet to the user space buffer */
1251 static ssize_t
tun_put_user(struct tun_struct
*tun
,
1252 struct tun_file
*tfile
,
1253 struct sk_buff
*skb
,
1254 struct iov_iter
*iter
)
1256 struct tun_pi pi
= { 0, skb
->protocol
};
1258 int vlan_offset
= 0;
1260 int vnet_hdr_sz
= 0;
1262 if (vlan_tx_tag_present(skb
))
1263 vlan_hlen
= VLAN_HLEN
;
1265 if (tun
->flags
& IFF_VNET_HDR
)
1266 vnet_hdr_sz
= tun
->vnet_hdr_sz
;
1268 total
= skb
->len
+ vlan_hlen
+ vnet_hdr_sz
;
1270 if (!(tun
->flags
& IFF_NO_PI
)) {
1271 if (iov_iter_count(iter
) < sizeof(pi
))
1274 total
+= sizeof(pi
);
1275 if (iov_iter_count(iter
) < total
) {
1276 /* Packet will be striped */
1277 pi
.flags
|= TUN_PKT_STRIP
;
1280 if (copy_to_iter(&pi
, sizeof(pi
), iter
) != sizeof(pi
))
1285 struct virtio_net_hdr gso
= { 0 }; /* no info leak */
1286 if (iov_iter_count(iter
) < vnet_hdr_sz
)
1289 if (skb_is_gso(skb
)) {
1290 struct skb_shared_info
*sinfo
= skb_shinfo(skb
);
1292 /* This is a hint as to how much should be linear. */
1293 gso
.hdr_len
= cpu_to_tun16(tun
, skb_headlen(skb
));
1294 gso
.gso_size
= cpu_to_tun16(tun
, sinfo
->gso_size
);
1295 if (sinfo
->gso_type
& SKB_GSO_TCPV4
)
1296 gso
.gso_type
= VIRTIO_NET_HDR_GSO_TCPV4
;
1297 else if (sinfo
->gso_type
& SKB_GSO_TCPV6
)
1298 gso
.gso_type
= VIRTIO_NET_HDR_GSO_TCPV6
;
1300 pr_err("unexpected GSO type: "
1301 "0x%x, gso_size %d, hdr_len %d\n",
1302 sinfo
->gso_type
, tun16_to_cpu(tun
, gso
.gso_size
),
1303 tun16_to_cpu(tun
, gso
.hdr_len
));
1304 print_hex_dump(KERN_ERR
, "tun: ",
1307 min((int)tun16_to_cpu(tun
, gso
.hdr_len
), 64), true);
1311 if (sinfo
->gso_type
& SKB_GSO_TCP_ECN
)
1312 gso
.gso_type
|= VIRTIO_NET_HDR_GSO_ECN
;
1314 gso
.gso_type
= VIRTIO_NET_HDR_GSO_NONE
;
1316 if (skb
->ip_summed
== CHECKSUM_PARTIAL
) {
1317 gso
.flags
= VIRTIO_NET_HDR_F_NEEDS_CSUM
;
1318 gso
.csum_start
= cpu_to_tun16(tun
, skb_checksum_start_offset(skb
) +
1320 gso
.csum_offset
= cpu_to_tun16(tun
, skb
->csum_offset
);
1321 } else if (skb
->ip_summed
== CHECKSUM_UNNECESSARY
) {
1322 gso
.flags
= VIRTIO_NET_HDR_F_DATA_VALID
;
1323 } /* else everything is zero */
1325 if (copy_to_iter(&gso
, sizeof(gso
), iter
) != sizeof(gso
))
1328 iov_iter_advance(iter
, vnet_hdr_sz
- sizeof(gso
));
1334 __be16 h_vlan_proto
;
1338 veth
.h_vlan_proto
= skb
->vlan_proto
;
1339 veth
.h_vlan_TCI
= htons(vlan_tx_tag_get(skb
));
1341 vlan_offset
= offsetof(struct vlan_ethhdr
, h_vlan_proto
);
1343 ret
= skb_copy_datagram_iter(skb
, 0, iter
, vlan_offset
);
1344 if (ret
|| !iov_iter_count(iter
))
1347 ret
= copy_to_iter(&veth
, sizeof(veth
), iter
);
1348 if (ret
!= sizeof(veth
) || !iov_iter_count(iter
))
1352 skb_copy_datagram_iter(skb
, vlan_offset
, iter
, skb
->len
- vlan_offset
);
1355 tun
->dev
->stats
.tx_packets
++;
1356 tun
->dev
->stats
.tx_bytes
+= skb
->len
+ vlan_hlen
;
1361 static ssize_t
tun_do_read(struct tun_struct
*tun
, struct tun_file
*tfile
,
1362 struct iov_iter
*to
,
1365 struct sk_buff
*skb
;
1367 int peeked
, err
, off
= 0;
1369 tun_debug(KERN_INFO
, tun
, "tun_do_read\n");
1371 if (!iov_iter_count(to
))
1374 if (tun
->dev
->reg_state
!= NETREG_REGISTERED
)
1377 /* Read frames from queue */
1378 skb
= __skb_recv_datagram(tfile
->socket
.sk
, noblock
? MSG_DONTWAIT
: 0,
1379 &peeked
, &off
, &err
);
1383 ret
= tun_put_user(tun
, tfile
, skb
, to
);
1384 if (unlikely(ret
< 0))
1392 static ssize_t
tun_chr_read_iter(struct kiocb
*iocb
, struct iov_iter
*to
)
1394 struct file
*file
= iocb
->ki_filp
;
1395 struct tun_file
*tfile
= file
->private_data
;
1396 struct tun_struct
*tun
= __tun_get(tfile
);
1397 ssize_t len
= iov_iter_count(to
), ret
;
1401 ret
= tun_do_read(tun
, tfile
, to
, file
->f_flags
& O_NONBLOCK
);
1402 ret
= min_t(ssize_t
, ret
, len
);
1409 static void tun_free_netdev(struct net_device
*dev
)
1411 struct tun_struct
*tun
= netdev_priv(dev
);
1413 BUG_ON(!(list_empty(&tun
->disabled
)));
1414 tun_flow_uninit(tun
);
1415 security_tun_dev_free_security(tun
->security
);
1419 static void tun_setup(struct net_device
*dev
)
1421 struct tun_struct
*tun
= netdev_priv(dev
);
1423 tun
->owner
= INVALID_UID
;
1424 tun
->group
= INVALID_GID
;
1426 dev
->ethtool_ops
= &tun_ethtool_ops
;
1427 dev
->destructor
= tun_free_netdev
;
1430 /* Trivial set of netlink ops to allow deleting tun or tap
1431 * device with netlink.
1433 static int tun_validate(struct nlattr
*tb
[], struct nlattr
*data
[])
1438 static struct rtnl_link_ops tun_link_ops __read_mostly
= {
1440 .priv_size
= sizeof(struct tun_struct
),
1442 .validate
= tun_validate
,
1445 static void tun_sock_write_space(struct sock
*sk
)
1447 struct tun_file
*tfile
;
1448 wait_queue_head_t
*wqueue
;
1450 if (!sock_writeable(sk
))
1453 if (!test_and_clear_bit(SOCK_ASYNC_NOSPACE
, &sk
->sk_socket
->flags
))
1456 wqueue
= sk_sleep(sk
);
1457 if (wqueue
&& waitqueue_active(wqueue
))
1458 wake_up_interruptible_sync_poll(wqueue
, POLLOUT
|
1459 POLLWRNORM
| POLLWRBAND
);
1461 tfile
= container_of(sk
, struct tun_file
, sk
);
1462 kill_fasync(&tfile
->fasync
, SIGIO
, POLL_OUT
);
1465 static int tun_sendmsg(struct kiocb
*iocb
, struct socket
*sock
,
1466 struct msghdr
*m
, size_t total_len
)
1469 struct tun_file
*tfile
= container_of(sock
, struct tun_file
, socket
);
1470 struct tun_struct
*tun
= __tun_get(tfile
);
1475 ret
= tun_get_user(tun
, tfile
, m
->msg_control
, &m
->msg_iter
,
1476 m
->msg_flags
& MSG_DONTWAIT
);
1481 static int tun_recvmsg(struct kiocb
*iocb
, struct socket
*sock
,
1482 struct msghdr
*m
, size_t total_len
,
1485 struct tun_file
*tfile
= container_of(sock
, struct tun_file
, socket
);
1486 struct tun_struct
*tun
= __tun_get(tfile
);
1492 if (flags
& ~(MSG_DONTWAIT
|MSG_TRUNC
|MSG_ERRQUEUE
)) {
1496 if (flags
& MSG_ERRQUEUE
) {
1497 ret
= sock_recv_errqueue(sock
->sk
, m
, total_len
,
1498 SOL_PACKET
, TUN_TX_TIMESTAMP
);
1501 ret
= tun_do_read(tun
, tfile
, &m
->msg_iter
, flags
& MSG_DONTWAIT
);
1502 if (ret
> total_len
) {
1503 m
->msg_flags
|= MSG_TRUNC
;
1504 ret
= flags
& MSG_TRUNC
? ret
: total_len
;
1511 static int tun_release(struct socket
*sock
)
1518 /* Ops structure to mimic raw sockets with tun */
1519 static const struct proto_ops tun_socket_ops
= {
1520 .sendmsg
= tun_sendmsg
,
1521 .recvmsg
= tun_recvmsg
,
1522 .release
= tun_release
,
1525 static struct proto tun_proto
= {
1527 .owner
= THIS_MODULE
,
1528 .obj_size
= sizeof(struct tun_file
),
1531 static int tun_flags(struct tun_struct
*tun
)
1533 return tun
->flags
& (TUN_FEATURES
| IFF_PERSIST
| IFF_TUN
| IFF_TAP
);
1536 static ssize_t
tun_show_flags(struct device
*dev
, struct device_attribute
*attr
,
1539 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
1540 return sprintf(buf
, "0x%x\n", tun_flags(tun
));
1543 static ssize_t
tun_show_owner(struct device
*dev
, struct device_attribute
*attr
,
1546 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
1547 return uid_valid(tun
->owner
)?
1548 sprintf(buf
, "%u\n",
1549 from_kuid_munged(current_user_ns(), tun
->owner
)):
1550 sprintf(buf
, "-1\n");
1553 static ssize_t
tun_show_group(struct device
*dev
, struct device_attribute
*attr
,
1556 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
1557 return gid_valid(tun
->group
) ?
1558 sprintf(buf
, "%u\n",
1559 from_kgid_munged(current_user_ns(), tun
->group
)):
1560 sprintf(buf
, "-1\n");
1563 static DEVICE_ATTR(tun_flags
, 0444, tun_show_flags
, NULL
);
1564 static DEVICE_ATTR(owner
, 0444, tun_show_owner
, NULL
);
1565 static DEVICE_ATTR(group
, 0444, tun_show_group
, NULL
);
1567 static int tun_set_iff(struct net
*net
, struct file
*file
, struct ifreq
*ifr
)
1569 struct tun_struct
*tun
;
1570 struct tun_file
*tfile
= file
->private_data
;
1571 struct net_device
*dev
;
1574 if (tfile
->detached
)
1577 dev
= __dev_get_by_name(net
, ifr
->ifr_name
);
1579 if (ifr
->ifr_flags
& IFF_TUN_EXCL
)
1581 if ((ifr
->ifr_flags
& IFF_TUN
) && dev
->netdev_ops
== &tun_netdev_ops
)
1582 tun
= netdev_priv(dev
);
1583 else if ((ifr
->ifr_flags
& IFF_TAP
) && dev
->netdev_ops
== &tap_netdev_ops
)
1584 tun
= netdev_priv(dev
);
1588 if (!!(ifr
->ifr_flags
& IFF_MULTI_QUEUE
) !=
1589 !!(tun
->flags
& IFF_MULTI_QUEUE
))
1592 if (tun_not_capable(tun
))
1594 err
= security_tun_dev_open(tun
->security
);
1598 err
= tun_attach(tun
, file
, ifr
->ifr_flags
& IFF_NOFILTER
);
1602 if (tun
->flags
& IFF_MULTI_QUEUE
&&
1603 (tun
->numqueues
+ tun
->numdisabled
> 1)) {
1604 /* One or more queue has already been attached, no need
1605 * to initialize the device again.
1612 unsigned long flags
= 0;
1613 int queues
= ifr
->ifr_flags
& IFF_MULTI_QUEUE
?
1616 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
1618 err
= security_tun_dev_create();
1623 if (ifr
->ifr_flags
& IFF_TUN
) {
1627 } else if (ifr
->ifr_flags
& IFF_TAP
) {
1635 name
= ifr
->ifr_name
;
1637 dev
= alloc_netdev_mqs(sizeof(struct tun_struct
), name
,
1638 NET_NAME_UNKNOWN
, tun_setup
, queues
,
1644 dev_net_set(dev
, net
);
1645 dev
->rtnl_link_ops
= &tun_link_ops
;
1646 dev
->ifindex
= tfile
->ifindex
;
1648 tun
= netdev_priv(dev
);
1651 tun
->txflt
.count
= 0;
1652 tun
->vnet_hdr_sz
= sizeof(struct virtio_net_hdr
);
1654 tun
->filter_attached
= false;
1655 tun
->sndbuf
= tfile
->socket
.sk
->sk_sndbuf
;
1657 spin_lock_init(&tun
->lock
);
1659 err
= security_tun_dev_alloc_security(&tun
->security
);
1666 dev
->hw_features
= NETIF_F_SG
| NETIF_F_FRAGLIST
|
1667 TUN_USER_FEATURES
| NETIF_F_HW_VLAN_CTAG_TX
|
1668 NETIF_F_HW_VLAN_STAG_TX
;
1669 dev
->features
= dev
->hw_features
;
1670 dev
->vlan_features
= dev
->features
&
1671 ~(NETIF_F_HW_VLAN_CTAG_TX
|
1672 NETIF_F_HW_VLAN_STAG_TX
);
1674 INIT_LIST_HEAD(&tun
->disabled
);
1675 err
= tun_attach(tun
, file
, false);
1679 err
= register_netdevice(tun
->dev
);
1683 if (device_create_file(&tun
->dev
->dev
, &dev_attr_tun_flags
) ||
1684 device_create_file(&tun
->dev
->dev
, &dev_attr_owner
) ||
1685 device_create_file(&tun
->dev
->dev
, &dev_attr_group
))
1686 pr_err("Failed to create tun sysfs files\n");
1689 netif_carrier_on(tun
->dev
);
1691 tun_debug(KERN_INFO
, tun
, "tun_set_iff\n");
1693 tun
->flags
= (tun
->flags
& ~TUN_FEATURES
) |
1694 (ifr
->ifr_flags
& TUN_FEATURES
);
1696 /* Make sure persistent devices do not get stuck in
1699 if (netif_running(tun
->dev
))
1700 netif_tx_wake_all_queues(tun
->dev
);
1702 strcpy(ifr
->ifr_name
, tun
->dev
->name
);
1706 tun_detach_all(dev
);
1708 tun_flow_uninit(tun
);
1709 security_tun_dev_free_security(tun
->security
);
1715 static void tun_get_iff(struct net
*net
, struct tun_struct
*tun
,
1718 tun_debug(KERN_INFO
, tun
, "tun_get_iff\n");
1720 strcpy(ifr
->ifr_name
, tun
->dev
->name
);
1722 ifr
->ifr_flags
= tun_flags(tun
);
1726 /* This is like a cut-down ethtool ops, except done via tun fd so no
1727 * privs required. */
1728 static int set_offload(struct tun_struct
*tun
, unsigned long arg
)
1730 netdev_features_t features
= 0;
1732 if (arg
& TUN_F_CSUM
) {
1733 features
|= NETIF_F_HW_CSUM
;
1736 if (arg
& (TUN_F_TSO4
|TUN_F_TSO6
)) {
1737 if (arg
& TUN_F_TSO_ECN
) {
1738 features
|= NETIF_F_TSO_ECN
;
1739 arg
&= ~TUN_F_TSO_ECN
;
1741 if (arg
& TUN_F_TSO4
)
1742 features
|= NETIF_F_TSO
;
1743 if (arg
& TUN_F_TSO6
)
1744 features
|= NETIF_F_TSO6
;
1745 arg
&= ~(TUN_F_TSO4
|TUN_F_TSO6
);
1749 /* This gives the user a way to test for new features in future by
1750 * trying to set them. */
1754 tun
->set_features
= features
;
1755 netdev_update_features(tun
->dev
);
1760 static void tun_detach_filter(struct tun_struct
*tun
, int n
)
1763 struct tun_file
*tfile
;
1765 for (i
= 0; i
< n
; i
++) {
1766 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
1767 sk_detach_filter(tfile
->socket
.sk
);
1770 tun
->filter_attached
= false;
1773 static int tun_attach_filter(struct tun_struct
*tun
)
1776 struct tun_file
*tfile
;
1778 for (i
= 0; i
< tun
->numqueues
; i
++) {
1779 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
1780 ret
= sk_attach_filter(&tun
->fprog
, tfile
->socket
.sk
);
1782 tun_detach_filter(tun
, i
);
1787 tun
->filter_attached
= true;
1791 static void tun_set_sndbuf(struct tun_struct
*tun
)
1793 struct tun_file
*tfile
;
1796 for (i
= 0; i
< tun
->numqueues
; i
++) {
1797 tfile
= rtnl_dereference(tun
->tfiles
[i
]);
1798 tfile
->socket
.sk
->sk_sndbuf
= tun
->sndbuf
;
1802 static int tun_set_queue(struct file
*file
, struct ifreq
*ifr
)
1804 struct tun_file
*tfile
= file
->private_data
;
1805 struct tun_struct
*tun
;
1810 if (ifr
->ifr_flags
& IFF_ATTACH_QUEUE
) {
1811 tun
= tfile
->detached
;
1816 ret
= security_tun_dev_attach_queue(tun
->security
);
1819 ret
= tun_attach(tun
, file
, false);
1820 } else if (ifr
->ifr_flags
& IFF_DETACH_QUEUE
) {
1821 tun
= rtnl_dereference(tfile
->tun
);
1822 if (!tun
|| !(tun
->flags
& IFF_MULTI_QUEUE
) || tfile
->detached
)
1825 __tun_detach(tfile
, false);
1834 static long __tun_chr_ioctl(struct file
*file
, unsigned int cmd
,
1835 unsigned long arg
, int ifreq_len
)
1837 struct tun_file
*tfile
= file
->private_data
;
1838 struct tun_struct
*tun
;
1839 void __user
* argp
= (void __user
*)arg
;
1845 unsigned int ifindex
;
1848 if (cmd
== TUNSETIFF
|| cmd
== TUNSETQUEUE
|| _IOC_TYPE(cmd
) == 0x89) {
1849 if (copy_from_user(&ifr
, argp
, ifreq_len
))
1852 memset(&ifr
, 0, sizeof(ifr
));
1854 if (cmd
== TUNGETFEATURES
) {
1855 /* Currently this just means: "what IFF flags are valid?".
1856 * This is needed because we never checked for invalid flags on
1859 return put_user(IFF_TUN
| IFF_TAP
| TUN_FEATURES
,
1860 (unsigned int __user
*)argp
);
1861 } else if (cmd
== TUNSETQUEUE
)
1862 return tun_set_queue(file
, &ifr
);
1867 tun
= __tun_get(tfile
);
1868 if (cmd
== TUNSETIFF
&& !tun
) {
1869 ifr
.ifr_name
[IFNAMSIZ
-1] = '\0';
1871 ret
= tun_set_iff(tfile
->net
, file
, &ifr
);
1876 if (copy_to_user(argp
, &ifr
, ifreq_len
))
1880 if (cmd
== TUNSETIFINDEX
) {
1886 if (copy_from_user(&ifindex
, argp
, sizeof(ifindex
)))
1890 tfile
->ifindex
= ifindex
;
1898 tun_debug(KERN_INFO
, tun
, "tun_chr_ioctl cmd %u\n", cmd
);
1903 tun_get_iff(current
->nsproxy
->net_ns
, tun
, &ifr
);
1905 if (tfile
->detached
)
1906 ifr
.ifr_flags
|= IFF_DETACH_QUEUE
;
1907 if (!tfile
->socket
.sk
->sk_filter
)
1908 ifr
.ifr_flags
|= IFF_NOFILTER
;
1910 if (copy_to_user(argp
, &ifr
, ifreq_len
))
1915 /* Disable/Enable checksum */
1917 /* [unimplemented] */
1918 tun_debug(KERN_INFO
, tun
, "ignored: set checksum %s\n",
1919 arg
? "disabled" : "enabled");
1923 /* Disable/Enable persist mode. Keep an extra reference to the
1924 * module to prevent the module being unprobed.
1926 if (arg
&& !(tun
->flags
& IFF_PERSIST
)) {
1927 tun
->flags
|= IFF_PERSIST
;
1928 __module_get(THIS_MODULE
);
1930 if (!arg
&& (tun
->flags
& IFF_PERSIST
)) {
1931 tun
->flags
&= ~IFF_PERSIST
;
1932 module_put(THIS_MODULE
);
1935 tun_debug(KERN_INFO
, tun
, "persist %s\n",
1936 arg
? "enabled" : "disabled");
1940 /* Set owner of the device */
1941 owner
= make_kuid(current_user_ns(), arg
);
1942 if (!uid_valid(owner
)) {
1947 tun_debug(KERN_INFO
, tun
, "owner set to %u\n",
1948 from_kuid(&init_user_ns
, tun
->owner
));
1952 /* Set group of the device */
1953 group
= make_kgid(current_user_ns(), arg
);
1954 if (!gid_valid(group
)) {
1959 tun_debug(KERN_INFO
, tun
, "group set to %u\n",
1960 from_kgid(&init_user_ns
, tun
->group
));
1964 /* Only allow setting the type when the interface is down */
1965 if (tun
->dev
->flags
& IFF_UP
) {
1966 tun_debug(KERN_INFO
, tun
,
1967 "Linktype set failed because interface is up\n");
1970 tun
->dev
->type
= (int) arg
;
1971 tun_debug(KERN_INFO
, tun
, "linktype set to %d\n",
1983 ret
= set_offload(tun
, arg
);
1986 case TUNSETTXFILTER
:
1987 /* Can be set only for TAPs */
1989 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
1991 ret
= update_filter(&tun
->txflt
, (void __user
*)arg
);
1995 /* Get hw address */
1996 memcpy(ifr
.ifr_hwaddr
.sa_data
, tun
->dev
->dev_addr
, ETH_ALEN
);
1997 ifr
.ifr_hwaddr
.sa_family
= tun
->dev
->type
;
1998 if (copy_to_user(argp
, &ifr
, ifreq_len
))
2003 /* Set hw address */
2004 tun_debug(KERN_DEBUG
, tun
, "set hw address: %pM\n",
2005 ifr
.ifr_hwaddr
.sa_data
);
2007 ret
= dev_set_mac_address(tun
->dev
, &ifr
.ifr_hwaddr
);
2011 sndbuf
= tfile
->socket
.sk
->sk_sndbuf
;
2012 if (copy_to_user(argp
, &sndbuf
, sizeof(sndbuf
)))
2017 if (copy_from_user(&sndbuf
, argp
, sizeof(sndbuf
))) {
2022 tun
->sndbuf
= sndbuf
;
2023 tun_set_sndbuf(tun
);
2026 case TUNGETVNETHDRSZ
:
2027 vnet_hdr_sz
= tun
->vnet_hdr_sz
;
2028 if (copy_to_user(argp
, &vnet_hdr_sz
, sizeof(vnet_hdr_sz
)))
2032 case TUNSETVNETHDRSZ
:
2033 if (copy_from_user(&vnet_hdr_sz
, argp
, sizeof(vnet_hdr_sz
))) {
2037 if (vnet_hdr_sz
< (int)sizeof(struct virtio_net_hdr
)) {
2042 tun
->vnet_hdr_sz
= vnet_hdr_sz
;
2045 case TUNATTACHFILTER
:
2046 /* Can be set only for TAPs */
2048 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
2051 if (copy_from_user(&tun
->fprog
, argp
, sizeof(tun
->fprog
)))
2054 ret
= tun_attach_filter(tun
);
2057 case TUNDETACHFILTER
:
2058 /* Can be set only for TAPs */
2060 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
2063 tun_detach_filter(tun
, tun
->numqueues
);
2068 if ((tun
->flags
& TUN_TYPE_MASK
) != IFF_TAP
)
2071 if (copy_to_user(argp
, &tun
->fprog
, sizeof(tun
->fprog
)))
2088 static long tun_chr_ioctl(struct file
*file
,
2089 unsigned int cmd
, unsigned long arg
)
2091 return __tun_chr_ioctl(file
, cmd
, arg
, sizeof (struct ifreq
));
2094 #ifdef CONFIG_COMPAT
2095 static long tun_chr_compat_ioctl(struct file
*file
,
2096 unsigned int cmd
, unsigned long arg
)
2101 case TUNSETTXFILTER
:
2106 arg
= (unsigned long)compat_ptr(arg
);
2109 arg
= (compat_ulong_t
)arg
;
2114 * compat_ifreq is shorter than ifreq, so we must not access beyond
2115 * the end of that structure. All fields that are used in this
2116 * driver are compatible though, we don't need to convert the
2119 return __tun_chr_ioctl(file
, cmd
, arg
, sizeof(struct compat_ifreq
));
2121 #endif /* CONFIG_COMPAT */
2123 static int tun_chr_fasync(int fd
, struct file
*file
, int on
)
2125 struct tun_file
*tfile
= file
->private_data
;
2128 if ((ret
= fasync_helper(fd
, file
, on
, &tfile
->fasync
)) < 0)
2132 __f_setown(file
, task_pid(current
), PIDTYPE_PID
, 0);
2133 tfile
->flags
|= TUN_FASYNC
;
2135 tfile
->flags
&= ~TUN_FASYNC
;
2141 static int tun_chr_open(struct inode
*inode
, struct file
* file
)
2143 struct tun_file
*tfile
;
2145 DBG1(KERN_INFO
, "tunX: tun_chr_open\n");
2147 tfile
= (struct tun_file
*)sk_alloc(&init_net
, AF_UNSPEC
, GFP_KERNEL
,
2151 RCU_INIT_POINTER(tfile
->tun
, NULL
);
2152 tfile
->net
= get_net(current
->nsproxy
->net_ns
);
2156 init_waitqueue_head(&tfile
->wq
.wait
);
2157 RCU_INIT_POINTER(tfile
->socket
.wq
, &tfile
->wq
);
2159 tfile
->socket
.file
= file
;
2160 tfile
->socket
.ops
= &tun_socket_ops
;
2162 sock_init_data(&tfile
->socket
, &tfile
->sk
);
2163 sk_change_net(&tfile
->sk
, tfile
->net
);
2165 tfile
->sk
.sk_write_space
= tun_sock_write_space
;
2166 tfile
->sk
.sk_sndbuf
= INT_MAX
;
2168 file
->private_data
= tfile
;
2169 set_bit(SOCK_EXTERNALLY_ALLOCATED
, &tfile
->socket
.flags
);
2170 INIT_LIST_HEAD(&tfile
->next
);
2172 sock_set_flag(&tfile
->sk
, SOCK_ZEROCOPY
);
2177 static int tun_chr_close(struct inode
*inode
, struct file
*file
)
2179 struct tun_file
*tfile
= file
->private_data
;
2180 struct net
*net
= tfile
->net
;
2182 tun_detach(tfile
, true);
2188 #ifdef CONFIG_PROC_FS
2189 static void tun_chr_show_fdinfo(struct seq_file
*m
, struct file
*f
)
2191 struct tun_struct
*tun
;
2194 memset(&ifr
, 0, sizeof(ifr
));
2199 tun_get_iff(current
->nsproxy
->net_ns
, tun
, &ifr
);
2205 seq_printf(m
, "iff:\t%s\n", ifr
.ifr_name
);
2209 static const struct file_operations tun_fops
= {
2210 .owner
= THIS_MODULE
,
2211 .llseek
= no_llseek
,
2212 .read
= new_sync_read
,
2213 .write
= new_sync_write
,
2214 .read_iter
= tun_chr_read_iter
,
2215 .write_iter
= tun_chr_write_iter
,
2216 .poll
= tun_chr_poll
,
2217 .unlocked_ioctl
= tun_chr_ioctl
,
2218 #ifdef CONFIG_COMPAT
2219 .compat_ioctl
= tun_chr_compat_ioctl
,
2221 .open
= tun_chr_open
,
2222 .release
= tun_chr_close
,
2223 .fasync
= tun_chr_fasync
,
2224 #ifdef CONFIG_PROC_FS
2225 .show_fdinfo
= tun_chr_show_fdinfo
,
2229 static struct miscdevice tun_miscdev
= {
2232 .nodename
= "net/tun",
2236 /* ethtool interface */
2238 static int tun_get_settings(struct net_device
*dev
, struct ethtool_cmd
*cmd
)
2241 cmd
->advertising
= 0;
2242 ethtool_cmd_speed_set(cmd
, SPEED_10
);
2243 cmd
->duplex
= DUPLEX_FULL
;
2244 cmd
->port
= PORT_TP
;
2245 cmd
->phy_address
= 0;
2246 cmd
->transceiver
= XCVR_INTERNAL
;
2247 cmd
->autoneg
= AUTONEG_DISABLE
;
2253 static void tun_get_drvinfo(struct net_device
*dev
, struct ethtool_drvinfo
*info
)
2255 struct tun_struct
*tun
= netdev_priv(dev
);
2257 strlcpy(info
->driver
, DRV_NAME
, sizeof(info
->driver
));
2258 strlcpy(info
->version
, DRV_VERSION
, sizeof(info
->version
));
2260 switch (tun
->flags
& TUN_TYPE_MASK
) {
2262 strlcpy(info
->bus_info
, "tun", sizeof(info
->bus_info
));
2265 strlcpy(info
->bus_info
, "tap", sizeof(info
->bus_info
));
2270 static u32
tun_get_msglevel(struct net_device
*dev
)
2273 struct tun_struct
*tun
= netdev_priv(dev
);
2280 static void tun_set_msglevel(struct net_device
*dev
, u32 value
)
2283 struct tun_struct
*tun
= netdev_priv(dev
);
2288 static const struct ethtool_ops tun_ethtool_ops
= {
2289 .get_settings
= tun_get_settings
,
2290 .get_drvinfo
= tun_get_drvinfo
,
2291 .get_msglevel
= tun_get_msglevel
,
2292 .set_msglevel
= tun_set_msglevel
,
2293 .get_link
= ethtool_op_get_link
,
2294 .get_ts_info
= ethtool_op_get_ts_info
,
2298 static int __init
tun_init(void)
2302 pr_info("%s, %s\n", DRV_DESCRIPTION
, DRV_VERSION
);
2303 pr_info("%s\n", DRV_COPYRIGHT
);
2305 ret
= rtnl_link_register(&tun_link_ops
);
2307 pr_err("Can't register link_ops\n");
2311 ret
= misc_register(&tun_miscdev
);
2313 pr_err("Can't register misc device %d\n", TUN_MINOR
);
2318 rtnl_link_unregister(&tun_link_ops
);
2323 static void tun_cleanup(void)
2325 misc_deregister(&tun_miscdev
);
2326 rtnl_link_unregister(&tun_link_ops
);
2329 /* Get an underlying socket object from tun file. Returns error unless file is
2330 * attached to a device. The returned object works like a packet socket, it
2331 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
2332 * holding a reference to the file for as long as the socket is in use. */
2333 struct socket
*tun_get_socket(struct file
*file
)
2335 struct tun_file
*tfile
;
2336 if (file
->f_op
!= &tun_fops
)
2337 return ERR_PTR(-EINVAL
);
2338 tfile
= file
->private_data
;
2340 return ERR_PTR(-EBADFD
);
2341 return &tfile
->socket
;
2343 EXPORT_SYMBOL_GPL(tun_get_socket
);
2345 module_init(tun_init
);
2346 module_exit(tun_cleanup
);
2347 MODULE_DESCRIPTION(DRV_DESCRIPTION
);
2348 MODULE_AUTHOR(DRV_COPYRIGHT
);
2349 MODULE_LICENSE("GPL");
2350 MODULE_ALIAS_MISCDEV(TUN_MINOR
);
2351 MODULE_ALIAS("devname:net/tun");