rts/sm/Storage.c

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2006
   4  *
   5  * Storage manager front end
   6  *
   7  * Documentation on the architecture of the Storage Manager can be
   8  * found in the online commentary:
   9  *
  10  *   http://hackage.haskell.org/trac/ghc/wiki/Commentary/Rts/Storage
  11  *
  12  * ---------------------------------------------------------------------------*/
  13
  14 #include "PosixSource.h"
  15 #include "Rts.h"
  16 #include "RtsUtils.h"
  17 #include "RtsFlags.h"
  18 #include "Stats.h"
  19 #include "Hooks.h"
  20 #include "BlockAlloc.h"
  21 #include "MBlock.h"
  22 #include "Weak.h"
  23 #include "Sanity.h"
  24 #include "Arena.h"
  25 #include "OSThreads.h"
  26 #include "Capability.h"
  27 #include "Storage.h"
  28 #include "Schedule.h"
  29 #include "RetainerProfile.h"    // for counting memory blocks (memInventory)
  30 #include "OSMem.h"
  31 #include "Trace.h"
  32
  33 #include <stdlib.h>
  34 #include <string.h>
  35
  36 /*
  37  * All these globals require sm_mutex to access in THREADED_RTS mode.
  38  */
  39 StgClosure    *caf_list         = NULL;
  40 StgClosure    *revertible_caf_list = NULL;
  41 rtsBool       keepCAFs;
  42
  43 bdescr *pinned_object_block;    /* allocate pinned objects into this block */
  44 nat alloc_blocks;               /* number of allocate()d blocks since GC */
  45 nat alloc_blocks_lim;           /* approximate limit on alloc_blocks */
  46
  47 generation *generations = NULL; /* all the generations */
  48 generation *g0          = NULL; /* generation 0, for convenience */
  49 generation *oldest_gen  = NULL; /* oldest generation, for convenience */
  50 step *g0s0              = NULL; /* generation 0, step 0, for convenience */
  51
  52 ullong total_allocated = 0;     /* total memory allocated during run */
  53
  54 nat n_nurseries         = 0;    /* == RtsFlags.ParFlags.nNodes, convenience */
  55 step *nurseries         = NULL; /* array of nurseries, >1 only if THREADED_RTS */
  56
  57 #ifdef THREADED_RTS
  58 /*
  59  * Storage manager mutex:  protects all the above state from
  60  * simultaneous access by two STG threads.
  61  */
  62 Mutex sm_mutex;
  63 /*
  64  * This mutex is used by atomicModifyMutVar# only
  65  */
  66 Mutex atomic_modify_mutvar_mutex;
  67 #endif
  68
  69
  70 /*
  71  * Forward references
  72  */
  73 static void *stgAllocForGMP   (size_t size_in_bytes);
  74 static void *stgReallocForGMP (void *ptr, size_t old_size, size_t new_size);
  75 static void  stgDeallocForGMP (void *ptr, size_t size);
  76
  77 static void
  78 initStep (step *stp, int g, int s)
  79 {
  80     stp->no = s;
  81     stp->blocks = NULL;
  82     stp->n_blocks = 0;
  83     stp->old_blocks = NULL;
  84     stp->n_old_blocks = 0;
  85     stp->gen = &generations[g];
  86     stp->gen_no = g;
  87     stp->hp = NULL;
  88     stp->hpLim = NULL;
  89     stp->hp_bd = NULL;
  90     stp->scavd_hp = NULL;
  91     stp->scavd_hpLim = NULL;
  92     stp->scan = NULL;
  93     stp->scan_bd = NULL;
  94     stp->large_objects = NULL;
  95     stp->n_large_blocks = 0;
  96     stp->new_large_objects = NULL;
  97     stp->scavenged_large_objects = NULL;
  98     stp->n_scavenged_large_blocks = 0;
  99     stp->is_compacted = 0;
 100     stp->bitmap = NULL;
 101 }
 102
 103 void
 104 initStorage( void )
 105 {
 106   nat g, s;
 107   generation *gen;
 108
 109   if (generations != NULL) {
 110       // multi-init protection
 111       return;
 112   }
 113
 114   initMBlocks();
 115
 116   /* Sanity check to make sure the LOOKS_LIKE_ macros appear to be
 117    * doing something reasonable.
 118    */
 119   ASSERT(LOOKS_LIKE_INFO_PTR(&stg_BLACKHOLE_info));
 120   ASSERT(LOOKS_LIKE_CLOSURE_PTR(&stg_dummy_ret_closure));
 121   ASSERT(!HEAP_ALLOCED(&stg_dummy_ret_closure));
 122
 123   if (RtsFlags.GcFlags.maxHeapSize != 0 &&
 124       RtsFlags.GcFlags.heapSizeSuggestion >
 125       RtsFlags.GcFlags.maxHeapSize) {
 126     RtsFlags.GcFlags.maxHeapSize = RtsFlags.GcFlags.heapSizeSuggestion;
 127   }
 128
 129   if (RtsFlags.GcFlags.maxHeapSize != 0 &&
 130       RtsFlags.GcFlags.minAllocAreaSize >
 131       RtsFlags.GcFlags.maxHeapSize) {
 132       errorBelch("maximum heap size (-M) is smaller than minimum alloc area size (-A)");
 133       RtsFlags.GcFlags.minAllocAreaSize = RtsFlags.GcFlags.maxHeapSize;
 134   }
 135
 136   initBlockAllocator();
 137
 138 #if defined(THREADED_RTS)
 139   initMutex(&sm_mutex);
 140   initMutex(&atomic_modify_mutvar_mutex);
 141 #endif
 142
 143   ACQUIRE_SM_LOCK;
 144
 145   /* allocate generation info array */
 146   generations = (generation *)stgMallocBytes(RtsFlags.GcFlags.generations
 147                                              * sizeof(struct generation_),
 148                                              "initStorage: gens");
 149
 150   /* Initialise all generations */
 151   for(g = 0; g < RtsFlags.GcFlags.generations; g++) {
 152     gen = &generations[g];
 153     gen->no = g;
 154     gen->mut_list = allocBlock();
 155     gen->collections = 0;
 156     gen->failed_promotions = 0;
 157     gen->max_blocks = 0;
 158   }
 159
 160   /* A couple of convenience pointers */
 161   g0 = &generations[0];
 162   oldest_gen = &generations[RtsFlags.GcFlags.generations-1];
 163
 164   /* Allocate step structures in each generation */
 165   if (RtsFlags.GcFlags.generations > 1) {
 166     /* Only for multiple-generations */
 167
 168     /* Oldest generation: one step */
 169     oldest_gen->n_steps = 1;
 170     oldest_gen->steps =
 171       stgMallocBytes(1 * sizeof(struct step_), "initStorage: last step");
 172
 173     /* set up all except the oldest generation with 2 steps */
 174     for(g = 0; g < RtsFlags.GcFlags.generations-1; g++) {
 175       generations[g].n_steps = RtsFlags.GcFlags.steps;
 176       generations[g].steps  =
 177         stgMallocBytes (RtsFlags.GcFlags.steps * sizeof(struct step_),
 178                         "initStorage: steps");
 179     }
 180
 181   } else {
 182     /* single generation, i.e. a two-space collector */
 183     g0->n_steps = 1;
 184     g0->steps = stgMallocBytes (sizeof(struct step_), "initStorage: steps");
 185   }
 186
 187 #ifdef THREADED_RTS
 188   n_nurseries = n_capabilities;
 189 #else
 190   n_nurseries = 1;
 191 #endif
 192   nurseries = stgMallocBytes (n_nurseries * sizeof(struct step_),
 193                               "initStorage: nurseries");
 194
 195   /* Initialise all steps */
 196   for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
 197     for (s = 0; s < generations[g].n_steps; s++) {
 198         initStep(&generations[g].steps[s], g, s);
 199     }
 200   }
 201
 202   for (s = 0; s < n_nurseries; s++) {
 203       initStep(&nurseries[s], 0, s);
 204   }
 205
 206   /* Set up the destination pointers in each younger gen. step */
 207   for (g = 0; g < RtsFlags.GcFlags.generations-1; g++) {
 208     for (s = 0; s < generations[g].n_steps-1; s++) {
 209       generations[g].steps[s].to = &generations[g].steps[s+1];
 210     }
 211     generations[g].steps[s].to = &generations[g+1].steps[0];
 212   }
 213   oldest_gen->steps[0].to = &oldest_gen->steps[0];
 214
 215   for (s = 0; s < n_nurseries; s++) {
 216       nurseries[s].to = generations[0].steps[0].to;
 217   }
 218
 219   /* The oldest generation has one step. */
 220   if (RtsFlags.GcFlags.compact) {
 221       if (RtsFlags.GcFlags.generations == 1) {
 222           errorBelch("WARNING: compaction is incompatible with -G1; disabled");
 223       } else {
 224           oldest_gen->steps[0].is_compacted = 1;
 225       }
 226   }
 227
 228   generations[0].max_blocks = 0;
 229   g0s0 = &generations[0].steps[0];
 230
 231   /* The allocation area.  Policy: keep the allocation area
 232    * small to begin with, even if we have a large suggested heap
 233    * size.  Reason: we're going to do a major collection first, and we
 234    * don't want it to be a big one.  This vague idea is borne out by
 235    * rigorous experimental evidence.
 236    */
 237   allocNurseries();
 238
 239   weak_ptr_list = NULL;
 240   caf_list = NULL;
 241   revertible_caf_list = NULL;
 242
 243   /* initialise the allocate() interface */
 244   alloc_blocks = 0;
 245   alloc_blocks_lim = RtsFlags.GcFlags.minAllocAreaSize;
 246
 247   /* Tell GNU multi-precision pkg about our custom alloc functions */
 248   mp_set_memory_functions(stgAllocForGMP, stgReallocForGMP, stgDeallocForGMP);
 249
 250   IF_DEBUG(gc, statDescribeGens());
 251
 252   RELEASE_SM_LOCK;
 253 }
 254
 255 void
 256 exitStorage (void)
 257 {
 258     stat_exit(calcAllocated());
 259 }
 260
 261 void
 262 freeStorage (void)
 263 {
 264     nat g;
 265
 266     for(g = 0; g < RtsFlags.GcFlags.generations; g++)
 267       stgFree(generations[g].steps);
 268     stgFree(generations);
 269     freeAllMBlocks();
 270 #if defined(THREADED_RTS)
 271     closeMutex(&sm_mutex);
 272     closeMutex(&atomic_modify_mutvar_mutex);
 273 #endif
 274     stgFree(nurseries);
 275 }
 276
 277 /* -----------------------------------------------------------------------------
 278    CAF management.
 279
 280    The entry code for every CAF does the following:
 281
 282       - builds a CAF_BLACKHOLE in the heap
 283       - pushes an update frame pointing to the CAF_BLACKHOLE
 284       - invokes UPD_CAF(), which:
 285           - calls newCaf, below
 286           - updates the CAF with a static indirection to the CAF_BLACKHOLE
 287
 288    Why do we build a BLACKHOLE in the heap rather than just updating
 289    the thunk directly?  It's so that we only need one kind of update
 290    frame - otherwise we'd need a static version of the update frame too.
 291
 292    newCaf() does the following:
 293
 294       - it puts the CAF on the oldest generation's mut-once list.
 295         This is so that we can treat the CAF as a root when collecting
 296         younger generations.
 297
 298    For GHCI, we have additional requirements when dealing with CAFs:
 299
 300       - we must *retain* all dynamically-loaded CAFs ever entered,
 301         just in case we need them again.
 302       - we must be able to *revert* CAFs that have been evaluated, to
 303         their pre-evaluated form.
 304
 305       To do this, we use an additional CAF list.  When newCaf() is
 306       called on a dynamically-loaded CAF, we add it to the CAF list
 307       instead of the old-generation mutable list, and save away its
 308       old info pointer (in caf->saved_info) for later reversion.
 309
 310       To revert all the CAFs, we traverse the CAF list and reset the
 311       info pointer to caf->saved_info, then throw away the CAF list.
 312       (see GC.c:revertCAFs()).
 313
 314       -- SDM 29/1/01
 315
 316    -------------------------------------------------------------------------- */
 317
 318 void
 319 newCAF(StgClosure* caf)
 320 {
 321   ACQUIRE_SM_LOCK;
 322
 323   if(keepCAFs)
 324   {
 325     // HACK:
 326     // If we are in GHCi _and_ we are using dynamic libraries,
 327     // then we can't redirect newCAF calls to newDynCAF (see below),
 328     // so we make newCAF behave almost like newDynCAF.
 329     // The dynamic libraries might be used by both the interpreted
 330     // program and GHCi itself, so they must not be reverted.
 331     // This also means that in GHCi with dynamic libraries, CAFs are not
 332     // garbage collected. If this turns out to be a problem, we could
 333     // do another hack here and do an address range test on caf to figure
 334     // out whether it is from a dynamic library.
 335     ((StgIndStatic *)caf)->saved_info  = (StgInfoTable *)caf->header.info;
 336     ((StgIndStatic *)caf)->static_link = caf_list;
 337     caf_list = caf;
 338   }
 339   else
 340   {
 341     /* Put this CAF on the mutable list for the old generation.
 342     * This is a HACK - the IND_STATIC closure doesn't really have
 343     * a mut_link field, but we pretend it has - in fact we re-use
 344     * the STATIC_LINK field for the time being, because when we
 345     * come to do a major GC we won't need the mut_link field
 346     * any more and can use it as a STATIC_LINK.
 347     */
 348     ((StgIndStatic *)caf)->saved_info = NULL;
 349     recordMutableGen(caf, oldest_gen);
 350   }
 351
 352   RELEASE_SM_LOCK;
 353 }
 354
 355 // An alternate version of newCaf which is used for dynamically loaded
 356 // object code in GHCi.  In this case we want to retain *all* CAFs in
 357 // the object code, because they might be demanded at any time from an
 358 // expression evaluated on the command line.
 359 // Also, GHCi might want to revert CAFs, so we add these to the
 360 // revertible_caf_list.
 361 //
 362 // The linker hackily arranges that references to newCaf from dynamic
 363 // code end up pointing to newDynCAF.
 364 void
 365 newDynCAF(StgClosure *caf)
 366 {
 367     ACQUIRE_SM_LOCK;
 368
 369     ((StgIndStatic *)caf)->saved_info  = (StgInfoTable *)caf->header.info;
 370     ((StgIndStatic *)caf)->static_link = revertible_caf_list;
 371     revertible_caf_list = caf;
 372
 373     RELEASE_SM_LOCK;
 374 }
 375
 376 /* -----------------------------------------------------------------------------
 377    Nursery management.
 378    -------------------------------------------------------------------------- */
 379
 380 static bdescr *
 381 allocNursery (step *stp, bdescr *tail, nat blocks)
 382 {
 383     bdescr *bd;
 384     nat i;
 385
 386     // Allocate a nursery: we allocate fresh blocks one at a time and
 387     // cons them on to the front of the list, not forgetting to update
 388     // the back pointer on the tail of the list to point to the new block.
 389     for (i=0; i < blocks; i++) {
 390         // @LDV profiling
 391         /*
 392           processNursery() in LdvProfile.c assumes that every block group in
 393           the nursery contains only a single block. So, if a block group is
 394           given multiple blocks, change processNursery() accordingly.
 395         */
 396         bd = allocBlock();
 397         bd->link = tail;
 398         // double-link the nursery: we might need to insert blocks
 399         if (tail != NULL) {
 400             tail->u.back = bd;
 401         }
 402         bd->step = stp;
 403         bd->gen_no = 0;
 404         bd->flags = 0;
 405         bd->free = bd->start;
 406         tail = bd;
 407     }
 408     tail->u.back = NULL;
 409     return tail;
 410 }
 411
 412 static void
 413 assignNurseriesToCapabilities (void)
 414 {
 415 #ifdef THREADED_RTS
 416     nat i;
 417
 418     for (i = 0; i < n_nurseries; i++) {
 419         capabilities[i].r.rNursery        = &nurseries[i];
 420         capabilities[i].r.rCurrentNursery = nurseries[i].blocks;
 421         capabilities[i].r.rCurrentAlloc   = NULL;
 422     }
 423 #else /* THREADED_RTS */
 424     MainCapability.r.rNursery        = &nurseries[0];
 425     MainCapability.r.rCurrentNursery = nurseries[0].blocks;
 426     MainCapability.r.rCurrentAlloc   = NULL;
 427 #endif
 428 }
 429
 430 void
 431 allocNurseries( void )
 432 {
 433     nat i;
 434
 435     for (i = 0; i < n_nurseries; i++) {
 436         nurseries[i].blocks =
 437             allocNursery(&nurseries[i], NULL,
 438                          RtsFlags.GcFlags.minAllocAreaSize);
 439         nurseries[i].n_blocks    = RtsFlags.GcFlags.minAllocAreaSize;
 440         nurseries[i].old_blocks   = NULL;
 441         nurseries[i].n_old_blocks = 0;
 442     }
 443     assignNurseriesToCapabilities();
 444 }
 445
 446 void
 447 resetNurseries( void )
 448 {
 449     nat i;
 450     bdescr *bd;
 451     step *stp;
 452
 453     for (i = 0; i < n_nurseries; i++) {
 454         stp = &nurseries[i];
 455         for (bd = stp->blocks; bd; bd = bd->link) {
 456             bd->free = bd->start;
 457             ASSERT(bd->gen_no == 0);
 458             ASSERT(bd->step == stp);
 459             IF_DEBUG(sanity,memset(bd->start, 0xaa, BLOCK_SIZE));
 460         }
 461     }
 462     assignNurseriesToCapabilities();
 463 }
 464
 465 lnat
 466 countNurseryBlocks (void)
 467 {
 468     nat i;
 469     lnat blocks = 0;
 470
 471     for (i = 0; i < n_nurseries; i++) {
 472         blocks += nurseries[i].n_blocks;
 473     }
 474     return blocks;
 475 }
 476
 477 static void
 478 resizeNursery ( step *stp, nat blocks )
 479 {
 480   bdescr *bd;
 481   nat nursery_blocks;
 482
 483   nursery_blocks = stp->n_blocks;
 484   if (nursery_blocks == blocks) return;
 485
 486   if (nursery_blocks < blocks) {
 487       debugTrace(DEBUG_gc, "increasing size of nursery to %d blocks",
 488                  blocks);
 489     stp->blocks = allocNursery(stp, stp->blocks, blocks-nursery_blocks);
 490   }
 491   else {
 492     bdescr *next_bd;
 493
 494     debugTrace(DEBUG_gc, "decreasing size of nursery to %d blocks",
 495                blocks);
 496
 497     bd = stp->blocks;
 498     while (nursery_blocks > blocks) {
 499         next_bd = bd->link;
 500         next_bd->u.back = NULL;
 501         nursery_blocks -= bd->blocks; // might be a large block
 502         freeGroup(bd);
 503         bd = next_bd;
 504     }
 505     stp->blocks = bd;
 506     // might have gone just under, by freeing a large block, so make
 507     // up the difference.
 508     if (nursery_blocks < blocks) {
 509         stp->blocks = allocNursery(stp, stp->blocks, blocks-nursery_blocks);
 510     }
 511   }
 512
 513   stp->n_blocks = blocks;
 514   ASSERT(countBlocks(stp->blocks) == stp->n_blocks);
 515 }
 516
 517 //
 518 // Resize each of the nurseries to the specified size.
 519 //
 520 void
 521 resizeNurseriesFixed (nat blocks)
 522 {
 523     nat i;
 524     for (i = 0; i < n_nurseries; i++) {
 525         resizeNursery(&nurseries[i], blocks);
 526     }
 527 }
 528
 529 //
 530 // Resize the nurseries to the total specified size.
 531 //
 532 void
 533 resizeNurseries (nat blocks)
 534 {
 535     // If there are multiple nurseries, then we just divide the number
 536     // of available blocks between them.
 537     resizeNurseriesFixed(blocks / n_nurseries);
 538 }
 539
 540 /* -----------------------------------------------------------------------------
 541    The allocate() interface
 542
 543    allocateInGen() function allocates memory directly into a specific
 544    generation.  It always succeeds, and returns a chunk of memory n
 545    words long.  n can be larger than the size of a block if necessary,
 546    in which case a contiguous block group will be allocated.
 547
 548    allocate(n) is equivalent to allocateInGen(g0).
 549    -------------------------------------------------------------------------- */
 550
 551 StgPtr
 552 allocateInGen (generation *g, nat n)
 553 {
 554     step *stp;
 555     bdescr *bd;
 556     StgPtr ret;
 557
 558     ACQUIRE_SM_LOCK;
 559
 560     TICK_ALLOC_HEAP_NOCTR(n);
 561     CCS_ALLOC(CCCS,n);
 562
 563     stp = &g->steps[0];
 564
 565     if (n >= LARGE_OBJECT_THRESHOLD/sizeof(W_))
 566     {
 567         nat req_blocks =  (lnat)BLOCK_ROUND_UP(n*sizeof(W_)) / BLOCK_SIZE;
 568         bd = allocGroup(req_blocks);
 569         dbl_link_onto(bd, &stp->large_objects);
 570         stp->n_large_blocks += bd->blocks; // might be larger than req_blocks
 571         bd->gen_no  = g->no;
 572         bd->step = stp;
 573         bd->flags = BF_LARGE;
 574         bd->free = bd->start + n;
 575         ret = bd->start;
 576     }
 577     else
 578     {
 579         // small allocation (<LARGE_OBJECT_THRESHOLD) */
 580         bd = stp->blocks;
 581         if (bd == NULL || bd->free + n > bd->start + BLOCK_SIZE_W) {
 582             bd = allocBlock();
 583             bd->gen_no = g->no;
 584             bd->step = stp;
 585             bd->flags = 0;
 586             bd->link = stp->blocks;
 587             stp->blocks = bd;
 588             stp->n_blocks++;
 589             alloc_blocks++;
 590         }
 591         ret = bd->free;
 592         bd->free += n;
 593     }
 594
 595     RELEASE_SM_LOCK;
 596
 597     return ret;
 598 }
 599
 600 StgPtr
 601 allocate (nat n)
 602 {
 603     return allocateInGen(g0,n);
 604 }
 605
 606 lnat
 607 allocatedBytes( void )
 608 {
 609     lnat allocated;
 610
 611     allocated = alloc_blocks * BLOCK_SIZE_W;
 612     if (pinned_object_block != NULL) {
 613         allocated -= (pinned_object_block->start + BLOCK_SIZE_W) -
 614             pinned_object_block->free;
 615     }
 616
 617     return allocated;
 618 }
 619
 620 /* -----------------------------------------------------------------------------
 621    allocateLocal()
 622
 623    This allocates memory in the current thread - it is intended for
 624    use primarily from STG-land where we have a Capability.  It is
 625    better than allocate() because it doesn't require taking the
 626    sm_mutex lock in the common case.
 627
 628    Memory is allocated directly from the nursery if possible (but not
 629    from the current nursery block, so as not to interfere with
 630    Hp/HpLim).
 631    -------------------------------------------------------------------------- */
 632
 633 StgPtr
 634 allocateLocal (Capability *cap, nat n)
 635 {
 636     bdescr *bd;
 637     StgPtr p;
 638
 639     if (n >= LARGE_OBJECT_THRESHOLD/sizeof(W_)) {
 640         return allocateInGen(g0,n);
 641     }
 642
 643     /* small allocation (<LARGE_OBJECT_THRESHOLD) */
 644
 645     TICK_ALLOC_HEAP_NOCTR(n);
 646     CCS_ALLOC(CCCS,n);
 647
 648     bd = cap->r.rCurrentAlloc;
 649     if (bd == NULL || bd->free + n > bd->start + BLOCK_SIZE_W) {
 650
 651         // The CurrentAlloc block is full, we need to find another
 652         // one.  First, we try taking the next block from the
 653         // nursery:
 654         bd = cap->r.rCurrentNursery->link;
 655
 656         if (bd == NULL || bd->free + n > bd->start + BLOCK_SIZE_W) {
 657             // The nursery is empty, or the next block is already
 658             // full: allocate a fresh block (we can't fail here).
 659             ACQUIRE_SM_LOCK;
 660             bd = allocBlock();
 661             cap->r.rNursery->n_blocks++;
 662             RELEASE_SM_LOCK;
 663             bd->gen_no = 0;
 664             bd->step = cap->r.rNursery;
 665             bd->flags = 0;
 666             // NO: alloc_blocks++;
 667             // calcAllocated() uses the size of the nursery, and we've
 668             // already bumpted nursery->n_blocks above.
 669         } else {
 670             // we have a block in the nursery: take it and put
 671             // it at the *front* of the nursery list, and use it
 672             // to allocate() from.
 673             cap->r.rCurrentNursery->link = bd->link;
 674             if (bd->link != NULL) {
 675                 bd->link->u.back = cap->r.rCurrentNursery;
 676             }
 677         }
 678         dbl_link_onto(bd, &cap->r.rNursery->blocks);
 679         cap->r.rCurrentAlloc = bd;
 680         IF_DEBUG(sanity, checkNurserySanity(cap->r.rNursery));
 681     }
 682     p = bd->free;
 683     bd->free += n;
 684     return p;
 685 }
 686
 687 /* ---------------------------------------------------------------------------
 688    Allocate a fixed/pinned object.
 689
 690    We allocate small pinned objects into a single block, allocating a
 691    new block when the current one overflows.  The block is chained
 692    onto the large_object_list of generation 0 step 0.
 693
 694    NOTE: The GC can't in general handle pinned objects.  This
 695    interface is only safe to use for ByteArrays, which have no
 696    pointers and don't require scavenging.  It works because the
 697    block's descriptor has the BF_LARGE flag set, so the block is
 698    treated as a large object and chained onto various lists, rather
 699    than the individual objects being copied.  However, when it comes
 700    to scavenge the block, the GC will only scavenge the first object.
 701    The reason is that the GC can't linearly scan a block of pinned
 702    objects at the moment (doing so would require using the
 703    mostly-copying techniques).  But since we're restricting ourselves
 704    to pinned ByteArrays, not scavenging is ok.
 705
 706    This function is called by newPinnedByteArray# which immediately
 707    fills the allocated memory with a MutableByteArray#.
 708    ------------------------------------------------------------------------- */
 709
 710 StgPtr
 711 allocatePinned( nat n )
 712 {
 713     StgPtr p;
 714     bdescr *bd = pinned_object_block;
 715
 716     // If the request is for a large object, then allocate()
 717     // will give us a pinned object anyway.
 718     if (n >= LARGE_OBJECT_THRESHOLD/sizeof(W_)) {
 719         return allocate(n);
 720     }
 721
 722     ACQUIRE_SM_LOCK;
 723
 724     TICK_ALLOC_HEAP_NOCTR(n);
 725     CCS_ALLOC(CCCS,n);
 726
 727     // we always return 8-byte aligned memory.  bd->free must be
 728     // 8-byte aligned to begin with, so we just round up n to
 729     // the nearest multiple of 8 bytes.
 730     if (sizeof(StgWord) == 4) {
 731         n = (n+1) & ~1;
 732     }
 733
 734     // If we don't have a block of pinned objects yet, or the current
 735     // one isn't large enough to hold the new object, allocate a new one.
 736     if (bd == NULL || (bd->free + n) > (bd->start + BLOCK_SIZE_W)) {
 737         pinned_object_block = bd = allocBlock();
 738         dbl_link_onto(bd, &g0s0->large_objects);
 739         g0s0->n_large_blocks++;
 740         bd->gen_no = 0;
 741         bd->step   = g0s0;
 742         bd->flags  = BF_PINNED | BF_LARGE;
 743         bd->free   = bd->start;
 744         alloc_blocks++;
 745     }
 746
 747     p = bd->free;
 748     bd->free += n;
 749     RELEASE_SM_LOCK;
 750     return p;
 751 }
 752
 753 /* -----------------------------------------------------------------------------
 754    Write Barriers
 755    -------------------------------------------------------------------------- */
 756
 757 /*
 758    This is the write barrier for MUT_VARs, a.k.a. IORefs.  A
 759    MUT_VAR_CLEAN object is not on the mutable list; a MUT_VAR_DIRTY
 760    is.  When written to, a MUT_VAR_CLEAN turns into a MUT_VAR_DIRTY
 761    and is put on the mutable list.
 762 */
 763 void
 764 dirty_MUT_VAR(StgRegTable *reg, StgClosure *p)
 765 {
 766     Capability *cap = regTableToCapability(reg);
 767     bdescr *bd;
 768     if (p->header.info == &stg_MUT_VAR_CLEAN_info) {
 769         p->header.info = &stg_MUT_VAR_DIRTY_info;
 770         bd = Bdescr((StgPtr)p);
 771         if (bd->gen_no > 0) recordMutableCap(p,cap,bd->gen_no);
 772     }
 773 }
 774
 775 /*
 776    This is the write barrier for MVARs.  An MVAR_CLEAN objects is not
 777    on the mutable list; a MVAR_DIRTY is.  When written to, a
 778    MVAR_CLEAN turns into a MVAR_DIRTY and is put on the mutable list.
 779    The check for MVAR_CLEAN is inlined at the call site for speed,
 780    this really does make a difference on concurrency-heavy benchmarks
 781    such as Chaneneos and cheap-concurrency.
 782 */
 783 void
 784 dirty_MVAR(StgRegTable *reg, StgClosure *p)
 785 {
 786     Capability *cap = regTableToCapability(reg);
 787     bdescr *bd;
 788     bd = Bdescr((StgPtr)p);
 789     if (bd->gen_no > 0) recordMutableCap(p,cap,bd->gen_no);
 790 }
 791
 792 /* -----------------------------------------------------------------------------
 793    Allocation functions for GMP.
 794
 795    These all use the allocate() interface - we can't have any garbage
 796    collection going on during a gmp operation, so we use allocate()
 797    which always succeeds.  The gmp operations which might need to
 798    allocate will ask the storage manager (via doYouWantToGC()) whether
 799    a garbage collection is required, in case we get into a loop doing
 800    only allocate() style allocation.
 801    -------------------------------------------------------------------------- */
 802
 803 static void *
 804 stgAllocForGMP (size_t size_in_bytes)
 805 {
 806   StgArrWords* arr;
 807   nat data_size_in_words, total_size_in_words;
 808
 809   /* round up to a whole number of words */
 810   data_size_in_words  = (size_in_bytes + sizeof(W_) + 1) / sizeof(W_);
 811   total_size_in_words = sizeofW(StgArrWords) + data_size_in_words;
 812
 813   /* allocate and fill it in. */
 814 #if defined(THREADED_RTS)
 815   arr = (StgArrWords *)allocateLocal(myTask()->cap, total_size_in_words);
 816 #else
 817   arr = (StgArrWords *)allocateLocal(&MainCapability, total_size_in_words);
 818 #endif
 819   SET_ARR_HDR(arr, &stg_ARR_WORDS_info, CCCS, data_size_in_words);
 820
 821   /* and return a ptr to the goods inside the array */
 822   return arr->payload;
 823 }
 824
 825 static void *
 826 stgReallocForGMP (void *ptr, size_t old_size, size_t new_size)
 827 {
 828     void *new_stuff_ptr = stgAllocForGMP(new_size);
 829     nat i = 0;
 830     char *p = (char *) ptr;
 831     char *q = (char *) new_stuff_ptr;
 832
 833     for (; i < old_size; i++, p++, q++) {
 834         *q = *p;
 835     }
 836
 837     return(new_stuff_ptr);
 838 }
 839
 840 static void
 841 stgDeallocForGMP (void *ptr STG_UNUSED,
 842                   size_t size STG_UNUSED)
 843 {
 844     /* easy for us: the garbage collector does the dealloc'n */
 845 }
 846
 847 /* -----------------------------------------------------------------------------
 848  * Stats and stuff
 849  * -------------------------------------------------------------------------- */
 850
 851 /* -----------------------------------------------------------------------------
 852  * calcAllocated()
 853  *
 854  * Approximate how much we've allocated: number of blocks in the
 855  * nursery + blocks allocated via allocate() - unused nusery blocks.
 856  * This leaves a little slop at the end of each block, and doesn't
 857  * take into account large objects (ToDo).
 858  * -------------------------------------------------------------------------- */
 859
 860 lnat
 861 calcAllocated( void )
 862 {
 863   nat allocated;
 864   bdescr *bd;
 865
 866   allocated = allocatedBytes();
 867   allocated += countNurseryBlocks() * BLOCK_SIZE_W;
 868
 869   {
 870 #ifdef THREADED_RTS
 871   nat i;
 872   for (i = 0; i < n_nurseries; i++) {
 873       Capability *cap;
 874       for ( bd = capabilities[i].r.rCurrentNursery->link;
 875             bd != NULL; bd = bd->link ) {
 876           allocated -= BLOCK_SIZE_W;
 877       }
 878       cap = &capabilities[i];
 879       if (cap->r.rCurrentNursery->free <
 880           cap->r.rCurrentNursery->start + BLOCK_SIZE_W) {
 881           allocated -= (cap->r.rCurrentNursery->start + BLOCK_SIZE_W)
 882               - cap->r.rCurrentNursery->free;
 883       }
 884   }
 885 #else
 886   bdescr *current_nursery = MainCapability.r.rCurrentNursery;
 887
 888   for ( bd = current_nursery->link; bd != NULL; bd = bd->link ) {
 889       allocated -= BLOCK_SIZE_W;
 890   }
 891   if (current_nursery->free < current_nursery->start + BLOCK_SIZE_W) {
 892       allocated -= (current_nursery->start + BLOCK_SIZE_W)
 893           - current_nursery->free;
 894   }
 895 #endif
 896   }
 897
 898   total_allocated += allocated;
 899   return allocated;
 900 }
 901
 902 /* Approximate the amount of live data in the heap.  To be called just
 903  * after garbage collection (see GarbageCollect()).
 904  */
 905 extern lnat
 906 calcLive(void)
 907 {
 908   nat g, s;
 909   lnat live = 0;
 910   step *stp;
 911
 912   if (RtsFlags.GcFlags.generations == 1) {
 913       return (g0s0->n_large_blocks + g0s0->n_blocks) * BLOCK_SIZE_W;
 914   }
 915
 916   for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
 917     for (s = 0; s < generations[g].n_steps; s++) {
 918       /* approximate amount of live data (doesn't take into account slop
 919        * at end of each block).
 920        */
 921       if (g == 0 && s == 0) {
 922           continue;
 923       }
 924       stp = &generations[g].steps[s];
 925       live += (stp->n_large_blocks + stp->n_blocks) * BLOCK_SIZE_W;
 926     }
 927   }
 928   return live;
 929 }
 930
 931 /* Approximate the number of blocks that will be needed at the next
 932  * garbage collection.
 933  *
 934  * Assume: all data currently live will remain live.  Steps that will
 935  * be collected next time will therefore need twice as many blocks
 936  * since all the data will be copied.
 937  */
 938 extern lnat
 939 calcNeeded(void)
 940 {
 941     lnat needed = 0;
 942     nat g, s;
 943     step *stp;
 944
 945     for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
 946         for (s = 0; s < generations[g].n_steps; s++) {
 947             if (g == 0 && s == 0) { continue; }
 948             stp = &generations[g].steps[s];
 949             if (generations[g].steps[0].n_blocks +
 950                 generations[g].steps[0].n_large_blocks
 951                 > generations[g].max_blocks
 952                 && stp->is_compacted == 0) {
 953                 needed += 2 * stp->n_blocks;
 954             } else {
 955                 needed += stp->n_blocks;
 956             }
 957         }
 958     }
 959     return needed;
 960 }
 961
 962 /* ----------------------------------------------------------------------------
 963    Executable memory
 964
 965    Executable memory must be managed separately from non-executable
 966    memory.  Most OSs these days require you to jump through hoops to
 967    dynamically allocate executable memory, due to various security
 968    measures.
 969
 970    Here we provide a small memory allocator for executable memory.
 971    Memory is managed with a page granularity; we allocate linearly
 972    in the page, and when the page is emptied (all objects on the page
 973    are free) we free the page again, not forgetting to make it
 974    non-executable.
 975
 976    TODO: The inability to handle objects bigger than BLOCK_SIZE_W means that
 977          the linker cannot use allocateExec for loading object code files
 978          on Windows. Once allocateExec can handle larger objects, the linker
 979          should be modified to use allocateExec instead of VirtualAlloc.
 980    ------------------------------------------------------------------------- */
 981
 982 static bdescr *exec_block;
 983
 984 void *allocateExec (nat bytes)
 985 {
 986     void *ret;
 987     nat n;
 988
 989     ACQUIRE_SM_LOCK;
 990
 991     // round up to words.
 992     n  = (bytes + sizeof(W_) + 1) / sizeof(W_);
 993
 994     if (n+1 > BLOCK_SIZE_W) {
 995         barf("allocateExec: can't handle large objects");
 996     }
 997
 998     if (exec_block == NULL ||
 999         exec_block->free + n + 1 > exec_block->start + BLOCK_SIZE_W) {
1000         bdescr *bd;
1001         lnat pagesize = getPageSize();
1002         bd = allocGroup(stg_max(1, pagesize / BLOCK_SIZE));
1003         debugTrace(DEBUG_gc, "allocate exec block %p", bd->start);
1004         bd->gen_no = 0;
1005         bd->flags = BF_EXEC;
1006         bd->link = exec_block;
1007         if (exec_block != NULL) {
1008             exec_block->u.back = bd;
1009         }
1010         bd->u.back = NULL;
1011         setExecutable(bd->start, bd->blocks * BLOCK_SIZE, rtsTrue);
1012         exec_block = bd;
1013     }
1014     *(exec_block->free) = n;  // store the size of this chunk
1015     exec_block->gen_no += n;  // gen_no stores the number of words allocated
1016     ret = exec_block->free + 1;
1017     exec_block->free += n + 1;
1018
1019     RELEASE_SM_LOCK
1020     return ret;
1021 }
1022
1023 void freeExec (void *addr)
1024 {
1025     StgPtr p = (StgPtr)addr - 1;
1026     bdescr *bd = Bdescr((StgPtr)p);
1027
1028     if ((bd->flags & BF_EXEC) == 0) {
1029         barf("freeExec: not executable");
1030     }
1031
1032     if (*(StgPtr)p == 0) {
1033         barf("freeExec: already free?");
1034     }
1035
1036     ACQUIRE_SM_LOCK;
1037
1038     bd->gen_no -= *(StgPtr)p;
1039     *(StgPtr)p = 0;
1040
1041     if (bd->gen_no == 0) {
1042         // Free the block if it is empty, but not if it is the block at
1043         // the head of the queue.
1044         if (bd != exec_block) {
1045             debugTrace(DEBUG_gc, "free exec block %p", bd->start);
1046             dbl_link_remove(bd, &exec_block);
1047             setExecutable(bd->start, bd->blocks * BLOCK_SIZE, rtsFalse);
1048             freeGroup(bd);
1049         } else {
1050             bd->free = bd->start;
1051         }
1052     }
1053
1054     RELEASE_SM_LOCK
1055 }
1056
1057 /* -----------------------------------------------------------------------------
1058    Debugging
1059
1060    memInventory() checks for memory leaks by counting up all the
1061    blocks we know about and comparing that to the number of blocks
1062    allegedly floating around in the system.
1063    -------------------------------------------------------------------------- */
1064
1065 #ifdef DEBUG
1066
1067 nat
1068 countBlocks(bdescr *bd)
1069 {
1070     nat n;
1071     for (n=0; bd != NULL; bd=bd->link) {
1072         n += bd->blocks;
1073     }
1074     return n;
1075 }
1076
1077 // (*1) Just like countBlocks, except that we adjust the count for a
1078 // megablock group so that it doesn't include the extra few blocks
1079 // that would be taken up by block descriptors in the second and
1080 // subsequent megablock.  This is so we can tally the count with the
1081 // number of blocks allocated in the system, for memInventory().
1082 static nat
1083 countAllocdBlocks(bdescr *bd)
1084 {
1085     nat n;
1086     for (n=0; bd != NULL; bd=bd->link) {
1087         n += bd->blocks;
1088         // hack for megablock groups: see (*1) above
1089         if (bd->blocks > BLOCKS_PER_MBLOCK) {
1090             n -= (MBLOCK_SIZE / BLOCK_SIZE - BLOCKS_PER_MBLOCK)
1091                 * (bd->blocks/(MBLOCK_SIZE/BLOCK_SIZE));
1092         }
1093     }
1094     return n;
1095 }
1096
1097 static lnat
1098 stepBlocks (step *stp)
1099 {
1100     ASSERT(countBlocks(stp->blocks) == stp->n_blocks);
1101     ASSERT(countBlocks(stp->large_objects) == stp->n_large_blocks);
1102     return stp->n_blocks + stp->n_old_blocks +
1103             countAllocdBlocks(stp->large_objects);
1104 }
1105
1106 void
1107 memInventory(void)
1108 {
1109   nat g, s, i;
1110   step *stp;
1111   lnat gen_blocks[RtsFlags.GcFlags.generations];
1112   lnat nursery_blocks, retainer_blocks,
1113        arena_blocks, exec_blocks;
1114   lnat live_blocks = 0, free_blocks = 0;
1115
1116   // count the blocks we current have
1117
1118   for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
1119       gen_blocks[g] = 0;
1120       for (i = 0; i < n_capabilities; i++) {
1121           gen_blocks[g] += countBlocks(capabilities[i].mut_lists[g]);
1122       }
1123       gen_blocks[g] += countAllocdBlocks(generations[g].mut_list);
1124       for (s = 0; s < generations[g].n_steps; s++) {
1125           stp = &generations[g].steps[s];
1126           gen_blocks[g] += stepBlocks(stp);
1127       }
1128   }
1129
1130   nursery_blocks = 0;
1131   for (i = 0; i < n_nurseries; i++) {
1132       nursery_blocks += stepBlocks(&nurseries[i]);
1133   }
1134
1135   retainer_blocks = 0;
1136 #ifdef PROFILING
1137   if (RtsFlags.ProfFlags.doHeapProfile == HEAP_BY_RETAINER) {
1138       retainer_blocks = retainerStackBlocks();
1139   }
1140 #endif
1141
1142   // count the blocks allocated by the arena allocator
1143   arena_blocks = arenaBlocks();
1144
1145   // count the blocks containing executable memory
1146   exec_blocks = countAllocdBlocks(exec_block);
1147
1148   /* count the blocks on the free list */
1149   free_blocks = countFreeList();
1150
1151   live_blocks = 0;
1152   for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
1153       live_blocks += gen_blocks[g];
1154   }
1155   live_blocks += nursery_blocks +
1156                + retainer_blocks + arena_blocks + exec_blocks;
1157
1158   if (live_blocks + free_blocks != mblocks_allocated * BLOCKS_PER_MBLOCK)
1159   {
1160       debugBelch("Memory leak detected\n");
1161       for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
1162           debugBelch("  gen %d blocks : %4lu\n", g, gen_blocks[g]);
1163       }
1164       debugBelch("  nursery      : %4lu\n", nursery_blocks);
1165       debugBelch("  retainer     : %4lu\n", retainer_blocks);
1166       debugBelch("  arena blocks : %4lu\n", arena_blocks);
1167       debugBelch("  exec         : %4lu\n", exec_blocks);
1168       debugBelch("  free         : %4lu\n", free_blocks);
1169       debugBelch("  total        : %4lu\n\n", live_blocks + free_blocks);
1170       debugBelch("  in system    : %4lu\n", mblocks_allocated * BLOCKS_PER_MBLOCK);
1171       ASSERT(0);
1172   }
1173 }
1174
1175
1176 /* Full heap sanity check. */
1177 void
1178 checkSanity( void )
1179 {
1180     nat g, s;
1181
1182     if (RtsFlags.GcFlags.generations == 1) {
1183         checkHeap(g0s0->blocks);
1184         checkChain(g0s0->large_objects);
1185     } else {
1186
1187         for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
1188             for (s = 0; s < generations[g].n_steps; s++) {
1189                 if (g == 0 && s == 0) { continue; }
1190                 ASSERT(countBlocks(generations[g].steps[s].blocks)
1191                        == generations[g].steps[s].n_blocks);
1192                 ASSERT(countBlocks(generations[g].steps[s].large_objects)
1193                        == generations[g].steps[s].n_large_blocks);
1194                 checkHeap(generations[g].steps[s].blocks);
1195                 checkChain(generations[g].steps[s].large_objects);
1196                 if (g > 0) {
1197                     checkMutableList(generations[g].mut_list, g);
1198                 }
1199             }
1200         }
1201
1202         for (s = 0; s < n_nurseries; s++) {
1203             ASSERT(countBlocks(nurseries[s].blocks)
1204                    == nurseries[s].n_blocks);
1205             ASSERT(countBlocks(nurseries[s].large_objects)
1206                    == nurseries[s].n_large_blocks);
1207         }
1208
1209         checkFreeListSanity();
1210     }
1211 }
1212
1213 /* Nursery sanity check */
1214 void
1215 checkNurserySanity( step *stp )
1216 {
1217     bdescr *bd, *prev;
1218     nat blocks = 0;
1219
1220     prev = NULL;
1221     for (bd = stp->blocks; bd != NULL; bd = bd->link) {
1222         ASSERT(bd->u.back == prev);
1223         prev = bd;
1224         blocks += bd->blocks;
1225     }
1226     ASSERT(blocks == stp->n_blocks);
1227 }
1228
1229 // handy function for use in gdb, because Bdescr() is inlined.
1230 extern bdescr *_bdescr( StgPtr p );
1231
1232 bdescr *
1233 _bdescr( StgPtr p )
1234 {
1235     return Bdescr(p);
1236 }
1237
1238 #endif