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 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the University of 21 * California, Berkeley and its contributors. 22 * 4. Neither the name of the University nor the names of its contributors 23 * may be used to endorse or promote products derived from this software 24 * without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36 * SUCH DAMAGE. 37 * 38 * @(#)systm.h 8.7 (Berkeley) 3/29/95 39 * $FreeBSD: src/sys/sys/systm.h,v 1.111.2.18 2002/12/17 18:04:02 sam Exp $ 40 */ 41 42 #ifndef _SYS_SYSTM_H_ 43 #define _SYS_SYSTM_H_ 44 45 #ifndef _KERNEL 46 #error "This file should not be included by userland programs." 47 #else 48 49 #ifndef _MACHINE_TYPES_H_ 50 #include <machine/types.h> 51 #endif 52 #include <machine/stdarg.h> 53 #include <machine/atomic.h> 54 #include <machine/cpufunc.h> 55 #include <sys/callout.h> 56 57 extern int securelevel; /* system security level (see init(8)) */ 58 extern int kernel_mem_readonly; /* disable writes to kernel memory */ 59 60 extern int cold; /* nonzero if we are doing a cold boot */ 61 extern int tsleep_now_works; /* tsleep won't just return any more */ 62 extern const char *panicstr; /* panic message */ 63 extern int dumping; /* system is dumping */ 64 extern int safepri; /* safe ipl when cold or panicing */ 65 extern int osreldate; /* System release date */ 66 extern char version[]; /* system version */ 67 extern char copyright[]; /* system copyright */ 68 69 extern int selwait; /* select timeout address */ 70 71 extern u_char curpriority; /* priority of current process */ 72 extern int cpu_mwait_spin; /* typically set in machdep, used by lwkt */ 73 74 extern long physmem; /* physical memory */ 75 76 extern cdev_t dumpdev; /* dump device */ 77 extern u_int64_t dumplo64; /* block number into dumpdev, start of dump */ 78 79 extern cdev_t rootdev; /* root device */ 80 extern cdev_t rootdevs[2]; /* possible root devices */ 81 extern char *rootdevnames[2]; /* names of possible root devices */ 82 extern char *ZeroPage; 83 84 extern int boothowto; /* reboot flags, from console subsystem */ 85 extern int bootverbose; /* nonzero to print verbose messages */ 86 87 extern int maxusers; /* system tune hint */ 88 89 extern int ncpus; /* total number of cpus (real, hyper, virtual)*/ 90 extern int ncpus2; /* ncpus rounded down to power of 2 */ 91 extern int ncpus2_shift; /* log base 2 of ncpus2 */ 92 extern int ncpus2_mask; /* ncpus2 - 1 */ 93 extern int ncpus_fit; /* round up to a power of 2 */ 94 extern int ncpus_fit_mask; /* ncpus_fit - 1 */ 95 extern int clocks_running; /* timing/timeout subsystem is operational */ 96 97 /* XXX TGEN these don't belong here, they're MD on i386/x86_64 */ 98 extern u_int cpu_feature; /* CPUID_* features */ 99 extern u_int cpu_feature2; /* CPUID2_* features */ 100 extern u_int cpu_mi_feature; /* CPU_MI_XXX machine-nonspecific features */ 101 extern cpumask_t usched_global_cpumask; 102 103 extern int nfs_diskless_valid; /* NFS diskless params were obtained */ 104 extern vm_paddr_t Maxmem; /* Highest physical memory address in system */ 105 106 #ifdef INVARIANTS /* The option is always available */ 107 #define KASSERT(exp,msg) do { if (__predict_false(!(exp))) \ 108 panic msg; } while (0) 109 #define KKASSERT(exp) do { if (__predict_false(!(exp))) \ 110 panic("assertion \"%s\" failed " \ 111 "in %s at %s:%u", #exp, __func__, \ 112 __FILE__, __LINE__); } while (0) 113 #define __debugvar 114 #else 115 #define KASSERT(exp,msg) 116 #define KKASSERT(exp) 117 #define __debugvar __attribute__((__unused__)) 118 #endif 119 120 #define CTASSERT(x) _CTASSERT(x, __LINE__) 121 #define _CTASSERT(x, y) __CTASSERT(x, y) 122 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1] 123 124 /* 125 * General function declarations. 126 */ 127 128 struct intrframe; 129 struct spinlock; 130 struct lock; 131 struct mtx; 132 struct lwkt_serialize; 133 struct malloc_type; 134 struct proc; 135 struct xwait; 136 struct timeval; 137 struct tty; 138 struct uio; 139 struct globaldata; 140 struct thread; 141 struct trapframe; 142 struct user; 143 struct vmspace; 144 struct savetls; 145 struct krate; 146 147 void Debugger (const char *msg); 148 void print_backtrace(int count); 149 void mi_gdinit (struct globaldata *gd, int cpu); 150 void mi_proc0init(struct globaldata *gd, struct user *proc0paddr); 151 int nullop (void); 152 int seltrue (cdev_t dev, int which); 153 int ureadc (int, struct uio *); 154 void *hashinit (int count, struct malloc_type *type, u_long *hashmask); 155 void hashdestroy(void *vhashtbl, struct malloc_type *type, u_long hashmask); 156 void *phashinit (int count, struct malloc_type *type, u_long *nentries); 157 void *hashinit_ext (int count, size_t size, 158 struct malloc_type *type, u_long *hashmask); 159 void *phashinit_ext (int count, size_t size, 160 struct malloc_type *type, u_long *nentries); 161 162 int cpu_sanitize_frame (struct trapframe *); 163 int cpu_sanitize_tls (struct savetls *); 164 void cpu_spinlock_contested(void); 165 void cpu_halt (void); 166 void cpu_reset (void); 167 void cpu_boot (int); 168 void cpu_rootconf (void); 169 void cpu_vmspace_alloc(struct vmspace *); 170 void cpu_vmspace_free(struct vmspace *); 171 void cpu_vkernel_trap(struct trapframe *, int); 172 void set_user_TLS(void); 173 void set_vkernel_fp(struct trapframe *); 174 int kvm_access_check(vm_offset_t, vm_offset_t, int); 175 176 vm_paddr_t kvtop(void *addr); 177 178 extern uint32_t crc32_tab[]; 179 uint32_t crc32(const void *buf, size_t size); 180 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc); 181 uint32_t iscsi_crc32(const void *buf, size_t size); 182 uint32_t iscsi_crc32_ext(const void *buf, size_t size, uint32_t ocrc); 183 void init_param1 (void); 184 void init_param2 (int physpages); 185 void tablefull (const char *); 186 int kvcprintf (char const *, void (*)(int, void*), void *, int, 187 __va_list) __printflike(1, 0); 188 void kvcreinitspin(void); 189 int log (int, const char *, ...) __printflike(2, 3); 190 void logwakeup (void); 191 void log_console (struct uio *); 192 int kprintf (const char *, ...) __printflike(1, 2); 193 void kprintf0 (const char *, ...) __printflike(1, 2); 194 void krateprintf (struct krate *, const char *, ...) __printflike(2, 3); 195 int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4); 196 int ksnrprintf (char *, size_t, int, const char *, ...) __printflike(4, 5); 197 int ksprintf (char *buf, const char *, ...) __printflike(2, 3); 198 int uprintf (const char *, ...) __printflike(1, 2); 199 int kvprintf (const char *, __va_list) __printflike(1, 0); 200 int kvsnprintf (char *, size_t, const char *, 201 __va_list) __printflike(3, 0); 202 int kvsnrprintf (char *, size_t, int, const char *, 203 __va_list) __printflike(4, 0); 204 int kvasnrprintf (char **, size_t, int, const char *, 205 __va_list) __printflike(4, 0); 206 int kvsprintf (char *buf, const char *, 207 __va_list) __printflike(2, 0); 208 int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3); 209 void hexdump (const void *ptr, int length, const char *hdr, int flags); 210 #define HD_COLUMN_MASK 0xff 211 #define HD_DELIM_MASK 0xff00 212 #define HD_OMIT_COUNT (1 << 16) 213 #define HD_OMIT_HEX (1 << 17) 214 #define HD_OMIT_CHARS (1 << 18) 215 int ksscanf(const char *, char const *, ...) 216 __nonnull(1) __nonnull(2) __scanflike(2, 3); 217 int kvsscanf(const char *, char const *, __va_list) 218 __nonnull(1) __nonnull(2) __scanflike(2, 0); 219 void kvasfree(char **); 220 221 long strtol(const char *, char **, int) __nonnull(1); 222 u_long strtoul(const char *, char **, int) __nonnull(1); 223 quad_t strtoq(const char *, char **, int) __nonnull(1); 224 u_quad_t strtouq(const char *, char **, int) __nonnull(1); 225 226 /* 227 * note: some functions commonly used by device drivers may be passed 228 * pointers to volatile storage, volatile set to avoid warnings. 229 * 230 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is 231 * explicitly not meant to be sophisticated. 232 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes). 233 * This routine is explicitly not meant to be sophisticated. 234 */ 235 void bcopyb(const void *from, void *to, size_t len) 236 __nonnull(1) __nonnull(2); 237 void bcopyi(const void *from, void *to, size_t len) 238 __nonnull(1) __nonnull(2); 239 void bcopy(volatile const void *from, volatile void *to, size_t len) 240 __nonnull(1) __nonnull(2); 241 void ovbcopy(const void *from, void *to, size_t len) 242 __nonnull(1) __nonnull(2); 243 void bzero(volatile void *buf, size_t len) __nonnull(1); 244 void bzeront(volatile void *buf, size_t len) __nonnull(1); 245 void *memcpy(void *to, const void *from, size_t len) 246 __nonnull(1) __nonnull(2); 247 248 int copystr (const void *kfaddr, void *kdaddr, size_t len, 249 size_t *lencopied) __nonnull(1) __nonnull(2); 250 int copyinstr (const void *udaddr, void *kaddr, size_t len, 251 size_t *lencopied) __nonnull(1) __nonnull(2); 252 int copyin(const void *udaddr, void *kaddr, size_t len) 253 __nonnull(1) __nonnull(2); 254 int copyin_nofault(const void *udaddr, void *kaddr, size_t len) 255 __nonnull(1) __nonnull(2); 256 int copyout(const void *kaddr, void *udaddr, size_t len) 257 __nonnull(1) __nonnull(2); 258 int copyout_nofault(const void *kaddr, void *udaddr, size_t len) 259 __nonnull(1) __nonnull(2); 260 261 int fubyte (const void *base); 262 int subyte (void *base, int byte); 263 long fuword (const void *base); 264 int suword (void *base, long word); 265 int suword32 (void *base, int word); 266 int fusword (void *base); 267 int susword (void *base, int word); 268 u_long casuword(volatile u_long *p, u_long oldval, u_long newval); 269 270 void realitexpire (void *); 271 void DELAY(int usec); 272 void DRIVERSLEEP(int usec); 273 274 void startprofclock (struct proc *); 275 void stopprofclock (struct proc *); 276 void setstatclockrate (int hzrate); 277 278 /* 279 * Kernel environment support functions and sundry. 280 */ 281 char *kgetenv (const char *name); 282 int ksetenv(const char *name, const char *value); 283 int kunsetenv(const char *name); 284 void kfreeenv(char *env); 285 int ktestenv(const char *name); 286 int kgetenv_int (const char *name, int *data); 287 int kgetenv_string (const char *name, char *data, int size); 288 int kgetenv_ulong(const char *name, unsigned long *data); 289 int kgetenv_quad (const char *name, quad_t *data); 290 int kgetenv_long(const char *name, long *data); 291 extern char *kern_envp; 292 293 #ifdef APM_FIXUP_CALLTODO 294 void adjust_timeout_calltodo (struct timeval *time_change); 295 #endif /* APM_FIXUP_CALLTODO */ 296 297 #include <sys/libkern.h> 298 299 /* Initialize the world */ 300 void mi_startup (void); 301 void nchinit (void); 302 303 /* Finalize the world. */ 304 void shutdown_nice (int); 305 306 /* 307 * Kernel to clock driver interface. 308 */ 309 void inittodr (time_t base); 310 void resettodr (void); 311 void startrtclock (void); 312 313 /* Timeouts */ 314 typedef void timeout_t (void *); /* timeout function type */ 315 316 /* Interrupt management */ 317 318 /* 319 * For the alpha arch, some of these functions are static __inline, and 320 * the others should be. 321 */ 322 #if defined(__i386__) || defined(__x86_64__) 323 void setdelayed (void); 324 void setsoftcambio (void); 325 void setsoftcamnet (void); 326 void setsoftunused02 (void); 327 void setsoftcrypto (void); 328 void setsoftunused01 (void); 329 void setsofttty (void); 330 void setsoftvm (void); 331 void setsofttq (void); 332 void schedsofttty (void); 333 void splz (void); 334 void splz_check (void); 335 void cpu_mmw_pause_int(int*, int, int, int); 336 void cpu_mmw_pause_long(long*, long, int, int); 337 #endif /* __i386__ || __x86_64__ */ 338 339 /* 340 * Various callout lists. 341 */ 342 343 /* Exit callout list declarations. */ 344 typedef void (*exitlist_fn) (struct thread *td); 345 346 int at_exit (exitlist_fn function); 347 int rm_at_exit (exitlist_fn function); 348 349 /* Fork callout list declarations. */ 350 typedef void (*forklist_fn) (struct proc *parent, struct proc *child, 351 int flags); 352 353 int at_fork (forklist_fn function); 354 int rm_at_fork (forklist_fn function); 355 356 extern struct globaldata *panic_cpu_gd; 357 358 /* 359 * Common `proc' functions are declared here so that proc.h can be included 360 * less often. 361 */ 362 int tsleep(const volatile void *, int, const char *, int) __nonnull(1); 363 int ssleep(const volatile void *, struct spinlock *, int, const char *, int) 364 __nonnull(1); 365 int lksleep(const volatile void *, struct lock *, int, const char *, int) 366 __nonnull(1); 367 int mtxsleep(const volatile void *, struct mtx *, int, const char *, int) 368 __nonnull(1); 369 int zsleep(const volatile void *, struct lwkt_serialize *, int, const char *, int) 370 __nonnull(1); 371 void tsleep_interlock(const volatile void *, int) __nonnull(1); 372 void tsleep_remove (struct thread *); 373 int lwkt_sleep (const char *, int); 374 void tstop (void); 375 void wakeup(const volatile void *chan) __nonnull(1); 376 void wakeup_one(const volatile void *chan) __nonnull(1); 377 void wakeup_mycpu(const volatile void *chan) __nonnull(1); 378 void wakeup_mycpu_one(const volatile void *chan) __nonnull(1); 379 void wakeup_oncpu(struct globaldata *gd, const volatile void *chan) 380 __nonnull(2); 381 void wakeup_oncpu_one(struct globaldata *gd, const volatile void *chan) 382 __nonnull(2); 383 void wakeup_domain(const volatile void *chan, int domain) __nonnull(1); 384 void wakeup_domain_one(const volatile void *chan, int domain) __nonnull(1); 385 void wakeup_start_delayed(void); 386 void wakeup_end_delayed(void); 387 388 /* 389 * Common `cdev_t' stuff are declared here to avoid #include poisoning 390 */ 391 392 int major(cdev_t x); 393 int minor(cdev_t x); 394 udev_t dev2udev(cdev_t x); 395 cdev_t udev2dev(udev_t x, int b); 396 int uminor(udev_t dev); 397 int umajor(udev_t dev); 398 udev_t makeudev(int x, int y); 399 400 /* 401 * Unit number allocation API. (kern/subr_unit.c) 402 */ 403 struct unrhdr; 404 struct unrhdr *new_unrhdr(int low, int high, struct lock *lock); 405 void delete_unrhdr(struct unrhdr *uh); 406 int alloc_unr(struct unrhdr *uh); 407 int alloc_unrl(struct unrhdr *uh); 408 void free_unr(struct unrhdr *uh, u_int item); 409 410 /* 411 * Population count algorithm using SWAR approach 412 * - "SIMD Within A Register". 413 */ 414 415 static __inline uint16_t 416 bitcount16(uint32_t x) 417 { 418 419 x = (x & 0x5555) + ((x & 0xaaaa) >> 1); 420 x = (x & 0x3333) + ((x & 0xcccc) >> 2); 421 x = (x + (x >> 4)) & 0x0f0f; 422 x = (x + (x >> 8)) & 0x00ff; 423 return (x); 424 } 425 426 static __inline uint32_t 427 bitcount32(uint32_t x) 428 { 429 430 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1); 431 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2); 432 x = (x + (x >> 4)) & 0x0f0f0f0f; 433 x = (x + (x >> 8)); 434 x = (x + (x >> 16)) & 0x000000ff; 435 return (x); 436 } 437 438 #endif /* _KERNEL */ 439 #endif /* !_SYS_SYSTM_H_ */ 440