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;
151 extern int iosize_max_clamp;
152 extern int devfs_iosize_max_clamp;
153 #define IOSIZE_MAX (iosize_max_clamp ? INT_MAX : SSIZE_MAX)
154 #define DEVFS_IOSIZE_MAX (devfs_iosize_max_clamp ? INT_MAX : SSIZE_MAX)
157 * General function declarations.
174 int setjmp(struct _jmp_buf *) __returns_twice;
175 void longjmp(struct _jmp_buf *, int) __dead2;
176 int dumpstatus(vm_offset_t addr, off_t count);
178 int eopnotsupp(void);
179 int ureadc(int, struct uio *);
180 void hashdestroy(void *, struct malloc_type *, u_long);
181 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
182 void *hashinit_flags(int count, struct malloc_type *type,
183 u_long *hashmask, int flags);
184 #define HASH_NOWAIT 0x00000001
185 #define HASH_WAITOK 0x00000002
187 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
188 void g_waitidle(void);
190 void panic(const char *, ...) __dead2 __printflike(1, 2);
191 void vpanic(const char *, __va_list) __dead2 __printflike(1, 0);
194 void cpu_flush_dcache(void *, size_t);
195 void cpu_rootconf(void);
196 void critical_enter(void);
197 void critical_exit(void);
198 void init_param1(void);
199 void init_param2(long physpages);
200 void init_static_kenv(char *, size_t);
201 void tablefull(const char *);
203 typedef void early_putc_t(int ch);
204 extern early_putc_t *early_putc;
206 int kvprintf(char const *, void (*)(int, void*), void *, int,
207 __va_list) __printflike(1, 0);
208 void log(int, const char *, ...) __printflike(2, 3);
209 void log_console(struct uio *);
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 ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
223 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
224 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
225 long strtol(const char *, char **, int) __nonnull(1);
226 u_long strtoul(const char *, char **, int) __nonnull(1);
227 quad_t strtoq(const char *, char **, int) __nonnull(1);
228 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
229 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
230 void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
231 void hexdump(const void *ptr, int length, const char *hdr, int flags);
232 #define HD_COLUMN_MASK 0xff
233 #define HD_DELIM_MASK 0xff00
234 #define HD_OMIT_COUNT (1 << 16)
235 #define HD_OMIT_HEX (1 << 17)
236 #define HD_OMIT_CHARS (1 << 18)
238 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
239 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
240 void bzero(void *buf, size_t len) __nonnull(1);
242 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
243 void *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
245 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
246 size_t len, size_t * __restrict lencopied)
247 __nonnull(1) __nonnull(2);
248 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
249 size_t len, size_t * __restrict lencopied)
250 __nonnull(1) __nonnull(2);
251 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
252 size_t len) __nonnull(1) __nonnull(2);
253 int copyin_nofault(const void * __restrict udaddr, void * __restrict kaddr,
254 size_t len) __nonnull(1) __nonnull(2);
255 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
256 size_t len) __nonnull(1) __nonnull(2);
257 int copyout_nofault(const void * __restrict kaddr, void * __restrict udaddr,
258 size_t len) __nonnull(1) __nonnull(2);
260 int fubyte(volatile const void *base);
261 long fuword(volatile const void *base);
262 int fuword16(volatile const void *base);
263 int32_t fuword32(volatile const void *base);
264 int64_t fuword64(volatile const void *base);
265 int fueword(volatile const void *base, long *val);
266 int fueword32(volatile const void *base, int32_t *val);
267 int fueword64(volatile const void *base, int64_t *val);
268 int subyte(volatile void *base, int byte);
269 int suword(volatile void *base, long word);
270 int suword16(volatile void *base, int word);
271 int suword32(volatile void *base, int32_t word);
272 int suword64(volatile void *base, int64_t word);
273 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
274 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
275 int casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp,
277 int casueword(volatile u_long *p, u_long oldval, u_long *oldvalp,
280 void realitexpire(void *);
282 int sysbeep(int hertz, int period);
284 void hardclock(int usermode, uintfptr_t pc);
285 void hardclock_cnt(int cnt, int usermode);
286 void hardclock_cpu(int usermode);
287 void hardclock_sync(int cpu);
288 void softclock(void *);
289 void statclock(int usermode);
290 void statclock_cnt(int cnt, int usermode);
291 void profclock(int usermode, uintfptr_t pc);
292 void profclock_cnt(int cnt, int usermode, uintfptr_t pc);
294 int hardclockintr(void);
296 void startprofclock(struct proc *);
297 void stopprofclock(struct proc *);
298 void cpu_startprofclock(void);
299 void cpu_stopprofclock(void);
300 sbintime_t cpu_idleclock(void);
301 void cpu_activeclock(void);
302 void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
303 void cpu_et_frequency(struct eventtimer *et, uint64_t newfreq);
304 extern int cpu_deepest_sleep;
305 extern int cpu_disable_c2_sleep;
306 extern int cpu_disable_c3_sleep;
308 int cr_cansee(struct ucred *u1, struct ucred *u2);
309 int cr_canseesocket(struct ucred *cred, struct socket *so);
310 int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
312 char *getenv(const char *name);
313 void freeenv(char *env);
314 int getenv_int(const char *name, int *data);
315 int getenv_uint(const char *name, unsigned int *data);
316 int getenv_long(const char *name, long *data);
317 int getenv_ulong(const char *name, unsigned long *data);
318 int getenv_string(const char *name, char *data, int size);
319 int getenv_quad(const char *name, quad_t *data);
320 int setenv(const char *name, const char *value);
321 int unsetenv(const char *name);
322 int testenv(const char *name);
324 typedef uint64_t (cpu_tick_f)(void);
325 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
326 extern cpu_tick_f *cpu_ticks;
327 uint64_t cpu_tickrate(void);
328 uint64_t cputick2usec(uint64_t tick);
330 #ifdef APM_FIXUP_CALLTODO
332 void adjust_timeout_calltodo(struct timeval *time_change);
333 #endif /* APM_FIXUP_CALLTODO */
335 #include <sys/libkern.h>
337 /* Initialize the world */
339 void cpu_initclocks(void);
340 void cpu_initclocks_bsp(void);
341 void cpu_initclocks_ap(void);
342 void usrinfoinit(void);
344 /* Finalize the world */
345 void kern_reboot(int) __dead2;
346 void shutdown_nice(int);
349 typedef void timeout_t(void *); /* timeout function type */
350 #define CALLOUT_HANDLE_INITIALIZER(handle) \
353 void callout_handle_init(struct callout_handle *);
354 struct callout_handle timeout(timeout_t *, void *, int);
355 void untimeout(timeout_t *, void *, struct callout_handle);
357 /* Stubs for obsolete functions that used to be for interrupt management */
358 static __inline intrmask_t splbio(void) { return 0; }
359 static __inline intrmask_t splcam(void) { return 0; }
360 static __inline intrmask_t splclock(void) { return 0; }
361 static __inline intrmask_t splhigh(void) { return 0; }
362 static __inline intrmask_t splimp(void) { return 0; }
363 static __inline intrmask_t splnet(void) { return 0; }
364 static __inline intrmask_t spltty(void) { return 0; }
365 static __inline intrmask_t splvm(void) { return 0; }
366 static __inline void splx(intrmask_t ipl __unused) { return; }
369 * Common `proc' functions are declared here so that proc.h can be included
372 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
373 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1);
374 #define msleep(chan, mtx, pri, wmesg, timo) \
375 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \
376 tick_sbt * (timo), 0, C_HARDCLOCK)
377 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \
378 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
380 int msleep_spin_sbt(void *chan, struct mtx *mtx, const char *wmesg,
381 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1);
382 #define msleep_spin(chan, mtx, wmesg, timo) \
383 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \
385 int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
387 #define pause(wmesg, timo) \
388 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK)
389 #define pause_sig(wmesg, timo) \
390 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK | C_CATCH)
391 #define tsleep(chan, pri, wmesg, timo) \
392 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \
394 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \
395 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
396 void wakeup(void *chan) __nonnull(1);
397 void wakeup_one(void *chan) __nonnull(1);
400 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
404 dev_t dev2udev(struct cdev *x);
405 const char *devtoname(struct cdev *cdev);
407 int poll_no_poll(int events);
409 /* XXX: Should be void nanodelay(u_int nsec); */
410 void DELAY(int usec);
412 /* Root mount holdback API */
413 struct root_hold_token;
415 struct root_hold_token *root_mount_hold(const char *identifier);
416 void root_mount_rel(struct root_hold_token *h);
417 void root_mount_wait(void);
418 int root_mounted(void);
422 * Unit number allocation API. (kern/subr_unit.c)
425 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
426 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
427 void delete_unrhdr(struct unrhdr *uh);
428 void clean_unrhdr(struct unrhdr *uh);
429 void clean_unrhdrl(struct unrhdr *uh);
430 int alloc_unr(struct unrhdr *uh);
431 int alloc_unr_specific(struct unrhdr *uh, u_int item);
432 int alloc_unrl(struct unrhdr *uh);
433 void free_unr(struct unrhdr *uh, u_int item);
435 void intr_prof_stack_use(struct thread *td, struct trapframe *frame);
437 extern void (*softdep_ast_cleanup)(void);
439 void counted_warning(unsigned *counter, const char *msg);
441 #endif /* !_SYS_SYSTM_H_ */