new function: is_lisp_immediate()
[sbcl.git] / src / runtime / runtime.h
index f204cf1..9905632 100644 (file)
@@ -15,8 +15,9 @@
 #ifndef _SBCL_RUNTIME_H_
 #define _SBCL_RUNTIME_H_
 
-#define QSHOW 0 /* Enable low-level debugging output? */
-#if QSHOW
+/*#define QSHOW */ /* Enable low-level debugging output? */
+
+#ifdef QSHOW
 #define FSHOW(args) fprintf args
 #define SHOW(string) FSHOW((stderr, "/%s\n", string))
 #else
  * problem.. */
 #define QSHOW_SIGNALS 0
 
-#define N_LOWTAG_BITS 3
-#define LOWTAG_MASK ((1<<N_LOWTAG_BITS)-1)
-#define N_WIDETAG_BITS 8
-#define WIDETAG_MASK ((1<<N_WIDETAG_BITS)-1)
-
-/* FIXME: Make HeaderValue, CONS, SYMBOL, and FDEFN into inline
- * functions instead of macros. */
-
-#define HeaderValue(obj) ((unsigned long) ((obj) >> N_WIDETAG_BITS))
-
-#define CONS(obj) ((struct cons *)((obj)-LIST_POINTER_LOWTAG))
-#define SYMBOL(obj) ((struct symbol *)((obj)-OTHER_POINTER_LOWTAG))
-#define FDEFN(obj) ((struct fdefn *)((obj)-OTHER_POINTER_LOWTAG))
+#if QSHOW_SIGNALS
+#define FSHOW_SIGNAL FSHOW
+#else
+#define FSHOW_SIGNAL(args)
+#endif
 
 /* KLUDGE: These are in theory machine-dependent and OS-dependent, but
  * in practice the "foo int" definitions work for all the machines
  * that SBCL runs on as of 0.6.7. If we port to the Alpha or some
  * other non-32-bit machine we'll probably need real machine-dependent
  * and OS-dependent definitions again. */
-#if ((defined alpha) && !(defined __linux__))
-#error No u32,s32 definitions for this platform.  Write some.
-#else
-/* int happens to be 4 bytes on linux/alpha.  long is longer. */
+/* even on alpha, int happens to be 4 bytes.  long is longer. */
+/* FIXME: these names really shouldn't reflect their length and this
+   is not quite right for some of the FFI stuff */
+typedef unsigned long u64;
+typedef signed long s64;
 typedef unsigned int u32;
 typedef signed int s32;
-#define LOW_WORD(c) ((long)(c) & 0xFFFFFFFFL)
+
+/* this is an integral type the same length as a machine pointer */
+typedef unsigned long pointer_sized_uint_t ;
+
+#include <sys/types.h>
+
+#if defined(LISP_FEATURE_SB_THREAD)
+#include <pthread.h>
+typedef pthread_t os_thread_t;
+#else
+typedef pid_t os_thread_t;
 #endif
 
-typedef u32 lispobj;
+/* FIXME: we do things this way because of the alpha32 port.  once
+   alpha64 has arrived, all this nastiness can go away */
+#if 64 == N_WORD_BITS
+#define LOW_WORD(c) ((pointer_sized_uint_t)c)
+typedef unsigned long lispobj;
+#else
+#define LOW_WORD(c) ((long)(c) & 0xFFFFFFFFL)
+/* fake it on alpha32 */
+typedef unsigned int lispobj;
+#endif
 
 static inline int
-lowtag_of(lispobj obj) {
+lowtag_of(lispobj obj)
+{
     return obj & LOWTAG_MASK;
 }
 
 static inline int
-widetag_of(lispobj obj) {
+widetag_of(lispobj obj)
+{
     return obj & WIDETAG_MASK;
 }
 
+static inline unsigned long
+HeaderValue(lispobj obj)
+{
+  return obj >> N_WIDETAG_BITS;
+}
+
+static inline struct cons *
+CONS(lispobj obj)
+{
+  return (struct cons *)(obj - LIST_POINTER_LOWTAG);
+}
+
+static inline struct symbol *
+SYMBOL(lispobj obj)
+{
+  return (struct symbol *)(obj - OTHER_POINTER_LOWTAG);
+}
+
+static inline struct fdefn *
+FDEFN(lispobj obj)
+{
+  return (struct fdefn *)(obj - OTHER_POINTER_LOWTAG);
+}
+
 /* Is the Lisp object obj something with pointer nature (as opposed to
  * e.g. a fixnum or character or unbound marker)? */
 static inline int
@@ -84,43 +123,78 @@ is_lisp_pointer(lispobj obj)
     return obj & 1;
 }
 
+#include "fixnump.h"
+
+/* Is the Lisp object obj something with immediate nature (e.g. a
+ * fixnum or character or unbound marker)? */
+static inline int
+is_lisp_immediate(lispobj obj)
+{
+    return (fixnump(obj)
+            || (widetag_of(obj) == CHARACTER_WIDETAG)
+#if N_WORD_BITS == 64
+            || (widetag_of(obj) == SINGLE_FLOAT_WIDETAG)
+#endif
+            || (widetag_of(obj) == UNBOUND_MARKER_WIDETAG));
+}
+
 /* Convert from a lispobj with type bits to a native (ordinary
  * C/assembly) pointer to the beginning of the object. */
-static inline lispobj
+static inline lispobj *
 native_pointer(lispobj obj)
 {
-    return obj & ~LOWTAG_MASK;
+    return (lispobj *) ((pointer_sized_uint_t) (obj & ~LOWTAG_MASK));
 }
 
-/* FIXME: There seems to be no reason that make_fixnum and fixnum_value
- * can't be implemented as (possibly inline) functions. */
-#define make_fixnum(n) ((lispobj)((n)<<2))
-#define fixnum_value(n) (((long)n)>>2)
-
-/* Too bad ANSI C doesn't define "bool" as C++ does.. */
-typedef int boolean;
+/* inverse operation: create a suitably tagged lispobj from a native
+ * pointer or integer.*/
+static inline lispobj
+make_lispobj(void *o, int low_tag)
+{
+    return LOW_WORD(o) | low_tag;
+}
 
-/* FIXME: There seems to be no reason that SymbolValue, SetSymbolValue,
- * and SymbolFunction can't be defined as (possibly inline) functions
- * instead of macros. */
+static inline lispobj
+make_fixnum(long n)
+{
+    return n << N_FIXNUM_TAG_BITS;
+}
 
-#define SymbolValue(sym) \
-    (((struct symbol *)((sym)-OTHER_POINTER_LOWTAG))->value)
-#define SetSymbolValue(sym,val) \
-    (((struct symbol *)((sym)-OTHER_POINTER_LOWTAG))->value = (val))
+static inline long
+fixnum_value(lispobj n)
+{
+    return n >> N_FIXNUM_TAG_BITS;
+}
 
-/* This only works for static symbols. */
-/* FIXME: should be called StaticSymbolFunction, right? */
-#define SymbolFunction(sym) \
-    (((struct fdefn *)(SymbolValue(sym)-OTHER_POINTER_LOWTAG))->fun)
+#if defined(LISP_FEATURE_WIN32)
+/* KLUDGE: Avoid double definition of boolean by rpcndr.h included via
+ * shlobj.h.
+ *
+ * FIXME: We should probably arrange to use the rpcndr.h boolean on Windows,
+ * or get rid of our own boolean type.  If the boolean type is only used in
+ * the runtime, and never passed to Lisp, then it doesn't matter which one
+ * we use.
+ */
+#define boolean rpcndr_boolean
+#include <shlobj.h>
+#undef boolean
+#endif
+typedef int boolean;
 
 /* KLUDGE: As far as I can tell there's no ANSI C way of saying
  * "this function never returns". This is the way that you do it
- * in GCC later than version 2.7 or so. If you are using some 
- * compiler that doesn't understand this, you could could just
- * change it to "typedef void never_returns" and nothing would
- * break, though you might get a few more bytes of compiled code or
- * a few more compiler warnings. -- WHN 2000-10-21 */
-typedef volatile void never_returns;
+ * in GCC later than version 2.5 or so. */
+#if defined(__GNUC__)
+#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5)
+#define never_returns __attribute__ ((noreturn))
+#else
+#define never_returns
+#endif
+#else
+#define never_returns
+#endif
+
+extern void *successful_malloc (size_t size);
+extern char *copied_string (char *string);
 
 #endif /* _SBCL_RUNTIME_H_ */