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