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  */
  41
  42 #ifndef _SYS_SYSTM_H_
  43 #define _SYS_SYSTM_H_
  44
  45 #ifndef _KERNEL
  46 #error "This file should not be included by userland programs."
  47 #else
  48
  49 #ifndef _MACHINE_TYPES_H_
  50 #include <machine/types.h>
  51 #endif
  52 #include <machine/stdarg.h>
  53 #include <machine/atomic.h>
  54 #include <machine/cpufunc.h>
  55 #include <sys/callout.h>
  56
  57 extern int securelevel;         /* system security level (see init(8)) */
  58 extern int kernel_mem_readonly; /* disable writes to kernel memory */
  59
  60 extern int cold;                /* nonzero if we are doing a cold boot */
  61 extern int tsleep_now_works;    /* tsleep won't just return any more */
  62 extern const char *panicstr;    /* panic message */
  63 extern int dumping;             /* system is dumping */
  64 extern int safepri;             /* safe ipl when cold or panicing */
  65 extern char version[];          /* system version */
  66 extern char copyright[];        /* system copyright */
  67
  68 extern int selwait;             /* select timeout address */
  69
  70 extern u_char curpriority;      /* priority of current process */
  71
  72 extern long physmem;            /* physical memory */
  73
  74 extern cdev_t dumpdev;          /* dump device */
  75 extern u_int64_t dumplo64;      /* block number into dumpdev, start of dump */
  76
  77 extern cdev_t rootdev;          /* root device */
  78 extern cdev_t rootdevs[2];      /* possible root devices */
  79 extern char *rootdevnames[2];   /* names of possible root devices */
  80 extern char *ZeroPage;
  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 ncpus_fit;           /* round up to a power of 2 */
  92 extern int ncpus_fit_mask;      /* ncpus_fit - 1 */
  93 extern int clocks_running;      /* timing/timeout subsystem is operational */
  94
  95 /* XXX TGEN these don't belong here, they're MD on i386/x86_64 */
  96 extern u_int cpu_feature;       /* CPUID_* features */
  97 extern u_int cpu_feature2;      /* CPUID2_* features */
  98 extern u_int cpu_mi_feature;    /* CPU_MI_XXX machine-nonspecific features */
  99 extern cpumask_t usched_global_cpumask;
 100
 101 extern int nfs_diskless_valid;  /* NFS diskless params were obtained */
 102 extern vm_paddr_t Maxmem;       /* Highest physical memory address in system */
 103
 104 #ifdef  INVARIANTS              /* The option is always available */
 105 #define KASSERT(exp,msg)        do { if (__predict_false(!(exp)))       \
 106                                         panic msg; } while (0)
 107 #define KKASSERT(exp)           do { if (__predict_false(!(exp)))       \
 108                                         panic("assertion: %s in %s",    \
 109                                               #exp, __func__); } while (0)
 110 #define __debugvar
 111 #else
 112 #define KASSERT(exp,msg)
 113 #define KKASSERT(exp)
 114 #define __debugvar              __attribute__((__unused__))
 115 #endif
 116
 117 #define CTASSERT(x)             _CTASSERT(x, __LINE__)
 118 #define _CTASSERT(x, y)         __CTASSERT(x, y)
 119 #define __CTASSERT(x, y)        typedef char __assert ## y[(x) ? 1 : -1]
 120
 121 /*
 122  * General function declarations.
 123  */
 124
 125 struct intrframe;
 126 struct spinlock;
 127 struct lock;
 128 struct mtx;
 129 struct lwkt_serialize;
 130 struct malloc_type;
 131 struct proc;
 132 struct xwait;
 133 struct timeval;
 134 struct tty;
 135 struct uio;
 136 struct globaldata;
 137 struct thread;
 138 struct trapframe;
 139 struct user;
 140 struct vmspace;
 141 struct savetls;
 142 struct krate;
 143
 144 void    Debugger (const char *msg);
 145 void    print_backtrace(int count);
 146 void    mi_gdinit (struct globaldata *gd, int cpu);
 147 void    mi_proc0init(struct globaldata *gd, struct user *proc0paddr);
 148 int     nullop (void);
 149 int     seltrue (cdev_t dev, int which);
 150 int     ureadc (int, struct uio *);
 151 void    *hashinit (int count, struct malloc_type *type, u_long *hashmask);
 152 void    *phashinit (int count, struct malloc_type *type, u_long *nentries);
 153 void    *hashinit_ext (int count, size_t size,
 154                         struct malloc_type *type, u_long *hashmask);
 155 void    *phashinit_ext (int count, size_t size,
 156                         struct malloc_type *type, u_long *nentries);
 157
 158 int     cpu_sanitize_frame (struct trapframe *);
 159 int     cpu_sanitize_tls (struct savetls *);
 160 void    cpu_spinlock_contested(void);
 161 void    cpu_halt (void);
 162 void    cpu_reset (void);
 163 void    cpu_boot (int);
 164 void    cpu_rootconf (void);
 165 void    cpu_vmspace_alloc(struct vmspace *);
 166 void    cpu_vmspace_free(struct vmspace *);
 167 void    cpu_vkernel_trap(struct trapframe *, int);
 168 void    set_user_TLS(void);
 169 void    set_vkernel_fp(struct trapframe *);
 170 int     kvm_access_check(vm_offset_t, vm_offset_t, int);
 171
 172 vm_paddr_t kvtop(void *addr);
 173 int     is_physical_memory (vm_offset_t addr);
 174
 175 extern uint32_t crc32_tab[];
 176 uint32_t crc32(const void *buf, size_t size);
 177 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc);
 178 void    init_param1 (void);
 179 void    init_param2 (int physpages);
 180 void    tablefull (const char *);
 181 int     kvcprintf (char const *, void (*)(int, void*), void *, int,
 182                       __va_list) __printflike(1, 0);
 183 void    kvcreinitspin(void);
 184 int     log (int, const char *, ...) __printflike(2, 3);
 185 void    logwakeup (void);
 186 void    log_console (struct uio *);
 187 int     kprintf (const char *, ...) __printflike(1, 2);
 188 void    kprintf0 (const char *, ...) __printflike(1, 2);
 189 void    krateprintf (struct krate *, const char *, ...) __printflike(2, 3);
 190 int     ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
 191 int     ksnrprintf (char *, size_t, int, const char *, ...) __printflike(4, 5);
 192 int     ksprintf (char *buf, const char *, ...) __printflike(2, 3);
 193 int     uprintf (const char *, ...) __printflike(1, 2);
 194 int     kvprintf (const char *, __va_list) __printflike(1, 0);
 195 int     kvsnprintf (char *, size_t, const char *,
 196                         __va_list) __printflike(3, 0);
 197 int     kvsnrprintf (char *, size_t, int, const char *,
 198                         __va_list) __printflike(4, 0);
 199 int     kvasnrprintf (char **, size_t, int, const char *,
 200                         __va_list) __printflike(4, 0);
 201 int     kvsprintf (char *buf, const char *,
 202                         __va_list) __printflike(2, 0);
 203 int     ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
 204 void    hexdump (const void *ptr, int length, const char *hdr, int flags);
 205 #define HD_COLUMN_MASK  0xff
 206 #define HD_DELIM_MASK   0xff00
 207 #define HD_OMIT_COUNT   (1 << 16)
 208 #define HD_OMIT_HEX     (1 << 17)
 209 #define HD_OMIT_CHARS   (1 << 18)
 210 int     ksscanf (const char *, char const *, ...) __scanflike(2, 3);
 211 int     kvsscanf (const char *, char const *, __va_list) __scanflike(2, 0);
 212 void    kvasfree(char **);
 213
 214 long    strtol (const char *, char **, int);
 215 u_long  strtoul (const char *, char **, int);
 216 quad_t  strtoq (const char *, char **, int);
 217 u_quad_t strtouq (const char *, char **, int);
 218
 219 /*
 220  * note: some functions commonly used by device drivers may be passed
 221  * pointers to volatile storage, volatile set to avoid warnings.
 222  *
 223  * NOTE: bcopyb() - is a dumb byte-granular bcopy.  This routine is
 224  *                  explicitly not meant to be sophisticated.
 225  * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
 226  *                  This routine is explicitly not meant to be sophisticated.
 227  */
 228 void    bcopyb (const void *from, void *to, size_t len);
 229 void    bcopyi (const void *from, void *to, size_t len);
 230 void    bcopy (volatile const void *from, volatile void *to, size_t len);
 231 void    ovbcopy (const void *from, void *to, size_t len);
 232 void    bzero (volatile void *buf, size_t len);
 233 void    bzeront (volatile void *buf, size_t len);
 234 void    *memcpy (void *to, const void *from, size_t len);
 235
 236 int     copystr (const void *kfaddr, void *kdaddr, size_t len,
 237                 size_t *lencopied);
 238 int     copyinstr (const void *udaddr, void *kaddr, size_t len,
 239                 size_t *lencopied);
 240 int     copyin (const void *udaddr, void *kaddr, size_t len);
 241 int     copyout (const void *kaddr, void *udaddr, size_t len);
 242
 243 int     fubyte (const void *base);
 244 int     subyte (void *base, int byte);
 245 long    fuword (const void *base);
 246 int     suword (void *base, long word);
 247 int     fusword (void *base);
 248 int     susword (void *base, int word);
 249 u_long  casuword(volatile u_long *p, u_long oldval, u_long newval);
 250
 251 void    realitexpire (void *);
 252 void    DELAY(int usec);
 253 void    DRIVERSLEEP(int usec);
 254
 255 void    startprofclock (struct proc *);
 256 void    stopprofclock (struct proc *);
 257 void    setstatclockrate (int hzrate);
 258
 259 /*
 260  * Kernel environment support functions and sundry.
 261  */
 262 char    *kgetenv (const char *name);
 263 int     ksetenv(const char *name, const char *value);
 264 int     kunsetenv(const char *name);
 265 void    kfreeenv(char *env);
 266 int     ktestenv(const char *name);
 267 int     kgetenv_int (const char *name, int *data);
 268 int     kgetenv_string (const char *name, char *data, int size);
 269 int     kgetenv_ulong(const char *name, unsigned long *data);
 270 int     kgetenv_quad (const char *name, quad_t *data);
 271 int     kgetenv_long(const char *name, long *data);
 272 extern char *kern_envp;
 273
 274 #ifdef APM_FIXUP_CALLTODO
 275 void    adjust_timeout_calltodo (struct timeval *time_change);
 276 #endif /* APM_FIXUP_CALLTODO */
 277
 278 #include <sys/libkern.h>
 279
 280 /* Initialize the world */
 281 void    mi_startup (void);
 282 void    nchinit (void);
 283
 284 /* Finalize the world. */
 285 void    shutdown_nice (int);
 286
 287 /*
 288  * Kernel to clock driver interface.
 289  */
 290 void    inittodr (time_t base);
 291 void    resettodr (void);
 292 void    startrtclock (void);
 293
 294 /* Timeouts */
 295 typedef void timeout_t (void *);        /* timeout function type */
 296
 297 /* Interrupt management */
 298
 299 /*
 300  * For the alpha arch, some of these functions are static __inline, and
 301  * the others should be.
 302  */
 303 #if defined(__i386__) || defined(__x86_64__)
 304 void            setdelayed (void);
 305 void            setsoftcambio (void);
 306 void            setsoftcamnet (void);
 307 void            setsoftunused02 (void);
 308 void            setsoftcrypto (void);
 309 void            setsoftunused01 (void);
 310 void            setsofttty (void);
 311 void            setsoftvm (void);
 312 void            setsofttq (void);
 313 void            schedsofttty (void);
 314 void            splz (void);
 315 void            splz_check (void);
 316 void            cpu_mmw_pause_int(int*, int);
 317 void            cpu_mmw_pause_long(long*, long);
 318 #endif /* __i386__ */
 319
 320 /*
 321  * Various callout lists.
 322  */
 323
 324 /* Exit callout list declarations. */
 325 typedef void (*exitlist_fn) (struct thread *td);
 326
 327 int     at_exit (exitlist_fn function);
 328 int     rm_at_exit (exitlist_fn function);
 329
 330 /* Fork callout list declarations. */
 331 typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
 332                                  int flags);
 333
 334 int     at_fork (forklist_fn function);
 335 int     rm_at_fork (forklist_fn function);
 336
 337 /*
 338  * Not exactly a callout LIST, but a callout entry.
 339  * Allow an external module to define a hardware watchdog tickler.
 340  * Normally a process would do this, but there are times when the
 341  * kernel needs to be able to hold off the watchdog, when the process
 342  * is not active, e.g., when dumping core.
 343  */
 344 typedef void (*watchdog_tickle_fn) (void);
 345
 346 extern watchdog_tickle_fn       wdog_tickler;
 347 extern struct globaldata        *panic_cpu_gd;
 348
 349 /*
 350  * Common `proc' functions are declared here so that proc.h can be included
 351  * less often.
 352  */
 353 int     tsleep (const volatile void *, int, const char *, int);
 354 int     ssleep (const volatile void *, struct spinlock *, int, const char *, int);
 355 int     lksleep (const volatile void *, struct lock *, int, const char *, int);
 356 int     mtxsleep (const volatile void *, struct mtx *, int, const char *, int);
 357 int     zsleep(const volatile void *, struct lwkt_serialize *, int, const char *, int);
 358 void    tsleep_interlock (const volatile void *, int);
 359 void    tsleep_remove (struct thread *);
 360 int     lwkt_sleep (const char *, int);
 361 void    tstop (void);
 362 void    wakeup (const volatile void *chan);
 363 void    wakeup_one (const volatile void *chan);
 364 void    wakeup_mycpu (const volatile void *chan);
 365 void    wakeup_mycpu_one (const volatile void *chan);
 366 void    wakeup_oncpu (struct globaldata *gd, const volatile void *chan);
 367 void    wakeup_oncpu_one (struct globaldata *gd, const volatile void *chan);
 368 void    wakeup_domain (const volatile void *chan, int domain);
 369 void    wakeup_domain_one (const volatile void *chan, int domain);
 370
 371 /*
 372  * Common `cdev_t' stuff are declared here to avoid #include poisoning
 373  */
 374
 375 int major(cdev_t x);
 376 int minor(cdev_t x);
 377 udev_t dev2udev(cdev_t x);
 378 cdev_t udev2dev(udev_t x, int b);
 379 int uminor(udev_t dev);
 380 int umajor(udev_t dev);
 381 udev_t makeudev(int x, int y);
 382
 383 #endif  /* _KERNEL */
 384 #endif /* !_SYS_SYSTM_H_ */