Dunk on NT and Darwin bc they don't use O_DIRECT which causes serious

problems for this project.
Bump crates.
2026-01-02 01:38:36 -05:00 · 2026-01-02 00:49:03 -05:00 · 2026-01-02 00:12:40 -05:00 · 2026-01-01 23:22:26 -05:00 · 2026-01-01 14:40:27 -05:00
8 changed files with 222 additions and 97 deletions
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -4,9 +4,9 @@ version = 4

 [[package]]
 name = "addr2line"
-version = "0.24.2"
+version = "0.25.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dfbe277e56a376000877090da837660b4427aad530e3028d44e0bffe4f89a1c1"
+checksum = "1b5d307320b3181d6d7954e663bd7c774a838b8220fe0593c86d9fb09f498b4b"
 dependencies = [
 "gimli",
 ]
@@ -18,10 +18,54 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "320119579fcad9c21884f5c4861d16174d0e06250625266f50fe6898340abefa"

 [[package]]
-name = "anstyle"
-version = "1.0.10"
+name = "anstream"
+version = "0.6.20"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "55cc3b69f167a1ef2e161439aa98aed94e6028e5f9a59be9a6ffb47aef1651f9"
+checksum = "3ae563653d1938f79b1ab1b5e668c87c76a9930414574a6583a7b7e11a8e6192"
+dependencies = [
+ "anstyle",
+ "anstyle-parse",
+ "anstyle-query",
+ "anstyle-wincon",
+ "colorchoice",
+ "is_terminal_polyfill",
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle"
+version = "1.0.13"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5192cca8006f1fd4f7237516f40fa183bb07f8fbdfedaa0036de5ea9b0b45e78"
+
+[[package]]
+name = "anstyle-parse"
+version = "0.2.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4e7644824f0aa2c7b9384579234ef10eb7efb6a0deb83f9630a49594dd9c15c2"
+dependencies = [
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle-query"
+version = "1.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6c8bdeb6047d8983be085bab0ba1472e6dc604e7041dbf6fcd5e71523014fae9"
+dependencies = [
+ "windows-sys",
+]
+
+[[package]]
+name = "anstyle-wincon"
+version = "3.0.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "403f75924867bb1033c59fbf0797484329750cfbe3c4325cd33127941fabc882"
+dependencies = [
+ "anstyle",
+ "once_cell_polyfill",
+ "windows-sys",
+]

 [[package]]
 name = "anyhow"
@@ -34,9 +78,9 @@ dependencies = [

 [[package]]
 name = "backtrace"
-version = "0.3.75"
+version = "0.3.76"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6806a6321ec58106fea15becdad98371e28d92ccbc7c8f1b3b6dd724fe8f1002"
+checksum = "bb531853791a215d7c62a30daf0dde835f381ab5de4589cfe7c649d2cbe92bd6"
 dependencies = [
 "addr2line",
 "cfg-if",
@@ -44,22 +88,16 @@ dependencies = [
 "miniz_oxide",
 "object",
 "rustc-demangle",
- "windows-targets",
+ "windows-link",
 ]

-[[package]]
-name = "base64"
-version = "0.21.7"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9d297deb1925b89f2ccc13d7635fa0714f12c87adce1c75356b39ca9b7178567"
-
 [[package]]
 name = "bitflags"
-version = "2.8.0"
+version = "2.10.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8f68f53c83ab957f72c32642f3868eec03eb974d1fb82e453128456482613d36"
+checksum = "812e12b5285cc515a9c72a5c1d3b6d46a19dac5acfef5265968c166106e31dd3"
 dependencies = [
- "serde",
+ "serde_core",
 ]

 [[package]]
@@ -70,9 +108,9 @@ checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"

 [[package]]
 name = "clap"
-version = "4.5.31"
+version = "4.5.53"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "027bb0d98429ae334a8698531da7077bdf906419543a35a55c2cb1b66437d767"
+checksum = "c9e340e012a1bf4935f5282ed1436d1489548e8f72308207ea5df0e23d2d03f8"
 dependencies = [
 "clap_builder",
 "clap_derive",
@@ -80,10 +118,11 @@ dependencies = [

 [[package]]
 name = "clap_builder"
-version = "4.5.31"
+version = "4.5.53"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5589e0cba072e0f3d23791efac0fd8627b49c829c196a492e88168e6a669d863"
+checksum = "d76b5d13eaa18c901fd2f7fca939fefe3a0727a953561fefdf3b2922b8569d00"
 dependencies = [
+ "anstream",
 "anstyle",
 "clap_lex",
 "strsim",
@@ -91,9 +130,9 @@ dependencies = [

 [[package]]
 name = "clap_derive"
-version = "4.5.28"
+version = "4.5.49"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bf4ced95c6f4a675af3da73304b9ac4ed991640c36374e4b46795c49e17cf1ed"
+checksum = "2a0b5487afeab2deb2ff4e03a807ad1a03ac532ff5a2cee5d86884440c7f7671"
 dependencies = [
 "heck",
 "proc-macro2",
@@ -103,15 +142,21 @@ dependencies = [

 [[package]]
 name = "clap_lex"
-version = "0.7.4"
+version = "0.7.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f46ad14479a25103f283c0f10005961cf086d8dc42205bb44c46ac563475dca6"
+checksum = "a1d728cc89cf3aee9ff92b05e62b19ee65a02b5702cff7d5a377e32c6ae29d8d"
+
+[[package]]
+name = "colorchoice"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b05b61dc5112cbb17e4b6cd61790d9845d13888356391624cbe7e41efeac1e75"

 [[package]]
 name = "gimli"
-version = "0.31.1"
+version = "0.32.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "07e28edb80900c19c28f1072f2e8aeca7fa06b23cd4169cefe1af5aa3260783f"
+checksum = "e629b9b98ef3dd8afe6ca2bd0f89306cec16d43d907889945bc5d6687f2f13c7"

 [[package]]
 name = "heck"
@@ -119,6 +164,12 @@ version = "0.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"

+[[package]]
+name = "is_terminal_polyfill"
+version = "1.70.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf"
+
 [[package]]
 name = "kramer"
 version = "0.1.0"
@@ -153,63 +204,87 @@ dependencies = [

 [[package]]
 name = "object"
-version = "0.36.7"
+version = "0.37.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "62948e14d923ea95ea2c7c86c71013138b66525b86bdc08d2dcc262bdb497b87"
+checksum = "ff76201f031d8863c38aa7f905eca4f53abbfa15f609db4277d44cd8938f33fe"
 dependencies = [
 "memchr",
 ]

 [[package]]
-name = "proc-macro2"
-version = "1.0.92"
+name = "once_cell"
+version = "1.21.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "37d3544b3f2748c54e147655edb5025752e2303145b5aefb3c3ea2c78b973bb0"
+checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d"
+
+[[package]]
+name = "once_cell_polyfill"
+version = "1.70.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a4895175b425cb1f87721b59f0f286c2092bd4af812243672510e1ac53e2e0ad"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.104"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9695f8df41bb4f3d222c95a67532365f569318332d03d5f3f67f37b20e6ebdf0"
 dependencies = [
 "unicode-ident",
 ]

 [[package]]
 name = "quote"
-version = "1.0.37"
+version = "1.0.42"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b5b9d34b8991d19d98081b46eacdd8eb58c6f2b201139f7c5f643cc155a633af"
+checksum = "a338cc41d27e6cc6dce6cefc13a0729dfbb81c262b1f519331575dd80ef3067f"
 dependencies = [
 "proc-macro2",
 ]

 [[package]]
 name = "ron"
-version = "0.8.1"
+version = "0.12.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b91f7eff05f748767f183df4320a63d6936e9c6107d97c9e6bdd9784f4289c94"
+checksum = "fd490c5b18261893f14449cbd28cb9c0b637aebf161cd77900bfdedaff21ec32"
 dependencies = [
- "base64",
 "bitflags",
+ "once_cell",
 "serde",
 "serde_derive",
+ "typeid",
+ "unicode-ident",
 ]

 [[package]]
 name = "rustc-demangle"
-version = "0.1.25"
+version = "0.1.26"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "989e6739f80c4ad5b13e0fd7fe89531180375b18520cc8c82080e4dc4035b84f"
+checksum = "56f7d92ca342cea22a06f2121d944b4fd82af56988c270852495420f961d4ace"

 [[package]]
 name = "serde"
-version = "1.0.219"
+version = "1.0.228"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5f0e2c6ed6606019b4e29e69dbaba95b11854410e5347d525002456dbbb786b6"
+checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e"
+dependencies = [
+ "serde_core",
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_core"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad"
 dependencies = [
 "serde_derive",
 ]

 [[package]]
 name = "serde_derive"
-version = "1.0.219"
+version = "1.0.228"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5b0276cf7f2c73365f7157c8123c21cd9a50fbbd844757af28ca1f5925fc2a00"
+checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79"
 dependencies = [
 "proc-macro2",
 "quote",
@@ -224,9 +299,9 @@ checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"

 [[package]]
 name = "syn"
-version = "2.0.89"
+version = "2.0.112"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "44d46482f1c1c87acd84dea20c1bf5ebff4c757009ed6bf19cfd36fb10e92c4e"
+checksum = "21f182278bf2d2bcb3c88b1b08a37df029d71ce3d3ae26168e3c653b213b99d4"
 dependencies = [
 "proc-macro2",
 "quote",
@@ -234,10 +309,37 @@ dependencies = [
 ]

 [[package]]
-name = "unicode-ident"
-version = "1.0.14"
+name = "typeid"
+version = "1.0.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "adb9e6ca4f869e1180728b7950e35922a7fc6397f7b641499e8f3ef06e50dc83"
+checksum = "bc7d623258602320d5c55d1bc22793b57daff0ec7efc270ea7d55ce1d5f5471c"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9312f7c4f6ff9069b165498234ce8be658059c6728633667c526e27dc2cf1df5"
+
+[[package]]
+name = "utf8parse"
+version = "0.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
+
+[[package]]
+name = "windows-link"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
+
+[[package]]
+name = "windows-sys"
+version = "0.59.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"
+dependencies = [
+ "windows-targets",
+]

 [[package]]
 name = "windows-targets"
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -2,40 +2,29 @@
 name = "kramer"
 version = "0.1.0"
 edition = "2024"
+authors = ["Olivia Brooks"]
+repository = "https://gitea.cutieguwu.ca/cutieguwu/kramer"
+license = "MIT"
+publish = false

 [dependencies]
-libc = "0.2.178"
-# NOTE:
-# = X.X.X is the version used in testing.
-# Use this version for greatest compatibility.
-#
-# For clap info, see [dependencies.clap]
-# For serde info, see [dependencies.serde]
-
-ron = "0.8.1, >=0.8, <0.9"
+ron = ">=0.8, <0.13"
 #rust-i18n = "3.1.3"

 [dependencies.anyhow]
 version = "1.0"
-features = [
-    "backtrace",
-]
+features = ["backtrace"]

 [dependencies.clap]
 version = "4.5"
-default-features = false
-features = [
-    # From default features collection
-    "error-context",
-    "help",
-    "std",
-    "suggestions",
-    "usage",
-
-    # Optional features
-    "derive",
-]
+features = ["derive"]

 [dependencies.serde]
-version = "1.0.219"
+version = "1.0"
 features = ["derive"]
+
+[target.'cfg(all(unix, not(target_os = "macos")))'.dependencies]
+# Yes. For one constant, this library is required.
+# And yes, I spent time tracking down the first release with that constant.
+# v0.2.25 is almost 9 years old as of writing this comment.
+libc = "~0.2.25"
--- a/src/cli.rs
+++ b/src/cli.rs
@@ -1,8 +1,6 @@
 use std::path::PathBuf;
 use std::sync::LazyLock;

-use crate::FB_SECTOR_SIZE;
-
 use clap::{ArgAction, Parser};

 pub static CONFIG: LazyLock<Args> = LazyLock::new(|| Args::parse());
@@ -22,7 +20,7 @@ pub struct Args {
    pub map: Option<PathBuf>,

    /// Max number of consecutive sectors to test as a group
-    #[arg(short, long, default_value_t = 128)]
+    #[arg(short, long, default_value_t = crate::FB_CLUSTER_LEN)]
    pub cluster_length: usize,

    /// Number of brute force read passes
@@ -30,13 +28,19 @@ pub struct Args {
    pub brute_passes: usize,

    /// Sector size
-    #[arg(short, long, default_value_t = FB_SECTOR_SIZE)]
+    #[arg(short, long, default_value_t = crate::FB_SECTOR_SIZE)]
    pub sector_size: usize,

    // Behaviour is backwards.
    // ArgAction::SetFalse by default evaluates to true,
    // ArgAction::SetTrue by default evaluates to false.
-    /// Whether to reopen the file on a read error or not.
-    #[arg(short, long, action=ArgAction::SetTrue)]
+    /// Upon encountering a read error, reopen the source file before continuing.
+    #[arg(short, long, action = ArgAction::SetTrue)]
    pub reopen_on_error: bool,
+
+    /// Use O_DIRECT to bypass kernel buffer when reading.
+    // BSD seems to support O_DIRECT, but MacOS for certain does not.
+    #[cfg(all(unix, not(target_os = "macos")))]
+    #[arg(short, long = "direct", action = ArgAction::SetFalse)]
+    pub direct_io: bool,
 }
--- a/src/io.rs
+++ b/src/io.rs
@@ -1,6 +1,5 @@
 use std::fs::{File, OpenOptions};
 use std::io::{self, Seek, SeekFrom};
-use std::os::unix::fs::OpenOptionsExt;

 use crate::cli::CONFIG;

@@ -20,21 +19,28 @@ pub fn get_stream_length<S: Seek>(stream: &mut S) -> io::Result<u64> {
    len
 }

+#[cfg(all(unix, not(target_os = "macos")))]
+pub fn load_input() -> anyhow::Result<File> {
+    use std::os::unix::fs::OpenOptionsExt;
+
+    let mut options = OpenOptions::new();
+    options.read(true);
+
+    if CONFIG.direct_io {
+        options.custom_flags(libc::O_DIRECT);
+    }
+
+    options
+        .open(&CONFIG.input)
+        .with_context(|| format!("Failed to open input file: {}", &CONFIG.input.display()))
+}
+
+#[cfg(any(not(unix), target_os = "macos"))]
 pub fn load_input() -> anyhow::Result<File> {
    OpenOptions::new()
        .read(true)
-        .custom_flags(libc::O_DIRECT)
        .open(&CONFIG.input)
        .with_context(|| format!("Failed to open input file: {}", &CONFIG.input.display()))
-
-    /*
-    use std::ffi::CString;
-    use std::os::fd::FromRawFd;
-
-    let path = CString::new(CONFIG.input.to_str().unwrap().to_owned()).unwrap();
-    let flags = libc::O_DIRECT | libc::O_RDONLY;
-    let f = unsafe { File::from_raw_fd(libc::open(path.as_ptr(), flags)) };
-    */
 }

 pub fn load_output() -> anyhow::Result<File> {
@@ -70,3 +76,18 @@ pub fn load_map_write() -> anyhow::Result<File> {
            )
        })
 }
+
+#[repr(C, align(512))]
+pub struct DirectIOBuffer(pub [u8; crate::MAX_BUFFER_SIZE]);
+
+impl Default for DirectIOBuffer {
+    fn default() -> Self {
+        Self([crate::FB_NULL_VALUE; _])
+    }
+}
+
+impl From<[u8; crate::MAX_BUFFER_SIZE]> for DirectIOBuffer {
+    fn from(value: [u8; crate::MAX_BUFFER_SIZE]) -> Self {
+        Self(value)
+    }
+}
--- a/src/main.rs
+++ b/src/main.rs
@@ -9,8 +9,11 @@ use recovery::Recover;
 use anyhow;

 const FB_SECTOR_SIZE: usize = 2048;
+const FB_CLUSTER_LEN: usize = 128;
 const FB_NULL_VALUE: u8 = 0;

+const MAX_BUFFER_SIZE: usize = FB_SECTOR_SIZE * FB_CLUSTER_LEN;
+
 fn main() -> anyhow::Result<()> {
    let mut recover_tool = Recover::new()?;
    recover_tool.run()?;
--- a/src/mapping/cluster.rs
+++ b/src/mapping/cluster.rs
@@ -21,6 +21,7 @@ impl Default for Cluster {
 impl Cluster {
    /// Breaks apart into a vec of clusters,
    /// each of cluster_size, excepting last.
+    #[allow(dead_code)]
    pub fn subdivide(&mut self, cluster_len: usize) -> Vec<Cluster> {
        let domain_len = self.domain.len();
        let mut start = self.domain.start;
@@ -49,6 +50,8 @@ impl Cluster {
        clusters
    }

+    // This is used in unit tests at present. Ideally it probably shouldn't exist.
+    #[allow(dead_code)]
    pub fn set_stage(&mut self, stage: Stage) -> &mut Self {
        self.stage = stage;
        self
--- a/src/mapping/domain.rs
+++ b/src/mapping/domain.rs
@@ -16,6 +16,7 @@ impl Default for Domain {

 impl Domain {
    /// Return length of domain in sectors.
+    #[allow(dead_code)]
    pub fn len(self) -> usize {
        self.end - self.start
    }
--- a/src/recovery.rs
+++ b/src/recovery.rs
@@ -2,13 +2,13 @@ use std::fs::File;
 use std::io::{BufWriter, Read, Seek, SeekFrom, Write};
 use std::usize;

-use anyhow::{Context, anyhow};
+use anyhow::Context;

 use crate::cli::CONFIG;
+use crate::io::DirectIOBuffer;
 use crate::mapping::prelude::*;

 #[derive(Debug)]
-#[allow(dead_code)]
 pub struct Recover {
    input: File,
    output: BufWriter<File>,
@@ -90,11 +90,12 @@ impl Recover {

    /// Attempt to copy all untested blocks.
    fn copy_untested(&mut self) -> anyhow::Result<()> {
+        let mut buf = DirectIOBuffer::default();
+
        for untested in self.map.get_clusters(Stage::Untested) {
            // Caching.
            let mut read_position: usize;
            let mut cluster: Cluster;
-            let mut buf: Vec<u8>;
            let mut buf_capacity = self.get_buf_capacity() as usize;

            dbg!(untested.domain);
@@ -104,7 +105,6 @@ impl Recover {
                dbg!(read_position);

                buf_capacity = buf_capacity.min(untested.domain.end - read_position);
-                buf = vec![crate::FB_NULL_VALUE; buf_capacity];

                cluster = Cluster {
                    domain: Domain {
@@ -114,7 +114,7 @@ impl Recover {
                    stage: Stage::Intact,
                };

-                if let Err(err) = self.input.read_exact(&mut buf) {
+                if let Err(err) = self.input.read_exact(&mut buf.0) {
                    // If buf were zeroed out before every read, one could theoretically recover
                    // part of that read given the assumption that all null values from the end to
                    // the first non-null value are unread, and some further padding from the last
@@ -141,7 +141,7 @@ impl Recover {

                if cluster.stage == Stage::Intact {
                    self.output
-                        .write_all(&buf[0..buf_capacity])
+                        .write_all(&buf.0[0..buf_capacity])
                        .context("Failed to write data to output file")?;
                }

@@ -151,6 +151,8 @@ impl Recover {
            }
        }

+        drop(buf);
+
        self.map.write_to(&mut crate::io::load_map_write()?)?;

        Ok(())
@@ -159,7 +161,7 @@ impl Recover {
    /// Set buffer capacity as cluster length in bytes.
    /// Varies depending on the recovery stage.
    fn get_buf_capacity(&mut self) -> u64 {
-        CONFIG.sector_size as u64 * CONFIG.cluster_length as u64
+        crate::MAX_BUFFER_SIZE.min(CONFIG.sector_size * CONFIG.cluster_length) as u64
    }

    /// Reloads the input and restores the seek position.
Author	SHA1	Message	Date
Cutieguwu	1e80713263	Dunk on NT and Darwin bc they don't use O_DIRECT which causes serious problems for this project.	2026-01-02 01:38:36 -05:00
Cutieguwu	0a0f2f52c0	Bump crates.	2026-01-02 00:49:03 -05:00
Cutieguwu	845d9a3cc9	Cleanup.	2026-01-02 00:12:40 -05:00
Cutieguwu	53d773e2ea	DirectIO is working! Also a bit more cleanup.	2026-01-01 23:22:26 -05:00
Cutieguwu	1607f7ebfa	Update io.rs	2026-01-01 14:40:27 -05:00