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