#ebpf #bytecode #linux #instructions #scripting-language

bpf-script

A small scripting language and compiler for creating eBPF programs at runtime

14 releases

0.5.4 Nov 5, 2022
0.5.3 Nov 3, 2022
0.4.0 Nov 2, 2022
0.1.7 Oct 31, 2022

#1032 in Programming languages


Used in 2 crates

MIT license

92KB
2K SLoC

bpf-script

Build Status crates.io mio Lines of Code

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

For usage examples, see code located in examples/ :

Examples Description
print-instructions Compiles a short program and prints the generated instructions

TODO

  • Add control flow.
  • Write more thorough tests.

License

Dependencies

~4–15MB
~125K SLoC