1use super::*;
2use parking_lot::RwLock;
3
4const CHECKPOINT_BATCH_BYTES: usize = 1024 * 1024;
5const CHECKPOINT_BATCH_ROWS: usize = 512;
6
7#[derive(Debug)]
8struct SystemCollectionCollision {
9 survivor: String,
10 loser: String,
11 canonical: String,
12 shared_physical_state: bool,
13 resume_counter_drift: bool,
14 merged_resume: Option<reddb_file::native_resume::CollectionResume>,
15}
16
17#[derive(Debug, Default)]
18struct CatalogLoadOutcome {
19 migrated: bool,
20 collisions: Vec<SystemCollectionCollision>,
21}
22
23fn merge_shared_alias_resume(
24 legacy: &reddb_file::native_resume::CollectionResume,
25 canonical: &reddb_file::native_resume::CollectionResume,
26) -> Option<reddb_file::native_resume::CollectionResume> {
27 let (data_root_match, key_index_root_match, secondary_index_state_match) =
28 shared_alias_resume_matches(legacy, canonical);
29 if !data_root_match || !key_index_root_match || !secondary_index_state_match {
30 return None;
31 }
32 let mut merged = legacy.clone();
33 merged.entities = legacy.entities.max(canonical.entities);
38 merged.entity_id_next = legacy.entity_id_next.max(canonical.entity_id_next);
39 merged.row_id_next = legacy.row_id_next.max(canonical.row_id_next);
40 merged.sequence_id_next = legacy.sequence_id_next.max(canonical.sequence_id_next);
41 Some(merged)
42}
43
44fn shared_alias_resume_matches(
45 legacy: &reddb_file::native_resume::CollectionResume,
46 canonical: &reddb_file::native_resume::CollectionResume,
47) -> (bool, bool, bool) {
48 (
49 legacy.root_page == canonical.root_page,
50 legacy.key_index_root == canonical.key_index_root,
51 legacy.secondary_indices == canonical.secondary_indices,
52 )
53}
54
55struct CheckpointTreeBuilder {
58 tree: Arc<BTree>,
59 records: Vec<(Vec<u8>, Vec<u8>)>,
60 bytes: usize,
61}
62
63impl CheckpointTreeBuilder {
64 fn new(pager: &Arc<Pager>) -> Self {
65 Self {
66 tree: Arc::new(BTree::new(Arc::clone(pager))),
67 records: Vec::new(),
68 bytes: 0,
69 }
70 }
71
72 fn push(&mut self, record: (Vec<u8>, Vec<u8>)) -> Result<(), StoreError> {
73 let bytes = record.0.len() + record.1.len();
74 if !self.records.is_empty()
75 && (self.bytes.saturating_add(bytes) > CHECKPOINT_BATCH_BYTES
76 || self.records.len() >= CHECKPOINT_BATCH_ROWS)
77 {
78 self.flush()?;
79 }
80 self.bytes += bytes;
81 self.records.push(record);
82 #[cfg(test)]
83 CHECKPOINT_BUFFERED_BYTES.with(|peak| peak.set(peak.get().max(self.bytes)));
84 Ok(())
85 }
86
87 fn flush(&mut self) -> Result<(), StoreError> {
88 self.tree
89 .bulk_insert_sorted(&self.records)
90 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
91 self.records.clear();
92 self.bytes = 0;
93 Ok(())
94 }
95
96 fn copy_prefix(&mut self, previous: &BTree, count: usize) -> Result<(), StoreError> {
97 let mut cursor = previous
98 .cursor_first()
99 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
100 for _ in 0..count {
101 let record = cursor
102 .next()
103 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?
104 .ok_or_else(|| StoreError::Serialization("checkpoint prefix disappeared".into()))?;
105 self.push(record)?;
106 }
107 Ok(())
108 }
109}
110
111#[cfg(test)]
112thread_local! {
113 static CHECKPOINT_SERIALIZED_ROWS: std::cell::Cell<usize> = const { std::cell::Cell::new(0) };
114 static REPLAY_SERIALIZED_ROWS: std::cell::Cell<usize> = const { std::cell::Cell::new(0) };
115 static CHECKPOINT_BUFFERED_BYTES: std::cell::Cell<usize> = const { std::cell::Cell::new(0) };
116}
117
118fn checkpoint_visibility_matches(
119 previous: &CheckpointVersion,
120 current: &CheckpointVersion,
121) -> bool {
122 (previous.visibility_revision == current.visibility_revision
123 || previous.excluded_xids == current.excluded_xids)
124 && previous.pending_vault == current.pending_vault
125}
126
127const META_PAGE_CONTENT_CAP: usize =
146 crate::storage::engine::PAGE_SIZE - crate::storage::engine::HEADER_SIZE;
147const META_V3_PAGE1_HEADER: usize = reddb_file::METADATA_OVERFLOW_HEADER_BYTES;
148const META_V3_OVERFLOW_HEADER: usize = reddb_file::METADATA_OVERFLOW_CONTINUATION_HEADER_BYTES;
149const META_V3_FIRST_PAYLOAD_CAP: usize = META_PAGE_CONTENT_CAP - META_V3_PAGE1_HEADER;
150const META_V3_OVERFLOW_PAYLOAD_CAP: usize = META_PAGE_CONTENT_CAP - META_V3_OVERFLOW_HEADER;
151
152fn existing_overflow_chain(pager: &Pager) -> Result<Vec<u32>, PagerError> {
153 let cs = crate::storage::engine::HEADER_SIZE;
154 let page = pager.read_page(1)?;
155 let bytes = page.as_bytes();
156 if bytes.len() < cs + META_V3_PAGE1_HEADER {
157 return Ok(Vec::new());
158 }
159 let Some(header) =
160 reddb_file::decode_native_metadata_overflow_header(&bytes[cs..]).map_err(|err| {
161 PagerError::InvalidDatabase(format!("invalid metadata overflow header: {err}"))
162 })?
163 else {
164 return Ok(Vec::new());
165 };
166 let mut next = header.next_overflow_page_id;
167 let mut pages = Vec::new();
168 let mut seen = std::collections::HashSet::new();
169 while next != 0 {
170 if !seen.insert(next) || pages.len() >= pager.page_count()? as usize {
171 return Err(PagerError::InvalidDatabase(
172 "cyclic metadata overflow chain".into(),
173 ));
174 }
175 let ov = pager.read_page(next)?;
176 if ov.page_type()? != crate::storage::engine::PageType::Overflow {
177 return Err(PagerError::InvalidDatabase(
178 "invalid metadata overflow page type".into(),
179 ));
180 }
181 let ob = ov.as_bytes();
182 let nn = reddb_file::decode_native_metadata_overflow_continuation_header(&ob[cs..])
183 .map_err(|err| PagerError::InvalidDatabase(err.to_string()))?
184 .next_overflow_page_id;
185 pages.push(next);
186 next = nn;
187 }
188 Ok(pages)
189}
190
191fn publish_paged_metadata(pager: &Pager, meta_data: &[u8]) -> Result<(), PagerError> {
192 let retired = existing_overflow_chain(pager)?;
193 if !retired.is_empty() {
194 pager.record_retirement_intent(&retired)?;
195 }
196 let page = build_meta_page1_with_overflow(pager, meta_data)?;
197 pager.sync()?;
199 pager.write_page(1, page)?;
200 pager.sync()?;
201 for id in retired {
202 pager.free_page(id)?;
203 }
204 Ok(())
205}
206
207fn build_meta_page1_with_overflow(
208 pager: &Pager,
209 meta_data: &[u8],
210) -> Result<crate::storage::engine::Page, PagerError> {
211 use crate::storage::engine::{Page, PageType, HEADER_SIZE};
212
213 let mut page1 = Page::new(PageType::Header, 1);
214 let cs = HEADER_SIZE;
215
216 if meta_data.len() <= META_PAGE_CONTENT_CAP {
217 let buf = page1.as_bytes_mut();
219 buf[cs..cs + meta_data.len()].copy_from_slice(meta_data);
220 return Ok(page1);
221 }
222
223 let first_chunk = &meta_data[..META_V3_FIRST_PAYLOAD_CAP];
227 let mut tail = &meta_data[META_V3_FIRST_PAYLOAD_CAP..];
228 let mut chunks: Vec<&[u8]> = Vec::new();
229 while !tail.is_empty() {
230 let take = tail.len().min(META_V3_OVERFLOW_PAYLOAD_CAP);
231 chunks.push(&tail[..take]);
232 tail = &tail[take..];
233 }
234
235 let mut overflow_pages: Vec<Page> = Vec::with_capacity(chunks.len());
236 let mut overflow_ids: Vec<u32> = Vec::with_capacity(chunks.len());
237 for _ in 0..chunks.len() {
238 let pg = pager.allocate_page(PageType::Overflow)?;
239 overflow_ids.push(pg.page_id());
240 overflow_pages.push(pg);
241 }
242
243 for i in 0..chunks.len() {
244 let next = if i + 1 < chunks.len() {
245 overflow_ids[i + 1]
246 } else {
247 0u32
248 };
249 let len = chunks[i].len() as u32;
250 let buf = overflow_pages[i].as_bytes_mut();
251 reddb_file::encode_native_metadata_overflow_continuation_header(
252 &mut buf[cs..cs + META_V3_OVERFLOW_HEADER],
253 reddb_file::NativeMetadataOverflowContinuationHeader {
254 next_overflow_page_id: next,
255 chunk_bytes: len,
256 },
257 )
258 .map_err(|err| PagerError::InvalidDatabase(err.to_string()))?;
259 buf[cs + 8..cs + 8 + chunks[i].len()].copy_from_slice(chunks[i]);
260 }
261 for (idx, page) in overflow_pages.into_iter().enumerate() {
262 let id = overflow_ids[idx];
263 pager.write_page(id, page)?;
264 }
265
266 let format_version = reddb_file::decode_native_paged_metadata_header(meta_data)
268 .ok()
269 .flatten()
270 .map_or(0, |header| header.format_version);
271
272 let buf = page1.as_bytes_mut();
273 reddb_file::encode_native_metadata_overflow_header(
274 &mut buf[cs..cs + META_V3_PAGE1_HEADER],
275 reddb_file::NativeMetadataOverflowHeader {
276 format_version,
277 total_payload_bytes: meta_data.len() as u32,
278 next_overflow_page_id: overflow_ids[0],
279 },
280 )
281 .map_err(|err| PagerError::InvalidDatabase(err.to_string()))?;
282 buf[cs + META_V3_PAGE1_HEADER..cs + META_V3_PAGE1_HEADER + first_chunk.len()]
283 .copy_from_slice(first_chunk);
284
285 Ok(page1)
286}
287
288fn storage_integrity(
289 zone: &str,
290 id: impl Into<String>,
291 collection: Option<String>,
292 detail: impl Into<String>,
293) -> StoreError {
294 StoreError::StorageIntegrity(crate::api::StorageIntegrityError::new(
295 zone, id, collection, detail,
296 ))
297}
298
299fn page_integrity(
300 page_id: u32,
301 collection: Option<String>,
302 detail: impl Into<String>,
303) -> StoreError {
304 storage_integrity("page", page_id.to_string(), collection, detail)
305}
306
307fn read_meta_payload(pager: &Pager) -> Result<Option<Vec<u8>>, StoreError> {
319 let cs = crate::storage::engine::HEADER_SIZE;
320 let meta_page = pager.read_manifest_page().map_err(|err| {
321 storage_integrity(
322 "manifest",
323 "manifest",
324 None,
325 format!("internal manifest zone read failed ({err})"),
326 )
327 })?;
328 let bytes = meta_page.as_bytes();
329 if bytes.len() < cs + 4 {
330 return Ok(Some(bytes.get(cs..).unwrap_or(&[]).to_vec()));
331 }
332 let header = match reddb_file::decode_native_metadata_overflow_header(&bytes[cs..])
333 .map_err(|err| page_integrity(1, None, err.to_string()))?
334 {
335 Some(header) => header,
336 None => {
337 return Ok(Some(bytes[cs..].to_vec()));
338 }
339 };
340 if bytes.len() < cs + META_V3_PAGE1_HEADER {
341 return Err(page_integrity(
342 1,
343 None,
344 "metadata overflow header is truncated",
345 ));
346 }
347 let total = header.total_payload_bytes as usize;
348 let mut next = header.next_overflow_page_id;
349 let mut payload: Vec<u8> = Vec::with_capacity(total);
350 let first_take = total.min(META_V3_FIRST_PAYLOAD_CAP);
351 payload.extend_from_slice(
352 &bytes[cs + META_V3_PAGE1_HEADER..cs + META_V3_PAGE1_HEADER + first_take],
353 );
354 let mut seen = std::collections::HashSet::new();
355 while next != 0 && payload.len() < total {
356 if !seen.insert(next)
357 || seen.len()
358 >= pager
359 .page_count()
360 .map_err(|err| page_integrity(next, None, err.to_string()))?
361 as usize
362 {
363 return Err(page_integrity(next, None, "cyclic metadata overflow chain"));
364 }
365 let ov = pager
366 .read_page(next)
367 .map_err(|err| page_integrity(next, None, err.to_string()))?;
368 if ov
369 .page_type()
370 .map_err(|err| page_integrity(next, None, err.to_string()))?
371 != crate::storage::engine::PageType::Overflow
372 {
373 return Err(page_integrity(
374 next,
375 None,
376 "invalid metadata overflow page type",
377 ));
378 }
379 let ob = ov.as_bytes();
380 if ob.len() < cs + META_V3_OVERFLOW_HEADER {
381 return Err(page_integrity(
382 next,
383 None,
384 "metadata overflow continuation is truncated",
385 ));
386 }
387 let continuation =
388 reddb_file::decode_native_metadata_overflow_continuation_header(&ob[cs..])
389 .map_err(|err| page_integrity(next, None, err.to_string()))?;
390 let nn = continuation.next_overflow_page_id;
391 let len = continuation.chunk_bytes as usize;
392 let remaining = total - payload.len();
393 let take = len.min(remaining).min(META_V3_OVERFLOW_PAYLOAD_CAP);
394 payload.extend_from_slice(
395 &ob[cs + META_V3_OVERFLOW_HEADER..cs + META_V3_OVERFLOW_HEADER + take],
396 );
397 next = nn;
398 }
399 if payload.len() != total {
400 return Err(page_integrity(
401 1,
402 None,
403 "metadata overflow chain is incomplete",
404 ));
405 }
406 Ok(Some(payload))
407}
408
409impl UnifiedStore {
410 fn checkpoint_tree(
414 &self,
415 pager: &Arc<Pager>,
416 manager: &SegmentManager,
417 previous: Option<&Arc<BTree>>,
418 mut encode: impl FnMut(&UnifiedEntity, Option<Metadata>) -> Option<Vec<u8>>,
419 ) -> Result<Arc<BTree>, StoreError> {
420 if let Some((base, overlay)) = manager.backing_overlay(&mut encode) {
421 use reddb_engine::storage::collection_read::{CollectionRead, MergedCollection};
422 let merged = MergedCollection::new(base.as_ref(), overlay);
423 let mut cursor = merged.cursor()?;
424 let mut builder = CheckpointTreeBuilder::new(pager);
425 while let Some(record) = cursor.next_record(
426 usize::try_from(self.config.resident_memory_bytes_max.unwrap_or(u64::MAX))
427 .unwrap_or(usize::MAX),
428 )? {
429 builder.push((record.id.raw().to_be_bytes().to_vec(), record.bytes))?;
430 }
431 builder.flush()?;
432 return Ok(builder.tree);
433 }
434 let mut cursor = previous
435 .map(|tree| tree.cursor_first())
436 .transpose()
437 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
438 let mut matched = 0;
439 let mut builder = None;
440 let mut failure = None;
441 manager.for_each_entity_with_metadata_in_id_order(|entity, metadata| {
442 let Some(value) = encode(entity, metadata) else {
443 return true;
444 };
445 let record = (entity.id.raw().to_be_bytes().to_vec(), value);
446 let result = (|| {
447 if builder.is_none() {
448 if let Some(cursor) = cursor.as_mut() {
449 if cursor
450 .next()
451 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?
452 .as_ref()
453 == Some(&record)
454 {
455 matched += 1;
456 return Ok(());
457 }
458 }
459 let mut replacement = CheckpointTreeBuilder::new(pager);
460 if let Some(previous) = previous {
461 replacement.copy_prefix(previous, matched)?;
462 }
463 builder = Some(replacement);
464 }
465 builder
466 .as_mut()
467 .expect("replacement initialized")
468 .push(record)
469 })();
470 if let Err(error) = result {
471 failure = Some(error);
472 return false;
473 }
474 true
475 });
476 if let Some(error) = failure {
477 return Err(error);
478 }
479 if builder.is_none() {
480 if let (Some(previous), Some(cursor)) = (previous, cursor.as_mut()) {
481 if cursor
482 .next()
483 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?
484 .is_none()
485 {
486 return Ok(Arc::clone(previous));
487 }
488 }
489 let mut replacement = CheckpointTreeBuilder::new(pager);
490 if let Some(previous) = previous {
491 replacement.copy_prefix(previous, matched)?;
492 }
493 builder = Some(replacement);
494 }
495 let mut builder = builder.expect("replacement or reused tree");
496 builder.flush()?;
497 Ok(builder.tree)
498 }
499
500 fn publish_reclaimable_trees(
504 &self,
505 pager: &Pager,
506 metadata: &mut Vec<u8>,
507 live: &HashMap<String, Arc<BTree>>,
508 keys: &HashMap<String, PublishedKeyIndex>,
509 ) -> Result<(), StoreError> {
510 let mut next_xid_summary = None;
511 let mut retired = self.retired_btrees.lock();
512 let mut roots = Vec::new();
513 let mut reclaim = Vec::new();
514 let mut remove = std::collections::HashSet::new();
515 for (index, entry) in retired.iter().enumerate() {
516 if live
517 .values()
518 .chain(keys.values().flat_map(PublishedKeyIndex::trees))
519 .any(|tree| Arc::ptr_eq(tree, &entry.tree))
520 {
521 remove.insert(index);
522 continue;
523 }
524 if entry.published
525 && Arc::strong_count(&entry.tree) == 1
526 && !entry.tree.has_retirement_readers()
527 {
528 #[cfg(test)]
532 if std::env::var_os("REDDB_EXPERIMENTAL_RETAIN_RELEASED_ROOT").is_some() {
533 roots.push(entry.tree.root_page_id());
534 }
535 reclaim.extend(
536 entry
537 .tree
538 .retired_pages()
539 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?,
540 );
541 remove.insert(index);
542 } else if entry.tree.root_page_id() != 0 {
543 roots.push(entry.tree.root_page_id());
544 }
545 }
546 roots.sort_unstable();
547 roots.dedup();
548 reddb_file::encode_native_paged_retired_trees(metadata, &roots)
549 .map_err(|e| StoreError::Serialization(e.to_string()))?;
550 let (pending_pages, published_pages) = pager
551 .deferred_reclamation_pages()
552 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
553 let readers = live
554 .values()
555 .chain(keys.values().flat_map(PublishedKeyIndex::trees))
556 .any(|tree| tree.has_retirement_readers())
557 || retired
558 .iter()
559 .any(|entry| entry.tree.has_retirement_readers());
560 let released_pages = if readers { Vec::new() } else { published_pages };
561 let released: std::collections::HashSet<_> = released_pages.iter().copied().collect();
562 let retained_pages: Vec<_> = pending_pages
563 .into_iter()
564 .filter(|id| !released.contains(id))
565 .collect();
566 reddb_file::encode_native_paged_deferred_pages(metadata, &retained_pages)
567 .map_err(|e| StoreError::Serialization(e.to_string()))?;
568 let active_epoch = self.ownership_active_epoch.load(Ordering::Acquire);
569 let catalog_epoch = if active_epoch == 0 {
570 self.ownership_catalog_epoch.load(Ordering::Acquire)
571 } else {
572 active_epoch
573 };
574 if catalog_epoch != 0 {
575 reddb_file::native_store::encode_native_paged_ownership_epoch(metadata, catalog_epoch)
576 .map_err(|e| StoreError::Serialization(e.to_string()))?;
577 }
578 if self.config.resident_memory_bytes_max.is_some() {
579 use reddb_file::native_resume::{
580 encode_catalog_resume, CatalogResume, CollectionResume,
581 };
582 let mut states = std::collections::BTreeMap::new();
583 let mut entity_id_next = self.resident.next_entity_id.load(Ordering::SeqCst);
584 let collections = self.resident.collections.read();
585 let publishes_rows = {
586 let summary = self.recovery_xid_summary.read();
587 live.iter().any(|(name, tree)| {
588 let root = tree.root_page_id();
589 root != 0
590 && summary.as_ref().and_then(|state| state.roots.get(name)) != Some(&root)
591 })
592 };
593 let xid_high_water_mark =
594 self.base_xid_high_water_mark(&collections).map(|mut high| {
595 if publishes_rows {
600 for manager in collections.values() {
601 manager.for_each_entity(|entity| {
602 high = high.max(entity.xmin).max(entity.xmax);
603 true
604 });
605 }
606 }
607 if let Some(snapshots) = self.snapshot_manager.get() {
608 high = high.max(snapshots.peek_next_xid().saturating_sub(1));
609 }
610 high
611 });
612 for (name, manager) in collections.iter() {
613 let tree = live.get(name);
614 let (entity_next, row_id_next) = manager.identity_counters();
615 entity_id_next = entity_id_next.max(entity_next);
616 let root_page = tree.map_or(0, |tree| tree.root_page_id());
617 let entities = if root_page == 0 {
618 0
619 } else if let Some(count) = manager.backing_count_at_root(root_page) {
620 count
621 } else {
622 let mut cursor = tree
625 .expect("invariant: nonzero root has a tree")
626 .cursor_first()
627 .map_err(|error| {
628 StoreError::Io(std::io::Error::other(error.to_string()))
629 })?;
630 let mut count = 0_u64;
631 while cursor
632 .skip_next()
633 .map_err(|error| StoreError::Io(std::io::Error::other(error.to_string())))?
634 {
635 count += 1;
636 }
637 count
638 };
639 states.insert(
640 name.clone(),
641 CollectionResume {
642 root_page,
643 entities,
644 entity_id_next: entity_next,
645 row_id_next,
646 sequence_id_next: manager.sequence_id_next(),
647 key_index_root: tree.and_then(|tree| {
648 keys.get(name)
649 .filter(|index| {
650 index.indexed && index.source.ptr_eq(&Arc::downgrade(tree))
651 })
652 .map(|index| index.tree.root_page_id())
653 }),
654 secondary_indices: tree
655 .and_then(|tree| {
656 keys.get(name)
657 .filter(|index| index.source.ptr_eq(&Arc::downgrade(tree)))
658 })
659 .map(|index| {
660 index
661 .secondary
662 .iter()
663 .map(|(name, index)| (name.clone(), index.resume()))
664 .collect()
665 })
666 .unwrap_or_default(),
667 },
668 );
669 }
670 let resume = CatalogResume {
671 entity_id_next,
672 xid_high_water_mark,
673 collections: states,
674 };
675 encode_catalog_resume(metadata, &resume)
676 .map_err(|error| StoreError::Serialization(error.to_string()))?;
677 next_xid_summary = xid_high_water_mark.map(|high_water_mark| {
678 super::recovery_xid::RecoveryXidSummary {
679 high_water_mark,
680 roots: resume
681 .collections
682 .into_iter()
683 .map(|(name, state)| (name, state.root_page))
684 .collect(),
685 }
686 });
687 }
688 let mut retirement_intent = reclaim.clone();
691 retirement_intent.extend_from_slice(&released_pages);
692 if !retirement_intent.is_empty() {
693 pager
694 .record_retirement_intent(&retirement_intent)
695 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
696 }
697 publish_paged_metadata(pager, metadata)
700 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
701 *self.recovery_xid_summary.write() = next_xid_summary;
702 self.ownership_catalog_epoch
703 .store(catalog_epoch, Ordering::Release);
704 #[cfg(test)]
705 if !reclaim.is_empty()
706 && std::env::var_os("REDDB_EXPERIMENTAL_EXIT_BEFORE_RETIRED_FREE").is_some()
707 {
708 eprintln!(
709 "experimental exit before retired free pages={}",
710 reclaim.len()
711 );
712 std::process::exit(184);
713 }
714 let mut index = 0;
715 retired.retain_mut(|entry| {
716 let keep = !remove.contains(&index);
717 entry.published = true;
718 index += 1;
719 keep
720 });
721 if !reclaim.is_empty() {
722 pager
723 .free_retired_pages(&reclaim)
724 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
725 #[cfg(test)]
726 if std::env::var_os("REDDB_EXPERIMENTAL_EXIT_AFTER_RETIRED_ENQUEUE").is_some() {
727 eprintln!(
728 "experimental exit after retired enqueue pages={}",
729 reclaim.len()
730 );
731 std::process::exit(186);
732 }
733 pager
734 .sync()
735 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
736 #[cfg(test)]
737 if std::env::var_os("REDDB_EXPERIMENTAL_EXIT_AFTER_RETIRED_FREE").is_some() {
738 eprintln!(
739 "experimental exit after retired free pages={}",
740 reclaim.len()
741 );
742 std::process::exit(185);
743 }
744 }
745 pager
746 .complete_deferred_publication(&retained_pages, &released_pages)
747 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
748 if !released_pages.is_empty() {
749 pager
750 .sync()
751 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
752 }
753 Ok(())
754 }
755
756 pub(super) fn retire_btree(&self, tree: Arc<BTree>) {
757 let mut retired = self.retired_btrees.lock();
758 if tree.root_page_id() != 0 && !retired.iter().any(|entry| Arc::ptr_eq(&entry.tree, &tree))
759 {
760 retired.push(RetiredBTree {
761 tree,
762 published: false,
763 });
764 }
765 }
766
767 pub(crate) fn note_paged_insert(
771 &self,
772 collection: &str,
773 manager: &Arc<SegmentManager>,
774 before: &[(u64, u64)],
775 id: EntityId,
776 ) {
777 let after = manager.checkpoint_revisions();
778 if before.len() != after.len() {
779 return;
780 }
781 let mut changed = 0;
782 for ((old_id, old_revision), (new_id, new_revision)) in before.iter().zip(&after) {
783 if old_id != new_id {
784 return;
785 }
786 if old_revision != new_revision {
787 if old_revision.checked_add(1) != Some(*new_revision) {
788 return;
789 }
790 changed += 1;
791 }
792 }
793 if changed != 1 {
794 return;
795 }
796 let mut versions = self.checkpoint_versions.write();
797 let Some(previous) = versions.get_mut(collection) else {
798 return;
799 };
800 if previous.manager.ptr_eq(&Arc::downgrade(manager))
801 && previous.segments == before
802 && previous.format_version == self.format_version()
803 && !previous.pending_vault.contains(&id)
804 && !previous.excluded_xids.contains(&0)
805 {
806 previous.segments = after;
807 }
808 }
809
810 pub(crate) fn note_paged_delete(
814 &self,
815 collection: &str,
816 manager: &Arc<SegmentManager>,
817 before: &[(u64, u64)],
818 deleted: &[EntityId],
819 ) {
820 let after = manager.checkpoint_revisions();
821 if before.len() != after.len() {
822 return;
823 }
824 let mut changes = 0_u64;
825 for ((old_id, old_revision), (new_id, new_revision)) in before.iter().zip(&after) {
826 if old_id != new_id {
827 return;
828 }
829 let Some(delta) = new_revision.checked_sub(*old_revision) else {
830 return;
831 };
832 let Some(total) = changes.checked_add(delta) else {
833 return;
834 };
835 changes = total;
836 }
837 let Ok(expected) = u64::try_from(deleted.len()) else {
838 return;
839 };
840 if changes != expected {
841 return;
842 }
843 let mut versions = self.checkpoint_versions.write();
844 let Some(previous) = versions.get_mut(collection) else {
845 return;
846 };
847 if !previous.manager.ptr_eq(&Arc::downgrade(manager))
848 || previous.format_version != self.format_version()
849 || deleted.iter().any(|id| previous.pending_vault.contains(id))
850 || previous.excluded_xids.contains(&0)
851 {
852 return;
853 }
854 if previous.segments != before {
855 let Some(deferred) = previous.deferred_rows.as_ref() else {
856 return;
857 };
858 let Some(changed) = manager.checkpoint_mutations_since(&previous.segments) else {
859 return;
860 };
861 let removed: std::collections::HashSet<_> = deleted.iter().copied().collect();
862 let pending: std::collections::BTreeSet<_> = deferred
863 .iter()
864 .copied()
865 .chain(changed)
866 .filter(|id| !removed.contains(id))
867 .collect();
868 if pending.len() > crate::storage::unified::segment::CHECKPOINT_MUTATIONS_MAX {
869 return;
870 }
871 previous.has_unprojected_rows = !pending.is_empty();
876 previous.deferred_rows = Some(Arc::new(pending.into_iter().collect()));
877 }
878 previous.segments = after;
879 }
880
881 pub(crate) fn mark_paged_registry_dirty(&self) {
882 self.resident.mark_paged_registry_dirty()
883 }
884
885 pub(crate) fn get_or_create_btree(&self, collection: &str) -> Option<Arc<BTree>> {
891 let collection = Self::canonical_collection(collection);
892 let pager = self.pager.as_ref()?;
893 if let Some(btree) = self.btree_indices.read().get(collection).cloned() {
894 return Some(btree);
895 }
896 let mut write = self.btree_indices.write();
897 let btree = write
898 .entry(collection.to_string())
899 .or_insert_with(|| Arc::new(BTree::new(Arc::clone(pager))))
900 .clone();
901 Some(btree)
902 }
903
904 pub(crate) fn flush_paged_state(&self) -> Result<(), StoreError> {
905 let Some(pager) = &self.pager else {
906 return Ok(());
907 };
908
909 if self.resident.paged_registry_dirty.load(Ordering::Acquire) {
910 self.flush_paged_registry()?;
911 self.resident
912 .paged_registry_dirty
913 .store(false, Ordering::Release);
914 return Ok(());
915 }
916
917 pager
918 .flush()
919 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))
920 }
921
922 pub(crate) fn flush_paged_registry(&self) -> Result<(), StoreError> {
923 let _vault_guard = self.vault_publication_lock.lock();
924 let Some(pager) = &self.pager else {
925 return Ok(());
926 };
927
928 match pager.read_page(1) {
929 Ok(_) => {}
930 Err(PagerError::PageNotFound(_)) => {
931 let meta_page = pager
932 .allocate_page(crate::storage::engine::PageType::Header)
933 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
934 pager
935 .write_page(meta_page.page_id(), meta_page)
936 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
937 }
938 Err(e) => {
939 return Err(StoreError::Io(std::io::Error::other(e.to_string())));
940 }
941 }
942
943 let format_version = STORE_VERSION_V11;
944 self.set_format_version(format_version);
945
946 let collections = self.resident.collections.read();
947 let btree_indices = self.btree_indices.read();
948 let mut collection_roots = Vec::with_capacity(collections.len());
949 for (name, _) in collections.iter() {
950 let root_page = btree_indices
951 .get(name)
952 .map_or(0, |btree| btree.root_page_id());
953 collection_roots.push((name.clone(), root_page));
954 }
955 drop(btree_indices);
956 drop(collections);
957
958 let mut meta_data = Vec::with_capacity(4096);
959 reddb_file::encode_native_paged_metadata_header(
960 &mut meta_data,
961 reddb_file::NativePagedMetadataHeader {
962 format_version,
963 collection_count: collection_roots.len() as u32,
964 },
965 );
966 for (name, root_page) in &collection_roots {
967 reddb_file::encode_native_paged_collection_root(&mut meta_data, name, *root_page);
968 }
969
970 let cross_refs = self.resident.cross_refs.read();
971 let total_refs: usize = cross_refs.values().map(|v| v.len()).sum();
972 meta_data.extend_from_slice(&(total_refs as u32).to_le_bytes());
973 for (source_id, refs) in cross_refs.iter() {
974 for (target_id, ref_type, collection) in refs {
975 reddb_file::encode_native_paged_cross_ref(
976 &mut meta_data,
977 source_id.raw(),
978 target_id.raw(),
979 ref_type.to_byte(),
980 reddb_engine::storage::system_collection_names::canonical_or_self(collection),
981 );
982 }
983 }
984
985 self.publish_reclaimable_trees(
986 pager,
987 &mut meta_data,
988 &self.btree_indices.read(),
989 &self.key_indices.read(),
990 )?;
991
992 Ok(())
993 }
994
995 pub fn pager(&self) -> Option<&Arc<Pager>> {
997 self.pager.as_ref()
998 }
999
1000 pub fn page_cache_bytes_in_use(&self) -> u64 {
1004 self.pager.as_ref().map_or(0, |pager| {
1005 pager.cache_len() as u64 * crate::storage::memory_pools::PAGE_CACHE_PAGE_SIZE_BYTES
1006 })
1007 }
1008
1009 pub fn wal_buffer_bytes_in_use(&self) -> u64 {
1012 self.commit
1013 .as_ref()
1014 .map_or(0, |commit| commit.buffered_bytes())
1015 }
1016
1017 pub fn segment_memory_bytes(&self) -> u64 {
1021 let managers: Vec<Arc<SegmentManager>> = self
1022 .resident
1023 .collections
1024 .read()
1025 .values()
1026 .map(Arc::clone)
1027 .collect();
1028
1029 managers
1030 .iter()
1031 .map(|manager| manager.resident_bytes())
1032 .fold(0, u64::saturating_add)
1033 }
1034
1035 pub fn config(&self) -> &UnifiedStoreConfig {
1039 &self.config
1040 }
1041
1042 pub fn with_config(config: UnifiedStoreConfig) -> Self {
1043 Self {
1044 config,
1045 resident: reddb_engine::storage::resident_store::ResidentStore::new(),
1046 format_version: AtomicU32::new(STORE_VERSION_V11),
1047 pager: None,
1048 db_path: None,
1049 btree_indices: RwLock::new(HashMap::new()),
1050 key_indices: RwLock::new(HashMap::new()),
1051 secondary_index_specs: RwLock::new(HashMap::new()),
1052 recovery_xid_summary: RwLock::new(None),
1053 checkpoint_versions: RwLock::new(HashMap::new()),
1054 checkpoint_durable_rows: RwLock::new(super::checkpoint_delta::DurableRows::default()),
1055 retired_btrees: parking_lot::Mutex::new(Vec::new()),
1056 ownership_catalog_epoch: AtomicU64::new(0),
1057 ownership_active_epoch: AtomicU64::new(0),
1058 detached_native_blob_pages: parking_lot::Mutex::new(Default::default()),
1059 commit: None,
1060 replayed_turbo_inserts: parking_lot::Mutex::new(HashMap::new()),
1061 replayed_probabilistic_deltas: parking_lot::Mutex::new(Vec::new()),
1062 snapshot_manager: std::sync::OnceLock::new(),
1063 embedded_commit_session: std::sync::OnceLock::new(),
1064 #[cfg(test)]
1065 test_fail_deferred_wal_append: std::sync::atomic::AtomicBool::new(false),
1066 #[cfg(test)]
1067 test_require_deferred_publication_fence: std::sync::atomic::AtomicBool::new(false),
1068 vault_publication_lock: parking_lot::ReentrantMutex::new(()),
1069 pending_vault_versions: RwLock::new(std::collections::HashSet::new()),
1070 }
1071 }
1072
1073 pub fn open(path: impl AsRef<Path>) -> Result<Self, StoreError> {
1091 Self::open_with_config(path, UnifiedStoreConfig::default())
1092 }
1093
1094 pub fn open_with_config(
1095 path: impl AsRef<Path>,
1096 config: UnifiedStoreConfig,
1097 ) -> Result<Self, StoreError> {
1098 let path = path.as_ref();
1099 let mut pager_config = PagerConfig {
1100 disk_residency: config.resident_memory_bytes_max.is_some(),
1101 ..PagerConfig::default()
1102 };
1103 if let Some(slots) = config.page_cache_slots {
1107 pager_config.cache_size = slots;
1108 }
1109 if matches!(
1117 std::env::var("REDDB_DOUBLE_WRITE").ok().as_deref(),
1118 Some("0") | Some("false") | Some("off")
1119 ) {
1120 pager_config.double_write = false;
1121 }
1122 let pager_open_started = std::time::Instant::now();
1123 let pager = Pager::open(path, pager_config)
1124 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
1125 pager
1126 .enable_deferred_reclamation()
1127 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
1128 trace_startup_phase(path, "paged_pager_open", pager_open_started);
1129
1130 if config.resident_memory_bytes_max.is_none()
1131 && pager
1132 .header()
1133 .map_err(|error| StoreError::Io(std::io::Error::other(error.to_string())))?
1134 .version
1135 >= reddb_file::file_format::PAGE_DISK_RESIDENCY_FILE_VERSION
1136 {
1137 return Err(StoreError::Io(std::io::Error::new(std::io::ErrorKind::Unsupported,
1138 "this database was prepared for disk residency; reopen with the disk-resident storage profile")));
1139 }
1140
1141 let wal_path = reddb_file::layout::unified_wal_path(path);
1142 let commit = Some(Arc::new(
1145 StoreCommitCoordinator::open(wal_path, config.durability_mode, config.group_commit)
1146 .map_err(StoreError::Io)?,
1147 ));
1148
1149 let store = Self {
1150 config,
1151 resident: reddb_engine::storage::resident_store::ResidentStore::new(),
1152 format_version: AtomicU32::new(STORE_VERSION_V11),
1153 pager: Some(Arc::new(pager)),
1154 db_path: Some(path.to_path_buf()),
1155 btree_indices: RwLock::new(HashMap::new()),
1156 key_indices: RwLock::new(HashMap::new()),
1157 secondary_index_specs: RwLock::new(HashMap::new()),
1158 recovery_xid_summary: RwLock::new(None),
1159 checkpoint_versions: RwLock::new(HashMap::new()),
1160 checkpoint_durable_rows: RwLock::new(super::checkpoint_delta::DurableRows::default()),
1161 retired_btrees: parking_lot::Mutex::new(Vec::new()),
1162 ownership_catalog_epoch: AtomicU64::new(0),
1163 ownership_active_epoch: AtomicU64::new(0),
1164 detached_native_blob_pages: parking_lot::Mutex::new(Default::default()),
1165 commit,
1166 replayed_turbo_inserts: parking_lot::Mutex::new(HashMap::new()),
1167 replayed_probabilistic_deltas: parking_lot::Mutex::new(Vec::new()),
1168 snapshot_manager: std::sync::OnceLock::new(),
1169 embedded_commit_session: std::sync::OnceLock::new(),
1170 #[cfg(test)]
1171 test_fail_deferred_wal_append: std::sync::atomic::AtomicBool::new(false),
1172 #[cfg(test)]
1173 test_require_deferred_publication_fence: std::sync::atomic::AtomicBool::new(false),
1174 vault_publication_lock: parking_lot::ReentrantMutex::new(()),
1175 pending_vault_versions: RwLock::new(std::collections::HashSet::new()),
1176 };
1177
1178 let checkpoint_recovery_started = std::time::Instant::now();
1181 if let Some(commit) = &store.commit {
1182 commit
1183 .restore_checkpoint_page_images(&store)
1184 .map_err(StoreError::Io)?;
1185 }
1186 trace_startup_phase(
1187 path,
1188 "paged_checkpoint_recovery",
1189 checkpoint_recovery_started,
1190 );
1191 let page_load_started = std::time::Instant::now();
1193 let catalog_load = store.load_from_pages()?;
1194 trace_startup_phase(path, "paged_catalog_and_roots", page_load_started);
1195 store.migrate_operational_manifest(&catalog_load.collisions)?;
1199 let wal_replay_started = std::time::Instant::now();
1200 if let Some(commit) = &store.commit {
1201 commit.replay_into(&store).map_err(StoreError::Io)?;
1202 }
1203 trace_startup_phase(path, "paged_wal_replay", wal_replay_started);
1204 if catalog_load.migrated {
1205 store.mark_paged_registry_dirty();
1208 store.flush_paged_state()?;
1209 }
1210 let manifest_recovery_started = std::time::Instant::now();
1211 store.recover_operational_manifest()?;
1212 if store.config.resident_memory_bytes_max.is_some() {
1213 let missing_key_index = {
1214 let trees = store.btree_indices.read();
1215 let keys = store.key_indices.read();
1216 trees.iter().any(|(name, tree)| {
1217 !keys
1218 .get(name)
1219 .is_some_and(|index| index.source.ptr_eq(&Arc::downgrade(tree)))
1220 })
1221 };
1222 if missing_key_index {
1223 store.persist()?;
1224 }
1225 }
1226 trace_startup_phase(
1227 path,
1228 "paged_manifest_and_derived_roots",
1229 manifest_recovery_started,
1230 );
1231
1232 Ok(store)
1233 }
1234
1235 pub(crate) fn reconcile_replayed_btrees(&self) -> Result<(), StoreError> {
1239 let Some(pager) = &self.pager else {
1240 return Ok(());
1241 };
1242 let collections = self.resident.collections.read();
1243 let mut indices = self.btree_indices.write();
1244 let previous_versions = self.checkpoint_versions.read();
1245 let raw_replay =
1246 self.snapshot_manager.get().is_none() && self.pending_vault_versions.read().is_empty();
1247 for (name, manager) in collections.iter() {
1248 let mut reusable = None;
1249 if raw_replay {
1250 if let (Some(previous), Some(tree)) =
1251 (previous_versions.get(name), indices.get(name))
1252 {
1253 let mut current = CheckpointVersion {
1254 manager: Arc::downgrade(manager),
1255 segments: manager.checkpoint_revisions(),
1256 visibility_revision: 0,
1257 untracked_visibility_revision: 0,
1258 excluded_xids: Arc::default(),
1259 pending_vault: Arc::default(),
1260 format_version: self.format_version(),
1261 deferred_rows: Some(Arc::default()),
1262 has_unprojected_rows: false,
1263 };
1264 if previous.manager.ptr_eq(¤t.manager)
1265 && previous.format_version == current.format_version
1266 {
1267 if previous.segments == current.segments
1268 && !previous.has_unprojected_rows
1269 && checkpoint_visibility_matches(previous, ¤t)
1270 {
1271 reusable = Some(Arc::clone(tree));
1272 } else {
1273 reusable = self.sparse_checkpoint_tree(
1279 name,
1280 manager,
1281 tree,
1282 previous,
1283 &mut current,
1284 )?;
1285 }
1286 }
1287 }
1288 }
1289 let tree = match reusable {
1290 Some(tree) => tree,
1291 None => {
1292 self.checkpoint_tree(pager, manager, indices.get(name), |entity, metadata| {
1293 #[cfg(test)]
1294 REPLAY_SERIALIZED_ROWS.with(|count| count.set(count.get() + 1));
1295 Some(Self::serialize_entity_record(
1296 entity,
1297 metadata.as_ref(),
1298 self.format_version(),
1299 ))
1300 })?
1301 }
1302 };
1303 if indices
1304 .get(name)
1305 .is_some_and(|previous| Arc::ptr_eq(previous, &tree))
1306 {
1307 continue;
1308 }
1309 if let Some(previous) = indices.insert(name.clone(), tree) {
1310 self.retire_btree(previous);
1311 }
1312 self.mark_paged_registry_dirty();
1313 #[cfg(test)]
1314 if std::env::var_os("REDDB_EXPERIMENTAL_EXIT_DURING_REPLAY_REBUILD").is_some() {
1315 if std::env::var_os("REDDB_EXPERIMENTAL_REPLAY_NO_SYNC").is_none() {
1316 pager.sync().map_err(|error| {
1317 StoreError::Io(std::io::Error::other(error.to_string()))
1318 })?;
1319 }
1320 eprintln!("experimental replay rebuild exit before manifest");
1321 std::process::exit(182);
1322 }
1323 }
1324 drop(previous_versions);
1325 drop(indices);
1326 drop(collections);
1327 self.flush_paged_state()?;
1328 #[cfg(test)]
1329 if std::env::var_os("REDDB_EXPERIMENTAL_EXIT_AFTER_REPLAY_PUBLICATION").is_some() {
1330 eprintln!("experimental replay exit after manifest");
1331 std::process::exit(182);
1332 }
1333 if self.snapshot_manager.get().is_none() && self.pending_vault_versions.read().is_empty() {
1336 let collections = self.resident.collections.read();
1337 let mut versions = self.checkpoint_versions.write();
1338 for (name, manager) in collections.iter() {
1339 versions.insert(
1340 name.clone(),
1341 CheckpointVersion {
1342 manager: Arc::downgrade(manager),
1343 segments: manager.checkpoint_revisions(),
1344 visibility_revision: 0,
1345 untracked_visibility_revision: 0,
1346 excluded_xids: Arc::default(),
1347 pending_vault: Arc::default(),
1348 format_version: self.format_version(),
1349 deferred_rows: Some(Arc::default()),
1350 has_unprojected_rows: false,
1351 },
1352 );
1353 }
1354 }
1355 Ok(())
1356 }
1357
1358 pub(crate) fn recover_operational_manifest(&self) -> Result<(), StoreError> {
1359 let Some(path) = &self.db_path else {
1360 return Ok(());
1361 };
1362 let mut collections = self.list_collections();
1363 collections.sort();
1364 let pending_drops =
1365 crate::storage::operational_manifest::OperationalManifest::for_db_path(path)
1366 .recover_or_bootstrap(&collections)
1367 .map_err(|err| storage_integrity("manifest", "current", None, err.to_string()))?;
1368 for name in pending_drops {
1369 if self.get_collection(&name).is_some() {
1370 self.drop_collection(&name)?;
1371 }
1372 }
1373 Ok(())
1374 }
1375
1376 fn migrate_operational_manifest(
1377 &self,
1378 collisions: &[SystemCollectionCollision],
1379 ) -> Result<(), StoreError> {
1380 let Some(path) = &self.db_path else {
1381 return Ok(());
1382 };
1383 let manifest = crate::storage::operational_manifest::OperationalManifest::for_db_path(path);
1384 let collision_refs = collisions
1385 .iter()
1386 .map(|collision| {
1387 (
1388 collision.survivor.as_str(),
1389 collision.loser.as_str(),
1390 collision.canonical.as_str(),
1391 )
1392 })
1393 .collect::<Vec<_>>();
1394 manifest
1395 .reconcile_collection_collisions(&collision_refs)
1396 .map_err(|err| storage_integrity("manifest", "current", None, err.to_string()))?;
1397 manifest
1398 .rename_collections(reddb_engine::storage::system_collection_names::LEGACY_NAMES)
1399 .map_err(|err| storage_integrity("manifest", "current", None, err.to_string()))
1400 }
1401
1402 pub(crate) fn prepare_operational_collection_create(
1403 &self,
1404 name: &str,
1405 ) -> Result<Option<reddb_file::PreparedCollectionCreate<reddb_file::StdVfs>>, StoreError> {
1406 let Some(path) = &self.db_path else {
1407 return Ok(None);
1408 };
1409 crate::storage::operational_manifest::OperationalManifest::for_db_path(path)
1410 .prepare_collection_create(name)
1411 .map(Some)
1412 .map_err(StoreError::Io)
1413 }
1414
1415 pub(crate) fn prepare_operational_collection_drop(
1416 &self,
1417 name: &str,
1418 ) -> Result<Option<reddb_file::PreparedCollectionDrop<reddb_file::StdVfs>>, StoreError> {
1419 let Some(path) = &self.db_path else {
1420 return Ok(None);
1421 };
1422 crate::storage::operational_manifest::OperationalManifest::for_db_path(path)
1423 .prepare_collection_drop(name)
1424 .map(Some)
1425 .map_err(StoreError::Io)
1426 }
1427
1428 pub(super) fn published_ownership_epoch(&self) -> Result<u64, StoreError> {
1430 let Some(pager) = &self.pager else {
1431 return Ok(0);
1432 };
1433 let Some(content) = read_meta_payload(pager)? else {
1434 return Ok(0);
1435 };
1436 reddb_file::native_store::decode_native_paged_catalog_ownership_epoch(&content)
1437 .map(|epoch| epoch.unwrap_or(0))
1438 .map_err(|error| StoreError::Serialization(error.to_string()))
1439 }
1440
1441 fn load_from_pages(&self) -> Result<CatalogLoadOutcome, StoreError> {
1443 let pager = match &self.pager {
1444 Some(p) => p,
1445 None => return Ok(CatalogLoadOutcome::default()), };
1447
1448 let page_count = pager.page_count().map_err(|e| {
1450 StoreError::Io(std::io::Error::other(format!(
1451 "failed to read page count: {}",
1452 e
1453 )))
1454 })?;
1455 if page_count <= 1 {
1456 return Ok(CatalogLoadOutcome::default());
1458 }
1459
1460 if let Some(content_vec) = read_meta_payload(pager)? {
1465 let content: &[u8] = &content_vec;
1466 let file_version = pager
1467 .header()
1468 .map_err(|error| StoreError::Io(std::io::Error::other(error.to_string())))?
1469 .version;
1470 let prepared =
1471 file_version >= reddb_file::file_format::PAGE_DISK_RESIDENCY_FILE_VERSION;
1472 let resume = if prepared {
1473 reddb_file::native_resume::decode_catalog_resume(content)
1474 .map_err(|error| StoreError::Serialization(error.to_string()))?
1475 } else {
1476 None
1477 };
1478 let mut outcome = CatalogLoadOutcome::default();
1479 let mut ignored_collections = std::collections::HashSet::new();
1480 if let Some(resume) = &resume {
1481 for &(legacy, canonical) in
1482 reddb_engine::storage::system_collection_names::LEGACY_NAMES
1483 {
1484 let (Some(legacy_state), Some(canonical_state)) = (
1485 resume.collections.get(legacy),
1486 resume.collections.get(canonical),
1487 ) else {
1488 continue;
1489 };
1490 let merged_resume = merge_shared_alias_resume(legacy_state, canonical_state);
1491 let shared_physical_state = merged_resume.is_some();
1492 let resume_counter_drift = legacy_state != canonical_state;
1493 let (survivor, loser) = match (
1494 legacy_state.entities == 0,
1495 canonical_state.entities == 0,
1496 ) {
1497 (false, true) => (legacy, canonical),
1498 (true, false) | (true, true) => (canonical, legacy),
1499 (false, false) if shared_physical_state => (canonical, legacy),
1500 (false, false) => {
1501 let (
1502 data_root_match,
1503 key_index_root_match,
1504 secondary_index_state_match,
1505 ) = shared_alias_resume_matches(legacy_state, canonical_state);
1506 return Err(page_integrity(
1507 1,
1508 None,
1509 format!(
1510 "catalog contains both populated legacy collection '{legacy}' and canonical collection '{canonical}' (data_root_match={data_root_match}, key_index_root_match={key_index_root_match}, secondary_index_state_match={secondary_index_state_match})"
1511 ),
1512 ));
1513 }
1514 };
1515 ignored_collections.insert(loser.to_string());
1516 outcome.collisions.push(SystemCollectionCollision {
1517 survivor: survivor.to_string(),
1518 loser: loser.to_string(),
1519 canonical: canonical.to_string(),
1520 shared_physical_state,
1521 resume_counter_drift,
1522 merged_resume,
1523 });
1524 }
1525 let live_roots = resume
1526 .collections
1527 .iter()
1528 .filter(|(name, _)| !ignored_collections.contains(name.as_str()))
1529 .flat_map(|(_, state)| {
1530 std::iter::once(state.root_page)
1531 .chain(state.key_index_root)
1532 .chain(
1533 state
1534 .secondary_indices
1535 .values()
1536 .map(|index| index.root_page),
1537 )
1538 })
1539 .filter(|root| *root != 0)
1540 .collect::<std::collections::HashSet<_>>();
1541 for collision in &outcome.collisions {
1542 if collision.shared_physical_state {
1543 continue;
1544 }
1545 let loser_state = resume
1546 .collections
1547 .get(&collision.loser)
1548 .expect("collision loser is present");
1549 if std::iter::once(loser_state.root_page)
1550 .chain(loser_state.key_index_root)
1551 .chain(
1552 loser_state
1553 .secondary_indices
1554 .values()
1555 .map(|index| index.root_page),
1556 )
1557 .filter(|root| *root != 0)
1558 .any(|root| live_roots.contains(&root))
1559 {
1560 return Err(page_integrity(
1561 1,
1562 None,
1563 format!(
1564 "empty collection '{}' aliases a live collection root",
1565 collision.loser
1566 ),
1567 ));
1568 }
1569 }
1570 reddb_engine::storage::system_collection_names::migration_plan(
1571 resume
1572 .collections
1573 .keys()
1574 .map(String::as_str)
1575 .filter(|name| !ignored_collections.contains(*name)),
1576 )
1577 .map_err(|(legacy, canonical)| {
1578 page_integrity(
1579 1,
1580 None,
1581 format!(
1582 "catalog contains both legacy collection '{legacy}' and canonical collection '{canonical}'"
1583 ),
1584 )
1585 })?;
1586 for state in resume.collections.values() {
1587 if !state.secondary_indices.is_empty()
1588 && file_version < reddb_file::file_format::PAGE_SECONDARY_INDEX_FILE_VERSION
1589 {
1590 return Err(page_integrity(
1591 1,
1592 None,
1593 "secondary roots require the file format fence",
1594 ));
1595 }
1596 for root in std::iter::once(state.root_page)
1597 .chain(state.key_index_root)
1598 .chain(
1599 state
1600 .secondary_indices
1601 .values()
1602 .map(|index| index.root_page),
1603 )
1604 {
1605 if root >= page_count {
1606 return Err(page_integrity(
1607 root,
1608 None,
1609 "published root exceeds the database page count",
1610 ));
1611 }
1612 }
1613 }
1614 self.resident
1615 .next_entity_id
1616 .fetch_max(resume.entity_id_next, Ordering::SeqCst);
1617 }
1618 *self.recovery_xid_summary.write() = resume.as_ref().and_then(|resume| {
1619 resume.xid_high_water_mark.map(|high_water_mark| {
1620 super::recovery_xid::RecoveryXidSummary {
1621 high_water_mark,
1622 roots: resume
1623 .collections
1624 .iter()
1625 .filter(|(name, _)| !ignored_collections.contains(name.as_str()))
1626 .map(|(name, state)| {
1627 (
1628 reddb_engine::storage::system_collection_names::canonical_or_self(name)
1629 .to_owned(),
1630 state.root_page,
1631 )
1632 })
1633 .collect(),
1634 }
1635 })
1636 });
1637 if content.len() >= 4 {
1638 let mut pos = 0;
1639 let mut format_version = STORE_VERSION_V1;
1640
1641 let collection_count = if let Some(header) =
1642 reddb_file::decode_native_paged_metadata_header(content)
1643 .map_err(|err| StoreError::Serialization(err.to_string()))?
1644 {
1645 format_version = header.format_version;
1646 pos += reddb_file::METADATA_HEADER_BYTES;
1647 header.collection_count as usize
1648 } else {
1649 let count = u32::from_le_bytes([
1650 content[pos],
1651 content[pos + 1],
1652 content[pos + 2],
1653 content[pos + 3],
1654 ]) as usize;
1655 pos += 4;
1656 count
1657 };
1658
1659 self.set_format_version(format_version);
1660
1661 if pos > content.len() {
1662 return Ok(CatalogLoadOutcome::default());
1663 }
1664
1665 let mut source_names = std::collections::HashMap::<String, String>::new();
1666 let mut migrated_catalog = !outcome.collisions.is_empty();
1667 let mut empty_duplicate_roots = std::collections::HashSet::new();
1668
1669 for _ in 0..collection_count {
1671 let root = reddb_file::decode_native_paged_collection_root(content, &mut pos)
1672 .map_err(|err| page_integrity(1, None, err.to_string()))?;
1673 let root_page = root.root_page;
1675 let stored_name = root.collection;
1676 if ignored_collections.contains(&stored_name) {
1677 let shared_physical_state = outcome
1678 .collisions
1679 .iter()
1680 .find(|collision| collision.loser == stored_name)
1681 .is_some_and(|collision| collision.shared_physical_state);
1682 if shared_physical_state {
1683 continue;
1684 }
1685 let state = resume
1686 .as_ref()
1687 .and_then(|resume| resume.collections.get(&stored_name))
1688 .expect("ignored collection was proven by catalog resume");
1689 for retired_root in std::iter::once(state.root_page)
1690 .chain(state.key_index_root)
1691 .chain(
1692 state
1693 .secondary_indices
1694 .values()
1695 .map(|index| index.root_page),
1696 )
1697 .filter(|root| *root != 0)
1698 {
1699 empty_duplicate_roots.insert(retired_root);
1700 }
1701 continue;
1702 }
1703 let name = reddb_engine::storage::system_collection_names::canonical_or_self(
1704 &stored_name,
1705 )
1706 .to_owned();
1707 if let Some(previous) = source_names.insert(name.clone(), stored_name.clone()) {
1708 if previous != stored_name {
1709 return Err(page_integrity(
1710 1,
1711 None,
1712 format!(
1713 "catalog contains both legacy collection '{previous}' and canonical collection '{name}'"
1714 ),
1715 ));
1716 }
1717 }
1718 migrated_catalog |= name != stored_name;
1719
1720 let _ = self.create_collection_in_memory(&name);
1724
1725 let shared_alias = outcome.collisions.iter().find(|collision| {
1726 collision.survivor == stored_name && collision.shared_physical_state
1727 });
1728 let counters = shared_alias
1729 .and_then(|collision| collision.merged_resume.as_ref())
1730 .or_else(|| {
1731 resume
1732 .as_ref()
1733 .and_then(|resume| resume.collections.get(&stored_name))
1734 });
1735 if let (Some(counters), Some(manager)) = (counters, self.get_collection(&name))
1736 {
1737 manager.restore_identity_counters(
1738 counters.entity_id_next,
1739 counters.row_id_next,
1740 );
1741 manager.restore_sequence_id_next(counters.sequence_id_next);
1742 }
1743 if root_page > 0 || counters.is_some() {
1745 let btree = BTree::with_root(Arc::clone(pager), root_page);
1746
1747 let mut cursor = btree.cursor_first().map_err(|err| {
1749 page_integrity(root_page, Some(name.clone()), err.to_string())
1750 })?;
1751 let manager = self.get_collection(&name);
1752 let mut persisted_entities = counters.map_or(0, |state| state.entities);
1753 while counters.is_none() {
1754 let next = cursor
1755 .next_with_budget(
1756 self.config
1757 .resident_memory_bytes_max
1758 .and_then(|limit| usize::try_from(limit).ok())
1759 .unwrap_or(usize::MAX),
1760 )
1761 .map_err(|err| {
1762 page_integrity(root_page, Some(name.clone()), err.to_string())
1763 })?;
1764 let Some((key, value)) = next else {
1765 break;
1766 };
1767 persisted_entities += 1;
1768 let key_bytes: [u8; 8] = key.as_slice().try_into().map_err(|_| {
1770 page_integrity(
1771 root_page,
1772 Some(name.clone()),
1773 "physical entity key must contain eight bytes",
1774 )
1775 })?;
1776 let record = reddb_engine::storage::collection_read::EncodedRecord {
1777 id: EntityId::new(u64::from_be_bytes(key_bytes)),
1778 bytes: value,
1779 };
1780 let decoded = if let Some(limit) = self.config.resident_memory_bytes_max
1781 {
1782 record.decode_with_budget(
1783 self.format_version(),
1784 usize::try_from(limit).unwrap_or(usize::MAX),
1785 )
1786 } else {
1787 record.decode(self.format_version())
1788 };
1789 let (entity, metadata) = decoded.map_err(|err| {
1790 page_integrity(root_page, Some(name.clone()), err.to_string())
1791 })?;
1792 if let Some(m) = &manager {
1793 let id = entity.id;
1794 if let EntityKind::TableRow { row_id, .. } = &entity.kind {
1795 m.register_row_id(*row_id);
1796 }
1797 if self.config.resident_memory_bytes_max.is_some() {
1798 self.register_entity_id(id);
1799 m.restore_sequence_id_next(
1800 entity.sequence_id.saturating_add(1),
1801 );
1802 m.restore_identity_counters(
1803 id.raw().saturating_add(1),
1804 m.identity_counters().1,
1805 );
1806 continue;
1807 }
1808 self.resident.context_index.index_entity(&name, &entity);
1809 m.restore_snapshot_entity(entity.clone())?;
1810 if let Some(metadata) = metadata {
1811 let _ = m.set_metadata(id, metadata);
1812 }
1813 self.register_entity_id(id);
1814 if self.config.auto_index_refs {
1815 self.index_cross_refs(&entity, &name)?;
1816 }
1817 }
1818 }
1819
1820 let btree = Arc::new(btree);
1822 if shared_alias.is_some_and(|collision| collision.resume_counter_drift) {
1823 persisted_entities = u64::try_from(btree.count().map_err(|err| {
1824 page_integrity(root_page, Some(name.clone()), err.to_string())
1825 })?)
1826 .map_err(|_| {
1827 page_integrity(
1828 root_page,
1829 Some(name.clone()),
1830 "shared collection entity count exceeds u64",
1831 )
1832 })?;
1833 }
1834 let key_tree = counters
1835 .and_then(|state| state.key_index_root)
1836 .map(|root| Arc::new(BTree::with_root(Arc::clone(pager), root)));
1837 if let Some(counters) = counters {
1838 self.key_indices.write().insert(
1839 name.clone(),
1840 PublishedKeyIndex {
1841 indexed: key_tree.is_some(),
1842 secondary: counters.secondary_indices.iter().map(|(name, index)| {
1843 (name.clone(), super::secondary_index::PublishedSecondaryIndex {
1844 identity: super::secondary_index::SecondaryIndexIdentity {
1845 codec_version: index.codec_version,
1846 definition: index.definition,
1847 },
1848 tree: Arc::new(BTree::with_root(Arc::clone(pager), index.root_page)),
1849 })
1850 }).collect(),
1851 source: Arc::downgrade(&btree),
1852 tree: key_tree.clone().unwrap_or_else(|| {
1853 Arc::new(BTree::with_root(Arc::clone(pager), 0))
1854 }),
1855 },
1856 );
1857 }
1858 if let (Some(manager), Some(limit)) =
1859 (&manager, self.config.resident_memory_bytes_max)
1860 {
1861 manager.install_backing(
1862 Arc::new(
1863 match key_tree {
1864 Some(keys) => reddb_engine::storage::collection_read::PagedCollection::with_key_index(Arc::clone(&btree), keys),
1865 None => reddb_engine::storage::collection_read::PagedCollection::new(Arc::clone(&btree)),
1866 },
1867 ),
1868 btree.root_page_id(),
1869 format_version,
1870 usize::try_from(limit).unwrap_or(usize::MAX),
1871 persisted_entities,
1872 );
1873 }
1874 self.btree_indices.write().insert(name.clone(), btree);
1875 if format_version == STORE_VERSION_V11 {
1876 if let Some(manager) = &manager {
1877 self.checkpoint_versions.write().insert(
1878 name,
1879 CheckpointVersion {
1880 manager: Arc::downgrade(manager),
1881 segments: manager.checkpoint_revisions(),
1882 visibility_revision: 0,
1883 untracked_visibility_revision: 0,
1884 excluded_xids: Arc::default(),
1885 pending_vault: Arc::default(),
1886 format_version,
1887 deferred_rows: Some(Arc::default()),
1888 has_unprojected_rows: false,
1889 },
1890 );
1891 }
1892 }
1893 }
1894 }
1895
1896 if format_version >= STORE_VERSION_V2 && pos + 4 <= content.len() {
1897 let cross_ref_count = u32::from_le_bytes([
1898 content[pos],
1899 content[pos + 1],
1900 content[pos + 2],
1901 content[pos + 3],
1902 ]) as usize;
1903 pos += 4;
1904
1905 for _ in 0..cross_ref_count {
1906 let Ok(cross_ref) =
1907 reddb_file::decode_native_paged_cross_ref(content, &mut pos)
1908 else {
1909 break;
1910 };
1911 let source_id = EntityId::new(cross_ref.source_id);
1912 let target_id = EntityId::new(cross_ref.target_id);
1913 let ref_type = RefType::from_byte(cross_ref.ref_type);
1914 let target_collection =
1915 reddb_engine::storage::system_collection_names::canonical_owned(
1916 cross_ref.target_collection,
1917 );
1918
1919 self.resident
1920 .cross_refs
1921 .write()
1922 .entry(source_id)
1923 .or_default()
1924 .push((target_id, ref_type, target_collection.clone()));
1925
1926 if let Some((collection, mut entity)) = self.get_any(source_id) {
1927 let exists = entity.cross_refs().iter().any(|xref| {
1928 xref.target == target_id
1929 && xref.ref_type == ref_type
1930 && xref.target_collection == target_collection
1931 });
1932 if !exists {
1933 entity.cross_refs_mut().push(CrossRef::new(
1934 source_id,
1935 target_id,
1936 target_collection.clone(),
1937 ref_type,
1938 ));
1939 if let Some(manager) = self.get_collection(&collection) {
1940 let _ = manager.update(entity);
1941 }
1942 }
1943 }
1944 }
1945 }
1946 let retired = reddb_file::decode_native_paged_retired_trees(content, &mut pos)
1947 .map_err(|e| StoreError::Serialization(e.to_string()))?;
1948 let already_retired = retired
1949 .iter()
1950 .copied()
1951 .collect::<std::collections::HashSet<_>>();
1952 let mut live_roots: std::collections::HashSet<_> = self
1953 .btree_indices
1954 .read()
1955 .values()
1956 .map(|tree| tree.root_page_id())
1957 .collect();
1958 live_roots.extend(
1959 self.key_indices
1960 .read()
1961 .values()
1962 .flat_map(PublishedKeyIndex::trees)
1963 .map(|tree| tree.root_page_id()),
1964 );
1965 for root in retired {
1966 if live_roots.contains(&root)
1967 || root
1968 >= pager
1969 .page_count()
1970 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?
1971 {
1972 return Err(page_integrity(
1973 root,
1974 None,
1975 "retired root aliases a live or missing page",
1976 ));
1977 }
1978 self.retired_btrees.lock().push(RetiredBTree {
1979 tree: Arc::new(BTree::with_root(Arc::clone(pager), root)),
1980 published: true,
1981 });
1982 }
1983 for root in empty_duplicate_roots
1984 .iter()
1985 .copied()
1986 .filter(|root| !already_retired.contains(root))
1987 {
1988 self.retire_btree(Arc::new(BTree::with_root(Arc::clone(pager), root)));
1989 }
1990 let deferred = reddb_file::decode_native_paged_deferred_pages(content, &mut pos)
1991 .map_err(|e| StoreError::Serialization(e.to_string()))?;
1992 if deferred
1993 .iter()
1994 .any(|id| live_roots.contains(id) || empty_duplicate_roots.contains(id))
1995 {
1996 return Err(page_integrity(1, None, "deferred page aliases a live root"));
1997 }
1998 pager
1999 .restore_deferred_reclamation(&deferred)
2000 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
2001 let ownership_epoch =
2002 reddb_file::native_store::decode_native_paged_ownership_epoch(
2003 content, &mut pos,
2004 )
2005 .map_err(|e| StoreError::Serialization(e.to_string()))?;
2006 self.ownership_catalog_epoch
2007 .store(ownership_epoch.unwrap_or(0), Ordering::Release);
2008 if migrated_catalog {
2009 self.mark_paged_registry_dirty();
2010 }
2011 if self.format_version() < STORE_VERSION_V11 {
2012 self.set_format_version(STORE_VERSION_V11);
2013 }
2014 outcome.migrated = migrated_catalog;
2015 return Ok(outcome);
2016 }
2017 }
2018
2019 if self.format_version() < STORE_VERSION_V11 {
2020 self.set_format_version(STORE_VERSION_V11);
2021 }
2022
2023 Ok(CatalogLoadOutcome::default())
2024 }
2025
2026 pub(crate) fn deserialize_entity(
2028 data: &[u8],
2029 format_version: u32,
2030 ) -> Result<UnifiedEntity, StoreError> {
2031 let mut pos = 0;
2032 Self::read_entity_binary(data, &mut pos, format_version)
2033 .map_err(|e| StoreError::Serialization(e.to_string()))
2034 }
2035
2036 pub(crate) fn serialize_entity(entity: &UnifiedEntity, format_version: u32) -> Vec<u8> {
2038 let mut buf = Vec::with_capacity(256);
2043 Self::write_entity_binary(&mut buf, entity, format_version);
2044 buf
2045 }
2046
2047 pub(crate) fn serialize_entity_record(
2048 entity: &UnifiedEntity,
2049 metadata: Option<&Metadata>,
2050 format_version: u32,
2051 ) -> Vec<u8> {
2052 reddb_engine::storage::metadata_codec::serialize_entity_record(
2053 entity,
2054 metadata,
2055 format_version,
2056 )
2057 }
2058
2059 pub(crate) fn deserialize_entity_record(
2060 data: &[u8],
2061 format_version: u32,
2062 ) -> Result<(UnifiedEntity, Option<Metadata>), StoreError> {
2063 reddb_engine::storage::metadata_codec::deserialize_entity_record(data, format_version)
2064 .map_err(StoreError::Serialization)
2065 }
2066
2067 pub fn persist(&self) -> Result<(), StoreError> {
2072 let _vault_guard = self.vault_publication_lock.lock();
2073 let pending_vault_versions = self.pending_vault_versions.read();
2074 let pager = match &self.pager {
2075 Some(p) => p,
2076 None => {
2077 if let Some(path) = &self.db_path {
2079 return self
2080 .save_to_file(path)
2081 .map_err(|e| StoreError::Serialization(e.to_string()));
2082 }
2083 return Err(StoreError::Io(std::io::Error::other(
2084 "No pager or path configured for persistence",
2085 )));
2086 }
2087 };
2088 let _ownership_guard = pager.lock_ownership_mutations();
2091
2092 match pager.read_page(1) {
2093 Ok(_) => {}
2094 Err(PagerError::PageNotFound(_)) => {
2095 let meta_page = pager
2096 .allocate_page(crate::storage::engine::PageType::Header)
2097 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
2098 pager
2099 .write_page(meta_page.page_id(), meta_page)
2100 .map_err(|e| StoreError::Io(std::io::Error::other(e.to_string())))?;
2101 }
2102 Err(e) => {
2103 return Err(StoreError::Io(std::io::Error::other(e.to_string())));
2104 }
2105 }
2106
2107 if let Some(commit) = &self.commit {
2108 commit.force_sync().map_err(StoreError::Io)?;
2109 }
2110
2111 struct InterruptedOwnership<'a> {
2112 pager: &'a Pager,
2113 active: bool,
2114 }
2115 impl Drop for InterruptedOwnership<'_> {
2116 fn drop(&mut self) {
2117 if self.active {
2118 self.pager.fence_interrupted_ownership();
2119 }
2120 }
2121 }
2122 let mut ownership = InterruptedOwnership {
2123 pager,
2124 active: self.commit.is_some(),
2125 };
2126 let epoch = if let Some(commit) = &self.commit {
2127 let epoch = commit
2128 .next_page_ownership_epoch(self)
2129 .map_err(StoreError::Io)?;
2130 commit
2131 .begin_page_ownership_epoch(self, epoch)
2132 .map_err(StoreError::Io)?;
2133 Some(epoch)
2134 } else {
2135 None
2136 };
2137
2138 let collections = self.resident.collections.read();
2139 let mut btree_indices = self.btree_indices.write();
2140
2141 let mut collection_roots: Vec<(String, u32)> = Vec::new();
2143
2144 let mut rebuilt_indices = HashMap::with_capacity(collections.len());
2147 let previous_versions = self.checkpoint_versions.read();
2148 let mut checkpoint_versions = HashMap::with_capacity(collections.len());
2149 let pending_vault = Arc::new(pending_vault_versions.clone());
2150 let (visibility_revision, excluded, untracked_visibility_revision) =
2151 self.snapshot_manager.get().map_or_else(
2152 || (0, Default::default(), 0),
2153 |manager| manager.checkpoint_projection_state(),
2154 );
2155 let excluded = Arc::new(excluded);
2156 for (name, manager) in collections.iter() {
2157 let mut version = CheckpointVersion {
2158 manager: Arc::downgrade(manager),
2159 segments: manager.checkpoint_revisions(),
2160 visibility_revision,
2161 untracked_visibility_revision,
2162 excluded_xids: Arc::clone(&excluded),
2163 pending_vault: Arc::clone(&pending_vault),
2164 format_version: self.format_version(),
2165 deferred_rows: Some(Arc::default()),
2166 has_unprojected_rows: false,
2167 };
2168 if let (Some(previous), Some(tree)) =
2169 (previous_versions.get(name), btree_indices.get(name))
2170 {
2171 if previous.manager.ptr_eq(&version.manager)
2172 && previous.segments == version.segments
2173 && previous.format_version == version.format_version
2174 && !previous.has_unprojected_rows
2175 && checkpoint_visibility_matches(previous, &version)
2176 {
2177 version.deferred_rows = previous.deferred_rows.clone();
2178 collection_roots.push((name.clone(), tree.root_page_id()));
2179 rebuilt_indices.insert(name.clone(), Arc::clone(tree));
2180 checkpoint_versions.insert(name.clone(), version);
2181 continue;
2182 }
2183 }
2184 if let (Some(previous), Some(tree)) =
2185 (previous_versions.get(name), btree_indices.get(name))
2186 {
2187 if previous.manager.ptr_eq(&version.manager)
2188 && previous.format_version == version.format_version
2189 {
2190 if let Some(tree) =
2191 self.sparse_checkpoint_tree(name, manager, tree, previous, &mut version)?
2192 {
2193 collection_roots.push((name.clone(), tree.root_page_id()));
2194 rebuilt_indices.insert(name.clone(), tree);
2195 checkpoint_versions.insert(name.clone(), version);
2196 continue;
2197 }
2198 }
2199 }
2200 let btree = self.checkpoint_tree(
2201 pager,
2202 manager,
2203 btree_indices.get(name),
2204 |entity, metadata| {
2205 #[cfg(test)]
2206 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(count.get() + 1));
2207 let hidden = pending_vault_versions.contains(&entity.id)
2208 || (matches!(
2209 entity.data,
2210 EntityData::Row(_)
2211 | EntityData::Vector(_)
2212 | EntityData::QueueMessage(_)
2213 ) && excluded.contains(&entity.xmin));
2214 let normalize_xmax = matches!(
2215 entity.data,
2216 EntityData::Row(_) | EntityData::QueueMessage(_)
2217 ) && excluded.contains(&entity.xmax);
2218 if hidden || normalize_xmax {
2219 version.remember_deferred_row(entity.id);
2220 }
2221 if hidden {
2222 return None;
2223 }
2224 let mut normalized = std::borrow::Cow::Borrowed(entity);
2225 if normalize_xmax {
2226 normalized.to_mut().xmax = 0;
2227 }
2228 Some(Self::serialize_entity_record(
2229 &normalized,
2230 metadata.as_ref(),
2231 self.format_version(),
2232 ))
2233 },
2234 )?;
2235 checkpoint_versions.insert(name.clone(), version);
2236
2237 collection_roots.push((name.clone(), btree.root_page_id()));
2238 rebuilt_indices.insert(name.clone(), btree);
2239 }
2240
2241 let mut meta_data = Vec::with_capacity(4096);
2243
2244 let format_version = STORE_VERSION_V11;
2245 self.set_format_version(format_version);
2246
2247 reddb_file::encode_native_paged_metadata_header(
2248 &mut meta_data,
2249 reddb_file::NativePagedMetadataHeader {
2250 format_version,
2251 collection_count: collection_roots.len() as u32,
2252 },
2253 );
2254
2255 for (name, root_page) in &collection_roots {
2257 reddb_file::encode_native_paged_collection_root(&mut meta_data, name, *root_page);
2258 }
2259
2260 let cross_refs = self.resident.cross_refs.read();
2262 let total_refs: usize = cross_refs.values().map(|v| v.len()).sum();
2263 meta_data.extend_from_slice(&(total_refs as u32).to_le_bytes());
2264 for (source_id, refs) in cross_refs.iter() {
2265 for (target_id, ref_type, collection) in refs {
2266 reddb_file::encode_native_paged_cross_ref(
2267 &mut meta_data,
2268 source_id.raw(),
2269 target_id.raw(),
2270 ref_type.to_byte(),
2271 collection,
2272 );
2273 }
2274 }
2275
2276 for (name, previous) in btree_indices.iter() {
2277 if !rebuilt_indices
2278 .get(name)
2279 .is_some_and(|tree| Arc::ptr_eq(tree, previous))
2280 {
2281 self.retire_btree(Arc::clone(previous));
2282 }
2283 }
2284 #[cfg(test)]
2285 if std::env::var_os("REDDB_EXPERIMENTAL_EXIT_DURING_CHECKPOINT_REBUILD").is_some() {
2286 pager
2287 .sync()
2288 .map_err(|error| StoreError::Io(std::io::Error::other(error.to_string())))?;
2289 eprintln!("experimental checkpoint exit before manifest");
2290 std::process::exit(183);
2291 }
2292 let rebuilt_keys = self.checkpoint_key_indices(pager, &rebuilt_indices)?;
2293 #[cfg(test)]
2294 if std::env::var_os("REDDB_TEST_EXIT_AFTER_SECONDARY_INDEX_BUILD").is_some() {
2295 pager
2296 .sync()
2297 .map_err(|error| StoreError::Io(std::io::Error::other(error.to_string())))?;
2298 std::process::exit(196);
2299 }
2300 self.publish_reclaimable_trees(pager, &mut meta_data, &rebuilt_indices, &rebuilt_keys)?;
2301
2302 #[cfg(test)]
2303 if std::env::var_os("REDDB_TEST_EXIT_AFTER_UNDO_CATALOG_PUBLICATION").is_some() {
2304 std::process::exit(195);
2305 }
2306
2307 *btree_indices = rebuilt_indices;
2310 *self.key_indices.write() = rebuilt_keys;
2311 drop(previous_versions);
2312 *self.checkpoint_versions.write() = checkpoint_versions;
2313
2314 if let Some(commit) = &self.commit {
2315 commit
2316 .finish_page_ownership_epoch(self, epoch.expect("WAL ownership epoch"))
2317 .map_err(StoreError::Io)?;
2318 ownership.active = false;
2319 commit.truncate().map_err(StoreError::Io)?;
2320 }
2321 *self.checkpoint_durable_rows.write() = Default::default();
2322
2323 if let Some(limit) = self.config.resident_memory_bytes_max {
2324 let mut versions = self.checkpoint_versions.write();
2325 for (name, manager) in collections.iter() {
2326 if versions
2327 .get(name)
2328 .is_some_and(|version| !version.has_unprojected_rows)
2329 {
2330 if let Some(tree) = btree_indices.get(name) {
2331 manager.install_backing(
2332 Arc::new(
2333 {
2334 let keys = self.key_indices.read();
2335 let index = keys.get(name).expect("invariant: prepared checkpoint classifies its key index");
2336 if index.indexed {
2337 reddb_engine::storage::collection_read::PagedCollection::with_key_index(Arc::clone(tree), Arc::clone(&index.tree))
2338 } else {
2339 reddb_engine::storage::collection_read::PagedCollection::new(Arc::clone(tree))
2340 }
2341 },
2342 ),
2343 tree.root_page_id(),
2344 self.format_version(),
2345 usize::try_from(limit).unwrap_or(usize::MAX),
2346 manager.count() as u64,
2347 );
2348 if let Some(version) = versions.get_mut(name) {
2349 version.segments = manager.checkpoint_revisions();
2350 }
2351 }
2352 }
2353 }
2354 }
2355
2356 Ok(())
2357 }
2358
2359 pub fn is_paged(&self) -> bool {
2361 self.pager.is_some()
2362 }
2363
2364 pub(crate) fn collection_root_page(&self, collection: &str) -> Option<u32> {
2367 self.btree_indices
2368 .read()
2369 .get(Self::canonical_collection(collection))
2370 .map(|btree| btree.root_page_id())
2371 .filter(|root| *root != 0)
2372 }
2373
2374 pub fn db_path(&self) -> Option<&Path> {
2376 self.db_path.as_deref()
2377 }
2378}
2379
2380#[cfg(test)]
2381mod checkpoint_work_tests {
2382 use super::*;
2383
2384 struct SystemNameProjection;
2385
2386 impl super::super::secondary_index::SecondaryIndexProjector for SystemNameProjection {
2387 fn project(
2388 &self,
2389 entity: &UnifiedEntity,
2390 key: &mut [u8; super::super::secondary_index::SECONDARY_KEY_BYTES_MAX],
2391 ) -> Result<Option<usize>, StoreError> {
2392 key[..8].copy_from_slice(&entity.id.raw().to_be_bytes());
2393 Ok(Some(8))
2394 }
2395 }
2396
2397 #[cfg(target_os = "linux")]
2398 #[test]
2399 fn interrupted_inline_sparse_checkpoint_replays_durable_rows() {
2400 const CHILD: &str = "REDDB_TEST_INLINE_SPARSE_PATH";
2401 if let Some(path) = std::env::var_os(CHILD) {
2402 let insert = std::env::var_os("REDDB_TEST_INLINE_SPARSE_INSERT").is_some();
2403 let multi = std::env::var_os("REDDB_TEST_INLINE_SPARSE_MULTI").is_some();
2404 let store = UnifiedStore::open(path).expect("open store");
2405 let initial_count = if multi { 600 } else { 1 };
2406 for id in 1..=initial_count {
2407 store.insert_auto("rows", row(id, 1)).expect("seed");
2408 }
2409 store.persist().expect("baseline");
2410 let manager = store.get_collection("rows").expect("collection");
2411 let ids: Vec<u64> = if multi {
2412 (1..=initial_count).collect()
2413 } else {
2414 vec![if insert { 2 } else { 1 }]
2415 };
2416 let mut actions = Vec::new();
2417 for id in ids {
2418 if insert {
2419 manager.insert(row(id, 9)).expect("insert version");
2420 } else {
2421 manager.update(row(id, 9)).expect("update version");
2422 }
2423 let entity = manager.get(EntityId::new(id)).expect("changed entity");
2424 actions.push(StoreWalAction::upsert_entity(
2425 "rows",
2426 &entity,
2427 None,
2428 store.format_version(),
2429 ));
2430 }
2431 let references = store
2432 .commit
2433 .as_ref()
2434 .expect("coordinator")
2435 .append_checkpoint_actions(&actions)
2436 .expect("durable WAL");
2437 store.remember_checkpoint_rows(actions, references);
2438 store.persist().expect("exit after sparse write");
2439 panic!("inline sparse crash hook was not reached");
2440 }
2441 for (insert, multi) in [(false, false), (true, false), (false, true)] {
2442 let directory = tempfile::tempdir().expect("temporary store");
2443 let path = directory.path().join("data.rdb");
2444 let mut command =
2445 std::process::Command::new(std::env::current_exe().expect("test executable"));
2446 command
2447 .args(["--exact", "storage::unified::store::impl_pages::checkpoint_work_tests::interrupted_inline_sparse_checkpoint_replays_durable_rows", "--nocapture"])
2448 .env(CHILD, &path)
2449 .env("REDDB_TEST_EXIT_AFTER_INLINE_SPARSE_WRITE", "1");
2450 if insert {
2451 command.env("REDDB_TEST_INLINE_SPARSE_INSERT", "1");
2452 }
2453 if multi {
2454 command.env("REDDB_TEST_INLINE_SPARSE_MULTI", "1");
2455 }
2456 let output = command.output().expect("crash child");
2457 assert_eq!(
2458 output.status.code(),
2459 Some(190),
2460 "insert={insert} multi={multi}: {}",
2461 String::from_utf8_lossy(&output.stderr)
2462 );
2463 let recovered = UnifiedStore::open(&path).expect("recover");
2464 let ids: Vec<u64> = if multi {
2465 (1..=600).collect()
2466 } else {
2467 vec![if insert { 2 } else { 1 }]
2468 };
2469 for id in ids {
2470 assert_eq!(
2471 recovered
2472 .get("rows", EntityId::new(id))
2473 .expect("recovered row")
2474 .data
2475 .as_row()
2476 .expect("row")
2477 .columns,
2478 vec![Value::Integer(9)]
2479 );
2480 }
2481 assert_eq!(
2482 recovered.get_collection("rows").expect("rows").count(),
2483 if multi {
2484 600
2485 } else if insert {
2486 2
2487 } else {
2488 1
2489 }
2490 );
2491 }
2492 }
2493
2494 #[test]
2495 fn catalog_ownership_epoch_survives_reopen_and_later_publication() {
2496 let directory = tempfile::tempdir().expect("temporary store");
2497 let path = directory.path().join("data.rdb");
2498 {
2499 let store = UnifiedStore::open(&path).expect("open store");
2500 store.create_collection("rows").expect("create collection");
2501 store.persist().expect("publish ownership epoch");
2502 assert_eq!(store.ownership_catalog_epoch.load(Ordering::Acquire), 1);
2503 store.persist().expect("publish next ownership epoch");
2504 }
2505 let reopened = UnifiedStore::open(&path).expect("reopen store");
2506 assert_eq!(reopened.ownership_catalog_epoch.load(Ordering::Acquire), 2);
2507 }
2508
2509 #[test]
2510 fn metadata_overflow_with_missing_continuation_fails_closed() {
2511 use crate::storage::engine::{Page, PageType, HEADER_SIZE};
2512
2513 let directory = tempfile::tempdir().expect("temporary store");
2514 let store = UnifiedStore::open(directory.path().join("data.rdb")).expect("paged store");
2515 let pager = store.pager.as_ref().unwrap();
2516 let valid_payload = vec![42; META_PAGE_CONTENT_CAP * 3];
2517 let valid_manifest = build_meta_page1_with_overflow(pager, &valid_payload).unwrap();
2518 pager.write_page(1, valid_manifest).unwrap();
2519 assert!(!existing_overflow_chain(pager).unwrap().is_empty());
2520 assert_eq!(read_meta_payload(pager).unwrap().unwrap(), valid_payload);
2521
2522 let missing = pager.page_count().unwrap() + 100;
2523 let mut manifest = Page::new(PageType::Header, 1);
2524 reddb_file::encode_native_metadata_overflow_header(
2525 &mut manifest.as_bytes_mut()[HEADER_SIZE..],
2526 reddb_file::NativeMetadataOverflowHeader {
2527 format_version: STORE_VERSION_V11,
2528 total_payload_bytes: META_PAGE_CONTENT_CAP as u32 + 1,
2529 next_overflow_page_id: missing,
2530 },
2531 )
2532 .unwrap();
2533 pager.write_page(1, manifest).unwrap();
2534
2535 assert!(
2536 existing_overflow_chain(pager).is_err(),
2537 "a missing continuation must not be treated as an empty chain"
2538 );
2539
2540 let wrong_type = pager.allocate_page(PageType::BTreeLeaf).unwrap();
2541 let mut manifest = Page::new(PageType::Header, 1);
2542 reddb_file::encode_native_metadata_overflow_header(
2543 &mut manifest.as_bytes_mut()[HEADER_SIZE..],
2544 reddb_file::NativeMetadataOverflowHeader {
2545 format_version: STORE_VERSION_V11,
2546 total_payload_bytes: META_PAGE_CONTENT_CAP as u32 + 1,
2547 next_overflow_page_id: wrong_type.page_id(),
2548 },
2549 )
2550 .unwrap();
2551 pager.write_page(1, manifest).unwrap();
2552 assert!(
2553 existing_overflow_chain(pager).is_err(),
2554 "a live page must not be mistaken for metadata overflow"
2555 );
2556 assert!(
2557 read_meta_payload(pager).is_err(),
2558 "a live page must not be read as metadata overflow"
2559 );
2560
2561 let mut cycle = pager.allocate_page(PageType::Overflow).unwrap();
2562 let cycle_id = cycle.page_id();
2563 reddb_file::encode_native_metadata_overflow_continuation_header(
2564 &mut cycle.as_bytes_mut()[HEADER_SIZE..],
2565 reddb_file::NativeMetadataOverflowContinuationHeader {
2566 next_overflow_page_id: cycle_id,
2567 chunk_bytes: 1,
2568 },
2569 )
2570 .unwrap();
2571 pager.write_page(cycle_id, cycle).unwrap();
2572 let mut manifest = Page::new(PageType::Header, 1);
2573 reddb_file::encode_native_metadata_overflow_header(
2574 &mut manifest.as_bytes_mut()[HEADER_SIZE..],
2575 reddb_file::NativeMetadataOverflowHeader {
2576 format_version: STORE_VERSION_V11,
2577 total_payload_bytes: META_V3_FIRST_PAYLOAD_CAP as u32 + 3,
2578 next_overflow_page_id: cycle_id,
2579 },
2580 )
2581 .unwrap();
2582 pager.write_page(1, manifest).unwrap();
2583 assert!(
2584 read_meta_payload(pager).is_err(),
2585 "cyclic overflow must not be accepted"
2586 );
2587
2588 let mut manifest = Page::new(PageType::Header, 1);
2589 reddb_file::encode_native_metadata_overflow_header(
2590 &mut manifest.as_bytes_mut()[HEADER_SIZE..],
2591 reddb_file::NativeMetadataOverflowHeader {
2592 format_version: STORE_VERSION_V11,
2593 total_payload_bytes: META_PAGE_CONTENT_CAP as u32 + 1,
2594 next_overflow_page_id: 0,
2595 },
2596 )
2597 .unwrap();
2598 pager.write_page(1, manifest).unwrap();
2599 assert!(
2600 read_meta_payload(pager).is_err(),
2601 "a truncated metadata payload must not be accepted"
2602 );
2603 }
2604
2605 #[test]
2606 fn retired_tree_pages_remain_pinned_by_a_cursor() {
2607 let directory = tempfile::tempdir().expect("temporary store");
2608 let store = UnifiedStore::open(&directory.path().join("data.rdb")).expect("paged store");
2609 for id in 1..=100 {
2610 store.insert_auto("rows", row(id, 1)).expect("seed");
2611 }
2612 store.persist().expect("initial checkpoint");
2613 let tree = store
2614 .btree_indices
2615 .read()
2616 .get("rows")
2617 .cloned()
2618 .expect("tree");
2619 let mut cursor = tree.cursor_first().expect("cursor");
2620 drop(tree);
2621 let manager = store.get_collection("rows").expect("rows");
2622 for value in 2..=6 {
2623 manager.update(row(1, value)).expect("change");
2624 store.persist().expect("checkpoint with old reader");
2625 }
2626 let mut count = 0;
2627 while let Some((_, bytes)) = cursor.next().expect("pinned tree must stay readable") {
2628 let (entity, _) =
2629 UnifiedStore::deserialize_entity_record(&bytes, store.format_version())
2630 .expect("decode");
2631 assert_eq!(
2632 entity.data.as_row().expect("row").columns,
2633 [Value::Integer(1)]
2634 );
2635 count += 1;
2636 }
2637 assert_eq!(count, 100);
2638 drop(cursor);
2639 store.persist().expect("reclaim after reader release");
2640 assert!(store.retired_btrees.lock().is_empty());
2641 }
2642
2643 #[test]
2644 fn checkpoint_payload_buffer_is_bounded_for_a_large_collection() {
2645 let directory = tempfile::tempdir().expect("temporary store");
2646 let store = UnifiedStore::open(&directory.path().join("data.rdb")).expect("paged store");
2647 store.create_collection("rows").expect("collection");
2648 let manager = store.get_collection("rows").expect("rows");
2649 for id in (1..=1200).rev() {
2650 manager
2651 .insert(UnifiedEntity::table_row(
2652 EntityId::new(id),
2653 "rows",
2654 id,
2655 vec![Value::text("x".repeat(4096))],
2656 ))
2657 .expect("seed");
2658 }
2659 CHECKPOINT_BUFFERED_BYTES.with(|peak| peak.set(0));
2660 store.persist().expect("bounded checkpoint");
2661 assert!(CHECKPOINT_BUFFERED_BYTES.with(|peak| peak.get()) <= CHECKPOINT_BATCH_BYTES);
2662 assert!(CHECKPOINT_BUFFERED_BYTES.with(|peak| peak.get()) > 0);
2663 assert_eq!(store.get_collection("rows").expect("rows").count(), 1200);
2664 }
2665
2666 #[test]
2667 fn unchanged_checkpoint_does_not_serialize_collection_rows() {
2668 let directory = tempfile::tempdir().expect("temporary store");
2669 let store = UnifiedStore::open(&directory.path().join("data.rdb")).expect("paged store");
2670 store.create_collection("rows").expect("collection");
2671 for id in 1..=40 {
2672 store
2673 .insert(
2674 "rows",
2675 UnifiedEntity::table_row(
2676 EntityId::new(id),
2677 "rows",
2678 id,
2679 vec![Value::Integer(id as i64)],
2680 ),
2681 )
2682 .expect("seed row");
2683 }
2684 store.persist().expect("initial checkpoint");
2685 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
2686 store.persist().expect("unchanged checkpoint");
2687 assert_eq!(
2688 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()),
2689 0,
2690 "unchanged collections must not hold the writer fence while serializing every row"
2691 );
2692 drop(store);
2693 let reopened = UnifiedStore::open(&directory.path().join("data.rdb")).expect("reopen");
2694 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
2695 reopened.persist().expect("unchanged recovered generation");
2696 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 0);
2697 }
2698
2699 #[test]
2700 fn sparse_wal_replay_does_not_reencode_complete_collections() {
2701 let directory = tempfile::tempdir().expect("temporary store");
2702 let path = directory.path().join("data.rdb");
2703 let store = UnifiedStore::open(&path).expect("paged store");
2704 for (name, first) in [("rows", 1), ("cold", 129)] {
2705 store.create_collection(name).expect("collection");
2706 for id in first..first + 128 {
2707 store
2708 .insert(
2709 name,
2710 UnifiedEntity::table_row(
2711 EntityId::new(id),
2712 name,
2713 id,
2714 vec![Value::text(format!("{id}:{}", "x".repeat(8192)))],
2715 ),
2716 )
2717 .expect("seed");
2718 }
2719 }
2720 store.persist().expect("durable baseline");
2721 let action = super::super::commit::StoreWalAction::upsert_entity(
2722 "rows",
2723 &row(1, 42),
2724 None,
2725 STORE_VERSION_V11,
2726 );
2727 store
2729 .commit
2730 .as_ref()
2731 .unwrap()
2732 .append_actions(&[action])
2733 .unwrap();
2734 drop(store);
2735
2736 REPLAY_SERIALIZED_ROWS.with(|count| count.set(0));
2737 let recovered = UnifiedStore::open(&path).expect("replay committed change");
2738 assert_eq!(
2739 recovered
2740 .get("rows", EntityId::new(1))
2741 .unwrap()
2742 .data
2743 .as_row()
2744 .unwrap()
2745 .columns,
2746 vec![Value::Integer(42)]
2747 );
2748 for name in ["rows", "cold"] {
2749 assert_eq!(recovered.get_collection(name).unwrap().count(), 128);
2750 }
2751 assert_eq!(
2752 REPLAY_SERIALIZED_ROWS.with(|count| count.get()),
2753 0,
2754 "one WAL-backed row must not reencode its whole collection or unrelated cold rows"
2755 );
2756 for (name, first) in [("rows", 2), ("cold", 129)] {
2757 let end = if name == "rows" { 129 } else { 257 };
2758 for id in first..end {
2759 assert_eq!(
2760 recovered
2761 .get(name, EntityId::new(id))
2762 .unwrap()
2763 .data
2764 .as_row()
2765 .unwrap()
2766 .columns,
2767 vec![Value::text(format!("{id}:{}", "x".repeat(8192)))],
2768 );
2769 }
2770 }
2771
2772 drop(recovered);
2773 let reopened = UnifiedStore::open(&path).expect("durable sparse replay");
2774 assert_eq!(
2775 reopened
2776 .get("rows", EntityId::new(1))
2777 .unwrap()
2778 .data
2779 .as_row()
2780 .unwrap()
2781 .columns,
2782 vec![Value::Integer(42)]
2783 );
2784 }
2785
2786 fn replay_test_payload(bytes: usize) -> String {
2787 let mut state = 0x1234_5678_u32;
2788 (0..bytes)
2789 .map(|_| {
2790 state ^= state << 13;
2791 state ^= state >> 17;
2792 state ^= state << 5;
2793 char::from(b'!' + (state % 90) as u8)
2794 })
2795 .collect()
2796 }
2797
2798 #[test]
2799 fn wal_replay_with_exhausted_row_proof_keeps_full_validation() {
2800 let directory = tempfile::tempdir().unwrap();
2801 let path = directory.path().join("data.rdb");
2802 let config = || UnifiedStoreConfig::default().with_page_cache_slots(4);
2803 let store = UnifiedStore::open_with_config(&path, config()).unwrap();
2804 for id in 1..=16 {
2805 store.insert_auto("rows", row(id, 1)).unwrap();
2806 }
2807 store.persist().unwrap();
2808 let payload = replay_test_payload(64 * 1024);
2810 let changed =
2811 UnifiedEntity::table_row(EntityId::new(1), "rows", 1, vec![Value::text(payload)]);
2812 let action = StoreWalAction::upsert_entity("rows", &changed, None, store.format_version());
2813 store
2814 .commit
2815 .as_ref()
2816 .unwrap()
2817 .append_actions(&[action])
2818 .unwrap();
2819 drop(store);
2820 REPLAY_SERIALIZED_ROWS.with(|count| count.set(0));
2821 let recovered = UnifiedStore::open_with_config(&path, config()).unwrap();
2822 assert!(REPLAY_SERIALIZED_ROWS.with(|count| count.get()) >= 16);
2823 assert_eq!(
2824 recovered
2825 .get("rows", EntityId::new(1))
2826 .unwrap()
2827 .data
2828 .as_row()
2829 .unwrap()
2830 .columns,
2831 changed.data.as_row().unwrap().columns
2832 );
2833 drop(recovered);
2834 let reopened = UnifiedStore::open_with_config(&path, config()).unwrap();
2835 assert_eq!(reopened.get_collection("rows").unwrap().count(), 16);
2836 assert_eq!(
2837 reopened
2838 .get("rows", EntityId::new(1))
2839 .unwrap()
2840 .data
2841 .as_row()
2842 .unwrap()
2843 .columns,
2844 changed.data.as_row().unwrap().columns
2845 );
2846 }
2847
2848 #[cfg(target_os = "linux")]
2849 #[test]
2850 fn interrupted_sparse_replay_preserves_rows_and_bounds_growth() {
2851 const CHILD: &str = "REDDB_TEST_SPARSE_REPLAY_PATH";
2852 if let Some(path) = std::env::var_os(CHILD) {
2853 let _store = UnifiedStore::open(path).unwrap();
2854 panic!("replay crash hook was not reached");
2855 }
2856 for overflow in [false, true] {
2857 for (hook, code) in [
2858 ("REDDB_TEST_EXIT_AFTER_SPARSE_BATCH", 193),
2859 ("REDDB_EXPERIMENTAL_EXIT_AFTER_REPLAY_PUBLICATION", 182),
2860 ] {
2861 let directory = tempfile::tempdir().unwrap();
2862 let path = directory.path().join("data.rdb");
2863 let store = UnifiedStore::open(&path).unwrap();
2864 for id in 1..=128 {
2865 store.insert_auto("rows", row(id, 1)).unwrap();
2866 }
2867 store.persist().unwrap();
2868 let changed = if overflow {
2869 UnifiedEntity::table_row(
2870 EntityId::new(1),
2871 "rows",
2872 1,
2873 vec![Value::text(replay_test_payload(16 * 1024))],
2874 )
2875 } else {
2876 row(1, 42)
2877 };
2878 let action =
2879 StoreWalAction::upsert_entity("rows", &changed, None, store.format_version());
2880 store
2881 .commit
2882 .as_ref()
2883 .unwrap()
2884 .append_actions(&[action])
2885 .unwrap();
2886 drop(store);
2887 let mut first_size = 0;
2888 for cycle in 0..12 {
2889 let output = std::process::Command::new(std::env::current_exe().unwrap())
2890 .args(["--exact", "storage::unified::store::impl_pages::checkpoint_work_tests::interrupted_sparse_replay_preserves_rows_and_bounds_growth", "--nocapture"])
2891 .env(CHILD, &path).env(hook, "1").output().unwrap();
2892 assert_eq!(
2893 output.status.code(),
2894 Some(code),
2895 "overflow={overflow} hook={hook} cycle={cycle}: {}",
2896 String::from_utf8_lossy(&output.stderr)
2897 );
2898 let size = std::fs::metadata(&path).unwrap().len();
2899 if cycle == 0 {
2900 first_size = size;
2901 }
2902 assert!(
2903 size <= first_size + 2 * crate::storage::engine::PAGE_SIZE as u64,
2904 "repeated recovery must reuse reservations: {first_size} -> {size}"
2905 );
2906 }
2907 for _ in 0..2 {
2908 let recovered = UnifiedStore::open(&path).unwrap();
2909 assert_eq!(recovered.get_collection("rows").unwrap().count(), 128);
2910 for id in 1..=128 {
2911 let expected = if id == 1 { changed.clone() } else { row(id, 1) };
2912 assert_eq!(
2913 recovered
2914 .get("rows", EntityId::new(id))
2915 .unwrap()
2916 .data
2917 .as_row()
2918 .unwrap()
2919 .columns,
2920 expected.data.as_row().unwrap().columns
2921 );
2922 }
2923 }
2924 }
2925 }
2926 }
2927
2928 #[test]
2929 fn paged_reopen_preserves_stored_sequence_identity() {
2930 let directory = tempfile::tempdir().expect("temporary store");
2931 let path = directory.path().join("data.rdb");
2932 let store = UnifiedStore::open(&path).expect("paged store");
2933 store.create_collection("rows").expect("collection");
2934 for id in [30, 10, 20] {
2935 store.insert("rows", row(id, id as i64)).expect("insert");
2936 }
2937 store.persist().expect("checkpoint");
2938 let sequences = [10, 20, 30].map(|id| {
2939 store
2940 .get("rows", EntityId::new(id))
2941 .expect("row")
2942 .sequence_id
2943 });
2944 drop(store);
2945 let reopened = UnifiedStore::open(&path).expect("reopen");
2946 let recovered = [10, 20, 30].map(|id| {
2947 reopened
2948 .get("rows", EntityId::new(id))
2949 .expect("row")
2950 .sequence_id
2951 });
2952 assert_eq!(
2953 recovered, sequences,
2954 "opening a checkpoint must not rewrite stored row identities"
2955 );
2956 }
2957
2958 #[test]
2959 fn auto_insert_persists_the_assigned_sequence_identity() {
2960 let directory = tempfile::tempdir().expect("temporary store");
2961 let store = UnifiedStore::open(&directory.path().join("data.rdb")).expect("paged store");
2962 for id in 1u64..=3 {
2963 store
2964 .insert_auto("rows", row(id, id as i64))
2965 .expect("insert");
2966 }
2967 let manager = store.get_collection("rows").expect("rows");
2968 let tree = store
2969 .btree_indices
2970 .read()
2971 .get("rows")
2972 .cloned()
2973 .expect("tree");
2974 for id in 1u64..=3 {
2975 let bytes = tree
2976 .get(&id.to_be_bytes())
2977 .expect("lookup")
2978 .expect("stored row");
2979 let (persisted, _) =
2980 UnifiedStore::deserialize_entity_record(&bytes, store.format_version())
2981 .expect("decode");
2982 assert_eq!(
2983 persisted.sequence_id,
2984 manager
2985 .get(EntityId::new(id))
2986 .expect("live row")
2987 .sequence_id
2988 );
2989 }
2990 }
2991
2992 #[test]
2993 fn completed_inline_insert_reuses_history_but_not_untracked_edits() {
2994 let directory = tempfile::tempdir().expect("temporary store");
2995 let path = directory.path().join("data.rdb");
2996 let store = UnifiedStore::open(&path).expect("paged store");
2997 store.insert_auto("rows", row(1, 1)).expect("seed");
2998 store.persist().expect("checkpoint");
2999 store.insert_auto("rows", row(2, 2)).expect("append");
3000 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3001 store.persist().expect("inline append checkpoint");
3002 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 0);
3003 store
3004 .get_collection("rows")
3005 .expect("rows")
3006 .update(row(1, 99))
3007 .expect("untracked edit");
3008 store.insert_auto("rows", row(3, 3)).expect("next append");
3009 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3010 store.persist().expect("untracked edit checkpoint");
3011 assert!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()) > 0);
3012 drop(store);
3013 let reopened = UnifiedStore::open(&path).expect("reopen");
3014 assert_eq!(
3015 reopened
3016 .get("rows", EntityId::new(1))
3017 .expect("row")
3018 .data
3019 .as_row()
3020 .expect("table")
3021 .columns,
3022 vec![Value::Integer(99)]
3023 );
3024 }
3025
3026 #[test]
3027 fn replayed_trees_are_reusable_after_durable_reconciliation() {
3028 let directory = tempfile::tempdir().expect("temporary store");
3029 let path = directory.path().join("data.rdb");
3030 let store = UnifiedStore::open(&path).expect("paged store");
3031 store.insert_auto("rows", row(1, 1)).expect("seed");
3032 store.persist().expect("checkpoint");
3033 store
3034 .insert_auto("rows", row(2, 2))
3035 .expect("WAL-backed append");
3036 drop(store);
3037 let reopened = UnifiedStore::open(&path).expect("replay");
3038 assert!(reopened.get("rows", EntityId::new(2)).is_some());
3039 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3040 reopened.persist().expect("checkpoint reconciled tree");
3041 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 0);
3042 }
3043
3044 #[test]
3045 fn legacy_system_catalog_and_wal_migrate_without_cold_boot_rebuild() {
3046 use crate::storage::wal::{WalRecord, WalWriter};
3047
3048 let directory = tempfile::tempdir().expect("temporary store");
3049 let path = directory.path().join("data.rdb");
3050 let config = UnifiedStoreConfig {
3051 page_cache_slots: Some(32),
3052 resident_memory_bytes_max: Some(2 * 1024 * 1024),
3053 ..UnifiedStoreConfig::default()
3054 };
3055 let index_identity = super::super::secondary_index::SecondaryIndexIdentity {
3056 codec_version: 1,
3057 definition: [91; 32],
3058 };
3059 let baseline_index_root;
3060 {
3061 let store = UnifiedStore::open_with_config(&path, config.clone()).expect("paged store");
3062 store
3063 .create_collection("red_config")
3064 .expect("system collection");
3065 store
3066 .insert_auto(
3067 "red_config",
3068 UnifiedEntity::table_row(
3069 EntityId::new(1),
3070 "red_config",
3071 1,
3072 vec![Value::text("checkpoint")],
3073 ),
3074 )
3075 .expect("legacy-compatible insert");
3076 store
3077 .register_secondary_index(
3078 "red_config",
3079 "by_id",
3080 index_identity.clone(),
3081 Arc::new(SystemNameProjection),
3082 )
3083 .expect("secondary index");
3084 store.persist().expect("baseline checkpoint");
3085 baseline_index_root = store
3086 .secondary_index("red.config", "by_id", &index_identity)
3087 .expect("published secondary index")
3088 .root_page_id();
3089 }
3090
3091 {
3095 let pager = Pager::open(
3096 &path,
3097 PagerConfig {
3098 disk_residency: true,
3099 ..PagerConfig::default()
3100 },
3101 )
3102 .expect("open pager");
3103 let mut page = pager.read_page(1).expect("catalog page");
3104 let bytes = page.as_bytes_mut();
3105 let canonical = b"red.config";
3106 let legacy = b"red_config";
3107 let mut replacements = 0;
3108 for offset in 0..=bytes.len() - canonical.len() {
3109 if &bytes[offset..offset + canonical.len()] == canonical {
3110 bytes[offset..offset + legacy.len()].copy_from_slice(legacy);
3111 replacements += 1;
3112 }
3113 }
3114 assert!(replacements >= 1, "catalog must contain the canonical name");
3115 pager.write_page(1, page).expect("write legacy catalog");
3116 pager.sync().expect("sync legacy catalog");
3117 }
3118 crate::storage::operational_manifest::OperationalManifest::for_db_path(&path)
3119 .rename_collections(&[("red.config", "red_config")])
3120 .expect("restore legacy operational name");
3121
3122 let wal_upsert = reddb_file::encode_store_wal_action_frame(
3125 &reddb_file::StoreWalActionFrame::UpsertEntityRecord {
3126 collection: "red_config".to_string(),
3127 record: UnifiedStore::serialize_entity_record(
3128 &UnifiedEntity::table_row(
3129 EntityId::new(2),
3130 "red_config",
3131 2,
3132 vec![Value::text("legacy WAL")],
3133 ),
3134 None,
3135 STORE_VERSION_CURRENT,
3136 ),
3137 },
3138 )
3139 .expect("legacy WAL action");
3140 let wal_delete = reddb_file::encode_store_wal_action_frame(
3141 &reddb_file::StoreWalActionFrame::DeleteEntityRecord {
3142 collection: "red_config".to_string(),
3143 entity_id: EntityId::new(1).raw(),
3144 },
3145 )
3146 .expect("legacy WAL delete");
3147 let wal_path = reddb_file::layout::unified_wal_path(&path);
3148 {
3149 let mut writer = WalWriter::open(&wal_path).expect("open WAL");
3150 writer
3151 .append(&WalRecord::TxCommitBatch {
3152 tx_id: 77,
3153 actions: vec![wal_upsert, wal_delete],
3154 })
3155 .expect("append legacy transaction");
3156 writer.sync().expect("sync legacy transaction");
3157 }
3158
3159 let (root_after_recovery, pages_after_recovery) = {
3160 let recovered =
3161 UnifiedStore::open_with_config(&path, config.clone()).expect("migrate and recover");
3162 assert_eq!(recovered.list_collections(), vec!["red.config".to_string()]);
3163 assert!(
3164 recovered.get("red.config", EntityId::new(1)).is_none(),
3165 "legacy WAL deletes must target the canonical collection"
3166 );
3167 assert_eq!(
3168 recovered
3169 .get("red.config", EntityId::new(2))
3170 .expect("WAL row")
3171 .kind
3172 .collection(),
3173 "red.config"
3174 );
3175 let root = recovered
3176 .collection_root_page("red.config")
3177 .expect("published canonical root");
3178 assert_eq!(
3179 recovered
3180 .secondary_index("red.config", "by_id", &index_identity)
3181 .expect("recovered secondary index")
3182 .root_page_id(),
3183 baseline_index_root,
3184 "name migration must reuse the secondary-index root"
3185 );
3186 let pages = recovered
3187 .pager()
3188 .expect("pager")
3189 .page_count()
3190 .expect("page count");
3191 (root, pages)
3192 };
3193
3194 crate::storage::operational_manifest::OperationalManifest::for_db_path(&path)
3197 .rename_collections(&[("red.config", "red_config")])
3198 .expect("restore stale manifest identity");
3199
3200 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3201 let cold = UnifiedStore::open_with_config(&path, config).expect("second cold boot");
3202 assert_eq!(
3203 cold.collection_root_page("red.config"),
3204 Some(root_after_recovery),
3205 "an idempotent cold boot must reuse the published data root"
3206 );
3207 assert_eq!(
3208 cold.pager()
3209 .expect("pager")
3210 .page_count()
3211 .expect("page count"),
3212 pages_after_recovery,
3213 "cold boot must not allocate replacement index trees"
3214 );
3215 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 0);
3216 assert_eq!(
3217 cold.secondary_index("red.config", "by_id", &index_identity)
3218 .expect("secondary index after cold boot")
3219 .root_page_id(),
3220 baseline_index_root
3221 );
3222 assert!(
3223 crate::storage::operational_manifest::OperationalManifest::for_db_path(&path)
3224 .recover_or_bootstrap(&["red.config".to_string()])
3225 .expect("canonical manifest")
3226 .is_empty()
3227 );
3228 }
3229
3230 struct DuplicateSystemCatalogFixture {
3231 _directory: tempfile::TempDir,
3232 path: std::path::PathBuf,
3233 config: UnifiedStoreConfig,
3234 pages_before: u32,
3235 legacy_root: Option<u32>,
3236 legacy_key_root: Option<u32>,
3237 legacy_secondary_root: Option<u32>,
3238 index_identity: super::super::secondary_index::SecondaryIndexIdentity,
3239 }
3240
3241 fn duplicate_system_catalog_fixture(
3242 legacy_populated: bool,
3243 canonical_populated: bool,
3244 index_legacy: bool,
3245 ) -> DuplicateSystemCatalogFixture {
3246 let directory = tempfile::tempdir().expect("temporary store");
3247 let path = directory.path().join("data.rdb");
3248 let config = UnifiedStoreConfig {
3249 page_cache_slots: Some(32),
3250 resident_memory_bytes_max: Some(2 * 1024 * 1024),
3251 ..UnifiedStoreConfig::default()
3252 };
3253 let index_identity = super::super::secondary_index::SecondaryIndexIdentity {
3254 codec_version: 1,
3255 definition: [73; 32],
3256 };
3257 let (legacy_root, legacy_key_root, legacy_secondary_root);
3258 {
3259 let store = UnifiedStore::open_with_config(&path, config.clone()).expect("paged store");
3260 store
3261 .create_collection("cfg_legacy")
3262 .expect("legacy source collection");
3263 if legacy_populated {
3264 store
3265 .insert_auto(
3266 "cfg_legacy",
3267 UnifiedEntity::table_row(
3268 EntityId::new(1),
3269 "red_config",
3270 1,
3271 vec![Value::text("legacy")],
3272 ),
3273 )
3274 .expect("legacy row");
3275 }
3276 store
3277 .create_collection("cfg.canon_")
3278 .expect("canonical source collection");
3279 if canonical_populated {
3280 store
3281 .insert_auto(
3282 "cfg.canon_",
3283 UnifiedEntity::table_row(
3284 EntityId::new(2),
3285 "red.config",
3286 2,
3287 vec![Value::text("canonical")],
3288 ),
3289 )
3290 .expect("canonical row");
3291 }
3292 if index_legacy {
3293 store
3294 .register_secondary_index(
3295 "cfg_legacy",
3296 "by_id",
3297 index_identity.clone(),
3298 Arc::new(SystemNameProjection),
3299 )
3300 .expect("legacy secondary index");
3301 }
3302 store.persist().expect("checkpoint duplicate catalog");
3303 legacy_root = store.collection_root_page("cfg_legacy");
3304 legacy_key_root = store
3305 .key_indices
3306 .read()
3307 .get("cfg_legacy")
3308 .map(|index| index.tree.root_page_id());
3309 legacy_secondary_root = index_legacy.then(|| {
3310 store
3311 .secondary_index("cfg_legacy", "by_id", &index_identity)
3312 .expect("legacy secondary root")
3313 .root_page_id()
3314 });
3315 }
3316
3317 {
3322 let pager = Pager::open(
3323 &path,
3324 PagerConfig {
3325 disk_residency: true,
3326 ..PagerConfig::default()
3327 },
3328 )
3329 .expect("open pager");
3330 let mut page = pager.read_page(1).expect("catalog page");
3331 let bytes = page.as_bytes_mut();
3332 for (source, destination) in [
3333 (b"cfg_legacy".as_slice(), b"red_config".as_slice()),
3334 (b"cfg.canon_".as_slice(), b"red.config".as_slice()),
3335 ] {
3336 let mut replacements = 0;
3337 for offset in 0..=bytes.len() - source.len() {
3338 if &bytes[offset..offset + source.len()] == source {
3339 bytes[offset..offset + destination.len()].copy_from_slice(destination);
3340 replacements += 1;
3341 }
3342 }
3343 assert!(replacements >= 1, "catalog must contain the source name");
3344 }
3345 pager.write_page(1, page).expect("write duplicate catalog");
3346 pager.sync().expect("sync duplicate catalog");
3347 }
3348 crate::storage::operational_manifest::OperationalManifest::for_db_path(&path)
3349 .rename_collections(&[("cfg_legacy", "red_config"), ("cfg.canon_", "red.config")])
3350 .expect("publish duplicate operational names");
3351
3352 let pages_before = Pager::open(
3353 &path,
3354 PagerConfig {
3355 disk_residency: true,
3356 ..PagerConfig::default()
3357 },
3358 )
3359 .expect("inspect pager")
3360 .page_count()
3361 .expect("page count");
3362 DuplicateSystemCatalogFixture {
3363 _directory: directory,
3364 path,
3365 config,
3366 pages_before,
3367 legacy_root,
3368 legacy_key_root,
3369 legacy_secondary_root,
3370 index_identity,
3371 }
3372 }
3373
3374 fn alias_duplicate_system_catalog_state_with(
3375 fixture: &DuplicateSystemCatalogFixture,
3376 mutate_canonical: impl FnOnce(&mut reddb_file::native_resume::CollectionResume),
3377 ) {
3378 let pager = Pager::open(
3379 &fixture.path,
3380 PagerConfig {
3381 disk_residency: true,
3382 ..PagerConfig::default()
3383 },
3384 )
3385 .expect("open duplicate catalog pager");
3386 let mut metadata = read_meta_payload(&pager)
3387 .expect("read duplicate catalog")
3388 .expect("published duplicate catalog");
3389 let mut resume = reddb_file::native_resume::decode_catalog_resume(&metadata)
3390 .expect("decode duplicate resume")
3391 .expect("prepared duplicate resume");
3392 let legacy_state = resume
3393 .collections
3394 .get("red_config")
3395 .expect("legacy resume state")
3396 .clone();
3397 let mut canonical_state = legacy_state.clone();
3398 mutate_canonical(&mut canonical_state);
3399 resume
3400 .collections
3401 .insert("red.config".to_string(), canonical_state);
3402
3403 let header = reddb_file::decode_native_paged_metadata_header(&metadata)
3404 .expect("decode metadata header")
3405 .expect("native metadata header");
3406 let mut position = reddb_file::METADATA_HEADER_BYTES;
3407 let mut replaced_root = false;
3408 for _ in 0..header.collection_count {
3409 let root = reddb_file::decode_native_paged_collection_root(&metadata, &mut position)
3410 .expect("decode collection root");
3411 if root.collection == "red.config" {
3412 metadata[position - 4..position]
3413 .copy_from_slice(&legacy_state.root_page.to_le_bytes());
3414 replaced_root = true;
3415 }
3416 }
3417 assert!(replaced_root, "canonical catalog root must be present");
3418
3419 let trailer = metadata
3420 .windows(4)
3421 .rposition(|bytes| bytes == b"RDRS")
3422 .expect("catalog resume trailer");
3423 metadata.truncate(trailer);
3424 reddb_file::native_resume::encode_catalog_resume(&mut metadata, &resume)
3425 .expect("encode aliased resume");
3426 publish_paged_metadata(&pager, &metadata).expect("publish aliased catalog");
3427 }
3428
3429 fn alias_duplicate_system_catalog_state(fixture: &DuplicateSystemCatalogFixture) {
3430 alias_duplicate_system_catalog_state_with(fixture, |_| {});
3431 }
3432
3433 #[test]
3434 fn populated_legacy_system_collection_replaces_empty_canonical_duplicate() {
3435 let fixture = duplicate_system_catalog_fixture(true, false, true);
3436 let recovered = UnifiedStore::open_with_config(&fixture.path, fixture.config.clone())
3437 .expect("resolve empty duplicate");
3438 assert_eq!(recovered.list_collections(), vec!["red.config".to_string()]);
3439 assert_eq!(
3440 recovered
3441 .get("red.config", EntityId::new(1))
3442 .expect("preserved legacy row")
3443 .kind
3444 .collection(),
3445 "red.config"
3446 );
3447 assert_eq!(
3448 recovered.collection_root_page("red.config"),
3449 fixture.legacy_root,
3450 "the populated data root must be reused"
3451 );
3452 assert_eq!(
3453 recovered
3454 .key_indices
3455 .read()
3456 .get("red.config")
3457 .map(|index| index.tree.root_page_id()),
3458 fixture.legacy_key_root,
3459 "the populated key-index root must be reused"
3460 );
3461 assert_eq!(
3462 recovered
3463 .secondary_index("red.config", "by_id", &fixture.index_identity)
3464 .expect("surviving secondary index")
3465 .root_page_id(),
3466 fixture
3467 .legacy_secondary_root
3468 .expect("fixture secondary root")
3469 );
3470 drop(recovered);
3471
3472 let cold = UnifiedStore::open_with_config(&fixture.path, fixture.config)
3473 .expect("idempotent cold boot");
3474 assert_eq!(cold.list_collections(), vec!["red.config".to_string()]);
3475 assert_eq!(
3476 cold.pager()
3477 .expect("pager")
3478 .page_count()
3479 .expect("page count"),
3480 fixture.pages_before,
3481 "resolving an empty duplicate must not extend the file"
3482 );
3483 }
3484
3485 #[test]
3486 fn populated_canonical_system_collection_replaces_empty_legacy_duplicate() {
3487 let fixture = duplicate_system_catalog_fixture(false, true, false);
3488 let recovered = UnifiedStore::open_with_config(&fixture.path, fixture.config)
3489 .expect("retain populated canonical duplicate");
3490 assert_eq!(recovered.list_collections(), vec!["red.config".to_string()]);
3491 assert_eq!(
3492 recovered
3493 .get("red.config", EntityId::new(2))
3494 .expect("preserved canonical row")
3495 .kind
3496 .collection(),
3497 "red.config"
3498 );
3499 assert!(recovered.get("red.config", EntityId::new(1)).is_none());
3500 }
3501
3502 #[test]
3503 fn empty_canonical_system_collection_replaces_empty_legacy_duplicate() {
3504 let fixture = duplicate_system_catalog_fixture(false, false, false);
3505 let recovered = UnifiedStore::open_with_config(&fixture.path, fixture.config)
3506 .expect("prefer canonical empty duplicate");
3507 assert_eq!(recovered.list_collections(), vec!["red.config".to_string()]);
3508 assert_eq!(
3509 recovered
3510 .get_collection("red.config")
3511 .expect("canonical collection")
3512 .count(),
3513 0
3514 );
3515 }
3516
3517 #[test]
3518 fn populated_system_collection_duplicates_still_fail_closed() {
3519 let fixture = duplicate_system_catalog_fixture(true, true, false);
3520 let error = match UnifiedStore::open_with_config(&fixture.path, fixture.config) {
3521 Ok(_) => panic!("two populated identities are ambiguous"),
3522 Err(error) => error,
3523 };
3524 assert!(
3525 error
3526 .to_string()
3527 .contains("both populated legacy collection 'red_config' and canonical collection 'red.config'"),
3528 "unexpected error: {error}"
3529 );
3530 assert!(
3531 error.to_string().contains(
3532 "data_root_match=false, key_index_root_match=true, secondary_index_state_match=true"
3533 ),
3534 "the error must identify which physical state diverged without exposing page IDs: {error}"
3535 );
3536 }
3537
3538 #[test]
3539 fn populated_system_collection_aliases_reconcile_without_rebuild() {
3540 let fixture = duplicate_system_catalog_fixture(true, false, true);
3541 alias_duplicate_system_catalog_state(&fixture);
3542
3543 let recovered = UnifiedStore::open_with_config(&fixture.path, fixture.config.clone())
3544 .expect("reconcile identical populated aliases");
3545 assert_eq!(recovered.list_collections(), vec!["red.config".to_string()]);
3546 assert_eq!(
3547 recovered
3548 .get("red.config", EntityId::new(1))
3549 .expect("preserved aliased row")
3550 .kind
3551 .collection(),
3552 "red.config"
3553 );
3554 assert_eq!(
3555 recovered.collection_root_page("red.config"),
3556 fixture.legacy_root,
3557 "the shared data root must be reused"
3558 );
3559 assert_eq!(
3560 recovered
3561 .key_indices
3562 .read()
3563 .get("red.config")
3564 .map(|index| index.tree.root_page_id()),
3565 fixture.legacy_key_root,
3566 "the shared key-index root must be reused"
3567 );
3568 assert_eq!(
3569 recovered
3570 .secondary_index("red.config", "by_id", &fixture.index_identity)
3571 .expect("shared secondary index")
3572 .root_page_id(),
3573 fixture
3574 .legacy_secondary_root
3575 .expect("fixture secondary root")
3576 );
3577 drop(recovered);
3578
3579 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3580 let cold = UnifiedStore::open_with_config(&fixture.path, fixture.config)
3581 .expect("idempotent cold boot");
3582 assert_eq!(cold.list_collections(), vec!["red.config".to_string()]);
3583 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 0);
3584 assert_eq!(
3585 cold.pager()
3586 .expect("pager")
3587 .page_count()
3588 .expect("page count"),
3589 fixture.pages_before,
3590 "reconciling a physical alias must not extend the file"
3591 );
3592 }
3593
3594 #[test]
3595 fn populated_system_collection_aliases_merge_resume_counter_drift() {
3596 let fixture = duplicate_system_catalog_fixture(true, false, false);
3597 alias_duplicate_system_catalog_state_with(&fixture, |canonical| {
3598 canonical.entities += 7;
3599 canonical.entity_id_next += 100;
3600 canonical.row_id_next += 200;
3601 canonical.sequence_id_next += 300;
3602 });
3603
3604 let recovered = UnifiedStore::open_with_config(&fixture.path, fixture.config.clone())
3605 .expect("reconcile shared roots with conservative counters");
3606 let manager = recovered
3607 .get_collection("red.config")
3608 .expect("canonical collection");
3609 assert_eq!(manager.count(), 1, "the shared tree owns the exact count");
3610 assert_eq!(manager.identity_counters(), (102, 202));
3611 assert_eq!(manager.sequence_id_next(), 301);
3612 assert_eq!(
3613 recovered.collection_root_page("red.config"),
3614 fixture.legacy_root,
3615 "counter reconciliation must keep the shared data root"
3616 );
3617 drop(manager);
3618 drop(recovered);
3619
3620 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3621 let cold = UnifiedStore::open_with_config(&fixture.path, fixture.config)
3622 .expect("idempotent cold boot after counter reconciliation");
3623 assert_eq!(cold.list_collections(), vec!["red.config".to_string()]);
3624 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 0);
3625 assert_eq!(
3626 cold.pager()
3627 .expect("pager")
3628 .page_count()
3629 .expect("page count"),
3630 fixture.pages_before,
3631 "counter reconciliation must not extend the file"
3632 );
3633 }
3634
3635 fn row(id: u64, value: i64) -> UnifiedEntity {
3636 UnifiedEntity::table_row(EntityId::new(id), "rows", id, vec![Value::Integer(value)])
3637 }
3638
3639 #[test]
3640 fn checkpoint_reuse_tracks_manager_updates_metadata_deletes_and_bulk_inserts() {
3641 let directory = tempfile::tempdir().expect("temporary store");
3642 let path = directory.path().join("data.rdb");
3643 let store = UnifiedStore::open(&path).expect("paged store");
3644 store.create_collection("rows").expect("collection");
3645 store.insert("rows", row(1, 1)).expect("seed");
3646 store.persist().expect("initial checkpoint");
3647 let manager = store.get_collection("rows").expect("rows");
3648 manager.update(row(1, 2)).expect("direct update");
3649 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3650 store.persist().expect("updated row checkpoint");
3651 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 1);
3652 let mut metadata = Metadata::new();
3653 metadata.set("verified", MetadataValue::Bool(true));
3654 manager
3655 .set_metadata(EntityId::new(1), metadata)
3656 .expect("metadata");
3657 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3658 store.persist().expect("metadata-only checkpoint");
3659 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 1);
3660 manager
3661 .bulk_insert(vec![row(2, 2), row(3, 3)])
3662 .expect("bulk insert");
3663 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3664 store.persist().expect("bulk insert checkpoint");
3665 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 3);
3666 manager.delete(EntityId::new(2)).expect("delete");
3667 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3668 store.persist().expect("changed checkpoint");
3669 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 2);
3670 drop(store);
3671 let recovered = UnifiedStore::open(&path).expect("recover changed rows");
3672 let manager = recovered.get_collection("rows").expect("rows");
3673 assert_eq!(manager.count(), 2);
3674 assert_eq!(
3675 manager
3676 .get(EntityId::new(1))
3677 .expect("row")
3678 .data
3679 .as_row()
3680 .expect("table")
3681 .columns,
3682 vec![Value::Integer(2)]
3683 );
3684 assert!(manager.get(EntityId::new(2)).is_none());
3685 assert!(manager
3686 .get_metadata(EntityId::new(1))
3687 .expect("metadata")
3688 .get("verified")
3689 .is_some());
3690 }
3691
3692 #[test]
3693 fn unrelated_visibility_changes_do_not_serialize_collection_rows() {
3694 let directory = tempfile::tempdir().expect("temporary store");
3695 let store = UnifiedStore::open(&directory.path().join("data.rdb")).expect("paged store");
3696 let snapshots = Arc::new(crate::storage::transaction::snapshot::SnapshotManager::new());
3697 assert!(store.snapshot_manager.set(Arc::clone(&snapshots)).is_ok());
3698 store.create_collection("rows").expect("collection");
3699 for id in 1..=40 {
3700 store.insert("rows", row(id, id as i64)).expect("seed");
3701 }
3702 store.persist().expect("initial checkpoint");
3703 let unrelated = snapshots.begin();
3704 snapshots.rollback(unrelated);
3705 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3706 store.persist().expect("unrelated rollback checkpoint");
3707 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 0);
3708
3709 store
3710 .pending_vault_versions
3711 .write()
3712 .insert(EntityId::new(100));
3713 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3714 store.persist().expect("unrelated vault checkpoint");
3715 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 0);
3716 store.pending_vault_versions.write().clear();
3717 CHECKPOINT_SERIALIZED_ROWS.with(|count| count.set(0));
3718 store
3719 .persist()
3720 .expect("unrelated vault publication checkpoint");
3721 assert_eq!(CHECKPOINT_SERIALIZED_ROWS.with(|count| count.get()), 0);
3722 }
3723
3724 #[test]
3725 fn low_level_rollback_of_a_non_active_xid_invalidates_sparse_visibility() {
3726 let directory = tempfile::tempdir().expect("temporary store");
3727 let path = directory.path().join("data.rdb");
3728 let store = UnifiedStore::open(&path).expect("paged store");
3729 let snapshots = Arc::new(crate::storage::transaction::snapshot::SnapshotManager::new());
3730 assert!(store.snapshot_manager.set(Arc::clone(&snapshots)).is_ok());
3731 store.create_collection("rows").expect("collection");
3732 let xid = snapshots.begin();
3733 let mut entity = row(1, 1);
3734 entity.xmin = xid;
3735 store.insert("rows", entity).expect("committed row");
3736 snapshots.commit(xid);
3737 store.persist().expect("committed baseline");
3738 snapshots.rollback(xid);
3739 store
3740 .persist()
3741 .expect("untracked outcome requires validation");
3742 drop(store);
3743 let recovered = UnifiedStore::open(&path).expect("recover");
3744 assert_eq!(recovered.get_collection("rows").expect("rows").count(), 0);
3745 }
3746
3747 #[test]
3748 fn exhausted_deferred_row_cache_keeps_full_validation() {
3749 let directory = tempfile::tempdir().expect("temporary store");
3750 let path = directory.path().join("data.rdb");
3751 let store = UnifiedStore::open(&path).expect("paged store");
3752 let snapshots = Arc::new(crate::storage::transaction::snapshot::SnapshotManager::new());
3753 assert!(store.snapshot_manager.set(Arc::clone(&snapshots)).is_ok());
3754 store.create_collection("rows").expect("collection");
3755 let xid = snapshots.begin();
3756 for id in 1..=1025 {
3757 let mut entity = row(id, id as i64);
3758 entity.xmin = xid;
3759 store.insert("rows", entity).expect("pending row");
3760 }
3761 store.persist().expect("exclude pending rows");
3762 assert!(store.checkpoint_versions.read()["rows"]
3763 .deferred_rows
3764 .is_none());
3765 snapshots.commit(xid);
3766 store
3767 .persist()
3768 .expect("publish committed rows conservatively");
3769 drop(store);
3770 let recovered = UnifiedStore::open(&path).expect("recover");
3771 assert_eq!(
3772 recovered.get_collection("rows").expect("rows").count(),
3773 1025
3774 );
3775 }
3776
3777 #[test]
3778 fn rollback_invalidates_reuse_without_a_segment_mutation() {
3779 let directory = tempfile::tempdir().expect("temporary store");
3780 let path = directory.path().join("data.rdb");
3781 let store = UnifiedStore::open(&path).expect("paged store");
3782 let snapshots = Arc::new(crate::storage::transaction::snapshot::SnapshotManager::new());
3783 assert!(store.snapshot_manager.set(Arc::clone(&snapshots)).is_ok());
3784 store.create_collection("rows").expect("collection");
3785 let xid = snapshots.begin();
3786 let mut pending = row(1, 1);
3787 pending.xmin = xid;
3788 store.insert("rows", pending).expect("version");
3789 store.persist().expect("before rollback");
3790 snapshots.rollback(xid);
3791 store.persist().expect("after rollback");
3792 drop(store);
3793 let recovered = UnifiedStore::open(&path).expect("recover");
3794 assert_eq!(recovered.get_collection("rows").expect("rows").count(), 0);
3795 }
3796
3797 #[test]
3798 fn rolled_back_delete_is_normalized_without_a_segment_mutation() {
3799 let directory = tempfile::tempdir().expect("temporary store");
3800 let path = directory.path().join("data.rdb");
3801 let store = UnifiedStore::open(&path).expect("paged store");
3802 let snapshots = Arc::new(crate::storage::transaction::snapshot::SnapshotManager::new());
3803 assert!(store.snapshot_manager.set(Arc::clone(&snapshots)).is_ok());
3804 store.create_collection("rows").expect("collection");
3805 let xid = snapshots.begin();
3806 let mut deleted = row(1, 1);
3807 deleted.xmax = xid;
3808 store.insert("rows", deleted).expect("version");
3809 store.persist().expect("before rollback");
3810 snapshots.rollback(xid);
3811 store.persist().expect("after rollback");
3812 drop(store);
3813 let recovered = UnifiedStore::open(&path).expect("recover");
3814 let manager = recovered.get_collection("rows").expect("rows");
3815 assert_eq!(manager.get(EntityId::new(1)).expect("retained row").xmax, 0);
3816 }
3817
3818 #[test]
3819 fn publishing_a_pending_vault_version_invalidates_reuse() {
3820 let directory = tempfile::tempdir().expect("temporary store");
3821 let path = directory.path().join("data.rdb");
3822 let store = UnifiedStore::open(&path).expect("paged store");
3823 store.create_collection("rows").expect("collection");
3824 store.insert("rows", row(1, 1)).expect("row");
3825 store
3826 .pending_vault_versions
3827 .write()
3828 .insert(EntityId::new(1));
3829 store.persist().expect("exclude pending vault version");
3830 store
3831 .pending_vault_versions
3832 .write()
3833 .remove(&EntityId::new(1));
3834 store.persist().expect("include published vault version");
3835 drop(store);
3836 let recovered = UnifiedStore::open(&path).expect("recover");
3837 assert_eq!(recovered.get_collection("rows").expect("rows").count(), 1);
3838 }
3839}