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