TSO.h 8.31 KB
Newer Older
1
/* -----------------------------------------------------------------------------
2
 *
Simon Marlow's avatar
Simon Marlow committed
3
 * (c) The GHC Team, 1998-2009
4 5 6 7 8
 *
 * The definitions for Thread State Objects.
 *
 * ---------------------------------------------------------------------------*/

Simon Marlow's avatar
Simon Marlow committed
9 10
#ifndef RTS_STORAGE_TSO_H
#define RTS_STORAGE_TSO_H
11

12 13 14
/*
 * PROFILING info in a TSO
 */
15 16 17 18
typedef struct {
  CostCentreStack *CCCS;	/* thread's current CCS */
} StgTSOProfInfo;

19
/*
20
 * There is no TICKY info in a TSO at this time.
21
 */
22 23

/*
ken's avatar
ken committed
24
 * Thread IDs are 32 bits.
25
 */
sof's avatar
sof committed
26
typedef StgWord32 StgThreadID;
27

28
#define tsoLocked(tso) ((tso)->flags & TSO_LOCKED)
29

30
/*
31 32 33
 * Type returned after running a thread.  Values of this type
 * include HeapOverflow, StackOverflow etc.  See Constants.h for the
 * full list.
34
 */
35
typedef unsigned int StgThreadReturnCode;
36

37
#if defined(mingw32_HOST_OS)
sof's avatar
sof committed
38
/* results from an async I/O request + its request ID. */
sof's avatar
sof committed
39 40 41 42 43 44 45
typedef struct {
  unsigned int reqID;
  int          len;
  int          errCode;
} StgAsyncIOResult;
#endif

46
/* Reason for thread being blocked. See comment above struct StgTso_. */
47 48
typedef union {
  StgClosure *closure;
49
  StgTSO *prev; // a back-link when the TSO is on the run queue (NotBlocked)
50
  struct MessageBlackHole_ *bh;
51 52
  struct MessageThrowTo_ *throwto;
  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)
sof's avatar
sof committed
55
  StgAsyncIOResult *async_result;
sof's avatar
sof committed
56
#endif
57
  StgWord target;
58 59
} StgTSOBlockInfo;

60

61 62 63 64 65 66
/*
 * TSOs live on the heap, and therefore look just like heap objects.
 * Large TSOs will live in their own "block group" allocated by the
 * storage manager, and won't be copied during garbage collection.
 */

67
/*
68 69 70 71 72 73 74
 * 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.
 */

75
typedef struct StgTSO_ {
76 77
    StgHeader               header;

78 79 80 81 82
    /* The link field, for linking threads together in lists (e.g. the
       run queue on a Capability.
    */
    struct StgTSO_*         _link;
    /*
83 84 85
      Currently used for linking TSOs on:
      * cap->run_queue_{hd,tl}
      * (non-THREADED_RTS); the blocked_queue
86
      * and pointing to the next chunk for a ThreadOldStack
87

88 89 90 91 92 93 94 95 96
       NOTE!!!  do not modify _link directly, it is subject to
       a write barrier for generational GC.  Instead use the
       setTSOLink() function.  Exceptions to this rule are:

       * setting the link field to END_TSO_QUEUE
       * setting the link field of the currently running TSO, as it
         will already be dirty.
    */

97 98
    struct StgTSO_*         global_link;    // Links threads on the
                                            // generation->threads lists
99
    
100 101 102 103 104
    /*
     * The thread's stack
     */
    struct StgStack_       *stackobj;

105 106 107 108 109 110 111 112 113 114 115 116 117 118
    /*
     * The tso->dirty flag indicates that this TSO's stack should be
     * scanned during garbage collection.  It also indicates that this
     * TSO is on the mutable list.
     *
     * NB. The dirty flag gets a word to itself, so that it can be set
     * safely by multiple threads simultaneously (the flags field is
     * not safe for this purpose; see #3429).  It is harmless for the
     * TSO to be on the mutable list multiple times.
     *
     * tso->dirty is set by dirty_TSO(), and unset by the garbage
     * collector (only).
     */

119 120 121
    StgWord16               what_next;      // Values defined in Constants.h
    StgWord16               why_blocked;    // Values defined in Constants.h
    StgWord32               flags;          // Values defined in Constants.h
122 123
    StgTSOBlockInfo         block_info;
    StgThreadID             id;
124 125
    StgWord32               saved_errno;
    StgWord32               dirty;          /* non-zero => dirty */
126
    struct InCall_*         bound;
127
    struct Capability_*     cap;
128

129 130
    struct StgTRecHeader_ * trec;       /* STM transaction record */

131
    /*
132
     * A list of threads blocked on this TSO waiting to throw exceptions.
133
    */
134
    struct MessageThrowTo_ * blocked_exceptions;
135

136
    /*
137 138
     * A list of StgBlockingQueue objects, representing threads
     * blocked on thunks that are under evaluation by this thread.
139 140 141
    */
    struct StgBlockingQueue_ *bq;

142
#ifdef TICKY_TICKY
143
    /* TICKY-specific stuff would go here. */
144 145
#endif
#ifdef PROFILING
146
    StgTSOProfInfo prof;
147
#endif
148 149 150
#ifdef mingw32_HOST_OS
    StgWord32 saved_winerror;
#endif
151

152 153 154 155 156 157 158 159 160 161 162 163 164
    /*
     * sum of the sizes of all stack chunks (in words), used to decide
     * whether to throw the StackOverflow exception when the stack
     * overflows, or whether to just chain on another stack chunk.
     *
     * Note that this overestimates the real stack size, because each
     * chunk will have a gap at the end, of +RTS -kb<size> words.
     * This means stack overflows are not entirely accurate, because
     * the more gaps there are, the sooner the stack will run into the
     * hard +RTS -K<size> limit.
     */
    StgWord32  tot_stack_size;

Simon Marlow's avatar
Simon Marlow committed
165
} *StgTSOPtr;
166

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
typedef struct StgStack_ {
    StgHeader  header;
    StgWord32  stack_size;     // stack size in *words*
    StgWord32  dirty;          // non-zero => dirty
    StgPtr     sp;             // current stack pointer
    StgWord    stack[FLEXIBLE_ARRAY];
} StgStack;

// Calculate SpLim from a TSO (reads tso->stackobj, but no fields from
// the stackobj itself).
INLINE_HEADER StgPtr tso_SpLim (StgTSO* tso)
{
    return tso->stackobj->stack + RESERVED_STACK_WORDS;
}

182 183 184 185
/* -----------------------------------------------------------------------------
   functions
   -------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
186 187
void dirty_TSO  (Capability *cap, StgTSO *tso);
void setTSOLink (Capability *cap, StgTSO *tso, StgTSO *target);
188
void setTSOPrev (Capability *cap, StgTSO *tso, StgTSO *target);
189

190
void dirty_STACK (Capability *cap, StgStack *stack);
191

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
/* -----------------------------------------------------------------------------
   Invariants:

   An active thread has the following properties:

      tso->stack < tso->sp < tso->stack+tso->stack_size
      tso->stack_size <= tso->max_stack_size
      
      RESERVED_STACK_WORDS is large enough for any heap-check or
      stack-check failure.

      The size of the TSO struct plus the stack is either
        (a) smaller than a block, or
	(b) a multiple of BLOCK_SIZE

207
	tso->why_blocked       tso->block_info      location
208
        ----------------------------------------------------------------------
209
	NotBlocked             END_TSO_QUEUE        runnable_queue, or running
210
	
Simon Marlow's avatar
Simon Marlow committed
211
        BlockedOnBlackHole     the BLACKHOLE        blackhole_queue
212 213
	
        BlockedOnMVar          the MVAR             the MVAR's queue
214 215

	BlockedOnSTM           END_TSO_QUEUE        STM wait queue(s)
216
	
217
        BlockedOnMsgThrowTo    MessageThrowTo *     TSO->blocked_exception
218 219 220 221

        BlockedOnRead          NULL                 blocked_queue
        BlockedOnWrite         NULL		    blocked_queue
        BlockedOnDelay         NULL                 blocked_queue
222 223
	BlockedOnGA            closure TSO blocks on   BQ of that closure
	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 228

   A zombie thread has the following properties:
      
229
      tso->what_next == ThreadComplete or ThreadKilled
230 231
      tso->link     ==  (could be on some queue somewhere)
      tso->sp       ==  tso->stack + tso->stack_size - 1 (i.e. top stack word)
232 233
      tso->sp[0]    ==  return value of thread, if what_next == ThreadComplete,
                        exception             , if what_next == ThreadKilled
234 235 236 237

      (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).

238 239
   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
240
   FETCH_ME_BQ closure, respectively; only the first TSO hitting the
241 242 243 244
   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

245
 ---------------------------------------------------------------------------- */
246

247 248 249
/* this is the NIL ptr for a TSO queue (e.g. runnable queue) */
#define END_TSO_QUEUE  ((StgTSO *)(void*)&stg_END_TSO_QUEUE_closure)

Simon Marlow's avatar
Simon Marlow committed
250
#endif /* RTS_STORAGE_TSO_H */