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_HYPERVISOR       = 0x1A40000,    /*
 100                                                  * Hypervisor detection and
 101                                                  * virtualization support
 102                                                  * setup.
 103                                                  */
 104         SI_SUB_WITNESS          = 0x1A80000,    /* witness initialization */
 105         SI_SUB_MTX_POOL_DYNAMIC = 0x1AC0000,    /* dynamic mutex pool */
 106         SI_SUB_LOCK             = 0x1B00000,    /* various locks */
 107         SI_SUB_EVENTHANDLER     = 0x1C00000,    /* eventhandler init */
 108         SI_SUB_VNET_PRELINK     = 0x1E00000,    /* vnet init before modules */
 109         SI_SUB_KLD              = 0x2000000,    /* KLD and module setup */
 110         SI_SUB_CPU              = 0x2100000,    /* CPU resource(s)*/
 111         SI_SUB_RACCT            = 0x2110000,    /* resource accounting */
 112         SI_SUB_RANDOM           = 0x2120000,    /* random number generator */
 113         SI_SUB_KDTRACE          = 0x2140000,    /* Kernel dtrace hooks */
 114         SI_SUB_MAC              = 0x2180000,    /* TrustedBSD MAC subsystem */
 115         SI_SUB_MAC_POLICY       = 0x21C0000,    /* TrustedBSD MAC policies */
 116         SI_SUB_MAC_LATE         = 0x21D0000,    /* TrustedBSD MAC subsystem */
 117         SI_SUB_VNET             = 0x21E0000,    /* vnet 0 */
 118         SI_SUB_INTRINSIC        = 0x2200000,    /* proc 0*/
 119         SI_SUB_VM_CONF          = 0x2300000,    /* config VM, set limits*/
 120         SI_SUB_DDB_SERVICES     = 0x2380000,    /* capture, scripting, etc. */
 121         SI_SUB_RUN_QUEUE        = 0x2400000,    /* set up run queue*/
 122         SI_SUB_KTRACE           = 0x2480000,    /* ktrace */
 123         SI_SUB_OPENSOLARIS      = 0x2490000,    /* OpenSolaris compatibility */
 124         SI_SUB_CYCLIC           = 0x24A0000,    /* Cyclic timers */
 125         SI_SUB_AUDIT            = 0x24C0000,    /* audit */
 126         SI_SUB_CREATE_INIT      = 0x2500000,    /* create init process*/
 127         SI_SUB_SCHED_IDLE       = 0x2600000,    /* required idle procs */
 128         SI_SUB_MBUF             = 0x2700000,    /* mbuf subsystem */
 129         SI_SUB_INTR             = 0x2800000,    /* interrupt threads */
 130         SI_SUB_TASKQ            = 0x2880000,    /* task queues */
 131         SI_SUB_ACL              = 0x2900000,    /* start for filesystem ACLs */
 132         SI_SUB_SOFTINTR         = 0x2A00000,    /* start soft interrupt thread */
 133         SI_SUB_DEVFS            = 0x2F00000,    /* devfs ready for devices */
 134         SI_SUB_INIT_IF          = 0x3000000,    /* prep for net interfaces */
 135         SI_SUB_NETGRAPH         = 0x3010000,    /* Let Netgraph initialize */
 136         SI_SUB_DTRACE           = 0x3020000,    /* DTrace subsystem */
 137         SI_SUB_DTRACE_PROVIDER  = 0x3048000,    /* DTrace providers */
 138         SI_SUB_DTRACE_ANON      = 0x308C000,    /* DTrace anon enabling */
 139         SI_SUB_DRIVERS          = 0x3100000,    /* Let Drivers initialize */
 140         SI_SUB_CONFIGURE        = 0x3800000,    /* Configure devices */
 141         SI_SUB_VFS              = 0x4000000,    /* virtual filesystem*/
 142         SI_SUB_CLOCKS           = 0x4800000,    /* real time and stat clocks*/
 143         SI_SUB_CLIST            = 0x5800000,    /* clists*/
 144         SI_SUB_SYSV_SHM         = 0x6400000,    /* System V shared memory*/
 145         SI_SUB_SYSV_SEM         = 0x6800000,    /* System V semaphores*/
 146         SI_SUB_SYSV_MSG         = 0x6C00000,    /* System V message queues*/
 147         SI_SUB_P1003_1B         = 0x6E00000,    /* P1003.1B realtime */
 148         SI_SUB_PSEUDO           = 0x7000000,    /* pseudo devices*/
 149         SI_SUB_EXEC             = 0x7400000,    /* execve() handlers */
 150         SI_SUB_PROTO_BEGIN      = 0x8000000,    /* VNET initialization */
 151         SI_SUB_PROTO_IF         = 0x8400000,    /* interfaces*/
 152         SI_SUB_PROTO_DOMAININIT = 0x8600000,    /* domain registration system */
 153         SI_SUB_PROTO_DOMAIN     = 0x8800000,    /* domains (address families?)*/
 154         SI_SUB_PROTO_IFATTACHDOMAIN     = 0x8800001,    /* 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_DUMP_CONF        = 0xb200000,    /* Find dump devices */
 161         SI_SUB_RAID             = 0xb380000,    /* Configure GEOM classes */
 162         SI_SUB_SWAP             = 0xc000000,    /* swap */
 163         SI_SUB_INTRINSIC_POST   = 0xd000000,    /* proc 0 cleanup*/
 164         SI_SUB_SYSCALLS         = 0xd800000,    /* register system calls */
 165         SI_SUB_VNET_DONE        = 0xdc00000,    /* vnet registration complete */
 166         SI_SUB_KTHREAD_INIT     = 0xe000000,    /* init process*/
 167         SI_SUB_KTHREAD_PAGE     = 0xe400000,    /* pageout daemon*/
 168         SI_SUB_KTHREAD_VM       = 0xe800000,    /* vm daemon*/
 169         SI_SUB_KTHREAD_BUF      = 0xea00000,    /* buffer daemon*/
 170         SI_SUB_KTHREAD_UPDATE   = 0xec00000,    /* update daemon*/
 171         SI_SUB_KTHREAD_IDLE     = 0xee00000,    /* idle procs*/
 172         SI_SUB_SMP              = 0xf000000,    /* start the APs*/
 173         SI_SUB_RACCTD           = 0xf100000,    /* start raccd*/
 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 #define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
 241         static struct sysinit uniquifier ## _sys_init = {       \
 242                 subsystem,                                      \
 243                 order,                                          \
 244                 func,                                           \
 245                 (ident)                                         \
 246         };                                                      \
 247         DATA_SET(sysinit_set,uniquifier ## _sys_init)
 248
 249 #define SYSINIT(uniquifier, subsystem, order, func, ident)      \
 250         C_SYSINIT(uniquifier, subsystem, order,                 \
 251         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))
 252
 253 /*
 254  * Called on module unload: no special processing
 255  */
 256 #define C_SYSUNINIT(uniquifier, subsystem, order, func, ident)  \
 257         static struct sysinit uniquifier ## _sys_uninit = {     \
 258                 subsystem,                                      \
 259                 order,                                          \
 260                 func,                                           \
 261                 (ident)                                         \
 262         };                                                      \
 263         DATA_SET(sysuninit_set,uniquifier ## _sys_uninit)
 264
 265 #define SYSUNINIT(uniquifier, subsystem, order, func, ident)    \
 266         C_SYSUNINIT(uniquifier, subsystem, order,               \
 267         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))
 268
 269 void    sysinit_add(struct sysinit **set, struct sysinit **set_end);
 270
 271 /*
 272  * Infrastructure for tunable 'constants'.  Value may be specified at compile
 273  * time or kernel load time.  Rules relating tunables together can be placed
 274  * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_ANY.
 275  *
 276  * WARNING: developers should never use the reserved suffixes specified in
 277  * loader.conf(5) for any tunables or conflicts will result.
 278  */
 279
 280 /*
 281  * int
 282  * please avoid using for new tunables!
 283  */
 284 extern void tunable_int_init(void *);
 285 struct tunable_int {
 286         const char *path;
 287         int *var;
 288 };
 289 #define TUNABLE_INT(path, var)                                  \
 290         static struct tunable_int __CONCAT(__tunable_int_, __LINE__) = { \
 291                 (path),                                         \
 292                 (var),                                          \
 293         };                                                      \
 294         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 295             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int_init, \
 296             &__CONCAT(__tunable_int_, __LINE__))
 297
 298 #define TUNABLE_INT_FETCH(path, var)    getenv_int((path), (var))
 299
 300 /*
 301  * long
 302  */
 303 extern void tunable_long_init(void *);
 304 struct tunable_long {
 305         const char *path;
 306         long *var;
 307 };
 308 #define TUNABLE_LONG(path, var)                                 \
 309         static struct tunable_long __CONCAT(__tunable_long_, __LINE__) = { \
 310                 (path),                                         \
 311                 (var),                                          \
 312         };                                                      \
 313         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 314             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_long_init,\
 315             &__CONCAT(__tunable_long_, __LINE__))
 316
 317 #define TUNABLE_LONG_FETCH(path, var)   getenv_long((path), (var))
 318
 319 /*
 320  * unsigned long
 321  */
 322 extern void tunable_ulong_init(void *);
 323 struct tunable_ulong {
 324         const char *path;
 325         unsigned long *var;
 326 };
 327 #define TUNABLE_ULONG(path, var)                                \
 328         static struct tunable_ulong __CONCAT(__tunable_ulong_, __LINE__) = { \
 329                 (path),                                         \
 330                 (var),                                          \
 331         };                                                      \
 332         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 333             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_ulong_init, \
 334             &__CONCAT(__tunable_ulong_, __LINE__))
 335
 336 #define TUNABLE_ULONG_FETCH(path, var)  getenv_ulong((path), (var))
 337
 338 /*
 339  * quad
 340  */
 341 extern void tunable_quad_init(void *);
 342 struct tunable_quad {
 343         const char *path;
 344         quad_t *var;
 345 };
 346 #define TUNABLE_QUAD(path, var)                                 \
 347         static struct tunable_quad __CONCAT(__tunable_quad_, __LINE__) = { \
 348                 (path),                                         \
 349                 (var),                                          \
 350         };                                                      \
 351         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 352             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_quad_init, \
 353             &__CONCAT(__tunable_quad_, __LINE__))
 354
 355 #define TUNABLE_QUAD_FETCH(path, var)   getenv_quad((path), (var))
 356
 357 extern void tunable_str_init(void *);
 358 struct tunable_str {
 359         const char *path;
 360         char *var;
 361         int size;
 362 };
 363 #define TUNABLE_STR(path, var, size)                            \
 364         static struct tunable_str __CONCAT(__tunable_str_, __LINE__) = { \
 365                 (path),                                         \
 366                 (var),                                          \
 367                 (size),                                         \
 368         };                                                      \
 369         SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
 370             SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_str_init, \
 371             &__CONCAT(__tunable_str_, __LINE__))
 372
 373 #define TUNABLE_STR_FETCH(path, var, size)                      \
 374         getenv_string((path), (var), (size))
 375
 376 struct intr_config_hook {
 377         TAILQ_ENTRY(intr_config_hook) ich_links;
 378         void    (*ich_func)(void *arg);
 379         void    *ich_arg;
 380 };
 381
 382 int     config_intrhook_establish(struct intr_config_hook *hook);
 383 void    config_intrhook_disestablish(struct intr_config_hook *hook);
 384
 385 #endif /* !_SYS_KERNEL_H_*/