Remove some white space at EOL.
[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 $
460426e6 40 * $DragonFly: src/sys/sys/systm.h,v 1.63 2007/01/12 03:05:49 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;
135d7199 128struct vmspace;
4e7c41c5 129struct savetls;
984263bc 130
b153f746 131void Debugger (const char *msg);
801f17b9 132void backtrace(void);
b153f746 133void mi_gdinit (struct globaldata *gd, int cpu);
6bf59cd2 134void mi_proc0init(struct globaldata *gd, struct user *proc0paddr);
b153f746
RG
135int dumpstatus (vm_offset_t addr, off_t count);
136int nullop (void);
b13267a5 137int seltrue (cdev_t dev, int which);
b153f746
RG
138int ureadc (int, struct uio *);
139void *hashinit (int count, struct malloc_type *type, u_long *hashmask);
140void *phashinit (int count, struct malloc_type *type, u_long *nentries);
141
4a22e893 142int cpu_sanitize_frame (struct trapframe *);
4e7c41c5 143int cpu_sanitize_tls (struct savetls *);
527fddf7
MD
144void cpu_halt (void);
145void cpu_reset (void);
b153f746
RG
146void cpu_boot (int);
147void cpu_rootconf (void);
135d7199
MD
148void cpu_vmspace_alloc(struct vmspace *);
149void cpu_vmspace_free(struct vmspace *);
4e7c41c5 150void set_user_TLS(void);
431d0fef 151void set_vkernel_fp(struct trapframe *);
460426e6 152int kvm_access_check(vm_offset_t, vm_offset_t, int);
1184892f
MD
153
154vm_paddr_t kvtop(void *addr);
155int is_physical_memory (vm_offset_t addr);
156
984263bc
MD
157extern uint32_t crc32_tab[];
158uint32_t crc32(const void *buf, size_t size);
b153f746
RG
159void init_param1 (void);
160void init_param2 (int physpages);
161void tablefull (const char *);
379210cb 162int kvcprintf (char const *, void (*)(int, void*), void *, int,
e2565a42 163 __va_list) __printflike(1, 0);
b153f746
RG
164int log (int, const char *, ...) __printflike(2, 3);
165void logwakeup (void);
166void log_console (struct uio *);
169276ba 167int kprintf (const char *, ...) __printflike(1, 2);
169276ba 168int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
169276ba 169int ksprintf (char *buf, const char *, ...) __printflike(2, 3);
b153f746 170int uprintf (const char *, ...) __printflike(1, 2);
379210cb
MD
171int kvprintf (const char *, __va_list) __printflike(1, 0);
172int kvsnprintf (char *, size_t, const char *, __va_list) __printflike(3, 0);
173int kvsprintf (char *buf, const char *, __va_list) __printflike(2, 0);
b153f746 174int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
e93690c2
MD
175int ksscanf (const char *, char const *, ...);
176int kvsscanf (const char *, char const *, __va_list);
44a09dd6 177
b153f746
RG
178long strtol (const char *, char **, int);
179u_long strtoul (const char *, char **, int);
180quad_t strtoq (const char *, char **, int);
181u_quad_t strtouq (const char *, char **, int);
984263bc 182
f15db79e
MD
183/*
184 * note: some functions commonly used by device drivers may be passed
185 * pointers to volatile storage, volatile set to avoid warnings.
527fddf7
MD
186 *
187 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is
188 * explicitly not meant to be sophisticated.
189 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
190 * This routine is explicitly not meant to be sophisticated.
f15db79e 191 */
527fddf7
MD
192void bcopyb (const void *from, void *to, size_t len);
193void bcopyi (const void *from, void *to, size_t len);
b153f746
RG
194void bcopy (volatile const void *from, volatile void *to, size_t len);
195void ovbcopy (const void *from, void *to, size_t len);
afaa1d56 196void bzero (volatile void *buf, size_t len);
b153f746 197void *memcpy (void *to, const void *from, size_t len);
984263bc 198
b153f746
RG
199int copystr (const void *kfaddr, void *kdaddr, size_t len,
200 size_t *lencopied);
201int copyinstr (const void *udaddr, void *kaddr, size_t len,
202 size_t *lencopied);
203int copyin (const void *udaddr, void *kaddr, size_t len);
204int copyout (const void *kaddr, void *udaddr, size_t len);
984263bc 205
b153f746
RG
206int fubyte (const void *base);
207int subyte (void *base, int byte);
b153f746
RG
208long fuword (const void *base);
209int suword (void *base, long word);
210int fusword (void *base);
211int susword (void *base, int word);
984263bc 212
b153f746 213void realitexpire (void *);
f0f0df1c 214void DELAY(int usec);
984263bc 215
b153f746
RG
216void startprofclock (struct proc *);
217void stopprofclock (struct proc *);
218void setstatclockrate (int hzrate);
984263bc 219
b9b7eb27
MD
220/*
221 * Console I/O spinlocks - these typically also hard-disable interrupts
222 * for the duration.
223 */
224void cons_lock(void);
225void cons_unlock(void);
226
bc01a404
MD
227char *kgetenv (const char *name);
228#define testenv kgetenv
6c6180e0 229#define freeenv(p)
bc01a404
MD
230int kgetenv_int (const char *name, int *data);
231int kgetenv_string (const char *name, char *data, int size);
232int kgetenv_quad (const char *name, quad_t *data);
984263bc
MD
233extern char *kern_envp;
234
235#ifdef APM_FIXUP_CALLTODO
b153f746 236void adjust_timeout_calltodo (struct timeval *time_change);
984263bc
MD
237#endif /* APM_FIXUP_CALLTODO */
238
239#include <sys/libkern.h>
240
241/* Initialize the world */
a8a86718 242void mi_startup (void);
b153f746
RG
243void consinit (void);
244void cpu_initclocks (void);
245void nchinit (void);
246void usrinfoinit (void);
984263bc
MD
247
248/* Finalize the world. */
b153f746 249void shutdown_nice (int);
984263bc
MD
250
251/*
252 * Kernel to clock driver interface.
253 */
b153f746
RG
254void inittodr (time_t base);
255void resettodr (void);
256void startrtclock (void);
984263bc
MD
257
258/* Timeouts */
b153f746 259typedef void timeout_t (void *); /* timeout function type */
984263bc
MD
260#define CALLOUT_HANDLE_INITIALIZER(handle) \
261 { NULL }
262
7eb3b2ae
MD
263#if 0
264/* OBSOLETE INTERFACE */
b153f746
RG
265void callout_handle_init (struct callout_handle *);
266struct callout_handle timeout (timeout_t *, void *, int);
267void untimeout (timeout_t *, void *, struct callout_handle);
7eb3b2ae 268#endif
984263bc
MD
269
270/* Interrupt management */
271
272/*
273 * For the alpha arch, some of these functions are static __inline, and
274 * the others should be.
275 */
276#ifdef __i386__
b153f746 277void setdelayed (void);
b153f746
RG
278void setsoftcambio (void);
279void setsoftcamnet (void);
0fb6ec96 280void setsoftunused02 (void);
b153f746 281void setsoftcrypto (void);
0fb6ec96 282void setsoftunused01 (void);
b153f746
RG
283void setsofttty (void);
284void setsoftvm (void);
285void setsofttq (void);
b153f746 286void schedsofttty (void);
b153f746 287void splz (void);
984263bc
MD
288#endif /* __i386__ */
289
984263bc
MD
290/*
291 * Various callout lists.
292 */
293
294/* Exit callout list declarations. */
b153f746 295typedef void (*exitlist_fn) (struct thread *td);
984263bc 296
b153f746
RG
297int at_exit (exitlist_fn function);
298int rm_at_exit (exitlist_fn function);
984263bc
MD
299
300/* Fork callout list declarations. */
b153f746
RG
301typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
302 int flags);
984263bc 303
b153f746
RG
304int at_fork (forklist_fn function);
305int rm_at_fork (forklist_fn function);
984263bc
MD
306
307/*
308 * Not exactly a callout LIST, but a callout entry.
309 * Allow an external module to define a hardware watchdog tickler.
310 * Normally a process would do this, but there are times when the
311 * kernel needs to be able to hold off the watchdog, when the process
312 * is not active, e.g., when dumping core.
313 */
b153f746 314typedef void (*watchdog_tickle_fn) (void);
984263bc
MD
315
316extern watchdog_tickle_fn wdog_tickler;
317
318/*
319 * Common `proc' functions are declared here so that proc.h can be included
320 * less often.
321 */
bf765287
MD
322int tsleep (void *, int, const char *, int);
323int msleep (void *, struct spinlock *, int, const char *, int);
16523a43 324void tsleep_interlock (void *chan);
344ad853 325void tstop (struct proc *);
b153f746
RG
326void wakeup (void *chan);
327void wakeup_one (void *chan);
b336a9b1
MD
328void wakeup_mycpu (void *chan);
329void wakeup_mycpu_one (void *chan);
330void wakeup_oncpu (struct globaldata *gd, void *chan);
331void wakeup_oncpu_one (struct globaldata *gd, void *chan);
da5fb9ef
MD
332void wakeup_domain (void *chan, int domain);
333void wakeup_domain_one (void *chan, int domain);
984263bc
MD
334
335/*
b13267a5 336 * Common `cdev_t' stuff are declared here to avoid #include poisoning
984263bc
MD
337 */
338
b13267a5
MD
339int major(cdev_t x);
340int minor(cdev_t x);
341udev_t dev2udev(cdev_t x);
342cdev_t udev2dev(udev_t x, int b);
984263bc
MD
343int uminor(udev_t dev);
344int umajor(udev_t dev);
345udev_t makeudev(int x, int y);
03d6a592
MD
346
347#endif /* _KERNEL */
984263bc 348#endif /* !_SYS_SYSTM_H_ */