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.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
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.53 2006/12/23 20:05:34 swildner Exp $
47 #error "This file should not be included by userland programs."
50 #ifndef _MACHINE_TYPES_H_
51 #include <machine/types.h>
53 #ifndef _MACHINE_STDARG_H_
54 #include <machine/stdarg.h>
56 #include <machine/atomic.h>
57 #include <machine/cpufunc.h>
58 #include <sys/callout.h>
60 extern int securelevel; /* system security level (see init(8)) */
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 */
69 extern int selwait; /* select timeout address */
71 extern u_char curpriority; /* priority of current process */
73 extern int physmem; /* physical memory */
75 extern cdev_t dumpdev; /* dump device */
76 extern long dumplo; /* offset into dumpdev */
78 extern cdev_t rootdev; /* root device */
79 extern cdev_t rootdevs[2]; /* possible root devices */
80 extern char *rootdevnames[2]; /* names of possible root devices */
82 extern int boothowto; /* reboot flags, from console subsystem */
83 extern int bootverbose; /* nonzero to print verbose messages */
85 extern int maxusers; /* system tune hint */
87 extern int ncpus; /* total number of cpus (real, hyper, virtual)*/
88 extern int ncpus2; /* ncpus rounded down to power of 2 */
89 extern int ncpus2_shift; /* log base 2 of ncpus2 */
90 extern int ncpus2_mask; /* ncpus2 - 1 */
91 extern int clocks_running; /* timing/timeout subsystem is operational */
93 extern u_int cpu_feature; /* CPUID_* features */
94 extern int nfs_diskless_valid; /* NFS diskless params were obtained */
95 extern vm_paddr_t Maxmem; /* Highest physical memory address in system */
97 #ifdef INVARIANTS /* The option is always available */
98 #define KASSERT(exp,msg) do { if (!(exp)) panic msg; } while (0)
99 #define KKASSERT(exp) if (!(exp)) panic("assertion: %s in %s", #exp, __func__)
101 #define KASSERT(exp,msg)
102 #define KKASSERT(exp)
105 #define CTASSERT(x) _CTASSERT(x, __LINE__)
106 #define _CTASSERT(x, y) __CTASSERT(x, y)
107 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
110 * General function declarations.
125 void Debugger (const char *msg);
126 void backtrace(void);
127 void mi_gdinit (struct globaldata *gd, int cpu);
128 int dumpstatus (vm_offset_t addr, off_t count);
130 int seltrue (cdev_t dev, int which);
131 int ureadc (int, struct uio *);
132 void *hashinit (int count, struct malloc_type *type, u_long *hashmask);
133 void *phashinit (int count, struct malloc_type *type, u_long *nentries);
135 int cpu_sanitize_frame (struct trapframe *);
136 void cpu_halt (void);
137 void cpu_reset (void);
140 void cpu_rootconf (void);
141 extern uint32_t crc32_tab[];
142 uint32_t crc32(const void *buf, size_t size);
143 void init_param1 (void);
144 void init_param2 (int physpages);
145 void tablefull (const char *);
146 int addlog (const char *, ...) __printflike(1, 2);
147 int kvcprintf (char const *, void (*)(int, void*), void *, int,
148 __va_list) __printflike(1, 0);
149 int log (int, const char *, ...) __printflike(2, 3);
150 void logwakeup (void);
151 void log_console (struct uio *);
152 int kprintf (const char *, ...) __printflike(1, 2);
153 int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
154 int ksprintf (char *buf, const char *, ...) __printflike(2, 3);
155 int uprintf (const char *, ...) __printflike(1, 2);
156 int kvprintf (const char *, __va_list) __printflike(1, 0);
157 int kvsnprintf (char *, size_t, const char *, __va_list) __printflike(3, 0);
158 int kvsprintf (char *buf, const char *, __va_list) __printflike(2, 0);
159 int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
160 int ksscanf (const char *, char const *, ...);
161 int kvsscanf (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);
169 * note: some functions commonly used by device drivers may be passed
170 * pointers to volatile storage, volatile set to avoid warnings.
172 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is
173 * explicitly not meant to be sophisticated.
174 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
175 * This routine is explicitly not meant to be sophisticated.
177 void bcopyb (const void *from, void *to, size_t len);
178 void bcopyi (const void *from, void *to, size_t len);
179 void bcopy (volatile const void *from, volatile void *to, size_t len);
180 void ovbcopy (const void *from, void *to, size_t len);
181 void bzero (volatile void *buf, size_t len);
182 void *memcpy (void *to, const void *from, size_t len);
184 int copystr (const void *kfaddr, void *kdaddr, size_t len,
186 int copyinstr (const void *udaddr, void *kaddr, size_t len,
188 int copyin (const void *udaddr, void *kaddr, size_t len);
189 int copyout (const void *kaddr, void *udaddr, size_t len);
191 int fubyte (const void *base);
192 int subyte (void *base, int byte);
193 int suibyte (void *base, int byte);
194 long fuword (const void *base);
195 int suword (void *base, long word);
196 int fusword (void *base);
197 int susword (void *base, int word);
199 void realitexpire (void *);
200 void DELAY(int usec);
202 void startprofclock (struct proc *);
203 void stopprofclock (struct proc *);
204 void setstatclockrate (int hzrate);
207 * Console I/O spinlocks - these typically also hard-disable interrupts
210 void cons_lock(void);
211 void cons_unlock(void);
213 char *kgetenv (const char *name);
214 #define testenv kgetenv
216 int kgetenv_int (const char *name, int *data);
217 int kgetenv_string (const char *name, char *data, int size);
218 int kgetenv_quad (const char *name, quad_t *data);
219 extern char *kern_envp;
221 #ifdef APM_FIXUP_CALLTODO
222 void adjust_timeout_calltodo (struct timeval *time_change);
223 #endif /* APM_FIXUP_CALLTODO */
225 #include <sys/libkern.h>
227 /* Initialize the world */
228 void mi_startup (void);
229 void consinit (void);
230 void cpu_initclocks (void);
232 void usrinfoinit (void);
234 /* Finalize the world. */
235 void shutdown_nice (int);
238 * Kernel to clock driver interface.
240 void inittodr (time_t base);
241 void resettodr (void);
242 void startrtclock (void);
245 typedef void timeout_t (void *); /* timeout function type */
246 #define CALLOUT_HANDLE_INITIALIZER(handle) \
250 /* OBSOLETE INTERFACE */
251 void callout_handle_init (struct callout_handle *);
252 struct callout_handle timeout (timeout_t *, void *, int);
253 void untimeout (timeout_t *, void *, struct callout_handle);
256 /* Interrupt management */
259 * For the alpha arch, some of these functions are static __inline, and
260 * the others should be.
263 void setdelayed (void);
264 void setsoftast (void);
265 void setsoftcambio (void);
266 void setsoftcamnet (void);
267 void setsoftclock (void);
268 void setsoftcrypto (void);
269 void setsoftnet (void);
270 void setsofttty (void);
271 void setsoftvm (void);
272 void setsofttq (void);
273 void schedsoftcamnet (void);
274 void schedsoftcambio (void);
275 void schedsoftnet (void);
276 void schedsofttty (void);
277 void schedsoftvm (void);
278 void schedsofttq (void);
279 intrmask_t softclockpending (void);
281 #endif /* __i386__ */
284 * Various callout lists.
287 /* Exit callout list declarations. */
288 typedef void (*exitlist_fn) (struct thread *td);
290 int at_exit (exitlist_fn function);
291 int rm_at_exit (exitlist_fn function);
293 /* Fork callout list declarations. */
294 typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
297 int at_fork (forklist_fn function);
298 int rm_at_fork (forklist_fn function);
301 * Not exactly a callout LIST, but a callout entry.
302 * Allow an external module to define a hardware watchdog tickler.
303 * Normally a process would do this, but there are times when the
304 * kernel needs to be able to hold off the watchdog, when the process
305 * is not active, e.g., when dumping core.
307 typedef void (*watchdog_tickle_fn) (void);
309 extern watchdog_tickle_fn wdog_tickler;
312 * Common `proc' functions are declared here so that proc.h can be included
315 int tsleep (void *, int, const char *, int);
316 int msleep (void *, struct spinlock *, int, const char *, int);
317 void tsleep_interlock (void *chan);
318 void tstop (struct proc *);
319 void wakeup (void *chan);
320 void wakeup_one (void *chan);
321 void wakeup_mycpu (void *chan);
322 void wakeup_mycpu_one (void *chan);
323 void wakeup_oncpu (struct globaldata *gd, void *chan);
324 void wakeup_oncpu_one (struct globaldata *gd, void *chan);
325 void wakeup_domain (void *chan, int domain);
326 void wakeup_domain_one (void *chan, int domain);
329 * Common `cdev_t' stuff are declared here to avoid #include poisoning
334 udev_t dev2udev(cdev_t x);
335 cdev_t udev2dev(udev_t x, int b);
336 int uminor(udev_t dev);
337 int umajor(udev_t dev);
338 udev_t makeudev(int x, int y);
341 #endif /* !_SYS_SYSTM_H_ */