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/6.1/sys/sys/kernel.h 158179 2006-04-30 16:44:43Z cvs2svn $
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_AUDIT = 0x24C0000, /* audit */
129 SI_SUB_CREATE_INIT = 0x2500000, /* create init process*/
130 SI_SUB_SCHED_IDLE = 0x2600000, /* required idle procs */
131 SI_SUB_MBUF = 0x2700000, /* mbuf subsystem */
132 SI_SUB_INTR = 0x2800000, /* interrupt threads */
133 SI_SUB_SOFTINTR = 0x2800001, /* start soft interrupt thread */
134 SI_SUB_ACL = 0x2900000, /* start for filesystem ACLs */
135 SI_SUB_DEVFS = 0x2F00000, /* devfs ready for devices */
136 SI_SUB_INIT_IF = 0x3000000, /* prep for net interfaces */
137 SI_SUB_NETGRAPH = 0x3010000, /* Let Netgraph initialize */
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_IFATTACHDOMAIN = 0x8800001, /* domain dependent data init*/
153 SI_SUB_PROTO_END = 0x8ffffff, /* XXX: set splx (kludge)*/
154 SI_SUB_KPROF = 0x9000000, /* kernel profiling*/
155 SI_SUB_KICK_SCHEDULER = 0xa000000, /* start the timeout events*/
156 SI_SUB_INT_CONFIG_HOOKS = 0xa800000, /* Interrupts enabled config */
157 SI_SUB_ROOT_CONF = 0xb000000, /* Find root devices */
158 SI_SUB_DUMP_CONF = 0xb200000, /* Find dump devices */
159 SI_SUB_RAID = 0xb380000, /* Configure GEOM classes */
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 * WARNING: developers should never use the reserved suffixes specified in
268 * loader.conf(5) for any tunables or conflicts will result.
269 */
270
271 /*
272 * int
273 * please avoid using for new tunables!
274 */
275 extern void tunable_int_init(void *);
276 struct tunable_int {
277 const char *path;
278 int *var;
279 };
280 #define TUNABLE_INT(path, var) \
281 static struct tunable_int __CONCAT(__tunable_int_, __LINE__) = { \
282 (path), \
283 (var), \
284 }; \
285 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \
286 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int_init, \
287 &__CONCAT(__tunable_int_, __LINE__))
288
289 #define TUNABLE_INT_FETCH(path, var) getenv_int((path), (var))
290
291 /*
292 * long
293 */
294 extern void tunable_long_init(void *);
295 struct tunable_long {
296 const char *path;
297 long *var;
298 };
299 #define TUNABLE_LONG(path, var) \
300 static struct tunable_long __CONCAT(__tunable_long_, __LINE__) = { \
301 (path), \
302 (var), \
303 }; \
304 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \
305 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_long_init,\
306 &__CONCAT(__tunable_long_, __LINE__))
307
308 #define TUNABLE_LONG_FETCH(path, var) getenv_long((path), (var))
309
310 /*
311 * unsigned long
312 */
313 extern void tunable_ulong_init(void *);
314 struct tunable_ulong {
315 const char *path;
316 unsigned long *var;
317 };
318 #define TUNABLE_ULONG(path, var) \
319 static struct tunable_ulong __CONCAT(__tunable_ulong_, __LINE__) = { \
320 (path), \
321 (var), \
322 }; \
323 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \
324 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_ulong_init, \
325 &__CONCAT(__tunable_ulong_, __LINE__))
326
327 #define TUNABLE_ULONG_FETCH(path, var) getenv_ulong((path), (var))
328
329 extern void tunable_str_init(void *);
330 struct tunable_str {
331 const char *path;
332 char *var;
333 int size;
334 };
335 #define TUNABLE_STR(path, var, size) \
336 static struct tunable_str __CONCAT(__tunable_str_, __LINE__) = { \
337 (path), \
338 (var), \
339 (size), \
340 }; \
341 SYSINIT(__CONCAT(__Tunable_init_, __LINE__), \
342 SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_str_init, \
343 &__CONCAT(__tunable_str_, __LINE__))
344
345 #define TUNABLE_STR_FETCH(path, var, size) \
346 getenv_string((path), (var), (size))
347
348 void net_warn_not_mpsafe(const char *component);
349 #define NET_NEEDS_GIANT(component) \
350 SYSINIT(__CONCAT(__net_warn_not_mpsafe_, __LINE__), \
351 SI_SUB_SETTINGS, SI_ORDER_SECOND, net_warn_not_mpsafe, component);
352
353 struct intr_config_hook {
354 TAILQ_ENTRY(intr_config_hook) ich_links;
355 void (*ich_func)(void *arg);
356 void *ich_arg;
357 };
358
359 int config_intrhook_establish(struct intr_config_hook *hook);
360 void config_intrhook_disestablish(struct intr_config_hook *hook);
361
362 #endif /* !_SYS_KERNEL_H_*/
Cache object: 98f165190f5271fe807c5027986b1a48
|