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