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  *      @(#)systm.h     8.7 (Berkeley) 3/29/95
  37  * $FreeBSD$
  38  */
  39
  40 #ifndef _SYS_SYSTM_H_
  41 #define _SYS_SYSTM_H_
  42
  43 #include <sys/cdefs.h>
  44 #include <machine/atomic.h>
  45 #include <machine/cpufunc.h>
  46 #include <sys/callout.h>
  47 #include <sys/queue.h>
  48 #include <sys/stdint.h>         /* for people using printf mainly */
  49
  50 __NULLABILITY_PRAGMA_PUSH
  51
  52 #ifdef _KERNEL
  53 extern int cold;                /* nonzero if we are doing a cold boot */
  54 extern int suspend_blocked;     /* block suspend due to pending shutdown */
  55 extern int rebooting;           /* kern_reboot() has been called. */
  56 extern const char *panicstr;    /* panic message */
  57 extern bool panicked;
  58 #define KERNEL_PANICKED()       __predict_false(panicked)
  59 extern char version[];          /* system version */
  60 extern char compiler_version[]; /* compiler version */
  61 extern char copyright[];        /* system copyright */
  62 extern int kstack_pages;        /* number of kernel stack pages */
  63
  64 extern u_long pagesizes[];      /* supported page sizes */
  65 extern long physmem;            /* physical memory */
  66 extern long realmem;            /* 'real' memory */
  67
  68 extern char *rootdevnames[2];   /* names of possible root devices */
  69
  70 extern int boothowto;           /* reboot flags, from console subsystem */
  71 extern int bootverbose;         /* nonzero to print verbose messages */
  72
  73 extern int maxusers;            /* system tune hint */
  74 extern int ngroups_max;         /* max # of supplemental groups */
  75 extern int vm_guest;            /* Running as virtual machine guest? */
  76
  77 /*
  78  * Detected virtual machine guest types. The intention is to expand
  79  * and/or add to the VM_GUEST_VM type if specific VM functionality is
  80  * ever implemented (e.g. vendor-specific paravirtualization features).
  81  * Keep in sync with vm_guest_sysctl_names[].
  82  */
  83 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN, VM_GUEST_HV,
  84                 VM_GUEST_VMWARE, VM_GUEST_KVM, VM_GUEST_BHYVE, VM_GUEST_VBOX,
  85                 VM_GUEST_PARALLELS, VM_LAST };
  86
  87 #ifdef  INVARIANTS              /* The option is always available */
  88 #define VNASSERT(exp, vp, msg) do {                                     \
  89         if (__predict_false(!(exp))) {                                  \
  90                 vn_printf(vp, "VNASSERT failed: %s not true at %s:%d (%s)\n",\
  91                    #exp, __FILE__, __LINE__, __func__);                 \
  92                 kassert_panic msg;                                      \
  93         }                                                               \
  94 } while (0)
  95 #define VNPASS(exp, vp) do {                                            \
  96         const char *_exp = #exp;                                        \
  97         VNASSERT(exp, vp, ("condition %s not met at %s:%d (%s)",        \
  98             _exp, __FILE__, __LINE__, __func__));                       \
  99 } while (0)
 100 #define __assert_unreachable() \
 101         panic("executing segment marked as unreachable at %s:%d (%s)\n", \
 102             __FILE__, __LINE__, __func__)
 103 #else
 104 #define VNASSERT(exp, vp, msg) do { \
 105 } while (0)
 106 #define VNPASS(exp, vp) do { \
 107 } while (0)
 108 #define __assert_unreachable()  __unreachable()
 109 #endif
 110
 111 #ifndef CTASSERT        /* Allow lint to override */
 112 #define CTASSERT(x)     _Static_assert(x, "compile-time assertion failed")
 113 #endif
 114 #endif /* KERNEL */
 115
 116 /*
 117  * These functions need to be declared before the KASSERT macro is invoked in
 118  * !KASSERT_PANIC_OPTIONAL builds, so their declarations are sort of out of
 119  * place compared to other function definitions in this header.  On the other
 120  * hand, this header is a bit disorganized anyway.
 121  */
 122 void    panic(const char *, ...) __dead2 __printflike(1, 2);
 123 void    vpanic(const char *, __va_list) __dead2 __printflike(1, 0);
 124
 125
 126 #if defined(_STANDALONE)
 127 /*
 128  * Until we have more experience with KASSERTS that are called
 129  * from the boot loader, they are off. The bootloader does this
 130  * a little differently than the kernel (we just call printf atm).
 131  * we avoid most of the common functions in the boot loader, so
 132  * declare printf() here too.
 133  */
 134 int     printf(const char *, ...) __printflike(1, 2);
 135 #  define kassert_panic printf
 136 #else /* !_STANDALONE */
 137 #  if defined(WITNESS) || defined(INVARIANT_SUPPORT)
 138 #    ifdef KASSERT_PANIC_OPTIONAL
 139 void    kassert_panic(const char *fmt, ...)  __printflike(1, 2);
 140 #    else
 141 #      define kassert_panic     panic
 142 #    endif /* KASSERT_PANIC_OPTIONAL */
 143 #  endif /* defined(WITNESS) || defined(INVARIANT_SUPPORT) */
 144 #endif /* _STANDALONE */
 145
 146 #if defined(INVARIANTS) || defined(_STANDALONE)
 147 #define KASSERT(exp,msg) do {                                           \
 148         if (__predict_false(!(exp)))                                    \
 149                 kassert_panic msg;                                      \
 150 } while (0)
 151 #else /* !INVARIANTS && !_STANDALONE */
 152 #define KASSERT(exp,msg) do { \
 153 } while (0)
 154 #endif /* INVARIANTS || _STANDALONE */
 155
 156 /*
 157  * Helpful macros for quickly coming up with assertions with informative
 158  * panic messages.
 159  */
 160 #define MPASS(ex)               MPASS4(ex, #ex, __FILE__, __LINE__)
 161 #define MPASS2(ex, what)        MPASS4(ex, what, __FILE__, __LINE__)
 162 #define MPASS3(ex, file, line)  MPASS4(ex, #ex, file, line)
 163 #define MPASS4(ex, what, file, line)                                    \
 164         KASSERT((ex), ("Assertion %s failed at %s:%d", what, file, line))
 165
 166 /*
 167  * Align variables.
 168  */
 169 #define __read_mostly           __section(".data.read_mostly")
 170 #define __read_frequently       __section(".data.read_frequently")
 171 #define __exclusive_cache_line  __aligned(CACHE_LINE_SIZE) \
 172                                     __section(".data.exclusive_cache_line")
 173 #ifdef _KERNEL
 174 #include <sys/param.h>          /* MAXCPU */
 175 #include <sys/pcpu.h>           /* curthread */
 176 #include <sys/kpilite.h>
 177
 178 /*
 179  * Assert that a pointer can be loaded from memory atomically.
 180  *
 181  * This assertion enforces stronger alignment than necessary.  For example,
 182  * on some architectures, atomicity for unaligned loads will depend on
 183  * whether or not the load spans multiple cache lines.
 184  */
 185 #define ASSERT_ATOMIC_LOAD_PTR(var, msg)                                \
 186         KASSERT(sizeof(var) == sizeof(void *) &&                        \
 187             ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
 188
 189 /*
 190  * Assert that a thread is in critical(9) section.
 191  */
 192 #define CRITICAL_ASSERT(td)                                             \
 193         KASSERT((td)->td_critnest >= 1, ("Not in critical section"));
 194
 195 /*
 196  * If we have already panic'd and this is the thread that called
 197  * panic(), then don't block on any mutexes but silently succeed.
 198  * Otherwise, the kernel will deadlock since the scheduler isn't
 199  * going to run the thread that holds any lock we need.
 200  */
 201 #define SCHEDULER_STOPPED_TD(td)  ({                                    \
 202         MPASS((td) == curthread);                                       \
 203         __predict_false((td)->td_stopsched);                            \
 204 })
 205 #define SCHEDULER_STOPPED() SCHEDULER_STOPPED_TD(curthread)
 206
 207 /*
 208  * XXX the hints declarations are even more misplaced than most declarations
 209  * in this file, since they are needed in one file (per arch) and only used
 210  * in two files.
 211  * XXX most of these variables should be const.
 212  */
 213 extern int osreldate;
 214 extern bool dynamic_kenv;
 215 extern struct mtx kenv_lock;
 216 extern char *kern_envp;
 217 extern char *md_envp;
 218 extern char static_env[];
 219 extern char static_hints[];     /* by config for now */
 220
 221 extern char **kenvp;
 222
 223 extern const void *zero_region; /* address space maps to a zeroed page  */
 224
 225 extern int unmapped_buf_allowed;
 226
 227 #ifdef __LP64__
 228 #define IOSIZE_MAX              iosize_max()
 229 #define DEVFS_IOSIZE_MAX        devfs_iosize_max()
 230 #else
 231 #define IOSIZE_MAX              SSIZE_MAX
 232 #define DEVFS_IOSIZE_MAX        SSIZE_MAX
 233 #endif
 234
 235 /*
 236  * General function declarations.
 237  */
 238
 239 struct inpcb;
 240 struct lock_object;
 241 struct malloc_type;
 242 struct mtx;
 243 struct proc;
 244 struct socket;
 245 struct thread;
 246 struct tty;
 247 struct ucred;
 248 struct uio;
 249 struct _jmp_buf;
 250 struct trapframe;
 251 struct eventtimer;
 252
 253 int     setjmp(struct _jmp_buf *) __returns_twice;
 254 void    longjmp(struct _jmp_buf *, int) __dead2;
 255 int     dumpstatus(vm_offset_t addr, off_t count);
 256 int     nullop(void);
 257 int     eopnotsupp(void);
 258 int     ureadc(int, struct uio *);
 259 void    hashdestroy(void *, struct malloc_type *, u_long);
 260 void    *hashinit(int count, struct malloc_type *type, u_long *hashmask);
 261 void    *hashinit_flags(int count, struct malloc_type *type,
 262     u_long *hashmask, int flags);
 263 #define HASH_NOWAIT     0x00000001
 264 #define HASH_WAITOK     0x00000002
 265
 266 void    *phashinit(int count, struct malloc_type *type, u_long *nentries);
 267 void    *phashinit_flags(int count, struct malloc_type *type, u_long *nentries,
 268     int flags);
 269 void    g_waitidle(void);
 270
 271 void    cpu_flush_dcache(void *, size_t);
 272 void    cpu_rootconf(void);
 273 void    critical_enter_KBI(void);
 274 void    critical_exit_KBI(void);
 275 void    critical_exit_preempt(void);
 276 void    init_param1(void);
 277 void    init_param2(long physpages);
 278 void    init_static_kenv(char *, size_t);
 279 void    tablefull(const char *);
 280
 281 /*
 282  * Allocate per-thread "current" state in the linuxkpi
 283  */
 284 extern int (*lkpi_alloc_current)(struct thread *, int);
 285 int linux_alloc_current_noop(struct thread *, int);
 286
 287 #if defined(KLD_MODULE) || defined(KTR_CRITICAL) || !defined(_KERNEL) || defined(GENOFFSET)
 288 #define critical_enter() critical_enter_KBI()
 289 #define critical_exit() critical_exit_KBI()
 290 #else
 291 static __inline void
 292 critical_enter(void)
 293 {
 294         struct thread_lite *td;
 295
 296         td = (struct thread_lite *)curthread;
 297         td->td_critnest++;
 298         __compiler_membar();
 299 }
 300
 301 static __inline void
 302 critical_exit(void)
 303 {
 304         struct thread_lite *td;
 305
 306         td = (struct thread_lite *)curthread;
 307         KASSERT(td->td_critnest != 0,
 308             ("critical_exit: td_critnest == 0"));
 309         __compiler_membar();
 310         td->td_critnest--;
 311         __compiler_membar();
 312         if (__predict_false(td->td_owepreempt))
 313                 critical_exit_preempt();
 314
 315 }
 316 #endif
 317
 318 #ifdef  EARLY_PRINTF
 319 typedef void early_putc_t(int ch);
 320 extern early_putc_t *early_putc;
 321 #endif
 322 int     kvprintf(char const *, void (*)(int, void*), void *, int,
 323             __va_list) __printflike(1, 0);
 324 void    log(int, const char *, ...) __printflike(2, 3);
 325 void    log_console(struct uio *);
 326 void    vlog(int, const char *, __va_list) __printflike(2, 0);
 327 int     asprintf(char **ret, struct malloc_type *mtp, const char *format,
 328             ...) __printflike(3, 4);
 329 int     printf(const char *, ...) __printflike(1, 2);
 330 int     snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
 331 int     sprintf(char *buf, const char *, ...) __printflike(2, 3);
 332 int     uprintf(const char *, ...) __printflike(1, 2);
 333 int     vprintf(const char *, __va_list) __printflike(1, 0);
 334 int     vasprintf(char **ret, struct malloc_type *mtp, const char *format,
 335             __va_list ap) __printflike(3, 0);
 336 int     vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
 337 int     vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
 338 int     vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
 339 int     sscanf(const char *, char const * _Nonnull, ...) __scanflike(2, 3);
 340 int     vsscanf(const char * _Nonnull, char const * _Nonnull, __va_list)  __scanflike(2, 0);
 341 long    strtol(const char *, char **, int);
 342 u_long  strtoul(const char *, char **, int);
 343 quad_t  strtoq(const char *, char **, int);
 344 u_quad_t strtouq(const char *, char **, int);
 345 void    tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
 346 void    vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
 347 void    hexdump(const void *ptr, int length, const char *hdr, int flags);
 348 #define HD_COLUMN_MASK  0xff
 349 #define HD_DELIM_MASK   0xff00
 350 #define HD_OMIT_COUNT   (1 << 16)
 351 #define HD_OMIT_HEX     (1 << 17)
 352 #define HD_OMIT_CHARS   (1 << 18)
 353
 354 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
 355 void    bcopy(const void * _Nonnull from, void * _Nonnull to, size_t len);
 356 void    bzero(void * _Nonnull buf, size_t len);
 357 void    explicit_bzero(void * _Nonnull, size_t);
 358 int     bcmp(const void *b1, const void *b2, size_t len);
 359
 360 void    *memset(void * _Nonnull buf, int c, size_t len);
 361 void    *memcpy(void * _Nonnull to, const void * _Nonnull from, size_t len);
 362 void    *memmove(void * _Nonnull dest, const void * _Nonnull src, size_t n);
 363 int     memcmp(const void *b1, const void *b2, size_t len);
 364
 365 #ifdef KCSAN
 366 void    *kcsan_memset(void *, int, size_t);
 367 void    *kcsan_memcpy(void *, const void *, size_t);
 368 void    *kcsan_memmove(void *, const void *, size_t);
 369 int     kcsan_memcmp(const void *, const void *, size_t);
 370 #define bcopy(from, to, len) kcsan_memmove((to), (from), (len))
 371 #define bzero(buf, len) kcsan_memset((buf), 0, (len))
 372 #define bcmp(b1, b2, len) kcsan_memcmp((b1), (b2), (len))
 373 #define memset(buf, c, len) kcsan_memset((buf), (c), (len))
 374 #define memcpy(to, from, len) kcsan_memcpy((to), (from), (len))
 375 #define memmove(dest, src, n) kcsan_memmove((dest), (src), (n))
 376 #define memcmp(b1, b2, len) kcsan_memcmp((b1), (b2), (len))
 377 #else
 378 #define bcopy(from, to, len) __builtin_memmove((to), (from), (len))
 379 #define bzero(buf, len) __builtin_memset((buf), 0, (len))
 380 #define bcmp(b1, b2, len) __builtin_memcmp((b1), (b2), (len))
 381 #define memset(buf, c, len) __builtin_memset((buf), (c), (len))
 382 #define memcpy(to, from, len) __builtin_memcpy((to), (from), (len))
 383 #define memmove(dest, src, n) __builtin_memmove((dest), (src), (n))
 384 #define memcmp(b1, b2, len) __builtin_memcmp((b1), (b2), (len))
 385 #endif
 386
 387 void    *memset_early(void * _Nonnull buf, int c, size_t len);
 388 #define bzero_early(buf, len) memset_early((buf), 0, (len))
 389 void    *memcpy_early(void * _Nonnull to, const void * _Nonnull from, size_t len);
 390 void    *memmove_early(void * _Nonnull dest, const void * _Nonnull src, size_t n);
 391 #define bcopy_early(from, to, len) memmove_early((to), (from), (len))
 392
 393 #define copystr(src, dst, len, outlen)  ({                      \
 394         size_t __r, __len, *__outlen;                           \
 395                                                                 \
 396         __len = (len);                                          \
 397         __outlen = (outlen);                                    \
 398         __r = strlcpy((dst), (src), __len);                     \
 399         if (__outlen != NULL)                                   \
 400                 *__outlen = ((__r >= __len) ? __len : __r + 1); \
 401         ((__r >= __len) ? ENAMETOOLONG : 0);                    \
 402 })
 403
 404 int     copyinstr(const void * __restrict udaddr,
 405             void * _Nonnull __restrict kaddr, size_t len,
 406             size_t * __restrict lencopied);
 407 int     copyin(const void * __restrict udaddr,
 408             void * _Nonnull __restrict kaddr, size_t len);
 409 int     copyin_nofault(const void * __restrict udaddr,
 410             void * _Nonnull __restrict kaddr, size_t len);
 411 int     copyout(const void * _Nonnull __restrict kaddr,
 412             void * __restrict udaddr, size_t len);
 413 int     copyout_nofault(const void * _Nonnull __restrict kaddr,
 414             void * __restrict udaddr, size_t len);
 415
 416 #ifdef KCSAN
 417 int     kcsan_copyin(const void *, void *, size_t);
 418 int     kcsan_copyinstr(const void *, void *, size_t, size_t *);
 419 int     kcsan_copyout(const void *, void *, size_t);
 420 #define copyin(u, k, l) kcsan_copyin((u), (k), (l))
 421 #define copyinstr(u, k, l, lc) kcsan_copyinstr((u), (k), (l), (lc))
 422 #define copyout(k, u, l) kcsan_copyout((k), (u), (l))
 423 #endif
 424
 425 int     fubyte(volatile const void *base);
 426 long    fuword(volatile const void *base);
 427 int     fuword16(volatile const void *base);
 428 int32_t fuword32(volatile const void *base);
 429 int64_t fuword64(volatile const void *base);
 430 int     fueword(volatile const void *base, long *val);
 431 int     fueword32(volatile const void *base, int32_t *val);
 432 int     fueword64(volatile const void *base, int64_t *val);
 433 int     subyte(volatile void *base, int byte);
 434 int     suword(volatile void *base, long word);
 435 int     suword16(volatile void *base, int word);
 436 int     suword32(volatile void *base, int32_t word);
 437 int     suword64(volatile void *base, int64_t word);
 438 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
 439 u_long  casuword(volatile u_long *p, u_long oldval, u_long newval);
 440 int     casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp,
 441             uint32_t newval);
 442 int     casueword(volatile u_long *p, u_long oldval, u_long *oldvalp,
 443             u_long newval);
 444
 445 void    realitexpire(void *);
 446
 447 int     sysbeep(int hertz, int period);
 448
 449 void    hardclock(int cnt, int usermode);
 450 void    hardclock_sync(int cpu);
 451 void    softclock(void *);
 452 void    statclock(int cnt, int usermode);
 453 void    profclock(int cnt, int usermode, uintfptr_t pc);
 454
 455 int     hardclockintr(void);
 456
 457 void    startprofclock(struct proc *);
 458 void    stopprofclock(struct proc *);
 459 void    cpu_startprofclock(void);
 460 void    cpu_stopprofclock(void);
 461 void    suspendclock(void);
 462 void    resumeclock(void);
 463 sbintime_t      cpu_idleclock(void);
 464 void    cpu_activeclock(void);
 465 void    cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
 466 void    cpu_et_frequency(struct eventtimer *et, uint64_t newfreq);
 467 extern int      cpu_disable_c2_sleep;
 468 extern int      cpu_disable_c3_sleep;
 469
 470 char    *kern_getenv(const char *name);
 471 void    freeenv(char *env);
 472 int     getenv_int(const char *name, int *data);
 473 int     getenv_uint(const char *name, unsigned int *data);
 474 int     getenv_long(const char *name, long *data);
 475 int     getenv_ulong(const char *name, unsigned long *data);
 476 int     getenv_string(const char *name, char *data, int size);
 477 int     getenv_int64(const char *name, int64_t *data);
 478 int     getenv_uint64(const char *name, uint64_t *data);
 479 int     getenv_quad(const char *name, quad_t *data);
 480 int     getenv_bool(const char *name, bool *data);
 481 bool    getenv_is_true(const char *name);
 482 bool    getenv_is_false(const char *name);
 483 int     kern_setenv(const char *name, const char *value);
 484 int     kern_unsetenv(const char *name);
 485 int     testenv(const char *name);
 486
 487 int     getenv_array(const char *name, void *data, int size, int *psize,
 488     int type_size, bool allow_signed);
 489 #define GETENV_UNSIGNED false   /* negative numbers not allowed */
 490 #define GETENV_SIGNED   true    /* negative numbers allowed */
 491
 492 typedef uint64_t (cpu_tick_f)(void);
 493 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
 494 extern cpu_tick_f *cpu_ticks;
 495 uint64_t cpu_tickrate(void);
 496 uint64_t cputick2usec(uint64_t tick);
 497
 498 #ifdef APM_FIXUP_CALLTODO
 499 struct timeval;
 500 void    adjust_timeout_calltodo(struct timeval *time_change);
 501 #endif /* APM_FIXUP_CALLTODO */
 502
 503 #include <sys/libkern.h>
 504
 505 /* Initialize the world */
 506 void    consinit(void);
 507 void    cpu_initclocks(void);
 508 void    cpu_initclocks_bsp(void);
 509 void    cpu_initclocks_ap(void);
 510 void    usrinfoinit(void);
 511
 512 /* Finalize the world */
 513 void    kern_reboot(int) __dead2;
 514 void    shutdown_nice(int);
 515
 516 /* Stubs for obsolete functions that used to be for interrupt management */
 517 static __inline intrmask_t      splhigh(void)           { return 0; }
 518 static __inline intrmask_t      splimp(void)            { return 0; }
 519 static __inline intrmask_t      splnet(void)            { return 0; }
 520 static __inline intrmask_t      spltty(void)            { return 0; }
 521 static __inline void            splx(intrmask_t ipl __unused)   { return; }
 522
 523 /*
 524  * Common `proc' functions are declared here so that proc.h can be included
 525  * less often.
 526  */
 527 int     _sleep(const void * _Nonnull chan, struct lock_object *lock, int pri,
 528            const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
 529 #define msleep(chan, mtx, pri, wmesg, timo)                             \
 530         _sleep((chan), &(mtx)->lock_object, (pri), (wmesg),             \
 531             tick_sbt * (timo), 0, C_HARDCLOCK)
 532 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags)                \
 533         _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
 534             (flags))
 535 int     msleep_spin_sbt(const void * _Nonnull chan, struct mtx *mtx,
 536             const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
 537 #define msleep_spin(chan, mtx, wmesg, timo)                             \
 538         msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo),      \
 539             0, C_HARDCLOCK)
 540 int     pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
 541             int flags);
 542 #define pause(wmesg, timo)                                              \
 543         pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK)
 544 #define pause_sig(wmesg, timo)                                          \
 545         pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK | C_CATCH)
 546 #define tsleep(chan, pri, wmesg, timo)                                  \
 547         _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo),         \
 548             0, C_HARDCLOCK)
 549 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags)                     \
 550         _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
 551 void    wakeup(const void *chan);
 552 void    wakeup_one(const void *chan);
 553 void    wakeup_any(const void *chan);
 554
 555 /*
 556  * Common `struct cdev *' stuff are declared here to avoid #include poisoning
 557  */
 558
 559 struct cdev;
 560 dev_t dev2udev(struct cdev *x);
 561 const char *devtoname(struct cdev *cdev);
 562
 563 #ifdef __LP64__
 564 size_t  devfs_iosize_max(void);
 565 size_t  iosize_max(void);
 566 #endif
 567
 568 int poll_no_poll(int events);
 569
 570 /* XXX: Should be void nanodelay(u_int nsec); */
 571 void    DELAY(int usec);
 572
 573 /* Root mount holdback API */
 574 struct root_hold_token {
 575         int                             flags;
 576         const char                      *who;
 577         TAILQ_ENTRY(root_hold_token)    list;
 578 };
 579
 580 struct root_hold_token *root_mount_hold(const char *identifier);
 581 void root_mount_hold_token(const char *identifier, struct root_hold_token *h);
 582 void root_mount_rel(struct root_hold_token *h);
 583 int root_mounted(void);
 584
 585 /*
 586  * Unit number allocation API. (kern/subr_unit.c)
 587  */
 588 struct unrhdr;
 589 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
 590 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
 591 void delete_unrhdr(struct unrhdr *uh);
 592 void clear_unrhdr(struct unrhdr *uh);
 593 void clean_unrhdr(struct unrhdr *uh);
 594 void clean_unrhdrl(struct unrhdr *uh);
 595 int alloc_unr(struct unrhdr *uh);
 596 int alloc_unr_specific(struct unrhdr *uh, u_int item);
 597 int alloc_unrl(struct unrhdr *uh);
 598 void free_unr(struct unrhdr *uh, u_int item);
 599
 600 #ifndef __LP64__
 601 #define UNR64_LOCKED
 602 #endif
 603
 604 struct unrhdr64 {
 605         uint64_t        counter;
 606 };
 607
 608 static __inline void
 609 new_unrhdr64(struct unrhdr64 *unr64, uint64_t low)
 610 {
 611
 612         unr64->counter = low;
 613 }
 614
 615 #ifdef UNR64_LOCKED
 616 uint64_t alloc_unr64(struct unrhdr64 *);
 617 #else
 618 static __inline uint64_t
 619 alloc_unr64(struct unrhdr64 *unr64)
 620 {
 621
 622         return (atomic_fetchadd_64(&unr64->counter, 1));
 623 }
 624 #endif
 625
 626 void    intr_prof_stack_use(struct thread *td, struct trapframe *frame);
 627
 628 void counted_warning(unsigned *counter, const char *msg);
 629
 630 /*
 631  * APIs to manage deprecation and obsolescence.
 632  */
 633 struct device;
 634 void _gone_in(int major, const char *msg);
 635 void _gone_in_dev(struct device *dev, int major, const char *msg);
 636 #ifdef NO_OBSOLETE_CODE
 637 #define __gone_ok(m, msg)                                        \
 638         _Static_assert(m < P_OSREL_MAJOR(__FreeBSD_version)),    \
 639             "Obsolete code: " msg);
 640 #else
 641 #define __gone_ok(m, msg)
 642 #endif
 643 #define gone_in(major, msg)             __gone_ok(major, msg) _gone_in(major, msg)
 644 #define gone_in_dev(dev, major, msg)    __gone_ok(major, msg) _gone_in_dev(dev, major, msg)
 645 #endif /* _KERNEL */
 646
 647 __NULLABILITY_PRAGMA_POP
 648
 649 #endif /* !_SYS_SYSTM_H_ */