ghc/rts/Storage.c

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2004
   4  *
   5  * Storage manager front end
   6  *
   7  * ---------------------------------------------------------------------------*/
   8
   9 #include "PosixSource.h"
  10 #include "Rts.h"
  11 #include "RtsUtils.h"
  12 #include "RtsFlags.h"
  13 #include "Stats.h"
  14 #include "Hooks.h"
  15 #include "BlockAlloc.h"
  16 #include "MBlock.h"
  17 #include "Weak.h"
  18 #include "Sanity.h"
  19 #include "Arena.h"
  20 #include "OSThreads.h"
  21 #include "Capability.h"
  22 #include "Storage.h"
  23 #include "Schedule.h"
  24 #include "RetainerProfile.h"    // for counting memory blocks (memInventory)
  25
  26 #include <stdlib.h>
  27 #include <string.h>
  28
  29 StgClosure    *caf_list         = NULL;
  30 StgClosure    *revertible_caf_list = NULL;
  31 rtsBool       keepCAFs;
  32
  33 bdescr *small_alloc_list;       /* allocate()d small objects */
  34 bdescr *pinned_object_block;    /* allocate pinned objects into this block */
  35 nat alloc_blocks;               /* number of allocate()d blocks since GC */
  36 nat alloc_blocks_lim;           /* approximate limit on alloc_blocks */
  37
  38 StgPtr alloc_Hp    = NULL;      /* next free byte in small_alloc_list */
  39 StgPtr alloc_HpLim = NULL;      /* end of block at small_alloc_list   */
  40
  41 generation *generations = NULL; /* all the generations */
  42 generation *g0          = NULL; /* generation 0, for convenience */
  43 generation *oldest_gen  = NULL; /* oldest generation, for convenience */
  44 step *g0s0              = NULL; /* generation 0, step 0, for convenience */
  45
  46 ullong total_allocated = 0;     /* total memory allocated during run */
  47
  48 /*
  49  * Storage manager mutex:  protects all the above state from
  50  * simultaneous access by two STG threads.
  51  */
  52 #ifdef SMP
  53 Mutex sm_mutex = INIT_MUTEX_VAR;
  54 #endif
  55
  56 /*
  57  * Forward references
  58  */
  59 static void *stgAllocForGMP   (size_t size_in_bytes);
  60 static void *stgReallocForGMP (void *ptr, size_t old_size, size_t new_size);
  61 static void  stgDeallocForGMP (void *ptr, size_t size);
  62
  63 /*
  64  * Storage manager mutex
  65  */
  66 #if defined(SMP)
  67 extern Mutex sm_mutex;
  68 #define ACQUIRE_SM_LOCK   ACQUIRE_LOCK(&sm_mutex)
  69 #define RELEASE_SM_LOCK   RELEASE_LOCK(&sm_mutex)
  70 #else
  71 #define ACQUIRE_SM_LOCK
  72 #define RELEASE_SM_LOCK
  73 #endif
  74
  75 void
  76 initStorage( void )
  77 {
  78   nat g, s;
  79   step *stp;
  80   generation *gen;
  81
  82   if (generations != NULL) {
  83       // multi-init protection
  84       return;
  85   }
  86
  87   /* Sanity check to make sure the LOOKS_LIKE_ macros appear to be
  88    * doing something reasonable.
  89    */
  90   ASSERT(LOOKS_LIKE_INFO_PTR(&stg_BLACKHOLE_info));
  91   ASSERT(LOOKS_LIKE_CLOSURE_PTR(&stg_dummy_ret_closure));
  92   ASSERT(!HEAP_ALLOCED(&stg_dummy_ret_closure));
  93
  94   if (RtsFlags.GcFlags.maxHeapSize != 0 &&
  95       RtsFlags.GcFlags.heapSizeSuggestion >
  96       RtsFlags.GcFlags.maxHeapSize) {
  97     RtsFlags.GcFlags.maxHeapSize = RtsFlags.GcFlags.heapSizeSuggestion;
  98   }
  99
 100   if (RtsFlags.GcFlags.maxHeapSize != 0 &&
 101       RtsFlags.GcFlags.minAllocAreaSize >
 102       RtsFlags.GcFlags.maxHeapSize) {
 103       errorBelch("maximum heap size (-M) is smaller than minimum alloc area size (-A)");
 104       exit(1);
 105   }
 106
 107   initBlockAllocator();
 108
 109 #if defined(SMP)
 110   initMutex(&sm_mutex);
 111 #endif
 112
 113   /* allocate generation info array */
 114   generations = (generation *)stgMallocBytes(RtsFlags.GcFlags.generations
 115                                              * sizeof(struct _generation),
 116                                              "initStorage: gens");
 117
 118   /* Initialise all generations */
 119   for(g = 0; g < RtsFlags.GcFlags.generations; g++) {
 120     gen = &generations[g];
 121     gen->no = g;
 122     gen->mut_list = allocBlock();
 123     gen->collections = 0;
 124     gen->failed_promotions = 0;
 125     gen->max_blocks = 0;
 126   }
 127
 128   /* A couple of convenience pointers */
 129   g0 = &generations[0];
 130   oldest_gen = &generations[RtsFlags.GcFlags.generations-1];
 131
 132   /* Allocate step structures in each generation */
 133   if (RtsFlags.GcFlags.generations > 1) {
 134     /* Only for multiple-generations */
 135
 136     /* Oldest generation: one step */
 137     oldest_gen->n_steps = 1;
 138     oldest_gen->steps =
 139       stgMallocBytes(1 * sizeof(struct _step), "initStorage: last step");
 140
 141     /* set up all except the oldest generation with 2 steps */
 142     for(g = 0; g < RtsFlags.GcFlags.generations-1; g++) {
 143       generations[g].n_steps = RtsFlags.GcFlags.steps;
 144       generations[g].steps  =
 145         stgMallocBytes (RtsFlags.GcFlags.steps * sizeof(struct _step),
 146                         "initStorage: steps");
 147     }
 148
 149   } else {
 150     /* single generation, i.e. a two-space collector */
 151     g0->n_steps = 1;
 152     g0->steps = stgMallocBytes (sizeof(struct _step), "initStorage: steps");
 153   }
 154
 155   /* Initialise all steps */
 156   for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
 157     for (s = 0; s < generations[g].n_steps; s++) {
 158       stp = &generations[g].steps[s];
 159       stp->no = s;
 160       stp->blocks = NULL;
 161       stp->n_to_blocks = 0;
 162       stp->n_blocks = 0;
 163       stp->gen = &generations[g];
 164       stp->gen_no = g;
 165       stp->hp = NULL;
 166       stp->hpLim = NULL;
 167       stp->hp_bd = NULL;
 168       stp->scan = NULL;
 169       stp->scan_bd = NULL;
 170       stp->large_objects = NULL;
 171       stp->n_large_blocks = 0;
 172       stp->new_large_objects = NULL;
 173       stp->scavenged_large_objects = NULL;
 174       stp->n_scavenged_large_blocks = 0;
 175       stp->is_compacted = 0;
 176       stp->bitmap = NULL;
 177     }
 178   }
 179
 180   /* Set up the destination pointers in each younger gen. step */
 181   for (g = 0; g < RtsFlags.GcFlags.generations-1; g++) {
 182     for (s = 0; s < generations[g].n_steps-1; s++) {
 183       generations[g].steps[s].to = &generations[g].steps[s+1];
 184     }
 185     generations[g].steps[s].to = &generations[g+1].steps[0];
 186   }
 187
 188   /* The oldest generation has one step and it is compacted. */
 189   if (RtsFlags.GcFlags.compact) {
 190       if (RtsFlags.GcFlags.generations == 1) {
 191           errorBelch("WARNING: compaction is incompatible with -G1; disabled");
 192       } else {
 193           oldest_gen->steps[0].is_compacted = 1;
 194       }
 195   }
 196   oldest_gen->steps[0].to = &oldest_gen->steps[0];
 197
 198   /* generation 0 is special: that's the nursery */
 199   generations[0].max_blocks = 0;
 200
 201   /* G0S0: the allocation area.  Policy: keep the allocation area
 202    * small to begin with, even if we have a large suggested heap
 203    * size.  Reason: we're going to do a major collection first, and we
 204    * don't want it to be a big one.  This vague idea is borne out by
 205    * rigorous experimental evidence.
 206    */
 207   g0s0 = &generations[0].steps[0];
 208
 209   allocNurseries();
 210
 211   weak_ptr_list = NULL;
 212   caf_list = NULL;
 213   revertible_caf_list = NULL;
 214
 215   /* initialise the allocate() interface */
 216   small_alloc_list = NULL;
 217   alloc_blocks = 0;
 218   alloc_blocks_lim = RtsFlags.GcFlags.minAllocAreaSize;
 219
 220   /* Tell GNU multi-precision pkg about our custom alloc functions */
 221   mp_set_memory_functions(stgAllocForGMP, stgReallocForGMP, stgDeallocForGMP);
 222
 223   IF_DEBUG(gc, statDescribeGens());
 224 }
 225
 226 void
 227 exitStorage (void)
 228 {
 229     stat_exit(calcAllocated());
 230 }
 231
 232 /* -----------------------------------------------------------------------------
 233    CAF management.
 234
 235    The entry code for every CAF does the following:
 236
 237       - builds a CAF_BLACKHOLE in the heap
 238       - pushes an update frame pointing to the CAF_BLACKHOLE
 239       - invokes UPD_CAF(), which:
 240           - calls newCaf, below
 241           - updates the CAF with a static indirection to the CAF_BLACKHOLE
 242
 243    Why do we build a BLACKHOLE in the heap rather than just updating
 244    the thunk directly?  It's so that we only need one kind of update
 245    frame - otherwise we'd need a static version of the update frame too.
 246
 247    newCaf() does the following:
 248
 249       - it puts the CAF on the oldest generation's mut-once list.
 250         This is so that we can treat the CAF as a root when collecting
 251         younger generations.
 252
 253    For GHCI, we have additional requirements when dealing with CAFs:
 254
 255       - we must *retain* all dynamically-loaded CAFs ever entered,
 256         just in case we need them again.
 257       - we must be able to *revert* CAFs that have been evaluated, to
 258         their pre-evaluated form.
 259
 260       To do this, we use an additional CAF list.  When newCaf() is
 261       called on a dynamically-loaded CAF, we add it to the CAF list
 262       instead of the old-generation mutable list, and save away its
 263       old info pointer (in caf->saved_info) for later reversion.
 264
 265       To revert all the CAFs, we traverse the CAF list and reset the
 266       info pointer to caf->saved_info, then throw away the CAF list.
 267       (see GC.c:revertCAFs()).
 268
 269       -- SDM 29/1/01
 270
 271    -------------------------------------------------------------------------- */
 272
 273 void
 274 newCAF(StgClosure* caf)
 275 {
 276   ACQUIRE_SM_LOCK;
 277
 278   if(keepCAFs)
 279   {
 280     // HACK:
 281     // If we are in GHCi _and_ we are using dynamic libraries,
 282     // then we can't redirect newCAF calls to newDynCAF (see below),
 283     // so we make newCAF behave almost like newDynCAF.
 284     // The dynamic libraries might be used by both the interpreted
 285     // program and GHCi itself, so they must not be reverted.
 286     // This also means that in GHCi with dynamic libraries, CAFs are not
 287     // garbage collected. If this turns out to be a problem, we could
 288     // do another hack here and do an address range test on caf to figure
 289     // out whether it is from a dynamic library.
 290     ((StgIndStatic *)caf)->saved_info  = (StgInfoTable *)caf->header.info;
 291     ((StgIndStatic *)caf)->static_link = caf_list;
 292     caf_list = caf;
 293   }
 294   else
 295   {
 296     /* Put this CAF on the mutable list for the old generation.
 297     * This is a HACK - the IND_STATIC closure doesn't really have
 298     * a mut_link field, but we pretend it has - in fact we re-use
 299     * the STATIC_LINK field for the time being, because when we
 300     * come to do a major GC we won't need the mut_link field
 301     * any more and can use it as a STATIC_LINK.
 302     */
 303     ((StgIndStatic *)caf)->saved_info = NULL;
 304     recordMutableGen(caf, oldest_gen);
 305   }
 306
 307   RELEASE_SM_LOCK;
 308
 309 #ifdef PAR
 310   /* If we are PAR or DIST then  we never forget a CAF */
 311   { globalAddr *newGA;
 312     //debugBelch("<##> Globalising CAF %08x %s",caf,info_type(caf));
 313     newGA=makeGlobal(caf,rtsTrue); /*given full weight*/
 314     ASSERT(newGA);
 315   }
 316 #endif /* PAR */
 317 }
 318
 319 // An alternate version of newCaf which is used for dynamically loaded
 320 // object code in GHCi.  In this case we want to retain *all* CAFs in
 321 // the object code, because they might be demanded at any time from an
 322 // expression evaluated on the command line.
 323 // Also, GHCi might want to revert CAFs, so we add these to the
 324 // revertible_caf_list.
 325 //
 326 // The linker hackily arranges that references to newCaf from dynamic
 327 // code end up pointing to newDynCAF.
 328 void
 329 newDynCAF(StgClosure *caf)
 330 {
 331     ACQUIRE_SM_LOCK;
 332
 333     ((StgIndStatic *)caf)->saved_info  = (StgInfoTable *)caf->header.info;
 334     ((StgIndStatic *)caf)->static_link = revertible_caf_list;
 335     revertible_caf_list = caf;
 336
 337     RELEASE_SM_LOCK;
 338 }
 339
 340 /* -----------------------------------------------------------------------------
 341    Nursery management.
 342    -------------------------------------------------------------------------- */
 343
 344 void
 345 allocNurseries( void )
 346 {
 347 #ifdef SMP
 348   Capability *cap;
 349
 350   g0s0->blocks = NULL;
 351   g0s0->n_blocks = 0;
 352   for (cap = free_capabilities; cap != NULL; cap = cap->link) {
 353     cap->r.rNursery = allocNursery(NULL, RtsFlags.GcFlags.minAllocAreaSize);
 354     cap->r.rCurrentNursery = cap->r.rNursery;
 355   }
 356 #else /* SMP */
 357   g0s0->blocks      = allocNursery(NULL, RtsFlags.GcFlags.minAllocAreaSize);
 358   g0s0->n_blocks    = RtsFlags.GcFlags.minAllocAreaSize;
 359   g0s0->to_blocks   = NULL;
 360   g0s0->n_to_blocks = 0;
 361   MainCapability.r.rNursery        = g0s0->blocks;
 362   MainCapability.r.rCurrentNursery = g0s0->blocks;
 363   /* hp, hpLim, hp_bd, to_space etc. aren't used in G0S0 */
 364 #endif
 365 }
 366
 367 void
 368 resetNurseries( void )
 369 {
 370   bdescr *bd;
 371   Capability *cap;
 372
 373 #ifdef SMP
 374   /* All tasks must be stopped */
 375   ASSERT(rts_n_free_capabilities == RtsFlags.ParFlags.nNodes);
 376   for (cap = free_capabilities; cap != NULL; cap = cap->link)
 377 #else
 378   cap = &MainCapability;
 379 #endif
 380   {
 381     for (bd = cap->r.rNursery; bd; bd = bd->link) {
 382       bd->free = bd->start;
 383       ASSERT(bd->gen_no == 0);
 384       ASSERT(bd->step == g0s0);
 385       IF_DEBUG(sanity,memset(bd->start, 0xaa, BLOCK_SIZE));
 386     }
 387     cap->r.rCurrentNursery = cap->r.rNursery;
 388   }
 389 }
 390
 391 bdescr *
 392 allocNursery (bdescr *tail, nat blocks)
 393 {
 394   bdescr *bd;
 395   nat i;
 396
 397   // Allocate a nursery: we allocate fresh blocks one at a time and
 398   // cons them on to the front of the list, not forgetting to update
 399   // the back pointer on the tail of the list to point to the new block.
 400   for (i=0; i < blocks; i++) {
 401     // @LDV profiling
 402     /*
 403       processNursery() in LdvProfile.c assumes that every block group in
 404       the nursery contains only a single block. So, if a block group is
 405       given multiple blocks, change processNursery() accordingly.
 406      */
 407     bd = allocBlock();
 408     bd->link = tail;
 409     // double-link the nursery: we might need to insert blocks
 410     if (tail != NULL) {
 411         tail->u.back = bd;
 412     }
 413     bd->step = g0s0;
 414     bd->gen_no = 0;
 415     bd->flags = 0;
 416     bd->free = bd->start;
 417     tail = bd;
 418   }
 419   tail->u.back = NULL;
 420   return tail;
 421 }
 422
 423 void
 424 resizeNursery ( nat blocks )
 425 {
 426   bdescr *bd;
 427   nat nursery_blocks;
 428
 429 #ifdef SMP
 430   barf("resizeNursery: can't resize in SMP mode");
 431 #endif
 432
 433   nursery_blocks = g0s0->n_blocks;
 434   if (nursery_blocks == blocks) {
 435     return;
 436   }
 437
 438   else if (nursery_blocks < blocks) {
 439     IF_DEBUG(gc, debugBelch("Increasing size of nursery to %d blocks\n",
 440                          blocks));
 441     g0s0->blocks = allocNursery(g0s0->blocks, blocks-nursery_blocks);
 442   }
 443
 444   else {
 445     bdescr *next_bd;
 446
 447     IF_DEBUG(gc, debugBelch("Decreasing size of nursery to %d blocks\n",
 448                          blocks));
 449
 450     bd = g0s0->blocks;
 451     while (nursery_blocks > blocks) {
 452         next_bd = bd->link;
 453         next_bd->u.back = NULL;
 454         nursery_blocks -= bd->blocks; // might be a large block
 455         freeGroup(bd);
 456         bd = next_bd;
 457     }
 458     g0s0->blocks = bd;
 459     // might have gone just under, by freeing a large block, so make
 460     // up the difference.
 461     if (nursery_blocks < blocks) {
 462         g0s0->blocks = allocNursery(g0s0->blocks, blocks-nursery_blocks);
 463     }
 464   }
 465
 466   g0s0->n_blocks = blocks;
 467   ASSERT(countBlocks(g0s0->blocks) == g0s0->n_blocks);
 468 }
 469
 470 /* -----------------------------------------------------------------------------
 471    The allocate() interface
 472
 473    allocate(n) always succeeds, and returns a chunk of memory n words
 474    long.  n can be larger than the size of a block if necessary, in
 475    which case a contiguous block group will be allocated.
 476    -------------------------------------------------------------------------- */
 477
 478 StgPtr
 479 allocate( nat n )
 480 {
 481   bdescr *bd;
 482   StgPtr p;
 483
 484   ACQUIRE_SM_LOCK;
 485
 486   TICK_ALLOC_HEAP_NOCTR(n);
 487   CCS_ALLOC(CCCS,n);
 488
 489   /* big allocation (>LARGE_OBJECT_THRESHOLD) */
 490   /* ToDo: allocate directly into generation 1 */
 491   if (n >= LARGE_OBJECT_THRESHOLD/sizeof(W_)) {
 492     nat req_blocks =  (lnat)BLOCK_ROUND_UP(n*sizeof(W_)) / BLOCK_SIZE;
 493     bd = allocGroup(req_blocks);
 494     dbl_link_onto(bd, &g0s0->large_objects);
 495     g0s0->n_large_blocks += req_blocks;
 496     bd->gen_no  = 0;
 497     bd->step = g0s0;
 498     bd->flags = BF_LARGE;
 499     bd->free = bd->start + n;
 500     alloc_blocks += req_blocks;
 501     RELEASE_SM_LOCK;
 502     return bd->start;
 503
 504   /* small allocation (<LARGE_OBJECT_THRESHOLD) */
 505   } else if (small_alloc_list == NULL || alloc_Hp + n > alloc_HpLim) {
 506     if (small_alloc_list) {
 507       small_alloc_list->free = alloc_Hp;
 508     }
 509     bd = allocBlock();
 510     bd->link = small_alloc_list;
 511     small_alloc_list = bd;
 512     bd->gen_no = 0;
 513     bd->step = g0s0;
 514     bd->flags = 0;
 515     alloc_Hp = bd->start;
 516     alloc_HpLim = bd->start + BLOCK_SIZE_W;
 517     alloc_blocks++;
 518   }
 519
 520   p = alloc_Hp;
 521   alloc_Hp += n;
 522   RELEASE_SM_LOCK;
 523   return p;
 524 }
 525
 526 lnat
 527 allocated_bytes( void )
 528 {
 529     lnat allocated;
 530
 531     allocated = alloc_blocks * BLOCK_SIZE_W - (alloc_HpLim - alloc_Hp);
 532     if (pinned_object_block != NULL) {
 533         allocated -= (pinned_object_block->start + BLOCK_SIZE_W) -
 534             pinned_object_block->free;
 535     }
 536
 537     return allocated;
 538 }
 539
 540 void
 541 tidyAllocateLists (void)
 542 {
 543     if (small_alloc_list != NULL) {
 544         ASSERT(alloc_Hp >= small_alloc_list->start &&
 545                alloc_Hp <= small_alloc_list->start + BLOCK_SIZE);
 546         small_alloc_list->free = alloc_Hp;
 547     }
 548 }
 549
 550 /* ---------------------------------------------------------------------------
 551    Allocate a fixed/pinned object.
 552
 553    We allocate small pinned objects into a single block, allocating a
 554    new block when the current one overflows.  The block is chained
 555    onto the large_object_list of generation 0 step 0.
 556
 557    NOTE: The GC can't in general handle pinned objects.  This
 558    interface is only safe to use for ByteArrays, which have no
 559    pointers and don't require scavenging.  It works because the
 560    block's descriptor has the BF_LARGE flag set, so the block is
 561    treated as a large object and chained onto various lists, rather
 562    than the individual objects being copied.  However, when it comes
 563    to scavenge the block, the GC will only scavenge the first object.
 564    The reason is that the GC can't linearly scan a block of pinned
 565    objects at the moment (doing so would require using the
 566    mostly-copying techniques).  But since we're restricting ourselves
 567    to pinned ByteArrays, not scavenging is ok.
 568
 569    This function is called by newPinnedByteArray# which immediately
 570    fills the allocated memory with a MutableByteArray#.
 571    ------------------------------------------------------------------------- */
 572
 573 StgPtr
 574 allocatePinned( nat n )
 575 {
 576     StgPtr p;
 577     bdescr *bd = pinned_object_block;
 578
 579     // If the request is for a large object, then allocate()
 580     // will give us a pinned object anyway.
 581     if (n >= LARGE_OBJECT_THRESHOLD/sizeof(W_)) {
 582         return allocate(n);
 583     }
 584
 585     ACQUIRE_SM_LOCK;
 586
 587     TICK_ALLOC_HEAP_NOCTR(n);
 588     CCS_ALLOC(CCCS,n);
 589
 590     // we always return 8-byte aligned memory.  bd->free must be
 591     // 8-byte aligned to begin with, so we just round up n to
 592     // the nearest multiple of 8 bytes.
 593     if (sizeof(StgWord) == 4) {
 594         n = (n+1) & ~1;
 595     }
 596
 597     // If we don't have a block of pinned objects yet, or the current
 598     // one isn't large enough to hold the new object, allocate a new one.
 599     if (bd == NULL || (bd->free + n) > (bd->start + BLOCK_SIZE_W)) {
 600         pinned_object_block = bd = allocBlock();
 601         dbl_link_onto(bd, &g0s0->large_objects);
 602         bd->gen_no = 0;
 603         bd->step   = g0s0;
 604         bd->flags  = BF_PINNED | BF_LARGE;
 605         bd->free   = bd->start;
 606         alloc_blocks++;
 607     }
 608
 609     p = bd->free;
 610     bd->free += n;
 611     RELEASE_SM_LOCK;
 612     return p;
 613 }
 614
 615 /* -----------------------------------------------------------------------------
 616    Allocation functions for GMP.
 617
 618    These all use the allocate() interface - we can't have any garbage
 619    collection going on during a gmp operation, so we use allocate()
 620    which always succeeds.  The gmp operations which might need to
 621    allocate will ask the storage manager (via doYouWantToGC()) whether
 622    a garbage collection is required, in case we get into a loop doing
 623    only allocate() style allocation.
 624    -------------------------------------------------------------------------- */
 625
 626 static void *
 627 stgAllocForGMP (size_t size_in_bytes)
 628 {
 629   StgArrWords* arr;
 630   nat data_size_in_words, total_size_in_words;
 631
 632   /* round up to a whole number of words */
 633   data_size_in_words  = (size_in_bytes + sizeof(W_) + 1) / sizeof(W_);
 634   total_size_in_words = sizeofW(StgArrWords) + data_size_in_words;
 635
 636   /* allocate and fill it in. */
 637   arr = (StgArrWords *)allocate(total_size_in_words);
 638   SET_ARR_HDR(arr, &stg_ARR_WORDS_info, CCCS, data_size_in_words);
 639
 640   /* and return a ptr to the goods inside the array */
 641   return arr->payload;
 642 }
 643
 644 static void *
 645 stgReallocForGMP (void *ptr, size_t old_size, size_t new_size)
 646 {
 647     void *new_stuff_ptr = stgAllocForGMP(new_size);
 648     nat i = 0;
 649     char *p = (char *) ptr;
 650     char *q = (char *) new_stuff_ptr;
 651
 652     for (; i < old_size; i++, p++, q++) {
 653         *q = *p;
 654     }
 655
 656     return(new_stuff_ptr);
 657 }
 658
 659 static void
 660 stgDeallocForGMP (void *ptr STG_UNUSED,
 661                   size_t size STG_UNUSED)
 662 {
 663     /* easy for us: the garbage collector does the dealloc'n */
 664 }
 665
 666 /* -----------------------------------------------------------------------------
 667  * Stats and stuff
 668  * -------------------------------------------------------------------------- */
 669
 670 /* -----------------------------------------------------------------------------
 671  * calcAllocated()
 672  *
 673  * Approximate how much we've allocated: number of blocks in the
 674  * nursery + blocks allocated via allocate() - unused nusery blocks.
 675  * This leaves a little slop at the end of each block, and doesn't
 676  * take into account large objects (ToDo).
 677  * -------------------------------------------------------------------------- */
 678
 679 lnat
 680 calcAllocated( void )
 681 {
 682   nat allocated;
 683   bdescr *bd;
 684
 685 #ifdef SMP
 686   Capability *cap;
 687
 688   /* All tasks must be stopped.  Can't assert that all the
 689      capabilities are owned by the scheduler, though: one or more
 690      tasks might have been stopped while they were running (non-main)
 691      threads. */
 692   /*  ASSERT(n_free_capabilities == RtsFlags.ParFlags.nNodes); */
 693
 694   allocated =
 695     rts_n_free_capabilities * RtsFlags.GcFlags.minAllocAreaSize * BLOCK_SIZE_W
 696     + allocated_bytes();
 697
 698   for (cap = free_capabilities; cap != NULL; cap = cap->link) {
 699     for ( bd = cap->r.rCurrentNursery->link; bd != NULL; bd = bd->link ) {
 700       allocated -= BLOCK_SIZE_W;
 701     }
 702     if (cap->r.rCurrentNursery->free < cap->r.rCurrentNursery->start
 703         + BLOCK_SIZE_W) {
 704       allocated -= (cap->r.rCurrentNursery->start + BLOCK_SIZE_W)
 705         - cap->r.rCurrentNursery->free;
 706     }
 707   }
 708
 709 #else /* !SMP */
 710   bdescr *current_nursery = MainCapability.r.rCurrentNursery;
 711
 712   allocated = (g0s0->n_blocks * BLOCK_SIZE_W) + allocated_bytes();
 713   for ( bd = current_nursery->link; bd != NULL; bd = bd->link ) {
 714     allocated -= BLOCK_SIZE_W;
 715   }
 716   if (current_nursery->free < current_nursery->start + BLOCK_SIZE_W) {
 717     allocated -= (current_nursery->start + BLOCK_SIZE_W)
 718       - current_nursery->free;
 719   }
 720 #endif
 721
 722   total_allocated += allocated;
 723   return allocated;
 724 }
 725
 726 /* Approximate the amount of live data in the heap.  To be called just
 727  * after garbage collection (see GarbageCollect()).
 728  */
 729 extern lnat
 730 calcLive(void)
 731 {
 732   nat g, s;
 733   lnat live = 0;
 734   step *stp;
 735
 736   if (RtsFlags.GcFlags.generations == 1) {
 737     live = (g0s0->n_to_blocks - 1) * BLOCK_SIZE_W +
 738       ((lnat)g0s0->hp_bd->free - (lnat)g0s0->hp_bd->start) / sizeof(W_);
 739     return live;
 740   }
 741
 742   for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
 743     for (s = 0; s < generations[g].n_steps; s++) {
 744       /* approximate amount of live data (doesn't take into account slop
 745        * at end of each block).
 746        */
 747       if (g == 0 && s == 0) {
 748           continue;
 749       }
 750       stp = &generations[g].steps[s];
 751       live += (stp->n_large_blocks + stp->n_blocks - 1) * BLOCK_SIZE_W;
 752       if (stp->hp_bd != NULL) {
 753           live += ((lnat)stp->hp_bd->free - (lnat)stp->hp_bd->start)
 754               / sizeof(W_);
 755       }
 756     }
 757   }
 758   return live;
 759 }
 760
 761 /* Approximate the number of blocks that will be needed at the next
 762  * garbage collection.
 763  *
 764  * Assume: all data currently live will remain live.  Steps that will
 765  * be collected next time will therefore need twice as many blocks
 766  * since all the data will be copied.
 767  */
 768 extern lnat
 769 calcNeeded(void)
 770 {
 771     lnat needed = 0;
 772     nat g, s;
 773     step *stp;
 774
 775     for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
 776         for (s = 0; s < generations[g].n_steps; s++) {
 777             if (g == 0 && s == 0) { continue; }
 778             stp = &generations[g].steps[s];
 779             if (generations[g].steps[0].n_blocks +
 780                 generations[g].steps[0].n_large_blocks
 781                 > generations[g].max_blocks
 782                 && stp->is_compacted == 0) {
 783                 needed += 2 * stp->n_blocks;
 784             } else {
 785                 needed += stp->n_blocks;
 786             }
 787         }
 788     }
 789     return needed;
 790 }
 791
 792 /* -----------------------------------------------------------------------------
 793    Debugging
 794
 795    memInventory() checks for memory leaks by counting up all the
 796    blocks we know about and comparing that to the number of blocks
 797    allegedly floating around in the system.
 798    -------------------------------------------------------------------------- */
 799
 800 #ifdef DEBUG
 801
 802 void
 803 memInventory(void)
 804 {
 805   nat g, s;
 806   step *stp;
 807   bdescr *bd;
 808   lnat total_blocks = 0, free_blocks = 0;
 809
 810   /* count the blocks we current have */
 811
 812   for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
 813       for (bd = generations[g].mut_list; bd != NULL; bd = bd->link) {
 814           total_blocks += bd->blocks;
 815       }
 816       for (s = 0; s < generations[g].n_steps; s++) {
 817           stp = &generations[g].steps[s];
 818           total_blocks += stp->n_blocks;
 819           if (RtsFlags.GcFlags.generations == 1) {
 820               /* two-space collector has a to-space too :-) */
 821               total_blocks += g0s0->n_to_blocks;
 822           }
 823           for (bd = stp->large_objects; bd; bd = bd->link) {
 824               total_blocks += bd->blocks;
 825               /* hack for megablock groups: they have an extra block or two in
 826                  the second and subsequent megablocks where the block
 827                  descriptors would normally go.
 828               */
 829               if (bd->blocks > BLOCKS_PER_MBLOCK) {
 830                   total_blocks -= (MBLOCK_SIZE / BLOCK_SIZE - BLOCKS_PER_MBLOCK)
 831                       * (bd->blocks/(MBLOCK_SIZE/BLOCK_SIZE));
 832               }
 833           }
 834       }
 835   }
 836
 837   /* any blocks held by allocate() */
 838   for (bd = small_alloc_list; bd; bd = bd->link) {
 839     total_blocks += bd->blocks;
 840   }
 841
 842 #ifdef PROFILING
 843   if (RtsFlags.ProfFlags.doHeapProfile == HEAP_BY_RETAINER) {
 844       total_blocks += retainerStackBlocks();
 845   }
 846 #endif
 847
 848   // count the blocks allocated by the arena allocator
 849   total_blocks += arenaBlocks();
 850
 851   /* count the blocks on the free list */
 852   free_blocks = countFreeList();
 853
 854   if (total_blocks + free_blocks != mblocks_allocated *
 855       BLOCKS_PER_MBLOCK) {
 856     debugBelch("Blocks: %ld live + %ld free  = %ld total (%ld around)\n",
 857             total_blocks, free_blocks, total_blocks + free_blocks,
 858             mblocks_allocated * BLOCKS_PER_MBLOCK);
 859   }
 860
 861   ASSERT(total_blocks + free_blocks == mblocks_allocated * BLOCKS_PER_MBLOCK);
 862 }
 863
 864
 865 nat
 866 countBlocks(bdescr *bd)
 867 {
 868     nat n;
 869     for (n=0; bd != NULL; bd=bd->link) {
 870         n += bd->blocks;
 871     }
 872     return n;
 873 }
 874
 875 /* Full heap sanity check. */
 876 void
 877 checkSanity( void )
 878 {
 879     nat g, s;
 880
 881     if (RtsFlags.GcFlags.generations == 1) {
 882         checkHeap(g0s0->to_blocks);
 883         checkChain(g0s0->large_objects);
 884     } else {
 885
 886         for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
 887             for (s = 0; s < generations[g].n_steps; s++) {
 888                 ASSERT(countBlocks(generations[g].steps[s].blocks)
 889                        == generations[g].steps[s].n_blocks);
 890                 ASSERT(countBlocks(generations[g].steps[s].large_objects)
 891                        == generations[g].steps[s].n_large_blocks);
 892                 if (g == 0 && s == 0) { continue; }
 893                 checkHeap(generations[g].steps[s].blocks);
 894                 checkChain(generations[g].steps[s].large_objects);
 895                 if (g > 0) {
 896                     checkMutableList(generations[g].mut_list, g);
 897                 }
 898             }
 899         }
 900         checkFreeListSanity();
 901     }
 902 }
 903
 904 // handy function for use in gdb, because Bdescr() is inlined.
 905 extern bdescr *_bdescr( StgPtr p );
 906
 907 bdescr *
 908 _bdescr( StgPtr p )
 909 {
 910     return Bdescr(p);
 911 }
 912
 913 #endif