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 #if defined(LISP_FEATURE_SB_THREAD)
19 #define thread_self() pthread_self()
20 #define thread_kill pthread_kill
21 #define thread_sigmask pthread_sigmask
22 #define thread_mutex_lock(l) pthread_mutex_lock(l)
23 #define thread_mutex_unlock(l) pthread_mutex_unlock(l)
25 #define thread_self() 0
26 #define thread_kill kill_safely
27 #define thread_sigmask sigprocmask
28 #define thread_mutex_lock(l) 0
29 #define thread_mutex_unlock(l) 0
32 #if defined(LISP_FEATURE_SB_SAFEPOINT)
35 int check_pending_interrupts();
39 * The next few defines serve as configuration -- edit them inline if
40 * you are a developer and want to affect FSHOW behaviour.
43 /* Block blockable interrupts for each SHOW, if not 0.
44 * (On Windows, this setting has no effect.)
46 * In principle, this is a "configuration option", but I am not aware of
47 * any reason why or when it would be advantageous to disable it. */
48 #define QSHOW_SIGNAL_SAFE 1
50 /* Enable extra-verbose low-level debugging output for signals? (You
51 * probably don't want this unless you're trying to debug very early
52 * cold boot on a new machine, or one where you've just messed up
55 * Note: It may be that doing this is fundamentally unsound, since it
56 * causes output from signal handlers, and the i/o libraries aren't
57 * necessarily reentrant. But it can still be very convenient for
58 * figuring out what's going on when you have a signal handling
61 * Possible values are:
62 * 0 -- Never show signal-related output. There is absolutely no
63 * run-time overhead from FSHOW_SIGNAL in this case.
66 * Show signal-related output only if selected at run-time
67 * (otherwise almost no run-time overhead).
69 * 2 -- Unconditionally show signal-related output.
70 * Very significant overhead.
72 * For reasons of tradition, we default to 0 on POSIX and 1 on Windows
75 * With option 1, set up environment variable SBCL_DYNDEBUG to include
76 * "fshow" or "fshow_signal" before starting SBCL to enable output.
78 * There is no particular advantage to option 2 except that you do not
79 * need to set environment variables in this case.
81 #ifdef LISP_FEATURE_SB_QSHOW
82 # define QSHOW_SIGNALS 1
84 # define QSHOW_SIGNALS 0
87 /* Enable low-level debugging output, if not zero. Defaults to enabled
88 * if QSHOW_SIGNALS, disabled otherwise. Change it to 1 or 2 if you want
89 * low-level debugging output but not the whole signal mess. */
90 #define QSHOW QSHOW_SIGNALS
93 * Configuration options end here -- the following defines do not
94 * generally need customization.
97 #define odxprint(topic, fmt, ...) \
99 if (dyndebug_config.dyndebug_##topic) \
100 odxprint_fun(fmt "\n", ##__VA_ARGS__); \
103 void odxprint_fun(const char *fmt, ...);
104 void fshow_fun(void *ignored, const char *fmt, ...);
106 /* Flags defined in a structure to avoid code duplication between
107 * declaration and definition. */
108 extern struct dyndebug_config {
110 int dyndebug_fshow_signal;
111 int dyndebug_gencgc_verbose;
112 int dyndebug_safepoints;
115 int dyndebug_pagefaults;
118 #ifdef LISP_FEATURE_GENCGC
119 extern int gencgc_verbose;
122 void dyndebug_init(void);
124 #if QSHOW_SIGNAL_SAFE == 1 && !defined(LISP_FEATURE_WIN32)
127 extern sigset_t blockable_sigset;
129 #define QSHOW_BLOCK \
131 thread_sigmask(SIG_BLOCK, &blockable_sigset, &oldset)
132 #define QSHOW_UNBLOCK thread_sigmask(SIG_SETMASK,&oldset,0)
135 #define QSHOW_UNBLOCK
138 /* The following macros duplicate the expansion of odxprint, because the
139 * extra level of parentheses around `args' prevents us from
140 * implementing FSHOW in terms of odxprint directly. (They also differ
145 # define FSHOW(args) \
146 do if (dyndebug_config.dyndebug_fshow) fshow_fun args; while (0)
147 # define SHOW(string) FSHOW((stderr, "/%s\n", string))
150 # define SHOW(string)
154 # define FSHOW_SIGNAL(args) \
155 do if (dyndebug_config.dyndebug_fshow_signal) fshow_fun args; while (0)
157 # define FSHOW_SIGNAL(args)
160 /* KLUDGE: These are in theory machine-dependent and OS-dependent, but
161 * in practice the "foo int" definitions work for all the machines
162 * that SBCL runs on as of 0.6.7. If we port to the Alpha or some
163 * other non-32-bit machine we'll probably need real machine-dependent
164 * and OS-dependent definitions again. */
165 /* even on alpha, int happens to be 4 bytes. long is longer. */
166 /* FIXME: these names really shouldn't reflect their length and this
167 is not quite right for some of the FFI stuff */
168 typedef unsigned long u64;
169 typedef signed long s64;
170 typedef unsigned int u32;
171 typedef signed int s32;
173 /* this is an integral type the same length as a machine pointer */
174 typedef unsigned long pointer_sized_uint_t ;
176 #include <sys/types.h>
178 #if defined(LISP_FEATURE_SB_THREAD)
180 typedef pthread_t os_thread_t;
182 typedef pid_t os_thread_t;
185 /* FIXME: we do things this way because of the alpha32 port. once
186 alpha64 has arrived, all this nastiness can go away */
187 #if 64 == N_WORD_BITS
188 #define LOW_WORD(c) ((pointer_sized_uint_t)c)
189 #define OBJ_FMTX "lx"
190 typedef unsigned long lispobj;
193 #define LOW_WORD(c) ((long)(c) & 0xFFFFFFFFL)
194 /* fake it on alpha32 */
195 typedef unsigned int lispobj;
199 lowtag_of(lispobj obj)
201 return obj & LOWTAG_MASK;
205 widetag_of(lispobj obj)
207 return obj & WIDETAG_MASK;
210 static inline unsigned long
211 HeaderValue(lispobj obj)
213 return obj >> N_WIDETAG_BITS;
216 static inline struct cons *
219 return (struct cons *)(obj - LIST_POINTER_LOWTAG);
222 static inline struct symbol *
225 return (struct symbol *)(obj - OTHER_POINTER_LOWTAG);
228 static inline struct fdefn *
231 return (struct fdefn *)(obj - OTHER_POINTER_LOWTAG);
234 /* Is the Lisp object obj something with pointer nature (as opposed to
235 * e.g. a fixnum or character or unbound marker)? */
237 is_lisp_pointer(lispobj obj)
239 #if N_WORD_BITS == 64
240 return (obj & 3) == 3;
248 /* Is the Lisp object obj something with immediate nature (e.g. a
249 * fixnum or character or unbound marker)? */
251 is_lisp_immediate(lispobj obj)
254 || (widetag_of(obj) == CHARACTER_WIDETAG)
255 #if N_WORD_BITS == 64
256 || (widetag_of(obj) == SINGLE_FLOAT_WIDETAG)
258 || (widetag_of(obj) == UNBOUND_MARKER_WIDETAG));
261 /* Convert from a lispobj with type bits to a native (ordinary
262 * C/assembly) pointer to the beginning of the object. */
263 static inline lispobj *
264 native_pointer(lispobj obj)
266 return (lispobj *) ((pointer_sized_uint_t) (obj & ~LOWTAG_MASK));
269 /* inverse operation: create a suitably tagged lispobj from a native
270 * pointer or integer.*/
271 static inline lispobj
272 make_lispobj(void *o, int low_tag)
274 return LOW_WORD(o) | low_tag;
277 #define MAKE_FIXNUM(n) (n << N_FIXNUM_TAG_BITS)
278 static inline lispobj
281 return MAKE_FIXNUM(n);
285 fixnum_value(lispobj n)
287 return n >> N_FIXNUM_TAG_BITS;
290 #if defined(LISP_FEATURE_WIN32)
291 /* KLUDGE: Avoid double definition of boolean by rpcndr.h included via
294 * FIXME: We should probably arrange to use the rpcndr.h boolean on Windows,
295 * or get rid of our own boolean type. If the boolean type is only used in
296 * the runtime, and never passed to Lisp, then it doesn't matter which one
299 #define boolean rpcndr_boolean
305 static inline boolean
306 other_immediate_lowtag_p(lispobj header)
308 /* These lowtags are spaced 4 apart throughout the lowtag space. */
309 return (lowtag_of(header) & 3) == OTHER_IMMEDIATE_0_LOWTAG;
312 /* KLUDGE: As far as I can tell there's no ANSI C way of saying
313 * "this function never returns". This is the way that you do it
314 * in GCC later than version 2.5 or so. */
315 #if defined(__GNUC__)
316 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5)
317 #define never_returns __attribute__ ((noreturn))
319 #define never_returns
322 #define never_returns
325 extern void *successful_malloc (size_t size);
326 extern char *copied_string (char *string);
328 #if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_SB_SAFEPOINT)
329 # define THREADS_USING_GCSIGNAL 1
332 #endif /* _SBCL_RUNTIME_H_ */