1 /* -----------------------------------------------------------------------------
2 * $Id: TSO.h,v 1.27 2002/06/26 08:18:41 stolz Exp $
4 * (c) The GHC Team, 1998-1999
6 * The definitions for Thread State Objects.
8 * ---------------------------------------------------------------------------*/
13 #if defined(GRAN) || defined(PAR)
16 #define TSO_MAGIC 4321
39 #if defined(PROFILING)
41 CostCentreStack *CCCS; /* thread's current CCS */
43 #else /* !PROFILING */
46 #endif /* PROFILING */
49 typedef StgTSOStatBuf StgTSOParInfo;
57 StgThreadPriority priority;
58 StgInt revalTid; /* ToDo: merge both into 1 word */
67 typedef StgTSOStatBuf StgTSOGranInfo;
77 #else /* !TICKY_TICKY */
80 #endif /* TICKY_TICKY */
88 * The what_next field of a TSO indicates how the thread is to be run.
91 ThreadEnterGHC, /* enter top thunk on stack */
92 ThreadRunGHC, /* return to address on top of stack */
93 ThreadEnterInterp, /* enter top thunk on stack (w/ interpreter) */
94 ThreadKilled, /* thread has died, don't run it */
95 ThreadRelocated, /* thread has moved, link points to new locn */
96 ThreadComplete /* thread has finished */
100 * Thread IDs are 32 bits.
102 typedef StgWord32 StgThreadID;
105 * This type is returned to the scheduler by a thread that has
106 * stopped for one reason or another.
110 HeapOverflow, /* might also be StackOverflow */
115 } StgThreadReturnCode;
118 * We distinguish between the various classes of threads in the system.
128 * Threads may be blocked for several reasons. A blocked thread will
129 * have the reason in the why_blocked field of the TSO, and some
130 * further info (such as the closure the thread is blocked on, or the
131 * file descriptor if the thread is waiting on I/O) in the block_info
144 , BlockedOnGA // blocked on a remote closure represented by a Global Address
145 , BlockedOnGA_NoSend // same as above but without sending a Fetch message
147 #if defined(RTS_SUPPORTS_THREADS)
160 * TSOs live on the heap, and therefore look just like heap objects.
161 * Large TSOs will live in their own "block group" allocated by the
162 * storage manager, and won't be copied during garbage collection.
166 * ToDo: make this structure sensible on a non-32-bit arch.
169 typedef struct StgTSO_ {
172 struct StgTSO_* link; /* Links threads onto blocking queues */
173 StgMutClosure * mut_link; /* TSO's are mutable of course! */
174 struct StgTSO_* global_link; /* Links all threads together */
176 StgTSOWhatNext what_next : 16;
177 StgTSOBlockReason why_blocked : 16;
178 StgTSOBlockInfo block_info;
179 struct StgTSO_* blocked_exceptions;
182 StgTSOTickyInfo ticky;
188 /* The thread stack... */
189 StgWord stack_size; /* stack size in *words* */
190 StgWord max_stack_size; /* maximum stack size in *words* */
194 StgWord stack[FLEXIBLE_ARRAY];
197 /* -----------------------------------------------------------------------------
200 An active thread has the following properties:
202 tso->stack < tso->sp < tso->stack+tso->stack_size
203 tso->stack_size <= tso->max_stack_size
205 RESERVED_STACK_WORDS is large enough for any heap-check or
208 The size of the TSO struct plus the stack is either
209 (a) smaller than a block, or
210 (b) a multiple of BLOCK_SIZE
212 tso->why_blocked tso->block_info location
213 ----------------------------------------------------------------------
214 NotBlocked NULL runnable_queue, or running
216 BlockedOnBlackHole the BLACKHOLE_BQ the BLACKHOLE_BQ's queue
218 BlockedOnMVar the MVAR the MVAR's queue
220 BlockedOnException the TSO TSO->blocked_exception
222 BlockedOnRead NULL blocked_queue
223 BlockedOnWrite NULL blocked_queue
224 BlockedOnDelay NULL blocked_queue
225 BlockedOnGA closure TSO blocks on BQ of that closure
226 BlockedOnGA_NoSend closure TSO blocks on BQ of that closure
228 tso->link == END_TSO_QUEUE, if the thread is currently running.
230 A zombie thread has the following properties:
232 tso->what_next == ThreadComplete or ThreadKilled
233 tso->link == (could be on some queue somewhere)
234 tso->su == tso->stack + tso->stack_size
235 tso->sp == tso->stack + tso->stack_size - 1 (i.e. top stack word)
236 tso->sp[0] == return value of thread, if what_next == ThreadComplete,
237 exception , if what_next == ThreadKilled
239 (tso->sp is left pointing at the top word on the stack so that
240 the return value or exception will be retained by a GC).
242 tso->blocked_exceptions is either:
244 NULL if async exceptions are unblocked.
246 END_TSO_QUEUE if async exceptions are blocked, but no threads
247 are currently waiting to deliver.
249 (StgTSO *)tso if threads are currently awaiting delivery of
250 exceptions to this thread.
252 The 2 cases BlockedOnGA and BlockedOnGA_NoSend are needed in a GUM
253 setup only. They mark a TSO that has entered a FETCH_ME or
254 FETCH_ME_BQ closure, respectively; only the first TSO hitting the
255 closure will send a Fetch message.
256 Currently we have no separate code for blocking on an RBH; we use the
257 BlockedOnBlackHole case for that. -- HWL
259 ---------------------------------------------------------------------------- */
261 /* Workaround for a bug/quirk in gcc on certain architectures.
262 * symptom is that (&tso->stack - &tso->header) /= sizeof(StgTSO)
263 * in other words, gcc pads the structure at the end.
266 extern StgTSO dummy_tso;
268 #define TSO_STRUCT_SIZE \
269 ((char *)&dummy_tso.stack - (char *)&dummy_tso.header)
271 #define TSO_STRUCT_SIZEW (TSO_STRUCT_SIZE / sizeof(W_))