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