libbpf_rs/
lib.rs

1//! # libbpf-rs
2//!
3//! `libbpf-rs` is a safe, idiomatic, and opinionated wrapper around
4//! [libbpf](https://github.com/libbpf/libbpf/).
5//!
6//! libbpf-rs, together with `libbpf-cargo` (libbpf cargo plugin) allow you
7//! to write Compile-Once-Run-Everywhere (CO-RE) eBPF programs. Note this document
8//! uses "eBPF" and "BPF" interchangeably.
9//!
10//! More information about CO-RE is [available
11//! here](https://facebookmicrosites.github.io/bpf/blog/2020/02/19/bpf-portability-and-co-re.html).
12//!
13//! ## High level workflow
14//!
15//! 1. Create new rust project (via `cargo new` or similar) at path `$PROJ_PATH`
16//! 2. Create directory `$PROJ_PATH/src/bpf`
17//! 3. Write CO-RE bpf code in `$PROJ_PATH/src/bpf/${MYFILE}.bpf.c`, where `$MYFILE` may be any
18//!    valid filename. Note the `.bpf.c` extension is required.
19//! 4. Create a [build script](https://doc.rust-lang.org/cargo/reference/build-scripts.html) that
20//!    builds and generates a skeleton module using `libbpf_cargo::SkeletonBuilder`
21//! 5. Write your userspace code by importing and using the generated module. Import the
22//!    module by using the [path
23//!    attribute](https://doc.rust-lang.org/reference/items/modules.html#the-path-attribute).
24//!    Your userspace code goes in `$PROJ_PATH/src/` as it would in a normal rust project.
25//! 6. Continue regular rust workflow (ie `cargo build`, `cargo run`, etc)
26//!
27//! ## Alternate workflow
28//!
29//! While using the skeleton is recommended, it is also possible to directly use libbpf-rs.
30//!
31//! 1. Follow steps 1-3 of "High level workflow"
32//! 2. Generate a BPF object file. Options include manually invoking `clang`, creating a build
33//!    script to invoke `clang`, or using `libbpf-cargo` cargo plugins.
34//! 3. Write your userspace code in `$PROJ_PATH/src/` as you would a normal rust project and point
35//!    libbpf-rs at your BPF object file
36//! 4. Continue regular rust workflow (ie `cargo build`, `cargo run`, etc)
37//!
38//! ## Design
39//!
40//! libbpf-rs models various "phases":
41//! ```text
42//!                from_*()        load()
43//!                  |               |
44//!                  v               v
45//!    ObjectBuilder ->  OpenObject  -> Object
46//!                          ^            ^
47//!                          |            |
48//!              <pre-load modifications> |
49//!                                       |
50//!                            <post-load interactions>
51//! ```
52//!
53//! The entry point into libbpf-rs is [`ObjectBuilder`]. `ObjectBuilder` helps open the BPF object
54//! file. After the object file is opened, you are returned an [`OpenObject`] where you can
55//! perform all your pre-load operations. Pre-load means before any BPF maps are created or BPF
56//! programs are loaded and verified by the kernel. Finally, after the BPF object is loaded, you
57//! are returned an [`Object`] instance where you can read/write to BPF maps, attach BPF programs
58//! to hooks, etc.
59//!
60//! You _must_ keep the [`Object`] alive the entire duration you interact with anything inside the
61//! BPF object it represents. This is further documented in [`Object`] documentation.
62//!
63//! ## Example
64//!
65//! This is probably the best way to understand how libbpf-rs and libbpf-cargo work together.
66//!
67//! [See example here](https://github.com/libbpf/libbpf-rs/tree/master/examples/runqslower).
68
69pub mod btf;
70mod error;
71mod iter;
72mod link;
73mod linker;
74mod map;
75mod netfilter;
76mod object;
77mod perf_buffer;
78mod print;
79mod program;
80pub mod query;
81mod ringbuf;
82mod skeleton;
83mod streams;
84mod tc;
85mod tracepoint;
86mod user_ringbuf;
87mod util;
88mod xdp;
89
90pub use libbpf_sys;
91
92pub use crate::btf::Btf;
93pub use crate::btf::HasSize;
94pub use crate::btf::ReferencesType;
95pub use crate::error::Error;
96pub use crate::error::ErrorExt;
97pub use crate::error::ErrorKind;
98pub use crate::error::Result;
99pub use crate::iter::Iter;
100pub use crate::link::Link;
101pub use crate::linker::Linker;
102pub use crate::map::BatchedMapIter;
103pub use crate::map::Map;
104pub use crate::map::MapCore;
105pub use crate::map::MapFlags;
106pub use crate::map::MapHandle;
107pub use crate::map::MapImpl;
108pub use crate::map::MapInfo;
109pub use crate::map::MapKeyIter;
110pub use crate::map::MapMut;
111pub use crate::map::MapType;
112pub use crate::map::OpenMap;
113pub use crate::map::OpenMapImpl;
114pub use crate::map::OpenMapMut;
115pub use crate::netfilter::NetfilterOpts;
116pub use crate::netfilter::NFPROTO_IPV4;
117pub use crate::netfilter::NFPROTO_IPV6;
118pub use crate::netfilter::NF_INET_FORWARD;
119pub use crate::netfilter::NF_INET_LOCAL_IN;
120pub use crate::netfilter::NF_INET_LOCAL_OUT;
121pub use crate::netfilter::NF_INET_POST_ROUTING;
122pub use crate::netfilter::NF_INET_PRE_ROUTING;
123pub use crate::object::AsRawLibbpf;
124pub use crate::object::MapIter;
125pub use crate::object::Object;
126pub use crate::object::ObjectBuilder;
127pub use crate::object::OpenObject;
128pub use crate::object::ProgIter;
129pub use crate::perf_buffer::PerfBuffer;
130pub use crate::perf_buffer::PerfBufferBuilder;
131pub use crate::print::get_print;
132pub use crate::print::set_print;
133pub use crate::print::PrintCallback;
134pub use crate::print::PrintLevel;
135pub use crate::program::CgroupIterOpts;
136pub use crate::program::CgroupIterOrder;
137pub use crate::program::Input as ProgramInput;
138pub use crate::program::IterOpts;
139pub use crate::program::KprobeMultiOpts;
140pub use crate::program::KprobeOpts;
141pub use crate::program::MapIterOpts;
142pub use crate::program::OpenProgram;
143pub use crate::program::OpenProgramImpl;
144pub use crate::program::OpenProgramMut;
145pub use crate::program::Output as ProgramOutput;
146pub use crate::program::PerfEventOpts;
147pub use crate::program::Program;
148pub use crate::program::ProgramAttachType;
149pub use crate::program::ProgramImpl;
150pub use crate::program::ProgramMut;
151pub use crate::program::ProgramType;
152pub use crate::program::UprobeMultiOpts;
153pub use crate::program::UprobeOpts;
154pub use crate::program::UsdtOpts;
155pub use crate::ringbuf::RingBuffer;
156pub use crate::ringbuf::RingBufferBuilder;
157pub use crate::tc::TcAttachPoint;
158pub use crate::tc::TcHook;
159pub use crate::tc::TcHookBuilder;
160pub use crate::tc::TC_CUSTOM;
161pub use crate::tc::TC_EGRESS;
162pub use crate::tc::TC_H_CLSACT;
163pub use crate::tc::TC_H_INGRESS;
164pub use crate::tc::TC_H_MIN_EGRESS;
165pub use crate::tc::TC_H_MIN_INGRESS;
166pub use crate::tc::TC_INGRESS;
167pub use crate::tracepoint::RawTracepointOpts;
168pub use crate::tracepoint::TracepointCategory;
169pub use crate::tracepoint::TracepointOpts;
170pub use crate::user_ringbuf::UserRingBuffer;
171pub use crate::user_ringbuf::UserRingBufferSample;
172pub use crate::util::num_possible_cpus;
173pub use crate::xdp::Xdp;
174pub use crate::xdp::XdpFlags;
175
176/// An unconstructible dummy type used for tagging mutable type
177/// variants.
178#[doc(hidden)]
179#[derive(Copy, Clone, Debug)]
180pub enum Mut {}
181
182
183/// Used for skeleton -- an end user may not consider this API stable
184#[doc(hidden)]
185pub mod __internal_skel {
186    pub use super::skeleton::*;
187}
188
189/// Skeleton related definitions.
190pub mod skel {
191    pub use super::skeleton::OpenSkel;
192    pub use super::skeleton::Skel;
193    pub use super::skeleton::SkelBuilder;
194}
libbpf_rs/lib.rs

libbpf_rs/
lib.rs
