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 /* KLUDGE: These are in theory machine-dependent and OS-dependent, but
  41  * in practice the "foo int" definitions work for all the machines
  42  * that SBCL runs on as of 0.6.7. If we port to the Alpha or some
  43  * other non-32-bit machine we'll probably need real machine-dependent
  44  * and OS-dependent definitions again. */
  45 /* even on alpha, int happens to be 4 bytes.  long is longer. */
  46 /* FIXME: these names really shouldn't reflect their length and this
  47    is not quite right for some of the FFI stuff */
  48 #if 64 == N_WORD_BITS
  49 typedef unsigned long u32;
  50 typedef signed long s32;
  51 #else
  52 typedef unsigned int u32;
  53 typedef signed int s32;
  54 #endif
  55
  56 /* this is an integral type the same length as a machine pointer */
  57 typedef unsigned long pointer_sized_uint_t ;
  58
  59 /* FIXME: we do things this way because of the alpha32 port.  once
  60    alpha64 has arrived, all this nastiness can go away */
  61 #if 64 == N_WORD_BITS
  62 #define LOW_WORD(c) ((pointer_sized_uint_t)c)
  63 typedef unsigned long lispobj;
  64 #else
  65 #define LOW_WORD(c) ((long)(c) & 0xFFFFFFFFL)
  66 /* fake it on alpha32 */
  67 typedef unsigned int lispobj;
  68 #endif
  69
  70 static inline int
  71 lowtag_of(lispobj obj) {
  72     return obj & LOWTAG_MASK;
  73 }
  74
  75 static inline int
  76 widetag_of(lispobj obj) {
  77     return obj & WIDETAG_MASK;
  78 }
  79
  80 static inline unsigned long
  81 HeaderValue(lispobj obj)
  82 {
  83   return obj >> N_WIDETAG_BITS;
  84 }
  85
  86 static inline struct cons *
  87 CONS(lispobj obj)
  88 {
  89   return (struct cons *)(obj - LIST_POINTER_LOWTAG);
  90 }
  91
  92 static inline struct symbol *
  93 SYMBOL(lispobj obj)
  94 {
  95   return (struct symbol *)(obj - OTHER_POINTER_LOWTAG);
  96 }
  97
  98 static inline struct fdefn *
  99 FDEFN(lispobj obj)
 100 {
 101   return (struct fdefn *)(obj - OTHER_POINTER_LOWTAG);
 102 }
 103
 104 /* Is the Lisp object obj something with pointer nature (as opposed to
 105  * e.g. a fixnum or character or unbound marker)? */
 106 static inline int
 107 is_lisp_pointer(lispobj obj)
 108 {
 109     return obj & 1;
 110 }
 111
 112 /* Convert from a lispobj with type bits to a native (ordinary
 113  * C/assembly) pointer to the beginning of the object. */
 114 static inline lispobj *
 115 native_pointer(lispobj obj)
 116 {
 117     return (lispobj *) ((pointer_sized_uint_t) (obj & ~LOWTAG_MASK));
 118 }
 119 /* inverse operation: create a suitably tagged lispobj from a native
 120  * pointer or integer.  Needs to be a macro due to the tedious C type
 121  * system */
 122 #define make_lispobj(o,low_tag) ((lispobj)(LOW_WORD(o)|low_tag))
 123
 124 /* FIXME: There seems to be no reason that make_fixnum and fixnum_value
 125  * can't be implemented as (possibly inline) functions. */
 126 #define make_fixnum(n) ((lispobj)((n)<<N_FIXNUM_TAG_BITS))
 127 #define fixnum_value(n) (((long)n)>>N_FIXNUM_TAG_BITS)
 128
 129 /* Too bad ANSI C doesn't define "bool" as C++ does.. */
 130 typedef int boolean;
 131
 132 /* This only works for static symbols. */
 133 /* FIXME: should be called StaticSymbolFunction, right? */
 134 #define SymbolFunction(sym) \
 135     (((struct fdefn *)(native_pointer(SymbolValue(sym,0))))->fun)
 136
 137 /* KLUDGE: As far as I can tell there's no ANSI C way of saying
 138  * "this function never returns". This is the way that you do it
 139  * in GCC later than version 2.7 or so. If you are using some
 140  * compiler that doesn't understand this, you could could just
 141  * change it to "typedef void never_returns" and nothing would
 142  * break, though you might get a few more bytes of compiled code or
 143  * a few more compiler warnings. -- WHN 2000-10-21 */
 144 typedef volatile void never_returns;
 145
 146 #endif /* _SBCL_RUNTIME_H_ */