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