1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2004-2009 University of Zagreb
5 * Copyright (c) 2006-2009 FreeBSD Foundation
6 * All rights reserved.
7 *
8 * This software was developed by the University of Zagreb and the
9 * FreeBSD Foundation under sponsorship by the Stichting NLnet and the
10 * FreeBSD Foundation.
11 *
12 * Copyright (c) 2009 Jeffrey Roberson <jeff@freebsd.org>
13 * Copyright (c) 2009 Robert N. M. Watson
14 * All rights reserved.
15 *
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
18 * are met:
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * SUCH DAMAGE.
36 */
37
38 #include <sys/cdefs.h>
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 = LIST_HEAD_INITIALIZER(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 (8 * PAGE_SIZE)
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 VNET_DEFINE_STATIC(char, modspace[VNET_MODMIN] __aligned(__alignof(void *)));
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 /*
222 * Run per-vnet sysinits or sysuninits during vnet creation/destruction.
223 */
224 static void vnet_sysinit(void);
225 static void vnet_sysuninit(void);
226
227 #ifdef DDB
228 static void db_show_vnet_print_vs(struct vnet_sysinit *, int);
229 #endif
230
231 /*
232 * Allocate a virtual network stack.
233 */
234 struct vnet *
vnet_alloc(void)235 vnet_alloc(void)
236 {
237 struct vnet *vnet;
238
239 SDT_PROBE1(vnet, functions, vnet_alloc, entry, __LINE__);
240 vnet = malloc(sizeof(struct vnet), M_VNET, M_WAITOK | M_ZERO);
241 vnet->vnet_magic_n = VNET_MAGIC_N;
242 SDT_PROBE2(vnet, functions, vnet_alloc, alloc, __LINE__, vnet);
243
244 /*
245 * Allocate storage for virtualized global variables and copy in
246 * initial values from our 'master' copy.
247 */
248 vnet->vnet_data_mem = malloc(VNET_SIZE, M_VNET_DATA, M_WAITOK);
249 memcpy(vnet->vnet_data_mem, (void *)VNET_START, VNET_BYTES);
250
251 /*
252 * All use of vnet-specific data will immediately subtract VNET_START
253 * from the base memory pointer, so pre-calculate that now to avoid
254 * it on each use.
255 */
256 vnet->vnet_data_base = (uintptr_t)vnet->vnet_data_mem - VNET_START;
257
258 /* Initialize / attach vnet module instances. */
259 CURVNET_SET_QUIET(vnet);
260 vnet_sysinit();
261 CURVNET_RESTORE();
262
263 VNET_LIST_WLOCK();
264 LIST_INSERT_HEAD(&vnet_head, vnet, vnet_le);
265 VNET_LIST_WUNLOCK();
266
267 SDT_PROBE2(vnet, functions, vnet_alloc, return, __LINE__, vnet);
268 return (vnet);
269 }
270
271 /*
272 * Destroy a virtual network stack.
273 */
274 void
vnet_destroy(struct vnet * vnet)275 vnet_destroy(struct vnet *vnet)
276 {
277
278 SDT_PROBE2(vnet, functions, vnet_destroy, entry, __LINE__, vnet);
279 KASSERT(vnet->vnet_sockcnt == 0,
280 ("%s: vnet still has sockets", __func__));
281
282 VNET_LIST_WLOCK();
283 LIST_REMOVE(vnet, vnet_le);
284 VNET_LIST_WUNLOCK();
285
286 /* Signal that VNET is being shutdown. */
287 vnet->vnet_shutdown = true;
288
289 CURVNET_SET_QUIET(vnet);
290 sx_xlock(&ifnet_detach_sxlock);
291 vnet_sysuninit();
292 sx_xunlock(&ifnet_detach_sxlock);
293 CURVNET_RESTORE();
294
295 /*
296 * Release storage for the virtual network stack instance.
297 */
298 free(vnet->vnet_data_mem, M_VNET_DATA);
299 vnet->vnet_data_mem = NULL;
300 vnet->vnet_data_base = 0;
301 vnet->vnet_magic_n = 0xdeadbeef;
302 free(vnet, M_VNET);
303 SDT_PROBE1(vnet, functions, vnet_destroy, return, __LINE__);
304 }
305
306 /*
307 * Boot time initialization and allocation of virtual network stacks.
308 */
309 static void
vnet_init_prelink(void * arg __unused)310 vnet_init_prelink(void *arg __unused)
311 {
312
313 rw_init(&vnet_rwlock, "vnet_rwlock");
314 sx_init(&vnet_sxlock, "vnet_sxlock");
315 sx_init(&vnet_sysinit_sxlock, "vnet_sysinit_sxlock");
316 }
317 SYSINIT(vnet_init_prelink, SI_SUB_VNET_PRELINK, SI_ORDER_FIRST,
318 vnet_init_prelink, NULL);
319
320 static void
vnet0_init(void * arg __unused)321 vnet0_init(void *arg __unused)
322 {
323
324 if (bootverbose)
325 printf("VIMAGE (virtualized network stack) enabled\n");
326
327 /*
328 * We MUST clear curvnet in vi_init_done() before going SMP,
329 * otherwise CURVNET_SET() macros would scream about unnecessary
330 * curvnet recursions.
331 */
332 curvnet = prison0.pr_vnet = vnet0 = vnet_alloc();
333 }
334 SYSINIT(vnet0_init, SI_SUB_VNET, SI_ORDER_FIRST, vnet0_init, NULL);
335
336 static void
vnet_init_done(void * unused __unused)337 vnet_init_done(void *unused __unused)
338 {
339
340 curvnet = NULL;
341 }
342 SYSINIT(vnet_init_done, SI_SUB_VNET_DONE, SI_ORDER_ANY, vnet_init_done,
343 NULL);
344
345 /*
346 * Once on boot, initialize the modspace freelist to entirely cover modspace.
347 */
348 static void
vnet_data_startup(void * dummy __unused)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, NULL);
360
361 /* Dummy VNET_SYSINIT to make sure we always reach the final end state. */
362 static void
vnet_sysinit_done(void * unused __unused)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 *
vnet_data_alloc(int size)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
vnet_data_free(void * start_arg,int size)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
vnet_data_copy(void * start,int size)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
vnet_register_sysinit(void * arg)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_LIST_RLOCK();
506 VNET_FOREACH(vnet) {
507 CURVNET_SET_QUIET(vnet);
508 vs->func(vs->arg);
509 CURVNET_RESTORE();
510 }
511 VNET_LIST_RUNLOCK();
512 VNET_SYSINIT_WUNLOCK();
513 }
514
515 void
vnet_deregister_sysinit(void * arg)516 vnet_deregister_sysinit(void *arg)
517 {
518 struct vnet_sysinit *vs;
519
520 vs = arg;
521
522 /* Remove the constructor from the global list of vnet constructors. */
523 VNET_SYSINIT_WLOCK();
524 TAILQ_REMOVE(&vnet_constructors, vs, link);
525 VNET_SYSINIT_WUNLOCK();
526 }
527
528 void
vnet_register_sysuninit(void * arg)529 vnet_register_sysuninit(void *arg)
530 {
531 struct vnet_sysinit *vs, *vs2;
532
533 vs = arg;
534
535 /* Add the destructor to the global list of vnet destructors. */
536 VNET_SYSINIT_WLOCK();
537 TAILQ_FOREACH(vs2, &vnet_destructors, link) {
538 if (vs2->subsystem > vs->subsystem)
539 break;
540 if (vs2->subsystem == vs->subsystem && vs2->order > vs->order)
541 break;
542 }
543 if (vs2 != NULL)
544 TAILQ_INSERT_BEFORE(vs2, vs, link);
545 else
546 TAILQ_INSERT_TAIL(&vnet_destructors, vs, link);
547 VNET_SYSINIT_WUNLOCK();
548 }
549
550 void
vnet_deregister_sysuninit(void * arg)551 vnet_deregister_sysuninit(void *arg)
552 {
553 struct vnet_sysinit *vs;
554 struct vnet *vnet;
555
556 vs = arg;
557
558 /*
559 * Invoke the destructor on all the existing vnets when it is
560 * deregistered.
561 */
562 VNET_SYSINIT_WLOCK();
563 VNET_LIST_RLOCK();
564 VNET_FOREACH(vnet) {
565 CURVNET_SET_QUIET(vnet);
566 vs->func(vs->arg);
567 CURVNET_RESTORE();
568 }
569
570 /* Remove the destructor from the global list of vnet destructors. */
571 TAILQ_REMOVE(&vnet_destructors, vs, link);
572 VNET_SYSINIT_WUNLOCK();
573 VNET_LIST_RUNLOCK();
574 }
575
576 /*
577 * Invoke all registered vnet constructors on the current vnet. Used during
578 * vnet construction. The caller is responsible for ensuring the new vnet is
579 * the current vnet and that the vnet_sysinit_sxlock lock is locked.
580 */
581 static void
vnet_sysinit(void)582 vnet_sysinit(void)
583 {
584 struct vnet_sysinit *vs;
585
586 VNET_SYSINIT_RLOCK();
587 TAILQ_FOREACH(vs, &vnet_constructors, link) {
588 curvnet->vnet_state = vs->subsystem;
589 vs->func(vs->arg);
590 }
591 VNET_SYSINIT_RUNLOCK();
592 }
593
594 /*
595 * Invoke all registered vnet destructors on the current vnet. Used during
596 * vnet destruction. The caller is responsible for ensuring the dying vnet
597 * the current vnet and that the vnet_sysinit_sxlock lock is locked.
598 */
599 static void
vnet_sysuninit(void)600 vnet_sysuninit(void)
601 {
602 struct vnet_sysinit *vs;
603
604 VNET_SYSINIT_RLOCK();
605 TAILQ_FOREACH_REVERSE(vs, &vnet_destructors, vnet_sysuninit_head,
606 link) {
607 curvnet->vnet_state = vs->subsystem;
608 vs->func(vs->arg);
609 }
610 VNET_SYSINIT_RUNLOCK();
611 }
612
613 /*
614 * EVENTHANDLER(9) extensions.
615 */
616 /*
617 * Invoke the eventhandler function originally registered with the possibly
618 * registered argument for all virtual network stack instances.
619 *
620 * This iterator can only be used for eventhandlers that do not take any
621 * additional arguments, as we do ignore the variadic arguments from the
622 * EVENTHANDLER_INVOKE() call.
623 */
624 void
vnet_global_eventhandler_iterator_func(void * arg,...)625 vnet_global_eventhandler_iterator_func(void *arg, ...)
626 {
627 VNET_ITERATOR_DECL(vnet_iter);
628 struct eventhandler_entry_vimage *v_ee;
629
630 /*
631 * There is a bug here in that we should actually cast things to
632 * (struct eventhandler_entry_ ## name *) but that's not easily
633 * possible in here so just re-using the variadic version we
634 * defined for the generic vimage case.
635 */
636 v_ee = arg;
637 VNET_LIST_RLOCK();
638 VNET_FOREACH(vnet_iter) {
639 CURVNET_SET(vnet_iter);
640 ((vimage_iterator_func_t)v_ee->func)(v_ee->ee_arg);
641 CURVNET_RESTORE();
642 }
643 VNET_LIST_RUNLOCK();
644 }
645
646 #ifdef VNET_DEBUG
647 struct vnet_recursion {
648 SLIST_ENTRY(vnet_recursion) vnr_le;
649 const char *prev_fn;
650 const char *where_fn;
651 int where_line;
652 struct vnet *old_vnet;
653 struct vnet *new_vnet;
654 };
655
656 static SLIST_HEAD(, vnet_recursion) vnet_recursions =
657 SLIST_HEAD_INITIALIZER(vnet_recursions);
658
659 static void
vnet_print_recursion(struct vnet_recursion * vnr,int brief)660 vnet_print_recursion(struct vnet_recursion *vnr, int brief)
661 {
662
663 if (!brief)
664 printf("CURVNET_SET() recursion in ");
665 printf("%s() line %d, prev in %s()", vnr->where_fn, vnr->where_line,
666 vnr->prev_fn);
667 if (brief)
668 printf(", ");
669 else
670 printf("\n ");
671 printf("%p -> %p\n", vnr->old_vnet, vnr->new_vnet);
672 }
673
674 void
vnet_log_recursion(struct vnet * old_vnet,const char * old_fn,int line)675 vnet_log_recursion(struct vnet *old_vnet, const char *old_fn, int line)
676 {
677 struct vnet_recursion *vnr;
678
679 /* Skip already logged recursion events. */
680 SLIST_FOREACH(vnr, &vnet_recursions, vnr_le)
681 if (vnr->prev_fn == old_fn &&
682 vnr->where_fn == curthread->td_vnet_lpush &&
683 vnr->where_line == line &&
684 (vnr->old_vnet == vnr->new_vnet) == (curvnet == old_vnet))
685 return;
686
687 vnr = malloc(sizeof(*vnr), M_VNET, M_NOWAIT | M_ZERO);
688 if (vnr == NULL)
689 panic("%s: malloc failed", __func__);
690 vnr->prev_fn = old_fn;
691 vnr->where_fn = curthread->td_vnet_lpush;
692 vnr->where_line = line;
693 vnr->old_vnet = old_vnet;
694 vnr->new_vnet = curvnet;
695
696 SLIST_INSERT_HEAD(&vnet_recursions, vnr, vnr_le);
697
698 vnet_print_recursion(vnr, 0);
699 #ifdef KDB
700 kdb_backtrace();
701 #endif
702 }
703 #endif /* VNET_DEBUG */
704
705 /*
706 * DDB(4).
707 */
708 #ifdef DDB
709 static void
db_vnet_print(struct vnet * vnet)710 db_vnet_print(struct vnet *vnet)
711 {
712
713 db_printf("vnet = %p\n", vnet);
714 db_printf(" vnet_magic_n = %#08x (%s, orig %#08x)\n",
715 vnet->vnet_magic_n,
716 (vnet->vnet_magic_n == VNET_MAGIC_N) ?
717 "ok" : "mismatch", VNET_MAGIC_N);
718 db_printf(" vnet_ifcnt = %u\n", vnet->vnet_ifcnt);
719 db_printf(" vnet_sockcnt = %u\n", vnet->vnet_sockcnt);
720 db_printf(" vnet_data_mem = %p\n", vnet->vnet_data_mem);
721 db_printf(" vnet_data_base = %#jx\n",
722 (uintmax_t)vnet->vnet_data_base);
723 db_printf(" vnet_state = %#08x\n", vnet->vnet_state);
724 db_printf(" vnet_shutdown = %#03x\n", vnet->vnet_shutdown);
725 db_printf("\n");
726 }
727
DB_SHOW_ALL_COMMAND(vnets,db_show_all_vnets)728 DB_SHOW_ALL_COMMAND(vnets, db_show_all_vnets)
729 {
730 VNET_ITERATOR_DECL(vnet_iter);
731
732 VNET_FOREACH(vnet_iter) {
733 db_vnet_print(vnet_iter);
734 if (db_pager_quit)
735 break;
736 }
737 }
738
DB_SHOW_COMMAND(vnet,db_show_vnet)739 DB_SHOW_COMMAND(vnet, db_show_vnet)
740 {
741
742 if (!have_addr) {
743 db_printf("usage: show vnet <struct vnet *>\n");
744 return;
745 }
746
747 db_vnet_print((struct vnet *)addr);
748 }
749
750 static void
db_show_vnet_print_vs(struct vnet_sysinit * vs,int ddb)751 db_show_vnet_print_vs(struct vnet_sysinit *vs, int ddb)
752 {
753 const char *vsname, *funcname;
754 c_db_sym_t sym;
755 db_expr_t offset;
756
757 #define xprint(...) do { \
758 if (ddb) \
759 db_printf(__VA_ARGS__); \
760 else \
761 printf(__VA_ARGS__); \
762 } while (0)
763
764 if (vs == NULL) {
765 xprint("%s: no vnet_sysinit * given\n", __func__);
766 return;
767 }
768
769 sym = db_search_symbol((vm_offset_t)vs, DB_STGY_ANY, &offset);
770 db_symbol_values(sym, &vsname, NULL);
771 sym = db_search_symbol((vm_offset_t)vs->func, DB_STGY_PROC, &offset);
772 db_symbol_values(sym, &funcname, NULL);
773 xprint("%s(%p)\n", (vsname != NULL) ? vsname : "", vs);
774 xprint(" %#08x %#08x\n", vs->subsystem, vs->order);
775 xprint(" %p(%s)(%p)\n",
776 vs->func, (funcname != NULL) ? funcname : "", vs->arg);
777 #undef xprint
778 }
779
DB_SHOW_COMMAND_FLAGS(vnet_sysinit,db_show_vnet_sysinit,DB_CMD_MEMSAFE)780 DB_SHOW_COMMAND_FLAGS(vnet_sysinit, db_show_vnet_sysinit, DB_CMD_MEMSAFE)
781 {
782 struct vnet_sysinit *vs;
783
784 db_printf("VNET_SYSINIT vs Name(Ptr)\n");
785 db_printf(" Subsystem Order\n");
786 db_printf(" Function(Name)(Arg)\n");
787 TAILQ_FOREACH(vs, &vnet_constructors, link) {
788 db_show_vnet_print_vs(vs, 1);
789 if (db_pager_quit)
790 break;
791 }
792 }
793
DB_SHOW_COMMAND_FLAGS(vnet_sysuninit,db_show_vnet_sysuninit,DB_CMD_MEMSAFE)794 DB_SHOW_COMMAND_FLAGS(vnet_sysuninit, db_show_vnet_sysuninit, DB_CMD_MEMSAFE)
795 {
796 struct vnet_sysinit *vs;
797
798 db_printf("VNET_SYSUNINIT vs Name(Ptr)\n");
799 db_printf(" Subsystem Order\n");
800 db_printf(" Function(Name)(Arg)\n");
801 TAILQ_FOREACH_REVERSE(vs, &vnet_destructors, vnet_sysuninit_head,
802 link) {
803 db_show_vnet_print_vs(vs, 1);
804 if (db_pager_quit)
805 break;
806 }
807 }
808
809 #ifdef VNET_DEBUG
DB_SHOW_COMMAND_FLAGS(vnetrcrs,db_show_vnetrcrs,DB_CMD_MEMSAFE)810 DB_SHOW_COMMAND_FLAGS(vnetrcrs, db_show_vnetrcrs, DB_CMD_MEMSAFE)
811 {
812 struct vnet_recursion *vnr;
813
814 SLIST_FOREACH(vnr, &vnet_recursions, vnr_le)
815 vnet_print_recursion(vnr, 1);
816 }
817 #endif
818 #endif /* DDB */
819