ghc/includes/Closures.h

   1 /* ----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2004
   4  *
   5  * Closures
   6  *
   7  * -------------------------------------------------------------------------- */
   8
   9 #ifndef CLOSURES_H
  10 #define CLOSURES_H
  11
  12 /*
  13  * The Layout of a closure header depends on which kind of system we're
  14  * compiling for: profiling, parallel, ticky, etc.
  15  */
  16
  17 /* -----------------------------------------------------------------------------
  18    The profiling header
  19    -------------------------------------------------------------------------- */
  20
  21 typedef struct {
  22   CostCentreStack *ccs;
  23   union {
  24     struct _RetainerSet *rs;  /* Retainer Set */
  25     StgWord ldvw;             /* Lag/Drag/Void Word */
  26   } hp;
  27 } StgProfHeader;
  28
  29 /* -----------------------------------------------------------------------------
  30    The GranSim header
  31    -------------------------------------------------------------------------- */
  32
  33 typedef struct {
  34   StgWord procs; /* bitmask indicating on which PEs this closure resides */
  35 } StgGranHeader;
  36
  37 /* -----------------------------------------------------------------------------
  38    The SMP header
  39
  40    In SMP mode, we have an extra word of padding in a thunk's header.
  41    (Note: thunks only; other closures do not have this padding word).
  42    -------------------------------------------------------------------------- */
  43
  44 typedef struct {
  45     StgWord pad;
  46 } StgSMPThunkHeader;
  47
  48 /* -----------------------------------------------------------------------------
  49    The full fixed-size closure header
  50
  51    The size of the fixed header is the sum of the optional parts plus a single
  52    word for the entry code pointer.
  53    -------------------------------------------------------------------------- */
  54
  55 typedef struct {
  56     const struct _StgInfoTable* info;
  57 #ifdef PROFILING
  58     StgProfHeader         prof;
  59 #endif
  60 #ifdef GRAN
  61     StgGranHeader         gran;
  62 #endif
  63 } StgHeader;
  64
  65 /*
  66  * In SMP mode, a thunk has a padding word to take the updated value.
  67  * This is so that the update doesn't overwrite the payload, so we can
  68  * avoid needing to lock the thunk during entry and update.
  69  *
  70  * Note: this doesn't apply to THUNK_STATICs, which have no payload.
  71  */
  72 typedef struct {
  73     const struct _StgInfoTable* info;
  74 #ifdef PROFILING
  75     StgProfHeader         prof;
  76 #endif
  77 #ifdef GRAN
  78     StgGranHeader         gran;
  79 #endif
  80 #ifdef SMP
  81     StgSMPThunkHeader     smp;
  82 #endif
  83 } StgThunkHeader;
  84
  85 /* -----------------------------------------------------------------------------
  86    Closure Types
  87
  88    For any given closure type (defined in InfoTables.h), there is a
  89    corresponding structure defined below.  The name of the structure
  90    is obtained by concatenating the closure type with '_closure'
  91    -------------------------------------------------------------------------- */
  92
  93 /* All closures follow the generic format */
  94
  95 struct StgClosure_ {
  96     StgHeader   header;
  97     struct StgClosure_ *payload[FLEXIBLE_ARRAY];
  98 };
  99
 100 typedef struct {
 101     StgThunkHeader  header;
 102     struct StgClosure_ *payload[FLEXIBLE_ARRAY];
 103 } StgThunk;
 104
 105 typedef struct {
 106     StgThunkHeader   header;
 107     StgClosure *selectee;
 108 } StgSelector;
 109
 110 typedef struct {
 111     StgHeader   header;
 112     StgHalfWord arity;          /* zero if it is an AP */
 113     StgHalfWord n_args;
 114     StgClosure *fun;            /* really points to a fun */
 115     StgClosure *payload[FLEXIBLE_ARRAY];
 116 } StgPAP;
 117
 118 typedef struct {
 119     StgThunkHeader   header;
 120     StgHalfWord arity;          /* zero if it is an AP */
 121     StgHalfWord n_args;
 122     StgClosure *fun;            /* really points to a fun */
 123     StgClosure *payload[FLEXIBLE_ARRAY];
 124 } StgAP;
 125
 126 typedef struct {
 127     StgThunkHeader   header;
 128     StgWord     size;                    /* number of words in payload */
 129     StgClosure *fun;
 130     StgClosure *payload[FLEXIBLE_ARRAY]; /* contains a chunk of *stack* */
 131 } StgAP_STACK;
 132
 133 typedef struct {
 134     StgHeader   header;
 135     StgClosure *indirectee;
 136 } StgInd;
 137
 138 typedef struct {
 139     StgHeader     header;
 140     StgClosure   *indirectee;
 141     StgClosure   *static_link;
 142     struct _StgInfoTable *saved_info;
 143 } StgIndStatic;
 144
 145 typedef struct {
 146     StgHeader  header;
 147     StgWord    words;
 148     StgWord    payload[FLEXIBLE_ARRAY];
 149 } StgArrWords;
 150
 151 typedef struct {
 152     StgHeader   header;
 153     StgWord     ptrs;
 154     StgClosure *payload[FLEXIBLE_ARRAY];
 155 } StgMutArrPtrs;
 156
 157 typedef struct {
 158     StgHeader   header;
 159     StgClosure *var;
 160 } StgMutVar;
 161
 162 typedef struct _StgUpdateFrame {
 163     StgHeader  header;
 164     StgClosure *updatee;
 165 } StgUpdateFrame;
 166
 167 typedef struct {
 168     StgHeader  header;
 169     StgInt      exceptions_blocked;
 170     StgClosure *handler;
 171 } StgCatchFrame;
 172
 173 typedef struct {
 174     StgHeader  header;
 175 } StgStopFrame;
 176
 177 typedef struct {
 178     StgHeader   header;
 179     StgClosure *evacuee;
 180 } StgEvacuated;
 181
 182 typedef struct {
 183   StgHeader header;
 184   StgWord data;
 185 } StgIntCharlikeClosure;
 186
 187 /* statically allocated */
 188 typedef struct {
 189   StgHeader  header;
 190 } StgRetry;
 191
 192 typedef struct _StgStableName {
 193   StgHeader      header;
 194   StgWord        sn;
 195 } StgStableName;
 196
 197 typedef struct _StgWeak {       /* Weak v */
 198   StgHeader header;
 199   StgClosure *key;
 200   StgClosure *value;            /* v */
 201   StgClosure *finalizer;
 202   struct _StgWeak *link;
 203 } StgWeak;
 204
 205 typedef struct _StgDeadWeak {   /* Weak v */
 206   StgHeader header;
 207   struct _StgWeak *link;
 208 } StgDeadWeak;
 209
 210 /* Byte code objects.  These are fixed size objects with pointers to
 211  * four arrays, designed so that a BCO can be easily "re-linked" to
 212  * other BCOs, to facilitate GHC's intelligent recompilation.  The
 213  * array of instructions is static and not re-generated when the BCO
 214  * is re-linked, but the other 3 arrays will be regenerated.
 215  *
 216  * A BCO represents either a function or a stack frame.  In each case,
 217  * it needs a bitmap to describe to the garbage collector the
 218  * pointerhood of its arguments/free variables respectively, and in
 219  * the case of a function it also needs an arity.  These are stored
 220  * directly in the BCO, rather than in the instrs array, for two
 221  * reasons:
 222  * (a) speed: we need to get at the bitmap info quickly when
 223  *     the GC is examining APs and PAPs that point to this BCO
 224  * (b) a subtle interaction with the compacting GC.  In compacting
 225  *     GC, the info that describes the size/layout of a closure
 226  *     cannot be in an object more than one level of indirection
 227  *     away from the current object, because of the order in
 228  *     which pointers are updated to point to their new locations.
 229  */
 230
 231 typedef struct {
 232     StgHeader      header;
 233     StgArrWords   *instrs;      /* a pointer to an ArrWords */
 234     StgArrWords   *literals;    /* a pointer to an ArrWords */
 235     StgMutArrPtrs *ptrs;        /* a pointer to a  MutArrPtrs */
 236     StgArrWords   *itbls;       /* a pointer to an ArrWords */
 237     StgHalfWord   arity;        /* arity of this BCO */
 238     StgHalfWord   size;         /* size of this BCO (in words) */
 239     StgWord       bitmap[FLEXIBLE_ARRAY];  /* an StgLargeBitmap */
 240 } StgBCO;
 241
 242 #define BCO_BITMAP(bco)      ((StgLargeBitmap *)((StgBCO *)(bco))->bitmap)
 243 #define BCO_BITMAP_SIZE(bco) (BCO_BITMAP(bco)->size)
 244 #define BCO_BITMAP_BITS(bco) (BCO_BITMAP(bco)->bitmap)
 245 #define BCO_BITMAP_SIZEW(bco) ((BCO_BITMAP_SIZE(bco) + BITS_IN(StgWord) - 1) \
 246                                 / BITS_IN(StgWord))
 247
 248 /* -----------------------------------------------------------------------------
 249    Dynamic stack frames for generic heap checks.
 250
 251    These generic heap checks are slow, but have the advantage of being
 252    usable in a variety of situations.
 253
 254    The one restriction is that any relevant SRTs must already be pointed
 255    to from the stack.  The return address doesn't need to have an info
 256    table attached: hence it can be any old code pointer.
 257
 258    The liveness mask contains a 1 at bit n, if register Rn contains a
 259    non-pointer.  The contents of all 8 vanilla registers are always saved
 260    on the stack; the liveness mask tells the GC which ones contain
 261    pointers.
 262
 263    Good places to use a generic heap check:
 264
 265         - case alternatives (the return address with an SRT is already
 266           on the stack).
 267
 268         - primitives (no SRT required).
 269
 270    The stack frame layout for a RET_DYN is like this:
 271
 272           some pointers         |-- RET_DYN_PTRS(liveness) words
 273           some nonpointers      |-- RET_DYN_NONPTRS(liveness) words
 274
 275           L1                    \
 276           D1-2                  |-- RET_DYN_NONPTR_REGS_SIZE words
 277           F1-4                  /
 278
 279           R1-8                  |-- RET_DYN_BITMAP_SIZE words
 280
 281           return address        \
 282           liveness mask         |-- StgRetDyn structure
 283           stg_gen_chk_info      /
 284
 285    we assume that the size of a double is always 2 pointers (wasting a
 286    word when it is only one pointer, but avoiding lots of #ifdefs).
 287
 288    See Liveness.h for the macros (RET_DYN_PTRS() etc.).
 289
 290    NOTE: if you change the layout of RET_DYN stack frames, then you
 291    might also need to adjust the value of RESERVED_STACK_WORDS in
 292    Constants.h.
 293    -------------------------------------------------------------------------- */
 294
 295 typedef struct {
 296     const struct _StgInfoTable* info;
 297     StgWord        liveness;
 298     StgWord        ret_addr;
 299     StgClosure *   payload[FLEXIBLE_ARRAY];
 300 } StgRetDyn;
 301
 302 /* A function return stack frame: used when saving the state for a
 303  * garbage collection at a function entry point.  The function
 304  * arguments are on the stack, and we also save the function (its
 305  * info table describes the pointerhood of the arguments).
 306  *
 307  * The stack frame size is also cached in the frame for convenience.
 308  */
 309 typedef struct {
 310     const struct _StgInfoTable* info;
 311     StgWord        size;
 312     StgClosure *   fun;
 313     StgClosure *   payload[FLEXIBLE_ARRAY];
 314 } StgRetFun;
 315
 316 /* Concurrent communication objects */
 317
 318 typedef struct {
 319   StgHeader       header;
 320   struct StgTSO_ *head;
 321   struct StgTSO_ *tail;
 322   StgClosure*     value;
 323 } StgMVar;
 324
 325
 326 /* STM data structures
 327  *
 328  *  StgTVar defines the only type that can be updated through the STM
 329  *  interface.
 330  *
 331  *  Note that various optimisations may be possible in order to use less
 332  *  space for these data structures at the cost of more complexity in the
 333  *  implementation:
 334  *
 335  *   - In StgTVar, current_value and first_wait_queue_entry could be held in
 336  *     the same field: if any thread is waiting then its expected_value for
 337  *     the tvar is the current value.
 338  *
 339  *   - In StgTRecHeader, it might be worthwhile having separate chunks
 340  *     of read-only and read-write locations.  This would save a
 341  *     new_value field in the read-only locations.
 342  *
 343  *   - In StgAtomicallyFrame, we could combine the waiting bit into
 344  *     the header (maybe a different info tbl for a waiting transaction).
 345  *     This means we can specialise the code for the atomically frame
 346  *     (it immediately switches on frame->waiting anyway).
 347  */
 348
 349 typedef struct StgTVarWaitQueue_ {
 350   StgHeader                  header;
 351   struct StgTSO_            *waiting_tso;
 352   struct StgTVarWaitQueue_  *next_queue_entry;
 353   struct StgTVarWaitQueue_  *prev_queue_entry;
 354 } StgTVarWaitQueue;
 355
 356 typedef struct {
 357   StgHeader                  header;
 358   StgClosure                *volatile current_value;
 359   StgTVarWaitQueue          *volatile first_wait_queue_entry;
 360 #if defined(SMP)
 361   StgInt                     volatile num_updates;
 362 #endif
 363 } StgTVar;
 364
 365 /* new_value == expected_value for read-only accesses */
 366 /* new_value is a StgTVarWaitQueue entry when trec in state TREC_WAITING */
 367 typedef struct {
 368   StgTVar                   *tvar;
 369   StgClosure                *expected_value;
 370   StgClosure                *new_value;
 371 #if defined(SMP)
 372   StgInt                     num_updates;
 373 #endif
 374 } TRecEntry;
 375
 376 #define TREC_CHUNK_NUM_ENTRIES 16
 377
 378 typedef struct StgTRecChunk_ {
 379   StgHeader                  header;
 380   struct StgTRecChunk_      *prev_chunk;
 381   StgWord                    next_entry_idx;
 382   TRecEntry                  entries[TREC_CHUNK_NUM_ENTRIES];
 383 } StgTRecChunk;
 384
 385 typedef enum {
 386   TREC_ACTIVE,        /* Transaction in progress, outcome undecided */
 387   TREC_CONDEMNED,     /* Transaction in progress, inconsistent / out of date reads */
 388   TREC_COMMITTED,     /* Transaction has committed, now updating tvars */
 389   TREC_ABORTED,       /* Transaction has aborted, now reverting tvars */
 390   TREC_WAITING,       /* Transaction currently waiting */
 391 } TRecState;
 392
 393 typedef struct StgTRecHeader_ {
 394   StgHeader                  header;
 395   TRecState                  state;
 396   struct StgTRecHeader_     *enclosing_trec;
 397   StgTRecChunk              *current_chunk;
 398 } StgTRecHeader;
 399
 400 typedef struct {
 401     StgHeader   header;
 402     StgClosure *code;
 403 } StgAtomicallyFrame;
 404
 405 typedef struct {
 406     StgHeader   header;
 407     StgClosure *handler;
 408 } StgCatchSTMFrame;
 409
 410 typedef struct {
 411     StgHeader      header;
 412     StgBool        running_alt_code;
 413     StgClosure    *first_code;
 414     StgClosure    *alt_code;
 415     StgTRecHeader *first_code_trec;
 416 } StgCatchRetryFrame;
 417
 418 #if defined(PAR) || defined(GRAN)
 419 /*
 420   StgBlockingQueueElement is a ``collective type'' representing the types
 421   of closures that can be found on a blocking queue: StgTSO, StgRBHSave,
 422   StgBlockedFetch.  (StgRBHSave can only appear at the end of a blocking
 423   queue).  Logically, this is a union type, but defining another struct
 424   with a common layout is easier to handle in the code.
 425   Note that in the standard setup only StgTSOs can be on a blocking queue.
 426   This is one of the main reasons for slightly different code in files
 427   such as Schedule.c.
 428 */
 429 typedef struct StgBlockingQueueElement_ {
 430   StgHeader                         header;
 431   struct StgBlockingQueueElement_  *link;      /* next elem in BQ */
 432   struct StgClosure_               *payload[FLEXIBLE_ARRAY];/* contents of the closure */
 433 } StgBlockingQueueElement;
 434
 435 /* only difference to std code is type of the elem in the BQ */
 436 typedef struct StgBlockingQueue_ {
 437   StgHeader                 header;
 438   struct StgBlockingQueueElement_ *blocking_queue; /* start of the BQ */
 439 } StgBlockingQueue;
 440
 441 /* this closure is hanging at the end of a blocking queue in (see RBH.c) */
 442 typedef struct StgRBHSave_ {
 443   StgHeader    header;
 444   StgClosure  *payload[FLEXIBLE_ARRAY];     /* 2 words ripped out of the guts of the */
 445 } StgRBHSave;                  /*  closure holding the blocking queue */
 446
 447 typedef struct StgRBH_ {
 448   StgHeader                         header;
 449   struct StgBlockingQueueElement_  *blocking_queue; /* start of the BQ */
 450 } StgRBH;
 451
 452 #endif
 453
 454 #if defined(PAR)
 455 /* global indirections aka FETCH_ME closures */
 456 typedef struct StgFetchMe_ {
 457   StgHeader              header;
 458   globalAddr            *ga;        /* ptr to unique id for a closure */
 459 } StgFetchMe;
 460
 461 /* same contents as an ordinary StgBlockingQueue */
 462 typedef struct StgFetchMeBlockingQueue_ {
 463   StgHeader                          header;
 464   struct StgBlockingQueueElement_   *blocking_queue; /* start of the BQ */
 465 } StgFetchMeBlockingQueue;
 466
 467 /* This is an entry in a blocking queue. It indicates a fetch request from a
 468    TSO on another PE demanding the value of this closur. Note that a
 469    StgBlockedFetch can only occur in a BQ. Once the node is evaluated and
 470    updated with the result, the result will be sent back (the PE is encoded
 471    in the globalAddr) and the StgBlockedFetch closure will be nuked.
 472 */
 473 typedef struct StgBlockedFetch_ {
 474   StgHeader                         header;
 475   struct StgBlockingQueueElement_  *link;     /* next elem in the BQ */
 476   StgClosure                       *node;     /* node to fetch */
 477   globalAddr                        ga;       /* where to send the result to */
 478 } StgBlockedFetch;                            /* NB: not just a ptr to a GA */
 479 #endif
 480
 481 #endif /* CLOSURES_H */