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\n"); \
115 #define KASSERT(exp,msg) do { \
118 #define VNASSERT(exp, vp, msg) do { \
122 #ifndef CTASSERT /* Allow lint to override */
123 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed")
127 #include <sys/param.h> /* MAXCPU */
128 #include <sys/pcpu.h> /* curthread */
129 #include <sys/kpilite.h>
133 * Assert that a pointer can be loaded from memory atomically.
135 * This assertion enforces stronger alignment than necessary. For example,
136 * on some architectures, atomicity for unaligned loads will depend on
137 * whether or not the load spans multiple cache lines.
139 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \
140 KASSERT(sizeof(var) == sizeof(void *) && \
141 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
144 * Assert that a thread is in critical(9) section.
146 #define CRITICAL_ASSERT(td) \
147 KASSERT((td)->td_critnest >= 1, ("Not in critical section"));
150 * If we have already panic'd and this is the thread that called
151 * panic(), then don't block on any mutexes but silently succeed.
152 * Otherwise, the kernel will deadlock since the scheduler isn't
153 * going to run the thread that holds any lock we need.
155 #define SCHEDULER_STOPPED_TD(td) ({ \
156 MPASS((td) == curthread); \
157 __predict_false((td)->td_stopsched); \
159 #define SCHEDULER_STOPPED() SCHEDULER_STOPPED_TD(curthread)
164 #define __read_mostly __section(".data.read_mostly")
165 #define __read_frequently __section(".data.read_frequently")
166 #define __exclusive_cache_line __aligned(CACHE_LINE_SIZE) \
167 __section(".data.exclusive_cache_line")
169 * XXX the hints declarations are even more misplaced than most declarations
170 * in this file, since they are needed in one file (per arch) and only used
172 * XXX most of these variables should be const.
174 extern int osreldate;
175 extern bool dynamic_kenv;
176 extern struct mtx kenv_lock;
177 extern char *kern_envp;
178 extern char *md_envp;
179 extern char static_env[];
180 extern char static_hints[]; /* by config for now */
184 extern const void *zero_region; /* address space maps to a zeroed page */
186 extern int unmapped_buf_allowed;
189 #define IOSIZE_MAX iosize_max()
190 #define DEVFS_IOSIZE_MAX devfs_iosize_max()
192 #define IOSIZE_MAX SSIZE_MAX
193 #define DEVFS_IOSIZE_MAX SSIZE_MAX
197 * General function declarations.
214 int setjmp(struct _jmp_buf *) __returns_twice;
215 void longjmp(struct _jmp_buf *, int) __dead2;
216 int dumpstatus(vm_offset_t addr, off_t count);
218 int eopnotsupp(void);
219 int ureadc(int, struct uio *);
220 void hashdestroy(void *, struct malloc_type *, u_long);
221 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
222 void *hashinit_flags(int count, struct malloc_type *type,
223 u_long *hashmask, int flags);
224 #define HASH_NOWAIT 0x00000001
225 #define HASH_WAITOK 0x00000002
227 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
228 void *phashinit_flags(int count, struct malloc_type *type, u_long *nentries,
230 void g_waitidle(void);
233 void cpu_flush_dcache(void *, size_t);
234 void cpu_rootconf(void);
235 void critical_enter_KBI(void);
236 void critical_exit_KBI(void);
237 void critical_exit_preempt(void);
238 void init_param1(void);
239 void init_param2(long physpages);
240 void init_static_kenv(char *, size_t);
241 void tablefull(const char *);
244 * Allocate per-thread "current" state in the linuxkpi
246 extern int (*lkpi_alloc_current)(struct thread *, int);
247 int linux_alloc_current_noop(struct thread *, int);
250 #if defined(KLD_MODULE) || defined(KTR_CRITICAL) || !defined(_KERNEL) || defined(GENOFFSET)
251 #define critical_enter() critical_enter_KBI()
252 #define critical_exit() critical_exit_KBI()
257 struct thread_lite *td;
259 td = (struct thread_lite *)curthread;
267 struct thread_lite *td;
269 td = (struct thread_lite *)curthread;
270 KASSERT(td->td_critnest != 0,
271 ("critical_exit: td_critnest == 0"));
275 if (__predict_false(td->td_owepreempt))
276 critical_exit_preempt();
283 typedef void early_putc_t(int ch);
284 extern early_putc_t *early_putc;
286 int kvprintf(char const *, void (*)(int, void*), void *, int,
287 __va_list) __printflike(1, 0);
288 void log(int, const char *, ...) __printflike(2, 3);
289 void log_console(struct uio *);
290 void vlog(int, const char *, __va_list) __printflike(2, 0);
291 int asprintf(char **ret, struct malloc_type *mtp, const char *format,
292 ...) __printflike(3, 4);
293 int printf(const char *, ...) __printflike(1, 2);
294 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
295 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
296 int uprintf(const char *, ...) __printflike(1, 2);
297 int vprintf(const char *, __va_list) __printflike(1, 0);
298 int vasprintf(char **ret, struct malloc_type *mtp, const char *format,
299 __va_list ap) __printflike(3, 0);
300 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
301 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
302 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
303 int sscanf(const char *, char const * _Nonnull, ...) __scanflike(2, 3);
304 int vsscanf(const char * _Nonnull, char const * _Nonnull, __va_list) __scanflike(2, 0);
305 long strtol(const char *, char **, int);
306 u_long strtoul(const char *, char **, int);
307 quad_t strtoq(const char *, char **, int);
308 u_quad_t strtouq(const char *, char **, int);
309 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
310 void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
311 void hexdump(const void *ptr, int length, const char *hdr, int flags);
312 #define HD_COLUMN_MASK 0xff
313 #define HD_DELIM_MASK 0xff00
314 #define HD_OMIT_COUNT (1 << 16)
315 #define HD_OMIT_HEX (1 << 17)
316 #define HD_OMIT_CHARS (1 << 18)
318 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
319 void bcopy(const void * _Nonnull from, void * _Nonnull to, size_t len);
320 void bzero(void * _Nonnull buf, size_t len);
321 void explicit_bzero(void * _Nonnull, size_t);
322 int bcmp(const void *b1, const void *b2, size_t len);
324 void *memset(void * _Nonnull buf, int c, size_t len);
325 void *memcpy(void * _Nonnull to, const void * _Nonnull from, size_t len);
326 void *memmove(void * _Nonnull dest, const void * _Nonnull src, size_t n);
327 int memcmp(const void *b1, const void *b2, size_t len);
330 void *kcsan_memset(void *, int, size_t);
331 void *kcsan_memcpy(void *, const void *, size_t);
332 void *kcsan_memmove(void *, const void *, size_t);
333 int kcsan_memcmp(const void *, const void *, size_t);
334 #define bcopy(from, to, len) kcsan_memmove((to), (from), (len))
335 #define bzero(buf, len) kcsan_memset((buf), 0, (len))
336 #define bcmp(b1, b2, len) kcsan_memcmp((b1), (b2), (len))
337 #define memset(buf, c, len) kcsan_memset((buf), (c), (len))
338 #define memcpy(to, from, len) kcsan_memcpy((to), (from), (len))
339 #define memmove(dest, src, n) kcsan_memmove((dest), (src), (n))
340 #define memcmp(b1, b2, len) kcsan_memcmp((b1), (b2), (len))
342 #define bcopy(from, to, len) __builtin_memmove((to), (from), (len))
343 #define bzero(buf, len) __builtin_memset((buf), 0, (len))
344 #define bcmp(b1, b2, len) __builtin_memcmp((b1), (b2), (len))
345 #define memset(buf, c, len) __builtin_memset((buf), (c), (len))
346 #define memcpy(to, from, len) __builtin_memcpy((to), (from), (len))
347 #define memmove(dest, src, n) __builtin_memmove((dest), (src), (n))
348 #define memcmp(b1, b2, len) __builtin_memcmp((b1), (b2), (len))
351 void *memset_early(void * _Nonnull buf, int c, size_t len);
352 #define bzero_early(buf, len) memset_early((buf), 0, (len))
353 void *memcpy_early(void * _Nonnull to, const void * _Nonnull from, size_t len);
354 void *memmove_early(void * _Nonnull dest, const void * _Nonnull src, size_t n);
355 #define bcopy_early(from, to, len) memmove_early((to), (from), (len))
357 int copystr(const void * _Nonnull __restrict kfaddr,
358 void * _Nonnull __restrict kdaddr, size_t len,
359 size_t * __restrict lencopied);
360 int copyinstr(const void * __restrict udaddr,
361 void * _Nonnull __restrict kaddr, size_t len,
362 size_t * __restrict lencopied);
363 int copyin(const void * __restrict udaddr,
364 void * _Nonnull __restrict kaddr, size_t len);
365 int copyin_nofault(const void * __restrict udaddr,
366 void * _Nonnull __restrict kaddr, size_t len);
367 int copyout(const void * _Nonnull __restrict kaddr,
368 void * __restrict udaddr, size_t len);
369 int copyout_nofault(const void * _Nonnull __restrict kaddr,
370 void * __restrict udaddr, size_t len);
373 int kcsan_copystr(const void *, void *, size_t, size_t *);
374 int kcsan_copyin(const void *, void *, size_t);
375 int kcsan_copyinstr(const void *, void *, size_t, size_t *);
376 int kcsan_copyout(const void *, void *, size_t);
377 #define copystr(kf, k, l, lc) kcsan_copystr((kf), (k), (l), (lc))
378 #define copyin(u, k, l) kcsan_copyin((u), (k), (l))
379 #define copyinstr(u, k, l, lc) kcsan_copyinstr((u), (k), (l), (lc))
380 #define copyout(k, u, l) kcsan_copyout((k), (u), (l))
383 int fubyte(volatile const void *base);
384 long fuword(volatile const void *base);
385 int fuword16(volatile const void *base);
386 int32_t fuword32(volatile const void *base);
387 int64_t fuword64(volatile const void *base);
388 int fueword(volatile const void *base, long *val);
389 int fueword32(volatile const void *base, int32_t *val);
390 int fueword64(volatile const void *base, int64_t *val);
391 int subyte(volatile void *base, int byte);
392 int suword(volatile void *base, long word);
393 int suword16(volatile void *base, int word);
394 int suword32(volatile void *base, int32_t word);
395 int suword64(volatile void *base, int64_t word);
396 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
397 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
398 int casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp,
400 int casueword(volatile u_long *p, u_long oldval, u_long *oldvalp,
403 void realitexpire(void *);
405 int sysbeep(int hertz, int period);
407 void hardclock(int cnt, int usermode);
408 void hardclock_sync(int cpu);
409 void softclock(void *);
410 void statclock(int cnt, int usermode);
411 void profclock(int cnt, int usermode, uintfptr_t pc);
413 int hardclockintr(void);
415 void startprofclock(struct proc *);
416 void stopprofclock(struct proc *);
417 void cpu_startprofclock(void);
418 void cpu_stopprofclock(void);
419 void suspendclock(void);
420 void resumeclock(void);
421 sbintime_t cpu_idleclock(void);
422 void cpu_activeclock(void);
423 void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
424 void cpu_et_frequency(struct eventtimer *et, uint64_t newfreq);
425 extern int cpu_disable_c2_sleep;
426 extern int cpu_disable_c3_sleep;
428 char *kern_getenv(const char *name);
429 void freeenv(char *env);
430 int getenv_int(const char *name, int *data);
431 int getenv_uint(const char *name, unsigned int *data);
432 int getenv_long(const char *name, long *data);
433 int getenv_ulong(const char *name, unsigned long *data);
434 int getenv_string(const char *name, char *data, int size);
435 int getenv_int64(const char *name, int64_t *data);
436 int getenv_uint64(const char *name, uint64_t *data);
437 int getenv_quad(const char *name, quad_t *data);
438 int kern_setenv(const char *name, const char *value);
439 int kern_unsetenv(const char *name);
440 int testenv(const char *name);
442 int getenv_array(const char *name, void *data, int size, int *psize,
443 int type_size, bool allow_signed);
444 #define GETENV_UNSIGNED false /* negative numbers not allowed */
445 #define GETENV_SIGNED true /* negative numbers allowed */
447 typedef uint64_t (cpu_tick_f)(void);
448 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
449 extern cpu_tick_f *cpu_ticks;
450 uint64_t cpu_tickrate(void);
451 uint64_t cputick2usec(uint64_t tick);
453 #ifdef APM_FIXUP_CALLTODO
455 void adjust_timeout_calltodo(struct timeval *time_change);
456 #endif /* APM_FIXUP_CALLTODO */
458 #include <sys/libkern.h>
460 /* Initialize the world */
462 void cpu_initclocks(void);
463 void cpu_initclocks_bsp(void);
464 void cpu_initclocks_ap(void);
465 void usrinfoinit(void);
467 /* Finalize the world */
468 void kern_reboot(int) __dead2;
469 void shutdown_nice(int);
471 /* Stubs for obsolete functions that used to be for interrupt management */
472 static __inline intrmask_t splbio(void) { return 0; }
473 static __inline intrmask_t splcam(void) { return 0; }
474 static __inline intrmask_t splclock(void) { return 0; }
475 static __inline intrmask_t splhigh(void) { return 0; }
476 static __inline intrmask_t splimp(void) { return 0; }
477 static __inline intrmask_t splnet(void) { return 0; }
478 static __inline intrmask_t spltty(void) { return 0; }
479 static __inline void splx(intrmask_t ipl __unused) { return; }
482 * Common `proc' functions are declared here so that proc.h can be included
485 int _sleep(const void * _Nonnull chan, struct lock_object *lock, int pri,
486 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
487 #define msleep(chan, mtx, pri, wmesg, timo) \
488 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \
489 tick_sbt * (timo), 0, C_HARDCLOCK)
490 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \
491 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
493 int msleep_spin_sbt(const void * _Nonnull chan, struct mtx *mtx,
494 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
495 #define msleep_spin(chan, mtx, wmesg, timo) \
496 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \
498 int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
500 #define pause(wmesg, timo) \
501 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK)
502 #define pause_sig(wmesg, timo) \
503 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK | C_CATCH)
504 #define tsleep(chan, pri, wmesg, timo) \
505 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \
507 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \
508 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
509 void wakeup(const void *chan);
510 void wakeup_one(const void *chan);
511 void wakeup_any(const void *chan);
514 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
518 dev_t dev2udev(struct cdev *x);
519 const char *devtoname(struct cdev *cdev);
522 size_t devfs_iosize_max(void);
523 size_t iosize_max(void);
526 int poll_no_poll(int events);
528 /* XXX: Should be void nanodelay(u_int nsec); */
529 void DELAY(int usec);
531 /* Root mount holdback API */
532 struct root_hold_token {
535 TAILQ_ENTRY(root_hold_token) list;
538 struct root_hold_token *root_mount_hold(const char *identifier);
539 void root_mount_hold_token(const char *identifier, struct root_hold_token *h);
540 void root_mount_rel(struct root_hold_token *h);
541 int root_mounted(void);
545 * Unit number allocation API. (kern/subr_unit.c)
548 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
549 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
550 void delete_unrhdr(struct unrhdr *uh);
551 void clear_unrhdr(struct unrhdr *uh);
552 void clean_unrhdr(struct unrhdr *uh);
553 void clean_unrhdrl(struct unrhdr *uh);
554 int alloc_unr(struct unrhdr *uh);
555 int alloc_unr_specific(struct unrhdr *uh, u_int item);
556 int alloc_unrl(struct unrhdr *uh);
557 void free_unr(struct unrhdr *uh, u_int item);
568 new_unrhdr64(struct unrhdr64 *unr64, uint64_t low)
571 unr64->counter = low;
575 uint64_t alloc_unr64(struct unrhdr64 *);
577 static __inline uint64_t
578 alloc_unr64(struct unrhdr64 *unr64)
581 return (atomic_fetchadd_64(&unr64->counter, 1));
585 void intr_prof_stack_use(struct thread *td, struct trapframe *frame);
587 void counted_warning(unsigned *counter, const char *msg);
590 * APIs to manage deprecation and obsolescence.
593 void _gone_in(int major, const char *msg);
594 void _gone_in_dev(struct device *dev, int major, const char *msg);
595 #ifdef NO_OBSOLETE_CODE
596 #define __gone_ok(m, msg) \
597 _Static_assert(m < P_OSREL_MAJOR(__FreeBSD_version)), \
598 "Obsolete code: " msg);
600 #define __gone_ok(m, msg)
602 #define gone_in(major, msg) __gone_ok(major, msg) _gone_in(major, msg)
603 #define gone_in_dev(dev, major, msg) __gone_ok(major, msg) _gone_in_dev(dev, major, msg)
605 __NULLABILITY_PRAGMA_POP
607 #endif /* !_SYS_SYSTM_H_ */