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