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.19 2006/01/25 19:56:23 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 timespec 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 lbolt_syncer;                /* approx 1 hz but may be sped up */
  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 enum sysinit_sub_id {
 102         SI_SUB_DUMMY            = 0x0000000,    /* not executed; for linker*/
 103         SI_SUB_DONE             = 0x0000001,    /* processed*/
 104         SI_SUB_TUNABLES         = 0x0700000,    /* establish tunable values */
 105         SI_SUB_CONSOLE          = 0x0800000,    /* console*/
 106         SI_SUB_COPYRIGHT        = 0x0800001,    /* first use of console*/
 107         SI_SUB_LOCK             = 0x0900000,    /* lockmgr locks and tokens */
 108         SI_SUB_VM               = 0x1000000,    /* virtual memory system init*/
 109         SI_SUB_KMEM             = 0x1800000,    /* kernel memory*/
 110         SI_SUB_KVM_RSRC         = 0x1A00000,    /* kvm operational limits*/
 111         SI_SUB_CPU              = 0x1e00000,    /* CPU resource(s)*/
 112         SI_SUB_KLD              = 0x1f00000,    /* KLD and module setup */
 113         SI_SUB_INTRINSIC        = 0x2000000,    /* proc 0*/
 114         SI_SUB_VM_CONF          = 0x2100000,    /* config VM, set limits*/
 115         SI_SUB_RUN_QUEUE        = 0x2200000,    /* the run queue*/
 116         SI_SUB_CREATE_INIT      = 0x2300000,    /* create the init process */
 117         SI_SUB_MBUF             = 0x2380000,    /* mbuf subsystem */
 118         SI_SUB_LEAVE_CRIT       = 0x23c0000,    /* allow interrupt operation */
 119         SI_SUB_DRIVERS          = 0x2400000,    /* Let Drivers initialize */
 120         SI_SUB_CONFIGURE        = 0x3800000,    /* Configure devices */
 121         SI_SUB_VFS              = 0x4000000,    /* virtual file system*/
 122         SI_SUB_CLOCKS           = 0x4800000,    /* real time and stat clocks*/
 123         SI_SUB_FINISH_SMP       = 0x5000000,    /* finish setting up cpus */
 124         SI_SUB_HELPER_THREADS   = 0x5400000,    /* misc helper threads */
 125         SI_SUB_CLIST            = 0x5800000,    /* clists*/
 126         SI_SUB_SYSV_SHM         = 0x6400000,    /* System V shared memory*/
 127         SI_SUB_SYSV_SEM         = 0x6800000,    /* System V semaphores*/
 128         SI_SUB_SYSV_MSG         = 0x6C00000,    /* System V message queues*/
 129         SI_SUB_P1003_1B         = 0x6E00000,    /* P1003.1B realtime */
 130         SI_SUB_PSEUDO           = 0x7000000,    /* pseudo devices*/
 131         SI_SUB_EXEC             = 0x7400000,    /* execve() handlers */
 132         SI_SUB_PROTO_BEGIN      = 0x8000000,    /* network protocol pre-init */
 133         SI_SUB_PROTO_IF         = 0x8400000,    /* interfaces */
 134         SI_SUB_PROTO_DOMAIN     = 0x8800000,    /* domains (address families?)*/
 135         SI_SUB_PROTO_IFATTACHDOMAIN
 136                                 = 0x8800001,    /* domain dependent data init */
 137         SI_SUB_PROTO_END        = 0x8ffffff,    /* network protocol post-init */
 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_RAID             = 0xb300000,    /* Configure vinum */
 144         SI_SUB_MOUNT_ROOT       = 0xb400000,    /* root mount*/
 145         SI_SUB_SWAP             = 0xc000000,    /* swap*/
 146         SI_SUB_INTRINSIC_POST   = 0xd000000,    /* proc 0 cleanup*/
 147         SI_SUB_KTHREAD_INIT     = 0xe000000,    /* init process*/
 148         SI_SUB_KTHREAD_PAGE     = 0xe400000,    /* pageout daemon*/
 149         SI_SUB_KTHREAD_VM       = 0xe800000,    /* vm daemon*/
 150         SI_SUB_KTHREAD_BUF      = 0xea00000,    /* buffer daemon*/
 151         SI_SUB_KTHREAD_UPDATE   = 0xec00000,    /* update daemon*/
 152         SI_SUB_KTHREAD_IDLE     = 0xee00000,    /* idle procs*/
 153         SI_SUB_SMP              = 0xf000000,    /* idle procs*/
 154         SI_SUB_RUN_SCHEDULER    = 0xfffffff     /* scheduler: no return*/
 155 };
 156
 157
 158 /*
 159  * Some enumerated orders; "ANY" sorts last.
 160  */
 161 enum sysinit_elem_order {
 162         SI_ORDER_FIRST          = 0x0000000,    /* first*/
 163         SI_ORDER_SECOND         = 0x0000001,    /* second*/
 164         SI_ORDER_THIRD          = 0x0000002,    /* third*/
 165         SI_ORDER_MIDDLE         = 0x1000000,    /* somewhere in the middle */
 166         SI_ORDER_ANY            = 0xfffffff     /* last*/
 167 };
 168
 169
 170 /*
 171  * A system initialization call instance
 172  *
 173  * At the moment there is one instance of sysinit.  We probably do not
 174  * want two which is why this code is if'd out, but we definitely want
 175  * to discern SYSINIT's which take non-constant data pointers and
 176  * SYSINIT's which take constant data pointers,
 177  *
 178  * The C_* macros take functions expecting const void * arguments
 179  * while the non-C_* macros take functions expecting just void * arguments.
 180  *
 181  * With -Wcast-qual on, the compiler issues warnings:
 182  *      - if we pass non-const data or functions taking non-const data
 183  *        to a C_* macro.
 184  *
 185  *      - if we pass const data to the normal macros
 186  *
 187  * However, no warning is issued if we pass a function taking const data
 188  * through a normal non-const macro.  This is ok because the function is
 189  * saying it won't modify the data so we don't care whether the data is
 190  * modifiable or not.
 191  */
 192
 193 typedef void (*sysinit_nfunc_t) (void *);
 194 typedef void (*sysinit_cfunc_t) (const void *);
 195
 196 struct sysinit {
 197         unsigned int    subsystem;              /* subsystem identifier*/
 198         unsigned int    order;                  /* init order within subsystem*/
 199         sysinit_cfunc_t func;                   /* function             */
 200         const void      *udata;                 /* multiplexer/argument */
 201 };
 202
 203 /*
 204  * Default: no special processing
 205  *
 206  * The C_ version of SYSINIT is for data pointers to const
 207  * data ( and functions taking data pointers to const data ).
 208  * At the moment it is no different from SYSINIT and thus
 209  * still results in warnings.
 210  *
 211  * The casts are necessary to have the compiler produce the
 212  * correct warnings when -Wcast-qual is used.
 213  *
 214  */
 215 #define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
 216         static struct sysinit uniquifier ## _sys_init = {       \
 217                 subsystem,                                      \
 218                 order,                                          \
 219                 func,                                           \
 220                 ident                                           \
 221         };                                                      \
 222         DATA_SET(sysinit_set,uniquifier ## _sys_init);
 223
 224 #define SYSINIT(uniquifier, subsystem, order, func, ident)      \
 225         C_SYSINIT(uniquifier, subsystem, order,                 \
 226         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
 227
 228 /*
 229  * Called on module unload: no special processing
 230  */
 231 #define C_SYSUNINIT(uniquifier, subsystem, order, func, ident)  \
 232         static struct sysinit uniquifier ## _sys_uninit = {     \
 233                 subsystem,                                      \
 234                 order,                                          \
 235                 func,                                           \
 236                 ident                                           \
 237         };                                                      \
 238         DATA_SET(sysuninit_set,uniquifier ## _sys_uninit)
 239
 240 #define SYSUNINIT(uniquifier, subsystem, order, func, ident)    \
 241         C_SYSUNINIT(uniquifier, subsystem, order,               \
 242         (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)ident)
 243
 244 void    sysinit_add (struct sysinit **, struct sysinit **);
 245
 246 /*
 247  * Infrastructure for tunable 'constants'.  Value may be specified at compile
 248  * time or kernel load time.  Rules relating tunables together can be placed
 249  * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_LAST.
 250  */
 251
 252 extern void tunable_int_init(void *);
 253 struct tunable_int {
 254         const char *path;
 255         int *var;
 256 };
 257 #define TUNABLE_INT(path, var)                                  \
 258         _TUNABLE_INT((path), (var), __LINE__)
 259 #define _TUNABLE_INT(path, var, line)                           \
 260         __TUNABLE_INT((path), (var), line)
 261
 262 #define __TUNABLE_INT(path, var, line)                          \
 263         static struct tunable_int __tunable_int_ ## line = {    \
 264                 path,                                           \
 265                 var,                                            \
 266         };                                                      \
 267         SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
 268              tunable_int_init, &__tunable_int_ ## line)
 269
 270 #define TUNABLE_INT_FETCH(path, var)    getenv_int((path), (var))
 271
 272 /* Backwards compatibility with the old deprecated TUNABLE_INT_DECL API */
 273 #define TUNABLE_INT_DECL(path, defval, var)     \
 274 static void __Tunable_ ## var (void *ignored)   \
 275 {                                               \
 276         (var) = (defval);                       \
 277         TUNABLE_INT_FETCH((path), &(var));      \
 278 }                                               \
 279 SYSINIT(__Tunable_init_ ## var, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, __Tunable_ ## var , NULL);
 280
 281 extern void tunable_quad_init(void *);
 282 struct tunable_quad {
 283         const char *path;
 284         quad_t *var;
 285 };
 286 #define TUNABLE_QUAD(path, var)                                 \
 287         _TUNABLE_QUAD((path), (var), __LINE__)
 288 #define _TUNABLE_QUAD(path, var, line)                          \
 289         __TUNABLE_QUAD((path), (var), line)
 290
 291 #define __TUNABLE_QUAD(path, var, line)                 \
 292         static struct tunable_quad __tunable_quad_ ## line = {  \
 293                 path,                                           \
 294                 var,                                            \
 295         };                                                      \
 296         SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
 297             tunable_quad_init, &__tunable_quad_ ## line)
 298
 299 #define TUNABLE_QUAD_FETCH(path, var)   getenv_quad((path), (var))
 300
 301 extern void tunable_str_init(void *);
 302 struct tunable_str {
 303         const char *path;
 304         char *var;
 305         int size;
 306 };
 307 #define TUNABLE_STR(path, var, size)                            \
 308         _TUNABLE_STR((path), (var), (size), __LINE__)
 309 #define _TUNABLE_STR(path, var, size, line)                     \
 310         __TUNABLE_STR((path), (var), (size), line)
 311
 312 #define __TUNABLE_STR(path, var, size, line)                    \
 313         static struct tunable_str __tunable_str_ ## line = {    \
 314                 path,                                           \
 315                 var,                                            \
 316                 size,                                           \
 317         };                                                      \
 318         SYSINIT(__Tunable_init_ ## line, SI_SUB_TUNABLES, SI_ORDER_MIDDLE, \
 319              tunable_str_init, &__tunable_str_ ## line)
 320
 321 #define TUNABLE_STR_FETCH(path, var, size)                      \
 322         getenv_string((path), (var), (size))
 323
 324 /*
 325  * Compatibility.  To be deprecated after LKM is removed.
 326  */
 327 #include <sys/module.h>
 328 #define PSEUDO_SET(sym, name) \
 329         static int name ## _modevent(module_t mod, int type, void *data) \
 330         { \
 331                 void (*initfunc)(void *) = (void (*)(void *))data; \
 332                 switch (type) { \
 333                 case MOD_LOAD: \
 334                         /* printf(#name " module load\n"); */ \
 335                         initfunc(NULL); \
 336                         break; \
 337                 case MOD_UNLOAD: \
 338                         printf(#name " module unload - not possible for this module type\n"); \
 339                         return EINVAL; \
 340                 } \
 341                 return 0; \
 342         } \
 343         static moduledata_t name ## _mod = { \
 344                 #name, \
 345                 name ## _modevent, \
 346                 (void *)sym \
 347         }; \
 348         DECLARE_MODULE(name, name ## _mod, SI_SUB_PSEUDO, SI_ORDER_ANY)
 349
 350 extern struct linker_set execsw_set;
 351
 352
 353
 354
 355 struct intr_config_hook {
 356         TAILQ_ENTRY(intr_config_hook) ich_links;
 357         void    (*ich_func) (void *);
 358         void    *ich_arg;
 359         const char *ich_desc;
 360 };
 361
 362 int     config_intrhook_establish (struct intr_config_hook *);
 363 void    config_intrhook_disestablish (struct intr_config_hook *);
 364
 365 #endif /* !_SYS_KERNEL_H_*/