]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/net/tun.c
Merge remote-tracking branches 'spi/topic/imx', 'spi/topic/mxs', 'spi/topic/orion...
[mirror_ubuntu-bionic-kernel.git] / drivers / net / tun.c
CommitLineData
1da177e4
LT
1/*
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 *
ff4cc3ac
MK
21 * Mike Kershaw <dragorn@kismetwireless.net> 2005/08/14
22 * Add TUNSETLINK ioctl to set the link encapsulation
23 *
1da177e4 24 * Mark Smith <markzzzsmith@yahoo.com.au>
344dc8ed 25 * Use eth_random_addr() for tap MAC address.
1da177e4
LT
26 *
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.
30 * Added ethtool API.
31 * Minor cleanups
32 *
33 * Daniel Podlejski <underley@underley.eu.org>
34 * Modifications for 2.3.99-pre5 kernel.
35 */
36
6b8a66ee
JP
37#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
38
1da177e4
LT
39#define DRV_NAME "tun"
40#define DRV_VERSION "1.6"
41#define DRV_DESCRIPTION "Universal TUN/TAP device driver"
42#define DRV_COPYRIGHT "(C) 1999-2004 Max Krasnyansky <maxk@qualcomm.com>"
43
1da177e4
LT
44#include <linux/module.h>
45#include <linux/errno.h>
46#include <linux/kernel.h>
174cd4b1 47#include <linux/sched/signal.h>
1da177e4
LT
48#include <linux/major.h>
49#include <linux/slab.h>
50#include <linux/poll.h>
51#include <linux/fcntl.h>
52#include <linux/init.h>
53#include <linux/skbuff.h>
54#include <linux/netdevice.h>
55#include <linux/etherdevice.h>
56#include <linux/miscdevice.h>
57#include <linux/ethtool.h>
58#include <linux/rtnetlink.h>
50857e2a 59#include <linux/compat.h>
1da177e4
LT
60#include <linux/if.h>
61#include <linux/if_arp.h>
62#include <linux/if_ether.h>
63#include <linux/if_tun.h>
6680ec68 64#include <linux/if_vlan.h>
1da177e4 65#include <linux/crc32.h>
d647a591 66#include <linux/nsproxy.h>
f43798c2 67#include <linux/virtio_net.h>
99405162 68#include <linux/rcupdate.h>
881d966b 69#include <net/net_namespace.h>
79d17604 70#include <net/netns/generic.h>
f019a7a5 71#include <net/rtnetlink.h>
33dccbb0 72#include <net/sock.h>
93e14b6d 73#include <linux/seq_file.h>
e0b46d0e 74#include <linux/uio.h>
1576d986 75#include <linux/skb_array.h>
761876c8
JW
76#include <linux/bpf.h>
77#include <linux/bpf_trace.h>
1da177e4 78
7c0f6ba6 79#include <linux/uaccess.h>
1da177e4 80
14daa021
RR
81/* Uncomment to enable debugging */
82/* #define TUN_DEBUG 1 */
83
1da177e4
LT
84#ifdef TUN_DEBUG
85static int debug;
14daa021 86
6b8a66ee
JP
87#define tun_debug(level, tun, fmt, args...) \
88do { \
89 if (tun->debug) \
90 netdev_printk(level, tun->dev, fmt, ##args); \
91} while (0)
92#define DBG1(level, fmt, args...) \
93do { \
94 if (debug == 2) \
95 printk(level fmt, ##args); \
96} while (0)
14daa021 97#else
6b8a66ee
JP
98#define tun_debug(level, tun, fmt, args...) \
99do { \
100 if (0) \
101 netdev_printk(level, tun->dev, fmt, ##args); \
102} while (0)
103#define DBG1(level, fmt, args...) \
104do { \
105 if (0) \
106 printk(level fmt, ##args); \
107} while (0)
14daa021
RR
108#endif
109
761876c8 110#define TUN_HEADROOM 256
7df13219 111#define TUN_RX_PAD (NET_IP_ALIGN + NET_SKB_PAD)
66ccbc9c 112
031f5e03
MT
113/* TUN device flags */
114
115/* IFF_ATTACH_QUEUE is never stored in device flags,
116 * overload it to mean fasync when stored there.
117 */
118#define TUN_FASYNC IFF_ATTACH_QUEUE
1cf8e410
MT
119/* High bits in flags field are unused. */
120#define TUN_VNET_LE 0x80000000
8b8e658b 121#define TUN_VNET_BE 0x40000000
031f5e03
MT
122
123#define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
1cf8e410 124 IFF_MULTI_QUEUE)
0690899b
MT
125#define GOODCOPY_LEN 128
126
f271b2cc
MK
127#define FLT_EXACT_COUNT 8
128struct tap_filter {
129 unsigned int count; /* Number of addrs. Zero means disabled */
130 u32 mask[2]; /* Mask of the hashed addrs */
131 unsigned char addr[FLT_EXACT_COUNT][ETH_ALEN];
132};
133
baf71c5c
PG
134/* MAX_TAP_QUEUES 256 is chosen to allow rx/tx queues to be equal
135 * to max number of VCPUs in guest. */
136#define MAX_TAP_QUEUES 256
b8732fb7 137#define MAX_TAP_FLOWS 4096
c8d68e6b 138
96442e42
JW
139#define TUN_FLOW_EXPIRE (3 * HZ)
140
608b9977
PA
141struct tun_pcpu_stats {
142 u64 rx_packets;
143 u64 rx_bytes;
144 u64 tx_packets;
145 u64 tx_bytes;
146 struct u64_stats_sync syncp;
147 u32 rx_dropped;
148 u32 tx_dropped;
149 u32 rx_frame_errors;
150};
151
54f968d6 152/* A tun_file connects an open character device to a tuntap netdevice. It
92d4ea6e 153 * also contains all socket related structures (except sock_fprog and tap_filter)
54f968d6
JW
154 * to serve as one transmit queue for tuntap device. The sock_fprog and
155 * tap_filter were kept in tun_struct since they were used for filtering for the
36fe8c09 156 * netdevice not for a specific queue (at least I didn't see the requirement for
54f968d6 157 * this).
6e914fc7
JW
158 *
159 * RCU usage:
36fe8c09 160 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
6e914fc7 161 * other can only be read while rcu_read_lock or rtnl_lock is held.
54f968d6 162 */
631ab46b 163struct tun_file {
54f968d6
JW
164 struct sock sk;
165 struct socket socket;
166 struct socket_wq wq;
6e914fc7 167 struct tun_struct __rcu *tun;
54f968d6
JW
168 struct fasync_struct *fasync;
169 /* only used for fasnyc */
170 unsigned int flags;
fb7589a1
PE
171 union {
172 u16 queue_index;
173 unsigned int ifindex;
174 };
4008e97f
JW
175 struct list_head next;
176 struct tun_struct *detached;
1576d986 177 struct skb_array tx_array;
631ab46b
EB
178};
179
96442e42
JW
180struct tun_flow_entry {
181 struct hlist_node hash_link;
182 struct rcu_head rcu;
183 struct tun_struct *tun;
184
185 u32 rxhash;
9bc88939 186 u32 rps_rxhash;
96442e42
JW
187 int queue_index;
188 unsigned long updated;
189};
190
191#define TUN_NUM_FLOW_ENTRIES 1024
192
54f968d6 193/* Since the socket were moved to tun_file, to preserve the behavior of persist
36fe8c09 194 * device, socket filter, sndbuf and vnet header size were restore when the
54f968d6
JW
195 * file were attached to a persist device.
196 */
14daa021 197struct tun_struct {
c8d68e6b
JW
198 struct tun_file __rcu *tfiles[MAX_TAP_QUEUES];
199 unsigned int numqueues;
f271b2cc 200 unsigned int flags;
0625c883
EB
201 kuid_t owner;
202 kgid_t group;
14daa021 203
14daa021 204 struct net_device *dev;
c8f44aff 205 netdev_features_t set_features;
88255375 206#define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
d591a1f3 207 NETIF_F_TSO6)
d9d52b51 208
eaea34b2 209 int align;
d9d52b51 210 int vnet_hdr_sz;
54f968d6
JW
211 int sndbuf;
212 struct tap_filter txflt;
213 struct sock_fprog fprog;
214 /* protected by rtnl lock */
215 bool filter_attached;
14daa021
RR
216#ifdef TUN_DEBUG
217 int debug;
1da177e4 218#endif
96442e42 219 spinlock_t lock;
96442e42
JW
220 struct hlist_head flows[TUN_NUM_FLOW_ENTRIES];
221 struct timer_list flow_gc_timer;
222 unsigned long ageing_time;
4008e97f
JW
223 unsigned int numdisabled;
224 struct list_head disabled;
5dbbaf2d 225 void *security;
b8732fb7 226 u32 flow_count;
5503fcec 227 u32 rx_batched;
608b9977 228 struct tun_pcpu_stats __percpu *pcpu_stats;
761876c8 229 struct bpf_prog __rcu *xdp_prog;
14daa021 230};
1da177e4 231
8b8e658b
GK
232#ifdef CONFIG_TUN_VNET_CROSS_LE
233static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
234{
235 return tun->flags & TUN_VNET_BE ? false :
236 virtio_legacy_is_little_endian();
237}
238
239static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
240{
241 int be = !!(tun->flags & TUN_VNET_BE);
242
243 if (put_user(be, argp))
244 return -EFAULT;
245
246 return 0;
247}
248
249static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
250{
251 int be;
252
253 if (get_user(be, argp))
254 return -EFAULT;
255
256 if (be)
257 tun->flags |= TUN_VNET_BE;
258 else
259 tun->flags &= ~TUN_VNET_BE;
260
261 return 0;
262}
263#else
264static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
265{
266 return virtio_legacy_is_little_endian();
267}
268
269static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
270{
271 return -EINVAL;
272}
273
274static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
275{
276 return -EINVAL;
277}
278#endif /* CONFIG_TUN_VNET_CROSS_LE */
279
25bd55bb
GK
280static inline bool tun_is_little_endian(struct tun_struct *tun)
281{
7d824109 282 return tun->flags & TUN_VNET_LE ||
8b8e658b 283 tun_legacy_is_little_endian(tun);
25bd55bb
GK
284}
285
56f0dcc5
MT
286static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
287{
25bd55bb 288 return __virtio16_to_cpu(tun_is_little_endian(tun), val);
56f0dcc5
MT
289}
290
291static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
292{
25bd55bb 293 return __cpu_to_virtio16(tun_is_little_endian(tun), val);
56f0dcc5
MT
294}
295
96442e42
JW
296static inline u32 tun_hashfn(u32 rxhash)
297{
298 return rxhash & 0x3ff;
299}
300
301static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
302{
303 struct tun_flow_entry *e;
96442e42 304
b67bfe0d 305 hlist_for_each_entry_rcu(e, head, hash_link) {
96442e42
JW
306 if (e->rxhash == rxhash)
307 return e;
308 }
309 return NULL;
310}
311
312static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
313 struct hlist_head *head,
314 u32 rxhash, u16 queue_index)
315{
9fdc6bef
ED
316 struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
317
96442e42
JW
318 if (e) {
319 tun_debug(KERN_INFO, tun, "create flow: hash %u index %u\n",
320 rxhash, queue_index);
321 e->updated = jiffies;
322 e->rxhash = rxhash;
9bc88939 323 e->rps_rxhash = 0;
96442e42
JW
324 e->queue_index = queue_index;
325 e->tun = tun;
326 hlist_add_head_rcu(&e->hash_link, head);
b8732fb7 327 ++tun->flow_count;
96442e42
JW
328 }
329 return e;
330}
331
96442e42
JW
332static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
333{
334 tun_debug(KERN_INFO, tun, "delete flow: hash %u index %u\n",
335 e->rxhash, e->queue_index);
336 hlist_del_rcu(&e->hash_link);
9fdc6bef 337 kfree_rcu(e, rcu);
b8732fb7 338 --tun->flow_count;
96442e42
JW
339}
340
341static void tun_flow_flush(struct tun_struct *tun)
342{
343 int i;
344
345 spin_lock_bh(&tun->lock);
346 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
347 struct tun_flow_entry *e;
b67bfe0d 348 struct hlist_node *n;
96442e42 349
b67bfe0d 350 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
96442e42
JW
351 tun_flow_delete(tun, e);
352 }
353 spin_unlock_bh(&tun->lock);
354}
355
356static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
357{
358 int i;
359
360 spin_lock_bh(&tun->lock);
361 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
362 struct tun_flow_entry *e;
b67bfe0d 363 struct hlist_node *n;
96442e42 364
b67bfe0d 365 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
96442e42
JW
366 if (e->queue_index == queue_index)
367 tun_flow_delete(tun, e);
368 }
369 }
370 spin_unlock_bh(&tun->lock);
371}
372
373static void tun_flow_cleanup(unsigned long data)
374{
375 struct tun_struct *tun = (struct tun_struct *)data;
376 unsigned long delay = tun->ageing_time;
377 unsigned long next_timer = jiffies + delay;
378 unsigned long count = 0;
379 int i;
380
381 tun_debug(KERN_INFO, tun, "tun_flow_cleanup\n");
382
383 spin_lock_bh(&tun->lock);
384 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
385 struct tun_flow_entry *e;
b67bfe0d 386 struct hlist_node *n;
96442e42 387
b67bfe0d 388 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
96442e42
JW
389 unsigned long this_timer;
390 count++;
391 this_timer = e->updated + delay;
392 if (time_before_eq(this_timer, jiffies))
393 tun_flow_delete(tun, e);
394 else if (time_before(this_timer, next_timer))
395 next_timer = this_timer;
396 }
397 }
398
399 if (count)
400 mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
401 spin_unlock_bh(&tun->lock);
402}
403
49974420 404static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
9e85722d 405 struct tun_file *tfile)
96442e42
JW
406{
407 struct hlist_head *head;
408 struct tun_flow_entry *e;
409 unsigned long delay = tun->ageing_time;
9e85722d 410 u16 queue_index = tfile->queue_index;
96442e42
JW
411
412 if (!rxhash)
413 return;
414 else
415 head = &tun->flows[tun_hashfn(rxhash)];
416
417 rcu_read_lock();
418
9e85722d
JW
419 /* We may get a very small possibility of OOO during switching, not
420 * worth to optimize.*/
421 if (tun->numqueues == 1 || tfile->detached)
96442e42
JW
422 goto unlock;
423
424 e = tun_flow_find(head, rxhash);
425 if (likely(e)) {
426 /* TODO: keep queueing to old queue until it's empty? */
427 e->queue_index = queue_index;
428 e->updated = jiffies;
9bc88939 429 sock_rps_record_flow_hash(e->rps_rxhash);
96442e42
JW
430 } else {
431 spin_lock_bh(&tun->lock);
b8732fb7
JW
432 if (!tun_flow_find(head, rxhash) &&
433 tun->flow_count < MAX_TAP_FLOWS)
96442e42
JW
434 tun_flow_create(tun, head, rxhash, queue_index);
435
436 if (!timer_pending(&tun->flow_gc_timer))
437 mod_timer(&tun->flow_gc_timer,
438 round_jiffies_up(jiffies + delay));
439 spin_unlock_bh(&tun->lock);
440 }
441
442unlock:
443 rcu_read_unlock();
444}
445
9bc88939
TH
446/**
447 * Save the hash received in the stack receive path and update the
448 * flow_hash table accordingly.
449 */
450static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry *e, u32 hash)
451{
567e4b79 452 if (unlikely(e->rps_rxhash != hash))
9bc88939 453 e->rps_rxhash = hash;
9bc88939
TH
454}
455
c8d68e6b 456/* We try to identify a flow through its rxhash first. The reason that
92d4ea6e 457 * we do not check rxq no. is because some cards(e.g 82599), chooses
c8d68e6b
JW
458 * the rxq based on the txq where the last packet of the flow comes. As
459 * the userspace application move between processors, we may get a
460 * different rxq no. here. If we could not get rxhash, then we would
461 * hope the rxq no. may help here.
462 */
f663dd9a 463static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb,
99932d4f 464 void *accel_priv, select_queue_fallback_t fallback)
c8d68e6b
JW
465{
466 struct tun_struct *tun = netdev_priv(dev);
96442e42 467 struct tun_flow_entry *e;
c8d68e6b
JW
468 u32 txq = 0;
469 u32 numqueues = 0;
470
471 rcu_read_lock();
92bb73ea 472 numqueues = ACCESS_ONCE(tun->numqueues);
c8d68e6b 473
feec084a 474 txq = __skb_get_hash_symmetric(skb);
c8d68e6b 475 if (txq) {
96442e42 476 e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
9bc88939 477 if (e) {
9bc88939 478 tun_flow_save_rps_rxhash(e, txq);
fbe4d456 479 txq = e->queue_index;
9bc88939 480 } else
96442e42
JW
481 /* use multiply and shift instead of expensive divide */
482 txq = ((u64)txq * numqueues) >> 32;
c8d68e6b
JW
483 } else if (likely(skb_rx_queue_recorded(skb))) {
484 txq = skb_get_rx_queue(skb);
485 while (unlikely(txq >= numqueues))
486 txq -= numqueues;
487 }
488
489 rcu_read_unlock();
490 return txq;
491}
492
cde8b15f
JW
493static inline bool tun_not_capable(struct tun_struct *tun)
494{
495 const struct cred *cred = current_cred();
c260b772 496 struct net *net = dev_net(tun->dev);
cde8b15f
JW
497
498 return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
499 (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
c260b772 500 !ns_capable(net->user_ns, CAP_NET_ADMIN);
cde8b15f
JW
501}
502
c8d68e6b
JW
503static void tun_set_real_num_queues(struct tun_struct *tun)
504{
505 netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
506 netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
507}
508
4008e97f
JW
509static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
510{
511 tfile->detached = tun;
512 list_add_tail(&tfile->next, &tun->disabled);
513 ++tun->numdisabled;
514}
515
d32649d1 516static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
4008e97f
JW
517{
518 struct tun_struct *tun = tfile->detached;
519
520 tfile->detached = NULL;
521 list_del_init(&tfile->next);
522 --tun->numdisabled;
523 return tun;
524}
525
4bfb0513
JW
526static void tun_queue_purge(struct tun_file *tfile)
527{
1576d986
JW
528 struct sk_buff *skb;
529
530 while ((skb = skb_array_consume(&tfile->tx_array)) != NULL)
531 kfree_skb(skb);
532
5503fcec 533 skb_queue_purge(&tfile->sk.sk_write_queue);
4bfb0513
JW
534 skb_queue_purge(&tfile->sk.sk_error_queue);
535}
536
c8d68e6b
JW
537static void __tun_detach(struct tun_file *tfile, bool clean)
538{
539 struct tun_file *ntfile;
540 struct tun_struct *tun;
c8d68e6b 541
b8deabd3
JW
542 tun = rtnl_dereference(tfile->tun);
543
9e85722d 544 if (tun && !tfile->detached) {
c8d68e6b
JW
545 u16 index = tfile->queue_index;
546 BUG_ON(index >= tun->numqueues);
c8d68e6b
JW
547
548 rcu_assign_pointer(tun->tfiles[index],
549 tun->tfiles[tun->numqueues - 1]);
b8deabd3 550 ntfile = rtnl_dereference(tun->tfiles[index]);
c8d68e6b
JW
551 ntfile->queue_index = index;
552
553 --tun->numqueues;
9e85722d 554 if (clean) {
c956674b 555 RCU_INIT_POINTER(tfile->tun, NULL);
4008e97f 556 sock_put(&tfile->sk);
9e85722d 557 } else
4008e97f 558 tun_disable_queue(tun, tfile);
c8d68e6b
JW
559
560 synchronize_net();
96442e42 561 tun_flow_delete_by_queue(tun, tun->numqueues + 1);
c8d68e6b 562 /* Drop read queue */
4bfb0513 563 tun_queue_purge(tfile);
c8d68e6b 564 tun_set_real_num_queues(tun);
dd38bd85 565 } else if (tfile->detached && clean) {
4008e97f 566 tun = tun_enable_queue(tfile);
dd38bd85
JW
567 sock_put(&tfile->sk);
568 }
c8d68e6b
JW
569
570 if (clean) {
af668b3c
MT
571 if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
572 netif_carrier_off(tun->dev);
573
40630b82 574 if (!(tun->flags & IFF_PERSIST) &&
af668b3c 575 tun->dev->reg_state == NETREG_REGISTERED)
4008e97f 576 unregister_netdevice(tun->dev);
af668b3c 577 }
1576d986
JW
578 if (tun)
579 skb_array_cleanup(&tfile->tx_array);
140e807d 580 sock_put(&tfile->sk);
c8d68e6b
JW
581 }
582}
583
584static void tun_detach(struct tun_file *tfile, bool clean)
585{
586 rtnl_lock();
587 __tun_detach(tfile, clean);
588 rtnl_unlock();
589}
590
591static void tun_detach_all(struct net_device *dev)
592{
593 struct tun_struct *tun = netdev_priv(dev);
761876c8 594 struct bpf_prog *xdp_prog = rtnl_dereference(tun->xdp_prog);
4008e97f 595 struct tun_file *tfile, *tmp;
c8d68e6b
JW
596 int i, n = tun->numqueues;
597
598 for (i = 0; i < n; i++) {
b8deabd3 599 tfile = rtnl_dereference(tun->tfiles[i]);
c8d68e6b 600 BUG_ON(!tfile);
addf8fc4 601 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
9e641bdc 602 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
c956674b 603 RCU_INIT_POINTER(tfile->tun, NULL);
c8d68e6b
JW
604 --tun->numqueues;
605 }
9e85722d 606 list_for_each_entry(tfile, &tun->disabled, next) {
addf8fc4 607 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
9e641bdc 608 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
c956674b 609 RCU_INIT_POINTER(tfile->tun, NULL);
9e85722d 610 }
c8d68e6b
JW
611 BUG_ON(tun->numqueues != 0);
612
613 synchronize_net();
614 for (i = 0; i < n; i++) {
b8deabd3 615 tfile = rtnl_dereference(tun->tfiles[i]);
c8d68e6b 616 /* Drop read queue */
4bfb0513 617 tun_queue_purge(tfile);
c8d68e6b
JW
618 sock_put(&tfile->sk);
619 }
4008e97f
JW
620 list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
621 tun_enable_queue(tfile);
4bfb0513 622 tun_queue_purge(tfile);
4008e97f
JW
623 sock_put(&tfile->sk);
624 }
625 BUG_ON(tun->numdisabled != 0);
dd38bd85 626
761876c8
JW
627 if (xdp_prog)
628 bpf_prog_put(xdp_prog);
629
40630b82 630 if (tun->flags & IFF_PERSIST)
dd38bd85 631 module_put(THIS_MODULE);
c8d68e6b
JW
632}
633
849c9b6f 634static int tun_attach(struct tun_struct *tun, struct file *file, bool skip_filter)
a7385ba2 635{
631ab46b 636 struct tun_file *tfile = file->private_data;
1576d986 637 struct net_device *dev = tun->dev;
38231b7a 638 int err;
a7385ba2 639
5dbbaf2d
PM
640 err = security_tun_dev_attach(tfile->socket.sk, tun->security);
641 if (err < 0)
642 goto out;
643
38231b7a 644 err = -EINVAL;
9e85722d 645 if (rtnl_dereference(tfile->tun) && !tfile->detached)
38231b7a
EB
646 goto out;
647
648 err = -EBUSY;
40630b82 649 if (!(tun->flags & IFF_MULTI_QUEUE) && tun->numqueues == 1)
c8d68e6b
JW
650 goto out;
651
652 err = -E2BIG;
4008e97f
JW
653 if (!tfile->detached &&
654 tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
38231b7a
EB
655 goto out;
656
657 err = 0;
54f968d6 658
92d4ea6e 659 /* Re-attach the filter to persist device */
849c9b6f 660 if (!skip_filter && (tun->filter_attached == true)) {
8ced425e
HFS
661 lock_sock(tfile->socket.sk);
662 err = sk_attach_filter(&tun->fprog, tfile->socket.sk);
663 release_sock(tfile->socket.sk);
54f968d6
JW
664 if (!err)
665 goto out;
666 }
1576d986
JW
667
668 if (!tfile->detached &&
669 skb_array_init(&tfile->tx_array, dev->tx_queue_len, GFP_KERNEL)) {
670 err = -ENOMEM;
671 goto out;
672 }
673
c8d68e6b 674 tfile->queue_index = tun->numqueues;
addf8fc4 675 tfile->socket.sk->sk_shutdown &= ~RCV_SHUTDOWN;
6e914fc7 676 rcu_assign_pointer(tfile->tun, tun);
c8d68e6b 677 rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
c8d68e6b 678 tun->numqueues++;
a7385ba2 679
4008e97f
JW
680 if (tfile->detached)
681 tun_enable_queue(tfile);
682 else
683 sock_hold(&tfile->sk);
684
c8d68e6b 685 tun_set_real_num_queues(tun);
a7385ba2 686
c8d68e6b
JW
687 /* device is allowed to go away first, so no need to hold extra
688 * refcnt.
689 */
690
691out:
692 return err;
631ab46b
EB
693}
694
695static struct tun_struct *__tun_get(struct tun_file *tfile)
696{
6e914fc7 697 struct tun_struct *tun;
c70f1829 698
6e914fc7
JW
699 rcu_read_lock();
700 tun = rcu_dereference(tfile->tun);
701 if (tun)
702 dev_hold(tun->dev);
703 rcu_read_unlock();
c70f1829
EB
704
705 return tun;
631ab46b
EB
706}
707
708static struct tun_struct *tun_get(struct file *file)
709{
710 return __tun_get(file->private_data);
711}
712
713static void tun_put(struct tun_struct *tun)
714{
6e914fc7 715 dev_put(tun->dev);
631ab46b
EB
716}
717
6b8a66ee 718/* TAP filtering */
f271b2cc
MK
719static void addr_hash_set(u32 *mask, const u8 *addr)
720{
721 int n = ether_crc(ETH_ALEN, addr) >> 26;
722 mask[n >> 5] |= (1 << (n & 31));
723}
724
725static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
726{
727 int n = ether_crc(ETH_ALEN, addr) >> 26;
728 return mask[n >> 5] & (1 << (n & 31));
729}
730
731static int update_filter(struct tap_filter *filter, void __user *arg)
732{
733 struct { u8 u[ETH_ALEN]; } *addr;
734 struct tun_filter uf;
735 int err, alen, n, nexact;
736
737 if (copy_from_user(&uf, arg, sizeof(uf)))
738 return -EFAULT;
739
740 if (!uf.count) {
741 /* Disabled */
742 filter->count = 0;
743 return 0;
744 }
745
746 alen = ETH_ALEN * uf.count;
28e8190d
ME
747 addr = memdup_user(arg + sizeof(uf), alen);
748 if (IS_ERR(addr))
749 return PTR_ERR(addr);
f271b2cc
MK
750
751 /* The filter is updated without holding any locks. Which is
752 * perfectly safe. We disable it first and in the worst
753 * case we'll accept a few undesired packets. */
754 filter->count = 0;
755 wmb();
756
757 /* Use first set of addresses as an exact filter */
758 for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
759 memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
760
761 nexact = n;
762
cfbf84fc
AW
763 /* Remaining multicast addresses are hashed,
764 * unicast will leave the filter disabled. */
f271b2cc 765 memset(filter->mask, 0, sizeof(filter->mask));
cfbf84fc
AW
766 for (; n < uf.count; n++) {
767 if (!is_multicast_ether_addr(addr[n].u)) {
768 err = 0; /* no filter */
3b8d2a69 769 goto free_addr;
cfbf84fc 770 }
f271b2cc 771 addr_hash_set(filter->mask, addr[n].u);
cfbf84fc 772 }
f271b2cc
MK
773
774 /* For ALLMULTI just set the mask to all ones.
775 * This overrides the mask populated above. */
776 if ((uf.flags & TUN_FLT_ALLMULTI))
777 memset(filter->mask, ~0, sizeof(filter->mask));
778
779 /* Now enable the filter */
780 wmb();
781 filter->count = nexact;
782
783 /* Return the number of exact filters */
784 err = nexact;
3b8d2a69 785free_addr:
f271b2cc
MK
786 kfree(addr);
787 return err;
788}
789
790/* Returns: 0 - drop, !=0 - accept */
791static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
792{
793 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
794 * at this point. */
795 struct ethhdr *eh = (struct ethhdr *) skb->data;
796 int i;
797
798 /* Exact match */
799 for (i = 0; i < filter->count; i++)
2e42e474 800 if (ether_addr_equal(eh->h_dest, filter->addr[i]))
f271b2cc
MK
801 return 1;
802
803 /* Inexact match (multicast only) */
804 if (is_multicast_ether_addr(eh->h_dest))
805 return addr_hash_test(filter->mask, eh->h_dest);
806
807 return 0;
808}
809
810/*
811 * Checks whether the packet is accepted or not.
812 * Returns: 0 - drop, !=0 - accept
813 */
814static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
815{
816 if (!filter->count)
817 return 1;
818
819 return run_filter(filter, skb);
820}
821
1da177e4
LT
822/* Network device part of the driver */
823
7282d491 824static const struct ethtool_ops tun_ethtool_ops;
1da177e4 825
c70f1829
EB
826/* Net device detach from fd. */
827static void tun_net_uninit(struct net_device *dev)
828{
c8d68e6b 829 tun_detach_all(dev);
c70f1829
EB
830}
831
1da177e4
LT
832/* Net device open. */
833static int tun_net_open(struct net_device *dev)
834{
b20e2d54
HFS
835 struct tun_struct *tun = netdev_priv(dev);
836 int i;
837
c8d68e6b 838 netif_tx_start_all_queues(dev);
b20e2d54
HFS
839
840 for (i = 0; i < tun->numqueues; i++) {
841 struct tun_file *tfile;
842
843 tfile = rtnl_dereference(tun->tfiles[i]);
844 tfile->socket.sk->sk_write_space(tfile->socket.sk);
845 }
846
1da177e4
LT
847 return 0;
848}
849
850/* Net device close. */
851static int tun_net_close(struct net_device *dev)
852{
c8d68e6b 853 netif_tx_stop_all_queues(dev);
1da177e4
LT
854 return 0;
855}
856
857/* Net device start xmit */
424efe9c 858static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
1da177e4
LT
859{
860 struct tun_struct *tun = netdev_priv(dev);
c8d68e6b 861 int txq = skb->queue_mapping;
6e914fc7 862 struct tun_file *tfile;
fa35864e 863 u32 numqueues = 0;
1da177e4 864
6e914fc7 865 rcu_read_lock();
c8d68e6b 866 tfile = rcu_dereference(tun->tfiles[txq]);
fa35864e 867 numqueues = ACCESS_ONCE(tun->numqueues);
c8d68e6b 868
1da177e4 869 /* Drop packet if interface is not attached */
fa35864e 870 if (txq >= numqueues)
1da177e4
LT
871 goto drop;
872
3df97ba8
JW
873#ifdef CONFIG_RPS
874 if (numqueues == 1 && static_key_false(&rps_needed)) {
9bc88939
TH
875 /* Select queue was not called for the skbuff, so we extract the
876 * RPS hash and save it into the flow_table here.
877 */
878 __u32 rxhash;
879
feec084a 880 rxhash = __skb_get_hash_symmetric(skb);
9bc88939
TH
881 if (rxhash) {
882 struct tun_flow_entry *e;
883 e = tun_flow_find(&tun->flows[tun_hashfn(rxhash)],
884 rxhash);
885 if (e)
886 tun_flow_save_rps_rxhash(e, rxhash);
887 }
888 }
3df97ba8 889#endif
9bc88939 890
6e914fc7
JW
891 tun_debug(KERN_INFO, tun, "tun_net_xmit %d\n", skb->len);
892
c8d68e6b
JW
893 BUG_ON(!tfile);
894
f271b2cc
MK
895 /* Drop if the filter does not like it.
896 * This is a noop if the filter is disabled.
897 * Filter can be enabled only for the TAP devices. */
898 if (!check_filter(&tun->txflt, skb))
899 goto drop;
900
54f968d6
JW
901 if (tfile->socket.sk->sk_filter &&
902 sk_filter(tfile->socket.sk, skb))
99405162
MT
903 goto drop;
904
1f8b977a 905 if (unlikely(skb_orphan_frags_rx(skb, GFP_ATOMIC)))
7bf66305
JW
906 goto drop;
907
7b996243 908 skb_tx_timestamp(skb);
eda29772 909
0110d6f2 910 /* Orphan the skb - required as we might hang on to it
7bf66305
JW
911 * for indefinite time.
912 */
0110d6f2
MT
913 skb_orphan(skb);
914
f8af75f3
ED
915 nf_reset(skb);
916
1576d986
JW
917 if (skb_array_produce(&tfile->tx_array, skb))
918 goto drop;
1da177e4
LT
919
920 /* Notify and wake up reader process */
54f968d6
JW
921 if (tfile->flags & TUN_FASYNC)
922 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
9e641bdc 923 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
6e914fc7
JW
924
925 rcu_read_unlock();
6ed10654 926 return NETDEV_TX_OK;
1da177e4
LT
927
928drop:
608b9977 929 this_cpu_inc(tun->pcpu_stats->tx_dropped);
149d36f7 930 skb_tx_error(skb);
1da177e4 931 kfree_skb(skb);
6e914fc7 932 rcu_read_unlock();
baeababb 933 return NET_XMIT_DROP;
1da177e4
LT
934}
935
f271b2cc 936static void tun_net_mclist(struct net_device *dev)
1da177e4 937{
f271b2cc
MK
938 /*
939 * This callback is supposed to deal with mc filter in
940 * _rx_ path and has nothing to do with the _tx_ path.
941 * In rx path we always accept everything userspace gives us.
942 */
1da177e4
LT
943}
944
c8f44aff
MM
945static netdev_features_t tun_net_fix_features(struct net_device *dev,
946 netdev_features_t features)
88255375
MM
947{
948 struct tun_struct *tun = netdev_priv(dev);
949
950 return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
951}
bebd097a
NH
952#ifdef CONFIG_NET_POLL_CONTROLLER
953static void tun_poll_controller(struct net_device *dev)
954{
955 /*
956 * Tun only receives frames when:
957 * 1) the char device endpoint gets data from user space
958 * 2) the tun socket gets a sendmsg call from user space
92d4ea6e 959 * Since both of those are synchronous operations, we are guaranteed
bebd097a 960 * never to have pending data when we poll for it
92d4ea6e 961 * so there is nothing to do here but return.
bebd097a
NH
962 * We need this though so netpoll recognizes us as an interface that
963 * supports polling, which enables bridge devices in virt setups to
964 * still use netconsole
965 */
966 return;
967}
968#endif
eaea34b2
PA
969
970static void tun_set_headroom(struct net_device *dev, int new_hr)
971{
972 struct tun_struct *tun = netdev_priv(dev);
973
974 if (new_hr < NET_SKB_PAD)
975 new_hr = NET_SKB_PAD;
976
977 tun->align = new_hr;
978}
979
bc1f4470 980static void
608b9977
PA
981tun_net_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats)
982{
983 u32 rx_dropped = 0, tx_dropped = 0, rx_frame_errors = 0;
984 struct tun_struct *tun = netdev_priv(dev);
985 struct tun_pcpu_stats *p;
986 int i;
987
988 for_each_possible_cpu(i) {
989 u64 rxpackets, rxbytes, txpackets, txbytes;
990 unsigned int start;
991
992 p = per_cpu_ptr(tun->pcpu_stats, i);
993 do {
994 start = u64_stats_fetch_begin(&p->syncp);
995 rxpackets = p->rx_packets;
996 rxbytes = p->rx_bytes;
997 txpackets = p->tx_packets;
998 txbytes = p->tx_bytes;
999 } while (u64_stats_fetch_retry(&p->syncp, start));
1000
1001 stats->rx_packets += rxpackets;
1002 stats->rx_bytes += rxbytes;
1003 stats->tx_packets += txpackets;
1004 stats->tx_bytes += txbytes;
1005
1006 /* u32 counters */
1007 rx_dropped += p->rx_dropped;
1008 rx_frame_errors += p->rx_frame_errors;
1009 tx_dropped += p->tx_dropped;
1010 }
1011 stats->rx_dropped = rx_dropped;
1012 stats->rx_frame_errors = rx_frame_errors;
1013 stats->tx_dropped = tx_dropped;
608b9977
PA
1014}
1015
761876c8
JW
1016static int tun_xdp_set(struct net_device *dev, struct bpf_prog *prog,
1017 struct netlink_ext_ack *extack)
1018{
1019 struct tun_struct *tun = netdev_priv(dev);
1020 struct bpf_prog *old_prog;
1021
1022 old_prog = rtnl_dereference(tun->xdp_prog);
1023 rcu_assign_pointer(tun->xdp_prog, prog);
1024 if (old_prog)
1025 bpf_prog_put(old_prog);
1026
1027 return 0;
1028}
1029
1030static u32 tun_xdp_query(struct net_device *dev)
1031{
1032 struct tun_struct *tun = netdev_priv(dev);
1033 const struct bpf_prog *xdp_prog;
1034
1035 xdp_prog = rtnl_dereference(tun->xdp_prog);
1036 if (xdp_prog)
1037 return xdp_prog->aux->id;
1038
1039 return 0;
1040}
1041
1042static int tun_xdp(struct net_device *dev, struct netdev_xdp *xdp)
1043{
1044 switch (xdp->command) {
1045 case XDP_SETUP_PROG:
1046 return tun_xdp_set(dev, xdp->prog, xdp->extack);
1047 case XDP_QUERY_PROG:
1048 xdp->prog_id = tun_xdp_query(dev);
1049 xdp->prog_attached = !!xdp->prog_id;
1050 return 0;
1051 default:
1052 return -EINVAL;
1053 }
1054}
1055
758e43b7 1056static const struct net_device_ops tun_netdev_ops = {
c70f1829 1057 .ndo_uninit = tun_net_uninit,
758e43b7
SH
1058 .ndo_open = tun_net_open,
1059 .ndo_stop = tun_net_close,
00829823 1060 .ndo_start_xmit = tun_net_xmit,
88255375 1061 .ndo_fix_features = tun_net_fix_features,
c8d68e6b 1062 .ndo_select_queue = tun_select_queue,
bebd097a
NH
1063#ifdef CONFIG_NET_POLL_CONTROLLER
1064 .ndo_poll_controller = tun_poll_controller,
1065#endif
eaea34b2 1066 .ndo_set_rx_headroom = tun_set_headroom,
608b9977 1067 .ndo_get_stats64 = tun_net_get_stats64,
758e43b7
SH
1068};
1069
1070static const struct net_device_ops tap_netdev_ops = {
c70f1829 1071 .ndo_uninit = tun_net_uninit,
758e43b7
SH
1072 .ndo_open = tun_net_open,
1073 .ndo_stop = tun_net_close,
00829823 1074 .ndo_start_xmit = tun_net_xmit,
88255375 1075 .ndo_fix_features = tun_net_fix_features,
afc4b13d 1076 .ndo_set_rx_mode = tun_net_mclist,
758e43b7
SH
1077 .ndo_set_mac_address = eth_mac_addr,
1078 .ndo_validate_addr = eth_validate_addr,
c8d68e6b 1079 .ndo_select_queue = tun_select_queue,
bebd097a
NH
1080#ifdef CONFIG_NET_POLL_CONTROLLER
1081 .ndo_poll_controller = tun_poll_controller,
1082#endif
5e52796a 1083 .ndo_features_check = passthru_features_check,
eaea34b2 1084 .ndo_set_rx_headroom = tun_set_headroom,
608b9977 1085 .ndo_get_stats64 = tun_net_get_stats64,
761876c8 1086 .ndo_xdp = tun_xdp,
758e43b7
SH
1087};
1088
944a1376 1089static void tun_flow_init(struct tun_struct *tun)
96442e42
JW
1090{
1091 int i;
1092
96442e42
JW
1093 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
1094 INIT_HLIST_HEAD(&tun->flows[i]);
1095
1096 tun->ageing_time = TUN_FLOW_EXPIRE;
1097 setup_timer(&tun->flow_gc_timer, tun_flow_cleanup, (unsigned long)tun);
1098 mod_timer(&tun->flow_gc_timer,
1099 round_jiffies_up(jiffies + tun->ageing_time));
96442e42
JW
1100}
1101
1102static void tun_flow_uninit(struct tun_struct *tun)
1103{
1104 del_timer_sync(&tun->flow_gc_timer);
1105 tun_flow_flush(tun);
96442e42
JW
1106}
1107
91572088
JW
1108#define MIN_MTU 68
1109#define MAX_MTU 65535
1110
1da177e4
LT
1111/* Initialize net device. */
1112static void tun_net_init(struct net_device *dev)
1113{
1114 struct tun_struct *tun = netdev_priv(dev);
6aa20a22 1115
1da177e4 1116 switch (tun->flags & TUN_TYPE_MASK) {
40630b82 1117 case IFF_TUN:
758e43b7
SH
1118 dev->netdev_ops = &tun_netdev_ops;
1119
1da177e4
LT
1120 /* Point-to-Point TUN Device */
1121 dev->hard_header_len = 0;
1122 dev->addr_len = 0;
1123 dev->mtu = 1500;
1124
1125 /* Zero header length */
6aa20a22 1126 dev->type = ARPHRD_NONE;
1da177e4 1127 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
1da177e4
LT
1128 break;
1129
40630b82 1130 case IFF_TAP:
7a0a9608 1131 dev->netdev_ops = &tap_netdev_ops;
1da177e4 1132 /* Ethernet TAP Device */
1da177e4 1133 ether_setup(dev);
550fd08c 1134 dev->priv_flags &= ~IFF_TX_SKB_SHARING;
a676847b 1135 dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
36226a8d 1136
f2cedb63 1137 eth_hw_addr_random(dev);
36226a8d 1138
1da177e4
LT
1139 break;
1140 }
91572088
JW
1141
1142 dev->min_mtu = MIN_MTU;
1143 dev->max_mtu = MAX_MTU - dev->hard_header_len;
1da177e4
LT
1144}
1145
1146/* Character device part */
1147
1148/* Poll */
c8d68e6b 1149static unsigned int tun_chr_poll(struct file *file, poll_table *wait)
6aa20a22 1150{
b2430de3
EB
1151 struct tun_file *tfile = file->private_data;
1152 struct tun_struct *tun = __tun_get(tfile);
3c8a9c63 1153 struct sock *sk;
33dccbb0 1154 unsigned int mask = 0;
1da177e4
LT
1155
1156 if (!tun)
eac9e902 1157 return POLLERR;
1da177e4 1158
54f968d6 1159 sk = tfile->socket.sk;
3c8a9c63 1160
6b8a66ee 1161 tun_debug(KERN_INFO, tun, "tun_chr_poll\n");
1da177e4 1162
9e641bdc 1163 poll_wait(file, sk_sleep(sk), wait);
6aa20a22 1164
1576d986 1165 if (!skb_array_empty(&tfile->tx_array))
1da177e4
LT
1166 mask |= POLLIN | POLLRDNORM;
1167
b20e2d54
HFS
1168 if (tun->dev->flags & IFF_UP &&
1169 (sock_writeable(sk) ||
1170 (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
1171 sock_writeable(sk))))
33dccbb0
HX
1172 mask |= POLLOUT | POLLWRNORM;
1173
c70f1829
EB
1174 if (tun->dev->reg_state != NETREG_REGISTERED)
1175 mask = POLLERR;
1176
631ab46b 1177 tun_put(tun);
1da177e4
LT
1178 return mask;
1179}
1180
f42157cb
RR
1181/* prepad is the amount to reserve at front. len is length after that.
1182 * linear is a hint as to how much to copy (usually headers). */
54f968d6 1183static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
6f7c156c 1184 size_t prepad, size_t len,
1185 size_t linear, int noblock)
f42157cb 1186{
54f968d6 1187 struct sock *sk = tfile->socket.sk;
f42157cb 1188 struct sk_buff *skb;
33dccbb0 1189 int err;
f42157cb
RR
1190
1191 /* Under a page? Don't bother with paged skb. */
0eca93bc 1192 if (prepad + len < PAGE_SIZE || !linear)
33dccbb0 1193 linear = len;
f42157cb 1194
33dccbb0 1195 skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
28d64271 1196 &err, 0);
f42157cb 1197 if (!skb)
33dccbb0 1198 return ERR_PTR(err);
f42157cb
RR
1199
1200 skb_reserve(skb, prepad);
1201 skb_put(skb, linear);
33dccbb0
HX
1202 skb->data_len = len - linear;
1203 skb->len += len - linear;
f42157cb
RR
1204
1205 return skb;
1206}
1207
5503fcec
JW
1208static void tun_rx_batched(struct tun_struct *tun, struct tun_file *tfile,
1209 struct sk_buff *skb, int more)
1210{
1211 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1212 struct sk_buff_head process_queue;
1213 u32 rx_batched = tun->rx_batched;
1214 bool rcv = false;
1215
1216 if (!rx_batched || (!more && skb_queue_empty(queue))) {
1217 local_bh_disable();
1218 netif_receive_skb(skb);
1219 local_bh_enable();
1220 return;
1221 }
1222
1223 spin_lock(&queue->lock);
1224 if (!more || skb_queue_len(queue) == rx_batched) {
1225 __skb_queue_head_init(&process_queue);
1226 skb_queue_splice_tail_init(queue, &process_queue);
1227 rcv = true;
1228 } else {
1229 __skb_queue_tail(queue, skb);
1230 }
1231 spin_unlock(&queue->lock);
1232
1233 if (rcv) {
1234 struct sk_buff *nskb;
1235
1236 local_bh_disable();
1237 while ((nskb = __skb_dequeue(&process_queue)))
1238 netif_receive_skb(nskb);
1239 netif_receive_skb(skb);
1240 local_bh_enable();
1241 }
1242}
1243
66ccbc9c
JW
1244static bool tun_can_build_skb(struct tun_struct *tun, struct tun_file *tfile,
1245 int len, int noblock, bool zerocopy)
1246{
1247 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
1248 return false;
1249
1250 if (tfile->socket.sk->sk_sndbuf != INT_MAX)
1251 return false;
1252
1253 if (!noblock)
1254 return false;
1255
1256 if (zerocopy)
1257 return false;
1258
1259 if (SKB_DATA_ALIGN(len + TUN_RX_PAD) +
1260 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
1261 return false;
1262
1263 return true;
1264}
1265
761876c8
JW
1266static struct sk_buff *tun_build_skb(struct tun_struct *tun,
1267 struct tun_file *tfile,
66ccbc9c 1268 struct iov_iter *from,
761876c8 1269 struct virtio_net_hdr *hdr,
1cfe6e93 1270 int len, int *skb_xdp)
66ccbc9c 1271{
0bbd7dad 1272 struct page_frag *alloc_frag = &current->task_frag;
66ccbc9c 1273 struct sk_buff *skb;
761876c8 1274 struct bpf_prog *xdp_prog;
7df13219 1275 int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
761876c8 1276 unsigned int delta = 0;
66ccbc9c
JW
1277 char *buf;
1278 size_t copied;
761876c8 1279 bool xdp_xmit = false;
7df13219
JW
1280 int err, pad = TUN_RX_PAD;
1281
1282 rcu_read_lock();
1283 xdp_prog = rcu_dereference(tun->xdp_prog);
1284 if (xdp_prog)
1285 pad += TUN_HEADROOM;
1286 buflen += SKB_DATA_ALIGN(len + pad);
1287 rcu_read_unlock();
66ccbc9c 1288
63b9ab65 1289 alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
66ccbc9c
JW
1290 if (unlikely(!skb_page_frag_refill(buflen, alloc_frag, GFP_KERNEL)))
1291 return ERR_PTR(-ENOMEM);
1292
1293 buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
1294 copied = copy_page_from_iter(alloc_frag->page,
7df13219 1295 alloc_frag->offset + pad,
66ccbc9c
JW
1296 len, from);
1297 if (copied != len)
1298 return ERR_PTR(-EFAULT);
1299
7df13219
JW
1300 /* There's a small window that XDP may be set after the check
1301 * of xdp_prog above, this should be rare and for simplicity
1302 * we do XDP on skb in case the headroom is not enough.
1303 */
1304 if (hdr->gso_type || !xdp_prog)
1cfe6e93 1305 *skb_xdp = 1;
761876c8 1306 else
1cfe6e93 1307 *skb_xdp = 0;
761876c8
JW
1308
1309 rcu_read_lock();
1310 xdp_prog = rcu_dereference(tun->xdp_prog);
1cfe6e93 1311 if (xdp_prog && !*skb_xdp) {
761876c8
JW
1312 struct xdp_buff xdp;
1313 void *orig_data;
1314 u32 act;
1315
1316 xdp.data_hard_start = buf;
7df13219 1317 xdp.data = buf + pad;
761876c8
JW
1318 xdp.data_end = xdp.data + len;
1319 orig_data = xdp.data;
1320 act = bpf_prog_run_xdp(xdp_prog, &xdp);
1321
1322 switch (act) {
1323 case XDP_REDIRECT:
1324 get_page(alloc_frag->page);
1325 alloc_frag->offset += buflen;
1326 err = xdp_do_redirect(tun->dev, &xdp, xdp_prog);
1327 if (err)
1328 goto err_redirect;
1329 return NULL;
1330 case XDP_TX:
1331 xdp_xmit = true;
1332 /* fall through */
1333 case XDP_PASS:
1334 delta = orig_data - xdp.data;
1335 break;
1336 default:
1337 bpf_warn_invalid_xdp_action(act);
1338 /* fall through */
1339 case XDP_ABORTED:
1340 trace_xdp_exception(tun->dev, xdp_prog, act);
1341 /* fall through */
1342 case XDP_DROP:
1343 goto err_xdp;
1344 }
1345 }
1346
66ccbc9c 1347 skb = build_skb(buf, buflen);
761876c8
JW
1348 if (!skb) {
1349 rcu_read_unlock();
66ccbc9c 1350 return ERR_PTR(-ENOMEM);
761876c8 1351 }
66ccbc9c 1352
7df13219 1353 skb_reserve(skb, pad - delta);
761876c8 1354 skb_put(skb, len + delta);
66ccbc9c
JW
1355 get_page(alloc_frag->page);
1356 alloc_frag->offset += buflen;
1357
761876c8
JW
1358 if (xdp_xmit) {
1359 skb->dev = tun->dev;
1360 generic_xdp_tx(skb, xdp_prog);
1361 rcu_read_lock();
1362 return NULL;
1363 }
1364
1365 rcu_read_unlock();
1366
66ccbc9c 1367 return skb;
761876c8
JW
1368
1369err_redirect:
1370 put_page(alloc_frag->page);
1371err_xdp:
1372 rcu_read_unlock();
1373 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1374 return NULL;
66ccbc9c
JW
1375}
1376
1da177e4 1377/* Get packet from user space buffer */
54f968d6 1378static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
f5ff53b4 1379 void *msg_control, struct iov_iter *from,
5503fcec 1380 int noblock, bool more)
1da177e4 1381{
09640e63 1382 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1da177e4 1383 struct sk_buff *skb;
f5ff53b4 1384 size_t total_len = iov_iter_count(from);
eaea34b2 1385 size_t len = total_len, align = tun->align, linear;
f43798c2 1386 struct virtio_net_hdr gso = { 0 };
608b9977 1387 struct tun_pcpu_stats *stats;
96f8d9ec 1388 int good_linear;
0690899b
MT
1389 int copylen;
1390 bool zerocopy = false;
1391 int err;
49974420 1392 u32 rxhash;
1cfe6e93 1393 int skb_xdp = 1;
1da177e4 1394
1bd4978a
ED
1395 if (!(tun->dev->flags & IFF_UP))
1396 return -EIO;
1397
40630b82 1398 if (!(tun->flags & IFF_NO_PI)) {
15718ea0 1399 if (len < sizeof(pi))
1da177e4 1400 return -EINVAL;
15718ea0 1401 len -= sizeof(pi);
1da177e4 1402
cbbd26b8 1403 if (!copy_from_iter_full(&pi, sizeof(pi), from))
1da177e4
LT
1404 return -EFAULT;
1405 }
1406
40630b82 1407 if (tun->flags & IFF_VNET_HDR) {
e1edab87
WB
1408 int vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1409
1410 if (len < vnet_hdr_sz)
f43798c2 1411 return -EINVAL;
e1edab87 1412 len -= vnet_hdr_sz;
f43798c2 1413
cbbd26b8 1414 if (!copy_from_iter_full(&gso, sizeof(gso), from))
f43798c2
RR
1415 return -EFAULT;
1416
4909122f 1417 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
56f0dcc5
MT
1418 tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1419 gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
4909122f 1420
56f0dcc5 1421 if (tun16_to_cpu(tun, gso.hdr_len) > len)
f43798c2 1422 return -EINVAL;
e1edab87 1423 iov_iter_advance(from, vnet_hdr_sz - sizeof(gso));
f43798c2
RR
1424 }
1425
40630b82 1426 if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
a504b86e 1427 align += NET_IP_ALIGN;
0eca93bc 1428 if (unlikely(len < ETH_HLEN ||
56f0dcc5 1429 (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
e01bf1c8
RR
1430 return -EINVAL;
1431 }
6aa20a22 1432
96f8d9ec
JW
1433 good_linear = SKB_MAX_HEAD(align);
1434
88529176 1435 if (msg_control) {
f5ff53b4
AV
1436 struct iov_iter i = *from;
1437
88529176
JW
1438 /* There are 256 bytes to be copied in skb, so there is
1439 * enough room for skb expand head in case it is used.
0690899b
MT
1440 * The rest of the buffer is mapped from userspace.
1441 */
56f0dcc5 1442 copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
96f8d9ec
JW
1443 if (copylen > good_linear)
1444 copylen = good_linear;
3dd5c330 1445 linear = copylen;
f5ff53b4
AV
1446 iov_iter_advance(&i, copylen);
1447 if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
88529176
JW
1448 zerocopy = true;
1449 }
1450
66ccbc9c 1451 if (tun_can_build_skb(tun, tfile, len, noblock, zerocopy)) {
1cfe6e93
JW
1452 /* For the packet that is not easy to be processed
1453 * (e.g gso or jumbo packet), we will do it at after
1454 * skb was created with generic XDP routine.
1455 */
1456 skb = tun_build_skb(tun, tfile, from, &gso, len, &skb_xdp);
66ccbc9c 1457 if (IS_ERR(skb)) {
608b9977 1458 this_cpu_inc(tun->pcpu_stats->rx_dropped);
66ccbc9c
JW
1459 return PTR_ERR(skb);
1460 }
761876c8
JW
1461 if (!skb)
1462 return total_len;
66ccbc9c
JW
1463 } else {
1464 if (!zerocopy) {
1465 copylen = len;
1466 if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1467 linear = good_linear;
1468 else
1469 linear = tun16_to_cpu(tun, gso.hdr_len);
1470 }
1da177e4 1471
66ccbc9c
JW
1472 skb = tun_alloc_skb(tfile, align, copylen, linear, noblock);
1473 if (IS_ERR(skb)) {
1474 if (PTR_ERR(skb) != -EAGAIN)
1475 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1476 return PTR_ERR(skb);
1477 }
0690899b 1478
66ccbc9c
JW
1479 if (zerocopy)
1480 err = zerocopy_sg_from_iter(skb, from);
1481 else
1482 err = skb_copy_datagram_from_iter(skb, 0, from, len);
1483
1484 if (err) {
1485 this_cpu_inc(tun->pcpu_stats->rx_dropped);
1486 kfree_skb(skb);
1487 return -EFAULT;
1488 }
8f22757e 1489 }
1da177e4 1490
3e9e40e7 1491 if (virtio_net_hdr_to_skb(skb, &gso, tun_is_little_endian(tun))) {
df10db98
PA
1492 this_cpu_inc(tun->pcpu_stats->rx_frame_errors);
1493 kfree_skb(skb);
1494 return -EINVAL;
1495 }
1496
1da177e4 1497 switch (tun->flags & TUN_TYPE_MASK) {
40630b82
MT
1498 case IFF_TUN:
1499 if (tun->flags & IFF_NO_PI) {
2580c4c1
AP
1500 u8 ip_version = skb->len ? (skb->data[0] >> 4) : 0;
1501
1502 switch (ip_version) {
1503 case 4:
f09f7ee2
AWC
1504 pi.proto = htons(ETH_P_IP);
1505 break;
2580c4c1 1506 case 6:
f09f7ee2
AWC
1507 pi.proto = htons(ETH_P_IPV6);
1508 break;
1509 default:
608b9977 1510 this_cpu_inc(tun->pcpu_stats->rx_dropped);
f09f7ee2
AWC
1511 kfree_skb(skb);
1512 return -EINVAL;
1513 }
1514 }
1515
459a98ed 1516 skb_reset_mac_header(skb);
1da177e4 1517 skb->protocol = pi.proto;
4c13eb66 1518 skb->dev = tun->dev;
1da177e4 1519 break;
40630b82 1520 case IFF_TAP:
1da177e4
LT
1521 skb->protocol = eth_type_trans(skb, tun->dev);
1522 break;
6403eab1 1523 }
1da177e4 1524
0690899b
MT
1525 /* copy skb_ubuf_info for callback when skb has no error */
1526 if (zerocopy) {
1527 skb_shinfo(skb)->destructor_arg = msg_control;
1528 skb_shinfo(skb)->tx_flags |= SKBTX_DEV_ZEROCOPY;
c9af6db4 1529 skb_shinfo(skb)->tx_flags |= SKBTX_SHARED_FRAG;
af1cc7a2
JW
1530 } else if (msg_control) {
1531 struct ubuf_info *uarg = msg_control;
1532 uarg->callback(uarg, false);
0690899b
MT
1533 }
1534
72f65107 1535 skb_reset_network_header(skb);
40893fd0 1536 skb_probe_transport_header(skb, 0);
38502af7 1537
1cfe6e93 1538 if (skb_xdp) {
761876c8
JW
1539 struct bpf_prog *xdp_prog;
1540 int ret;
1541
1542 rcu_read_lock();
1543 xdp_prog = rcu_dereference(tun->xdp_prog);
1544 if (xdp_prog) {
1545 ret = do_xdp_generic(xdp_prog, skb);
1546 if (ret != XDP_PASS) {
1547 rcu_read_unlock();
1548 return total_len;
1549 }
1550 }
1551 rcu_read_unlock();
1552 }
1553
feec084a 1554 rxhash = __skb_get_hash_symmetric(skb);
d4aea20d 1555#ifndef CONFIG_4KSTACKS
5503fcec 1556 tun_rx_batched(tun, tfile, skb, more);
d4aea20d 1557#else
1da177e4 1558 netif_rx_ni(skb);
d4aea20d 1559#endif
6aa20a22 1560
608b9977
PA
1561 stats = get_cpu_ptr(tun->pcpu_stats);
1562 u64_stats_update_begin(&stats->syncp);
1563 stats->rx_packets++;
1564 stats->rx_bytes += len;
1565 u64_stats_update_end(&stats->syncp);
1566 put_cpu_ptr(stats);
1da177e4 1567
9e85722d 1568 tun_flow_update(tun, rxhash, tfile);
0690899b 1569 return total_len;
6aa20a22 1570}
1da177e4 1571
f5ff53b4 1572static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
1da177e4 1573{
33dccbb0 1574 struct file *file = iocb->ki_filp;
ab46d779 1575 struct tun_struct *tun = tun_get(file);
54f968d6 1576 struct tun_file *tfile = file->private_data;
631ab46b 1577 ssize_t result;
1da177e4
LT
1578
1579 if (!tun)
1580 return -EBADFD;
1581
5503fcec
JW
1582 result = tun_get_user(tun, tfile, NULL, from,
1583 file->f_flags & O_NONBLOCK, false);
631ab46b
EB
1584
1585 tun_put(tun);
1586 return result;
1da177e4
LT
1587}
1588
1da177e4 1589/* Put packet to the user space buffer */
6f7c156c 1590static ssize_t tun_put_user(struct tun_struct *tun,
54f968d6 1591 struct tun_file *tfile,
6f7c156c 1592 struct sk_buff *skb,
e0b46d0e 1593 struct iov_iter *iter)
1da177e4
LT
1594{
1595 struct tun_pi pi = { 0, skb->protocol };
608b9977 1596 struct tun_pcpu_stats *stats;
e0b46d0e 1597 ssize_t total;
8c847d25 1598 int vlan_offset = 0;
a8f9bfdf 1599 int vlan_hlen = 0;
2eb783c4 1600 int vnet_hdr_sz = 0;
a8f9bfdf 1601
df8a39de 1602 if (skb_vlan_tag_present(skb))
a8f9bfdf 1603 vlan_hlen = VLAN_HLEN;
1da177e4 1604
40630b82 1605 if (tun->flags & IFF_VNET_HDR)
e1edab87 1606 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1da177e4 1607
e0b46d0e
HX
1608 total = skb->len + vlan_hlen + vnet_hdr_sz;
1609
40630b82 1610 if (!(tun->flags & IFF_NO_PI)) {
e0b46d0e 1611 if (iov_iter_count(iter) < sizeof(pi))
1da177e4
LT
1612 return -EINVAL;
1613
e0b46d0e
HX
1614 total += sizeof(pi);
1615 if (iov_iter_count(iter) < total) {
1da177e4
LT
1616 /* Packet will be striped */
1617 pi.flags |= TUN_PKT_STRIP;
1618 }
6aa20a22 1619
e0b46d0e 1620 if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
1da177e4 1621 return -EFAULT;
6aa20a22 1622 }
1da177e4 1623
2eb783c4 1624 if (vnet_hdr_sz) {
9403cd7c 1625 struct virtio_net_hdr gso;
34166093 1626
e0b46d0e 1627 if (iov_iter_count(iter) < vnet_hdr_sz)
f43798c2
RR
1628 return -EINVAL;
1629
3e9e40e7 1630 if (virtio_net_hdr_from_skb(skb, &gso,
6391a448 1631 tun_is_little_endian(tun), true)) {
f43798c2 1632 struct skb_shared_info *sinfo = skb_shinfo(skb);
34166093
MR
1633 pr_err("unexpected GSO type: "
1634 "0x%x, gso_size %d, hdr_len %d\n",
1635 sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
1636 tun16_to_cpu(tun, gso.hdr_len));
1637 print_hex_dump(KERN_ERR, "tun: ",
1638 DUMP_PREFIX_NONE,
1639 16, 1, skb->head,
1640 min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
1641 WARN_ON_ONCE(1);
1642 return -EINVAL;
1643 }
f43798c2 1644
e0b46d0e 1645 if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
f43798c2 1646 return -EFAULT;
8c847d25
JW
1647
1648 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
f43798c2
RR
1649 }
1650
a8f9bfdf 1651 if (vlan_hlen) {
e0b46d0e 1652 int ret;
6680ec68
JW
1653 struct {
1654 __be16 h_vlan_proto;
1655 __be16 h_vlan_TCI;
1656 } veth;
1657
1658 veth.h_vlan_proto = skb->vlan_proto;
df8a39de 1659 veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
6680ec68
JW
1660
1661 vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
6680ec68 1662
e0b46d0e
HX
1663 ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
1664 if (ret || !iov_iter_count(iter))
6680ec68
JW
1665 goto done;
1666
e0b46d0e
HX
1667 ret = copy_to_iter(&veth, sizeof(veth), iter);
1668 if (ret != sizeof(veth) || !iov_iter_count(iter))
6680ec68
JW
1669 goto done;
1670 }
1da177e4 1671
e0b46d0e 1672 skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
1da177e4 1673
6680ec68 1674done:
608b9977
PA
1675 /* caller is in process context, */
1676 stats = get_cpu_ptr(tun->pcpu_stats);
1677 u64_stats_update_begin(&stats->syncp);
1678 stats->tx_packets++;
1679 stats->tx_bytes += skb->len + vlan_hlen;
1680 u64_stats_update_end(&stats->syncp);
1681 put_cpu_ptr(tun->pcpu_stats);
1da177e4
LT
1682
1683 return total;
1684}
1685
1576d986
JW
1686static struct sk_buff *tun_ring_recv(struct tun_file *tfile, int noblock,
1687 int *err)
1688{
1689 DECLARE_WAITQUEUE(wait, current);
1690 struct sk_buff *skb = NULL;
f48cc6b2 1691 int error = 0;
1576d986
JW
1692
1693 skb = skb_array_consume(&tfile->tx_array);
1694 if (skb)
1695 goto out;
1696 if (noblock) {
f48cc6b2 1697 error = -EAGAIN;
1576d986
JW
1698 goto out;
1699 }
1700
1701 add_wait_queue(&tfile->wq.wait, &wait);
1702 current->state = TASK_INTERRUPTIBLE;
1703
1704 while (1) {
1705 skb = skb_array_consume(&tfile->tx_array);
1706 if (skb)
1707 break;
1708 if (signal_pending(current)) {
f48cc6b2 1709 error = -ERESTARTSYS;
1576d986
JW
1710 break;
1711 }
1712 if (tfile->socket.sk->sk_shutdown & RCV_SHUTDOWN) {
f48cc6b2 1713 error = -EFAULT;
1576d986
JW
1714 break;
1715 }
1716
1717 schedule();
1718 }
1719
1720 current->state = TASK_RUNNING;
1721 remove_wait_queue(&tfile->wq.wait, &wait);
1722
1723out:
f48cc6b2 1724 *err = error;
1576d986
JW
1725 return skb;
1726}
1727
54f968d6 1728static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
9b067034 1729 struct iov_iter *to,
ac77cfd4 1730 int noblock, struct sk_buff *skb)
1da177e4 1731{
9b067034 1732 ssize_t ret;
1576d986 1733 int err;
1da177e4 1734
3872baf6 1735 tun_debug(KERN_INFO, tun, "tun_do_read\n");
1da177e4 1736
9b067034
AV
1737 if (!iov_iter_count(to))
1738 return 0;
1da177e4 1739
ac77cfd4
JW
1740 if (!skb) {
1741 /* Read frames from ring */
1742 skb = tun_ring_recv(tfile, noblock, &err);
1743 if (!skb)
1744 return err;
1745 }
e0b46d0e 1746
9b067034 1747 ret = tun_put_user(tun, tfile, skb, to);
f51a5e82 1748 if (unlikely(ret < 0))
f271b2cc 1749 kfree_skb(skb);
f51a5e82
JW
1750 else
1751 consume_skb(skb);
1da177e4 1752
05c2828c
MT
1753 return ret;
1754}
1755
9b067034 1756static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
05c2828c
MT
1757{
1758 struct file *file = iocb->ki_filp;
1759 struct tun_file *tfile = file->private_data;
1760 struct tun_struct *tun = __tun_get(tfile);
9b067034 1761 ssize_t len = iov_iter_count(to), ret;
05c2828c
MT
1762
1763 if (!tun)
1764 return -EBADFD;
ac77cfd4 1765 ret = tun_do_read(tun, tfile, to, file->f_flags & O_NONBLOCK, NULL);
42404c09 1766 ret = min_t(ssize_t, ret, len);
d0b7da8a
ZYW
1767 if (ret > 0)
1768 iocb->ki_pos = ret;
631ab46b 1769 tun_put(tun);
1da177e4
LT
1770 return ret;
1771}
1772
96442e42
JW
1773static void tun_free_netdev(struct net_device *dev)
1774{
1775 struct tun_struct *tun = netdev_priv(dev);
1776
4008e97f 1777 BUG_ON(!(list_empty(&tun->disabled)));
608b9977 1778 free_percpu(tun->pcpu_stats);
96442e42 1779 tun_flow_uninit(tun);
5dbbaf2d 1780 security_tun_dev_free_security(tun->security);
96442e42
JW
1781}
1782
1da177e4
LT
1783static void tun_setup(struct net_device *dev)
1784{
1785 struct tun_struct *tun = netdev_priv(dev);
1786
0625c883
EB
1787 tun->owner = INVALID_UID;
1788 tun->group = INVALID_GID;
1da177e4 1789
1da177e4 1790 dev->ethtool_ops = &tun_ethtool_ops;
cf124db5
DM
1791 dev->needs_free_netdev = true;
1792 dev->priv_destructor = tun_free_netdev;
016adb72
JW
1793 /* We prefer our own queue length */
1794 dev->tx_queue_len = TUN_READQ_SIZE;
1da177e4
LT
1795}
1796
f019a7a5
EB
1797/* Trivial set of netlink ops to allow deleting tun or tap
1798 * device with netlink.
1799 */
a8b8a889
MS
1800static int tun_validate(struct nlattr *tb[], struct nlattr *data[],
1801 struct netlink_ext_ack *extack)
f019a7a5
EB
1802{
1803 return -EINVAL;
1804}
1805
1806static struct rtnl_link_ops tun_link_ops __read_mostly = {
1807 .kind = DRV_NAME,
1808 .priv_size = sizeof(struct tun_struct),
1809 .setup = tun_setup,
1810 .validate = tun_validate,
1811};
1812
33dccbb0
HX
1813static void tun_sock_write_space(struct sock *sk)
1814{
54f968d6 1815 struct tun_file *tfile;
43815482 1816 wait_queue_head_t *wqueue;
33dccbb0
HX
1817
1818 if (!sock_writeable(sk))
1819 return;
1820
9cd3e072 1821 if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
33dccbb0
HX
1822 return;
1823
43815482
ED
1824 wqueue = sk_sleep(sk);
1825 if (wqueue && waitqueue_active(wqueue))
1826 wake_up_interruptible_sync_poll(wqueue, POLLOUT |
05c2828c 1827 POLLWRNORM | POLLWRBAND);
c722c625 1828
54f968d6
JW
1829 tfile = container_of(sk, struct tun_file, sk);
1830 kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
33dccbb0
HX
1831}
1832
1b784140 1833static int tun_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
05c2828c 1834{
54f968d6
JW
1835 int ret;
1836 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
1837 struct tun_struct *tun = __tun_get(tfile);
1838
1839 if (!tun)
1840 return -EBADFD;
f5ff53b4 1841
c0371da6 1842 ret = tun_get_user(tun, tfile, m->msg_control, &m->msg_iter,
5503fcec
JW
1843 m->msg_flags & MSG_DONTWAIT,
1844 m->msg_flags & MSG_MORE);
54f968d6
JW
1845 tun_put(tun);
1846 return ret;
05c2828c
MT
1847}
1848
1b784140 1849static int tun_recvmsg(struct socket *sock, struct msghdr *m, size_t total_len,
05c2828c
MT
1850 int flags)
1851{
54f968d6
JW
1852 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
1853 struct tun_struct *tun = __tun_get(tfile);
05c2828c 1854 int ret;
54f968d6
JW
1855
1856 if (!tun)
1857 return -EBADFD;
1858
eda29772 1859 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
3811ae76
G
1860 ret = -EINVAL;
1861 goto out;
1862 }
eda29772
RC
1863 if (flags & MSG_ERRQUEUE) {
1864 ret = sock_recv_errqueue(sock->sk, m, total_len,
1865 SOL_PACKET, TUN_TX_TIMESTAMP);
1866 goto out;
1867 }
ac77cfd4
JW
1868 ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT,
1869 m->msg_control);
87897931 1870 if (ret > (ssize_t)total_len) {
42404c09
DM
1871 m->msg_flags |= MSG_TRUNC;
1872 ret = flags & MSG_TRUNC ? ret : total_len;
1873 }
3811ae76 1874out:
54f968d6 1875 tun_put(tun);
05c2828c
MT
1876 return ret;
1877}
1878
1576d986
JW
1879static int tun_peek_len(struct socket *sock)
1880{
1881 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
1882 struct tun_struct *tun;
1883 int ret = 0;
1884
1885 tun = __tun_get(tfile);
1886 if (!tun)
1887 return 0;
1888
1889 ret = skb_array_peek_len(&tfile->tx_array);
1890 tun_put(tun);
1891
1892 return ret;
1893}
1894
05c2828c
MT
1895/* Ops structure to mimic raw sockets with tun */
1896static const struct proto_ops tun_socket_ops = {
1576d986 1897 .peek_len = tun_peek_len,
05c2828c
MT
1898 .sendmsg = tun_sendmsg,
1899 .recvmsg = tun_recvmsg,
1900};
1901
33dccbb0
HX
1902static struct proto tun_proto = {
1903 .name = "tun",
1904 .owner = THIS_MODULE,
54f968d6 1905 .obj_size = sizeof(struct tun_file),
33dccbb0 1906};
f019a7a5 1907
980c9e8c
DW
1908static int tun_flags(struct tun_struct *tun)
1909{
031f5e03 1910 return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
980c9e8c
DW
1911}
1912
1913static ssize_t tun_show_flags(struct device *dev, struct device_attribute *attr,
1914 char *buf)
1915{
1916 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
1917 return sprintf(buf, "0x%x\n", tun_flags(tun));
1918}
1919
1920static ssize_t tun_show_owner(struct device *dev, struct device_attribute *attr,
1921 char *buf)
1922{
1923 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
0625c883
EB
1924 return uid_valid(tun->owner)?
1925 sprintf(buf, "%u\n",
1926 from_kuid_munged(current_user_ns(), tun->owner)):
1927 sprintf(buf, "-1\n");
980c9e8c
DW
1928}
1929
1930static ssize_t tun_show_group(struct device *dev, struct device_attribute *attr,
1931 char *buf)
1932{
1933 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
0625c883
EB
1934 return gid_valid(tun->group) ?
1935 sprintf(buf, "%u\n",
1936 from_kgid_munged(current_user_ns(), tun->group)):
1937 sprintf(buf, "-1\n");
980c9e8c
DW
1938}
1939
1940static DEVICE_ATTR(tun_flags, 0444, tun_show_flags, NULL);
1941static DEVICE_ATTR(owner, 0444, tun_show_owner, NULL);
1942static DEVICE_ATTR(group, 0444, tun_show_group, NULL);
1943
c4d33e24
TI
1944static struct attribute *tun_dev_attrs[] = {
1945 &dev_attr_tun_flags.attr,
1946 &dev_attr_owner.attr,
1947 &dev_attr_group.attr,
1948 NULL
1949};
1950
1951static const struct attribute_group tun_attr_group = {
1952 .attrs = tun_dev_attrs
1953};
1954
d647a591 1955static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
1da177e4
LT
1956{
1957 struct tun_struct *tun;
54f968d6 1958 struct tun_file *tfile = file->private_data;
1da177e4
LT
1959 struct net_device *dev;
1960 int err;
1961
7c0c3b1a
JW
1962 if (tfile->detached)
1963 return -EINVAL;
1964
74a3e5a7
EB
1965 dev = __dev_get_by_name(net, ifr->ifr_name);
1966 if (dev) {
f85ba780
DW
1967 if (ifr->ifr_flags & IFF_TUN_EXCL)
1968 return -EBUSY;
74a3e5a7
EB
1969 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
1970 tun = netdev_priv(dev);
1971 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
1972 tun = netdev_priv(dev);
1973 else
1974 return -EINVAL;
1975
8e6d91ae 1976 if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
40630b82 1977 !!(tun->flags & IFF_MULTI_QUEUE))
8e6d91ae
JW
1978 return -EINVAL;
1979
cde8b15f 1980 if (tun_not_capable(tun))
2b980dbd 1981 return -EPERM;
5dbbaf2d 1982 err = security_tun_dev_open(tun->security);
2b980dbd
PM
1983 if (err < 0)
1984 return err;
1985
849c9b6f 1986 err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER);
a7385ba2
EB
1987 if (err < 0)
1988 return err;
4008e97f 1989
40630b82 1990 if (tun->flags & IFF_MULTI_QUEUE &&
e8dbad66
JW
1991 (tun->numqueues + tun->numdisabled > 1)) {
1992 /* One or more queue has already been attached, no need
1993 * to initialize the device again.
1994 */
1995 return 0;
1996 }
6aa20a22 1997 }
1da177e4
LT
1998 else {
1999 char *name;
2000 unsigned long flags = 0;
edfb6a14
JW
2001 int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
2002 MAX_TAP_QUEUES : 1;
1da177e4 2003
c260b772 2004 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
ca6bb5d7 2005 return -EPERM;
2b980dbd
PM
2006 err = security_tun_dev_create();
2007 if (err < 0)
2008 return err;
ca6bb5d7 2009
1da177e4
LT
2010 /* Set dev type */
2011 if (ifr->ifr_flags & IFF_TUN) {
2012 /* TUN device */
40630b82 2013 flags |= IFF_TUN;
1da177e4
LT
2014 name = "tun%d";
2015 } else if (ifr->ifr_flags & IFF_TAP) {
2016 /* TAP device */
40630b82 2017 flags |= IFF_TAP;
1da177e4 2018 name = "tap%d";
6aa20a22 2019 } else
36989b90 2020 return -EINVAL;
6aa20a22 2021
1da177e4
LT
2022 if (*ifr->ifr_name)
2023 name = ifr->ifr_name;
2024
c8d68e6b 2025 dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
c835a677
TG
2026 NET_NAME_UNKNOWN, tun_setup, queues,
2027 queues);
edfb6a14 2028
1da177e4
LT
2029 if (!dev)
2030 return -ENOMEM;
0ad646c8 2031 err = dev_get_valid_name(net, dev, name);
5c25f65f 2032 if (err < 0)
0ad646c8 2033 goto err_free_dev;
1da177e4 2034
fc54c658 2035 dev_net_set(dev, net);
f019a7a5 2036 dev->rtnl_link_ops = &tun_link_ops;
fb7589a1 2037 dev->ifindex = tfile->ifindex;
c4d33e24 2038 dev->sysfs_groups[0] = &tun_attr_group;
758e43b7 2039
1da177e4
LT
2040 tun = netdev_priv(dev);
2041 tun->dev = dev;
2042 tun->flags = flags;
f271b2cc 2043 tun->txflt.count = 0;
d9d52b51 2044 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
33dccbb0 2045
eaea34b2 2046 tun->align = NET_SKB_PAD;
54f968d6
JW
2047 tun->filter_attached = false;
2048 tun->sndbuf = tfile->socket.sk->sk_sndbuf;
5503fcec 2049 tun->rx_batched = 0;
33dccbb0 2050
608b9977
PA
2051 tun->pcpu_stats = netdev_alloc_pcpu_stats(struct tun_pcpu_stats);
2052 if (!tun->pcpu_stats) {
2053 err = -ENOMEM;
2054 goto err_free_dev;
2055 }
2056
96442e42
JW
2057 spin_lock_init(&tun->lock);
2058
5dbbaf2d
PM
2059 err = security_tun_dev_alloc_security(&tun->security);
2060 if (err < 0)
608b9977 2061 goto err_free_stat;
2b980dbd 2062
1da177e4 2063 tun_net_init(dev);
944a1376 2064 tun_flow_init(tun);
96442e42 2065
88255375 2066 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
6680ec68
JW
2067 TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
2068 NETIF_F_HW_VLAN_STAG_TX;
2a2bbf17 2069 dev->features = dev->hw_features | NETIF_F_LLTX;
6671b224
FLVC
2070 dev->vlan_features = dev->features &
2071 ~(NETIF_F_HW_VLAN_CTAG_TX |
2072 NETIF_F_HW_VLAN_STAG_TX);
88255375 2073
4008e97f 2074 INIT_LIST_HEAD(&tun->disabled);
849c9b6f 2075 err = tun_attach(tun, file, false);
eb0fb363 2076 if (err < 0)
662ca437 2077 goto err_free_flow;
eb0fb363 2078
1da177e4
LT
2079 err = register_netdevice(tun->dev);
2080 if (err < 0)
662ca437 2081 goto err_detach;
1da177e4
LT
2082 }
2083
af668b3c
MT
2084 netif_carrier_on(tun->dev);
2085
6b8a66ee 2086 tun_debug(KERN_INFO, tun, "tun_set_iff\n");
1da177e4 2087
031f5e03
MT
2088 tun->flags = (tun->flags & ~TUN_FEATURES) |
2089 (ifr->ifr_flags & TUN_FEATURES);
c8d68e6b 2090
e35259a9
MK
2091 /* Make sure persistent devices do not get stuck in
2092 * xoff state.
2093 */
2094 if (netif_running(tun->dev))
c8d68e6b 2095 netif_tx_wake_all_queues(tun->dev);
e35259a9 2096
1da177e4
LT
2097 strcpy(ifr->ifr_name, tun->dev->name);
2098 return 0;
2099
662ca437
JW
2100err_detach:
2101 tun_detach_all(dev);
ff244c6b
ED
2102 /* register_netdevice() already called tun_free_netdev() */
2103 goto err_free_dev;
2104
662ca437
JW
2105err_free_flow:
2106 tun_flow_uninit(tun);
2107 security_tun_dev_free_security(tun->security);
608b9977
PA
2108err_free_stat:
2109 free_percpu(tun->pcpu_stats);
662ca437 2110err_free_dev:
1da177e4 2111 free_netdev(dev);
1da177e4
LT
2112 return err;
2113}
2114
9ce99cf6 2115static void tun_get_iff(struct net *net, struct tun_struct *tun,
876bfd4d 2116 struct ifreq *ifr)
e3b99556 2117{
6b8a66ee 2118 tun_debug(KERN_INFO, tun, "tun_get_iff\n");
e3b99556
MM
2119
2120 strcpy(ifr->ifr_name, tun->dev->name);
2121
980c9e8c 2122 ifr->ifr_flags = tun_flags(tun);
e3b99556 2123
e3b99556
MM
2124}
2125
5228ddc9
RR
2126/* This is like a cut-down ethtool ops, except done via tun fd so no
2127 * privs required. */
88255375 2128static int set_offload(struct tun_struct *tun, unsigned long arg)
5228ddc9 2129{
c8f44aff 2130 netdev_features_t features = 0;
5228ddc9
RR
2131
2132 if (arg & TUN_F_CSUM) {
88255375 2133 features |= NETIF_F_HW_CSUM;
5228ddc9
RR
2134 arg &= ~TUN_F_CSUM;
2135
2136 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
2137 if (arg & TUN_F_TSO_ECN) {
2138 features |= NETIF_F_TSO_ECN;
2139 arg &= ~TUN_F_TSO_ECN;
2140 }
2141 if (arg & TUN_F_TSO4)
2142 features |= NETIF_F_TSO;
2143 if (arg & TUN_F_TSO6)
2144 features |= NETIF_F_TSO6;
2145 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
2146 }
2147 }
2148
2149 /* This gives the user a way to test for new features in future by
2150 * trying to set them. */
2151 if (arg)
2152 return -EINVAL;
2153
88255375 2154 tun->set_features = features;
09050957
YI
2155 tun->dev->wanted_features &= ~TUN_USER_FEATURES;
2156 tun->dev->wanted_features |= features;
88255375 2157 netdev_update_features(tun->dev);
5228ddc9
RR
2158
2159 return 0;
2160}
2161
c8d68e6b
JW
2162static void tun_detach_filter(struct tun_struct *tun, int n)
2163{
2164 int i;
2165 struct tun_file *tfile;
2166
2167 for (i = 0; i < n; i++) {
b8deabd3 2168 tfile = rtnl_dereference(tun->tfiles[i]);
8ced425e
HFS
2169 lock_sock(tfile->socket.sk);
2170 sk_detach_filter(tfile->socket.sk);
2171 release_sock(tfile->socket.sk);
c8d68e6b
JW
2172 }
2173
2174 tun->filter_attached = false;
2175}
2176
2177static int tun_attach_filter(struct tun_struct *tun)
2178{
2179 int i, ret = 0;
2180 struct tun_file *tfile;
2181
2182 for (i = 0; i < tun->numqueues; i++) {
b8deabd3 2183 tfile = rtnl_dereference(tun->tfiles[i]);
8ced425e
HFS
2184 lock_sock(tfile->socket.sk);
2185 ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
2186 release_sock(tfile->socket.sk);
c8d68e6b
JW
2187 if (ret) {
2188 tun_detach_filter(tun, i);
2189 return ret;
2190 }
2191 }
2192
2193 tun->filter_attached = true;
2194 return ret;
2195}
2196
2197static void tun_set_sndbuf(struct tun_struct *tun)
2198{
2199 struct tun_file *tfile;
2200 int i;
2201
2202 for (i = 0; i < tun->numqueues; i++) {
b8deabd3 2203 tfile = rtnl_dereference(tun->tfiles[i]);
c8d68e6b
JW
2204 tfile->socket.sk->sk_sndbuf = tun->sndbuf;
2205 }
2206}
2207
cde8b15f
JW
2208static int tun_set_queue(struct file *file, struct ifreq *ifr)
2209{
2210 struct tun_file *tfile = file->private_data;
2211 struct tun_struct *tun;
cde8b15f
JW
2212 int ret = 0;
2213
2214 rtnl_lock();
2215
2216 if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
4008e97f 2217 tun = tfile->detached;
5dbbaf2d 2218 if (!tun) {
cde8b15f 2219 ret = -EINVAL;
5dbbaf2d
PM
2220 goto unlock;
2221 }
2222 ret = security_tun_dev_attach_queue(tun->security);
2223 if (ret < 0)
2224 goto unlock;
849c9b6f 2225 ret = tun_attach(tun, file, false);
4008e97f 2226 } else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
b8deabd3 2227 tun = rtnl_dereference(tfile->tun);
40630b82 2228 if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
4008e97f
JW
2229 ret = -EINVAL;
2230 else
2231 __tun_detach(tfile, false);
2232 } else
cde8b15f
JW
2233 ret = -EINVAL;
2234
5dbbaf2d 2235unlock:
cde8b15f
JW
2236 rtnl_unlock();
2237 return ret;
2238}
2239
50857e2a
AB
2240static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
2241 unsigned long arg, int ifreq_len)
1da177e4 2242{
36b50bab 2243 struct tun_file *tfile = file->private_data;
631ab46b 2244 struct tun_struct *tun;
1da177e4
LT
2245 void __user* argp = (void __user*)arg;
2246 struct ifreq ifr;
0625c883
EB
2247 kuid_t owner;
2248 kgid_t group;
33dccbb0 2249 int sndbuf;
d9d52b51 2250 int vnet_hdr_sz;
fb7589a1 2251 unsigned int ifindex;
1cf8e410 2252 int le;
f271b2cc 2253 int ret;
1da177e4 2254
20861f26 2255 if (cmd == TUNSETIFF || cmd == TUNSETQUEUE || _IOC_TYPE(cmd) == SOCK_IOC_TYPE) {
50857e2a 2256 if (copy_from_user(&ifr, argp, ifreq_len))
1da177e4 2257 return -EFAULT;
8bbb1813 2258 } else {
a117dacd 2259 memset(&ifr, 0, sizeof(ifr));
8bbb1813 2260 }
631ab46b
EB
2261 if (cmd == TUNGETFEATURES) {
2262 /* Currently this just means: "what IFF flags are valid?".
2263 * This is needed because we never checked for invalid flags on
031f5e03
MT
2264 * TUNSETIFF.
2265 */
2266 return put_user(IFF_TUN | IFF_TAP | TUN_FEATURES,
631ab46b 2267 (unsigned int __user*)argp);
cde8b15f
JW
2268 } else if (cmd == TUNSETQUEUE)
2269 return tun_set_queue(file, &ifr);
631ab46b 2270
c8d68e6b 2271 ret = 0;
876bfd4d
HX
2272 rtnl_lock();
2273
36b50bab 2274 tun = __tun_get(tfile);
0f16bc13
GF
2275 if (cmd == TUNSETIFF) {
2276 ret = -EEXIST;
2277 if (tun)
2278 goto unlock;
2279
1da177e4
LT
2280 ifr.ifr_name[IFNAMSIZ-1] = '\0';
2281
140e807d 2282 ret = tun_set_iff(sock_net(&tfile->sk), file, &ifr);
1da177e4 2283
876bfd4d
HX
2284 if (ret)
2285 goto unlock;
1da177e4 2286
50857e2a 2287 if (copy_to_user(argp, &ifr, ifreq_len))
876bfd4d
HX
2288 ret = -EFAULT;
2289 goto unlock;
1da177e4 2290 }
fb7589a1
PE
2291 if (cmd == TUNSETIFINDEX) {
2292 ret = -EPERM;
2293 if (tun)
2294 goto unlock;
2295
2296 ret = -EFAULT;
2297 if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
2298 goto unlock;
2299
2300 ret = 0;
2301 tfile->ifindex = ifindex;
2302 goto unlock;
2303 }
1da177e4 2304
876bfd4d 2305 ret = -EBADFD;
1da177e4 2306 if (!tun)
876bfd4d 2307 goto unlock;
1da177e4 2308
1e588338 2309 tun_debug(KERN_INFO, tun, "tun_chr_ioctl cmd %u\n", cmd);
1da177e4 2310
631ab46b 2311 ret = 0;
1da177e4 2312 switch (cmd) {
e3b99556 2313 case TUNGETIFF:
9ce99cf6 2314 tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
e3b99556 2315
3d407a80
PE
2316 if (tfile->detached)
2317 ifr.ifr_flags |= IFF_DETACH_QUEUE;
849c9b6f
PE
2318 if (!tfile->socket.sk->sk_filter)
2319 ifr.ifr_flags |= IFF_NOFILTER;
3d407a80 2320
50857e2a 2321 if (copy_to_user(argp, &ifr, ifreq_len))
631ab46b 2322 ret = -EFAULT;
e3b99556
MM
2323 break;
2324
1da177e4
LT
2325 case TUNSETNOCSUM:
2326 /* Disable/Enable checksum */
1da177e4 2327
88255375
MM
2328 /* [unimplemented] */
2329 tun_debug(KERN_INFO, tun, "ignored: set checksum %s\n",
6b8a66ee 2330 arg ? "disabled" : "enabled");
1da177e4
LT
2331 break;
2332
2333 case TUNSETPERSIST:
54f968d6
JW
2334 /* Disable/Enable persist mode. Keep an extra reference to the
2335 * module to prevent the module being unprobed.
2336 */
40630b82
MT
2337 if (arg && !(tun->flags & IFF_PERSIST)) {
2338 tun->flags |= IFF_PERSIST;
54f968d6 2339 __module_get(THIS_MODULE);
dd38bd85 2340 }
40630b82
MT
2341 if (!arg && (tun->flags & IFF_PERSIST)) {
2342 tun->flags &= ~IFF_PERSIST;
54f968d6
JW
2343 module_put(THIS_MODULE);
2344 }
1da177e4 2345
6b8a66ee
JP
2346 tun_debug(KERN_INFO, tun, "persist %s\n",
2347 arg ? "enabled" : "disabled");
1da177e4
LT
2348 break;
2349
2350 case TUNSETOWNER:
2351 /* Set owner of the device */
0625c883
EB
2352 owner = make_kuid(current_user_ns(), arg);
2353 if (!uid_valid(owner)) {
2354 ret = -EINVAL;
2355 break;
2356 }
2357 tun->owner = owner;
1e588338 2358 tun_debug(KERN_INFO, tun, "owner set to %u\n",
0625c883 2359 from_kuid(&init_user_ns, tun->owner));
1da177e4
LT
2360 break;
2361
8c644623
GG
2362 case TUNSETGROUP:
2363 /* Set group of the device */
0625c883
EB
2364 group = make_kgid(current_user_ns(), arg);
2365 if (!gid_valid(group)) {
2366 ret = -EINVAL;
2367 break;
2368 }
2369 tun->group = group;
1e588338 2370 tun_debug(KERN_INFO, tun, "group set to %u\n",
0625c883 2371 from_kgid(&init_user_ns, tun->group));
8c644623
GG
2372 break;
2373
ff4cc3ac
MK
2374 case TUNSETLINK:
2375 /* Only allow setting the type when the interface is down */
2376 if (tun->dev->flags & IFF_UP) {
6b8a66ee
JP
2377 tun_debug(KERN_INFO, tun,
2378 "Linktype set failed because interface is up\n");
48abfe05 2379 ret = -EBUSY;
ff4cc3ac
MK
2380 } else {
2381 tun->dev->type = (int) arg;
6b8a66ee
JP
2382 tun_debug(KERN_INFO, tun, "linktype set to %d\n",
2383 tun->dev->type);
48abfe05 2384 ret = 0;
ff4cc3ac 2385 }
631ab46b 2386 break;
ff4cc3ac 2387
1da177e4
LT
2388#ifdef TUN_DEBUG
2389 case TUNSETDEBUG:
2390 tun->debug = arg;
2391 break;
2392#endif
5228ddc9 2393 case TUNSETOFFLOAD:
88255375 2394 ret = set_offload(tun, arg);
631ab46b 2395 break;
5228ddc9 2396
f271b2cc
MK
2397 case TUNSETTXFILTER:
2398 /* Can be set only for TAPs */
631ab46b 2399 ret = -EINVAL;
40630b82 2400 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
631ab46b 2401 break;
c0e5a8c2 2402 ret = update_filter(&tun->txflt, (void __user *)arg);
631ab46b 2403 break;
1da177e4
LT
2404
2405 case SIOCGIFHWADDR:
b595076a 2406 /* Get hw address */
f271b2cc
MK
2407 memcpy(ifr.ifr_hwaddr.sa_data, tun->dev->dev_addr, ETH_ALEN);
2408 ifr.ifr_hwaddr.sa_family = tun->dev->type;
50857e2a 2409 if (copy_to_user(argp, &ifr, ifreq_len))
631ab46b
EB
2410 ret = -EFAULT;
2411 break;
1da177e4
LT
2412
2413 case SIOCSIFHWADDR:
f271b2cc 2414 /* Set hw address */
6b8a66ee
JP
2415 tun_debug(KERN_DEBUG, tun, "set hw address: %pM\n",
2416 ifr.ifr_hwaddr.sa_data);
40102371 2417
40102371 2418 ret = dev_set_mac_address(tun->dev, &ifr.ifr_hwaddr);
631ab46b 2419 break;
33dccbb0
HX
2420
2421 case TUNGETSNDBUF:
54f968d6 2422 sndbuf = tfile->socket.sk->sk_sndbuf;
33dccbb0
HX
2423 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
2424 ret = -EFAULT;
2425 break;
2426
2427 case TUNSETSNDBUF:
2428 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
2429 ret = -EFAULT;
2430 break;
2431 }
93161922
CG
2432 if (sndbuf <= 0) {
2433 ret = -EINVAL;
2434 break;
2435 }
33dccbb0 2436
c8d68e6b
JW
2437 tun->sndbuf = sndbuf;
2438 tun_set_sndbuf(tun);
33dccbb0
HX
2439 break;
2440
d9d52b51
MT
2441 case TUNGETVNETHDRSZ:
2442 vnet_hdr_sz = tun->vnet_hdr_sz;
2443 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
2444 ret = -EFAULT;
2445 break;
2446
2447 case TUNSETVNETHDRSZ:
2448 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
2449 ret = -EFAULT;
2450 break;
2451 }
2452 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
2453 ret = -EINVAL;
2454 break;
2455 }
2456
2457 tun->vnet_hdr_sz = vnet_hdr_sz;
2458 break;
2459
1cf8e410
MT
2460 case TUNGETVNETLE:
2461 le = !!(tun->flags & TUN_VNET_LE);
2462 if (put_user(le, (int __user *)argp))
2463 ret = -EFAULT;
2464 break;
2465
2466 case TUNSETVNETLE:
2467 if (get_user(le, (int __user *)argp)) {
2468 ret = -EFAULT;
2469 break;
2470 }
2471 if (le)
2472 tun->flags |= TUN_VNET_LE;
2473 else
2474 tun->flags &= ~TUN_VNET_LE;
2475 break;
2476
8b8e658b
GK
2477 case TUNGETVNETBE:
2478 ret = tun_get_vnet_be(tun, argp);
2479 break;
2480
2481 case TUNSETVNETBE:
2482 ret = tun_set_vnet_be(tun, argp);
2483 break;
2484
99405162
MT
2485 case TUNATTACHFILTER:
2486 /* Can be set only for TAPs */
2487 ret = -EINVAL;
40630b82 2488 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
99405162
MT
2489 break;
2490 ret = -EFAULT;
54f968d6 2491 if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
99405162
MT
2492 break;
2493
c8d68e6b 2494 ret = tun_attach_filter(tun);
99405162
MT
2495 break;
2496
2497 case TUNDETACHFILTER:
2498 /* Can be set only for TAPs */
2499 ret = -EINVAL;
40630b82 2500 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
99405162 2501 break;
c8d68e6b
JW
2502 ret = 0;
2503 tun_detach_filter(tun, tun->numqueues);
99405162
MT
2504 break;
2505
76975e9c
PE
2506 case TUNGETFILTER:
2507 ret = -EINVAL;
40630b82 2508 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
76975e9c
PE
2509 break;
2510 ret = -EFAULT;
2511 if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
2512 break;
2513 ret = 0;
2514 break;
2515
1da177e4 2516 default:
631ab46b
EB
2517 ret = -EINVAL;
2518 break;
ee289b64 2519 }
1da177e4 2520
876bfd4d
HX
2521unlock:
2522 rtnl_unlock();
2523 if (tun)
2524 tun_put(tun);
631ab46b 2525 return ret;
1da177e4
LT
2526}
2527
50857e2a
AB
2528static long tun_chr_ioctl(struct file *file,
2529 unsigned int cmd, unsigned long arg)
2530{
2531 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
2532}
2533
2534#ifdef CONFIG_COMPAT
2535static long tun_chr_compat_ioctl(struct file *file,
2536 unsigned int cmd, unsigned long arg)
2537{
2538 switch (cmd) {
2539 case TUNSETIFF:
2540 case TUNGETIFF:
2541 case TUNSETTXFILTER:
2542 case TUNGETSNDBUF:
2543 case TUNSETSNDBUF:
2544 case SIOCGIFHWADDR:
2545 case SIOCSIFHWADDR:
2546 arg = (unsigned long)compat_ptr(arg);
2547 break;
2548 default:
2549 arg = (compat_ulong_t)arg;
2550 break;
2551 }
2552
2553 /*
2554 * compat_ifreq is shorter than ifreq, so we must not access beyond
2555 * the end of that structure. All fields that are used in this
2556 * driver are compatible though, we don't need to convert the
2557 * contents.
2558 */
2559 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
2560}
2561#endif /* CONFIG_COMPAT */
2562
1da177e4
LT
2563static int tun_chr_fasync(int fd, struct file *file, int on)
2564{
54f968d6 2565 struct tun_file *tfile = file->private_data;
1da177e4
LT
2566 int ret;
2567
54f968d6 2568 if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
9d319522 2569 goto out;
6aa20a22 2570
1da177e4 2571 if (on) {
e0b93edd 2572 __f_setown(file, task_pid(current), PIDTYPE_PID, 0);
54f968d6 2573 tfile->flags |= TUN_FASYNC;
6aa20a22 2574 } else
54f968d6 2575 tfile->flags &= ~TUN_FASYNC;
9d319522
JC
2576 ret = 0;
2577out:
9d319522 2578 return ret;
1da177e4
LT
2579}
2580
2581static int tun_chr_open(struct inode *inode, struct file * file)
2582{
140e807d 2583 struct net *net = current->nsproxy->net_ns;
631ab46b 2584 struct tun_file *tfile;
deed49fb 2585
6b8a66ee 2586 DBG1(KERN_INFO, "tunX: tun_chr_open\n");
631ab46b 2587
140e807d 2588 tfile = (struct tun_file *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
11aa9c28 2589 &tun_proto, 0);
631ab46b
EB
2590 if (!tfile)
2591 return -ENOMEM;
c956674b 2592 RCU_INIT_POINTER(tfile->tun, NULL);
54f968d6 2593 tfile->flags = 0;
fb7589a1 2594 tfile->ifindex = 0;
54f968d6 2595
54f968d6 2596 init_waitqueue_head(&tfile->wq.wait);
9e641bdc 2597 RCU_INIT_POINTER(tfile->socket.wq, &tfile->wq);
54f968d6
JW
2598
2599 tfile->socket.file = file;
2600 tfile->socket.ops = &tun_socket_ops;
2601
2602 sock_init_data(&tfile->socket, &tfile->sk);
54f968d6
JW
2603
2604 tfile->sk.sk_write_space = tun_sock_write_space;
2605 tfile->sk.sk_sndbuf = INT_MAX;
2606
631ab46b 2607 file->private_data = tfile;
4008e97f 2608 INIT_LIST_HEAD(&tfile->next);
54f968d6 2609
19a6afb2
JW
2610 sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
2611
1da177e4
LT
2612 return 0;
2613}
2614
2615static int tun_chr_close(struct inode *inode, struct file *file)
2616{
631ab46b 2617 struct tun_file *tfile = file->private_data;
1da177e4 2618
c8d68e6b 2619 tun_detach(tfile, true);
1da177e4
LT
2620
2621 return 0;
2622}
2623
93e14b6d 2624#ifdef CONFIG_PROC_FS
a3816ab0 2625static void tun_chr_show_fdinfo(struct seq_file *m, struct file *f)
93e14b6d
MY
2626{
2627 struct tun_struct *tun;
2628 struct ifreq ifr;
2629
2630 memset(&ifr, 0, sizeof(ifr));
2631
2632 rtnl_lock();
2633 tun = tun_get(f);
2634 if (tun)
2635 tun_get_iff(current->nsproxy->net_ns, tun, &ifr);
2636 rtnl_unlock();
2637
2638 if (tun)
2639 tun_put(tun);
2640
a3816ab0 2641 seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
93e14b6d
MY
2642}
2643#endif
2644
d54b1fdb 2645static const struct file_operations tun_fops = {
6aa20a22 2646 .owner = THIS_MODULE,
1da177e4 2647 .llseek = no_llseek,
9b067034 2648 .read_iter = tun_chr_read_iter,
f5ff53b4 2649 .write_iter = tun_chr_write_iter,
1da177e4 2650 .poll = tun_chr_poll,
50857e2a
AB
2651 .unlocked_ioctl = tun_chr_ioctl,
2652#ifdef CONFIG_COMPAT
2653 .compat_ioctl = tun_chr_compat_ioctl,
2654#endif
1da177e4
LT
2655 .open = tun_chr_open,
2656 .release = tun_chr_close,
93e14b6d
MY
2657 .fasync = tun_chr_fasync,
2658#ifdef CONFIG_PROC_FS
2659 .show_fdinfo = tun_chr_show_fdinfo,
2660#endif
1da177e4
LT
2661};
2662
2663static struct miscdevice tun_miscdev = {
2664 .minor = TUN_MINOR,
2665 .name = "tun",
e454cea2 2666 .nodename = "net/tun",
1da177e4 2667 .fops = &tun_fops,
1da177e4
LT
2668};
2669
2670/* ethtool interface */
2671
29ccc49d
PR
2672static int tun_get_link_ksettings(struct net_device *dev,
2673 struct ethtool_link_ksettings *cmd)
2674{
2675 ethtool_link_ksettings_zero_link_mode(cmd, supported);
2676 ethtool_link_ksettings_zero_link_mode(cmd, advertising);
2677 cmd->base.speed = SPEED_10;
2678 cmd->base.duplex = DUPLEX_FULL;
2679 cmd->base.port = PORT_TP;
2680 cmd->base.phy_address = 0;
2681 cmd->base.autoneg = AUTONEG_DISABLE;
1da177e4
LT
2682 return 0;
2683}
2684
2685static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
2686{
2687 struct tun_struct *tun = netdev_priv(dev);
2688
33a5ba14
RJ
2689 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
2690 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
1da177e4
LT
2691
2692 switch (tun->flags & TUN_TYPE_MASK) {
40630b82 2693 case IFF_TUN:
33a5ba14 2694 strlcpy(info->bus_info, "tun", sizeof(info->bus_info));
1da177e4 2695 break;
40630b82 2696 case IFF_TAP:
33a5ba14 2697 strlcpy(info->bus_info, "tap", sizeof(info->bus_info));
1da177e4
LT
2698 break;
2699 }
2700}
2701
2702static u32 tun_get_msglevel(struct net_device *dev)
2703{
2704#ifdef TUN_DEBUG
2705 struct tun_struct *tun = netdev_priv(dev);
2706 return tun->debug;
2707#else
2708 return -EOPNOTSUPP;
2709#endif
2710}
2711
2712static void tun_set_msglevel(struct net_device *dev, u32 value)
2713{
2714#ifdef TUN_DEBUG
2715 struct tun_struct *tun = netdev_priv(dev);
2716 tun->debug = value;
2717#endif
2718}
2719
5503fcec
JW
2720static int tun_get_coalesce(struct net_device *dev,
2721 struct ethtool_coalesce *ec)
2722{
2723 struct tun_struct *tun = netdev_priv(dev);
2724
2725 ec->rx_max_coalesced_frames = tun->rx_batched;
2726
2727 return 0;
2728}
2729
2730static int tun_set_coalesce(struct net_device *dev,
2731 struct ethtool_coalesce *ec)
2732{
2733 struct tun_struct *tun = netdev_priv(dev);
2734
2735 if (ec->rx_max_coalesced_frames > NAPI_POLL_WEIGHT)
2736 tun->rx_batched = NAPI_POLL_WEIGHT;
2737 else
2738 tun->rx_batched = ec->rx_max_coalesced_frames;
2739
2740 return 0;
2741}
2742
7282d491 2743static const struct ethtool_ops tun_ethtool_ops = {
1da177e4
LT
2744 .get_drvinfo = tun_get_drvinfo,
2745 .get_msglevel = tun_get_msglevel,
2746 .set_msglevel = tun_set_msglevel,
bee31369 2747 .get_link = ethtool_op_get_link,
eda29772 2748 .get_ts_info = ethtool_op_get_ts_info,
5503fcec
JW
2749 .get_coalesce = tun_get_coalesce,
2750 .set_coalesce = tun_set_coalesce,
29ccc49d 2751 .get_link_ksettings = tun_get_link_ksettings,
1da177e4
LT
2752};
2753
1576d986
JW
2754static int tun_queue_resize(struct tun_struct *tun)
2755{
2756 struct net_device *dev = tun->dev;
2757 struct tun_file *tfile;
2758 struct skb_array **arrays;
2759 int n = tun->numqueues + tun->numdisabled;
2760 int ret, i;
2761
12039046 2762 arrays = kmalloc_array(n, sizeof(*arrays), GFP_KERNEL);
1576d986
JW
2763 if (!arrays)
2764 return -ENOMEM;
2765
2766 for (i = 0; i < tun->numqueues; i++) {
2767 tfile = rtnl_dereference(tun->tfiles[i]);
2768 arrays[i] = &tfile->tx_array;
2769 }
2770 list_for_each_entry(tfile, &tun->disabled, next)
2771 arrays[i++] = &tfile->tx_array;
2772
2773 ret = skb_array_resize_multiple(arrays, n,
2774 dev->tx_queue_len, GFP_KERNEL);
2775
2776 kfree(arrays);
2777 return ret;
2778}
2779
2780static int tun_device_event(struct notifier_block *unused,
2781 unsigned long event, void *ptr)
2782{
2783 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
2784 struct tun_struct *tun = netdev_priv(dev);
2785
86dfb4ac
CG
2786 if (dev->rtnl_link_ops != &tun_link_ops)
2787 return NOTIFY_DONE;
2788
1576d986
JW
2789 switch (event) {
2790 case NETDEV_CHANGE_TX_QUEUE_LEN:
2791 if (tun_queue_resize(tun))
2792 return NOTIFY_BAD;
2793 break;
2794 default:
2795 break;
2796 }
2797
2798 return NOTIFY_DONE;
2799}
2800
2801static struct notifier_block tun_notifier_block __read_mostly = {
2802 .notifier_call = tun_device_event,
2803};
79d17604 2804
1da177e4
LT
2805static int __init tun_init(void)
2806{
2807 int ret = 0;
2808
6b8a66ee 2809 pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
1da177e4 2810
f019a7a5 2811 ret = rtnl_link_register(&tun_link_ops);
79d17604 2812 if (ret) {
6b8a66ee 2813 pr_err("Can't register link_ops\n");
f019a7a5 2814 goto err_linkops;
79d17604
PE
2815 }
2816
1da177e4 2817 ret = misc_register(&tun_miscdev);
79d17604 2818 if (ret) {
6b8a66ee 2819 pr_err("Can't register misc device %d\n", TUN_MINOR);
79d17604
PE
2820 goto err_misc;
2821 }
1576d986 2822
5edfbd3c
TZ
2823 ret = register_netdevice_notifier(&tun_notifier_block);
2824 if (ret) {
2825 pr_err("Can't register netdevice notifier\n");
2826 goto err_notifier;
2827 }
2828
f019a7a5 2829 return 0;
5edfbd3c
TZ
2830
2831err_notifier:
2832 misc_deregister(&tun_miscdev);
79d17604 2833err_misc:
f019a7a5
EB
2834 rtnl_link_unregister(&tun_link_ops);
2835err_linkops:
1da177e4
LT
2836 return ret;
2837}
2838
2839static void tun_cleanup(void)
2840{
6aa20a22 2841 misc_deregister(&tun_miscdev);
f019a7a5 2842 rtnl_link_unregister(&tun_link_ops);
1576d986 2843 unregister_netdevice_notifier(&tun_notifier_block);
1da177e4
LT
2844}
2845
05c2828c
MT
2846/* Get an underlying socket object from tun file. Returns error unless file is
2847 * attached to a device. The returned object works like a packet socket, it
2848 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
2849 * holding a reference to the file for as long as the socket is in use. */
2850struct socket *tun_get_socket(struct file *file)
2851{
6e914fc7 2852 struct tun_file *tfile;
05c2828c
MT
2853 if (file->f_op != &tun_fops)
2854 return ERR_PTR(-EINVAL);
6e914fc7
JW
2855 tfile = file->private_data;
2856 if (!tfile)
05c2828c 2857 return ERR_PTR(-EBADFD);
54f968d6 2858 return &tfile->socket;
05c2828c
MT
2859}
2860EXPORT_SYMBOL_GPL(tun_get_socket);
2861
83339c6b
JW
2862struct skb_array *tun_get_skb_array(struct file *file)
2863{
2864 struct tun_file *tfile;
2865
2866 if (file->f_op != &tun_fops)
2867 return ERR_PTR(-EINVAL);
2868 tfile = file->private_data;
2869 if (!tfile)
2870 return ERR_PTR(-EBADFD);
2871 return &tfile->tx_array;
2872}
2873EXPORT_SYMBOL_GPL(tun_get_skb_array);
2874
1da177e4
LT
2875module_init(tun_init);
2876module_exit(tun_cleanup);
2877MODULE_DESCRIPTION(DRV_DESCRIPTION);
2878MODULE_AUTHOR(DRV_COPYRIGHT);
2879MODULE_LICENSE("GPL");
2880MODULE_ALIAS_MISCDEV(TUN_MINOR);
578454ff 2881MODULE_ALIAS("devname:net/tun");