slight refactor pre

btrfs/src/lib.rs

@@ -1,3 +1,4 @@
+#![allow(dead_code)]
 #![feature(error_in_core)]
 #![cfg_attr(not(any(feature = "std", test)), no_std)]
 
@@ -16,13 +17,15 @@ use scroll::Pread;
 use thiserror::Error;
 
 use structs::{Chunk, Key, KeyPtr, KnownObjectId, ObjectType, RootItem, Stripe, Superblock};
-use tree::Tree;
+use tree::{PartialKey, Tree};
 
 extern crate alloc;
 
 pub mod crc32c;
+pub mod files;
 pub mod structs;
 pub mod tree;
+pub mod v2;
 
 #[cfg(feature = "std")]
 pub mod std_io {
@@ -33,7 +36,7 @@ pub mod std_io {
     impl<T: Read + Seek> VolumeIo for T {
         fn read(&mut self, dst: &mut [u8], address: u64) -> Result<(), Error> {
             self.seek(std::io::SeekFrom::Start(address))
-                .map_err(|a| Error::SeekFailed)?;
+                .map_err(|a| Error::ReadFailed)?;
             self.read_exact(dst).map_err(|_| Error::ReadFailed)
         }
 
@@ -43,36 +46,7 @@ pub mod std_io {
     }
 }
 
-#[derive(Debug, Error)]
+pub use v2::error::*;
-pub enum Error {
-    #[error("read failed")]
-    ReadFailed,
-    #[error("seek failed")]
-    SeekFailed,
-    #[error("invalid magic signature")]
-    InvalidMagic,
-    #[error("invalid offset")]
-    InvalidOffset,
-    #[error("Expected an internal node")]
-    ExpectedInternalNode,
-    #[error("Expected a leaf node")]
-    ExpectedLeafNode,
-    #[error("Invalid checksum: expected {expected:#?} but got {actual:#?}")]
-    InvalidChecksum {
-        expected: [u8; 32],
-        actual: [u8; 32],
-    },
-    #[error("{0}")]
-    ScrollError(scroll::Error),
-}
-
-impl From<scroll::Error> for Error {
-    fn from(value: scroll::Error) -> Self {
-        Self::ScrollError(value)
-    }
-}
-
-pub type Result<T> = core::result::Result<T, Error>;
 
 pub trait VolumeIo {
     fn read(&mut self, dst: &mut [u8], address: u64) -> Result<()>;
@@ -144,11 +118,13 @@ pub struct Btrfs<R: VolumeIo> {
     roots: BTreeMap<KnownObjectId, RootItem>,
 }
 
+#[derive(Debug)]
 pub struct Root<'a, R: VolumeIo> {
     id: KnownObjectId,
     tree: Tree<'a, R>,
 }
 
+#[derive(Debug)]
 pub struct Volume<'a, R: VolumeIo> {
     fs: &'a Btrfs<R>,
     root: Root<'a, R>,
@@ -357,25 +333,65 @@ impl<R: VolumeIo> Btrfs<R> {
         }
     }
 
-    pub fn find_default_subvol(&self) -> Result<()> {
+    pub fn find_default_subvol(&self) -> Result<Option<Volume<'_, R>>> {
         let root_tree = Tree::from_logical_offset(self, self.superblock().root.get())?;
 
-        let range = root_tree.full_range();
+        let _range = root_tree.full_range();
 
+        // we are looking for the root tree directory (?)
+        // this is a DIR_ITEM entry in the root tree, with the name "default",
+        // and the crc32 of "default" as its offset
         let key = Key::new(
             KnownObjectId::Custom(self.superblock.root_dir_objectid.get()),
             ObjectType::DirItem,
             0x8dbfc2d2, // crc of "default"
         );
 
-        if let Some((item, value)) = root_tree.find_key(key)? {
+        if let Some(subvol_root) = root_tree.find_key(&key)? {
-            //let fs_root = value.
+            // if we found the dir entry of the "default subvol" (mharmstone nomenclature)
-            Root {
+            // we then look for the root fs tree in the root tree with the ID found in the `.location` of the dir_item only (from mharmstone)
-                id: item.key.id(),
+            let search_key = PartialKey::new(
-                tree: todo!(),
+                Some(
+                    subvol_root
+                        .1
+                        .as_dir_item()
+                        .expect("dir item")
+                        .first()
+                        .expect("dir item entry")
+                        .dir_item
+                        .location
+                        .id(),
+                ),
+                Some(ObjectType::RootItem),
+                None,
+            );
+            log::info!("subvol item: {subvol_root:#?}");
+
+            let subvol_id = subvol_root
+                .1
+                .as_dir_item()
+                .expect("dir item")
+                .first()
+                .expect("dir item entry")
+                .dir_item
+                .location
+                .id();
+
+            if let Some(root) = self.roots.get(&subvol_id) {
+                log::info!("my root: {root:#?}");
+
+                let root = Root {
+                    id: subvol_id,
+                    tree: Tree::from_logical_offset(self, root.bytenr.get())?,
+                };
+
+                Ok(Some(Volume { fs: self, root }))
+            } else {
+                Ok(None)
             }
         } else {
             log::warn!("default subvol not found");
+            Ok(None)
         }
     }
 

btrfs/src/structs.rs

@@ -22,7 +22,7 @@ pub enum KnownObjectId {
     QuotaTree,
     UuidTree,
     FreeSpaceTree,
-    __FirstFreeId = 256,
+    RootINode = 0x100,
     __LastFreeId = u64::MAX - 256,
     DataRelocTree = u64::MAX - 9,
     TreeReloc = u64::MAX - 8,
@@ -797,7 +797,7 @@ impl DirItem {
         DirItemType::from_primitive(self.ty)
     }
 
-    pub fn parse_single(bytes: &[u8]) -> Result<(DirItemEntry)> {
+    pub fn parse_single(bytes: &[u8]) -> Result<DirItemEntry> {
         let offset = &mut 0;
         Self::parse_single_inner(bytes, offset)
     }
@@ -813,7 +813,7 @@ impl DirItem {
         Ok(DirItemEntry::new(dir_item, name.to_vec()))
     }
 
-    pub fn parse(bytes: &[u8]) -> Result<Vec<(DirItemEntry)>> {
+    pub fn parse(bytes: &[u8]) -> Result<Vec<DirItemEntry>> {
         let offset = &mut 0;
         let entries = core::iter::from_fn(|| {
             if *offset + size_of::<DirItem>() < bytes.len() {
@@ -942,6 +942,22 @@ impl TreeItem {
             _ => TreeItem::Unimplemented,
         })
     }
+
+    pub fn as_dir_item(&self) -> Option<&Vec<DirItemEntry>> {
+        if let Self::DirItem(v) = self {
+            Some(v)
+        } else {
+            None
+        }
+    }
+
+    pub fn as_dir_index(&self) -> Option<&DirItemEntry> {
+        if let Self::DirIndex(v) = self {
+            Some(v)
+        } else {
+            None
+        }
+    }
 }
 
 impl TreeItem {

btrfs/src/tree.rs

@@ -1,15 +1,11 @@
 use core::{mem::size_of, ops::Deref};
 
 use crate::{
-    structs::{Chunk, Header, Item, Key, KeyPtr, KnownObjectId, ObjectType, RootItem, TreeItem},
+    structs::{Header, Item, Key, KeyPtr, KnownObjectId, ObjectType, TreeItem},
     Btrfs, Error, Result, VolumeIo,
 };
-use alloc::{
+use alloc::{borrow::Cow, rc::Rc, vec::Vec};
-    borrow::Cow,
+use derivative::Derivative;
-    collections::VecDeque,
-    rc::{self, Rc},
-    vec::Vec,
-};
 use scroll::Pread;
 use zerocopy::FromBytes;
 
@@ -85,6 +81,46 @@ mod partial_key_tests {
 
         let pkey = PartialKey::new(None, Some(ObjectType::DirItem), Some(0xdeadbeef));
         assert_ne!(pkey.partial_cmp(&key), None);
+
+        let pkey = PartialKey::new(
+            Some(KnownObjectId::ChunkTree),
+            Some(ObjectType::DirItem),
+            Some(0x8dbfc2d2),
+        );
+        assert_eq!(pkey.partial_cmp(&key), Some(core::cmp::Ordering::Equal));
+    }
+
+    #[test]
+    fn test_partial_eq_partial_key() {
+        let key = Key::new(
+            KnownObjectId::ChunkTree,
+            ObjectType::DirItem,
+            0x8dbfc2d2, // crc of "default"
+        );
+
+        let pkey = PartialKey::new(
+            Some(KnownObjectId::ChunkTree),
+            Some(ObjectType::DirItem),
+            None,
+        );
+        assert!(pkey.eq(&key));
+
+        let pkey = PartialKey::new(
+            Some(KnownObjectId::ChunkTree),
+            Some(ObjectType::DirItem),
+            Some(0xdeadbeef),
+        );
+        assert!(!pkey.eq(&key));
+
+        let pkey = PartialKey::new(None, Some(ObjectType::DirItem), Some(0xdeadbeef));
+        assert!(!pkey.eq(&key));
+
+        let pkey = PartialKey::new(
+            Some(KnownObjectId::ChunkTree),
+            Some(ObjectType::DirItem),
+            Some(0x8dbfc2d2),
+        );
+        assert!(pkey.eq(&key));
     }
 }
 
@@ -241,9 +277,11 @@ pub struct Tree<'a, R: VolumeIo> {
     root: BoxedNode<'a>,
 }
 
-#[derive(Debug)]
+#[derive(Derivative)]
+#[derivative(Debug)]
 pub struct Node<'a> {
     inner: BTreeNode,
+    #[derivative(Debug = "ignore")]
     bytes: Cow<'a, [u8]>,
 }
 
@@ -265,20 +303,27 @@ impl<'a> Node<'a> {
         }
     }
 
-    pub fn find_key(self: &Rc<Self>, key: &Key) -> SearchResult<'a> {
+    pub fn find_key<K: PartialEq<Key> + PartialOrd<Key>>(
+        self: &Rc<Self>,
+        key: &K,
+    ) -> SearchResult<'a> {
         match &self.inner {
             BTreeNode::Internal(node) => {
                 for (i, child) in node.children.iter().enumerate() {
-                    if key < &child.key {
+                    match key.partial_cmp(&child.key) {
-                        return SearchResult::Edge(NodeHandle {
+                        Some(core::cmp::Ordering::Less) => {
-                            node: self.clone(),
+                            return SearchResult::Edge(NodeHandle {
-                            idx: if i == 0 { 0 } else { i as u32 - 1 },
+                                node: self.clone(),
-                        });
+                                idx: if i == 0 { 0 } else { i as u32 - 1 },
-                    } else if key == &child.key {
+                            });
-                        return SearchResult::Edge(NodeHandle {
+                        }
-                            node: self.clone(),
+                        Some(core::cmp::Ordering::Equal) | None => {
-                            idx: i as u32,
+                            return SearchResult::Edge(NodeHandle {
-                        });
+                                node: self.clone(),
+                                idx: i as u32,
+                            });
+                        }
+                        _ => {}
                     }
                 }
 
@@ -295,7 +340,7 @@ impl<'a> Node<'a> {
                     //         idx: if i == 0 { 0 } else { i as u32 - 1 },
                     //     });
                     // } else
-                    if key == &child.key {
+                    if key.eq(&child.key) {
                         return SearchResult::Leaf(NodeHandle {
                             node: self.clone(),
                             idx: i as u32,
@@ -601,11 +646,14 @@ impl<'a, R: VolumeIo> Tree<'a, R> {
         Ok(Self { volume, root })
     }
 
-    pub fn find_key(&self, key: Key) -> Result<Option<(Item, TreeItem)>> {
+    pub fn find_key<K: PartialEq<Key> + PartialOrd<Key>>(
+        &self,
+        key: &K,
+    ) -> Result<Option<(Item, TreeItem)>> {
         let mut node = self.root.clone();
 
         loop {
-            let search = node.find_key(&key);
+            let search = node.find_key(key);
             match search {
                 SearchResult::Leaf(a) => {
                     return a.parse_item();