reddb_server/storage/wal/

writer.rs

use super::record::WalRecord;
use std::fs::{File, OpenOptions};
use std::io::{self, BufWriter, Seek, SeekFrom, Write};
use std::path::Path;
use std::sync::Arc;

/// User-space buffer size for the WAL writer.
///
/// Chosen so that ~5 000 small records (Begin/Commit ≈ 21 bytes,
/// small PageWrite ≈ 34 bytes) coalesce into a single `write` syscall
/// before the next `sync()` drains the buffer. Tunable; reflects the
/// postgres XLOG block size (8 KiB) scaled up because we batch
/// record-level rather than page-level.
const WAL_BUFFER_BYTES: usize = 64 * 1024;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum WalSyncMethod {
    Data,
    All,
}

pub(crate) struct WalGroupSync {
    target_lsn: u64,
    sync_handle: Arc<File>,
    method: WalSyncMethod,
}

impl WalGroupSync {
    pub(crate) fn target_lsn(&self) -> u64 {
        self.target_lsn
    }

    pub(crate) fn sync(&self) -> io::Result<()> {
        match self.method {
            WalSyncMethod::Data => self.sync_handle.sync_data(),
            WalSyncMethod::All => self.sync_handle.sync_all(),
        }
    }
}

/// Reserve disk blocks for `[offset, offset + len)` **without** growing the
/// file's logical length (`FALLOC_FL_KEEP_SIZE`).
///
/// Pinning `i_size` is the whole trick that makes preallocation invisible to
/// crash recovery: the WAL's logical end stays equal to its real data length,
/// so [`WalReader`](super::reader::WalReader)'s EOF scan never walks into a
/// zero-filled reserved tail (a `0x00` type byte would otherwise decode to an
/// "Invalid record type" error and abort recovery). This is why we cannot use
/// `fs2::allocate` here — it calls `posix_fallocate`, which *extends* `i_size`.
///
/// Linux-only; other targets return [`io::ErrorKind::Unsupported`] so the
/// caller disables the optimization silently.
#[cfg(target_os = "linux")]
fn reserve_wal_blocks(file: &File, offset: u64, len: u64) -> io::Result<()> {
    use std::os::unix::io::AsRawFd;
    if len == 0 {
        return Ok(());
    }
    // SAFETY: `file` owns a valid fd for the duration of the call; fallocate
    // only mutates block reservations for that fd, never process memory.
    let ret = unsafe {
        libc::fallocate(
            file.as_raw_fd(),
            libc::FALLOC_FL_KEEP_SIZE,
            offset as libc::off_t,
            len as libc::off_t,
        )
    };
    if ret == 0 {
        Ok(())
    } else {
        Err(io::Error::last_os_error())
    }
}

#[cfg(not(target_os = "linux"))]
fn reserve_wal_blocks(_file: &File, _offset: u64, _len: u64) -> io::Result<()> {
    Err(io::Error::new(
        io::ErrorKind::Unsupported,
        "WAL preallocation is only implemented on linux",
    ))
}

/// Whether a `fallocate` failure means "this filesystem can't preallocate"
/// (tmpfs, overlayfs, many network filesystems) rather than a real I/O error.
/// Those are soft failures that flip the feature off; anything else is left to
/// the normal write path to surface (e.g. a genuine `ENOSPC`).
fn fallocate_unsupported(err: &io::Error) -> bool {
    if err.kind() == io::ErrorKind::Unsupported {
        return true;
    }
    #[cfg(target_os = "linux")]
    {
        matches!(
            err.raw_os_error(),
            Some(libc::EOPNOTSUPP) | Some(libc::ENOSYS) | Some(libc::EINVAL)
        )
    }
    #[cfg(not(target_os = "linux"))]
    {
        false
    }
}

/// Writer for the Write-Ahead Log
///
/// Wraps the underlying file in a [`BufWriter`] so each `append` does
/// not pay a write syscall — bytes accumulate in a 64 KiB user-space
/// buffer until `sync()` (or `flush_until()`) drains them and then
/// calls `sync_data()`/`sync_all()` on the raw file. This is how postgres turns
/// per-record append cost from ~500 ns down to ~5 ns; reddb's previous
/// per-append `write_all` directly to the file paid the syscall on
/// every record.
///
/// **Critical contract:** every code path that syncs the underlying
/// file *must* drain the [`BufWriter`] first via
/// `BufWriter::flush()`. Otherwise the bytes in user-space never reach
/// the kernel before fsync, and durability is silently broken.
pub struct WalWriter {
    file: BufWriter<File>,
    /// Cloned file descriptor for `sync_all()` outside the writer
    /// mutex. Both this and `file`'s inner `File` point at the same
    /// kernel inode; calling `sync_all()` on either flushes ALL
    /// pending bytes for that inode. This is the trick that lets
    /// the group-commit leader release the WAL writer lock during
    /// the expensive fsync — see [`WalWriter::drain_for_group_sync`].
    ///
    /// Without this clone, a leader holding the writer mutex during
    /// `sync_all()` blocks every other writer from appending,
    /// defeating the entire purpose of group commit.
    sync_handle: Arc<File>,
    /// Log Sequence Number — byte offset of the next record. Advances
    /// every `append`; survives across restarts via `seek(End)`.
    current_lsn: u64,
    /// Highest LSN that has been `sync_all()`'d to disk. The WAL-first
    /// flush invariant relies on this: a page with `header.lsn = L` may
    /// only be written to its data file once `durable_lsn >= L`.
    /// See `src/storage/cache/README.md` § Invariant 2 and the Target 3
    /// section of `PLAN.md`.
    durable_lsn: u64,
    /// WAL byte frontier covered by the last full file sync. Appends that stay
    /// inside this synced preallocation range can use `sync_data()`; crossing
    /// it, or syncing after fresh preallocation metadata, falls back to
    /// `sync_all()`.
    last_synced_size: u64,
    /// Exclusive byte offset up to which disk blocks are pre-reserved via
    /// `fallocate(FALLOC_FL_KEEP_SIZE)`. Advances one
    /// [`reddb_file::MAIN_WAL_SEGMENT_BYTES`]
    /// segment at a time as `current_lsn` approaches it (issue #893). Reset to
    /// `0` on [`truncate`](Self::truncate) — which frees the blocks — and
    /// immediately re-extended (the checkpoint re-extend path).
    preallocated_to: u64,
    /// Cleared the first time `fallocate` reports the backing filesystem can't
    /// preallocate (tmpfs/overlay/NFS → `EOPNOTSUPP`/`ENOSYS`, or any non-Linux
    /// target) so we stop issuing syscalls that will always fail. Preallocation
    /// is a best-effort optimization; clearing this never affects correctness.
    prealloc_supported: bool,
    /// Set when `fallocate(FALLOC_FL_KEEP_SIZE)` successfully reserved a new
    /// range and that allocation metadata has not yet been covered by a full
    /// sync.
    prealloc_metadata_dirty: bool,
    #[cfg(test)]
    last_sync_method: Option<WalSyncMethod>,
}

impl WalWriter {
    /// Open a WAL file for writing. Creates it if it doesn't exist.
    pub fn open<P: AsRef<Path>>(path: P) -> io::Result<Self> {
        let exists = path.as_ref().exists();

        // We do all initial bookkeeping (write header, seek to EOF) on
        // the raw `File` BEFORE wrapping in a BufWriter so we don't
        // have to worry about flush ordering during construction.
        let mut raw = OpenOptions::new()
            .read(true)
            .create(true)
            .append(true)
            .open(path)?;

        let current_lsn = if !exists || raw.metadata()?.len() == 0 {
            raw.write_all(&reddb_file::encode_wal_file_header())?;
            raw.sync_all()?;
            reddb_file::WAL_FILE_HEADER_BYTES as u64
        } else {
            // Existing file, set LSN to current end. Append-mode files
            // ignore this seek for *writes*, but we use the returned
            // position as our LSN counter.
            raw.seek(SeekFrom::End(0))?
        };

        // Clone the file handle BEFORE wrapping in BufWriter. The
        // clone shares the same kernel file description, so
        // sync_all() on either descriptor flushes the whole inode.
        // The BufWriter owns the original; the Arc<File> is shared
        // with the group-commit leader.
        let sync_handle = Arc::new(raw.try_clone()?);
        let file = BufWriter::with_capacity(WAL_BUFFER_BYTES, raw);

        // On open, every byte already on disk is by definition durable
        // (any pre-crash unflushed tail was lost when the OS dropped
        // page cache). Initialise `durable_lsn` to `current_lsn`.
        let mut writer = Self {
            file,
            sync_handle,
            current_lsn,
            durable_lsn: current_lsn,
            last_synced_size: current_lsn,
            preallocated_to: 0,
            prealloc_supported: true,
            prealloc_metadata_dirty: false,
            #[cfg(test)]
            last_sync_method: None,
        };
        // Reserve the first segment up front so the very first appends land in
        // contiguous extents rather than growing the file page-by-page.
        writer.ensure_preallocated()?;
        Ok(writer)
    }

    /// Ensure disk blocks are reserved at least up to the next segment
    /// boundary above the current write frontier (`current_lsn`).
    ///
    /// Cheap (pure arithmetic) until the frontier crosses a
    /// [`reddb_file::MAIN_WAL_SEGMENT_BYTES`] boundary, at which point it issues a single
    /// `fallocate`. Best-effort: a filesystem that can't preallocate disables
    /// the feature; a transient error is swallowed so a write never fails
    /// because preallocation hiccuped (the write path surfaces a genuine
    /// `ENOSPC` on its own). Never grows the file's logical length, so it is
    /// invisible to crash recovery.
    fn ensure_preallocated(&mut self) -> io::Result<()> {
        if !self.prealloc_supported {
            return Ok(());
        }
        let target = reddb_file::next_main_wal_segment_boundary(self.current_lsn);
        if target <= self.preallocated_to {
            return Ok(());
        }
        let from = self.preallocated_to;
        match reserve_wal_blocks(self.file.get_ref(), from, target - from) {
            Ok(()) => {
                self.preallocated_to = target;
                self.prealloc_metadata_dirty = true;
            }
            Err(ref e) if fallocate_unsupported(e) => self.prealloc_supported = false,
            Err(_) => {
                // Best-effort: leave `preallocated_to` as-is and retry at the
                // next boundary. Never propagate.
            }
        }
        Ok(())
    }

    /// Append a record to the WAL.
    ///
    /// Bytes go into the BufWriter — they are NOT durable on disk
    /// after this call returns. Callers that need durability must
    /// follow up with [`WalWriter::sync`] or
    /// [`WalWriter::flush_until`].
    ///
    /// Returns the LSN (Log Sequence Number) of the record.
    pub fn append(&mut self, record: &WalRecord) -> io::Result<u64> {
        let bytes = record.encode();
        self.file.write_all(&bytes)?;

        let record_lsn = self.current_lsn;
        self.current_lsn += bytes.len() as u64;

        self.ensure_preallocated()?;
        Ok(record_lsn)
    }

    /// Write already-encoded bytes and advance the LSN counter to
    /// match. Used by the lock-free append path: writers encode +
    /// atomically reserve an LSN range outside this writer, the
    /// group-commit coordinator drains the pending queue in LSN
    /// order, then calls `append_bytes` for each batch.
    ///
    /// The bytes MUST be a valid `WalRecord::encode()` payload (or a
    /// concatenation of such) — no structural validation happens
    /// here. The caller is responsible for keeping the on-disk
    /// byte offset synchronised with the externally-tracked LSN
    /// counter; this method just appends and advances.
    pub fn append_bytes(&mut self, bytes: &[u8]) -> io::Result<u64> {
        self.file.write_all(bytes)?;
        let record_lsn = self.current_lsn;
        self.current_lsn += bytes.len() as u64;
        self.ensure_preallocated()?;
        Ok(record_lsn)
    }

    /// Rewind the writer's LSN counter to a specific value. Used
    /// by the lock-free append path to resync the writer with the
    /// externally-tracked `next_lsn` after a drain batch; the
    /// coordinator knows the exact byte offset it just wrote to
    /// and needs `current_lsn` to match so subsequent direct
    /// callers of `append` stay consistent.
    pub fn set_current_lsn(&mut self, lsn: u64) {
        self.current_lsn = lsn;
    }

    /// Force sync to disk.
    ///
    /// Drains the user-space [`BufWriter`] first, then calls
    /// `sync_all()` on the underlying file so every byte appended
    /// since the last sync is durable. Updates `durable_lsn` so
    /// subsequent `flush_until` calls become no-ops up to
    /// `current_lsn`.
    pub fn sync(&mut self) -> io::Result<()> {
        self.file.flush()?;
        self.sync_flushed_file()?;
        self.durable_lsn = self.current_lsn;
        Ok(())
    }

    /// Ensure the WAL is durable on disk at least up to byte offset
    /// `target`. No-op when `target <= durable_lsn`.
    ///
    /// This is the postgres `XLogFlush(LSN)` analogue. Pager flush
    /// paths call this with `max(dirty.header.lsn)` before writing
    /// any data page so the WAL record describing the change is
    /// guaranteed to be on disk before the page itself.
    pub fn flush_until(&mut self, target: u64) -> io::Result<()> {
        if self.durable_lsn >= target {
            return Ok(());
        }
        self.file.flush()?;
        self.sync_flushed_file()?;
        self.durable_lsn = self.current_lsn;
        Ok(())
    }

    fn sync_flushed_file(&mut self) -> io::Result<()> {
        let method = self.next_sync_method();
        match method {
            WalSyncMethod::Data => self.file.get_ref().sync_data()?,
            WalSyncMethod::All => self.file.get_ref().sync_all()?,
        }
        self.mark_sync_complete(method, self.current_lsn);
        Ok(())
    }

    fn next_sync_method(&self) -> WalSyncMethod {
        if !self.prealloc_metadata_dirty && self.current_lsn <= self.last_synced_size {
            WalSyncMethod::Data
        } else {
            WalSyncMethod::All
        }
    }

    fn mark_sync_complete(&mut self, method: WalSyncMethod, lsn: u64) {
        match method {
            WalSyncMethod::Data => {}
            WalSyncMethod::All => {
                self.last_synced_size = self.preallocated_to.max(lsn);
                self.prealloc_metadata_dirty = false;
            }
        }
        #[cfg(test)]
        {
            self.last_sync_method = Some(method);
        }
    }

    /// Highest byte offset that is durable on disk. Used by the pager
    /// to decide whether a `flush_until` call would actually need a
    /// `fsync`.
    pub fn durable_lsn(&self) -> u64 {
        self.durable_lsn
    }

    /// Get current LSN (end of file offset)
    pub fn current_lsn(&self) -> u64 {
        self.current_lsn
    }

    /// Drain the BufWriter into the kernel and return the captured
    /// LSN plus a cloned file handle and sync method for the caller
    /// **without holding the WAL writer mutex**.
    ///
    /// Used by the group-commit leader path. The flow is:
    ///
    /// 1. Take the WAL writer mutex.
    /// 2. Call this method — drains user-space buffer to the kernel
    ///    and captures a size-aware sync plan.
    /// 3. Release the WAL writer mutex.
    /// 4. Execute the sync plan — this is the expensive ~100 µs syscall,
    ///    and other writers can keep appending while it runs.
    /// 5. Take the WAL writer mutex briefly and call
    ///    [`WalWriter::mark_durable`] to publish the new durable position.
    ///
    /// The cloned `sync_handle` shares the same kernel inode with
    /// the writer's `file`, so syncing the clone flushes bytes that
    /// have reached the kernel for that file.
    /// This is the coalescing window that makes group commit win.
    pub(crate) fn drain_for_group_sync(&mut self) -> io::Result<WalGroupSync> {
        // Drain user-space buffer into the kernel.
        self.file.flush()?;
        Ok(WalGroupSync {
            target_lsn: self.current_lsn,
            sync_handle: Arc::clone(&self.sync_handle),
            method: self.next_sync_method(),
        })
    }

    /// Manually advance `durable_lsn` after a successful out-of-lock
    /// sync performed via [`WalWriter::drain_for_group_sync`].
    ///
    /// Monotonic — never lowers `durable_lsn`. Safe to call with a
    /// stale `lsn`; just becomes a no-op.
    pub(crate) fn mark_durable(&mut self, sync: &WalGroupSync) {
        let lsn = sync.target_lsn;
        if lsn > self.durable_lsn {
            self.durable_lsn = lsn;
        }
        self.mark_sync_complete(sync.method, lsn);
    }

    /// Truncate the WAL (usually after checkpoint).
    ///
    /// Drains the BufWriter first so no pending bytes hit the file
    /// after the truncate. Then resets the underlying file, rewrites
    /// the header through the buffered writer (header is small; the
    /// followup `flush + sync_all` makes it durable), and resets
    /// LSN bookkeeping.
    pub fn truncate(&mut self) -> io::Result<()> {
        // Drop any pending bytes BEFORE the truncate; otherwise the
        // BufWriter would flush them to a re-shrunken file in
        // confused order.
        self.file.flush()?;

        {
            let raw = self.file.get_mut();
            raw.set_len(0)?;
            raw.seek(SeekFrom::Start(0))?;
        }

        // Rewrite header through the BufWriter then drain.
        self.file.write_all(&reddb_file::encode_wal_file_header())?;
        self.file.flush()?;
        self.file.get_ref().sync_all()?;

        self.current_lsn = reddb_file::WAL_FILE_HEADER_BYTES as u64;
        self.durable_lsn = reddb_file::WAL_FILE_HEADER_BYTES as u64;
        self.last_synced_size = reddb_file::WAL_FILE_HEADER_BYTES as u64;
        self.prealloc_metadata_dirty = false;
        #[cfg(test)]
        {
            self.last_sync_method = Some(WalSyncMethod::All);
        }

        // `set_len(0)` freed every reserved block, so the WAL would otherwise
        // grow page-by-page again from here. Re-extend a fresh segment now —
        // this is the "truncate/re-extend on checkpoint" half of issue #893.
        self.preallocated_to = 0;
        self.ensure_preallocated()?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::path::PathBuf;

    struct FileGuard {
        path: PathBuf,
    }

    impl Drop for FileGuard {
        fn drop(&mut self) {
            let _ = std::fs::remove_file(&self.path);
        }
    }

    fn temp_wal(name: &str) -> (FileGuard, PathBuf) {
        let path = reddb_file::layout::wal_component_temp_path(
            &std::env::temp_dir(),
            "writer",
            name,
            std::process::id(),
        );
        let guard = FileGuard { path: path.clone() };
        let _ = std::fs::remove_file(&path);
        (guard, path)
    }

    #[test]
    fn test_create_new_wal() {
        let (_guard, path) = temp_wal("create");
        let writer = WalWriter::open(&path).expect("open() should succeed");

        // Should start at LSN 8 (after 8-byte header)
        assert_eq!(writer.current_lsn(), 8);
        assert!(path.exists());
    }

    #[test]
    fn test_append_record() {
        let (_guard, path) = temp_wal("append");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");

        let record = WalRecord::Begin { tx_id: 42 };
        let lsn = writer.append(&record).expect("append() should succeed");

        // First record starts at LSN 8
        assert_eq!(lsn, 8);

        // Next record should start after encoded size
        // Begin record: 1 (type) + 8 (term) + 8 (tx_id) + 4 (checksum) = 21 bytes
        assert_eq!(writer.current_lsn(), 8 + 21);
    }

    #[test]
    fn test_append_multiple_records() {
        let (_guard, path) = temp_wal("multi");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");

        let lsn1 = writer
            .append(&WalRecord::Begin { tx_id: 1 })
            .expect("append() should succeed");
        let lsn2 = writer
            .append(&WalRecord::Begin { tx_id: 2 })
            .expect("append() should succeed");
        let lsn3 = writer
            .append(&WalRecord::Commit { tx_id: 1 })
            .expect("append() should succeed");

        assert_eq!(lsn1, 8);
        assert_eq!(lsn2, 8 + 21);
        assert_eq!(lsn3, 8 + 21 + 21);
    }

    #[test]
    fn test_page_write_lsn() {
        let (_guard, path) = temp_wal("pagewrite");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");

        // First record
        let lsn1 = writer
            .append(&WalRecord::Begin { tx_id: 1 })
            .expect("append() should succeed");
        assert_eq!(lsn1, 8);

        // PageWrite record: 1 + 8 + 4 + 4 + data_len + 4 = 21 + data_len
        let data = vec![1, 2, 3, 4, 5];
        let lsn2 = writer
            .append(&WalRecord::PageWrite {
                tx_id: 1,
                page_id: 100,
                data: data.clone(),
            })
            .expect("value is present");

        assert_eq!(lsn2, 8 + 21); // after Begin

        // Next LSN = lsn2 + (1 + 8 + 8 + 4 + 4 + 5 + 4) = lsn2 + 34
        assert_eq!(writer.current_lsn(), 8 + 21 + 34);
    }

    #[test]
    fn test_sync() {
        let (_guard, path) = temp_wal("sync");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");

        writer
            .append(&WalRecord::Begin { tx_id: 1 })
            .expect("append() should succeed");
        writer.sync().expect("sync() should succeed");

        // File should be synced, just verify no error
        assert!(path.exists());
    }

    #[test]
    fn test_truncate() {
        let (_guard, path) = temp_wal("truncate");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");

        // Write some records
        writer
            .append(&WalRecord::Begin { tx_id: 1 })
            .expect("append() should succeed");
        writer
            .append(&WalRecord::PageWrite {
                tx_id: 1,
                page_id: 0,
                data: vec![0; 100],
            })
            .expect("value is present");
        writer
            .append(&WalRecord::Commit { tx_id: 1 })
            .expect("append() should succeed");

        let lsn_before = writer.current_lsn();
        assert!(lsn_before > 8);

        // Truncate
        writer.truncate().expect("truncate() should succeed");

        // LSN should be back to 8
        assert_eq!(writer.current_lsn(), 8);

        // File should be 8 bytes (just header)
        let len = std::fs::metadata(&path)
            .expect("metadata() should succeed")
            .len();
        assert_eq!(len, 8);
    }

    #[test]
    fn test_reopen_existing() {
        let (_guard, path) = temp_wal("reopen");

        // Create and write
        let lsn_after_write;
        {
            let mut writer = WalWriter::open(&path).expect("open() should succeed");
            writer
                .append(&WalRecord::Begin { tx_id: 1 })
                .expect("append() should succeed");
            writer
                .append(&WalRecord::Commit { tx_id: 1 })
                .expect("append() should succeed");
            lsn_after_write = writer.current_lsn();
        }

        // Reopen
        {
            let writer = WalWriter::open(&path).expect("open() should succeed");
            // Should continue from where we left off
            assert_eq!(writer.current_lsn(), lsn_after_write);
        }
    }

    #[test]
    fn test_checkpoint_record() {
        let (_guard, path) = temp_wal("checkpoint");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");

        // Checkpoint is same size as Begin (1 + 8 + 8 + 4 = 21)
        let lsn = writer
            .append(&WalRecord::Checkpoint { lsn: 12345 })
            .expect("value is present");
        assert_eq!(lsn, 8);
        assert_eq!(writer.current_lsn(), 8 + 21);
    }

    // -----------------------------------------------------------------
    // Target 3: durable_lsn / flush_until tests
    // -----------------------------------------------------------------

    #[test]
    fn fresh_wal_has_durable_lsn_at_header_end() {
        let (_guard, path) = temp_wal("durable_init");
        let writer = WalWriter::open(&path).expect("open() should succeed");
        assert_eq!(writer.durable_lsn(), 8);
        assert_eq!(writer.current_lsn(), 8);
    }

    #[test]
    fn flush_until_below_durable_is_noop() {
        let (_guard, path) = temp_wal("flush_noop");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        // After open, durable_lsn == 8.
        let before = writer.durable_lsn();
        writer.flush_until(0).expect("flush_until() should succeed");
        writer.flush_until(8).expect("flush_until() should succeed");
        assert_eq!(writer.durable_lsn(), before);
    }

    #[test]
    fn flush_until_advances_durable_to_current() {
        let (_guard, path) = temp_wal("flush_advance");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        writer
            .append(&WalRecord::Begin { tx_id: 7 })
            .expect("append() should succeed");
        writer
            .append(&WalRecord::Commit { tx_id: 7 })
            .expect("append() should succeed");
        let target = writer.current_lsn();
        // Before flush_until, durable still at the header.
        assert_eq!(writer.durable_lsn(), 8);
        writer
            .flush_until(target)
            .expect("flush_until() should succeed");
        assert_eq!(writer.durable_lsn(), target);
    }

    #[test]
    fn flush_until_is_monotonic() {
        let (_guard, path) = temp_wal("flush_monotonic");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        writer
            .append(&WalRecord::Begin { tx_id: 1 })
            .expect("append() should succeed");
        let lo = writer.current_lsn();
        writer
            .flush_until(lo)
            .expect("flush_until() should succeed");
        let durable_after_lo = writer.durable_lsn();
        writer
            .append(&WalRecord::Commit { tx_id: 1 })
            .expect("append() should succeed");
        let hi = writer.current_lsn();
        writer
            .flush_until(hi)
            .expect("flush_until() should succeed");
        assert!(writer.durable_lsn() >= durable_after_lo);
        // Calling flush_until(lo) after flush_until(hi) is a no-op.
        writer
            .flush_until(lo)
            .expect("flush_until() should succeed");
        assert_eq!(writer.durable_lsn(), hi);
    }

    #[test]
    fn sync_advances_durable_lsn_too() {
        let (_guard, path) = temp_wal("sync_durable");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        writer
            .append(&WalRecord::Begin { tx_id: 9 })
            .expect("append() should succeed");
        let before = writer.durable_lsn();
        let after_append = writer.current_lsn();
        assert!(after_append > before);
        writer.sync().expect("sync() should succeed");
        assert_eq!(writer.durable_lsn(), after_append);
    }

    #[test]
    fn sync_all_is_used_when_wal_size_grew() {
        let (_guard, path) = temp_wal("sync_all_grew");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");

        writer
            .append(&WalRecord::Begin { tx_id: 1 })
            .expect("append() should succeed");
        writer.sync().expect("sync() should succeed");

        assert_eq!(writer.last_sync_method, Some(WalSyncMethod::All));
        assert!(writer.last_synced_size >= writer.current_lsn());
        assert!(!writer.prealloc_metadata_dirty);
    }

    #[test]
    fn sync_all_is_used_for_metadata_only_preallocation() {
        let (_guard, path) = temp_wal("sync_all_prealloc_metadata");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        if !writer.prealloc_supported {
            return;
        }

        assert_eq!(writer.current_lsn(), 8);
        assert!(writer.prealloc_metadata_dirty);

        writer.sync().expect("sync() should succeed");

        assert_eq!(writer.last_sync_method, Some(WalSyncMethod::All));
        assert_eq!(writer.last_synced_size, writer.preallocated_to);
        assert!(!writer.prealloc_metadata_dirty);
    }

    #[test]
    fn sync_data_is_used_when_wal_size_is_unchanged() {
        let (_guard, path) = temp_wal("sync_data_unchanged");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");

        writer
            .append(&WalRecord::Begin { tx_id: 1 })
            .expect("append() should succeed");
        writer.sync().expect("sync() should succeed");
        let synced_size = writer.last_synced_size;
        writer.sync().expect("sync() should succeed");

        assert_eq!(writer.last_sync_method, Some(WalSyncMethod::Data));
        assert_eq!(writer.last_synced_size, synced_size);
        assert_eq!(writer.durable_lsn(), writer.current_lsn());
    }

    #[test]
    fn sync_data_is_used_for_appends_within_synced_preallocation() {
        let (_guard, path) = temp_wal("sync_data_preallocated_append");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        if !writer.prealloc_supported {
            return;
        }

        writer
            .append(&WalRecord::Begin { tx_id: 1 })
            .expect("append() should succeed");
        writer.sync().expect("sync() should succeed");
        assert_eq!(writer.last_sync_method, Some(WalSyncMethod::All));

        writer
            .append(&WalRecord::Commit { tx_id: 1 })
            .expect("append() should succeed");
        writer.sync().expect("sync() should succeed");

        assert_eq!(writer.last_sync_method, Some(WalSyncMethod::Data));
        assert_eq!(writer.durable_lsn(), writer.current_lsn());
        assert!(writer.current_lsn() <= writer.last_synced_size);
    }

    #[test]
    fn group_sync_uses_sync_data_within_synced_preallocation() {
        let (_guard, path) = temp_wal("group_sync_data_preallocated_append");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        if !writer.prealloc_supported {
            return;
        }

        writer
            .append(&WalRecord::Begin { tx_id: 1 })
            .expect("append() should succeed");
        writer.sync().expect("sync() should succeed");
        assert_eq!(writer.last_sync_method, Some(WalSyncMethod::All));

        writer
            .append(&WalRecord::Commit { tx_id: 1 })
            .expect("append() should succeed");
        let sync = writer
            .drain_for_group_sync()
            .expect("drain_for_group_sync() should succeed");
        assert_eq!(sync.method, WalSyncMethod::Data);
        sync.sync().expect("sync() should succeed");
        writer.mark_durable(&sync);

        assert_eq!(writer.last_sync_method, Some(WalSyncMethod::Data));
        assert_eq!(writer.durable_lsn(), writer.current_lsn());
    }

    #[test]
    fn truncate_resets_durable_lsn() {
        let (_guard, path) = temp_wal("truncate_durable");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        writer
            .append(&WalRecord::Begin { tx_id: 1 })
            .expect("append() should succeed");
        writer.sync().expect("sync() should succeed");
        assert!(writer.durable_lsn() > 8);
        writer.truncate().expect("truncate() should succeed");
        assert_eq!(writer.durable_lsn(), 8);
        assert_eq!(writer.current_lsn(), 8);
    }

    #[test]
    fn reopen_initialises_durable_to_current() {
        let (_guard, path) = temp_wal("reopen_durable");
        {
            let mut writer = WalWriter::open(&path).expect("open() should succeed");
            writer
                .append(&WalRecord::Begin { tx_id: 1 })
                .expect("append() should succeed");
            writer.sync().expect("sync() should succeed");
        }
        let writer = WalWriter::open(&path).expect("open() should succeed");
        // After reopen, every byte on disk is durable by definition.
        assert_eq!(writer.durable_lsn(), writer.current_lsn());
    }

    // -----------------------------------------------------------------
    // Perf 1.1: BufWriter coalesces small appends until sync
    // -----------------------------------------------------------------

    #[test]
    fn bufwriter_coalesces_until_sync() {
        // Append 100 small records but DO NOT sync. The on-disk file
        // size must still equal the header (8 bytes) because the
        // bytes are sitting in the BufWriter, not in the kernel.
        let (_guard, path) = temp_wal("bufwriter_coalesce");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        for tx in 0..100u64 {
            writer
                .append(&WalRecord::Begin { tx_id: tx })
                .expect("append() should succeed");
        }
        // current_lsn reflects the in-buffer position.
        assert_eq!(writer.current_lsn(), 8 + 100 * 21);
        // But the file on disk only has the header.
        let on_disk = std::fs::metadata(&path)
            .expect("metadata() should succeed")
            .len();
        assert_eq!(on_disk, 8, "BufWriter leaked bytes to disk before sync");
    }

    #[test]
    fn sync_drains_bufwriter_before_fsync() {
        // After sync(), the file size must equal current_lsn — the
        // BufWriter has been flushed and sync_all has hit the kernel.
        let (_guard, path) = temp_wal("sync_drains");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        for tx in 0..50u64 {
            writer
                .append(&WalRecord::Begin { tx_id: tx })
                .expect("append() should succeed");
        }
        writer.sync().expect("sync() should succeed");
        let on_disk = std::fs::metadata(&path)
            .expect("metadata() should succeed")
            .len();
        assert_eq!(on_disk, writer.current_lsn());
        assert_eq!(writer.durable_lsn(), writer.current_lsn());
    }

    #[test]
    fn flush_until_drains_bufwriter_too() {
        // flush_until must drain the BufWriter before calling
        // sync_all on the underlying file — otherwise pending bytes
        // never become durable.
        let (_guard, path) = temp_wal("flush_until_drains");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        for tx in 0..30u64 {
            writer
                .append(&WalRecord::Begin { tx_id: tx })
                .expect("append() should succeed");
        }
        let target = writer.current_lsn();
        writer
            .flush_until(target)
            .expect("flush_until() should succeed");
        let on_disk = std::fs::metadata(&path)
            .expect("metadata() should succeed")
            .len();
        assert_eq!(on_disk, target);
        assert_eq!(writer.durable_lsn(), target);
    }

    #[test]
    fn truncate_drains_pending_bufwriter_bytes_first() {
        // If truncate did NOT drain BufWriter first, the pending bytes
        // would either land in the post-truncate file (corrupting it
        // with stale records) or be lost. Verify the resulting file
        // contains only a fresh header.
        let (_guard, path) = temp_wal("truncate_drain");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        // Write enough small records to fill some of the 64 KiB buffer
        // but stay below the auto-flush threshold.
        for tx in 0..200u64 {
            writer
                .append(&WalRecord::Begin { tx_id: tx })
                .expect("append() should succeed");
        }
        // Sanity: bytes are buffered.
        assert_eq!(
            std::fs::metadata(&path)
                .expect("metadata() should succeed")
                .len(),
            8
        );

        writer.truncate().expect("truncate() should succeed");
        // After truncate the file is just the header again.
        let on_disk = std::fs::metadata(&path)
            .expect("metadata() should succeed")
            .len();
        assert_eq!(on_disk, 8);
        assert_eq!(writer.current_lsn(), 8);
        assert_eq!(writer.durable_lsn(), 8);

        // And we can append again successfully.
        writer
            .append(&WalRecord::Begin { tx_id: 99 })
            .expect("append() should succeed");
        writer.sync().expect("sync() should succeed");
        assert_eq!(
            std::fs::metadata(&path)
                .expect("metadata() should succeed")
                .len(),
            8 + 21
        );
    }

    #[test]
    fn reopen_sees_only_synced_records() {
        // Records that were appended but never sync'd must NOT
        // survive a reopen — they lived in the BufWriter, never made
        // it to the kernel, and the previous WalWriter went out of
        // scope. The new WalWriter reopens the file and reads from
        // EOF, which reflects only the bytes that hit disk.
        //
        // We sync some records, then drop the writer mid-buffer, and
        // assert the reopen LSN matches only the synced prefix.
        let (_guard, path) = temp_wal("reopen_synced_only");
        let synced_lsn;
        {
            let mut writer = WalWriter::open(&path).expect("open() should succeed");
            writer
                .append(&WalRecord::Begin { tx_id: 1 })
                .expect("append() should succeed");
            writer.sync().expect("sync() should succeed");
            synced_lsn = writer.current_lsn();
            // These records are never sync'd before drop. Drop runs
            // BufWriter::flush which DOES write them — see note below.
            for tx in 100..120u64 {
                writer
                    .append(&WalRecord::Begin { tx_id: tx })
                    .expect("append() should succeed");
            }
            // Without a sync, the in-buffer bytes are still pending.
            // BufWriter's Drop impl does flush to the file but does
            // not call sync_all. For reopen-LSN purposes, on-disk
            // bytes count regardless of fsync, so the reopened LSN
            // will reflect the dropped writes too.
        }
        let writer = WalWriter::open(&path).expect("open() should succeed");
        // The reopen LSN reflects what's physically on disk after
        // BufWriter::Drop flushes its buffer. That may or may not
        // include the unsync'd records depending on platform; the
        // contract we care about is that durable_lsn ≥ synced_lsn.
        assert!(writer.durable_lsn() >= synced_lsn);
    }

    // -----------------------------------------------------------------
    // Issue #893: fallocate-based WAL segment preallocation
    // -----------------------------------------------------------------

    /// On-disk blocks reserved by `fallocate`, in bytes. Returns the
    /// allocated size (st_blocks × 512), independent of the logical length.
    fn allocated_bytes(path: &std::path::Path) -> u64 {
        use fs2::FileExt;
        let f = std::fs::File::open(path).expect("open() should succeed");
        f.allocated_size().expect("allocated_size() should succeed")
    }

    #[test]
    fn segment_boundary_rounds_strictly_up() {
        // Always lands one boundary ahead so the reservation stays in front
        // of the write frontier.
        assert_eq!(
            reddb_file::next_main_wal_segment_boundary(0),
            reddb_file::MAIN_WAL_SEGMENT_BYTES
        );
        assert_eq!(
            reddb_file::next_main_wal_segment_boundary(8),
            reddb_file::MAIN_WAL_SEGMENT_BYTES
        );
        assert_eq!(
            reddb_file::next_main_wal_segment_boundary(reddb_file::MAIN_WAL_SEGMENT_BYTES - 1),
            reddb_file::MAIN_WAL_SEGMENT_BYTES
        );
        // Exactly on a boundary still advances to the next one.
        assert_eq!(
            reddb_file::next_main_wal_segment_boundary(reddb_file::MAIN_WAL_SEGMENT_BYTES),
            2 * reddb_file::MAIN_WAL_SEGMENT_BYTES
        );
        assert_eq!(
            reddb_file::next_main_wal_segment_boundary(reddb_file::MAIN_WAL_SEGMENT_BYTES + 1),
            2 * reddb_file::MAIN_WAL_SEGMENT_BYTES
        );
    }

    #[test]
    fn open_preallocates_first_segment() {
        // A freshly opened WAL must reserve a whole segment up front instead
        // of growing incrementally (acceptance #1).
        let (_guard, path) = temp_wal("prealloc_open");
        let writer = WalWriter::open(&path).expect("open() should succeed");
        if !writer.prealloc_supported {
            return; // filesystem without fallocate — feature is a no-op.
        }
        assert_eq!(writer.preallocated_to, reddb_file::MAIN_WAL_SEGMENT_BYTES);
        // The reservation is real on disk, yet the logical file is still just
        // the 8-byte header.
        assert!(allocated_bytes(&path) >= reddb_file::MAIN_WAL_SEGMENT_BYTES);
        assert_eq!(
            std::fs::metadata(&path)
                .expect("metadata() should succeed")
                .len(),
            8
        );
    }

    #[test]
    fn preallocation_does_not_grow_logical_length() {
        // The load-bearing invariant for crash recovery: appending records
        // must NOT inflate the logical file size beyond the real data, or the
        // EOF scan in WalReader would walk into the reserved tail. Holds on
        // every filesystem (fallocate keeps i_size pinned; absent fallocate
        // there is no reservation at all).
        let (_guard, path) = temp_wal("prealloc_logical");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        for tx in 0..50u64 {
            writer
                .append(&WalRecord::Begin { tx_id: tx })
                .expect("append() should succeed");
        }
        writer.sync().expect("sync() should succeed");
        let logical = std::fs::metadata(&path)
            .expect("metadata() should succeed")
            .len();
        assert_eq!(logical, 8 + 50 * 21, "preallocation inflated i_size");
        assert_eq!(writer.current_lsn(), logical);
    }

    #[test]
    fn truncate_re_extends_a_fresh_segment() {
        // After checkpoint truncation the WAL must re-extend rather than grow
        // unbounded page-by-page (acceptance #2).
        let (_guard, path) = temp_wal("prealloc_truncate");
        let mut writer = WalWriter::open(&path).expect("open() should succeed");
        writer
            .append(&WalRecord::Begin { tx_id: 1 })
            .expect("append() should succeed");
        writer.sync().expect("sync() should succeed");

        writer.truncate().expect("truncate() should succeed");

        assert_eq!(writer.current_lsn(), 8);
        assert_eq!(
            std::fs::metadata(&path)
                .expect("metadata() should succeed")
                .len(),
            8
        );
        if writer.prealloc_supported {
            assert_eq!(writer.preallocated_to, reddb_file::MAIN_WAL_SEGMENT_BYTES);
            assert!(allocated_bytes(&path) >= reddb_file::MAIN_WAL_SEGMENT_BYTES);
        }
    }

    #[test]
    fn preallocated_wal_recovers_records_without_trailing_garbage() {
        // End-to-end: a preallocated WAL must read back exactly the records
        // written — the reserved (unwritten) tail must be invisible to the
        // reader, proving crash-recovery is unchanged (acceptance #3).
        use super::super::reader::WalReader;
        let (_guard, path) = temp_wal("prealloc_recover");
        {
            let mut writer = WalWriter::open(&path).expect("open() should succeed");
            writer
                .append(&WalRecord::Begin { tx_id: 1 })
                .expect("append() should succeed");
            writer
                .append(&WalRecord::PageWrite {
                    tx_id: 1,
                    page_id: 7,
                    data: vec![1, 2, 3, 4],
                })
                .expect("value is present");
            writer
                .append(&WalRecord::Commit { tx_id: 1 })
                .expect("append() should succeed");
            writer.sync().expect("sync() should succeed");
        }
        let records: Vec<_> = WalReader::open(&path)
            .expect("value is present")
            .iter()
            .collect::<Result<_, _>>()
            .expect("reader must stop cleanly at real EOF, not in reserved tail");
        assert_eq!(records.len(), 3);
        assert_eq!(records[0].1, WalRecord::Begin { tx_id: 1 });
        assert_eq!(records[2].1, WalRecord::Commit { tx_id: 1 });
    }
}