[project @ 2003-08-27 15:18:29 by panne]
[ghc-hetmet.git] / ghc / rts / RtsAPI.c
index 0009fb6..4f7e783 100644 (file)
@@ -1,12 +1,13 @@
 /* ----------------------------------------------------------------------------
- * $Id: RtsAPI.c,v 1.11 2000/03/13 10:53:56 simonmar Exp $
+ * $Id: RtsAPI.c,v 1.44 2003/05/23 08:28:48 simonmar Exp $
  *
- * (c) The GHC Team, 1998-1999
+ * (c) The GHC Team, 1998-2001
  *
  * API for invoking Haskell functions via the RTS
  *
  * --------------------------------------------------------------------------*/
 
+#include "PosixSource.h"
 #include "Rts.h"
 #include "Storage.h"
 #include "RtsAPI.h"
 #include "RtsFlags.h"
 #include "RtsUtils.h"
 #include "Prelude.h"
+#include "OSThreads.h"
+#include "Schedule.h"
+#include "Capability.h"
+
+#include <stdlib.h>
 
 /* ----------------------------------------------------------------------------
    Building Haskell objects from C datatypes.
    ------------------------------------------------------------------------- */
 HaskellObj
-rts_mkChar (char c)
+rts_mkChar (HsChar c)
 {
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,1));
-  p->header.info = (const StgInfoTable*)&Czh_con_info;
-  p->payload[0]  = (StgClosure *)((StgInt)c);
+  SET_HDR(p, Czh_con_info, CCS_SYSTEM);
+  p->payload[0]  = (StgClosure *)(StgChar)c;
   return p;
 }
 
 HaskellObj
-rts_mkInt (int i)
+rts_mkInt (HsInt i)
 {
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,1));
-  p->header.info = (const StgInfoTable*)&Izh_con_info;
+  SET_HDR(p, Izh_con_info, CCS_SYSTEM);
   p->payload[0]  = (StgClosure *)(StgInt)i;
   return p;
 }
 
 HaskellObj
-rts_mkInt8 (int i)
+rts_mkInt8 (HsInt8 i)
 {
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,1));
-  /* This is a 'cheat', using the static info table for Ints,
-     instead of the one for Int8, but the types have identical
-     representation.
-  */
-  p->header.info = (const StgInfoTable*)&Izh_con_info;
+  SET_HDR(p, I8zh_con_info, CCS_SYSTEM);
   /* Make sure we mask out the bits above the lowest 8 */
   p->payload[0]  = (StgClosure *)(StgInt)((unsigned)i & 0xff);
   return p;
 }
 
 HaskellObj
-rts_mkInt16 (int i)
+rts_mkInt16 (HsInt16 i)
 {
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,1));
-  /* This is a 'cheat', using the static info table for Ints,
-     instead of the one for Int8, but the types have identical
-     representation.
-  */
-  p->header.info = (const StgInfoTable*)&Izh_con_info;
+  SET_HDR(p, I16zh_con_info, CCS_SYSTEM);
   /* Make sure we mask out the relevant bits */
   p->payload[0]  = (StgClosure *)(StgInt)((unsigned)i & 0xffff);
   return p;
 }
 
 HaskellObj
-rts_mkInt32 (int i)
+rts_mkInt32 (HsInt32 i)
 {
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,1));
-  /* see mk_Int8 comment */
-  p->header.info = (const StgInfoTable*)&Izh_con_info;
-  p->payload[0]  = (StgClosure *)(StgInt)i;
+  SET_HDR(p, I32zh_con_info, CCS_SYSTEM);
+  p->payload[0]  = (StgClosure *)(StgInt)((unsigned)i & 0xffffffff);
   return p;
 }
 
 HaskellObj
-rts_mkInt64 (long long int i)
+rts_mkInt64 (HsInt64 i)
 {
   long long *tmp;
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,2));
-  /* see mk_Int8 comment */
-  p->header.info = (const StgInfoTable*)&I64zh_con_info;
+  SET_HDR(p, I64zh_con_info, CCS_SYSTEM);
   tmp  = (long long*)&(p->payload[0]);
   *tmp = (StgInt64)i;
   return p;
 }
 
 HaskellObj
-rts_mkWord (unsigned int i)
+rts_mkWord (HsWord i)
 {
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,1));
-  p->header.info = (const StgInfoTable*)&Wzh_con_info;
+  SET_HDR(p, Wzh_con_info, CCS_SYSTEM);
   p->payload[0]  = (StgClosure *)(StgWord)i;
   return p;
 }
 
 HaskellObj
-rts_mkWord8 (unsigned int w)
+rts_mkWord8 (HsWord8 w)
 {
   /* see rts_mkInt* comments */
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,1));
-  p->header.info = (const StgInfoTable*)&Wzh_con_info;
+  SET_HDR(p, W8zh_con_info, CCS_SYSTEM);
   p->payload[0]  = (StgClosure *)(StgWord)(w & 0xff);
   return p;
 }
 
 HaskellObj
-rts_mkWord16 (unsigned int w)
+rts_mkWord16 (HsWord16 w)
 {
   /* see rts_mkInt* comments */
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,1));
-  p->header.info = (const StgInfoTable*)&Wzh_con_info;
+  SET_HDR(p, W16zh_con_info, CCS_SYSTEM);
   p->payload[0]  = (StgClosure *)(StgWord)(w & 0xffff);
   return p;
 }
 
 HaskellObj
-rts_mkWord32 (unsigned int w)
+rts_mkWord32 (HsWord32 w)
 {
   /* see rts_mkInt* comments */
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,1));
-  p->header.info = (const StgInfoTable*)&Wzh_con_info;
-  p->payload[0]  = (StgClosure *)(StgWord)w;
+  SET_HDR(p, W32zh_con_info, CCS_SYSTEM);
+  p->payload[0]  = (StgClosure *)(StgWord)(w & 0xffffffff);
   return p;
 }
 
 HaskellObj
-rts_mkWord64 (unsigned long long w)
+rts_mkWord64 (HsWord64 w)
 {
   unsigned long long *tmp;
 
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,2));
   /* see mk_Int8 comment */
-  p->header.info = (const StgInfoTable*)&W64zh_con_info;
+  SET_HDR(p, W64zh_con_info, CCS_SYSTEM);
   tmp  = (unsigned long long*)&(p->payload[0]);
   *tmp = (StgWord64)w;
   return p;
 }
 
 HaskellObj
-rts_mkFloat (float f)
+rts_mkFloat (HsFloat f)
 {
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,1));
-  p->header.info = (const StgInfoTable*)&Fzh_con_info;
+  SET_HDR(p, Fzh_con_info, CCS_SYSTEM);
   ASSIGN_FLT((P_)p->payload, (StgFloat)f);
   return p;
 }
 
 HaskellObj
-rts_mkDouble (double d)
+rts_mkDouble (HsDouble d)
 {
   StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,sizeofW(StgDouble)));
-  p->header.info = (const StgInfoTable*)&Dzh_con_info;
+  SET_HDR(p, Dzh_con_info, CCS_SYSTEM);
   ASSIGN_DBL((P_)p->payload, (StgDouble)d);
   return p;
 }
 
 HaskellObj
-rts_mkStablePtr (StgStablePtr s)
+rts_mkStablePtr (HsStablePtr s)
 {
   StgClosure *p = (StgClosure *)allocate(sizeofW(StgHeader)+1);
-  p->header.info = (const StgInfoTable*)&StablePtr_con_info;
+  SET_HDR(p, StablePtr_con_info, CCS_SYSTEM);
   p->payload[0]  = (StgClosure *)s;
   return p;
 }
 
 HaskellObj
-rts_mkAddr (void *a)
+rts_mkPtr (HsPtr a)
+{
+  StgClosure *p = (StgClosure *)allocate(sizeofW(StgHeader)+1);
+  SET_HDR(p, Ptr_con_info, CCS_SYSTEM);
+  p->payload[0]  = (StgClosure *)a;
+  return p;
+}
+
+HaskellObj
+rts_mkFunPtr (HsFunPtr a)
 {
   StgClosure *p = (StgClosure *)allocate(sizeofW(StgHeader)+1);
-  p->header.info = (const StgInfoTable*)&Azh_con_info;
+  SET_HDR(p, FunPtr_con_info, CCS_SYSTEM);
   p->payload[0]  = (StgClosure *)a;
   return p;
 }
 
-#ifdef COMPILER /* GHC has em, Hugs doesn't */
 HaskellObj
-rts_mkBool (int b)
+rts_mkBool (HsBool b)
 {
   if (b) {
-    return (StgClosure *)&True_closure;
+    return (StgClosure *)True_closure;
   } else {
-    return (StgClosure *)&False_closure;
+    return (StgClosure *)False_closure;
   }
 }
 
 HaskellObj
 rts_mkString (char *s)
 {
-  return rts_apply((StgClosure *)&unpackCString_closure, rts_mkAddr(s));
+  return rts_apply((StgClosure *)unpackCString_closure, rts_mkPtr(s));
 }
-#endif /* COMPILER */
 
 HaskellObj
 rts_apply (HaskellObj f, HaskellObj arg)
 {
-  StgAP_UPD *ap = (StgAP_UPD *)allocate(AP_sizeW(1));
-  ap->header.info = &AP_UPD_info;
-  ap->n_args = 1;
-  ap->fun    = f;
-  ap->payload[0] = (P_)arg;
-  return (StgClosure *)ap;
+    StgClosure *ap;
+
+    ap = (StgClosure *)allocate(sizeofW(StgClosure) + 2);
+    SET_HDR(ap, (StgInfoTable *)&stg_ap_2_upd_info, CCS_SYSTEM);
+    ap->payload[0] = f;
+    ap->payload[1] = arg;
+    return (StgClosure *)ap;
 }
 
 /* ----------------------------------------------------------------------------
    Deconstructing Haskell objects
+
+   We would like to assert that we have the right kind of object in
+   each case, but this is problematic because in GHCi the info table
+   for the D# constructor (say) might be dynamically loaded.  Hence we
+   omit these assertions for now.
    ------------------------------------------------------------------------- */
 
-char
+HsChar
 rts_getChar (HaskellObj p)
 {
-  if ( p->header.info == (const StgInfoTable*)&Czh_con_info || 
-       p->header.info == (const StgInfoTable*)&Czh_static_info) {
-    return (char)(StgWord)(p->payload[0]);
-  } else {
-    barf("getChar: not a Char");
-  }
+    // See comment above:
+    // ASSERT(p->header.info == Czh_con_info ||
+    //        p->header.info == Czh_static_info);
+    return (StgChar)(StgWord)(p->payload[0]);
 }
 
-int
+HsInt
 rts_getInt (HaskellObj p)
 {
-  if ( 1 ||
-       p->header.info == (const StgInfoTable*)&Izh_con_info || 
-       p->header.info == (const StgInfoTable*)&Izh_static_info ) {
-    return (int)(p->payload[0]);
-  } else {
-    barf("getInt: not an Int");
-  }
+    // See comment above:
+    // ASSERT(p->header.info == Izh_con_info ||
+    //        p->header.info == Izh_static_info);
+    return (HsInt)(p->payload[0]);
+}
+
+HsInt8
+rts_getInt8 (HaskellObj p)
+{
+    // See comment above:
+    // ASSERT(p->header.info == I8zh_con_info ||
+    //        p->header.info == I8zh_static_info);
+    return (HsInt8)(HsInt)(p->payload[0]);
+}
+
+HsInt16
+rts_getInt16 (HaskellObj p)
+{
+    // See comment above:
+    // ASSERT(p->header.info == I16zh_con_info ||
+    //        p->header.info == I16zh_static_info);
+    return (HsInt16)(HsInt)(p->payload[0]);
 }
 
-int
+HsInt32
 rts_getInt32 (HaskellObj p)
 {
-  if ( 1 ||
-       p->header.info == (const StgInfoTable*)&Izh_con_info || 
-       p->header.info == (const StgInfoTable*)&Izh_static_info ) {
-    return (int)(p->payload[0]);
-  } else {
-    barf("getInt: not an Int");
-  }
+    // See comment above:
+    // ASSERT(p->header.info == I32zh_con_info ||
+    //        p->header.info == I32zh_static_info);
+    return (HsInt32)(p->payload[0]);
 }
 
-unsigned int
+HsInt64
+rts_getInt64 (HaskellObj p)
+{
+    HsInt64* tmp;
+    // See comment above:
+    // ASSERT(p->header.info == I64zh_con_info ||
+    //        p->header.info == I64zh_static_info);
+    tmp = (HsInt64*)&(p->payload[0]);
+    return *tmp;
+}
+HsWord
 rts_getWord (HaskellObj p)
 {
-  if ( 1 || /* see above comment */
-       p->header.info == (const StgInfoTable*)&Wzh_con_info ||
-       p->header.info == (const StgInfoTable*)&Wzh_static_info ) {
-    return (unsigned int)(p->payload[0]);
-  } else {
-    barf("getWord: not a Word");
-  }
+    // See comment above:
+    // ASSERT(p->header.info == Wzh_con_info ||
+    //        p->header.info == Wzh_static_info);
+    return (HsWord)(p->payload[0]);
+}
+
+HsWord8
+rts_getWord8 (HaskellObj p)
+{
+    // See comment above:
+    // ASSERT(p->header.info == W8zh_con_info ||
+    //        p->header.info == W8zh_static_info);
+    return (HsWord8)(HsWord)(p->payload[0]);
 }
 
-unsigned int
+HsWord16
+rts_getWord16 (HaskellObj p)
+{
+    // See comment above:
+    // ASSERT(p->header.info == W16zh_con_info ||
+    //        p->header.info == W16zh_static_info);
+    return (HsWord16)(HsWord)(p->payload[0]);
+}
+
+HsWord32
 rts_getWord32 (HaskellObj p)
 {
-  if ( 1 || /* see above comment */
-       p->header.info == (const StgInfoTable*)&Wzh_con_info ||
-       p->header.info == (const StgInfoTable*)&Wzh_static_info ) {
-    return (unsigned int)(p->payload[0]);
-  } else {
-    barf("getWord: not a Word");
-  }
+    // See comment above:
+    // ASSERT(p->header.info == W32zh_con_info ||
+    //        p->header.info == W32zh_static_info);
+    return (HsWord32)(p->payload[0]);
+}
+
+
+HsWord64
+rts_getWord64 (HaskellObj p)
+{
+    HsWord64* tmp;
+    // See comment above:
+    // ASSERT(p->header.info == W64zh_con_info ||
+    //        p->header.info == W64zh_static_info);
+    tmp = (HsWord64*)&(p->payload[0]);
+    return *tmp;
 }
 
-float
+HsFloat
 rts_getFloat (HaskellObj p)
 {
-  if ( p->header.info == (const StgInfoTable*)&Fzh_con_info || 
-       p->header.info == (const StgInfoTable*)&Fzh_static_info ) {
+    // See comment above:
+    // ASSERT(p->header.info == Fzh_con_info ||
+    //        p->header.info == Fzh_static_info);
     return (float)(PK_FLT((P_)p->payload));
-  } else {
-    barf("getFloat: not a Float");
-  }
 }
 
-double
+HsDouble
 rts_getDouble (HaskellObj p)
 {
-  if ( p->header.info == (const StgInfoTable*)&Dzh_con_info || 
-       p->header.info == (const StgInfoTable*)&Dzh_static_info ) {
+    // See comment above:
+    // ASSERT(p->header.info == Dzh_con_info ||
+    //        p->header.info == Dzh_static_info);
     return (double)(PK_DBL((P_)p->payload));
-  } else {
-    barf("getDouble: not a Double");
-  }
 }
 
-StgStablePtr
+HsStablePtr
 rts_getStablePtr (HaskellObj p)
 {
-  if ( p->header.info == (const StgInfoTable*)&StablePtr_con_info || 
-       p->header.info == (const StgInfoTable*)&StablePtr_static_info ) {
+    // See comment above:
+    // ASSERT(p->header.info == StablePtr_con_info ||
+    //        p->header.info == StablePtr_static_info);
     return (StgStablePtr)(p->payload[0]);
-  } else {
-    barf("getStablePtr: not a StablePtr");
-  }
 }
 
-void *
-rts_getAddr (HaskellObj p)
+HsPtr
+rts_getPtr (HaskellObj p)
 {
-  if ( p->header.info == (const StgInfoTable*)&Azh_con_info || 
-       p->header.info == (const StgInfoTable*)&Azh_static_info ) {
-  
+    // See comment above:
+    // ASSERT(p->header.info == Ptr_con_info ||
+    //        p->header.info == Ptr_static_info);
     return (void *)(p->payload[0]);
-  } else {
-    barf("getAddr: not an Addr");
-  }
 }
 
-#ifdef COMPILER /* GHC has em, Hugs doesn't */
-int
+HsFunPtr
+rts_getFunPtr (HaskellObj p)
+{
+    // See comment above:
+    // ASSERT(p->header.info == FunPtr_con_info ||
+    //        p->header.info == FunPtr_static_info);
+    return (void *)(p->payload[0]);
+}
+
+HsBool
 rts_getBool (HaskellObj p)
 {
-  if (p == &True_closure) {
+  if (p == True_closure) {
     return 1;
-  } else if (p == &False_closure) {
+  } else if (p == False_closure) {
     return 0;
   } else {
-    barf("getBool: not a Bool");
+    barf("rts_getBool: not a Bool");
   }
 }
-#endif /* COMPILER */
 
 /* ----------------------------------------------------------------------------
    Evaluating Haskell expressions
@@ -331,17 +382,19 @@ rts_getBool (HaskellObj p)
 SchedulerStatus
 rts_eval (HaskellObj p, /*out*/HaskellObj *ret)
 {
-  StgTSO *tso = createGenThread(RtsFlags.GcFlags.initialStkSize, p);
-  scheduleThread(tso);
-  return waitThread(tso, ret);
+    StgTSO *tso;
+
+    tso = createGenThread(RtsFlags.GcFlags.initialStkSize, p);
+    return scheduleWaitThread(tso,ret);
 }
 
 SchedulerStatus
 rts_eval_ (HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret)
 {
-  StgTSO *tso = createGenThread(stack_size, p);
-  scheduleThread(tso);
-  return waitThread(tso, ret);
+    StgTSO *tso;
+    
+    tso = createGenThread(stack_size, p);
+    return scheduleWaitThread(tso,ret);
 }
 
 /*
@@ -351,9 +404,50 @@ rts_eval_ (HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret)
 SchedulerStatus
 rts_evalIO (HaskellObj p, /*out*/HaskellObj *ret)
 {
-  StgTSO* tso = createStrictIOThread(RtsFlags.GcFlags.initialStkSize, p);
-  scheduleThread(tso);
-  return waitThread(tso, ret);
+    StgTSO* tso; 
+    
+    tso = createStrictIOThread(RtsFlags.GcFlags.initialStkSize, p);
+    return scheduleWaitThread(tso,ret);
+}
+
+/*
+ * Identical to rts_evalLazyIO(), but won't create a new task/OS thread
+ * to evaluate the Haskell thread. Used by main() only. Hack.
+ */
+SchedulerStatus
+rts_mainLazyIO(HaskellObj p, /*out*/HaskellObj *ret)
+{
+    StgTSO* tso;
+    
+    tso = createIOThread(RtsFlags.GcFlags.initialStkSize, p);
+    scheduleThread(tso);
+    return waitThread(tso, ret);
+}
+
+/*
+ * rts_evalStableIO() is suitable for calling from Haskell.  It
+ * evaluates a value of the form (StablePtr (IO a)), forcing the
+ * action's result to WHNF before returning.  The result is returned
+ * in a StablePtr.
+ */
+SchedulerStatus
+rts_evalStableIO (HsStablePtr s, /*out*/HsStablePtr *ret)
+{
+    StgTSO* tso;
+    StgClosure *p, *r;
+    SchedulerStatus stat;
+    
+    p = (StgClosure *)deRefStablePtr(s);
+    tso = createStrictIOThread(RtsFlags.GcFlags.initialStkSize, p);
+    stat = scheduleWaitThread(tso,&r);
+
+    if (stat == Success) {
+       ASSERT(r != NULL);
+       *ret = getStablePtr((StgPtr)r);
+    }
+
+    return stat;
 }
 
 /*
@@ -362,18 +456,61 @@ rts_evalIO (HaskellObj p, /*out*/HaskellObj *ret)
 SchedulerStatus
 rts_evalLazyIO (HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret)
 {
-  StgTSO *tso = createIOThread(stack_size, p);
-  scheduleThread(tso);
-  return waitThread(tso, ret);
+    StgTSO *tso;
+
+    tso = createIOThread(stack_size, p);
+    return scheduleWaitThread(tso,ret);
 }
 
 /* Convenience function for decoding the returned status. */
 
-void rts_checkSchedStatus ( char* site, SchedulerStatus rc )
-{
-  if ( rc == Success ) {
-     return;
-  } else {
-     barf("%s: Return code (%d) not ok",(site),(rc));
-  }
+void
+rts_checkSchedStatus ( char* site, SchedulerStatus rc )
+{
+    switch (rc) {
+    case Success:
+       return;
+    case Killed:
+       prog_belch("%s: uncaught exception",site);
+       stg_exit(EXIT_FAILURE);
+    case Interrupted:
+       prog_belch("%s: interrupted", site);
+       stg_exit(EXIT_FAILURE);
+    default:
+       prog_belch("%s: Return code (%d) not ok",(site),(rc));  
+       stg_exit(EXIT_FAILURE);
+    }
+}
+
+void
+rts_lock()
+{
+#ifdef RTS_SUPPORTS_THREADS
+       Capability *cap;
+       ACQUIRE_LOCK(&sched_mutex);
+       
+               // we request to get the capability immediately, in order to
+               // a) stop other threads from using allocate()
+               // b) wake the current worker thread from awaitEvent()
+               //       (so that a thread started by rts_eval* will start immediately)
+       grabReturnCapability(&sched_mutex,&cap);
+       
+               // now that we have the capability, we don't need it anymore
+               // (other threads will continue to run as soon as we release the sched_mutex)
+       releaseCapability(cap);
+       
+               // In the RTS hasn't been entered yet,
+               // start a RTS task.
+               // If there is already a task available (waiting for the work capability),
+               // this will do nothing.
+       startSchedulerTask();
+#endif
+}
+
+void
+rts_unlock()
+{
+#ifdef RTS_SUPPORTS_THREADS
+       RELEASE_LOCK(&sched_mutex);
+#endif
 }