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