vtcode_core/core/

memory_pool.rs

//! Memory pool for reducing allocations in hot paths

use parking_lot::Mutex;
use serde_json::Value;
use std::collections::VecDeque;
use std::sync::Arc;
use vtcode_config::MemoryPoolConfig;

/// Memory pool statistics for auto-tuning
#[derive(Debug, Clone, Default)]
pub struct MemoryPoolStats {
    /// Number of successful string pool retrievals.
    pub string_hits: usize,
    /// Number of string pool misses requiring a new allocation.
    pub string_misses: usize,
    /// Number of successful value pool retrievals.
    pub value_hits: usize,
    /// Number of value pool misses requiring a new allocation.
    pub value_misses: usize,
    /// Number of successful `Vec<String>` pool retrievals.
    pub vec_hits: usize,
    /// Number of `Vec<String>` pool misses requiring a new allocation.
    pub vec_misses: usize,
    /// Total allocations avoided by reusing pooled objects.
    pub allocations_avoided: usize,
}

/// Pre-allocated memory pools for common data structures
pub struct MemoryPool {
    string_pool: Mutex<VecDeque<String>>,
    value_pool: Mutex<VecDeque<Value>>,
    vec_pool: Mutex<VecDeque<Vec<String>>>,
    stats: Mutex<MemoryPoolStats>,
}

impl MemoryPool {
    /// Create a memory pool with default capacities.
    pub fn new() -> Self {
        Self {
            string_pool: Mutex::new(VecDeque::with_capacity(64)),
            value_pool: Mutex::new(VecDeque::with_capacity(32)),
            vec_pool: Mutex::new(VecDeque::with_capacity(16)),
            stats: Mutex::new(MemoryPoolStats::default()),
        }
    }

    /// Create a new memory pool with custom sizes
    pub fn with_capacities(string_capacity: usize, value_capacity: usize, vec_capacity: usize) -> Self {
        Self {
            string_pool: Mutex::new(VecDeque::with_capacity(string_capacity)),
            value_pool: Mutex::new(VecDeque::with_capacity(value_capacity)),
            vec_pool: Mutex::new(VecDeque::with_capacity(vec_capacity)),
            stats: Mutex::new(MemoryPoolStats::default()),
        }
    }

    /// Create a memory pool from configuration
    pub fn from_config(config: &MemoryPoolConfig) -> Self {
        Self {
            string_pool: Mutex::new(VecDeque::with_capacity(config.max_string_pool_size)),
            value_pool: Mutex::new(VecDeque::with_capacity(config.max_value_pool_size)),
            vec_pool: Mutex::new(VecDeque::with_capacity(config.max_vec_pool_size)),
            stats: Mutex::new(MemoryPoolStats::default()),
        }
    }

    /// Get a reusable string, clearing it first
    pub fn get_string(&self) -> String {
        let mut stats = self.stats.lock();
        let result = self.string_pool.lock().pop_front();
        if let Some(mut s) = result {
            stats.string_hits += 1;
            stats.allocations_avoided += 1;
            s.clear();
            s
        } else {
            stats.string_misses += 1;
            String::new()
        }
    }

    /// Return a string to the pool after clearing it
    /// Optimization: Only clear if string has content, preserve capacity for reuse
    pub fn return_string(&self, mut s: String) {
        // Shrink large strings to avoid memory bloat, reuse existing allocation
        if s.capacity() > 4096 {
            s.shrink_to(256);
        }
        s.clear();
        let mut pool = self.string_pool.lock();
        // Use capacity as the limit to respect configuration
        if pool.len() < pool.capacity() {
            pool.push_back(s);
        }
    }

    /// Get a reusable Value
    pub fn get_value(&self) -> Value {
        let mut stats = self.stats.lock();
        let result = self.value_pool.lock().pop_front();
        if let Some(v) = result {
            stats.value_hits += 1;
            stats.allocations_avoided += 1;
            v
        } else {
            stats.value_misses += 1;
            Value::Null
        }
    }

    /// Return a Value to the pool
    /// Optimization: Only pool simple values to avoid memory bloat from large objects
    pub fn return_value(&self, v: Value) {
        // Optimization: Only pool null/simple values, skip large objects/arrays
        let should_pool = match &v {
            Value::Null | Value::Bool(_) | Value::Number(_) => true,
            Value::String(s) => s.len() < 1024,
            Value::Array(arr) => arr.is_empty(),
            Value::Object(obj) => obj.is_empty(),
        };

        if should_pool {
            let mut pool = self.value_pool.lock();
            if pool.len() < pool.capacity() {
                pool.push_back(v);
            }
        }
    }

    /// Get a reusable `Vec<String>`
    pub fn get_vec(&self) -> Vec<String> {
        let mut stats = self.stats.lock();
        let result = self.vec_pool.lock().pop_front();
        if let Some(mut v) = result {
            stats.vec_hits += 1;
            stats.allocations_avoided += 1;
            v.clear();
            v
        } else {
            stats.vec_misses += 1;
            Vec::new()
        }
    }

    /// Return a `Vec<String>` to the pool after clearing it
    /// Optimization: Preserve capacity for vectors with reasonable size
    pub fn return_vec(&self, mut v: Vec<String>) {
        // Optimization: Shrink large vectors to avoid memory bloat
        if v.capacity() > 128 {
            v = Vec::with_capacity(32);
        } else {
            v.clear();
        }
        let mut pool = self.vec_pool.lock();
        // Use capacity as the limit to respect configuration
        if pool.len() < pool.capacity() {
            pool.push_back(v);
        }
    }

    /// Get memory pool statistics
    pub fn get_stats(&self) -> MemoryPoolStats {
        self.stats.lock().clone()
    }

    /// Reset statistics
    pub fn reset_stats(&self) {
        *self.stats.lock() = MemoryPoolStats::default();
    }

    /// Auto-tune pool sizes based on usage patterns
    /// Returns recommendations for configuration adjustments
    pub fn auto_tune(&self, config: &MemoryPoolConfig) -> MemoryPoolTuningRecommendation {
        let stats = self.get_stats();

        // Calculate hit rates
        let string_hit_rate = if stats.string_hits + stats.string_misses > 0 {
            stats.string_hits as f64 / (stats.string_hits + stats.string_misses) as f64
        } else {
            0.0
        };

        let value_hit_rate = if stats.value_hits + stats.value_misses > 0 {
            stats.value_hits as f64 / (stats.value_hits + stats.value_misses) as f64
        } else {
            0.0
        };

        let vec_hit_rate = if stats.vec_hits + stats.vec_misses > 0 {
            stats.vec_hits as f64 / (stats.vec_hits + stats.vec_misses) as f64
        } else {
            0.0
        };

        // Calculate current pool utilization
        let string_utilization = self.string_pool.lock().len() as f64 / config.max_string_pool_size as f64;
        let value_utilization = self.value_pool.lock().len() as f64 / config.max_value_pool_size as f64;
        let vec_utilization = self.vec_pool.lock().len() as f64 / config.max_vec_pool_size as f64;

        // Generate tuning recommendations
        MemoryPoolTuningRecommendation {
            string_hit_rate,
            value_hit_rate,
            vec_hit_rate,
            string_utilization,
            value_utilization,
            vec_utilization,
            total_allocations_avoided: stats.allocations_avoided,

            // Recommendations based on usage patterns
            string_size_recommendation: calculate_size_recommendation(
                string_hit_rate,
                string_utilization,
                config.max_string_pool_size,
            ),
            value_size_recommendation: calculate_size_recommendation(
                value_hit_rate,
                value_utilization,
                config.max_value_pool_size,
            ),
            vec_size_recommendation: calculate_size_recommendation(
                vec_hit_rate,
                vec_utilization,
                config.max_vec_pool_size,
            ),
        }
    }
}

/// Calculate size recommendation based on hit rate and utilization
fn calculate_size_recommendation(hit_rate: f64, utilization: f64, current_size: usize) -> SizeRecommendation {
    if hit_rate < 0.3 {
        // Low hit rate - pool might be too small or not used effectively
        if utilization > 0.8 {
            SizeRecommendation::Increase(current_size.saturating_mul(2))
        } else {
            SizeRecommendation::Maintain
        }
    } else if hit_rate > 0.7 {
        // High hit rate - pool is working well
        if utilization > 0.9 {
            SizeRecommendation::Increase(current_size.saturating_add(16))
        } else if utilization < 0.5 {
            SizeRecommendation::Decrease(current_size.saturating_sub(8).max(16))
        } else {
            SizeRecommendation::Maintain
        }
    } else {
        // Medium hit rate
        if utilization > 0.85 {
            SizeRecommendation::Increase(current_size.saturating_add(8))
        } else {
            SizeRecommendation::Maintain
        }
    }
}

/// Memory pool tuning recommendation
#[derive(Debug, Clone)]
pub struct MemoryPoolTuningRecommendation {
    /// Hit rate for the string pool (0.0 to 1.0).
    pub string_hit_rate: f64,
    /// Hit rate for the value pool (0.0 to 1.0).
    pub value_hit_rate: f64,
    /// Hit rate for the vector pool (0.0 to 1.0).
    pub vec_hit_rate: f64,
    /// Current utilization of the string pool (0.0 to 1.0).
    pub string_utilization: f64,
    /// Current utilization of the value pool (0.0 to 1.0).
    pub value_utilization: f64,
    /// Current utilization of the vector pool (0.0 to 1.0).
    pub vec_utilization: f64,
    /// Total allocations avoided across all pools.
    pub total_allocations_avoided: usize,
    /// Recommended action for the string pool size.
    pub string_size_recommendation: SizeRecommendation,
    /// Recommended action for the value pool size.
    pub value_size_recommendation: SizeRecommendation,
    /// Recommended action for the vector pool size.
    pub vec_size_recommendation: SizeRecommendation,
}

/// Size recommendation enum
#[derive(Debug, Clone, Copy)]
pub enum SizeRecommendation {
    /// Current pool size is appropriate.
    Maintain,
    /// Pool size should be increased to the specified capacity.
    Increase(usize),
    /// Pool size should be decreased to the specified capacity.
    Decrease(usize),
}

impl From<MemoryPoolStats> for crate::telemetry::MemoryPoolTelemetry {
    fn from(stats: MemoryPoolStats) -> Self {
        Self {
            string_hit_rate: if stats.string_hits + stats.string_misses > 0 {
                stats.string_hits as f64 / (stats.string_hits + stats.string_misses) as f64
            } else {
                0.0
            },
            value_hit_rate: if stats.value_hits + stats.value_misses > 0 {
                stats.value_hits as f64 / (stats.value_hits + stats.value_misses) as f64
            } else {
                0.0
            },
            vec_hit_rate: if stats.vec_hits + stats.vec_misses > 0 {
                stats.vec_hits as f64 / (stats.vec_hits + stats.vec_misses) as f64
            } else {
                0.0
            },
            total_allocations_avoided: stats.allocations_avoided,
        }
    }
}

impl Default for MemoryPool {
    fn default() -> Self {
        Self::new()
    }
}

impl MemoryPool {
    /// Pre-warm the pool with initial allocations
    /// Call this during startup to avoid allocation latency during hot paths
    pub fn pre_warm(&self, string_count: usize, value_count: usize, vec_count: usize) {
        {
            let mut pool = self.string_pool.lock();
            let to_add = string_count.min(pool.capacity().saturating_sub(pool.len()));
            for _ in 0..to_add {
                pool.push_back(String::with_capacity(256));
            }
        }
        {
            let mut pool = self.value_pool.lock();
            let to_add = value_count.min(pool.capacity().saturating_sub(pool.len()));
            for _ in 0..to_add {
                pool.push_back(Value::Null);
            }
        }
        {
            let mut pool = self.vec_pool.lock();
            let to_add = vec_count.min(pool.capacity().saturating_sub(pool.len()));
            for _ in 0..to_add {
                pool.push_back(Vec::with_capacity(16));
            }
        }
    }

    /// Get a string with pre-allocated capacity for better performance
    pub fn get_string_with_capacity(&self, capacity: usize) -> String {
        let mut stats = self.stats.lock();
        let result = self.string_pool.lock().pop_front();
        if let Some(mut s) = result {
            stats.string_hits += 1;
            stats.allocations_avoided += 1;
            s.clear();
            // Reserve additional capacity if needed
            if s.capacity() < capacity {
                s.reserve(capacity - s.capacity());
            }
            s
        } else {
            stats.string_misses += 1;
            String::with_capacity(capacity)
        }
    }
}

/// Global memory pool instance
static MEMORY_POOL: once_cell::sync::Lazy<Arc<MemoryPool>> = once_cell::sync::Lazy::new(|| Arc::new(MemoryPool::new()));

/// Get the global memory pool
pub fn global_pool() -> Arc<MemoryPool> {
    Arc::clone(&MEMORY_POOL)
}