Struct Reclaiming

struct Reclaiming {
    heap: BinaryHeap<Reverse<(Age, AId)>>,
    enabled: EnabledToken,
}

State while reclamation is active

Fields

heap: BinaryHeap<Reverse<(Age, AId)>>

The heap of candidates, oldest at top of heap

enabled: EnabledToken

Make this type uninhabited if memory tracking is compiled out

Implementations

impl Reclaiming

fn maybe_start(state: &mut GuardWithDeferredDrop<'_>) -> Option<Self>

Check to see if we should start reclaiming, and if so return a Reclaiming

1. Checks to see if usage is above max; if not, returns None
2. Logs that we’re starting reclamation
3. Calculates the heap of data ages

fn choose_victims( &mut self, state: &mut State, ) -> Result<Option<Vec<(AId, ProtectedArc<dyn IsParticipant>)>>, ReclaimCrashed>

If we’re reclaiming, choose the next victim(s) to reclaim

This is the account whose participant has the oldest data age, and all of that account’s children.

We might discover that we didn’t want to continue reclamation after all: this function is responsible for checking our progress against the low water mark.

If reclamation should stop, this function logs, and returns None.

async fn notify_victims( &mut self, victims: Vec<(AId, ProtectedArc<dyn IsParticipant>)>, ) -> Vec<(AId, Result<Reclaimed, VictimPanicked>)>

Notify the chosen victims and obtain their responses

This is the async part, and is done with the state unlocked.

fn handle_victim_responses( &mut self, state: &mut State, responses: Vec<(AId, Result<Reclaimed, VictimPanicked>)>, )

Process the victim’s responses and update state accordingly