source: rtems-libbsd/freebsd/sys/sys/kernel.h @ 164c5f5

4.1155-freebsd-126-freebsd-12freebsd-9.3
Last change on this file since 164c5f5 was 164c5f5, checked in by Sebastian Huber <sebastian.huber@…>, on 01/15/14 at 11:46:22

UNIX(4): Import from FreeBSD

  • Property mode set to 100644
File size: 15.4 KB
Line 
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$
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#ifndef __rtems__
58/* 1.1 */
59extern char kernelname[MAXPATHLEN];
60#endif /* __rtems__ */
61
62extern int tick;                        /* usec per tick (1000000 / hz) */
63extern int hz;                          /* system clock's frequency */
64extern int psratio;                     /* ratio: prof / stat */
65extern int stathz;                      /* statistics clock's frequency */
66extern int profhz;                      /* profiling clock's frequency */
67extern int profprocs;                   /* number of process's profiling */
68#ifndef __rtems__
69extern volatile int ticks;
70#else /* __rtems__ */
71#include <rtems/score/watchdogimpl.h>
72#define ticks _Watchdog_Ticks_since_boot
73#endif /* __rtems__ */
74
75#endif /* _KERNEL */
76
77/*
78 * Enumerated types for known system startup interfaces.
79 *
80 * Startup occurs in ascending numeric order; the list entries are
81 * sorted prior to attempting startup to guarantee order.  Items
82 * of the same level are arbitrated for order based on the 'order'
83 * element.
84 *
85 * These numbers are arbitrary and are chosen ONLY for ordering; the
86 * enumeration values are explicit rather than implicit to provide
87 * for binary compatibility with inserted elements.
88 *
89 * The SI_SUB_RUN_SCHEDULER value must have the highest lexical value.
90 *
91 * The SI_SUB_SWAP values represent a value used by
92 * the BSD 4.4Lite but not by FreeBSD; it is maintained in dependent
93 * order to support porting.
94 */
95enum sysinit_sub_id {
96        SI_SUB_DUMMY            = 0x0000000,    /* not executed; for linker*/
97        SI_SUB_DONE             = 0x0000001,    /* processed*/
98        SI_SUB_TUNABLES         = 0x0700000,    /* establish tunable values */
99        SI_SUB_COPYRIGHT        = 0x0800001,    /* first use of console*/
100        SI_SUB_SETTINGS         = 0x0880000,    /* check and recheck settings */
101        SI_SUB_MTX_POOL_STATIC  = 0x0900000,    /* static mutex pool */
102        SI_SUB_LOCKMGR          = 0x0980000,    /* lockmgr locks */
103        SI_SUB_VM               = 0x1000000,    /* virtual memory system init*/
104        SI_SUB_KMEM             = 0x1800000,    /* kernel memory*/
105        SI_SUB_KVM_RSRC         = 0x1A00000,    /* kvm operational limits*/
106        SI_SUB_WITNESS          = 0x1A80000,    /* witness initialization */
107        SI_SUB_MTX_POOL_DYNAMIC = 0x1AC0000,    /* dynamic mutex pool */
108        SI_SUB_LOCK             = 0x1B00000,    /* various locks */
109        SI_SUB_EVENTHANDLER     = 0x1C00000,    /* eventhandler init */
110        SI_SUB_VNET_PRELINK     = 0x1E00000,    /* vnet init before modules */
111        SI_SUB_KLD              = 0x2000000,    /* KLD and module setup */
112        SI_SUB_CPU              = 0x2100000,    /* CPU resource(s)*/
113        SI_SUB_RACCT            = 0x2110000,    /* resource accounting */
114        SI_SUB_RANDOM           = 0x2120000,    /* random number generator */
115        SI_SUB_KDTRACE          = 0x2140000,    /* Kernel dtrace hooks */
116        SI_SUB_MAC              = 0x2180000,    /* TrustedBSD MAC subsystem */
117        SI_SUB_MAC_POLICY       = 0x21C0000,    /* TrustedBSD MAC policies */
118        SI_SUB_MAC_LATE         = 0x21D0000,    /* TrustedBSD MAC subsystem */
119        SI_SUB_VNET             = 0x21E0000,    /* vnet 0 */
120        SI_SUB_INTRINSIC        = 0x2200000,    /* proc 0*/
121        SI_SUB_VM_CONF          = 0x2300000,    /* config VM, set limits*/
122        SI_SUB_DDB_SERVICES     = 0x2380000,    /* capture, scripting, etc. */
123        SI_SUB_RUN_QUEUE        = 0x2400000,    /* set up run queue*/
124        SI_SUB_KTRACE           = 0x2480000,    /* ktrace */
125        SI_SUB_OPENSOLARIS      = 0x2490000,    /* OpenSolaris compatibility */
126        SI_SUB_CYCLIC           = 0x24A0000,    /* Cyclic timers */
127        SI_SUB_AUDIT            = 0x24C0000,    /* audit */
128        SI_SUB_CREATE_INIT      = 0x2500000,    /* create init process*/
129        SI_SUB_SCHED_IDLE       = 0x2600000,    /* required idle procs */
130        SI_SUB_MBUF             = 0x2700000,    /* mbuf subsystem */
131        SI_SUB_INTR             = 0x2800000,    /* interrupt threads */
132        SI_SUB_SOFTINTR         = 0x2800001,    /* start soft interrupt thread */
133        SI_SUB_ACL              = 0x2900000,    /* start for filesystem ACLs */
134        SI_SUB_DEVFS            = 0x2F00000,    /* devfs ready for devices */
135        SI_SUB_INIT_IF          = 0x3000000,    /* prep for net interfaces */
136        SI_SUB_NETGRAPH         = 0x3010000,    /* Let Netgraph initialize */
137        SI_SUB_DTRACE           = 0x3020000,    /* DTrace subsystem */
138        SI_SUB_DTRACE_PROVIDER  = 0x3048000,    /* DTrace providers */
139        SI_SUB_DTRACE_ANON      = 0x308C000,    /* DTrace anon enabling */
140        SI_SUB_DRIVERS          = 0x3100000,    /* Let Drivers initialize */
141        SI_SUB_CONFIGURE        = 0x3800000,    /* Configure devices */
142        SI_SUB_VFS              = 0x4000000,    /* virtual filesystem*/
143        SI_SUB_CLOCKS           = 0x4800000,    /* real time and stat clocks*/
144        SI_SUB_CLIST            = 0x5800000,    /* clists*/
145        SI_SUB_SYSV_SHM         = 0x6400000,    /* System V shared memory*/
146        SI_SUB_SYSV_SEM         = 0x6800000,    /* System V semaphores*/
147        SI_SUB_SYSV_MSG         = 0x6C00000,    /* System V message queues*/
148        SI_SUB_P1003_1B         = 0x6E00000,    /* P1003.1B realtime */
149        SI_SUB_PSEUDO           = 0x7000000,    /* pseudo devices*/
150        SI_SUB_EXEC             = 0x7400000,    /* execve() handlers */
151        SI_SUB_PROTO_BEGIN      = 0x8000000,    /* VNET initialization */
152        SI_SUB_PROTO_IF         = 0x8400000,    /* interfaces*/
153        SI_SUB_PROTO_DOMAININIT = 0x8600000,    /* domain registration system */
154        SI_SUB_PROTO_DOMAIN     = 0x8800000,    /* domains (address families?)*/
155        SI_SUB_PROTO_IFATTACHDOMAIN     = 0x8800001,    /* domain dependent data init*/
156        SI_SUB_PROTO_END        = 0x8ffffff,    /* VNET helper functions */
157        SI_SUB_KPROF            = 0x9000000,    /* kernel profiling*/
158        SI_SUB_KICK_SCHEDULER   = 0xa000000,    /* start the timeout events*/
159        SI_SUB_INT_CONFIG_HOOKS = 0xa800000,    /* Interrupts enabled config */
160        SI_SUB_ROOT_CONF        = 0xb000000,    /* Find root devices */
161        SI_SUB_DUMP_CONF        = 0xb200000,    /* Find dump devices */
162        SI_SUB_RAID             = 0xb380000,    /* Configure GEOM classes */
163        SI_SUB_SWAP             = 0xc000000,    /* swap */
164        SI_SUB_INTRINSIC_POST   = 0xd000000,    /* proc 0 cleanup*/
165        SI_SUB_SYSCALLS         = 0xd800000,    /* register system calls */
166        SI_SUB_VNET_DONE        = 0xdc00000,    /* vnet registration complete */
167        SI_SUB_KTHREAD_INIT     = 0xe000000,    /* init process*/
168        SI_SUB_KTHREAD_PAGE     = 0xe400000,    /* pageout daemon*/
169        SI_SUB_KTHREAD_VM       = 0xe800000,    /* vm daemon*/
170        SI_SUB_KTHREAD_BUF      = 0xea00000,    /* buffer daemon*/
171        SI_SUB_KTHREAD_UPDATE   = 0xec00000,    /* update daemon*/
172        SI_SUB_KTHREAD_IDLE     = 0xee00000,    /* idle procs*/
173        SI_SUB_SMP              = 0xf000000,    /* start the APs*/
174        SI_SUB_RACCTD           = 0xf100000,    /* start raccd*/
175        SI_SUB_RUN_SCHEDULER    = 0xfffffff     /* scheduler*/
176};
177
178
179/*
180 * Some enumerated orders; "ANY" sorts last.
181 */
182enum sysinit_elem_order {
183        SI_ORDER_FIRST          = 0x0000000,    /* first*/
184        SI_ORDER_SECOND         = 0x0000001,    /* second*/
185        SI_ORDER_THIRD          = 0x0000002,    /* third*/
186        SI_ORDER_FOURTH         = 0x0000003,    /* fourth*/
187        SI_ORDER_MIDDLE         = 0x1000000,    /* somewhere in the middle */
188        SI_ORDER_ANY            = 0xfffffff     /* last*/
189};
190
191
192/*
193 * A system initialization call instance
194 *
195 * At the moment there is one instance of sysinit.  We probably do not
196 * want two which is why this code is if'd out, but we definitely want
197 * to discern SYSINIT's which take non-constant data pointers and
198 * SYSINIT's which take constant data pointers,
199 *
200 * The C_* macros take functions expecting const void * arguments
201 * while the non-C_* macros take functions expecting just void * arguments.
202 *
203 * With -Wcast-qual on, the compiler issues warnings:
204 *      - if we pass non-const data or functions taking non-const data
205 *        to a C_* macro.
206 *
207 *      - if we pass const data to the normal macros
208 *
209 * However, no warning is issued if we pass a function taking const data
210 * through a normal non-const macro.  This is ok because the function is
211 * saying it won't modify the data so we don't care whether the data is
212 * modifiable or not.
213 */
214
215typedef void (*sysinit_nfunc_t)(void *);
216typedef void (*sysinit_cfunc_t)(const void *);
217
218struct sysinit {
219        enum sysinit_sub_id     subsystem;      /* subsystem identifier*/
220        enum sysinit_elem_order order;          /* init order within subsystem*/
221        sysinit_cfunc_t func;                   /* function             */
222        const void      *udata;                 /* multiplexer/argument */
223};
224
225/*
226 * Default: no special processing
227 *
228 * The C_ version of SYSINIT is for data pointers to const
229 * data ( and functions taking data pointers to const data ).
230 * At the moment it is no different from SYSINIT and thus
231 * still results in warnings.
232 *
233 * The casts are necessary to have the compiler produce the
234 * correct warnings when -Wcast-qual is used.
235 *
236 */
237#ifndef __rtems__
238#define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
239        static struct sysinit uniquifier ## _sys_init = {       \
240                subsystem,                                      \
241                order,                                          \
242                func,                                           \
243                (ident)                                         \
244        };                                                      \
245        DATA_SET(sysinit_set,uniquifier ## _sys_init)
246#else /* __rtems__ */
247#define SYSINIT_ENTRY_NAME(uniquifier)                          \
248        _bsd_ ## uniquifier ## _sys_init
249#define SYSINIT_REFERENCE_NAME(uniquifier)                      \
250        _bsd_ ## uniquifier ## _sys_init_ref
251#define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
252        struct sysinit SYSINIT_ENTRY_NAME(uniquifier) = {       \
253                subsystem,                                      \
254                order,                                          \
255                func,                                           \
256                (ident)                                         \
257        };                                                      \
258        RWDATA_SET(sysinit_set,SYSINIT_ENTRY_NAME(uniquifier))
259#define SYSINIT_REFERENCE(uniquifier)                           \
260        extern struct sysinit SYSINIT_ENTRY_NAME(uniquifier);   \
261        static struct sysinit const * const                     \
262        SYSINIT_REFERENCE_NAME(uniquifier) __used               \
263        = &SYSINIT_ENTRY_NAME(uniquifier)
264#define SYSINIT_MODULE_REFERENCE(mod)                           \
265        SYSINIT_REFERENCE(mod ## module)
266#define SYSINIT_DRIVER_REFERENCE(driver, bus)                   \
267        SYSINIT_MODULE_REFERENCE(driver ## _ ## bus)
268#define SYSINIT_DOMAIN_REFERENCE(dom)                           \
269        SYSINIT_REFERENCE(domain_add_ ## dom)
270#endif /* __rtems__ */
271
272#define SYSINIT(uniquifier, subsystem, order, func, ident)      \
273        C_SYSINIT(uniquifier, subsystem, order,                 \
274        (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))
275
276/*
277 * Called on module unload: no special processing
278 */
279#ifndef __rtems__
280#define C_SYSUNINIT(uniquifier, subsystem, order, func, ident)  \
281        static struct sysinit uniquifier ## _sys_uninit = {     \
282                subsystem,                                      \
283                order,                                          \
284                func,                                           \
285                (ident)                                         \
286        };                                                      \
287        DATA_SET(sysuninit_set,uniquifier ## _sys_uninit)
288#else /* __rtems__ */
289#define C_SYSUNINIT(uniquifier, subsystem, order, func, ident)
290#endif /* __rtems__ */
291
292#define SYSUNINIT(uniquifier, subsystem, order, func, ident)    \
293        C_SYSUNINIT(uniquifier, subsystem, order,               \
294        (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))
295
296void    sysinit_add(struct sysinit **set, struct sysinit **set_end);
297
298#ifndef __rtems__
299/*
300 * Infrastructure for tunable 'constants'.  Value may be specified at compile
301 * time or kernel load time.  Rules relating tunables together can be placed
302 * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_LAST.
303 *
304 * WARNING: developers should never use the reserved suffixes specified in
305 * loader.conf(5) for any tunables or conflicts will result.
306 */
307
308/*
309 * int
310 * please avoid using for new tunables!
311 */
312extern void tunable_int_init(void *);
313struct tunable_int {
314        const char *path;
315        int *var;
316};
317#define TUNABLE_INT(path, var)                                  \
318        static struct tunable_int __CONCAT(__tunable_int_, __LINE__) = { \
319                (path),                                         \
320                (var),                                          \
321        };                                                      \
322        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
323            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int_init, \
324            &__CONCAT(__tunable_int_, __LINE__))
325
326#define TUNABLE_INT_FETCH(path, var)    getenv_int((path), (var))
327
328/*
329 * long
330 */
331extern void tunable_long_init(void *);
332struct tunable_long {
333        const char *path;
334        long *var;
335};
336#define TUNABLE_LONG(path, var)                                 \
337        static struct tunable_long __CONCAT(__tunable_long_, __LINE__) = { \
338                (path),                                         \
339                (var),                                          \
340        };                                                      \
341        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
342            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_long_init,\
343            &__CONCAT(__tunable_long_, __LINE__))
344
345#define TUNABLE_LONG_FETCH(path, var)   getenv_long((path), (var))
346
347/*
348 * unsigned long
349 */
350extern void tunable_ulong_init(void *);
351struct tunable_ulong {
352        const char *path;
353        unsigned long *var;
354};
355#define TUNABLE_ULONG(path, var)                                \
356        static struct tunable_ulong __CONCAT(__tunable_ulong_, __LINE__) = { \
357                (path),                                         \
358                (var),                                          \
359        };                                                      \
360        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
361            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_ulong_init, \
362            &__CONCAT(__tunable_ulong_, __LINE__))
363
364#define TUNABLE_ULONG_FETCH(path, var)  getenv_ulong((path), (var))
365
366/*
367 * quad
368 */
369extern void tunable_quad_init(void *);
370struct tunable_quad {
371        const char *path;
372        quad_t *var;
373};
374#define TUNABLE_QUAD(path, var)                                 \
375        static struct tunable_quad __CONCAT(__tunable_quad_, __LINE__) = { \
376                (path),                                         \
377                (var),                                          \
378        };                                                      \
379        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
380            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_quad_init, \
381            &__CONCAT(__tunable_quad_, __LINE__))
382
383#define TUNABLE_QUAD_FETCH(path, var)   getenv_quad((path), (var))
384
385extern void tunable_str_init(void *);
386struct tunable_str {
387        const char *path;
388        char *var;
389        int size;
390};
391#define TUNABLE_STR(path, var, size)                            \
392        static struct tunable_str __CONCAT(__tunable_str_, __LINE__) = { \
393                (path),                                         \
394                (var),                                          \
395                (size),                                         \
396        };                                                      \
397        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
398            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_str_init, \
399            &__CONCAT(__tunable_str_, __LINE__))
400
401#define TUNABLE_STR_FETCH(path, var, size)                      \
402        getenv_string((path), (var), (size))
403#else /* __rtems__ */
404#define TUNABLE_INT(path, var)
405#define TUNABLE_INT_FETCH(path, var)
406#define TUNABLE_LONG(path, var)
407#define TUNABLE_LONG_FETCH(path, var)
408#define TUNABLE_ULONG(path, var)
409#define TUNABLE_ULONG_FETCH(path, var)
410#define TUNABLE_QUAD(path, var)
411#define TUNABLE_QUAD_FETCH(path, var)
412#define TUNABLE_STR(path, var, size)
413#define TUNABLE_STR_FETCH(path, var, size)
414#endif /* __rtems__ */
415
416struct intr_config_hook {
417        TAILQ_ENTRY(intr_config_hook) ich_links;
418        void    (*ich_func)(void *arg);
419        void    *ich_arg;
420};
421
422int     config_intrhook_establish(struct intr_config_hook *hook);
423void    config_intrhook_disestablish(struct intr_config_hook *hook);
424
425#endif /* !_SYS_KERNEL_H_*/
Note: See TracBrowser for help on using the repository browser.