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