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.1/sys/sys/systm.h 315386 2017-03-16 07:10:08Z mjg $
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 __NULLABILITY_PRAGMA_PUSH
49
50 extern int cold; /* nonzero if we are doing a cold boot */
51 extern int suspend_blocked; /* block suspend due to pending shutdown */
52 extern int rebooting; /* kern_reboot() has been called. */
53 extern const char *panicstr; /* panic message */
54 extern char version[]; /* system version */
55 extern char compiler_version[]; /* compiler version */
56 extern 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 /*
73 * Detected virtual machine guest types. The intention is to expand
74 * and/or add to the VM_GUEST_VM type if specific VM functionality is
75 * ever implemented (e.g. vendor-specific paravirtualization features).
76 * Keep in sync with vm_guest_sysctl_names[].
77 */
78 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN, VM_GUEST_HV,
79 VM_GUEST_VMWARE, VM_GUEST_KVM, VM_LAST };
80
81 #if defined(WITNESS) || defined(INVARIANT_SUPPORT)
82 void kassert_panic(const char *fmt, ...) __printflike(1, 2);
83 #endif
84
85 #ifdef INVARIANTS /* The option is always available */
86 #define KASSERT(exp,msg) do { \
87 if (__predict_false(!(exp))) \
88 kassert_panic msg; \
89 } while (0)
90 #define VNASSERT(exp, vp, msg) do { \
91 if (__predict_false(!(exp))) { \
92 vn_printf(vp, "VNASSERT failed\n"); \
93 kassert_panic msg; \
94 } \
95 } while (0)
96 #else
97 #define KASSERT(exp,msg) do { \
98 } while (0)
99
100 #define VNASSERT(exp, vp, msg) do { \
101 } while (0)
102 #endif
103
104 #ifndef CTASSERT /* Allow lint to override */
105 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed")
106 #endif
107
108 /*
109 * Assert that a pointer can be loaded from memory atomically.
110 *
111 * This assertion enforces stronger alignment than necessary. For example,
112 * on some architectures, atomicity for unaligned loads will depend on
113 * whether or not the load spans multiple cache lines.
114 */
115 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \
116 KASSERT(sizeof(var) == sizeof(void *) && \
117 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
118
119 /*
120 * Assert that a thread is in critical(9) section.
121 */
122 #define CRITICAL_ASSERT(td) \
123 KASSERT((td)->td_critnest >= 1, ("Not in critical section"));
124
125 /*
126 * If we have already panic'd and this is the thread that called
127 * panic(), then don't block on any mutexes but silently succeed.
128 * Otherwise, the kernel will deadlock since the scheduler isn't
129 * going to run the thread that holds any lock we need.
130 */
131 #define SCHEDULER_STOPPED_TD(td) ({ \
132 MPASS((td) == curthread); \
133 __predict_false((td)->td_stopsched); \
134 })
135 #define SCHEDULER_STOPPED() SCHEDULER_STOPPED_TD(curthread)
136
137 /*
138 * Align variables.
139 */
140 #define __read_mostly __section(".data.read_mostly")
141 #define __exclusive_cache_line __aligned(CACHE_LINE_SIZE) \
142 __section(".data.exclusive_cache_line")
143 /*
144 * XXX the hints declarations are even more misplaced than most declarations
145 * in this file, since they are needed in one file (per arch) and only used
146 * in two files.
147 * XXX most of these variables should be const.
148 */
149 extern int osreldate;
150 extern int envmode;
151 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
152 extern int dynamic_kenv;
153 extern struct mtx kenv_lock;
154 extern char *kern_envp;
155 extern char static_env[];
156 extern char static_hints[]; /* by config for now */
157
158 extern char **kenvp;
159
160 extern const void *zero_region; /* address space maps to a zeroed page */
161
162 extern int unmapped_buf_allowed;
163
164 #ifdef __LP64__
165 #define IOSIZE_MAX iosize_max()
166 #define DEVFS_IOSIZE_MAX devfs_iosize_max()
167 #else
168 #define IOSIZE_MAX SSIZE_MAX
169 #define DEVFS_IOSIZE_MAX SSIZE_MAX
170 #endif
171
172 /*
173 * General function declarations.
174 */
175
176 struct inpcb;
177 struct lock_object;
178 struct malloc_type;
179 struct mtx;
180 struct proc;
181 struct socket;
182 struct thread;
183 struct tty;
184 struct ucred;
185 struct uio;
186 struct _jmp_buf;
187 struct trapframe;
188 struct eventtimer;
189
190 int setjmp(struct _jmp_buf *) __returns_twice;
191 void longjmp(struct _jmp_buf *, int) __dead2;
192 int dumpstatus(vm_offset_t addr, off_t count);
193 int nullop(void);
194 int eopnotsupp(void);
195 int ureadc(int, struct uio *);
196 void hashdestroy(void *, struct malloc_type *, u_long);
197 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
198 void *hashinit_flags(int count, struct malloc_type *type,
199 u_long *hashmask, int flags);
200 #define HASH_NOWAIT 0x00000001
201 #define HASH_WAITOK 0x00000002
202
203 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
204 void *phashinit_flags(int count, struct malloc_type *type, u_long *nentries,
205 int flags);
206 void g_waitidle(void);
207
208 void panic(const char *, ...) __dead2 __printflike(1, 2);
209 void vpanic(const char *, __va_list) __dead2 __printflike(1, 0);
210
211 void cpu_boot(int);
212 void cpu_flush_dcache(void *, size_t);
213 void cpu_rootconf(void);
214 void critical_enter(void);
215 void critical_exit(void);
216 void init_param1(void);
217 void init_param2(long physpages);
218 void init_static_kenv(char *, size_t);
219 void tablefull(const char *);
220 #ifdef EARLY_PRINTF
221 typedef void early_putc_t(int ch);
222 extern early_putc_t *early_putc;
223 #endif
224 int kvprintf(char const *, void (*)(int, void*), void *, int,
225 __va_list) __printflike(1, 0);
226 void log(int, const char *, ...) __printflike(2, 3);
227 void log_console(struct uio *);
228 void vlog(int, const char *, __va_list) __printflike(2, 0);
229 int asprintf(char **ret, struct malloc_type *mtp, const char *format,
230 ...) __printflike(3, 4);
231 int printf(const char *, ...) __printflike(1, 2);
232 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
233 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
234 int uprintf(const char *, ...) __printflike(1, 2);
235 int vprintf(const char *, __va_list) __printflike(1, 0);
236 int vasprintf(char **ret, struct malloc_type *mtp, const char *format,
237 __va_list ap) __printflike(3, 0);
238 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
239 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
240 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
241 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
242 int sscanf(const char *, char const * _Nonnull, ...) __scanflike(2, 3);
243 int vsscanf(const char * _Nonnull, char const * _Nonnull, __va_list) __scanflike(2, 0);
244 long strtol(const char *, char **, int);
245 u_long strtoul(const char *, char **, int);
246 quad_t strtoq(const char *, char **, int);
247 u_quad_t strtouq(const char *, char **, int);
248 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
249 void vtprintf(struct proc *, int, const char *, __va_list) __printflike(3, 0);
250 void hexdump(const void *ptr, int length, const char *hdr, int flags);
251 #define HD_COLUMN_MASK 0xff
252 #define HD_DELIM_MASK 0xff00
253 #define HD_OMIT_COUNT (1 << 16)
254 #define HD_OMIT_HEX (1 << 17)
255 #define HD_OMIT_CHARS (1 << 18)
256
257 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
258 void bcopy(const void * _Nonnull from, void * _Nonnull to, size_t len);
259 void bzero(void * _Nonnull buf, size_t len);
260 void explicit_bzero(void * _Nonnull, size_t);
261
262 void *memcpy(void * _Nonnull to, const void * _Nonnull from, size_t len);
263 void *memmove(void * _Nonnull dest, const void * _Nonnull src, size_t n);
264
265 int copystr(const void * _Nonnull __restrict kfaddr,
266 void * _Nonnull __restrict kdaddr, size_t len,
267 size_t * __restrict lencopied);
268 int copyinstr(const void * __restrict udaddr,
269 void * _Nonnull __restrict kaddr, size_t len,
270 size_t * __restrict lencopied);
271 int copyin(const void * _Nonnull __restrict udaddr,
272 void * _Nonnull __restrict kaddr, size_t len);
273 int copyin_nofault(const void * _Nonnull __restrict udaddr,
274 void * _Nonnull __restrict kaddr, size_t len);
275 int copyout(const void * _Nonnull __restrict kaddr,
276 void * _Nonnull __restrict udaddr, size_t len);
277 int copyout_nofault(const void * _Nonnull __restrict kaddr,
278 void * _Nonnull __restrict udaddr, size_t len);
279
280 int fubyte(volatile const void *base);
281 long fuword(volatile const void *base);
282 int fuword16(volatile const void *base);
283 int32_t fuword32(volatile const void *base);
284 int64_t fuword64(volatile const void *base);
285 int fueword(volatile const void *base, long *val);
286 int fueword32(volatile const void *base, int32_t *val);
287 int fueword64(volatile const void *base, int64_t *val);
288 int subyte(volatile void *base, int byte);
289 int suword(volatile void *base, long word);
290 int suword16(volatile void *base, int word);
291 int suword32(volatile void *base, int32_t word);
292 int suword64(volatile void *base, int64_t word);
293 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
294 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
295 int casueword32(volatile uint32_t *base, uint32_t oldval, uint32_t *oldvalp,
296 uint32_t newval);
297 int casueword(volatile u_long *p, u_long oldval, u_long *oldvalp,
298 u_long newval);
299
300 void realitexpire(void *);
301
302 int sysbeep(int hertz, int period);
303
304 void hardclock(int usermode, uintfptr_t pc);
305 void hardclock_cnt(int cnt, int usermode);
306 void hardclock_cpu(int usermode);
307 void hardclock_sync(int cpu);
308 void softclock(void *);
309 void statclock(int usermode);
310 void statclock_cnt(int cnt, int usermode);
311 void profclock(int usermode, uintfptr_t pc);
312 void profclock_cnt(int cnt, int usermode, uintfptr_t pc);
313
314 int hardclockintr(void);
315
316 void startprofclock(struct proc *);
317 void stopprofclock(struct proc *);
318 void cpu_startprofclock(void);
319 void cpu_stopprofclock(void);
320 sbintime_t cpu_idleclock(void);
321 void cpu_activeclock(void);
322 void cpu_new_callout(int cpu, sbintime_t bt, sbintime_t bt_opt);
323 void cpu_et_frequency(struct eventtimer *et, uint64_t newfreq);
324 extern int cpu_disable_c2_sleep;
325 extern int cpu_disable_c3_sleep;
326
327 int cr_cansee(struct ucred *u1, struct ucred *u2);
328 int cr_canseesocket(struct ucred *cred, struct socket *so);
329 int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
330
331 char *kern_getenv(const char *name);
332 void freeenv(char *env);
333 int getenv_int(const char *name, int *data);
334 int getenv_uint(const char *name, unsigned int *data);
335 int getenv_long(const char *name, long *data);
336 int getenv_ulong(const char *name, unsigned long *data);
337 int getenv_string(const char *name, char *data, int size);
338 int getenv_int64(const char *name, int64_t *data);
339 int getenv_uint64(const char *name, uint64_t *data);
340 int getenv_quad(const char *name, quad_t *data);
341 int kern_setenv(const char *name, const char *value);
342 int kern_unsetenv(const char *name);
343 int testenv(const char *name);
344
345 typedef uint64_t (cpu_tick_f)(void);
346 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
347 extern cpu_tick_f *cpu_ticks;
348 uint64_t cpu_tickrate(void);
349 uint64_t cputick2usec(uint64_t tick);
350
351 #ifdef APM_FIXUP_CALLTODO
352 struct timeval;
353 void adjust_timeout_calltodo(struct timeval *time_change);
354 #endif /* APM_FIXUP_CALLTODO */
355
356 #include <sys/libkern.h>
357
358 /* Initialize the world */
359 void consinit(void);
360 void cpu_initclocks(void);
361 void cpu_initclocks_bsp(void);
362 void cpu_initclocks_ap(void);
363 void usrinfoinit(void);
364
365 /* Finalize the world */
366 void kern_reboot(int) __dead2;
367 void shutdown_nice(int);
368
369 /* Timeouts */
370 typedef void timeout_t(void *); /* timeout function type */
371 #define CALLOUT_HANDLE_INITIALIZER(handle) \
372 { NULL }
373
374 void callout_handle_init(struct callout_handle *);
375 struct callout_handle timeout(timeout_t *, void *, int);
376 void untimeout(timeout_t *, void *, struct callout_handle);
377
378 /* Stubs for obsolete functions that used to be for interrupt management */
379 static __inline intrmask_t splbio(void) { return 0; }
380 static __inline intrmask_t splcam(void) { return 0; }
381 static __inline intrmask_t splclock(void) { return 0; }
382 static __inline intrmask_t splhigh(void) { return 0; }
383 static __inline intrmask_t splimp(void) { return 0; }
384 static __inline intrmask_t splnet(void) { return 0; }
385 static __inline intrmask_t spltty(void) { return 0; }
386 static __inline void splx(intrmask_t ipl __unused) { return; }
387
388 /*
389 * Common `proc' functions are declared here so that proc.h can be included
390 * less often.
391 */
392 int _sleep(void * _Nonnull chan, struct lock_object *lock, int pri,
393 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
394 #define msleep(chan, mtx, pri, wmesg, timo) \
395 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), \
396 tick_sbt * (timo), 0, C_HARDCLOCK)
397 #define msleep_sbt(chan, mtx, pri, wmesg, bt, pr, flags) \
398 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (bt), (pr), \
399 (flags))
400 int msleep_spin_sbt(void * _Nonnull chan, struct mtx *mtx,
401 const char *wmesg, sbintime_t sbt, sbintime_t pr, int flags);
402 #define msleep_spin(chan, mtx, wmesg, timo) \
403 msleep_spin_sbt((chan), (mtx), (wmesg), tick_sbt * (timo), \
404 0, C_HARDCLOCK)
405 int pause_sbt(const char *wmesg, sbintime_t sbt, sbintime_t pr,
406 int flags);
407 #define pause(wmesg, timo) \
408 pause_sbt((wmesg), tick_sbt * (timo), 0, C_HARDCLOCK)
409 #define tsleep(chan, pri, wmesg, timo) \
410 _sleep((chan), NULL, (pri), (wmesg), tick_sbt * (timo), \
411 0, C_HARDCLOCK)
412 #define tsleep_sbt(chan, pri, wmesg, bt, pr, flags) \
413 _sleep((chan), NULL, (pri), (wmesg), (bt), (pr), (flags))
414 void wakeup(void * chan);
415 void wakeup_one(void * chan);
416
417 /*
418 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
419 */
420
421 struct cdev;
422 dev_t dev2udev(struct cdev *x);
423 const char *devtoname(struct cdev *cdev);
424
425 #ifdef __LP64__
426 size_t devfs_iosize_max(void);
427 size_t iosize_max(void);
428 #endif
429
430 int poll_no_poll(int events);
431
432 /* XXX: Should be void nanodelay(u_int nsec); */
433 void DELAY(int usec);
434
435 /* Root mount holdback API */
436 struct root_hold_token;
437
438 struct root_hold_token *root_mount_hold(const char *identifier);
439 void root_mount_rel(struct root_hold_token *h);
440 int root_mounted(void);
441
442
443 /*
444 * Unit number allocation API. (kern/subr_unit.c)
445 */
446 struct unrhdr;
447 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
448 void init_unrhdr(struct unrhdr *uh, int low, int high, struct mtx *mutex);
449 void delete_unrhdr(struct unrhdr *uh);
450 void clean_unrhdr(struct unrhdr *uh);
451 void clean_unrhdrl(struct unrhdr *uh);
452 int alloc_unr(struct unrhdr *uh);
453 int alloc_unr_specific(struct unrhdr *uh, u_int item);
454 int alloc_unrl(struct unrhdr *uh);
455 void free_unr(struct unrhdr *uh, u_int item);
456
457 void intr_prof_stack_use(struct thread *td, struct trapframe *frame);
458
459 void counted_warning(unsigned *counter, const char *msg);
460
461 __NULLABILITY_PRAGMA_POP
462
463 #endif /* !_SYS_SYSTM_H_ */
Cache object: 55132120af7b6381de075831fc50a67c
|