dpdk-stdlib-sys 0.2.0

Raw FFI bindings for DPDK with stub support for building without DPDK installed
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
55
56

# dpdk-stdlib-sys

Raw FFI bindings for DPDK with stub support for building without DPDK installed.

## Overview

This crate provides low-level Rust FFI bindings to the [DPDK](https://www.dpdk.org/) C library. It uses `bindgen` to generate bindings when DPDK is installed, and ships with complete stub implementations so everything compiles and tests pass on any platform — no DPDK required.

## How It Works

The build script (`build.rs`) auto-detects DPDK via `pkg-config`:

- **DPDK found**: Generates real FFI bindings via bindgen, links against DPDK libraries.
- **DPDK not found**: Compiles stub implementations that return safe defaults (empty MAC addresses, zero-length bursts, successful init).

Check at runtime which mode is active:

```rust
if dpdk_sys::is_stub() {
    println!("Running with stubs (no real DPDK)");
}

if dpdk_sys::is_real_dpdk() {
    println!("Running with real DPDK");
}
```

## Usage

This crate is a dependency of [`dpdk-stdlib`](https://crates.io/crates/dpdk-stdlib) and is not typically used directly. If you need raw DPDK FFI access:

```toml
[dependencies]
dpdk-stdlib-sys = "0.1"
```

## Covered DPDK APIs

- EAL initialization and cleanup (`rte_eal_init`, `rte_eal_cleanup`)
- Ethernet device management (`rte_eth_dev_*`)
- Mbuf and mempool operations (`rte_pktmbuf_*`, `rte_mempool_*`)
- RX/TX burst functions (`rte_eth_rx_burst`, `rte_eth_tx_burst`)
- Promiscuous and allmulticast mode
- Device statistics
- MAC address retrieval

## Platform Support

| Platform | Stubs | Real DPDK |
|----------|-------|-----------|
| macOS | Yes | No |
| Linux | Yes | Yes |

## License

MIT