sys/sys/kernel.h

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