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