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  * 4. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)systm.h     8.7 (Berkeley) 3/29/95
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _SYS_SYSTM_H_
  39 #define _SYS_SYSTM_H_
  40
  41 #include <machine/atomic.h>
  42 #include <machine/cpufunc.h>
  43 #include <sys/callout.h>
  44 #include <sys/cdefs.h>
  45 #include <sys/queue.h>
  46 #include <sys/stdint.h>         /* for people using printf mainly */
  47
  48 extern int cold;                /* nonzero if we are doing a cold boot */
  49 extern int rebooting;           /* boot() has been called. */
  50 extern const char *panicstr;    /* panic message */
  51 extern char version[];          /* system version */
  52 extern char copyright[];        /* system copyright */
  53 extern int kstack_pages;        /* number of kernel stack pages */
  54
  55 extern int nswap;               /* size of swap space */
  56
  57 extern long physmem;            /* physical memory */
  58 extern long realmem;            /* 'real' memory */
  59
  60 extern char *rootdevnames[2];   /* names of possible root devices */
  61
  62 extern int boothowto;           /* reboot flags, from console subsystem */
  63 extern int bootverbose;         /* nonzero to print verbose messages */
  64
  65 extern int maxusers;            /* system tune hint */
  66
  67 #ifdef  INVARIANTS              /* The option is always available */
  68 #define KASSERT(exp,msg) do {                                           \
  69         if (__predict_false(!(exp)))                                    \
  70                 panic msg;                                              \
  71 } while (0)
  72 #define VNASSERT(exp, vp, msg) do {                                     \
  73         if (__predict_false(!(exp))) {                                  \
  74                 vn_printf(vp, "VNASSERT failed\n");                     \
  75                 panic msg;                                              \
  76         }                                                               \
  77 } while (0)
  78 #else
  79 #define KASSERT(exp,msg) do { \
  80 } while (0)
  81
  82 #define VNASSERT(exp, vp, msg) do { \
  83 } while (0)
  84 #endif
  85
  86 #ifndef CTASSERT                /* Allow lint to override */
  87 #define CTASSERT(x)             _CTASSERT(x, __LINE__)
  88 #define _CTASSERT(x, y)         __CTASSERT(x, y)
  89 #define __CTASSERT(x, y)        typedef char __assert ## y[(x) ? 1 : -1]
  90 #endif
  91
  92 /*
  93  * Assert that a pointer can be loaded from memory atomically.
  94  *
  95  * This assertion enforces stronger alignment than necessary.  For example,
  96  * on some architectures, atomicity for unaligned loads will depend on
  97  * whether or not the load spans multiple cache lines.
  98  */
  99 #define ASSERT_ATOMIC_LOAD_PTR(var, msg)                                \
 100         KASSERT(sizeof(var) == sizeof(void *) &&                        \
 101             ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
 102
 103 /*
 104  * XXX the hints declarations are even more misplaced than most declarations
 105  * in this file, since they are needed in one file (per arch) and only used
 106  * in two files.
 107  * XXX most of these variables should be const.
 108  */
 109 extern int osreldate;
 110 extern int envmode;
 111 extern int hintmode;            /* 0 = off. 1 = config, 2 = fallback */
 112 extern int dynamic_kenv;
 113 extern struct mtx kenv_lock;
 114 extern char *kern_envp;
 115 extern char static_env[];
 116 extern char static_hints[];     /* by config for now */
 117
 118 extern char **kenvp;
 119
 120 /*
 121  * General function declarations.
 122  */
 123
 124 struct inpcb;
 125 struct lock_object;
 126 struct malloc_type;
 127 struct mtx;
 128 struct proc;
 129 struct socket;
 130 struct thread;
 131 struct tty;
 132 struct ucred;
 133 struct uio;
 134 struct _jmp_buf;
 135
 136 int     setjmp(struct _jmp_buf *);
 137 void    longjmp(struct _jmp_buf *, int) __dead2;
 138 int     dumpstatus(vm_offset_t addr, off_t count);
 139 int     nullop(void);
 140 int     eopnotsupp(void);
 141 int     ureadc(int, struct uio *);
 142 void    hashdestroy(void *, struct malloc_type *, u_long);
 143 void    *hashinit(int count, struct malloc_type *type, u_long *hashmark);
 144 void    *hashinit_flags(int count, struct malloc_type *type,
 145     u_long *hashmask, int flags);
 146 #define HASH_NOWAIT     0x00000001
 147 #define HASH_WAITOK     0x00000002
 148
 149 void    *phashinit(int count, struct malloc_type *type, u_long *nentries);
 150 void    g_waitidle(void);
 151
 152 #ifdef RESTARTABLE_PANICS
 153 void    panic(const char *, ...) __printflike(1, 2);
 154 #else
 155 void    panic(const char *, ...) __dead2 __printflike(1, 2);
 156 #endif
 157
 158 void    cpu_boot(int);
 159 void    cpu_flush_dcache(void *, size_t);
 160 void    cpu_rootconf(void);
 161 void    critical_enter(void);
 162 void    critical_exit(void);
 163 void    init_param1(void);
 164 void    init_param2(long physpages);
 165 void    init_param3(long kmempages);
 166 void    tablefull(const char *);
 167 int     kvprintf(char const *, void (*)(int, void*), void *, int,
 168             __va_list) __printflike(1, 0);
 169 void    log(int, const char *, ...) __printflike(2, 3);
 170 void    log_console(struct uio *);
 171 int     printf(const char *, ...) __printflike(1, 2);
 172 int     snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
 173 int     sprintf(char *buf, const char *, ...) __printflike(2, 3);
 174 int     uprintf(const char *, ...) __printflike(1, 2);
 175 int     vprintf(const char *, __va_list) __printflike(1, 0);
 176 int     vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
 177 int     vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
 178 int     vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
 179 int     ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
 180 int     sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
 181 int     vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
 182 long    strtol(const char *, char **, int) __nonnull(1);
 183 u_long  strtoul(const char *, char **, int) __nonnull(1);
 184 quad_t  strtoq(const char *, char **, int) __nonnull(1);
 185 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
 186 void    tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
 187 void    hexdump(const void *ptr, int length, const char *hdr, int flags);
 188 #define HD_COLUMN_MASK  0xff
 189 #define HD_DELIM_MASK   0xff00
 190 #define HD_OMIT_COUNT   (1 << 16)
 191 #define HD_OMIT_HEX     (1 << 17)
 192 #define HD_OMIT_CHARS   (1 << 18)
 193
 194 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
 195 void    bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
 196 void    bzero(void *buf, size_t len) __nonnull(1);
 197
 198 void    *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
 199 void    *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
 200
 201 int     copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
 202             size_t len, size_t * __restrict lencopied)
 203             __nonnull(1) __nonnull(2);
 204 int     copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
 205             size_t len, size_t * __restrict lencopied)
 206             __nonnull(1) __nonnull(2);
 207 int     copyin(const void * __restrict udaddr, void * __restrict kaddr,
 208             size_t len) __nonnull(1) __nonnull(2);
 209 int     copyout(const void * __restrict kaddr, void * __restrict udaddr,
 210             size_t len) __nonnull(1) __nonnull(2);
 211
 212 int     fubyte(const void *base);
 213 long    fuword(const void *base);
 214 int     fuword16(void *base);
 215 int32_t fuword32(const void *base);
 216 int64_t fuword64(const void *base);
 217 int     subyte(void *base, int byte);
 218 int     suword(void *base, long word);
 219 int     suword16(void *base, int word);
 220 int     suword32(void *base, int32_t word);
 221 int     suword64(void *base, int64_t word);
 222 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
 223 u_long   casuword(volatile u_long *p, u_long oldval, u_long newval);
 224
 225 void    realitexpire(void *);
 226
 227 int     sysbeep(int hertz, int period);
 228
 229 void    hardclock(int usermode, uintfptr_t pc);
 230 void    hardclock_cpu(int usermode);
 231 void    softclock(void *);
 232 void    statclock(int usermode);
 233 void    profclock(int usermode, uintfptr_t pc);
 234
 235 void    startprofclock(struct proc *);
 236 void    stopprofclock(struct proc *);
 237 void    cpu_startprofclock(void);
 238 void    cpu_stopprofclock(void);
 239
 240 int     cr_cansee(struct ucred *u1, struct ucred *u2);
 241 int     cr_canseesocket(struct ucred *cred, struct socket *so);
 242 int     cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
 243
 244 char    *getenv(const char *name);
 245 void    freeenv(char *env);
 246 int     getenv_int(const char *name, int *data);
 247 int     getenv_uint(const char *name, unsigned int *data);
 248 int     getenv_long(const char *name, long *data);
 249 int     getenv_ulong(const char *name, unsigned long *data);
 250 int     getenv_string(const char *name, char *data, int size);
 251 int     getenv_quad(const char *name, quad_t *data);
 252 int     setenv(const char *name, const char *value);
 253 int     unsetenv(const char *name);
 254 int     testenv(const char *name);
 255
 256 typedef uint64_t (cpu_tick_f)(void);
 257 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
 258 extern cpu_tick_f *cpu_ticks;
 259 uint64_t cpu_tickrate(void);
 260 uint64_t cputick2usec(uint64_t tick);
 261
 262 #ifdef APM_FIXUP_CALLTODO
 263 struct timeval;
 264 void    adjust_timeout_calltodo(struct timeval *time_change);
 265 #endif /* APM_FIXUP_CALLTODO */
 266
 267 #include <sys/libkern.h>
 268
 269 /* Initialize the world */
 270 void    consinit(void);
 271 void    cpu_initclocks(void);
 272 void    usrinfoinit(void);
 273
 274 /* Finalize the world */
 275 void    shutdown_nice(int);
 276
 277 /* Timeouts */
 278 typedef void timeout_t(void *); /* timeout function type */
 279 #define CALLOUT_HANDLE_INITIALIZER(handle)      \
 280         { NULL }
 281
 282 void    callout_handle_init(struct callout_handle *);
 283 struct  callout_handle timeout(timeout_t *, void *, int);
 284 void    untimeout(timeout_t *, void *, struct callout_handle);
 285 caddr_t kern_timeout_callwheel_alloc(caddr_t v);
 286 void    kern_timeout_callwheel_init(void);
 287
 288 /* Stubs for obsolete functions that used to be for interrupt management */
 289 static __inline void            spl0(void)              { return; }
 290 static __inline intrmask_t      splbio(void)            { return 0; }
 291 static __inline intrmask_t      splcam(void)            { return 0; }
 292 static __inline intrmask_t      splclock(void)          { return 0; }
 293 static __inline intrmask_t      splhigh(void)           { return 0; }
 294 static __inline intrmask_t      splimp(void)            { return 0; }
 295 static __inline intrmask_t      splnet(void)            { return 0; }
 296 static __inline intrmask_t      splsoftcam(void)        { return 0; }
 297 static __inline intrmask_t      splsoftclock(void)      { return 0; }
 298 static __inline intrmask_t      splsofttty(void)        { return 0; }
 299 static __inline intrmask_t      splsoftvm(void)         { return 0; }
 300 static __inline intrmask_t      splsofttq(void)         { return 0; }
 301 static __inline intrmask_t      splstatclock(void)      { return 0; }
 302 static __inline intrmask_t      spltty(void)            { return 0; }
 303 static __inline intrmask_t      splvm(void)             { return 0; }
 304 static __inline void            splx(intrmask_t ipl __unused)   { return; }
 305
 306 /*
 307  * Common `proc' functions are declared here so that proc.h can be included
 308  * less often.
 309  */
 310 int     _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
 311             int timo) __nonnull(1);
 312 #define msleep(chan, mtx, pri, wmesg, timo)                             \
 313         _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (timo))
 314 int     msleep_spin(void *chan, struct mtx *mtx, const char *wmesg, int timo)
 315             __nonnull(1);
 316 int     pause(const char *wmesg, int timo);
 317 #define tsleep(chan, pri, wmesg, timo)                                  \
 318         _sleep((chan), NULL, (pri), (wmesg), (timo))
 319 void    wakeup(void *chan) __nonnull(1);
 320 void    wakeup_one(void *chan) __nonnull(1);
 321
 322 /*
 323  * Common `struct cdev *' stuff are declared here to avoid #include poisoning
 324  */
 325
 326 struct cdev;
 327 dev_t dev2udev(struct cdev *x);
 328 const char *devtoname(struct cdev *cdev);
 329
 330 int poll_no_poll(int events);
 331
 332 /* XXX: Should be void nanodelay(u_int nsec); */
 333 void    DELAY(int usec);
 334
 335 /* Root mount holdback API */
 336 struct root_hold_token;
 337
 338 struct root_hold_token *root_mount_hold(const char *identifier);
 339 void root_mount_rel(struct root_hold_token *h);
 340 void root_mount_wait(void);
 341 int root_mounted(void);
 342
 343
 344 /*
 345  * Unit number allocation API. (kern/subr_unit.c)
 346  */
 347 struct unrhdr;
 348 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
 349 void delete_unrhdr(struct unrhdr *uh);
 350 void clean_unrhdr(struct unrhdr *uh);
 351 void clean_unrhdrl(struct unrhdr *uh);
 352 int alloc_unr(struct unrhdr *uh);
 353 int alloc_unrl(struct unrhdr *uh);
 354 void free_unr(struct unrhdr *uh, u_int item);
 355
 356 /*
 357  * This is about as magic as it gets.  fortune(1) has got similar code
 358  * for reversing bits in a word.  Who thinks up this stuff??
 359  *
 360  * Yes, it does appear to be consistently faster than:
 361  * while (i = ffs(m)) {
 362  *      m >>= i;
 363  *      bits++;
 364  * }
 365  * and
 366  * while (lsb = (m & -m)) {     // This is magic too
 367  *      m &= ~lsb;              // or: m ^= lsb
 368  *      bits++;
 369  * }
 370  * Both of these latter forms do some very strange things on gcc-3.1 with
 371  * -mcpu=pentiumpro and/or -march=pentiumpro and/or -O or -O2.
 372  * There is probably an SSE or MMX popcnt instruction.
 373  *
 374  * I wonder if this should be in libkern?
 375  *
 376  * XXX Stop the presses!  Another one:
 377  * static __inline u_int32_t
 378  * popcnt1(u_int32_t v)
 379  * {
 380  *      v -= ((v >> 1) & 0x55555555);
 381  *      v = (v & 0x33333333) + ((v >> 2) & 0x33333333);
 382  *      v = (v + (v >> 4)) & 0x0F0F0F0F;
 383  *      return (v * 0x01010101) >> 24;
 384  * }
 385  * The downside is that it has a multiply.  With a pentium3 with
 386  * -mcpu=pentiumpro and -march=pentiumpro then gcc-3.1 will use
 387  * an imull, and in that case it is faster.  In most other cases
 388  * it appears slightly slower.
 389  *
 390  * Another variant (also from fortune):
 391  * #define BITCOUNT(x) (((BX_(x)+(BX_(x)>>4)) & 0x0F0F0F0F) % 255)
 392  * #define  BX_(x)     ((x) - (((x)>>1)&0x77777777)            \
 393  *                          - (((x)>>2)&0x33333333)            \
 394  *                          - (((x)>>3)&0x11111111))
 395  */
 396 static __inline uint32_t
 397 bitcount32(uint32_t x)
 398 {
 399
 400         x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
 401         x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
 402         x = (x + (x >> 4)) & 0x0f0f0f0f;
 403         x = (x + (x >> 8));
 404         x = (x + (x >> 16)) & 0x000000ff;
 405         return (x);
 406 }
 407
 408 #endif /* !_SYS_SYSTM_H_ */