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