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 */
74 extern long physmem; /* physical memory */
76 extern cdev_t dumpdev; /* dump device */
77 extern u_int64_t dumplo64; /* block number into dumpdev, start of dump */
79 extern cdev_t rootdev; /* root device */
80 extern cdev_t rootdevs[2]; /* possible root devices */
81 extern char *rootdevnames[2]; /* names of possible root devices */
82 extern char *ZeroPage;
84 extern int boothowto; /* reboot flags, from console subsystem */
85 extern int bootverbose; /* nonzero to print verbose messages */
87 extern int maxusers; /* system tune hint */
89 extern int ncpus; /* total number of cpus (real, hyper, virtual)*/
90 extern int ncpus2; /* ncpus rounded down to power of 2 */
91 extern int ncpus2_shift; /* log base 2 of ncpus2 */
92 extern int ncpus2_mask; /* ncpus2 - 1 */
93 extern int ncpus_fit; /* round up to a power of 2 */
94 extern int ncpus_fit_mask; /* ncpus_fit - 1 */
95 extern int clocks_running; /* timing/timeout subsystem is operational */
97 /* XXX TGEN these don't belong here, they're MD on i386/x86_64 */
98 extern u_int cpu_feature; /* CPUID_* features */
99 extern u_int cpu_feature2; /* CPUID2_* features */
100 extern u_int cpu_mi_feature; /* CPU_MI_XXX machine-nonspecific features */
101 extern cpumask_t usched_global_cpumask;
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\" failed " \
111 "in %s at %s:%u", #exp, __func__, \
112 __FILE__, __LINE__); } while (0)
115 #define KASSERT(exp,msg)
116 #define KKASSERT(exp)
117 #define __debugvar __attribute__((__unused__))
121 * General function declarations.
128 struct lwkt_serialize;
142 void Debugger (const char *msg);
143 void print_backtrace(int count);
144 void mi_gdinit (struct globaldata *gd, int cpu);
145 void mi_proc0init(struct globaldata *gd, struct user *proc0paddr);
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 hashdestroy(void *vhashtbl, struct malloc_type *type, u_long hashmask);
151 void *phashinit (int count, struct malloc_type *type, u_long *nentries);
152 void *hashinit_ext (int count, size_t size,
153 struct malloc_type *type, u_long *hashmask);
154 void *phashinit_ext (int count, size_t size,
155 struct malloc_type *type, u_long *nentries);
157 int cpu_sanitize_frame (struct trapframe *);
158 int cpu_sanitize_tls (struct savetls *);
159 void cpu_spinlock_contested(void);
160 void cpu_halt (void) __dead2;
161 void cpu_reset (void);
163 void cpu_rootconf (void);
164 void cpu_vmspace_alloc(struct vmspace *);
165 void cpu_vmspace_free(struct vmspace *);
166 void cpu_vkernel_trap(struct trapframe *, int);
167 enum vmm_guest_type detect_virtual(void);
168 void set_user_TLS(void);
169 void set_vkernel_fp(struct trapframe *);
170 int kvm_access_check(vm_offset_t, vm_offset_t, int);
172 vm_paddr_t kvtop(void *addr);
174 extern uint32_t crc32_tab[];
175 uint32_t crc32(const void *buf, size_t size);
176 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc);
177 uint32_t iscsi_crc32(const void *buf, size_t size);
178 uint32_t iscsi_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 void kvcreinitspin(void);
185 int log (int, const char *, ...) __printflike(2, 3);
186 void logwakeup (void);
187 void log_console (struct uio *);
188 int kprintf (const char *, ...) __printflike(1, 2);
189 void kprintf0 (const char *, ...) __printflike(1, 2);
190 void krateprintf (struct krate *, const char *, ...) __printflike(2, 3);
191 int ksnprintf (char *, size_t, const char *, ...) __printflike(3, 4);
192 int ksnrprintf (char *, size_t, int, const char *, ...) __printflike(4, 5);
193 int ksprintf (char *buf, const char *, ...) __printflike(2, 3);
194 int uprintf (const char *, ...) __printflike(1, 2);
195 int kvprintf (const char *, __va_list) __printflike(1, 0);
196 int kvsnprintf (char *, size_t, const char *,
197 __va_list) __printflike(3, 0);
198 int kvsnrprintf (char *, size_t, int, const char *,
199 __va_list) __printflike(4, 0);
200 int kvasnrprintf (char **, size_t, int, const char *,
201 __va_list) __printflike(4, 0);
202 int kvsprintf (char *buf, const char *,
203 __va_list) __printflike(2, 0);
204 int ttyprintf (struct tty *, const char *, ...) __printflike(2, 3);
205 void hexdump (const void *ptr, int length, const char *hdr, int flags);
206 void kprint_cpuset(cpumask_t *mask);
207 #define HD_COLUMN_MASK 0xff
208 #define HD_DELIM_MASK 0xff00
209 #define HD_OMIT_COUNT (1 << 16)
210 #define HD_OMIT_HEX (1 << 17)
211 #define HD_OMIT_CHARS (1 << 18)
212 int ksscanf(const char *, char const *, ...)
213 __nonnull(1) __nonnull(2) __scanflike(2, 3);
214 int kvsscanf(const char *, char const *, __va_list)
215 __nonnull(1) __nonnull(2) __scanflike(2, 0);
216 void kvasfree(char **);
218 long strtol(const char *, char **, int) __nonnull(1);
219 u_long strtoul(const char *, char **, int) __nonnull(1);
220 quad_t strtoq(const char *, char **, int) __nonnull(1);
221 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
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 __nonnull(1) __nonnull(2);
234 void bcopyi(const void *from, void *to, size_t len)
235 __nonnull(1) __nonnull(2);
236 void bcopy(volatile const void *from, volatile void *to, size_t len)
237 __nonnull(1) __nonnull(2);
238 void ovbcopy(const void *from, void *to, size_t len)
239 __nonnull(1) __nonnull(2);
240 void bzero(volatile void *buf, size_t len) __nonnull(1);
241 void bzeront(volatile void *buf, size_t len) __nonnull(1);
242 void *memcpy(void *to, const void *from, size_t len)
243 __nonnull(1) __nonnull(2);
245 int copystr (const void *kfaddr, void *kdaddr, size_t len,
246 size_t *lencopied) __nonnull(1) __nonnull(2);
247 int copyinstr (const void *udaddr, void *kaddr, size_t len,
248 size_t *lencopied) __nonnull(1) __nonnull(2);
249 int copyin(const void *udaddr, void *kaddr, size_t len)
250 __nonnull(1) __nonnull(2);
251 int copyin_nofault(const void *udaddr, void *kaddr, size_t len)
252 __nonnull(1) __nonnull(2);
253 int copyout(const void *kaddr, void *udaddr, size_t len)
254 __nonnull(1) __nonnull(2);
255 int copyout_nofault(const void *kaddr, void *udaddr, size_t len)
256 __nonnull(1) __nonnull(2);
258 int fubyte (const void *base);
259 int subyte (void *base, int byte);
260 long fuword (const void *base);
261 int suword (void *base, long word);
262 int suword32 (void *base, int word);
263 int fusword (void *base);
264 int susword (void *base, int word);
265 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
267 void realitexpire (void *);
268 void DELAY(int usec);
269 void DRIVERSLEEP(int usec);
271 void startprofclock (struct proc *);
272 void stopprofclock (struct proc *);
273 void setstatclockrate (int hzrate);
276 * Kernel environment support functions and sundry.
278 char *kgetenv (const char *name);
279 int ksetenv(const char *name, const char *value);
280 int kunsetenv(const char *name);
281 void kfreeenv(char *env);
282 int ktestenv(const char *name);
283 int kgetenv_int (const char *name, int *data);
284 int kgetenv_string (const char *name, char *data, int size);
285 int kgetenv_ulong(const char *name, unsigned long *data);
286 int kgetenv_quad (const char *name, quad_t *data);
287 int kgetenv_long(const char *name, long *data);
288 extern char *kern_envp;
290 #ifdef APM_FIXUP_CALLTODO
291 void adjust_timeout_calltodo (struct timeval *time_change);
292 #endif /* APM_FIXUP_CALLTODO */
294 #include <sys/libkern.h>
296 /* Initialize the world */
297 void mi_startup (void);
300 /* Finalize the world. */
301 void shutdown_nice (int);
304 * Kernel to clock driver interface.
306 void inittodr (time_t base);
307 void resettodr (void);
308 void startrtclock (void);
311 typedef void timeout_t (void *); /* timeout function type */
313 /* Interrupt management */
316 * For the alpha arch, some of these functions are static __inline, and
317 * the others should be.
319 #if defined(__i386__) || defined(__x86_64__)
320 void setdelayed (void);
321 void setsoftcambio (void);
322 void setsoftcamnet (void);
323 void setsoftunused02 (void);
324 void setsoftcrypto (void);
325 void setsoftunused01 (void);
326 void setsofttty (void);
327 void setsoftvm (void);
328 void setsofttq (void);
329 void schedsofttty (void);
331 void splz_check (void);
332 void cpu_mmw_pause_int(int*, int, int, int);
333 void cpu_mmw_pause_long(long*, long, int, int);
334 #endif /* __i386__ || __x86_64__ */
337 * Various callout lists.
340 /* Exit callout list declarations. */
341 typedef void (*exitlist_fn) (struct thread *td);
343 int at_exit (exitlist_fn function);
344 int rm_at_exit (exitlist_fn function);
346 /* Fork callout list declarations. */
347 typedef void (*forklist_fn) (struct proc *parent, struct proc *child,
350 int at_fork (forklist_fn function);
351 int rm_at_fork (forklist_fn function);
353 extern struct globaldata *panic_cpu_gd;
356 * Common `proc' functions are declared here so that proc.h can be included
359 int tsleep(const volatile void *, int, const char *, int) __nonnull(1);
360 int ssleep(const volatile void *, struct spinlock *, int, const char *, int)
362 int lksleep(const volatile void *, struct lock *, int, const char *, int)
364 int mtxsleep(const volatile void *, struct mtx *, int, const char *, int)
366 int zsleep(const volatile void *, struct lwkt_serialize *, int, const char *, int)
368 void tsleep_interlock(const volatile void *, int) __nonnull(1);
369 void tsleep_remove (struct thread *);
370 int lwkt_sleep (const char *, int);
372 void wakeup(const volatile void *chan) __nonnull(1);
373 void wakeup_one(const volatile void *chan) __nonnull(1);
374 void wakeup_mycpu(const volatile void *chan) __nonnull(1);
375 void wakeup_mycpu_one(const volatile void *chan) __nonnull(1);
376 void wakeup_oncpu(struct globaldata *gd, const volatile void *chan)
378 void wakeup_oncpu_one(struct globaldata *gd, const volatile void *chan)
380 void wakeup_domain(const volatile void *chan, int domain) __nonnull(1);
381 void wakeup_domain_one(const volatile void *chan, int domain) __nonnull(1);
382 void wakeup_start_delayed(void);
383 void wakeup_end_delayed(void);
386 * Common `cdev_t' stuff are declared here to avoid #include poisoning
391 udev_t dev2udev(cdev_t x);
392 cdev_t udev2dev(udev_t x, int b);
393 int uminor(udev_t dev);
394 int umajor(udev_t dev);
395 udev_t makeudev(int x, int y);
398 * Unit number allocation API. (kern/subr_unit.c)
401 struct unrhdr *new_unrhdr(int low, int high, struct lock *lock);
402 void delete_unrhdr(struct unrhdr *uh);
403 int alloc_unr(struct unrhdr *uh);
404 int alloc_unrl(struct unrhdr *uh);
405 void free_unr(struct unrhdr *uh, u_int item);
408 * Population count algorithm using SWAR approach
409 * - "SIMD Within A Register".
412 static __inline uint16_t
413 bitcount16(uint32_t x)
416 x = (x & 0x5555) + ((x & 0xaaaa) >> 1);
417 x = (x & 0x3333) + ((x & 0xcccc) >> 2);
418 x = (x + (x >> 4)) & 0x0f0f;
419 x = (x + (x >> 8)) & 0x00ff;
423 static __inline uint32_t
424 bitcount32(uint32_t x)
427 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
428 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
429 x = (x + (x >> 4)) & 0x0f0f0f0f;
431 x = (x + (x >> 16)) & 0x000000ff;
436 #endif /* !_SYS_SYSTM_H_ */