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/config.h>
43 #include <linux/module.h>
44 #include <linux/errno.h>
45 #include <linux/kernel.h>
46 #include <linux/major.h>
47 #include <linux/slab.h>
48 #include <linux/poll.h>
49 #include <linux/fcntl.h>
50 #include <linux/init.h>
51 #include <linux/skbuff.h>
52 #include <linux/netdevice.h>
53 #include <linux/etherdevice.h>
54 #include <linux/miscdevice.h>
55 #include <linux/ethtool.h>
56 #include <linux/rtnetlink.h>
58 #include <linux/if_arp.h>
59 #include <linux/if_ether.h>
60 #include <linux/if_tun.h>
61 #include <linux/crc32.h>
63 #include <asm/system.h>
64 #include <asm/uaccess.h>
70 /* Network device part of the driver */
72 static LIST_HEAD(tun_dev_list);
73 static struct ethtool_ops tun_ethtool_ops;
75 /* Net device open. */
76 static int tun_net_open(struct net_device *dev)
78 netif_start_queue(dev);
82 /* Net device close. */
83 static int tun_net_close(struct net_device *dev)
85 netif_stop_queue(dev);
89 /* Net device start xmit */
90 static int tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
92 struct tun_struct *tun = netdev_priv(dev);
94 DBG(KERN_INFO "%s: tun_net_xmit %d\n", tun->dev->name, skb->len);
96 /* Drop packet if interface is not attached */
100 /* Packet dropping */
101 if (skb_queue_len(&tun->readq) >= dev->tx_queue_len) {
102 if (!(tun->flags & TUN_ONE_QUEUE)) {
103 /* Normal queueing mode. */
104 /* Packet scheduler handles dropping of further packets. */
105 netif_stop_queue(dev);
107 /* We won't see all dropped packets individually, so overrun
108 * error is more appropriate. */
109 tun->stats.tx_fifo_errors++;
111 /* Single queue mode.
112 * Driver handles dropping of all packets itself. */
118 skb_queue_tail(&tun->readq, skb);
119 dev->trans_start = jiffies;
121 /* Notify and wake up reader process */
122 if (tun->flags & TUN_FASYNC)
123 kill_fasync(&tun->fasync, SIGIO, POLL_IN);
124 wake_up_interruptible(&tun->read_wait);
128 tun->stats.tx_dropped++;
133 /** Add the specified Ethernet address to this multicast filter. */
135 add_multi(u32* filter, const u8* addr)
137 int bit_nr = ether_crc(ETH_ALEN, addr) >> 26;
138 filter[bit_nr >> 5] |= 1 << (bit_nr & 31);
141 /** Remove the specified Ethernet addres from this multicast filter. */
143 del_multi(u32* filter, const u8* addr)
145 int bit_nr = ether_crc(ETH_ALEN, addr) >> 26;
146 filter[bit_nr >> 5] &= ~(1 << (bit_nr & 31));
149 /** Update the list of multicast groups to which the network device belongs.
150 * This list is used to filter packets being sent from the character device to
151 * the network device. */
153 tun_net_mclist(struct net_device *dev)
155 struct tun_struct *tun = netdev_priv(dev);
156 const struct dev_mc_list *mclist;
158 DBG(KERN_DEBUG "%s: tun_net_mclist: mc_count %d\n",
159 dev->name, dev->mc_count);
160 memset(tun->chr_filter, 0, sizeof tun->chr_filter);
161 for (i = 0, mclist = dev->mc_list; i < dev->mc_count && mclist != NULL;
162 i++, mclist = mclist->next) {
163 add_multi(tun->net_filter, mclist->dmi_addr);
164 DBG(KERN_DEBUG "%s: tun_net_mclist: %x:%x:%x:%x:%x:%x\n",
166 mclist->dmi_addr[0], mclist->dmi_addr[1], mclist->dmi_addr[2],
167 mclist->dmi_addr[3], mclist->dmi_addr[4], mclist->dmi_addr[5]);
171 static struct net_device_stats *tun_net_stats(struct net_device *dev)
173 struct tun_struct *tun = netdev_priv(dev);
177 /* Initialize net device. */
178 static void tun_net_init(struct net_device *dev)
180 struct tun_struct *tun = netdev_priv(dev);
182 switch (tun->flags & TUN_TYPE_MASK) {
184 /* Point-to-Point TUN Device */
185 dev->hard_header_len = 0;
189 /* Zero header length */
190 dev->type = ARPHRD_NONE;
191 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
192 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
196 /* Ethernet TAP Device */
197 dev->set_multicast_list = tun_net_mclist;
200 random_ether_addr(dev->dev_addr);
201 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
206 /* Character device part */
209 static unsigned int tun_chr_poll(struct file *file, poll_table * wait)
211 struct tun_struct *tun = file->private_data;
212 unsigned int mask = POLLOUT | POLLWRNORM;
217 DBG(KERN_INFO "%s: tun_chr_poll\n", tun->dev->name);
219 poll_wait(file, &tun->read_wait, wait);
221 if (!skb_queue_empty(&tun->readq))
222 mask |= POLLIN | POLLRDNORM;
227 /* Get packet from user space buffer */
228 static __inline__ ssize_t tun_get_user(struct tun_struct *tun, struct iovec *iv, size_t count)
230 struct tun_pi pi = { 0, __constant_htons(ETH_P_IP) };
232 size_t len = count, align = 0;
234 if (!(tun->flags & TUN_NO_PI)) {
235 if ((len -= sizeof(pi)) > count)
238 if(memcpy_fromiovec((void *)&pi, iv, sizeof(pi)))
242 if ((tun->flags & TUN_TYPE_MASK) == TUN_TAP_DEV)
243 align = NET_IP_ALIGN;
245 if (!(skb = alloc_skb(len + align, GFP_KERNEL))) {
246 tun->stats.rx_dropped++;
251 skb_reserve(skb, align);
252 if (memcpy_fromiovec(skb_put(skb, len), iv, len))
256 switch (tun->flags & TUN_TYPE_MASK) {
258 skb->mac.raw = skb->data;
259 skb->protocol = pi.proto;
262 skb->protocol = eth_type_trans(skb, tun->dev);
266 if (tun->flags & TUN_NOCHECKSUM)
267 skb->ip_summed = CHECKSUM_UNNECESSARY;
270 tun->dev->last_rx = jiffies;
272 tun->stats.rx_packets++;
273 tun->stats.rx_bytes += len;
278 static inline size_t iov_total(const struct iovec *iv, unsigned long count)
283 for (i = 0, len = 0; i < count; i++)
284 len += iv[i].iov_len;
290 static ssize_t tun_chr_writev(struct file * file, const struct iovec *iv,
291 unsigned long count, loff_t *pos)
293 struct tun_struct *tun = file->private_data;
298 DBG(KERN_INFO "%s: tun_chr_write %ld\n", tun->dev->name, count);
300 return tun_get_user(tun, (struct iovec *) iv, iov_total(iv, count));
304 static ssize_t tun_chr_write(struct file * file, const char __user * buf,
305 size_t count, loff_t *pos)
307 struct iovec iv = { (void __user *) buf, count };
308 return tun_chr_writev(file, &iv, 1, pos);
311 /* Put packet to the user space buffer */
312 static __inline__ ssize_t tun_put_user(struct tun_struct *tun,
314 struct iovec *iv, int len)
316 struct tun_pi pi = { 0, skb->protocol };
319 if (!(tun->flags & TUN_NO_PI)) {
320 if ((len -= sizeof(pi)) < 0)
323 if (len < skb->len) {
324 /* Packet will be striped */
325 pi.flags |= TUN_PKT_STRIP;
328 if (memcpy_toiovec(iv, (void *) &pi, sizeof(pi)))
333 len = min_t(int, skb->len, len);
335 skb_copy_datagram_iovec(skb, 0, iv, len);
338 tun->stats.tx_packets++;
339 tun->stats.tx_bytes += len;
345 static ssize_t tun_chr_readv(struct file *file, const struct iovec *iv,
346 unsigned long count, loff_t *pos)
348 struct tun_struct *tun = file->private_data;
349 DECLARE_WAITQUEUE(wait, current);
351 ssize_t len, ret = 0;
356 DBG(KERN_INFO "%s: tun_chr_read\n", tun->dev->name);
358 len = iov_total(iv, count);
362 add_wait_queue(&tun->read_wait, &wait);
364 const u8 ones[ ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
368 current->state = TASK_INTERRUPTIBLE;
370 /* Read frames from the queue */
371 if (!(skb=skb_dequeue(&tun->readq))) {
372 if (file->f_flags & O_NONBLOCK) {
376 if (signal_pending(current)) {
381 /* Nothing to read, let's sleep */
385 netif_wake_queue(tun->dev);
387 /** Decide whether to accept this packet. This code is designed to
388 * behave identically to an Ethernet interface. Accept the packet if
389 * - we are promiscuous.
390 * - the packet is addressed to us.
391 * - the packet is broadcast.
392 * - the packet is multicast and
393 * - we are multicast promiscous.
394 * - we belong to the multicast group.
396 memcpy(addr, skb->data,
397 min_t(size_t, sizeof addr, skb->len));
398 bit_nr = ether_crc(sizeof addr, addr) >> 26;
399 if ((tun->if_flags & IFF_PROMISC) ||
400 memcmp(addr, tun->dev_addr, sizeof addr) == 0 ||
401 memcmp(addr, ones, sizeof addr) == 0 ||
402 (((addr[0] == 1 && addr[1] == 0 && addr[2] == 0x5e) ||
403 (addr[0] == 0x33 && addr[1] == 0x33)) &&
404 ((tun->if_flags & IFF_ALLMULTI) ||
405 (tun->chr_filter[bit_nr >> 5] & (1 << (bit_nr & 31)))))) {
406 DBG(KERN_DEBUG "%s: tun_chr_readv: accepted: %x:%x:%x:%x:%x:%x\n",
407 tun->dev->name, addr[0], addr[1], addr[2],
408 addr[3], addr[4], addr[5]);
409 ret = tun_put_user(tun, skb, (struct iovec *) iv, len);
413 DBG(KERN_DEBUG "%s: tun_chr_readv: rejected: %x:%x:%x:%x:%x:%x\n",
414 tun->dev->name, addr[0], addr[1], addr[2],
415 addr[3], addr[4], addr[5]);
421 current->state = TASK_RUNNING;
422 remove_wait_queue(&tun->read_wait, &wait);
428 static ssize_t tun_chr_read(struct file * file, char __user * buf,
429 size_t count, loff_t *pos)
431 struct iovec iv = { buf, count };
432 return tun_chr_readv(file, &iv, 1, pos);
435 static void tun_setup(struct net_device *dev)
437 struct tun_struct *tun = netdev_priv(dev);
439 skb_queue_head_init(&tun->readq);
440 init_waitqueue_head(&tun->read_wait);
444 SET_MODULE_OWNER(dev);
445 dev->open = tun_net_open;
446 dev->hard_start_xmit = tun_net_xmit;
447 dev->stop = tun_net_close;
448 dev->get_stats = tun_net_stats;
449 dev->ethtool_ops = &tun_ethtool_ops;
450 dev->destructor = free_netdev;
453 static struct tun_struct *tun_get_by_name(const char *name)
455 struct tun_struct *tun;
458 list_for_each_entry(tun, &tun_dev_list, list) {
459 if (!strncmp(tun->dev->name, name, IFNAMSIZ))
466 static int tun_set_iff(struct file *file, struct ifreq *ifr)
468 struct tun_struct *tun;
469 struct net_device *dev;
472 tun = tun_get_by_name(ifr->ifr_name);
477 /* Check permissions */
478 if (tun->owner != -1 &&
479 current->euid != tun->owner && !capable(CAP_NET_ADMIN))
482 else if (__dev_get_by_name(ifr->ifr_name))
486 unsigned long flags = 0;
491 if (ifr->ifr_flags & IFF_TUN) {
493 flags |= TUN_TUN_DEV;
495 } else if (ifr->ifr_flags & IFF_TAP) {
497 flags |= TUN_TAP_DEV;
503 name = ifr->ifr_name;
505 dev = alloc_netdev(sizeof(struct tun_struct), name,
510 tun = netdev_priv(dev);
513 /* Be promiscuous by default to maintain previous behaviour. */
514 tun->if_flags = IFF_PROMISC;
515 /* Generate random Ethernet address. */
516 *(u16 *)tun->dev_addr = htons(0x00FF);
517 get_random_bytes(tun->dev_addr + sizeof(u16), 4);
518 memset(tun->chr_filter, 0, sizeof tun->chr_filter);
522 if (strchr(dev->name, '%')) {
523 err = dev_alloc_name(dev, dev->name);
528 err = register_netdevice(tun->dev);
532 list_add(&tun->list, &tun_dev_list);
535 DBG(KERN_INFO "%s: tun_set_iff\n", tun->dev->name);
537 if (ifr->ifr_flags & IFF_NO_PI)
538 tun->flags |= TUN_NO_PI;
540 if (ifr->ifr_flags & IFF_ONE_QUEUE)
541 tun->flags |= TUN_ONE_QUEUE;
543 file->private_data = tun;
546 strcpy(ifr->ifr_name, tun->dev->name);
555 static int tun_chr_ioctl(struct inode *inode, struct file *file,
556 unsigned int cmd, unsigned long arg)
558 struct tun_struct *tun = file->private_data;
559 void __user* argp = (void __user*)arg;
562 if (cmd == TUNSETIFF || _IOC_TYPE(cmd) == 0x89)
563 if (copy_from_user(&ifr, argp, sizeof ifr))
566 if (cmd == TUNSETIFF && !tun) {
569 ifr.ifr_name[IFNAMSIZ-1] = '\0';
572 err = tun_set_iff(file, &ifr);
578 if (copy_to_user(argp, &ifr, sizeof(ifr)))
586 DBG(KERN_INFO "%s: tun_chr_ioctl cmd %d\n", tun->dev->name, cmd);
590 /* Disable/Enable checksum */
592 tun->flags |= TUN_NOCHECKSUM;
594 tun->flags &= ~TUN_NOCHECKSUM;
596 DBG(KERN_INFO "%s: checksum %s\n",
597 tun->dev->name, arg ? "disabled" : "enabled");
601 /* Disable/Enable persist mode */
603 tun->flags |= TUN_PERSIST;
605 tun->flags &= ~TUN_PERSIST;
607 DBG(KERN_INFO "%s: persist %s\n",
608 tun->dev->name, arg ? "disabled" : "enabled");
612 /* Set owner of the device */
613 tun->owner = (uid_t) arg;
615 DBG(KERN_INFO "%s: owner set to %d\n", tun->dev->name, tun->owner);
619 /* Only allow setting the type when the interface is down */
620 if (tun->dev->flags & IFF_UP) {
621 DBG(KERN_INFO "%s: Linktype set failed because interface is up\n",
625 tun->dev->type = (int) arg;
626 DBG(KERN_INFO "%s: linktype set to %d\n", tun->dev->name, tun->dev->type);
637 ifr.ifr_flags = tun->if_flags;
638 if (copy_to_user( argp, &ifr, sizeof ifr))
643 /** Set the character device's interface flags. Currently only
644 * IFF_PROMISC and IFF_ALLMULTI are used. */
645 tun->if_flags = ifr.ifr_flags;
646 DBG(KERN_INFO "%s: interface flags 0x%lx\n",
647 tun->dev->name, tun->if_flags);
651 memcpy(ifr.ifr_hwaddr.sa_data, tun->dev_addr,
652 min(sizeof ifr.ifr_hwaddr.sa_data, sizeof tun->dev_addr));
653 if (copy_to_user( argp, &ifr, sizeof ifr))
658 /** Set the character device's hardware address. This is used when
659 * filtering packets being sent from the network device to the character
661 memcpy(tun->dev_addr, ifr.ifr_hwaddr.sa_data,
662 min(sizeof ifr.ifr_hwaddr.sa_data, sizeof tun->dev_addr));
663 DBG(KERN_DEBUG "%s: set hardware address: %x:%x:%x:%x:%x:%x\n",
665 tun->dev_addr[0], tun->dev_addr[1], tun->dev_addr[2],
666 tun->dev_addr[3], tun->dev_addr[4], tun->dev_addr[5]);
670 /** Add the specified group to the character device's multicast filter
672 add_multi(tun->chr_filter, ifr.ifr_hwaddr.sa_data);
673 DBG(KERN_DEBUG "%s: add multi: %x:%x:%x:%x:%x:%x\n",
675 (u8)ifr.ifr_hwaddr.sa_data[0], (u8)ifr.ifr_hwaddr.sa_data[1],
676 (u8)ifr.ifr_hwaddr.sa_data[2], (u8)ifr.ifr_hwaddr.sa_data[3],
677 (u8)ifr.ifr_hwaddr.sa_data[4], (u8)ifr.ifr_hwaddr.sa_data[5]);
681 /** Remove the specified group from the character device's multicast
683 del_multi(tun->chr_filter, ifr.ifr_hwaddr.sa_data);
684 DBG(KERN_DEBUG "%s: del multi: %x:%x:%x:%x:%x:%x\n",
686 (u8)ifr.ifr_hwaddr.sa_data[0], (u8)ifr.ifr_hwaddr.sa_data[1],
687 (u8)ifr.ifr_hwaddr.sa_data[2], (u8)ifr.ifr_hwaddr.sa_data[3],
688 (u8)ifr.ifr_hwaddr.sa_data[4], (u8)ifr.ifr_hwaddr.sa_data[5]);
698 static int tun_chr_fasync(int fd, struct file *file, int on)
700 struct tun_struct *tun = file->private_data;
706 DBG(KERN_INFO "%s: tun_chr_fasync %d\n", tun->dev->name, on);
708 if ((ret = fasync_helper(fd, file, on, &tun->fasync)) < 0)
712 ret = f_setown(file, current->pid, 0);
715 tun->flags |= TUN_FASYNC;
717 tun->flags &= ~TUN_FASYNC;
722 static int tun_chr_open(struct inode *inode, struct file * file)
724 DBG1(KERN_INFO "tunX: tun_chr_open\n");
725 file->private_data = NULL;
729 static int tun_chr_close(struct inode *inode, struct file *file)
731 struct tun_struct *tun = file->private_data;
736 DBG(KERN_INFO "%s: tun_chr_close\n", tun->dev->name);
738 tun_chr_fasync(-1, file, 0);
742 /* Detach from net device */
743 file->private_data = NULL;
746 /* Drop read queue */
747 skb_queue_purge(&tun->readq);
749 if (!(tun->flags & TUN_PERSIST)) {
750 list_del(&tun->list);
751 unregister_netdevice(tun->dev);
759 static struct file_operations tun_fops = {
760 .owner = THIS_MODULE,
762 .read = tun_chr_read,
763 .readv = tun_chr_readv,
764 .write = tun_chr_write,
765 .writev = tun_chr_writev,
766 .poll = tun_chr_poll,
767 .ioctl = tun_chr_ioctl,
768 .open = tun_chr_open,
769 .release = tun_chr_close,
770 .fasync = tun_chr_fasync
773 static struct miscdevice tun_miscdev = {
777 .devfs_name = "net/tun",
780 /* ethtool interface */
782 static int tun_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
785 cmd->advertising = 0;
786 cmd->speed = SPEED_10;
787 cmd->duplex = DUPLEX_FULL;
789 cmd->phy_address = 0;
790 cmd->transceiver = XCVR_INTERNAL;
791 cmd->autoneg = AUTONEG_DISABLE;
797 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
799 struct tun_struct *tun = netdev_priv(dev);
801 strcpy(info->driver, DRV_NAME);
802 strcpy(info->version, DRV_VERSION);
803 strcpy(info->fw_version, "N/A");
805 switch (tun->flags & TUN_TYPE_MASK) {
807 strcpy(info->bus_info, "tun");
810 strcpy(info->bus_info, "tap");
815 static u32 tun_get_msglevel(struct net_device *dev)
818 struct tun_struct *tun = netdev_priv(dev);
825 static void tun_set_msglevel(struct net_device *dev, u32 value)
828 struct tun_struct *tun = netdev_priv(dev);
833 static u32 tun_get_link(struct net_device *dev)
835 struct tun_struct *tun = netdev_priv(dev);
836 return tun->attached;
839 static u32 tun_get_rx_csum(struct net_device *dev)
841 struct tun_struct *tun = netdev_priv(dev);
842 return (tun->flags & TUN_NOCHECKSUM) == 0;
845 static int tun_set_rx_csum(struct net_device *dev, u32 data)
847 struct tun_struct *tun = netdev_priv(dev);
849 tun->flags &= ~TUN_NOCHECKSUM;
851 tun->flags |= TUN_NOCHECKSUM;
855 static struct ethtool_ops tun_ethtool_ops = {
856 .get_settings = tun_get_settings,
857 .get_drvinfo = tun_get_drvinfo,
858 .get_msglevel = tun_get_msglevel,
859 .set_msglevel = tun_set_msglevel,
860 .get_link = tun_get_link,
861 .get_rx_csum = tun_get_rx_csum,
862 .set_rx_csum = tun_set_rx_csum
865 static int __init tun_init(void)
869 printk(KERN_INFO "tun: %s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
870 printk(KERN_INFO "tun: %s\n", DRV_COPYRIGHT);
872 ret = misc_register(&tun_miscdev);
874 printk(KERN_ERR "tun: Can't register misc device %d\n", TUN_MINOR);
878 static void tun_cleanup(void)
880 struct tun_struct *tun, *nxt;
882 misc_deregister(&tun_miscdev);
885 list_for_each_entry_safe(tun, nxt, &tun_dev_list, list) {
886 DBG(KERN_INFO "%s cleaned up\n", tun->dev->name);
887 unregister_netdevice(tun->dev);
893 module_init(tun_init);
894 module_exit(tun_cleanup);
895 MODULE_DESCRIPTION(DRV_DESCRIPTION);
896 MODULE_AUTHOR(DRV_COPYRIGHT);
897 MODULE_LICENSE("GPL");
898 MODULE_ALIAS_MISCDEV(TUN_MINOR);