sys/sys/systm.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1988, 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  */
  36
  37 #ifndef _SYS_SYSTM_H_
  38 #define _SYS_SYSTM_H_
  39
  40 #include <sys/types.h>
  41 #include <sys/callout.h>
  42 #include <sys/kassert.h>
  43 #include <sys/queue.h>
  44 #include <sys/stdint.h>         /* for people using printf mainly */
  45 #include <machine/atomic.h>
  46 #include <machine/cpufunc.h>
  47
  48 __NULLABILITY_PRAGMA_PUSH
  49
  50 #ifdef _KERNEL
  51 extern int cold;                /* nonzero if we are doing a cold boot */
  52 extern int suspend_blocked;     /* block suspend due to pending shutdown */
  53 extern int rebooting;           /* kern_reboot() has been called. */
  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 extern u_long maxphys;          /* max raw I/O transfer size */
  73
  74 /*
  75  * Detected virtual machine guest types. The intention is to expand
  76  * and/or add to the VM_GUEST_VM type if specific VM functionality is
  77  * ever implemented (e.g. vendor-specific paravirtualization features).
  78  * Keep in sync with vm_guest_sysctl_names[].
  79  */
  80 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN, VM_GUEST_HV,
  81                 VM_GUEST_VMWARE, VM_GUEST_KVM, VM_GUEST_BHYVE, VM_GUEST_VBOX,
  82                 VM_GUEST_PARALLELS, VM_LAST };
  83
  84 #endif /* KERNEL */
  85
  86 /*
  87  * Align variables.
  88  */
  89 #define __read_mostly           __section(".data.read_mostly")
  90 #define __read_frequently       __section(".data.read_frequently")
  91 #define __exclusive_cache_line  __aligned(CACHE_LINE_SIZE) \
  92                                     __section(".data.exclusive_cache_line")
  93 #if defined(_STANDALONE)
  94 struct ucred;
  95 #endif
  96
  97 #ifdef _KERNEL
  98 #include <sys/param.h>          /* MAXCPU */
  99 #include <sys/pcpu.h>           /* curthread */
 100 #include <sys/kpilite.h>
 101
 102 extern int osreldate;
 103
 104 extern const void *zero_region; /* address space maps to a zeroed page  */
 105
 106 extern int unmapped_buf_allowed;
 107
 108 #ifdef __LP64__
 109 #define IOSIZE_MAX              iosize_max()
 110 #define DEVFS_IOSIZE_MAX        devfs_iosize_max()
 111 #else
 112 #define IOSIZE_MAX              SSIZE_MAX
 113 #define DEVFS_IOSIZE_MAX        SSIZE_MAX
 114 #endif
 115
 116 /*
 117  * General function declarations.
 118  */
 119
 120 struct inpcb;
 121 struct lock_object;
 122 struct malloc_type;
 123 struct mtx;
 124 struct proc;
 125 struct socket;
 126 struct thread;
 127 struct tty;
 128 struct ucred;
 129 struct uio;
 130 struct _jmp_buf;
 131 struct trapframe;
 132 struct eventtimer;
 133
 134 int     setjmp(struct _jmp_buf *) __returns_twice;
 135 void    longjmp(struct _jmp_buf *, int) __dead2;
 136 int     dumpstatus(vm_offset_t addr, off_t count);
 137 int     nullop(void);
 138 int     eopnotsupp(void);
 139 int     ureadc(int, struct uio *);
 140 void    hashdestroy(void *, struct malloc_type *, u_long);
 141 void    *hashinit(int count, struct malloc_type *type, u_long *hashmask);
 142 void    *hashinit_flags(int count, struct malloc_type *type,
 143     u_long *hashmask, int flags);
 144 #define HASH_NOWAIT     0x00000001
 145 #define HASH_WAITOK     0x00000002
 146
 147 void    *phashinit(int count, struct malloc_type *type, u_long *nentries);
 148 void    *phashinit_flags(int count, struct malloc_type *type, u_long *nentries,
 149     int flags);
 150
 151 void    cpu_flush_dcache(void *, size_t);
 152 void    cpu_rootconf(void);
 153 void    critical_enter_KBI(void);
 154 void    critical_exit_KBI(void);
 155 void    critical_exit_preempt(void);
 156 void    init_param1(void);
 157 void    init_param2(long physpages);
 158 void    init_static_kenv(char *, size_t);
 159 void    tablefull(const char *);
 160
 161 /*
 162  * Allocate per-thread "current" state in the linuxkpi
 163  */
 164 extern int (*lkpi_alloc_current)(struct thread *, int);
 165 int linux_alloc_current_noop(struct thread *, int);
 166
 167 #if (defined(KLD_MODULE) && !defined(KLD_TIED)) || defined(KTR_CRITICAL) || !defined(_KERNEL) || defined(GENOFFSET)
 168 #define critical_enter() critical_enter_KBI()
 169 #define critical_exit() critical_exit_KBI()
 170 #else
 171 static __inline void
 172 critical_enter(void)
 173 {
 174         struct thread_lite *td;
 175
 176         td = (struct thread_lite *)curthread;
 177         td->td_critnest++;
 178         atomic_interrupt_fence();
 179 }
 180
 181 static __inline void
 182 critical_exit(void)
 183 {
 184         struct thread_lite *td;
 185
 186         td = (struct thread_lite *)curthread;
 187         KASSERT(td->td_critnest != 0,
 188             ("critical_exit: td_critnest == 0"));
 189         atomic_interrupt_fence();
 190         td->td_critnest--;
 191         atomic_interrupt_fence();
 192         if (__predict_false(td->td_owepreempt))
 193                 critical_exit_preempt();
 194
 195 }
 196 #endif
 197
 198 #ifdef  EARLY_PRINTF
 199 typedef void early_putc_t(int ch);
 200 extern early_putc_t *early_putc;
 201 #endif
 202 int     kvprintf(char const *, void (*)(int, void*), void *, int,
 203             __va_list) __printflike(1, 0);
 204 void    log(int, const char *, ...) __printflike(2, 3);
 205 void    log_console(struct uio *);
 206 void    vlog(int, const char *, __va_list) __printflike(2, 0);
 207 int     asprintf(char **ret, struct malloc_type *mtp, const char *format,
 208             ...) __printflike(3, 4);
 209 int     printf(const char *, ...) __printflike(1, 2);
 210 int     snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
 211 int     sprintf(char *buf, const char *, ...) __printflike(2, 3);
 212 int     uprintf(const char *, ...) __printflike(1, 2);
 213 int     vprintf(const char *, __va_list) __printflike(1, 0);
 214 int     vasprintf(char **ret, struct malloc_type *mtp, const char *format,
 215             __va_list ap) __printflike(3, 0);
 216 int     vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
 217 int     vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
 218 int     vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
 219 int     sscanf(const char *, char const * _Nonnull, ...) __scanflike(2, 3);
 220 int     vsscanf(const char * _Nonnull, char const * _Nonnull, __va_list)  __scanflike(2, 0);
 221 long    strtol(const char *, char **, int);
 222 u_long  strtoul(const char *, char **, int);
 223 quad_t  strtoq(const char *, char **, int);
 224 u_quad_t strtouq(const char *, char **, int);
 225 void    tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
 226 void    vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
 227 void    hexdump(const void *ptr, int length, const char *hdr, int flags);
 228 #define HD_COLUMN_MASK  0xff
 229 #define HD_DELIM_MASK   0xff00
 230 #define HD_OMIT_COUNT   (1 << 16)
 231 #define HD_OMIT_HEX     (1 << 17)
 232 #define HD_OMIT_CHARS   (1 << 18)
 233
 234 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
 235 void    explicit_bzero(void * _Nonnull, size_t);
 236
 237 void    *memset(void * _Nonnull buf, int c, size_t len);
 238 void    *memcpy(void * _Nonnull to, const void * _Nonnull from, size_t len);
 239 void    *memmove(void * _Nonnull dest, const void * _Nonnull src, size_t n);
 240 int     memcmp(const void *b1, const void *b2, size_t len);
 241
 242 #ifdef SAN_NEEDS_INTERCEPTORS
 243 #define SAN_INTERCEPTOR(func)   \
 244         __CONCAT(SAN_INTERCEPTOR_PREFIX, __CONCAT(_, func))
 245 void    *SAN_INTERCEPTOR(memset)(void *, int, size_t);
 246 void    *SAN_INTERCEPTOR(memcpy)(void *, const void *, size_t);
 247 void    *SAN_INTERCEPTOR(memmove)(void *, const void *, size_t);
 248 int     SAN_INTERCEPTOR(memcmp)(const void *, const void *, size_t);
 249 #ifndef SAN_RUNTIME
 250 #define bcopy(from, to, len)    SAN_INTERCEPTOR(memmove)((to), (from), (len))
 251 #define bzero(buf, len)         SAN_INTERCEPTOR(memset)((buf), 0, (len))
 252 #define bcmp(b1, b2, len)       SAN_INTERCEPTOR(memcmp)((b1), (b2), (len))
 253 #define memset(buf, c, len)     SAN_INTERCEPTOR(memset)((buf), (c), (len))
 254 #define memcpy(to, from, len)   SAN_INTERCEPTOR(memcpy)((to), (from), (len))
 255 #define memmove(dest, src, n)   SAN_INTERCEPTOR(memmove)((dest), (src), (n))
 256 #define memcmp(b1, b2, len)     SAN_INTERCEPTOR(memcmp)((b1), (b2), (len))
 257 #endif /* !SAN_RUNTIME */
 258 #else /* !SAN_NEEDS_INTERCEPTORS */
 259 #define bcopy(from, to, len)    __builtin_memmove((to), (from), (len))
 260 #define bzero(buf, len)         __builtin_memset((buf), 0, (len))
 261 #define bcmp(b1, b2, len)       __builtin_memcmp((b1), (b2), (len))
 262 #define memset(buf, c, len)     __builtin_memset((buf), (c), (len))
 263 #define memcpy(to, from, len)   __builtin_memcpy((to), (from), (len))
 264 #define memmove(dest, src, n)   __builtin_memmove((dest), (src), (n))
 265 #define memcmp(b1, b2, len)     __builtin_memcmp((b1), (b2), (len))
 266 #endif /* SAN_NEEDS_INTERCEPTORS */
 267
 268 void    *memset_early(void * _Nonnull buf, int c, size_t len);
 269 #define bzero_early(buf, len) memset_early((buf), 0, (len))
 270 void    *memcpy_early(void * _Nonnull to, const void * _Nonnull from, size_t len);
 271 void    *memmove_early(void * _Nonnull dest, const void * _Nonnull src, size_t n);
 272 #define bcopy_early(from, to, len) memmove_early((to), (from), (len))
 273
 274 #define copystr(src, dst, len, outlen)  ({                      \
 275         size_t __r, __len, *__outlen;                           \
 276                                                                 \
 277         __len = (len);                                          \
 278         __outlen = (outlen);                                    \
 279         __r = strlcpy((dst), (src), __len);                     \
 280         if (__outlen != NULL)                                   \
 281                 *__outlen = ((__r >= __len) ? __len : __r + 1); \
 282         ((__r >= __len) ? ENAMETOOLONG : 0);                    \
 283 })
 284
 285 int __result_use_check copyinstr(const void * __restrict udaddr,
 286     void * _Nonnull __restrict kaddr, size_t len,
 287     size_t * __restrict lencopied);
 288 int __result_use_check copyin(const void * __restrict udaddr,
 289     void * _Nonnull __restrict kaddr, size_t len);
 290 int __result_use_check copyin_nofault(const void * __restrict udaddr,
 291     void * _Nonnull __restrict kaddr, size_t len);
 292 int __result_use_check copyout(const void * _Nonnull __restrict kaddr,
 293     void * __restrict udaddr, size_t len);
 294 int __result_use_check copyout_nofault(const void * _Nonnull __restrict kaddr,
 295     void * __restrict udaddr, size_t len);
 296
 297 #ifdef SAN_NEEDS_INTERCEPTORS
 298 int     SAN_INTERCEPTOR(copyin)(const void *, void *, size_t);
 299 int     SAN_INTERCEPTOR(copyinstr)(const void *, void *, size_t, size_t *);
 300 int     SAN_INTERCEPTOR(copyout)(const void *, void *, size_t);
 301 #ifndef SAN_RUNTIME
 302 #define copyin(u, k, l)         SAN_INTERCEPTOR(copyin)((u), (k), (l))
 303 #define copyinstr(u, k, l, lc)  SAN_INTERCEPTOR(copyinstr)((u), (k), (l), (lc))
 304 #define copyout(k, u, l)        SAN_INTERCEPTOR(copyout)((k), (u), (l))
 305 #endif /* !SAN_RUNTIME */
 306 #endif /* SAN_NEEDS_INTERCEPTORS */
 307
 308 int     fubyte(volatile const void *base);
 309 long    fuword(volatile const void *base);
 310 int     fuword16(volatile const void *base);
 311 int32_t fuword32(volatile const void *base);
 312 int64_t fuword64(volatile const void *base);
 313 int __result_use_check fueword(volatile const void *base, long *val);
 314 int __result_use_check fueword32(volatile const void *base, int32_t *val);
 315 int __result_use_check fueword64(volatile const void *base, int64_t *val);
 316 int __result_use_check subyte(volatile void *base, int byte);
 317 int __result_use_check suword(volatile void *base, long word);
 318 int __result_use_check suword16(volatile void *base, int word);
 319 int __result_use_check suword32(volatile void *base, int32_t word);
 320 int __result_use_check suword64(volatile void *base, int64_t word);
 321 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
 322 u_long  casuword(volatile u_long *p, u_long oldval, u_long newval);
 323 int     casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp,
 324             uint32_t newval);
 325 int     casueword(volatile u_long *p, u_long oldval, u_long *oldvalp,
 326             u_long newval);
 327
 328 #if defined(SAN_NEEDS_INTERCEPTORS) && !defined(KCSAN)
 329 int     SAN_INTERCEPTOR(fubyte)(volatile const void *base);
 330 int     SAN_INTERCEPTOR(fuword16)(volatile const void *base);
 331 int     SAN_INTERCEPTOR(fueword)(volatile const void *base, long *val);
 332 int     SAN_INTERCEPTOR(fueword32)(volatile const void *base, int32_t *val);
 333 int     SAN_INTERCEPTOR(fueword64)(volatile const void *base, int64_t *val);
 334 int     SAN_INTERCEPTOR(subyte)(volatile void *base, int byte);
 335 int     SAN_INTERCEPTOR(suword)(volatile void *base, long word);
 336 int     SAN_INTERCEPTOR(suword16)(volatile void *base, int word);
 337 int     SAN_INTERCEPTOR(suword32)(volatile void *base, int32_t word);
 338 int     SAN_INTERCEPTOR(suword64)(volatile void *base, int64_t word);
 339 int     SAN_INTERCEPTOR(casueword32)(volatile uint32_t *base, uint32_t oldval,
 340             uint32_t *oldvalp, uint32_t newval);
 341 int     SAN_INTERCEPTOR(casueword)(volatile u_long *p, u_long oldval,
 342             u_long *oldvalp, u_long newval);
 343 #ifndef SAN_RUNTIME
 344 #define fubyte(b)               SAN_INTERCEPTOR(fubyte)((b))
 345 #define fuword16(b)             SAN_INTERCEPTOR(fuword16)((b))
 346 #define fueword(b, v)           SAN_INTERCEPTOR(fueword)((b), (v))
 347 #define fueword32(b, v)         SAN_INTERCEPTOR(fueword32)((b), (v))
 348 #define fueword64(b, v)         SAN_INTERCEPTOR(fueword64)((b), (v))
 349 #define subyte(b, w)            SAN_INTERCEPTOR(subyte)((b), (w))
 350 #define suword(b, w)            SAN_INTERCEPTOR(suword)((b), (w))
 351 #define suword16(b, w)          SAN_INTERCEPTOR(suword16)((b), (w))
 352 #define suword32(b, w)          SAN_INTERCEPTOR(suword32)((b), (w))
 353 #define suword64(b, w)          SAN_INTERCEPTOR(suword64)((b), (w))
 354 #define casueword32(b, o, p, n) SAN_INTERCEPTOR(casueword32)((b), (o), (p), (n))
 355 #define casueword(b, o, p, n)   SAN_INTERCEPTOR(casueword)((b), (o), (p), (n))
 356 #endif /* !SAN_RUNTIME */
 357 #endif /* SAN_NEEDS_INTERCEPTORS && !KCSAN */
 358
 359 int     sysbeep(int hertz, sbintime_t duration);
 360
 361 void    hardclock(int cnt, int usermode);
 362 void    hardclock_sync(int cpu);
 363 void    statclock(int cnt, int usermode);
 364 void    profclock(int cnt, int usermode, uintfptr_t pc);
 365
 366 int     hardclockintr(void);
 367
 368 void    startprofclock(struct proc *);
 369 void    stopprofclock(struct proc *);
 370 void    cpu_startprofclock(void);
 371 void    cpu_stopprofclock(void);
 372 void    suspendclock(void);
 373 void    resumeclock(void);
 374 sbintime_t      cpu_idleclock(void);
 375 void    cpu_activeclock(void);
 376 void    cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
 377 void    cpu_et_frequency(struct eventtimer *et, uint64_t newfreq);
 378 extern int      cpu_disable_c2_sleep;
 379 extern int      cpu_disable_c3_sleep;
 380
 381 extern void     (*tcp_hpts_softclock)(void);
 382 #define tcp_hpts_softclock()    do {                                    \
 383                 if (tcp_hpts_softclock != NULL)                         \
 384                         tcp_hpts_softclock();                           \
 385 } while (0)
 386
 387 char    *kern_getenv(const char *name);
 388 void    freeenv(char *env);
 389 int     getenv_int(const char *name, int *data);
 390 int     getenv_uint(const char *name, unsigned int *data);
 391 int     getenv_long(const char *name, long *data);
 392 int     getenv_ulong(const char *name, unsigned long *data);
 393 int     getenv_string(const char *name, char *data, int size);
 394 int     getenv_int64(const char *name, int64_t *data);
 395 int     getenv_uint64(const char *name, uint64_t *data);
 396 int     getenv_quad(const char *name, quad_t *data);
 397 int     getenv_bool(const char *name, bool *data);
 398 bool    getenv_is_true(const char *name);
 399 bool    getenv_is_false(const char *name);
 400 int     kern_setenv(const char *name, const char *value);
 401 int     kern_unsetenv(const char *name);
 402 int     testenv(const char *name);
 403
 404 int     getenv_array(const char *name, void *data, int size, int *psize,
 405     int type_size, bool allow_signed);
 406 #define GETENV_UNSIGNED false   /* negative numbers not allowed */
 407 #define GETENV_SIGNED   true    /* negative numbers allowed */
 408
 409 typedef uint64_t (cpu_tick_f)(void);
 410 void set_cputicker(cpu_tick_f *func, uint64_t freq, bool isvariable);
 411 extern cpu_tick_f *cpu_ticks;
 412 uint64_t cpu_tickrate(void);
 413 uint64_t cputick2usec(uint64_t tick);
 414
 415 #include <sys/libkern.h>
 416
 417 /* Initialize the world */
 418 void    consinit(void);
 419 void    cpu_initclocks(void);
 420 void    cpu_initclocks_bsp(void);
 421 void    cpu_initclocks_ap(void);
 422 void    usrinfoinit(void);
 423
 424 /* Finalize the world */
 425 void    kern_reboot(int) __dead2;
 426 void    shutdown_nice(int);
 427
 428 /* Stubs for obsolete functions that used to be for interrupt management */
 429 static __inline intrmask_t      splhigh(void)           { return 0; }
 430 static __inline intrmask_t      splimp(void)            { return 0; }
 431 static __inline intrmask_t      splnet(void)            { return 0; }
 432 static __inline intrmask_t      spltty(void)            { return 0; }
 433 static __inline void            splx(intrmask_t ipl __unused)   { return; }
 434
 435 /*
 436  * Common `proc' functions are declared here so that proc.h can be included
 437  * less often.
 438  */
 439 int     _sleep(const void * _Nonnull chan, struct lock_object *lock, int pri,
 440            const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
 441 #define msleep(chan, mtx, pri, wmesg, timo)                             \
 442         _sleep((chan), &(mtx)->lock_object, (pri), (wmesg),             \
 443             tick_sbt * (timo), 0, C_HARDCLOCK)
 444 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags)                \
 445         _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
 446             (flags))
 447 int     msleep_spin_sbt(const void * _Nonnull chan, struct mtx *mtx,
 448             const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
 449 #define msleep_spin(chan, mtx, wmesg, timo)                             \
 450         msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo),      \
 451             0, C_HARDCLOCK)
 452 int     pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
 453             int flags);
 454 static __inline int
 455 pause(const char *wmesg, int timo)
 456 {
 457         return (pause_sbt(wmesg, tick_sbt * timo, 0, C_HARDCLOCK));
 458 }
 459 #define pause_sig(wmesg, timo)                                          \
 460         pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK | C_CATCH)
 461 #define tsleep(chan, pri, wmesg, timo)                                  \
 462         _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo),         \
 463             0, C_HARDCLOCK)
 464 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags)                     \
 465         _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
 466 void    wakeup(const void *chan);
 467 void    wakeup_one(const void *chan);
 468 void    wakeup_any(const void *chan);
 469
 470 /*
 471  * Common `struct cdev *' stuff are declared here to avoid #include poisoning
 472  */
 473
 474 struct cdev;
 475 dev_t dev2udev(struct cdev *x);
 476 const char *devtoname(struct cdev *cdev);
 477
 478 #ifdef __LP64__
 479 size_t  devfs_iosize_max(void);
 480 size_t  iosize_max(void);
 481 #endif
 482
 483 int poll_no_poll(int events);
 484
 485 /* XXX: Should be void nanodelay(u_int nsec); */
 486 void    DELAY(int usec);
 487
 488 /* Root mount holdback API */
 489 struct root_hold_token {
 490         int                             flags;
 491         const char                      *who;
 492         TAILQ_ENTRY(root_hold_token)    list;
 493 };
 494
 495 struct root_hold_token *root_mount_hold(const char *identifier);
 496 void root_mount_hold_token(const char *identifier, struct root_hold_token *h);
 497 void root_mount_rel(struct root_hold_token *h);
 498 int root_mounted(void);
 499
 500 /*
 501  * Unit number allocation API. (kern/subr_unit.c)
 502  */
 503 struct unrhdr;
 504 #define UNR_NO_MTX      ((void *)(uintptr_t)-1)
 505 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
 506 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
 507 void delete_unrhdr(struct unrhdr *uh);
 508 void clear_unrhdr(struct unrhdr *uh);
 509 void clean_unrhdr(struct unrhdr *uh);
 510 void clean_unrhdrl(struct unrhdr *uh);
 511 int alloc_unr(struct unrhdr *uh);
 512 int alloc_unr_specific(struct unrhdr *uh, u_int item);
 513 int alloc_unrl(struct unrhdr *uh);
 514 void free_unr(struct unrhdr *uh, u_int item);
 515 void *create_iter_unr(struct unrhdr *uh);
 516 int next_iter_unr(void *handle);
 517 void free_iter_unr(void *handle);
 518
 519 struct unrhdr64 {
 520         uint64_t        counter;
 521 };
 522
 523 static __inline void
 524 new_unrhdr64(struct unrhdr64 *unr64, uint64_t low)
 525 {
 526
 527         unr64->counter = low;
 528 }
 529
 530 static __inline uint64_t
 531 alloc_unr64(struct unrhdr64 *unr64)
 532 {
 533
 534         return (atomic_fetchadd_64(&unr64->counter, 1));
 535 }
 536
 537 void    intr_prof_stack_use(struct thread *td, struct trapframe *frame);
 538
 539 void counted_warning(unsigned *counter, const char *msg);
 540
 541 /*
 542  * APIs to manage deprecation and obsolescence.
 543  */
 544 void _gone_in(int major, const char *msg);
 545 void _gone_in_dev(device_t dev, int major, const char *msg);
 546 #ifdef NO_OBSOLETE_CODE
 547 #define __gone_ok(m, msg)                                        \
 548         _Static_assert(m < P_OSREL_MAJOR(__FreeBSD_version)),    \
 549             "Obsolete code: " msg);
 550 #else
 551 #define __gone_ok(m, msg)
 552 #endif
 553 #define gone_in(major, msg)             __gone_ok(major, msg) _gone_in(major, msg)
 554 #define gone_in_dev(dev, major, msg)    __gone_ok(major, msg) _gone_in_dev(dev, major, msg)
 555
 556 #ifdef INVARIANTS
 557 #define __diagused
 558 #else
 559 #define __diagused      __unused
 560 #endif
 561
 562 #ifdef WITNESS
 563 #define __witness_used
 564 #else
 565 #define __witness_used  __unused
 566 #endif
 567
 568 #endif /* _KERNEL */
 569
 570 __NULLABILITY_PRAGMA_POP
 571 #endif /* !_SYS_SYSTM_H_ */