This commit represents a major revamping of the clock interrupt and timebase
[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 $
88c4d2f6 43 * $DragonFly: src/sys/sys/kernel.h,v 1.8 2004/01/30 05:42:17 dillon Exp $
984263bc
MD
44 */
45
46#ifndef _SYS_KERNEL_H_
47#define _SYS_KERNEL_H_
48
49#include <sys/linker_set.h>
50
51#ifdef _KERNEL
52
53/* for intrhook below */
54#include <sys/queue.h>
55
56/* Global variables for the kernel. */
57
58/* 1.1 */
59extern unsigned long hostid;
60extern char hostname[MAXHOSTNAMELEN];
61extern int hostnamelen;
62extern char domainname[MAXHOSTNAMELEN];
63extern int domainnamelen;
64extern char kernelname[MAXPATHLEN];
65
66/* 1.2 */
88c4d2f6
MD
67extern struct timespec boottime;
68extern struct timespec basetime;
984263bc
MD
69
70extern struct timezone tz; /* XXX */
71
72extern int tick; /* usec per tick (1000000 / hz) */
73extern int tickadj; /* "standard" clock skew, us./tick */
74extern int hz; /* system clock's frequency */
75extern int psratio; /* ratio: prof / stat */
76extern int stathz; /* statistics clock's frequency */
77extern int profhz; /* profiling clock's frequency */
78extern int ticks;
79extern int lbolt; /* once a second sleep address */
88c4d2f6
MD
80extern int tickdelta; /* make this correction */
81extern long timedelta; /* until this aggregate is exhausted */
82extern int tickpll; /* scaled tick adjustment */
984263bc
MD
83
84#endif /* _KERNEL */
85
86/*
87 * Enumerated types for known system startup interfaces.
88 *
89 * Startup occurs in ascending numeric order; the list entries are
90 * sorted prior to attempting startup to guarantee order. Items
91 * of the same level are arbitrated for order based on the 'order'
92 * element.
93 *
94 * These numbers are arbitrary and are chosen ONLY for ordering; the
95 * enumeration values are explicit rather than implicit to provide
96 * for binary compatibility with inserted elements.
97 *
98 * The SI_SUB_RUN_SCHEDULER value must have the highest lexical value.
99 *
100 * The SI_SUB_CONSOLE and SI_SUB_SWAP values represent values used by
101 * the BSD 4.4Lite but not by FreeBSD; they are maintained in dependent
102 * order to support porting.
103 *
104 * The SI_SUB_PROTO_BEGIN and SI_SUB_PROTO_END bracket a range of
105 * initializations to take place at splimp(). This is a historical
106 * wart that should be removed -- probably running everything at
107 * splimp() until the first init that doesn't want it is the correct
108 * fix. They are currently present to ensure historical behavior.
109 */
110enum sysinit_sub_id {
111 SI_SUB_DUMMY = 0x0000000, /* not executed; for linker*/
112 SI_SUB_DONE = 0x0000001, /* processed*/
113 SI_SUB_CONSOLE = 0x0800000, /* console*/
114 SI_SUB_COPYRIGHT = 0x0800001, /* first use of console*/
115 SI_SUB_TUNABLES = 0x0700000, /* establish tunable values */
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_CPU = 0x1e00000, /* CPU resource(s)*/
120 SI_SUB_KLD = 0x1f00000, /* KLD and module setup */
121 SI_SUB_INTRINSIC = 0x2000000, /* proc 0*/
122 SI_SUB_VM_CONF = 0x2100000, /* config VM, set limits*/
123 SI_SUB_RUN_QUEUE = 0x2200000, /* the run queue*/
124 SI_SUB_CREATE_INIT = 0x2300000, /* create the init process */
125 SI_SUB_MBUF = 0x2380000, /* mbuf subsystem */
f8c3996b 126 SI_SUB_LEAVE_CRIT = 0x23c0000, /* allow interrupt operation */
984263bc
MD
127 SI_SUB_DRIVERS = 0x2400000, /* Let Drivers initialize */
128 SI_SUB_CONFIGURE = 0x3800000, /* Configure devices */
129 SI_SUB_VFS = 0x4000000, /* virtual file system*/
130 SI_SUB_CLOCKS = 0x4800000, /* real time and stat clocks*/
131 SI_SUB_CLIST = 0x5800000, /* clists*/
132 SI_SUB_SYSV_SHM = 0x6400000, /* System V shared memory*/
133 SI_SUB_SYSV_SEM = 0x6800000, /* System V semaphores*/
134 SI_SUB_SYSV_MSG = 0x6C00000, /* System V message queues*/
135 SI_SUB_P1003_1B = 0x6E00000, /* P1003.1B realtime */
136 SI_SUB_PSEUDO = 0x7000000, /* pseudo devices*/
137 SI_SUB_EXEC = 0x7400000, /* execve() handlers */
138 SI_SUB_PROTO_BEGIN = 0x8000000, /* XXX: set splimp (kludge)*/
139 SI_SUB_PROTO_IF = 0x8400000, /* interfaces*/
140 SI_SUB_PROTO_DOMAIN = 0x8800000, /* domains (address families?)*/
141 SI_SUB_PROTO_END = 0x8ffffff, /* XXX: set splx (kludge)*/
142 SI_SUB_KPROF = 0x9000000, /* kernel profiling*/
143 SI_SUB_KICK_SCHEDULER = 0xa000000, /* start the timeout events*/
144 SI_SUB_INT_CONFIG_HOOKS = 0xa800000, /* Interrupts enabled config */
145 SI_SUB_ROOT_CONF = 0xb000000, /* Find root devices */
146 SI_SUB_DUMP_CONF = 0xb200000, /* Find dump devices */
5dbaf12c 147 SI_SUB_RAID = 0xb300000, /* Configure vinum */
984263bc
MD
148 SI_SUB_MOUNT_ROOT = 0xb400000, /* root mount*/
149 SI_SUB_SWAP = 0xc000000, /* swap*/
150 SI_SUB_INTRINSIC_POST = 0xd000000, /* proc 0 cleanup*/
151 SI_SUB_KTHREAD_INIT = 0xe000000, /* init process*/
152 SI_SUB_KTHREAD_PAGE = 0xe400000, /* pageout daemon*/
153 SI_SUB_KTHREAD_VM = 0xe800000, /* vm daemon*/
154 SI_SUB_KTHREAD_BUF = 0xea00000, /* buffer daemon*/
155 SI_SUB_KTHREAD_UPDATE = 0xec00000, /* update daemon*/
156 SI_SUB_KTHREAD_IDLE = 0xee00000, /* idle procs*/
157 SI_SUB_SMP = 0xf000000, /* idle procs*/
158 SI_SUB_RUN_SCHEDULER = 0xfffffff /* scheduler: no return*/
159};
160
161
162/*
163 * Some enumerated orders; "ANY" sorts last.
164 */
165enum sysinit_elem_order {
166 SI_ORDER_FIRST = 0x0000000, /* first*/
167 SI_ORDER_SECOND = 0x0000001, /* second*/
168 SI_ORDER_THIRD = 0x0000002, /* third*/
169 SI_ORDER_MIDDLE = 0x1000000, /* somewhere in the middle */
170 SI_ORDER_ANY = 0xfffffff /* last*/
171};
172
173
174/*
175 * A system initialization call instance
176 *
177 * At the moment there is one instance of sysinit. We probably do not
178 * want two which is why this code is if'd out, but we definitely want
179 * to discern SYSINIT's which take non-constant data pointers and
180 * SYSINIT's which take constant data pointers,
181 *
182 * The C_* macros take functions expecting const void * arguments
183 * while the non-C_* macros take functions expecting just void * arguments.
184 *
185 * With -Wcast-qual on, the compiler issues warnings:
186 * - if we pass non-const data or functions taking non-const data
187 * to a C_* macro.
188 *
189 * - if we pass const data to the normal macros
190 *
191 * However, no warning is issued if we pass a function taking const data
192 * through a normal non-const macro. This is ok because the function is
193 * saying it won't modify the data so we don't care whether the data is
194 * modifiable or not.
195 */
196
b153f746
RG
197typedef void (*sysinit_nfunc_t) (void *);
198typedef void (*sysinit_cfunc_t) (const void *);
984263bc
MD
199
200struct sysinit {
201 unsigned int subsystem; /* subsystem identifier*/
202 unsigned int order; /* init order within subsystem*/
203 sysinit_cfunc_t func; /* function */
204 const void *udata; /* multiplexer/argument */
205};
206
207/*
208 * Default: no special processing
209 *
210 * The C_ version of SYSINIT is for data pointers to const
211 * data ( and functions taking data pointers to const data ).
212 * At the moment it is no different from SYSINIT and thus
213 * still results in warnings.
214 *
215 * The casts are necessary to have the compiler produce the
216 * correct warnings when -Wcast-qual is used.
217 *
218 */
219#define C_SYSINIT(uniquifier, subsystem, order, func, ident) \
220 static struct sysinit uniquifier ## _sys_init = { \
221 subsystem, \
222 order, \
223 func, \
224 ident \
225 }; \
226 DATA_SET(sysinit_set,uniquifier ## _sys_init);
227
228#define SYSINIT(uniquifier, subsystem, order, func, ident) \
229 C_SYSINIT(uniquifier, subsystem, order, \
230 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
231
232/*
233 * Called on module unload: no special processing
234 */
235#define C_SYSUNINIT(uniquifier, subsystem, order, func, ident) \
236 static struct sysinit uniquifier ## _sys_uninit = { \
237 subsystem, \
238 order, \
239 func, \
240 ident \
241 }; \
242 DATA_SET(sysuninit_set,uniquifier ## _sys_uninit)
243
244#define SYSUNINIT(uniquifier, subsystem, order, func, ident) \
245 C_SYSUNINIT(uniquifier, subsystem, order, \
246 (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
247
dc62b251 248void sysinit_add (struct sysinit **set, struct sysinit **set_end);
984263bc
MD
249
250/*
251 * Infrastructure for tunable 'constants'. Value may be specified at compile
252 * time or kernel load time. Rules relating tunables together can be placed
253 * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_LAST.
254 */
255
256extern void tunable_int_init(void *);
257struct tunable_int {
258 const char *path;
259 int *var;
260};
261#define TUNABLE_INT(path, var) \
262 _TUNABLE_INT((path), (var), __LINE__)
263#define _TUNABLE_INT(path, var, line) \
264 __TUNABLE_INT((path), (var), line)
265
266#define __TUNABLE_INT(path, var, line) \
267 static struct tunable_int __tunable_int_ ## line = { \
268 path, \
269 var, \
270 }; \
271 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
272 tunable_int_init, &__tunable_int_ ## line)
273
274#define TUNABLE_INT_FETCH(path, var) getenv_int((path), (var))
275
9a7c6212 276/* Backwards compatibility with the old deprecated TUNABLE_INT_DECL API */
984263bc
MD
277#define TUNABLE_INT_DECL(path, defval, var) \
278static void __Tunable_ ## var (void *ignored) \
279{ \
280 (var) = (defval); \
281 TUNABLE_INT_FETCH((path), &(var)); \
282} \
283SYSINIT(__Tunable_init_ ## var, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, __Tunable_ ## var , NULL);
284
285extern void tunable_quad_init(void *);
286struct tunable_quad {
287 const char *path;
288 quad_t *var;
289};
290#define TUNABLE_QUAD(path, var) \
291 _TUNABLE_QUAD((path), (var), __LINE__)
292#define _TUNABLE_QUAD(path, var, line) \
293 __TUNABLE_QUAD((path), (var), line)
294
295#define __TUNABLE_QUAD(path, var, line) \
296 static struct tunable_quad __tunable_quad_ ## line = { \
297 path, \
298 var, \
299 }; \
300 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
301 tunable_quad_init, &__tunable_quad_ ## line)
302
303#define TUNABLE_QUAD_FETCH(path, var) getenv_quad((path), (var))
304
305extern void tunable_str_init(void *);
306struct tunable_str {
307 const char *path;
308 char *var;
309 int size;
310};
311#define TUNABLE_STR(path, var, size) \
312 _TUNABLE_STR((path), (var), (size), __LINE__)
313#define _TUNABLE_STR(path, var, size, line) \
314 __TUNABLE_STR((path), (var), (size), line)
315
316#define __TUNABLE_STR(path, var, size, line) \
317 static struct tunable_str __tunable_str_ ## line = { \
318 path, \
319 var, \
320 size, \
321 }; \
322 SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
323 tunable_str_init, &__tunable_str_ ## line)
324
325#define TUNABLE_STR_FETCH(path, var, size) \
326 getenv_string((path), (var), (size))
327
328/*
329 * Compatibility. To be deprecated after LKM is removed.
330 */
331#include <sys/module.h>
332#define PSEUDO_SET(sym, name) \
333 static int name ## _modevent(module_t mod, int type, void *data) \
334 { \
335 void (*initfunc)(void *) = (void (*)(void *))data; \
336 switch (type) { \
337 case MOD_LOAD: \
338 /* printf(#name " module load\n"); */ \
339 initfunc(NULL); \
340 break; \
341 case MOD_UNLOAD: \
342 printf(#name " module unload - not possible for this module type\n"); \
343 return EINVAL; \
344 } \
345 return 0; \
346 } \
347 static moduledata_t name ## _mod = { \
348 #name, \
349 name ## _modevent, \
350 (void *)sym \
351 }; \
352 DECLARE_MODULE(name, name ## _mod, SI_SUB_PSEUDO, SI_ORDER_ANY)
353
354extern struct linker_set execsw_set;
355
356
357
358
359struct intr_config_hook {
360 TAILQ_ENTRY(intr_config_hook) ich_links;
b153f746 361 void (*ich_func) (void *arg);
984263bc
MD
362 void *ich_arg;
363};
364
b153f746
RG
365int config_intrhook_establish (struct intr_config_hook *hook);
366void config_intrhook_disestablish (struct intr_config_hook *hook);
984263bc
MD
367
368#endif /* !_SYS_KERNEL_H_*/