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