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