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 $
46 #error "This file should not be included by userland programs."
49 #ifndef _MACHINE_TYPES_H_
50 #include <machine/types.h>
52 #include <machine/stdarg.h>
53 #include <machine/atomic.h>
54 #include <machine/cpufunc.h>
55 #include <sys/callout.h>
57 extern int securelevel; /* system security level (see init(8)) */
58 extern int kernel_mem_readonly; /* disable writes to kernel memory */
60 extern int cold; /* nonzero if we are doing a cold boot */
61 extern int tsleep_now_works; /* tsleep won't just return any more */
62 extern const char *panicstr; /* panic message */
63 extern int dumping; /* system is dumping */
64 extern int safepri; /* safe ipl when cold or panicing */
65 extern int osreldate; /* System release date */
66 extern char version[]; /* system version */
67 extern char copyright[]; /* system copyright */
69 extern int selwait; /* select timeout address */
71 extern u_char curpriority; /* priority of current process */
73 extern long physmem; /* physical memory */
75 extern cdev_t dumpdev; /* dump device */
76 extern u_int64_t dumplo64; /* block number into dumpdev, start of dump */
78 extern cdev_t rootdev; /* root device */
79 extern cdev_t rootdevs[2]; /* possible root devices */
80 extern char *rootdevnames[2]; /* names of possible root devices */
81 extern char *ZeroPage;
83 extern int boothowto; /* reboot flags, from console subsystem */
84 extern int bootverbose; /* nonzero to print verbose messages */
86 extern int maxusers; /* system tune hint */
88 extern int ncpus; /* total number of cpus (real, hyper, virtual)*/
89 extern int ncpus2; /* ncpus rounded down to power of 2 */
90 extern int ncpus2_shift; /* log base 2 of ncpus2 */
91 extern int ncpus2_mask; /* ncpus2 - 1 */
92 extern int ncpus_fit; /* round up to a power of 2 */
93 extern int ncpus_fit_mask; /* ncpus_fit - 1 */
94 extern int clocks_running; /* timing/timeout subsystem is operational */
96 /* XXX TGEN these don't belong here, they're MD on i386/x86_64 */
97 extern u_int cpu_feature; /* CPUID_* features */
98 extern u_int cpu_feature2; /* CPUID2_* features */
99 extern u_int cpu_mi_feature; /* CPU_MI_XXX machine-nonspecific features */
100 extern cpumask_t usched_global_cpumask;
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\" failed " \
110 "in %s at %s:%u", #exp, __func__, \
111 __FILE__, __LINE__); } while (0)
114 #define KASSERT(exp,msg)
115 #define KKASSERT(exp)
116 #define __debugvar __attribute__((__unused__))
119 #define CTASSERT(x) _CTASSERT(x, __LINE__)
120 #define _CTASSERT(x, y) __CTASSERT(x, y)
121 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
124 * General function declarations.
131 struct lwkt_serialize;
146 void Debugger (const char *msg);
147 void print_backtrace(int count);
148 void mi_gdinit (struct globaldata *gd, int cpu);
149 void mi_proc0init(struct globaldata *gd, struct user *proc0paddr);
151 int seltrue (cdev_t dev, int which);
152 int ureadc (int, struct uio *);
153 void *hashinit (int count, struct malloc_type *type, u_long *hashmask);
154 void hashdestroy(void *vhashtbl, struct malloc_type *type, u_long hashmask);
155 void *phashinit (int count, struct malloc_type *type, u_long *nentries);
156 void *hashinit_ext (int count, size_t size,
157 struct malloc_type *type, u_long *hashmask);
158 void *phashinit_ext (int count, size_t size,
159 struct malloc_type *type, u_long *nentries);
161 int cpu_sanitize_frame (struct trapframe *);
162 int cpu_sanitize_tls (struct savetls *);
163 void cpu_spinlock_contested(void);
164 void cpu_halt (void);
165 void cpu_reset (void);
167 void cpu_rootconf (void);
168 void cpu_vmspace_alloc(struct vmspace *);
169 void cpu_vmspace_free(struct vmspace *);
170 void cpu_vkernel_trap(struct trapframe *, int);
171 void set_user_TLS(void);
172 void set_vkernel_fp(struct trapframe *);
173 int kvm_access_check(vm_offset_t, vm_offset_t, int);
175 vm_paddr_t kvtop(void *addr);
177 extern uint32_t crc32_tab[];
178 uint32_t crc32(const void *buf, size_t size);
179 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc);
180 uint32_t iscsi_crc32(const void *buf, size_t size);
181 uint32_t iscsi_crc32_ext(const void *buf, size_t size, uint32_t ocrc);
182 void init_param1 (void);
183 void init_param2 (int physpages);
184 void tablefull (const char *);
185 int kvcprintf (char const *, void (*)(int, void*), void *, int,
186 __va_list) __printflike(1, 0);
187 void kvcreinitspin(void);
188 int log (int, const char *, ...) __printflike(2, 3);
189 void logwakeup (void);
190 void log_console (struct uio *);
191 int kprintf (const char *, ...) __printflike(1, 2);
192 void kprintf0 (const char *, ...) __printflike(1, 2);
193 void krateprintf (struct krate *, const char *, ...) __printflike(2, 3);
194 int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
195 int ksnrprintf (char *, size_t, int, const char *, ...) __printflike(4, 5);
196 int ksprintf (char *buf, const char *, ...) __printflike(2, 3);
197 int uprintf (const char *, ...) __printflike(1, 2);
198 int kvprintf (const char *, __va_list) __printflike(1, 0);
199 int kvsnprintf (char *, size_t, const char *,
200 __va_list) __printflike(3, 0);
201 int kvsnrprintf (char *, size_t, int, const char *,
202 __va_list) __printflike(4, 0);
203 int kvasnrprintf (char **, size_t, int, const char *,
204 __va_list) __printflike(4, 0);
205 int kvsprintf (char *buf, const char *,
206 __va_list) __printflike(2, 0);
207 int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
208 void hexdump (const void *ptr, int length, const char *hdr, int flags);
209 #define HD_COLUMN_MASK 0xff
210 #define HD_DELIM_MASK 0xff00
211 #define HD_OMIT_COUNT (1 << 16)
212 #define HD_OMIT_HEX (1 << 17)
213 #define HD_OMIT_CHARS (1 << 18)
214 int ksscanf (const char *, char const *, ...) __scanflike(2, 3);
215 int kvsscanf (const char *, char const *, __va_list) __scanflike(2, 0);
216 void kvasfree(char **);
218 long strtol (const char *, char **, int);
219 u_long strtoul (const char *, char **, int);
220 quad_t strtoq (const char *, char **, int);
221 u_quad_t strtouq (const char *, char **, int);
224 * note: some functions commonly used by device drivers may be passed
225 * pointers to volatile storage, volatile set to avoid warnings.
227 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is
228 * explicitly not meant to be sophisticated.
229 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
230 * This routine is explicitly not meant to be sophisticated.
232 void bcopyb (const void *from, void *to, size_t len);
233 void bcopyi (const void *from, void *to, size_t len);
234 void bcopy (volatile const void *from, volatile void *to, size_t len);
235 void ovbcopy (const void *from, void *to, size_t len);
236 void bzero (volatile void *buf, size_t len);
237 void bzeront (volatile void *buf, size_t len);
238 void *memcpy (void *to, const void *from, size_t len);
240 int copystr (const void *kfaddr, void *kdaddr, size_t len,
242 int copyinstr (const void *udaddr, void *kaddr, size_t len,
244 int copyin (const void *udaddr, void *kaddr, size_t len);
245 int copyout (const void *kaddr, void *udaddr, size_t len);
247 int fubyte (const void *base);
248 int subyte (void *base, int byte);
249 long fuword (const void *base);
250 int suword (void *base, long word);
251 int suword32 (void *base, int word);
252 int fusword (void *base);
253 int susword (void *base, int word);
254 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
256 void realitexpire (void *);
257 void DELAY(int usec);
258 void DRIVERSLEEP(int usec);
260 void startprofclock (struct proc *);
261 void stopprofclock (struct proc *);
262 void setstatclockrate (int hzrate);
265 * Kernel environment support functions and sundry.
267 char *kgetenv (const char *name);
268 int ksetenv(const char *name, const char *value);
269 int kunsetenv(const char *name);
270 void kfreeenv(char *env);
271 int ktestenv(const char *name);
272 int kgetenv_int (const char *name, int *data);
273 int kgetenv_string (const char *name, char *data, int size);
274 int kgetenv_ulong(const char *name, unsigned long *data);
275 int kgetenv_quad (const char *name, quad_t *data);
276 int kgetenv_long(const char *name, long *data);
277 extern char *kern_envp;
279 #ifdef APM_FIXUP_CALLTODO
280 void adjust_timeout_calltodo (struct timeval *time_change);
281 #endif /* APM_FIXUP_CALLTODO */
283 #include <sys/libkern.h>
285 /* Initialize the world */
286 void mi_startup (void);
289 /* Finalize the world. */
290 void shutdown_nice (int);
293 * Kernel to clock driver interface.
295 void inittodr (time_t base);
296 void resettodr (void);
297 void startrtclock (void);
300 typedef void timeout_t (void *); /* timeout function type */
302 /* Interrupt management */
305 * For the alpha arch, some of these functions are static __inline, and
306 * the others should be.
308 #if defined(__i386__) || defined(__x86_64__)
309 void setdelayed (void);
310 void setsoftcambio (void);
311 void setsoftcamnet (void);
312 void setsoftunused02 (void);
313 void setsoftcrypto (void);
314 void setsoftunused01 (void);
315 void setsofttty (void);
316 void setsoftvm (void);
317 void setsofttq (void);
318 void schedsofttty (void);
320 void splz_check (void);
321 void cpu_mmw_pause_int(int*, int);
322 void cpu_mmw_pause_long(long*, long);
323 #endif /* __i386__ */
326 * Various callout lists.
329 /* Exit callout list declarations. */
330 typedef void (*exitlist_fn) (struct thread *td);
332 int at_exit (exitlist_fn function);
333 int rm_at_exit (exitlist_fn function);
335 /* Fork callout list declarations. */
336 typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
339 int at_fork (forklist_fn function);
340 int rm_at_fork (forklist_fn function);
343 * Not exactly a callout LIST, but a callout entry.
344 * Allow an external module to define a hardware watchdog tickler.
345 * Normally a process would do this, but there are times when the
346 * kernel needs to be able to hold off the watchdog, when the process
347 * is not active, e.g., when dumping core.
349 typedef void (*watchdog_tickle_fn) (void);
351 extern watchdog_tickle_fn wdog_tickler;
352 extern struct globaldata *panic_cpu_gd;
355 * Common `proc' functions are declared here so that proc.h can be included
358 int tsleep (const volatile void *, int, const char *, int);
359 int ssleep (const volatile void *, struct spinlock *, int, const char *, int);
360 int lksleep (const volatile void *, struct lock *, int, const char *, int);
361 int mtxsleep (const volatile void *, struct mtx *, int, const char *, int);
362 int zsleep(const volatile void *, struct lwkt_serialize *, int, const char *, int);
363 void tsleep_interlock (const volatile void *, int);
364 void tsleep_remove (struct thread *);
365 int lwkt_sleep (const char *, int);
367 void wakeup (const volatile void *chan);
368 void wakeup_one (const volatile void *chan);
369 void wakeup_mycpu (const volatile void *chan);
370 void wakeup_mycpu_one (const volatile void *chan);
371 void wakeup_oncpu (struct globaldata *gd, const volatile void *chan);
372 void wakeup_oncpu_one (struct globaldata *gd, const volatile void *chan);
373 void wakeup_domain (const volatile void *chan, int domain);
374 void wakeup_domain_one (const volatile void *chan, int domain);
375 void wakeup_start_delayed(void);
376 void wakeup_end_delayed(void);
379 * Common `cdev_t' stuff are declared here to avoid #include poisoning
384 udev_t dev2udev(cdev_t x);
385 cdev_t udev2dev(udev_t x, int b);
386 int uminor(udev_t dev);
387 int umajor(udev_t dev);
388 udev_t makeudev(int x, int y);
391 #endif /* !_SYS_SYSTM_H_ */