[project @ 2004-03-01 14:18:35 by simonmar]
[ghc-hetmet.git] / ghc / includes / TSO.h
index 1f7aa8e..22f3e53 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
- * $Id: TSO.h,v 1.19 2000/12/14 15:19:47 sewardj Exp $
+ * $Id: TSO.h,v 1.34 2004/03/01 14:18:35 simonmar Exp $
  *
  * (c) The GHC Team, 1998-1999
  *
@@ -12,8 +12,7 @@
 
 #if defined(GRAN) || defined(PAR)
 
-#if DEBUG // && PARANOIA_LEVEL>999
-// magic marker for TSOs; debugging only
+#if DEBUG
 #define TSO_MAGIC 4321
 #endif
 
@@ -42,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 */
 
 
@@ -65,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 {
@@ -78,20 +103,15 @@ typedef enum {
  * 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 */
-  ThreadEnterInterp,           /* 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;
 
@@ -108,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
@@ -124,16 +154,34 @@ 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_NoSend // same as above but without sending a Fetch message
 #endif
+  , BlockedOnCCall
+  , BlockedOnCCall_NoUnblockExc // same as above but don't unblock
+                               // async exceptions in resumeThread()
 } 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;
+#if defined(mingw32_TARGET_OS)
+  StgAsyncIOResult* async_result;
+#endif
   unsigned int target;
 } StgTSOBlockInfo;
 
@@ -154,24 +202,26 @@ typedef struct StgTSO_ {
   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;
-
+  StgTSOWhatNext         what_next   : 16;
+  StgTSOBlockReason      why_blocked : 16;
+  StgTSOBlockInfo        block_info;
+  struct StgTSO_*        blocked_exceptions;
+  StgThreadID            id;
+  int                    saved_errno;
+  struct StgMainThread_* main;
+  
+  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;
   
-  StgWord            stack[0];
+  StgWord            stack[FLEXIBLE_ARRAY];
 } StgTSO;
 
 /* -----------------------------------------------------------------------------
@@ -246,7 +296,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_))