sys/net/vnet.h

   1 /*-
   2  * Copyright (c) 2006-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  * $FreeBSD$
  36  */
  37
  38 /*-
  39  * This header file defines several sets of interfaces supporting virtualized
  40  * network stacks:
  41  *
  42  * - Definition of 'struct vnet' and functions and macros to allocate/free/
  43  *   manipulate it.
  44  *
  45  * - A virtual network stack memory allocator, which provides support for
  46  *   virtualized global variables via a special linker set, set_vnet.
  47  *
  48  * - Virtualized sysinits/sysuninits, which allow constructors and
  49  *   destructors to be run for each network stack subsystem as virtual
  50  *   instances are created and destroyed.
  51  *
  52  * If VIMAGE isn't compiled into the kernel, virtualized global variables
  53  * compile to normal global variables, and virtualized sysinits to regular
  54  * sysinits.
  55  */
  56
  57 #ifndef _NET_VNET_H_
  58 #define _NET_VNET_H_
  59
  60 /*
  61  * struct vnet describes a virtualized network stack, and is primarily a
  62  * pointer to storage for virtualized global variables.  Expose to userspace
  63  * as required for libkvm.
  64  */
  65 #if defined(_KERNEL) || defined(_WANT_VNET)
  66 #include <sys/queue.h>
  67
  68 struct vnet {
  69         LIST_ENTRY(vnet)         vnet_le;       /* all vnets list */
  70         u_int                    vnet_magic_n;
  71         u_int                    vnet_ifcnt;
  72         u_int                    vnet_sockcnt;
  73         void                    *vnet_data_mem;
  74         uintptr_t                vnet_data_base;
  75 };
  76 #define VNET_MAGIC_N    0x3e0d8f29
  77
  78 /*
  79  * These two virtual network stack allocator definitions are also required
  80  * for libkvm so that it can evaluate virtualized global variables.
  81  */
  82 #define VNET_SETNAME            "set_vnet"
  83 #define VNET_SYMPREFIX          "vnet_entry_"
  84 #endif
  85
  86 #ifdef _KERNEL
  87
  88 #ifdef VIMAGE
  89 #include <sys/lock.h>
  90 #include <sys/proc.h>                   /* for struct thread */
  91 #include <sys/rwlock.h>
  92 #include <sys/sx.h>
  93
  94 /*
  95  * Location of the kernel's 'set_vnet' linker set.
  96  */
  97 extern uintptr_t        *__start_set_vnet;
  98 extern uintptr_t        *__stop_set_vnet;
  99
 100 #define VNET_START      (uintptr_t)&__start_set_vnet
 101 #define VNET_STOP       (uintptr_t)&__stop_set_vnet
 102
 103 /*
 104  * Functions to allocate and destroy virtual network stacks.
 105  */
 106 struct vnet *vnet_alloc(void);
 107 void    vnet_destroy(struct vnet *vnet);
 108
 109 /*
 110  * The current virtual network stack -- we may wish to move this to struct
 111  * pcpu in the future.
 112  */
 113 #define curvnet curthread->td_vnet
 114
 115 /*
 116  * Various macros -- get and set the current network stack, but also
 117  * assertions.
 118  */
 119 #ifdef VNET_DEBUG
 120 void vnet_log_recursion(struct vnet *, const char *, int);
 121
 122 #define VNET_ASSERT(condition)                                          \
 123         if (!(condition)) {                                             \
 124                 printf("VNET_ASSERT @ %s:%d %s():\n",                   \
 125                         __FILE__, __LINE__, __FUNCTION__);              \
 126                 panic(#condition);                                      \
 127         }
 128
 129 #define CURVNET_SET_QUIET(arg)                                          \
 130         VNET_ASSERT((arg)->vnet_magic_n == VNET_MAGIC_N);               \
 131         struct vnet *saved_vnet = curvnet;                              \
 132         const char *saved_vnet_lpush = curthread->td_vnet_lpush;        \
 133         curvnet = arg;                                                  \
 134         curthread->td_vnet_lpush = __FUNCTION__;
 135
 136 #define CURVNET_SET_VERBOSE(arg)                                        \
 137         CURVNET_SET_QUIET(arg)                                          \
 138         if (saved_vnet)                                                 \
 139                 vnet_log_recursion(saved_vnet, saved_vnet_lpush, __LINE__);
 140
 141 #define CURVNET_SET(arg)        CURVNET_SET_VERBOSE(arg)
 142
 143 #define CURVNET_RESTORE()                                               \
 144         VNET_ASSERT(saved_vnet == NULL ||                               \
 145                     saved_vnet->vnet_magic_n == VNET_MAGIC_N);          \
 146         curvnet = saved_vnet;                                           \
 147         curthread->td_vnet_lpush = saved_vnet_lpush;
 148 #else /* !VNET_DEBUG */
 149 #define VNET_ASSERT(condition)
 150
 151 #define CURVNET_SET(arg)                                                \
 152         struct vnet *saved_vnet = curvnet;                              \
 153         curvnet = arg;
 154
 155 #define CURVNET_SET_VERBOSE(arg)        CURVNET_SET(arg)
 156 #define CURVNET_SET_QUIET(arg)          CURVNET_SET(arg)
 157
 158 #define CURVNET_RESTORE()                                               \
 159         curvnet = saved_vnet;
 160 #endif /* VNET_DEBUG */
 161
 162 extern struct vnet *vnet0;
 163 #define IS_DEFAULT_VNET(arg)    ((arg) == vnet0)
 164
 165 #define CRED_TO_VNET(cr)        (cr)->cr_prison->pr_vnet
 166 #define TD_TO_VNET(td)          CRED_TO_VNET((td)->td_ucred)
 167 #define P_TO_VNET(p)            CRED_TO_VNET((p)->p_ucred)
 168
 169 /*
 170  * Global linked list of all virtual network stacks, along with read locks to
 171  * access it.  If a caller may sleep while accessing the list, it must use
 172  * the sleepable lock macros.
 173  */
 174 LIST_HEAD(vnet_list_head, vnet);
 175 extern struct vnet_list_head vnet_head;
 176 extern struct rwlock vnet_rwlock;
 177 extern struct sx vnet_sxlock;
 178
 179 #define VNET_LIST_RLOCK()               sx_slock(&vnet_sxlock)
 180 #define VNET_LIST_RLOCK_NOSLEEP()       rw_rlock(&vnet_rwlock)
 181 #define VNET_LIST_RUNLOCK()             sx_sunlock(&vnet_sxlock)
 182 #define VNET_LIST_RUNLOCK_NOSLEEP()     rw_runlock(&vnet_rwlock)
 183
 184 /*
 185  * Iteration macros to walk the global list of virtual network stacks.
 186  */
 187 #define VNET_ITERATOR_DECL(arg) struct vnet *arg
 188 #define VNET_FOREACH(arg)       LIST_FOREACH((arg), &vnet_head, vnet_le)
 189
 190 /*
 191  * Virtual network stack memory allocator, which allows global variables to
 192  * be automatically instantiated for each network stack instance.
 193  */
 194 __asm__(
 195 #if defined(__arm__)
 196         ".section " VNET_SETNAME ", \"aw\", %progbits\n"
 197 #else
 198         ".section " VNET_SETNAME ", \"aw\", @progbits\n"
 199 #endif
 200         "\t.p2align " __XSTRING(CACHE_LINE_SHIFT) "\n"
 201         "\t.previous");
 202
 203 #define VNET_NAME(n)            vnet_entry_##n
 204 #define VNET_DECLARE(t, n)      extern t VNET_NAME(n)
 205 #define VNET_DEFINE(t, n)       t VNET_NAME(n) __section(VNET_SETNAME) __used
 206 #define _VNET_PTR(b, n)         (__typeof(VNET_NAME(n))*)               \
 207                                     ((b) + (uintptr_t)&VNET_NAME(n))
 208
 209 #define _VNET(b, n)             (*_VNET_PTR(b, n))
 210
 211 /*
 212  * Virtualized global variable accessor macros.
 213  */
 214 #define VNET_VNET_PTR(vnet, n)          _VNET_PTR((vnet)->vnet_data_base, n)
 215 #define VNET_VNET(vnet, n)              (*VNET_VNET_PTR((vnet), n))
 216
 217 #define VNET_PTR(n)             VNET_VNET_PTR(curvnet, n)
 218 #define VNET(n)                 VNET_VNET(curvnet, n)
 219
 220 /*
 221  * Virtual network stack allocator interfaces from the kernel linker.
 222  */
 223 void    *vnet_data_alloc(int size);
 224 void     vnet_data_copy(void *start, int size);
 225 void     vnet_data_free(void *start_arg, int size);
 226
 227 /*
 228  * Sysctl variants for vnet-virtualized global variables.  Include
 229  * <sys/sysctl.h> to expose these definitions.
 230  *
 231  * Note: SYSCTL_PROC() handler functions will need to resolve pointer
 232  * arguments themselves, if required.
 233  */
 234 #ifdef SYSCTL_OID
 235 int     vnet_sysctl_handle_int(SYSCTL_HANDLER_ARGS);
 236 int     vnet_sysctl_handle_opaque(SYSCTL_HANDLER_ARGS);
 237 int     vnet_sysctl_handle_string(SYSCTL_HANDLER_ARGS);
 238 int     vnet_sysctl_handle_uint(SYSCTL_HANDLER_ARGS);
 239
 240 #define SYSCTL_VNET_INT(parent, nbr, name, access, ptr, val, descr)     \
 241         SYSCTL_OID(parent, nbr, name,                                   \
 242             CTLTYPE_INT|CTLFLAG_MPSAFE|CTLFLAG_VNET|(access),           \
 243             ptr, val, vnet_sysctl_handle_int, "I", descr)
 244 #define SYSCTL_VNET_PROC(parent, nbr, name, access, ptr, arg, handler,  \
 245             fmt, descr)                                                 \
 246         SYSCTL_OID(parent, nbr, name, CTLFLAG_VNET|(access), ptr, arg,  \
 247             handler, fmt, descr)
 248 #define SYSCTL_VNET_OPAQUE(parent, nbr, name, access, ptr, len, fmt,    \
 249             descr)                                                      \
 250         SYSCTL_OID(parent, nbr, name,                                   \
 251             CTLTYPE_OPAQUE|CTLFLAG_VNET|(access), ptr, len,             \
 252             vnet_sysctl_handle_opaque, fmt, descr)
 253 #define SYSCTL_VNET_STRING(parent, nbr, name, access, arg, len, descr)  \
 254         SYSCTL_OID(parent, nbr, name,                                   \
 255             CTLTYPE_STRING|CTLFLAG_VNET|(access),                       \
 256             arg, len, vnet_sysctl_handle_string, "A", descr)
 257 #define SYSCTL_VNET_STRUCT(parent, nbr, name, access, ptr, type, descr) \
 258         SYSCTL_OID(parent, nbr, name,                                   \
 259             CTLTYPE_OPAQUE|CTLFLAG_VNET|(access), ptr,                  \
 260             sizeof(struct type), vnet_sysctl_handle_opaque, "S," #type, \
 261             descr)
 262 #define SYSCTL_VNET_UINT(parent, nbr, name, access, ptr, val, descr)    \
 263         SYSCTL_OID(parent, nbr, name,                                   \
 264             CTLTYPE_UINT|CTLFLAG_MPSAFE|CTLFLAG_VNET|(access),          \
 265             ptr, val, vnet_sysctl_handle_uint, "IU", descr)
 266 #define VNET_SYSCTL_ARG(req, arg1) do {                                 \
 267         if (arg1 != NULL)                                               \
 268                 arg1 = (void *)(TD_TO_VNET((req)->td)->vnet_data_base + \
 269                     (uintptr_t)(arg1));                                 \
 270 } while (0)
 271 #endif /* SYSCTL_OID */
 272
 273 /*
 274  * Virtual sysinit mechanism, allowing network stack components to declare
 275  * startup and shutdown methods to be run when virtual network stack
 276  * instances are created and destroyed.
 277  */
 278 #include <sys/kernel.h>
 279
 280 /*
 281  * SYSINIT/SYSUNINIT variants that provide per-vnet constructors and
 282  * destructors.
 283  */
 284 struct vnet_sysinit {
 285         enum sysinit_sub_id     subsystem;
 286         enum sysinit_elem_order order;
 287         sysinit_cfunc_t         func;
 288         const void              *arg;
 289         TAILQ_ENTRY(vnet_sysinit) link;
 290 };
 291
 292 #define VNET_SYSINIT(ident, subsystem, order, func, arg)                \
 293         static struct vnet_sysinit ident ## _vnet_init = {              \
 294                 subsystem,                                              \
 295                 order,                                                  \
 296                 (sysinit_cfunc_t)(sysinit_nfunc_t)func,                 \
 297                 (arg)                                                   \
 298         };                                                              \
 299         SYSINIT(vnet_init_ ## ident, subsystem, order,                  \
 300             vnet_register_sysinit, &ident ## _vnet_init);               \
 301         SYSUNINIT(vnet_init_ ## ident, subsystem, order,                \
 302             vnet_deregister_sysinit, &ident ## _vnet_init)
 303
 304 #define VNET_SYSUNINIT(ident, subsystem, order, func, arg)              \
 305         static struct vnet_sysinit ident ## _vnet_uninit = {            \
 306                 subsystem,                                              \
 307                 order,                                                  \
 308                 (sysinit_cfunc_t)(sysinit_nfunc_t)func,                 \
 309                 (arg)                                                   \
 310         };                                                              \
 311         SYSINIT(vnet_uninit_ ## ident, subsystem, order,                \
 312             vnet_register_sysuninit, &ident ## _vnet_uninit);           \
 313         SYSUNINIT(vnet_uninit_ ## ident, subsystem, order,              \
 314             vnet_deregister_sysuninit, &ident ## _vnet_uninit)
 315
 316 /*
 317  * Run per-vnet sysinits or sysuninits during vnet creation/destruction.
 318  */
 319 void     vnet_sysinit(void);
 320 void     vnet_sysuninit(void);
 321
 322 /*
 323  * Interfaces for managing per-vnet constructors and destructors.
 324  */
 325 void    vnet_register_sysinit(void *arg);
 326 void    vnet_register_sysuninit(void *arg);
 327 void    vnet_deregister_sysinit(void *arg);
 328 void    vnet_deregister_sysuninit(void *arg);
 329
 330 /*
 331  * EVENTHANDLER(9) extensions.
 332  */
 333 #include <sys/eventhandler.h>
 334
 335 void    vnet_global_eventhandler_iterator_func(void *, ...);
 336 #define VNET_GLOBAL_EVENTHANDLER_REGISTER_TAG(tag, name, func, arg, priority) \
 337 do {                                                                    \
 338         if (IS_DEFAULT_VNET(curvnet)) {                                 \
 339                 (tag) = vimage_eventhandler_register(NULL, #name, func, \
 340                     arg, priority,                                      \
 341                     vnet_global_eventhandler_iterator_func);            \
 342         }                                                               \
 343 } while(0)
 344 #define VNET_GLOBAL_EVENTHANDLER_REGISTER(name, func, arg, priority)    \
 345 do {                                                                    \
 346         if (IS_DEFAULT_VNET(curvnet)) {                                 \
 347                 vimage_eventhandler_register(NULL, #name, func,         \
 348                     arg, priority,                                      \
 349                     vnet_global_eventhandler_iterator_func);            \
 350         }                                                               \
 351 } while(0)
 352
 353 #else /* !VIMAGE */
 354
 355 /*
 356  * Various virtual network stack macros compile to no-ops without VIMAGE.
 357  */
 358 #define curvnet                 NULL
 359
 360 #define VNET_ASSERT(condition)
 361 #define CURVNET_SET(arg)
 362 #define CURVNET_SET_QUIET(arg)
 363 #define CURVNET_RESTORE()
 364
 365 #define VNET_LIST_RLOCK()
 366 #define VNET_LIST_RLOCK_NOSLEEP()
 367 #define VNET_LIST_RUNLOCK()
 368 #define VNET_LIST_RUNLOCK_NOSLEEP()
 369 #define VNET_ITERATOR_DECL(arg)
 370 #define VNET_FOREACH(arg)
 371
 372 #define IS_DEFAULT_VNET(arg)    1
 373 #define CRED_TO_VNET(cr)        NULL
 374 #define TD_TO_VNET(td)          NULL
 375 #define P_TO_VNET(p)            NULL
 376
 377 /*
 378  * Versions of the VNET macros that compile to normal global variables and
 379  * standard sysctl definitions.
 380  */
 381 #define VNET_NAME(n)            n
 382 #define VNET_DECLARE(t, n)      extern t n
 383 #define VNET_DEFINE(t, n)       t n
 384 #define _VNET_PTR(b, n)         &VNET_NAME(n)
 385
 386 /*
 387  * Virtualized global variable accessor macros.
 388  */
 389 #define VNET_VNET_PTR(vnet, n)          (&(n))
 390 #define VNET_VNET(vnet, n)              (n)
 391
 392 #define VNET_PTR(n)             (&(n))
 393 #define VNET(n)                 (n)
 394
 395 /*
 396  * When VIMAGE isn't compiled into the kernel, virtaulized SYSCTLs simply
 397  * become normal SYSCTLs.
 398  */
 399 #ifdef SYSCTL_OID
 400 #define SYSCTL_VNET_INT(parent, nbr, name, access, ptr, val, descr)     \
 401         SYSCTL_INT(parent, nbr, name, access, ptr, val, descr)
 402 #define SYSCTL_VNET_PROC(parent, nbr, name, access, ptr, arg, handler,  \
 403             fmt, descr)                                                 \
 404         SYSCTL_PROC(parent, nbr, name, access, ptr, arg, handler, fmt,  \
 405             descr)
 406 #define SYSCTL_VNET_OPAQUE(parent, nbr, name, access, ptr, len, fmt,    \
 407             descr)                                                      \
 408         SYSCTL_OPAQUE(parent, nbr, name, access, ptr, len, fmt, descr)
 409 #define SYSCTL_VNET_STRING(parent, nbr, name, access, arg, len, descr)  \
 410         SYSCTL_STRING(parent, nbr, name, access, arg, len, descr)
 411 #define SYSCTL_VNET_STRUCT(parent, nbr, name, access, ptr, type, descr) \
 412         SYSCTL_STRUCT(parent, nbr, name, access, ptr, type, descr)
 413 #define SYSCTL_VNET_UINT(parent, nbr, name, access, ptr, val, descr)    \
 414         SYSCTL_UINT(parent, nbr, name, access, ptr, val, descr)
 415 #define VNET_SYSCTL_ARG(req, arg1)
 416 #endif /* SYSCTL_OID */
 417
 418 /*
 419  * When VIMAGE isn't compiled into the kernel, VNET_SYSINIT/VNET_SYSUNINIT
 420  * map into normal sysinits, which have the same ordering properties.
 421  */
 422 #define VNET_SYSINIT(ident, subsystem, order, func, arg)                \
 423         SYSINIT(ident, subsystem, order, func, arg)
 424 #define VNET_SYSUNINIT(ident, subsystem, order, func, arg)              \
 425         SYSUNINIT(ident, subsystem, order, func, arg)
 426
 427 /*
 428  * Without VIMAGE revert to the default implementation.
 429  */
 430 #define VNET_GLOBAL_EVENTHANDLER_REGISTER_TAG(tag, name, func, arg, priority) \
 431         (tag) = eventhandler_register(NULL, #name, func, arg, priority)
 432 #define VNET_GLOBAL_EVENTHANDLER_REGISTER(name, func, arg, priority)    \
 433         eventhandler_register(NULL, #name, func, arg, priority)
 434 #endif /* VIMAGE */
 435 #endif /* _KERNEL */
 436
 437 #endif /* !_NET_VNET_H_ */