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.81 2008/09/11 00:35:49 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 u_int64_t dumplo64; /* block number into dumpdev, start of dump */ 79 80 extern cdev_t rootdev; /* root device */ 81 extern cdev_t rootdevs[2]; /* possible root devices */ 82 extern char *rootdevnames[2]; /* names of possible root devices */ 83 extern char *ZeroPage; 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/x86_64 */ 99 extern u_int cpu_feature; /* CPUID_* features */ 100 extern u_int cpu_feature2; /* CPUID2_* features */ 101 extern u_int cpu_mi_feature; /* CPU_MI_XXX machine-nonspecific features */ 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 in %s", \ 111 #exp, __func__); } while (0) 112 #define __debugvar 113 #else 114 #define KASSERT(exp,msg) 115 #define KKASSERT(exp) 116 #define __debugvar __attribute__((__unused__)) 117 #endif 118 119 #define CTASSERT(x) _CTASSERT(x, __LINE__) 120 #define _CTASSERT(x, y) __CTASSERT(x, y) 121 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1] 122 123 /* 124 * General function declarations. 125 */ 126 127 struct intrframe; 128 struct spinlock; 129 struct lock; 130 struct mtx; 131 struct lwkt_serialize; 132 struct malloc_type; 133 struct proc; 134 struct xwait; 135 struct timeval; 136 struct tty; 137 struct uio; 138 struct globaldata; 139 struct thread; 140 struct trapframe; 141 struct user; 142 struct vmspace; 143 struct savetls; 144 struct krate; 145 146 void Debugger (const char *msg); 147 void print_backtrace(int count); 148 void mi_gdinit (struct globaldata *gd, int cpu); 149 void mi_proc0init(struct globaldata *gd, struct user *proc0paddr); 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 *phashinit (int count, struct malloc_type *type, u_long *nentries); 155 void *hashinit_ext (int count, size_t size, 156 struct malloc_type *type, u_long *hashmask); 157 void *phashinit_ext (int count, size_t size, 158 struct malloc_type *type, u_long *nentries); 159 160 int cpu_sanitize_frame (struct trapframe *); 161 int cpu_sanitize_tls (struct savetls *); 162 void cpu_spinlock_contested(void); 163 void cpu_halt (void); 164 void cpu_reset (void); 165 void cpu_boot (int); 166 void cpu_rootconf (void); 167 void cpu_vmspace_alloc(struct vmspace *); 168 void cpu_vmspace_free(struct vmspace *); 169 void cpu_vkernel_trap(struct trapframe *, int); 170 void set_user_TLS(void); 171 void set_vkernel_fp(struct trapframe *); 172 int kvm_access_check(vm_offset_t, vm_offset_t, int); 173 174 vm_paddr_t kvtop(void *addr); 175 int is_physical_memory (vm_offset_t addr); 176 177 extern uint32_t crc32_tab[]; 178 uint32_t crc32(const void *buf, size_t size); 179 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc); 180 void init_param1 (void); 181 void init_param2 (int physpages); 182 void tablefull (const char *); 183 int kvcprintf (char const *, void (*)(int, void*), void *, int, 184 __va_list) __printflike(1, 0); 185 void kvcreinitspin(void); 186 int log (int, const char *, ...) __printflike(2, 3); 187 void logwakeup (void); 188 void log_console (struct uio *); 189 int kprintf (const char *, ...) __printflike(1, 2); 190 void kprintf0 (const char *, ...) __printflike(1, 2); 191 void krateprintf (struct krate *, const char *, ...) __printflike(2, 3); 192 int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4); 193 int ksnrprintf (char *, size_t, int, const char *, ...) __printflike(4, 5); 194 int ksprintf (char *buf, const char *, ...) __printflike(2, 3); 195 int uprintf (const char *, ...) __printflike(1, 2); 196 int kvprintf (const char *, __va_list) __printflike(1, 0); 197 int kvsnprintf (char *, size_t, const char *, 198 __va_list) __printflike(3, 0); 199 int kvsnrprintf (char *, size_t, int, const char *, 200 __va_list) __printflike(4, 0); 201 int kvasnrprintf (char **, size_t, int, const char *, 202 __va_list) __printflike(4, 0); 203 int kvsprintf (char *buf, const char *, 204 __va_list) __printflike(2, 0); 205 int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3); 206 void hexdump (const void *ptr, int length, const char *hdr, int flags); 207 #define HD_COLUMN_MASK 0xff 208 #define HD_DELIM_MASK 0xff00 209 #define HD_OMIT_COUNT (1 << 16) 210 #define HD_OMIT_HEX (1 << 17) 211 #define HD_OMIT_CHARS (1 << 18) 212 int ksscanf (const char *, char const *, ...) __scanflike(2, 3); 213 int kvsscanf (const char *, char const *, __va_list) __scanflike(2, 0); 214 void kvasfree(char **); 215 216 long strtol (const char *, char **, int); 217 u_long strtoul (const char *, char **, int); 218 quad_t strtoq (const char *, char **, int); 219 u_quad_t strtouq (const char *, char **, int); 220 221 /* 222 * note: some functions commonly used by device drivers may be passed 223 * pointers to volatile storage, volatile set to avoid warnings. 224 * 225 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is 226 * explicitly not meant to be sophisticated. 227 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes). 228 * This routine is explicitly not meant to be sophisticated. 229 */ 230 void bcopyb (const void *from, void *to, size_t len); 231 void bcopyi (const void *from, void *to, size_t len); 232 void bcopy (volatile const void *from, volatile void *to, size_t len); 233 void ovbcopy (const void *from, void *to, size_t len); 234 void bzero (volatile void *buf, size_t len); 235 void bzeront (volatile void *buf, size_t len); 236 void *memcpy (void *to, const void *from, size_t len); 237 238 int copystr (const void *kfaddr, void *kdaddr, size_t len, 239 size_t *lencopied); 240 int copyinstr (const void *udaddr, void *kaddr, size_t len, 241 size_t *lencopied); 242 int copyin (const void *udaddr, void *kaddr, size_t len); 243 int copyout (const void *kaddr, void *udaddr, size_t len); 244 245 int fubyte (const void *base); 246 int subyte (void *base, int byte); 247 long fuword (const void *base); 248 int suword (void *base, long word); 249 int fusword (void *base); 250 int susword (void *base, int word); 251 u_long casuword(volatile u_long *p, u_long oldval, u_long newval); 252 253 void realitexpire (void *); 254 void DELAY(int usec); 255 void DRIVERSLEEP(int usec); 256 257 void startprofclock (struct proc *); 258 void stopprofclock (struct proc *); 259 void setstatclockrate (int hzrate); 260 261 /* 262 * Kernel environment support functions and sundry. 263 */ 264 char *kgetenv (const char *name); 265 int ksetenv(const char *name, const char *value); 266 int kunsetenv(const char *name); 267 void kfreeenv(char *env); 268 int ktestenv(const char *name); 269 int kgetenv_int (const char *name, int *data); 270 int kgetenv_string (const char *name, char *data, int size); 271 int kgetenv_ulong(const char *name, unsigned long *data); 272 int kgetenv_quad (const char *name, quad_t *data); 273 int kgetenv_long(const char *name, long *data); 274 extern char *kern_envp; 275 276 #ifdef APM_FIXUP_CALLTODO 277 void adjust_timeout_calltodo (struct timeval *time_change); 278 #endif /* APM_FIXUP_CALLTODO */ 279 280 #include <sys/libkern.h> 281 282 /* Initialize the world */ 283 void mi_startup (void); 284 void nchinit (void); 285 286 /* Finalize the world. */ 287 void shutdown_nice (int); 288 289 /* 290 * Kernel to clock driver interface. 291 */ 292 void inittodr (time_t base); 293 void resettodr (void); 294 void startrtclock (void); 295 296 /* Timeouts */ 297 typedef void timeout_t (void *); /* timeout function type */ 298 299 /* Interrupt management */ 300 301 /* 302 * For the alpha arch, some of these functions are static __inline, and 303 * the others should be. 304 */ 305 #if defined(__i386__) || defined(__x86_64__) 306 void setdelayed (void); 307 void setsoftcambio (void); 308 void setsoftcamnet (void); 309 void setsoftunused02 (void); 310 void setsoftcrypto (void); 311 void setsoftunused01 (void); 312 void setsofttty (void); 313 void setsoftvm (void); 314 void setsofttq (void); 315 void schedsofttty (void); 316 void splz (void); 317 void splz_check (void); 318 #endif /* __i386__ */ 319 320 /* 321 * Various callout lists. 322 */ 323 324 /* Exit callout list declarations. */ 325 typedef void (*exitlist_fn) (struct thread *td); 326 327 int at_exit (exitlist_fn function); 328 int rm_at_exit (exitlist_fn function); 329 330 /* Fork callout list declarations. */ 331 typedef void (*forklist_fn) (struct proc *parent, struct proc *child, 332 int flags); 333 334 int at_fork (forklist_fn function); 335 int rm_at_fork (forklist_fn function); 336 337 /* 338 * Not exactly a callout LIST, but a callout entry. 339 * Allow an external module to define a hardware watchdog tickler. 340 * Normally a process would do this, but there are times when the 341 * kernel needs to be able to hold off the watchdog, when the process 342 * is not active, e.g., when dumping core. 343 */ 344 typedef void (*watchdog_tickle_fn) (void); 345 346 extern watchdog_tickle_fn wdog_tickler; 347 extern struct globaldata *panic_cpu_gd; 348 349 /* 350 * Common `proc' functions are declared here so that proc.h can be included 351 * less often. 352 */ 353 int tsleep (const volatile void *, int, const char *, int); 354 int ssleep (const volatile void *, struct spinlock *, int, const char *, int); 355 int lksleep (const volatile void *, struct lock *, int, const char *, int); 356 int mtxsleep (const volatile void *, struct mtx *, int, const char *, int); 357 int zsleep(const volatile void *, struct lwkt_serialize *, int, const char *, int); 358 void tsleep_interlock (const volatile void *, int); 359 void tsleep_remove (struct thread *); 360 int lwkt_sleep (const char *, int); 361 void tstop (void); 362 void wakeup (const volatile void *chan); 363 void wakeup_one (const volatile void *chan); 364 void wakeup_mycpu (const volatile void *chan); 365 void wakeup_mycpu_one (const volatile void *chan); 366 void wakeup_oncpu (struct globaldata *gd, const volatile void *chan); 367 void wakeup_oncpu_one (struct globaldata *gd, const volatile void *chan); 368 void wakeup_domain (const volatile void *chan, int domain); 369 void wakeup_domain_one (const volatile void *chan, int domain); 370 371 /* 372 * Common `cdev_t' stuff are declared here to avoid #include poisoning 373 */ 374 375 int major(cdev_t x); 376 int minor(cdev_t x); 377 udev_t dev2udev(cdev_t x); 378 cdev_t udev2dev(udev_t x, int b); 379 int uminor(udev_t dev); 380 int umajor(udev_t dev); 381 udev_t makeudev(int x, int y); 382 383 #endif /* _KERNEL */ 384 #endif /* !_SYS_SYSTM_H_ */ 385