Weak.c 2.7 KB
Newer Older
1
/* -----------------------------------------------------------------------------
2 3
 *
 * (c) The GHC Team, 1998-1999
4
 *
5
 * Weak pointers / finalizers
6 7 8
 *
 * ---------------------------------------------------------------------------*/

9
#include "PosixSource.h"
10
#include "Rts.h"
11
#include "RtsUtils.h"
sof's avatar
sof committed
12
#include "SchedAPI.h"
13 14
#include "RtsFlags.h"
#include "Weak.h"
sof's avatar
sof committed
15
#include "Schedule.h"
16
#include "Prelude.h"
sof's avatar
sof committed
17
#include "RtsAPI.h"
Simon Marlow's avatar
Simon Marlow committed
18
#include "Trace.h"
19 20 21 22

StgWeak *weak_ptr_list;

/*
23
 * scheduleFinalizers() is called on the list of weak pointers found
24
 * to be dead after a garbage collection.  It overwrites each object
25
 * with DEAD_WEAK, and creates a new thread to run the pending finalizers.
26 27 28 29 30 31 32
 *
 * This function is called just after GC.  The weak pointers on the
 * argument list are those whose keys were found to be not reachable,
 * however the value and finalizer fields have by now been marked live.
 * The weak pointer object itself may not be alive - i.e. we may be
 * looking at either an object in from-space or one in to-space.  It
 * doesn't really matter either way.
sof's avatar
sof committed
33 34
 *
 * Pre-condition: sched_mutex _not_ held.
35 36 37
 */

void
38
scheduleFinalizers(Capability *cap, StgWeak *list)
39
{
40 41 42 43 44
    StgWeak *w;
    StgTSO *t;
    StgMutArrPtrs *arr;
    nat n;

45
    // count number of finalizers, and kill all the weak pointers first...
46 47 48 49 50 51 52 53
    n = 0;
    for (w = list; w; w = w->link) { 

	// Better not be a DEAD_WEAK at this stage; the garbage
	// collector removes DEAD_WEAKs from the weak pointer list.
	ASSERT(w->header.info != &stg_DEAD_WEAK_info);

	if (w->finalizer != &stg_NO_FINALIZER_closure) {
54
	    n++;
55 56 57 58 59 60 61 62 63 64 65 66
	}

#ifdef PROFILING
        // A weak pointer is inherently used, so we do not need to call
        // LDV_recordDead().
	//
        // Furthermore, when PROFILING is turned on, dead weak
        // pointers are exactly as large as weak pointers, so there is
        // no need to fill the slop, either.  See stg_DEAD_WEAK_info
        // in StgMiscClosures.hc.
#endif
	SET_HDR(w, &stg_DEAD_WEAK_info, w->header.prof.ccs);
67
    }
68
	
69
    // No finalizers to run?
70 71
    if (n == 0) return;

Simon Marlow's avatar
Simon Marlow committed
72
    debugTrace(DEBUG_weak, "weak: batching %d finalizers", n);
73

74
    arr = (StgMutArrPtrs *)allocateLocal(cap, sizeofW(StgMutArrPtrs) + n);
75
    TICK_ALLOC_PRIM(sizeofW(StgMutArrPtrs), n, 0);
76
    SET_HDR(arr, &stg_MUT_ARR_PTRS_FROZEN_info, CCS_SYSTEM);
77 78
    arr->ptrs = n;

79 80 81
    n = 0;
    for (w = list; w; w = w->link) {
	if (w->finalizer != &stg_NO_FINALIZER_closure) {
82 83 84 85 86
	    arr->payload[n] = w->finalizer;
	    n++;
	}
    }

87 88 89 90
    t = createIOThread(cap, 
		       RtsFlags.GcFlags.initialStkSize, 
		       rts_apply(cap,
			   rts_apply(cap,
91
			       (StgClosure *)runFinalizerBatch_closure,
92
			       rts_mkInt(cap,n)), 
93 94
			   (StgClosure *)arr)
	);
95
    scheduleThread(cap,t);
96
}