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