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