e94e988336
This patch adds some documentation to aya-bpf/helpers and adds documentation for the module itself and for all of the wrappers currently defined in the module. It also implements the rest of the bpf_probe_read_* wrappers that were missing from this file. In the future, it probably also makes sense to add some bpf_probe_read_* wrappers that can read directly into a map pointer, avoiding the BPF stack altogether. I'm going to call this out of scope for this PR, but plan to submit a subsequent one that addresses this use case. Signed-off-by: William Findlay <william@williamfindlay.com> |
3 years ago | |
|---|---|---|
| .cargo | 3 years ago | |
| .github | 3 years ago | |
| .vim | 3 years ago | |
| .vscode | 3 years ago | |
| aya | 3 years ago | |
| aya-gen | 3 years ago | |
| bpf | 3 years ago | |
| xtask | 3 years ago | |
| .gitignore | 3 years ago | |
| CONTRIBUTING.md | 3 years ago | |
| Cargo.toml | 4 years ago | |
| LICENSE-APACHE | 4 years ago | |
| LICENSE-MIT | 4 years ago | |
| README.md | 3 years ago | |
| rustfmt.toml | 4 years ago | |
README.md
Aya
API docs | Chat | Aya-Related Projects
Overview
eBPF is a technology that allows running user-supplied programs inside the Linux kernel. For more info see https://ebpf.io/what-is-ebpf.
Aya is an eBPF library built with a focus on operability and developer experience. It does not rely on libbpf nor bcc - it's built from the ground up purely in Rust, using only the libc crate to execute syscalls. With BTF support and when linked with musl, it offers a true compile once, run everywhere solution, where a single self-contained binary can be deployed on many linux distributions and kernel versions.
Some of the major features provided include:
- Support for the BPF Type Format (BTF), which is transparently enabled when supported by the target kernel. This allows eBPF programs compiled against one kernel version to run on different kernel versions without the need to recompile.
- Support for function call relocation and global data maps, which allows eBPF programs to make function calls and use global variables and initializers.
- Async support with both tokio and async-std.
- Easy to deploy and fast to build: aya doesn't require a kernel build or compiled headers, and not even a C toolchain; a release build completes in a matter of seconds.
Example
Aya supports a large chunk of the eBPF API. The following example shows how to use a
BPF_PROG_TYPE_CGROUP_SKB program with aya:
use std::fs::File;
use std::convert::TryInto;
use aya::Bpf;
use aya::programs::{CgroupSkb, CgroupSkbAttachType};
// load the BPF code
let mut bpf = Bpf::load_file("bpf.o")?;
// get the `ingress_filter` program compiled into `bpf.o`.
let ingress: &mut CgroupSkb = bpf.program_mut("ingress_filter")?.try_into()?;
// load the program into the kernel
ingress.load()?;
// attach th program to the root cgroup. `ingress_filter` will be called for all
// incoming packets.
let cgroup = File::open("/sys/fs/cgroup/unified")?;
ingress.attach(cgroup, CgroupSkbAttachType::Ingress)?;
Community
Join the conversation on Discord to discuss anything related to aya.
Contributing
Please see the contributing guide.
License
Aya is distributed under the terms of either the MIT license or the Apache License (version 2.0), at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.