Skip to main content

lean_ctx/core/config/
memory.rs

1//! RAM cleanup profile and memory-footprint presets (`config.toml`).
2
3use serde::{Deserialize, Serialize};
4
5use super::Config;
6
7/// Controls how aggressively lean-ctx frees memory when idle.
8/// - `aggressive`: (Default) Cache cleared after short idle period (5 min). Best for single-IDE use.
9/// - `shared`: Cache retained longer (30 min). Best when multiple IDEs/models share lean-ctx context.
10#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
11#[serde(rename_all = "lowercase")]
12pub enum MemoryCleanup {
13    #[default]
14    Aggressive,
15    Shared,
16}
17
18impl MemoryCleanup {
19    pub fn from_env() -> Option<Self> {
20        std::env::var("LEAN_CTX_MEMORY_CLEANUP").ok().and_then(|v| {
21            match v.trim().to_lowercase().as_str() {
22                "aggressive" => Some(Self::Aggressive),
23                "shared" => Some(Self::Shared),
24                _ => None,
25            }
26        })
27    }
28
29    pub fn effective(config: &Config) -> Self {
30        if let Some(env_val) = Self::from_env() {
31            return env_val;
32        }
33        config.memory_cleanup.clone()
34    }
35
36    /// Idle TTL in seconds before cache is auto-cleared.
37    pub fn idle_ttl_secs(&self) -> u64 {
38        match self {
39            Self::Aggressive => 300,
40            Self::Shared => 1800,
41        }
42    }
43
44    /// BM25 index eviction age multiplier (shared mode retains longer).
45    pub fn index_retention_multiplier(&self) -> f64 {
46        match self {
47            Self::Aggressive => 1.0,
48            Self::Shared => 3.0,
49        }
50    }
51}
52
53/// Controls RAM usage vs. feature richness trade-off.
54/// - `low`: Minimal RAM footprint, disables optional caches and embedding features
55/// - `balanced`: Default — moderate caches, single embedding engine
56/// - `performance`: Maximum caches, all features enabled
57#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
58#[serde(rename_all = "lowercase")]
59pub enum MemoryProfile {
60    Low,
61    #[default]
62    Balanced,
63    Performance,
64}
65
66impl MemoryProfile {
67    pub fn from_env() -> Option<Self> {
68        std::env::var("LEAN_CTX_MEMORY_PROFILE").ok().and_then(|v| {
69            match v.trim().to_lowercase().as_str() {
70                "low" => Some(Self::Low),
71                "balanced" => Some(Self::Balanced),
72                "performance" => Some(Self::Performance),
73                _ => None,
74            }
75        })
76    }
77
78    pub fn effective(config: &Config) -> Self {
79        if let Some(env_val) = Self::from_env() {
80            return env_val;
81        }
82        config.memory_profile.clone()
83    }
84
85    pub fn bm25_max_cache_mb(&self) -> u64 {
86        match self {
87            Self::Low => 64,
88            Self::Balanced => 128,
89            Self::Performance => 512,
90        }
91    }
92
93    pub fn semantic_cache_enabled(&self) -> bool {
94        !matches!(self, Self::Low)
95    }
96
97    pub fn embeddings_enabled(&self) -> bool {
98        !matches!(self, Self::Low)
99    }
100}
101
102/// Controls visibility of token savings footers in tool output.
103///
104/// - `never` (default): suppressed everywhere
105/// - `always`: shown everywhere
106/// - `auto`: legacy compatibility mode; behavior is transport/context dependent
107#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
108#[serde(rename_all = "lowercase")]
109pub enum SavingsFooter {
110    Auto,
111    Always,
112    #[default]
113    Never,
114}
115
116impl SavingsFooter {
117    pub fn from_env() -> Option<Self> {
118        std::env::var("LEAN_CTX_SAVINGS_FOOTER").ok().and_then(|v| {
119            match v.trim().to_lowercase().as_str() {
120                "auto" => Some(Self::Auto),
121                "always" => Some(Self::Always),
122                "never" => Some(Self::Never),
123                _ => None,
124            }
125        })
126    }
127
128    pub fn effective() -> Self {
129        if let Some(env_val) = Self::from_env() {
130            return env_val;
131        }
132        let cfg = super::Config::load();
133        cfg.savings_footer.clone()
134    }
135}
136
137/// RSS-based memory guardian configuration.
138pub struct MemoryGuardConfig {
139    pub max_ram_percent: u8,
140}
141
142impl MemoryGuardConfig {
143    pub fn effective(config: &Config) -> Self {
144        let pct = std::env::var("LEAN_CTX_MAX_RAM_PERCENT")
145            .ok()
146            .and_then(|v| v.parse::<u8>().ok())
147            .unwrap_or(config.max_ram_percent)
148            .clamp(1, 50);
149        Self {
150            max_ram_percent: pct,
151        }
152    }
153}
154
155#[cfg(test)]
156mod tests {
157    use super::*;
158
159    #[test]
160    fn savings_footer_defaults_to_never() {
161        assert_eq!(SavingsFooter::default(), SavingsFooter::Never);
162    }
163
164    #[test]
165    fn savings_footer_from_env_accepts_auto() {
166        let _guard = crate::core::data_dir::test_env_lock();
167        std::env::set_var("LEAN_CTX_SAVINGS_FOOTER", "auto");
168        assert_eq!(SavingsFooter::from_env(), Some(SavingsFooter::Auto));
169        std::env::remove_var("LEAN_CTX_SAVINGS_FOOTER");
170    }
171}