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.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
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.77 2007/11/25 00:13:28 swildner Exp $
47 #error "This file should not be included by userland programs."
50 #ifndef _MACHINE_TYPES_H_
51 #include <machine/types.h>
53 #ifndef _MACHINE_STDARG_H_
54 #include <machine/stdarg.h>
56 #include <machine/atomic.h>
57 #include <machine/cpufunc.h>
58 #include <sys/callout.h>
60 extern int securelevel; /* system security level (see init(8)) */
61 extern int kernel_mem_readonly; /* disable writes to kernel memory */
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 */
71 extern int selwait; /* select timeout address */
73 extern u_char curpriority; /* priority of current process */
75 extern int physmem; /* physical memory */
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 */
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 */
85 extern int boothowto; /* reboot flags, from console subsystem */
86 extern int bootverbose; /* nonzero to print verbose messages */
88 extern int maxusers; /* system tune hint */
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 */
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 */
102 extern int nfs_diskless_valid; /* NFS diskless params were obtained */
103 extern vm_paddr_t Maxmem; /* Highest physical memory address in system */
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__)
109 #define KASSERT(exp,msg)
110 #define KKASSERT(exp)
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]
118 * General function declarations.
137 void Debugger (const char *msg);
138 void backtrace(void);
139 void mi_gdinit (struct globaldata *gd, int cpu);
140 void mi_proc0init(struct globaldata *gd, struct user *proc0paddr);
141 int dumpstatus (vm_offset_t addr, off_t count);
143 int seltrue (cdev_t dev, int which);
144 int ureadc (int, struct uio *);
145 void *hashinit (int count, struct malloc_type *type, u_long *hashmask);
146 void *phashinit (int count, struct malloc_type *type, u_long *nentries);
148 int cpu_sanitize_frame (struct trapframe *);
149 int cpu_sanitize_tls (struct savetls *);
150 void cpu_mplock_contested(void);
151 void cpu_spinlock_contested(void);
152 void cpu_halt (void);
153 void cpu_reset (void);
155 void cpu_rootconf (void);
156 void cpu_vmspace_alloc(struct vmspace *);
157 void cpu_vmspace_free(struct vmspace *);
158 void set_user_TLS(void);
159 void set_vkernel_fp(struct trapframe *);
160 int kvm_access_check(vm_offset_t, vm_offset_t, int);
162 vm_paddr_t kvtop(void *addr);
163 int is_physical_memory (vm_offset_t addr);
165 extern uint32_t crc32_tab[];
166 uint32_t crc32(const void *buf, size_t size);
167 void init_param1 (void);
168 void init_param2 (int physpages);
169 void tablefull (const char *);
170 int kvcprintf (char const *, void (*)(int, void*), void *, int,
171 __va_list) __printflike(1, 0);
172 int log (int, const char *, ...) __printflike(2, 3);
173 void logwakeup (void);
174 void log_console (struct uio *);
175 int kprintf (const char *, ...) __printflike(1, 2);
176 void krateprintf (struct krate *, const char *, ...) __printflike(2, 3);
177 int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
178 int ksprintf (char *buf, const char *, ...) __printflike(2, 3);
179 int uprintf (const char *, ...) __printflike(1, 2);
180 int kvprintf (const char *, __va_list) __printflike(1, 0);
181 int kvsnprintf (char *, size_t, const char *, __va_list) __printflike(3, 0);
182 int kvsprintf (char *buf, const char *, __va_list) __printflike(2, 0);
183 int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
184 int ksscanf (const char *, char const *, ...);
185 int kvsscanf (const char *, char const *, __va_list);
187 long strtol (const char *, char **, int);
188 u_long strtoul (const char *, char **, int);
189 quad_t strtoq (const char *, char **, int);
190 u_quad_t strtouq (const char *, char **, int);
193 * note: some functions commonly used by device drivers may be passed
194 * pointers to volatile storage, volatile set to avoid warnings.
196 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is
197 * explicitly not meant to be sophisticated.
198 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
199 * This routine is explicitly not meant to be sophisticated.
201 void bcopyb (const void *from, void *to, size_t len);
202 void bcopyi (const void *from, void *to, size_t len);
203 void bcopy (volatile const void *from, volatile void *to, size_t len);
204 void ovbcopy (const void *from, void *to, size_t len);
205 void bzero (volatile void *buf, size_t len);
206 void *memcpy (void *to, const void *from, size_t len);
208 int copystr (const void *kfaddr, void *kdaddr, size_t len,
210 int copyinstr (const void *udaddr, void *kaddr, size_t len,
212 int copyin (const void *udaddr, void *kaddr, size_t len);
213 int copyout (const void *kaddr, void *udaddr, size_t len);
215 int fubyte (const void *base);
216 int subyte (void *base, int byte);
217 long fuword (const void *base);
218 int suword (void *base, long word);
219 int fusword (void *base);
220 int susword (void *base, int word);
222 void realitexpire (void *);
223 void DELAY(int usec);
224 void DRIVERSLEEP(int usec);
226 void startprofclock (struct proc *);
227 void stopprofclock (struct proc *);
228 void setstatclockrate (int hzrate);
231 * Console I/O spinlocks - these typically also hard-disable interrupts
234 void cons_lock(void);
235 void cons_unlock(void);
238 * Kernel environment support functions and sundry.
240 char *kgetenv (const char *name);
241 int ksetenv(const char *name, const char *value);
242 int kunsetenv(const char *name);
243 void kfreeenv(char *env);
244 int ktestenv(const char *name);
245 int kgetenv_int (const char *name, int *data);
246 int kgetenv_string (const char *name, char *data, int size);
247 int kgetenv_quad (const char *name, quad_t *data);
248 extern char *kern_envp;
250 #ifdef APM_FIXUP_CALLTODO
251 void adjust_timeout_calltodo (struct timeval *time_change);
252 #endif /* APM_FIXUP_CALLTODO */
254 #include <sys/libkern.h>
256 /* Initialize the world */
257 void mi_startup (void);
258 void cpu_initclocks (void *arg __unused);
261 /* Finalize the world. */
262 void shutdown_nice (int);
265 * Kernel to clock driver interface.
267 void inittodr (time_t base);
268 void resettodr (void);
269 void startrtclock (void);
272 typedef void timeout_t (void *); /* timeout function type */
274 /* Interrupt management */
277 * For the alpha arch, some of these functions are static __inline, and
278 * the others should be.
281 void setdelayed (void);
282 void setsoftcambio (void);
283 void setsoftcamnet (void);
284 void setsoftunused02 (void);
285 void setsoftcrypto (void);
286 void setsoftunused01 (void);
287 void setsofttty (void);
288 void setsoftvm (void);
289 void setsofttq (void);
290 void schedsofttty (void);
292 #endif /* __i386__ */
295 * Various callout lists.
298 /* Exit callout list declarations. */
299 typedef void (*exitlist_fn) (struct thread *td);
301 int at_exit (exitlist_fn function);
302 int rm_at_exit (exitlist_fn function);
304 /* Fork callout list declarations. */
305 typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
308 int at_fork (forklist_fn function);
309 int rm_at_fork (forklist_fn function);
312 * Not exactly a callout LIST, but a callout entry.
313 * Allow an external module to define a hardware watchdog tickler.
314 * Normally a process would do this, but there are times when the
315 * kernel needs to be able to hold off the watchdog, when the process
316 * is not active, e.g., when dumping core.
318 typedef void (*watchdog_tickle_fn) (void);
320 extern watchdog_tickle_fn wdog_tickler;
323 * Common `proc' functions are declared here so that proc.h can be included
326 int tsleep (void *, int, const char *, int);
327 int msleep (void *, struct spinlock *, int, const char *, int);
328 void tsleep_interlock (void *chan);
329 int lwkt_sleep (const char *, int);
331 void wakeup (void *chan);
332 void wakeup_one (void *chan);
333 void wakeup_mycpu (void *chan);
334 void wakeup_mycpu_one (void *chan);
335 void wakeup_oncpu (struct globaldata *gd, void *chan);
336 void wakeup_oncpu_one (struct globaldata *gd, void *chan);
337 void wakeup_domain (void *chan, int domain);
338 void wakeup_domain_one (void *chan, int domain);
341 * Common `cdev_t' stuff are declared here to avoid #include poisoning
346 udev_t dev2udev(cdev_t x);
347 cdev_t udev2dev(udev_t x, int b);
348 int uminor(udev_t dev);
349 int umajor(udev_t dev);
350 udev_t makeudev(int x, int y);
353 #endif /* !_SYS_SYSTM_H_ */