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.21 2006/05/21 03:43:47 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 #ifdef _KERNEL 61 62 #ifndef _SYS_QUEUE_H_ 63 #include <sys/queue.h> 64 #endif 65 66 /* Global variables for the kernel. */ 67 68 /* 1.1 */ 69 extern unsigned long hostid; 70 extern char hostname[MAXHOSTNAMELEN]; 71 extern int hostnamelen; 72 extern char domainname[MAXHOSTNAMELEN]; 73 extern int domainnamelen; 74 extern char kernelname[MAXPATHLEN]; 75 76 /* 1.2 */ 77 extern struct timespec boottime; 78 79 extern struct timezone tz; /* XXX */ 80 81 extern int tick; /* usec per tick (1000000 / hz) */ 82 extern int tickadj; /* "standard" clock skew, us./tick */ 83 extern int hz; /* system clock's frequency */ 84 extern int psratio; /* ratio: prof / stat */ 85 extern int stathz; /* statistics clock's frequency */ 86 extern int profhz; /* profiling clock's frequency */ 87 extern int ticks; 88 extern int lbolt; /* once a second sleep address */ 89 extern int lbolt_syncer; /* approx 1 hz but may be sped up */ 90 91 #endif /* _KERNEL */ 92 93 /* 94 * Enumerated types for known system startup interfaces. 95 * 96 * Startup occurs in ascending numeric order; the list entries are 97 * sorted prior to attempting startup to guarantee order. Items 98 * of the same level are arbitrated for order based on the 'order' 99 * element. 100 * 101 * These numbers are arbitrary and are chosen ONLY for ordering; the 102 * enumeration values are explicit rather than implicit to provide 103 * for binary compatibility with inserted elements. 104 * 105 * The SI_SUB_RUN_SCHEDULER value must have the highest lexical value. 106 * 107 * The SI_SUB_CONSOLE and SI_SUB_SWAP values represent values used by 108 * the BSD 4.4Lite but not by FreeBSD; they are maintained in dependent 109 * order to support porting. 110 */ 111 enum sysinit_sub_id { 112 SI_SUB_DUMMY = 0x0000000, /* not executed; for linker*/ 113 SI_SUB_DONE = 0x0000001, /* processed*/ 114 SI_SUB_TUNABLES = 0x0700000, /* establish tunable values */ 115 SI_SUB_CONSOLE = 0x0800000, /* console*/ 116 SI_SUB_COPYRIGHT = 0x0800001, /* first use of console*/ 117 SI_SUB_LOCK = 0x0900000, /* lockmgr locks and tokens */ 118 SI_SUB_VM = 0x1000000, /* virtual memory system init*/ 119 SI_SUB_KMEM = 0x1800000, /* kernel memory*/ 120 SI_SUB_KVM_RSRC = 0x1A00000, /* kvm operational limits*/ 121 SI_SUB_CPU = 0x1e00000, /* CPU resource(s)*/ 122 SI_SUB_KLD = 0x1f00000, /* KLD and module setup */ 123 SI_SUB_INTRINSIC = 0x2000000, /* proc 0*/ 124 SI_SUB_VM_CONF = 0x2100000, /* config VM, set limits*/ 125 SI_SUB_RUN_QUEUE = 0x2200000, /* the run queue*/ 126 SI_SUB_CREATE_INIT = 0x2300000, /* create the init process */ 127 SI_SUB_MBUF = 0x2380000, /* mbuf subsystem */ 128 SI_SUB_LEAVE_CRIT = 0x23c0000, /* allow interrupt operation */ 129 SI_SUB_DRIVERS = 0x2400000, /* Let Drivers initialize */ 130 SI_SUB_CONFIGURE = 0x3800000, /* Configure devices */ 131 SI_SUB_VFS = 0x4000000, /* virtual file system*/ 132 SI_SUB_CLOCKS = 0x4800000, /* real time and stat clocks*/ 133 SI_SUB_FINISH_SMP = 0x5000000, /* finish setting up cpus */ 134 SI_SUB_HELPER_THREADS = 0x5400000, /* misc helper threads */ 135 SI_SUB_CLIST = 0x5800000, /* clists*/ 136 SI_SUB_SYSV_SHM = 0x6400000, /* System V shared memory*/ 137 SI_SUB_SYSV_SEM = 0x6800000, /* System V semaphores*/ 138 SI_SUB_SYSV_MSG = 0x6C00000, /* System V message queues*/ 139 SI_SUB_P1003_1B = 0x6E00000, /* P1003.1B realtime */ 140 SI_SUB_PSEUDO = 0x7000000, /* pseudo devices*/ 141 SI_SUB_EXEC = 0x7400000, /* execve() handlers */ 142 SI_SUB_PROTO_BEGIN = 0x8000000, /* network protocol pre-init */ 143 SI_SUB_PROTO_IF = 0x8400000, /* interfaces */ 144 SI_SUB_PROTO_DOMAIN = 0x8800000, /* domains (address families?)*/ 145 SI_SUB_PROTO_IFATTACHDOMAIN 146 = 0x8800001, /* domain dependent data init */ 147 SI_SUB_PROTO_END = 0x8ffffff, /* network protocol post-init */ 148 SI_SUB_KPROF = 0x9000000, /* kernel profiling*/ 149 SI_SUB_KICK_SCHEDULER = 0xa000000, /* start the timeout events*/ 150 SI_SUB_INT_CONFIG_HOOKS = 0xa800000, /* Interrupts enabled config */ 151 SI_SUB_ROOT_CONF = 0xb000000, /* Find root devices */ 152 SI_SUB_DUMP_CONF = 0xb200000, /* Find dump devices */ 153 SI_SUB_RAID = 0xb300000, /* Configure vinum */ 154 SI_SUB_MOUNT_ROOT = 0xb400000, /* root mount*/ 155 SI_SUB_SWAP = 0xc000000, /* swap*/ 156 SI_SUB_INTRINSIC_POST = 0xd000000, /* proc 0 cleanup*/ 157 SI_SUB_KTHREAD_INIT = 0xe000000, /* init process*/ 158 SI_SUB_KTHREAD_PAGE = 0xe400000, /* pageout daemon*/ 159 SI_SUB_KTHREAD_VM = 0xe800000, /* vm daemon*/ 160 SI_SUB_KTHREAD_BUF = 0xea00000, /* buffer daemon*/ 161 SI_SUB_KTHREAD_UPDATE = 0xec00000, /* update daemon*/ 162 SI_SUB_KTHREAD_IDLE = 0xee00000, /* idle procs*/ 163 SI_SUB_SMP = 0xf000000, /* idle procs*/ 164 SI_SUB_RUN_SCHEDULER = 0xfffffff /* scheduler: no return*/ 165 }; 166 167 168 /* 169 * Some enumerated orders; "ANY" sorts last. 170 */ 171 enum sysinit_elem_order { 172 SI_ORDER_FIRST = 0x0000000, /* first*/ 173 SI_ORDER_SECOND = 0x0000001, /* second*/ 174 SI_ORDER_THIRD = 0x0000002, /* third*/ 175 SI_ORDER_MIDDLE = 0x1000000, /* somewhere in the middle */ 176 SI_ORDER_ANY = 0xfffffff /* last*/ 177 }; 178 179 180 /* 181 * A system initialization call instance 182 * 183 * At the moment there is one instance of sysinit. We probably do not 184 * want two which is why this code is if'd out, but we definitely want 185 * to discern SYSINIT's which take non-constant data pointers and 186 * SYSINIT's which take constant data pointers, 187 * 188 * The C_* macros take functions expecting const void * arguments 189 * while the non-C_* macros take functions expecting just void * arguments. 190 * 191 * With -Wcast-qual on, the compiler issues warnings: 192 * - if we pass non-const data or functions taking non-const data 193 * to a C_* macro. 194 * 195 * - if we pass const data to the normal macros 196 * 197 * However, no warning is issued if we pass a function taking const data 198 * through a normal non-const macro. This is ok because the function is 199 * saying it won't modify the data so we don't care whether the data is 200 * modifiable or not. 201 */ 202 203 typedef void (*sysinit_nfunc_t) (void *); 204 typedef void (*sysinit_cfunc_t) (const void *); 205 206 struct sysinit { 207 unsigned int subsystem; /* subsystem identifier*/ 208 unsigned int order; /* init order within subsystem*/ 209 sysinit_cfunc_t func; /* function */ 210 const void *udata; /* multiplexer/argument */ 211 }; 212 213 /* 214 * Default: no special processing 215 * 216 * The C_ version of SYSINIT is for data pointers to const 217 * data ( and functions taking data pointers to const data ). 218 * At the moment it is no different from SYSINIT and thus 219 * still results in warnings. 220 * 221 * The casts are necessary to have the compiler produce the 222 * correct warnings when -Wcast-qual is used. 223 * 224 */ 225 #define C_SYSINIT(uniquifier, subsystem, order, func, ident) \ 226 static struct sysinit uniquifier ## _sys_init = { \ 227 subsystem, \ 228 order, \ 229 func, \ 230 ident \ 231 }; \ 232 DATA_SET(sysinit_set,uniquifier ## _sys_init); 233 234 #define SYSINIT(uniquifier, subsystem, order, func, ident) \ 235 C_SYSINIT(uniquifier, subsystem, order, \ 236 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident) 237 238 /* 239 * Called on module unload: no special processing 240 */ 241 #define C_SYSUNINIT(uniquifier, subsystem, order, func, ident) \ 242 static struct sysinit uniquifier ## _sys_uninit = { \ 243 subsystem, \ 244 order, \ 245 func, \ 246 ident \ 247 }; \ 248 DATA_SET(sysuninit_set,uniquifier ## _sys_uninit) 249 250 #define SYSUNINIT(uniquifier, subsystem, order, func, ident) \ 251 C_SYSUNINIT(uniquifier, subsystem, order, \ 252 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident) 253 254 void sysinit_add (struct sysinit **, struct sysinit **); 255 256 /* 257 * Infrastructure for tunable 'constants'. Value may be specified at compile 258 * time or kernel load time. Rules relating tunables together can be placed 259 * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_LAST. 260 */ 261 262 extern void tunable_int_init(void *); 263 264 struct tunable_int { 265 const char *path; 266 int *var; 267 }; 268 #define TUNABLE_INT(path, var) \ 269 _TUNABLE_INT((path), (var), __LINE__) 270 #define _TUNABLE_INT(path, var, line) \ 271 __TUNABLE_INT((path), (var), line) 272 273 #define __TUNABLE_INT(path, var, line) \ 274 static struct tunable_int __tunable_int_ ## line = { \ 275 path, \ 276 var, \ 277 }; \ 278 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \ 279 tunable_int_init, &__tunable_int_ ## line) 280 281 #define TUNABLE_INT_FETCH(path, var) getenv_int((path), (var)) 282 283 /* Backwards compatibility with the old deprecated TUNABLE_INT_DECL API */ 284 #define TUNABLE_INT_DECL(path, defval, var) \ 285 static void __Tunable_ ## var (void *ignored) \ 286 { \ 287 (var) = (defval); \ 288 TUNABLE_INT_FETCH((path), &(var)); \ 289 } \ 290 SYSINIT(__Tunable_init_ ## var, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, __Tunable_ ## var , NULL); 291 292 extern void tunable_quad_init(void *); 293 struct tunable_quad { 294 const char *path; 295 quad_t *var; 296 }; 297 #define TUNABLE_QUAD(path, var) \ 298 _TUNABLE_QUAD((path), (var), __LINE__) 299 #define _TUNABLE_QUAD(path, var, line) \ 300 __TUNABLE_QUAD((path), (var), line) 301 302 #define __TUNABLE_QUAD(path, var, line) \ 303 static struct tunable_quad __tunable_quad_ ## line = { \ 304 path, \ 305 var, \ 306 }; \ 307 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \ 308 tunable_quad_init, &__tunable_quad_ ## line) 309 310 #define TUNABLE_QUAD_FETCH(path, var) getenv_quad((path), (var)) 311 312 extern void tunable_str_init(void *); 313 struct tunable_str { 314 const char *path; 315 char *var; 316 int size; 317 }; 318 #define TUNABLE_STR(path, var, size) \ 319 _TUNABLE_STR((path), (var), (size), __LINE__) 320 #define _TUNABLE_STR(path, var, size, line) \ 321 __TUNABLE_STR((path), (var), (size), line) 322 323 #define __TUNABLE_STR(path, var, size, line) \ 324 static struct tunable_str __tunable_str_ ## line = { \ 325 path, \ 326 var, \ 327 size, \ 328 }; \ 329 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \ 330 tunable_str_init, &__tunable_str_ ## line) 331 332 #define TUNABLE_STR_FETCH(path, var, size) \ 333 getenv_string((path), (var), (size)) 334 335 /* 336 * Compatibility. To be deprecated after LKM is removed. 337 */ 338 #ifndef _SYS_MODULE_H_ 339 #include <sys/module.h> 340 #endif 341 342 #define PSEUDO_SET(sym, name) \ 343 static int name ## _modevent(module_t mod, int type, void *data) \ 344 { \ 345 void (*initfunc)(void *) = (void (*)(void *))data; \ 346 switch (type) { \ 347 case MOD_LOAD: \ 348 /* printf(#name " module load\n"); */ \ 349 initfunc(NULL); \ 350 break; \ 351 case MOD_UNLOAD: \ 352 printf(#name " module unload - not possible for this module type\n"); \ 353 return EINVAL; \ 354 } \ 355 return 0; \ 356 } \ 357 static moduledata_t name ## _mod = { \ 358 #name, \ 359 name ## _modevent, \ 360 (void *)sym \ 361 }; \ 362 DECLARE_MODULE(name, name ## _mod, SI_SUB_PSEUDO, SI_ORDER_ANY) 363 364 extern struct linker_set execsw_set; 365 366 struct intr_config_hook { 367 TAILQ_ENTRY(intr_config_hook) ich_links; 368 void (*ich_func) (void *); 369 void *ich_arg; 370 const char *ich_desc; 371 }; 372 373 int config_intrhook_establish (struct intr_config_hook *); 374 void config_intrhook_disestablish (struct intr_config_hook *); 375 376 #endif /* _KERNEL */ 377 #endif /* !_SYS_KERNEL_H_*/ 378