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