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