[project @ 2002-11-21 17:43:43 by simonpj]
[ghc-hetmet.git] / ghc / rts / RtsAPI.c
index de6de62..7449bad 100644 (file)
@@ -1,12 +1,13 @@
 /* ----------------------------------------------------------------------------
- * $Id: RtsAPI.c,v 1.20 2000/08/29 13:34:21 qrczak Exp $
+ * $Id: RtsAPI.c,v 1.36 2002/08/16 14:30:21 simonmar Exp $
  *
- * (c) The GHC Team, 1998-2000
+ * (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"
+
+#if defined(RTS_SUPPORTS_THREADS)
+/* Cheesy locking scheme while waiting for the 
+ * RTS API to change.
+ */
+static Mutex     alloc_mutex = INIT_MUTEX_VAR;
+static Condition alloc_cond  = INIT_COND_VAR;
+#define INVALID_THREAD_ID ((OSThreadId)(-1))
+
+/* Thread currently owning the allocator */
+static OSThreadId c_id = INVALID_THREAD_ID;
+
+static StgPtr alloc(nat n)
+{
+  OSThreadId tid = osThreadId();
+  ACQUIRE_LOCK(&alloc_mutex);
+  if (tid == c_id) {
+    /* I've got the lock, just allocate() */
+    ;
+  } else if (c_id == INVALID_THREAD_ID) {
+    c_id = tid;
+  } else {
+    waitCondition(&alloc_cond, &alloc_mutex);
+    c_id = tid;
+  }
+  RELEASE_LOCK(&alloc_mutex);
+  return allocate(n);
+}
+
+static void releaseAllocLock(void)
+{
+  ACQUIRE_LOCK(&alloc_mutex);
+  /* Reset the allocator owner */
+  c_id = INVALID_THREAD_ID;
+  RELEASE_LOCK(&alloc_mutex);
+
+  /* Free up an OS thread waiting to get in */
+  signalCondition(&alloc_cond);
+}
+#else
+# define alloc(n) allocate(n)
+# define releaseAllocLock() /* nothing */
+#endif
+
 
 /* ----------------------------------------------------------------------------
    Building Haskell objects from C datatypes.
    ------------------------------------------------------------------------- */
 HaskellObj
-rts_mkChar (unsigned int c)
+rts_mkChar (HsChar c)
 {
-  StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,1));
-  p->header.info = Czh_con_info;
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,1));
+  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 = Izh_con_info;
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,1));
+  SET_HDR(p, Izh_con_info, CCS_SYSTEM);
   p->payload[0]  = (StgClosure *)(StgInt)i;
   return p;
 }
 
 HaskellObj
-rts_mkInt8 (int 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 = Izh_con_info;
+rts_mkInt8 (HsInt8 i)
+{
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,1));
+  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)
-{
-  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 = Izh_con_info;
+rts_mkInt16 (HsInt16 i)
+{
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,1));
+  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 = Izh_con_info;
-  p->payload[0]  = (StgClosure *)(StgInt)i;
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,1));
+  SET_HDR(p, I32zh_con_info, CCS_SYSTEM);
+  p->payload[0]  = (StgClosure *)(StgInt)((unsigned)i & 0xffffffff);
   return p;
 }
 
 HaskellObj
-rts_mkInt64 (HsInt64_ i)
+rts_mkInt64 (HsInt64 i)
 {
   long long *tmp;
-  StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,2));
-  /* see mk_Int8 comment */
-  p->header.info = I64zh_con_info;
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,2));
+  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 = Wzh_con_info;
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,1));
+  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 = Wzh_con_info;
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,1));
+  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 = Wzh_con_info;
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,1));
+  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 = Wzh_con_info;
-  p->payload[0]  = (StgClosure *)(StgWord)w;
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,1));
+  SET_HDR(p, W32zh_con_info, CCS_SYSTEM);
+  p->payload[0]  = (StgClosure *)(StgWord)(w & 0xffffffff);
   return p;
 }
 
 HaskellObj
-rts_mkWord64 (HsWord64_ w)
+rts_mkWord64 (HsWord64 w)
 {
   unsigned long long *tmp;
 
-  StgClosure *p = (StgClosure *)allocate(CONSTR_sizeW(0,2));
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,2));
   /* see mk_Int8 comment */
-  p->header.info = 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 = Fzh_con_info;
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,1));
+  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 = Dzh_con_info;
+  StgClosure *p = (StgClosure *)alloc(CONSTR_sizeW(0,sizeofW(StgDouble)));
+  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 = StablePtr_con_info;
+  StgClosure *p = (StgClosure *)alloc(sizeofW(StgHeader)+1);
+  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);
-  p->header.info = Azh_con_info;
+  StgClosure *p = (StgClosure *)alloc(sizeofW(StgHeader)+1);
+  SET_HDR(p, Ptr_con_info, CCS_SYSTEM);
   p->payload[0]  = (StgClosure *)a;
   return p;
 }
 
 #ifdef COMPILER /* GHC has em, Hugs doesn't */
 HaskellObj
-rts_mkBool (StgBool b)
+rts_mkBool (HsBool b)
 {
   if (b) {
     return (StgClosure *)True_closure;
@@ -188,131 +225,207 @@ rts_mkBool (StgBool b)
 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));
-  SET_HDR(ap, &AP_UPD_info, CCS_SYSTEM);
-  ap->n_args = 1;
-  ap->fun    = f;
-  ap->payload[0] = arg;
-  return (StgClosure *)ap;
+    StgClosure *ap;
+
+    ap = (StgClosure *)alloc(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
    ------------------------------------------------------------------------- */
 
-unsigned int
+HsChar
 rts_getChar (HaskellObj p)
 {
   if ( p->header.info == Czh_con_info || 
        p->header.info == Czh_static_info) {
     return (StgChar)(StgWord)(p->payload[0]);
   } else {
-    barf("getChar: not a Char");
+    barf("rts_getChar: not a Char");
   }
 }
 
-int
+HsInt
 rts_getInt (HaskellObj p)
 {
   if ( 1 ||
        p->header.info == Izh_con_info || 
        p->header.info == Izh_static_info ) {
-    return (int)(p->payload[0]);
+    return (HsInt)(p->payload[0]);
+  } else {
+    barf("rts_getInt: not an Int");
+  }
+}
+
+HsInt8
+rts_getInt8 (HaskellObj p)
+{
+  if ( 1 ||
+       p->header.info == I8zh_con_info || 
+       p->header.info == I8zh_static_info ) {
+    return (HsInt8)(HsInt)(p->payload[0]);
+  } else {
+    barf("rts_getInt8: not an Int8");
+  }
+}
+
+HsInt16
+rts_getInt16 (HaskellObj p)
+{
+  if ( 1 ||
+       p->header.info == I16zh_con_info || 
+       p->header.info == I16zh_static_info ) {
+    return (HsInt16)(HsInt)(p->payload[0]);
   } else {
-    barf("getInt: not an Int");
+    barf("rts_getInt16: not an Int16");
   }
 }
 
-int
+HsInt32
 rts_getInt32 (HaskellObj p)
 {
   if ( 1 ||
-       p->header.info == Izh_con_info || 
-       p->header.info == Izh_static_info ) {
-    return (int)(p->payload[0]);
+       p->header.info == I32zh_con_info || 
+       p->header.info == I32zh_static_info ) {
+    return (HsInt32)(p->payload[0]);
   } else {
-    barf("getInt: not an Int");
+    barf("rts_getInt32: not an Int32");
   }
 }
 
-unsigned int
+HsInt64
+rts_getInt64 (HaskellObj p)
+{
+  HsInt64* tmp;
+  if ( 1 ||
+       p->header.info == I64zh_con_info || 
+       p->header.info == I64zh_static_info ) {
+    tmp = (HsInt64*)&(p->payload[0]);
+    return *tmp;
+  } else {
+    barf("rts_getInt64: not an Int64");
+  }
+}
+HsWord
 rts_getWord (HaskellObj p)
 {
   if ( 1 || /* see above comment */
        p->header.info == Wzh_con_info ||
        p->header.info == Wzh_static_info ) {
-    return (unsigned int)(p->payload[0]);
+    return (HsWord)(p->payload[0]);
+  } else {
+    barf("rts_getWord: not a Word");
+  }
+}
+
+HsWord8
+rts_getWord8 (HaskellObj p)
+{
+  if ( 1 || /* see above comment */
+       p->header.info == W8zh_con_info ||
+       p->header.info == W8zh_static_info ) {
+    return (HsWord8)(HsWord)(p->payload[0]);
+  } else {
+    barf("rts_getWord8: not a Word8");
+  }
+}
+
+HsWord16
+rts_getWord16 (HaskellObj p)
+{
+  if ( 1 || /* see above comment */
+       p->header.info == W16zh_con_info ||
+       p->header.info == W16zh_static_info ) {
+    return (HsWord16)(HsWord)(p->payload[0]);
   } else {
-    barf("getWord: not a Word");
+    barf("rts_getWord16: not a Word16");
   }
 }
 
-unsigned int
+HsWord32
 rts_getWord32 (HaskellObj p)
 {
   if ( 1 || /* see above comment */
-       p->header.info == Wzh_con_info ||
-       p->header.info == Wzh_static_info ) {
+       p->header.info == W32zh_con_info ||
+       p->header.info == W32zh_static_info ) {
     return (unsigned int)(p->payload[0]);
   } else {
-    barf("getWord: not a Word");
+    barf("rts_getWord: not a Word");
+  }
+}
+
+
+HsWord64
+rts_getWord64 (HaskellObj p)
+{
+  HsWord64* tmp;
+  if ( 1 || /* see above comment */
+       p->header.info == W64zh_con_info ||
+       p->header.info == W64zh_static_info ) {
+    tmp = (HsWord64*)&(p->payload[0]);
+    return *tmp;
+  } else {
+    barf("rts_getWord64: not a Word64");
   }
 }
 
-float
+HsFloat
 rts_getFloat (HaskellObj p)
 {
   if ( 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");
+    barf("rts_getFloat: not a Float");
   }
 }
 
-double
+HsDouble
 rts_getDouble (HaskellObj p)
 {
   if ( 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");
+    barf("rts_getDouble: not a Double");
   }
 }
 
-StgStablePtr
+HsStablePtr
 rts_getStablePtr (HaskellObj p)
 {
   if ( p->header.info == StablePtr_con_info || 
        p->header.info == StablePtr_static_info ) {
     return (StgStablePtr)(p->payload[0]);
   } else {
-    barf("getStablePtr: not a StablePtr");
+    barf("rts_getStablePtr: not a StablePtr");
   }
 }
 
-void *
-rts_getAddr (HaskellObj p)
+HsPtr
+rts_getPtr (HaskellObj p)
 {
-  if ( p->header.info == Azh_con_info || 
-       p->header.info == Azh_static_info ) {
-  
+  if ( p->header.info == Ptr_con_info || 
+       p->header.info == Ptr_static_info ) {
     return (void *)(p->payload[0]);
   } else {
-    barf("getAddr: not an Addr");
+    barf("rts_getPtr: not an Ptr");
   }
 }
 
 #ifdef COMPILER /* GHC has em, Hugs doesn't */
-int
+HsBool
 rts_getBool (HaskellObj p)
 {
   if (p == True_closure) {
@@ -320,7 +433,7 @@ rts_getBool (HaskellObj p)
   } else if (p == False_closure) {
     return 0;
   } else {
-    barf("getBool: not a Bool");
+    barf("rts_getBool: not a Bool");
   }
 }
 #endif /* COMPILER */
@@ -331,17 +444,21 @@ 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);
+    releaseAllocLock();
+    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);
+    releaseAllocLock();
+    return scheduleWaitThread(tso,ret);
 }
 
 /*
@@ -351,36 +468,66 @@ 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);
+    releaseAllocLock();
+    return scheduleWaitThread(tso,ret);
 }
 
 /*
- * Like rts_evalIO(), but doesn't force the action's result.
+ * Identical to rts_evalIO(), but won't create a new task/OS thread
+ * to evaluate the Haskell thread. Used by main() only. Hack.
  */
 SchedulerStatus
-rts_evalLazyIO (HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret)
+rts_mainEvalIO(HaskellObj p, /*out*/HaskellObj *ret)
 {
-  StgTSO *tso = createIOThread(stack_size, p);
-  scheduleThread(tso);
-  return waitThread(tso, ret);
+    StgTSO* tso; 
+    
+    tso = createStrictIOThread(RtsFlags.GcFlags.initialStkSize, p);
+    releaseAllocLock();
+    scheduleThread(tso);
+    return waitThread(tso, ret);
 }
 
-#if defined(PAR) || defined(SMP)
 /*
-  Needed in the parallel world for non-Main PEs, which do not get a piece
-  of work to start with --- they have to humbly ask for it
-*/
+ * 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);
+    releaseAllocLock();
+    stat = scheduleWaitThread(tso,&r);
+
+    if (stat == Success) {
+       ASSERT(r != NULL);
+       *ret = getStablePtr((StgPtr)r);
+    }
+
+    return stat;
+}
 
+/*
+ * Like rts_evalIO(), but doesn't force the action's result.
+ */
 SchedulerStatus
-rts_evalNothing(unsigned int stack_size)
+rts_evalLazyIO (HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret)
 {
-  /* ToDo: propagate real SchedulerStatus back to caller */
-  scheduleThread(END_TSO_QUEUE);
-  return Success;
+    StgTSO *tso;
+
+    tso = createIOThread(stack_size, p);
+    releaseAllocLock();
+    return scheduleWaitThread(tso,ret);
 }
-#endif
 
 /* Convenience function for decoding the returned status. */
 
@@ -394,8 +541,6 @@ rts_checkSchedStatus ( char* site, SchedulerStatus rc )
        barf("%s: uncaught exception",site);
     case Interrupted:
        barf("%s: interrupted", site);
-    case Deadlock:
-       barf("%s: no threads to run:  infinite loop or deadlock?", site);
     default:
        barf("%s: Return code (%d) not ok",(site),(rc));        
     }