rts/sm/Evac.c

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team 1998-2008
   4  *
   5  * Generational garbage collector: evacuation functions
   6  *
   7  * Documentation on the architecture of the Garbage Collector can be
   8  * found in the online commentary:
   9  *
  10  *   http://hackage.haskell.org/trac/ghc/wiki/Commentary/Rts/Storage/GC
  11  *
  12  * ---------------------------------------------------------------------------*/
  13
  14 #include "PosixSource.h"
  15 #include "Rts.h"
  16
  17 #include "Evac.h"
  18 #include "Storage.h"
  19 #include "GC.h"
  20 #include "GCThread.h"
  21 #include "GCUtils.h"
  22 #include "Compact.h"
  23 #include "MarkStack.h"
  24 #include "Prelude.h"
  25 #include "Trace.h"
  26 #include "LdvProfile.h"
  27
  28 #if defined(PROF_SPIN) && defined(THREADED_RTS) && defined(PARALLEL_GC)
  29 StgWord64 whitehole_spin = 0;
  30 #endif
  31
  32 #if defined(THREADED_RTS) && !defined(PARALLEL_GC)
  33 #define evacuate(p) evacuate1(p)
  34 #define HEAP_ALLOCED_GC(p) HEAP_ALLOCED(p)
  35 #endif
  36
  37 #if !defined(PARALLEL_GC)
  38 #define copy_tag_nolock(p, info, src, size, stp, tag) \
  39         copy_tag(p, info, src, size, stp, tag)
  40 #endif
  41
  42 /* Used to avoid long recursion due to selector thunks
  43  */
  44 #define MAX_THUNK_SELECTOR_DEPTH 16
  45
  46 static void eval_thunk_selector (StgClosure **q, StgSelector * p, rtsBool);
  47 STATIC_INLINE void evacuate_large(StgPtr p);
  48
  49 /* -----------------------------------------------------------------------------
  50    Allocate some space in which to copy an object.
  51    -------------------------------------------------------------------------- */
  52
  53 STATIC_INLINE StgPtr
  54 alloc_for_copy (nat size, nat gen_no)
  55 {
  56     StgPtr to;
  57     gen_workspace *ws;
  58
  59     /* Find out where we're going, using the handy "to" pointer in
  60      * the gen of the source object.  If it turns out we need to
  61      * evacuate to an older generation, adjust it here (see comment
  62      * by evacuate()).
  63      */
  64     if (gen_no < gct->evac_gen_no) {
  65         if (gct->eager_promotion) {
  66             gen_no = gct->evac_gen_no;
  67         } else {
  68             gct->failed_to_evac = rtsTrue;
  69         }
  70     }
  71
  72     ws = &gct->gens[gen_no];  // zero memory references here
  73
  74     /* chain a new block onto the to-space for the destination gen if
  75      * necessary.
  76      */
  77     to = ws->todo_free;
  78     ws->todo_free += size;
  79     if (ws->todo_free > ws->todo_lim) {
  80         to = todo_block_full(size, ws);
  81     }
  82     ASSERT(ws->todo_free >= ws->todo_bd->free && ws->todo_free <= ws->todo_lim);
  83
  84     return to;
  85 }
  86
  87 /* -----------------------------------------------------------------------------
  88    The evacuate() code
  89    -------------------------------------------------------------------------- */
  90
  91 STATIC_INLINE GNUC_ATTR_HOT void
  92 copy_tag(StgClosure **p, const StgInfoTable *info,
  93          StgClosure *src, nat size, nat gen_no, StgWord tag)
  94 {
  95     StgPtr to, from;
  96     nat i;
  97
  98     to = alloc_for_copy(size,gen_no);
  99
 100     from = (StgPtr)src;
 101     to[0] = (W_)info;
 102     for (i = 1; i < size; i++) { // unroll for small i
 103         to[i] = from[i];
 104     }
 105
 106 //  if (to+size+2 < bd->start + BLOCK_SIZE_W) {
 107 //      __builtin_prefetch(to + size + 2, 1);
 108 //  }
 109
 110 #if defined(PARALLEL_GC)
 111     {
 112         const StgInfoTable *new_info;
 113         new_info = (const StgInfoTable *)cas((StgPtr)&src->header.info, (W_)info, MK_FORWARDING_PTR(to));
 114         if (new_info != info) {
 115             return evacuate(p); // does the failed_to_evac stuff
 116         } else {
 117             *p = TAG_CLOSURE(tag,(StgClosure*)to);
 118         }
 119     }
 120 #else
 121     src->header.info = (const StgInfoTable *)MK_FORWARDING_PTR(to);
 122     *p = TAG_CLOSURE(tag,(StgClosure*)to);
 123 #endif
 124
 125 #ifdef PROFILING
 126     // We store the size of the just evacuated object in the LDV word so that
 127     // the profiler can guess the position of the next object later.
 128     SET_EVACUAEE_FOR_LDV(from, size);
 129 #endif
 130 }
 131
 132 #if defined(PARALLEL_GC)
 133 STATIC_INLINE void
 134 copy_tag_nolock(StgClosure **p, const StgInfoTable *info,
 135          StgClosure *src, nat size, nat gen_no, StgWord tag)
 136 {
 137     StgPtr to, from;
 138     nat i;
 139
 140     to = alloc_for_copy(size,gen_no);
 141
 142     from = (StgPtr)src;
 143     to[0] = (W_)info;
 144     for (i = 1; i < size; i++) { // unroll for small i
 145         to[i] = from[i];
 146     }
 147
 148     // if somebody else reads the forwarding pointer, we better make
 149     // sure there's a closure at the end of it.
 150     write_barrier();
 151     *p = TAG_CLOSURE(tag,(StgClosure*)to);
 152     src->header.info = (const StgInfoTable *)MK_FORWARDING_PTR(to);
 153
 154 //  if (to+size+2 < bd->start + BLOCK_SIZE_W) {
 155 //      __builtin_prefetch(to + size + 2, 1);
 156 //  }
 157
 158 #ifdef PROFILING
 159     // We store the size of the just evacuated object in the LDV word so that
 160     // the profiler can guess the position of the next object later.
 161     SET_EVACUAEE_FOR_LDV(from, size);
 162 #endif
 163 }
 164 #endif
 165
 166 /* Special version of copy() for when we only want to copy the info
 167  * pointer of an object, but reserve some padding after it.  This is
 168  * used to optimise evacuation of TSOs.
 169  */
 170 static rtsBool
 171 copyPart(StgClosure **p, StgClosure *src, nat size_to_reserve,
 172          nat size_to_copy, nat gen_no)
 173 {
 174     StgPtr to, from;
 175     nat i;
 176     StgWord info;
 177
 178 #if defined(PARALLEL_GC)
 179 spin:
 180         info = xchg((StgPtr)&src->header.info, (W_)&stg_WHITEHOLE_info);
 181         if (info == (W_)&stg_WHITEHOLE_info) {
 182 #ifdef PROF_SPIN
 183             whitehole_spin++;
 184 #endif
 185             goto spin;
 186         }
 187     if (IS_FORWARDING_PTR(info)) {
 188         src->header.info = (const StgInfoTable *)info;
 189         evacuate(p); // does the failed_to_evac stuff
 190         return rtsFalse;
 191     }
 192 #else
 193     info = (W_)src->header.info;
 194 #endif
 195
 196     to = alloc_for_copy(size_to_reserve, gen_no);
 197
 198     from = (StgPtr)src;
 199     to[0] = info;
 200     for (i = 1; i < size_to_copy; i++) { // unroll for small i
 201         to[i] = from[i];
 202     }
 203
 204     write_barrier();
 205     src->header.info = (const StgInfoTable*)MK_FORWARDING_PTR(to);
 206     *p = (StgClosure *)to;
 207
 208 #ifdef PROFILING
 209     // We store the size of the just evacuated object in the LDV word so that
 210     // the profiler can guess the position of the next object later.
 211     SET_EVACUAEE_FOR_LDV(from, size_to_reserve);
 212     // fill the slop
 213     if (size_to_reserve - size_to_copy > 0)
 214         LDV_FILL_SLOP(to + size_to_copy, (int)(size_to_reserve - size_to_copy));
 215 #endif
 216
 217     return rtsTrue;
 218 }
 219
 220
 221 /* Copy wrappers that don't tag the closure after copying */
 222 STATIC_INLINE GNUC_ATTR_HOT void
 223 copy(StgClosure **p, const StgInfoTable *info,
 224      StgClosure *src, nat size, nat gen_no)
 225 {
 226     copy_tag(p,info,src,size,gen_no,0);
 227 }
 228
 229 /* -----------------------------------------------------------------------------
 230    Evacuate a large object
 231
 232    This just consists of removing the object from the (doubly-linked)
 233    gen->large_objects list, and linking it on to the (singly-linked)
 234    gen->new_large_objects list, from where it will be scavenged later.
 235
 236    Convention: bd->flags has BF_EVACUATED set for a large object
 237    that has been evacuated, or unset otherwise.
 238    -------------------------------------------------------------------------- */
 239
 240 STATIC_INLINE void
 241 evacuate_large(StgPtr p)
 242 {
 243   bdescr *bd;
 244   generation *gen, *new_gen;
 245   nat gen_no, new_gen_no;
 246   gen_workspace *ws;
 247
 248   bd = Bdescr(p);
 249   gen = bd->gen;
 250   gen_no = bd->gen_no;
 251   ACQUIRE_SPIN_LOCK(&gen->sync_large_objects);
 252
 253   // already evacuated?
 254   if (bd->flags & BF_EVACUATED) {
 255     /* Don't forget to set the gct->failed_to_evac flag if we didn't get
 256      * the desired destination (see comments in evacuate()).
 257      */
 258     if (gen_no < gct->evac_gen_no) {
 259         gct->failed_to_evac = rtsTrue;
 260         TICK_GC_FAILED_PROMOTION();
 261     }
 262     RELEASE_SPIN_LOCK(&gen->sync_large_objects);
 263     return;
 264   }
 265
 266   // remove from large_object list
 267   if (bd->u.back) {
 268     bd->u.back->link = bd->link;
 269   } else { // first object in the list
 270     gen->large_objects = bd->link;
 271   }
 272   if (bd->link) {
 273     bd->link->u.back = bd->u.back;
 274   }
 275
 276   /* link it on to the evacuated large object list of the destination gen
 277    */
 278   new_gen_no = bd->dest_no;
 279
 280   if (new_gen_no < gct->evac_gen_no) {
 281       if (gct->eager_promotion) {
 282           new_gen_no = gct->evac_gen_no;
 283       } else {
 284           gct->failed_to_evac = rtsTrue;
 285       }
 286   }
 287
 288   ws = &gct->gens[new_gen_no];
 289   new_gen = &generations[new_gen_no];
 290
 291   bd->flags |= BF_EVACUATED;
 292   initBdescr(bd, new_gen, new_gen->to);
 293
 294   // If this is a block of pinned objects, we don't have to scan
 295   // these objects, because they aren't allowed to contain any
 296   // pointers.  For these blocks, we skip the scavenge stage and put
 297   // them straight on the scavenged_large_objects list.
 298   if (bd->flags & BF_PINNED) {
 299       ASSERT(get_itbl((StgClosure *)p)->type == ARR_WORDS);
 300       if (new_gen != gen) { ACQUIRE_SPIN_LOCK(&new_gen->sync_large_objects); }
 301       dbl_link_onto(bd, &new_gen->scavenged_large_objects);
 302       new_gen->n_scavenged_large_blocks += bd->blocks;
 303       if (new_gen != gen) { RELEASE_SPIN_LOCK(&new_gen->sync_large_objects); }
 304   } else {
 305       bd->link = ws->todo_large_objects;
 306       ws->todo_large_objects = bd;
 307   }
 308
 309   RELEASE_SPIN_LOCK(&gen->sync_large_objects);
 310 }
 311
 312 /* ----------------------------------------------------------------------------
 313    Evacuate
 314
 315    This is called (eventually) for every live object in the system.
 316
 317    The caller to evacuate specifies a desired generation in the
 318    gct->evac_gen thread-local variable.  The following conditions apply to
 319    evacuating an object which resides in generation M when we're
 320    collecting up to generation N
 321
 322    if  M >= gct->evac_gen
 323            if  M > N     do nothing
 324            else          evac to gen->to
 325
 326    if  M < gct->evac_gen      evac to gct->evac_gen, step 0
 327
 328    if the object is already evacuated, then we check which generation
 329    it now resides in.
 330
 331    if  M >= gct->evac_gen     do nothing
 332    if  M <  gct->evac_gen     set gct->failed_to_evac flag to indicate that we
 333                          didn't manage to evacuate this object into gct->evac_gen.
 334
 335
 336    OPTIMISATION NOTES:
 337
 338    evacuate() is the single most important function performance-wise
 339    in the GC.  Various things have been tried to speed it up, but as
 340    far as I can tell the code generated by gcc 3.2 with -O2 is about
 341    as good as it's going to get.  We pass the argument to evacuate()
 342    in a register using the 'regparm' attribute (see the prototype for
 343    evacuate() near the top of this file).
 344
 345    Changing evacuate() to take an (StgClosure **) rather than
 346    returning the new pointer seems attractive, because we can avoid
 347    writing back the pointer when it hasn't changed (eg. for a static
 348    object, or an object in a generation > N).  However, I tried it and
 349    it doesn't help.  One reason is that the (StgClosure **) pointer
 350    gets spilled to the stack inside evacuate(), resulting in far more
 351    extra reads/writes than we save.
 352    ------------------------------------------------------------------------- */
 353
 354 REGPARM1 GNUC_ATTR_HOT void
 355 evacuate(StgClosure **p)
 356 {
 357   bdescr *bd = NULL;
 358   nat gen_no;
 359   StgClosure *q;
 360   const StgInfoTable *info;
 361   StgWord tag;
 362
 363   q = *p;
 364
 365 loop:
 366   /* The tag and the pointer are split, to be merged after evacing */
 367   tag = GET_CLOSURE_TAG(q);
 368   q = UNTAG_CLOSURE(q);
 369
 370   ASSERTM(LOOKS_LIKE_CLOSURE_PTR(q), "invalid closure, info=%p", q->header.info);
 371
 372   if (!HEAP_ALLOCED_GC(q)) {
 373
 374       if (!major_gc) return;
 375
 376       info = get_itbl(q);
 377       switch (info->type) {
 378
 379       case THUNK_STATIC:
 380           if (info->srt_bitmap != 0) {
 381               if (*THUNK_STATIC_LINK((StgClosure *)q) == NULL) {
 382 #ifndef THREADED_RTS
 383                   *THUNK_STATIC_LINK((StgClosure *)q) = gct->static_objects;
 384                   gct->static_objects = (StgClosure *)q;
 385 #else
 386                   StgPtr link;
 387                   link = (StgPtr)cas((StgPtr)THUNK_STATIC_LINK((StgClosure *)q),
 388                                      (StgWord)NULL,
 389                                      (StgWord)gct->static_objects);
 390                   if (link == NULL) {
 391                       gct->static_objects = (StgClosure *)q;
 392                   }
 393 #endif
 394               }
 395           }
 396           return;
 397
 398       case FUN_STATIC:
 399           if (info->srt_bitmap != 0 &&
 400               *FUN_STATIC_LINK((StgClosure *)q) == NULL) {
 401 #ifndef THREADED_RTS
 402               *FUN_STATIC_LINK((StgClosure *)q) = gct->static_objects;
 403               gct->static_objects = (StgClosure *)q;
 404 #else
 405               StgPtr link;
 406               link = (StgPtr)cas((StgPtr)FUN_STATIC_LINK((StgClosure *)q),
 407                                  (StgWord)NULL,
 408                                  (StgWord)gct->static_objects);
 409               if (link == NULL) {
 410                   gct->static_objects = (StgClosure *)q;
 411               }
 412 #endif
 413           }
 414           return;
 415
 416       case IND_STATIC:
 417           /* If q->saved_info != NULL, then it's a revertible CAF - it'll be
 418            * on the CAF list, so don't do anything with it here (we'll
 419            * scavenge it later).
 420            */
 421           if (*IND_STATIC_LINK((StgClosure *)q) == NULL) {
 422 #ifndef THREADED_RTS
 423                   *IND_STATIC_LINK((StgClosure *)q) = gct->static_objects;
 424                   gct->static_objects = (StgClosure *)q;
 425 #else
 426                   StgPtr link;
 427                   link = (StgPtr)cas((StgPtr)IND_STATIC_LINK((StgClosure *)q),
 428                                      (StgWord)NULL,
 429                                      (StgWord)gct->static_objects);
 430                   if (link == NULL) {
 431                       gct->static_objects = (StgClosure *)q;
 432                   }
 433 #endif
 434           }
 435           return;
 436
 437       case CONSTR_STATIC:
 438           if (*STATIC_LINK(info,(StgClosure *)q) == NULL) {
 439 #ifndef THREADED_RTS
 440               *STATIC_LINK(info,(StgClosure *)q) = gct->static_objects;
 441               gct->static_objects = (StgClosure *)q;
 442 #else
 443               StgPtr link;
 444               link = (StgPtr)cas((StgPtr)STATIC_LINK(info,(StgClosure *)q),
 445                                  (StgWord)NULL,
 446                                  (StgWord)gct->static_objects);
 447               if (link == NULL) {
 448                   gct->static_objects = (StgClosure *)q;
 449               }
 450 #endif
 451           }
 452           /* I am assuming that static_objects pointers are not
 453            * written to other objects, and thus, no need to retag. */
 454           return;
 455
 456       case CONSTR_NOCAF_STATIC:
 457           /* no need to put these on the static linked list, they don't need
 458            * to be scavenged.
 459            */
 460           return;
 461
 462       default:
 463           barf("evacuate(static): strange closure type %d", (int)(info->type));
 464       }
 465   }
 466
 467   bd = Bdescr((P_)q);
 468
 469   if ((bd->flags & (BF_LARGE | BF_MARKED | BF_EVACUATED)) != 0) {
 470
 471       // pointer into to-space: just return it.  It might be a pointer
 472       // into a generation that we aren't collecting (> N), or it
 473       // might just be a pointer into to-space.  The latter doesn't
 474       // happen often, but allowing it makes certain things a bit
 475       // easier; e.g. scavenging an object is idempotent, so it's OK to
 476       // have an object on the mutable list multiple times.
 477       if (bd->flags & BF_EVACUATED) {
 478           // We aren't copying this object, so we have to check
 479           // whether it is already in the target generation.  (this is
 480           // the write barrier).
 481           if (bd->gen_no < gct->evac_gen_no) {
 482               gct->failed_to_evac = rtsTrue;
 483               TICK_GC_FAILED_PROMOTION();
 484           }
 485           return;
 486       }
 487
 488       /* evacuate large objects by re-linking them onto a different list.
 489        */
 490       if (bd->flags & BF_LARGE) {
 491           evacuate_large((P_)q);
 492           return;
 493       }
 494
 495       /* If the object is in a gen that we're compacting, then we
 496        * need to use an alternative evacuate procedure.
 497        */
 498       if (!is_marked((P_)q,bd)) {
 499           mark((P_)q,bd);
 500           push_mark_stack((P_)q);
 501       }
 502       return;
 503   }
 504
 505   gen_no = bd->dest_no;
 506
 507   info = q->header.info;
 508   if (IS_FORWARDING_PTR(info))
 509   {
 510     /* Already evacuated, just return the forwarding address.
 511      * HOWEVER: if the requested destination generation (gct->evac_gen) is
 512      * older than the actual generation (because the object was
 513      * already evacuated to a younger generation) then we have to
 514      * set the gct->failed_to_evac flag to indicate that we couldn't
 515      * manage to promote the object to the desired generation.
 516      */
 517     /*
 518      * Optimisation: the check is fairly expensive, but we can often
 519      * shortcut it if either the required generation is 0, or the
 520      * current object (the EVACUATED) is in a high enough generation.
 521      * We know that an EVACUATED always points to an object in the
 522      * same or an older generation.  gen is the lowest generation that the
 523      * current object would be evacuated to, so we only do the full
 524      * check if gen is too low.
 525      */
 526       StgClosure *e = (StgClosure*)UN_FORWARDING_PTR(info);
 527       *p = TAG_CLOSURE(tag,e);
 528       if (gen_no < gct->evac_gen_no) {  // optimisation
 529           if (Bdescr((P_)e)->gen_no < gct->evac_gen_no) {
 530               gct->failed_to_evac = rtsTrue;
 531               TICK_GC_FAILED_PROMOTION();
 532           }
 533       }
 534       return;
 535   }
 536
 537   switch (INFO_PTR_TO_STRUCT(info)->type) {
 538
 539   case WHITEHOLE:
 540       goto loop;
 541
 542   case MUT_VAR_CLEAN:
 543   case MUT_VAR_DIRTY:
 544   case MVAR_CLEAN:
 545   case MVAR_DIRTY:
 546       copy(p,info,q,sizeW_fromITBL(INFO_PTR_TO_STRUCT(info)),gen_no);
 547       return;
 548
 549   // For ints and chars of low value, save space by replacing references to
 550   //    these with closures with references to common, shared ones in the RTS.
 551   //
 552   // * Except when compiling into Windows DLLs which don't support cross-package
 553   //    data references very well.
 554   //
 555   case CONSTR_0_1:
 556   {
 557 #if defined(__PIC__) && defined(mingw32_HOST_OS)
 558       copy_tag_nolock(p,info,q,sizeofW(StgHeader)+1,gen_no,tag);
 559 #else
 560       StgWord w = (StgWord)q->payload[0];
 561       if (info == Czh_con_info &&
 562           // unsigned, so always true:  (StgChar)w >= MIN_CHARLIKE &&
 563           (StgChar)w <= MAX_CHARLIKE) {
 564           *p =  TAG_CLOSURE(tag,
 565                             (StgClosure *)CHARLIKE_CLOSURE((StgChar)w)
 566                            );
 567       }
 568       else if (info == Izh_con_info &&
 569           (StgInt)w >= MIN_INTLIKE && (StgInt)w <= MAX_INTLIKE) {
 570           *p = TAG_CLOSURE(tag,
 571                              (StgClosure *)INTLIKE_CLOSURE((StgInt)w)
 572                              );
 573       }
 574       else {
 575           copy_tag_nolock(p,info,q,sizeofW(StgHeader)+1,gen_no,tag);
 576       }
 577 #endif
 578       return;
 579   }
 580
 581   case FUN_0_1:
 582   case FUN_1_0:
 583   case CONSTR_1_0:
 584       copy_tag_nolock(p,info,q,sizeofW(StgHeader)+1,gen_no,tag);
 585       return;
 586
 587   case THUNK_1_0:
 588   case THUNK_0_1:
 589       copy(p,info,q,sizeofW(StgThunk)+1,gen_no);
 590       return;
 591
 592   case THUNK_1_1:
 593   case THUNK_2_0:
 594   case THUNK_0_2:
 595 #ifdef NO_PROMOTE_THUNKS
 596 #error bitrotted
 597 #endif
 598     copy(p,info,q,sizeofW(StgThunk)+2,gen_no);
 599     return;
 600
 601   case FUN_1_1:
 602   case FUN_2_0:
 603   case FUN_0_2:
 604   case CONSTR_1_1:
 605   case CONSTR_2_0:
 606       copy_tag_nolock(p,info,q,sizeofW(StgHeader)+2,gen_no,tag);
 607       return;
 608
 609   case CONSTR_0_2:
 610       copy_tag_nolock(p,info,q,sizeofW(StgHeader)+2,gen_no,tag);
 611       return;
 612
 613   case THUNK:
 614       copy(p,info,q,thunk_sizeW_fromITBL(INFO_PTR_TO_STRUCT(info)),gen_no);
 615       return;
 616
 617   case FUN:
 618   case IND_PERM:
 619   case CONSTR:
 620       copy_tag_nolock(p,info,q,sizeW_fromITBL(INFO_PTR_TO_STRUCT(info)),gen_no,tag);
 621       return;
 622
 623   case BLACKHOLE:
 624   {
 625       StgClosure *r;
 626       const StgInfoTable *i;
 627       r = ((StgInd*)q)->indirectee;
 628       if (GET_CLOSURE_TAG(r) == 0) {
 629           i = r->header.info;
 630           if (IS_FORWARDING_PTR(i)) {
 631               r = (StgClosure *)UN_FORWARDING_PTR(i);
 632               i = r->header.info;
 633           }
 634           if (i == &stg_TSO_info
 635               || i == &stg_WHITEHOLE_info
 636               || i == &stg_BLOCKING_QUEUE_CLEAN_info
 637               || i == &stg_BLOCKING_QUEUE_DIRTY_info) {
 638               copy(p,info,q,sizeofW(StgInd),gen_no);
 639               return;
 640           }
 641           ASSERT(i != &stg_IND_info);
 642       }
 643       q = r;
 644       *p = r;
 645       goto loop;
 646   }
 647
 648   case BLOCKING_QUEUE:
 649   case WEAK:
 650   case PRIM:
 651   case MUT_PRIM:
 652       copy(p,info,q,sizeW_fromITBL(INFO_PTR_TO_STRUCT(info)),gen_no);
 653       return;
 654
 655   case BCO:
 656       copy(p,info,q,bco_sizeW((StgBCO *)q),gen_no);
 657       return;
 658
 659   case THUNK_SELECTOR:
 660       eval_thunk_selector(p, (StgSelector *)q, rtsTrue);
 661       return;
 662
 663   case IND:
 664     // follow chains of indirections, don't evacuate them
 665     q = ((StgInd*)q)->indirectee;
 666     *p = q;
 667     goto loop;
 668
 669   case RET_BCO:
 670   case RET_SMALL:
 671   case RET_BIG:
 672   case RET_DYN:
 673   case UPDATE_FRAME:
 674   case UNDERFLOW_FRAME:
 675   case STOP_FRAME:
 676   case CATCH_FRAME:
 677   case CATCH_STM_FRAME:
 678   case CATCH_RETRY_FRAME:
 679   case ATOMICALLY_FRAME:
 680     // shouldn't see these
 681     barf("evacuate: stack frame at %p\n", q);
 682
 683   case PAP:
 684       copy(p,info,q,pap_sizeW((StgPAP*)q),gen_no);
 685       return;
 686
 687   case AP:
 688       copy(p,info,q,ap_sizeW((StgAP*)q),gen_no);
 689       return;
 690
 691   case AP_STACK:
 692       copy(p,info,q,ap_stack_sizeW((StgAP_STACK*)q),gen_no);
 693       return;
 694
 695   case ARR_WORDS:
 696       // just copy the block
 697       copy(p,info,q,arr_words_sizeW((StgArrWords *)q),gen_no);
 698       return;
 699
 700   case MUT_ARR_PTRS_CLEAN:
 701   case MUT_ARR_PTRS_DIRTY:
 702   case MUT_ARR_PTRS_FROZEN:
 703   case MUT_ARR_PTRS_FROZEN0:
 704       // just copy the block
 705       copy(p,info,q,mut_arr_ptrs_sizeW((StgMutArrPtrs *)q),gen_no);
 706       return;
 707
 708   case TSO:
 709       copy(p,info,q,sizeofW(StgTSO),gen_no);
 710       return;
 711
 712   case STACK:
 713     {
 714       StgStack *stack = (StgStack *)q;
 715
 716       /* To evacuate a small STACK, we need to adjust the stack pointer
 717        */
 718       {
 719           StgStack *new_stack;
 720           StgPtr r, s;
 721           rtsBool mine;
 722
 723           mine = copyPart(p,(StgClosure *)stack, stack_sizeW(stack),
 724                           sizeofW(StgStack), gen_no);
 725           if (mine) {
 726               new_stack = (StgStack *)*p;
 727               move_STACK(stack, new_stack);
 728               for (r = stack->sp, s = new_stack->sp;
 729                    r < stack->stack + stack->stack_size;) {
 730                   *s++ = *r++;
 731               }
 732           }
 733           return;
 734       }
 735     }
 736
 737   case TREC_CHUNK:
 738       copy(p,info,q,sizeofW(StgTRecChunk),gen_no);
 739       return;
 740
 741   default:
 742     barf("evacuate: strange closure type %d", (int)(INFO_PTR_TO_STRUCT(info)->type));
 743   }
 744
 745   barf("evacuate");
 746 }
 747
 748 /* -----------------------------------------------------------------------------
 749    Evaluate a THUNK_SELECTOR if possible.
 750
 751    p points to a THUNK_SELECTOR that we want to evaluate.  The
 752    result of "evaluating" it will be evacuated and a pointer to the
 753    to-space closure will be returned.
 754
 755    If the THUNK_SELECTOR could not be evaluated (its selectee is still
 756    a THUNK, for example), then the THUNK_SELECTOR itself will be
 757    evacuated.
 758    -------------------------------------------------------------------------- */
 759 static void
 760 unchain_thunk_selectors(StgSelector *p, StgClosure *val)
 761 {
 762     StgSelector *prev;
 763
 764     prev = NULL;
 765     while (p)
 766     {
 767         ASSERT(p->header.info == &stg_WHITEHOLE_info);
 768         // val must be in to-space.  Not always: when we recursively
 769         // invoke eval_thunk_selector(), the recursive calls will not
 770         // evacuate the value (because we want to select on the value,
 771         // not evacuate it), so in this case val is in from-space.
 772         // ASSERT(!HEAP_ALLOCED_GC(val) || Bdescr((P_)val)->gen_no > N || (Bdescr((P_)val)->flags & BF_EVACUATED));
 773
 774         prev = (StgSelector*)((StgClosure *)p)->payload[0];
 775
 776         // Update the THUNK_SELECTOR with an indirection to the
 777         // value.  The value is still in from-space at this stage.
 778         //
 779         // (old note: Why not do upd_evacuee(q,p)?  Because we have an
 780         // invariant that an EVACUATED closure always points to an
 781         // object in the same or an older generation (required by
 782         // the short-cut test in the EVACUATED case, below).
 783         if ((StgClosure *)p == val) {
 784             // must be a loop; just leave a BLACKHOLE in place.  This
 785             // can happen when we have a chain of selectors that
 786             // eventually loops back on itself.  We can't leave an
 787             // indirection pointing to itself, and we want the program
 788             // to deadlock if it ever enters this closure, so
 789             // BLACKHOLE is correct.
 790
 791             // XXX we do not have BLACKHOLEs any more; replace with
 792             // a THUNK_SELECTOR again.  This will go into a loop if it is
 793             // entered, and should result in a NonTermination exception.
 794             ((StgThunk *)p)->payload[0] = val;
 795             write_barrier();
 796             SET_INFO(p, &stg_sel_0_upd_info);
 797         } else {
 798             ((StgInd *)p)->indirectee = val;
 799             write_barrier();
 800             SET_INFO(p, &stg_IND_info);
 801         }
 802
 803         // For the purposes of LDV profiling, we have created an
 804         // indirection.
 805         LDV_RECORD_CREATE(p);
 806
 807         p = prev;
 808     }
 809 }
 810
 811 static void
 812 eval_thunk_selector (StgClosure **q, StgSelector * p, rtsBool evac)
 813                  // NB. for legacy reasons, p & q are swapped around :(
 814 {
 815     nat field;
 816     StgInfoTable *info;
 817     StgWord info_ptr;
 818     StgClosure *selectee;
 819     StgSelector *prev_thunk_selector;
 820     bdescr *bd;
 821     StgClosure *val;
 822
 823     prev_thunk_selector = NULL;
 824     // this is a chain of THUNK_SELECTORs that we are going to update
 825     // to point to the value of the current THUNK_SELECTOR.  Each
 826     // closure on the chain is a WHITEHOLE, and points to the next in the
 827     // chain with payload[0].
 828
 829 selector_chain:
 830
 831     bd = Bdescr((StgPtr)p);
 832     if (HEAP_ALLOCED_GC(p)) {
 833         // If the THUNK_SELECTOR is in to-space or in a generation that we
 834         // are not collecting, then bale out early.  We won't be able to
 835         // save any space in any case, and updating with an indirection is
 836         // trickier in a non-collected gen: we would have to update the
 837         // mutable list.
 838         if (bd->flags & BF_EVACUATED) {
 839             unchain_thunk_selectors(prev_thunk_selector, (StgClosure *)p);
 840             *q = (StgClosure *)p;
 841             // shortcut, behave as for:  if (evac) evacuate(q);
 842             if (evac && bd->gen_no < gct->evac_gen_no) {
 843                 gct->failed_to_evac = rtsTrue;
 844                 TICK_GC_FAILED_PROMOTION();
 845             }
 846             return;
 847         }
 848         // we don't update THUNK_SELECTORS in the compacted
 849         // generation, because compaction does not remove the INDs
 850         // that result, this causes confusion later
 851         // (scavenge_mark_stack doesn't deal with IND).  BEWARE!  This
 852         // bit is very tricky to get right.  If you make changes
 853         // around here, test by compiling stage 3 with +RTS -c -RTS.
 854         if (bd->flags & BF_MARKED) {
 855             // must call evacuate() to mark this closure if evac==rtsTrue
 856             *q = (StgClosure *)p;
 857             if (evac) evacuate(q);
 858             unchain_thunk_selectors(prev_thunk_selector, (StgClosure *)p);
 859             return;
 860         }
 861     }
 862
 863
 864     // WHITEHOLE the selector thunk, since it is now under evaluation.
 865     // This is important to stop us going into an infinite loop if
 866     // this selector thunk eventually refers to itself.
 867 #if defined(THREADED_RTS)
 868     // In threaded mode, we'll use WHITEHOLE to lock the selector
 869     // thunk while we evaluate it.
 870     {
 871         do {
 872             info_ptr = xchg((StgPtr)&p->header.info, (W_)&stg_WHITEHOLE_info);
 873         } while (info_ptr == (W_)&stg_WHITEHOLE_info);
 874
 875         // make sure someone else didn't get here first...
 876         if (IS_FORWARDING_PTR(info_ptr) ||
 877             INFO_PTR_TO_STRUCT(info_ptr)->type != THUNK_SELECTOR) {
 878             // v. tricky now.  The THUNK_SELECTOR has been evacuated
 879             // by another thread, and is now either a forwarding ptr or IND.
 880             // We need to extract ourselves from the current situation
 881             // as cleanly as possible.
 882             //   - unlock the closure
 883             //   - update *q, we may have done *some* evaluation
 884             //   - if evac, we need to call evacuate(), because we
 885             //     need the write-barrier stuff.
 886             //   - undo the chain we've built to point to p.
 887             SET_INFO(p, (const StgInfoTable *)info_ptr);
 888             *q = (StgClosure *)p;
 889             if (evac) evacuate(q);
 890             unchain_thunk_selectors(prev_thunk_selector, (StgClosure *)p);
 891             return;
 892         }
 893     }
 894 #else
 895     // Save the real info pointer (NOTE: not the same as get_itbl()).
 896     info_ptr = (StgWord)p->header.info;
 897     SET_INFO(p,&stg_WHITEHOLE_info);
 898 #endif
 899
 900     field = INFO_PTR_TO_STRUCT(info_ptr)->layout.selector_offset;
 901
 902     // The selectee might be a constructor closure,
 903     // so we untag the pointer.
 904     selectee = UNTAG_CLOSURE(p->selectee);
 905
 906 selector_loop:
 907     // selectee now points to the closure that we're trying to select
 908     // a field from.  It may or may not be in to-space: we try not to
 909     // end up in to-space, but it's impractical to avoid it in
 910     // general.  The compacting GC scatters to-space pointers in
 911     // from-space during marking, for example.  We rely on the property
 912     // that evacuate() doesn't mind if it gets passed a to-space pointer.
 913
 914     info = (StgInfoTable*)selectee->header.info;
 915
 916     if (IS_FORWARDING_PTR(info)) {
 917         // We don't follow pointers into to-space; the constructor
 918         // has already been evacuated, so we won't save any space
 919         // leaks by evaluating this selector thunk anyhow.
 920         goto bale_out;
 921     }
 922
 923     info = INFO_PTR_TO_STRUCT(info);
 924     switch (info->type) {
 925       case WHITEHOLE:
 926           goto bale_out; // about to be evacuated by another thread (or a loop).
 927
 928       case CONSTR:
 929       case CONSTR_1_0:
 930       case CONSTR_0_1:
 931       case CONSTR_2_0:
 932       case CONSTR_1_1:
 933       case CONSTR_0_2:
 934       case CONSTR_STATIC:
 935       case CONSTR_NOCAF_STATIC:
 936           {
 937               // check that the size is in range
 938               ASSERT(field <  (StgWord32)(info->layout.payload.ptrs +
 939                                           info->layout.payload.nptrs));
 940
 941               // Select the right field from the constructor
 942               val = selectee->payload[field];
 943
 944 #ifdef PROFILING
 945               // For the purposes of LDV profiling, we have destroyed
 946               // the original selector thunk, p.
 947               SET_INFO(p, (StgInfoTable *)info_ptr);
 948               OVERWRITING_CLOSURE((StgClosure*)p);
 949               SET_INFO(p, &stg_WHITEHOLE_info);
 950 #endif
 951
 952               // the closure in val is now the "value" of the
 953               // THUNK_SELECTOR in p.  However, val may itself be a
 954               // THUNK_SELECTOR, in which case we want to continue
 955               // evaluating until we find the real value, and then
 956               // update the whole chain to point to the value.
 957           val_loop:
 958               info_ptr = (StgWord)UNTAG_CLOSURE(val)->header.info;
 959               if (!IS_FORWARDING_PTR(info_ptr))
 960               {
 961                   info = INFO_PTR_TO_STRUCT(info_ptr);
 962                   switch (info->type) {
 963                   case IND:
 964                   case IND_PERM:
 965                   case IND_STATIC:
 966                       val = ((StgInd *)val)->indirectee;
 967                       goto val_loop;
 968                   case THUNK_SELECTOR:
 969                       ((StgClosure*)p)->payload[0] = (StgClosure *)prev_thunk_selector;
 970                       prev_thunk_selector = p;
 971                       p = (StgSelector*)val;
 972                       goto selector_chain;
 973                   default:
 974                       break;
 975                   }
 976               }
 977               ((StgClosure*)p)->payload[0] = (StgClosure *)prev_thunk_selector;
 978               prev_thunk_selector = p;
 979
 980               *q = val;
 981
 982               // update the other selectors in the chain *before*
 983               // evacuating the value.  This is necessary in the case
 984               // where the value turns out to be one of the selectors
 985               // in the chain (i.e. we have a loop), and evacuating it
 986               // would corrupt the chain.
 987               unchain_thunk_selectors(prev_thunk_selector, val);
 988
 989               // evacuate() cannot recurse through
 990               // eval_thunk_selector(), because we know val is not
 991               // a THUNK_SELECTOR.
 992               if (evac) evacuate(q);
 993               return;
 994           }
 995
 996       case IND:
 997       case IND_PERM:
 998       case IND_STATIC:
 999           // Again, we might need to untag a constructor.
1000           selectee = UNTAG_CLOSURE( ((StgInd *)selectee)->indirectee );
1001           goto selector_loop;
1002
1003       case BLACKHOLE:
1004       {
1005           StgClosure *r;
1006           const StgInfoTable *i;
1007           r = ((StgInd*)selectee)->indirectee;
1008
1009           // establish whether this BH has been updated, and is now an
1010           // indirection, as in evacuate().
1011           if (GET_CLOSURE_TAG(r) == 0) {
1012               i = r->header.info;
1013               if (IS_FORWARDING_PTR(i)) {
1014                   r = (StgClosure *)UN_FORWARDING_PTR(i);
1015                   i = r->header.info;
1016               }
1017               if (i == &stg_TSO_info
1018                   || i == &stg_WHITEHOLE_info
1019                   || i == &stg_BLOCKING_QUEUE_CLEAN_info
1020                   || i == &stg_BLOCKING_QUEUE_DIRTY_info) {
1021                   goto bale_out;
1022               }
1023               ASSERT(i != &stg_IND_info);
1024           }
1025
1026           selectee = UNTAG_CLOSURE( ((StgInd *)selectee)->indirectee );
1027           goto selector_loop;
1028       }
1029
1030       case THUNK_SELECTOR:
1031       {
1032           StgClosure *val;
1033
1034           // recursively evaluate this selector.  We don't want to
1035           // recurse indefinitely, so we impose a depth bound.
1036           if (gct->thunk_selector_depth >= MAX_THUNK_SELECTOR_DEPTH) {
1037               goto bale_out;
1038           }
1039
1040           gct->thunk_selector_depth++;
1041           // rtsFalse says "don't evacuate the result".  It will,
1042           // however, update any THUNK_SELECTORs that are evaluated
1043           // along the way.
1044           eval_thunk_selector(&val, (StgSelector*)selectee, rtsFalse);
1045           gct->thunk_selector_depth--;
1046
1047           // did we actually manage to evaluate it?
1048           if (val == selectee) goto bale_out;
1049
1050           // Of course this pointer might be tagged...
1051           selectee = UNTAG_CLOSURE(val);
1052           goto selector_loop;
1053       }
1054
1055       case AP:
1056       case AP_STACK:
1057       case THUNK:
1058       case THUNK_1_0:
1059       case THUNK_0_1:
1060       case THUNK_2_0:
1061       case THUNK_1_1:
1062       case THUNK_0_2:
1063       case THUNK_STATIC:
1064           // not evaluated yet
1065           goto bale_out;
1066
1067       default:
1068         barf("eval_thunk_selector: strange selectee %d",
1069              (int)(info->type));
1070     }
1071
1072 bale_out:
1073     // We didn't manage to evaluate this thunk; restore the old info
1074     // pointer.  But don't forget: we still need to evacuate the thunk itself.
1075     SET_INFO(p, (const StgInfoTable *)info_ptr);
1076     // THREADED_RTS: we just unlocked the thunk, so another thread
1077     // might get in and update it.  copy() will lock it again and
1078     // check whether it was updated in the meantime.
1079     *q = (StgClosure *)p;
1080     if (evac) {
1081         copy(q,(const StgInfoTable *)info_ptr,(StgClosure *)p,THUNK_SELECTOR_sizeW(),bd->dest_no);
1082     }
1083     unchain_thunk_selectors(prev_thunk_selector, *q);
1084     return;
1085 }