/* -----------------------------------------------------------------------------
- * $Id: TSO.h,v 1.3 1999/01/13 17:25:55 simonm Exp $
+ * $Id: TSO.h,v 1.37 2004/11/08 12:26:57 simonmar Exp $
+ *
+ * (c) The GHC Team, 1998-1999
*
* The definitions for Thread State Objects.
*
#ifndef TSO_H
#define TSO_H
-#if defined(PROFILING)
+#if DEBUG
+#define TSO_MAGIC 4321
+#endif
+
typedef struct {
- CostCentreStack *CCCS; /* thread's current CCS */
-} StgTSOProfInfo;
-#else /* !PROFILING */
+ 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;
+
+/*
+ * GRAN: We distinguish between the various classes of threads in
+ * the system.
+ */
+typedef enum {
+ AdvisoryPriority,
+ MandatoryPriority,
+ RevalPriority
+} StgThreadPriority;
+
+/*
+ * PROFILING info in a TSO
+ */
typedef struct {
+ CostCentreStack *CCCS; /* thread's current CCS */
} StgTSOProfInfo;
-#endif /* PROFILING */
-#if defined(PAR)
-typedef struct {
-} StgTSOParInfo;
-#else /* !PAR */
-typedef struct {
-} StgTSOParInfo;
-#endif /* PAR */
+/*
+ * PAR info in a TSO
+ */
+typedef StgTSOStatBuf StgTSOParInfo;
-#if defined(TICKY)
-typedef struct {
-} StgTSOTickyInfo;
-#else /* !TICKY */
+/*
+ * DIST info in a TSO
+ */
typedef struct {
-} StgTSOTickyInfo;
-#endif /* TICKY */
+ StgThreadPriority priority;
+ StgInt revalTid; /* ToDo: merge both into 1 word */
+ StgInt revalSlot;
+} StgTSODistInfo;
-typedef enum {
- tso_state_runnable,
- tso_state_stopped
-} StgTSOState;
+/*
+ * GRAN info in a TSO
+ */
+typedef StgTSOStatBuf StgTSOGranInfo;
-typedef enum {
- ThreadEnterGHC,
- ThreadRunGHC,
- ThreadEnterHugs,
- ThreadKilled,
- ThreadComplete
-} StgTSOWhatNext;
+/*
+ * There is no TICKY info in a TSO at this time.
+ */
/*
- * 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 StgNat32 StgThreadID;
+typedef StgWord32 StgThreadID;
/*
- * This type is returned to the scheduler by a thread that has
- * stopped for one reason or another.
+ * Type returned after running a thread. Values of this type
+ * include HeapOverflow, StackOverflow etc. See Constants.h for the
+ * full list.
*/
+typedef unsigned int StgThreadReturnCode;
-typedef enum {
- HeapOverflow, /* might also be StackOverflow */
- StackOverflow,
- ThreadYielding,
- ThreadBlocked,
- ThreadFinished
-} StgThreadReturnCode;
+#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;
/*
* TSOs live on the heap, and therefore look just like heap objects.
* storage manager, and won't be copied during garbage collection.
*/
+/*
+ * Threads may be blocked for several reasons. A blocked thread will
+ * have the reason in the why_blocked field of the TSO, and some
+ * further info (such as the closure the thread is blocked on, or the
+ * file descriptor if the thread is waiting on I/O) in the block_info
+ * field.
+ */
+
+/*
+ * 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;
- StgTSOState state; /* necessary? */
+
+ 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 */
+
+ StgWord16 what_next; // Values defined in Constants.h
+ StgWord16 why_blocked; // Values defined in Constants.h
+ StgTSOBlockInfo block_info;
+ struct StgTSO_* blocked_exceptions;
StgThreadID id;
- /* Exception Handlers */
- StgTSOTickyInfo ticky;
- StgTSOProfInfo prof;
- StgTSOParInfo par;
- /* GranSim Info? */
+ int saved_errno;
+ struct StgMainThread_* main;
+
+#ifdef TICKY_TICKY
+ // TICKY-specific stuff would go here.
+#endif
+#ifdef PROFILING
+ StgTSOProfInfo prof;
+#endif
+#ifdef PAR
+ StgTSOParInfo par;
+#endif
+#ifdef GRAN
+ StgTSOGranInfo gran;
+#endif
+#ifdef DIST
+ StgTSODistInfo dist;
+#endif
/* 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;
-extern StgTSO *CurrentTSO;
+/* -----------------------------------------------------------------------------
+ Invariants:
+
+ An active thread has the following properties:
+
+ tso->stack < tso->sp < tso->stack+tso->stack_size
+ tso->stack_size <= tso->max_stack_size
+
+ RESERVED_STACK_WORDS is large enough for any heap-check or
+ stack-check failure.
+
+ The size of the TSO struct plus the stack is either
+ (a) smaller than a block, or
+ (b) a multiple of BLOCK_SIZE
+
+ tso->why_blocked 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
+ 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->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 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.
+
+ 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.
* symptom is that (&tso->stack - &tso->header) /= sizeof(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_))
+
+/* this is the NIL ptr for a TSO queue (e.g. runnable queue) */
+#define END_TSO_QUEUE ((StgTSO *)(void*)&stg_END_TSO_QUEUE_closure)
+
+#if defined(PAR) || defined(GRAN)
+/* this is the NIL ptr for a blocking queue */
+# define END_BQ_QUEUE ((StgBlockingQueueElement *)(void*)&stg_END_TSO_QUEUE_closure)
+/* this is the NIL ptr for a blocked fetch queue (as in PendingFetches in GUM) */
+# define END_BF_QUEUE ((StgBlockedFetch *)(void*)&stg_END_TSO_QUEUE_closure)
+#endif
+/* ToDo?: different name for end of sleeping queue ? -- HWL */
+
#endif /* TSO_H */
projects / ghc-hetmet.git / blobdiff