Remove page in cat4 as well.
[dragonfly.git] / sys / sys / systm.h
CommitLineData
984263bc
MD
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 $
6bf59cd2 40 * $DragonFly: src/sys/sys/systm.h,v 1.57 2006/12/27 20:41:58 dillon Exp $
984263bc
MD
41 */
42
43#ifndef _SYS_SYSTM_H_
44#define _SYS_SYSTM_H_
45
d9f3f6fa
CP
46#ifndef _KERNEL
47#error "This file should not be included by userland programs."
03d6a592 48#else
d9f3f6fa 49
e2565a42
MD
50#ifndef _MACHINE_TYPES_H_
51#include <machine/types.h>
52#endif
53#ifndef _MACHINE_STDARG_H_
54#include <machine/stdarg.h>
55#endif
984263bc
MD
56#include <machine/atomic.h>
57#include <machine/cpufunc.h>
58#include <sys/callout.h>
59
60extern int securelevel; /* system security level (see init(8)) */
61
62extern int cold; /* nonzero if we are doing a cold boot */
63extern const char *panicstr; /* panic message */
64extern int dumping; /* system is dumping */
65extern int safepri; /* safe ipl when cold or panicing */
66extern char version[]; /* system version */
67extern char copyright[]; /* system copyright */
68
984263bc
MD
69extern int selwait; /* select timeout address */
70
71extern u_char curpriority; /* priority of current process */
72
73extern int physmem; /* physical memory */
74
b13267a5 75extern cdev_t dumpdev; /* dump device */
984263bc
MD
76extern long dumplo; /* offset into dumpdev */
77
b13267a5
MD
78extern cdev_t rootdev; /* root device */
79extern cdev_t rootdevs[2]; /* possible root devices */
984263bc 80extern char *rootdevnames[2]; /* names of possible root devices */
984263bc
MD
81
82extern int boothowto; /* reboot flags, from console subsystem */
83extern int bootverbose; /* nonzero to print verbose messages */
84
85extern int maxusers; /* system tune hint */
86
17a9f566 87extern int ncpus; /* total number of cpus (real, hyper, virtual)*/
90100055
JH
88extern int ncpus2; /* ncpus rounded down to power of 2 */
89extern int ncpus2_shift; /* log base 2 of ncpus2 */
90extern int ncpus2_mask; /* ncpus2 - 1 */
da3639ef 91extern int clocks_running; /* timing/timeout subsystem is operational */
17a9f566 92
97ee3efc 93/* XXX TGEN these don't belong here, they're MD on i386/amd64 */
527fddf7 94extern u_int cpu_feature; /* CPUID_* features */
97ee3efc
TS
95extern u_int cpu_feature2; /* CPUID2_* features */
96
b9b7eb27
MD
97extern int nfs_diskless_valid; /* NFS diskless params were obtained */
98extern vm_paddr_t Maxmem; /* Highest physical memory address in system */
527fddf7 99
984263bc
MD
100#ifdef INVARIANTS /* The option is always available */
101#define KASSERT(exp,msg) do { if (!(exp)) panic msg; } while (0)
5ee2acaa 102#define KKASSERT(exp) if (!(exp)) panic("assertion: %s in %s", #exp, __func__)
984263bc
MD
103#else
104#define KASSERT(exp,msg)
41c20dac 105#define KKASSERT(exp)
984263bc
MD
106#endif
107
832f5800
JS
108#define CTASSERT(x) _CTASSERT(x, __LINE__)
109#define _CTASSERT(x, y) __CTASSERT(x, y)
110#define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
111
984263bc
MD
112/*
113 * General function declarations.
114 */
115
88c4d2f6 116struct intrframe;
bf765287 117struct spinlock;
984263bc
MD
118struct malloc_type;
119struct proc;
f1d1c3fa 120struct xwait;
984263bc
MD
121struct timeval;
122struct tty;
123struct uio;
8ad65e08 124struct globaldata;
41c20dac 125struct thread;
4a22e893 126struct trapframe;
6bf59cd2 127struct user;
984263bc 128
b153f746 129void Debugger (const char *msg);
801f17b9 130void backtrace(void);
b153f746 131void mi_gdinit (struct globaldata *gd, int cpu);
6bf59cd2 132void mi_proc0init(struct globaldata *gd, struct user *proc0paddr);
b153f746
RG
133int dumpstatus (vm_offset_t addr, off_t count);
134int nullop (void);
b13267a5 135int seltrue (cdev_t dev, int which);
b153f746
RG
136int ureadc (int, struct uio *);
137void *hashinit (int count, struct malloc_type *type, u_long *hashmask);
138void *phashinit (int count, struct malloc_type *type, u_long *nentries);
139
4a22e893 140int cpu_sanitize_frame (struct trapframe *);
527fddf7
MD
141void cpu_halt (void);
142void cpu_reset (void);
b153f746 143void cpu_boot (int);
527fddf7 144
b153f746 145void cpu_rootconf (void);
984263bc
MD
146extern uint32_t crc32_tab[];
147uint32_t crc32(const void *buf, size_t size);
b153f746
RG
148void init_param1 (void);
149void init_param2 (int physpages);
150void tablefull (const char *);
379210cb 151int kvcprintf (char const *, void (*)(int, void*), void *, int,
e2565a42 152 __va_list) __printflike(1, 0);
b153f746
RG
153int log (int, const char *, ...) __printflike(2, 3);
154void logwakeup (void);
155void log_console (struct uio *);
169276ba 156int kprintf (const char *, ...) __printflike(1, 2);
169276ba 157int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
169276ba 158int ksprintf (char *buf, const char *, ...) __printflike(2, 3);
b153f746 159int uprintf (const char *, ...) __printflike(1, 2);
379210cb
MD
160int kvprintf (const char *, __va_list) __printflike(1, 0);
161int kvsnprintf (char *, size_t, const char *, __va_list) __printflike(3, 0);
162int kvsprintf (char *buf, const char *, __va_list) __printflike(2, 0);
b153f746 163int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
e93690c2
MD
164int ksscanf (const char *, char const *, ...);
165int kvsscanf (const char *, char const *, __va_list);
44a09dd6 166
b153f746
RG
167long strtol (const char *, char **, int);
168u_long strtoul (const char *, char **, int);
169quad_t strtoq (const char *, char **, int);
170u_quad_t strtouq (const char *, char **, int);
984263bc 171
f15db79e
MD
172/*
173 * note: some functions commonly used by device drivers may be passed
174 * pointers to volatile storage, volatile set to avoid warnings.
527fddf7
MD
175 *
176 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is
177 * explicitly not meant to be sophisticated.
178 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
179 * This routine is explicitly not meant to be sophisticated.
f15db79e 180 */
527fddf7
MD
181void bcopyb (const void *from, void *to, size_t len);
182void bcopyi (const void *from, void *to, size_t len);
b153f746
RG
183void bcopy (volatile const void *from, volatile void *to, size_t len);
184void ovbcopy (const void *from, void *to, size_t len);
afaa1d56 185void bzero (volatile void *buf, size_t len);
b153f746 186void *memcpy (void *to, const void *from, size_t len);
984263bc 187
b153f746
RG
188int copystr (const void *kfaddr, void *kdaddr, size_t len,
189 size_t *lencopied);
190int copyinstr (const void *udaddr, void *kaddr, size_t len,
191 size_t *lencopied);
192int copyin (const void *udaddr, void *kaddr, size_t len);
193int copyout (const void *kaddr, void *udaddr, size_t len);
984263bc 194
b153f746
RG
195int fubyte (const void *base);
196int subyte (void *base, int byte);
b153f746
RG
197long fuword (const void *base);
198int suword (void *base, long word);
199int fusword (void *base);
200int susword (void *base, int word);
984263bc 201
b153f746 202void realitexpire (void *);
f0f0df1c 203void DELAY(int usec);
984263bc 204
b153f746
RG
205void startprofclock (struct proc *);
206void stopprofclock (struct proc *);
207void setstatclockrate (int hzrate);
984263bc 208
b9b7eb27
MD
209/*
210 * Console I/O spinlocks - these typically also hard-disable interrupts
211 * for the duration.
212 */
213void cons_lock(void);
214void cons_unlock(void);
215
bc01a404
MD
216char *kgetenv (const char *name);
217#define testenv kgetenv
6c6180e0 218#define freeenv(p)
bc01a404
MD
219int kgetenv_int (const char *name, int *data);
220int kgetenv_string (const char *name, char *data, int size);
221int kgetenv_quad (const char *name, quad_t *data);
984263bc
MD
222extern char *kern_envp;
223
224#ifdef APM_FIXUP_CALLTODO
b153f746 225void adjust_timeout_calltodo (struct timeval *time_change);
984263bc
MD
226#endif /* APM_FIXUP_CALLTODO */
227
228#include <sys/libkern.h>
229
230/* Initialize the world */
a8a86718 231void mi_startup (void);
b153f746
RG
232void consinit (void);
233void cpu_initclocks (void);
234void nchinit (void);
235void usrinfoinit (void);
984263bc
MD
236
237/* Finalize the world. */
b153f746 238void shutdown_nice (int);
984263bc
MD
239
240/*
241 * Kernel to clock driver interface.
242 */
b153f746
RG
243void inittodr (time_t base);
244void resettodr (void);
245void startrtclock (void);
984263bc
MD
246
247/* Timeouts */
b153f746 248typedef void timeout_t (void *); /* timeout function type */
984263bc
MD
249#define CALLOUT_HANDLE_INITIALIZER(handle) \
250 { NULL }
251
7eb3b2ae
MD
252#if 0
253/* OBSOLETE INTERFACE */
b153f746
RG
254void callout_handle_init (struct callout_handle *);
255struct callout_handle timeout (timeout_t *, void *, int);
256void untimeout (timeout_t *, void *, struct callout_handle);
7eb3b2ae 257#endif
984263bc
MD
258
259/* Interrupt management */
260
261/*
262 * For the alpha arch, some of these functions are static __inline, and
263 * the others should be.
264 */
265#ifdef __i386__
b153f746
RG
266void setdelayed (void);
267void setsoftast (void);
268void setsoftcambio (void);
269void setsoftcamnet (void);
270void setsoftclock (void);
271void setsoftcrypto (void);
272void setsoftnet (void);
273void setsofttty (void);
274void setsoftvm (void);
275void setsofttq (void);
276void schedsoftcamnet (void);
277void schedsoftcambio (void);
278void schedsoftnet (void);
279void schedsofttty (void);
280void schedsoftvm (void);
281void schedsofttq (void);
282intrmask_t softclockpending (void);
b153f746 283void splz (void);
984263bc
MD
284#endif /* __i386__ */
285
984263bc
MD
286/*
287 * Various callout lists.
288 */
289
290/* Exit callout list declarations. */
b153f746 291typedef void (*exitlist_fn) (struct thread *td);
984263bc 292
b153f746
RG
293int at_exit (exitlist_fn function);
294int rm_at_exit (exitlist_fn function);
984263bc
MD
295
296/* Fork callout list declarations. */
b153f746
RG
297typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
298 int flags);
984263bc 299
b153f746
RG
300int at_fork (forklist_fn function);
301int rm_at_fork (forklist_fn function);
984263bc
MD
302
303/*
304 * Not exactly a callout LIST, but a callout entry.
305 * Allow an external module to define a hardware watchdog tickler.
306 * Normally a process would do this, but there are times when the
307 * kernel needs to be able to hold off the watchdog, when the process
308 * is not active, e.g., when dumping core.
309 */
b153f746 310typedef void (*watchdog_tickle_fn) (void);
984263bc
MD
311
312extern watchdog_tickle_fn wdog_tickler;
313
314/*
315 * Common `proc' functions are declared here so that proc.h can be included
316 * less often.
317 */
bf765287
MD
318int tsleep (void *, int, const char *, int);
319int msleep (void *, struct spinlock *, int, const char *, int);
16523a43 320void tsleep_interlock (void *chan);
344ad853 321void tstop (struct proc *);
b153f746
RG
322void wakeup (void *chan);
323void wakeup_one (void *chan);
b336a9b1
MD
324void wakeup_mycpu (void *chan);
325void wakeup_mycpu_one (void *chan);
326void wakeup_oncpu (struct globaldata *gd, void *chan);
327void wakeup_oncpu_one (struct globaldata *gd, void *chan);
da5fb9ef
MD
328void wakeup_domain (void *chan, int domain);
329void wakeup_domain_one (void *chan, int domain);
984263bc
MD
330
331/*
b13267a5 332 * Common `cdev_t' stuff are declared here to avoid #include poisoning
984263bc
MD
333 */
334
b13267a5
MD
335int major(cdev_t x);
336int minor(cdev_t x);
337udev_t dev2udev(cdev_t x);
338cdev_t udev2dev(udev_t x, int b);
984263bc
MD
339int uminor(udev_t dev);
340int umajor(udev_t dev);
341udev_t makeudev(int x, int y);
03d6a592
MD
342
343#endif /* _KERNEL */
984263bc 344#endif /* !_SYS_SYSTM_H_ */