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