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: src/sys/sys/kernel.h,v 1.63.2.9 2002/07/02 23:00:30 archie Exp $
  43  */
  44
  45 #ifndef _SYS_KERNEL_H_
  46 #define _SYS_KERNEL_H_
  47
  48 #ifndef _KERNEL
  49 #error "This file should not be included by userland programs."
  50 #else
  51
  52 #ifndef _SYS_PARAM_H_
  53 #include <sys/param.h>
  54 #endif
  55 #ifndef _SYS_LINKER_SET_H_
  56 #include <sys/linker_set.h>
  57 #endif
  58
  59 #ifndef _SYS_QUEUE_H_
  60 #include <sys/queue.h>
  61 #endif
  62
  63 /* Global variables for the kernel. */
  64
  65 /* 1.1 */
  66 extern unsigned long hostid;
  67 extern char hostname[MAXHOSTNAMELEN];
  68 extern int hostnamelen;
  69 extern char domainname[MAXHOSTNAMELEN];
  70 extern int domainnamelen;
  71 extern char kernelname[MAXPATHLEN];
  72
  73 /* 1.2 */
  74 extern struct timespec boottime;
  75
  76 extern struct timezone tz;                      /* XXX */
  77
  78 extern int ustick;                      /* usec per tick (1000000 / hz) */
  79 extern int nstick;                      /* nsec per tick (1000000000 / hz) */
  80 extern int tickadj;                     /* "standard" clock skew, us./tick */
  81 extern int hz;                          /* system clock's frequency */
  82 extern int psratio;                     /* ratio: prof / stat */
  83 extern int stathz;                      /* statistics clock's frequency */
  84 extern int profhz;                      /* profiling clock's frequency */
  85 extern int ticks;
  86 extern int lbolt;                       /* once a second sleep address */
  87 extern void *lbolt_syncer;              /* approx 1 hz but may be sped up */
  88 extern enum vmm_guest_type vmm_guest;   /* Running as virtual machine guest? */
  89
  90 enum vmm_guest_type {
  91         VMM_GUEST_NONE = 0,
  92         VMM_GUEST_QEMU,
  93         VMM_GUEST_PLEX86,
  94         VMM_GUEST_BOCHS,
  95         VMM_GUEST_XEN,
  96         VMM_GUEST_BHYVE,
  97         VMM_GUEST_KVM,
  98         VMM_GUEST_VMWARE,
  99         VMM_GUEST_VPC,
 100         VMM_GUEST_VBOX,
 101         VMM_GUEST_PARALLELS,
 102         VMM_GUEST_VKERNEL,
 103         VMM_GUEST_UNKNOWN,
 104         VMM_GUEST_LAST
 105 };
 106
 107 /*
 108  * Enumerated types for known system startup interfaces.
 109  *
 110  * Startup occurs in ascending numeric order; the list entries are
 111  * sorted prior to attempting startup to guarantee order.  Items
 112  * of the same level are arbitrated for order based on the 'order'
 113  * element.
 114  *
 115  * These numbers are arbitrary and are chosen ONLY for ordering; the
 116  * enumeration values are explicit rather than implicit to provide
 117  * for binary compatibility with inserted elements.
 118  *
 119  * The SI_SUB_RUN_SCHEDULER value must have the highest lexical value.
 120  */
 121 enum sysinit_sub_id {
 122         /*
 123          * Special cased
 124          */
 125         SI_SPECIAL_DUMMY        = 0x0000000,    /* not executed; for linker*/
 126         SI_SPECIAL_DONE         = 0x0000001,    /* flag sysinit completion */
 127
 128         /*
 129          * Memory management subsystems.
 130          */
 131         SI_BOOT1_TUNABLES       = 0x0700000,    /* establish tunable values */
 132         SI_BOOT1_COPYRIGHT      = 0x0800000,    /* first use of console*/
 133         SI_BOOT1_LOCK           = 0x0900000,    /* lockmgr locks and tokens */
 134         SI_BOOT1_VM             = 0x1000000,    /* virtual memory system init*/
 135         SI_BOOT1_ALLOCATOR      = 0x1400000,    /* slab allocator */
 136         SI_BOOT1_KMALLOC        = 0x1600000,    /* kmalloc inits */
 137         SI_BOOT1_POST           = 0x1800000,    /* post boot1 inits */
 138
 139         /*
 140          * Fickle ordering.  objcache and softclock need to know what
 141          * ncpus is to initialize properly, clocks (e.g. hardclock)
 142          * need softclock to work, and we can't finish initializing
 143          * the APs until the system clock has been initialized.
 144          * Also, clock registration and smp configuration registration
 145          * must occur before SMP.  Messy messy.
 146          */
 147         SI_BOOT2_LEAVE_CRIT     = 0x1900000,
 148         SI_BOOT2_PRESMP         = 0x1a00000,    /* register SMP configs */
 149         SI_BOOT2_START_CPU      = 0x1a40000,    /* start CPU (BSP) */
 150         SI_BOOT2_LAPIC          = 0x1a50000,    /* configure Local APIC */
 151         SI_BOOT2_START_APS      = 0x1a60000,    /* start all APs */
 152         SI_BOOT2_IOAPIC         = 0x1a70000,    /* configure I/O APIC */
 153         SI_BOOT2_FINISH_PIC     = 0x1a80000,    /* finish PIC configure */
 154         SI_BOOT2_FINISH_CPU     = 0x1a90000,    /* finish CPU startup */
 155         SI_BOOT2_CLOCKREG       = 0x1ac0000,    /* register available clocks */
 156         SI_BOOT2_OBJCACHE       = 0x1b00000,
 157         SI_BOOT2_SOFTCLOCK      = 0x1b80000,
 158         SI_BOOT2_CLOCKS         = 0x1c00000,    /* select & start clocks */
 159         SI_BOOT2_FINISH_SMP     = 0x1c80000,    /* SMP go (& synch clocks) */
 160
 161         /*
 162          * Finish up core kernel initialization and set up the process
 163          * abstraction.
 164          */
 165         SI_BOOT2_BIOS           = 0x1d00000,
 166         SI_BOOT2_MACHDEP        = 0x1d80000,
 167         SI_BOOT2_KLD            = 0x1e00000,
 168         SI_BOOT2_CPU_TOPOLOGY   = 0x1e40000,
 169         SI_BOOT2_USCHED         = 0x1e80000,
 170         SI_BOOT2_PROC0          = 0x1f00000,
 171
 172         /*
 173          * Continue with miscellanious system initialization
 174          */
 175         SI_SUB_CREATE_INIT      = 0x2300000,    /* create the init process */
 176         SI_SUB_PRE_DRIVERS      = 0x2380000,
 177         SI_SUB_DRIVERS          = 0x2400000,    /* Let Drivers initialize */
 178         SI_SUB_CONFIGURE        = 0x3800000,    /* Configure devices */
 179         SI_SUB_ISWARM           = 0x3c00000,    /* No longer in cold boot */
 180         SI_SUB_VFS              = 0x4000000,    /* virtual file system*/
 181         SI_SUB_HELPER_THREADS   = 0x5400000,    /* misc helper threads */
 182         SI_SUB_CLIST            = 0x5800000,    /* clists*/
 183         SI_SUB_SYSV_SHM         = 0x6400000,    /* System V shared memory*/
 184         SI_SUB_SYSV_SEM         = 0x6800000,    /* System V semaphores*/
 185         SI_SUB_SYSV_MSG         = 0x6C00000,    /* System V message queues*/
 186         SI_SUB_P1003_1B         = 0x6E00000,    /* P1003.1B realtime */
 187         SI_SUB_PSEUDO           = 0x7000000,    /* pseudo devices*/
 188         SI_SUB_EXEC             = 0x7400000,    /* execve() handlers */
 189         SI_SUB_PROTO_IF         = 0x8400000,    /* interfaces */
 190         SI_SUB_PROTO_DOMAIN     = 0x8800000,    /* domains (address families?)*/
 191         SI_SUB_PROTO_IFATTACHDOMAIN
 192                                 = 0x8800001,    /* domain dependent data init */
 193         SI_SUB_PROTO_END        = 0x8ffffff,    /* network protocol post-init */
 194         SI_SUB_KPROF            = 0x9000000,    /* kernel profiling*/
 195         SI_SUB_KICK_SCHEDULER   = 0xa000000,    /* start the timeout events*/
 196         SI_SUB_INT_CONFIG_HOOKS = 0xa800000,    /* Interrupts enabled config */
 197
 198         /*
 199          * Root filesystem setup, finish up with the major system
 200          * demons.
 201          */
 202         SI_SUB_ROOT_CONF        = 0xb000000,    /* Find root devices */
 203         SI_SUB_DUMP_CONF        = 0xb200000,    /* Find dump devices */
 204         SI_SUB_RAID             = 0xb300000,    /* Configure vinum */
 205         SI_SUB_DM_TARGETS       = 0xb3a0000,    /* configure dm targets */
 206         SI_SUB_MOUNT_ROOT       = 0xb400000,    /* root mount*/
 207         SI_SUB_PROC0_POST       = 0xd000000,    /* proc 0 cleanup*/
 208         SI_SUB_KTHREAD_INIT     = 0xe000000,    /* init process*/
 209         SI_SUB_KTHREAD_PAGE     = 0xe400000,    /* pageout daemon*/
 210         SI_SUB_KTHREAD_VM       = 0xe800000,    /* vm daemon*/
 211         SI_SUB_KTHREAD_BUF      = 0xea00000,    /* buffer daemon*/
 212         SI_SUB_KTHREAD_UPDATE   = 0xec00000,    /* update daemon*/
 213         SI_SUB_KTHREAD_IDLE     = 0xee00000,    /* idle procs*/
 214         SI_SUB_RUN_SCHEDULER    = 0xfffffff     /* scheduler: no return*/
 215 };
 216
 217
 218 /*
 219  * Some enumerated orders; "ANY" sorts last.
 220  */
 221 enum sysinit_elem_order {
 222         SI_ORDER_FIRST          = 0x0000000,    /* first*/
 223         SI_ORDER_SECOND         = 0x0000001,    /* second*/
 224         SI_ORDER_THIRD          = 0x0000002,    /* third*/
 225         SI_ORDER_MIDDLE         = 0x1000000,    /* somewhere in the middle */
 226         SI_ORDER_ANY            = 0xfffffff     /* last*/
 227 };
 228
 229
 230 /*
 231  * A system initialization call instance
 232  *
 233  * At the moment there is one instance of sysinit.  We probably do not
 234  * want two which is why this code is if'd out, but we definitely want
 235  * to discern SYSINIT's which take non-constant data pointers and
 236  * SYSINIT's which take constant data pointers,
 237  *
 238  * The C_* macros take functions expecting const void * arguments
 239  * while the non-C_* macros take functions expecting just void * arguments.
 240  *
 241  * With -Wcast-qual on, the compiler issues warnings:
 242  *      - if we pass non-const data or functions taking non-const data
 243  *        to a C_* macro.
 244  *
 245  *      - if we pass const data to the normal macros
 246  *
 247  * However, no warning is issued if we pass a function taking const data
 248  * through a normal non-const macro.  This is ok because the function is
 249  * saying it won't modify the data so we don't care whether the data is
 250  * modifiable or not.
 251  */
 252
 253 typedef void (*sysinit_nfunc_t) (void *);
 254 typedef void (*sysinit_cfunc_t) (const void *);
 255
 256 struct sysinit {
 257         unsigned int    subsystem;              /* subsystem identifier*/
 258         unsigned int    order;                  /* init order within subsystem*/
 259         sysinit_cfunc_t func;                   /* function             */
 260         const void      *udata;                 /* multiplexer/argument */
 261         const char      *name;
 262 };
 263
 264 /*
 265  * Default: no special processing
 266  *
 267  * The C_ version of SYSINIT is for data pointers to const
 268  * data ( and functions taking data pointers to const data ).
 269  * At the moment it is no different from SYSINIT and thus
 270  * still results in warnings.
 271  *
 272  * The casts are necessary to have the compiler produce the
 273  * correct warnings when -Wcast-qual is used.
 274  *
 275  */
 276 #define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
 277         static struct sysinit uniquifier ## _sys_init = {       \
 278                 subsystem,                                      \
 279                 order,                                          \
 280                 func,                                           \
 281                 ident,                                          \
 282                 #uniquifier                                     \
 283         };                                                      \
 284         DATA_SET(sysinit_set,uniquifier ## _sys_init);
 285
 286 #define SYSINIT(uniquifier, subsystem, order, func, ident)      \
 287         C_SYSINIT(uniquifier, subsystem, order,                 \
 288         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
 289
 290 /*
 291  * Called on module unload: no special processing
 292  */
 293 #define C_SYSUNINIT(uniquifier, subsystem, order, func, ident)  \
 294         static struct sysinit uniquifier ## _sys_uninit = {     \
 295                 subsystem,                                      \
 296                 order,                                          \
 297                 func,                                           \
 298                 ident                                           \
 299         };                                                      \
 300         DATA_SET(sysuninit_set,uniquifier ## _sys_uninit)
 301
 302 #define SYSUNINIT(uniquifier, subsystem, order, func, ident)    \
 303         C_SYSUNINIT(uniquifier, subsystem, order,               \
 304         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
 305
 306 void    sysinit_add (struct sysinit **, struct sysinit **);
 307
 308 /*
 309  * Infrastructure for tunable 'constants'.  Value may be specified at compile
 310  * time or kernel load time.  Rules relating tunables together can be placed
 311  * in a SYSINIT function at SI_BOOT1_TUNABLES with SI_ORDER_LAST.
 312  */
 313
 314 extern void tunable_int_init(void *);
 315
 316 struct tunable_int {
 317         const char *path;
 318         int *var;
 319 };
 320 #define TUNABLE_INT(path, var)                                  \
 321         _TUNABLE_INT((path), (var), __LINE__)
 322 #define _TUNABLE_INT(path, var, line)                           \
 323         __TUNABLE_INT((path), (var), line)
 324
 325 #define __TUNABLE_INT(path, var, line)                          \
 326         static struct tunable_int __tunable_int_ ## line = {    \
 327                 path,                                           \
 328                 var,                                            \
 329         };                                                      \
 330         SYSINIT(__Tunable_init_ ## line,                        \
 331                 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE,             \
 332                 tunable_int_init, &__tunable_int_ ## line)
 333
 334 #define TUNABLE_INT_FETCH(path, var)    kgetenv_int((path), (var))
 335
 336 /* Backwards compatibility with the old deprecated TUNABLE_INT_DECL API */
 337 #define TUNABLE_INT_DECL(path, defval, var)     \
 338 static void __Tunable_ ## var (void *ignored)   \
 339 {                                               \
 340         (var) = (defval);                       \
 341         TUNABLE_INT_FETCH((path), &(var));      \
 342 }                                               \
 343 SYSINIT(__Tunable_init_ ## var, SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE, \
 344         __Tunable_ ## var , NULL);
 345
 346 extern void tunable_long_init(void *);
 347
 348 struct tunable_long {
 349         const char *path;
 350         long *var;
 351 };
 352 #define TUNABLE_LONG(path, var)                                 \
 353         _TUNABLE_LONG((path), (var), __LINE__)
 354 #define _TUNABLE_LONG(path, var, line)                          \
 355         __TUNABLE_LONG((path), (var), line)
 356
 357 #define __TUNABLE_LONG(path, var, line)                         \
 358         static struct tunable_long __tunable_long_ ## line = {  \
 359                 path,                                           \
 360                 var,                                            \
 361         };                                                      \
 362         SYSINIT(__Tunable_init_ ## line,                        \
 363                 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE,             \
 364                 tunable_long_init, &__tunable_long_ ## line)
 365
 366 #define TUNABLE_LONG_FETCH(path, var)   kgetenv_long((path), (var))
 367
 368 extern void tunable_ulong_init(void *);
 369
 370 struct tunable_ulong {
 371         const char *path;
 372         unsigned long *var;
 373 };
 374 #define TUNABLE_ULONG(path, var)                                \
 375         _TUNABLE_ULONG((path), (var), __LINE__)
 376 #define _TUNABLE_ULONG(path, var, line)                         \
 377         __TUNABLE_ULONG((path), (var), line)
 378
 379 #define __TUNABLE_ULONG(path, var, line)                        \
 380         static struct tunable_ulong __tunable_ulong_ ## line = {\
 381                 path,                                           \
 382                 var,                                            \
 383         };                                                      \
 384         SYSINIT(__Tunable_init_ ## line,                        \
 385                 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE,             \
 386                 tunable_ulong_init, &__tunable_ulong_ ## line)
 387
 388 #define TUNABLE_ULONG_FETCH(path, var)  kgetenv_ulong((path), (var))
 389
 390 extern void tunable_quad_init(void *);
 391 struct tunable_quad {
 392         const char *path;
 393         quad_t *var;
 394 };
 395 #define TUNABLE_QUAD(path, var)                                 \
 396         _TUNABLE_QUAD((path), (var), __LINE__)
 397 #define _TUNABLE_QUAD(path, var, line)                          \
 398         __TUNABLE_QUAD((path), (var), line)
 399
 400 #define __TUNABLE_QUAD(path, var, line)                 \
 401         static struct tunable_quad __tunable_quad_ ## line = {  \
 402                 path,                                           \
 403                 var,                                            \
 404         };                                                      \
 405         SYSINIT(__Tunable_init_ ## line,                        \
 406                 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE,             \
 407                 tunable_quad_init, &__tunable_quad_ ## line)
 408
 409 #define TUNABLE_QUAD_FETCH(path, var)   kgetenv_quad((path), (var))
 410
 411 extern void tunable_str_init(void *);
 412 struct tunable_str {
 413         const char *path;
 414         char *var;
 415         int size;
 416 };
 417 #define TUNABLE_STR(path, var, size)                            \
 418         _TUNABLE_STR((path), (var), (size), __LINE__)
 419 #define _TUNABLE_STR(path, var, size, line)                     \
 420         __TUNABLE_STR((path), (var), (size), line)
 421
 422 #define __TUNABLE_STR(path, var, size, line)                    \
 423         static struct tunable_str __tunable_str_ ## line = {    \
 424                 path,                                           \
 425                 var,                                            \
 426                 size,                                           \
 427         };                                                      \
 428         SYSINIT(__Tunable_init_ ## line,                        \
 429                 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE,             \
 430                 tunable_str_init, &__tunable_str_ ## line)
 431
 432 #define TUNABLE_STR_FETCH(path, var, size)                      \
 433         kgetenv_string((path), (var), (size))
 434
 435 /*
 436  * Compatibility.  To be deprecated after LKM is removed.
 437  */
 438 #ifndef _SYS_MODULE_H_
 439 #include <sys/module.h>
 440 #endif
 441
 442 #define PSEUDO_SET(sym, name) \
 443         static int name ## _modevent(module_t mod, int type, void *data) \
 444         { \
 445                 void (*initfunc)(void *) = (void (*)(void *))data; \
 446                 switch (type) { \
 447                 case MOD_LOAD: \
 448                         /* kprintf(#name " module load\n"); */ \
 449                         initfunc(NULL); \
 450                         break; \
 451                 case MOD_UNLOAD: \
 452                         kprintf(#name " module unload - not possible for this module type\n"); \
 453                         return EINVAL; \
 454                 } \
 455                 return 0; \
 456         } \
 457         static moduledata_t name ## _mod = { \
 458                 #name, \
 459                 name ## _modevent, \
 460                 (void *)sym \
 461         }; \
 462         DECLARE_MODULE(name, name ## _mod, SI_SUB_PSEUDO, SI_ORDER_ANY)
 463
 464 struct intr_config_hook {
 465         TAILQ_ENTRY(intr_config_hook) ich_links;
 466         void    (*ich_func) (void *);
 467         void    *ich_arg;
 468         const char *ich_desc;
 469         int     ich_order;
 470         int     ich_ran;
 471 };
 472
 473 int     config_intrhook_establish (struct intr_config_hook *);
 474 void    config_intrhook_disestablish (struct intr_config_hook *);
 475
 476 #endif  /* _KERNEL */
 477 #endif /* !_SYS_KERNEL_H_*/