[project @ 2001-02-21 11:36:01 by simonmar]
[ghc-hetmet.git] / ghc / includes / TSO.h
index 5cc34be..1f7aa8e 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
- * $Id: TSO.h,v 1.9 1999/12/01 14:34:49 simonmar Exp $
+ * $Id: TSO.h,v 1.19 2000/12/14 15:19:47 sewardj Exp $
  *
  * (c) The GHC Team, 1998-1999
  *
 #ifndef TSO_H
 #define TSO_H
 
+#if defined(GRAN) || defined(PAR)
+
+#if DEBUG // && PARANOIA_LEVEL>999
+// magic marker for TSOs; debugging only
+#define TSO_MAGIC 4321
+#endif
+
+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 +47,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 +74,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 */
+  ThreadEnterInterp,           /* 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;
 
 /*
@@ -86,13 +124,17 @@ typedef enum {
   BlockedOnRead,
   BlockedOnWrite,
   BlockedOnDelay
+#if defined(PAR)
+  , BlockedOnGA  // blocked on a remote closure represented by a Global Address
+  , BlockedOnGA_NoSend // same as above but without sending a Fetch message
+#endif
 } StgTSOBlockReason;
 
 typedef union {
   StgClosure *closure;
   struct StgTSO_ *tso;
   int fd;
-  unsigned int delay;
+  unsigned int target;
 } StgTSOBlockInfo;
 
 /*
@@ -101,26 +143,33 @@ typedef union {
  * storage manager, and won't be copied during garbage collection.
  */
 
+/* 
+ * ToDo: make this structure sensible on a non-32-bit arch.
+ */
+
 typedef struct StgTSO_ {
   StgHeader          header;
-  struct StgTSO_*    link;
-  StgMutClosure *    mut_link; /* TSO's are mutable of course! */
-  StgTSOWhatNext     whatNext;
-  StgTSOBlockReason  why_blocked;
+
+  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   : 16;
+  StgTSOBlockReason  why_blocked : 16;
   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* */
   StgWord            max_stack_size; /* maximum stack size in *words* */
   StgPtr             sp;
   StgUpdateFrame*    su;
-  StgPtr             splim;
   
   StgWord            stack[0];
 } StgTSO;
@@ -132,7 +181,6 @@ typedef struct StgTSO_ {
 
       tso->stack < tso->sp < tso->stack+tso->stack_size
       tso->stack_size <= tso->max_stack_size
-      tso->splim == tso->stack + RESERVED_STACK_WORDS;
       
       RESERVED_STACK_WORDS is large enough for any heap-check or
       stack-check failure.
@@ -141,7 +189,7 @@ typedef struct StgTSO_ {
         (a) smaller than a block, or
        (b) a multiple of BLOCK_SIZE
 
-       tso->block_reason      tso->block_info      location
+       tso->why_blocked       tso->block_info      location
         ----------------------------------------------------------------------
        NotBlocked             NULL                 runnable_queue, or running
        
@@ -154,17 +202,19 @@ typedef struct StgTSO_ {
         BlockedOnRead          NULL                 blocked_queue
         BlockedOnWrite         NULL                blocked_queue
         BlockedOnDelay         NULL                 blocked_queue
+       BlockedOnGA            closure TSO blocks on   BQ of that closure
+       BlockedOnGA_NoSend     closure TSO blocks on   BQ of that closure
 
       tso->link == END_TSO_QUEUE, if the thread is currently running.
 
    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).
@@ -179,6 +229,13 @@ typedef struct StgTSO_ {
       (StgTSO *)tso    if threads are currently awaiting delivery of
                        exceptions to this thread.
 
+   The 2 cases BlockedOnGA and BlockedOnGA_NoSend are needed in a GUM
+   setup only. They mark a TSO that has entered a FETCH_ME or
+   FETCH_ME_BQ closure, respectively; only the first TSO hitting the 
+   closure will send a Fetch message.
+   Currently we have no separate code for blocking on an RBH; we use the
+   BlockedOnBlackHole case for that.   -- HWL
+
  ---------------------------------------------------------------------------- */
 
 /* Workaround for a bug/quirk in gcc on certain architectures.