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 extern int cold; /* nonzero if we are doing a cold boot */
49 extern int suspend_blocked; /* block suspend due to pending shutdown */
50 extern int rebooting; /* kern_reboot() has been called. */
51 extern const char *panicstr; /* panic message */
52 extern char version[]; /* system version */
53 extern char compiler_version[]; /* compiler version */
54 extern char copyright[]; /* system copyright */
55 extern int kstack_pages; /* number of kernel stack pages */
57 extern u_long pagesizes[]; /* supported page sizes */
58 extern long physmem; /* physical memory */
59 extern long realmem; /* 'real' memory */
61 extern char *rootdevnames[2]; /* names of possible root devices */
63 extern int boothowto; /* reboot flags, from console subsystem */
64 extern int bootverbose; /* nonzero to print verbose messages */
66 extern int maxusers; /* system tune hint */
67 extern int ngroups_max; /* max # of supplemental groups */
68 extern int vm_guest; /* Running as virtual machine guest? */
71 * Detected virtual machine guest types. The intention is to expand
72 * and/or add to the VM_GUEST_VM type if specific VM functionality is
73 * ever implemented (e.g. vendor-specific paravirtualization features).
74 * Keep in sync with vm_guest_sysctl_names[].
76 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN, VM_GUEST_HV,
77 VM_GUEST_VMWARE, VM_LAST };
79 #if defined(WITNESS) || defined(INVARIANTS)
80 void kassert_panic(const char *fmt, ...) __printflike(1, 2);
83 #ifdef INVARIANTS /* The option is always available */
84 #define KASSERT(exp,msg) do { \
85 if (__predict_false(!(exp))) \
88 #define VNASSERT(exp, vp, msg) do { \
89 if (__predict_false(!(exp))) { \
90 vn_printf(vp, "VNASSERT failed\n"); \
95 #define KASSERT(exp,msg) do { \
98 #define VNASSERT(exp, vp, msg) do { \
102 #ifndef CTASSERT /* Allow lint to override */
103 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed")
107 * Assert that a pointer can be loaded from memory atomically.
109 * This assertion enforces stronger alignment than necessary. For example,
110 * on some architectures, atomicity for unaligned loads will depend on
111 * whether or not the load spans multiple cache lines.
113 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \
114 KASSERT(sizeof(var) == sizeof(void *) && \
115 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
118 * Assert that a thread is in critical(9) section.
120 #define CRITICAL_ASSERT(td) \
121 KASSERT((td)->td_critnest >= 1, ("Not in critical section"));
124 * If we have already panic'd and this is the thread that called
125 * panic(), then don't block on any mutexes but silently succeed.
126 * Otherwise, the kernel will deadlock since the scheduler isn't
127 * going to run the thread that holds any lock we need.
129 #define SCHEDULER_STOPPED() __predict_false(curthread->td_stopsched)
132 * XXX the hints declarations are even more misplaced than most declarations
133 * in this file, since they are needed in one file (per arch) and only used
135 * XXX most of these variables should be const.
137 extern int osreldate;
139 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
140 extern int dynamic_kenv;
141 extern struct mtx kenv_lock;
142 extern char *kern_envp;
143 extern char static_env[];
144 extern char static_hints[]; /* by config for now */
148 extern const void *zero_region; /* address space maps to a zeroed page */
150 extern int unmapped_buf_allowed;
153 #define IOSIZE_MAX iosize_max()
154 #define DEVFS_IOSIZE_MAX devfs_iosize_max()
156 #define IOSIZE_MAX SSIZE_MAX
157 #define DEVFS_IOSIZE_MAX SSIZE_MAX
161 * General function declarations.
178 int setjmp(struct _jmp_buf *) __returns_twice;
179 void longjmp(struct _jmp_buf *, int) __dead2;
180 int dumpstatus(vm_offset_t addr, off_t count);
182 int eopnotsupp(void);
183 int ureadc(int, struct uio *);
184 void hashdestroy(void *, struct malloc_type *, u_long);
185 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
186 void *hashinit_flags(int count, struct malloc_type *type,
187 u_long *hashmask, int flags);
188 #define HASH_NOWAIT 0x00000001
189 #define HASH_WAITOK 0x00000002
191 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
192 void g_waitidle(void);
194 void panic(const char *, ...) __dead2 __printflike(1, 2);
195 void vpanic(const char *, __va_list) __dead2 __printflike(1, 0);
198 void cpu_flush_dcache(void *, size_t);
199 void cpu_rootconf(void);
200 void critical_enter(void);
201 void critical_exit(void);
202 void init_param1(void);
203 void init_param2(long physpages);
204 void init_static_kenv(char *, size_t);
205 void tablefull(const char *);
207 typedef void early_putc_t(int ch);
208 extern early_putc_t *early_putc;
210 int kvprintf(char const *, void (*)(int, void*), void *, int,
211 __va_list) __printflike(1, 0);
212 void log(int, const char *, ...) __printflike(2, 3);
213 void log_console(struct uio *);
214 void vlog(int, const char *, __va_list) __printflike(2, 0);
215 int asprintf(char **ret, struct malloc_type *mtp, const char *format,
216 ...) __printflike(3, 4);
217 int printf(const char *, ...) __printflike(1, 2);
218 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
219 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
220 int uprintf(const char *, ...) __printflike(1, 2);
221 int vprintf(const char *, __va_list) __printflike(1, 0);
222 int vasprintf(char **ret, struct malloc_type *mtp, const char *format,
223 __va_list ap) __printflike(3, 0);
224 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
225 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
226 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
227 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
228 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
229 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
230 long strtol(const char *, char **, int) __nonnull(1);
231 u_long strtoul(const char *, char **, int) __nonnull(1);
232 quad_t strtoq(const char *, char **, int) __nonnull(1);
233 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
234 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
235 void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
236 void hexdump(const void *ptr, int length, const char *hdr, int flags);
237 #define HD_COLUMN_MASK 0xff
238 #define HD_DELIM_MASK 0xff00
239 #define HD_OMIT_COUNT (1 << 16)
240 #define HD_OMIT_HEX (1 << 17)
241 #define HD_OMIT_CHARS (1 << 18)
243 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
244 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
245 void bzero(void *buf, size_t len) __nonnull(1);
246 void explicit_bzero(void *, size_t) __nonnull(1);
248 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
249 void *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
251 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
252 size_t len, size_t * __restrict lencopied)
253 __nonnull(1) __nonnull(2);
254 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
255 size_t len, size_t * __restrict lencopied)
256 __nonnull(1) __nonnull(2);
257 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
258 size_t len) __nonnull(1) __nonnull(2);
259 int copyin_nofault(const void * __restrict udaddr, void * __restrict kaddr,
260 size_t len) __nonnull(1) __nonnull(2);
261 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
262 size_t len) __nonnull(1) __nonnull(2);
263 int copyout_nofault(const void * __restrict kaddr, void * __restrict udaddr,
264 size_t len) __nonnull(1) __nonnull(2);
266 int fubyte(volatile const void *base);
267 long fuword(volatile const void *base);
268 int fuword16(volatile const void *base);
269 int32_t fuword32(volatile const void *base);
270 int64_t fuword64(volatile const void *base);
271 int fueword(volatile const void *base, long *val);
272 int fueword32(volatile const void *base, int32_t *val);
273 int fueword64(volatile const void *base, int64_t *val);
274 int subyte(volatile void *base, int byte);
275 int suword(volatile void *base, long word);
276 int suword16(volatile void *base, int word);
277 int suword32(volatile void *base, int32_t word);
278 int suword64(volatile void *base, int64_t word);
279 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
280 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
281 int casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp,
283 int casueword(volatile u_long *p, u_long oldval, u_long *oldvalp,
286 void realitexpire(void *);
288 int sysbeep(int hertz, int period);
290 void hardclock(int usermode, uintfptr_t pc);
291 void hardclock_cnt(int cnt, int usermode);
292 void hardclock_cpu(int usermode);
293 void hardclock_sync(int cpu);
294 void softclock(void *);
295 void statclock(int usermode);
296 void statclock_cnt(int cnt, int usermode);
297 void profclock(int usermode, uintfptr_t pc);
298 void profclock_cnt(int cnt, int usermode, uintfptr_t pc);
300 int hardclockintr(void);
302 void startprofclock(struct proc *);
303 void stopprofclock(struct proc *);
304 void cpu_startprofclock(void);
305 void cpu_stopprofclock(void);
306 sbintime_t cpu_idleclock(void);
307 void cpu_activeclock(void);
308 void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
309 void cpu_et_frequency(struct eventtimer *et, uint64_t newfreq);
310 extern int cpu_deepest_sleep;
311 extern int cpu_disable_c2_sleep;
312 extern int cpu_disable_c3_sleep;
314 int cr_cansee(struct ucred *u1, struct ucred *u2);
315 int cr_canseesocket(struct ucred *cred, struct socket *so);
316 int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
318 char *kern_getenv(const char *name);
319 void freeenv(char *env);
320 int getenv_int(const char *name, int *data);
321 int getenv_uint(const char *name, unsigned int *data);
322 int getenv_long(const char *name, long *data);
323 int getenv_ulong(const char *name, unsigned long *data);
324 int getenv_string(const char *name, char *data, int size);
325 int getenv_int64(const char *name, int64_t *data);
326 int getenv_uint64(const char *name, uint64_t *data);
327 int getenv_quad(const char *name, quad_t *data);
328 int kern_setenv(const char *name, const char *value);
329 int kern_unsetenv(const char *name);
330 int testenv(const char *name);
332 typedef uint64_t (cpu_tick_f)(void);
333 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
334 extern cpu_tick_f *cpu_ticks;
335 uint64_t cpu_tickrate(void);
336 uint64_t cputick2usec(uint64_t tick);
338 #ifdef APM_FIXUP_CALLTODO
340 void adjust_timeout_calltodo(struct timeval *time_change);
341 #endif /* APM_FIXUP_CALLTODO */
343 #include <sys/libkern.h>
345 /* Initialize the world */
347 void cpu_initclocks(void);
348 void cpu_initclocks_bsp(void);
349 void cpu_initclocks_ap(void);
350 void usrinfoinit(void);
352 /* Finalize the world */
353 void kern_reboot(int) __dead2;
354 void shutdown_nice(int);
357 typedef void timeout_t(void *); /* timeout function type */
358 #define CALLOUT_HANDLE_INITIALIZER(handle) \
361 void callout_handle_init(struct callout_handle *);
362 struct callout_handle timeout(timeout_t *, void *, int);
363 void untimeout(timeout_t *, void *, struct callout_handle);
365 /* Stubs for obsolete functions that used to be for interrupt management */
366 static __inline intrmask_t splbio(void) { return 0; }
367 static __inline intrmask_t splcam(void) { return 0; }
368 static __inline intrmask_t splclock(void) { return 0; }
369 static __inline intrmask_t splhigh(void) { return 0; }
370 static __inline intrmask_t splimp(void) { return 0; }
371 static __inline intrmask_t splnet(void) { return 0; }
372 static __inline intrmask_t spltty(void) { return 0; }
373 static __inline void splx(intrmask_t ipl __unused) { return; }
376 * Common `proc' functions are declared here so that proc.h can be included
379 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
380 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1);
381 #define msleep(chan, mtx, pri, wmesg, timo) \
382 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \
383 tick_sbt * (timo), 0, C_HARDCLOCK)
384 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \
385 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
387 int msleep_spin_sbt(void *chan, struct mtx *mtx, const char *wmesg,
388 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1);
389 #define msleep_spin(chan, mtx, wmesg, timo) \
390 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \
392 int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
394 #define pause(wmesg, timo) \
395 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK)
396 #define tsleep(chan, pri, wmesg, timo) \
397 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \
399 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \
400 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
401 void wakeup(void *chan) __nonnull(1);
402 void wakeup_one(void *chan) __nonnull(1);
405 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
409 dev_t dev2udev(struct cdev *x);
410 const char *devtoname(struct cdev *cdev);
413 size_t devfs_iosize_max(void);
414 size_t iosize_max(void);
417 int poll_no_poll(int events);
419 /* XXX: Should be void nanodelay(u_int nsec); */
420 void DELAY(int usec);
422 /* Root mount holdback API */
423 struct root_hold_token;
425 struct root_hold_token *root_mount_hold(const char *identifier);
426 void root_mount_rel(struct root_hold_token *h);
427 int root_mounted(void);
431 * Unit number allocation API. (kern/subr_unit.c)
434 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
435 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
436 void delete_unrhdr(struct unrhdr *uh);
437 void clean_unrhdr(struct unrhdr *uh);
438 void clean_unrhdrl(struct unrhdr *uh);
439 int alloc_unr(struct unrhdr *uh);
440 int alloc_unr_specific(struct unrhdr *uh, u_int item);
441 int alloc_unrl(struct unrhdr *uh);
442 void free_unr(struct unrhdr *uh, u_int item);
444 void intr_prof_stack_use(struct thread *td, struct trapframe *frame);
446 extern void (*softdep_ast_cleanup)(void);
448 #endif /* !_SYS_SYSTM_H_ */