/* -----------------------------------------------------------------------------
- * $Id: TSO.h,v 1.7 1999/05/11 16:47:42 keithw Exp $
+ * $Id: TSO.h,v 1.30 2003/02/21 05:34:15 sof Exp $
*
* (c) The GHC Team, 1998-1999
*
#ifndef TSO_H
#define TSO_H
+#if defined(GRAN) || defined(PAR)
+
+#if DEBUG
+#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 */
#endif /* PROFILING */
#if defined(PAR)
-typedef struct {
-} StgTSOParInfo;
+typedef StgTSOStatBuf StgTSOParInfo;
#else /* !PAR */
typedef struct {
} StgTSOParInfo;
#endif /* PAR */
-#if defined(TICKY_TICKY)
+#if defined(DIST)
+typedef struct {
+ StgThreadPriority priority;
+ StgInt revalTid; /* ToDo: merge both into 1 word */
+ StgInt revalSlot;
+} StgTSODistInfo;
+#else /* !DIST */
+typedef struct {
+} StgTSODistInfo;
+#endif /* DIST */
+
+#if defined(GRAN)
+typedef StgTSOStatBuf StgTSOGranInfo;
+#else /* !GRAN */
+typedef struct {
+} StgTSOGranInfo;
+#endif /* GRAN */
+
+
+#if defined(TICKY)
typedef struct {
} StgTSOTickyInfo;
#else /* !TICKY_TICKY */
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
+ ThreadRunGHC, /* return to address on top of stack */
+ 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;
} 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
+ * 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.
+ */
+
+typedef enum {
+ NotBlocked,
+ BlockedOnMVar,
+ BlockedOnBlackHole,
+ BlockedOnException,
+ 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
+#if defined(RTS_SUPPORTS_THREADS)
+ , BlockedOnCCall
+ , BlockedOnCCall_NoUnblockExc // same as above but don't unblock async exceptions
+ // in resumeThread()
+#endif
+} StgTSOBlockReason;
+
+#ifdef 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;
+#ifdef mingw32_TARGET_OS
+ StgAsyncIOResult* async_result;
+#endif
+ unsigned int target;
+} StgTSOBlockInfo;
+
+/*
* TSOs live on the heap, and therefore look just like heap objects.
* Large TSOs will live in their own "block group" allocated by the
* 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;
- StgClosure * blocked_on;
+
+ 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;
+ 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;
-extern DLL_IMPORT_RTS StgTSO *CurrentTSO;
-
/* -----------------------------------------------------------------------------
Invariants:
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.
(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->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.
- - 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.
+
+ 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_))
projects / ghc-hetmet.git / blobdiff