systm.h revision 272946
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 272946 2014-10-11 17:49:51Z kib $ 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_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); 190 191void cpu_boot(int); 192void cpu_flush_dcache(void *, size_t); 193void cpu_rootconf(void); 194void critical_enter(void); 195void critical_exit(void); 196void init_param1(void); 197void init_param2(long physpages); 198void init_static_kenv(char *, size_t); 199void tablefull(const char *); 200#ifdef EARLY_PRINTF 201typedef void early_putc_t(int ch); 202extern early_putc_t *early_putc; 203#endif 204int kvprintf(char const *, void (*)(int, void*), void *, int, 205 __va_list) __printflike(1, 0); 206void log(int, const char *, ...) __printflike(2, 3); 207void log_console(struct uio *); 208int printf(const char *, ...) __printflike(1, 2); 209int snprintf(char *, size_t, const char *, ...) __printflike(3, 4); 210int sprintf(char *buf, const char *, ...) __printflike(2, 3); 211int uprintf(const char *, ...) __printflike(1, 2); 212int vprintf(const char *, __va_list) __printflike(1, 0); 213int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0); 214int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0); 215int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0); 216int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3); 217int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2); 218int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2); 219long strtol(const char *, char **, int) __nonnull(1); 220u_long strtoul(const char *, char **, int) __nonnull(1); 221quad_t strtoq(const char *, char **, int) __nonnull(1); 222u_quad_t strtouq(const char *, char **, int) __nonnull(1); 223void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4); 224void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0); 225void hexdump(const void *ptr, int length, const char *hdr, int flags); 226#define HD_COLUMN_MASK 0xff 227#define HD_DELIM_MASK 0xff00 228#define HD_OMIT_COUNT (1 << 16) 229#define HD_OMIT_HEX (1 << 17) 230#define HD_OMIT_CHARS (1 << 18) 231 232#define ovbcopy(f, t, l) bcopy((f), (t), (l)) 233void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2); 234void bzero(void *buf, size_t len) __nonnull(1); 235 236void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2); 237void *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2); 238 239int copystr(const void * __restrict kfaddr, void * __restrict kdaddr, 240 size_t len, size_t * __restrict lencopied) 241 __nonnull(1) __nonnull(2); 242int copyinstr(const void * __restrict udaddr, void * __restrict kaddr, 243 size_t len, size_t * __restrict lencopied) 244 __nonnull(1) __nonnull(2); 245int copyin(const void * __restrict udaddr, void * __restrict kaddr, 246 size_t len) __nonnull(1) __nonnull(2); 247int copyin_nofault(const void * __restrict udaddr, void * __restrict kaddr, 248 size_t len) __nonnull(1) __nonnull(2); 249int copyout(const void * __restrict kaddr, void * __restrict udaddr, 250 size_t len) __nonnull(1) __nonnull(2); 251int copyout_nofault(const void * __restrict kaddr, void * __restrict udaddr, 252 size_t len) __nonnull(1) __nonnull(2); 253 254int fubyte(const void *base); 255long fuword(const void *base); 256int fuword16(void *base); 257int32_t fuword32(const void *base); 258int64_t fuword64(const void *base); 259int subyte(void *base, int byte); 260int suword(void *base, long word); 261int suword16(void *base, int word); 262int suword32(void *base, int32_t word); 263int suword64(void *base, int64_t word); 264uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval); 265u_long casuword(volatile u_long *p, u_long oldval, u_long newval); 266 267void realitexpire(void *); 268 269int sysbeep(int hertz, int period); 270 271void hardclock(int usermode, uintfptr_t pc); 272void hardclock_cnt(int cnt, int usermode); 273void hardclock_cpu(int usermode); 274void hardclock_sync(int cpu); 275void softclock(void *); 276void statclock(int usermode); 277void statclock_cnt(int cnt, int usermode); 278void profclock(int usermode, uintfptr_t pc); 279void profclock_cnt(int cnt, int usermode, uintfptr_t pc); 280 281int hardclockintr(void); 282 283void startprofclock(struct proc *); 284void stopprofclock(struct proc *); 285void cpu_startprofclock(void); 286void cpu_stopprofclock(void); 287sbintime_t cpu_idleclock(void); 288void cpu_activeclock(void); 289void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt); 290void cpu_et_frequency(struct eventtimer *et, uint64_t newfreq); 291extern int cpu_can_deep_sleep; 292extern int cpu_disable_deep_sleep; 293 294int cr_cansee(struct ucred *u1, struct ucred *u2); 295int cr_canseesocket(struct ucred *cred, struct socket *so); 296int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp); 297 298char *getenv(const char *name); 299void freeenv(char *env); 300int getenv_int(const char *name, int *data); 301int getenv_uint(const char *name, unsigned int *data); 302int getenv_long(const char *name, long *data); 303int getenv_ulong(const char *name, unsigned long *data); 304int getenv_string(const char *name, char *data, int size); 305int getenv_quad(const char *name, quad_t *data); 306int setenv(const char *name, const char *value); 307int unsetenv(const char *name); 308int testenv(const char *name); 309 310typedef uint64_t (cpu_tick_f)(void); 311void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var); 312extern cpu_tick_f *cpu_ticks; 313uint64_t cpu_tickrate(void); 314uint64_t cputick2usec(uint64_t tick); 315 316#ifdef APM_FIXUP_CALLTODO 317struct timeval; 318void adjust_timeout_calltodo(struct timeval *time_change); 319#endif /* APM_FIXUP_CALLTODO */ 320 321#include <sys/libkern.h> 322 323/* Initialize the world */ 324void consinit(void); 325void cpu_initclocks(void); 326void cpu_initclocks_bsp(void); 327void cpu_initclocks_ap(void); 328void usrinfoinit(void); 329 330/* Finalize the world */ 331void kern_reboot(int) __dead2; 332void shutdown_nice(int); 333 334/* Timeouts */ 335typedef void timeout_t(void *); /* timeout function type */ 336#define CALLOUT_HANDLE_INITIALIZER(handle) \ 337 { NULL } 338 339void callout_handle_init(struct callout_handle *); 340struct callout_handle timeout(timeout_t *, void *, int); 341void untimeout(timeout_t *, void *, struct callout_handle); 342 343/* Stubs for obsolete functions that used to be for interrupt management */ 344static __inline intrmask_t splbio(void) { return 0; } 345static __inline intrmask_t splcam(void) { return 0; } 346static __inline intrmask_t splclock(void) { return 0; } 347static __inline intrmask_t splhigh(void) { return 0; } 348static __inline intrmask_t splimp(void) { return 0; } 349static __inline intrmask_t splnet(void) { return 0; } 350static __inline intrmask_t spltty(void) { return 0; } 351static __inline intrmask_t splvm(void) { return 0; } 352static __inline void splx(intrmask_t ipl __unused) { return; } 353 354/* 355 * Common `proc' functions are declared here so that proc.h can be included 356 * less often. 357 */ 358int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg, 359 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1); 360#define msleep(chan, mtx, pri, wmesg, timo) \ 361 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \ 362 tick_sbt * (timo), 0, C_HARDCLOCK) 363#define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \ 364 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \ 365 (flags)) 366int msleep_spin_sbt(void *chan, struct mtx *mtx, const char *wmesg, 367 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1); 368#define msleep_spin(chan, mtx, wmesg, timo) \ 369 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \ 370 0, C_HARDCLOCK) 371int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr, 372 int flags); 373#define pause(wmesg, timo) \ 374 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK) 375#define tsleep(chan, pri, wmesg, timo) \ 376 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \ 377 0, C_HARDCLOCK) 378#define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \ 379 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags)) 380void wakeup(void *chan) __nonnull(1); 381void wakeup_one(void *chan) __nonnull(1); 382 383/* 384 * Common `struct cdev *' stuff are declared here to avoid #include poisoning 385 */ 386 387struct cdev; 388dev_t dev2udev(struct cdev *x); 389const char *devtoname(struct cdev *cdev); 390 391int poll_no_poll(int events); 392 393/* XXX: Should be void nanodelay(u_int nsec); */ 394void DELAY(int usec); 395 396/* Root mount holdback API */ 397struct root_hold_token; 398 399struct root_hold_token *root_mount_hold(const char *identifier); 400void root_mount_rel(struct root_hold_token *h); 401void root_mount_wait(void); 402int root_mounted(void); 403 404 405/* 406 * Unit number allocation API. (kern/subr_unit.c) 407 */ 408struct unrhdr; 409struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex); 410void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex); 411void delete_unrhdr(struct unrhdr *uh); 412void clean_unrhdr(struct unrhdr *uh); 413void clean_unrhdrl(struct unrhdr *uh); 414int alloc_unr(struct unrhdr *uh); 415int alloc_unr_specific(struct unrhdr *uh, u_int item); 416int alloc_unrl(struct unrhdr *uh); 417void free_unr(struct unrhdr *uh, u_int item); 418 419/* 420 * Population count algorithm using SWAR approach 421 * - "SIMD Within A Register". 422 */ 423static __inline uint32_t 424bitcount32(uint32_t x) 425{ 426 427 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1); 428 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2); 429 x = (x + (x >> 4)) & 0x0f0f0f0f; 430 x = (x + (x >> 8)); 431 x = (x + (x >> 16)) & 0x000000ff; 432 return (x); 433} 434 435static __inline uint16_t 436bitcount16(uint32_t x) 437{ 438 439 x = (x & 0x5555) + ((x & 0xaaaa) >> 1); 440 x = (x & 0x3333) + ((x & 0xcccc) >> 2); 441 x = (x + (x >> 4)) & 0x0f0f; 442 x = (x + (x >> 8)) & 0x00ff; 443 return (x); 444} 445 446void intr_prof_stack_use(struct thread *td, struct trapframe *frame); 447 448#endif /* !_SYS_SYSTM_H_ */ 449