sys/sys/kernel.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-4-Clause
   3  *
   4  * Copyright (c) 1995 Terrence R. Lambert
   5  * All rights reserved.
   6  *
   7  * Copyright (c) 1990, 1993
   8  *      The Regents of the University of California.  All rights reserved.
   9  * (c) UNIX System Laboratories, Inc.
  10  * All or some portions of this file are derived from material licensed
  11  * to the University of California by American Telephone and Telegraph
  12  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  13  * the permission of UNIX System Laboratories, Inc.
  14  *
  15  * Redistribution and use in source and binary forms, with or without
  16  * modification, are permitted provided that the following conditions
  17  * are met:
  18  * 1. Redistributions of source code must retain the above copyright
  19  *    notice, this list of conditions and the following disclaimer.
  20  * 2. Redistributions in binary form must reproduce the above copyright
  21  *    notice, this list of conditions and the following disclaimer in the
  22  *    documentation and/or other materials provided with the distribution.
  23  * 3. All advertising materials mentioning features or use of this software
  24  *    must display the following acknowledgement:
  25  *      This product includes software developed by the University of
  26  *      California, Berkeley and its contributors.
  27  * 4. Neither the name of the University nor the names of its contributors
  28  *    may be used to endorse or promote products derived from this software
  29  *    without specific prior written permission.
  30  *
  31  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  32  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  33  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  34  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  35  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  39  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  40  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  41  * SUCH DAMAGE.
  42  *
  43  *      @(#)kernel.h    8.3 (Berkeley) 1/21/94
  44  * $FreeBSD$
  45  */
  46
  47 #ifndef _SYS_KERNEL_H_
  48 #define _SYS_KERNEL_H_
  49
  50 #include <sys/linker_set.h>
  51
  52 #ifdef _KERNEL
  53
  54 /* for intrhook below */
  55 #include <sys/queue.h>
  56
  57 /* for timestamping SYSINITs; other files may assume this is included here */
  58 #include <sys/tslog.h>
  59
  60 /* Global variables for the kernel. */
  61
  62 /* 1.1 */
  63 extern char kernelname[MAXPATHLEN];
  64
  65 extern int tick;                        /* usec per tick (1000000 / hz) */
  66 extern int hz;                          /* system clock's frequency */
  67 extern int psratio;                     /* ratio: prof / stat */
  68 extern int stathz;                      /* statistics clock's frequency */
  69 extern int profhz;                      /* profiling clock's frequency */
  70 extern int profprocs;                   /* number of process's profiling */
  71 extern volatile int ticks;
  72
  73 #endif /* _KERNEL */
  74
  75 /*
  76  * Enumerated types for known system startup interfaces.
  77  *
  78  * Startup occurs in ascending numeric order; the list entries are
  79  * sorted prior to attempting startup to guarantee order.  Items
  80  * of the same level are arbitrated for order based on the 'order'
  81  * element.
  82  *
  83  * These numbers are arbitrary and are chosen ONLY for ordering; the
  84  * enumeration values are explicit rather than implicit to provide
  85  * for binary compatibility with inserted elements.
  86  *
  87  * The SI_SUB_LAST value must have the highest lexical value.
  88  */
  89 enum sysinit_sub_id {
  90         SI_SUB_DUMMY            = 0x0000000,    /* not executed; for linker*/
  91         SI_SUB_DONE             = 0x0000001,    /* processed*/
  92         SI_SUB_TUNABLES         = 0x0700000,    /* establish tunable values */
  93         SI_SUB_COPYRIGHT        = 0x0800001,    /* first use of console*/
  94         SI_SUB_VM               = 0x1000000,    /* virtual memory system init*/
  95         SI_SUB_KMEM             = 0x1800000,    /* kernel memory*/
  96         SI_SUB_HYPERVISOR       = 0x1A40000,    /*
  97                                                  * Hypervisor detection and
  98                                                  * virtualization support
  99                                                  * setup.
 100                                                  */
 101         SI_SUB_WITNESS          = 0x1A80000,    /* witness initialization */
 102         SI_SUB_MTX_POOL_DYNAMIC = 0x1AC0000,    /* dynamic mutex pool */
 103         SI_SUB_LOCK             = 0x1B00000,    /* various locks */
 104         SI_SUB_EVENTHANDLER     = 0x1C00000,    /* eventhandler init */
 105         SI_SUB_VNET_PRELINK     = 0x1E00000,    /* vnet init before modules */
 106         SI_SUB_KLD              = 0x2000000,    /* KLD and module setup */
 107         SI_SUB_CPU              = 0x2100000,    /* CPU resource(s)*/
 108         SI_SUB_RACCT            = 0x2110000,    /* resource accounting */
 109         SI_SUB_KDTRACE          = 0x2140000,    /* Kernel dtrace hooks */
 110         SI_SUB_RANDOM           = 0x2160000,    /* random number generator */
 111         SI_SUB_MAC              = 0x2180000,    /* TrustedBSD MAC subsystem */
 112         SI_SUB_MAC_POLICY       = 0x21C0000,    /* TrustedBSD MAC policies */
 113         SI_SUB_MAC_LATE         = 0x21D0000,    /* TrustedBSD MAC subsystem */
 114         SI_SUB_VNET             = 0x21E0000,    /* vnet 0 */
 115         SI_SUB_INTRINSIC        = 0x2200000,    /* proc 0*/
 116         SI_SUB_VM_CONF          = 0x2300000,    /* config VM, set limits*/
 117         SI_SUB_DDB_SERVICES     = 0x2380000,    /* capture, scripting, etc. */
 118         SI_SUB_RUN_QUEUE        = 0x2400000,    /* set up run queue*/
 119         SI_SUB_KTRACE           = 0x2480000,    /* ktrace */
 120         SI_SUB_OPENSOLARIS      = 0x2490000,    /* OpenSolaris compatibility */
 121         SI_SUB_AUDIT            = 0x24C0000,    /* audit */
 122         SI_SUB_CREATE_INIT      = 0x2500000,    /* create init process*/
 123         SI_SUB_SCHED_IDLE       = 0x2600000,    /* required idle procs */
 124         SI_SUB_MBUF             = 0x2700000,    /* mbuf subsystem */
 125         SI_SUB_INTR             = 0x2800000,    /* interrupt threads */
 126         SI_SUB_TASKQ            = 0x2880000,    /* task queues */
 127 #ifdef EARLY_AP_STARTUP
 128         SI_SUB_SMP              = 0x2900000,    /* start the APs*/
 129 #endif
 130         SI_SUB_SOFTINTR         = 0x2A00000,    /* start soft interrupt thread */
 131         SI_SUB_DEVFS            = 0x2F00000,    /* devfs ready for devices */
 132         SI_SUB_INIT_IF          = 0x3000000,    /* prep for net interfaces */
 133         SI_SUB_NETGRAPH         = 0x3010000,    /* Let Netgraph initialize */
 134         SI_SUB_DTRACE           = 0x3020000,    /* DTrace subsystem */
 135         SI_SUB_DTRACE_PROVIDER  = 0x3048000,    /* DTrace providers */
 136         SI_SUB_DTRACE_ANON      = 0x308C000,    /* DTrace anon enabling */
 137         SI_SUB_DRIVERS          = 0x3100000,    /* Let Drivers initialize */
 138         SI_SUB_CONFIGURE        = 0x3800000,    /* Configure devices */
 139         SI_SUB_VFS              = 0x4000000,    /* virtual filesystem*/
 140         SI_SUB_CLOCKS           = 0x4800000,    /* real time and stat clocks*/
 141         SI_SUB_SYSV_SHM         = 0x6400000,    /* System V shared memory*/
 142         SI_SUB_SYSV_SEM         = 0x6800000,    /* System V semaphores*/
 143         SI_SUB_SYSV_MSG         = 0x6C00000,    /* System V message queues*/
 144         SI_SUB_P1003_1B         = 0x6E00000,    /* P1003.1B realtime */
 145         SI_SUB_PSEUDO           = 0x7000000,    /* pseudo devices*/
 146         SI_SUB_EXEC             = 0x7400000,    /* execve() handlers */
 147         SI_SUB_PROTO_BEGIN      = 0x8000000,    /* VNET initialization */
 148         SI_SUB_PROTO_PFIL       = 0x8100000,    /* Initialize pfil before FWs */
 149         SI_SUB_PROTO_IF         = 0x8400000,    /* interfaces*/
 150         SI_SUB_PROTO_DOMAININIT = 0x8600000,    /* domain registration system */
 151         SI_SUB_PROTO_MC         = 0x8700000,    /* Multicast */
 152         SI_SUB_PROTO_DOMAIN     = 0x8800000,    /* domains (address families?)*/
 153         SI_SUB_PROTO_FIREWALL   = 0x8806000,    /* Firewalls */
 154         SI_SUB_PROTO_IFATTACHDOMAIN = 0x8808000,/* domain dependent data init */
 155         SI_SUB_PROTO_END        = 0x8ffffff,    /* VNET helper functions */
 156         SI_SUB_KPROF            = 0x9000000,    /* kernel profiling*/
 157         SI_SUB_KICK_SCHEDULER   = 0xa000000,    /* start the timeout events*/
 158         SI_SUB_INT_CONFIG_HOOKS = 0xa800000,    /* Interrupts enabled config */
 159         SI_SUB_ROOT_CONF        = 0xb000000,    /* Find root devices */
 160         SI_SUB_INTRINSIC_POST   = 0xd000000,    /* proc 0 cleanup*/
 161         SI_SUB_SYSCALLS         = 0xd800000,    /* register system calls */
 162         SI_SUB_VNET_DONE        = 0xdc00000,    /* vnet registration complete */
 163         SI_SUB_KTHREAD_INIT     = 0xe000000,    /* init process*/
 164         SI_SUB_KTHREAD_PAGE     = 0xe400000,    /* pageout daemon*/
 165         SI_SUB_KTHREAD_VM       = 0xe800000,    /* vm daemon*/
 166         SI_SUB_KTHREAD_BUF      = 0xea00000,    /* buffer daemon*/
 167         SI_SUB_KTHREAD_UPDATE   = 0xec00000,    /* update daemon*/
 168         SI_SUB_KTHREAD_IDLE     = 0xee00000,    /* idle procs*/
 169 #ifndef EARLY_AP_STARTUP
 170         SI_SUB_SMP              = 0xf000000,    /* start the APs*/
 171 #endif
 172         SI_SUB_RACCTD           = 0xf100000,    /* start racctd*/
 173         SI_SUB_LAST             = 0xfffffff     /* final initialization */
 174 };
 175
 176
 177 /*
 178  * Some enumerated orders; "ANY" sorts last.
 179  */
 180 enum sysinit_elem_order {
 181         SI_ORDER_FIRST          = 0x0000000,    /* first*/
 182         SI_ORDER_SECOND         = 0x0000001,    /* second*/
 183         SI_ORDER_THIRD          = 0x0000002,    /* third*/
 184         SI_ORDER_FOURTH         = 0x0000003,    /* fourth*/
 185         SI_ORDER_MIDDLE         = 0x1000000,    /* somewhere in the middle */
 186         SI_ORDER_ANY            = 0xfffffff     /* last*/
 187 };
 188
 189
 190 /*
 191  * A system initialization call instance
 192  *
 193  * At the moment there is one instance of sysinit.  We probably do not
 194  * want two which is why this code is if'd out, but we definitely want
 195  * to discern SYSINIT's which take non-constant data pointers and
 196  * SYSINIT's which take constant data pointers,
 197  *
 198  * The C_* macros take functions expecting const void * arguments
 199  * while the non-C_* macros take functions expecting just void * arguments.
 200  *
 201  * With -Wcast-qual on, the compiler issues warnings:
 202  *      - if we pass non-const data or functions taking non-const data
 203  *        to a C_* macro.
 204  *
 205  *      - if we pass const data to the normal macros
 206  *
 207  * However, no warning is issued if we pass a function taking const data
 208  * through a normal non-const macro.  This is ok because the function is
 209  * saying it won't modify the data so we don't care whether the data is
 210  * modifiable or not.
 211  */
 212
 213 typedef void (*sysinit_nfunc_t)(void *);
 214 typedef void (*sysinit_cfunc_t)(const void *);
 215
 216 struct sysinit {
 217         enum sysinit_sub_id     subsystem;      /* subsystem identifier*/
 218         enum sysinit_elem_order order;          /* init order within subsystem*/
 219         sysinit_cfunc_t func;                   /* function             */
 220         const void      *udata;                 /* multiplexer/argument */
 221 };
 222
 223 /*
 224  * Default: no special processing
 225  *
 226  * The C_ version of SYSINIT is for data pointers to const
 227  * data ( and functions taking data pointers to const data ).
 228  * At the moment it is no different from SYSINIT and thus
 229  * still results in warnings.
 230  *
 231  * The casts are necessary to have the compiler produce the
 232  * correct warnings when -Wcast-qual is used.
 233  *
 234  */
 235 #ifdef TSLOG
 236 struct sysinit_tslog {
 237         sysinit_cfunc_t func;
 238         const void * data;
 239         const char * name;
 240 };
 241 static inline void
 242 sysinit_tslog_shim(const void * data)
 243 {
 244         const struct sysinit_tslog * x = data;
 245
 246         TSRAW(curthread, TS_ENTER, "SYSINIT", x->name);
 247         (x->func)(x->data);
 248         TSRAW(curthread, TS_EXIT, "SYSINIT", x->name);
 249 }
 250 #define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
 251         static struct sysinit_tslog uniquifier ## _sys_init_tslog = {   \
 252                 func,                                           \
 253                 (ident),                                        \
 254                 #uniquifier                                     \
 255         };                                                      \
 256         static struct sysinit uniquifier ## _sys_init = {       \
 257                 subsystem,                                      \
 258                 order,                                          \
 259                 sysinit_tslog_shim,                             \
 260                 &uniquifier ## _sys_init_tslog                  \
 261         };                                                      \
 262         DATA_WSET(sysinit_set,uniquifier ## _sys_init)
 263 #else
 264 #define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
 265         static struct sysinit uniquifier ## _sys_init = {       \
 266                 subsystem,                                      \
 267                 order,                                          \
 268                 func,                                           \
 269                 (ident)                                         \
 270         };                                                      \
 271         DATA_WSET(sysinit_set,uniquifier ## _sys_init)
 272 #endif
 273
 274 #define SYSINIT(uniquifier, subsystem, order, func, ident)      \
 275         C_SYSINIT(uniquifier, subsystem, order,                 \
 276         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))
 277
 278 /*
 279  * Called on module unload: no special processing
 280  */
 281 #define C_SYSUNINIT(uniquifier, subsystem, order, func, ident)  \
 282         static struct sysinit uniquifier ## _sys_uninit = {     \
 283                 subsystem,                                      \
 284                 order,                                          \
 285                 func,                                           \
 286                 (ident)                                         \
 287         };                                                      \
 288         DATA_WSET(sysuninit_set,uniquifier ## _sys_uninit)
 289
 290 #define SYSUNINIT(uniquifier, subsystem, order, func, ident)    \
 291         C_SYSUNINIT(uniquifier, subsystem, order,               \
 292         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))
 293
 294 void    sysinit_add(struct sysinit **set, struct sysinit **set_end);
 295
 296 /*
 297  * Infrastructure for tunable 'constants'.  Value may be specified at compile
 298  * time or kernel load time.  Rules relating tunables together can be placed
 299  * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_ANY.
 300  *
 301  * WARNING: developers should never use the reserved suffixes specified in
 302  * loader.conf(5) for any tunables or conflicts will result.
 303  */
 304
 305 /*
 306  * int
 307  * please avoid using for new tunables!
 308  */
 309 extern void tunable_int_init(void *);
 310 struct tunable_int {
 311         const char *path;
 312         int *var;
 313 };
 314 #define TUNABLE_INT(path, var)                                  \
 315         static struct tunable_int __CONCAT(__tunable_int_, __LINE__) = { \
 316                 (path),                                         \
 317                 (var),                                          \
 318         };                                                      \
 319         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 320             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int_init, \
 321             &__CONCAT(__tunable_int_, __LINE__))
 322
 323 #define TUNABLE_INT_FETCH(path, var)    getenv_int((path), (var))
 324
 325 /*
 326  * long
 327  */
 328 extern void tunable_long_init(void *);
 329 struct tunable_long {
 330         const char *path;
 331         long *var;
 332 };
 333 #define TUNABLE_LONG(path, var)                                 \
 334         static struct tunable_long __CONCAT(__tunable_long_, __LINE__) = { \
 335                 (path),                                         \
 336                 (var),                                          \
 337         };                                                      \
 338         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 339             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_long_init,\
 340             &__CONCAT(__tunable_long_, __LINE__))
 341
 342 #define TUNABLE_LONG_FETCH(path, var)   getenv_long((path), (var))
 343
 344 /*
 345  * unsigned long
 346  */
 347 extern void tunable_ulong_init(void *);
 348 struct tunable_ulong {
 349         const char *path;
 350         unsigned long *var;
 351 };
 352 #define TUNABLE_ULONG(path, var)                                \
 353         static struct tunable_ulong __CONCAT(__tunable_ulong_, __LINE__) = { \
 354                 (path),                                         \
 355                 (var),                                          \
 356         };                                                      \
 357         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 358             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_ulong_init, \
 359             &__CONCAT(__tunable_ulong_, __LINE__))
 360
 361 #define TUNABLE_ULONG_FETCH(path, var)  getenv_ulong((path), (var))
 362
 363 /*
 364  * int64_t
 365  */
 366 extern void tunable_int64_init(void *);
 367 struct tunable_int64 {
 368         const char *path;
 369         int64_t *var;
 370 };
 371 #define TUNABLE_INT64(path, var)                                \
 372         static struct tunable_int64 __CONCAT(__tunable_int64_, __LINE__) = { \
 373                 (path),                                         \
 374                 (var),                                          \
 375         };                                                      \
 376         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 377             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int64_init, \
 378             &__CONCAT(__tunable_int64_, __LINE__))
 379
 380 #define TUNABLE_INT64_FETCH(path, var)  getenv_int64((path), (var))
 381
 382 /*
 383  * uint64_t
 384  */
 385 extern void tunable_uint64_init(void *);
 386 struct tunable_uint64 {
 387         const char *path;
 388         uint64_t *var;
 389 };
 390 #define TUNABLE_UINT64(path, var)                               \
 391         static struct tunable_uint64 __CONCAT(__tunable_uint64_, __LINE__) = { \
 392                 (path),                                         \
 393                 (var),                                          \
 394         };                                                      \
 395         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 396             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_uint64_init, \
 397             &__CONCAT(__tunable_uint64_, __LINE__))
 398
 399 #define TUNABLE_UINT64_FETCH(path, var) getenv_uint64((path), (var))
 400
 401 /*
 402  * quad
 403  */
 404 extern void tunable_quad_init(void *);
 405 struct tunable_quad {
 406         const char *path;
 407         quad_t *var;
 408 };
 409 #define TUNABLE_QUAD(path, var)                                 \
 410         static struct tunable_quad __CONCAT(__tunable_quad_, __LINE__) = { \
 411                 (path),                                         \
 412                 (var),                                          \
 413         };                                                      \
 414         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 415             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_quad_init, \
 416             &__CONCAT(__tunable_quad_, __LINE__))
 417
 418 #define TUNABLE_QUAD_FETCH(path, var)   getenv_quad((path), (var))
 419
 420 extern void tunable_str_init(void *);
 421 struct tunable_str {
 422         const char *path;
 423         char *var;
 424         int size;
 425 };
 426 #define TUNABLE_STR(path, var, size)                            \
 427         static struct tunable_str __CONCAT(__tunable_str_, __LINE__) = { \
 428                 (path),                                         \
 429                 (var),                                          \
 430                 (size),                                         \
 431         };                                                      \
 432         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 433             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_str_init, \
 434             &__CONCAT(__tunable_str_, __LINE__))
 435
 436 #define TUNABLE_STR_FETCH(path, var, size)                      \
 437         getenv_string((path), (var), (size))
 438
 439 typedef void (*ich_func_t)(void *_arg);
 440
 441 struct intr_config_hook {
 442         TAILQ_ENTRY(intr_config_hook) ich_links;
 443         ich_func_t      ich_func;
 444         void            *ich_arg;
 445 };
 446
 447 int     config_intrhook_establish(struct intr_config_hook *hook);
 448 void    config_intrhook_disestablish(struct intr_config_hook *hook);
 449 void    config_intrhook_oneshot(ich_func_t _func, void *_arg);
 450
 451 #endif /* !_SYS_KERNEL_H_*/