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