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