includes/TSO.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-1999
   4  *
   5  * The definitions for Thread State Objects.
   6  *
   7  * ---------------------------------------------------------------------------*/
   8
   9 #ifndef TSO_H
  10 #define TSO_H
  11
  12 #if DEBUG
  13 #define TSO_MAGIC 4321
  14 #endif
  15
  16 typedef struct {
  17   StgInt   pri;
  18   StgInt   magic;
  19   StgInt   sparkname;
  20   rtsTime  startedat;
  21   rtsBool  exported;
  22   StgInt   basicblocks;
  23   StgInt   allocs;
  24   rtsTime  exectime;
  25   rtsTime  fetchtime;
  26   rtsTime  fetchcount;
  27   rtsTime  blocktime;
  28   StgInt   blockcount;
  29   rtsTime  blockedat;
  30   StgInt   globalsparks;
  31   StgInt   localsparks;
  32   rtsTime  clock;
  33 } StgTSOStatBuf;
  34
  35 /*
  36  * GRAN: We distinguish between the various classes of threads in
  37  * the system.
  38  */
  39 typedef enum {
  40   AdvisoryPriority,
  41   MandatoryPriority,
  42   RevalPriority
  43 } StgThreadPriority;
  44
  45 /*
  46  * PROFILING info in a TSO
  47  */
  48 typedef struct {
  49   CostCentreStack *CCCS;        /* thread's current CCS */
  50 } StgTSOProfInfo;
  51
  52 /*
  53  * PAR info in a TSO
  54  */
  55 typedef StgTSOStatBuf StgTSOParInfo;
  56
  57 /*
  58  * DIST info in a TSO
  59  */
  60 typedef struct {
  61   StgThreadPriority  priority;
  62   StgInt             revalTid;   /* ToDo: merge both into 1 word */
  63   StgInt             revalSlot;
  64 } StgTSODistInfo;
  65
  66 /*
  67  * GRAN info in a TSO
  68  */
  69 typedef StgTSOStatBuf StgTSOGranInfo;
  70
  71 /*
  72  * There is no TICKY info in a TSO at this time.
  73  */
  74
  75 /*
  76  * Thread IDs are 32 bits.
  77  */
  78 typedef StgWord32 StgThreadID;
  79
  80 #define tsoDirty(tso)  ((tso)->flags & TSO_DIRTY)
  81 #define tsoLocked(tso) ((tso)->flags & TSO_LOCKED)
  82
  83 /*
  84  * Type returned after running a thread.  Values of this type
  85  * include HeapOverflow, StackOverflow etc.  See Constants.h for the
  86  * full list.
  87  */
  88 typedef unsigned int StgThreadReturnCode;
  89
  90 #if defined(mingw32_HOST_OS)
  91 /* results from an async I/O request + its request ID. */
  92 typedef struct {
  93   unsigned int reqID;
  94   int          len;
  95   int          errCode;
  96 } StgAsyncIOResult;
  97 #endif
  98
  99 typedef union {
 100   StgClosure *closure;
 101   struct StgTSO_ *tso;
 102   StgInt fd;    /* StgInt instead of int, so that it's the same size as the ptrs */
 103 #if defined(mingw32_HOST_OS)
 104   StgAsyncIOResult *async_result;
 105 #endif
 106   StgWord target;
 107 } StgTSOBlockInfo;
 108
 109
 110 /*
 111  * TSOs live on the heap, and therefore look just like heap objects.
 112  * Large TSOs will live in their own "block group" allocated by the
 113  * storage manager, and won't be copied during garbage collection.
 114  */
 115
 116 /*
 117  * Threads may be blocked for several reasons.  A blocked thread will
 118  * have the reason in the why_blocked field of the TSO, and some
 119  * further info (such as the closure the thread is blocked on, or the
 120  * file descriptor if the thread is waiting on I/O) in the block_info
 121  * field.
 122  */
 123
 124 typedef struct StgTSO_ {
 125     StgHeader               header;
 126
 127     struct StgTSO_*         link;       /* Links threads onto blocking queues */
 128     struct StgTSO_*         global_link;    /* Links all threads together */
 129
 130     StgWord16               what_next;      /* Values defined in Constants.h */
 131     StgWord16               why_blocked;    /* Values defined in Constants.h */
 132     StgWord32               flags;
 133     StgTSOBlockInfo         block_info;
 134     StgThreadID             id;
 135     int                     saved_errno;
 136     struct Task_*           bound;
 137     struct Capability_*     cap;
 138     struct StgTRecHeader_ * trec;       /* STM transaction record */
 139
 140     /*
 141        A list of threads blocked on this TSO waiting to throw
 142        exceptions.  In order to access this field, the TSO must be
 143        locked using lockClosure/unlockClosure (see SMP.h).
 144     */
 145     struct StgTSO_ *        blocked_exceptions;
 146
 147 #ifdef TICKY_TICKY
 148     /* TICKY-specific stuff would go here. */
 149 #endif
 150 #ifdef PROFILING
 151     StgTSOProfInfo prof;
 152 #endif
 153 #ifdef PAR
 154     StgTSOParInfo par;
 155 #endif
 156 #ifdef GRAN
 157     StgTSOGranInfo gran;
 158 #endif
 159 #ifdef DIST
 160     StgTSODistInfo dist;
 161 #endif
 162
 163     /* The thread stack... */
 164     StgWord32          stack_size;     /* stack size in *words* */
 165     StgWord32          max_stack_size; /* maximum stack size in *words* */
 166     StgPtr             sp;
 167
 168     StgWord            stack[FLEXIBLE_ARRAY];
 169 } StgTSO;
 170
 171 /* -----------------------------------------------------------------------------
 172    Invariants:
 173
 174    An active thread has the following properties:
 175
 176       tso->stack < tso->sp < tso->stack+tso->stack_size
 177       tso->stack_size <= tso->max_stack_size
 178
 179       RESERVED_STACK_WORDS is large enough for any heap-check or
 180       stack-check failure.
 181
 182       The size of the TSO struct plus the stack is either
 183         (a) smaller than a block, or
 184         (b) a multiple of BLOCK_SIZE
 185
 186         tso->why_blocked       tso->block_info      location
 187         ----------------------------------------------------------------------
 188         NotBlocked             NULL                 runnable_queue, or running
 189
 190         BlockedOnBlackHole     the BLACKHOLE_BQ     the BLACKHOLE_BQ's queue
 191
 192         BlockedOnMVar          the MVAR             the MVAR's queue
 193
 194         BlockedOnSTM           END_TSO_QUEUE        STM wait queue(s)
 195
 196         BlockedOnException     the TSO              TSO->blocked_exception
 197
 198         BlockedOnRead          NULL                 blocked_queue
 199         BlockedOnWrite         NULL                 blocked_queue
 200         BlockedOnDelay         NULL                 blocked_queue
 201         BlockedOnGA            closure TSO blocks on   BQ of that closure
 202         BlockedOnGA_NoSend     closure TSO blocks on   BQ of that closure
 203
 204       tso->link == END_TSO_QUEUE, if the thread is currently running.
 205
 206    A zombie thread has the following properties:
 207
 208       tso->what_next == ThreadComplete or ThreadKilled
 209       tso->link     ==  (could be on some queue somewhere)
 210       tso->su       ==  tso->stack + tso->stack_size
 211       tso->sp       ==  tso->stack + tso->stack_size - 1 (i.e. top stack word)
 212       tso->sp[0]    ==  return value of thread, if what_next == ThreadComplete,
 213                         exception             , if what_next == ThreadKilled
 214
 215       (tso->sp is left pointing at the top word on the stack so that
 216       the return value or exception will be retained by a GC).
 217
 218    The 2 cases BlockedOnGA and BlockedOnGA_NoSend are needed in a GUM
 219    setup only. They mark a TSO that has entered a FETCH_ME or
 220    FETCH_ME_BQ closure, respectively; only the first TSO hitting the
 221    closure will send a Fetch message.
 222    Currently we have no separate code for blocking on an RBH; we use the
 223    BlockedOnBlackHole case for that.   -- HWL
 224
 225  ---------------------------------------------------------------------------- */
 226
 227 /* Workaround for a bug/quirk in gcc on certain architectures.
 228  * symptom is that (&tso->stack - &tso->header) /=  sizeof(StgTSO)
 229  * in other words, gcc pads the structure at the end.
 230  */
 231
 232 extern StgTSO dummy_tso;
 233
 234 #define TSO_STRUCT_SIZE \
 235    ((char *)&dummy_tso.stack - (char *)&dummy_tso.header)
 236
 237 #define TSO_STRUCT_SIZEW (TSO_STRUCT_SIZE / sizeof(W_))
 238
 239
 240 /* this is the NIL ptr for a TSO queue (e.g. runnable queue) */
 241 #define END_TSO_QUEUE  ((StgTSO *)(void*)&stg_END_TSO_QUEUE_closure)
 242
 243 #if defined(PAR) || defined(GRAN)
 244 /* this is the NIL ptr for a blocking queue */
 245 # define END_BQ_QUEUE  ((StgBlockingQueueElement *)(void*)&stg_END_TSO_QUEUE_closure)
 246 /* this is the NIL ptr for a blocked fetch queue (as in PendingFetches in GUM) */
 247 # define END_BF_QUEUE  ((StgBlockedFetch *)(void*)&stg_END_TSO_QUEUE_closure)
 248 #endif
 249 /* ToDo?: different name for end of sleeping queue ? -- HWL */
 250
 251 #endif /* TSO_H */