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