[project @ 2004-02-12 02:04:59 by mthomas]
[ghc-hetmet.git] / ghc / includes / TSO.h
index 2b81f76..f72d3bb 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
- * $Id: TSO.h,v 1.11 2000/01/22 18:00:03 simonmar Exp $
+ * $Id: TSO.h,v 1.33 2003/11/12 17:27:05 sof Exp $
  *
  * (c) The GHC Team, 1998-1999
  *
 #define TSO_H
 
 #if defined(GRAN) || defined(PAR)
-// magic marker for TSOs; debugging only
+
+#if DEBUG
 #define TSO_MAGIC 4321
+#endif
 
 typedef struct {
   StgInt   pri;
@@ -39,22 +41,45 @@ typedef struct {
   CostCentreStack *CCCS;       /* thread's current CCS */
 } StgTSOProfInfo;
 #else /* !PROFILING */
+# if defined(SUPPORTS_EMPTY_STRUCTS)
 typedef struct {
+    /* empty */
 } StgTSOProfInfo;
+# endif
 #endif /* PROFILING */
 
 #if defined(PAR)
 typedef StgTSOStatBuf StgTSOParInfo;
 #else /* !PAR */
+# if defined(SUPPORTS_EMPTY_STRUCTS)
 typedef struct {
+    /* empty */
 } StgTSOParInfo;
+# endif
 #endif /* PAR */
 
+#if defined(DIST)
+typedef struct {
+  StgThreadPriority  priority;   
+  StgInt             revalTid;   /* ToDo: merge both into 1 word */
+  StgInt             revalSlot;
+} StgTSODistInfo;
+#else /* !DIST */
+# if defined(SUPPORTS_EMPTY_STRUCTS)
+typedef struct {
+    /* empty */
+} StgTSODistInfo;
+# endif
+#endif /* DIST */
+
 #if defined(GRAN)
 typedef StgTSOStatBuf StgTSOGranInfo;
 #else /* !GRAN */
+# if defined(SUPPORTS_EMPTY_STRUCTS)
 typedef struct {
+    /* empty */
 } StgTSOGranInfo;
+# endif
 #endif /* GRAN */
 
 
@@ -62,8 +87,11 @@ typedef struct {
 typedef struct {
 } StgTSOTickyInfo;
 #else /* !TICKY_TICKY */
+# if defined(SUPPORTS_EMPTY_STRUCTS)
 typedef struct {
+    /* empty */
 } StgTSOTickyInfo;
+# endif
 #endif /* TICKY_TICKY */
 
 typedef enum {
@@ -72,23 +100,18 @@ typedef enum {
 } StgTSOState;
 
 /*
- * The whatNext field of a TSO indicates how the thread is to be run. 
+ * The what_next field of a TSO indicates how the thread is to be run. 
  */
 typedef enum {
-  ThreadEnterGHC,              /* enter top thunk on stack */
   ThreadRunGHC,                        /* return to address on top of stack */
-  ThreadEnterHugs,             /* enter top thunk on stack (w/ interpreter) */
+  ThreadInterpret,             /* interpret this thread */
   ThreadKilled,                        /* thread has died, don't run it */
   ThreadRelocated,             /* thread has moved, link points to new locn */
   ThreadComplete               /* thread has finished */
 } StgTSOWhatNext;
 
 /*
- * We are completely paranoid and make thread IDs 64 bits to avoid
- * having to worry about overflow.  A little calculation shows that
- * even doing 10^6 forks per second would take 35 million years to
- * overflow a 64 bit thread ID :-)
- *
+ * Thread IDs are 32 bits.
  */
 typedef StgWord32 StgThreadID;
 
@@ -105,6 +128,16 @@ typedef enum {
   ThreadFinished
 } StgThreadReturnCode;
 
+/*
+ * We distinguish between the various classes of threads in the system.
+ */
+
+typedef enum {
+  AdvisoryPriority,
+  MandatoryPriority,
+  RevalPriority
+} StgThreadPriority;
+
 /* 
  * Threads may be blocked for several reasons.  A blocked thread will
  * have the reason in the why_blocked field of the TSO, and some
@@ -121,19 +154,37 @@ typedef enum {
   BlockedOnRead,
   BlockedOnWrite,
   BlockedOnDelay
+#if defined(mingw32_TARGET_OS)
+  , BlockedOnDoProc
+#endif
 #if defined(PAR)
-  , BlockedOnGA    // blocked on a remote closure represented by a Global Address
+  , BlockedOnGA  // blocked on a remote closure represented by a Global Address
+  , BlockedOnGA_NoSend // same as above but without sending a Fetch message
+#endif
+#if defined(RTS_SUPPORTS_THREADS)
+  , BlockedOnCCall
+  , BlockedOnCCall_NoUnblockExc // same as above but don't unblock async exceptions
+                               // in resumeThread()
 #endif
 } StgTSOBlockReason;
 
+#if defined(mingw32_TARGET_OS)
+/* results from an async I/O request + it's ID. */
+typedef struct {
+  unsigned int reqID;
+  int          len;
+  int          errCode;
+} StgAsyncIOResult;
+#endif
+
 typedef union {
   StgClosure *closure;
   struct StgTSO_ *tso;
   int fd;
-  unsigned int delay;
-#if defined(PAR)
-  globalAddr ga;
+#if defined(mingw32_TARGET_OS)
+  StgAsyncIOResult* async_result;
 #endif
+  unsigned int target;
 } StgTSOBlockInfo;
 
 /*
@@ -142,29 +193,36 @@ 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;
-  /* SDM and HWL agree that it would be cool to have a list of all TSOs */
-  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;
-  StgTSOGranInfo     gran;
-
+  int                saved_errno;
+  
+  MAYBE_EMPTY_STRUCT(StgTSOTickyInfo,ticky)
+  MAYBE_EMPTY_STRUCT(StgTSOProfInfo,prof)
+  MAYBE_EMPTY_STRUCT(StgTSOParInfo,par)
+  MAYBE_EMPTY_STRUCT(StgTSOGranInfo,gran)
+  MAYBE_EMPTY_STRUCT(StgTSODistInfo,dist)
+    
   /* 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];
+  StgWord            stack[FLEXIBLE_ARRAY];
 } StgTSO;
 
 /* -----------------------------------------------------------------------------
@@ -174,7 +232,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.
@@ -183,7 +240,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
        
@@ -196,17 +253,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).
@@ -221,6 +280,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.
@@ -231,7 +297,7 @@ typedef struct StgTSO_ {
 extern StgTSO dummy_tso;
 
 #define TSO_STRUCT_SIZE \
-   ((int)&(dummy_tso).stack - (int)&(dummy_tso).header)
+   ((char *)&dummy_tso.stack - (char *)&dummy_tso.header)
 
 #define TSO_STRUCT_SIZEW (TSO_STRUCT_SIZE / sizeof(W_))