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 /*
  81  * Flags for the tso->flags field.
  82  *
  83  * The TSO_DIRTY flag indicates that this TSO's stack should be
  84  * scanned during garbage collection.  The link field of a TSO is
  85  * always scanned, so we don't have to dirty a TSO just for linking
  86  * it on a different list.
  87  *
  88  * TSO_DIRTY is set by
  89  *    - schedule(), just before running a thread,
  90  *    - raiseAsync(), because it modifies a thread's stack
  91  *    - resumeThread(), just before running the thread again
  92  * and unset by the garbage collector (only).
  93  */
  94 #define TSO_DIRTY   1
  95
  96 /*
  97  * TSO_LOCKED is set when a TSO is locked to a particular Capability.
  98  */
  99 #define TSO_LOCKED  2
 100
 101 #define tsoDirty(tso)  ((tso)->flags & TSO_DIRTY)
 102 #define tsoLocked(tso) ((tso)->flags & TSO_LOCKED)
 103
 104 /*
 105  * Type returned after running a thread.  Values of this type
 106  * include HeapOverflow, StackOverflow etc.  See Constants.h for the
 107  * full list.
 108  */
 109 typedef unsigned int StgThreadReturnCode;
 110
 111 #if defined(mingw32_HOST_OS)
 112 /* results from an async I/O request + its request ID. */
 113 typedef struct {
 114   unsigned int reqID;
 115   int          len;
 116   int          errCode;
 117 } StgAsyncIOResult;
 118 #endif
 119
 120 typedef union {
 121   StgClosure *closure;
 122   struct StgTSO_ *tso;
 123   StgInt fd;    /* StgInt instead of int, so that it's the same size as the ptrs */
 124 #if defined(mingw32_HOST_OS)
 125   StgAsyncIOResult *async_result;
 126 #endif
 127   StgWord target;
 128 } StgTSOBlockInfo;
 129
 130 /*
 131  * TSOs live on the heap, and therefore look just like heap objects.
 132  * Large TSOs will live in their own "block group" allocated by the
 133  * storage manager, and won't be copied during garbage collection.
 134  */
 135
 136 /*
 137  * Threads may be blocked for several reasons.  A blocked thread will
 138  * have the reason in the why_blocked field of the TSO, and some
 139  * further info (such as the closure the thread is blocked on, or the
 140  * file descriptor if the thread is waiting on I/O) in the block_info
 141  * field.
 142  */
 143
 144 typedef struct StgTSO_ {
 145     StgHeader               header;
 146
 147     struct StgTSO_*         link;       /* Links threads onto blocking queues */
 148     struct StgTSO_*         global_link;    /* Links all threads together */
 149
 150     StgWord16               what_next;      /* Values defined in Constants.h */
 151     StgWord16               why_blocked;    /* Values defined in Constants.h */
 152     StgWord32               flags;
 153     StgTSOBlockInfo         block_info;
 154     struct StgTSO_*         blocked_exceptions;
 155     StgThreadID             id;
 156     int                     saved_errno;
 157     struct Task_*           bound;
 158     struct Capability_*     cap;
 159     struct StgTRecHeader_ * trec;       /* STM transaction record */
 160
 161 #ifdef TICKY_TICKY
 162     /* TICKY-specific stuff would go here. */
 163 #endif
 164 #ifdef PROFILING
 165     StgTSOProfInfo prof;
 166 #endif
 167 #ifdef PAR
 168     StgTSOParInfo par;
 169 #endif
 170 #ifdef GRAN
 171     StgTSOGranInfo gran;
 172 #endif
 173 #ifdef DIST
 174     StgTSODistInfo dist;
 175 #endif
 176
 177     /* The thread stack... */
 178     StgWord32          stack_size;     /* stack size in *words* */
 179     StgWord32          max_stack_size; /* maximum stack size in *words* */
 180     StgPtr             sp;
 181
 182     StgWord            stack[FLEXIBLE_ARRAY];
 183 } StgTSO;
 184
 185 /* -----------------------------------------------------------------------------
 186    Invariants:
 187
 188    An active thread has the following properties:
 189
 190       tso->stack < tso->sp < tso->stack+tso->stack_size
 191       tso->stack_size <= tso->max_stack_size
 192
 193       RESERVED_STACK_WORDS is large enough for any heap-check or
 194       stack-check failure.
 195
 196       The size of the TSO struct plus the stack is either
 197         (a) smaller than a block, or
 198         (b) a multiple of BLOCK_SIZE
 199
 200         tso->why_blocked       tso->block_info      location
 201         ----------------------------------------------------------------------
 202         NotBlocked             NULL                 runnable_queue, or running
 203
 204         BlockedOnBlackHole     the BLACKHOLE_BQ     the BLACKHOLE_BQ's queue
 205
 206         BlockedOnMVar          the MVAR             the MVAR's queue
 207
 208         BlockedOnSTM           END_TSO_QUEUE        STM wait queue(s)
 209
 210         BlockedOnException     the TSO              TSO->blocked_exception
 211
 212         BlockedOnRead          NULL                 blocked_queue
 213         BlockedOnWrite         NULL                 blocked_queue
 214         BlockedOnDelay         NULL                 blocked_queue
 215         BlockedOnGA            closure TSO blocks on   BQ of that closure
 216         BlockedOnGA_NoSend     closure TSO blocks on   BQ of that closure
 217
 218       tso->link == END_TSO_QUEUE, if the thread is currently running.
 219
 220    A zombie thread has the following properties:
 221
 222       tso->what_next == ThreadComplete or ThreadKilled
 223       tso->link     ==  (could be on some queue somewhere)
 224       tso->su       ==  tso->stack + tso->stack_size
 225       tso->sp       ==  tso->stack + tso->stack_size - 1 (i.e. top stack word)
 226       tso->sp[0]    ==  return value of thread, if what_next == ThreadComplete,
 227                         exception             , if what_next == ThreadKilled
 228
 229       (tso->sp is left pointing at the top word on the stack so that
 230       the return value or exception will be retained by a GC).
 231
 232    tso->blocked_exceptions is either:
 233
 234       NULL             if async exceptions are unblocked.
 235
 236       END_TSO_QUEUE    if async exceptions are blocked, but no threads
 237                        are currently waiting to deliver.
 238
 239       (StgTSO *)tso    if threads are currently awaiting delivery of
 240                        exceptions to this thread.
 241
 242    The 2 cases BlockedOnGA and BlockedOnGA_NoSend are needed in a GUM
 243    setup only. They mark a TSO that has entered a FETCH_ME or
 244    FETCH_ME_BQ closure, respectively; only the first TSO hitting the
 245    closure will send a Fetch message.
 246    Currently we have no separate code for blocking on an RBH; we use the
 247    BlockedOnBlackHole case for that.   -- HWL
 248
 249  ---------------------------------------------------------------------------- */
 250
 251 /* Workaround for a bug/quirk in gcc on certain architectures.
 252  * symptom is that (&tso->stack - &tso->header) /=  sizeof(StgTSO)
 253  * in other words, gcc pads the structure at the end.
 254  */
 255
 256 extern StgTSO dummy_tso;
 257
 258 #define TSO_STRUCT_SIZE \
 259    ((char *)&dummy_tso.stack - (char *)&dummy_tso.header)
 260
 261 #define TSO_STRUCT_SIZEW (TSO_STRUCT_SIZE / sizeof(W_))
 262
 263
 264 /* this is the NIL ptr for a TSO queue (e.g. runnable queue) */
 265 #if IN_STG_CODE
 266 #define END_TSO_QUEUE  (stg_END_TSO_QUEUE_closure)
 267 #else
 268 #define END_TSO_QUEUE  ((StgTSO *)(void*)&stg_END_TSO_QUEUE_closure)
 269 #endif
 270
 271 #if defined(PAR) || defined(GRAN)
 272 /* this is the NIL ptr for a blocking queue */
 273 # define END_BQ_QUEUE  ((StgBlockingQueueElement *)(void*)&stg_END_TSO_QUEUE_closure)
 274 /* this is the NIL ptr for a blocked fetch queue (as in PendingFetches in GUM) */
 275 # define END_BF_QUEUE  ((StgBlockedFetch *)(void*)&stg_END_TSO_QUEUE_closure)
 276 #endif
 277 /* ToDo?: different name for end of sleeping queue ? -- HWL */
 278
 279 #endif /* TSO_H */