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