source: rtems-libbsd/freebsd/sys/systm.h @ 03d4faf

4.115-freebsd-12freebsd-9.3
Last change on this file since 03d4faf was 03d4faf, checked in by Joel Sherrill <joel.sherrill@…>, on Mar 8, 2012 at 2:56:25 PM

Begin to trim rtems/ from include file paths - start with freebsd

  • Property mode set to 100644
File size: 14.7 KB
Line 
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_HH_
39#define _SYS_SYSTM_HH_
40
41#include <freebsd/machine/atomic.h>
42#include <freebsd/machine/cpufunc.h>
43#include <freebsd/sys/callout.h>
44#include <freebsd/sys/cdefs.h>
45#include <freebsd/sys/queue.h>
46#include <freebsd/sys/stdint.h>         /* for people using printf mainly */
47
48extern int cold;                /* nonzero if we are doing a cold boot */
49extern int rebooting;           /* boot() has been called. */
50extern const char *panicstr;    /* panic message */
51extern char version[];          /* system version */
52extern char copyright[];        /* system copyright */
53extern int kstack_pages;        /* number of kernel stack pages */
54
55extern int nswap;               /* size of swap space */
56
57extern u_long pagesizes[];      /* supported page sizes */
58extern long physmem;            /* physical memory */
59extern long realmem;            /* 'real' memory */
60
61extern char *rootdevnames[2];   /* names of possible root devices */
62
63extern int boothowto;           /* reboot flags, from console subsystem */
64extern int bootverbose;         /* nonzero to print verbose messages */
65
66extern int maxusers;            /* system tune hint */
67extern int ngroups_max;         /* max # of supplemental groups */
68extern int vm_guest;            /* Running as virtual machine guest? */
69
70/*
71 * Detected virtual machine guest types. The intention is to expand
72 * and/or add to the VM_GUEST_VM type if specific VM functionality is
73 * ever implemented (e.g. vendor-specific paravirtualization features).
74 */
75enum VM_GUEST { VM_GUEST_NO = 0, VM_GUEST_VM, VM_GUEST_XEN };
76
77#ifdef  INVARIANTS              /* The option is always available */
78#define KASSERT(exp,msg) do {                                           \
79        if (__predict_false(!(exp)))                                    \
80                panic msg;                                              \
81} while (0)
82#define VNASSERT(exp, vp, msg) do {                                     \
83        if (__predict_false(!(exp))) {                                  \
84                vn_printf(vp, "VNASSERT failed\n");                     \
85                panic msg;                                              \
86        }                                                               \
87} while (0)
88#else
89#define KASSERT(exp,msg) do { \
90} while (0)
91
92#define VNASSERT(exp, vp, msg) do { \
93} while (0)
94#endif
95
96#ifndef CTASSERT                /* Allow lint to override */
97#define CTASSERT(x)             _CTASSERT(x, __LINE__)
98#define _CTASSERT(x, y)         __CTASSERT(x, y)
99#define __CTASSERT(x, y)        typedef char __assert ## y[(x) ? 1 : -1]
100#endif
101
102/*
103 * Assert that a pointer can be loaded from memory atomically.
104 *
105 * This assertion enforces stronger alignment than necessary.  For example,
106 * on some architectures, atomicity for unaligned loads will depend on
107 * whether or not the load spans multiple cache lines.
108 */
109#define ASSERT_ATOMIC_LOAD_PTR(var, msg)                                \
110        KASSERT(sizeof(var) == sizeof(void *) &&                        \
111            ((uintptr_t)&(var) & (sizeof(void *) - 1)) == 0, msg)
112
113/*
114 * XXX the hints declarations are even more misplaced than most declarations
115 * in this file, since they are needed in one file (per arch) and only used
116 * in two files.
117 * XXX most of these variables should be const.
118 */
119extern int osreldate;
120extern int envmode;
121extern int hintmode;            /* 0 = off. 1 = config, 2 = fallback */
122extern int dynamic_kenv;
123extern struct mtx kenv_lock;
124extern char *kern_envp;
125extern char static_env[];
126extern char static_hints[];     /* by config for now */
127
128extern char **kenvp;
129
130/*
131 * General function declarations.
132 */
133
134struct inpcb;
135struct lock_object;
136struct malloc_type;
137struct mtx;
138struct proc;
139struct socket;
140struct thread;
141struct tty;
142struct ucred;
143struct uio;
144struct _jmp_buf;
145
146int     setjmp(struct _jmp_buf *);
147void    longjmp(struct _jmp_buf *, int) __dead2;
148int     dumpstatus(vm_offset_t addr, off_t count);
149int     nullop(void);
150int     eopnotsupp(void);
151int     ureadc(int, struct uio *);
152void    hashdestroy(void *, struct malloc_type *, u_long);
153void    *hashinit(int count, struct malloc_type *type, u_long *hashmark);
154void    *hashinit_flags(int count, struct malloc_type *type,
155    u_long *hashmask, int flags);
156#define HASH_NOWAIT     0x00000001
157#define HASH_WAITOK     0x00000002
158
159void    *phashinit(int count, struct malloc_type *type, u_long *nentries);
160void    g_waitidle(void);
161
162#ifdef RESTARTABLE_PANICS
163void    panic(const char *, ...) __printflike(1, 2);
164#else
165void    panic(const char *, ...) __dead2 __printflike(1, 2);
166#endif
167
168void    cpu_boot(int);
169void    cpu_flush_dcache(void *, size_t);
170void    cpu_rootconf(void);
171void    critical_enter(void);
172void    critical_exit(void);
173void    init_param1(void);
174void    init_param2(long physpages);
175void    init_param3(long kmempages);
176void    tablefull(const char *);
177int     kvprintf(char const *, void (*)(int, void*), void *, int,
178            __va_list) __printflike(1, 0);
179void    log(int, const char *, ...) __printflike(2, 3);
180void    log_console(struct uio *);
181int     printf(const char *, ...) __printflike(1, 2);
182int     snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
183int     sprintf(char *buf, const char *, ...) __printflike(2, 3);
184int     uprintf(const char *, ...) __printflike(1, 2);
185int     vprintf(const char *, __va_list) __printflike(1, 0);
186int     vsnprintf(char *, size_t, const char *, __va_list) __printflike(3, 0);
187int     vsnrprintf(char *, size_t, int, const char *, __va_list) __printflike(4, 0);
188int     vsprintf(char *buf, const char *, __va_list) __printflike(2, 0);
189int     ttyprintf(struct tty *, const char *, ...) __printflike(2, 3);
190int     sscanf(const char *, char const *, ...) __nonnull(1) __nonnull(2);
191int     vsscanf(const char *, char const *, __va_list) __nonnull(1) __nonnull(2);
192long    strtol(const char *, char **, int) __nonnull(1);
193u_long  strtoul(const char *, char **, int) __nonnull(1);
194quad_t  strtoq(const char *, char **, int) __nonnull(1);
195u_quad_t strtouq(const char *, char **, int) __nonnull(1);
196void    tprintf(struct proc *p, int pri, const char *, ...) __printflike(3, 4);
197void    hexdump(const void *ptr, int length, const char *hdr, int flags);
198#define HD_COLUMN_MASK  0xff
199#define HD_DELIM_MASK   0xff00
200#define HD_OMIT_COUNT   (1 << 16)
201#define HD_OMIT_HEX     (1 << 17)
202#define HD_OMIT_CHARS   (1 << 18)
203
204#define ovbcopy(f, t, l) bcopy((f), (t), (l))
205void    bcopy(const void *from, void *to, size_t len) __nonnull(1) __nonnull(2);
206void    bzero(void *buf, size_t len) __nonnull(1);
207
208void    *memcpy(void *to, const void *from, size_t len) __nonnull(1) __nonnull(2);
209void    *memmove(void *dest, const void *src, size_t n) __nonnull(1) __nonnull(2);
210
211int     copystr(const void * __restrict kfaddr, void * __restrict kdaddr,
212            size_t len, size_t * __restrict lencopied)
213            __nonnull(1) __nonnull(2);
214int     copyinstr(const void * __restrict udaddr, void * __restrict kaddr,
215            size_t len, size_t * __restrict lencopied)
216            __nonnull(1) __nonnull(2);
217int     copyin(const void * __restrict udaddr, void * __restrict kaddr,
218            size_t len) __nonnull(1) __nonnull(2);
219int     copyout(const void * __restrict kaddr, void * __restrict udaddr,
220            size_t len) __nonnull(1) __nonnull(2);
221
222int     fubyte(const void *base);
223long    fuword(const void *base);
224int     fuword16(void *base);
225int32_t fuword32(const void *base);
226int64_t fuword64(const void *base);
227int     subyte(void *base, int byte);
228int     suword(void *base, long word);
229int     suword16(void *base, int word);
230int     suword32(void *base, int32_t word);
231int     suword64(void *base, int64_t word);
232uint32_t casuword32(volatile uint32_t *base, uint32_t oldval, uint32_t newval);
233u_long   casuword(volatile u_long *p, u_long oldval, u_long newval);
234
235void    realitexpire(void *);
236
237int     sysbeep(int hertz, int period);
238
239void    hardclock(int usermode, uintfptr_t pc);
240void    hardclock_cpu(int usermode);
241void    softclock(void *);
242void    statclock(int usermode);
243void    profclock(int usermode, uintfptr_t pc);
244
245void    startprofclock(struct proc *);
246void    stopprofclock(struct proc *);
247void    cpu_startprofclock(void);
248void    cpu_stopprofclock(void);
249
250int     cr_cansee(struct ucred *u1, struct ucred *u2);
251int     cr_canseesocket(struct ucred *cred, struct socket *so);
252int     cr_canseeinpcb(struct ucred *cred, struct inpcb *inp);
253
254char    *getenv(const char *name);
255void    freeenv(char *env);
256int     getenv_int(const char *name, int *data);
257int     getenv_uint(const char *name, unsigned int *data);
258int     getenv_long(const char *name, long *data);
259int     getenv_ulong(const char *name, unsigned long *data);
260int     getenv_string(const char *name, char *data, int size);
261int     getenv_quad(const char *name, quad_t *data);
262int     setenv(const char *name, const char *value);
263int     unsetenv(const char *name);
264int     testenv(const char *name);
265
266typedef uint64_t (cpu_tick_f)(void);
267void set_cputicker(cpu_tick_f *func, uint64_t freq, unsigned var);
268extern cpu_tick_f *cpu_ticks;
269uint64_t cpu_tickrate(void);
270uint64_t cputick2usec(uint64_t tick);
271
272#ifdef APM_FIXUP_CALLTODO
273struct timeval;
274void    adjust_timeout_calltodo(struct timeval *time_change);
275#endif /* APM_FIXUP_CALLTODO */
276
277#include <freebsd/sys/libkern.h>
278
279/* Initialize the world */
280void    consinit(void);
281void    cpu_initclocks(void);
282void    usrinfoinit(void);
283
284/* Finalize the world */
285void    shutdown_nice(int);
286
287/* Timeouts */
288typedef void timeout_t(void *); /* timeout function type */
289#define CALLOUT_HANDLE_INITIALIZER(handle)      \
290        { NULL }
291
292void    callout_handle_init(struct callout_handle *);
293struct  callout_handle timeout(timeout_t *, void *, int);
294void    untimeout(timeout_t *, void *, struct callout_handle);
295caddr_t kern_timeout_callwheel_alloc(caddr_t v);
296void    kern_timeout_callwheel_init(void);
297
298/* Stubs for obsolete functions that used to be for interrupt management */
299static __inline void            spl0(void)              { return; }
300static __inline intrmask_t      splbio(void)            { return 0; }
301static __inline intrmask_t      splcam(void)            { return 0; }
302static __inline intrmask_t      splclock(void)          { return 0; }
303static __inline intrmask_t      splhigh(void)           { return 0; }
304static __inline intrmask_t      splimp(void)            { return 0; }
305static __inline intrmask_t      splnet(void)            { return 0; }
306static __inline intrmask_t      splsoftcam(void)        { return 0; }
307static __inline intrmask_t      splsoftclock(void)      { return 0; }
308static __inline intrmask_t      splsofttty(void)        { return 0; }
309static __inline intrmask_t      splsoftvm(void)         { return 0; }
310static __inline intrmask_t      splsofttq(void)         { return 0; }
311static __inline intrmask_t      splstatclock(void)      { return 0; }
312static __inline intrmask_t      spltty(void)            { return 0; }
313static __inline intrmask_t      splvm(void)             { return 0; }
314static __inline void            splx(intrmask_t ipl __unused)   { return; }
315
316/*
317 * Common `proc' functions are declared here so that proc.h can be included
318 * less often.
319 */
320int     _sleep(void *chan, struct lock_object *lock, int pri, const char *wmesg,
321            int timo) __nonnull(1);
322#define msleep(chan, mtx, pri, wmesg, timo)                             \
323        _sleep((chan), &(mtx)->lock_object, (pri), (wmesg), (timo))
324int     msleep_spin(void *chan, struct mtx *mtx, const char *wmesg, int timo)
325            __nonnull(1);
326int     pause(const char *wmesg, int timo);
327#define tsleep(chan, pri, wmesg, timo)                                  \
328        _sleep((chan), NULL, (pri), (wmesg), (timo))
329void    wakeup(void *chan) __nonnull(1);
330void    wakeup_one(void *chan) __nonnull(1);
331
332/*
333 * Common `struct cdev *' stuff are declared here to avoid #include poisoning
334 */
335
336struct cdev;
337dev_t dev2udev(struct cdev *x);
338const char *devtoname(struct cdev *cdev);
339
340int poll_no_poll(int events);
341
342/* XXX: Should be void nanodelay(u_int nsec); */
343void    DELAY(int usec);
344
345/* Root mount holdback API */
346struct root_hold_token;
347
348struct root_hold_token *root_mount_hold(const char *identifier);
349void root_mount_rel(struct root_hold_token *h);
350void root_mount_wait(void);
351int root_mounted(void);
352
353
354/*
355 * Unit number allocation API. (kern/subr_unit.c)
356 */
357struct unrhdr;
358struct unrhdr *new_unrhdr(int low, int high, struct mtx *mutex);
359void delete_unrhdr(struct unrhdr *uh);
360void clean_unrhdr(struct unrhdr *uh);
361void clean_unrhdrl(struct unrhdr *uh);
362int alloc_unr(struct unrhdr *uh);
363int alloc_unrl(struct unrhdr *uh);
364void free_unr(struct unrhdr *uh, u_int item);
365
366/*
367 * This is about as magic as it gets.  fortune(1) has got similar code
368 * for reversing bits in a word.  Who thinks up this stuff??
369 *
370 * Yes, it does appear to be consistently faster than:
371 * while (i = ffs(m)) {
372 *      m >>= i;
373 *      bits++;
374 * }
375 * and
376 * while (lsb = (m & -m)) {     // This is magic too
377 *      m &= ~lsb;              // or: m ^= lsb
378 *      bits++;
379 * }
380 * Both of these latter forms do some very strange things on gcc-3.1 with
381 * -mcpu=pentiumpro and/or -march=pentiumpro and/or -O or -O2.
382 * There is probably an SSE or MMX popcnt instruction.
383 *
384 * I wonder if this should be in libkern?
385 *
386 * XXX Stop the presses!  Another one:
387 * static __inline u_int32_t
388 * popcnt1(u_int32_t v)
389 * {
390 *      v -= ((v >> 1) & 0x55555555);
391 *      v = (v & 0x33333333) + ((v >> 2) & 0x33333333);
392 *      v = (v + (v >> 4)) & 0x0F0F0F0F;
393 *      return (v * 0x01010101) >> 24;
394 * }
395 * The downside is that it has a multiply.  With a pentium3 with
396 * -mcpu=pentiumpro and -march=pentiumpro then gcc-3.1 will use
397 * an imull, and in that case it is faster.  In most other cases
398 * it appears slightly slower.
399 *
400 * Another variant (also from fortune):
401 * #define BITCOUNT(x) (((BX_(x)+(BX_(x)>>4)) & 0x0F0F0F0F) % 255)
402 * #define  BX_(x)     ((x) - (((x)>>1)&0x77777777)            \
403 *                          - (((x)>>2)&0x33333333)            \
404 *                          - (((x)>>3)&0x11111111))
405 */
406static __inline uint32_t
407bitcount32(uint32_t x)
408{
409
410        x = (x & 0x55555555) + ((x & 0xaaaaaaaa) >> 1);
411        x = (x & 0x33333333) + ((x & 0xcccccccc) >> 2);
412        x = (x + (x >> 4)) & 0x0f0f0f0f;
413        x = (x + (x >> 8));
414        x = (x + (x >> 16)) & 0x000000ff;
415        return (x);
416}
417
418#endif /* !_SYS_SYSTM_HH_ */
Note: See TracBrowser for help on using the repository browser.