[project @ 2000-04-14 15:18:05 by sewardj]
[ghc-hetmet.git] / ghc / rts / Storage.c
index e08ba9b..39a6a5f 100644 (file)
@@ -1,5 +1,7 @@
 /* -----------------------------------------------------------------------------
- * $Id: Storage.c,v 1.2 1998/12/02 13:28:57 simonm Exp $
+ * $Id: Storage.c,v 1.24 2000/04/14 15:18:07 sewardj Exp $
+ *
+ * (c) The GHC Team, 1998-1999
  *
  * Storage manager front end
  *
 #include "Stats.h"
 #include "Hooks.h"
 #include "BlockAlloc.h"
+#include "MBlock.h"
 #include "gmp.h"
 #include "Weak.h"
+#include "Sanity.h"
 
 #include "Storage.h"
+#include "Schedule.h"
 #include "StoragePriv.h"
 
-bdescr *nursery;               /* chained-blocks in the nursery */
-bdescr *current_nursery;       /* next available nursery block, or NULL */
+#ifndef SMP
 nat nursery_blocks;            /* number of blocks in the nursery */
+#endif
 
 StgClosure    *caf_list         = NULL;
 
@@ -31,6 +36,19 @@ nat alloc_blocks_lim;                /* approximate limit on alloc_blocks */
 StgPtr alloc_Hp    = NULL;     /* next free byte in small_alloc_list */
 StgPtr alloc_HpLim = NULL;     /* end of block at small_alloc_list   */
 
+generation *generations;       /* all the generations */
+generation *g0;                        /* generation 0, for convenience */
+generation *oldest_gen;                /* oldest generation, for convenience */
+step *g0s0;                    /* generation 0, step 0, for convenience */
+
+/*
+ * Storage manager mutex:  protects all the above state from
+ * simultaneous access by two STG threads.
+ */
+#ifdef SMP
+pthread_mutex_t sm_mutex = PTHREAD_MUTEX_INITIALIZER;
+#endif
+
 /*
  * Forward references
  */
@@ -41,9 +59,116 @@ static void  stgDeallocForGMP (void *ptr, size_t size);
 void
 initStorage (void)
 {
+  nat g, s;
+  step *step;
+  generation *gen;
+
+  /* If we're doing heap profiling, we want a two-space heap with a
+   * fixed-size allocation area so that we get roughly even-spaced
+   * samples.
+   */
+#if defined(PROFILING) || defined(DEBUG)
+  if (RtsFlags.ProfFlags.doHeapProfile) {
+    RtsFlags.GcFlags.generations = 1;
+    RtsFlags.GcFlags.steps = 1;
+    RtsFlags.GcFlags.oldGenFactor = 0;
+    RtsFlags.GcFlags.heapSizeSuggestion = 0;
+  }
+#endif
+
+  if (RtsFlags.GcFlags.heapSizeSuggestion > 
+      RtsFlags.GcFlags.maxHeapSize) {
+    RtsFlags.GcFlags.maxHeapSize = RtsFlags.GcFlags.heapSizeSuggestion;
+  }
+
   initBlockAllocator();
   
-  nursery = allocNursery(NULL, RtsFlags.GcFlags.minAllocAreaSize);
+  /* allocate generation info array */
+  generations = (generation *)stgMallocBytes(RtsFlags.GcFlags.generations 
+                                            * sizeof(struct _generation),
+                                            "initStorage: gens");
+
+  /* Initialise all generations */
+  for(g = 0; g < RtsFlags.GcFlags.generations; g++) {
+    gen = &generations[g];
+    gen->no = g;
+    gen->mut_list = END_MUT_LIST;
+    gen->mut_once_list = END_MUT_LIST;
+    gen->collections = 0;
+    gen->failed_promotions = 0;
+    gen->max_blocks = 0;
+  }
+
+  /* A couple of convenience pointers */
+  g0 = &generations[0];
+  oldest_gen = &generations[RtsFlags.GcFlags.generations-1];
+
+  /* Allocate step structures in each generation */
+  if (RtsFlags.GcFlags.generations > 1) {
+    /* Only for multiple-generations */
+
+    /* Oldest generation: one step */
+    oldest_gen->n_steps = 1;
+    oldest_gen->steps = 
+      stgMallocBytes(1 * sizeof(struct _step), "initStorage: last step");
+
+    /* set up all except the oldest generation with 2 steps */
+    for(g = 0; g < RtsFlags.GcFlags.generations-1; g++) {
+      generations[g].n_steps = RtsFlags.GcFlags.steps;
+      generations[g].steps  = 
+       stgMallocBytes (RtsFlags.GcFlags.steps * sizeof(struct _step),
+                       "initStorage: steps");
+    }
+    
+  } else {
+    /* single generation, i.e. a two-space collector */
+    g0->n_steps = 1;
+    g0->steps = stgMallocBytes (sizeof(struct _step), "initStorage: steps");
+  }
+
+  /* Initialise all steps */
+  for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
+    for (s = 0; s < generations[g].n_steps; s++) {
+      step = &generations[g].steps[s];
+      step->no = s;
+      step->blocks = NULL;
+      step->n_blocks = 0;
+      step->gen = &generations[g];
+      step->hp = NULL;
+      step->hpLim = NULL;
+      step->hp_bd = NULL;
+      step->scan = NULL;
+      step->scan_bd = NULL;
+      step->large_objects = NULL;
+      step->new_large_objects = NULL;
+      step->scavenged_large_objects = NULL;
+    }
+  }
+  
+  /* Set up the destination pointers in each younger gen. step */
+  for (g = 0; g < RtsFlags.GcFlags.generations-1; g++) {
+    for (s = 0; s < generations[g].n_steps-1; s++) {
+      generations[g].steps[s].to = &generations[g].steps[s+1];
+    }
+    generations[g].steps[s].to = &generations[g+1].steps[0];
+  }
+  
+  /* The oldest generation has one step and its destination is the
+   * same step. */
+  oldest_gen->steps[0].to = &oldest_gen->steps[0];
+
+  /* generation 0 is special: that's the nursery */
+  generations[0].max_blocks = 0;
+
+  /* G0S0: the allocation area.  Policy: keep the allocation area
+   * small to begin with, even if we have a large suggested heap
+   * size.  Reason: we're going to do a major collection first, and we
+   * don't want it to be a big one.  This vague idea is borne out by 
+   * rigorous experimental evidence.
+   */
+  g0s0 = &generations[0].steps[0];
+
+  allocNurseries();
 
   weak_ptr_list = NULL;
   caf_list = NULL;
@@ -54,9 +179,174 @@ initStorage (void)
   alloc_blocks = 0;
   alloc_blocks_lim = RtsFlags.GcFlags.minAllocAreaSize;
 
-#ifdef COMPILER
   /* Tell GNU multi-precision pkg about our custom alloc functions */
   mp_set_memory_functions(stgAllocForGMP, stgReallocForGMP, stgDeallocForGMP);
+
+#ifdef SMP
+  pthread_mutex_init(&sm_mutex, NULL);
+#endif
+
+  IF_DEBUG(gc, stat_describe_gens());
+}
+
+void
+exitStorage (void)
+{
+  stat_exit(calcAllocated());
+}
+
+
+/* -----------------------------------------------------------------------------
+   CAF management.
+   -------------------------------------------------------------------------- */
+
+void
+newCAF(StgClosure* caf)
+{
+  /* Put this CAF on the mutable list for the old generation.
+   * This is a HACK - the IND_STATIC closure doesn't really have
+   * a mut_link field, but we pretend it has - in fact we re-use
+   * the STATIC_LINK field for the time being, because when we
+   * come to do a major GC we won't need the mut_link field
+   * any more and can use it as a STATIC_LINK.
+   */
+  ACQUIRE_LOCK(&sm_mutex);
+
+  ASSERT( ((StgMutClosure*)caf)->mut_link == NULL );
+  ((StgMutClosure *)caf)->mut_link = oldest_gen->mut_once_list;
+  oldest_gen->mut_once_list = (StgMutClosure *)caf;
+
+#ifdef INTERPRETER
+  /* If we're Hugs, we also have to put it in the CAF table, so that
+     the CAF can be reverted.  When reverting, CAFs created by compiled
+     code are recorded in the CAF table, which lives outside the
+     heap, in mallocville.  CAFs created by interpreted code are
+     chained together via the link fields in StgCAFs, and are not
+     recorded in the CAF table.
+  */
+  ASSERT( get_itbl(caf)->type == THUNK_STATIC );
+  addToECafTable ( caf, get_itbl(caf) );
+#endif
+
+  RELEASE_LOCK(&sm_mutex);
+}
+
+#ifdef INTERPRETER
+void
+newCAF_made_by_Hugs(StgCAF* caf)
+{
+  ACQUIRE_LOCK(&sm_mutex);
+
+  ASSERT( get_itbl(caf)->type == CAF_ENTERED );
+  recordOldToNewPtrs((StgMutClosure*)caf);
+  caf->link = ecafList;
+  ecafList = caf->link;
+
+  RELEASE_LOCK(&sm_mutex);
+}
+#endif
+
+#ifdef INTERPRETER
+/* These initialisations are critical for correct operation
+   on the first call of addToECafTable. 
+*/
+StgCAF*         ecafList      = END_ECAF_LIST;
+StgCAFTabEntry* ecafTable     = NULL;
+StgInt          usedECafTable = 0;
+StgInt          sizeECafTable = 0;
+
+
+void clearECafTable ( void )
+{
+   usedECafTable = 0;
+}
+
+void addToECafTable ( StgClosure* closure, StgInfoTable* origItbl )
+{
+   StgInt          i;
+   StgCAFTabEntry* et2;
+   if (usedECafTable == sizeECafTable) {
+      /* Make the initial table size be 8 */
+      sizeECafTable *= 2;
+      if (sizeECafTable == 0) sizeECafTable = 8;
+      et2 = stgMallocBytes ( 
+               sizeECafTable * sizeof(StgCAFTabEntry),
+               "addToECafTable" );
+      for (i = 0; i < usedECafTable; i++) 
+         et2[i] = ecafTable[i];
+      if (ecafTable) free(ecafTable);
+      ecafTable = et2;
+   }
+   ecafTable[usedECafTable].closure  = closure;
+   ecafTable[usedECafTable].origItbl = origItbl;
+   usedECafTable++;
+}
+#endif
+
+/* -----------------------------------------------------------------------------
+   Nursery management.
+   -------------------------------------------------------------------------- */
+
+void
+allocNurseries( void )
+{ 
+#ifdef SMP
+  {
+    Capability *cap;
+    bdescr *bd;
+
+    g0s0->blocks = NULL;
+    g0s0->n_blocks = 0;
+    for (cap = free_capabilities; cap != NULL; cap = cap->link) {
+      cap->rNursery = allocNursery(NULL, RtsFlags.GcFlags.minAllocAreaSize);
+      cap->rCurrentNursery = cap->rNursery;
+      for (bd = cap->rNursery; bd != NULL; bd = bd->link) {
+       bd->back = (bdescr *)cap;
+      }
+    }
+    /* Set the back links to be equal to the Capability,
+     * so we can do slightly better informed locking.
+     */
+  }
+#else /* SMP */
+  nursery_blocks  = RtsFlags.GcFlags.minAllocAreaSize;
+  g0s0->blocks    = allocNursery(NULL, nursery_blocks);
+  g0s0->n_blocks  = nursery_blocks;
+  g0s0->to_space  = NULL;
+  MainRegTable.rNursery        = g0s0->blocks;
+  MainRegTable.rCurrentNursery = g0s0->blocks;
+  /* hp, hpLim, hp_bd, to_space etc. aren't used in G0S0 */
+#endif
+}
+      
+void
+resetNurseries( void )
+{
+  bdescr *bd;
+#ifdef SMP
+  Capability *cap;
+  
+  /* All tasks must be stopped */
+  ASSERT(n_free_capabilities == RtsFlags.ParFlags.nNodes);
+
+  for (cap = free_capabilities; cap != NULL; cap = cap->link) {
+    for (bd = cap->rNursery; bd; bd = bd->link) {
+      bd->free = bd->start;
+      ASSERT(bd->gen == g0);
+      ASSERT(bd->step == g0s0);
+      IF_DEBUG(sanity,memset(bd->start, 0xaa, BLOCK_SIZE));
+    }
+    cap->rCurrentNursery = cap->rNursery;
+  }
+#else
+  for (bd = g0s0->blocks; bd; bd = bd->link) {
+    bd->free = bd->start;
+    ASSERT(bd->gen == g0);
+    ASSERT(bd->step == g0s0);
+    IF_DEBUG(sanity,memset(bd->start, 0xaa, BLOCK_SIZE));
+  }
+  MainRegTable.rNursery = g0s0->blocks;
+  MainRegTable.rCurrentNursery = g0s0->blocks;
 #endif
 }
 
@@ -70,38 +360,49 @@ allocNursery (bdescr *last_bd, nat blocks)
   for (i=0; i < blocks; i++) {
     bd = allocBlock();
     bd->link = last_bd;
-    bd->step = 0;
+    bd->step = g0s0;
+    bd->gen = g0;
+    bd->evacuated = 0;
     bd->free = bd->start;
     last_bd = bd;
   }
-  nursery_blocks = blocks;
-  current_nursery = last_bd;
   return last_bd;
 }
 
 void
-exitStorage (void)
+resizeNursery ( nat blocks )
 {
-  lnat allocated;
   bdescr *bd;
 
-  /* Return code ignored for now */
-  /* ToDo: allocation figure is slightly wrong (see also GarbageCollect()) */
-  allocated = (nursery_blocks * BLOCK_SIZE_W) + allocated_bytes();
-  for ( bd = current_nursery->link; bd != NULL; bd = bd->link ) {
-    allocated -= BLOCK_SIZE_W;
+#ifdef SMP
+  barf("resizeNursery: can't resize in SMP mode");
+#endif
+
+  if (nursery_blocks == blocks) {
+    ASSERT(g0s0->n_blocks == blocks);
+    return;
   }
-  stat_exit(allocated);
-}
 
-void
-newCAF(StgClosure* caf)
-{
-  const StgInfoTable *info = get_itbl(caf);
+  else if (nursery_blocks < blocks) {
+    IF_DEBUG(gc, fprintf(stderr, "Increasing size of nursery to %d blocks\n", 
+                        blocks));
+    g0s0->blocks = allocNursery(g0s0->blocks, blocks-nursery_blocks);
+  } 
 
-  ASSERT(info->type == IND_STATIC);
-  STATIC_LINK2(info,caf) = caf_list;
-  caf_list = caf;
+  else {
+    bdescr *next_bd;
+    
+    IF_DEBUG(gc, fprintf(stderr, "Decreasing size of nursery to %d blocks\n", 
+                        blocks));
+    for (bd = g0s0->blocks; nursery_blocks > blocks; nursery_blocks--) {
+      next_bd = bd->link;
+      freeGroup(bd);
+      bd = next_bd;
+    }
+    g0s0->blocks = bd;
+  }
+  
+  g0s0->n_blocks = nursery_blocks = blocks;
 }
 
 /* -----------------------------------------------------------------------------
@@ -118,25 +419,27 @@ allocate(nat n)
   bdescr *bd;
   StgPtr p;
 
-  TICK_ALLOC_PRIM(n,wibble,wibble,wibble)
+  ACQUIRE_LOCK(&sm_mutex);
+
+  TICK_ALLOC_HEAP_NOCTR(n);
   CCS_ALLOC(CCCS,n);
 
   /* big allocation (>LARGE_OBJECT_THRESHOLD) */
+  /* ToDo: allocate directly into generation 1 */
   if (n >= LARGE_OBJECT_THRESHOLD/sizeof(W_)) {
     nat req_blocks =  (lnat)BLOCK_ROUND_UP(n*sizeof(W_)) / BLOCK_SIZE;
     bd = allocGroup(req_blocks);
-    bd->link = large_alloc_list; 
-    bd->back = NULL;
-    if (large_alloc_list) {
-      large_alloc_list->back = bd; /* double-link the list */
-    }
-    large_alloc_list = bd;
-    bd->step = 0;
+    dbl_link_onto(bd, &g0s0->large_objects);
+    bd->gen  = g0;
+    bd->step = g0s0;
+    bd->evacuated = 0;
+    bd->free = bd->start;
     /* don't add these blocks to alloc_blocks, since we're assuming
      * that large objects are likely to remain live for quite a while
      * (eg. running threads), so garbage collecting early won't make
      * much difference.
      */
+    RELEASE_LOCK(&sm_mutex);
     return bd->start;
 
   /* small allocation (<LARGE_OBJECT_THRESHOLD) */
@@ -147,7 +450,9 @@ allocate(nat n)
     bd = allocBlock();
     bd->link = small_alloc_list;
     small_alloc_list = bd;
-    bd->step = 0;
+    bd->gen = g0;
+    bd->step = g0s0;
+    bd->evacuated = 0;
     alloc_Hp = bd->start;
     alloc_HpLim = bd->start + BLOCK_SIZE_W;
     alloc_blocks++;
@@ -155,6 +460,7 @@ allocate(nat n)
   
   p = alloc_Hp;
   alloc_Hp += n;
+  RELEASE_LOCK(&sm_mutex);
   return p;
 }
 
@@ -215,3 +521,218 @@ stgDeallocForGMP (void *ptr STG_UNUSED,
 {
     /* easy for us: the garbage collector does the dealloc'n */
 }
+
+/* -----------------------------------------------------------------------------
+ * Stats and stuff
+ * -------------------------------------------------------------------------- */
+
+/* -----------------------------------------------------------------------------
+ * calcAllocated()
+ *
+ * Approximate how much we've allocated: number of blocks in the
+ * nursery + blocks allocated via allocate() - unused nusery blocks.
+ * This leaves a little slop at the end of each block, and doesn't
+ * take into account large objects (ToDo).
+ * -------------------------------------------------------------------------- */
+
+lnat
+calcAllocated( void )
+{
+  nat allocated;
+  bdescr *bd;
+
+#ifdef SMP
+  Capability *cap;
+
+  /* All tasks must be stopped.  Can't assert that all the
+     capabilities are owned by the scheduler, though: one or more
+     tasks might have been stopped while they were running (non-main)
+     threads. */
+  /*  ASSERT(n_free_capabilities == RtsFlags.ParFlags.nNodes); */
+
+  allocated = 
+    n_free_capabilities * RtsFlags.GcFlags.minAllocAreaSize * BLOCK_SIZE_W
+    + allocated_bytes();
+
+  for (cap = free_capabilities; cap != NULL; cap = cap->link) {
+    for ( bd = cap->rCurrentNursery->link; bd != NULL; bd = bd->link ) {
+      allocated -= BLOCK_SIZE_W;
+    }
+    if (cap->rCurrentNursery->free < cap->rCurrentNursery->start 
+       + BLOCK_SIZE_W) {
+      allocated -= (cap->rCurrentNursery->start + BLOCK_SIZE_W)
+       - cap->rCurrentNursery->free;
+    }
+  }
+
+#else /* !SMP */
+  bdescr *current_nursery = MainRegTable.rCurrentNursery;
+
+  allocated = (nursery_blocks * BLOCK_SIZE_W) + allocated_bytes();
+  for ( bd = current_nursery->link; bd != NULL; bd = bd->link ) {
+    allocated -= BLOCK_SIZE_W;
+  }
+  if (current_nursery->free < current_nursery->start + BLOCK_SIZE_W) {
+    allocated -= (current_nursery->start + BLOCK_SIZE_W)
+      - current_nursery->free;
+  }
+#endif
+
+  return allocated;
+}  
+
+/* Approximate the amount of live data in the heap.  To be called just
+ * after garbage collection (see GarbageCollect()).
+ */
+extern lnat 
+calcLive(void)
+{
+  nat g, s;
+  lnat live = 0;
+  step *step;
+
+  if (RtsFlags.GcFlags.generations == 1) {
+    live = (g0s0->to_blocks - 1) * BLOCK_SIZE_W + 
+      ((lnat)g0s0->hp_bd->free - (lnat)g0s0->hp_bd->start) / sizeof(W_);
+    return live;
+  }
+
+  for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
+    for (s = 0; s < generations[g].n_steps; s++) {
+      /* approximate amount of live data (doesn't take into account slop
+       * at end of each block).
+       */
+      if (g == 0 && s == 0) { 
+         continue; 
+      }
+      step = &generations[g].steps[s];
+      live += (step->n_blocks - 1) * BLOCK_SIZE_W +
+       ((lnat)step->hp_bd->free - (lnat)step->hp_bd->start) / sizeof(W_);
+    }
+  }
+  return live;
+}
+
+/* Approximate the number of blocks that will be needed at the next
+ * garbage collection.
+ *
+ * Assume: all data currently live will remain live.  Steps that will
+ * be collected next time will therefore need twice as many blocks
+ * since all the data will be copied.
+ */
+extern lnat 
+calcNeeded(void)
+{
+  lnat needed = 0;
+  nat g, s;
+  step *step;
+
+  for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
+    for (s = 0; s < generations[g].n_steps; s++) {
+      if (g == 0 && s == 0) { continue; }
+      step = &generations[g].steps[s];
+      if (generations[g].steps[0].n_blocks > generations[g].max_blocks) {
+       needed += 2 * step->n_blocks;
+      } else {
+       needed += step->n_blocks;
+      }
+    }
+  }
+  return needed;
+}
+
+/* -----------------------------------------------------------------------------
+   Debugging
+
+   memInventory() checks for memory leaks by counting up all the
+   blocks we know about and comparing that to the number of blocks
+   allegedly floating around in the system.
+   -------------------------------------------------------------------------- */
+
+#ifdef DEBUG
+
+extern void
+memInventory(void)
+{
+  nat g, s;
+  step *step;
+  bdescr *bd;
+  lnat total_blocks = 0, free_blocks = 0;
+
+  /* count the blocks we current have */
+
+  for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
+    for (s = 0; s < generations[g].n_steps; s++) {
+      step = &generations[g].steps[s];
+      total_blocks += step->n_blocks;
+      if (RtsFlags.GcFlags.generations == 1) {
+       /* two-space collector has a to-space too :-) */
+       total_blocks += g0s0->to_blocks;
+      }
+      for (bd = step->large_objects; bd; bd = bd->link) {
+       total_blocks += bd->blocks;
+       /* hack for megablock groups: they have an extra block or two in
+          the second and subsequent megablocks where the block
+          descriptors would normally go.
+       */
+       if (bd->blocks > BLOCKS_PER_MBLOCK) {
+         total_blocks -= (MBLOCK_SIZE / BLOCK_SIZE - BLOCKS_PER_MBLOCK)
+                         * (bd->blocks/(MBLOCK_SIZE/BLOCK_SIZE));
+       }
+      }
+    }
+  }
+
+  /* any blocks held by allocate() */
+  for (bd = small_alloc_list; bd; bd = bd->link) {
+    total_blocks += bd->blocks;
+  }
+  for (bd = large_alloc_list; bd; bd = bd->link) {
+    total_blocks += bd->blocks;
+  }
+  
+  /* count the blocks on the free list */
+  free_blocks = countFreeList();
+
+  ASSERT(total_blocks + free_blocks == mblocks_allocated * BLOCKS_PER_MBLOCK);
+
+#if 0
+  if (total_blocks + free_blocks != mblocks_allocated *
+      BLOCKS_PER_MBLOCK) {
+    fprintf(stderr, "Blocks: %ld live + %ld free  = %ld total (%ld around)\n",
+           total_blocks, free_blocks, total_blocks + free_blocks,
+           mblocks_allocated * BLOCKS_PER_MBLOCK);
+  }
+#endif
+}
+
+/* Full heap sanity check. */
+
+extern void
+checkSanity(nat N)
+{
+  nat g, s;
+fprintf(stderr, "--- checkSanity %d\n", N );
+  if (0&&RtsFlags.GcFlags.generations == 1) {
+    checkHeap(g0s0->to_space, NULL);
+    checkChain(g0s0->large_objects);
+  } else {
+    
+    for (g = 0; g <= N; g++) {
+      for (s = 0; s < generations[g].n_steps; s++) {
+       if (g == 0 && s == 0) { continue; }
+       checkHeap(generations[g].steps[s].blocks, NULL);
+      }
+    }
+    for (g = N+1; g < RtsFlags.GcFlags.generations; g++) {
+      for (s = 0; s < generations[g].n_steps; s++) {
+       checkHeap(generations[g].steps[s].blocks,
+                 generations[g].steps[s].blocks->start);
+       checkChain(generations[g].steps[s].large_objects);
+      }
+    }
+    checkFreeListSanity();
+  }
+}
+
+#endif