sys/sys/systm.h

   1 /*-
   2  * Copyright (c) 1982, 1988, 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)systm.h     8.7 (Berkeley) 3/29/95
  39  * $FreeBSD$
  40  */
  41
  42 #ifndef _SYS_SYSTM_H_
  43 #define _SYS_SYSTM_H_
  44
  45 #include <machine/atomic.h>
  46 #include <machine/cpufunc.h>
  47 #include <sys/callout.h>
  48
  49 extern int securelevel;         /* system security level (see init(8)) */
  50
  51 extern int cold;                /* nonzero if we are doing a cold boot */
  52 extern const char *panicstr;    /* panic message */
  53 extern int safepri;             /* safe ipl when cold or panicing */
  54 extern char version[];          /* system version */
  55 extern char copyright[];        /* system copyright */
  56
  57 extern int nswap;               /* size of swap space */
  58
  59 extern int selwait;             /* select timeout address */
  60
  61 extern u_char curpriority;      /* priority of current process */
  62
  63 extern int physmem;             /* physical memory */
  64
  65 extern dev_t dumpdev;           /* dump device */
  66 extern long dumplo;             /* offset into dumpdev */
  67
  68 extern dev_t rootdev;           /* root device */
  69 extern dev_t rootdevs[2];       /* possible root devices */
  70 extern char *rootdevnames[2];   /* names of possible root devices */
  71 extern struct vnode *rootvp;    /* vnode equivalent to above */
  72
  73 extern int boothowto;           /* reboot flags, from console subsystem */
  74 extern int bootverbose;         /* nonzero to print verbose messages */
  75
  76 #ifdef  INVARIANTS              /* The option is always available */
  77 #define KASSERT(exp,msg)        do { if (!(exp)) panic msg; } while (0)
  78 #define SPLASSERT(level, msg)   __CONCAT(__CONCAT(spl,level),assert)(msg)
  79 #define CONDSPLASSERT(cond, level, msg) do {                            \
  80         if (cond)                                                       \
  81                 SPLASSERT(level, msg);                                  \
  82 } while (0)
  83 #else
  84 #define KASSERT(exp,msg)
  85 #define SPLASSERT(level, msg)
  86 #define CONDSPLASSERT(cond, level, msg)
  87 #endif
  88
  89 /*
  90  * General function declarations.
  91  */
  92
  93 struct clockframe;
  94 struct malloc_type;
  95 struct proc;
  96 struct timeval;
  97 struct tty;
  98 struct uio;
  99
 100 void    Debugger __P((const char *msg));
 101 int     nullop __P((void));
 102 int     eopnotsupp __P((void));
 103 int     einval __P((void));
 104 int     seltrue __P((dev_t dev, int which, struct proc *p));
 105 int     ureadc __P((int, struct uio *));
 106 void    *hashinit __P((int count, struct malloc_type *type, u_long *hashmask));
 107 void    *phashinit __P((int count, struct malloc_type *type, u_long *nentries));
 108
 109 void    cpu_boot __P((int));
 110 void    cpu_rootconf __P((void));
 111 void    tablefull __P((const char *));
 112 int     addlog __P((const char *, ...)) __printflike(1, 2);
 113 int     kvprintf __P((char const *, void (*)(int, void*), void *, int,
 114                       _BSD_VA_LIST_)) __printflike(1, 0);
 115 int     log __P((int, const char *, ...)) __printflike(2, 3);
 116 void    logwakeup __P((void));
 117 int     printf __P((const char *, ...)) __printflike(1, 2);
 118 int     snprintf __P((char *, size_t, const char *, ...)) __printflike(3, 4);
 119 int     sprintf __P((char *buf, const char *, ...)) __printflike(2, 3);
 120 int     uprintf __P((const char *, ...)) __printflike(1, 2);
 121 int     vprintf __P((const char *, _BSD_VA_LIST_)) __printflike(1, 0);
 122 int     vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_)) __printflike(3, 0);
 123 int     vsprintf __P((char *buf, const char *, _BSD_VA_LIST_)) __printflike(2, 0);
 124 int     ttyprintf __P((struct tty *, const char *, ...)) __printflike(2, 3);
 125 int     sscanf __P((const char *, char const *, ...));
 126 int     vsscanf __P((const char *, char const *, _BSD_VA_LIST_));
 127 long    strtol __P((const char *, char **, int));
 128 u_long  strtoul __P((const char *, char **, int));
 129 quad_t  strtoq __P((const char *, char **, int));
 130 u_quad_t strtouq __P((const char *, char **, int));
 131
 132 void    bcopy __P((const void *from, void *to, size_t len));
 133 void    ovbcopy __P((const void *from, void *to, size_t len));
 134
 135 #ifdef __i386__
 136 extern void     (*bzero) __P((void *buf, size_t len));
 137 #else
 138 void    bzero __P((void *buf, size_t len));
 139 #endif
 140
 141 void    *memcpy __P((void *to, const void *from, size_t len));
 142
 143 int     copystr __P((const void *kfaddr, void *kdaddr, size_t len,
 144                 size_t *lencopied));
 145 int     copyinstr __P((const void *udaddr, void *kaddr, size_t len,
 146                 size_t *lencopied));
 147 int     copyin __P((const void *udaddr, void *kaddr, size_t len));
 148 int     copyout __P((const void *kaddr, void *udaddr, size_t len));
 149
 150 int     fubyte __P((const void *base));
 151 int     subyte __P((void *base, int byte));
 152 int     suibyte __P((void *base, int byte));
 153 long    fuword __P((const void *base));
 154 int     suword __P((void *base, long word));
 155 int     fusword __P((void *base));
 156 int     susword __P((void *base, int word));
 157
 158 void    realitexpire __P((void *));
 159
 160 void    hardclock __P((struct clockframe *frame));
 161 void    softclock __P((void));
 162 void    statclock __P((struct clockframe *frame));
 163
 164 void    startprofclock __P((struct proc *));
 165 void    stopprofclock __P((struct proc *));
 166 void    setstatclockrate __P((int hzrate));
 167
 168 char    *getenv __P((char *name));
 169 int     getenv_int __P((char *name, int *data));
 170 quad_t  getenv_quad __P((char *name, quad_t *data));
 171 extern char *kern_envp;
 172
 173 #ifdef APM_FIXUP_CALLTODO
 174 void    adjust_timeout_calltodo __P((struct timeval *time_change));
 175 #endif /* APM_FIXUP_CALLTODO */
 176
 177 #include <sys/libkern.h>
 178
 179 /* Initialize the world */
 180 void    consinit __P((void));
 181 void    cpu_initclocks __P((void));
 182 void    nchinit __P((void));
 183 void    usrinfoinit __P((void));
 184 void    vntblinit __P((void));
 185
 186 /* Finalize the world. */
 187 void    shutdown_nice __P((int));
 188
 189 /*
 190  * Kernel to clock driver interface.
 191  */
 192 void    inittodr __P((time_t base));
 193 void    resettodr __P((void));
 194 void    startrtclock __P((void));
 195
 196 /* Timeouts */
 197 typedef void timeout_t __P((void *));   /* timeout function type */
 198 #define CALLOUT_HANDLE_INITIALIZER(handle)      \
 199         { NULL }
 200
 201 void    callout_handle_init __P((struct callout_handle *));
 202 struct  callout_handle timeout __P((timeout_t *, void *, int));
 203 void    untimeout __P((timeout_t *, void *, struct callout_handle));
 204
 205 /* Interrupt management */
 206
 207 /*
 208  * For the alpha arch, some of these functions are static __inline, and
 209  * the others should be.
 210  */
 211 #ifdef __i386__
 212 void            setdelayed __P((void));
 213 void            setsoftast __P((void));
 214 void            setsoftcambio __P((void));
 215 void            setsoftcamnet __P((void));
 216 void            setsoftclock __P((void));
 217 void            setsoftnet __P((void));
 218 void            setsofttty __P((void));
 219 void            setsoftvm __P((void));
 220 void            setsofttq __P((void));
 221 void            schedsoftcamnet __P((void));
 222 void            schedsoftcambio __P((void));
 223 void            schedsoftnet __P((void));
 224 void            schedsofttty __P((void));
 225 void            schedsoftvm __P((void));
 226 void            schedsofttq __P((void));
 227 intrmask_t      softclockpending __P((void));
 228 void            spl0 __P((void));
 229 intrmask_t      splbio __P((void));
 230 intrmask_t      splcam __P((void));
 231 intrmask_t      splclock __P((void));
 232 intrmask_t      splhigh __P((void));
 233 intrmask_t      splimp __P((void));
 234 intrmask_t      splnet __P((void));
 235 intrmask_t      splsoftcam __P((void));
 236 intrmask_t      splsoftcambio __P((void));
 237 intrmask_t      splsoftcamnet __P((void));
 238 intrmask_t      splsoftclock __P((void));
 239 intrmask_t      splsofttty __P((void));
 240 intrmask_t      splsoftvm __P((void));
 241 intrmask_t      splsofttq __P((void));
 242 intrmask_t      splstatclock __P((void));
 243 intrmask_t      spltty __P((void));
 244 intrmask_t      splvm __P((void));
 245 void            splx __P((intrmask_t ipl));
 246 void            splz __P((void));
 247 #endif /* __i386__ */
 248
 249 #ifdef __alpha__
 250 #include <machine/ipl.h>
 251 #endif
 252
 253 #ifdef INVARIANT_SUPPORT
 254 void    splbioassert __P((const char *msg));
 255 void    splcamassert __P((const char *msg));
 256 void    splclockassert __P((const char *msg));
 257 void    splhighassert __P((const char *msg));
 258 void    splimpassert __P((const char *msg));
 259 void    splnetassert __P((const char *msg));
 260 void    splsoftcamassert __P((const char *msg));
 261 void    splsoftcambioassert __P((const char *msg));
 262 void    splsoftcamnetassert __P((const char *msg));
 263 void    splsoftclockassert __P((const char *msg));
 264 void    splsoftttyassert __P((const char *msg));
 265 void    splsoftvmassert __P((const char *msg));
 266 void    splsofttqassert __P((const char *msg));
 267 void    splstatclockassert __P((const char *msg));
 268 void    splttyassert __P((const char *msg));
 269 void    splvmassert __P((const char *msg));
 270 #endif /* INVARIANT_SUPPORT */
 271
 272 /*
 273  * XXX It's not clear how "machine independent" these will be yet, but
 274  * they are used all over the place especially in pci drivers.  We would
 275  * have to modify lots of drivers since <machine/cpufunc.h> no longer
 276  * implicitly causes these to be defined when it #included <machine/spl.h>
 277  */
 278 extern intrmask_t bio_imask;    /* group of interrupts masked with splbio() */
 279 extern intrmask_t cam_imask;    /* group of interrupts masked with splcam() */
 280 extern intrmask_t net_imask;    /* group of interrupts masked with splimp() */
 281 extern intrmask_t stat_imask;   /* interrupts masked with splstatclock() */
 282 extern intrmask_t tty_imask;    /* group of interrupts masked with spltty() */
 283
 284 /* Read only */
 285 extern const intrmask_t soft_imask;    /* interrupts masked with splsoft*() */
 286 extern const intrmask_t softnet_imask; /* interrupt masked with splnet() */
 287 extern const intrmask_t softtty_imask; /* interrupt masked with splsofttty() */
 288
 289 /*
 290  * Various callout lists.
 291  */
 292
 293 /* Exit callout list declarations. */
 294 typedef void (*exitlist_fn) __P((struct proc *procp));
 295
 296 int     at_exit __P((exitlist_fn function));
 297 int     rm_at_exit __P((exitlist_fn function));
 298
 299 /* Fork callout list declarations. */
 300 typedef void (*forklist_fn) __P((struct proc *parent, struct proc *child,
 301                                  int flags));
 302
 303 int     at_fork __P((forklist_fn function));
 304 int     rm_at_fork __P((forklist_fn function));
 305
 306 /*
 307  * Not exactly a callout LIST, but a callout entry.
 308  * Allow an external module to define a hardware watchdog tickler.
 309  * Normally a process would do this, but there are times when the
 310  * kernel needs to be able to hold off the watchdog, when the process
 311  * is not active, e.g., when dumping core.
 312  */
 313 typedef void (*watchdog_tickle_fn) __P((void));
 314
 315 extern watchdog_tickle_fn       wdog_tickler;
 316
 317 /*
 318  * Common `proc' functions are declared here so that proc.h can be included
 319  * less often.
 320  */
 321 int     tsleep __P((void *chan, int pri, const char *wmesg, int timo));
 322 int     asleep __P((void *chan, int pri, const char *wmesg, int timo));
 323 int     await  __P((int pri, int timo));
 324 void    wakeup __P((void *chan));
 325 void    wakeup_one __P((void *chan));
 326
 327 /*
 328  * Common `dev_t' stuff are declared here to avoid #include poisoning
 329  */
 330
 331 int major(dev_t x);
 332 int minor(dev_t x);
 333 dev_t makedev(int x, int y);
 334 udev_t dev2udev(dev_t x);
 335 dev_t udev2dev(udev_t x, int b);
 336 int uminor(udev_t dev);
 337 int umajor(udev_t dev);
 338 udev_t makeudev(int x, int y);
 339 #endif /* !_SYS_SYSTM_H_ */