[project @ 2001-10-01 11:09:02 by simonmar]
[ghc-hetmet.git] / ghc / rts / Storage.c
index c2939d9..134106d 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
- * $Id: Storage.c,v 1.37 2001/03/22 03:51:10 hwloidl Exp $
+ * $Id: Storage.c,v 1.51 2001/10/01 11:09:02 simonmar Exp $
  *
  * (c) The GHC Team, 1998-1999
  *
@@ -7,6 +7,7 @@
  *
  * ---------------------------------------------------------------------------*/
 
+#include "PosixSource.h"
 #include "Rts.h"
 #include "RtsUtils.h"
 #include "RtsFlags.h"
@@ -29,6 +30,7 @@ StgClosure    *caf_list         = NULL;
 
 bdescr *small_alloc_list;      /* allocate()d small objects */
 bdescr *large_alloc_list;      /* allocate()d large objects */
+bdescr *pinned_object_block;    /* allocate pinned objects into this block */
 nat alloc_blocks;              /* number of allocate()d blocks since GC */
 nat alloc_blocks_lim;          /* approximate limit on alloc_blocks */
 
@@ -58,7 +60,7 @@ static void *stgReallocForGMP (void *ptr, size_t old_size, size_t new_size);
 static void  stgDeallocForGMP (void *ptr, size_t size);
 
 void
-initStorage (void)
+initStorage( void )
 {
   nat g, s;
   step *stp;
@@ -68,6 +70,10 @@ initStorage (void)
    * fixed-size allocation area so that we get roughly even-spaced
    * samples.
    */
+
+  /* As an experiment, try a 2 generation collector
+   */
+
 #if defined(PROFILING) || defined(DEBUG)
   if (RtsFlags.ProfFlags.doHeapProfile) {
     RtsFlags.GcFlags.generations = 1;
@@ -77,11 +83,19 @@ initStorage (void)
   }
 #endif
 
-  if (RtsFlags.GcFlags.heapSizeSuggestion > 
+  if (RtsFlags.GcFlags.maxHeapSize != 0 &&
+      RtsFlags.GcFlags.heapSizeSuggestion > 
       RtsFlags.GcFlags.maxHeapSize) {
     RtsFlags.GcFlags.maxHeapSize = RtsFlags.GcFlags.heapSizeSuggestion;
   }
 
+  if (RtsFlags.GcFlags.maxHeapSize != 0 &&
+      RtsFlags.GcFlags.minAllocAreaSize > 
+      RtsFlags.GcFlags.maxHeapSize) {
+      prog_belch("maximum heap size (-M) is smaller than minimum alloc area size (-A)");
+      exit(1);
+  }
+
   initBlockAllocator();
   
   /* allocate generation info array */
@@ -135,14 +149,19 @@ initStorage (void)
       stp->blocks = NULL;
       stp->n_blocks = 0;
       stp->gen = &generations[g];
+      stp->gen_no = g;
       stp->hp = NULL;
       stp->hpLim = NULL;
       stp->hp_bd = NULL;
       stp->scan = NULL;
       stp->scan_bd = NULL;
       stp->large_objects = NULL;
+      stp->n_large_blocks = 0;
       stp->new_large_objects = NULL;
       stp->scavenged_large_objects = NULL;
+      stp->n_scavenged_large_blocks = 0;
+      stp->is_compacted = 0;
+      stp->bitmap = NULL;
     }
   }
   
@@ -154,8 +173,14 @@ initStorage (void)
     generations[g].steps[s].to = &generations[g+1].steps[0];
   }
   
-  /* The oldest generation has one step and its destination is the
-   * same step. */
+  /* The oldest generation has one step and it is compacted. */
+  if (RtsFlags.GcFlags.compact) {
+      if (RtsFlags.GcFlags.generations == 1) {
+         belch("WARNING: compaction is incompatible with -G1; disabled");
+      } else {
+         oldest_gen->steps[0].is_compacted = 1;
+      }
+  }
   oldest_gen->steps[0].to = &oldest_gen->steps[0];
 
   /* generation 0 is special: that's the nursery */
@@ -187,7 +212,7 @@ initStorage (void)
   pthread_mutex_init(&sm_mutex, NULL);
 #endif
 
-  IF_DEBUG(gc, stat_describe_gens());
+  IF_DEBUG(gc, statDescribeGens());
 }
 
 void
@@ -268,7 +293,7 @@ newCAF(StgClosure* caf)
     newGA=makeGlobal(caf,rtsTrue); /*given full weight*/
     ASSERT(newGA);
   } 
-#endif PAR  
+#endif /* PAR */
 }
 
 /* -----------------------------------------------------------------------------
@@ -289,7 +314,7 @@ allocNurseries( void )
       cap->rNursery = allocNursery(NULL, RtsFlags.GcFlags.minAllocAreaSize);
       cap->rCurrentNursery = cap->rNursery;
       for (bd = cap->rNursery; bd != NULL; bd = bd->link) {
-       bd->back = (bdescr *)cap;
+       bd->u.back = (bdescr *)cap;
       }
     }
     /* Set the back links to be equal to the Capability,
@@ -297,10 +322,11 @@ allocNurseries( void )
      */
   }
 #else /* SMP */
-  nursery_blocks  = RtsFlags.GcFlags.minAllocAreaSize;
-  g0s0->blocks    = allocNursery(NULL, nursery_blocks);
-  g0s0->n_blocks  = nursery_blocks;
-  g0s0->to_space  = NULL;
+  nursery_blocks    = RtsFlags.GcFlags.minAllocAreaSize;
+  g0s0->blocks      = allocNursery(NULL, nursery_blocks);
+  g0s0->n_blocks    = nursery_blocks;
+  g0s0->to_blocks   = NULL;
+  g0s0->n_to_blocks = 0;
   MainRegTable.rNursery        = g0s0->blocks;
   MainRegTable.rCurrentNursery = g0s0->blocks;
   /* hp, hpLim, hp_bd, to_space etc. aren't used in G0S0 */
@@ -320,7 +346,7 @@ resetNurseries( void )
   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->gen_no == 0);
       ASSERT(bd->step == g0s0);
       IF_DEBUG(sanity,memset(bd->start, 0xaa, BLOCK_SIZE));
     }
@@ -329,7 +355,7 @@ resetNurseries( void )
 #else
   for (bd = g0s0->blocks; bd; bd = bd->link) {
     bd->free = bd->start;
-    ASSERT(bd->gen == g0);
+    ASSERT(bd->gen_no == 0);
     ASSERT(bd->step == g0s0);
     IF_DEBUG(sanity,memset(bd->start, 0xaa, BLOCK_SIZE));
   }
@@ -349,8 +375,8 @@ allocNursery (bdescr *last_bd, nat blocks)
     bd = allocBlock();
     bd->link = last_bd;
     bd->step = g0s0;
-    bd->gen = g0;
-    bd->evacuated = 0;
+    bd->gen_no = 0;
+    bd->flags = 0;
     bd->free = bd->start;
     last_bd = bd;
   }
@@ -402,7 +428,7 @@ resizeNursery ( nat blocks )
    -------------------------------------------------------------------------- */
 
 StgPtr
-allocate(nat n)
+allocate( nat n )
 {
   bdescr *bd;
   StgPtr p;
@@ -418,9 +444,9 @@ allocate(nat n)
     nat req_blocks =  (lnat)BLOCK_ROUND_UP(n*sizeof(W_)) / BLOCK_SIZE;
     bd = allocGroup(req_blocks);
     dbl_link_onto(bd, &g0s0->large_objects);
-    bd->gen  = g0;
+    bd->gen_no  = 0;
     bd->step = g0s0;
-    bd->evacuated = 0;
+    bd->flags = BF_LARGE;
     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
@@ -439,25 +465,85 @@ allocate(nat n)
     bd = allocBlock();
     bd->link = small_alloc_list;
     small_alloc_list = bd;
-    bd->gen = g0;
+    bd->gen_no = 0;
     bd->step = g0s0;
-    bd->evacuated = 0;
+    bd->flags = 0;
     alloc_Hp = bd->start;
     alloc_HpLim = bd->start + BLOCK_SIZE_W;
     alloc_blocks++;
   }
-  
+
   p = alloc_Hp;
   alloc_Hp += n;
   RELEASE_LOCK(&sm_mutex);
   return p;
 }
 
-lnat allocated_bytes(void)
+lnat
+allocated_bytes( void )
 {
   return (alloc_blocks * BLOCK_SIZE_W - (alloc_HpLim - alloc_Hp));
 }
 
+/* ---------------------------------------------------------------------------
+   Allocate a fixed/pinned object.
+
+   We allocate small pinned objects into a single block, allocating a
+   new block when the current one overflows.  The block is chained
+   onto the large_object_list of generation 0 step 0.
+
+   NOTE: The GC can't in general handle pinned objects.  This
+   interface is only safe to use for ByteArrays, which have no
+   pointers and don't require scavenging.  It works because the
+   block's descriptor has the BF_LARGE flag set, so the block is
+   treated as a large object and chained onto various lists, rather
+   than the individual objects being copied.  However, when it comes
+   to scavenge the block, the GC will only scavenge the first object.
+   The reason is that the GC can't linearly scan a block of pinned
+   objects at the moment (doing so would require using the
+   mostly-copying techniques).  But since we're restricting ourselves
+   to pinned ByteArrays, not scavenging is ok.
+
+   This function is called by newPinnedByteArray# which immediately
+   fills the allocated memory with a MutableByteArray#.
+   ------------------------------------------------------------------------- */
+
+StgPtr
+allocatePinned( nat n )
+{
+    StgPtr p;
+    bdescr *bd = pinned_object_block;
+
+    ACQUIRE_LOCK(&sm_mutex);
+    
+    TICK_ALLOC_HEAP_NOCTR(n);
+    CCS_ALLOC(CCCS,n);
+
+    // If the request is for a large object, then allocate()
+    // will give us a pinned object anyway.
+    if (n >= LARGE_OBJECT_THRESHOLD/sizeof(W_)) {
+       RELEASE_LOCK(&sm_mutex);
+       return allocate(n);
+    }
+
+    // If we don't have a block of pinned objects yet, or the current
+    // one isn't large enough to hold the new object, allocate a new one.
+    if (bd == NULL || (bd->free + n) > (bd->start + BLOCK_SIZE_W)) {
+       pinned_object_block = bd = allocBlock();
+       dbl_link_onto(bd, &g0s0->large_objects);
+       bd->gen_no = 0;
+       bd->step   = g0s0;
+       bd->flags  = BF_LARGE;
+       bd->free   = bd->start;
+       alloc_blocks++;
+    }
+
+    p = bd->free;
+    bd->free += n;
+    RELEASE_LOCK(&sm_mutex);
+    return p;
+}
+
 /* -----------------------------------------------------------------------------
    Allocation functions for GMP.
 
@@ -582,7 +668,7 @@ calcLive(void)
   step *stp;
 
   if (RtsFlags.GcFlags.generations == 1) {
-    live = (g0s0->to_blocks - 1) * BLOCK_SIZE_W + 
+    live = (g0s0->n_to_blocks - 1) * BLOCK_SIZE_W + 
       ((lnat)g0s0->hp_bd->free - (lnat)g0s0->hp_bd->start) / sizeof(W_);
     return live;
   }
@@ -596,8 +682,11 @@ calcLive(void)
          continue; 
       }
       stp = &generations[g].steps[s];
-      live += (stp->n_blocks - 1) * BLOCK_SIZE_W +
-       ((lnat)stp->hp_bd->free - (lnat)stp->hp_bd->start) / sizeof(W_);
+      live += (stp->n_large_blocks + stp->n_blocks - 1) * BLOCK_SIZE_W;
+      if (stp->hp_bd != NULL) {
+         live += ((lnat)stp->hp_bd->free - (lnat)stp->hp_bd->start) 
+             / sizeof(W_);
+      }
     }
   }
   return live;
@@ -613,22 +702,25 @@ calcLive(void)
 extern lnat 
 calcNeeded(void)
 {
-  lnat needed = 0;
-  nat g, s;
-  step *stp;
-
-  for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
-    for (s = 0; s < generations[g].n_steps; s++) {
-      if (g == 0 && s == 0) { continue; }
-      stp = &generations[g].steps[s];
-      if (generations[g].steps[0].n_blocks > generations[g].max_blocks) {
-       needed += 2 * stp->n_blocks;
-      } else {
-       needed += stp->n_blocks;
-      }
+    lnat needed = 0;
+    nat g, s;
+    step *stp;
+    
+    for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
+       for (s = 0; s < generations[g].n_steps; s++) {
+           if (g == 0 && s == 0) { continue; }
+           stp = &generations[g].steps[s];
+           if (generations[g].steps[0].n_blocks +
+               generations[g].steps[0].n_large_blocks 
+               > generations[g].max_blocks
+               && stp->is_compacted == 0) {
+               needed += 2 * stp->n_blocks;
+           } else {
+               needed += stp->n_blocks;
+           }
+       }
     }
-  }
-  return needed;
+    return needed;
 }
 
 /* -----------------------------------------------------------------------------
@@ -641,7 +733,7 @@ calcNeeded(void)
 
 #ifdef DEBUG
 
-extern void
+void
 memInventory(void)
 {
   nat g, s;
@@ -657,7 +749,7 @@ memInventory(void)
       total_blocks += stp->n_blocks;
       if (RtsFlags.GcFlags.generations == 1) {
        /* two-space collector has a to-space too :-) */
-       total_blocks += g0s0->to_blocks;
+       total_blocks += g0s0->n_to_blocks;
       }
       for (bd = stp->large_objects; bd; bd = bd->link) {
        total_blocks += bd->blocks;
@@ -684,45 +776,54 @@ memInventory(void)
   /* 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. */
+  ASSERT(total_blocks + free_blocks == mblocks_allocated * BLOCKS_PER_MBLOCK);
+}
 
-extern void
-checkSanity(nat N)
+static nat
+countBlocks(bdescr *bd)
 {
-  nat g, s;
-
-  if (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);
-      }
+    nat n;
+    for (n=0; bd != NULL; bd=bd->link) {
+       n += bd->blocks;
     }
-    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);
-      }
+    return n;
+}
+
+/* Full heap sanity check. */
+void
+checkSanity( void )
+{
+    nat g, s;
+
+    if (RtsFlags.GcFlags.generations == 1) {
+       checkHeap(g0s0->to_blocks);
+       checkChain(g0s0->large_objects);
+    } else {
+       
+       for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
+           for (s = 0; s < generations[g].n_steps; s++) {
+               if (g == 0 && s == 0) { continue; }
+               checkHeap(generations[g].steps[s].blocks);
+               checkChain(generations[g].steps[s].large_objects);
+               ASSERT(countBlocks(generations[g].steps[s].blocks)
+                      == generations[g].steps[s].n_blocks);
+               ASSERT(countBlocks(generations[g].steps[s].large_objects)
+                      == generations[g].steps[s].n_large_blocks);
+               if (g > 0) {
+                   checkMutableList(generations[g].mut_list, g);
+                   checkMutOnceList(generations[g].mut_once_list, g);
+               }
+           }
+       }
+       checkFreeListSanity();
     }
-    checkFreeListSanity();
-  }
 }
 
 #endif