FreeBSD/Linux Kernel Cross Reference
sys/sys/kernel.h
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: releng/5.1/sys/sys/kernel.h 110299 2003-02-03 19:49:35Z phk $
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 /* THIS MUST DIE! */
56 #include <sys/module.h>
57
58 /* Global variables for the kernel. */
59
60 /* 1.1 */
61 extern unsigned long hostid;
62 extern char hostname[MAXHOSTNAMELEN];
63 extern int hostnamelen;
64 extern char domainname[MAXHOSTNAMELEN];
65 extern int domainnamelen;
66 extern char kernelname[MAXPATHLEN];
67
68 /* 1.2 */
69 extern struct timeval boottime;
70
71 extern int tick; /* usec per tick (1000000 / hz) */
72 extern int hz; /* system clock's frequency */
73 extern int psratio; /* ratio: prof / stat */
74 extern int stathz; /* statistics clock's frequency */
75 extern int profhz; /* profiling clock's frequency */
76 extern int profprocs; /* number of process's profiling */
77 extern int ticks;
78 extern int lbolt; /* once a second sleep address */
79
80 extern int tz_minuteswest;
81 extern int tz_dsttime;
82
83 #endif /* _KERNEL */
84
85 /*
86 * Enumerated types for known system startup interfaces.
87 *
88 * Startup occurs in ascending numeric order; the list entries are
89 * sorted prior to attempting startup to guarantee order. Items
90 * of the same level are arbitrated for order based on the 'order'
91 * element.
92 *
93 * These numbers are arbitrary and are chosen ONLY for ordering; the
94 * enumeration values are explicit rather than implicit to provide
95 * for binary compatibility with inserted elements.
96 *
97 * The SI_SUB_RUN_SCHEDULER value must have the highest lexical value.
98 *
99 * The SI_SUB_CONSOLE and SI_SUB_SWAP values represent values used by
100 * the BSD 4.4Lite but not by FreeBSD; they are maintained in dependent
101 * order to support porting.
102 *
103 * The SI_SUB_PROTO_BEGIN and SI_SUB_PROTO_END bracket a range of
104 * initializations to take place at splimp(). This is a historical
105 * wart that should be removed -- probably running everything at
106 * splimp() until the first init that doesn't want it is the correct
107 * fix. They are currently present to ensure historical behavior.
108 */
109 enum sysinit_sub_id {
110 SI_SUB_DUMMY = 0x0000000, /* not executed; for linker*/
111 SI_SUB_DONE = 0x0000001, /* processed*/
112 SI_SUB_TUNABLES = 0x0700000, /* establish tunable values */
113 SI_SUB_CONSOLE = 0x0800000, /* console*/
114 SI_SUB_COPYRIGHT = 0x0800001, /* first use of console*/
115 SI_SUB_MTX_POOL = 0x0900000, /* mutex pool */
116 SI_SUB_VM = 0x1000000, /* virtual memory system init*/
117 SI_SUB_KMEM = 0x1800000, /* kernel memory*/
118 SI_SUB_KVM_RSRC = 0x1A00000, /* kvm operational limits*/
119 SI_SUB_WITNESS = 0x1A80000, /* witness initialization */
120 SI_SUB_LOCK = 0x1B00000, /* lockmgr locks */
121 SI_SUB_EVENTHANDLER = 0x1C00000, /* eventhandler init */
122 SI_SUB_KLD = 0x2000000, /* KLD and module setup */
123 SI_SUB_CPU = 0x2100000, /* CPU resource(s)*/
124 SI_SUB_MAC = 0x2180000, /* TrustedBSD MAC subsystem */
125 SI_SUB_MAC_POLICY = 0x21C0000, /* TrustedBSD MAC policies */
126 SI_SUB_MAC_LATE = 0x21D0000, /* TrustedBSD MAC subsystem */
127 SI_SUB_INTRINSIC = 0x2200000, /* proc 0*/
128 SI_SUB_VM_CONF = 0x2300000, /* config VM, set limits*/
129 SI_SUB_RUN_QUEUE = 0x2400000, /* set up run queue*/
130 SI_SUB_KTRACE = 0x2480000, /* ktrace */
131 SI_SUB_CREATE_INIT = 0x2500000, /* create init process*/
132 SI_SUB_SCHED_IDLE = 0x2600000, /* required idle procs */
133 SI_SUB_MBUF = 0x2700000, /* mbuf subsystem */
134 SI_SUB_INTR = 0x2800000, /* interrupt threads */
135 SI_SUB_SOFTINTR = 0x2800001, /* start soft interrupt thread */
136 SI_SUB_DEVFS = 0x2F00000, /* devfs ready for devices */
137 SI_SUB_INIT_IF = 0x3000000, /* prep for net interfaces */
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, /* XXX: set splimp (kludge)*/
150 SI_SUB_PROTO_IF = 0x8400000, /* interfaces*/
151 SI_SUB_PROTO_DOMAIN = 0x8800000, /* domains (address families?)*/
152 SI_SUB_PROTO_END = 0x8ffffff, /* XXX: set splx (kludge)*/
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_DUMP_CONF = 0xb200000, /* Find dump devices */
158 SI_SUB_VINUM = 0xb300000, /* Configure vinum */
159 SI_SUB_RAID = 0xb380000, /* Configure RAIDframe */
160 SI_SUB_MOUNT_ROOT = 0xb400000, /* root mount*/
161 SI_SUB_SWAP = 0xc000000, /* swap*/
162 SI_SUB_INTRINSIC_POST = 0xd000000, /* proc 0 cleanup*/
163 SI_SUB_KTHREAD_INIT = 0xe000000, /* init process*/
164 SI_SUB_KTHREAD_PAGE = 0xe400000, /* pageout daemon*/
165 SI_SUB_KTHREAD_VM = 0xe800000, /* vm daemon*/
166 SI_SUB_KTHREAD_BUF = 0xea00000, /* buffer daemon*/
167 SI_SUB_KTHREAD_UPDATE = 0xec00000, /* update daemon*/
168 SI_SUB_KTHREAD_IDLE = 0xee00000, /* idle procs*/
169 SI_SUB_SMP = 0xf000000, /* start the APs*/
170 SI_SUB_RUN_SCHEDULER = 0xfffffff /* scheduler*/
171 };
172
173
174 /*
175 * Some enumerated orders; "ANY" sorts last.
176 */
177 enum sysinit_elem_order {
178 SI_ORDER_FIRST = 0x0000000, /* first*/
179 SI_ORDER_SECOND = 0x0000001, /* second*/
180 SI_ORDER_THIRD = 0x0000002, /* third*/
181 SI_ORDER_MIDDLE = 0x1000000, /* somewhere in the middle */
182 SI_ORDER_ANY = 0xfffffff /* last*/
183 };
184
185
186 /*
187 * A system initialization call instance
188 *
189 * At the moment there is one instance of sysinit. We probably do not
190 * want two which is why this code is if'd out, but we definitely want
191 * to discern SYSINIT's which take non-constant data pointers and
192 * SYSINIT's which take constant data pointers,
193 *
194 * The C_* macros take functions expecting const void * arguments
195 * while the non-C_* macros take functions expecting just void * arguments.
196 *
197 * With -Wcast-qual on, the compiler issues warnings:
198 * - if we pass non-const data or functions taking non-const data
199 * to a C_* macro.
200 *
201 * - if we pass const data to the normal macros
202 *
203 * However, no warning is issued if we pass a function taking const data
204 * through a normal non-const macro. This is ok because the function is
205 * saying it won't modify the data so we don't care whether the data is
206 * modifiable or not.
207 */
208
209 typedef void (*sysinit_nfunc_t)(void *);
210 typedef void (*sysinit_cfunc_t)(const void *);
211
212 struct sysinit {
213 enum sysinit_sub_id subsystem; /* subsystem identifier*/
214 enum sysinit_elem_order order; /* init order within subsystem*/
215 sysinit_cfunc_t func; /* function */
216 const void *udata; /* multiplexer/argument */
217 };
218
219 /*
220 * Default: no special processing
221 *
222 * The C_ version of SYSINIT is for data pointers to const
223 * data ( and functions taking data pointers to const data ).
224 * At the moment it is no different from SYSINIT and thus
225 * still results in warnings.
226 *
227 * The casts are necessary to have the compiler produce the
228 * correct warnings when -Wcast-qual is used.
229 *
230 */
231 #define C_SYSINIT(uniquifier, subsystem, order, func, ident) \
232 static struct sysinit uniquifier ## _sys_init = { \
233 subsystem, \
234 order, \
235 func, \
236 (ident) \
237 }; \
238 DATA_SET(sysinit_set,uniquifier ## _sys_init);
239
240 #define SYSINIT(uniquifier, subsystem, order, func, ident) \
241 C_SYSINIT(uniquifier, subsystem, order, \
242 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))
243
244 /*
245 * Called on module unload: no special processing
246 */
247 #define C_SYSUNINIT(uniquifier, subsystem, order, func, ident) \
248 static struct sysinit uniquifier ## _sys_uninit = { \
249 subsystem, \
250 order, \
251 func, \
252 (ident) \
253 }; \
254 DATA_SET(sysuninit_set,uniquifier ## _sys_uninit)
255
256 #define SYSUNINIT(uniquifier, subsystem, order, func, ident) \
257 C_SYSUNINIT(uniquifier, subsystem, order, \
258 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))
259
260 void sysinit_add(struct sysinit **set, struct sysinit **set_end);
261
262 /*
263 * Infrastructure for tunable 'constants'. Value may be specified at compile
264 * time or kernel load time. Rules relating tunables together can be placed
265 * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_LAST.
266 */
267
268 extern void tunable_int_init(void *);
269 struct tunable_int {
270 const char *path;
271 int *var;
272 };
273 #define TUNABLE_INT(path, var) \
274 _TUNABLE_INT((path), (var), __LINE__)
275 #define _TUNABLE_INT(path, var, line) \
276 __TUNABLE_INT((path), (var), line)
277
278 #define __TUNABLE_INT(path, var, line) \
279 static struct tunable_int __tunable_int_ ## line = { \
280 path, \
281 var, \
282 }; \
283 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
284 tunable_int_init, &__tunable_int_ ## line)
285
286 #define TUNABLE_INT_FETCH(path, var) getenv_int((path), (var))
287
288 extern void tunable_quad_init(void *);
289 struct tunable_quad {
290 const char *path;
291 quad_t *var;
292 };
293 #define TUNABLE_QUAD(path, var) \
294 _TUNABLE_QUAD((path), (var), __LINE__)
295 #define _TUNABLE_QUAD(path, var, line) \
296 __TUNABLE_QUAD((path), (var), line)
297
298 #define __TUNABLE_QUAD(path, var, line) \
299 static struct tunable_quad __tunable_quad_ ## line = { \
300 path, \
301 var, \
302 }; \
303 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
304 tunable_quad_init, &__tunable_quad_ ## line)
305
306 #define TUNABLE_QUAD_FETCH(path, var) getenv_quad((path), (var))
307
308 extern void tunable_str_init(void *);
309 struct tunable_str {
310 const char *path;
311 char *var;
312 int size;
313 };
314 #define TUNABLE_STR(path, var, size) \
315 _TUNABLE_STR((path), (var), (size), __LINE__)
316 #define _TUNABLE_STR(path, var, size, line) \
317 __TUNABLE_STR((path), (var), (size), line)
318
319 #define __TUNABLE_STR(path, var, size, line) \
320 static struct tunable_str __tunable_str_ ## line = { \
321 path, \
322 var, \
323 size, \
324 }; \
325 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
326 tunable_str_init, &__tunable_str_ ## line)
327
328 #define TUNABLE_STR_FETCH(path, var, size) \
329 getenv_string((path), (var), (size))
330
331 struct intr_config_hook {
332 TAILQ_ENTRY(intr_config_hook) ich_links;
333 void (*ich_func)(void *arg);
334 void *ich_arg;
335 };
336
337 int config_intrhook_establish(struct intr_config_hook *hook);
338 void config_intrhook_disestablish(struct intr_config_hook *hook);
339
340 #endif /* !_SYS_KERNEL_H_*/
Cache object: add58034e15445afc37dde022e2888b3
|