[project @ 2004-02-12 02:04:59 by mthomas]
[ghc-hetmet.git] / ghc / includes / Stg.h
index b046847..c6792b3 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
- * $Id: Stg.h,v 1.37 2001/08/14 13:40:08 sewardj Exp $
+ * $Id: Stg.h,v 1.60 2003/12/28 13:09:43 panne Exp $
  *
  * (c) The GHC Team, 1998-1999
  *
@@ -7,6 +7,11 @@
  *
  * This file is included *automatically* by all .hc files.
  *
+ * NOTE: always include Stg.h *before* any other headers, because we
+ * define some register variables which must be done before any inline
+ * functions are defined (some system headers have been known to
+ * define the odd inline function).
+ *
  * ---------------------------------------------------------------------------*/
 
 #ifndef STG_H
 /* Configuration */
 #include "config.h"
 
+/* This needs to be up near the top as the register line on alpha needs
+ * to be before all procedures */
+#include "TailCalls.h"
+
+#if __GNUC__ >= 3
+/* Assume that a flexible array member at the end of a struct
+ * can be defined thus: T arr[]; */
+#define FLEXIBLE_ARRAY
+#else
+/* Assume that it must be defined thus: T arr[0]; */
+#define FLEXIBLE_ARRAY 0
+#endif
+
+#if defined(SMP) || defined(THREADED_RTS)
+#define RTS_SUPPORTS_THREADS 1
+#endif
+
 /* Some macros to handle DLLing (Win32 only at the moment). */
 #include "StgDLL.h"
 
 #  define LAZY_BLACKHOLING
 #endif
 
-/* ToDo: remove */
-#define COMPILER 1
+#if defined(__GNUC__)
+#define GNU_ATTRIBUTE(at) __attribute__((at))
+#else
+#define GNU_ATTRIBUTE(at)
+#endif
+
+/* 
+ * Empty structures isn't supported by all, so to define
+ * empty structures, please protect the defn with an
+ * #if SUPPORTS_EMPTY_STRUCTS. Similarly for use,
+ * employ the macro MAYBE_EMPTY_STRUCT():
+ *
+ *     MAYBE_EMPTY_STRUCT(structFoo, fieldName);
+ */
+#if SUPPORTS_EMPTY_STRUCTS
+# define MAYBE_EMPTY_STRUCT(a,b) a b;
+#else
+# define MAYBE_EMPTY_STRUCT(a,b) /* empty */
+#endif
+
+/*
+ * 'Portable' 
+ */
+#if defined(__GNUC__)
+# define INLINE_HEADER static inline
+# define INLINE_ME inline
+# define STATIC_INLINE INLINE_HEADER
+#elif defined(_MSC_VER)
+# define INLINE_HEADER __inline static
+# define INLINE_ME __inline
+# define STATIC_INLINE INLINE_HEADER
+#else
+# error "Don't know how to inline functions with your C compiler."
+#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
+#if !defined(USE_MINIINTERPRETER) && !defined(ia64_TARGET_ARCH)
 #define TABLES_NEXT_TO_CODE
 #endif
 
@@ -94,6 +148,14 @@ void _stgAssert (char *, unsigned int);
            _stgAssert(__FILE__, __LINE__)
 #endif /* DEBUG */
 
+/* 
+ * Use this on the RHS of macros which expand to nothing
+ * to make sure that the macro can be used in a context which
+ * demands a non-empty statement.
+ */
+
+#define doNothing() do { } while (0)
+
 /* -----------------------------------------------------------------------------
    Global type definitions
    -------------------------------------------------------------------------- */
@@ -141,8 +203,10 @@ typedef StgWord64       LW_;
 
 /* Profiling information */
 #include "StgProf.h"
+#include "StgLdvProf.h"
 
 /* Storage format definitions */
+#include "StgFun.h"
 #include "Closures.h"
 #include "ClosureTypes.h"
 #include "InfoTables.h"
@@ -158,27 +222,17 @@ typedef StgWord64       LW_;
 #include "SMP.h"
 #include "MachRegs.h"
 #include "Regs.h"
-#include "TailCalls.h"
 #include "Block.h"
 
 /* RTS public interface */
 #include "RtsAPI.h"
 
-/* these are all ANSI C headers */
+/* System headers: stdlib.h is eeded so that we can use NULL.  It must
+ * come after MachRegs.h, because stdlib.h might define some inline
+ * functions which may only be defined after register variables have
+ * been declared.
+ */
 #include <stdlib.h>
-#include <string.h>
-#include <math.h>
-#include <assert.h>
-#include <errno.h>
-#include <stdio.h>
-
-#ifdef HAVE_SIGNAL_H
-#include <signal.h>
-#endif
-
-#ifdef HAVE_UNISTD_H
-#include <unistd.h>
-#endif
 
 #ifdef SMP
 #include <pthread.h>
@@ -206,22 +260,28 @@ typedef StgWord64       LW_;
 /* Runtime-system hooks */
 #include "Hooks.h"
 
+#include "Signals.h"
+
 #include "HsFFI.h"
 
 /* Misc stuff without a home */
 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;
+DLL_IMPORT_RTS extern char  *prog_name;
 
 extern void stackOverflow(void);
 
-/* Creating and destroying an adjustor thunk.
-   I cannot make myself create a separate .h file
-   for these two (sof.) 
+#if defined(WANT_DOTNET_SUPPORT)
+#include "DNInvoke.h"
+#endif
+
+/* Creating and destroying an adjustor thunk and initialising the whole
+   adjustor thunk machinery. I cannot make myself create a separate .h file
+   for these three (sof.) 
    
 */
-extern void* createAdjustor(int cconv, StgStablePtr hptr, StgFunPtr wptr);
-extern void  freeHaskellFunctionPtr(void* ptr);
+extern void*   createAdjustor(int cconv, StgStablePtr hptr, StgFunPtr wptr);
+extern void    freeHaskellFunctionPtr(void* ptr);
+extern rtsBool initAdjustor(void);
 
 #endif /* STG_H */