Struct MemoryController 

pub struct MemoryController { /* private fields */ }

Global memory controller for query execution

Manages a shared memory budget across all operators in a query. Thread-safe and supports concurrent reservations.

Example

use std::sync::Arc;
use vibesql_executor::memory::{MemoryController, MemoryConfig};

let controller = Arc::new(MemoryController::new(MemoryConfig::with_budget(1024 * 1024 * 1024)));

// Create a reservation for a sort operator
let mut reservation = controller.create_reservation();

// Try to reserve memory for sorted runs
assert!(reservation.try_grow(1024 * 1024)); // Should succeed with 1GB budget
assert_eq!(reservation.reserved(), 1024 * 1024);

Implementations

impl MemoryController

pub fn new(config: MemoryConfig) -> Self

Create a new memory controller with the given configuration

pub fn with_defaults() -> Self

Create a memory controller with default configuration

pub fn with_budget(budget_bytes: usize) -> Self

Create a memory controller with a specific budget

pub fn budget(&self) -> usize

Get the total memory budget

pub fn reserved(&self) -> usize

Get the currently reserved memory

pub fn available(&self) -> usize

Get available memory (budget - reserved)

pub fn spill_threshold_bytes(&self) -> usize

Get the spill threshold in bytes

pub fn should_spill(&self) -> bool

Check if memory pressure is high (above spill threshold)

pub fn temp_directory(&self) -> &PathBuf

Get the temporary directory for spill files

pub fn target_partition_bytes(&self) -> usize

Get the target partition size for external operators

pub fn create_reservation(self: &Arc<Self>) -> MemoryReservation

Create a new memory reservation

Returns a reservation handle that tracks memory for a single operator. When the reservation is dropped, its memory is released.

pub fn record_spill(&self, bytes: usize)

Record that bytes were spilled to disk (for metrics)

pub fn bytes_spilled(&self) -> usize

Get total bytes spilled to disk

pub fn spill_count(&self) -> usize

Get number of spill operations

pub fn peak_memory(&self) -> usize

Get peak memory usage

pub fn active_reservations(&self) -> usize

Get number of active reservations

pub fn stats(&self) -> MemoryStats

Get comprehensive statistics snapshot

Trait Implementations

impl Send for MemoryController

impl Sync for MemoryController