/* -----------------------------------------------------------------------------
- * $Id: Stg.h,v 1.4 1999/01/21 10:31:43 simonm Exp $
+ * $Id: Stg.h,v 1.60 2003/12/28 13:09:43 panne Exp $
+ *
+ * (c) The GHC Team, 1998-1999
*
* Top-level include file for everything STG-ish.
*
* 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
#define STG_H
-#ifndef NON_POSIX_SOURCE
-#define _POSIX_SOURCE
+
+/* 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"
+
+/* 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"
+
+/* Fix for mingw stat problem (done here so it's early enough) */
+#ifdef mingw32_TARGET_OS
+#define __MSVCRT__ 1
+#endif
+
+/* 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
+
+#if defined(__GNUC__)
+#define GNU_ATTRIBUTE(at) __attribute__((at))
+#else
+#define GNU_ATTRIBUTE(at)
#endif
-/* ToDo: Set this flag properly: COMPILER and INTERPRETER should not be mutually exclusive. */
-#ifndef INTERPRETER
-#define COMPILER 1
+/*
+ * 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.
+ */
+#if !defined(USE_MINIINTERPRETER) && !defined(ia64_TARGET_ARCH)
+#define TABLES_NEXT_TO_CODE
#endif
-/* Global type definitions*/
+/* 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 */
+
+/*
+ * 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
+ -------------------------------------------------------------------------- */
+
#include "StgTypes.h"
+#include "RtsTypes.h"
+
+/* -----------------------------------------------------------------------------
+ Shorthand forms
+ -------------------------------------------------------------------------- */
+
+typedef StgChar C_;
+typedef StgWord W_;
+typedef StgWord* P_;
+typedef P_* PP_;
+typedef StgInt I_;
+typedef StgAddr A_;
+typedef const StgWord* D_;
+typedef StgFunPtr F_;
+typedef StgByteArray B_;
+typedef StgClosurePtr L_;
+
+typedef StgInt64 LI_;
+typedef StgWord64 LW_;
+
+/*
+ * We often want to know the size of something in units of an
+ * StgWord... (rounded up, of course!)
+ */
+
+#define sizeofW(t) ((sizeof(t)+sizeof(W_)-1)/sizeof(W_))
+
+/*
+ * It's nice to be able to grep for casts
+ */
+
+#define stgCast(ty,e) ((ty)(e))
+
+/* -----------------------------------------------------------------------------
+ Include everything STG-ish
+ -------------------------------------------------------------------------- */
/* Global constaints */
#include "Constants.h"
/* Profiling information */
-#include "Profiling.h"
+#include "StgProf.h"
+#include "StgLdvProf.h"
/* Storage format definitions */
+#include "StgFun.h"
#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 */
+/* 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>
+#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"
/* Runtime-system hooks */
#include "Hooks.h"
-/* Misc stuff without a home */
-extern char **prog_argv; /* so we can get at these from Haskell */
-extern int prog_argc;
+#include "Signals.h"
-extern char **environ;
+#include "HsFFI.h"
-/* Creating and destroying an adjustor thunk.
- I cannot make myself create a separate .h file
- for these two (sof.)
-*/
-extern void* createAdjustor(int cconv, StgStablePtr hptr, StgFunPtr wptr);
-extern void freeHaskellFunctionPtr(void* ptr);
+/* 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;
+DLL_IMPORT_RTS extern char *prog_name;
-/* -----------------------------------------------------------------------------
- Assertions and Debuggery
- -------------------------------------------------------------------------- */
+extern void stackOverflow(void);
-#ifndef DEBUG
-#define ASSERT(predicate) /* nothing */
-#else
-
-void _stgAssert (char *, unsigned int);
+#if defined(WANT_DOTNET_SUPPORT)
+#include "DNInvoke.h"
+#endif
-#define ASSERT(predicate) \
- if (predicate) \
- /*null*/; \
- else \
- _stgAssert(__FILE__, __LINE__)
-#endif /* DEBUG */
+/* 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 rtsBool initAdjustor(void);
#endif /* STG_H */
projects / ghc-hetmet.git / blobdiff