xref: /dragonfly/sys/sys/kernel.h (revision d5f516c3)
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.11 2004/03/30 17:18:58 joerg 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_END	= 0x8ffffff,	/* XXX: set splx (kludge)*/
144 	SI_SUB_KPROF		= 0x9000000,	/* kernel profiling*/
145 	SI_SUB_KICK_SCHEDULER	= 0xa000000,	/* start the timeout events*/
146 	SI_SUB_INT_CONFIG_HOOKS	= 0xa800000,	/* Interrupts enabled config */
147 	SI_SUB_ROOT_CONF	= 0xb000000,	/* Find root devices */
148 	SI_SUB_DUMP_CONF	= 0xb200000,	/* Find dump devices */
149 	SI_SUB_RAID		= 0xb300000,	/* Configure vinum */
150 	SI_SUB_MOUNT_ROOT	= 0xb400000,	/* root mount*/
151 	SI_SUB_SWAP		= 0xc000000,	/* swap*/
152 	SI_SUB_INTRINSIC_POST	= 0xd000000,	/* proc 0 cleanup*/
153 	SI_SUB_KTHREAD_INIT	= 0xe000000,	/* init process*/
154 	SI_SUB_KTHREAD_PAGE	= 0xe400000,	/* pageout daemon*/
155 	SI_SUB_KTHREAD_VM	= 0xe800000,	/* vm daemon*/
156 	SI_SUB_KTHREAD_BUF	= 0xea00000,	/* buffer daemon*/
157 	SI_SUB_KTHREAD_UPDATE	= 0xec00000,	/* update daemon*/
158 	SI_SUB_KTHREAD_IDLE	= 0xee00000,	/* idle procs*/
159 	SI_SUB_SMP		= 0xf000000,	/* idle procs*/
160 	SI_SUB_RUN_SCHEDULER	= 0xfffffff	/* scheduler: no return*/
161 };
162 
163 
164 /*
165  * Some enumerated orders; "ANY" sorts last.
166  */
167 enum sysinit_elem_order {
168 	SI_ORDER_FIRST		= 0x0000000,	/* first*/
169 	SI_ORDER_SECOND		= 0x0000001,	/* second*/
170 	SI_ORDER_THIRD		= 0x0000002,	/* third*/
171 	SI_ORDER_MIDDLE		= 0x1000000,	/* somewhere in the middle */
172 	SI_ORDER_ANY		= 0xfffffff	/* last*/
173 };
174 
175 
176 /*
177  * A system initialization call instance
178  *
179  * At the moment there is one instance of sysinit.  We probably do not
180  * want two which is why this code is if'd out, but we definitely want
181  * to discern SYSINIT's which take non-constant data pointers and
182  * SYSINIT's which take constant data pointers,
183  *
184  * The C_* macros take functions expecting const void * arguments
185  * while the non-C_* macros take functions expecting just void * arguments.
186  *
187  * With -Wcast-qual on, the compiler issues warnings:
188  *	- if we pass non-const data or functions taking non-const data
189  *	  to a C_* macro.
190  *
191  *	- if we pass const data to the normal macros
192  *
193  * However, no warning is issued if we pass a function taking const data
194  * through a normal non-const macro.  This is ok because the function is
195  * saying it won't modify the data so we don't care whether the data is
196  * modifiable or not.
197  */
198 
199 typedef void (*sysinit_nfunc_t) (void *);
200 typedef void (*sysinit_cfunc_t) (const void *);
201 
202 struct sysinit {
203 	unsigned int	subsystem;		/* subsystem identifier*/
204 	unsigned int	order;			/* init order within subsystem*/
205 	sysinit_cfunc_t func;			/* function		*/
206 	const void	*udata;			/* multiplexer/argument */
207 };
208 
209 /*
210  * Default: no special processing
211  *
212  * The C_ version of SYSINIT is for data pointers to const
213  * data ( and functions taking data pointers to const data ).
214  * At the moment it is no different from SYSINIT and thus
215  * still results in warnings.
216  *
217  * The casts are necessary to have the compiler produce the
218  * correct warnings when -Wcast-qual is used.
219  *
220  */
221 #define	C_SYSINIT(uniquifier, subsystem, order, func, ident)	\
222 	static struct sysinit uniquifier ## _sys_init = {	\
223 		subsystem,					\
224 		order,						\
225 		func,						\
226 		ident						\
227 	};							\
228 	DATA_SET(sysinit_set,uniquifier ## _sys_init);
229 
230 #define	SYSINIT(uniquifier, subsystem, order, func, ident)	\
231 	C_SYSINIT(uniquifier, subsystem, order,			\
232 	(sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
233 
234 /*
235  * Called on module unload: no special processing
236  */
237 #define	C_SYSUNINIT(uniquifier, subsystem, order, func, ident)	\
238 	static struct sysinit uniquifier ## _sys_uninit = {	\
239 		subsystem,					\
240 		order,						\
241 		func,						\
242 		ident						\
243 	};							\
244 	DATA_SET(sysuninit_set,uniquifier ## _sys_uninit)
245 
246 #define	SYSUNINIT(uniquifier, subsystem, order, func, ident)	\
247 	C_SYSUNINIT(uniquifier, subsystem, order,		\
248 	(sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
249 
250 void	sysinit_add (struct sysinit **, struct sysinit **);
251 
252 /*
253  * Infrastructure for tunable 'constants'.  Value may be specified at compile
254  * time or kernel load time.  Rules relating tunables together can be placed
255  * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_LAST.
256  */
257 
258 extern void tunable_int_init(void *);
259 struct tunable_int {
260 	const char *path;
261 	int *var;
262 };
263 #define	TUNABLE_INT(path, var)					\
264 	_TUNABLE_INT((path), (var), __LINE__)
265 #define _TUNABLE_INT(path, var, line)				\
266 	__TUNABLE_INT((path), (var), line)
267 
268 #define	__TUNABLE_INT(path, var, line)				\
269 	static struct tunable_int __tunable_int_ ## line = {	\
270 		path,						\
271 		var,						\
272 	};							\
273 	SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
274 	     tunable_int_init, &__tunable_int_ ## line)
275 
276 #define	TUNABLE_INT_FETCH(path, var)	getenv_int((path), (var))
277 
278 /* Backwards compatibility with the old deprecated TUNABLE_INT_DECL API */
279 #define TUNABLE_INT_DECL(path, defval, var)	\
280 static void __Tunable_ ## var (void *ignored)	\
281 {						\
282 	(var) = (defval);			\
283 	TUNABLE_INT_FETCH((path), &(var));	\
284 }						\
285 SYSINIT(__Tunable_init_ ## var, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, __Tunable_ ## var , NULL);
286 
287 extern void tunable_quad_init(void *);
288 struct tunable_quad {
289 	const char *path;
290 	quad_t *var;
291 };
292 #define	TUNABLE_QUAD(path, var)					\
293 	_TUNABLE_QUAD((path), (var), __LINE__)
294 #define	_TUNABLE_QUAD(path, var, line)				\
295 	__TUNABLE_QUAD((path), (var), line)
296 
297 #define	__TUNABLE_QUAD(path, var, line)			\
298 	static struct tunable_quad __tunable_quad_ ## line = {	\
299 		path,						\
300 		var,						\
301 	};							\
302 	SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
303 	    tunable_quad_init, &__tunable_quad_ ## line)
304 
305 #define	TUNABLE_QUAD_FETCH(path, var)	getenv_quad((path), (var))
306 
307 extern void tunable_str_init(void *);
308 struct tunable_str {
309 	const char *path;
310 	char *var;
311 	int size;
312 };
313 #define	TUNABLE_STR(path, var, size)				\
314 	_TUNABLE_STR((path), (var), (size), __LINE__)
315 #define	_TUNABLE_STR(path, var, size, line)			\
316 	__TUNABLE_STR((path), (var), (size), line)
317 
318 #define	__TUNABLE_STR(path, var, size, line)			\
319 	static struct tunable_str __tunable_str_ ## line = {	\
320 		path,						\
321 		var,						\
322 		size,						\
323 	};							\
324 	SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
325 	     tunable_str_init, &__tunable_str_ ## line)
326 
327 #define	TUNABLE_STR_FETCH(path, var, size)			\
328 	getenv_string((path), (var), (size))
329 
330 /*
331  * Compatibility.  To be deprecated after LKM is removed.
332  */
333 #include <sys/module.h>
334 #define	PSEUDO_SET(sym, name) \
335 	static int name ## _modevent(module_t mod, int type, void *data) \
336 	{ \
337 		void (*initfunc)(void *) = (void (*)(void *))data; \
338 		switch (type) { \
339 		case MOD_LOAD: \
340 			/* printf(#name " module load\n"); */ \
341 			initfunc(NULL); \
342 			break; \
343 		case MOD_UNLOAD: \
344 			printf(#name " module unload - not possible for this module type\n"); \
345 			return EINVAL; \
346 		} \
347 		return 0; \
348 	} \
349 	static moduledata_t name ## _mod = { \
350 		#name, \
351 		name ## _modevent, \
352 		(void *)sym \
353 	}; \
354 	DECLARE_MODULE(name, name ## _mod, SI_SUB_PSEUDO, SI_ORDER_ANY)
355 
356 extern struct linker_set execsw_set;
357 
358 
359 
360 
361 struct intr_config_hook {
362 	TAILQ_ENTRY(intr_config_hook) ich_links;
363 	void	(*ich_func) (void *);
364 	void	*ich_arg;
365 };
366 
367 int	config_intrhook_establish (struct intr_config_hook *);
368 void	config_intrhook_disestablish (struct intr_config_hook *);
369 
370 #endif /* !_SYS_KERNEL_H_*/
371