2 * This software is part of the SBCL system. See the README file for
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.
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_
18 /*#define QSHOW */ /* Enable low-level debugging output? */
21 #define FSHOW(args) fprintf args
22 #define SHOW(string) FSHOW((stderr, "/%s\n", string))
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
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
38 #define QSHOW_SIGNALS 0
41 #define FSHOW_SIGNAL FSHOW
43 #define FSHOW_SIGNAL(args)
46 /* KLUDGE: These are in theory machine-dependent and OS-dependent, but
47 * in practice the "foo int" definitions work for all the machines
48 * that SBCL runs on as of 0.6.7. If we port to the Alpha or some
49 * other non-32-bit machine we'll probably need real machine-dependent
50 * and OS-dependent definitions again. */
51 /* even on alpha, int happens to be 4 bytes. long is longer. */
52 /* FIXME: these names really shouldn't reflect their length and this
53 is not quite right for some of the FFI stuff */
54 typedef unsigned long u64;
55 typedef signed long s64;
56 typedef unsigned int u32;
57 typedef signed int s32;
59 /* this is an integral type the same length as a machine pointer */
60 typedef unsigned long pointer_sized_uint_t ;
62 #include <sys/types.h>
64 #if defined(LISP_FEATURE_SB_THREAD)
66 typedef pthread_t os_thread_t;
68 typedef pid_t os_thread_t;
71 /* FIXME: we do things this way because of the alpha32 port. once
72 alpha64 has arrived, all this nastiness can go away */
74 #define LOW_WORD(c) ((pointer_sized_uint_t)c)
75 typedef unsigned long lispobj;
77 #define LOW_WORD(c) ((long)(c) & 0xFFFFFFFFL)
78 /* fake it on alpha32 */
79 typedef unsigned int lispobj;
83 lowtag_of(lispobj obj)
85 return obj & LOWTAG_MASK;
89 widetag_of(lispobj obj)
91 return obj & WIDETAG_MASK;
94 static inline unsigned long
95 HeaderValue(lispobj obj)
97 return obj >> N_WIDETAG_BITS;
100 static inline struct cons *
103 return (struct cons *)(obj - LIST_POINTER_LOWTAG);
106 static inline struct symbol *
109 return (struct symbol *)(obj - OTHER_POINTER_LOWTAG);
112 static inline struct fdefn *
115 return (struct fdefn *)(obj - OTHER_POINTER_LOWTAG);
118 /* Is the Lisp object obj something with pointer nature (as opposed to
119 * e.g. a fixnum or character or unbound marker)? */
121 is_lisp_pointer(lispobj obj)
128 /* Is the Lisp object obj something with immediate nature (e.g. a
129 * fixnum or character or unbound marker)? */
131 is_lisp_immediate(lispobj obj)
134 || (widetag_of(obj) == CHARACTER_WIDETAG)
135 #if N_WORD_BITS == 64
136 || (widetag_of(obj) == SINGLE_FLOAT_WIDETAG)
138 || (widetag_of(obj) == UNBOUND_MARKER_WIDETAG));
141 /* Convert from a lispobj with type bits to a native (ordinary
142 * C/assembly) pointer to the beginning of the object. */
143 static inline lispobj *
144 native_pointer(lispobj obj)
146 return (lispobj *) ((pointer_sized_uint_t) (obj & ~LOWTAG_MASK));
149 /* inverse operation: create a suitably tagged lispobj from a native
150 * pointer or integer.*/
151 static inline lispobj
152 make_lispobj(void *o, int low_tag)
154 return LOW_WORD(o) | low_tag;
157 static inline lispobj
160 return n << N_FIXNUM_TAG_BITS;
164 fixnum_value(lispobj n)
166 return n >> N_FIXNUM_TAG_BITS;
169 #if defined(LISP_FEATURE_WIN32)
170 /* KLUDGE: Avoid double definition of boolean by rpcndr.h included via
173 * FIXME: We should probably arrange to use the rpcndr.h boolean on Windows,
174 * or get rid of our own boolean type. If the boolean type is only used in
175 * the runtime, and never passed to Lisp, then it doesn't matter which one
178 #define boolean rpcndr_boolean
184 /* KLUDGE: As far as I can tell there's no ANSI C way of saying
185 * "this function never returns". This is the way that you do it
186 * in GCC later than version 2.5 or so. */
187 #if defined(__GNUC__)
188 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5)
189 #define never_returns __attribute__ ((noreturn))
191 #define never_returns
194 #define never_returns
197 extern void *successful_malloc (size_t size);
198 extern char *copied_string (char *string);
200 #define RUNTIME_OPTIONS_MAGIC 0x31EBF355
201 /* 1 for magic, 1 for boolean, 2 for struct runtime_options fields */
202 #define RUNTIME_OPTIONS_WORDS (1 + 1 + 2)
204 struct runtime_options {
205 size_t dynamic_space_size;
206 size_t thread_control_stack_size;
209 #endif /* _SBCL_RUNTIME_H_ */