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