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) _Static_assert(x, "compile-time assertion failed")
99 * Assert that a pointer can be loaded from memory atomically.
101 * This assertion enforces stronger alignment than necessary. For example,
102 * on some architectures, atomicity for unaligned loads will depend on
103 * whether or not the load spans multiple cache lines.
105 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \
106 KASSERT(sizeof(var) == sizeof(void *) && \
107 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
110 * If we have already panic'd and this is the thread that called
111 * panic(), then don't block on any mutexes but silently succeed.
112 * Otherwise, the kernel will deadlock since the scheduler isn't
113 * going to run the thread that holds any lock we need.
115 #define SCHEDULER_STOPPED() __predict_false(curthread->td_stopsched)
118 * XXX the hints declarations are even more misplaced than most declarations
119 * in this file, since they are needed in one file (per arch) and only used
121 * XXX most of these variables should be const.
123 extern int osreldate;
125 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
126 extern int dynamic_kenv;
127 extern struct mtx kenv_lock;
128 extern char *kern_envp;
129 extern char static_env[];
130 extern char static_hints[]; /* by config for now */
134 extern const void *zero_region; /* address space maps to a zeroed page */
136 extern int iosize_max_clamp;
137 #define IOSIZE_MAX (iosize_max_clamp ? INT_MAX : SSIZE_MAX)
140 * General function declarations.
156 int setjmp(struct _jmp_buf *);
157 void longjmp(struct _jmp_buf *, int) __dead2;
158 int dumpstatus(vm_offset_t addr, off_t count);
160 int eopnotsupp(void);
161 int ureadc(int, struct uio *);
162 void hashdestroy(void *, struct malloc_type *, u_long);
163 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
164 void *hashinit_flags(int count, struct malloc_type *type,
165 u_long *hashmask, int flags);
166 #define HASH_NOWAIT 0x00000001
167 #define HASH_WAITOK 0x00000002
169 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
170 void g_waitidle(void);
172 void panic(const char *, ...) __dead2 __printflike(1, 2);
175 void cpu_flush_dcache(void *, size_t);
176 void cpu_rootconf(void);
177 void critical_enter(void);
178 void critical_exit(void);
179 void init_param1(void);
180 void init_param2(long physpages);
181 void init_static_kenv(char *, size_t);
182 void tablefull(const char *);
183 int kvprintf(char const *, void (*)(int, void*), void *, int,
184 __va_list) __printflike(1, 0);
185 void log(int, const char *, ...) __printflike(2, 3);
186 void log_console(struct uio *);
187 int printf(const char *, ...) __printflike(1, 2);
188 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
189 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
190 int uprintf(const char *, ...) __printflike(1, 2);
191 int vprintf(const char *, __va_list) __printflike(1, 0);
192 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
193 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
194 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
195 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
196 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
197 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
198 long strtol(const char *, char **, int) __nonnull(1);
199 u_long strtoul(const char *, char **, int) __nonnull(1);
200 quad_t strtoq(const char *, char **, int) __nonnull(1);
201 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
202 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
203 void hexdump(const void *ptr, int length, const char *hdr, int flags);
204 #define HD_COLUMN_MASK 0xff
205 #define HD_DELIM_MASK 0xff00
206 #define HD_OMIT_COUNT (1 << 16)
207 #define HD_OMIT_HEX (1 << 17)
208 #define HD_OMIT_CHARS (1 << 18)
210 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
211 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
212 void bzero(void *buf, size_t len) __nonnull(1);
214 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
215 void *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
217 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
218 size_t len, size_t * __restrict lencopied)
219 __nonnull(1) __nonnull(2);
220 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
221 size_t len, size_t * __restrict lencopied)
222 __nonnull(1) __nonnull(2);
223 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
224 size_t len) __nonnull(1) __nonnull(2);
225 int copyin_nofault(const void * __restrict udaddr, void * __restrict kaddr,
226 size_t len) __nonnull(1) __nonnull(2);
227 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
228 size_t len) __nonnull(1) __nonnull(2);
229 int copyout_nofault(const void * __restrict kaddr, void * __restrict udaddr,
230 size_t len) __nonnull(1) __nonnull(2);
232 int fubyte(const void *base);
233 long fuword(const void *base);
234 int fuword16(void *base);
235 int32_t fuword32(const void *base);
236 int64_t fuword64(const void *base);
237 int subyte(void *base, int byte);
238 int suword(void *base, long word);
239 int suword16(void *base, int word);
240 int suword32(void *base, int32_t word);
241 int suword64(void *base, int64_t word);
242 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
243 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
245 void realitexpire(void *);
247 int sysbeep(int hertz, int period);
249 void hardclock(int usermode, uintfptr_t pc);
250 void hardclock_cnt(int cnt, int usermode);
251 void hardclock_cpu(int usermode);
252 void hardclock_sync(int cpu);
253 void softclock(void *);
254 void statclock(int usermode);
255 void statclock_cnt(int cnt, int usermode);
256 void profclock(int usermode, uintfptr_t pc);
257 void profclock_cnt(int cnt, int usermode, uintfptr_t pc);
259 int hardclockintr(void);
261 void startprofclock(struct proc *);
262 void stopprofclock(struct proc *);
263 void cpu_startprofclock(void);
264 void cpu_stopprofclock(void);
265 void cpu_idleclock(void);
266 void cpu_activeclock(void);
267 extern int cpu_can_deep_sleep;
268 extern int cpu_disable_deep_sleep;
270 int cr_cansee(struct ucred *u1, struct ucred *u2);
271 int cr_canseesocket(struct ucred *cred, struct socket *so);
272 int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
274 char *getenv(const char *name);
275 void freeenv(char *env);
276 int getenv_int(const char *name, int *data);
277 int getenv_uint(const char *name, unsigned int *data);
278 int getenv_long(const char *name, long *data);
279 int getenv_ulong(const char *name, unsigned long *data);
280 int getenv_string(const char *name, char *data, int size);
281 int getenv_quad(const char *name, quad_t *data);
282 int setenv(const char *name, const char *value);
283 int unsetenv(const char *name);
284 int testenv(const char *name);
286 typedef uint64_t (cpu_tick_f)(void);
287 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
288 extern cpu_tick_f *cpu_ticks;
289 uint64_t cpu_tickrate(void);
290 uint64_t cputick2usec(uint64_t tick);
292 #ifdef APM_FIXUP_CALLTODO
294 void adjust_timeout_calltodo(struct timeval *time_change);
295 #endif /* APM_FIXUP_CALLTODO */
297 #include <sys/libkern.h>
299 /* Initialize the world */
301 void cpu_initclocks(void);
302 void cpu_initclocks_bsp(void);
303 void cpu_initclocks_ap(void);
304 void usrinfoinit(void);
306 /* Finalize the world */
307 void kern_reboot(int) __dead2;
308 void shutdown_nice(int);
311 typedef void timeout_t(void *); /* timeout function type */
312 #define CALLOUT_HANDLE_INITIALIZER(handle) \
315 void callout_handle_init(struct callout_handle *);
316 struct callout_handle timeout(timeout_t *, void *, int);
317 void untimeout(timeout_t *, void *, struct callout_handle);
318 caddr_t kern_timeout_callwheel_alloc(caddr_t v);
319 void kern_timeout_callwheel_init(void);
321 /* Stubs for obsolete functions that used to be for interrupt management */
322 static __inline void spl0(void) { return; }
323 static __inline intrmask_t splbio(void) { return 0; }
324 static __inline intrmask_t splcam(void) { return 0; }
325 static __inline intrmask_t splclock(void) { return 0; }
326 static __inline intrmask_t splhigh(void) { return 0; }
327 static __inline intrmask_t splimp(void) { return 0; }
328 static __inline intrmask_t splnet(void) { return 0; }
329 static __inline intrmask_t splsoftcam(void) { return 0; }
330 static __inline intrmask_t splsoftclock(void) { return 0; }
331 static __inline intrmask_t splsofttty(void) { return 0; }
332 static __inline intrmask_t splsoftvm(void) { return 0; }
333 static __inline intrmask_t splsofttq(void) { return 0; }
334 static __inline intrmask_t splstatclock(void) { return 0; }
335 static __inline intrmask_t spltty(void) { return 0; }
336 static __inline intrmask_t splvm(void) { return 0; }
337 static __inline void splx(intrmask_t ipl __unused) { return; }
340 * Common `proc' functions are declared here so that proc.h can be included
343 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
344 int timo) __nonnull(1);
345 #define msleep(chan, mtx, pri, wmesg, timo) \
346 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (timo))
347 int msleep_spin(void *chan, struct mtx *mtx, const char *wmesg, int timo)
349 int pause(const char *wmesg, int timo);
350 #define tsleep(chan, pri, wmesg, timo) \
351 _sleep((chan), NULL, (pri), (wmesg), (timo))
352 void wakeup(void *chan) __nonnull(1);
353 void wakeup_one(void *chan) __nonnull(1);
356 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
360 dev_t dev2udev(struct cdev *x);
361 const char *devtoname(struct cdev *cdev);
363 int poll_no_poll(int events);
365 /* XXX: Should be void nanodelay(u_int nsec); */
366 void DELAY(int usec);
368 /* Root mount holdback API */
369 struct root_hold_token;
371 struct root_hold_token *root_mount_hold(const char *identifier);
372 void root_mount_rel(struct root_hold_token *h);
373 void root_mount_wait(void);
374 int root_mounted(void);
378 * Unit number allocation API. (kern/subr_unit.c)
381 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
382 void delete_unrhdr(struct unrhdr *uh);
383 void clean_unrhdr(struct unrhdr *uh);
384 void clean_unrhdrl(struct unrhdr *uh);
385 int alloc_unr(struct unrhdr *uh);
386 int alloc_unr_specific(struct unrhdr *uh, u_int item);
387 int alloc_unrl(struct unrhdr *uh);
388 void free_unr(struct unrhdr *uh, u_int item);
391 * Population count algorithm using SWAR approach
392 * - "SIMD Within A Register".
394 static __inline uint32_t
395 bitcount32(uint32_t x)
398 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
399 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
400 x = (x + (x >> 4)) & 0x0f0f0f0f;
402 x = (x + (x >> 16)) & 0x000000ff;
406 static __inline uint16_t
407 bitcount16(uint32_t x)
410 x = (x & 0x5555) + ((x & 0xaaaa) >> 1);
411 x = (x & 0x3333) + ((x & 0xcccc) >> 2);
412 x = (x + (x >> 4)) & 0x0f0f;
413 x = (x + (x >> 8)) & 0x00ff;
417 #endif /* !_SYS_SYSTM_H_ */