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