libbpf-rs 0.26.2

libbpf-rs is a safe, idiomatic, and opinionated wrapper around libbpf-sys
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

use core::ffi::c_ulong;
use std::io::Error;
use std::io::Read;
use std::mem;
use std::os::fd::AsRawFd;
use std::os::fd::{self};
use std::result::Result;

use crate::libbpf_sys::bpf_prog_stream_read_opts;

/// [`Stream`] instances.
///
/// `streams`s are BPF descriptors that provide a character output
/// interface from the BPF program to userspace.
#[derive(Debug)]
pub(crate) struct Stream<'a> {
    prog_fd: fd::BorrowedFd<'a>,
    stream_id: u32,
}

impl<'a> Stream<'a> {
    /// Default BPF stdout stream id.
    pub(crate) const BPF_STDOUT: u32 = 1;
    /// Default BPF stderr stream id.
    pub(crate) const BPF_STDERR: u32 = 2;

    /// Create a new Stream instance.
    pub(crate) fn new(prog_fd: fd::BorrowedFd<'a>, stream_id: u32) -> Self {
        Stream { prog_fd, stream_id }
    }
}

impl Read for Stream<'_> {
    /// Fill in a caller-provided buffer with contents from the stream.
    fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error> {
        let ret = unsafe {
            let mut c_opts = bpf_prog_stream_read_opts {
                sz: mem::size_of::<bpf_prog_stream_read_opts>() as c_ulong,
            };
            libbpf_sys::bpf_prog_stream_read(
                self.prog_fd.as_raw_fd(),
                self.stream_id,
                buf.as_mut_ptr().cast(),
                buf.len().try_into().unwrap(),
                &raw mut c_opts,
            )
        };
        if ret < 0 {
            return Err(Error::last_os_error());
        }

        Ok(ret as usize)
    }
}