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: stable/9/sys/sys/systm.h 281538 2015-04-14 20:05:26Z jhb $
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 rebooting; /* kern_reboot() has been called. */
50 extern const char *panicstr; /* panic message */
51 extern char version[]; /* system version */
52 extern char compiler_version[]; /* compiler version */
53 extern char copyright[]; /* system copyright */
54 extern int kstack_pages; /* number of kernel stack pages */
55
56 extern u_long pagesizes[]; /* supported page sizes */
57 extern long physmem; /* physical memory */
58 extern long realmem; /* 'real' memory */
59
60 extern char *rootdevnames[2]; /* names of possible root devices */
61
62 extern int boothowto; /* reboot flags, from console subsystem */
63 extern int bootverbose; /* nonzero to print verbose messages */
64
65 extern int maxusers; /* system tune hint */
66 extern int ngroups_max; /* max # of supplemental groups */
67 extern int vm_guest; /* Running as virtual machine guest? */
68
69 /*
70 * Detected virtual machine guest types. The intention is to expand
71 * and/or add to the VM_GUEST_VM type if specific VM functionality is
72 * ever implemented (e.g. vendor-specific paravirtualization features).
73 */
74 enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN };
75
76 #ifdef INVARIANTS /* The option is always available */
77 #define KASSERT(exp,msg) do { \
78 if (__predict_false(!(exp))) \
79 panic msg; \
80 } while (0)
81 #define VNASSERT(exp, vp, msg) do { \
82 if (__predict_false(!(exp))) { \
83 vn_printf(vp, "VNASSERT failed\n"); \
84 panic msg; \
85 } \
86 } while (0)
87 #else
88 #define KASSERT(exp,msg) do { \
89 } while (0)
90
91 #define VNASSERT(exp, vp, msg) do { \
92 } while (0)
93 #endif
94
95 #ifndef CTASSERT /* Allow lint to override */
96 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed")
97 #endif
98
99 /*
100 * Assert that a pointer can be loaded from memory atomically.
101 *
102 * This assertion enforces stronger alignment than necessary. For example,
103 * on some architectures, atomicity for unaligned loads will depend on
104 * whether or not the load spans multiple cache lines.
105 */
106 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \
107 KASSERT(sizeof(var) == sizeof(void *) && \
108 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
109
110 /*
111 * If we have already panic'd and this is the thread that called
112 * panic(), then don't block on any mutexes but silently succeed.
113 * Otherwise, the kernel will deadlock since the scheduler isn't
114 * going to run the thread that holds any lock we need.
115 */
116 #define SCHEDULER_STOPPED() __predict_false(curthread->td_stopsched)
117
118 /*
119 * XXX the hints declarations are even more misplaced than most declarations
120 * in this file, since they are needed in one file (per arch) and only used
121 * in two files.
122 * XXX most of these variables should be const.
123 */
124 extern int osreldate;
125 extern int envmode;
126 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
127 extern int dynamic_kenv;
128 extern struct mtx kenv_lock;
129 extern char *kern_envp;
130 extern char static_env[];
131 extern char static_hints[]; /* by config for now */
132
133 extern char **kenvp;
134
135 extern const void *zero_region; /* address space maps to a zeroed page */
136
137 extern int unmapped_buf_allowed;
138 extern int iosize_max_clamp;
139 extern int devfs_iosize_max_clamp;
140 #define IOSIZE_MAX (iosize_max_clamp ? INT_MAX : SSIZE_MAX)
141 #define DEVFS_IOSIZE_MAX (devfs_iosize_max_clamp ? INT_MAX : SSIZE_MAX)
142
143 /*
144 * General function declarations.
145 */
146
147 struct inpcb;
148 struct lock_object;
149 struct malloc_type;
150 struct mtx;
151 struct proc;
152 struct socket;
153 struct thread;
154 struct tty;
155 struct ucred;
156 struct uio;
157 struct _jmp_buf;
158 struct trapframe;
159
160 int setjmp(struct _jmp_buf *) __returns_twice;
161 void longjmp(struct _jmp_buf *, int) __dead2;
162 int dumpstatus(vm_offset_t addr, off_t count);
163 int nullop(void);
164 int eopnotsupp(void);
165 int ureadc(int, struct uio *);
166 void hashdestroy(void *, struct malloc_type *, u_long);
167 void *hashinit(int count, struct malloc_type *type, u_long *hashmask);
168 void *hashinit_flags(int count, struct malloc_type *type,
169 u_long *hashmask, int flags);
170 #define HASH_NOWAIT 0x00000001
171 #define HASH_WAITOK 0x00000002
172
173 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
174 void g_waitidle(void);
175
176 void panic(const char *, ...) __dead2 __printflike(1, 2);
177
178 void cpu_boot(int);
179 void cpu_flush_dcache(void *, size_t);
180 void cpu_rootconf(void);
181 void critical_enter(void);
182 void critical_exit(void);
183 void init_param1(void);
184 void init_param2(long physpages);
185 void init_static_kenv(char *, size_t);
186 void tablefull(const char *);
187 int kvprintf(char const *, void (*)(int, void*), void *, int,
188 __va_list) __printflike(1, 0);
189 void log(int, const char *, ...) __printflike(2, 3);
190 void log_console(struct uio *);
191 int printf(const char *, ...) __printflike(1, 2);
192 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
193 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
194 int uprintf(const char *, ...) __printflike(1, 2);
195 int vprintf(const char *, __va_list) __printflike(1, 0);
196 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
197 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
198 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
199 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
200 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
201 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
202 long strtol(const char *, char **, int) __nonnull(1);
203 u_long strtoul(const char *, char **, int) __nonnull(1);
204 quad_t strtoq(const char *, char **, int) __nonnull(1);
205 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
206 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
207 void hexdump(const void *ptr, int length, const char *hdr, int flags);
208 #define HD_COLUMN_MASK 0xff
209 #define HD_DELIM_MASK 0xff00
210 #define HD_OMIT_COUNT (1 << 16)
211 #define HD_OMIT_HEX (1 << 17)
212 #define HD_OMIT_CHARS (1 << 18)
213
214 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
215 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
216 void bzero(void *buf, size_t len) __nonnull(1);
217
218 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
219 void *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
220
221 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
222 size_t len, size_t * __restrict lencopied)
223 __nonnull(1) __nonnull(2);
224 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
225 size_t len, size_t * __restrict lencopied)
226 __nonnull(1) __nonnull(2);
227 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
228 size_t len) __nonnull(1) __nonnull(2);
229 int copyin_nofault(const void * __restrict udaddr, void * __restrict kaddr,
230 size_t len) __nonnull(1) __nonnull(2);
231 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
232 size_t len) __nonnull(1) __nonnull(2);
233 int copyout_nofault(const void * __restrict kaddr, void * __restrict udaddr,
234 size_t len) __nonnull(1) __nonnull(2);
235
236 int fubyte(const void *base);
237 long fuword(const void *base);
238 int fuword16(void *base);
239 int32_t fuword32(const void *base);
240 int64_t fuword64(const void *base);
241 int subyte(void *base, int byte);
242 int suword(void *base, long word);
243 int suword16(void *base, int word);
244 int suword32(void *base, int32_t word);
245 int suword64(void *base, int64_t word);
246 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
247 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
248
249 void realitexpire(void *);
250
251 int sysbeep(int hertz, int period);
252
253 void hardclock(int usermode, uintfptr_t pc);
254 void hardclock_cnt(int cnt, int usermode);
255 void hardclock_cpu(int usermode);
256 void hardclock_sync(int cpu);
257 void softclock(void *);
258 void statclock(int usermode);
259 void statclock_cnt(int cnt, int usermode);
260 void profclock(int usermode, uintfptr_t pc);
261 void profclock_cnt(int cnt, int usermode, uintfptr_t pc);
262
263 int hardclockintr(void);
264
265 void startprofclock(struct proc *);
266 void stopprofclock(struct proc *);
267 void cpu_startprofclock(void);
268 void cpu_stopprofclock(void);
269 void cpu_idleclock(void);
270 void cpu_activeclock(void);
271 extern int cpu_deepest_sleep;
272 extern int cpu_disable_c2_sleep;
273 extern int cpu_disable_c3_sleep;
274
275 int cr_cansee(struct ucred *u1, struct ucred *u2);
276 int cr_canseesocket(struct ucred *cred, struct socket *so);
277 int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
278
279 char *getenv(const char *name);
280 void freeenv(char *env);
281 int getenv_int(const char *name, int *data);
282 int getenv_uint(const char *name, unsigned int *data);
283 int getenv_long(const char *name, long *data);
284 int getenv_ulong(const char *name, unsigned long *data);
285 int getenv_string(const char *name, char *data, int size);
286 int getenv_quad(const char *name, quad_t *data);
287 int setenv(const char *name, const char *value);
288 int unsetenv(const char *name);
289 int testenv(const char *name);
290
291 typedef uint64_t (cpu_tick_f)(void);
292 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
293 extern cpu_tick_f *cpu_ticks;
294 uint64_t cpu_tickrate(void);
295 uint64_t cputick2usec(uint64_t tick);
296
297 #ifdef APM_FIXUP_CALLTODO
298 struct timeval;
299 void adjust_timeout_calltodo(struct timeval *time_change);
300 #endif /* APM_FIXUP_CALLTODO */
301
302 #include <sys/libkern.h>
303
304 /* Initialize the world */
305 void consinit(void);
306 void cpu_initclocks(void);
307 void cpu_initclocks_bsp(void);
308 void cpu_initclocks_ap(void);
309 void usrinfoinit(void);
310
311 /* Finalize the world */
312 void kern_reboot(int) __dead2;
313 void shutdown_nice(int);
314
315 /* Timeouts */
316 typedef void timeout_t(void *); /* timeout function type */
317 #define CALLOUT_HANDLE_INITIALIZER(handle) \
318 { NULL }
319
320 void callout_handle_init(struct callout_handle *);
321 struct callout_handle timeout(timeout_t *, void *, int);
322 void untimeout(timeout_t *, void *, struct callout_handle);
323 caddr_t kern_timeout_callwheel_alloc(caddr_t v);
324 void kern_timeout_callwheel_init(void);
325
326 /* Stubs for obsolete functions that used to be for interrupt management */
spl0(void)327 static __inline void spl0(void) { return; }
splbio(void)328 static __inline intrmask_t splbio(void) { return 0; }
splcam(void)329 static __inline intrmask_t splcam(void) { return 0; }
splclock(void)330 static __inline intrmask_t splclock(void) { return 0; }
splhigh(void)331 static __inline intrmask_t splhigh(void) { return 0; }
splimp(void)332 static __inline intrmask_t splimp(void) { return 0; }
splnet(void)333 static __inline intrmask_t splnet(void) { return 0; }
splsoftcam(void)334 static __inline intrmask_t splsoftcam(void) { return 0; }
splsoftclock(void)335 static __inline intrmask_t splsoftclock(void) { return 0; }
splsofttty(void)336 static __inline intrmask_t splsofttty(void) { return 0; }
splsoftvm(void)337 static __inline intrmask_t splsoftvm(void) { return 0; }
splsofttq(void)338 static __inline intrmask_t splsofttq(void) { return 0; }
splstatclock(void)339 static __inline intrmask_t splstatclock(void) { return 0; }
spltty(void)340 static __inline intrmask_t spltty(void) { return 0; }
splvm(void)341 static __inline intrmask_t splvm(void) { return 0; }
splx(intrmask_t ipl __unused)342 static __inline void splx(intrmask_t ipl __unused) { return; }
343
344 /*
345 * Common `proc' functions are declared here so that proc.h can be included
346 * less often.
347 */
348 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
349 int timo) __nonnull(1);
350 #define msleep(chan, mtx, pri, wmesg, timo) \
351 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (timo))
352 int msleep_spin(void *chan, struct mtx *mtx, const char *wmesg, int timo)
353 __nonnull(1);
354 int pause(const char *wmesg, int timo);
355 #define tsleep(chan, pri, wmesg, timo) \
356 _sleep((chan), NULL, (pri), (wmesg), (timo))
357 void wakeup(void *chan) __nonnull(1);
358 void wakeup_one(void *chan) __nonnull(1);
359
360 /*
361 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
362 */
363
364 struct cdev;
365 dev_t dev2udev(struct cdev *x);
366 const char *devtoname(struct cdev *cdev);
367
368 int poll_no_poll(int events);
369
370 /* XXX: Should be void nanodelay(u_int nsec); */
371 void DELAY(int usec);
372
373 /* Root mount holdback API */
374 struct root_hold_token;
375
376 struct root_hold_token *root_mount_hold(const char *identifier);
377 void root_mount_rel(struct root_hold_token *h);
378 void root_mount_wait(void);
379 int root_mounted(void);
380
381
382 /*
383 * Unit number allocation API. (kern/subr_unit.c)
384 */
385 struct unrhdr;
386 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
387 void delete_unrhdr(struct unrhdr *uh);
388 void clean_unrhdr(struct unrhdr *uh);
389 void clean_unrhdrl(struct unrhdr *uh);
390 int alloc_unr(struct unrhdr *uh);
391 int alloc_unr_specific(struct unrhdr *uh, u_int item);
392 int alloc_unrl(struct unrhdr *uh);
393 void free_unr(struct unrhdr *uh, u_int item);
394
395 #endif /* !_SYS_SYSTM_H_ */
396