sys/net/vnet.c

   1 /*-
   2  * Copyright (c) 2004-2009 University of Zagreb
   3  * Copyright (c) 2006-2009 FreeBSD Foundation
   4  * All rights reserved.
   5  *
   6  * This software was developed by the University of Zagreb and the
   7  * FreeBSD Foundation under sponsorship by the Stichting NLnet and the
   8  * FreeBSD Foundation.
   9  *
  10  * Copyright (c) 2009 Jeffrey Roberson <jeff@freebsd.org>
  11  * Copyright (c) 2009 Robert N. M. Watson
  12  * All rights reserved.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions
  16  * are met:
  17  * 1. Redistributions of source code must retain the above copyright
  18  *    notice, this list of conditions and the following disclaimer.
  19  * 2. Redistributions in binary form must reproduce the above copyright
  20  *    notice, this list of conditions and the following disclaimer in the
  21  *    documentation and/or other materials provided with the distribution.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 #include <sys/cdefs.h>
  37 __FBSDID("$FreeBSD$");
  38
  39 #include "opt_ddb.h"
  40 #include "opt_kdb.h"
  41
  42 #include <sys/param.h>
  43 #include <sys/kdb.h>
  44 #include <sys/kernel.h>
  45 #include <sys/jail.h>
  46 #include <sys/sdt.h>
  47 #include <sys/systm.h>
  48 #include <sys/sysctl.h>
  49 #include <sys/eventhandler.h>
  50 #include <sys/lock.h>
  51 #include <sys/malloc.h>
  52 #include <sys/proc.h>
  53 #include <sys/socket.h>
  54 #include <sys/sx.h>
  55 #include <sys/sysctl.h>
  56
  57 #include <machine/stdarg.h>
  58
  59 #ifdef DDB
  60 #include <ddb/ddb.h>
  61 #include <ddb/db_sym.h>
  62 #endif
  63
  64 #include <net/if.h>
  65 #include <net/if_var.h>
  66 #include <net/vnet.h>
  67
  68 /*-
  69  * This file implements core functions for virtual network stacks:
  70  *
  71  * - Virtual network stack management functions.
  72  *
  73  * - Virtual network stack memory allocator, which virtualizes global
  74  *   variables in the network stack
  75  *
  76  * - Virtualized SYSINIT's/SYSUNINIT's, which allow network stack subsystems
  77  *   to register startup/shutdown events to be run for each virtual network
  78  *   stack instance.
  79  */
  80
  81 FEATURE(vimage, "VIMAGE kernel virtualization");
  82
  83 static MALLOC_DEFINE(M_VNET, "vnet", "network stack control block");
  84
  85 /*
  86  * The virtual network stack list has two read-write locks, one sleepable and
  87  * the other not, so that the list can be stablized and walked in a variety
  88  * of network stack contexts.  Both must be acquired exclusively to modify
  89  * the list, but a read lock of either lock is sufficient to walk the list.
  90  */
  91 struct rwlock           vnet_rwlock;
  92 struct sx               vnet_sxlock;
  93
  94 #define VNET_LIST_WLOCK() do {                                          \
  95         sx_xlock(&vnet_sxlock);                                         \
  96         rw_wlock(&vnet_rwlock);                                         \
  97 } while (0)
  98
  99 #define VNET_LIST_WUNLOCK() do {                                        \
 100         rw_wunlock(&vnet_rwlock);                                       \
 101         sx_xunlock(&vnet_sxlock);                                       \
 102 } while (0)
 103
 104 struct vnet_list_head vnet_head;
 105 struct vnet *vnet0;
 106
 107 /*
 108  * The virtual network stack allocator provides storage for virtualized
 109  * global variables.  These variables are defined/declared using the
 110  * VNET_DEFINE()/VNET_DECLARE() macros, which place them in the 'set_vnet'
 111  * linker set.  The details of the implementation are somewhat subtle, but
 112  * allow the majority of most network subsystems to maintain
 113  * virtualization-agnostic.
 114  *
 115  * The virtual network stack allocator handles variables in the base kernel
 116  * vs. modules in similar but different ways.  In both cases, virtualized
 117  * global variables are marked as such by being declared to be part of the
 118  * vnet linker set.  These "master" copies of global variables serve two
 119  * functions:
 120  *
 121  * (1) They contain static initialization or "default" values for global
 122  *     variables which will be propagated to each virtual network stack
 123  *     instance when created.  As with normal global variables, they default
 124  *     to zero-filled.
 125  *
 126  * (2) They act as unique global names by which the variable can be referred
 127  *     to, regardless of network stack instance.  The single global symbol
 128  *     will be used to calculate the location of a per-virtual instance
 129  *     variable at run-time.
 130  *
 131  * Each virtual network stack instance has a complete copy of each
 132  * virtualized global variable, stored in a malloc'd block of memory
 133  * referred to by vnet->vnet_data_mem.  Critical to the design is that each
 134  * per-instance memory block is laid out identically to the master block so
 135  * that the offset of each global variable is the same across all blocks.  To
 136  * optimize run-time access, a precalculated 'base' address,
 137  * vnet->vnet_data_base, is stored in each vnet, and is the amount that can
 138  * be added to the address of a 'master' instance of a variable to get to the
 139  * per-vnet instance.
 140  *
 141  * Virtualized global variables are handled in a similar manner, but as each
 142  * module has its own 'set_vnet' linker set, and we want to keep all
 143  * virtualized globals togther, we reserve space in the kernel's linker set
 144  * for potential module variables using a per-vnet character array,
 145  * 'modspace'.  The virtual network stack allocator maintains a free list to
 146  * track what space in the array is free (all, initially) and as modules are
 147  * linked, allocates portions of the space to specific globals.  The kernel
 148  * module linker queries the virtual network stack allocator and will
 149  * bind references of the global to the location during linking.  It also
 150  * calls into the virtual network stack allocator, once the memory is
 151  * initialized, in order to propagate the new static initializations to all
 152  * existing virtual network stack instances so that the soon-to-be executing
 153  * module will find every network stack instance with proper default values.
 154  */
 155
 156 /*
 157  * Number of bytes of data in the 'set_vnet' linker set, and hence the total
 158  * size of all kernel virtualized global variables, and the malloc(9) type
 159  * that will be used to allocate it.
 160  */
 161 #define VNET_BYTES      (VNET_STOP - VNET_START)
 162
 163 static MALLOC_DEFINE(M_VNET_DATA, "vnet_data", "VNET data");
 164
 165 /*
 166  * VNET_MODMIN is the minimum number of bytes we will reserve for the sum of
 167  * global variables across all loaded modules.  As this actually sizes an
 168  * array declared as a virtualized global variable in the kernel itself, and
 169  * we want the virtualized global variable space to be page-sized, we may
 170  * have more space than that in practice.
 171  */
 172 #define VNET_MODMIN     8192
 173 #define VNET_SIZE       roundup2(VNET_BYTES, PAGE_SIZE)
 174
 175 /*
 176  * Space to store virtualized global variables from loadable kernel modules,
 177  * and the free list to manage it.
 178  */
 179 static VNET_DEFINE(char, modspace[VNET_MODMIN]);
 180
 181 /*
 182  * Global lists of subsystem constructor and destructors for vnets.  They are
 183  * registered via VNET_SYSINIT() and VNET_SYSUNINIT().  Both lists are
 184  * protected by the vnet_sysinit_sxlock global lock.
 185  */
 186 static TAILQ_HEAD(vnet_sysinit_head, vnet_sysinit) vnet_constructors =
 187         TAILQ_HEAD_INITIALIZER(vnet_constructors);
 188 static TAILQ_HEAD(vnet_sysuninit_head, vnet_sysinit) vnet_destructors =
 189         TAILQ_HEAD_INITIALIZER(vnet_destructors);
 190
 191 struct sx               vnet_sysinit_sxlock;
 192
 193 #define VNET_SYSINIT_WLOCK()    sx_xlock(&vnet_sysinit_sxlock);
 194 #define VNET_SYSINIT_WUNLOCK()  sx_xunlock(&vnet_sysinit_sxlock);
 195 #define VNET_SYSINIT_RLOCK()    sx_slock(&vnet_sysinit_sxlock);
 196 #define VNET_SYSINIT_RUNLOCK()  sx_sunlock(&vnet_sysinit_sxlock);
 197
 198 struct vnet_data_free {
 199         uintptr_t       vnd_start;
 200         int             vnd_len;
 201         TAILQ_ENTRY(vnet_data_free) vnd_link;
 202 };
 203
 204 static MALLOC_DEFINE(M_VNET_DATA_FREE, "vnet_data_free",
 205     "VNET resource accounting");
 206 static TAILQ_HEAD(, vnet_data_free) vnet_data_free_head =
 207             TAILQ_HEAD_INITIALIZER(vnet_data_free_head);
 208 static struct sx vnet_data_free_lock;
 209
 210 SDT_PROVIDER_DEFINE(vnet);
 211 SDT_PROBE_DEFINE1(vnet, functions, vnet_alloc, entry, "int");
 212 SDT_PROBE_DEFINE2(vnet, functions, vnet_alloc, alloc, "int",
 213     "struct vnet *");
 214 SDT_PROBE_DEFINE2(vnet, functions, vnet_alloc, return,
 215     "int", "struct vnet *");
 216 SDT_PROBE_DEFINE2(vnet, functions, vnet_destroy, entry,
 217     "int", "struct vnet *");
 218 SDT_PROBE_DEFINE1(vnet, functions, vnet_destroy, return,
 219     "int");
 220
 221 #ifdef DDB
 222 static void db_show_vnet_print_vs(struct vnet_sysinit *, int);
 223 #endif
 224
 225 /*
 226  * Allocate a virtual network stack.
 227  */
 228 struct vnet *
 229 vnet_alloc(void)
 230 {
 231         struct vnet *vnet;
 232
 233         SDT_PROBE1(vnet, functions, vnet_alloc, entry, __LINE__);
 234         vnet = malloc(sizeof(struct vnet), M_VNET, M_WAITOK | M_ZERO);
 235         vnet->vnet_magic_n = VNET_MAGIC_N;
 236         SDT_PROBE2(vnet, functions, vnet_alloc, alloc, __LINE__, vnet);
 237
 238         /*
 239          * Allocate storage for virtualized global variables and copy in
 240          * initial values form our 'master' copy.
 241          */
 242         vnet->vnet_data_mem = malloc(VNET_SIZE, M_VNET_DATA, M_WAITOK);
 243         memcpy(vnet->vnet_data_mem, (void *)VNET_START, VNET_BYTES);
 244
 245         /*
 246          * All use of vnet-specific data will immediately subtract VNET_START
 247          * from the base memory pointer, so pre-calculate that now to avoid
 248          * it on each use.
 249          */
 250         vnet->vnet_data_base = (uintptr_t)vnet->vnet_data_mem - VNET_START;
 251
 252         /* Initialize / attach vnet module instances. */
 253         CURVNET_SET_QUIET(vnet);
 254         vnet_sysinit();
 255         CURVNET_RESTORE();
 256
 257         VNET_LIST_WLOCK();
 258         LIST_INSERT_HEAD(&vnet_head, vnet, vnet_le);
 259         VNET_LIST_WUNLOCK();
 260
 261         SDT_PROBE2(vnet, functions, vnet_alloc, return, __LINE__, vnet);
 262         return (vnet);
 263 }
 264
 265 /*
 266  * Destroy a virtual network stack.
 267  */
 268 void
 269 vnet_destroy(struct vnet *vnet)
 270 {
 271         struct ifnet *ifp, *nifp;
 272
 273         SDT_PROBE2(vnet, functions, vnet_destroy, entry, __LINE__, vnet);
 274         KASSERT(vnet->vnet_sockcnt == 0,
 275             ("%s: vnet still has sockets", __func__));
 276
 277         VNET_LIST_WLOCK();
 278         LIST_REMOVE(vnet, vnet_le);
 279         VNET_LIST_WUNLOCK();
 280
 281         CURVNET_SET_QUIET(vnet);
 282
 283         /* Return all inherited interfaces to their parent vnets. */
 284         TAILQ_FOREACH_SAFE(ifp, &V_ifnet, if_link, nifp) {
 285                 if (ifp->if_home_vnet != ifp->if_vnet)
 286                         if_vmove(ifp, ifp->if_home_vnet);
 287         }
 288
 289         vnet_sysuninit();
 290         CURVNET_RESTORE();
 291
 292         /*
 293          * Release storage for the virtual network stack instance.
 294          */
 295         free(vnet->vnet_data_mem, M_VNET_DATA);
 296         vnet->vnet_data_mem = NULL;
 297         vnet->vnet_data_base = 0;
 298         vnet->vnet_magic_n = 0xdeadbeef;
 299         free(vnet, M_VNET);
 300         SDT_PROBE1(vnet, functions, vnet_destroy, return, __LINE__);
 301 }
 302
 303 /*
 304  * Boot time initialization and allocation of virtual network stacks.
 305  */
 306 static void
 307 vnet_init_prelink(void *arg __unused)
 308 {
 309
 310         rw_init(&vnet_rwlock, "vnet_rwlock");
 311         sx_init(&vnet_sxlock, "vnet_sxlock");
 312         sx_init(&vnet_sysinit_sxlock, "vnet_sysinit_sxlock");
 313         LIST_INIT(&vnet_head);
 314 }
 315 SYSINIT(vnet_init_prelink, SI_SUB_VNET_PRELINK, SI_ORDER_FIRST,
 316     vnet_init_prelink, NULL);
 317
 318 static void
 319 vnet0_init(void *arg __unused)
 320 {
 321
 322         /* Warn people before take off - in case we crash early. */
 323         printf("WARNING: VIMAGE (virtualized network stack) is a highly "
 324             "experimental feature.\n");
 325
 326         /*
 327          * We MUST clear curvnet in vi_init_done() before going SMP,
 328          * otherwise CURVNET_SET() macros would scream about unnecessary
 329          * curvnet recursions.
 330          */
 331         curvnet = prison0.pr_vnet = vnet0 = vnet_alloc();
 332 }
 333 SYSINIT(vnet0_init, SI_SUB_VNET, SI_ORDER_FIRST, vnet0_init, NULL);
 334
 335 static void
 336 vnet_init_done(void *unused __unused)
 337 {
 338
 339         curvnet = NULL;
 340 }
 341
 342 SYSINIT(vnet_init_done, SI_SUB_VNET_DONE, SI_ORDER_FIRST, vnet_init_done,
 343     NULL);
 344
 345 /*
 346  * Once on boot, initialize the modspace freelist to entirely cover modspace.
 347  */
 348 static void
 349 vnet_data_startup(void *dummy __unused)
 350 {
 351         struct vnet_data_free *df;
 352
 353         df = malloc(sizeof(*df), M_VNET_DATA_FREE, M_WAITOK | M_ZERO);
 354         df->vnd_start = (uintptr_t)&VNET_NAME(modspace);
 355         df->vnd_len = VNET_MODMIN;
 356         TAILQ_INSERT_HEAD(&vnet_data_free_head, df, vnd_link);
 357         sx_init(&vnet_data_free_lock, "vnet_data alloc lock");
 358 }
 359 SYSINIT(vnet_data, SI_SUB_KLD, SI_ORDER_FIRST, vnet_data_startup, 0);
 360
 361 /* Dummy VNET_SYSINIT to make sure we always reach the final end state. */
 362 static void
 363 vnet_sysinit_done(void *unused __unused)
 364 {
 365
 366         return;
 367 }
 368 VNET_SYSINIT(vnet_sysinit_done, SI_SUB_VNET_DONE, SI_ORDER_ANY,
 369     vnet_sysinit_done, NULL);
 370
 371 /*
 372  * When a module is loaded and requires storage for a virtualized global
 373  * variable, allocate space from the modspace free list.  This interface
 374  * should be used only by the kernel linker.
 375  */
 376 void *
 377 vnet_data_alloc(int size)
 378 {
 379         struct vnet_data_free *df;
 380         void *s;
 381
 382         s = NULL;
 383         size = roundup2(size, sizeof(void *));
 384         sx_xlock(&vnet_data_free_lock);
 385         TAILQ_FOREACH(df, &vnet_data_free_head, vnd_link) {
 386                 if (df->vnd_len < size)
 387                         continue;
 388                 if (df->vnd_len == size) {
 389                         s = (void *)df->vnd_start;
 390                         TAILQ_REMOVE(&vnet_data_free_head, df, vnd_link);
 391                         free(df, M_VNET_DATA_FREE);
 392                         break;
 393                 }
 394                 s = (void *)df->vnd_start;
 395                 df->vnd_len -= size;
 396                 df->vnd_start = df->vnd_start + size;
 397                 break;
 398         }
 399         sx_xunlock(&vnet_data_free_lock);
 400
 401         return (s);
 402 }
 403
 404 /*
 405  * Free space for a virtualized global variable on module unload.
 406  */
 407 void
 408 vnet_data_free(void *start_arg, int size)
 409 {
 410         struct vnet_data_free *df;
 411         struct vnet_data_free *dn;
 412         uintptr_t start;
 413         uintptr_t end;
 414
 415         size = roundup2(size, sizeof(void *));
 416         start = (uintptr_t)start_arg;
 417         end = start + size;
 418         /*
 419          * Free a region of space and merge it with as many neighbors as
 420          * possible.  Keeping the list sorted simplifies this operation.
 421          */
 422         sx_xlock(&vnet_data_free_lock);
 423         TAILQ_FOREACH(df, &vnet_data_free_head, vnd_link) {
 424                 if (df->vnd_start > end)
 425                         break;
 426                 /*
 427                  * If we expand at the end of an entry we may have to merge
 428                  * it with the one following it as well.
 429                  */
 430                 if (df->vnd_start + df->vnd_len == start) {
 431                         df->vnd_len += size;
 432                         dn = TAILQ_NEXT(df, vnd_link);
 433                         if (df->vnd_start + df->vnd_len == dn->vnd_start) {
 434                                 df->vnd_len += dn->vnd_len;
 435                                 TAILQ_REMOVE(&vnet_data_free_head, dn,
 436                                     vnd_link);
 437                                 free(dn, M_VNET_DATA_FREE);
 438                         }
 439                         sx_xunlock(&vnet_data_free_lock);
 440                         return;
 441                 }
 442                 if (df->vnd_start == end) {
 443                         df->vnd_start = start;
 444                         df->vnd_len += size;
 445                         sx_xunlock(&vnet_data_free_lock);
 446                         return;
 447                 }
 448         }
 449         dn = malloc(sizeof(*df), M_VNET_DATA_FREE, M_WAITOK | M_ZERO);
 450         dn->vnd_start = start;
 451         dn->vnd_len = size;
 452         if (df)
 453                 TAILQ_INSERT_BEFORE(df, dn, vnd_link);
 454         else
 455                 TAILQ_INSERT_TAIL(&vnet_data_free_head, dn, vnd_link);
 456         sx_xunlock(&vnet_data_free_lock);
 457 }
 458
 459 /*
 460  * When a new virtualized global variable has been allocated, propagate its
 461  * initial value to each already-allocated virtual network stack instance.
 462  */
 463 void
 464 vnet_data_copy(void *start, int size)
 465 {
 466         struct vnet *vnet;
 467
 468         VNET_LIST_RLOCK();
 469         LIST_FOREACH(vnet, &vnet_head, vnet_le)
 470                 memcpy((void *)((uintptr_t)vnet->vnet_data_base +
 471                     (uintptr_t)start), start, size);
 472         VNET_LIST_RUNLOCK();
 473 }
 474
 475 /*
 476  * Support for special SYSINIT handlers registered via VNET_SYSINIT()
 477  * and VNET_SYSUNINIT().
 478  */
 479 void
 480 vnet_register_sysinit(void *arg)
 481 {
 482         struct vnet_sysinit *vs, *vs2;
 483         struct vnet *vnet;
 484
 485         vs = arg;
 486         KASSERT(vs->subsystem > SI_SUB_VNET, ("vnet sysinit too early"));
 487
 488         /* Add the constructor to the global list of vnet constructors. */
 489         VNET_SYSINIT_WLOCK();
 490         TAILQ_FOREACH(vs2, &vnet_constructors, link) {
 491                 if (vs2->subsystem > vs->subsystem)
 492                         break;
 493                 if (vs2->subsystem == vs->subsystem && vs2->order > vs->order)
 494                         break;
 495         }
 496         if (vs2 != NULL)
 497                 TAILQ_INSERT_BEFORE(vs2, vs, link);
 498         else
 499                 TAILQ_INSERT_TAIL(&vnet_constructors, vs, link);
 500
 501         /*
 502          * Invoke the constructor on all the existing vnets when it is
 503          * registered.
 504          */
 505         VNET_FOREACH(vnet) {
 506                 CURVNET_SET_QUIET(vnet);
 507                 vs->func(vs->arg);
 508                 CURVNET_RESTORE();
 509         }
 510         VNET_SYSINIT_WUNLOCK();
 511 }
 512
 513 void
 514 vnet_deregister_sysinit(void *arg)
 515 {
 516         struct vnet_sysinit *vs;
 517
 518         vs = arg;
 519
 520         /* Remove the constructor from the global list of vnet constructors. */
 521         VNET_SYSINIT_WLOCK();
 522         TAILQ_REMOVE(&vnet_constructors, vs, link);
 523         VNET_SYSINIT_WUNLOCK();
 524 }
 525
 526 void
 527 vnet_register_sysuninit(void *arg)
 528 {
 529         struct vnet_sysinit *vs, *vs2;
 530
 531         vs = arg;
 532
 533         /* Add the destructor to the global list of vnet destructors. */
 534         VNET_SYSINIT_WLOCK();
 535         TAILQ_FOREACH(vs2, &vnet_destructors, link) {
 536                 if (vs2->subsystem > vs->subsystem)
 537                         break;
 538                 if (vs2->subsystem == vs->subsystem && vs2->order > vs->order)
 539                         break;
 540         }
 541         if (vs2 != NULL)
 542                 TAILQ_INSERT_BEFORE(vs2, vs, link);
 543         else
 544                 TAILQ_INSERT_TAIL(&vnet_destructors, vs, link);
 545         VNET_SYSINIT_WUNLOCK();
 546 }
 547
 548 void
 549 vnet_deregister_sysuninit(void *arg)
 550 {
 551         struct vnet_sysinit *vs;
 552         struct vnet *vnet;
 553
 554         vs = arg;
 555
 556         /*
 557          * Invoke the destructor on all the existing vnets when it is
 558          * deregistered.
 559          */
 560         VNET_SYSINIT_WLOCK();
 561         VNET_FOREACH(vnet) {
 562                 CURVNET_SET_QUIET(vnet);
 563                 vs->func(vs->arg);
 564                 CURVNET_RESTORE();
 565         }
 566
 567         /* Remove the destructor from the global list of vnet destructors. */
 568         TAILQ_REMOVE(&vnet_destructors, vs, link);
 569         VNET_SYSINIT_WUNLOCK();
 570 }
 571
 572 /*
 573  * Invoke all registered vnet constructors on the current vnet.  Used during
 574  * vnet construction.  The caller is responsible for ensuring the new vnet is
 575  * the current vnet and that the vnet_sysinit_sxlock lock is locked.
 576  */
 577 void
 578 vnet_sysinit(void)
 579 {
 580         struct vnet_sysinit *vs;
 581
 582         VNET_SYSINIT_RLOCK();
 583         TAILQ_FOREACH(vs, &vnet_constructors, link) {
 584                 vs->func(vs->arg);
 585         }
 586         VNET_SYSINIT_RUNLOCK();
 587 }
 588
 589 /*
 590  * Invoke all registered vnet destructors on the current vnet.  Used during
 591  * vnet destruction.  The caller is responsible for ensuring the dying vnet
 592  * the current vnet and that the vnet_sysinit_sxlock lock is locked.
 593  */
 594 void
 595 vnet_sysuninit(void)
 596 {
 597         struct vnet_sysinit *vs;
 598
 599         VNET_SYSINIT_RLOCK();
 600         TAILQ_FOREACH_REVERSE(vs, &vnet_destructors, vnet_sysuninit_head,
 601             link) {
 602                 vs->func(vs->arg);
 603         }
 604         VNET_SYSINIT_RUNLOCK();
 605 }
 606
 607 /*
 608  * EVENTHANDLER(9) extensions.
 609  */
 610 /*
 611  * Invoke the eventhandler function originally registered with the possibly
 612  * registered argument for all virtual network stack instances.
 613  *
 614  * This iterator can only be used for eventhandlers that do not take any
 615  * additional arguments, as we do ignore the variadic arguments from the
 616  * EVENTHANDLER_INVOKE() call.
 617  */
 618 void
 619 vnet_global_eventhandler_iterator_func(void *arg, ...)
 620 {
 621         VNET_ITERATOR_DECL(vnet_iter);
 622         struct eventhandler_entry_vimage *v_ee;
 623
 624         /*
 625          * There is a bug here in that we should actually cast things to
 626          * (struct eventhandler_entry_ ## name *)  but that's not easily
 627          * possible in here so just re-using the variadic version we
 628          * defined for the generic vimage case.
 629          */
 630         v_ee = arg;
 631         VNET_LIST_RLOCK();
 632         VNET_FOREACH(vnet_iter) {
 633                 CURVNET_SET(vnet_iter);
 634                 ((vimage_iterator_func_t)v_ee->func)(v_ee->ee_arg);
 635                 CURVNET_RESTORE();
 636         }
 637         VNET_LIST_RUNLOCK();
 638 }
 639
 640 #ifdef VNET_DEBUG
 641 struct vnet_recursion {
 642         SLIST_ENTRY(vnet_recursion)      vnr_le;
 643         const char                      *prev_fn;
 644         const char                      *where_fn;
 645         int                              where_line;
 646         struct vnet                     *old_vnet;
 647         struct vnet                     *new_vnet;
 648 };
 649
 650 static SLIST_HEAD(, vnet_recursion) vnet_recursions =
 651     SLIST_HEAD_INITIALIZER(vnet_recursions);
 652
 653 static void
 654 vnet_print_recursion(struct vnet_recursion *vnr, int brief)
 655 {
 656
 657         if (!brief)
 658                 printf("CURVNET_SET() recursion in ");
 659         printf("%s() line %d, prev in %s()", vnr->where_fn, vnr->where_line,
 660             vnr->prev_fn);
 661         if (brief)
 662                 printf(", ");
 663         else
 664                 printf("\n    ");
 665         printf("%p -> %p\n", vnr->old_vnet, vnr->new_vnet);
 666 }
 667
 668 void
 669 vnet_log_recursion(struct vnet *old_vnet, const char *old_fn, int line)
 670 {
 671         struct vnet_recursion *vnr;
 672
 673         /* Skip already logged recursion events. */
 674         SLIST_FOREACH(vnr, &vnet_recursions, vnr_le)
 675                 if (vnr->prev_fn == old_fn &&
 676                     vnr->where_fn == curthread->td_vnet_lpush &&
 677                     vnr->where_line == line &&
 678                     (vnr->old_vnet == vnr->new_vnet) == (curvnet == old_vnet))
 679                         return;
 680
 681         vnr = malloc(sizeof(*vnr), M_VNET, M_NOWAIT | M_ZERO);
 682         if (vnr == NULL)
 683                 panic("%s: malloc failed", __func__);
 684         vnr->prev_fn = old_fn;
 685         vnr->where_fn = curthread->td_vnet_lpush;
 686         vnr->where_line = line;
 687         vnr->old_vnet = old_vnet;
 688         vnr->new_vnet = curvnet;
 689
 690         SLIST_INSERT_HEAD(&vnet_recursions, vnr, vnr_le);
 691
 692         vnet_print_recursion(vnr, 0);
 693 #ifdef KDB
 694         kdb_backtrace();
 695 #endif
 696 }
 697 #endif /* VNET_DEBUG */
 698
 699 /*
 700  * DDB(4).
 701  */
 702 #ifdef DDB
 703 static void
 704 db_vnet_print(struct vnet *vnet)
 705 {
 706
 707         db_printf("vnet            = %p\n", vnet);
 708         db_printf(" vnet_magic_n   = %#08x (%s, orig %#08x)\n",
 709             vnet->vnet_magic_n,
 710             (vnet->vnet_magic_n == VNET_MAGIC_N) ?
 711                 "ok" : "mismatch", VNET_MAGIC_N);
 712         db_printf(" vnet_ifcnt     = %u\n", vnet->vnet_ifcnt);
 713         db_printf(" vnet_sockcnt   = %u\n", vnet->vnet_sockcnt);
 714         db_printf(" vnet_data_mem  = %p\n", vnet->vnet_data_mem);
 715         db_printf(" vnet_data_base = %#jx\n",
 716             (uintmax_t)vnet->vnet_data_base);
 717         db_printf("\n");
 718 }
 719
 720 DB_SHOW_ALL_COMMAND(vnets, db_show_all_vnets)
 721 {
 722         VNET_ITERATOR_DECL(vnet_iter);
 723
 724         VNET_FOREACH(vnet_iter) {
 725                 db_vnet_print(vnet_iter);
 726                 if (db_pager_quit)
 727                         break;
 728         }
 729 }
 730
 731 DB_SHOW_COMMAND(vnet, db_show_vnet)
 732 {
 733
 734         if (!have_addr) {
 735                 db_printf("usage: show vnet <struct vnet *>\n");
 736                 return;
 737         }
 738
 739         db_vnet_print((struct vnet *)addr);
 740 }
 741
 742 static void
 743 db_show_vnet_print_vs(struct vnet_sysinit *vs, int ddb)
 744 {
 745         const char *vsname, *funcname;
 746         c_db_sym_t sym;
 747         db_expr_t  offset;
 748
 749 #define xprint(...)                                                     \
 750         if (ddb)                                                        \
 751                 db_printf(__VA_ARGS__);                                 \
 752         else                                                            \
 753                 printf(__VA_ARGS__)
 754
 755         if (vs == NULL) {
 756                 xprint("%s: no vnet_sysinit * given\n", __func__);
 757                 return;
 758         }
 759
 760         sym = db_search_symbol((vm_offset_t)vs, DB_STGY_ANY, &offset);
 761         db_symbol_values(sym, &vsname, NULL);
 762         sym = db_search_symbol((vm_offset_t)vs->func, DB_STGY_PROC, &offset);
 763         db_symbol_values(sym, &funcname, NULL);
 764         xprint("%s(%p)\n", (vsname != NULL) ? vsname : "", vs);
 765         xprint("  %#08x %#08x\n", vs->subsystem, vs->order);
 766         xprint("  %p(%s)(%p)\n",
 767             vs->func, (funcname != NULL) ? funcname : "", vs->arg);
 768 #undef xprint
 769 }
 770
 771 DB_SHOW_COMMAND(vnet_sysinit, db_show_vnet_sysinit)
 772 {
 773         struct vnet_sysinit *vs;
 774
 775         db_printf("VNET_SYSINIT vs Name(Ptr)\n");
 776         db_printf("  Subsystem  Order\n");
 777         db_printf("  Function(Name)(Arg)\n");
 778         TAILQ_FOREACH(vs, &vnet_constructors, link) {
 779                 db_show_vnet_print_vs(vs, 1);
 780                 if (db_pager_quit)
 781                         break;
 782         }
 783 }
 784
 785 DB_SHOW_COMMAND(vnet_sysuninit, db_show_vnet_sysuninit)
 786 {
 787         struct vnet_sysinit *vs;
 788
 789         db_printf("VNET_SYSUNINIT vs Name(Ptr)\n");
 790         db_printf("  Subsystem  Order\n");
 791         db_printf("  Function(Name)(Arg)\n");
 792         TAILQ_FOREACH_REVERSE(vs, &vnet_destructors, vnet_sysuninit_head,
 793             link) {
 794                 db_show_vnet_print_vs(vs, 1);
 795                 if (db_pager_quit)
 796                         break;
 797         }
 798 }
 799
 800 #ifdef VNET_DEBUG
 801 DB_SHOW_COMMAND(vnetrcrs, db_show_vnetrcrs)
 802 {
 803         struct vnet_recursion *vnr;
 804
 805         SLIST_FOREACH(vnr, &vnet_recursions, vnr_le)
 806                 vnet_print_recursion(vnr, 1);
 807 }
 808 #endif
 809 #endif /* DDB */