2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1988, 1991, 1993
5 * The Regents of the University of California. All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * All or some portions of this file are derived from material licensed
8 * to the University of California by American Telephone and Telegraph
9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 * the permission of UNIX System Laboratories, Inc.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * @(#)systm.h 8.7 (Berkeley) 3/29/95
43 #include <sys/cdefs.h>
44 #include <machine/atomic.h>
45 #include <machine/cpufunc.h>
46 #include <sys/callout.h>
47 #include <sys/queue.h>
48 #include <sys/stdint.h> /* for people using printf mainly */
50 __NULLABILITY_PRAGMA_PUSH
52 extern int cold; /* nonzero if we are doing a cold boot */
53 extern int suspend_blocked; /* block suspend due to pending shutdown */
54 extern int rebooting; /* kern_reboot() has been called. */
55 extern const char *panicstr; /* panic message */
57 #define KERNEL_PANICKED() __predict_false(panicked)
58 extern char version[]; /* system version */
59 extern char compiler_version[]; /* compiler version */
60 extern char copyright[]; /* system copyright */
61 extern int kstack_pages; /* number of kernel stack pages */
63 extern u_long pagesizes[]; /* supported page sizes */
64 extern long physmem; /* physical memory */
65 extern long realmem; /* 'real' memory */
67 extern char *rootdevnames[2]; /* names of possible root devices */
69 extern int boothowto; /* reboot flags, from console subsystem */
70 extern int bootverbose; /* nonzero to print verbose messages */
72 extern int maxusers; /* system tune hint */
73 extern int ngroups_max; /* max # of supplemental groups */
74 extern int vm_guest; /* Running as virtual machine guest? */
77 * Detected virtual machine guest types. The intention is to expand
78 * and/or add to the VM_GUEST_VM type if specific VM functionality is
79 * ever implemented (e.g. vendor-specific paravirtualization features).
80 * Keep in sync with vm_guest_sysctl_names[].
82 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN, VM_GUEST_HV,
83 VM_GUEST_VMWARE, VM_GUEST_KVM, VM_GUEST_BHYVE, VM_GUEST_VBOX,
84 VM_GUEST_PARALLELS, VM_LAST };
87 * These functions need to be declared before the KASSERT macro is invoked in
88 * !KASSERT_PANIC_OPTIONAL builds, so their declarations are sort of out of
89 * place compared to other function definitions in this header. On the other
90 * hand, this header is a bit disorganized anyway.
92 void panic(const char *, ...) __dead2 __printflike(1, 2);
93 void vpanic(const char *, __va_list) __dead2 __printflike(1, 0);
95 #if defined(WITNESS) || defined(INVARIANT_SUPPORT)
96 #ifdef KASSERT_PANIC_OPTIONAL
97 void kassert_panic(const char *fmt, ...) __printflike(1, 2);
99 #define kassert_panic panic
103 #ifdef INVARIANTS /* The option is always available */
104 #define KASSERT(exp,msg) do { \
105 if (__predict_false(!(exp))) \
108 #define VNASSERT(exp, vp, msg) do { \
109 if (__predict_false(!(exp))) { \
110 vn_printf(vp, "VNASSERT failed: %s not true at %s:%d (%s)\n",\
111 #exp, __FILE__, __LINE__, __func__); \
115 #define VNPASS(exp, vp) do { \
116 const char *_exp = #exp; \
117 VNASSERT(exp, vp, ("condition %s not met at %s:%d (%s)", \
118 _exp, __FILE__, __LINE__, __func__)); \
121 #define KASSERT(exp,msg) do { \
124 #define VNASSERT(exp, vp, msg) do { \
126 #define VNPASS(exp, vp) do { \
130 #ifndef CTASSERT /* Allow lint to override */
131 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed")
135 #include <sys/param.h> /* MAXCPU */
136 #include <sys/pcpu.h> /* curthread */
137 #include <sys/kpilite.h>
141 * Assert that a pointer can be loaded from memory atomically.
143 * This assertion enforces stronger alignment than necessary. For example,
144 * on some architectures, atomicity for unaligned loads will depend on
145 * whether or not the load spans multiple cache lines.
147 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \
148 KASSERT(sizeof(var) == sizeof(void *) && \
149 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
152 * Assert that a thread is in critical(9) section.
154 #define CRITICAL_ASSERT(td) \
155 KASSERT((td)->td_critnest >= 1, ("Not in critical section"));
158 * If we have already panic'd and this is the thread that called
159 * panic(), then don't block on any mutexes but silently succeed.
160 * Otherwise, the kernel will deadlock since the scheduler isn't
161 * going to run the thread that holds any lock we need.
163 #define SCHEDULER_STOPPED_TD(td) ({ \
164 MPASS((td) == curthread); \
165 __predict_false((td)->td_stopsched); \
167 #define SCHEDULER_STOPPED() SCHEDULER_STOPPED_TD(curthread)
172 #define __read_mostly __section(".data.read_mostly")
173 #define __read_frequently __section(".data.read_frequently")
174 #define __exclusive_cache_line __aligned(CACHE_LINE_SIZE) \
175 __section(".data.exclusive_cache_line")
177 * XXX the hints declarations are even more misplaced than most declarations
178 * in this file, since they are needed in one file (per arch) and only used
180 * XXX most of these variables should be const.
182 extern int osreldate;
183 extern bool dynamic_kenv;
184 extern struct mtx kenv_lock;
185 extern char *kern_envp;
186 extern char *md_envp;
187 extern char static_env[];
188 extern char static_hints[]; /* by config for now */
192 extern const void *zero_region; /* address space maps to a zeroed page */
194 extern int unmapped_buf_allowed;
197 #define IOSIZE_MAX iosize_max()
198 #define DEVFS_IOSIZE_MAX devfs_iosize_max()
200 #define IOSIZE_MAX SSIZE_MAX
201 #define DEVFS_IOSIZE_MAX SSIZE_MAX
205 * General function declarations.
222 int setjmp(struct _jmp_buf *) __returns_twice;
223 void longjmp(struct _jmp_buf *, int) __dead2;
224 int dumpstatus(vm_offset_t addr, off_t count);
226 int eopnotsupp(void);
227 int ureadc(int, struct uio *);
228 void hashdestroy(void *, struct malloc_type *, u_long);
229 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
230 void *hashinit_flags(int count, struct malloc_type *type,
231 u_long *hashmask, int flags);
232 #define HASH_NOWAIT 0x00000001
233 #define HASH_WAITOK 0x00000002
235 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
236 void *phashinit_flags(int count, struct malloc_type *type, u_long *nentries,
238 void g_waitidle(void);
241 void cpu_flush_dcache(void *, size_t);
242 void cpu_rootconf(void);
243 void critical_enter_KBI(void);
244 void critical_exit_KBI(void);
245 void critical_exit_preempt(void);
246 void init_param1(void);
247 void init_param2(long physpages);
248 void init_static_kenv(char *, size_t);
249 void tablefull(const char *);
252 * Allocate per-thread "current" state in the linuxkpi
254 extern int (*lkpi_alloc_current)(struct thread *, int);
255 int linux_alloc_current_noop(struct thread *, int);
258 #if defined(KLD_MODULE) || defined(KTR_CRITICAL) || !defined(_KERNEL) || defined(GENOFFSET)
259 #define critical_enter() critical_enter_KBI()
260 #define critical_exit() critical_exit_KBI()
265 struct thread_lite *td;
267 td = (struct thread_lite *)curthread;
275 struct thread_lite *td;
277 td = (struct thread_lite *)curthread;
278 KASSERT(td->td_critnest != 0,
279 ("critical_exit: td_critnest == 0"));
283 if (__predict_false(td->td_owepreempt))
284 critical_exit_preempt();
291 typedef void early_putc_t(int ch);
292 extern early_putc_t *early_putc;
294 int kvprintf(char const *, void (*)(int, void*), void *, int,
295 __va_list) __printflike(1, 0);
296 void log(int, const char *, ...) __printflike(2, 3);
297 void log_console(struct uio *);
298 void vlog(int, const char *, __va_list) __printflike(2, 0);
299 int asprintf(char **ret, struct malloc_type *mtp, const char *format,
300 ...) __printflike(3, 4);
301 int printf(const char *, ...) __printflike(1, 2);
302 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
303 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
304 int uprintf(const char *, ...) __printflike(1, 2);
305 int vprintf(const char *, __va_list) __printflike(1, 0);
306 int vasprintf(char **ret, struct malloc_type *mtp, const char *format,
307 __va_list ap) __printflike(3, 0);
308 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
309 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
310 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
311 int sscanf(const char *, char const * _Nonnull, ...) __scanflike(2, 3);
312 int vsscanf(const char * _Nonnull, char const * _Nonnull, __va_list) __scanflike(2, 0);
313 long strtol(const char *, char **, int);
314 u_long strtoul(const char *, char **, int);
315 quad_t strtoq(const char *, char **, int);
316 u_quad_t strtouq(const char *, char **, int);
317 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
318 void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
319 void hexdump(const void *ptr, int length, const char *hdr, int flags);
320 #define HD_COLUMN_MASK 0xff
321 #define HD_DELIM_MASK 0xff00
322 #define HD_OMIT_COUNT (1 << 16)
323 #define HD_OMIT_HEX (1 << 17)
324 #define HD_OMIT_CHARS (1 << 18)
326 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
327 void bcopy(const void * _Nonnull from, void * _Nonnull to, size_t len);
328 void bzero(void * _Nonnull buf, size_t len);
329 void explicit_bzero(void * _Nonnull, size_t);
330 int bcmp(const void *b1, const void *b2, size_t len);
332 void *memset(void * _Nonnull buf, int c, size_t len);
333 void *memcpy(void * _Nonnull to, const void * _Nonnull from, size_t len);
334 void *memmove(void * _Nonnull dest, const void * _Nonnull src, size_t n);
335 int memcmp(const void *b1, const void *b2, size_t len);
338 void *kcsan_memset(void *, int, size_t);
339 void *kcsan_memcpy(void *, const void *, size_t);
340 void *kcsan_memmove(void *, const void *, size_t);
341 int kcsan_memcmp(const void *, const void *, size_t);
342 #define bcopy(from, to, len) kcsan_memmove((to), (from), (len))
343 #define bzero(buf, len) kcsan_memset((buf), 0, (len))
344 #define bcmp(b1, b2, len) kcsan_memcmp((b1), (b2), (len))
345 #define memset(buf, c, len) kcsan_memset((buf), (c), (len))
346 #define memcpy(to, from, len) kcsan_memcpy((to), (from), (len))
347 #define memmove(dest, src, n) kcsan_memmove((dest), (src), (n))
348 #define memcmp(b1, b2, len) kcsan_memcmp((b1), (b2), (len))
350 #define bcopy(from, to, len) __builtin_memmove((to), (from), (len))
351 #define bzero(buf, len) __builtin_memset((buf), 0, (len))
352 #define bcmp(b1, b2, len) __builtin_memcmp((b1), (b2), (len))
353 #define memset(buf, c, len) __builtin_memset((buf), (c), (len))
354 #define memcpy(to, from, len) __builtin_memcpy((to), (from), (len))
355 #define memmove(dest, src, n) __builtin_memmove((dest), (src), (n))
356 #define memcmp(b1, b2, len) __builtin_memcmp((b1), (b2), (len))
359 void *memset_early(void * _Nonnull buf, int c, size_t len);
360 #define bzero_early(buf, len) memset_early((buf), 0, (len))
361 void *memcpy_early(void * _Nonnull to, const void * _Nonnull from, size_t len);
362 void *memmove_early(void * _Nonnull dest, const void * _Nonnull src, size_t n);
363 #define bcopy_early(from, to, len) memmove_early((to), (from), (len))
365 int copystr(const void * _Nonnull __restrict kfaddr,
366 void * _Nonnull __restrict kdaddr, size_t len,
367 size_t * __restrict lencopied);
368 int copyinstr(const void * __restrict udaddr,
369 void * _Nonnull __restrict kaddr, size_t len,
370 size_t * __restrict lencopied);
371 int copyin(const void * __restrict udaddr,
372 void * _Nonnull __restrict kaddr, size_t len);
373 int copyin_nofault(const void * __restrict udaddr,
374 void * _Nonnull __restrict kaddr, size_t len);
375 int copyout(const void * _Nonnull __restrict kaddr,
376 void * __restrict udaddr, size_t len);
377 int copyout_nofault(const void * _Nonnull __restrict kaddr,
378 void * __restrict udaddr, size_t len);
381 int kcsan_copystr(const void *, void *, size_t, size_t *);
382 int kcsan_copyin(const void *, void *, size_t);
383 int kcsan_copyinstr(const void *, void *, size_t, size_t *);
384 int kcsan_copyout(const void *, void *, size_t);
385 #define copystr(kf, k, l, lc) kcsan_copystr((kf), (k), (l), (lc))
386 #define copyin(u, k, l) kcsan_copyin((u), (k), (l))
387 #define copyinstr(u, k, l, lc) kcsan_copyinstr((u), (k), (l), (lc))
388 #define copyout(k, u, l) kcsan_copyout((k), (u), (l))
391 int fubyte(volatile const void *base);
392 long fuword(volatile const void *base);
393 int fuword16(volatile const void *base);
394 int32_t fuword32(volatile const void *base);
395 int64_t fuword64(volatile const void *base);
396 int fueword(volatile const void *base, long *val);
397 int fueword32(volatile const void *base, int32_t *val);
398 int fueword64(volatile const void *base, int64_t *val);
399 int subyte(volatile void *base, int byte);
400 int suword(volatile void *base, long word);
401 int suword16(volatile void *base, int word);
402 int suword32(volatile void *base, int32_t word);
403 int suword64(volatile void *base, int64_t word);
404 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
405 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
406 int casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp,
408 int casueword(volatile u_long *p, u_long oldval, u_long *oldvalp,
411 void realitexpire(void *);
413 int sysbeep(int hertz, int period);
415 void hardclock(int cnt, int usermode);
416 void hardclock_sync(int cpu);
417 void softclock(void *);
418 void statclock(int cnt, int usermode);
419 void profclock(int cnt, int usermode, uintfptr_t pc);
421 int hardclockintr(void);
423 void startprofclock(struct proc *);
424 void stopprofclock(struct proc *);
425 void cpu_startprofclock(void);
426 void cpu_stopprofclock(void);
427 void suspendclock(void);
428 void resumeclock(void);
429 sbintime_t cpu_idleclock(void);
430 void cpu_activeclock(void);
431 void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
432 void cpu_et_frequency(struct eventtimer *et, uint64_t newfreq);
433 extern int cpu_disable_c2_sleep;
434 extern int cpu_disable_c3_sleep;
436 char *kern_getenv(const char *name);
437 void freeenv(char *env);
438 int getenv_int(const char *name, int *data);
439 int getenv_uint(const char *name, unsigned int *data);
440 int getenv_long(const char *name, long *data);
441 int getenv_ulong(const char *name, unsigned long *data);
442 int getenv_string(const char *name, char *data, int size);
443 int getenv_int64(const char *name, int64_t *data);
444 int getenv_uint64(const char *name, uint64_t *data);
445 int getenv_quad(const char *name, quad_t *data);
446 int kern_setenv(const char *name, const char *value);
447 int kern_unsetenv(const char *name);
448 int testenv(const char *name);
450 int getenv_array(const char *name, void *data, int size, int *psize,
451 int type_size, bool allow_signed);
452 #define GETENV_UNSIGNED false /* negative numbers not allowed */
453 #define GETENV_SIGNED true /* negative numbers allowed */
455 typedef uint64_t (cpu_tick_f)(void);
456 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
457 extern cpu_tick_f *cpu_ticks;
458 uint64_t cpu_tickrate(void);
459 uint64_t cputick2usec(uint64_t tick);
461 #ifdef APM_FIXUP_CALLTODO
463 void adjust_timeout_calltodo(struct timeval *time_change);
464 #endif /* APM_FIXUP_CALLTODO */
466 #include <sys/libkern.h>
468 /* Initialize the world */
470 void cpu_initclocks(void);
471 void cpu_initclocks_bsp(void);
472 void cpu_initclocks_ap(void);
473 void usrinfoinit(void);
475 /* Finalize the world */
476 void kern_reboot(int) __dead2;
477 void shutdown_nice(int);
479 /* Stubs for obsolete functions that used to be for interrupt management */
480 static __inline intrmask_t splbio(void) { return 0; }
481 static __inline intrmask_t splcam(void) { return 0; }
482 static __inline intrmask_t splclock(void) { return 0; }
483 static __inline intrmask_t splhigh(void) { return 0; }
484 static __inline intrmask_t splimp(void) { return 0; }
485 static __inline intrmask_t splnet(void) { return 0; }
486 static __inline intrmask_t spltty(void) { return 0; }
487 static __inline void splx(intrmask_t ipl __unused) { return; }
490 * Common `proc' functions are declared here so that proc.h can be included
493 int _sleep(const void * _Nonnull chan, struct lock_object *lock, int pri,
494 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
495 #define msleep(chan, mtx, pri, wmesg, timo) \
496 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \
497 tick_sbt * (timo), 0, C_HARDCLOCK)
498 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \
499 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
501 int msleep_spin_sbt(const void * _Nonnull chan, struct mtx *mtx,
502 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
503 #define msleep_spin(chan, mtx, wmesg, timo) \
504 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \
506 int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
508 #define pause(wmesg, timo) \
509 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK)
510 #define pause_sig(wmesg, timo) \
511 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK | C_CATCH)
512 #define tsleep(chan, pri, wmesg, timo) \
513 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \
515 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \
516 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
517 void wakeup(const void *chan);
518 void wakeup_one(const void *chan);
519 void wakeup_any(const void *chan);
522 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
526 dev_t dev2udev(struct cdev *x);
527 const char *devtoname(struct cdev *cdev);
530 size_t devfs_iosize_max(void);
531 size_t iosize_max(void);
534 int poll_no_poll(int events);
536 /* XXX: Should be void nanodelay(u_int nsec); */
537 void DELAY(int usec);
539 /* Root mount holdback API */
540 struct root_hold_token {
543 TAILQ_ENTRY(root_hold_token) list;
546 struct root_hold_token *root_mount_hold(const char *identifier);
547 void root_mount_hold_token(const char *identifier, struct root_hold_token *h);
548 void root_mount_rel(struct root_hold_token *h);
549 int root_mounted(void);
553 * Unit number allocation API. (kern/subr_unit.c)
556 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
557 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
558 void delete_unrhdr(struct unrhdr *uh);
559 void clear_unrhdr(struct unrhdr *uh);
560 void clean_unrhdr(struct unrhdr *uh);
561 void clean_unrhdrl(struct unrhdr *uh);
562 int alloc_unr(struct unrhdr *uh);
563 int alloc_unr_specific(struct unrhdr *uh, u_int item);
564 int alloc_unrl(struct unrhdr *uh);
565 void free_unr(struct unrhdr *uh, u_int item);
576 new_unrhdr64(struct unrhdr64 *unr64, uint64_t low)
579 unr64->counter = low;
583 uint64_t alloc_unr64(struct unrhdr64 *);
585 static __inline uint64_t
586 alloc_unr64(struct unrhdr64 *unr64)
589 return (atomic_fetchadd_64(&unr64->counter, 1));
593 void intr_prof_stack_use(struct thread *td, struct trapframe *frame);
595 void counted_warning(unsigned *counter, const char *msg);
598 * APIs to manage deprecation and obsolescence.
601 void _gone_in(int major, const char *msg);
602 void _gone_in_dev(struct device *dev, int major, const char *msg);
603 #ifdef NO_OBSOLETE_CODE
604 #define __gone_ok(m, msg) \
605 _Static_assert(m < P_OSREL_MAJOR(__FreeBSD_version)), \
606 "Obsolete code: " msg);
608 #define __gone_ok(m, msg)
610 #define gone_in(major, msg) __gone_ok(major, msg) _gone_in(major, msg)
611 #define gone_in_dev(dev, major, msg) __gone_ok(major, msg) _gone_in_dev(dev, major, msg)
613 __NULLABILITY_PRAGMA_POP
615 #endif /* !_SYS_SYSTM_H_ */