Crate bpf_script

Expand description

A small scripting language and compiler for creating eBPF programs at runtime without bcc or llvm.

The intent behind building this crate was to primarily learn more about BPF internals and, secondly, to provide a dependency-free way of writing BPF programs, using a higher-level language, that could be compiled at run-time without the need to shell out to a compiler and load/patch BPF from an ELF file.

The syntax for the language resembles Rust with a lot of features stripped out. For example, a simple u/k probe program that calls a helper and returns the value looks like so:

fn(regs: &bpf_user_pt_regs_t)
    a = get_current_uid_gid()
    map_push_elem(queue, &a, 0)
    return a

This crate is made to work together with the following crates but they are not required:

btf A BTF parsing library.
bpf-script-derive Allows you to seamlessly share types between Rust and this compiler.
bpf-api Creating programs, probes, maps, etc.

Usage

use bpf_script::compiler::Compiler;
use bpf_script::types::{AddToTypeDatabase, TypeDatabase};

let mut types = TypeDatabase::default();
u32::add_to_database(&mut types).expect("Failed to add type");

let mut compiler = Compiler::create(&types);
compiler.compile(r#"
    fn(a: u32)
        return a
"#).expect("Compilation failed");

for ins in compiler.get_instructions() {
    println!("{}", ins);
}

TODO

Add control flow.
Write more thorough tests.

License

MIT license

Modules

compiler

error

types