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