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