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/crc32.h>
64 #include <linux/nsproxy.h>
65 #include <linux/virtio_net.h>
66 #include <linux/rcupdate.h>
67 #include <net/net_namespace.h>
68 #include <net/netns/generic.h>
69 #include <net/rtnetlink.h>
72 #include <asm/uaccess.h>
74 /* Uncomment to enable debugging */
75 /* #define TUN_DEBUG 1 */
80 #define tun_debug(level, tun, fmt, args...) \
83 netdev_printk(level, tun->dev, fmt, ##args); \
85 #define DBG1(level, fmt, args...) \
88 printk(level fmt, ##args); \
91 #define tun_debug(level, tun, fmt, args...) \
94 netdev_printk(level, tun->dev, fmt, ##args); \
96 #define DBG1(level, fmt, args...) \
99 printk(level fmt, ##args); \
103 #define GOODCOPY_LEN 128
105 #define FLT_EXACT_COUNT 8
107 unsigned int count
; /* Number of addrs. Zero means disabled */
108 u32 mask
[2]; /* Mask of the hashed addrs */
109 unsigned char addr
[FLT_EXACT_COUNT
][ETH_ALEN
];
112 /* 1024 is probably a high enough limit: modern hypervisors seem to support on
113 * the order of 100-200 CPUs so this leaves us some breathing space if we want
114 * to match a queue per guest CPU.
116 #define MAX_TAP_QUEUES 1024
118 #define TUN_FLOW_EXPIRE (3 * HZ)
120 /* A tun_file connects an open character device to a tuntap netdevice. It
121 * also contains all socket related strctures (except sock_fprog and tap_filter)
122 * to serve as one transmit queue for tuntap device. The sock_fprog and
123 * tap_filter were kept in tun_struct since they were used for filtering for the
124 * netdevice not for a specific queue (at least I didn't see the requirement for
128 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
129 * other can only be read while rcu_read_lock or rtnl_lock is held.
133 struct socket socket
;
135 struct tun_struct __rcu
*tun
;
137 struct fasync_struct
*fasync
;
138 /* only used for fasnyc */
143 struct tun_flow_entry
{
144 struct hlist_node hash_link
;
146 struct tun_struct
*tun
;
150 unsigned long updated
;
153 #define TUN_NUM_FLOW_ENTRIES 1024
155 /* Since the socket were moved to tun_file, to preserve the behavior of persist
156 * device, socket filter, sndbuf and vnet header size were restore when the
157 * file were attached to a persist device.
160 struct tun_file __rcu
*tfiles
[MAX_TAP_QUEUES
];
161 unsigned int numqueues
;
166 struct net_device
*dev
;
167 netdev_features_t set_features
;
168 #define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
169 NETIF_F_TSO6|NETIF_F_UFO)
173 struct tap_filter txflt
;
174 struct sock_fprog fprog
;
175 /* protected by rtnl lock */
176 bool filter_attached
;
181 struct kmem_cache
*flow_cache
;
182 struct hlist_head flows
[TUN_NUM_FLOW_ENTRIES
];
183 struct timer_list flow_gc_timer
;
184 unsigned long ageing_time
;
187 static inline u32
tun_hashfn(u32 rxhash
)
189 return rxhash
& 0x3ff;
192 static struct tun_flow_entry
*tun_flow_find(struct hlist_head
*head
, u32 rxhash
)
194 struct tun_flow_entry
*e
;
195 struct hlist_node
*n
;
197 hlist_for_each_entry_rcu(e
, n
, head
, hash_link
) {
198 if (e
->rxhash
== rxhash
)
204 static struct tun_flow_entry
*tun_flow_create(struct tun_struct
*tun
,
205 struct hlist_head
*head
,
206 u32 rxhash
, u16 queue_index
)
208 struct tun_flow_entry
*e
= kmem_cache_alloc(tun
->flow_cache
,
211 tun_debug(KERN_INFO
, tun
, "create flow: hash %u index %u\n",
212 rxhash
, queue_index
);
213 e
->updated
= jiffies
;
215 e
->queue_index
= queue_index
;
217 hlist_add_head_rcu(&e
->hash_link
, head
);
222 static void tun_flow_free(struct rcu_head
*head
)
224 struct tun_flow_entry
*e
225 = container_of(head
, struct tun_flow_entry
, rcu
);
226 kmem_cache_free(e
->tun
->flow_cache
, e
);
229 static void tun_flow_delete(struct tun_struct
*tun
, struct tun_flow_entry
*e
)
231 tun_debug(KERN_INFO
, tun
, "delete flow: hash %u index %u\n",
232 e
->rxhash
, e
->queue_index
);
233 hlist_del_rcu(&e
->hash_link
);
234 call_rcu(&e
->rcu
, tun_flow_free
);
237 static void tun_flow_flush(struct tun_struct
*tun
)
241 spin_lock_bh(&tun
->lock
);
242 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
243 struct tun_flow_entry
*e
;
244 struct hlist_node
*h
, *n
;
246 hlist_for_each_entry_safe(e
, h
, n
, &tun
->flows
[i
], hash_link
)
247 tun_flow_delete(tun
, e
);
249 spin_unlock_bh(&tun
->lock
);
252 static void tun_flow_delete_by_queue(struct tun_struct
*tun
, u16 queue_index
)
256 spin_lock_bh(&tun
->lock
);
257 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
258 struct tun_flow_entry
*e
;
259 struct hlist_node
*h
, *n
;
261 hlist_for_each_entry_safe(e
, h
, n
, &tun
->flows
[i
], hash_link
) {
262 if (e
->queue_index
== queue_index
)
263 tun_flow_delete(tun
, e
);
266 spin_unlock_bh(&tun
->lock
);
269 static void tun_flow_cleanup(unsigned long data
)
271 struct tun_struct
*tun
= (struct tun_struct
*)data
;
272 unsigned long delay
= tun
->ageing_time
;
273 unsigned long next_timer
= jiffies
+ delay
;
274 unsigned long count
= 0;
277 tun_debug(KERN_INFO
, tun
, "tun_flow_cleanup\n");
279 spin_lock_bh(&tun
->lock
);
280 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++) {
281 struct tun_flow_entry
*e
;
282 struct hlist_node
*h
, *n
;
284 hlist_for_each_entry_safe(e
, h
, n
, &tun
->flows
[i
], hash_link
) {
285 unsigned long this_timer
;
287 this_timer
= e
->updated
+ delay
;
288 if (time_before_eq(this_timer
, jiffies
))
289 tun_flow_delete(tun
, e
);
290 else if (time_before(this_timer
, next_timer
))
291 next_timer
= this_timer
;
296 mod_timer(&tun
->flow_gc_timer
, round_jiffies_up(next_timer
));
297 spin_unlock_bh(&tun
->lock
);
300 static void tun_flow_update(struct tun_struct
*tun
, struct sk_buff
*skb
,
303 struct hlist_head
*head
;
304 struct tun_flow_entry
*e
;
305 unsigned long delay
= tun
->ageing_time
;
306 u32 rxhash
= skb_get_rxhash(skb
);
311 head
= &tun
->flows
[tun_hashfn(rxhash
)];
315 if (tun
->numqueues
== 1)
318 e
= tun_flow_find(head
, rxhash
);
320 /* TODO: keep queueing to old queue until it's empty? */
321 e
->queue_index
= queue_index
;
322 e
->updated
= jiffies
;
324 spin_lock_bh(&tun
->lock
);
325 if (!tun_flow_find(head
, rxhash
))
326 tun_flow_create(tun
, head
, rxhash
, queue_index
);
328 if (!timer_pending(&tun
->flow_gc_timer
))
329 mod_timer(&tun
->flow_gc_timer
,
330 round_jiffies_up(jiffies
+ delay
));
331 spin_unlock_bh(&tun
->lock
);
338 /* We try to identify a flow through its rxhash first. The reason that
339 * we do not check rxq no. is becuase some cards(e.g 82599), chooses
340 * the rxq based on the txq where the last packet of the flow comes. As
341 * the userspace application move between processors, we may get a
342 * different rxq no. here. If we could not get rxhash, then we would
343 * hope the rxq no. may help here.
345 static u16
tun_select_queue(struct net_device
*dev
, struct sk_buff
*skb
)
347 struct tun_struct
*tun
= netdev_priv(dev
);
348 struct tun_flow_entry
*e
;
353 numqueues
= tun
->numqueues
;
355 txq
= skb_get_rxhash(skb
);
357 e
= tun_flow_find(&tun
->flows
[tun_hashfn(txq
)], txq
);
359 txq
= e
->queue_index
;
361 /* use multiply and shift instead of expensive divide */
362 txq
= ((u64
)txq
* numqueues
) >> 32;
363 } else if (likely(skb_rx_queue_recorded(skb
))) {
364 txq
= skb_get_rx_queue(skb
);
365 while (unlikely(txq
>= numqueues
))
373 static inline bool tun_not_capable(struct tun_struct
*tun
)
375 const struct cred
*cred
= current_cred();
376 struct net
*net
= dev_net(tun
->dev
);
378 return ((uid_valid(tun
->owner
) && !uid_eq(cred
->euid
, tun
->owner
)) ||
379 (gid_valid(tun
->group
) && !in_egroup_p(tun
->group
))) &&
380 !ns_capable(net
->user_ns
, CAP_NET_ADMIN
);
383 static void tun_set_real_num_queues(struct tun_struct
*tun
)
385 netif_set_real_num_tx_queues(tun
->dev
, tun
->numqueues
);
386 netif_set_real_num_rx_queues(tun
->dev
, tun
->numqueues
);
389 static void __tun_detach(struct tun_file
*tfile
, bool clean
)
391 struct tun_file
*ntfile
;
392 struct tun_struct
*tun
;
393 struct net_device
*dev
;
395 tun
= rcu_dereference_protected(tfile
->tun
,
396 lockdep_rtnl_is_held());
398 u16 index
= tfile
->queue_index
;
399 BUG_ON(index
>= tun
->numqueues
);
402 rcu_assign_pointer(tun
->tfiles
[index
],
403 tun
->tfiles
[tun
->numqueues
- 1]);
404 rcu_assign_pointer(tfile
->tun
, NULL
);
405 ntfile
= rcu_dereference_protected(tun
->tfiles
[index
],
406 lockdep_rtnl_is_held());
407 ntfile
->queue_index
= index
;
410 sock_put(&tfile
->sk
);
413 tun_flow_delete_by_queue(tun
, tun
->numqueues
+ 1);
414 /* Drop read queue */
415 skb_queue_purge(&tfile
->sk
.sk_receive_queue
);
416 tun_set_real_num_queues(tun
);
418 if (tun
->numqueues
== 0 && !(tun
->flags
& TUN_PERSIST
))
419 if (dev
->reg_state
== NETREG_REGISTERED
)
420 unregister_netdevice(dev
);
424 BUG_ON(!test_bit(SOCK_EXTERNALLY_ALLOCATED
,
425 &tfile
->socket
.flags
));
426 sk_release_kernel(&tfile
->sk
);
430 static void tun_detach(struct tun_file
*tfile
, bool clean
)
433 __tun_detach(tfile
, clean
);
437 static void tun_detach_all(struct net_device
*dev
)
439 struct tun_struct
*tun
= netdev_priv(dev
);
440 struct tun_file
*tfile
;
441 int i
, n
= tun
->numqueues
;
443 for (i
= 0; i
< n
; i
++) {
444 tfile
= rcu_dereference_protected(tun
->tfiles
[i
],
445 lockdep_rtnl_is_held());
447 wake_up_all(&tfile
->wq
.wait
);
448 rcu_assign_pointer(tfile
->tun
, NULL
);
451 BUG_ON(tun
->numqueues
!= 0);
454 for (i
= 0; i
< n
; i
++) {
455 tfile
= rcu_dereference_protected(tun
->tfiles
[i
],
456 lockdep_rtnl_is_held());
457 /* Drop read queue */
458 skb_queue_purge(&tfile
->sk
.sk_receive_queue
);
459 sock_put(&tfile
->sk
);
463 static int tun_attach(struct tun_struct
*tun
, struct file
*file
)
465 struct tun_file
*tfile
= file
->private_data
;
469 if (rcu_dereference_protected(tfile
->tun
, lockdep_rtnl_is_held()))
473 if (!(tun
->flags
& TUN_TAP_MQ
) && tun
->numqueues
== 1)
477 if (tun
->numqueues
== MAX_TAP_QUEUES
)
482 /* Re-attach the filter to presist device */
483 if (tun
->filter_attached
== true) {
484 err
= sk_attach_filter(&tun
->fprog
, tfile
->socket
.sk
);
488 tfile
->queue_index
= tun
->numqueues
;
489 rcu_assign_pointer(tfile
->tun
, tun
);
490 rcu_assign_pointer(tun
->tfiles
[tun
->numqueues
], tfile
);
491 sock_hold(&tfile
->sk
);
494 tun_set_real_num_queues(tun
);
496 /* device is allowed to go away first, so no need to hold extra
504 static struct tun_struct
*__tun_get(struct tun_file
*tfile
)
506 struct tun_struct
*tun
;
509 tun
= rcu_dereference(tfile
->tun
);
517 static struct tun_struct
*tun_get(struct file
*file
)
519 return __tun_get(file
->private_data
);
522 static void tun_put(struct tun_struct
*tun
)
528 static void addr_hash_set(u32
*mask
, const u8
*addr
)
530 int n
= ether_crc(ETH_ALEN
, addr
) >> 26;
531 mask
[n
>> 5] |= (1 << (n
& 31));
534 static unsigned int addr_hash_test(const u32
*mask
, const u8
*addr
)
536 int n
= ether_crc(ETH_ALEN
, addr
) >> 26;
537 return mask
[n
>> 5] & (1 << (n
& 31));
540 static int update_filter(struct tap_filter
*filter
, void __user
*arg
)
542 struct { u8 u
[ETH_ALEN
]; } *addr
;
543 struct tun_filter uf
;
544 int err
, alen
, n
, nexact
;
546 if (copy_from_user(&uf
, arg
, sizeof(uf
)))
555 alen
= ETH_ALEN
* uf
.count
;
556 addr
= kmalloc(alen
, GFP_KERNEL
);
560 if (copy_from_user(addr
, arg
+ sizeof(uf
), alen
)) {
565 /* The filter is updated without holding any locks. Which is
566 * perfectly safe. We disable it first and in the worst
567 * case we'll accept a few undesired packets. */
571 /* Use first set of addresses as an exact filter */
572 for (n
= 0; n
< uf
.count
&& n
< FLT_EXACT_COUNT
; n
++)
573 memcpy(filter
->addr
[n
], addr
[n
].u
, ETH_ALEN
);
577 /* Remaining multicast addresses are hashed,
578 * unicast will leave the filter disabled. */
579 memset(filter
->mask
, 0, sizeof(filter
->mask
));
580 for (; n
< uf
.count
; n
++) {
581 if (!is_multicast_ether_addr(addr
[n
].u
)) {
582 err
= 0; /* no filter */
585 addr_hash_set(filter
->mask
, addr
[n
].u
);
588 /* For ALLMULTI just set the mask to all ones.
589 * This overrides the mask populated above. */
590 if ((uf
.flags
& TUN_FLT_ALLMULTI
))
591 memset(filter
->mask
, ~0, sizeof(filter
->mask
));
593 /* Now enable the filter */
595 filter
->count
= nexact
;
597 /* Return the number of exact filters */
605 /* Returns: 0 - drop, !=0 - accept */
606 static int run_filter(struct tap_filter
*filter
, const struct sk_buff
*skb
)
608 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
610 struct ethhdr
*eh
= (struct ethhdr
*) skb
->data
;
614 for (i
= 0; i
< filter
->count
; i
++)
615 if (ether_addr_equal(eh
->h_dest
, filter
->addr
[i
]))
618 /* Inexact match (multicast only) */
619 if (is_multicast_ether_addr(eh
->h_dest
))
620 return addr_hash_test(filter
->mask
, eh
->h_dest
);
626 * Checks whether the packet is accepted or not.
627 * Returns: 0 - drop, !=0 - accept
629 static int check_filter(struct tap_filter
*filter
, const struct sk_buff
*skb
)
634 return run_filter(filter
, skb
);
637 /* Network device part of the driver */
639 static const struct ethtool_ops tun_ethtool_ops
;
641 /* Net device detach from fd. */
642 static void tun_net_uninit(struct net_device
*dev
)
647 /* Net device open. */
648 static int tun_net_open(struct net_device
*dev
)
650 netif_tx_start_all_queues(dev
);
654 /* Net device close. */
655 static int tun_net_close(struct net_device
*dev
)
657 netif_tx_stop_all_queues(dev
);
661 /* Net device start xmit */
662 static netdev_tx_t
tun_net_xmit(struct sk_buff
*skb
, struct net_device
*dev
)
664 struct tun_struct
*tun
= netdev_priv(dev
);
665 int txq
= skb
->queue_mapping
;
666 struct tun_file
*tfile
;
669 tfile
= rcu_dereference(tun
->tfiles
[txq
]);
671 /* Drop packet if interface is not attached */
672 if (txq
>= tun
->numqueues
)
675 tun_debug(KERN_INFO
, tun
, "tun_net_xmit %d\n", skb
->len
);
679 /* Drop if the filter does not like it.
680 * This is a noop if the filter is disabled.
681 * Filter can be enabled only for the TAP devices. */
682 if (!check_filter(&tun
->txflt
, skb
))
685 if (tfile
->socket
.sk
->sk_filter
&&
686 sk_filter(tfile
->socket
.sk
, skb
))
689 /* Limit the number of packets queued by dividing txq length with the
692 if (skb_queue_len(&tfile
->socket
.sk
->sk_receive_queue
)
693 >= dev
->tx_queue_len
/ tun
->numqueues
){
694 if (!(tun
->flags
& TUN_ONE_QUEUE
)) {
695 /* Normal queueing mode. */
696 /* Packet scheduler handles dropping of further packets. */
697 netif_stop_subqueue(dev
, txq
);
699 /* We won't see all dropped packets individually, so overrun
700 * error is more appropriate. */
701 dev
->stats
.tx_fifo_errors
++;
703 /* Single queue mode.
704 * Driver handles dropping of all packets itself. */
709 /* Orphan the skb - required as we might hang on to it
710 * for indefinite time. */
711 if (unlikely(skb_orphan_frags(skb
, GFP_ATOMIC
)))
716 skb_queue_tail(&tfile
->socket
.sk
->sk_receive_queue
, skb
);
718 /* Notify and wake up reader process */
719 if (tfile
->flags
& TUN_FASYNC
)
720 kill_fasync(&tfile
->fasync
, SIGIO
, POLL_IN
);
721 wake_up_interruptible_poll(&tfile
->wq
.wait
, POLLIN
|
722 POLLRDNORM
| POLLRDBAND
);
728 dev
->stats
.tx_dropped
++;
735 static void tun_net_mclist(struct net_device
*dev
)
738 * This callback is supposed to deal with mc filter in
739 * _rx_ path and has nothing to do with the _tx_ path.
740 * In rx path we always accept everything userspace gives us.
745 #define MAX_MTU 65535
748 tun_net_change_mtu(struct net_device
*dev
, int new_mtu
)
750 if (new_mtu
< MIN_MTU
|| new_mtu
+ dev
->hard_header_len
> MAX_MTU
)
756 static netdev_features_t
tun_net_fix_features(struct net_device
*dev
,
757 netdev_features_t features
)
759 struct tun_struct
*tun
= netdev_priv(dev
);
761 return (features
& tun
->set_features
) | (features
& ~TUN_USER_FEATURES
);
763 #ifdef CONFIG_NET_POLL_CONTROLLER
764 static void tun_poll_controller(struct net_device
*dev
)
767 * Tun only receives frames when:
768 * 1) the char device endpoint gets data from user space
769 * 2) the tun socket gets a sendmsg call from user space
770 * Since both of those are syncronous operations, we are guaranteed
771 * never to have pending data when we poll for it
772 * so theres nothing to do here but return.
773 * We need this though so netpoll recognizes us as an interface that
774 * supports polling, which enables bridge devices in virt setups to
775 * still use netconsole
780 static const struct net_device_ops tun_netdev_ops
= {
781 .ndo_uninit
= tun_net_uninit
,
782 .ndo_open
= tun_net_open
,
783 .ndo_stop
= tun_net_close
,
784 .ndo_start_xmit
= tun_net_xmit
,
785 .ndo_change_mtu
= tun_net_change_mtu
,
786 .ndo_fix_features
= tun_net_fix_features
,
787 .ndo_select_queue
= tun_select_queue
,
788 #ifdef CONFIG_NET_POLL_CONTROLLER
789 .ndo_poll_controller
= tun_poll_controller
,
793 static const struct net_device_ops tap_netdev_ops
= {
794 .ndo_uninit
= tun_net_uninit
,
795 .ndo_open
= tun_net_open
,
796 .ndo_stop
= tun_net_close
,
797 .ndo_start_xmit
= tun_net_xmit
,
798 .ndo_change_mtu
= tun_net_change_mtu
,
799 .ndo_fix_features
= tun_net_fix_features
,
800 .ndo_set_rx_mode
= tun_net_mclist
,
801 .ndo_set_mac_address
= eth_mac_addr
,
802 .ndo_validate_addr
= eth_validate_addr
,
803 .ndo_select_queue
= tun_select_queue
,
804 #ifdef CONFIG_NET_POLL_CONTROLLER
805 .ndo_poll_controller
= tun_poll_controller
,
809 static int tun_flow_init(struct tun_struct
*tun
)
813 tun
->flow_cache
= kmem_cache_create("tun_flow_cache",
814 sizeof(struct tun_flow_entry
), 0, 0,
816 if (!tun
->flow_cache
)
819 for (i
= 0; i
< TUN_NUM_FLOW_ENTRIES
; i
++)
820 INIT_HLIST_HEAD(&tun
->flows
[i
]);
822 tun
->ageing_time
= TUN_FLOW_EXPIRE
;
823 setup_timer(&tun
->flow_gc_timer
, tun_flow_cleanup
, (unsigned long)tun
);
824 mod_timer(&tun
->flow_gc_timer
,
825 round_jiffies_up(jiffies
+ tun
->ageing_time
));
830 static void tun_flow_uninit(struct tun_struct
*tun
)
832 del_timer_sync(&tun
->flow_gc_timer
);
835 /* Wait for completion of call_rcu()'s */
837 kmem_cache_destroy(tun
->flow_cache
);
840 /* Initialize net device. */
841 static void tun_net_init(struct net_device
*dev
)
843 struct tun_struct
*tun
= netdev_priv(dev
);
845 switch (tun
->flags
& TUN_TYPE_MASK
) {
847 dev
->netdev_ops
= &tun_netdev_ops
;
849 /* Point-to-Point TUN Device */
850 dev
->hard_header_len
= 0;
854 /* Zero header length */
855 dev
->type
= ARPHRD_NONE
;
856 dev
->flags
= IFF_POINTOPOINT
| IFF_NOARP
| IFF_MULTICAST
;
857 dev
->tx_queue_len
= TUN_READQ_SIZE
; /* We prefer our own queue length */
861 dev
->netdev_ops
= &tap_netdev_ops
;
862 /* Ethernet TAP Device */
864 dev
->priv_flags
&= ~IFF_TX_SKB_SHARING
;
866 eth_hw_addr_random(dev
);
868 dev
->tx_queue_len
= TUN_READQ_SIZE
; /* We prefer our own queue length */
873 /* Character device part */
876 static unsigned int tun_chr_poll(struct file
*file
, poll_table
*wait
)
878 struct tun_file
*tfile
= file
->private_data
;
879 struct tun_struct
*tun
= __tun_get(tfile
);
881 unsigned int mask
= 0;
886 sk
= tfile
->socket
.sk
;
888 tun_debug(KERN_INFO
, tun
, "tun_chr_poll\n");
890 poll_wait(file
, &tfile
->wq
.wait
, wait
);
892 if (!skb_queue_empty(&sk
->sk_receive_queue
))
893 mask
|= POLLIN
| POLLRDNORM
;
895 if (sock_writeable(sk
) ||
896 (!test_and_set_bit(SOCK_ASYNC_NOSPACE
, &sk
->sk_socket
->flags
) &&
898 mask
|= POLLOUT
| POLLWRNORM
;
900 if (tun
->dev
->reg_state
!= NETREG_REGISTERED
)
907 /* prepad is the amount to reserve at front. len is length after that.
908 * linear is a hint as to how much to copy (usually headers). */
909 static struct sk_buff
*tun_alloc_skb(struct tun_file
*tfile
,
910 size_t prepad
, size_t len
,
911 size_t linear
, int noblock
)
913 struct sock
*sk
= tfile
->socket
.sk
;
917 /* Under a page? Don't bother with paged skb. */
918 if (prepad
+ len
< PAGE_SIZE
|| !linear
)
921 skb
= sock_alloc_send_pskb(sk
, prepad
+ linear
, len
- linear
, noblock
,
926 skb_reserve(skb
, prepad
);
927 skb_put(skb
, linear
);
928 skb
->data_len
= len
- linear
;
929 skb
->len
+= len
- linear
;
934 /* set skb frags from iovec, this can move to core network code for reuse */
935 static int zerocopy_sg_from_iovec(struct sk_buff
*skb
, const struct iovec
*from
,
936 int offset
, size_t count
)
938 int len
= iov_length(from
, count
) - offset
;
939 int copy
= skb_headlen(skb
);
940 int size
, offset1
= 0;
943 /* Skip over from offset */
944 while (count
&& (offset
>= from
->iov_len
)) {
945 offset
-= from
->iov_len
;
950 /* copy up to skb headlen */
951 while (count
&& (copy
> 0)) {
952 size
= min_t(unsigned int, copy
, from
->iov_len
- offset
);
953 if (copy_from_user(skb
->data
+ offset1
, from
->iov_base
+ offset
,
970 struct page
*page
[MAX_SKB_FRAGS
];
973 unsigned long truesize
;
975 len
= from
->iov_len
- offset
;
981 base
= (unsigned long)from
->iov_base
+ offset
;
982 size
= ((base
& ~PAGE_MASK
) + len
+ ~PAGE_MASK
) >> PAGE_SHIFT
;
983 if (i
+ size
> MAX_SKB_FRAGS
)
985 num_pages
= get_user_pages_fast(base
, size
, 0, &page
[i
]);
986 if (num_pages
!= size
) {
987 for (i
= 0; i
< num_pages
; i
++)
991 truesize
= size
* PAGE_SIZE
;
992 skb
->data_len
+= len
;
994 skb
->truesize
+= truesize
;
995 atomic_add(truesize
, &skb
->sk
->sk_wmem_alloc
);
997 int off
= base
& ~PAGE_MASK
;
998 int size
= min_t(int, len
, PAGE_SIZE
- off
);
999 __skb_fill_page_desc(skb
, i
, page
[i
], off
, size
);
1000 skb_shinfo(skb
)->nr_frags
++;
1001 /* increase sk_wmem_alloc */
1012 /* Get packet from user space buffer */
1013 static ssize_t
tun_get_user(struct tun_struct
*tun
, struct tun_file
*tfile
,
1014 void *msg_control
, const struct iovec
*iv
,
1015 size_t total_len
, size_t count
, int noblock
)
1017 struct tun_pi pi
= { 0, cpu_to_be16(ETH_P_IP
) };
1018 struct sk_buff
*skb
;
1019 size_t len
= total_len
, align
= NET_SKB_PAD
;
1020 struct virtio_net_hdr gso
= { 0 };
1023 bool zerocopy
= false;
1026 if (!(tun
->flags
& TUN_NO_PI
)) {
1027 if ((len
-= sizeof(pi
)) > total_len
)
1030 if (memcpy_fromiovecend((void *)&pi
, iv
, 0, sizeof(pi
)))
1032 offset
+= sizeof(pi
);
1035 if (tun
->flags
& TUN_VNET_HDR
) {
1036 if ((len
-= tun
->vnet_hdr_sz
) > total_len
)
1039 if (memcpy_fromiovecend((void *)&gso
, iv
, offset
, sizeof(gso
)))
1042 if ((gso
.flags
& VIRTIO_NET_HDR_F_NEEDS_CSUM
) &&
1043 gso
.csum_start
+ gso
.csum_offset
+ 2 > gso
.hdr_len
)
1044 gso
.hdr_len
= gso
.csum_start
+ gso
.csum_offset
+ 2;
1046 if (gso
.hdr_len
> len
)
1048 offset
+= tun
->vnet_hdr_sz
;
1051 if ((tun
->flags
& TUN_TYPE_MASK
) == TUN_TAP_DEV
) {
1052 align
+= NET_IP_ALIGN
;
1053 if (unlikely(len
< ETH_HLEN
||
1054 (gso
.hdr_len
&& gso
.hdr_len
< ETH_HLEN
)))
1062 /* Userspace may produce vectors with count greater than
1063 * MAX_SKB_FRAGS, so we need to linearize parts of the skb
1064 * to let the rest of data to be fit in the frags.
1066 if (count
> MAX_SKB_FRAGS
) {
1067 copylen
= iov_length(iv
, count
- MAX_SKB_FRAGS
);
1068 if (copylen
< offset
)
1074 /* There are 256 bytes to be copied in skb, so there is enough
1075 * room for skb expand head in case it is used.
1076 * The rest of the buffer is mapped from userspace.
1078 if (copylen
< gso
.hdr_len
)
1079 copylen
= gso
.hdr_len
;
1081 copylen
= GOODCOPY_LEN
;
1085 skb
= tun_alloc_skb(tfile
, align
, copylen
, gso
.hdr_len
, noblock
);
1087 if (PTR_ERR(skb
) != -EAGAIN
)
1088 tun
->dev
->stats
.rx_dropped
++;
1089 return PTR_ERR(skb
);
1093 err
= zerocopy_sg_from_iovec(skb
, iv
, offset
, count
);
1095 err
= skb_copy_datagram_from_iovec(skb
, 0, iv
, offset
, len
);
1098 tun
->dev
->stats
.rx_dropped
++;
1103 if (gso
.flags
& VIRTIO_NET_HDR_F_NEEDS_CSUM
) {
1104 if (!skb_partial_csum_set(skb
, gso
.csum_start
,
1106 tun
->dev
->stats
.rx_frame_errors
++;
1112 switch (tun
->flags
& TUN_TYPE_MASK
) {
1114 if (tun
->flags
& TUN_NO_PI
) {
1115 switch (skb
->data
[0] & 0xf0) {
1117 pi
.proto
= htons(ETH_P_IP
);
1120 pi
.proto
= htons(ETH_P_IPV6
);
1123 tun
->dev
->stats
.rx_dropped
++;
1129 skb_reset_mac_header(skb
);
1130 skb
->protocol
= pi
.proto
;
1131 skb
->dev
= tun
->dev
;
1134 skb
->protocol
= eth_type_trans(skb
, tun
->dev
);
1138 if (gso
.gso_type
!= VIRTIO_NET_HDR_GSO_NONE
) {
1140 switch (gso
.gso_type
& ~VIRTIO_NET_HDR_GSO_ECN
) {
1141 case VIRTIO_NET_HDR_GSO_TCPV4
:
1142 skb_shinfo(skb
)->gso_type
= SKB_GSO_TCPV4
;
1144 case VIRTIO_NET_HDR_GSO_TCPV6
:
1145 skb_shinfo(skb
)->gso_type
= SKB_GSO_TCPV6
;
1147 case VIRTIO_NET_HDR_GSO_UDP
:
1148 skb_shinfo(skb
)->gso_type
= SKB_GSO_UDP
;
1151 tun
->dev
->stats
.rx_frame_errors
++;
1156 if (gso
.gso_type
& VIRTIO_NET_HDR_GSO_ECN
)
1157 skb_shinfo(skb
)->gso_type
|= SKB_GSO_TCP_ECN
;
1159 skb_shinfo(skb
)->gso_size
= gso
.gso_size
;
1160 if (skb_shinfo(skb
)->gso_size
== 0) {
1161 tun
->dev
->stats
.rx_frame_errors
++;
1166 /* Header must be checked, and gso_segs computed. */
1167 skb_shinfo(skb
)->gso_type
|= SKB_GSO_DODGY
;
1168 skb_shinfo(skb
)->gso_segs
= 0;
1171 /* copy skb_ubuf_info for callback when skb has no error */
1173 skb_shinfo(skb
)->destructor_arg
= msg_control
;
1174 skb_shinfo(skb
)->tx_flags
|= SKBTX_DEV_ZEROCOPY
;
1179 tun
->dev
->stats
.rx_packets
++;
1180 tun
->dev
->stats
.rx_bytes
+= len
;
1182 tun_flow_update(tun
, skb
, tfile
->queue_index
);
1186 static ssize_t
tun_chr_aio_write(struct kiocb
*iocb
, const struct iovec
*iv
,
1187 unsigned long count
, loff_t pos
)
1189 struct file
*file
= iocb
->ki_filp
;
1190 struct tun_struct
*tun
= tun_get(file
);
1191 struct tun_file
*tfile
= file
->private_data
;
1197 tun_debug(KERN_INFO
, tun
, "tun_chr_write %ld\n", count
);
1199 result
= tun_get_user(tun
, tfile
, NULL
, iv
, iov_length(iv
, count
),
1200 count
, file
->f_flags
& O_NONBLOCK
);
1206 /* Put packet to the user space buffer */
1207 static ssize_t
tun_put_user(struct tun_struct
*tun
,
1208 struct tun_file
*tfile
,
1209 struct sk_buff
*skb
,
1210 const struct iovec
*iv
, int len
)
1212 struct tun_pi pi
= { 0, skb
->protocol
};
1215 if (!(tun
->flags
& TUN_NO_PI
)) {
1216 if ((len
-= sizeof(pi
)) < 0)
1219 if (len
< skb
->len
) {
1220 /* Packet will be striped */
1221 pi
.flags
|= TUN_PKT_STRIP
;
1224 if (memcpy_toiovecend(iv
, (void *) &pi
, 0, sizeof(pi
)))
1226 total
+= sizeof(pi
);
1229 if (tun
->flags
& TUN_VNET_HDR
) {
1230 struct virtio_net_hdr gso
= { 0 }; /* no info leak */
1231 if ((len
-= tun
->vnet_hdr_sz
) < 0)
1234 if (skb_is_gso(skb
)) {
1235 struct skb_shared_info
*sinfo
= skb_shinfo(skb
);
1237 /* This is a hint as to how much should be linear. */
1238 gso
.hdr_len
= skb_headlen(skb
);
1239 gso
.gso_size
= sinfo
->gso_size
;
1240 if (sinfo
->gso_type
& SKB_GSO_TCPV4
)
1241 gso
.gso_type
= VIRTIO_NET_HDR_GSO_TCPV4
;
1242 else if (sinfo
->gso_type
& SKB_GSO_TCPV6
)
1243 gso
.gso_type
= VIRTIO_NET_HDR_GSO_TCPV6
;
1244 else if (sinfo
->gso_type
& SKB_GSO_UDP
)
1245 gso
.gso_type
= VIRTIO_NET_HDR_GSO_UDP
;
1247 pr_err("unexpected GSO type: "
1248 "0x%x, gso_size %d, hdr_len %d\n",
1249 sinfo
->gso_type
, gso
.gso_size
,
1251 print_hex_dump(KERN_ERR
, "tun: ",
1254 min((int)gso
.hdr_len
, 64), true);
1258 if (sinfo
->gso_type
& SKB_GSO_TCP_ECN
)
1259 gso
.gso_type
|= VIRTIO_NET_HDR_GSO_ECN
;
1261 gso
.gso_type
= VIRTIO_NET_HDR_GSO_NONE
;
1263 if (skb
->ip_summed
== CHECKSUM_PARTIAL
) {
1264 gso
.flags
= VIRTIO_NET_HDR_F_NEEDS_CSUM
;
1265 gso
.csum_start
= skb_checksum_start_offset(skb
);
1266 gso
.csum_offset
= skb
->csum_offset
;
1267 } else if (skb
->ip_summed
== CHECKSUM_UNNECESSARY
) {
1268 gso
.flags
= VIRTIO_NET_HDR_F_DATA_VALID
;
1269 } /* else everything is zero */
1271 if (unlikely(memcpy_toiovecend(iv
, (void *)&gso
, total
,
1274 total
+= tun
->vnet_hdr_sz
;
1277 len
= min_t(int, skb
->len
, len
);
1279 skb_copy_datagram_const_iovec(skb
, 0, iv
, total
, len
);
1282 tun
->dev
->stats
.tx_packets
++;
1283 tun
->dev
->stats
.tx_bytes
+= len
;
1288 static ssize_t
tun_do_read(struct tun_struct
*tun
, struct tun_file
*tfile
,
1289 struct kiocb
*iocb
, const struct iovec
*iv
,
1290 ssize_t len
, int noblock
)
1292 DECLARE_WAITQUEUE(wait
, current
);
1293 struct sk_buff
*skb
;
1296 tun_debug(KERN_INFO
, tun
, "tun_do_read\n");
1298 if (unlikely(!noblock
))
1299 add_wait_queue(&tfile
->wq
.wait
, &wait
);
1301 current
->state
= TASK_INTERRUPTIBLE
;
1303 /* Read frames from the queue */
1304 if (!(skb
= skb_dequeue(&tfile
->socket
.sk
->sk_receive_queue
))) {
1309 if (signal_pending(current
)) {
1313 if (tun
->dev
->reg_state
!= NETREG_REGISTERED
) {
1318 /* Nothing to read, let's sleep */
1322 netif_wake_subqueue(tun
->dev
, tfile
->queue_index
);
1324 ret
= tun_put_user(tun
, tfile
, skb
, iv
, len
);
1329 current
->state
= TASK_RUNNING
;
1330 if (unlikely(!noblock
))
1331 remove_wait_queue(&tfile
->wq
.wait
, &wait
);
1336 static ssize_t
tun_chr_aio_read(struct kiocb
*iocb
, const struct iovec
*iv
,
1337 unsigned long count
, loff_t pos
)
1339 struct file
*file
= iocb
->ki_filp
;
1340 struct tun_file
*tfile
= file
->private_data
;
1341 struct tun_struct
*tun
= __tun_get(tfile
);
1346 len
= iov_length(iv
, count
);
1352 ret
= tun_do_read(tun
, tfile
, iocb
, iv
, len
,
1353 file
->f_flags
& O_NONBLOCK
);
1354 ret
= min_t(ssize_t
, ret
, len
);
1360 static void tun_free_netdev(struct net_device
*dev
)
1362 struct tun_struct
*tun
= netdev_priv(dev
);
1364 tun_flow_uninit(tun
);
1368 static void tun_setup(struct net_device
*dev
)
1370 struct tun_struct
*tun
= netdev_priv(dev
);
1372 tun
->owner
= INVALID_UID
;
1373 tun
->group
= INVALID_GID
;
1375 dev
->ethtool_ops
= &tun_ethtool_ops
;
1376 dev
->destructor
= tun_free_netdev
;
1379 /* Trivial set of netlink ops to allow deleting tun or tap
1380 * device with netlink.
1382 static int tun_validate(struct nlattr
*tb
[], struct nlattr
*data
[])
1387 static struct rtnl_link_ops tun_link_ops __read_mostly
= {
1389 .priv_size
= sizeof(struct tun_struct
),
1391 .validate
= tun_validate
,
1394 static void tun_sock_write_space(struct sock
*sk
)
1396 struct tun_file
*tfile
;
1397 wait_queue_head_t
*wqueue
;
1399 if (!sock_writeable(sk
))
1402 if (!test_and_clear_bit(SOCK_ASYNC_NOSPACE
, &sk
->sk_socket
->flags
))
1405 wqueue
= sk_sleep(sk
);
1406 if (wqueue
&& waitqueue_active(wqueue
))
1407 wake_up_interruptible_sync_poll(wqueue
, POLLOUT
|
1408 POLLWRNORM
| POLLWRBAND
);
1410 tfile
= container_of(sk
, struct tun_file
, sk
);
1411 kill_fasync(&tfile
->fasync
, SIGIO
, POLL_OUT
);
1414 static int tun_sendmsg(struct kiocb
*iocb
, struct socket
*sock
,
1415 struct msghdr
*m
, size_t total_len
)
1418 struct tun_file
*tfile
= container_of(sock
, struct tun_file
, socket
);
1419 struct tun_struct
*tun
= __tun_get(tfile
);
1423 ret
= tun_get_user(tun
, tfile
, m
->msg_control
, m
->msg_iov
, total_len
,
1424 m
->msg_iovlen
, m
->msg_flags
& MSG_DONTWAIT
);
1430 static int tun_recvmsg(struct kiocb
*iocb
, struct socket
*sock
,
1431 struct msghdr
*m
, size_t total_len
,
1434 struct tun_file
*tfile
= container_of(sock
, struct tun_file
, socket
);
1435 struct tun_struct
*tun
= __tun_get(tfile
);
1441 if (flags
& ~(MSG_DONTWAIT
|MSG_TRUNC
))
1443 ret
= tun_do_read(tun
, tfile
, iocb
, m
->msg_iov
, total_len
,
1444 flags
& MSG_DONTWAIT
);
1445 if (ret
> total_len
) {
1446 m
->msg_flags
|= MSG_TRUNC
;
1447 ret
= flags
& MSG_TRUNC
? ret
: total_len
;
1453 static int tun_release(struct socket
*sock
)
1460 /* Ops structure to mimic raw sockets with tun */
1461 static const struct proto_ops tun_socket_ops
= {
1462 .sendmsg
= tun_sendmsg
,
1463 .recvmsg
= tun_recvmsg
,
1464 .release
= tun_release
,
1467 static struct proto tun_proto
= {
1469 .owner
= THIS_MODULE
,
1470 .obj_size
= sizeof(struct tun_file
),
1473 static int tun_flags(struct tun_struct
*tun
)
1477 if (tun
->flags
& TUN_TUN_DEV
)
1482 if (tun
->flags
& TUN_NO_PI
)
1485 if (tun
->flags
& TUN_ONE_QUEUE
)
1486 flags
|= IFF_ONE_QUEUE
;
1488 if (tun
->flags
& TUN_VNET_HDR
)
1489 flags
|= IFF_VNET_HDR
;
1491 if (tun
->flags
& TUN_TAP_MQ
)
1492 flags
|= IFF_MULTI_QUEUE
;
1497 static ssize_t
tun_show_flags(struct device
*dev
, struct device_attribute
*attr
,
1500 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
1501 return sprintf(buf
, "0x%x\n", tun_flags(tun
));
1504 static ssize_t
tun_show_owner(struct device
*dev
, struct device_attribute
*attr
,
1507 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
1508 return uid_valid(tun
->owner
)?
1509 sprintf(buf
, "%u\n",
1510 from_kuid_munged(current_user_ns(), tun
->owner
)):
1511 sprintf(buf
, "-1\n");
1514 static ssize_t
tun_show_group(struct device
*dev
, struct device_attribute
*attr
,
1517 struct tun_struct
*tun
= netdev_priv(to_net_dev(dev
));
1518 return gid_valid(tun
->group
) ?
1519 sprintf(buf
, "%u\n",
1520 from_kgid_munged(current_user_ns(), tun
->group
)):
1521 sprintf(buf
, "-1\n");
1524 static DEVICE_ATTR(tun_flags
, 0444, tun_show_flags
, NULL
);
1525 static DEVICE_ATTR(owner
, 0444, tun_show_owner
, NULL
);
1526 static DEVICE_ATTR(group
, 0444, tun_show_group
, NULL
);
1528 static int tun_set_iff(struct net
*net
, struct file
*file
, struct ifreq
*ifr
)
1530 struct tun_struct
*tun
;
1531 struct tun_file
*tfile
= file
->private_data
;
1532 struct net_device
*dev
;
1535 dev
= __dev_get_by_name(net
, ifr
->ifr_name
);
1537 if (ifr
->ifr_flags
& IFF_TUN_EXCL
)
1539 if ((ifr
->ifr_flags
& IFF_TUN
) && dev
->netdev_ops
== &tun_netdev_ops
)
1540 tun
= netdev_priv(dev
);
1541 else if ((ifr
->ifr_flags
& IFF_TAP
) && dev
->netdev_ops
== &tap_netdev_ops
)
1542 tun
= netdev_priv(dev
);
1546 if (tun_not_capable(tun
))
1548 err
= security_tun_dev_attach(tfile
->socket
.sk
);
1552 err
= tun_attach(tun
, file
);
1558 unsigned long flags
= 0;
1560 if (!ns_capable(net
->user_ns
, CAP_NET_ADMIN
))
1562 err
= security_tun_dev_create();
1567 if (ifr
->ifr_flags
& IFF_TUN
) {
1569 flags
|= TUN_TUN_DEV
;
1571 } else if (ifr
->ifr_flags
& IFF_TAP
) {
1573 flags
|= TUN_TAP_DEV
;
1579 name
= ifr
->ifr_name
;
1581 dev
= alloc_netdev_mqs(sizeof(struct tun_struct
), name
,
1583 MAX_TAP_QUEUES
, MAX_TAP_QUEUES
);
1587 dev_net_set(dev
, net
);
1588 dev
->rtnl_link_ops
= &tun_link_ops
;
1590 tun
= netdev_priv(dev
);
1593 tun
->txflt
.count
= 0;
1594 tun
->vnet_hdr_sz
= sizeof(struct virtio_net_hdr
);
1596 tun
->filter_attached
= false;
1597 tun
->sndbuf
= tfile
->socket
.sk
->sk_sndbuf
;
1599 spin_lock_init(&tun
->lock
);
1601 security_tun_dev_post_create(&tfile
->sk
);
1605 if (tun_flow_init(tun
))
1608 dev
->hw_features
= NETIF_F_SG
| NETIF_F_FRAGLIST
|
1610 dev
->features
= dev
->hw_features
;
1612 err
= tun_attach(tun
, file
);
1616 err
= register_netdevice(tun
->dev
);
1620 if (device_create_file(&tun
->dev
->dev
, &dev_attr_tun_flags
) ||
1621 device_create_file(&tun
->dev
->dev
, &dev_attr_owner
) ||
1622 device_create_file(&tun
->dev
->dev
, &dev_attr_group
))
1623 pr_err("Failed to create tun sysfs files\n");
1625 netif_carrier_on(tun
->dev
);
1628 tun_debug(KERN_INFO
, tun
, "tun_set_iff\n");
1630 if (ifr
->ifr_flags
& IFF_NO_PI
)
1631 tun
->flags
|= TUN_NO_PI
;
1633 tun
->flags
&= ~TUN_NO_PI
;
1635 if (ifr
->ifr_flags
& IFF_ONE_QUEUE
)
1636 tun
->flags
|= TUN_ONE_QUEUE
;
1638 tun
->flags
&= ~TUN_ONE_QUEUE
;
1640 if (ifr
->ifr_flags
& IFF_VNET_HDR
)
1641 tun
->flags
|= TUN_VNET_HDR
;
1643 tun
->flags
&= ~TUN_VNET_HDR
;
1645 if (ifr
->ifr_flags
& IFF_MULTI_QUEUE
)
1646 tun
->flags
|= TUN_TAP_MQ
;
1648 tun
->flags
&= ~TUN_TAP_MQ
;
1650 /* Make sure persistent devices do not get stuck in
1653 if (netif_running(tun
->dev
))
1654 netif_tx_wake_all_queues(tun
->dev
);
1656 strcpy(ifr
->ifr_name
, tun
->dev
->name
);
1664 static void tun_get_iff(struct net
*net
, struct tun_struct
*tun
,
1667 tun_debug(KERN_INFO
, tun
, "tun_get_iff\n");
1669 strcpy(ifr
->ifr_name
, tun
->dev
->name
);
1671 ifr
->ifr_flags
= tun_flags(tun
);
1675 /* This is like a cut-down ethtool ops, except done via tun fd so no
1676 * privs required. */
1677 static int set_offload(struct tun_struct
*tun
, unsigned long arg
)
1679 netdev_features_t features
= 0;
1681 if (arg
& TUN_F_CSUM
) {
1682 features
|= NETIF_F_HW_CSUM
;
1685 if (arg
& (TUN_F_TSO4
|TUN_F_TSO6
)) {
1686 if (arg
& TUN_F_TSO_ECN
) {
1687 features
|= NETIF_F_TSO_ECN
;
1688 arg
&= ~TUN_F_TSO_ECN
;
1690 if (arg
& TUN_F_TSO4
)
1691 features
|= NETIF_F_TSO
;
1692 if (arg
& TUN_F_TSO6
)
1693 features
|= NETIF_F_TSO6
;
1694 arg
&= ~(TUN_F_TSO4
|TUN_F_TSO6
);
1697 if (arg
& TUN_F_UFO
) {
1698 features
|= NETIF_F_UFO
;
1703 /* This gives the user a way to test for new features in future by
1704 * trying to set them. */
1708 tun
->set_features
= features
;
1709 netdev_update_features(tun
->dev
);
1714 static void tun_detach_filter(struct tun_struct
*tun
, int n
)
1717 struct tun_file
*tfile
;
1719 for (i
= 0; i
< n
; i
++) {
1720 tfile
= rcu_dereference_protected(tun
->tfiles
[i
],
1721 lockdep_rtnl_is_held());
1722 sk_detach_filter(tfile
->socket
.sk
);
1725 tun
->filter_attached
= false;
1728 static int tun_attach_filter(struct tun_struct
*tun
)
1731 struct tun_file
*tfile
;
1733 for (i
= 0; i
< tun
->numqueues
; i
++) {
1734 tfile
= rcu_dereference_protected(tun
->tfiles
[i
],
1735 lockdep_rtnl_is_held());
1736 ret
= sk_attach_filter(&tun
->fprog
, tfile
->socket
.sk
);
1738 tun_detach_filter(tun
, i
);
1743 tun
->filter_attached
= true;
1747 static void tun_set_sndbuf(struct tun_struct
*tun
)
1749 struct tun_file
*tfile
;
1752 for (i
= 0; i
< tun
->numqueues
; i
++) {
1753 tfile
= rcu_dereference_protected(tun
->tfiles
[i
],
1754 lockdep_rtnl_is_held());
1755 tfile
->socket
.sk
->sk_sndbuf
= tun
->sndbuf
;
1759 static int tun_set_queue(struct file
*file
, struct ifreq
*ifr
)
1761 struct tun_file
*tfile
= file
->private_data
;
1762 struct tun_struct
*tun
;
1763 struct net_device
*dev
;
1768 if (ifr
->ifr_flags
& IFF_ATTACH_QUEUE
) {
1769 dev
= __dev_get_by_name(tfile
->net
, ifr
->ifr_name
);
1775 tun
= netdev_priv(dev
);
1776 if (dev
->netdev_ops
!= &tap_netdev_ops
&&
1777 dev
->netdev_ops
!= &tun_netdev_ops
)
1779 else if (tun_not_capable(tun
))
1782 ret
= tun_attach(tun
, file
);
1783 } else if (ifr
->ifr_flags
& IFF_DETACH_QUEUE
)
1784 __tun_detach(tfile
, false);
1793 static long __tun_chr_ioctl(struct file
*file
, unsigned int cmd
,
1794 unsigned long arg
, int ifreq_len
)
1796 struct tun_file
*tfile
= file
->private_data
;
1797 struct tun_struct
*tun
;
1798 void __user
* argp
= (void __user
*)arg
;
1806 if (cmd
== TUNSETIFF
|| cmd
== TUNSETQUEUE
|| _IOC_TYPE(cmd
) == 0x89) {
1807 if (copy_from_user(&ifr
, argp
, ifreq_len
))
1810 memset(&ifr
, 0, sizeof(ifr
));
1812 if (cmd
== TUNGETFEATURES
) {
1813 /* Currently this just means: "what IFF flags are valid?".
1814 * This is needed because we never checked for invalid flags on
1816 return put_user(IFF_TUN
| IFF_TAP
| IFF_NO_PI
| IFF_ONE_QUEUE
|
1817 IFF_VNET_HDR
| IFF_MULTI_QUEUE
,
1818 (unsigned int __user
*)argp
);
1819 } else if (cmd
== TUNSETQUEUE
)
1820 return tun_set_queue(file
, &ifr
);
1825 tun
= __tun_get(tfile
);
1826 if (cmd
== TUNSETIFF
&& !tun
) {
1827 ifr
.ifr_name
[IFNAMSIZ
-1] = '\0';
1829 ret
= tun_set_iff(tfile
->net
, file
, &ifr
);
1834 if (copy_to_user(argp
, &ifr
, ifreq_len
))
1843 tun_debug(KERN_INFO
, tun
, "tun_chr_ioctl cmd %u\n", cmd
);
1848 tun_get_iff(current
->nsproxy
->net_ns
, tun
, &ifr
);
1850 if (copy_to_user(argp
, &ifr
, ifreq_len
))
1855 /* Disable/Enable checksum */
1857 /* [unimplemented] */
1858 tun_debug(KERN_INFO
, tun
, "ignored: set checksum %s\n",
1859 arg
? "disabled" : "enabled");
1863 /* Disable/Enable persist mode. Keep an extra reference to the
1864 * module to prevent the module being unprobed.
1867 tun
->flags
|= TUN_PERSIST
;
1868 __module_get(THIS_MODULE
);
1870 tun
->flags
&= ~TUN_PERSIST
;
1871 module_put(THIS_MODULE
);
1874 tun_debug(KERN_INFO
, tun
, "persist %s\n",
1875 arg
? "enabled" : "disabled");
1879 /* Set owner of the device */
1880 owner
= make_kuid(current_user_ns(), arg
);
1881 if (!uid_valid(owner
)) {
1886 tun_debug(KERN_INFO
, tun
, "owner set to %u\n",
1887 from_kuid(&init_user_ns
, tun
->owner
));
1891 /* Set group of the device */
1892 group
= make_kgid(current_user_ns(), arg
);
1893 if (!gid_valid(group
)) {
1898 tun_debug(KERN_INFO
, tun
, "group set to %u\n",
1899 from_kgid(&init_user_ns
, tun
->group
));
1903 /* Only allow setting the type when the interface is down */
1904 if (tun
->dev
->flags
& IFF_UP
) {
1905 tun_debug(KERN_INFO
, tun
,
1906 "Linktype set failed because interface is up\n");
1909 tun
->dev
->type
= (int) arg
;
1910 tun_debug(KERN_INFO
, tun
, "linktype set to %d\n",
1922 ret
= set_offload(tun
, arg
);
1925 case TUNSETTXFILTER
:
1926 /* Can be set only for TAPs */
1928 if ((tun
->flags
& TUN_TYPE_MASK
) != TUN_TAP_DEV
)
1930 ret
= update_filter(&tun
->txflt
, (void __user
*)arg
);
1934 /* Get hw address */
1935 memcpy(ifr
.ifr_hwaddr
.sa_data
, tun
->dev
->dev_addr
, ETH_ALEN
);
1936 ifr
.ifr_hwaddr
.sa_family
= tun
->dev
->type
;
1937 if (copy_to_user(argp
, &ifr
, ifreq_len
))
1942 /* Set hw address */
1943 tun_debug(KERN_DEBUG
, tun
, "set hw address: %pM\n",
1944 ifr
.ifr_hwaddr
.sa_data
);
1946 ret
= dev_set_mac_address(tun
->dev
, &ifr
.ifr_hwaddr
);
1950 sndbuf
= tfile
->socket
.sk
->sk_sndbuf
;
1951 if (copy_to_user(argp
, &sndbuf
, sizeof(sndbuf
)))
1956 if (copy_from_user(&sndbuf
, argp
, sizeof(sndbuf
))) {
1961 tun
->sndbuf
= sndbuf
;
1962 tun_set_sndbuf(tun
);
1965 case TUNGETVNETHDRSZ
:
1966 vnet_hdr_sz
= tun
->vnet_hdr_sz
;
1967 if (copy_to_user(argp
, &vnet_hdr_sz
, sizeof(vnet_hdr_sz
)))
1971 case TUNSETVNETHDRSZ
:
1972 if (copy_from_user(&vnet_hdr_sz
, argp
, sizeof(vnet_hdr_sz
))) {
1976 if (vnet_hdr_sz
< (int)sizeof(struct virtio_net_hdr
)) {
1981 tun
->vnet_hdr_sz
= vnet_hdr_sz
;
1984 case TUNATTACHFILTER
:
1985 /* Can be set only for TAPs */
1987 if ((tun
->flags
& TUN_TYPE_MASK
) != TUN_TAP_DEV
)
1990 if (copy_from_user(&tun
->fprog
, argp
, sizeof(tun
->fprog
)))
1993 ret
= tun_attach_filter(tun
);
1996 case TUNDETACHFILTER
:
1997 /* Can be set only for TAPs */
1999 if ((tun
->flags
& TUN_TYPE_MASK
) != TUN_TAP_DEV
)
2002 tun_detach_filter(tun
, tun
->numqueues
);
2017 static long tun_chr_ioctl(struct file
*file
,
2018 unsigned int cmd
, unsigned long arg
)
2020 return __tun_chr_ioctl(file
, cmd
, arg
, sizeof (struct ifreq
));
2023 #ifdef CONFIG_COMPAT
2024 static long tun_chr_compat_ioctl(struct file
*file
,
2025 unsigned int cmd
, unsigned long arg
)
2030 case TUNSETTXFILTER
:
2035 arg
= (unsigned long)compat_ptr(arg
);
2038 arg
= (compat_ulong_t
)arg
;
2043 * compat_ifreq is shorter than ifreq, so we must not access beyond
2044 * the end of that structure. All fields that are used in this
2045 * driver are compatible though, we don't need to convert the
2048 return __tun_chr_ioctl(file
, cmd
, arg
, sizeof(struct compat_ifreq
));
2050 #endif /* CONFIG_COMPAT */
2052 static int tun_chr_fasync(int fd
, struct file
*file
, int on
)
2054 struct tun_file
*tfile
= file
->private_data
;
2057 if ((ret
= fasync_helper(fd
, file
, on
, &tfile
->fasync
)) < 0)
2061 ret
= __f_setown(file
, task_pid(current
), PIDTYPE_PID
, 0);
2064 tfile
->flags
|= TUN_FASYNC
;
2066 tfile
->flags
&= ~TUN_FASYNC
;
2072 static int tun_chr_open(struct inode
*inode
, struct file
* file
)
2074 struct tun_file
*tfile
;
2076 DBG1(KERN_INFO
, "tunX: tun_chr_open\n");
2078 tfile
= (struct tun_file
*)sk_alloc(&init_net
, AF_UNSPEC
, GFP_KERNEL
,
2082 rcu_assign_pointer(tfile
->tun
, NULL
);
2083 tfile
->net
= get_net(current
->nsproxy
->net_ns
);
2086 rcu_assign_pointer(tfile
->socket
.wq
, &tfile
->wq
);
2087 init_waitqueue_head(&tfile
->wq
.wait
);
2089 tfile
->socket
.file
= file
;
2090 tfile
->socket
.ops
= &tun_socket_ops
;
2092 sock_init_data(&tfile
->socket
, &tfile
->sk
);
2093 sk_change_net(&tfile
->sk
, tfile
->net
);
2095 tfile
->sk
.sk_write_space
= tun_sock_write_space
;
2096 tfile
->sk
.sk_sndbuf
= INT_MAX
;
2098 file
->private_data
= tfile
;
2099 set_bit(SOCK_EXTERNALLY_ALLOCATED
, &tfile
->socket
.flags
);
2104 static int tun_chr_close(struct inode
*inode
, struct file
*file
)
2106 struct tun_file
*tfile
= file
->private_data
;
2107 struct net
*net
= tfile
->net
;
2109 tun_detach(tfile
, true);
2115 static const struct file_operations tun_fops
= {
2116 .owner
= THIS_MODULE
,
2117 .llseek
= no_llseek
,
2118 .read
= do_sync_read
,
2119 .aio_read
= tun_chr_aio_read
,
2120 .write
= do_sync_write
,
2121 .aio_write
= tun_chr_aio_write
,
2122 .poll
= tun_chr_poll
,
2123 .unlocked_ioctl
= tun_chr_ioctl
,
2124 #ifdef CONFIG_COMPAT
2125 .compat_ioctl
= tun_chr_compat_ioctl
,
2127 .open
= tun_chr_open
,
2128 .release
= tun_chr_close
,
2129 .fasync
= tun_chr_fasync
2132 static struct miscdevice tun_miscdev
= {
2135 .nodename
= "net/tun",
2139 /* ethtool interface */
2141 static int tun_get_settings(struct net_device
*dev
, struct ethtool_cmd
*cmd
)
2144 cmd
->advertising
= 0;
2145 ethtool_cmd_speed_set(cmd
, SPEED_10
);
2146 cmd
->duplex
= DUPLEX_FULL
;
2147 cmd
->port
= PORT_TP
;
2148 cmd
->phy_address
= 0;
2149 cmd
->transceiver
= XCVR_INTERNAL
;
2150 cmd
->autoneg
= AUTONEG_DISABLE
;
2156 static void tun_get_drvinfo(struct net_device
*dev
, struct ethtool_drvinfo
*info
)
2158 struct tun_struct
*tun
= netdev_priv(dev
);
2160 strlcpy(info
->driver
, DRV_NAME
, sizeof(info
->driver
));
2161 strlcpy(info
->version
, DRV_VERSION
, sizeof(info
->version
));
2163 switch (tun
->flags
& TUN_TYPE_MASK
) {
2165 strlcpy(info
->bus_info
, "tun", sizeof(info
->bus_info
));
2168 strlcpy(info
->bus_info
, "tap", sizeof(info
->bus_info
));
2173 static u32
tun_get_msglevel(struct net_device
*dev
)
2176 struct tun_struct
*tun
= netdev_priv(dev
);
2183 static void tun_set_msglevel(struct net_device
*dev
, u32 value
)
2186 struct tun_struct
*tun
= netdev_priv(dev
);
2191 static const struct ethtool_ops tun_ethtool_ops
= {
2192 .get_settings
= tun_get_settings
,
2193 .get_drvinfo
= tun_get_drvinfo
,
2194 .get_msglevel
= tun_get_msglevel
,
2195 .set_msglevel
= tun_set_msglevel
,
2196 .get_link
= ethtool_op_get_link
,
2200 static int __init
tun_init(void)
2204 pr_info("%s, %s\n", DRV_DESCRIPTION
, DRV_VERSION
);
2205 pr_info("%s\n", DRV_COPYRIGHT
);
2207 ret
= rtnl_link_register(&tun_link_ops
);
2209 pr_err("Can't register link_ops\n");
2213 ret
= misc_register(&tun_miscdev
);
2215 pr_err("Can't register misc device %d\n", TUN_MINOR
);
2220 rtnl_link_unregister(&tun_link_ops
);
2225 static void tun_cleanup(void)
2227 misc_deregister(&tun_miscdev
);
2228 rtnl_link_unregister(&tun_link_ops
);
2231 /* Get an underlying socket object from tun file. Returns error unless file is
2232 * attached to a device. The returned object works like a packet socket, it
2233 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
2234 * holding a reference to the file for as long as the socket is in use. */
2235 struct socket
*tun_get_socket(struct file
*file
)
2237 struct tun_file
*tfile
;
2238 if (file
->f_op
!= &tun_fops
)
2239 return ERR_PTR(-EINVAL
);
2240 tfile
= file
->private_data
;
2242 return ERR_PTR(-EBADFD
);
2243 return &tfile
->socket
;
2245 EXPORT_SYMBOL_GPL(tun_get_socket
);
2247 module_init(tun_init
);
2248 module_exit(tun_cleanup
);
2249 MODULE_DESCRIPTION(DRV_DESCRIPTION
);
2250 MODULE_AUTHOR(DRV_COPYRIGHT
);
2251 MODULE_LICENSE("GPL");
2252 MODULE_ALIAS_MISCDEV(TUN_MINOR
);
2253 MODULE_ALIAS("devname:net/tun");