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