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_COUNTER          = 0x1100000,    /* counter(9) is initialized */
  96         SI_SUB_KMEM             = 0x1800000,    /* kernel memory*/
  97         SI_SUB_HYPERVISOR       = 0x1A40000,    /*
  98                                                  * Hypervisor detection and
  99                                                  * virtualization support
 100                                                  * setup.
 101                                                  */
 102         SI_SUB_WITNESS          = 0x1A80000,    /* witness initialization */
 103         SI_SUB_MTX_POOL_DYNAMIC = 0x1AC0000,    /* dynamic mutex pool */
 104         SI_SUB_LOCK             = 0x1B00000,    /* various locks */
 105         SI_SUB_EVENTHANDLER     = 0x1C00000,    /* eventhandler init */
 106         SI_SUB_VNET_PRELINK     = 0x1E00000,    /* vnet init before modules */
 107         SI_SUB_KLD              = 0x2000000,    /* KLD and module setup */
 108         SI_SUB_CPU              = 0x2100000,    /* CPU resource(s)*/
 109         SI_SUB_RACCT            = 0x2110000,    /* resource accounting */
 110         SI_SUB_KDTRACE          = 0x2140000,    /* Kernel dtrace hooks */
 111         SI_SUB_RANDOM           = 0x2160000,    /* random number generator */
 112         SI_SUB_MAC              = 0x2180000,    /* TrustedBSD MAC subsystem */
 113         SI_SUB_MAC_POLICY       = 0x21C0000,    /* TrustedBSD MAC policies */
 114         SI_SUB_MAC_LATE         = 0x21D0000,    /* TrustedBSD MAC subsystem */
 115         SI_SUB_VNET             = 0x21E0000,    /* vnet 0 */
 116         SI_SUB_INTRINSIC        = 0x2200000,    /* proc 0*/
 117         SI_SUB_VM_CONF          = 0x2300000,    /* config VM, set limits*/
 118         SI_SUB_DDB_SERVICES     = 0x2380000,    /* capture, scripting, etc. */
 119         SI_SUB_RUN_QUEUE        = 0x2400000,    /* set up run queue*/
 120         SI_SUB_KTRACE           = 0x2480000,    /* ktrace */
 121         SI_SUB_OPENSOLARIS      = 0x2490000,    /* OpenSolaris compatibility */
 122         SI_SUB_AUDIT            = 0x24C0000,    /* audit */
 123         SI_SUB_CREATE_INIT      = 0x2500000,    /* create init process*/
 124         SI_SUB_SCHED_IDLE       = 0x2600000,    /* required idle procs */
 125         SI_SUB_MBUF             = 0x2700000,    /* mbuf subsystem */
 126         SI_SUB_INTR             = 0x2800000,    /* interrupt threads */
 127         SI_SUB_TASKQ            = 0x2880000,    /* task queues */
 128 #ifdef EARLY_AP_STARTUP
 129         SI_SUB_SMP              = 0x2900000,    /* start the APs*/
 130 #endif
 131         SI_SUB_SOFTINTR         = 0x2A00000,    /* start soft interrupt thread */
 132         SI_SUB_DEVFS            = 0x2F00000,    /* devfs ready for devices */
 133         SI_SUB_INIT_IF          = 0x3000000,    /* prep for net interfaces */
 134         SI_SUB_NETGRAPH         = 0x3010000,    /* Let Netgraph initialize */
 135         SI_SUB_DTRACE           = 0x3020000,    /* DTrace subsystem */
 136         SI_SUB_DTRACE_PROVIDER  = 0x3048000,    /* DTrace providers */
 137         SI_SUB_DTRACE_ANON      = 0x308C000,    /* DTrace anon enabling */
 138         SI_SUB_DRIVERS          = 0x3100000,    /* Let Drivers initialize */
 139         SI_SUB_CONFIGURE        = 0x3800000,    /* Configure devices */
 140         SI_SUB_VFS              = 0x4000000,    /* virtual filesystem*/
 141         SI_SUB_CLOCKS           = 0x4800000,    /* real time and stat clocks*/
 142         SI_SUB_SYSV_SHM         = 0x6400000,    /* System V shared memory*/
 143         SI_SUB_SYSV_SEM         = 0x6800000,    /* System V semaphores*/
 144         SI_SUB_SYSV_MSG         = 0x6C00000,    /* System V message queues*/
 145         SI_SUB_P1003_1B         = 0x6E00000,    /* P1003.1B realtime */
 146         SI_SUB_PSEUDO           = 0x7000000,    /* pseudo devices*/
 147         SI_SUB_EXEC             = 0x7400000,    /* execve() handlers */
 148         SI_SUB_PROTO_BEGIN      = 0x8000000,    /* VNET initialization */
 149         SI_SUB_PROTO_PFIL       = 0x8100000,    /* Initialize pfil before FWs */
 150         SI_SUB_PROTO_IF         = 0x8400000,    /* interfaces*/
 151         SI_SUB_PROTO_DOMAININIT = 0x8600000,    /* domain registration system */
 152         SI_SUB_PROTO_MC         = 0x8700000,    /* Multicast */
 153         SI_SUB_PROTO_DOMAIN     = 0x8800000,    /* domains (address families?)*/
 154         SI_SUB_PROTO_FIREWALL   = 0x8806000,    /* Firewalls */
 155         SI_SUB_PROTO_IFATTACHDOMAIN = 0x8808000,/* domain dependent data init */
 156         SI_SUB_PROTO_END        = 0x8ffffff,    /* VNET helper functions */
 157         SI_SUB_KPROF            = 0x9000000,    /* kernel profiling*/
 158         SI_SUB_KICK_SCHEDULER   = 0xa000000,    /* start the timeout events*/
 159         SI_SUB_INT_CONFIG_HOOKS = 0xa800000,    /* Interrupts enabled config */
 160         SI_SUB_ROOT_CONF        = 0xb000000,    /* Find root devices */
 161         SI_SUB_INTRINSIC_POST   = 0xd000000,    /* proc 0 cleanup*/
 162         SI_SUB_SYSCALLS         = 0xd800000,    /* register system calls */
 163         SI_SUB_VNET_DONE        = 0xdc00000,    /* vnet registration complete */
 164         SI_SUB_KTHREAD_INIT     = 0xe000000,    /* init process*/
 165         SI_SUB_KTHREAD_PAGE     = 0xe400000,    /* pageout daemon*/
 166         SI_SUB_KTHREAD_VM       = 0xe800000,    /* vm daemon*/
 167         SI_SUB_KTHREAD_BUF      = 0xea00000,    /* buffer daemon*/
 168         SI_SUB_KTHREAD_UPDATE   = 0xec00000,    /* update daemon*/
 169         SI_SUB_KTHREAD_IDLE     = 0xee00000,    /* idle procs*/
 170 #ifndef EARLY_AP_STARTUP
 171         SI_SUB_SMP              = 0xf000000,    /* start the APs*/
 172 #endif
 173         SI_SUB_RACCTD           = 0xf100000,    /* start racctd*/
 174         SI_SUB_LAST             = 0xfffffff     /* final initialization */
 175 };
 176
 177
 178 /*
 179  * Some enumerated orders; "ANY" sorts last.
 180  */
 181 enum sysinit_elem_order {
 182         SI_ORDER_FIRST          = 0x0000000,    /* first*/
 183         SI_ORDER_SECOND         = 0x0000001,    /* second*/
 184         SI_ORDER_THIRD          = 0x0000002,    /* third*/
 185         SI_ORDER_FOURTH         = 0x0000003,    /* fourth*/
 186         SI_ORDER_FIFTH          = 0x0000004,    /* fifth*/
 187         SI_ORDER_SIXTH          = 0x0000005,    /* sixth*/
 188         SI_ORDER_SEVENTH        = 0x0000006,    /* seventh*/
 189         SI_ORDER_EIGHTH         = 0x0000007,    /* eighth*/
 190         SI_ORDER_MIDDLE         = 0x1000000,    /* somewhere in the middle */
 191         SI_ORDER_ANY            = 0xfffffff     /* last*/
 192 };
 193
 194
 195 /*
 196  * A system initialization call instance
 197  *
 198  * At the moment there is one instance of sysinit.  We probably do not
 199  * want two which is why this code is if'd out, but we definitely want
 200  * to discern SYSINIT's which take non-constant data pointers and
 201  * SYSINIT's which take constant data pointers,
 202  *
 203  * The C_* macros take functions expecting const void * arguments
 204  * while the non-C_* macros take functions expecting just void * arguments.
 205  *
 206  * With -Wcast-qual on, the compiler issues warnings:
 207  *      - if we pass non-const data or functions taking non-const data
 208  *        to a C_* macro.
 209  *
 210  *      - if we pass const data to the normal macros
 211  *
 212  * However, no warning is issued if we pass a function taking const data
 213  * through a normal non-const macro.  This is ok because the function is
 214  * saying it won't modify the data so we don't care whether the data is
 215  * modifiable or not.
 216  */
 217
 218 typedef void (*sysinit_nfunc_t)(void *);
 219 typedef void (*sysinit_cfunc_t)(const void *);
 220
 221 struct sysinit {
 222         enum sysinit_sub_id     subsystem;      /* subsystem identifier*/
 223         enum sysinit_elem_order order;          /* init order within subsystem*/
 224         sysinit_cfunc_t func;                   /* function             */
 225         const void      *udata;                 /* multiplexer/argument */
 226 };
 227
 228 /*
 229  * Default: no special processing
 230  *
 231  * The C_ version of SYSINIT is for data pointers to const
 232  * data ( and functions taking data pointers to const data ).
 233  * At the moment it is no different from SYSINIT and thus
 234  * still results in warnings.
 235  *
 236  * The casts are necessary to have the compiler produce the
 237  * correct warnings when -Wcast-qual is used.
 238  *
 239  */
 240 #ifdef TSLOG
 241 struct sysinit_tslog {
 242         sysinit_cfunc_t func;
 243         const void * data;
 244         const char * name;
 245 };
 246 static inline void
 247 sysinit_tslog_shim(const void * data)
 248 {
 249         const struct sysinit_tslog * x = data;
 250
 251         TSRAW(curthread, TS_ENTER, "SYSINIT", x->name);
 252         (x->func)(x->data);
 253         TSRAW(curthread, TS_EXIT, "SYSINIT", x->name);
 254 }
 255 #define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
 256         static struct sysinit_tslog uniquifier ## _sys_init_tslog = {   \
 257                 func,                                           \
 258                 (ident),                                        \
 259                 #uniquifier                                     \
 260         };                                                      \
 261         static struct sysinit uniquifier ## _sys_init = {       \
 262                 subsystem,                                      \
 263                 order,                                          \
 264                 sysinit_tslog_shim,                             \
 265                 &uniquifier ## _sys_init_tslog                  \
 266         };                                                      \
 267         DATA_WSET(sysinit_set,uniquifier ## _sys_init)
 268 #else
 269 #define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
 270         static struct sysinit uniquifier ## _sys_init = {       \
 271                 subsystem,                                      \
 272                 order,                                          \
 273                 func,                                           \
 274                 (ident)                                         \
 275         };                                                      \
 276         DATA_WSET(sysinit_set,uniquifier ## _sys_init)
 277 #endif
 278
 279 #define SYSINIT(uniquifier, subsystem, order, func, ident)      \
 280         C_SYSINIT(uniquifier, subsystem, order,                 \
 281         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))
 282
 283 /*
 284  * Called on module unload: no special processing
 285  */
 286 #define C_SYSUNINIT(uniquifier, subsystem, order, func, ident)  \
 287         static struct sysinit uniquifier ## _sys_uninit = {     \
 288                 subsystem,                                      \
 289                 order,                                          \
 290                 func,                                           \
 291                 (ident)                                         \
 292         };                                                      \
 293         DATA_WSET(sysuninit_set,uniquifier ## _sys_uninit)
 294
 295 #define SYSUNINIT(uniquifier, subsystem, order, func, ident)    \
 296         C_SYSUNINIT(uniquifier, subsystem, order,               \
 297         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))
 298
 299 void    sysinit_add(struct sysinit **set, struct sysinit **set_end);
 300
 301 /*
 302  * Infrastructure for tunable 'constants'.  Value may be specified at compile
 303  * time or kernel load time.  Rules relating tunables together can be placed
 304  * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_ANY.
 305  *
 306  * WARNING: developers should never use the reserved suffixes specified in
 307  * loader.conf(5) for any tunables or conflicts will result.
 308  */
 309
 310 /*
 311  * int
 312  * please avoid using for new tunables!
 313  */
 314 extern void tunable_int_init(void *);
 315 struct tunable_int {
 316         const char *path;
 317         int *var;
 318 };
 319 #define TUNABLE_INT(path, var)                                  \
 320         static struct tunable_int __CONCAT(__tunable_int_, __LINE__) = { \
 321                 (path),                                         \
 322                 (var),                                          \
 323         };                                                      \
 324         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 325             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int_init, \
 326             &__CONCAT(__tunable_int_, __LINE__))
 327
 328 #define TUNABLE_INT_FETCH(path, var)    getenv_int((path), (var))
 329
 330 /*
 331  * long
 332  */
 333 extern void tunable_long_init(void *);
 334 struct tunable_long {
 335         const char *path;
 336         long *var;
 337 };
 338 #define TUNABLE_LONG(path, var)                                 \
 339         static struct tunable_long __CONCAT(__tunable_long_, __LINE__) = { \
 340                 (path),                                         \
 341                 (var),                                          \
 342         };                                                      \
 343         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 344             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_long_init,\
 345             &__CONCAT(__tunable_long_, __LINE__))
 346
 347 #define TUNABLE_LONG_FETCH(path, var)   getenv_long((path), (var))
 348
 349 /*
 350  * unsigned long
 351  */
 352 extern void tunable_ulong_init(void *);
 353 struct tunable_ulong {
 354         const char *path;
 355         unsigned long *var;
 356 };
 357 #define TUNABLE_ULONG(path, var)                                \
 358         static struct tunable_ulong __CONCAT(__tunable_ulong_, __LINE__) = { \
 359                 (path),                                         \
 360                 (var),                                          \
 361         };                                                      \
 362         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 363             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_ulong_init, \
 364             &__CONCAT(__tunable_ulong_, __LINE__))
 365
 366 #define TUNABLE_ULONG_FETCH(path, var)  getenv_ulong((path), (var))
 367
 368 /*
 369  * int64_t
 370  */
 371 extern void tunable_int64_init(void *);
 372 struct tunable_int64 {
 373         const char *path;
 374         int64_t *var;
 375 };
 376 #define TUNABLE_INT64(path, var)                                \
 377         static struct tunable_int64 __CONCAT(__tunable_int64_, __LINE__) = { \
 378                 (path),                                         \
 379                 (var),                                          \
 380         };                                                      \
 381         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 382             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int64_init, \
 383             &__CONCAT(__tunable_int64_, __LINE__))
 384
 385 #define TUNABLE_INT64_FETCH(path, var)  getenv_int64((path), (var))
 386
 387 /*
 388  * uint64_t
 389  */
 390 extern void tunable_uint64_init(void *);
 391 struct tunable_uint64 {
 392         const char *path;
 393         uint64_t *var;
 394 };
 395 #define TUNABLE_UINT64(path, var)                               \
 396         static struct tunable_uint64 __CONCAT(__tunable_uint64_, __LINE__) = { \
 397                 (path),                                         \
 398                 (var),                                          \
 399         };                                                      \
 400         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 401             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_uint64_init, \
 402             &__CONCAT(__tunable_uint64_, __LINE__))
 403
 404 #define TUNABLE_UINT64_FETCH(path, var) getenv_uint64((path), (var))
 405
 406 /*
 407  * quad
 408  */
 409 extern void tunable_quad_init(void *);
 410 struct tunable_quad {
 411         const char *path;
 412         quad_t *var;
 413 };
 414 #define TUNABLE_QUAD(path, var)                                 \
 415         static struct tunable_quad __CONCAT(__tunable_quad_, __LINE__) = { \
 416                 (path),                                         \
 417                 (var),                                          \
 418         };                                                      \
 419         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 420             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_quad_init, \
 421             &__CONCAT(__tunable_quad_, __LINE__))
 422
 423 #define TUNABLE_QUAD_FETCH(path, var)   getenv_quad((path), (var))
 424
 425 extern void tunable_str_init(void *);
 426 struct tunable_str {
 427         const char *path;
 428         char *var;
 429         int size;
 430 };
 431 #define TUNABLE_STR(path, var, size)                            \
 432         static struct tunable_str __CONCAT(__tunable_str_, __LINE__) = { \
 433                 (path),                                         \
 434                 (var),                                          \
 435                 (size),                                         \
 436         };                                                      \
 437         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 438             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_str_init, \
 439             &__CONCAT(__tunable_str_, __LINE__))
 440
 441 #define TUNABLE_STR_FETCH(path, var, size)                      \
 442         getenv_string((path), (var), (size))
 443
 444 typedef void (*ich_func_t)(void *_arg);
 445
 446 struct intr_config_hook {
 447         TAILQ_ENTRY(intr_config_hook) ich_links;
 448         ich_func_t      ich_func;
 449         void            *ich_arg;
 450 };
 451
 452 int     config_intrhook_establish(struct intr_config_hook *hook);
 453 void    config_intrhook_disestablish(struct intr_config_hook *hook);
 454 void    config_intrhook_oneshot(ich_func_t _func, void *_arg);
 455
 456 #endif /* !_SYS_KERNEL_H_*/