Silence warnings regarding yyunput being defined and never used.
[dragonfly.git] / sys / sys / systm.h
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.40 2006/09/03 17:43:59 dillon Exp $
41  */
42
43 #ifndef _SYS_SYSTM_H_
44 #define _SYS_SYSTM_H_
45
46 #ifndef _KERNEL
47 #error "This file should not be included by userland programs."
48 #else
49
50 #ifndef _MACHINE_TYPES_H_
51 #include <machine/types.h>
52 #endif
53 #ifndef _MACHINE_STDARG_H_
54 #include <machine/stdarg.h>
55 #endif
56 #include <machine/atomic.h>
57 #include <machine/cpufunc.h>
58 #include <sys/callout.h>
59
60 extern int securelevel;         /* system security level (see init(8)) */
61
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 */
68
69 extern int nswap;               /* size of swap space */
70
71 extern int selwait;             /* select timeout address */
72
73 extern u_char curpriority;      /* priority of current process */
74
75 extern int physmem;             /* physical memory */
76
77 extern dev_t dumpdev;           /* dump device */
78 extern long dumplo;             /* offset into dumpdev */
79
80 extern dev_t rootdev;           /* root device */
81 extern dev_t rootdevs[2];       /* possible root devices */
82 extern char *rootdevnames[2];   /* names of possible root devices */
83
84 extern int boothowto;           /* reboot flags, from console subsystem */
85 extern int bootverbose;         /* nonzero to print verbose messages */
86
87 extern int maxusers;            /* system tune hint */
88
89 extern int ncpus;               /* total number of cpus (real, hyper, virtual)*/
90 extern int ncpus2;              /* ncpus rounded down to power of 2 */
91 extern int ncpus2_shift;        /* log base 2 of ncpus2 */
92 extern int ncpus2_mask;         /* ncpus2 - 1 */
93 extern int clocks_running;      /* timing/timeout subsystem is operational */
94
95 #ifdef  INVARIANTS              /* The option is always available */
96 #define KASSERT(exp,msg)        do { if (!(exp)) panic msg; } while (0)
97 #define KKASSERT(exp)           if (!(exp)) panic("assertion: %s in %s", #exp, __func__)
98 #else
99 #define KASSERT(exp,msg)
100 #define KKASSERT(exp)
101 #endif
102
103 #define CTASSERT(x)             _CTASSERT(x, __LINE__)
104 #define _CTASSERT(x, y)         __CTASSERT(x, y)
105 #define __CTASSERT(x, y)        typedef char __assert ## y[(x) ? 1 : -1]
106
107 /*
108  * General function declarations.
109  */
110
111 struct intrframe;
112 struct spinlock;
113 struct malloc_type;
114 struct proc;
115 struct xwait;
116 struct timeval;
117 struct tty;
118 struct uio;
119 struct globaldata;
120 struct thread;
121
122 void    Debugger (const char *msg);
123 void    backtrace(void);
124 void    mi_gdinit (struct globaldata *gd, int cpu);
125 int     dumpstatus (vm_offset_t addr, off_t count);
126 int     nullop (void);
127 int     seltrue (dev_t dev, int which);
128 int     ureadc (int, struct uio *);
129 void    *hashinit (int count, struct malloc_type *type, u_long *hashmask);
130 void    *phashinit (int count, struct malloc_type *type, u_long *nentries);
131
132 void    cpu_boot (int);
133 void    cpu_rootconf (void);
134 extern uint32_t crc32_tab[];
135 uint32_t crc32(const void *buf, size_t size);
136 void    init_param1 (void);
137 void    init_param2 (int physpages);
138 void    tablefull (const char *);
139 int     addlog (const char *, ...) __printflike(1, 2);
140 int     kvprintf (char const *, void (*)(int, void*), void *, int,
141                       __va_list) __printflike(1, 0);
142 int     log (int, const char *, ...) __printflike(2, 3);
143 void    logwakeup (void);
144 void    log_console (struct uio *);
145 int     printf (const char *, ...) __printflike(1, 2);
146 int     snprintf (char *, size_t, const char *, ...) __printflike(3, 4);
147 int     sprintf (char *buf, const char *, ...) __printflike(2, 3);
148 int     uprintf (const char *, ...) __printflike(1, 2);
149 int     vprintf (const char *, __va_list) __printflike(1, 0);
150 int     vsnprintf (char *, size_t, const char *, __va_list) __printflike(3, 0);
151 int     vsprintf (char *buf, const char *, __va_list) __printflike(2, 0);
152 int     ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
153 int     sscanf (const char *, char const *, ...);
154 int     vsscanf (const char *, char const *, __va_list);
155 long    strtol (const char *, char **, int);
156 u_long  strtoul (const char *, char **, int);
157 quad_t  strtoq (const char *, char **, int);
158 u_quad_t strtouq (const char *, char **, int);
159
160 /*
161  * note: some functions commonly used by device drivers may be passed
162  * pointers to volatile storage, volatile set to avoid warnings.
163  */
164 void    bcopy (volatile const void *from, volatile void *to, size_t len);
165 void    ovbcopy (const void *from, void *to, size_t len);
166
167 #ifdef __i386__
168 extern void     (*bzero) (volatile void *buf, size_t len);
169 #else
170 void    bzero (void *buf, size_t len);
171 #endif
172
173 void    *memcpy (void *to, const void *from, size_t len);
174
175 int     copystr (const void *kfaddr, void *kdaddr, size_t len,
176                 size_t *lencopied);
177 int     copyinstr (const void *udaddr, void *kaddr, size_t len,
178                 size_t *lencopied);
179 int     copyin (const void *udaddr, void *kaddr, size_t len);
180 int     copyout (const void *kaddr, void *udaddr, size_t len);
181
182 int     fubyte (const void *base);
183 int     subyte (void *base, int byte);
184 int     suibyte (void *base, int byte);
185 long    fuword (const void *base);
186 int     suword (void *base, long word);
187 int     fusword (void *base);
188 int     susword (void *base, int word);
189
190 void    realitexpire (void *);
191 void    DELAY(int usec);
192
193 void    startprofclock (struct proc *);
194 void    stopprofclock (struct proc *);
195 void    setstatclockrate (int hzrate);
196
197 char    *kgetenv (const char *name);
198 #define testenv kgetenv
199 #define freeenv(p)
200 int     kgetenv_int (const char *name, int *data);
201 int     kgetenv_string (const char *name, char *data, int size);
202 int     kgetenv_quad (const char *name, quad_t *data);
203 extern char *kern_envp;
204
205 #ifdef APM_FIXUP_CALLTODO 
206 void    adjust_timeout_calltodo (struct timeval *time_change); 
207 #endif /* APM_FIXUP_CALLTODO */ 
208
209 #include <sys/libkern.h>
210
211 /* Initialize the world */
212 void    consinit (void);
213 void    cpu_initclocks (void);
214 void    nchinit (void);
215 void    usrinfoinit (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 #if 0
233 /* OBSOLETE INTERFACE */
234 void    callout_handle_init (struct callout_handle *);
235 struct  callout_handle timeout (timeout_t *, void *, int);
236 void    untimeout (timeout_t *, void *, struct callout_handle);
237 #endif
238
239 /* Interrupt management */
240
241 /* 
242  * For the alpha arch, some of these functions are static __inline, and
243  * the others should be.
244  */
245 #ifdef __i386__
246 void            setdelayed (void);
247 void            setsoftast (void);
248 void            setsoftcambio (void);
249 void            setsoftcamnet (void);
250 void            setsoftclock (void);
251 void            setsoftcrypto (void);
252 void            setsoftnet (void);
253 void            setsofttty (void);
254 void            setsoftvm (void);
255 void            setsofttq (void);
256 void            schedsoftcamnet (void);
257 void            schedsoftcambio (void);
258 void            schedsoftnet (void);
259 void            schedsofttty (void);
260 void            schedsoftvm (void);
261 void            schedsofttq (void);
262 intrmask_t      softclockpending (void);
263 void            splz (void);
264 #endif /* __i386__ */
265
266 /*
267  * Various callout lists.
268  */
269
270 /* Exit callout list declarations. */
271 typedef void (*exitlist_fn) (struct thread *td);
272
273 int     at_exit (exitlist_fn function);
274 int     rm_at_exit (exitlist_fn function);
275
276 /* Fork callout list declarations. */
277 typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
278                                  int flags);
279
280 int     at_fork (forklist_fn function);
281 int     rm_at_fork (forklist_fn function);
282
283 /*
284  * Not exactly a callout LIST, but a callout entry.
285  * Allow an external module to define a hardware watchdog tickler.
286  * Normally a process would do this, but there are times when the
287  * kernel needs to be able to hold off the watchdog, when the process
288  * is not active, e.g., when dumping core.
289  */
290 typedef void (*watchdog_tickle_fn) (void);
291
292 extern watchdog_tickle_fn       wdog_tickler;
293
294 /* 
295  * Common `proc' functions are declared here so that proc.h can be included
296  * less often.
297  */
298 int     tsleep (void *, int, const char *, int);
299 int     msleep (void *, struct spinlock *, int, const char *, int);
300 void    tsleep_interlock (void *chan);
301 void    tstop (struct proc *);
302 void    wakeup (void *chan);
303 void    wakeup_one (void *chan);
304 void    wakeup_mycpu (void *chan);
305 void    wakeup_mycpu_one (void *chan);
306 void    wakeup_oncpu (struct globaldata *gd, void *chan);
307 void    wakeup_oncpu_one (struct globaldata *gd, void *chan);
308 void    wakeup_domain (void *chan, int domain);
309 void    wakeup_domain_one (void *chan, int domain);
310
311 /*
312  * Common `dev_t' stuff are declared here to avoid #include poisoning
313  */
314
315 int major(dev_t x);
316 int minor(dev_t x);
317 udev_t dev2udev(dev_t x);
318 dev_t udev2dev(udev_t x, int b);
319 int uminor(udev_t dev);
320 int umajor(udev_t dev);
321 udev_t makeudev(int x, int y);
322
323 #endif  /* _KERNEL */
324 #endif /* !_SYS_SYSTM_H_ */