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 * Brian Braunstein <linuxkernel@bristyle.com> 2007/03/23
22 * Fixed hw address handling. Now net_device.dev_addr is kept consistent
23 * with tun.dev_addr when the address is set by this module.
25 * Mike Kershaw <dragorn@kismetwireless.net> 2005/08/14
26 * Add TUNSETLINK ioctl to set the link encapsulation
28 * Mark Smith <markzzzsmith@yahoo.com.au>
29 * Use random_ether_addr() for tap MAC address.
31 * Harald Roelle <harald.roelle@ifi.lmu.de> 2004/04/20
32 * Fixes in packet dropping, queue length setting and queue wakeup.
33 * Increased default tx queue length.
37 * Daniel Podlejski <underley@underley.eu.org>
38 * Modifications for 2.3.99-pre5 kernel.
41 #define DRV_NAME "tun"
42 #define DRV_VERSION "1.6"
43 #define DRV_DESCRIPTION "Universal TUN/TAP device driver"
44 #define DRV_COPYRIGHT "(C) 1999-2004 Max Krasnyansky <maxk@qualcomm.com>"
46 #include <linux/module.h>
47 #include <linux/errno.h>
48 #include <linux/kernel.h>
49 #include <linux/major.h>
50 #include <linux/slab.h>
51 #include <linux/poll.h>
52 #include <linux/fcntl.h>
53 #include <linux/init.h>
54 #include <linux/skbuff.h>
55 #include <linux/netdevice.h>
56 #include <linux/etherdevice.h>
57 #include <linux/miscdevice.h>
58 #include <linux/ethtool.h>
59 #include <linux/rtnetlink.h>
61 #include <linux/if_arp.h>
62 #include <linux/if_ether.h>
63 #include <linux/if_tun.h>
64 #include <linux/crc32.h>
65 #include <net/net_namespace.h>
67 #include <asm/system.h>
68 #include <asm/uaccess.h>
74 /* Network device part of the driver */
76 static LIST_HEAD(tun_dev_list);
77 static const struct ethtool_ops tun_ethtool_ops;
79 /* Net device open. */
80 static int tun_net_open(struct net_device *dev)
82 netif_start_queue(dev);
86 /* Net device close. */
87 static int tun_net_close(struct net_device *dev)
89 netif_stop_queue(dev);
93 /* Net device start xmit */
94 static int tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
96 struct tun_struct *tun = netdev_priv(dev);
98 DBG(KERN_INFO "%s: tun_net_xmit %d\n", tun->dev->name, skb->len);
100 /* Drop packet if interface is not attached */
104 /* Packet dropping */
105 if (skb_queue_len(&tun->readq) >= dev->tx_queue_len) {
106 if (!(tun->flags & TUN_ONE_QUEUE)) {
107 /* Normal queueing mode. */
108 /* Packet scheduler handles dropping of further packets. */
109 netif_stop_queue(dev);
111 /* We won't see all dropped packets individually, so overrun
112 * error is more appropriate. */
113 dev->stats.tx_fifo_errors++;
115 /* Single queue mode.
116 * Driver handles dropping of all packets itself. */
122 skb_queue_tail(&tun->readq, skb);
123 dev->trans_start = jiffies;
125 /* Notify and wake up reader process */
126 if (tun->flags & TUN_FASYNC)
127 kill_fasync(&tun->fasync, SIGIO, POLL_IN);
128 wake_up_interruptible(&tun->read_wait);
132 dev->stats.tx_dropped++;
137 /** Add the specified Ethernet address to this multicast filter. */
139 add_multi(u32* filter, const u8* addr)
141 int bit_nr = ether_crc(ETH_ALEN, addr) >> 26;
142 filter[bit_nr >> 5] |= 1 << (bit_nr & 31);
145 /** Remove the specified Ethernet addres from this multicast filter. */
147 del_multi(u32* filter, const u8* addr)
149 int bit_nr = ether_crc(ETH_ALEN, addr) >> 26;
150 filter[bit_nr >> 5] &= ~(1 << (bit_nr & 31));
153 /** Update the list of multicast groups to which the network device belongs.
154 * This list is used to filter packets being sent from the character device to
155 * the network device. */
157 tun_net_mclist(struct net_device *dev)
159 struct tun_struct *tun = netdev_priv(dev);
160 const struct dev_mc_list *mclist;
162 DBG(KERN_DEBUG "%s: tun_net_mclist: mc_count %d\n",
163 dev->name, dev->mc_count);
164 memset(tun->chr_filter, 0, sizeof tun->chr_filter);
165 for (i = 0, mclist = dev->mc_list; i < dev->mc_count && mclist != NULL;
166 i++, mclist = mclist->next) {
167 add_multi(tun->net_filter, mclist->dmi_addr);
168 DBG(KERN_DEBUG "%s: tun_net_mclist: %x:%x:%x:%x:%x:%x\n",
170 mclist->dmi_addr[0], mclist->dmi_addr[1], mclist->dmi_addr[2],
171 mclist->dmi_addr[3], mclist->dmi_addr[4], mclist->dmi_addr[5]);
175 /* Initialize net device. */
176 static void tun_net_init(struct net_device *dev)
178 struct tun_struct *tun = netdev_priv(dev);
180 switch (tun->flags & TUN_TYPE_MASK) {
182 /* Point-to-Point TUN Device */
183 dev->hard_header_len = 0;
187 /* Zero header length */
188 dev->type = ARPHRD_NONE;
189 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
190 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
194 /* Ethernet TAP Device */
195 dev->set_multicast_list = tun_net_mclist;
199 /* random address already created for us by tun_set_iff, use it */
200 memcpy(dev->dev_addr, tun->dev_addr, min(sizeof(tun->dev_addr), sizeof(dev->dev_addr)) );
202 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
207 /* Character device part */
210 static unsigned int tun_chr_poll(struct file *file, poll_table * wait)
212 struct tun_struct *tun = file->private_data;
213 unsigned int mask = POLLOUT | POLLWRNORM;
218 DBG(KERN_INFO "%s: tun_chr_poll\n", tun->dev->name);
220 poll_wait(file, &tun->read_wait, wait);
222 if (!skb_queue_empty(&tun->readq))
223 mask |= POLLIN | POLLRDNORM;
228 /* Get packet from user space buffer */
229 static __inline__ ssize_t tun_get_user(struct tun_struct *tun, struct iovec *iv, size_t count)
231 struct tun_pi pi = { 0, __constant_htons(ETH_P_IP) };
233 size_t len = count, align = 0;
235 if (!(tun->flags & TUN_NO_PI)) {
236 if ((len -= sizeof(pi)) > count)
239 if(memcpy_fromiovec((void *)&pi, iv, sizeof(pi)))
243 if ((tun->flags & TUN_TYPE_MASK) == TUN_TAP_DEV)
244 align = NET_IP_ALIGN;
246 if (!(skb = alloc_skb(len + align, GFP_KERNEL))) {
247 tun->dev->stats.rx_dropped++;
252 skb_reserve(skb, align);
253 if (memcpy_fromiovec(skb_put(skb, len), iv, len)) {
254 tun->dev->stats.rx_dropped++;
259 switch (tun->flags & TUN_TYPE_MASK) {
261 skb_reset_mac_header(skb);
262 skb->protocol = pi.proto;
266 skb->protocol = eth_type_trans(skb, tun->dev);
270 if (tun->flags & TUN_NOCHECKSUM)
271 skb->ip_summed = CHECKSUM_UNNECESSARY;
274 tun->dev->last_rx = jiffies;
276 tun->dev->stats.rx_packets++;
277 tun->dev->stats.rx_bytes += len;
282 static inline size_t iov_total(const struct iovec *iv, unsigned long count)
287 for (i = 0, len = 0; i < count; i++)
288 len += iv[i].iov_len;
293 static ssize_t tun_chr_aio_write(struct kiocb *iocb, const struct iovec *iv,
294 unsigned long count, loff_t pos)
296 struct tun_struct *tun = iocb->ki_filp->private_data;
301 DBG(KERN_INFO "%s: tun_chr_write %ld\n", tun->dev->name, count);
303 return tun_get_user(tun, (struct iovec *) iv, iov_total(iv, count));
306 /* Put packet to the user space buffer */
307 static __inline__ ssize_t tun_put_user(struct tun_struct *tun,
309 struct iovec *iv, int len)
311 struct tun_pi pi = { 0, skb->protocol };
314 if (!(tun->flags & TUN_NO_PI)) {
315 if ((len -= sizeof(pi)) < 0)
318 if (len < skb->len) {
319 /* Packet will be striped */
320 pi.flags |= TUN_PKT_STRIP;
323 if (memcpy_toiovec(iv, (void *) &pi, sizeof(pi)))
328 len = min_t(int, skb->len, len);
330 skb_copy_datagram_iovec(skb, 0, iv, len);
333 tun->dev->stats.tx_packets++;
334 tun->dev->stats.tx_bytes += len;
339 static ssize_t tun_chr_aio_read(struct kiocb *iocb, const struct iovec *iv,
340 unsigned long count, loff_t pos)
342 struct file *file = iocb->ki_filp;
343 struct tun_struct *tun = file->private_data;
344 DECLARE_WAITQUEUE(wait, current);
346 ssize_t len, ret = 0;
351 DBG(KERN_INFO "%s: tun_chr_read\n", tun->dev->name);
353 len = iov_total(iv, count);
357 add_wait_queue(&tun->read_wait, &wait);
359 const u8 ones[ ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
363 current->state = TASK_INTERRUPTIBLE;
365 /* Read frames from the queue */
366 if (!(skb=skb_dequeue(&tun->readq))) {
367 if (file->f_flags & O_NONBLOCK) {
371 if (signal_pending(current)) {
376 /* Nothing to read, let's sleep */
380 netif_wake_queue(tun->dev);
382 /** Decide whether to accept this packet. This code is designed to
383 * behave identically to an Ethernet interface. Accept the packet if
384 * - we are promiscuous.
385 * - the packet is addressed to us.
386 * - the packet is broadcast.
387 * - the packet is multicast and
388 * - we are multicast promiscous.
389 * - we belong to the multicast group.
391 skb_copy_from_linear_data(skb, addr, min_t(size_t, sizeof addr,
393 bit_nr = ether_crc(sizeof addr, addr) >> 26;
394 if ((tun->if_flags & IFF_PROMISC) ||
395 memcmp(addr, tun->dev_addr, sizeof addr) == 0 ||
396 memcmp(addr, ones, sizeof addr) == 0 ||
397 (((addr[0] == 1 && addr[1] == 0 && addr[2] == 0x5e) ||
398 (addr[0] == 0x33 && addr[1] == 0x33)) &&
399 ((tun->if_flags & IFF_ALLMULTI) ||
400 (tun->chr_filter[bit_nr >> 5] & (1 << (bit_nr & 31)))))) {
401 DBG(KERN_DEBUG "%s: tun_chr_readv: accepted: %x:%x:%x:%x:%x:%x\n",
402 tun->dev->name, addr[0], addr[1], addr[2],
403 addr[3], addr[4], addr[5]);
404 ret = tun_put_user(tun, skb, (struct iovec *) iv, len);
408 DBG(KERN_DEBUG "%s: tun_chr_readv: rejected: %x:%x:%x:%x:%x:%x\n",
409 tun->dev->name, addr[0], addr[1], addr[2],
410 addr[3], addr[4], addr[5]);
416 current->state = TASK_RUNNING;
417 remove_wait_queue(&tun->read_wait, &wait);
422 static void tun_setup(struct net_device *dev)
424 struct tun_struct *tun = netdev_priv(dev);
426 skb_queue_head_init(&tun->readq);
427 init_waitqueue_head(&tun->read_wait);
432 dev->open = tun_net_open;
433 dev->hard_start_xmit = tun_net_xmit;
434 dev->stop = tun_net_close;
435 dev->ethtool_ops = &tun_ethtool_ops;
436 dev->destructor = free_netdev;
439 static struct tun_struct *tun_get_by_name(const char *name)
441 struct tun_struct *tun;
444 list_for_each_entry(tun, &tun_dev_list, list) {
445 if (!strncmp(tun->dev->name, name, IFNAMSIZ))
452 static int tun_set_iff(struct file *file, struct ifreq *ifr)
454 struct tun_struct *tun;
455 struct net_device *dev;
458 tun = tun_get_by_name(ifr->ifr_name);
463 /* Check permissions */
464 if (((tun->owner != -1 &&
465 current->euid != tun->owner) ||
467 current->egid != tun->group)) &&
468 !capable(CAP_NET_ADMIN))
471 else if (__dev_get_by_name(&init_net, ifr->ifr_name))
475 unsigned long flags = 0;
479 if (!capable(CAP_NET_ADMIN))
483 if (ifr->ifr_flags & IFF_TUN) {
485 flags |= TUN_TUN_DEV;
487 } else if (ifr->ifr_flags & IFF_TAP) {
489 flags |= TUN_TAP_DEV;
495 name = ifr->ifr_name;
497 dev = alloc_netdev(sizeof(struct tun_struct), name,
502 tun = netdev_priv(dev);
505 /* Be promiscuous by default to maintain previous behaviour. */
506 tun->if_flags = IFF_PROMISC;
507 /* Generate random Ethernet address. */
508 *(u16 *)tun->dev_addr = htons(0x00FF);
509 get_random_bytes(tun->dev_addr + sizeof(u16), 4);
510 memset(tun->chr_filter, 0, sizeof tun->chr_filter);
514 if (strchr(dev->name, '%')) {
515 err = dev_alloc_name(dev, dev->name);
520 err = register_netdevice(tun->dev);
524 list_add(&tun->list, &tun_dev_list);
527 DBG(KERN_INFO "%s: tun_set_iff\n", tun->dev->name);
529 if (ifr->ifr_flags & IFF_NO_PI)
530 tun->flags |= TUN_NO_PI;
532 if (ifr->ifr_flags & IFF_ONE_QUEUE)
533 tun->flags |= TUN_ONE_QUEUE;
535 file->private_data = tun;
538 strcpy(ifr->ifr_name, tun->dev->name);
547 static int tun_chr_ioctl(struct inode *inode, struct file *file,
548 unsigned int cmd, unsigned long arg)
550 struct tun_struct *tun = file->private_data;
551 void __user* argp = (void __user*)arg;
554 if (cmd == TUNSETIFF || _IOC_TYPE(cmd) == 0x89)
555 if (copy_from_user(&ifr, argp, sizeof ifr))
558 if (cmd == TUNSETIFF && !tun) {
561 ifr.ifr_name[IFNAMSIZ-1] = '\0';
564 err = tun_set_iff(file, &ifr);
570 if (copy_to_user(argp, &ifr, sizeof(ifr)))
578 DBG(KERN_INFO "%s: tun_chr_ioctl cmd %d\n", tun->dev->name, cmd);
582 /* Disable/Enable checksum */
584 tun->flags |= TUN_NOCHECKSUM;
586 tun->flags &= ~TUN_NOCHECKSUM;
588 DBG(KERN_INFO "%s: checksum %s\n",
589 tun->dev->name, arg ? "disabled" : "enabled");
593 /* Disable/Enable persist mode */
595 tun->flags |= TUN_PERSIST;
597 tun->flags &= ~TUN_PERSIST;
599 DBG(KERN_INFO "%s: persist %s\n",
600 tun->dev->name, arg ? "disabled" : "enabled");
604 /* Set owner of the device */
605 tun->owner = (uid_t) arg;
607 DBG(KERN_INFO "%s: owner set to %d\n", tun->dev->name, tun->owner);
611 /* Set group of the device */
612 tun->group= (gid_t) arg;
614 DBG(KERN_INFO "%s: group set to %d\n", tun->dev->name, tun->group);
618 /* Only allow setting the type when the interface is down */
619 if (tun->dev->flags & IFF_UP) {
620 DBG(KERN_INFO "%s: Linktype set failed because interface is up\n",
624 tun->dev->type = (int) arg;
625 DBG(KERN_INFO "%s: linktype set to %d\n", tun->dev->name, tun->dev->type);
636 ifr.ifr_flags = tun->if_flags;
637 if (copy_to_user( argp, &ifr, sizeof ifr))
642 /** Set the character device's interface flags. Currently only
643 * IFF_PROMISC and IFF_ALLMULTI are used. */
644 tun->if_flags = ifr.ifr_flags;
645 DBG(KERN_INFO "%s: interface flags 0x%lx\n",
646 tun->dev->name, tun->if_flags);
650 /* Note: the actual net device's address may be different */
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))
659 /* try to set the actual net device's hw address */
660 int ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr);
663 /** Set the character device's hardware address. This is used when
664 * filtering packets being sent from the network device to the character
666 memcpy(tun->dev_addr, ifr.ifr_hwaddr.sa_data,
667 min(sizeof ifr.ifr_hwaddr.sa_data, sizeof tun->dev_addr));
668 DBG(KERN_DEBUG "%s: set hardware address: %x:%x:%x:%x:%x:%x\n",
670 tun->dev_addr[0], tun->dev_addr[1], tun->dev_addr[2],
671 tun->dev_addr[3], tun->dev_addr[4], tun->dev_addr[5]);
678 /** Add the specified group to the character device's multicast filter
680 add_multi(tun->chr_filter, ifr.ifr_hwaddr.sa_data);
681 DBG(KERN_DEBUG "%s: add multi: %x:%x:%x:%x:%x:%x\n",
683 (u8)ifr.ifr_hwaddr.sa_data[0], (u8)ifr.ifr_hwaddr.sa_data[1],
684 (u8)ifr.ifr_hwaddr.sa_data[2], (u8)ifr.ifr_hwaddr.sa_data[3],
685 (u8)ifr.ifr_hwaddr.sa_data[4], (u8)ifr.ifr_hwaddr.sa_data[5]);
689 /** Remove the specified group from the character device's multicast
691 del_multi(tun->chr_filter, ifr.ifr_hwaddr.sa_data);
692 DBG(KERN_DEBUG "%s: del multi: %x:%x:%x:%x:%x:%x\n",
694 (u8)ifr.ifr_hwaddr.sa_data[0], (u8)ifr.ifr_hwaddr.sa_data[1],
695 (u8)ifr.ifr_hwaddr.sa_data[2], (u8)ifr.ifr_hwaddr.sa_data[3],
696 (u8)ifr.ifr_hwaddr.sa_data[4], (u8)ifr.ifr_hwaddr.sa_data[5]);
706 static int tun_chr_fasync(int fd, struct file *file, int on)
708 struct tun_struct *tun = file->private_data;
714 DBG(KERN_INFO "%s: tun_chr_fasync %d\n", tun->dev->name, on);
716 if ((ret = fasync_helper(fd, file, on, &tun->fasync)) < 0)
720 ret = __f_setown(file, task_pid(current), PIDTYPE_PID, 0);
723 tun->flags |= TUN_FASYNC;
725 tun->flags &= ~TUN_FASYNC;
730 static int tun_chr_open(struct inode *inode, struct file * file)
732 DBG1(KERN_INFO "tunX: tun_chr_open\n");
733 file->private_data = NULL;
737 static int tun_chr_close(struct inode *inode, struct file *file)
739 struct tun_struct *tun = file->private_data;
744 DBG(KERN_INFO "%s: tun_chr_close\n", tun->dev->name);
746 tun_chr_fasync(-1, file, 0);
750 /* Detach from net device */
751 file->private_data = NULL;
754 /* Drop read queue */
755 skb_queue_purge(&tun->readq);
757 if (!(tun->flags & TUN_PERSIST)) {
758 list_del(&tun->list);
759 unregister_netdevice(tun->dev);
767 static const struct file_operations tun_fops = {
768 .owner = THIS_MODULE,
770 .read = do_sync_read,
771 .aio_read = tun_chr_aio_read,
772 .write = do_sync_write,
773 .aio_write = tun_chr_aio_write,
774 .poll = tun_chr_poll,
775 .ioctl = tun_chr_ioctl,
776 .open = tun_chr_open,
777 .release = tun_chr_close,
778 .fasync = tun_chr_fasync
781 static struct miscdevice tun_miscdev = {
787 /* ethtool interface */
789 static int tun_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
792 cmd->advertising = 0;
793 cmd->speed = SPEED_10;
794 cmd->duplex = DUPLEX_FULL;
796 cmd->phy_address = 0;
797 cmd->transceiver = XCVR_INTERNAL;
798 cmd->autoneg = AUTONEG_DISABLE;
804 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
806 struct tun_struct *tun = netdev_priv(dev);
808 strcpy(info->driver, DRV_NAME);
809 strcpy(info->version, DRV_VERSION);
810 strcpy(info->fw_version, "N/A");
812 switch (tun->flags & TUN_TYPE_MASK) {
814 strcpy(info->bus_info, "tun");
817 strcpy(info->bus_info, "tap");
822 static u32 tun_get_msglevel(struct net_device *dev)
825 struct tun_struct *tun = netdev_priv(dev);
832 static void tun_set_msglevel(struct net_device *dev, u32 value)
835 struct tun_struct *tun = netdev_priv(dev);
840 static u32 tun_get_link(struct net_device *dev)
842 struct tun_struct *tun = netdev_priv(dev);
843 return tun->attached;
846 static u32 tun_get_rx_csum(struct net_device *dev)
848 struct tun_struct *tun = netdev_priv(dev);
849 return (tun->flags & TUN_NOCHECKSUM) == 0;
852 static int tun_set_rx_csum(struct net_device *dev, u32 data)
854 struct tun_struct *tun = netdev_priv(dev);
856 tun->flags &= ~TUN_NOCHECKSUM;
858 tun->flags |= TUN_NOCHECKSUM;
862 static const struct ethtool_ops tun_ethtool_ops = {
863 .get_settings = tun_get_settings,
864 .get_drvinfo = tun_get_drvinfo,
865 .get_msglevel = tun_get_msglevel,
866 .set_msglevel = tun_set_msglevel,
867 .get_link = tun_get_link,
868 .get_rx_csum = tun_get_rx_csum,
869 .set_rx_csum = tun_set_rx_csum
872 static int __init tun_init(void)
876 printk(KERN_INFO "tun: %s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
877 printk(KERN_INFO "tun: %s\n", DRV_COPYRIGHT);
879 ret = misc_register(&tun_miscdev);
881 printk(KERN_ERR "tun: Can't register misc device %d\n", TUN_MINOR);
885 static void tun_cleanup(void)
887 struct tun_struct *tun, *nxt;
889 misc_deregister(&tun_miscdev);
892 list_for_each_entry_safe(tun, nxt, &tun_dev_list, list) {
893 DBG(KERN_INFO "%s cleaned up\n", tun->dev->name);
894 unregister_netdevice(tun->dev);
900 module_init(tun_init);
901 module_exit(tun_cleanup);
902 MODULE_DESCRIPTION(DRV_DESCRIPTION);
903 MODULE_AUTHOR(DRV_COPYRIGHT);
904 MODULE_LICENSE("GPL");
905 MODULE_ALIAS_MISCDEV(TUN_MINOR);