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 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD)
  19 # include "pthreads_win32.h"
  20 #else
  21 # include <signal.h>
  22 # ifdef LISP_FEATURE_SB_THREAD
  23 #  include <pthread.h>
  24 # endif
  25 #endif
  26
  27 #include <stdint.h>
  28
  29 #if defined(LISP_FEATURE_SB_THREAD)
  30 #define thread_self() pthread_self()
  31 #define thread_kill pthread_kill
  32 #define thread_sigmask pthread_sigmask
  33 #define thread_mutex_lock(l) pthread_mutex_lock(l)
  34 #define thread_mutex_unlock(l) pthread_mutex_unlock(l)
  35 #else
  36 #define thread_self() 0
  37 #define thread_kill kill_safely
  38 #define thread_sigmask sigprocmask
  39 #define thread_mutex_lock(l) 0
  40 #define thread_mutex_unlock(l) 0
  41 #endif
  42
  43 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD)
  44 void os_preinit();
  45 #endif
  46
  47 #if defined(LISP_FEATURE_SB_SAFEPOINT)
  48 void map_gc_page();
  49 void unmap_gc_page();
  50 int check_pending_interrupts();
  51 #endif
  52
  53 /*
  54  * The next few defines serve as configuration -- edit them inline if
  55  * you are a developer and want to affect FSHOW behaviour.
  56  */
  57
  58 /* Block blockable interrupts for each SHOW, if not 0.
  59  * (On Windows, this setting has no effect.)
  60  *
  61  * In principle, this is a "configuration option", but I am not aware of
  62  * any reason why or when it would be advantageous to disable it. */
  63 #define QSHOW_SIGNAL_SAFE 1
  64
  65 /* Enable extra-verbose low-level debugging output for signals? (You
  66  * probably don't want this unless you're trying to debug very early
  67  * cold boot on a new machine, or one where you've just messed up
  68  * signal handling.)
  69  *
  70  * Note: It may be that doing this is fundamentally unsound, since it
  71  * causes output from signal handlers, and the i/o libraries aren't
  72  * necessarily reentrant. But it can still be very convenient for
  73  * figuring out what's going on when you have a signal handling
  74  * problem.
  75  *
  76  * Possible values are:
  77  *   0 -- Never show signal-related output.  There is absolutely no
  78  *        run-time overhead from FSHOW_SIGNAL in this case.
  79  *
  80  *   1 -- (recommended)
  81  *        Show signal-related output only if selected at run-time
  82  *        (otherwise almost no run-time overhead).
  83  *
  84  *   2 -- Unconditionally show signal-related output.
  85  *        Very significant overhead.
  86  *
  87  * For reasons of tradition, we default to 0 on POSIX and 1 on Windows
  88  * through :SB-QSHOW.
  89  *
  90  * With option 1, set up environment variable SBCL_DYNDEBUG to include
  91  * "fshow" or "fshow_signal" before starting SBCL to enable output.
  92  *
  93  * There is no particular advantage to option 2 except that you do not
  94  * need to set environment variables in this case.
  95  */
  96 #ifdef LISP_FEATURE_SB_QSHOW
  97 # define QSHOW_SIGNALS 1
  98 #else
  99 # define QSHOW_SIGNALS 0
 100 #endif
 101
 102 /* Enable low-level debugging output, if not zero. Defaults to enabled
 103  * if QSHOW_SIGNALS, disabled otherwise. Change it to 1 or 2 if you want
 104  * low-level debugging output but not the whole signal mess. */
 105 #define QSHOW QSHOW_SIGNALS
 106
 107 /*
 108  * Configuration options end here -- the following defines do not
 109  * generally need customization.
 110  */
 111
 112 #define odxprint(topic, fmt, ...)                       \
 113     do                                                  \
 114         if (dyndebug_config.dyndebug_##topic)           \
 115             odxprint_fun(fmt "\n", ##__VA_ARGS__);      \
 116     while (0)
 117
 118 void odxprint_fun(const char *fmt, ...);
 119 void fshow_fun(void *ignored, const char *fmt, ...);
 120
 121 /* Flags defined in a structure to avoid code duplication between
 122  * declaration and definition. */
 123 extern struct dyndebug_config {
 124     int dyndebug_fshow;
 125     int dyndebug_fshow_signal;
 126     int dyndebug_gencgc_verbose;
 127     int dyndebug_safepoints;
 128     int dyndebug_seh;
 129     int dyndebug_misc;
 130     int dyndebug_pagefaults;
 131     int dyndebug_backtrace_when_lost;
 132     int dyndebug_sleep_when_lost;
 133 } dyndebug_config;
 134
 135 #ifdef LISP_FEATURE_GENCGC
 136 extern int gencgc_verbose;
 137 #endif
 138
 139 void dyndebug_init(void);
 140
 141 #if QSHOW_SIGNAL_SAFE == 1 && !defined(LISP_FEATURE_WIN32)
 142
 143 extern sigset_t blockable_sigset;
 144
 145 #define QSHOW_BLOCK                                             \
 146         sigset_t oldset;                                        \
 147         thread_sigmask(SIG_BLOCK, &blockable_sigset, &oldset)
 148 #define QSHOW_UNBLOCK thread_sigmask(SIG_SETMASK,&oldset,0)
 149 #else
 150 #define QSHOW_BLOCK
 151 #define QSHOW_UNBLOCK
 152 #endif
 153
 154 /* The following macros duplicate the expansion of odxprint, because the
 155  * extra level of parentheses around `args' prevents us from
 156  * implementing FSHOW in terms of odxprint directly.  (They also differ
 157  * in a newline.)
 158  */
 159
 160 #if QSHOW
 161 # define FSHOW(args) \
 162     do if (dyndebug_config.dyndebug_fshow) fshow_fun args; while (0)
 163 # define SHOW(string) FSHOW((stderr, "/%s\n", string))
 164 #else
 165 # define FSHOW(args)
 166 # define SHOW(string)
 167 #endif
 168
 169 #if QSHOW_SIGNALS
 170 # define FSHOW_SIGNAL(args)                                             \
 171     do if (dyndebug_config.dyndebug_fshow_signal) fshow_fun args; while (0)
 172 #else
 173 # define FSHOW_SIGNAL(args)
 174 #endif
 175
 176 /* KLUDGE: These are in theory machine-dependent and OS-dependent, but
 177  * in practice the "foo int" definitions work for all the machines
 178  * that SBCL runs on as of 0.6.7. If we port to the Alpha or some
 179  * other non-32-bit machine we'll probably need real machine-dependent
 180  * and OS-dependent definitions again. */
 181 /* even on alpha, int happens to be 4 bytes.  long is longer. */
 182 /* FIXME: these names really shouldn't reflect their length and this
 183    is not quite right for some of the FFI stuff */
 184 typedef unsigned long u64;
 185 typedef signed long s64;
 186 typedef unsigned int u32;
 187 typedef signed int s32;
 188
 189 /* this is an integral type the same length as a machine pointer */
 190 typedef unsigned long pointer_sized_uint_t ;
 191
 192 #include <sys/types.h>
 193
 194 #if defined(LISP_FEATURE_SB_THREAD)
 195 typedef pthread_t os_thread_t;
 196 #else
 197 typedef pid_t os_thread_t;
 198 #endif
 199
 200 /* FIXME: we do things this way because of the alpha32 port.  once
 201    alpha64 has arrived, all this nastiness can go away */
 202 #if 64 == N_WORD_BITS
 203 #define LOW_WORD(c) ((pointer_sized_uint_t)c)
 204 #define OBJ_FMTX "lx"
 205 typedef unsigned long lispobj;
 206 #else
 207 #define OBJ_FMTX "x"
 208 #define LOW_WORD(c) ((long)(c) & 0xFFFFFFFFL)
 209 /* fake it on alpha32 */
 210 typedef unsigned int lispobj;
 211 #endif
 212
 213 static inline int
 214 lowtag_of(lispobj obj)
 215 {
 216     return obj & LOWTAG_MASK;
 217 }
 218
 219 static inline int
 220 widetag_of(lispobj obj)
 221 {
 222     return obj & WIDETAG_MASK;
 223 }
 224
 225 static inline unsigned long
 226 HeaderValue(lispobj obj)
 227 {
 228   return obj >> N_WIDETAG_BITS;
 229 }
 230
 231 static inline struct cons *
 232 CONS(lispobj obj)
 233 {
 234   return (struct cons *)(obj - LIST_POINTER_LOWTAG);
 235 }
 236
 237 static inline struct symbol *
 238 SYMBOL(lispobj obj)
 239 {
 240   return (struct symbol *)(obj - OTHER_POINTER_LOWTAG);
 241 }
 242
 243 static inline struct fdefn *
 244 FDEFN(lispobj obj)
 245 {
 246   return (struct fdefn *)(obj - OTHER_POINTER_LOWTAG);
 247 }
 248
 249 /* Is the Lisp object obj something with pointer nature (as opposed to
 250  * e.g. a fixnum or character or unbound marker)? */
 251 static inline int
 252 is_lisp_pointer(lispobj obj)
 253 {
 254 #if N_WORD_BITS == 64
 255     return (obj & 3) == 3;
 256 #else
 257     return obj & 1;
 258 #endif
 259 }
 260
 261 #include "fixnump.h"
 262
 263 /* Is the Lisp object obj something with immediate nature (e.g. a
 264  * fixnum or character or unbound marker)? */
 265 static inline int
 266 is_lisp_immediate(lispobj obj)
 267 {
 268     return (fixnump(obj)
 269             || (widetag_of(obj) == CHARACTER_WIDETAG)
 270 #if N_WORD_BITS == 64
 271             || (widetag_of(obj) == SINGLE_FLOAT_WIDETAG)
 272 #endif
 273             || (widetag_of(obj) == UNBOUND_MARKER_WIDETAG));
 274 }
 275
 276 /* Convert from a lispobj with type bits to a native (ordinary
 277  * C/assembly) pointer to the beginning of the object. */
 278 static inline lispobj *
 279 native_pointer(lispobj obj)
 280 {
 281     return (lispobj *) ((pointer_sized_uint_t) (obj & ~LOWTAG_MASK));
 282 }
 283
 284 /* inverse operation: create a suitably tagged lispobj from a native
 285  * pointer or integer.*/
 286 static inline lispobj
 287 make_lispobj(void *o, int low_tag)
 288 {
 289     return LOW_WORD(o) | low_tag;
 290 }
 291
 292 #define MAKE_FIXNUM(n) (n << N_FIXNUM_TAG_BITS)
 293 static inline lispobj
 294 make_fixnum(long n)
 295 {
 296     return MAKE_FIXNUM(n);
 297 }
 298
 299 static inline long
 300 fixnum_value(lispobj n)
 301 {
 302     return n >> N_FIXNUM_TAG_BITS;
 303 }
 304
 305 #if defined(LISP_FEATURE_WIN32)
 306 /* KLUDGE: Avoid double definition of boolean by rpcndr.h included via
 307  * shlobj.h.
 308  *
 309  * FIXME: We should probably arrange to use the rpcndr.h boolean on Windows,
 310  * or get rid of our own boolean type.  If the boolean type is only used in
 311  * the runtime, and never passed to Lisp, then it doesn't matter which one
 312  * we use.
 313  */
 314 #define boolean rpcndr_boolean
 315 #include <shlobj.h>
 316 #undef boolean
 317 #endif
 318 typedef int boolean;
 319
 320 static inline boolean
 321 other_immediate_lowtag_p(lispobj header)
 322 {
 323     /* These lowtags are spaced 4 apart throughout the lowtag space. */
 324     return (lowtag_of(header) & 3) == OTHER_IMMEDIATE_0_LOWTAG;
 325 }
 326
 327 /* KLUDGE: As far as I can tell there's no ANSI C way of saying
 328  * "this function never returns". This is the way that you do it
 329  * in GCC later than version 2.5 or so. */
 330 #if defined(__GNUC__)
 331 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5)
 332 #define never_returns __attribute__ ((noreturn))
 333 #else
 334 #define never_returns
 335 #endif
 336 #else
 337 #define never_returns
 338 #endif
 339
 340 extern void *successful_malloc (size_t size);
 341 extern char *copied_string (char *string);
 342
 343 #if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_SB_SAFEPOINT)
 344 # define THREADS_USING_GCSIGNAL 1
 345 #endif
 346
 347 /* Now that SPARC has precise GENCGC, several places that used to be
 348  * #ifdef PCC need adjustment.  Clearly, "PPC or SPARC" is as unhelpful
 349  * a test as its reverse, "x86 or x86-64".  However, the feature
 350  * commonly used to differentiate between those two worlds is
 351  * C_STACK_IS_CONTROL_STACK, and clearly (or at least in my humble
 352  * opinion), at some point we'd like to have precise GC on x86 while
 353  * still sharing the C stack, so stack usage ought not imply GC
 354  * conservativeness.  So let's have a helper feature that makes the code
 355  * a bit more future-proof, even if it is itself currently defined in
 356  * the naive way: */
 357 #if defined(LISP_FEATURE_GENCGC) && !defined(LISP_FEATURE_C_STACK_IS_CONTROL_STACK)
 358 # define GENCGC_IS_PRECISE 1
 359 #endif
 360
 361 #endif /* _SBCL_RUNTIME_H_ */