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 random_ether_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 DRV_NAME "tun"
38 #define DRV_VERSION "1.6"
39 #define DRV_DESCRIPTION "Universal TUN/TAP device driver"
40 #define DRV_COPYRIGHT "(C) 1999-2004 Max Krasnyansky <maxk@qualcomm.com>"
42 #include <linux/module.h>
43 #include <linux/errno.h>
44 #include <linux/kernel.h>
45 #include <linux/major.h>
46 #include <linux/slab.h>
47 #include <linux/poll.h>
48 #include <linux/fcntl.h>
49 #include <linux/init.h>
50 #include <linux/skbuff.h>
51 #include <linux/netdevice.h>
52 #include <linux/etherdevice.h>
53 #include <linux/miscdevice.h>
54 #include <linux/ethtool.h>
55 #include <linux/rtnetlink.h>
56 #include <linux/compat.h>
58 #include <linux/if_arp.h>
59 #include <linux/if_ether.h>
60 #include <linux/if_tun.h>
61 #include <linux/crc32.h>
62 #include <linux/nsproxy.h>
63 #include <linux/virtio_net.h>
64 #include <linux/rcupdate.h>
65 #include <net/net_namespace.h>
66 #include <net/netns/generic.h>
67 #include <net/rtnetlink.h>
70 #include <asm/system.h>
71 #include <asm/uaccess.h>
73 /* Uncomment to enable debugging */
74 /* #define TUN_DEBUG 1 */
79 #define DBG if(tun->debug)printk
80 #define DBG1 if(debug==2)printk
86 #define FLT_EXACT_COUNT 8
88 unsigned int count; /* Number of addrs. Zero means disabled */
89 u32 mask[2]; /* Mask of the hashed addrs */
90 unsigned char addr[FLT_EXACT_COUNT][ETH_ALEN];
95 struct tun_struct *tun;
102 struct tun_file *tfile;
107 struct net_device *dev;
108 struct fasync_struct *fasync;
110 struct tap_filter txflt;
111 struct socket socket;
123 struct tun_struct *tun;
126 static inline struct tun_sock *tun_sk(struct sock *sk)
128 return container_of(sk, struct tun_sock, sk);
131 static int tun_attach(struct tun_struct *tun, struct file *file)
133 struct tun_file *tfile = file->private_data;
138 netif_tx_lock_bh(tun->dev);
151 tun->socket.file = file;
152 netif_carrier_on(tun->dev);
154 sock_hold(tun->socket.sk);
155 atomic_inc(&tfile->count);
158 netif_tx_unlock_bh(tun->dev);
162 static void __tun_detach(struct tun_struct *tun)
164 /* Detach from net device */
165 netif_tx_lock_bh(tun->dev);
166 netif_carrier_off(tun->dev);
168 tun->socket.file = NULL;
169 netif_tx_unlock_bh(tun->dev);
171 /* Drop read queue */
172 skb_queue_purge(&tun->socket.sk->sk_receive_queue);
174 /* Drop the extra count on the net device */
178 static void tun_detach(struct tun_struct *tun)
185 static struct tun_struct *__tun_get(struct tun_file *tfile)
187 struct tun_struct *tun = NULL;
189 if (atomic_inc_not_zero(&tfile->count))
195 static struct tun_struct *tun_get(struct file *file)
197 return __tun_get(file->private_data);
200 static void tun_put(struct tun_struct *tun)
202 struct tun_file *tfile = tun->tfile;
204 if (atomic_dec_and_test(&tfile->count))
205 tun_detach(tfile->tun);
209 static void addr_hash_set(u32 *mask, const u8 *addr)
211 int n = ether_crc(ETH_ALEN, addr) >> 26;
212 mask[n >> 5] |= (1 << (n & 31));
215 static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
217 int n = ether_crc(ETH_ALEN, addr) >> 26;
218 return mask[n >> 5] & (1 << (n & 31));
221 static int update_filter(struct tap_filter *filter, void __user *arg)
223 struct { u8 u[ETH_ALEN]; } *addr;
224 struct tun_filter uf;
225 int err, alen, n, nexact;
227 if (copy_from_user(&uf, arg, sizeof(uf)))
236 alen = ETH_ALEN * uf.count;
237 addr = kmalloc(alen, GFP_KERNEL);
241 if (copy_from_user(addr, arg + sizeof(uf), alen)) {
246 /* The filter is updated without holding any locks. Which is
247 * perfectly safe. We disable it first and in the worst
248 * case we'll accept a few undesired packets. */
252 /* Use first set of addresses as an exact filter */
253 for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
254 memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
258 /* Remaining multicast addresses are hashed,
259 * unicast will leave the filter disabled. */
260 memset(filter->mask, 0, sizeof(filter->mask));
261 for (; n < uf.count; n++) {
262 if (!is_multicast_ether_addr(addr[n].u)) {
263 err = 0; /* no filter */
266 addr_hash_set(filter->mask, addr[n].u);
269 /* For ALLMULTI just set the mask to all ones.
270 * This overrides the mask populated above. */
271 if ((uf.flags & TUN_FLT_ALLMULTI))
272 memset(filter->mask, ~0, sizeof(filter->mask));
274 /* Now enable the filter */
276 filter->count = nexact;
278 /* Return the number of exact filters */
286 /* Returns: 0 - drop, !=0 - accept */
287 static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
289 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
291 struct ethhdr *eh = (struct ethhdr *) skb->data;
295 for (i = 0; i < filter->count; i++)
296 if (!compare_ether_addr(eh->h_dest, filter->addr[i]))
299 /* Inexact match (multicast only) */
300 if (is_multicast_ether_addr(eh->h_dest))
301 return addr_hash_test(filter->mask, eh->h_dest);
307 * Checks whether the packet is accepted or not.
308 * Returns: 0 - drop, !=0 - accept
310 static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
315 return run_filter(filter, skb);
318 /* Network device part of the driver */
320 static const struct ethtool_ops tun_ethtool_ops;
322 /* Net device detach from fd. */
323 static void tun_net_uninit(struct net_device *dev)
325 struct tun_struct *tun = netdev_priv(dev);
326 struct tun_file *tfile = tun->tfile;
328 /* Inform the methods they need to stop using the dev.
331 wake_up_all(&tun->wq.wait);
332 if (atomic_dec_and_test(&tfile->count))
337 static void tun_free_netdev(struct net_device *dev)
339 struct tun_struct *tun = netdev_priv(dev);
341 sock_put(tun->socket.sk);
344 /* Net device open. */
345 static int tun_net_open(struct net_device *dev)
347 netif_start_queue(dev);
351 /* Net device close. */
352 static int tun_net_close(struct net_device *dev)
354 netif_stop_queue(dev);
358 /* Net device start xmit */
359 static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
361 struct tun_struct *tun = netdev_priv(dev);
363 DBG(KERN_INFO "%s: tun_net_xmit %d\n", tun->dev->name, skb->len);
365 /* Drop packet if interface is not attached */
369 /* Drop if the filter does not like it.
370 * This is a noop if the filter is disabled.
371 * Filter can be enabled only for the TAP devices. */
372 if (!check_filter(&tun->txflt, skb))
375 if (tun->socket.sk->sk_filter &&
376 sk_filter(tun->socket.sk, skb))
379 if (skb_queue_len(&tun->socket.sk->sk_receive_queue) >= dev->tx_queue_len) {
380 if (!(tun->flags & TUN_ONE_QUEUE)) {
381 /* Normal queueing mode. */
382 /* Packet scheduler handles dropping of further packets. */
383 netif_stop_queue(dev);
385 /* We won't see all dropped packets individually, so overrun
386 * error is more appropriate. */
387 dev->stats.tx_fifo_errors++;
389 /* Single queue mode.
390 * Driver handles dropping of all packets itself. */
395 /* Orphan the skb - required as we might hang on to it
396 * for indefinite time. */
400 skb_queue_tail(&tun->socket.sk->sk_receive_queue, skb);
402 /* Notify and wake up reader process */
403 if (tun->flags & TUN_FASYNC)
404 kill_fasync(&tun->fasync, SIGIO, POLL_IN);
405 wake_up_interruptible_poll(&tun->wq.wait, POLLIN |
406 POLLRDNORM | POLLRDBAND);
410 dev->stats.tx_dropped++;
415 static void tun_net_mclist(struct net_device *dev)
418 * This callback is supposed to deal with mc filter in
419 * _rx_ path and has nothing to do with the _tx_ path.
420 * In rx path we always accept everything userspace gives us.
425 #define MAX_MTU 65535
428 tun_net_change_mtu(struct net_device *dev, int new_mtu)
430 if (new_mtu < MIN_MTU || new_mtu + dev->hard_header_len > MAX_MTU)
436 static const struct net_device_ops tun_netdev_ops = {
437 .ndo_uninit = tun_net_uninit,
438 .ndo_open = tun_net_open,
439 .ndo_stop = tun_net_close,
440 .ndo_start_xmit = tun_net_xmit,
441 .ndo_change_mtu = tun_net_change_mtu,
444 static const struct net_device_ops tap_netdev_ops = {
445 .ndo_uninit = tun_net_uninit,
446 .ndo_open = tun_net_open,
447 .ndo_stop = tun_net_close,
448 .ndo_start_xmit = tun_net_xmit,
449 .ndo_change_mtu = tun_net_change_mtu,
450 .ndo_set_multicast_list = tun_net_mclist,
451 .ndo_set_mac_address = eth_mac_addr,
452 .ndo_validate_addr = eth_validate_addr,
455 /* Initialize net device. */
456 static void tun_net_init(struct net_device *dev)
458 struct tun_struct *tun = netdev_priv(dev);
460 switch (tun->flags & TUN_TYPE_MASK) {
462 dev->netdev_ops = &tun_netdev_ops;
464 /* Point-to-Point TUN Device */
465 dev->hard_header_len = 0;
469 /* Zero header length */
470 dev->type = ARPHRD_NONE;
471 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
472 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
476 dev->netdev_ops = &tap_netdev_ops;
477 /* Ethernet TAP Device */
480 random_ether_addr(dev->dev_addr);
482 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
487 /* Character device part */
490 static unsigned int tun_chr_poll(struct file *file, poll_table * wait)
492 struct tun_file *tfile = file->private_data;
493 struct tun_struct *tun = __tun_get(tfile);
495 unsigned int mask = 0;
502 DBG(KERN_INFO "%s: tun_chr_poll\n", tun->dev->name);
504 poll_wait(file, &tun->wq.wait, wait);
506 if (!skb_queue_empty(&sk->sk_receive_queue))
507 mask |= POLLIN | POLLRDNORM;
509 if (sock_writeable(sk) ||
510 (!test_and_set_bit(SOCK_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
512 mask |= POLLOUT | POLLWRNORM;
514 if (tun->dev->reg_state != NETREG_REGISTERED)
521 /* prepad is the amount to reserve at front. len is length after that.
522 * linear is a hint as to how much to copy (usually headers). */
523 static inline struct sk_buff *tun_alloc_skb(struct tun_struct *tun,
524 size_t prepad, size_t len,
525 size_t linear, int noblock)
527 struct sock *sk = tun->socket.sk;
531 sock_update_classid(sk);
533 /* Under a page? Don't bother with paged skb. */
534 if (prepad + len < PAGE_SIZE || !linear)
537 skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
542 skb_reserve(skb, prepad);
543 skb_put(skb, linear);
544 skb->data_len = len - linear;
545 skb->len += len - linear;
550 /* Get packet from user space buffer */
551 static __inline__ ssize_t tun_get_user(struct tun_struct *tun,
552 const struct iovec *iv, size_t count,
555 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
557 size_t len = count, align = 0;
558 struct virtio_net_hdr gso = { 0 };
561 if (!(tun->flags & TUN_NO_PI)) {
562 if ((len -= sizeof(pi)) > count)
565 if (memcpy_fromiovecend((void *)&pi, iv, 0, sizeof(pi)))
567 offset += sizeof(pi);
570 if (tun->flags & TUN_VNET_HDR) {
571 if ((len -= tun->vnet_hdr_sz) > count)
574 if (memcpy_fromiovecend((void *)&gso, iv, offset, sizeof(gso)))
577 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
578 gso.csum_start + gso.csum_offset + 2 > gso.hdr_len)
579 gso.hdr_len = gso.csum_start + gso.csum_offset + 2;
581 if (gso.hdr_len > len)
583 offset += tun->vnet_hdr_sz;
586 if ((tun->flags & TUN_TYPE_MASK) == TUN_TAP_DEV) {
587 align = NET_IP_ALIGN;
588 if (unlikely(len < ETH_HLEN ||
589 (gso.hdr_len && gso.hdr_len < ETH_HLEN)))
593 skb = tun_alloc_skb(tun, align, len, gso.hdr_len, noblock);
595 if (PTR_ERR(skb) != -EAGAIN)
596 tun->dev->stats.rx_dropped++;
600 if (skb_copy_datagram_from_iovec(skb, 0, iv, offset, len)) {
601 tun->dev->stats.rx_dropped++;
606 if (gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) {
607 if (!skb_partial_csum_set(skb, gso.csum_start,
609 tun->dev->stats.rx_frame_errors++;
613 } else if (tun->flags & TUN_NOCHECKSUM)
614 skb->ip_summed = CHECKSUM_UNNECESSARY;
616 switch (tun->flags & TUN_TYPE_MASK) {
618 if (tun->flags & TUN_NO_PI) {
619 switch (skb->data[0] & 0xf0) {
621 pi.proto = htons(ETH_P_IP);
624 pi.proto = htons(ETH_P_IPV6);
627 tun->dev->stats.rx_dropped++;
633 skb_reset_mac_header(skb);
634 skb->protocol = pi.proto;
638 skb->protocol = eth_type_trans(skb, tun->dev);
642 if (gso.gso_type != VIRTIO_NET_HDR_GSO_NONE) {
644 switch (gso.gso_type & ~VIRTIO_NET_HDR_GSO_ECN) {
645 case VIRTIO_NET_HDR_GSO_TCPV4:
646 skb_shinfo(skb)->gso_type = SKB_GSO_TCPV4;
648 case VIRTIO_NET_HDR_GSO_TCPV6:
649 skb_shinfo(skb)->gso_type = SKB_GSO_TCPV6;
651 case VIRTIO_NET_HDR_GSO_UDP:
652 skb_shinfo(skb)->gso_type = SKB_GSO_UDP;
655 tun->dev->stats.rx_frame_errors++;
660 if (gso.gso_type & VIRTIO_NET_HDR_GSO_ECN)
661 skb_shinfo(skb)->gso_type |= SKB_GSO_TCP_ECN;
663 skb_shinfo(skb)->gso_size = gso.gso_size;
664 if (skb_shinfo(skb)->gso_size == 0) {
665 tun->dev->stats.rx_frame_errors++;
670 /* Header must be checked, and gso_segs computed. */
671 skb_shinfo(skb)->gso_type |= SKB_GSO_DODGY;
672 skb_shinfo(skb)->gso_segs = 0;
677 tun->dev->stats.rx_packets++;
678 tun->dev->stats.rx_bytes += len;
683 static ssize_t tun_chr_aio_write(struct kiocb *iocb, const struct iovec *iv,
684 unsigned long count, loff_t pos)
686 struct file *file = iocb->ki_filp;
687 struct tun_struct *tun = tun_get(file);
693 DBG(KERN_INFO "%s: tun_chr_write %ld\n", tun->dev->name, count);
695 result = tun_get_user(tun, iv, iov_length(iv, count),
696 file->f_flags & O_NONBLOCK);
702 /* Put packet to the user space buffer */
703 static __inline__ ssize_t tun_put_user(struct tun_struct *tun,
705 const struct iovec *iv, int len)
707 struct tun_pi pi = { 0, skb->protocol };
710 if (!(tun->flags & TUN_NO_PI)) {
711 if ((len -= sizeof(pi)) < 0)
714 if (len < skb->len) {
715 /* Packet will be striped */
716 pi.flags |= TUN_PKT_STRIP;
719 if (memcpy_toiovecend(iv, (void *) &pi, 0, sizeof(pi)))
724 if (tun->flags & TUN_VNET_HDR) {
725 struct virtio_net_hdr gso = { 0 }; /* no info leak */
726 if ((len -= tun->vnet_hdr_sz) < 0)
729 if (skb_is_gso(skb)) {
730 struct skb_shared_info *sinfo = skb_shinfo(skb);
732 /* This is a hint as to how much should be linear. */
733 gso.hdr_len = skb_headlen(skb);
734 gso.gso_size = sinfo->gso_size;
735 if (sinfo->gso_type & SKB_GSO_TCPV4)
736 gso.gso_type = VIRTIO_NET_HDR_GSO_TCPV4;
737 else if (sinfo->gso_type & SKB_GSO_TCPV6)
738 gso.gso_type = VIRTIO_NET_HDR_GSO_TCPV6;
739 else if (sinfo->gso_type & SKB_GSO_UDP)
740 gso.gso_type = VIRTIO_NET_HDR_GSO_UDP;
742 printk(KERN_ERR "tun: unexpected GSO type: "
743 "0x%x, gso_size %d, hdr_len %d\n",
744 sinfo->gso_type, gso.gso_size,
746 print_hex_dump(KERN_ERR, "tun: ",
749 min((int)gso.hdr_len, 64), true);
753 if (sinfo->gso_type & SKB_GSO_TCP_ECN)
754 gso.gso_type |= VIRTIO_NET_HDR_GSO_ECN;
756 gso.gso_type = VIRTIO_NET_HDR_GSO_NONE;
758 if (skb->ip_summed == CHECKSUM_PARTIAL) {
759 gso.flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
760 gso.csum_start = skb->csum_start - skb_headroom(skb);
761 gso.csum_offset = skb->csum_offset;
762 } /* else everything is zero */
764 if (unlikely(memcpy_toiovecend(iv, (void *)&gso, total,
767 total += tun->vnet_hdr_sz;
770 len = min_t(int, skb->len, len);
772 skb_copy_datagram_const_iovec(skb, 0, iv, total, len);
775 tun->dev->stats.tx_packets++;
776 tun->dev->stats.tx_bytes += len;
781 static ssize_t tun_do_read(struct tun_struct *tun,
782 struct kiocb *iocb, const struct iovec *iv,
783 ssize_t len, int noblock)
785 DECLARE_WAITQUEUE(wait, current);
789 DBG(KERN_INFO "%s: tun_chr_read\n", tun->dev->name);
791 add_wait_queue(&tun->wq.wait, &wait);
793 current->state = TASK_INTERRUPTIBLE;
795 /* Read frames from the queue */
796 if (!(skb=skb_dequeue(&tun->socket.sk->sk_receive_queue))) {
801 if (signal_pending(current)) {
805 if (tun->dev->reg_state != NETREG_REGISTERED) {
810 /* Nothing to read, let's sleep */
814 netif_wake_queue(tun->dev);
816 ret = tun_put_user(tun, skb, iv, len);
821 current->state = TASK_RUNNING;
822 remove_wait_queue(&tun->wq.wait, &wait);
827 static ssize_t tun_chr_aio_read(struct kiocb *iocb, const struct iovec *iv,
828 unsigned long count, loff_t pos)
830 struct file *file = iocb->ki_filp;
831 struct tun_file *tfile = file->private_data;
832 struct tun_struct *tun = __tun_get(tfile);
837 len = iov_length(iv, count);
843 ret = tun_do_read(tun, iocb, iv, len, file->f_flags & O_NONBLOCK);
844 ret = min_t(ssize_t, ret, len);
850 static void tun_setup(struct net_device *dev)
852 struct tun_struct *tun = netdev_priv(dev);
857 dev->ethtool_ops = &tun_ethtool_ops;
858 dev->destructor = tun_free_netdev;
861 /* Trivial set of netlink ops to allow deleting tun or tap
862 * device with netlink.
864 static int tun_validate(struct nlattr *tb[], struct nlattr *data[])
869 static struct rtnl_link_ops tun_link_ops __read_mostly = {
871 .priv_size = sizeof(struct tun_struct),
873 .validate = tun_validate,
876 static void tun_sock_write_space(struct sock *sk)
878 struct tun_struct *tun;
879 wait_queue_head_t *wqueue;
881 if (!sock_writeable(sk))
884 if (!test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sk->sk_socket->flags))
887 wqueue = sk_sleep(sk);
888 if (wqueue && waitqueue_active(wqueue))
889 wake_up_interruptible_sync_poll(wqueue, POLLOUT |
890 POLLWRNORM | POLLWRBAND);
892 tun = tun_sk(sk)->tun;
893 kill_fasync(&tun->fasync, SIGIO, POLL_OUT);
896 static void tun_sock_destruct(struct sock *sk)
898 free_netdev(tun_sk(sk)->tun->dev);
901 static int tun_sendmsg(struct kiocb *iocb, struct socket *sock,
902 struct msghdr *m, size_t total_len)
904 struct tun_struct *tun = container_of(sock, struct tun_struct, socket);
905 return tun_get_user(tun, m->msg_iov, total_len,
906 m->msg_flags & MSG_DONTWAIT);
909 static int tun_recvmsg(struct kiocb *iocb, struct socket *sock,
910 struct msghdr *m, size_t total_len,
913 struct tun_struct *tun = container_of(sock, struct tun_struct, socket);
915 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC))
917 ret = tun_do_read(tun, iocb, m->msg_iov, total_len,
918 flags & MSG_DONTWAIT);
919 if (ret > total_len) {
920 m->msg_flags |= MSG_TRUNC;
921 ret = flags & MSG_TRUNC ? ret : total_len;
926 /* Ops structure to mimic raw sockets with tun */
927 static const struct proto_ops tun_socket_ops = {
928 .sendmsg = tun_sendmsg,
929 .recvmsg = tun_recvmsg,
932 static struct proto tun_proto = {
934 .owner = THIS_MODULE,
935 .obj_size = sizeof(struct tun_sock),
938 static int tun_flags(struct tun_struct *tun)
942 if (tun->flags & TUN_TUN_DEV)
947 if (tun->flags & TUN_NO_PI)
950 if (tun->flags & TUN_ONE_QUEUE)
951 flags |= IFF_ONE_QUEUE;
953 if (tun->flags & TUN_VNET_HDR)
954 flags |= IFF_VNET_HDR;
959 static ssize_t tun_show_flags(struct device *dev, struct device_attribute *attr,
962 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
963 return sprintf(buf, "0x%x\n", tun_flags(tun));
966 static ssize_t tun_show_owner(struct device *dev, struct device_attribute *attr,
969 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
970 return sprintf(buf, "%d\n", tun->owner);
973 static ssize_t tun_show_group(struct device *dev, struct device_attribute *attr,
976 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
977 return sprintf(buf, "%d\n", tun->group);
980 static DEVICE_ATTR(tun_flags, 0444, tun_show_flags, NULL);
981 static DEVICE_ATTR(owner, 0444, tun_show_owner, NULL);
982 static DEVICE_ATTR(group, 0444, tun_show_group, NULL);
984 static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
987 struct tun_struct *tun;
988 struct net_device *dev;
991 dev = __dev_get_by_name(net, ifr->ifr_name);
993 const struct cred *cred = current_cred();
995 if (ifr->ifr_flags & IFF_TUN_EXCL)
997 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
998 tun = netdev_priv(dev);
999 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
1000 tun = netdev_priv(dev);
1004 if (((tun->owner != -1 && cred->euid != tun->owner) ||
1005 (tun->group != -1 && !in_egroup_p(tun->group))) &&
1006 !capable(CAP_NET_ADMIN))
1008 err = security_tun_dev_attach(tun->socket.sk);
1012 err = tun_attach(tun, file);
1018 unsigned long flags = 0;
1020 if (!capable(CAP_NET_ADMIN))
1022 err = security_tun_dev_create();
1027 if (ifr->ifr_flags & IFF_TUN) {
1029 flags |= TUN_TUN_DEV;
1031 } else if (ifr->ifr_flags & IFF_TAP) {
1033 flags |= TUN_TAP_DEV;
1039 name = ifr->ifr_name;
1041 dev = alloc_netdev(sizeof(struct tun_struct), name,
1046 dev_net_set(dev, net);
1047 dev->rtnl_link_ops = &tun_link_ops;
1049 tun = netdev_priv(dev);
1052 tun->txflt.count = 0;
1053 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
1056 sk = sk_alloc(net, AF_UNSPEC, GFP_KERNEL, &tun_proto);
1060 tun->socket.wq = &tun->wq;
1061 init_waitqueue_head(&tun->wq.wait);
1062 tun->socket.ops = &tun_socket_ops;
1063 sock_init_data(&tun->socket, sk);
1064 sk->sk_write_space = tun_sock_write_space;
1065 sk->sk_sndbuf = INT_MAX;
1067 tun_sk(sk)->tun = tun;
1069 security_tun_dev_post_create(sk);
1073 if (strchr(dev->name, '%')) {
1074 err = dev_alloc_name(dev, dev->name);
1079 err = register_netdevice(tun->dev);
1083 if (device_create_file(&tun->dev->dev, &dev_attr_tun_flags) ||
1084 device_create_file(&tun->dev->dev, &dev_attr_owner) ||
1085 device_create_file(&tun->dev->dev, &dev_attr_group))
1086 printk(KERN_ERR "Failed to create tun sysfs files\n");
1088 sk->sk_destruct = tun_sock_destruct;
1090 err = tun_attach(tun, file);
1095 DBG(KERN_INFO "%s: tun_set_iff\n", tun->dev->name);
1097 if (ifr->ifr_flags & IFF_NO_PI)
1098 tun->flags |= TUN_NO_PI;
1100 tun->flags &= ~TUN_NO_PI;
1102 if (ifr->ifr_flags & IFF_ONE_QUEUE)
1103 tun->flags |= TUN_ONE_QUEUE;
1105 tun->flags &= ~TUN_ONE_QUEUE;
1107 if (ifr->ifr_flags & IFF_VNET_HDR)
1108 tun->flags |= TUN_VNET_HDR;
1110 tun->flags &= ~TUN_VNET_HDR;
1112 /* Make sure persistent devices do not get stuck in
1115 if (netif_running(tun->dev))
1116 netif_wake_queue(tun->dev);
1118 strcpy(ifr->ifr_name, tun->dev->name);
1129 static int tun_get_iff(struct net *net, struct tun_struct *tun,
1132 DBG(KERN_INFO "%s: tun_get_iff\n", tun->dev->name);
1134 strcpy(ifr->ifr_name, tun->dev->name);
1136 ifr->ifr_flags = tun_flags(tun);
1141 /* This is like a cut-down ethtool ops, except done via tun fd so no
1142 * privs required. */
1143 static int set_offload(struct net_device *dev, unsigned long arg)
1145 unsigned int old_features, features;
1147 old_features = dev->features;
1148 /* Unset features, set them as we chew on the arg. */
1149 features = (old_features & ~(NETIF_F_HW_CSUM|NETIF_F_SG|NETIF_F_FRAGLIST
1150 |NETIF_F_TSO_ECN|NETIF_F_TSO|NETIF_F_TSO6
1153 if (arg & TUN_F_CSUM) {
1154 features |= NETIF_F_HW_CSUM|NETIF_F_SG|NETIF_F_FRAGLIST;
1157 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
1158 if (arg & TUN_F_TSO_ECN) {
1159 features |= NETIF_F_TSO_ECN;
1160 arg &= ~TUN_F_TSO_ECN;
1162 if (arg & TUN_F_TSO4)
1163 features |= NETIF_F_TSO;
1164 if (arg & TUN_F_TSO6)
1165 features |= NETIF_F_TSO6;
1166 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
1169 if (arg & TUN_F_UFO) {
1170 features |= NETIF_F_UFO;
1175 /* This gives the user a way to test for new features in future by
1176 * trying to set them. */
1180 dev->features = features;
1181 if (old_features != dev->features)
1182 netdev_features_change(dev);
1187 static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
1188 unsigned long arg, int ifreq_len)
1190 struct tun_file *tfile = file->private_data;
1191 struct tun_struct *tun;
1192 void __user* argp = (void __user*)arg;
1193 struct sock_fprog fprog;
1199 if (cmd == TUNSETIFF || _IOC_TYPE(cmd) == 0x89)
1200 if (copy_from_user(&ifr, argp, ifreq_len))
1203 if (cmd == TUNGETFEATURES) {
1204 /* Currently this just means: "what IFF flags are valid?".
1205 * This is needed because we never checked for invalid flags on
1207 return put_user(IFF_TUN | IFF_TAP | IFF_NO_PI | IFF_ONE_QUEUE |
1209 (unsigned int __user*)argp);
1214 tun = __tun_get(tfile);
1215 if (cmd == TUNSETIFF && !tun) {
1216 ifr.ifr_name[IFNAMSIZ-1] = '\0';
1218 ret = tun_set_iff(tfile->net, file, &ifr);
1223 if (copy_to_user(argp, &ifr, ifreq_len))
1232 DBG(KERN_INFO "%s: tun_chr_ioctl cmd %d\n", tun->dev->name, cmd);
1237 ret = tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
1241 if (copy_to_user(argp, &ifr, ifreq_len))
1246 /* Disable/Enable checksum */
1248 tun->flags |= TUN_NOCHECKSUM;
1250 tun->flags &= ~TUN_NOCHECKSUM;
1252 DBG(KERN_INFO "%s: checksum %s\n",
1253 tun->dev->name, arg ? "disabled" : "enabled");
1257 /* Disable/Enable persist mode */
1259 tun->flags |= TUN_PERSIST;
1261 tun->flags &= ~TUN_PERSIST;
1263 DBG(KERN_INFO "%s: persist %s\n",
1264 tun->dev->name, arg ? "enabled" : "disabled");
1268 /* Set owner of the device */
1269 tun->owner = (uid_t) arg;
1271 DBG(KERN_INFO "%s: owner set to %d\n", tun->dev->name, tun->owner);
1275 /* Set group of the device */
1276 tun->group= (gid_t) arg;
1278 DBG(KERN_INFO "%s: group set to %d\n", tun->dev->name, tun->group);
1282 /* Only allow setting the type when the interface is down */
1283 if (tun->dev->flags & IFF_UP) {
1284 DBG(KERN_INFO "%s: Linktype set failed because interface is up\n",
1288 tun->dev->type = (int) arg;
1289 DBG(KERN_INFO "%s: linktype set to %d\n", tun->dev->name, tun->dev->type);
1300 ret = set_offload(tun->dev, arg);
1303 case TUNSETTXFILTER:
1304 /* Can be set only for TAPs */
1306 if ((tun->flags & TUN_TYPE_MASK) != TUN_TAP_DEV)
1308 ret = update_filter(&tun->txflt, (void __user *)arg);
1313 memcpy(ifr.ifr_hwaddr.sa_data, tun->dev->dev_addr, ETH_ALEN);
1314 ifr.ifr_hwaddr.sa_family = tun->dev->type;
1315 if (copy_to_user(argp, &ifr, ifreq_len))
1320 /* Set hw address */
1321 DBG(KERN_DEBUG "%s: set hw address: %pM\n",
1322 tun->dev->name, ifr.ifr_hwaddr.sa_data);
1324 ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr);
1328 sndbuf = tun->socket.sk->sk_sndbuf;
1329 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
1334 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
1339 tun->socket.sk->sk_sndbuf = sndbuf;
1342 case TUNGETVNETHDRSZ:
1343 vnet_hdr_sz = tun->vnet_hdr_sz;
1344 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
1348 case TUNSETVNETHDRSZ:
1349 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
1353 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
1358 tun->vnet_hdr_sz = vnet_hdr_sz;
1361 case TUNATTACHFILTER:
1362 /* Can be set only for TAPs */
1364 if ((tun->flags & TUN_TYPE_MASK) != TUN_TAP_DEV)
1367 if (copy_from_user(&fprog, argp, sizeof(fprog)))
1370 ret = sk_attach_filter(&fprog, tun->socket.sk);
1373 case TUNDETACHFILTER:
1374 /* Can be set only for TAPs */
1376 if ((tun->flags & TUN_TYPE_MASK) != TUN_TAP_DEV)
1378 ret = sk_detach_filter(tun->socket.sk);
1393 static long tun_chr_ioctl(struct file *file,
1394 unsigned int cmd, unsigned long arg)
1396 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
1399 #ifdef CONFIG_COMPAT
1400 static long tun_chr_compat_ioctl(struct file *file,
1401 unsigned int cmd, unsigned long arg)
1406 case TUNSETTXFILTER:
1411 arg = (unsigned long)compat_ptr(arg);
1414 arg = (compat_ulong_t)arg;
1419 * compat_ifreq is shorter than ifreq, so we must not access beyond
1420 * the end of that structure. All fields that are used in this
1421 * driver are compatible though, we don't need to convert the
1424 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
1426 #endif /* CONFIG_COMPAT */
1428 static int tun_chr_fasync(int fd, struct file *file, int on)
1430 struct tun_struct *tun = tun_get(file);
1436 DBG(KERN_INFO "%s: tun_chr_fasync %d\n", tun->dev->name, on);
1438 if ((ret = fasync_helper(fd, file, on, &tun->fasync)) < 0)
1442 ret = __f_setown(file, task_pid(current), PIDTYPE_PID, 0);
1445 tun->flags |= TUN_FASYNC;
1447 tun->flags &= ~TUN_FASYNC;
1454 static int tun_chr_open(struct inode *inode, struct file * file)
1456 struct tun_file *tfile;
1458 DBG1(KERN_INFO "tunX: tun_chr_open\n");
1460 tfile = kmalloc(sizeof(*tfile), GFP_KERNEL);
1463 atomic_set(&tfile->count, 0);
1465 tfile->net = get_net(current->nsproxy->net_ns);
1466 file->private_data = tfile;
1470 static int tun_chr_close(struct inode *inode, struct file *file)
1472 struct tun_file *tfile = file->private_data;
1473 struct tun_struct *tun;
1475 tun = __tun_get(tfile);
1477 struct net_device *dev = tun->dev;
1479 DBG(KERN_INFO "%s: tun_chr_close\n", dev->name);
1483 /* If desirable, unregister the netdevice. */
1484 if (!(tun->flags & TUN_PERSIST)) {
1486 if (dev->reg_state == NETREG_REGISTERED)
1487 unregister_netdevice(dev);
1494 sock_put(tun->socket.sk);
1496 put_net(tfile->net);
1502 static const struct file_operations tun_fops = {
1503 .owner = THIS_MODULE,
1504 .llseek = no_llseek,
1505 .read = do_sync_read,
1506 .aio_read = tun_chr_aio_read,
1507 .write = do_sync_write,
1508 .aio_write = tun_chr_aio_write,
1509 .poll = tun_chr_poll,
1510 .unlocked_ioctl = tun_chr_ioctl,
1511 #ifdef CONFIG_COMPAT
1512 .compat_ioctl = tun_chr_compat_ioctl,
1514 .open = tun_chr_open,
1515 .release = tun_chr_close,
1516 .fasync = tun_chr_fasync
1519 static struct miscdevice tun_miscdev = {
1522 .nodename = "net/tun",
1526 /* ethtool interface */
1528 static int tun_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
1531 cmd->advertising = 0;
1532 cmd->speed = SPEED_10;
1533 cmd->duplex = DUPLEX_FULL;
1534 cmd->port = PORT_TP;
1535 cmd->phy_address = 0;
1536 cmd->transceiver = XCVR_INTERNAL;
1537 cmd->autoneg = AUTONEG_DISABLE;
1543 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
1545 struct tun_struct *tun = netdev_priv(dev);
1547 strcpy(info->driver, DRV_NAME);
1548 strcpy(info->version, DRV_VERSION);
1549 strcpy(info->fw_version, "N/A");
1551 switch (tun->flags & TUN_TYPE_MASK) {
1553 strcpy(info->bus_info, "tun");
1556 strcpy(info->bus_info, "tap");
1561 static u32 tun_get_msglevel(struct net_device *dev)
1564 struct tun_struct *tun = netdev_priv(dev);
1571 static void tun_set_msglevel(struct net_device *dev, u32 value)
1574 struct tun_struct *tun = netdev_priv(dev);
1579 static u32 tun_get_rx_csum(struct net_device *dev)
1581 struct tun_struct *tun = netdev_priv(dev);
1582 return (tun->flags & TUN_NOCHECKSUM) == 0;
1585 static int tun_set_rx_csum(struct net_device *dev, u32 data)
1587 struct tun_struct *tun = netdev_priv(dev);
1589 tun->flags &= ~TUN_NOCHECKSUM;
1591 tun->flags |= TUN_NOCHECKSUM;
1595 static const struct ethtool_ops tun_ethtool_ops = {
1596 .get_settings = tun_get_settings,
1597 .get_drvinfo = tun_get_drvinfo,
1598 .get_msglevel = tun_get_msglevel,
1599 .set_msglevel = tun_set_msglevel,
1600 .get_link = ethtool_op_get_link,
1601 .get_rx_csum = tun_get_rx_csum,
1602 .set_rx_csum = tun_set_rx_csum
1606 static int __init tun_init(void)
1610 printk(KERN_INFO "tun: %s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
1611 printk(KERN_INFO "tun: %s\n", DRV_COPYRIGHT);
1613 ret = rtnl_link_register(&tun_link_ops);
1615 printk(KERN_ERR "tun: Can't register link_ops\n");
1619 ret = misc_register(&tun_miscdev);
1621 printk(KERN_ERR "tun: Can't register misc device %d\n", TUN_MINOR);
1626 rtnl_link_unregister(&tun_link_ops);
1631 static void tun_cleanup(void)
1633 misc_deregister(&tun_miscdev);
1634 rtnl_link_unregister(&tun_link_ops);
1637 /* Get an underlying socket object from tun file. Returns error unless file is
1638 * attached to a device. The returned object works like a packet socket, it
1639 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
1640 * holding a reference to the file for as long as the socket is in use. */
1641 struct socket *tun_get_socket(struct file *file)
1643 struct tun_struct *tun;
1644 if (file->f_op != &tun_fops)
1645 return ERR_PTR(-EINVAL);
1646 tun = tun_get(file);
1648 return ERR_PTR(-EBADFD);
1650 return &tun->socket;
1652 EXPORT_SYMBOL_GPL(tun_get_socket);
1654 module_init(tun_init);
1655 module_exit(tun_cleanup);
1656 MODULE_DESCRIPTION(DRV_DESCRIPTION);
1657 MODULE_AUTHOR(DRV_COPYRIGHT);
1658 MODULE_LICENSE("GPL");
1659 MODULE_ALIAS_MISCDEV(TUN_MINOR);
1660 MODULE_ALIAS("devname:net/tun");