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 */
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 (__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)
112 #define KASSERT(exp,msg)
113 #define KKASSERT(exp)
116 #define CTASSERT(x) _CTASSERT(x, __LINE__)
117 #define _CTASSERT(x, y) __CTASSERT(x, y)
118 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
121 * General function declarations.
126 struct lwkt_serialize
;
141 void Debugger (const char *msg
);
142 void print_backtrace(void);
143 void mi_gdinit (struct globaldata
*gd
, int cpu
);
144 void mi_proc0init(struct globaldata
*gd
, struct user
*proc0paddr
);
145 int dumpstatus (vm_offset_t addr
, off_t count
);
147 int seltrue (cdev_t dev
, int which
);
148 int ureadc (int, struct uio
*);
149 void *hashinit (int count
, struct malloc_type
*type
, u_long
*hashmask
);
150 void *phashinit (int count
, struct malloc_type
*type
, u_long
*nentries
);
152 int cpu_sanitize_frame (struct trapframe
*);
153 int cpu_sanitize_tls (struct savetls
*);
154 void cpu_mplock_contested(void);
155 void cpu_spinlock_contested(void);
156 void cpu_halt (void);
157 void cpu_reset (void);
159 void cpu_rootconf (void);
160 void cpu_vmspace_alloc(struct vmspace
*);
161 void cpu_vmspace_free(struct vmspace
*);
162 void set_user_TLS(void);
163 void set_vkernel_fp(struct trapframe
*);
164 int kvm_access_check(vm_offset_t
, vm_offset_t
, int);
166 vm_paddr_t
kvtop(void *addr
);
167 int is_physical_memory (vm_offset_t addr
);
169 extern uint32_t crc32_tab
[];
170 uint32_t crc32(const void *buf
, size_t size
);
171 uint32_t crc32_ext(const void *buf
, size_t size
, uint32_t ocrc
);
172 void init_param1 (void);
173 void init_param2 (int physpages
);
174 void tablefull (const char *);
175 int kvcprintf (char const *, void (*)(int, void*), void *, int,
176 __va_list
) __printflike(1, 0);
177 int log (int, const char *, ...) __printflike(2, 3);
178 void logwakeup (void);
179 void log_console (struct uio
*);
180 int kprintf (const char *, ...) __printflike(1, 2);
181 int kprintf0(const char *, ...) __printflike(1, 2);
182 void krateprintf (struct krate
*, const char *, ...) __printflike(2, 3);
183 int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
184 int ksprintf (char *buf
, const char *, ...) __printflike(2, 3);
185 int uprintf (const char *, ...) __printflike(1, 2);
186 int kvprintf (const char *, __va_list
) __printflike(1, 0);
187 int kvsnprintf (char *, size_t, const char *, __va_list
) __printflike(3, 0);
188 int kvsprintf (char *buf
, const char *, __va_list
) __printflike(2, 0);
189 int ttyprintf (struct tty
*, const char *, ...) __printflike(2, 3);
190 int ksscanf (const char *, char const *, ...);
191 int kvsscanf (const char *, char const *, __va_list
);
193 long strtol (const char *, char **, int);
194 u_long
strtoul (const char *, char **, int);
195 quad_t
strtoq (const char *, char **, int);
196 u_quad_t
strtouq (const char *, char **, int);
199 * note: some functions commonly used by device drivers may be passed
200 * pointers to volatile storage, volatile set to avoid warnings.
202 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is
203 * explicitly not meant to be sophisticated.
204 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
205 * This routine is explicitly not meant to be sophisticated.
207 void bcopyb (const void *from
, void *to
, size_t len
);
208 void bcopyi (const void *from
, void *to
, size_t len
);
209 void bcopy (volatile const void *from
, volatile void *to
, size_t len
);
210 void ovbcopy (const void *from
, void *to
, size_t len
);
211 void bzero (volatile void *buf
, size_t len
);
212 void *memcpy (void *to
, const void *from
, size_t len
);
214 int copystr (const void *kfaddr
, void *kdaddr
, size_t len
,
216 int copyinstr (const void *udaddr
, void *kaddr
, size_t len
,
218 int copyin (const void *udaddr
, void *kaddr
, size_t len
);
219 int copyout (const void *kaddr
, void *udaddr
, size_t len
);
221 int fubyte (const void *base
);
222 int subyte (void *base
, int byte
);
223 long fuword (const void *base
);
224 int suword (void *base
, long word
);
225 int fusword (void *base
);
226 int susword (void *base
, int word
);
228 void realitexpire (void *);
229 void DELAY(int usec
);
230 void DRIVERSLEEP(int usec
);
232 void startprofclock (struct proc
*);
233 void stopprofclock (struct proc
*);
234 void setstatclockrate (int hzrate
);
237 * Console I/O spinlocks - these typically also hard-disable interrupts
240 void cons_lock(void);
241 void cons_unlock(void);
244 * Kernel environment support functions and sundry.
246 char *kgetenv (const char *name
);
247 int ksetenv(const char *name
, const char *value
);
248 int kunsetenv(const char *name
);
249 void kfreeenv(char *env
);
250 int ktestenv(const char *name
);
251 int kgetenv_int (const char *name
, int *data
);
252 int kgetenv_string (const char *name
, char *data
, int size
);
253 int kgetenv_ulong(const char *name
, unsigned long *data
);
254 int kgetenv_quad (const char *name
, quad_t
*data
);
255 extern char *kern_envp
;
257 #ifdef APM_FIXUP_CALLTODO
258 void adjust_timeout_calltodo (struct timeval
*time_change
);
259 #endif /* APM_FIXUP_CALLTODO */
261 #include <sys/libkern.h>
263 /* Initialize the world */
264 void mi_startup (void);
265 void cpu_initclocks (void *arg __unused
);
268 /* Finalize the world. */
269 void shutdown_nice (int);
272 * Kernel to clock driver interface.
274 void inittodr (time_t base
);
275 void resettodr (void);
276 void startrtclock (void);
279 typedef void timeout_t (void *); /* timeout function type */
281 /* Interrupt management */
284 * For the alpha arch, some of these functions are static __inline, and
285 * the others should be.
287 #if defined(__i386__) || defined(__amd64__)
288 void setdelayed (void);
289 void setsoftcambio (void);
290 void setsoftcamnet (void);
291 void setsoftunused02 (void);
292 void setsoftcrypto (void);
293 void setsoftunused01 (void);
294 void setsofttty (void);
295 void setsoftvm (void);
296 void setsofttq (void);
297 void schedsofttty (void);
299 #endif /* __i386__ */
302 * Various callout lists.
305 /* Exit callout list declarations. */
306 typedef void (*exitlist_fn
) (struct thread
*td
);
308 int at_exit (exitlist_fn function
);
309 int rm_at_exit (exitlist_fn function
);
311 /* Fork callout list declarations. */
312 typedef void (*forklist_fn
) (struct proc
*parent
, struct proc
*child
,
315 int at_fork (forklist_fn function
);
316 int rm_at_fork (forklist_fn function
);
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.
325 typedef void (*watchdog_tickle_fn
) (void);
327 extern watchdog_tickle_fn wdog_tickler
;
330 * Common `proc' functions are declared here so that proc.h can be included
333 int tsleep (void *, int, const char *, int);
334 int msleep (void *, struct spinlock
*, int, const char *, int);
335 int serialize_sleep(void *, struct lwkt_serialize
*, int,
337 void tsleep_interlock (void *chan
);
338 int lwkt_sleep (const char *, int);
340 void wakeup (void *chan
);
341 void wakeup_one (void *chan
);
342 void wakeup_mycpu (void *chan
);
343 void wakeup_mycpu_one (void *chan
);
344 void wakeup_oncpu (struct globaldata
*gd
, void *chan
);
345 void wakeup_oncpu_one (struct globaldata
*gd
, void *chan
);
346 void wakeup_domain (void *chan
, int domain
);
347 void wakeup_domain_one (void *chan
, int domain
);
350 * Common `cdev_t' stuff are declared here to avoid #include poisoning
355 udev_t
dev2udev(cdev_t x
);
356 cdev_t
udev2dev(udev_t x
, int b
);
357 int uminor(udev_t dev
);
358 int umajor(udev_t dev
);
359 udev_t
makeudev(int x
, int y
);
362 #endif /* !_SYS_SYSTM_H_ */