2 * Copyright (c) 1995 Terrence R. Lambert
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.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
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.
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
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.25 2006/12/23 02:58:09 swildner Exp $
46 #ifndef _SYS_KERNEL_H_
47 #define _SYS_KERNEL_H_
50 #error "This file should not be included by userland programs."
54 #include <sys/param.h>
56 #ifndef _SYS_LINKER_SET_H_
57 #include <sys/linker_set.h>
61 #include <sys/queue.h>
64 /* Global variables for the kernel. */
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];
75 extern struct timespec boottime;
77 extern struct timezone tz; /* XXX */
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 */
86 extern int lbolt; /* once a second sleep address */
87 extern int lbolt_syncer; /* approx 1 hz but may be sped up */
90 * Enumerated types for known system startup interfaces.
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'
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.
101 * The SI_SUB_RUN_SCHEDULER value must have the highest lexical value.
103 * The SI_SUB_CONSOLE and SI_SUB_SWAP values represent values used by
104 * the BSD 4.4Lite but not by FreeBSD; they are maintained in dependent
105 * order to support porting.
107 enum sysinit_sub_id {
108 SI_SUB_DUMMY = 0x0000000, /* not executed; for linker*/
109 SI_SUB_DONE = 0x0000001, /* processed*/
110 SI_SUB_TUNABLES = 0x0700000, /* establish tunable values */
111 SI_SUB_CONSOLE = 0x0800000, /* console*/
112 SI_SUB_COPYRIGHT = 0x0800001, /* first use of console*/
113 SI_SUB_LOCK = 0x0900000, /* lockmgr locks and tokens */
114 SI_SUB_VM = 0x1000000, /* virtual memory system init*/
115 SI_SUB_KMEM = 0x1800000, /* kernel memory*/
116 SI_SUB_KVM_RSRC = 0x1A00000, /* kvm operational limits*/
117 SI_SUB_CPU = 0x1e00000, /* CPU resource(s)*/
118 SI_SUB_OBJCACHE = 0x1e80000, /* inits w/ objcache/malloc */
119 SI_SUB_KLD = 0x1f00000, /* KLD and module setup */
120 SI_SUB_INTRINSIC = 0x2000000, /* proc 0*/
121 SI_SUB_VM_CONF = 0x2100000, /* config VM, set limits*/
122 SI_SUB_RUN_QUEUE = 0x2200000, /* the run queue*/
123 SI_SUB_CREATE_INIT = 0x2300000, /* create the init process */
124 SI_SUB_MBUF = 0x2380000, /* mbuf subsystem */
125 SI_SUB_LEAVE_CRIT = 0x23c0000, /* allow interrupt operation */
126 SI_SUB_DRIVERS = 0x2400000, /* Let Drivers initialize */
127 SI_SUB_CONFIGURE = 0x3800000, /* Configure devices */
128 SI_SUB_VFS = 0x4000000, /* virtual file system*/
129 SI_SUB_CLOCKS = 0x4800000, /* real time and stat clocks*/
130 SI_SUB_FINISH_SMP = 0x5000000, /* finish setting up cpus */
131 SI_SUB_HELPER_THREADS = 0x5400000, /* misc helper threads */
132 SI_SUB_CLIST = 0x5800000, /* clists*/
133 SI_SUB_SYSV_SHM = 0x6400000, /* System V shared memory*/
134 SI_SUB_SYSV_SEM = 0x6800000, /* System V semaphores*/
135 SI_SUB_SYSV_MSG = 0x6C00000, /* System V message queues*/
136 SI_SUB_P1003_1B = 0x6E00000, /* P1003.1B realtime */
137 SI_SUB_PSEUDO = 0x7000000, /* pseudo devices*/
138 SI_SUB_EXEC = 0x7400000, /* execve() handlers */
139 SI_SUB_PROTO_BEGIN = 0x8000000, /* network protocol pre-init */
140 SI_SUB_PROTO_IF = 0x8400000, /* interfaces */
141 SI_SUB_PROTO_DOMAIN = 0x8800000, /* domains (address families?)*/
142 SI_SUB_PROTO_IFATTACHDOMAIN
143 = 0x8800001, /* domain dependent data init */
144 SI_SUB_PROTO_END = 0x8ffffff, /* network protocol post-init */
145 SI_SUB_KPROF = 0x9000000, /* kernel profiling*/
146 SI_SUB_KICK_SCHEDULER = 0xa000000, /* start the timeout events*/
147 SI_SUB_INT_CONFIG_HOOKS = 0xa800000, /* Interrupts enabled config */
148 SI_SUB_ROOT_CONF = 0xb000000, /* Find root devices */
149 SI_SUB_DUMP_CONF = 0xb200000, /* Find dump devices */
150 SI_SUB_RAID = 0xb300000, /* Configure vinum */
151 SI_SUB_MOUNT_ROOT = 0xb400000, /* root mount*/
152 SI_SUB_SWAP = 0xc000000, /* swap*/
153 SI_SUB_INTRINSIC_POST = 0xd000000, /* proc 0 cleanup*/
154 SI_SUB_KTHREAD_INIT = 0xe000000, /* init process*/
155 SI_SUB_KTHREAD_PAGE = 0xe400000, /* pageout daemon*/
156 SI_SUB_KTHREAD_VM = 0xe800000, /* vm daemon*/
157 SI_SUB_KTHREAD_BUF = 0xea00000, /* buffer daemon*/
158 SI_SUB_KTHREAD_UPDATE = 0xec00000, /* update daemon*/
159 SI_SUB_KTHREAD_IDLE = 0xee00000, /* idle procs*/
160 SI_SUB_SMP = 0xf000000, /* idle procs*/
161 SI_SUB_RUN_SCHEDULER = 0xfffffff /* scheduler: no return*/
166 * Some enumerated orders; "ANY" sorts last.
168 enum sysinit_elem_order {
169 SI_ORDER_FIRST = 0x0000000, /* first*/
170 SI_ORDER_SECOND = 0x0000001, /* second*/
171 SI_ORDER_THIRD = 0x0000002, /* third*/
172 SI_ORDER_MIDDLE = 0x1000000, /* somewhere in the middle */
173 SI_ORDER_ANY = 0xfffffff /* last*/
178 * A system initialization call instance
180 * At the moment there is one instance of sysinit. We probably do not
181 * want two which is why this code is if'd out, but we definitely want
182 * to discern SYSINIT's which take non-constant data pointers and
183 * SYSINIT's which take constant data pointers,
185 * The C_* macros take functions expecting const void * arguments
186 * while the non-C_* macros take functions expecting just void * arguments.
188 * With -Wcast-qual on, the compiler issues warnings:
189 * - if we pass non-const data or functions taking non-const data
192 * - if we pass const data to the normal macros
194 * However, no warning is issued if we pass a function taking const data
195 * through a normal non-const macro. This is ok because the function is
196 * saying it won't modify the data so we don't care whether the data is
200 typedef void (*sysinit_nfunc_t) (void *);
201 typedef void (*sysinit_cfunc_t) (const void *);
204 unsigned int subsystem; /* subsystem identifier*/
205 unsigned int order; /* init order within subsystem*/
206 sysinit_cfunc_t func; /* function */
207 const void *udata; /* multiplexer/argument */
211 * Default: no special processing
213 * The C_ version of SYSINIT is for data pointers to const
214 * data ( and functions taking data pointers to const data ).
215 * At the moment it is no different from SYSINIT and thus
216 * still results in warnings.
218 * The casts are necessary to have the compiler produce the
219 * correct warnings when -Wcast-qual is used.
222 #define C_SYSINIT(uniquifier, subsystem, order, func, ident) \
223 static struct sysinit uniquifier ## _sys_init = { \
229 DATA_SET(sysinit_set,uniquifier ## _sys_init);
231 #define SYSINIT(uniquifier, subsystem, order, func, ident) \
232 C_SYSINIT(uniquifier, subsystem, order, \
233 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
236 * Called on module unload: no special processing
238 #define C_SYSUNINIT(uniquifier, subsystem, order, func, ident) \
239 static struct sysinit uniquifier ## _sys_uninit = { \
245 DATA_SET(sysuninit_set,uniquifier ## _sys_uninit)
247 #define SYSUNINIT(uniquifier, subsystem, order, func, ident) \
248 C_SYSUNINIT(uniquifier, subsystem, order, \
249 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
251 void sysinit_add (struct sysinit **, struct sysinit **);
254 * Infrastructure for tunable 'constants'. Value may be specified at compile
255 * time or kernel load time. Rules relating tunables together can be placed
256 * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_LAST.
259 extern void tunable_int_init(void *);
265 #define TUNABLE_INT(path, var) \
266 _TUNABLE_INT((path), (var), __LINE__)
267 #define _TUNABLE_INT(path, var, line) \
268 __TUNABLE_INT((path), (var), line)
270 #define __TUNABLE_INT(path, var, line) \
271 static struct tunable_int __tunable_int_ ## line = { \
275 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
276 tunable_int_init, &__tunable_int_ ## line)
278 #define TUNABLE_INT_FETCH(path, var) kgetenv_int((path), (var))
280 /* Backwards compatibility with the old deprecated TUNABLE_INT_DECL API */
281 #define TUNABLE_INT_DECL(path, defval, var) \
282 static void __Tunable_ ## var (void *ignored) \
285 TUNABLE_INT_FETCH((path), &(var)); \
287 SYSINIT(__Tunable_init_ ## var, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, __Tunable_ ## var , NULL);
289 extern void tunable_quad_init(void *);
290 struct tunable_quad {
294 #define TUNABLE_QUAD(path, var) \
295 _TUNABLE_QUAD((path), (var), __LINE__)
296 #define _TUNABLE_QUAD(path, var, line) \
297 __TUNABLE_QUAD((path), (var), line)
299 #define __TUNABLE_QUAD(path, var, line) \
300 static struct tunable_quad __tunable_quad_ ## line = { \
304 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
305 tunable_quad_init, &__tunable_quad_ ## line)
307 #define TUNABLE_QUAD_FETCH(path, var) kgetenv_quad((path), (var))
309 extern void tunable_str_init(void *);
315 #define TUNABLE_STR(path, var, size) \
316 _TUNABLE_STR((path), (var), (size), __LINE__)
317 #define _TUNABLE_STR(path, var, size, line) \
318 __TUNABLE_STR((path), (var), (size), line)
320 #define __TUNABLE_STR(path, var, size, line) \
321 static struct tunable_str __tunable_str_ ## line = { \
326 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
327 tunable_str_init, &__tunable_str_ ## line)
329 #define TUNABLE_STR_FETCH(path, var, size) \
330 kgetenv_string((path), (var), (size))
333 * Compatibility. To be deprecated after LKM is removed.
335 #ifndef _SYS_MODULE_H_
336 #include <sys/module.h>
339 #define PSEUDO_SET(sym, name) \
340 static int name ## _modevent(module_t mod, int type, void *data) \
342 void (*initfunc)(void *) = (void (*)(void *))data; \
345 /* kprintf(#name " module load\n"); */ \
349 kprintf(#name " module unload - not possible for this module type\n"); \
354 static moduledata_t name ## _mod = { \
359 DECLARE_MODULE(name, name ## _mod, SI_SUB_PSEUDO, SI_ORDER_ANY)
361 extern struct linker_set execsw_set;
363 struct intr_config_hook {
364 TAILQ_ENTRY(intr_config_hook) ich_links;
365 void (*ich_func) (void *);
367 const char *ich_desc;
370 int config_intrhook_establish (struct intr_config_hook *);
371 void config_intrhook_disestablish (struct intr_config_hook *);
374 #endif /* !_SYS_KERNEL_H_*/