| 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 | * $DragonFly: src/sys/sys/systm.h,v 1.72 2007/07/02 01:37:11 dillon Exp $ |
| 41 | */ |
| 42 | |
| 43 | #ifndef _SYS_SYSTM_H_ |
| 44 | #define _SYS_SYSTM_H_ |
| 45 | |
| 46 | #ifndef _KERNEL |
| 47 | #error "This file should not be included by userland programs." |
| 48 | #else |
| 49 | |
| 50 | #ifndef _MACHINE_TYPES_H_ |
| 51 | #include <machine/types.h> |
| 52 | #endif |
| 53 | #ifndef _MACHINE_STDARG_H_ |
| 54 | #include <machine/stdarg.h> |
| 55 | #endif |
| 56 | #include <machine/atomic.h> |
| 57 | #include <machine/cpufunc.h> |
| 58 | #include <sys/callout.h> |
| 59 | |
| 60 | extern int securelevel; /* system security level (see init(8)) */ |
| 61 | extern int kernel_mem_readonly; /* disable writes to kernel memory */ |
| 62 | |
| 63 | extern int cold; /* nonzero if we are doing a cold boot */ |
| 64 | extern int tsleep_now_works; /* tsleep won't just return any more */ |
| 65 | extern const char *panicstr; /* panic message */ |
| 66 | extern int dumping; /* system is dumping */ |
| 67 | extern int safepri; /* safe ipl when cold or panicing */ |
| 68 | extern char version[]; /* system version */ |
| 69 | extern char copyright[]; /* system copyright */ |
| 70 | |
| 71 | extern int selwait; /* select timeout address */ |
| 72 | |
| 73 | extern u_char curpriority; /* priority of current process */ |
| 74 | |
| 75 | extern int physmem; /* physical memory */ |
| 76 | |
| 77 | extern cdev_t dumpdev; /* dump device */ |
| 78 | extern int dumplo; /* OBSOLETE */ |
| 79 | extern u_int64_t dumplo64; /* block number into dumpdev, start of dump */ |
| 80 | |
| 81 | extern cdev_t rootdev; /* root device */ |
| 82 | extern cdev_t rootdevs[2]; /* possible root devices */ |
| 83 | extern char *rootdevnames[2]; /* names of possible root devices */ |
| 84 | |
| 85 | extern int boothowto; /* reboot flags, from console subsystem */ |
| 86 | extern int bootverbose; /* nonzero to print verbose messages */ |
| 87 | |
| 88 | extern int maxusers; /* system tune hint */ |
| 89 | |
| 90 | extern int ncpus; /* total number of cpus (real, hyper, virtual)*/ |
| 91 | extern int ncpus2; /* ncpus rounded down to power of 2 */ |
| 92 | extern int ncpus2_shift; /* log base 2 of ncpus2 */ |
| 93 | extern int ncpus2_mask; /* ncpus2 - 1 */ |
| 94 | extern int ncpus_fit; /* round up to a power of 2 */ |
| 95 | extern int ncpus_fit_mask; /* ncpus_fit - 1 */ |
| 96 | extern int clocks_running; /* timing/timeout subsystem is operational */ |
| 97 | |
| 98 | /* XXX TGEN these don't belong here, they're MD on i386/amd64 */ |
| 99 | extern u_int cpu_feature; /* CPUID_* features */ |
| 100 | extern u_int cpu_feature2; /* CPUID2_* features */ |
| 101 | |
| 102 | extern int nfs_diskless_valid; /* NFS diskless params were obtained */ |
| 103 | extern vm_paddr_t Maxmem; /* Highest physical memory address in system */ |
| 104 | |
| 105 | #ifdef INVARIANTS /* The option is always available */ |
| 106 | #define KASSERT(exp,msg) do { if (!(exp)) panic msg; } while (0) |
| 107 | #define KKASSERT(exp) if (!(exp)) panic("assertion: %s in %s", #exp, __func__) |
| 108 | #else |
| 109 | #define KASSERT(exp,msg) |
| 110 | #define KKASSERT(exp) |
| 111 | #endif |
| 112 | |
| 113 | #define CTASSERT(x) _CTASSERT(x, __LINE__) |
| 114 | #define _CTASSERT(x, y) __CTASSERT(x, y) |
| 115 | #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1] |
| 116 | |
| 117 | /* |
| 118 | * General function declarations. |
| 119 | */ |
| 120 | |
| 121 | struct intrframe; |
| 122 | struct spinlock; |
| 123 | struct malloc_type; |
| 124 | struct proc; |
| 125 | struct xwait; |
| 126 | struct timeval; |
| 127 | struct tty; |
| 128 | struct uio; |
| 129 | struct globaldata; |
| 130 | struct thread; |
| 131 | struct trapframe; |
| 132 | struct user; |
| 133 | struct vmspace; |
| 134 | struct savetls; |
| 135 | |
| 136 | void Debugger (const char *msg); |
| 137 | void backtrace(void); |
| 138 | void mi_gdinit (struct globaldata *gd, int cpu); |
| 139 | void mi_proc0init(struct globaldata *gd, struct user *proc0paddr); |
| 140 | int dumpstatus (vm_offset_t addr, off_t count); |
| 141 | int nullop (void); |
| 142 | int seltrue (cdev_t dev, int which); |
| 143 | int ureadc (int, struct uio *); |
| 144 | void *hashinit (int count, struct malloc_type *type, u_long *hashmask); |
| 145 | void *phashinit (int count, struct malloc_type *type, u_long *nentries); |
| 146 | |
| 147 | int cpu_sanitize_frame (struct trapframe *); |
| 148 | int cpu_sanitize_tls (struct savetls *); |
| 149 | void cpu_mplock_contested(void); |
| 150 | void cpu_halt (void); |
| 151 | void cpu_reset (void); |
| 152 | void cpu_boot (int); |
| 153 | void cpu_rootconf (void); |
| 154 | void cpu_vmspace_alloc(struct vmspace *); |
| 155 | void cpu_vmspace_free(struct vmspace *); |
| 156 | void set_user_TLS(void); |
| 157 | void set_vkernel_fp(struct trapframe *); |
| 158 | int kvm_access_check(vm_offset_t, vm_offset_t, int); |
| 159 | |
| 160 | vm_paddr_t kvtop(void *addr); |
| 161 | int is_physical_memory (vm_offset_t addr); |
| 162 | |
| 163 | extern uint32_t crc32_tab[]; |
| 164 | uint32_t crc32(const void *buf, size_t size); |
| 165 | void init_param1 (void); |
| 166 | void init_param2 (int physpages); |
| 167 | void tablefull (const char *); |
| 168 | int kvcprintf (char const *, void (*)(int, void*), void *, int, |
| 169 | __va_list) __printflike(1, 0); |
| 170 | int log (int, const char *, ...) __printflike(2, 3); |
| 171 | void logwakeup (void); |
| 172 | void log_console (struct uio *); |
| 173 | int kprintf (const char *, ...) __printflike(1, 2); |
| 174 | int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4); |
| 175 | int ksprintf (char *buf, const char *, ...) __printflike(2, 3); |
| 176 | int uprintf (const char *, ...) __printflike(1, 2); |
| 177 | int kvprintf (const char *, __va_list) __printflike(1, 0); |
| 178 | int kvsnprintf (char *, size_t, const char *, __va_list) __printflike(3, 0); |
| 179 | int kvsprintf (char *buf, const char *, __va_list) __printflike(2, 0); |
| 180 | int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3); |
| 181 | int ksscanf (const char *, char const *, ...); |
| 182 | int kvsscanf (const char *, char const *, __va_list); |
| 183 | |
| 184 | long strtol (const char *, char **, int); |
| 185 | u_long strtoul (const char *, char **, int); |
| 186 | quad_t strtoq (const char *, char **, int); |
| 187 | u_quad_t strtouq (const char *, char **, int); |
| 188 | |
| 189 | /* |
| 190 | * note: some functions commonly used by device drivers may be passed |
| 191 | * pointers to volatile storage, volatile set to avoid warnings. |
| 192 | * |
| 193 | * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is |
| 194 | * explicitly not meant to be sophisticated. |
| 195 | * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes). |
| 196 | * This routine is explicitly not meant to be sophisticated. |
| 197 | */ |
| 198 | void bcopyb (const void *from, void *to, size_t len); |
| 199 | void bcopyi (const void *from, void *to, size_t len); |
| 200 | void bcopy (volatile const void *from, volatile void *to, size_t len); |
| 201 | void ovbcopy (const void *from, void *to, size_t len); |
| 202 | void bzero (volatile void *buf, size_t len); |
| 203 | void *memcpy (void *to, const void *from, size_t len); |
| 204 | |
| 205 | int copystr (const void *kfaddr, void *kdaddr, size_t len, |
| 206 | size_t *lencopied); |
| 207 | int copyinstr (const void *udaddr, void *kaddr, size_t len, |
| 208 | size_t *lencopied); |
| 209 | int copyin (const void *udaddr, void *kaddr, size_t len); |
| 210 | int copyout (const void *kaddr, void *udaddr, size_t len); |
| 211 | |
| 212 | int fubyte (const void *base); |
| 213 | int subyte (void *base, int byte); |
| 214 | long fuword (const void *base); |
| 215 | int suword (void *base, long word); |
| 216 | int fusword (void *base); |
| 217 | int susword (void *base, int word); |
| 218 | |
| 219 | void realitexpire (void *); |
| 220 | void DELAY(int usec); |
| 221 | void DRIVERSLEEP(int usec); |
| 222 | |
| 223 | void startprofclock (struct proc *); |
| 224 | void stopprofclock (struct proc *); |
| 225 | void setstatclockrate (int hzrate); |
| 226 | |
| 227 | /* |
| 228 | * Console I/O spinlocks - these typically also hard-disable interrupts |
| 229 | * for the duration. |
| 230 | */ |
| 231 | void cons_lock(void); |
| 232 | void cons_unlock(void); |
| 233 | |
| 234 | /* |
| 235 | * Kernel environment support functions and sundry. |
| 236 | */ |
| 237 | char *kgetenv (const char *name); |
| 238 | int ksetenv(const char *name, const char *value); |
| 239 | int kunsetenv(const char *name); |
| 240 | void kfreeenv(char *env); |
| 241 | int ktestenv(const char *name); |
| 242 | /* XXX TGEN Get rid of these compat defines. */ |
| 243 | #define testenv ktestenv |
| 244 | #define freeenv kfreeenv |
| 245 | int kgetenv_int (const char *name, int *data); |
| 246 | int kgetenv_string (const char *name, char *data, int size); |
| 247 | int kgetenv_quad (const char *name, quad_t *data); |
| 248 | extern char *kern_envp; |
| 249 | |
| 250 | #ifdef APM_FIXUP_CALLTODO |
| 251 | void adjust_timeout_calltodo (struct timeval *time_change); |
| 252 | #endif /* APM_FIXUP_CALLTODO */ |
| 253 | |
| 254 | #include <sys/libkern.h> |
| 255 | |
| 256 | /* Initialize the world */ |
| 257 | void mi_startup (void); |
| 258 | void consinit (void); |
| 259 | void cpu_initclocks (void *arg __unused); |
| 260 | void nchinit (void); |
| 261 | void usrinfoinit (void); |
| 262 | |
| 263 | /* Finalize the world. */ |
| 264 | void shutdown_nice (int); |
| 265 | |
| 266 | /* |
| 267 | * Kernel to clock driver interface. |
| 268 | */ |
| 269 | void inittodr (time_t base); |
| 270 | void resettodr (void); |
| 271 | void startrtclock (void); |
| 272 | |
| 273 | /* Timeouts */ |
| 274 | typedef void timeout_t (void *); /* timeout function type */ |
| 275 | #define CALLOUT_HANDLE_INITIALIZER(handle) \ |
| 276 | { NULL } |
| 277 | |
| 278 | #if 0 |
| 279 | /* OBSOLETE INTERFACE */ |
| 280 | void callout_handle_init (struct callout_handle *); |
| 281 | struct callout_handle timeout (timeout_t *, void *, int); |
| 282 | void untimeout (timeout_t *, void *, struct callout_handle); |
| 283 | #endif |
| 284 | |
| 285 | /* Interrupt management */ |
| 286 | |
| 287 | /* |
| 288 | * For the alpha arch, some of these functions are static __inline, and |
| 289 | * the others should be. |
| 290 | */ |
| 291 | #ifdef __i386__ |
| 292 | void setdelayed (void); |
| 293 | void setsoftcambio (void); |
| 294 | void setsoftcamnet (void); |
| 295 | void setsoftunused02 (void); |
| 296 | void setsoftcrypto (void); |
| 297 | void setsoftunused01 (void); |
| 298 | void setsofttty (void); |
| 299 | void setsoftvm (void); |
| 300 | void setsofttq (void); |
| 301 | void schedsofttty (void); |
| 302 | void splz (void); |
| 303 | #endif /* __i386__ */ |
| 304 | |
| 305 | /* |
| 306 | * Various callout lists. |
| 307 | */ |
| 308 | |
| 309 | /* Exit callout list declarations. */ |
| 310 | typedef void (*exitlist_fn) (struct thread *td); |
| 311 | |
| 312 | int at_exit (exitlist_fn function); |
| 313 | int rm_at_exit (exitlist_fn function); |
| 314 | |
| 315 | /* Fork callout list declarations. */ |
| 316 | typedef void (*forklist_fn) (struct proc *parent, struct proc *child, |
| 317 | int flags); |
| 318 | |
| 319 | int at_fork (forklist_fn function); |
| 320 | int rm_at_fork (forklist_fn function); |
| 321 | |
| 322 | /* |
| 323 | * Not exactly a callout LIST, but a callout entry. |
| 324 | * Allow an external module to define a hardware watchdog tickler. |
| 325 | * Normally a process would do this, but there are times when the |
| 326 | * kernel needs to be able to hold off the watchdog, when the process |
| 327 | * is not active, e.g., when dumping core. |
| 328 | */ |
| 329 | typedef void (*watchdog_tickle_fn) (void); |
| 330 | |
| 331 | extern watchdog_tickle_fn wdog_tickler; |
| 332 | |
| 333 | /* |
| 334 | * Common `proc' functions are declared here so that proc.h can be included |
| 335 | * less often. |
| 336 | */ |
| 337 | int tsleep (void *, int, const char *, int); |
| 338 | int msleep (void *, struct spinlock *, int, const char *, int); |
| 339 | void tsleep_interlock (void *chan); |
| 340 | int lwkt_sleep (const char *, int); |
| 341 | void tstop (void); |
| 342 | void wakeup (void *chan); |
| 343 | void wakeup_one (void *chan); |
| 344 | void wakeup_mycpu (void *chan); |
| 345 | void wakeup_mycpu_one (void *chan); |
| 346 | void wakeup_oncpu (struct globaldata *gd, void *chan); |
| 347 | void wakeup_oncpu_one (struct globaldata *gd, void *chan); |
| 348 | void wakeup_domain (void *chan, int domain); |
| 349 | void wakeup_domain_one (void *chan, int domain); |
| 350 | |
| 351 | /* |
| 352 | * Common `cdev_t' stuff are declared here to avoid #include poisoning |
| 353 | */ |
| 354 | |
| 355 | int major(cdev_t x); |
| 356 | int minor(cdev_t x); |
| 357 | udev_t dev2udev(cdev_t x); |
| 358 | cdev_t udev2dev(udev_t x, int b); |
| 359 | int uminor(udev_t dev); |
| 360 | int umajor(udev_t dev); |
| 361 | udev_t makeudev(int x, int y); |
| 362 | |
| 363 | #endif /* _KERNEL */ |
| 364 | #endif /* !_SYS_SYSTM_H_ */ |