sys/sys/systm.h

   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_idle_halt (void);
 159 void    cpu_reset (void);
 160 void    cpu_boot (int);
 161 void    cpu_rootconf (void);
 162 void    cpu_vmspace_alloc(struct vmspace *);
 163 void    cpu_vmspace_free(struct vmspace *);
 164 void    cpu_vkernel_trap(struct trapframe *, int);
 165 enum vmm_guest_type detect_virtual(void);
 166 void    set_user_TLS(void);
 167 void    set_vkernel_fp(struct trapframe *);
 168 int     kvm_access_check(vm_offset_t, vm_offset_t, int);
 169
 170 vm_paddr_t kvtop(void *addr);
 171
 172 /*
 173  * Old CRC32 API
 174  */
 175 extern const uint32_t crc32_tab[];
 176 uint32_t crc32(const void *buf, size_t size);
 177 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc);
 178
 179 /*
 180  * Newer (fast) iscsi CRC32 APIs.
 181  *
 182  * NOTE: iscsi_crc32_ext() inverts ocrc input and output as expected,
 183  *       pass a seed of 0 for the equivalent of iscsi_crc32().
 184  *
 185  *       calculate_crc32c() does not invert crc32c input and output
 186  *       to maintain FreeBSD API compatibility.
 187  */
 188 uint32_t iscsi_crc32(const void *buf, size_t size);
 189 uint32_t iscsi_crc32_ext(const void *buf, size_t size, uint32_t ocrc);
 190 uint32_t calculate_crc32c(uint32_t crc32c, const unsigned char *buffer,
 191                         unsigned int length);
 192
 193 void    init_param1 (void);
 194 void    init_param2 (int physpages);
 195 void    tablefull (const char *);
 196 int     kvcprintf (char const *, void (*)(int, void*), void *,
 197                       __va_list) __printf0like(1, 0);
 198 void    kvcreinitspin(void);
 199 int     log (int, const char *, ...) __printflike(2, 3);
 200 void    logwakeup (void);
 201 void    log_console (struct uio *);
 202 int     kprintf (const char *, ...) __printflike(1, 2);
 203 void    kprintf0 (const char *, ...) __printflike(1, 2);
 204 void    krateprintf (struct krate *, const char *, ...) __printflike(2, 3);
 205 int     ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
 206 int     ksprintf (char *buf, const char *, ...) __printflike(2, 3);
 207 int     uprintf (const char *, ...) __printflike(1, 2);
 208 int     kvprintf (const char *, __va_list) __printflike(1, 0);
 209 int     kvsnprintf (char *, size_t, const char *,
 210                         __va_list) __printflike(3, 0);
 211 int     kvasnprintf (char **, size_t, const char *,
 212                         __va_list) __printflike(3, 0);
 213 int     kvsprintf (char *buf, const char *,
 214                         __va_list) __printflike(2, 0);
 215 int     ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
 216 void    hexdump (const void *ptr, int length, const char *hdr, int flags);
 217 void    kprint_cpuset(cpumask_t *mask);
 218 #define HD_COLUMN_MASK  0xff
 219 #define HD_DELIM_MASK   0xff00
 220 #define HD_OMIT_COUNT   (1 << 16)
 221 #define HD_OMIT_HEX     (1 << 17)
 222 #define HD_OMIT_CHARS   (1 << 18)
 223 int     ksscanf(const char *, char const *, ...)
 224             __nonnull(1, 2) __scanflike(2, 3);
 225 int     kvsscanf(const char *, char const *, __va_list)
 226             __nonnull(1, 2) __scanflike(2, 0);
 227 void    kvasfree(char **);
 228
 229 long    strtol(const char *, char **, int) __nonnull(1);
 230 u_long  strtoul(const char *, char **, int) __nonnull(1);
 231 quad_t  strtoq(const char *, char **, int) __nonnull(1);
 232 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
 233
 234 /*
 235  * NOTE: some functions commonly used by device drivers may be passed
 236  *       pointers to volatile storage, volatile set to avoid warnings.
 237  *
 238  * NOTE: When using builtin's, GCC does enormous optimizations and makes
 239  *       a number of assumptions that can cause later unrelated conditionals
 240  *       to be optimized out.  In the case of memset and memmove, GCC
 241  *       assumes that (to) and (from) cannot be NULL (even when (len) might
 242  *       be 0), and will optimize-out later NULL tests on (to) or (from).
 243  */
 244 #if 1
 245 #define bcopy(from, to, len)                            \
 246         __builtin_memmove(__DEQUALIFY(void *, (to)),    \
 247                           __DEQUALIFY(void *, (from)),  \
 248                           (len))
 249 #define memcpy(to, from, len)                           \
 250         __builtin_memcpy(__DEQUALIFY(void *, (to)),     \
 251                           __DEQUALIFY(void *, (from)),  \
 252                           (len))
 253 #define memset(ptr, c, len)                             \
 254         __builtin_memset(__DEQUALIFY(void *, (ptr)), (c), (len))
 255 #define memmove(to, from, len)                          \
 256         __builtin_memmove(__DEQUALIFY(void *, (to)),    \
 257                           __DEQUALIFY(void *, (from)),  \
 258                           (len))
 259 #define bzero(buf, len)                                 \
 260         __builtin_memset(__DEQUALIFY(void *, (buf)), 0, (len))
 261 #else
 262 void    bcopy(volatile const void *from, volatile void *to, size_t len)
 263             __nonnull(1, 2);
 264 void    *memcpy(void *to, const void *from, size_t len)
 265             __nonnull(1, 2);
 266 void    *memmove(void *, const void *, size_t);
 267 void    *memset(void *, int, size_t);
 268 void    bzero(volatile void *buf, size_t len) __nonnull(1);
 269 #endif
 270 void    _bcopy(volatile const void *from, volatile void *to, size_t len)
 271             __nonnull(1, 2);
 272 void    *_memcpy(void *to, const void *from, size_t len)
 273             __nonnull(1, 2);
 274 void    *_memmove(void *, const void *, size_t);
 275 void    *_memset(void *, int, size_t);
 276 void    _bzero(volatile void *buf, size_t len) __nonnull(1);
 277 void    bzeront(volatile void *buf, size_t len) __nonnull(1);
 278
 279 long    kreadmem64(const void *addr);
 280
 281 int     copystr (const void *kfaddr, void *kdaddr, size_t len,
 282                 size_t *lencopied) __nonnull(1, 2);
 283 int     copyinstr (const void *udaddr, void *kaddr, size_t len,
 284                 size_t *lencopied) __nonnull(1, 2);
 285 int     copyin(const void *udaddr, void *kaddr, size_t len) __nonnull(1, 2);
 286 int     copyin_nofault(const void *udaddr, void *kaddr, size_t len)
 287             __nonnull(1, 2);
 288 int     copyout(const void *kaddr, void *udaddr, size_t len) __nonnull(1, 2);
 289 int     copyout_nofault(const void *kaddr, void *udaddr, size_t len)
 290             __nonnull(1, 2);
 291
 292 int     fubyte (const uint8_t *base);
 293 int     subyte (uint8_t *base, uint8_t byte);
 294 int32_t fuword32 (const uint32_t *base);
 295 int64_t fuword64 (const uint64_t *base);
 296 int     suword32 (uint32_t *base, int word);
 297 int     suword64 (uint64_t *base, uint64_t word);
 298 uint32_t casu32(volatile uint32_t *p, uint32_t oldval, uint32_t newval);
 299 uint64_t casu64(volatile uint64_t *p, uint64_t oldval, uint64_t newval);
 300 uint32_t swapu32(volatile uint32_t *p, uint32_t val);
 301 uint64_t swapu64(volatile uint64_t *p, uint64_t val);
 302 uint32_t fuwordadd32(volatile uint32_t *p, uint32_t val);
 303 uint64_t fuwordadd64(volatile uint64_t *p, uint64_t val);
 304
 305 void    DELAY(int usec);
 306 void    DRIVERSLEEP(int usec);
 307
 308 void    startprofclock (struct proc *);
 309 void    stopprofclock (struct proc *);
 310 void    setstatclockrate (int hzrate);
 311
 312 /*
 313  * Kernel environment support functions and sundry.
 314  */
 315 char    *kgetenv (const char *name);
 316 int     ksetenv(const char *name, const char *value);
 317 int     kunsetenv(const char *name);
 318 void    kfreeenv(char *env);
 319 int     ktestenv(const char *name);
 320 int     kgetenv_int (const char *name, int *data);
 321 int     kgetenv_string (const char *name, char *data, int size);
 322 int     kgetenv_ulong(const char *name, unsigned long *data);
 323 int     kgetenv_quad (const char *name, quad_t *data);
 324 int     kgetenv_long(const char *name, long *data);
 325 extern char *kern_envp;
 326
 327 #include <sys/libkern.h>
 328
 329 /* Initialize the world */
 330 void    mi_startup (void);
 331 void    nchinit (void);
 332
 333 /* Finalize the world. */
 334 void    shutdown_nice (int);
 335
 336 /*
 337  * Kernel to clock driver interface.
 338  */
 339 void    inittodr (time_t base);
 340 void    resettodr (void);
 341 void    startrtclock (void);
 342
 343 /* Timeouts */
 344 typedef void timeout_t (void *);        /* timeout function type */
 345
 346 /* Interrupt management */
 347
 348 /*
 349  * For the alpha arch, some of these functions are static __inline, and
 350  * the others should be.
 351  */
 352 #if defined(__x86_64__)
 353 void            setdelayed (void);
 354 void            setsoftcambio (void);
 355 void            setsoftcamnet (void);
 356 void            setsoftunused02 (void);
 357 void            setsoftcrypto (void);
 358 void            setsoftunused01 (void);
 359 void            setsofttty (void);
 360 void            setsoftvm (void);
 361 void            setsofttq (void);
 362 void            schedsofttty (void);
 363 void            splz (void);
 364 void            splz_check (void);
 365 void            cpu_mmw_pause_int(int*, int, int, int);
 366 void            cpu_mmw_pause_long(long*, long, int, int);
 367 void            cpu_smp_stopped(void);
 368 #endif /* __x86_64__ */
 369
 370 /*
 371  * Various callout lists.
 372  */
 373
 374 /* Exit callout list declarations. */
 375 typedef void (*exitlist_fn) (struct thread *td);
 376
 377 int     at_exit (exitlist_fn function);
 378 int     rm_at_exit (exitlist_fn function);
 379
 380 /* Fork callout list declarations. */
 381 typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
 382                                  int flags);
 383
 384 int     at_fork (forklist_fn function);
 385 int     rm_at_fork (forklist_fn function);
 386
 387 extern struct globaldata        *panic_cpu_gd;
 388
 389 /*
 390  * Common `proc' functions are declared here so that proc.h can be included
 391  * less often.
 392  */
 393 int     tsleep(const volatile void *, int, const char *, int);
 394 int     ssleep(const volatile void *, struct spinlock *, int, const char *, int)
 395             __nonnull(1);
 396 int     lksleep(const volatile void *, struct lock *, int, const char *, int)
 397             __nonnull(1);
 398 int     mtxsleep(const volatile void *, struct mtx *, int, const char *, int)
 399             __nonnull(1);
 400 int     zsleep(const volatile void *, struct lwkt_serialize *, int, const char *, int)
 401             __nonnull(1);
 402 void    tsleep_interlock(const volatile void *, int) __nonnull(1);
 403 void    tsleep_remove (struct thread *);
 404 int     lwkt_sleep (const char *, int);
 405 void    tstop (void);
 406 void    wakeup(const volatile void *chan) __nonnull(1);
 407 void    wakeup_one(const volatile void *chan) __nonnull(1);
 408 void    wakeup_mycpu(const volatile void *chan) __nonnull(1);
 409 void    wakeup_mycpu_one(const volatile void *chan) __nonnull(1);
 410 void    wakeup_oncpu(struct globaldata *gd, const volatile void *chan)
 411             __nonnull(2);
 412 void    wakeup_oncpu_one(struct globaldata *gd, const volatile void *chan)
 413             __nonnull(2);
 414 void    wakeup_domain(const volatile void *chan, int domain) __nonnull(1);
 415 void    wakeup_domain_one(const volatile void *chan, int domain) __nonnull(1);
 416 void    wakeup_start_delayed(void);
 417 void    wakeup_end_delayed(void);
 418
 419 /*
 420  * Common `cdev_t' stuff are declared here to avoid #include poisoning
 421  */
 422
 423 int major(cdev_t x);
 424 int minor(cdev_t x);
 425 udev_t dev2udev(cdev_t x);
 426 cdev_t udev2dev(udev_t x, int b);
 427 int uminor(udev_t dev);
 428 int umajor(udev_t dev);
 429 udev_t makeudev(int x, int y);
 430
 431 /*
 432  * Unit number allocation API. (kern/subr_unit.c)
 433  */
 434 struct unrhdr;
 435 struct unrhdr *new_unrhdr(int low, int high, struct lock *lock);
 436 void delete_unrhdr(struct unrhdr *uh);
 437 int alloc_unr(struct unrhdr *uh);
 438 int alloc_unrl(struct unrhdr *uh);
 439 void free_unr(struct unrhdr *uh, u_int item);
 440
 441 /*
 442  * Population count algorithm using SWAR approach
 443  * - "SIMD Within A Register".
 444  */
 445
 446 static __inline uint16_t
 447 bitcount16(uint32_t x)
 448 {
 449
 450         x = (x & 0x5555) + ((x & 0xaaaa) >> 1);
 451         x = (x & 0x3333) + ((x & 0xcccc) >> 2);
 452         x = (x + (x >> 4)) & 0x0f0f;
 453         x = (x + (x >> 8)) & 0x00ff;
 454         return (x);
 455 }
 456
 457 static __inline uint32_t
 458 bitcount32(uint32_t x)
 459 {
 460
 461         x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
 462         x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
 463         x = (x + (x >> 4)) & 0x0f0f0f0f;
 464         x = (x + (x >> 8));
 465         x = (x + (x >> 16)) & 0x000000ff;
 466         return (x);
 467 }
 468
 469 static __inline uint64_t
 470 bitcount64(uint64_t x)
 471 {
 472
 473         x = (x & 0x5555555555555555) + ((x & 0xaaaaaaaaaaaaaaaa) >> 1);
 474         x = (x & 0x3333333333333333) + ((x & 0xcccccccccccccccc) >> 2);
 475         x = (x + (x >> 4)) & 0x0f0f0f0f0f0f0f0f;
 476         x = (x + (x >> 8));
 477         x = (x + (x >> 16));
 478         x = (x + (x >> 32)) & 0x000000ff;
 479         return (x);
 480 }
 481
 482 #endif  /* _KERNEL */
 483 #endif /* !_SYS_SYSTM_H_ */