Skip to main content

PagedKvCache

Struct PagedKvCache 

Source
pub struct PagedKvCache { /* private fields */ }
Expand description

A vLLM-style block-paged KV-cache. Instead of one contiguous pre-allocated tensor (which may fragment or require realloc), this manages memory in fixed-size 16-token blocks via a BlockTable.

Benefits:

  • No single large allocation — blocks are page-sized
  • Zero reallocation on append (new blocks allocated on demand from pool)
  • Logical-to-physical mapping via block table
  • Each block is independently cache-line friendly

Implementations§

Source§

impl PagedKvCache

Source

pub fn new(max_tokens: usize, dim: usize) -> Self

Create a paged KV-cache for max_tokens tokens of dimension dim.

Pre-allocates all blocks upfront to avoid any heap allocation during the inference loop. The number of blocks = ceil(max_tokens / 16).

Source

pub fn len(&self) -> usize

Number of tokens currently stored.

Source

pub fn is_empty(&self) -> bool

Whether no tokens are stored.

Source

pub fn max_tokens(&self) -> usize

Maximum tokens this cache can hold.

Source

pub fn dim(&self) -> usize

Hidden dimension per token.

Source

pub fn num_blocks(&self) -> usize

Number of blocks allocated.

Source

pub fn blocks_in_use(&self) -> usize

Number of blocks currently in use (partially or fully).

Source

pub fn append(&mut self, token: &[f64]) -> Result<(), RuntimeError>

Append a single token vector. Zero allocation — writes into the next available slot in the current block.

Source

pub fn append_tensor(&mut self, t: &Tensor) -> Result<(), RuntimeError>

Append a batch of tokens from a 2D tensor [n, dim].

Source

pub fn as_tensor(&self) -> Tensor

Materialize all stored tokens into a contiguous Tensor [current_len, dim].

This is a read operation that copies data from blocks into a flat buffer. The copy is required since blocks are non-contiguous.

Source

pub fn clear(&mut self)

Reset the cache to empty without deallocating blocks. Block data is retained; only cursors are reset.

Source

pub fn get_token(&self, idx: usize) -> Result<Vec<f64>, RuntimeError>

Read a single token at logical position idx.

Trait Implementations§

Source§

impl Clone for PagedKvCache

Source§

fn clone(&self) -> PagedKvCache

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PagedKvCache

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for PagedKvCache

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.