[project @ 2000-03-13 10:53:55 by simonmar]
[ghc-hetmet.git] / ghc / rts / GC.c
index fad50be..acb122f 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
- * $Id: GC.c,v 1.42 1999/02/25 17:52:33 simonm Exp $
+ * $Id: GC.c,v 1.72 2000/01/22 18:00:03 simonmar Exp $
  *
  * (c) The GHC Team 1998-1999
  *
@@ -7,6 +7,25 @@
  *
  * ---------------------------------------------------------------------------*/
 
+//@menu
+//* Includes::                 
+//* STATIC OBJECT LIST::       
+//* Static function declarations::  
+//* Garbage Collect::          
+//* Weak Pointers::            
+//* Evacuation::               
+//* Scavenging::               
+//* Reverting CAFs::           
+//* Sanity code for CAF garbage collection::  
+//* Lazy black holing::                
+//* Stack squeezing::          
+//* Pausing a thread::         
+//* Index::                    
+//@end menu
+
+//@node Includes, STATIC OBJECT LIST
+//@subsection Includes
+
 #include "Rts.h"
 #include "RtsFlags.h"
 #include "RtsUtils.h"
 #include "GC.h"
 #include "BlockAlloc.h"
 #include "Main.h"
-#include "DebugProf.h"
+#include "ProfHeap.h"
 #include "SchedAPI.h"
 #include "Weak.h"
 #include "StablePriv.h"
+#if defined(GRAN) || defined(PAR)
+# include "GranSimRts.h"
+# include "ParallelRts.h"
+# include "FetchMe.h"
+# if defined(DEBUG)
+#  include "Printer.h"
+#  include "ParallelDebug.h"
+# endif
+#endif
 
 StgCAF* enteredCAFs;
 
+//@node STATIC OBJECT LIST, Static function declarations, Includes
+//@subsection STATIC OBJECT LIST
+
 /* STATIC OBJECT LIST.
  *
  * During GC:
@@ -96,27 +127,35 @@ bdescr *old_to_space;
 lnat new_blocks;               /* blocks allocated during this GC */
 lnat g0s0_pcnt_kept = 30;      /* percentage of g0s0 live at last minor GC */
 
+//@node Static function declarations, Garbage Collect, STATIC OBJECT LIST
+//@subsection Static function declarations
+
 /* -----------------------------------------------------------------------------
    Static function declarations
    -------------------------------------------------------------------------- */
 
-static StgClosure *evacuate(StgClosure *q);
-static void    zeroStaticObjectList(StgClosure* first_static);
-static rtsBool traverse_weak_ptr_list(void);
-static void    zeroMutableList(StgMutClosure *first);
-static void    revertDeadCAFs(void);
+static StgClosure * evacuate                ( StgClosure *q );
+static void         zero_static_object_list ( StgClosure* first_static );
+static void         zero_mutable_list       ( StgMutClosure *first );
+static void         revert_dead_CAFs        ( void );
+
+static rtsBool      traverse_weak_ptr_list  ( void );
+static void         cleanup_weak_ptr_list   ( StgWeak **list );
 
-static void           scavenge_stack(StgPtr p, StgPtr stack_end);
-static void           scavenge_large(step *step);
-static void           scavenge(step *step);
-static void           scavenge_static(void);
-static void           scavenge_mutable_list(generation *g);
-static void           scavenge_mut_once_list(generation *g);
+static void         scavenge_stack          ( StgPtr p, StgPtr stack_end );
+static void         scavenge_large          ( step *step );
+static void         scavenge                ( step *step );
+static void         scavenge_static         ( void );
+static void         scavenge_mutable_list   ( generation *g );
+static void         scavenge_mut_once_list  ( generation *g );
 
 #ifdef DEBUG
-static void gcCAFs(void);
+static void         gcCAFs                  ( void );
 #endif
 
+//@node Garbage Collect, Weak Pointers, Static function declarations
+//@subsection Garbage Collect
+
 /* -----------------------------------------------------------------------------
    GarbageCollect
 
@@ -139,6 +178,7 @@ static void gcCAFs(void);
      - free from-space in each step, and set from-space = to-space.
 
    -------------------------------------------------------------------------- */
+//@cindex GarbageCollect
 
 void GarbageCollect(void (*get_roots)(void))
 {
@@ -151,6 +191,11 @@ void GarbageCollect(void (*get_roots)(void))
   CostCentreStack *prev_CCS;
 #endif
 
+#if defined(DEBUG) && defined(GRAN)
+  IF_DEBUG(gc, belch("@@ Starting garbage collection at %ld (%lx)\n", 
+                    Now, Now))
+#endif
+
   /* tell the stats department that we've started a GC */
   stat_startGC();
 
@@ -160,21 +205,8 @@ void GarbageCollect(void (*get_roots)(void))
   CCCS = CCS_GC;
 #endif
 
-  /* We might have been called from Haskell land by _ccall_GC, in
-   * which case we need to call threadPaused() because the scheduler
-   * won't have done it.
-   */
-  if (CurrentTSO) { threadPaused(CurrentTSO); }
-
-  /* Approximate how much we 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).
-   */
-  allocated = (nursery_blocks * BLOCK_SIZE_W) + allocated_bytes();
-  for ( bd = current_nursery->link; bd != NULL; bd = bd->link ) {
-    allocated -= BLOCK_SIZE_W;
-  }
+  /* Approximate how much we allocated */
+  allocated = calcAllocated();
 
   /* Figure out which generation to collect
    */
@@ -187,8 +219,10 @@ void GarbageCollect(void (*get_roots)(void))
   major_gc = (N == RtsFlags.GcFlags.generations-1);
 
   /* check stack sanity *before* GC (ToDo: check all threads) */
-  /*IF_DEBUG(sanity, checkTSO(MainTSO,0)); */
-  IF_DEBUG(sanity, checkFreeListSanity());
+#if defined(GRAN)
+  // ToDo!: check sanity  IF_DEBUG(sanity, checkTSOsSanity());
+#endif
+    IF_DEBUG(sanity, checkFreeListSanity());
 
   /* Initialise the static object lists
    */
@@ -196,10 +230,10 @@ void GarbageCollect(void (*get_roots)(void))
   scavenged_static_objects = END_OF_STATIC_LIST;
 
   /* zero the mutable list for the oldest generation (see comment by
-   * zeroMutableList below).
+   * zero_mutable_list below).
    */
   if (major_gc) { 
-    zeroMutableList(generations[RtsFlags.GcFlags.generations-1].mut_once_list);
+    zero_mutable_list(generations[RtsFlags.GcFlags.generations-1].mut_once_list);
   }
 
   /* Save the old to-space if we're doing a two-space collection
@@ -307,6 +341,8 @@ void GarbageCollect(void (*get_roots)(void))
 
     /* Do the mut-once lists first */
     for (g = RtsFlags.GcFlags.generations-1; g > N; g--) {
+      IF_PAR_DEBUG(verbose,
+                  printMutOnceList(&generations[g]));
       scavenge_mut_once_list(&generations[g]);
       evac_gen = g;
       for (st = generations[g].n_steps-1; st >= 0; st--) {
@@ -315,6 +351,8 @@ void GarbageCollect(void (*get_roots)(void))
     }
 
     for (g = RtsFlags.GcFlags.generations-1; g > N; g--) {
+      IF_PAR_DEBUG(verbose,
+                  printMutableList(&generations[g]));
       scavenge_mutable_list(&generations[g]);
       evac_gen = g;
       for (st = generations[g].n_steps-1; st >= 0; st--) {
@@ -328,16 +366,22 @@ void GarbageCollect(void (*get_roots)(void))
   evac_gen = 0;
   get_roots();
 
+#if defined(PAR)
   /* And don't forget to mark the TSO if we got here direct from
    * Haskell! */
+  /* Not needed in a seq version?
   if (CurrentTSO) {
     CurrentTSO = (StgTSO *)MarkRoot((StgClosure *)CurrentTSO);
   }
+  */
+
+  /* Mark the entries in the GALA table of the parallel system */
+  markLocalGAs(major_gc);
+#endif
 
   /* Mark the weak pointer list, and prepare to detect dead weak
    * pointers.
    */
-  markWeakList();
   old_weak_ptr_list = weak_ptr_list;
   weak_ptr_list = NULL;
   weak_done = rtsFalse;
@@ -353,22 +397,7 @@ void GarbageCollect(void (*get_roots)(void))
        * the CAF document.
        */
       extern void markHugsObjects(void);
-#if 0
-      /* ToDo: This (undefined) function should contain the scavenge
-       * loop immediately below this block of code - but I'm not sure
-       * enough of the details to do this myself.
-       */
-      scavengeEverything();
-      /* revert dead CAFs and update enteredCAFs list */
-      revertDeadCAFs();
-#endif      
       markHugsObjects();
-#if 0
-      /* This will keep the CAFs and the attached BCOs alive 
-       * but the values will have been reverted
-       */
-      scavengeEverything();
-#endif
   }
 #endif
 
@@ -427,10 +456,18 @@ void GarbageCollect(void (*get_roots)(void))
     }
   }
 
-  /* Now see which stable names are still alive
+  /* Final traversal of the weak pointer list (see comment by
+   * cleanUpWeakPtrList below).
+   */
+  cleanup_weak_ptr_list(&weak_ptr_list);
+
+  /* Now see which stable names are still alive.
    */
   gcStablePtrTable(major_gc);
 
+  /* revert dead CAFs and update enteredCAFs list */
+  revert_dead_CAFs();
+  
   /* Set the maximum blocks for the oldest generation, based on twice
    * the amount of live data now, adjusted to fit the maximum heap
    * size if necessary.  
@@ -602,7 +639,7 @@ void GarbageCollect(void (*get_roots)(void))
       int pc_free; 
       
       adjusted_blocks = (RtsFlags.GcFlags.maxHeapSize - 2 * blocks);
-      IF_DEBUG(gc, fprintf(stderr, "Near maximum heap size of 0x%x blocks, blocks = %d, adjusted to %d\n", RtsFlags.GcFlags.maxHeapSize, blocks, adjusted_blocks));
+      IF_DEBUG(gc, fprintf(stderr, "@@ Near maximum heap size of 0x%x blocks, blocks = %d, adjusted to %d\n", RtsFlags.GcFlags.maxHeapSize, blocks, adjusted_blocks));
       pc_free = adjusted_blocks * 100 / RtsFlags.GcFlags.maxHeapSize;
       if (pc_free < RtsFlags.GcFlags.pcFreeHeap) /* might even be < 0 */ {
        heapOverflow();
@@ -659,28 +696,24 @@ void GarbageCollect(void (*get_roots)(void))
     }
   }
 
-  /* revert dead CAFs and update enteredCAFs list */
-  revertDeadCAFs();
-  
-  /* mark the garbage collected CAFs as dead */
+ /* mark the garbage collected CAFs as dead */
 #ifdef DEBUG
   if (major_gc) { gcCAFs(); }
 #endif
   
   /* zero the scavenged static object list */
   if (major_gc) {
-    zeroStaticObjectList(scavenged_static_objects);
+    zero_static_object_list(scavenged_static_objects);
   }
 
   /* Reset the nursery
    */
-  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));
-  }
-  current_nursery = g0s0->blocks;
+  resetNurseries();
+
+#if defined(PAR)
+  /* Reconstruct the Global Address tables used in GUM */
+  RebuildGAtables(major_gc);
+#endif
 
   /* start any pending finalizers */
   scheduleFinalizers(old_weak_ptr_list);
@@ -698,6 +731,7 @@ void GarbageCollect(void (*get_roots)(void))
 
   /* restore enclosing cost centre */
 #ifdef PROFILING
+  heapCensus();
   CCCS = prev_CCS;
 #endif
 
@@ -708,6 +742,9 @@ void GarbageCollect(void (*get_roots)(void))
   stat_endGC(allocated, collected, live, copied, N);
 }
 
+//@node Weak Pointers, Evacuation, Garbage Collect
+//@subsection Weak Pointers
+
 /* -----------------------------------------------------------------------------
    Weak Pointers
 
@@ -727,6 +764,7 @@ void GarbageCollect(void (*get_roots)(void))
    probably be optimised by keeping per-generation lists of weak
    pointers, but for a few weak pointers this scheme will work.
    -------------------------------------------------------------------------- */
+//@cindex traverse_weak_ptr_list
 
 static rtsBool 
 traverse_weak_ptr_list(void)
@@ -745,6 +783,27 @@ traverse_weak_ptr_list(void)
   last_w = &old_weak_ptr_list;
   for (w = old_weak_ptr_list; w; w = next_w) {
 
+    /* First, this weak pointer might have been evacuated.  If so,
+     * remove the forwarding pointer from the weak_ptr_list.
+     */
+    if (get_itbl(w)->type == EVACUATED) {
+      w = (StgWeak *)((StgEvacuated *)w)->evacuee;
+      *last_w = w;
+    }
+
+    /* There might be a DEAD_WEAK on the list if finalizeWeak# was
+     * called on a live weak pointer object.  Just remove it.
+     */
+    if (w->header.info == &DEAD_WEAK_info) {
+      next_w = ((StgDeadWeak *)w)->link;
+      *last_w = next_w;
+      continue;
+    }
+
+    ASSERT(get_itbl(w)->type == WEAK);
+
+    /* Now, check whether the key is reachable.
+     */
     if ((new = isAlive(w->key))) {
       w->key = new;
       /* evacuate the value and finalizer */
@@ -772,8 +831,8 @@ traverse_weak_ptr_list(void)
    * of pending finalizers later on.
    */
   if (flag == rtsFalse) {
+    cleanup_weak_ptr_list(&old_weak_ptr_list);
     for (w = old_weak_ptr_list; w; w = w->link) {
-      w->value = evacuate(w->value);
       w->finalizer = evacuate(w->finalizer);
     }
     weak_done = rtsTrue;
@@ -783,15 +842,52 @@ traverse_weak_ptr_list(void)
 }
 
 /* -----------------------------------------------------------------------------
+   After GC, the live weak pointer list may have forwarding pointers
+   on it, because a weak pointer object was evacuated after being
+   moved to the live weak pointer list.  We remove those forwarding
+   pointers here.
+
+   Also, we don't consider weak pointer objects to be reachable, but
+   we must nevertheless consider them to be "live" and retain them.
+   Therefore any weak pointer objects which haven't as yet been
+   evacuated need to be evacuated now.
+   -------------------------------------------------------------------------- */
+
+//@cindex cleanup_weak_ptr_list
+
+static void
+cleanup_weak_ptr_list ( StgWeak **list )
+{
+  StgWeak *w, **last_w;
+
+  last_w = list;
+  for (w = *list; w; w = w->link) {
+
+    if (get_itbl(w)->type == EVACUATED) {
+      w = (StgWeak *)((StgEvacuated *)w)->evacuee;
+      *last_w = w;
+    }
+
+    if (Bdescr((P_)w)->evacuated == 0) {
+      (StgClosure *)w = evacuate((StgClosure *)w);
+      *last_w = w;
+    }
+    last_w = &(w->link);
+  }
+}
+
+/* -----------------------------------------------------------------------------
    isAlive determines whether the given closure is still alive (after
    a garbage collection) or not.  It returns the new address of the
    closure if it is alive, or NULL otherwise.
    -------------------------------------------------------------------------- */
 
+//@cindex isAlive
+
 StgClosure *
 isAlive(StgClosure *p)
 {
-  StgInfoTable *info;
+  const StgInfoTable *info;
 
   while (1) {
 
@@ -802,10 +898,14 @@ isAlive(StgClosure *p)
      * for static closures with an empty SRT or CONSTR_STATIC_NOCAFs.
      */
 
+#if 1 || !defined(PAR)
     /* ignore closures in generations that we're not collecting. */
+    /* In GUM we use this routine when rebuilding GA tables; for some
+       reason it has problems with the LOOKS_LIKE_STATIC macro -- HWL */
     if (LOOKS_LIKE_STATIC(p) || Bdescr((P_)p)->gen->no > N) {
       return p;
     }
+#endif
     
     switch (info->type) {
       
@@ -829,12 +929,14 @@ isAlive(StgClosure *p)
   }
 }
 
+//@cindex MarkRoot
 StgClosure *
 MarkRoot(StgClosure *root)
 {
   return evacuate(root);
 }
 
+//@cindex addBlock
 static void addBlock(step *step)
 {
   bdescr *bd = allocBlock();
@@ -856,6 +958,8 @@ static void addBlock(step *step)
   new_blocks++;
 }
 
+//@cindex upd_evacuee
+
 static __inline__ void 
 upd_evacuee(StgClosure *p, StgClosure *dest)
 {
@@ -863,6 +967,8 @@ upd_evacuee(StgClosure *p, StgClosure *dest)
   ((StgEvacuated *)p)->evacuee = dest;
 }
 
+//@cindex copy
+
 static __inline__ StgClosure *
 copy(StgClosure *src, nat size, step *step)
 {
@@ -904,6 +1010,8 @@ copy(StgClosure *src, nat size, step *step)
  * used to optimise evacuation of BLACKHOLEs.
  */
 
+//@cindex copyPart
+
 static __inline__ StgClosure *
 copyPart(StgClosure *src, nat size_to_reserve, nat size_to_copy, step *step)
 {
@@ -932,6 +1040,9 @@ copyPart(StgClosure *src, nat size_to_reserve, nat size_to_copy, step *step)
   return (StgClosure *)dest;
 }
 
+//@node Evacuation, Scavenging, Weak Pointers
+//@subsection Evacuation
+
 /* -----------------------------------------------------------------------------
    Evacuate a large object
 
@@ -943,6 +1054,8 @@ copyPart(StgClosure *src, nat size_to_reserve, nat size_to_copy, step *step)
    evacuated, or 0 otherwise.
    -------------------------------------------------------------------------- */
 
+//@cindex evacuate_large
+
 static inline void
 evacuate_large(StgPtr p, rtsBool mutable)
 {
@@ -1005,6 +1118,8 @@ evacuate_large(StgPtr p, rtsBool mutable)
    the promotion until the next GC.
    -------------------------------------------------------------------------- */
 
+//@cindex mkMutCons
+
 static StgClosure *
 mkMutCons(StgClosure *ptr, generation *gen)
 {
@@ -1054,7 +1169,7 @@ mkMutCons(StgClosure *ptr, generation *gen)
                          didn't manage to evacuate this object into evac_gen.
 
    -------------------------------------------------------------------------- */
-
+//@cindex evacuate
 
 static StgClosure *
 evacuate(StgClosure *q)
@@ -1065,7 +1180,7 @@ evacuate(StgClosure *q)
   const StgInfoTable *info;
 
 loop:
-  if (!LOOKS_LIKE_STATIC(q)) {
+  if (HEAP_ALLOCED(q)) {
     bd = Bdescr((P_)q);
     if (bd->gen->no > N) {
       /* Can't evacuate this object, because it's in a generation
@@ -1081,16 +1196,38 @@ loop:
     }
     step = bd->step->to;
   }
+#ifdef DEBUG
+  else step = NULL; /* make sure copy() will crash if HEAP_ALLOCED is wrong */
+#endif
 
   /* make sure the info pointer is into text space */
   ASSERT(q && (LOOKS_LIKE_GHC_INFO(GET_INFO(q))
               || IS_HUGS_CONSTR_INFO(GET_INFO(q))));
-
   info = get_itbl(q);
+  /*
+  if (info->type==RBH) {
+    info = REVERT_INFOPTR(info);
+    IF_DEBUG(gc,
+            belch("@_ Trying to evacuate an RBH %p (%s); reverting to IP %p (%s)",
+                    q, info_type(q), info, info_type_by_ip(info)));
+  }
+  */
+  
   switch (info -> type) {
 
   case BCO:
-    return copy(q,bco_sizeW(stgCast(StgBCO*,q)),step);
+    {
+      nat size = bco_sizeW((StgBCO*)q);
+
+      if (size >= LARGE_OBJECT_THRESHOLD/sizeof(W_)) {
+       evacuate_large((P_)q, rtsFalse);
+       to = q;
+      } else {
+       /* just copy the block */
+       to = copy(q,size,step);
+      }
+      return to;
+    }
 
   case MUT_VAR:
     ASSERT(q->header.info != &MUT_CONS_info);
@@ -1099,10 +1236,6 @@ loop:
     recordMutable((StgMutClosure *)to);
     return to;
 
-  case STABLE_NAME:
-    stable_ptr_table[((StgStableName *)q)->sn].keep = rtsTrue;
-    return copy(q,sizeofW(StgStableName),step);
-
   case FUN_1_0:
   case FUN_0_1:
   case CONSTR_1_0:
@@ -1140,9 +1273,12 @@ loop:
   case CAF_ENTERED:
   case WEAK:
   case FOREIGN:
+  case STABLE_NAME:
     return copy(q,sizeW_fromITBL(info),step);
 
   case CAF_BLACKHOLE:
+  case SE_CAF_BLACKHOLE:
+  case SE_BLACKHOLE:
   case BLACKHOLE:
     return copyPart(q,BLACKHOLE_sizeW(),sizeofW(StgHeader),step);
 
@@ -1167,11 +1303,11 @@ loop:
       case CONSTR_0_2:
       case CONSTR_STATIC:
        { 
-         StgNat32 offset = info->layout.selector_offset;
+         StgWord32 offset = info->layout.selector_offset;
 
          /* check that the size is in range */
          ASSERT(offset < 
-                (StgNat32)(selectee_info->layout.payload.ptrs + 
+                (StgWord32)(selectee_info->layout.payload.ptrs + 
                            selectee_info->layout.payload.nptrs));
 
          /* perform the selection! */
@@ -1181,7 +1317,7 @@ loop:
           * with the evacuation, just update the source address with
           * a pointer to the (evacuated) constructor field.
           */
-         if (IS_USER_PTR(q)) {
+         if (HEAP_ALLOCED(q)) {
            bdescr *bd = Bdescr((P_)q);
            if (bd->evacuated) {
              if (bd->gen->no < evac_gen) {
@@ -1225,13 +1361,16 @@ loop:
        /* aargh - do recursively???? */
       case CAF_UNENTERED:
       case CAF_BLACKHOLE:
+      case SE_CAF_BLACKHOLE:
+      case SE_BLACKHOLE:
       case BLACKHOLE:
       case BLACKHOLE_BQ:
        /* not evaluated yet */
        break;
 
       default:
-       barf("evacuate: THUNK_SELECTOR: strange selectee");
+       barf("evacuate: THUNK_SELECTOR: strange selectee %d",
+            (int)(selectee_info->type));
       }
     }
     return copy(q,THUNK_SELECTOR_sizeW(),step);
@@ -1242,30 +1381,35 @@ loop:
     q = ((StgInd*)q)->indirectee;
     goto loop;
 
-    /* ToDo: optimise STATIC_LINK for known cases.
-       - FUN_STATIC       : payload[0]
-       - THUNK_STATIC     : payload[1]
-       - IND_STATIC       : payload[1]
-    */
   case THUNK_STATIC:
+    if (info->srt_len > 0 && major_gc && 
+       THUNK_STATIC_LINK((StgClosure *)q) == NULL) {
+      THUNK_STATIC_LINK((StgClosure *)q) = static_objects;
+      static_objects = (StgClosure *)q;
+    }
+    return q;
+
   case FUN_STATIC:
-    if (info->srt_len == 0) {  /* small optimisation */
-      return q;
+    if (info->srt_len > 0 && major_gc && 
+       FUN_STATIC_LINK((StgClosure *)q) == NULL) {
+      FUN_STATIC_LINK((StgClosure *)q) = static_objects;
+      static_objects = (StgClosure *)q;
     }
-    /* fall through */
-  case CONSTR_STATIC:
+    return q;
+
   case IND_STATIC:
-    /* don't want to evacuate these, but we do want to follow pointers
-     * from SRTs  - see scavenge_static.
-     */
+    if (major_gc && IND_STATIC_LINK((StgClosure *)q) == NULL) {
+      IND_STATIC_LINK((StgClosure *)q) = static_objects;
+      static_objects = (StgClosure *)q;
+    }
+    return q;
 
-    /* put the object on the static list, if necessary.
-     */
+  case CONSTR_STATIC:
     if (major_gc && STATIC_LINK(info,(StgClosure *)q) == NULL) {
       STATIC_LINK(info,(StgClosure *)q) = static_objects;
       static_objects = (StgClosure *)q;
     }
-    /* fall through */
+    return q;
 
   case CONSTR_INTLIKE:
   case CONSTR_CHARLIKE:
@@ -1286,7 +1430,7 @@ loop:
   case CATCH_FRAME:
   case SEQ_FRAME:
     /* shouldn't see these */
-    barf("evacuate: stack frame\n");
+    barf("evacuate: stack frame at %p\n", q);
 
   case AP_UPD:
   case PAP:
@@ -1305,7 +1449,7 @@ loop:
     if (evac_gen > 0) {                /* optimisation */
       StgClosure *p = ((StgEvacuated*)q)->evacuee;
       if (Bdescr((P_)p)->gen->no < evac_gen) {
-       /*      fprintf(stderr,"evac failed!\n");*/
+       IF_DEBUG(gc, belch("@@ evacuate: evac of EVACUATED node %p failed!", p));
        failed_to_evac = rtsTrue;
        TICK_GC_FAILED_PROMOTION();
       }
@@ -1345,10 +1489,17 @@ loop:
 
   case TSO:
     {
-      StgTSO *tso = stgCast(StgTSO *,q);
+      StgTSO *tso = (StgTSO *)q;
       nat size = tso_sizeW(tso);
       int diff;
 
+      /* Deal with redirected TSOs (a TSO that's had its stack enlarged).
+       */
+      if (tso->whatNext == ThreadRelocated) {
+       q = (StgClosure *)tso->link;
+       goto loop;
+      }
+
       /* Large TSOs don't get moved, so no relocation is required.
        */
       if (size >= LARGE_OBJECT_THRESHOLD/sizeof(W_)) {
@@ -1375,13 +1526,47 @@ loop:
       }
     }
 
+#if defined(PAR)
+  case RBH: // cf. BLACKHOLE_BQ
+    {
+      //StgInfoTable *rip = get_closure_info(q, &size, &ptrs, &nonptrs, &vhs, str);
+      to = copy(q,BLACKHOLE_sizeW(),step); 
+      //ToDo: derive size etc from reverted IP
+      //to = copy(q,size,step);
+      recordMutable((StgMutClosure *)to);
+      IF_DEBUG(gc,
+              belch("@@ evacuate: RBH %p (%s) to %p (%s)",
+                    q, info_type(q), to, info_type(to)));
+      return to;
+    }
+
   case BLOCKED_FETCH:
+    ASSERT(sizeofW(StgBlockedFetch) >= MIN_NONUPD_SIZE);
+    to = copy(q,sizeofW(StgBlockedFetch),step);
+    IF_DEBUG(gc,
+            belch("@@ evacuate: %p (%s) to %p (%s)",
+                  q, info_type(q), to, info_type(to)));
+    return to;
+
   case FETCH_ME:
-    fprintf(stderr,"evacuate: unimplemented/strange closure type\n");
-    return q;
+    ASSERT(sizeofW(StgBlockedFetch) >= MIN_UPD_SIZE);
+    to = copy(q,sizeofW(StgFetchMe),step);
+    IF_DEBUG(gc,
+            belch("@@ evacuate: %p (%s) to %p (%s)",
+                  q, info_type(q), to, info_type(to)));
+    return to;
+
+  case FETCH_ME_BQ:
+    ASSERT(sizeofW(StgBlockedFetch) >= MIN_UPD_SIZE);
+    to = copy(q,sizeofW(StgFetchMeBlockingQueue),step);
+    IF_DEBUG(gc,
+            belch("@@ evacuate: %p (%s) to %p (%s)",
+                  q, info_type(q), to, info_type(to)));
+    return to;
+#endif
 
   default:
-    barf("evacuate: strange closure type");
+    barf("evacuate: strange closure type %d", (int)(info->type));
   }
 
   barf("evacuate");
@@ -1391,6 +1576,7 @@ loop:
    relocate_TSO is called just after a TSO has been copied from src to
    dest.  It adjusts the update frame list for the new location.
    -------------------------------------------------------------------------- */
+//@cindex relocate_TSO
 
 StgTSO *
 relocate_TSO(StgTSO *src, StgTSO *dest)
@@ -1431,7 +1617,7 @@ relocate_TSO(StgTSO *src, StgTSO *dest)
       break;
 
     default:
-      barf("relocate_TSO");
+      barf("relocate_TSO %d", (int)(get_itbl(su)->type));
     }
     break;
   }
@@ -1439,6 +1625,11 @@ relocate_TSO(StgTSO *src, StgTSO *dest)
   return dest;
 }
 
+//@node Scavenging, Reverting CAFs, Evacuation
+//@subsection Scavenging
+
+//@cindex scavenge_srt
+
 static inline void
 scavenge_srt(const StgInfoTable *info)
 {
@@ -1451,8 +1642,47 @@ scavenge_srt(const StgInfoTable *info)
   srt = stgCast(StgClosure **,info->srt);
   srt_end = srt + info->srt_len;
   for (; srt < srt_end; srt++) {
-    evacuate(*srt);
+    /* Special-case to handle references to closures hiding out in DLLs, since
+       double indirections required to get at those. The code generator knows
+       which is which when generating the SRT, so it stores the (indirect)
+       reference to the DLL closure in the table by first adding one to it.
+       We check for this here, and undo the addition before evacuating it.
+
+       If the SRT entry hasn't got bit 0 set, the SRT entry points to a
+       closure that's fixed at link-time, and no extra magic is required.
+    */
+#ifdef ENABLE_WIN32_DLL_SUPPORT
+    if ( stgCast(unsigned long,*srt) & 0x1 ) {
+       evacuate(*stgCast(StgClosure**,(stgCast(unsigned long, *srt) & ~0x1)));
+    } else {
+       evacuate(*srt);
+    }
+#else
+       evacuate(*srt);
+#endif
+  }
+}
+
+/* -----------------------------------------------------------------------------
+   Scavenge a TSO.
+   -------------------------------------------------------------------------- */
+
+static void
+scavengeTSO (StgTSO *tso)
+{
+  /* chase the link field for any TSOs on the same queue */
+  (StgClosure *)tso->link = evacuate((StgClosure *)tso->link);
+  if (   tso->why_blocked == BlockedOnMVar
+        || tso->why_blocked == BlockedOnBlackHole
+        || tso->why_blocked == BlockedOnException) {
+    tso->block_info.closure = evacuate(tso->block_info.closure);
+  }
+  if ( tso->blocked_exceptions != NULL ) {
+    tso->blocked_exceptions = 
+      (StgTSO *)evacuate((StgClosure *)tso->blocked_exceptions);
   }
+  /* scavenge this thread's stack */
+  scavenge_stack(tso->sp, &(tso->stack[tso->stack_size]));
 }
 
 /* -----------------------------------------------------------------------------
@@ -1467,7 +1697,7 @@ scavenge_srt(const StgInfoTable *info)
    scavenging a mutable object where early promotion isn't such a good
    idea.  
    -------------------------------------------------------------------------- */
-   
+//@cindex scavenge
 
 static void
 scavenge(step *step)
@@ -1501,6 +1731,11 @@ scavenge(step *step)
                 || IS_HUGS_CONSTR_INFO(GET_INFO((StgClosure *)p))));
 
     info = get_itbl((StgClosure *)p);
+    /*
+    if (info->type==RBH)
+      info = REVERT_INFOPTR(info);
+    */
+
     switch (info -> type) {
 
     case BCO:
@@ -1586,10 +1821,6 @@ scavenge(step *step)
     case WEAK:
     case FOREIGN:
     case STABLE_NAME:
-    case IND_PERM:
-    case IND_OLDGEN_PERM:
-    case CAF_UNENTERED:
-    case CAF_ENTERED:
       {
        StgPtr end;
 
@@ -1601,6 +1832,52 @@ scavenge(step *step)
        break;
       }
 
+    case IND_PERM:
+      if (step->gen->no != 0) {
+       SET_INFO(((StgClosure *)p), &IND_OLDGEN_PERM_info);
+      }
+      /* fall through */
+    case IND_OLDGEN_PERM:
+      ((StgIndOldGen *)p)->indirectee = 
+       evacuate(((StgIndOldGen *)p)->indirectee);
+      if (failed_to_evac) {
+       failed_to_evac = rtsFalse;
+       recordOldToNewPtrs((StgMutClosure *)p);
+      }
+      p += sizeofW(StgIndOldGen);
+      break;
+
+    case CAF_UNENTERED:
+      {
+       StgCAF *caf = (StgCAF *)p;
+
+       caf->body = evacuate(caf->body);
+       if (failed_to_evac) {
+         failed_to_evac = rtsFalse;
+         recordOldToNewPtrs((StgMutClosure *)p);
+       } else {
+         caf->mut_link = NULL;
+       }
+        p += sizeofW(StgCAF);
+       break;
+      }
+
+    case CAF_ENTERED:
+      {
+       StgCAF *caf = (StgCAF *)p;
+
+       caf->body = evacuate(caf->body);
+       caf->value = evacuate(caf->value);
+       if (failed_to_evac) {
+         failed_to_evac = rtsFalse;
+         recordOldToNewPtrs((StgMutClosure *)p);
+       } else {
+         caf->mut_link = NULL;
+       }
+        p += sizeofW(StgCAF);
+       break;
+      }
+
     case MUT_VAR:
       /* ignore MUT_CONSs */
       if (((StgMutVar *)p)->header.info != &MUT_CONS_info) {
@@ -1612,6 +1889,8 @@ scavenge(step *step)
       break;
 
     case CAF_BLACKHOLE:
+    case SE_CAF_BLACKHOLE:
+    case SE_BLACKHOLE:
     case BLACKHOLE:
        p += BLACKHOLE_sizeW();
        break;
@@ -1716,21 +1995,80 @@ scavenge(step *step)
 
     case TSO:
       { 
-       StgTSO *tso;
-       
-       tso = (StgTSO *)p;
+       StgTSO *tso = (StgTSO *)p;
        evac_gen = 0;
-       /* chase the link field for any TSOs on the same queue */
-       (StgClosure *)tso->link = evacuate((StgClosure *)tso->link);
-       /* scavenge this thread's stack */
-       scavenge_stack(tso->sp, &(tso->stack[tso->stack_size]));
+       scavengeTSO(tso);
        evac_gen = saved_evac_gen;
        p += tso_sizeW(tso);
        break;
       }
 
+#if defined(PAR)
+    case RBH: // cf. BLACKHOLE_BQ
+      { 
+       // nat size, ptrs, nonptrs, vhs;
+       // char str[80];
+       // StgInfoTable *rip = get_closure_info(p, &size, &ptrs, &nonptrs, &vhs, str);
+       StgRBH *rbh = (StgRBH *)p;
+       (StgClosure *)rbh->blocking_queue = 
+         evacuate((StgClosure *)rbh->blocking_queue);
+       if (failed_to_evac) {
+         failed_to_evac = rtsFalse;
+         recordMutable((StgMutClosure *)rbh);
+       }
+       IF_DEBUG(gc,
+                belch("@@ scavenge: RBH %p (%s) (new blocking_queue link=%p)",
+                      p, info_type(p), (StgClosure *)rbh->blocking_queue));
+       // ToDo: use size of reverted closure here!
+       p += BLACKHOLE_sizeW(); 
+       break;
+      }
+
     case BLOCKED_FETCH:
+      { 
+       StgBlockedFetch *bf = (StgBlockedFetch *)p;
+       /* follow the pointer to the node which is being demanded */
+       (StgClosure *)bf->node = 
+         evacuate((StgClosure *)bf->node);
+       /* follow the link to the rest of the blocking queue */
+       (StgClosure *)bf->link = 
+         evacuate((StgClosure *)bf->link);
+       if (failed_to_evac) {
+         failed_to_evac = rtsFalse;
+         recordMutable((StgMutClosure *)bf);
+       }
+       IF_DEBUG(gc,
+                belch("@@ scavenge: %p (%s); node is now %p; exciting, isn't it",
+                    bf, info_type((StgClosure *)bf), 
+                    bf->node, info_type(bf->node)));
+       p += sizeofW(StgBlockedFetch);
+       break;
+      }
+
     case FETCH_ME:
+      IF_DEBUG(gc,
+              belch("@@ scavenge: HWL claims nothing to do for %p (%s)",
+                    p, info_type((StgClosure *)p)));
+      p += sizeofW(StgFetchMe);
+      break; // nothing to do in this case
+
+    case FETCH_ME_BQ: // cf. BLACKHOLE_BQ
+      { 
+       StgFetchMeBlockingQueue *fmbq = (StgFetchMeBlockingQueue *)p;
+       (StgClosure *)fmbq->blocking_queue = 
+         evacuate((StgClosure *)fmbq->blocking_queue);
+       if (failed_to_evac) {
+         failed_to_evac = rtsFalse;
+         recordMutable((StgMutClosure *)fmbq);
+       }
+       IF_DEBUG(gc,
+                belch("@@ scavenge: %p (%s) exciting, isn't it",
+                    p, info_type((StgClosure *)p)));
+       p += sizeofW(StgFetchMeBlockingQueue);
+       break;
+      }
+#endif
+
     case EVACUATED:
       barf("scavenge: unimplemented/strange closure type\n");
 
@@ -1759,10 +2097,12 @@ scavenge(step *step)
    because they contain old-to-new generation pointers.  Only certain
    objects can have this property.
    -------------------------------------------------------------------------- */
+//@cindex scavenge_one
+
 static rtsBool
 scavenge_one(StgClosure *p)
 {
-  StgInfoTable *info;
+  const StgInfoTable *info;
   rtsBool no_luck;
 
   ASSERT(p && (LOOKS_LIKE_GHC_INFO(GET_INFO(p))
@@ -1770,6 +2110,11 @@ scavenge_one(StgClosure *p)
 
   info = get_itbl(p);
 
+  /* ngoq moHqu'! 
+  if (info->type==RBH)
+    info = REVERT_INFOPTR(info); // if it's an RBH, look at the orig closure
+  */
+
   switch (info -> type) {
 
   case FUN:
@@ -1795,7 +2140,6 @@ scavenge_one(StgClosure *p)
   case IND_PERM:
   case IND_OLDGEN_PERM:
   case CAF_UNENTERED:
-  case CAF_ENTERED:
     {
       StgPtr q, end;
       
@@ -1807,6 +2151,8 @@ scavenge_one(StgClosure *p)
     }
 
   case CAF_BLACKHOLE:
+  case SE_CAF_BLACKHOLE:
+  case SE_BLACKHOLE:
   case BLACKHOLE:
       break;
 
@@ -1855,11 +2201,12 @@ scavenge_one(StgClosure *p)
    generations older than the one being collected) as roots.  We also
    remove non-mutable objects from the mutable list at this point.
    -------------------------------------------------------------------------- */
+//@cindex scavenge_mut_once_list
 
 static void
 scavenge_mut_once_list(generation *gen)
 {
-  StgInfoTable *info;
+  const StgInfoTable *info;
   StgMutClosure *p, *next, *new_list;
 
   p = gen->mut_once_list;
@@ -1876,6 +2223,10 @@ scavenge_mut_once_list(generation *gen)
                 || IS_HUGS_CONSTR_INFO(GET_INFO(p))));
     
     info = get_itbl(p);
+    /*
+    if (info->type==RBH)
+      info = REVERT_INFOPTR(info); // if it's an RBH, look at the orig closure
+    */
     switch(info->type) {
       
     case IND_OLDGEN:
@@ -1887,7 +2238,8 @@ scavenge_mut_once_list(generation *gen)
       ((StgIndOldGen *)p)->indirectee = 
         evacuate(((StgIndOldGen *)p)->indirectee);
       
-#if 0
+#ifdef DEBUG
+      if (RtsFlags.DebugFlags.gc) 
       /* Debugging code to print out the size of the thing we just
        * promoted 
        */
@@ -1948,20 +2300,50 @@ scavenge_mut_once_list(generation *gen)
       } 
       continue;
       
+    case CAF_ENTERED:
+      { 
+       StgCAF *caf = (StgCAF *)p;
+       caf->body  = evacuate(caf->body);
+       caf->value = evacuate(caf->value);
+       if (failed_to_evac) {
+         failed_to_evac = rtsFalse;
+         p->mut_link = new_list;
+         new_list = p;
+       } else {
+         p->mut_link = NULL;
+       }
+      }
+      continue;
+
+    case CAF_UNENTERED:
+      { 
+       StgCAF *caf = (StgCAF *)p;
+       caf->body  = evacuate(caf->body);
+       if (failed_to_evac) {
+         failed_to_evac = rtsFalse;
+         p->mut_link = new_list;
+         new_list = p;
+       } else {
+          p->mut_link = NULL;
+        }
+      }
+      continue;
+
     default:
       /* shouldn't have anything else on the mutables list */
-      barf("scavenge_mut_once_list: strange object?");
+      barf("scavenge_mut_once_list: strange object? %d", (int)(info->type));
     }
   }
 
   gen->mut_once_list = new_list;
 }
 
+//@cindex scavenge_mutable_list
 
 static void
 scavenge_mutable_list(generation *gen)
 {
-  StgInfoTable *info;
+  const StgInfoTable *info;
   StgMutClosure *p, *next;
 
   p = gen->saved_mut_list;
@@ -1977,6 +2359,10 @@ scavenge_mutable_list(generation *gen)
                 || IS_HUGS_CONSTR_INFO(GET_INFO(p))));
     
     info = get_itbl(p);
+    /*
+    if (info->type==RBH)
+      info = REVERT_INFOPTR(info); // if it's an RBH, look at the orig closure
+    */
     switch(info->type) {
       
     case MUT_ARR_PTRS_FROZEN:
@@ -1986,6 +2372,10 @@ scavenge_mutable_list(generation *gen)
       {
        StgPtr end, q;
        
+       IF_DEBUG(gc,
+                belch("@@ scavenge_mut_list: scavenging MUT_ARR_PTRS_FROZEN %p; size: %#x ; next: %p",
+                      p, mut_arr_ptrs_sizeW((StgMutArrPtrs*)p), p->mut_link));
+
        end = (P_)p + mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
        evac_gen = gen->no;
        for (q = (P_)((StgMutArrPtrs *)p)->payload; q < end; q++) {
@@ -2008,6 +2398,10 @@ scavenge_mutable_list(generation *gen)
       {
        StgPtr end, q;
        
+       IF_DEBUG(gc,
+                belch("@@ scavenge_mut_list: scavenging MUT_ARR_PTRS %p; size: %#x ; next: %p",
+                      p, mut_arr_ptrs_sizeW((StgMutArrPtrs*)p), p->mut_link));
+
        end = (P_)p + mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
        for (q = (P_)((StgMutArrPtrs *)p)->payload; q < end; q++) {
          (StgClosure *)*q = evacuate((StgClosure *)*q);
@@ -2020,6 +2414,10 @@ scavenge_mutable_list(generation *gen)
        * it from the mutable list if possible by promoting whatever it
        * points to.
        */
+       IF_DEBUG(gc,
+                belch("@@ scavenge_mut_list: scavenging MUT_VAR %p; var: %p ; next: %p",
+                      p, ((StgMutVar *)p)->var, p->mut_link));
+
       ASSERT(p->header.info != &MUT_CONS_info);
       ((StgMutVar *)p)->var = evacuate(((StgMutVar *)p)->var);
       p->mut_link = gen->mut_list;
@@ -2029,6 +2427,11 @@ scavenge_mutable_list(generation *gen)
     case MVAR:
       {
        StgMVar *mvar = (StgMVar *)p;
+
+       IF_DEBUG(gc,
+                belch("@@ scavenge_mut_list: scavenging MAVR %p; head: %p; tail: %p; value: %p ; next: %p",
+                      mvar, mvar->head, mvar->tail, mvar->value, p->mut_link));
+
        (StgClosure *)mvar->head = evacuate((StgClosure *)mvar->head);
        (StgClosure *)mvar->tail = evacuate((StgClosure *)mvar->tail);
        (StgClosure *)mvar->value = evacuate((StgClosure *)mvar->value);
@@ -2038,19 +2441,10 @@ scavenge_mutable_list(generation *gen)
       }
 
     case TSO:
-      /* follow ptrs and remove this from the mutable list */
       { 
        StgTSO *tso = (StgTSO *)p;
 
-       /* Don't bother scavenging if this thread is dead 
-        */
-       if (!(tso->whatNext == ThreadComplete ||
-             tso->whatNext == ThreadKilled)) {
-         /* Don't need to chase the link field for any TSOs on the
-          * same queue. Just scavenge this thread's stack 
-          */
-         scavenge_stack(tso->sp, &(tso->stack[tso->stack_size]));
-       }
+       scavengeTSO(tso);
 
        /* Don't take this TSO off the mutable list - it might still
         * point to some younger objects (because we set evac_gen to 0
@@ -2064,6 +2458,11 @@ scavenge_mutable_list(generation *gen)
     case BLACKHOLE_BQ:
       { 
        StgBlockingQueue *bh = (StgBlockingQueue *)p;
+
+       IF_DEBUG(gc,
+                belch("@@ scavenge_mut_list: scavenging BLACKHOLE_BQ (%p); next: %p",
+                      p, p->mut_link));
+
        (StgClosure *)bh->blocking_queue = 
          evacuate((StgClosure *)bh->blocking_queue);
        p->mut_link = gen->mut_list;
@@ -2071,13 +2470,38 @@ scavenge_mutable_list(generation *gen)
        continue;
       }
 
+      /* Happens if a BLACKHOLE_BQ in the old generation is updated: 
+       */
+    case IND_OLDGEN:
+    case IND_OLDGEN_PERM:
+      /* Try to pull the indirectee into this generation, so we can
+       * remove the indirection from the mutable list.  
+       */
+      evac_gen = gen->no;
+      ((StgIndOldGen *)p)->indirectee = 
+        evacuate(((StgIndOldGen *)p)->indirectee);
+      evac_gen = 0;
+
+      if (failed_to_evac) {
+       failed_to_evac = rtsFalse;
+       p->mut_link = gen->mut_once_list;
+       gen->mut_once_list = p;
+      } else {
+       p->mut_link = NULL;
+      }
+      continue;
+
+    // HWL: old PAR code deleted here
+
     default:
       /* shouldn't have anything else on the mutables list */
-      barf("scavenge_mut_list: strange object?");
+      barf("scavenge_mutable_list: strange object? %d", (int)(info->type));
     }
   }
 }
 
+//@cindex scavenge_static
+
 static void
 scavenge_static(void)
 {
@@ -2093,7 +2517,10 @@ scavenge_static(void)
   while (p != END_OF_STATIC_LIST) {
 
     info = get_itbl(p);
-
+    /*
+    if (info->type==RBH)
+      info = REVERT_INFOPTR(info); // if it's an RBH, look at the orig closure
+    */
     /* make sure the info pointer is into text space */
     ASSERT(p && (LOOKS_LIKE_GHC_INFO(GET_INFO(p))
                 || IS_HUGS_CONSTR_INFO(GET_INFO(p))));
@@ -2162,13 +2589,16 @@ scavenge_static(void)
    objects pointed to by it.  We can use the same code for walking
    PAPs, since these are just sections of copied stack.
    -------------------------------------------------------------------------- */
+//@cindex scavenge_stack
 
 static void
 scavenge_stack(StgPtr p, StgPtr stack_end)
 {
   StgPtr q;
   const StgInfoTable* info;
-  StgNat32 bitmap;
+  StgWord32 bitmap;
+
+  IF_DEBUG(sanity, belch("  scavenging stack between %p and %p", p, stack_end));
 
   /* 
    * Each time around this loop, we are looking at a chunk of stack
@@ -2177,24 +2607,22 @@ scavenge_stack(StgPtr p, StgPtr stack_end)
    */
 
   while (p < stack_end) {
-    q = *stgCast(StgPtr*,p);
+    q = *(P_ *)p;
 
     /* If we've got a tag, skip over that many words on the stack */
-    if (IS_ARG_TAG(stgCast(StgWord,q))) {
+    if (IS_ARG_TAG((W_)q)) {
       p += ARG_SIZE(q);
       p++; continue;
     }
      
     /* Is q a pointer to a closure?
      */
-    if (! LOOKS_LIKE_GHC_INFO(q)) {
-
+    if (! LOOKS_LIKE_GHC_INFO(q) ) {
 #ifdef DEBUG
-      if (LOOKS_LIKE_STATIC(q)) { /* Is it a static closure? */
+      if ( 0 && LOOKS_LIKE_STATIC_CLOSURE(q) ) {  /* Is it a static closure? */
        ASSERT(closure_STATIC(stgCast(StgClosure*,q)));
-      } 
-      /* otherwise, must be a pointer into the allocation space.
-       */
+      }
+      /* otherwise, must be a pointer into the allocation space. */
 #endif
 
       (StgClosure *)*p = evacuate((StgClosure *)q);
@@ -2207,21 +2635,31 @@ scavenge_stack(StgPtr p, StgPtr stack_end)
      * record.  All activation records have 'bitmap' style layout
      * info.
      */
-    info  = get_itbl(stgCast(StgClosure*,p));
+    info  = get_itbl((StgClosure *)p);
       
     switch (info->type) {
        
       /* Dynamic bitmap: the mask is stored on the stack */
     case RET_DYN:
-      bitmap = stgCast(StgRetDyn*,p)->liveness;
-      p      = &payloadWord(stgCast(StgRetDyn*,p),0);
+      bitmap = ((StgRetDyn *)p)->liveness;
+      p      = (P_)&((StgRetDyn *)p)->payload[0];
       goto small_bitmap;
 
       /* probably a slow-entry point return address: */
     case FUN:
     case FUN_STATIC:
-      p++;
+      {
+#if 0  
+       StgPtr old_p = p;
+       p++; p++; 
+       IF_DEBUG(sanity, 
+                belch("HWL: scavenge_stack: FUN(_STATIC) adjusting p from %p to %p (instead of %p)",
+                      old_p, p, old_p+1));
+#else
+      p++; /* what if FHS!=1 !? -- HWL */
+#endif
       goto follow_srt;
+      }
 
       /* Specialised code for update frames, since they're so common.
        * We *know* the updatee points to a BLACKHOLE, CAF_BLACKHOLE,
@@ -2231,7 +2669,7 @@ scavenge_stack(StgPtr p, StgPtr stack_end)
       {
        StgUpdateFrame *frame = (StgUpdateFrame *)p;
        StgClosure *to;
-       StgClosureType type = get_itbl(frame->updatee)->type;
+       nat type = get_itbl(frame->updatee)->type;
 
        p += sizeofW(StgUpdateFrame);
        if (type == EVACUATED) {
@@ -2268,20 +2706,35 @@ scavenge_stack(StgPtr p, StgPtr stack_end)
            recordMutable((StgMutClosure *)to);
            continue;
          default:
+            /* will never be SE_{,CAF_}BLACKHOLE, since we
+               don't push an update frame for single-entry thunks.  KSW 1999-01. */
            barf("scavenge_stack: UPDATE_FRAME updatee");
          }
        }
       }
 
       /* small bitmap (< 32 entries, or 64 on a 64-bit machine) */
-    case RET_BCO:
-    case RET_SMALL:
-    case RET_VEC_SMALL:
     case STOP_FRAME:
     case CATCH_FRAME:
     case SEQ_FRAME:
+      {
+       // StgPtr old_p = p; // debugging only -- HWL
+      /* stack frames like these are ordinary closures and therefore may 
+        contain setup-specific fixed-header words (as in GranSim!);
+        therefore, these cases should not use p++ but &(p->payload) -- HWL */
+      // IF_DEBUG(gran, IF_DEBUG(sanity, printObj(p)));
+      bitmap = info->layout.bitmap;
+
+      p = (StgPtr)&(((StgClosure *)p)->payload);
+      // IF_DEBUG(sanity, belch("HWL: scavenge_stack: (STOP|CATCH|SEQ)_FRAME adjusting p from %p to %p (instead of %p)",                      old_p, p, old_p+1));
+      goto small_bitmap;
+      }
+    case RET_BCO:
+    case RET_SMALL:
+    case RET_VEC_SMALL:
       bitmap = info->layout.bitmap;
       p++;
+      /* this assumes that the payload starts immediately after the info-ptr */
     small_bitmap:
       while (bitmap != 0) {
        if ((bitmap & 1) == 0) {
@@ -2342,6 +2795,7 @@ scavenge_stack(StgPtr p, StgPtr stack_end)
   objects are (repeatedly) mutable, so most of the time evac_gen will
   be zero.
   --------------------------------------------------------------------------- */
+//@cindex scavenge_large
 
 static void
 scavenge_large(step *step)
@@ -2417,16 +2871,9 @@ scavenge_large(step *step)
       }
 
     case TSO:
-      { 
-       StgTSO *tso;
-       
-       tso = (StgTSO *)p;
-       /* chase the link field for any TSOs on the same queue */
-       (StgClosure *)tso->link = evacuate((StgClosure *)tso->link);
-       /* scavenge this thread's stack */
-       scavenge_stack(tso->sp, &(tso->stack[tso->stack_size]));
+       scavengeTSO((StgTSO *)p);
+        // HWL: old PAR code deleted here
        continue;
-      }
 
     default:
       barf("scavenge_large: unknown/strange object");
@@ -2434,8 +2881,10 @@ scavenge_large(step *step)
   }
 }
 
+//@cindex zero_static_object_list
+
 static void
-zeroStaticObjectList(StgClosure* first_static)
+zero_static_object_list(StgClosure* first_static)
 {
   StgClosure* p;
   StgClosure* link;
@@ -2456,8 +2905,10 @@ zeroStaticObjectList(StgClosure* first_static)
  * It doesn't do any harm to zero all the mutable link fields on the
  * mutable list.
  */
+//@cindex zero_mutable_list
+
 static void
-zeroMutableList(StgMutClosure *first)
+zero_mutable_list( StgMutClosure *first )
 {
   StgMutClosure *next, *c;
 
@@ -2467,9 +2918,13 @@ zeroMutableList(StgMutClosure *first)
   }
 }
 
+//@node Reverting CAFs, Sanity code for CAF garbage collection, Scavenging
+//@subsection Reverting CAFs
+
 /* -----------------------------------------------------------------------------
    Reverting CAFs
    -------------------------------------------------------------------------- */
+//@cindex RevertCAFs
 
 void RevertCAFs(void)
 {
@@ -2482,38 +2937,35 @@ void RevertCAFs(void)
     caf->value = stgCast(StgClosure*,0xdeadbeef);
     caf->link  = stgCast(StgCAF*,0xdeadbeef);
   }
+  enteredCAFs = END_CAF_LIST;
 }
 
-void revertDeadCAFs(void)
+//@cindex revert_dead_CAFs
+
+void revert_dead_CAFs(void)
 {
     StgCAF* caf = enteredCAFs;
     enteredCAFs = END_CAF_LIST;
     while (caf != END_CAF_LIST) {
-       StgCAF* next = caf->link;
-
-       switch(GET_INFO(caf)->type) {
-       case EVACUATED:
-           {
-               /* This object has been evacuated, it must be live. */
-               StgCAF* new = stgCast(StgCAF*,stgCast(StgEvacuated*,caf)->evacuee);
-               new->link = enteredCAFs;
-               enteredCAFs = new;
-               break;
-           }
-       case CAF_ENTERED:
-           {
-               SET_INFO(caf,&CAF_UNENTERED_info);
-               caf->value = stgCast(StgClosure*,0xdeadbeef);
-               caf->link  = stgCast(StgCAF*,0xdeadbeef);
-               break;
-           }
-       default:
-               barf("revertDeadCAFs: enteredCAFs list corrupted");
-       } 
-       caf = next;
+        StgCAF *next, *new;
+        next = caf->link;
+        new = (StgCAF*)isAlive((StgClosure*)caf);
+        if (new) {
+           new->link = enteredCAFs;
+           enteredCAFs = new;
+        } else {
+           /* ASSERT(0); */
+           SET_INFO(caf,&CAF_UNENTERED_info);
+           caf->value = (StgClosure*)0xdeadbeef;
+           caf->link  = (StgCAF*)0xdeadbeef;
+        } 
+        caf = next;
     }
 }
 
+//@node Sanity code for CAF garbage collection, Lazy black holing, Reverting CAFs
+//@subsection Sanity code for CAF garbage collection
+
 /* -----------------------------------------------------------------------------
    Sanity code for CAF garbage collection.
 
@@ -2527,6 +2979,8 @@ void revertDeadCAFs(void)
    -------------------------------------------------------------------------- */
 
 #ifdef DEBUG
+//@cindex gcCAFs
+
 static void
 gcCAFs(void)
 {
@@ -2564,6 +3018,9 @@ gcCAFs(void)
 }
 #endif
 
+//@node Lazy black holing, Stack squeezing, Sanity code for CAF garbage collection
+//@subsection Lazy black holing
+
 /* -----------------------------------------------------------------------------
    Lazy black holing.
 
@@ -2571,6 +3028,7 @@ gcCAFs(void)
    some work, we have to run down the stack and black-hole all the
    closures referred to by update frames.
    -------------------------------------------------------------------------- */
+//@cindex threadLazyBlackHole
 
 static void
 threadLazyBlackHole(StgTSO *tso)
@@ -2605,6 +3063,9 @@ threadLazyBlackHole(StgTSO *tso)
 
       if (bh->header.info != &BLACKHOLE_BQ_info &&
          bh->header.info != &CAF_BLACKHOLE_info) {
+#if (!defined(LAZY_BLACKHOLING)) && defined(DEBUG)
+        fprintf(stderr,"Unexpected lazy BHing required at 0x%04x\n",(int)bh);
+#endif
        SET_INFO(bh,&BLACKHOLE_info);
       }
 
@@ -2623,6 +3084,9 @@ threadLazyBlackHole(StgTSO *tso)
   }
 }
 
+//@node Stack squeezing, Pausing a thread, Lazy black holing
+//@subsection Stack squeezing
+
 /* -----------------------------------------------------------------------------
  * Stack squeezing
  *
@@ -2630,6 +3094,7 @@ threadLazyBlackHole(StgTSO *tso)
  * lazy black holing here.
  *
  * -------------------------------------------------------------------------- */
+//@cindex threadSqueezeStack
 
 static void
 threadSqueezeStack(StgTSO *tso)
@@ -2640,6 +3105,14 @@ threadSqueezeStack(StgTSO *tso)
   StgUpdateFrame *prev_frame;                  /* Temporally previous */
   StgPtr bottom;
   rtsBool prev_was_update_frame;
+#if DEBUG
+  StgUpdateFrame *top_frame;
+  nat upd_frames=0, stop_frames=0, catch_frames=0, seq_frames=0,
+      bhs=0, squeezes=0;
+  void printObj( StgClosure *obj ); // from Printer.c
+
+  top_frame  = tso->su;
+#endif
   
   bottom = &(tso->stack[tso->stack_size]);
   frame  = tso->su;
@@ -2659,11 +3132,36 @@ threadSqueezeStack(StgTSO *tso)
    */
   
   next_frame = NULL;
-  while ((P_)frame < bottom - 1) {  /* bottom - 1 is the STOP_FRAME */
+  /* bottom - sizeof(StgStopFrame) is the STOP_FRAME */
+  while ((P_)frame < bottom - sizeofW(StgStopFrame)) {  
     prev_frame = frame->link;
     frame->link = next_frame;
     next_frame = frame;
     frame = prev_frame;
+#if DEBUG
+    IF_DEBUG(sanity,
+            if (!(frame>=top_frame && frame<=(StgUpdateFrame *)bottom)) {
+              printObj((StgClosure *)prev_frame);
+              barf("threadSqueezeStack: current frame is rubbish %p; previous was %p\n", 
+                   frame, prev_frame);
+            })
+    switch (get_itbl(frame)->type) {
+    case UPDATE_FRAME: upd_frames++;
+                       if (frame->updatee->header.info == &BLACKHOLE_info)
+                        bhs++;
+                       break;
+    case STOP_FRAME:  stop_frames++;
+                      break;
+    case CATCH_FRAME: catch_frames++;
+                      break;
+    case SEQ_FRAME: seq_frames++;
+                    break;
+    default:
+      barf("Found non-frame during stack squeezing at %p (prev frame was %p)\n",
+          frame, prev_frame);
+      printObj((StgClosure *)prev_frame);
+    }
+#endif
     if (get_itbl(frame)->type == UPDATE_FRAME
        && frame->updatee->header.info == &BLACKHOLE_info) {
         break;
@@ -2713,8 +3211,9 @@ threadSqueezeStack(StgTSO *tso)
       StgClosure *updatee_keep   = prev_frame->updatee;
       StgClosure *updatee_bypass = frame->updatee;
       
-#if 0 /* DEBUG */
-      fprintf(stderr, "squeezing frame at %p\n", frame);
+#if DEBUG
+      IF_DEBUG(gc, fprintf(stderr, "@@ squeezing frame at %p\n", frame));
+      squeezes++;
 #endif
 
       /* Deal with blocking queues.  If both updatees have blocked
@@ -2727,7 +3226,12 @@ threadSqueezeStack(StgTSO *tso)
        * slower --SDM
        */
 #if 0 /* do it properly... */
-      if (GET_INFO(updatee_bypass) == BLACKHOLE_BQ_info) {
+#  if (!defined(LAZY_BLACKHOLING)) && defined(DEBUG)
+#    error Unimplemented lazy BH warning.  (KSW 1999-01)
+#  endif
+      if (GET_INFO(updatee_bypass) == BLACKHOLE_BQ_info
+         || GET_INFO(updatee_bypass) == CAF_BLACKHOLE_info
+         ) {
        /* Sigh.  It has one.  Don't lose those threads! */
          if (GET_INFO(updatee_keep) == BLACKHOLE_BQ_info) {
          /* Urgh.  Two queues.  Merge them. */
@@ -2752,7 +3256,11 @@ threadSqueezeStack(StgTSO *tso)
 #endif
 
       TICK_UPD_SQUEEZED();
-      UPD_IND(updatee_bypass, updatee_keep); /* this wakes the threads up */
+      /* wasn't there something about update squeezing and ticky to be
+       * sorted out?  oh yes: we aren't counting each enter properly
+       * in this case.  See the log somewhere.  KSW 1999-04-21
+       */
+      UPD_IND_NOLOCK(updatee_bypass, updatee_keep); /* this wakes the threads up */
       
       sp = (P_)frame - 1;      /* sp = stuff to slide */
       displacement += sizeofW(StgUpdateFrame);
@@ -2765,8 +3273,12 @@ threadSqueezeStack(StgTSO *tso)
        */
       if (is_update_frame) {
        StgBlockingQueue *bh = (StgBlockingQueue *)frame->updatee;
-       if (bh->header.info != &BLACKHOLE_BQ_info &&
+       if (bh->header.info != &BLACKHOLE_info &&
+           bh->header.info != &BLACKHOLE_BQ_info &&
            bh->header.info != &CAF_BLACKHOLE_info) {
+#if (!defined(LAZY_BLACKHOLING)) && defined(DEBUG)
+          fprintf(stderr,"Unexpected lazy BHing required at 0x%04x\n",(int)bh);
+#endif
          SET_INFO(bh,&BLACKHOLE_info);
        }
       }
@@ -2786,9 +3298,10 @@ threadSqueezeStack(StgTSO *tso)
       else
        next_frame_bottom = tso->sp - 1;
       
-#if 0 /* DEBUG */
-      fprintf(stderr, "sliding [%p, %p] by %ld\n", sp, next_frame_bottom,
-             displacement);
+#if DEBUG
+      IF_DEBUG(gc,
+              fprintf(stderr, "sliding [%p, %p] by %ld\n", sp, next_frame_bottom,
+                      displacement))
 #endif
       
       while (sp >= next_frame_bottom) {
@@ -2802,8 +3315,16 @@ threadSqueezeStack(StgTSO *tso)
 
   tso->sp += displacement;
   tso->su = prev_frame;
+#if DEBUG
+  IF_DEBUG(gc,
+          fprintf(stderr, "@@ threadSqueezeStack: squeezed %d update-frames; found %d BHs; found %d update-, %d stop-, %d catch, %d seq-frames\n",
+                  squeezes, bhs, upd_frames, stop_frames, catch_frames, seq_frames))
+#endif
 }
 
+//@node Pausing a thread, Index, Stack squeezing
+//@subsection Pausing a thread
+
 /* -----------------------------------------------------------------------------
  * Pausing a thread
  * 
@@ -2811,6 +3332,7 @@ threadSqueezeStack(StgTSO *tso)
  * here.  We also take the opportunity to do stack squeezing if it's
  * turned on.
  * -------------------------------------------------------------------------- */
+//@cindex threadPaused
 
 void
 threadPaused(StgTSO *tso)
@@ -2820,3 +3342,78 @@ threadPaused(StgTSO *tso)
   else
     threadLazyBlackHole(tso);
 }
+
+/* -----------------------------------------------------------------------------
+ * Debugging
+ * -------------------------------------------------------------------------- */
+
+#if DEBUG
+//@cindex printMutOnceList
+void
+printMutOnceList(generation *gen)
+{
+  StgMutClosure *p, *next;
+
+  p = gen->mut_once_list;
+  next = p->mut_link;
+
+  fprintf(stderr, "@@ Mut once list %p: ", gen->mut_once_list);
+  for (; p != END_MUT_LIST; p = next, next = p->mut_link) {
+    fprintf(stderr, "%p (%s), ", 
+           p, info_type((StgClosure *)p));
+  }
+  fputc('\n', stderr);
+}
+
+//@cindex printMutableList
+void
+printMutableList(generation *gen)
+{
+  StgMutClosure *p, *next;
+
+  p = gen->saved_mut_list;
+  next = p->mut_link;
+
+  fprintf(stderr, "@@ Mutable list %p: ", gen->saved_mut_list);
+  for (; p != END_MUT_LIST; p = next, next = p->mut_link) {
+    fprintf(stderr, "%p (%s), ",
+           p, info_type((StgClosure *)p));
+  }
+  fputc('\n', stderr);
+}
+#endif /* DEBUG */
+
+//@node Index,  , Pausing a thread
+//@subsection Index
+
+//@index
+//* GarbageCollect::  @cindex\s-+GarbageCollect
+//* MarkRoot::  @cindex\s-+MarkRoot
+//* RevertCAFs::  @cindex\s-+RevertCAFs
+//* addBlock::  @cindex\s-+addBlock
+//* cleanup_weak_ptr_list::  @cindex\s-+cleanup_weak_ptr_list
+//* copy::  @cindex\s-+copy
+//* copyPart::  @cindex\s-+copyPart
+//* evacuate::  @cindex\s-+evacuate
+//* evacuate_large::  @cindex\s-+evacuate_large
+//* gcCAFs::  @cindex\s-+gcCAFs
+//* isAlive::  @cindex\s-+isAlive
+//* mkMutCons::  @cindex\s-+mkMutCons
+//* relocate_TSO::  @cindex\s-+relocate_TSO
+//* revert_dead_CAFs::  @cindex\s-+revert_dead_CAFs
+//* scavenge::  @cindex\s-+scavenge
+//* scavenge_large::  @cindex\s-+scavenge_large
+//* scavenge_mut_once_list::  @cindex\s-+scavenge_mut_once_list
+//* scavenge_mutable_list::  @cindex\s-+scavenge_mutable_list
+//* scavenge_one::  @cindex\s-+scavenge_one
+//* scavenge_srt::  @cindex\s-+scavenge_srt
+//* scavenge_stack::  @cindex\s-+scavenge_stack
+//* scavenge_static::  @cindex\s-+scavenge_static
+//* threadLazyBlackHole::  @cindex\s-+threadLazyBlackHole
+//* threadPaused::  @cindex\s-+threadPaused
+//* threadSqueezeStack::  @cindex\s-+threadSqueezeStack
+//* traverse_weak_ptr_list::  @cindex\s-+traverse_weak_ptr_list
+//* upd_evacuee::  @cindex\s-+upd_evacuee
+//* zero_mutable_list::  @cindex\s-+zero_mutable_list
+//* zero_static_object_list::  @cindex\s-+zero_static_object_list
+//@end index