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 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)systm.h 8.7 (Berkeley) 3/29/95
41 #include <machine/atomic.h>
42 #include <machine/cpufunc.h>
43 #include <sys/callout.h>
44 #include <sys/cdefs.h>
45 #include <sys/queue.h>
46 #include <sys/stdint.h> /* for people using printf mainly */
48 extern int cold; /* nonzero if we are doing a cold boot */
49 extern int rebooting; /* kern_reboot() has been called. */
50 extern const char *panicstr; /* panic message */
51 extern char version[]; /* system version */
52 extern char copyright[]; /* system copyright */
53 extern int kstack_pages; /* number of kernel stack pages */
55 extern u_long pagesizes[]; /* supported page sizes */
56 extern long physmem; /* physical memory */
57 extern long realmem; /* 'real' memory */
59 extern char *rootdevnames[2]; /* names of possible root devices */
61 extern int boothowto; /* reboot flags, from console subsystem */
62 extern int bootverbose; /* nonzero to print verbose messages */
64 extern int maxusers; /* system tune hint */
65 extern int ngroups_max; /* max # of supplemental groups */
66 extern int vm_guest; /* Running as virtual machine guest? */
69 * Detected virtual machine guest types. The intention is to expand
70 * and/or add to the VM_GUEST_VM type if specific VM functionality is
71 * ever implemented (e.g. vendor-specific paravirtualization features).
73 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN };
75 #ifdef INVARIANTS /* The option is always available */
76 #define KASSERT(exp,msg) do { \
77 if (__predict_false(!(exp))) \
80 #define VNASSERT(exp, vp, msg) do { \
81 if (__predict_false(!(exp))) { \
82 vn_printf(vp, "VNASSERT failed\n"); \
87 #define KASSERT(exp,msg) do { \
90 #define VNASSERT(exp, vp, msg) do { \
94 #ifndef CTASSERT /* Allow lint to override */
95 #define CTASSERT(x) _CTASSERT(x, __LINE__)
96 #define _CTASSERT(x, y) __CTASSERT(x, y)
97 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
101 * Assert that a pointer can be loaded from memory atomically.
103 * This assertion enforces stronger alignment than necessary. For example,
104 * on some architectures, atomicity for unaligned loads will depend on
105 * whether or not the load spans multiple cache lines.
107 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \
108 KASSERT(sizeof(var) == sizeof(void *) && \
109 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
112 * XXX the hints declarations are even more misplaced than most declarations
113 * in this file, since they are needed in one file (per arch) and only used
115 * XXX most of these variables should be const.
117 extern int osreldate;
119 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
120 extern int dynamic_kenv;
121 extern struct mtx kenv_lock;
122 extern char *kern_envp;
123 extern char static_env[];
124 extern char static_hints[]; /* by config for now */
129 * General function declarations.
145 int setjmp(struct _jmp_buf *);
146 void longjmp(struct _jmp_buf *, int) __dead2;
147 int dumpstatus(vm_offset_t addr, off_t count);
149 int eopnotsupp(void);
150 int ureadc(int, struct uio *);
151 void hashdestroy(void *, struct malloc_type *, u_long);
152 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
153 void *hashinit_flags(int count, struct malloc_type *type,
154 u_long *hashmask, int flags);
155 #define HASH_NOWAIT 0x00000001
156 #define HASH_WAITOK 0x00000002
158 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
159 void g_waitidle(void);
161 #ifdef RESTARTABLE_PANICS
162 void panic(const char *, ...) __printflike(1, 2);
164 void panic(const char *, ...) __dead2 __printflike(1, 2);
168 void cpu_flush_dcache(void *, size_t);
169 void cpu_rootconf(void);
170 void critical_enter(void);
171 void critical_exit(void);
172 void init_param1(void);
173 void init_param2(long physpages);
174 void init_static_kenv(char *, size_t);
175 void tablefull(const char *);
176 int kvprintf(char const *, void (*)(int, void*), void *, int,
177 __va_list) __printflike(1, 0);
178 void log(int, const char *, ...) __printflike(2, 3);
179 void log_console(struct uio *);
180 int printf(const char *, ...) __printflike(1, 2);
181 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
182 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
183 int uprintf(const char *, ...) __printflike(1, 2);
184 int vprintf(const char *, __va_list) __printflike(1, 0);
185 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
186 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
187 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
188 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
189 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
190 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
191 long strtol(const char *, char **, int) __nonnull(1);
192 u_long strtoul(const char *, char **, int) __nonnull(1);
193 quad_t strtoq(const char *, char **, int) __nonnull(1);
194 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
195 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
196 void hexdump(const void *ptr, int length, const char *hdr, int flags);
197 #define HD_COLUMN_MASK 0xff
198 #define HD_DELIM_MASK 0xff00
199 #define HD_OMIT_COUNT (1 << 16)
200 #define HD_OMIT_HEX (1 << 17)
201 #define HD_OMIT_CHARS (1 << 18)
203 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
204 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
205 void bzero(void *buf, size_t len) __nonnull(1);
207 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
208 void *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
210 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
211 size_t len, size_t * __restrict lencopied)
212 __nonnull(1) __nonnull(2);
213 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
214 size_t len, size_t * __restrict lencopied)
215 __nonnull(1) __nonnull(2);
216 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
217 size_t len) __nonnull(1) __nonnull(2);
218 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
219 size_t len) __nonnull(1) __nonnull(2);
221 int fubyte(const void *base);
222 long fuword(const void *base);
223 int fuword16(void *base);
224 int32_t fuword32(const void *base);
225 int64_t fuword64(const void *base);
226 int subyte(void *base, int byte);
227 int suword(void *base, long word);
228 int suword16(void *base, int word);
229 int suword32(void *base, int32_t word);
230 int suword64(void *base, int64_t word);
231 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
232 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
234 void realitexpire(void *);
236 int sysbeep(int hertz, int period);
238 void hardclock(int usermode, uintfptr_t pc);
239 void hardclock_anycpu(int cnt, int usermode);
240 void hardclock_cpu(int usermode);
241 void hardclock_sync(int cpu);
242 void softclock(void *);
243 void statclock(int usermode);
244 void profclock(int usermode, uintfptr_t pc);
246 int hardclockintr(void);
248 void startprofclock(struct proc *);
249 void stopprofclock(struct proc *);
250 void cpu_startprofclock(void);
251 void cpu_stopprofclock(void);
252 void cpu_idleclock(void);
253 void cpu_activeclock(void);
254 extern int cpu_disable_deep_sleep;
256 int cr_cansee(struct ucred *u1, struct ucred *u2);
257 int cr_canseesocket(struct ucred *cred, struct socket *so);
258 int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
260 char *getenv(const char *name);
261 void freeenv(char *env);
262 int getenv_int(const char *name, int *data);
263 int getenv_uint(const char *name, unsigned int *data);
264 int getenv_long(const char *name, long *data);
265 int getenv_ulong(const char *name, unsigned long *data);
266 int getenv_string(const char *name, char *data, int size);
267 int getenv_quad(const char *name, quad_t *data);
268 int setenv(const char *name, const char *value);
269 int unsetenv(const char *name);
270 int testenv(const char *name);
272 typedef uint64_t (cpu_tick_f)(void);
273 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
274 extern cpu_tick_f *cpu_ticks;
275 uint64_t cpu_tickrate(void);
276 uint64_t cputick2usec(uint64_t tick);
278 #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 */
287 void cpu_initclocks(void);
288 void cpu_initclocks_bsp(void);
289 void cpu_initclocks_ap(void);
290 void usrinfoinit(void);
292 /* Finalize the world */
293 void kern_reboot(int) __dead2;
294 void shutdown_nice(int);
297 typedef void timeout_t(void *); /* timeout function type */
298 #define CALLOUT_HANDLE_INITIALIZER(handle) \
301 void callout_handle_init(struct callout_handle *);
302 struct callout_handle timeout(timeout_t *, void *, int);
303 void untimeout(timeout_t *, void *, struct callout_handle);
304 caddr_t kern_timeout_callwheel_alloc(caddr_t v);
305 void kern_timeout_callwheel_init(void);
307 /* Stubs for obsolete functions that used to be for interrupt management */
308 static __inline void spl0(void) { return; }
309 static __inline intrmask_t splbio(void) { return 0; }
310 static __inline intrmask_t splcam(void) { return 0; }
311 static __inline intrmask_t splclock(void) { return 0; }
312 static __inline intrmask_t splhigh(void) { return 0; }
313 static __inline intrmask_t splimp(void) { return 0; }
314 static __inline intrmask_t splnet(void) { return 0; }
315 static __inline intrmask_t splsoftcam(void) { return 0; }
316 static __inline intrmask_t splsoftclock(void) { return 0; }
317 static __inline intrmask_t splsofttty(void) { return 0; }
318 static __inline intrmask_t splsoftvm(void) { return 0; }
319 static __inline intrmask_t splsofttq(void) { return 0; }
320 static __inline intrmask_t splstatclock(void) { return 0; }
321 static __inline intrmask_t spltty(void) { return 0; }
322 static __inline intrmask_t splvm(void) { return 0; }
323 static __inline void splx(intrmask_t ipl __unused) { return; }
326 * Common `proc' functions are declared here so that proc.h can be included
329 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
330 int timo) __nonnull(1);
331 #define msleep(chan, mtx, pri, wmesg, timo) \
332 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (timo))
333 int msleep_spin(void *chan, struct mtx *mtx, const char *wmesg, int timo)
335 int pause(const char *wmesg, int timo);
336 #define tsleep(chan, pri, wmesg, timo) \
337 _sleep((chan), NULL, (pri), (wmesg), (timo))
338 void wakeup(void *chan) __nonnull(1);
339 void wakeup_one(void *chan) __nonnull(1);
342 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
346 dev_t dev2udev(struct cdev *x);
347 const char *devtoname(struct cdev *cdev);
349 int poll_no_poll(int events);
351 /* XXX: Should be void nanodelay(u_int nsec); */
352 void DELAY(int usec);
354 /* Root mount holdback API */
355 struct root_hold_token;
357 struct root_hold_token *root_mount_hold(const char *identifier);
358 void root_mount_rel(struct root_hold_token *h);
359 void root_mount_wait(void);
360 int root_mounted(void);
364 * Unit number allocation API. (kern/subr_unit.c)
367 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
368 void delete_unrhdr(struct unrhdr *uh);
369 void clean_unrhdr(struct unrhdr *uh);
370 void clean_unrhdrl(struct unrhdr *uh);
371 int alloc_unr(struct unrhdr *uh);
372 int alloc_unr_specific(struct unrhdr *uh, u_int item);
373 int alloc_unrl(struct unrhdr *uh);
374 void free_unr(struct unrhdr *uh, u_int item);
377 * Population count algorithm using SWAR approach
378 * - "SIMD Within A Register".
380 static __inline uint32_t
381 bitcount32(uint32_t x)
384 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
385 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
386 x = (x + (x >> 4)) & 0x0f0f0f0f;
388 x = (x + (x >> 16)) & 0x000000ff;
392 #endif /* !_SYS_SYSTM_H_ */