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