refactor: put hermit-image-reader into this repo, for now

Author: fogti

Cargo.lock

@@ -1,4 +1,5 @@
 [workspace]
+members = ["hermit-image-reader", "uhyve-interface"]
 exclude = ["tests/test-kernels", "hermit-rs", "hermit-rs/*", "kernel"]
 
 [package]
@@ -51,6 +52,7 @@ env_logger = "0.11"
 gdbstub = "0.7"
 gdbstub_arch = "0.3"
 hermit-entry = { version = "0.10.4", features = ["loader"] }
+hermit-image-reader = { version = "0.1", path = "hermit-image-reader" }
 libc = "0.2"
 log = "0.4"
 mac_address = "1.1"
@@ -73,9 +75,6 @@ serde = { version = "1.0", features = ["derive"] }
 merge = { version = "0.2" }
 memmap2 = "0.9.8"
 
-[dependencies.hermit-image-reader]
-git = "https://codeberg.org/hermit-os-contrib/hermit-image-reader.git"
-
 [target.'cfg(target_os = "linux")'.dependencies]
 kvm-bindings = "0.14"
 kvm-ioctls = "0.24"

Cargo.toml

@@ -0,0 +1,34 @@
+[package]
+name = "hermit-image-reader"
+version = "0.1.0"
+edition = "2024"
+license = "MIT OR Apache-2.0"
+
+[features]
+std = ["compression/std"]
+
+[dependencies]
+
+[dependencies.byte-unit]
+version = "5"
+default-features = false
+features = ["byte", "serde"]
+
+[dependencies.compression]
+version = "0.1"
+default-features = false
+features = ["gzip"]
+
+[dependencies.num-traits]
+version = "0.2"
+default-features = false
+
+[dependencies.serde]
+version = "1"
+default-features = false
+features = ["alloc", "derive"]
+
+[dependencies.toml]
+version = "0.9"
+default-features = false
+features = ["parse", "serde"]

hermit-image-reader/Cargo.lock

@@ -0,0 +1 @@
+../LICENSE-APACHE

hermit-image-reader/Cargo.toml

@@ -0,0 +1 @@
+../LICENSE-MIT

hermit-image-reader/LICENSE-APACHE

@@ -0,0 +1,40 @@
+// Copyright (c) 2025 Hermit contributors
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+fn main() {
+	for f in std::env::args().skip(1) {
+		println!("# File {}:", f);
+		let data = std::fs::read(f).expect("unable to read image file");
+		let decompressed = hermit_image_reader::decompress_image(&data[..])
+			.expect("unable to decompress image file");
+		for i in hermit_image_reader::ImageParser::new(&decompressed[..]) {
+			let i = i.expect("unable to read image entry");
+			print!("  Entry ");
+			if let Ok(name) = str::from_utf8(&*i.name) {
+				print!("{:?}", name);
+			} else {
+				print!("{:?}", i.name);
+			}
+			if i.is_exec {
+				print!(" (executable)");
+			}
+			print!(" :: {:?} :: starts with: ", i.value_range);
+			let value_start = &i.value[..core::cmp::min(20, i.value.len())];
+
+			if let Ok(value_start) = str::from_utf8(value_start) {
+				println!("{:?}", value_start);
+			} else {
+				println!("{:?}", value_start);
+			}
+
+			if let Ok(name) = str::from_utf8(&*i.name) {
+				if name == hermit_image_reader::config::DEFAULT_CONFIG_NAME {
+					match hermit_image_reader::config::parse(i.value) {
+						Ok(config) => println!("parsed config ::\n{:#?}\n", config),
+						Err(e) => eprintln!("failed to parse config :: {}", e),
+					}
+				}
+			}
+		}
+	}
+}

hermit-image-reader/LICENSE-MIT

@@ -0,0 +1,44 @@
+// Copyright (c) 2025 Hermit contributors
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+use alloc::{collections::btree_map as btm, string::String, vec::Vec};
+
+pub const DEFAULT_CONFIG_NAME: &'static str = "hermit_config.toml";
+pub type ParserError = toml::de::Error;
+
+#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)]
+/// The image `hermit_config.toml` config file format.
+///
+/// All file paths are relative to the iamge root.
+pub struct Config {
+	pub input: Input,
+	pub requirements: Requirements,
+
+	pub kernel: String,
+	pub file_mapping: btm::BTreeMap<String, String>,
+}
+
+#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)]
+pub struct Input {
+	/// Arguments to be passed to the kernel
+	pub kernel_args: Vec<String>,
+
+	/// Arguments to be passed to the application
+	pub app_args: Vec<String>,
+
+	/// Environment variables
+	pub env_vars: Vec<String>,
+}
+
+#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)]
+pub struct Requirements {
+	pub memory: Option<byte_unit::Byte>,
+
+	#[serde(default)]
+	pub cpus: u32,
+}
+
+#[inline]
+pub fn parse(data: &[u8]) -> Result<Config, ParserError> {
+	toml::from_slice(data)
+}

hermit-image-reader/examples/hermit-image-info.rs

@@ -0,0 +1,23 @@
+// Copyright (c) 2025 Hermit contributors
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+#![no_std]
+
+extern crate alloc;
+
+use alloc::vec::Vec;
+
+/// We assume that all images are gzip-compressed
+pub fn decompress_image(data: &[u8]) -> Result<Vec<u8>, compression::prelude::CompressionError> {
+	use compression::prelude::{DecodeExt as _, GZipDecoder};
+
+	data.iter()
+		.copied()
+		.decode(&mut GZipDecoder::new())
+		.collect()
+}
+
+mod tar_parser;
+pub use tar_parser::{ImageFile, ImageParser, ImageParserError};
+
+pub mod config;