Rust bindings for working with XDP programs & eBPF maps.
This library has bindings for some of the common, basic operations needed when working with XDP programs & eBPF maps from user-space. It is built on top of libbpf-sys. At the time of writing, it supports only a subset of all the possibe eBPF map types (see tests directory for a good indication of which maps are supported).
```rust use rxdp;
let objpath = "/path/to/elf/file"; let obj = match rxdp::XDPObject::new(objpath) { Ok(obj) => { println!("Successfully created object from {}", obj_path); obj }, Err(err) => panic!("{:?}", err), }; ```
Maps that have already been pinned will be loaded from the fs, provided the map name
matches the name in the fs. Any new maps in the HashSet will set the pin path so that
once the program is loaded, they will get automatically pinned.
rust
let mut pinned_maps = HashSet::new();
pinned_maps.insert("my_map_name".to_string());
obj.pinned_maps(pinned_maps).unwrap();
This will consume the XDPObject created above and return an XDPLoadedObject.
rust
let obj = obj.load().unwrap();
```rust let dev = "eth0"; let flags = rxdp::AttachFlags::SKB_MODE;
let prog = obj.getprogram("progname").unwrap(); match prog.attachtointerface(dev, flags) { Ok(_) => println!("Successfully attached to {}", dev), Err(e) => panic!("{:?}", e), } ```
Maprust
let m: rxdp::Map<u32, u64> = match rxdp::Map::new(&obj, "map_name") {
Ok(m) => m,
Err(e) => panic!("{:?}", e),
};
NOTE: the key/value sizes MUST match the key/value sizes defined in the eBPF code, otherwise creating the map will fail.
```rust use rxdp::MapLike;
let key = 0u32; let value = 1000u64; m.update(&key, &value, rxdp::MapFlags::BpfAny).unwrap(); let got = m.lookup(&key).unwrap(); asserteq!(value, got.intosingle());
// iterate through all items for kv in m.items().unwrap() { println!("key: {}, value: {}", kv.key, kv.value.into_single()); } ```
PerCpuMaprust
let m: rxdp::PerCpuMap<u32, u64> = rxdp::PerCpuMap::new(&obj, "map_name").unwrap();
NOTE: the key size MUST match the key size defined in the eBPF code, otherwise creating the map will fail.
Per CPU maps return the MapValue::Multi(Vec<T>) variant during lookup, one for each possible CPU:
```rust
use rxdp::MapLike;
let key = 0u32; let value = 1000u64; m.update(&key, &value, rxdp::MapFlags::BpfAny).unwrap(); let got = m.lookup(&key).unwrap(); asserteq!(got.intovec(), vec![value; rxdp::num_cpus()]);
// iterate through all items for kv in m.items().unwrap() { println!("key: {}", kv.key); for v in kv.value.into_vec() { println!("value: {}", v); } } ```
Perf events sent from eBPF can be retrieved via PerfMap.
```rust
let mut perfmap = rxdp::PerfMap::
// Wait for events on the receiver side of the channel loop { r.recv().maporelse( |e| println!("error: {:?}", e), |event| println!("event: {:?}", event), ); } ```
If the kernel supports it, you can do batch operations for update/lookups:
rust
if rxdp::is_batching_supported() {
let mut next_key = None;
let r = m.lookup_batch(10u32, next_key).unwrap();
// do something with r.items...
next_key = r.next_key;
}
Running tests requires root access, so it's best to run them in a Docker container:
sh
make docker-test
Running benchmarks requires root access, so it's best to run them in a Docker container:
sh
make docker-bench
This crate is released under MIT license and has the following third party dependencies:
| | Website | License | Linkage |
|----------------|--------------------------------------------------------------------------------|------------------------------------------|---------|
| libbpf-sys | github.com/alexforster/libbpf-sys | BSD-2-Clause | Static |
| libbpf | github.com/libbpf/libbpf | LGPL-2.1-only OR BSD-2-Clause | Static |
| libelf | sourceware.org/elfutils | LGPL-2.1-or-later OR LGPL-3.0-or-later | Dynamic |
| zlib | zlib.net | Zlib | Dynamic |