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.81 2008/09/11 00:35:49 dillon 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 */
84 extern char *ZeroPage
;
86 extern int boothowto
; /* reboot flags, from console subsystem */
87 extern int bootverbose
; /* nonzero to print verbose messages */
89 extern int maxusers
; /* system tune hint */
91 extern int ncpus
; /* total number of cpus (real, hyper, virtual)*/
92 extern int ncpus2
; /* ncpus rounded down to power of 2 */
93 extern int ncpus2_shift
; /* log base 2 of ncpus2 */
94 extern int ncpus2_mask
; /* ncpus2 - 1 */
95 extern int ncpus_fit
; /* round up to a power of 2 */
96 extern int ncpus_fit_mask
; /* ncpus_fit - 1 */
97 extern int clocks_running
; /* timing/timeout subsystem is operational */
99 /* XXX TGEN these don't belong here, they're MD on i386/amd64 */
100 extern u_int cpu_feature
; /* CPUID_* features */
101 extern u_int cpu_feature2
; /* CPUID2_* features */
103 extern int nfs_diskless_valid
; /* NFS diskless params were obtained */
104 extern vm_paddr_t Maxmem
; /* Highest physical memory address in system */
106 #ifdef INVARIANTS /* The option is always available */
107 #define KASSERT(exp,msg) do { if (__predict_false(!(exp))) \
108 panic msg; } while (0)
109 #define KKASSERT(exp) do { if (__predict_false(!(exp))) \
110 panic("assertion: %s in %s", \
111 #exp, __func__); } while (0)
113 #define KASSERT(exp,msg)
114 #define KKASSERT(exp)
117 #define CTASSERT(x) _CTASSERT(x, __LINE__)
118 #define _CTASSERT(x, y) __CTASSERT(x, y)
119 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
122 * General function declarations.
128 struct lwkt_serialize
;
143 void Debugger (const char *msg
);
144 void print_backtrace(void);
145 void mi_gdinit (struct globaldata
*gd
, int cpu
);
146 void mi_proc0init(struct globaldata
*gd
, struct user
*proc0paddr
);
147 int dumpstatus (vm_offset_t addr
, off_t count
);
149 int seltrue (cdev_t dev
, int which
);
150 int ureadc (int, struct uio
*);
151 void *hashinit (int count
, struct malloc_type
*type
, u_long
*hashmask
);
152 void *phashinit (int count
, struct malloc_type
*type
, u_long
*nentries
);
154 int cpu_sanitize_frame (struct trapframe
*);
155 int cpu_sanitize_tls (struct savetls
*);
156 void cpu_mplock_contested(void);
157 void cpu_spinlock_contested(void);
158 void cpu_halt (void);
159 void cpu_reset (void);
161 void cpu_rootconf (void);
162 void cpu_vmspace_alloc(struct vmspace
*);
163 void cpu_vmspace_free(struct vmspace
*);
164 void set_user_TLS(void);
165 void set_vkernel_fp(struct trapframe
*);
166 int kvm_access_check(vm_offset_t
, vm_offset_t
, int);
168 vm_paddr_t
kvtop(void *addr
);
169 int is_physical_memory (vm_offset_t addr
);
171 extern uint32_t crc32_tab
[];
172 uint32_t crc32(const void *buf
, size_t size
);
173 uint32_t crc32_ext(const void *buf
, size_t size
, uint32_t ocrc
);
174 void init_param1 (void);
175 void init_param2 (int physpages
);
176 void tablefull (const char *);
177 int kvcprintf (char const *, void (*)(int, void*), void *, int,
178 __va_list
) __printflike(1, 0);
179 int log (int, const char *, ...) __printflike(2, 3);
180 void logwakeup (void);
181 void log_console (struct uio
*);
182 int kprintf (const char *, ...) __printflike(1, 2);
183 int kprintf0(const char *, ...) __printflike(1, 2);
184 void krateprintf (struct krate
*, const char *, ...) __printflike(2, 3);
185 int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
186 int ksnrprintf (char *, size_t, int, const char *, ...) __printflike(4, 5);
187 int ksprintf (char *buf
, const char *, ...) __printflike(2, 3);
188 int uprintf (const char *, ...) __printflike(1, 2);
189 int kvprintf (const char *, __va_list
) __printflike(1, 0);
190 int kvsnprintf (char *, size_t, const char *,
191 __va_list
) __printflike(3, 0);
192 int kvsnrprintf (char *, size_t, int, const char *,
193 __va_list
) __printflike(4, 0);
194 int kvasnrprintf (char **, size_t, int, const char *,
195 __va_list
) __printflike(4, 0);
196 int kvsprintf (char *buf
, const char *,
197 __va_list
) __printflike(2, 0);
198 int ttyprintf (struct tty
*, const char *, ...) __printflike(2, 3);
199 int ksscanf (const char *, char const *, ...);
200 int kvsscanf (const char *, char const *, __va_list
);
201 void kvasfree(char **);
203 long strtol (const char *, char **, int);
204 u_long
strtoul (const char *, char **, int);
205 quad_t
strtoq (const char *, char **, int);
206 u_quad_t
strtouq (const char *, char **, int);
209 * note: some functions commonly used by device drivers may be passed
210 * pointers to volatile storage, volatile set to avoid warnings.
212 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is
213 * explicitly not meant to be sophisticated.
214 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
215 * This routine is explicitly not meant to be sophisticated.
217 void bcopyb (const void *from
, void *to
, size_t len
);
218 void bcopyi (const void *from
, void *to
, size_t len
);
219 void bcopy (volatile const void *from
, volatile void *to
, size_t len
);
220 void ovbcopy (const void *from
, void *to
, size_t len
);
221 void bzero (volatile void *buf
, size_t len
);
222 void *memcpy (void *to
, const void *from
, size_t len
);
224 int copystr (const void *kfaddr
, void *kdaddr
, size_t len
,
226 int copyinstr (const void *udaddr
, void *kaddr
, size_t len
,
228 int copyin (const void *udaddr
, void *kaddr
, size_t len
);
229 int copyout (const void *kaddr
, void *udaddr
, size_t len
);
231 int fubyte (const void *base
);
232 int subyte (void *base
, int byte
);
233 long fuword (const void *base
);
234 int suword (void *base
, long word
);
235 int fusword (void *base
);
236 int susword (void *base
, int word
);
238 void realitexpire (void *);
239 void DELAY(int usec
);
240 void DRIVERSLEEP(int usec
);
242 void startprofclock (struct proc
*);
243 void stopprofclock (struct proc
*);
244 void setstatclockrate (int hzrate
);
247 * Console I/O spinlocks - these typically also hard-disable interrupts
250 void cons_lock(void);
251 void cons_unlock(void);
254 * Kernel environment support functions and sundry.
256 char *kgetenv (const char *name
);
257 int ksetenv(const char *name
, const char *value
);
258 int kunsetenv(const char *name
);
259 void kfreeenv(char *env
);
260 int ktestenv(const char *name
);
261 int kgetenv_int (const char *name
, int *data
);
262 int kgetenv_string (const char *name
, char *data
, int size
);
263 int kgetenv_ulong(const char *name
, unsigned long *data
);
264 int kgetenv_quad (const char *name
, quad_t
*data
);
265 int kgetenv_long(const char *name
, long *data
);
266 extern char *kern_envp
;
268 #ifdef APM_FIXUP_CALLTODO
269 void adjust_timeout_calltodo (struct timeval
*time_change
);
270 #endif /* APM_FIXUP_CALLTODO */
272 #include <sys/libkern.h>
274 /* Initialize the world */
275 void mi_startup (void);
278 /* Finalize the world. */
279 void shutdown_nice (int);
282 * Kernel to clock driver interface.
284 void inittodr (time_t base
);
285 void resettodr (void);
286 void startrtclock (void);
289 typedef void timeout_t (void *); /* timeout function type */
291 /* Interrupt management */
294 * For the alpha arch, some of these functions are static __inline, and
295 * the others should be.
297 #if defined(__i386__) || defined(__amd64__)
298 void setdelayed (void);
299 void setsoftcambio (void);
300 void setsoftcamnet (void);
301 void setsoftunused02 (void);
302 void setsoftcrypto (void);
303 void setsoftunused01 (void);
304 void setsofttty (void);
305 void setsoftvm (void);
306 void setsofttq (void);
307 void schedsofttty (void);
309 void splz_check (void);
310 #endif /* __i386__ */
313 * Various callout lists.
316 /* Exit callout list declarations. */
317 typedef void (*exitlist_fn
) (struct thread
*td
);
319 int at_exit (exitlist_fn function
);
320 int rm_at_exit (exitlist_fn function
);
322 /* Fork callout list declarations. */
323 typedef void (*forklist_fn
) (struct proc
*parent
, struct proc
*child
,
326 int at_fork (forklist_fn function
);
327 int rm_at_fork (forklist_fn function
);
330 * Not exactly a callout LIST, but a callout entry.
331 * Allow an external module to define a hardware watchdog tickler.
332 * Normally a process would do this, but there are times when the
333 * kernel needs to be able to hold off the watchdog, when the process
334 * is not active, e.g., when dumping core.
336 typedef void (*watchdog_tickle_fn
) (void);
338 extern watchdog_tickle_fn wdog_tickler
;
341 * Common `proc' functions are declared here so that proc.h can be included
344 int tsleep (void *, int, const char *, int);
345 int ssleep (void *, struct spinlock
*, int, const char *, int);
346 int mtxsleep (void *, struct mtx
*, int, const char *, int);
347 int zsleep(void *, struct lwkt_serialize
*, int, const char *, int);
348 void tsleep_interlock (void *, int);
349 void tsleep_remove (struct thread
*);
350 int lwkt_sleep (const char *, int);
352 void wakeup (void *chan
);
353 void wakeup_one (void *chan
);
354 void wakeup_mycpu (void *chan
);
355 void wakeup_mycpu_one (void *chan
);
356 void wakeup_oncpu (struct globaldata
*gd
, void *chan
);
357 void wakeup_oncpu_one (struct globaldata
*gd
, void *chan
);
358 void wakeup_domain (void *chan
, int domain
);
359 void wakeup_domain_one (void *chan
, int domain
);
362 * Common `cdev_t' stuff are declared here to avoid #include poisoning
367 udev_t
dev2udev(cdev_t x
);
368 cdev_t
udev2dev(udev_t x
, int b
);
369 int uminor(udev_t dev
);
370 int umajor(udev_t dev
);
371 udev_t
makeudev(int x
, int y
);
374 #endif /* !_SYS_SYSTM_H_ */