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$ 43 */ 44 45 #ifndef _SYS_KERNEL_H_ 46 #define _SYS_KERNEL_H_ 47 48 #include <sys/linker_set.h> 49 50 #ifdef _KERNEL 51 52 /* for intrhook below */ 53 #include <sys/queue.h> 54 55 /* Global variables for the kernel. */ 56 57 /* 1.1 */ 58 extern char kernelname[MAXPATHLEN]; 59 60 extern int tick; /* usec per tick (1000000 / hz) */ 61 extern int hz; /* system clock's frequency */ 62 extern int psratio; /* ratio: prof / stat */ 63 extern int stathz; /* statistics clock's frequency */ 64 extern int profhz; /* profiling clock's frequency */ 65 extern int profprocs; /* number of process's profiling */ 66 extern volatile int ticks; 67 68 #endif /* _KERNEL */ 69 70 /* 71 * Enumerated types for known system startup interfaces. 72 * 73 * Startup occurs in ascending numeric order; the list entries are 74 * sorted prior to attempting startup to guarantee order. Items 75 * of the same level are arbitrated for order based on the 'order' 76 * element. 77 * 78 * These numbers are arbitrary and are chosen ONLY for ordering; the 79 * enumeration values are explicit rather than implicit to provide 80 * for binary compatibility with inserted elements. 81 * 82 * The SI_SUB_LAST value must have the highest lexical value. 83 * 84 * The SI_SUB_SWAP values represent a value used by 85 * the BSD 4.4Lite but not by FreeBSD; it is maintained in dependent 86 * order to support porting. 87 */ 88 enum sysinit_sub_id { 89 SI_SUB_DUMMY = 0x0000000, /* not executed; for linker*/ 90 SI_SUB_DONE = 0x0000001, /* processed*/ 91 SI_SUB_TUNABLES = 0x0700000, /* establish tunable values */ 92 SI_SUB_COPYRIGHT = 0x0800001, /* first use of console*/ 93 SI_SUB_SETTINGS = 0x0880000, /* check and recheck settings */ 94 SI_SUB_MTX_POOL_STATIC = 0x0900000, /* static mutex pool */ 95 SI_SUB_LOCKMGR = 0x0980000, /* lockmgr locks */ 96 SI_SUB_VM = 0x1000000, /* virtual memory system init*/ 97 SI_SUB_KMEM = 0x1800000, /* kernel memory*/ 98 SI_SUB_KVM_RSRC = 0x1A00000, /* kvm operational limits*/ 99 SI_SUB_HYPERVISOR = 0x1A40000, /* 100 * Hypervisor detection and 101 * virtualization support 102 * setup. 103 */ 104 SI_SUB_WITNESS = 0x1A80000, /* witness initialization */ 105 SI_SUB_MTX_POOL_DYNAMIC = 0x1AC0000, /* dynamic mutex pool */ 106 SI_SUB_LOCK = 0x1B00000, /* various locks */ 107 SI_SUB_EVENTHANDLER = 0x1C00000, /* eventhandler init */ 108 SI_SUB_VNET_PRELINK = 0x1E00000, /* vnet init before modules */ 109 SI_SUB_KLD = 0x2000000, /* KLD and module setup */ 110 SI_SUB_CPU = 0x2100000, /* CPU resource(s)*/ 111 SI_SUB_RACCT = 0x2110000, /* resource accounting */ 112 SI_SUB_RANDOM = 0x2120000, /* random number generator */ 113 SI_SUB_KDTRACE = 0x2140000, /* Kernel dtrace hooks */ 114 SI_SUB_MAC = 0x2180000, /* TrustedBSD MAC subsystem */ 115 SI_SUB_MAC_POLICY = 0x21C0000, /* TrustedBSD MAC policies */ 116 SI_SUB_MAC_LATE = 0x21D0000, /* TrustedBSD MAC subsystem */ 117 SI_SUB_VNET = 0x21E0000, /* vnet 0 */ 118 SI_SUB_INTRINSIC = 0x2200000, /* proc 0*/ 119 SI_SUB_VM_CONF = 0x2300000, /* config VM, set limits*/ 120 SI_SUB_DDB_SERVICES = 0x2380000, /* capture, scripting, etc. */ 121 SI_SUB_RUN_QUEUE = 0x2400000, /* set up run queue*/ 122 SI_SUB_KTRACE = 0x2480000, /* ktrace */ 123 SI_SUB_OPENSOLARIS = 0x2490000, /* OpenSolaris compatibility */ 124 SI_SUB_CYCLIC = 0x24A0000, /* Cyclic timers */ 125 SI_SUB_AUDIT = 0x24C0000, /* audit */ 126 SI_SUB_CREATE_INIT = 0x2500000, /* create init process*/ 127 SI_SUB_SCHED_IDLE = 0x2600000, /* required idle procs */ 128 SI_SUB_MBUF = 0x2700000, /* mbuf subsystem */ 129 SI_SUB_INTR = 0x2800000, /* interrupt threads */ 130 SI_SUB_SOFTINTR = 0x2800001, /* start soft interrupt thread */ 131 SI_SUB_ACL = 0x2900000, /* start for filesystem ACLs */ 132 SI_SUB_DEVFS = 0x2F00000, /* devfs ready for devices */ 133 SI_SUB_INIT_IF = 0x3000000, /* prep for net interfaces */ 134 SI_SUB_NETGRAPH = 0x3010000, /* Let Netgraph initialize */ 135 SI_SUB_DTRACE = 0x3020000, /* DTrace subsystem */ 136 SI_SUB_DTRACE_PROVIDER = 0x3048000, /* DTrace providers */ 137 SI_SUB_DTRACE_ANON = 0x308C000, /* DTrace anon enabling */ 138 SI_SUB_DRIVERS = 0x3100000, /* Let Drivers initialize */ 139 SI_SUB_CONFIGURE = 0x3800000, /* Configure devices */ 140 SI_SUB_VFS = 0x4000000, /* virtual filesystem*/ 141 SI_SUB_CLOCKS = 0x4800000, /* real time and stat clocks*/ 142 SI_SUB_CLIST = 0x5800000, /* clists*/ 143 SI_SUB_SYSV_SHM = 0x6400000, /* System V shared memory*/ 144 SI_SUB_SYSV_SEM = 0x6800000, /* System V semaphores*/ 145 SI_SUB_SYSV_MSG = 0x6C00000, /* System V message queues*/ 146 SI_SUB_P1003_1B = 0x6E00000, /* P1003.1B realtime */ 147 SI_SUB_PSEUDO = 0x7000000, /* pseudo devices*/ 148 SI_SUB_EXEC = 0x7400000, /* execve() handlers */ 149 SI_SUB_PROTO_BEGIN = 0x8000000, /* VNET initialization */ 150 SI_SUB_PROTO_IF = 0x8400000, /* interfaces*/ 151 SI_SUB_PROTO_DOMAININIT = 0x8600000, /* domain registration system */ 152 SI_SUB_PROTO_DOMAIN = 0x8800000, /* domains (address families?)*/ 153 SI_SUB_PROTO_IFATTACHDOMAIN = 0x8800001, /* domain dependent data init*/ 154 SI_SUB_PROTO_END = 0x8ffffff, /* VNET helper functions */ 155 SI_SUB_KPROF = 0x9000000, /* kernel profiling*/ 156 SI_SUB_KICK_SCHEDULER = 0xa000000, /* start the timeout events*/ 157 SI_SUB_INT_CONFIG_HOOKS = 0xa800000, /* Interrupts enabled config */ 158 SI_SUB_ROOT_CONF = 0xb000000, /* Find root devices */ 159 SI_SUB_DUMP_CONF = 0xb200000, /* Find dump devices */ 160 SI_SUB_RAID = 0xb380000, /* Configure GEOM classes */ 161 SI_SUB_SWAP = 0xc000000, /* swap */ 162 SI_SUB_INTRINSIC_POST = 0xd000000, /* proc 0 cleanup*/ 163 SI_SUB_SYSCALLS = 0xd800000, /* register system calls */ 164 SI_SUB_VNET_DONE = 0xdc00000, /* vnet registration complete */ 165 SI_SUB_KTHREAD_INIT = 0xe000000, /* init process*/ 166 SI_SUB_KTHREAD_PAGE = 0xe400000, /* pageout daemon*/ 167 SI_SUB_KTHREAD_VM = 0xe800000, /* vm daemon*/ 168 SI_SUB_KTHREAD_BUF = 0xea00000, /* buffer daemon*/ 169 SI_SUB_KTHREAD_UPDATE = 0xec00000, /* update daemon*/ 170 SI_SUB_KTHREAD_IDLE = 0xee00000, /* idle procs*/ 171 SI_SUB_SMP = 0xf000000, /* start the APs*/ 172 SI_SUB_RACCTD = 0xf100000, /* start raccd*/ 173 SI_SUB_LAST = 0xfffffff /* final initialization */ 174 }; 175 176 177 /* 178 * Some enumerated orders; "ANY" sorts last. 179 */ 180 enum sysinit_elem_order { 181 SI_ORDER_FIRST = 0x0000000, /* first*/ 182 SI_ORDER_SECOND = 0x0000001, /* second*/ 183 SI_ORDER_THIRD = 0x0000002, /* third*/ 184 SI_ORDER_FOURTH = 0x0000003, /* fourth*/ 185 SI_ORDER_MIDDLE = 0x1000000, /* somewhere in the middle */ 186 SI_ORDER_ANY = 0xfffffff /* last*/ 187 }; 188 189 190 /* 191 * A system initialization call instance 192 * 193 * At the moment there is one instance of sysinit. We probably do not 194 * want two which is why this code is if'd out, but we definitely want 195 * to discern SYSINIT's which take non-constant data pointers and 196 * SYSINIT's which take constant data pointers, 197 * 198 * The C_* macros take functions expecting const void * arguments 199 * while the non-C_* macros take functions expecting just void * arguments. 200 * 201 * With -Wcast-qual on, the compiler issues warnings: 202 * - if we pass non-const data or functions taking non-const data 203 * to a C_* macro. 204 * 205 * - if we pass const data to the normal macros 206 * 207 * However, no warning is issued if we pass a function taking const data 208 * through a normal non-const macro. This is ok because the function is 209 * saying it won't modify the data so we don't care whether the data is 210 * modifiable or not. 211 */ 212 213 typedef void (*sysinit_nfunc_t)(void *); 214 typedef void (*sysinit_cfunc_t)(const void *); 215 216 struct sysinit { 217 enum sysinit_sub_id subsystem; /* subsystem identifier*/ 218 enum sysinit_elem_order order; /* init order within subsystem*/ 219 sysinit_cfunc_t func; /* function */ 220 const void *udata; /* multiplexer/argument */ 221 }; 222 223 /* 224 * Default: no special processing 225 * 226 * The C_ version of SYSINIT is for data pointers to const 227 * data ( and functions taking data pointers to const data ). 228 * At the moment it is no different from SYSINIT and thus 229 * still results in warnings. 230 * 231 * The casts are necessary to have the compiler produce the 232 * correct warnings when -Wcast-qual is used. 233 * 234 */ 235 #define C_SYSINIT(uniquifier, subsystem, order, func, ident) \ 236 static struct sysinit uniquifier ## _sys_init = { \ 237 subsystem, \ 238 order, \ 239 func, \ 240 (ident) \ 241 }; \ 242 DATA_SET(sysinit_set,uniquifier ## _sys_init) 243 244 #define SYSINIT(uniquifier, subsystem, order, func, ident) \ 245 C_SYSINIT(uniquifier, subsystem, order, \ 246 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident)) 247 248 /* 249 * Called on module unload: no special processing 250 */ 251 #define C_SYSUNINIT(uniquifier, subsystem, order, func, ident) \ 252 static struct sysinit uniquifier ## _sys_uninit = { \ 253 subsystem, \ 254 order, \ 255 func, \ 256 (ident) \ 257 }; \ 258 DATA_SET(sysuninit_set,uniquifier ## _sys_uninit) 259 260 #define SYSUNINIT(uniquifier, subsystem, order, func, ident) \ 261 C_SYSUNINIT(uniquifier, subsystem, order, \ 262 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident)) 263 264 void sysinit_add(struct sysinit **set, struct sysinit **set_end); 265 266 /* 267 * Infrastructure for tunable 'constants'. Value may be specified at compile 268 * time or kernel load time. Rules relating tunables together can be placed 269 * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_ANY. 270 * 271 * WARNING: developers should never use the reserved suffixes specified in 272 * loader.conf(5) for any tunables or conflicts will result. 273 */ 274 275 /* 276 * int 277 * please avoid using for new tunables! 278 */ 279 extern void tunable_int_init(void *); 280 struct tunable_int { 281 const char *path; 282 int *var; 283 }; 284 #define TUNABLE_INT(path, var) \ 285 static struct tunable_int __CONCAT(__tunable_int_, __LINE__) = { \ 286 (path), \ 287 (var), \ 288 }; \ 289 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 290 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int_init, \ 291 &__CONCAT(__tunable_int_, __LINE__)) 292 293 #define TUNABLE_INT_FETCH(path, var) getenv_int((path), (var)) 294 295 /* 296 * long 297 */ 298 extern void tunable_long_init(void *); 299 struct tunable_long { 300 const char *path; 301 long *var; 302 }; 303 #define TUNABLE_LONG(path, var) \ 304 static struct tunable_long __CONCAT(__tunable_long_, __LINE__) = { \ 305 (path), \ 306 (var), \ 307 }; \ 308 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 309 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_long_init,\ 310 &__CONCAT(__tunable_long_, __LINE__)) 311 312 #define TUNABLE_LONG_FETCH(path, var) getenv_long((path), (var)) 313 314 /* 315 * unsigned long 316 */ 317 extern void tunable_ulong_init(void *); 318 struct tunable_ulong { 319 const char *path; 320 unsigned long *var; 321 }; 322 #define TUNABLE_ULONG(path, var) \ 323 static struct tunable_ulong __CONCAT(__tunable_ulong_, __LINE__) = { \ 324 (path), \ 325 (var), \ 326 }; \ 327 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 328 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_ulong_init, \ 329 &__CONCAT(__tunable_ulong_, __LINE__)) 330 331 #define TUNABLE_ULONG_FETCH(path, var) getenv_ulong((path), (var)) 332 333 /* 334 * quad 335 */ 336 extern void tunable_quad_init(void *); 337 struct tunable_quad { 338 const char *path; 339 quad_t *var; 340 }; 341 #define TUNABLE_QUAD(path, var) \ 342 static struct tunable_quad __CONCAT(__tunable_quad_, __LINE__) = { \ 343 (path), \ 344 (var), \ 345 }; \ 346 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 347 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_quad_init, \ 348 &__CONCAT(__tunable_quad_, __LINE__)) 349 350 #define TUNABLE_QUAD_FETCH(path, var) getenv_quad((path), (var)) 351 352 extern void tunable_str_init(void *); 353 struct tunable_str { 354 const char *path; 355 char *var; 356 int size; 357 }; 358 #define TUNABLE_STR(path, var, size) \ 359 static struct tunable_str __CONCAT(__tunable_str_, __LINE__) = { \ 360 (path), \ 361 (var), \ 362 (size), \ 363 }; \ 364 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 365 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_str_init, \ 366 &__CONCAT(__tunable_str_, __LINE__)) 367 368 #define TUNABLE_STR_FETCH(path, var, size) \ 369 getenv_string((path), (var), (size)) 370 371 struct intr_config_hook { 372 TAILQ_ENTRY(intr_config_hook) ich_links; 373 void (*ich_func)(void *arg); 374 void *ich_arg; 375 }; 376 377 int config_intrhook_establish(struct intr_config_hook *hook); 378 void config_intrhook_disestablish(struct intr_config_hook *hook); 379 380 #endif /* !_SYS_KERNEL_H_*/ 381