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