xref: /freebsd/sys/sys/systm.h (revision a68e3a8ae8401fe3ba6c0a85bbd3de87bd2e36f2)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
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.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
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.
23  *
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
34  * SUCH DAMAGE.
35  */
36 
37 #ifndef _SYS_SYSTM_H_
38 #define	_SYS_SYSTM_H_
39 
40 #include <sys/types.h>
41 #include <sys/callout.h>
42 #include <sys/kassert.h>
43 #include <sys/queue.h>
44 #include <sys/stdint.h>		/* for people using printf mainly */
45 #include <machine/atomic.h>
46 #include <machine/cpufunc.h>
47 
48 __NULLABILITY_PRAGMA_PUSH
49 
50 #ifdef _KERNEL
51 extern int cold;		/* nonzero if we are doing a cold boot */
52 extern int suspend_blocked;	/* block suspend due to pending shutdown */
53 extern int rebooting;		/* kern_reboot() has been called. */
54 extern const char version[];	/* system version */
55 extern const char compiler_version[];	/* compiler version */
56 extern const char copyright[];	/* system copyright */
57 extern int kstack_pages;	/* number of kernel stack pages */
58 
59 extern u_long pagesizes[];	/* supported page sizes */
60 extern long physmem;		/* physical memory */
61 extern long realmem;		/* 'real' memory */
62 
63 extern char *rootdevnames[2];	/* names of possible root devices */
64 
65 extern int boothowto;		/* reboot flags, from console subsystem */
66 extern int bootverbose;		/* nonzero to print verbose messages */
67 
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? */
71 
72 extern u_long maxphys;		/* max raw I/O transfer size */
73 
74 /*
75  * Detected virtual machine guest types. The intention is to expand
76  * and/or add to the VM_GUEST_VM type if specific VM functionality is
77  * ever implemented (e.g. vendor-specific paravirtualization features).
78  * Keep in sync with vm_guest_sysctl_names[].
79  */
80 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN, VM_GUEST_HV,
81 		VM_GUEST_VMWARE, VM_GUEST_KVM, VM_GUEST_BHYVE, VM_GUEST_VBOX,
82 		VM_GUEST_PARALLELS, VM_GUEST_NVMM, VM_GUEST_LAST };
83 
84 #endif /* KERNEL */
85 
86 /*
87  * Align variables.
88  */
89 #define	__read_mostly		__section(".data.read_mostly")
90 #define	__read_frequently	__section(".data.read_frequently")
91 #define	__exclusive_cache_line	__aligned(CACHE_LINE_SIZE) \
92 				    __section(".data.exclusive_cache_line")
93 #if defined(_STANDALONE)
94 struct ucred;
95 #endif
96 
97 #ifdef _KERNEL
98 #include <sys/param.h>		/* MAXCPU */
99 #include <sys/pcpu.h>		/* curthread */
100 #include <sys/kpilite.h>
101 
102 extern bool scheduler_stopped;
103 
104 /*
105  * If we have already panic'd and this is the thread that called
106  * panic(), then don't block on any mutexes but silently succeed.
107  * Otherwise, the kernel will deadlock since the scheduler isn't
108  * going to run the thread that holds any lock we need.
109  */
110 #define	SCHEDULER_STOPPED()	__predict_false(scheduler_stopped)
111 
112 extern const int osreldate;
113 
114 extern const void *zero_region;	/* address space maps to a zeroed page	*/
115 
116 extern int unmapped_buf_allowed;
117 
118 #ifdef __LP64__
119 #define	IOSIZE_MAX		iosize_max()
120 #define	DEVFS_IOSIZE_MAX	devfs_iosize_max()
121 #else
122 #define	IOSIZE_MAX		SSIZE_MAX
123 #define	DEVFS_IOSIZE_MAX	SSIZE_MAX
124 #endif
125 
126 /*
127  * General function declarations.
128  */
129 
130 struct lock_object;
131 struct malloc_type;
132 struct mtx;
133 struct proc;
134 struct thread;
135 struct tty;
136 struct ucred;
137 struct uio;
138 struct _jmp_buf;
139 struct trapframe;
140 struct eventtimer;
141 
142 int	setjmp(struct _jmp_buf *) __returns_twice;
143 void	longjmp(struct _jmp_buf *, int) __dead2;
144 int	dumpstatus(vm_offset_t addr, off_t count);
145 int	nullop(void);
146 int	eopnotsupp(void);
147 int	ureadc(int, struct uio *);
148 void	hashdestroy(void *, struct malloc_type *, u_long);
149 void	*hashinit(int count, struct malloc_type *type, u_long *hashmask);
150 void	*hashinit_flags(int count, struct malloc_type *type,
151     u_long *hashmask, int flags);
152 #define	HASH_NOWAIT	0x00000001
153 #define	HASH_WAITOK	0x00000002
154 
155 void	*phashinit(int count, struct malloc_type *type, u_long *nentries);
156 void	*phashinit_flags(int count, struct malloc_type *type, u_long *nentries,
157     int flags);
158 
159 void	cpu_flush_dcache(void *, size_t);
160 void	cpu_rootconf(void);
161 void	critical_enter_KBI(void);
162 void	critical_exit_KBI(void);
163 void	critical_exit_preempt(void);
164 void	init_param1(void);
165 void	init_param2(long physpages);
166 void	init_static_kenv(char *, size_t);
167 void	tablefull(const char *);
168 
169 /*
170  * Allocate per-thread "current" state in the linuxkpi
171  */
172 extern int (*lkpi_alloc_current)(struct thread *, int);
173 int linux_alloc_current_noop(struct thread *, int);
174 
175 #if (defined(KLD_MODULE) && !defined(KLD_TIED)) || defined(KTR_CRITICAL) || !defined(_KERNEL) || defined(GENOFFSET)
176 #define critical_enter() critical_enter_KBI()
177 #define critical_exit() critical_exit_KBI()
178 #else
179 static __inline void
critical_enter(void)180 critical_enter(void)
181 {
182 	struct thread_lite *td;
183 
184 	td = (struct thread_lite *)curthread;
185 	td->td_critnest++;
186 	atomic_interrupt_fence();
187 }
188 
189 static __inline void
critical_exit(void)190 critical_exit(void)
191 {
192 	struct thread_lite *td;
193 
194 	td = (struct thread_lite *)curthread;
195 	KASSERT(td->td_critnest != 0,
196 	    ("critical_exit: td_critnest == 0"));
197 	atomic_interrupt_fence();
198 	td->td_critnest--;
199 	atomic_interrupt_fence();
200 	if (__predict_false(td->td_owepreempt))
201 		critical_exit_preempt();
202 
203 }
204 #endif
205 
206 #ifdef  EARLY_PRINTF
207 typedef void early_putc_t(int ch);
208 extern early_putc_t *early_putc;
209 #define	CHECK_EARLY_PRINTF(x)	\
210     __CONCAT(early_printf_, EARLY_PRINTF) == __CONCAT(early_printf_, x)
211 #define	early_printf_1		1
212 #define	early_printf_mvebu	2
213 #define	early_printf_ns8250	3
214 #define	early_printf_pl011	4
215 #define	early_printf_snps	5
216 #define	early_printf_sbi	6
217 #else
218 #define	CHECK_EARLY_PRINTF(x)	0
219 #endif
220 int	kvprintf(char const *, void (*)(int, void*), void *, int,
221 	    __va_list) __printflike(1, 0);
222 void	log(int, const char *, ...) __printflike(2, 3);
223 void	log_console(struct uio *);
224 void	vlog(int, const char *, __va_list) __printflike(2, 0);
225 int	asprintf(char **ret, struct malloc_type *mtp, const char *format,
226 	    ...) __printflike(3, 4);
227 int	printf(const char *, ...) __printflike(1, 2);
228 int	snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
229 int	sprintf(char *buf, const char *, ...) __printflike(2, 3);
230 int	uprintf(const char *, ...) __printflike(1, 2);
231 int	vprintf(const char *, __va_list) __printflike(1, 0);
232 int	vasprintf(char **ret, struct malloc_type *mtp, const char *format,
233 	    __va_list ap) __printflike(3, 0);
234 int	vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
235 int	vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
236 int	vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
237 int	sscanf(const char *, char const * _Nonnull, ...) __scanflike(2, 3);
238 int	vsscanf(const char * _Nonnull, char const * _Nonnull, __va_list)  __scanflike(2, 0);
239 long	strtol(const char *, char **, int);
240 u_long	strtoul(const char *, char **, int);
241 quad_t	strtoq(const char *, char **, int);
242 u_quad_t strtouq(const char *, char **, int);
243 void	tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
244 void	vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
245 void	hexdump(const void *ptr, int length, const char *hdr, int flags);
246 #define	HD_COLUMN_MASK	0xff
247 #define	HD_DELIM_MASK	0xff00
248 #define	HD_OMIT_COUNT	(1 << 16)
249 #define	HD_OMIT_HEX	(1 << 17)
250 #define	HD_OMIT_CHARS	(1 << 18)
251 
252 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
253 void	explicit_bzero(void * _Nonnull, size_t);
254 
255 void	*memset(void * _Nonnull buf, int c, size_t len);
256 void	*memcpy(void * _Nonnull to, const void * _Nonnull from, size_t len);
257 void	*memmove(void * _Nonnull dest, const void * _Nonnull src, size_t n);
258 int	memcmp(const void *b1, const void *b2, size_t len);
259 
260 #ifdef SAN_NEEDS_INTERCEPTORS
261 #define	SAN_INTERCEPTOR(func)	\
262 	__CONCAT(SAN_INTERCEPTOR_PREFIX, __CONCAT(_, func))
263 void	*SAN_INTERCEPTOR(memset)(void *, int, size_t);
264 void	*SAN_INTERCEPTOR(memcpy)(void *, const void *, size_t);
265 void	*SAN_INTERCEPTOR(memmove)(void *, const void *, size_t);
266 int	SAN_INTERCEPTOR(memcmp)(const void *, const void *, size_t);
267 #ifndef SAN_RUNTIME
268 #define bcopy(from, to, len)	SAN_INTERCEPTOR(memmove)((to), (from), (len))
269 #define bzero(buf, len)		SAN_INTERCEPTOR(memset)((buf), 0, (len))
270 #define bcmp(b1, b2, len)	SAN_INTERCEPTOR(memcmp)((b1), (b2), (len))
271 #define memset(buf, c, len)	SAN_INTERCEPTOR(memset)((buf), (c), (len))
272 #define memcpy(to, from, len)	SAN_INTERCEPTOR(memcpy)((to), (from), (len))
273 #define memmove(dest, src, n)	SAN_INTERCEPTOR(memmove)((dest), (src), (n))
274 #define memcmp(b1, b2, len)	SAN_INTERCEPTOR(memcmp)((b1), (b2), (len))
275 #endif /* !SAN_RUNTIME */
276 #else /* !SAN_NEEDS_INTERCEPTORS */
277 #define bcopy(from, to, len)	__builtin_memmove((to), (from), (len))
278 #define bzero(buf, len)		__builtin_memset((buf), 0, (len))
279 #define bcmp(b1, b2, len)	__builtin_memcmp((b1), (b2), (len))
280 #define memset(buf, c, len)	__builtin_memset((buf), (c), (len))
281 #define memcpy(to, from, len)	__builtin_memcpy((to), (from), (len))
282 #define memmove(dest, src, n)	__builtin_memmove((dest), (src), (n))
283 #define memcmp(b1, b2, len)	__builtin_memcmp((b1), (b2), (len))
284 #endif /* SAN_NEEDS_INTERCEPTORS */
285 
286 void	*memset_early(void * _Nonnull buf, int c, size_t len);
287 #define bzero_early(buf, len) memset_early((buf), 0, (len))
288 void	*memcpy_early(void * _Nonnull to, const void * _Nonnull from, size_t len);
289 void	*memmove_early(void * _Nonnull dest, const void * _Nonnull src, size_t n);
290 #define bcopy_early(from, to, len) memmove_early((to), (from), (len))
291 
292 #define	copystr(src, dst, len, outlen)	({			\
293 	size_t __r, __len, *__outlen;				\
294 								\
295 	__len = (len);						\
296 	__outlen = (outlen);					\
297 	__r = strlcpy((dst), (src), __len);			\
298 	if (__outlen != NULL)					\
299 		*__outlen = ((__r >= __len) ? __len : __r + 1);	\
300 	((__r >= __len) ? ENAMETOOLONG : 0);			\
301 })
302 
303 int __result_use_check copyinstr(const void * __restrict udaddr,
304     void * _Nonnull __restrict kaddr, size_t len,
305     size_t * __restrict lencopied);
306 int __result_use_check copyin(const void * __restrict udaddr,
307     void * _Nonnull __restrict kaddr, size_t len);
308 int __result_use_check copyin_nofault(const void * __restrict udaddr,
309     void * _Nonnull __restrict kaddr, size_t len);
310 __nodiscard int copyout(const void * _Nonnull __restrict kaddr,
311     void * __restrict udaddr, size_t len);
312 __nodiscard int copyout_nofault(
313     const void * _Nonnull __restrict kaddr, void * __restrict udaddr,
314     size_t len);
315 
316 #ifdef SAN_NEEDS_INTERCEPTORS
317 int	SAN_INTERCEPTOR(copyin)(const void *, void *, size_t);
318 int	SAN_INTERCEPTOR(copyinstr)(const void *, void *, size_t, size_t *);
319 int	SAN_INTERCEPTOR(copyout)(const void *, void *, size_t);
320 #ifndef SAN_RUNTIME
321 #define	copyin(u, k, l)		SAN_INTERCEPTOR(copyin)((u), (k), (l))
322 #define	copyinstr(u, k, l, lc)	SAN_INTERCEPTOR(copyinstr)((u), (k), (l), (lc))
323 #define	copyout(k, u, l)	SAN_INTERCEPTOR(copyout)((k), (u), (l))
324 #endif /* !SAN_RUNTIME */
325 #endif /* SAN_NEEDS_INTERCEPTORS */
326 
327 int	fubyte(volatile const void *base);
328 long	fuword(volatile const void *base);
329 int	fuword16(volatile const void *base);
330 int32_t	fuword32(volatile const void *base);
331 int64_t	fuword64(volatile const void *base);
332 int __result_use_check fueword(volatile const void *base, long *val);
333 int __result_use_check fueword32(volatile const void *base, int32_t *val);
334 int __result_use_check fueword64(volatile const void *base, int64_t *val);
335 __nodiscard int subyte(volatile void *base, int byte);
336 __nodiscard int suword(volatile void *base, long word);
337 __nodiscard int suword16(volatile void *base, int word);
338 __nodiscard int suword32(volatile void *base, int32_t word);
339 __nodiscard int suword64(volatile void *base, int64_t word);
340 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
341 u_long	casuword(volatile u_long *p, u_long oldval, u_long newval);
342 int	casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp,
343 	    uint32_t newval);
344 int	casueword(volatile u_long *p, u_long oldval, u_long *oldvalp,
345 	    u_long newval);
346 
347 #if defined(SAN_NEEDS_INTERCEPTORS) && !defined(KCSAN)
348 int	SAN_INTERCEPTOR(fubyte)(volatile const void *base);
349 int	SAN_INTERCEPTOR(fuword16)(volatile const void *base);
350 int	SAN_INTERCEPTOR(fueword)(volatile const void *base, long *val);
351 int	SAN_INTERCEPTOR(fueword32)(volatile const void *base, int32_t *val);
352 int	SAN_INTERCEPTOR(fueword64)(volatile const void *base, int64_t *val);
353 int	SAN_INTERCEPTOR(subyte)(volatile void *base, int byte);
354 int	SAN_INTERCEPTOR(suword)(volatile void *base, long word);
355 int	SAN_INTERCEPTOR(suword16)(volatile void *base, int word);
356 int	SAN_INTERCEPTOR(suword32)(volatile void *base, int32_t word);
357 int	SAN_INTERCEPTOR(suword64)(volatile void *base, int64_t word);
358 int	SAN_INTERCEPTOR(casueword32)(volatile uint32_t *base, uint32_t oldval,
359 	    uint32_t *oldvalp, uint32_t newval);
360 int	SAN_INTERCEPTOR(casueword)(volatile u_long *p, u_long oldval,
361 	    u_long *oldvalp, u_long newval);
362 #ifndef SAN_RUNTIME
363 #define	fubyte(b)		SAN_INTERCEPTOR(fubyte)((b))
364 #define	fuword16(b)		SAN_INTERCEPTOR(fuword16)((b))
365 #define	fueword(b, v)		SAN_INTERCEPTOR(fueword)((b), (v))
366 #define	fueword32(b, v)		SAN_INTERCEPTOR(fueword32)((b), (v))
367 #define	fueword64(b, v)		SAN_INTERCEPTOR(fueword64)((b), (v))
368 #define	subyte(b, w)		SAN_INTERCEPTOR(subyte)((b), (w))
369 #define	suword(b, w)		SAN_INTERCEPTOR(suword)((b), (w))
370 #define	suword16(b, w)		SAN_INTERCEPTOR(suword16)((b), (w))
371 #define	suword32(b, w)		SAN_INTERCEPTOR(suword32)((b), (w))
372 #define	suword64(b, w)		SAN_INTERCEPTOR(suword64)((b), (w))
373 #define	casueword32(b, o, p, n)	SAN_INTERCEPTOR(casueword32)((b), (o), (p), (n))
374 #define	casueword(b, o, p, n)	SAN_INTERCEPTOR(casueword)((b), (o), (p), (n))
375 #endif /* !SAN_RUNTIME */
376 #endif /* SAN_NEEDS_INTERCEPTORS && !KCSAN */
377 
378 int	sysbeep(int hertz, sbintime_t duration);
379 
380 void	hardclock(int cnt, int usermode);
381 void	hardclock_sync(int cpu);
382 void	statclock(int cnt, int usermode);
383 void	profclock(int cnt, int usermode, uintfptr_t pc);
384 
385 int	hardclockintr(void);
386 
387 void	startprofclock(struct proc *);
388 void	stopprofclock(struct proc *);
389 void	cpu_startprofclock(void);
390 void	cpu_stopprofclock(void);
391 void	suspendclock(void);
392 void	resumeclock(void);
393 sbintime_t 	cpu_idleclock(void);
394 void	cpu_activeclock(void);
395 void	cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
396 void	cpu_et_frequency(struct eventtimer *et, uint64_t newfreq);
397 extern int	cpu_disable_c2_sleep;
398 extern int	cpu_disable_c3_sleep;
399 
400 char	*kern_getenv(const char *name);
401 void	freeenv(char *env);
402 int	getenv_int(const char *name, int *data);
403 int	getenv_uint(const char *name, unsigned int *data);
404 int	getenv_long(const char *name, long *data);
405 int	getenv_ulong(const char *name, unsigned long *data);
406 int	getenv_string(const char *name, char *data, int size);
407 int	getenv_int64(const char *name, int64_t *data);
408 int	getenv_uint64(const char *name, uint64_t *data);
409 int	getenv_quad(const char *name, quad_t *data);
410 int	getenv_bool(const char *name, bool *data);
411 bool	getenv_is_true(const char *name);
412 bool	getenv_is_false(const char *name);
413 int	kern_setenv(const char *name, const char *value);
414 int	kern_unsetenv(const char *name);
415 int	testenv(const char *name);
416 
417 int	getenv_array(const char *name, void *data, int size, int *psize,
418     int type_size, bool allow_signed);
419 #define	GETENV_UNSIGNED	false	/* negative numbers not allowed */
420 #define	GETENV_SIGNED	true	/* negative numbers allowed */
421 
422 typedef uint64_t (cpu_tick_f)(void);
423 void set_cputicker(cpu_tick_f *func, uint64_t freq, bool isvariable);
424 extern cpu_tick_f *cpu_ticks;
425 uint64_t cpu_tickrate(void);
426 uint64_t cputick2usec(uint64_t tick);
427 
428 #include <sys/libkern.h>
429 
430 /* Initialize the world */
431 void	consinit(void);
432 void	cpu_initclocks(void);
433 void	cpu_initclocks_bsp(void);
434 void	cpu_initclocks_ap(void);
435 void	usrinfoinit(void);
436 
437 /* Finalize the world */
438 void	kern_reboot(int) __dead2;
439 void	shutdown_nice(int);
440 
441 /* Stubs for obsolete functions that used to be for interrupt management */
splhigh(void)442 static __inline intrmask_t	splhigh(void)		{ return 0; }
splimp(void)443 static __inline intrmask_t	splimp(void)		{ return 0; }
splnet(void)444 static __inline intrmask_t	splnet(void)		{ return 0; }
spltty(void)445 static __inline intrmask_t	spltty(void)		{ return 0; }
splx(intrmask_t ipl __unused)446 static __inline void		splx(intrmask_t ipl __unused)	{ return; }
447 
448 /*
449  * Common `proc' functions are declared here so that proc.h can be included
450  * less often.
451  */
452 int	_sleep(const void * _Nonnull chan, struct lock_object *lock, int pri,
453 	   const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
454 #define	msleep(chan, mtx, pri, wmesg, timo)				\
455 	_sleep((chan), &(mtx)->lock_object, (pri), (wmesg),		\
456 	    tick_sbt * (timo), 0, C_HARDCLOCK)
457 #define	msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags)		\
458 	_sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr),	\
459 	    (flags))
460 int	msleep_spin_sbt(const void * _Nonnull chan, struct mtx *mtx,
461 	    const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
462 #define	msleep_spin(chan, mtx, wmesg, timo)				\
463 	msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo),	\
464 	    0, C_HARDCLOCK)
465 int	pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
466 	    int flags);
467 static __inline int
pause(const char * wmesg,int timo)468 pause(const char *wmesg, int timo)
469 {
470 	return (pause_sbt(wmesg, tick_sbt * timo, 0, C_HARDCLOCK));
471 }
472 #define	pause_sig(wmesg, timo)						\
473 	pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK | C_CATCH)
474 #define	tsleep(chan, pri, wmesg, timo)					\
475 	_sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo),		\
476 	    0, C_HARDCLOCK)
477 #define	tsleep_sbt(chan, pri, wmesg, bt, pr, flags)			\
478 	_sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
479 void	wakeup(const void *chan);
480 void	wakeup_one(const void *chan);
481 void	wakeup_any(const void *chan);
482 
483 /*
484  * Common `struct cdev *' stuff are declared here to avoid #include poisoning
485  */
486 
487 struct cdev;
488 dev_t dev2udev(struct cdev *x);
489 const char *devtoname(struct cdev *cdev);
490 
491 #ifdef __LP64__
492 size_t	devfs_iosize_max(void);
493 size_t	iosize_max(void);
494 #endif
495 
496 int poll_no_poll(int events);
497 
498 /* XXX: Should be void nanodelay(u_int nsec); */
499 void	DELAY(int usec);
500 
501 int kcmp_cmp(uintptr_t a, uintptr_t b);
502 
503 /* Root mount holdback API */
504 struct root_hold_token {
505 	int				flags;
506 	const char			*who;
507 	TAILQ_ENTRY(root_hold_token)	list;
508 };
509 
510 struct root_hold_token *root_mount_hold(const char *identifier);
511 void root_mount_hold_token(const char *identifier, struct root_hold_token *h);
512 void root_mount_rel(struct root_hold_token *h);
513 int root_mounted(void);
514 
515 /*
516  * Unit number allocation API. (kern/subr_unit.c)
517  */
518 struct unrhdr;
519 #define	UNR_NO_MTX	((void *)(uintptr_t)-1)
520 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
521 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
522 void delete_unrhdr(struct unrhdr *uh);
523 void clear_unrhdr(struct unrhdr *uh);
524 void clean_unrhdr(struct unrhdr *uh);
525 void clean_unrhdrl(struct unrhdr *uh);
526 int alloc_unr(struct unrhdr *uh);
527 int alloc_unr_specific(struct unrhdr *uh, u_int item);
528 int alloc_unrl(struct unrhdr *uh);
529 void free_unr(struct unrhdr *uh, u_int item);
530 void *create_iter_unr(struct unrhdr *uh);
531 int next_iter_unr(void *handle);
532 void free_iter_unr(void *handle);
533 
534 struct unrhdr64 {
535         uint64_t	counter;
536 };
537 
538 static __inline void
new_unrhdr64(struct unrhdr64 * unr64,uint64_t low)539 new_unrhdr64(struct unrhdr64 *unr64, uint64_t low)
540 {
541 
542 	unr64->counter = low;
543 }
544 
545 static __inline uint64_t
alloc_unr64(struct unrhdr64 * unr64)546 alloc_unr64(struct unrhdr64 *unr64)
547 {
548 
549 	return (atomic_fetchadd_64(&unr64->counter, 1));
550 }
551 
552 void	intr_prof_stack_use(struct thread *td, struct trapframe *frame);
553 
554 void counted_warning(unsigned *counter, const char *msg);
555 
556 /*
557  * APIs to manage deprecation and obsolescence.
558  */
559 void _gone_in(int major, const char *msg, ...) __printflike(2, 3);
560 void _gone_in_dev(device_t dev, int major, const char *msg, ...)
561     __printflike(3, 4);
562 #ifdef NO_OBSOLETE_CODE
563 #define __gone_ok(m, msg)					 \
564 	_Static_assert(m < P_OSREL_MAJOR(__FreeBSD_version)),	 \
565 	    "Obsolete code: " msg)
566 #else
567 #define	__gone_ok(m, msg)
568 #endif
569 #define gone_in(major, msg, ...)	do {				\
570 	static bool __read_mostly __gone_in_ ## __LINE__ = true;	\
571 	__gone_ok(major, msg);						\
572 	if (__predict_false(__gone_in_ ## __LINE__)) {			\
573 		__gone_in_ ## __LINE__ = false;				\
574 		_gone_in(major, msg __VA_OPT__(,) __VA_ARGS__);		\
575 	}								\
576 } while (0)
577 #define gone_in_dev(dev, major, msg, ...)	do {			\
578 	static bool __read_mostly __gone_in_ ## __LINE__ = true;	\
579 	__gone_ok(major, msg);						\
580 	if (__predict_false(__gone_in_ ## __LINE__)) {			\
581 		__gone_in_ ## __LINE__ = false;				\
582 		_gone_in_dev(dev, major, msg __VA_OPT__(,) __VA_ARGS__);\
583 	}								\
584 } while (0)
585 
586 #ifdef INVARIANTS
587 #define	__diagused
588 #else
589 #define	__diagused	__unused
590 #endif
591 
592 #ifdef WITNESS
593 #define	__witness_used
594 #else
595 #define	__witness_used	__unused
596 #endif
597 
598 #endif /* _KERNEL */
599 
600 __NULLABILITY_PRAGMA_POP
601 #endif /* !_SYS_SYSTM_H_ */
602