includes/rts/storage/TSO.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2009
   4  *
   5  * The definitions for Thread State Objects.
   6  *
   7  * ---------------------------------------------------------------------------*/
   8
   9 #ifndef RTS_STORAGE_TSO_H
  10 #define RTS_STORAGE_TSO_H
  11
  12 /*
  13  * PROFILING info in a TSO
  14  */
  15 typedef struct {
  16   CostCentreStack *CCCS;        /* thread's current CCS */
  17 } StgTSOProfInfo;
  18
  19 /*
  20  * There is no TICKY info in a TSO at this time.
  21  */
  22
  23 /*
  24  * Thread IDs are 32 bits.
  25  */
  26 typedef StgWord32 StgThreadID;
  27
  28 #define tsoLocked(tso) ((tso)->flags & TSO_LOCKED)
  29
  30 /*
  31  * Type returned after running a thread.  Values of this type
  32  * include HeapOverflow, StackOverflow etc.  See Constants.h for the
  33  * full list.
  34  */
  35 typedef unsigned int StgThreadReturnCode;
  36
  37 #if defined(mingw32_HOST_OS)
  38 /* results from an async I/O request + its request ID. */
  39 typedef struct {
  40   unsigned int reqID;
  41   int          len;
  42   int          errCode;
  43 } StgAsyncIOResult;
  44 #endif
  45
  46 /* Reason for thread being blocked. See comment above struct StgTso_. */
  47 typedef union {
  48   StgClosure *closure;
  49   StgTSO *prev; // a back-link when the TSO is on the run queue (NotBlocked)
  50   struct MessageBlackHole_ *bh;
  51   struct MessageThrowTo_ *throwto;
  52   struct MessageWakeup_  *wakeup;
  53   StgInt fd;    /* StgInt instead of int, so that it's the same size as the ptrs */
  54 #if defined(mingw32_HOST_OS)
  55   StgAsyncIOResult *async_result;
  56 #endif
  57   StgWord target;
  58 } StgTSOBlockInfo;
  59
  60
  61 /*
  62  * TSOs live on the heap, and therefore look just like heap objects.
  63  * Large TSOs will live in their own "block group" allocated by the
  64  * storage manager, and won't be copied during garbage collection.
  65  */
  66
  67 /*
  68  * Threads may be blocked for several reasons.  A blocked thread will
  69  * have the reason in the why_blocked field of the TSO, and some
  70  * further info (such as the closure the thread is blocked on, or the
  71  * file descriptor if the thread is waiting on I/O) in the block_info
  72  * field.
  73  */
  74
  75 typedef struct StgTSO_ {
  76     StgHeader               header;
  77
  78     /* The link field, for linking threads together in lists (e.g. the
  79        run queue on a Capability.
  80     */
  81     struct StgTSO_*         _link;
  82     /*
  83       Currently used for linking TSOs on:
  84       * cap->run_queue_{hd,tl}
  85       * MVAR queue
  86       * (non-THREADED_RTS); the blocked_queue
  87       * and pointing to the relocated version of a ThreadRelocated
  88
  89        NOTE!!!  do not modify _link directly, it is subject to
  90        a write barrier for generational GC.  Instead use the
  91        setTSOLink() function.  Exceptions to this rule are:
  92
  93        * setting the link field to END_TSO_QUEUE
  94        * setting the link field of the currently running TSO, as it
  95          will already be dirty.
  96     */
  97
  98     struct StgTSO_*         global_link;    // Links threads on the
  99                                             // generation->threads lists
 100
 101     StgWord                 dirty;          /* non-zero => dirty */
 102     /*
 103      * The tso->dirty flag indicates that this TSO's stack should be
 104      * scanned during garbage collection.  It also indicates that this
 105      * TSO is on the mutable list.
 106      *
 107      * NB. The dirty flag gets a word to itself, so that it can be set
 108      * safely by multiple threads simultaneously (the flags field is
 109      * not safe for this purpose; see #3429).  It is harmless for the
 110      * TSO to be on the mutable list multiple times.
 111      *
 112      * tso->dirty is set by dirty_TSO(), and unset by the garbage
 113      * collector (only).
 114      *
 115      * The link field has a separate dirty bit of its own, namely the
 116      * bit TSO_LINK_DIRTY in the tso->flags field, set by
 117      * setTSOLink().
 118      */
 119
 120     StgWord16               what_next;      // Values defined in Constants.h
 121     StgWord16               why_blocked;    // Values defined in Constants.h
 122     StgWord32               flags;          // Values defined in Constants.h
 123     StgTSOBlockInfo         block_info;
 124     StgThreadID             id;
 125     int                     saved_errno;
 126     struct InCall_*         bound;
 127     struct Capability_*     cap;
 128     struct StgTRecHeader_ * trec;       /* STM transaction record */
 129
 130     /*
 131        A list of threads blocked on this TSO waiting to throw
 132        exceptions.  In order to access this field, the TSO must be
 133        locked using lockClosure/unlockClosure (see SMP.h).
 134     */
 135     struct MessageThrowTo_ * blocked_exceptions;
 136
 137     /*
 138       A list of StgBlockingQueue objects, representing threads blocked
 139       on thunks that are under evaluation by this thread.
 140     */
 141     struct StgBlockingQueue_ *bq;
 142
 143 #ifdef TICKY_TICKY
 144     /* TICKY-specific stuff would go here. */
 145 #endif
 146 #ifdef PROFILING
 147     StgTSOProfInfo prof;
 148 #endif
 149 #ifdef mingw32_HOST_OS
 150     StgWord32 saved_winerror;
 151 #endif
 152
 153     /* The thread stack... */
 154     StgWord32          stack_size;     /* stack size in *words* */
 155     StgWord32          max_stack_size; /* maximum stack size in *words* */
 156     StgPtr             sp;
 157
 158     StgWord            stack[FLEXIBLE_ARRAY];
 159 } *StgTSOPtr;
 160
 161 /* -----------------------------------------------------------------------------
 162    functions
 163    -------------------------------------------------------------------------- */
 164
 165 void dirty_TSO  (Capability *cap, StgTSO *tso);
 166 void setTSOLink (Capability *cap, StgTSO *tso, StgTSO *target);
 167 void setTSOPrev (Capability *cap, StgTSO *tso, StgTSO *target);
 168
 169 // Apply to a TSO before looking at it if you are not sure whether it
 170 // might be ThreadRelocated or not (basically, that's most of the time
 171 // unless the TSO is the current TSO).
 172 //
 173 INLINE_HEADER StgTSO * deRefTSO(StgTSO *tso)
 174 {
 175     while (tso->what_next == ThreadRelocated) {
 176         tso = tso->_link;
 177     }
 178     return tso;
 179 }
 180
 181 /* -----------------------------------------------------------------------------
 182    Invariants:
 183
 184    An active thread has the following properties:
 185
 186       tso->stack < tso->sp < tso->stack+tso->stack_size
 187       tso->stack_size <= tso->max_stack_size
 188
 189       RESERVED_STACK_WORDS is large enough for any heap-check or
 190       stack-check failure.
 191
 192       The size of the TSO struct plus the stack is either
 193         (a) smaller than a block, or
 194         (b) a multiple of BLOCK_SIZE
 195
 196         tso->why_blocked       tso->block_info      location
 197         ----------------------------------------------------------------------
 198         NotBlocked             END_TSO_QUEUE        runnable_queue, or running
 199
 200         BlockedOnBlackHole     the BLACKHOLE        blackhole_queue
 201
 202         BlockedOnMVar          the MVAR             the MVAR's queue
 203
 204         BlockedOnSTM           END_TSO_QUEUE        STM wait queue(s)
 205
 206         BlockedOnMsgThrowTo    MessageThrowTo *     TSO->blocked_exception
 207
 208         BlockedOnRead          NULL                 blocked_queue
 209         BlockedOnWrite         NULL                 blocked_queue
 210         BlockedOnDelay         NULL                 blocked_queue
 211         BlockedOnGA            closure TSO blocks on   BQ of that closure
 212         BlockedOnGA_NoSend     closure TSO blocks on   BQ of that closure
 213
 214       tso->link == END_TSO_QUEUE, if the thread is currently running.
 215
 216    A zombie thread has the following properties:
 217
 218       tso->what_next == ThreadComplete or ThreadKilled
 219       tso->link     ==  (could be on some queue somewhere)
 220       tso->sp       ==  tso->stack + tso->stack_size - 1 (i.e. top stack word)
 221       tso->sp[0]    ==  return value of thread, if what_next == ThreadComplete,
 222                         exception             , if what_next == ThreadKilled
 223
 224       (tso->sp is left pointing at the top word on the stack so that
 225       the return value or exception will be retained by a GC).
 226
 227    The 2 cases BlockedOnGA and BlockedOnGA_NoSend are needed in a GUM
 228    setup only. They mark a TSO that has entered a FETCH_ME or
 229    FETCH_ME_BQ closure, respectively; only the first TSO hitting the
 230    closure will send a Fetch message.
 231    Currently we have no separate code for blocking on an RBH; we use the
 232    BlockedOnBlackHole case for that.   -- HWL
 233
 234  ---------------------------------------------------------------------------- */
 235
 236 /* Workaround for a bug/quirk in gcc on certain architectures.
 237  * symptom is that (&tso->stack - &tso->header) /=  sizeof(StgTSO)
 238  * in other words, gcc pads the structure at the end.
 239  */
 240
 241 extern StgTSO dummy_tso;
 242
 243 #define TSO_STRUCT_SIZE \
 244    ((char *)&dummy_tso.stack - (char *)&dummy_tso.header)
 245
 246 #define TSO_STRUCT_SIZEW (TSO_STRUCT_SIZE / sizeof(W_))
 247
 248 /* this is the NIL ptr for a TSO queue (e.g. runnable queue) */
 249 #define END_TSO_QUEUE  ((StgTSO *)(void*)&stg_END_TSO_QUEUE_closure)
 250
 251 #endif /* RTS_STORAGE_TSO_H */