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