systm.h revision 335656
1/*- 2 * Copyright (c) 1982, 1988, 1991, 1993 3 * The Regents of the University of California. All rights reserved. 4 * (c) UNIX System Laboratories, Inc. 5 * All or some portions of this file are derived from material licensed 6 * to the University of California by American Telephone and Telegraph 7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 8 * the permission of UNIX System Laboratories, Inc. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 4. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * @(#)systm.h 8.7 (Berkeley) 3/29/95 35 * $FreeBSD: stable/11/sys/sys/systm.h 335656 2018-06-26 08:31:08Z avg $ 36 */ 37 38#ifndef _SYS_SYSTM_H_ 39#define _SYS_SYSTM_H_ 40 41#include <machine/atomic.h> 42#include <machine/cpufunc.h> 43#include <sys/callout.h> 44#include <sys/cdefs.h> 45#include <sys/queue.h> 46#include <sys/stdint.h> /* for people using printf mainly */ 47 48__NULLABILITY_PRAGMA_PUSH 49 50extern int cold; /* nonzero if we are doing a cold boot */ 51extern int suspend_blocked; /* block suspend due to pending shutdown */ 52extern int rebooting; /* kern_reboot() has been called. */ 53extern const char *panicstr; /* panic message */ 54extern char version[]; /* system version */ 55extern char compiler_version[]; /* compiler version */ 56extern char copyright[]; /* system copyright */ 57extern int kstack_pages; /* number of kernel stack pages */ 58 59extern u_long pagesizes[]; /* supported page sizes */ 60extern long physmem; /* physical memory */ 61extern long realmem; /* 'real' memory */ 62 63extern char *rootdevnames[2]; /* names of possible root devices */ 64 65extern int boothowto; /* reboot flags, from console subsystem */ 66extern int bootverbose; /* nonzero to print verbose messages */ 67 68extern int maxusers; /* system tune hint */ 69extern int ngroups_max; /* max # of supplemental groups */ 70extern int vm_guest; /* Running as virtual machine guest? */ 71 72/* 73 * Detected virtual machine guest types. The intention is to expand 74 * and/or add to the VM_GUEST_VM type if specific VM functionality is 75 * ever implemented (e.g. vendor-specific paravirtualization features). 76 * Keep in sync with vm_guest_sysctl_names[]. 77 */ 78enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN, VM_GUEST_HV, 79 VM_GUEST_VMWARE, VM_GUEST_KVM, VM_GUEST_BHYVE, VM_LAST }; 80 81#if defined(WITNESS) || defined(INVARIANT_SUPPORT) 82void kassert_panic(const char *fmt, ...) __printflike(1, 2); 83#endif 84 85#ifdef INVARIANTS /* The option is always available */ 86#define KASSERT(exp,msg) do { \ 87 if (__predict_false(!(exp))) \ 88 kassert_panic msg; \ 89} while (0) 90#define VNASSERT(exp, vp, msg) do { \ 91 if (__predict_false(!(exp))) { \ 92 vn_printf(vp, "VNASSERT failed\n"); \ 93 kassert_panic msg; \ 94 } \ 95} while (0) 96#else 97#define KASSERT(exp,msg) do { \ 98} while (0) 99 100#define VNASSERT(exp, vp, msg) do { \ 101} while (0) 102#endif 103 104#ifndef CTASSERT /* Allow lint to override */ 105#define CTASSERT(x) _Static_assert(x, "compile-time assertion failed") 106#endif 107 108/* 109 * Assert that a pointer can be loaded from memory atomically. 110 * 111 * This assertion enforces stronger alignment than necessary. For example, 112 * on some architectures, atomicity for unaligned loads will depend on 113 * whether or not the load spans multiple cache lines. 114 */ 115#define ASSERT_ATOMIC_LOAD_PTR(var, msg) \ 116 KASSERT(sizeof(var) == sizeof(void *) && \ 117 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg) 118 119/* 120 * Assert that a thread is in critical(9) section. 121 */ 122#define CRITICAL_ASSERT(td) \ 123 KASSERT((td)->td_critnest >= 1, ("Not in critical section")); 124 125/* 126 * If we have already panic'd and this is the thread that called 127 * panic(), then don't block on any mutexes but silently succeed. 128 * Otherwise, the kernel will deadlock since the scheduler isn't 129 * going to run the thread that holds any lock we need. 130 */ 131#define SCHEDULER_STOPPED_TD(td) ({ \ 132 MPASS((td) == curthread); \ 133 __predict_false((td)->td_stopsched); \ 134}) 135#define SCHEDULER_STOPPED() SCHEDULER_STOPPED_TD(curthread) 136 137/* 138 * Align variables. 139 */ 140#define __read_mostly __section(".data.read_mostly") 141#define __read_frequently __section(".data.read_frequently") 142#define __exclusive_cache_line __aligned(CACHE_LINE_SIZE) \ 143 __section(".data.exclusive_cache_line") 144/* 145 * XXX the hints declarations are even more misplaced than most declarations 146 * in this file, since they are needed in one file (per arch) and only used 147 * in two files. 148 * XXX most of these variables should be const. 149 */ 150extern int osreldate; 151extern int envmode; 152extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */ 153extern int dynamic_kenv; 154extern struct mtx kenv_lock; 155extern char *kern_envp; 156extern char static_env[]; 157extern char static_hints[]; /* by config for now */ 158 159extern char **kenvp; 160 161extern const void *zero_region; /* address space maps to a zeroed page */ 162 163extern int unmapped_buf_allowed; 164 165#ifdef __LP64__ 166#define IOSIZE_MAX iosize_max() 167#define DEVFS_IOSIZE_MAX devfs_iosize_max() 168#else 169#define IOSIZE_MAX SSIZE_MAX 170#define DEVFS_IOSIZE_MAX SSIZE_MAX 171#endif 172 173/* 174 * General function declarations. 175 */ 176 177struct inpcb; 178struct lock_object; 179struct malloc_type; 180struct mtx; 181struct proc; 182struct socket; 183struct thread; 184struct tty; 185struct ucred; 186struct uio; 187struct _jmp_buf; 188struct trapframe; 189struct eventtimer; 190 191int setjmp(struct _jmp_buf *) __returns_twice; 192void longjmp(struct _jmp_buf *, int) __dead2; 193int dumpstatus(vm_offset_t addr, off_t count); 194int nullop(void); 195int eopnotsupp(void); 196int ureadc(int, struct uio *); 197void hashdestroy(void *, struct malloc_type *, u_long); 198void *hashinit(int count, struct malloc_type *type, u_long *hashmask); 199void *hashinit_flags(int count, struct malloc_type *type, 200 u_long *hashmask, int flags); 201#define HASH_NOWAIT 0x00000001 202#define HASH_WAITOK 0x00000002 203 204void *phashinit(int count, struct malloc_type *type, u_long *nentries); 205void *phashinit_flags(int count, struct malloc_type *type, u_long *nentries, 206 int flags); 207void g_waitidle(void); 208 209void panic(const char *, ...) __dead2 __printflike(1, 2); 210void vpanic(const char *, __va_list) __dead2 __printflike(1, 0); 211 212void cpu_boot(int); 213void cpu_flush_dcache(void *, size_t); 214void cpu_rootconf(void); 215void critical_enter(void); 216void critical_exit(void); 217void init_param1(void); 218void init_param2(long physpages); 219void init_static_kenv(char *, size_t); 220void tablefull(const char *); 221#ifdef EARLY_PRINTF 222typedef void early_putc_t(int ch); 223extern early_putc_t *early_putc; 224#endif 225int kvprintf(char const *, void (*)(int, void*), void *, int, 226 __va_list) __printflike(1, 0); 227void log(int, const char *, ...) __printflike(2, 3); 228void log_console(struct uio *); 229void vlog(int, const char *, __va_list) __printflike(2, 0); 230int asprintf(char **ret, struct malloc_type *mtp, const char *format, 231 ...) __printflike(3, 4); 232int printf(const char *, ...) __printflike(1, 2); 233int snprintf(char *, size_t, const char *, ...) __printflike(3, 4); 234int sprintf(char *buf, const char *, ...) __printflike(2, 3); 235int uprintf(const char *, ...) __printflike(1, 2); 236int vprintf(const char *, __va_list) __printflike(1, 0); 237int vasprintf(char **ret, struct malloc_type *mtp, const char *format, 238 __va_list ap) __printflike(3, 0); 239int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0); 240int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0); 241int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0); 242int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3); 243int sscanf(const char *, char const * _Nonnull, ...) __scanflike(2, 3); 244int vsscanf(const char * _Nonnull, char const * _Nonnull, __va_list) __scanflike(2, 0); 245long strtol(const char *, char **, int); 246u_long strtoul(const char *, char **, int); 247quad_t strtoq(const char *, char **, int); 248u_quad_t strtouq(const char *, char **, int); 249void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4); 250void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0); 251void hexdump(const void *ptr, int length, const char *hdr, int flags); 252#define HD_COLUMN_MASK 0xff 253#define HD_DELIM_MASK 0xff00 254#define HD_OMIT_COUNT (1 << 16) 255#define HD_OMIT_HEX (1 << 17) 256#define HD_OMIT_CHARS (1 << 18) 257 258#define ovbcopy(f, t, l) bcopy((f), (t), (l)) 259void bcopy(const void * _Nonnull from, void * _Nonnull to, size_t len); 260void bzero(void * _Nonnull buf, size_t len); 261void explicit_bzero(void * _Nonnull, size_t); 262 263void *memcpy(void * _Nonnull to, const void * _Nonnull from, size_t len); 264void *memmove(void * _Nonnull dest, const void * _Nonnull src, size_t n); 265 266int copystr(const void * _Nonnull __restrict kfaddr, 267 void * _Nonnull __restrict kdaddr, size_t len, 268 size_t * __restrict lencopied); 269int copyinstr(const void * __restrict udaddr, 270 void * _Nonnull __restrict kaddr, size_t len, 271 size_t * __restrict lencopied); 272int copyin(const void * __restrict udaddr, 273 void * _Nonnull __restrict kaddr, size_t len); 274int copyin_nofault(const void * __restrict udaddr, 275 void * _Nonnull __restrict kaddr, size_t len); 276int copyout(const void * _Nonnull __restrict kaddr, 277 void * __restrict udaddr, size_t len); 278int copyout_nofault(const void * _Nonnull __restrict kaddr, 279 void * __restrict udaddr, size_t len); 280 281int fubyte(volatile const void *base); 282long fuword(volatile const void *base); 283int fuword16(volatile const void *base); 284int32_t fuword32(volatile const void *base); 285int64_t fuword64(volatile const void *base); 286int fueword(volatile const void *base, long *val); 287int fueword32(volatile const void *base, int32_t *val); 288int fueword64(volatile const void *base, int64_t *val); 289int subyte(volatile void *base, int byte); 290int suword(volatile void *base, long word); 291int suword16(volatile void *base, int word); 292int suword32(volatile void *base, int32_t word); 293int suword64(volatile void *base, int64_t word); 294uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval); 295u_long casuword(volatile u_long *p, u_long oldval, u_long newval); 296int casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp, 297 uint32_t newval); 298int casueword(volatile u_long *p, u_long oldval, u_long *oldvalp, 299 u_long newval); 300 301void realitexpire(void *); 302 303int sysbeep(int hertz, int period); 304 305void hardclock(int usermode, uintfptr_t pc); 306void hardclock_cnt(int cnt, int usermode); 307void hardclock_cpu(int usermode); 308void hardclock_sync(int cpu); 309void softclock(void *); 310void statclock(int usermode); 311void statclock_cnt(int cnt, int usermode); 312void profclock(int usermode, uintfptr_t pc); 313void profclock_cnt(int cnt, int usermode, uintfptr_t pc); 314 315int hardclockintr(void); 316 317void startprofclock(struct proc *); 318void stopprofclock(struct proc *); 319void cpu_startprofclock(void); 320void cpu_stopprofclock(void); 321void suspendclock(void); 322void resumeclock(void); 323sbintime_t cpu_idleclock(void); 324void cpu_activeclock(void); 325void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt); 326void cpu_et_frequency(struct eventtimer *et, uint64_t newfreq); 327extern int cpu_disable_c2_sleep; 328extern int cpu_disable_c3_sleep; 329 330int cr_cansee(struct ucred *u1, struct ucred *u2); 331int cr_canseesocket(struct ucred *cred, struct socket *so); 332int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp); 333 334char *kern_getenv(const char *name); 335void freeenv(char *env); 336int getenv_int(const char *name, int *data); 337int getenv_uint(const char *name, unsigned int *data); 338int getenv_long(const char *name, long *data); 339int getenv_ulong(const char *name, unsigned long *data); 340int getenv_string(const char *name, char *data, int size); 341int getenv_int64(const char *name, int64_t *data); 342int getenv_uint64(const char *name, uint64_t *data); 343int getenv_quad(const char *name, quad_t *data); 344int kern_setenv(const char *name, const char *value); 345int kern_unsetenv(const char *name); 346int testenv(const char *name); 347 348typedef uint64_t (cpu_tick_f)(void); 349void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var); 350extern cpu_tick_f *cpu_ticks; 351uint64_t cpu_tickrate(void); 352uint64_t cputick2usec(uint64_t tick); 353 354#ifdef APM_FIXUP_CALLTODO 355struct timeval; 356void adjust_timeout_calltodo(struct timeval *time_change); 357#endif /* APM_FIXUP_CALLTODO */ 358 359#include <sys/libkern.h> 360 361/* Initialize the world */ 362void consinit(void); 363void cpu_initclocks(void); 364void cpu_initclocks_bsp(void); 365void cpu_initclocks_ap(void); 366void usrinfoinit(void); 367 368/* Finalize the world */ 369void kern_reboot(int) __dead2; 370void shutdown_nice(int); 371 372/* Timeouts */ 373typedef void timeout_t(void *); /* timeout function type */ 374#define CALLOUT_HANDLE_INITIALIZER(handle) \ 375 { NULL } 376 377void callout_handle_init(struct callout_handle *); 378struct callout_handle timeout(timeout_t *, void *, int); 379void untimeout(timeout_t *, void *, struct callout_handle); 380 381/* Stubs for obsolete functions that used to be for interrupt management */ 382static __inline intrmask_t splbio(void) { return 0; } 383static __inline intrmask_t splcam(void) { return 0; } 384static __inline intrmask_t splclock(void) { return 0; } 385static __inline intrmask_t splhigh(void) { return 0; } 386static __inline intrmask_t splimp(void) { return 0; } 387static __inline intrmask_t splnet(void) { return 0; } 388static __inline intrmask_t spltty(void) { return 0; } 389static __inline void splx(intrmask_t ipl __unused) { return; } 390 391/* 392 * Common `proc' functions are declared here so that proc.h can be included 393 * less often. 394 */ 395int _sleep(void * _Nonnull chan, struct lock_object *lock, int pri, 396 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags); 397#define msleep(chan, mtx, pri, wmesg, timo) \ 398 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \ 399 tick_sbt * (timo), 0, C_HARDCLOCK) 400#define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \ 401 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \ 402 (flags)) 403int msleep_spin_sbt(void * _Nonnull chan, struct mtx *mtx, 404 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags); 405#define msleep_spin(chan, mtx, wmesg, timo) \ 406 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \ 407 0, C_HARDCLOCK) 408int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr, 409 int flags); 410#define pause(wmesg, timo) \ 411 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK) 412#define pause_sig(wmesg, timo) \ 413 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK | C_CATCH) 414#define tsleep(chan, pri, wmesg, timo) \ 415 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \ 416 0, C_HARDCLOCK) 417#define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \ 418 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags)) 419void wakeup(void * chan); 420void wakeup_one(void * chan); 421 422/* 423 * Common `struct cdev *' stuff are declared here to avoid #include poisoning 424 */ 425 426struct cdev; 427dev_t dev2udev(struct cdev *x); 428const char *devtoname(struct cdev *cdev); 429 430#ifdef __LP64__ 431size_t devfs_iosize_max(void); 432size_t iosize_max(void); 433#endif 434 435int poll_no_poll(int events); 436 437/* XXX: Should be void nanodelay(u_int nsec); */ 438void DELAY(int usec); 439 440/* Root mount holdback API */ 441struct root_hold_token; 442 443struct root_hold_token *root_mount_hold(const char *identifier); 444void root_mount_rel(struct root_hold_token *h); 445int root_mounted(void); 446 447 448/* 449 * Unit number allocation API. (kern/subr_unit.c) 450 */ 451struct unrhdr; 452struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex); 453void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex); 454void delete_unrhdr(struct unrhdr *uh); 455void clean_unrhdr(struct unrhdr *uh); 456void clean_unrhdrl(struct unrhdr *uh); 457int alloc_unr(struct unrhdr *uh); 458int alloc_unr_specific(struct unrhdr *uh, u_int item); 459int alloc_unrl(struct unrhdr *uh); 460void free_unr(struct unrhdr *uh, u_int item); 461 462void intr_prof_stack_use(struct thread *td, struct trapframe *frame); 463 464void counted_warning(unsigned *counter, const char *msg); 465 466/* 467 * APIs to manage deprecation and obsolescence. 468 */ 469struct device; 470void _gone_in(int major, const char *msg); 471void _gone_in_dev(struct device *dev, int major, const char *msg); 472#ifdef NO_OBSOLETE_CODE 473#define __gone_ok(m, msg) \ 474 _Static_assert(m < P_OSREL_MAJOR(__FreeBSD_version)), \ 475 "Obsolete code" msg); 476#else 477#define __gone_ok(m, msg) 478#endif 479#define gone_in(major, msg) __gone_ok(major, msg) _gone_in(major, msg) 480#define gone_in_dev(dev, major, msg) __gone_ok(major, msg) _gone_in_dev(dev, major, msg) 481 482__NULLABILITY_PRAGMA_POP 483 484#endif /* !_SYS_SYSTM_H_ */ 485