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, ...) __printflike(1, 2);
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 * Assert that a thread is in critical(9) section.
117 #define CRITICAL_ASSERT(td) \
118 KASSERT((td)->td_critnest >= 1, ("Not in critical section"));
121 * If we have already panic'd and this is the thread that called
122 * panic(), then don't block on any mutexes but silently succeed.
123 * Otherwise, the kernel will deadlock since the scheduler isn't
124 * going to run the thread that holds any lock we need.
126 #define SCHEDULER_STOPPED() __predict_false(curthread->td_stopsched)
129 * XXX the hints declarations are even more misplaced than most declarations
130 * in this file, since they are needed in one file (per arch) and only used
132 * XXX most of these variables should be const.
134 extern int osreldate;
136 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
137 extern int dynamic_kenv;
138 extern struct mtx kenv_lock;
139 extern char *kern_envp;
140 extern char static_env[];
141 extern char static_hints[]; /* by config for now */
145 extern const void *zero_region; /* address space maps to a zeroed page */
147 extern int unmapped_buf_allowed;
148 extern int iosize_max_clamp;
149 #define IOSIZE_MAX (iosize_max_clamp ? INT_MAX : SSIZE_MAX)
152 * General function declarations.
168 int setjmp(struct _jmp_buf *) __returns_twice;
169 void longjmp(struct _jmp_buf *, int) __dead2;
170 int dumpstatus(vm_offset_t addr, off_t count);
172 int eopnotsupp(void);
173 int ureadc(int, struct uio *);
174 void hashdestroy(void *, struct malloc_type *, u_long);
175 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
176 void *hashinit_flags(int count, struct malloc_type *type,
177 u_long *hashmask, int flags);
178 #define HASH_NOWAIT 0x00000001
179 #define HASH_WAITOK 0x00000002
181 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
182 void g_waitidle(void);
184 void panic(const char *, ...) __dead2 __printflike(1, 2);
187 void cpu_flush_dcache(void *, size_t);
188 void cpu_rootconf(void);
189 void critical_enter(void);
190 void critical_exit(void);
191 void init_param1(void);
192 void init_param2(long physpages);
193 void init_static_kenv(char *, size_t);
194 void tablefull(const char *);
195 int kvprintf(char const *, void (*)(int, void*), void *, int,
196 __va_list) __printflike(1, 0);
197 void log(int, const char *, ...) __printflike(2, 3);
198 void log_console(struct uio *);
199 int printf(const char *, ...) __printflike(1, 2);
200 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
201 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
202 int uprintf(const char *, ...) __printflike(1, 2);
203 int vprintf(const char *, __va_list) __printflike(1, 0);
204 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
205 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
206 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
207 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
208 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
209 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
210 long strtol(const char *, char **, int) __nonnull(1);
211 u_long strtoul(const char *, char **, int) __nonnull(1);
212 quad_t strtoq(const char *, char **, int) __nonnull(1);
213 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
214 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
215 void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
216 void hexdump(const void *ptr, int length, const char *hdr, int flags);
217 #define HD_COLUMN_MASK 0xff
218 #define HD_DELIM_MASK 0xff00
219 #define HD_OMIT_COUNT (1 << 16)
220 #define HD_OMIT_HEX (1 << 17)
221 #define HD_OMIT_CHARS (1 << 18)
223 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
224 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
225 void bzero(void *buf, size_t len) __nonnull(1);
227 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
228 void *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
230 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
231 size_t len, size_t * __restrict lencopied)
232 __nonnull(1) __nonnull(2);
233 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
234 size_t len, size_t * __restrict lencopied)
235 __nonnull(1) __nonnull(2);
236 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
237 size_t len) __nonnull(1) __nonnull(2);
238 int copyin_nofault(const void * __restrict udaddr, void * __restrict kaddr,
239 size_t len) __nonnull(1) __nonnull(2);
240 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
241 size_t len) __nonnull(1) __nonnull(2);
242 int copyout_nofault(const void * __restrict kaddr, void * __restrict udaddr,
243 size_t len) __nonnull(1) __nonnull(2);
245 int fubyte(const void *base);
246 long fuword(const void *base);
247 int fuword16(void *base);
248 int32_t fuword32(const void *base);
249 int64_t fuword64(const void *base);
250 int subyte(void *base, int byte);
251 int suword(void *base, long word);
252 int suword16(void *base, int word);
253 int suword32(void *base, int32_t word);
254 int suword64(void *base, int64_t word);
255 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
256 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
258 void realitexpire(void *);
260 int sysbeep(int hertz, int period);
262 void hardclock(int usermode, uintfptr_t pc);
263 void hardclock_cnt(int cnt, int usermode);
264 void hardclock_cpu(int usermode);
265 void hardclock_sync(int cpu);
266 void softclock(void *);
267 void statclock(int usermode);
268 void statclock_cnt(int cnt, int usermode);
269 void profclock(int usermode, uintfptr_t pc);
270 void profclock_cnt(int cnt, int usermode, uintfptr_t pc);
272 int hardclockintr(void);
274 void startprofclock(struct proc *);
275 void stopprofclock(struct proc *);
276 void cpu_startprofclock(void);
277 void cpu_stopprofclock(void);
278 sbintime_t cpu_idleclock(void);
279 void cpu_activeclock(void);
280 void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
281 extern int cpu_can_deep_sleep;
282 extern int cpu_disable_deep_sleep;
284 int cr_cansee(struct ucred *u1, struct ucred *u2);
285 int cr_canseesocket(struct ucred *cred, struct socket *so);
286 int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
288 char *getenv(const char *name);
289 void freeenv(char *env);
290 int getenv_int(const char *name, int *data);
291 int getenv_uint(const char *name, unsigned int *data);
292 int getenv_long(const char *name, long *data);
293 int getenv_ulong(const char *name, unsigned long *data);
294 int getenv_string(const char *name, char *data, int size);
295 int getenv_quad(const char *name, quad_t *data);
296 int setenv(const char *name, const char *value);
297 int unsetenv(const char *name);
298 int testenv(const char *name);
300 typedef uint64_t (cpu_tick_f)(void);
301 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
302 extern cpu_tick_f *cpu_ticks;
303 uint64_t cpu_tickrate(void);
304 uint64_t cputick2usec(uint64_t tick);
306 #ifdef APM_FIXUP_CALLTODO
308 void adjust_timeout_calltodo(struct timeval *time_change);
309 #endif /* APM_FIXUP_CALLTODO */
311 #include <sys/libkern.h>
313 /* Initialize the world */
315 void cpu_initclocks(void);
316 void cpu_initclocks_bsp(void);
317 void cpu_initclocks_ap(void);
318 void usrinfoinit(void);
320 /* Finalize the world */
321 void kern_reboot(int) __dead2;
322 void shutdown_nice(int);
325 typedef void timeout_t(void *); /* timeout function type */
326 #define CALLOUT_HANDLE_INITIALIZER(handle) \
329 void callout_handle_init(struct callout_handle *);
330 struct callout_handle timeout(timeout_t *, void *, int);
331 void untimeout(timeout_t *, void *, struct callout_handle);
333 /* Stubs for obsolete functions that used to be for interrupt management */
334 static __inline intrmask_t splbio(void) { return 0; }
335 static __inline intrmask_t splcam(void) { return 0; }
336 static __inline intrmask_t splclock(void) { return 0; }
337 static __inline intrmask_t splhigh(void) { return 0; }
338 static __inline intrmask_t splimp(void) { return 0; }
339 static __inline intrmask_t splnet(void) { return 0; }
340 static __inline intrmask_t spltty(void) { return 0; }
341 static __inline intrmask_t splvm(void) { return 0; }
342 static __inline void splx(intrmask_t ipl __unused) { return; }
345 * Common `proc' functions are declared here so that proc.h can be included
348 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
349 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1);
350 #define msleep(chan, mtx, pri, wmesg, timo) \
351 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \
352 tick_sbt * (timo), 0, C_HARDCLOCK)
353 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \
354 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
356 int msleep_spin_sbt(void *chan, struct mtx *mtx, const char *wmesg,
357 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1);
358 #define msleep_spin(chan, mtx, wmesg, timo) \
359 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \
361 int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
363 #define pause(wmesg, timo) \
364 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK)
365 #define tsleep(chan, pri, wmesg, timo) \
366 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \
368 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \
369 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
370 void wakeup(void *chan) __nonnull(1);
371 void wakeup_one(void *chan) __nonnull(1);
374 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
378 dev_t dev2udev(struct cdev *x);
379 const char *devtoname(struct cdev *cdev);
381 int poll_no_poll(int events);
383 /* XXX: Should be void nanodelay(u_int nsec); */
384 void DELAY(int usec);
386 /* Root mount holdback API */
387 struct root_hold_token;
389 struct root_hold_token *root_mount_hold(const char *identifier);
390 void root_mount_rel(struct root_hold_token *h);
391 void root_mount_wait(void);
392 int root_mounted(void);
396 * Unit number allocation API. (kern/subr_unit.c)
399 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
400 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
401 void delete_unrhdr(struct unrhdr *uh);
402 void clean_unrhdr(struct unrhdr *uh);
403 void clean_unrhdrl(struct unrhdr *uh);
404 int alloc_unr(struct unrhdr *uh);
405 int alloc_unr_specific(struct unrhdr *uh, u_int item);
406 int alloc_unrl(struct unrhdr *uh);
407 void free_unr(struct unrhdr *uh, u_int item);
410 * Population count algorithm using SWAR approach
411 * - "SIMD Within A Register".
413 static __inline uint32_t
414 bitcount32(uint32_t x)
417 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
418 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
419 x = (x + (x >> 4)) & 0x0f0f0f0f;
421 x = (x + (x >> 16)) & 0x000000ff;
425 static __inline uint16_t
426 bitcount16(uint32_t x)
429 x = (x & 0x5555) + ((x & 0xaaaa) >> 1);
430 x = (x & 0x3333) + ((x & 0xcccc) >> 2);
431 x = (x + (x >> 4)) & 0x0f0f;
432 x = (x + (x >> 8)) & 0x00ff;
436 #endif /* !_SYS_SYSTM_H_ */