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