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 DECLARE_MAC_BUF(mac);
163 DBG(KERN_DEBUG "%s: tun_net_mclist: mc_count %d\n",
164 dev->name, dev->mc_count);
165 memset(tun->chr_filter, 0, sizeof tun->chr_filter);
166 for (i = 0, mclist = dev->mc_list; i < dev->mc_count && mclist != NULL;
167 i++, mclist = mclist->next) {
168 add_multi(tun->net_filter, mclist->dmi_addr);
169 DBG(KERN_DEBUG "%s: tun_net_mclist: %s\n",
170 dev->name, print_mac(mac, mclist->dmi_addr));
175 #define MAX_MTU 65535
178 tun_net_change_mtu(struct net_device *dev, int new_mtu)
180 if (new_mtu < MIN_MTU || new_mtu + dev->hard_header_len > MAX_MTU)
186 /* Initialize net device. */
187 static void tun_net_init(struct net_device *dev)
189 struct tun_struct *tun = netdev_priv(dev);
191 switch (tun->flags & TUN_TYPE_MASK) {
193 /* Point-to-Point TUN Device */
194 dev->hard_header_len = 0;
197 dev->change_mtu = tun_net_change_mtu;
199 /* Zero header length */
200 dev->type = ARPHRD_NONE;
201 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
202 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
206 /* Ethernet TAP Device */
207 dev->set_multicast_list = tun_net_mclist;
210 dev->change_mtu = tun_net_change_mtu;
212 /* random address already created for us by tun_set_iff, use it */
213 memcpy(dev->dev_addr, tun->dev_addr, min(sizeof(tun->dev_addr), sizeof(dev->dev_addr)) );
215 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
220 /* Character device part */
223 static unsigned int tun_chr_poll(struct file *file, poll_table * wait)
225 struct tun_struct *tun = file->private_data;
226 unsigned int mask = POLLOUT | POLLWRNORM;
231 DBG(KERN_INFO "%s: tun_chr_poll\n", tun->dev->name);
233 poll_wait(file, &tun->read_wait, wait);
235 if (!skb_queue_empty(&tun->readq))
236 mask |= POLLIN | POLLRDNORM;
241 /* Get packet from user space buffer */
242 static __inline__ ssize_t tun_get_user(struct tun_struct *tun, struct iovec *iv, size_t count)
244 struct tun_pi pi = { 0, __constant_htons(ETH_P_IP) };
246 size_t len = count, align = 0;
248 if (!(tun->flags & TUN_NO_PI)) {
249 if ((len -= sizeof(pi)) > count)
252 if(memcpy_fromiovec((void *)&pi, iv, sizeof(pi)))
256 if ((tun->flags & TUN_TYPE_MASK) == TUN_TAP_DEV)
257 align = NET_IP_ALIGN;
259 if (!(skb = alloc_skb(len + align, GFP_KERNEL))) {
260 tun->dev->stats.rx_dropped++;
265 skb_reserve(skb, align);
266 if (memcpy_fromiovec(skb_put(skb, len), iv, len)) {
267 tun->dev->stats.rx_dropped++;
272 switch (tun->flags & TUN_TYPE_MASK) {
274 skb_reset_mac_header(skb);
275 skb->protocol = pi.proto;
279 skb->protocol = eth_type_trans(skb, tun->dev);
283 if (tun->flags & TUN_NOCHECKSUM)
284 skb->ip_summed = CHECKSUM_UNNECESSARY;
287 tun->dev->last_rx = jiffies;
289 tun->dev->stats.rx_packets++;
290 tun->dev->stats.rx_bytes += len;
295 static inline size_t iov_total(const struct iovec *iv, unsigned long count)
300 for (i = 0, len = 0; i < count; i++)
301 len += iv[i].iov_len;
306 static ssize_t tun_chr_aio_write(struct kiocb *iocb, const struct iovec *iv,
307 unsigned long count, loff_t pos)
309 struct tun_struct *tun = iocb->ki_filp->private_data;
314 DBG(KERN_INFO "%s: tun_chr_write %ld\n", tun->dev->name, count);
316 return tun_get_user(tun, (struct iovec *) iv, iov_total(iv, count));
319 /* Put packet to the user space buffer */
320 static __inline__ ssize_t tun_put_user(struct tun_struct *tun,
322 struct iovec *iv, int len)
324 struct tun_pi pi = { 0, skb->protocol };
327 if (!(tun->flags & TUN_NO_PI)) {
328 if ((len -= sizeof(pi)) < 0)
331 if (len < skb->len) {
332 /* Packet will be striped */
333 pi.flags |= TUN_PKT_STRIP;
336 if (memcpy_toiovec(iv, (void *) &pi, sizeof(pi)))
341 len = min_t(int, skb->len, len);
343 skb_copy_datagram_iovec(skb, 0, iv, len);
346 tun->dev->stats.tx_packets++;
347 tun->dev->stats.tx_bytes += len;
352 static ssize_t tun_chr_aio_read(struct kiocb *iocb, const struct iovec *iv,
353 unsigned long count, loff_t pos)
355 struct file *file = iocb->ki_filp;
356 struct tun_struct *tun = file->private_data;
357 DECLARE_WAITQUEUE(wait, current);
359 ssize_t len, ret = 0;
360 DECLARE_MAC_BUF(mac);
365 DBG(KERN_INFO "%s: tun_chr_read\n", tun->dev->name);
367 len = iov_total(iv, count);
371 add_wait_queue(&tun->read_wait, &wait);
373 const u8 ones[ ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
377 current->state = TASK_INTERRUPTIBLE;
379 /* Read frames from the queue */
380 if (!(skb=skb_dequeue(&tun->readq))) {
381 if (file->f_flags & O_NONBLOCK) {
385 if (signal_pending(current)) {
390 /* Nothing to read, let's sleep */
394 netif_wake_queue(tun->dev);
396 /** Decide whether to accept this packet. This code is designed to
397 * behave identically to an Ethernet interface. Accept the packet if
398 * - we are promiscuous.
399 * - the packet is addressed to us.
400 * - the packet is broadcast.
401 * - the packet is multicast and
402 * - we are multicast promiscous.
403 * - we belong to the multicast group.
405 skb_copy_from_linear_data(skb, addr, min_t(size_t, sizeof addr,
407 bit_nr = ether_crc(sizeof addr, addr) >> 26;
408 if ((tun->if_flags & IFF_PROMISC) ||
409 memcmp(addr, tun->dev_addr, sizeof addr) == 0 ||
410 memcmp(addr, ones, sizeof addr) == 0 ||
411 (((addr[0] == 1 && addr[1] == 0 && addr[2] == 0x5e) ||
412 (addr[0] == 0x33 && addr[1] == 0x33)) &&
413 ((tun->if_flags & IFF_ALLMULTI) ||
414 (tun->chr_filter[bit_nr >> 5] & (1 << (bit_nr & 31)))))) {
415 DBG(KERN_DEBUG "%s: tun_chr_readv: accepted: %s\n",
416 tun->dev->name, print_mac(mac, addr));
417 ret = tun_put_user(tun, skb, (struct iovec *) iv, len);
421 DBG(KERN_DEBUG "%s: tun_chr_readv: rejected: %s\n",
422 tun->dev->name, print_mac(mac, addr));
428 current->state = TASK_RUNNING;
429 remove_wait_queue(&tun->read_wait, &wait);
434 static void tun_setup(struct net_device *dev)
436 struct tun_struct *tun = netdev_priv(dev);
438 skb_queue_head_init(&tun->readq);
439 init_waitqueue_head(&tun->read_wait);
444 dev->open = tun_net_open;
445 dev->hard_start_xmit = tun_net_xmit;
446 dev->stop = tun_net_close;
447 dev->ethtool_ops = &tun_ethtool_ops;
448 dev->destructor = free_netdev;
451 static struct tun_struct *tun_get_by_name(const char *name)
453 struct tun_struct *tun;
456 list_for_each_entry(tun, &tun_dev_list, list) {
457 if (!strncmp(tun->dev->name, name, IFNAMSIZ))
464 static int tun_set_iff(struct file *file, struct ifreq *ifr)
466 struct tun_struct *tun;
467 struct net_device *dev;
470 tun = tun_get_by_name(ifr->ifr_name);
475 /* Check permissions */
476 if (((tun->owner != -1 &&
477 current->euid != tun->owner) ||
479 current->egid != tun->group)) &&
480 !capable(CAP_NET_ADMIN))
483 else if (__dev_get_by_name(&init_net, ifr->ifr_name))
487 unsigned long flags = 0;
491 if (!capable(CAP_NET_ADMIN))
495 if (ifr->ifr_flags & IFF_TUN) {
497 flags |= TUN_TUN_DEV;
499 } else if (ifr->ifr_flags & IFF_TAP) {
501 flags |= TUN_TAP_DEV;
507 name = ifr->ifr_name;
509 dev = alloc_netdev(sizeof(struct tun_struct), name,
514 tun = netdev_priv(dev);
517 /* Be promiscuous by default to maintain previous behaviour. */
518 tun->if_flags = IFF_PROMISC;
519 /* Generate random Ethernet address. */
520 *(u16 *)tun->dev_addr = htons(0x00FF);
521 get_random_bytes(tun->dev_addr + sizeof(u16), 4);
522 memset(tun->chr_filter, 0, sizeof tun->chr_filter);
526 if (strchr(dev->name, '%')) {
527 err = dev_alloc_name(dev, dev->name);
532 err = register_netdevice(tun->dev);
536 list_add(&tun->list, &tun_dev_list);
539 DBG(KERN_INFO "%s: tun_set_iff\n", tun->dev->name);
541 if (ifr->ifr_flags & IFF_NO_PI)
542 tun->flags |= TUN_NO_PI;
544 if (ifr->ifr_flags & IFF_ONE_QUEUE)
545 tun->flags |= TUN_ONE_QUEUE;
547 file->private_data = tun;
550 strcpy(ifr->ifr_name, tun->dev->name);
559 static int tun_chr_ioctl(struct inode *inode, struct file *file,
560 unsigned int cmd, unsigned long arg)
562 struct tun_struct *tun = file->private_data;
563 void __user* argp = (void __user*)arg;
565 DECLARE_MAC_BUF(mac);
567 if (cmd == TUNSETIFF || _IOC_TYPE(cmd) == 0x89)
568 if (copy_from_user(&ifr, argp, sizeof ifr))
571 if (cmd == TUNSETIFF && !tun) {
574 ifr.ifr_name[IFNAMSIZ-1] = '\0';
577 err = tun_set_iff(file, &ifr);
583 if (copy_to_user(argp, &ifr, sizeof(ifr)))
591 DBG(KERN_INFO "%s: tun_chr_ioctl cmd %d\n", tun->dev->name, cmd);
595 /* Disable/Enable checksum */
597 tun->flags |= TUN_NOCHECKSUM;
599 tun->flags &= ~TUN_NOCHECKSUM;
601 DBG(KERN_INFO "%s: checksum %s\n",
602 tun->dev->name, arg ? "disabled" : "enabled");
606 /* Disable/Enable persist mode */
608 tun->flags |= TUN_PERSIST;
610 tun->flags &= ~TUN_PERSIST;
612 DBG(KERN_INFO "%s: persist %s\n",
613 tun->dev->name, arg ? "disabled" : "enabled");
617 /* Set owner of the device */
618 tun->owner = (uid_t) arg;
620 DBG(KERN_INFO "%s: owner set to %d\n", tun->dev->name, tun->owner);
624 /* Set group of the device */
625 tun->group= (gid_t) arg;
627 DBG(KERN_INFO "%s: group set to %d\n", tun->dev->name, tun->group);
631 /* Only allow setting the type when the interface is down */
632 if (tun->dev->flags & IFF_UP) {
633 DBG(KERN_INFO "%s: Linktype set failed because interface is up\n",
637 tun->dev->type = (int) arg;
638 DBG(KERN_INFO "%s: linktype set to %d\n", tun->dev->name, tun->dev->type);
649 ifr.ifr_flags = tun->if_flags;
650 if (copy_to_user( argp, &ifr, sizeof ifr))
655 /** Set the character device's interface flags. Currently only
656 * IFF_PROMISC and IFF_ALLMULTI are used. */
657 tun->if_flags = ifr.ifr_flags;
658 DBG(KERN_INFO "%s: interface flags 0x%lx\n",
659 tun->dev->name, tun->if_flags);
663 /* Note: the actual net device's address may be different */
664 memcpy(ifr.ifr_hwaddr.sa_data, tun->dev_addr,
665 min(sizeof ifr.ifr_hwaddr.sa_data, sizeof tun->dev_addr));
666 if (copy_to_user( argp, &ifr, sizeof ifr))
672 /* try to set the actual net device's hw address */
673 int ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr);
676 /** Set the character device's hardware address. This is used when
677 * filtering packets being sent from the network device to the character
679 memcpy(tun->dev_addr, ifr.ifr_hwaddr.sa_data,
680 min(sizeof ifr.ifr_hwaddr.sa_data, sizeof tun->dev_addr));
681 DBG(KERN_DEBUG "%s: set hardware address: %x:%x:%x:%x:%x:%x\n",
683 tun->dev_addr[0], tun->dev_addr[1], tun->dev_addr[2],
684 tun->dev_addr[3], tun->dev_addr[4], tun->dev_addr[5]);
691 /** Add the specified group to the character device's multicast filter
693 add_multi(tun->chr_filter, ifr.ifr_hwaddr.sa_data);
694 DBG(KERN_DEBUG "%s: add multi: %s\n",
695 tun->dev->name, print_mac(mac, ifr.ifr_hwaddr.sa_data));
699 /** Remove the specified group from the character device's multicast
701 del_multi(tun->chr_filter, ifr.ifr_hwaddr.sa_data);
702 DBG(KERN_DEBUG "%s: del multi: %s\n",
703 tun->dev->name, print_mac(mac, ifr.ifr_hwaddr.sa_data));
713 static int tun_chr_fasync(int fd, struct file *file, int on)
715 struct tun_struct *tun = file->private_data;
721 DBG(KERN_INFO "%s: tun_chr_fasync %d\n", tun->dev->name, on);
723 if ((ret = fasync_helper(fd, file, on, &tun->fasync)) < 0)
727 ret = __f_setown(file, task_pid(current), PIDTYPE_PID, 0);
730 tun->flags |= TUN_FASYNC;
732 tun->flags &= ~TUN_FASYNC;
737 static int tun_chr_open(struct inode *inode, struct file * file)
739 DBG1(KERN_INFO "tunX: tun_chr_open\n");
740 file->private_data = NULL;
744 static int tun_chr_close(struct inode *inode, struct file *file)
746 struct tun_struct *tun = file->private_data;
751 DBG(KERN_INFO "%s: tun_chr_close\n", tun->dev->name);
753 tun_chr_fasync(-1, file, 0);
757 /* Detach from net device */
758 file->private_data = NULL;
761 /* Drop read queue */
762 skb_queue_purge(&tun->readq);
764 if (!(tun->flags & TUN_PERSIST)) {
765 list_del(&tun->list);
766 unregister_netdevice(tun->dev);
774 static const struct file_operations tun_fops = {
775 .owner = THIS_MODULE,
777 .read = do_sync_read,
778 .aio_read = tun_chr_aio_read,
779 .write = do_sync_write,
780 .aio_write = tun_chr_aio_write,
781 .poll = tun_chr_poll,
782 .ioctl = tun_chr_ioctl,
783 .open = tun_chr_open,
784 .release = tun_chr_close,
785 .fasync = tun_chr_fasync
788 static struct miscdevice tun_miscdev = {
794 /* ethtool interface */
796 static int tun_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
799 cmd->advertising = 0;
800 cmd->speed = SPEED_10;
801 cmd->duplex = DUPLEX_FULL;
803 cmd->phy_address = 0;
804 cmd->transceiver = XCVR_INTERNAL;
805 cmd->autoneg = AUTONEG_DISABLE;
811 static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
813 struct tun_struct *tun = netdev_priv(dev);
815 strcpy(info->driver, DRV_NAME);
816 strcpy(info->version, DRV_VERSION);
817 strcpy(info->fw_version, "N/A");
819 switch (tun->flags & TUN_TYPE_MASK) {
821 strcpy(info->bus_info, "tun");
824 strcpy(info->bus_info, "tap");
829 static u32 tun_get_msglevel(struct net_device *dev)
832 struct tun_struct *tun = netdev_priv(dev);
839 static void tun_set_msglevel(struct net_device *dev, u32 value)
842 struct tun_struct *tun = netdev_priv(dev);
847 static u32 tun_get_link(struct net_device *dev)
849 struct tun_struct *tun = netdev_priv(dev);
850 return tun->attached;
853 static u32 tun_get_rx_csum(struct net_device *dev)
855 struct tun_struct *tun = netdev_priv(dev);
856 return (tun->flags & TUN_NOCHECKSUM) == 0;
859 static int tun_set_rx_csum(struct net_device *dev, u32 data)
861 struct tun_struct *tun = netdev_priv(dev);
863 tun->flags &= ~TUN_NOCHECKSUM;
865 tun->flags |= TUN_NOCHECKSUM;
869 static const struct ethtool_ops tun_ethtool_ops = {
870 .get_settings = tun_get_settings,
871 .get_drvinfo = tun_get_drvinfo,
872 .get_msglevel = tun_get_msglevel,
873 .set_msglevel = tun_set_msglevel,
874 .get_link = tun_get_link,
875 .get_rx_csum = tun_get_rx_csum,
876 .set_rx_csum = tun_set_rx_csum
879 static int __init tun_init(void)
883 printk(KERN_INFO "tun: %s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
884 printk(KERN_INFO "tun: %s\n", DRV_COPYRIGHT);
886 ret = misc_register(&tun_miscdev);
888 printk(KERN_ERR "tun: Can't register misc device %d\n", TUN_MINOR);
892 static void tun_cleanup(void)
894 struct tun_struct *tun, *nxt;
896 misc_deregister(&tun_miscdev);
899 list_for_each_entry_safe(tun, nxt, &tun_dev_list, list) {
900 DBG(KERN_INFO "%s cleaned up\n", tun->dev->name);
901 unregister_netdevice(tun->dev);
907 module_init(tun_init);
908 module_exit(tun_cleanup);
909 MODULE_DESCRIPTION(DRV_DESCRIPTION);
910 MODULE_AUTHOR(DRV_COPYRIGHT);
911 MODULE_LICENSE("GPL");
912 MODULE_ALIAS_MISCDEV(TUN_MINOR);