docs: update README.md

Author: weizhiao

src/image/kinds/dylib.rs

@@ -131,6 +131,12 @@ impl<D> RawDylib<D> {
         self.inner.name()
     }
 
+    /// Returns the short name of the ELF object.
+    #[inline]
+    pub fn short_name(&self) -> &str {
+        self.inner.core_ref().short_name()
+    }
+
     /// Returns the program headers of the ELF object.
     pub fn phdrs(&self) -> &[ElfPhdr] {
         self.inner.phdrs()

src/input/backend.rs

@@ -79,12 +79,7 @@ impl ElfFile {
         #[cfg(feature = "log")]
         log::debug!("Opening ELF file: {}", path);
 
-        let inner = RawFile::from_path(path).map_err(|e| {
-            #[cfg(feature = "log")]
-            log::error!("Failed to open ELF file {}: {:?}", path, e);
-            e
-        })?;
-
+        let inner = RawFile::from_path(path)?;
         Ok(ElfFile { inner })
     }
 }

tools/gen-elf/README.md

@@ -1,37 +1,44 @@
 # gen-elf
 
-`gen-elf` is a utility for generating ELF files (Shared Objects and Relocatable Objects) specifically designed for testing ELF loaders. It simplifies the process of creating binaries with specific symbol structures and relocation entries for `elf_loader` verification.
+`gen-elf` is a utility for generating ELF files (Shared Objects and Relocatable Objects) specifically designed for testing ELF loaders. It simplifies the process of creating binaries with specific symbol structures, relocation entries, and memory layouts for `elf_loader` verification.
 
 ## Features
 
 - **Multi-architecture Support**: Supports x86_64, x86, Aarch64, Riscv64, Riscv32, Arm, and Loongarch64.
-- **Dynamic Library Generation**: Generates Shared Objects (.so) with `.dynamic` sections, relocation tables (RELA/REL), and symbol tables.
+- **Dynamic Library Generation**: Generates Shared Objects (.so) with `.dynamic` sections, relocation tables (RELA/REL), symbol tables, and GOT/PLT.
+- **TLS and IFUNC Support**: Easily generate Thread-Local Storage (TLS) symbols and Indirect Functions (IFUNC) with automatic resolver generation.
 - **Relocatable Object Generation**: Generates standard relocatable object files (.o).
+- **Customizable Layout**: Configure base address and page size for memory mapping tests.
 - **High-level API**: Provides intent-based interfaces like `RelocEntry::jump_slot` and `SymbolDesc::global_func`, abstracting away complex ELF constants.
-- **Metadata Export**: Exports relocation addresses and other metadata alongside the ELF data for easy verification in tests.
+- **Metadata Export**: Exports detailed relocation information and section addresses alongside the ELF data for easy verification in tests.
 
 ## Core Interfaces
 
 ### `DylibWriter`
-Used for generating dynamic libraries.
+Used for generating dynamic libraries. You can customize the generation using `ElfWriterConfig`.
 
 ```rust
-use gen_elf::{Arch, DylibWriter, RelocEntry, SymbolDesc};
+use gen_elf::{Arch, DylibWriter, ElfWriterConfig, RelocEntry, SymbolDesc};
 
-let arch = Arch::X86_64;
-let writer = DylibWriter::new(arch);
+let arch = Arch::current();
+let config = ElfWriterConfig::default()
+    .with_base_addr(0x400000)
+    .with_page_size(0x1000);
+let writer = DylibWriter::with_config(arch, config);
 
 let relocs = vec![
     RelocEntry::jump_slot("external_func", arch),
+    RelocEntry::irelative(arch), // Test IFUNC
 ];
 
 let symbols = vec![
     SymbolDesc::global_object("my_var", &[1, 2, 3, 4]),
+    SymbolDesc::global_tls("my_tls", &[0xaa, 0xbb]),
     SymbolDesc::undefined_func("external_func"),
 ];
 
-let output = writer.write_file("libtest.so", &relocs, &symbols)?;
-println!("Generated ELF at base address: {:#x}", output.base_addr);
+let output = writer.write(&relocs, &symbols)?;
+println!("Generated ELF with {} relocations", output.relocations.len());
 ```
 
 ### `ObjectWriter`
@@ -45,31 +52,34 @@ let writer = ObjectWriter::new(arch);
 
 let symbols = vec![
     SymbolDesc::global_func("my_func", &[0x90, 0xc3]), // nop; ret
+    SymbolDesc::global_object("data_var", &[0x01, 0x02]),
 ];
 
+// Symbols and Relocs
 writer.write_file("test.o", &symbols, &[])?;
 ```
 
-### `Arch`
-Represents the target architecture and provides methods to retrieve architecture-specific relocation types.
-
-- `Arch::current()`: Returns the architecture of the current host.
-- `jump_slot_reloc()`: Returns the `JUMP_SLOT` relocation type for the architecture.
+### `RelocEntry`
+Common relocation types are available as high-level methods:
 
-## CLI Tool
+- `RelocEntry::jump_slot(name, arch)`: PLT-based functions.
+- `RelocEntry::glob_dat(name, arch)`: Global variable references.
+- `RelocEntry::relative(arch)`: Base-relative relocations.
+- `RelocEntry::irelative(arch)`: Indirect (IFUNC) relocations.
+- `RelocEntry::copy(name, arch)`: Copy relocations for variables.
+- `RelocEntry::dtpmod(name, arch)` / `RelocEntry::dtpoff(name, arch)`: TLS-related relocations.
 
-`gen-elf` can also be used as a standalone command-line tool:
+### `SymbolDesc`
+Describe symbols with various scopes and types:
 
-```bash
-# Generate a default x86_64 dynamic library
-cargo run -p gen-elf -- --dynamic -o ./out
-
-# Generate for a specific architecture
-cargo run -p gen-elf -- --target aarch64 --dynamic -o ./out
-```
+- `SymbolDesc::global_func(name, code)`: A global function.
+- `SymbolDesc::global_object(name, data)`: A global variable.
+- `SymbolDesc::global_tls(name, data)`: A thread-local variable.
+- `SymbolDesc::undefined_func(name)`: Reference to an external function.
+- `.with_scope(SymbolScope::Weak)`: Mark a symbol as weak.
 
 ## Usage in Tests
 
-This tool is particularly useful for integration testing of `elf_loader`. You can dynamically generate an ELF with specific relocation types, load it with your loader, and verify that relocations are applied correctly.
+This tool is particularly useful for integration testing of `elf_loader`. You can dynamically generate an ELF with specific relocation types, load it with your loader, and verify that relocations are applied correctly by inspecting `ElfWriteOutput`.
 
-See `tests/gen_elf.rs` for examples.
+See `tests/gen_elf.rs` for comprehensive examples.

tools/gen-elf/README_zh.md

@@ -1,37 +1,44 @@
 # gen-elf
 
-`gen-elf` 是一个用于生成测试用 ELF 文件（动态库和可重定位对象文件）的辅助工具。它旨在简化在测试 `elf_loader` 时创建具有特定符号和重定位结构的二进制文件的过程。
+`gen-elf` 是一个用于生成测试用 ELF 文件（共享对象和可重定位对象）的辅助工具，专为测试 ELF 加载器而设计。它简化了创建具有特定符号结构、重定位条目和内存布局的二进制文件的过程，以便对 `elf_loader` 进行验证。
 
 ## 功能特性
 
-- **多架构支持**：支持 x86_64, x86, Aarch64, Riscv64, Riscv32, Arm, Loongarch64。
-- **动态库生成**：支持生成带有 `.dynamic` 段、重定位表（RELA/REL）和符号表的共享对象（.so）。
-- **可重定位文件生成**：支持生成标准的 `.o` 文件。
-- **高层级 API**：提供意图导向的接口，如 `RelocEntry::jump_slot` 和 `SymbolDesc::global_func`，无需手动处理复杂的 ELF 常量。
-- **元数据导出**：生成 ELF 的同时导出重定位地址等元数据，方便在测试中进行验证。
+- **多架构支持**：支持 x86_64, x86, Aarch64, Riscv64, Riscv32, Arm 和 Loongarch64。
+- **动态库生成**：生成带有 `.dynamic` 段、重定位表（RELA/REL）、符号表以及 GOT/PLT 的共享对象 (.so)。
+- **TLS 和 IFUNC 支持**：轻松生成线程本地存储 (TLS) 符号和间接函数 (IFUNC)，并自动生成 resolver。
+- **可重定位对象生成**：生成标准的可重定位对象文件 (.o)。
+- **可自定义布局**：配置用于内存映射测试的基地址和页面大小。
+- **高层级 API**：提供意图导向的接口，如 `RelocEntry::jump_slot` 和 `SymbolDesc::global_func`，抽象掉复杂的 ELF 常量。
+- **元数据导出**：导出详细的重定位信息和段地址，方便在测试中进行验证。
 
 ## 核心接口
 
 ### `DylibWriter`
-用于生成动态库。
+用于生成动态库。你可以使用 `ElfWriterConfig` 自定义生成过程。
 
 ```rust
-use gen_elf::{Arch, DylibWriter, RelocEntry, SymbolDesc};
+use gen_elf::{Arch, DylibWriter, ElfWriterConfig, RelocEntry, SymbolDesc};
 
-let arch = Arch::X86_64;
-let writer = DylibWriter::new(arch);
+let arch = Arch::current();
+let config = ElfWriterConfig::default()
+    .with_base_addr(0x400000)
+    .with_page_size(0x1000);
+let writer = DylibWriter::with_config(arch, config);
 
 let relocs = vec![
     RelocEntry::jump_slot("external_func", arch),
+    RelocEntry::irelative(arch), // 测试 IFUNC
 ];
 
 let symbols = vec![
     SymbolDesc::global_object("my_var", &[1, 2, 3, 4]),
+    SymbolDesc::global_tls("my_tls", &[0xaa, 0xbb]),
     SymbolDesc::undefined_func("external_func"),
 ];
 
-let output = writer.write_file("libtest.so", &relocs, &symbols)?;
-println!("Generated ELF at base address: {:#x}", output.base_addr);
+let output = writer.write(&relocs, &symbols)?;
+println!("Generated ELF with {} relocations", output.relocations.len());
 ```
 
 ### `ObjectWriter`
@@ -45,29 +52,34 @@ let writer = ObjectWriter::new(arch);
 
 let symbols = vec![
     SymbolDesc::global_func("my_func", &[0x90, 0xc3]), // nop; ret
+    SymbolDesc::global_object("data_var", &[0x01, 0x02]),
 ];
 
+// 符号和重定位
 writer.write_file("test.o", &symbols, &[])?;
 ```
 
-### `Arch`
-表示目标架构，提供架构相关的重定位类型获取方法。
-
-- `Arch::current()`: 获取当前主机的架构。
-- `jump_slot_reloc()`: 获取该架构的 `JUMP_SLOT` 重定位类型。
+### `RelocEntry`
+常见的重定位类型可以通过高层级方法使用：
 
-## 命令行工具
+- `RelocEntry::jump_slot(name, arch)`：基于 PLT 的函数。
+- `RelocEntry::glob_dat(name, arch)`：全局变量引用。
+- `RelocEntry::relative(arch)`：基地址相对重定位。
+- `RelocEntry::irelative(arch)`：间接 (IFUNC) 重定位。
+- `RelocEntry::copy(name, arch)`：变量的复制重定位。
+- `RelocEntry::dtpmod(name, arch)` / `RelocEntry::dtpoff(name, arch)`：TLS 相关重定位。
 
-`gen-elf` 也可以作为一个独立的命令行工具使用：
+### `SymbolDesc`
+描述具有各种作用域和类型的符号：
 
-```bash
-# 生成默认的 x86_64 动态库
-cargo run -p gen-elf -- --dynamic -o ./out
-
-# 为指定架构生成
-cargo run -p gen-elf -- --target aarch64 --dynamic -o ./out
-```
+- `SymbolDesc::global_func(name, code)`：全局函数。
+- `SymbolDesc::global_object(name, data)`：全局变量。
+- `SymbolDesc::global_tls(name, data)`：线程本地变量。
+- `SymbolDesc::undefined_func(name)`：对外部函数的引用。
+- `.with_scope(SymbolScope::Weak)`：将符号标记为弱符号 (weak)。
 
 ## 在测试中使用
 
-该工具特别适合用于 `elf_loader` 的集成测试。你可以动态生成一个具有特定重定位类型的 ELF，然后使用你的加载器加载它，并验证重定位是否正确应用。
+该工具特别适用于 `elf_loader` 的集成测试。你可以动态生成具有特定重定位类型的 ELF，使用加载器加载它，并通过检查 `ElfWriteOutput` 验证重定位是否正确应用。
+
+有关全面示例，请参阅 `tests/gen_elf.rs`。