FreeBSD/Linux Kernel Cross Reference
sys/sys/systm.h
1 /*-
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.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
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.
21 *
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
32 * SUCH DAMAGE.
33 *
34 * @(#)systm.h 8.7 (Berkeley) 3/29/95
35 * $FreeBSD: releng/11.0/sys/sys/systm.h 303432 2016-07-28 11:43:25Z kib $
36 */
37
38 #ifndef _SYS_SYSTM_H_
39 #define _SYS_SYSTM_H_
40
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 */
47
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 */
56
57 extern u_long pagesizes[]; /* supported page sizes */
58 extern long physmem; /* physical memory */
59 extern long realmem; /* 'real' memory */
60
61 extern char *rootdevnames[2]; /* names of possible root devices */
62
63 extern int boothowto; /* reboot flags, from console subsystem */
64 extern int bootverbose; /* nonzero to print verbose messages */
65
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? */
69
70 /*
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[].
75 */
76 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN, VM_GUEST_HV,
77 VM_GUEST_VMWARE, VM_LAST };
78
79 #if defined(WITNESS) || defined(INVARIANT_SUPPORT)
80 void kassert_panic(const char *fmt, ...) __printflike(1, 2);
81 #endif
82
83 #ifdef INVARIANTS /* The option is always available */
84 #define KASSERT(exp,msg) do { \
85 if (__predict_false(!(exp))) \
86 kassert_panic msg; \
87 } while (0)
88 #define VNASSERT(exp, vp, msg) do { \
89 if (__predict_false(!(exp))) { \
90 vn_printf(vp, "VNASSERT failed\n"); \
91 kassert_panic msg; \
92 } \
93 } while (0)
94 #else
95 #define KASSERT(exp,msg) do { \
96 } while (0)
97
98 #define VNASSERT(exp, vp, msg) do { \
99 } while (0)
100 #endif
101
102 #ifndef CTASSERT /* Allow lint to override */
103 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed")
104 #endif
105
106 /*
107 * Assert that a pointer can be loaded from memory atomically.
108 *
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.
112 */
113 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \
114 KASSERT(sizeof(var) == sizeof(void *) && \
115 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
116
117 /*
118 * Assert that a thread is in critical(9) section.
119 */
120 #define CRITICAL_ASSERT(td) \
121 KASSERT((td)->td_critnest >= 1, ("Not in critical section"));
122
123 /*
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.
128 */
129 #define SCHEDULER_STOPPED() __predict_false(curthread->td_stopsched)
130
131 /*
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
134 * in two files.
135 * XXX most of these variables should be const.
136 */
137 extern int osreldate;
138 extern int envmode;
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 */
145
146 extern char **kenvp;
147
148 extern const void *zero_region; /* address space maps to a zeroed page */
149
150 extern int unmapped_buf_allowed;
151
152 #ifdef __LP64__
153 #define IOSIZE_MAX iosize_max()
154 #define DEVFS_IOSIZE_MAX devfs_iosize_max()
155 #else
156 #define IOSIZE_MAX SSIZE_MAX
157 #define DEVFS_IOSIZE_MAX SSIZE_MAX
158 #endif
159
160 /*
161 * General function declarations.
162 */
163
164 struct inpcb;
165 struct lock_object;
166 struct malloc_type;
167 struct mtx;
168 struct proc;
169 struct socket;
170 struct thread;
171 struct tty;
172 struct ucred;
173 struct uio;
174 struct _jmp_buf;
175 struct trapframe;
176 struct eventtimer;
177
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);
181 int nullop(void);
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
190
191 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
192 void *phashinit_flags(int count, struct malloc_type *type, u_long *nentries,
193 int flags);
194 void g_waitidle(void);
195
196 void panic(const char *, ...) __dead2 __printflike(1, 2);
197 void vpanic(const char *, __va_list) __dead2 __printflike(1, 0);
198
199 void cpu_boot(int);
200 void cpu_flush_dcache(void *, size_t);
201 void cpu_rootconf(void);
202 void critical_enter(void);
203 void critical_exit(void);
204 void init_param1(void);
205 void init_param2(long physpages);
206 void init_static_kenv(char *, size_t);
207 void tablefull(const char *);
208 #ifdef EARLY_PRINTF
209 typedef void early_putc_t(int ch);
210 extern early_putc_t *early_putc;
211 #endif
212 int kvprintf(char const *, void (*)(int, void*), void *, int,
213 __va_list) __printflike(1, 0);
214 void log(int, const char *, ...) __printflike(2, 3);
215 void log_console(struct uio *);
216 void vlog(int, const char *, __va_list) __printflike(2, 0);
217 int asprintf(char **ret, struct malloc_type *mtp, const char *format,
218 ...) __printflike(3, 4);
219 int printf(const char *, ...) __printflike(1, 2);
220 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
221 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
222 int uprintf(const char *, ...) __printflike(1, 2);
223 int vprintf(const char *, __va_list) __printflike(1, 0);
224 int vasprintf(char **ret, struct malloc_type *mtp, const char *format,
225 __va_list ap) __printflike(3, 0);
226 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
227 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
228 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
229 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
230 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
231 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
232 long strtol(const char *, char **, int) __nonnull(1);
233 u_long strtoul(const char *, char **, int) __nonnull(1);
234 quad_t strtoq(const char *, char **, int) __nonnull(1);
235 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
236 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
237 void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
238 void hexdump(const void *ptr, int length, const char *hdr, int flags);
239 #define HD_COLUMN_MASK 0xff
240 #define HD_DELIM_MASK 0xff00
241 #define HD_OMIT_COUNT (1 << 16)
242 #define HD_OMIT_HEX (1 << 17)
243 #define HD_OMIT_CHARS (1 << 18)
244
245 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
246 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
247 void bzero(void *buf, size_t len) __nonnull(1);
248 void explicit_bzero(void *, size_t) __nonnull(1);
249
250 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
251 void *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
252
253 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
254 size_t len, size_t * __restrict lencopied)
255 __nonnull(1) __nonnull(2);
256 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
257 size_t len, size_t * __restrict lencopied)
258 __nonnull(1) __nonnull(2);
259 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
260 size_t len) __nonnull(1) __nonnull(2);
261 int copyin_nofault(const void * __restrict udaddr, void * __restrict kaddr,
262 size_t len) __nonnull(1) __nonnull(2);
263 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
264 size_t len) __nonnull(1) __nonnull(2);
265 int copyout_nofault(const void * __restrict kaddr, void * __restrict udaddr,
266 size_t len) __nonnull(1) __nonnull(2);
267
268 int fubyte(volatile const void *base);
269 long fuword(volatile const void *base);
270 int fuword16(volatile const void *base);
271 int32_t fuword32(volatile const void *base);
272 int64_t fuword64(volatile const void *base);
273 int fueword(volatile const void *base, long *val);
274 int fueword32(volatile const void *base, int32_t *val);
275 int fueword64(volatile const void *base, int64_t *val);
276 int subyte(volatile void *base, int byte);
277 int suword(volatile void *base, long word);
278 int suword16(volatile void *base, int word);
279 int suword32(volatile void *base, int32_t word);
280 int suword64(volatile void *base, int64_t word);
281 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
282 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
283 int casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp,
284 uint32_t newval);
285 int casueword(volatile u_long *p, u_long oldval, u_long *oldvalp,
286 u_long newval);
287
288 void realitexpire(void *);
289
290 int sysbeep(int hertz, int period);
291
292 void hardclock(int usermode, uintfptr_t pc);
293 void hardclock_cnt(int cnt, int usermode);
294 void hardclock_cpu(int usermode);
295 void hardclock_sync(int cpu);
296 void softclock(void *);
297 void statclock(int usermode);
298 void statclock_cnt(int cnt, int usermode);
299 void profclock(int usermode, uintfptr_t pc);
300 void profclock_cnt(int cnt, int usermode, uintfptr_t pc);
301
302 int hardclockintr(void);
303
304 void startprofclock(struct proc *);
305 void stopprofclock(struct proc *);
306 void cpu_startprofclock(void);
307 void cpu_stopprofclock(void);
308 sbintime_t cpu_idleclock(void);
309 void cpu_activeclock(void);
310 void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
311 void cpu_et_frequency(struct eventtimer *et, uint64_t newfreq);
312 extern int cpu_deepest_sleep;
313 extern int cpu_disable_c2_sleep;
314 extern int cpu_disable_c3_sleep;
315
316 int cr_cansee(struct ucred *u1, struct ucred *u2);
317 int cr_canseesocket(struct ucred *cred, struct socket *so);
318 int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
319
320 char *kern_getenv(const char *name);
321 void freeenv(char *env);
322 int getenv_int(const char *name, int *data);
323 int getenv_uint(const char *name, unsigned int *data);
324 int getenv_long(const char *name, long *data);
325 int getenv_ulong(const char *name, unsigned long *data);
326 int getenv_string(const char *name, char *data, int size);
327 int getenv_int64(const char *name, int64_t *data);
328 int getenv_uint64(const char *name, uint64_t *data);
329 int getenv_quad(const char *name, quad_t *data);
330 int kern_setenv(const char *name, const char *value);
331 int kern_unsetenv(const char *name);
332 int testenv(const char *name);
333
334 typedef uint64_t (cpu_tick_f)(void);
335 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
336 extern cpu_tick_f *cpu_ticks;
337 uint64_t cpu_tickrate(void);
338 uint64_t cputick2usec(uint64_t tick);
339
340 #ifdef APM_FIXUP_CALLTODO
341 struct timeval;
342 void adjust_timeout_calltodo(struct timeval *time_change);
343 #endif /* APM_FIXUP_CALLTODO */
344
345 #include <sys/libkern.h>
346
347 /* Initialize the world */
348 void consinit(void);
349 void cpu_initclocks(void);
350 void cpu_initclocks_bsp(void);
351 void cpu_initclocks_ap(void);
352 void usrinfoinit(void);
353
354 /* Finalize the world */
355 void kern_reboot(int) __dead2;
356 void shutdown_nice(int);
357
358 /* Timeouts */
359 typedef void timeout_t(void *); /* timeout function type */
360 #define CALLOUT_HANDLE_INITIALIZER(handle) \
361 { NULL }
362
363 void callout_handle_init(struct callout_handle *);
364 struct callout_handle timeout(timeout_t *, void *, int);
365 void untimeout(timeout_t *, void *, struct callout_handle);
366
367 /* Stubs for obsolete functions that used to be for interrupt management */
368 static __inline intrmask_t splbio(void) { return 0; }
369 static __inline intrmask_t splcam(void) { return 0; }
370 static __inline intrmask_t splclock(void) { return 0; }
371 static __inline intrmask_t splhigh(void) { return 0; }
372 static __inline intrmask_t splimp(void) { return 0; }
373 static __inline intrmask_t splnet(void) { return 0; }
374 static __inline intrmask_t spltty(void) { return 0; }
375 static __inline void splx(intrmask_t ipl __unused) { return; }
376
377 /*
378 * Common `proc' functions are declared here so that proc.h can be included
379 * less often.
380 */
381 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
382 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1);
383 #define msleep(chan, mtx, pri, wmesg, timo) \
384 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \
385 tick_sbt * (timo), 0, C_HARDCLOCK)
386 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \
387 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
388 (flags))
389 int msleep_spin_sbt(void *chan, struct mtx *mtx, const char *wmesg,
390 sbintime_t sbt, sbintime_t pr, int flags) __nonnull(1);
391 #define msleep_spin(chan, mtx, wmesg, timo) \
392 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \
393 0, C_HARDCLOCK)
394 int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
395 int flags);
396 #define pause(wmesg, timo) \
397 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK)
398 #define tsleep(chan, pri, wmesg, timo) \
399 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \
400 0, C_HARDCLOCK)
401 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \
402 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
403 void wakeup(void *chan) __nonnull(1);
404 void wakeup_one(void *chan) __nonnull(1);
405
406 /*
407 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
408 */
409
410 struct cdev;
411 dev_t dev2udev(struct cdev *x);
412 const char *devtoname(struct cdev *cdev);
413
414 #ifdef __LP64__
415 size_t devfs_iosize_max(void);
416 size_t iosize_max(void);
417 #endif
418
419 int poll_no_poll(int events);
420
421 /* XXX: Should be void nanodelay(u_int nsec); */
422 void DELAY(int usec);
423
424 /* Root mount holdback API */
425 struct root_hold_token;
426
427 struct root_hold_token *root_mount_hold(const char *identifier);
428 void root_mount_rel(struct root_hold_token *h);
429 int root_mounted(void);
430
431
432 /*
433 * Unit number allocation API. (kern/subr_unit.c)
434 */
435 struct unrhdr;
436 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
437 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
438 void delete_unrhdr(struct unrhdr *uh);
439 void clean_unrhdr(struct unrhdr *uh);
440 void clean_unrhdrl(struct unrhdr *uh);
441 int alloc_unr(struct unrhdr *uh);
442 int alloc_unr_specific(struct unrhdr *uh, u_int item);
443 int alloc_unrl(struct unrhdr *uh);
444 void free_unr(struct unrhdr *uh, u_int item);
445
446 void intr_prof_stack_use(struct thread *td, struct trapframe *frame);
447
448 extern void (*softdep_ast_cleanup)(void);
449
450 void counted_warning(unsigned *counter, const char *msg);
451
452 #endif /* !_SYS_SYSTM_H_ */
Cache object: 64e48ed5e45481e8bbfede1a60fffe1a
|