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