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