Import of the port of the new(er) FreeBSD atacontrol(8), as natacontrol(8).
[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 $
a8a86718 40 * $DragonFly: src/sys/sys/systm.h,v 1.47 2006/12/04 18:03:27 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
527fddf7 93extern u_int cpu_feature; /* CPUID_* features */
b9b7eb27
MD
94extern int nfs_diskless_valid; /* NFS diskless params were obtained */
95extern vm_paddr_t Maxmem; /* Highest physical memory address in system */
527fddf7 96
984263bc
MD
97#ifdef INVARIANTS /* The option is always available */
98#define KASSERT(exp,msg) do { if (!(exp)) panic msg; } while (0)
5ee2acaa 99#define KKASSERT(exp) if (!(exp)) panic("assertion: %s in %s", #exp, __func__)
984263bc
MD
100#else
101#define KASSERT(exp,msg)
41c20dac 102#define KKASSERT(exp)
984263bc
MD
103#endif
104
832f5800
JS
105#define CTASSERT(x) _CTASSERT(x, __LINE__)
106#define _CTASSERT(x, y) __CTASSERT(x, y)
107#define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
108
984263bc
MD
109/*
110 * General function declarations.
111 */
112
88c4d2f6 113struct intrframe;
bf765287 114struct spinlock;
984263bc
MD
115struct malloc_type;
116struct proc;
f1d1c3fa 117struct xwait;
984263bc
MD
118struct timeval;
119struct tty;
120struct uio;
8ad65e08 121struct globaldata;
41c20dac 122struct thread;
4a22e893 123struct trapframe;
984263bc 124
b153f746 125void Debugger (const char *msg);
801f17b9 126void backtrace(void);
b153f746
RG
127void mi_gdinit (struct globaldata *gd, int cpu);
128int dumpstatus (vm_offset_t addr, off_t count);
129int nullop (void);
b13267a5 130int seltrue (cdev_t dev, int which);
b153f746
RG
131int ureadc (int, struct uio *);
132void *hashinit (int count, struct malloc_type *type, u_long *hashmask);
133void *phashinit (int count, struct malloc_type *type, u_long *nentries);
134
4a22e893 135int cpu_sanitize_frame (struct trapframe *);
527fddf7
MD
136void cpu_halt (void);
137void cpu_reset (void);
b153f746 138void cpu_boot (int);
527fddf7 139
b153f746 140void cpu_rootconf (void);
984263bc
MD
141extern uint32_t crc32_tab[];
142uint32_t crc32(const void *buf, size_t size);
b153f746
RG
143void init_param1 (void);
144void init_param2 (int physpages);
145void tablefull (const char *);
146int addlog (const char *, ...) __printflike(1, 2);
147int kvprintf (char const *, void (*)(int, void*), void *, int,
e2565a42 148 __va_list) __printflike(1, 0);
b153f746
RG
149int log (int, const char *, ...) __printflike(2, 3);
150void logwakeup (void);
151void log_console (struct uio *);
152int printf (const char *, ...) __printflike(1, 2);
153int snprintf (char *, size_t, const char *, ...) __printflike(3, 4);
154int sprintf (char *buf, const char *, ...) __printflike(2, 3);
155int uprintf (const char *, ...) __printflike(1, 2);
e2565a42
MD
156int vprintf (const char *, __va_list) __printflike(1, 0);
157int vsnprintf (char *, size_t, const char *, __va_list) __printflike(3, 0);
158int vsprintf (char *buf, const char *, __va_list) __printflike(2, 0);
b153f746
RG
159int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
160int sscanf (const char *, char const *, ...);
e2565a42 161int vsscanf (const char *, char const *, __va_list);
b153f746
RG
162long strtol (const char *, char **, int);
163u_long strtoul (const char *, char **, int);
164quad_t strtoq (const char *, char **, int);
165u_quad_t strtouq (const char *, char **, int);
984263bc 166
f15db79e
MD
167/*
168 * note: some functions commonly used by device drivers may be passed
169 * pointers to volatile storage, volatile set to avoid warnings.
527fddf7
MD
170 *
171 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is
172 * explicitly not meant to be sophisticated.
173 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
174 * This routine is explicitly not meant to be sophisticated.
f15db79e 175 */
527fddf7
MD
176void bcopyb (const void *from, void *to, size_t len);
177void bcopyi (const void *from, void *to, size_t len);
b153f746
RG
178void bcopy (volatile const void *from, volatile void *to, size_t len);
179void ovbcopy (const void *from, void *to, size_t len);
afaa1d56 180void bzero (volatile void *buf, size_t len);
b153f746 181void *memcpy (void *to, const void *from, size_t len);
984263bc 182
b153f746
RG
183int copystr (const void *kfaddr, void *kdaddr, size_t len,
184 size_t *lencopied);
185int copyinstr (const void *udaddr, void *kaddr, size_t len,
186 size_t *lencopied);
187int copyin (const void *udaddr, void *kaddr, size_t len);
188int copyout (const void *kaddr, void *udaddr, size_t len);
984263bc 189
b153f746
RG
190int fubyte (const void *base);
191int subyte (void *base, int byte);
192int suibyte (void *base, int byte);
193long fuword (const void *base);
194int suword (void *base, long word);
195int fusword (void *base);
196int susword (void *base, int word);
984263bc 197
b153f746 198void realitexpire (void *);
f0f0df1c 199void DELAY(int usec);
984263bc 200
b153f746
RG
201void startprofclock (struct proc *);
202void stopprofclock (struct proc *);
203void setstatclockrate (int hzrate);
984263bc 204
b9b7eb27
MD
205/*
206 * Console I/O spinlocks - these typically also hard-disable interrupts
207 * for the duration.
208 */
209void cons_lock(void);
210void cons_unlock(void);
211
bc01a404
MD
212char *kgetenv (const char *name);
213#define testenv kgetenv
6c6180e0 214#define freeenv(p)
bc01a404
MD
215int kgetenv_int (const char *name, int *data);
216int kgetenv_string (const char *name, char *data, int size);
217int kgetenv_quad (const char *name, quad_t *data);
984263bc
MD
218extern char *kern_envp;
219
220#ifdef APM_FIXUP_CALLTODO
b153f746 221void adjust_timeout_calltodo (struct timeval *time_change);
984263bc
MD
222#endif /* APM_FIXUP_CALLTODO */
223
224#include <sys/libkern.h>
225
226/* Initialize the world */
a8a86718 227void mi_startup (void);
b153f746
RG
228void consinit (void);
229void cpu_initclocks (void);
230void nchinit (void);
231void usrinfoinit (void);
984263bc
MD
232
233/* Finalize the world. */
b153f746 234void shutdown_nice (int);
984263bc
MD
235
236/*
237 * Kernel to clock driver interface.
238 */
b153f746
RG
239void inittodr (time_t base);
240void resettodr (void);
241void startrtclock (void);
984263bc
MD
242
243/* Timeouts */
b153f746 244typedef void timeout_t (void *); /* timeout function type */
984263bc
MD
245#define CALLOUT_HANDLE_INITIALIZER(handle) \
246 { NULL }
247
7eb3b2ae
MD
248#if 0
249/* OBSOLETE INTERFACE */
b153f746
RG
250void callout_handle_init (struct callout_handle *);
251struct callout_handle timeout (timeout_t *, void *, int);
252void untimeout (timeout_t *, void *, struct callout_handle);
7eb3b2ae 253#endif
984263bc
MD
254
255/* Interrupt management */
256
257/*
258 * For the alpha arch, some of these functions are static __inline, and
259 * the others should be.
260 */
261#ifdef __i386__
b153f746
RG
262void setdelayed (void);
263void setsoftast (void);
264void setsoftcambio (void);
265void setsoftcamnet (void);
266void setsoftclock (void);
267void setsoftcrypto (void);
268void setsoftnet (void);
269void setsofttty (void);
270void setsoftvm (void);
271void setsofttq (void);
272void schedsoftcamnet (void);
273void schedsoftcambio (void);
274void schedsoftnet (void);
275void schedsofttty (void);
276void schedsoftvm (void);
277void schedsofttq (void);
278intrmask_t softclockpending (void);
b153f746 279void splz (void);
984263bc
MD
280#endif /* __i386__ */
281
984263bc
MD
282/*
283 * Various callout lists.
284 */
285
286/* Exit callout list declarations. */
b153f746 287typedef void (*exitlist_fn) (struct thread *td);
984263bc 288
b153f746
RG
289int at_exit (exitlist_fn function);
290int rm_at_exit (exitlist_fn function);
984263bc
MD
291
292/* Fork callout list declarations. */
b153f746
RG
293typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
294 int flags);
984263bc 295
b153f746
RG
296int at_fork (forklist_fn function);
297int rm_at_fork (forklist_fn function);
984263bc
MD
298
299/*
300 * Not exactly a callout LIST, but a callout entry.
301 * Allow an external module to define a hardware watchdog tickler.
302 * Normally a process would do this, but there are times when the
303 * kernel needs to be able to hold off the watchdog, when the process
304 * is not active, e.g., when dumping core.
305 */
b153f746 306typedef void (*watchdog_tickle_fn) (void);
984263bc
MD
307
308extern watchdog_tickle_fn wdog_tickler;
309
310/*
311 * Common `proc' functions are declared here so that proc.h can be included
312 * less often.
313 */
bf765287
MD
314int tsleep (void *, int, const char *, int);
315int msleep (void *, struct spinlock *, int, const char *, int);
16523a43 316void tsleep_interlock (void *chan);
344ad853 317void tstop (struct proc *);
b153f746
RG
318void wakeup (void *chan);
319void wakeup_one (void *chan);
b336a9b1
MD
320void wakeup_mycpu (void *chan);
321void wakeup_mycpu_one (void *chan);
322void wakeup_oncpu (struct globaldata *gd, void *chan);
323void wakeup_oncpu_one (struct globaldata *gd, void *chan);
da5fb9ef
MD
324void wakeup_domain (void *chan, int domain);
325void wakeup_domain_one (void *chan, int domain);
984263bc
MD
326
327/*
b13267a5 328 * Common `cdev_t' stuff are declared here to avoid #include poisoning
984263bc
MD
329 */
330
b13267a5
MD
331int major(cdev_t x);
332int minor(cdev_t x);
333udev_t dev2udev(cdev_t x);
334cdev_t udev2dev(udev_t x, int b);
984263bc
MD
335int uminor(udev_t dev);
336int umajor(udev_t dev);
337udev_t makeudev(int x, int y);
03d6a592
MD
338
339#endif /* _KERNEL */
984263bc 340#endif /* !_SYS_SYSTM_H_ */