ghc/includes/TSO.h

   1 /* -----------------------------------------------------------------------------
   2  * $Id: TSO.h,v 1.23 2001/08/29 17:24:25 qrczak Exp $
   3  *
   4  * (c) The GHC Team, 1998-1999
   5  *
   6  * The definitions for Thread State Objects.
   7  *
   8  * ---------------------------------------------------------------------------*/
   9
  10 #ifndef TSO_H
  11 #define TSO_H
  12
  13 #if defined(GRAN) || defined(PAR)
  14
  15 #if DEBUG
  16 #define TSO_MAGIC 4321
  17 #endif
  18
  19 typedef struct {
  20   StgInt   pri;
  21   StgInt   magic;
  22   StgInt   sparkname;
  23   rtsTime  startedat;
  24   rtsBool  exported;
  25   StgInt   basicblocks;
  26   StgInt   allocs;
  27   rtsTime  exectime;
  28   rtsTime  fetchtime;
  29   rtsTime  fetchcount;
  30   rtsTime  blocktime;
  31   StgInt   blockcount;
  32   rtsTime  blockedat;
  33   StgInt   globalsparks;
  34   StgInt   localsparks;
  35   rtsTime  clock;
  36 } StgTSOStatBuf;
  37 #endif
  38
  39 #if defined(PROFILING)
  40 typedef struct {
  41   CostCentreStack *CCCS;        /* thread's current CCS */
  42 } StgTSOProfInfo;
  43 #else /* !PROFILING */
  44 typedef struct {
  45 } StgTSOProfInfo;
  46 #endif /* PROFILING */
  47
  48 #if defined(PAR)
  49 typedef StgTSOStatBuf StgTSOParInfo;
  50 #else /* !PAR */
  51 typedef struct {
  52 } StgTSOParInfo;
  53 #endif /* PAR */
  54
  55 #if defined(DIST)
  56 typedef struct {
  57   StgThreadPriority  priority;
  58   StgInt             revalTid;   /* ToDo: merge both into 1 word */
  59   StgInt             revalSlot;
  60 } StgTSODistInfo;
  61 #else /* !DIST */
  62 typedef struct {
  63 } StgTSODistInfo;
  64 #endif /* DIST */
  65
  66 #if defined(GRAN)
  67 typedef StgTSOStatBuf StgTSOGranInfo;
  68 #else /* !GRAN */
  69 typedef struct {
  70 } StgTSOGranInfo;
  71 #endif /* GRAN */
  72
  73
  74 #if defined(TICKY)
  75 typedef struct {
  76 } StgTSOTickyInfo;
  77 #else /* !TICKY_TICKY */
  78 typedef struct {
  79 } StgTSOTickyInfo;
  80 #endif /* TICKY_TICKY */
  81
  82 typedef enum {
  83     tso_state_runnable,
  84     tso_state_stopped
  85 } StgTSOState;
  86
  87 /*
  88  * The what_next field of a TSO indicates how the thread is to be run.
  89  */
  90 typedef enum {
  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 */
  97 } StgTSOWhatNext;
  98
  99 /*
 100  * Thread IDs are 32 bits.
 101  */
 102 typedef StgWord32 StgThreadID;
 103
 104 /*
 105  * This type is returned to the scheduler by a thread that has
 106  * stopped for one reason or another.
 107  */
 108
 109 typedef enum {
 110   HeapOverflow,                 /* might also be StackOverflow */
 111   StackOverflow,
 112   ThreadYielding,
 113   ThreadBlocked,
 114   ThreadFinished
 115 } StgThreadReturnCode;
 116
 117 /*
 118  * We distinguish between the various classes of threads in the system.
 119  */
 120
 121 typedef enum {
 122   AdvisoryPriority,
 123   MandatoryPriority,
 124   RevalPriority
 125 } StgThreadPriority;
 126
 127 /*
 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
 132  * field.
 133  */
 134
 135 typedef enum {
 136   NotBlocked,
 137   BlockedOnMVar,
 138   BlockedOnBlackHole,
 139   BlockedOnException,
 140   BlockedOnRead,
 141   BlockedOnWrite,
 142   BlockedOnDelay
 143 #if defined(PAR)
 144   , BlockedOnGA  // blocked on a remote closure represented by a Global Address
 145   , BlockedOnGA_NoSend // same as above but without sending a Fetch message
 146 #endif
 147 } StgTSOBlockReason;
 148
 149 typedef union {
 150   StgClosure *closure;
 151   struct StgTSO_ *tso;
 152   int fd;
 153   unsigned int target;
 154 } StgTSOBlockInfo;
 155
 156 /*
 157  * TSOs live on the heap, and therefore look just like heap objects.
 158  * Large TSOs will live in their own "block group" allocated by the
 159  * storage manager, and won't be copied during garbage collection.
 160  */
 161
 162 /*
 163  * ToDo: make this structure sensible on a non-32-bit arch.
 164  */
 165
 166 typedef struct StgTSO_ {
 167   StgHeader          header;
 168
 169   struct StgTSO_*    link;           /* Links threads onto blocking queues */
 170   StgMutClosure *    mut_link;       /* TSO's are mutable of course! */
 171   struct StgTSO_*    global_link;    /* Links all threads together */
 172
 173   StgTSOWhatNext     what_next   : 16;
 174   StgTSOBlockReason  why_blocked : 16;
 175   StgTSOBlockInfo    block_info;
 176   struct StgTSO_*    blocked_exceptions;
 177   StgThreadID        id;
 178
 179   StgTSOTickyInfo    ticky;
 180   StgTSOProfInfo     prof;
 181   StgTSOParInfo      par;
 182   StgTSOGranInfo     gran;
 183   StgTSODistInfo     dist;
 184
 185   /* The thread stack... */
 186   StgWord            stack_size;     /* stack size in *words* */
 187   StgWord            max_stack_size; /* maximum stack size in *words* */
 188   StgPtr             sp;
 189   StgUpdateFrame*    su;
 190
 191   StgWord            stack[FLEXIBLE_ARRAY];
 192 } StgTSO;
 193
 194 /* -----------------------------------------------------------------------------
 195    Invariants:
 196
 197    An active thread has the following properties:
 198
 199       tso->stack < tso->sp < tso->stack+tso->stack_size
 200       tso->stack_size <= tso->max_stack_size
 201
 202       RESERVED_STACK_WORDS is large enough for any heap-check or
 203       stack-check failure.
 204
 205       The size of the TSO struct plus the stack is either
 206         (a) smaller than a block, or
 207         (b) a multiple of BLOCK_SIZE
 208
 209         tso->why_blocked       tso->block_info      location
 210         ----------------------------------------------------------------------
 211         NotBlocked             NULL                 runnable_queue, or running
 212
 213         BlockedOnBlackHole     the BLACKHOLE_BQ     the BLACKHOLE_BQ's queue
 214
 215         BlockedOnMVar          the MVAR             the MVAR's queue
 216
 217         BlockedOnException     the TSO              TSO->blocked_exception
 218
 219         BlockedOnRead          NULL                 blocked_queue
 220         BlockedOnWrite         NULL                 blocked_queue
 221         BlockedOnDelay         NULL                 blocked_queue
 222         BlockedOnGA            closure TSO blocks on   BQ of that closure
 223         BlockedOnGA_NoSend     closure TSO blocks on   BQ of that closure
 224
 225       tso->link == END_TSO_QUEUE, if the thread is currently running.
 226
 227    A zombie thread has the following properties:
 228
 229       tso->what_next == ThreadComplete or ThreadKilled
 230       tso->link     ==  (could be on some queue somewhere)
 231       tso->su       ==  tso->stack + tso->stack_size
 232       tso->sp       ==  tso->stack + tso->stack_size - 1 (i.e. top stack word)
 233       tso->sp[0]    ==  return value of thread, if what_next == ThreadComplete,
 234                         exception             , if what_next == ThreadKilled
 235
 236       (tso->sp is left pointing at the top word on the stack so that
 237       the return value or exception will be retained by a GC).
 238
 239    tso->blocked_exceptions is either:
 240
 241       NULL             if async exceptions are unblocked.
 242
 243       END_TSO_QUEUE    if async exceptions are blocked, but no threads
 244                        are currently waiting to deliver.
 245
 246       (StgTSO *)tso    if threads are currently awaiting delivery of
 247                        exceptions to this thread.
 248
 249    The 2 cases BlockedOnGA and BlockedOnGA_NoSend are needed in a GUM
 250    setup only. They mark a TSO that has entered a FETCH_ME or
 251    FETCH_ME_BQ closure, respectively; only the first TSO hitting the
 252    closure will send a Fetch message.
 253    Currently we have no separate code for blocking on an RBH; we use the
 254    BlockedOnBlackHole case for that.   -- HWL
 255
 256  ---------------------------------------------------------------------------- */
 257
 258 /* Workaround for a bug/quirk in gcc on certain architectures.
 259  * symptom is that (&tso->stack - &tso->header) /=  sizeof(StgTSO)
 260  * in other words, gcc pads the structure at the end.
 261  */
 262
 263 extern StgTSO dummy_tso;
 264
 265 #define TSO_STRUCT_SIZE \
 266    ((char *)&dummy_tso.stack - (char *)&dummy_tso.header)
 267
 268 #define TSO_STRUCT_SIZEW (TSO_STRUCT_SIZE / sizeof(W_))
 269
 270 #endif /* TSO_H */