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 u_int64_t dumplo64
; /* block number into dumpdev, start of dump */
80 extern cdev_t rootdev
; /* root device */
81 extern cdev_t rootdevs
[2]; /* possible root devices */
82 extern char *rootdevnames
[2]; /* names of possible root devices */
83 extern char *ZeroPage
;
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/x86_64 */
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 (__predict_false(!(exp))) \
107 panic msg; } while (0)
108 #define KKASSERT(exp) do { if (__predict_false(!(exp))) \
109 panic("assertion: %s in %s", \
110 #exp, __func__); } while (0)
113 #define KASSERT(exp,msg)
114 #define KKASSERT(exp)
115 #define __debugvar __attribute__((__unused__))
118 #define CTASSERT(x) _CTASSERT(x, __LINE__)
119 #define _CTASSERT(x, y) __CTASSERT(x, y)
120 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
123 * General function declarations.
130 struct lwkt_serialize
;
145 void Debugger (const char *msg
);
146 void print_backtrace(void);
147 void mi_gdinit (struct globaldata
*gd
, int cpu
);
148 void mi_proc0init(struct globaldata
*gd
, struct user
*proc0paddr
);
150 int seltrue (cdev_t dev
, int which
);
151 int ureadc (int, struct uio
*);
152 void *hashinit (int count
, struct malloc_type
*type
, u_long
*hashmask
);
153 void *phashinit (int count
, struct malloc_type
*type
, u_long
*nentries
);
154 void *hashinit_ext (int count
, size_t size
,
155 struct malloc_type
*type
, u_long
*hashmask
);
156 void *phashinit_ext (int count
, size_t size
,
157 struct malloc_type
*type
, u_long
*nentries
);
159 int cpu_sanitize_frame (struct trapframe
*);
160 int cpu_sanitize_tls (struct savetls
*);
161 void cpu_spinlock_contested(void);
162 void cpu_halt (void);
163 void cpu_reset (void);
165 void cpu_rootconf (void);
166 void cpu_vmspace_alloc(struct vmspace
*);
167 void cpu_vmspace_free(struct vmspace
*);
168 void cpu_vkernel_trap(struct trapframe
*, int);
169 void set_user_TLS(void);
170 void set_vkernel_fp(struct trapframe
*);
171 int kvm_access_check(vm_offset_t
, vm_offset_t
, int);
173 vm_paddr_t
kvtop(void *addr
);
174 int is_physical_memory (vm_offset_t addr
);
176 extern uint32_t crc32_tab
[];
177 uint32_t crc32(const void *buf
, size_t size
);
178 uint32_t crc32_ext(const void *buf
, size_t size
, uint32_t ocrc
);
179 void init_param1 (void);
180 void init_param2 (int physpages
);
181 void tablefull (const char *);
182 int kvcprintf (char const *, void (*)(int, void*), void *, int,
183 __va_list
) __printflike(1, 0);
184 int log (int, const char *, ...) __printflike(2, 3);
185 void logwakeup (void);
186 void log_console (struct uio
*);
187 int kprintf (const char *, ...) __printflike(1, 2);
188 int kprintf0(const char *, ...) __printflike(1, 2);
189 void krateprintf (struct krate
*, const char *, ...) __printflike(2, 3);
190 int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
191 int ksnrprintf (char *, size_t, int, const char *, ...) __printflike(4, 5);
192 int ksprintf (char *buf
, const char *, ...) __printflike(2, 3);
193 int uprintf (const char *, ...) __printflike(1, 2);
194 int kvprintf (const char *, __va_list
) __printflike(1, 0);
195 int kvsnprintf (char *, size_t, const char *,
196 __va_list
) __printflike(3, 0);
197 int kvsnrprintf (char *, size_t, int, const char *,
198 __va_list
) __printflike(4, 0);
199 int kvasnrprintf (char **, size_t, int, const char *,
200 __va_list
) __printflike(4, 0);
201 int kvsprintf (char *buf
, const char *,
202 __va_list
) __printflike(2, 0);
203 int ttyprintf (struct tty
*, const char *, ...) __printflike(2, 3);
204 int ksscanf (const char *, char const *, ...);
205 int kvsscanf (const char *, char const *, __va_list
);
206 void kvasfree(char **);
208 long strtol (const char *, char **, int);
209 u_long
strtoul (const char *, char **, int);
210 quad_t
strtoq (const char *, char **, int);
211 u_quad_t
strtouq (const char *, char **, int);
214 * note: some functions commonly used by device drivers may be passed
215 * pointers to volatile storage, volatile set to avoid warnings.
217 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is
218 * explicitly not meant to be sophisticated.
219 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
220 * This routine is explicitly not meant to be sophisticated.
222 void bcopyb (const void *from
, void *to
, size_t len
);
223 void bcopyi (const void *from
, void *to
, size_t len
);
224 void bcopy (volatile const void *from
, volatile void *to
, size_t len
);
225 void ovbcopy (const void *from
, void *to
, size_t len
);
226 void bzero (volatile void *buf
, size_t len
);
227 void *memcpy (void *to
, const void *from
, size_t len
);
229 int copystr (const void *kfaddr
, void *kdaddr
, size_t len
,
231 int copyinstr (const void *udaddr
, void *kaddr
, size_t len
,
233 int copyin (const void *udaddr
, void *kaddr
, size_t len
);
234 int copyout (const void *kaddr
, void *udaddr
, size_t len
);
236 int fubyte (const void *base
);
237 int subyte (void *base
, int byte
);
238 long fuword (const void *base
);
239 int suword (void *base
, long word
);
240 int fusword (void *base
);
241 int susword (void *base
, int word
);
243 void realitexpire (void *);
244 void DELAY(int usec
);
245 void DRIVERSLEEP(int usec
);
247 void startprofclock (struct proc
*);
248 void stopprofclock (struct proc
*);
249 void setstatclockrate (int hzrate
);
252 * Console I/O spinlocks - these typically also hard-disable interrupts
255 void cons_lock(void);
256 void cons_unlock(void);
259 * Kernel environment support functions and sundry.
261 char *kgetenv (const char *name
);
262 int ksetenv(const char *name
, const char *value
);
263 int kunsetenv(const char *name
);
264 void kfreeenv(char *env
);
265 int ktestenv(const char *name
);
266 int kgetenv_int (const char *name
, int *data
);
267 int kgetenv_string (const char *name
, char *data
, int size
);
268 int kgetenv_ulong(const char *name
, unsigned long *data
);
269 int kgetenv_quad (const char *name
, quad_t
*data
);
270 int kgetenv_long(const char *name
, long *data
);
271 extern char *kern_envp
;
273 #ifdef APM_FIXUP_CALLTODO
274 void adjust_timeout_calltodo (struct timeval
*time_change
);
275 #endif /* APM_FIXUP_CALLTODO */
277 #include <sys/libkern.h>
279 /* Initialize the world */
280 void mi_startup (void);
283 /* Finalize the world. */
284 void shutdown_nice (int);
287 * Kernel to clock driver interface.
289 void inittodr (time_t base
);
290 void resettodr (void);
291 void startrtclock (void);
294 typedef void timeout_t (void *); /* timeout function type */
296 /* Interrupt management */
299 * For the alpha arch, some of these functions are static __inline, and
300 * the others should be.
302 #if defined(__i386__) || defined(__x86_64__)
303 void setdelayed (void);
304 void setsoftcambio (void);
305 void setsoftcamnet (void);
306 void setsoftunused02 (void);
307 void setsoftcrypto (void);
308 void setsoftunused01 (void);
309 void setsofttty (void);
310 void setsoftvm (void);
311 void setsofttq (void);
312 void schedsofttty (void);
314 void splz_check (void);
315 #endif /* __i386__ */
318 * Various callout lists.
321 /* Exit callout list declarations. */
322 typedef void (*exitlist_fn
) (struct thread
*td
);
324 int at_exit (exitlist_fn function
);
325 int rm_at_exit (exitlist_fn function
);
327 /* Fork callout list declarations. */
328 typedef void (*forklist_fn
) (struct proc
*parent
, struct proc
*child
,
331 int at_fork (forklist_fn function
);
332 int rm_at_fork (forklist_fn function
);
335 * Not exactly a callout LIST, but a callout entry.
336 * Allow an external module to define a hardware watchdog tickler.
337 * Normally a process would do this, but there are times when the
338 * kernel needs to be able to hold off the watchdog, when the process
339 * is not active, e.g., when dumping core.
341 typedef void (*watchdog_tickle_fn
) (void);
343 extern watchdog_tickle_fn wdog_tickler
;
346 * Common `proc' functions are declared here so that proc.h can be included
349 int tsleep (void *, int, const char *, int);
350 int ssleep (void *, struct spinlock
*, int, const char *, int);
351 int lksleep (void *, struct lock
*, int, const char *, int);
352 int mtxsleep (void *, struct mtx
*, int, const char *, int);
353 int zsleep(void *, struct lwkt_serialize
*, int, const char *, int);
354 void tsleep_interlock (void *, int);
355 void tsleep_remove (struct thread
*);
356 int lwkt_sleep (const char *, int);
358 void wakeup (void *chan
);
359 void wakeup_one (void *chan
);
360 void wakeup_mycpu (void *chan
);
361 void wakeup_mycpu_one (void *chan
);
362 void wakeup_oncpu (struct globaldata
*gd
, void *chan
);
363 void wakeup_oncpu_one (struct globaldata
*gd
, void *chan
);
364 void wakeup_domain (void *chan
, int domain
);
365 void wakeup_domain_one (void *chan
, int domain
);
368 * Common `cdev_t' stuff are declared here to avoid #include poisoning
373 udev_t
dev2udev(cdev_t x
);
374 cdev_t
udev2dev(udev_t x
, int b
);
375 int uminor(udev_t dev
);
376 int umajor(udev_t dev
);
377 udev_t
makeudev(int x
, int y
);
380 #endif /* !_SYS_SYSTM_H_ */