net: marvell: prestera: fix memory leak in prestera_rxtx_switch_init()
[linux-block.git] / drivers / net / tun.c
CommitLineData
c942fddf 1// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4
LT
2/*
3 * TUN - Universal TUN/TAP device driver.
4 * Copyright (C) 1999-2002 Maxim Krasnyansky <maxk@qualcomm.com>
5 *
1da177e4
LT
6 * $Id: tun.c,v 1.15 2002/03/01 02:44:24 maxk Exp $
7 */
8
9/*
10 * Changes:
11 *
ff4cc3ac
MK
12 * Mike Kershaw <dragorn@kismetwireless.net> 2005/08/14
13 * Add TUNSETLINK ioctl to set the link encapsulation
14 *
1da177e4 15 * Mark Smith <markzzzsmith@yahoo.com.au>
344dc8ed 16 * Use eth_random_addr() for tap MAC address.
1da177e4
LT
17 *
18 * Harald Roelle <harald.roelle@ifi.lmu.de> 2004/04/20
19 * Fixes in packet dropping, queue length setting and queue wakeup.
20 * Increased default tx queue length.
21 * Added ethtool API.
22 * Minor cleanups
23 *
24 * Daniel Podlejski <underley@underley.eu.org>
25 * Modifications for 2.3.99-pre5 kernel.
26 */
27
6b8a66ee
JP
28#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
29
1da177e4
LT
30#define DRV_NAME "tun"
31#define DRV_VERSION "1.6"
32#define DRV_DESCRIPTION "Universal TUN/TAP device driver"
33#define DRV_COPYRIGHT "(C) 1999-2004 Max Krasnyansky <maxk@qualcomm.com>"
34
1da177e4
LT
35#include <linux/module.h>
36#include <linux/errno.h>
37#include <linux/kernel.h>
174cd4b1 38#include <linux/sched/signal.h>
1da177e4
LT
39#include <linux/major.h>
40#include <linux/slab.h>
41#include <linux/poll.h>
42#include <linux/fcntl.h>
43#include <linux/init.h>
44#include <linux/skbuff.h>
45#include <linux/netdevice.h>
46#include <linux/etherdevice.h>
47#include <linux/miscdevice.h>
48#include <linux/ethtool.h>
49#include <linux/rtnetlink.h>
50857e2a 50#include <linux/compat.h>
1da177e4
LT
51#include <linux/if.h>
52#include <linux/if_arp.h>
53#include <linux/if_ether.h>
54#include <linux/if_tun.h>
6680ec68 55#include <linux/if_vlan.h>
1da177e4 56#include <linux/crc32.h>
d647a591 57#include <linux/nsproxy.h>
f43798c2 58#include <linux/virtio_net.h>
99405162 59#include <linux/rcupdate.h>
881d966b 60#include <net/net_namespace.h>
79d17604 61#include <net/netns/generic.h>
f019a7a5 62#include <net/rtnetlink.h>
33dccbb0 63#include <net/sock.h>
735fc405 64#include <net/xdp.h>
b9815eb1 65#include <net/ip_tunnels.h>
93e14b6d 66#include <linux/seq_file.h>
e0b46d0e 67#include <linux/uio.h>
1576d986 68#include <linux/skb_array.h>
761876c8
JW
69#include <linux/bpf.h>
70#include <linux/bpf_trace.h>
90e33d45 71#include <linux/mutex.h>
cca8ea3b
PP
72#include <linux/ieee802154.h>
73#include <linux/if_ltalk.h>
74#include <uapi/linux/if_fddi.h>
75#include <uapi/linux/if_hippi.h>
76#include <uapi/linux/if_fc.h>
77#include <net/ax25.h>
78#include <net/rose.h>
79#include <net/6lowpan.h>
1da177e4 80
7c0f6ba6 81#include <linux/uaccess.h>
f2780d6d 82#include <linux/proc_fs.h>
1da177e4 83
4e24f2dd
CW
84static void tun_default_link_ksettings(struct net_device *dev,
85 struct ethtool_link_ksettings *cmd);
86
7df13219 87#define TUN_RX_PAD (NET_IP_ALIGN + NET_SKB_PAD)
66ccbc9c 88
031f5e03
MT
89/* TUN device flags */
90
91/* IFF_ATTACH_QUEUE is never stored in device flags,
92 * overload it to mean fasync when stored there.
93 */
94#define TUN_FASYNC IFF_ATTACH_QUEUE
1cf8e410
MT
95/* High bits in flags field are unused. */
96#define TUN_VNET_LE 0x80000000
8b8e658b 97#define TUN_VNET_BE 0x40000000
031f5e03
MT
98
99#define TUN_FEATURES (IFF_NO_PI | IFF_ONE_QUEUE | IFF_VNET_HDR | \
90e33d45
PP
100 IFF_MULTI_QUEUE | IFF_NAPI | IFF_NAPI_FRAGS)
101
0690899b
MT
102#define GOODCOPY_LEN 128
103
f271b2cc
MK
104#define FLT_EXACT_COUNT 8
105struct tap_filter {
106 unsigned int count; /* Number of addrs. Zero means disabled */
107 u32 mask[2]; /* Mask of the hashed addrs */
108 unsigned char addr[FLT_EXACT_COUNT][ETH_ALEN];
109};
110
baf71c5c
PG
111/* MAX_TAP_QUEUES 256 is chosen to allow rx/tx queues to be equal
112 * to max number of VCPUs in guest. */
113#define MAX_TAP_QUEUES 256
b8732fb7 114#define MAX_TAP_FLOWS 4096
c8d68e6b 115
96442e42
JW
116#define TUN_FLOW_EXPIRE (3 * HZ)
117
54f968d6 118/* A tun_file connects an open character device to a tuntap netdevice. It
92d4ea6e 119 * also contains all socket related structures (except sock_fprog and tap_filter)
54f968d6
JW
120 * to serve as one transmit queue for tuntap device. The sock_fprog and
121 * tap_filter were kept in tun_struct since they were used for filtering for the
36fe8c09 122 * netdevice not for a specific queue (at least I didn't see the requirement for
54f968d6 123 * this).
6e914fc7
JW
124 *
125 * RCU usage:
36fe8c09 126 * The tun_file and tun_struct are loosely coupled, the pointer from one to the
6e914fc7 127 * other can only be read while rcu_read_lock or rtnl_lock is held.
54f968d6 128 */
631ab46b 129struct tun_file {
54f968d6
JW
130 struct sock sk;
131 struct socket socket;
6e914fc7 132 struct tun_struct __rcu *tun;
54f968d6
JW
133 struct fasync_struct *fasync;
134 /* only used for fasnyc */
135 unsigned int flags;
fb7589a1
PE
136 union {
137 u16 queue_index;
138 unsigned int ifindex;
139 };
94317099 140 struct napi_struct napi;
aec72f33 141 bool napi_enabled;
af3fb24e 142 bool napi_frags_enabled;
90e33d45 143 struct mutex napi_mutex; /* Protects access to the above napi */
4008e97f
JW
144 struct list_head next;
145 struct tun_struct *detached;
5990a305 146 struct ptr_ring tx_ring;
8bf5c4ee 147 struct xdp_rxq_info xdp_rxq;
631ab46b
EB
148};
149
f9e06c45
JW
150struct tun_page {
151 struct page *page;
152 int count;
153};
154
96442e42
JW
155struct tun_flow_entry {
156 struct hlist_node hash_link;
157 struct rcu_head rcu;
158 struct tun_struct *tun;
159
160 u32 rxhash;
9bc88939 161 u32 rps_rxhash;
96442e42 162 int queue_index;
83b1bc12 163 unsigned long updated ____cacheline_aligned_in_smp;
96442e42
JW
164};
165
166#define TUN_NUM_FLOW_ENTRIES 1024
f13b5468 167#define TUN_MASK_FLOW_ENTRIES (TUN_NUM_FLOW_ENTRIES - 1)
96442e42 168
cd5681d7 169struct tun_prog {
96f84061
JW
170 struct rcu_head rcu;
171 struct bpf_prog *prog;
172};
173
54f968d6 174/* Since the socket were moved to tun_file, to preserve the behavior of persist
36fe8c09 175 * device, socket filter, sndbuf and vnet header size were restore when the
54f968d6
JW
176 * file were attached to a persist device.
177 */
14daa021 178struct tun_struct {
c8d68e6b
JW
179 struct tun_file __rcu *tfiles[MAX_TAP_QUEUES];
180 unsigned int numqueues;
f271b2cc 181 unsigned int flags;
0625c883
EB
182 kuid_t owner;
183 kgid_t group;
14daa021 184
14daa021 185 struct net_device *dev;
c8f44aff 186 netdev_features_t set_features;
88255375 187#define TUN_USER_FEATURES (NETIF_F_HW_CSUM|NETIF_F_TSO_ECN|NETIF_F_TSO| \
d591a1f3 188 NETIF_F_TSO6)
d9d52b51 189
eaea34b2 190 int align;
d9d52b51 191 int vnet_hdr_sz;
54f968d6
JW
192 int sndbuf;
193 struct tap_filter txflt;
194 struct sock_fprog fprog;
195 /* protected by rtnl lock */
196 bool filter_attached;
3424170f 197 u32 msg_enable;
96442e42 198 spinlock_t lock;
96442e42
JW
199 struct hlist_head flows[TUN_NUM_FLOW_ENTRIES];
200 struct timer_list flow_gc_timer;
201 unsigned long ageing_time;
4008e97f
JW
202 unsigned int numdisabled;
203 struct list_head disabled;
5dbbaf2d 204 void *security;
b8732fb7 205 u32 flow_count;
5503fcec 206 u32 rx_batched;
497a5757 207 atomic_long_t rx_frame_errors;
761876c8 208 struct bpf_prog __rcu *xdp_prog;
cd5681d7 209 struct tun_prog __rcu *steering_prog;
aff3d70a 210 struct tun_prog __rcu *filter_prog;
4e24f2dd 211 struct ethtool_link_ksettings link_ksettings;
158b515f
GK
212 /* init args */
213 struct file *file;
214 struct ifreq *ifr;
14daa021 215};
1da177e4 216
aff3d70a
JW
217struct veth {
218 __be16 h_vlan_proto;
219 __be16 h_vlan_TCI;
14daa021 220};
1da177e4 221
158b515f
GK
222static void tun_flow_init(struct tun_struct *tun);
223static void tun_flow_uninit(struct tun_struct *tun);
224
94317099
PP
225static int tun_napi_receive(struct napi_struct *napi, int budget)
226{
227 struct tun_file *tfile = container_of(napi, struct tun_file, napi);
228 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
229 struct sk_buff_head process_queue;
230 struct sk_buff *skb;
231 int received = 0;
232
233 __skb_queue_head_init(&process_queue);
234
235 spin_lock(&queue->lock);
236 skb_queue_splice_tail_init(queue, &process_queue);
237 spin_unlock(&queue->lock);
238
239 while (received < budget && (skb = __skb_dequeue(&process_queue))) {
240 napi_gro_receive(napi, skb);
241 ++received;
242 }
243
244 if (!skb_queue_empty(&process_queue)) {
245 spin_lock(&queue->lock);
246 skb_queue_splice(&process_queue, queue);
247 spin_unlock(&queue->lock);
248 }
249
250 return received;
251}
252
253static int tun_napi_poll(struct napi_struct *napi, int budget)
254{
255 unsigned int received;
256
257 received = tun_napi_receive(napi, budget);
258
259 if (received < budget)
260 napi_complete_done(napi, received);
261
262 return received;
263}
264
265static void tun_napi_init(struct tun_struct *tun, struct tun_file *tfile,
af3fb24e 266 bool napi_en, bool napi_frags)
94317099 267{
aec72f33 268 tfile->napi_enabled = napi_en;
af3fb24e 269 tfile->napi_frags_enabled = napi_en && napi_frags;
94317099 270 if (napi_en) {
16d083e2 271 netif_napi_add_tx(tun->dev, &tfile->napi, tun_napi_poll);
94317099
PP
272 napi_enable(&tfile->napi);
273 }
274}
275
a8fc8cb5
JK
276static void tun_napi_enable(struct tun_file *tfile)
277{
278 if (tfile->napi_enabled)
279 napi_enable(&tfile->napi);
280}
281
06e55add 282static void tun_napi_disable(struct tun_file *tfile)
94317099 283{
aec72f33 284 if (tfile->napi_enabled)
94317099
PP
285 napi_disable(&tfile->napi);
286}
287
06e55add 288static void tun_napi_del(struct tun_file *tfile)
94317099 289{
aec72f33 290 if (tfile->napi_enabled)
94317099
PP
291 netif_napi_del(&tfile->napi);
292}
293
af3fb24e 294static bool tun_napi_frags_enabled(const struct tun_file *tfile)
90e33d45 295{
af3fb24e 296 return tfile->napi_frags_enabled;
90e33d45
PP
297}
298
8b8e658b
GK
299#ifdef CONFIG_TUN_VNET_CROSS_LE
300static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
301{
302 return tun->flags & TUN_VNET_BE ? false :
303 virtio_legacy_is_little_endian();
304}
305
306static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
307{
308 int be = !!(tun->flags & TUN_VNET_BE);
309
310 if (put_user(be, argp))
311 return -EFAULT;
312
313 return 0;
314}
315
316static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
317{
318 int be;
319
320 if (get_user(be, argp))
321 return -EFAULT;
322
323 if (be)
324 tun->flags |= TUN_VNET_BE;
325 else
326 tun->flags &= ~TUN_VNET_BE;
327
328 return 0;
329}
330#else
331static inline bool tun_legacy_is_little_endian(struct tun_struct *tun)
332{
333 return virtio_legacy_is_little_endian();
334}
335
336static long tun_get_vnet_be(struct tun_struct *tun, int __user *argp)
337{
338 return -EINVAL;
339}
340
341static long tun_set_vnet_be(struct tun_struct *tun, int __user *argp)
342{
343 return -EINVAL;
344}
345#endif /* CONFIG_TUN_VNET_CROSS_LE */
346
25bd55bb
GK
347static inline bool tun_is_little_endian(struct tun_struct *tun)
348{
7d824109 349 return tun->flags & TUN_VNET_LE ||
8b8e658b 350 tun_legacy_is_little_endian(tun);
25bd55bb
GK
351}
352
56f0dcc5
MT
353static inline u16 tun16_to_cpu(struct tun_struct *tun, __virtio16 val)
354{
25bd55bb 355 return __virtio16_to_cpu(tun_is_little_endian(tun), val);
56f0dcc5
MT
356}
357
358static inline __virtio16 cpu_to_tun16(struct tun_struct *tun, u16 val)
359{
25bd55bb 360 return __cpu_to_virtio16(tun_is_little_endian(tun), val);
56f0dcc5
MT
361}
362
96442e42
JW
363static inline u32 tun_hashfn(u32 rxhash)
364{
f13b5468 365 return rxhash & TUN_MASK_FLOW_ENTRIES;
96442e42
JW
366}
367
368static struct tun_flow_entry *tun_flow_find(struct hlist_head *head, u32 rxhash)
369{
370 struct tun_flow_entry *e;
96442e42 371
b67bfe0d 372 hlist_for_each_entry_rcu(e, head, hash_link) {
96442e42
JW
373 if (e->rxhash == rxhash)
374 return e;
375 }
376 return NULL;
377}
378
379static struct tun_flow_entry *tun_flow_create(struct tun_struct *tun,
380 struct hlist_head *head,
381 u32 rxhash, u16 queue_index)
382{
9fdc6bef
ED
383 struct tun_flow_entry *e = kmalloc(sizeof(*e), GFP_ATOMIC);
384
96442e42 385 if (e) {
3424170f
MK
386 netif_info(tun, tx_queued, tun->dev,
387 "create flow: hash %u index %u\n",
388 rxhash, queue_index);
96442e42
JW
389 e->updated = jiffies;
390 e->rxhash = rxhash;
9bc88939 391 e->rps_rxhash = 0;
96442e42
JW
392 e->queue_index = queue_index;
393 e->tun = tun;
394 hlist_add_head_rcu(&e->hash_link, head);
b8732fb7 395 ++tun->flow_count;
96442e42
JW
396 }
397 return e;
398}
399
96442e42
JW
400static void tun_flow_delete(struct tun_struct *tun, struct tun_flow_entry *e)
401{
3424170f
MK
402 netif_info(tun, tx_queued, tun->dev, "delete flow: hash %u index %u\n",
403 e->rxhash, e->queue_index);
96442e42 404 hlist_del_rcu(&e->hash_link);
9fdc6bef 405 kfree_rcu(e, rcu);
b8732fb7 406 --tun->flow_count;
96442e42
JW
407}
408
409static void tun_flow_flush(struct tun_struct *tun)
410{
411 int i;
412
413 spin_lock_bh(&tun->lock);
414 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
415 struct tun_flow_entry *e;
b67bfe0d 416 struct hlist_node *n;
96442e42 417
b67bfe0d 418 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link)
96442e42
JW
419 tun_flow_delete(tun, e);
420 }
421 spin_unlock_bh(&tun->lock);
422}
423
424static void tun_flow_delete_by_queue(struct tun_struct *tun, u16 queue_index)
425{
426 int i;
427
428 spin_lock_bh(&tun->lock);
429 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
430 struct tun_flow_entry *e;
b67bfe0d 431 struct hlist_node *n;
96442e42 432
b67bfe0d 433 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
96442e42
JW
434 if (e->queue_index == queue_index)
435 tun_flow_delete(tun, e);
436 }
437 }
438 spin_unlock_bh(&tun->lock);
439}
440
e99e88a9 441static void tun_flow_cleanup(struct timer_list *t)
96442e42 442{
e99e88a9 443 struct tun_struct *tun = from_timer(tun, t, flow_gc_timer);
96442e42
JW
444 unsigned long delay = tun->ageing_time;
445 unsigned long next_timer = jiffies + delay;
446 unsigned long count = 0;
447 int i;
448
7dbfb4ef 449 spin_lock(&tun->lock);
96442e42
JW
450 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++) {
451 struct tun_flow_entry *e;
b67bfe0d 452 struct hlist_node *n;
96442e42 453
b67bfe0d 454 hlist_for_each_entry_safe(e, n, &tun->flows[i], hash_link) {
96442e42 455 unsigned long this_timer;
81d98fa4 456
96442e42 457 this_timer = e->updated + delay;
81d98fa4 458 if (time_before_eq(this_timer, jiffies)) {
96442e42 459 tun_flow_delete(tun, e);
81d98fa4
ED
460 continue;
461 }
462 count++;
463 if (time_before(this_timer, next_timer))
96442e42
JW
464 next_timer = this_timer;
465 }
466 }
467
468 if (count)
469 mod_timer(&tun->flow_gc_timer, round_jiffies_up(next_timer));
7dbfb4ef 470 spin_unlock(&tun->lock);
96442e42
JW
471}
472
49974420 473static void tun_flow_update(struct tun_struct *tun, u32 rxhash,
9e85722d 474 struct tun_file *tfile)
96442e42
JW
475{
476 struct hlist_head *head;
477 struct tun_flow_entry *e;
478 unsigned long delay = tun->ageing_time;
9e85722d 479 u16 queue_index = tfile->queue_index;
96442e42 480
5c327f67 481 head = &tun->flows[tun_hashfn(rxhash)];
96442e42
JW
482
483 rcu_read_lock();
484
96442e42
JW
485 e = tun_flow_find(head, rxhash);
486 if (likely(e)) {
487 /* TODO: keep queueing to old queue until it's empty? */
4ffdd22e
ED
488 if (READ_ONCE(e->queue_index) != queue_index)
489 WRITE_ONCE(e->queue_index, queue_index);
83b1bc12
LR
490 if (e->updated != jiffies)
491 e->updated = jiffies;
9bc88939 492 sock_rps_record_flow_hash(e->rps_rxhash);
96442e42
JW
493 } else {
494 spin_lock_bh(&tun->lock);
b8732fb7
JW
495 if (!tun_flow_find(head, rxhash) &&
496 tun->flow_count < MAX_TAP_FLOWS)
96442e42
JW
497 tun_flow_create(tun, head, rxhash, queue_index);
498
499 if (!timer_pending(&tun->flow_gc_timer))
500 mod_timer(&tun->flow_gc_timer,
501 round_jiffies_up(jiffies + delay));
502 spin_unlock_bh(&tun->lock);
503 }
504
96442e42
JW
505 rcu_read_unlock();
506}
507
516c512b 508/* Save the hash received in the stack receive path and update the
9bc88939
TH
509 * flow_hash table accordingly.
510 */
511static inline void tun_flow_save_rps_rxhash(struct tun_flow_entry *e, u32 hash)
512{
567e4b79 513 if (unlikely(e->rps_rxhash != hash))
9bc88939 514 e->rps_rxhash = hash;
9bc88939
TH
515}
516
4b035271 517/* We try to identify a flow through its rxhash. The reason that
92d4ea6e 518 * we do not check rxq no. is because some cards(e.g 82599), chooses
c8d68e6b
JW
519 * the rxq based on the txq where the last packet of the flow comes. As
520 * the userspace application move between processors, we may get a
4b035271 521 * different rxq no. here.
c8d68e6b 522 */
96f84061 523static u16 tun_automq_select_queue(struct tun_struct *tun, struct sk_buff *skb)
c8d68e6b 524{
96442e42 525 struct tun_flow_entry *e;
c8d68e6b
JW
526 u32 txq = 0;
527 u32 numqueues = 0;
528
6aa7de05 529 numqueues = READ_ONCE(tun->numqueues);
c8d68e6b 530
feec084a 531 txq = __skb_get_hash_symmetric(skb);
4b035271
WL
532 e = tun_flow_find(&tun->flows[tun_hashfn(txq)], txq);
533 if (e) {
534 tun_flow_save_rps_rxhash(e, txq);
535 txq = e->queue_index;
536 } else {
537 /* use multiply and shift instead of expensive divide */
538 txq = ((u64)txq * numqueues) >> 32;
c8d68e6b
JW
539 }
540
c8d68e6b
JW
541 return txq;
542}
543
96f84061
JW
544static u16 tun_ebpf_select_queue(struct tun_struct *tun, struct sk_buff *skb)
545{
cd5681d7 546 struct tun_prog *prog;
a35d310f 547 u32 numqueues;
96f84061
JW
548 u16 ret = 0;
549
a35d310f
JW
550 numqueues = READ_ONCE(tun->numqueues);
551 if (!numqueues)
552 return 0;
553
96f84061
JW
554 prog = rcu_dereference(tun->steering_prog);
555 if (prog)
556 ret = bpf_prog_run_clear_cb(prog->prog, skb);
557
a35d310f 558 return ret % numqueues;
96f84061
JW
559}
560
561static u16 tun_select_queue(struct net_device *dev, struct sk_buff *skb,
a350ecce 562 struct net_device *sb_dev)
96f84061
JW
563{
564 struct tun_struct *tun = netdev_priv(dev);
565 u16 ret;
566
567 rcu_read_lock();
568 if (rcu_dereference(tun->steering_prog))
569 ret = tun_ebpf_select_queue(tun, skb);
570 else
571 ret = tun_automq_select_queue(tun, skb);
572 rcu_read_unlock();
573
574 return ret;
575}
576
cde8b15f
JW
577static inline bool tun_not_capable(struct tun_struct *tun)
578{
579 const struct cred *cred = current_cred();
c260b772 580 struct net *net = dev_net(tun->dev);
cde8b15f
JW
581
582 return ((uid_valid(tun->owner) && !uid_eq(cred->euid, tun->owner)) ||
583 (gid_valid(tun->group) && !in_egroup_p(tun->group))) &&
c260b772 584 !ns_capable(net->user_ns, CAP_NET_ADMIN);
cde8b15f
JW
585}
586
c8d68e6b
JW
587static void tun_set_real_num_queues(struct tun_struct *tun)
588{
589 netif_set_real_num_tx_queues(tun->dev, tun->numqueues);
590 netif_set_real_num_rx_queues(tun->dev, tun->numqueues);
591}
592
4008e97f
JW
593static void tun_disable_queue(struct tun_struct *tun, struct tun_file *tfile)
594{
595 tfile->detached = tun;
596 list_add_tail(&tfile->next, &tun->disabled);
597 ++tun->numdisabled;
598}
599
d32649d1 600static struct tun_struct *tun_enable_queue(struct tun_file *tfile)
4008e97f
JW
601{
602 struct tun_struct *tun = tfile->detached;
603
604 tfile->detached = NULL;
605 list_del_init(&tfile->next);
606 --tun->numdisabled;
607 return tun;
608}
609
3a403076 610void tun_ptr_free(void *ptr)
fc72d1d5
JW
611{
612 if (!ptr)
613 return;
1ffcbc85
JDB
614 if (tun_is_xdp_frame(ptr)) {
615 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
fc72d1d5 616
03993094 617 xdp_return_frame(xdpf);
fc72d1d5
JW
618 } else {
619 __skb_array_destroy_skb(ptr);
620 }
621}
3a403076 622EXPORT_SYMBOL_GPL(tun_ptr_free);
fc72d1d5 623
4bfb0513
JW
624static void tun_queue_purge(struct tun_file *tfile)
625{
fc72d1d5 626 void *ptr;
1576d986 627
fc72d1d5
JW
628 while ((ptr = ptr_ring_consume(&tfile->tx_ring)) != NULL)
629 tun_ptr_free(ptr);
1576d986 630
5503fcec 631 skb_queue_purge(&tfile->sk.sk_write_queue);
4bfb0513
JW
632 skb_queue_purge(&tfile->sk.sk_error_queue);
633}
634
c8d68e6b
JW
635static void __tun_detach(struct tun_file *tfile, bool clean)
636{
637 struct tun_file *ntfile;
638 struct tun_struct *tun;
c8d68e6b 639
b8deabd3
JW
640 tun = rtnl_dereference(tfile->tun);
641
94317099 642 if (tun && clean) {
ff1fa208
JK
643 if (!tfile->detached)
644 tun_napi_disable(tfile);
06e55add 645 tun_napi_del(tfile);
94317099
PP
646 }
647
9e85722d 648 if (tun && !tfile->detached) {
c8d68e6b
JW
649 u16 index = tfile->queue_index;
650 BUG_ON(index >= tun->numqueues);
c8d68e6b
JW
651
652 rcu_assign_pointer(tun->tfiles[index],
653 tun->tfiles[tun->numqueues - 1]);
b8deabd3 654 ntfile = rtnl_dereference(tun->tfiles[index]);
c8d68e6b 655 ntfile->queue_index = index;
9871a9e4
JW
656 rcu_assign_pointer(tun->tfiles[tun->numqueues - 1],
657 NULL);
c8d68e6b
JW
658
659 --tun->numqueues;
9e85722d 660 if (clean) {
c956674b 661 RCU_INIT_POINTER(tfile->tun, NULL);
4008e97f 662 sock_put(&tfile->sk);
a8fc8cb5 663 } else {
4008e97f 664 tun_disable_queue(tun, tfile);
a8fc8cb5
JK
665 tun_napi_disable(tfile);
666 }
c8d68e6b
JW
667
668 synchronize_net();
96442e42 669 tun_flow_delete_by_queue(tun, tun->numqueues + 1);
c8d68e6b 670 /* Drop read queue */
4bfb0513 671 tun_queue_purge(tfile);
c8d68e6b 672 tun_set_real_num_queues(tun);
dd38bd85 673 } else if (tfile->detached && clean) {
4008e97f 674 tun = tun_enable_queue(tfile);
dd38bd85
JW
675 sock_put(&tfile->sk);
676 }
c8d68e6b
JW
677
678 if (clean) {
af668b3c
MT
679 if (tun && tun->numqueues == 0 && tun->numdisabled == 0) {
680 netif_carrier_off(tun->dev);
681
40630b82 682 if (!(tun->flags & IFF_PERSIST) &&
af668b3c 683 tun->dev->reg_state == NETREG_REGISTERED)
4008e97f 684 unregister_netdevice(tun->dev);
af668b3c 685 }
b196d88a
JW
686 if (tun)
687 xdp_rxq_info_unreg(&tfile->xdp_rxq);
7063efd3 688 ptr_ring_cleanup(&tfile->tx_ring, tun_ptr_free);
140e807d 689 sock_put(&tfile->sk);
c8d68e6b
JW
690 }
691}
692
693static void tun_detach(struct tun_file *tfile, bool clean)
694{
83c1f36f
SD
695 struct tun_struct *tun;
696 struct net_device *dev;
697
c8d68e6b 698 rtnl_lock();
83c1f36f
SD
699 tun = rtnl_dereference(tfile->tun);
700 dev = tun ? tun->dev : NULL;
c8d68e6b 701 __tun_detach(tfile, clean);
83c1f36f
SD
702 if (dev)
703 netdev_state_change(dev);
c8d68e6b
JW
704 rtnl_unlock();
705}
706
707static void tun_detach_all(struct net_device *dev)
708{
709 struct tun_struct *tun = netdev_priv(dev);
4008e97f 710 struct tun_file *tfile, *tmp;
c8d68e6b
JW
711 int i, n = tun->numqueues;
712
713 for (i = 0; i < n; i++) {
b8deabd3 714 tfile = rtnl_dereference(tun->tfiles[i]);
c8d68e6b 715 BUG_ON(!tfile);
06e55add 716 tun_napi_disable(tfile);
addf8fc4 717 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
9e641bdc 718 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
c956674b 719 RCU_INIT_POINTER(tfile->tun, NULL);
c8d68e6b
JW
720 --tun->numqueues;
721 }
9e85722d 722 list_for_each_entry(tfile, &tun->disabled, next) {
addf8fc4 723 tfile->socket.sk->sk_shutdown = RCV_SHUTDOWN;
9e641bdc 724 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
c956674b 725 RCU_INIT_POINTER(tfile->tun, NULL);
9e85722d 726 }
c8d68e6b
JW
727 BUG_ON(tun->numqueues != 0);
728
729 synchronize_net();
730 for (i = 0; i < n; i++) {
b8deabd3 731 tfile = rtnl_dereference(tun->tfiles[i]);
06e55add 732 tun_napi_del(tfile);
c8d68e6b 733 /* Drop read queue */
4bfb0513 734 tun_queue_purge(tfile);
b196d88a 735 xdp_rxq_info_unreg(&tfile->xdp_rxq);
c8d68e6b
JW
736 sock_put(&tfile->sk);
737 }
4008e97f 738 list_for_each_entry_safe(tfile, tmp, &tun->disabled, next) {
3b9bc84d 739 tun_napi_del(tfile);
4008e97f 740 tun_enable_queue(tfile);
4bfb0513 741 tun_queue_purge(tfile);
b196d88a 742 xdp_rxq_info_unreg(&tfile->xdp_rxq);
4008e97f
JW
743 sock_put(&tfile->sk);
744 }
745 BUG_ON(tun->numdisabled != 0);
dd38bd85 746
40630b82 747 if (tun->flags & IFF_PERSIST)
dd38bd85 748 module_put(THIS_MODULE);
c8d68e6b
JW
749}
750
94317099 751static int tun_attach(struct tun_struct *tun, struct file *file,
77f22f92
YY
752 bool skip_filter, bool napi, bool napi_frags,
753 bool publish_tun)
a7385ba2 754{
631ab46b 755 struct tun_file *tfile = file->private_data;
1576d986 756 struct net_device *dev = tun->dev;
38231b7a 757 int err;
a7385ba2 758
5dbbaf2d
PM
759 err = security_tun_dev_attach(tfile->socket.sk, tun->security);
760 if (err < 0)
761 goto out;
762
38231b7a 763 err = -EINVAL;
9e85722d 764 if (rtnl_dereference(tfile->tun) && !tfile->detached)
38231b7a
EB
765 goto out;
766
767 err = -EBUSY;
40630b82 768 if (!(tun->flags & IFF_MULTI_QUEUE) && tun->numqueues == 1)
c8d68e6b
JW
769 goto out;
770
771 err = -E2BIG;
4008e97f
JW
772 if (!tfile->detached &&
773 tun->numqueues + tun->numdisabled == MAX_TAP_QUEUES)
38231b7a
EB
774 goto out;
775
776 err = 0;
54f968d6 777
92d4ea6e 778 /* Re-attach the filter to persist device */
849c9b6f 779 if (!skip_filter && (tun->filter_attached == true)) {
8ced425e
HFS
780 lock_sock(tfile->socket.sk);
781 err = sk_attach_filter(&tun->fprog, tfile->socket.sk);
782 release_sock(tfile->socket.sk);
54f968d6
JW
783 if (!err)
784 goto out;
785 }
1576d986
JW
786
787 if (!tfile->detached &&
b196d88a
JW
788 ptr_ring_resize(&tfile->tx_ring, dev->tx_queue_len,
789 GFP_KERNEL, tun_ptr_free)) {
1576d986
JW
790 err = -ENOMEM;
791 goto out;
792 }
793
c8d68e6b 794 tfile->queue_index = tun->numqueues;
addf8fc4 795 tfile->socket.sk->sk_shutdown &= ~RCV_SHUTDOWN;
8bf5c4ee
JDB
796
797 if (tfile->detached) {
798 /* Re-attach detached tfile, updating XDP queue_index */
799 WARN_ON(!xdp_rxq_info_is_reg(&tfile->xdp_rxq));
800
801 if (tfile->xdp_rxq.queue_index != tfile->queue_index)
802 tfile->xdp_rxq.queue_index = tfile->queue_index;
803 } else {
804 /* Setup XDP RX-queue info, for new tfile getting attached */
805 err = xdp_rxq_info_reg(&tfile->xdp_rxq,
b02e5a0e 806 tun->dev, tfile->queue_index, 0);
8bf5c4ee
JDB
807 if (err < 0)
808 goto out;
8d5d8852
JDB
809 err = xdp_rxq_info_reg_mem_model(&tfile->xdp_rxq,
810 MEM_TYPE_PAGE_SHARED, NULL);
811 if (err < 0) {
812 xdp_rxq_info_unreg(&tfile->xdp_rxq);
813 goto out;
814 }
8bf5c4ee
JDB
815 err = 0;
816 }
817
94317099 818 if (tfile->detached) {
4008e97f 819 tun_enable_queue(tfile);
a8fc8cb5 820 tun_napi_enable(tfile);
94317099 821 } else {
4008e97f 822 sock_hold(&tfile->sk);
af3fb24e 823 tun_napi_init(tun, tfile, napi, napi_frags);
94317099 824 }
4008e97f 825
e4a2a304
JW
826 if (rtnl_dereference(tun->xdp_prog))
827 sock_set_flag(&tfile->sk, SOCK_XDP);
828
c8d68e6b
JW
829 /* device is allowed to go away first, so no need to hold extra
830 * refcnt.
831 */
832
0b7959b6
SF
833 /* Publish tfile->tun and tun->tfiles only after we've fully
834 * initialized tfile; otherwise we risk using half-initialized
835 * object.
836 */
77f22f92
YY
837 if (publish_tun)
838 rcu_assign_pointer(tfile->tun, tun);
0b7959b6
SF
839 rcu_assign_pointer(tun->tfiles[tun->numqueues], tfile);
840 tun->numqueues++;
3a03cb84 841 tun_set_real_num_queues(tun);
c8d68e6b
JW
842out:
843 return err;
631ab46b
EB
844}
845
9484dc74 846static struct tun_struct *tun_get(struct tun_file *tfile)
631ab46b 847{
6e914fc7 848 struct tun_struct *tun;
c70f1829 849
6e914fc7
JW
850 rcu_read_lock();
851 tun = rcu_dereference(tfile->tun);
852 if (tun)
853 dev_hold(tun->dev);
854 rcu_read_unlock();
c70f1829
EB
855
856 return tun;
631ab46b
EB
857}
858
631ab46b
EB
859static void tun_put(struct tun_struct *tun)
860{
6e914fc7 861 dev_put(tun->dev);
631ab46b
EB
862}
863
6b8a66ee 864/* TAP filtering */
f271b2cc
MK
865static void addr_hash_set(u32 *mask, const u8 *addr)
866{
867 int n = ether_crc(ETH_ALEN, addr) >> 26;
868 mask[n >> 5] |= (1 << (n & 31));
869}
870
871static unsigned int addr_hash_test(const u32 *mask, const u8 *addr)
872{
873 int n = ether_crc(ETH_ALEN, addr) >> 26;
874 return mask[n >> 5] & (1 << (n & 31));
875}
876
877static int update_filter(struct tap_filter *filter, void __user *arg)
878{
879 struct { u8 u[ETH_ALEN]; } *addr;
880 struct tun_filter uf;
881 int err, alen, n, nexact;
882
883 if (copy_from_user(&uf, arg, sizeof(uf)))
884 return -EFAULT;
885
886 if (!uf.count) {
887 /* Disabled */
888 filter->count = 0;
889 return 0;
890 }
891
892 alen = ETH_ALEN * uf.count;
28e8190d
ME
893 addr = memdup_user(arg + sizeof(uf), alen);
894 if (IS_ERR(addr))
895 return PTR_ERR(addr);
f271b2cc
MK
896
897 /* The filter is updated without holding any locks. Which is
898 * perfectly safe. We disable it first and in the worst
899 * case we'll accept a few undesired packets. */
900 filter->count = 0;
901 wmb();
902
903 /* Use first set of addresses as an exact filter */
904 for (n = 0; n < uf.count && n < FLT_EXACT_COUNT; n++)
905 memcpy(filter->addr[n], addr[n].u, ETH_ALEN);
906
907 nexact = n;
908
cfbf84fc
AW
909 /* Remaining multicast addresses are hashed,
910 * unicast will leave the filter disabled. */
f271b2cc 911 memset(filter->mask, 0, sizeof(filter->mask));
cfbf84fc
AW
912 for (; n < uf.count; n++) {
913 if (!is_multicast_ether_addr(addr[n].u)) {
914 err = 0; /* no filter */
3b8d2a69 915 goto free_addr;
cfbf84fc 916 }
f271b2cc 917 addr_hash_set(filter->mask, addr[n].u);
cfbf84fc 918 }
f271b2cc
MK
919
920 /* For ALLMULTI just set the mask to all ones.
921 * This overrides the mask populated above. */
922 if ((uf.flags & TUN_FLT_ALLMULTI))
923 memset(filter->mask, ~0, sizeof(filter->mask));
924
925 /* Now enable the filter */
926 wmb();
927 filter->count = nexact;
928
929 /* Return the number of exact filters */
930 err = nexact;
3b8d2a69 931free_addr:
f271b2cc
MK
932 kfree(addr);
933 return err;
934}
935
936/* Returns: 0 - drop, !=0 - accept */
937static int run_filter(struct tap_filter *filter, const struct sk_buff *skb)
938{
939 /* Cannot use eth_hdr(skb) here because skb_mac_hdr() is incorrect
940 * at this point. */
941 struct ethhdr *eh = (struct ethhdr *) skb->data;
942 int i;
943
944 /* Exact match */
945 for (i = 0; i < filter->count; i++)
2e42e474 946 if (ether_addr_equal(eh->h_dest, filter->addr[i]))
f271b2cc
MK
947 return 1;
948
949 /* Inexact match (multicast only) */
950 if (is_multicast_ether_addr(eh->h_dest))
951 return addr_hash_test(filter->mask, eh->h_dest);
952
953 return 0;
954}
955
956/*
957 * Checks whether the packet is accepted or not.
958 * Returns: 0 - drop, !=0 - accept
959 */
960static int check_filter(struct tap_filter *filter, const struct sk_buff *skb)
961{
962 if (!filter->count)
963 return 1;
964
965 return run_filter(filter, skb);
966}
967
1da177e4
LT
968/* Network device part of the driver */
969
7282d491 970static const struct ethtool_ops tun_ethtool_ops;
1da177e4 971
158b515f
GK
972static int tun_net_init(struct net_device *dev)
973{
974 struct tun_struct *tun = netdev_priv(dev);
975 struct ifreq *ifr = tun->ifr;
976 int err;
977
978 dev->tstats = netdev_alloc_pcpu_stats(struct pcpu_sw_netstats);
979 if (!dev->tstats)
980 return -ENOMEM;
981
982 spin_lock_init(&tun->lock);
983
984 err = security_tun_dev_alloc_security(&tun->security);
985 if (err < 0) {
986 free_percpu(dev->tstats);
987 return err;
988 }
989
990 tun_flow_init(tun);
991
992 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST |
993 TUN_USER_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
994 NETIF_F_HW_VLAN_STAG_TX;
995 dev->features = dev->hw_features | NETIF_F_LLTX;
996 dev->vlan_features = dev->features &
997 ~(NETIF_F_HW_VLAN_CTAG_TX |
998 NETIF_F_HW_VLAN_STAG_TX);
999
1000 tun->flags = (tun->flags & ~TUN_FEATURES) |
1001 (ifr->ifr_flags & TUN_FEATURES);
1002
1003 INIT_LIST_HEAD(&tun->disabled);
1004 err = tun_attach(tun, tun->file, false, ifr->ifr_flags & IFF_NAPI,
1005 ifr->ifr_flags & IFF_NAPI_FRAGS, false);
1006 if (err < 0) {
1007 tun_flow_uninit(tun);
1008 security_tun_dev_free_security(tun->security);
1009 free_percpu(dev->tstats);
1010 return err;
1011 }
1012 return 0;
1013}
1014
c70f1829
EB
1015/* Net device detach from fd. */
1016static void tun_net_uninit(struct net_device *dev)
1017{
c8d68e6b 1018 tun_detach_all(dev);
c70f1829
EB
1019}
1020
1da177e4
LT
1021/* Net device open. */
1022static int tun_net_open(struct net_device *dev)
1023{
c8d68e6b 1024 netif_tx_start_all_queues(dev);
b20e2d54 1025
1da177e4
LT
1026 return 0;
1027}
1028
1029/* Net device close. */
1030static int tun_net_close(struct net_device *dev)
1031{
c8d68e6b 1032 netif_tx_stop_all_queues(dev);
1da177e4
LT
1033 return 0;
1034}
1035
1036/* Net device start xmit */
96f84061 1037static void tun_automq_xmit(struct tun_struct *tun, struct sk_buff *skb)
1da177e4 1038{
3df97ba8 1039#ifdef CONFIG_RPS
dc05360f 1040 if (tun->numqueues == 1 && static_branch_unlikely(&rps_needed)) {
9bc88939
TH
1041 /* Select queue was not called for the skbuff, so we extract the
1042 * RPS hash and save it into the flow_table here.
1043 */
4b035271 1044 struct tun_flow_entry *e;
9bc88939
TH
1045 __u32 rxhash;
1046
feec084a 1047 rxhash = __skb_get_hash_symmetric(skb);
4b035271
WL
1048 e = tun_flow_find(&tun->flows[tun_hashfn(rxhash)], rxhash);
1049 if (e)
1050 tun_flow_save_rps_rxhash(e, rxhash);
9bc88939 1051 }
3df97ba8 1052#endif
96f84061
JW
1053}
1054
aff3d70a
JW
1055static unsigned int run_ebpf_filter(struct tun_struct *tun,
1056 struct sk_buff *skb,
1057 int len)
1058{
1059 struct tun_prog *prog = rcu_dereference(tun->filter_prog);
1060
1061 if (prog)
1062 len = bpf_prog_run_clear_cb(prog->prog, skb);
1063
1064 return len;
1065}
1066
96f84061
JW
1067/* Net device start xmit */
1068static netdev_tx_t tun_net_xmit(struct sk_buff *skb, struct net_device *dev)
1069{
1070 struct tun_struct *tun = netdev_priv(dev);
4b4f052e 1071 enum skb_drop_reason drop_reason;
96f84061 1072 int txq = skb->queue_mapping;
a31d27fb 1073 struct netdev_queue *queue;
96f84061 1074 struct tun_file *tfile;
aff3d70a 1075 int len = skb->len;
96f84061
JW
1076
1077 rcu_read_lock();
1078 tfile = rcu_dereference(tun->tfiles[txq]);
96f84061
JW
1079
1080 /* Drop packet if interface is not attached */
4b4f052e
DZ
1081 if (!tfile) {
1082 drop_reason = SKB_DROP_REASON_DEV_READY;
96f84061 1083 goto drop;
4b4f052e 1084 }
96f84061
JW
1085
1086 if (!rcu_dereference(tun->steering_prog))
1087 tun_automq_xmit(tun, skb);
9bc88939 1088
3424170f 1089 netif_info(tun, tx_queued, tun->dev, "%s %d\n", __func__, skb->len);
6e914fc7 1090
f271b2cc
MK
1091 /* Drop if the filter does not like it.
1092 * This is a noop if the filter is disabled.
1093 * Filter can be enabled only for the TAP devices. */
4b4f052e
DZ
1094 if (!check_filter(&tun->txflt, skb)) {
1095 drop_reason = SKB_DROP_REASON_TAP_TXFILTER;
f271b2cc 1096 goto drop;
4b4f052e 1097 }
f271b2cc 1098
54f968d6 1099 if (tfile->socket.sk->sk_filter &&
4b4f052e
DZ
1100 sk_filter(tfile->socket.sk, skb)) {
1101 drop_reason = SKB_DROP_REASON_SOCKET_FILTER;
99405162 1102 goto drop;
4b4f052e 1103 }
99405162 1104
aff3d70a 1105 len = run_ebpf_filter(tun, skb, len);
4b4f052e
DZ
1106 if (len == 0) {
1107 drop_reason = SKB_DROP_REASON_TAP_FILTER;
45a15d89 1108 goto drop;
4b4f052e 1109 }
45a15d89 1110
4b4f052e
DZ
1111 if (pskb_trim(skb, len)) {
1112 drop_reason = SKB_DROP_REASON_NOMEM;
aff3d70a 1113 goto drop;
4b4f052e 1114 }
aff3d70a 1115
4b4f052e
DZ
1116 if (unlikely(skb_orphan_frags_rx(skb, GFP_ATOMIC))) {
1117 drop_reason = SKB_DROP_REASON_SKB_UCOPY_FAULT;
7bf66305 1118 goto drop;
4b4f052e 1119 }
7bf66305 1120
7b996243 1121 skb_tx_timestamp(skb);
eda29772 1122
0110d6f2 1123 /* Orphan the skb - required as we might hang on to it
7bf66305
JW
1124 * for indefinite time.
1125 */
0110d6f2
MT
1126 skb_orphan(skb);
1127
895b5c9f 1128 nf_reset_ct(skb);
f8af75f3 1129
4b4f052e
DZ
1130 if (ptr_ring_produce(&tfile->tx_ring, skb)) {
1131 drop_reason = SKB_DROP_REASON_FULL_RING;
1576d986 1132 goto drop;
4b4f052e 1133 }
1da177e4 1134
a31d27fb
ND
1135 /* NETIF_F_LLTX requires to do our own update of trans_start */
1136 queue = netdev_get_tx_queue(dev, txq);
968a1a5d 1137 txq_trans_cond_update(queue);
a31d27fb 1138
1da177e4 1139 /* Notify and wake up reader process */
54f968d6
JW
1140 if (tfile->flags & TUN_FASYNC)
1141 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
9e641bdc 1142 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
6e914fc7
JW
1143
1144 rcu_read_unlock();
6ed10654 1145 return NETDEV_TX_OK;
1da177e4
LT
1146
1147drop:
625788b5 1148 dev_core_stats_tx_dropped_inc(dev);
149d36f7 1149 skb_tx_error(skb);
4b4f052e 1150 kfree_skb_reason(skb, drop_reason);
6e914fc7 1151 rcu_read_unlock();
baeababb 1152 return NET_XMIT_DROP;
1da177e4
LT
1153}
1154
f271b2cc 1155static void tun_net_mclist(struct net_device *dev)
1da177e4 1156{
f271b2cc
MK
1157 /*
1158 * This callback is supposed to deal with mc filter in
1159 * _rx_ path and has nothing to do with the _tx_ path.
1160 * In rx path we always accept everything userspace gives us.
1161 */
1da177e4
LT
1162}
1163
c8f44aff
MM
1164static netdev_features_t tun_net_fix_features(struct net_device *dev,
1165 netdev_features_t features)
88255375
MM
1166{
1167 struct tun_struct *tun = netdev_priv(dev);
1168
1169 return (features & tun->set_features) | (features & ~TUN_USER_FEATURES);
1170}
eaea34b2
PA
1171
1172static void tun_set_headroom(struct net_device *dev, int new_hr)
1173{
1174 struct tun_struct *tun = netdev_priv(dev);
1175
1176 if (new_hr < NET_SKB_PAD)
1177 new_hr = NET_SKB_PAD;
1178
1179 tun->align = new_hr;
1180}
1181
bc1f4470 1182static void
608b9977
PA
1183tun_net_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats)
1184{
608b9977 1185 struct tun_struct *tun = netdev_priv(dev);
608b9977 1186
497a5757 1187 dev_get_tstats64(dev, stats);
608b9977 1188
497a5757
HK
1189 stats->rx_frame_errors +=
1190 (unsigned long)atomic_long_read(&tun->rx_frame_errors);
608b9977
PA
1191}
1192
761876c8
JW
1193static int tun_xdp_set(struct net_device *dev, struct bpf_prog *prog,
1194 struct netlink_ext_ack *extack)
1195{
1196 struct tun_struct *tun = netdev_priv(dev);
e4a2a304 1197 struct tun_file *tfile;
761876c8 1198 struct bpf_prog *old_prog;
e4a2a304 1199 int i;
761876c8
JW
1200
1201 old_prog = rtnl_dereference(tun->xdp_prog);
1202 rcu_assign_pointer(tun->xdp_prog, prog);
1203 if (old_prog)
1204 bpf_prog_put(old_prog);
1205
e4a2a304
JW
1206 for (i = 0; i < tun->numqueues; i++) {
1207 tfile = rtnl_dereference(tun->tfiles[i]);
1208 if (prog)
1209 sock_set_flag(&tfile->sk, SOCK_XDP);
1210 else
1211 sock_reset_flag(&tfile->sk, SOCK_XDP);
1212 }
1213 list_for_each_entry(tfile, &tun->disabled, next) {
1214 if (prog)
1215 sock_set_flag(&tfile->sk, SOCK_XDP);
1216 else
1217 sock_reset_flag(&tfile->sk, SOCK_XDP);
1218 }
1219
761876c8
JW
1220 return 0;
1221}
1222
f4e63525 1223static int tun_xdp(struct net_device *dev, struct netdev_bpf *xdp)
761876c8
JW
1224{
1225 switch (xdp->command) {
1226 case XDP_SETUP_PROG:
1227 return tun_xdp_set(dev, xdp->prog, xdp->extack);
761876c8
JW
1228 default:
1229 return -EINVAL;
1230 }
1231}
1232
26d31925
ND
1233static int tun_net_change_carrier(struct net_device *dev, bool new_carrier)
1234{
1235 if (new_carrier) {
1236 struct tun_struct *tun = netdev_priv(dev);
1237
1238 if (!tun->numqueues)
1239 return -EPERM;
1240
1241 netif_carrier_on(dev);
1242 } else {
1243 netif_carrier_off(dev);
1244 }
1245 return 0;
1246}
1247
758e43b7 1248static const struct net_device_ops tun_netdev_ops = {
158b515f 1249 .ndo_init = tun_net_init,
c70f1829 1250 .ndo_uninit = tun_net_uninit,
758e43b7
SH
1251 .ndo_open = tun_net_open,
1252 .ndo_stop = tun_net_close,
00829823 1253 .ndo_start_xmit = tun_net_xmit,
88255375 1254 .ndo_fix_features = tun_net_fix_features,
c8d68e6b 1255 .ndo_select_queue = tun_select_queue,
eaea34b2 1256 .ndo_set_rx_headroom = tun_set_headroom,
608b9977 1257 .ndo_get_stats64 = tun_net_get_stats64,
26d31925 1258 .ndo_change_carrier = tun_net_change_carrier,
758e43b7
SH
1259};
1260
0c9d917b
JDB
1261static void __tun_xdp_flush_tfile(struct tun_file *tfile)
1262{
1263 /* Notify and wake up reader process */
1264 if (tfile->flags & TUN_FASYNC)
1265 kill_fasync(&tfile->fasync, SIGIO, POLL_IN);
1266 tfile->socket.sk->sk_data_ready(tfile->socket.sk);
1267}
1268
42b33468
JDB
1269static int tun_xdp_xmit(struct net_device *dev, int n,
1270 struct xdp_frame **frames, u32 flags)
fc72d1d5
JW
1271{
1272 struct tun_struct *tun = netdev_priv(dev);
fc72d1d5
JW
1273 struct tun_file *tfile;
1274 u32 numqueues;
fdc13979 1275 int nxmit = 0;
735fc405 1276 int i;
fc72d1d5 1277
0c9d917b 1278 if (unlikely(flags & ~XDP_XMIT_FLAGS_MASK))
42b33468
JDB
1279 return -EINVAL;
1280
fc72d1d5
JW
1281 rcu_read_lock();
1282
9871a9e4 1283resample:
fc72d1d5
JW
1284 numqueues = READ_ONCE(tun->numqueues);
1285 if (!numqueues) {
735fc405
JDB
1286 rcu_read_unlock();
1287 return -ENXIO; /* Caller will free/return all frames */
fc72d1d5
JW
1288 }
1289
1290 tfile = rcu_dereference(tun->tfiles[smp_processor_id() %
1291 numqueues]);
9871a9e4
JW
1292 if (unlikely(!tfile))
1293 goto resample;
735fc405
JDB
1294
1295 spin_lock(&tfile->tx_ring.producer_lock);
1296 for (i = 0; i < n; i++) {
1297 struct xdp_frame *xdp = frames[i];
1298 /* Encode the XDP flag into lowest bit for consumer to differ
1299 * XDP buffer from sk_buff.
1300 */
1301 void *frame = tun_xdp_to_ptr(xdp);
1302
1303 if (__ptr_ring_produce(&tfile->tx_ring, frame)) {
625788b5 1304 dev_core_stats_tx_dropped_inc(dev);
fdc13979 1305 break;
735fc405 1306 }
fdc13979 1307 nxmit++;
fc72d1d5 1308 }
735fc405 1309 spin_unlock(&tfile->tx_ring.producer_lock);
fc72d1d5 1310
0c9d917b
JDB
1311 if (flags & XDP_XMIT_FLUSH)
1312 __tun_xdp_flush_tfile(tfile);
1313
fc72d1d5 1314 rcu_read_unlock();
fdc13979 1315 return nxmit;
fc72d1d5
JW
1316}
1317
44fa2dbd
JDB
1318static int tun_xdp_tx(struct net_device *dev, struct xdp_buff *xdp)
1319{
1b698fa5 1320 struct xdp_frame *frame = xdp_convert_buff_to_frame(xdp);
fdc13979 1321 int nxmit;
44fa2dbd
JDB
1322
1323 if (unlikely(!frame))
1324 return -EOVERFLOW;
1325
fdc13979
LB
1326 nxmit = tun_xdp_xmit(dev, 1, &frame, XDP_XMIT_FLUSH);
1327 if (!nxmit)
1328 xdp_return_frame_rx_napi(frame);
1329 return nxmit;
fc72d1d5
JW
1330}
1331
758e43b7 1332static const struct net_device_ops tap_netdev_ops = {
158b515f 1333 .ndo_init = tun_net_init,
c70f1829 1334 .ndo_uninit = tun_net_uninit,
758e43b7
SH
1335 .ndo_open = tun_net_open,
1336 .ndo_stop = tun_net_close,
00829823 1337 .ndo_start_xmit = tun_net_xmit,
88255375 1338 .ndo_fix_features = tun_net_fix_features,
afc4b13d 1339 .ndo_set_rx_mode = tun_net_mclist,
758e43b7
SH
1340 .ndo_set_mac_address = eth_mac_addr,
1341 .ndo_validate_addr = eth_validate_addr,
c8d68e6b 1342 .ndo_select_queue = tun_select_queue,
5e52796a 1343 .ndo_features_check = passthru_features_check,
eaea34b2 1344 .ndo_set_rx_headroom = tun_set_headroom,
497a5757 1345 .ndo_get_stats64 = dev_get_tstats64,
f4e63525 1346 .ndo_bpf = tun_xdp,
fc72d1d5 1347 .ndo_xdp_xmit = tun_xdp_xmit,
26d31925 1348 .ndo_change_carrier = tun_net_change_carrier,
758e43b7
SH
1349};
1350
944a1376 1351static void tun_flow_init(struct tun_struct *tun)
96442e42
JW
1352{
1353 int i;
1354
96442e42
JW
1355 for (i = 0; i < TUN_NUM_FLOW_ENTRIES; i++)
1356 INIT_HLIST_HEAD(&tun->flows[i]);
1357
1358 tun->ageing_time = TUN_FLOW_EXPIRE;
e99e88a9
KC
1359 timer_setup(&tun->flow_gc_timer, tun_flow_cleanup, 0);
1360 mod_timer(&tun->flow_gc_timer,
1361 round_jiffies_up(jiffies + tun->ageing_time));
96442e42
JW
1362}
1363
1364static void tun_flow_uninit(struct tun_struct *tun)
1365{
1366 del_timer_sync(&tun->flow_gc_timer);
1367 tun_flow_flush(tun);
96442e42
JW
1368}
1369
91572088
JW
1370#define MIN_MTU 68
1371#define MAX_MTU 65535
1372
1da177e4 1373/* Initialize net device. */
158b515f 1374static void tun_net_initialize(struct net_device *dev)
1da177e4
LT
1375{
1376 struct tun_struct *tun = netdev_priv(dev);
6aa20a22 1377
1da177e4 1378 switch (tun->flags & TUN_TYPE_MASK) {
40630b82 1379 case IFF_TUN:
758e43b7 1380 dev->netdev_ops = &tun_netdev_ops;
b9815eb1 1381 dev->header_ops = &ip_tunnel_header_ops;
758e43b7 1382
1da177e4
LT
1383 /* Point-to-Point TUN Device */
1384 dev->hard_header_len = 0;
1385 dev->addr_len = 0;
1386 dev->mtu = 1500;
1387
1388 /* Zero header length */
6aa20a22 1389 dev->type = ARPHRD_NONE;
1da177e4 1390 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
1da177e4
LT
1391 break;
1392
40630b82 1393 case IFF_TAP:
7a0a9608 1394 dev->netdev_ops = &tap_netdev_ops;
1da177e4 1395 /* Ethernet TAP Device */
1da177e4 1396 ether_setup(dev);
550fd08c 1397 dev->priv_flags &= ~IFF_TX_SKB_SHARING;
a676847b 1398 dev->priv_flags |= IFF_LIVE_ADDR_CHANGE;
36226a8d 1399
f2cedb63 1400 eth_hw_addr_random(dev);
36226a8d 1401
1da177e4
LT
1402 break;
1403 }
91572088
JW
1404
1405 dev->min_mtu = MIN_MTU;
1406 dev->max_mtu = MAX_MTU - dev->hard_header_len;
1da177e4
LT
1407}
1408
2f3ab622
JW
1409static bool tun_sock_writeable(struct tun_struct *tun, struct tun_file *tfile)
1410{
1411 struct sock *sk = tfile->socket.sk;
1412
1413 return (tun->dev->flags & IFF_UP) && sock_writeable(sk);
1414}
1415
1da177e4
LT
1416/* Character device part */
1417
1418/* Poll */
afc9a42b 1419static __poll_t tun_chr_poll(struct file *file, poll_table *wait)
6aa20a22 1420{
b2430de3 1421 struct tun_file *tfile = file->private_data;
9484dc74 1422 struct tun_struct *tun = tun_get(tfile);
3c8a9c63 1423 struct sock *sk;
afc9a42b 1424 __poll_t mask = 0;
1da177e4
LT
1425
1426 if (!tun)
a9a08845 1427 return EPOLLERR;
1da177e4 1428
54f968d6 1429 sk = tfile->socket.sk;
3c8a9c63 1430
9e641bdc 1431 poll_wait(file, sk_sleep(sk), wait);
6aa20a22 1432
5990a305 1433 if (!ptr_ring_empty(&tfile->tx_ring))
a9a08845 1434 mask |= EPOLLIN | EPOLLRDNORM;
1da177e4 1435
2f3ab622
JW
1436 /* Make sure SOCKWQ_ASYNC_NOSPACE is set if not writable to
1437 * guarantee EPOLLOUT to be raised by either here or
1438 * tun_sock_write_space(). Then process could get notification
1439 * after it writes to a down device and meets -EIO.
1440 */
1441 if (tun_sock_writeable(tun, tfile) ||
1442 (!test_and_set_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags) &&
1443 tun_sock_writeable(tun, tfile)))
a9a08845 1444 mask |= EPOLLOUT | EPOLLWRNORM;
33dccbb0 1445
c70f1829 1446 if (tun->dev->reg_state != NETREG_REGISTERED)
a9a08845 1447 mask = EPOLLERR;
c70f1829 1448
631ab46b 1449 tun_put(tun);
1da177e4
LT
1450 return mask;
1451}
1452
90e33d45
PP
1453static struct sk_buff *tun_napi_alloc_frags(struct tun_file *tfile,
1454 size_t len,
1455 const struct iov_iter *it)
1456{
1457 struct sk_buff *skb;
1458 size_t linear;
1459 int err;
1460 int i;
1461
363a5328
ZX
1462 if (it->nr_segs > MAX_SKB_FRAGS + 1 ||
1463 len > (ETH_MAX_MTU - NET_SKB_PAD - NET_IP_ALIGN))
950271d7 1464 return ERR_PTR(-EMSGSIZE);
90e33d45
PP
1465
1466 local_bh_disable();
1467 skb = napi_get_frags(&tfile->napi);
1468 local_bh_enable();
1469 if (!skb)
1470 return ERR_PTR(-ENOMEM);
1471
1472 linear = iov_iter_single_seg_count(it);
1473 err = __skb_grow(skb, linear);
1474 if (err)
1475 goto free;
1476
1477 skb->len = len;
1478 skb->data_len = len - linear;
1479 skb->truesize += skb->data_len;
1480
1481 for (i = 1; i < it->nr_segs; i++) {
1482 size_t fragsz = it->iov[i].iov_len;
aa6daaca
ED
1483 struct page *page;
1484 void *frag;
90e33d45
PP
1485
1486 if (fragsz == 0 || fragsz > PAGE_SIZE) {
1487 err = -EINVAL;
1488 goto free;
1489 }
aa6daaca
ED
1490 frag = netdev_alloc_frag(fragsz);
1491 if (!frag) {
90e33d45
PP
1492 err = -ENOMEM;
1493 goto free;
1494 }
aa6daaca
ED
1495 page = virt_to_head_page(frag);
1496 skb_fill_page_desc(skb, i - 1, page,
1497 frag - page_address(page), fragsz);
90e33d45
PP
1498 }
1499
1500 return skb;
1501free:
1502 /* frees skb and all frags allocated with napi_alloc_frag() */
1503 napi_free_frags(&tfile->napi);
1504 return ERR_PTR(err);
1505}
1506
f42157cb
RR
1507/* prepad is the amount to reserve at front. len is length after that.
1508 * linear is a hint as to how much to copy (usually headers). */
54f968d6 1509static struct sk_buff *tun_alloc_skb(struct tun_file *tfile,
6f7c156c 1510 size_t prepad, size_t len,
1511 size_t linear, int noblock)
f42157cb 1512{
54f968d6 1513 struct sock *sk = tfile->socket.sk;
f42157cb 1514 struct sk_buff *skb;
33dccbb0 1515 int err;
f42157cb
RR
1516
1517 /* Under a page? Don't bother with paged skb. */
0eca93bc 1518 if (prepad + len < PAGE_SIZE || !linear)
33dccbb0 1519 linear = len;
f42157cb 1520
33dccbb0 1521 skb = sock_alloc_send_pskb(sk, prepad + linear, len - linear, noblock,
28d64271 1522 &err, 0);
f42157cb 1523 if (!skb)
33dccbb0 1524 return ERR_PTR(err);
f42157cb
RR
1525
1526 skb_reserve(skb, prepad);
1527 skb_put(skb, linear);
33dccbb0
HX
1528 skb->data_len = len - linear;
1529 skb->len += len - linear;
f42157cb
RR
1530
1531 return skb;
1532}
1533
5503fcec
JW
1534static void tun_rx_batched(struct tun_struct *tun, struct tun_file *tfile,
1535 struct sk_buff *skb, int more)
1536{
1537 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1538 struct sk_buff_head process_queue;
1539 u32 rx_batched = tun->rx_batched;
1540 bool rcv = false;
1541
1542 if (!rx_batched || (!more && skb_queue_empty(queue))) {
1543 local_bh_disable();
8ebebcba 1544 skb_record_rx_queue(skb, tfile->queue_index);
5503fcec
JW
1545 netif_receive_skb(skb);
1546 local_bh_enable();
1547 return;
1548 }
1549
1550 spin_lock(&queue->lock);
1551 if (!more || skb_queue_len(queue) == rx_batched) {
1552 __skb_queue_head_init(&process_queue);
1553 skb_queue_splice_tail_init(queue, &process_queue);
1554 rcv = true;
1555 } else {
1556 __skb_queue_tail(queue, skb);
1557 }
1558 spin_unlock(&queue->lock);
1559
1560 if (rcv) {
1561 struct sk_buff *nskb;
1562
1563 local_bh_disable();
8ebebcba
MC
1564 while ((nskb = __skb_dequeue(&process_queue))) {
1565 skb_record_rx_queue(nskb, tfile->queue_index);
5503fcec 1566 netif_receive_skb(nskb);
8ebebcba
MC
1567 }
1568 skb_record_rx_queue(skb, tfile->queue_index);
5503fcec
JW
1569 netif_receive_skb(skb);
1570 local_bh_enable();
1571 }
1572}
1573
66ccbc9c
JW
1574static bool tun_can_build_skb(struct tun_struct *tun, struct tun_file *tfile,
1575 int len, int noblock, bool zerocopy)
1576{
1577 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
1578 return false;
1579
1580 if (tfile->socket.sk->sk_sndbuf != INT_MAX)
1581 return false;
1582
1583 if (!noblock)
1584 return false;
1585
1586 if (zerocopy)
1587 return false;
1588
1589 if (SKB_DATA_ALIGN(len + TUN_RX_PAD) +
1590 SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
1591 return false;
1592
1593 return true;
1594}
1595
4b663366
AB
1596static struct sk_buff *__tun_build_skb(struct tun_file *tfile,
1597 struct page_frag *alloc_frag, char *buf,
8ae1aff0 1598 int buflen, int len, int pad)
ac1f1f6c
JW
1599{
1600 struct sk_buff *skb = build_skb(buf, buflen);
1601
1602 if (!skb)
1603 return ERR_PTR(-ENOMEM);
1604
8ae1aff0 1605 skb_reserve(skb, pad);
ac1f1f6c 1606 skb_put(skb, len);
4b663366 1607 skb_set_owner_w(skb, tfile->socket.sk);
ac1f1f6c
JW
1608
1609 get_page(alloc_frag->page);
1610 alloc_frag->offset += buflen;
1611
1612 return skb;
1613}
1614
8ae1aff0
JW
1615static int tun_xdp_act(struct tun_struct *tun, struct bpf_prog *xdp_prog,
1616 struct xdp_buff *xdp, u32 act)
1617{
1618 int err;
1619
1620 switch (act) {
1621 case XDP_REDIRECT:
1622 err = xdp_do_redirect(tun->dev, xdp, xdp_prog);
8ae1aff0
JW
1623 if (err)
1624 return err;
1625 break;
1626 case XDP_TX:
1627 err = tun_xdp_tx(tun->dev, xdp);
1628 if (err < 0)
1629 return err;
1630 break;
1631 case XDP_PASS:
1632 break;
1633 default:
c8064e5b 1634 bpf_warn_invalid_xdp_action(tun->dev, xdp_prog, act);
df561f66 1635 fallthrough;
8ae1aff0
JW
1636 case XDP_ABORTED:
1637 trace_xdp_exception(tun->dev, xdp_prog, act);
df561f66 1638 fallthrough;
8ae1aff0 1639 case XDP_DROP:
625788b5 1640 dev_core_stats_rx_dropped_inc(tun->dev);
8ae1aff0
JW
1641 break;
1642 }
1643
1644 return act;
1645}
1646
761876c8
JW
1647static struct sk_buff *tun_build_skb(struct tun_struct *tun,
1648 struct tun_file *tfile,
66ccbc9c 1649 struct iov_iter *from,
761876c8 1650 struct virtio_net_hdr *hdr,
1cfe6e93 1651 int len, int *skb_xdp)
66ccbc9c 1652{
0bbd7dad 1653 struct page_frag *alloc_frag = &current->task_frag;
761876c8 1654 struct bpf_prog *xdp_prog;
7df13219 1655 int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
66ccbc9c
JW
1656 char *buf;
1657 size_t copied;
8ae1aff0
JW
1658 int pad = TUN_RX_PAD;
1659 int err = 0;
7df13219
JW
1660
1661 rcu_read_lock();
1662 xdp_prog = rcu_dereference(tun->xdp_prog);
1663 if (xdp_prog)
4f23aff8 1664 pad += XDP_PACKET_HEADROOM;
7df13219
JW
1665 buflen += SKB_DATA_ALIGN(len + pad);
1666 rcu_read_unlock();
66ccbc9c 1667
63b9ab65 1668 alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
66ccbc9c
JW
1669 if (unlikely(!skb_page_frag_refill(buflen, alloc_frag, GFP_KERNEL)))
1670 return ERR_PTR(-ENOMEM);
1671
1672 buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
1673 copied = copy_page_from_iter(alloc_frag->page,
7df13219 1674 alloc_frag->offset + pad,
66ccbc9c
JW
1675 len, from);
1676 if (copied != len)
1677 return ERR_PTR(-EFAULT);
1678
7df13219
JW
1679 /* There's a small window that XDP may be set after the check
1680 * of xdp_prog above, this should be rare and for simplicity
1681 * we do XDP on skb in case the headroom is not enough.
1682 */
ac1f1f6c 1683 if (hdr->gso_type || !xdp_prog) {
1cfe6e93 1684 *skb_xdp = 1;
4b663366
AB
1685 return __tun_build_skb(tfile, alloc_frag, buf, buflen, len,
1686 pad);
ac1f1f6c
JW
1687 }
1688
1689 *skb_xdp = 0;
761876c8 1690
6547e387 1691 local_bh_disable();
761876c8
JW
1692 rcu_read_lock();
1693 xdp_prog = rcu_dereference(tun->xdp_prog);
8ae1aff0 1694 if (xdp_prog) {
761876c8 1695 struct xdp_buff xdp;
761876c8
JW
1696 u32 act;
1697
43b5169d 1698 xdp_init_buff(&xdp, buflen, &tfile->xdp_rxq);
be9df4af 1699 xdp_prepare_buff(&xdp, buf, pad, len, false);
761876c8 1700
8ae1aff0
JW
1701 act = bpf_prog_run_xdp(xdp_prog, &xdp);
1702 if (act == XDP_REDIRECT || act == XDP_TX) {
59655a5b
JW
1703 get_page(alloc_frag->page);
1704 alloc_frag->offset += buflen;
761876c8 1705 }
8ae1aff0 1706 err = tun_xdp_act(tun, xdp_prog, &xdp, act);
bee34890
WD
1707 if (err < 0) {
1708 if (act == XDP_REDIRECT || act == XDP_TX)
1709 put_page(alloc_frag->page);
1710 goto out;
1711 }
1712
1a097910 1713 if (err == XDP_REDIRECT)
1d233886 1714 xdp_do_flush();
8ae1aff0
JW
1715 if (err != XDP_PASS)
1716 goto out;
1717
1718 pad = xdp.data - xdp.data_hard_start;
1719 len = xdp.data_end - xdp.data;
761876c8 1720 }
291aeb2b
JW
1721 rcu_read_unlock();
1722 local_bh_enable();
761876c8 1723
4b663366 1724 return __tun_build_skb(tfile, alloc_frag, buf, buflen, len, pad);
761876c8 1725
f7053b6c 1726out:
761876c8 1727 rcu_read_unlock();
6547e387 1728 local_bh_enable();
761876c8 1729 return NULL;
66ccbc9c
JW
1730}
1731
1da177e4 1732/* Get packet from user space buffer */
54f968d6 1733static ssize_t tun_get_user(struct tun_struct *tun, struct tun_file *tfile,
f5ff53b4 1734 void *msg_control, struct iov_iter *from,
5503fcec 1735 int noblock, bool more)
1da177e4 1736{
09640e63 1737 struct tun_pi pi = { 0, cpu_to_be16(ETH_P_IP) };
1da177e4 1738 struct sk_buff *skb;
f5ff53b4 1739 size_t total_len = iov_iter_count(from);
eaea34b2 1740 size_t len = total_len, align = tun->align, linear;
f43798c2 1741 struct virtio_net_hdr gso = { 0 };
96f8d9ec 1742 int good_linear;
0690899b
MT
1743 int copylen;
1744 bool zerocopy = false;
1745 int err;
96f84061 1746 u32 rxhash = 0;
1cfe6e93 1747 int skb_xdp = 1;
af3fb24e 1748 bool frags = tun_napi_frags_enabled(tfile);
4b4f052e 1749 enum skb_drop_reason drop_reason;
1da177e4 1750
40630b82 1751 if (!(tun->flags & IFF_NO_PI)) {
15718ea0 1752 if (len < sizeof(pi))
1da177e4 1753 return -EINVAL;
15718ea0 1754 len -= sizeof(pi);
1da177e4 1755
cbbd26b8 1756 if (!copy_from_iter_full(&pi, sizeof(pi), from))
1da177e4
LT
1757 return -EFAULT;
1758 }
1759
40630b82 1760 if (tun->flags & IFF_VNET_HDR) {
e1edab87
WB
1761 int vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1762
1763 if (len < vnet_hdr_sz)
f43798c2 1764 return -EINVAL;
e1edab87 1765 len -= vnet_hdr_sz;
f43798c2 1766
cbbd26b8 1767 if (!copy_from_iter_full(&gso, sizeof(gso), from))
f43798c2
RR
1768 return -EFAULT;
1769
4909122f 1770 if ((gso.flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
56f0dcc5
MT
1771 tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2 > tun16_to_cpu(tun, gso.hdr_len))
1772 gso.hdr_len = cpu_to_tun16(tun, tun16_to_cpu(tun, gso.csum_start) + tun16_to_cpu(tun, gso.csum_offset) + 2);
4909122f 1773
56f0dcc5 1774 if (tun16_to_cpu(tun, gso.hdr_len) > len)
f43798c2 1775 return -EINVAL;
e1edab87 1776 iov_iter_advance(from, vnet_hdr_sz - sizeof(gso));
f43798c2
RR
1777 }
1778
40630b82 1779 if ((tun->flags & TUN_TYPE_MASK) == IFF_TAP) {
a504b86e 1780 align += NET_IP_ALIGN;
0eca93bc 1781 if (unlikely(len < ETH_HLEN ||
56f0dcc5 1782 (gso.hdr_len && tun16_to_cpu(tun, gso.hdr_len) < ETH_HLEN)))
e01bf1c8
RR
1783 return -EINVAL;
1784 }
6aa20a22 1785
96f8d9ec
JW
1786 good_linear = SKB_MAX_HEAD(align);
1787
88529176 1788 if (msg_control) {
f5ff53b4
AV
1789 struct iov_iter i = *from;
1790
88529176
JW
1791 /* There are 256 bytes to be copied in skb, so there is
1792 * enough room for skb expand head in case it is used.
0690899b
MT
1793 * The rest of the buffer is mapped from userspace.
1794 */
56f0dcc5 1795 copylen = gso.hdr_len ? tun16_to_cpu(tun, gso.hdr_len) : GOODCOPY_LEN;
96f8d9ec
JW
1796 if (copylen > good_linear)
1797 copylen = good_linear;
3dd5c330 1798 linear = copylen;
f5ff53b4
AV
1799 iov_iter_advance(&i, copylen);
1800 if (iov_iter_npages(&i, INT_MAX) <= MAX_SKB_FRAGS)
88529176
JW
1801 zerocopy = true;
1802 }
1803
90e33d45 1804 if (!frags && tun_can_build_skb(tun, tfile, len, noblock, zerocopy)) {
1cfe6e93
JW
1805 /* For the packet that is not easy to be processed
1806 * (e.g gso or jumbo packet), we will do it at after
1807 * skb was created with generic XDP routine.
1808 */
1809 skb = tun_build_skb(tun, tfile, from, &gso, len, &skb_xdp);
66ccbc9c 1810 if (IS_ERR(skb)) {
625788b5 1811 dev_core_stats_rx_dropped_inc(tun->dev);
66ccbc9c
JW
1812 return PTR_ERR(skb);
1813 }
761876c8
JW
1814 if (!skb)
1815 return total_len;
66ccbc9c
JW
1816 } else {
1817 if (!zerocopy) {
1818 copylen = len;
1819 if (tun16_to_cpu(tun, gso.hdr_len) > good_linear)
1820 linear = good_linear;
1821 else
1822 linear = tun16_to_cpu(tun, gso.hdr_len);
1823 }
1da177e4 1824
90e33d45
PP
1825 if (frags) {
1826 mutex_lock(&tfile->napi_mutex);
1827 skb = tun_napi_alloc_frags(tfile, copylen, from);
1828 /* tun_napi_alloc_frags() enforces a layout for the skb.
1829 * If zerocopy is enabled, then this layout will be
1830 * overwritten by zerocopy_sg_from_iter().
1831 */
1832 zerocopy = false;
1833 } else {
1834 skb = tun_alloc_skb(tfile, align, copylen, linear,
1835 noblock);
1836 }
1837
66ccbc9c
JW
1838 if (IS_ERR(skb)) {
1839 if (PTR_ERR(skb) != -EAGAIN)
625788b5 1840 dev_core_stats_rx_dropped_inc(tun->dev);
90e33d45
PP
1841 if (frags)
1842 mutex_unlock(&tfile->napi_mutex);
66ccbc9c
JW
1843 return PTR_ERR(skb);
1844 }
0690899b 1845
66ccbc9c
JW
1846 if (zerocopy)
1847 err = zerocopy_sg_from_iter(skb, from);
1848 else
1849 err = skb_copy_datagram_from_iter(skb, 0, from, len);
1850
1851 if (err) {
4477138f 1852 err = -EFAULT;
4b4f052e 1853 drop_reason = SKB_DROP_REASON_SKB_UCOPY_FAULT;
4477138f 1854drop:
625788b5 1855 dev_core_stats_rx_dropped_inc(tun->dev);
4b4f052e 1856 kfree_skb_reason(skb, drop_reason);
90e33d45
PP
1857 if (frags) {
1858 tfile->napi.skb = NULL;
1859 mutex_unlock(&tfile->napi_mutex);
1860 }
1861
4477138f 1862 return err;
66ccbc9c 1863 }
8f22757e 1864 }
1da177e4 1865
3e9e40e7 1866 if (virtio_net_hdr_to_skb(skb, &gso, tun_is_little_endian(tun))) {
497a5757 1867 atomic_long_inc(&tun->rx_frame_errors);
df10db98 1868 kfree_skb(skb);
90e33d45
PP
1869 if (frags) {
1870 tfile->napi.skb = NULL;
1871 mutex_unlock(&tfile->napi_mutex);
1872 }
1873
df10db98
PA
1874 return -EINVAL;
1875 }
1876
1da177e4 1877 switch (tun->flags & TUN_TYPE_MASK) {
40630b82
MT
1878 case IFF_TUN:
1879 if (tun->flags & IFF_NO_PI) {
2580c4c1
AP
1880 u8 ip_version = skb->len ? (skb->data[0] >> 4) : 0;
1881
1882 switch (ip_version) {
1883 case 4:
f09f7ee2
AWC
1884 pi.proto = htons(ETH_P_IP);
1885 break;
2580c4c1 1886 case 6:
f09f7ee2
AWC
1887 pi.proto = htons(ETH_P_IPV6);
1888 break;
1889 default:
625788b5 1890 dev_core_stats_rx_dropped_inc(tun->dev);
f09f7ee2
AWC
1891 kfree_skb(skb);
1892 return -EINVAL;
1893 }
1894 }
1895
459a98ed 1896 skb_reset_mac_header(skb);
1da177e4 1897 skb->protocol = pi.proto;
4c13eb66 1898 skb->dev = tun->dev;
1da177e4 1899 break;
40630b82 1900 case IFF_TAP:
96aa1b22
WB
1901 if (frags && !pskb_may_pull(skb, ETH_HLEN)) {
1902 err = -ENOMEM;
4b4f052e 1903 drop_reason = SKB_DROP_REASON_HDR_TRUNC;
96aa1b22
WB
1904 goto drop;
1905 }
1906 skb->protocol = eth_type_trans(skb, tun->dev);
1da177e4 1907 break;
6403eab1 1908 }
1da177e4 1909
0690899b
MT
1910 /* copy skb_ubuf_info for callback when skb has no error */
1911 if (zerocopy) {
9ee5e5ad 1912 skb_zcopy_init(skb, msg_control);
af1cc7a2
JW
1913 } else if (msg_control) {
1914 struct ubuf_info *uarg = msg_control;
36177832 1915 uarg->callback(NULL, uarg, false);
0690899b
MT
1916 }
1917
72f65107 1918 skb_reset_network_header(skb);
d2aa125d 1919 skb_probe_transport_header(skb);
3fe260e0 1920 skb_record_rx_queue(skb, tfile->queue_index);
38502af7 1921
1cfe6e93 1922 if (skb_xdp) {
761876c8
JW
1923 struct bpf_prog *xdp_prog;
1924 int ret;
1925
6547e387 1926 local_bh_disable();
761876c8
JW
1927 rcu_read_lock();
1928 xdp_prog = rcu_dereference(tun->xdp_prog);
1929 if (xdp_prog) {
1930 ret = do_xdp_generic(xdp_prog, skb);
1931 if (ret != XDP_PASS) {
1932 rcu_read_unlock();
6547e387 1933 local_bh_enable();
1efba987
ED
1934 if (frags) {
1935 tfile->napi.skb = NULL;
1936 mutex_unlock(&tfile->napi_mutex);
1937 }
761876c8
JW
1938 return total_len;
1939 }
1940 }
1941 rcu_read_unlock();
6547e387 1942 local_bh_enable();
761876c8
JW
1943 }
1944
cf1a1e07
PA
1945 /* Compute the costly rx hash only if needed for flow updates.
1946 * We may get a very small possibility of OOO during switching, not
1947 * worth to optimize.
1948 */
1949 if (!rcu_access_pointer(tun->steering_prog) && tun->numqueues > 1 &&
1950 !tfile->detached)
96f84061 1951 rxhash = __skb_get_hash_symmetric(skb);
94317099 1952
4477138f
ED
1953 rcu_read_lock();
1954 if (unlikely(!(tun->dev->flags & IFF_UP))) {
1955 err = -EIO;
9180bb4f 1956 rcu_read_unlock();
4b4f052e 1957 drop_reason = SKB_DROP_REASON_DEV_READY;
4477138f
ED
1958 goto drop;
1959 }
1960
90e33d45 1961 if (frags) {
96aa1b22
WB
1962 u32 headlen;
1963
90e33d45 1964 /* Exercise flow dissector code path. */
96aa1b22
WB
1965 skb_push(skb, ETH_HLEN);
1966 headlen = eth_get_headlen(tun->dev, skb->data,
1967 skb_headlen(skb));
90e33d45 1968
010f245b 1969 if (unlikely(headlen > skb_headlen(skb))) {
625788b5 1970 dev_core_stats_rx_dropped_inc(tun->dev);
90e33d45 1971 napi_free_frags(&tfile->napi);
4477138f 1972 rcu_read_unlock();
90e33d45
PP
1973 mutex_unlock(&tfile->napi_mutex);
1974 WARN_ON(1);
1975 return -ENOMEM;
1976 }
1977
1978 local_bh_disable();
1979 napi_gro_frags(&tfile->napi);
1118b204 1980 napi_complete(&tfile->napi);
90e33d45
PP
1981 local_bh_enable();
1982 mutex_unlock(&tfile->napi_mutex);
aec72f33 1983 } else if (tfile->napi_enabled) {
94317099
PP
1984 struct sk_buff_head *queue = &tfile->sk.sk_write_queue;
1985 int queue_len;
1986
1987 spin_lock_bh(&queue->lock);
1988 __skb_queue_tail(queue, skb);
1989 queue_len = skb_queue_len(queue);
1990 spin_unlock(&queue->lock);
1991
1992 if (!more || queue_len > NAPI_POLL_WEIGHT)
1993 napi_schedule(&tfile->napi);
1994
1995 local_bh_enable();
1996 } else if (!IS_ENABLED(CONFIG_4KSTACKS)) {
1997 tun_rx_batched(tun, tfile, skb, more);
1998 } else {
3d391f65 1999 netif_rx(skb);
94317099 2000 }
4477138f 2001 rcu_read_unlock();
6aa20a22 2002
497a5757
HK
2003 preempt_disable();
2004 dev_sw_netstats_rx_add(tun->dev, len);
2005 preempt_enable();
1da177e4 2006
96f84061
JW
2007 if (rxhash)
2008 tun_flow_update(tun, rxhash, tfile);
2009
0690899b 2010 return total_len;
6aa20a22 2011}
1da177e4 2012
f5ff53b4 2013static ssize_t tun_chr_write_iter(struct kiocb *iocb, struct iov_iter *from)
1da177e4 2014{
33dccbb0 2015 struct file *file = iocb->ki_filp;
54f968d6 2016 struct tun_file *tfile = file->private_data;
9484dc74 2017 struct tun_struct *tun = tun_get(tfile);
631ab46b 2018 ssize_t result;
5aac0390 2019 int noblock = 0;
1da177e4
LT
2020
2021 if (!tun)
2022 return -EBADFD;
2023
5aac0390
JA
2024 if ((file->f_flags & O_NONBLOCK) || (iocb->ki_flags & IOCB_NOWAIT))
2025 noblock = 1;
2026
2027 result = tun_get_user(tun, tfile, NULL, from, noblock, false);
631ab46b
EB
2028
2029 tun_put(tun);
2030 return result;
1da177e4
LT
2031}
2032
fc72d1d5
JW
2033static ssize_t tun_put_user_xdp(struct tun_struct *tun,
2034 struct tun_file *tfile,
1ffcbc85 2035 struct xdp_frame *xdp_frame,
fc72d1d5
JW
2036 struct iov_iter *iter)
2037{
2038 int vnet_hdr_sz = 0;
1ffcbc85 2039 size_t size = xdp_frame->len;
fc72d1d5
JW
2040 size_t ret;
2041
2042 if (tun->flags & IFF_VNET_HDR) {
2043 struct virtio_net_hdr gso = { 0 };
2044
2045 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
2046 if (unlikely(iov_iter_count(iter) < vnet_hdr_sz))
2047 return -EINVAL;
2048 if (unlikely(copy_to_iter(&gso, sizeof(gso), iter) !=
2049 sizeof(gso)))
2050 return -EFAULT;
2051 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
2052 }
2053
1ffcbc85 2054 ret = copy_to_iter(xdp_frame->data, size, iter) + vnet_hdr_sz;
fc72d1d5 2055
497a5757
HK
2056 preempt_disable();
2057 dev_sw_netstats_tx_add(tun->dev, 1, ret);
2058 preempt_enable();
fc72d1d5
JW
2059
2060 return ret;
2061}
2062
1da177e4 2063/* Put packet to the user space buffer */
6f7c156c 2064static ssize_t tun_put_user(struct tun_struct *tun,
54f968d6 2065 struct tun_file *tfile,
6f7c156c 2066 struct sk_buff *skb,
e0b46d0e 2067 struct iov_iter *iter)
1da177e4
LT
2068{
2069 struct tun_pi pi = { 0, skb->protocol };
e0b46d0e 2070 ssize_t total;
8c847d25 2071 int vlan_offset = 0;
a8f9bfdf 2072 int vlan_hlen = 0;
2eb783c4 2073 int vnet_hdr_sz = 0;
a8f9bfdf 2074
df8a39de 2075 if (skb_vlan_tag_present(skb))
a8f9bfdf 2076 vlan_hlen = VLAN_HLEN;
1da177e4 2077
40630b82 2078 if (tun->flags & IFF_VNET_HDR)
e1edab87 2079 vnet_hdr_sz = READ_ONCE(tun->vnet_hdr_sz);
1da177e4 2080
e0b46d0e
HX
2081 total = skb->len + vlan_hlen + vnet_hdr_sz;
2082
40630b82 2083 if (!(tun->flags & IFF_NO_PI)) {
e0b46d0e 2084 if (iov_iter_count(iter) < sizeof(pi))
1da177e4
LT
2085 return -EINVAL;
2086
e0b46d0e
HX
2087 total += sizeof(pi);
2088 if (iov_iter_count(iter) < total) {
1da177e4
LT
2089 /* Packet will be striped */
2090 pi.flags |= TUN_PKT_STRIP;
2091 }
6aa20a22 2092
e0b46d0e 2093 if (copy_to_iter(&pi, sizeof(pi), iter) != sizeof(pi))
1da177e4 2094 return -EFAULT;
6aa20a22 2095 }
1da177e4 2096
2eb783c4 2097 if (vnet_hdr_sz) {
9403cd7c 2098 struct virtio_net_hdr gso;
34166093 2099
e0b46d0e 2100 if (iov_iter_count(iter) < vnet_hdr_sz)
f43798c2
RR
2101 return -EINVAL;
2102
3e9e40e7 2103 if (virtio_net_hdr_from_skb(skb, &gso,
fd3a8862
WB
2104 tun_is_little_endian(tun), true,
2105 vlan_hlen)) {
f43798c2 2106 struct skb_shared_info *sinfo = skb_shinfo(skb);
34166093
MR
2107 pr_err("unexpected GSO type: "
2108 "0x%x, gso_size %d, hdr_len %d\n",
2109 sinfo->gso_type, tun16_to_cpu(tun, gso.gso_size),
2110 tun16_to_cpu(tun, gso.hdr_len));
2111 print_hex_dump(KERN_ERR, "tun: ",
2112 DUMP_PREFIX_NONE,
2113 16, 1, skb->head,
2114 min((int)tun16_to_cpu(tun, gso.hdr_len), 64), true);
2115 WARN_ON_ONCE(1);
2116 return -EINVAL;
2117 }
f43798c2 2118
e0b46d0e 2119 if (copy_to_iter(&gso, sizeof(gso), iter) != sizeof(gso))
f43798c2 2120 return -EFAULT;
8c847d25
JW
2121
2122 iov_iter_advance(iter, vnet_hdr_sz - sizeof(gso));
f43798c2
RR
2123 }
2124
a8f9bfdf 2125 if (vlan_hlen) {
e0b46d0e 2126 int ret;
aff3d70a 2127 struct veth veth;
6680ec68
JW
2128
2129 veth.h_vlan_proto = skb->vlan_proto;
df8a39de 2130 veth.h_vlan_TCI = htons(skb_vlan_tag_get(skb));
6680ec68
JW
2131
2132 vlan_offset = offsetof(struct vlan_ethhdr, h_vlan_proto);
6680ec68 2133
e0b46d0e
HX
2134 ret = skb_copy_datagram_iter(skb, 0, iter, vlan_offset);
2135 if (ret || !iov_iter_count(iter))
6680ec68
JW
2136 goto done;
2137
e0b46d0e
HX
2138 ret = copy_to_iter(&veth, sizeof(veth), iter);
2139 if (ret != sizeof(veth) || !iov_iter_count(iter))
6680ec68
JW
2140 goto done;
2141 }
1da177e4 2142
e0b46d0e 2143 skb_copy_datagram_iter(skb, vlan_offset, iter, skb->len - vlan_offset);
1da177e4 2144
6680ec68 2145done:
608b9977 2146 /* caller is in process context, */
497a5757
HK
2147 preempt_disable();
2148 dev_sw_netstats_tx_add(tun->dev, 1, skb->len + vlan_hlen);
2149 preempt_enable();
1da177e4
LT
2150
2151 return total;
2152}
2153
fc72d1d5 2154static void *tun_ring_recv(struct tun_file *tfile, int noblock, int *err)
1576d986
JW
2155{
2156 DECLARE_WAITQUEUE(wait, current);
fc72d1d5 2157 void *ptr = NULL;
f48cc6b2 2158 int error = 0;
1576d986 2159
fc72d1d5
JW
2160 ptr = ptr_ring_consume(&tfile->tx_ring);
2161 if (ptr)
1576d986
JW
2162 goto out;
2163 if (noblock) {
f48cc6b2 2164 error = -EAGAIN;
1576d986
JW
2165 goto out;
2166 }
2167
333f7909 2168 add_wait_queue(&tfile->socket.wq.wait, &wait);
1576d986
JW
2169
2170 while (1) {
71828b22 2171 set_current_state(TASK_INTERRUPTIBLE);
fc72d1d5
JW
2172 ptr = ptr_ring_consume(&tfile->tx_ring);
2173 if (ptr)
1576d986
JW
2174 break;
2175 if (signal_pending(current)) {
f48cc6b2 2176 error = -ERESTARTSYS;
1576d986
JW
2177 break;
2178 }
2179 if (tfile->socket.sk->sk_shutdown & RCV_SHUTDOWN) {
f48cc6b2 2180 error = -EFAULT;
1576d986
JW
2181 break;
2182 }
2183
2184 schedule();
2185 }
2186
ecef67cb 2187 __set_current_state(TASK_RUNNING);
333f7909 2188 remove_wait_queue(&tfile->socket.wq.wait, &wait);
1576d986
JW
2189
2190out:
f48cc6b2 2191 *err = error;
fc72d1d5 2192 return ptr;
1576d986
JW
2193}
2194
54f968d6 2195static ssize_t tun_do_read(struct tun_struct *tun, struct tun_file *tfile,
9b067034 2196 struct iov_iter *to,
fc72d1d5 2197 int noblock, void *ptr)
1da177e4 2198{
9b067034 2199 ssize_t ret;
1576d986 2200 int err;
1da177e4 2201
c33ee15b 2202 if (!iov_iter_count(to)) {
fc72d1d5 2203 tun_ptr_free(ptr);
9b067034 2204 return 0;
c33ee15b 2205 }
1da177e4 2206
fc72d1d5 2207 if (!ptr) {
ac77cfd4 2208 /* Read frames from ring */
fc72d1d5
JW
2209 ptr = tun_ring_recv(tfile, noblock, &err);
2210 if (!ptr)
ac77cfd4
JW
2211 return err;
2212 }
e0b46d0e 2213
1ffcbc85
JDB
2214 if (tun_is_xdp_frame(ptr)) {
2215 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
fc72d1d5 2216
1ffcbc85 2217 ret = tun_put_user_xdp(tun, tfile, xdpf, to);
03993094 2218 xdp_return_frame(xdpf);
fc72d1d5
JW
2219 } else {
2220 struct sk_buff *skb = ptr;
2221
2222 ret = tun_put_user(tun, tfile, skb, to);
2223 if (unlikely(ret < 0))
2224 kfree_skb(skb);
2225 else
2226 consume_skb(skb);
2227 }
1da177e4 2228
05c2828c
MT
2229 return ret;
2230}
2231
9b067034 2232static ssize_t tun_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
05c2828c
MT
2233{
2234 struct file *file = iocb->ki_filp;
2235 struct tun_file *tfile = file->private_data;
9484dc74 2236 struct tun_struct *tun = tun_get(tfile);
9b067034 2237 ssize_t len = iov_iter_count(to), ret;
5aac0390 2238 int noblock = 0;
05c2828c
MT
2239
2240 if (!tun)
2241 return -EBADFD;
5aac0390
JA
2242
2243 if ((file->f_flags & O_NONBLOCK) || (iocb->ki_flags & IOCB_NOWAIT))
2244 noblock = 1;
2245
2246 ret = tun_do_read(tun, tfile, to, noblock, NULL);
42404c09 2247 ret = min_t(ssize_t, ret, len);
d0b7da8a
ZYW
2248 if (ret > 0)
2249 iocb->ki_pos = ret;
631ab46b 2250 tun_put(tun);
1da177e4
LT
2251 return ret;
2252}
2253
cd5681d7 2254static void tun_prog_free(struct rcu_head *rcu)
96f84061 2255{
cd5681d7 2256 struct tun_prog *prog = container_of(rcu, struct tun_prog, rcu);
96f84061
JW
2257
2258 bpf_prog_destroy(prog->prog);
2259 kfree(prog);
2260}
2261
9d6474e4
JW
2262static int __tun_set_ebpf(struct tun_struct *tun,
2263 struct tun_prog __rcu **prog_p,
cd5681d7 2264 struct bpf_prog *prog)
96f84061 2265{
cd5681d7 2266 struct tun_prog *old, *new = NULL;
96f84061
JW
2267
2268 if (prog) {
2269 new = kmalloc(sizeof(*new), GFP_KERNEL);
2270 if (!new)
2271 return -ENOMEM;
2272 new->prog = prog;
2273 }
2274
124da8f6 2275 spin_lock_bh(&tun->lock);
cd5681d7 2276 old = rcu_dereference_protected(*prog_p,
124da8f6 2277 lockdep_is_held(&tun->lock));
cd5681d7 2278 rcu_assign_pointer(*prog_p, new);
124da8f6 2279 spin_unlock_bh(&tun->lock);
96f84061
JW
2280
2281 if (old)
cd5681d7 2282 call_rcu(&old->rcu, tun_prog_free);
96f84061
JW
2283
2284 return 0;
2285}
2286
96442e42
JW
2287static void tun_free_netdev(struct net_device *dev)
2288{
2289 struct tun_struct *tun = netdev_priv(dev);
2290
4008e97f 2291 BUG_ON(!(list_empty(&tun->disabled)));
11fc7d5a 2292
497a5757 2293 free_percpu(dev->tstats);
96442e42 2294 tun_flow_uninit(tun);
5dbbaf2d 2295 security_tun_dev_free_security(tun->security);
cd5681d7 2296 __tun_set_ebpf(tun, &tun->steering_prog, NULL);
aff3d70a 2297 __tun_set_ebpf(tun, &tun->filter_prog, NULL);
96442e42
JW
2298}
2299
1da177e4
LT
2300static void tun_setup(struct net_device *dev)
2301{
2302 struct tun_struct *tun = netdev_priv(dev);
2303
0625c883
EB
2304 tun->owner = INVALID_UID;
2305 tun->group = INVALID_GID;
4e24f2dd 2306 tun_default_link_ksettings(dev, &tun->link_ksettings);
1da177e4 2307
1da177e4 2308 dev->ethtool_ops = &tun_ethtool_ops;
cf124db5
DM
2309 dev->needs_free_netdev = true;
2310 dev->priv_destructor = tun_free_netdev;
016adb72
JW
2311 /* We prefer our own queue length */
2312 dev->tx_queue_len = TUN_READQ_SIZE;
1da177e4
LT
2313}
2314
f019a7a5
EB
2315/* Trivial set of netlink ops to allow deleting tun or tap
2316 * device with netlink.
2317 */
a8b8a889
MS
2318static int tun_validate(struct nlattr *tb[], struct nlattr *data[],
2319 struct netlink_ext_ack *extack)
f019a7a5 2320{
35b827b6
ND
2321 NL_SET_ERR_MSG(extack,
2322 "tun/tap creation via rtnetlink is not supported.");
2323 return -EOPNOTSUPP;
f019a7a5
EB
2324}
2325
1ec010e7
SD
2326static size_t tun_get_size(const struct net_device *dev)
2327{
2328 BUILD_BUG_ON(sizeof(u32) != sizeof(uid_t));
2329 BUILD_BUG_ON(sizeof(u32) != sizeof(gid_t));
2330
2331 return nla_total_size(sizeof(uid_t)) + /* OWNER */
2332 nla_total_size(sizeof(gid_t)) + /* GROUP */
2333 nla_total_size(sizeof(u8)) + /* TYPE */
2334 nla_total_size(sizeof(u8)) + /* PI */
2335 nla_total_size(sizeof(u8)) + /* VNET_HDR */
2336 nla_total_size(sizeof(u8)) + /* PERSIST */
2337 nla_total_size(sizeof(u8)) + /* MULTI_QUEUE */
2338 nla_total_size(sizeof(u32)) + /* NUM_QUEUES */
2339 nla_total_size(sizeof(u32)) + /* NUM_DISABLED_QUEUES */
2340 0;
2341}
2342
2343static int tun_fill_info(struct sk_buff *skb, const struct net_device *dev)
2344{
2345 struct tun_struct *tun = netdev_priv(dev);
2346
2347 if (nla_put_u8(skb, IFLA_TUN_TYPE, tun->flags & TUN_TYPE_MASK))
2348 goto nla_put_failure;
2349 if (uid_valid(tun->owner) &&
2350 nla_put_u32(skb, IFLA_TUN_OWNER,
2351 from_kuid_munged(current_user_ns(), tun->owner)))
2352 goto nla_put_failure;
2353 if (gid_valid(tun->group) &&
2354 nla_put_u32(skb, IFLA_TUN_GROUP,
2355 from_kgid_munged(current_user_ns(), tun->group)))
2356 goto nla_put_failure;
2357 if (nla_put_u8(skb, IFLA_TUN_PI, !(tun->flags & IFF_NO_PI)))
2358 goto nla_put_failure;
2359 if (nla_put_u8(skb, IFLA_TUN_VNET_HDR, !!(tun->flags & IFF_VNET_HDR)))
2360 goto nla_put_failure;
2361 if (nla_put_u8(skb, IFLA_TUN_PERSIST, !!(tun->flags & IFF_PERSIST)))
2362 goto nla_put_failure;
2363 if (nla_put_u8(skb, IFLA_TUN_MULTI_QUEUE,
2364 !!(tun->flags & IFF_MULTI_QUEUE)))
2365 goto nla_put_failure;
2366 if (tun->flags & IFF_MULTI_QUEUE) {
2367 if (nla_put_u32(skb, IFLA_TUN_NUM_QUEUES, tun->numqueues))
2368 goto nla_put_failure;
2369 if (nla_put_u32(skb, IFLA_TUN_NUM_DISABLED_QUEUES,
2370 tun->numdisabled))
2371 goto nla_put_failure;
2372 }
2373
2374 return 0;
2375
2376nla_put_failure:
2377 return -EMSGSIZE;
2378}
2379
f019a7a5
EB
2380static struct rtnl_link_ops tun_link_ops __read_mostly = {
2381 .kind = DRV_NAME,
2382 .priv_size = sizeof(struct tun_struct),
2383 .setup = tun_setup,
2384 .validate = tun_validate,
1ec010e7
SD
2385 .get_size = tun_get_size,
2386 .fill_info = tun_fill_info,
f019a7a5
EB
2387};
2388
33dccbb0
HX
2389static void tun_sock_write_space(struct sock *sk)
2390{
54f968d6 2391 struct tun_file *tfile;
43815482 2392 wait_queue_head_t *wqueue;
33dccbb0
HX
2393
2394 if (!sock_writeable(sk))
2395 return;
2396
9cd3e072 2397 if (!test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &sk->sk_socket->flags))
33dccbb0
HX
2398 return;
2399
43815482
ED
2400 wqueue = sk_sleep(sk);
2401 if (wqueue && waitqueue_active(wqueue))
a9a08845
LT
2402 wake_up_interruptible_sync_poll(wqueue, EPOLLOUT |
2403 EPOLLWRNORM | EPOLLWRBAND);
c722c625 2404
54f968d6
JW
2405 tfile = container_of(sk, struct tun_file, sk);
2406 kill_fasync(&tfile->fasync, SIGIO, POLL_OUT);
33dccbb0
HX
2407}
2408
f9e06c45
JW
2409static void tun_put_page(struct tun_page *tpage)
2410{
2411 if (tpage->page)
2412 __page_frag_cache_drain(tpage->page, tpage->count);
2413}
2414
043d222f
JW
2415static int tun_xdp_one(struct tun_struct *tun,
2416 struct tun_file *tfile,
f9e06c45
JW
2417 struct xdp_buff *xdp, int *flush,
2418 struct tun_page *tpage)
043d222f 2419{
4e4b08e5 2420 unsigned int datasize = xdp->data_end - xdp->data;
043d222f
JW
2421 struct tun_xdp_hdr *hdr = xdp->data_hard_start;
2422 struct virtio_net_hdr *gso = &hdr->gso;
043d222f
JW
2423 struct bpf_prog *xdp_prog;
2424 struct sk_buff *skb = NULL;
fb3f9037 2425 struct sk_buff_head *queue;
043d222f
JW
2426 u32 rxhash = 0, act;
2427 int buflen = hdr->buflen;
fb3f9037 2428 int ret = 0;
043d222f 2429 bool skb_xdp = false;
f9e06c45 2430 struct page *page;
043d222f
JW
2431
2432 xdp_prog = rcu_dereference(tun->xdp_prog);
2433 if (xdp_prog) {
2434 if (gso->gso_type) {
2435 skb_xdp = true;
2436 goto build;
2437 }
43b5169d
LB
2438
2439 xdp_init_buff(xdp, buflen, &tfile->xdp_rxq);
043d222f 2440 xdp_set_data_meta_invalid(xdp);
043d222f
JW
2441
2442 act = bpf_prog_run_xdp(xdp_prog, xdp);
fb3f9037
HH
2443 ret = tun_xdp_act(tun, xdp_prog, xdp, act);
2444 if (ret < 0) {
043d222f 2445 put_page(virt_to_head_page(xdp->data));
fb3f9037 2446 return ret;
043d222f
JW
2447 }
2448
fb3f9037 2449 switch (ret) {
043d222f
JW
2450 case XDP_REDIRECT:
2451 *flush = true;
df561f66 2452 fallthrough;
043d222f
JW
2453 case XDP_TX:
2454 return 0;
2455 case XDP_PASS:
2456 break;
2457 default:
f9e06c45
JW
2458 page = virt_to_head_page(xdp->data);
2459 if (tpage->page == page) {
2460 ++tpage->count;
2461 } else {
2462 tun_put_page(tpage);
2463 tpage->page = page;
2464 tpage->count = 1;
2465 }
043d222f
JW
2466 return 0;
2467 }
2468 }
2469
2470build:
2471 skb = build_skb(xdp->data_hard_start, buflen);
2472 if (!skb) {
fb3f9037 2473 ret = -ENOMEM;
043d222f
JW
2474 goto out;
2475 }
2476
2477 skb_reserve(skb, xdp->data - xdp->data_hard_start);
2478 skb_put(skb, xdp->data_end - xdp->data);
2479
2480 if (virtio_net_hdr_to_skb(skb, gso, tun_is_little_endian(tun))) {
497a5757 2481 atomic_long_inc(&tun->rx_frame_errors);
043d222f 2482 kfree_skb(skb);
fb3f9037 2483 ret = -EINVAL;
043d222f
JW
2484 goto out;
2485 }
2486
2487 skb->protocol = eth_type_trans(skb, tun->dev);
2488 skb_reset_network_header(skb);
d2aa125d 2489 skb_probe_transport_header(skb);
3fe260e0 2490 skb_record_rx_queue(skb, tfile->queue_index);
043d222f
JW
2491
2492 if (skb_xdp) {
fb3f9037
HH
2493 ret = do_xdp_generic(xdp_prog, skb);
2494 if (ret != XDP_PASS) {
2495 ret = 0;
043d222f 2496 goto out;
fb3f9037 2497 }
043d222f
JW
2498 }
2499
f29eb2a9
PA
2500 if (!rcu_dereference(tun->steering_prog) && tun->numqueues > 1 &&
2501 !tfile->detached)
043d222f
JW
2502 rxhash = __skb_get_hash_symmetric(skb);
2503
fb3f9037
HH
2504 if (tfile->napi_enabled) {
2505 queue = &tfile->sk.sk_write_queue;
2506 spin_lock(&queue->lock);
2507 __skb_queue_tail(queue, skb);
2508 spin_unlock(&queue->lock);
2509 ret = 1;
2510 } else {
2511 netif_receive_skb(skb);
2512 ret = 0;
2513 }
043d222f 2514
497a5757 2515 /* No need to disable preemption here since this function is
6342ca64
PB
2516 * always called with bh disabled
2517 */
497a5757 2518 dev_sw_netstats_rx_add(tun->dev, datasize);
043d222f
JW
2519
2520 if (rxhash)
2521 tun_flow_update(tun, rxhash, tfile);
2522
2523out:
fb3f9037 2524 return ret;
043d222f
JW
2525}
2526
1b784140 2527static int tun_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
05c2828c 2528{
043d222f 2529 int ret, i;
54f968d6 2530 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
9484dc74 2531 struct tun_struct *tun = tun_get(tfile);
fe8dd45b 2532 struct tun_msg_ctl *ctl = m->msg_control;
043d222f 2533 struct xdp_buff *xdp;
54f968d6
JW
2534
2535 if (!tun)
2536 return -EBADFD;
f5ff53b4 2537
74a335a0
HH
2538 if (m->msg_controllen == sizeof(struct tun_msg_ctl) &&
2539 ctl && ctl->type == TUN_MSG_PTR) {
6f0271d9 2540 struct tun_page tpage;
043d222f 2541 int n = ctl->num;
fb3f9037 2542 int flush = 0, queued = 0;
043d222f 2543
6f0271d9
DM
2544 memset(&tpage, 0, sizeof(tpage));
2545
043d222f
JW
2546 local_bh_disable();
2547 rcu_read_lock();
2548
2549 for (i = 0; i < n; i++) {
2550 xdp = &((struct xdp_buff *)ctl->ptr)[i];
fb3f9037
HH
2551 ret = tun_xdp_one(tun, tfile, xdp, &flush, &tpage);
2552 if (ret > 0)
2553 queued += ret;
043d222f
JW
2554 }
2555
2556 if (flush)
1d233886 2557 xdp_do_flush();
043d222f 2558
fb3f9037
HH
2559 if (tfile->napi_enabled && queued > 0)
2560 napi_schedule(&tfile->napi);
2561
043d222f
JW
2562 rcu_read_unlock();
2563 local_bh_enable();
2564
f9e06c45
JW
2565 tun_put_page(&tpage);
2566
043d222f
JW
2567 ret = total_len;
2568 goto out;
2569 }
fe8dd45b
JW
2570
2571 ret = tun_get_user(tun, tfile, ctl ? ctl->ptr : NULL, &m->msg_iter,
5503fcec
JW
2572 m->msg_flags & MSG_DONTWAIT,
2573 m->msg_flags & MSG_MORE);
043d222f 2574out:
54f968d6
JW
2575 tun_put(tun);
2576 return ret;
05c2828c
MT
2577}
2578
1b784140 2579static int tun_recvmsg(struct socket *sock, struct msghdr *m, size_t total_len,
05c2828c
MT
2580 int flags)
2581{
54f968d6 2582 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
9484dc74 2583 struct tun_struct *tun = tun_get(tfile);
fc72d1d5 2584 void *ptr = m->msg_control;
05c2828c 2585 int ret;
54f968d6 2586
c33ee15b
WX
2587 if (!tun) {
2588 ret = -EBADFD;
fc72d1d5 2589 goto out_free;
c33ee15b 2590 }
54f968d6 2591
eda29772 2592 if (flags & ~(MSG_DONTWAIT|MSG_TRUNC|MSG_ERRQUEUE)) {
3811ae76 2593 ret = -EINVAL;
c33ee15b 2594 goto out_put_tun;
3811ae76 2595 }
eda29772
RC
2596 if (flags & MSG_ERRQUEUE) {
2597 ret = sock_recv_errqueue(sock->sk, m, total_len,
2598 SOL_PACKET, TUN_TX_TIMESTAMP);
2599 goto out;
2600 }
fc72d1d5 2601 ret = tun_do_read(tun, tfile, &m->msg_iter, flags & MSG_DONTWAIT, ptr);
87897931 2602 if (ret > (ssize_t)total_len) {
42404c09
DM
2603 m->msg_flags |= MSG_TRUNC;
2604 ret = flags & MSG_TRUNC ? ret : total_len;
2605 }
3811ae76 2606out:
54f968d6 2607 tun_put(tun);
05c2828c 2608 return ret;
c33ee15b
WX
2609
2610out_put_tun:
2611 tun_put(tun);
fc72d1d5
JW
2612out_free:
2613 tun_ptr_free(ptr);
c33ee15b 2614 return ret;
05c2828c
MT
2615}
2616
fc72d1d5
JW
2617static int tun_ptr_peek_len(void *ptr)
2618{
2619 if (likely(ptr)) {
1ffcbc85
JDB
2620 if (tun_is_xdp_frame(ptr)) {
2621 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
fc72d1d5 2622
1ffcbc85 2623 return xdpf->len;
fc72d1d5
JW
2624 }
2625 return __skb_array_len_with_tag(ptr);
2626 } else {
2627 return 0;
2628 }
2629}
2630
1576d986
JW
2631static int tun_peek_len(struct socket *sock)
2632{
2633 struct tun_file *tfile = container_of(sock, struct tun_file, socket);
2634 struct tun_struct *tun;
2635 int ret = 0;
2636
9484dc74 2637 tun = tun_get(tfile);
1576d986
JW
2638 if (!tun)
2639 return 0;
2640
fc72d1d5 2641 ret = PTR_RING_PEEK_CALL(&tfile->tx_ring, tun_ptr_peek_len);
1576d986
JW
2642 tun_put(tun);
2643
2644 return ret;
2645}
2646
05c2828c
MT
2647/* Ops structure to mimic raw sockets with tun */
2648static const struct proto_ops tun_socket_ops = {
1576d986 2649 .peek_len = tun_peek_len,
05c2828c
MT
2650 .sendmsg = tun_sendmsg,
2651 .recvmsg = tun_recvmsg,
2652};
2653
33dccbb0
HX
2654static struct proto tun_proto = {
2655 .name = "tun",
2656 .owner = THIS_MODULE,
54f968d6 2657 .obj_size = sizeof(struct tun_file),
33dccbb0 2658};
f019a7a5 2659
980c9e8c
DW
2660static int tun_flags(struct tun_struct *tun)
2661{
031f5e03 2662 return tun->flags & (TUN_FEATURES | IFF_PERSIST | IFF_TUN | IFF_TAP);
980c9e8c
DW
2663}
2664
bc6d076d 2665static ssize_t tun_flags_show(struct device *dev, struct device_attribute *attr,
980c9e8c
DW
2666 char *buf)
2667{
2668 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
aff30699 2669 return sysfs_emit(buf, "0x%x\n", tun_flags(tun));
980c9e8c
DW
2670}
2671
bc6d076d
Y
2672static ssize_t owner_show(struct device *dev, struct device_attribute *attr,
2673 char *buf)
980c9e8c
DW
2674{
2675 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
0625c883 2676 return uid_valid(tun->owner)?
aff30699
WY
2677 sysfs_emit(buf, "%u\n",
2678 from_kuid_munged(current_user_ns(), tun->owner)) :
2679 sysfs_emit(buf, "-1\n");
980c9e8c
DW
2680}
2681
bc6d076d
Y
2682static ssize_t group_show(struct device *dev, struct device_attribute *attr,
2683 char *buf)
980c9e8c
DW
2684{
2685 struct tun_struct *tun = netdev_priv(to_net_dev(dev));
0625c883 2686 return gid_valid(tun->group) ?
aff30699
WY
2687 sysfs_emit(buf, "%u\n",
2688 from_kgid_munged(current_user_ns(), tun->group)) :
2689 sysfs_emit(buf, "-1\n");
980c9e8c
DW
2690}
2691
bc6d076d
Y
2692static DEVICE_ATTR_RO(tun_flags);
2693static DEVICE_ATTR_RO(owner);
2694static DEVICE_ATTR_RO(group);
980c9e8c 2695
c4d33e24
TI
2696static struct attribute *tun_dev_attrs[] = {
2697 &dev_attr_tun_flags.attr,
2698 &dev_attr_owner.attr,
2699 &dev_attr_group.attr,
2700 NULL
2701};
2702
2703static const struct attribute_group tun_attr_group = {
2704 .attrs = tun_dev_attrs
2705};
2706
d647a591 2707static int tun_set_iff(struct net *net, struct file *file, struct ifreq *ifr)
1da177e4
LT
2708{
2709 struct tun_struct *tun;
54f968d6 2710 struct tun_file *tfile = file->private_data;
1da177e4
LT
2711 struct net_device *dev;
2712 int err;
2713
7c0c3b1a
JW
2714 if (tfile->detached)
2715 return -EINVAL;
2716
90e33d45
PP
2717 if ((ifr->ifr_flags & IFF_NAPI_FRAGS)) {
2718 if (!capable(CAP_NET_ADMIN))
2719 return -EPERM;
2720
2721 if (!(ifr->ifr_flags & IFF_NAPI) ||
2722 (ifr->ifr_flags & TUN_TYPE_MASK) != IFF_TAP)
2723 return -EINVAL;
2724 }
2725
74a3e5a7
EB
2726 dev = __dev_get_by_name(net, ifr->ifr_name);
2727 if (dev) {
f85ba780
DW
2728 if (ifr->ifr_flags & IFF_TUN_EXCL)
2729 return -EBUSY;
74a3e5a7
EB
2730 if ((ifr->ifr_flags & IFF_TUN) && dev->netdev_ops == &tun_netdev_ops)
2731 tun = netdev_priv(dev);
2732 else if ((ifr->ifr_flags & IFF_TAP) && dev->netdev_ops == &tap_netdev_ops)
2733 tun = netdev_priv(dev);
2734 else
2735 return -EINVAL;
2736
8e6d91ae 2737 if (!!(ifr->ifr_flags & IFF_MULTI_QUEUE) !=
40630b82 2738 !!(tun->flags & IFF_MULTI_QUEUE))
8e6d91ae
JW
2739 return -EINVAL;
2740
cde8b15f 2741 if (tun_not_capable(tun))
2b980dbd 2742 return -EPERM;
5dbbaf2d 2743 err = security_tun_dev_open(tun->security);
2b980dbd
PM
2744 if (err < 0)
2745 return err;
2746
94317099 2747 err = tun_attach(tun, file, ifr->ifr_flags & IFF_NOFILTER,
af3fb24e 2748 ifr->ifr_flags & IFF_NAPI,
77f22f92 2749 ifr->ifr_flags & IFF_NAPI_FRAGS, true);
a7385ba2
EB
2750 if (err < 0)
2751 return err;
4008e97f 2752
40630b82 2753 if (tun->flags & IFF_MULTI_QUEUE &&
e8dbad66
JW
2754 (tun->numqueues + tun->numdisabled > 1)) {
2755 /* One or more queue has already been attached, no need
2756 * to initialize the device again.
2757 */
83c1f36f 2758 netdev_state_change(dev);
e8dbad66
JW
2759 return 0;
2760 }
9fffc5c6
SD
2761
2762 tun->flags = (tun->flags & ~TUN_FEATURES) |
2763 (ifr->ifr_flags & TUN_FEATURES);
83c1f36f
SD
2764
2765 netdev_state_change(dev);
2766 } else {
1da177e4
LT
2767 char *name;
2768 unsigned long flags = 0;
edfb6a14
JW
2769 int queues = ifr->ifr_flags & IFF_MULTI_QUEUE ?
2770 MAX_TAP_QUEUES : 1;
1da177e4 2771
c260b772 2772 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
ca6bb5d7 2773 return -EPERM;
2b980dbd
PM
2774 err = security_tun_dev_create();
2775 if (err < 0)
2776 return err;
ca6bb5d7 2777
1da177e4
LT
2778 /* Set dev type */
2779 if (ifr->ifr_flags & IFF_TUN) {
2780 /* TUN device */
40630b82 2781 flags |= IFF_TUN;
1da177e4
LT
2782 name = "tun%d";
2783 } else if (ifr->ifr_flags & IFF_TAP) {
2784 /* TAP device */
40630b82 2785 flags |= IFF_TAP;
1da177e4 2786 name = "tap%d";
6aa20a22 2787 } else
36989b90 2788 return -EINVAL;
6aa20a22 2789
1da177e4
LT
2790 if (*ifr->ifr_name)
2791 name = ifr->ifr_name;
2792
c8d68e6b 2793 dev = alloc_netdev_mqs(sizeof(struct tun_struct), name,
c835a677
TG
2794 NET_NAME_UNKNOWN, tun_setup, queues,
2795 queues);
edfb6a14 2796
1da177e4
LT
2797 if (!dev)
2798 return -ENOMEM;
2799
fc54c658 2800 dev_net_set(dev, net);
f019a7a5 2801 dev->rtnl_link_ops = &tun_link_ops;
fb7589a1 2802 dev->ifindex = tfile->ifindex;
c4d33e24 2803 dev->sysfs_groups[0] = &tun_attr_group;
758e43b7 2804
1da177e4
LT
2805 tun = netdev_priv(dev);
2806 tun->dev = dev;
2807 tun->flags = flags;
f271b2cc 2808 tun->txflt.count = 0;
d9d52b51 2809 tun->vnet_hdr_sz = sizeof(struct virtio_net_hdr);
33dccbb0 2810
eaea34b2 2811 tun->align = NET_SKB_PAD;
54f968d6
JW
2812 tun->filter_attached = false;
2813 tun->sndbuf = tfile->socket.sk->sk_sndbuf;
5503fcec 2814 tun->rx_batched = 0;
96f84061 2815 RCU_INIT_POINTER(tun->steering_prog, NULL);
33dccbb0 2816
158b515f
GK
2817 tun->ifr = ifr;
2818 tun->file = file;
608b9977 2819
158b515f 2820 tun_net_initialize(dev);
eb0fb363 2821
1da177e4 2822 err = register_netdevice(tun->dev);
158b515f
GK
2823 if (err < 0) {
2824 free_netdev(dev);
2825 return err;
2826 }
c2e315b8 2827 /* free_netdev() won't check refcnt, to avoid race
77f22f92
YY
2828 * with dev_put() we need publish tun after registration.
2829 */
2830 rcu_assign_pointer(tfile->tun, tun);
1da177e4
LT
2831 }
2832
195624d9
PR
2833 if (ifr->ifr_flags & IFF_NO_CARRIER)
2834 netif_carrier_off(tun->dev);
2835 else
2836 netif_carrier_on(tun->dev);
af668b3c 2837
e35259a9
MK
2838 /* Make sure persistent devices do not get stuck in
2839 * xoff state.
2840 */
2841 if (netif_running(tun->dev))
c8d68e6b 2842 netif_tx_wake_all_queues(tun->dev);
e35259a9 2843
1da177e4
LT
2844 strcpy(ifr->ifr_name, tun->dev->name);
2845 return 0;
1da177e4
LT
2846}
2847
12132768 2848static void tun_get_iff(struct tun_struct *tun, struct ifreq *ifr)
e3b99556 2849{
e3b99556
MM
2850 strcpy(ifr->ifr_name, tun->dev->name);
2851
980c9e8c 2852 ifr->ifr_flags = tun_flags(tun);
e3b99556 2853
e3b99556
MM
2854}
2855
5228ddc9
RR
2856/* This is like a cut-down ethtool ops, except done via tun fd so no
2857 * privs required. */
88255375 2858static int set_offload(struct tun_struct *tun, unsigned long arg)
5228ddc9 2859{
c8f44aff 2860 netdev_features_t features = 0;
5228ddc9
RR
2861
2862 if (arg & TUN_F_CSUM) {
88255375 2863 features |= NETIF_F_HW_CSUM;
5228ddc9
RR
2864 arg &= ~TUN_F_CSUM;
2865
2866 if (arg & (TUN_F_TSO4|TUN_F_TSO6)) {
2867 if (arg & TUN_F_TSO_ECN) {
2868 features |= NETIF_F_TSO_ECN;
2869 arg &= ~TUN_F_TSO_ECN;
2870 }
2871 if (arg & TUN_F_TSO4)
2872 features |= NETIF_F_TSO;
2873 if (arg & TUN_F_TSO6)
2874 features |= NETIF_F_TSO6;
2875 arg &= ~(TUN_F_TSO4|TUN_F_TSO6);
2876 }
0c19f846
WB
2877
2878 arg &= ~TUN_F_UFO;
5228ddc9
RR
2879 }
2880
2881 /* This gives the user a way to test for new features in future by
2882 * trying to set them. */
2883 if (arg)
2884 return -EINVAL;
2885
88255375 2886 tun->set_features = features;
09050957
YI
2887 tun->dev->wanted_features &= ~TUN_USER_FEATURES;
2888 tun->dev->wanted_features |= features;
88255375 2889 netdev_update_features(tun->dev);
5228ddc9
RR
2890
2891 return 0;
2892}
2893
c8d68e6b
JW
2894static void tun_detach_filter(struct tun_struct *tun, int n)
2895{
2896 int i;
2897 struct tun_file *tfile;
2898
2899 for (i = 0; i < n; i++) {
b8deabd3 2900 tfile = rtnl_dereference(tun->tfiles[i]);
8ced425e
HFS
2901 lock_sock(tfile->socket.sk);
2902 sk_detach_filter(tfile->socket.sk);
2903 release_sock(tfile->socket.sk);
c8d68e6b
JW
2904 }
2905
2906 tun->filter_attached = false;
2907}
2908
2909static int tun_attach_filter(struct tun_struct *tun)
2910{
2911 int i, ret = 0;
2912 struct tun_file *tfile;
2913
2914 for (i = 0; i < tun->numqueues; i++) {
b8deabd3 2915 tfile = rtnl_dereference(tun->tfiles[i]);
8ced425e
HFS
2916 lock_sock(tfile->socket.sk);
2917 ret = sk_attach_filter(&tun->fprog, tfile->socket.sk);
2918 release_sock(tfile->socket.sk);
c8d68e6b
JW
2919 if (ret) {
2920 tun_detach_filter(tun, i);
2921 return ret;
2922 }
2923 }
2924
2925 tun->filter_attached = true;
2926 return ret;
2927}
2928
2929static void tun_set_sndbuf(struct tun_struct *tun)
2930{
2931 struct tun_file *tfile;
2932 int i;
2933
2934 for (i = 0; i < tun->numqueues; i++) {
b8deabd3 2935 tfile = rtnl_dereference(tun->tfiles[i]);
c8d68e6b
JW
2936 tfile->socket.sk->sk_sndbuf = tun->sndbuf;
2937 }
2938}
2939
cde8b15f
JW
2940static int tun_set_queue(struct file *file, struct ifreq *ifr)
2941{
2942 struct tun_file *tfile = file->private_data;
2943 struct tun_struct *tun;
cde8b15f
JW
2944 int ret = 0;
2945
2946 rtnl_lock();
2947
2948 if (ifr->ifr_flags & IFF_ATTACH_QUEUE) {
4008e97f 2949 tun = tfile->detached;
5dbbaf2d 2950 if (!tun) {
cde8b15f 2951 ret = -EINVAL;
5dbbaf2d
PM
2952 goto unlock;
2953 }
2954 ret = security_tun_dev_attach_queue(tun->security);
2955 if (ret < 0)
2956 goto unlock;
af3fb24e 2957 ret = tun_attach(tun, file, false, tun->flags & IFF_NAPI,
77f22f92 2958 tun->flags & IFF_NAPI_FRAGS, true);
4008e97f 2959 } else if (ifr->ifr_flags & IFF_DETACH_QUEUE) {
b8deabd3 2960 tun = rtnl_dereference(tfile->tun);
40630b82 2961 if (!tun || !(tun->flags & IFF_MULTI_QUEUE) || tfile->detached)
4008e97f
JW
2962 ret = -EINVAL;
2963 else
2964 __tun_detach(tfile, false);
2965 } else
cde8b15f
JW
2966 ret = -EINVAL;
2967
83c1f36f
SD
2968 if (ret >= 0)
2969 netdev_state_change(tun->dev);
2970
5dbbaf2d 2971unlock:
cde8b15f
JW
2972 rtnl_unlock();
2973 return ret;
2974}
2975
8f3f330d 2976static int tun_set_ebpf(struct tun_struct *tun, struct tun_prog __rcu **prog_p,
cd5681d7 2977 void __user *data)
96f84061
JW
2978{
2979 struct bpf_prog *prog;
2980 int fd;
2981
2982 if (copy_from_user(&fd, data, sizeof(fd)))
2983 return -EFAULT;
2984
2985 if (fd == -1) {
2986 prog = NULL;
2987 } else {
2988 prog = bpf_prog_get_type(fd, BPF_PROG_TYPE_SOCKET_FILTER);
2989 if (IS_ERR(prog))
2990 return PTR_ERR(prog);
2991 }
2992
cd5681d7 2993 return __tun_set_ebpf(tun, prog_p, prog);
96f84061
JW
2994}
2995
cca8ea3b
PP
2996/* Return correct value for tun->dev->addr_len based on tun->dev->type. */
2997static unsigned char tun_get_addr_len(unsigned short type)
2998{
2999 switch (type) {
3000 case ARPHRD_IP6GRE:
3001 case ARPHRD_TUNNEL6:
3002 return sizeof(struct in6_addr);
3003 case ARPHRD_IPGRE:
3004 case ARPHRD_TUNNEL:
3005 case ARPHRD_SIT:
3006 return 4;
3007 case ARPHRD_ETHER:
3008 return ETH_ALEN;
3009 case ARPHRD_IEEE802154:
3010 case ARPHRD_IEEE802154_MONITOR:
3011 return IEEE802154_EXTENDED_ADDR_LEN;
3012 case ARPHRD_PHONET_PIPE:
3013 case ARPHRD_PPP:
3014 case ARPHRD_NONE:
3015 return 0;
3016 case ARPHRD_6LOWPAN:
3017 return EUI64_ADDR_LEN;
3018 case ARPHRD_FDDI:
3019 return FDDI_K_ALEN;
3020 case ARPHRD_HIPPI:
3021 return HIPPI_ALEN;
3022 case ARPHRD_IEEE802:
3023 return FC_ALEN;
3024 case ARPHRD_ROSE:
3025 return ROSE_ADDR_LEN;
3026 case ARPHRD_NETROM:
3027 return AX25_ADDR_LEN;
3028 case ARPHRD_LOCALTLK:
3029 return LTALK_ALEN;
3030 default:
3031 return 0;
3032 }
3033}
3034
50857e2a
AB
3035static long __tun_chr_ioctl(struct file *file, unsigned int cmd,
3036 unsigned long arg, int ifreq_len)
1da177e4 3037{
36b50bab 3038 struct tun_file *tfile = file->private_data;
f663706a 3039 struct net *net = sock_net(&tfile->sk);
631ab46b 3040 struct tun_struct *tun;
1da177e4 3041 void __user* argp = (void __user*)arg;
26d31925 3042 unsigned int ifindex, carrier;
1da177e4 3043 struct ifreq ifr;
0625c883
EB
3044 kuid_t owner;
3045 kgid_t group;
33dccbb0 3046 int sndbuf;
d9d52b51 3047 int vnet_hdr_sz;
1cf8e410 3048 int le;
f271b2cc 3049 int ret;
83c1f36f 3050 bool do_notify = false;
1da177e4 3051
f2780d6d
KT
3052 if (cmd == TUNSETIFF || cmd == TUNSETQUEUE ||
3053 (_IOC_TYPE(cmd) == SOCK_IOC_TYPE && cmd != SIOCGSKNS)) {
50857e2a 3054 if (copy_from_user(&ifr, argp, ifreq_len))
1da177e4 3055 return -EFAULT;
8bbb1813 3056 } else {
a117dacd 3057 memset(&ifr, 0, sizeof(ifr));
8bbb1813 3058 }
631ab46b
EB
3059 if (cmd == TUNGETFEATURES) {
3060 /* Currently this just means: "what IFF flags are valid?".
3061 * This is needed because we never checked for invalid flags on
031f5e03
MT
3062 * TUNSETIFF.
3063 */
195624d9
PR
3064 return put_user(IFF_TUN | IFF_TAP | IFF_NO_CARRIER |
3065 TUN_FEATURES, (unsigned int __user*)argp);
f663706a 3066 } else if (cmd == TUNSETQUEUE) {
cde8b15f 3067 return tun_set_queue(file, &ifr);
f663706a
KT
3068 } else if (cmd == SIOCGSKNS) {
3069 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
3070 return -EPERM;
3071 return open_related_ns(&net->ns, get_net_ns);
3072 }
631ab46b 3073
876bfd4d
HX
3074 rtnl_lock();
3075
9484dc74 3076 tun = tun_get(tfile);
0f16bc13
GF
3077 if (cmd == TUNSETIFF) {
3078 ret = -EEXIST;
3079 if (tun)
3080 goto unlock;
3081
1da177e4
LT
3082 ifr.ifr_name[IFNAMSIZ-1] = '\0';
3083
f2780d6d 3084 ret = tun_set_iff(net, file, &ifr);
1da177e4 3085
876bfd4d
HX
3086 if (ret)
3087 goto unlock;
1da177e4 3088
50857e2a 3089 if (copy_to_user(argp, &ifr, ifreq_len))
876bfd4d
HX
3090 ret = -EFAULT;
3091 goto unlock;
1da177e4 3092 }
fb7589a1
PE
3093 if (cmd == TUNSETIFINDEX) {
3094 ret = -EPERM;
3095 if (tun)
3096 goto unlock;
3097
3098 ret = -EFAULT;
3099 if (copy_from_user(&ifindex, argp, sizeof(ifindex)))
3100 goto unlock;
3101
3102 ret = 0;
3103 tfile->ifindex = ifindex;
3104 goto unlock;
3105 }
1da177e4 3106
876bfd4d 3107 ret = -EBADFD;
1da177e4 3108 if (!tun)
876bfd4d 3109 goto unlock;
1da177e4 3110
3424170f 3111 netif_info(tun, drv, tun->dev, "tun_chr_ioctl cmd %u\n", cmd);
1da177e4 3112
0c3e0e3b 3113 net = dev_net(tun->dev);
631ab46b 3114 ret = 0;
1da177e4 3115 switch (cmd) {
e3b99556 3116 case TUNGETIFF:
12132768 3117 tun_get_iff(tun, &ifr);
e3b99556 3118
3d407a80
PE
3119 if (tfile->detached)
3120 ifr.ifr_flags |= IFF_DETACH_QUEUE;
849c9b6f
PE
3121 if (!tfile->socket.sk->sk_filter)
3122 ifr.ifr_flags |= IFF_NOFILTER;
3d407a80 3123
50857e2a 3124 if (copy_to_user(argp, &ifr, ifreq_len))
631ab46b 3125 ret = -EFAULT;
e3b99556
MM
3126 break;
3127
1da177e4
LT
3128 case TUNSETNOCSUM:
3129 /* Disable/Enable checksum */
1da177e4 3130
88255375 3131 /* [unimplemented] */
3424170f
MK
3132 netif_info(tun, drv, tun->dev, "ignored: set checksum %s\n",
3133 arg ? "disabled" : "enabled");
1da177e4
LT
3134 break;
3135
3136 case TUNSETPERSIST:
54f968d6
JW
3137 /* Disable/Enable persist mode. Keep an extra reference to the
3138 * module to prevent the module being unprobed.
3139 */
40630b82
MT
3140 if (arg && !(tun->flags & IFF_PERSIST)) {
3141 tun->flags |= IFF_PERSIST;
54f968d6 3142 __module_get(THIS_MODULE);
83c1f36f 3143 do_notify = true;
dd38bd85 3144 }
40630b82
MT
3145 if (!arg && (tun->flags & IFF_PERSIST)) {
3146 tun->flags &= ~IFF_PERSIST;
54f968d6 3147 module_put(THIS_MODULE);
83c1f36f 3148 do_notify = true;
54f968d6 3149 }
1da177e4 3150
3424170f
MK
3151 netif_info(tun, drv, tun->dev, "persist %s\n",
3152 arg ? "enabled" : "disabled");
1da177e4
LT
3153 break;
3154
3155 case TUNSETOWNER:
3156 /* Set owner of the device */
0625c883
EB
3157 owner = make_kuid(current_user_ns(), arg);
3158 if (!uid_valid(owner)) {
3159 ret = -EINVAL;
3160 break;
3161 }
3162 tun->owner = owner;
83c1f36f 3163 do_notify = true;
3424170f
MK
3164 netif_info(tun, drv, tun->dev, "owner set to %u\n",
3165 from_kuid(&init_user_ns, tun->owner));
1da177e4
LT
3166 break;
3167
8c644623
GG
3168 case TUNSETGROUP:
3169 /* Set group of the device */
0625c883
EB
3170 group = make_kgid(current_user_ns(), arg);
3171 if (!gid_valid(group)) {
3172 ret = -EINVAL;
3173 break;
3174 }
3175 tun->group = group;
83c1f36f 3176 do_notify = true;
3424170f
MK
3177 netif_info(tun, drv, tun->dev, "group set to %u\n",
3178 from_kgid(&init_user_ns, tun->group));
8c644623
GG
3179 break;
3180
ff4cc3ac
MK
3181 case TUNSETLINK:
3182 /* Only allow setting the type when the interface is down */
3183 if (tun->dev->flags & IFF_UP) {
3424170f
MK
3184 netif_info(tun, drv, tun->dev,
3185 "Linktype set failed because interface is up\n");
48abfe05 3186 ret = -EBUSY;
ff4cc3ac 3187 } else {
8e1e33ff
MS
3188 ret = call_netdevice_notifiers(NETDEV_PRE_TYPE_CHANGE,
3189 tun->dev);
3190 ret = notifier_to_errno(ret);
3191 if (ret) {
3192 netif_info(tun, drv, tun->dev,
3193 "Refused to change device type\n");
3194 break;
3195 }
ff4cc3ac 3196 tun->dev->type = (int) arg;
cca8ea3b 3197 tun->dev->addr_len = tun_get_addr_len(tun->dev->type);
3424170f
MK
3198 netif_info(tun, drv, tun->dev, "linktype set to %d\n",
3199 tun->dev->type);
8e1e33ff
MS
3200 call_netdevice_notifiers(NETDEV_POST_TYPE_CHANGE,
3201 tun->dev);
ff4cc3ac 3202 }
631ab46b 3203 break;
ff4cc3ac 3204
1da177e4 3205 case TUNSETDEBUG:
3424170f 3206 tun->msg_enable = (u32)arg;
1da177e4 3207 break;
3424170f 3208
5228ddc9 3209 case TUNSETOFFLOAD:
88255375 3210 ret = set_offload(tun, arg);
631ab46b 3211 break;
5228ddc9 3212
f271b2cc
MK
3213 case TUNSETTXFILTER:
3214 /* Can be set only for TAPs */
631ab46b 3215 ret = -EINVAL;
40630b82 3216 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
631ab46b 3217 break;
c0e5a8c2 3218 ret = update_filter(&tun->txflt, (void __user *)arg);
631ab46b 3219 break;
1da177e4
LT
3220
3221 case SIOCGIFHWADDR:
b595076a 3222 /* Get hw address */
3b23a32a 3223 dev_get_mac_address(&ifr.ifr_hwaddr, net, tun->dev->name);
50857e2a 3224 if (copy_to_user(argp, &ifr, ifreq_len))
631ab46b
EB
3225 ret = -EFAULT;
3226 break;
1da177e4
LT
3227
3228 case SIOCSIFHWADDR:
f271b2cc 3229 /* Set hw address */
3b23a32a 3230 ret = dev_set_mac_address_user(tun->dev, &ifr.ifr_hwaddr, NULL);
631ab46b 3231 break;
33dccbb0
HX
3232
3233 case TUNGETSNDBUF:
54f968d6 3234 sndbuf = tfile->socket.sk->sk_sndbuf;
33dccbb0
HX
3235 if (copy_to_user(argp, &sndbuf, sizeof(sndbuf)))
3236 ret = -EFAULT;
3237 break;
3238
3239 case TUNSETSNDBUF:
3240 if (copy_from_user(&sndbuf, argp, sizeof(sndbuf))) {
3241 ret = -EFAULT;
3242 break;
3243 }
93161922
CG
3244 if (sndbuf <= 0) {
3245 ret = -EINVAL;
3246 break;
3247 }
33dccbb0 3248
c8d68e6b
JW
3249 tun->sndbuf = sndbuf;
3250 tun_set_sndbuf(tun);
33dccbb0
HX
3251 break;
3252
d9d52b51
MT
3253 case TUNGETVNETHDRSZ:
3254 vnet_hdr_sz = tun->vnet_hdr_sz;
3255 if (copy_to_user(argp, &vnet_hdr_sz, sizeof(vnet_hdr_sz)))
3256 ret = -EFAULT;
3257 break;
3258
3259 case TUNSETVNETHDRSZ:
3260 if (copy_from_user(&vnet_hdr_sz, argp, sizeof(vnet_hdr_sz))) {
3261 ret = -EFAULT;
3262 break;
3263 }
3264 if (vnet_hdr_sz < (int)sizeof(struct virtio_net_hdr)) {
3265 ret = -EINVAL;
3266 break;
3267 }
3268
3269 tun->vnet_hdr_sz = vnet_hdr_sz;
3270 break;
3271
1cf8e410
MT
3272 case TUNGETVNETLE:
3273 le = !!(tun->flags & TUN_VNET_LE);
3274 if (put_user(le, (int __user *)argp))
3275 ret = -EFAULT;
3276 break;
3277
3278 case TUNSETVNETLE:
3279 if (get_user(le, (int __user *)argp)) {
3280 ret = -EFAULT;
3281 break;
3282 }
3283 if (le)
3284 tun->flags |= TUN_VNET_LE;
3285 else
3286 tun->flags &= ~TUN_VNET_LE;
3287 break;
3288
8b8e658b
GK
3289 case TUNGETVNETBE:
3290 ret = tun_get_vnet_be(tun, argp);
3291 break;
3292
3293 case TUNSETVNETBE:
3294 ret = tun_set_vnet_be(tun, argp);
3295 break;
3296
99405162
MT
3297 case TUNATTACHFILTER:
3298 /* Can be set only for TAPs */
3299 ret = -EINVAL;
40630b82 3300 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
99405162
MT
3301 break;
3302 ret = -EFAULT;
54f968d6 3303 if (copy_from_user(&tun->fprog, argp, sizeof(tun->fprog)))
99405162
MT
3304 break;
3305
c8d68e6b 3306 ret = tun_attach_filter(tun);
99405162
MT
3307 break;
3308
3309 case TUNDETACHFILTER:
3310 /* Can be set only for TAPs */
3311 ret = -EINVAL;
40630b82 3312 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
99405162 3313 break;
c8d68e6b
JW
3314 ret = 0;
3315 tun_detach_filter(tun, tun->numqueues);
99405162
MT
3316 break;
3317
76975e9c
PE
3318 case TUNGETFILTER:
3319 ret = -EINVAL;
40630b82 3320 if ((tun->flags & TUN_TYPE_MASK) != IFF_TAP)
76975e9c
PE
3321 break;
3322 ret = -EFAULT;
3323 if (copy_to_user(argp, &tun->fprog, sizeof(tun->fprog)))
3324 break;
3325 ret = 0;
3326 break;
3327
96f84061 3328 case TUNSETSTEERINGEBPF:
cd5681d7 3329 ret = tun_set_ebpf(tun, &tun->steering_prog, argp);
96f84061
JW
3330 break;
3331
aff3d70a
JW
3332 case TUNSETFILTEREBPF:
3333 ret = tun_set_ebpf(tun, &tun->filter_prog, argp);
3334 break;
3335
26d31925
ND
3336 case TUNSETCARRIER:
3337 ret = -EFAULT;
3338 if (copy_from_user(&carrier, argp, sizeof(carrier)))
3339 goto unlock;
3340
3341 ret = tun_net_change_carrier(tun->dev, (bool)carrier);
3342 break;
3343
0c3e0e3b
KT
3344 case TUNGETDEVNETNS:
3345 ret = -EPERM;
3346 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
3347 goto unlock;
3348 ret = open_related_ns(&net->ns, get_net_ns);
3349 break;
3350
1da177e4 3351 default:
631ab46b
EB
3352 ret = -EINVAL;
3353 break;
ee289b64 3354 }
1da177e4 3355
83c1f36f
SD
3356 if (do_notify)
3357 netdev_state_change(tun->dev);
3358
876bfd4d
HX
3359unlock:
3360 rtnl_unlock();
3361 if (tun)
3362 tun_put(tun);
631ab46b 3363 return ret;
1da177e4
LT
3364}
3365
50857e2a
AB
3366static long tun_chr_ioctl(struct file *file,
3367 unsigned int cmd, unsigned long arg)
3368{
3369 return __tun_chr_ioctl(file, cmd, arg, sizeof (struct ifreq));
3370}
3371
3372#ifdef CONFIG_COMPAT
3373static long tun_chr_compat_ioctl(struct file *file,
3374 unsigned int cmd, unsigned long arg)
3375{
3376 switch (cmd) {
3377 case TUNSETIFF:
3378 case TUNGETIFF:
3379 case TUNSETTXFILTER:
3380 case TUNGETSNDBUF:
3381 case TUNSETSNDBUF:
3382 case SIOCGIFHWADDR:
3383 case SIOCSIFHWADDR:
3384 arg = (unsigned long)compat_ptr(arg);
3385 break;
3386 default:
3387 arg = (compat_ulong_t)arg;
3388 break;
3389 }
3390
3391 /*
3392 * compat_ifreq is shorter than ifreq, so we must not access beyond
3393 * the end of that structure. All fields that are used in this
3394 * driver are compatible though, we don't need to convert the
3395 * contents.
3396 */
3397 return __tun_chr_ioctl(file, cmd, arg, sizeof(struct compat_ifreq));
3398}
3399#endif /* CONFIG_COMPAT */
3400
1da177e4
LT
3401static int tun_chr_fasync(int fd, struct file *file, int on)
3402{
54f968d6 3403 struct tun_file *tfile = file->private_data;
1da177e4
LT
3404 int ret;
3405
54f968d6 3406 if ((ret = fasync_helper(fd, file, on, &tfile->fasync)) < 0)
9d319522 3407 goto out;
6aa20a22 3408
1da177e4 3409 if (on) {
01919134 3410 __f_setown(file, task_pid(current), PIDTYPE_TGID, 0);
54f968d6 3411 tfile->flags |= TUN_FASYNC;
6aa20a22 3412 } else
54f968d6 3413 tfile->flags &= ~TUN_FASYNC;
9d319522
JC
3414 ret = 0;
3415out:
9d319522 3416 return ret;
1da177e4
LT
3417}
3418
3419static int tun_chr_open(struct inode *inode, struct file * file)
3420{
140e807d 3421 struct net *net = current->nsproxy->net_ns;
631ab46b 3422 struct tun_file *tfile;
deed49fb 3423
140e807d 3424 tfile = (struct tun_file *)sk_alloc(net, AF_UNSPEC, GFP_KERNEL,
11aa9c28 3425 &tun_proto, 0);
631ab46b
EB
3426 if (!tfile)
3427 return -ENOMEM;
b196d88a
JW
3428 if (ptr_ring_init(&tfile->tx_ring, 0, GFP_KERNEL)) {
3429 sk_free(&tfile->sk);
3430 return -ENOMEM;
3431 }
3432
c7256f57 3433 mutex_init(&tfile->napi_mutex);
c956674b 3434 RCU_INIT_POINTER(tfile->tun, NULL);
54f968d6 3435 tfile->flags = 0;
fb7589a1 3436 tfile->ifindex = 0;
54f968d6 3437
333f7909 3438 init_waitqueue_head(&tfile->socket.wq.wait);
54f968d6
JW
3439
3440 tfile->socket.file = file;
3441 tfile->socket.ops = &tun_socket_ops;
3442
3443 sock_init_data(&tfile->socket, &tfile->sk);
54f968d6
JW
3444
3445 tfile->sk.sk_write_space = tun_sock_write_space;
3446 tfile->sk.sk_sndbuf = INT_MAX;
3447
631ab46b 3448 file->private_data = tfile;
4008e97f 3449 INIT_LIST_HEAD(&tfile->next);
54f968d6 3450
19a6afb2
JW
3451 sock_set_flag(&tfile->sk, SOCK_ZEROCOPY);
3452
1da177e4
LT
3453 return 0;
3454}
3455
3456static int tun_chr_close(struct inode *inode, struct file *file)
3457{
631ab46b 3458 struct tun_file *tfile = file->private_data;
1da177e4 3459
c8d68e6b 3460 tun_detach(tfile, true);
1da177e4
LT
3461
3462 return 0;
3463}
3464
93e14b6d 3465#ifdef CONFIG_PROC_FS
9484dc74 3466static void tun_chr_show_fdinfo(struct seq_file *m, struct file *file)
93e14b6d 3467{
9484dc74 3468 struct tun_file *tfile = file->private_data;
93e14b6d
MY
3469 struct tun_struct *tun;
3470 struct ifreq ifr;
3471
3472 memset(&ifr, 0, sizeof(ifr));
3473
3474 rtnl_lock();
9484dc74 3475 tun = tun_get(tfile);
93e14b6d 3476 if (tun)
12132768 3477 tun_get_iff(tun, &ifr);
93e14b6d
MY
3478 rtnl_unlock();
3479
3480 if (tun)
3481 tun_put(tun);
3482
a3816ab0 3483 seq_printf(m, "iff:\t%s\n", ifr.ifr_name);
93e14b6d
MY
3484}
3485#endif
3486
d54b1fdb 3487static const struct file_operations tun_fops = {
6aa20a22 3488 .owner = THIS_MODULE,
1da177e4 3489 .llseek = no_llseek,
9b067034 3490 .read_iter = tun_chr_read_iter,
f5ff53b4 3491 .write_iter = tun_chr_write_iter,
1da177e4 3492 .poll = tun_chr_poll,
50857e2a
AB
3493 .unlocked_ioctl = tun_chr_ioctl,
3494#ifdef CONFIG_COMPAT
3495 .compat_ioctl = tun_chr_compat_ioctl,
3496#endif
1da177e4
LT
3497 .open = tun_chr_open,
3498 .release = tun_chr_close,
93e14b6d
MY
3499 .fasync = tun_chr_fasync,
3500#ifdef CONFIG_PROC_FS
3501 .show_fdinfo = tun_chr_show_fdinfo,
3502#endif
1da177e4
LT
3503};
3504
3505static struct miscdevice tun_miscdev = {
3506 .minor = TUN_MINOR,
3507 .name = "tun",
e454cea2 3508 .nodename = "net/tun",
1da177e4 3509 .fops = &tun_fops,
1da177e4
LT
3510};
3511
3512/* ethtool interface */
3513
4e24f2dd
CW
3514static void tun_default_link_ksettings(struct net_device *dev,
3515 struct ethtool_link_ksettings *cmd)
29ccc49d
PR
3516{
3517 ethtool_link_ksettings_zero_link_mode(cmd, supported);
3518 ethtool_link_ksettings_zero_link_mode(cmd, advertising);
3519 cmd->base.speed = SPEED_10;
3520 cmd->base.duplex = DUPLEX_FULL;
3521 cmd->base.port = PORT_TP;
3522 cmd->base.phy_address = 0;
3523 cmd->base.autoneg = AUTONEG_DISABLE;
4e24f2dd
CW
3524}
3525
3526static int tun_get_link_ksettings(struct net_device *dev,
3527 struct ethtool_link_ksettings *cmd)
3528{
3529 struct tun_struct *tun = netdev_priv(dev);
3530
3531 memcpy(cmd, &tun->link_ksettings, sizeof(*cmd));
3532 return 0;
3533}
3534
3535static int tun_set_link_ksettings(struct net_device *dev,
3536 const struct ethtool_link_ksettings *cmd)
3537{
3538 struct tun_struct *tun = netdev_priv(dev);
3539
3540 memcpy(&tun->link_ksettings, cmd, sizeof(*cmd));
1da177e4
LT
3541 return 0;
3542}
3543
3544static void tun_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
3545{
3546 struct tun_struct *tun = netdev_priv(dev);
3547
fb3ceec1
WS
3548 strscpy(info->driver, DRV_NAME, sizeof(info->driver));
3549 strscpy(info->version, DRV_VERSION, sizeof(info->version));
1da177e4
LT
3550
3551 switch (tun->flags & TUN_TYPE_MASK) {
40630b82 3552 case IFF_TUN:
fb3ceec1 3553 strscpy(info->bus_info, "tun", sizeof(info->bus_info));
1da177e4 3554 break;
40630b82 3555 case IFF_TAP:
fb3ceec1 3556 strscpy(info->bus_info, "tap", sizeof(info->bus_info));
1da177e4
LT
3557 break;
3558 }
3559}
3560
3561static u32 tun_get_msglevel(struct net_device *dev)
3562{
1da177e4 3563 struct tun_struct *tun = netdev_priv(dev);
3424170f
MK
3564
3565 return tun->msg_enable;
1da177e4
LT
3566}
3567
3568static void tun_set_msglevel(struct net_device *dev, u32 value)
3569{
1da177e4 3570 struct tun_struct *tun = netdev_priv(dev);
3424170f
MK
3571
3572 tun->msg_enable = value;
1da177e4
LT
3573}
3574
5503fcec 3575static int tun_get_coalesce(struct net_device *dev,
f3ccfda1
YM
3576 struct ethtool_coalesce *ec,
3577 struct kernel_ethtool_coalesce *kernel_coal,
3578 struct netlink_ext_ack *extack)
5503fcec
JW
3579{
3580 struct tun_struct *tun = netdev_priv(dev);
3581
3582 ec->rx_max_coalesced_frames = tun->rx_batched;
3583
3584 return 0;
3585}
3586
3587static int tun_set_coalesce(struct net_device *dev,
f3ccfda1
YM
3588 struct ethtool_coalesce *ec,
3589 struct kernel_ethtool_coalesce *kernel_coal,
3590 struct netlink_ext_ack *extack)
5503fcec
JW
3591{
3592 struct tun_struct *tun = netdev_priv(dev);
3593
3594 if (ec->rx_max_coalesced_frames > NAPI_POLL_WEIGHT)
3595 tun->rx_batched = NAPI_POLL_WEIGHT;
3596 else
3597 tun->rx_batched = ec->rx_max_coalesced_frames;
3598
3599 return 0;
3600}
3601
7282d491 3602static const struct ethtool_ops tun_ethtool_ops = {
e5ad00b3 3603 .supported_coalesce_params = ETHTOOL_COALESCE_RX_MAX_FRAMES,
1da177e4
LT
3604 .get_drvinfo = tun_get_drvinfo,
3605 .get_msglevel = tun_get_msglevel,
3606 .set_msglevel = tun_set_msglevel,
bee31369 3607 .get_link = ethtool_op_get_link,
eda29772 3608 .get_ts_info = ethtool_op_get_ts_info,
5503fcec
JW
3609 .get_coalesce = tun_get_coalesce,
3610 .set_coalesce = tun_set_coalesce,
29ccc49d 3611 .get_link_ksettings = tun_get_link_ksettings,
4e24f2dd 3612 .set_link_ksettings = tun_set_link_ksettings,
1da177e4
LT
3613};
3614
1576d986
JW
3615static int tun_queue_resize(struct tun_struct *tun)
3616{
3617 struct net_device *dev = tun->dev;
3618 struct tun_file *tfile;
5990a305 3619 struct ptr_ring **rings;
1576d986
JW
3620 int n = tun->numqueues + tun->numdisabled;
3621 int ret, i;
3622
5990a305
JW
3623 rings = kmalloc_array(n, sizeof(*rings), GFP_KERNEL);
3624 if (!rings)
1576d986
JW
3625 return -ENOMEM;
3626
3627 for (i = 0; i < tun->numqueues; i++) {
3628 tfile = rtnl_dereference(tun->tfiles[i]);
5990a305 3629 rings[i] = &tfile->tx_ring;
1576d986
JW
3630 }
3631 list_for_each_entry(tfile, &tun->disabled, next)
5990a305 3632 rings[i++] = &tfile->tx_ring;
1576d986 3633
5990a305
JW
3634 ret = ptr_ring_resize_multiple(rings, n,
3635 dev->tx_queue_len, GFP_KERNEL,
fc72d1d5 3636 tun_ptr_free);
1576d986 3637
5990a305 3638 kfree(rings);
1576d986
JW
3639 return ret;
3640}
3641
3642static int tun_device_event(struct notifier_block *unused,
3643 unsigned long event, void *ptr)
3644{
3645 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
3646 struct tun_struct *tun = netdev_priv(dev);
72b319dc 3647 int i;
1576d986 3648
86dfb4ac
CG
3649 if (dev->rtnl_link_ops != &tun_link_ops)
3650 return NOTIFY_DONE;
3651
1576d986
JW
3652 switch (event) {
3653 case NETDEV_CHANGE_TX_QUEUE_LEN:
3654 if (tun_queue_resize(tun))
3655 return NOTIFY_BAD;
3656 break;
72b319dc
FL
3657 case NETDEV_UP:
3658 for (i = 0; i < tun->numqueues; i++) {
3659 struct tun_file *tfile;
3660
3661 tfile = rtnl_dereference(tun->tfiles[i]);
3662 tfile->socket.sk->sk_write_space(tfile->socket.sk);
3663 }
3664 break;
1576d986
JW
3665 default:
3666 break;
3667 }
3668
3669 return NOTIFY_DONE;
3670}
3671
3672static struct notifier_block tun_notifier_block __read_mostly = {
3673 .notifier_call = tun_device_event,
3674};
79d17604 3675
1da177e4
LT
3676static int __init tun_init(void)
3677{
3678 int ret = 0;
3679
6b8a66ee 3680 pr_info("%s, %s\n", DRV_DESCRIPTION, DRV_VERSION);
1da177e4 3681
f019a7a5 3682 ret = rtnl_link_register(&tun_link_ops);
79d17604 3683 if (ret) {
6b8a66ee 3684 pr_err("Can't register link_ops\n");
f019a7a5 3685 goto err_linkops;
79d17604
PE
3686 }
3687
1da177e4 3688 ret = misc_register(&tun_miscdev);
79d17604 3689 if (ret) {
6b8a66ee 3690 pr_err("Can't register misc device %d\n", TUN_MINOR);
79d17604
PE
3691 goto err_misc;
3692 }
1576d986 3693
5edfbd3c
TZ
3694 ret = register_netdevice_notifier(&tun_notifier_block);
3695 if (ret) {
3696 pr_err("Can't register netdevice notifier\n");
3697 goto err_notifier;
3698 }
3699
f019a7a5 3700 return 0;
5edfbd3c
TZ
3701
3702err_notifier:
3703 misc_deregister(&tun_miscdev);
79d17604 3704err_misc:
f019a7a5
EB
3705 rtnl_link_unregister(&tun_link_ops);
3706err_linkops:
1da177e4
LT
3707 return ret;
3708}
3709
3710static void tun_cleanup(void)
3711{
6aa20a22 3712 misc_deregister(&tun_miscdev);
f019a7a5 3713 rtnl_link_unregister(&tun_link_ops);
1576d986 3714 unregister_netdevice_notifier(&tun_notifier_block);
1da177e4
LT
3715}
3716
05c2828c
MT
3717/* Get an underlying socket object from tun file. Returns error unless file is
3718 * attached to a device. The returned object works like a packet socket, it
3719 * can be used for sock_sendmsg/sock_recvmsg. The caller is responsible for
3720 * holding a reference to the file for as long as the socket is in use. */
3721struct socket *tun_get_socket(struct file *file)
3722{
6e914fc7 3723 struct tun_file *tfile;
05c2828c
MT
3724 if (file->f_op != &tun_fops)
3725 return ERR_PTR(-EINVAL);
6e914fc7
JW
3726 tfile = file->private_data;
3727 if (!tfile)
05c2828c 3728 return ERR_PTR(-EBADFD);
54f968d6 3729 return &tfile->socket;
05c2828c
MT
3730}
3731EXPORT_SYMBOL_GPL(tun_get_socket);
3732
5990a305 3733struct ptr_ring *tun_get_tx_ring(struct file *file)
83339c6b
JW
3734{
3735 struct tun_file *tfile;
3736
3737 if (file->f_op != &tun_fops)
3738 return ERR_PTR(-EINVAL);
3739 tfile = file->private_data;
3740 if (!tfile)
3741 return ERR_PTR(-EBADFD);
5990a305 3742 return &tfile->tx_ring;
83339c6b 3743}
5990a305 3744EXPORT_SYMBOL_GPL(tun_get_tx_ring);
83339c6b 3745
1da177e4
LT
3746module_init(tun_init);
3747module_exit(tun_cleanup);
3748MODULE_DESCRIPTION(DRV_DESCRIPTION);
3749MODULE_AUTHOR(DRV_COPYRIGHT);
3750MODULE_LICENSE("GPL");
3751MODULE_ALIAS_MISCDEV(TUN_MINOR);
578454ff 3752MODULE_ALIAS("devname:net/tun");