18 Commits

Author SHA1 Message Date
Caleb Gardner 84a9cf17b9 Fixed some issues with stateless Lookup Table 2026-05-21 05:42:00 -05:00
Caleb Gardner d1d453ac29 Finished an initial version of extraction
It works, but is very slow.
2026-05-21 05:07:02 -05:00
Caleb Gardner 69ce562b6c Re-doing extraction with learning about Io 2026-05-17 12:32:58 -05:00
Caleb Gardner 10e9b66ac6 Further work on extraction 2026-05-16 23:41:28 -05:00
Caleb Gardner 3c57a2d1e4 Cleanup & fixes 2026-05-16 06:14:08 -05:00
Caleb Gardner 700993b0e3 Finished up some errors
Kinda finished extraction
2026-05-13 06:21:01 -05:00
Caleb Gardner 78d1ee2937 Started concrete implementation of extraction 2026-05-13 01:12:02 -05:00
Caleb Gardner 2b0625e178 Finished (?) Data extractor 2026-05-12 12:22:48 -05:00
Caleb J. Gardner ad05e5dff1 Added xattr function to inode 2026-05-10 14:34:05 -05:00
Caleb J. Gardner 688ca53206 Finished (?) Xattr Cached table 2026-05-10 14:23:56 -05:00
Caleb Gardner 93a55aa5c7 Started work on xattr decoding
Added more utility to Inode's
2026-05-10 12:31:40 -05:00
Caleb Gardner d76b164e45 More work on extraction, especially for regular files 2026-05-08 06:06:33 -05:00
Caleb Gardner 5521b2ce6a Started working on file extraction 2026-05-03 05:31:04 -05:00
Caleb Gardner cbd2697c19 File openning
Start on data extraction
2026-05-03 04:40:49 -05:00
Caleb Gardner a3f7b86e67 Updated a lot of packed structs to extern struct
Specified int types for remaining packed structs
Instead of manually decoding File & ExtFile structs, decode an extern struct first
Fixed some zstd issues
Some more File stuff
2026-05-02 06:10:24 -05:00
Caleb Gardner ab606bdfa5 Fished decompression (maybe)
Added the necessary skeleton functions to re-add test
2026-05-01 07:05:52 -05:00
Caleb Gardner 274d088490 Further work on getting everything working again
Mainly working on decompression interface
2026-04-30 07:00:46 -05:00
Caleb Gardner b67d02074d Started re-write (once again)
Main reason for this re-write is to be compatible with zig 0.16.0
2026-04-29 03:48:34 -05:00
37 changed files with 2311 additions and 1697 deletions
+45 -94
View File
@@ -1,125 +1,76 @@
const std = @import("std");
const Build = std.Build;
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 allow_lzo = b.option(bool, "allow_lzo", "Compile with lzo decompression support.") orelse false;
const dynamic = b.option(bool, "dynamic", "Dynamic link C decompression libraries.") orelse false;
const debug = b.option(bool, "debug", "Enable options to make debugging easier.") orelse false;
const version_string = b.option([]const u8, "version", "Version of the library/binary") orelse "0.0.0-testing";
// 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 debug = b.option(bool, "debug", "Enable options to make debugging easier.");
const version_string_option = b.option([]const u8, "version", "Version of the library/binary");
const version: std.SemanticVersion = try .parse(version_string);
// const zig_squashfs_options = b.addOptions();
// zig_squashfs_options.addOption(bool, "use_zig_decomp", use_zig_decomp);
// zig_squashfs_options.addOption(bool, "allow_lzo", allow_lzo);
const zig_squashfs_options = b.addOptions();
zig_squashfs_options.addOption(bool, "use_zig_decomp", use_zig_decomp);
zig_squashfs_options.addOption(bool, "allow_lzo", allow_lzo);
const optimize = b.standardOptimizeOption(.{});
const target = b.standardTargetOptions(.{});
const c = b.addTranslateC(.{
.optimize = optimize,
.target = target,
.root_source_file = b.path("src/c.h"),
});
if (allow_lzo)
c.defineCMacro("ALLOW_LZO", null);
if (dynamic) {
c.linkSystemLibrary("z", .{});
c.linkSystemLibrary("lzma", .{});
c.linkSystemLibrary("lz4", .{});
c.linkSystemLibrary("zstd", .{});
if (allow_lzo)
c.linkSystemLibrary("minilzo", .{});
}
const deps = try getDependencies(b, optimize, target, allow_lzo);
const optimize = b.standardOptimizeOption(.{});
const lib = b.addLibrary(.{
.name = "squashfs",
.use_llvm = debug,
.version = version,
.root_module = b.createModule(.{
.imports = &.{
.{ .name = "options", .module = zig_squashfs_options.createModule() },
.{ .name = "c", .module = c.createModule() },
},
.optimize = optimize,
.optimize = if (debug == true) .Debug else optimize,
.target = target,
.root_source_file = b.path("src/root.zig"),
.valgrind = debug,
.root_source_file = b.path("src/root.zig"),
}),
.use_llvm = debug,
});
for (deps) |d|
lib.root_module.linkLibrary(d);
b.installArtifact(lib);
const exe_config = b.addOptions();
exe_config.addOption(std.SemanticVersion,"version", version);
var version = version_string_option orelse "0.0.0-testing";
if (version[0] == 'v') version = version[1..];
const unsquashfs_options = b.addOptions();
unsquashfs_options.addOption(
std.SemanticVersion,
"version",
try std.SemanticVersion.parse(version),
);
const exe = b.addExecutable(.{
.name = "unsquashfs",
.root_module = b.createModule(.{
.optimize = if (debug == true) .Debug else optimize,
.target = target,
.valgrind = debug,
.root_source_file = b.path("src/bin/unsquashfs.zig"),
.imports = &.{
.{ .name = "zig_squashfs", .module = lib.root_module },
},
}),
.use_llvm = debug,
.version = version,
});
exe.root_module.addOptions("config", unsquashfs_options);
b.installArtifact(lib);
b.installArtifact(exe);
const mod_tests = b.addTest(.{
.root_module = b.createModule(.{
.optimize = optimize,
.target = target,
.root_source_file = b.path("src/bin/unsquashfs.zig"),
.valgrind = debug,
.imports = &.{
.{ .name = "config", .module = exe_config.createModule() },
.{ .name = "squashfs", .module = lib.root_module }
},
.root_source_file = b.path("src/test.zig"),
}),
});
b.installArtifact(exe);
const lib_test = b.addTest(.{
.name = "squashfs-test",
.root_module = lib.root_module,
});
const run_mod_tests = b.addRunArtifact(mod_tests);
const test_step = b.step("test", "Run tests");
test_step.dependOn(&lib_test.step);
test_step.dependOn(&run_mod_tests.step);
// zls check step
// zls build check steps
const lib_check = b.addLibrary(.{
.name = "squashfs-check",
.root_module = lib.root_module,
});
const exe_check = b.addLibrary(.{
.name = "unsquashfs-check",
.name = "squashfs",
.root_module = exe.root_module,
});
const check = b.step("check", "Check if squashfs compiles");
const exe_check = b.addExecutable(.{
.name = "unsquashfs",
.root_module = lib.root_module,
});
const check = b.step("check", "Check if unsquashfs compiles");
check.dependOn(&lib_check.step);
check.dependOn(&exe_check.step);
}
fn getDependencies(b: *Build, optimize: std.builtin.OptimizeMode, target: Build.ResolvedTarget, allow_lzo: bool) ![]*Build.Step.Compile {
const alloc = b.allocator;
var list: std.ArrayList(*Build.Step.Compile) = .empty;
const zlib_ng = b.dependency("zlib_ng", .{ .optimize = optimize, .target = target });
try list.append(alloc, zlib_ng.artifact("zng"));
const xz = b.dependency("xz", .{ .optimize = optimize, .target = target });
try list.append(alloc, xz.artifact("lzma"));
const lz4 = b.dependency("lz4", .{ .optimize = optimize, .target = target });
try list.append(alloc, lz4.artifact("lz4"));
const zstd = b.dependency("zstd", .{ .optimize = optimize, .target = target });
try list.append(alloc, zstd.artifact("zstd"));
if (allow_lzo) {
const minilzo = b.dependency("minilzo", .{ .optimize = optimize, .target = target });
try list.append(alloc, minilzo.artifact("minilzo"));
}
return list.toOwnedSlice(b.allocator);
}
+1 -5
View File
@@ -2,7 +2,7 @@
.name = .squashfs,
.version = "0.0.6",
.fingerprint = 0x37ba29474b87f145, // Changing this has security and trust implications.
.minimum_zig_version = "0.16.0",
.minimum_zig_version = "0.15.2",
.dependencies = .{
.zlib_ng = .{
.url = "git+https://github.com/CalebQ42/zig-zlib-ng#5f2f02dfb28acca2517dacbbd09e9b987f57b133",
@@ -20,10 +20,6 @@
.url = "git+https://github.com/CalebQ42/zig-minilzo.git#7cbae997b91a44d74b7cd6c073584dc9562a6c90",
.hash = "minilzo-2.10.0-Ij7BO8wLAADeWI4Pe4jp8XTDsDaquZR14oZ7_9yKKDWP",
},
.xz = .{
.url = "git+https://github.com/akunaakwei/zig-xz.git#e2d389262c8291907e3e4c6fb119819141c16c0f",
.hash = "xz-5.8.2-6v47_JYeAABSL-jonprpL5-E_YaaGc4B5xrbe93WsJ3G",
},
},
.paths = .{
"build.zig",
+103 -110
View File
@@ -1,114 +1,155 @@
const std = @import("std");
const Io = std.Io;
const File = Io.File;
const MemoryMap = File.MemoryMap;
const Decomp = @import("decomp.zig");
const DecompCache = @import("decomp_cache.zig");
const Extract = @import("extract.zig");
const ExtractionOptions = @import("options.zig");
const File = @import("file.zig");
const Inode = @import("inode.zig");
const SfsFile = @import("file.zig");
const LookupTable = @import("lookup_table.zig");
const Decompressor = @import("util/decompressor.zig");
const MetadataReader = @import("util/metadata.zig");
const Utils = @import("util/misc.zig");
const OffsetFile = @import("util/offset_file.zig");
const Archive = @This();
const CACHE_MEM_MAX = 1024 * 1024 * 1024;
file: OffsetFile,
super: Superblock,
cache: DecompCache,
stateless_decomp: Decompressor,
pub fn init(alloc: std.mem.Allocator, io: Io, fil: File) !Archive {
return initAdvanced(alloc, io, fil, 0, 0);
}
pub fn initAdvanced(alloc: std.mem.Allocator, io: Io, fil: File, offset: u64, cache_memory_max: u64) !Archive {
var rdr = fil.reader(io, &[0]u8{});
pub fn init(io: Io, file: std.Io.File, offset: u64) !Archive {
var rdr = file.reader(io, &[0]u8{});
try rdr.seekTo(offset);
var super: Superblock = undefined;
try rdr.interface.readSliceEndian(Superblock, @ptrCast(&super), .little);
try super.validate();
const map = try fil.createMemoryMap(io, .{
.offset = offset,
.len = super.size,
.protection = .{ .read = true },
});
return .{
.file = .init(file, offset),
.super = super,
.cache = try .init(
alloc,
map,
super.compression,
if (cache_memory_max != 0)
cache_memory_max
else
@min(CACHE_MEM_MAX, (try std.process.totalSystemMemory()) / 2),
),
.stateless_decomp = switch (super.compression) {
.gzip => @import("decomp/zlib.zig").stateless_decompressor,
.lzma => @import("decomp/lzma.zig").stateless_decompressor,
.lzo => return error.LzoUnsupported,
.xz => @import("decomp/xz.zig").stateless_decompressor,
.lz4 => return error.Lz4Unsupported,
.zstd => @import("decomp/zstd.zig").stateless_decompressor,
},
};
}
pub fn deinit(self: *Archive, io: Io) void {
self.cache.deinit(io);
}
pub fn root(self: *Archive, alloc: std.mem.Allocator, io: Io) !SfsFile {
const inode: Inode = try .initRef(
/// The root folder of the Archive. Used to open other Files.
pub fn root(self: Archive, alloc: std.mem.Allocator, io: Io) !File {
const root_inode = try Utils.inodeFromRef(
alloc,
io,
&self.cache,
self.file,
&self.stateless_decomp,
self.super.inode_start,
self.super.block_size,
self.super.root_ref,
);
return .init(alloc, self, inode, "");
return .init(alloc, self, root_inode, "");
}
pub fn open(self: *Archive, alloc: std.mem.Allocator, io: Io, filepath: []const u8) !SfsFile {
/// Opens a File within the archive.
pub fn open(self: Archive, alloc: std.mem.Allocator, io: Io, filepath: []const u8) !File {
const root_file = try self.root(alloc, io);
const path = std.mem.trim(u8, filepath, "/");
var root_file = try self.root(alloc, io);
if (path.len == 0 or path[0] == '.') return root_file;
if (Utils.pathIsSelf(path))
return root_file;
defer root_file.deinit();
return root_file.open(alloc, io, filepath);
}
pub fn extract(self: *Archive, alloc: std.mem.Allocator, io: Io, ext_loc: []const u8, options: ExtractionOptions) !void {
const root_inode: Inode = try .initRef(
/// 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,
io,
&self.cache,
self.file,
&self.stateless_decomp,
self.super.inode_start,
self.super.block_size,
self.super.root_ref,
);
return Extract.extract(alloc, io, root_inode, &self.cache, self.super, ext_loc, options);
return root_inode.extract(alloc, io, self.file, self.super, extract_dir, options);
}
/// Returns the inode with the given inode number.
/// Requires that the archive is exportable (has an export lookup table).
pub fn inode(self: Archive, alloc: std.mem.Allocator, io: Io, num: u32) !Inode {
if (!self.super.flags.exportable)
return error.NotExportable;
const ref = try LookupTable.lookupValue(
Inode.Ref,
alloc,
io,
&self.stateless_decomp,
self.file,
self.super.export_start,
num + 1,
);
return Utils.inodeFromRef(
alloc,
io,
self.file,
&self.stateless_decomp,
self.super.inode_start,
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,
idx,
);
}
// 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,
compression: enum(u16) {
gzip = 1,
lzma,
lzo,
xz,
lz4,
zstd,
},
block_log: u16,
flags: packed struct(u16) {
inode_uncompressed: bool,
data_uncompressed: bool,
check: bool,
frag_uncompressed: bool,
frag_never: bool,
frag_always: bool,
de_dupe: bool,
fragment_never: bool,
fragment_always: bool,
duplicates: bool,
exportable: bool,
xattr_uncompressed: bool,
xattr_never: bool,
compression_options: bool,
id_uncompressed: bool,
ids_uncompressed: bool,
_: u4,
},
id_count: u16,
@@ -123,63 +164,15 @@ pub const Superblock = extern struct {
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 != std.mem.readInt(u32, "hsqs", .little))
return error.BadMagic;
if (self.ver_maj != 4 or self.ver_min != 0)
return error.InvalidVersion;
if (self.block_log != std.math.log2(self.block_size))
return error.BadBlockLog;
if (self.magic != SQUASHFS_MAGIC)
return SuperblockError.InvalidMagic;
if (self.flags.check)
return error.BadCheckFlag;
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;
}
};
// Test
const TestArchive = "testing/LinuxPATest.sfs";
test "Basics" {
const alloc = std.testing.allocator;
const io = std.testing.io;
var archive_file = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer archive_file.close(io);
var arc: Archive = try .init(alloc, io, archive_file);
defer arc.deinit(io);
var root_file = try arc.root(alloc, io);
defer root_file.deinit();
}
const TestFile = "Start.exe";
const TestFileExtractLocation = "testing/Start.exe";
test "SingleFileExtraction" {
const alloc = std.testing.allocator;
const io = std.testing.io;
var archive_file = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer archive_file.close(io);
var arc: Archive = try .init(alloc, io, archive_file);
defer arc.deinit(io);
var ext_file = try arc.open(alloc, io, TestFile);
defer ext_file.deinit();
try ext_file.extract(alloc, io, TestFileExtractLocation, .default);
}
const TestFullExtractLocation = "testing/TestExtract";
test "FullExtraction" {
const alloc = std.testing.allocator;
const io = std.testing.io;
var archive_file = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer archive_file.close(io);
var arc: Archive = try .init(alloc, io, archive_file);
defer arc.deinit(io);
try arc.extract(alloc, io, TestFullExtractLocation, .default);
}
+12 -8
View File
@@ -1,11 +1,10 @@
const std = @import("std");
const Io = std.Io;
const Writer = Io.Writer;
const File = Io.File;
const builtin = @import("builtin");
const config = @import("config");
const squashfs = @import("squashfs");
const squashfs = @import("zig_squashfs");
//TODO: Add more options
const help_mgs =
@@ -19,7 +18,7 @@ const help_mgs =
\\ -dx Don't set xattr values
\\ -dp Don't set permissions (includes setting uid & gid owner)
\\
\\ -p <threads> Specify how many threads to use. If no present or zero, the system's logical cores count is used.
\\ -p <threads> Specify how many threads to use. If not present or zero, the system's logical cores count is used.
\\ -v Verbose
\\
\\ --force Force extraction. If the destination already exists, it will be deleted.
@@ -44,25 +43,30 @@ pub fn main(init: std.process.Init) !void {
const alloc = init.gpa;
const io = init.io;
var stdout = File.stdout();
var stdout = std.Io.File.stdout();
defer stdout.close(io);
var out = stdout.writer(io, &[0]u8{});
defer out.interface.flush() catch {};
try handleArgs(init.minimal.args, &out.interface);
if (archive.len == 0) {
try out.interface.print("You must provide a squashfs archive\n", .{});
try out.interface.print(help_mgs, .{});
return;
}
var fil: File = try Io.Dir.cwd().openFile(io, archive, .{}); //TODO: Handle error gracefully.
var fil = try Io.Dir.cwd().openFile(io, archive, .{}); //TODO: Handle error gracefully.
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.
defer arc.deinit(io);
var arc: squashfs.Archive = try .init(io, fil, offset); //TODO: Handle error gracefully.
const options: squashfs.ExtractionOptions = .{
.threads = if (threads == 0) try std.Thread.getCpuCount() else threads,
.verbose = verbose,
.verbose_writer = if (verbose) &out.interface else null,
.ignore_xattr = ignore_xattrs,
.ignore_permissions = ignore_permissions,
};
if (force)
try Io.Dir.cwd().deleteTree(io, extLoc);
try arc.extract(alloc, io, extLoc, options); //TODO: Handle error gracefully.
@@ -71,7 +75,7 @@ pub fn main(init: std.process.Init) !void {
fn handleArgs(args: std.process.Args, out: *Writer) !void {
var arg_iter = args.iterate();
defer arg_iter.deinit();
_ = arg_iter.skip(); // args[0] is the application launch command.
_ = arg_iter.next(); // args[0] is the application launch command.
while (arg_iter.next()) |arg| {
if (std.mem.eql(u8, arg, "-o")) {
const nxt = arg_iter.next();
-7
View File
@@ -1,7 +0,0 @@
#include <zlib.h>
#include <lzma.h>
#include <lz4.h>
#include <zstd.h>
#ifdef ALLOW_LZO
#include <lzo/minilzo.h>
#endif
-61
View File
@@ -1,61 +0,0 @@
const std = @import("std");
const c = @import("c");
const Error = @import("decomp.zig").Error;
pub fn zlibDecompress(_: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
var strem: c.z_stream = .{
.next_in = in.ptr,
.avail_in = @truncate(in.len),
.next_out = out.ptr,
.avail_out = @truncate(out.len),
};
var res = c.inflateInit(&strem);
if (res != c.Z_OK) return Error.ReadFailed;
defer _ = c.inflateEnd(&strem);
res = c.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;
}
-102
View File
@@ -1,102 +0,0 @@
const std = @import("std");
const Io = std.Io;
const DecompCache = @import("../decomp_cache.zig");
const DataBlock = @import("../inode.zig").DataBlock;
const Extractor = @This();
cache: *DecompCache,
block_size: u32,
start: u64,
size: u64,
blocks: []DataBlock,
frag_data: ?[]u8 = null,
frag_offset: u32 = 0,
pub fn init(cache: *DecompCache, block_size: u32, size: u64, start: u64, blocks: []DataBlock) Extractor {
return .{
.cache = cache,
.block_size = block_size,
.start = start,
.size = size,
.blocks = blocks,
};
}
pub fn addFragment(self: *Extractor, data: []u8, offset: u32) void {
self.frag_data = data;
self.frag_offset = offset;
}
pub fn asyncExtract(self: Extractor, io: Io, fil: Io.File) Error!void {
try fil.writePositionalAll(io, &.{&.{0}}, self.size - 1);
var map = try fil.createMemoryMap(io, .{ .len = self.size, .protection = .{ .write = true } });
defer map.destroy(io);
var group: Io.Group = .init;
defer group.cancel(io);
var ret_err: ?Error = null;
var offset = self.start;
for (0..self.blocks.len) |i| {
group.async(io, blockThread, .{ self, io, map, offset, i, &ret_err });
offset += self.blocks[i].size;
}
if (self.frag_data != null)
group.async(io, fragThread, .{ self, map });
group.await(io) catch |err| return ret_err orelse err;
try map.write(io);
}
fn blockThread(self: Extractor, io: Io, map: Io.File.MemoryMap, read_offset: u64, idx: usize, ret_err: *?Error) error{Canceled}!void {
const write_pos = idx * self.block_size;
const size = if (self.frag_data == null and idx == self.block_size.len - 1)
self.size % self.block_size
else
self.block_size;
const block = self.blocks[idx];
if (block.size == 0) {
@memset(map.memory[write_pos..][0..size], 0);
return;
}
if (block.uncompressed) {
@memcpy(map[write_pos..][0..size], self.cache.map.memory[read_offset..][0..size]);
return;
}
const data = self.cache.get(io, read_offset, block.size, size) catch |err| switch (err) {
error.Canceled => {
io.recancel();
return error.Canceled;
},
else => |e| {
ret_err.* = e;
return error.Canceled;
},
};
defer self.cache.finished(io, read_offset);
if (data.len != size) {
std.debug.print("Size of decompression at {} is {} and should be {}\n", .{ read_offset, data.len, size });
return Error.BadDecompressionSize;
}
@memcpy(map[write_pos..][0..size], data);
}
fn fragThread(self: Extractor, map: Io.File.MemoryMap) error{Canceled}!void {
const write_pos = self.blocks.len * self.block_size;
const size = self.size % self.block_size;
@memcpy(map.memory[write_pos..][0..size], self.frag_data.?[self.frag_offset..][0..size]);
}
// Types
pub const Error = error{BadDecompressionSize} || Io.File.WritePositionalError || Io.File.MemoryMap.CreateError;
-151
View File
@@ -1,151 +0,0 @@
const std = @import("std");
const Io = std.Io;
const DecompCache = @import("../decomp_cache.zig");
const DataBlock = @import("../inode.zig").DataBlock;
const Reader = @This();
io: Io,
cache: *DecompCache,
block_size: u32,
size: u64,
blocks: []DataBlock,
frag_data: ?[]u8 = null,
frag_offset: u32 = 0,
cur_offset: u64 = 0,
next_offset: u64,
idx: u32 = 0,
cur_block_sparse: bool = false,
interface: Io.Reader = .{
.buffer = &[0]u8{},
.end = 0,
.seek = 0,
.vtable = &.{
.stream = stream,
.discard = discard,
.readVec = readVec,
},
},
pub fn init(io: Io, cache: *DecompCache, block_size: u32, size: u64, start: u64, blocks: []DataBlock) Reader {
return .{
.io = io,
.cache = cache,
.block_size = block_size,
.size = size,
.blocks = blocks,
.next_offset = start,
};
}
pub fn deinit(self: Reader) void {
self.cache.finished(self.io);
}
pub fn addFragment(self: *Reader, data: []u8, offset: u32) void {
self.frag_data = data;
self.frag_offset = offset;
}
fn advance(self: *Reader) Io.Reader.Error!void {
errdefer self.interface.end = 0;
self.interface.seek = 0;
if (self.idx > self.blocks.len) return error.EndOfStream;
defer self.idx += 1;
self.cache.finished(self.io, self.cur_offset);
if (self.idx == self.blocks.len) {
if (self.frag_data == null) return error.EndOfStream;
self.cur_offset = 0;
const size = self.size % self.block_size;
self.interface.buffer = self.frag_data.?[self.frag_offset..][0..size];
self.interface.end = size;
return;
}
const block = self.blocks[self.idx];
const size = if (self.idx == self.blocks.len - 1 and self.frag_data == null)
self.size % self.block_size
else
self.block_size;
if (block.size == 0) {
self.interface.buffer = &[0]u8{};
self.cur_block_sparse = true;
self.interface.end = size;
return;
} else {
self.cur_block_sparse = false;
}
self.cur_offset = self.next_offset;
self.next_offset = self.cur_offset + block.size;
if (block.uncompressed) {
self.interface.buffer = self.cache.map.memory[self.cur_offset..][0..size];
self.interface.end = size;
return;
}
const data = self.cache.get(self.io, self.cur_offset, block.size, size);
if (data.len != size) {
std.debug.print("Size of decompression at {} is {} and should be {}\n", .{ self.cur_offset, data.len, size });
return Io.Reader.Error.ReadFailed;
}
self.interface.buffer = data;
self.interface.end = size;
}
fn stream(r: *Io.Reader, w: *Io.Writer, limit: Io.Limit) Io.Reader.StreamError!usize {
const self: *Reader = @fieldParentPtr("interface", r);
if (r.seek >= r.end) {
try self.advance();
}
const to_write = @min(@intFromEnum(limit), r.end - r.seek);
const wrote = try if (self.cur_block_sparse)
w.splatByte(0, to_write)
else
w.write(r.buffer[r.seek..][0..to_write]);
r.seek += wrote;
return wrote;
}
fn discard(r: *Io.Reader, limit: Io.Limit) Io.Reader.Error!usize {
if (r.seek >= r.end) {
const self: *Reader = @fieldParentPtr("interface", r);
try self.advance();
}
const to_discard = @min(@intFromEnum(limit), r.end - r.seek);
r.seek += to_discard;
return to_discard;
}
fn readVec(r: *Io.Reader, vec: [][]u8) Io.Reader.Error!usize {
const self: *Reader = @fieldParentPtr("interface", r);
if (r.seek >= r.end) {
try self.advance();
}
var total: usize = 0;
for (vec) |v| {
const to_copy = @min(v.len, r.end - r.seek);
if (self.cur_block_sparse) {
@memset(v[0..to_copy], 0);
} else {
@memcpy(v[0..to_copy], r.buffer[r.seek..][0..to_copy]);
}
total += to_copy;
r.seek += to_copy;
if (r.seek >= r.end) break;
}
return total;
}
+27 -36
View File
@@ -1,41 +1,32 @@
const std = @import("std");
const options = @import("options");
const Decompressor = @import("util/decompressor.zig");
const c_decomp = @import("c_decomp.zig");
const zig_decomp = @import("zig_decomp.zig");
pub const Decomp = union(enum) {
gzip: @import("decomp/zlib.zig"),
lzma: @import("decomp/lzma.zig"),
lzo: void,
xz: @import("decomp/xz.zig"),
lz4: void,
zstd: @import("decomp/zstd.zig"),
pub const Error = error{} || std.Io.Reader.UnlimitedAllocError;
pub const Enum = enum(u16) {
zlib = 1,
lzma,
lzo,
xz,
lz4,
zstd,
};
pub const Fn = *const fn (std.mem.Allocator, in: []u8, out: []u8) Error!usize;
pub fn DecompFn(comp: Enum) !Fn {
return if (options.use_zig_decomp)
switch (comp) {
.zlib => zig_decomp.zlibDecompress,
.lzma => zig_decomp.lzmaDecompress,
.xz => zig_decomp.xzDecompress,
.zstd => zig_decomp.zstdDecompress,
.lz4 => error.Lz4Unsupported,
.lzo => error.LzoUnsupported,
pub fn deinit(self: *Decomp) void {
switch (self.*) {
.gzip => self.gzip.deinit(),
.lzma => self.lzma.deinit(),
.xz => self.xz.deinit(),
.zstd => self.zstd.deinit(),
else => unreachable,
}
else switch (comp) {
.zlib => c_decomp.zlibDecompress,
.lzma, .xz => c_decomp.lzmaDecompress,
.zstd => c_decomp.zstdDecompress,
.lz4 => c_decomp.lz4Decompress,
.lzo => if (options.allow_lzo)
c_decomp.zstdDecompress
else
error.LzoUnsupported,
};
}
}
pub fn decompressor(self: *Decomp) *Decompressor {
return switch (self.*) {
.gzip => &self.gzip.interface,
.lzma => &self.lzma.interface,
.xz => &self.xz.interface,
.zstd => &self.zstd.interface,
else => unreachable,
};
}
};
+86
View File
@@ -0,0 +1,86 @@
const std = @import("std");
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 Self = @This();
const Buffer = struct {
node: Node,
buf: []u8,
};
interface: Decompressor = .{ .decomp_fn = decomp },
alloc: std.mem.Allocator,
block_size: u32,
buffers: std.ArrayList(Buffer),
buffer_queue: std.SinglyLinkedList = .{},
pub fn init(alloc: std.mem.Allocator, block_size: u32) !Self {
return .{
.alloc = alloc,
.block_size = block_size,
.buffers = try .initCapacity(alloc, 5),
};
}
pub fn deinit(self: *Self) void {
for (self.buffers.items) |buf|
self.alloc.free(buf.buf);
self.buffers.deinit(self.alloc);
}
fn decomp(d: ?*const Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
if (d == null) {
var buf = try alloc.alloc(u8, in.len * 2);
defer alloc.free(buf);
return lzmaDecomp(alloc, &buf, in, out) catch |err| return switch (err) {
error.OutOfMemory => Error.OutOfMemory,
else => Error.ReadFailed,
};
}
var self: *Self = @fieldParentPtr("interface", @constCast(d.?));
const buf_node = self.buffer_queue.popFirst();
var buf: *Buffer = undefined;
if (buf_node == null) {
const new_buf = try self.buffers.addOne(self.alloc);
new_buf.* = .{ .node = .{}, .buf = try self.alloc.alloc(u8, self.block_size) };
buf = new_buf;
} else {
buf = @fieldParentPtr("node", buf_node.?);
}
defer self.buffer_queue.prepend(&buf.node);
return lzmaDecomp(self.alloc, &buf.buf, in, out) catch |err| {
// self.err = err;
return switch (err) {
error.OutOfMemory => Error.OutOfMemory,
else => 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.*, .{ .allow_incomplete = true }, 3 * 1024 * 1024);
defer {
buffer.* = d.takeBuffer();
d.deinit();
}
return d.reader.readSliceShort(out);
}
// Stateless
pub const stateless_decompressor: Decompressor = .{ .decomp_fn = statelessDecomp };
fn statelessDecomp(_: ?*const 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;
}
+80
View File
@@ -0,0 +1,80 @@
const std = @import("std");
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 Self = @This();
const Buffer = struct {
node: Node,
buf: []u8,
};
interface: Decompressor = .{ .decomp_fn = decomp },
alloc: std.mem.Allocator,
block_size: u32,
buffers: std.ArrayList(Buffer),
buffer_queue: std.SinglyLinkedList = .{},
pub fn init(alloc: std.mem.Allocator, block_size: u32) !Self {
return .{
.alloc = alloc,
.block_size = block_size,
.buffers = try .initCapacity(alloc, 5),
};
}
pub fn deinit(self: *Self) void {
for (self.buffers.items) |buf|
self.alloc.free(buf.buf);
self.buffers.deinit(self.alloc);
}
fn decomp(d: ?*const Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
if (d == null) {
var buf = try alloc.alloc(u8, in.len * 2);
defer alloc.free(buf);
return xzDecomp(alloc, &buf, in, out) catch return Error.ReadFailed;
}
var self: *Self = @fieldParentPtr("interface", @constCast(d.?));
const buf_node = self.buffer_queue.popFirst();
var buf: *Buffer = undefined;
if (buf_node == null) {
const new_buf = try self.buffers.addOne(self.alloc);
new_buf.* = .{ .node = .{}, .buf = try self.alloc.alloc(u8, self.block_size) };
buf = new_buf;
} else {
buf = @fieldParentPtr("node", buf_node.?);
}
defer self.buffer_queue.prepend(&buf.node);
return xzDecomp(self.alloc, &buf.buf, in, out) catch {
// self.err = err;
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(_: ?*const 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;
}
+73
View File
@@ -0,0 +1,73 @@
const std = @import("std");
const Reader = std.Io.Reader;
const flate = std.compress.flate;
const Node = std.SinglyLinkedList.Node;
const Decompressor = @import("../util/decompressor.zig");
const Error = Decompressor.Error;
const Self = @This();
const Buffer = struct {
node: Node,
buf: []u8,
};
interface: Decompressor = .{ .decomp_fn = decomp },
alloc: std.mem.Allocator,
block_size: u32,
buffers: std.ArrayList(Buffer),
buffer_queue: std.SinglyLinkedList = .{},
pub fn init(alloc: std.mem.Allocator, block_size: u32) !Self {
return .{
.alloc = alloc,
.block_size = block_size,
.buffers = try .initCapacity(alloc, 5),
};
}
pub fn deinit(self: *Self) void {
for (self.buffers.items) |buf|
self.alloc.free(buf.buf);
self.buffers.deinit(self.alloc);
}
fn decomp(d: ?*const 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 zlibDecomp(buf, in, out);
}
var self: *Self = @fieldParentPtr("interface", @constCast(d.?));
const buf_node = self.buffer_queue.popFirst();
var buf: *Buffer = undefined;
if (buf_node == null) {
const new_buf = try self.buffers.addOne(self.alloc);
new_buf.* = .{ .node = .{}, .buf = try self.alloc.alloc(u8, self.block_size) };
buf = new_buf;
} else {
buf = @fieldParentPtr("node", buf_node.?);
}
defer self.buffer_queue.prepend(&buf.node);
return zlibDecomp(buf.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(_: ?*const Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
const buf = try alloc.alloc(u8, in.len * 2);
defer alloc.free(buf);
return zlibDecomp(buf, in, out);
}
+74
View File
@@ -0,0 +1,74 @@
const std = @import("std");
const Io = std.Io;
const Reader = std.Io.Reader;
const zstd = std.compress.zstd;
const Node = std.SinglyLinkedList.Node;
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, 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 + 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: ?*const 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(_: ?*const 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);
}
-116
View File
@@ -1,116 +0,0 @@
const std = @import("std");
const Io = std.Io;
const File = Io.File;
const MemoryMap = File.MemoryMap;
const Atomic = std.atomic.Value;
const Decomp = @import("decomp.zig");
const DecompCache = @This();
alloc: std.mem.Allocator,
map: MemoryMap,
decomp_fn: Decomp.Fn,
cache: std.AutoHashMap(u64, Cache),
mut: std.Io.RwLock = .init,
cond: std.Io.Condition = .init,
max_mem: u64,
cur_mem: u64 = 0,
pub fn init(alloc: std.mem.Allocator, map: MemoryMap, compression: Decomp.Enum, max_mem: u64) !DecompCache {
return .{
.alloc = alloc,
.map = map,
.decomp_fn = try Decomp.DecompFn(compression),
.cache = .init(alloc),
.max_mem = max_mem,
};
}
pub fn deinit(self: *DecompCache, io: Io) void {
self.mut.lockUncancelable(io);
var iter = self.cache.valueIterator();
while (iter.next()) |v|
self.alloc.free(v.data);
self.cache.deinit();
}
pub fn get(self: *DecompCache, io: Io, offset: u64, compressed_size: u32, max_size: u32) ![]u8 {
{
try self.mut.lockShared(io);
defer self.mut.unlockShared(io);
const cache = self.cache.getPtr(offset);
if (cache != null) {
_ = cache.?.usage.fetchAdd(1, .acquire);
return cache.?.data;
}
}
try self.mut.lock(io);
defer self.mut.unlock(io);
const cache = try self.cache.getOrPut(offset);
if (cache.found_existing) {
_ = cache.value_ptr.usage.fetchAdd(1, .acquire);
return cache.value_ptr.data;
}
errdefer self.cache.removeByPtr(cache.key_ptr);
try self.ensureSpace(io, max_size);
var out = try self.alloc.alloc(u8, max_size);
errdefer self.alloc.free(out);
const decomp_size = try self.decomp_fn(self.alloc, self.map.memory[offset..][0..compressed_size], out);
if (decomp_size != max_size) {
if (!self.alloc.resize(out, decomp_size)) {
const new_out = try self.alloc.alloc(u8, decomp_size);
@memcpy(new_out, out[0..decomp_size]);
out = new_out;
} else {
out.len = decomp_size;
}
}
self.cur_mem += decomp_size;
cache.value_ptr.data = out;
_ = cache.value_ptr.usage.fetchAdd(1, .acquire);
return out;
}
pub fn finished(self: *DecompCache, io: Io, offset: u64) void {
const cache = self.cache.getPtr(offset);
if (cache == null) {
std.debug.print("Finished using cache, but cache does not exist: {}\n", .{offset});
return;
}
const use = cache.?.usage.fetchSub(1, .acquire);
if (use == 0)
self.cond.broadcast(io);
}
fn ensureSpace(self: *DecompCache, io: Io, size: u64) !void {
while (self.cur_mem + size > self.max_mem) {
var iter = self.cache.valueIterator();
while (iter.next()) |cache| {
if (cache.usage.load(.unordered) == 0) {
self.alloc.free(cache.data);
self.cur_mem -= cache.data.len;
if (self.cur_mem + size <= self.max_mem) return;
}
}
if (self.cur_mem + size <= self.max_mem) return;
try self.cond.wait(io, &self.mut.mutex);
}
}
// Types
const Cache = struct {
data: []u8,
usage: Atomic(u32),
};
+36 -50
View File
@@ -1,83 +1,69 @@
const std = @import("std");
const Io = std.Io;
const Reader = Io.Reader;
const Reader = std.Io.Reader;
const Inode = @import("inode.zig");
const Directory = @This();
pub const Error = error{OutOfMemory} || Reader.Error;
entries: []Entry,
const DirEntry = @This();
pub fn init(alloc: std.mem.Allocator, rdr: *Reader, size: u32) Error!Directory {
if (size <= 3) return .{ .entries = &[0]Entry{} };
block_start: u32,
block_offset: u16,
type: Inode.Type,
name: []const u8,
var entries: std.ArrayList(Entry) = try .initCapacity(alloc, 50);
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 (entries.items) |ent|
ent.deinit(alloc);
entries.deinit(alloc);
for (out.items) |ent|
alloc.free(ent.name);
out.deinit(alloc);
}
var read: u32 = 3;
while (read < size) {
var hdr: Header = undefined;
var tot_red: u32 = 3;
while (tot_red < size) {
try rdr.readSliceEndian(Header, @ptrCast(&hdr), .little);
read += @sizeOf(Header);
try out.ensureUnusedCapacity(alloc, hdr.count + 1);
tot_red += @sizeOf(Header);
try entries.ensureUnusedCapacity(alloc, hdr.count + 1);
for (0..hdr.count + 1) |_| {
var raw: RawEntry = undefined;
try rdr.readSliceEndian(RawEntry, @ptrCast(&raw), .little);
const name = try alloc.alloc(u8, raw.name_size + 1);
errdefer alloc.free(name);
try rdr.readSliceEndian(u8, name, .little);
const new_name = try alloc.alloc(u8, raw.name_size + 1);
try rdr.readSliceEndian(u8, new_name, .little);
entries.appendAssumeCapacity(.{
.inode_num = if (raw.inode_num_offset > 0)
hdr.inode_num + @abs(raw.inode_num_offset)
else
hdr.inode_num - @abs(raw.inode_num_offset),
const new = out.addOneAssumeCapacity();
new.* = .{
.block_start = hdr.block_start,
.block_offset = raw.block_offset,
.type = raw.type,
.name = name,
});
.name = new_name,
};
tot_red += @sizeOf(RawEntry) + raw.name_size + 1;
}
}
return .{ .entries = try entries.toOwnedSlice(alloc) };
}
pub fn deinit(self: Directory, alloc: std.mem.Allocator) void {
for (self.entries) |entry|
entry.deinit(alloc);
alloc.free(self.entries);
return out.toOwnedSlice(alloc);
}
// Types
pub const Error = Reader.Error || std.mem.Allocator.Error;
pub const Entry = struct {
inode_num: u32,
block_start: u32,
block_offset: u16,
type: Inode.Enum,
name: []const u8,
pub fn deinit(self: Entry, alloc: std.mem.Allocator) void {
alloc.free(self.name);
}
};
const Header = extern struct {
count: u32,
block_start: u32,
inode_num: u32,
num: u32,
};
const RawEntry = extern struct {
block_offset: u16,
inode_num_offset: i16,
type: Inode.Enum,
num_offset: i16,
type: Inode.Type,
name_size: u16,
};
-283
View File
@@ -1,283 +0,0 @@
const std = @import("std");
const Io = std.Io;
const Atomic = std.atomic.Value;
const DecompCache = @import("decomp_cache.zig");
const ExtractionOptions = @import("options.zig");
const Inode = @import("inode.zig");
const Superblock = @import("archive.zig").Superblock;
const Directory = @import("directory.zig");
const DataExtractor = @import("data/extractor.zig");
const DataReader = @import("data/reader.zig");
const Lookup = @import("lookup.zig");
pub fn extract(alloc: std.mem.Allocator, io: Io, inode: Inode, cache: *DecompCache, super: Superblock, ext_loc: []const u8, options: ExtractionOptions) !void {
const path = std.mem.trim(u8, ext_loc, "/");
var buf: [50]ReturnUnion = undefined;
var sel: Io.Select(ReturnUnion) = .init(io, &buf);
defer {
while (sel.cancel()) |ret| {
switch (ret) {
.dir_ret => |d| {
const res = d catch continue;
alloc.free(res.path);
},
.file_ret => |f| {
const res = f catch continue;
alloc.free(res.path);
},
else => {},
}
}
}
var frag_table: Lookup.Table(Lookup.FragmentEntry) = .init(alloc, cache, super.frag_start, super.frag_count);
defer frag_table.deinit();
var ret_loop = io.async(returnLoop, .{ alloc, &sel, options });
try extractReal(alloc, io, cache, super, &sel, &frag_table, path, inode, null, false);
ret_loop.await(io) catch |err| {
// TODO: Drain sel
return err;
};
}
fn extractReal(
alloc: std.mem.Allocator,
io: Io,
cache: *DecompCache,
super: Superblock,
sel: *Io.Select(ReturnUnion),
frag_table: *Lookup.Table(Lookup.FragmentEntry),
path: []const u8,
inode: Inode,
parent: ?*Atomic(usize),
origin: bool,
) Error!void {
try io.checkCancel();
switch (inode.data) {
.dir, .ext_dir => sel.async(
.dir_ret,
extractDir,
.{ alloc, io, cache, super, sel, frag_table, path, inode, parent, origin },
),
.file, .ext_file => sel.async(
.file_ret,
extractFile,
.{ alloc, io, cache, super.block_size, frag_table, path, inode, parent, origin },
),
else => return error.Canceled,
}
}
fn extractDir(
alloc: std.mem.Allocator,
io: Io,
cache: *DecompCache,
super: Superblock,
sel: *Io.Select(ReturnUnion),
frag_table: *Lookup.Table(Lookup.FragmentEntry),
path: []const u8,
inode: Inode,
parent: ?*Atomic(usize),
origin: bool,
) Error!DirReturn {
defer {
if (parent != null)
_ = parent.?.fetchSub(1, .acquire);
if (!origin) inode.deinit(alloc);
}
errdefer if (!origin) alloc.free(path);
const dir = inode.directory(alloc, io, cache, super.dir_start) catch |err| switch (err) {
error.NotDirectory => unreachable,
else => |e| return e,
};
defer dir.deinit(alloc);
const sub_files = try alloc.create(Atomic(usize));
sub_files.* = .init(dir.entries.len);
const ret: DirReturn = .{
.path = path,
.sub_files = sub_files,
.origin = origin,
.uid_idx = inode.hdr.uid_idx,
.gid_idx = inode.hdr.gid_idx,
.mod_time = inode.hdr.mod_time,
.permissions = inode.hdr.permission,
.xattr_idx = switch (inode.data) {
.ext_dir => |d| if (d.xattr_idx != 0xFFFFFFFF) d.xattr_idx else null,
else => null,
},
};
for (dir.entries) |entry| {
const new_inode: Inode = try .initDirEntry(alloc, io, cache, super.inode_start, super.block_size, entry);
errdefer new_inode.deinit(alloc);
const new_path = try std.mem.concat(alloc, u8, &.{ path, "/", entry.name });
try extractReal(
alloc,
io,
cache,
super,
sel,
frag_table,
new_path,
new_inode,
sub_files,
false,
);
}
return ret;
}
fn extractFile(
alloc: std.mem.Allocator,
io: Io,
cache: *DecompCache,
block_size: u32,
frag_table: *Lookup.Table(Lookup.FragmentEntry),
path: []const u8,
inode: Inode,
parent: ?*Atomic(usize),
origin: bool,
) Error!FileReturn {
defer {
if (parent != null)
_ = parent.?.fetchSub(1, .acquire);
if (!origin) inode.deinit(alloc);
}
errdefer if (!origin) alloc.free(path);
var atomic = try Io.Dir.cwd().createFileAtomic(io, path, .{});
defer atomic.deinit(io);
var ret: FileReturn = .{
.path = path,
.origin = origin,
.uid_idx = inode.hdr.uid_idx,
.gid_idx = inode.hdr.gid_idx,
.permissions = inode.hdr.permission,
.mod_time = inode.hdr.mod_time,
};
const data: DataExtractor = switch (inode.data) {
.file => |f| blk: {
var data: DataExtractor = .init(cache, block_size, f.size, f.data_start, f.blocks);
if (f.frag_idx != 0xFFFFFFFF) {
const entry: Lookup.FragmentEntry = try frag_table.get(io, f.frag_idx);
if (entry.size.uncompressed) {
data.addFragment(cache.map.memory[entry.start..][0..entry.size.size], f.frag_offset);
} else {
const block = try cache.get(io, entry.start, entry.size.size, block_size);
data.addFragment(block, f.frag_offset);
}
}
break :blk data;
},
.ext_file => |f| blk: {
var data: DataExtractor = .init(cache, block_size, f.size, f.data_start, f.blocks);
if (f.frag_idx != 0xFFFFFFFF) {
const entry: Lookup.FragmentEntry = try frag_table.get(io, f.frag_idx);
if (entry.size.uncompressed) {
data.addFragment(cache.map.memory[entry.start..][0..entry.size.size], f.frag_offset);
} else {
const block = try cache.get(io, entry.start, entry.size.size, block_size);
data.addFragment(block, f.frag_offset);
}
}
if (f.xattr_idx != 0xFFFFFFFF)
ret.xattr_idx = f.xattr_idx;
break :blk data;
},
else => unreachable,
};
try data.asyncExtract(io, atomic.file);
try atomic.link(io);
return ret;
}
// Loop
fn returnLoop(alloc: std.mem.Allocator, sel: *Io.Select(ReturnUnion), options: ExtractionOptions) !void {
while (true) {
const finished = try sel.await();
switch (finished) {
.dir_ret => |d| {
const ret = try d;
if (ret.sub_files.load(.unordered) != 0) {
sel.queue.putOne(sel.io, .{ .dir_ret = ret }) catch |err| {
if (!ret.origin) alloc.free(ret.path);
return err;
};
continue;
}
if (!ret.origin) alloc.free(ret.path);
alloc.destroy(ret.sub_files);
if (!options.ignore_permissions and !options.ignore_xattr) {
// TODO: set permissions & xattr.
}
},
.file_ret => |f| {
const ret = try f;
if (!ret.origin) alloc.free(ret.path);
if (!options.ignore_permissions and !options.ignore_xattr) {
// TODO: set permissions & xattr.
}
},
.void_ret => |v| try v,
}
if (sel.group.token.load(.unordered) == null) break;
}
}
// Utility types
const ReturnUnion = union(enum) {
file_ret: Error!FileReturn,
dir_ret: Error!DirReturn,
void_ret: Error!void,
};
const Error = error{Canceled} || Directory.Error || Io.Dir.CreateFileAtomicError || Io.File.Atomic.LinkError || DataExtractor.Error;
const FileReturn = struct {
path: []const u8,
origin: bool,
uid_idx: u32,
gid_idx: u32,
mod_time: u32,
permissions: u16,
xattr_idx: ?u32 = null,
};
const DirReturn = struct {
path: []const u8,
sub_files: *Atomic(usize),
origin: bool,
uid_idx: u32,
gid_idx: u32,
mod_time: u32,
permissions: u16,
xattr_idx: ?u32 = null,
};
+60 -67
View File
@@ -1,102 +1,95 @@
//! An easier to use wrapper around an inode.
const std = @import("std");
const Io = std.Io;
const Archive = @import("archive.zig");
const Directory = @import("directory.zig");
const DirEntry = @import("directory.zig");
const ExtractionOptions = @import("options.zig");
const Inode = @import("inode.zig");
const DataExtractor = @import("util/data_extractor.zig");
const Decompressor = @import("util/decompressor.zig");
const MetadataReader = @import("util/metadata.zig");
const SharedCache = @import("util/shared_cache.zig");
const SfsFile = @This();
const File = @This();
alloc: std.mem.Allocator,
archive: *Archive,
archive: Archive,
inode: Inode,
name: []const u8,
/// The given allocator must have been used to create the Inode and name.
pub fn init(alloc: std.mem.Allocator, archive: *Archive, inode: Inode, name: []const u8) SfsFile {
/// 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 .{
.alloc = alloc,
.archive = archive,
.inode = inode,
.name = name,
};
}
pub fn initDirEntry(alloc: std.mem.Allocator, io: Io, archive: *Archive, entry: Directory.Entry) !SfsFile {
const new_name = try alloc.alloc(u8, entry.name.len);
defer alloc.free(new_name);
@memcpy(new_name, entry.name);
return .{
.alloc = alloc,
.archive = archive,
.inode = try .initDirEntry(
alloc,
io,
&archive.cache,
archive.super.inode_start,
archive.super.block_size,
entry,
),
.inode = in,
.name = new_name,
};
}
/// Creates a new copy of the given SfsFile using the given allocator
pub fn copy(self: SfsFile, alloc: std.mem.Allocator) !SfsFile {
const new_name = try alloc(u8, self.name.len);
errdefer alloc.free(new_name);
pub fn fromDirEntry(alloc: std.mem.Allocator, io: Io, archive: Archive, ent: DirEntry) !File {
var rdr = try archive.file.readerAt(io, archive.super.inode_start + ent.block_start, &[0]u8{});
var meta: MetadataReader = .init(alloc, &rdr.interface, &archive.stateless_decomp);
try meta.interface.discardAll(ent.block_offset);
return .{
.alloc = alloc,
.archive = self.archive,
.inode = try self.inode.copy(alloc),
.name = new_name,
};
var in: Inode = try .read(alloc, &meta.interface, archive.super.block_size);
errdefer in.deinit(alloc);
return .init(alloc, archive, in, ent.name);
}
pub fn deinit(self: SfsFile) void {
self.inode.deinit(self.alloc);
pub fn deinit(self: File) void {
self.alloc.free(self.name);
self.inode.deinit(self.alloc);
}
/// Attempts to open the filepath if the SfsFile is a directory.
/// If the given path refers to itself (such as "" or "."), a copied SfsFile is returned.
pub fn open(self: SfsFile, alloc: std.mem.Allocator, io: Io, filepath: []const u8) !SfsFile {
pub fn open(self: File, alloc: std.mem.Allocator, io: Io, filepath: []const u8) !File {
const entries = try self.inode.readDirectory(
alloc,
io,
self.archive.file,
&self.archive.stateless_decomp,
self.archive.super.dir_start,
);
defer {
for (entries) |ent|
alloc.free(ent.name);
alloc.free(entries);
}
const path = std.mem.trim(u8, filepath, "/");
const first_element: []const u8 = std.mem.sliceTo(path, '/');
const dir: Directory = try self.inode.directory(alloc, io, &self.archive.cache, self.archive.super.dir_start);
defer dir.deinit(alloc);
var cur_slice = dir.entries;
var search_slice = entries;
var idx: usize = undefined;
while (cur_slice.len > 0) {
idx = cur_slice.len / 2;
switch (std.mem.order(u8, first_element, cur_slice[idx].name)) {
while (search_slice.len > 0) {
idx = search_slice.len / 2;
const middle = search_slice[idx];
switch (std.mem.order(u8, first_element, middle.name)) {
.eq => break,
.lt => cur_slice = cur_slice[0..idx],
.gt => cur_slice = cur_slice[idx..],
.lt => search_slice = search_slice[0..idx],
.gt => search_slice = search_slice[idx + 1 ..],
}
} else {
return error.NotFound;
}
if (first_element.len == path.len) return .initDirEntry(alloc, io, self.archive, cur_slice[idx]);
if (cur_slice[idx].type != .dir) return error.NotFound;
const tmp_file: SfsFile = try .initDirEntry(alloc, io, self.archive, cur_slice[idx]);
defer tmp_file.deinit();
} else return Error.FileNotFound;
return tmp_file.open(alloc, io, path[first_element.len..]);
const first_elem_file = try fromDirEntry(alloc, io, self.archive, search_slice[idx]);
if (first_element.len == path.len)
return first_elem_file;
defer first_elem_file.deinit();
return first_elem_file.open(alloc, io, path[first_element.len + 1 ..]);
}
pub fn extract(self: SfsFile, alloc: std.mem.Allocator, io: Io, ext_dir: []const u8, options: ExtractionOptions) !void {
_ = self;
_ = alloc;
_ = io;
_ = ext_dir;
_ = options;
return error.TODO;
pub fn extract(self: File, alloc: std.mem.Allocator, io: Io, filepath: []const u8, options: ExtractionOptions) !void {
return self.inode.extract(alloc, io, self.archive.file, self.archive.super, filepath, options);
}
// Types
pub const Error = error{
FileNotFound,
} || Inode.Error;
+7
View File
@@ -0,0 +1,7 @@
const BlockSize = @import("inode_data/file.zig").BlockSize;
pub const FragEntry = extern struct {
start: u64,
size: BlockSize,
_: u32,
};
+429 -315
View File
@@ -1,118 +1,168 @@
const std = @import("std");
const Io = std.Io;
const Reader = Io.Reader;
//! A file-system object. Represents a File or directory.
const DecompCache = @import("decomp_cache.zig");
const Directory = @import("directory.zig");
const MetadataReader = @import("meta_rdr.zig");
const std = @import("std");
const Reader = std.Io.Reader;
const Io = std.Io;
const Archive = @import("archive.zig");
const Decomp = @import("decomp.zig").Decomp;
const DirEntry = @import("directory.zig");
const ExtractionOptions = @import("options.zig");
const FragEntry = @import("frag.zig").FragEntry;
const dir = @import("inode_data/dir.zig");
const file = @import("inode_data/file.zig");
const misc = @import("inode_data/misc.zig");
const LookupTable = @import("lookup_table.zig");
const CachedTable = LookupTable.CachedTable;
const DataExtractor = @import("util/data_extractor.zig");
const DataReader = @import("util/data_reader.zig");
const Decompressor = @import("util/decompressor.zig");
const MetadataReader = @import("util/metadata.zig");
const OffsetFile = @import("util/offset_file.zig");
const SharedCache = @import("util/shared_cache.zig");
const XattrTable = @import("xattr_table.zig");
const Inode = @This();
hdr: Header,
data: Data,
/// Read an inode given an inode Ref.
pub fn initRef(alloc: std.mem.Allocator, io: Io, cache: *DecompCache, inode_start: u64, block_size: u32, ref: Ref) !Inode {
var meta: MetadataReader = .init(io, cache, inode_start + ref.block_start);
defer meta.deinit(io);
try meta.interface.discardAll(ref.block_offset);
return .init(alloc, &meta.interface, block_size);
}
pub fn initDirEntry(alloc: std.mem.Allocator, io: Io, cache: *DecompCache, inode_start: u64, block_size: u32, entry: Directory.Entry) !Inode {
var meta: MetadataReader = .init(io, cache, inode_start + entry.block_start);
defer meta.deinit(io);
try meta.interface.discardAll(entry.block_offset);
return .init(alloc, &meta.interface, block_size);
}
/// Read the inode from the given Reader.
pub fn init(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !Inode {
pub fn read(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !Inode {
var hdr: Header = undefined;
try rdr.readSliceEndian(Header, @ptrCast(&hdr), .little);
const data: Data = switch (hdr.type) {
.dir => .{ .dir = try .init(rdr) },
.file => .{ .file = try .init(alloc, rdr, block_size) },
.symlink => .{ .symlink = try .init(alloc, rdr) },
.block_dev => .{ .block_dev = try .init(rdr) },
.char_dev => .{ .char_dev = try .init(rdr) },
.fifo => .{ .fifo = try .init(rdr) },
.socket => .{ .socket = try .init(rdr) },
.ext_dir => .{ .ext_dir = try .init(rdr) },
.ext_file => .{ .ext_file = try .init(alloc, rdr, block_size) },
.ext_symlink => .{ .ext_symlink = try .init(alloc, rdr) },
.ext_block_dev => .{ .ext_block_dev = try .init(rdr) },
.ext_char_dev => .{ .ext_char_dev = try .init(rdr) },
.ext_fifo => .{ .ext_fifo = try .init(rdr) },
.ext_socket => .{ .ext_socket = try .init(rdr) },
};
return .{
.hdr = hdr,
.data = data,
.data = switch (hdr.inode_type) {
.dir => .{ .dir = try .read(rdr) },
.file => .{ .file = try .read(alloc, rdr, block_size) },
.symlink => .{ .symlink = try .read(alloc, rdr) },
.block_dev => .{ .block_dev = try .read(rdr) },
.char_dev => .{ .char_dev = try .read(rdr) },
.fifo => .{ .fifo = try .read(rdr) },
.socket => .{ .socket = try .read(rdr) },
.ext_dir => .{ .ext_dir = try .read(rdr) },
.ext_file => .{ .ext_file = try .read(alloc, rdr, block_size) },
.ext_symlink => .{ .ext_symlink = try .read(alloc, rdr) },
.ext_block_dev => .{ .ext_block_dev = try .read(rdr) },
.ext_char_dev => .{ .ext_char_dev = try .read(rdr) },
.ext_fifo => .{ .ext_fifo = try .read(rdr) },
.ext_socket => .{ .ext_socket = try .read(rdr) },
},
};
}
pub fn copy(self: Inode, alloc: std.mem.Allocator) !Inode {
var new_inode = self;
switch (new_inode.data) {
.file => |*f| {
if (f.blocks.len > 0) {
f.blocks = try alloc.alloc(DataBlock, f.blocks.len);
@memcpy(f.blocks, self.data.file.blocks);
}
},
.ext_file => |*f| {
if (f.blocks.len > 0) {
f.blocks = try alloc.alloc(DataBlock, f.blocks.len);
@memcpy(f.blocks, self.data.ext_file.blocks);
}
},
.symlink => |*s| {
s.target = try alloc.alloc(u8, s.target.len);
@memcpy(s.target, self.data.symlink.target);
},
.ext_symlink => |*s| {
s.target = try alloc.alloc(u8, s.target.len);
@memcpy(s.target, self.data.ext_symlink.target);
},
}
return new_inode;
}
pub fn deinit(self: Inode, alloc: std.mem.Allocator) void {
switch (self.data) {
.file => |f| f.deinit(alloc),
.ext_file => |f| f.deinit(alloc),
.symlink => |s| s.deinit(alloc),
.ext_symlink => |s| s.deinit(alloc),
.file => |d| d.deinit(alloc),
.symlink => |d| d.deinit(alloc),
.ext_file => |d| d.deinit(alloc),
.ext_symlink => |d| d.deinit(alloc),
else => {},
}
}
// Utility functions
// Utility Functions
pub fn directory(self: Inode, alloc: std.mem.Allocator, io: Io, cache: *DecompCache, dir_start: u64) !Directory {
/// Read the directory entries
pub fn readDirectory(self: Inode, alloc: std.mem.Allocator, io: Io, fil: OffsetFile, decomp: *const Decompressor, dir_offset: u64) ![]DirEntry {
return switch (self.data) {
.dir => |d| readDirectory(alloc, io, cache, dir_start, d),
.ext_dir => |d| readDirectory(alloc, io, cache, dir_start, d),
else => error.NotDirectory,
.dir => |d| readDirFromData(alloc, io, fil, decomp, dir_offset, d),
.ext_dir => |d| readDirFromData(alloc, io, fil, decomp, dir_offset, d),
else => Error.NotDirectory,
};
}
fn readDirectory(alloc: std.mem.Allocator, io: Io, cache: *DecompCache, dir_start: u64, d: anytype) !Directory {
var meta: MetadataReader = .init(io, cache, dir_start + d.block_start);
defer meta.deinit(io);
fn readDirFromData(alloc: std.mem.Allocator, io: Io, fil: OffsetFile, decomp: *const Decompressor, dir_offset: u64, d: anytype) ![]DirEntry {
var rdr = try fil.readerAt(io, dir_offset + d.block_start, &[0]u8{});
var meta: MetadataReader = .init(alloc, &rdr.interface, decomp);
try meta.interface.discardAll(d.block_offset);
return .init(alloc, &meta.interface, d.size);
return DirEntry.readDirectory(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, cache: *SharedCache, decomp: *const Decompressor, block_size: u32) !DataReader {
return switch (self.data) {
.file => |f| getReaderFromData(alloc, io, fil, cache, decomp, block_size, f),
.ext_file => |f| getReaderFromData(alloc, io, fil, cache, decomp, block_size, f),
else => Error.NotRegularFile,
};
}
fn getReaderFromData(alloc: std.mem.Allocator, io: Io, fil: OffsetFile, cache: *SharedCache, decomp: *const Decompressor, block_size: u32, d: anytype) !DataReader {
const ext: DataReader = .init(alloc, io, fil, cache, decomp, block_size, d.size, d.block_start, d.blocks);
if (d.frag_block_offset == 0xFFFFFFFF) {
// TODO:
return error.TODO;
}
return ext;
}
/// Get an extractor for a regular file's data.
pub fn dataExtractor(self: Inode, fil: OffsetFile, cache: *SharedCache, decomp: *const Decompressor, block_size: u32) !DataExtractor {
return switch (self.data) {
.file => |f| getExtractorFromData(fil, cache, decomp, block_size, f),
.ext_file => |f| getExtractorFromData(fil, cache, decomp, block_size, f),
else => Error.NotRegularFile,
};
}
fn getExtractorFromData(fil: OffsetFile, cache: *SharedCache, decomp: *const Decompressor, block_size: u32, d: anytype) !DataExtractor {
const ext: DataExtractor = .init(fil, cache, decomp, block_size, d.size, d.block_start, d.blocks);
if (d.frag_block_offset == 0xFFFFFFFF) {
// TODO:
return error.TODO;
}
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: *const 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: *const 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 => 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: *const 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
pub const Error = error{
NotDirectory,
NotRegularFile,
NotSymlink,
NotExtended,
};
pub const Ref = packed struct(u64) {
block_offset: u16,
block_start: u32,
_: u16,
_: u16 = 0,
};
pub const Enum = enum(u16) {
pub const Type = enum(u16) {
dir = 1,
file,
symlink,
@@ -129,270 +179,334 @@ pub const Enum = enum(u16) {
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 {
type: Enum,
permission: u16,
inode_type: Type,
permissions: u16,
uid_idx: u16,
gid_idx: u16,
mod_time: u32,
num: u32,
};
pub const Data = union(Enum) {
dir: Dir,
file: File,
symlink: Symlink,
block_dev: Device,
char_dev: Device,
fifo: IPC,
socket: IPC,
ext_dir: ExtDir,
ext_file: ExtFile,
ext_symlink: ExtSymlink,
ext_block_dev: ExtDevice,
ext_char_dev: ExtDevice,
ext_fifo: ExtIPC,
ext_socket: ExtIPC,
// Extract
const ExtractError = error{ MknodFailed, CannotSetXattr, ConcurrencyUnavailable } || DataExtractor.Error || Io.Dir.CreateFileAtomicError || LookupTable.Error ||
Io.File.Reader.SeekError || Io.File.Atomic.LinkError || Io.Dir.CreateDirError || Io.File.OpenError ||
Io.File.SetPermissionsError || Io.File.SetOwnerError || Io.Dir.SymLinkError || Io.Dir.CreateDirPathError;
const PathRet = struct {
path: []const u8,
inode: Inode,
xattr_idx: ?u32 = null,
};
const ExtractReturnUnion = union(enum) {
path_ret: ExtractError!PathRet,
};
const Tables = struct {
id: LookupTable.CachedTable(u16),
frag: LookupTable.CachedTable(FragEntry),
xattr: XattrTable,
};
pub const DataBlock = packed struct(u32) {
size: u24,
uncompressed: bool,
_: u7,
};
/// 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(
self: Inode,
alloc: std.mem.Allocator,
io: Io,
fil: OffsetFile,
super: Archive.Superblock,
filepath: []const u8,
options: ExtractionOptions,
) !void {
const path = std.mem.trimEnd(u8, filepath, "/");
const Dir = extern struct {
block_start: u32,
hard_links: u32,
size: u16,
block_offset: u16,
parent: u32,
const Self = @This();
fn init(rdr: *Reader) !Self {
var dir: Self = undefined;
try rdr.readSliceEndian(Self, @ptrCast(&dir), .little);
return dir;
}
};
const ExtDir = extern struct {
hard_links: u32,
size: u32,
block_start: u32,
parent: u32,
idx_count: u16,
block_offset: u16,
xattr_idx: u32,
// []DirIndex
const Self = @This();
fn init(rdr: *Reader) !Self {
var dir: Self = undefined;
try rdr.readSliceEndian(Self, @ptrCast(&dir), .little);
return dir;
}
};
const File = struct {
data_start: u32,
frag_idx: u32,
frag_offset: u32,
size: u32,
blocks: []DataBlock,
const Raw = extern struct {
data_start: u32,
frag_idx: u32,
frag_offset: u32,
size: u32,
var decomp_base: Decomp = switch (super.compression) {
.gzip => .{ .gzip = try .init(alloc, super.block_size) },
.lzma => .{ .lzma = try .init(alloc, super.block_size) },
.xz => .{ .xz = try .init(alloc, super.block_size) },
.zstd => .{ .zstd = try .init(alloc, io, super.block_size) },
else => unreachable,
};
defer decomp_base.deinit();
const decomp = decomp_base.decompressor();
const Self = @This();
var frag_table: CachedTable(FragEntry) = .init(alloc, fil, decomp, super.frag_start, super.frag_count);
defer if (!options.ignore_permissions) frag_table.deinit(io);
try frag_table.fill(io);
pub fn init(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !Self {
var raw: Raw = undefined;
try rdr.readSliceEndian(Raw, @ptrCast(&raw), .little);
var arena: std.heap.ArenaAllocator = .init(alloc);
defer arena.deinit();
var blocks_num = raw.size / block_size;
if (raw.frag_idx == 0xFFFFFFFF and raw.size % block_size > 0)
blocks_num += 1;
var sel_buf = [1]ExtractReturnUnion{undefined} ** 10;
var sel: Io.Select(ExtractReturnUnion) = .init(io, &sel_buf);
defer sel.cancelDiscard();
const blocks: []DataBlock = try alloc.alloc(DataBlock, blocks_num);
errdefer alloc.free(blocks);
switch (self.hdr.inode_type) {
.dir, .ext_dir => try sel.concurrent(
.path_ret,
extractDir,
.{ self, alloc, io, fil, decomp, &sel, &arena, super.dir_start, super.inode_start, &frag_table, super.block_size, path },
),
.file, .ext_file => try sel.concurrent(
.path_ret,
extractFile,
.{ self, alloc, io, fil, decomp, &frag_table, super.block_size, path },
),
.symlink, .ext_symlink => try sel.concurrent(.path_ret, extractSymlink, .{ self, io, path }),
else => if (@hasField(std.os, "linux"))
try sel.concurrent(.path_ret, extractDevOrIPC, .{ self, alloc, path }),
}
try rdr.readSliceEndian(DataBlock, blocks, .little);
return .{
.data_start = raw.data_start,
.frag_idx = raw.frag_idx,
.frag_offset = raw.frag_offset,
.size = raw.size,
.blocks = blocks,
var xattr_table: ?XattrTable = if (!options.ignore_xattr)
try .init(alloc, io, fil, decomp, super.xattr_start)
else
null;
defer if (!options.ignore_xattr) xattr_table.?.deinit(io);
if (xattr_table != null) try xattr_table.?.table.fill(io);
var id_table: ?CachedTable(u16) = if (!options.ignore_xattr)
.init(alloc, fil, decomp, super.id_start, super.id_count)
else
null;
defer if (!options.ignore_xattr) id_table.?.deinit(io);
if (id_table != null) try id_table.?.fill(io);
while (true) {
const group_token = sel.group.token.load(.acquire);
if (group_token == null) break;
// std.debug.print("{any}\n", .{sel.group.state});
// std.debug.print("Waiting for return...", .{});
const ret = try sel.await();
// std.debug.print("Got One...\n", .{});
const path_ret = try ret.path_ret;
if (options.ignore_permissions and options.ignore_xattr) continue;
if (options.ignore_permissions and path_ret.xattr_idx == null) continue;
var ret_file = try Io.Dir.cwd().openFile(io, path_ret.path, .{});
defer ret_file.close(io);
if (!options.ignore_permissions) {
try ret_file.setPermissions(io, @enumFromInt(path_ret.inode.hdr.permissions));
try ret_file.setOwner(
io,
try id_table.?.get(io, path_ret.inode.hdr.uid_idx),
try id_table.?.get(io, path_ret.inode.hdr.gid_idx),
);
}
if (@hasField(std.os, "linux") and !options.ignore_xattr and path_ret.xattr_idx != null) {
const xattrs = try xattr_table.?.get(alloc, io, path_ret.xattr_idx.?);
defer {
for (xattrs) |x|
alloc.free(x.key);
alloc.free(xattrs);
}
for (xattrs) |x| {
const res = std.os.linux.fsetxattr(ret_file.handle, x.key, x.value.ptr, x.value.len, 0);
if (res != 0)
return error.CannotSetXattr;
}
}
}
}
fn extractDir(
self: Inode,
alloc: std.mem.Allocator,
io: Io,
fil: OffsetFile,
decomp: *const Decompressor,
parent_select: *Io.Select(ExtractReturnUnion),
arena: *std.heap.ArenaAllocator,
dir_start: u64,
inode_start: u64,
frag: *CachedTable(FragEntry),
block_size: u32,
path: []const u8,
) ExtractError!PathRet {
try Io.Dir.cwd().createDirPath(io, path);
var sel_buf = [1]ExtractReturnUnion{undefined} ** 10;
var sel: Io.Select(ExtractReturnUnion) = .init(io, &sel_buf);
defer sel.cancelDiscard();
var num: usize = 0;
{
const dir_entries = self.readDirectory(alloc, io, fil, decomp, dir_start) catch |err| switch (err) {
Error.NotDirectory => unreachable,
else => return @errorCast(err),
};
num = dir_entries.len;
defer {
for (dir_entries) |d|
d.deinit(alloc);
alloc.free(dir_entries);
}
for (dir_entries) |d| {
var rdr = try fil.readerAt(io, d.block_start + inode_start, &[0]u8{});
var meta_rdr: MetadataReader = .init(alloc, &rdr.interface, decomp);
try meta_rdr.interface.discardAll(d.block_offset);
const inode = try read(arena.allocator(), &meta_rdr.interface, block_size);
errdefer inode.deinit(arena.allocator());
const new_path = try std.mem.concat(arena.allocator(), u8, &[_][]const u8{ path, "/", d.name });
errdefer arena.allocator().free(new_path);
switch (d.type) {
.dir => try sel.concurrent(
.path_ret,
extractDir,
.{ inode, alloc, io, fil, decomp, parent_select, arena, dir_start, inode_start, frag, block_size, new_path },
),
.file => try sel.concurrent(
.path_ret,
extractFile,
.{ inode, alloc, io, fil, decomp, frag, block_size, new_path },
),
.symlink => try sel.concurrent(.path_ret, extractSymlink, .{ inode, io, new_path }),
else => try sel.concurrent(.path_ret, extractDevOrIPC, .{ inode, alloc, new_path }),
}
}
}
while (num > 0) {
const ret = sel.await() catch break;
num -= 1;
parent_select.queue.putOne(io, ret) catch |err| switch (err) {
error.Canceled => return error.Canceled,
else => break,
};
}
pub fn deinit(self: File, alloc: std.mem.Allocator) void {
alloc.free(self.blocks);
}
};
const ExtFile = struct {
data_start: u64,
size: u64,
sparse: u64,
hard_links: u32,
frag_idx: u32,
frag_offset: u32,
xattr_idx: u32,
blocks: []DataBlock,
return .{
.path = path,
.inode = self,
};
}
fn extractFile(
self: Inode,
alloc: std.mem.Allocator,
io: Io,
fil: OffsetFile,
decomp: *const Decompressor,
frag: *CachedTable(FragEntry),
block_size: u32,
path: []const u8,
) ExtractError!PathRet {
var atomic = try Io.Dir.cwd().createFileAtomic(io, path, .{});
defer atomic.deinit(io);
const Raw = extern struct {
data_start: u64,
size: u64,
sparse: u64,
hard_links: u32,
frag_idx: u32,
frag_offset: u32,
xattr_idx: u32,
var ret: PathRet = .{
.inode = self,
.path = path,
};
const data: DataExtractor = blk: {
switch (self.data) {
.file => |f| {
var data: DataExtractor = .init(fil, decomp, block_size, f.size, f.block_start, f.block_sizes);
if (f.frag_idx != 0xFFFFFFFF)
data.addFrag(f.frag_block_offset, try frag.get(io, f.frag_idx));
break :blk data;
},
.ext_file => |f| {
if (f.xattr_idx != 0xFFFFFFFF) ret.xattr_idx = f.xattr_idx;
var data: DataExtractor = .init(fil, decomp, block_size, f.size, f.block_start, f.block_sizes);
if (f.frag_idx != 0xFFFFFFFF)
data.addFrag(f.frag_block_offset, try frag.get(io, f.frag_idx));
break :blk data;
},
else => unreachable,
}
};
const Self = @This();
try data.extractAsync(alloc, io, atomic.file);
try atomic.link(io);
pub fn init(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !Self {
var raw: Raw = undefined;
try rdr.readSliceEndian(Raw, @ptrCast(&raw), .little);
var blocks_num = raw.size / block_size;
if (raw.frag_idx == 0xFFFFFFFF and raw.size % block_size > 0)
blocks_num += 1;
const blocks: []DataBlock = try alloc.alloc(DataBlock, blocks_num);
errdefer alloc.free(blocks);
try rdr.readSliceEndian(DataBlock, blocks, .little);
return .{
.data_start = raw.data_start,
.size = raw.size,
.sparse = raw.sparse,
.hard_links = raw.hard_links,
.frag_idx = raw.frag_idx,
.frag_offset = raw.frag_offset,
.xattr_idx = raw.xattr_idx,
.blocks = blocks,
};
}
pub fn deinit(self: ExtFile, alloc: std.mem.Allocator) void {
alloc.free(self.blocks);
}
};
const Symlink = struct {
hard_links: u32,
target: []const u8,
const Raw = extern struct {
hard_links: u32,
target_size: u32,
return ret;
}
fn extractSymlink(self: Inode, io: Io, path: []const u8) ExtractError!PathRet {
const target = switch (self.data) {
.symlink => |s| s.target,
.ext_symlink => |s| s.target,
else => unreachable,
};
const Self = @This();
try Io.Dir.cwd().symLink(io, target, path, .{});
pub fn init(alloc: std.mem.Allocator, rdr: *Reader) !Self {
var raw: Raw = undefined;
try rdr.readSliceEndian(Raw, @ptrCast(&raw), .little);
return .{
.path = path,
.inode = self,
};
}
fn extractDevOrIPC(self: Inode, alloc: std.mem.Allocator, path: []const u8) ExtractError!PathRet {
var dev_num: u32 = 0;
var mode: u32 = 0;
const target = try alloc.alloc(u8, raw.target_size);
try rdr.readSliceEndian(u8, target, .little);
const DT = std.posix.DT;
return .{
.hard_links = raw.hard_links,
.target = target,
};
}
pub fn deinit(self: Symlink, alloc: std.mem.Allocator) void {
alloc.free(self.target);
}
};
const ExtSymlink = struct {
hard_links: u32,
xattr_idx: u32,
target: []const u8,
const Raw = extern struct {
hard_links: u32,
target_size: u32,
var ret: PathRet = .{
.inode = self,
.path = path,
};
const Self = @This();
pub fn init(alloc: std.mem.Allocator, rdr: *Reader) !Self {
var raw: Raw = undefined;
try rdr.readSliceEndian(Raw, @ptrCast(&raw), .little);
const target = try alloc.alloc(u8, raw.target_size);
errdefer alloc.free(target);
try rdr.readSliceEndian(u8, target, .little);
var xattr_idx: u32 = undefined;
try rdr.readSliceEndian(u32, @ptrCast(&xattr_idx), .little);
return .{
.hard_links = raw.hard_links,
.target = target,
.xattr_idx = xattr_idx,
};
switch (self.data) {
.block_dev => |d| {
dev_num = d.dev;
mode = DT.BLK;
},
.ext_block_dev => |d| {
dev_num = d.dev;
mode = DT.BLK;
if (d.xattr_idx != 0xFFFFFFFF) ret.xattr_idx = d.xattr_idx;
},
.char_dev => |d| {
dev_num = d.dev;
mode = DT.CHR;
},
.ext_char_dev => |d| {
dev_num = d.dev;
mode = DT.CHR;
if (d.xattr_idx != 0xFFFFFFFF) ret.xattr_idx = d.xattr_idx;
},
.fifo => mode = DT.FIFO,
.ext_fifo => |f| {
mode = DT.FIFO;
if (f.xattr_idx != 0xFFFFFFFF) ret.xattr_idx = f.xattr_idx;
},
.socket => mode = DT.SOCK,
.ext_socket => |s| {
mode = DT.SOCK;
if (s.xattr_idx != 0xFFFFFFFF) ret.xattr_idx = s.xattr_idx;
},
else => unreachable,
}
pub fn deinit(self: ExtSymlink, alloc: std.mem.Allocator) void {
alloc.free(self.target);
}
};
const sentinel_path = try std.mem.concatWithSentinel(alloc, u8, &[_][]const u8{path}, 0);
defer alloc.free(sentinel_path);
const Device = extern struct {
hard_links: u32,
device: u32,
const res = std.os.linux.mknod(sentinel_path, mode, dev_num);
if (res != 0) return ExtractError.MknodFailed;
const Self = @This();
fn init(rdr: *Reader) !Self {
var dir: Self = undefined;
try rdr.readSliceEndian(Self, @ptrCast(&dir), .little);
return dir;
}
};
const ExtDevice = extern struct {
hard_links: u32,
device: u32,
xattr_idx: u32,
const Self = @This();
fn init(rdr: *Reader) !Self {
var dir: Self = undefined;
try rdr.readSliceEndian(Self, @ptrCast(&dir), .little);
return dir;
}
};
const IPC = extern struct {
hard_links: u32,
const Self = @This();
fn init(rdr: *Reader) !Self {
var dir: Self = undefined;
try rdr.readSliceEndian(Self, @ptrCast(&dir), .little);
return dir;
}
};
const ExtIPC = extern struct {
hard_links: u32,
xattr_idx: u32,
const Self = @This();
fn init(rdr: *Reader) !Self {
var dir: Self = undefined;
try rdr.readSliceEndian(Self, @ptrCast(&dir), .little);
return dir;
}
};
return ret;
}
+32
View File
@@ -0,0 +1,32 @@
const Reader = @import("std").Io.Reader;
pub const Dir = extern struct {
block_start: u32,
hard_links: u32,
size: u16,
block_offset: u16,
parent_num: u32,
pub fn read(rdr: *Reader) !Dir {
var d: Dir = undefined;
try rdr.readSliceEndian(Dir, @ptrCast(&d), .little);
return d;
}
};
pub const ExtDir = extern struct {
hard_links: u32,
size: u32,
block_start: u32,
parent_num: u32,
idx_count: u16,
block_offset: u16,
xattr_idx: u32,
// index: []DirIndex
pub fn read(rdr: *Reader) !ExtDir {
var d: ExtDir = undefined;
try rdr.readSliceEndian(ExtDir, @ptrCast(&d), .little);
return d;
}
};
+97
View File
@@ -0,0 +1,97 @@
const std = @import("std");
const Reader = std.Io.Reader;
pub const BlockSize = packed struct(u32) {
size: u24,
uncompressed: bool,
_: u7,
};
const FileRawRead = extern struct {
block_start: u32,
frag_idx: u32,
frag_block_offset: u32,
size: u32,
};
pub const File = struct {
block_start: u32,
frag_idx: u32,
frag_block_offset: u32,
size: u32,
block_sizes: []BlockSize,
pub fn read(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !File {
var raw: FileRawRead = undefined;
try rdr.readSliceEndian(FileRawRead, @ptrCast(&raw), .little);
var num_blocks: u32 = raw.size / block_size;
if (raw.size % block_size != 0 and raw.frag_idx == 0xFFFFFFFF)
num_blocks += 1;
const sizes = try alloc.alloc(BlockSize, num_blocks);
errdefer alloc.free(sizes);
try rdr.readSliceEndian(BlockSize, sizes, .little);
return .{
.block_start = raw.block_start,
.frag_idx = raw.frag_idx,
.frag_block_offset = raw.frag_block_offset,
.size = raw.size,
.block_sizes = sizes,
};
}
pub fn deinit(self: File, alloc: std.mem.Allocator) void {
alloc.free(self.block_sizes);
}
};
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 {
block_start: u64,
size: u64,
sparse: u64,
hard_links: u32,
frag_idx: u32,
frag_block_offset: u32,
xattr_idx: u32,
block_sizes: []BlockSize,
pub fn read(alloc: std.mem.Allocator, rdr: *Reader, block_size: u32) !ExtFile {
var raw: ExtFileRawRead = undefined;
try rdr.readSliceEndian(ExtFileRawRead, @ptrCast(&raw), .little);
var num_blocks: u32 = @truncate(raw.size / block_size);
if (raw.size % block_size != 0 and raw.frag_idx == 0xFFFFFFFF)
num_blocks += 1;
const sizes = try alloc.alloc(BlockSize, num_blocks);
errdefer alloc.free(sizes);
try rdr.readSliceEndian(BlockSize, sizes, .little);
return .{
.block_start = raw.block_start,
.size = raw.size,
.sparse = raw.sparse,
.hard_links = raw.hard_links,
.frag_idx = raw.frag_idx,
.frag_block_offset = raw.frag_block_offset,
.xattr_idx = raw.xattr_idx,
.block_sizes = sizes,
};
}
pub fn deinit(self: ExtFile, alloc: std.mem.Allocator) void {
alloc.free(self.block_sizes);
}
};
+98
View File
@@ -0,0 +1,98 @@
const std = @import("std");
const Reader = std.Io.Reader;
pub const Symlink = struct {
hard_links: u32,
target: []const u8,
pub fn read(alloc: std.mem.Allocator, rdr: *Reader) !Symlink {
var start: [8]u8 = undefined;
try rdr.readSliceAll(&start);
const target_size = std.mem.readInt(u32, start[4..8], .little);
const target = try alloc.alloc(u8, target_size + 1);
errdefer alloc.free(target);
try rdr.readSliceEndian(u8, target, .little);
return .{
.hard_links = std.mem.readInt(u32, start[0..4], .little),
.target = target,
};
}
pub fn deinit(self: Symlink, alloc: std.mem.Allocator) void {
alloc.free(self.target);
}
};
pub const ExtSymlink = struct {
hard_links: u32,
target: []const u8,
xattr_idx: u32,
pub fn read(alloc: std.mem.Allocator, rdr: *Reader) !ExtSymlink {
var start: [8]u8 = undefined;
try rdr.readSliceAll(&start);
const target_size = std.mem.readInt(u32, start[4..8], .little);
const target = try alloc.alloc(u8, target_size + 1);
errdefer alloc.free(target);
try rdr.readSliceEndian(u8, target, .little);
var xattr_idx: u32 = undefined;
try rdr.readSliceEndian(u32, @ptrCast(&xattr_idx), .little);
return .{
.hard_links = std.mem.readInt(u32, start[0..4], .little),
.target = target,
.xattr_idx = xattr_idx,
};
}
pub fn deinit(self: ExtSymlink, alloc: std.mem.Allocator) void {
alloc.free(self.target);
}
};
/// A block or character device.
pub const Dev = extern struct {
hard_links: u32,
dev: u32,
pub fn read(rdr: *Reader) !Dev {
var d: Dev = undefined;
try rdr.readSliceEndian(Dev, @ptrCast(&d), .little);
return d;
}
};
/// An extended block or character device.
pub const ExtDev = extern struct {
hard_links: u32,
dev: u32,
xattr_idx: u32,
pub fn read(rdr: *Reader) !ExtDev {
var d: ExtDev = undefined;
try rdr.readSliceEndian(ExtDev, @ptrCast(&d), .little);
return d;
}
};
/// A socket or FIFO file.
pub const IPC = extern struct {
hard_links: u32,
pub fn read(rdr: *Reader) !IPC {
var d: IPC = undefined;
try rdr.readSliceEndian(IPC, @ptrCast(&d), .little);
return d;
}
};
/// An extended socket or FIFO file.
pub const ExtIPC = extern struct {
hard_links: u32,
xattr_idx: u32,
pub fn read(rdr: *Reader) !ExtIPC {
var d: ExtIPC = undefined;
try rdr.readSliceEndian(ExtIPC, @ptrCast(&d), .little);
return d;
}
};
-114
View File
@@ -1,114 +0,0 @@
const std = @import("std");
const Io = std.Io;
const DataBlock = @import("inode.zig").DataBlock;
const InodeRef = @import("inode.zig").Ref;
const DecompCache = @import("decomp_cache.zig");
const MetadataReader = @import("meta_rdr.zig");
pub fn stateless(comptime T: anytype, io: Io, cache: *DecompCache, table_start: u64, idx: u32) !T {
const PER_BLOCK = 8192 / @sizeOf(T);
const block = idx / PER_BLOCK;
const block_idx = idx % PER_BLOCK;
const offset_offset = table_start + (block * 8);
const offset: u64 = std.mem.readInt(u64, cache.map.memory[offset_offset..][0..2], .little);
var meta: MetadataReader = .init(io, cache, offset);
defer meta.deinit(io);
try meta.discardAll(block_idx * @sizeOf(T));
var new: T = undefined;
try meta.interface.readSliceEndian(T, @ptrCast(&new), .little);
return new;
}
pub fn Table(comptime T: anytype) type {
return struct {
const PER_BLOCK = 8192 / @sizeOf(T);
const LookupTable = @This();
alloc: std.mem.Allocator,
cache: *DecompCache,
table_start: u64,
num: u32,
values: std.AutoHashMap(u32, []T),
mut: Io.RwLock = .init,
pub fn init(alloc: std.mem.Allocator, cache: *DecompCache, table_start: u64, num_values: u32) LookupTable {
return .{
.alloc = alloc,
.cache = cache,
.table_start = table_start,
.num = num_values,
.values = .init(alloc),
};
}
pub fn deinit(self: *LookupTable) void {
var iter = self.values.valueIterator();
while (iter.next()) |v|
self.alloc.free(v);
self.values.deinit();
}
pub fn get(self: *LookupTable, io: Io, idx: u32) Error!T {
const block = idx / PER_BLOCK;
const block_idx = idx % PER_BLOCK;
{
try self.mut.lockShared(io);
defer self.mut.unlockShared(io);
const val = self.values.get(block);
if (val != null) return val.*[block_idx];
}
try self.mut.lock(io);
defer self.mut.unlock(io);
const val = try self.values.getOrPut(block);
if (val.found_existing)
return val.value_ptr.*[block_idx];
errdefer self.values.removeByPtr(val.key_ptr);
const offset_offset = self.table_start + (block * 8);
const offset: u64 = std.mem.readInt(u64, self.cache.map.memory[offset_offset..][0..2], .little);
var meta: MetadataReader = .init(io, self.cache, offset);
defer meta.deinit(io);
const size = if (block == ((self.num - 1) / PER_BLOCK))
self.num % PER_BLOCK
else
PER_BLOCK;
const new_block = try self.alloc.alloc(T, size);
errdefer self.alloc.free(new_block);
try meta.interface.readSliceEndian(T, new_block, .little);
val.value_ptr.* = new_block;
return new_block[block_idx];
}
};
}
// Types
pub const Error = error{} || std.mem.Allocator.Error;
pub const FragmentEntry = extern struct {
start: u64,
size: DataBlock,
_: u32,
};
pub const XattrEntry = extern struct {
ref: InodeRef,
count: u32,
size: u32,
};
+122
View File
@@ -0,0 +1,122 @@
const std = @import("std");
const Io = std.Io;
const Decompressor = @import("util/decompressor.zig");
const MetadataReader = @import("util/metadata.zig");
const OffsetFile = @import("util/offset_file.zig");
pub fn lookupValue(comptime T: anytype, alloc: std.mem.Allocator, io: Io, decomp: *const Decompressor, file: OffsetFile, table_start: u64, idx: u32) !T {
const T_PER_BLOCK: u16 = 8192 / @sizeOf(T);
const block = idx / T_PER_BLOCK;
const block_offset = idx % T_PER_BLOCK;
var rdr = try file.readerAt(io, table_start + (8 * block), &[0]u8{});
var offset: u64 = undefined;
try rdr.interface.readSliceEndian(u64, @ptrCast(&offset), .little);
rdr = try file.readerAt(io, offset, &[0]u8{});
var meta: MetadataReader = .init(alloc, &rdr.interface, decomp);
try meta.interface.discardAll(@sizeOf(T) * block_offset);
var out: T = undefined;
try meta.interface.readSliceEndian(T, @ptrCast(&out), .little);
return out;
}
pub const Error = Io.Cancelable || Io.File.Reader.SeekError || Io.Reader.ReadAllocError;
pub fn CachedTable(comptime T: anytype) type {
return struct {
const T_PER_BLOCK: u16 = 8192 / @sizeOf(T);
const Table = @This();
alloc: std.mem.Allocator,
fil: OffsetFile,
decomp: *const Decompressor,
table_start: u64,
total_num: u32,
table: std.AutoHashMap(u32, []T),
mut: Io.Mutex = .init,
pub fn init(alloc: std.mem.Allocator, fil: OffsetFile, decomp: *const 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| {
var rdr = try self.fil.readerAt(io, self.table_start + (8 * block), &[0]u8{});
var offset: u64 = undefined;
try rdr.interface.readSliceEndian(u64, @ptrCast(&offset), .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;
rdr = try self.fil.readerAt(io, offset, &[0]u8{});
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;
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];
var rdr = try self.fil.readerAt(io, self.table_start + (8 * block), &[0]u8{});
var offset: u64 = undefined;
try rdr.interface.readSliceEndian(u64, @ptrCast(&offset), .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;
rdr = try self.fil.readerAt(io, offset, &[0]u8{});
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(block, slice);
return slice[block_offset];
}
};
}
-109
View File
@@ -1,109 +0,0 @@
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();
io: Io,
cache: *DecompCache,
cur_offset: u64 = 0,
next_offset: u64,
interface: Reader = .{
.buffer = &[0]u8{},
.end = 0,
.seek = 0,
.vtable = &.{
.stream = stream,
.discard = discard,
.readVec = readVec,
},
},
pub fn init(io: Io, cache: *DecompCache, start: u64) MetadataReader {
return .{
.io = io,
.cache = cache,
.next_offset = start,
};
}
pub fn deinit(self: *MetadataReader, io: Io) void {
self.cache.finished(io, self.cur_offset);
}
fn advance(self: *MetadataReader) !void {
self.cache.finished(self.io, self.cur_offset);
self.interface.seek = 0;
errdefer self.interface.end = 0;
const hdr: Header = @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;
if (hdr.uncompressed) {
self.interface.buffer = self.cache.map.memory[self.cur_offset..][0..hdr.size];
self.interface.end = hdr.size;
return;
}
self.interface.buffer = try self.cache.get(self.io, self.cur_offset, hdr.size, 8192);
self.interface.end = self.interface.buffer.len;
}
fn stream(r: *Reader, w: *Writer, limit: Limit) Reader.StreamError!usize {
if (r.seek >= r.end) {
const self: *MetadataReader = @fieldParentPtr("interface", r);
self.advance() catch |err| {
std.debug.print("error advancing metadata reader: {}\n", .{err});
return Reader.Error.ReadFailed;
};
}
const to_write = @min(r.end - r.seek, @intFromEnum(limit));
const wrote = try w.write(r.buffer[r.seek..][0..to_write]);
r.seek += wrote;
return wrote;
}
fn discard(r: *Reader, limit: Limit) Reader.Error!usize {
if (r.seek >= r.end) {
const self: *MetadataReader = @fieldParentPtr("interface", r);
self.advance() catch |err| {
std.debug.print("error advancing metadata reader: {}\n", .{err});
return Reader.Error.ReadFailed;
};
}
const to_discard = @min(r.end - r.seek, @intFromEnum(limit));
r.seek += to_discard;
return to_discard;
}
fn readVec(r: *Reader, vec: [][]u8) Reader.Error!usize {
if (r.seek >= r.end) {
const self: *MetadataReader = @fieldParentPtr("interface", r);
self.advance() catch |err| {
std.debug.print("error advancing metadata reader: {}\n", .{err});
return Reader.Error.ReadFailed;
};
}
var total: usize = 0;
for (vec) |v| {
const to_copy = @min(r.end - r.seek, v.len);
@memcpy(v[0..to_copy], r.buffer[r.seek..][0..to_copy]);
r.seek += to_copy;
total += to_copy;
if (r.seek >= r.end)
break;
}
return total;
}
// Types
const Header = packed struct(u16) {
size: u15,
uncompressed: bool,
};
+9 -1
View File
@@ -5,6 +5,8 @@ const Writer = std.Io.Writer;
const ExtractionOptions = @This();
/// The number of threads used for extraction. 0 implies single threaded.
threads: usize = 1, // TODO: Update to better integrate with zig 0.16 Io. Maybe limit to only single or multi-threaded.
/// Don't set the file's owner & permissions after extraction
ignore_permissions: bool = false,
/// Don't set xattr values. Currently xattrs are never set anyway.
@@ -16,10 +18,16 @@ verbose: bool = false,
/// Where to print verbose log.
verbose_writer: ?*Writer = null,
pub const default: ExtractionOptions = .{};
pub const SingleThreadedDefault: ExtractionOptions = .{};
pub fn Default() !ExtractionOptions {
return .{
.threads = try std.Thread.getCpuCount(),
};
}
pub fn VerboseDefault(wrt: *Writer) !ExtractionOptions {
return .{
.verbose = true,
.verbose_writer = wrt,
.threads = try std.Thread.getCpuCount(),
};
}
-6
View File
@@ -1,8 +1,2 @@
pub const Archive = @import("archive.zig");
pub const ExtractionOptions = @import("options.zig");
test {
const std = @import("std");
std.testing.refAllDecls(Archive);
}
+27 -22
View File
@@ -1,46 +1,51 @@
const std = @import("std");
const Io = std.Io;
const io = std.testing.io;
const alloc = std.testing.allocator;
const stuff = @import("builtin");
const Archive = @import("archive.zig");
const Superblock = @import("super.zig").Superblock;
const Superblock = Archive.Superblock;
const TestArchive = "testing/LinuxPATest.sfs";
test "Basics" {
var fil = try std.fs.cwd().openFile(TestArchive, .{});
defer fil.close();
var sfs: Archive = try .init(std.testing.allocator, fil);
defer sfs.deinit();
if (sfs.super != LinuxPATestCorrectSuperblock) {
std.debug.print("Superblock wrong\nShould be: {}\n\nis: {}\n", .{ LinuxPATestCorrectSuperblock, sfs.super });
return error.BadSuperblock;
}
std.debug.print("Starting test: Basics...\n", .{});
var fil = try Io.Dir.cwd().openFile(io, TestArchive, .{});
defer fil.close(io);
var sfs: Archive = try .init(io, fil, 0);
try std.testing.expectEqualDeep(sfs.super, LinuxPATestCorrectSuperblock);
const root_file = try sfs.root(alloc, io);
defer root_file.deinit();
}
const TestFile = "Start.exe";
const TestFileExtractLocation = "testing/Start.exe";
test "ExtractSingleFile" {
std.fs.cwd().deleteFile(TestFileExtractLocation) catch {};
var fil = try std.fs.cwd().openFile(TestArchive, .{});
defer fil.close();
var sfs: Archive = try .init(std.testing.allocator, fil);
defer sfs.deinit();
var test_fil = try sfs.open(TestFile);
std.debug.print("Starting test: ExtractSingleFile...\n", .{});
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);
var test_fil = try sfs.open(alloc, io, TestFile);
defer test_fil.deinit();
try test_fil.extract(TestFileExtractLocation, .Default);
try test_fil.extract(alloc, io, TestFileExtractLocation, try .Default());
//TODO: validate extracted file.
}
const TestFullExtractLocation = "testing/TestExtract";
test "ExtractCompleteArchive" {
std.fs.cwd().deleteTree(TestFullExtractLocation) catch {};
var fil = try std.fs.cwd().openFile(TestArchive, .{});
defer fil.close();
var sfs: Archive = try .init(std.testing.allocator, fil);
defer sfs.deinit();
try sfs.extract(TestFullExtractLocation, .Default);
std.debug.print("Starting test: ExtractCompleteArchive...\n", .{});
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);
try sfs.extract(alloc, io, TestFullExtractLocation, try .Default());
}
const LinuxPATestCorrectSuperblock: Superblock = .{
+180
View File
@@ -0,0 +1,180 @@
//! 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 = error{OutOfMemory} || Io.File.Reader.SeekError || Io.Writer.Error;
const DataExtractor = @This();
fil: OffsetFile,
decomp: *const Decompressor,
block_size: u32,
file_size: u64,
start: u64,
blocks: []BlockSize,
frag_offset: u32 = 0,
frag_entry: ?FragEntry = null,
err: ?Error = null,
pub fn init(fil: OffsetFile, decomp: *const 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, entry: FragEntry) void {
self.frag_offset = frag_offset;
self.frag_entry = entry;
}
fn numBlocks(self: DataExtractor) usize {
var num = self.blocks.len;
if (self.frag_entry != null) num += 1;
return num;
}
/// 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_entry != null)
group.async(io, fragThread, .{ self, alloc, 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;
var wrt = fil.writer(io, &[0]u8{});
wrt.seekTo(self.block_size * idx) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
defer wrt.flush() catch {};
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;
};
return;
}
var rdr = self.fil.readerAt(io, read_offset, &[0]u8{}) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
if (block.uncompressed) {
rdr.interface.streamExact(&wrt.interface, cur_block_size) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
return;
} else {
@branchHint(.likely);
var cache: [1024 * 1024]u8 = undefined;
var tmp: [1024 * 1024]u8 = undefined;
rdr.interface.readSliceAll(cache[0..block.size]) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
_ = self.decomp.Decompress(alloc, cache[0..block.size], tmp[0..cur_block_size]) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
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;
};
}
}
fn fragThread(self: DataExtractor, alloc: std.mem.Allocator, io: Io, fil: Io.File, ret_err: *?Error) Io.Cancelable!void {
const frag = self.frag_entry.?;
const cur_block_size = self.file_size % self.block_size;
var wrt = fil.writer(io, &[0]u8{});
wrt.seekTo(self.blocks.len * self.block_size) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
defer wrt.flush() catch {};
var rdr = self.fil.readerAt(io, frag.start, &[0]u8{}) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
if (frag.size.uncompressed) {
rdr.interface.discardAll(self.frag_offset) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
rdr.interface.streamExact(&wrt.interface, cur_block_size) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
return;
} else {
@branchHint(.likely);
var cache: [1024 * 1024]u8 = undefined;
var tmp: [1024 * 1024]u8 = undefined;
rdr.interface.readSliceAll(cache[0..frag.size.size]) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
_ = self.decomp.Decompress(alloc, cache[0..frag.size.size], tmp[0..self.block_size]) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
wrt.interface.writeAll(tmp[self.frag_offset .. self.frag_offset + cur_block_size]) catch |err| {
ret_err.* = err;
if (err == error.Canceled) io.recancel();
return Io.Cancelable.Canceled;
};
}
}
+208
View File
@@ -0,0 +1,208 @@
//! 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 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");
const DataReader = @This();
alloc: std.mem.Allocator,
fil: OffsetFile,
io: Io,
decomp: *const Decompressor,
cache: *Io.Queue([]u8),
block_size: u32,
file_size: u64,
cur_offset: u64,
blocks: []BlockSize,
frag_offset: u32 = 0,
frag_entry: ?FragEntry = null,
block_idx: usize = 0,
sparse_block: bool = false,
interface: Io.Reader,
pub fn init(alloc: std.mem.Allocator, io: Io, fil: OffsetFile, decomp: *const Decompressor, cache: *Io.Queue([]u8), block_size: u32, file_size: u64, data_start: u64, blocks: []BlockSize) !DataReader {
return .{
.alloc = alloc,
.fil = fil,
.io = io,
.decomp = decomp,
.cache = cache,
.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, entry: FragEntry) void {
self.frag_offset = frag_offset;
self.frag_entry = entry;
}
fn numBlocks(self: DataReader) usize {
var num = self.blocks.len;
if (self.frag_entry != null) num += 1;
return num;
}
fn advanceBuffer(self: *DataReader) !void {
if (self.block_idx >= self.numBlocks()) {
return Reader.Error.EndOfStream;
}
defer self.block_idx += 1;
self.interface.end = if (self.block_idx == self.numBlocks() - 1)
self.size % self.block_size
else
self.block_size;
// Fragment
if (self.block_idx == self.blocks.len) {
const entry = self.frag_entry.?;
if (entry.size.uncompressed) {
var rdr = try self.fil.readerAt(self.io, entry.start + self.frag_offset, &[0]u8{});
try rdr.interface.readSliceAll(self.interface.buffer[0..self.interface.end]);
} else {
@branchHint(.likely);
const tmp = try self.cache.getOne(self.io);
defer self.cache.putOne(tmp) catch {};
var rdr = try self.fil.readerAt(self.io, entry.start, &[0]u8{});
try rdr.interface.readSliceAll(tmp.cache[0..entry.size.size]);
_ = try self.decomp.Decompress(self.alloc, tmp.cache[0..entry.size.size], self.interface.buffer[0..self.block_size]);
@memmove(self.interface.buffer[0..self.interface.end], self.interface.buffer[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) {
try self.fil.readAt(self.io, self.cur_offset, self.interface.buffer[0..self.interface.end]);
self.cur_offset += self.interface.end;
} else {
@branchHint(.likely);
const tmp = try self.cache.getOne(self.io);
defer self.cache.putOne(tmp) catch {};
var rdr = try self.fil.readerAt(self.io, self.cur_offset, &[0]u8{});
try rdr.interface.readSliceAll(tmp.cache[0..block.size]);
self.cur_offset += block.size;
_ = try self.decomp.Decompress(self.alloc, tmp.cache[0..block.size], self.interface.buffer[0..self.interface.end]);
}
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;
}
+15
View File
@@ -0,0 +1,15 @@
//! 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 (?*const Decompressor, std.mem.Allocator, in: []u8, out: []u8) Error!usize,
pub fn Decompress(self: *const Decompressor, alloc: std.mem.Allocator, in: []u8, out: []u8) Error!usize {
return self.decomp_fn(self, alloc, in, out);
}
+103
View File
@@ -0,0 +1,103 @@
const std = @import("std");
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 BlockHeader = packed struct(u16) {
size: u15,
uncompressed: bool,
};
const This = @This();
alloc: std.mem.Allocator,
rdr: *Reader,
decomp: *const Decompressor,
cur_block_start: u32 = 0,
next_start_start: u32 = 0,
buf: [8192]u8 = undefined,
err: ?anyerror = null,
interface: Reader = .{
.buffer = &[0]u8{},
.end = 0,
.seek = 0,
.vtable = &.{
.stream = stream,
.discard = discard,
.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: *const Decompressor) This {
return .{
.alloc = alloc,
.rdr = rdr,
.decomp = decomp,
};
}
fn advance(self: *This) !void {
self.interface.seek = 0;
var hdr: BlockHeader = undefined;
try self.rdr.readSliceEndian(BlockHeader, @ptrCast(&hdr), .little);
self.cur_block_start = self.next_start_start;
self.next_start_start += hdr.size;
if (hdr.uncompressed) {
try self.rdr.readSliceEndian(u8, self.buf[0..hdr.size], .little);
self.interface.end = hdr.size;
self.interface.buffer = self.buf[0..hdr.size];
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];
}
}
fn stream(rdr: *Reader, wrt: *Writer, limit: Limit) StreamError!usize {
const self: *This = @fieldParentPtr("interface", rdr);
if (rdr.end == rdr.seek) self.advance() catch |err| {
self.err = err;
return StreamError.ReadFailed;
};
if (@intFromEnum(limit) == 0) return 0;
const to_write = @min(rdr.end - rdr.seek, @intFromEnum(limit));
const wrote = try wrt.write(self.buf[rdr.seek .. rdr.seek + to_write]);
self.interface.seek += wrote;
return wrote;
}
fn discard(rdr: *Reader, limit: Limit) Reader.Error!usize {
const self: *This = @fieldParentPtr("interface", rdr);
if (rdr.end == rdr.seek) self.advance() catch |err| {
self.err = err;
return error.ReadFailed;
};
if (@intFromEnum(limit) == 0) return 0;
const to_skip = @min(rdr.end - rdr.seek, @intFromEnum(limit));
rdr.seek += to_skip;
return to_skip;
}
fn readVec(rdr: *Reader, vec: [][]u8) Reader.Error!usize {
const self: *This = @fieldParentPtr("interface", rdr);
if (rdr.end == rdr.seek) self.advance() catch |err| {
self.err = err;
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;
}
+25
View File
@@ -0,0 +1,25 @@
//! 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, io: Io, file: OffsetFile, decomp: *const Decompressor, inode_start: u64, block_size: u32, ref: Inode.Ref) !Inode {
var rdr = try file.readerAt(io, inode_start + ref.block_start, &[0]u8{});
var meta: MetadataReader = .init(alloc, &rdr.interface, decomp);
try meta.interface.discardAll(ref.block_offset);
return .read(alloc, &meta.interface, block_size);
}
+24
View File
@@ -0,0 +1,24 @@
//! 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 = File.Reader;
const OffsetFile = @This();
fil: File,
offset: u64,
pub fn init(fil: File, init_offset: u64) OffsetFile {
return .{ .fil = fil, .offset = init_offset };
}
pub fn readerAt(self: OffsetFile, io: Io, offset: u64, buffer: []u8) Reader.SeekError!Reader {
var rdr = self.fil.reader(io, buffer);
try rdr.seekTo(self.offset + offset);
return rdr;
}
pub fn readAt(self: OffsetFile, io: Io, offset: u64, buf: []u8) File.ReadPositionalError!void {
_ = try self.fil.readPositionalAll(io, buf, self.offset + offset);
}
+52
View File
@@ -0,0 +1,52 @@
const std = @import("std");
const Io = std.Io;
const Node = std.SinglyLinkedList.Node;
const SharedCache = @This();
pub const CACHE_SIZE = 1024 * 1024;
pub const BufferNode = struct {
node: Node,
cache: [CACHE_SIZE]u8,
};
alloc: std.mem.Allocator,
caches: std.ArrayList(BufferNode),
cache_queue: std.SinglyLinkedList,
queue_mut: Io.Mutex,
pub fn init(alloc: std.mem.Allocator, init_cache_size: u32) !SharedCache {
const caches: std.ArrayList(BufferNode) = try .initCapacity(alloc, init_cache_size);
var queue: std.SinglyLinkedList = .{};
for (caches.items) |item|
queue.prepend(&item.node);
return .{
.alloc = alloc,
.caches = caches,
.cache_queue = queue,
};
}
pub fn deinit(self: *SharedCache) void {
self.caches.deinit(self.alloc);
}
pub fn getCache(self: *SharedCache, io: Io) !*BufferNode {
self.queue_mut.lock(io);
const nxt = self.cache_queue.popFirst();
self.queue_mut.unlock(io);
if (nxt == null) {
const new = try self.caches.addOne(self.alloc);
new.* = .{
.node = .{},
.cache = undefined,
};
return new;
}
return @fieldParentPtr("node", nxt.?);
}
pub fn returnCache(self: *SharedCache, buf: *BufferNode) void {
self.cache_queue.prepend(buf);
}
+286
View File
@@ -0,0 +1,286 @@
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: *const Decompressor,
kv_start: u64,
table: LookupTable.CachedTable(TableValue),
value_cache: std.AutoHashMap(InodeRef, []const u8),
value_mut: Io.Mutex = .init,
pub fn init(alloc: std.mem.Allocator, io: Io, fil: OffsetFile, decomp: *const Decompressor, xattr_start: u64) !XattrCachedTable {
var rdr = try fil.readerAt(io, xattr_start, &[0]u8{});
var start: u64 = undefined;
try rdr.interface.readSliceEndian(u64, @ptrCast(&start), .little);
var num: u32 = undefined;
try rdr.interface.readSliceEndian(u32, @ptrCast(&num), .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.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 = try self.fil.readerAt(io, self.kv_start + lookup.ref.block_start, &[0]u8{});
var meta: MetadataReader = .init(alloc, &rdr.interface, 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.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 = try self.fil.readerAt(io, self.kv_start + ref.block_start, &[0]u8{});
var meta: MetadataReader = .init(self.alloc, &rdr.interface, 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: *const Decompressor, fil: OffsetFile, table_start: u64, idx: u16) ![]XattrOwned {
var rdr = try fil.readerAt(io, table_start, &[0]u8{});
var kv_start: u64 = undefined;
try rdr.interface.readSliceEndian(u64, @ptrCast(&kv_start), .little);
const lookup = try LookupTable.lookupValue(TableValue, alloc, io, decomp, fil, table_start + 16, idx);
rdr = try fil.readerAt(io, kv_start + lookup.ref.block_start, &[0]u8{});
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 = try fil.readerAt(io, kv_start + value.ref.block_start, &[0]u8{});
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;
}
-40
View File
@@ -1,40 +0,0 @@
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("decomp.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);
}