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 __NULLABILITY_PRAGMA_PUSH
50 extern int cold; /* nonzero if we are doing a cold boot */
51 extern int suspend_blocked; /* block suspend due to pending shutdown */
52 extern int rebooting; /* kern_reboot() has been called. */
53 extern const char *panicstr; /* panic message */
54 extern char version[]; /* system version */
55 extern char compiler_version[]; /* compiler version */
56 extern char copyright[]; /* system copyright */
57 extern int kstack_pages; /* number of kernel stack pages */
59 extern u_long pagesizes[]; /* supported page sizes */
60 extern long physmem; /* physical memory */
61 extern long realmem; /* 'real' memory */
63 extern char *rootdevnames[2]; /* names of possible root devices */
65 extern int boothowto; /* reboot flags, from console subsystem */
66 extern int bootverbose; /* nonzero to print verbose messages */
68 extern int maxusers; /* system tune hint */
69 extern int ngroups_max; /* max # of supplemental groups */
70 extern int vm_guest; /* Running as virtual machine guest? */
73 * Detected virtual machine guest types. The intention is to expand
74 * and/or add to the VM_GUEST_VM type if specific VM functionality is
75 * ever implemented (e.g. vendor-specific paravirtualization features).
76 * Keep in sync with vm_guest_sysctl_names[].
78 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN, VM_GUEST_HV,
79 VM_GUEST_VMWARE, VM_GUEST_KVM, VM_LAST };
81 #if defined(WITNESS) || defined(INVARIANT_SUPPORT)
82 void kassert_panic(const char *fmt, ...) __printflike(1, 2);
85 #ifdef INVARIANTS /* The option is always available */
86 #define KASSERT(exp,msg) do { \
87 if (__predict_false(!(exp))) \
90 #define VNASSERT(exp, vp, msg) do { \
91 if (__predict_false(!(exp))) { \
92 vn_printf(vp, "VNASSERT failed\n"); \
97 #define KASSERT(exp,msg) do { \
100 #define VNASSERT(exp, vp, msg) do { \
104 #ifndef CTASSERT /* Allow lint to override */
105 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed")
109 * Assert that a pointer can be loaded from memory atomically.
111 * This assertion enforces stronger alignment than necessary. For example,
112 * on some architectures, atomicity for unaligned loads will depend on
113 * whether or not the load spans multiple cache lines.
115 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \
116 KASSERT(sizeof(var) == sizeof(void *) && \
117 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
120 * Assert that a thread is in critical(9) section.
122 #define CRITICAL_ASSERT(td) \
123 KASSERT((td)->td_critnest >= 1, ("Not in critical section"));
126 * If we have already panic'd and this is the thread that called
127 * panic(), then don't block on any mutexes but silently succeed.
128 * Otherwise, the kernel will deadlock since the scheduler isn't
129 * going to run the thread that holds any lock we need.
131 #define SCHEDULER_STOPPED_TD(td) ({ \
132 MPASS((td) == curthread); \
133 __predict_false((td)->td_stopsched); \
135 #define SCHEDULER_STOPPED() SCHEDULER_STOPPED_TD(curthread)
140 #define __read_mostly __section(".data.read_mostly")
141 #define __exclusive_cache_line __aligned(CACHE_LINE_SIZE) \
142 __section(".data.exclusive_cache_line")
144 * XXX the hints declarations are even more misplaced than most declarations
145 * in this file, since they are needed in one file (per arch) and only used
147 * XXX most of these variables should be const.
149 extern int osreldate;
151 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
152 extern int dynamic_kenv;
153 extern struct mtx kenv_lock;
154 extern char *kern_envp;
155 extern char static_env[];
156 extern char static_hints[]; /* by config for now */
160 extern const void *zero_region; /* address space maps to a zeroed page */
162 extern int unmapped_buf_allowed;
165 #define IOSIZE_MAX iosize_max()
166 #define DEVFS_IOSIZE_MAX devfs_iosize_max()
168 #define IOSIZE_MAX SSIZE_MAX
169 #define DEVFS_IOSIZE_MAX SSIZE_MAX
173 * General function declarations.
190 int setjmp(struct _jmp_buf *) __returns_twice;
191 void longjmp(struct _jmp_buf *, int) __dead2;
192 int dumpstatus(vm_offset_t addr, off_t count);
194 int eopnotsupp(void);
195 int ureadc(int, struct uio *);
196 void hashdestroy(void *, struct malloc_type *, u_long);
197 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
198 void *hashinit_flags(int count, struct malloc_type *type,
199 u_long *hashmask, int flags);
200 #define HASH_NOWAIT 0x00000001
201 #define HASH_WAITOK 0x00000002
203 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
204 void *phashinit_flags(int count, struct malloc_type *type, u_long *nentries,
206 void g_waitidle(void);
208 void panic(const char *, ...) __dead2 __printflike(1, 2);
209 void vpanic(const char *, __va_list) __dead2 __printflike(1, 0);
212 void cpu_flush_dcache(void *, size_t);
213 void cpu_rootconf(void);
214 void critical_enter(void);
215 void critical_exit(void);
216 void init_param1(void);
217 void init_param2(long physpages);
218 void init_static_kenv(char *, size_t);
219 void tablefull(const char *);
221 typedef void early_putc_t(int ch);
222 extern early_putc_t *early_putc;
224 int kvprintf(char const *, void (*)(int, void*), void *, int,
225 __va_list) __printflike(1, 0);
226 void log(int, const char *, ...) __printflike(2, 3);
227 void log_console(struct uio *);
228 void vlog(int, const char *, __va_list) __printflike(2, 0);
229 int asprintf(char **ret, struct malloc_type *mtp, const char *format,
230 ...) __printflike(3, 4);
231 int printf(const char *, ...) __printflike(1, 2);
232 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
233 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
234 int uprintf(const char *, ...) __printflike(1, 2);
235 int vprintf(const char *, __va_list) __printflike(1, 0);
236 int vasprintf(char **ret, struct malloc_type *mtp, const char *format,
237 __va_list ap) __printflike(3, 0);
238 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
239 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
240 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
241 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
242 int sscanf(const char *, char const * _Nonnull, ...) __scanflike(2, 3);
243 int vsscanf(const char * _Nonnull, char const * _Nonnull, __va_list) __scanflike(2, 0);
244 long strtol(const char *, char **, int);
245 u_long strtoul(const char *, char **, int);
246 quad_t strtoq(const char *, char **, int);
247 u_quad_t strtouq(const char *, char **, int);
248 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
249 void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
250 void hexdump(const void *ptr, int length, const char *hdr, int flags);
251 #define HD_COLUMN_MASK 0xff
252 #define HD_DELIM_MASK 0xff00
253 #define HD_OMIT_COUNT (1 << 16)
254 #define HD_OMIT_HEX (1 << 17)
255 #define HD_OMIT_CHARS (1 << 18)
257 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
258 void bcopy(const void * _Nonnull from, void * _Nonnull to, size_t len);
259 void bzero(void * _Nonnull buf, size_t len);
260 void explicit_bzero(void * _Nonnull, size_t);
262 void *memcpy(void * _Nonnull to, const void * _Nonnull from, size_t len);
263 void *memmove(void * _Nonnull dest, const void * _Nonnull src, size_t n);
265 int copystr(const void * _Nonnull __restrict kfaddr,
266 void * _Nonnull __restrict kdaddr, size_t len,
267 size_t * __restrict lencopied);
268 int copyinstr(const void * __restrict udaddr,
269 void * _Nonnull __restrict kaddr, size_t len,
270 size_t * __restrict lencopied);
271 int copyin(const void * _Nonnull __restrict udaddr,
272 void * _Nonnull __restrict kaddr, size_t len);
273 int copyin_nofault(const void * _Nonnull __restrict udaddr,
274 void * _Nonnull __restrict kaddr, size_t len);
275 int copyout(const void * _Nonnull __restrict kaddr,
276 void * _Nonnull __restrict udaddr, size_t len);
277 int copyout_nofault(const void * _Nonnull __restrict kaddr,
278 void * _Nonnull __restrict udaddr, size_t len);
280 int fubyte(volatile const void *base);
281 long fuword(volatile const void *base);
282 int fuword16(volatile const void *base);
283 int32_t fuword32(volatile const void *base);
284 int64_t fuword64(volatile const void *base);
285 int fueword(volatile const void *base, long *val);
286 int fueword32(volatile const void *base, int32_t *val);
287 int fueword64(volatile const void *base, int64_t *val);
288 int subyte(volatile void *base, int byte);
289 int suword(volatile void *base, long word);
290 int suword16(volatile void *base, int word);
291 int suword32(volatile void *base, int32_t word);
292 int suword64(volatile void *base, int64_t word);
293 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
294 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
295 int casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp,
297 int casueword(volatile u_long *p, u_long oldval, u_long *oldvalp,
300 void realitexpire(void *);
302 int sysbeep(int hertz, int period);
304 void hardclock(int usermode, uintfptr_t pc);
305 void hardclock_cnt(int cnt, int usermode);
306 void hardclock_cpu(int usermode);
307 void hardclock_sync(int cpu);
308 void softclock(void *);
309 void statclock(int usermode);
310 void statclock_cnt(int cnt, int usermode);
311 void profclock(int usermode, uintfptr_t pc);
312 void profclock_cnt(int cnt, int usermode, uintfptr_t pc);
314 int hardclockintr(void);
316 void startprofclock(struct proc *);
317 void stopprofclock(struct proc *);
318 void cpu_startprofclock(void);
319 void cpu_stopprofclock(void);
320 sbintime_t cpu_idleclock(void);
321 void cpu_activeclock(void);
322 void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
323 void cpu_et_frequency(struct eventtimer *et, uint64_t newfreq);
324 extern int cpu_deepest_sleep;
325 extern int cpu_disable_c2_sleep;
326 extern int cpu_disable_c3_sleep;
328 char *kern_getenv(const char *name);
329 void freeenv(char *env);
330 int getenv_int(const char *name, int *data);
331 int getenv_uint(const char *name, unsigned int *data);
332 int getenv_long(const char *name, long *data);
333 int getenv_ulong(const char *name, unsigned long *data);
334 int getenv_string(const char *name, char *data, int size);
335 int getenv_int64(const char *name, int64_t *data);
336 int getenv_uint64(const char *name, uint64_t *data);
337 int getenv_quad(const char *name, quad_t *data);
338 int kern_setenv(const char *name, const char *value);
339 int kern_unsetenv(const char *name);
340 int testenv(const char *name);
342 typedef uint64_t (cpu_tick_f)(void);
343 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
344 extern cpu_tick_f *cpu_ticks;
345 uint64_t cpu_tickrate(void);
346 uint64_t cputick2usec(uint64_t tick);
348 #ifdef APM_FIXUP_CALLTODO
350 void adjust_timeout_calltodo(struct timeval *time_change);
351 #endif /* APM_FIXUP_CALLTODO */
353 #include <sys/libkern.h>
355 /* Initialize the world */
357 void cpu_initclocks(void);
358 void cpu_initclocks_bsp(void);
359 void cpu_initclocks_ap(void);
360 void usrinfoinit(void);
362 /* Finalize the world */
363 void kern_reboot(int) __dead2;
364 void shutdown_nice(int);
367 typedef void timeout_t(void *); /* timeout function type */
368 #define CALLOUT_HANDLE_INITIALIZER(handle) \
371 void callout_handle_init(struct callout_handle *);
372 struct callout_handle timeout(timeout_t *, void *, int);
373 void untimeout(timeout_t *, void *, struct callout_handle);
375 /* Stubs for obsolete functions that used to be for interrupt management */
376 static __inline intrmask_t splbio(void) { return 0; }
377 static __inline intrmask_t splcam(void) { return 0; }
378 static __inline intrmask_t splclock(void) { return 0; }
379 static __inline intrmask_t splhigh(void) { return 0; }
380 static __inline intrmask_t splimp(void) { return 0; }
381 static __inline intrmask_t splnet(void) { return 0; }
382 static __inline intrmask_t spltty(void) { return 0; }
383 static __inline void splx(intrmask_t ipl __unused) { return; }
386 * Common `proc' functions are declared here so that proc.h can be included
389 int _sleep(void * _Nonnull chan, struct lock_object *lock, int pri,
390 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
391 #define msleep(chan, mtx, pri, wmesg, timo) \
392 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \
393 tick_sbt * (timo), 0, C_HARDCLOCK)
394 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \
395 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
397 int msleep_spin_sbt(void * _Nonnull chan, struct mtx *mtx,
398 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
399 #define msleep_spin(chan, mtx, wmesg, timo) \
400 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \
402 int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
404 #define pause(wmesg, timo) \
405 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK)
406 #define tsleep(chan, pri, wmesg, timo) \
407 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \
409 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \
410 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
411 void wakeup(void * chan);
412 void wakeup_one(void * chan);
415 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
419 dev_t dev2udev(struct cdev *x);
420 const char *devtoname(struct cdev *cdev);
423 size_t devfs_iosize_max(void);
424 size_t iosize_max(void);
427 int poll_no_poll(int events);
429 /* XXX: Should be void nanodelay(u_int nsec); */
430 void DELAY(int usec);
432 /* Root mount holdback API */
433 struct root_hold_token;
435 struct root_hold_token *root_mount_hold(const char *identifier);
436 void root_mount_rel(struct root_hold_token *h);
437 int root_mounted(void);
441 * Unit number allocation API. (kern/subr_unit.c)
444 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
445 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
446 void delete_unrhdr(struct unrhdr *uh);
447 void clean_unrhdr(struct unrhdr *uh);
448 void clean_unrhdrl(struct unrhdr *uh);
449 int alloc_unr(struct unrhdr *uh);
450 int alloc_unr_specific(struct unrhdr *uh, u_int item);
451 int alloc_unrl(struct unrhdr *uh);
452 void free_unr(struct unrhdr *uh, u_int item);
454 void intr_prof_stack_use(struct thread *td, struct trapframe *frame);
456 extern void (*softdep_ast_cleanup)(void);
458 void counted_warning(unsigned *counter, const char *msg);
460 __NULLABILITY_PRAGMA_POP
462 #endif /* !_SYS_SYSTM_H_ */