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
//! Tests for `alloc_guard` module
use super::alloc_guard::*;
use serial_test::serial;
use std::alloc::{dealloc, Layout};
#[test]
fn test_alloc_guard_basic() {
let layout = Layout::from_size_align(1024, 8).unwrap();
let guard = AllocGuard::new(layout).expect("allocation failed");
assert!(!guard.as_ptr().is_null());
assert_eq!(guard.layout().size(), 1024);
assert_eq!(guard.layout().align(), 8);
}
#[test]
fn test_alloc_guard_into_raw() {
let layout = Layout::from_size_align(64, 8).unwrap();
let guard = AllocGuard::new(layout).expect("allocation failed");
let ptr = guard.into_raw();
// Must manually deallocate
assert!(!ptr.is_null());
// SAFETY: `dealloc` requires a pointer from `alloc` with the same layout.
// - Condition 1: `ptr` was obtained from `into_raw()`, which transfers ownership
// of a valid allocation created by `AllocGuard::new(layout)`.
// - Condition 2: `layout` is the same layout used for the original allocation.
// Reason: `into_raw()` disables the RAII guard; caller must deallocate manually.
unsafe {
dealloc(ptr, layout);
}
}
#[test]
fn test_alloc_guard_zero_size() {
let layout = Layout::from_size_align(0, 1).unwrap();
assert!(AllocGuard::new(layout).is_none());
}
#[test]
fn test_alloc_guard_aligned() {
// Cache-line aligned (64 bytes)
let layout = Layout::from_size_align(256, 64).unwrap();
let guard = AllocGuard::new(layout).expect("allocation failed");
let addr = guard.as_ptr() as usize;
assert_eq!(addr % 64, 0, "Not cache-line aligned");
}
#[test]
fn test_alloc_guard_cast() {
let layout =
Layout::from_size_align(std::mem::size_of::<f32>() * 10, std::mem::align_of::<f32>())
.unwrap();
let guard = AllocGuard::new(layout).expect("allocation failed");
let float_ptr: *mut f32 = guard.cast();
// Write some data
// SAFETY: `float_ptr.add(i)` requires a valid, aligned pointer within the allocation.
// - Condition 1: `guard` allocated `size_of::<f32>() * 10` bytes with `align_of::<f32>()`.
// - Condition 2: `i` ranges 0..10, so `add(i)` stays within the allocation bounds.
// Reason: Verifying that `AllocGuard::cast` produces a usable typed pointer.
#[allow(clippy::cast_precision_loss)]
unsafe {
for i in 0..10 {
*float_ptr.add(i) = i as f32;
}
}
// Read back
// SAFETY: Same invariants as the write block above.
// - Condition 1: Data was written in the preceding block; no reallocation occurred.
// - Condition 2: `guard` is still alive, so the allocation is valid.
// Reason: Round-trip verification of typed pointer read/write.
#[allow(clippy::cast_precision_loss, clippy::float_cmp)]
unsafe {
for i in 0..10 {
assert_eq!(*float_ptr.add(i), i as f32);
}
}
}
#[test]
fn test_alloc_guard_drop_frees_memory() {
// This test verifies the guard deallocates on drop
// We can't directly verify deallocation, but we can ensure no panic
for _ in 0..1000 {
let layout = Layout::from_size_align(1024, 8).unwrap();
let _guard = AllocGuard::new(layout);
// guard dropped here, memory freed
}
}
#[test]
fn test_alloc_guard_panic_safety() {
use std::panic;
let layout = Layout::from_size_align(1024, 8).unwrap();
// Simulate panic during operation
let result = panic::catch_unwind(|| {
let _guard = AllocGuard::new(layout).expect("allocation failed");
panic!("simulated panic");
});
assert!(result.is_err());
// Memory should have been freed by drop during unwind
}
// =========================================================================
// #899 — Allocation-bound regression tests
//
// Tests that read or mutate the process-global `ALLOC_BYTE_LIMIT` are marked
// `#[serial]` so they cannot observe or corrupt each other's view of the
// global; each one also saves and restores the limit it changes.
// =========================================================================
/// The default ceiling is the high 1 TiB backstop — not a 16 GiB workload cap.
#[test]
#[serial]
fn test_default_ceiling_is_high_backstop() {
let saved = alloc_byte_limit();
set_alloc_byte_limit(0); // normalize to the default
assert_eq!(alloc_byte_limit(), DEFAULT_ALLOC_BYTE_LIMIT);
assert_eq!(DEFAULT_ALLOC_BYTE_LIMIT, 1024 * 1024 * 1024 * 1024);
set_alloc_byte_limit(saved);
}
/// A request above the configured byte ceiling returns `None` (no allocation),
/// while a normal-sized request still succeeds.
#[test]
#[serial]
fn test_alloc_guard_rejects_above_ceiling() {
let saved = alloc_byte_limit();
set_alloc_byte_limit(0);
let limit = alloc_byte_limit();
assert_eq!(limit, DEFAULT_ALLOC_BYTE_LIMIT);
// Just above the ceiling: rejected without touching the allocator
// (constructing the Layout never allocates).
let oversized = Layout::from_size_align(limit + 1, 8).unwrap();
assert!(AllocGuard::new(oversized).is_none());
assert!(AllocGuard::new_zeroed(oversized).is_none());
// A normal, sane allocation still succeeds.
let ok = Layout::from_size_align(4096, 64).unwrap();
assert!(AllocGuard::new(ok).is_some());
assert!(AllocGuard::new_zeroed(ok).is_some());
set_alloc_byte_limit(saved);
}
/// `check_alloc_bound` errors above the limit and is OK at/below it.
#[test]
#[serial]
fn test_check_alloc_bound() {
let saved = alloc_byte_limit();
set_alloc_byte_limit(0);
let limit = alloc_byte_limit();
assert!(check_alloc_bound(limit).is_ok());
assert!(check_alloc_bound(0).is_ok());
assert!(check_alloc_bound(limit + 1).is_err());
set_alloc_byte_limit(saved);
}
/// The ceiling is configurable; `0` restores the default.
#[test]
#[serial]
fn test_set_alloc_byte_limit_roundtrip() {
let original = alloc_byte_limit();
set_alloc_byte_limit(8192);
assert_eq!(alloc_byte_limit(), 8192);
assert!(AllocGuard::new(Layout::from_size_align(16384, 8).unwrap()).is_none());
assert!(AllocGuard::new(Layout::from_size_align(4096, 8).unwrap()).is_some());
// `0` means "no override" → back to default.
set_alloc_byte_limit(0);
assert_eq!(alloc_byte_limit(), DEFAULT_ALLOC_BYTE_LIMIT);
// Restore whatever the harness started with.
set_alloc_byte_limit(original);
}
/// REGRESSION (#899 follow-up): a large-but-legitimate single-buffer size that
/// the old 16 GiB cap would have falsely rejected is now accepted by the
/// bound-decision function. We test the *decision*, never a real 20 GiB alloc.
#[test]
#[serial]
fn test_large_legit_buffer_not_falsely_rejected() {
const GIB: usize = 1024 * 1024 * 1024;
let saved = alloc_byte_limit();
set_alloc_byte_limit(0); // default 1 TiB backstop
// ~2.8M vectors @768D ≈ 8.2 GiB; ~5.6M @768D ≈ 16.5 GiB — both tripped the
// old 16 GiB cap. Probe sizes well above 16 GiB but below 1 TiB: all OK now.
for gib in [20usize, 64, 128, 512] {
let bytes = gib * GIB;
assert!(
check_alloc_bound(bytes).is_ok(),
"{gib} GiB single buffer must not be falsely rejected"
);
}
set_alloc_byte_limit(saved);
}
/// REGRESSION (#899 follow-up): the persisted-index LOAD bound is derived from
/// the file-backed payload, so a realistic large `count` (above the old cap)
/// reloads. `with_min_alloc_byte_limit` raises the ceiling to the file-backed
/// size for the load scope, then restores it.
#[test]
#[serial]
fn test_load_path_bound_allows_realistic_large_count() {
let saved = alloc_byte_limit();
// Pin a deliberately low limit to prove the load path raises past it.
set_alloc_byte_limit(4096);
// ~30 GiB file-backed payload (8M vectors @768D *4 ≈ 24 GiB) — a legit
// persisted index. The load path must accept its own file-backed size.
let file_backed_bytes = 30usize * 1024 * 1024 * 1024;
let inner = with_min_alloc_byte_limit(file_backed_bytes, || {
// Inside the scope the ceiling covers the file-backed size.
assert!(check_alloc_bound(file_backed_bytes).is_ok());
alloc_byte_limit()
});
assert_eq!(inner, file_backed_bytes, "ceiling raised within load scope");
// Restored after the scope (no leak of the raised limit).
assert_eq!(alloc_byte_limit(), 4096);
set_alloc_byte_limit(saved);
}
/// `with_min_alloc_byte_limit` is a transparent pass-through when the current
/// ceiling already covers the requested minimum (no mutation).
#[test]
#[serial]
fn test_with_min_alloc_byte_limit_passthrough() {
let saved = alloc_byte_limit();
set_alloc_byte_limit(0); // 1 TiB default
let before = alloc_byte_limit();
let observed = with_min_alloc_byte_limit(1024, alloc_byte_limit);
assert_eq!(
observed, before,
"no raise needed; ceiling unchanged in scope"
);
assert_eq!(alloc_byte_limit(), before);
set_alloc_byte_limit(saved);
}
/// `with_min_alloc_byte_limit` restores the previous ceiling even if the closure
/// panics (RAII restore), so a panicking load cannot leak a raised limit.
#[test]
#[serial]
fn test_with_min_alloc_byte_limit_restores_on_panic() {
use std::panic;
let saved = alloc_byte_limit();
set_alloc_byte_limit(4096);
let huge = 30usize * 1024 * 1024 * 1024;
let result = panic::catch_unwind(|| {
with_min_alloc_byte_limit(huge, || {
panic!("simulated load failure");
});
});
assert!(result.is_err());
assert_eq!(alloc_byte_limit(), 4096, "ceiling restored after panic");
set_alloc_byte_limit(saved);
}