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