systm.h revision 192323
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: head/sys/sys/systm.h 192323 2009-05-18 18:37:18Z marcel $ 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 securelevel; /* system security level (see init(8)) */ 49 50extern int cold; /* nonzero if we are doing a cold boot */ 51extern int rebooting; /* boot() has been called. */ 52extern const char *panicstr; /* panic message */ 53extern char version[]; /* system version */ 54extern char copyright[]; /* system copyright */ 55extern int kstack_pages; /* number of kernel stack pages */ 56 57extern int nswap; /* size of swap space */ 58 59extern long physmem; /* physical memory */ 60extern long realmem; /* 'real' memory */ 61 62extern char *rootdevnames[2]; /* names of possible root devices */ 63 64extern int boothowto; /* reboot flags, from console subsystem */ 65extern int bootverbose; /* nonzero to print verbose messages */ 66 67extern int maxusers; /* system tune hint */ 68 69#ifdef INVARIANTS /* The option is always available */ 70#define KASSERT(exp,msg) do { \ 71 if (__predict_false(!(exp))) \ 72 panic msg; \ 73} while (0) 74#define VNASSERT(exp, vp, msg) do { \ 75 if (__predict_false(!(exp))) { \ 76 vn_printf(vp, "VNASSERT failed\n"); \ 77 panic msg; \ 78 } \ 79} while (0) 80#else 81#define KASSERT(exp,msg) do { \ 82} while (0) 83 84#define VNASSERT(exp, vp, msg) do { \ 85} while (0) 86#endif 87 88#ifndef CTASSERT /* Allow lint to override */ 89#define CTASSERT(x) _CTASSERT(x, __LINE__) 90#define _CTASSERT(x, y) __CTASSERT(x, y) 91#define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1] 92#endif 93 94/* 95 * XXX the hints declarations are even more misplaced than most declarations 96 * in this file, since they are needed in one file (per arch) and only used 97 * in two files. 98 * XXX most of these variables should be const. 99 */ 100extern int osreldate; 101extern int envmode; 102extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */ 103extern int dynamic_kenv; 104extern struct mtx kenv_lock; 105extern char *kern_envp; 106extern char static_env[]; 107extern char static_hints[]; /* by config for now */ 108 109extern char **kenvp; 110 111/* 112 * General function declarations. 113 */ 114 115struct inpcb; 116struct lock_object; 117struct malloc_type; 118struct mtx; 119struct proc; 120struct socket; 121struct thread; 122struct tty; 123struct ucred; 124struct uio; 125struct _jmp_buf; 126 127int setjmp(struct _jmp_buf *); 128void longjmp(struct _jmp_buf *, int) __dead2; 129int dumpstatus(vm_offset_t addr, off_t count); 130int nullop(void); 131int eopnotsupp(void); 132int ureadc(int, struct uio *); 133void hashdestroy(void *, struct malloc_type *, u_long); 134void *hashinit(int count, struct malloc_type *type, u_long *hashmark); 135void *hashinit_flags(int count, struct malloc_type *type, 136 u_long *hashmask, int flags); 137#define HASH_NOWAIT 0x00000001 138#define HASH_WAITOK 0x00000002 139 140void *phashinit(int count, struct malloc_type *type, u_long *nentries); 141void g_waitidle(void); 142 143#ifdef RESTARTABLE_PANICS 144void panic(const char *, ...) __printflike(1, 2); 145#else 146void panic(const char *, ...) __dead2 __printflike(1, 2); 147#endif 148 149void cpu_boot(int); 150void cpu_flush_dcache(void *, size_t); 151void cpu_rootconf(void); 152void critical_enter(void); 153void critical_exit(void); 154void init_param1(void); 155void init_param2(long physpages); 156void init_param3(long kmempages); 157void tablefull(const char *); 158int kvprintf(char const *, void (*)(int, void*), void *, int, 159 __va_list) __printflike(1, 0); 160void log(int, const char *, ...) __printflike(2, 3); 161void log_console(struct uio *); 162int printf(const char *, ...) __printflike(1, 2); 163int snprintf(char *, size_t, const char *, ...) __printflike(3, 4); 164int sprintf(char *buf, const char *, ...) __printflike(2, 3); 165int uprintf(const char *, ...) __printflike(1, 2); 166int vprintf(const char *, __va_list) __printflike(1, 0); 167int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0); 168int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0); 169int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0); 170int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3); 171int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2); 172int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2); 173long strtol(const char *, char **, int) __nonnull(1); 174u_long strtoul(const char *, char **, int) __nonnull(1); 175quad_t strtoq(const char *, char **, int) __nonnull(1); 176u_quad_t strtouq(const char *, char **, int) __nonnull(1); 177void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4); 178void hexdump(const void *ptr, int length, const char *hdr, int flags); 179#define HD_COLUMN_MASK 0xff 180#define HD_DELIM_MASK 0xff00 181#define HD_OMIT_COUNT (1 << 16) 182#define HD_OMIT_HEX (1 << 17) 183#define HD_OMIT_CHARS (1 << 18) 184 185#define ovbcopy(f, t, l) bcopy((f), (t), (l)) 186void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2); 187void bzero(void *buf, size_t len) __nonnull(1); 188 189void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2); 190void *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2); 191 192int copystr(const void * __restrict kfaddr, void * __restrict kdaddr, 193 size_t len, size_t * __restrict lencopied) 194 __nonnull(1) __nonnull(2); 195int copyinstr(const void * __restrict udaddr, void * __restrict kaddr, 196 size_t len, size_t * __restrict lencopied) 197 __nonnull(1) __nonnull(2); 198int copyin(const void * __restrict udaddr, void * __restrict kaddr, 199 size_t len) __nonnull(1) __nonnull(2); 200int copyout(const void * __restrict kaddr, void * __restrict udaddr, 201 size_t len) __nonnull(1) __nonnull(2); 202 203int fubyte(const void *base); 204long fuword(const void *base); 205int fuword16(void *base); 206int32_t fuword32(const void *base); 207int64_t fuword64(const void *base); 208int subyte(void *base, int byte); 209int suword(void *base, long word); 210int suword16(void *base, int word); 211int suword32(void *base, int32_t word); 212int suword64(void *base, int64_t word); 213uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval); 214u_long casuword(volatile u_long *p, u_long oldval, u_long newval); 215 216void realitexpire(void *); 217 218int sysbeep(int hertz, int period); 219 220void hardclock(int usermode, uintfptr_t pc); 221void hardclock_cpu(int usermode); 222void softclock(void *); 223void statclock(int usermode); 224void profclock(int usermode, uintfptr_t pc); 225 226void startprofclock(struct proc *); 227void stopprofclock(struct proc *); 228void cpu_startprofclock(void); 229void cpu_stopprofclock(void); 230 231int cr_cansee(struct ucred *u1, struct ucred *u2); 232int cr_canseesocket(struct ucred *cred, struct socket *so); 233int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp); 234 235char *getenv(const char *name); 236void freeenv(char *env); 237int getenv_int(const char *name, int *data); 238int getenv_uint(const char *name, unsigned int *data); 239int getenv_long(const char *name, long *data); 240int getenv_ulong(const char *name, unsigned long *data); 241int getenv_string(const char *name, char *data, int size); 242int getenv_quad(const char *name, quad_t *data); 243int setenv(const char *name, const char *value); 244int unsetenv(const char *name); 245int testenv(const char *name); 246 247typedef uint64_t (cpu_tick_f)(void); 248void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var); 249extern cpu_tick_f *cpu_ticks; 250uint64_t cpu_tickrate(void); 251uint64_t cputick2usec(uint64_t tick); 252 253#ifdef APM_FIXUP_CALLTODO 254struct timeval; 255void adjust_timeout_calltodo(struct timeval *time_change); 256#endif /* APM_FIXUP_CALLTODO */ 257 258#include <sys/libkern.h> 259 260/* Initialize the world */ 261void consinit(void); 262void cpu_initclocks(void); 263void usrinfoinit(void); 264 265/* Finalize the world */ 266void shutdown_nice(int); 267 268/* Timeouts */ 269typedef void timeout_t(void *); /* timeout function type */ 270#define CALLOUT_HANDLE_INITIALIZER(handle) \ 271 { NULL } 272 273void callout_handle_init(struct callout_handle *); 274struct callout_handle timeout(timeout_t *, void *, int); 275void untimeout(timeout_t *, void *, struct callout_handle); 276caddr_t kern_timeout_callwheel_alloc(caddr_t v); 277void kern_timeout_callwheel_init(void); 278 279/* Stubs for obsolete functions that used to be for interrupt management */ 280static __inline void spl0(void) { return; } 281static __inline intrmask_t splbio(void) { return 0; } 282static __inline intrmask_t splcam(void) { return 0; } 283static __inline intrmask_t splclock(void) { return 0; } 284static __inline intrmask_t splhigh(void) { return 0; } 285static __inline intrmask_t splimp(void) { return 0; } 286static __inline intrmask_t splnet(void) { return 0; } 287static __inline intrmask_t splsoftcam(void) { return 0; } 288static __inline intrmask_t splsoftclock(void) { return 0; } 289static __inline intrmask_t splsofttty(void) { return 0; } 290static __inline intrmask_t splsoftvm(void) { return 0; } 291static __inline intrmask_t splsofttq(void) { return 0; } 292static __inline intrmask_t splstatclock(void) { return 0; } 293static __inline intrmask_t spltty(void) { return 0; } 294static __inline intrmask_t splvm(void) { return 0; } 295static __inline void splx(intrmask_t ipl __unused) { return; } 296 297/* 298 * Common `proc' functions are declared here so that proc.h can be included 299 * less often. 300 */ 301int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg, 302 int timo) __nonnull(1); 303#define msleep(chan, mtx, pri, wmesg, timo) \ 304 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (timo)) 305int msleep_spin(void *chan, struct mtx *mtx, const char *wmesg, int timo) 306 __nonnull(1); 307int pause(const char *wmesg, int timo); 308#define tsleep(chan, pri, wmesg, timo) \ 309 _sleep((chan), NULL, (pri), (wmesg), (timo)) 310void wakeup(void *chan) __nonnull(1); 311void wakeup_one(void *chan) __nonnull(1); 312 313/* 314 * Common `struct cdev *' stuff are declared here to avoid #include poisoning 315 */ 316 317struct cdev; 318dev_t dev2udev(struct cdev *x); 319const char *devtoname(struct cdev *cdev); 320 321int poll_no_poll(int events); 322 323/* XXX: Should be void nanodelay(u_int nsec); */ 324void DELAY(int usec); 325 326/* Root mount holdback API */ 327struct root_hold_token; 328 329struct root_hold_token *root_mount_hold(const char *identifier); 330void root_mount_rel(struct root_hold_token *h); 331void root_mount_wait(void); 332int root_mounted(void); 333 334 335/* 336 * Unit number allocation API. (kern/subr_unit.c) 337 */ 338struct unrhdr; 339struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex); 340void delete_unrhdr(struct unrhdr *uh); 341void clean_unrhdr(struct unrhdr *uh); 342void clean_unrhdrl(struct unrhdr *uh); 343int alloc_unr(struct unrhdr *uh); 344int alloc_unrl(struct unrhdr *uh); 345void free_unr(struct unrhdr *uh, u_int item); 346 347/* 348 * This is about as magic as it gets. fortune(1) has got similar code 349 * for reversing bits in a word. Who thinks up this stuff?? 350 * 351 * Yes, it does appear to be consistently faster than: 352 * while (i = ffs(m)) { 353 * m >>= i; 354 * bits++; 355 * } 356 * and 357 * while (lsb = (m & -m)) { // This is magic too 358 * m &= ~lsb; // or: m ^= lsb 359 * bits++; 360 * } 361 * Both of these latter forms do some very strange things on gcc-3.1 with 362 * -mcpu=pentiumpro and/or -march=pentiumpro and/or -O or -O2. 363 * There is probably an SSE or MMX popcnt instruction. 364 * 365 * I wonder if this should be in libkern? 366 * 367 * XXX Stop the presses! Another one: 368 * static __inline u_int32_t 369 * popcnt1(u_int32_t v) 370 * { 371 * v -= ((v >> 1) & 0x55555555); 372 * v = (v & 0x33333333) + ((v >> 2) & 0x33333333); 373 * v = (v + (v >> 4)) & 0x0F0F0F0F; 374 * return (v * 0x01010101) >> 24; 375 * } 376 * The downside is that it has a multiply. With a pentium3 with 377 * -mcpu=pentiumpro and -march=pentiumpro then gcc-3.1 will use 378 * an imull, and in that case it is faster. In most other cases 379 * it appears slightly slower. 380 * 381 * Another variant (also from fortune): 382 * #define BITCOUNT(x) (((BX_(x)+(BX_(x)>>4)) & 0x0F0F0F0F) % 255) 383 * #define BX_(x) ((x) - (((x)>>1)&0x77777777) \ 384 * - (((x)>>2)&0x33333333) \ 385 * - (((x)>>3)&0x11111111)) 386 */ 387static __inline uint32_t 388bitcount32(uint32_t x) 389{ 390 391 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1); 392 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2); 393 x = (x + (x >> 4)) & 0x0f0f0f0f; 394 x = (x + (x >> 8)); 395 x = (x + (x >> 16)) & 0x000000ff; 396 return (x); 397} 398 399#endif /* !_SYS_SYSTM_H_ */ 400