reddb_server/storage/wal/
transaction.rs1use std::collections::HashMap;
25use std::io;
26use std::path::{Path, PathBuf};
27use std::sync::atomic::{AtomicU64, Ordering};
28use std::sync::{Arc, RwLock, RwLockReadGuard, RwLockWriteGuard};
29
30use parking_lot::{Mutex, MutexGuard};
31
32use super::append_coordinator::WalAppendCoordinator;
33use super::record::WalRecord;
34use super::writer::WalWriter;
35use crate::storage::engine::{Page, Pager, PAGE_SIZE};
36
37static NEXT_TX_ID: AtomicU64 = AtomicU64::new(1);
39
40fn next_transaction_id() -> u64 {
42 NEXT_TX_ID.fetch_add(1, Ordering::SeqCst)
43}
44
45#[derive(Debug, Clone, Copy, PartialEq, Eq)]
47pub enum TxState {
48 Active,
50 Committed,
52 Aborted,
54}
55
56#[derive(Debug)]
58pub enum TxError {
59 Io(io::Error),
61 Pager(String),
63 LockPoisoned(&'static str),
65 NotActive,
67 AlreadyCommitted,
69 AlreadyAborted,
71 WriteConflict(u32),
73 InvalidPage(String),
75}
76
77impl std::fmt::Display for TxError {
78 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
79 match self {
80 Self::Io(e) => write!(f, "I/O error: {}", e),
81 Self::Pager(msg) => write!(f, "Pager error: {}", msg),
82 Self::LockPoisoned(name) => write!(f, "Lock poisoned: {}", name),
83 Self::NotActive => write!(f, "Transaction is not active"),
84 Self::AlreadyCommitted => write!(f, "Transaction already committed"),
85 Self::AlreadyAborted => write!(f, "Transaction already aborted"),
86 Self::WriteConflict(page_id) => write!(f, "Write conflict on page {}", page_id),
87 Self::InvalidPage(msg) => write!(f, "Invalid page: {}", msg),
88 }
89 }
90}
91
92impl std::error::Error for TxError {}
93
94impl From<io::Error> for TxError {
95 fn from(e: io::Error) -> Self {
96 Self::Io(e)
97 }
98}
99
100#[derive(Clone)]
102struct BufferedWrite {
103 page_id: u32,
104 data: [u8; PAGE_SIZE],
105}
106
107pub struct Transaction {
111 id: u64,
113 state: TxState,
115 write_set: HashMap<u32, BufferedWrite>,
117 read_set: Vec<u32>,
119 manager: Arc<TransactionManager>,
121}
122
123impl Transaction {
124 pub fn id(&self) -> u64 {
126 self.id
127 }
128
129 pub fn state(&self) -> TxState {
131 self.state
132 }
133
134 pub fn is_active(&self) -> bool {
136 self.state == TxState::Active
137 }
138
139 pub fn read_page(&mut self, page_id: u32) -> Result<Page, TxError> {
144 if self.state != TxState::Active {
145 return Err(TxError::NotActive);
146 }
147
148 if let Some(buffered) = self.write_set.get(&page_id) {
150 return Ok(Page::from_bytes(buffered.data));
151 }
152
153 self.read_set.push(page_id);
155
156 self.manager
158 .pager
159 .read_page(page_id)
160 .map_err(|e| TxError::Pager(e.to_string()))
161 }
162
163 pub fn write_page(&mut self, page_id: u32, page: Page) -> Result<(), TxError> {
167 if self.state != TxState::Active {
168 return Err(TxError::NotActive);
169 }
170
171 let mut data = [0u8; PAGE_SIZE];
173 data.copy_from_slice(page.as_bytes());
174
175 self.write_set
176 .insert(page_id, BufferedWrite { page_id, data });
177
178 Ok(())
179 }
180
181 pub fn commit(mut self) -> Result<(), TxError> {
194 if self.state != TxState::Active {
195 return match self.state {
196 TxState::Committed => Err(TxError::AlreadyCommitted),
197 TxState::Aborted => Err(TxError::AlreadyAborted),
198 _ => Err(TxError::NotActive),
199 };
200 }
201
202 if self.write_set.is_empty() {
207 self.state = TxState::Committed;
208 self.manager.unregister_transaction(self.id);
209 return Ok(());
210 }
211
212 let mut blob = Vec::with_capacity(64 + self.write_set.len() * (PAGE_SIZE + 32));
220 for (page_id, buffered) in &self.write_set {
221 let record = WalRecord::PageWrite {
222 tx_id: self.id,
223 page_id: *page_id,
224 data: buffered.data.to_vec(),
225 };
226 record.encode_into(&mut blob);
230 }
231 WalRecord::Commit { tx_id: self.id }.encode_into(&mut blob);
232
233 let commit_lsn = self.manager.coordinator.reserve_and_enqueue(blob);
238
239 self.manager
246 .coordinator
247 .commit_at_least(commit_lsn, &self.manager.wal)
248 .map_err(TxError::Io)?;
249
250 for (page_id, buffered) in &self.write_set {
252 let page = Page::from_bytes(buffered.data);
253 self.manager
254 .pager
255 .write_page(*page_id, page)
256 .map_err(|e| TxError::Pager(e.to_string()))?;
257 }
258
259 self.state = TxState::Committed;
260
261 self.manager.unregister_transaction(self.id);
263
264 Ok(())
265 }
266
267 pub fn rollback(mut self) -> Result<(), TxError> {
271 if self.state != TxState::Active {
272 return match self.state {
273 TxState::Committed => Err(TxError::AlreadyCommitted),
274 TxState::Aborted => Err(TxError::AlreadyAborted),
275 _ => Err(TxError::NotActive),
276 };
277 }
278
279 let blob = WalRecord::Rollback { tx_id: self.id }.encode();
284 let target = self.manager.coordinator.reserve_and_enqueue(blob);
285 self.manager
286 .coordinator
287 .commit_at_least(target, &self.manager.wal)
288 .map_err(TxError::Io)?;
289
290 self.write_set.clear();
292 self.state = TxState::Aborted;
293
294 self.manager.unregister_transaction(self.id);
296
297 Ok(())
298 }
299}
300
301impl Drop for Transaction {
302 fn drop(&mut self) {
303 if self.state == TxState::Active {
306 let blob = WalRecord::Rollback { tx_id: self.id }.encode();
312 let target = self.manager.coordinator.reserve_and_enqueue(blob);
313 let _ = self
314 .manager
315 .coordinator
316 .commit_at_least(target, &self.manager.wal);
317 self.manager.unregister_transaction(self.id);
318 }
319 }
320}
321
322pub struct TransactionManager {
326 pager: Arc<Pager>,
328 wal: Mutex<WalWriter>,
333 wal_path: PathBuf,
335 active_transactions: RwLock<Vec<u64>>,
337 coordinator: WalAppendCoordinator,
346}
347
348impl TransactionManager {
349 pub fn new(pager: Arc<Pager>, wal_path: impl AsRef<Path>) -> io::Result<Self> {
356 let wal_path = wal_path.as_ref().to_path_buf();
357 let wal = WalWriter::open(&wal_path)?;
358 let initial_current = wal.current_lsn();
359 let initial_durable = wal.durable_lsn();
360
361 Ok(Self {
362 pager,
363 wal: Mutex::new(wal),
364 wal_path,
365 active_transactions: RwLock::new(Vec::new()),
366 coordinator: WalAppendCoordinator::new(initial_current, initial_durable),
367 })
368 }
369
370 fn wal_writer(&self) -> Result<MutexGuard<'_, WalWriter>, TxError> {
371 Ok(self.wal.lock())
378 }
379
380 fn active_transactions_write(&self) -> RwLockWriteGuard<'_, Vec<u64>> {
381 self.active_transactions
382 .write()
383 .unwrap_or_else(|poisoned| poisoned.into_inner())
384 }
385
386 fn active_transactions_read(&self) -> RwLockReadGuard<'_, Vec<u64>> {
387 self.active_transactions
388 .read()
389 .unwrap_or_else(|poisoned| poisoned.into_inner())
390 }
391
392 pub fn begin(self: &Arc<Self>) -> Result<Transaction, TxError> {
394 let tx_id = next_transaction_id();
395
396 let blob = WalRecord::Begin { tx_id }.encode();
404 let _begin_lsn = self.coordinator.reserve_and_enqueue(blob);
405
406 {
408 let mut active = self.active_transactions_write();
409 active.push(tx_id);
410 }
411
412 Ok(Transaction {
413 id: tx_id,
414 state: TxState::Active,
415 write_set: HashMap::new(),
416 read_set: Vec::new(),
417 manager: Arc::clone(self),
418 })
419 }
420
421 fn unregister_transaction(&self, tx_id: u64) {
423 let mut active = self.active_transactions_write();
424 active.retain(|&id| id != tx_id);
425 }
426
427 pub fn active_transactions(&self) -> Vec<u64> {
429 self.active_transactions_read().clone()
430 }
431
432 pub fn wal_path(&self) -> &Path {
434 &self.wal_path
435 }
436
437 pub fn pager(&self) -> &Arc<Pager> {
439 &self.pager
440 }
441
442 pub fn sync_wal(&self) -> io::Result<()> {
446 let target = self.coordinator.next_lsn();
447 self.coordinator.commit_at_least(target, &self.wal)
448 }
449
450 pub fn has_active_transactions(&self) -> bool {
452 !self.active_transactions_read().is_empty()
453 }
454}
455
456#[cfg(test)]
457mod tests {
458 use super::*;
459 use crate::storage::engine::PageType;
460 use std::fs;
461 use std::time::{SystemTime, UNIX_EPOCH};
462
463 fn temp_dir() -> PathBuf {
464 let timestamp = SystemTime::now()
465 .duration_since(UNIX_EPOCH)
466 .unwrap()
467 .as_nanos();
468 std::env::temp_dir().join(format!("reddb_tx_test_{}", timestamp))
469 }
470
471 fn cleanup(dir: &Path) {
472 let _ = fs::remove_dir_all(dir);
473 }
474
475 #[test]
476 fn test_transaction_commit() {
477 let dir = temp_dir();
478 let _ = fs::create_dir_all(&dir);
479 let db_path = dir.join("test.db");
480 let wal_path = dir.join("test.wal");
481
482 let pager = Arc::new(Pager::open_default(&db_path).unwrap());
484
485 let page = pager.allocate_page(PageType::BTreeLeaf).unwrap();
487 let page_id = page.page_id();
488
489 let tm = Arc::new(TransactionManager::new(Arc::clone(&pager), &wal_path).unwrap());
491
492 let mut tx = tm.begin().unwrap();
494 assert!(tx.is_active());
495
496 let mut page = Page::new(PageType::BTreeLeaf, page_id);
498 page.as_bytes_mut()[100] = 0xAB;
499 tx.write_page(page_id, page).unwrap();
500
501 let read_page = tx.read_page(page_id).unwrap();
503 assert_eq!(read_page.as_bytes()[100], 0xAB);
504
505 tx.commit().unwrap();
507
508 let final_page = pager.read_page(page_id).unwrap();
510 assert_eq!(final_page.as_bytes()[100], 0xAB);
511
512 cleanup(&dir);
513 }
514
515 #[test]
516 fn test_transaction_rollback() {
517 let dir = temp_dir();
518 let _ = fs::create_dir_all(&dir);
519 let db_path = dir.join("test.db");
520 let wal_path = dir.join("test.wal");
521
522 let pager = Arc::new(Pager::open_default(&db_path).unwrap());
524
525 let mut page = pager.allocate_page(PageType::BTreeLeaf).unwrap();
527 let page_id = page.page_id();
528 page.as_bytes_mut()[100] = 0x11;
529 pager.write_page(page_id, page).unwrap();
530
531 let tm = Arc::new(TransactionManager::new(Arc::clone(&pager), &wal_path).unwrap());
533
534 let mut tx = tm.begin().unwrap();
536
537 let mut page = Page::new(PageType::BTreeLeaf, page_id);
539 page.as_bytes_mut()[100] = 0xAB;
540 tx.write_page(page_id, page).unwrap();
541
542 let read_page = tx.read_page(page_id).unwrap();
544 assert_eq!(read_page.as_bytes()[100], 0xAB);
545
546 tx.rollback().unwrap();
548
549 let final_page = pager.read_page(page_id).unwrap();
551 assert_eq!(final_page.as_bytes()[100], 0x11);
552
553 cleanup(&dir);
554 }
555
556 #[test]
557 fn test_multiple_transactions() {
558 let dir = temp_dir();
559 let _ = fs::create_dir_all(&dir);
560 let db_path = dir.join("test.db");
561 let wal_path = dir.join("test.wal");
562
563 let pager = Arc::new(Pager::open_default(&db_path).unwrap());
565
566 let page1 = pager.allocate_page(PageType::BTreeLeaf).unwrap();
568 let page2 = pager.allocate_page(PageType::BTreeLeaf).unwrap();
569 let page1_id = page1.page_id();
570 let page2_id = page2.page_id();
571
572 let tm = Arc::new(TransactionManager::new(Arc::clone(&pager), &wal_path).unwrap());
574
575 let mut tx1 = tm.begin().unwrap();
577 let mut page1 = Page::new(PageType::BTreeLeaf, page1_id);
578 page1.as_bytes_mut()[100] = 0x11;
579 tx1.write_page(page1_id, page1).unwrap();
580 tx1.commit().unwrap();
581
582 let mut tx2 = tm.begin().unwrap();
584 let mut page2 = Page::new(PageType::BTreeLeaf, page2_id);
585 page2.as_bytes_mut()[100] = 0x22;
586 tx2.write_page(page2_id, page2).unwrap();
587 tx2.commit().unwrap();
588
589 let final_page1 = pager.read_page(page1_id).unwrap();
591 let final_page2 = pager.read_page(page2_id).unwrap();
592 assert_eq!(final_page1.as_bytes()[100], 0x11);
593 assert_eq!(final_page2.as_bytes()[100], 0x22);
594
595 cleanup(&dir);
596 }
597
598 #[test]
599 fn test_transaction_isolation() {
600 let dir = temp_dir();
601 let _ = fs::create_dir_all(&dir);
602 let db_path = dir.join("test.db");
603 let wal_path = dir.join("test.wal");
604
605 let pager = Arc::new(Pager::open_default(&db_path).unwrap());
607
608 let mut page = pager.allocate_page(PageType::BTreeLeaf).unwrap();
610 let page_id = page.page_id();
611 page.as_bytes_mut()[100] = 0x00;
612 pager.write_page(page_id, page).unwrap();
613
614 let tm = Arc::new(TransactionManager::new(Arc::clone(&pager), &wal_path).unwrap());
616
617 let mut tx1 = tm.begin().unwrap();
619 let mut page1 = Page::new(PageType::BTreeLeaf, page_id);
620 page1.as_bytes_mut()[100] = 0x11;
621 tx1.write_page(page_id, page1).unwrap();
622
623 let tx1_read = tx1.read_page(page_id).unwrap();
625 assert_eq!(tx1_read.as_bytes()[100], 0x11);
626
627 let pager_read = pager.read_page(page_id).unwrap();
629 assert_eq!(pager_read.as_bytes()[100], 0x00);
630
631 tx1.commit().unwrap();
633
634 let final_read = pager.read_page(page_id).unwrap();
636 assert_eq!(final_read.as_bytes()[100], 0x11);
637
638 cleanup(&dir);
639 }
640
641 #[test]
642 fn test_active_transaction_tracking() {
643 let dir = temp_dir();
644 let _ = fs::create_dir_all(&dir);
645 let db_path = dir.join("test.db");
646 let wal_path = dir.join("test.wal");
647
648 let pager = Arc::new(Pager::open_default(&db_path).unwrap());
649 let tm = Arc::new(TransactionManager::new(Arc::clone(&pager), &wal_path).unwrap());
650
651 assert!(!tm.has_active_transactions());
652
653 let tx1 = tm.begin().unwrap();
654 let tx1_id = tx1.id();
655 assert!(tm.has_active_transactions());
656 assert!(tm.active_transactions().contains(&tx1_id));
657
658 let tx2 = tm.begin().unwrap();
659 let tx2_id = tx2.id();
660 assert_eq!(tm.active_transactions().len(), 2);
661
662 tx1.commit().unwrap();
663 assert!(!tm.active_transactions().contains(&tx1_id));
664 assert!(tm.active_transactions().contains(&tx2_id));
665
666 tx2.rollback().unwrap();
667 assert!(!tm.has_active_transactions());
668
669 cleanup(&dir);
670 }
671
672 #[test]
673 fn test_transaction_double_commit() {
674 let dir = temp_dir();
675 let _ = fs::create_dir_all(&dir);
676 let db_path = dir.join("test.db");
677 let wal_path = dir.join("test.wal");
678
679 let pager = Arc::new(Pager::open_default(&db_path).unwrap());
680 let tm = Arc::new(TransactionManager::new(Arc::clone(&pager), &wal_path).unwrap());
681
682 let tx = tm.begin().unwrap();
685 tx.commit().unwrap();
686
687 cleanup(&dir);
688 }
689
690 #[test]
691 fn test_begin_succeeds_after_panic_in_lock_holder() {
692 let dir = temp_dir();
699 let _ = fs::create_dir_all(&dir);
700 let db_path = dir.join("test.db");
701 let wal_path = dir.join("test.wal");
702
703 let pager = Arc::new(Pager::open_default(&db_path).unwrap());
704 let tm = Arc::new(TransactionManager::new(Arc::clone(&pager), &wal_path).unwrap());
705
706 let poison_target = Arc::clone(&tm);
707 let _ = std::thread::spawn(move || {
708 let _guard = poison_target.wal.lock();
709 panic!("would-poison the wal mutex on std::sync");
710 })
711 .join();
712
713 match tm.begin() {
715 Ok(_) => {}
716 Err(err) => panic!("begin must succeed despite prior panic: {err:?}"),
717 }
718
719 cleanup(&dir);
720 }
721
722 #[test]
727 fn read_only_commit_does_not_advance_durable_lsn() {
728 let dir = temp_dir();
729 let _ = fs::create_dir_all(&dir);
730 let db_path = dir.join("ro_durable.db");
731 let wal_path = dir.join("ro_durable.wal");
732
733 let pager = Arc::new(Pager::open_default(&db_path).unwrap());
734 let tm = Arc::new(TransactionManager::new(Arc::clone(&pager), &wal_path).unwrap());
735
736 let before = {
738 let wal = tm.wal_writer().unwrap();
739 wal.durable_lsn()
740 };
741
742 let tx = tm.begin().unwrap();
743 tx.commit().unwrap();
745
746 let after = {
749 let wal = tm.wal_writer().unwrap();
750 wal.durable_lsn()
751 };
752 assert_eq!(
753 before, after,
754 "read-only commit must not advance durable_lsn (was {} → {})",
755 before, after
756 );
757
758 cleanup(&dir);
759 }
760
761 #[test]
762 fn read_only_commit_does_not_grow_wal_file() {
763 let dir = temp_dir();
764 let _ = fs::create_dir_all(&dir);
765 let db_path = dir.join("ro_size.db");
766 let wal_path = dir.join("ro_size.wal");
767
768 let pager = Arc::new(Pager::open_default(&db_path).unwrap());
769 let tm = Arc::new(TransactionManager::new(Arc::clone(&pager), &wal_path).unwrap());
770
771 let size_before = std::fs::metadata(&wal_path).unwrap().len();
773 assert_eq!(
774 size_before, 8,
775 "fresh WAL must be exactly the 8-byte header"
776 );
777
778 for _ in 0..100 {
780 let tx = tm.begin().unwrap();
781 tx.commit().unwrap();
782 }
783
784 let size_after = std::fs::metadata(&wal_path).unwrap().len();
785 assert_eq!(
786 size_after, size_before,
787 "100 read-only commits should not have written any WAL bytes"
788 );
789 cleanup(&dir);
790 }
791
792 #[test]
793 fn read_only_commit_marks_transaction_committed() {
794 let dir = temp_dir();
795 let _ = fs::create_dir_all(&dir);
796 let db_path = dir.join("ro_state.db");
797 let wal_path = dir.join("ro_state.wal");
798
799 let pager = Arc::new(Pager::open_default(&db_path).unwrap());
800 let tm = Arc::new(TransactionManager::new(Arc::clone(&pager), &wal_path).unwrap());
801
802 let tx = tm.begin().unwrap();
803 let id = tx.id();
804 tx.commit().unwrap();
805
806 assert!(
809 !tm.active_transactions().contains(&id),
810 "RO-committed txn {id} must no longer be active in the manager"
811 );
812
813 cleanup(&dir);
814 }
815
816 #[test]
817 fn writing_commit_still_syncs_after_ro_fast_path() {
818 let dir = temp_dir();
822 let _ = fs::create_dir_all(&dir);
823 let db_path = dir.join("rw_after_ro.db");
824 let wal_path = dir.join("rw_after_ro.wal");
825
826 let pager = Arc::new(Pager::open_default(&db_path).unwrap());
827 let allocated = pager.allocate_page(PageType::BTreeLeaf).unwrap();
828 let page_id = allocated.page_id();
829 let tm = Arc::new(TransactionManager::new(Arc::clone(&pager), &wal_path).unwrap());
830
831 let ro = tm.begin().unwrap();
833 ro.commit().unwrap();
834
835 let mut rw = tm.begin().unwrap();
837 let mut page = Page::new(PageType::BTreeLeaf, page_id);
838 page.as_bytes_mut()[42] = 0x77;
839 rw.write_page(page_id, page).unwrap();
840 rw.commit().unwrap();
841
842 let size = std::fs::metadata(&wal_path).unwrap().len();
845 assert!(size > 8, "writing commit should grow the WAL");
846
847 let read_back = pager.read_page(page_id).unwrap();
849 assert_eq!(read_back.as_bytes()[42], 0x77);
850
851 cleanup(&dir);
852 }
853}