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