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.

History

Michal Rostecki 28abaece2a Fix the log buffer bounds Change 821ba0b243fd removed the `size > buf.len()` check, which was a mistake, because we might write to a subslice of the whole buffer, so then `buf` can be lower than `LOG_BUF_CAPACITY`. This change compares `size` with `min::(buf.len(), LOG_BUF_CAPACITY)` instead. Fixes: 821ba0b243fd ("Ensure log buffer bounds") Signed-off-by: Michal Rostecki <vadorovsky@gmail.com>		2 years ago
..
.cargo	git add .cargo and xtask	2 years ago
.github	Add CI	2 years ago
.vim	Add vim/vscode rust-analyzer settings	2 years ago
.vscode	Add vim/vscode rust-analyzer settings	2 years ago
aya-log	aya-log, aya-log-common: start next development iteration 0.1.11-dev.0	2 years ago
aya-log-common	Fix the log buffer bounds	2 years ago
ebpf	ebpf: use new PerCpuArray::get_ptr_mut API	2 years ago
xtask	Add rustfmt.toml	2 years ago
.gitignore	Initial commit	2 years ago
Cargo.toml	Initial commit	2 years ago
README.md	Simplify BpfLogger::init	2 years ago
release.toml	Add cargo-release config	2 years ago
rustfmt.toml	Add rustfmt.toml	2 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-log", branch = "main" }

eBPF side

Add aya-log-ebpf to Cargo.toml:

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

Example

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

User space code

use simplelog::{ColorChoice, ConfigBuilder, LevelFilter, TermLogger, TerminalMode};
use aya_log::BpfLogger;

TermLogger::init(
    LevelFilter::Debug,
    ConfigBuilder::new()
        .set_target_level(LevelFilter::Error)
        .set_location_level(LevelFilter::Error)
        .build(),
    TerminalMode::Mixed,
    ColorChoice::Auto,
)
.unwrap();

// Will log using the default logger, which is TermLogger in this case
BpfLogger::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)
}