X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fincludes%2FStg.h;h=1189b0e99b834f69b833d5a34fd51d0e34ce4db1;hb=153b9cb9b11e05c4edb1b6bc0a7b972660e41f70;hp=9e37b03a1cd1e330e2782f9f908c74d27eb54275;hpb=e778a17045aac8aded0e0438f5e0178643ff678d;p=ghc-hetmet.git diff --git a/ghc/includes/Stg.h b/ghc/includes/Stg.h index 9e37b03..1189b0e 100644 --- a/ghc/includes/Stg.h +++ b/ghc/includes/Stg.h @@ -1,24 +1,29 @@ /* ----------------------------------------------------------------------------- - * $Id: Stg.h,v 1.35 2001/02/09 13:09:17 simonmar Exp $ + * $Id: Stg.h,v 1.66 2005/01/28 12:55:52 simonmar Exp $ * - * (c) The GHC Team, 1998-1999 + * (c) The GHC Team, 1998-2004 * * 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). + * + * We generally try to keep as little visible as possible when + * compiling .hc files. So for example the definitions of the + * InfoTable structs, closure structs and other RTS types are not + * visible here. The compiler knows enough about the representations + * of these types to generate code which manipulates them directly + * with pointer arithmetic. + * * ---------------------------------------------------------------------------*/ #ifndef STG_H #define STG_H -#ifndef NON_POSIX_SOURCE -#define _POSIX_SOURCE 1 -#define _POSIX_C_SOURCE 199309L -#define _ISOC9X_SOURCE -#endif - -/* Let's be ISO C9X too... */ /* 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 @@ -30,48 +35,30 @@ #endif #if IN_STG_CODE == 0 -# ifndef NO_REGS -# define NO_REGS /* don't define fixed registers */ -# endif +# define NO_GLOBAL_REG_DECLS /* don't define fixed registers */ #endif /* Configuration */ -#include "config.h" - -/* Some macros to handle DLLing (Win32 only at the moment). */ -#include "StgDLL.h" +#include "ghcconfig.h" +#include "RtsConfig.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. - */ +/* ----------------------------------------------------------------------------- + Useful definitions + -------------------------------------------------------------------------- */ -/* 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. +/* + * The C backend like to refer to labels by just mentioning their + * names. Howevver, when a symbol is declared as a variable in C, the + * C compiler will implicitly dereference it when it occurs in source. + * So we must subvert this behaviour for .hc files by declaring + * variables as arrays, which eliminates the implicit dereference. */ -#if defined(SMP) || defined(TICKY_TICKY) -# define EAGER_BLACKHOLING +#if IN_STG_CODE +#define RTS_VAR(x) (x)[] +#define RTS_DEREF(x) (*(x)) #else -# define LAZY_BLACKHOLING -#endif - -/* ToDo: remove */ -#define COMPILER 1 - -/* 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 +#define RTS_VAR(x) x +#define RTS_DEREF(x) x #endif /* bit macros @@ -79,29 +66,27 @@ #define BITS_PER_BYTE 8 #define BITS_IN(x) (BITS_PER_BYTE * sizeof(x)) -/* ----------------------------------------------------------------------------- - Assertions and Debuggery - -------------------------------------------------------------------------- */ - -#ifndef DEBUG -#define ASSERT(predicate) /* nothing */ +/* + * 'Portable' inlining + */ +#if defined(__GNUC__) || defined( __INTEL_COMPILER) +# 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 - -void _stgAssert (char *, unsigned int); - -#define ASSERT(predicate) \ - if (predicate) \ - /*null*/; \ - else \ - _stgAssert(__FILE__, __LINE__) -#endif /* DEBUG */ +# error "Don't know how to inline functions with your C compiler." +#endif /* ----------------------------------------------------------------------------- Global type definitions -------------------------------------------------------------------------- */ +#include "MachDeps.h" #include "StgTypes.h" -#include "RtsTypes.h" /* ----------------------------------------------------------------------------- Shorthand forms @@ -121,109 +106,321 @@ 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 IF_(f) static F_ f(void) +#define FN_(f) F_ f(void) +#define EF_(f) extern F_ f(void) -#define sizeofW(t) ((sizeof(t)+sizeof(W_)-1)/sizeof(W_)) +typedef StgWord StgWordArray[]; +#define EI_ extern StgWordArray +#define II_ static StgWordArray -/* - * It's nice to be able to grep for casts +/* ----------------------------------------------------------------------------- + Tail calls + + This needs to be up near the top as the register line on alpha needs + to be before all procedures (inline & out-of-line). + -------------------------------------------------------------------------- */ + +#include "TailCalls.h" + +/* ----------------------------------------------------------------------------- + Other Stg stuff... + -------------------------------------------------------------------------- */ + +#include "StgDLL.h" +#include "MachRegs.h" +#include "Regs.h" +#include "StgProf.h" /* ToDo: separate out RTS-only stuff from here */ + +#if IN_STG_CODE +/* + * This is included later for RTS sources, after definitions of + * StgInfoTable, StgClosure and so on. */ +#include "StgMiscClosures.h" +#endif -#define stgCast(ty,e) ((ty)(e)) +/* RTS external interface */ +#include "RtsExternal.h" /* ----------------------------------------------------------------------------- - Include everything STG-ish + Moving Floats and Doubles + + ASSIGN_FLT is for assigning a float to memory (usually the + stack/heap). The memory address is guaranteed to be + StgWord aligned (currently == sizeof(void *)). + + PK_FLT is for pulling a float out of memory. The memory is + guaranteed to be StgWord aligned. -------------------------------------------------------------------------- */ -/* Global constaints */ -#include "Constants.h" +INLINE_HEADER void ASSIGN_FLT (W_ [], StgFloat); +INLINE_HEADER StgFloat PK_FLT (W_ []); -/* Profiling information */ -#include "StgProf.h" +#if ALIGNMENT_FLOAT <= ALIGNMENT_LONG -/* Storage format definitions */ -#include "Closures.h" -#include "ClosureTypes.h" -#include "InfoTables.h" -#include "TSO.h" +INLINE_HEADER void ASSIGN_FLT(W_ p_dest[], StgFloat src) { *(StgFloat *)p_dest = src; } +INLINE_HEADER StgFloat PK_FLT (W_ p_src[]) { return *(StgFloat *)p_src; } -/* Simulated-parallel information */ -#include "GranSim.h" +#else /* ALIGNMENT_FLOAT > ALIGNMENT_UNSIGNED_INT */ -/* Parallel information */ -#include "Parallel.h" +INLINE_HEADER void ASSIGN_FLT(W_ p_dest[], StgFloat src) +{ + float_thing y; + y.f = src; + *p_dest = y.fu; +} -/* STG/Optimised-C related stuff */ -#include "SMP.h" -#include "MachRegs.h" -#include "Regs.h" -#include "TailCalls.h" -#include "Block.h" +INLINE_HEADER StgFloat PK_FLT(W_ p_src[]) +{ + float_thing y; + y.fu = *p_src; + return(y.f); +} -/* RTS public interface */ -#include "RtsAPI.h" +#endif /* ALIGNMENT_FLOAT > ALIGNMENT_LONG */ -/* these are all ANSI C headers */ -#include -#include -#include -#include -#include -#include +#if ALIGNMENT_DOUBLE <= ALIGNMENT_LONG -#ifdef HAVE_SIGNAL_H -#include -#endif +INLINE_HEADER void ASSIGN_DBL (W_ [], StgDouble); +INLINE_HEADER StgDouble PK_DBL (W_ []); -#ifdef HAVE_UNISTD_H -#include -#endif +INLINE_HEADER void ASSIGN_DBL(W_ p_dest[], StgDouble src) { *(StgDouble *)p_dest = src; } +INLINE_HEADER StgDouble PK_DBL (W_ p_src[]) { return *(StgDouble *)p_src; } -#ifdef SMP -#include -#endif +#else /* ALIGNMENT_DOUBLE > ALIGNMENT_LONG */ + +/* Sparc uses two floating point registers to hold a double. We can + * write ASSIGN_DBL and PK_DBL by directly accessing the registers + * independently - unfortunately this code isn't writable in C, we + * have to use inline assembler. + */ +#if sparc_HOST_ARCH + +#define ASSIGN_DBL(dst0,src) \ + { StgPtr dst = (StgPtr)(dst0); \ + __asm__("st %2,%0\n\tst %R2,%1" : "=m" (((P_)(dst))[0]), \ + "=m" (((P_)(dst))[1]) : "f" (src)); \ + } + +#define PK_DBL(src0) \ + ( { StgPtr src = (StgPtr)(src0); \ + register double d; \ + __asm__("ld %1,%0\n\tld %2,%R0" : "=f" (d) : \ + "m" (((P_)(src))[0]), "m" (((P_)(src))[1])); d; \ + } ) + +#else /* ! sparc_HOST_ARCH */ + +INLINE_HEADER void ASSIGN_DBL (W_ [], StgDouble); +INLINE_HEADER StgDouble PK_DBL (W_ []); + +typedef struct + { StgWord dhi; + StgWord dlo; + } unpacked_double; + +typedef union + { StgDouble d; + unpacked_double du; + } double_thing; + +INLINE_HEADER void ASSIGN_DBL(W_ p_dest[], StgDouble src) +{ + double_thing y; + y.d = src; + p_dest[0] = y.du.dhi; + p_dest[1] = y.du.dlo; +} + +/* GCC also works with this version, but it generates + the same code as the previous one, and is not ANSI + +#define ASSIGN_DBL( p_dest, src ) \ + *p_dest = ((double_thing) src).du.dhi; \ + *(p_dest+1) = ((double_thing) src).du.dlo \ +*/ -/* GNU mp library */ -#include "gmp.h" +INLINE_HEADER StgDouble PK_DBL(W_ p_src[]) +{ + double_thing y; + y.du.dhi = p_src[0]; + y.du.dlo = p_src[1]; + return(y.d); +} -/* Storage Manager */ -#include "StgStorage.h" +#endif /* ! sparc_HOST_ARCH */ -/* Macros for STG/C code */ -#include "ClosureMacros.h" -#include "InfoMacros.h" -#include "StgMacros.h" -#include "PrimOps.h" -#include "Updates.h" -#include "StgTicky.h" -#include "CCall.h" -#include "Stable.h" +#endif /* ALIGNMENT_DOUBLE > ALIGNMENT_UNSIGNED_INT */ -/* Built-in entry points */ -#include "StgMiscClosures.h" -/* Runtime-system hooks */ -#include "Hooks.h" +/* ----------------------------------------------------------------------------- + Moving 64-bit quantities around -#include "HsFFI.h" + ASSIGN_Word64 assign an StgWord64/StgInt64 to a memory location + PK_Word64 load an StgWord64/StgInt64 from a amemory location -/* 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; + In both cases the memory location might not be 64-bit aligned. + -------------------------------------------------------------------------- */ -extern char **environ; +#ifdef SUPPORT_LONG_LONGS + +typedef struct + { StgWord dhi; + StgWord dlo; + } unpacked_double_word; + +typedef union + { StgInt64 i; + unpacked_double_word iu; + } int64_thing; + +typedef union + { StgWord64 w; + unpacked_double_word wu; + } word64_thing; + +INLINE_HEADER void ASSIGN_Word64(W_ p_dest[], StgWord64 src) +{ + word64_thing y; + y.w = src; + p_dest[0] = y.wu.dhi; + p_dest[1] = y.wu.dlo; +} + +INLINE_HEADER StgWord64 PK_Word64(W_ p_src[]) +{ + word64_thing y; + y.wu.dhi = p_src[0]; + y.wu.dlo = p_src[1]; + return(y.w); +} + +INLINE_HEADER void ASSIGN_Int64(W_ p_dest[], StgInt64 src) +{ + int64_thing y; + y.i = src; + p_dest[0] = y.iu.dhi; + p_dest[1] = y.iu.dlo; +} + +INLINE_HEADER StgInt64 PK_Int64(W_ p_src[]) +{ + int64_thing y; + y.iu.dhi = p_src[0]; + y.iu.dlo = p_src[1]; + return(y.i); +} + +#elif SIZEOF_VOID_P == 8 + +INLINE_HEADER void ASSIGN_Word64(W_ p_dest[], StgWord64 src) +{ + p_dest[0] = src; +} + +INLINE_HEADER StgWord64 PK_Word64(W_ p_src[]) +{ + return p_src[0]; +} + +INLINE_HEADER void ASSIGN_Int64(W_ p_dest[], StgInt64 src) +{ + p_dest[0] = src; +} + +INLINE_HEADER StgInt64 PK_Int64(W_ p_src[]) +{ + return p_src[0]; +} -extern void stackOverflow(void); +#endif -/* 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); +/* ----------------------------------------------------------------------------- + Split markers + -------------------------------------------------------------------------- */ + +#if defined(USE_SPLIT_MARKERS) +#if defined(LEADING_UNDERSCORE) +#define __STG_SPLIT_MARKER __asm__("\n___stg_split_marker:"); +#else +#define __STG_SPLIT_MARKER __asm__("\n__stg_split_marker:"); +#endif +#else +#define __STG_SPLIT_MARKER /* nothing */ +#endif + +/* ----------------------------------------------------------------------------- + Integer multiply with overflow + -------------------------------------------------------------------------- */ + +/* Multiply with overflow checking. + * + * This is tricky - the usual sign rules for add/subtract don't apply. + * + * On 32-bit machines we use gcc's 'long long' types, finding + * overflow with some careful bit-twiddling. + * + * On 64-bit machines where gcc's 'long long' type is also 64-bits, + * we use a crude approximation, testing whether either operand is + * larger than 32-bits; if neither is, then we go ahead with the + * multiplication. + * + * Return non-zero if there is any possibility that the signed multiply + * of a and b might overflow. Return zero only if you are absolutely sure + * that it won't overflow. If in doubt, return non-zero. + */ + +#if SIZEOF_VOID_P == 4 + +#ifdef WORDS_BIGENDIAN +#define RTS_CARRY_IDX__ 0 +#define RTS_REM_IDX__ 1 +#else +#define RTS_CARRY_IDX__ 1 +#define RTS_REM_IDX__ 0 +#endif + +typedef union { + StgInt64 l; + StgInt32 i[2]; +} long_long_u ; + +#define mulIntMayOflo(a,b) \ +({ \ + StgInt32 r, c; \ + long_long_u z; \ + z.l = (StgInt64)a * (StgInt64)b; \ + r = z.i[RTS_REM_IDX__]; \ + c = z.i[RTS_CARRY_IDX__]; \ + if (c == 0 || c == -1) { \ + c = ((StgWord)((a^b) ^ r)) \ + >> (BITS_IN (I_) - 1); \ + } \ + c; \ +}) + +/* Careful: the carry calculation above is extremely delicate. Make sure + * you test it thoroughly after changing it. + */ + +#else + +#define HALF_INT (((I_)1) << (BITS_IN (I_) / 2)) + +#define stg_abs(a) (((I_)(a)) < 0 ? -((I_)(a)) : ((I_)(a))) + +#define mulIntMayOflo(a,b) \ +({ \ + I_ c; \ + if (stg_abs(a) >= HALF_INT || \ + stg_abs(b) >= HALF_INT) { \ + c = 1; \ + } else { \ + c = 0; \ + } \ + c; \ +}) +#endif #endif /* STG_H */