Skip to main content

MemoryManager

Struct MemoryManager 

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

A memory tracker for the database instance.

In addition to a flat total_allocated counter, the manager routes every allocation through a MemoryAccountant so the same budget can be broken down by subsystem (buffer pool, indexes, graphs) and used to derive an effective spill threshold for the memory governor.

Implementations§

Source§

impl MemoryManager

Source

pub fn new(max_memory: u64) -> Self

Source

pub fn max_memory(&self) -> u64

Source

pub fn total_allocated(&self) -> u64

Source

pub fn allocate(&self, amount: u64)

Allocate amount bytes attributed to MemoryAccountingClass::Other.

Kept for callers that do not care about attribution; prefer MemoryManager::allocate_with.

Source

pub fn allocate_with(&self, attr: MemoryAttribution, amount: u64)

Allocate amount bytes attributed to attr (accountable allocation).

Source

pub fn deallocate(&self, amount: u64)

Release amount bytes (unattributed). Prefer MemoryManager::deallocate_with to keep per-class books balanced.

Source

pub fn deallocate_with(&self, attr: MemoryAttribution, amount: u64)

Release amount bytes previously attributed to attr.

Source

pub fn is_under_limit(&self) -> bool

Source

pub fn accountant(&self) -> &MemoryAccountant

The accountant backing this manager (live totals break down by class).

Source

pub fn effective_spill_threshold(&self) -> u64

Headroom left before the configured budget is exhausted.

Intended to be read by the spiller when deciding whether a NodeGroup / frame batch crosses the spill threshold: “how much can I still grow?”.

Source

pub fn memory_pressure(&self) -> f64

Fraction of the configured budget currently allocated, in 0.0..=1.0.

Source

pub fn is_under_memory_pressure(&self, ratio: f64) -> bool

True when allocated memory consumes at least ratio of the budget.

Trait Implementations§

Source§

impl Debug for MemoryManager

Source§

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

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

impl Default for MemoryManager

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.