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