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.21 2004/09/19 02:52:27 dillon Exp $ 41 */ 42 43 #ifndef _SYS_SYSTM_H_ 44 #define _SYS_SYSTM_H_ 45 46 #ifndef _MACHINE_TYPES_H_ 47 #include <machine/types.h> 48 #endif 49 #ifndef _MACHINE_STDARG_H_ 50 #include <machine/stdarg.h> 51 #endif 52 #include <machine/atomic.h> 53 #include <machine/cpufunc.h> 54 #include <sys/callout.h> 55 56 extern int securelevel; /* system security level (see init(8)) */ 57 58 extern int cold; /* nonzero if we are doing a cold boot */ 59 extern const char *panicstr; /* panic message */ 60 extern int dumping; /* system is dumping */ 61 extern int safepri; /* safe ipl when cold or panicing */ 62 extern char version[]; /* system version */ 63 extern char copyright[]; /* system copyright */ 64 65 extern int nswap; /* size of swap space */ 66 67 extern int selwait; /* select timeout address */ 68 69 extern u_char curpriority; /* priority of current process */ 70 71 extern int physmem; /* physical memory */ 72 73 extern dev_t dumpdev; /* dump device */ 74 extern long dumplo; /* offset into dumpdev */ 75 76 extern dev_t rootdev; /* root device */ 77 extern dev_t rootdevs[2]; /* possible root devices */ 78 extern char *rootdevnames[2]; /* names of possible root devices */ 79 extern struct vnode *rootvp; /* vnode equivalent to above */ 80 81 extern int boothowto; /* reboot flags, from console subsystem */ 82 extern int bootverbose; /* nonzero to print verbose messages */ 83 84 extern int maxusers; /* system tune hint */ 85 86 extern int ncpus; /* total number of cpus (real, hyper, virtual)*/ 87 extern int ncpus2; /* ncpus rounded down to power of 2 */ 88 extern int ncpus2_shift; /* log base 2 of ncpus2 */ 89 extern int ncpus2_mask; /* ncpus2 - 1 */ 90 extern int clocks_running; /* timing/timeout subsystem is operational */ 91 92 #ifdef INVARIANTS /* The option is always available */ 93 #define KASSERT(exp,msg) do { if (!(exp)) panic msg; } while (0) 94 #define KKASSERT(exp) if (!(exp)) panic("assertion: " #exp " in %s", __FUNCTION__) 95 #define SPLASSERT(level, msg) __CONCAT(__CONCAT(spl,level),assert)(msg) 96 #define CONDSPLASSERT(cond, level, msg) do { \ 97 if (cond) \ 98 SPLASSERT(level, msg); \ 99 } while (0) 100 #else 101 #define KASSERT(exp,msg) 102 #define KKASSERT(exp) 103 #define SPLASSERT(level, msg) 104 #define CONDSPLASSERT(cond, level, msg) 105 #endif 106 107 /* 108 * General function declarations. 109 */ 110 111 struct intrframe; 112 struct malloc_type; 113 struct proc; 114 struct xwait; 115 struct timeval; 116 struct tty; 117 struct uio; 118 struct globaldata; 119 struct thread; 120 121 void Debugger (const char *msg); 122 void backtrace(void); 123 void mi_gdinit (struct globaldata *gd, int cpu); 124 int dumpstatus (vm_offset_t addr, off_t count); 125 int nullop (void); 126 int eopnotsupp (void); 127 int einval (void); 128 int seltrue (dev_t dev, int which, struct thread *td); 129 int ureadc (int, struct uio *); 130 void *hashinit (int count, struct malloc_type *type, u_long *hashmask); 131 void *phashinit (int count, struct malloc_type *type, u_long *nentries); 132 133 void cpu_boot (int); 134 void cpu_rootconf (void); 135 extern uint32_t crc32_tab[]; 136 uint32_t crc32(const void *buf, size_t size); 137 void init_param1 (void); 138 void init_param2 (int physpages); 139 void tablefull (const char *); 140 int addlog (const char *, ...) __printflike(1, 2); 141 int kvprintf (char const *, void (*)(int, void*), void *, int, 142 __va_list) __printflike(1, 0); 143 int log (int, const char *, ...) __printflike(2, 3); 144 void logwakeup (void); 145 void log_console (struct uio *); 146 int printf (const char *, ...) __printflike(1, 2); 147 int snprintf (char *, size_t, const char *, ...) __printflike(3, 4); 148 int sprintf (char *buf, const char *, ...) __printflike(2, 3); 149 int uprintf (const char *, ...) __printflike(1, 2); 150 int vprintf (const char *, __va_list) __printflike(1, 0); 151 int vsnprintf (char *, size_t, const char *, __va_list) __printflike(3, 0); 152 int vsprintf (char *buf, const char *, __va_list) __printflike(2, 0); 153 int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3); 154 int sscanf (const char *, char const *, ...); 155 int vsscanf (const char *, char const *, __va_list); 156 long strtol (const char *, char **, int); 157 u_long strtoul (const char *, char **, int); 158 quad_t strtoq (const char *, char **, int); 159 u_quad_t strtouq (const char *, char **, int); 160 161 /* 162 * note: some functions commonly used by device drivers may be passed 163 * pointers to volatile storage, volatile set to avoid warnings. 164 */ 165 void bcopy (volatile const void *from, volatile void *to, size_t len); 166 void ovbcopy (const void *from, void *to, size_t len); 167 168 #ifdef __i386__ 169 extern void (*bzero) (volatile void *buf, size_t len); 170 #else 171 void bzero (void *buf, size_t len); 172 #endif 173 174 void *memcpy (void *to, const void *from, size_t len); 175 176 int copystr (const void *kfaddr, void *kdaddr, size_t len, 177 size_t *lencopied); 178 int copyinstr (const void *udaddr, void *kaddr, size_t len, 179 size_t *lencopied); 180 int copyin (const void *udaddr, void *kaddr, size_t len); 181 int copyout (const void *kaddr, void *udaddr, size_t len); 182 183 int fubyte (const void *base); 184 int subyte (void *base, int byte); 185 int suibyte (void *base, int byte); 186 long fuword (const void *base); 187 int suword (void *base, long word); 188 int fusword (void *base); 189 int susword (void *base, int word); 190 191 void realitexpire (void *); 192 void DELAY(int usec); 193 194 void startprofclock (struct proc *); 195 void stopprofclock (struct proc *); 196 void setstatclockrate (int hzrate); 197 198 char *getenv (const char *name); 199 #define testenv getenv 200 #define freeenv(p) 201 int getenv_int (const char *name, int *data); 202 int getenv_string (const char *name, char *data, int size); 203 int getenv_quad (const char *name, quad_t *data); 204 extern char *kern_envp; 205 206 #ifdef APM_FIXUP_CALLTODO 207 void adjust_timeout_calltodo (struct timeval *time_change); 208 #endif /* APM_FIXUP_CALLTODO */ 209 210 #include <sys/libkern.h> 211 212 /* Initialize the world */ 213 void consinit (void); 214 void cpu_initclocks (void); 215 void nchinit (void); 216 void usrinfoinit (void); 217 void vntblinit (void); 218 219 /* Finalize the world. */ 220 void shutdown_nice (int); 221 222 /* 223 * Kernel to clock driver interface. 224 */ 225 void inittodr (time_t base); 226 void resettodr (void); 227 void startrtclock (void); 228 229 /* Timeouts */ 230 typedef void timeout_t (void *); /* timeout function type */ 231 #define CALLOUT_HANDLE_INITIALIZER(handle) \ 232 { NULL } 233 234 #if 0 235 /* OBSOLETE INTERFACE */ 236 void callout_handle_init (struct callout_handle *); 237 struct callout_handle timeout (timeout_t *, void *, int); 238 void untimeout (timeout_t *, void *, struct callout_handle); 239 #endif 240 241 /* Interrupt management */ 242 243 /* 244 * For the alpha arch, some of these functions are static __inline, and 245 * the others should be. 246 */ 247 #ifdef __i386__ 248 void setdelayed (void); 249 void setsoftast (void); 250 void setsoftcambio (void); 251 void setsoftcamnet (void); 252 void setsoftclock (void); 253 void setsoftcrypto (void); 254 void setsoftnet (void); 255 void setsofttty (void); 256 void setsoftvm (void); 257 void setsofttq (void); 258 void schedsoftcamnet (void); 259 void schedsoftcambio (void); 260 void schedsoftnet (void); 261 void schedsofttty (void); 262 void schedsoftvm (void); 263 void schedsofttq (void); 264 intrmask_t softclockpending (void); 265 void spl0 (void); 266 intrmask_t splbio (void); 267 intrmask_t splcam (void); 268 intrmask_t splclock (void); 269 intrmask_t splcrypto (void); 270 intrmask_t splhigh (void); 271 intrmask_t splimp (void); 272 intrmask_t splnet (void); 273 intrmask_t splsoftcam (void); 274 intrmask_t splsoftcambio (void); 275 intrmask_t splsoftcamnet (void); 276 intrmask_t splsoftclock (void); 277 intrmask_t splsofttty (void); 278 intrmask_t splsoftvm (void); 279 intrmask_t splsofttq (void); 280 intrmask_t splstatclock (void); 281 intrmask_t spltty (void); 282 intrmask_t splvm (void); 283 void splx (intrmask_t ipl); 284 void splz (void); 285 #endif /* __i386__ */ 286 287 #ifdef __alpha__ 288 #include <machine/ipl.h> 289 #endif 290 291 #ifdef INVARIANT_SUPPORT 292 void splbioassert (const char *msg); 293 void splcamassert (const char *msg); 294 void splclockassert (const char *msg); 295 void splcryptoassert (const char *msg); 296 void splhighassert (const char *msg); 297 void splimpassert (const char *msg); 298 void splnetassert (const char *msg); 299 void splsoftcamassert (const char *msg); 300 void splsoftcambioassert (const char *msg); 301 void splsoftcamnetassert (const char *msg); 302 void splsoftclockassert (const char *msg); 303 void splsoftttyassert (const char *msg); 304 void splsoftvmassert (const char *msg); 305 void splsofttqassert (const char *msg); 306 void splstatclockassert (const char *msg); 307 void splttyassert (const char *msg); 308 void splvmassert (const char *msg); 309 #endif /* INVARIANT_SUPPORT */ 310 311 /* 312 * XXX It's not clear how "machine independent" these will be yet, but 313 * they are used all over the place especially in pci drivers. We would 314 * have to modify lots of drivers since <machine/cpufunc.h> no longer 315 * implicitly causes these to be defined when it #included <machine/spl.h> 316 */ 317 extern intrmask_t bio_imask; /* group of interrupts masked with splbio() */ 318 extern intrmask_t cam_imask; /* group of interrupts masked with splcam() */ 319 extern intrmask_t net_imask; /* group of interrupts masked with splimp() */ 320 extern intrmask_t stat_imask; /* interrupts masked with splstatclock() */ 321 extern intrmask_t tty_imask; /* group of interrupts masked with spltty() */ 322 323 /* Read only */ 324 extern const intrmask_t soft_imask; /* interrupts masked with splsoft*() */ 325 extern const intrmask_t softnet_imask; /* interrupt masked with splnet() */ 326 extern const intrmask_t softtty_imask; /* interrupt masked with splsofttty() */ 327 328 /* 329 * Various callout lists. 330 */ 331 332 /* Exit callout list declarations. */ 333 typedef void (*exitlist_fn) (struct thread *td); 334 335 int at_exit (exitlist_fn function); 336 int rm_at_exit (exitlist_fn function); 337 338 /* Fork callout list declarations. */ 339 typedef void (*forklist_fn) (struct proc *parent, struct proc *child, 340 int flags); 341 342 int at_fork (forklist_fn function); 343 int rm_at_fork (forklist_fn function); 344 345 /* 346 * Not exactly a callout LIST, but a callout entry. 347 * Allow an external module to define a hardware watchdog tickler. 348 * Normally a process would do this, but there are times when the 349 * kernel needs to be able to hold off the watchdog, when the process 350 * is not active, e.g., when dumping core. 351 */ 352 typedef void (*watchdog_tickle_fn) (void); 353 354 extern watchdog_tickle_fn wdog_tickler; 355 356 /* 357 * Common `proc' functions are declared here so that proc.h can be included 358 * less often. 359 */ 360 int tsleep (void *chan, int slpflags, const char *wmesg, int timo); 361 void wakeup (void *chan); 362 void wakeup_one (void *chan); 363 364 /* 365 * Common `dev_t' stuff are declared here to avoid #include poisoning 366 */ 367 368 int major(dev_t x); 369 int minor(dev_t x); 370 udev_t dev2udev(dev_t x); 371 dev_t udev2dev(udev_t x, int b); 372 int uminor(udev_t dev); 373 int umajor(udev_t dev); 374 udev_t makeudev(int x, int y); 375 #endif /* !_SYS_SYSTM_H_ */ 376