/* -----------------------------------------------------------------------------
- * $Id: TSO.h,v 1.3 1999/01/13 17:25:55 simonm Exp $
+ * $Id: TSO.h,v 1.14 2000/03/20 09:42:49 andy Exp $
+ *
+ * (c) The GHC Team, 1998-1999
*
* The definitions for Thread State Objects.
*
#ifndef TSO_H
#define TSO_H
+#if defined(GRAN) || defined(PAR)
+// magic marker for TSOs; debugging only
+#define TSO_MAGIC 4321
+
+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(GRAN)
+typedef StgTSOStatBuf StgTSOGranInfo;
+#else /* !GRAN */
+typedef struct {
+} StgTSOGranInfo;
+#endif /* GRAN */
+
+
#if defined(TICKY)
typedef struct {
} StgTSOTickyInfo;
-#else /* !TICKY */
+#else /* !TICKY_TICKY */
typedef struct {
} StgTSOTickyInfo;
-#endif /* TICKY */
+#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.
+ */
typedef enum {
- ThreadEnterGHC,
- ThreadRunGHC,
- ThreadEnterHugs,
- ThreadKilled,
- ThreadComplete
+ 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;
/*
* 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 :-)
+ *
*/
-typedef StgNat32 StgThreadID;
+typedef StgWord32 StgThreadID;
/*
* This type is returned to the scheduler by a thread that has
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.
+ */
+
+typedef enum {
+ NotBlocked,
+ BlockedOnMVar,
+ BlockedOnBlackHole,
+ BlockedOnException,
+ BlockedOnRead,
+ BlockedOnWrite,
+ BlockedOnDelay
+#if defined(PAR)
+ , BlockedOnGA // blocked on a remote closure represented by a Global Address
+#endif
+} StgTSOBlockReason;
+
+typedef union {
+ StgClosure *closure;
+ struct StgTSO_ *tso;
+ int fd;
+#if defined(INTERPRETER) && !defined(HAVE_SETITIMER)
+ unsigned int target;
+#else
+ unsigned int delay;
+#endif
+#if defined(PAR)
+ globalAddr ga;
+#endif
+} 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
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 */
+
+ StgTSOWhatNext what_next;
+ StgTSOBlockReason why_blocked;
+ StgTSOBlockInfo block_info;
+ struct StgTSO_* blocked_exceptions;
StgThreadID id;
- /* Exception Handlers */
StgTSOTickyInfo ticky;
StgTSOProfInfo prof;
StgTSOParInfo par;
- /* GranSim Info? */
+ StgTSOGranInfo gran;
/* The thread stack... */
StgWord stack_size; /* stack size in *words* */
StgWord stack[0];
} 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
+ tso->splim == tso->stack + RESERVED_STACK_WORDS;
+
+ 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->block_reason 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
+
+ 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.
+ ---------------------------------------------------------------------------- */
/* Workaround for a bug/quirk in gcc on certain architectures.
* symptom is that (&tso->stack - &tso->header) /= sizeof(StgTSO)
projects / ghc-hetmet.git / blobdiff