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;           /* kern_reboot() has been called. */
  50 extern const char *panicstr;    /* panic message */
  51 extern char version[];          /* system version */
  52 extern char compiler_version[]; /* compiler version */
  53 extern char copyright[];        /* system copyright */
  54 extern int kstack_pages;        /* number of kernel stack pages */
  55
  56 extern u_long pagesizes[];      /* supported page sizes */
  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 extern int ngroups_max;         /* max # of supplemental groups */
  67 extern int vm_guest;            /* Running as virtual machine guest? */
  68
  69 /*
  70  * Detected virtual machine guest types. The intention is to expand
  71  * and/or add to the VM_GUEST_VM type if specific VM functionality is
  72  * ever implemented (e.g. vendor-specific paravirtualization features).
  73  */
  74 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN };
  75
  76 #ifdef  INVARIANTS              /* The option is always available */
  77 #define KASSERT(exp,msg) do {                                           \
  78         if (__predict_false(!(exp)))                                    \
  79                 panic msg;                                              \
  80 } while (0)
  81 #define VNASSERT(exp, vp, msg) do {                                     \
  82         if (__predict_false(!(exp))) {                                  \
  83                 vn_printf(vp, "VNASSERT failed\n");                     \
  84                 panic msg;                                              \
  85         }                                                               \
  86 } while (0)
  87 #else
  88 #define KASSERT(exp,msg) do { \
  89 } while (0)
  90
  91 #define VNASSERT(exp, vp, msg) do { \
  92 } while (0)
  93 #endif
  94
  95 #ifndef CTASSERT                /* Allow lint to override */
  96 #define CTASSERT(x)             _CTASSERT(x, __LINE__)
  97 #define _CTASSERT(x, y)         __CTASSERT(x, y)
  98 #define __CTASSERT(x, y)        typedef char __assert ## y[(x) ? 1 : -1]
  99 #endif
 100
 101 /*
 102  * Assert that a pointer can be loaded from memory atomically.
 103  *
 104  * This assertion enforces stronger alignment than necessary.  For example,
 105  * on some architectures, atomicity for unaligned loads will depend on
 106  * whether or not the load spans multiple cache lines.
 107  */
 108 #define ASSERT_ATOMIC_LOAD_PTR(var, msg)                                \
 109         KASSERT(sizeof(var) == sizeof(void *) &&                        \
 110             ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
 111
 112 /*
 113  * If we have already panic'd and this is the thread that called
 114  * panic(), then don't block on any mutexes but silently succeed.
 115  * Otherwise, the kernel will deadlock since the scheduler isn't
 116  * going to run the thread that holds any lock we need.
 117  */
 118 #define SCHEDULER_STOPPED() __predict_false(curthread->td_stopsched)
 119
 120 /*
 121  * XXX the hints declarations are even more misplaced than most declarations
 122  * in this file, since they are needed in one file (per arch) and only used
 123  * in two files.
 124  * XXX most of these variables should be const.
 125  */
 126 extern int osreldate;
 127 extern int envmode;
 128 extern int hintmode;            /* 0 = off. 1 = config, 2 = fallback */
 129 extern int dynamic_kenv;
 130 extern struct mtx kenv_lock;
 131 extern char *kern_envp;
 132 extern char static_env[];
 133 extern char static_hints[];     /* by config for now */
 134
 135 extern char **kenvp;
 136
 137 extern const void *zero_region; /* address space maps to a zeroed page  */
 138
 139 extern int unmapped_buf_allowed;
 140 extern int iosize_max_clamp;
 141 #define IOSIZE_MAX      (iosize_max_clamp ? INT_MAX : SSIZE_MAX)
 142
 143 /*
 144  * General function declarations.
 145  */
 146
 147 struct inpcb;
 148 struct lock_object;
 149 struct malloc_type;
 150 struct mtx;
 151 struct proc;
 152 struct socket;
 153 struct thread;
 154 struct tty;
 155 struct ucred;
 156 struct uio;
 157 struct _jmp_buf;
 158 struct trapframe;
 159
 160 int     setjmp(struct _jmp_buf *) __returns_twice;
 161 void    longjmp(struct _jmp_buf *, int) __dead2;
 162 int     dumpstatus(vm_offset_t addr, off_t count);
 163 int     nullop(void);
 164 int     eopnotsupp(void);
 165 int     ureadc(int, struct uio *);
 166 void    hashdestroy(void *, struct malloc_type *, u_long);
 167 void    *hashinit(int count, struct malloc_type *type, u_long *hashmask);
 168 void    *hashinit_flags(int count, struct malloc_type *type,
 169     u_long *hashmask, int flags);
 170 #define HASH_NOWAIT     0x00000001
 171 #define HASH_WAITOK     0x00000002
 172
 173 void    *phashinit(int count, struct malloc_type *type, u_long *nentries);
 174 void    g_waitidle(void);
 175
 176 void    panic(const char *, ...) __dead2 __printflike(1, 2);
 177
 178 void    cpu_boot(int);
 179 void    cpu_flush_dcache(void *, size_t);
 180 void    cpu_rootconf(void);
 181 void    critical_enter(void);
 182 void    critical_exit(void);
 183 void    init_param1(void);
 184 void    init_param2(long physpages);
 185 void    init_static_kenv(char *, size_t);
 186 void    tablefull(const char *);
 187 int     kvprintf(char const *, void (*)(int, void*), void *, int,
 188             __va_list) __printflike(1, 0);
 189 void    log(int, const char *, ...) __printflike(2, 3);
 190 void    log_console(struct uio *);
 191 int     printf(const char *, ...) __printflike(1, 2);
 192 int     snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
 193 int     sprintf(char *buf, const char *, ...) __printflike(2, 3);
 194 int     uprintf(const char *, ...) __printflike(1, 2);
 195 int     vprintf(const char *, __va_list) __printflike(1, 0);
 196 int     vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
 197 int     vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
 198 int     vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
 199 int     ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
 200 int     sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
 201 int     vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
 202 long    strtol(const char *, char **, int) __nonnull(1);
 203 u_long  strtoul(const char *, char **, int) __nonnull(1);
 204 quad_t  strtoq(const char *, char **, int) __nonnull(1);
 205 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
 206 void    tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
 207 void    hexdump(const void *ptr, int length, const char *hdr, int flags);
 208 #define HD_COLUMN_MASK  0xff
 209 #define HD_DELIM_MASK   0xff00
 210 #define HD_OMIT_COUNT   (1 << 16)
 211 #define HD_OMIT_HEX     (1 << 17)
 212 #define HD_OMIT_CHARS   (1 << 18)
 213
 214 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
 215 void    bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
 216 void    bzero(void *buf, size_t len) __nonnull(1);
 217
 218 void    *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
 219 void    *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
 220
 221 int     copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
 222             size_t len, size_t * __restrict lencopied)
 223             __nonnull(1) __nonnull(2);
 224 int     copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
 225             size_t len, size_t * __restrict lencopied)
 226             __nonnull(1) __nonnull(2);
 227 int     copyin(const void * __restrict udaddr, void * __restrict kaddr,
 228             size_t len) __nonnull(1) __nonnull(2);
 229 int     copyin_nofault(const void * __restrict udaddr, void * __restrict kaddr,
 230             size_t len) __nonnull(1) __nonnull(2);
 231 int     copyout(const void * __restrict kaddr, void * __restrict udaddr,
 232             size_t len) __nonnull(1) __nonnull(2);
 233 int     copyout_nofault(const void * __restrict kaddr, void * __restrict udaddr,
 234             size_t len) __nonnull(1) __nonnull(2);
 235
 236 int     fubyte(const void *base);
 237 long    fuword(const void *base);
 238 int     fuword16(void *base);
 239 int32_t fuword32(const void *base);
 240 int64_t fuword64(const void *base);
 241 int     subyte(void *base, int byte);
 242 int     suword(void *base, long word);
 243 int     suword16(void *base, int word);
 244 int     suword32(void *base, int32_t word);
 245 int     suword64(void *base, int64_t word);
 246 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
 247 u_long   casuword(volatile u_long *p, u_long oldval, u_long newval);
 248
 249 void    realitexpire(void *);
 250
 251 int     sysbeep(int hertz, int period);
 252
 253 void    hardclock(int usermode, uintfptr_t pc);
 254 void    hardclock_cnt(int cnt, int usermode);
 255 void    hardclock_cpu(int usermode);
 256 void    hardclock_sync(int cpu);
 257 void    softclock(void *);
 258 void    statclock(int usermode);
 259 void    statclock_cnt(int cnt, int usermode);
 260 void    profclock(int usermode, uintfptr_t pc);
 261 void    profclock_cnt(int cnt, int usermode, uintfptr_t pc);
 262
 263 int     hardclockintr(void);
 264
 265 void    startprofclock(struct proc *);
 266 void    stopprofclock(struct proc *);
 267 void    cpu_startprofclock(void);
 268 void    cpu_stopprofclock(void);
 269 void    cpu_idleclock(void);
 270 void    cpu_activeclock(void);
 271 extern int      cpu_can_deep_sleep;
 272 extern int      cpu_disable_deep_sleep;
 273
 274 int     cr_cansee(struct ucred *u1, struct ucred *u2);
 275 int     cr_canseesocket(struct ucred *cred, struct socket *so);
 276 int     cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
 277
 278 char    *getenv(const char *name);
 279 void    freeenv(char *env);
 280 int     getenv_int(const char *name, int *data);
 281 int     getenv_uint(const char *name, unsigned int *data);
 282 int     getenv_long(const char *name, long *data);
 283 int     getenv_ulong(const char *name, unsigned long *data);
 284 int     getenv_string(const char *name, char *data, int size);
 285 int     getenv_quad(const char *name, quad_t *data);
 286 int     setenv(const char *name, const char *value);
 287 int     unsetenv(const char *name);
 288 int     testenv(const char *name);
 289
 290 typedef uint64_t (cpu_tick_f)(void);
 291 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
 292 extern cpu_tick_f *cpu_ticks;
 293 uint64_t cpu_tickrate(void);
 294 uint64_t cputick2usec(uint64_t tick);
 295
 296 #ifdef APM_FIXUP_CALLTODO
 297 struct timeval;
 298 void    adjust_timeout_calltodo(struct timeval *time_change);
 299 #endif /* APM_FIXUP_CALLTODO */
 300
 301 #include <sys/libkern.h>
 302
 303 /* Initialize the world */
 304 void    consinit(void);
 305 void    cpu_initclocks(void);
 306 void    cpu_initclocks_bsp(void);
 307 void    cpu_initclocks_ap(void);
 308 void    usrinfoinit(void);
 309
 310 /* Finalize the world */
 311 void    kern_reboot(int) __dead2;
 312 void    shutdown_nice(int);
 313
 314 /* Timeouts */
 315 typedef void timeout_t(void *); /* timeout function type */
 316 #define CALLOUT_HANDLE_INITIALIZER(handle)      \
 317         { NULL }
 318
 319 void    callout_handle_init(struct callout_handle *);
 320 struct  callout_handle timeout(timeout_t *, void *, int);
 321 void    untimeout(timeout_t *, void *, struct callout_handle);
 322 caddr_t kern_timeout_callwheel_alloc(caddr_t v);
 323 void    kern_timeout_callwheel_init(void);
 324
 325 /* Stubs for obsolete functions that used to be for interrupt management */
 326 static __inline void            spl0(void)              { return; }
 327 static __inline intrmask_t      splbio(void)            { return 0; }
 328 static __inline intrmask_t      splcam(void)            { return 0; }
 329 static __inline intrmask_t      splclock(void)          { return 0; }
 330 static __inline intrmask_t      splhigh(void)           { return 0; }
 331 static __inline intrmask_t      splimp(void)            { return 0; }
 332 static __inline intrmask_t      splnet(void)            { return 0; }
 333 static __inline intrmask_t      splsoftcam(void)        { return 0; }
 334 static __inline intrmask_t      splsoftclock(void)      { return 0; }
 335 static __inline intrmask_t      splsofttty(void)        { return 0; }
 336 static __inline intrmask_t      splsoftvm(void)         { return 0; }
 337 static __inline intrmask_t      splsofttq(void)         { return 0; }
 338 static __inline intrmask_t      splstatclock(void)      { return 0; }
 339 static __inline intrmask_t      spltty(void)            { return 0; }
 340 static __inline intrmask_t      splvm(void)             { return 0; }
 341 static __inline void            splx(intrmask_t ipl __unused)   { return; }
 342
 343 /*
 344  * Common `proc' functions are declared here so that proc.h can be included
 345  * less often.
 346  */
 347 int     _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
 348             int timo) __nonnull(1);
 349 #define msleep(chan, mtx, pri, wmesg, timo)                             \
 350         _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (timo))
 351 int     msleep_spin(void *chan, struct mtx *mtx, const char *wmesg, int timo)
 352             __nonnull(1);
 353 int     pause(const char *wmesg, int timo);
 354 #define tsleep(chan, pri, wmesg, timo)                                  \
 355         _sleep((chan), NULL, (pri), (wmesg), (timo))
 356 void    wakeup(void *chan) __nonnull(1);
 357 void    wakeup_one(void *chan) __nonnull(1);
 358
 359 /*
 360  * Common `struct cdev *' stuff are declared here to avoid #include poisoning
 361  */
 362
 363 struct cdev;
 364 dev_t dev2udev(struct cdev *x);
 365 const char *devtoname(struct cdev *cdev);
 366
 367 int poll_no_poll(int events);
 368
 369 /* XXX: Should be void nanodelay(u_int nsec); */
 370 void    DELAY(int usec);
 371
 372 /* Root mount holdback API */
 373 struct root_hold_token;
 374
 375 struct root_hold_token *root_mount_hold(const char *identifier);
 376 void root_mount_rel(struct root_hold_token *h);
 377 void root_mount_wait(void);
 378 int root_mounted(void);
 379
 380
 381 /*
 382  * Unit number allocation API. (kern/subr_unit.c)
 383  */
 384 struct unrhdr;
 385 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
 386 void delete_unrhdr(struct unrhdr *uh);
 387 void clean_unrhdr(struct unrhdr *uh);
 388 void clean_unrhdrl(struct unrhdr *uh);
 389 int alloc_unr(struct unrhdr *uh);
 390 int alloc_unr_specific(struct unrhdr *uh, u_int item);
 391 int alloc_unrl(struct unrhdr *uh);
 392 void free_unr(struct unrhdr *uh, u_int item);
 393
 394 /*
 395  * Population count algorithm using SWAR approach
 396  * - "SIMD Within A Register".
 397  */
 398 static __inline uint32_t
 399 bitcount32(uint32_t x)
 400 {
 401
 402         x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
 403         x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
 404         x = (x + (x >> 4)) & 0x0f0f0f0f;
 405         x = (x + (x >> 8));
 406         x = (x + (x >> 16)) & 0x000000ff;
 407         return (x);
 408 }
 409
 410 static __inline uint16_t
 411 bitcount16(uint32_t x)
 412 {
 413
 414         x = (x & 0x5555) + ((x & 0xaaaa) >> 1);
 415         x = (x & 0x3333) + ((x & 0xcccc) >> 2);
 416         x = (x + (x >> 4)) & 0x0f0f;
 417         x = (x + (x >> 8)) & 0x00ff;
 418         return (x);
 419 }
 420
 421 #endif /* !_SYS_SYSTM_H_ */