You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
aya/aya-log
Dave Tucker e899c8e408 WIP: Reduce Explosion of Aya Error Types
I have been down a rabbit hole of cleaning up the aya error types 😅

Most of the important changes are in `errors.rs`.

TL;DR

Current exposed types are:

- `EbpfError`
- `ProgramError`
- `MapError`
- `LinkError`
- `PerfBufferError`
- `SysError`

Honestly I'm still thinking about how we could collapse those types.
Either into a single type, or at least fewer than we expose today.

Within each of those types, I've tried to remove any invariants
that don't have any business being public (e.g if a syscall fails
with -EINVAL, there is nothing at runtime you can do about it
other than bailing).

👆 (and the spaghetti of errors depending on other errors) are
replaced by an `Other` invariant that's a Box<dyn std::error::Error>.

There are still some `pub(crate) XInternalError` types, but these
are used only to make nice error messages. This could plausibly be
replaced with anyhow/context etc.. But I've left it as-is for now.

Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
6 months ago
..
src WIP: Reduce Explosion of Aya Error Types 6 months ago
CHANGELOG.md Release aya-log v0.2.1 7 months ago
Cargo.toml Release aya-log v0.2.1 7 months ago
README.md feat(aya-log): Rename BpfLogger to EbpfLogger 1 year ago
release.toml Re-organize into a single workspace 3 years ago

README.md

aya-log - a logging library for eBPF programs

Overview

aya-log is a logging library for eBPF programs written using aya. Think of it as the log crate for eBPF.

Installation

User space

Add aya-log to Cargo.toml:

[dependencies]
aya-log = { git = "https://github.com/aya-rs/aya", branch = "main" }

eBPF side

Add aya-log-ebpf to Cargo.toml:

[dependencies]
aya-log-ebpf = { git = "https://github.com/aya-rs/aya", branch = "main" }

Example

Here's an example that uses aya-log in conjunction with the env_logger crate to log eBPF messages to the terminal.

User space code

use aya_log::EbpfLogger;

env_logger::init();

// Will log using the default logger, which is TermLogger in this case
EbpfLogger::init(&mut bpf).unwrap();

eBPF code

use aya_log_ebpf::info;

fn try_xdp_firewall(ctx: XdpContext) -> Result<u32, ()> {
    if let Some(port) = tcp_dest_port(&ctx)? {
        if block_port(port) {
            info!(&ctx, "❌ blocked incoming connection on port: {}", port);
            return Ok(XDP_DROP);
        }
    }

    Ok(XDP_PASS)
}