LibObjectFile 0.6.0
See the version list below for details.
dotnet add package LibObjectFile --version 0.6.0
NuGet\Install-Package LibObjectFile -Version 0.6.0
<PackageReference Include="LibObjectFile" Version="0.6.0" />
paket add LibObjectFile --version 0.6.0
#r "nuget: LibObjectFile, 0.6.0"
// Install LibObjectFile as a Cake Addin #addin nuget:?package=LibObjectFile&version=0.6.0 // Install LibObjectFile as a Cake Tool #tool nuget:?package=LibObjectFile&version=0.6.0
LibObjectFile
<img align="right" width="200px" height="200px" src="https://raw.githubusercontent.com/xoofx/LibObjectFile/master/img/libobjectfile.png">
LibObjectFile is a .NET library to read, manipulate and write linker and executable object files (e.g ELF, ar, DWARF, COFF...)
NOTE: Currently LibObjectFile supports only the following file format:
- ELF object-file format
- DWARF debugging format (version 4)
- Archive
ar
file format (Common, GNU and BSD variants)There is a longer term plan to support other file formats (e.g COFF, MACH-O, .lib) but as I don't have a need for them right now, it is left as an exercise for PR contributors! 😉
Usage
// Reads an ELF file
using var inStream = File.OpenRead("helloworld");
var elf = ElfObjectFile.Read(inStream);
foreach(var section in elf.Sections)
{
Console.WriteLine(section.Name);
}
// Print the content of the ELF as readelf output
elf.Print(Console.Out);
// Write the ElfObjectFile to another file on the disk
using var outStream = File.OpenWrite("helloworld2");
elf.Write(outStream);
Features
- Full support of Archive
ar
file format including Common, GNU and BSD variants. - Good support for the ELF file format:
- Read and write from/to a
System.IO.Stream
- Handling of LSB/MSB
- Support the following sections:
- String Table
- Symbol Table
- Relocation Table: supported I386, X86_64, ARM and AARCH64 relocations (others can be exposed by adding some mappings)
- Note Table
- Other sections fallback to
ElfCustomSection
- Program headers with or without sections
- Print with
readelf
similar output
- Read and write from/to a
- Support for DWARF debugging format:
- Partial support of Version 4 (currently still the default for GCC)
- Support for the sections:
.debug_info
,.debug_line
,.debug_aranges
,.debug_abbrev
and.debug_str
- Support for Dwarf expressions
- High level interface, automatic layout/offsets between sections.
- Integration with ELF to support easy reading/writing back
- Support for relocatable sections
- Use of a Diagnostics API to validate file format (on read/before write)
- Library requiring
net8.0
- If you are looking for
netstandard2.1
support you will need to use0.4.0
version
- If you are looking for
Documentation
The doc/readme.md explains how the library is designed and can be used.
Known Issues
PR Welcome if you are willing to contribute to one of these issues:
- Add more unit tests
ELF
There are still a few missing implementation of ElfSection
for completeness:
- Dynamic Linking Table (
SHT_DYNAMIC
) - Version Symbol Table (
SHT_VERSYM
) - Version Needs Table (
SHT_VERNEED
)
These sections are currently loaded as ElfCustomSection
but should have their own ElfXXXTable (e.g ElfDynamicLinkingTable
, ElfVersionSymbolTable
...)
DWARF
- Version 4: support for
.debug_types
,.debug_frame
,.debug_loc
,.debug_ranges
,.debug_pubnames
,.debug_pubtypes
,.debug_macinfo
section - Version 5
Other file formats
In a future version I would like to implement the following file format:
- COFF
- Mach-O
- Portable in Memory file format to easily convert between ELF/COFF/Mach-O file formats.
Download
LibObjectFile is available as a NuGet package:
Build
In order to build LibObjectFile, you need to have installed the .NET Core 3.0 SDK.
Running the tests require Ubuntu 18.04. dotnet test
will work on Windows (via WSL) and on that version of Ubuntu.
If you're using macOS or another Linux, there's a Dockerfile and a helper script under src
to run tests in the right OS version.
License
This software is released under the BSD-Clause 2 license.
Author
Alexandre MUTEL aka xoofx
Supporters
Supports this project with a monthly donation and help me continue improving it. [Become a supporter]
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net8.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.1.1 | 40 | 10/13/2024 |
1.1.0 | 87 | 10/2/2024 |
1.0.0 | 87 | 10/1/2024 |
0.6.0 | 425 | 12/9/2023 |
0.5.0 | 215 | 10/14/2023 |
0.4.0 | 1,212 | 10/21/2022 |
0.3.6 | 695 | 3/6/2022 |
0.3.5 | 938 | 2/11/2020 |
0.3.4 | 523 | 1/4/2020 |
0.3.3 | 454 | 12/24/2019 |
0.3.2 | 497 | 12/22/2019 |
0.3.1 | 482 | 12/19/2019 |
0.3.0 | 490 | 12/18/2019 |
0.2.1 | 480 | 11/19/2019 |
0.2.0 | 472 | 11/17/2019 |
0.1.0 | 483 | 11/16/2019 |