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