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/7.3/sys/sys/systm.h 198742 2009-11-01 08:45:44Z alc $
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 securelevel; /* system security level (see init(8)) */
49
50 extern int cold; /* nonzero if we are doing a cold boot */
51 extern int rebooting; /* boot() has been called. */
52 extern const char *panicstr; /* panic message */
53 extern char version[]; /* system version */
54 extern char copyright[]; /* system copyright */
55 extern int kstack_pages; /* number of kernel stack pages */
56
57 extern int nswap; /* size of swap space */
58
59 extern u_int nselcoll; /* select collisions since boot */
60 extern struct mtx sellock; /* select lock variable */
61 extern struct cv selwait; /* select conditional variable */
62
63 extern u_long pagesizes[]; /* supported page sizes */
64 extern long physmem; /* physical memory */
65 extern long realmem; /* 'real' memory */
66
67 extern char *rootdevnames[2]; /* names of possible root devices */
68
69 extern int boothowto; /* reboot flags, from console subsystem */
70 extern int bootverbose; /* nonzero to print verbose messages */
71
72 extern int maxusers; /* system tune hint */
73
74 #ifdef INVARIANTS /* The option is always available */
75 #define KASSERT(exp,msg) do { \
76 if (__predict_false(!(exp))) \
77 panic msg; \
78 } while (0)
79 #define VNASSERT(exp, vp, msg) do { \
80 if (__predict_false(!(exp))) { \
81 vn_printf(vp, "VNASSERT failed\n"); \
82 panic msg; \
83 } \
84 } while (0)
85 #else
86 #define KASSERT(exp,msg) do { \
87 } while (0)
88
89 #define VNASSERT(exp, vp, msg) do { \
90 } while (0)
91 #endif
92
93 #ifndef CTASSERT /* Allow lint to override */
94 #define CTASSERT(x) _CTASSERT(x, __LINE__)
95 #define _CTASSERT(x, y) __CTASSERT(x, y)
96 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
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 * XXX the hints declarations are even more misplaced than most declarations
112 * in this file, since they are needed in one file (per arch) and only used
113 * in two files.
114 * XXX most of these variables should be const.
115 */
116 extern int osreldate;
117 extern int envmode;
118 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
119 extern int dynamic_kenv;
120 extern struct mtx kenv_lock;
121 extern char *kern_envp;
122 extern char static_env[];
123 extern char static_hints[]; /* by config for now */
124
125 extern char **kenvp;
126
127 /*
128 * General function declarations.
129 */
130
131 struct inpcb;
132 struct lock_object;
133 struct malloc_type;
134 struct mtx;
135 struct proc;
136 struct kse;
137 struct socket;
138 struct thread;
139 struct tty;
140 struct ucred;
141 struct uio;
142 struct _jmp_buf;
143
144 int setjmp(struct _jmp_buf *);
145 void longjmp(struct _jmp_buf *, int) __dead2;
146 int dumpstatus(vm_offset_t addr, off_t count);
147 int nullop(void);
148 int eopnotsupp(void);
149 int ureadc(int, struct uio *);
150 void hashdestroy(void *, struct malloc_type *, u_long);
151 void *hashinit(int count, struct malloc_type *type, u_long *hashmark);
152 void *hashinit_flags(int count, struct malloc_type *type,
153 u_long *hashmask, int flags);
154 #define HASH_NOWAIT 0x00000001
155 #define HASH_WAITOK 0x00000002
156
157 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
158 void g_waitidle(void);
159
160 #ifdef RESTARTABLE_PANICS
161 void panic(const char *, ...) __printflike(1, 2);
162 #else
163 void panic(const char *, ...) __dead2 __printflike(1, 2);
164 #endif
165
166 void cpu_boot(int);
167 void cpu_rootconf(void);
168 void critical_enter(void);
169 void critical_exit(void);
170 void init_param1(void);
171 void init_param2(long physpages);
172 void init_param3(long kmempages);
173 void tablefull(const char *);
174 int kvprintf(char const *, void (*)(int, void*), void *, int,
175 __va_list) __printflike(1, 0);
176 void log(int, const char *, ...) __printflike(2, 3);
177 void log_console(struct uio *);
178 int printf(const char *, ...) __printflike(1, 2);
179 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
180 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
181 int uprintf(const char *, ...) __printflike(1, 2);
182 int vprintf(const char *, __va_list) __printflike(1, 0);
183 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
184 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
185 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
186 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
187 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
188 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
189 long strtol(const char *, char **, int) __nonnull(1);
190 u_long strtoul(const char *, char **, int) __nonnull(1);
191 quad_t strtoq(const char *, char **, int) __nonnull(1);
192 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
193 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
194 void hexdump(const void *ptr, int length, const char *hdr, int flags);
195 #define HD_COLUMN_MASK 0xff
196 #define HD_DELIM_MASK 0xff00
197 #define HD_OMIT_COUNT (1 << 16)
198 #define HD_OMIT_HEX (1 << 17)
199 #define HD_OMIT_CHARS (1 << 18)
200
201 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
202 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
203 void bzero(void *buf, size_t len) __nonnull(1);
204
205 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
206 void *memmove(void *dest, const void *src, size_t len) __nonnull(1) __nonnull(2);
207
208 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
209 size_t len, size_t * __restrict lencopied)
210 __nonnull(1) __nonnull(2);
211 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
212 size_t len, size_t * __restrict lencopied)
213 __nonnull(1) __nonnull(2);
214 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
215 size_t len) __nonnull(1) __nonnull(2);
216 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
217 size_t len) __nonnull(1) __nonnull(2);
218
219 int fubyte(const void *base);
220 long fuword(const void *base);
221 int fuword16(void *base);
222 int32_t fuword32(const void *base);
223 int64_t fuword64(const void *base);
224 int subyte(void *base, int byte);
225 int suword(void *base, long word);
226 int suword16(void *base, int word);
227 int suword32(void *base, int32_t word);
228 int suword64(void *base, int64_t word);
229 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
230 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
231
232 void realitexpire(void *);
233
234 void hardclock(int usermode, uintfptr_t pc);
235 void hardclock_cpu(int usermode);
236 void softclock(void *);
237 void statclock(int usermode);
238 void profclock(int usermode, uintfptr_t pc);
239
240 void startprofclock(struct proc *);
241 void stopprofclock(struct proc *);
242 void cpu_startprofclock(void);
243 void cpu_stopprofclock(void);
244
245 int cr_cansee(struct ucred *u1, struct ucred *u2);
246 int cr_canseesocket(struct ucred *cred, struct socket *so);
247 int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
248
249 char *getenv(const char *name);
250 void freeenv(char *env);
251 int getenv_int(const char *name, int *data);
252 long getenv_long(const char *name, long *data);
253 unsigned long getenv_ulong(const char *name, unsigned long *data);
254 int getenv_string(const char *name, char *data, int size);
255 int getenv_quad(const char *name, quad_t *data);
256 int setenv(const char *name, const char *value);
257 int unsetenv(const char *name);
258 int testenv(const char *name);
259
260 typedef uint64_t (cpu_tick_f)(void);
261 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
262 extern cpu_tick_f *cpu_ticks;
263 uint64_t cpu_tickrate(void);
264 uint64_t cputick2usec(uint64_t tick);
265
266 #ifdef APM_FIXUP_CALLTODO
267 struct timeval;
268 void adjust_timeout_calltodo(struct timeval *time_change);
269 #endif /* APM_FIXUP_CALLTODO */
270
271 #include <sys/libkern.h>
272
273 /* Initialize the world */
274 void consinit(void);
275 void cpu_initclocks(void);
276 void usrinfoinit(void);
277
278 /* Finalize the world */
279 void shutdown_nice(int);
280
281 /* Timeouts */
282 typedef void timeout_t(void *); /* timeout function type */
283 #define CALLOUT_HANDLE_INITIALIZER(handle) \
284 { NULL }
285
286 void callout_handle_init(struct callout_handle *);
287 struct callout_handle timeout(timeout_t *, void *, int);
288 void untimeout(timeout_t *, void *, struct callout_handle);
289 caddr_t kern_timeout_callwheel_alloc(caddr_t v);
290 void kern_timeout_callwheel_init(void);
291
292 /* Stubs for obsolete functions that used to be for interrupt management */
293 static __inline void spl0(void) { return; }
294 static __inline intrmask_t splbio(void) { return 0; }
295 static __inline intrmask_t splcam(void) { return 0; }
296 static __inline intrmask_t splclock(void) { return 0; }
297 static __inline intrmask_t splhigh(void) { return 0; }
298 static __inline intrmask_t splimp(void) { return 0; }
299 static __inline intrmask_t splnet(void) { return 0; }
300 static __inline intrmask_t splsoftcam(void) { return 0; }
301 static __inline intrmask_t splsoftclock(void) { return 0; }
302 static __inline intrmask_t splsofttty(void) { return 0; }
303 static __inline intrmask_t splsoftvm(void) { return 0; }
304 static __inline intrmask_t splsofttq(void) { return 0; }
305 static __inline intrmask_t splstatclock(void) { return 0; }
306 static __inline intrmask_t spltty(void) { return 0; }
307 static __inline intrmask_t splvm(void) { return 0; }
308 static __inline void splx(intrmask_t ipl __unused) { return; }
309
310 /*
311 * Common `proc' functions are declared here so that proc.h can be included
312 * less often.
313 */
314 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
315 int timo) __nonnull(1);
316 #define msleep(chan, mtx, pri, wmesg, timo) \
317 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (timo))
318 int msleep_spin(void *chan, struct mtx *mtx, const char *wmesg, int timo)
319 __nonnull(1);
320 int pause(const char *wmesg, int timo);
321 #define tsleep(chan, pri, wmesg, timo) \
322 _sleep((chan), NULL, (pri), (wmesg), (timo))
323 void wakeup(void *chan) __nonnull(1);
324 void wakeup_one(void *chan) __nonnull(1);
325
326 /*
327 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
328 */
329
330 struct cdev;
331 int minor(struct cdev *x);
332 dev_t dev2udev(struct cdev *x);
333 int uminor(dev_t dev);
334 int umajor(dev_t dev);
335 const char *devtoname(struct cdev *cdev);
336
337 int poll_no_poll(int events);
338
339 /* XXX: Should be void nanodelay(u_int nsec); */
340 void DELAY(int usec);
341
342 /* Root mount holdback API */
343 struct root_hold_token;
344
345 struct root_hold_token *root_mount_hold(const char *identifier);
346 void root_mount_rel(struct root_hold_token *h);
347 void root_mount_wait(void);
348 int root_mounted(void);
349
350
351 /*
352 * Unit number allocation API. (kern/subr_unit.c)
353 */
354 struct unrhdr;
355 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
356 void delete_unrhdr(struct unrhdr *uh);
357 void clean_unrhdr(struct unrhdr *uh);
358 void clean_unrhdrl(struct unrhdr *uh);
359 int alloc_unr(struct unrhdr *uh);
360 int alloc_unrl(struct unrhdr *uh);
361 void free_unr(struct unrhdr *uh, u_int item);
362
363 /*
364 * This is about as magic as it gets. fortune(1) has got similar code
365 * for reversing bits in a word. Who thinks up this stuff??
366 *
367 * Yes, it does appear to be consistently faster than:
368 * while (i = ffs(m)) {
369 * m >>= i;
370 * bits++;
371 * }
372 * and
373 * while (lsb = (m & -m)) { // This is magic too
374 * m &= ~lsb; // or: m ^= lsb
375 * bits++;
376 * }
377 * Both of these latter forms do some very strange things on gcc-3.1 with
378 * -mcpu=pentiumpro and/or -march=pentiumpro and/or -O or -O2.
379 * There is probably an SSE or MMX popcnt instruction.
380 *
381 * I wonder if this should be in libkern?
382 *
383 * XXX Stop the presses! Another one:
384 * static __inline u_int32_t
385 * popcnt1(u_int32_t v)
386 * {
387 * v -= ((v >> 1) & 0x55555555);
388 * v = (v & 0x33333333) + ((v >> 2) & 0x33333333);
389 * v = (v + (v >> 4)) & 0x0F0F0F0F;
390 * return (v * 0x01010101) >> 24;
391 * }
392 * The downside is that it has a multiply. With a pentium3 with
393 * -mcpu=pentiumpro and -march=pentiumpro then gcc-3.1 will use
394 * an imull, and in that case it is faster. In most other cases
395 * it appears slightly slower.
396 *
397 * Another variant (also from fortune):
398 * #define BITCOUNT(x) (((BX_(x)+(BX_(x)>>4)) & 0x0F0F0F0F) % 255)
399 * #define BX_(x) ((x) - (((x)>>1)&0x77777777) \
400 * - (((x)>>2)&0x33333333) \
401 * - (((x)>>3)&0x11111111))
402 */
403 static __inline uint32_t
404 bitcount32(uint32_t x)
405 {
406
407 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
408 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
409 x = (x + (x >> 4)) & 0x0f0f0f0f;
410 x = (x + (x >> 8));
411 x = (x + (x >> 16)) & 0x000000ff;
412 return (x);
413 }
414
415 #endif /* !_SYS_SYSTM_H_ */
Cache object: bc1bd2dc8c85cd3baafb63f84df36666
|