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 mtx;
  96 struct proc;
  97 struct timeval;
  98 struct tty;
  99 struct uio;
 100
 101 void    Debugger __P((const char *msg));
 102 int     nullop __P((void));
 103 int     eopnotsupp __P((void));
 104 int     einval __P((void));
 105 int     seltrue __P((dev_t dev, int which, struct proc *p));
 106 int     ureadc __P((int, struct uio *));
 107 void    *hashinit __P((int count, struct malloc_type *type, u_long *hashmask));
 108 void    *phashinit __P((int count, struct malloc_type *type, u_long *nentries));
 109
 110 void    cpu_boot __P((int));
 111 void    cpu_rootconf __P((void));
 112 void    tablefull __P((const char *));
 113 int     addlog __P((const char *, ...)) __printflike(1, 2);
 114 int     kvprintf __P((char const *, void (*)(int, void*), void *, int,
 115                       _BSD_VA_LIST_)) __printflike(1, 0);
 116 int     log __P((int, const char *, ...)) __printflike(2, 3);
 117 void    logwakeup __P((void));
 118 int     printf __P((const char *, ...)) __printflike(1, 2);
 119 int     snprintf __P((char *, size_t, const char *, ...)) __printflike(3, 4);
 120 int     sprintf __P((char *buf, const char *, ...)) __printflike(2, 3);
 121 int     uprintf __P((const char *, ...)) __printflike(1, 2);
 122 int     vprintf __P((const char *, _BSD_VA_LIST_)) __printflike(1, 0);
 123 int     vsnprintf __P((char *, size_t, const char *, _BSD_VA_LIST_)) __printflike(3, 0);
 124 int     vsprintf __P((char *buf, const char *, _BSD_VA_LIST_)) __printflike(2, 0);
 125 int     ttyprintf __P((struct tty *, const char *, ...)) __printflike(2, 3);
 126 int     sscanf __P((const char *, char const *, ...));
 127 int     vsscanf __P((const char *, char const *, _BSD_VA_LIST_));
 128 long    strtol __P((const char *, char **, int));
 129 u_long  strtoul __P((const char *, char **, int));
 130 quad_t  strtoq __P((const char *, char **, int));
 131 u_quad_t strtouq __P((const char *, char **, int));
 132
 133 void    bcopy __P((const void *from, void *to, size_t len));
 134 void    ovbcopy __P((const void *from, void *to, size_t len));
 135
 136 #ifdef __i386__
 137 extern void     (*bzero) __P((void *buf, size_t len));
 138 #else
 139 void    bzero __P((void *buf, size_t len));
 140 #endif
 141
 142 void    *memcpy __P((void *to, const void *from, size_t len));
 143
 144 int     copystr __P((const void *kfaddr, void *kdaddr, size_t len,
 145                 size_t *lencopied));
 146 int     copyinstr __P((const void *udaddr, void *kaddr, size_t len,
 147                 size_t *lencopied));
 148 int     copyin __P((const void *udaddr, void *kaddr, size_t len));
 149 int     copyout __P((const void *kaddr, void *udaddr, size_t len));
 150
 151 int     fubyte __P((const void *base));
 152 int     subyte __P((void *base, int byte));
 153 int     suibyte __P((void *base, int byte));
 154 long    fuword __P((const void *base));
 155 int     suword __P((void *base, long word));
 156 int     fusword __P((void *base));
 157 int     susword __P((void *base, int word));
 158
 159 void    realitexpire __P((void *));
 160
 161 void    hardclock __P((struct clockframe *frame));
 162 void    softclock __P((void));
 163 void    statclock __P((struct clockframe *frame));
 164
 165 void    startprofclock __P((struct proc *));
 166 void    stopprofclock __P((struct proc *));
 167 void    setstatclockrate __P((int hzrate));
 168
 169 char    *getenv __P((char *name));
 170 int     getenv_int __P((char *name, int *data));
 171 quad_t  getenv_quad __P((char *name, quad_t *data));
 172 extern char *kern_envp;
 173
 174 #ifdef APM_FIXUP_CALLTODO
 175 void    adjust_timeout_calltodo __P((struct timeval *time_change));
 176 #endif /* APM_FIXUP_CALLTODO */
 177
 178 #include <sys/libkern.h>
 179
 180 /* Initialize the world */
 181 void    consinit __P((void));
 182 void    cpu_initclocks __P((void));
 183 void    nchinit __P((void));
 184 void    usrinfoinit __P((void));
 185 void    vntblinit __P((void));
 186
 187 /* Finalize the world. */
 188 void    shutdown_nice __P((int));
 189
 190 /*
 191  * Kernel to clock driver interface.
 192  */
 193 void    inittodr __P((time_t base));
 194 void    resettodr __P((void));
 195 void    startrtclock __P((void));
 196
 197 /* Timeouts */
 198 typedef void timeout_t __P((void *));   /* timeout function type */
 199 #define CALLOUT_HANDLE_INITIALIZER(handle)      \
 200         { NULL }
 201
 202 void    callout_handle_init __P((struct callout_handle *));
 203 struct  callout_handle timeout __P((timeout_t *, void *, int));
 204 void    untimeout __P((timeout_t *, void *, struct callout_handle));
 205
 206 /* Interrupt management */
 207 void            setdelayed __P((void));
 208 void            setsoftast __P((void));
 209 void            setsoftcambio __P((void));
 210 void            setsoftcamnet __P((void));
 211 void            setsoftclock __P((void));
 212 void            setsoftnet __P((void));
 213 void            setsofttty __P((void));
 214 void            setsoftvm __P((void));
 215 void            setsofttq __P((void));
 216 void            schedsoftcamnet __P((void));
 217 void            schedsoftcambio __P((void));
 218 void            schedsoftnet __P((void));
 219 void            schedsofttty __P((void));
 220 void            schedsoftvm __P((void));
 221 void            schedsofttq __P((void));
 222 intrmask_t      softclockpending __P((void));
 223 void            spl0 __P((void));
 224 intrmask_t      splbio __P((void));
 225 intrmask_t      splcam __P((void));
 226 intrmask_t      splclock __P((void));
 227 intrmask_t      splhigh __P((void));
 228 intrmask_t      splimp __P((void));
 229 intrmask_t      splnet __P((void));
 230 intrmask_t      splsoftcam __P((void));
 231 intrmask_t      splsoftcambio __P((void));
 232 intrmask_t      splsoftcamnet __P((void));
 233 intrmask_t      splsoftclock __P((void));
 234 intrmask_t      splsofttty __P((void));
 235 intrmask_t      splsoftvm __P((void));
 236 intrmask_t      splsofttq __P((void));
 237 intrmask_t      splstatclock __P((void));
 238 intrmask_t      spltty __P((void));
 239 intrmask_t      splvm __P((void));
 240 void            splx __P((intrmask_t ipl));
 241 intrmask_t      splq __P((intrmask_t ipl));
 242 void            splz __P((void));
 243
 244 #if defined(__ia64__)
 245 #include <machine/ipl.h>
 246 #endif
 247
 248 #ifdef INVARIANT_SUPPORT
 249 void    splbioassert __P((const char *msg));
 250 void    splcamassert __P((const char *msg));
 251 void    splclockassert __P((const char *msg));
 252 void    splhighassert __P((const char *msg));
 253 void    splimpassert __P((const char *msg));
 254 void    splnetassert __P((const char *msg));
 255 void    splsoftcamassert __P((const char *msg));
 256 void    splsoftcambioassert __P((const char *msg));
 257 void    splsoftcamnetassert __P((const char *msg));
 258 void    splsoftclockassert __P((const char *msg));
 259 void    splsoftttyassert __P((const char *msg));
 260 void    splsoftvmassert __P((const char *msg));
 261 void    splsofttqassert __P((const char *msg));
 262 void    splstatclockassert __P((const char *msg));
 263 void    splttyassert __P((const char *msg));
 264 void    splvmassert __P((const char *msg));
 265 #endif /* INVARIANT_SUPPORT */
 266
 267 /*
 268  * XXX It's not clear how "machine independent" these will be yet, but
 269  * they are used all over the place especially in pci drivers.  We would
 270  * have to modify lots of drivers since <machine/cpufunc.h> no longer
 271  * implicitly causes these to be defined when it #included <machine/spl.h>
 272  */
 273 extern intrmask_t bio_imask;    /* group of interrupts masked with splbio() */
 274 extern intrmask_t cam_imask;    /* group of interrupts masked with splcam() */
 275 extern intrmask_t net_imask;    /* group of interrupts masked with splimp() */
 276 extern intrmask_t stat_imask;   /* interrupts masked with splstatclock() */
 277 extern intrmask_t tty_imask;    /* group of interrupts masked with spltty() */
 278
 279 /* Read only */
 280 extern const intrmask_t soft_imask;    /* interrupts masked with splsoft*() */
 281 extern const intrmask_t softnet_imask; /* interrupt masked with splnet() */
 282 extern const intrmask_t softtty_imask; /* interrupt masked with splsofttty() */
 283
 284 /*
 285  * Various callout lists.
 286  */
 287
 288 /* Exit callout list declarations. */
 289 typedef void (*exitlist_fn) __P((struct proc *procp));
 290
 291 int     at_exit __P((exitlist_fn function));
 292 int     rm_at_exit __P((exitlist_fn function));
 293
 294 /* Fork callout list declarations. */
 295 typedef void (*forklist_fn) __P((struct proc *parent, struct proc *child,
 296                                  int flags));
 297
 298 int     at_fork __P((forklist_fn function));
 299 int     rm_at_fork __P((forklist_fn function));
 300
 301 /*
 302  * Not exactly a callout LIST, but a callout entry.
 303  * Allow an external module to define a hardware watchdog tickler.
 304  * Normally a process would do this, but there are times when the
 305  * kernel needs to be able to hold off the watchdog, when the process
 306  * is not active, e.g., when dumping core.
 307  */
 308 typedef void (*watchdog_tickle_fn) __P((void));
 309
 310 extern watchdog_tickle_fn       wdog_tickler;
 311
 312 /*
 313  * Common `proc' functions are declared here so that proc.h can be included
 314  * less often.
 315  */
 316 int     msleep __P((void *chan, struct mtx *mtx, int pri, const char *wmesg,
 317                     int timo));
 318 #define tsleep(chan, pri, wmesg, timo)  msleep(chan, NULL, pri, wmesg, timo)
 319 int     asleep __P((void *chan, int pri, const char *wmesg, int timo));
 320 int     await  __P((int pri, int timo));
 321 void    wakeup __P((void *chan));
 322 void    wakeup_one __P((void *chan));
 323
 324 /*
 325  * Common `dev_t' stuff are declared here to avoid #include poisoning
 326  */
 327
 328 int major(dev_t x);
 329 int minor(dev_t x);
 330 dev_t makedev(int x, int y);
 331 udev_t dev2udev(dev_t x);
 332 dev_t udev2dev(udev_t x, int b);
 333 int uminor(udev_t dev);
 334 int umajor(udev_t dev);
 335 udev_t makeudev(int x, int y);
 336 #endif /* !_SYS_SYSTM_H_ */