Weak.c 4.07 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"
Simon Marlow's avatar
Simon Marlow committed
11 12
#include "RtsAPI.h"

13
#include "RtsUtils.h"
14
#include "Weak.h"
sof's avatar
sof committed
15
#include "Schedule.h"
16
#include "Prelude.h"
Simon Marlow's avatar
Simon Marlow committed
17
#include "Trace.h"
18

19 20 21
// ForeignPtrs with C finalizers rely on weak pointers inside weak_ptr_list
// to always be in the same order.

22 23
StgWeak *weak_ptr_list;

24 25 26
// So that we can detect when a finalizer illegally calls back into Haskell
rtsBool running_finalizers = rtsFalse;

27
void
Simon Marlow's avatar
Simon Marlow committed
28
runCFinalizer(void *fn, void *ptr, void *env, StgWord flag)
29 30 31 32 33 34 35 36 37 38 39 40
{
    if (flag)
	((void (*)(void *, void *))fn)(env, ptr);
    else
	((void (*)(void *))fn)(ptr);
}

void
runAllCFinalizers(StgWeak *list)
{
    StgWeak *w;

41 42
    running_finalizers = rtsTrue;

43 44 45 46 47 48
    for (w = list; w; w = w->link) {
	StgArrWords *farr;

	farr = (StgArrWords *)UNTAG_CLOSURE(w->cfinalizer);

	if ((StgClosure *)farr != &stg_NO_FINALIZER_closure)
Simon Marlow's avatar
Simon Marlow committed
49 50 51
	    runCFinalizer((void *)farr->payload[0],
	                  (void *)farr->payload[1],
	                  (void *)farr->payload[2],
52 53
	                  farr->payload[3]);
    }
54 55

    running_finalizers = rtsFalse;
56 57
}

58
/*
59
 * scheduleFinalizers() is called on the list of weak pointers found
60
 * to be dead after a garbage collection.  It overwrites each object
61
 * with DEAD_WEAK, and creates a new thread to run the pending finalizers.
62 63 64 65 66 67 68
 *
 * 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
69 70
 *
 * Pre-condition: sched_mutex _not_ held.
71 72 73
 */

void
74
scheduleFinalizers(Capability *cap, StgWeak *list)
75
{
76 77 78
    StgWeak *w;
    StgTSO *t;
    StgMutArrPtrs *arr;
79 80
    StgWord size;
    nat n, i;
81

82 83
    running_finalizers = rtsTrue;

84
    // count number of finalizers, and kill all the weak pointers first...
85 86
    n = 0;
    for (w = list; w; w = w->link) { 
87
	StgArrWords *farr;
88 89 90 91 92 93

	// 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) {
94
	    n++;
95 96
	}

97 98 99
	farr = (StgArrWords *)UNTAG_CLOSURE(w->cfinalizer);

	if ((StgClosure *)farr != &stg_NO_FINALIZER_closure)
Simon Marlow's avatar
Simon Marlow committed
100 101 102
	    runCFinalizer((void *)farr->payload[0],
	                  (void *)farr->payload[1],
	                  (void *)farr->payload[2],
103 104
	                  farr->payload[3]);

105 106 107 108 109 110 111 112 113 114
#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);
115
    }
116
	
117 118
    running_finalizers = rtsFalse;

119
    // No finalizers to run?
120 121
    if (n == 0) return;

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

124 125
    size = n + mutArrPtrsCardTableSize(n);
    arr = (StgMutArrPtrs *)allocate(cap, sizeofW(StgMutArrPtrs) + size);
126
    TICK_ALLOC_PRIM(sizeofW(StgMutArrPtrs), n, 0);
127
    SET_HDR(arr, &stg_MUT_ARR_PTRS_FROZEN_info, CCS_SYSTEM);
128
    arr->ptrs = n;
129
    arr->size = size;
130

131 132 133
    n = 0;
    for (w = list; w; w = w->link) {
	if (w->finalizer != &stg_NO_FINALIZER_closure) {
134 135 136 137
	    arr->payload[n] = w->finalizer;
	    n++;
	}
    }
138 139 140 141
    // set all the cards to 1
    for (i = n; i < size; i++) {
        arr->payload[i] = (StgClosure *)(W_)(-1);
    }
142

143 144 145 146
    t = createIOThread(cap, 
		       RtsFlags.GcFlags.initialStkSize, 
		       rts_apply(cap,
			   rts_apply(cap,
147
			       (StgClosure *)runFinalizerBatch_closure,
148
			       rts_mkInt(cap,n)), 
149 150
			   (StgClosure *)arr)
	);
151
    scheduleThread(cap,t);
152
}