Go to file
Michal Rostecki 94bc93ea07
Merge pull request from abhijeetbhagat/fix-warnings
fix all clippy warnings
.cargo Re-organize into a single workspace
.github bpf: Only use never type with rust nightly
.vim Re-organize into a single workspace
.vscode Re-organize into a single workspace
assets readme: Add crabby, sync with aya/README.md
aya Merge pull request from abhijeetbhagat/fix-warnings
aya-bpf-macros ebpf: Add TcContext for classifier programs
aya-log aya-log: Make miri happy
aya-log-common aya-log, aya-log-common: start next development iteration 0.1.12-dev.0
aya-log-ebpf-macros aya-log-ebpf-macros: Fix the DisplayHint expression names
aya-log-parser lib: Add display hints
aya-tool cargo: Remove unused dependencies
bpf fix all clippy warnings
test integration-test: Change `assert_loaded` to a macro with timeouts
xtask cargo: Remove unused dependencies
.gitignore xtask: Fix docs generation
CODE_OF_CONDUCT.md Add a Code of Conduct
CONTRIBUTING.md Remove docs. Update URLs to aya-rs
Cargo.toml aya-gen: Rename to aya-tool
LICENSE-APACHE Add license files
LICENSE-MIT Add license files
README.md Change from Rust edition 2018 to 2021
netlify.toml Re-organize into a single workspace
release.toml Re-organize into a single workspace
rustfmt.toml Add rustfmt.toml

README.md

Aya

Crates.io License Build status Book

API Documentation

Unreleased Documentation Documentaiton

Community

Discord Awesome

Join the conversation on Discord to discuss anything related to Aya, or discover and contribute to a list of Awesome Aya 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 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 the 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)?;

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.