1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
//! `VelesConfig` validation logic.
//!
//! Extracted from `config.rs` to reduce NLOC below the 500 threshold.
use crate::config::{ConfigError, VelesConfig};
// ---------------------------------------------------------------------------
// Upper-bound caps for capacity/size limits.
//
// These caps reject absurd values that would silently invite resource
// exhaustion or integer-overflow surprises downstream, while staying well
// above every realistic deployment (and above the crate defaults so the
// default config validates through the loaders). `0` is rejected for
// capacities/sizes because a zero capacity is never a meaningful config.
// ---------------------------------------------------------------------------
/// Hard ceiling for `limits.max_vectors_per_collection`.
///
/// On 64-bit targets this is 10 billion. On 32-bit / WASM targets `usize`
/// is only 32 bits (max ≈ 4.29 billion), so the literal is capped at
/// 4 billion to prevent a compile-time integer-overflow error.
#[cfg(target_pointer_width = "64")]
const MAX_VECTORS_PER_COLLECTION_CAP: usize = 10_000_000_000;
#[cfg(not(target_pointer_width = "64"))]
const MAX_VECTORS_PER_COLLECTION_CAP: usize = 4_000_000_000;
/// Hard ceiling for `limits.max_collections` (1 million).
const MAX_COLLECTIONS_CAP: usize = 1_000_000;
/// Hard ceiling for `limits.max_payload_size` (1 GiB).
const MAX_PAYLOAD_SIZE_CAP: usize = 1_073_741_824;
/// Hard ceiling for `limits.max_perfect_mode_vectors` (100 million).
const MAX_PERFECT_MODE_VECTORS_CAP: usize = 100_000_000;
/// Hard ceiling for `search.query_timeout_ms` (24 hours). `0` means
/// "disabled". The previous 1-hour cap rejected legitimate long batch
/// timeouts; 24h is generous enough for any real query while still rejecting
/// effectively-unbounded values.
const QUERY_TIMEOUT_MS_CAP: u64 = 86_400_000;
/// Hard ceiling for `hnsw.max_layers`. `0` means "auto".
const MAX_LAYERS_CAP: usize = 64;
/// Hard ceiling for `storage.mmap_cache_mb` (1 TiB). `0` is rejected: a
/// zero-byte mmap cache is never a meaningful configuration.
const MMAP_CACHE_MB_CAP: usize = 1_048_576;
/// Hard ceiling for `server.workers`. `0` means "auto" (derive from CPU
/// count), so it is allowed; any positive value is capped to a sane ceiling.
const WORKERS_CAP: usize = 4_096;
/// Rejects `0` and any value above `cap` for a capacity/size field.
fn range_check_capacity(key: &str, value: usize, cap: usize) -> Result<(), ConfigError> {
if value == 0 || value > cap {
return Err(ConfigError::InvalidValue {
key: key.to_string(),
message: format!("value {value} is out of range [1, {cap}]"),
});
}
Ok(())
}
/// Range-checks a field where `0` is a valid sentinel (disabled / auto) but any
/// positive value must not exceed `cap`. Unlike [`range_check_capacity`], `0`
/// is accepted.
fn range_check_upper<T: PartialOrd + Copy + std::fmt::Display>(
key: &str,
value: T,
cap: T,
) -> Result<(), ConfigError> {
if value > cap {
return Err(ConfigError::InvalidValue {
key: key.to_string(),
message: format!("value {value} is out of range [0, {cap}]"),
});
}
Ok(())
}
impl VelesConfig {
/// Validates the configuration.
///
/// # Errors
///
/// Returns an error if any configuration value is invalid.
pub fn validate(&self) -> Result<(), ConfigError> {
self.validate_search()?;
self.validate_hnsw()?;
self.validate_limits()?;
self.validate_server()?;
self.validate_storage()?;
self.validate_logging()?;
self.warn_inert_wal_batch();
self.warn_inert_engine_sections();
Ok(())
}
/// The `[search]`, `[hnsw]`, `[storage]` and `[quantization]` sections
/// are parsed and validated but not yet applied — only `[limits]`
/// reaches the engine (issue #2087). Warn — rather than reject — when a
/// config sets any of them away from its defaults, so existing files
/// keep loading while no deployment silently believes those knobs work.
///
/// Serde-value comparison instead of `PartialEq` derives: the sections
/// carry enums and nested types, and this runs once per config load.
fn warn_inert_engine_sections(&self) {
fn deviates<T: serde::Serialize>(actual: &T, default: &T) -> bool {
match (serde_json::to_value(actual), serde_json::to_value(default)) {
(Ok(a), Ok(d)) => a != d,
_ => false,
}
}
let mut inert: Vec<&str> = Vec::new();
if deviates(&self.search, &crate::config::SearchConfig::default()) {
inert.push("[search]");
}
if deviates(&self.hnsw, &crate::config::HnswConfig::default()) {
inert.push("[hnsw]");
}
if deviates(
&self.storage,
&crate::config::server::StorageConfig::default(),
) {
inert.push("[storage]");
}
if deviates(
&self.quantization,
&crate::config_quantization::QuantizationConfig::default(),
) {
inert.push("[quantization]");
}
if !inert.is_empty() {
tracing::warn!(
sections = inert.join(", "),
"these config sections are parsed and validated but not yet \
applied by the engine — only [limits] is; see issue #2087. \
Query-time WITH (...) overrides are unaffected."
);
}
}
/// `[wal_batch]` is parsed but not wired (issue #2078): warn — rather
/// than reject — when a config enables it, so existing files keep
/// loading while no deployment silently believes it has group commit.
fn warn_inert_wal_batch(&self) {
if self.wal_batch.enabled {
tracing::warn!(
"[wal_batch] enabled = true is parsed but not yet wired: no group \
commit occurs and every write keeps its own durability barrier \
(see issue #2078)"
);
}
}
fn validate_search(&self) -> Result<(), ConfigError> {
if let Some(ef) = self.search.ef_search {
if !(16..=4096).contains(&ef) {
return Err(ConfigError::InvalidValue {
key: "search.ef_search".to_string(),
message: format!("value {ef} is out of range [16, 4096]"),
});
}
}
if self.search.max_results == 0 || self.search.max_results > 10000 {
return Err(ConfigError::InvalidValue {
key: "search.max_results".to_string(),
message: format!(
"value {} is out of range [1, 10000]",
self.search.max_results
),
});
}
// `query_timeout_ms == 0` disables the timeout (see `QueryContext`);
// any positive value is capped to avoid effectively-unbounded queries.
range_check_upper(
"search.query_timeout_ms",
self.search.query_timeout_ms,
QUERY_TIMEOUT_MS_CAP,
)
}
fn validate_hnsw(&self) -> Result<(), ConfigError> {
if let Some(m) = self.hnsw.m {
if !(4..=128).contains(&m) {
return Err(ConfigError::InvalidValue {
key: "hnsw.m".to_string(),
message: format!("value {m} is out of range [4, 128]"),
});
}
}
if let Some(ef) = self.hnsw.ef_construction {
if !(100..=2000).contains(&ef) {
return Err(ConfigError::InvalidValue {
key: "hnsw.ef_construction".to_string(),
message: format!("value {ef} is out of range [100, 2000]"),
});
}
}
// `max_layers == 0` means "auto" (see `HnswConfig`); a positive value
// is capped to a sane ceiling.
range_check_upper("hnsw.max_layers", self.hnsw.max_layers, MAX_LAYERS_CAP)
}
fn validate_limits(&self) -> Result<(), ConfigError> {
let limits = &self.limits;
range_check_capacity("limits.max_dimensions", limits.max_dimensions, 65536)?;
range_check_capacity(
"limits.max_vectors_per_collection",
limits.max_vectors_per_collection,
MAX_VECTORS_PER_COLLECTION_CAP,
)?;
range_check_capacity(
"limits.max_collections",
limits.max_collections,
MAX_COLLECTIONS_CAP,
)?;
range_check_capacity(
"limits.max_payload_size",
limits.max_payload_size,
MAX_PAYLOAD_SIZE_CAP,
)?;
range_check_capacity(
"limits.max_perfect_mode_vectors",
limits.max_perfect_mode_vectors,
MAX_PERFECT_MODE_VECTORS_CAP,
)
}
fn validate_server(&self) -> Result<(), ConfigError> {
if self.server.port < 1024 {
return Err(ConfigError::InvalidValue {
key: "server.port".to_string(),
message: format!("value {} must be >= 1024", self.server.port),
});
}
// `workers == 0` means "auto" (derive from CPU count); a positive
// value is capped so a typo cannot spawn an absurd thread count.
range_check_upper("server.workers", self.server.workers, WORKERS_CAP)
}
fn validate_storage(&self) -> Result<(), ConfigError> {
let valid_modes = ["mmap", "memory"];
if !valid_modes.contains(&self.storage.storage_mode.as_str()) {
return Err(ConfigError::InvalidValue {
key: "storage.storage_mode".to_string(),
message: format!(
"value '{}' is invalid, expected one of: {:?}",
self.storage.storage_mode, valid_modes
),
});
}
// A zero-byte mmap cache is meaningless; cap the upper bound so an
// out-of-range value cannot drive an absurd reservation.
range_check_capacity(
"storage.mmap_cache_mb",
self.storage.mmap_cache_mb,
MMAP_CACHE_MB_CAP,
)?;
Ok(())
}
fn validate_logging(&self) -> Result<(), ConfigError> {
let valid_levels = ["error", "warn", "info", "debug", "trace"];
if !valid_levels.contains(&self.logging.level.as_str()) {
return Err(ConfigError::InvalidValue {
key: "logging.level".to_string(),
message: format!(
"value '{}' is invalid, expected one of: {:?}",
self.logging.level, valid_levels
),
});
}
Ok(())
}
}