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