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 */
72 extern int cpu_mwait_spin; /* typically set in machdep, used by lwkt */
73 extern int cpu_mwait_halt; /* typically set in machdep, used by idle */
75 extern long 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 */
101 extern u_int cpu_mi_feature; /* CPU_MI_XXX machine-nonspecific features */
102 extern cpumask_t usched_global_cpumask;
104 extern int nfs_diskless_valid; /* NFS diskless params were obtained */
105 extern vm_paddr_t Maxmem; /* Highest physical memory address in system */
107 #ifdef INVARIANTS /* The option is always available */
108 #define KASSERT(exp,msg) do { if (__predict_false(!(exp))) \
109 panic msg; } while (0)
110 #define KKASSERT(exp) do { if (__predict_false(!(exp))) \
111 panic("assertion \"%s\" failed " \
112 "in %s at %s:%u", #exp, __func__, \
113 __FILE__, __LINE__); } while (0)
116 #define KASSERT(exp,msg)
117 #define KKASSERT(exp)
118 #define __debugvar __attribute__((__unused__))
121 #define CTASSERT(x) _CTASSERT(x, __LINE__)
122 #define _CTASSERT(x, y) __CTASSERT(x, y)
123 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
126 * General function declarations.
133 struct lwkt_serialize;
148 void Debugger (const char *msg);
149 void print_backtrace(int count);
150 void mi_gdinit (struct globaldata *gd, int cpu);
151 void mi_proc0init(struct globaldata *gd, struct user *proc0paddr);
153 int seltrue (cdev_t dev, int which);
154 int ureadc (int, struct uio *);
155 void *hashinit (int count, struct malloc_type *type, u_long *hashmask);
156 void hashdestroy(void *vhashtbl, struct malloc_type *type, u_long hashmask);
157 void *phashinit (int count, struct malloc_type *type, u_long *nentries);
158 void *hashinit_ext (int count, size_t size,
159 struct malloc_type *type, u_long *hashmask);
160 void *phashinit_ext (int count, size_t size,
161 struct malloc_type *type, u_long *nentries);
163 int cpu_sanitize_frame (struct trapframe *);
164 int cpu_sanitize_tls (struct savetls *);
165 void cpu_spinlock_contested(void);
166 void cpu_halt (void);
167 void cpu_reset (void);
169 void cpu_rootconf (void);
170 void cpu_vmspace_alloc(struct vmspace *);
171 void cpu_vmspace_free(struct vmspace *);
172 void cpu_vkernel_trap(struct trapframe *, int);
173 void set_user_TLS(void);
174 void set_vkernel_fp(struct trapframe *);
175 int kvm_access_check(vm_offset_t, vm_offset_t, int);
177 vm_paddr_t kvtop(void *addr);
179 extern uint32_t crc32_tab[];
180 uint32_t crc32(const void *buf, size_t size);
181 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc);
182 uint32_t iscsi_crc32(const void *buf, size_t size);
183 uint32_t iscsi_crc32_ext(const void *buf, size_t size, uint32_t ocrc);
184 void init_param1 (void);
185 void init_param2 (int physpages);
186 void tablefull (const char *);
187 int kvcprintf (char const *, void (*)(int, void*), void *, int,
188 __va_list) __printflike(1, 0);
189 void kvcreinitspin(void);
190 int log (int, const char *, ...) __printflike(2, 3);
191 void logwakeup (void);
192 void log_console (struct uio *);
193 int kprintf (const char *, ...) __printflike(1, 2);
194 void kprintf0 (const char *, ...) __printflike(1, 2);
195 void krateprintf (struct krate *, const char *, ...) __printflike(2, 3);
196 int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
197 int ksnrprintf (char *, size_t, int, const char *, ...) __printflike(4, 5);
198 int ksprintf (char *buf, const char *, ...) __printflike(2, 3);
199 int uprintf (const char *, ...) __printflike(1, 2);
200 int kvprintf (const char *, __va_list) __printflike(1, 0);
201 int kvsnprintf (char *, size_t, const char *,
202 __va_list) __printflike(3, 0);
203 int kvsnrprintf (char *, size_t, int, const char *,
204 __va_list) __printflike(4, 0);
205 int kvasnrprintf (char **, size_t, int, const char *,
206 __va_list) __printflike(4, 0);
207 int kvsprintf (char *buf, const char *,
208 __va_list) __printflike(2, 0);
209 int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
210 void hexdump (const void *ptr, int length, const char *hdr, int flags);
211 #define HD_COLUMN_MASK 0xff
212 #define HD_DELIM_MASK 0xff00
213 #define HD_OMIT_COUNT (1 << 16)
214 #define HD_OMIT_HEX (1 << 17)
215 #define HD_OMIT_CHARS (1 << 18)
216 int ksscanf (const char *, char const *, ...) __scanflike(2, 3);
217 int kvsscanf (const char *, char const *, __va_list) __scanflike(2, 0);
218 void kvasfree(char **);
220 long strtol (const char *, char **, int);
221 u_long strtoul (const char *, char **, int);
222 quad_t strtoq (const char *, char **, int);
223 u_quad_t strtouq (const char *, char **, int);
226 * note: some functions commonly used by device drivers may be passed
227 * pointers to volatile storage, volatile set to avoid warnings.
229 * NOTE: bcopyb() - is a dumb byte-granular bcopy. This routine is
230 * explicitly not meant to be sophisticated.
231 * NOTE: bcopyi() - is a dumb int-granular bcopy (len is still in bytes).
232 * This routine is explicitly not meant to be sophisticated.
234 void bcopyb (const void *from, void *to, size_t len);
235 void bcopyi (const void *from, void *to, size_t len);
236 void bcopy (volatile const void *from, volatile void *to, size_t len);
237 void ovbcopy (const void *from, void *to, size_t len);
238 void bzero (volatile void *buf, size_t len);
239 void bzeront (volatile void *buf, size_t len);
240 void *memcpy (void *to, const void *from, size_t len);
242 int copystr (const void *kfaddr, void *kdaddr, size_t len,
244 int copyinstr (const void *udaddr, void *kaddr, size_t len,
246 int copyin (const void *udaddr, void *kaddr, size_t len);
247 int copyin_nofault (const void *udaddr, void *kaddr, size_t len);
248 int copyout (const void *kaddr, void *udaddr, size_t len);
249 int copyout_nofault (const void *kaddr, void *udaddr, size_t len);
251 int fubyte (const void *base);
252 int subyte (void *base, int byte);
253 long fuword (const void *base);
254 int suword (void *base, long word);
255 int suword32 (void *base, int word);
256 int fusword (void *base);
257 int susword (void *base, int word);
258 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
260 void realitexpire (void *);
261 void DELAY(int usec);
262 void DRIVERSLEEP(int usec);
264 void startprofclock (struct proc *);
265 void stopprofclock (struct proc *);
266 void setstatclockrate (int hzrate);
269 * Kernel environment support functions and sundry.
271 char *kgetenv (const char *name);
272 int ksetenv(const char *name, const char *value);
273 int kunsetenv(const char *name);
274 void kfreeenv(char *env);
275 int ktestenv(const char *name);
276 int kgetenv_int (const char *name, int *data);
277 int kgetenv_string (const char *name, char *data, int size);
278 int kgetenv_ulong(const char *name, unsigned long *data);
279 int kgetenv_quad (const char *name, quad_t *data);
280 int kgetenv_long(const char *name, long *data);
281 extern char *kern_envp;
283 #ifdef APM_FIXUP_CALLTODO
284 void adjust_timeout_calltodo (struct timeval *time_change);
285 #endif /* APM_FIXUP_CALLTODO */
287 #include <sys/libkern.h>
289 /* Initialize the world */
290 void mi_startup (void);
293 /* Finalize the world. */
294 void shutdown_nice (int);
297 * Kernel to clock driver interface.
299 void inittodr (time_t base);
300 void resettodr (void);
301 void startrtclock (void);
304 typedef void timeout_t (void *); /* timeout function type */
306 /* Interrupt management */
309 * For the alpha arch, some of these functions are static __inline, and
310 * the others should be.
312 #if defined(__i386__) || defined(__x86_64__)
313 void setdelayed (void);
314 void setsoftcambio (void);
315 void setsoftcamnet (void);
316 void setsoftunused02 (void);
317 void setsoftcrypto (void);
318 void setsoftunused01 (void);
319 void setsofttty (void);
320 void setsoftvm (void);
321 void setsofttq (void);
322 void schedsofttty (void);
324 void splz_check (void);
325 void cpu_mmw_pause_int(int*, int, int);
326 void cpu_mmw_pause_long(long*, long, int);
327 #endif /* __i386__ */
330 * Various callout lists.
333 /* Exit callout list declarations. */
334 typedef void (*exitlist_fn) (struct thread *td);
336 int at_exit (exitlist_fn function);
337 int rm_at_exit (exitlist_fn function);
339 /* Fork callout list declarations. */
340 typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
343 int at_fork (forklist_fn function);
344 int rm_at_fork (forklist_fn function);
346 extern struct globaldata *panic_cpu_gd;
349 * Common `proc' functions are declared here so that proc.h can be included
352 int tsleep (const volatile void *, int, const char *, int);
353 int ssleep (const volatile void *, struct spinlock *, int, const char *, int);
354 int lksleep (const volatile void *, struct lock *, int, const char *, int);
355 int mtxsleep (const volatile void *, struct mtx *, int, const char *, int);
356 int zsleep(const volatile void *, struct lwkt_serialize *, int, const char *, int);
357 void tsleep_interlock (const volatile void *, int);
358 void tsleep_remove (struct thread *);
359 int lwkt_sleep (const char *, int);
361 void wakeup (const volatile void *chan);
362 void wakeup_one (const volatile void *chan);
363 void wakeup_mycpu (const volatile void *chan);
364 void wakeup_mycpu_one (const volatile void *chan);
365 void wakeup_oncpu (struct globaldata *gd, const volatile void *chan);
366 void wakeup_oncpu_one (struct globaldata *gd, const volatile void *chan);
367 void wakeup_domain (const volatile void *chan, int domain);
368 void wakeup_domain_one (const volatile void *chan, int domain);
369 void wakeup_start_delayed(void);
370 void wakeup_end_delayed(void);
373 * Common `cdev_t' stuff are declared here to avoid #include poisoning
378 udev_t dev2udev(cdev_t x);
379 cdev_t udev2dev(udev_t x, int b);
380 int uminor(udev_t dev);
381 int umajor(udev_t dev);
382 udev_t makeudev(int x, int y);
385 * Unit number allocation API. (kern/subr_unit.c)
388 struct unrhdr *new_unrhdr(int low, int high, struct lock *lock);
389 void delete_unrhdr(struct unrhdr *uh);
390 int alloc_unr(struct unrhdr *uh);
391 int alloc_unrl(struct unrhdr *uh);
392 void free_unr(struct unrhdr *uh, u_int item);
395 * Population count algorithm using SWAR approach
396 * - "SIMD Within A Register".
399 static __inline uint16_t
400 bitcount16(uint32_t x)
403 x = (x & 0x5555) + ((x & 0xaaaa) >> 1);
404 x = (x & 0x3333) + ((x & 0xcccc) >> 2);
405 x = (x + (x >> 4)) & 0x0f0f;
406 x = (x + (x >> 8)) & 0x00ff;
410 static __inline uint32_t
411 bitcount32(uint32_t x)
414 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
415 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
416 x = (x + (x >> 4)) & 0x0f0f0f0f;
418 x = (x + (x >> 16)) & 0x000000ff;
423 #endif /* !_SYS_SYSTM_H_ */