wip

Author: wcampbell0x2a

src/bin/unsquashfs.rs

@@ -9,7 +9,7 @@ use std::process::ExitCode;
 use backhand::kind::Kind;
 use backhand::{
     BufReadSeek, FilesystemReader, InnerNode, Node, NodeHeader, Squashfs, SquashfsBlockDevice,
-    SquashfsCharacterDevice, SquashfsDir, SquashfsFileReader, SquashfsSymlink,
+    SquashfsCharacterDevice, SquashfsDir, SquashfsFileReader, SquashfsSymlink, SuperBlock_V4_0,
 };
 use clap::builder::PossibleValuesParser;
 use clap::{CommandFactory, Parser};
@@ -108,6 +108,7 @@ struct Args {
               "be_v4_0",
               "le_v4_0",
               "avm_be_v4_0",
+              "le_v3_0",
           ]
     ))]
     kind: String,
@@ -202,7 +203,7 @@ fn stat(args: Args, mut file: BufReader<File>, kind: Kind) {
     file.seek(SeekFrom::Start(args.offset)).unwrap();
     let mut reader: Box<dyn BufReadSeek> = Box::new(file);
     let (superblock, compression_options) =
-        Squashfs::superblock_and_compression_options(&mut reader, &kind).unwrap();
+        SuperBlock_V4_0::superblock_and_compression_options(&mut reader, &kind).unwrap();
 
     // show info about flags
     println!("{superblock:#08x?}");

src/entry.rs

@@ -12,7 +12,7 @@ use crate::inode::{
 };
 use crate::kinds::Kind;
 use crate::metadata::MetadataWriter;
-use crate::squashfs::SuperBlock;
+use crate::squashfs::{SuperBlock, SuperBlock_V4_0};
 use crate::{NodeHeader, SquashfsBlockDevice, SquashfsCharacterDevice, SquashfsSymlink};
 
 #[derive(Clone)]
@@ -42,7 +42,7 @@ impl<'a> Entry<'a> {
         file_size: usize,
         block_offset: u16,
         block_index: u32,
-        superblock: &SuperBlock,
+        superblock: &SuperBlock_V4_0,
         kind: &Kind,
     ) -> Self {
         // if entry won't fit in file_size of regular dir entry, create extended directory
@@ -96,7 +96,7 @@ impl<'a> Entry<'a> {
         inode_writer: &mut MetadataWriter,
         file_size: usize,
         added: &Added,
-        superblock: &SuperBlock,
+        superblock: &SuperBlock_V4_0,
         kind: &Kind,
     ) -> Self {
         let basic_file = match added {
@@ -143,7 +143,7 @@ impl<'a> Entry<'a> {
         symlink: &SquashfsSymlink,
         inode: u32,
         inode_writer: &mut MetadataWriter,
-        superblock: &SuperBlock,
+        superblock: &SuperBlock_V4_0,
         kind: &Kind,
     ) -> Self {
         let link = symlink.link.as_os_str().as_bytes();
@@ -170,7 +170,7 @@ impl<'a> Entry<'a> {
         char_device: &SquashfsCharacterDevice,
         inode: u32,
         inode_writer: &mut MetadataWriter,
-        superblock: &SuperBlock,
+        superblock: &SuperBlock_V4_0,
         kind: &Kind,
     ) -> Self {
         let char_inode = Inode::new(
@@ -195,7 +195,7 @@ impl<'a> Entry<'a> {
         block_device: &SquashfsBlockDevice,
         inode: u32,
         inode_writer: &mut MetadataWriter,
-        superblock: &SuperBlock,
+        superblock: &SuperBlock_V4_0,
         kind: &Kind,
     ) -> Self {
         let block_inode = Inode::new(

src/filesystem/writer.rs

@@ -22,7 +22,7 @@ use crate::kind::Kind;
 use crate::kinds::LE_V4_0;
 use crate::metadata::{self, MetadataWriter, METADATA_MAXSIZE};
 use crate::reader::WriteSeek;
-use crate::squashfs::{Flags, SuperBlock};
+use crate::squashfs::{Flags, SuperBlock, SuperBlock_V4_0};
 use crate::{
     fragment, FilesystemReader, Node, NodeHeader, SquashfsBlockDevice, SquashfsCharacterDevice,
     SquashfsDir, SquashfsFileWriter, DEFAULT_BLOCK_SIZE, DEFAULT_PAD_LEN, MAX_BLOCK_SIZE,
@@ -416,7 +416,7 @@ impl<'a> FilesystemWriter<'a> {
         &mut self,
         w: &mut W,
         offset: u64,
-    ) -> Result<(SuperBlock, u64), BackhandError> {
+    ) -> Result<(SuperBlock_V4_0, u64), BackhandError> {
         let mut writer = WriterWithOffset::new(w, offset)?;
         self.write(&mut writer)
     }
@@ -476,7 +476,7 @@ impl<'a> FilesystemWriter<'a> {
         dir_writer: &'_ mut MetadataWriter,
         parent_node_id: u32,
         node_id: NonZeroUsize,
-        superblock: &SuperBlock,
+        superblock: &SuperBlock_V4_0,
         kind: &Kind,
     ) -> Result<Entry<'b>, BackhandError> {
         let node = &self.root.node(node_id).unwrap();
@@ -596,8 +596,9 @@ impl<'a> FilesystemWriter<'a> {
     pub fn write<W: Write + Seek>(
         &mut self,
         w: &mut W,
-    ) -> Result<(SuperBlock, u64), BackhandError> {
-        let mut superblock = SuperBlock::new(
+    ) -> Result<(SuperBlock_V4_0, u64), BackhandError> {
+        // TODO: support v3
+        let mut superblock = SuperBlock_V4_0::new(
             self.fs_compressor.id,
             Kind {
                 inner: self.kind.inner.clone(),
@@ -709,7 +710,7 @@ impl<'a> FilesystemWriter<'a> {
     fn finalize<W: Write + Seek>(
         &self,
         w: &mut W,
-        superblock: &mut SuperBlock,
+        superblock: &mut SuperBlock_V4_0,
     ) -> Result<u64, BackhandError> {
         superblock.bytes_used = w.stream_position()?;
 

src/inode.rs

@@ -11,7 +11,7 @@ use crate::dir::DirectoryIndex;
 use crate::entry::Entry;
 use crate::kind::Kind;
 use crate::metadata::MetadataWriter;
-use crate::squashfs::SuperBlock;
+use crate::squashfs::{SuperBlock, SuperBlock_V4_0, SuperBlockTrait};
 use crate::NodeHeader;
 
 #[derive(Debug, DekuRead, DekuWrite, Clone, PartialEq, Eq)]
@@ -34,16 +34,16 @@ impl Inode {
         &self,
         name: &'a [u8],
         m_writer: &mut MetadataWriter,
-        superblock: &SuperBlock,
+        superblock: &SuperBlock_V4_0,
         kind: &Kind,
     ) -> Entry<'a> {
         let mut v = BitVec::<u8, Msb0>::new();
         self.write(
             &mut v,
             (
                 0xffff_ffff_ffff_ffff, // bytes_used is unused for ctx. set to max
-                superblock.block_size,
-                superblock.block_log,
+                u32::try_from(superblock.block_size()).unwrap(),
+                superblock.block_log(),
                 kind.inner.type_endian,
             ),
         )

src/kinds.rs

@@ -150,6 +150,7 @@ impl Kind {
             "avm_be_v4_0" => AVM_BE_V4_0,
             "be_v4_0" => BE_V4_0,
             "le_v4_0" => LE_V4_0,
+            "le_v3_0" => LE_V3_0,
             _ => return Err("not a valid kind".to_string()),
         };
 
@@ -273,3 +274,13 @@ pub const AVM_BE_V4_0: InnerKind<dyn CompressionAction> = InnerKind {
     version_minor: 0,
     compressor: &DefaultCompressor,
 };
+
+/// TODO:
+pub const LE_V3_0: InnerKind<dyn CompressionAction> = InnerKind {
+    magic: *b"hsqs",
+    type_endian: deku::ctx::Endian::Little,
+    data_endian: deku::ctx::Endian::Little,
+    version_major: 3,
+    version_minor: 0,
+    compressor: &DefaultCompressor,
+};

src/lib.rs

@@ -65,6 +65,7 @@ mod inode;
 mod kinds;
 mod metadata;
 mod reader;
+mod reader_v4;
 mod squashfs;
 
 pub use crate::data::DataSize;
@@ -83,7 +84,7 @@ pub use crate::id::Id;
 pub use crate::inode::{BasicFile, Inode};
 pub use crate::reader::BufReadSeek;
 pub use crate::squashfs::{
-    Squashfs, SuperBlock, DEFAULT_BLOCK_SIZE, DEFAULT_PAD_LEN, MAX_BLOCK_SIZE, MIN_BLOCK_SIZE,
+    Squashfs, SuperBlock, SuperBlock_V4_0, DEFAULT_BLOCK_SIZE, DEFAULT_PAD_LEN, MAX_BLOCK_SIZE, MIN_BLOCK_SIZE,
 };
 
 /// Support the wonderful world of vendor formats

src/metadata.rs

@@ -4,6 +4,7 @@ use deku::bitvec::{BitVec, BitView};
 use deku::prelude::*;
 use tracing::{instrument, trace};
 
+use crate::compression::Compressor;
 use crate::error::BackhandError;
 use crate::filesystem::writer::FilesystemCompressor;
 use crate::kinds::Kind;
@@ -98,7 +99,7 @@ impl Write for MetadataWriter {
 #[instrument(skip_all)]
 pub fn read_block<R: Read + ?Sized>(
     reader: &mut R,
-    superblock: &SuperBlock,
+    compressor: Compressor,
     kind: &Kind,
 ) -> Result<Vec<u8>, BackhandError> {
     let mut buf = [0u8; 2];
@@ -118,7 +119,7 @@ pub fn read_block<R: Read + ?Sized>(
         let mut out = Vec::with_capacity(8 * 1024);
         kind.inner
             .compressor
-            .decompress(&buf, &mut out, superblock.compressor)?;
+            .decompress(&buf, &mut out, compressor)?;
         out
     } else {
         tracing::trace!("uncompressed");