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 cold; /* nonzero if we are doing a cold boot */
49 extern int rebooting; /* boot() has been called. */
50 extern const char *panicstr; /* panic message */
51 extern char version[]; /* system version */
52 extern char copyright[]; /* system copyright */
53 extern int kstack_pages; /* number of kernel stack pages */
55 extern int nswap; /* size of swap space */
57 extern u_long pagesizes[]; /* supported page sizes */
58 extern long physmem; /* physical memory */
59 extern long realmem; /* 'real' memory */
61 extern char *rootdevnames[2]; /* names of possible root devices */
63 extern int boothowto; /* reboot flags, from console subsystem */
64 extern int bootverbose; /* nonzero to print verbose messages */
66 extern int maxusers; /* system tune hint */
67 extern int ngroups_max; /* max # of supplemental groups */
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 * Assert that a pointer can be loaded from memory atomically.
97 * This assertion enforces stronger alignment than necessary. For example,
98 * on some architectures, atomicity for unaligned loads will depend on
99 * whether or not the load spans multiple cache lines.
101 #define ASSERT_ATOMIC_LOAD_PTR(var, msg) \
102 KASSERT(sizeof(var) == sizeof(void *) && \
103 ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
106 * XXX the hints declarations are even more misplaced than most declarations
107 * in this file, since they are needed in one file (per arch) and only used
109 * XXX most of these variables should be const.
111 extern int osreldate;
113 extern int hintmode; /* 0 = off. 1 = config, 2 = fallback */
114 extern int dynamic_kenv;
115 extern struct mtx kenv_lock;
116 extern char *kern_envp;
117 extern char static_env[];
118 extern char static_hints[]; /* by config for now */
123 * General function declarations.
138 int setjmp(struct _jmp_buf *);
139 void longjmp(struct _jmp_buf *, int) __dead2;
140 int dumpstatus(vm_offset_t addr, off_t count);
142 int eopnotsupp(void);
143 int ureadc(int, struct uio *);
144 void hashdestroy(void *, struct malloc_type *, u_long);
145 void *hashinit(int count, struct malloc_type *type, u_long *hashmark);
146 void *hashinit_flags(int count, struct malloc_type *type,
147 u_long *hashmask, int flags);
148 #define HASH_NOWAIT 0x00000001
149 #define HASH_WAITOK 0x00000002
151 void *phashinit(int count, struct malloc_type *type, u_long *nentries);
152 void g_waitidle(void);
154 #ifdef RESTARTABLE_PANICS
155 void panic(const char *, ...) __printflike(1, 2);
157 void panic(const char *, ...) __dead2 __printflike(1, 2);
161 void cpu_flush_dcache(void *, size_t);
162 void cpu_rootconf(void);
163 void critical_enter(void);
164 void critical_exit(void);
165 void init_param1(void);
166 void init_param2(long physpages);
167 void init_param3(long kmempages);
168 void tablefull(const char *);
169 int kvprintf(char const *, void (*)(int, void*), void *, int,
170 __va_list) __printflike(1, 0);
171 void log(int, const char *, ...) __printflike(2, 3);
172 void log_console(struct uio *);
173 int printf(const char *, ...) __printflike(1, 2);
174 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
175 int sprintf(char *buf, const char *, ...) __printflike(2, 3);
176 int uprintf(const char *, ...) __printflike(1, 2);
177 int vprintf(const char *, __va_list) __printflike(1, 0);
178 int vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
179 int vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
180 int vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
181 int ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
182 int sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
183 int vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
184 long strtol(const char *, char **, int) __nonnull(1);
185 u_long strtoul(const char *, char **, int) __nonnull(1);
186 quad_t strtoq(const char *, char **, int) __nonnull(1);
187 u_quad_t strtouq(const char *, char **, int) __nonnull(1);
188 void tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
189 void hexdump(const void *ptr, int length, const char *hdr, int flags);
190 #define HD_COLUMN_MASK 0xff
191 #define HD_DELIM_MASK 0xff00
192 #define HD_OMIT_COUNT (1 << 16)
193 #define HD_OMIT_HEX (1 << 17)
194 #define HD_OMIT_CHARS (1 << 18)
196 #define ovbcopy(f, t, l) bcopy((f), (t), (l))
197 void bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
198 void bzero(void *buf, size_t len) __nonnull(1);
200 void *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
201 void *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
203 int copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
204 size_t len, size_t * __restrict lencopied)
205 __nonnull(1) __nonnull(2);
206 int copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
207 size_t len, size_t * __restrict lencopied)
208 __nonnull(1) __nonnull(2);
209 int copyin(const void * __restrict udaddr, void * __restrict kaddr,
210 size_t len) __nonnull(1) __nonnull(2);
211 int copyout(const void * __restrict kaddr, void * __restrict udaddr,
212 size_t len) __nonnull(1) __nonnull(2);
214 int fubyte(const void *base);
215 long fuword(const void *base);
216 int fuword16(void *base);
217 int32_t fuword32(const void *base);
218 int64_t fuword64(const void *base);
219 int subyte(void *base, int byte);
220 int suword(void *base, long word);
221 int suword16(void *base, int word);
222 int suword32(void *base, int32_t word);
223 int suword64(void *base, int64_t word);
224 uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
225 u_long casuword(volatile u_long *p, u_long oldval, u_long newval);
227 void realitexpire(void *);
229 int sysbeep(int hertz, int period);
231 void hardclock(int usermode, uintfptr_t pc);
232 void hardclock_cpu(int usermode);
233 void softclock(void *);
234 void statclock(int usermode);
235 void profclock(int usermode, uintfptr_t pc);
237 void startprofclock(struct proc *);
238 void stopprofclock(struct proc *);
239 void cpu_startprofclock(void);
240 void cpu_stopprofclock(void);
242 int cr_cansee(struct ucred *u1, struct ucred *u2);
243 int cr_canseesocket(struct ucred *cred, struct socket *so);
244 int cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
246 char *getenv(const char *name);
247 void freeenv(char *env);
248 int getenv_int(const char *name, int *data);
249 int getenv_uint(const char *name, unsigned int *data);
250 int getenv_long(const char *name, long *data);
251 int getenv_ulong(const char *name, unsigned long *data);
252 int getenv_string(const char *name, char *data, int size);
253 int getenv_quad(const char *name, quad_t *data);
254 int setenv(const char *name, const char *value);
255 int unsetenv(const char *name);
256 int testenv(const char *name);
258 typedef uint64_t (cpu_tick_f)(void);
259 void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
260 extern cpu_tick_f *cpu_ticks;
261 uint64_t cpu_tickrate(void);
262 uint64_t cputick2usec(uint64_t tick);
264 #ifdef APM_FIXUP_CALLTODO
266 void adjust_timeout_calltodo(struct timeval *time_change);
267 #endif /* APM_FIXUP_CALLTODO */
269 #include <sys/libkern.h>
271 /* Initialize the world */
273 void cpu_initclocks(void);
274 void usrinfoinit(void);
276 /* Finalize the world */
277 void shutdown_nice(int);
280 typedef void timeout_t(void *); /* timeout function type */
281 #define CALLOUT_HANDLE_INITIALIZER(handle) \
284 void callout_handle_init(struct callout_handle *);
285 struct callout_handle timeout(timeout_t *, void *, int);
286 void untimeout(timeout_t *, void *, struct callout_handle);
287 caddr_t kern_timeout_callwheel_alloc(caddr_t v);
288 void kern_timeout_callwheel_init(void);
290 /* Stubs for obsolete functions that used to be for interrupt management */
291 static __inline void spl0(void) { return; }
292 static __inline intrmask_t splbio(void) { return 0; }
293 static __inline intrmask_t splcam(void) { return 0; }
294 static __inline intrmask_t splclock(void) { return 0; }
295 static __inline intrmask_t splhigh(void) { return 0; }
296 static __inline intrmask_t splimp(void) { return 0; }
297 static __inline intrmask_t splnet(void) { return 0; }
298 static __inline intrmask_t splsoftcam(void) { return 0; }
299 static __inline intrmask_t splsoftclock(void) { return 0; }
300 static __inline intrmask_t splsofttty(void) { return 0; }
301 static __inline intrmask_t splsoftvm(void) { return 0; }
302 static __inline intrmask_t splsofttq(void) { return 0; }
303 static __inline intrmask_t splstatclock(void) { return 0; }
304 static __inline intrmask_t spltty(void) { return 0; }
305 static __inline intrmask_t splvm(void) { return 0; }
306 static __inline void splx(intrmask_t ipl __unused) { return; }
309 * Common `proc' functions are declared here so that proc.h can be included
312 int _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
313 int timo) __nonnull(1);
314 #define msleep(chan, mtx, pri, wmesg, timo) \
315 _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (timo))
316 int msleep_spin(void *chan, struct mtx *mtx, const char *wmesg, int timo)
318 int pause(const char *wmesg, int timo);
319 #define tsleep(chan, pri, wmesg, timo) \
320 _sleep((chan), NULL, (pri), (wmesg), (timo))
321 void wakeup(void *chan) __nonnull(1);
322 void wakeup_one(void *chan) __nonnull(1);
325 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
329 dev_t dev2udev(struct cdev *x);
330 const char *devtoname(struct cdev *cdev);
332 int poll_no_poll(int events);
334 /* XXX: Should be void nanodelay(u_int nsec); */
335 void DELAY(int usec);
337 /* Root mount holdback API */
338 struct root_hold_token;
340 struct root_hold_token *root_mount_hold(const char *identifier);
341 void root_mount_rel(struct root_hold_token *h);
342 void root_mount_wait(void);
343 int root_mounted(void);
347 * Unit number allocation API. (kern/subr_unit.c)
350 struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
351 void delete_unrhdr(struct unrhdr *uh);
352 void clean_unrhdr(struct unrhdr *uh);
353 void clean_unrhdrl(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_ */