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