88d6ca91e5cbc1230474b87dd98f61e9b10e7ab0
[sbcl.git] / src / runtime / runtime.h
1 /*
2  * This software is part of the SBCL system. See the README file for
3  * more information.
4  *
5  * This software is derived from the CMU CL system, which was
6  * written at Carnegie Mellon University and released into the
7  * public domain. The software is in the public domain and is
8  * provided with absolutely no warranty. See the COPYING and CREDITS
9  * files for more information.
10  */
11
12 /* FIXME: Aren't symbols with underscore prefixes supposed to be
13  * reserved for system libraries? Perhaps rename stuff like this
14  * to names like INCLUDED_SBCL_RUNTIME_H. */
15 #ifndef _SBCL_RUNTIME_H_
16 #define _SBCL_RUNTIME_H_
17
18 /*#define QSHOW */ /* Enable low-level debugging output? */
19
20 #ifdef QSHOW
21 #define FSHOW(args) fprintf args
22 #define SHOW(string) FSHOW((stderr, "/%s\n", string))
23 #else
24 #define FSHOW(args)
25 #define SHOW(string)
26 #endif
27
28 /* Enable extra-verbose low-level debugging output for signals? (You
29  * probably don't want this unless you're trying to debug very early
30  * cold boot on a new machine, or one where you've just messed up
31  * signal handling.)
32  *
33  * Note: It may be that doing this is fundamentally unsound, since it
34  * causes output from signal handlers, and the i/o libraries aren't
35  * necessarily reentrant. But it can still be very convenient for
36  * figuring out what's going on when you have a signal handling
37  * problem.. */
38 #define QSHOW_SIGNALS 0
39
40 /* FIXME: Make HeaderValue, CONS, SYMBOL, and FDEFN into inline
41  * functions instead of macros. */
42
43 #define HeaderValue(obj) ((unsigned long) ((obj) >> N_WIDETAG_BITS))
44
45 #define CONS(obj) ((struct cons *)((obj)-LIST_POINTER_LOWTAG))
46 #define SYMBOL(obj) ((struct symbol *)((obj)-OTHER_POINTER_LOWTAG))
47 #define FDEFN(obj) ((struct fdefn *)((obj)-OTHER_POINTER_LOWTAG))
48
49 /* KLUDGE: These are in theory machine-dependent and OS-dependent, but
50  * in practice the "foo int" definitions work for all the machines
51  * that SBCL runs on as of 0.6.7. If we port to the Alpha or some
52  * other non-32-bit machine we'll probably need real machine-dependent
53  * and OS-dependent definitions again. */
54 /* even on alpha, int happens to be 4 bytes.  long is longer. */
55 typedef unsigned int u32;
56 typedef signed int s32;
57 #define LOW_WORD(c) ((long)(c) & 0xFFFFFFFFL)
58 /* this is an integral type the same length as a machine pointer */
59 typedef unsigned long pointer_sized_uint_t ;
60
61 typedef u32 lispobj;
62
63 static inline int
64 lowtag_of(lispobj obj) {
65     return obj & LOWTAG_MASK;
66 }
67
68 static inline int
69 widetag_of(lispobj obj) {
70     return obj & WIDETAG_MASK;
71 }
72
73 /* Is the Lisp object obj something with pointer nature (as opposed to
74  * e.g. a fixnum or character or unbound marker)? */
75 static inline int
76 is_lisp_pointer(lispobj obj)
77 {
78     return obj & 1;
79 }
80
81 /* Convert from a lispobj with type bits to a native (ordinary
82  * C/assembly) pointer to the beginning of the object. */
83 static inline lispobj *
84 native_pointer(lispobj obj)
85 {
86     return (lispobj *) ((pointer_sized_uint_t) (obj & ~LOWTAG_MASK));
87 }
88 /* inverse operation: create a suitably tagged lispobj from a native
89  * pointer or integer.  Needs to be a macro due to the tedious C type
90  * system */
91 #define make_lispobj(o,low_tag) ((lispobj)(LOW_WORD(o)|low_tag))
92
93 /* FIXME: There seems to be no reason that make_fixnum and fixnum_value
94  * can't be implemented as (possibly inline) functions. */
95 #define make_fixnum(n) ((lispobj)((n)<<N_FIXNUM_TAG_BITS))
96 #define fixnum_value(n) (((long)n)>>N_FIXNUM_TAG_BITS)
97
98 /* Too bad ANSI C doesn't define "bool" as C++ does.. */
99 typedef int boolean;
100
101 /* This only works for static symbols. */
102 /* FIXME: should be called StaticSymbolFunction, right? */
103 #define SymbolFunction(sym) \
104     (((struct fdefn *)(native_pointer(SymbolValue(sym,0))))->fun)
105
106 /* KLUDGE: As far as I can tell there's no ANSI C way of saying
107  * "this function never returns". This is the way that you do it
108  * in GCC later than version 2.7 or so. If you are using some 
109  * compiler that doesn't understand this, you could could just
110  * change it to "typedef void never_returns" and nothing would
111  * break, though you might get a few more bytes of compiled code or
112  * a few more compiler warnings. -- WHN 2000-10-21 */
113 typedef volatile void never_returns;
114
115 #endif /* _SBCL_RUNTIME_H_ */