X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fincludes%2FTSO.h;h=82ecacb867f065f117560e82e4922769dcecba25;hb=c137ecd7e6e83d0f9c39b15ccdb9f2355f243c91;hp=2c53ab9b67517cda13caf46cb3e92b1c7511d9ca;hpb=c6ab4bfa09886be3bfff4aa747af2f1c8e348a1f;p=ghc-hetmet.git diff --git a/ghc/includes/TSO.h b/ghc/includes/TSO.h index 2c53ab9..82ecacb 100644 --- a/ghc/includes/TSO.h +++ b/ghc/includes/TSO.h @@ -1,5 +1,4 @@ /* ----------------------------------------------------------------------------- - * $Id: TSO.h,v 1.8 1999/08/25 16:11:44 simonmar Exp $ * * (c) The GHC Team, 1998-1999 * @@ -10,87 +9,114 @@ #ifndef TSO_H #define TSO_H -#if defined(PROFILING) -typedef struct { - CostCentreStack *CCCS; /* thread's current CCS */ -} StgTSOProfInfo; -#else /* !PROFILING */ -typedef struct { -} StgTSOProfInfo; -#endif /* PROFILING */ +#if DEBUG +#define TSO_MAGIC 4321 +#endif -#if defined(PAR) -typedef struct { -} StgTSOParInfo; -#else /* !PAR */ typedef struct { -} StgTSOParInfo; -#endif /* PAR */ + 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; -#if defined(TICKY_TICKY) -typedef struct { -} StgTSOTickyInfo; -#else /* !TICKY_TICKY */ +/* + * 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 { -} StgTSOTickyInfo; -#endif /* TICKY_TICKY */ + CostCentreStack *CCCS; /* thread's current CCS */ +} StgTSOProfInfo; -typedef enum { - tso_state_runnable, - tso_state_stopped -} StgTSOState; +/* + * PAR info in a TSO + */ +typedef StgTSOStatBuf StgTSOParInfo; -typedef enum { - ThreadEnterGHC, - ThreadRunGHC, - ThreadEnterHugs, - ThreadKilled, - ThreadComplete -} StgTSOWhatNext; +/* + * DIST info in a TSO + */ +typedef struct { + StgThreadPriority priority; + StgInt revalTid; /* ToDo: merge both into 1 word */ + StgInt revalSlot; +} StgTSODistInfo; /* - * 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 :-) - * + * GRAN info in a TSO */ -typedef StgWord32 StgThreadID; +typedef StgTSOStatBuf StgTSOGranInfo; /* - * This type is returned to the scheduler by a thread that has - * stopped for one reason or another. + * There is no TICKY info in a TSO at this time. */ -typedef enum { - HeapOverflow, /* might also be StackOverflow */ - StackOverflow, - ThreadYielding, - ThreadBlocked, - ThreadFinished -} StgThreadReturnCode; +/* + * Thread IDs are 32 bits. + */ +typedef StgWord32 StgThreadID; /* - * 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. + * 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). */ +#define TSO_DIRTY 1 -typedef enum { - NotBlocked, - BlockedOnMVar, - BlockedOnBlackHole, - BlockedOnRead, - BlockedOnWrite, - BlockedOnDelay -} StgTSOBlockReason; +/* + * 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; + +#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 typedef union { StgClosure *closure; - int fd; - unsigned int delay; + struct StgTSO_ *tso; + 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; /* @@ -99,31 +125,54 @@ typedef union { * 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. + */ + typedef struct StgTSO_ { StgHeader header; - struct StgTSO_* link; - StgMutClosure * mut_link; /* TSO's are mutable of course! */ - StgTSOWhatNext whatNext; - StgTSOBlockReason why_blocked; + + struct StgTSO_* link; /* Links threads onto blocking queues */ + struct StgTSO_* global_link; /* Links all threads together */ + + 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; - StgTSOTickyInfo ticky; - StgTSOProfInfo prof; - StgTSOParInfo par; - /* GranSim Info? */ + int saved_errno; + struct Task_* bound; // non-NULL for a bound thread + 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... */ 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: @@ -131,7 +180,6 @@ extern DLL_IMPORT_RTS StgTSO *CurrentTSO; 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. @@ -140,28 +188,56 @@ extern DLL_IMPORT_RTS StgTSO *CurrentTSO; (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 + + BlockedOnSTM END_TSO_QUEUE STM wait queue(s) + + 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) @@ -171,8 +247,24 @@ extern DLL_IMPORT_RTS StgTSO *CurrentTSO; 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) */ +#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 */