Tamir Duberstein e95a54f593 build(deps): update thiserror to 2.0.3 1 day ago
..
include 366c599c20 codegen: cgroup_iter_order NFPROTO* nf_inet_hooks 1 month ago
src e95a54f593 build(deps): update thiserror to 2.0.3 1 day ago
CHANGELOG.md c6a34cade1 Release aya-obj v0.2.1 1 week ago
Cargo.toml e95a54f593 build(deps): update thiserror to 2.0.3 1 day ago
README.md 9c451a3357 aya-obj: update documentation and versioning info 1 year ago

README.md

aya-obj

Status

This crate includes code that started as internal API used by the aya crate. It has been split out so that it can be used by other projects that deal with eBPF object files. Unless you're writing low level eBPF plumbing tools, you should not need to use this crate but see the aya crate instead.

The API as it is today has a few rough edges and is generally not as polished nor stable as the main aya crate API. As always, improvements welcome!

Overview

eBPF programs written with libbpf or aya-bpf are usually compiled into an ELF object file, using various sections to store information about the eBPF programs.

aya-obj is a library for parsing such eBPF object files, with BTF and relocation support.

Example

This example loads a simple eBPF program and runs it with rbpf.

use aya_obj::{generated::bpf_insn, Object};

// Parse the object file
let bytes = std::fs::read("program.o").unwrap();
let mut object = Object::parse(&bytes).unwrap();
// Relocate the programs
object.relocate_calls().unwrap();
object.relocate_maps(std::iter::empty()).unwrap();

// Run with rbpf
let instructions = &object.programs["prog_name"].function.instructions;
let data = unsafe {
    core::slice::from_raw_parts(
        instructions.as_ptr() as *const u8,
        instructions.len() * core::mem::size_of::<bpf_insn>(),
    )
};
let vm = rbpf::EbpfVmNoData::new(Some(data)).unwrap();
let _return = vm.execute_program().unwrap();