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
42 #include <sys/cdefs.h>
43 #include <machine/atomic.h>
44 #include <machine/cpufunc.h>
45 #include <sys/callout.h>
46 #include <sys/kassert.h>
47 #include <sys/queue.h>
48 #include <sys/stdint.h> /* for people using printf mainly */
50 __NULLABILITY_PRAGMA_PUSH
53 extern int cold; /* nonzero if we are doing a cold boot */
54 extern int suspend_blocked; /* block suspend due to pending shutdown */
55 extern int rebooting; /* kern_reboot() has been called. */
56 extern char version[]; /* system version */
57 extern char compiler_version[]; /* compiler version */
58 extern char copyright[]; /* system copyright */
59 extern int kstack_pages; /* number of kernel stack pages */
61 extern u_long pagesizes[]; /* supported page sizes */
62 extern long physmem; /* physical memory */
63 extern long realmem; /* 'real' memory */
65 extern char *rootdevnames[2]; /* names of possible root devices */
67 extern int boothowto; /* reboot flags, from console subsystem */
68 extern int bootverbose; /* nonzero to print verbose messages */
70 extern int maxusers; /* system tune hint */
71 extern int ngroups_max; /* max # of supplemental groups */
72 extern int vm_guest; /* Running as virtual machine guest? */
74 extern u_long maxphys; /* max raw I/O transfer size */
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 };
91 #define __read_mostly __section(".data.read_mostly")
92 #define __read_frequently __section(".data.read_frequently")
93 #define __exclusive_cache_line __aligned(CACHE_LINE_SIZE) \
94 __section(".data.exclusive_cache_line")
95 #if defined(_STANDALONE)
100 #include <sys/param.h> /* MAXCPU */
101 #include <sys/pcpu.h> /* curthread */
102 #include <sys/kpilite.h>
104 extern int osreldate;
106 extern const void *zero_region; /* address space maps to a zeroed page */
108 extern int unmapped_buf_allowed;
111 #define IOSIZE_MAX iosize_max()
112 #define DEVFS_IOSIZE_MAX devfs_iosize_max()
114 #define IOSIZE_MAX SSIZE_MAX
115 #define DEVFS_IOSIZE_MAX SSIZE_MAX
119 * General function declarations.
136 int setjmp(struct _jmp_buf *) __returns_twice;
137 void longjmp(struct _jmp_buf *, int) __dead2;
138 int dumpstatus(vm_offset_t addr, off_t count);
140 int eopnotsupp(void);
141 int ureadc(int, struct uio *);
142 void hashdestroy(void *, struct malloc_type *, u_long);
143 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
144 void *hashinit_flags(int count, struct malloc_type *type,
145 u_long *hashmask, int flags);
146 #define HASH_NOWAIT 0x00000001
147 #define HASH_WAITOK 0x00000002
149 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
150 void *phashinit_flags(int count, struct malloc_type *type, u_long *nentries,
152 void g_waitidle(void);
154 void cpu_flush_dcache(void *, size_t);
155 void cpu_rootconf(void);
156 void critical_enter_KBI(void);
157 void critical_exit_KBI(void);
158 void critical_exit_preempt(void);
159 void init_param1(void);
160 void init_param2(long physpages);
161 void init_static_kenv(char *, size_t);
162 void tablefull(const char *);
165 * Allocate per-thread "current" state in the linuxkpi
167 extern int (*lkpi_alloc_current)(struct thread *, int);
168 int linux_alloc_current_noop(struct thread *, int);
170 #if defined(KLD_MODULE) || defined(KTR_CRITICAL) || !defined(_KERNEL) || defined(GENOFFSET)
171 #define critical_enter() critical_enter_KBI()
172 #define critical_exit() critical_exit_KBI()
177 struct thread_lite *td;
179 td = (struct thread_lite *)curthread;
181 atomic_interrupt_fence();
187 struct thread_lite *td;
189 td = (struct thread_lite *)curthread;
190 KASSERT(td->td_critnest != 0,
191 ("critical_exit: td_critnest == 0"));
192 atomic_interrupt_fence();
194 atomic_interrupt_fence();
195 if (__predict_false(td->td_owepreempt))
196 critical_exit_preempt();
202 typedef void early_putc_t(int ch);
203 extern early_putc_t *early_putc;
205 int kvprintf(char const *, void (*)(int, void*), void *, int,
206 __va_list) __printflike(1, 0);
207 void log(int, const char *, ...) __printflike(2, 3);
208 void log_console(struct uio *);
209 void vlog(int, const char *, __va_list) __printflike(2, 0);
210 int asprintf(char **ret, struct malloc_type *mtp, const char *format,
211 ...) __printflike(3, 4);
212 int printf(const char *, ...) __printflike(1, 2);
213 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
214 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
215 int uprintf(const char *, ...) __printflike(1, 2);
216 int vprintf(const char *, __va_list) __printflike(1, 0);
217 int vasprintf(char **ret, struct malloc_type *mtp, const char *format,
218 __va_list ap) __printflike(3, 0);
219 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
220 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
221 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
222 int sscanf(const char *, char const * _Nonnull, ...) __scanflike(2, 3);
223 int vsscanf(const char * _Nonnull, char const * _Nonnull, __va_list) __scanflike(2, 0);
224 long strtol(const char *, char **, int);
225 u_long strtoul(const char *, char **, int);
226 quad_t strtoq(const char *, char **, int);
227 u_quad_t strtouq(const char *, char **, int);
228 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
229 void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
230 void hexdump(const void *ptr, int length, const char *hdr, int flags);
231 #define HD_COLUMN_MASK 0xff
232 #define HD_DELIM_MASK 0xff00
233 #define HD_OMIT_COUNT (1 << 16)
234 #define HD_OMIT_HEX (1 << 17)
235 #define HD_OMIT_CHARS (1 << 18)
237 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
238 void bcopy(const void * _Nonnull from, void * _Nonnull to, size_t len);
239 void bzero(void * _Nonnull buf, size_t len);
240 void explicit_bzero(void * _Nonnull, size_t);
241 int bcmp(const void *b1, const void *b2, size_t len);
243 void *memset(void * _Nonnull buf, int c, size_t len);
244 void *memcpy(void * _Nonnull to, const void * _Nonnull from, size_t len);
245 void *memmove(void * _Nonnull dest, const void * _Nonnull src, size_t n);
246 int memcmp(const void *b1, const void *b2, size_t len);
248 #ifdef SAN_NEEDS_INTERCEPTORS
249 #define SAN_INTERCEPTOR(func) \
250 __CONCAT(SAN_INTERCEPTOR_PREFIX, __CONCAT(_, func))
251 void *SAN_INTERCEPTOR(memset)(void *, int, size_t);
252 void *SAN_INTERCEPTOR(memcpy)(void *, const void *, size_t);
253 void *SAN_INTERCEPTOR(memmove)(void *, const void *, size_t);
254 int SAN_INTERCEPTOR(memcmp)(const void *, const void *, size_t);
256 #define bcopy(from, to, len) SAN_INTERCEPTOR(memmove)((to), (from), (len))
257 #define bzero(buf, len) SAN_INTERCEPTOR(memset)((buf), 0, (len))
258 #define bcmp(b1, b2, len) SAN_INTERCEPTOR(memcmp)((b1), (b2), (len))
259 #define memset(buf, c, len) SAN_INTERCEPTOR(memset)((buf), (c), (len))
260 #define memcpy(to, from, len) SAN_INTERCEPTOR(memcpy)((to), (from), (len))
261 #define memmove(dest, src, n) SAN_INTERCEPTOR(memmove)((dest), (src), (n))
262 #define memcmp(b1, b2, len) SAN_INTERCEPTOR(memcmp)((b1), (b2), (len))
263 #endif /* !SAN_RUNTIME */
264 #else /* !SAN_NEEDS_INTERCEPTORS */
265 #define bcopy(from, to, len) __builtin_memmove((to), (from), (len))
266 #define bzero(buf, len) __builtin_memset((buf), 0, (len))
267 #define bcmp(b1, b2, len) __builtin_memcmp((b1), (b2), (len))
268 #define memset(buf, c, len) __builtin_memset((buf), (c), (len))
269 #define memcpy(to, from, len) __builtin_memcpy((to), (from), (len))
270 #define memmove(dest, src, n) __builtin_memmove((dest), (src), (n))
271 #define memcmp(b1, b2, len) __builtin_memcmp((b1), (b2), (len))
272 #endif /* SAN_NEEDS_INTERCEPTORS */
274 void *memset_early(void * _Nonnull buf, int c, size_t len);
275 #define bzero_early(buf, len) memset_early((buf), 0, (len))
276 void *memcpy_early(void * _Nonnull to, const void * _Nonnull from, size_t len);
277 void *memmove_early(void * _Nonnull dest, const void * _Nonnull src, size_t n);
278 #define bcopy_early(from, to, len) memmove_early((to), (from), (len))
280 #define copystr(src, dst, len, outlen) ({ \
281 size_t __r, __len, *__outlen; \
284 __outlen = (outlen); \
285 __r = strlcpy((dst), (src), __len); \
286 if (__outlen != NULL) \
287 *__outlen = ((__r >= __len) ? __len : __r + 1); \
288 ((__r >= __len) ? ENAMETOOLONG : 0); \
291 int copyinstr(const void * __restrict udaddr,
292 void * _Nonnull __restrict kaddr, size_t len,
293 size_t * __restrict lencopied);
294 int copyin(const void * __restrict udaddr,
295 void * _Nonnull __restrict kaddr, size_t len);
296 int copyin_nofault(const void * __restrict udaddr,
297 void * _Nonnull __restrict kaddr, size_t len);
298 int copyout(const void * _Nonnull __restrict kaddr,
299 void * __restrict udaddr, size_t len);
300 int copyout_nofault(const void * _Nonnull __restrict kaddr,
301 void * __restrict udaddr, size_t len);
303 #ifdef SAN_NEEDS_INTERCEPTORS
304 int SAN_INTERCEPTOR(copyin)(const void *, void *, size_t);
305 int SAN_INTERCEPTOR(copyinstr)(const void *, void *, size_t, size_t *);
306 int SAN_INTERCEPTOR(copyout)(const void *, void *, size_t);
308 #define copyin(u, k, l) SAN_INTERCEPTOR(copyin)((u), (k), (l))
309 #define copyinstr(u, k, l, lc) SAN_INTERCEPTOR(copyinstr)((u), (k), (l), (lc))
310 #define copyout(k, u, l) SAN_INTERCEPTOR(copyout)((k), (u), (l))
311 #endif /* !SAN_RUNTIME */
312 #endif /* SAN_NEEDS_INTERCEPTORS */
314 int fubyte(volatile const void *base);
315 long fuword(volatile const void *base);
316 int fuword16(volatile const void *base);
317 int32_t fuword32(volatile const void *base);
318 int64_t fuword64(volatile const void *base);
319 int fueword(volatile const void *base, long *val);
320 int fueword32(volatile const void *base, int32_t *val);
321 int fueword64(volatile const void *base, int64_t *val);
322 int subyte(volatile void *base, int byte);
323 int suword(volatile void *base, long word);
324 int suword16(volatile void *base, int word);
325 int suword32(volatile void *base, int32_t word);
326 int suword64(volatile void *base, int64_t word);
327 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
328 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
329 int casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp,
331 int casueword(volatile u_long *p, u_long oldval, u_long *oldvalp,
334 int sysbeep(int hertz, sbintime_t duration);
336 void hardclock(int cnt, int usermode);
337 void hardclock_sync(int cpu);
338 void softclock(void *);
339 void statclock(int cnt, int usermode);
340 void profclock(int cnt, int usermode, uintfptr_t pc);
342 int hardclockintr(void);
344 void startprofclock(struct proc *);
345 void stopprofclock(struct proc *);
346 void cpu_startprofclock(void);
347 void cpu_stopprofclock(void);
348 void suspendclock(void);
349 void resumeclock(void);
350 sbintime_t cpu_idleclock(void);
351 void cpu_activeclock(void);
352 void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
353 void cpu_et_frequency(struct eventtimer *et, uint64_t newfreq);
354 extern int cpu_disable_c2_sleep;
355 extern int cpu_disable_c3_sleep;
357 char *kern_getenv(const char *name);
358 void freeenv(char *env);
359 int getenv_int(const char *name, int *data);
360 int getenv_uint(const char *name, unsigned int *data);
361 int getenv_long(const char *name, long *data);
362 int getenv_ulong(const char *name, unsigned long *data);
363 int getenv_string(const char *name, char *data, int size);
364 int getenv_int64(const char *name, int64_t *data);
365 int getenv_uint64(const char *name, uint64_t *data);
366 int getenv_quad(const char *name, quad_t *data);
367 int getenv_bool(const char *name, bool *data);
368 bool getenv_is_true(const char *name);
369 bool getenv_is_false(const char *name);
370 int kern_setenv(const char *name, const char *value);
371 int kern_unsetenv(const char *name);
372 int testenv(const char *name);
374 int getenv_array(const char *name, void *data, int size, int *psize,
375 int type_size, bool allow_signed);
376 #define GETENV_UNSIGNED false /* negative numbers not allowed */
377 #define GETENV_SIGNED true /* negative numbers allowed */
379 typedef uint64_t (cpu_tick_f)(void);
380 void set_cputicker(cpu_tick_f *func, uint64_t freq, bool isvariable);
381 extern cpu_tick_f *cpu_ticks;
382 uint64_t cpu_tickrate(void);
383 uint64_t cputick2usec(uint64_t tick);
385 #include <sys/libkern.h>
387 /* Initialize the world */
389 void cpu_initclocks(void);
390 void cpu_initclocks_bsp(void);
391 void cpu_initclocks_ap(void);
392 void usrinfoinit(void);
394 /* Finalize the world */
395 void kern_reboot(int) __dead2;
396 void shutdown_nice(int);
398 /* Stubs for obsolete functions that used to be for interrupt management */
399 static __inline intrmask_t splhigh(void) { return 0; }
400 static __inline intrmask_t splimp(void) { return 0; }
401 static __inline intrmask_t splnet(void) { return 0; }
402 static __inline intrmask_t spltty(void) { return 0; }
403 static __inline void splx(intrmask_t ipl __unused) { return; }
406 * Common `proc' functions are declared here so that proc.h can be included
409 int _sleep(const void * _Nonnull chan, struct lock_object *lock, int pri,
410 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
411 #define msleep(chan, mtx, pri, wmesg, timo) \
412 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \
413 tick_sbt * (timo), 0, C_HARDCLOCK)
414 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \
415 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
417 int msleep_spin_sbt(const void * _Nonnull chan, struct mtx *mtx,
418 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
419 #define msleep_spin(chan, mtx, wmesg, timo) \
420 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \
422 int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
425 pause(const char *wmesg, int timo)
427 return (pause_sbt(wmesg, tick_sbt * timo, 0, C_HARDCLOCK));
429 #define pause_sig(wmesg, timo) \
430 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK | C_CATCH)
431 #define tsleep(chan, pri, wmesg, timo) \
432 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \
434 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \
435 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
436 void wakeup(const void *chan);
437 void wakeup_one(const void *chan);
438 void wakeup_any(const void *chan);
441 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
445 dev_t dev2udev(struct cdev *x);
446 const char *devtoname(struct cdev *cdev);
449 size_t devfs_iosize_max(void);
450 size_t iosize_max(void);
453 int poll_no_poll(int events);
455 /* XXX: Should be void nanodelay(u_int nsec); */
456 void DELAY(int usec);
458 /* Root mount holdback API */
459 struct root_hold_token {
462 TAILQ_ENTRY(root_hold_token) list;
465 struct root_hold_token *root_mount_hold(const char *identifier);
466 void root_mount_hold_token(const char *identifier, struct root_hold_token *h);
467 void root_mount_rel(struct root_hold_token *h);
468 int root_mounted(void);
471 * Unit number allocation API. (kern/subr_unit.c)
474 #define UNR_NO_MTX ((void *)(uintptr_t)-1)
475 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
476 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
477 void delete_unrhdr(struct unrhdr *uh);
478 void clear_unrhdr(struct unrhdr *uh);
479 void clean_unrhdr(struct unrhdr *uh);
480 void clean_unrhdrl(struct unrhdr *uh);
481 int alloc_unr(struct unrhdr *uh);
482 int alloc_unr_specific(struct unrhdr *uh, u_int item);
483 int alloc_unrl(struct unrhdr *uh);
484 void free_unr(struct unrhdr *uh, u_int item);
485 void *create_iter_unr(struct unrhdr *uh);
486 int next_iter_unr(void *handle);
487 void free_iter_unr(void *handle);
498 new_unrhdr64(struct unrhdr64 *unr64, uint64_t low)
501 unr64->counter = low;
505 uint64_t alloc_unr64(struct unrhdr64 *);
507 static __inline uint64_t
508 alloc_unr64(struct unrhdr64 *unr64)
511 return (atomic_fetchadd_64(&unr64->counter, 1));
515 void intr_prof_stack_use(struct thread *td, struct trapframe *frame);
517 void counted_warning(unsigned *counter, const char *msg);
520 * APIs to manage deprecation and obsolescence.
522 void _gone_in(int major, const char *msg);
523 void _gone_in_dev(device_t dev, int major, const char *msg);
524 #ifdef NO_OBSOLETE_CODE
525 #define __gone_ok(m, msg) \
526 _Static_assert(m < P_OSREL_MAJOR(__FreeBSD_version)), \
527 "Obsolete code: " msg);
529 #define __gone_ok(m, msg)
531 #define gone_in(major, msg) __gone_ok(major, msg) _gone_in(major, msg)
532 #define gone_in_dev(dev, major, msg) __gone_ok(major, msg) _gone_in_dev(dev, major, msg)
534 #if defined(INVARIANTS) || defined(WITNESS)
537 #define __diagused __unused
542 __NULLABILITY_PRAGMA_POP
543 #endif /* !_SYS_SYSTM_H_ */