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 compiler_version[]; /* compiler version */
53 extern char copyright[]; /* system copyright */
54 extern int kstack_pages; /* number of kernel stack pages */
56 extern u_long pagesizes[]; /* supported page sizes */
57 extern long physmem; /* physical memory */
58 extern long realmem; /* 'real' memory */
60 extern char *rootdevnames[2]; /* names of possible root devices */
62 extern int boothowto; /* reboot flags, from console subsystem */
63 extern int bootverbose; /* nonzero to print verbose messages */
65 extern int maxusers; /* system tune hint */
66 extern int ngroups_max; /* max # of supplemental groups */
67 extern int vm_guest; /* Running as virtual machine guest? */
70 * Detected virtual machine guest types. The intention is to expand
71 * and/or add to the VM_GUEST_VM type if specific VM functionality is
72 * ever implemented (e.g. vendor-specific paravirtualization features).
74 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN };
76 #if defined(WITNESS) || defined(INVARIANTS)
77 void kassert_panic(const char *fmt, ...);
80 #ifdef INVARIANTS /* The option is always available */
81 #define KASSERT(exp,msg) do { \
82 if (__predict_false(!(exp))) \
85 #define VNASSERT(exp, vp, msg) do { \
86 if (__predict_false(!(exp))) { \
87 vn_printf(vp, "VNASSERT failed\n"); \
92 #define KASSERT(exp,msg) do { \
95 #define VNASSERT(exp, vp, msg) do { \
99 #ifndef CTASSERT /* Allow lint to override */
100 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed")
104 * Assert that a pointer can be loaded from memory atomically.
106 * This assertion enforces stronger alignment than necessary. For example,
107 * on some architectures, atomicity for unaligned loads will depend on
108 * whether or not the load spans multiple cache lines.
110 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \
111 KASSERT(sizeof(var) == sizeof(void *) && \
112 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
115 * If we have already panic'd and this is the thread that called
116 * panic(), then don't block on any mutexes but silently succeed.
117 * Otherwise, the kernel will deadlock since the scheduler isn't
118 * going to run the thread that holds any lock we need.
120 #define SCHEDULER_STOPPED() __predict_false(curthread->td_stopsched)
123 * XXX the hints declarations are even more misplaced than most declarations
124 * in this file, since they are needed in one file (per arch) and only used
126 * XXX most of these variables should be const.
128 extern int osreldate;
130 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
131 extern int dynamic_kenv;
132 extern struct mtx kenv_lock;
133 extern char *kern_envp;
134 extern char static_env[];
135 extern char static_hints[]; /* by config for now */
139 extern const void *zero_region; /* address space maps to a zeroed page */
141 extern int unmapped_buf_allowed;
142 extern int iosize_max_clamp;
143 #define IOSIZE_MAX (iosize_max_clamp ? INT_MAX : SSIZE_MAX)
146 * General function declarations.
162 int setjmp(struct _jmp_buf *) __returns_twice;
163 void longjmp(struct _jmp_buf *, int) __dead2;
164 int dumpstatus(vm_offset_t addr, off_t count);
166 int eopnotsupp(void);
167 int ureadc(int, struct uio *);
168 void hashdestroy(void *, struct malloc_type *, u_long);
169 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
170 void *hashinit_flags(int count, struct malloc_type *type,
171 u_long *hashmask, int flags);
172 #define HASH_NOWAIT 0x00000001
173 #define HASH_WAITOK 0x00000002
175 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
176 void g_waitidle(void);
178 void panic(const char *, ...) __dead2 __printflike(1, 2);
181 void cpu_flush_dcache(void *, size_t);
182 void cpu_rootconf(void);
183 void critical_enter(void);
184 void critical_exit(void);
185 void init_param1(void);
186 void init_param2(long physpages);
187 void init_static_kenv(char *, size_t);
188 void tablefull(const char *);
189 int kvprintf(char const *, void (*)(int, void*), void *, int,
190 __va_list) __printflike(1, 0);
191 void log(int, const char *, ...) __printflike(2, 3);
192 void log_console(struct uio *);
193 int printf(const char *, ...) __printflike(1, 2);
194 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
195 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
196 int uprintf(const char *, ...) __printflike(1, 2);
197 int vprintf(const char *, __va_list) __printflike(1, 0);
198 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
199 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
200 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
201 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
202 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
203 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
204 long strtol(const char *, char **, int) __nonnull(1);
205 u_long strtoul(const char *, char **, int) __nonnull(1);
206 quad_t strtoq(const char *, char **, int) __nonnull(1);
207 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
208 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
209 void hexdump(const void *ptr, int length, const char *hdr, int flags);
210 #define HD_COLUMN_MASK 0xff
211 #define HD_DELIM_MASK 0xff00
212 #define HD_OMIT_COUNT (1 << 16)
213 #define HD_OMIT_HEX (1 << 17)
214 #define HD_OMIT_CHARS (1 << 18)
216 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
217 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
218 void bzero(void *buf, size_t len) __nonnull(1);
220 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
221 void *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
223 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
224 size_t len, size_t * __restrict lencopied)
225 __nonnull(1) __nonnull(2);
226 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
227 size_t len, size_t * __restrict lencopied)
228 __nonnull(1) __nonnull(2);
229 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
230 size_t len) __nonnull(1) __nonnull(2);
231 int copyin_nofault(const void * __restrict udaddr, void * __restrict kaddr,
232 size_t len) __nonnull(1) __nonnull(2);
233 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
234 size_t len) __nonnull(1) __nonnull(2);
235 int copyout_nofault(const void * __restrict kaddr, void * __restrict udaddr,
236 size_t len) __nonnull(1) __nonnull(2);
238 int fubyte(const void *base);
239 long fuword(const void *base);
240 int fuword16(void *base);
241 int32_t fuword32(const void *base);
242 int64_t fuword64(const void *base);
243 int subyte(void *base, int byte);
244 int suword(void *base, long word);
245 int suword16(void *base, int word);
246 int suword32(void *base, int32_t word);
247 int suword64(void *base, int64_t word);
248 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
249 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
251 void realitexpire(void *);
253 int sysbeep(int hertz, int period);
255 void hardclock(int usermode, uintfptr_t pc);
256 void hardclock_cnt(int cnt, int usermode);
257 void hardclock_cpu(int usermode);
258 void hardclock_sync(int cpu);
259 void softclock(void *);
260 void statclock(int usermode);
261 void statclock_cnt(int cnt, int usermode);
262 void profclock(int usermode, uintfptr_t pc);
263 void profclock_cnt(int cnt, int usermode, uintfptr_t pc);
265 int hardclockintr(void);
267 void startprofclock(struct proc *);
268 void stopprofclock(struct proc *);
269 void cpu_startprofclock(void);
270 void cpu_stopprofclock(void);
271 sbintime_t cpu_idleclock(void);
272 void cpu_activeclock(void);
273 void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
274 extern int cpu_can_deep_sleep;
275 extern int cpu_disable_deep_sleep;
277 int cr_cansee(struct ucred *u1, struct ucred *u2);
278 int cr_canseesocket(struct ucred *cred, struct socket *so);
279 int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
281 char *getenv(const char *name);
282 void freeenv(char *env);
283 int getenv_int(const char *name, int *data);
284 int getenv_uint(const char *name, unsigned int *data);
285 int getenv_long(const char *name, long *data);
286 int getenv_ulong(const char *name, unsigned long *data);
287 int getenv_string(const char *name, char *data, int size);
288 int getenv_quad(const char *name, quad_t *data);
289 int setenv(const char *name, const char *value);
290 int unsetenv(const char *name);
291 int testenv(const char *name);
293 typedef uint64_t (cpu_tick_f)(void);
294 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
295 extern cpu_tick_f *cpu_ticks;
296 uint64_t cpu_tickrate(void);
297 uint64_t cputick2usec(uint64_t tick);
299 #ifdef APM_FIXUP_CALLTODO
301 void adjust_timeout_calltodo(struct timeval *time_change);
302 #endif /* APM_FIXUP_CALLTODO */
304 #include <sys/libkern.h>
306 /* Initialize the world */
308 void cpu_initclocks(void);
309 void cpu_initclocks_bsp(void);
310 void cpu_initclocks_ap(void);
311 void usrinfoinit(void);
313 /* Finalize the world */
314 void kern_reboot(int) __dead2;
315 void shutdown_nice(int);
318 typedef void timeout_t(void *); /* timeout function type */
319 #define CALLOUT_HANDLE_INITIALIZER(handle) \
322 void callout_handle_init(struct callout_handle *);
323 struct callout_handle timeout(timeout_t *, void *, int);
324 void untimeout(timeout_t *, void *, struct callout_handle);
326 /* Stubs for obsolete functions that used to be for interrupt management */
327 static __inline intrmask_t splbio(void) { return 0; }
328 static __inline intrmask_t splcam(void) { return 0; }
329 static __inline intrmask_t splclock(void) { return 0; }
330 static __inline intrmask_t splhigh(void) { return 0; }
331 static __inline intrmask_t splimp(void) { return 0; }
332 static __inline intrmask_t splnet(void) { return 0; }
333 static __inline intrmask_t spltty(void) { return 0; }
334 static __inline intrmask_t splvm(void) { return 0; }
335 static __inline void splx(intrmask_t ipl __unused) { return; }
338 * Common `proc' functions are declared here so that proc.h can be included
341 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
342 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1);
343 #define msleep(chan, mtx, pri, wmesg, timo) \
344 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \
345 tick_sbt * (timo), 0, C_HARDCLOCK)
346 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \
347 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
349 int msleep_spin_sbt(void *chan, struct mtx *mtx, const char *wmesg,
350 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1);
351 #define msleep_spin(chan, mtx, wmesg, timo) \
352 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \
354 int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
356 #define pause(wmesg, timo) \
357 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK)
358 #define tsleep(chan, pri, wmesg, timo) \
359 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \
361 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \
362 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
363 void wakeup(void *chan) __nonnull(1);
364 void wakeup_one(void *chan) __nonnull(1);
367 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
371 dev_t dev2udev(struct cdev *x);
372 const char *devtoname(struct cdev *cdev);
374 int poll_no_poll(int events);
376 /* XXX: Should be void nanodelay(u_int nsec); */
377 void DELAY(int usec);
379 /* Root mount holdback API */
380 struct root_hold_token;
382 struct root_hold_token *root_mount_hold(const char *identifier);
383 void root_mount_rel(struct root_hold_token *h);
384 void root_mount_wait(void);
385 int root_mounted(void);
389 * Unit number allocation API. (kern/subr_unit.c)
392 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
393 void delete_unrhdr(struct unrhdr *uh);
394 void clean_unrhdr(struct unrhdr *uh);
395 void clean_unrhdrl(struct unrhdr *uh);
396 int alloc_unr(struct unrhdr *uh);
397 int alloc_unr_specific(struct unrhdr *uh, u_int item);
398 int alloc_unrl(struct unrhdr *uh);
399 void free_unr(struct unrhdr *uh, u_int item);
402 * Population count algorithm using SWAR approach
403 * - "SIMD Within A Register".
405 static __inline uint32_t
406 bitcount32(uint32_t x)
409 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
410 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
411 x = (x + (x >> 4)) & 0x0f0f0f0f;
413 x = (x + (x >> 16)) & 0x000000ff;
417 static __inline uint16_t
418 bitcount16(uint32_t x)
421 x = (x & 0x5555) + ((x & 0xaaaa) >> 1);
422 x = (x & 0x3333) + ((x & 0xcccc) >> 2);
423 x = (x + (x >> 4)) & 0x0f0f;
424 x = (x + (x >> 8)) & 0x00ff;
428 #endif /* !_SYS_SYSTM_H_ */