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_LWKT_INIT      = 0x1b40000,
 158         SI_BOOT2_SOFTCLOCK      = 0x1b80000,
 159         SI_BOOT2_CLOCKS         = 0x1c00000,    /* select & start clocks */
 160         SI_BOOT2_FINISH_SMP     = 0x1c80000,    /* SMP go (& synch clocks) */
 161         SI_BOOT2_POST_SMP       = 0x1cc0000,    /* post-SMP low level */
 162
 163         /*
 164          * Finish up core kernel initialization and set up the process
 165          * abstraction.
 166          */
 167         SI_BOOT2_BIOS           = 0x1d00000,
 168         SI_BOOT2_MACHDEP        = 0x1d80000,
 169         SI_BOOT2_KLD            = 0x1e00000,
 170         SI_BOOT2_CPU_TOPOLOGY   = 0x1e40000,
 171         SI_BOOT2_USCHED         = 0x1e80000,
 172         SI_BOOT2_PROC0          = 0x1f00000,
 173
 174         /*
 175          * Continue with miscellanious system initialization
 176          */
 177         SI_SUB_CREATE_INIT      = 0x2300000,    /* create the init process */
 178         SI_SUB_PRE_DRIVERS      = 0x2380000,
 179         SI_SUB_DRIVERS          = 0x2400000,    /* Let Drivers initialize */
 180         SI_SUB_CONFIGURE        = 0x3800000,    /* Configure devices */
 181         SI_SUB_ISWARM           = 0x3c00000,    /* No longer in cold boot */
 182         SI_SUB_VFS              = 0x4000000,    /* virtual file system*/
 183         SI_SUB_HELPER_THREADS   = 0x5400000,    /* misc helper threads */
 184         SI_SUB_CLIST            = 0x5800000,    /* clists*/
 185         SI_SUB_SYSV_SHM         = 0x6400000,    /* System V shared memory*/
 186         SI_SUB_SYSV_SEM         = 0x6800000,    /* System V semaphores*/
 187         SI_SUB_SYSV_MSG         = 0x6C00000,    /* System V message queues*/
 188         SI_SUB_P1003_1B         = 0x6E00000,    /* P1003.1B realtime */
 189         SI_SUB_PSEUDO           = 0x7000000,    /* pseudo devices*/
 190         SI_SUB_EXEC             = 0x7400000,    /* execve() handlers */
 191         SI_SUB_PROTO_IF         = 0x8400000,    /* interfaces */
 192         SI_SUB_PROTO_DOMAIN     = 0x8800000,    /* domains (address families?)*/
 193         SI_SUB_PROTO_IFATTACHDOMAIN
 194                                 = 0x8800001,    /* domain dependent data init */
 195         SI_SUB_PROTO_END        = 0x8ffffff,    /* network protocol post-init */
 196         SI_SUB_KPROF            = 0x9000000,    /* kernel profiling*/
 197         SI_SUB_KICK_SCHEDULER   = 0xa000000,    /* start the timeout events*/
 198         SI_SUB_INT_CONFIG_HOOKS = 0xa800000,    /* Interrupts enabled config */
 199
 200         /*
 201          * Root filesystem setup, finish up with the major system
 202          * demons.
 203          */
 204         SI_SUB_ROOT_CONF        = 0xb000000,    /* Find root devices */
 205         SI_SUB_DUMP_CONF        = 0xb200000,    /* Find dump devices */
 206         SI_SUB_RAID             = 0xb300000,    /* Configure vinum */
 207         SI_SUB_DM_TARGETS       = 0xb3a0000,    /* configure dm targets */
 208         SI_SUB_MOUNT_ROOT       = 0xb400000,    /* root mount*/
 209         SI_SUB_PROC0_POST       = 0xd000000,    /* proc 0 cleanup*/
 210         SI_SUB_KTHREAD_INIT     = 0xe000000,    /* init process*/
 211         SI_SUB_KTHREAD_PAGE     = 0xe400000,    /* pageout daemon*/
 212         SI_SUB_KTHREAD_VM       = 0xe800000,    /* vm daemon*/
 213         SI_SUB_KTHREAD_BUF      = 0xea00000,    /* buffer daemon*/
 214         SI_SUB_KTHREAD_UPDATE   = 0xec00000,    /* update daemon*/
 215         SI_SUB_KTHREAD_IDLE     = 0xee00000,    /* idle procs*/
 216         SI_SUB_RUN_SCHEDULER    = 0xfffffff     /* scheduler: no return*/
 217 };
 218
 219
 220 /*
 221  * Some enumerated orders; "ANY" sorts last.
 222  */
 223 enum sysinit_elem_order {
 224         SI_ORDER_FIRST          = 0x0000000,    /* first*/
 225         SI_ORDER_SECOND         = 0x0000001,    /* second*/
 226         SI_ORDER_THIRD          = 0x0000002,    /* third*/
 227         SI_ORDER_MIDDLE         = 0x1000000,    /* somewhere in the middle */
 228         SI_ORDER_ANY            = 0xfffffff     /* last*/
 229 };
 230
 231
 232 /*
 233  * A system initialization call instance
 234  *
 235  * At the moment there is one instance of sysinit.  We probably do not
 236  * want two which is why this code is if'd out, but we definitely want
 237  * to discern SYSINIT's which take non-constant data pointers and
 238  * SYSINIT's which take constant data pointers,
 239  *
 240  * The C_* macros take functions expecting const void * arguments
 241  * while the non-C_* macros take functions expecting just void * arguments.
 242  *
 243  * With -Wcast-qual on, the compiler issues warnings:
 244  *      - if we pass non-const data or functions taking non-const data
 245  *        to a C_* macro.
 246  *
 247  *      - if we pass const data to the normal macros
 248  *
 249  * However, no warning is issued if we pass a function taking const data
 250  * through a normal non-const macro.  This is ok because the function is
 251  * saying it won't modify the data so we don't care whether the data is
 252  * modifiable or not.
 253  */
 254
 255 typedef void (*sysinit_nfunc_t) (void *);
 256 typedef void (*sysinit_cfunc_t) (const void *);
 257
 258 struct sysinit {
 259         unsigned int    subsystem;              /* subsystem identifier*/
 260         unsigned int    order;                  /* init order within subsystem*/
 261         sysinit_cfunc_t func;                   /* function             */
 262         const void      *udata;                 /* multiplexer/argument */
 263         const char      *name;
 264 };
 265
 266 /*
 267  * Default: no special processing
 268  *
 269  * The C_ version of SYSINIT is for data pointers to const
 270  * data ( and functions taking data pointers to const data ).
 271  * At the moment it is no different from SYSINIT and thus
 272  * still results in warnings.
 273  *
 274  * The casts are necessary to have the compiler produce the
 275  * correct warnings when -Wcast-qual is used.
 276  *
 277  */
 278 #define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
 279         static struct sysinit uniquifier ## _sys_init = {       \
 280                 subsystem,                                      \
 281                 order,                                          \
 282                 func,                                           \
 283                 ident,                                          \
 284                 #uniquifier                                     \
 285         };                                                      \
 286         DATA_SET(sysinit_set,uniquifier ## _sys_init)
 287
 288 #define SYSINIT(uniquifier, subsystem, order, func, ident)      \
 289         C_SYSINIT(uniquifier, subsystem, order,                 \
 290         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
 291
 292 /*
 293  * Called on module unload: no special processing
 294  */
 295 #define C_SYSUNINIT(uniquifier, subsystem, order, func, ident)  \
 296         static struct sysinit uniquifier ## _sys_uninit = {     \
 297                 subsystem,                                      \
 298                 order,                                          \
 299                 func,                                           \
 300                 ident                                           \
 301         };                                                      \
 302         DATA_SET(sysuninit_set,uniquifier ## _sys_uninit)
 303
 304 #define SYSUNINIT(uniquifier, subsystem, order, func, ident)    \
 305         C_SYSUNINIT(uniquifier, subsystem, order,               \
 306         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
 307
 308 void    sysinit_add (struct sysinit **, struct sysinit **);
 309
 310 /*
 311  * Infrastructure for tunable 'constants'.  Value may be specified at compile
 312  * time or kernel load time.  Rules relating tunables together can be placed
 313  * in a SYSINIT function at SI_BOOT1_TUNABLES with SI_ORDER_LAST.
 314  */
 315
 316 extern void tunable_int_init(void *);
 317
 318 struct tunable_int {
 319         const char *path;
 320         int *var;
 321 };
 322 #define TUNABLE_INT(path, var)                                  \
 323         _TUNABLE_INT((path), (var), __LINE__)
 324 #define _TUNABLE_INT(path, var, line)                           \
 325         __TUNABLE_INT((path), (var), line)
 326
 327 #define __TUNABLE_INT(path, var, line)                          \
 328         static struct tunable_int __tunable_int_ ## line = {    \
 329                 path,                                           \
 330                 var,                                            \
 331         };                                                      \
 332         SYSINIT(__Tunable_init_ ## line,                        \
 333                 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE,             \
 334                 tunable_int_init, &__tunable_int_ ## line)
 335
 336 #define TUNABLE_INT_FETCH(path, var)    kgetenv_int((path), (var))
 337
 338 /* Backwards compatibility with the old deprecated TUNABLE_INT_DECL API */
 339 #define TUNABLE_INT_DECL(path, defval, var)     \
 340 static void __Tunable_ ## var (void *ignored)   \
 341 {                                               \
 342         (var) = (defval);                       \
 343         TUNABLE_INT_FETCH((path), &(var));      \
 344 }                                               \
 345 SYSINIT(__Tunable_init_ ## var, SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE, \
 346         __Tunable_ ## var , NULL);
 347
 348 extern void tunable_long_init(void *);
 349
 350 struct tunable_long {
 351         const char *path;
 352         long *var;
 353 };
 354 #define TUNABLE_LONG(path, var)                                 \
 355         _TUNABLE_LONG((path), (var), __LINE__)
 356 #define _TUNABLE_LONG(path, var, line)                          \
 357         __TUNABLE_LONG((path), (var), line)
 358
 359 #define __TUNABLE_LONG(path, var, line)                         \
 360         static struct tunable_long __tunable_long_ ## line = {  \
 361                 path,                                           \
 362                 var,                                            \
 363         };                                                      \
 364         SYSINIT(__Tunable_init_ ## line,                        \
 365                 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE,             \
 366                 tunable_long_init, &__tunable_long_ ## line)
 367
 368 #define TUNABLE_LONG_FETCH(path, var)   kgetenv_long((path), (var))
 369
 370 extern void tunable_ulong_init(void *);
 371
 372 struct tunable_ulong {
 373         const char *path;
 374         unsigned long *var;
 375 };
 376 #define TUNABLE_ULONG(path, var)                                \
 377         _TUNABLE_ULONG((path), (var), __LINE__)
 378 #define _TUNABLE_ULONG(path, var, line)                         \
 379         __TUNABLE_ULONG((path), (var), line)
 380
 381 #define __TUNABLE_ULONG(path, var, line)                        \
 382         static struct tunable_ulong __tunable_ulong_ ## line = {\
 383                 path,                                           \
 384                 var,                                            \
 385         };                                                      \
 386         SYSINIT(__Tunable_init_ ## line,                        \
 387                 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE,             \
 388                 tunable_ulong_init, &__tunable_ulong_ ## line)
 389
 390 #define TUNABLE_ULONG_FETCH(path, var)  kgetenv_ulong((path), (var))
 391
 392 extern void tunable_quad_init(void *);
 393 struct tunable_quad {
 394         const char *path;
 395         quad_t *var;
 396 };
 397 #define TUNABLE_QUAD(path, var)                                 \
 398         _TUNABLE_QUAD((path), (var), __LINE__)
 399 #define _TUNABLE_QUAD(path, var, line)                          \
 400         __TUNABLE_QUAD((path), (var), line)
 401
 402 #define __TUNABLE_QUAD(path, var, line)                 \
 403         static struct tunable_quad __tunable_quad_ ## line = {  \
 404                 path,                                           \
 405                 var,                                            \
 406         };                                                      \
 407         SYSINIT(__Tunable_init_ ## line,                        \
 408                 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE,             \
 409                 tunable_quad_init, &__tunable_quad_ ## line)
 410
 411 #define TUNABLE_QUAD_FETCH(path, var)   kgetenv_quad((path), (var))
 412
 413 extern void tunable_str_init(void *);
 414 struct tunable_str {
 415         const char *path;
 416         char *var;
 417         int size;
 418 };
 419 #define TUNABLE_STR(path, var, size)                            \
 420         _TUNABLE_STR((path), (var), (size), __LINE__)
 421 #define _TUNABLE_STR(path, var, size, line)                     \
 422         __TUNABLE_STR((path), (var), (size), line)
 423
 424 #define __TUNABLE_STR(path, var, size, line)                    \
 425         static struct tunable_str __tunable_str_ ## line = {    \
 426                 path,                                           \
 427                 var,                                            \
 428                 size,                                           \
 429         };                                                      \
 430         SYSINIT(__Tunable_init_ ## line,                        \
 431                 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE,             \
 432                 tunable_str_init, &__tunable_str_ ## line)
 433
 434 #define TUNABLE_STR_FETCH(path, var, size)                      \
 435         kgetenv_string((path), (var), (size))
 436
 437 /*
 438  * Compatibility.  To be deprecated after LKM is removed.
 439  */
 440 #ifndef _SYS_MODULE_H_
 441 #include <sys/module.h>
 442 #endif
 443
 444 #define PSEUDO_SET(sym, name) \
 445         static int name ## _modevent(module_t mod, int type, void *data) \
 446         { \
 447                 void (*initfunc)(void *) = (void (*)(void *))data; \
 448                 switch (type) { \
 449                 case MOD_LOAD: \
 450                         /* kprintf(#name " module load\n"); */ \
 451                         initfunc(NULL); \
 452                         break; \
 453                 case MOD_UNLOAD: \
 454                         kprintf(#name " module unload - not possible for this module type\n"); \
 455                         return EINVAL; \
 456                 } \
 457                 return 0; \
 458         } \
 459         static moduledata_t name ## _mod = { \
 460                 #name, \
 461                 name ## _modevent, \
 462                 (void *)sym \
 463         }; \
 464         DECLARE_MODULE(name, name ## _mod, SI_SUB_PSEUDO, SI_ORDER_ANY)
 465
 466 struct intr_config_hook {
 467         TAILQ_ENTRY(intr_config_hook) ich_links;
 468         void    (*ich_func) (void *);
 469         void    *ich_arg;
 470         const char *ich_desc;
 471         int     ich_order;
 472         int     ich_ran;
 473 };
 474
 475 int     config_intrhook_establish (struct intr_config_hook *);
 476 void    config_intrhook_disestablish (struct intr_config_hook *);
 477
 478 #endif  /* _KERNEL */
 479 #endif /* !_SYS_KERNEL_H_*/