blob: 06b1829731fd6f6c7f4864463c0ee2b73b4e15bf [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Universal TUN/TAP device driver.
3 * Copyright (C) 1999-2000 Maxim Krasnyansky <max_mk@yahoo.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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 */
15
16#ifndef __IF_TUN_H
17#define __IF_TUN_H
18
Al Viroa3edb082007-12-22 17:52:42 +000019#include <linux/types.h>
Max Krasnyanskyf271b2c2008-07-14 22:18:19 -070020#include <linux/if_ether.h>
Michael S. Tsirkin99405162010-02-14 01:01:10 +000021#include <linux/filter.h>
Al Viroa3edb082007-12-22 17:52:42 +000022
Linus Torvalds1da177e2005-04-16 15:20:36 -070023/* Read queue size */
24#define TUN_READQ_SIZE 500
25
26/* TUN device flags */
27#define TUN_TUN_DEV 0x0001
28#define TUN_TAP_DEV 0x0002
29#define TUN_TYPE_MASK 0x000f
30
31#define TUN_FASYNC 0x0010
32#define TUN_NOCHECKSUM 0x0020
33#define TUN_NO_PI 0x0040
34#define TUN_ONE_QUEUE 0x0080
35#define TUN_PERSIST 0x0100
Rusty Russellf43798c2008-07-03 03:48:02 -070036#define TUN_VNET_HDR 0x0200
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38/* Ioctl defines */
39#define TUNSETNOCSUM _IOW('T', 200, int)
40#define TUNSETDEBUG _IOW('T', 201, int)
41#define TUNSETIFF _IOW('T', 202, int)
42#define TUNSETPERSIST _IOW('T', 203, int)
43#define TUNSETOWNER _IOW('T', 204, int)
Mike Kershawff4cc3a2005-09-01 17:40:05 -070044#define TUNSETLINK _IOW('T', 205, int)
Guido Guenther8c644622007-07-02 22:50:25 -070045#define TUNSETGROUP _IOW('T', 206, int)
Rusty Russell07240fd2008-07-03 03:45:32 -070046#define TUNGETFEATURES _IOR('T', 207, unsigned int)
Max Krasnyanskyf271b2c2008-07-14 22:18:19 -070047#define TUNSETOFFLOAD _IOW('T', 208, unsigned int)
48#define TUNSETTXFILTER _IOW('T', 209, unsigned int)
Mark McLoughline3b99552008-08-15 15:09:56 -070049#define TUNGETIFF _IOR('T', 210, unsigned int)
Herbert Xu33dccbb2009-02-05 21:25:32 -080050#define TUNGETSNDBUF _IOR('T', 211, int)
51#define TUNSETSNDBUF _IOW('T', 212, int)
Michael S. Tsirkin99405162010-02-14 01:01:10 +000052#define TUNATTACHFILTER _IOW('T', 213, struct sock_fprog)
53#define TUNDETACHFILTER _IOW('T', 214, struct sock_fprog)
Michael S. Tsirkind9d52b52010-03-17 17:45:01 +020054#define TUNGETVNETHDRSZ _IOR('T', 215, int)
55#define TUNSETVNETHDRSZ _IOW('T', 216, int)
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57/* TUNSETIFF ifr flags */
58#define IFF_TUN 0x0001
59#define IFF_TAP 0x0002
60#define IFF_NO_PI 0x1000
61#define IFF_ONE_QUEUE 0x2000
Rusty Russellf43798c2008-07-03 03:48:02 -070062#define IFF_VNET_HDR 0x4000
David Woodhousef85ba782009-04-27 03:23:54 -070063#define IFF_TUN_EXCL 0x8000
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Rusty Russell5228ddc2008-07-03 03:46:16 -070065/* Features for GSO (TUNSETOFFLOAD). */
66#define TUN_F_CSUM 0x01 /* You can hand me unchecksummed packets. */
67#define TUN_F_TSO4 0x02 /* I can handle TSO for IPv4 packets */
68#define TUN_F_TSO6 0x04 /* I can handle TSO for IPv6 packets */
69#define TUN_F_TSO_ECN 0x08 /* I can handle TSO with ECN bits. */
Sridhar Samudralae36aa252009-07-14 14:21:04 +000070#define TUN_F_UFO 0x10 /* I can handle UFO packets */
Rusty Russell5228ddc2008-07-03 03:46:16 -070071
Max Krasnyanskyf271b2c2008-07-14 22:18:19 -070072/* Protocol info prepended to the packets (when IFF_NO_PI is not set) */
73#define TUN_PKT_STRIP 0x0001
Linus Torvalds1da177e2005-04-16 15:20:36 -070074struct tun_pi {
Max Krasnyanskyf271b2c2008-07-14 22:18:19 -070075 __u16 flags;
Al Viroa3edb082007-12-22 17:52:42 +000076 __be16 proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -070077};
Max Krasnyanskyf271b2c2008-07-14 22:18:19 -070078
79/*
80 * Filter spec (used for SETXXFILTER ioctls)
81 * This stuff is applicable only to the TAP (Ethernet) devices.
82 * If the count is zero the filter is disabled and the driver accepts
83 * all packets (promisc mode).
84 * If the filter is enabled in order to accept broadcast packets
85 * broadcast addr must be explicitly included in the addr list.
86 */
87#define TUN_FLT_ALLMULTI 0x0001 /* Accept all multicast packets */
88struct tun_filter {
89 __u16 flags; /* TUN_FLT_ flags see above */
90 __u16 count; /* Number of addresses */
91 __u8 addr[0][ETH_ALEN];
92};
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Michael S. Tsirkin05c28282010-01-14 06:17:09 +000094#ifdef __KERNEL__
95#if defined(CONFIG_TUN) || defined(CONFIG_TUN_MODULE)
96struct socket *tun_get_socket(struct file *);
97#else
98#include <linux/err.h>
99#include <linux/errno.h>
100struct file;
101struct socket;
102static inline struct socket *tun_get_socket(struct file *f)
103{
104 return ERR_PTR(-EINVAL);
105}
106#endif /* CONFIG_TUN */
107#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108#endif /* __IF_TUN_H */