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