includes/Cmm.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The University of Glasgow 2004
   4  *
   5  * This file is included at the top of all .cmm source files (and
   6  * *only* .cmm files).  It defines a collection of useful macros for
   7  * making .cmm code a bit less error-prone to write, and a bit easier
   8  * on the eye for the reader.
   9  *
  10  * For the syntax of .cmm files, see the parser in ghc/compiler/cmm/CmmParse.y.
  11  *
  12  * If you're used to the old HC file syntax, here's a quick cheat sheet
  13  * for converting HC code:
  14  *
  15  *       - Remove FB_/FE_
  16  *       - Remove all type casts
  17  *       - Remove '&'
  18  *       - STGFUN(foo) { ... }  ==>  foo { ... }
  19  *       - FN_(foo) { ... }  ==>  foo { ... }
  20  *       - JMP_(e)  ==> jump e;
  21  *       - Remove EXTFUN(foo)
  22  *       - Sp[n]  ==>  Sp(n)
  23  *       - Hp[n]  ==>  Hp(n)
  24  *       - Sp += n  ==> Sp_adj(n)
  25  *       - Hp += n  ==> Hp_adj(n)
  26  *       - R1.i   ==>  R1   (similarly for R1.w, R1.cl etc.)
  27  *       - You need to explicitly dereference variables; eg.
  28  *             alloc_blocks   ==>  CInt[alloc_blocks]
  29  *       - convert all word offsets into byte offsets:
  30  *              - e ==> WDS(e)
  31  *       - sizeofW(StgFoo)  ==>  SIZEOF_StgFoo
  32  *       - ENTRY_CODE(e)  ==>  %ENTRY_CODE(e)
  33  *       - get_itbl(c)  ==>  %GET_STD_INFO(c)
  34  *       - Change liveness masks in STK_CHK_GEN, HP_CHK_GEN:
  35  *              R1_PTR | R2_PTR  ==>  R1_PTR & R2_PTR
  36  *              (NOTE: | becomes &)
  37  *       - Declarations like 'StgPtr p;' become just 'W_ p;'
  38  *       - e->payload[n] ==> PAYLOAD(e,n)
  39  *       - Be very careful with comparisons: the infix versions (>, >=, etc.)
  40  *         are unsigned, so use %lt(a,b) to get signed less-than for example.
  41  *
  42  * Accessing fields of structures defined in the RTS header files is
  43  * done via automatically-generated macros in DerivedConstants.h.  For
  44  * example, where previously we used
  45  *
  46  *          CurrentTSO->what_next = x
  47  *
  48  * in C-- we now use
  49  *
  50  *          StgTSO_what_next(CurrentTSO) = x
  51  *
  52  * where the StgTSO_what_next() macro is automatically generated by
  53  * mkDerivedConstnants.c.  If you need to access a field that doesn't
  54  * already have a macro, edit that file (it's pretty self-explanatory).
  55  *
  56  * -------------------------------------------------------------------------- */
  57
  58 #ifndef CMM_H
  59 #define CMM_H
  60
  61 /*
  62  * In files that are included into both C and C-- (and perhaps
  63  * Haskell) sources, we sometimes need to conditionally compile bits
  64  * depending on the language.  CMINUSMINUS==1 in .cmm sources:
  65  */
  66 #define CMINUSMINUS 1
  67
  68 #include "ghcconfig.h"
  69 #include "RtsConfig.h"
  70
  71 /* -----------------------------------------------------------------------------
  72    Types
  73
  74    The following synonyms for C-- types are declared here:
  75
  76      I8, I16, I32, I64    MachRep-style names for convenience
  77
  78      W_                   is shorthand for the word type (== StgWord)
  79      F_                   shorthand for float  (F_ == StgFloat == C's float)
  80      D_                   shorthand for double (D_ == StgDouble == C's double)
  81
  82      CInt                 has the same size as an int in C on this platform
  83      CLong                has the same size as a long in C on this platform
  84
  85   --------------------------------------------------------------------------- */
  86
  87 #define I8  bits8
  88 #define I16 bits16
  89 #define I32 bits32
  90 #define I64 bits64
  91 #define P_  gcptr
  92
  93 #if SIZEOF_VOID_P == 4
  94 #define W_ bits32
  95 /* Maybe it's better to include MachDeps.h */
  96 #define TAG_BITS                2
  97 #elif SIZEOF_VOID_P == 8
  98 #define W_ bits64
  99 /* Maybe it's better to include MachDeps.h */
 100 #define TAG_BITS                3
 101 #else
 102 #error Unknown word size
 103 #endif
 104
 105 /*
 106  * The RTS must sometimes UNTAG a pointer before dereferencing it.
 107  * See the wiki page Commentary/Rts/HaskellExecution/PointerTagging
 108  */
 109 #define TAG_MASK ((1 << TAG_BITS) - 1)
 110 #define UNTAG(p) (p & ~TAG_MASK)
 111 #define GETTAG(p) (p & TAG_MASK)
 112
 113 #if SIZEOF_INT == 4
 114 #define CInt bits32
 115 #elif SIZEOF_INT == 8
 116 #define CInt bits64
 117 #else
 118 #error Unknown int size
 119 #endif
 120
 121 #if SIZEOF_LONG == 4
 122 #define CLong bits32
 123 #elif SIZEOF_LONG == 8
 124 #define CLong bits64
 125 #else
 126 #error Unknown long size
 127 #endif
 128
 129 #define F_ float32
 130 #define D_ float64
 131 #define L_ bits64
 132
 133 #define SIZEOF_StgDouble 8
 134 #define SIZEOF_StgWord64 8
 135
 136 /* -----------------------------------------------------------------------------
 137    Misc useful stuff
 138    -------------------------------------------------------------------------- */
 139
 140 #define NULL (0::W_)
 141
 142 #define STRING(name,str)                        \
 143   section "rodata" {                            \
 144         name : bits8[] str;                     \
 145   }                                             \
 146
 147 /* -----------------------------------------------------------------------------
 148    Byte/word macros
 149
 150    Everything in C-- is in byte offsets (well, most things).  We use
 151    some macros to allow us to express offsets in words and to try to
 152    avoid byte/word confusion.
 153    -------------------------------------------------------------------------- */
 154
 155 #define SIZEOF_W  SIZEOF_VOID_P
 156 #define W_MASK    (SIZEOF_W-1)
 157
 158 #if SIZEOF_W == 4
 159 #define W_SHIFT 2
 160 #elif SIZEOF_W == 8
 161 #define W_SHIFT 4
 162 #endif
 163
 164 /* Converting quantities of words to bytes */
 165 #define WDS(n) ((n)*SIZEOF_W)
 166
 167 /*
 168  * Converting quantities of bytes to words
 169  * NB. these work on *unsigned* values only
 170  */
 171 #define BYTES_TO_WDS(n) ((n) / SIZEOF_W)
 172 #define ROUNDUP_BYTES_TO_WDS(n) (((n) + SIZEOF_W - 1) / SIZEOF_W)
 173
 174 /* TO_W_(n) converts n to W_ type from a smaller type */
 175 #if SIZEOF_W == 4
 176 #define TO_W_(x) %sx32(x)
 177 #define HALF_W_(x) %lobits16(x)
 178 #elif SIZEOF_W == 8
 179 #define TO_W_(x) %sx64(x)
 180 #define HALF_W_(x) %lobits32(x)
 181 #endif
 182
 183 #if SIZEOF_INT == 4 && SIZEOF_W == 8
 184 #define W_TO_INT(x) %lobits32(x)
 185 #elif SIZEOF_INT == SIZEOF_W
 186 #define W_TO_INT(x) (x)
 187 #endif
 188
 189 /* -----------------------------------------------------------------------------
 190    Heap/stack access, and adjusting the heap/stack pointers.
 191    -------------------------------------------------------------------------- */
 192
 193 #define Sp(n)  W_[Sp + WDS(n)]
 194 #define Hp(n)  W_[Hp + WDS(n)]
 195
 196 #define Sp_adj(n) Sp = Sp + WDS(n)
 197 #define Hp_adj(n) Hp = Hp + WDS(n)
 198
 199 /* -----------------------------------------------------------------------------
 200    Assertions and Debuggery
 201    -------------------------------------------------------------------------- */
 202
 203 #ifdef DEBUG
 204 #define ASSERT(predicate)                       \
 205         if (predicate) {                        \
 206             /*null*/;                           \
 207         } else {                                \
 208             foreign "C" _assertFail(NULL, __LINE__); \
 209         }
 210 #else
 211 #define ASSERT(p) /* nothing */
 212 #endif
 213
 214 #ifdef DEBUG
 215 #define DEBUG_ONLY(s) s
 216 #else
 217 #define DEBUG_ONLY(s) /* nothing */
 218 #endif
 219
 220 /*
 221  * The IF_DEBUG macro is useful for debug messages that depend on one
 222  * of the RTS debug options.  For example:
 223  *
 224  *   IF_DEBUG(RtsFlags_DebugFlags_apply,
 225  *      foreign "C" fprintf(stderr, stg_ap_0_ret_str));
 226  *
 227  * Note the syntax is slightly different to the C version of this macro.
 228  */
 229 #ifdef DEBUG
 230 #define IF_DEBUG(c,s)  if (RtsFlags_DebugFlags_##c(RtsFlags) != 0::I32) { s; }
 231 #else
 232 #define IF_DEBUG(c,s)  /* nothing */
 233 #endif
 234
 235 /* -----------------------------------------------------------------------------
 236    Entering
 237
 238    It isn't safe to "enter" every closure.  Functions in particular
 239    have no entry code as such; their entry point contains the code to
 240    apply the function.
 241
 242    ToDo: range should end in N_CLOSURE_TYPES-1, not N_CLOSURE_TYPES,
 243    but switch doesn't allow us to use exprs there yet.
 244
 245    If R1 points to a tagged object it points either to
 246    * A constructor.
 247    * A function with arity <= TAG_MASK.
 248    In both cases the right thing to do is to return.
 249    Note: it is rather lucky that we can use the tag bits to do this
 250          for both objects. Maybe it points to a brittle design?
 251
 252    Indirections can contain tagged pointers, so their tag is checked.
 253    -------------------------------------------------------------------------- */
 254
 255 #define ENTER()                                         \
 256  again:                                                 \
 257   W_ info;                                              \
 258   if (GETTAG(P1) != 0) {                                \
 259       jump %ENTRY_CODE(Sp(0));                          \
 260   }                                                     \
 261   info = %INFO_PTR(P1);                                 \
 262   switch [INVALID_OBJECT .. N_CLOSURE_TYPES]            \
 263          (TO_W_( %INFO_TYPE(%STD_INFO(info)) )) {       \
 264   case                                                  \
 265     IND,                                                \
 266     IND_OLDGEN,                                         \
 267     IND_PERM,                                           \
 268     IND_OLDGEN_PERM,                                    \
 269     IND_STATIC:                                         \
 270    {                                                    \
 271       P1 = StgInd_indirectee(P1);                       \
 272       goto again;                                       \
 273    }                                                    \
 274   case                                                  \
 275     FUN,                                                \
 276     FUN_1_0,                                            \
 277     FUN_0_1,                                            \
 278     FUN_2_0,                                            \
 279     FUN_1_1,                                            \
 280     FUN_STATIC,                                         \
 281     BCO,                                                \
 282     PAP:                                                \
 283    {                                                    \
 284       jump %ENTRY_CODE(Sp(0));                          \
 285    }                                                    \
 286   default:                                              \
 287    {                                                    \
 288       jump %ENTRY_CODE(info);                           \
 289    }                                                    \
 290   }
 291
 292 // The FUN cases almost never happen: a pointer to a non-static FUN
 293 // should always be tagged.  This unfortunately isn't true for the
 294 // interpreter right now, which leaves untagged FUNs on the stack.
 295
 296 /* -----------------------------------------------------------------------------
 297    Constants.
 298    -------------------------------------------------------------------------- */
 299
 300 #include "Constants.h"
 301 #include "DerivedConstants.h"
 302 #include "ClosureTypes.h"
 303 #include "StgFun.h"
 304 #include "OSThreads.h"
 305 #include "SMPClosureOps.h"
 306
 307 /*
 308  * Need MachRegs, because some of the RTS code is conditionally
 309  * compiled based on REG_R1, REG_R2, etc.
 310  */
 311 #define STOLEN_X86_REGS 4
 312 #include "MachRegs.h"
 313
 314 #include "Liveness.h"
 315 #include "StgLdvProf.h"
 316
 317 #undef BLOCK_SIZE
 318 #undef MBLOCK_SIZE
 319 #include "Block.h"  /* For Bdescr() */
 320
 321
 322 /* Can't think of a better place to put this. */
 323 #if SIZEOF_mp_limb_t != SIZEOF_VOID_P
 324 #error mp_limb_t != StgWord: assumptions in PrimOps.cmm are now false
 325 #endif
 326
 327 #define MyCapability()  (BaseReg - OFFSET_Capability_r)
 328
 329 /* -------------------------------------------------------------------------
 330    Allocation and garbage collection
 331    ------------------------------------------------------------------------- */
 332
 333 /*
 334  * ALLOC_PRIM is for allocating memory on the heap for a primitive
 335  * object.  It is used all over PrimOps.cmm.
 336  *
 337  * We make the simplifying assumption that the "admin" part of a
 338  * primitive closure is just the header when calculating sizes for
 339  * ticky-ticky.  It's not clear whether eg. the size field of an array
 340  * should be counted as "admin", or the various fields of a BCO.
 341  */
 342 #define ALLOC_PRIM(bytes,liveness,reentry)                      \
 343    HP_CHK_GEN_TICKY(bytes,liveness,reentry);                    \
 344    TICK_ALLOC_PRIM(SIZEOF_StgHeader,bytes-SIZEOF_StgHeader,0);  \
 345    CCCS_ALLOC(bytes);
 346
 347 /* CCS_ALLOC wants the size in words, because ccs->mem_alloc is in words */
 348 #define CCCS_ALLOC(__alloc) CCS_ALLOC(BYTES_TO_WDS(__alloc), W_[CCCS])
 349
 350 #define HP_CHK_GEN_TICKY(alloc,liveness,reentry)        \
 351    HP_CHK_GEN(alloc,liveness,reentry);                  \
 352    TICK_ALLOC_HEAP_NOCTR(alloc);
 353
 354 // allocateLocal() allocates from the nursery, so we check to see
 355 // whether the nursery is nearly empty in any function that uses
 356 // allocateLocal() - this includes many of the primops.
 357 #define MAYBE_GC(liveness,reentry)                      \
 358   if (bdescr_link(CurrentNursery) == NULL || CInt[alloc_blocks] >= CInt[alloc_blocks_lim]) {            \
 359         R9  = liveness;                                 \
 360         R10 = reentry;                                  \
 361         HpAlloc = 0;                                    \
 362         jump stg_gc_gen_hp;                             \
 363    }
 364
 365 /* -----------------------------------------------------------------------------
 366    Closure headers
 367    -------------------------------------------------------------------------- */
 368
 369 /*
 370  * This is really ugly, since we don't do the rest of StgHeader this
 371  * way.  The problem is that values from DerivedConstants.h cannot be
 372  * dependent on the way (SMP, PROF etc.).  For SIZEOF_StgHeader we get
 373  * the value from GHC, but it seems like too much trouble to do that
 374  * for StgThunkHeader.
 375  */
 376 #define SIZEOF_StgThunkHeader SIZEOF_StgHeader+SIZEOF_StgSMPThunkHeader
 377
 378 #define StgThunk_payload(__ptr__,__ix__) \
 379     W_[__ptr__+SIZEOF_StgThunkHeader+ WDS(__ix__)]
 380
 381 /* -----------------------------------------------------------------------------
 382    Closures
 383    -------------------------------------------------------------------------- */
 384
 385 /* The offset of the payload of an array */
 386 #define BYTE_ARR_CTS(arr)  ((arr) + SIZEOF_StgArrWords)
 387
 388 /* Getting/setting the info pointer of a closure */
 389 #define SET_INFO(p,info) StgHeader_info(p) = info
 390 #define GET_INFO(p) StgHeader_info(p)
 391
 392 /* Determine the size of an ordinary closure from its info table */
 393 #define sizeW_fromITBL(itbl) \
 394   SIZEOF_StgHeader + WDS(%INFO_PTRS(itbl)) + WDS(%INFO_NPTRS(itbl))
 395
 396 /* NB. duplicated from InfoTables.h! */
 397 #define BITMAP_SIZE(bitmap) ((bitmap) & BITMAP_SIZE_MASK)
 398 #define BITMAP_BITS(bitmap) ((bitmap) >> BITMAP_BITS_SHIFT)
 399
 400 /* Debugging macros */
 401 #define LOOKS_LIKE_INFO_PTR(p)                                  \
 402    ((p) != NULL &&                                              \
 403     LOOKS_LIKE_INFO_PTR_NOT_NULL(p))
 404
 405 #define LOOKS_LIKE_INFO_PTR_NOT_NULL(p)                         \
 406    ( (TO_W_(%INFO_TYPE(%STD_INFO(p))) != INVALID_OBJECT) &&     \
 407      (TO_W_(%INFO_TYPE(%STD_INFO(p))) <  N_CLOSURE_TYPES))
 408
 409 #define LOOKS_LIKE_CLOSURE_PTR(p) (LOOKS_LIKE_INFO_PTR(GET_INFO(UNTAG(p))))
 410
 411 /*
 412  * The layout of the StgFunInfoExtra part of an info table changes
 413  * depending on TABLES_NEXT_TO_CODE.  So we define field access
 414  * macros which use the appropriate version here:
 415  */
 416 #ifdef TABLES_NEXT_TO_CODE
 417 /*
 418  * when TABLES_NEXT_TO_CODE, slow_apply is stored as an offset
 419  * instead of the normal pointer.
 420  */
 421
 422 #define StgFunInfoExtra_slow_apply(fun_info)    \
 423         (TO_W_(StgFunInfoExtraRev_slow_apply_offset(fun_info))    \
 424                + (fun_info) + SIZEOF_StgFunInfoExtraRev + SIZEOF_StgInfoTable)
 425
 426 #define StgFunInfoExtra_fun_type(i)   StgFunInfoExtraRev_fun_type(i)
 427 #define StgFunInfoExtra_arity(i)      StgFunInfoExtraRev_arity(i)
 428 #define StgFunInfoExtra_bitmap(i)     StgFunInfoExtraRev_bitmap(i)
 429 #else
 430 #define StgFunInfoExtra_slow_apply(i) StgFunInfoExtraFwd_slow_apply(i)
 431 #define StgFunInfoExtra_fun_type(i)   StgFunInfoExtraFwd_fun_type(i)
 432 #define StgFunInfoExtra_arity(i)      StgFunInfoExtraFwd_arity(i)
 433 #define StgFunInfoExtra_bitmap(i)     StgFunInfoExtraFwd_bitmap(i)
 434 #endif
 435
 436 /* -----------------------------------------------------------------------------
 437    Voluntary Yields/Blocks
 438
 439    We only have a generic version of this at the moment - if it turns
 440    out to be slowing us down we can make specialised ones.
 441    -------------------------------------------------------------------------- */
 442
 443 #define YIELD(liveness,reentry)                 \
 444    R9  = liveness;                              \
 445    R10 = reentry;                               \
 446    jump stg_gen_yield;
 447
 448 #define BLOCK(liveness,reentry)                 \
 449    R9  = liveness;                              \
 450    R10 = reentry;                               \
 451    jump stg_gen_block;
 452
 453 /* -----------------------------------------------------------------------------
 454    Ticky macros
 455    -------------------------------------------------------------------------- */
 456
 457 #ifdef TICKY_TICKY
 458 #define TICK_BUMP_BY(ctr,n) CLong[ctr] = CLong[ctr] + n
 459 #else
 460 #define TICK_BUMP_BY(ctr,n) /* nothing */
 461 #endif
 462
 463 #define TICK_BUMP(ctr)      TICK_BUMP_BY(ctr,1)
 464
 465 #define TICK_ENT_DYN_IND()              TICK_BUMP(ENT_DYN_IND_ctr)
 466 #define TICK_ENT_DYN_THK()              TICK_BUMP(ENT_DYN_THK_ctr)
 467 #define TICK_ENT_VIA_NODE()             TICK_BUMP(ENT_VIA_NODE_ctr)
 468 #define TICK_ENT_STATIC_IND()           TICK_BUMP(ENT_STATIC_IND_ctr)
 469 #define TICK_ENT_PERM_IND()             TICK_BUMP(ENT_PERM_IND_ctr)
 470 #define TICK_ENT_PAP()                  TICK_BUMP(ENT_PAP_ctr)
 471 #define TICK_ENT_AP()                   TICK_BUMP(ENT_AP_ctr)
 472 #define TICK_ENT_AP_STACK()             TICK_BUMP(ENT_AP_STACK_ctr)
 473 #define TICK_ENT_BH()                   TICK_BUMP(ENT_BH_ctr)
 474 #define TICK_UNKNOWN_CALL()             TICK_BUMP(UNKNOWN_CALL_ctr)
 475 #define TICK_UPDF_PUSHED()              TICK_BUMP(UPDF_PUSHED_ctr)
 476 #define TICK_CATCHF_PUSHED()            TICK_BUMP(CATCHF_PUSHED_ctr)
 477 #define TICK_UPDF_OMITTED()             TICK_BUMP(UPDF_OMITTED_ctr)
 478 #define TICK_UPD_NEW_IND()              TICK_BUMP(UPD_NEW_IND_ctr)
 479 #define TICK_UPD_NEW_PERM_IND()         TICK_BUMP(UPD_NEW_PERM_IND_ctr)
 480 #define TICK_UPD_OLD_IND()              TICK_BUMP(UPD_OLD_IND_ctr)
 481 #define TICK_UPD_OLD_PERM_IND()         TICK_BUMP(UPD_OLD_PERM_IND_ctr)
 482
 483 #define TICK_SLOW_CALL_FUN_TOO_FEW()    TICK_BUMP(SLOW_CALL_FUN_TOO_FEW_ctr)
 484 #define TICK_SLOW_CALL_FUN_CORRECT()    TICK_BUMP(SLOW_CALL_FUN_CORRECT_ctr)
 485 #define TICK_SLOW_CALL_FUN_TOO_MANY()   TICK_BUMP(SLOW_CALL_FUN_TOO_MANY_ctr)
 486 #define TICK_SLOW_CALL_PAP_TOO_FEW()    TICK_BUMP(SLOW_CALL_PAP_TOO_FEW_ctr)
 487 #define TICK_SLOW_CALL_PAP_CORRECT()    TICK_BUMP(SLOW_CALL_PAP_CORRECT_ctr)
 488 #define TICK_SLOW_CALL_PAP_TOO_MANY()   TICK_BUMP(SLOW_CALL_PAP_TOO_MANY_ctr)
 489
 490 #define TICK_SLOW_CALL_v()              TICK_BUMP(SLOW_CALL_v_ctr)
 491 #define TICK_SLOW_CALL_p()              TICK_BUMP(SLOW_CALL_p_ctr)
 492 #define TICK_SLOW_CALL_pv()             TICK_BUMP(SLOW_CALL_pv_ctr)
 493 #define TICK_SLOW_CALL_pp()             TICK_BUMP(SLOW_CALL_pp_ctr)
 494 #define TICK_SLOW_CALL_ppp()            TICK_BUMP(SLOW_CALL_ppp_ctr)
 495 #define TICK_SLOW_CALL_pppp()           TICK_BUMP(SLOW_CALL_pppp_ctr)
 496 #define TICK_SLOW_CALL_ppppp()          TICK_BUMP(SLOW_CALL_ppppp_ctr)
 497 #define TICK_SLOW_CALL_pppppp()         TICK_BUMP(SLOW_CALL_pppppp_ctr)
 498
 499 /* NOTE: TICK_HISTO_BY and TICK_HISTO
 500    currently have no effect.
 501    The old code for it didn't typecheck and I
 502    just commented it out to get ticky to work.
 503    - krc 1/2007 */
 504
 505 #define TICK_HISTO_BY(histo,n,i) /* nothing */
 506
 507 #define TICK_HISTO(histo,n) TICK_HISTO_BY(histo,n,1)
 508
 509 /* An unboxed tuple with n components. */
 510 #define TICK_RET_UNBOXED_TUP(n)                 \
 511   TICK_BUMP(RET_UNBOXED_TUP_ctr++);             \
 512   TICK_HISTO(RET_UNBOXED_TUP,n)
 513
 514 /*
 515  * A slow call with n arguments.  In the unevald case, this call has
 516  * already been counted once, so don't count it again.
 517  */
 518 #define TICK_SLOW_CALL(n)                       \
 519   TICK_BUMP(SLOW_CALL_ctr);                     \
 520   TICK_HISTO(SLOW_CALL,n)
 521
 522 /*
 523  * This slow call was found to be to an unevaluated function; undo the
 524  * ticks we did in TICK_SLOW_CALL.
 525  */
 526 #define TICK_SLOW_CALL_UNEVALD(n)               \
 527   TICK_BUMP(SLOW_CALL_UNEVALD_ctr);             \
 528   TICK_BUMP_BY(SLOW_CALL_ctr,-1);               \
 529   TICK_HISTO_BY(SLOW_CALL,n,-1);
 530
 531 /* Updating a closure with a new CON */
 532 #define TICK_UPD_CON_IN_NEW(n)                  \
 533   TICK_BUMP(UPD_CON_IN_NEW_ctr);                \
 534   TICK_HISTO(UPD_CON_IN_NEW,n)
 535
 536 #define TICK_ALLOC_HEAP_NOCTR(n)                \
 537     TICK_BUMP(ALLOC_HEAP_ctr);                  \
 538     TICK_BUMP_BY(ALLOC_HEAP_tot,n)
 539
 540 /* -----------------------------------------------------------------------------
 541    Misc junk
 542    -------------------------------------------------------------------------- */
 543
 544 #define NO_TREC                   stg_NO_TREC_closure
 545 #define END_TSO_QUEUE             stg_END_TSO_QUEUE_closure
 546 #define END_INVARIANT_CHECK_QUEUE stg_END_INVARIANT_CHECK_QUEUE_closure
 547
 548 #define recordMutableCap(p, gen, regs)                                  \
 549   W_ __bd;                                                              \
 550   W_ mut_list;                                                          \
 551   mut_list = Capability_mut_lists(MyCapability()) + WDS(gen);           \
 552  __bd = W_[mut_list];                                                   \
 553   if (bdescr_free(__bd) >= bdescr_start(__bd) + BLOCK_SIZE) {           \
 554       W_ __new_bd;                                                      \
 555       ("ptr" __new_bd) = foreign "C" allocBlock_lock() [regs];          \
 556       bdescr_link(__new_bd) = __bd;                                     \
 557       __bd = __new_bd;                                                  \
 558       W_[mut_list] = __bd;                                              \
 559   }                                                                     \
 560   W_ free;                                                              \
 561   free = bdescr_free(__bd);                                             \
 562   W_[free] = p;                                                         \
 563   bdescr_free(__bd) = free + WDS(1);
 564
 565 #define recordMutable(p, regs)                                  \
 566       P_ __p;                                                   \
 567       W_ __bd;                                                  \
 568       W_ __gen;                                                 \
 569       __p = p;                                                  \
 570       __bd = Bdescr(__p);                                       \
 571       __gen = TO_W_(bdescr_gen_no(__bd));                       \
 572       if (__gen > 0) { recordMutableCap(__p, __gen, regs); }
 573
 574 #endif /* CMM_H */