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: src/sys/sys/systm.h,v 1.111.2.18 2002/12/17 18:04:02 sam Exp $
  40  * $DragonFly: src/sys/sys/systm.h,v 1.24 2004/10/12 19:20:48 dillon Exp $
  41  */
  42
  43 #ifndef _SYS_SYSTM_H_
  44 #define _SYS_SYSTM_H_
  45
  46 #ifndef _MACHINE_TYPES_H_
  47 #include <machine/types.h>
  48 #endif
  49 #ifndef _MACHINE_STDARG_H_
  50 #include <machine/stdarg.h>
  51 #endif
  52 #include <machine/atomic.h>
  53 #include <machine/cpufunc.h>
  54 #include <sys/callout.h>
  55
  56 extern int securelevel;         /* system security level (see init(8)) */
  57
  58 extern int cold;                /* nonzero if we are doing a cold boot */
  59 extern const char *panicstr;    /* panic message */
  60 extern int dumping;             /* system is dumping */
  61 extern int safepri;             /* safe ipl when cold or panicing */
  62 extern char version[];          /* system version */
  63 extern char copyright[];        /* system copyright */
  64
  65 extern int nswap;               /* size of swap space */
  66
  67 extern int selwait;             /* select timeout address */
  68
  69 extern u_char curpriority;      /* priority of current process */
  70
  71 extern int physmem;             /* physical memory */
  72
  73 extern dev_t dumpdev;           /* dump device */
  74 extern long dumplo;             /* offset into dumpdev */
  75
  76 extern dev_t rootdev;           /* root device */
  77 extern dev_t rootdevs[2];       /* possible root devices */
  78 extern char *rootdevnames[2];   /* names of possible root devices */
  79
  80 extern int boothowto;           /* reboot flags, from console subsystem */
  81 extern int bootverbose;         /* nonzero to print verbose messages */
  82
  83 extern int maxusers;            /* system tune hint */
  84
  85 extern int ncpus;               /* total number of cpus (real, hyper, virtual)*/
  86 extern int ncpus2;              /* ncpus rounded down to power of 2 */
  87 extern int ncpus2_shift;        /* log base 2 of ncpus2 */
  88 extern int ncpus2_mask;         /* ncpus2 - 1 */
  89 extern int clocks_running;      /* timing/timeout subsystem is operational */
  90
  91 #ifdef  INVARIANTS              /* The option is always available */
  92 #define KASSERT(exp,msg)        do { if (!(exp)) panic msg; } while (0)
  93 #define KKASSERT(exp)           if (!(exp)) panic("assertion: " #exp " in %s", __FUNCTION__)
  94 #define SPLASSERT(level, msg)   __CONCAT(__CONCAT(spl,level),assert)(msg)
  95 #define CONDSPLASSERT(cond, level, msg) do {                            \
  96         if (cond)                                                       \
  97                 SPLASSERT(level, msg);                                  \
  98 } while (0)
  99 #else
 100 #define KASSERT(exp,msg)
 101 #define KKASSERT(exp)
 102 #define SPLASSERT(level, msg)
 103 #define CONDSPLASSERT(cond, level, msg)
 104 #endif
 105
 106 #define CTASSERT(x)             _CTASSERT(x, __LINE__)
 107 #define _CTASSERT(x, y)         __CTASSERT(x, y)
 108 #define __CTASSERT(x, y)        typedef char __assert ## y[(x) ? 1 : -1]
 109
 110 /*
 111  * General function declarations.
 112  */
 113
 114 struct intrframe;
 115 struct malloc_type;
 116 struct proc;
 117 struct xwait;
 118 struct timeval;
 119 struct tty;
 120 struct uio;
 121 struct globaldata;
 122 struct thread;
 123
 124 void    Debugger (const char *msg);
 125 void    backtrace(void);
 126 void    mi_gdinit (struct globaldata *gd, int cpu);
 127 int     dumpstatus (vm_offset_t addr, off_t count);
 128 int     nullop (void);
 129 int     eopnotsupp (void);
 130 int     einval (void);
 131 int     seltrue (dev_t dev, int which, struct thread *td);
 132 int     ureadc (int, struct uio *);
 133 void    *hashinit (int count, struct malloc_type *type, u_long *hashmask);
 134 void    *phashinit (int count, struct malloc_type *type, u_long *nentries);
 135
 136 void    cpu_boot (int);
 137 void    cpu_rootconf (void);
 138 extern uint32_t crc32_tab[];
 139 uint32_t crc32(const void *buf, size_t size);
 140 void    init_param1 (void);
 141 void    init_param2 (int physpages);
 142 void    tablefull (const char *);
 143 int     addlog (const char *, ...) __printflike(1, 2);
 144 int     kvprintf (char const *, void (*)(int, void*), void *, int,
 145                       __va_list) __printflike(1, 0);
 146 int     log (int, const char *, ...) __printflike(2, 3);
 147 void    logwakeup (void);
 148 void    log_console (struct uio *);
 149 int     printf (const char *, ...) __printflike(1, 2);
 150 int     snprintf (char *, size_t, const char *, ...) __printflike(3, 4);
 151 int     sprintf (char *buf, const char *, ...) __printflike(2, 3);
 152 int     uprintf (const char *, ...) __printflike(1, 2);
 153 int     vprintf (const char *, __va_list) __printflike(1, 0);
 154 int     vsnprintf (char *, size_t, const char *, __va_list) __printflike(3, 0);
 155 int     vsprintf (char *buf, const char *, __va_list) __printflike(2, 0);
 156 int     ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
 157 int     sscanf (const char *, char const *, ...);
 158 int     vsscanf (const char *, char const *, __va_list);
 159 long    strtol (const char *, char **, int);
 160 u_long  strtoul (const char *, char **, int);
 161 quad_t  strtoq (const char *, char **, int);
 162 u_quad_t strtouq (const char *, char **, int);
 163
 164 /*
 165  * note: some functions commonly used by device drivers may be passed
 166  * pointers to volatile storage, volatile set to avoid warnings.
 167  */
 168 void    bcopy (volatile const void *from, volatile void *to, size_t len);
 169 void    ovbcopy (const void *from, void *to, size_t len);
 170
 171 #ifdef __i386__
 172 extern void     (*bzero) (volatile void *buf, size_t len);
 173 #else
 174 void    bzero (void *buf, size_t len);
 175 #endif
 176
 177 void    *memcpy (void *to, const void *from, size_t len);
 178
 179 int     copystr (const void *kfaddr, void *kdaddr, size_t len,
 180                 size_t *lencopied);
 181 int     copyinstr (const void *udaddr, void *kaddr, size_t len,
 182                 size_t *lencopied);
 183 int     copyin (const void *udaddr, void *kaddr, size_t len);
 184 int     copyout (const void *kaddr, void *udaddr, size_t len);
 185
 186 int     fubyte (const void *base);
 187 int     subyte (void *base, int byte);
 188 int     suibyte (void *base, int byte);
 189 long    fuword (const void *base);
 190 int     suword (void *base, long word);
 191 int     fusword (void *base);
 192 int     susword (void *base, int word);
 193
 194 void    realitexpire (void *);
 195 void    DELAY(int usec);
 196
 197 void    startprofclock (struct proc *);
 198 void    stopprofclock (struct proc *);
 199 void    setstatclockrate (int hzrate);
 200
 201 char    *getenv (const char *name);
 202 #define testenv getenv
 203 #define freeenv(p)
 204 int     getenv_int (const char *name, int *data);
 205 int     getenv_string (const char *name, char *data, int size);
 206 int     getenv_quad (const char *name, quad_t *data);
 207 extern char *kern_envp;
 208
 209 #ifdef APM_FIXUP_CALLTODO
 210 void    adjust_timeout_calltodo (struct timeval *time_change);
 211 #endif /* APM_FIXUP_CALLTODO */
 212
 213 #include <sys/libkern.h>
 214
 215 /* Initialize the world */
 216 void    consinit (void);
 217 void    cpu_initclocks (void);
 218 void    nchinit (void);
 219 void    usrinfoinit (void);
 220
 221 /* Finalize the world. */
 222 void    shutdown_nice (int);
 223
 224 /*
 225  * Kernel to clock driver interface.
 226  */
 227 void    inittodr (time_t base);
 228 void    resettodr (void);
 229 void    startrtclock (void);
 230
 231 /* Timeouts */
 232 typedef void timeout_t (void *);        /* timeout function type */
 233 #define CALLOUT_HANDLE_INITIALIZER(handle)      \
 234         { NULL }
 235
 236 #if 0
 237 /* OBSOLETE INTERFACE */
 238 void    callout_handle_init (struct callout_handle *);
 239 struct  callout_handle timeout (timeout_t *, void *, int);
 240 void    untimeout (timeout_t *, void *, struct callout_handle);
 241 #endif
 242
 243 /* Interrupt management */
 244
 245 /*
 246  * For the alpha arch, some of these functions are static __inline, and
 247  * the others should be.
 248  */
 249 #ifdef __i386__
 250 void            setdelayed (void);
 251 void            setsoftast (void);
 252 void            setsoftcambio (void);
 253 void            setsoftcamnet (void);
 254 void            setsoftclock (void);
 255 void            setsoftcrypto (void);
 256 void            setsoftnet (void);
 257 void            setsofttty (void);
 258 void            setsoftvm (void);
 259 void            setsofttq (void);
 260 void            schedsoftcamnet (void);
 261 void            schedsoftcambio (void);
 262 void            schedsoftnet (void);
 263 void            schedsofttty (void);
 264 void            schedsoftvm (void);
 265 void            schedsofttq (void);
 266 intrmask_t      softclockpending (void);
 267 void            spl0 (void);
 268 intrmask_t      splbio (void);
 269 intrmask_t      splcam (void);
 270 intrmask_t      splclock (void);
 271 intrmask_t      splcrypto (void);
 272 intrmask_t      splhigh (void);
 273 intrmask_t      splimp (void);
 274 intrmask_t      splnet (void);
 275 intrmask_t      splsoftcam (void);
 276 intrmask_t      splsoftcambio (void);
 277 intrmask_t      splsoftcamnet (void);
 278 intrmask_t      splsoftclock (void);
 279 intrmask_t      splsofttty (void);
 280 intrmask_t      splsoftvm (void);
 281 intrmask_t      splsofttq (void);
 282 intrmask_t      splstatclock (void);
 283 intrmask_t      spltty (void);
 284 intrmask_t      splvm (void);
 285 void            splx (intrmask_t ipl);
 286 void            splz (void);
 287 #endif /* __i386__ */
 288
 289 #ifdef __alpha__
 290 #include <machine/ipl.h>
 291 #endif
 292
 293 #ifdef INVARIANT_SUPPORT
 294 void    splbioassert (const char *msg);
 295 void    splcamassert (const char *msg);
 296 void    splclockassert (const char *msg);
 297 void    splcryptoassert (const char *msg);
 298 void    splhighassert (const char *msg);
 299 void    splimpassert (const char *msg);
 300 void    splnetassert (const char *msg);
 301 void    splsoftcamassert (const char *msg);
 302 void    splsoftcambioassert (const char *msg);
 303 void    splsoftcamnetassert (const char *msg);
 304 void    splsoftclockassert (const char *msg);
 305 void    splsoftttyassert (const char *msg);
 306 void    splsoftvmassert (const char *msg);
 307 void    splsofttqassert (const char *msg);
 308 void    splstatclockassert (const char *msg);
 309 void    splttyassert (const char *msg);
 310 void    splvmassert (const char *msg);
 311 #endif /* INVARIANT_SUPPORT */
 312
 313 /*
 314  * XXX It's not clear how "machine independent" these will be yet, but
 315  * they are used all over the place especially in pci drivers.  We would
 316  * have to modify lots of drivers since <machine/cpufunc.h> no longer
 317  * implicitly causes these to be defined when it #included <machine/spl.h>
 318  */
 319 extern intrmask_t bio_imask;    /* group of interrupts masked with splbio() */
 320 extern intrmask_t cam_imask;    /* group of interrupts masked with splcam() */
 321 extern intrmask_t net_imask;    /* group of interrupts masked with splimp() */
 322 extern intrmask_t stat_imask;   /* interrupts masked with splstatclock() */
 323 extern intrmask_t tty_imask;    /* group of interrupts masked with spltty() */
 324
 325 /* Read only */
 326 extern const intrmask_t soft_imask;    /* interrupts masked with splsoft*() */
 327 extern const intrmask_t softnet_imask; /* interrupt masked with splnet() */
 328 extern const intrmask_t softtty_imask; /* interrupt masked with splsofttty() */
 329
 330 /*
 331  * Various callout lists.
 332  */
 333
 334 /* Exit callout list declarations. */
 335 typedef void (*exitlist_fn) (struct thread *td);
 336
 337 int     at_exit (exitlist_fn function);
 338 int     rm_at_exit (exitlist_fn function);
 339
 340 /* Fork callout list declarations. */
 341 typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
 342                                  int flags);
 343
 344 int     at_fork (forklist_fn function);
 345 int     rm_at_fork (forklist_fn function);
 346
 347 /*
 348  * Not exactly a callout LIST, but a callout entry.
 349  * Allow an external module to define a hardware watchdog tickler.
 350  * Normally a process would do this, but there are times when the
 351  * kernel needs to be able to hold off the watchdog, when the process
 352  * is not active, e.g., when dumping core.
 353  */
 354 typedef void (*watchdog_tickle_fn) (void);
 355
 356 extern watchdog_tickle_fn       wdog_tickler;
 357
 358 /*
 359  * Common `proc' functions are declared here so that proc.h can be included
 360  * less often.
 361  */
 362 int     tsleep (void *chan, int slpflags, const char *wmesg, int timo);
 363 void    wakeup (void *chan);
 364 void    wakeup_one (void *chan);
 365
 366 /*
 367  * Common `dev_t' stuff are declared here to avoid #include poisoning
 368  */
 369
 370 int major(dev_t x);
 371 int minor(dev_t x);
 372 udev_t dev2udev(dev_t x);
 373 dev_t udev2dev(udev_t x, int b);
 374 int uminor(udev_t dev);
 375 int umajor(udev_t dev);
 376 udev_t makeudev(int x, int y);
 377 #endif /* !_SYS_SYSTM_H_ */