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