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