4 Commits

Author SHA1 Message Date
Caleb Gardner c2a3eb420f Fixed some bugs. Caused some bugs 2026-05-28 03:56:43 -05:00
Caleb Gardner eb1b940854 (Mostly) Finished extraction (currently infinitely hanging)
Added DataExtract
Added LookupTable
2026-05-27 19:17:17 -05:00
Caleb Gardner ba2f069a4a More work on re-implementing everything
Finished MetadataReader
Finished DirEntry
Started work on File
Added most important things to Inode
Fixed test.zig
Fixed some build issues causing SEGV
2026-05-27 11:59:47 -05:00
Caleb Gardner 7c4089f826 Re-set & re-write of several things
Implemented new decompression cache to prevent decompressing the same block multiple times
2026-05-27 06:03:54 -05:00
45 changed files with 1429 additions and 2742 deletions
+1 -1
View File
@@ -11,7 +11,7 @@
"build": { "build": {
"command": "zig", "command": "zig",
"args": ["build", "-Ddebug=true"], "args": ["build", "-Duse_c_libs=true", "-Ddebug=true"],
}, },
"program": "zig-out/bin/unsquashfs", "program": "zig-out/bin/unsquashfs",
+18
View File
@@ -0,0 +1,18 @@
// Folder-specific settings
//
// For a full list of overridable settings, and general information on folder-specific settings,
// see the documentation: https://zed.dev/docs/configuring-zed#settings-files
{
"lsp": {
"zls": {
"initialization_options": {
"usePlaceholders": false,
},
"settings": {
"build_on_save": true,
"use_placeholders": false,
"build_on_save_args": ["-fincremental", "-Dallow_lzo=true"],
},
},
},
}
+10 -14
View File
@@ -10,13 +10,9 @@ Overall works, but currently is missing some features ([see below](#capabilities
## Build options ## Build options
> `-Duse_zig_decomp=true` > `-Duse_c_libs=true`
Instead of using C libraries for decompression, use Zig's standard library for decompression. If using this option LZO and LZ4 decomrpession types are unsupported and decompression times will be significantly longer. Instead of using Zig's standard library for decompression, use the system's C libraries. Has the benefit of being much faster and enabling LZO and LZ4 decompression.
> `-Ddynamic=true`
Dynamicly link C libraries (if they're used) instead of statically linking them.
> `-Dallow_lzo=true` > `-Dallow_lzo=true`
@@ -39,22 +35,22 @@ Most features are present except for the following:
## Performance ## Performance
This is some basic observation's I've made about this library's performance when compared to `unsquashfs`. Unless otherwise stated, most observations were made when extracting my test archive which is fairly small and uses zstd compression with `-Doptimize=ReleaseFast`. This is some basic observation's I've made about this library's performance when compared to `unsquashfs`. Unless otherwise stated, most observations were made when extracting my test archive (which is fairly small and uses zstd compression) and with `--release=fast`.
Currently, my only performance checks are checking execution time, nothing deeper. Currently, my only performance checks are checking execution time, nothing deeper.
* Currently, using my test archive, performance aproximately matches `unsquashfs` when multi-threaded, but significantly slower when single-threaded. * Under ideal circumstances, my library is ~70% slower (.12s vs .20s).
* Using Zig decompression libraries *significantly* increases decompression time. * Using Zig decompression libraries *significantly* increases decompression time by ~600%. Under ideal circumstances.
* Performance improvements/regressions will be common. I'm still learning Zig. * Performance improvements/regressions will be common. I'm still learning Zig.
Example Times: Example Times:
* *unsquashfs, multi-threaded*: .11s * *unsquashfs, multi-threaded*: .12s
* *unsquashfs, single-threaded*: .13s * *unsquashfs, single-threaded*: .13s
* *C-libs, multi-threaded*: .10s * *C-libs, single-threaded*: .45s
* *C-libs, single-threaded*: ..28s * *C-libs, multi-threaded*: .20s
* *Zig-libs, single-threaded*: .74s * *Zig-libs, single-threaded*: 5.78s
* *Zig-libs, multi-threaded*: 2.70s * *Zig-libs, multi-threaded*: 1.08s
## Build considerations ## Build considerations
-17
View File
@@ -1,17 +0,0 @@
#! /usr/bin/env bash
ARCHIVE="testing/LinuxPATest.sfs"
REF_EXT_LOC="testing/LinuxPAReference"
PROG_EXT_LOC="testing/LinuxPABinTest"
echo "Testing Multi-threaded Performance"
echo ""
hyperfine --warmup 5 --prepare "rm -rf $REF_EXT_LOC && rm -rf $PROG_EXT_LOC" "unsquashfs -d $REF_EXT_LOC $ARCHIVE" "zig-out/bin/unsquashfs -d $PROG_EXT_LOC $ARCHIVE"
echo ""
echo "Testing Single-threaded Performance"
echo ""
hyperfine --warmup 5 --prepare "rm -rf $REF_EXT_LOC && rm -rf $PROG_EXT_LOC" "unsquashfs -p 1 -d $REF_EXT_LOC $ARCHIVE" "zig-out/bin/unsquashfs -p 1 -d $PROG_EXT_LOC $ARCHIVE"
+108 -99
View File
@@ -1,109 +1,116 @@
const std = @import("std"); const std = @import("std");
const Build = std.Build;
const Step = Build.Step;
pub fn build(b: *std.Build) !void { pub fn build(b: *std.Build) !void {
const use_zig_decomp = b.option(bool, "use_zig_decomp", "Use zig standard library for decompression.") orelse false; const use_zig_decomp = b.option(bool, "use_zig_decomp", "Use zig standard library for decompression.") orelse false;
const allow_lzo = b.option(bool, "allow_lzo", "Compile with lzo support") orelse false; const allow_lzo = b.option(bool, "allow_lzo", "Compile with lzo support") orelse false;
const dynamic = b.option(bool, "dynamic", "Dynamicly link C decompression libraries") orelse false; var debug = b.option(bool, "debug", "Enable options to make debugging easier.") orelse false;
var debug = b.option(bool, "debug", "Enable options to make debugging easier."); const dynamic = b.option(bool, "dynamic", "Use dynamic linking for C libraries (if used).") orelse false;
const version_string_option = b.option([]const u8, "version", "Version of the library/binary"); var version_string = b.option([]const u8, "version", "Version of the library/binary") orelse "0.0.0-testing";
const target = b.standardTargetOptions(.{});
var optimize = b.standardOptimizeOption(.{});
const zig_squashfs_options = b.addOptions(); const zig_squashfs_options = b.addOptions();
zig_squashfs_options.addOption(bool, "use_zig_decomp", use_zig_decomp); zig_squashfs_options.addOption(bool, "use_zig_decomp", use_zig_decomp);
zig_squashfs_options.addOption(bool, "allow_lzo", allow_lzo); zig_squashfs_options.addOption(bool, "allow_lzo", allow_lzo);
const target = b.standardTargetOptions(.{}); version_string = std.mem.trimStart(u8, version_string, "v");
var optimize = b.standardOptimizeOption(.{}); const version = try std.SemanticVersion.parse(version_string);
if (debug == true)
optimize = .Debug;
if (optimize == .Debug)
debug = true;
const lib = b.addLibrary(.{
.name = "squashfs",
.root_module = b.createModule(.{
.optimize = if (debug == true) .Debug else optimize,
.target = target,
.valgrind = debug,
.root_source_file = b.path("src/root.zig"),
.imports = &.{
.{ .name = "options", .module = zig_squashfs_options.createModule() },
},
}),
.use_llvm = debug,
});
const deps = try dependencies(b, optimize, target, use_zig_decomp, allow_lzo, dynamic);
defer b.allocator.free(deps);
for (deps) |d|
lib.root_module.linkLibrary(d);
if (!use_zig_decomp) {
const c = b.addTranslateC(.{
.optimize = optimize,
.target = target,
.root_source_file = b.path("src/c.h"),
});
if (allow_lzo) c.defineCMacro("ALLOW_LZO", null);
lib.root_module.addImport("c", c.createModule());
if (dynamic)
dynamicLinkLibraries(c, allow_lzo);
}
var version = version_string_option orelse "0.0.0-testing";
if (version[0] == 'v') version = version[1..];
const unsquashfs_options = b.addOptions(); const unsquashfs_options = b.addOptions();
unsquashfs_options.addOption( unsquashfs_options.addOption(
std.SemanticVersion, std.SemanticVersion,
"version", "version",
try std.SemanticVersion.parse(version), version,
); );
const exe = b.addExecutable(.{
.name = "unsquashfs", if (debug) optimize = .Debug;
.root_module = b.createModule(.{ if (optimize == .Debug) debug = true;
.optimize = if (debug == true) .Debug else optimize,
const c_import = b.addTranslateC(.{
.root_source_file = b.path("src/c.h"),
.target = target, .target = target,
.optimize = optimize,
});
if (allow_lzo) c_import.defineCMacro("ALLOW_LZO", null);
if (dynamic) {
c_import.linkSystemLibrary("zlib-ng", .{});
c_import.linkSystemLibrary("lzma", .{});
if (allow_lzo)
c_import.linkSystemLibrary("minilzo", .{});
c_import.linkSystemLibrary("lz4", .{});
c_import.linkSystemLibrary("zstd", .{});
}
var lib = b.addLibrary(.{
.name = "squashfs",
.root_module = b.addModule("squashfs", .{
.root_source_file = b.path("src/root.zig"),
.target = target,
.optimize = optimize,
.valgrind = debug, .valgrind = debug,
.root_source_file = b.path("src/bin/unsquashfs.zig"), .error_tracing = debug,
.strip = !debug,
.imports = &.{ .imports = &.{
.{ .name = "zig_squashfs", .module = lib.root_module }, .{ .name = "config", .module = zig_squashfs_options.createModule() },
.{ .name = "c", .module = c_import.createModule() },
}, },
}), }),
.use_llvm = debug, .use_llvm = debug,
.version = version,
});
const deps = try getDependencies(b, target, optimize, allow_lzo, dynamic);
for (deps) |d|
lib.root_module.linkLibrary(d);
const exe = b.addExecutable(.{
.name = "unsquashfs",
.root_module = b.createModule(.{
.root_source_file = b.path("src/bin/unsquashfs.zig"),
.target = target,
.optimize = optimize,
.imports = &.{
.{ .name = "config", .module = unsquashfs_options.createModule() },
.{ .name = "squashfs", .module = lib.root_module },
},
.valgrind = debug,
.error_tracing = debug,
.strip = !debug,
}),
.use_llvm = debug,
.version = version,
}); });
exe.root_module.addOptions("config", unsquashfs_options);
b.installArtifact(lib); b.installArtifact(lib);
b.installArtifact(exe); b.installArtifact(exe);
const mod_tests = b.addTest(.{ const mod_tests = b.addTest(.{
.root_module = b.createModule(.{ .root_module = b.createModule(.{
.optimize = optimize,
.target = target,
.root_source_file = b.path("src/root.zig"), .root_source_file = b.path("src/root.zig"),
.target = target,
.optimize = optimize,
.valgrind = true,
.error_tracing = true,
.strip = false,
.imports = &.{ .imports = &.{
.{ .name = "options", .module = zig_squashfs_options.createModule() }, .{ .name = "config", .module = zig_squashfs_options.createModule() },
.{ .name = "c", .module = c_import.createModule() },
}, },
.valgrind = debug,
}), }),
.use_llvm = debug, .use_llvm = debug, // Helps with lldb degugging
}); });
for (deps) |d| for (deps) |d|
mod_tests.root_module.linkLibrary(d); mod_tests.root_module.linkLibrary(d);
if (!use_zig_decomp) { if (dynamic) {
const c = b.addTranslateC(.{ mod_tests.root_module.linkSystemLibrary("zlib-ng", .{});
.optimize = optimize, mod_tests.root_module.linkSystemLibrary("lzma", .{});
.target = target, mod_tests.root_module.linkSystemLibrary("minilzo", .{});
.root_source_file = b.path("src/c.h"), mod_tests.root_module.linkSystemLibrary("lz4", .{});
});
mod_tests.root_module.addImport("c", c.createModule());
if (allow_lzo) c.defineCMacro("ALLOW_LZO", null);
if (dynamic)
dynamicLinkLibraries(c, allow_lzo);
} }
const run_mod_tests = b.addRunArtifact(mod_tests); const run_mod_tests = b.addRunArtifact(mod_tests);
@@ -113,52 +120,54 @@ pub fn build(b: *std.Build) !void {
// zls build check steps // zls build check steps
const lib_check = b.addLibrary(.{ const lib_check = b.addLibrary(.{
.name = "squashfs", .name = "squashfs",
.root_module = exe.root_module, .root_module = lib.root_module,
}); });
const exe_check = b.addExecutable(.{ const exe_check = b.addExecutable(.{
.name = "unsquashfs", .name = "unsquashfs",
.root_module = lib.root_module, .root_module = exe.root_module,
}); });
const check = b.step("check", "Check if unsquashfs compiles"); const check = b.step("check", "Check if unsquashfs compiles");
check.dependOn(&lib_check.step); check.dependOn(&lib_check.step);
check.dependOn(&exe_check.step); check.dependOn(&exe_check.step);
} }
pub fn dynamicLinkLibraries(mod: *std.Build.Step.TranslateC, allow_lzo: bool) void { fn getDependencies(b: *Build, target: Build.ResolvedTarget, optimize: std.builtin.OptimizeMode, allow_lzo: bool, dynamic: bool) ![]*Step.Compile {
mod.linkSystemLibrary("zstd", .{}); if (dynamic) return &.{};
mod.linkSystemLibrary("zlib-ng", .{});
mod.linkSystemLibrary("lzma", .{});
mod.linkSystemLibrary("lz4", .{});
if (allow_lzo)
mod.linkSystemLibrary("minilzo", .{});
}
fn dependencies(
b: *std.Build,
optimize: std.builtin.OptimizeMode,
target: std.Build.ResolvedTarget,
use_zig_decomp: bool,
allow_lzo: bool,
dynamic: bool,
) ![]*std.Build.Step.Compile {
if (use_zig_decomp or dynamic) return &.{};
var list: std.ArrayList(*std.Build.Step.Compile) = .empty; var list: std.ArrayList(*Step.Compile) = .empty;
errdefer list.clearAndFree(b.allocator);
const zstd = b.dependency("zstd", .{ .optimize = optimize, .target = target }); var zlib_ng = b.dependency("zlib_ng", .{
try list.append(b.allocator, zstd.artifact("zstd")); .target = target,
.optimize = optimize,
});
try list.append(b.allocator, zlib_ng.artifact("zng"));
const zng = b.dependency("zlib_ng", .{ .optimize = optimize, .target = target }); var xz = b.dependency("xz", .{
try list.append(b.allocator, zng.artifact("zng")); .target = target,
.optimize = optimize,
const xz = b.dependency("xz", .{ .optimize = optimize, .target = target }); });
try list.append(b.allocator, xz.artifact("lzma")); try list.append(b.allocator, xz.artifact("lzma"));
const lz4 = b.dependency("lz4", .{ .optimize = optimize, .target = target });
try list.append(b.allocator, lz4.artifact("lz4"));
if (allow_lzo) { if (allow_lzo) {
const minilzo = b.dependency("minilzo", .{ .optimize = optimize, .target = target }); var minilzo = b.dependency("minilzo", .{
.target = target,
.optimize = optimize,
});
try list.append(b.allocator, minilzo.artifact("minilzo")); try list.append(b.allocator, minilzo.artifact("minilzo"));
} }
var lz4 = b.dependency("lz4", .{
.target = target,
.optimize = optimize,
});
try list.append(b.allocator, lz4.artifact("lz4"));
var zstd = b.dependency("zstd", .{
.target = target,
.optimize = optimize,
});
try list.append(b.allocator, zstd.artifact("zstd"));
return list.toOwnedSlice(b.allocator); return list.toOwnedSlice(b.allocator);
} }
+1 -1
View File
@@ -2,7 +2,7 @@
.name = .squashfs, .name = .squashfs,
.version = "0.0.6", .version = "0.0.6",
.fingerprint = 0x37ba29474b87f145, // Changing this has security and trust implications. .fingerprint = 0x37ba29474b87f145, // Changing this has security and trust implications.
.minimum_zig_version = "0.15.2", .minimum_zig_version = "0.16.1",
.dependencies = .{ .dependencies = .{
.zlib_ng = .{ .zlib_ng = .{
.url = "git+https://github.com/CalebQ42/zig-zlib-ng#5f2f02dfb28acca2517dacbbd09e9b987f57b133", .url = "git+https://github.com/CalebQ42/zig-zlib-ng#5f2f02dfb28acca2517dacbbd09e9b987f57b133",
+2
View File
@@ -0,0 +1,2 @@
[tools]
zig = "0.16.0"
Executable
+10
View File
@@ -0,0 +1,10 @@
#!/bin/sh
zig test \
-lc \
-lz \
-llzma \
-lminilzo \
-llz4 \
-lzstd \
src/test.zig
+64 -252
View File
@@ -1,288 +1,100 @@
const std = @import("std"); const std = @import("std");
const Io = std.Io; const Io = std.Io;
const MemoryMap = Io.File.MemoryMap;
const c = @import("c");
const config = @import("config");
const Decomp = @import("decomp.zig");
const ExtractionOptions = @import("options.zig"); const ExtractionOptions = @import("options.zig");
const File = @import("file.zig"); const File = @import("file.zig");
const Inode = @import("inode.zig"); const Inode = @import("inode.zig");
const LookupTable = @import("lookup_table.zig"); const Superblock = @import("super.zig").Superblock;
const Decompressor = @import("util/decompressor.zig"); const DecompCache = @import("util/decomp_cache.zig");
const MetadataReader = @import("util/metadata.zig"); const CompressionType = @import("util/decompress.zig").CompressionType;
const Utils = @import("util/misc.zig");
const OffsetFile = @import("util/offset_file.zig");
const Archive = @This(); const Archive = @This();
file: OffsetFile, const CACHE_MIN = 16 * 1024 * 1024;
const CACHE_MAX = 1 * 1024 * 1024 * 1024;
cache: DecompCache,
super: Superblock, super: Superblock,
stateless_decomp: Decompressor, /// Open a squashfs archive from an Io.File.
pub fn init(alloc: std.mem.Allocator, io: Io, fil: Io.File) !Archive {
pub fn init(io: Io, file: std.Io.File, offset: u64) !Archive { return initAdvanced(alloc, io, fil, 0, 0);
}
/// If max_cache_size is zero, a size is selected based on system ram, up to 1GB with a minimum of 16MB.
pub fn initAdvanced(alloc: std.mem.Allocator, io: Io, file: Io.File, offset: u64, max_cache_size: u64) !Archive {
var rdr = file.reader(io, &[0]u8{}); var rdr = file.reader(io, &[0]u8{});
try rdr.seekTo(offset); try rdr.seekTo(offset);
var super: Superblock = undefined; var super: Superblock = undefined;
try rdr.interface.readSliceEndian(Superblock, @ptrCast(&super), .little); try rdr.interface.readSliceEndian(Superblock, @ptrCast(&super), .little);
try super.validate(); try super.validate();
return .{ if (!config.use_zig_decomp and config.allow_lzo)
.file = try .init(io, file, super.size, offset), _ = c.lzo_init();
.super = super,
.stateless_decomp = try Decomp.StatelessDecomp(super.compression), const cache_size = blk: {
if (max_cache_size > CACHE_MIN) break :blk CACHE_MIN;
const sys_mem = std.process.totalSystemMemory() catch break :blk CACHE_MIN;
var min = @min(CACHE_MAX, sys_mem / 4);
if (min < CACHE_MIN and sys_mem > CACHE_MIN)
min = CACHE_MIN;
break :blk min;
};
return .{
.cache = try .init(
alloc,
try file.createMemoryMap(
io,
.{
.offset = offset,
.len = super.size,
.protection = .{ .read = true },
},
),
super.compression,
cache_size,
),
.super = super,
}; };
} }
pub fn deinit(self: *Archive, io: Io) void { pub fn deinit(self: *Archive, io: Io) void {
self.file.deinit(io); self.cache.deinit(io);
} }
/// The root folder of the Archive. Used to open other Files. pub fn root(self: *Archive, alloc: std.mem.Allocator, io: Io) !File {
pub fn root(self: *Archive, alloc: std.mem.Allocator) !File { return .fromRef(alloc, io, self, "", self.super.root_ref);
const root_inode = try Utils.inodeFromRef(
alloc,
self.file,
&self.stateless_decomp,
self.super.inode_start,
self.super.block_size,
self.super.root_ref,
);
return .init(alloc, self.*, root_inode, "");
} }
/// Opens a File within the archive.
pub fn open(self: *Archive, alloc: std.mem.Allocator, io: Io, filepath: []const u8) !File { pub fn open(self: *Archive, alloc: std.mem.Allocator, io: Io, filepath: []const u8) !File {
var root_file = try self.root(alloc);
const path = std.mem.trim(u8, filepath, "/"); const path = std.mem.trim(u8, filepath, "/");
if (Utils.pathIsSelf(path))
return root_file; var root_file = try self.root(alloc, io);
if (path.len == 0 or std.mem.eql(u8, path, ".")) return root_file;
defer root_file.deinit(); defer root_file.deinit();
return root_file.open(alloc, io, filepath);
return root_file.open(alloc, io, path);
} }
/// Returns the inode with the given inode number. pub fn extract(self: *Archive, alloc: std.mem.Allocator, io: Io, ext_dir: []const u8, options: ExtractionOptions) !void {
/// Requires that the archive is exportable (has an export lookup table). const root_inode: Inode = try .fromRef(alloc, io, &self.cache, self.super.inode_start, self.super.block_size, self.super.root_ref);
pub fn inode(self: *Archive, alloc: std.mem.Allocator, io: Io, num: u32) !Inode { return root_inode.extract(
if (!self.super.flags.exportable)
return error.NotExportable;
const ref = try LookupTable.lookupValue(
Inode.Ref,
alloc, alloc,
io, io,
&self.stateless_decomp, &self.cache,
self.file, self.super.dir_start,
self.super.export_start,
num + 1,
);
return Utils.inodeFromRef(
alloc,
io,
self.file,
&self.stateless_decomp,
self.super.inode_start, self.super.inode_start,
self.super.frag_start,
self.super.block_size, self.super.block_size,
ref,
);
}
/// Returns a value at the given index from the Archive's id (uid/gid) table.
pub fn idTable(self: *Archive, alloc: std.mem.Allocator, io: Io, idx: u32) !u16 {
return LookupTable.lookupValue(
u16,
alloc,
io,
&self.stateless_decomp,
self.file,
self.super.id_start, self.super.id_start,
idx, self.super.xattr_start,
ext_dir,
options,
); );
} }
/// Extract the entire archive contents to the given directory.
pub fn extract(self: *Archive, alloc: std.mem.Allocator, io: Io, extract_dir: []const u8, options: ExtractionOptions) !void {
const root_inode = try Utils.inodeFromRef(
alloc,
self.file,
&self.stateless_decomp,
self.super.inode_start,
self.super.block_size,
self.super.root_ref,
);
return root_inode.extract(alloc, io, self.file, self.super, extract_dir, options);
}
// Superblock
const SQUASHFS_MAGIC: u32 = std.mem.readInt(u32, "hsqs", .little);
const SuperblockError = error{
InvalidMagic,
InvalidBlockLog,
InvalidVersion,
InvalidCheck,
};
/// A squashfs Superblock
pub const Superblock = extern struct {
magic: u32,
inode_count: u32,
mod_time: u32,
block_size: u32,
frag_count: u32,
compression: Decomp.Enum,
block_log: u16,
flags: packed struct(u16) {
inode_uncompressed: bool,
data_uncompressed: bool,
check: bool,
frag_uncompressed: bool,
fragment_never: bool,
fragment_always: bool,
duplicates: bool,
exportable: bool,
xattr_uncompressed: bool,
xattr_never: bool,
compression_options: bool,
ids_uncompressed: bool,
_: u4,
},
id_count: u16,
ver_maj: u16,
ver_min: u16,
root_ref: Inode.Ref,
size: u64,
id_start: u64,
xattr_start: u64,
inode_start: u64,
dir_start: u64,
frag_start: u64,
export_start: u64,
/// Validate the Superblock. If an error is returned, it's likely the archive is corrupted or not a squashfs archive.
pub fn validate(self: Superblock) !void {
if (self.magic != SQUASHFS_MAGIC)
return SuperblockError.InvalidMagic;
if (self.flags.check)
return SuperblockError.InvalidCheck;
if (self.ver_maj != 4 or self.ver_min != 0)
return SuperblockError.InvalidVersion;
if (std.math.log2(self.block_size) != self.block_log)
return SuperblockError.InvalidBlockLog;
}
};
// Tests
const TestArchive = "testing/LinuxPATest.sfs";
test "Basics" {
std.debug.print("Starting test: Basics...\n", .{});
const alloc = std.testing.allocator;
const io = std.testing.io;
var fil = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer fil.close(io);
var sfs: Archive = try .init(io, fil, 0);
defer sfs.deinit(io);
try std.testing.expectEqualDeep(sfs.super, LinuxPATestCorrectSuperblock);
const root_file = try sfs.root(alloc);
defer root_file.deinit();
}
const TestFile = "Start.exe";
const TestFileExtractLocation = "testing/Start.exe";
test "ExtractSingleFile" {
std.debug.print("Starting test: ExtractSingleFile...\n", .{});
const alloc = std.testing.allocator;
const io = std.testing.io;
Io.Dir.cwd().deleteFile(io, TestFileExtractLocation) catch {};
var fil = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer fil.close(io);
var sfs: Archive = try .init(io, fil, 0);
defer sfs.deinit(io);
var test_fil = try sfs.open(alloc, io, TestFile);
defer test_fil.deinit();
try test_fil.extract(alloc, io, TestFileExtractLocation, .default);
//TODO: validate extracted file.
}
const TestFullExtractLocation = "testing/TestExtract";
test "ExtractCompleteArchive" {
std.debug.print("Starting test: ExtractCompleteArchive...\n", .{});
const alloc = std.testing.allocator;
const io = std.testing.io;
Io.Dir.cwd().deleteTree(io, TestFullExtractLocation) catch {};
var fil = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer fil.close(io);
var sfs: Archive = try .init(io, fil, 0);
defer sfs.deinit(io);
try sfs.extract(alloc, io, TestFullExtractLocation, .default);
}
test "ExtractCompleteArchiveSingleThreaded" {
std.debug.print("Starting test: ExtractCompleteArchive...\n", .{});
const alloc = std.testing.allocator;
const io = std.testing.io;
var fil = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer fil.close(io);
{
std.debug.print("First testing using Threaded.global_single_threaded...\n", .{});
Io.Dir.cwd().deleteTree(io, TestFullExtractLocation) catch {};
var sfs: Archive = try .init(Io.Threaded.global_single_threaded.io(), fil, 0);
defer sfs.deinit(Io.Threaded.global_single_threaded.io());
try sfs.extract(alloc, Io.Threaded.global_single_threaded.io(), TestFullExtractLocation, .default);
}
{
std.debug.print("Next testing using ExtractionOptions.single_threaded...\n", .{});
Io.Dir.cwd().deleteTree(io, TestFullExtractLocation) catch {};
var sfs: Archive = try .init(io, fil, 0);
defer sfs.deinit(io);
try sfs.extract(alloc, io, TestFullExtractLocation, .default_single_threaded);
}
}
const LinuxPATestCorrectSuperblock: Superblock = .{
.magic = std.mem.readInt(u32, "hsqs", .little),
.inode_count = 2974,
.mod_time = 1632696724,
.block_size = 131072,
.frag_count = 264,
.compression = .zstd,
.block_log = 17,
.flags = .{
.inode_uncompressed = false,
.data_uncompressed = false,
.check = false,
.frag_uncompressed = false,
.fragment_never = false,
.fragment_always = false,
.duplicates = true,
.exportable = true,
.xattr_uncompressed = false,
.xattr_never = false,
.compression_options = false,
.ids_uncompressed = false,
._ = 0,
},
.id_count = 1,
.ver_maj = 4,
.ver_min = 0,
.root_ref = .{
.block_offset = 1363,
.block_start = 29237,
._ = 0,
},
.size = 106841744,
.id_start = 106841632,
.xattr_start = 106841720,
.inode_start = 106778274,
.dir_start = 106807998,
.frag_start = 106837747,
.export_start = 106841602,
};
+15 -26
View File
@@ -1,10 +1,10 @@
const std = @import("std"); const std = @import("std");
const Io = std.Io; const Io = std.Io;
const Writer = Io.Writer; const Writer = std.Io.Writer;
const builtin = @import("builtin"); const builtin = @import("builtin");
const config = @import("config"); const config = @import("config");
const squashfs = @import("zig_squashfs"); const squashfs = @import("squashfs");
//TODO: Add more options //TODO: Add more options
const help_mgs = const help_mgs =
@@ -18,7 +18,7 @@ const help_mgs =
\\ -dx Don't set xattr values \\ -dx Don't set xattr values
\\ -dp Don't set permissions (includes setting uid & gid owner) \\ -dp Don't set permissions (includes setting uid & gid owner)
\\ \\
\\ -p <threads> Specify how many threads to use. If not present or zero, the system's logical cores count is used. \\ -p <threads> Specify how many threads to use. If no present or zero, the system's logical cores count is used.
\\ -v Verbose \\ -v Verbose
\\ \\
\\ --force Force extraction. If the destination already exists, it will be deleted. \\ --force Force extraction. If the destination already exists, it will be deleted.
@@ -41,27 +41,23 @@ var force: bool = false;
pub fn main(init: std.process.Init) !void { pub fn main(init: std.process.Init) !void {
const alloc = init.gpa; const alloc = init.gpa;
// const io = init.io; const io = init.io;
var evented: Io.Evented = undefined;
try evented.init(alloc, .{});
const io = evented.io();
var stdout = std.Io.File.stdout(); var stdout = Io.File.stdout();
defer stdout.close(io);
var out = stdout.writer(io, &[0]u8{}); var out = stdout.writer(io, &[0]u8{});
defer out.interface.flush() catch {}; defer out.interface.flush() catch {};
try handleArgs(init.minimal.args, &out.interface); try handleArgs(&out.interface, init.minimal.args);
if (archive.len == 0) { if (archive.len == 0) {
try out.interface.print("You must provide a squashfs archive\n", .{}); try out.interface.print("You must provide a squashfs archive\n", .{});
try out.interface.print(help_mgs, .{}); try out.interface.print(help_mgs, .{});
return; return;
} }
var fil = try Io.Dir.cwd().openFile(io, archive, .{}); //TODO: Handle error gracefully. var fil: std.Io.File = try Io.Dir.cwd().openFile(io, archive, .{}); //TODO: Handle error gracefully.
defer fil.close(io); defer fil.close(io);
var arc: squashfs.Archive = try .initAdvanced(alloc, io, fil, offset, 0); //TODO: Update when memory size matters. //TODO: Handle error gracefully.
var arc: squashfs.Archive = try .init(io, fil, offset); //TODO: Handle error gracefully. defer arc.deinit(io);
const options: squashfs.ExtractionOptions = .{ const options: squashfs.ExtractionOptions = .{
.single_threaded = threads == 1, .single_threaded = threads == 1,
.verbose = verbose, .verbose = verbose,
@@ -69,24 +65,13 @@ pub fn main(init: std.process.Init) !void {
.ignore_xattr = ignore_xattrs, .ignore_xattr = ignore_xattrs,
.ignore_permissions = ignore_permissions, .ignore_permissions = ignore_permissions,
}; };
if (force) if (force)
try Io.Dir.cwd().deleteTree(io, extLoc); try Io.Dir.cwd().deleteTree(io, extLoc);
if (threads != 0) { try arc.extract(alloc, io, extLoc, options); //TODO: Handle error gracefully.
var limited_io = Io.Threaded.init(alloc, .{
.async_limit = .limited(threads - 1),
.concurrent_limit = .limited(threads - 1),
.argv0 = .init(init.minimal.args),
.environ = init.minimal.environ,
});
return arc.extract(alloc, limited_io.io(), extLoc, options); //TODO: Handle error gracefully.
}
return arc.extract(alloc, io, extLoc, options); //TODO: Handle error gracefully.
} }
fn handleArgs(args: std.process.Args, out: *Writer) !void { fn handleArgs(out: *Writer, args: std.process.Args) !void {
var arg_iter = args.iterate(); var arg_iter = args.iterate();
defer arg_iter.deinit();
_ = arg_iter.next(); // args[0] is the application launch command. _ = arg_iter.next(); // args[0] is the application launch command.
while (arg_iter.next()) |arg| { while (arg_iter.next()) |arg| {
if (std.mem.eql(u8, arg, "-o")) { if (std.mem.eql(u8, arg, "-o")) {
@@ -150,3 +135,7 @@ fn handleArgs(args: std.process.Args, out: *Writer) !void {
archive = arg; archive = arg;
} }
} }
test {
std.testing.refAllDecls(squashfs.Archive);
}
+3 -3
View File
@@ -1,7 +1,7 @@
#include <zstd.h>
#include <zlib-ng.h>
#include <lzma.h>
#ifdef ALLOW_LZO #ifdef ALLOW_LZO
#include <lzo/minilzo.h> #include <lzo/minilzo.h>
#endif #endif
#include <zlib-ng.h>
#include <zstd.h>
#include <lz4.h> #include <lz4.h>
#include <lzma.h>
-87
View File
@@ -1,87 +0,0 @@
const std = @import("std");
const Io = std.Io;
const options = @import("options");
const Decompressor = @import("util/decompressor.zig");
const zlib = if (options.use_zig_decomp) @import("decomp/zig_zlib.zig") else @import("decomp/c_zlib.zig");
const lzma = if (options.use_zig_decomp) @import("decomp/zig_lzma.zig") else @import("decomp/c_lzma.zig");
const lzo = if (options.use_zig_decomp or !options.allow_lzo) void else @import("decomp/c_lzo.zig");
const xz = if (options.use_zig_decomp) @import("decomp/zig_xz.zig") else @import("decomp/c_xz.zig");
const lz4 = if (options.use_zig_decomp) void else @import("decomp/c_lz4.zig");
const zstd = if (options.use_zig_decomp) @import("decomp/zig_zstd.zig") else @import("decomp/c_zstd.zig");
pub const Enum = enum(u16) {
gzip = 1,
lzma,
lzo,
xz,
lz4,
zstd,
};
pub fn StatelessDecomp(val: Enum) !Decompressor {
return switch (val) {
.gzip => zlib.stateless_decompressor,
.lzma => lzma.stateless_decompressor,
.lzo => if (options.use_zig_decomp or !options.allow_lzo)
error.LzoUnsupported
else
lzo.stateless_decompressor,
.xz => xz.stateless_decompressor,
.lz4 => if (options.use_zig_decomp)
error.Lz4Unsupported
else
lz4.stateless_decompressor,
.zstd => zstd.stateless_decompressor,
};
}
pub const Decomp = union(enum) {
gzip: zlib,
lzma: lzma,
lzo: lzo,
xz: xz,
lz4: lz4,
zstd: zstd,
pub fn init(val: Enum, alloc: std.mem.Allocator, io: Io, block_size: u32) !Decomp {
return switch (val) {
.gzip => .{ .gzip = if (options.use_zig_decomp) try zlib.init(alloc, io, block_size) else try zlib.init(alloc, io) },
.lzma => .{ .lzma = if (options.use_zig_decomp) try lzma.init(alloc, io, block_size) else .{} },
.lzo => if (options.use_zig_decomp or !options.allow_lzo) error.LzoUnsupported else .{ .lzo = .{} },
.xz => .{ .xz = if (options.use_zig_decomp) try xz.init(alloc, io, block_size) else .{} },
.lz4 => if (options.use_zig_decomp) error.Lz4Unsupported else .{ .lz4 = .{} },
.zstd => .{ .zstd = if (options.use_zig_decomp) try zstd.init(alloc, io, block_size) else try zstd.init(alloc, io) },
};
}
pub fn deinit(self: *Decomp, alloc: std.mem.Allocator) void {
if (options.use_zig_decomp) {
switch (self.*) {
.gzip => self.gzip.deinit(),
.lzma => self.lzma.deinit(),
.xz => self.xz.deinit(),
.zstd => self.zstd.deinit(),
else => {},
}
} else {
switch (self.*) {
.gzip => self.gzip.deinit(alloc),
.zstd => self.zstd.deinit(alloc),
else => {},
}
}
}
pub fn decompressor(self: *Decomp) *Decompressor {
return switch (self.*) {
.gzip => &self.gzip.interface,
.lzma => &self.lzma.interface,
.lzo => if (options.use_zig_decomp or !options.allow_lzo) unreachable else &self.lzo.interface,
.xz => &self.xz.interface,
.lz4 => if (options.use_zig_decomp) unreachable else &self.lz4.interface,
.zstd => &self.zstd.interface,
};
}
};
-17
View File
@@ -1,17 +0,0 @@
const std = @import("std");
const c = @import("c");
const Decompressor = @import("../util/decompressor.zig");
const Error = Decompressor.Error;
pub const stateless_decompressor: Decompressor = .{ .decomp_fn = statelessDecomp };
interface: Decompressor = .{ .decomp_fn = statelessDecomp },
fn statelessDecomp(_: ?*Decompressor, _: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
const out_len: c_int = @bitCast(@as(u32, @truncate(out.len)));
const res = c.LZ4_decompress_fast(in.ptr, out.ptr, out_len);
if (res < 0) return Error.ReadFailed;
return @abs(res);
}
-46
View File
@@ -1,46 +0,0 @@
const std = @import("std");
const Io = std.Io;
const Reader = std.Io.Reader;
const zstd = std.compress.zstd;
const Node = std.SinglyLinkedList.Node;
const c = @import("c");
const Decompressor = @import("../util/decompressor.zig");
const Error = Decompressor.Error;
const Queue = std.Io.Queue(c.lzma_stream);
const Self = @This();
pub const stateless_decompressor: Decompressor = .{ .decomp_fn = statelessDecomp };
interface: Decompressor = .{ .decomp_fn = statelessDecomp },
fn statelessDecomp(_: ?*Decompressor, _: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var stream: c.lzma_stream = .{
.next_in = in.ptr,
.avail_in = in.len,
.next_out = out.ptr,
.avail_out = out.len,
};
var res = c.lzma_alone_decoder(&stream, stream.avail_out * 2);
if (res != c.LZMA_OK) return Error.ReadFailed;
while (res == c.LZMA_OK)
res = c.lzma_code(&stream, c.LZMA_RUN);
if (res != c.LZMA_FINISH) return Error.ReadFailed;
return stream.total_out;
}
// lzma_allocator
// fn lzmaAlloc(ptr: ?*anyopaque, size: usize, _: usize) callconv(.c) ?*anyopaque {
// var alloc: *std.mem.Allocator = @ptrCast(@alignCast(ptr));
// return alloc.rawAlloc(size, .@"1", 0);
// }
// fn lzmaFree(ptr: ?*anyopaque, mem_ptr: ?*anyopaque) callconv(.c) void {
// if (mem_ptr == null) return;
// var alloc: *std.mem.Allocator = @ptrCast(@alignCast(ptr));
// alloc.free(@as([*]u8, @ptrCast(mem_ptr.?)));
// }
-26
View File
@@ -1,26 +0,0 @@
const std = @import("std");
const Io = std.Io;
const Reader = std.Io.Reader;
const zstd = std.compress.zstd;
const Node = std.SinglyLinkedList.Node;
const c = @import("c");
const Decompressor = @import("../util/decompressor.zig");
const Error = Decompressor.Error;
const Queue = std.Io.Queue(c.lzma_stream);
const Self = @This();
pub const stateless_decompressor: Decompressor = .{ .decomp_fn = statelessDecomp };
interface: Decompressor = .{ .decomp_fn = statelessDecomp },
fn statelessDecomp(_: ?*Decompressor, _: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
_ = c.lzo_init();
var out_len = out.len;
const res = c.lzo1x_decompress_safe(in.ptr, in.len, out.ptr, &out_len, null);
if (res != c.LZO_E_OK) return Error.ReadFailed;
return out_len;
}
-47
View File
@@ -1,47 +0,0 @@
const std = @import("std");
const Io = std.Io;
const Reader = std.Io.Reader;
const zstd = std.compress.zstd;
const Node = std.SinglyLinkedList.Node;
const c = @import("c");
const Decompressor = @import("../util/decompressor.zig");
const Error = Decompressor.Error;
const Queue = std.Io.Queue(c.lzma_stream);
const Self = @This();
pub const stateless_decompressor: Decompressor = .{ .decomp_fn = statelessDecomp };
interface: Decompressor = .{ .decomp_fn = statelessDecomp },
fn statelessDecomp(_: ?*Decompressor, _: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var stream: c.lzma_stream = .{
.next_in = in.ptr,
.avail_in = in.len,
.next_out = out.ptr,
.avail_out = out.len,
};
var res = c.lzma_alone_decoder(&stream, stream.avail_out * 2);
if (res != c.LZMA_OK) return Error.ReadFailed;
while (res == c.LZMA_OK)
res = c.lzma_code(&stream, c.LZMA_RUN);
if (res != c.LZMA_FINISH) return Error.ReadFailed;
return stream.total_out;
}
// lzma_allocator
// fn lzmaAlloc(ptr: ?*anyopaque, size: usize, _: usize) callconv(.c) ?*anyopaque {
// var alloc: *std.mem.Allocator = @ptrCast(@alignCast(ptr));
// const mem = alloc.alloc(u8, size) catch return null;
// return mem.ptr;
// }
// fn lzmaFree(ptr: ?*anyopaque, mem_ptr: ?*anyopaque) callconv(.c) void {
// if (mem_ptr == null) return;
// var alloc: *std.mem.Allocator = @ptrCast(@alignCast(ptr));
// alloc.free(@as([*]u8, @ptrCast(mem_ptr.?)));
// }
-80
View File
@@ -1,80 +0,0 @@
const std = @import("std");
const Io = std.Io;
const Reader = std.Io.Reader;
const zstd = std.compress.zstd;
const Node = std.SinglyLinkedList.Node;
const c = @import("c");
const Decompressor = @import("../util/decompressor.zig");
const Error = Decompressor.Error;
const Queue = std.Io.Queue(c.zng_stream);
const Self = @This();
interface: Decompressor = .{ .decomp_fn = decomp },
io: Io,
ctx: []c.zng_stream,
ctx_queue: Queue,
pub fn init(alloc: std.mem.Allocator, io: Io) !Self {
const buf = try alloc.alloc(c.zng_stream, 20); // TODO: Choose a better number instead of a random one.
var queue: Queue = .init(buf);
for (0..20) |_|
try queue.putOne(io, .{});
return .{
.io = io,
.ctx = buf,
.ctx_queue = queue,
};
}
pub fn deinit(self: *Self, alloc: std.mem.Allocator) void {
self.ctx_queue.close(self.io);
alloc.free(self.ctx);
}
fn decomp(d: ?*Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
if (d == null) {
return statelessDecomp(d, alloc, in, out);
}
var self: *Self = @fieldParentPtr("interface", @constCast(d.?));
var stream = self.ctx_queue.getOne(self.io) catch return Error.ReadFailed;
defer self.ctx_queue.putOne(self.io, stream) catch {};
stream.next_in = in.ptr;
stream.avail_in = @truncate(in.len);
stream.next_out = out.ptr;
stream.avail_out = @truncate(out.len);
try zlibDecomp(&stream);
return stream.total_out;
}
inline fn zlibDecomp(stream: *c.zng_stream) !void {
_ = c.zng_inflateReset(stream);
const res = c.zng_inflate(stream, c.Z_FULL_FLUSH);
if (res != c.Z_OK) return Error.ReadFailed;
}
// Stateless
pub const stateless_decompressor: Decompressor = .{ .decomp_fn = statelessDecomp };
fn statelessDecomp(_: ?*Decompressor, _: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var stream: c.zng_stream = .{
.next_in = in.ptr,
.avail_in = @truncate(in.len),
.next_out = out.ptr,
.avail_out = @truncate(out.len),
};
try zlibDecomp(&stream);
return stream.total_out;
}
-69
View File
@@ -1,69 +0,0 @@
const std = @import("std");
const Io = std.Io;
const Reader = std.Io.Reader;
const zstd = std.compress.zstd;
const Node = std.SinglyLinkedList.Node;
const c = @import("c");
const Decompressor = @import("../util/decompressor.zig");
const Error = Decompressor.Error;
const Queue = std.Io.Queue(?*c.ZSTD_DCtx);
const Self = @This();
interface: Decompressor = .{ .decomp_fn = decomp },
io: Io,
ctx: []?*c.ZSTD_DCtx,
ctx_queue: Queue,
pub fn init(alloc: std.mem.Allocator, io: Io) !Self {
const buf = try alloc.alloc(?*c.ZSTD_DCtx, 20); // TODO: Choose a better number instead of a random one.
var queue: Queue = .init(buf);
for (0..20) |_|
try queue.putOne(io, c.ZSTD_createDCtx());
return .{
.io = io,
.ctx = buf,
.ctx_queue = queue,
};
}
pub fn deinit(self: *Self, alloc: std.mem.Allocator) void {
self.ctx_queue.close(self.io);
for (self.ctx) |ctx|
_ = c.ZSTD_freeDCtx(ctx);
alloc.free(self.ctx);
}
fn decomp(d: ?*Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
if (d == null) {
return statelessDecomp(d, alloc, in, out);
}
var self: *Self = @fieldParentPtr("interface", @constCast(d.?));
const ctx = self.ctx_queue.getOne(self.io) catch return Error.ReadFailed;
defer self.ctx_queue.putOne(self.io, ctx) catch {};
_ = c.ZSTD_DCtx_reset(ctx, c.ZSTD_reset_session_only);
const res = c.ZSTD_decompressDCtx(ctx, out.ptr, out.len, in.ptr, in.len);
if (c.ZSTD_isError(res) != 0)
return Error.ReadFailed;
return res;
}
// Stateless
pub const stateless_decompressor: Decompressor = .{ .decomp_fn = statelessDecomp };
fn statelessDecomp(_: ?*Decompressor, _: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
const res = c.ZSTD_decompress(out.ptr, out.len, in.ptr, in.len);
if (c.ZSTD_isError(res) != 0)
return Error.ReadFailed;
return res;
}
-81
View File
@@ -1,81 +0,0 @@
const std = @import("std");
const Io = std.Io;
const Reader = std.Io.Reader;
const lzma = std.compress.lzma;
const Node = std.SinglyLinkedList.Node;
const Decompressor = @import("../util/decompressor.zig");
const Error = Decompressor.Error;
const Queue = Io.Queue([]u8);
const Self = @This();
const Buffer = struct {
node: Node,
buf: []u8,
};
interface: Decompressor = .{ .decomp_fn = decomp },
alloc: std.mem.Allocator,
io: Io,
block_size: u32,
buf: [][]u8,
buf_queue: Queue,
pub fn init(alloc: std.mem.Allocator, io: Io, block_size: u32) !Self {
const buf = try alloc.alloc([]u8, 20); // TODO: Choose a better number instead of a random one.
var queue: Queue = .init(buf);
for (0..20) |_|
try queue.putOne(io, try alloc.alloc(u8, block_size));
return .{
.alloc = alloc,
.io = io,
.block_size = block_size,
.buf = buf,
.buf_queue = queue,
};
}
pub fn deinit(self: *Self) void {
self.buf_queue.close(self.io);
for (self.buf) |buf|
self.alloc.free(buf);
self.alloc.free(self.buf);
}
fn decomp(d: ?*Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
if (d == null) {
return statelessDecomp(d, alloc, in, out);
}
var self: *Self = @fieldParentPtr("interface", @constCast(d.?));
var buf = self.buf_queue.getOne(self.io) catch return Error.ReadFailed;
defer self.buf_queue.putOne(self.io, buf) catch {};
return lzmaDecomp(self.alloc, &buf, in, out) catch return Error.ReadFailed;
}
inline fn lzmaDecomp(alloc: std.mem.Allocator, buffer: *[]u8, in: []u8, out: []u8) !usize {
var rdr: Reader = .fixed(in);
var d = try lzma.Decompress.initOptions(&rdr, alloc, buffer.*, .{}, in.len * 2);
defer {
buffer.* = d.takeBuffer();
d.deinit();
}
return d.reader.readSliceShort(out);
}
// Stateless
pub const stateless_decompressor: Decompressor = .{ .decomp_fn = statelessDecomp };
fn statelessDecomp(_: ?*Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var buf = try alloc.alloc(u8, in.len);
defer alloc.free(buf);
return lzmaDecomp(alloc, &buf, in, out) catch return Error.ReadFailed;
}
-81
View File
@@ -1,81 +0,0 @@
const std = @import("std");
const Io = std.Io;
const Reader = std.Io.Reader;
const xz = std.compress.xz;
const Node = std.SinglyLinkedList.Node;
const Decompressor = @import("../util/decompressor.zig");
const Error = Decompressor.Error;
const Queue = Io.Queue([]u8);
const Self = @This();
const Buffer = struct {
node: Node,
buf: []u8,
};
interface: Decompressor = .{ .decomp_fn = decomp },
alloc: std.mem.Allocator,
io: Io,
block_size: u32,
buf: [][]u8,
buf_queue: Queue,
pub fn init(alloc: std.mem.Allocator, io: Io, block_size: u32) !Self {
const buf = try alloc.alloc([]u8, 20); // TODO: Choose a better number instead of a random one.
var queue: Queue = .init(buf);
for (0..20) |_|
try queue.putOne(io, try alloc.alloc(u8, block_size));
return .{
.alloc = alloc,
.io = io,
.block_size = block_size,
.buf = buf,
.buf_queue = queue,
};
}
pub fn deinit(self: *Self) void {
self.buf_queue.close(self.io);
for (self.buf) |buf|
self.alloc.free(buf);
self.alloc.free(self.buf);
}
fn decomp(d: ?*Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
if (d == null) {
return statelessDecomp(d, alloc, in, out);
}
var self: *Self = @fieldParentPtr("interface", @constCast(d.?));
var buf = self.buf_queue.getOne(self.io) catch return Error.ReadFailed;
defer self.buf_queue.putOne(self.io, buf) catch {};
return xzDecomp(self.alloc, &buf, in, out) catch return Error.ReadFailed;
}
inline fn xzDecomp(alloc: std.mem.Allocator, buffer: *[]u8, in: []u8, out: []u8) !usize {
var rdr: Reader = .fixed(in);
var d = try xz.Decompress.init(&rdr, alloc, buffer.*);
defer {
buffer.* = d.takeBuffer();
d.deinit();
}
return d.reader.readSliceShort(out);
}
// Stateless
pub const stateless_decompressor: Decompressor = .{ .decomp_fn = statelessDecomp };
fn statelessDecomp(_: ?*Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var buf = try alloc.alloc(u8, in.len);
defer alloc.free(buf);
return xzDecomp(alloc, &buf, in, out) catch return Error.ReadFailed;
}
-77
View File
@@ -1,77 +0,0 @@
const std = @import("std");
const Io = std.Io;
const flate = std.compress.flate;
const Node = std.SinglyLinkedList.Node;
const Reader = Io.Reader;
const Decompressor = @import("../util/decompressor.zig");
const Error = Decompressor.Error;
const Queue = Io.Queue([]u8);
const Self = @This();
const Buffer = struct {
node: Node,
buf: []u8,
};
interface: Decompressor = .{ .decomp_fn = decomp },
alloc: std.mem.Allocator,
io: Io,
block_size: u32,
buf: [][]u8,
buf_queue: Queue,
pub fn init(alloc: std.mem.Allocator, io: Io, block_size: u32) !Self {
const buf = try alloc.alloc([]u8, 20); // TODO: Choose a better number instead of a random one.
var queue: Queue = .init(buf);
for (0..20) |_|
try queue.putOne(io, try alloc.alloc(u8, block_size));
return .{
.alloc = alloc,
.io = io,
.block_size = block_size,
.buf = buf,
.buf_queue = queue,
};
}
pub fn deinit(self: *Self) void {
self.buf_queue.close(self.io);
for (self.buf) |buf|
self.alloc.free(buf);
self.alloc.free(self.buf);
}
fn decomp(d: ?*Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
if (d == null) {
return statelessDecomp(d, alloc, in, out);
}
var self: *Self = @fieldParentPtr("interface", @constCast(d.?));
const buf = self.buf_queue.getOne(self.io) catch return Error.ReadFailed;
defer self.buf_queue.putOne(self.io, buf) catch {};
return zlibDecomp(buf, in, out);
}
inline fn zlibDecomp(buffer: []u8, in: []u8, out: []u8) !usize {
var rdr: Reader = .fixed(in);
var d = flate.Decompress.init(&rdr, .zlib, buffer);
return d.reader.readSliceShort(out);
}
// Stateless
pub const stateless_decompressor: Decompressor = .{ .decomp_fn = statelessDecomp };
fn statelessDecomp(_: ?*Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
const buf = try alloc.alloc(u8, out.len);
defer alloc.free(buf);
return zlibDecomp(buf, in, out);
}
-73
View File
@@ -1,73 +0,0 @@
const std = @import("std");
const Io = std.Io;
const Reader = std.Io.Reader;
const zstd = std.compress.zstd;
const Decompressor = @import("../util/decompressor.zig");
const Error = Decompressor.Error;
const Queue = std.Io.Queue([]u8);
const Self = @This();
interface: Decompressor = .{ .decomp_fn = decomp },
alloc: std.mem.Allocator,
io: Io,
block_size: u32,
buf: [][]u8,
buf_queue: Queue,
pub fn init(alloc: std.mem.Allocator, io: Io, block_size: u32) !Self {
const buf = try alloc.alloc([]u8, 5); // TODO: Choose a better number instead of a random one.
var queue: Queue = .init(buf);
for (buf) |_|
try queue.putOne(io, try alloc.alloc(u8, block_size + zstd.block_size_max));
return .{
.alloc = alloc,
.io = io,
.block_size = block_size,
.buf = buf,
.buf_queue = queue,
};
}
pub fn deinit(self: *Self) void {
self.buf_queue.close(self.io);
for (self.buf) |buf|
self.alloc.free(buf);
self.alloc.free(self.buf);
}
fn decomp(d: ?*Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
if (d == null) {
const buf = try alloc.alloc(u8, in.len * 2);
defer alloc.free(buf);
return zstdDecomp(buf, in, out);
}
var self: *Self = @fieldParentPtr("interface", @constCast(d.?));
const buf = self.buf_queue.getOne(self.io) catch return Error.ReadFailed;
defer self.buf_queue.putOne(self.io, buf) catch {};
return zstdDecomp(buf, in, out);
}
inline fn zstdDecomp(buffer: []u8, in: []u8, out: []u8) !usize {
var rdr: Reader = .fixed(in);
var d = zstd.Decompress.init(&rdr, buffer, .{ .window_len = @truncate(out.len) });
return d.reader.readSliceShort(out);
}
// Stateless
pub const stateless_decompressor: Decompressor = .{ .decomp_fn = statelessDecomp };
fn statelessDecomp(_: ?*Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
const buf = try alloc.alloc(u8, out.len + zstd.block_size_max);
defer alloc.free(buf);
return zstdDecomp(buf, in, out);
}
+67
View File
@@ -0,0 +1,67 @@
const std = @import("std");
const Reader = std.Io.Reader;
const Inode = @import("inode.zig");
const Header = extern struct {
count: u32,
block_start: u32,
num: u32,
};
const Entry = extern struct {
block_offset: u16,
num_offset: i16,
inode_type: Inode.Type,
name_size: u16,
};
pub const Error = error{OutOfMemory} || std.Io.Reader.Error;
const DirEntry = @This();
inode_type: Inode.Type,
name: []const u8,
block_start: u32,
block_offset: u32,
num: u32,
pub fn deinit(self: DirEntry, alloc: std.mem.Allocator) void {
alloc.free(self.name);
}
pub fn readEntries(alloc: std.mem.Allocator, rdr: *Reader, size: u32) Error![]DirEntry {
var out: std.ArrayList(DirEntry) = try .initCapacity(alloc, 50);
errdefer out.deinit(alloc);
var tot_read: u32 = 3;
while (tot_read < size) {
var hdr: Header = undefined;
try rdr.readSliceEndian(Header, @ptrCast(&hdr), .little);
tot_read += @sizeOf(Header);
try out.ensureUnusedCapacity(alloc, hdr.count + 1);
for (0..hdr.count + 1) |_| {
var ent: Entry = undefined;
try rdr.readSliceEndian(Entry, @ptrCast(&ent), .little);
tot_read += @sizeOf(Entry) + ent.name_size + 1;
const name = try alloc.alloc(u8, ent.name_size + 1);
errdefer alloc.free(name);
try rdr.readSliceEndian(u8, name, .little);
out.appendAssumeCapacity(.{
.inode_type = ent.inode_type,
.name = name,
.block_offset = ent.block_offset,
.block_start = hdr.block_start,
.num = @intCast(@as(i64, @intCast(hdr.num)) + ent.num_offset),
});
}
}
return out.toOwnedSlice(alloc);
}
-69
View File
@@ -1,69 +0,0 @@
const std = @import("std");
const Reader = std.Io.Reader;
const Inode = @import("inode.zig");
pub const Error = error{OutOfMemory} || Reader.Error;
const DirEntry = @This();
block_start: u32,
block_offset: u16,
type: Inode.Type,
name: []const u8,
pub fn deinit(self: DirEntry, alloc: std.mem.Allocator) void {
alloc.free(self.name);
}
pub fn readDirectory(alloc: std.mem.Allocator, rdr: *Reader, size: u32) Error![]DirEntry {
var hdr: Header = undefined;
var raw: RawEntry = undefined;
var out: std.ArrayList(DirEntry) = try .initCapacity(alloc, 30);
errdefer {
for (out.items) |ent|
alloc.free(ent.name);
out.deinit(alloc);
}
var tot_red: u32 = 3;
while (tot_red < size) {
try rdr.readSliceEndian(Header, @ptrCast(&hdr), .little);
try out.ensureUnusedCapacity(alloc, hdr.count + 1);
tot_red += @sizeOf(Header);
for (0..hdr.count + 1) |_| {
try rdr.readSliceEndian(RawEntry, @ptrCast(&raw), .little);
const new_name = try alloc.alloc(u8, raw.name_size + 1);
try rdr.readSliceEndian(u8, new_name, .little);
const new = out.addOneAssumeCapacity();
new.* = .{
.block_start = hdr.block_start,
.block_offset = raw.block_offset,
.type = raw.type,
.name = new_name,
};
tot_red += @sizeOf(RawEntry) + raw.name_size + 1;
}
}
return out.toOwnedSlice(alloc);
}
// Types
const Header = extern struct {
count: u32,
block_start: u32,
num: u32,
};
const RawEntry = extern struct {
block_offset: u16,
num_offset: i16,
type: Inode.Type,
name_size: u16,
};
+84 -51
View File
@@ -1,93 +1,126 @@
//! An easier to use wrapper around an inode. //! A wrapper around an Inode to make common activities easier.
const std = @import("std"); const std = @import("std");
const Io = std.Io; const Io = std.Io;
const Archive = @import("archive.zig"); const Archive = @import("archive.zig");
const DirEntry = @import("directory.zig"); const DirEntry = @import("dir_entry.zig");
const ExtractionOptions = @import("options.zig"); const ExtractionOptions = @import("options.zig");
const Inode = @import("inode.zig"); const Inode = @import("inode.zig");
const DataExtractor = @import("util/data_extractor.zig"); const LookupTable = @import("lookup_table.zig");
const Decompressor = @import("util/decompressor.zig");
const MetadataReader = @import("util/metadata.zig"); const MetadataReader = @import("util/metadata.zig");
pub const Error = error{
NotFound,
};
const File = @This(); const File = @This();
alloc: std.mem.Allocator, alloc: std.mem.Allocator,
archive: *Archive,
archive: Archive,
inode: Inode,
name: []const u8, name: []const u8,
inode: Inode,
pub fn fromEntry(alloc: std.mem.Allocator, io: Io, archive: *Archive, entry: DirEntry) !File {
var meta: MetadataReader = .init(io, &archive.cache, archive.super.inode_start + entry.block_start);
defer meta.deinit();
try meta.interface.discardAll(entry.block_offset);
const new_name = try alloc.alloc(u8, entry.name.len);
errdefer alloc.free(new_name);
@memcpy(new_name, entry.name);
/// Creates a new File from an inode. Takes ownership of the Inode and creates a copy of the given name.
/// Requires the given allocator was used to create the Inode.
pub fn init(alloc: std.mem.Allocator, archive: Archive, in: Inode, name: []const u8) !File {
const new_name = try alloc.alloc(u8, name.len);
@memcpy(new_name, name);
return .{ return .{
.alloc = alloc, .alloc = alloc,
.archive = archive, .archive = archive,
.inode = in,
.name = new_name, .name = new_name,
.inode = try .fromReader(alloc, &meta.interface, archive.super.block_size),
}; };
} }
pub fn fromDirEntry(alloc: std.mem.Allocator, archive: *Archive, ent: DirEntry) !File { /// Create a File from an Inode.Ref. name should be created using the alloc given.
var rdr = archive.file.readerAt(archive.super.inode_start + ent.block_start); pub fn fromRef(alloc: std.mem.Allocator, io: Io, archive: *Archive, name: []const u8, ref: Inode.Ref) !File {
var meta: MetadataReader = .init(alloc, &rdr, &archive.stateless_decomp); return .{
try meta.interface.discardAll(ent.block_offset); .alloc = alloc,
.archive = archive,
var in: Inode = try .read(alloc, &meta.interface, archive.super.block_size); .name = name,
errdefer in.deinit(alloc); .inode = try .fromRef(
return .init(alloc, archive.*, in, ent.name); alloc,
io,
&archive.cache,
archive.super.inode_start,
archive.super.block_size,
ref,
),
};
}
pub fn copy(alloc: std.mem.Allocator, from: File) !File {
const new_name = try alloc.alloc(u8, from.name.len);
errdefer alloc.free(new_name);
@memcpy(new_name, from.name);
return .{
.alloc = alloc,
.archive = from.archive,
.inode = try .copy(alloc, from.inode),
.name = new_name,
};
} }
pub fn deinit(self: File) void { pub fn deinit(self: File) void {
self.alloc.free(self.name); self.alloc.free(self.name);
self.inode.deinit(self.alloc); self.inode.deinit(self.alloc);
} }
pub fn open(self: *File, alloc: std.mem.Allocator, io: Io, filepath: []const u8) !File { pub fn open(self: File, alloc: std.mem.Allocator, io: Io, filepath: []const u8) !File {
const entries = try self.inode.readDirectory( const path = std.mem.trim(u8, filepath, "/");
alloc,
self.archive.file, if (path.len == 0 or std.mem.eql(u8, path, ".")) return .copy(alloc, self);
&self.archive.stateless_decomp,
self.archive.super.dir_start, const first_element = std.mem.sliceTo(path, '/');
);
const entries = try self.inode.readDirectory(alloc, io, &self.archive.cache, self.archive.super.dir_start);
defer { defer {
for (entries) |ent| for (entries) |entry|
alloc.free(ent.name); entry.deinit(alloc);
alloc.free(entries); alloc.free(entries);
} }
const path = std.mem.trim(u8, filepath, "/");
const first_element: []const u8 = std.mem.sliceTo(path, '/');
// Potentially I could use linear searching on small dir tables...
var search_slice = entries; var search_slice = entries;
var idx: usize = undefined; var idx = search_slice.len / 2;
while (search_slice.len > 0) { while (search_slice.len > 0) {
idx = search_slice.len / 2; const order = std.mem.order(u8, first_element, search_slice[idx].name);
const middle = search_slice[idx]; switch (order) {
switch (std.mem.order(u8, first_element, middle.name)) {
.eq => break, .eq => break,
.gt => search_slice = search_slice[idx..],
.lt => search_slice = search_slice[0..idx], .lt => search_slice = search_slice[0..idx],
.gt => search_slice = search_slice[idx + 1 ..],
} }
} else return Error.FileNotFound; idx = search_slice.len / 2;
}
if (search_slice.len == 0) return Error.NotFound;
var first_elem_file = try fromDirEntry(alloc, &self.archive, search_slice[idx]); var fil: File = try .fromEntry(alloc, io, self.archive, search_slice[idx]);
if (first_element.len == path.len) if (path.len == first_element.len) return fil;
return first_elem_file; defer fil.deinit();
defer first_elem_file.deinit();
return first_elem_file.open(alloc, io, path[first_element.len + 1 ..]); return fil.open(alloc, io, filepath[first_element.len..]);
} }
pub fn extract(self: File, alloc: std.mem.Allocator, io: Io, filepath: []const u8, options: ExtractionOptions) !void { pub fn extract(self: File, alloc: std.mem.Allocator, io: Io, path: []const u8, options: ExtractionOptions) !void {
return self.inode.extract(alloc, io, self.archive.file, self.archive.super, filepath, options); return self.inode.extract(
alloc,
io,
&self.archive.cache,
self.archive.super.dir_start,
self.archive.super.inode_start,
self.archive.super.frag_start,
self.archive.super.block_size,
self.archive.super.id_start,
self.archive.super.xattr_start,
path,
options,
);
} }
// Types
pub const Error = error{
FileNotFound,
} || Inode.Error;
-78
View File
@@ -1,85 +1,7 @@
const std = @import("std");
const Io = std.Io;
const BlockSize = @import("inode_data/file.zig").BlockSize; const BlockSize = @import("inode_data/file.zig").BlockSize;
const LookupTable = @import("lookup_table.zig");
const Decompressor = @import("util/decompressor.zig");
const MetadataReader = @import("util/metadata.zig");
const OffsetFile = @import("util/offset_file.zig");
const FragManager = @This();
pub const FragEntry = extern struct { pub const FragEntry = extern struct {
start: u64, start: u64,
size: BlockSize, size: BlockSize,
_: u32, _: u32,
}; };
alloc: std.mem.Allocator,
fil: OffsetFile,
decomp: *Decompressor,
block_size: u32,
entries: []FragEntry,
frag_cache: std.array_hash_map.Auto(u32, []u8),
cache_mut: std.Io.RwLock = .init,
pub fn init(alloc: std.mem.Allocator, fil: OffsetFile, decomp: *Decompressor, frag_start: u64, frag_num: u32, block_size: u32) !FragManager {
const first_offset: u64 = std.mem.readInt(u64, @ptrCast(fil.map.memory[frag_start .. frag_start + 8]), .little);
var rdr = fil.readerAt(first_offset);
var meta: MetadataReader = .init(alloc, &rdr, decomp);
const entries = try alloc.alloc(FragEntry, frag_num);
errdefer alloc.free(entries);
try meta.interface.readSliceEndian(FragEntry, entries, .little);
return .{
.alloc = alloc,
.fil = fil,
.decomp = decomp,
.block_size = block_size,
.entries = entries,
.frag_cache = .empty,
};
}
pub fn deinit(self: *FragManager, io: Io) void {
self.cache_mut.lockUncancelable(io);
self.alloc.free(self.entries);
for (self.frag_cache.values()) |v|
self.alloc.free(v);
self.frag_cache.deinit(self.alloc);
}
pub fn get(self: *FragManager, io: Io, idx: u32) ![]u8 {
{
try self.cache_mut.lockShared(io);
defer self.cache_mut.unlockShared(io);
if (self.frag_cache.contains(idx))
return self.frag_cache.get(idx).?;
}
try self.cache_mut.lock(io);
defer self.cache_mut.unlock(io);
if (self.frag_cache.contains(idx))
return self.frag_cache.get(idx).?;
const entry = self.entries[idx];
const out = try self.alloc.alloc(u8, if (entry.size.uncompressed) entry.size.size else self.block_size);
if (entry.size.uncompressed) {
@memcpy(out, self.fil.map.memory[entry.start .. entry.start + entry.size.size]);
} else {
@branchHint(.likely);
_ = try self.decomp.Decompress(self.alloc, self.fil.map.memory[entry.start .. entry.start + entry.size.size], out);
}
try self.frag_cache.put(self.alloc, idx, out);
return out;
}
+297 -496
View File
@@ -1,33 +1,85 @@
//! A file-system object. Represents a File or directory. //! A file-system object. Represents a File or directory.
const std = @import("std"); const std = @import("std");
const Reader = std.Io.Reader;
const Io = std.Io; const Io = std.Io;
const Reader = Io.Reader;
const Archive = @import("archive.zig"); const DirEntry = @import("dir_entry.zig");
const Decomp = @import("decomp.zig").Decomp;
const DirEntry = @import("directory.zig");
const ExtractionOptions = @import("options.zig"); const ExtractionOptions = @import("options.zig");
const FragEntry = @import("frag.zig").FragEntry; const FragEntry = @import("frag.zig").FragEntry;
const FragManager = @import("frag.zig"); const DirTypes = @import("inode_data/dir.zig");
const dir = @import("inode_data/dir.zig"); const FileTypes = @import("inode_data/file.zig");
const file = @import("inode_data/file.zig"); const MiscTypes = @import("inode_data/misc.zig");
const misc = @import("inode_data/misc.zig");
const LookupTable = @import("lookup_table.zig"); const LookupTable = @import("lookup_table.zig");
const CachedTable = LookupTable.CachedTable; const DataExtract = @import("util/data_extract.zig");
const DataExtractor = @import("util/data_extractor.zig"); const DecompCache = @import("util/decomp_cache.zig");
const DataReader = @import("util/data_reader.zig");
const Decompressor = @import("util/decompressor.zig");
const MetadataReader = @import("util/metadata.zig"); const MetadataReader = @import("util/metadata.zig");
const OffsetFile = @import("util/offset_file.zig");
const XattrTable = @import("xattr_table.zig"); pub const Ref = packed struct(u64) {
block_offset: u16,
block_start: u32,
_: u16,
};
pub const Type = enum(u16) {
dir = 1,
file,
symlink,
block_dev,
char_dev,
fifo,
socket,
ext_dir,
ext_file,
ext_symlink,
ext_block_dev,
ext_char_dev,
ext_fifo,
ext_socket,
};
pub const Data = union(Type) {
dir: DirTypes.Dir,
file: FileTypes.File,
symlink: MiscTypes.Symlink,
block_dev: MiscTypes.Dev,
char_dev: MiscTypes.Dev,
fifo: MiscTypes.IPC,
socket: MiscTypes.IPC,
ext_dir: DirTypes.ExtDir,
ext_file: FileTypes.ExtFile,
ext_symlink: MiscTypes.ExtSymlink,
ext_block_dev: MiscTypes.ExtDev,
ext_char_dev: MiscTypes.ExtDev,
ext_fifo: MiscTypes.ExtIPC,
ext_socket: MiscTypes.ExtIPC,
};
pub const Header = packed struct {
inode_type: Type,
permissions: u16,
uid_idx: u16,
gid_idx: u16,
mod_time: u32,
num: u32,
};
pub const Error = error{
NotDirectory,
};
const Inode = @This(); const Inode = @This();
hdr: Header, hdr: Header,
data: Data, data: Data,
pub fn read(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !Inode { pub fn fromRef(alloc: std.mem.Allocator, io: Io, cache: *DecompCache, inode_start: u64, block_size: u32, ref: Ref) !Inode {
var meta: MetadataReader = .init(io, cache, ref.block_start + inode_start);
defer meta.deinit();
try meta.interface.discardAll(ref.block_offset);
return fromReader(alloc, &meta.interface, block_size);
}
pub fn fromReader(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !Inode {
var hdr: Header = undefined; var hdr: Header = undefined;
try rdr.readSliceEndian(Header, @ptrCast(&hdr), .little); try rdr.readSliceEndian(Header, @ptrCast(&hdr), .little);
return .{ return .{
@@ -50,584 +102,333 @@ pub fn read(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !Inode {
}, },
}; };
} }
pub fn copy(alloc: std.mem.Allocator, from: Inode) !Inode {
var new = from;
switch (from.data) {
.file => |f| {
new.data.file.block_sizes = try alloc.alloc(FileTypes.BlockSize, f.block_sizes.len);
@memcpy(new.data.file.block_sizes, f.block_sizes);
},
.ext_file => |f| {
new.data.ext_file.block_sizes = try alloc.alloc(FileTypes.BlockSize, f.block_sizes.len);
@memcpy(new.data.ext_file.block_sizes, f.block_sizes);
},
.symlink => |s| {
const new_target = try alloc.alloc(u8, s.target.len);
@memcpy(new_target, s.target);
new.data.symlink.target = new_target;
},
.ext_symlink => |s| {
const new_target = try alloc.alloc(u8, s.target.len);
@memcpy(new_target, s.target);
new.data.ext_symlink.target = new_target;
},
else => {},
}
return new;
}
pub fn deinit(self: Inode, alloc: std.mem.Allocator) void { pub fn deinit(self: Inode, alloc: std.mem.Allocator) void {
switch (self.data) { switch (self.data) {
.file => |d| d.deinit(alloc), .file => |f| alloc.free(f.block_sizes),
.symlink => |d| d.deinit(alloc), .ext_file => |f| alloc.free(f.block_sizes),
.ext_file => |d| d.deinit(alloc), .symlink => |s| alloc.free(s.target),
.ext_symlink => |d| d.deinit(alloc), .ext_symlink => |s| alloc.free(s.target),
else => {}, else => {},
} }
} }
// Utility Functions pub fn readDirectory(self: Inode, alloc: std.mem.Allocator, io: Io, cache: *DecompCache, dir_start: u64) ![]DirEntry {
/// Read the directory entries
pub fn readDirectory(self: Inode, alloc: std.mem.Allocator, fil: OffsetFile, decomp: *Decompressor, dir_offset: u64) ![]DirEntry {
return switch (self.data) { return switch (self.data) {
.dir => |d| readDirFromData(alloc, fil, decomp, dir_offset, d), .dir => |d| readDirectoryFromData(alloc, io, cache, dir_start, d),
.ext_dir => |d| readDirFromData(alloc, fil, decomp, dir_offset, d), .ext_dir => |d| readDirectoryFromData(alloc, io, cache, dir_start, d),
else => Error.NotDirectory, else => Error.NotDirectory,
}; };
} }
fn readDirFromData(alloc: std.mem.Allocator, fil: OffsetFile, decomp: *Decompressor, dir_offset: u64, d: anytype) ![]DirEntry { fn readDirectoryFromData(alloc: std.mem.Allocator, io: Io, cache: *DecompCache, dir_start: u64, d: anytype) ![]DirEntry {
var rdr = fil.readerAt(dir_offset + d.block_start); var meta: MetadataReader = .init(io, cache, dir_start + d.block_start);
var meta: MetadataReader = .init(alloc, &rdr, decomp); defer meta.deinit();
try meta.interface.discardAll(d.block_offset); try meta.interface.discardAll(d.block_offset);
return DirEntry.readDirectory(alloc, &meta.interface, d.size); return DirEntry.readEntries(alloc, &meta.interface, d.size);
}
/// Get a reader for a regular file's data.
pub fn dataReader(self: Inode, alloc: std.mem.Allocator, io: Io, fil: OffsetFile, decomp: *Decompressor, block_size: u32, frag_block: ?[]u8) !DataReader {
return switch (self.data) {
.file => |f| getReaderFromData(alloc, io, fil, decomp, block_size, frag_block, f),
.ext_file => |f| getReaderFromData(alloc, io, fil, decomp, block_size, frag_block, f),
else => Error.NotRegularFile,
};
}
fn getReaderFromData(alloc: std.mem.Allocator, io: Io, fil: OffsetFile, decomp: *Decompressor, block_size: u32, frag_block: ?[]u8, d: anytype) !DataReader {
const ext: DataReader = .init(alloc, io, fil, decomp, block_size, d.size, d.block_start, d.blocks);
if (d.frag_block_offset == 0xFFFFFFFF) {
if (frag_block == null) return error.FragBlockNotProvided;
ext.addFrag(d.frag_block_offset, frag_block.?);
}
return ext;
}
/// Get an extractor for a regular file's data.
pub fn dataExtractor(self: Inode, fil: OffsetFile, decomp: *Decompressor, block_size: u32, frag_block: ?[]u8) !DataExtractor {
return switch (self.data) {
.file => |f| getExtractorFromData(fil, decomp, block_size, frag_block, f),
.ext_file => |f| getExtractorFromData(fil, decomp, block_size, frag_block, f),
else => Error.NotRegularFile,
};
}
fn getExtractorFromData(fil: OffsetFile, decomp: *Decompressor, block_size: u32, frag_block: ?[]u8, d: anytype) !DataExtractor {
const ext: DataExtractor = .init(fil, decomp, block_size, d.size, d.block_start, d.blocks);
if (d.frag_block_offset == 0xFFFFFFFF) {
if (frag_block == null) return error.FragBlockNotProvided;
ext.addFrag(d.frag_block_offset, frag_block.?);
}
return ext;
}
/// Get a symlink's target path
pub fn symlinkTarget(self: Inode) ![]const u8 {
return switch (self.data) {
.symlink => |s| s.target,
.ext_symlink => |s| s.target,
else => Error.NotSymlink,
};
}
/// Get inode's gid
pub fn gid(self: Inode, alloc: std.mem.Allocator, io: Io, fil: OffsetFile, decomp: *Decompressor, id_table_start: u64) !u16 {
return LookupTable.lookupValue(u16, alloc, io, decomp, fil, id_table_start, self.hdr.gid_idx);
}
/// Get inode's uid
pub fn uid(self: Inode, alloc: std.mem.Allocator, io: Io, fil: OffsetFile, decomp: *Decompressor, id_table_start: u64) !u16 {
return LookupTable.lookupValue(u16, alloc, io, decomp, fil, id_table_start, self.hdr.uid_idx);
}
/// Get the inode's xattr values as an index into the Archive's xattr table.
/// Returns error.NoXattr if the inode doesn't have extended attributes.
pub fn xattrIndex(self: Inode) !u32 {
const idx = switch (self.data) {
.ext_dir => |e| e.xattr_idx,
.ext_file => |e| e.xattr_idx,
.ext_symlink => |e| e.xattr_idx,
.ext_block_dev => |e| e.xattr_idx,
.ext_char_dev => |e| e.xattr_idx,
.ext_fifo => |e| e.xattr_idx,
.ext_socket => |e| e.xattr_idx,
else => return error.NoXattr,
};
if (idx == 0xFFFFFFFF) return error.NoXattr;
return idx;
}
// Get an inode's xattr values. If the inode does not have xattr values (including if the inode is not an extended type), an empty slice is returned.
pub fn xattrValues(self: Inode, alloc: std.mem.Allocator, io: Io, fil: OffsetFile, decomp: *Decompressor, xattr_table_start: u64) ![]XattrTable.XattrOwned {
const idx = self.xattrIndex() catch &[0]XattrTable.XattrOwned{};
return XattrTable.statelessLookup(alloc, io, decomp, fil, xattr_table_start, idx);
} }
// Types // Extraction
pub const Error = error{
NotDirectory,
NotRegularFile,
NotSymlink,
NotExtended,
};
pub const Ref = packed struct(u64) {
block_offset: u16,
block_start: u32,
_: u16 = 0,
};
pub const Type = enum(u16) {
dir = 1,
file,
symlink,
block_dev,
char_dev,
fifo,
socket,
ext_dir,
ext_file,
ext_symlink,
ext_block_dev,
ext_char_dev,
ext_fifo,
ext_socket,
};
pub const Data = union(Type) {
dir: dir.Dir,
file: file.File,
symlink: misc.Symlink,
block_dev: misc.Dev,
char_dev: misc.Dev,
fifo: misc.IPC,
socket: misc.IPC,
ext_dir: dir.ExtDir,
ext_file: file.ExtFile,
ext_symlink: misc.ExtSymlink,
ext_block_dev: misc.ExtDev,
ext_char_dev: misc.ExtDev,
ext_fifo: misc.ExtIPC,
ext_socket: misc.ExtIPC,
};
pub const Header = extern struct {
inode_type: Type,
permissions: u16,
uid_idx: u16,
gid_idx: u16,
mod_time: u32,
num: u32,
};
// Extract
const ExtractError = error{ MknodFailed, CannotSetXattr } || DataExtractor.Error || DirEntry.Error ||
Decompressor.Error || Io.File.Atomic.InitError || Io.File.Atomic.LinkError || Io.Dir.SymLinkError;
const PathRet = struct {
path: []const u8,
inode: Inode,
origin: bool,
fn deinit(self: PathRet, alloc: std.mem.Allocator) void {
if (self.origin) return;
alloc.free(self.path);
self.inode.deinit(alloc);
}
fn setMetadata(self: PathRet, alloc: std.mem.Allocator, io: Io, id_table: *CachedTable(u16), xattr_table: ?*XattrTable, options: ExtractionOptions) !void {
var fil = try Io.Dir.cwd().openFile(io, self.path, .{});
defer fil.close(io);
const inode = self.inode;
if (!options.ignore_permissions) {
try fil.setPermissions(io, @enumFromInt(inode.hdr.permissions));
try fil.setOwner(io, try id_table.get(io, inode.hdr.uid_idx), try id_table.get(io, inode.hdr.gid_idx));
}
if (xattr_table != null) {
const idx = inode.xattrIndex() catch return;
const xattrs = try xattr_table.?.get(alloc, io, idx);
defer {
for (xattrs) |x|
x.deinit(alloc);
alloc.free(xattrs);
}
const sentinel_path = try std.mem.concatWithSentinel(alloc, u8, &[_][]const u8{self.path}, 0);
defer alloc.free(sentinel_path);
for (xattrs) |x| {
const xattr_ret = std.os.linux.fsetxattr(fil.handle, x.key, x.value.ptr, x.value.len, 0);
if (xattr_ret != 0)
return ExtractError.CannotSetXattr;
}
}
}
};
fn DirCompare(_: void, a: PathRet, b: PathRet) std.math.Order {
return std.math.order(std.mem.count(u8, a.path, "/"), std.mem.count(u8, b.path, "/"));
}
const ExtractReturnUnion = union(enum) {
path_ret: ExtractError!PathRet,
};
const Tables = struct {
id: LookupTable.CachedTable(u16),
frag: LookupTable.CachedTable(FragEntry),
xattr: XattrTable,
};
/// Extracts the given inode to the given path. If the inode not a directory, the given path must not exist.
/// If the inode is a directory the path must not exist or be a directory.
pub fn extract( pub fn extract(
self: Inode, self: Inode,
alloc: std.mem.Allocator, alloc: std.mem.Allocator,
io: Io, io: Io,
fil: OffsetFile, cache: *DecompCache,
super: Archive.Superblock, dir_start: u64,
filepath: []const u8, inode_start: u64,
frag_start: u64,
block_size: u32,
id_start: u64,
xattr_start: u64,
ext_loc: []const u8,
options: ExtractionOptions, options: ExtractionOptions,
) !void { ) !void {
const path = std.mem.trimEnd(u8, filepath, "/"); const path = std.mem.trimEnd(u8, ext_loc, "/");
var decomp_base: Decompressor = try @import("decomp.zig").StatelessDecomp(super.compression); // TODO: Replace with actual Decomp value to share states & caches for efficiency. var sel_val: std.atomic.Value(usize) = .init(1);
const decomp = &decomp_base;
var frag_mgr: FragManager = try .init(alloc, fil, decomp, super.frag_start, super.frag_count, super.block_size); var sel_buf: [5]ExtractUnion = undefined;
defer frag_mgr.deinit(io); var sel: Io.Select(ExtractUnion) = .init(io, &sel_buf);
if (options.single_threaded)
return self.extractSinglethreaded(alloc, io, fil, super, path, options, decomp, &frag_mgr);
var sel_buf: [10]ExtractReturnUnion = undefined;
var sel: Io.Select(ExtractReturnUnion) = .init(io, &sel_buf);
defer sel.cancelDiscard(); defer sel.cancelDiscard();
var loop = io.async(finishLoop, .{ alloc, io, fil, decomp, super, options, &sel }); var meta_loop = io.async(metadataLoop, .{ alloc, io, cache, id_start, xattr_start, &sel, &sel_val, options });
defer _ = meta_loop.cancel(io) catch {};
sel.async(.path_ret, extractRealAsync, .{ self, alloc, io, fil, super, decomp, &sel, &frag_mgr, path, true }); sel.async(.ret, extractReal, .{ self, alloc, io, cache, dir_start, inode_start, frag_start, block_size, &sel, &sel_val, path, true });
try loop.await(io); try meta_loop.await(io);
} }
fn extractRealAsync( fn extractReal(
self: Inode, self: Inode,
alloc: std.mem.Allocator, alloc: std.mem.Allocator,
io: Io, io: Io,
fil: OffsetFile, cache: *DecompCache,
super: Archive.Superblock, dir_start: u64,
decomp: *Decompressor, inode_start: u64,
sel: *Io.Select(ExtractReturnUnion), frag_start: u64,
frag_mgr: *FragManager, block_size: u32,
sel: *Io.Select(ExtractUnion),
sel_val: *std.atomic.Value(usize),
path: []const u8, path: []const u8,
origin: bool, origin: bool,
) ExtractError!PathRet { ) ExtractionError!ExtractReturn {
errdefer { errdefer if (!origin) {
if (!origin) {
self.deinit(alloc); self.deinit(alloc);
alloc.free(path); alloc.free(path);
} };
}
switch (self.hdr.inode_type) { switch (self.hdr.inode_type) {
.dir, .ext_dir => { .dir, .ext_dir => {
try Io.Dir.cwd().createDir(io, path, @enumFromInt(0o777)); try Io.Dir.cwd().createDir(io, path, @enumFromInt(0o777));
const entries = self.readDirectory(alloc, fil, decomp, super.dir_start) catch |err| switch (err) { const entries = self.readDirectory(alloc, io, cache, dir_start) catch |err| switch (err) {
Error.NotDirectory, Error.NotExtended, Error.NotRegularFile, Error.NotSymlink => unreachable, error.NotDirectory => unreachable,
else => |e| return e, else => |e| return e,
}; };
defer { defer {
for (entries) |e| for (entries) |entry|
e.deinit(alloc); entry.deinit(alloc);
alloc.free(entries); alloc.free(entries);
} }
for (entries) |e| { if (entries.len != 0) {
const new_path = try std.mem.concat(alloc, u8, &[_][]const u8{ path, "/", e.name }); _ = sel_val.fetchAdd(entries.len, .acq_rel);
errdefer alloc.free(new_path);
var rdr = fil.readerAt(super.inode_start + e.block_start); for (entries) |entry| {
var meta: MetadataReader = .init(alloc, &rdr, decomp); var meta: MetadataReader = .init(io, cache, inode_start + entry.block_start);
try meta.interface.discardAll(e.block_offset); defer meta.deinit();
try meta.interface.discardAll(entry.block_offset);
const new_inode = try read(alloc, &meta.interface, super.block_size); var new_inode: Inode = try .fromReader(alloc, &meta.interface, block_size);
errdefer new_inode.deinit(alloc); errdefer new_inode.deinit(alloc);
sel.async(.path_ret, extractRealAsync, .{ new_inode, alloc, io, fil, super, decomp, sel, frag_mgr, new_path, false }); const new_path = try std.mem.concat(alloc, u8, &.{ path, "/", entry.name });
errdefer alloc.free(new_path);
sel.async(
.ret,
extractReal,
.{ new_inode, alloc, io, cache, dir_start, inode_start, frag_start, block_size, sel, sel_val, new_path, false },
);
}
} }
}, },
.file, .ext_file => { .file, .ext_file => {
var atomic = try Io.Dir.cwd().createFileAtomic(io, path, .{ .make_path = true }); std.debug.print("{s} {}\n", .{ path, self.data });
defer atomic.deinit(io); // var atomic = try Io.Dir.cwd().createFileAtomic(io, path, .{});
// defer atomic.deinit(io);
var ext: DataExtractor = switch (self.data) { // var data: DataExtract = undefined;
.file => |f| blk: { // var frag_offset: ?u64 = null;
var ext: DataExtractor = .init(fil, decomp, super.block_size, f.size, f.block_start, f.block_sizes); // switch (self.data) {
if (f.frag_idx != 0xFFFFFFFF) // .file => |f| {
ext.addFrag(f.frag_block_offset, try frag_mgr.get(io, f.frag_idx)); // data = .init(cache.decomp, cache.map, block_size, f.block_start, f.size, f.block_sizes);
break :blk ext; // if (f.frag_idx != 0xFFFFFFFF) {
}, // const entry: FragEntry = try LookupTable.lookup(FragEntry, io, cache, frag_start, f.frag_idx);
.ext_file => |f| blk: { // if (entry.size.uncompressed) {
var ext: DataExtractor = .init(fil, decomp, super.block_size, f.size, f.block_start, f.block_sizes); // data.addFrag(cache.map.memory[entry.start..][0..entry.size.size], f.frag_offset);
if (f.frag_idx != 0xFFFFFFFF) // } else {
ext.addFrag(f.frag_block_offset, try frag_mgr.get(io, f.frag_idx)); // frag_offset = entry.start;
break :blk ext; // const block = try cache.checkoutBlock(io, entry.start, entry.size.size, block_size);
// data.addFrag(block, f.frag_offset);
// }
// }
// },
// .ext_file => |f| {
// data = .init(cache.decomp, cache.map, block_size, f.block_start, f.size, f.block_sizes);
// if (f.frag_idx != 0xFFFFFFFF) {
// const entry: FragEntry = try LookupTable.lookup(FragEntry, io, cache, frag_start, f.frag_idx);
// if (entry.size.uncompressed) {
// data.addFrag(cache.map.memory[entry.start..][0..entry.size.size], f.frag_offset);
// } else {
// frag_offset = entry.start;
// const block = try cache.checkoutBlock(io, entry.start, entry.size.size, block_size);
// data.addFrag(block, f.frag_offset);
// }
// }
// },
// else => unreachable,
// }
// defer if (frag_offset != null) cache.checkinBlock(io, frag_offset.?) catch {};
// try data.asyncExtract(alloc, io, atomic.file);
// try atomic.link(io);
}, },
.symlink, .ext_symlink => {
const target = switch (self.data) {
.symlink => |s| s.target,
.ext_symlink => |s| s.target,
else => unreachable, else => unreachable,
}; };
try Io.Dir.cwd().symLink(io, target, path, .{});
try ext.extractAsync(alloc, io, atomic.file);
try atomic.link(io);
}, },
.symlink, .ext_symlink => try Io.Dir.cwd().symLink(io, self.symlinkTarget() catch unreachable, path, .{}),
else => { else => {
var mode: u32 = undefined;
var dev: u32 = 0; var dev: u32 = 0;
var mode: u32 = undefined;
const DT = std.posix.DT; const DT = std.os.linux.DT;
switch (self.data) { switch (self.data) {
.char_dev => |d| {
dev = d.dev;
mode = DT.CHR;
},
.ext_char_dev => |d| {
dev = d.dev;
mode = DT.CHR;
},
.block_dev => |d| { .block_dev => |d| {
dev = d.dev;
mode = DT.BLK; mode = DT.BLK;
dev = d.dev;
}, },
.ext_block_dev => |d| { .ext_block_dev => |d| {
dev = d.dev;
mode = DT.BLK; mode = DT.BLK;
dev = d.dev;
},
.char_dev => |d| {
mode = DT.CHR;
dev = d.dev;
},
.ext_char_dev => |d| {
mode = DT.CHR;
dev = d.dev;
}, },
.fifo, .ext_fifo => mode = DT.FIFO, .fifo, .ext_fifo => mode = DT.FIFO,
.socket, .ext_socket => mode = DT.SOCK, .socket, .ext_socket => mode = DT.SOCK,
else => unreachable, else => unreachable,
} }
const sentinel_path = try std.mem.concatWithSentinel(alloc, u8, &[_][]const u8{path}, 0); const sentinel_path = try std.mem.concatWithSentinel(alloc, u8, &.{path}, 0);
defer alloc.free(sentinel_path);
const res = std.os.linux.mknod(sentinel_path, mode, dev); const res = std.os.linux.mknod(sentinel_path, mode, dev);
alloc.free(sentinel_path);
if (res != 0) if (res != 0)
return ExtractError.MknodFailed; return ExtractionError.Mknod;
}, },
} }
return .{ return .{
.path = path, .path = path,
.inode = self, .inode = self,
.origin = origin, .origin = origin,
}; };
} }
fn finishLoop(alloc: std.mem.Allocator, io: Io, fil: OffsetFile, decomp: *Decompressor, super: Archive.Superblock, options: ExtractionOptions, sel: *Io.Select(ExtractReturnUnion)) !void {
var id_table: CachedTable(u16) = .init(alloc, fil, decomp, super.id_start, super.id_count);
defer id_table.deinit(io);
var xattr_table: ?XattrTable = if (super.flags.xattr_never or options.ignore_xattr or !@hasField(std.os, "linux")) const ExtractUnion = union { ret: ExtractionError!ExtractReturn };
null pub const ExtractionError = error{ SetXattr, Mknod, Canceled } || DirEntry.Error || Io.Dir.CreateFileAtomicError || DataExtract.Error || Io.File.Atomic.LinkError ||
else Io.Dir.SymLinkError;
try .init(alloc, fil, decomp, super.xattr_start);
defer if (xattr_table != null) xattr_table.?.deinit(io);
var dir_queue: std.PriorityDequeue(PathRet, void, DirCompare) = .empty; const ExtractReturn = struct {
defer dir_queue.deinit(alloc);
while (true) {
if (sel.group.token.load(.unordered) == null) break;
const ret = try sel.await();
const path_ret = try ret.path_ret;
if (options.ignore_permissions and xattr_table == null) {
path_ret.deinit(alloc);
continue;
}
if (path_ret.inode.hdr.inode_type == .dir or path_ret.inode.hdr.inode_type == .ext_dir) {
try dir_queue.push(alloc, path_ret);
continue;
}
defer path_ret.deinit(alloc);
try path_ret.setMetadata(alloc, io, &id_table, if (xattr_table == null) null else &xattr_table.?, options);
}
while (sel.cancel()) |ret| {
const path_ret = try ret.path_ret;
if (options.ignore_permissions and xattr_table == null) {
path_ret.deinit(alloc);
continue;
}
if (path_ret.inode.hdr.inode_type == .dir or path_ret.inode.hdr.inode_type == .ext_dir) {
try dir_queue.push(alloc, path_ret);
continue;
}
defer path_ret.deinit(alloc);
try path_ret.setMetadata(alloc, io, &id_table, if (xattr_table == null) null else &xattr_table.?, options);
}
var iter = dir_queue.iterator();
while (iter.next()) |path_ret| {
defer path_ret.deinit(alloc);
try path_ret.setMetadata(alloc, io, &id_table, if (xattr_table == null) null else &xattr_table.?, options);
}
}
/// Extracts the given inode to the given path. If the inode not a directory, the given path must not exist.
/// If the inode is a directory the path must not exist or be a directory.
fn extractSinglethreaded(
self: Inode,
alloc: std.mem.Allocator,
io: Io,
fil: OffsetFile,
super: Archive.Superblock,
path: []const u8, path: []const u8,
options: ExtractionOptions, inode: Inode,
decomp: *Decompressor, origin: bool,
frag: *FragManager,
) !void {
var id_table: CachedTable(u16) = .init(alloc, fil, decomp, super.id_start, super.id_count);
defer id_table.deinit(io);
var xattr_table: ?XattrTable = if (super.flags.xattr_never or options.ignore_xattr or !@hasField(std.os, "linux")) fn deinit(self: ExtractReturn, alloc: std.mem.Allocator) void {
null if (self.origin) return;
else alloc.free(self.path);
try .init(alloc, fil, decomp, super.xattr_start); self.inode.deinit(alloc);
defer if (xattr_table != null) xattr_table.?.deinit(io);
return self.extractReal(
alloc,
io,
fil,
super,
decomp,
frag,
&id_table,
if (xattr_table == null) null else &xattr_table.?,
path,
options,
);
}
fn extractReal(
self: Inode,
alloc: std.mem.Allocator,
io: Io,
fil: OffsetFile,
super: Archive.Superblock,
decomp: *Decompressor,
frag_mgr: *FragManager,
id_table: *CachedTable(u16),
xattr_table: ?*XattrTable,
path: []const u8,
options: ExtractionOptions,
) !void {
switch (self.hdr.inode_type) {
.dir, .ext_dir => {
try Io.Dir.cwd().createDir(io, path, @enumFromInt(0o777));
const entries = self.readDirectory(alloc, fil, decomp, super.dir_start) catch |err| switch (err) {
Error.NotDirectory, Error.NotExtended, Error.NotRegularFile, Error.NotSymlink => unreachable,
else => |e| return e,
};
defer {
for (entries) |e|
e.deinit(alloc);
alloc.free(entries);
}
for (entries) |e| {
const new_path = try std.mem.concat(alloc, u8, &[_][]const u8{ path, "/", e.name });
defer alloc.free(new_path);
var rdr = fil.readerAt(super.inode_start + e.block_start);
var meta: MetadataReader = .init(alloc, &rdr, decomp);
try meta.interface.discardAll(e.block_offset);
const new_inode = try read(alloc, &meta.interface, super.block_size);
defer new_inode.deinit(alloc);
try new_inode.extractReal(alloc, io, fil, super, decomp, frag_mgr, id_table, xattr_table, new_path, options);
}
},
.file, .ext_file => {
var atomic = try Io.Dir.cwd().createFileAtomic(io, path, .{ .make_path = true });
defer atomic.deinit(io);
var rdr: DataReader = switch (self.data) {
.file => |f| blk: {
var ext: DataReader = try .init(alloc, io, fil, decomp, super.block_size, f.size, f.block_start, f.block_sizes);
if (f.frag_idx != 0xFFFFFFFF)
ext.addFrag(f.frag_block_offset, try frag_mgr.get(io, f.frag_idx));
break :blk ext;
},
.ext_file => |f| blk: {
var ext: DataReader = try .init(alloc, io, fil, decomp, super.block_size, f.size, f.block_start, f.block_sizes);
if (f.frag_idx != 0xFFFFFFFF)
ext.addFrag(f.frag_block_offset, try frag_mgr.get(io, f.frag_idx));
break :blk ext;
},
else => unreachable,
};
defer rdr.deinit();
var buf: [512 * 1024]u8 = undefined;
var wrt = atomic.file.writer(io, &buf);
_ = try rdr.interface.streamRemaining(&wrt.interface);
try wrt.flush();
try atomic.link(io);
},
.symlink, .ext_symlink => try Io.Dir.cwd().symLink(io, self.symlinkTarget() catch unreachable, path, .{}),
else => {
var mode: u32 = undefined;
var dev: u32 = 0;
const DT = std.posix.DT;
switch (self.data) {
.char_dev => |d| {
dev = d.dev;
mode = DT.CHR;
},
.ext_char_dev => |d| {
dev = d.dev;
mode = DT.CHR;
},
.block_dev => |d| {
dev = d.dev;
mode = DT.BLK;
},
.ext_block_dev => |d| {
dev = d.dev;
mode = DT.BLK;
},
.fifo, .ext_fifo => mode = DT.FIFO,
.socket, .ext_socket => mode = DT.SOCK,
else => unreachable,
}
const sentinel_path = try std.mem.concatWithSentinel(alloc, u8, &[_][]const u8{path}, 0);
const res = std.os.linux.mknod(sentinel_path, mode, dev);
alloc.free(sentinel_path);
if (res != 0)
return ExtractError.MknodFailed;
},
} }
fn setMetadata(self: ExtractReturn, alloc: std.mem.Allocator, io: Io, cache: *DecompCache, id_start: u64, xattr_start: u64, options: ExtractionOptions) !void {
if (options.ignore_permissions and options.ignore_xattr) return; if (options.ignore_permissions and options.ignore_xattr) return;
var f = try Io.Dir.cwd().openFile(io, path, .{}); var fil = try Io.Dir.cwd().openFile(io, self.path, .{});
defer f.close(io); defer fil.close(io);
if (!options.ignore_permissions) { if (!options.ignore_permissions) {
try f.setPermissions(io, @enumFromInt(self.hdr.permissions)); try fil.setTimestamps(io, .{ .modify_timestamp = .{
try f.setOwner(io, try id_table.get(io, self.hdr.uid_idx), try id_table.get(io, self.hdr.gid_idx)); .new = .{ .nanoseconds = @as(i96, @intCast(self.inode.hdr.mod_time)) * std.time.ns_per_s },
} });
try fil.setPermissions(io, @enumFromInt(self.inode.hdr.permissions));
try fil.setOwner(
io,
try LookupTable.lookup(u16, io, cache, id_start, self.inode.hdr.uid_idx),
try LookupTable.lookup(u16, io, cache, id_start, self.inode.hdr.gid_idx),
);
} }
if (xattr_table != null) { if (options.ignore_xattr) return;
const idx = self.xattrIndex() catch return; const xattr_idx: u32 = switch (self.inode.data) {
.ext_dir => |d| d.xattr_idx,
const xattrs = try xattr_table.?.get(alloc, io, idx); .ext_file => |f| f.xattr_idx,
.ext_symlink => |s| s.xattr_idx,
.ext_block_dev, .ext_char_dev => |d| d.xattr_idx,
.ext_fifo, .ext_socket => |i| i.xattr_idx,
else => return,
};
if (xattr_idx == 0xFFFFFFFF) return;
const xattrs = try LookupTable.xattrLookup(alloc, io, cache, xattr_start, xattr_idx);
defer { defer {
for (xattrs) |x| for (xattrs) |kv|
x.deinit(alloc); kv.deinit(alloc);
alloc.free(xattrs); alloc.free(xattrs);
} }
const sentinel_path = try std.mem.concatWithSentinel(alloc, u8, &[_][]const u8{path}, 0); for (xattrs) |kv| {
defer alloc.free(sentinel_path); const res = std.os.linux.fsetxattr(fil.handle, kv.key.ptr, kv.value.ptr, kv.value.len, 0);
for (xattrs) |x| { if (res != 0)
const xattr_ret = std.os.linux.fsetxattr(f.handle, x.key, x.value.ptr, x.value.len, 0); return ExtractionError.SetXattr;
if (xattr_ret != 0)
return ExtractError.CannotSetXattr;
} }
} }
};
fn metadataLoop(
alloc: std.mem.Allocator,
io: Io,
cache: *DecompCache,
id_start: u64,
xattr_start: u64,
sel: *Io.Select(ExtractUnion),
sel_val: *std.atomic.Value(usize),
options: ExtractionOptions,
) !void {
errdefer {
while (sel.group.token.load(.unordered) != null) {
const ret = sel.queue.getOne(io) catch break;
const res = ret.ret catch continue;
res.deinit(alloc);
}
}
var dir_queue: std.PriorityDequeue(ExtractReturn, void, dirReturnQueueOrder) = .empty;
defer {
while (dir_queue.popMax()) |ret|
ret.deinit(alloc);
dir_queue.deinit(alloc);
}
while (sel_val.load(.unordered) > 0) {
defer _ = sel_val.fetchSub(1, .acq_rel);
const ret = try sel.queue.getOne(io);
const res = try ret.ret;
if (res.inode.hdr.inode_type == .dir or res.inode.hdr.inode_type == .ext_dir) {
try dir_queue.push(alloc, res);
} else {
defer res.deinit(alloc);
try res.setMetadata(alloc, io, cache, id_start, xattr_start, options);
}
}
while (dir_queue.popMax()) |res| {
defer res.deinit(alloc);
try res.setMetadata(alloc, io, cache, id_start, xattr_start, options);
}
}
fn dirReturnQueueOrder(_: void, a: ExtractReturn, b: ExtractReturn) std.math.Order {
return std.math.order(std.mem.count(u8, a.path, "/"), std.mem.count(u8, b.path, "/"));
} }
+45 -51
View File
@@ -7,37 +7,34 @@ pub const BlockSize = packed struct(u32) {
_: u7, _: u7,
}; };
const FileRawRead = extern struct {
block_start: u32,
frag_idx: u32,
frag_block_offset: u32,
size: u32,
};
pub const File = struct { pub const File = struct {
block_start: u32, block_start: u32, // bytes 0-3
frag_idx: u32, frag_idx: u32, // bytes 4-7
frag_block_offset: u32, frag_offset: u32, // bytes 8-11
size: u32, size: u32, // bytes 12-15
block_sizes: []BlockSize, block_sizes: []BlockSize,
pub fn read(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !File { pub fn read(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !File {
var raw: FileRawRead = undefined; const raw_values = extern struct {
try rdr.readSliceEndian(FileRawRead, @ptrCast(&raw), .little); block_start: u32, // bytes 0-3
frag_idx: u32, // bytes 4-7
var num_blocks: u32 = raw.size / block_size; frag_offset: u32, // bytes 8-11
if (raw.size % block_size != 0 and raw.frag_idx == 0xFFFFFFFF) size: u32, // bytes 12-15
num_blocks += 1; };
var values: raw_values = undefined;
try rdr.readSliceEndian(@TypeOf(values), @ptrCast(&values), .little);
var num_blocks: u32 = values.size / block_size;
if (values.size % block_size != 0 and values.frag_idx == 0xFFFFFFFF) num_blocks += 1;
const sizes = try alloc.alloc(BlockSize, num_blocks); const sizes = try alloc.alloc(BlockSize, num_blocks);
errdefer alloc.free(sizes); errdefer alloc.free(sizes);
try rdr.readSliceEndian(BlockSize, sizes, .little); try rdr.readSliceEndian(BlockSize, sizes, .little);
return .{ return .{
.block_start = raw.block_start, .block_start = values.block_start,
.frag_idx = raw.frag_idx, .frag_idx = values.frag_idx,
.frag_block_offset = raw.frag_block_offset, .frag_offset = values.frag_offset,
.size = raw.size, .size = values.size,
.block_sizes = sizes, .block_sizes = sizes,
}; };
} }
@@ -47,46 +44,43 @@ pub const File = struct {
} }
}; };
const ExtFileRawRead = extern struct {
block_start: u64,
size: u64,
sparse: u64,
hard_links: u32,
frag_idx: u32,
frag_block_offset: u32,
xattr_idx: u32,
};
pub const ExtFile = struct { pub const ExtFile = struct {
block_start: u64, block_start: u64, // bytes 0-7
size: u64, size: u64, // bytes 8-15
sparse: u64, sparse: u64, // bytes 16-23
hard_links: u32, hard_links: u32, // bytes 24-27
frag_idx: u32, frag_idx: u32, // bytes 28-31
frag_block_offset: u32, frag_offset: u32, // bytes 32-35
xattr_idx: u32, xattr_idx: u32, // bytes 36-39
block_sizes: []BlockSize, block_sizes: []BlockSize,
pub fn read(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !ExtFile { pub fn read(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !ExtFile {
var raw: ExtFileRawRead = undefined; const raw_values = extern struct {
try rdr.readSliceEndian(ExtFileRawRead, @ptrCast(&raw), .little); block_start: u64, // bytes 0-7
size: u64, // bytes 8-15
var num_blocks: u32 = @truncate(raw.size / block_size); sparse: u64, // bytes 16-23
if (raw.size % block_size != 0 and raw.frag_idx == 0xFFFFFFFF) hard_links: u32, // bytes 24-27
num_blocks += 1; frag_idx: u32, // bytes 28-31
frag_offset: u32, // bytes 32-35
xattr_idx: u32, // bytes 36-39
};
var values: raw_values = undefined;
try rdr.readSliceEndian(@TypeOf(values), @ptrCast(&values), .little);
var num_blocks: u32 = @truncate(values.size / block_size);
if (values.size % block_size != 0 and values.frag_idx == 0xFFFFFFFF) num_blocks += 1;
const sizes = try alloc.alloc(BlockSize, num_blocks); const sizes = try alloc.alloc(BlockSize, num_blocks);
errdefer alloc.free(sizes); errdefer alloc.free(sizes);
try rdr.readSliceEndian(BlockSize, sizes, .little); try rdr.readSliceEndian(BlockSize, sizes, .little);
return .{ return .{
.block_start = raw.block_start, .block_start = values.block_start,
.size = raw.size, .size = values.size,
.sparse = raw.sparse, .sparse = values.sparse,
.hard_links = raw.hard_links, .hard_links = values.hard_links,
.frag_idx = raw.frag_idx, .frag_idx = values.frag_idx,
.frag_block_offset = raw.frag_block_offset, .frag_offset = values.frag_offset,
.xattr_idx = raw.xattr_idx, .xattr_idx = values.xattr_idx,
.block_sizes = sizes, .block_sizes = sizes,
}; };
} }
+108 -109
View File
@@ -1,125 +1,124 @@
const std = @import("std"); const std = @import("std");
const Io = std.Io; const Io = std.Io;
const Decompressor = @import("util/decompressor.zig"); const Inode = @import("inode.zig");
const DecompCache = @import("util/decomp_cache.zig");
const MetadataReader = @import("util/metadata.zig"); const MetadataReader = @import("util/metadata.zig");
const OffsetFile = @import("util/offset_file.zig");
pub fn lookupValue(comptime T: anytype, alloc: std.mem.Allocator, decomp: *Decompressor, file: OffsetFile, table_start: u64, idx: u32) !T { pub fn lookup(comptime T: anytype, io: Io, cache: *DecompCache, table_start: u64, idx: u32) !T {
const T_PER_BLOCK: u16 = 8192 / @sizeOf(T); const PER_BLOCK = 8192 / @sizeOf(T);
const block = idx / T_PER_BLOCK; const block_idx = idx / PER_BLOCK;
const block_offset = idx % T_PER_BLOCK; const block_offset = idx % PER_BLOCK;
const offset_pos = table_start + (8 * block); if (table_start + (block_idx * 8) > cache.map.memory.len) return error.ReadFailed;
const offset: u64 = std.mem.readInt(u64, @ptrCast(file.map.memory[offset_pos .. offset_pos + 8]), .little); const offset: u64 = std.mem.readInt(u64, cache.map.memory[table_start + (block_idx * 8) ..][0..8], .little);
var rdr = file.readerAt(offset); var meta: MetadataReader = .init(io, cache, offset);
var meta: MetadataReader = .init(alloc, &rdr, decomp); defer meta.deinit();
try meta.interface.discardAll(block_offset * @sizeOf(T));
var new: T = undefined;
try meta.interface.readSliceEndian(T, @ptrCast(&new), .little);
return new;
}
pub const XattrKV = struct {
key: [:0]u8,
value: []u8,
pub fn deinit(self: XattrKV, alloc: std.mem.Allocator) void {
alloc.free(self.key);
alloc.free(self.value);
}
};
const LookupValue = extern struct {
ref: Inode.Ref,
count: u32,
size: u32,
};
const KeyEntry = extern struct {
prefix: packed struct(u16) {
prefix: enum(u8) {
user,
trusted,
security,
},
out_of_line: bool,
_: u7,
},
name_size: u16,
};
pub fn xattrLookup(alloc: std.mem.Allocator, io: Io, cache: *DecompCache, xattr_start: u64, idx: u32) ![]XattrKV {
const table_start = std.mem.readInt(u64, cache.map.memory[xattr_start..][0..8], .little);
const val: LookupValue = try lookup(
LookupValue,
io,
cache,
xattr_start + 16,
idx,
);
const out = try alloc.alloc(XattrKV, val.count);
errdefer alloc.free(out);
var meta: MetadataReader = .init(io, cache, table_start + val.ref.block_start);
defer meta.deinit();
try meta.interface.discardAll(val.ref.block_offset);
for (out) |*kv| {
var key_entry: KeyEntry = undefined;
try meta.interface.readSliceEndian(KeyEntry, @ptrCast(&key_entry), .little);
const prefix_len: u16 = switch (key_entry.prefix.prefix) {
.user => 5,
.trusted => 8,
.security => 9,
};
var key_len = key_entry.name_size;
key_len += prefix_len;
kv.key = try alloc.allocSentinel(u8, key_len, 0);
errdefer alloc.free(kv.key);
try meta.interface.readSliceEndian(u8, kv.key[prefix_len..], .little);
switch (key_entry.prefix.prefix) {
.user => @memcpy(kv.key[0..prefix_len], "user."),
.trusted => @memcpy(kv.key[0..prefix_len], "trusted."),
.security => @memcpy(kv.key[0..prefix_len], "security."),
}
if (key_entry.prefix.out_of_line) {
try meta.interface.discardAll(8);
var ool_ref: Inode.Ref = undefined;
try meta.interface.readSliceEndian(Inode.Ref, @ptrCast(&ool_ref), .little);
var ool_meta: MetadataReader = .init(io, cache, table_start + ool_ref.block_start);
defer ool_meta.deinit();
try ool_meta.interface.discardAll(ool_ref.block_offset);
kv.value = try readValue(alloc, &ool_meta.interface);
errdefer alloc.free(kv.value);
} else {
kv.value = try readValue(alloc, &meta.interface);
}
}
try meta.interface.discardAll(@sizeOf(T) * block_offset);
var out: T = undefined;
try meta.interface.readSliceEndian(T, @ptrCast(&out), .little);
return out; return out;
} }
pub const Error = Io.Cancelable || Io.File.Reader.SeekError || Io.Reader.ReadAllocError; fn readValue(alloc: std.mem.Allocator, rdr: *Io.Reader) ![]u8 {
var val_size: u32 = undefined;
try rdr.readSliceEndian(u32, @ptrCast(&val_size), .little);
pub fn CachedTable(comptime T: anytype) type { const val = try alloc.alloc(u8, val_size);
return struct { errdefer alloc.free(val);
const T_PER_BLOCK: u16 = 8192 / @sizeOf(T);
const Table = @This(); try rdr.readSliceEndian(u8, val, .little);
alloc: std.mem.Allocator, return val;
fil: OffsetFile,
decomp: *Decompressor,
table_start: u64,
total_num: u32,
table: std.AutoHashMap(u32, []T),
mut: Io.RwLock = .init,
pub fn init(alloc: std.mem.Allocator, fil: OffsetFile, decomp: *Decompressor, offset: u64, total_num: u32) Table {
return .{
.alloc = alloc,
.fil = fil,
.decomp = decomp,
.table_start = offset,
.total_num = total_num,
.table = .init(alloc),
};
}
pub fn deinit(self: *Table, io: Io) void {
self.mut.lockUncancelable(io);
var iter = self.table.valueIterator();
while (iter.next()) |val|
self.alloc.free(val.*);
self.table.deinit();
}
pub fn fill(self: *Table, io: Io) Error!void {
try self.mut.lock(io);
defer self.mut.unlock(io);
var num_blocks = self.total_num / T_PER_BLOCK;
if (self.total_num % T_PER_BLOCK > 0)
num_blocks += 1;
for (0..num_blocks) |block| {
const offset_pos = self.table_start + (8 * block);
const offset: u64 = std.mem.readInt(u64, @ptrCast(self.fil.map.memory[offset_pos .. offset_pos + 8]), .little);
const len: u16 = if (self.total_num % T_PER_BLOCK != 0 and block == (self.total_num - 1) / T_PER_BLOCK)
@truncate(self.total_num % T_PER_BLOCK)
else
T_PER_BLOCK;
var rdr = self.fil.readerAt(offset);
var meta: MetadataReader = .init(self.alloc, &rdr.interface, self.decomp);
const slice = try meta.interface.readSliceEndianAlloc(self.alloc, T, len, .little);
try self.table.put(@truncate(block), slice);
}
}
pub fn get(self: *Table, io: Io, idx: u32) Error!T {
const block = idx / T_PER_BLOCK;
const block_offset = idx % T_PER_BLOCK;
{
try self.mut.lockShared(io);
defer self.mut.unlockShared(io);
if (self.table.contains(block))
return self.table.get(block).?[block_offset];
}
try self.mut.lock(io);
defer self.mut.unlock(io);
if (self.table.contains(block))
return self.table.get(block).?[block_offset];
const offset_pos = self.table_start + (8 * block);
const offset: u64 = std.mem.readInt(u64, @ptrCast(self.fil.map.memory[offset_pos .. offset_pos + 8]), .little);
const len: u16 = if (self.total_num % T_PER_BLOCK != 0 and block == (self.total_num - 1) / T_PER_BLOCK)
@truncate(self.total_num % T_PER_BLOCK)
else
T_PER_BLOCK;
var rdr = self.fil.readerAt(offset);
var meta: MetadataReader = .init(self.alloc, &rdr, self.decomp);
const slice = try meta.interface.readSliceEndianAlloc(self.alloc, T, len, .little);
try self.table.put(@truncate(block), slice);
return slice[block_offset];
}
};
} }
+6 -7
View File
@@ -5,27 +5,26 @@ const Writer = std.Io.Writer;
const ExtractionOptions = @This(); const ExtractionOptions = @This();
/// Extract single-threaded only. /// Force single-threaded extraction. Io.Threaded.global_single_threaded also works.
/// Though not necessary if using Threaded.single_threaded,
/// setting single_threaded is more efficient.
single_threaded: bool = false, single_threaded: bool = false,
/// Don't set the file's owner & permissions after extraction /// Don't set the file's owner, permissions, & modify time after extraction.
ignore_permissions: bool = false, ignore_permissions: bool = false,
/// Don't set xattr values. Currently xattrs are never set anyway. /// Don't set xattr values.
ignore_xattr: bool = false, ignore_xattr: bool = false,
/// Replace symlinks with their target. /// Replace symlinks with their target. Currently doesn't do anything.
dereference_symlinks: bool = false, dereference_symlinks: bool = false,
/// Verbose logging. If true, verbose_writer must be set /// Verbose logging. If true, verbose_writer must be set
verbose: bool = false, verbose: bool = false,
/// Where to print verbose log. /// Where to print verbose log.
verbose_writer: ?*Writer = null, verbose_writer: ?*Writer = null,
pub const defaultSingleThreaded: ExtractionOptions = .{ .single_threaded = true };
pub const default: ExtractionOptions = .{}; pub const default: ExtractionOptions = .{};
pub const default_single_threaded: ExtractionOptions = .{ .single_threaded = true };
pub fn VerboseDefault(wrt: *Writer) !ExtractionOptions { pub fn VerboseDefault(wrt: *Writer) !ExtractionOptions {
return .{ return .{
.verbose = true, .verbose = true,
.verbose_writer = wrt, .verbose_writer = wrt,
.threads = try std.Thread.getCpuCount(),
}; };
} }
+2 -1
View File
@@ -1,6 +1,7 @@
pub const Archive = @import("archive.zig"); pub const Archive = @import("archive.zig");
pub const ExtractionOptions = @import("options.zig"); pub const ExtractionOptions = @import("options.zig");
const Test = @import("test.zig");
test { test {
@import("std").testing.refAllDecls(@This()); @import("std").testing.refAllDecls(Test);
} }
+63
View File
@@ -0,0 +1,63 @@
const std = @import("std");
const math = std.math;
const InodeRef = @import("inode.zig").Ref;
const CompressionType = @import("util/decompress.zig").CompressionType;
const SQUASHFS_MAGIC: u32 = std.mem.readInt(u32, "hsqs", .little);
const SuperblockError = error{
InvalidMagic,
InvalidBlockLog,
InvalidVersion,
InvalidCheck,
};
/// A squashfs Superblock
pub const Superblock = extern struct {
magic: u32,
inode_count: u32,
mod_time: u32,
block_size: u32,
frag_count: u32,
compression: CompressionType,
block_log: u16,
flags: packed struct(u16) {
inode_uncompressed: bool,
data_uncompressed: bool,
check: bool,
frag_uncompressed: bool,
fragment_never: bool,
fragment_always: bool,
duplicates: bool,
exportable: bool,
xattr_uncompressed: bool,
xattr_never: bool,
compression_options: bool,
ids_uncompressed: bool,
_: u4,
},
id_count: u16,
ver_maj: u16,
ver_min: u16,
root_ref: InodeRef,
size: u64,
id_start: u64,
xattr_start: u64,
inode_start: u64,
dir_start: u64,
frag_start: u64,
export_start: u64,
/// Validate the Superblock. If an error is returned, it's likely the archive is corrupted or not a squashfs archive.
pub fn validate(self: Superblock) !void {
if (self.magic != SQUASHFS_MAGIC)
return SuperblockError.InvalidMagic;
if (self.flags.check)
return SuperblockError.InvalidCheck;
if (self.ver_maj != 4 or self.ver_min != 0)
return SuperblockError.InvalidVersion;
if (math.log2(self.block_size) != self.block_log)
return SuperblockError.InvalidBlockLog;
}
};
+109
View File
@@ -0,0 +1,109 @@
const std = @import("std");
const Io = std.Io;
const stuff = @import("builtin");
const Archive = @import("archive.zig");
const Superblock = @import("super.zig").Superblock;
const TestArchive = "testing/LinuxPATest.sfs";
test "Basics" {
const io = std.testing.io;
const alloc = std.testing.allocator;
var fil = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer fil.close(io);
var sfs: Archive = try .init(alloc, io, fil);
defer sfs.deinit(io);
try std.testing.expectEqualDeep(sfs.super, LinuxPATestCorrectSuperblock);
}
const TestFile = "Start.exe";
const TestFileExtractLocation = "testing/Start.exe";
test "ExtractSingleFile" {
const io = std.testing.io;
const alloc = std.testing.allocator;
Io.Dir.cwd().deleteFile(io, TestFileExtractLocation) catch {};
var fil = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer fil.close(io);
var sfs: Archive = try .init(alloc, io, fil);
defer sfs.deinit(io);
var test_fil = try sfs.open(alloc, io, TestFile);
defer test_fil.deinit();
try test_fil.extract(alloc, io, TestFileExtractLocation, .default);
//TODO: validate extracted file.
}
const TestDir = "Documents";
const TestDirExtractLocation = "testing/Documents";
test "ExtractSmallDir" {
const io = std.testing.io;
const alloc = std.testing.allocator;
Io.Dir.cwd().deleteTree(io, TestDirExtractLocation) catch {};
var fil = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer fil.close(io);
var sfs: Archive = try .init(alloc, io, fil);
defer sfs.deinit(io);
var test_fil = try sfs.open(alloc, io, TestDir);
defer test_fil.deinit();
try test_fil.extract(alloc, io, TestDirExtractLocation, .default);
//TODO: validate extracted file.
}
const TestFullExtractLocation = "testing/TestExtract";
test "ExtractCompleteArchive" {
const io = std.testing.io;
const alloc = std.testing.allocator;
Io.Dir.cwd().deleteTree(io, TestFullExtractLocation) catch {};
var fil = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer fil.close(io);
var sfs: Archive = try .init(alloc, io, fil);
defer sfs.deinit(io);
try sfs.extract(alloc, io, TestFullExtractLocation, .default);
}
const LinuxPATestCorrectSuperblock: Superblock = .{
.magic = std.mem.readInt(u32, "hsqs", .little),
.inode_count = 2974,
.mod_time = 1632696724,
.block_size = 131072,
.frag_count = 264,
.compression = .zstd,
.block_log = 17,
.flags = .{
.inode_uncompressed = false,
.data_uncompressed = false,
.check = false,
.frag_uncompressed = false,
.fragment_never = false,
.fragment_always = false,
.duplicates = true,
.exportable = true,
.xattr_uncompressed = false,
.xattr_never = false,
.compression_options = false,
.ids_uncompressed = false,
._ = 0,
},
.id_count = 1,
.ver_maj = 4,
.ver_min = 0,
.root_ref = .{
.block_offset = 1363,
.block_start = 29237,
._ = 0,
},
.size = 106841744,
.id_start = 106841632,
.xattr_start = 106841720,
.inode_start = 106778274,
.dir_start = 106807998,
.frag_start = 106837747,
.export_start = 106841602,
};
+61
View File
@@ -0,0 +1,61 @@
const std = @import("std");
const c = @import("c");
const Error = @import("decompress.zig").Error;
pub fn zlibDecompress(_: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var strem: c.zng_stream = .{
.next_in = in.ptr,
.avail_in = @truncate(in.len),
.next_out = out.ptr,
.avail_out = @truncate(out.len),
};
var res = c.zng_inflateInit(&strem);
if (res != c.Z_OK) return Error.ReadFailed;
defer _ = c.zng_inflateEnd(&strem);
res = c.zng_inflate(&strem, c.Z_FULL_FLUSH);
if (res != c.Z_OK) return Error.ReadFailed;
return strem.total_out;
}
pub fn lzmaDecompress(_: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var strem: c.lzma_stream = .{
.next_in = in.ptr,
.avail_in = in.len,
.next_out = out.ptr,
.avail_out = out.len,
};
var res = c.lzma_auto_decoder(&strem, out.len * 2, 0);
if (res != c.LZMA_OK) return Error.ReadFailed;
defer c.lzma_end(&strem);
while (res == c.LZMA_OK)
res = c.lzma_code(&strem, c.LZMA_RUN);
if (res != c.LZMA_FINISH) return Error.ReadFailed;
return strem.total_out;
}
pub fn lzoDecompress(_: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var out_len = out.len;
const res = c.lzo1x_decompress(in.ptr, in.len, out.ptr, &out_len, null);
if (res != c.LZO_E_OK) return Error.ReadFailed;
return out_len;
}
pub fn lz4Decompress(_: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
const res = c.LZ4_decompress_safe(
in.ptr,
out.ptr,
@bitCast(@as(u32, @truncate(in.len))),
@bitCast(@as(u32, @truncate(out.len))),
);
if (res < 0) return Error.ReadFailed;
return @abs(res);
}
pub fn zstdDecompress(_: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
const res = c.ZSTD_decompress(out.ptr, out.len, in.ptr, in.len);
if (c.ZSTD_isError(res) != 0)
return Error.ReadFailed;
return res;
}
+85
View File
@@ -0,0 +1,85 @@
const std = @import("std");
const Io = std.Io;
const BlockSize = @import("../inode_data/file.zig").BlockSize;
const Decompress = @import("decompress.zig");
const DataExtract = @This();
decomp: Decompress.Fn,
map: Io.File.MemoryMap,
block_size: u32,
block_start: u64,
size: u64,
blocks: []BlockSize,
frag_data: ?[]u8 = null,
frag_offset: u32 = undefined,
pub fn init(decomp: Decompress.Fn, map: Io.File.MemoryMap, block_size: u32, block_start: u64, size: u64, blocks: []BlockSize) DataExtract {
return .{
.decomp = decomp,
.map = map,
.block_size = block_size,
.block_start = block_start,
.size = size,
.blocks = blocks,
};
}
pub fn addFrag(self: *DataExtract, frag_block: []u8, frag_offset: u32) void {
self.frag_data = frag_block;
self.frag_offset = frag_offset;
}
pub const Error = error{} || Io.File.MemoryMap.CreateError || Io.File.WritePositionalError || Decompress.Error || Io.File.MemoryMap.SetLengthError;
pub fn asyncExtract(self: DataExtract, alloc: std.mem.Allocator, io: Io, fil: Io.File) Error!void {
if (self.size == 0) return;
try fil.writePositionalAll(io, &.{0}, self.size - 1);
var map = try fil.createMemoryMap(io, .{ .len = self.size, .protection = .{ .write = true }, .undefined_contents = true });
defer map.destroy(io);
var group: Io.Group = .init;
defer group.cancel(io);
var ret_err: ?Error = null;
var offset: u64 = self.block_start;
for (0..self.blocks.len) |i| {
group.async(io, blockThread, .{ self, alloc, map, offset, i, &ret_err });
offset += self.blocks[i].size;
}
if (self.frag_data != null)
group.async(io, fragThread, .{ self, map });
try group.await(io);
if (ret_err != null) return ret_err.?;
return map.write(io);
}
fn blockThread(self: DataExtract, alloc: std.mem.Allocator, map: Io.File.MemoryMap, read_offset: u64, idx: usize, ret_err: *?Error) error{Canceled}!void {
const block = self.blocks[idx];
const write_offset = idx * self.block_size;
const size = if (self.frag_data == null and idx == self.blocks.len - 1)
self.size % self.block_size
else
self.block_size;
if (block.size == 0) {
@memset(map.memory[write_offset..][0..size], 0);
return;
} else if (block.uncompressed) {
@memcpy(map.memory[write_offset..][0..size], self.map.memory[read_offset..][0..block.size]);
}
_ = self.decomp(alloc, self.map.memory[read_offset..][0..block.size], map.memory[write_offset..][0..size]) catch |err| {
ret_err.* = err;
return error.Canceled;
};
}
fn fragThread(self: DataExtract, map: Io.File.MemoryMap) error{Canceled}!void {
const size = self.size % self.block_size;
@memcpy(map.memory[self.blocks.len * self.block_size ..][0..size], self.frag_data.?[self.frag_offset..][0..size]);
}
-162
View File
@@ -1,162 +0,0 @@
//! The DataExtractor is meant to extract a regular file's data to a given file asyncronously.
const std = @import("std");
const Io = std.Io;
const FragEntry = @import("../frag.zig").FragEntry;
const BlockSize = @import("../inode_data/file.zig").BlockSize;
const Decompressor = @import("decompressor.zig");
const OffsetFile = @import("offset_file.zig");
// const SharedCache = @import("shared_cache.zig");
pub const Error = Decompressor.Error || Io.File.MemoryMap.CreateError || Io.File.WritePositionalError;
const DataExtractor = @This();
fil: OffsetFile,
decomp: *Decompressor,
block_size: u32,
file_size: u64,
start: u64,
blocks: []BlockSize,
frag_offset: u32 = 0,
frag_block: ?[]u8 = null,
err: ?Error = null,
pub fn init(fil: OffsetFile, decomp: *Decompressor, block_size: u32, file_size: u64, data_start: u64, blocks: []BlockSize) DataExtractor {
return .{
.fil = fil,
.decomp = decomp,
.block_size = block_size,
.file_size = file_size,
.start = data_start,
.blocks = blocks,
};
}
pub fn addFrag(self: *DataExtractor, frag_offset: u32, block: []u8) void {
self.frag_offset = frag_offset;
self.frag_block = block;
}
fn numBlocks(self: DataExtractor) usize {
var num = self.blocks.len;
if (self.frag_block != null) num += 1;
return num;
}
/// Starts extracting the data using the given group to spawn async tasks.
pub fn extractConcurrent(self: DataExtractor, alloc: std.mem.Allocator, io: Io, fil: Io.File) (Error || Io.ConcurrentError)!void {
var group: Io.Group = .init;
defer group.cancel(io);
var err: ?Error = null;
var read_offset: u64 = self.start;
for (0..self.blocks.len) |idx| {
try group.concurrent(io, blockThread, .{ self, alloc, io, fil, read_offset, idx, &err });
read_offset += self.blocks[idx].size;
}
if (self.frag_block != null)
try group.concurrent(io, fragThread, .{ self, io, fil, &err });
group.await(io) catch |cancel| return err orelse cancel;
}
/// Starts extracting the data using the given group to spawn async tasks.
pub fn extractAsync(self: DataExtractor, alloc: std.mem.Allocator, io: Io, fil: Io.File) Error!void {
var group: Io.Group = .init;
defer group.cancel(io);
var err: ?Error = null;
var read_offset: u64 = self.start;
for (0..self.blocks.len) |idx| {
group.async(io, blockThread, .{ self, alloc, io, fil, read_offset, idx, &err });
read_offset += self.blocks[idx].size;
}
if (self.frag_block != null)
group.async(io, fragThread, .{ self, io, fil, &err });
group.await(io) catch |cancel| return err orelse cancel;
}
fn blockThread(self: DataExtractor, alloc: std.mem.Allocator, io: Io, fil: Io.File, read_offset: u64, idx: usize, ret_err: *?Error) Io.Cancelable!void {
const block = self.blocks[idx];
const cur_block_size = if (idx == self.numBlocks() - 1)
self.file_size % self.block_size
else
self.block_size;
const write_offset = self.block_size * idx;
var wrt = fil.writer(io, &[0]u8{});
wrt.seekTo(write_offset) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
if (block.size == 0) {
wrt.interface.splatByteAll(0, cur_block_size) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
} else {
if (block.uncompressed) {
wrt.interface.writeAll(self.fil.map.memory[read_offset..][0..cur_block_size]) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
} else {
@branchHint(.likely);
var tmp: [1024 * 1024]u8 = undefined;
_ = self.decomp.Decompress(alloc, self.fil.map.memory[read_offset..][0..block.size], tmp[0..cur_block_size]) catch |err| {
ret_err.* = err;
return Io.Cancelable.Canceled;
};
wrt.interface.writeAll(tmp[0..cur_block_size]) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
}
}
wrt.flush() catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
}
fn fragThread(self: DataExtractor, io: Io, fil: Io.File, ret_err: *?Error) Io.Cancelable!void {
const cur_block_size = self.file_size % self.block_size;
const write_offset = self.blocks.len * self.block_size;
var wrt = fil.writer(io, &[0]u8{});
wrt.seekTo(write_offset) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
wrt.interface.writeAll(self.frag_block.?[self.frag_offset..][0..cur_block_size]) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
wrt.flush() catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
}
-189
View File
@@ -1,189 +0,0 @@
//! DataReader reads a regular file's data linearly from start to finish using Io.Reader interface.
const std = @import("std");
const Io = std.Io;
const Reader = Io.Reader;
const Writer = Io.Writer;
const Limit = Io.Limit;
const BlockSize = @import("../inode_data/file.zig").BlockSize;
const Decompressor = @import("decompressor.zig");
const OffsetFile = @import("offset_file.zig");
// const SharedCache = @import("shared_cache.zig");
const DataReader = @This();
alloc: std.mem.Allocator,
fil: OffsetFile,
io: Io,
decomp: *Decompressor,
block_size: u32,
file_size: u64,
cur_offset: u64,
blocks: []BlockSize,
frag_offset: u32 = 0,
frag_block: ?[]u8 = null,
block_idx: usize = 0,
sparse_block: bool = false,
interface: Io.Reader,
pub fn init(alloc: std.mem.Allocator, io: Io, fil: OffsetFile, decomp: *Decompressor, block_size: u32, file_size: u64, data_start: u64, blocks: []BlockSize) !DataReader {
return .{
.alloc = alloc,
.fil = fil,
.io = io,
.decomp = decomp,
.block_size = block_size,
.file_size = file_size,
.cur_offset = data_start,
.blocks = blocks,
.interface = .{
.buffer = try alloc.alloc(u8, block_size),
.seek = 0,
.end = 0,
.vtable = &.{
.stream = stream,
.discard = discard,
.readVec = readVec,
},
},
};
}
pub fn deinit(self: *DataReader) void {
self.alloc.free(self.interface.buffer);
}
pub fn addFrag(self: *DataReader, frag_offset: u32, block: []u8) void {
self.frag_offset = frag_offset;
self.frag_block = block;
}
fn numBlocks(self: DataReader) usize {
var num = self.blocks.len;
if (self.frag_block != null) num += 1;
return num;
}
fn advanceBuffer(self: *DataReader) !void {
if (self.block_idx >= self.numBlocks())
return Reader.Error.EndOfStream;
errdefer self.interface.end = 0;
defer self.block_idx += 1;
self.interface.end = if (self.block_idx == self.numBlocks() - 1)
self.file_size % self.block_size
else
self.block_size;
// Fragment
if (self.block_idx == self.blocks.len) {
@memcpy(self.interface.buffer[0..self.interface.end], self.frag_block.?[self.frag_offset .. self.frag_offset + self.interface.end]);
self.interface.seek = 0;
return;
}
// Normal Block
const block = self.blocks[self.block_idx];
if (block.size == 0) {
self.interface.seek = 0;
self.sparse_block = true;
return;
} else {
self.sparse_block = false;
}
if (block.uncompressed) {
@memcpy(self.interface.buffer[0..self.interface.end], self.fil.map.memory[self.cur_offset .. self.cur_offset + self.interface.end]);
self.cur_offset += self.interface.end;
} else {
@branchHint(.likely);
_ = try self.decomp.Decompress(self.alloc, self.fil.map.memory[self.cur_offset .. self.cur_offset + block.size], self.interface.buffer[0..self.interface.end]);
self.cur_offset += block.size;
}
self.interface.seek = 0;
}
fn stream(rdr: *Reader, wrt: *Writer, limit: Limit) Reader.StreamError!usize {
var data: *DataReader = @fieldParentPtr("interface", rdr);
if (rdr.seek == rdr.end)
data.advanceBuffer() catch |err| return switch (err) {
error.ReadFailed => error.ReadFailed,
error.EndOfStream => error.EndOfStream,
else => error.ReadFailed,
};
switch (limit) {
.nothing => return 0,
.unlimited => {
const wrote = if (data.sparse_block)
try wrt.splatByte(0, rdr.end - rdr.seek)
else
try wrt.write(rdr.buffer[rdr.seek..rdr.end]);
rdr.seek += wrote;
return wrote;
},
else => {
const to_read = @min(rdr.end - rdr.seek, @intFromEnum(limit));
const wrote = if (data.sparse_block)
try wrt.splatByte(0, to_read)
else
try wrt.write(rdr.buffer[rdr.seek .. rdr.seek + to_read]);
rdr.seek += wrote;
return wrote;
},
}
}
fn discard(rdr: *Reader, limit: Limit) Reader.Error!usize {
var data: *DataReader = @fieldParentPtr("interface", rdr);
if (rdr.seek == rdr.end)
data.advanceBuffer() catch |err| return switch (err) {
error.ReadFailed => error.ReadFailed,
error.EndOfStream => error.EndOfStream,
else => error.ReadFailed,
};
switch (limit) {
.nothing => return 0,
.unlimited => {
const adv = rdr.end - rdr.seek;
rdr.seek = rdr.end;
return adv;
},
else => {
const adv = @min(rdr.end - rdr.seek, @intFromEnum(limit));
rdr.seek += adv;
return adv;
},
}
}
fn readVec(rdr: *Reader, vec: [][]u8) Reader.Error!usize {
var data: *DataReader = @fieldParentPtr("interface", rdr);
if (rdr.seek == rdr.end)
data.advanceBuffer() catch |err| return switch (err) {
error.ReadFailed => error.ReadFailed,
error.EndOfStream => error.EndOfStream,
else => error.ReadFailed,
};
var wrote: usize = 0;
for (vec) |buf| {
if (rdr.seek == rdr.end) break;
const to_copy = @min(rdr.end - rdr.seek, buf.len);
if (data.sparse_block)
@memset(buf[0..to_copy], 0)
else
@memcpy(buf[0..to_copy], rdr.buffer[rdr.seek .. rdr.seek + to_copy]);
rdr.seek += to_copy;
wrote += to_copy;
}
return wrote;
}
+112
View File
@@ -0,0 +1,112 @@
const std = @import("std");
const Io = std.Io;
const ArrayHashMap = std.array_hash_map.Auto;
const Atomic = std.atomic.Value;
const Decompress = @import("decompress.zig");
const Fn = Decompress.Fn;
const DecompressType = Decompress.CompressionType;
const DecompCache = @This();
const Cache = struct {
cache: []u8,
usage: Atomic(u32),
};
arena: std.heap.ArenaAllocator,
decomp: Fn,
map: Io.File.MemoryMap,
cache: ArrayHashMap(u64, Cache),
mut: Io.RwLock = .init,
cond: Io.Condition = .init,
max_size: u64,
cur_size: u64 = 0,
pub fn init(alloc: std.mem.Allocator, map: Io.File.MemoryMap, decomp_type: DecompressType, max_size: u64) !DecompCache {
return .{
.arena = .init(alloc),
.decomp = try Decompress.getDecompressFn(decomp_type),
.map = map,
.cache = .empty,
.max_size = max_size,
};
}
pub fn deinit(self: *DecompCache, io: Io) void {
self.mut.lockUncancelable(io);
self.cache.deinit(self.arena.child_allocator);
self.arena.deinit();
self.map.destroy(io);
}
fn makeRoom(self: *DecompCache, io: Io, size: u32) !void {
if (size + self.cur_size < self.max_size) return;
var iter = self.cache.iterator();
while (iter.next()) |ent| {
const val = ent.value_ptr;
if (val.usage.load(.unordered) == 0) {
self.cur_size -= val.cache.len;
_ = self.cache.orderedRemove(ent.key_ptr.*);
}
if (size + self.cur_size < self.max_size) return;
}
try self.cond.wait(io, &self.mut.mutex);
return self.makeRoom(io, size);
}
pub fn checkinBlock(self: *DecompCache, io: Io, offset: u64) !void {
self.mut.lockSharedUncancelable(io);
defer self.mut.unlockShared(io);
const get = self.cache.getPtr(offset);
if (get == null) return error.NotACachedBlock;
const res = get.?.usage.fetchSub(1, .acq_rel);
if (res == 0) self.cond.broadcast(io);
}
pub fn checkoutBlock(self: *DecompCache, io: Io, offset: u64, data_size: u32, max_result_size: u32) ![]u8 {
{
try self.mut.lockShared(io);
defer self.mut.unlockShared(io);
const get = self.cache.getPtr(offset);
if (get != null) {
_ = get.?.usage.fetchAdd(1, .acq_rel);
return get.?.cache;
}
}
try self.mut.lock(io);
defer self.mut.unlock(io);
try self.makeRoom(io, max_result_size);
var alloc = self.arena.allocator();
const buf_alloc = self.arena.child_allocator;
var out = try alloc.alloc(u8, max_result_size);
errdefer alloc.free(out);
const out_size = try self.decomp(buf_alloc, self.map.memory[offset..][0..data_size], out);
if (out_size != max_result_size) {
if (alloc.resize(out, out_size)) {
out.len = out_size;
} else {
const new_out = try alloc.alloc(u8, out_size);
@memcpy(new_out, out[0..out_size]);
alloc.free(out);
out = new_out;
}
}
try self.cache.put(buf_alloc, offset, .{
.cache = out,
.usage = .init(1),
});
return out;
}
+38
View File
@@ -0,0 +1,38 @@
const std = @import("std");
const Io = std.Io;
const config = @import("config");
const c_decomp = @import("c_decomp.zig");
const zig_decomp = @import("zig_decomp.zig");
pub const Error = Io.Reader.Error || std.mem.Allocator.Error;
pub const Fn = *const fn (alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize;
pub const CompressionType = enum(u16) {
gzip = 1,
lzma,
lzo,
xz,
lz4,
zstd,
};
pub fn getDecompressFn(t: CompressionType) !Fn {
return if (config.use_zig_decomp) switch (t) {
.lzo => error.LzoUnsupported,
.lz4 => error.Lz4Unsupported,
.gzip => zig_decomp.zlibDecompress,
.lzma => zig_decomp.lzmaDecompress,
.xz => zig_decomp.xzDecompress,
.zstd => zig_decomp.zstdDecompress,
} else switch (t) {
.gzip => c_decomp.zlibDecompress,
.lzma => c_decomp.lzmaDecompress,
.lzo => if (config.allow_lzo) c_decomp.lzoDecompress else error.LzoUnsupported,
.xz => c_decomp.lzmaDecompress,
.lz4 => c_decomp.lz4Decompress,
.zstd => c_decomp.zstdDecompress,
};
}
-15
View File
@@ -1,15 +0,0 @@
//! A decompression interface
const std = @import("std");
const Decompressor = @This();
pub const Error = std.Io.Reader.StreamError || std.mem.Allocator.Error;
/// The actual decompression function.
/// If the given decompressor is null, then the decompression should be done "stateless" without lasting allocations.
decomp_fn: *const fn (?*Decompressor, std.mem.Allocator, in: []u8, out: []u8) Error!usize,
pub fn Decompress(self: *Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
return self.decomp_fn(self, alloc, in, out);
}
+73 -66
View File
@@ -1,27 +1,29 @@
const std = @import("std"); //! A cache for decompressed blocks. Used for Metadata & fragments.
const Reader = std.Io.Reader;
const Writer = std.Io.Writer;
const Limit = std.Io.Limit;
const StreamError = std.Io.Reader.StreamError;
const Decompressor = @import("decompressor.zig"); const std = @import("std");
const Io = std.Io;
const Reader = Io.Reader;
const Writer = Io.Writer;
const Limit = Io.Limit;
const DecompCache = @import("decomp_cache.zig");
const MetadataReader = @This();
const BlockHeader = packed struct(u16) { const BlockHeader = packed struct(u16) {
size: u15, size: u15,
uncompressed: bool, uncompressed: bool,
}; };
const This = @This(); io: Io,
alloc: std.mem.Allocator, cur_offset: u64 = 0,
rdr: *Reader, next_offset: u64,
decomp: *Decompressor,
cur_block_start: u32 = 0, cache: *DecompCache,
next_start_start: u32 = 0,
buf: [8192]u8 = undefined, buf_uncompress: bool = false,
err: ?anyerror = null,
interface: Reader = .{ interface: Reader = .{
.buffer = &[0]u8{}, .buffer = &[0]u8{},
.end = 0, .end = 0,
@@ -30,74 +32,79 @@ interface: Reader = .{
.stream = stream, .stream = stream,
.discard = discard, .discard = discard,
.readVec = readVec, .readVec = readVec,
// TODO: Potentially add rebase so that we can guarentee that self.block_start & interface.seek is correct.
}, },
}, },
pub fn init(alloc: std.mem.Allocator, rdr: *Reader, decomp: *Decompressor) This { pub fn init(io: Io, cache: *DecompCache, offset: u64) MetadataReader {
return .{ return .{
.alloc = alloc, .io = io,
.rdr = rdr,
.decomp = decomp, .next_offset = offset,
.cache = cache,
}; };
} }
pub fn deinit(self: *MetadataReader) void {
if (self.cur_offset != 0 and !self.buf_uncompress)
self.cache.checkinBlock(self.io, self.cur_offset) catch {};
}
fn advance(self: *This) !void { fn advance(self: *MetadataReader) !void {
self.interface.seek = 0; if (self.interface.buffer.len > 0 and !self.buf_uncompress)
var hdr: BlockHeader = undefined; self.cache.checkinBlock(self.io, self.cur_offset) catch |err| {
try self.rdr.readSliceEndian(BlockHeader, @ptrCast(&hdr), .little); std.debug.print("UH OH! {}\n", .{err});
self.cur_block_start = self.next_start_start; return error.ReadFailed;
self.next_start_start += hdr.size; };
const hdr: BlockHeader = @bitCast(std.mem.readInt(u16, self.cache.map.memory[self.next_offset..][0..2], .little));
self.cur_offset = self.next_offset + 2;
self.next_offset = self.cur_offset + hdr.size;
self.buf_uncompress = hdr.uncompressed;
if (hdr.uncompressed) { if (hdr.uncompressed) {
try self.rdr.readSliceEndian(u8, self.buf[0..hdr.size], .little); self.interface.buffer = self.cache.map.memory[self.cur_offset..][0..hdr.size];
self.interface.end = hdr.size; self.interface.end = hdr.size;
self.interface.buffer = self.buf[0..hdr.size]; self.interface.seek = 0;
return; return;
} else {
@branchHint(.likely);
var tmp_buf: [8192]u8 = undefined;
try self.rdr.readSliceAll(tmp_buf[0..hdr.size]);
self.interface.end = try self.decomp.Decompress(self.alloc, tmp_buf[0..hdr.size], &self.buf);
self.interface.buffer = self.buf[0..self.interface.end];
} }
self.interface.buffer = try self.cache.checkoutBlock(self.io, self.cur_offset, hdr.size, 8192);
self.interface.end = self.interface.buffer.len;
self.interface.seek = 0;
} }
fn stream(rdr: *Reader, wrt: *Writer, limit: Limit) StreamError!usize { fn stream(r: *Reader, w: *Writer, limit: Limit) Reader.StreamError!usize {
const self: *This = @fieldParentPtr("interface", rdr); if (r.seek == r.end) {
if (rdr.end == rdr.seek) self.advance() catch |err| { var self: *MetadataReader = @fieldParentPtr("interface", r);
self.err = err; self.advance() catch return Reader.Error.ReadFailed;
return StreamError.ReadFailed; }
}; if (limit == .nothing) return 0;
if (@intFromEnum(limit) == 0) return 0; const to_write = @min(r.end - r.seek, @intFromEnum(limit));
const to_write = @min(rdr.end - rdr.seek, @intFromEnum(limit)); const wrote = try w.write(r.buffer[r.seek..][0..to_write]);
const wrote = try wrt.write(self.buf[rdr.seek .. rdr.seek + to_write]); r.seek += wrote;
self.interface.seek += wrote;
return wrote; return wrote;
} }
fn discard(rdr: *Reader, limit: Limit) Reader.Error!usize { fn discard(r: *Reader, limit: Limit) Reader.Error!usize {
const self: *This = @fieldParentPtr("interface", rdr); if (r.seek == r.end) {
if (rdr.end == rdr.seek) self.advance() catch |err| { var self: *MetadataReader = @fieldParentPtr("interface", r);
self.err = err; self.advance() catch return Reader.Error.ReadFailed;
return error.ReadFailed; }
}; if (limit == .nothing) return 0;
if (@intFromEnum(limit) == 0) return 0; const to_skip = @min(r.end - r.seek, @intFromEnum(limit));
const to_skip = @min(rdr.end - rdr.seek, @intFromEnum(limit)); r.seek += to_skip;
rdr.seek += to_skip;
return to_skip; return to_skip;
} }
fn readVec(rdr: *Reader, vec: [][]u8) Reader.Error!usize { fn readVec(r: *Reader, vec: [][]u8) Reader.Error!usize {
const self: *This = @fieldParentPtr("interface", rdr); if (r.seek == r.end) {
if (rdr.end == rdr.seek) self.advance() catch |err| { var self: *MetadataReader = @fieldParentPtr("interface", r);
self.err = err; self.advance() catch return Reader.Error.ReadFailed;
return error.ReadFailed;
};
var cur_red: usize = 0;
for (vec) |s| {
const to_copy: usize = @min(rdr.end - rdr.seek, s.len);
@memcpy(s[0..to_copy], self.buf[rdr.seek .. rdr.seek + to_copy]);
rdr.seek += to_copy;
cur_red += to_copy;
if (rdr.end == rdr.seek) break;
} }
return cur_red; if (vec.len == 0) return 0;
var total_copied: usize = 0;
for (vec) |v| {
const to_cpy = @min(r.end - r.seek, v.len);
@memcpy(v[0..to_cpy], r.buffer[r.seek..][0..to_cpy]);
r.seek += to_cpy;
total_copied += to_cpy;
if (r.seek == r.end) break;
}
return total_copied;
} }
-25
View File
@@ -1,25 +0,0 @@
//! Miscellaneous utility functions.
const std = @import("std");
const Io = std.Io;
const Inode = @import("../inode.zig");
const Decompressor = @import("decompressor.zig");
const MetadataReader = @import("metadata.zig");
const OffsetFile = @import("offset_file.zig");
/// check is the path is referencing itself ("" or ".").
/// separators must be trimmed before calling this function for it to work properly.
pub fn pathIsSelf(path: []const u8) bool {
if (path.len == 0) return true;
if (path.len > 1) return false;
return path[0] == '.';
}
/// Creates an Inode from an Inode.Ref.
pub fn inodeFromRef(alloc: std.mem.Allocator, file: OffsetFile, decomp: *Decompressor, inode_start: u64, block_size: u32, ref: Inode.Ref) !Inode {
var rdr = file.readerAt(inode_start + ref.block_start);
var meta: MetadataReader = .init(alloc, &rdr, decomp);
try meta.interface.discardAll(ref.block_offset);
return .read(alloc, &meta.interface, block_size);
}
-27
View File
@@ -1,27 +0,0 @@
//! A File where it's meaningful (to us) content starts at a given offset.
const std = @import("std");
const Io = std.Io;
const File = Io.File;
const Reader = Io.Reader;
const OffsetFile = @This();
map: Io.File.MemoryMap,
pub fn init(io: Io, fil: File, archive_size: u64, init_offset: u64) !OffsetFile {
return .{
.map = try fil.createMemoryMap(io, .{
.protection = .{ .read = true, .write = false, .execute = false },
.len = archive_size,
.offset = init_offset,
}),
};
}
pub fn deinit(self: *OffsetFile, io: Io) void {
self.map.destroy(io);
}
pub fn readerAt(self: OffsetFile, offset: u64) Reader {
return .fixed(self.map.memory[offset..]);
}
+40
View File
@@ -0,0 +1,40 @@
const std = @import("std");
const Reader = std.Io.Reader;
const flate = std.compress.flate;
const zstd = std.compress.zstd;
const xz = std.compress.xz;
const lzma = std.compress.lzma;
const Error = @import("decompress.zig").Error;
pub fn zlibDecompress(_: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var buf: [flate.max_window_len]u8 = undefined;
var rdr: Reader = .fixed(in);
var decomp: flate.Decompress = .init(&rdr, .zlib, &buf);
return decomp.reader.readSliceShort(out);
}
pub fn zstdDecompress(alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
const buf = try alloc.alloc(u8, in.len + zstd.block_size_max);
defer alloc.free(buf);
var rdr: Reader = .fixed(in);
var decomp: zstd.Decompress = .init(&rdr, buf, .{ .window_len = in.len });
return decomp.reader.readSliceShort(out);
}
pub fn lzmaDecompress(alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var rdr: Reader = .fixed(in);
var decomp: lzma.Decompress = .initOptions(&rdr, alloc, &[0]u8{}, .{}, 2 * out.len);
defer decomp.deinit();
return decomp.reader.readSliceShort(out);
}
pub fn xzDecompress(alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var rdr: Reader = .fixed(in);
var decomp: xz.Decompress = .init(&rdr, alloc, &[0]u8{});
defer decomp.deinit();
return decomp.reader.readSliceShort(out);
}
-292
View File
@@ -1,292 +0,0 @@
const std = @import("std");
const Io = std.Io;
const InodeRef = @import("inode.zig").Ref;
const LookupTable = @import("lookup_table.zig");
const Decompressor = @import("util/decompressor.zig");
const MetadataReader = @import("util/metadata.zig");
const OffsetFile = @import("util/offset_file.zig");
const XattrCachedTable = @This();
alloc: std.mem.Allocator,
fil: OffsetFile,
decomp: *Decompressor,
kv_start: u64,
table: LookupTable.CachedTable(TableValue),
value_cache: std.AutoHashMap(InodeRef, []const u8),
value_mut: Io.RwLock = .init,
pub fn init(alloc: std.mem.Allocator, fil: OffsetFile, decomp: *Decompressor, xattr_start: u64) !XattrCachedTable {
const start: u64 = std.mem.readInt(u64, @ptrCast(fil.map.memory[xattr_start .. xattr_start + 8]), .little);
const num: u64 = std.mem.readInt(u64, @ptrCast(fil.map.memory[xattr_start + 8 .. xattr_start + 16]), .little);
return .{
.alloc = alloc,
.fil = fil,
.decomp = decomp,
.kv_start = start,
.table = .init(alloc, fil, decomp, xattr_start + 16, num),
.value_cache = .init(alloc),
};
}
pub fn deinit(self: *XattrCachedTable, io: Io) void {
self.value_mut.lockUncancelable(io);
self.table.deinit(io);
self.value_cache.deinit();
}
pub fn get(self: *XattrCachedTable, alloc: std.mem.Allocator, io: Io, idx: u32) ![]XattrSemiOwned {
const lookup = try self.table.get(io, idx);
var rdr = self.fil.readerAt(self.kv_start + lookup.ref.block_start);
var meta: MetadataReader = .init(alloc, &rdr, self.decomp);
try meta.interface.discardAll(lookup.ref.block_offset);
const out = try alloc.alloc(XattrSemiOwned, lookup.count);
errdefer alloc.free(out);
for (0..lookup.count) |i| {
var key_entry: KeyEntry = undefined;
try meta.interface.readSliceEndian(KeyEntry, @ptrCast(&key_entry), .little);
const key: [:0]u8 = switch (key_entry.type.namespace) {
.user => blk: {
const tmp = try alloc.alloc(u8, key_entry.name_size + 1 + 5);
errdefer alloc.free(tmp);
try meta.interface.readSliceEndian(u8, tmp[5 .. tmp.len - 1], .little);
@memcpy(tmp[0..5], "user.");
tmp[tmp.len - 1] = 0;
break :blk @ptrCast(tmp);
},
.trusted => blk: {
const tmp = try alloc.alloc(u8, key_entry.name_size + 1 + 8);
errdefer alloc.free(tmp);
try meta.interface.readSliceEndian(u8, tmp[8 .. tmp.len - 1], .little);
@memcpy(tmp[0..8], "trusted.");
tmp[tmp.len - 1] = 0;
break :blk @ptrCast(tmp);
},
.security => blk: {
const tmp = try alloc.alloc(u8, key_entry.name_size + 1 + 9);
errdefer alloc.free(tmp);
try meta.interface.readSliceEndian(u8, tmp[9 .. tmp.len - 1], .little);
@memcpy(tmp[0..9], "security.");
tmp[tmp.len - 1] = 0;
break :blk @ptrCast(tmp);
},
};
errdefer alloc.free(key);
if (key_entry.type.out_of_line) {
var value: ValueOutOfLineEntry = undefined;
try meta.interface.readSliceEndian(ValueOutOfLineEntry, @ptrCast(&value), .little);
out[i] = .{
.key = key,
.value = try self.valueAt(io, value.ref),
};
continue;
}
const val_ref: InodeRef = .{ .block_start = meta.cur_block_start, .block_offset = @truncate(meta.interface.seek) };
{
try self.value_mut.lockShared(io);
defer self.value_mut.unlockShared(io);
if (self.value_cache.contains(val_ref)) {
out[i] = .{
.key = key,
.value = try self.valueAt(io, val_ref),
};
continue;
}
}
try self.value_mut.lock(io);
defer self.value_mut.unlock(io);
if (self.value_cache.contains(val_ref)) {
out[i] = .{
.key = key,
.value = try self.valueAt(io, val_ref),
};
continue;
}
var val_size: u32 = undefined;
try meta.interface.readSliceEndian(u32, @ptrCast(&val_size), .little);
const val = try self.alloc.alloc(u8, val_size);
errdefer alloc.free(val);
try meta.interface.readSliceEndian(u8, val, .little);
try self.value_cache.put(val_ref, val);
out[i] = .{
.key = key,
.value = val,
};
}
return out;
}
fn valueAt(self: *XattrCachedTable, io: Io, ref: InodeRef) ![]const u8 {
try self.value_mut.lock(io);
defer self.value_mut.unlock(io);
if (self.value_cache.contains(ref)) return self.value_cache.get(ref).?;
var rdr = self.fil.readerAt(self.kv_start + ref.block_start);
var meta: MetadataReader = .init(self.alloc, &rdr, self.decomp);
try meta.interface.discardAll(ref.block_offset);
var val_size: u32 = undefined;
try meta.interface.readSliceEndian(u32, @ptrCast(&val_size), .little);
const val = try self.alloc.alloc(u8, val_size);
errdefer self.alloc.free(val);
try meta.interface.readSliceEndian(u8, val, .little);
try self.value_cache.put(ref, val);
return val;
}
// Types
/// An Xattr return value where the reciever only owns the key value.
pub const XattrSemiOwned = struct {
key: [:0]const u8,
value: []const u8,
pub fn deinit(self: XattrSemiOwned, alloc: std.mem.Allocator) void {
alloc.free(self.key);
}
};
/// An Xattr return value where the reciever owns both the key & value.
pub const XattrOwned = struct {
key: [:0]const u8,
value: []const u8,
pub fn deinit(self: XattrSemiOwned, alloc: std.mem.Allocator) void {
alloc.free(self.key);
alloc.free(self.value);
}
};
const TableValue = extern struct {
ref: InodeRef,
count: u32,
size: u32,
};
const KeyEntry = extern struct {
type: XattrPrefix,
name_size: u16,
};
const ValueOutOfLineEntry = extern struct {
_: u32,
ref: InodeRef,
};
const XattrPrefix = packed struct(u16) {
namespace: enum(u8) {
user,
trusted,
security,
fn prefixSize(self: @This()) u16 {
return switch (self) {
.user => 5,
.trusted => 8,
.security => 9,
};
}
},
out_of_line: bool,
_: u7,
};
// Stateless
pub fn statelessLookup(alloc: std.mem.Allocator, io: Io, decomp: *Decompressor, fil: OffsetFile, table_start: u64, idx: u16) ![]XattrOwned {
const kv_start: u64 = std.mem.readInt(u64, @ptrCast(fil.map.memory[table_start .. table_start + 8]), .little);
const lookup = try LookupTable.lookupValue(TableValue, alloc, io, decomp, fil, table_start + 16, idx);
var rdr = fil.readerAt(kv_start + lookup.ref.block_start);
var meta: MetadataReader = .init(alloc, &rdr.interface, decomp);
try meta.interface.discardAll(lookup.ref.block_offset);
const out = try alloc.alloc(XattrOwned, lookup.count);
errdefer alloc.free(out);
for (0..lookup.count) |i| {
const key_entry: KeyEntry = undefined;
try meta.interface.readSliceEndian(KeyEntry, @ptrCast(&key_entry), .little);
const key = switch (key_entry.type.namespace) {
.user => blk: {
const tmp = try alloc.alloc(u8, key_entry.name_size + 1 + 5);
errdefer alloc.free(tmp);
try meta.interface.readSliceEndian(u8, tmp[5 .. tmp.len - 1], .little);
@memset(tmp[0..5], "user.");
break :blk tmp;
},
.trusted => blk: {
const tmp = try alloc.alloc(u8, key_entry.name_size + 1 + 8);
errdefer alloc.free(tmp);
try meta.interface.readSliceEndian(u8, tmp[8 .. tmp.len - 1], .little);
@memset(tmp[0..8], "trusted.");
break :blk tmp;
},
.security => blk: {
const tmp = try alloc.alloc(u8, key_entry.name_size + 1 + 9);
errdefer alloc.free(tmp);
try meta.interface.readSliceEndian(u8, tmp[9 .. tmp.len - 1], .little);
@memset(tmp[0..9], "security.");
break :blk tmp;
},
};
key[key.len - 1] = 0;
errdefer alloc.free(key);
if (key_entry.type.out_of_line) {
const value: ValueOutOfLineEntry = undefined;
try meta.interface.readSliceEndian(ValueOutOfLineEntry, @ptrCast(&value), .little);
var ool_rdr = fil.readerAt(kv_start + value.ref.block_start);
var ool_meta: MetadataReader = .init(alloc, &ool_rdr.interface, decomp);
try ool_meta.interface.discardAll(value.ref.block_offset);
var val_size: u32 = undefined;
try ool_meta.interface.readSliceEndian(val_size, @ptrCast(&val_size), .little);
const val = try alloc.alloc(u8, val_size);
errdefer alloc.free(val);
try ool_meta.interface.readSliceEndian(u8, val, .little);
out[i] = .{
.key = key,
.value = val,
};
continue;
}
var val_size: u32 = undefined;
try meta.interface.readSliceEndian(val_size, @ptrCast(&val_size), .little);
const val = try alloc.alloc(u8, val_size);
errdefer alloc.free(val);
try meta.interface.readSliceEndian(u8, val, .little);
out[i] = .{
.key = key,
.value = val,
};
}
return out;
}