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