Cmm.h 27.5 KB
Newer Older
1 2
/* -----------------------------------------------------------------------------
 *
3
 * (c) The University of Glasgow 2004-2013
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * This file is included at the top of all .cmm source files (and
 * *only* .cmm files).  It defines a collection of useful macros for
 * making .cmm code a bit less error-prone to write, and a bit easier
 * on the eye for the reader.
 *
 * For the syntax of .cmm files, see the parser in ghc/compiler/cmm/CmmParse.y.
 *
 * Accessing fields of structures defined in the RTS header files is
 * done via automatically-generated macros in DerivedConstants.h.  For
 * example, where previously we used
 *
 *          CurrentTSO->what_next = x
 *
 * in C-- we now use
 *
 *          StgTSO_what_next(CurrentTSO) = x
 *
 * where the StgTSO_what_next() macro is automatically generated by
Gabor Greif's avatar
Gabor Greif committed
23
 * mkDerivedConstants.c.  If you need to access a field that doesn't
24 25 26 27 28 29 30
 * already have a macro, edit that file (it's pretty self-explanatory).
 *
 * -------------------------------------------------------------------------- */

#ifndef CMM_H
#define CMM_H

31 32 33 34 35
/*
 * In files that are included into both C and C-- (and perhaps
 * Haskell) sources, we sometimes need to conditionally compile bits
 * depending on the language.  CMINUSMINUS==1 in .cmm sources:
 */
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
#define CMINUSMINUS 1

#include "ghcconfig.h"

/* -----------------------------------------------------------------------------
   Types 

   The following synonyms for C-- types are declared here:

     I8, I16, I32, I64    MachRep-style names for convenience

     W_                   is shorthand for the word type (== StgWord)
     F_		 	  shorthand for float  (F_ == StgFloat == C's float)
     D_	 		  shorthand for double (D_ == StgDouble == C's double)

     CInt		  has the same size as an int in C on this platform
     CLong		  has the same size as a long in C on this platform
   
  --------------------------------------------------------------------------- */

#define I8  bits8
#define I16 bits16
#define I32 bits32
#define I64 bits64
60
#define P_  gcptr
61 62 63

#if SIZEOF_VOID_P == 4
#define W_ bits32
Simon Marlow's avatar
Simon Marlow committed
64 65
/* Maybe it's better to include MachDeps.h */
#define TAG_BITS                2
66 67
#elif SIZEOF_VOID_P == 8
#define W_ bits64
Simon Marlow's avatar
Simon Marlow committed
68 69
/* Maybe it's better to include MachDeps.h */
#define TAG_BITS                3
70 71 72 73
#else
#error Unknown word size
#endif

Simon Marlow's avatar
Simon Marlow committed
74
/*
Simon Marlow's avatar
Simon Marlow committed
75 76
 * The RTS must sometimes UNTAG a pointer before dereferencing it.
 * See the wiki page Commentary/Rts/HaskellExecution/PointerTagging 
Simon Marlow's avatar
Simon Marlow committed
77 78 79 80 81
 */
#define TAG_MASK ((1 << TAG_BITS) - 1)
#define UNTAG(p) (p & ~TAG_MASK)
#define GETTAG(p) (p & TAG_MASK)

82 83
#if SIZEOF_INT == 4
#define CInt bits32
84
#elif SIZEOF_INT == 8
85 86 87 88 89 90 91
#define CInt bits64
#else
#error Unknown int size
#endif

#if SIZEOF_LONG == 4
#define CLong bits32
92
#elif SIZEOF_LONG == 8
93 94 95 96 97
#define CLong bits64
#else
#error Unknown long size
#endif

98 99 100 101
#define F_   float32
#define D_   float64
#define L_   bits64
#define V16_ bits128
102 103 104 105 106 107 108 109

#define SIZEOF_StgDouble 8
#define SIZEOF_StgWord64 8

/* -----------------------------------------------------------------------------
   Misc useful stuff
   -------------------------------------------------------------------------- */

110 111
#define ccall foreign "C"

112 113 114 115 116 117 118
#define NULL (0::W_)

#define STRING(name,str)			\
  section "rodata" {				\
	name : bits8[] str;			\
  }						\

Simon Marlow's avatar
Simon Marlow committed
119 120 121 122 123 124 125 126 127 128 129 130
#ifdef TABLES_NEXT_TO_CODE
#define RET_LBL(f) f##_info
#else
#define RET_LBL(f) f##_ret
#endif

#ifdef TABLES_NEXT_TO_CODE
#define ENTRY_LBL(f) f##_info
#else
#define ENTRY_LBL(f) f##_entry
#endif

131 132 133 134 135 136 137 138 139 140 141 142 143 144
/* -----------------------------------------------------------------------------
   Byte/word macros

   Everything in C-- is in byte offsets (well, most things).  We use
   some macros to allow us to express offsets in words and to try to
   avoid byte/word confusion.
   -------------------------------------------------------------------------- */

#define SIZEOF_W  SIZEOF_VOID_P
#define W_MASK    (SIZEOF_W-1)

#if SIZEOF_W == 4
#define W_SHIFT 2
#elif SIZEOF_W == 8
145
#define W_SHIFT 3
146 147
#endif

148
/* Converting quantities of words to bytes */
149 150
#define WDS(n) ((n)*SIZEOF_W)

151 152 153 154
/*
 * Converting quantities of bytes to words
 * NB. these work on *unsigned* values only
 */
155 156 157
#define BYTES_TO_WDS(n) ((n) / SIZEOF_W)
#define ROUNDUP_BYTES_TO_WDS(n) (((n) + SIZEOF_W - 1) / SIZEOF_W)

158
/* TO_W_(n) converts n to W_ type from a smaller type */
159 160 161 162 163 164 165 166
#if SIZEOF_W == 4
#define TO_W_(x) %sx32(x)
#define HALF_W_(x) %lobits16(x)
#elif SIZEOF_W == 8
#define TO_W_(x) %sx64(x)
#define HALF_W_(x) %lobits32(x)
#endif

167 168 169 170 171 172
#if SIZEOF_INT == 4 && SIZEOF_W == 8
#define W_TO_INT(x) %lobits32(x)
#elif SIZEOF_INT == SIZEOF_W
#define W_TO_INT(x) (x)
#endif

Ian Lynagh's avatar
Ian Lynagh committed
173 174 175 176 177 178
#if SIZEOF_LONG == 4 && SIZEOF_W == 8
#define W_TO_LONG(x) %lobits32(x)
#elif SIZEOF_LONG == SIZEOF_W
#define W_TO_LONG(x) (x)
#endif

179 180 181 182 183 184 185
/* -----------------------------------------------------------------------------
   Heap/stack access, and adjusting the heap/stack pointers.
   -------------------------------------------------------------------------- */

#define Sp(n)  W_[Sp + WDS(n)]
#define Hp(n)  W_[Hp + WDS(n)]

186
#define Sp_adj(n) Sp = Sp + WDS(n)  /* pronounced "spadge" */
187 188 189 190 191 192 193 194 195 196 197
#define Hp_adj(n) Hp = Hp + WDS(n)

/* -----------------------------------------------------------------------------
   Assertions and Debuggery
   -------------------------------------------------------------------------- */

#ifdef DEBUG
#define ASSERT(predicate)			\
	if (predicate) {			\
	    /*null*/;				\
	} else {				\
198
	    foreign "C" _assertFail(NULL, __LINE__) never returns; \
199 200 201 202 203 204 205 206 207 208 209
        }
#else
#define ASSERT(p) /* nothing */
#endif

#ifdef DEBUG
#define DEBUG_ONLY(s) s
#else
#define DEBUG_ONLY(s) /* nothing */
#endif

210 211 212 213 214 215 216 217 218
/*
 * The IF_DEBUG macro is useful for debug messages that depend on one
 * of the RTS debug options.  For example:
 * 
 *   IF_DEBUG(RtsFlags_DebugFlags_apply,
 *      foreign "C" fprintf(stderr, stg_ap_0_ret_str));
 *
 * Note the syntax is slightly different to the C version of this macro.
 */
219
#ifdef DEBUG
Simon Marlow's avatar
Simon Marlow committed
220
#define IF_DEBUG(c,s)  if (RtsFlags_DebugFlags_##c(RtsFlags) != 0::I32) { s; }
221 222 223 224 225 226 227 228 229 230 231 232 233
#else
#define IF_DEBUG(c,s)  /* nothing */
#endif

/* -----------------------------------------------------------------------------
   Entering 

   It isn't safe to "enter" every closure.  Functions in particular
   have no entry code as such; their entry point contains the code to
   apply the function.

   ToDo: range should end in N_CLOSURE_TYPES-1, not N_CLOSURE_TYPES,
   but switch doesn't allow us to use exprs there yet.
Simon Marlow's avatar
Simon Marlow committed
234 235 236 237 238 239 240 241 242

   If R1 points to a tagged object it points either to
   * A constructor.
   * A function with arity <= TAG_MASK.
   In both cases the right thing to do is to return.
   Note: it is rather lucky that we can use the tag bits to do this
         for both objects. Maybe it points to a brittle design?

   Indirections can contain tagged pointers, so their tag is checked.
243 244
   -------------------------------------------------------------------------- */

245 246 247 248 249 250
#ifdef PROFILING

// When profiling, we cannot shortcut ENTER() by checking the tag,
// because LDV profiling relies on entering closures to mark them as
// "used".

Simon Marlow's avatar
Simon Marlow committed
251 252
#define LOAD_INFO(ret,x)                        \
    info = %INFO_PTR(UNTAG(x));
253

Simon Marlow's avatar
Simon Marlow committed
254
#define UNTAG_IF_PROF(x) UNTAG(x)
255 256 257

#else

258 259 260
#define LOAD_INFO(ret,x)                        \
  if (GETTAG(x) != 0) {                         \
      ret(x);                                   \
261
  }                                             \
262
  info = %INFO_PTR(x);
263

Simon Marlow's avatar
Simon Marlow committed
264
#define UNTAG_IF_PROF(x) (x) /* already untagged */
265 266 267

#endif

268 269 270 271 272 273 274 275 276 277 278 279 280 281
// We need two versions of ENTER():
//  - ENTER(x) takes the closure as an argument and uses return(),
//    for use in civilized code where the stack is handled by GHC
//
//  - ENTER_NOSTACK() where the closure is in R1, and returns are
//    explicit jumps, for use when we are doing the stack management
//    ourselves.

#define ENTER(x) ENTER_(return,x)
#define ENTER_R1() ENTER_(RET_R1,R1)

#define RET_R1(x) jump %ENTRY_CODE(Sp(0)) [R1]

#define ENTER_(ret,x)                                   \
282
 again:							\
283
  W_ info;						\
284
  LOAD_INFO(ret,x)                                       \
285
  switch [INVALID_OBJECT .. N_CLOSURE_TYPES]		\
286 287
         (TO_W_( %INFO_TYPE(%STD_INFO(info)) )) {	\
  case							\
288 289 290 291
    IND,						\
    IND_PERM,						\
    IND_STATIC:						\
   {							\
292
      x = StgInd_indirectee(x);                         \
293 294
      goto again;					\
   }							\
295
  case							\
296 297 298 299 300
    FUN,						\
    FUN_1_0,						\
    FUN_0_1,						\
    FUN_2_0,						\
    FUN_1_1,						\
301
    FUN_0_2,						\
Simon Marlow's avatar
Simon Marlow committed
302 303
    FUN_STATIC,                                         \
    BCO,						\
304 305
    PAP:						\
   {							\
306
       ret(x);                                          \
307 308 309
   }							\
  default:						\
   {							\
Simon Marlow's avatar
Simon Marlow committed
310
       x = UNTAG_IF_PROF(x);                            \
311
       jump %ENTRY_CODE(info) (x);                      \
312 313 314
   }							\
  }

Simon Marlow's avatar
Simon Marlow committed
315 316 317 318
// The FUN cases almost never happen: a pointer to a non-static FUN
// should always be tagged.  This unfortunately isn't true for the
// interpreter right now, which leaves untagged FUNs on the stack.

319 320 321 322
/* -----------------------------------------------------------------------------
   Constants.
   -------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
323
#include "rts/Constants.h"
324
#include "DerivedConstants.h"
Simon Marlow's avatar
Simon Marlow committed
325 326 327 328
#include "rts/storage/ClosureTypes.h"
#include "rts/storage/FunTypes.h"
#include "rts/storage/SMPClosureOps.h"
#include "rts/OSThreads.h"
329

330 331 332 333
/*
 * Need MachRegs, because some of the RTS code is conditionally
 * compiled based on REG_R1, REG_R2, etc.
 */
334
#include "stg/RtsMachRegs.h"
335

Simon Marlow's avatar
Simon Marlow committed
336
#include "rts/prof/LDV.h"
337 338 339

#undef BLOCK_SIZE
#undef MBLOCK_SIZE
Simon Marlow's avatar
Simon Marlow committed
340
#include "rts/storage/Block.h"  /* For Bdescr() */
341 342


343 344
#define MyCapability()  (BaseReg - OFFSET_Capability_r)

345 346 347 348 349
/* -------------------------------------------------------------------------
   Info tables
   ------------------------------------------------------------------------- */

#if defined(PROFILING)
Simon Marlow's avatar
Simon Marlow committed
350 351
#define PROF_HDR_FIELDS(w_,hdr1,hdr2)          \
  w_ hdr1,                                     \
Simon Marlow's avatar
Simon Marlow committed
352
  w_ hdr2,
353
#else
Simon Marlow's avatar
Simon Marlow committed
354
#define PROF_HDR_FIELDS(w_,hdr1,hdr2) /* nothing */
355 356
#endif

357 358 359 360
/* -------------------------------------------------------------------------
   Allocation and garbage collection
   ------------------------------------------------------------------------- */

361 362 363 364 365 366 367 368 369
/*
 * ALLOC_PRIM is for allocating memory on the heap for a primitive
 * object.  It is used all over PrimOps.cmm.
 *
 * We make the simplifying assumption that the "admin" part of a
 * primitive closure is just the header when calculating sizes for
 * ticky-ticky.  It's not clear whether eg. the size field of an array
 * should be counted as "admin", or the various fields of a BCO.
 */
370 371
#define ALLOC_PRIM(bytes)                                       \
   HP_CHK_GEN_TICKY(bytes);                                     \
372 373 374
   TICK_ALLOC_PRIM(SIZEOF_StgHeader,bytes-SIZEOF_StgHeader,0);	\
   CCCS_ALLOC(bytes);

375
#define HEAP_CHECK(bytes,failure)                       \
376
    TICK_BUMP(HEAP_CHK_ctr);				\
377 378
    Hp = Hp + (bytes);                                  \
    if (Hp > HpLim) { HpAlloc = (bytes); failure; }     \
379 380 381 382 383 384 385
    TICK_ALLOC_HEAP_NOCTR(bytes);

#define ALLOC_PRIM_WITH_CUSTOM_FAILURE(bytes,failure)           \
    HEAP_CHECK(bytes,failure)                                   \
    TICK_ALLOC_PRIM(SIZEOF_StgHeader,bytes-SIZEOF_StgHeader,0); \
    CCCS_ALLOC(bytes);

386 387 388
#define ALLOC_PRIM_(bytes,fun)                                  \
    ALLOC_PRIM_WITH_CUSTOM_FAILURE(bytes,GC_PRIM(fun));

389 390 391 392 393 394
#define ALLOC_PRIM_P(bytes,fun,arg)                             \
    ALLOC_PRIM_WITH_CUSTOM_FAILURE(bytes,GC_PRIM_P(fun,arg));

#define ALLOC_PRIM_N(bytes,fun,arg)                             \
    ALLOC_PRIM_WITH_CUSTOM_FAILURE(bytes,GC_PRIM_N(fun,arg));

395
/* CCS_ALLOC wants the size in words, because ccs->mem_alloc is in words */
396
#define CCCS_ALLOC(__alloc) CCS_ALLOC(BYTES_TO_WDS(__alloc), CCCS)
397

nfrisby's avatar
nfrisby committed
398 399 400
#define HP_CHK_GEN_TICKY(bytes)                 \
   HP_CHK_GEN(bytes);                           \
   TICK_ALLOC_HEAP_NOCTR(bytes);
401

402 403 404
#define HP_CHK_P(bytes, fun, arg)               \
   HEAP_CHECK(bytes, GC_PRIM_P(fun,arg))

nfrisby's avatar
nfrisby committed
405 406 407 408 409
// TODO I'm not seeing where ALLOC_P_TICKY is used; can it be removed?
//         -NSF March 2013
#define ALLOC_P_TICKY(bytes, fun, arg)		\
   HP_CHK_P(bytes);				\
   TICK_ALLOC_HEAP_NOCTR(bytes);
410 411 412 413 414

#define CHECK_GC()                                                      \
  (bdescr_link(CurrentNursery) == NULL ||                               \
   generation_n_new_large_words(W_[g0]) >= TO_W_(CLong[large_alloc_lim]))

415
// allocate() allocates from the nursery, so we check to see
416
// whether the nursery is nearly empty in any function that uses
417
// allocate() - this includes many of the primops.
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
//
// HACK alert: the __L__ stuff is here to coax the common-block
// eliminator into commoning up the call stg_gc_noregs() with the same
// code that gets generated by a STK_CHK_GEN() in the same proc.  We
// also need an if (0) { goto __L__; } so that the __L__ label isn't
// optimised away by the control-flow optimiser prior to common-block
// elimination (it will be optimised away later).
//
// This saves some code in gmp-wrappers.cmm where we have lots of
// MAYBE_GC() in the same proc as STK_CHK_GEN().
//
#define MAYBE_GC(retry)                         \
    if (CHECK_GC()) {                           \
        HpAlloc = 0;                            \
        goto __L__;                             \
  __L__:                                        \
        call stg_gc_noregs();                   \
        goto retry;                             \
   }                                            \
   if (0) { goto __L__; }

#define GC_PRIM(fun)                            \
        R9 = fun;                               \
        jump stg_gc_prim();

#define GC_PRIM_N(fun,arg)                      \
        R9 = fun;                               \
        jump stg_gc_prim_n(arg);

#define GC_PRIM_P(fun,arg)                      \
        R9 = fun;                               \
        jump stg_gc_prim_p(arg);

#define GC_PRIM_PP(fun,arg1,arg2)               \
        R9 = fun;                               \
        jump stg_gc_prim_pp(arg1,arg2);

#define MAYBE_GC_(fun)                          \
    if (CHECK_GC()) {                           \
        HpAlloc = 0;                            \
        GC_PRIM(fun)                            \
   }

#define MAYBE_GC_N(fun,arg)                     \
    if (CHECK_GC()) {                           \
        HpAlloc = 0;                            \
        GC_PRIM_N(fun,arg)                      \
   }

#define MAYBE_GC_P(fun,arg)                     \
    if (CHECK_GC()) {                           \
        HpAlloc = 0;                            \
        GC_PRIM_P(fun,arg)                      \
471 472
   }

473 474 475 476 477 478 479
#define MAYBE_GC_PP(fun,arg1,arg2)              \
    if (CHECK_GC()) {                           \
        HpAlloc = 0;                            \
        GC_PRIM_PP(fun,arg1,arg2)               \
   }

#define STK_CHK(n, fun)                         \
480
    TICK_BUMP(STK_CHK_ctr); 			\
481
    if (Sp - (n) < SpLim) {                     \
482 483 484 485
        GC_PRIM(fun)                            \
    }

#define STK_CHK_P(n, fun, arg)                  \
486
    if (Sp - (n) < SpLim) {                     \
487 488 489 490
        GC_PRIM_P(fun,arg)                      \
    }

#define STK_CHK_PP(n, fun, arg1, arg2)          \
491
    if (Sp - (n) < SpLim) {                     \
492 493 494 495
        GC_PRIM_PP(fun,arg1,arg2)               \
    }

#define STK_CHK_ENTER(n, closure)               \
496
    if (Sp - (n) < SpLim) {                     \
497 498 499 500 501 502 503 504
        jump __stg_gc_enter_1(closure);         \
    }

// A funky heap check used by AutoApply.cmm

#define HP_CHK_NP_ASSIGN_SP0(size,f)                    \
    HEAP_CHECK(size, Sp(0) = f; jump __stg_gc_enter_1 [R1];)

505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
/* -----------------------------------------------------------------------------
   Closure headers
   -------------------------------------------------------------------------- */

/*
 * This is really ugly, since we don't do the rest of StgHeader this
 * way.  The problem is that values from DerivedConstants.h cannot be 
 * dependent on the way (SMP, PROF etc.).  For SIZEOF_StgHeader we get
 * the value from GHC, but it seems like too much trouble to do that
 * for StgThunkHeader.
 */
#define SIZEOF_StgThunkHeader SIZEOF_StgHeader+SIZEOF_StgSMPThunkHeader

#define StgThunk_payload(__ptr__,__ix__) \
    W_[__ptr__+SIZEOF_StgThunkHeader+ WDS(__ix__)]

521 522 523 524
/* -----------------------------------------------------------------------------
   Closures
   -------------------------------------------------------------------------- */

525
/* The offset of the payload of an array */
526 527
#define BYTE_ARR_CTS(arr)  ((arr) + SIZEOF_StgArrWords)

528 529 530
/* The number of words allocated in an array payload */
#define BYTE_ARR_WDS(arr) ROUNDUP_BYTES_TO_WDS(StgArrWords_bytes(arr))

531
/* Getting/setting the info pointer of a closure */
532 533 534
#define SET_INFO(p,info) StgHeader_info(p) = info
#define GET_INFO(p) StgHeader_info(p)

535
/* Determine the size of an ordinary closure from its info table */
536 537 538
#define sizeW_fromITBL(itbl) \
  SIZEOF_StgHeader + WDS(%INFO_PTRS(itbl)) + WDS(%INFO_NPTRS(itbl))

539
/* NB. duplicated from InfoTables.h! */
540 541 542
#define BITMAP_SIZE(bitmap) ((bitmap) & BITMAP_SIZE_MASK)
#define BITMAP_BITS(bitmap) ((bitmap) >> BITMAP_BITS_SHIFT)

543
/* Debugging macros */
Ian Lynagh's avatar
Ian Lynagh committed
544 545 546 547 548 549
#define LOOKS_LIKE_INFO_PTR(p)                                  \
   ((p) != NULL &&                                              \
    LOOKS_LIKE_INFO_PTR_NOT_NULL(p))

#define LOOKS_LIKE_INFO_PTR_NOT_NULL(p)                         \
   ( (TO_W_(%INFO_TYPE(%STD_INFO(p))) != INVALID_OBJECT) &&     \
550 551
     (TO_W_(%INFO_TYPE(%STD_INFO(p))) <  N_CLOSURE_TYPES))

Simon Marlow's avatar
Simon Marlow committed
552
#define LOOKS_LIKE_CLOSURE_PTR(p) (LOOKS_LIKE_INFO_PTR(GET_INFO(UNTAG(p))))
553

554 555 556 557 558
/*
 * The layout of the StgFunInfoExtra part of an info table changes
 * depending on TABLES_NEXT_TO_CODE.  So we define field access
 * macros which use the appropriate version here:
 */
559
#ifdef TABLES_NEXT_TO_CODE
560 561 562 563
/*
 * when TABLES_NEXT_TO_CODE, slow_apply is stored as an offset
 * instead of the normal pointer.
 */
564 565
        
#define StgFunInfoExtra_slow_apply(fun_info)    \
566 567
        (TO_W_(StgFunInfoExtraRev_slow_apply_offset(fun_info))    \
               + (fun_info) + SIZEOF_StgFunInfoExtraRev + SIZEOF_StgInfoTable)
568

569 570 571 572 573 574 575 576 577 578
#define StgFunInfoExtra_fun_type(i)   StgFunInfoExtraRev_fun_type(i)
#define StgFunInfoExtra_arity(i)      StgFunInfoExtraRev_arity(i)
#define StgFunInfoExtra_bitmap(i)     StgFunInfoExtraRev_bitmap(i)
#else
#define StgFunInfoExtra_slow_apply(i) StgFunInfoExtraFwd_slow_apply(i)
#define StgFunInfoExtra_fun_type(i)   StgFunInfoExtraFwd_fun_type(i)
#define StgFunInfoExtra_arity(i)      StgFunInfoExtraFwd_arity(i)
#define StgFunInfoExtra_bitmap(i)     StgFunInfoExtraFwd_bitmap(i)
#endif

pumpkin's avatar
pumpkin committed
579 580 581 582
#define mutArrCardMask ((1 << MUT_ARR_PTRS_CARD_BITS) - 1)
#define mutArrPtrCardDown(i) ((i) >> MUT_ARR_PTRS_CARD_BITS)
#define mutArrPtrCardUp(i)   (((i) + mutArrCardMask) >> MUT_ARR_PTRS_CARD_BITS)
#define mutArrPtrsCardWords(n) ROUNDUP_BYTES_TO_WDS(mutArrPtrCardUp(n))
583

584 585 586 587 588 589
#if defined(PROFILING) || (!defined(THREADED_RTS) && defined(DEBUG))
#define OVERWRITING_CLOSURE(c) foreign "C" overwritingClosure(c "ptr")
#else
#define OVERWRITING_CLOSURE(c) /* nothing */
#endif

590 591 592 593 594 595
#ifdef THREADED_RTS
#define prim_write_barrier prim %write_barrier()
#else
#define prim_write_barrier /* nothing */
#endif

596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
/* -----------------------------------------------------------------------------
   Ticky macros 
   -------------------------------------------------------------------------- */

#ifdef TICKY_TICKY
#define TICK_BUMP_BY(ctr,n) CLong[ctr] = CLong[ctr] + n
#else
#define TICK_BUMP_BY(ctr,n) /* nothing */
#endif

#define TICK_BUMP(ctr)      TICK_BUMP_BY(ctr,1)

#define TICK_ENT_DYN_IND()  		TICK_BUMP(ENT_DYN_IND_ctr)
#define TICK_ENT_DYN_THK()  		TICK_BUMP(ENT_DYN_THK_ctr)
#define TICK_ENT_VIA_NODE()  		TICK_BUMP(ENT_VIA_NODE_ctr)
#define TICK_ENT_STATIC_IND()  		TICK_BUMP(ENT_STATIC_IND_ctr)
#define TICK_ENT_PERM_IND()  		TICK_BUMP(ENT_PERM_IND_ctr)
#define TICK_ENT_PAP()  		TICK_BUMP(ENT_PAP_ctr)
#define TICK_ENT_AP()  			TICK_BUMP(ENT_AP_ctr)
#define TICK_ENT_AP_STACK()  		TICK_BUMP(ENT_AP_STACK_ctr)
#define TICK_ENT_BH()  			TICK_BUMP(ENT_BH_ctr)
nfrisby's avatar
nfrisby committed
617
#define TICK_ENT_LNE() 			TICK_BUMP(ENT_LNE_ctr)
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
#define TICK_UNKNOWN_CALL()  		TICK_BUMP(UNKNOWN_CALL_ctr)
#define TICK_UPDF_PUSHED()  		TICK_BUMP(UPDF_PUSHED_ctr)
#define TICK_CATCHF_PUSHED()  		TICK_BUMP(CATCHF_PUSHED_ctr)
#define TICK_UPDF_OMITTED()  		TICK_BUMP(UPDF_OMITTED_ctr)
#define TICK_UPD_NEW_IND()  		TICK_BUMP(UPD_NEW_IND_ctr)
#define TICK_UPD_NEW_PERM_IND()  	TICK_BUMP(UPD_NEW_PERM_IND_ctr)
#define TICK_UPD_OLD_IND()  		TICK_BUMP(UPD_OLD_IND_ctr)
#define TICK_UPD_OLD_PERM_IND()  	TICK_BUMP(UPD_OLD_PERM_IND_ctr)
  
#define TICK_SLOW_CALL_FUN_TOO_FEW()	TICK_BUMP(SLOW_CALL_FUN_TOO_FEW_ctr)
#define TICK_SLOW_CALL_FUN_CORRECT()	TICK_BUMP(SLOW_CALL_FUN_CORRECT_ctr)
#define TICK_SLOW_CALL_FUN_TOO_MANY()	TICK_BUMP(SLOW_CALL_FUN_TOO_MANY_ctr)
#define TICK_SLOW_CALL_PAP_TOO_FEW()	TICK_BUMP(SLOW_CALL_PAP_TOO_FEW_ctr)
#define TICK_SLOW_CALL_PAP_CORRECT()	TICK_BUMP(SLOW_CALL_PAP_CORRECT_ctr)
#define TICK_SLOW_CALL_PAP_TOO_MANY()	TICK_BUMP(SLOW_CALL_PAP_TOO_MANY_ctr)

nfrisby's avatar
nfrisby committed
634 635 636 637 638 639 640 641 642 643 644 645
#define TICK_SLOW_CALL_fast_v16()    	TICK_BUMP(SLOW_CALL_fast_v16_ctr)
#define TICK_SLOW_CALL_fast_v()  	TICK_BUMP(SLOW_CALL_fast_v_ctr)
#define TICK_SLOW_CALL_fast_p()  	TICK_BUMP(SLOW_CALL_fast_p_ctr)
#define TICK_SLOW_CALL_fast_pv()  	TICK_BUMP(SLOW_CALL_fast_pv_ctr)
#define TICK_SLOW_CALL_fast_pp()  	TICK_BUMP(SLOW_CALL_fast_pp_ctr)
#define TICK_SLOW_CALL_fast_ppv()  	TICK_BUMP(SLOW_CALL_fast_ppv_ctr)
#define TICK_SLOW_CALL_fast_ppp()  	TICK_BUMP(SLOW_CALL_fast_ppp_ctr)
#define TICK_SLOW_CALL_fast_pppv()  	TICK_BUMP(SLOW_CALL_fast_pppv_ctr)
#define TICK_SLOW_CALL_fast_pppp()  	TICK_BUMP(SLOW_CALL_fast_pppp_ctr)
#define TICK_SLOW_CALL_fast_ppppp()  	TICK_BUMP(SLOW_CALL_fast_ppppp_ctr)
#define TICK_SLOW_CALL_fast_pppppp()  	TICK_BUMP(SLOW_CALL_fast_pppppp_ctr)
#define TICK_VERY_SLOW_CALL()  		TICK_BUMP(VERY_SLOW_CALL_ctr)
646

647 648 649 650 651 652
/* NOTE: TICK_HISTO_BY and TICK_HISTO 
   currently have no effect.
   The old code for it didn't typecheck and I 
   just commented it out to get ticky to work.
   - krc 1/2007 */

653 654 655 656
#define TICK_HISTO_BY(histo,n,i) /* nothing */

#define TICK_HISTO(histo,n) TICK_HISTO_BY(histo,n,1)

657
/* An unboxed tuple with n components. */
658 659 660 661
#define TICK_RET_UNBOXED_TUP(n)			\
  TICK_BUMP(RET_UNBOXED_TUP_ctr++);		\
  TICK_HISTO(RET_UNBOXED_TUP,n)

662 663 664 665
/*
 * A slow call with n arguments.  In the unevald case, this call has
 * already been counted once, so don't count it again.
 */
666 667 668 669
#define TICK_SLOW_CALL(n)			\
  TICK_BUMP(SLOW_CALL_ctr);			\
  TICK_HISTO(SLOW_CALL,n)

670 671 672 673
/*
 * This slow call was found to be to an unevaluated function; undo the
 * ticks we did in TICK_SLOW_CALL.
 */
674 675 676 677 678
#define TICK_SLOW_CALL_UNEVALD(n)		\
  TICK_BUMP(SLOW_CALL_UNEVALD_ctr);		\
  TICK_BUMP_BY(SLOW_CALL_ctr,-1);		\
  TICK_HISTO_BY(SLOW_CALL,n,-1);

679
/* Updating a closure with a new CON */
680 681 682 683
#define TICK_UPD_CON_IN_NEW(n)			\
  TICK_BUMP(UPD_CON_IN_NEW_ctr);		\
  TICK_HISTO(UPD_CON_IN_NEW,n)

nfrisby's avatar
nfrisby committed
684 685 686
#define TICK_ALLOC_HEAP_NOCTR(bytes)		\
    TICK_BUMP(ALLOC_RTS_ctr);			\
    TICK_BUMP_BY(ALLOC_RTS_tot,bytes)
687

688 689 690 691 692 693 694 695 696 697 698 699 700
/* -----------------------------------------------------------------------------
   Saving and restoring STG registers

   STG registers must be saved around a C call, just in case the STG
   register is mapped to a caller-saves machine register.  Normally we
   don't need to worry about this the code generator has already
   loaded any live STG registers into variables for us, but in
   hand-written low-level Cmm code where we don't know which registers
   are live, we might have to save them all.
   -------------------------------------------------------------------------- */

#define SAVE_STGREGS                            \
    W_ r1, r2, r3,  r4,  r5,  r6,  r7,  r8;     \
701 702
    F_ f1, f2, f3, f4, f5, f6;                  \
    D_ d1, d2, d3, d4, d5, d6;                  \
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
    L_ l1;                                      \
                                                \
    r1 = R1;                                    \
    r2 = R2;                                    \
    r3 = R3;                                    \
    r4 = R4;                                    \
    r5 = R5;                                    \
    r6 = R6;                                    \
    r7 = R7;                                    \
    r8 = R8;                                    \
                                                \
    f1 = F1;                                    \
    f2 = F2;                                    \
    f3 = F3;                                    \
    f4 = F4;                                    \
718 719
    f5 = F5;                                    \
    f6 = F6;                                    \
720 721 722
                                                \
    d1 = D1;                                    \
    d2 = D2;                                    \
723 724 725 726
    d3 = D3;                                    \
    d4 = D4;                                    \
    d5 = D5;                                    \
    d6 = D6;                                    \
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
                                                \
    l1 = L1;


#define RESTORE_STGREGS                         \
    R1 = r1;                                    \
    R2 = r2;                                    \
    R3 = r3;                                    \
    R4 = r4;                                    \
    R5 = r5;                                    \
    R6 = r6;                                    \
    R7 = r7;                                    \
    R8 = r8;                                    \
                                                \
    F1 = f1;                                    \
    F2 = f2;                                    \
    F3 = f3;                                    \
    F4 = f4;                                    \
745 746
    F5 = f5;                                    \
    F6 = f6;                                    \
747 748 749
                                                \
    D1 = d1;                                    \
    D2 = d2;                                    \
750 751 752 753
    D3 = d3;                                    \
    D4 = d4;                                    \
    D5 = d5;                                    \
    D6 = d6;                                    \
754 755 756
                                                \
    L1 = l1;

757 758 759 760
/* -----------------------------------------------------------------------------
   Misc junk
   -------------------------------------------------------------------------- */

tharris@microsoft.com's avatar
tharris@microsoft.com committed
761 762
#define NO_TREC                   stg_NO_TREC_closure
#define END_TSO_QUEUE             stg_END_TSO_QUEUE_closure
Ben Gamari's avatar
Ben Gamari committed
763
#define STM_AWOKEN                stg_STM_AWOKEN_closure
tharris@microsoft.com's avatar
tharris@microsoft.com committed
764
#define END_INVARIANT_CHECK_QUEUE stg_END_INVARIANT_CHECK_QUEUE_closure
765

766
#define recordMutableCap(p, gen)                                        \
767 768 769 770 771 772
  W_ __bd;								\
  W_ mut_list;								\
  mut_list = Capability_mut_lists(MyCapability()) + WDS(gen);		\
 __bd = W_[mut_list];							\
  if (bdescr_free(__bd) >= bdescr_start(__bd) + BLOCK_SIZE) {		\
      W_ __new_bd;							\
773
      ("ptr" __new_bd) = foreign "C" allocBlock_lock();			\
774 775 776 777 778 779 780 781 782
      bdescr_link(__new_bd) = __bd;					\
      __bd = __new_bd;							\
      W_[mut_list] = __bd;						\
  }									\
  W_ free;								\
  free = bdescr_free(__bd);						\
  W_[free] = p;								\
  bdescr_free(__bd) = free + WDS(1);

783
#define recordMutable(p)                                        \
784
      P_ __p;                                                   \
785 786 787 788 789
      W_ __bd;                                                  \
      W_ __gen;                                                 \
      __p = p;                                                  \
      __bd = Bdescr(__p);                                       \
      __gen = TO_W_(bdescr_gen_no(__bd));                       \
790
      if (__gen > 0) { recordMutableCap(__p, __gen); }
791

792
#endif /* CMM_H */