mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-22 04:21:24 -08:00
Code Issues Projects Releases Wiki Activity
emacs/mps/src/trace.c
Tony Mann 1018f28b7e Change.mps.dylan.kinglet.160189 - rework 
Copied from Perforce
 Change: 21022
 ServerID: perforce.ravenbrook.com
1999-12-08 17:57:05 +00:00

1628 lines
44 KiB
C
Raw Blame History

/* impl.c.trace: GENERIC TRACER IMPLEMENTATION
*
* $HopeName: MMsrc!trace.c(trunk.87) $
* Copyright (C) 1999. Harlequin Limited. All rights reserved.
*
* .design: design.mps.trace.
*/
#include "mpm.h"
SRCID(trace, "$HopeName: MMsrc!trace.c(trunk.87) $");
/* Types
*
* These types only used internally to this trace module.
*/
enum {TraceAccountingPhaseRootScan,
TraceAccountingPhaseSegScan,
TraceAccountingPhaseSingleScan};
typedef int TraceAccountingPhase;
#define TraceMessageSig ((Sig)0x51926359)
typedef struct TraceMessageStruct {
Sig sig;
Size liveSize;
Size condemnedSize;
Size notCondemnedSize;
MessageStruct messageStruct;
} TraceMessageStruct, *TraceMessage;
#define TraceMessageMessage(traceMessage) (&((traceMessage)->messageStruct))
#define MessageTraceMessage(message) \
(PARENT(TraceMessageStruct, messageStruct, (message)))
static Bool TraceMessageCheck(TraceMessage traceMessage)
{
CHECKS(TraceMessage, traceMessage);
CHECKD(Message, TraceMessageMessage(traceMessage));
CHECKL(MessageGetType(TraceMessageMessage(traceMessage)) ==
MessageTypeGC);
/* We can't check anything about the statistics. In particular, */
/* liveSize may exceed condemnedSize because they are only estimates. */
return TRUE;
}
static void TraceMessageDelete(Message message)
{
TraceMessage traceMessage;
Arena arena;
AVERT(Message, message);
traceMessage = MessageTraceMessage(message);
AVERT(TraceMessage, traceMessage);
arena = MessageArena(message);
ControlFree(arena, (void *)traceMessage, sizeof(TraceMessageStruct));
}
static Size TraceMessageLiveSize(Message message)
{
TraceMessage traceMessage;
AVERT(Message, message);
traceMessage = MessageTraceMessage(message);
AVERT(TraceMessage, traceMessage);
return traceMessage->liveSize;
}
static Size TraceMessageCondemnedSize(Message message)
{
TraceMessage traceMessage;
AVERT(Message, message);
traceMessage = MessageTraceMessage(message);
AVERT(TraceMessage, traceMessage);
return traceMessage->condemnedSize;
}
static Size TraceMessageNotCondemnedSize(Message message)
{
TraceMessage traceMessage;
AVERT(Message, message);
traceMessage = MessageTraceMessage(message);
AVERT(TraceMessage, traceMessage);
return traceMessage->notCondemnedSize;
}
static MessageClassStruct TraceMessageClassStruct = {
MessageClassSig, /* sig */
"TraceGC", /* name */
TraceMessageDelete, /* Delete */
MessageNoFinalizationRef, /* FinalizationRef */
TraceMessageLiveSize, /* GCLiveSize */
TraceMessageCondemnedSize, /* GCCondemnedSize */
TraceMessageNotCondemnedSize, /* GCNotCondemnedSize */
MessageClassSig /* design.mps.message.class.sig.double */
};
static void TraceMessageInit(Arena arena, TraceMessage traceMessage)
{
AVERT(Arena, arena);
MessageInit(arena, TraceMessageMessage(traceMessage),
&TraceMessageClassStruct, MessageTypeGC);
traceMessage->liveSize = (Size)0;
traceMessage->condemnedSize = (Size)0;
traceMessage->notCondemnedSize = (Size)0;
traceMessage->sig = TraceMessageSig;
AVERT(TraceMessage, traceMessage);
}
/* ScanStateCheck -- check consistency of a ScanState object */
Bool ScanStateCheck(ScanState ss)
{
TraceId ti;
RefSet white;
CHECKS(ScanState, ss);
CHECKL(FUNCHECK(ss->fix));
CHECKL(ss->zoneShift == ss->arena->zoneShift);
CHECKL(RefSetCheck(ss->white));
white = RefSetEMPTY;
for(ti = 0; ti < TRACE_MAX; ++ti)
if(TraceSetIsMember(ss->traces, ti))
white = RefSetUnion(white, ss->arena->trace[ti].white);
CHECKL(ss->white == white);
CHECKL(RefSetCheck(ss->unfixedSummary));
CHECKU(Arena, ss->arena);
CHECKL(TraceSetCheck(ss->traces));
CHECKL(TraceSetSuper(ss->arena->busyTraces, ss->traces));
CHECKL(RankCheck(ss->rank));
CHECKL(BoolCheck(ss->wasMarked));
CHECKL(RefSetCheck(ss->fixedSummary));
/* @@@@ checks for counts missing */
return TRUE;
}
/* ScanStateInit -- Initialize a ScanState object */
void ScanStateInit(ScanState ss, TraceSet ts, Arena arena,
Rank rank, RefSet white)
{
TraceId ti;
/* we are initing it, so we can't check ss */
AVERT(Arena, arena);
AVER(RankCheck(rank));
/* white is arbitrary and can't be checked */
ss->fix = TraceFix;
for(ti = 0; ti < TRACE_MAX; ++ti) {
if(TraceSetIsMember(ts, ti) &&
ArenaTrace(arena, ti)->emergency) {
ss->fix = TraceFixEmergency;
}
}
ss->rank = rank;
ss->traces = ts;
ss->zoneShift = arena->zoneShift;
ss->unfixedSummary = RefSetEMPTY;
ss->fixedSummary = RefSetEMPTY;
ss->arena = arena;
ss->wasMarked = TRUE;
ss->white = white;
STATISTIC(ss->fixRefCount = (Count)0);
STATISTIC(ss->segRefCount = (Count)0);
STATISTIC(ss->whiteSegRefCount = (Count)0);
STATISTIC(ss->nailCount = (Count)0);
STATISTIC(ss->snapCount = (Count)0);
STATISTIC(ss->forwardedCount = (Count)0);
ss->forwardedSize = (Size)0; /* see .message.data */
STATISTIC(ss->preservedInPlaceCount = (Count)0);
ss->preservedInPlaceSize = (Size)0; /* see .message.data */
STATISTIC(ss->copiedSize = (Size)0);
ss->scannedSize = (Size)0; /* see .workclock */
ss->sig = ScanStateSig;
AVERT(ScanState, ss);
}
/* ScanStateFinish -- Finish a ScanState object */
void ScanStateFinish(ScanState ss)
{
AVERT(ScanState, ss);
ss->sig = SigInvalid;
}
/* TraceIdCheck -- check that a TraceId is valid */
Bool TraceIdCheck(TraceId ti)
{
CHECKL(ti == TraceIdNONE || ti < TRACE_MAX);
UNUSED(ti); /* impl.c.mpm.check.unused */
return TRUE;
}
/* TraceSetCheck -- check that a TraceSet is valid */
Bool TraceSetCheck(TraceSet ts)
{
CHECKL(ts < (1uL << TRACE_MAX));
UNUSED(ts); /* impl.c.mpm.check.unused */
return TRUE;
}
/* TraceCheck -- check consistency of Trace object */
Bool TraceCheck(Trace trace)
{
CHECKS(Trace, trace);
CHECKU(Arena, trace->arena);
CHECKL(TraceIdCheck(trace->ti));
CHECKL(trace == &trace->arena->trace[trace->ti]);
CHECKL(TraceSetIsMember(trace->arena->busyTraces, trace->ti));
CHECKL(RefSetCheck(trace->white));
CHECKL(RefSetCheck(trace->mayMove));
CHECKL(RefSetSub(trace->mayMove, trace->white));
/* Use trace->state to check more invariants. */
switch(trace->state) {
case TraceINIT:
/* @@@@ What can be checked here? */
break;
case TraceUNFLIPPED:
CHECKL(!TraceSetIsMember(trace->arena->flippedTraces, trace->ti));
/* @@@@ Assert that mutator is grey for trace. */
break;
case TraceFLIPPED:
CHECKL(TraceSetIsMember(trace->arena->flippedTraces, trace->ti));
/* @@@@ Assert that mutator is black for trace. */
break;
case TraceRECLAIM:
CHECKL(TraceSetIsMember(trace->arena->flippedTraces, trace->ti));
/* @@@@ Assert that grey set is empty for trace. */
break;
case TraceFINISHED:
CHECKL(TraceSetIsMember(trace->arena->flippedTraces, trace->ti));
/* @@@@ Assert that grey and white sets is empty for trace. */
break;
default:
NOTREACHED;
}
CHECKL(BoolCheck(trace->emergency));
/* @@@@ checks for counts missing */
return TRUE;
}
/* TraceUpdateCounts
*
* Dumps the counts accumulated in a ScanState into the Trace. */
static void TraceUpdateCounts(Trace trace, ScanState ss,
TraceAccountingPhase phase)
{
AVERT(Trace, trace);
AVERT(ScanState, ss);
switch(phase) {
case TraceAccountingPhaseRootScan:
STATISTIC(trace->rootScanSize += ss->scannedSize);
STATISTIC(trace->rootCopiedSize += ss->copiedSize);
STATISTIC(++trace->rootScanCount);
break;
case TraceAccountingPhaseSegScan:
trace->segScanSize += ss->scannedSize; /* see .workclock */
STATISTIC(trace->segCopiedSize += ss->copiedSize);
STATISTIC(++trace->segScanCount);
break;
case TraceAccountingPhaseSingleScan:
STATISTIC(trace->singleScanSize += ss->scannedSize);
STATISTIC(trace->singleCopiedSize += ss->copiedSize);
break;
default:
NOTREACHED;
}
STATISTIC(trace->fixRefCount += ss->fixRefCount);
STATISTIC(trace->segRefCount += ss->segRefCount);
STATISTIC(trace->whiteSegRefCount += ss->whiteSegRefCount);
STATISTIC(trace->nailCount += ss->nailCount);
STATISTIC(trace->snapCount += ss->snapCount);
STATISTIC(trace->forwardedCount += ss->forwardedCount);
trace->forwardedSize += ss->forwardedSize; /* see .message.data */
STATISTIC(trace->preservedInPlaceCount += ss->preservedInPlaceCount);
trace->preservedInPlaceSize += ss->preservedInPlaceSize;
return;
}
/* TraceSetUpdateCounts -- update counts for a set of traces */
static void TraceSetUpdateCounts(TraceSet ts, Arena arena,
ScanState ss,
TraceAccountingPhase phase)
{
TraceId ti; Trace trace;
TRACE_SET_ITER(ti, trace, ts, arena)
TraceUpdateCounts(trace, ss, phase);
TRACE_SET_ITER_END(ti, trace, ts, arena);
return;
}
/* TraceSetSignalEmergency
*
* Moves a set of traces into emergency mode. */
static void TraceSetSignalEmergency(TraceSet ts, Arena arena)
{
TraceId ti;
AVER(TraceSetCheck(ts));
AVERT(Arena, arena);
for(ti = 0; ti < TRACE_MAX; ++ti) {
if(TraceSetIsMember(ts, ti)) {
ArenaTrace(arena, ti)->emergency = TRUE;
}
}
return;
}
/* Collection control parameters @@@@ */
/* Defined here, because they are used by more than one module (pool). */
/* They have the wrong name because they originally came from AMC, and */
/* binary compatibility is required. */
unsigned long AMCGen0Frequency = 4;
unsigned long AMCGen1Frequency = 32;
unsigned long AMCGen2Frequency = 200;
unsigned long AMCGen2plusFrequencyMultiplier = 1000;
unsigned long AMCGen0RampmodeFrequency = 4;
unsigned long AMCGen1RampmodeFrequency = 20;
unsigned long AMCRampGenFrequency = 300;
unsigned long AMCGen2RampmodeFrequency = 1000;
unsigned long AMCGen2plusRampmodeFrequencyMultiplier = 1000;
Serial AMCRampGenFollows = 1;
Serial AMCGenFinal = 0; /* default: no final generation */
double TraceGen0IncrementalityMultiple = 0.5;
double TraceMortalityEstimate = 0.5;
/* TraceSetWhiteUnion
*
* Returns a RefSet describing the union of the white sets
* of all the specified traces. */
static RefSet TraceSetWhiteUnion(TraceSet ts, Arena arena)
{
TraceId ti;
RefSet white = RefSetEMPTY;
/* static function used internally, no checking */
for(ti = 0; ti < TRACE_MAX; ++ti) {
if(TraceSetIsMember(ts, ti)) {
white = RefSetUnion(white, ArenaTrace(arena, ti)->white);
}
}
return white;
}
/* TraceAddWhite -- add a segment to the white set of a trace */
Res TraceAddWhite(Trace trace, Seg seg)
{
Res res;
Pool pool;
AVERT(Trace, trace);
AVERT(Seg, seg);
AVER(!TraceSetIsMember(SegWhite(seg), trace->ti)); /* .start.black */
pool = SegPool(seg);
AVERT(Pool, pool);
/* Give the pool the opportunity to turn the segment white. */
/* If it fails, unwind. */
res = PoolWhiten(pool, trace, seg);
if(res != ResOK)
return res;
/* Add the segment to the approximation of the white set the */
/* pool made it white. */
if(TraceSetIsMember(SegWhite(seg), trace->ti)) {
trace->white = RefSetUnion(trace->white,
RefSetOfSeg(trace->arena, seg));
/* if the pool is a moving GC, then condemned objects may move */
if(pool->class->attr & AttrMOVINGGC) {
trace->mayMove = RefSetUnion(trace->mayMove,
RefSetOfSeg(PoolArena(pool), seg));
}
}
return ResOK;
}
/* TraceCondemnRefSet -- condemn a set of objects
*
* TraceCondemnRefSet is passed a trace in state TraceINIT,
* and a set of objects to condemn.
*
* @@@@ For efficiency, we ought to find the condemned set and
* the foundation in one search of the segment ring. This hasn't
* been done because some pools still use TraceAddWhite for the
* condemned set.
*
* @@@@ This function would be more efficient if there were a
* cheaper way to select the segments in a particular zone set.
*/
Res TraceCondemnRefSet(Trace trace, RefSet condemnedSet)
{
Seg seg;
Arena arena;
Res res;
AVERT(Trace, trace);
AVERT(RefSet, condemnedSet);
AVER(condemnedSet != RefSetEMPTY);
AVER(trace->state == TraceINIT);
AVER(trace->white == RefSetEMPTY);
arena = trace->arena;
if(SegFirst(&seg, arena)) {
Addr base;
do {
base = SegBase(seg);
/* Segment should be black now. */
AVER(!TraceSetIsMember(SegGrey(seg), trace->ti));
AVER(!TraceSetIsMember(SegWhite(seg), trace->ti));
/* A segment can only be white if it is GC-able. */
/* This is indicated by the pool having the GC attribute */
/* We only condemn segments that fall entirely within */
/* the requested zone set. Otherwise, we would bloat the */
/* foundation to no gain. Note that this doesn't exclude */
/* any segments from which the condemned set was derived, */
if((SegPool(seg)->class->attr & AttrGC) != 0 &&
RefSetSuper(condemnedSet, RefSetOfSeg(arena, seg))) {
res = TraceAddWhite(trace, seg);
if(res != ResOK)
return res;
}
} while(SegNext(&seg, arena, base));
}
/* The trace's white set must be a subset of the condemned set */
AVER(RefSetSuper(condemnedSet, trace->white));
return ResOK;
}
/* TraceFlipBuffers -- flip all buffers in the arena */
static void TraceFlipBuffers(Arena arena)
{
Ring poolRing, poolNode, bufferRing, bufferNode;
AVERT(Arena, arena);
poolRing = ArenaPoolRing(arena);
poolNode = RingNext(poolRing);
while(poolNode != poolRing) {
Ring poolNext = RingNext(poolNode);
Pool pool = RING_ELT(Pool, arenaRing, poolNode);
AVERT(Pool, pool);
bufferRing = &pool->bufferRing;
bufferNode = RingNext(bufferRing);
while(bufferNode != bufferRing) {
Ring bufferNext = RingNext(bufferNode);
Buffer buffer = RING_ELT(Buffer, poolRing, bufferNode);
AVERT(Buffer, buffer);
BufferFlip(buffer);
bufferNode = bufferNext;
}
poolNode = poolNext;
}
}
/* TraceRootScanRes
*
* Scans a root. By calling RootScan mostly.
* This version is allowed to fail and returns an appropriate result
* code. */
static Res TraceScanRootRes(TraceSet ts, Rank rank, Arena arena, Root root)
{
RefSet white;
Res res;
ScanStateStruct ss;
/* static function used internally, no checking */
white = TraceSetWhiteUnion(ts, arena);
ScanStateInit(&ss, ts, arena, rank, white);
res = RootScan(&ss, root);
TraceSetUpdateCounts(ts, arena, &ss, TraceAccountingPhaseRootScan);
ScanStateFinish(&ss);
return res;
}
/* TraceScanRoot
*
* Scan a root without fail. The traces may enter emergency mode
* to ensure this. */
static void TraceScanRoot(TraceSet ts, Rank rank, Arena arena, Root root)
{
Res res;
AVER(TraceSetCheck(ts));
AVER(RankCheck(rank));
AVERT(Arena, arena);
AVERT(Root, root);
res = TraceScanRootRes(ts, rank, arena, root);
if(res != ResOK) {
TraceSetSignalEmergency(ts, arena);
res = TraceScanRootRes(ts, rank, arena, root);
/* Should be OK in emergency mode */
}
AVER(ResOK == res);
return;
}
/* TraceFlip -- blacken the mutator */
static void TraceFlip(Trace trace)
{
Ring node, nextNode;
Arena arena;
Rank rank;
TraceSet traceSingleton;
AVERT(Trace, trace);
traceSingleton = TraceSetSingle(trace->ti);
arena = trace->arena;
ShieldSuspend(arena);
AVER(trace->state == TraceUNFLIPPED);
AVER(!TraceSetIsMember(arena->flippedTraces, trace->ti));
EVENT_PP(TraceFlipBegin, trace, arena);
TraceFlipBuffers(arena);
/* Update location dependency structures. */
/* mayMove is a conservative approximation of the refset of refs */
/* which may move during this collection. */
if(trace->mayMove != RefSetEMPTY) {
LDAge(arena, trace->mayMove);
}
/* At the moment we must scan all roots, because we don't have */
/* a mechanism for shielding them. There can't be any weak or */
/* final roots either, since we must protect these in order to */
/* avoid scanning them too early, before the pool contents. */
/* @@@@ This isn't correct if there are higher ranking roots than */
/* data in pools. */
for(rank = RankAMBIG; rank <= RankEXACT; ++rank) {
RING_FOR(node, ArenaRootRing(arena), nextNode) {
Root root = RING_ELT(Root, arenaRing, node);
AVER(RootRank(root) <= RankEXACT); /* see above */
if(RootRank(root) == rank) {
TraceScanRoot(traceSingleton, rank, arena, root);
}
}
}
/* .flip.alloc: Allocation needs to become black now. While we flip */
/* at the start, we can get away with always allocating black. This */
/* needs to change when we flip later (i.e. have a read-barrier */
/* collector), so that we allocate grey or white before the flip */
/* and black afterwards. For instance, see */
/* design.mps.poolams.invariant.alloc. */
/* Now that the mutator is black we must prevent it from reading */
/* grey objects so that it can't obtain white pointers. This is */
/* achieved by read protecting all segments containing objects */
/* which are grey for any of the flipped traces. */
for(rank = 0; rank < RankMAX; ++rank)
RING_FOR(node, ArenaGreyRing(arena, rank), nextNode) {
Seg seg = SegOfGreyRing(node);
if(TraceSetInter(SegGrey(seg),
arena->flippedTraces) == TraceSetEMPTY &&
TraceSetIsMember(SegGrey(seg), trace->ti))
ShieldRaise(arena, seg, AccessREAD);
}
/* @@@@ When write barrier collection is implemented, this is where */
/* write protection should be removed for all segments which are */
/* no longer blacker than the mutator. Possibly this can be done */
/* lazily as they are touched. */
/* Mark the trace as flipped. */
trace->state = TraceFLIPPED;
arena->flippedTraces = TraceSetAdd(arena->flippedTraces, trace->ti);
EVENT_PP(TraceFlipEnd, trace, arena);
ShieldResume(arena);
return;
}
/* TraceStart -- condemn a set of objects and start collection
*
* TraceStart should be passed a trace with state TraceINIT, i.e.,
* recently returned from TraceCreate, with some condemned segments
* added. mortality is the fraction of the condemned set expected
* to survive. finishingTime is relative to the current polling clock,
* see design.mps.arena.poll.clock.
*
* .start.black: All segments are black w.r.t. a newly allocated trace.
* However, if TraceStart initialized segments to black when it
* calculated the grey set then this condition could be relaxed, making
* it easy to destroy traces half-way through.
*/
void TraceStart(Trace trace, double mortality, double finishingTime)
{
Ring ring, node;
Arena arena;
Seg seg;
Size size;
AVERT(Trace, trace);
AVER(trace->state == TraceINIT);
AVER(0.0 <= mortality && mortality <= 1.0);
arena = trace->arena;
AVER(finishingTime >= 0.0);
/* From the already set up white set, derive a grey set. */
/* @@@@ Instead of iterating over all the segments, we could */
/* iterate over all pools which are scannable and thence over */
/* all their segments. This might be better if the minority */
/* of segments are scannable. Perhaps we should choose */
/* dynamically which method to use. */
if(SegFirst(&seg, arena)) {
Addr base;
do {
base = SegBase(seg);
size = SegSize(seg);
/* Segment should be either black or white by now. */
AVER(!TraceSetIsMember(SegGrey(seg), trace->ti));
/* A segment can only be grey if it contains some references. */
/* This is indicated by the rankSet begin non-empty. Such */
/* segments may only belong to scannable pools. */
if(SegRankSet(seg) != RankSetEMPTY) {
/* Segments with ranks may only belong to scannable pools. */
AVER((SegPool(seg)->class->attr & AttrSCAN) != 0);
/* Turn the segment grey if there might be a reference in it */
/* to the white set. This is done by seeing if the summary */
/* of references in the segment intersects with the */
/* approximation to the white set. */
if(RefSetInter(SegSummary(seg), trace->white) != RefSetEMPTY) {
PoolGrey(SegPool(seg), trace, seg);
if(TraceSetIsMember(SegGrey(seg), trace->ti))
trace->foundation += size;
}
if((SegPool(seg)->class->attr & AttrGC) &&
!TraceSetIsMember(SegWhite(seg), trace->ti))
trace->notCondemned += size;
}
} while(SegNext(&seg, arena, base));
}
ring = ArenaRootRing(arena);
node = RingNext(ring);
while(node != ring) {
Ring next = RingNext(node);
Root root = RING_ELT(Root, arenaRing, node);
if(RefSetInter(root->summary, trace->white) != RefSetEMPTY)
RootGrey(root, trace);
node = next;
}
STATISTIC_STAT(EVENT_PW(ArenaWriteFaults, arena,
arena->writeBarrierHitCount));
/* Calculate the rate of scanning. */
{
Size sSurvivors = (Size)(trace->condemned * (1.0 - mortality));
double nPolls = finishingTime / ARENA_POLL_MAX;
/* There must be at least one poll. */
if(nPolls < 1.0)
nPolls = 1.0;
/* We use casting to long to truncate nPolls down to the nearest */
/* integer, so try to make sure it fits. */
if(nPolls >= (double)LONG_MAX)
nPolls = (double)LONG_MAX;
/* rate equals scanning work per number of polls available */
trace->rate = (trace->foundation + sSurvivors) / (long)nPolls + 1;
}
STATISTIC_STAT(EVENT_PWWWWDD
(TraceStatCondemn, trace,
trace->condemned, trace->notCondemned,
trace->foundation, trace->rate,
mortality, finishingTime));
trace->state = TraceUNFLIPPED;
/* All traces must flip at beginning at the moment. */
TraceFlip(trace);
return;
}
/* TraceCreate -- create a Trace object
*
* Allocates and initializes a new Trace object with a TraceId
* which is not currently active.
*
* Returns ResLIMIT if there aren't any available trace IDs.
*
* Trace objects are allocated directly from a small array in the
* arena structure which is indexed by the TraceId. This is so
* that it's always possible to start a trace (provided there's
* a free TraceId) even if there's no available memory.
*
* This code is written to be adaptable to allocating Trace
* objects dynamically.
*/
Res TraceCreate(Trace *traceReturn, Arena arena)
{
TraceId ti;
Trace trace;
AVER(TRACE_MAX == 1); /* .single-collection */
AVER(traceReturn != NULL);
AVERT(Arena, arena);
/* Find a free trace ID */
for(ti = 0; ti < TRACE_MAX; ++ti)
if(!TraceSetIsMember(arena->busyTraces, ti))
goto found;
return ResLIMIT; /* no trace IDs available */
found:
trace = ArenaTrace(arena, ti);
AVER(trace->sig == SigInvalid); /* design.mps.arena.trace.invalid */
arena->busyTraces = TraceSetAdd(arena->busyTraces, ti);
trace->arena = arena;
trace->white = RefSetEMPTY;
trace->mayMove = RefSetEMPTY;
trace->ti = ti;
trace->state = TraceINIT;
trace->emergency = FALSE;
trace->condemned = (Size)0; /* nothing condemned yet */
trace->notCondemned = (Size)0;
trace->foundation = (Size)0; /* nothing grey yet */
trace->rate = (Size)0; /* no scanning to be done yet */
STATISTIC(trace->greySegCount = (Count)0);
STATISTIC(trace->greySegMax = (Count)0);
STATISTIC(trace->rootScanCount = (Count)0);
STATISTIC(trace->rootScanSize = (Size)0);
STATISTIC(trace->rootCopiedSize = (Size)0);
STATISTIC(trace->segScanCount = (Count)0);
trace->segScanSize = (Size)0; /* see .workclock */
STATISTIC(trace->segCopiedSize = (Size)0);
STATISTIC(trace->singleScanCount = (Count)0);
STATISTIC(trace->singleScanSize = (Size)0);
STATISTIC(trace->singleCopiedSize = (Size)0);
STATISTIC(trace->fixRefCount = (Count)0);
STATISTIC(trace->segRefCount = (Count)0);
STATISTIC(trace->whiteSegRefCount = (Count)0);
STATISTIC(trace->nailCount = (Count)0);
STATISTIC(trace->snapCount = (Count)0);
STATISTIC(trace->readBarrierHitCount = (Count)0);
STATISTIC(trace->pointlessScanCount = (Count)0);
STATISTIC(trace->forwardedCount = (Count)0);
trace->forwardedSize = (Size)0; /* see .message.data */
STATISTIC(trace->preservedInPlaceCount = (Count)0);
trace->preservedInPlaceSize = (Size)0; /* see .message.data */
STATISTIC(trace->reclaimCount = (Count)0);
STATISTIC(trace->reclaimSize = (Size)0);
trace->sig = TraceSig;
AVERT(Trace, trace);
/* We suspend the mutator threads so that the PoolWhiten methods */
/* can calculate white sets without the mutator allocating in */
/* buffers under our feet. */
/* @@@@ This is a short-term fix for change.dylan.crow.160098, */
/* and should receive a long-term fix in change.dylan.dove.160098. */
ShieldSuspend(arena);
*traceReturn = trace;
return ResOK;
}
/* TraceDestroy -- destroy a trace object
*
* Finish and deallocate a Trace object, freeing up a TraceId.
*
* This code does not allow a Trace to be destroyed while it is
* active. It would be possible to allow this, but the colours
* of segments etc. would need to be reset to black.
*/
void TraceDestroy(Trace trace)
{
AVERT(Trace, trace);
AVER(trace->state == TraceFINISHED);
STATISTIC_STAT(EVENT_PWWWWWWWWWWWW
(TraceStatScan, trace,
trace->rootScanCount, trace->rootScanSize,
trace->rootCopiedSize,
trace->segScanCount, trace->segScanSize,
trace->segCopiedSize,
trace->singleScanCount, trace->singleScanSize,
trace->singleCopiedSize,
trace->readBarrierHitCount, trace->greySegMax,
trace->pointlessScanCount));
STATISTIC_STAT(EVENT_PWWWWWWWWW
(TraceStatFix, trace,
trace->fixRefCount, trace->segRefCount,
trace->whiteSegRefCount,
trace->nailCount, trace->snapCount,
trace->forwardedCount, trace->forwardedSize,
trace->preservedInPlaceCount,
trace->preservedInPlaceSize));
STATISTIC_STAT(EVENT_PWW
(TraceStatReclaim, trace,
trace->reclaimCount, trace->reclaimSize));
trace->sig = SigInvalid;
trace->arena->busyTraces =
TraceSetDel(trace->arena->busyTraces, trace->ti);
trace->arena->flippedTraces =
TraceSetDel(trace->arena->flippedTraces, trace->ti);
EVENT_P(TraceDestroy, trace);
}
/* TracePostMessage -- post trace end message
*
* .message.data: The trace end message contains the live size
* (forwardedSize + preservedInPlaceSize), the condemned size
* (condemned), and the not-condemned size (notCondemned).
*/
static void TracePostMessage(Trace trace)
{
Arena arena;
void *p;
TraceMessage traceMessage;
Res res;
AVERT(Trace, trace);
AVER(trace->state == TraceFINISHED);
arena = trace->arena;
res = ControlAlloc(&p, arena, sizeof(TraceMessageStruct),
/* withReservoirPermit */ FALSE);
if(res == ResOK) {
traceMessage = (TraceMessage)p;
TraceMessageInit(arena, traceMessage);
traceMessage->liveSize = trace->forwardedSize + trace->preservedInPlaceSize;
traceMessage->condemnedSize = trace->condemned;
traceMessage->notCondemnedSize = trace->notCondemned;
MessagePost(arena, TraceMessageMessage(traceMessage));
}
return;
}
static void TraceReclaim(Trace trace)
{
Arena arena;
Seg seg;
AVERT(Trace, trace);
AVER(trace->state == TraceRECLAIM);
EVENT_P(TraceReclaim, trace);
arena = trace->arena;
if(SegFirst(&seg, arena)) {
Addr base;
do {
base = SegBase(seg);
/* There shouldn't be any grey stuff left for this trace. */
AVER_CRITICAL(!TraceSetIsMember(SegGrey(seg), trace->ti));
if(TraceSetIsMember(SegWhite(seg), trace->ti)) {
AVER_CRITICAL((SegPool(seg)->class->attr & AttrGC) != 0);
STATISTIC(++trace->reclaimCount);
PoolReclaim(SegPool(seg), trace, seg);
/* If the segment still exists, it should no longer be white. */
/* Note that the seg returned by this SegOfAddr may not be */
/* the same as the one above, but in that case it's new and */
/* still shouldn't be white for this trace. */
/* The code from the class-specific reclaim methods to */
/* unwhiten the segment could in fact be moved here. */
{
Seg nonWhiteSeg = NULL; /* prevents compiler warning */
AVER_CRITICAL(!(SegOfAddr(&nonWhiteSeg, arena, base)
&& TraceSetIsMember(SegWhite(nonWhiteSeg),
trace->ti)));
}
}
} while(SegNext(&seg, arena, base));
}
trace->state = TraceFINISHED;
TracePostMessage(trace);
return;
}
/* traceFindGrey -- find a grey segment
*
* This function finds a segment which is grey for any of the traces
* in ts and which does not have a higher rank than any other such
* segment (i.e. a next segment to scan).
*
* This is equivalent to choosing a grey node from the grey set
* of a partition.
*/
static Bool traceFindGrey(Seg *segReturn, Rank *rankReturn,
Arena arena, TraceId ti)
{
Rank rank;
Trace trace;
Ring node, nextNode;
AVER(segReturn != NULL);
AVERT(Arena, arena);
AVER(TraceIdCheck(ti));
trace = ArenaTrace(arena, ti);
for(rank = 0; rank < RankMAX; ++rank) {
RING_FOR(node, ArenaGreyRing(arena, rank), nextNode) {
Seg seg = SegOfGreyRing(node);
AVERT(Seg, seg);
AVER(SegGrey(seg) != TraceSetEMPTY);
AVER(RankSetIsMember(SegRankSet(seg), rank));
if(TraceSetIsMember(SegGrey(seg), ti)) {
*segReturn = seg;
*rankReturn = rank;
return TRUE;
}
}
}
/* There are no grey segments for this trace. */
return FALSE;
}
/* ScanStateSetSummary -- set the summary of scanned references
*
* This function sets unfixedSummary and fixedSummary such that
* ScanStateSummary will return the summary passed. Subsequently
* fixed references are accumulated into this result.
*/
void ScanStateSetSummary(ScanState ss, RefSet summary)
{
AVERT(ScanState, ss);
AVERT(RefSet, summary);
ss->unfixedSummary = RefSetEMPTY;
ss->fixedSummary = summary;
AVER(ScanStateSummary(ss) == summary);
}
/* ScanStateSummary -- calculate the summary of scanned references
*
* The summary of the scanned references is the summary of the
* unfixed references, minus the white set, plus the summary of the
* fixed references. This is because TraceFix is called for all
* references in the white set, and accumulates a summary of
* references after they have been fixed.
*/
RefSet ScanStateSummary(ScanState ss)
{
AVERT(ScanState, ss);
return TraceSetUnion(ss->fixedSummary,
TraceSetDiff(ss->unfixedSummary, ss->white));
}
/* TraceScanSegRes -- scan a segment to remove greyness
*
* @@@@ During scanning, the segment should be write-shielded to
* prevent any other threads from updating it while fix is being
* applied to it (because fix is not atomic). At the moment, we
* don't bother, because we know that all threads are suspended.
*/
static Res TraceScanSegRes(TraceSet ts, Rank rank, Arena arena, Seg seg)
{
Bool wasTotal;
RefSet white;
Res res;
AVER(TraceSetCheck(ts));
AVER(RankCheck(rank));
AVERT(Arena, arena);
AVER(SegCheck(seg));
/* The reason for scanning a segment is that it's grey. */
AVER(TraceSetInter(ts, SegGrey(seg)) != TraceSetEMPTY);
EVENT_UUPP(TraceScanSeg, ts, rank, arena, seg);
white = TraceSetWhiteUnion(ts, arena);
/* only scan a segment if it refers to the white set */
if(RefSetInter(white, SegSummary(seg)) == RefSetEMPTY) { /* blacken it */
PoolBlacken(SegPool(seg), ts, seg);
/* setup result code to return later */
res = ResOK;
} else { /* scan it */
ScanStateStruct ss;
ScanStateInit(&ss, ts, arena, rank, white);
/* Expose the segment to make sure we can scan it. */
ShieldExpose(arena, seg);
res = PoolScan(&wasTotal, &ss, SegPool(seg), seg);
/* Cover, regardless of result */
ShieldCover(arena, seg);
TraceSetUpdateCounts(ts, arena, &ss, TraceAccountingPhaseSegScan);
/* Count segments scanned pointlessly */
STATISTIC_STAT
({
TraceId ti; Trace trace;
Count whiteSegRefCount = 0;
TRACE_SET_ITER(ti, trace, ts, arena)
whiteSegRefCount += trace->whiteSegRefCount;
TRACE_SET_ITER_END(ti, trace, ts, arena);
if(whiteSegRefCount == 0)
TRACE_SET_ITER(ti, trace, ts, arena)
++trace->pointlessScanCount;
TRACE_SET_ITER_END(ti, trace, ts, arena);
});
/* following is true whether or not scan was total */
/* See design.mps.scan.summary.subset. */
AVER(RefSetSub(ss.unfixedSummary, SegSummary(seg)));
if(res != ResOK || !wasTotal) {
/* scan was partial, so... */
/* scanned summary should be ORed into segment summary. */
SegSetSummary(seg, RefSetUnion(SegSummary(seg),
ScanStateSummary(&ss)));
} else {
/* all objects on segment have been scanned, so... */
/* scanned summary should replace the segment summary. */
SegSetSummary(seg, ScanStateSummary(&ss));
}
ScanStateFinish(&ss);
}
if(res == ResOK) {
/* The segment is now black only if scan was successful. */
/* Remove the greyness from it. */
SegSetGrey(seg, TraceSetDiff(SegGrey(seg), ts));
}
return res;
}
/* TraceScanSeg
*
* Scans a segment without fail. May put the traces into emergency
* mode to ensure this. */
static void TraceScanSeg(TraceSet ts, Rank rank, Arena arena, Seg seg)
{
Res res;
AVER(TraceSetCheck(ts));
AVER(RankCheck(rank));
AVERT(Arena, arena);
AVER(SegCheck(seg));
res = TraceScanSegRes(ts, rank, arena, seg);
if(res != ResOK) {
TraceSetSignalEmergency(ts, arena);
res = TraceScanSegRes(ts, rank, arena, seg);
/* should be OK in emergency mode */
}
AVER(ResOK == res);
return;
}
void TraceSegAccess(Arena arena, Seg seg, AccessSet mode)
{
TraceId ti;
AVERT(Arena, arena);
AVERT(Seg, seg);
/* If it's a read access, then the segment must be grey for a trace */
/* which is flipped. */
AVER((mode & SegSM(seg) & AccessREAD) == 0
|| TraceSetInter(SegGrey(seg), arena->flippedTraces)
!= TraceSetEMPTY);
/* If it's a write acess, then the segment must have a summary that */
/* is smaller than the mutator's summary (which is assumed to be */
/* RefSetUNIV). */
AVER((mode & SegSM(seg) & AccessWRITE) == 0
|| SegSummary(seg) != RefSetUNIV);
EVENT_PPU(TraceAccess, arena, seg, mode);
if((mode & SegSM(seg) & AccessREAD) != 0) { /* read barrier? */
/* Pick set of traces to scan for: */
TraceSet traces = arena->flippedTraces;
/* .scan.conservative: At the moment we scan at RankEXACT. Really */
/* we should be scanning at the "phase" of the trace, which is the */
/* minimum rank of all grey segments. (see request.mps.170160) */
TraceScanSeg(traces, RankEXACT, arena, seg);
/* The pool should've done the job of removing the greyness that */
/* was causing the segment to be protected, so that the mutator */
/* can go ahead and access it. */
AVER(TraceSetInter(SegGrey(seg), traces) == TraceSetEMPTY);
STATISTIC_STAT(for(ti = 0; ti < TRACE_MAX; ++ti)
if(TraceSetIsMember(traces, ti))
++ArenaTrace(arena, ti)->readBarrierHitCount);
} else { /* write barrier */
STATISTIC(++arena->writeBarrierHitCount);
}
/* The write barrier handling must come after the read barrier, */
/* because the latter may set the summary and raise the write barrier. */
if((mode & SegSM(seg) & AccessWRITE) != 0) /* write barrier? */
SegSetSummary(seg, RefSetUNIV);
/* The segment must now be accessible. */
AVER((mode & SegSM(seg)) == AccessSetEMPTY);
}
static Res TraceRun(Trace trace)
{
Res res;
Arena arena;
Seg seg;
Rank rank;
AVERT(Trace, trace);
AVER(trace->state == TraceFLIPPED);
arena = trace->arena;
if(traceFindGrey(&seg, &rank, arena, trace->ti)) {
AVER((SegPool(seg)->class->attr & AttrSCAN) != 0);
res = TraceScanSegRes(TraceSetSingle(trace->ti), rank, arena, seg);
if(res != ResOK)
return res;
} else
trace->state = TraceRECLAIM;
return ResOK;
}
/* TraceWorkClock -- a measure of the work done for this trace */
static Size TraceWorkClock(Trace trace)
{
AVERT(Trace, trace);
/* .workclock: Segment scanning work is the regulator. */
return trace->segScanSize;
}
/* TraceExpedite -- signals an emergency on the trace and */
/* moves it to the Finished state. */
static void TraceExpedite(Trace trace)
{
AVERT(Trace, trace);
trace->emergency = TRUE;
while(trace->state != TraceFINISHED) {
Res res = TraceStep(trace);
/* because we are using emergencyFix the trace shouldn't */
/* raise any error conditions */
AVER(res == ResOK);
}
}
/* TraceStep -- progresses a trace by some small amount */
Res TraceStep(Trace trace)
{
Arena arena;
Res res;
AVERT(Trace, trace);
arena = trace->arena;
EVENT_PP(TraceStep, trace, arena);
switch(trace->state) {
case TraceUNFLIPPED:
/* all traces are flipped in TraceStart at the moment */
NOTREACHED;
break;
case TraceFLIPPED:
res = TraceRun(trace);
if(res != ResOK)
return res;
break;
case TraceRECLAIM:
TraceReclaim(trace);
break;
default:
NOTREACHED;
break;
}
return ResOK;
}
/* TracePoll -- progresses a trace, without returning errors */
void TracePoll(Trace trace)
{
Res res;
Size pollEnd;
AVERT(Trace, trace);
pollEnd = TraceWorkClock(trace) + trace->rate;
do {
res = TraceStep(trace);
if(res != ResOK) {
AVER(ResIsAllocFailure(res));
TraceExpedite(trace);
AVER(trace->state == TraceFINISHED);
return;
}
} while(trace->state != TraceFINISHED
&& TraceWorkClock(trace) < pollEnd);
}
/* TraceGreyEstimate -- estimate amount of grey stuff
*
* This function returns an estimate of the total size (in bytes)
* of objects which would need to be scanned in order to find
* all references to a certain RefSet.
*
* @@@@ This currently assumes that it's everything in the world.
* @@@@ Should factor in the size of the roots, especially if the stack
* is currently very deep.
*/
Size TraceGreyEstimate(Arena arena, RefSet refSet)
{
UNUSED(refSet);
return ArenaCommitted(arena);
}
Res TraceFix(ScanState ss, Ref *refIO)
{
Ref ref;
Tract tract;
Pool pool;
/* See design.mps.trace.fix.noaver */
AVERT_CRITICAL(ScanState, ss);
AVER_CRITICAL(refIO != NULL);
ref = *refIO;
STATISTIC(++ss->fixRefCount);
EVENT_PPAU(TraceFix, ss, refIO, ref, ss->rank);
/* TractOfAddr is inlined, see design.mps.trace.fix.tractofaddr */
if(TRACT_OF_ADDR(&tract, ss->arena, ref)) {
if(TraceSetInter(TractWhite(tract), ss->traces) != TraceSetEMPTY) {
Seg seg;
if (TRACT_SEG(&seg, tract)) {
Res res;
STATISTIC(++ss->segRefCount);
STATISTIC(++ss->whiteSegRefCount);
EVENT_P(TraceFixSeg, seg);
EVENT_0(TraceFixWhite);
pool = TractPool(tract);
/* Could move the rank switch here from the class-specific */
/* fix methods. */
res = PoolFix(pool, ss, seg, refIO);
if(res != ResOK)
return res;
}
} else {
/* Tract isn't white. Don't compute seg for non-statistical */
/* variety. See design.mps.trace.fix.tractofaddr */
STATISTIC_STAT
({
Seg seg;
if (TRACT_SEG(&seg, tract)) {
++ss->segRefCount;
EVENT_P(TraceFixSeg, seg);
}
});
}
} else {
/* See design.mps.trace.exact.legal */
AVER(ss->rank < RankEXACT
|| !ArenaIsReservedAddr(ss->arena, ref));
}
/* See design.mps.trace.fix.fixed.all */
ss->fixedSummary = RefSetAdd(ss->arena, ss->fixedSummary, *refIO);
return ResOK;
}
Res TraceFixEmergency(ScanState ss, Ref *refIO)
{
Ref ref;
Tract tract;
Pool pool;
AVERT(ScanState, ss);
AVER(refIO != NULL);
ref = *refIO;
STATISTIC(++ss->fixRefCount);
EVENT_PPAU(TraceFix, ss, refIO, ref, ss->rank);
/* TractOfAddr is inlined, see design.mps.trace.fix.tractofaddr */
if(TRACT_OF_ADDR(&tract, ss->arena, ref)) {
if(TraceSetInter(TractWhite(tract), ss->traces) != TraceSetEMPTY) {
Seg seg;
if (TRACT_SEG(&seg, tract)) {
STATISTIC(++ss->segRefCount);
STATISTIC(++ss->whiteSegRefCount);
EVENT_P(TraceFixSeg, seg);
EVENT_0(TraceFixWhite);
pool = TractPool(tract);
PoolFixEmergency(pool, ss, seg, refIO);
}
} else {
/* Tract isn't white. Don't compute seg for non-statistical */
/* variety. See design.mps.trace.fix.tractofaddr */
STATISTIC_STAT
({
Seg seg;
if (TRACT_SEG(&seg, tract)) {
++ss->segRefCount;
EVENT_P(TraceFixSeg, seg);
}
});
}
} else {
/* See design.mps.trace.exact.legal */
AVER(ss->rank < RankEXACT ||
!ArenaIsReservedAddr(ss->arena, ref));
}
/* See design.mps.trace.fix.fixed.all */
ss->fixedSummary = RefSetAdd(ss->arena, ss->fixedSummary, *refIO);
return ResOK;
}
/* TraceScanSingleRefRes
*
* (internal variant on TraceScanSingleRef)
* Scans a single reference (in the location specified by refIO).
* This version is allowed to fail and return an appropriate result
* code.
*/
static Res TraceScanSingleRefRes(TraceSet ts, Rank rank, Arena arena,
Seg seg, Ref *refIO)
{
RefSet summary;
RefSet white;
Res res;
ScanStateStruct ss;
/* static function used internally, no checking */
EVENT_UUPA(TraceScanSingleRef, ts, rank, arena, (Addr)refIO);
white = TraceSetWhiteUnion(ts, arena);
if(RefSetInter(SegSummary(seg), white) == RefSetEMPTY) {
return ResOK;
}
ScanStateInit(&ss, ts, arena, rank, white);
ShieldExpose(arena, seg);
TRACE_SCAN_BEGIN(&ss) {
res = TRACE_FIX(&ss, refIO);
} TRACE_SCAN_END(&ss);
ss.scannedSize = sizeof *refIO;
summary = SegSummary(seg);
summary = RefSetAdd(arena, summary, *refIO);
SegSetSummary(seg, summary);
ShieldCover(arena, seg);
TraceSetUpdateCounts(ts, arena, &ss, TraceAccountingPhaseSingleScan);
ScanStateFinish(&ss);
return res;
}
/* TraceScanSingleRef
*
* The exported function to scan a single reference. This one can't
* fail. It may put the traces into emergency mode in order to
* achieve this. */
void TraceScanSingleRef(TraceSet ts, Rank rank, Arena arena,
Seg seg, Ref *refIO)
{
Res res;
AVER(TraceSetCheck(ts));
AVER(RankCheck(rank));
AVERT(Arena, arena);
AVER(SegCheck(seg));
AVER(refIO != NULL);
res = TraceScanSingleRefRes(ts, rank, arena, seg, refIO);
if(res != ResOK) {
TraceSetSignalEmergency(ts, arena);
res = TraceScanSingleRefRes(ts, rank, arena, seg, refIO);
/* ought to be OK in emergency mode now */
}
AVER(ResOK == res);
return;
}
/* TraceScanArea -- scan contiguous area of references
*
* This is a convenience function for scanning the contiguous area
* [base, limit). i.e. it calls fix on all words from base up
* to limit, inclusive of base and exclusive of limit.
*/
Res TraceScanArea(ScanState ss, Addr *base, Addr *limit)
{
Res res;
Addr *p;
Ref ref;
AVER(base != NULL);
AVER(limit != NULL);
AVER(base < limit);
EVENT_PPP(TraceScanArea, ss, base, limit);
TRACE_SCAN_BEGIN(ss) {
p = base;
loop:
if(p >= limit) goto out;
ref = *p++;
if(!TRACE_FIX1(ss, ref))
goto loop;
res = TRACE_FIX2(ss, p-1);
if(res == ResOK)
goto loop;
return res;
out:
AVER(p == limit);
} TRACE_SCAN_END(ss);
return ResOK;
}
/* TraceScanAreaTagged -- scan contiguous area of tagged references
*
* This is as TraceScanArea except words are only fixed if they are
* tagged as Dylan references (i.e. bottom two bits are zero).
* @@@@ This Dylan-specificness should be generalized in some way.
*/
Res TraceScanAreaTagged(ScanState ss, Addr *base, Addr *limit)
{
return TraceScanAreaMasked(ss, base, limit, (Word)3);
}
/* TraceScanAreaMasked -- scan contiguous area of filtered references
*
* This is as TraceScanArea except words are only fixed if they
* are zero when masked with a mask.
*/
Res TraceScanAreaMasked(ScanState ss, Addr *base, Addr *limit, Word mask)
{
Res res;
Addr *p;
Ref ref;
AVER(base != NULL);
AVER(limit != NULL);
AVER(base < limit);
EVENT_PPP(TraceScanAreaTagged, ss, base, limit);
TRACE_SCAN_BEGIN(ss) {
p = base;
loop:
if(p >= limit) goto out;
ref = *p++;
if(((Word)ref & mask) != 0) goto loop;
if(!TRACE_FIX1(ss, ref)) goto loop;
res = TRACE_FIX2(ss, p-1);
if(res == ResOK)
goto loop;
return res;
out:
AVER(p == limit);
} TRACE_SCAN_END(ss);
return ResOK;
}
Reference in a new issue View git blame Copy permalink