1/*- 2 * SPDX-License-Identifier: BSD-4-Clause 3 * 4 * Copyright (c) 1995 Terrence R. Lambert 5 * All rights reserved. 6 * 7 * Copyright (c) 1990, 1993 8 * The Regents of the University of California. All rights reserved. 9 * (c) UNIX System Laboratories, Inc. 10 * All or some portions of this file are derived from material licensed 11 * to the University of California by American Telephone and Telegraph 12 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 13 * the permission of UNIX System Laboratories, Inc. 14 * 15 * Redistribution and use in source and binary forms, with or without 16 * modification, are permitted provided that the following conditions 17 * are met: 18 * 1. Redistributions of source code must retain the above copyright 19 * notice, this list of conditions and the following disclaimer. 20 * 2. Redistributions in binary form must reproduce the above copyright 21 * notice, this list of conditions and the following disclaimer in the 22 * documentation and/or other materials provided with the distribution. 23 * 3. All advertising materials mentioning features or use of this software 24 * must display the following acknowledgement: 25 * This product includes software developed by the University of 26 * California, Berkeley and its contributors. 27 * 4. Neither the name of the University nor the names of its contributors 28 * may be used to endorse or promote products derived from this software 29 * without specific prior written permission. 30 * 31 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 32 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 33 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 34 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 35 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 39 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 40 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 41 * SUCH DAMAGE. 42 * 43 * @(#)kernel.h 8.3 (Berkeley) 1/21/94 44 * $FreeBSD$ 45 */ 46 47#ifndef _SYS_KERNEL_H_ 48#define _SYS_KERNEL_H_ 49 50#include <sys/linker_set.h> 51 52#ifdef _KERNEL 53 54/* for intrhook below */ 55#include <sys/queue.h> 56 57/* for timestamping SYSINITs; other files may assume this is included here */ 58#include <sys/tslog.h> 59 60/* Global variables for the kernel. */ 61 62/* 1.1 */ 63extern char kernelname[MAXPATHLEN]; 64 65extern int tick; /* usec per tick (1000000 / hz) */ 66extern int hz; /* system clock's frequency */ 67extern int psratio; /* ratio: prof / stat */ 68extern int stathz; /* statistics clock's frequency */ 69extern int profhz; /* profiling clock's frequency */ 70extern int profprocs; /* number of process's profiling */ 71extern volatile int ticks; 72 73#endif /* _KERNEL */ 74 75/* 76 * Enumerated types for known system startup interfaces. 77 * 78 * Startup occurs in ascending numeric order; the list entries are 79 * sorted prior to attempting startup to guarantee order. Items 80 * of the same level are arbitrated for order based on the 'order' 81 * element. 82 * 83 * These numbers are arbitrary and are chosen ONLY for ordering; the 84 * enumeration values are explicit rather than implicit to provide 85 * for binary compatibility with inserted elements. 86 * 87 * The SI_SUB_LAST value must have the highest lexical value. 88 */ 89enum sysinit_sub_id { 90 SI_SUB_DUMMY = 0x0000000, /* not executed; for linker*/ 91 SI_SUB_DONE = 0x0000001, /* processed*/ 92 SI_SUB_TUNABLES = 0x0700000, /* establish tunable values */ 93 SI_SUB_COPYRIGHT = 0x0800001, /* first use of console*/ 94 SI_SUB_VM = 0x1000000, /* virtual memory system init */ 95 SI_SUB_COUNTER = 0x1100000, /* counter(9) is initialized */ 96 SI_SUB_KMEM = 0x1800000, /* kernel memory*/ 97 SI_SUB_HYPERVISOR = 0x1A40000, /* 98 * Hypervisor detection and 99 * virtualization support 100 * setup. 101 */ 102 SI_SUB_WITNESS = 0x1A80000, /* witness initialization */ 103 SI_SUB_MTX_POOL_DYNAMIC = 0x1AC0000, /* dynamic mutex pool */ 104 SI_SUB_LOCK = 0x1B00000, /* various locks */ 105 SI_SUB_EVENTHANDLER = 0x1C00000, /* eventhandler init */ 106 SI_SUB_VNET_PRELINK = 0x1E00000, /* vnet init before modules */ 107 SI_SUB_KLD = 0x2000000, /* KLD and module setup */ 108 SI_SUB_CPU = 0x2100000, /* CPU resource(s)*/ 109 SI_SUB_RACCT = 0x2110000, /* resource accounting */ 110 SI_SUB_KDTRACE = 0x2140000, /* Kernel dtrace hooks */ 111 SI_SUB_RANDOM = 0x2160000, /* random number generator */ 112 SI_SUB_MAC = 0x2180000, /* TrustedBSD MAC subsystem */ 113 SI_SUB_MAC_POLICY = 0x21C0000, /* TrustedBSD MAC policies */ 114 SI_SUB_MAC_LATE = 0x21D0000, /* TrustedBSD MAC subsystem */ 115 SI_SUB_VNET = 0x21E0000, /* vnet 0 */ 116 SI_SUB_INTRINSIC = 0x2200000, /* proc 0*/ 117 SI_SUB_VM_CONF = 0x2300000, /* config VM, set limits*/ 118 SI_SUB_DDB_SERVICES = 0x2380000, /* capture, scripting, etc. */ 119 SI_SUB_RUN_QUEUE = 0x2400000, /* set up run queue*/ 120 SI_SUB_KTRACE = 0x2480000, /* ktrace */ 121 SI_SUB_OPENSOLARIS = 0x2490000, /* OpenSolaris compatibility */ 122 SI_SUB_AUDIT = 0x24C0000, /* audit */ 123 SI_SUB_CREATE_INIT = 0x2500000, /* create init process*/ 124 SI_SUB_SCHED_IDLE = 0x2600000, /* required idle procs */ 125 SI_SUB_MBUF = 0x2700000, /* mbuf subsystem */ 126 SI_SUB_INTR = 0x2800000, /* interrupt threads */ 127 SI_SUB_TASKQ = 0x2880000, /* task queues */ 128 SI_SUB_EPOCH = 0x2888000, /* epoch subsystem */ 129#ifdef EARLY_AP_STARTUP 130 SI_SUB_SMP = 0x2900000, /* start the APs*/ 131#endif 132 SI_SUB_SOFTINTR = 0x2A00000, /* start soft interrupt thread */ 133 SI_SUB_DEVFS = 0x2F00000, /* devfs ready for devices */ 134 SI_SUB_INIT_IF = 0x3000000, /* prep for net interfaces */ 135 SI_SUB_NETGRAPH = 0x3010000, /* Let Netgraph initialize */ 136 SI_SUB_DTRACE = 0x3020000, /* DTrace subsystem */ 137 SI_SUB_DTRACE_PROVIDER = 0x3048000, /* DTrace providers */ 138 SI_SUB_DTRACE_ANON = 0x308C000, /* DTrace anon enabling */ 139 SI_SUB_DRIVERS = 0x3100000, /* Let Drivers initialize */ 140 SI_SUB_CONFIGURE = 0x3800000, /* Configure devices */ 141 SI_SUB_VFS = 0x4000000, /* virtual filesystem*/ 142 SI_SUB_CLOCKS = 0x4800000, /* real time and stat clocks*/ 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_PFIL = 0x8100000, /* Initialize pfil before FWs */ 151 SI_SUB_PROTO_IF = 0x8400000, /* interfaces*/ 152 SI_SUB_PROTO_DOMAININIT = 0x8600000, /* domain registration system */ 153 SI_SUB_PROTO_MC = 0x8700000, /* Multicast */ 154 SI_SUB_PROTO_DOMAIN = 0x8800000, /* domains (address families?)*/ 155 SI_SUB_PROTO_FIREWALL = 0x8806000, /* Firewalls */ 156 SI_SUB_PROTO_IFATTACHDOMAIN = 0x8808000,/* domain dependent data init */ 157 SI_SUB_PROTO_END = 0x8ffffff, /* VNET helper functions */ 158 SI_SUB_KPROF = 0x9000000, /* kernel profiling*/ 159 SI_SUB_KICK_SCHEDULER = 0xa000000, /* start the timeout events*/ 160 SI_SUB_INT_CONFIG_HOOKS = 0xa800000, /* Interrupts enabled config */ 161 SI_SUB_ROOT_CONF = 0xb000000, /* Find root devices */ 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#ifndef EARLY_AP_STARTUP 172 SI_SUB_SMP = 0xf000000, /* start the APs*/ 173#endif 174 SI_SUB_RACCTD = 0xf100000, /* start racctd*/ 175 SI_SUB_LAST = 0xfffffff /* final initialization */ 176}; 177 178/* 179 * Some enumerated orders; "ANY" sorts last. 180 */ 181enum sysinit_elem_order { 182 SI_ORDER_FIRST = 0x0000000, /* first*/ 183 SI_ORDER_SECOND = 0x0000001, /* second*/ 184 SI_ORDER_THIRD = 0x0000002, /* third*/ 185 SI_ORDER_FOURTH = 0x0000003, /* fourth*/ 186 SI_ORDER_FIFTH = 0x0000004, /* fifth*/ 187 SI_ORDER_SIXTH = 0x0000005, /* sixth*/ 188 SI_ORDER_SEVENTH = 0x0000006, /* seventh*/ 189 SI_ORDER_EIGHTH = 0x0000007, /* eighth*/ 190 SI_ORDER_MIDDLE = 0x1000000, /* somewhere in the middle */ 191 SI_ORDER_ANY = 0xfffffff /* last*/ 192}; 193 194/* 195 * A system initialization call instance 196 * 197 * At the moment there is one instance of sysinit. We probably do not 198 * want two which is why this code is if'd out, but we definitely want 199 * to discern SYSINIT's which take non-constant data pointers and 200 * SYSINIT's which take constant data pointers, 201 * 202 * The C_* macros take functions expecting const void * arguments 203 * while the non-C_* macros take functions expecting just void * arguments. 204 * 205 * With -Wcast-qual on, the compiler issues warnings: 206 * - if we pass non-const data or functions taking non-const data 207 * to a C_* macro. 208 * 209 * - if we pass const data to the normal macros 210 * 211 * However, no warning is issued if we pass a function taking const data 212 * through a normal non-const macro. This is ok because the function is 213 * saying it won't modify the data so we don't care whether the data is 214 * modifiable or not. 215 */ 216 217typedef void (*sysinit_nfunc_t)(void *); 218typedef void (*sysinit_cfunc_t)(const void *); 219 220struct sysinit { 221 enum sysinit_sub_id subsystem; /* subsystem identifier*/ 222 enum sysinit_elem_order order; /* init order within subsystem*/ 223 sysinit_cfunc_t func; /* function */ 224 const void *udata; /* multiplexer/argument */ 225}; 226 227/* 228 * Default: no special processing 229 * 230 * The C_ version of SYSINIT is for data pointers to const 231 * data ( and functions taking data pointers to const data ). 232 * At the moment it is no different from SYSINIT and thus 233 * still results in warnings. 234 * 235 * The casts are necessary to have the compiler produce the 236 * correct warnings when -Wcast-qual is used. 237 * 238 */ 239#ifdef TSLOG 240struct sysinit_tslog { 241 sysinit_cfunc_t func; 242 const void * data; 243 const char * name; 244}; 245static inline void 246sysinit_tslog_shim(const void * data) 247{ 248 const struct sysinit_tslog * x = data; 249 250 TSRAW(curthread, TS_ENTER, "SYSINIT", x->name); 251 (x->func)(x->data); 252 TSRAW(curthread, TS_EXIT, "SYSINIT", x->name); 253} 254#define C_SYSINIT(uniquifier, subsystem, order, func, ident) \ 255 static struct sysinit_tslog uniquifier ## _sys_init_tslog = { \ 256 func, \ 257 (ident), \ 258 #uniquifier \ 259 }; \ 260 static struct sysinit uniquifier ## _sys_init = { \ 261 subsystem, \ 262 order, \ 263 sysinit_tslog_shim, \ 264 &uniquifier ## _sys_init_tslog \ 265 }; \ 266 DATA_WSET(sysinit_set,uniquifier ## _sys_init) 267#else 268#define C_SYSINIT(uniquifier, subsystem, order, func, ident) \ 269 static struct sysinit uniquifier ## _sys_init = { \ 270 subsystem, \ 271 order, \ 272 func, \ 273 (ident) \ 274 }; \ 275 DATA_WSET(sysinit_set,uniquifier ## _sys_init) 276#endif 277 278#define SYSINIT(uniquifier, subsystem, order, func, ident) \ 279 C_SYSINIT(uniquifier, subsystem, order, \ 280 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident)) 281 282/* 283 * Called on module unload: no special processing 284 */ 285#define C_SYSUNINIT(uniquifier, subsystem, order, func, ident) \ 286 static struct sysinit uniquifier ## _sys_uninit = { \ 287 subsystem, \ 288 order, \ 289 func, \ 290 (ident) \ 291 }; \ 292 DATA_WSET(sysuninit_set,uniquifier ## _sys_uninit) 293 294#define SYSUNINIT(uniquifier, subsystem, order, func, ident) \ 295 C_SYSUNINIT(uniquifier, subsystem, order, \ 296 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident)) 297 298void sysinit_add(struct sysinit **set, struct sysinit **set_end); 299 300#ifdef _KERNEL 301 302/* 303 * Infrastructure for tunable 'constants'. Value may be specified at compile 304 * time or kernel load time. Rules relating tunables together can be placed 305 * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_ANY. 306 * 307 * WARNING: developers should never use the reserved suffixes specified in 308 * loader.conf(5) for any tunables or conflicts will result. 309 */ 310 311/* 312 * int 313 * please avoid using for new tunables! 314 */ 315extern void tunable_int_init(void *); 316struct tunable_int { 317 const char *path; 318 int *var; 319}; 320#define TUNABLE_INT(path, var) \ 321 static struct tunable_int __CONCAT(__tunable_int_, __LINE__) = { \ 322 (path), \ 323 (var), \ 324 }; \ 325 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 326 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int_init, \ 327 &__CONCAT(__tunable_int_, __LINE__)) 328 329#define TUNABLE_INT_FETCH(path, var) getenv_int((path), (var)) 330 331/* 332 * long 333 */ 334extern void tunable_long_init(void *); 335struct tunable_long { 336 const char *path; 337 long *var; 338}; 339#define TUNABLE_LONG(path, var) \ 340 static struct tunable_long __CONCAT(__tunable_long_, __LINE__) = { \ 341 (path), \ 342 (var), \ 343 }; \ 344 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 345 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_long_init,\ 346 &__CONCAT(__tunable_long_, __LINE__)) 347 348#define TUNABLE_LONG_FETCH(path, var) getenv_long((path), (var)) 349 350/* 351 * unsigned long 352 */ 353extern void tunable_ulong_init(void *); 354struct tunable_ulong { 355 const char *path; 356 unsigned long *var; 357}; 358#define TUNABLE_ULONG(path, var) \ 359 static struct tunable_ulong __CONCAT(__tunable_ulong_, __LINE__) = { \ 360 (path), \ 361 (var), \ 362 }; \ 363 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 364 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_ulong_init, \ 365 &__CONCAT(__tunable_ulong_, __LINE__)) 366 367#define TUNABLE_ULONG_FETCH(path, var) getenv_ulong((path), (var)) 368 369/* 370 * int64_t 371 */ 372extern void tunable_int64_init(void *); 373struct tunable_int64 { 374 const char *path; 375 int64_t *var; 376}; 377#define TUNABLE_INT64(path, var) \ 378 static struct tunable_int64 __CONCAT(__tunable_int64_, __LINE__) = { \ 379 (path), \ 380 (var), \ 381 }; \ 382 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 383 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int64_init, \ 384 &__CONCAT(__tunable_int64_, __LINE__)) 385 386#define TUNABLE_INT64_FETCH(path, var) getenv_int64((path), (var)) 387 388/* 389 * uint64_t 390 */ 391extern void tunable_uint64_init(void *); 392struct tunable_uint64 { 393 const char *path; 394 uint64_t *var; 395}; 396#define TUNABLE_UINT64(path, var) \ 397 static struct tunable_uint64 __CONCAT(__tunable_uint64_, __LINE__) = { \ 398 (path), \ 399 (var), \ 400 }; \ 401 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 402 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_uint64_init, \ 403 &__CONCAT(__tunable_uint64_, __LINE__)) 404 405#define TUNABLE_UINT64_FETCH(path, var) getenv_uint64((path), (var)) 406 407/* 408 * quad 409 */ 410extern void tunable_quad_init(void *); 411struct tunable_quad { 412 const char *path; 413 quad_t *var; 414}; 415#define TUNABLE_QUAD(path, var) \ 416 static struct tunable_quad __CONCAT(__tunable_quad_, __LINE__) = { \ 417 (path), \ 418 (var), \ 419 }; \ 420 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 421 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_quad_init, \ 422 &__CONCAT(__tunable_quad_, __LINE__)) 423 424#define TUNABLE_QUAD_FETCH(path, var) getenv_quad((path), (var)) 425 426/* 427 * bool 428 */ 429extern void tunable_bool_init(void *); 430struct tunable_bool { 431 const char *path; 432 bool *var; 433}; 434#define TUNABLE_BOOL(path, var) \ 435 static struct tunable_bool __CONCAT(__tunable_bool_, __LINE__) = { \ 436 (path), \ 437 (var), \ 438 }; \ 439 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 440 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_bool_init, \ 441 &__CONCAT(__tunable_bool_, __LINE__)) 442 443#define TUNABLE_BOOL_FETCH(path, var) getenv_bool((path), (var)) 444 445extern void tunable_str_init(void *); 446struct tunable_str { 447 const char *path; 448 char *var; 449 int size; 450}; 451#define TUNABLE_STR(path, var, size) \ 452 static struct tunable_str __CONCAT(__tunable_str_, __LINE__) = { \ 453 (path), \ 454 (var), \ 455 (size), \ 456 }; \ 457 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \ 458 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_str_init, \ 459 &__CONCAT(__tunable_str_, __LINE__)) 460 461#define TUNABLE_STR_FETCH(path, var, size) \ 462 getenv_string((path), (var), (size)) 463 464#endif /* _KERNEL */ 465 466typedef void (*ich_func_t)(void *_arg); 467 468struct intr_config_hook { 469 TAILQ_ENTRY(intr_config_hook) ich_links; 470 ich_func_t ich_func; 471 void *ich_arg; 472}; 473 474int config_intrhook_establish(struct intr_config_hook *hook); 475void config_intrhook_disestablish(struct intr_config_hook *hook); 476void config_intrhook_oneshot(ich_func_t _func, void *_arg); 477 478#endif /* !_SYS_KERNEL_H_*/ 479