/* -----------------------------------------------------------------------------
- * $Id: TSO.h,v 1.22 2001/07/23 23:26:14 ken 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
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(DIST)
+/*
+ * DIST info in a TSO
+ */
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)
+/*
+ * GRAN info in a TSO
+ */
typedef StgTSOStatBuf StgTSOGranInfo;
-#else /* !GRAN */
-typedef struct {
-} StgTSOGranInfo;
-#endif /* GRAN */
-
-
-#if defined(TICKY)
-typedef struct {
-} StgTSOTickyInfo;
-#else /* !TICKY_TICKY */
-typedef struct {
-} StgTSOTickyInfo;
-#endif /* TICKY_TICKY */
-
-typedef enum {
- tso_state_runnable,
- tso_state_stopped
-} StgTSOState;
/*
- * The what_next field of a TSO indicates how the thread is to be run.
+ * There is no TICKY info in a TSO at this time.
*/
-typedef enum {
- ThreadEnterGHC, /* enter top thunk on stack */
- ThreadRunGHC, /* return to address on top of stack */
- ThreadEnterInterp, /* 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;
/*
* Thread IDs are 32 bits.
*/
typedef StgWord32 StgThreadID;
-/*
- * This type is returned to the scheduler by a thread that has
- * stopped for one reason or another.
+/*
+ * Flags for the tso->flags field.
+ *
+ * The TSO_DIRTY flag indicates that this TSO's stack should be
+ * scanned during garbage collection. The link field of a TSO is
+ * always scanned, so we don't have to dirty a TSO just for linking
+ * it on a different list.
+ *
+ * TSO_DIRTY is set by
+ * - schedule(), just before running a thread,
+ * - raiseAsync(), because it modifies a thread's stack
+ * - resumeThread(), just before running the thread again
+ * and unset by the garbage collector (only).
*/
-
-typedef enum {
- HeapOverflow, /* might also be StackOverflow */
- StackOverflow,
- ThreadYielding,
- ThreadBlocked,
- ThreadFinished
-} StgThreadReturnCode;
+#define TSO_DIRTY 1
/*
- * We distinguish between the various classes of threads in the system.
+ * TSO_LOCKED is set when a TSO is locked to a particular Capability.
*/
+#define TSO_LOCKED 2
-typedef enum {
- AdvisoryPriority,
- MandatoryPriority,
- RevalPriority
-} StgThreadPriority;
+#define tsoDirty(tso) ((tso)->flags & TSO_DIRTY)
+#define tsoLocked(tso) ((tso)->flags & TSO_LOCKED)
-/*
- * 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
- , BlockedOnGA_NoSend // same as above but without sending a Fetch message
+#if defined(mingw32_HOST_OS)
+/* results from an async I/O request + its request ID. */
+typedef struct {
+ unsigned int reqID;
+ int len;
+ int errCode;
+} StgAsyncIOResult;
#endif
-} StgTSOBlockReason;
typedef union {
StgClosure *closure;
struct StgTSO_ *tso;
- int fd;
- unsigned int target;
+ StgInt fd; /* StgInt instead of int, so that it's the same size as the ptrs */
+#if defined(mingw32_HOST_OS)
+ StgAsyncIOResult *async_result;
+#endif
+ StgWord target;
} StgTSOBlockInfo;
/*
*/
/*
- * ToDo: make this structure sensible on a non-32-bit arch.
+ * 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 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 */
-
- 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;
- StgTSODistInfo dist;
+ StgHeader header;
+
+ struct StgTSO_* link; /* Links threads onto blocking queues */
+ struct StgTSO_* global_link; /* Links all threads together */
- /* 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];
+ StgWord16 what_next; /* Values defined in Constants.h */
+ StgWord16 why_blocked; /* Values defined in Constants.h */
+ StgWord32 flags;
+ StgTSOBlockInfo block_info;
+ struct StgTSO_* blocked_exceptions;
+ StgThreadID id;
+ int saved_errno;
+ struct Task_* bound;
+ struct Capability_* cap;
+ struct StgTRecHeader_ * trec; /* STM transaction record */
+
+#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... */
+ StgWord32 stack_size; /* stack size in *words* */
+ StgWord32 max_stack_size; /* maximum stack size in *words* */
+ StgPtr sp;
+
+ StgWord stack[FLEXIBLE_ARRAY];
} StgTSO;
/* -----------------------------------------------------------------------------
BlockedOnBlackHole the BLACKHOLE_BQ the BLACKHOLE_BQ's queue
BlockedOnMVar the MVAR the MVAR's queue
+
+ BlockedOnSTM END_TSO_QUEUE STM wait queue(s)
BlockedOnException the TSO TSO->blocked_exception
#define TSO_STRUCT_SIZEW (TSO_STRUCT_SIZE / sizeof(W_))
+
+/* this is the NIL ptr for a TSO queue (e.g. runnable queue) */
+#if IN_STG_CODE
+#define END_TSO_QUEUE (stg_END_TSO_QUEUE_closure)
+#else
+#define END_TSO_QUEUE ((StgTSO *)(void*)&stg_END_TSO_QUEUE_closure)
+#endif
+
+#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