[project @ 2000-03-20 09:42:49 by andy]
[ghc-hetmet.git] / ghc / includes / TSO.h
index 2c53ab9..4de0562 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
- * $Id: TSO.h,v 1.8 1999/08/25 16:11:44 simonmar Exp $
+ * $Id: TSO.h,v 1.14 2000/03/20 09:42:49 andy Exp $
  *
  * (c) The GHC Team, 1998-1999
  *
 #ifndef TSO_H
 #define TSO_H
 
+#if defined(GRAN) || defined(PAR)
+// magic marker for TSOs; debugging only
+#define TSO_MAGIC 4321
+
+typedef struct {
+  StgInt   pri;
+  StgInt   magic;
+  StgInt   sparkname;
+  rtsTime  startedat;
+  rtsBool  exported;
+  StgInt   basicblocks;
+  StgInt   allocs;
+  rtsTime  exectime;
+  rtsTime  fetchtime;
+  rtsTime  fetchcount;
+  rtsTime  blocktime;
+  StgInt   blockcount;
+  rtsTime  blockedat;
+  StgInt   globalsparks;
+  StgInt   localsparks;
+  rtsTime  clock;
+} StgTSOStatBuf;
+#endif
+
 #if defined(PROFILING)
 typedef struct {
   CostCentreStack *CCCS;       /* thread's current CCS */
@@ -20,14 +44,21 @@ typedef struct {
 #endif /* PROFILING */
 
 #if defined(PAR)
-typedef struct {
-} StgTSOParInfo;
+typedef StgTSOStatBuf StgTSOParInfo;
 #else /* !PAR */
 typedef struct {
 } StgTSOParInfo;
 #endif /* PAR */
 
-#if defined(TICKY_TICKY)
+#if defined(GRAN)
+typedef StgTSOStatBuf StgTSOGranInfo;
+#else /* !GRAN */
+typedef struct {
+} StgTSOGranInfo;
+#endif /* GRAN */
+
+
+#if defined(TICKY)
 typedef struct {
 } StgTSOTickyInfo;
 #else /* !TICKY_TICKY */
@@ -40,12 +71,16 @@ typedef enum {
     tso_state_stopped
 } StgTSOState;
 
+/*
+ * The what_next field of a TSO indicates how the thread is to be run. 
+ */
 typedef enum {
-  ThreadEnterGHC,
-  ThreadRunGHC,
-  ThreadEnterHugs,
-  ThreadKilled,
-  ThreadComplete
+  ThreadEnterGHC,              /* enter top thunk on stack */
+  ThreadRunGHC,                        /* return to address on top of stack */
+  ThreadEnterHugs,             /* enter top thunk on stack (w/ interpreter) */
+  ThreadKilled,                        /* thread has died, don't run it */
+  ThreadRelocated,             /* thread has moved, link points to new locn */
+  ThreadComplete               /* thread has finished */
 } StgTSOWhatNext;
 
 /*
@@ -82,15 +117,27 @@ typedef enum {
   NotBlocked,
   BlockedOnMVar,
   BlockedOnBlackHole,
+  BlockedOnException,
   BlockedOnRead,
   BlockedOnWrite,
   BlockedOnDelay
+#if defined(PAR)
+  , BlockedOnGA    // blocked on a remote closure represented by a Global Address
+#endif
 } StgTSOBlockReason;
 
 typedef union {
   StgClosure *closure;
+  struct StgTSO_ *tso;
   int fd;
+#if defined(INTERPRETER) && !defined(HAVE_SETITIMER)
+  unsigned int target;
+#else
   unsigned int delay;
+#endif
+#if defined(PAR)
+  globalAddr ga;
+#endif
 } StgTSOBlockInfo;
 
 /*
@@ -101,16 +148,20 @@ typedef union {
 
 typedef struct StgTSO_ {
   StgHeader          header;
-  struct StgTSO_*    link;
-  StgMutClosure *    mut_link; /* TSO's are mutable of course! */
-  StgTSOWhatNext     whatNext;
+
+  struct StgTSO_*    link;          /* Links threads onto blocking queues */
+  StgMutClosure *    mut_link;      /* TSO's are mutable of course! */
+  struct StgTSO_*    global_link;    /* Links all threads together */
+  
+  StgTSOWhatNext     what_next;
   StgTSOBlockReason  why_blocked;
   StgTSOBlockInfo    block_info;
+  struct StgTSO_*    blocked_exceptions;
   StgThreadID        id;
   StgTSOTickyInfo    ticky; 
   StgTSOProfInfo     prof;
   StgTSOParInfo      par;
-  /* GranSim Info? */
+  StgTSOGranInfo     gran;
 
   /* The thread stack... */
   StgWord           stack_size;     /* stack size in *words* */
@@ -122,8 +173,6 @@ typedef struct StgTSO_ {
   StgWord            stack[0];
 } StgTSO;
 
-extern DLL_IMPORT_RTS StgTSO      *CurrentTSO;
-
 /* -----------------------------------------------------------------------------
    Invariants:
 
@@ -140,28 +189,45 @@ extern DLL_IMPORT_RTS StgTSO      *CurrentTSO;
         (a) smaller than a block, or
        (b) a multiple of BLOCK_SIZE
 
-      tso->link
-          == END_TSO_QUEUE  , iff the thread is currently running.
-          == (StgTSO *)     , otherwise, and it is linked onto either:
+       tso->block_reason      tso->block_info      location
+        ----------------------------------------------------------------------
+       NotBlocked             NULL                 runnable_queue, or running
+       
+        BlockedOnBlackHole     the BLACKHOLE_BQ     the BLACKHOLE_BQ's queue
+       
+        BlockedOnMVar          the MVAR             the MVAR's queue
+       
+        BlockedOnException     the TSO              TSO->blocked_exception
+
+        BlockedOnRead          NULL                 blocked_queue
+        BlockedOnWrite         NULL                blocked_queue
+        BlockedOnDelay         NULL                 blocked_queue
+
+      tso->link == END_TSO_QUEUE, if the thread is currently running.
 
-          - the runnable_queue       tso->blocked_on == END_TSO_QUEUE
-          - the blocked_queue       tso->blocked_on == END_TSO_QUEUE
-          - a BLACKHOLE_BQ,          tso->blocked_on == the BLACKHOLE_BQ
-          - an MVAR,                 tso->blocked_on == the MVAR
-                               
    A zombie thread has the following properties:
       
-      tso->whatNext == ThreadComplete or ThreadKilled
+      tso->what_next == ThreadComplete or ThreadKilled
       tso->link     ==  (could be on some queue somewhere)
       tso->su       ==  tso->stack + tso->stack_size
       tso->sp       ==  tso->stack + tso->stack_size - 1 (i.e. top stack word)
-      tso->sp[0]    ==  return value of thread, if whatNext == ThreadComplete,
-                        exception             , if whatNext == ThreadKilled
+      tso->sp[0]    ==  return value of thread, if what_next == ThreadComplete,
+                        exception             , if what_next == ThreadKilled
 
       (tso->sp is left pointing at the top word on the stack so that
       the return value or exception will be retained by a GC).
 
-   ---------------------------------------------------------------------------- */
+   tso->blocked_exceptions is either:
+
+      NULL             if async exceptions are unblocked.
+
+      END_TSO_QUEUE    if async exceptions are blocked, but no threads
+                       are currently waiting to deliver.
+
+      (StgTSO *)tso    if threads are currently awaiting delivery of
+                       exceptions to this thread.
+
+ ---------------------------------------------------------------------------- */
 
 /* Workaround for a bug/quirk in gcc on certain architectures.
  * symptom is that (&tso->stack - &tso->header) /=  sizeof(StgTSO)