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 #ifdef INVARIANTS /* The option is always available */
75 #define KASSERT(exp,msg) do { \
76 if (__predict_false(!(exp))) \
79 #define VNASSERT(exp, vp, msg) do { \
80 if (__predict_false(!(exp))) { \
81 vn_printf(vp, "VNASSERT failed\n"); \
86 #define KASSERT(exp,msg) do { \
89 #define VNASSERT(exp, vp, msg) do { \
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]
100 * XXX the hints declarations are even more misplaced than most declarations
101 * in this file, since they are needed in one file (per arch) and only used
103 * XXX most of these variables should be const.
106 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
107 extern int dynamic_kenv;
108 extern struct mtx kenv_lock;
109 extern char *kern_envp;
110 extern char static_env[];
111 extern char static_hints[]; /* by config for now */
116 * General function declarations.
131 int setjmp(struct _jmp_buf *);
132 void longjmp(struct _jmp_buf *, int) __dead2;
133 int dumpstatus(vm_offset_t addr, off_t count);
135 int eopnotsupp(void);
136 int ureadc(int, struct uio *);
137 void hashdestroy(void *, struct malloc_type *, u_long);
138 void *hashinit(int count, struct malloc_type *type, u_long *hashmark);
139 void *hashinit_flags(int count, struct malloc_type *type,
140 u_long *hashmask, int flags);
141 #define HASH_NOWAIT 0x00000001
142 #define HASH_WAITOK 0x00000002
144 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
145 void g_waitidle(void);
147 #ifdef RESTARTABLE_PANICS
148 void panic(const char *, ...) __printflike(1, 2);
150 void panic(const char *, ...) __dead2 __printflike(1, 2);
154 void cpu_rootconf(void);
155 void critical_enter(void);
156 void critical_exit(void);
157 void init_param1(void);
158 void init_param2(long physpages);
159 void init_param3(long kmempages);
160 void tablefull(const char *);
161 int kvprintf(char const *, void (*)(int, void*), void *, int,
162 __va_list) __printflike(1, 0);
163 void log(int, const char *, ...) __printflike(2, 3);
164 void log_console(struct uio *);
165 int printf(const char *, ...) __printflike(1, 2);
166 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
167 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
168 int uprintf(const char *, ...) __printflike(1, 2);
169 int vprintf(const char *, __va_list) __printflike(1, 0);
170 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
171 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
172 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
173 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
174 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
175 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
176 long strtol(const char *, char **, int) __nonnull(1);
177 u_long strtoul(const char *, char **, int) __nonnull(1);
178 quad_t strtoq(const char *, char **, int) __nonnull(1);
179 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
180 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
181 void hexdump(const void *ptr, int length, const char *hdr, int flags);
182 #define HD_COLUMN_MASK 0xff
183 #define HD_DELIM_MASK 0xff00
184 #define HD_OMIT_COUNT (1 << 16)
185 #define HD_OMIT_HEX (1 << 17)
186 #define HD_OMIT_CHARS (1 << 18)
188 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
189 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
190 void bzero(void *buf, size_t len) __nonnull(1);
192 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
194 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
195 size_t len, size_t * __restrict lencopied)
196 __nonnull(1) __nonnull(2);
197 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
198 size_t len, size_t * __restrict lencopied)
199 __nonnull(1) __nonnull(2);
200 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
201 size_t len) __nonnull(1) __nonnull(2);
202 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
203 size_t len) __nonnull(1) __nonnull(2);
205 int fubyte(const void *base);
206 long fuword(const void *base);
207 int fuword16(void *base);
208 int32_t fuword32(const void *base);
209 int64_t fuword64(const void *base);
210 int subyte(void *base, int byte);
211 int suword(void *base, long word);
212 int suword16(void *base, int word);
213 int suword32(void *base, int32_t word);
214 int suword64(void *base, int64_t word);
215 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
216 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
218 void realitexpire(void *);
221 * Cyclic clock function type definition used to hook the cyclic
222 * subsystem into the appropriate timer interrupt.
224 typedef void (*cyclic_clock_func_t)(void);
226 void hardclock(int usermode, uintfptr_t pc);
227 void hardclock_cpu(int usermode);
228 void softclock(void *);
229 void statclock(int usermode);
230 void profclock(int usermode, uintfptr_t pc);
232 void startprofclock(struct proc *);
233 void stopprofclock(struct proc *);
234 void cpu_startprofclock(void);
235 void cpu_stopprofclock(void);
237 int cr_cansee(struct ucred *u1, struct ucred *u2);
238 int cr_canseesocket(struct ucred *cred, struct socket *so);
240 char *getenv(const char *name);
241 void freeenv(char *env);
242 int getenv_int(const char *name, int *data);
243 long getenv_long(const char *name, long *data);
244 unsigned long getenv_ulong(const char *name, unsigned long *data);
245 int getenv_string(const char *name, char *data, int size);
246 int getenv_quad(const char *name, quad_t *data);
247 int setenv(const char *name, const char *value);
248 int unsetenv(const char *name);
249 int testenv(const char *name);
251 typedef uint64_t (cpu_tick_f)(void);
252 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
253 extern cpu_tick_f *cpu_ticks;
254 uint64_t cpu_tickrate(void);
255 uint64_t cputick2usec(uint64_t tick);
257 #ifdef APM_FIXUP_CALLTODO
259 void adjust_timeout_calltodo(struct timeval *time_change);
260 #endif /* APM_FIXUP_CALLTODO */
262 #include <sys/libkern.h>
264 /* Initialize the world */
266 void cpu_initclocks(void);
267 void usrinfoinit(void);
269 /* Finalize the world */
270 void shutdown_nice(int);
273 typedef void timeout_t(void *); /* timeout function type */
274 #define CALLOUT_HANDLE_INITIALIZER(handle) \
277 void callout_handle_init(struct callout_handle *);
278 struct callout_handle timeout(timeout_t *, void *, int);
279 void untimeout(timeout_t *, void *, struct callout_handle);
280 caddr_t kern_timeout_callwheel_alloc(caddr_t v);
281 void kern_timeout_callwheel_init(void);
283 /* Stubs for obsolete functions that used to be for interrupt management */
284 static __inline void spl0(void) { return; }
285 static __inline intrmask_t splbio(void) { return 0; }
286 static __inline intrmask_t splcam(void) { return 0; }
287 static __inline intrmask_t splclock(void) { return 0; }
288 static __inline intrmask_t splhigh(void) { return 0; }
289 static __inline intrmask_t splimp(void) { return 0; }
290 static __inline intrmask_t splnet(void) { return 0; }
291 static __inline intrmask_t splsoftcam(void) { return 0; }
292 static __inline intrmask_t splsoftclock(void) { return 0; }
293 static __inline intrmask_t splsofttty(void) { return 0; }
294 static __inline intrmask_t splsoftvm(void) { return 0; }
295 static __inline intrmask_t splsofttq(void) { return 0; }
296 static __inline intrmask_t splstatclock(void) { return 0; }
297 static __inline intrmask_t spltty(void) { return 0; }
298 static __inline intrmask_t splvm(void) { return 0; }
299 static __inline void splx(intrmask_t ipl __unused) { return; }
302 * Common `proc' functions are declared here so that proc.h can be included
305 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
306 int timo) __nonnull(1);
307 #define msleep(chan, mtx, pri, wmesg, timo) \
308 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (timo))
309 int msleep_spin(void *chan, struct mtx *mtx, const char *wmesg, int timo)
311 int pause(const char *wmesg, int timo);
312 #define tsleep(chan, pri, wmesg, timo) \
313 _sleep((chan), NULL, (pri), (wmesg), (timo))
314 void wakeup(void *chan) __nonnull(1);
315 void wakeup_one(void *chan) __nonnull(1);
318 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
322 int minor(struct cdev *x);
323 dev_t dev2udev(struct cdev *x);
324 int uminor(dev_t dev);
325 int umajor(dev_t dev);
326 const char *devtoname(struct cdev *cdev);
328 /* XXX: Should be void nanodelay(u_int nsec); */
329 void DELAY(int usec);
331 /* Root mount holdback API */
332 struct root_hold_token;
334 struct root_hold_token *root_mount_hold(const char *identifier);
335 void root_mount_rel(struct root_hold_token *h);
336 void root_mount_wait(void);
337 int root_mounted(void);
341 * Unit number allocation API. (kern/subr_unit.c)
344 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
345 void delete_unrhdr(struct unrhdr *uh);
346 int alloc_unr(struct unrhdr *uh);
347 int alloc_unrl(struct unrhdr *uh);
348 void free_unr(struct unrhdr *uh, u_int item);
351 * This is about as magic as it gets. fortune(1) has got similar code
352 * for reversing bits in a word. Who thinks up this stuff??
354 * Yes, it does appear to be consistently faster than:
355 * while (i = ffs(m)) {
360 * while (lsb = (m & -m)) { // This is magic too
361 * m &= ~lsb; // or: m ^= lsb
364 * Both of these latter forms do some very strange things on gcc-3.1 with
365 * -mcpu=pentiumpro and/or -march=pentiumpro and/or -O or -O2.
366 * There is probably an SSE or MMX popcnt instruction.
368 * I wonder if this should be in libkern?
370 * XXX Stop the presses! Another one:
371 * static __inline u_int32_t
372 * popcnt1(u_int32_t v)
374 * v -= ((v >> 1) & 0x55555555);
375 * v = (v & 0x33333333) + ((v >> 2) & 0x33333333);
376 * v = (v + (v >> 4)) & 0x0F0F0F0F;
377 * return (v * 0x01010101) >> 24;
379 * The downside is that it has a multiply. With a pentium3 with
380 * -mcpu=pentiumpro and -march=pentiumpro then gcc-3.1 will use
381 * an imull, and in that case it is faster. In most other cases
382 * it appears slightly slower.
384 * Another variant (also from fortune):
385 * #define BITCOUNT(x) (((BX_(x)+(BX_(x)>>4)) & 0x0F0F0F0F) % 255)
386 * #define BX_(x) ((x) - (((x)>>1)&0x77777777) \
387 * - (((x)>>2)&0x33333333) \
388 * - (((x)>>3)&0x11111111))
390 static __inline uint32_t
391 bitcount32(uint32_t x)
394 x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
395 x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
396 x = (x + (x >> 4)) & 0x0f0f0f0f;
398 x = (x + (x >> 16)) & 0x000000ff;
402 #endif /* !_SYS_SYSTM_H_ */