[project @ 2000-04-03 15:54:49 by simonmar]
[ghc-hetmet.git] / ghc / includes / Stg.h
index 555c7b1..7a2266c 100644 (file)
@@ -1,5 +1,7 @@
 /* -----------------------------------------------------------------------------
- * $Id: Stg.h,v 1.4 1999/01/21 10:31:43 simonm Exp $
+ * $Id: Stg.h,v 1.25 2000/04/03 15:54:49 simonmar Exp $
+ *
+ * (c) The GHC Team, 1998-1999
  *
  * Top-level include file for everything STG-ish.  
  *
 #define _POSIX_SOURCE
 #endif
 
+/* If we include "Stg.h" directly, we're in STG code, and we therefore
+ * get all the global register variables, macros etc. that go along
+ * with that.  If "Stg.h" is included via "Rts.h", we're assumed to
+ * be in vanilla C.
+ */
+#ifndef IN_STG_CODE
+# define IN_STG_CODE 1
+#endif
+
+#if IN_STG_CODE == 0
+# ifndef NO_REGS
+#  define NO_REGS                      /* don't define fixed registers */
+# endif
+#endif
+
 /* Configuration */
 #include "config.h"
 #ifdef __HUGS__ /* vile hack till the GHC folks come on board */
 #include "options.h"
 #endif
 
+/* Some macros to handle DLLing (Win32 only at the moment). */
+#include "StgDLL.h"
+
+/* Turn lazy blackholing and eager blackholing on/off.
+ *
+ * Using eager blackholing makes things easier to debug because
+ * the blackholes are more predictable - but it's slower and less sexy.
+ *
+ * For now, do lazy and not eager.
+ */
+
+/* TICKY_TICKY needs EAGER_BLACKHOLING to verify no double-entries of
+ * single-entry thunks.
+ *
+ * SMP needs EAGER_BLACKHOLING because it has to lock thunks
+ * synchronously, in case another thread is trying to evaluate the
+ * same thunk simultaneously.
+ */
+#if defined(SMP) || defined(TICKY_TICKY)
+#  define EAGER_BLACKHOLING
+#else
+#  define LAZY_BLACKHOLING
+#endif
+
 /* ToDo: Set this flag properly: COMPILER and INTERPRETER should not be mutually exclusive. */
 #ifndef INTERPRETER
 #define COMPILER 1
 #endif
 
+/* TABLES_NEXT_TO_CODE says whether to assume that info tables are
+ * assumed to reside just before the code for a function.
+ *
+ * UNDEFINING THIS WON'T WORK ON ITS OWN.  You have been warned.
+ */
+#ifndef USE_MINIINTERPRETER
+#define TABLES_NEXT_TO_CODE
+#endif
+
+/* bit macros
+ */
+#define BITS_PER_BYTE 8
+#define BITS_IN(x) (BITS_PER_BYTE * sizeof(x))
+
+/* -----------------------------------------------------------------------------
+   Assertions and Debuggery
+   -------------------------------------------------------------------------- */
+
+#ifndef DEBUG
+#define ASSERT(predicate) /* nothing */
+#else
+
+void _stgAssert (char *, unsigned int);
+
+#define ASSERT(predicate)                      \
+       if (predicate)                          \
+           /*null*/;                           \
+       else                                    \
+           _stgAssert(__FILE__, __LINE__)
+#endif /* DEBUG */
+
+/* -----------------------------------------------------------------------------
+   Include everything STG-ish
+   -------------------------------------------------------------------------- */
+
 /* Global type definitions*/
 #include "StgTypes.h"
+#include "RtsTypes.h"
 
 /* Global constaints */
 #include "Constants.h"
 
 /* Profiling information */
-#include "Profiling.h"
+#include "StgProf.h"
 
 /* Storage format definitions */
 #include "Closures.h"
+#include "ClosureTypes.h"
 #include "InfoTables.h"
 #include "TSO.h"
 
+/* Simulated-parallel information */
+#include "GranSim.h"
+
+/* Parallel information */
+#include "Parallel.h"
+
 /* STG/Optimised-C related stuff */
+#include "SMP.h"
 #include "MachRegs.h"
 #include "Regs.h"
 #include "TailCalls.h"
+#include "Block.h"
 
-/**
- * Added by Ian McDonald 7/5/98 
- * XXX The position of this code is very
- * important - it must come after the 
- * Regs.h include
- **/
-#ifdef nemesis_TARGET_OS
-#define _NEMESIS_OS_
-#ifndef __LANGUAGE_C
-#define __LANGUAGE_C
-#endif
-#include <nemesis.h>
-#endif
+/* RTS public interface */
+#include "RtsAPI.h"
 
 /* these are all ANSI C headers */
 #include <stdlib.h>
 #include <unistd.h>
 #endif
 
+#ifdef SMP
+#include <pthread.h>
+#endif
+
 /* GNU mp library */
 #include "gmp.h"
 
-/* Wired-in Prelude identifiers */
-#include "Prelude.h"
-
 /* Storage Manager */
 #include "StgStorage.h"
 
 #include "ClosureMacros.h"
 #include "InfoMacros.h"
 #include "StgMacros.h"
-#include "StgProf.h"
 #include "PrimOps.h"
 #include "Updates.h"
 #include "StgTicky.h"
 #include "CCall.h"
+#include "Stable.h"
 
 /* Built-in entry points */
 #include "StgMiscClosures.h"
 #include "Hooks.h"
 
 /* Misc stuff without a home */
-extern char **prog_argv;       /* so we can get at these from Haskell */
-extern int    prog_argc;
+DLL_IMPORT_RTS extern char **prog_argv;        /* so we can get at these from Haskell */
+DLL_IMPORT_RTS extern int    prog_argc;
 
 extern char **environ;
 
 /* Creating and destroying an adjustor thunk.
    I cannot make myself create a separate .h file
-   for these two (sof.)
+   for these two (sof.) 
+   
 */
 extern void* createAdjustor(int cconv, StgStablePtr hptr, StgFunPtr wptr);
 extern void  freeHaskellFunctionPtr(void* ptr);
 
-/* -----------------------------------------------------------------------------
-   Assertions and Debuggery
-   -------------------------------------------------------------------------- */
-
-#ifndef DEBUG
-#define ASSERT(predicate) /* nothing */
-#else
-
-void _stgAssert (char *, unsigned int);
-
-#define ASSERT(predicate)                      \
-       if (predicate)                          \
-           /*null*/;                           \
-       else                                    \
-           _stgAssert(__FILE__, __LINE__)
-#endif /* DEBUG */
-
 #endif /* STG_H */