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