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     int dyndebug_io;
 134 } dyndebug_config;
 135
 136 #ifdef LISP_FEATURE_GENCGC
 137 extern int gencgc_verbose;
 138 #endif
 139
 140 void dyndebug_init(void);
 141
 142 #if QSHOW_SIGNAL_SAFE == 1 && !defined(LISP_FEATURE_WIN32)
 143
 144 extern sigset_t blockable_sigset;
 145
 146 #define QSHOW_BLOCK                                             \
 147         sigset_t oldset;                                        \
 148         thread_sigmask(SIG_BLOCK, &blockable_sigset, &oldset)
 149 #define QSHOW_UNBLOCK thread_sigmask(SIG_SETMASK,&oldset,0)
 150 #else
 151 #define QSHOW_BLOCK
 152 #define QSHOW_UNBLOCK
 153 #endif
 154
 155 /* The following macros duplicate the expansion of odxprint, because the
 156  * extra level of parentheses around `args' prevents us from
 157  * implementing FSHOW in terms of odxprint directly.  (They also differ
 158  * in a newline.)
 159  */
 160
 161 #if QSHOW
 162 # define FSHOW(args) \
 163     do if (dyndebug_config.dyndebug_fshow) fshow_fun args; while (0)
 164 # define SHOW(string) FSHOW((stderr, "/%s\n", string))
 165 #else
 166 # define FSHOW(args)
 167 # define SHOW(string)
 168 #endif
 169
 170 #if QSHOW_SIGNALS
 171 # define FSHOW_SIGNAL(args)                                             \
 172     do if (dyndebug_config.dyndebug_fshow_signal) fshow_fun args; while (0)
 173 #else
 174 # define FSHOW_SIGNAL(args)
 175 #endif
 176
 177 /* KLUDGE: These are in theory machine-dependent and OS-dependent, but
 178  * in practice the "foo int" definitions work for all the machines
 179  * that SBCL runs on as of 0.6.7. If we port to the Alpha or some
 180  * other non-32-bit machine we'll probably need real machine-dependent
 181  * and OS-dependent definitions again. */
 182 /* even on alpha, int happens to be 4 bytes.  long is longer. */
 183 /* FIXME: these names really shouldn't reflect their length and this
 184    is not quite right for some of the FFI stuff */
 185 typedef unsigned long u64;
 186 typedef signed long s64;
 187 typedef unsigned int u32;
 188 typedef signed int s32;
 189
 190 /* this is an integral type the same length as a machine pointer */
 191 typedef unsigned long pointer_sized_uint_t ;
 192
 193 #include <sys/types.h>
 194
 195 #if defined(LISP_FEATURE_SB_THREAD)
 196 typedef pthread_t os_thread_t;
 197 #else
 198 typedef pid_t os_thread_t;
 199 #endif
 200
 201 /* FIXME: we do things this way because of the alpha32 port.  once
 202    alpha64 has arrived, all this nastiness can go away */
 203 #if 64 == N_WORD_BITS
 204 #define LOW_WORD(c) ((pointer_sized_uint_t)c)
 205 #define OBJ_FMTX "lx"
 206 typedef unsigned long lispobj;
 207 #else
 208 #define OBJ_FMTX "x"
 209 #define LOW_WORD(c) ((long)(c) & 0xFFFFFFFFL)
 210 /* fake it on alpha32 */
 211 typedef unsigned int lispobj;
 212 #endif
 213
 214 static inline int
 215 lowtag_of(lispobj obj)
 216 {
 217     return obj & LOWTAG_MASK;
 218 }
 219
 220 static inline int
 221 widetag_of(lispobj obj)
 222 {
 223     return obj & WIDETAG_MASK;
 224 }
 225
 226 static inline unsigned long
 227 HeaderValue(lispobj obj)
 228 {
 229   return obj >> N_WIDETAG_BITS;
 230 }
 231
 232 static inline struct cons *
 233 CONS(lispobj obj)
 234 {
 235   return (struct cons *)(obj - LIST_POINTER_LOWTAG);
 236 }
 237
 238 static inline struct symbol *
 239 SYMBOL(lispobj obj)
 240 {
 241   return (struct symbol *)(obj - OTHER_POINTER_LOWTAG);
 242 }
 243
 244 static inline struct fdefn *
 245 FDEFN(lispobj obj)
 246 {
 247   return (struct fdefn *)(obj - OTHER_POINTER_LOWTAG);
 248 }
 249
 250 /* Is the Lisp object obj something with pointer nature (as opposed to
 251  * e.g. a fixnum or character or unbound marker)? */
 252 static inline int
 253 is_lisp_pointer(lispobj obj)
 254 {
 255 #if N_WORD_BITS == 64
 256     return (obj & 3) == 3;
 257 #else
 258     return obj & 1;
 259 #endif
 260 }
 261
 262 #include "fixnump.h"
 263
 264 /* Is the Lisp object obj something with immediate nature (e.g. a
 265  * fixnum or character or unbound marker)? */
 266 static inline int
 267 is_lisp_immediate(lispobj obj)
 268 {
 269     return (fixnump(obj)
 270             || (widetag_of(obj) == CHARACTER_WIDETAG)
 271 #if N_WORD_BITS == 64
 272             || (widetag_of(obj) == SINGLE_FLOAT_WIDETAG)
 273 #endif
 274             || (widetag_of(obj) == UNBOUND_MARKER_WIDETAG));
 275 }
 276
 277 /* Convert from a lispobj with type bits to a native (ordinary
 278  * C/assembly) pointer to the beginning of the object. */
 279 static inline lispobj *
 280 native_pointer(lispobj obj)
 281 {
 282     return (lispobj *) ((pointer_sized_uint_t) (obj & ~LOWTAG_MASK));
 283 }
 284
 285 /* inverse operation: create a suitably tagged lispobj from a native
 286  * pointer or integer.*/
 287 static inline lispobj
 288 make_lispobj(void *o, int low_tag)
 289 {
 290     return LOW_WORD(o) | low_tag;
 291 }
 292
 293 #define MAKE_FIXNUM(n) (n << N_FIXNUM_TAG_BITS)
 294 static inline lispobj
 295 make_fixnum(long n)
 296 {
 297     return MAKE_FIXNUM(n);
 298 }
 299
 300 static inline long
 301 fixnum_value(lispobj n)
 302 {
 303     return n >> N_FIXNUM_TAG_BITS;
 304 }
 305
 306 #if defined(LISP_FEATURE_WIN32)
 307 /* KLUDGE: Avoid double definition of boolean by rpcndr.h included via
 308  * shlobj.h.
 309  *
 310  * FIXME: We should probably arrange to use the rpcndr.h boolean on Windows,
 311  * or get rid of our own boolean type.  If the boolean type is only used in
 312  * the runtime, and never passed to Lisp, then it doesn't matter which one
 313  * we use.
 314  */
 315 #define boolean rpcndr_boolean
 316 #include <shlobj.h>
 317 #undef boolean
 318 #endif
 319 typedef int boolean;
 320
 321 static inline boolean
 322 other_immediate_lowtag_p(lispobj header)
 323 {
 324     /* These lowtags are spaced 4 apart throughout the lowtag space. */
 325     return (lowtag_of(header) & 3) == OTHER_IMMEDIATE_0_LOWTAG;
 326 }
 327
 328 /* KLUDGE: As far as I can tell there's no ANSI C way of saying
 329  * "this function never returns". This is the way that you do it
 330  * in GCC later than version 2.5 or so. */
 331 #if defined(__GNUC__)
 332 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5)
 333 #define never_returns __attribute__ ((noreturn))
 334 #else
 335 #define never_returns
 336 #endif
 337 #else
 338 #define never_returns
 339 #endif
 340
 341 extern void *successful_malloc (size_t size);
 342 extern char *copied_string (char *string);
 343
 344 #if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_SB_SAFEPOINT)
 345 # define THREADS_USING_GCSIGNAL 1
 346 #endif
 347
 348 /* Now that SPARC has precise GENCGC, several places that used to be
 349  * #ifdef PCC need adjustment.  Clearly, "PPC or SPARC" is as unhelpful
 350  * a test as its reverse, "x86 or x86-64".  However, the feature
 351  * commonly used to differentiate between those two worlds is
 352  * C_STACK_IS_CONTROL_STACK, and clearly (or at least in my humble
 353  * opinion), at some point we'd like to have precise GC on x86 while
 354  * still sharing the C stack, so stack usage ought not imply GC
 355  * conservativeness.  So let's have a helper feature that makes the code
 356  * a bit more future-proof, even if it is itself currently defined in
 357  * the naive way: */
 358 #if defined(LISP_FEATURE_GENCGC) && !defined(LISP_FEATURE_C_STACK_IS_CONTROL_STACK)
 359 # define GENCGC_IS_PRECISE 1
 360 #endif
 361
 362 #endif /* _SBCL_RUNTIME_H_ */