xref: /dragonfly/sys/sys/kernel.h (revision 222a27c4)
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 $
43  * $DragonFly: src/sys/sys/kernel.h,v 1.13 2005/02/04 02:55:38 dillon Exp $
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 */
59 extern unsigned long hostid;
60 extern char hostname[MAXHOSTNAMELEN];
61 extern int hostnamelen;
62 extern char domainname[MAXHOSTNAMELEN];
63 extern int domainnamelen;
64 extern char kernelname[MAXPATHLEN];
65 
66 /* 1.2 */
67 extern struct timespec boottime;
68 extern struct timespec basetime;
69 
70 extern struct timezone tz;			/* XXX */
71 
72 extern int tick;			/* usec per tick (1000000 / hz) */
73 extern int tickadj;			/* "standard" clock skew, us./tick */
74 extern int hz;				/* system clock's frequency */
75 extern int psratio;			/* ratio: prof / stat */
76 extern int stathz;			/* statistics clock's frequency */
77 extern int profhz;			/* profiling clock's frequency */
78 extern int ticks;
79 extern int lbolt;			/* once a second sleep address */
80 extern int tickdelta;			/* make this correction */
81 extern long timedelta;			/* until this aggregate is exhausted */
82 extern int tickpll;			/* scaled tick adjustment */
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  */
110 enum 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_LOCK		= 0x0900000,	/* lockmgr locks and tokens */
117 	SI_SUB_VM		= 0x1000000,	/* virtual memory system init*/
118 	SI_SUB_KMEM		= 0x1800000,	/* kernel memory*/
119 	SI_SUB_KVM_RSRC		= 0x1A00000,	/* kvm operational limits*/
120 	SI_SUB_CPU		= 0x1e00000,	/* CPU resource(s)*/
121 	SI_SUB_KLD		= 0x1f00000,	/* KLD and module setup */
122 	SI_SUB_INTRINSIC	= 0x2000000,	/* proc 0*/
123 	SI_SUB_VM_CONF		= 0x2100000,	/* config VM, set limits*/
124 	SI_SUB_RUN_QUEUE	= 0x2200000,	/* the run queue*/
125 	SI_SUB_CREATE_INIT	= 0x2300000,	/* create the init process */
126 	SI_SUB_MBUF		= 0x2380000,	/* mbuf subsystem */
127 	SI_SUB_LEAVE_CRIT	= 0x23c0000,	/* allow interrupt operation */
128 	SI_SUB_DRIVERS		= 0x2400000,	/* Let Drivers initialize */
129 	SI_SUB_CONFIGURE	= 0x3800000,	/* Configure devices */
130 	SI_SUB_VFS		= 0x4000000,	/* virtual file system*/
131 	SI_SUB_CLOCKS		= 0x4800000,	/* real time and stat clocks*/
132 	SI_SUB_FINISH_SMP	= 0x5000000,	/* finish setting up cpus */
133 	SI_SUB_CLIST		= 0x5800000,	/* clists*/
134 	SI_SUB_SYSV_SHM		= 0x6400000,	/* System V shared memory*/
135 	SI_SUB_SYSV_SEM		= 0x6800000,	/* System V semaphores*/
136 	SI_SUB_SYSV_MSG		= 0x6C00000,	/* System V message queues*/
137 	SI_SUB_P1003_1B		= 0x6E00000,	/* P1003.1B realtime */
138 	SI_SUB_PSEUDO		= 0x7000000,	/* pseudo devices*/
139 	SI_SUB_EXEC		= 0x7400000,	/* execve() handlers */
140 	SI_SUB_PROTO_BEGIN	= 0x8000000,	/* XXX: set splimp (kludge)*/
141 	SI_SUB_PROTO_IF		= 0x8400000,	/* interfaces*/
142 	SI_SUB_PROTO_DOMAIN	= 0x8800000,	/* domains (address families?)*/
143 	SI_SUB_PROTO_IFATTACHDOMAIN	= 0x8800001,	/* domain dependent data init */
144 	SI_SUB_PROTO_END	= 0x8ffffff,	/* XXX: set splx (kludge)*/
145 	SI_SUB_KPROF		= 0x9000000,	/* kernel profiling*/
146 	SI_SUB_KICK_SCHEDULER	= 0xa000000,	/* start the timeout events*/
147 	SI_SUB_INT_CONFIG_HOOKS	= 0xa800000,	/* Interrupts enabled config */
148 	SI_SUB_ROOT_CONF	= 0xb000000,	/* Find root devices */
149 	SI_SUB_DUMP_CONF	= 0xb200000,	/* Find dump devices */
150 	SI_SUB_RAID		= 0xb300000,	/* Configure vinum */
151 	SI_SUB_MOUNT_ROOT	= 0xb400000,	/* root mount*/
152 	SI_SUB_SWAP		= 0xc000000,	/* swap*/
153 	SI_SUB_INTRINSIC_POST	= 0xd000000,	/* proc 0 cleanup*/
154 	SI_SUB_KTHREAD_INIT	= 0xe000000,	/* init process*/
155 	SI_SUB_KTHREAD_PAGE	= 0xe400000,	/* pageout daemon*/
156 	SI_SUB_KTHREAD_VM	= 0xe800000,	/* vm daemon*/
157 	SI_SUB_KTHREAD_BUF	= 0xea00000,	/* buffer daemon*/
158 	SI_SUB_KTHREAD_UPDATE	= 0xec00000,	/* update daemon*/
159 	SI_SUB_KTHREAD_IDLE	= 0xee00000,	/* idle procs*/
160 	SI_SUB_SMP		= 0xf000000,	/* idle procs*/
161 	SI_SUB_RUN_SCHEDULER	= 0xfffffff	/* scheduler: no return*/
162 };
163 
164 
165 /*
166  * Some enumerated orders; "ANY" sorts last.
167  */
168 enum sysinit_elem_order {
169 	SI_ORDER_FIRST		= 0x0000000,	/* first*/
170 	SI_ORDER_SECOND		= 0x0000001,	/* second*/
171 	SI_ORDER_THIRD		= 0x0000002,	/* third*/
172 	SI_ORDER_MIDDLE		= 0x1000000,	/* somewhere in the middle */
173 	SI_ORDER_ANY		= 0xfffffff	/* last*/
174 };
175 
176 
177 /*
178  * A system initialization call instance
179  *
180  * At the moment there is one instance of sysinit.  We probably do not
181  * want two which is why this code is if'd out, but we definitely want
182  * to discern SYSINIT's which take non-constant data pointers and
183  * SYSINIT's which take constant data pointers,
184  *
185  * The C_* macros take functions expecting const void * arguments
186  * while the non-C_* macros take functions expecting just void * arguments.
187  *
188  * With -Wcast-qual on, the compiler issues warnings:
189  *	- if we pass non-const data or functions taking non-const data
190  *	  to a C_* macro.
191  *
192  *	- if we pass const data to the normal macros
193  *
194  * However, no warning is issued if we pass a function taking const data
195  * through a normal non-const macro.  This is ok because the function is
196  * saying it won't modify the data so we don't care whether the data is
197  * modifiable or not.
198  */
199 
200 typedef void (*sysinit_nfunc_t) (void *);
201 typedef void (*sysinit_cfunc_t) (const void *);
202 
203 struct sysinit {
204 	unsigned int	subsystem;		/* subsystem identifier*/
205 	unsigned int	order;			/* init order within subsystem*/
206 	sysinit_cfunc_t func;			/* function		*/
207 	const void	*udata;			/* multiplexer/argument */
208 };
209 
210 /*
211  * Default: no special processing
212  *
213  * The C_ version of SYSINIT is for data pointers to const
214  * data ( and functions taking data pointers to const data ).
215  * At the moment it is no different from SYSINIT and thus
216  * still results in warnings.
217  *
218  * The casts are necessary to have the compiler produce the
219  * correct warnings when -Wcast-qual is used.
220  *
221  */
222 #define	C_SYSINIT(uniquifier, subsystem, order, func, ident)	\
223 	static struct sysinit uniquifier ## _sys_init = {	\
224 		subsystem,					\
225 		order,						\
226 		func,						\
227 		ident						\
228 	};							\
229 	DATA_SET(sysinit_set,uniquifier ## _sys_init);
230 
231 #define	SYSINIT(uniquifier, subsystem, order, func, ident)	\
232 	C_SYSINIT(uniquifier, subsystem, order,			\
233 	(sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
234 
235 /*
236  * Called on module unload: no special processing
237  */
238 #define	C_SYSUNINIT(uniquifier, subsystem, order, func, ident)	\
239 	static struct sysinit uniquifier ## _sys_uninit = {	\
240 		subsystem,					\
241 		order,						\
242 		func,						\
243 		ident						\
244 	};							\
245 	DATA_SET(sysuninit_set,uniquifier ## _sys_uninit)
246 
247 #define	SYSUNINIT(uniquifier, subsystem, order, func, ident)	\
248 	C_SYSUNINIT(uniquifier, subsystem, order,		\
249 	(sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
250 
251 void	sysinit_add (struct sysinit **, struct sysinit **);
252 
253 /*
254  * Infrastructure for tunable 'constants'.  Value may be specified at compile
255  * time or kernel load time.  Rules relating tunables together can be placed
256  * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_LAST.
257  */
258 
259 extern void tunable_int_init(void *);
260 struct tunable_int {
261 	const char *path;
262 	int *var;
263 };
264 #define	TUNABLE_INT(path, var)					\
265 	_TUNABLE_INT((path), (var), __LINE__)
266 #define _TUNABLE_INT(path, var, line)				\
267 	__TUNABLE_INT((path), (var), line)
268 
269 #define	__TUNABLE_INT(path, var, line)				\
270 	static struct tunable_int __tunable_int_ ## line = {	\
271 		path,						\
272 		var,						\
273 	};							\
274 	SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
275 	     tunable_int_init, &__tunable_int_ ## line)
276 
277 #define	TUNABLE_INT_FETCH(path, var)	getenv_int((path), (var))
278 
279 /* Backwards compatibility with the old deprecated TUNABLE_INT_DECL API */
280 #define TUNABLE_INT_DECL(path, defval, var)	\
281 static void __Tunable_ ## var (void *ignored)	\
282 {						\
283 	(var) = (defval);			\
284 	TUNABLE_INT_FETCH((path), &(var));	\
285 }						\
286 SYSINIT(__Tunable_init_ ## var, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, __Tunable_ ## var , NULL);
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 /*
332  * Compatibility.  To be deprecated after LKM is removed.
333  */
334 #include <sys/module.h>
335 #define	PSEUDO_SET(sym, name) \
336 	static int name ## _modevent(module_t mod, int type, void *data) \
337 	{ \
338 		void (*initfunc)(void *) = (void (*)(void *))data; \
339 		switch (type) { \
340 		case MOD_LOAD: \
341 			/* printf(#name " module load\n"); */ \
342 			initfunc(NULL); \
343 			break; \
344 		case MOD_UNLOAD: \
345 			printf(#name " module unload - not possible for this module type\n"); \
346 			return EINVAL; \
347 		} \
348 		return 0; \
349 	} \
350 	static moduledata_t name ## _mod = { \
351 		#name, \
352 		name ## _modevent, \
353 		(void *)sym \
354 	}; \
355 	DECLARE_MODULE(name, name ## _mod, SI_SUB_PSEUDO, SI_ORDER_ANY)
356 
357 extern struct linker_set execsw_set;
358 
359 
360 
361 
362 struct intr_config_hook {
363 	TAILQ_ENTRY(intr_config_hook) ich_links;
364 	void	(*ich_func) (void *);
365 	void	*ich_arg;
366 	const char *ich_desc;
367 };
368 
369 int	config_intrhook_establish (struct intr_config_hook *);
370 void	config_intrhook_disestablish (struct intr_config_hook *);
371 
372 #endif /* !_SYS_KERNEL_H_*/
373