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)) */
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 */
57 extern int nswap; /* size of swap space */
59 extern long physmem; /* physical memory */
60 extern long realmem; /* 'real' memory */
62 extern char *rootdevnames[2]; /* names of possible root devices */
64 extern int boothowto; /* reboot flags, from console subsystem */
65 extern int bootverbose; /* nonzero to print verbose messages */
67 extern int maxusers; /* system tune hint */
69 #ifdef INVARIANTS /* The option is always available */
70 #define KASSERT(exp,msg) do { \
71 if (__predict_false(!(exp))) \
74 #define VNASSERT(exp, vp, msg) do { \
75 if (__predict_false(!(exp))) { \
76 vn_printf(vp, "VNASSERT failed\n"); \
81 #define KASSERT(exp,msg) do { \
84 #define VNASSERT(exp, vp, msg) do { \
88 #ifndef CTASSERT /* Allow lint to override */
89 #define CTASSERT(x) _CTASSERT(x, __LINE__)
90 #define _CTASSERT(x, y) __CTASSERT(x, y)
91 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
95 * XXX the hints declarations are even more misplaced than most declarations
96 * in this file, since they are needed in one file (per arch) and only used
98 * XXX most of these variables should be const.
100 extern int osreldate;
102 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
103 extern int dynamic_kenv;
104 extern struct mtx kenv_lock;
105 extern char *kern_envp;
106 extern char static_env[];
107 extern char static_hints[]; /* by config for now */
112 * General function declarations.
127 int setjmp(struct _jmp_buf *);
128 void longjmp(struct _jmp_buf *, int) __dead2;
129 int dumpstatus(vm_offset_t addr, off_t count);
131 int eopnotsupp(void);
132 int ureadc(int, struct uio *);
133 void hashdestroy(void *, struct malloc_type *, u_long);
134 void *hashinit(int count, struct malloc_type *type, u_long *hashmark);
135 void *hashinit_flags(int count, struct malloc_type *type,
136 u_long *hashmask, int flags);
137 #define HASH_NOWAIT 0x00000001
138 #define HASH_WAITOK 0x00000002
140 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
141 void g_waitidle(void);
143 #ifdef RESTARTABLE_PANICS
144 void panic(const char *, ...) __printflike(1, 2);
146 void panic(const char *, ...) __dead2 __printflike(1, 2);
150 void cpu_rootconf(void);
151 void critical_enter(void);
152 void critical_exit(void);
153 void init_param1(void);
154 void init_param2(long physpages);
155 void init_param3(long kmempages);
156 void tablefull(const char *);
157 int kvprintf(char const *, void (*)(int, void*), void *, int,
158 __va_list) __printflike(1, 0);
159 void log(int, const char *, ...) __printflike(2, 3);
160 void log_console(struct uio *);
161 int printf(const char *, ...) __printflike(1, 2);
162 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
163 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
164 int uprintf(const char *, ...) __printflike(1, 2);
165 int vprintf(const char *, __va_list) __printflike(1, 0);
166 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
167 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
168 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
169 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
170 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
171 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
172 long strtol(const char *, char **, int) __nonnull(1);
173 u_long strtoul(const char *, char **, int) __nonnull(1);
174 quad_t strtoq(const char *, char **, int) __nonnull(1);
175 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
176 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
177 void hexdump(const void *ptr, int length, const char *hdr, int flags);
178 #define HD_COLUMN_MASK 0xff
179 #define HD_DELIM_MASK 0xff00
180 #define HD_OMIT_COUNT (1 << 16)
181 #define HD_OMIT_HEX (1 << 17)
182 #define HD_OMIT_CHARS (1 << 18)
184 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
185 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
186 void bzero(void *buf, size_t len) __nonnull(1);
188 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
190 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
191 size_t len, size_t * __restrict lencopied)
192 __nonnull(1) __nonnull(2);
193 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
194 size_t len, size_t * __restrict lencopied)
195 __nonnull(1) __nonnull(2);
196 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
197 size_t len) __nonnull(1) __nonnull(2);
198 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
199 size_t len) __nonnull(1) __nonnull(2);
201 int fubyte(const void *base);
202 long fuword(const void *base);
203 int fuword16(void *base);
204 int32_t fuword32(const void *base);
205 int64_t fuword64(const void *base);
206 int subyte(void *base, int byte);
207 int suword(void *base, long word);
208 int suword16(void *base, int word);
209 int suword32(void *base, int32_t word);
210 int suword64(void *base, int64_t word);
211 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
212 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
214 void realitexpire(void *);
217 * Cyclic clock function type definition used to hook the cyclic
218 * subsystem into the appropriate timer interrupt.
220 typedef void (*cyclic_clock_func_t)(void);
222 void hardclock(int usermode, uintfptr_t pc);
223 void hardclock_cpu(int usermode);
224 void softclock(void *);
225 void statclock(int usermode);
226 void profclock(int usermode, uintfptr_t pc);
228 void startprofclock(struct proc *);
229 void stopprofclock(struct proc *);
230 void cpu_startprofclock(void);
231 void cpu_stopprofclock(void);
233 int cr_cansee(struct ucred *u1, struct ucred *u2);
234 int cr_canseesocket(struct ucred *cred, struct socket *so);
236 char *getenv(const char *name);
237 void freeenv(char *env);
238 int getenv_int(const char *name, int *data);
239 int getenv_uint(const char *name, unsigned int *data);
240 int getenv_long(const char *name, long *data);
241 int getenv_ulong(const char *name, unsigned long *data);
242 int getenv_string(const char *name, char *data, int size);
243 int getenv_quad(const char *name, quad_t *data);
244 int setenv(const char *name, const char *value);
245 int unsetenv(const char *name);
246 int testenv(const char *name);
248 typedef uint64_t (cpu_tick_f)(void);
249 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
250 extern cpu_tick_f *cpu_ticks;
251 uint64_t cpu_tickrate(void);
252 uint64_t cputick2usec(uint64_t tick);
254 #ifdef APM_FIXUP_CALLTODO
256 void adjust_timeout_calltodo(struct timeval *time_change);
257 #endif /* APM_FIXUP_CALLTODO */
259 #include <sys/libkern.h>
261 /* Initialize the world */
263 void cpu_initclocks(void);
264 void usrinfoinit(void);
266 /* Finalize the world */
267 void shutdown_nice(int);
270 typedef void timeout_t(void *); /* timeout function type */
271 #define CALLOUT_HANDLE_INITIALIZER(handle) \
274 void callout_handle_init(struct callout_handle *);
275 struct callout_handle timeout(timeout_t *, void *, int);
276 void untimeout(timeout_t *, void *, struct callout_handle);
277 caddr_t kern_timeout_callwheel_alloc(caddr_t v);
278 void kern_timeout_callwheel_init(void);
280 /* Stubs for obsolete functions that used to be for interrupt management */
281 static __inline void spl0(void) { return; }
282 static __inline intrmask_t splbio(void) { return 0; }
283 static __inline intrmask_t splcam(void) { return 0; }
284 static __inline intrmask_t splclock(void) { return 0; }
285 static __inline intrmask_t splhigh(void) { return 0; }
286 static __inline intrmask_t splimp(void) { return 0; }
287 static __inline intrmask_t splnet(void) { return 0; }
288 static __inline intrmask_t splsoftcam(void) { return 0; }
289 static __inline intrmask_t splsoftclock(void) { return 0; }
290 static __inline intrmask_t splsofttty(void) { return 0; }
291 static __inline intrmask_t splsoftvm(void) { return 0; }
292 static __inline intrmask_t splsofttq(void) { return 0; }
293 static __inline intrmask_t splstatclock(void) { return 0; }
294 static __inline intrmask_t spltty(void) { return 0; }
295 static __inline intrmask_t splvm(void) { return 0; }
296 static __inline void splx(intrmask_t ipl __unused) { return; }
299 * Common `proc' functions are declared here so that proc.h can be included
302 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
303 int timo) __nonnull(1);
304 #define msleep(chan, mtx, pri, wmesg, timo) \
305 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (timo))
306 int msleep_spin(void *chan, struct mtx *mtx, const char *wmesg, int timo)
308 int pause(const char *wmesg, int timo);
309 #define tsleep(chan, pri, wmesg, timo) \
310 _sleep((chan), NULL, (pri), (wmesg), (timo))
311 void wakeup(void *chan) __nonnull(1);
312 void wakeup_one(void *chan) __nonnull(1);
315 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
319 int minor(struct cdev *x);
320 dev_t dev2udev(struct cdev *x);
321 int uminor(dev_t dev);
322 int umajor(dev_t dev);
323 const char *devtoname(struct cdev *cdev);
325 /* XXX: Should be void nanodelay(u_int nsec); */
326 void DELAY(int usec);
328 /* Root mount holdback API */
329 struct root_hold_token;
331 struct root_hold_token *root_mount_hold(const char *identifier);
332 void root_mount_rel(struct root_hold_token *h);
333 void root_mount_wait(void);
334 int root_mounted(void);
338 * Unit number allocation API. (kern/subr_unit.c)
341 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
342 void delete_unrhdr(struct unrhdr *uh);
343 void clean_unrhdr(struct unrhdr *uh);
344 void clean_unrhdrl(struct unrhdr *uh);
345 int alloc_unr(struct unrhdr *uh);
346 int alloc_unrl(struct unrhdr *uh);
347 void free_unr(struct unrhdr *uh, u_int item);
350 * This is about as magic as it gets. fortune(1) has got similar code
351 * for reversing bits in a word. Who thinks up this stuff??
353 * Yes, it does appear to be consistently faster than:
354 * while (i = ffs(m)) {
359 * while (lsb = (m & -m)) { // This is magic too
360 * m &= ~lsb; // or: m ^= lsb
363 * Both of these latter forms do some very strange things on gcc-3.1 with
364 * -mcpu=pentiumpro and/or -march=pentiumpro and/or -O or -O2.
365 * There is probably an SSE or MMX popcnt instruction.
367 * I wonder if this should be in libkern?
369 * XXX Stop the presses! Another one:
370 * static __inline u_int32_t
371 * popcnt1(u_int32_t v)
373 * v -= ((v >> 1) & 0x55555555);
374 * v = (v & 0x33333333) + ((v >> 2) & 0x33333333);
375 * v = (v + (v >> 4)) & 0x0F0F0F0F;
376 * return (v * 0x01010101) >> 24;
378 * The downside is that it has a multiply. With a pentium3 with
379 * -mcpu=pentiumpro and -march=pentiumpro then gcc-3.1 will use
380 * an imull, and in that case it is faster. In most other cases
381 * it appears slightly slower.
383 * Another variant (also from fortune):
384 * #define BITCOUNT(x) (((BX_(x)+(BX_(x)>>4)) & 0x0F0F0F0F) % 255)
385 * #define BX_(x) ((x) - (((x)>>1)&0x77777777) \
386 * - (((x)>>2)&0x33333333) \
387 * - (((x)>>3)&0x11111111))
389 static __inline uint32_t
390 bitcount32(uint32_t x)
393 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
394 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
395 x = (x + (x >> 4)) & 0x0f0f0f0f;
397 x = (x + (x >> 16)) & 0x000000ff;
401 #endif /* !_SYS_SYSTM_H_ */