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