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 /* 121 * General function declarations. 122 */ 123 124 struct intrframe; 125 struct spinlock; 126 struct lock; 127 struct mtx; 128 struct lwkt_serialize; 129 struct malloc_type; 130 struct proc; 131 struct timeval; 132 struct tty; 133 struct uio; 134 struct globaldata; 135 struct thread; 136 struct trapframe; 137 struct user; 138 struct vmspace; 139 struct savetls; 140 struct krate; 141 struct _jmp_buf; 142 143 void Debugger (const char *msg); 144 void print_backtrace(int count); 145 void mi_gdinit (struct globaldata *gd, int cpu); 146 void slab_gdinit (struct globaldata *gd); 147 void mi_proc0init(struct globaldata *gd, struct user *proc0paddr); 148 int setjmp(struct _jmp_buf *) __returns_twice; 149 void longjmp(struct _jmp_buf *, int) __dead2; 150 int nullop (void); 151 int seltrue (cdev_t dev, int which); 152 int ureadc (int, struct uio *); 153 void *hashinit (int count, struct malloc_type *type, u_long *hashmask); 154 void hashdestroy(void *vhashtbl, struct malloc_type *type, u_long hashmask); 155 void *phashinit (int count, struct malloc_type *type, u_long *nentries); 156 void *hashinit_ext (int count, size_t size, 157 struct malloc_type *type, u_long *hashmask); 158 void *phashinit_ext (int count, size_t size, 159 struct malloc_type *type, u_long *nentries); 160 161 int cpu_sanitize_frame (struct trapframe *); 162 int cpu_sanitize_tls (struct savetls *); 163 void cpu_spinlock_contested(void); 164 void cpu_halt (void) __dead2; 165 void cpu_reset (void); 166 void cpu_boot (int); 167 void cpu_rootconf (void); 168 void cpu_vmspace_alloc(struct vmspace *); 169 void cpu_vmspace_free(struct vmspace *); 170 void cpu_vkernel_trap(struct trapframe *, int); 171 enum vmm_guest_type detect_virtual(void); 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 /* 179 * Old CRC32 API 180 */ 181 extern const uint32_t crc32_tab[]; 182 uint32_t crc32(const void *buf, size_t size); 183 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc); 184 185 /* 186 * Newer (fast) iscsi CRC32 APIs. 187 * 188 * NOTE: iscsi_crc32_ext() inverts ocrc input and output as expected, 189 * pass a seed of 0 for the equivalent of iscsi_crc32(). 190 * 191 * calculate_crc32c() does not invert crc32c input and output 192 * to maintain FreeBSD API compatibility. 193 */ 194 uint32_t iscsi_crc32(const void *buf, size_t size); 195 uint32_t iscsi_crc32_ext(const void *buf, size_t size, uint32_t ocrc); 196 uint32_t calculate_crc32c(uint32_t crc32c, const unsigned char *buffer, 197 unsigned int length); 198 199 void init_param1 (void); 200 void init_param2 (int physpages); 201 void tablefull (const char *); 202 int kvcprintf (char const *, void (*)(int, void*), void *, int, 203 __va_list) __printflike(1, 0); 204 void kvcreinitspin(void); 205 int log (int, const char *, ...) __printflike(2, 3); 206 void logwakeup (void); 207 void log_console (struct uio *); 208 int kprintf (const char *, ...) __printflike(1, 2); 209 void kprintf0 (const char *, ...) __printflike(1, 2); 210 void krateprintf (struct krate *, const char *, ...) __printflike(2, 3); 211 int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4); 212 int ksnrprintf (char *, size_t, int, const char *, ...) __printflike(4, 5); 213 int ksprintf (char *buf, const char *, ...) __printflike(2, 3); 214 int uprintf (const char *, ...) __printflike(1, 2); 215 int kvprintf (const char *, __va_list) __printflike(1, 0); 216 int kvsnprintf (char *, size_t, const char *, 217 __va_list) __printflike(3, 0); 218 int kvsnrprintf (char *, size_t, int, const char *, 219 __va_list) __printflike(4, 0); 220 int kvasnrprintf (char **, size_t, int, const char *, 221 __va_list) __printflike(4, 0); 222 int kvsprintf (char *buf, const char *, 223 __va_list) __printflike(2, 0); 224 int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3); 225 void hexdump (const void *ptr, int length, const char *hdr, int flags); 226 void kprint_cpuset(cpumask_t *mask); 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 int ksscanf(const char *, char const *, ...) 233 __nonnull(1) __nonnull(2) __scanflike(2, 3); 234 int kvsscanf(const char *, char const *, __va_list) 235 __nonnull(1) __nonnull(2) __scanflike(2, 0); 236 void kvasfree(char **); 237 238 long strtol(const char *, char **, int) __nonnull(1); 239 u_long strtoul(const char *, char **, int) __nonnull(1); 240 quad_t strtoq(const char *, char **, int) __nonnull(1); 241 u_quad_t strtouq(const char *, char **, int) __nonnull(1); 242 243 /* 244 * note: some functions commonly used by device drivers may be passed 245 * pointers to volatile storage, volatile set to avoid warnings. 246 * 247 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is 248 * explicitly not meant to be sophisticated. 249 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes). 250 * This routine is explicitly not meant to be sophisticated. 251 */ 252 void bcopyb(const void *from, void *to, size_t len) 253 __nonnull(1) __nonnull(2); 254 void bcopyi(const void *from, void *to, size_t len) 255 __nonnull(1) __nonnull(2); 256 void bcopy(volatile const void *from, volatile void *to, size_t len) 257 __nonnull(1) __nonnull(2); 258 void ovbcopy(const void *from, void *to, size_t len) 259 __nonnull(1) __nonnull(2); 260 void bzero(volatile void *buf, size_t len) __nonnull(1); 261 void bzeront(volatile void *buf, size_t len) __nonnull(1); 262 void *memcpy(void *to, const void *from, size_t len) 263 __nonnull(1) __nonnull(2); 264 265 int copystr (const void *kfaddr, void *kdaddr, size_t len, 266 size_t *lencopied) __nonnull(1) __nonnull(2); 267 int copyinstr (const void *udaddr, void *kaddr, size_t len, 268 size_t *lencopied) __nonnull(1) __nonnull(2); 269 int copyin(const void *udaddr, void *kaddr, size_t len) 270 __nonnull(1) __nonnull(2); 271 int copyin_nofault(const void *udaddr, void *kaddr, size_t len) 272 __nonnull(1) __nonnull(2); 273 int copyout(const void *kaddr, void *udaddr, size_t len) 274 __nonnull(1) __nonnull(2); 275 int copyout_nofault(const void *kaddr, void *udaddr, size_t len) 276 __nonnull(1) __nonnull(2); 277 278 int fubyte (const void *base); 279 int subyte (void *base, int byte); 280 long fuword (const void *base); 281 int suword (void *base, long word); 282 int suword32 (void *base, int word); 283 int fusword (void *base); 284 int susword (void *base, int word); 285 u_long casuword(volatile u_long *p, u_long oldval, u_long newval); 286 287 void realitexpire (void *); 288 void DELAY(int usec); 289 void DRIVERSLEEP(int usec); 290 291 void startprofclock (struct proc *); 292 void stopprofclock (struct proc *); 293 void setstatclockrate (int hzrate); 294 295 /* 296 * Kernel environment support functions and sundry. 297 */ 298 char *kgetenv (const char *name); 299 int ksetenv(const char *name, const char *value); 300 int kunsetenv(const char *name); 301 void kfreeenv(char *env); 302 int ktestenv(const char *name); 303 int kgetenv_int (const char *name, int *data); 304 int kgetenv_string (const char *name, char *data, int size); 305 int kgetenv_ulong(const char *name, unsigned long *data); 306 int kgetenv_quad (const char *name, quad_t *data); 307 int kgetenv_long(const char *name, long *data); 308 extern char *kern_envp; 309 310 #ifdef APM_FIXUP_CALLTODO 311 void adjust_timeout_calltodo (struct timeval *time_change); 312 #endif /* APM_FIXUP_CALLTODO */ 313 314 #include <sys/libkern.h> 315 316 /* Initialize the world */ 317 void mi_startup (void); 318 void nchinit (void); 319 320 /* Finalize the world. */ 321 void shutdown_nice (int); 322 323 /* 324 * Kernel to clock driver interface. 325 */ 326 void inittodr (time_t base); 327 void resettodr (void); 328 void startrtclock (void); 329 330 /* Timeouts */ 331 typedef void timeout_t (void *); /* timeout function type */ 332 333 /* Interrupt management */ 334 335 /* 336 * For the alpha arch, some of these functions are static __inline, and 337 * the others should be. 338 */ 339 #if defined(__x86_64__) 340 void setdelayed (void); 341 void setsoftcambio (void); 342 void setsoftcamnet (void); 343 void setsoftunused02 (void); 344 void setsoftcrypto (void); 345 void setsoftunused01 (void); 346 void setsofttty (void); 347 void setsoftvm (void); 348 void setsofttq (void); 349 void schedsofttty (void); 350 void splz (void); 351 void splz_check (void); 352 void cpu_mmw_pause_int(int*, int, int, int); 353 void cpu_mmw_pause_long(long*, long, int, int); 354 #endif /* __x86_64__ */ 355 356 /* 357 * Various callout lists. 358 */ 359 360 /* Exit callout list declarations. */ 361 typedef void (*exitlist_fn) (struct thread *td); 362 363 int at_exit (exitlist_fn function); 364 int rm_at_exit (exitlist_fn function); 365 366 /* Fork callout list declarations. */ 367 typedef void (*forklist_fn) (struct proc *parent, struct proc *child, 368 int flags); 369 370 int at_fork (forklist_fn function); 371 int rm_at_fork (forklist_fn function); 372 373 extern struct globaldata *panic_cpu_gd; 374 375 /* 376 * Common `proc' functions are declared here so that proc.h can be included 377 * less often. 378 */ 379 int tsleep(const volatile void *, int, const char *, int) __nonnull(1); 380 int ssleep(const volatile void *, struct spinlock *, int, const char *, int) 381 __nonnull(1); 382 int lksleep(const volatile void *, struct lock *, int, const char *, int) 383 __nonnull(1); 384 int mtxsleep(const volatile void *, struct mtx *, int, const char *, int) 385 __nonnull(1); 386 int zsleep(const volatile void *, struct lwkt_serialize *, int, const char *, int) 387 __nonnull(1); 388 void tsleep_interlock(const volatile void *, int) __nonnull(1); 389 void tsleep_remove (struct thread *); 390 int lwkt_sleep (const char *, int); 391 void tstop (void); 392 void wakeup(const volatile void *chan) __nonnull(1); 393 void wakeup_one(const volatile void *chan) __nonnull(1); 394 void wakeup_mycpu(const volatile void *chan) __nonnull(1); 395 void wakeup_mycpu_one(const volatile void *chan) __nonnull(1); 396 void wakeup_oncpu(struct globaldata *gd, const volatile void *chan) 397 __nonnull(2); 398 void wakeup_oncpu_one(struct globaldata *gd, const volatile void *chan) 399 __nonnull(2); 400 void wakeup_domain(const volatile void *chan, int domain) __nonnull(1); 401 void wakeup_domain_one(const volatile void *chan, int domain) __nonnull(1); 402 void wakeup_start_delayed(void); 403 void wakeup_end_delayed(void); 404 405 /* 406 * Common `cdev_t' stuff are declared here to avoid #include poisoning 407 */ 408 409 int major(cdev_t x); 410 int minor(cdev_t x); 411 udev_t dev2udev(cdev_t x); 412 cdev_t udev2dev(udev_t x, int b); 413 int uminor(udev_t dev); 414 int umajor(udev_t dev); 415 udev_t makeudev(int x, int y); 416 417 /* 418 * Unit number allocation API. (kern/subr_unit.c) 419 */ 420 struct unrhdr; 421 struct unrhdr *new_unrhdr(int low, int high, struct lock *lock); 422 void delete_unrhdr(struct unrhdr *uh); 423 int alloc_unr(struct unrhdr *uh); 424 int alloc_unrl(struct unrhdr *uh); 425 void free_unr(struct unrhdr *uh, u_int item); 426 427 /* 428 * Population count algorithm using SWAR approach 429 * - "SIMD Within A Register". 430 */ 431 432 static __inline uint16_t 433 bitcount16(uint32_t x) 434 { 435 436 x = (x & 0x5555) + ((x & 0xaaaa) >> 1); 437 x = (x & 0x3333) + ((x & 0xcccc) >> 2); 438 x = (x + (x >> 4)) & 0x0f0f; 439 x = (x + (x >> 8)) & 0x00ff; 440 return (x); 441 } 442 443 static __inline uint32_t 444 bitcount32(uint32_t x) 445 { 446 447 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1); 448 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2); 449 x = (x + (x >> 4)) & 0x0f0f0f0f; 450 x = (x + (x >> 8)); 451 x = (x + (x >> 16)) & 0x000000ff; 452 return (x); 453 } 454 455 static __inline uint64_t 456 bitcount64(uint64_t x) 457 { 458 459 x = (x & 0x5555555555555555) + ((x & 0xaaaaaaaaaaaaaaaa) >> 1); 460 x = (x & 0x3333333333333333) + ((x & 0xcccccccccccccccc) >> 2); 461 x = (x + (x >> 4)) & 0x0f0f0f0f0f0f0f0f; 462 x = (x + (x >> 8)); 463 x = (x + (x >> 16)); 464 x = (x + (x >> 32)) & 0x000000ff; 465 return (x); 466 } 467 468 #endif /* _KERNEL */ 469 #endif /* !_SYS_SYSTM_H_ */ 470