Struct Residency 

pub struct Residency {
    set: Retained<ProtocolObject<dyn MTLResidencySet>>,
    base: *const u8,
    stride: usize,
    bufs: Vec<Option<Retained<ProtocolObject<dyn MTLBuffer>>>>,
    member_pos: Vec<u32>,
    members: Vec<u32>,
    last_used: Vec<u64>,
    dirty: bool,
    pub budget: usize,
}

Fields

set: Retained<ProtocolObject<dyn MTLResidencySet>>

base: *const u8

stride: usize

bufs: Vec<Option<Retained<ProtocolObject<dyn MTLBuffer>>>>

member_pos: Vec<u32>

Position in members, or u32::MAX when not in the set.

members: Vec<u32>

last_used: Vec<u64>

Step of last use per record (LRU key; also the eviction guard).

dirty: bool

Records added to the set object since the last commit.

budget: usize

Implementations

impl Residency

pub fn new( ctx: &MetalContext, base: *const u8, stride: usize, n_records: usize, budget: usize, ) -> Result<Self>

pub fn resident(&self) -> usize

pub fn is_member(&self, rid: usize) -> bool

pub fn buf( &mut self, ctx: &MetalContext, rid: usize, ) -> Result<Retained<ProtocolObject<dyn MTLBuffer>>>

The record’s sub-buffer (wrapped on first use).

pub fn addr(&mut self, ctx: &MetalContext, rid: usize) -> Result<u64>

GPU address of the record.

pub fn acquire( &mut self, ctx: &MetalContext, rids: &[usize], step: u64, ) -> Result<Vec<usize>>

This method reserves membership for the step’s records, evicting the least recently used members outside the step as needed. It returns records that still need to be read and added. Call finish once their pages are in memory.

fn evict_one(&mut self, ctx: &MetalContext, step: u64) -> Result<()>

pub fn cached(&self, rid: usize) -> bool

Whether all of the record’s pages are in memory (page cache or wired), so no read is needed before adding it.

pub fn finish(&mut self, ctx: &MetalContext, rids: &[usize]) -> Result<()>

Add records whose pages are in memory to the set and commit.

Trait Implementations

impl Send for Residency