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.58 2007/01/05 22:16:32 dillon Exp $
  41  */
  42
  43 #ifndef _SYS_SYSTM_H_
  44 #define _SYS_SYSTM_H_
  45
  46 #ifndef _KERNEL
  47 #error "This file should not be included by userland programs."
  48 #else
  49
  50 #ifndef _MACHINE_TYPES_H_
  51 #include <machine/types.h>
  52 #endif
  53 #ifndef _MACHINE_STDARG_H_
  54 #include <machine/stdarg.h>
  55 #endif
  56 #include <machine/atomic.h>
  57 #include <machine/cpufunc.h>
  58 #include <sys/callout.h>
  59
  60 extern int securelevel;         /* system security level (see init(8)) */
  61
  62 extern int cold;                /* nonzero if we are doing a cold boot */
  63 extern const char *panicstr;    /* panic message */
  64 extern int dumping;             /* system is dumping */
  65 extern int safepri;             /* safe ipl when cold or panicing */
  66 extern char version[];          /* system version */
  67 extern char copyright[];        /* system copyright */
  68
  69 extern int selwait;             /* select timeout address */
  70
  71 extern u_char curpriority;      /* priority of current process */
  72
  73 extern int physmem;             /* physical memory */
  74
  75 extern cdev_t dumpdev;          /* dump device */
  76 extern long dumplo;             /* offset into dumpdev */
  77
  78 extern cdev_t rootdev;          /* root device */
  79 extern cdev_t rootdevs[2];      /* possible root devices */
  80 extern char *rootdevnames[2];   /* names of possible root devices */
  81
  82 extern int boothowto;           /* reboot flags, from console subsystem */
  83 extern int bootverbose;         /* nonzero to print verbose messages */
  84
  85 extern int maxusers;            /* system tune hint */
  86
  87 extern int ncpus;               /* total number of cpus (real, hyper, virtual)*/
  88 extern int ncpus2;              /* ncpus rounded down to power of 2 */
  89 extern int ncpus2_shift;        /* log base 2 of ncpus2 */
  90 extern int ncpus2_mask;         /* ncpus2 - 1 */
  91 extern int clocks_running;      /* timing/timeout subsystem is operational */
  92
  93 /* XXX TGEN these don't belong here, they're MD on i386/amd64 */
  94 extern u_int cpu_feature;       /* CPUID_* features */
  95 extern u_int cpu_feature2;      /* CPUID2_* features */
  96
  97 extern int nfs_diskless_valid;  /* NFS diskless params were obtained */
  98 extern vm_paddr_t Maxmem;       /* Highest physical memory address in system */
  99
 100 #ifdef  INVARIANTS              /* The option is always available */
 101 #define KASSERT(exp,msg)        do { if (!(exp)) panic msg; } while (0)
 102 #define KKASSERT(exp)           if (!(exp)) panic("assertion: %s in %s", #exp, __func__)
 103 #else
 104 #define KASSERT(exp,msg)
 105 #define KKASSERT(exp)
 106 #endif
 107
 108 #define CTASSERT(x)             _CTASSERT(x, __LINE__)
 109 #define _CTASSERT(x, y)         __CTASSERT(x, y)
 110 #define __CTASSERT(x, y)        typedef char __assert ## y[(x) ? 1 : -1]
 111
 112 /*
 113  * General function declarations.
 114  */
 115
 116 struct intrframe;
 117 struct spinlock;
 118 struct malloc_type;
 119 struct proc;
 120 struct xwait;
 121 struct timeval;
 122 struct tty;
 123 struct uio;
 124 struct globaldata;
 125 struct thread;
 126 struct trapframe;
 127 struct user;
 128
 129 void    Debugger (const char *msg);
 130 void    backtrace(void);
 131 void    mi_gdinit (struct globaldata *gd, int cpu);
 132 void    mi_proc0init(struct globaldata *gd, struct user *proc0paddr);
 133 int     dumpstatus (vm_offset_t addr, off_t count);
 134 int     nullop (void);
 135 int     seltrue (cdev_t dev, int which);
 136 int     ureadc (int, struct uio *);
 137 void    *hashinit (int count, struct malloc_type *type, u_long *hashmask);
 138 void    *phashinit (int count, struct malloc_type *type, u_long *nentries);
 139
 140 int     cpu_sanitize_frame (struct trapframe *);
 141 void    cpu_halt (void);
 142 void    cpu_reset (void);
 143 void    cpu_boot (int);
 144 void    cpu_rootconf (void);
 145
 146 vm_paddr_t kvtop(void *addr);
 147 int     is_physical_memory (vm_offset_t addr);
 148
 149 extern uint32_t crc32_tab[];
 150 uint32_t crc32(const void *buf, size_t size);
 151 void    init_param1 (void);
 152 void    init_param2 (int physpages);
 153 void    tablefull (const char *);
 154 int     kvcprintf (char const *, void (*)(int, void*), void *, int,
 155                       __va_list) __printflike(1, 0);
 156 int     log (int, const char *, ...) __printflike(2, 3);
 157 void    logwakeup (void);
 158 void    log_console (struct uio *);
 159 int     kprintf (const char *, ...) __printflike(1, 2);
 160 int     ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
 161 int     ksprintf (char *buf, const char *, ...) __printflike(2, 3);
 162 int     uprintf (const char *, ...) __printflike(1, 2);
 163 int     kvprintf (const char *, __va_list) __printflike(1, 0);
 164 int     kvsnprintf (char *, size_t, const char *, __va_list) __printflike(3, 0);
 165 int     kvsprintf (char *buf, const char *, __va_list) __printflike(2, 0);
 166 int     ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
 167 int     ksscanf (const char *, char const *, ...);
 168 int     kvsscanf (const char *, char const *, __va_list);
 169
 170 long    strtol (const char *, char **, int);
 171 u_long  strtoul (const char *, char **, int);
 172 quad_t  strtoq (const char *, char **, int);
 173 u_quad_t strtouq (const char *, char **, int);
 174
 175 /*
 176  * note: some functions commonly used by device drivers may be passed
 177  * pointers to volatile storage, volatile set to avoid warnings.
 178  *
 179  * NOTE: bcopyb() - is a dumb byte-granular bcopy.  This routine is
 180  *                  explicitly not meant to be sophisticated.
 181  * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
 182  *                  This routine is explicitly not meant to be sophisticated.
 183  */
 184 void    bcopyb (const void *from, void *to, size_t len);
 185 void    bcopyi (const void *from, void *to, size_t len);
 186 void    bcopy (volatile const void *from, volatile void *to, size_t len);
 187 void    ovbcopy (const void *from, void *to, size_t len);
 188 void    bzero (volatile void *buf, size_t len);
 189 void    *memcpy (void *to, const void *from, size_t len);
 190
 191 int     copystr (const void *kfaddr, void *kdaddr, size_t len,
 192                 size_t *lencopied);
 193 int     copyinstr (const void *udaddr, void *kaddr, size_t len,
 194                 size_t *lencopied);
 195 int     copyin (const void *udaddr, void *kaddr, size_t len);
 196 int     copyout (const void *kaddr, void *udaddr, size_t len);
 197
 198 int     fubyte (const void *base);
 199 int     subyte (void *base, int byte);
 200 long    fuword (const void *base);
 201 int     suword (void *base, long word);
 202 int     fusword (void *base);
 203 int     susword (void *base, int word);
 204
 205 void    realitexpire (void *);
 206 void    DELAY(int usec);
 207
 208 void    startprofclock (struct proc *);
 209 void    stopprofclock (struct proc *);
 210 void    setstatclockrate (int hzrate);
 211
 212 /*
 213  * Console I/O spinlocks - these typically also hard-disable interrupts
 214  * for the duration.
 215  */
 216 void    cons_lock(void);
 217 void    cons_unlock(void);
 218
 219 char    *kgetenv (const char *name);
 220 #define testenv kgetenv
 221 #define freeenv(p)
 222 int     kgetenv_int (const char *name, int *data);
 223 int     kgetenv_string (const char *name, char *data, int size);
 224 int     kgetenv_quad (const char *name, quad_t *data);
 225 extern char *kern_envp;
 226
 227 #ifdef APM_FIXUP_CALLTODO
 228 void    adjust_timeout_calltodo (struct timeval *time_change);
 229 #endif /* APM_FIXUP_CALLTODO */
 230
 231 #include <sys/libkern.h>
 232
 233 /* Initialize the world */
 234 void    mi_startup (void);
 235 void    consinit (void);
 236 void    cpu_initclocks (void);
 237 void    nchinit (void);
 238 void    usrinfoinit (void);
 239
 240 /* Finalize the world. */
 241 void    shutdown_nice (int);
 242
 243 /*
 244  * Kernel to clock driver interface.
 245  */
 246 void    inittodr (time_t base);
 247 void    resettodr (void);
 248 void    startrtclock (void);
 249
 250 /* Timeouts */
 251 typedef void timeout_t (void *);        /* timeout function type */
 252 #define CALLOUT_HANDLE_INITIALIZER(handle)      \
 253         { NULL }
 254
 255 #if 0
 256 /* OBSOLETE INTERFACE */
 257 void    callout_handle_init (struct callout_handle *);
 258 struct  callout_handle timeout (timeout_t *, void *, int);
 259 void    untimeout (timeout_t *, void *, struct callout_handle);
 260 #endif
 261
 262 /* Interrupt management */
 263
 264 /*
 265  * For the alpha arch, some of these functions are static __inline, and
 266  * the others should be.
 267  */
 268 #ifdef __i386__
 269 void            setdelayed (void);
 270 void            setsoftast (void);
 271 void            setsoftcambio (void);
 272 void            setsoftcamnet (void);
 273 void            setsoftclock (void);
 274 void            setsoftcrypto (void);
 275 void            setsoftnet (void);
 276 void            setsofttty (void);
 277 void            setsoftvm (void);
 278 void            setsofttq (void);
 279 void            schedsoftcamnet (void);
 280 void            schedsoftcambio (void);
 281 void            schedsoftnet (void);
 282 void            schedsofttty (void);
 283 void            schedsoftvm (void);
 284 void            schedsofttq (void);
 285 intrmask_t      softclockpending (void);
 286 void            splz (void);
 287 #endif /* __i386__ */
 288
 289 /*
 290  * Various callout lists.
 291  */
 292
 293 /* Exit callout list declarations. */
 294 typedef void (*exitlist_fn) (struct thread *td);
 295
 296 int     at_exit (exitlist_fn function);
 297 int     rm_at_exit (exitlist_fn function);
 298
 299 /* Fork callout list declarations. */
 300 typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
 301                                  int flags);
 302
 303 int     at_fork (forklist_fn function);
 304 int     rm_at_fork (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) (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 (void *, int, const char *, int);
 322 int     msleep (void *, struct spinlock *, int, const char *, int);
 323 void    tsleep_interlock (void *chan);
 324 void    tstop (struct proc *);
 325 void    wakeup (void *chan);
 326 void    wakeup_one (void *chan);
 327 void    wakeup_mycpu (void *chan);
 328 void    wakeup_mycpu_one (void *chan);
 329 void    wakeup_oncpu (struct globaldata *gd, void *chan);
 330 void    wakeup_oncpu_one (struct globaldata *gd, void *chan);
 331 void    wakeup_domain (void *chan, int domain);
 332 void    wakeup_domain_one (void *chan, int domain);
 333
 334 /*
 335  * Common `cdev_t' stuff are declared here to avoid #include poisoning
 336  */
 337
 338 int major(cdev_t x);
 339 int minor(cdev_t x);
 340 udev_t dev2udev(cdev_t x);
 341 cdev_t udev2dev(udev_t x, int b);
 342 int uminor(udev_t dev);
 343 int umajor(udev_t dev);
 344 udev_t makeudev(int x, int y);
 345
 346 #endif  /* _KERNEL */
 347 #endif /* !_SYS_SYSTM_H_ */