blob: b9018bfa0a9724d2a28ee54d9f9af50429c55da0 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * TUN - Universal TUN/TAP device driver.
3 * Copyright (C) 1999-2002 Maxim Krasnyansky <maxk@qualcomm.com>
4 *
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.
9 *
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.
14 *
15 * $Id: tun.c,v 1.15 2002/03/01 02:44:24 maxk Exp $
16 */
17
18/*
19 * Changes:
20 *
Brian Braunstein36226a82007-04-26 01:00:55 -070021 * 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.
24 *
Mike Kershawff4cc3a2005-09-01 17:40:05 -070025 * Mike Kershaw <dragorn@kismetwireless.net> 2005/08/14
26 * Add TUNSETLINK ioctl to set the link encapsulation
27 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 * Mark Smith <markzzzsmith@yahoo.com.au>
29 * Use random_ether_addr() for tap MAC address.
30 *
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.
34 * Added ethtool API.
35 * Minor cleanups
36 *
37 * Daniel Podlejski <underley@underley.eu.org>
38 * Modifications for 2.3.99-pre5 kernel.
39 */
40
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>"
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#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>
60#include <linux/if.h>
61#include <linux/if_arp.h>
62#include <linux/if_ether.h>
63#include <linux/if_tun.h>
64#include <linux/crc32.h>
Pavel Emelyanovd647a592008-04-16 00:41:16 -070065#include <linux/nsproxy.h>
Eric W. Biederman881d9662007-09-17 11:56:21 -070066#include <net/net_namespace.h>
Pavel Emelyanov79d17602008-04-16 00:40:46 -070067#include <net/netns/generic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69#include <asm/system.h>
70#include <asm/uaccess.h>
71
Rusty Russell14daa022008-04-12 18:48:58 -070072/* Uncomment to enable debugging */
73/* #define TUN_DEBUG 1 */
74
Linus Torvalds1da177e2005-04-16 15:20:36 -070075#ifdef TUN_DEBUG
76static int debug;
Rusty Russell14daa022008-04-12 18:48:58 -070077
78#define DBG if(tun->debug)printk
79#define DBG1 if(debug==2)printk
80#else
81#define DBG( a... )
82#define DBG1( a... )
Linus Torvalds1da177e2005-04-16 15:20:36 -070083#endif
84
Rusty Russell14daa022008-04-12 18:48:58 -070085struct tun_struct {
86 struct list_head list;
87 unsigned long flags;
88 int attached;
89 uid_t owner;
90 gid_t group;
91
92 wait_queue_head_t read_wait;
93 struct sk_buff_head readq;
94
95 struct net_device *dev;
96
97 struct fasync_struct *fasync;
98
99 unsigned long if_flags;
100 u8 dev_addr[ETH_ALEN];
101 u32 chr_filter[2];
102 u32 net_filter[2];
103
104#ifdef TUN_DEBUG
105 int debug;
106#endif
107};
108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109/* Network device part of the driver */
110
Pavel Emelyanov79d17602008-04-16 00:40:46 -0700111static unsigned int tun_net_id;
112struct tun_net {
113 struct list_head dev_list;
114};
115
Jeff Garzik7282d492006-09-13 14:30:00 -0400116static const struct ethtool_ops tun_ethtool_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
118/* Net device open. */
119static int tun_net_open(struct net_device *dev)
120{
121 netif_start_queue(dev);
122 return 0;
123}
124
125/* Net device close. */
126static int tun_net_close(struct net_device *dev)
127{
128 netif_stop_queue(dev);
129 return 0;
130}
131
132/* Net device start xmit */
133static int tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
134{
135 struct tun_struct *tun = netdev_priv(dev);
136
137 DBG(KERN_INFO "%s: tun_net_xmit %d\n", tun->dev->name, skb->len);
138
139 /* Drop packet if interface is not attached */
140 if (!tun->attached)
141 goto drop;
142
143 /* Packet dropping */
144 if (skb_queue_len(&tun->readq) >= dev->tx_queue_len) {
145 if (!(tun->flags & TUN_ONE_QUEUE)) {
146 /* Normal queueing mode. */
147 /* Packet scheduler handles dropping of further packets. */
148 netif_stop_queue(dev);
149
150 /* We won't see all dropped packets individually, so overrun
151 * error is more appropriate. */
Jeff Garzik09f75cd2007-10-03 17:41:50 -0700152 dev->stats.tx_fifo_errors++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 } else {
154 /* Single queue mode.
155 * Driver handles dropping of all packets itself. */
156 goto drop;
157 }
158 }
159
160 /* Queue packet */
161 skb_queue_tail(&tun->readq, skb);
162 dev->trans_start = jiffies;
163
164 /* Notify and wake up reader process */
165 if (tun->flags & TUN_FASYNC)
166 kill_fasync(&tun->fasync, SIGIO, POLL_IN);
167 wake_up_interruptible(&tun->read_wait);
168 return 0;
169
170drop:
Jeff Garzik09f75cd2007-10-03 17:41:50 -0700171 dev->stats.tx_dropped++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 kfree_skb(skb);
173 return 0;
174}
175
176/** Add the specified Ethernet address to this multicast filter. */
177static void
178add_multi(u32* filter, const u8* addr)
179{
180 int bit_nr = ether_crc(ETH_ALEN, addr) >> 26;
181 filter[bit_nr >> 5] |= 1 << (bit_nr & 31);
182}
183
184/** Remove the specified Ethernet addres from this multicast filter. */
185static void
186del_multi(u32* filter, const u8* addr)
187{
188 int bit_nr = ether_crc(ETH_ALEN, addr) >> 26;
189 filter[bit_nr >> 5] &= ~(1 << (bit_nr & 31));
190}
191
192/** Update the list of multicast groups to which the network device belongs.
193 * This list is used to filter packets being sent from the character device to
194 * the network device. */
195static void
196tun_net_mclist(struct net_device *dev)
197{
198 struct tun_struct *tun = netdev_priv(dev);
199 const struct dev_mc_list *mclist;
200 int i;
Joe Perches0795af52007-10-03 17:59:30 -0700201 DECLARE_MAC_BUF(mac);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 DBG(KERN_DEBUG "%s: tun_net_mclist: mc_count %d\n",
203 dev->name, dev->mc_count);
204 memset(tun->chr_filter, 0, sizeof tun->chr_filter);
205 for (i = 0, mclist = dev->mc_list; i < dev->mc_count && mclist != NULL;
206 i++, mclist = mclist->next) {
207 add_multi(tun->net_filter, mclist->dmi_addr);
Joe Perches0795af52007-10-03 17:59:30 -0700208 DBG(KERN_DEBUG "%s: tun_net_mclist: %s\n",
209 dev->name, print_mac(mac, mclist->dmi_addr));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 }
211}
212
Ed Swierk4885a502007-09-16 12:21:38 -0700213#define MIN_MTU 68
214#define MAX_MTU 65535
215
216static int
217tun_net_change_mtu(struct net_device *dev, int new_mtu)
218{
219 if (new_mtu < MIN_MTU || new_mtu + dev->hard_header_len > MAX_MTU)
220 return -EINVAL;
221 dev->mtu = new_mtu;
222 return 0;
223}
224
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225/* Initialize net device. */
226static void tun_net_init(struct net_device *dev)
227{
228 struct tun_struct *tun = netdev_priv(dev);
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400229
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 switch (tun->flags & TUN_TYPE_MASK) {
231 case TUN_TUN_DEV:
232 /* Point-to-Point TUN Device */
233 dev->hard_header_len = 0;
234 dev->addr_len = 0;
235 dev->mtu = 1500;
Ed Swierk4885a502007-09-16 12:21:38 -0700236 dev->change_mtu = tun_net_change_mtu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
238 /* Zero header length */
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400239 dev->type = ARPHRD_NONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
241 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
242 break;
243
244 case TUN_TAP_DEV:
245 /* Ethernet TAP Device */
246 dev->set_multicast_list = tun_net_mclist;
247
248 ether_setup(dev);
Ed Swierk4885a502007-09-16 12:21:38 -0700249 dev->change_mtu = tun_net_change_mtu;
Brian Braunstein36226a82007-04-26 01:00:55 -0700250
251 /* random address already created for us by tun_set_iff, use it */
252 memcpy(dev->dev_addr, tun->dev_addr, min(sizeof(tun->dev_addr), sizeof(dev->dev_addr)) );
253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 dev->tx_queue_len = TUN_READQ_SIZE; /* We prefer our own queue length */
255 break;
256 }
257}
258
259/* Character device part */
260
261/* Poll */
262static unsigned int tun_chr_poll(struct file *file, poll_table * wait)
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400263{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 struct tun_struct *tun = file->private_data;
265 unsigned int mask = POLLOUT | POLLWRNORM;
266
267 if (!tun)
268 return -EBADFD;
269
270 DBG(KERN_INFO "%s: tun_chr_poll\n", tun->dev->name);
271
272 poll_wait(file, &tun->read_wait, wait);
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400273
David S. Millerb03efcf2005-07-08 14:57:23 -0700274 if (!skb_queue_empty(&tun->readq))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 mask |= POLLIN | POLLRDNORM;
276
277 return mask;
278}
279
280/* Get packet from user space buffer */
281static __inline__ ssize_t tun_get_user(struct tun_struct *tun, struct iovec *iv, size_t count)
282{
283 struct tun_pi pi = { 0, __constant_htons(ETH_P_IP) };
284 struct sk_buff *skb;
285 size_t len = count, align = 0;
286
287 if (!(tun->flags & TUN_NO_PI)) {
288 if ((len -= sizeof(pi)) > count)
289 return -EINVAL;
290
291 if(memcpy_fromiovec((void *)&pi, iv, sizeof(pi)))
292 return -EFAULT;
293 }
294
Rusty Russelle01bf1c2008-04-12 18:49:30 -0700295 if ((tun->flags & TUN_TYPE_MASK) == TUN_TAP_DEV) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 align = NET_IP_ALIGN;
Rusty Russelle01bf1c2008-04-12 18:49:30 -0700297 if (unlikely(len < ETH_HLEN))
298 return -EINVAL;
299 }
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 if (!(skb = alloc_skb(len + align, GFP_KERNEL))) {
Jeff Garzik09f75cd2007-10-03 17:41:50 -0700302 tun->dev->stats.rx_dropped++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 return -ENOMEM;
304 }
305
306 if (align)
307 skb_reserve(skb, align);
Dave Jones8f227572006-03-11 18:49:13 -0800308 if (memcpy_fromiovec(skb_put(skb, len), iv, len)) {
Jeff Garzik09f75cd2007-10-03 17:41:50 -0700309 tun->dev->stats.rx_dropped++;
Dave Jones8f227572006-03-11 18:49:13 -0800310 kfree_skb(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 return -EFAULT;
Dave Jones8f227572006-03-11 18:49:13 -0800312 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 switch (tun->flags & TUN_TYPE_MASK) {
315 case TUN_TUN_DEV:
Ang Way Chuangf09f7ee2008-06-17 21:10:33 -0700316 if (tun->flags & TUN_NO_PI) {
317 switch (skb->data[0] & 0xf0) {
318 case 0x40:
319 pi.proto = htons(ETH_P_IP);
320 break;
321 case 0x60:
322 pi.proto = htons(ETH_P_IPV6);
323 break;
324 default:
325 tun->dev->stats.rx_dropped++;
326 kfree_skb(skb);
327 return -EINVAL;
328 }
329 }
330
Arnaldo Carvalho de Melo459a98e2007-03-19 15:30:44 -0700331 skb_reset_mac_header(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 skb->protocol = pi.proto;
Arnaldo Carvalho de Melo4c13eb62007-04-25 17:40:23 -0700333 skb->dev = tun->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 break;
335 case TUN_TAP_DEV:
336 skb->protocol = eth_type_trans(skb, tun->dev);
337 break;
338 };
339
340 if (tun->flags & TUN_NOCHECKSUM)
341 skb->ip_summed = CHECKSUM_UNNECESSARY;
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400342
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 netif_rx_ni(skb);
344 tun->dev->last_rx = jiffies;
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400345
Jeff Garzik09f75cd2007-10-03 17:41:50 -0700346 tun->dev->stats.rx_packets++;
347 tun->dev->stats.rx_bytes += len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 return count;
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400350}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
Badari Pulavartyee0b3e62006-09-30 23:28:47 -0700352static ssize_t tun_chr_aio_write(struct kiocb *iocb, const struct iovec *iv,
353 unsigned long count, loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354{
Badari Pulavartyee0b3e62006-09-30 23:28:47 -0700355 struct tun_struct *tun = iocb->ki_filp->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
357 if (!tun)
358 return -EBADFD;
359
360 DBG(KERN_INFO "%s: tun_chr_write %ld\n", tun->dev->name, count);
361
Akinobu Mita52427c92007-11-19 22:46:51 -0800362 return tun_get_user(tun, (struct iovec *) iv, iov_length(iv, count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363}
364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365/* Put packet to the user space buffer */
366static __inline__ ssize_t tun_put_user(struct tun_struct *tun,
367 struct sk_buff *skb,
368 struct iovec *iv, int len)
369{
370 struct tun_pi pi = { 0, skb->protocol };
371 ssize_t total = 0;
372
373 if (!(tun->flags & TUN_NO_PI)) {
374 if ((len -= sizeof(pi)) < 0)
375 return -EINVAL;
376
377 if (len < skb->len) {
378 /* Packet will be striped */
379 pi.flags |= TUN_PKT_STRIP;
380 }
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400381
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 if (memcpy_toiovec(iv, (void *) &pi, sizeof(pi)))
383 return -EFAULT;
384 total += sizeof(pi);
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400385 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
387 len = min_t(int, skb->len, len);
388
389 skb_copy_datagram_iovec(skb, 0, iv, len);
390 total += len;
391
Jeff Garzik09f75cd2007-10-03 17:41:50 -0700392 tun->dev->stats.tx_packets++;
393 tun->dev->stats.tx_bytes += len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395 return total;
396}
397
Badari Pulavartyee0b3e62006-09-30 23:28:47 -0700398static ssize_t tun_chr_aio_read(struct kiocb *iocb, const struct iovec *iv,
399 unsigned long count, loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400{
Badari Pulavartyee0b3e62006-09-30 23:28:47 -0700401 struct file *file = iocb->ki_filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 struct tun_struct *tun = file->private_data;
403 DECLARE_WAITQUEUE(wait, current);
404 struct sk_buff *skb;
405 ssize_t len, ret = 0;
Joe Perches0795af52007-10-03 17:59:30 -0700406 DECLARE_MAC_BUF(mac);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
408 if (!tun)
409 return -EBADFD;
410
411 DBG(KERN_INFO "%s: tun_chr_read\n", tun->dev->name);
412
Akinobu Mita52427c92007-11-19 22:46:51 -0800413 len = iov_length(iv, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 if (len < 0)
415 return -EINVAL;
416
417 add_wait_queue(&tun->read_wait, &wait);
418 while (len) {
419 const u8 ones[ ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
420 u8 addr[ ETH_ALEN];
421 int bit_nr;
422
423 current->state = TASK_INTERRUPTIBLE;
424
425 /* Read frames from the queue */
426 if (!(skb=skb_dequeue(&tun->readq))) {
427 if (file->f_flags & O_NONBLOCK) {
428 ret = -EAGAIN;
429 break;
430 }
431 if (signal_pending(current)) {
432 ret = -ERESTARTSYS;
433 break;
434 }
435
436 /* Nothing to read, let's sleep */
437 schedule();
438 continue;
439 }
440 netif_wake_queue(tun->dev);
441
442 /** Decide whether to accept this packet. This code is designed to
443 * behave identically to an Ethernet interface. Accept the packet if
444 * - we are promiscuous.
445 * - the packet is addressed to us.
446 * - the packet is broadcast.
447 * - the packet is multicast and
448 * - we are multicast promiscous.
449 * - we belong to the multicast group.
450 */
Arnaldo Carvalho de Melod626f622007-03-27 18:55:52 -0300451 skb_copy_from_linear_data(skb, addr, min_t(size_t, sizeof addr,
452 skb->len));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 bit_nr = ether_crc(sizeof addr, addr) >> 26;
454 if ((tun->if_flags & IFF_PROMISC) ||
455 memcmp(addr, tun->dev_addr, sizeof addr) == 0 ||
456 memcmp(addr, ones, sizeof addr) == 0 ||
457 (((addr[0] == 1 && addr[1] == 0 && addr[2] == 0x5e) ||
458 (addr[0] == 0x33 && addr[1] == 0x33)) &&
459 ((tun->if_flags & IFF_ALLMULTI) ||
460 (tun->chr_filter[bit_nr >> 5] & (1 << (bit_nr & 31)))))) {
Joe Perches0795af52007-10-03 17:59:30 -0700461 DBG(KERN_DEBUG "%s: tun_chr_readv: accepted: %s\n",
462 tun->dev->name, print_mac(mac, addr));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 ret = tun_put_user(tun, skb, (struct iovec *) iv, len);
464 kfree_skb(skb);
465 break;
466 } else {
Joe Perches0795af52007-10-03 17:59:30 -0700467 DBG(KERN_DEBUG "%s: tun_chr_readv: rejected: %s\n",
468 tun->dev->name, print_mac(mac, addr));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 kfree_skb(skb);
470 continue;
471 }
472 }
473
474 current->state = TASK_RUNNING;
475 remove_wait_queue(&tun->read_wait, &wait);
476
477 return ret;
478}
479
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480static void tun_setup(struct net_device *dev)
481{
482 struct tun_struct *tun = netdev_priv(dev);
483
484 skb_queue_head_init(&tun->readq);
485 init_waitqueue_head(&tun->read_wait);
486
487 tun->owner = -1;
Guido Guenther8c644622007-07-02 22:50:25 -0700488 tun->group = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 dev->open = tun_net_open;
491 dev->hard_start_xmit = tun_net_xmit;
492 dev->stop = tun_net_close;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 dev->ethtool_ops = &tun_ethtool_ops;
494 dev->destructor = free_netdev;
Pavel Emelyanovfc54c652008-04-16 00:41:53 -0700495 dev->features |= NETIF_F_NETNS_LOCAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496}
497
Pavel Emelyanovd647a592008-04-16 00:41:16 -0700498static struct tun_struct *tun_get_by_name(struct tun_net *tn, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499{
500 struct tun_struct *tun;
501
502 ASSERT_RTNL();
Pavel Emelyanovd647a592008-04-16 00:41:16 -0700503 list_for_each_entry(tun, &tn->dev_list, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 if (!strncmp(tun->dev->name, name, IFNAMSIZ))
505 return tun;
506 }
507
508 return NULL;
509}
510
Pavel Emelyanovd647a592008-04-16 00:41:16 -0700511static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
Pavel Emelyanovd647a592008-04-16 00:41:16 -0700513 struct tun_net *tn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 struct tun_struct *tun;
515 struct net_device *dev;
516 int err;
517
Pavel Emelyanovd647a592008-04-16 00:41:16 -0700518 tn = net_generic(net, tun_net_id);
519 tun = tun_get_by_name(tn, ifr->ifr_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 if (tun) {
521 if (tun->attached)
522 return -EBUSY;
523
524 /* Check permissions */
Guido Guenther8c644622007-07-02 22:50:25 -0700525 if (((tun->owner != -1 &&
526 current->euid != tun->owner) ||
527 (tun->group != -1 &&
528 current->egid != tun->group)) &&
529 !capable(CAP_NET_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 return -EPERM;
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400531 }
Pavel Emelyanovd647a592008-04-16 00:41:16 -0700532 else if (__dev_get_by_name(net, ifr->ifr_name))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 return -EINVAL;
534 else {
535 char *name;
536 unsigned long flags = 0;
537
538 err = -EINVAL;
539
David Woodhouseca6bb5d2006-06-22 16:07:52 -0700540 if (!capable(CAP_NET_ADMIN))
541 return -EPERM;
542
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 /* Set dev type */
544 if (ifr->ifr_flags & IFF_TUN) {
545 /* TUN device */
546 flags |= TUN_TUN_DEV;
547 name = "tun%d";
548 } else if (ifr->ifr_flags & IFF_TAP) {
549 /* TAP device */
550 flags |= TUN_TAP_DEV;
551 name = "tap%d";
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400552 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 goto failed;
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400554
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 if (*ifr->ifr_name)
556 name = ifr->ifr_name;
557
558 dev = alloc_netdev(sizeof(struct tun_struct), name,
559 tun_setup);
560 if (!dev)
561 return -ENOMEM;
562
Pavel Emelyanovfc54c652008-04-16 00:41:53 -0700563 dev_net_set(dev, net);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 tun = netdev_priv(dev);
565 tun->dev = dev;
566 tun->flags = flags;
567 /* Be promiscuous by default to maintain previous behaviour. */
568 tun->if_flags = IFF_PROMISC;
569 /* Generate random Ethernet address. */
Al Viroa3edb082007-12-22 17:52:42 +0000570 *(__be16 *)tun->dev_addr = htons(0x00FF);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 get_random_bytes(tun->dev_addr + sizeof(u16), 4);
572 memset(tun->chr_filter, 0, sizeof tun->chr_filter);
573
574 tun_net_init(dev);
575
576 if (strchr(dev->name, '%')) {
577 err = dev_alloc_name(dev, dev->name);
578 if (err < 0)
579 goto err_free_dev;
580 }
581
582 err = register_netdevice(tun->dev);
583 if (err < 0)
584 goto err_free_dev;
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400585
Pavel Emelyanovd647a592008-04-16 00:41:16 -0700586 list_add(&tun->list, &tn->dev_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 }
588
589 DBG(KERN_INFO "%s: tun_set_iff\n", tun->dev->name);
590
591 if (ifr->ifr_flags & IFF_NO_PI)
592 tun->flags |= TUN_NO_PI;
Nathaniel Filardoa26af1e2008-02-05 03:05:07 -0800593 else
594 tun->flags &= ~TUN_NO_PI;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
596 if (ifr->ifr_flags & IFF_ONE_QUEUE)
597 tun->flags |= TUN_ONE_QUEUE;
Nathaniel Filardoa26af1e2008-02-05 03:05:07 -0800598 else
599 tun->flags &= ~TUN_ONE_QUEUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
601 file->private_data = tun;
602 tun->attached = 1;
Pavel Emelyanovfc54c652008-04-16 00:41:53 -0700603 get_net(dev_net(tun->dev));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
Max Krasnyanskye35259a2008-07-10 16:59:11 -0700605 /* Make sure persistent devices do not get stuck in
606 * xoff state.
607 */
608 if (netif_running(tun->dev))
609 netif_wake_queue(tun->dev);
610
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 strcpy(ifr->ifr_name, tun->dev->name);
612 return 0;
613
614 err_free_dev:
615 free_netdev(dev);
616 failed:
617 return err;
618}
619
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400620static int tun_chr_ioctl(struct inode *inode, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 unsigned int cmd, unsigned long arg)
622{
623 struct tun_struct *tun = file->private_data;
624 void __user* argp = (void __user*)arg;
625 struct ifreq ifr;
Joe Perches0795af52007-10-03 17:59:30 -0700626 DECLARE_MAC_BUF(mac);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
628 if (cmd == TUNSETIFF || _IOC_TYPE(cmd) == 0x89)
629 if (copy_from_user(&ifr, argp, sizeof ifr))
630 return -EFAULT;
631
632 if (cmd == TUNSETIFF && !tun) {
633 int err;
634
635 ifr.ifr_name[IFNAMSIZ-1] = '\0';
636
637 rtnl_lock();
Pavel Emelyanovd647a592008-04-16 00:41:16 -0700638 err = tun_set_iff(current->nsproxy->net_ns, file, &ifr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 rtnl_unlock();
640
641 if (err)
642 return err;
643
644 if (copy_to_user(argp, &ifr, sizeof(ifr)))
645 return -EFAULT;
646 return 0;
647 }
648
649 if (!tun)
650 return -EBADFD;
651
652 DBG(KERN_INFO "%s: tun_chr_ioctl cmd %d\n", tun->dev->name, cmd);
653
654 switch (cmd) {
655 case TUNSETNOCSUM:
656 /* Disable/Enable checksum */
657 if (arg)
658 tun->flags |= TUN_NOCHECKSUM;
659 else
660 tun->flags &= ~TUN_NOCHECKSUM;
661
662 DBG(KERN_INFO "%s: checksum %s\n",
663 tun->dev->name, arg ? "disabled" : "enabled");
664 break;
665
666 case TUNSETPERSIST:
667 /* Disable/Enable persist mode */
668 if (arg)
669 tun->flags |= TUN_PERSIST;
670 else
671 tun->flags &= ~TUN_PERSIST;
672
673 DBG(KERN_INFO "%s: persist %s\n",
Toyo Abec6e991d2007-12-24 21:29:35 -0800674 tun->dev->name, arg ? "enabled" : "disabled");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 break;
676
677 case TUNSETOWNER:
678 /* Set owner of the device */
679 tun->owner = (uid_t) arg;
680
681 DBG(KERN_INFO "%s: owner set to %d\n", tun->dev->name, tun->owner);
682 break;
683
Guido Guenther8c644622007-07-02 22:50:25 -0700684 case TUNSETGROUP:
685 /* Set group of the device */
686 tun->group= (gid_t) arg;
687
688 DBG(KERN_INFO "%s: group set to %d\n", tun->dev->name, tun->group);
689 break;
690
Mike Kershawff4cc3a2005-09-01 17:40:05 -0700691 case TUNSETLINK:
David S. Miller48abfe02008-04-23 19:37:58 -0700692 {
693 int ret;
694
Mike Kershawff4cc3a2005-09-01 17:40:05 -0700695 /* Only allow setting the type when the interface is down */
David S. Miller48abfe02008-04-23 19:37:58 -0700696 rtnl_lock();
Mike Kershawff4cc3a2005-09-01 17:40:05 -0700697 if (tun->dev->flags & IFF_UP) {
698 DBG(KERN_INFO "%s: Linktype set failed because interface is up\n",
699 tun->dev->name);
David S. Miller48abfe02008-04-23 19:37:58 -0700700 ret = -EBUSY;
Mike Kershawff4cc3a2005-09-01 17:40:05 -0700701 } else {
702 tun->dev->type = (int) arg;
703 DBG(KERN_INFO "%s: linktype set to %d\n", tun->dev->name, tun->dev->type);
David S. Miller48abfe02008-04-23 19:37:58 -0700704 ret = 0;
Mike Kershawff4cc3a2005-09-01 17:40:05 -0700705 }
David S. Miller48abfe02008-04-23 19:37:58 -0700706 rtnl_unlock();
707 return ret;
708 }
Mike Kershawff4cc3a2005-09-01 17:40:05 -0700709
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710#ifdef TUN_DEBUG
711 case TUNSETDEBUG:
712 tun->debug = arg;
713 break;
714#endif
715
716 case SIOCGIFFLAGS:
717 ifr.ifr_flags = tun->if_flags;
718 if (copy_to_user( argp, &ifr, sizeof ifr))
719 return -EFAULT;
720 return 0;
721
722 case SIOCSIFFLAGS:
723 /** Set the character device's interface flags. Currently only
724 * IFF_PROMISC and IFF_ALLMULTI are used. */
725 tun->if_flags = ifr.ifr_flags;
726 DBG(KERN_INFO "%s: interface flags 0x%lx\n",
727 tun->dev->name, tun->if_flags);
728 return 0;
729
730 case SIOCGIFHWADDR:
Brian Braunstein36226a82007-04-26 01:00:55 -0700731 /* Note: the actual net device's address may be different */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 memcpy(ifr.ifr_hwaddr.sa_data, tun->dev_addr,
733 min(sizeof ifr.ifr_hwaddr.sa_data, sizeof tun->dev_addr));
734 if (copy_to_user( argp, &ifr, sizeof ifr))
735 return -EFAULT;
736 return 0;
737
738 case SIOCSIFHWADDR:
Brian Braunstein36226a82007-04-26 01:00:55 -0700739 {
740 /* try to set the actual net device's hw address */
Kim B. Heino40102372008-02-29 12:26:21 -0800741 int ret;
742
743 rtnl_lock();
744 ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr);
745 rtnl_unlock();
Brian Braunstein36226a82007-04-26 01:00:55 -0700746
747 if (ret == 0) {
748 /** Set the character device's hardware address. This is used when
749 * filtering packets being sent from the network device to the character
750 * device. */
751 memcpy(tun->dev_addr, ifr.ifr_hwaddr.sa_data,
752 min(sizeof ifr.ifr_hwaddr.sa_data, sizeof tun->dev_addr));
753 DBG(KERN_DEBUG "%s: set hardware address: %x:%x:%x:%x:%x:%x\n",
754 tun->dev->name,
755 tun->dev_addr[0], tun->dev_addr[1], tun->dev_addr[2],
756 tun->dev_addr[3], tun->dev_addr[4], tun->dev_addr[5]);
757 }
758
759 return ret;
760 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
762 case SIOCADDMULTI:
763 /** Add the specified group to the character device's multicast filter
764 * list. */
David S. Miller9edb74c2008-04-24 03:44:43 -0700765 rtnl_lock();
766 netif_tx_lock_bh(tun->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 add_multi(tun->chr_filter, ifr.ifr_hwaddr.sa_data);
David S. Miller9edb74c2008-04-24 03:44:43 -0700768 netif_tx_unlock_bh(tun->dev);
769 rtnl_unlock();
770
Joe Perches0795af52007-10-03 17:59:30 -0700771 DBG(KERN_DEBUG "%s: add multi: %s\n",
772 tun->dev->name, print_mac(mac, ifr.ifr_hwaddr.sa_data));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 return 0;
774
775 case SIOCDELMULTI:
776 /** Remove the specified group from the character device's multicast
777 * filter list. */
David S. Miller9edb74c2008-04-24 03:44:43 -0700778 rtnl_lock();
779 netif_tx_lock_bh(tun->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 del_multi(tun->chr_filter, ifr.ifr_hwaddr.sa_data);
David S. Miller9edb74c2008-04-24 03:44:43 -0700781 netif_tx_unlock_bh(tun->dev);
782 rtnl_unlock();
783
Joe Perches0795af52007-10-03 17:59:30 -0700784 DBG(KERN_DEBUG "%s: del multi: %s\n",
785 tun->dev->name, print_mac(mac, ifr.ifr_hwaddr.sa_data));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 return 0;
787
788 default:
789 return -EINVAL;
790 };
791
792 return 0;
793}
794
795static int tun_chr_fasync(int fd, struct file *file, int on)
796{
797 struct tun_struct *tun = file->private_data;
798 int ret;
799
800 if (!tun)
801 return -EBADFD;
802
803 DBG(KERN_INFO "%s: tun_chr_fasync %d\n", tun->dev->name, on);
804
805 if ((ret = fasync_helper(fd, file, on, &tun->fasync)) < 0)
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400806 return ret;
807
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 if (on) {
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700809 ret = __f_setown(file, task_pid(current), PIDTYPE_PID, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 if (ret)
811 return ret;
812 tun->flags |= TUN_FASYNC;
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400813 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 tun->flags &= ~TUN_FASYNC;
815
816 return 0;
817}
818
819static int tun_chr_open(struct inode *inode, struct file * file)
820{
821 DBG1(KERN_INFO "tunX: tun_chr_open\n");
822 file->private_data = NULL;
823 return 0;
824}
825
826static int tun_chr_close(struct inode *inode, struct file *file)
827{
828 struct tun_struct *tun = file->private_data;
829
830 if (!tun)
831 return 0;
832
833 DBG(KERN_INFO "%s: tun_chr_close\n", tun->dev->name);
834
835 tun_chr_fasync(-1, file, 0);
836
837 rtnl_lock();
838
839 /* Detach from net device */
840 file->private_data = NULL;
841 tun->attached = 0;
Pavel Emelyanovfc54c652008-04-16 00:41:53 -0700842 put_net(dev_net(tun->dev));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
844 /* Drop read queue */
845 skb_queue_purge(&tun->readq);
846
847 if (!(tun->flags & TUN_PERSIST)) {
848 list_del(&tun->list);
849 unregister_netdevice(tun->dev);
850 }
851
852 rtnl_unlock();
853
854 return 0;
855}
856
Arjan van de Vend54b1fd2007-02-12 00:55:34 -0800857static const struct file_operations tun_fops = {
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400858 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 .llseek = no_llseek,
Badari Pulavartyee0b3e62006-09-30 23:28:47 -0700860 .read = do_sync_read,
861 .aio_read = tun_chr_aio_read,
862 .write = do_sync_write,
863 .aio_write = tun_chr_aio_write,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 .poll = tun_chr_poll,
865 .ioctl = tun_chr_ioctl,
866 .open = tun_chr_open,
867 .release = tun_chr_close,
Jeff Garzik6aa20a22006-09-13 13:24:59 -0400868 .fasync = tun_chr_fasync
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869};
870
871static struct miscdevice tun_miscdev = {
872 .minor = TUN_MINOR,
873 .name = "tun",
874 .fops = &tun_fops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875};
876
877/* ethtool interface */
878
879static int tun_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
880{
881 cmd->supported = 0;
882 cmd->advertising = 0;
883 cmd->speed = SPEED_10;
884 cmd->duplex = DUPLEX_FULL;
885 cmd->port = PORT_TP;
886 cmd->phy_address = 0;
887 cmd->transceiver = XCVR_INTERNAL;
888 cmd->autoneg = AUTONEG_DISABLE;
889 cmd->maxtxpkt = 0;
890 cmd->maxrxpkt = 0;
891 return 0;
892}
893
894static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
895{
896 struct tun_struct *tun = netdev_priv(dev);
897
898 strcpy(info->driver, DRV_NAME);
899 strcpy(info->version, DRV_VERSION);
900 strcpy(info->fw_version, "N/A");
901
902 switch (tun->flags & TUN_TYPE_MASK) {
903 case TUN_TUN_DEV:
904 strcpy(info->bus_info, "tun");
905 break;
906 case TUN_TAP_DEV:
907 strcpy(info->bus_info, "tap");
908 break;
909 }
910}
911
912static u32 tun_get_msglevel(struct net_device *dev)
913{
914#ifdef TUN_DEBUG
915 struct tun_struct *tun = netdev_priv(dev);
916 return tun->debug;
917#else
918 return -EOPNOTSUPP;
919#endif
920}
921
922static void tun_set_msglevel(struct net_device *dev, u32 value)
923{
924#ifdef TUN_DEBUG
925 struct tun_struct *tun = netdev_priv(dev);
926 tun->debug = value;
927#endif
928}
929
930static u32 tun_get_link(struct net_device *dev)
931{
932 struct tun_struct *tun = netdev_priv(dev);
933 return tun->attached;
934}
935
936static u32 tun_get_rx_csum(struct net_device *dev)
937{
938 struct tun_struct *tun = netdev_priv(dev);
939 return (tun->flags & TUN_NOCHECKSUM) == 0;
940}
941
942static int tun_set_rx_csum(struct net_device *dev, u32 data)
943{
944 struct tun_struct *tun = netdev_priv(dev);
945 if (data)
946 tun->flags &= ~TUN_NOCHECKSUM;
947 else
948 tun->flags |= TUN_NOCHECKSUM;
949 return 0;
950}
951
Jeff Garzik7282d492006-09-13 14:30:00 -0400952static const struct ethtool_ops tun_ethtool_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 .get_settings = tun_get_settings,
954 .get_drvinfo = tun_get_drvinfo,
955 .get_msglevel = tun_get_msglevel,
956 .set_msglevel = tun_set_msglevel,
957 .get_link = tun_get_link,
958 .get_rx_csum = tun_get_rx_csum,
959 .set_rx_csum = tun_set_rx_csum
960};
961
Pavel Emelyanov79d17602008-04-16 00:40:46 -0700962static int tun_init_net(struct net *net)
963{
964 struct tun_net *tn;
965
966 tn = kmalloc(sizeof(*tn), GFP_KERNEL);
967 if (tn == NULL)
968 return -ENOMEM;
969
970 INIT_LIST_HEAD(&tn->dev_list);
971
972 if (net_assign_generic(net, tun_net_id, tn)) {
973 kfree(tn);
974 return -ENOMEM;
975 }
976
977 return 0;
978}
979
980static void tun_exit_net(struct net *net)
981{
982 struct tun_net *tn;
Pavel Emelyanovd647a592008-04-16 00:41:16 -0700983 struct tun_struct *tun, *nxt;
Pavel Emelyanov79d17602008-04-16 00:40:46 -0700984
985 tn = net_generic(net, tun_net_id);
Pavel Emelyanovd647a592008-04-16 00:41:16 -0700986
987 rtnl_lock();
988 list_for_each_entry_safe(tun, nxt, &tn->dev_list, list) {
989 DBG(KERN_INFO "%s cleaned up\n", tun->dev->name);
990 unregister_netdevice(tun->dev);
991 }
992 rtnl_unlock();
993
Pavel Emelyanov79d17602008-04-16 00:40:46 -0700994 kfree(tn);
995}
996
997static struct pernet_operations tun_net_ops = {
998 .init = tun_init_net,
999 .exit = tun_exit_net,
1000};
1001
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002static int __init tun_init(void)
1003{
1004 int ret = 0;
1005
1006 printk(KERN_INFO "tun: %s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
1007 printk(KERN_INFO "tun: %s\n", DRV_COPYRIGHT);
1008
Pavel Emelyanov79d17602008-04-16 00:40:46 -07001009 ret = register_pernet_gen_device(&tun_net_id, &tun_net_ops);
1010 if (ret) {
1011 printk(KERN_ERR "tun: Can't register pernet ops\n");
1012 goto err_pernet;
1013 }
1014
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 ret = misc_register(&tun_miscdev);
Pavel Emelyanov79d17602008-04-16 00:40:46 -07001016 if (ret) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 printk(KERN_ERR "tun: Can't register misc device %d\n", TUN_MINOR);
Pavel Emelyanov79d17602008-04-16 00:40:46 -07001018 goto err_misc;
1019 }
1020 return 0;
1021
1022err_misc:
1023 unregister_pernet_gen_device(tun_net_id, &tun_net_ops);
1024err_pernet:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 return ret;
1026}
1027
1028static void tun_cleanup(void)
1029{
Jeff Garzik6aa20a22006-09-13 13:24:59 -04001030 misc_deregister(&tun_miscdev);
Pavel Emelyanov79d17602008-04-16 00:40:46 -07001031 unregister_pernet_gen_device(tun_net_id, &tun_net_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032}
1033
1034module_init(tun_init);
1035module_exit(tun_cleanup);
1036MODULE_DESCRIPTION(DRV_DESCRIPTION);
1037MODULE_AUTHOR(DRV_COPYRIGHT);
1038MODULE_LICENSE("GPL");
1039MODULE_ALIAS_MISCDEV(TUN_MINOR);