/* -----------------------------------------------------------------------------
- * $Id: TSO.h,v 1.13 2000/03/17 13:30:23 simonmar Exp $
+ * $Id: TSO.h,v 1.37 2004/11/08 12:26:57 simonmar Exp $
*
* (c) The GHC Team, 1998-1999
*
#ifndef TSO_H
#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;
StgInt localsparks;
rtsTime clock;
} StgTSOStatBuf;
-#endif
-#if defined(PROFILING)
+/*
+ * 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;
-#else /* !PROFILING */
-typedef struct {
-} StgTSOProfInfo;
-#endif /* PROFILING */
-#if defined(PAR)
+/*
+ * PAR info in a TSO
+ */
typedef StgTSOStatBuf StgTSOParInfo;
-#else /* !PAR */
-typedef struct {
-} StgTSOParInfo;
-#endif /* PAR */
-
-#if defined(GRAN)
-typedef StgTSOStatBuf StgTSOGranInfo;
-#else /* !GRAN */
-typedef struct {
-} StgTSOGranInfo;
-#endif /* GRAN */
-
-#if defined(TICKY)
-typedef struct {
-} StgTSOTickyInfo;
-#else /* !TICKY_TICKY */
+/*
+ * DIST info in a TSO
+ */
typedef struct {
-} StgTSOTickyInfo;
-#endif /* TICKY_TICKY */
-
-typedef enum {
- tso_state_runnable,
- tso_state_stopped
-} StgTSOState;
+ StgThreadPriority priority;
+ StgInt revalTid; /* ToDo: merge both into 1 word */
+ StgInt revalSlot;
+} StgTSODistInfo;
/*
- * The what_next field of a TSO indicates how the thread is to be run.
+ * GRAN info in a TSO
*/
-typedef enum {
- ThreadEnterGHC, /* enter top thunk on stack */
- ThreadRunGHC, /* return to address on top of stack */
- ThreadEnterHugs, /* 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;
+typedef StgTSOStatBuf StgTSOGranInfo;
/*
- * 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 :-)
- *
+ * There is no TICKY info in a TSO at this time.
*/
-typedef StgWord32 StgThreadID;
/*
- * This type is returned to the scheduler by a thread that has
- * stopped for one reason or another.
+ * Thread IDs are 32 bits.
*/
+typedef StgWord32 StgThreadID;
-typedef enum {
- HeapOverflow, /* might also be StackOverflow */
- StackOverflow,
- ThreadYielding,
- ThreadBlocked,
- ThreadFinished
-} StgThreadReturnCode;
-
-/*
- * 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.
+/*
+ * 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 {
- NotBlocked,
- BlockedOnMVar,
- BlockedOnBlackHole,
- BlockedOnException,
- BlockedOnRead,
- BlockedOnWrite,
- BlockedOnDelay
-#if defined(PAR)
- , BlockedOnGA // blocked on a remote closure represented by a Global Address
+#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
-} StgTSOBlockReason;
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;
/*
* 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; /* Links threads onto blocking queues */
- StgMutClosure * mut_link; /* TSO's are mutable of course! */
- struct StgTSO_* global_link; /* Links all threads together */
+ 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;
- StgTSOBlockReason why_blocked;
+ 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;
- StgTSOTickyInfo ticky;
- StgTSOProfInfo prof;
- StgTSOParInfo par;
- StgTSOGranInfo gran;
+ 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;
/* -----------------------------------------------------------------------------
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->block_reason tso->block_info location
+ tso->why_blocked tso->block_info location
----------------------------------------------------------------------
NotBlocked NULL runnable_queue, or running
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.
(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.
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