Compact.c 26 KB
Newer Older
1 2
/* -----------------------------------------------------------------------------
 *
3
 * (c) The GHC Team 2001-2008
4 5 6
 *
 * Compacting garbage collector
 *
7 8
 * Documentation on the architecture of the Garbage Collector can be
 * found in the online commentary:
9
 *
10
 *   http://ghc.haskell.org/trac/ghc/wiki/Commentary/Rts/Storage/GC
11
 *
12 13
 * ---------------------------------------------------------------------------*/

14
#include "PosixSource.h"
15
#include "Rts.h"
Simon Marlow's avatar
Simon Marlow committed
16

Simon Marlow's avatar
Simon Marlow committed
17
#include "GCThread.h"
Simon Marlow's avatar
Simon Marlow committed
18
#include "Storage.h"
19 20
#include "RtsUtils.h"
#include "BlockAlloc.h"
21 22
#include "GC.h"
#include "Compact.h"
23
#include "Schedule.h"
24
#include "Apply.h"
Simon Marlow's avatar
Simon Marlow committed
25
#include "Trace.h"
Simon Marlow's avatar
Simon Marlow committed
26 27 28
#include "Weak.h"
#include "MarkWeak.h"
#include "Stable.h"
29

30 31
// Turn off inlining when debugging - it obfuscates things
#ifdef DEBUG
sof's avatar
sof committed
32 33
# undef  STATIC_INLINE
# define STATIC_INLINE static
34 35
#endif

36
/* ----------------------------------------------------------------------------
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
   Threading / unthreading pointers.

   The basic idea here is to chain together all the fields pointing at
   a particular object, with the root of the chain in the object's
   info table field.  The original contents of the info pointer goes
   at the end of the chain.

   Adding a new field to the chain is a matter of swapping the
   contents of the field with the contents of the object's info table
   field.

   To unthread the chain, we walk down it updating all the fields on
   the chain with the new location of the object.  We stop when we
   reach the info pointer at the end.

52 53 54 55 56 57 58
   The main difficulty here is that we need to be able to identify the
   info pointer at the end of the chain.  We can't use the low bits of
   the pointer for this; they are already being used for
   pointer-tagging.  What's more, we need to retain the
   pointer-tagging tag bits on each pointer during the
   threading/unthreading process.

59
   Our solution is as follows:
60 61 62 63 64 65 66 67 68 69 70
     - an info pointer (chain length zero) is identified by having tag 0
     - in a threaded chain of length > 0:
        - the pointer-tagging tag bits are attached to the info pointer
        - the first entry in the chain has tag 1
        - second and subsequent entries in the chain have tag 2

   This exploits the fact that the tag on each pointer to a given
   closure is normally the same (if they are not the same, then
   presumably the tag is not essential and it therefore doesn't matter
   if we throw away some of the tags).
   ------------------------------------------------------------------------- */
71

sof's avatar
sof committed
72
STATIC_INLINE void
73
thread (StgClosure **p)
74
{
75 76 77
    StgClosure *q0;
    StgPtr q;
    StgWord iptr;
78 79
    bdescr *bd;

80 81 82
    q0  = *p;
    q   = (StgPtr)UNTAG_CLOSURE(q0);

83 84 85
    // It doesn't look like a closure at the moment, because the info
    // ptr is possibly threaded:
    // ASSERT(LOOKS_LIKE_CLOSURE_PTR(q));
86

87
    if (HEAP_ALLOCED(q)) {
88
        bd = Bdescr(q);
89

90
        if (bd->flags & BF_MARKED)
Simon Marlow's avatar
Simon Marlow committed
91
        {
92 93 94
            iptr = *q;
            switch (GET_CLOSURE_TAG((StgClosure *)iptr))
            {
95
            case 0:
96 97 98 99 100 101 102 103 104 105 106 107 108
                // this is the info pointer; we are creating a new chain.
                // save the original tag at the end of the chain.
                *p = (StgClosure *)((StgWord)iptr + GET_CLOSURE_TAG(q0));
                *q = (StgWord)p + 1;
                break;
            case 1:
            case 2:
                // this is a chain of length 1 or more
                *p = (StgClosure *)iptr;
                *q = (StgWord)p + 2;
                break;
            }
        }
109 110 111
    }
}

112 113 114 115 116 117
static void
thread_root (void *user STG_UNUSED, StgClosure **p)
{
    thread(p);
}

118 119 120 121
// This version of thread() takes a (void *), used to circumvent
// warnings from gcc about pointer punning and strict aliasing.
STATIC_INLINE void thread_ (void *p) { thread((StgClosure **)p); }

sof's avatar
sof committed
122
STATIC_INLINE void
123
unthread( StgPtr p, StgWord free )
124
{
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
    StgWord q, r;
    StgPtr q0;

    q = *p;
loop:
    switch (GET_CLOSURE_TAG((StgClosure *)q))
    {
    case 0:
        // nothing to do; the chain is length zero
        return;
    case 1:
        q0 = (StgPtr)(q-1);
        r = *q0;  // r is the info ptr, tagged with the pointer-tag
        *q0 = free;
        *p = (StgWord)UNTAG_CLOSURE((StgClosure *)r);
        return;
    case 2:
        q0 = (StgPtr)(q-2);
        r = *q0;
        *q0 = free;
        q = r;
        goto loop;
    default:
        barf("unthread");
149 150 151
    }
}

152 153 154 155 156
// Traverse a threaded chain and pull out the info pointer at the end.
// The info pointer is also tagged with the appropriate pointer tag
// for this closure, which should be attached to the pointer
// subsequently passed to unthread().
STATIC_INLINE StgWord
157 158
get_threaded_info( StgPtr p )
{
159
    StgWord q;
160

161
    q = (W_)GET_INFO(UNTAG_CLOSURE((StgClosure *)p));
162

163
loop:
164
    switch (GET_CLOSURE_TAG((StgClosure *)q))
165 166 167 168 169 170 171
    {
    case 0:
        ASSERT(LOOKS_LIKE_INFO_PTR(q));
        return q;
    case 1:
    {
        StgWord r = *(StgPtr)(q-1);
Simon Marlow's avatar
Simon Marlow committed
172
        ASSERT(LOOKS_LIKE_INFO_PTR((StgWord)UNTAG_CLOSURE((StgClosure *)r)));
173 174 175 176 177 178 179
        return r;
    }
    case 2:
        q = *(StgPtr)(q-2);
        goto loop;
    default:
        barf("get_threaded_info");
180 181 182 183 184
    }
}

// A word-aligned memmove will be faster for small objects than libc's or gcc's.
// Remember, the two regions *might* overlap, but: to <= from.
sof's avatar
sof committed
185
STATIC_INLINE void
186
move(StgPtr to, StgPtr from, StgWord size)
187 188
{
    for(; size > 0; --size) {
189
        *to++ = *from++;
190 191 192 193 194 195 196 197 198
    }
}

static void
thread_static( StgClosure* p )
{
  const StgInfoTable *info;

  // keep going until we've threaded all the objects on the linked
199
  // list...
200 201
  while (p != END_OF_STATIC_LIST) {

202 203
    info = get_itbl(p);
    switch (info->type) {
204

205
    case IND_STATIC:
206 207 208 209
        thread(&((StgInd *)p)->indirectee);
        p = *IND_STATIC_LINK(p);
        continue;

210
    case THUNK_STATIC:
211 212
        p = *THUNK_STATIC_LINK(p);
        continue;
213
    case FUN_STATIC:
214 215
        p = *FUN_STATIC_LINK(p);
        continue;
216
    case CONSTR_STATIC:
217 218 219
        p = *STATIC_LINK(info,p);
        continue;

220
    default:
221
        barf("thread_static: strange closure %d", (int)(info->type));
222 223 224 225 226
    }

  }
}

sof's avatar
sof committed
227
STATIC_INLINE void
228
thread_large_bitmap( StgPtr p, StgLargeBitmap *large_bitmap, StgWord size )
229
{
230
    W_ i, b;
231 232 233 234 235
    StgWord bitmap;

    b = 0;
    bitmap = large_bitmap->bitmap[b];
    for (i = 0; i < size; ) {
236 237 238 239 240 241 242 243 244 245 246
        if ((bitmap & 1) == 0) {
            thread((StgClosure **)p);
        }
        i++;
        p++;
        if (i % BITS_IN(W_) == 0) {
            b++;
            bitmap = large_bitmap->bitmap[b];
        } else {
            bitmap = bitmap >> 1;
        }
247 248 249
    }
}

250 251 252 253 254 255 256 257 258 259 260 261 262 263
STATIC_INLINE StgPtr
thread_small_bitmap (StgPtr p, StgWord size, StgWord bitmap)
{
    while (size > 0) {
        if ((bitmap & 1) == 0) {
            thread((StgClosure **)p);
        }
        p++;
        bitmap = bitmap >> 1;
        size--;
    }
    return p;
}

sof's avatar
sof committed
264
STATIC_INLINE StgPtr
265 266 267 268
thread_arg_block (StgFunInfoTable *fun_info, StgClosure **args)
{
    StgPtr p;
    StgWord bitmap;
269
    StgWord size;
270 271

    p = (StgPtr)args;
272
    switch (fun_info->f.fun_type) {
273
    case ARG_GEN:
274 275 276
        bitmap = BITMAP_BITS(fun_info->f.b.bitmap);
        size = BITMAP_SIZE(fun_info->f.b.bitmap);
        goto small_bitmap;
277
    case ARG_GEN_BIG:
278 279 280 281
        size = GET_FUN_LARGE_BITMAP(fun_info)->size;
        thread_large_bitmap(p, GET_FUN_LARGE_BITMAP(fun_info), size);
        p += size;
        break;
282
    default:
283 284
        bitmap = BITMAP_BITS(stg_arg_bitmaps[fun_info->f.fun_type]);
        size = BITMAP_SIZE(stg_arg_bitmaps[fun_info->f.fun_type]);
285
    small_bitmap:
286
        p = thread_small_bitmap(p, size, bitmap);
287
        break;
288 289 290 291
    }
    return p;
}

292 293 294
static void
thread_stack(StgPtr p, StgPtr stack_end)
{
295
    const StgRetInfoTable* info;
ken's avatar
ken committed
296
    StgWord bitmap;
297
    StgWord size;
298

299
    // highly similar to scavenge_stack, but we do pointer threading here.
300

301 302
    while (p < stack_end) {

303 304 305 306 307 308 309 310
        // *p must be the info pointer of an activation
        // record.  All activation records have 'bitmap' style layout
        // info.
        //
        info  = get_ret_itbl((StgClosure *)p);

        switch (info->i.type) {

311
            // small bitmap (<= 32 entries, or 64 on a 64-bit machine)
312 313 314
        case CATCH_RETRY_FRAME:
        case CATCH_STM_FRAME:
        case ATOMICALLY_FRAME:
315
        case UPDATE_FRAME:
316 317 318
        case UNDERFLOW_FRAME:
        case STOP_FRAME:
        case CATCH_FRAME:
319 320 321 322 323 324
        case RET_SMALL:
            bitmap = BITMAP_BITS(info->i.layout.bitmap);
            size   = BITMAP_SIZE(info->i.layout.bitmap);
            p++;
            // NOTE: the payload starts immediately after the info-ptr, we
            // don't have an StgHeader in the same sense as a heap closure.
325
            p = thread_small_bitmap(p, size, bitmap);
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
            continue;

        case RET_BCO: {
            StgBCO *bco;

            p++;
            bco = (StgBCO *)*p;
            thread((StgClosure **)p);
            p++;
            size = BCO_BITMAP_SIZE(bco);
            thread_large_bitmap(p, BCO_BITMAP(bco), size);
            p += size;
            continue;
        }

            // large bitmap (> 32 entries, or 64 on a 64-bit machine)
        case RET_BIG:
            p++;
            size = GET_LARGE_BITMAP(&info->i)->size;
            thread_large_bitmap(p, GET_LARGE_BITMAP(&info->i), size);
            p += size;
            continue;

        case RET_FUN:
        {
            StgRetFun *ret_fun = (StgRetFun *)p;
            StgFunInfoTable *fun_info;

            fun_info = FUN_INFO_PTR_TO_STRUCT((StgInfoTable *)UNTAG_CLOSURE((StgClosure *)
355
                           get_threaded_info((StgPtr)ret_fun->fun)));
356 357 358 359 360 361 362 363 364 365
                 // *before* threading it!
            thread(&ret_fun->fun);
            p = thread_arg_block(fun_info, ret_fun->payload);
            continue;
        }

        default:
            barf("thread_stack: weird activation record found on stack: %d",
                 (int)(info->i.type));
        }
366 367 368
    }
}

sof's avatar
sof committed
369
STATIC_INLINE StgPtr
370
thread_PAP_payload (StgClosure *fun, StgClosure **payload, StgWord size)
371 372
{
    StgPtr p;
373
    StgWord bitmap;
374
    StgFunInfoTable *fun_info;
375

376
    fun_info = FUN_INFO_PTR_TO_STRUCT((StgInfoTable *)UNTAG_CLOSURE((StgClosure *)
377
                        get_threaded_info((StgPtr)fun)));
378 379
    ASSERT(fun_info->i.type != PAP);

380
    p = (StgPtr)payload;
381

382
    switch (fun_info->f.fun_type) {
383
    case ARG_GEN:
384 385
        bitmap = BITMAP_BITS(fun_info->f.b.bitmap);
        goto small_bitmap;
386
    case ARG_GEN_BIG:
387 388 389
        thread_large_bitmap(p, GET_FUN_LARGE_BITMAP(fun_info), size);
        p += size;
        break;
390
    case ARG_BCO:
391 392 393
        thread_large_bitmap((StgPtr)payload, BCO_BITMAP(fun), size);
        p += size;
        break;
394
    default:
395
        bitmap = BITMAP_BITS(stg_arg_bitmaps[fun_info->f.fun_type]);
396
    small_bitmap:
397
        p = thread_small_bitmap(p, size, bitmap);
398
        break;
399
    }
400

401 402 403 404 405 406 407 408
    return p;
}

STATIC_INLINE StgPtr
thread_PAP (StgPAP *pap)
{
    StgPtr p;
    p = thread_PAP_payload(pap->fun, pap->payload, pap->n_args);
409
    thread(&pap->fun);
410 411
    return p;
}
412

413 414 415 416 417
STATIC_INLINE StgPtr
thread_AP (StgAP *ap)
{
    StgPtr p;
    p = thread_PAP_payload(ap->fun, ap->payload, ap->n_args);
418
    thread(&ap->fun);
419
    return p;
420
}
421

sof's avatar
sof committed
422
STATIC_INLINE StgPtr
423 424
thread_AP_STACK (StgAP_STACK *ap)
{
425
    thread(&ap->fun);
426 427 428 429 430 431 432
    thread_stack((P_)ap->payload, (P_)ap->payload + ap->size);
    return (P_)ap + sizeofW(StgAP_STACK) + ap->size;
}

static StgPtr
thread_TSO (StgTSO *tso)
{
433
    thread_(&tso->_link);
434
    thread_(&tso->global_link);
435 436

    if (   tso->why_blocked == BlockedOnMVar
437
        || tso->why_blocked == BlockedOnMVarRead
438 439
        || tso->why_blocked == BlockedOnBlackHole
        || tso->why_blocked == BlockedOnMsgThrowTo
440 441
        || tso->why_blocked == NotBlocked
        ) {
442
        thread_(&tso->block_info.closure);
443
    }
444
    thread_(&tso->blocked_exceptions);
445
    thread_(&tso->bq);
446

447
    thread_(&tso->trec);
448

449 450
    thread_(&tso->stackobj);
    return (StgPtr)tso + sizeofW(StgTSO);
451 452 453
}


454 455 456 457 458 459 460 461
static void
update_fwd_large( bdescr *bd )
{
  StgPtr p;
  const StgInfoTable* info;

  for (; bd != NULL; bd = bd->link) {

Simon Marlow's avatar
Simon Marlow committed
462 463 464 465
    // nothing to do in a pinned block; it might not even have an object
    // at the beginning.
    if (bd->flags & BF_PINNED) continue;

466 467 468 469 470 471
    p = bd->start;
    info  = get_itbl((StgClosure *)p);

    switch (info->type) {

    case ARR_WORDS:
472
      // nothing to follow
473 474
      continue;

475 476
    case MUT_ARR_PTRS_CLEAN:
    case MUT_ARR_PTRS_DIRTY:
477
    case MUT_ARR_PTRS_FROZEN:
478
    case MUT_ARR_PTRS_FROZEN0:
479
      // follow everything
480
      {
481
          StgMutArrPtrs *a;
482

483 484 485 486 487
          a = (StgMutArrPtrs*)p;
          for (p = (P_)a->payload; p < (P_)&a->payload[a->ptrs]; p++) {
              thread((StgClosure **)p);
          }
          continue;
488 489
      }

490 491 492 493
    case SMALL_MUT_ARR_PTRS_CLEAN:
    case SMALL_MUT_ARR_PTRS_DIRTY:
    case SMALL_MUT_ARR_PTRS_FROZEN:
    case SMALL_MUT_ARR_PTRS_FROZEN0:
494
      // follow everything
495 496 497 498 499 500 501 502 503 504
      {
          StgSmallMutArrPtrs *a;

          a = (StgSmallMutArrPtrs*)p;
          for (p = (P_)a->payload; p < (P_)&a->payload[a->ptrs]; p++) {
              thread((StgClosure **)p);
          }
          continue;
      }

505 506 507 508 509 510
    case STACK:
    {
        StgStack *stack = (StgStack*)p;
        thread_stack(stack->sp, stack->stack + stack->stack_size);
        continue;
    }
511 512

    case AP_STACK:
513 514
        thread_AP_STACK((StgAP_STACK *)p);
        continue;
515 516

    case PAP:
517 518
        thread_PAP((StgPAP *)p);
        continue;
519

520 521 522 523
    case TREC_CHUNK:
    {
        StgWord i;
        StgTRecChunk *tc = (StgTRecChunk *)p;
524 525 526 527 528 529 530 531
        TRecEntry *e = &(tc -> entries[0]);
        thread_(&tc->prev_chunk);
        for (i = 0; i < tc -> next_entry_idx; i ++, e++ ) {
          thread_(&e->tvar);
          thread(&e->expected_value);
          thread(&e->new_value);
        }
        continue;
532 533
    }

534 535 536 537 538 539
    default:
      barf("update_fwd_large: unknown/strange object  %d", (int)(info->type));
    }
  }
}

540 541
// ToDo: too big to inline
static /* STATIC_INLINE */ StgPtr
542 543 544
thread_obj (StgInfoTable *info, StgPtr p)
{
    switch (info->type) {
545
    case THUNK_0_1:
546
        return p + sizeofW(StgThunk) + 1;
547

548 549
    case FUN_0_1:
    case CONSTR_0_1:
550 551
        return p + sizeofW(StgHeader) + 1;

552 553
    case FUN_1_0:
    case CONSTR_1_0:
554 555 556
        thread(&((StgClosure *)p)->payload[0]);
        return p + sizeofW(StgHeader) + 1;

557
    case THUNK_1_0:
558 559 560
        thread(&((StgThunk *)p)->payload[0]);
        return p + sizeofW(StgThunk) + 1;

561
    case THUNK_0_2:
562
        return p + sizeofW(StgThunk) + 2;
563

564 565
    case FUN_0_2:
    case CONSTR_0_2:
566 567
        return p + sizeofW(StgHeader) + 2;

568
    case THUNK_1_1:
569 570
        thread(&((StgThunk *)p)->payload[0]);
        return p + sizeofW(StgThunk) + 2;
571

572 573
    case FUN_1_1:
    case CONSTR_1_1:
574 575 576
        thread(&((StgClosure *)p)->payload[0]);
        return p + sizeofW(StgHeader) + 2;

577
    case THUNK_2_0:
578 579 580
        thread(&((StgThunk *)p)->payload[0]);
        thread(&((StgThunk *)p)->payload[1]);
        return p + sizeofW(StgThunk) + 2;
581

582 583
    case FUN_2_0:
    case CONSTR_2_0:
584 585 586 587
        thread(&((StgClosure *)p)->payload[0]);
        thread(&((StgClosure *)p)->payload[1]);
        return p + sizeofW(StgHeader) + 2;

588
    case BCO: {
589 590 591 592 593
        StgBCO *bco = (StgBCO *)p;
        thread_(&bco->instrs);
        thread_(&bco->literals);
        thread_(&bco->ptrs);
        return p + bco_sizeW(bco);
594 595
    }

596
    case THUNK:
597
    {
598 599 600 601 602 603 604 605
        StgPtr end;

        end = (P_)((StgThunk *)p)->payload +
            info->layout.payload.ptrs;
        for (p = (P_)((StgThunk *)p)->payload; p < end; p++) {
            thread((StgClosure **)p);
        }
        return p + info->layout.payload.nptrs;
606 607 608
    }

    case FUN:
609
    case CONSTR:
610 611
    case PRIM:
    case MUT_PRIM:
612 613
    case MUT_VAR_CLEAN:
    case MUT_VAR_DIRTY:
614
    case TVAR:
615
    case BLACKHOLE:
616
    case BLOCKING_QUEUE:
617
    {
618 619 620 621 622 623 624 625
        StgPtr end;

        end = (P_)((StgClosure *)p)->payload +
            info->layout.payload.ptrs;
        for (p = (P_)((StgClosure *)p)->payload; p < end; p++) {
            thread((StgClosure **)p);
        }
        return p + info->layout.payload.nptrs;
626
    }
627

628 629
    case WEAK:
    {
630 631 632 633 634 635 636 637 638
        StgWeak *w = (StgWeak *)p;
        thread(&w->cfinalizers);
        thread(&w->key);
        thread(&w->value);
        thread(&w->finalizer);
        if (w->link != NULL) {
            thread_(&w->link);
        }
        return p + sizeofW(StgWeak);
639
    }
640

641 642
    case MVAR_CLEAN:
    case MVAR_DIRTY:
643 644 645 646 647 648
    {
        StgMVar *mvar = (StgMVar *)p;
        thread_(&mvar->head);
        thread_(&mvar->tail);
        thread(&mvar->value);
        return p + sizeofW(StgMVar);
649
    }
650

651 652
    case IND:
    case IND_PERM:
653 654
        thread(&((StgInd *)p)->indirectee);
        return p + sizeofW(StgInd);
655 656

    case THUNK_SELECTOR:
657 658 659 660
    {
        StgSelector *s = (StgSelector *)p;
        thread(&s->selectee);
        return p + THUNK_SELECTOR_sizeW();
661
    }
662

663
    case AP_STACK:
664 665
        return thread_AP_STACK((StgAP_STACK *)p);

666
    case PAP:
667
        return thread_PAP((StgPAP *)p);
668 669

    case AP:
670 671
        return thread_AP((StgAP *)p);

672
    case ARR_WORDS:
673 674
        return p + arr_words_sizeW((StgArrWords *)p);

675 676
    case MUT_ARR_PTRS_CLEAN:
    case MUT_ARR_PTRS_DIRTY:
677
    case MUT_ARR_PTRS_FROZEN:
678
    case MUT_ARR_PTRS_FROZEN0:
679
        // follow everything
680
    {
681 682 683
        StgMutArrPtrs *a;

        a = (StgMutArrPtrs *)p;
684 685 686
        for (p = (P_)a->payload; p < (P_)&a->payload[a->ptrs]; p++) {
            thread((StgClosure **)p);
        }
687

688
        return (StgPtr)a + mut_arr_ptrs_sizeW(a);
689
    }
690 691 692 693 694

    case SMALL_MUT_ARR_PTRS_CLEAN:
    case SMALL_MUT_ARR_PTRS_DIRTY:
    case SMALL_MUT_ARR_PTRS_FROZEN:
    case SMALL_MUT_ARR_PTRS_FROZEN0:
695
        // follow everything
696 697 698 699
    {
        StgSmallMutArrPtrs *a;

        a = (StgSmallMutArrPtrs *)p;
700 701 702
        for (p = (P_)a->payload; p < (P_)&a->payload[a->ptrs]; p++) {
            thread((StgClosure **)p);
        }
703

704
        return (StgPtr)a + small_mut_arr_ptrs_sizeW(a);
705
    }
706

707
    case TSO:
708 709
        return thread_TSO((StgTSO *)p);

710 711 712 713 714 715 716
    case STACK:
    {
        StgStack *stack = (StgStack*)p;
        thread_stack(stack->sp, stack->stack + stack->stack_size);
        return p + stack_sizeW(stack);
    }

717 718
    case TREC_CHUNK:
    {
719
        StgWord i;
720
        StgTRecChunk *tc = (StgTRecChunk *)p;
721 722 723 724 725 726 727 728
        TRecEntry *e = &(tc -> entries[0]);
        thread_(&tc->prev_chunk);
        for (i = 0; i < tc -> next_entry_idx; i ++, e++ ) {
          thread_(&e->tvar);
          thread(&e->expected_value);
          thread(&e->new_value);
        }
        return p + sizeofW(StgTRecChunk);
729 730
    }

731
    default:
732 733
        barf("update_fwd: unknown/strange object  %d", (int)(info->type));
        return NULL;
734 735 736
    }
}

737 738 739 740 741 742 743 744 745 746 747
static void
update_fwd( bdescr *blocks )
{
    StgPtr p;
    bdescr *bd;
    StgInfoTable *info;

    bd = blocks;

    // cycle through all the blocks in the step
    for (; bd != NULL; bd = bd->link) {
748 749 750 751 752 753 754 755
        p = bd->start;

        // linearly scan the objects in this block
        while (p < bd->free) {
            ASSERT(LOOKS_LIKE_CLOSURE_PTR(p));
            info = get_itbl((StgClosure *)p);
            p = thread_obj(info, p);
        }
756
    }
757
}
758 759 760 761 762

static void
update_fwd_compact( bdescr *blocks )
{
    StgPtr p, q, free;
763
#if 0
764
    StgWord m;
765
#endif
766 767
    bdescr *bd, *free_bd;
    StgInfoTable *info;
768
    StgWord size;
769
    StgWord iptr;
770 771 772 773 774 775 776

    bd = blocks;
    free_bd = blocks;
    free = free_bd->start;

    // cycle through all the blocks in the step
    for (; bd != NULL; bd = bd->link) {
777
        p = bd->start;
778

779
        while (p < bd->free ) {
780

781 782 783 784 785 786
            while ( p < bd->free && !is_marked(p,bd) ) {
                p++;
            }
            if (p >= bd->free) {
                break;
            }
787 788 789

#if 0
    next:
790 791 792 793 794 795 796 797 798 799 800 801 802 803
        m = * ((StgPtr)bd->u.bitmap + ((p - bd->start) / (BITS_IN(StgWord))));
        m >>= ((p - bd->start) & (BITS_IN(StgWord) - 1));

        while ( p < bd->free ) {

            if ((m & 1) == 0) {
                m >>= 1;
                p++;
                if (((StgWord)p & (sizeof(W_) * BITS_IN(StgWord))) == 0) {
                    goto next;
                } else {
                    continue;
                }
            }
804 805
#endif

806 807 808 809 810
            // Problem: we need to know the destination for this cell
            // in order to unthread its info pointer.  But we can't
            // know the destination without the size, because we may
            // spill into the next block.  So we have to run down the
            // threaded list and get the info ptr first.
811 812 813 814
            //
            // ToDo: one possible avenue of attack is to use the fact
            // that if (p&BLOCK_MASK) >= (free&BLOCK_MASK), then we
            // definitely have enough room.  Also see bug #1147.
815
            iptr = get_threaded_info(p);
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
            info = INFO_PTR_TO_STRUCT((StgInfoTable *)UNTAG_CLOSURE((StgClosure *)iptr));

            q = p;

            p = thread_obj(info, p);

            size = p - q;
            if (free + size > free_bd->start + BLOCK_SIZE_W) {
                // set the next bit in the bitmap to indicate that
                // this object needs to be pushed into the next
                // block.  This saves us having to run down the
                // threaded info pointer list twice during the next pass.
                mark(q+1,bd);
                free_bd = free_bd->link;
                free = free_bd->start;
            } else {
                ASSERT(!is_marked(q+1,bd));
            }

            unthread(q,(StgWord)free + GET_CLOSURE_TAG((StgClosure *)iptr));
            free += size;
837
#if 0
838
            goto next;
839
#endif
840
        }
841 842 843
    }
}

844
static W_
845
update_bkwd_compact( generation *gen )
846 847
{
    StgPtr p, free;
848
#if 0
849
    StgWord m;
850
#endif
851 852
    bdescr *bd, *free_bd;
    StgInfoTable *info;
853 854
    StgWord size;
    W_ free_blocks;
855
    StgWord iptr;
856

857
    bd = free_bd = gen->old_blocks;
858 859 860 861 862
    free = free_bd->start;
    free_blocks = 1;

    // cycle through all the blocks in the step
    for (; bd != NULL; bd = bd->link) {
863
        p = bd->start;
864

865
        while (p < bd->free ) {
866

867 868 869 870 871 872
            while ( p < bd->free && !is_marked(p,bd) ) {
                p++;
            }
            if (p >= bd->free) {
                break;
            }
873 874 875

#if 0
    next:
876 877 878 879 880 881 882 883 884 885 886 887 888 889
        m = * ((StgPtr)bd->u.bitmap + ((p - bd->start) / (BITS_IN(StgWord))));
        m >>= ((p - bd->start) & (BITS_IN(StgWord) - 1));

        while ( p < bd->free ) {

            if ((m & 1) == 0) {
                m >>= 1;
                p++;
                if (((StgWord)p & (sizeof(W_) * BITS_IN(StgWord))) == 0) {
                    goto next;
                } else {
                    continue;
                }
            }
890 891
#endif

892 893 894 895 896 897 898
            if (is_marked(p+1,bd)) {
                // don't forget to update the free ptr in the block desc.
                free_bd->free = free;
                free_bd = free_bd->link;
                free = free_bd->start;
                free_blocks++;
            }
899

900
            iptr = get_threaded_info(p);
901 902 903 904
            unthread(p, (StgWord)free + GET_CLOSURE_TAG((StgClosure *)iptr));
            ASSERT(LOOKS_LIKE_INFO_PTR((StgWord)((StgClosure *)p)->header.info));
            info = get_itbl((StgClosure *)p);
            size = closure_sizeW_((StgClosure *)p,info);
905

906 907 908
            if (free != p) {
                move(free,p,size);
            }
909

910
            // relocate TSOs
911 912
            if (info->type == STACK) {
                move_STACK((StgStack *)p, (StgStack *)free);
913
            }
914

915 916
            free += size;
            p += size;
917
#if 0
918
            goto next;
919
#endif
920
        }
921 922 923 924 925
    }

    // free the remaining blocks and count what's left.
    free_bd->free = free;
    if (free_bd->link != NULL) {
926 927
        freeChain(free_bd->link);
        free_bd->link = NULL;
928 929 930
    }

    return free_blocks;
931 932
}

933
void
934
compact(StgClosure *static_objects)
935
{
936
    W_ n, g, blocks;
937
    generation *gen;
938 939

    // 1. thread the roots
940
    markCapabilities((evac_fn)thread_root, NULL);
941

Simon Marlow's avatar
Simon Marlow committed
942 943
    markScheduler((evac_fn)thread_root, NULL);

944
    // the weak pointer lists...
945
    for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
946
        if (generations[g].weak_ptr_list != NULL) {
947
            thread((void *)&generations[g].weak_ptr_list);
948
        }
949
    }
950 951

    if (dead_weak_ptr_list != NULL) {
952
        thread((void *)&dead_weak_ptr_list); // tmp
953 954
    }

955 956
    // mutable lists
    for (g = 1; g < RtsFlags.GcFlags.generations; g++) {
957 958
        bdescr *bd;
        StgPtr p;
959
        for (n = 0; n < n_capabilities; n++) {
960
            for (bd = capabilities[n]->mut_lists[g];
961 962 963 964 965 966
                 bd != NULL; bd = bd->link) {
                for (p = bd->start; p < bd->free; p++) {
                    thread((StgClosure **)p);
                }
            }
        }
967
    }
968 969

    // the global thread list
970 971
    for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
        thread((void *)&generations[g].threads);
972
    }
973

974
    // any threads resurrected during this GC
975
    thread((void *)&resurrected_threads);
976

977
    // the task list
978
    {
979
        Task *task;
980
        InCall *incall;
981
        for (task = all_tasks; task != NULL; task = task->all_next) {
982
            for (incall = task->incall; incall != NULL;
983 984 985 986 987
                 incall = incall->prev_stack) {
                if (incall->tso) {
                    thread_(&incall->tso);
                }
            }
988
        }
989 990
    }

991
    // the static objects
992
    thread_static(static_objects /* ToDo: ok? */);
993 994

    // the stable pointer table
995
    threadStableTables((evac_fn)thread_root, NULL);
996

997
    // the CAF list (used by GHCi)
998
    markCAFs((evac_fn)thread_root, NULL);
999

1000 1001
    // 2. update forward ptrs
    for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
1002 1003 1004 1005
        gen = &generations[g];
        debugTrace(DEBUG_gc, "update_fwd:  %d", g);

        update_fwd(gen->blocks);
Simon Marlow's avatar
Simon Marlow committed
1006 1007 1008 1009
        for (n = 0; n < n_capabilities; n++) {
            update_fwd(gc_threads[n]->gens[g].todo_bd);
            update_fwd(gc_threads[n]->gens[g].part_list);
        }
1010 1011 1012 1013
        update_fwd_large(gen->scavenged_large_objects);
        if (g == RtsFlags.GcFlags.generations-1 && gen->old_blocks != NULL) {
            debugTrace(DEBUG_gc, "update_fwd:  %d (compact)", g);
            update_fwd_compact(gen->old_blocks);
1014
        }
1015 1016 1017
    }

    // 3. update backward ptrs
1018 1019
    gen = oldest_gen;
    if (gen->old_blocks != NULL) {
1020 1021 1022 1023 1024
        blocks = update_bkwd_compact(gen);
        debugTrace(DEBUG_gc,
                   "update_bkwd: %d (compact, old: %d blocks, now %d blocks)",
                   gen->no, gen->n_old_blocks, blocks);
        gen->n_old_blocks = blocks;
1025 1026
    }
}