kernel - add missing header commit to interrupt config hooks changes
[dragonfly.git] / sys / sys / kernel.h
CommitLineData
984263bc
MD
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: src/sys/sys/kernel.h,v 1.63.2.9 2002/07/02 23:00:30 archie Exp $
4c202dcc 43 * $DragonFly: src/sys/sys/kernel.h,v 1.32 2008/08/25 17:11:23 dillon Exp $
984263bc
MD
44 */
45
46#ifndef _SYS_KERNEL_H_
47#define _SYS_KERNEL_H_
48
03d6a592
MD
49#ifndef _KERNEL
50#error "This file should not be included by userland programs."
51#else
52
1bd40720
MD
53#ifndef _SYS_PARAM_H_
54#include <sys/param.h>
55#endif
56#ifndef _SYS_LINKER_SET_H_
984263bc 57#include <sys/linker_set.h>
1bd40720 58#endif
984263bc 59
03d6a592 60#ifndef _SYS_QUEUE_H_
984263bc 61#include <sys/queue.h>
03d6a592 62#endif
984263bc
MD
63
64/* Global variables for the kernel. */
65
66/* 1.1 */
67extern unsigned long hostid;
68extern char hostname[MAXHOSTNAMELEN];
69extern int hostnamelen;
70extern char domainname[MAXHOSTNAMELEN];
71extern int domainnamelen;
72extern char kernelname[MAXPATHLEN];
73
74/* 1.2 */
88c4d2f6 75extern struct timespec boottime;
984263bc
MD
76
77extern struct timezone tz; /* XXX */
78
79extern int tick; /* usec per tick (1000000 / hz) */
80extern int tickadj; /* "standard" clock skew, us./tick */
81extern int hz; /* system clock's frequency */
82extern int psratio; /* ratio: prof / stat */
83extern int stathz; /* statistics clock's frequency */
84extern int profhz; /* profiling clock's frequency */
85extern int ticks;
86extern int lbolt; /* once a second sleep address */
344ad853 87extern int lbolt_syncer; /* approx 1 hz but may be sped up */
984263bc 88
984263bc
MD
89/*
90 * Enumerated types for known system startup interfaces.
91 *
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'
95 * element.
96 *
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.
100 *
101 * The SI_SUB_RUN_SCHEDULER value must have the highest lexical value.
984263bc
MD
102 */
103enum sysinit_sub_id {
ba39e2e0
MD
104 /*
105 * Special cased
106 */
107 SI_SPECIAL_DUMMY = 0x0000000, /* not executed; for linker*/
108 SI_SPECIAL_DONE = 0x0000001, /* flag sysinit completion */
109
110 /*
111 * Memory management subsystems.
112 */
113 SI_BOOT1_TUNABLES = 0x0700000, /* establish tunable values */
114 SI_BOOT1_COPYRIGHT = 0x0800000, /* first use of console*/
115 SI_BOOT1_LOCK = 0x0900000, /* lockmgr locks and tokens */
116 SI_BOOT1_VM = 0x1000000, /* virtual memory system init*/
117 SI_BOOT1_ALLOCATOR = 0x1400000, /* slab allocator */
118 SI_BOOT1_KMALLOC = 0x1600000, /* kmalloc inits */
119 SI_BOOT1_POST = 0x1800000, /* post boot1 inits */
120
121 /*
122 * Fickle ordering. objcache and softclock need to know what
123 * ncpus is to initialize properly, clocks (e.g. hardclock)
124 * need softclock to work, and we can't finish initializing
125 * the APs until the system clock has been initialized.
126 * Also, clock registration and smp configuration registration
127 * must occur before SMP. Messy messy.
128 */
129 SI_BOOT2_LEAVE_CRIT = 0x1900000,
ba39e2e0
MD
130 SI_BOOT2_PRESMP = 0x1a00000, /* register smp configs */
131 SI_BOOT2_SMP = 0x1a80000, /* SMP startup */
7ce8a225 132 SI_BOOT2_CLOCKREG = 0x1ac0000, /* register available clocks */
ba39e2e0
MD
133 SI_BOOT2_OBJCACHE = 0x1b00000,
134 SI_BOOT2_SOFTCLOCK = 0x1b80000,
135 SI_BOOT2_CLOCKS = 0x1c00000, /* select & start clocks */
136 SI_BOOT2_FINISH_SMP = 0x1c80000, /* SMP go (& synch clocks) */
137
138 /*
139 * Finish up core kernel initialization and set up the process
140 * abstraction.
141 */
142 SI_BOOT2_BIOS = 0x1d00000,
143 SI_BOOT2_MACHDEP = 0x1d80000,
144 SI_BOOT2_KLD = 0x1e00000,
145 SI_BOOT2_USCHED = 0x1e80000,
146 SI_BOOT2_PROC0 = 0x1f00000,
147
148 /*
149 * Continue with miscellanious system initialization
150 */
984263bc 151 SI_SUB_CREATE_INIT = 0x2300000, /* create the init process */
b2632176 152 SI_SUB_PRE_DRIVERS = 0x2380000,
984263bc
MD
153 SI_SUB_DRIVERS = 0x2400000, /* Let Drivers initialize */
154 SI_SUB_CONFIGURE = 0x3800000, /* Configure devices */
dbcd0c9b 155 SI_SUB_ISWARM = 0x3c00000, /* No longer in cold boot */
984263bc 156 SI_SUB_VFS = 0x4000000, /* virtual file system*/
8b3ec75a 157 SI_SUB_HELPER_THREADS = 0x5400000, /* misc helper threads */
984263bc
MD
158 SI_SUB_CLIST = 0x5800000, /* clists*/
159 SI_SUB_SYSV_SHM = 0x6400000, /* System V shared memory*/
160 SI_SUB_SYSV_SEM = 0x6800000, /* System V semaphores*/
161 SI_SUB_SYSV_MSG = 0x6C00000, /* System V message queues*/
162 SI_SUB_P1003_1B = 0x6E00000, /* P1003.1B realtime */
163 SI_SUB_PSEUDO = 0x7000000, /* pseudo devices*/
164 SI_SUB_EXEC = 0x7400000, /* execve() handlers */
aabba8b4
MD
165 SI_SUB_PROTO_BEGIN = 0x8000000, /* network protocol pre-init */
166 SI_SUB_PROTO_IF = 0x8400000, /* interfaces */
984263bc 167 SI_SUB_PROTO_DOMAIN = 0x8800000, /* domains (address families?)*/
aabba8b4
MD
168 SI_SUB_PROTO_IFATTACHDOMAIN
169 = 0x8800001, /* domain dependent data init */
170 SI_SUB_PROTO_END = 0x8ffffff, /* network protocol post-init */
984263bc
MD
171 SI_SUB_KPROF = 0x9000000, /* kernel profiling*/
172 SI_SUB_KICK_SCHEDULER = 0xa000000, /* start the timeout events*/
173 SI_SUB_INT_CONFIG_HOOKS = 0xa800000, /* Interrupts enabled config */
ba39e2e0
MD
174
175 /*
176 * Root filesystem setup, finish up with the major system
177 * demons.
178 */
984263bc
MD
179 SI_SUB_ROOT_CONF = 0xb000000, /* Find root devices */
180 SI_SUB_DUMP_CONF = 0xb200000, /* Find dump devices */
5dbaf12c 181 SI_SUB_RAID = 0xb300000, /* Configure vinum */
984263bc 182 SI_SUB_MOUNT_ROOT = 0xb400000, /* root mount*/
ba39e2e0 183 SI_SUB_PROC0_POST = 0xd000000, /* proc 0 cleanup*/
984263bc
MD
184 SI_SUB_KTHREAD_INIT = 0xe000000, /* init process*/
185 SI_SUB_KTHREAD_PAGE = 0xe400000, /* pageout daemon*/
186 SI_SUB_KTHREAD_VM = 0xe800000, /* vm daemon*/
187 SI_SUB_KTHREAD_BUF = 0xea00000, /* buffer daemon*/
188 SI_SUB_KTHREAD_UPDATE = 0xec00000, /* update daemon*/
189 SI_SUB_KTHREAD_IDLE = 0xee00000, /* idle procs*/
984263bc
MD
190 SI_SUB_RUN_SCHEDULER = 0xfffffff /* scheduler: no return*/
191};
192
193
194/*
195 * Some enumerated orders; "ANY" sorts last.
196 */
197enum sysinit_elem_order {
198 SI_ORDER_FIRST = 0x0000000, /* first*/
199 SI_ORDER_SECOND = 0x0000001, /* second*/
200 SI_ORDER_THIRD = 0x0000002, /* third*/
201 SI_ORDER_MIDDLE = 0x1000000, /* somewhere in the middle */
202 SI_ORDER_ANY = 0xfffffff /* last*/
203};
204
205
206/*
207 * A system initialization call instance
208 *
209 * At the moment there is one instance of sysinit. We probably do not
210 * want two which is why this code is if'd out, but we definitely want
211 * to discern SYSINIT's which take non-constant data pointers and
212 * SYSINIT's which take constant data pointers,
213 *
214 * The C_* macros take functions expecting const void * arguments
215 * while the non-C_* macros take functions expecting just void * arguments.
216 *
217 * With -Wcast-qual on, the compiler issues warnings:
218 * - if we pass non-const data or functions taking non-const data
219 * to a C_* macro.
220 *
221 * - if we pass const data to the normal macros
222 *
223 * However, no warning is issued if we pass a function taking const data
224 * through a normal non-const macro. This is ok because the function is
225 * saying it won't modify the data so we don't care whether the data is
226 * modifiable or not.
227 */
228
b153f746
RG
229typedef void (*sysinit_nfunc_t) (void *);
230typedef void (*sysinit_cfunc_t) (const void *);
984263bc
MD
231
232struct sysinit {
233 unsigned int subsystem; /* subsystem identifier*/
234 unsigned int order; /* init order within subsystem*/
235 sysinit_cfunc_t func; /* function */
236 const void *udata; /* multiplexer/argument */
4c202dcc 237 const char *name;
984263bc
MD
238};
239
240/*
241 * Default: no special processing
242 *
243 * The C_ version of SYSINIT is for data pointers to const
244 * data ( and functions taking data pointers to const data ).
245 * At the moment it is no different from SYSINIT and thus
246 * still results in warnings.
247 *
248 * The casts are necessary to have the compiler produce the
249 * correct warnings when -Wcast-qual is used.
250 *
251 */
252#define C_SYSINIT(uniquifier, subsystem, order, func, ident) \
253 static struct sysinit uniquifier ## _sys_init = { \
254 subsystem, \
255 order, \
256 func, \
4c202dcc
MD
257 ident, \
258 #uniquifier \
984263bc
MD
259 }; \
260 DATA_SET(sysinit_set,uniquifier ## _sys_init);
261
262#define SYSINIT(uniquifier, subsystem, order, func, ident) \
263 C_SYSINIT(uniquifier, subsystem, order, \
264 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
265
266/*
267 * Called on module unload: no special processing
268 */
269#define C_SYSUNINIT(uniquifier, subsystem, order, func, ident) \
270 static struct sysinit uniquifier ## _sys_uninit = { \
271 subsystem, \
272 order, \
273 func, \
274 ident \
275 }; \
276 DATA_SET(sysuninit_set,uniquifier ## _sys_uninit)
277
278#define SYSUNINIT(uniquifier, subsystem, order, func, ident) \
279 C_SYSUNINIT(uniquifier, subsystem, order, \
280 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
281
005f09fe 282void sysinit_add (struct sysinit **, struct sysinit **);
984263bc
MD
283
284/*
285 * Infrastructure for tunable 'constants'. Value may be specified at compile
286 * time or kernel load time. Rules relating tunables together can be placed
ba39e2e0 287 * in a SYSINIT function at SI_BOOT1_TUNABLES with SI_ORDER_LAST.
984263bc
MD
288 */
289
290extern void tunable_int_init(void *);
03d6a592 291
984263bc
MD
292struct tunable_int {
293 const char *path;
294 int *var;
295};
296#define TUNABLE_INT(path, var) \
297 _TUNABLE_INT((path), (var), __LINE__)
298#define _TUNABLE_INT(path, var, line) \
299 __TUNABLE_INT((path), (var), line)
300
301#define __TUNABLE_INT(path, var, line) \
302 static struct tunable_int __tunable_int_ ## line = { \
303 path, \
304 var, \
305 }; \
ba39e2e0
MD
306 SYSINIT(__Tunable_init_ ## line, \
307 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE, \
308 tunable_int_init, &__tunable_int_ ## line)
984263bc 309
bc01a404 310#define TUNABLE_INT_FETCH(path, var) kgetenv_int((path), (var))
79634a66 311#define TUNABLE_LONG_FETCH(path, var) kgetenv_long((path), (var))
984263bc 312
9a7c6212 313/* Backwards compatibility with the old deprecated TUNABLE_INT_DECL API */
984263bc
MD
314#define TUNABLE_INT_DECL(path, defval, var) \
315static void __Tunable_ ## var (void *ignored) \
316{ \
317 (var) = (defval); \
318 TUNABLE_INT_FETCH((path), &(var)); \
319} \
ba39e2e0
MD
320SYSINIT(__Tunable_init_ ## var, SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE, \
321 __Tunable_ ## var , NULL);
984263bc 322
28a93126
MD
323#define TUNABLE_ULONG_FETCH(path, var) kgetenv_ulong((path), (var))
324
984263bc
MD
325extern void tunable_quad_init(void *);
326struct tunable_quad {
327 const char *path;
328 quad_t *var;
329};
330#define TUNABLE_QUAD(path, var) \
331 _TUNABLE_QUAD((path), (var), __LINE__)
332#define _TUNABLE_QUAD(path, var, line) \
333 __TUNABLE_QUAD((path), (var), line)
334
335#define __TUNABLE_QUAD(path, var, line) \
336 static struct tunable_quad __tunable_quad_ ## line = { \
337 path, \
338 var, \
339 }; \
ba39e2e0
MD
340 SYSINIT(__Tunable_init_ ## line, \
341 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE, \
342 tunable_quad_init, &__tunable_quad_ ## line)
984263bc 343
bc01a404 344#define TUNABLE_QUAD_FETCH(path, var) kgetenv_quad((path), (var))
984263bc
MD
345
346extern void tunable_str_init(void *);
347struct tunable_str {
348 const char *path;
349 char *var;
350 int size;
351};
352#define TUNABLE_STR(path, var, size) \
353 _TUNABLE_STR((path), (var), (size), __LINE__)
354#define _TUNABLE_STR(path, var, size, line) \
355 __TUNABLE_STR((path), (var), (size), line)
356
357#define __TUNABLE_STR(path, var, size, line) \
358 static struct tunable_str __tunable_str_ ## line = { \
359 path, \
360 var, \
361 size, \
362 }; \
ba39e2e0
MD
363 SYSINIT(__Tunable_init_ ## line, \
364 SI_BOOT1_TUNABLES, SI_ORDER_MIDDLE, \
365 tunable_str_init, &__tunable_str_ ## line)
984263bc
MD
366
367#define TUNABLE_STR_FETCH(path, var, size) \
bc01a404 368 kgetenv_string((path), (var), (size))
984263bc
MD
369
370/*
371 * Compatibility. To be deprecated after LKM is removed.
372 */
03d6a592 373#ifndef _SYS_MODULE_H_
984263bc 374#include <sys/module.h>
03d6a592
MD
375#endif
376
984263bc
MD
377#define PSEUDO_SET(sym, name) \
378 static int name ## _modevent(module_t mod, int type, void *data) \
379 { \
380 void (*initfunc)(void *) = (void (*)(void *))data; \
381 switch (type) { \
382 case MOD_LOAD: \
26be20a0 383 /* kprintf(#name " module load\n"); */ \
984263bc
MD
384 initfunc(NULL); \
385 break; \
386 case MOD_UNLOAD: \
26be20a0 387 kprintf(#name " module unload - not possible for this module type\n"); \
984263bc
MD
388 return EINVAL; \
389 } \
390 return 0; \
391 } \
392 static moduledata_t name ## _mod = { \
393 #name, \
394 name ## _modevent, \
395 (void *)sym \
396 }; \
397 DECLARE_MODULE(name, name ## _mod, SI_SUB_PSEUDO, SI_ORDER_ANY)
398
399extern struct linker_set execsw_set;
400
984263bc
MD
401struct intr_config_hook {
402 TAILQ_ENTRY(intr_config_hook) ich_links;
005f09fe 403 void (*ich_func) (void *);
984263bc 404 void *ich_arg;
a1e26a0c 405 const char *ich_desc;
cce90053 406 int ich_order;
12e8c583 407 int ich_ran;
984263bc
MD
408};
409
005f09fe
JS
410int config_intrhook_establish (struct intr_config_hook *);
411void config_intrhook_disestablish (struct intr_config_hook *);
984263bc 412
03d6a592 413#endif /* _KERNEL */
984263bc 414#endif /* !_SYS_KERNEL_H_*/