1use hawdb_core::{
18 HawDBError, ResourceBudgetError, ResourceBudgetKind, ResourceBudgetScope, Result,
19};
20use std::collections::BTreeMap;
21use std::num::NonZeroUsize;
22use std::sync::{Arc, Mutex, MutexGuard};
23
24#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
25pub enum QueryMemoryClass {
26 PipelineBatch,
27 BlockingState,
28 ExternalRead,
29 SpillStaging,
30 MorselOutput,
31 ResultMaterialization,
32}
33
34impl QueryMemoryClass {
35 pub const fn as_str(self) -> &'static str {
36 match self {
37 Self::PipelineBatch => "pipeline_batch",
38 Self::BlockingState => "blocking_state",
39 Self::ExternalRead => "external_read",
40 Self::SpillStaging => "spill_staging",
41 Self::MorselOutput => "morsel_output",
42 Self::ResultMaterialization => "result_materialization",
43 }
44 }
45}
46
47#[derive(Debug, Clone, PartialEq, Eq)]
48pub struct QueryMemoryClassSnapshot {
49 pub class: QueryMemoryClass,
50 pub used_bytes: usize,
51 pub peak_bytes: usize,
52}
53
54#[derive(Debug, Clone, PartialEq, Eq)]
55pub struct QueryMemoryLedgerSnapshot {
56 pub budget_bytes: usize,
57 pub used_bytes: usize,
58 pub peak_bytes: usize,
59 pub account_count: usize,
60 pub classes: Vec<QueryMemoryClassSnapshot>,
61}
62
63#[derive(Debug, Clone)]
64pub struct QueryMemoryLedger {
65 inner: Arc<QueryMemoryLedgerInner>,
66 file_descriptors: Option<hawdb_storage::file_descriptors::FileOpenContext>,
67}
68
69#[derive(Debug)]
70struct QueryMemoryLedgerInner {
71 budget_bytes: usize,
72 budget_option: &'static str,
73 state: Mutex<QueryMemoryLedgerState>,
74}
75
76#[derive(Debug, Default)]
77struct QueryMemoryLedgerState {
78 used_bytes: usize,
79 peak_bytes: usize,
80 next_account_id: u64,
81 accounts: BTreeMap<u64, QueryMemoryAccountState>,
82 classes: BTreeMap<QueryMemoryClass, QueryMemoryClassState>,
83}
84
85#[derive(Debug)]
86struct QueryMemoryAccountState {
87 class: QueryMemoryClass,
88 owner: Arc<str>,
89 budget_bytes: usize,
90 budget_option: &'static str,
91 used_bytes: usize,
92 peak_bytes: usize,
93}
94
95#[derive(Debug, Default)]
96struct QueryMemoryClassState {
97 used_bytes: usize,
98 peak_bytes: usize,
99}
100
101impl QueryMemoryAccountState {
102 fn budget_error(
103 &self,
104 scope: ResourceBudgetScope,
105 requested: usize,
106 used: usize,
107 budget: usize,
108 budget_option: &'static str,
109 message: String,
110 ) -> HawDBError {
111 HawDBError::from(ResourceBudgetError {
112 resource: ResourceBudgetKind::MemoryBytes,
113 scope,
114 owner: self.owner.to_string(),
115 memory_class: Some(self.class.as_str()),
116 requested: requested as u64,
117 used: used as u64,
118 budget: budget as u64,
119 budget_option,
120 message,
121 })
122 }
123
124 fn account_budget_error(&self, requested: usize, message: String) -> HawDBError {
125 self.budget_error(
126 ResourceBudgetScope::Account,
127 requested,
128 self.used_bytes,
129 self.budget_bytes,
130 self.budget_option,
131 message,
132 )
133 }
134}
135
136impl QueryMemoryLedger {
137 #[doc(hidden)]
139 pub fn for_query(
140 memory: &crate::ExecutionMemoryConfig,
141 task_context: Option<&hawdb_core::RuntimeTaskContext>,
142 ) -> Result<Self> {
143 Ok(Self::new_with_budget_option(
144 crate::memory::enforced_query_memory_budget(memory, task_context)?,
145 if task_context
146 .and_then(hawdb_core::RuntimeTaskContext::memory_reservation)
147 .is_some()
148 {
149 "RuntimeTaskContext.memory_reservation.memory_bytes"
150 } else {
151 "ExecutionMemoryConfig.query_memory_bytes"
152 },
153 ))
154 }
155
156 pub(crate) fn budget_bytes(&self) -> NonZeroUsize {
157 NonZeroUsize::new(self.inner.budget_bytes).unwrap()
158 }
159
160 pub(crate) fn source_account(
161 &self,
162 owner: &'static str,
163 source_budget: NonZeroUsize,
164 retained_budget: NonZeroUsize,
165 ) -> QueryMemoryAccount {
166 self.source_account_retaining(
167 owner,
168 source_budget,
169 self.account(QueryMemoryClass::BlockingState, owner, retained_budget),
170 )
171 }
172
173 pub(crate) fn source_account_retaining(
174 &self,
175 owner: &'static str,
176 source_budget: NonZeroUsize,
177 retained: QueryMemoryAccount,
178 ) -> QueryMemoryAccount {
179 self.account(QueryMemoryClass::ExternalRead, owner, source_budget)
180 .with_retained_state(retained)
181 }
182
183 pub fn new(budget_bytes: NonZeroUsize) -> Self {
184 Self::new_with_budget_option(budget_bytes, "QueryMemoryLedger::new(budget_bytes)")
185 }
186
187 pub fn new_with_budget_option(budget_bytes: NonZeroUsize, budget_option: &'static str) -> Self {
189 Self {
190 inner: Arc::new(QueryMemoryLedgerInner {
191 budget_bytes: budget_bytes.get(),
192 budget_option,
193 state: Mutex::new(QueryMemoryLedgerState::default()),
194 }),
195 file_descriptors: None,
196 }
197 }
198
199 #[doc(hidden)]
201 pub fn with_file_descriptors(
202 mut self,
203 context: Option<hawdb_storage::file_descriptors::FileOpenContext>,
204 ) -> Self {
205 self.file_descriptors = context.or(self.file_descriptors);
206 self
207 }
208
209 pub(crate) fn file_descriptor_context(
210 &self,
211 ) -> Option<&hawdb_storage::file_descriptors::FileOpenContext> {
212 self.file_descriptors.as_ref()
213 }
214
215 pub fn account(
216 &self,
217 class: QueryMemoryClass,
218 owner: impl Into<Arc<str>>,
219 budget_bytes: NonZeroUsize,
220 ) -> QueryMemoryAccount {
221 self.account_with_budget_option(
222 class,
223 owner,
224 budget_bytes,
225 "QueryMemoryLedger::account(budget_bytes)",
226 )
227 }
228
229 pub fn account_with_budget_option(
231 &self,
232 class: QueryMemoryClass,
233 owner: impl Into<Arc<str>>,
234 budget_bytes: NonZeroUsize,
235 budget_option: &'static str,
236 ) -> QueryMemoryAccount {
237 let owner = owner.into();
239 let mut state = lock_recover(&self.inner.state);
240 let account_id = state.next_account_id;
241 state.next_account_id = state.next_account_id.saturating_add(1);
242 state.accounts.insert(
243 account_id,
244 QueryMemoryAccountState {
245 class,
246 owner,
247 budget_bytes: budget_bytes.get(),
248 budget_option,
249 used_bytes: 0,
250 peak_bytes: 0,
251 },
252 );
253 QueryMemoryAccount {
254 ledger: self.clone(),
255 account_id,
256 backing: None,
257 retained_state: None,
258 }
259 }
260
261 pub fn snapshot(&self) -> QueryMemoryLedgerSnapshot {
262 let state = lock_recover(&self.inner.state);
263 QueryMemoryLedgerSnapshot {
264 budget_bytes: self.inner.budget_bytes,
265 used_bytes: state.used_bytes,
266 peak_bytes: state.peak_bytes,
267 account_count: state.accounts.len(),
268 classes: state
269 .classes
270 .iter()
271 .map(|(class, state)| QueryMemoryClassSnapshot {
272 class: *class,
273 used_bytes: state.used_bytes,
274 peak_bytes: state.peak_bytes,
275 })
276 .collect(),
277 }
278 }
279
280 #[cfg(test)]
282 pub(crate) fn test_owner_used_bytes(&self, class: QueryMemoryClass, owner: &str) -> usize {
283 lock_recover(&self.inner.state)
284 .accounts
285 .values()
286 .filter(|account| account.class == class && account.owner.as_ref() == owner)
287 .map(|account| account.used_bytes)
288 .sum()
289 }
290
291 fn reserve(&self, account_id: u64, bytes: usize) -> Result<()> {
292 if bytes == 0 {
293 return Ok(());
294 }
295 let mut state = lock_recover(&self.inner.state);
296 let account = state.accounts.get(&account_id).ok_or_else(|| {
297 HawDBError::Execution("query memory account is no longer registered".to_string())
298 })?;
299 let class = account.class;
300 let owner = &account.owner;
301 let account_budget = account.budget_bytes;
302 let account_next = account.used_bytes.checked_add(bytes).ok_or_else(|| {
303 account.account_budget_error(
304 bytes,
305 format!(
306 "query memory account {owner} ({}) byte accounting overflow",
307 class.as_str()
308 ),
309 )
310 })?;
311 if account_next > account_budget {
312 return Err(account.account_budget_error(bytes, format!(
313 "query memory account {owner} ({}) would use {account_next} bytes, exceeding its {account_budget}-byte budget",
314 class.as_str()
315 )));
316 }
317 let query_error = |message| {
318 account.budget_error(
319 ResourceBudgetScope::Query,
320 bytes,
321 state.used_bytes,
322 self.inner.budget_bytes,
323 self.inner.budget_option,
324 message,
325 )
326 };
327 let root_next = state.used_bytes.checked_add(bytes).ok_or_else(|| {
328 query_error(format!(
329 "query memory ledger byte accounting overflow while charging {owner} ({})",
330 class.as_str()
331 ))
332 })?;
333 if root_next > self.inner.budget_bytes {
334 return Err(query_error(format!(
335 "query memory ledger would use {root_next} bytes while charging {owner} ({}), exceeding query_memory_bytes {}",
336 class.as_str(),
337 self.inner.budget_bytes
338 )));
339 }
340
341 state.classes.entry(class).or_default();
343 let account = state
344 .accounts
345 .get_mut(&account_id)
346 .expect("validated query memory account remains registered");
347 account.used_bytes = account_next;
348 account.peak_bytes = account.peak_bytes.max(account_next);
349 state.used_bytes = root_next;
350 state.peak_bytes = state.peak_bytes.max(root_next);
351 let class_state = state
352 .classes
353 .get_mut(&class)
354 .expect("prepared query memory class remains registered");
355 class_state.used_bytes = class_state.used_bytes.saturating_add(bytes);
356 class_state.peak_bytes = class_state.peak_bytes.max(class_state.used_bytes);
357 Ok(())
358 }
359
360 fn can_reserve(&self, account_id: u64, bytes: usize) -> bool {
361 let state = lock_recover(&self.inner.state);
362 let Some(account) = state.accounts.get(&account_id) else {
363 return false;
364 };
365 let Some(account_next) = account.used_bytes.checked_add(bytes) else {
366 return false;
367 };
368 let Some(root_next) = state.used_bytes.checked_add(bytes) else {
369 return false;
370 };
371 account_next <= account.budget_bytes && root_next <= self.inner.budget_bytes
372 }
373
374 fn release(&self, account_id: u64, bytes: usize) {
375 if bytes == 0 {
376 return;
377 }
378 let mut state = lock_recover(&self.inner.state);
379 let Some(account) = state.accounts.get_mut(&account_id) else {
380 return;
381 };
382 let released = bytes.min(account.used_bytes);
383 let class = account.class;
384 account.used_bytes -= released;
385 state.used_bytes = state.used_bytes.saturating_sub(released);
386 if let Some(class_state) = state.classes.get_mut(&class) {
387 class_state.used_bytes = class_state.used_bytes.saturating_sub(released);
388 }
389 }
390
391 fn transfer(
392 &self,
393 source_account_id: u64,
394 source_bytes: usize,
395 target_account_id: u64,
396 target_bytes: usize,
397 ) -> Result<()> {
398 if source_account_id == target_account_id {
399 return Err(HawDBError::Execution(
400 "query memory transfer requires distinct accounts".to_string(),
401 ));
402 }
403 let mut state = lock_recover(&self.inner.state);
404 let (source_class, source_used) = state
405 .accounts
406 .get(&source_account_id)
407 .map(|account| (account.class, account.used_bytes))
408 .ok_or_else(|| {
409 HawDBError::Execution(
410 "source query memory account is no longer registered".to_string(),
411 )
412 })?;
413 if source_bytes > source_used {
414 return Err(HawDBError::Execution(format!(
415 "query memory transfer tried to release {source_bytes} bytes from a source account using {source_used} bytes"
416 )));
417 }
418 let target_account = state.accounts.get(&target_account_id).ok_or_else(|| {
419 HawDBError::Execution("target query memory account is no longer registered".to_string())
420 })?;
421 let target_class = target_account.class;
422 let target_owner = &target_account.owner;
423 let target_budget = target_account.budget_bytes;
424 let target_used = target_account.used_bytes;
425 let target_next = target_used.checked_add(target_bytes).ok_or_else(|| {
426 target_account.account_budget_error(
427 target_bytes,
428 format!(
429 "query memory account {target_owner} ({}) byte accounting overflow",
430 target_class.as_str()
431 ),
432 )
433 })?;
434 if target_next > target_budget {
435 return Err(target_account.account_budget_error(target_bytes, format!(
436 "query memory account {target_owner} ({}) would use {target_next} bytes, exceeding its {target_budget}-byte budget",
437 target_class.as_str()
438 )));
439 }
440 let root_after_release = state.used_bytes.checked_sub(source_bytes).ok_or_else(|| {
441 HawDBError::Execution(
442 "query memory ledger underflow during ownership transfer".to_string(),
443 )
444 })?;
445 let query_error = |message| {
446 target_account.budget_error(
447 ResourceBudgetScope::Query,
448 target_bytes.saturating_sub(source_bytes),
449 state.used_bytes,
450 self.inner.budget_bytes,
451 self.inner.budget_option,
452 message,
453 )
454 };
455 let root_next = root_after_release.checked_add(target_bytes).ok_or_else(|| {
456 query_error(format!(
457 "query memory ledger byte accounting overflow while transferring ownership to {target_owner} ({})",
458 target_class.as_str()
459 ))
460 })?;
461 if root_next > self.inner.budget_bytes {
462 return Err(query_error(format!(
463 "query memory ledger would use {root_next} bytes while transferring ownership to {target_owner} ({}), exceeding query_memory_bytes {}",
464 target_class.as_str(),
465 self.inner.budget_bytes
466 )));
467 }
468
469 state.classes.entry(target_class).or_default();
470 let source = state
471 .accounts
472 .get_mut(&source_account_id)
473 .expect("validated source query memory account remains registered");
474 source.used_bytes -= source_bytes;
475 let target = state
476 .accounts
477 .get_mut(&target_account_id)
478 .expect("validated target query memory account remains registered");
479 target.used_bytes = target_next;
480 target.peak_bytes = target.peak_bytes.max(target_next);
481 state.used_bytes = root_next;
482 state.peak_bytes = state.peak_bytes.max(root_next);
483 if let Some(class_state) = state.classes.get_mut(&source_class) {
484 class_state.used_bytes = class_state.used_bytes.saturating_sub(source_bytes);
485 }
486 let class_state = state
487 .classes
488 .get_mut(&target_class)
489 .expect("prepared target query memory class remains registered");
490 class_state.used_bytes = class_state.used_bytes.saturating_add(target_bytes);
491 class_state.peak_bytes = class_state.peak_bytes.max(class_state.used_bytes);
492 Ok(())
493 }
494}
495
496#[derive(Debug, Clone)]
497pub struct QueryMemoryAccount {
498 ledger: QueryMemoryLedger,
499 account_id: u64,
500 backing: Option<Arc<QueryMemoryLease>>,
503 retained_state: Option<Arc<QueryMemoryAccount>>,
504}
505
506impl QueryMemoryAccount {
507 pub(crate) fn query_budget_bytes(&self) -> NonZeroUsize {
508 self.ledger.budget_bytes()
509 }
510
511 pub(crate) fn with_retained_state(mut self, account: Self) -> Self {
512 self.retained_state = Some(Arc::new(account));
513 self
514 }
515
516 pub(crate) fn retained_state(&self) -> Option<&Self> {
517 self.retained_state.as_deref()
518 }
519
520 pub(crate) fn sub_account(&self, budget: NonZeroUsize) -> Result<Self> {
523 let backing = Arc::new(self.reserve(budget.get())?);
524 let (class, owner) = {
525 let state = lock_recover(&self.ledger.inner.state);
526 let account = &state.accounts[&self.account_id];
527 (account.class, Arc::clone(&account.owner))
528 };
529 let origin = "QueryMemoryAccount::sub_account(budget)";
530 let mut child = QueryMemoryLedger::new_with_budget_option(budget, origin)
531 .account_with_budget_option(class, owner, budget, origin);
532 child.backing = Some(backing);
533 Ok(child)
534 }
535
536 pub(crate) fn budget_bytes(&self) -> NonZeroUsize {
537 NonZeroUsize::new(
538 lock_recover(&self.ledger.inner.state).accounts[&self.account_id].budget_bytes,
539 )
540 .unwrap()
541 }
542
543 #[doc(hidden)]
547 pub fn available_bytes(&self) -> usize {
548 let state = lock_recover(&self.ledger.inner.state);
549 let account = &state.accounts[&self.account_id];
550 account.budget_bytes.saturating_sub(account.used_bytes).min(
551 self.ledger
552 .inner
553 .budget_bytes
554 .saturating_sub(state.used_bytes),
555 )
556 }
557
558 pub(crate) fn peak_bytes(&self) -> usize {
559 lock_recover(&self.ledger.inner.state).accounts[&self.account_id].peak_bytes
560 }
561
562 pub(crate) fn sibling(
563 &self,
564 class: QueryMemoryClass,
565 owner: impl Into<Arc<str>>,
566 budget_bytes: NonZeroUsize,
567 ) -> Self {
568 self.sibling_with_budget_option(
569 class,
570 owner,
571 budget_bytes,
572 "QueryMemoryAccount::sibling(budget_bytes)",
573 )
574 }
575
576 pub(crate) fn sibling_with_budget_option(
577 &self,
578 class: QueryMemoryClass,
579 owner: impl Into<Arc<str>>,
580 budget_bytes: NonZeroUsize,
581 budget_option: &'static str,
582 ) -> Self {
583 let mut account =
584 self.ledger
585 .account_with_budget_option(class, owner, budget_bytes, budget_option);
586 account.backing = self.backing.clone();
587 account
588 }
589
590 pub(crate) fn can_reserve(&self, bytes: usize) -> bool {
591 self.ledger.can_reserve(self.account_id, bytes)
592 }
593
594 pub fn reserve(&self, bytes: usize) -> Result<QueryMemoryLease> {
595 self.ledger.reserve(self.account_id, bytes)?;
596 Ok(QueryMemoryLease {
597 account: self.clone(),
598 bytes,
599 })
600 }
601}
602
603#[derive(Debug)]
604pub struct QueryMemoryLease {
605 account: QueryMemoryAccount,
606 bytes: usize,
607}
608
609impl QueryMemoryLease {
610 pub(crate) fn operator_budget_error(
611 &self,
612 requested: usize,
613 used: usize,
614 budget: usize,
615 budget_option: &'static str,
616 message: String,
617 ) -> HawDBError {
618 let state = lock_recover(&self.account.ledger.inner.state);
619 state.accounts[&self.account.account_id].budget_error(
620 ResourceBudgetScope::Operator,
621 requested,
622 used,
623 budget,
624 budget_option,
625 message,
626 )
627 }
628
629 pub(crate) fn belongs_to(&self, account: &QueryMemoryAccount) -> bool {
630 self.account.account_id == account.account_id
631 && Arc::ptr_eq(&self.account.ledger.inner, &account.ledger.inner)
632 }
633
634 pub fn bytes(&self) -> usize {
635 self.bytes
636 }
637
638 pub(crate) fn split_off(&mut self, bytes: usize) -> Result<Self> {
641 if bytes > self.bytes {
642 return Err(HawDBError::Execution(
643 "query memory lease split exceeds its admitted charge".into(),
644 ));
645 }
646 self.bytes -= bytes;
647 Ok(Self {
648 account: self.account.clone(),
649 bytes,
650 })
651 }
652
653 pub fn grow(&mut self, bytes: usize) -> Result<()> {
654 self.account
655 .ledger
656 .reserve(self.account.account_id, bytes)?;
657 self.bytes = self.bytes.saturating_add(bytes);
658 Ok(())
659 }
660
661 pub fn shrink(&mut self, bytes: usize) {
662 let released = bytes.min(self.bytes);
663 self.account
664 .ledger
665 .release(self.account.account_id, released);
666 self.bytes -= released;
667 }
668
669 pub fn reset(&mut self) {
670 self.shrink(self.bytes);
671 }
672
673 pub(crate) fn transfer_to(
674 &mut self,
675 source_bytes: usize,
676 target: &mut Self,
677 target_bytes: usize,
678 ) -> Result<()> {
679 if !Arc::ptr_eq(&self.account.ledger.inner, &target.account.ledger.inner) {
680 return Err(HawDBError::Execution(
681 "query memory transfer requires accounts from the same ledger".to_string(),
682 ));
683 }
684 if source_bytes > self.bytes {
685 return Err(HawDBError::Execution(format!(
686 "query memory transfer tried to release {source_bytes} bytes from a {}-byte lease",
687 self.bytes,
688 )));
689 }
690 self.account.ledger.transfer(
691 self.account.account_id,
692 source_bytes,
693 target.account.account_id,
694 target_bytes,
695 )?;
696 self.bytes -= source_bytes;
697 target.bytes = target.bytes.saturating_add(target_bytes);
698 Ok(())
699 }
700}
701
702impl Drop for QueryMemoryLease {
703 fn drop(&mut self) {
704 self.account
705 .ledger
706 .release(self.account.account_id, self.bytes);
707 self.bytes = 0;
708 }
709}
710
711fn lock_recover<T>(mutex: &Mutex<T>) -> MutexGuard<'_, T> {
712 mutex
716 .lock()
717 .unwrap_or_else(|poisoned| poisoned.into_inner())
718}
719
720#[cfg(test)]
721#[path = "memory_ledger_hardening_tests.rs"]
722mod hardening_tests;
723
724#[cfg(test)]
725#[path = "memory_ledger_budget_tests.rs"]
726mod budget_tests;
727
728#[cfg(test)]
729mod tests {
730 use super::*;
731
732 #[test]
733 fn splitting_a_full_lease_preserves_charge_and_independent_drop() {
734 let budget = NonZeroUsize::new(8).unwrap();
735 let ledger = QueryMemoryLedger::new(budget);
736 let account = ledger.account(QueryMemoryClass::ResultMaterialization, "retained", budget);
737 let mut owner = account.reserve(8).unwrap();
738 assert!(owner.split_off(9).is_err());
739 assert_eq!(owner.bytes(), 8);
740 let view = owner.split_off(3).unwrap();
741 assert_eq!(owner.bytes(), 5);
742 assert_eq!(view.bytes(), 3);
743 assert_eq!(ledger.snapshot().used_bytes, 8);
744 assert_eq!(ledger.snapshot().peak_bytes, 8);
745 drop(owner);
746 assert_eq!(ledger.snapshot().used_bytes, 3);
747 drop(view);
748 assert_eq!(ledger.snapshot().used_bytes, 0);
749 }
750
751 #[test]
752 fn source_account_reuses_retained_cap_without_registering_an_unused_account() {
753 let ledger = QueryMemoryLedger::new(NonZeroUsize::new(1024).unwrap());
754 let retained = ledger.account(
755 QueryMemoryClass::BlockingState,
756 "shared state",
757 NonZeroUsize::new(512).unwrap(),
758 );
759 let source =
760 ledger.source_account_retaining("source", ledger.budget_bytes(), retained.clone());
761 assert_eq!(ledger.snapshot().account_count, 2);
762 let mut grant = crate::store::admit_graph_read(&source, None, 512).unwrap();
763 grant.retain_state().unwrap();
764 assert!(retained.reserve(1).is_err());
765 assert_eq!(ledger.snapshot().used_bytes, 512);
766 drop(grant);
767 let reused = retained.reserve(512).unwrap();
768 assert_eq!(ledger.snapshot().account_count, 2);
769 drop(reused);
770 assert_eq!(ledger.snapshot().used_bytes, 0);
771 }
772
773 #[test]
774 fn sub_accounts_reserve_parent_capacity_without_double_charging() {
775 let budget = NonZeroUsize::new(100).unwrap();
776 let ledger = QueryMemoryLedger::new(budget);
777 let parent = ledger.account(QueryMemoryClass::BlockingState, "merge", budget);
778 let retained = parent.reserve(10).unwrap();
779 let left = parent.sub_account(NonZeroUsize::new(60).unwrap()).unwrap();
780 let right = parent.sub_account(NonZeroUsize::new(30).unwrap()).unwrap();
781 assert_eq!(parent.available_bytes(), 0);
782 assert!(parent.sub_account(NonZeroUsize::MIN).is_err());
783 let mut left_lease = left.reserve(60).unwrap();
784 let right_lease = right.reserve(30).unwrap();
785 assert!(left_lease.grow(1).is_err());
786 assert_eq!(ledger.snapshot().used_bytes, 100);
787 drop((left, right, retained));
788 assert_eq!(ledger.snapshot().used_bytes, 90);
789 drop(left_lease);
790 assert_eq!(ledger.snapshot().used_bytes, 30);
791 drop(right_lease);
792 assert_eq!(ledger.snapshot().used_bytes, 0);
793 assert_eq!(ledger.snapshot().peak_bytes, 100);
794 }
795
796 #[test]
797 fn nested_accounts_and_siblings_keep_backing_until_last_owner_drops() {
798 let budget = NonZeroUsize::new(8).unwrap();
799 let ledger = QueryMemoryLedger::new(budget);
800 let parent = ledger.account(QueryMemoryClass::BlockingState, "merge", budget);
801 let child = parent.sub_account(budget).unwrap();
802 let sibling = child.sibling(QueryMemoryClass::SpillStaging, "staging", budget);
803 let nested = child.sub_account(NonZeroUsize::new(4).unwrap()).unwrap();
804 assert!(sibling.reserve(5).is_err());
805 let lease = nested.reserve(4).unwrap();
806 drop((parent, child, nested));
807 assert_eq!(ledger.snapshot().used_bytes, 8);
808 drop(lease);
809 assert_eq!(ledger.snapshot().used_bytes, 8);
810 let sibling_lease = sibling.reserve(8).unwrap();
811 drop(sibling);
812 assert_eq!(ledger.snapshot().used_bytes, 8);
813 drop(sibling_lease);
814 assert_eq!(ledger.snapshot().used_bytes, 0);
815 }
816
817 #[test]
818 fn failed_sub_account_admission_does_not_leak_root_capacity() {
819 let budget = NonZeroUsize::new(100).unwrap();
820 let ledger = QueryMemoryLedger::new(budget);
821 let parent = ledger.account(QueryMemoryClass::BlockingState, "merge", budget);
822 let other = ledger.account(QueryMemoryClass::PipelineBatch, "input", budget);
823 let retained = other.reserve(70).unwrap();
824 assert!(parent.sub_account(NonZeroUsize::new(31).unwrap()).is_err());
825 assert_eq!(ledger.snapshot().used_bytes, 70);
826 let child = parent.sub_account(NonZeroUsize::new(30).unwrap()).unwrap();
827 assert!(child.reserve(31).is_err());
828 drop((child, retained));
829 assert_eq!(ledger.snapshot().used_bytes, 0);
830 }
831
832 #[test]
833 fn sibling_accounts_share_one_root_budget() {
834 let ledger = QueryMemoryLedger::new(NonZeroUsize::new(10).unwrap());
835 let left = ledger.account(
836 QueryMemoryClass::BlockingState,
837 "left",
838 NonZeroUsize::new(10).unwrap(),
839 );
840 let right = ledger.account(
841 QueryMemoryClass::PipelineBatch,
842 "right",
843 NonZeroUsize::new(10).unwrap(),
844 );
845 let left_lease = left.reserve(6).unwrap();
846 let error = right.reserve(5).unwrap_err();
847
848 assert!(error.to_string().contains("query_memory_bytes 10"));
849 assert_eq!(ledger.snapshot().used_bytes, 6);
850 drop(left_lease);
851 assert_eq!(ledger.snapshot().used_bytes, 0);
852 }
853
854 #[test]
855 fn capacity_preflight_checks_account_and_root_without_charging() {
856 let ledger = QueryMemoryLedger::new(NonZeroUsize::new(10).unwrap());
857 let left = ledger.account(
858 QueryMemoryClass::BlockingState,
859 "left",
860 NonZeroUsize::new(8).unwrap(),
861 );
862 let right = ledger.account(
863 QueryMemoryClass::PipelineBatch,
864 "right",
865 NonZeroUsize::new(10).unwrap(),
866 );
867
868 assert!(left.can_reserve(8));
869 assert_eq!(ledger.snapshot().used_bytes, 0);
870 let left_lease = left.reserve(6).unwrap();
871 assert!(!left.can_reserve(3));
872 assert!(right.can_reserve(4));
873 assert!(!right.can_reserve(5));
874 assert_eq!(ledger.snapshot().used_bytes, 6);
875
876 drop(left_lease);
877 assert_eq!(ledger.snapshot().used_bytes, 0);
878 }
879
880 #[test]
881 fn derived_sibling_account_keeps_the_original_query_root() {
882 let budget = NonZeroUsize::new(8).unwrap();
883 let ledger = QueryMemoryLedger::new(budget);
884 let state = ledger.account(QueryMemoryClass::BlockingState, "merge", budget);
885 let output = state.sibling(QueryMemoryClass::PipelineBatch, "output", budget);
886 let state_lease = state.reserve(6).unwrap();
887 assert!(output
888 .reserve(3)
889 .unwrap_err()
890 .to_string()
891 .contains("query_memory_bytes 8"));
892 let output_lease = output.reserve(2).unwrap();
893 assert_eq!(ledger.snapshot().used_bytes, 8);
894 drop((state_lease, output_lease));
895 assert_eq!(ledger.snapshot().used_bytes, 0);
896 }
897
898 #[test]
899 fn ownership_transfer_does_not_require_double_root_capacity() {
900 let budget = NonZeroUsize::new(8).unwrap();
901 let ledger = QueryMemoryLedger::new(budget);
902 let source = ledger.account(QueryMemoryClass::BlockingState, "source", budget);
903 let target = ledger.account(QueryMemoryClass::PipelineBatch, "target", budget);
904 let mut source_lease = source.reserve(8).unwrap();
905 let mut target_lease = target.reserve(0).unwrap();
906
907 source_lease.transfer_to(8, &mut target_lease, 8).unwrap();
908
909 assert_eq!(source_lease.bytes(), 0);
910 assert_eq!(target_lease.bytes(), 8);
911 let snapshot = ledger.snapshot();
912 assert_eq!(snapshot.used_bytes, 8);
913 assert_eq!(snapshot.peak_bytes, 8);
914 drop((source_lease, target_lease));
915 assert_eq!(ledger.snapshot().used_bytes, 0);
916 }
917
918 #[test]
919 fn failed_ownership_transfer_preserves_source_charge() {
920 let budget = NonZeroUsize::new(8).unwrap();
921 let ledger = QueryMemoryLedger::new(budget);
922 let source = ledger.account(QueryMemoryClass::BlockingState, "source", budget);
923 let target = ledger.account(QueryMemoryClass::PipelineBatch, "target", budget);
924 let mut source_lease = source.reserve(8).unwrap();
925 let mut target_lease = target.reserve(0).unwrap();
926
927 let error = source_lease
928 .transfer_to(8, &mut target_lease, 9)
929 .unwrap_err();
930
931 assert!(error.to_string().contains("9 bytes"));
932 assert_eq!(source_lease.bytes(), 8);
933 assert_eq!(target_lease.bytes(), 0);
934 assert_eq!(ledger.snapshot().used_bytes, 8);
935 }
936
937 #[test]
938 fn account_budget_is_enforced_before_root_budget() {
939 let ledger = QueryMemoryLedger::new(NonZeroUsize::new(100).unwrap());
940 let account = ledger.account(
941 QueryMemoryClass::BlockingState,
942 "sort",
943 NonZeroUsize::new(4).unwrap(),
944 );
945
946 let error = account.reserve(5).unwrap_err();
947
948 assert!(error.to_string().contains("sort"));
949 assert!(error.to_string().contains("4-byte budget"));
950 assert_eq!(ledger.snapshot().used_bytes, 0);
951 }
952
953 #[test]
954 fn lease_growth_shrink_and_drop_update_hierarchy() {
955 let ledger = QueryMemoryLedger::new(NonZeroUsize::new(100).unwrap());
956 let account = ledger.account(
957 QueryMemoryClass::MorselOutput,
958 "reorder",
959 NonZeroUsize::new(80).unwrap(),
960 );
961 let mut lease = account.reserve(20).unwrap();
962 lease.grow(30).unwrap();
963 lease.shrink(10);
964 assert_eq!(lease.bytes(), 40);
965 assert_eq!(ledger.snapshot().used_bytes, 40);
966
967 drop(lease);
968 let snapshot = ledger.snapshot();
969 assert_eq!(snapshot.used_bytes, 0);
970 assert_eq!(snapshot.peak_bytes, 50);
971 assert_eq!(snapshot.classes[0].peak_bytes, 50);
972 }
973
974 #[test]
975 fn unwind_releases_query_memory_lease() {
976 let ledger = QueryMemoryLedger::new(NonZeroUsize::new(100).unwrap());
977 let account = ledger.account(
978 QueryMemoryClass::SpillStaging,
979 "spill",
980 NonZeroUsize::new(100).unwrap(),
981 );
982 let result = std::panic::catch_unwind(|| {
983 let _lease = account.reserve(80).unwrap();
984 panic!("injected panic");
985 });
986
987 assert!(result.is_err());
988 assert_eq!(ledger.snapshot().used_bytes, 0);
989 }
990}