rust: support DPDK API

From: Gregory Etelson <[email protected]>
Sent: Thursday, March 6, 2025 1:37 PM
To: [email protected] <[email protected]>
Cc: [email protected] <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>; Richardson, Bruce <[email protected]>
Subject: [PATCH] rust: support DPDK API

The patch converts include files with DPDK API to RUST and binds new RUST API files info dpdklib package.

The RUST dpdklib files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdklib package as dependency in Cargo.toml file.

RUST dpdklib package is installed into
MESON_INSTALL_DESTDIR_PREFIX/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

RUST dpdklib installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create MESON_INSTALL_DESTDIR_PREFIX/rust directory.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

Signed-off-by Gregory Etelson <[email protected]>

Quoted 6 lines

From: Gregory Etelson <[email protected]>
Sent: Thursday, March 6, 2025 1:37 PM
To: [email protected] <[email protected]>
Cc: [email protected] <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>; Richardson, Bruce <[email protected]>
Subject: [PATCH] rust: support DPDK API

Cool, I like this subject, great!

Quoted 17 lines

The patch converts include files with DPDK API to RUST and binds new RUST API files info dpdklib package.

The RUST dpdklib files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdklib package as dependency in Cargo.toml file.

RUST dpdklib package is installed into
MESON_INSTALL_DESTDIR_PREFIX/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

Quoted 5 lines

RUST dpdklib installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create MESON_INSTALL_DESTDIR_PREFIX/rust directory.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

Interesting approach to automate it; are there specific reasons that this approach was taken, or did this just seem the easiest/best way to include "Rust support" into upstream DPDK? Alternatives could be (*not* suggesting to rework the patch!) a dpdk-sys
crate where the bindgen etc is done externally to DPDK itself. Many existing approaches (some examples: https://youtu.be/lb6xn2xQ-NQ?t=130) use that method.

I kind of like (this approach) of having the binding generation upstream with DPDK itself; it makes the Rust support upstream and keeps it close to DPDK... however it means that it is "the one" official/DPDK-community-approved library/crate.

There's some nice tidy-ups to cleanup the namespaces possible if this is "the crate". Perhaps (sorry, borderline bikeshed-topics..) renames for clarity & readability, e.g.:
dpdklib::rte_eal::rte_eal_init()

to
dpdk::eal::init()

Quoted 1 line

Signed-off-by Gregory Etelson <[email protected]>

I'll get to a testing & review in the next days, however I'd like to ask some bigger picture questions, to understand/provide input on approach, and how big an effor to expect here! See above linked youtube video - I had sketched out some API concepts for exposing a "safe Rust API" wrapper around the DPDK C API, which also encodes threading requirements.

Some questions:
- Is there an overaching "we're trying to achieve X with Rust", or specifically "safe Rust"?
- Is this patch the "get DPDK + Rust working", with follow up patches for "safe wrappers" the intention?
- Or is this patch all to expect for now?

Again, thanks for the patch, I think Rust is important for DPDK & infrastructure software, and will try make time to help test/review/discuss this patch, and the wider Rust effort!

Regards, -Harry

<snip code itself>

From: Gregory Etelson <[email protected]>
Sent: Thursday, March 6, 2025 1:37 PM
To: [email protected] <[email protected]>
Cc: [email protected] <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>; Richardson, Bruce <[email protected]>
Subject: [PATCH] rust: support DPDK API

The patch converts include files with DPDK API to RUST and binds new RUST API files info dpdklib package.

The RUST dpdklib files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdklib package as dependency in Cargo.toml file.

RUST dpdklib package is installed into
MESON_INSTALL_DESTDIR_PREFIX/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

RUST dpdklib installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create MESON_INSTALL_DESTDIR_PREFIX/rust directory.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

Signed-off-by Gregory Etelson <[email protected]>

---
 buildtools/meson.build               |   4 +
 buildtools/rust-env.sh               |  78 +++++++++++
 examples/rust/helloworld/Cargo.lock  |  14 ++
 examples/rust/helloworld/Cargo.toml  |   7 +
 examples/rust/helloworld/build.rs    |  21 +++
 examples/rust/helloworld/src/main.rs | 197 +++++++++++++++++++++++++++
 meson_options.txt                    |   2 +
 7 files changed, 323 insertions(+)
 create mode 100755 buildtools/rust-env.sh
 create mode 100644 examples/rust/helloworld/Cargo.lock
 create mode 100644 examples/rust/helloworld/Cargo.toml
 create mode 100644 examples/rust/helloworld/build.rs
 create mode 100644 examples/rust/helloworld/src/main.rs

buildtools/meson.build +4 -0

index 4e2c1217a2..dd16567f51 100644
@@ -50,3 +50,7 @@ else
     pmdinfo += 'ar'
     pmdinfogen += 'elf'
 endif
+
+if get_option('enable_rust')
+    meson.add_install_script('rust-env.sh')
+endif

buildtools/rust-env.sh new file +17 -0

new file mode 100755
index 0000000000..705bc0d95b
@@ -0,0 +1,78 @@
+#! /bin/sh
+
+# Convert DPDK API files into RUST.
+# DPDK files selection is on demand.
+#
+# The coversion is done in 4 stages:
+# 1. Preparation [Optional]
+#    Due to the bindgen conversion utility limitations source file may need
+#    manual adjustment.
+# 2. Preprocessing [Mandatory]
+#    Run preprocessor on a source file before conversion.
+# 3. Conversion [Mandatory]
+#    Convert preprocessed C file into RUST file
+# 4. Post translation [Optional]
+#    Manually fix translation.
+
+# DPDK files list

buildtools/rust-env.sh new file +20 -0

+include_dir="${MESON_INSTALL_DESTDIR_PREFIX}/include"
+
+if test -d "$rust_dir"; then
+  rm -rf "$rust_dir"
+fi
+
+mkdir -p "$rust_dir/src"
+if ! test -d "$rust_dir"; then
+  echo "failed to create Rust library $rust_dir"
+  exit 255
+fi
+touch "$rust_dir/src/lib.rs"
+
+bindgen_opt='--no-layout-tests --no-derive-debug'
+bindgen_clang_opt='-Wno-unused-command-line-argument'
+
+create_rust_lib ()
+{
+  base=$1
+

buildtools/rust-env.sh new file +5 -0

+  bindgen $bindgen_opt --output $rust_dir/src/$base.rs /tmp/$base.i -- $bindgen_clang_opt
+  rm -f /tmp/$base.i /tmp/$base.h
+}
+
+for file in $files; do

examples/rust/helloworld/Cargo.lock new file +14 -0

new file mode 100644
index 0000000000..d18af80c66
@@ -0,0 +1,14 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "dpdklib"
+version = "25.3.0-rc1"
+
+[[package]]
+name = "helloworld"
+version = "0.1.0"
+dependencies = [
+ "dpdklib",
+]

examples/rust/helloworld/Cargo.toml new file +0 -0

new file mode 100644
index 0000000000..7f9a77968a

examples/rust/helloworld/build.rs new file +11 -0

new file mode 100644
index 0000000000..5c76188e18
@@ -0,0 +1,21 @@
+use std::process::Command;
+
+pub fn main() {
+    let mut pkgconfig = Command::new("pkg-config");
+
+    match pkgconfig.args(["--libs", "libdpdk"]).output() {
+        Ok (output) => {
+            let stdout = String::from_utf8_lossy(&output.stdout).trim_end().to_string();
+            for token in stdout.split_ascii_whitespace().filter(|s| !s.is_empty()) {
+                if token.starts_with("-L") {
+                    println!("cargo::rustc-link-search=native={}", &token[2..]);

examples/rust/helloworld/src/main.rs new file +4 -0

new file mode 100644
index 0000000000..cf666aece6
@@ -0,0 +1,197 @@
+/// Usage: helloworld -a <port 1 params> -a <port 2 params> ...
+
+use std::env;
+use std::ffi::{CString};

examples/rust/helloworld/src/main.rs new file +35 -0

+    RTE_ETH_NAME_MAX_LEN,
+    RTE_ETH_DEV_NO_OWNER,
+    RTE_ETH_RSS_IP,
+    rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_RSS,
+    rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_VMDQ_DCB_RSS,
+
+    // Structures
+    rte_eth_dev_info,
+    rte_eth_conf,
+    rte_eth_txconf,
+    rte_eth_rxconf,
+
+    // Functions
+    rte_eth_dev_get_name_by_port,
+    rte_eth_find_next_owned_by,
+    rte_eth_dev_info_get,
+    rte_eth_dev_configure,
+    rte_eth_tx_queue_setup,
+    rte_eth_rx_queue_setup,
+    rte_eth_dev_start,
+};
+
+use dpdklib::rte_build_config::{
+    RTE_MAX_ETHPORTS,
+};
+
+use dpdklib::rte_mbuf::{
+    rte_pktmbuf_pool_create,
+};
+
+use dpdklib::rte_mbuf_core::{
+    RTE_MBUF_DEFAULT_BUF_SIZE
+};
+
+pub type DpdkPort = u16;

examples/rust/helloworld/src/main.rs new file +26 -0

+        Port {
+            port_id:id,
+            dev_info: unsafe {
+                let uninit: ::std::mem::MaybeUninit<rte_eth_dev_info> = ::std::mem::MaybeUninit::zeroed().assume_init();
+                *uninit.as_ptr()
+            },
+            dev_conf: unsafe {
+                let uninit: ::std::mem::MaybeUninit<rte_eth_conf> = ::std::mem::MaybeUninit::zeroed().assume_init();
+                *uninit.as_ptr()
+            },
+            rxq_num:1,
+            txq_num:1,
+        }
+    }
+}
+
+pub unsafe fn iter_rte_eth_dev_owned_by(owner_id:u64) -> impl Iterator<Item=DpdkPort> {
+    let mut port_id:DpdkPort = 0 as DpdkPort;
+    std::iter::from_fn(move || {
+        let cur = port_id;
+        port_id = unsafe {
+            rte_eth_find_next_owned_by(cur, owner_id) as DpdkPort
+        };
+        if port_id == RTE_MAX_ETHPORTS as DpdkPort {
+            return None
+        }

examples/rust/helloworld/src/main.rs new file +23 -0

+pub unsafe fn init_port_config(port: &mut Port) {
+    let ret = unsafe {
+        rte_eth_dev_info_get(port.port_id, &mut port.dev_info as *mut rte_eth_dev_info)
+    };
+    if ret != 0 {
+        panic!("port-{}: failed to get dev info {ret}", port.port_id);
+    }
+
+    port.dev_conf.rx_adv_conf.rss_conf.rss_key = std::ptr::null_mut();
+    port.dev_conf.rx_adv_conf.rss_conf.rss_hf = if port.rxq_num > 1 {
+        RTE_ETH_RSS_IP as u64 & port.dev_info.flow_type_rss_offloads
+    } else {0};
+
+    if port.dev_conf.rx_adv_conf.rss_conf.rss_hf != 0 {
+        port.dev_conf.rxmode.mq_mode =
+            rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_VMDQ_DCB_RSS & rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_RSS;
+    }
+}
+
+pub unsafe fn show_ports_summary(ports: &Vec<Port>) {
+    let mut name_buf:[c_char;RTE_ETH_NAME_MAX_LEN as usize]= [0 as c_char;RTE_ETH_NAME_MAX_LEN as usize];
+    let title = format!("{:<4}    {:<32} {:<14}", "Port", "Name", "Driver");
+    println!("{title}");

examples/rust/helloworld/src/main.rs new file +29 -0

+unsafe fn start_port(port:&mut Port) {
+    let mut rc = unsafe {
+      rte_eth_dev_configure(port.port_id, port.rxq_num, port.txq_num,
+                            &port.dev_conf as *const rte_eth_conf)
+    };
+    if rc != 0 { panic!("failed to configure port-{}: {rc}", port.port_id)}
+    println!("port-{} configured", port.port_id);
+
+    rc = unsafe {
+      rte_eth_tx_queue_setup(port.port_id, 0, 64, 0, 0 as *const rte_eth_txconf)
+    };
+    if rc != 0 { panic!("port-{}: failed to configure TX queue 0 {rc}", port.port_id)}
+    println!("port-{} configured TX queue 0", port.port_id);
+
+    let mbuf_pool_name = CString::new(format!("mbuf pool port-{}", port.port_id)).unwrap();
+    let mbuf_pool : *mut dpdklib::rte_mbuf::rte_mempool = unsafe {
+        rte_pktmbuf_pool_create(mbuf_pool_name.as_ptr(), 1024, 0, 0,
+                                RTE_MBUF_DEFAULT_BUF_SIZE as u16, 0)
+    };
+    if mbuf_pool  == 0 as *mut dpdklib::rte_mbuf::rte_mempool {
+        panic!("port-{}: failed to allocate mempool {rc}", port.port_id)
+    }
+    println!("port-{} mempool ready", port.port_id);
+
+    let mut rxq_conf:rte_eth_rxconf = port.dev_info.default_rxconf.clone();
+    rxq_conf.offloads = 0;
+    rc = unsafe {
+        rte_eth_rx_queue_setup(port.port_id, 0, 64, 0,
+                               &mut rxq_conf as *mut rte_eth_rxconf,

examples/rust/helloworld/src/main.rs new file +18 -0

+fn main() {
+
+    let mut argv: Vec<*mut c_char> = env::args()
+        .map(|arg| CString::new(arg).unwrap().into_raw()).collect();
+
+    let rc = unsafe {
+        rte_eal_init(env::args().len() as c_int, argv.as_mut_ptr())
+    };
+    if rc == -1 {
+        unsafe { rte_eal_cleanup(); }
+    }
+
+    let mut ports:Vec<Port> = vec![];
+    unsafe {
+        for port_id in iter_rte_eth_dev()
+            .take(dpdklib::rte_build_config::RTE_MAX_ETHPORTS as usize) {
+            let mut port = Port::new(port_id);
+            init_port_config(&mut port);

meson_options.txt +2 -1

index e49b2fc089..d37b9ba1dc 100644
@@ -60,3 +60,5 @@ option('tests', type: 'boolean', value: true, description:
        'build unit tests')
 option('use_hpet', type: 'boolean', value: false, description:
        'use HPET timer in EAL')
+option('enable_rust', type: 'boolean', value: false, description:
+       'enable RUST')
--

2.45.2

Quoted 5 lines

From: Gregory Etelson <[email protected]>
Sent: Thursday, March 6, 2025 1:37 PM
To: [email protected] <[email protected]>
Cc: [email protected] <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>; Richardson, Bruce <[email protected]>
Subject: [PATCH] rust: support DPDK API

+

Quoted 1 line

+use dpdklib::rte_ethdev::{

As per first reply, I'd like to see the end-result safe-Rust namespacing be shortened.

This can be easily done by renaming the name= in Cargo.toml, and removing the "rte_" prefix at bindgen output stage for each file. dpdk::ethdev:: { RTE_ETH_NAME_MAX_LEN, ... };

Perhaps its a good method to put the generated (unsafe, raw-C-bindings) in this namespace, and build a safe crate (with the dpdk::ethdev::* namespacing) over it. Thoughts?

External email: Use caution opening links or attachments

Quoted 6 lines · Harry

Quoted 5 lines

From: Gregory Etelson <[email protected]>
Sent: Thursday, March 6, 2025 1:37 PM
To: [email protected] <[email protected]>
Cc: [email protected] <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>; Richardson, Bruce <[email protected]>
Subject: [PATCH] rust: support DPDK API

<snip>

Quoted 5 lines

+

Quoted 1 line

+use dpdklib::rte_ethdev::{

As per first reply, I'd like to see the end-result safe-Rust namespacing be shortened.

Quoted 8 lines

This can be easily done by renaming the name= in Cargo.toml, and removing the "rte_" prefix at bindgen output stage for each file. dpdk::ethdev:: { RTE_ETH_NAME_MAX_LEN, ... };

Perhaps its a good method to put the generated (unsafe, raw-C-bindings) in this namespace, and build a safe crate (with the dpdk::ethdev::* namespacing) over it. Thoughts?

I love naming discussions :-)

+1 to separate namespaces for low-level DPDK wraps, and more rustic higher-level APIs. However, that doesn't mean that the names get to be ugly! Let's definitely remove the "lib" in dpdklib (or libdpdk), and the "rte_" prefix from libs.

How about having "dpdk::raw::*" e.g. "dpdk::raw::ethdev" for low-level wraps and "dpdk::*" e.g. "dpdk::ethdev" for higher level apis?

/Bruce

External email: Use caution opening links or attachments

Quoted 5 lines

From: Gregory Etelson <[email protected]>
Sent: Thursday, March 6, 2025 1:37 PM
To: [email protected] <[email protected]>
Cc: [email protected] <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>; Richardson, Bruce <[email protected]>
Subject: [PATCH] rust: support DPDK API

More in-depth review in this reply..

Quoted 17 lines

The patch converts include files with DPDK API to RUST and binds new RUST API files info dpdklib package.

The RUST dpdklib files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdklib package as dependency in Cargo.toml file.

RUST dpdklib package is installed into
MESON_INSTALL_DESTDIR_PREFIX/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

Quoted 5 lines

RUST dpdklib installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create MESON_INSTALL_DESTDIR_PREFIX/rust directory.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

I've tested these instructions, using the default prefix = "/usr/local" This puts the rust files in "/usr/local/rust", so some tidy-up required. Debugging (or "searching for the files" was difficult - perhaps a log of the bindgen output from "rust-env.sh" would be helpful for 1st time setup?)

Quoted 53 lines

Signed-off-by Gregory Etelson <[email protected]>

---
 buildtools/meson.build               |   4 +
 buildtools/rust-env.sh               |  78 +++++++++++
 examples/rust/helloworld/Cargo.lock  |  14 ++
 examples/rust/helloworld/Cargo.toml  |   7 +
 examples/rust/helloworld/build.rs    |  21 +++
 examples/rust/helloworld/src/main.rs | 197 +++++++++++++++++++++++++++
 meson_options.txt                    |   2 +
 7 files changed, 323 insertions(+)
 create mode 100755 buildtools/rust-env.sh
 create mode 100644 examples/rust/helloworld/Cargo.lock
 create mode 100644 examples/rust/helloworld/Cargo.toml
 create mode 100644 examples/rust/helloworld/build.rs
 create mode 100644 examples/rust/helloworld/src/main.rs

buildtools/meson.build +4 -0

index 4e2c1217a2..dd16567f51 100644
@@ -50,3 +50,7 @@ else
     pmdinfo += 'ar'
     pmdinfogen += 'elf'
 endif
+
+if get_option('enable_rust')
+    meson.add_install_script('rust-env.sh')
+endif

buildtools/rust-env.sh new file +17 -0

new file mode 100755
index 0000000000..705bc0d95b
@@ -0,0 +1,78 @@
+#! /bin/sh
+
+# Convert DPDK API files into RUST.
+# DPDK files selection is on demand.
+#
+# The coversion is done in 4 stages:
+# 1. Preparation [Optional]
+#    Due to the bindgen conversion utility limitations source file may need
+#    manual adjustment.
+# 2. Preprocessing [Mandatory]
+#    Run preprocessor on a source file before conversion.
+# 3. Conversion [Mandatory]
+#    Convert preprocessed C file into RUST file
+# 4. Post translation [Optional]
+#    Manually fix translation.
+
+# DPDK files list

buildtools/rust-env.sh line 27

Quoted 10 lines

buildtools/rust-env.sh new file +10 -0

+files='
+rte_build_config.h
+rte_eal.h
+rte_ethdev.h
+rte_mbuf.h
+rte_mbuf_core.h
+rte_mempool.h
+'
+
+rust_dir="${MESON_INSTALL_DESTDIR_PREFIX}/rust"

Here "rust_dir"="/usr/local/rust" if the default prefix is used.
At least, a "dpdk" must be in there somewhere (we're not Rust itself after all!) but also different systems put files in e.g: "/usr/local/lib/x86_64-linux-gnu/dpdk"

Appending a "/rust" to the end of that is probably what was intended?

Quoted 27 lines

buildtools/rust-env.sh new file +25 -0

+include_dir="${MESON_INSTALL_DESTDIR_PREFIX}/include"
+
+if test -d "$rust_dir"; then
+  rm -rf "$rust_dir"
+fi
+
+mkdir -p "$rust_dir/src"
+if ! test -d "$rust_dir"; then
+  echo "failed to create Rust library $rust_dir"
+  exit 255
+fi
+touch "$rust_dir/src/lib.rs"
+
+bindgen_opt='--no-layout-tests --no-derive-debug'
+bindgen_clang_opt='-Wno-unused-command-line-argument'
+
+create_rust_lib ()
+{
+  base=$1
+
+  cp $include_dir/${base}.h /tmp/${base}.h
+
+# bindgen cannot process complex macro definitions
+# manually simplify macros before conversion
+  sed -i -e 's/RTE_BIT64(\([0-9]*\))/(1UL << \1)/g' /tmp/${base}.h

buildtools/rust-env.sh line 57

Quoted 5 lines

buildtools/rust-env.sh new file +5 -0

+  sed -i -e 's/RTE_BIT32(\([0-9]*\))/(1U << \1)/g' /tmp/${base}.h
+  sed -i -e 's/UINT64_C(\([0-9]*\))/\1/g' /tmp/${base}.h
+
+  # clang output has better integration with bindgen than GCC
+  clang -E -dD -I$include_dir /tmp/${base}.h > /tmp/$base.i

# Adding this helps debug the header conversion & output file locations echo "writing Rust converted header to ${rust_dir}/src/${base}.rs"

Quoted 10 lines

buildtools/rust-env.sh new file +9 -0

+  bindgen $bindgen_opt --output $rust_dir/src/$base.rs /tmp/$base.i -- $bindgen_clang_opt
+  rm -f /tmp/$base.i /tmp/$base.h
+}
+
+for file in $files; do
+  base=$(basename $file | cut -d. -f 1)
+  create_rust_lib $base
+  echo "pub mod $base;" >> "$rust_dir/src/lib.rs"
+done

buildtools/rust-env.sh line 72

Quoted 6 lines

buildtools/rust-env.sh new file +6 -0

+
+
+cat > "$rust_dir/Cargo.toml" <<EOF
+[package]
+name = "dpdklib"
+version = "$(cat $MESON_SOURCE_ROOT/VERSION | sed 's/\.0\([1-9]\)/\.\1/')"

Missing {} brackets around MESON_SOURCE_ROOT perhaps? Got an error on "/VERSION" not found.

buildtools/rust-env.sh line 78

Quoted 6 lines

buildtools/rust-env.sh new file +6 -0

+EOF
+
+# post conversion updates
+# RUST does not accept aligned structures into packed structure.
+# TODO: fix DPDK definitions.
+sed -i 's/repr(align(2))/repr(packed(2))/g'  "$rust_dir/src/rte_ethdev.rs"

Hmm, interesting, lets keep a TODO here, but as this changes the "allowable" or valid binary layouts, it is potentially going to cause differences between C and Rust's interpretation of the memory backing the structs.
TODO: investigate each struct individually, and determine if/what is really required/correct.

Quoted 31 lines

examples/rust/helloworld/Cargo.lock new file +14 -0

new file mode 100644
index 0000000000..d18af80c66
@@ -0,0 +1,14 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "dpdklib"
+version = "25.3.0-rc1"
+
+[[package]]
+name = "helloworld"
+version = "0.1.0"
+dependencies = [
+ "dpdklib",
+]

examples/rust/helloworld/Cargo.toml new file +4 -0

new file mode 100644
index 0000000000..7f9a77968a
@@ -0,0 +1,7 @@
+[package]
+name = "helloworld"
+version = "0.1.0"
+edition = "2024"

examples/rust/helloworld/Cargo.toml line 7

Quoted 4 lines

examples/rust/helloworld/Cargo.toml new file +3 -0

+
+[dependencies]
+dpdklib = {path = "MESON_INSTALL_DESTDIR_PREFIX/rust"}
\ No newline at end of file

Above Cargo.toml looks normal. Perhaps we could suggest/provide a method where DPDK does not need to be "ninja install"-ed, but instead process a local directory? That would likely make it easier to locally build/test Rust bindings.

Quoted 17 lines

examples/rust/helloworld/build.rs new file +11 -0

new file mode 100644
index 0000000000..5c76188e18
@@ -0,0 +1,21 @@
+use std::process::Command;
+
+pub fn main() {
+    let mut pkgconfig = Command::new("pkg-config");
+
+    match pkgconfig.args(["--libs", "libdpdk"]).output() {
+        Ok (output) => {
+            let stdout = String::from_utf8_lossy(&output.stdout).trim_end().to_string();
+            for token in stdout.split_ascii_whitespace().filter(|s| !s.is_empty()) {
+                if token.starts_with("-L") {
+                    println!("cargo::rustc-link-search=native={}", &token[2..]);

examples/rust/helloworld/build.rs line 21

Quoted 10 lines

examples/rust/helloworld/build.rs new file +10 -0

+                } else if token.starts_with("-l") {
+                    println!("cargo::rustc-link-lib={}", &token[2..]);
+                }
+            }
+        }
+        Err(error) => {
+            panic!("failed to read libdpdk package: {:?}", error);
+        }
+    }
+}

Could a simple "probe()" like below replace the more complex logic? I've linked DPDK in the past using this more boring method.. or is there a reason that the link-search-native and link-lib parts have to be handled manually? Doing a Command::new() is hacky, nice to remove it if possible!

if let Err(e) = pkg_config::Config::new().probe("libdpdk") {
   panic!("libdpdk probe failed: {e:?}");
}

The build.rs file itself also needs a "rebuild if self changed" line:
println!("cargo:rerun-if-changed=build.rs");

Quoted 10 lines

examples/rust/helloworld/src/main.rs new file +4 -0

new file mode 100644
index 0000000000..cf666aece6
@@ -0,0 +1,197 @@
+/// Usage: helloworld -a <port 1 params> -a <port 2 params> ...
+
+use std::env;
+use std::ffi::{CString};

examples/rust/helloworld/src/main.rs line 14

Quoted 10 lines

examples/rust/helloworld/src/main.rs new file +10 -0

+use std::os::raw::{c_int, c_char};
+use std::ffi::CStr;
+
+use dpdklib::rte_eal::{
+    // Functions
+    rte_eal_init,
+    rte_eal_cleanup,
+};
+
+use dpdklib::rte_ethdev::{

As per first reply, I'd like to see the end-result safe-Rust namespacing be shortened.

This can be easily done by renaming the name= in Cargo.toml, and removing the "rte_" prefix at bindgen output stage for each file. dpdk::ethdev:: { RTE_ETH_NAME_MAX_LEN, ... };

Perhaps its a good method to put the generated (unsafe, raw-C-bindings) in this namespace, and build a safe crate (with the dpdk::ethdev::* namespacing) over it. Thoughts?

Quoted 36 lines

examples/rust/helloworld/src/main.rs new file +35 -0

+    RTE_ETH_NAME_MAX_LEN,
+    RTE_ETH_DEV_NO_OWNER,
+    RTE_ETH_RSS_IP,
+    rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_RSS,
+    rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_VMDQ_DCB_RSS,
+
+    // Structures
+    rte_eth_dev_info,
+    rte_eth_conf,
+    rte_eth_txconf,
+    rte_eth_rxconf,
+
+    // Functions
+    rte_eth_dev_get_name_by_port,
+    rte_eth_find_next_owned_by,
+    rte_eth_dev_info_get,
+    rte_eth_dev_configure,
+    rte_eth_tx_queue_setup,
+    rte_eth_rx_queue_setup,
+    rte_eth_dev_start,
+};
+
+use dpdklib::rte_build_config::{
+    RTE_MAX_ETHPORTS,
+};
+
+use dpdklib::rte_mbuf::{
+    rte_pktmbuf_pool_create,
+};
+
+use dpdklib::rte_mbuf_core::{
+    RTE_MBUF_DEFAULT_BUF_SIZE
+};
+
+pub type DpdkPort = u16;

examples/rust/helloworld/src/main.rs line 59

Quoted 10 lines

examples/rust/helloworld/src/main.rs new file +10 -0

+pub struct Port {
+    pub port_id:DpdkPort,
+    pub dev_info:rte_eth_dev_info,
+    pub dev_conf:rte_eth_conf,
+    pub rxq_num:u16,
+    pub txq_num:u16,
+}
+
+impl Port {
+    unsafe fn new(id:DpdkPort) -> Self {

This is where the first manual code is wrapping C concepts into Rust. And the approach taken here is quite "C thinking", where it is possible to misuse an API, and hence "unsafe" is used for many functions (more below) and also for the C FFI function calls.

I believe this part can be improved, and that there is big value in those improvements:
Today the code is "C but compiled by the Rust compiler", the programmer has to use the APIs correctly.

I'll send a patch in reply to this one for review, suggesting ways to improve.
Future code goal: "Rust checks code: invalid code will not compile, or provide a clean error at runtime."

Quoted 27 lines

examples/rust/helloworld/src/main.rs new file +26 -0

+        Port {
+            port_id:id,
+            dev_info: unsafe {
+                let uninit: ::std::mem::MaybeUninit<rte_eth_dev_info> = ::std::mem::MaybeUninit::zeroed().assume_init();
+                *uninit.as_ptr()
+            },
+            dev_conf: unsafe {
+                let uninit: ::std::mem::MaybeUninit<rte_eth_conf> = ::std::mem::MaybeUninit::zeroed().assume_init();
+                *uninit.as_ptr()
+            },
+            rxq_num:1,
+            txq_num:1,
+        }
+    }
+}
+
+pub unsafe fn iter_rte_eth_dev_owned_by(owner_id:u64) -> impl Iterator<Item=DpdkPort> {
+    let mut port_id:DpdkPort = 0 as DpdkPort;
+    std::iter::from_fn(move || {
+        let cur = port_id;
+        port_id = unsafe {
+            rte_eth_find_next_owned_by(cur, owner_id) as DpdkPort
+        };
+        if port_id == RTE_MAX_ETHPORTS as DpdkPort {
+            return None
+        }

examples/rust/helloworld/src/main.rs line 95

Quoted 10 lines

examples/rust/helloworld/src/main.rs new file +10 -0

+        if cur == port_id { port_id += 1 }
+        Some(cur)
+    })
+}
+
+pub unsafe fn iter_rte_eth_dev() -> impl Iterator<Item=DpdkPort> {
+    unsafe {
+      iter_rte_eth_dev_owned_by(RTE_ETH_DEV_NO_OWNER as u64)
+    }
+}

Cool - I like the egonomics idea of providing Iterator<DpdkPort>. The implementation here is unsafe, which is unfortunate, we'd like to ensure that all "end-user visible" Rust code is "safe Rust".

Quoted 23 lines

examples/rust/helloworld/src/main.rs new file +23 -0

+pub unsafe fn init_port_config(port: &mut Port) {
+    let ret = unsafe {
+        rte_eth_dev_info_get(port.port_id, &mut port.dev_info as *mut rte_eth_dev_info)
+    };
+    if ret != 0 {
+        panic!("port-{}: failed to get dev info {ret}", port.port_id);
+    }
+
+    port.dev_conf.rx_adv_conf.rss_conf.rss_key = std::ptr::null_mut();
+    port.dev_conf.rx_adv_conf.rss_conf.rss_hf = if port.rxq_num > 1 {
+        RTE_ETH_RSS_IP as u64 & port.dev_info.flow_type_rss_offloads
+    } else {0};
+
+    if port.dev_conf.rx_adv_conf.rss_conf.rss_hf != 0 {
+        port.dev_conf.rxmode.mq_mode =
+            rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_VMDQ_DCB_RSS & rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_RSS;
+    }
+}
+
+pub unsafe fn show_ports_summary(ports: &Vec<Port>) {
+    let mut name_buf:[c_char;RTE_ETH_NAME_MAX_LEN as usize]= [0 as c_char;RTE_ETH_NAME_MAX_LEN as usize];
+    let title = format!("{:<4}    {:<32} {:<14}", "Port", "Name", "Driver");
+    println!("{title}");

examples/rust/helloworld/src/main.rs line 129

Quoted 10 lines

examples/rust/helloworld/src/main.rs new file +10 -0

+    ports.iter().for_each(|p| unsafe {
+        let _rc = rte_eth_dev_get_name_by_port(p.port_id, name_buf.as_mut_ptr());
+        let name = CStr::from_ptr(name_buf.as_ptr());
+        let drv = CStr::from_ptr(p.dev_info.driver_name);
+        let summary = format!("{:<4}    {:<32} {:<14}",
+                              p.port_id, name.to_str().unwrap(), drv.to_str().unwrap());
+        println!("{summary}");
+    });
+
+}

There are some interesting changes of thoughts in Rust vs C, in how applications actually allocate or "own" data. The above show_ports_summary() function requires a &Vec<Port>. That demands that the backing storage for Port is a Vec<Port>, and a (immutable) reference is passed into this function. Hence the type is:
summary(ports: &Vec<Port>)

There is no reason to "demand" that the application stores Ports in a Vec. While common to store things in Vec<T>, we have now demanded "more than required" from the application. In some situations (perhaps not 100% relevant here, but..) like embedded systems, where dynamic allocation isn't available there IS no Vec<T> available. In other application scenarios, perhaps a HashMap is better.

The best way to do this in Rust is to use the Iterator trait, which doesn't require any specific "backing storage" (e.g. linear-data for 'slice' or Vec, or HashMap per-item allocated data, or ...). Instead the Iterator trait allows the function itself to iterate of the "Item". Example:

pub fn show_ports_summary_iterator<'a>(ports: impl Iterator<Item = &'a Port>) {
   ports.for_each(|p| { /* p is a &Port */);
}

There should be no unsafe required for the above debug print, and no statically sized C-string allocations. Instead of fetching the port name via C function at print-time, the Port::new() function can cache the value and convert it to a Rust String type - avoids unsafe {}, reduces scope of unsafe variables in the program.

Quoted 29 lines

examples/rust/helloworld/src/main.rs new file +29 -0

+unsafe fn start_port(port:&mut Port) {
+    let mut rc = unsafe {
+      rte_eth_dev_configure(port.port_id, port.rxq_num, port.txq_num,
+                            &port.dev_conf as *const rte_eth_conf)
+    };
+    if rc != 0 { panic!("failed to configure port-{}: {rc}", port.port_id)}
+    println!("port-{} configured", port.port_id);
+
+    rc = unsafe {
+      rte_eth_tx_queue_setup(port.port_id, 0, 64, 0, 0 as *const rte_eth_txconf)
+    };
+    if rc != 0 { panic!("port-{}: failed to configure TX queue 0 {rc}", port.port_id)}
+    println!("port-{} configured TX queue 0", port.port_id);
+
+    let mbuf_pool_name = CString::new(format!("mbuf pool port-{}", port.port_id)).unwrap();
+    let mbuf_pool : *mut dpdklib::rte_mbuf::rte_mempool = unsafe {
+        rte_pktmbuf_pool_create(mbuf_pool_name.as_ptr(), 1024, 0, 0,
+                                RTE_MBUF_DEFAULT_BUF_SIZE as u16, 0)
+    };
+    if mbuf_pool  == 0 as *mut dpdklib::rte_mbuf::rte_mempool {
+        panic!("port-{}: failed to allocate mempool {rc}", port.port_id)
+    }
+    println!("port-{} mempool ready", port.port_id);
+
+    let mut rxq_conf:rte_eth_rxconf = port.dev_info.default_rxconf.clone();
+    rxq_conf.offloads = 0;
+    rc = unsafe {
+        rte_eth_rx_queue_setup(port.port_id, 0, 64, 0,
+                               &mut rxq_conf as *mut rte_eth_rxconf,

examples/rust/helloworld/src/main.rs line 168

Quoted 10 lines

examples/rust/helloworld/src/main.rs new file +10 -0

+                               mbuf_pool as *mut dpdklib::rte_ethdev::rte_mempool)
+    };
+    if rc != 0 { panic!("port-{}: failed to configure RX queue 0 {rc}", port.port_id)}
+    println!("port-{} configured RX queue 0", port.port_id);
+    rc = unsafe {
+        rte_eth_dev_start(port.port_id)
+    };
+    if rc != 0 { panic!("failed to start port-{}: {rc}", port.port_id)}
+    println!("port-{} started", port.port_id);
+}

Similar concepts around reworking "unsafe" away as above, future discussion.

Quoted 18 lines

examples/rust/helloworld/src/main.rs new file +18 -0

+fn main() {
+
+    let mut argv: Vec<*mut c_char> = env::args()
+        .map(|arg| CString::new(arg).unwrap().into_raw()).collect();
+
+    let rc = unsafe {
+        rte_eal_init(env::args().len() as c_int, argv.as_mut_ptr())
+    };
+    if rc == -1 {
+        unsafe { rte_eal_cleanup(); }
+    }
+
+    let mut ports:Vec<Port> = vec![];
+    unsafe {
+        for port_id in iter_rte_eth_dev()
+            .take(dpdklib::rte_build_config::RTE_MAX_ETHPORTS as usize) {
+            let mut port = Port::new(port_id);
+            init_port_config(&mut port);

examples/rust/helloworld/src/main.rs line 197

Quoted 10 lines

examples/rust/helloworld/src/main.rs new file +10 -0

+            println!("init port {port_id}");
+            start_port(&mut port);
+            ports.push(port);
+        }
+    }
+
+    unsafe { show_ports_summary(&ports); }
+
+    println!("Hello, world!");
+}

Overall, I'm very happy to see this patch, I want to ensure folks on list hear that! The unsafe {} around each block of "do something" is not idiomatic Rust - we can improve that. The summary_iterator() function above can be called like a normal function:

show_ports_summary_iterator(ports.iter());

Quoted 11 lines

meson_options.txt +2 -1

index e49b2fc089..d37b9ba1dc 100644
@@ -60,3 +60,5 @@ option('tests', type: 'boolean', value: true, description:
        'build unit tests')
 option('use_hpet', type: 'boolean', value: false, description:
        'use HPET timer in EAL')
+option('enable_rust', type: 'boolean', value: false, description:
+       'enable RUST')
--

Quoted 1 line

2.45.2

Great work, and looking forward to hearing about next-steps, and discussion on the above feedback.

Regards! (& thanks for reading till the end.. this turned into a long response :) -Harry

The patch converts include files with DPDK API to RUST and binds new RUST API files info dpdklib package.

The RUST dpdklib files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdklib package as dependency in Cargo.toml file.

RUST dpdklib package is installed into
MESON_INSTALL_DESTDIR_PREFIX/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

RUST dpdklib installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create MESON_INSTALL_DESTDIR_PREFIX/rust directory.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

Signed-off-by Gregory Etelson <[email protected]>

---
 buildtools/meson.build               |   4 +
 buildtools/rust-env.sh               |  78 +++++++++++
 examples/rust/helloworld/Cargo.lock  |  14 ++
 examples/rust/helloworld/Cargo.toml  |   7 +
 examples/rust/helloworld/build.rs    |  21 +++
 examples/rust/helloworld/src/main.rs | 197 +++++++++++++++++++++++++++
 meson_options.txt                    |   2 +
 7 files changed, 323 insertions(+)
 create mode 100755 buildtools/rust-env.sh
 create mode 100644 examples/rust/helloworld/Cargo.lock
 create mode 100644 examples/rust/helloworld/Cargo.toml
 create mode 100644 examples/rust/helloworld/build.rs
 create mode 100644 examples/rust/helloworld/src/main.rs

buildtools/meson.build +4 -0

index 4e2c1217a2..dd16567f51 100644
@@ -50,3 +50,7 @@ else
     pmdinfo += 'ar'
     pmdinfogen += 'elf'
 endif
+
+if get_option('enable_rust')
+    meson.add_install_script('rust-env.sh')
+endif

buildtools/rust-env.sh new file +0 -0

new file mode 100755
index 0000000000..705bc0d95b

buildtools/rust-env.sh new file +72 -0

+# 1. Preparation [Optional]
+#    Due to the bindgen conversion utility limitations source file may need
+#    manual adjustment.
+# 2. Preprocessing [Mandatory]
+#    Run preprocessor on a source file before conversion.
+# 3. Conversion [Mandatory]
+#    Convert preprocessed C file into RUST file
+# 4. Post translation [Optional]
+#    Manually fix translation.
+
+# DPDK files list
+files='
+rte_build_config.h
+rte_eal.h
+rte_ethdev.h
+rte_mbuf.h
+rte_mbuf_core.h
+rte_mempool.h
+'
+
+rust_dir="${MESON_INSTALL_DESTDIR_PREFIX}/rust"
+include_dir="${MESON_INSTALL_DESTDIR_PREFIX}/include"
+
+if test -d "$rust_dir"; then
+  rm -rf "$rust_dir"
+fi
+
+mkdir -p "$rust_dir/src"
+if ! test -d "$rust_dir"; then
+  echo "failed to create Rust library $rust_dir"
+  exit 255
+fi
+touch "$rust_dir/src/lib.rs"
+
+bindgen_opt='--no-layout-tests --no-derive-debug'
+bindgen_clang_opt='-Wno-unused-command-line-argument'
+
+create_rust_lib ()
+{
+  base=$1
+
+  cp $include_dir/${base}.h /tmp/${base}.h
+
+# bindgen cannot process complex macro definitions
+# manually simplify macros before conversion
+  sed -i -e 's/RTE_BIT64(\([0-9]*\))/(1UL << \1)/g' /tmp/${base}.h
+  sed -i -e 's/RTE_BIT32(\([0-9]*\))/(1U << \1)/g' /tmp/${base}.h
+  sed -i -e 's/UINT64_C(\([0-9]*\))/\1/g' /tmp/${base}.h
+
+  # clang output has better integration with bindgen than GCC
+  clang -E -dD -I$include_dir /tmp/${base}.h > /tmp/$base.i
+  bindgen $bindgen_opt --output $rust_dir/src/$base.rs /tmp/$base.i -- $bindgen_clang_opt
+  rm -f /tmp/$base.i /tmp/$base.h
+}
+
+for file in $files; do
+  base=$(basename $file | cut -d. -f 1)
+  create_rust_lib $base
+  echo "pub mod $base;" >> "$rust_dir/src/lib.rs"
+done
+
+
+cat > "$rust_dir/Cargo.toml" <<EOF
+[package]
+name = "dpdklib"
+version = "$(cat $MESON_SOURCE_ROOT/VERSION | sed 's/\.0\([1-9]\)/\.\1/')"
+EOF
+
+# post conversion updates
+# RUST does not accept aligned structures into packed structure.
+# TODO: fix DPDK definitions.
+sed -i 's/repr(align(2))/repr(packed(2))/g'  "$rust_dir/src/rte_ethdev.rs"

examples/rust/helloworld/Cargo.lock new file +14 -0

new file mode 100644
index 0000000000..d18af80c66
@@ -0,0 +1,14 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "dpdklib"
+version = "25.3.0-rc1"
+
+[[package]]
+name = "helloworld"
+version = "0.1.0"
+dependencies = [
+ "dpdklib",
+]

examples/rust/helloworld/Cargo.toml new file +7 -0

new file mode 100644
index 0000000000..7f9a77968a
@@ -0,0 +1,7 @@
+[package]
+name = "helloworld"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+dpdklib = {path = "MESON_INSTALL_DESTDIR_PREFIX/rust"}
\ No newline at end of file

examples/rust/helloworld/build.rs new file +21 -0

new file mode 100644
index 0000000000..5c76188e18
@@ -0,0 +1,21 @@
+use std::process::Command;
+
+pub fn main() {
+    let mut pkgconfig = Command::new("pkg-config");
+
+    match pkgconfig.args(["--libs", "libdpdk"]).output() {
+        Ok (output) => {
+            let stdout = String::from_utf8_lossy(&output.stdout).trim_end().to_string();
+            for token in stdout.split_ascii_whitespace().filter(|s| !s.is_empty()) {
+                if token.starts_with("-L") {
+                    println!("cargo::rustc-link-search=native={}", &token[2..]);
+                } else if token.starts_with("-l") {
+                    println!("cargo::rustc-link-lib={}", &token[2..]);
+                }
+            }
+        }
+        Err(error) => {
+            panic!("failed to read libdpdk package: {:?}", error);
+        }
+    }
+}

examples/rust/helloworld/src/main.rs new file +85 -0

new file mode 100644
index 0000000000..cf666aece6
@@ -0,0 +1,197 @@
+/// Usage: helloworld -a <port 1 params> -a <port 2 params> ...
+
+use std::env;
+use std::ffi::{CString};
+use std::os::raw::{c_int, c_char};
+use std::ffi::CStr;
+
+use dpdklib::rte_eal::{
+    // Functions
+    rte_eal_init,
+    rte_eal_cleanup,
+};
+
+use dpdklib::rte_ethdev::{
+    RTE_ETH_NAME_MAX_LEN,
+    RTE_ETH_DEV_NO_OWNER,
+    RTE_ETH_RSS_IP,
+    rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_RSS,
+    rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_VMDQ_DCB_RSS,
+
+    // Structures
+    rte_eth_dev_info,
+    rte_eth_conf,
+    rte_eth_txconf,
+    rte_eth_rxconf,
+
+    // Functions
+    rte_eth_dev_get_name_by_port,
+    rte_eth_find_next_owned_by,
+    rte_eth_dev_info_get,
+    rte_eth_dev_configure,
+    rte_eth_tx_queue_setup,
+    rte_eth_rx_queue_setup,
+    rte_eth_dev_start,
+};
+
+use dpdklib::rte_build_config::{
+    RTE_MAX_ETHPORTS,
+};
+
+use dpdklib::rte_mbuf::{
+    rte_pktmbuf_pool_create,
+};
+
+use dpdklib::rte_mbuf_core::{
+    RTE_MBUF_DEFAULT_BUF_SIZE
+};
+
+pub type DpdkPort = u16;
+pub struct Port {
+    pub port_id:DpdkPort,
+    pub dev_info:rte_eth_dev_info,
+    pub dev_conf:rte_eth_conf,
+    pub rxq_num:u16,
+    pub txq_num:u16,
+}
+
+impl Port {
+    unsafe fn new(id:DpdkPort) -> Self {
+        Port {
+            port_id:id,
+            dev_info: unsafe {
+                let uninit: ::std::mem::MaybeUninit<rte_eth_dev_info> = ::std::mem::MaybeUninit::zeroed().assume_init();
+                *uninit.as_ptr()
+            },
+            dev_conf: unsafe {
+                let uninit: ::std::mem::MaybeUninit<rte_eth_conf> = ::std::mem::MaybeUninit::zeroed().assume_init();
+                *uninit.as_ptr()
+            },
+            rxq_num:1,
+            txq_num:1,
+        }
+    }
+}
+
+pub unsafe fn iter_rte_eth_dev_owned_by(owner_id:u64) -> impl Iterator<Item=DpdkPort> {
+    let mut port_id:DpdkPort = 0 as DpdkPort;
+    std::iter::from_fn(move || {
+        let cur = port_id;
+        port_id = unsafe {
+            rte_eth_find_next_owned_by(cur, owner_id) as DpdkPort
+        };
+        if port_id == RTE_MAX_ETHPORTS as DpdkPort {
+            return None
+        }

examples/rust/helloworld/src/main.rs new file +11 -0

+
+pub unsafe fn init_port_config(port: &mut Port) {
+    let ret = unsafe {
+        rte_eth_dev_info_get(port.port_id, &mut port.dev_info as *mut rte_eth_dev_info)
+    };
+    if ret != 0 {
+        panic!("port-{}: failed to get dev info {ret}", port.port_id);
+    }
+
+    port.dev_conf.rx_adv_conf.rss_conf.rss_key = std::ptr::null_mut();
+    port.dev_conf.rx_adv_conf.rss_conf.rss_hf = if port.rxq_num > 1 {

examples/rust/helloworld/src/main.rs new file +4 -0

+    let mut name_buf:[c_char;RTE_ETH_NAME_MAX_LEN as usize]= [0 as c_char;RTE_ETH_NAME_MAX_LEN as usize];
+    let title = format!("{:<4}    {:<32} {:<14}", "Port", "Name", "Driver");
+    println!("{title}");
+    ports.iter().for_each(|p| unsafe {

examples/rust/helloworld/src/main.rs new file +9 -0

+    let mut rc = unsafe {
+      rte_eth_dev_configure(port.port_id, port.rxq_num, port.txq_num,
+                            &port.dev_conf as *const rte_eth_conf)
+    };
+    if rc != 0 { panic!("failed to configure port-{}: {rc}", port.port_id)}
+    println!("port-{} configured", port.port_id);
+
+    rc = unsafe {
+      rte_eth_tx_queue_setup(port.port_id, 0, 64, 0, 0 as *const rte_eth_txconf)

examples/rust/helloworld/src/main.rs new file +23 -0

+    };
+    if rc != 0 { panic!("port-{}: failed to configure RX queue 0 {rc}", port.port_id)}
+    println!("port-{} configured RX queue 0", port.port_id);
+    rc = unsafe {
+        rte_eth_dev_start(port.port_id)
+    };
+    if rc != 0 { panic!("failed to start port-{}: {rc}", port.port_id)}
+    println!("port-{} started", port.port_id);
+}
+
+fn main() {
+
+    let mut argv: Vec<*mut c_char> = env::args()
+        .map(|arg| CString::new(arg).unwrap().into_raw()).collect();
+
+    let rc = unsafe {
+        rte_eal_init(env::args().len() as c_int, argv.as_mut_ptr())
+    };
+    if rc == -1 {
+        unsafe { rte_eal_cleanup(); }
+    }
+
+    let mut ports:Vec<Port> = vec![];

examples/rust/helloworld/src/main.rs new file +5 -0

+
+    unsafe { show_ports_summary(&ports); }
+
+    println!("Hello, world!");
+}

meson_options.txt +2 -1

index e49b2fc089..d37b9ba1dc 100644
@@ -60,3 +60,5 @@ option('tests', type: 'boolean', value: true, description:
        'build unit tests')
 option('use_hpet', type: 'boolean', value: false, description:
        'use HPET timer in EAL')
+option('enable_rust', type: 'boolean', value: false, description:
+       'enable RUST')
--

2.45.2

Hi Gregory!

As a DPDK as well as a Rust user, I'm quite excited about this patch. I'm wondering though, is DPDK getting an official Rust API? I'm subscribed to dev and user mailing lists, and haven't seen any announcements - did I miss something?

Bellow are some stylistic suggestions

Hello Igor,

Quoted 9 lines

Hi Gregory!

As a DPDK as well as a Rust user, I'm quite excited about this patch. I'm wondering though, is DPDK getting an official Rust API? I'm subscribed to dev and user mailing lists, and haven't seen any announcements - did I miss something?

Bellow are some stylistic suggestions

There is no DPDK API for RUST yet.
My patch allows RUST application to use native DPDK API. I'll adopt you coding style suggestions in the next patch release.

Regards,
Gregory

Quoted 4 lines

There is no DPDK API for RUST yet.
My patch allows RUST application to use native DPDK API. I'll adopt you coding style suggestions in the next patch release.

I have same concerns about rust in DPDK as the Linux kernel. What API's are we going to be covered?

Will new API's have to have rust support?

What about API stability?

From: Gregory Etelson <[email protected]>
Sent: Saturday, March 8, 2025 6:50 PM
To: Van Haaren, Harry <[email protected]>; Richardson, Bruce <[email protected]>; [email protected] <[email protected]>
Cc: [email protected] <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>
Subject: [PATCH v2] rust: support raw DPDK API

The patch converts include files with DPDK API to RUST and binds new RUST API files into raw module under dpdk crate.

The RUST files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdk crate as dependency in Cargo.toml file.

RUST dpdk crate is installed into $MESON_INSTALL_DESTDIR_PREFIX/$libdir/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

RUST dpdk installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create $MESON_INSTALL_DESTDIR_PREFIX/$libdir/rust crate.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

Signed-off-by Gregory Etelson <[email protected]>

examples/rust/helloworld/src/main.rs new file +0 -0

new file mode 100644

examples/rust/helloworld/src/main.rs new file +18 -0

+pub type DpdkPort = u16;
+pub struct Port {
+    pub port_id:DpdkPort,
+    pub dev_info:rte_eth_dev_info,
+    pub dev_conf:rte_eth_conf,
+    pub rxq_num:u16,
+    pub txq_num:u16,
+}
+
+impl Port {
+    unsafe fn new(id:DpdkPort) -> Self {
+        Port {
+            port_id:id,
+            dev_info: unsafe {
+                let uninit: ::std::mem::MaybeUninit<rte_eth_dev_info> = ::std::mem::MaybeUninit::zeroed().assume_init();
+                *uninit.as_ptr()
+            },
+            dev_conf: unsafe {

Quoted 23 lines

From: Gregory Etelson <[email protected]>
Sent: Saturday, March 8, 2025 6:50 PM
To: Van Haaren, Harry <[email protected]>; Richardson, Bruce <[email protected]>; [email protected] <[email protected]>
Cc: [email protected] <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>
Subject: [PATCH v2] rust: support raw DPDK API

The patch converts include files with DPDK API to RUST and binds new RUST API files into raw module under dpdk crate.

The RUST files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdk crate as dependency in Cargo.toml file.

RUST dpdk crate is installed into $MESON_INSTALL_DESTDIR_PREFIX/$libdir/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

Quoted 7 lines

RUST dpdk installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create $MESON_INSTALL_DESTDIR_PREFIX/$libdir/rust crate.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

Signed-off-by Gregory Etelson <[email protected]>

Please include a "revision change" summary, this helps reviewers understand what changes you have addressed, and what changes are not present. This usually is formatted below a --- line, so Git doesn't include it in commit notes.

Also add to CC any participants of the wider email discussion. (+CC Igor and Stephen here now)

---
v2:
- update rust crate name to "dpdk" from "dpdklib" (Bruce)
- update binding generation to use dpdk::raw::* namespace (Bruce)
- <were other comments/notes fixed?>
--- e.g. "rte_ethdev" -> "ethdev" namespace change?
--- e.g. "cargo fmt"?
--- e.g. "build.rs" simplification & fix?

Pulling comments from "detailed review" email thread (see v1 on patchwork)
- Gregory: "The idea was to provide generic DPDK API and let application to resolve unsafe interfaces."

For this patch, OK. But we (DPDK project) should take the next steps, and provide a "Safe Rust" API. The main reasons are that:
1) DPDK APIs have many rules around multithreading; (lcore concepts, rx_burst() threading requirements, etc).
2) Cross-language bindings are hard, FFI is hard (even though C/Rust is one of the "easier" ones)

Overall, I'd like to set the "goal" of Rust in DPDK to be "if it compiles, it is correct".
For example, if compiler allows "rxq.rx_burst()" to be called, it must ensure that a &mut reference is valid at that point. That gives a Rust bindings *actual value*, as opposed to "allowing DPDK usage from Rust (with all threading/unsafety just like in C)".

The bindings are the required base for that: making it available. But it is important state that these raw bindings are NOT ready for Rust folks to go build applications in "safe Rust".

- Igor "Indentation/styling is a bit off or inconsistent. I'd suggest to run cargo fmt to format the code."

Big +1. Rust has a default formatting engine, and using it means everybody wins (no checkpatch, no manual style rework). By reworking (and auto-saving..) my updates of the first patch, it reformatted a bunch of code, losing my own changes. Small things like this really hinder productivity. (Off topic: I'd like to see a DPDK auto-formatted for C code too!)

- Igor "I'd make init_port_config and start_port a method on Port, rather than a free function, but that's just my preference."

+1 here too. There is a logical "ownership" of functions to structs. For value added Rust APIs, we must
not copy the existing DPDK namespacing (it does not capture "ownership" in the way that Rust API should).
Instead, logically understanding the thread-requirements and boundaries of concepts like an "Rxq" struct instance, and ensuring appropriate Rust "Send" and "Sync" bounds are applied is key to a good Rust API (as per https://youtu.be/lb6xn2xQ-NQ?t=702).

<snip>

Quoted 2 lines

examples/rust/helloworld/src/main.rs new file +0 -0

new file mode 100644

<snip>

Quoted 18 lines

examples/rust/helloworld/src/main.rs new file +18 -0

+pub type DpdkPort = u16;
+pub struct Port {
+    pub port_id:DpdkPort,
+    pub dev_info:rte_eth_dev_info,
+    pub dev_conf:rte_eth_conf,
+    pub rxq_num:u16,
+    pub txq_num:u16,
+}
+
+impl Port {
+    unsafe fn new(id:DpdkPort) -> Self {
+        Port {
+            port_id:id,
+            dev_info: unsafe {
+                let uninit: ::std::mem::MaybeUninit<rte_eth_dev_info> = ::std::mem::MaybeUninit::zeroed().assume_init();
+                *uninit.as_ptr()
+            },
+            dev_conf: unsafe {

examples/rust/helloworld/src/main.rs line 76

Quoted 10 lines

examples/rust/helloworld/src/main.rs new file +10 -0

+                let uninit: ::std::mem::MaybeUninit<rte_eth_conf> = ::std::mem::MaybeUninit::zeroed().assume_init();
+                *uninit.as_ptr()
+            },
+            rxq_num:1,
+            txq_num:1,
+        }
+    }
+}
+
+pub unsafe fn iter_rte_eth_dev_owned_by(owner_id:u64) -> impl Iterator<Item=DpdkPort> {

Looking at the above parts of "Port abstraction in Rust", I'm not sure it really adds anything. It feels a bit "middle of the road" (aka, adding some "abstraction", but not going far enough).

What if we took an even smaller step: remove the Rust struct concepts, and just call the "dpdk::raw::*" unsafe functions directly, as if they were C code. No "struct Port, impl Port", and no "Iterator<DpdkPort" concepts at all. That would show "correct" usage of the raw generated bindings, and provide raw API unit-tests.

Quoted 7 lines

Looking at the above parts of "Port abstraction in Rust", I'm not sure it really adds anything. It feels a bit "middle of the road" (aka, adding some "abstraction", but not going far enough).

What if we took an even smaller step: remove the Rust struct concepts, and just call the "dpdk::raw::*" unsafe functions directly, as if they were C code. No "struct Port, impl Port", and no "Iterator<DpdkPort" concepts at all. That would show "correct" usage of the raw generated bindings, and provide raw API unit-tests.

Yes, definite +1 for this. Let's not try and have a half-C, half-Rust set of APIs, but instead let's have a clean low-level mapping directly to C functions, and then build a proper, safe API on top of that.

Looking at the above parts of "Port abstraction in Rust", I'm not sure it really adds anything. It feels a bit "middle of the road" (aka, adding some "abstraction", but not going far enough).

What if we took an even smaller step: remove the Rust struct concepts, and just call the "dpdk::raw::*" unsafe functions directly, as if they were C code. No "struct Port, impl Port", and no "Iterator<DpdkPort" concepts at all. That would show "correct" usage of the raw generated bindings, and provide raw API unit-tests.

In a future patch, we can start to build "Safe Rust" essential-basics of EAL, and Ethdev. This is to abstract over the "dpdk::raw::*" APIs, "compiles == correct", end-user documentation, etc all as is normal in Rust ecosystem. Example:

Today: V2 patch (note the "Port" struct in Rust):
pub unsafe fn init_port_config(port: &mut Port) { ... }

Future Raw API (note the raw u16 like C APIs):
unsafe fn init_port_config(port: u16) { ... }

Future Safe API (mockup, this needs thought):
let ports = eal.get_eth_ports();

 for p in &mut ports {
    p.initialize(rxqs, txqs, ...)?;

}

Thoughts?

examples/rust/helloworld/Cargo.toml new file +0 -0

new file mode 100644
index 0000000000..7f9a77968a

Quoted 3 lines

+[dependencies]
+dpdklib = {path = "MESON_INSTALL_DESTDIR_PREFIX/rust"} \ No newline at end of file

Bad practice.
Don't forget EOL

The patch converts include files with DPDK API to RUST and binds new RUST API files info dpdklib package.

The RUST dpdklib files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdklib package as dependency in Cargo.toml file.

RUST dpdklib package is installed into
MESON_INSTALL_DESTDIR_PREFIX/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

RUST dpdklib installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create MESON_INSTALL_DESTDIR_PREFIX/rust directory.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

Signed-off-by Gregory Etelson <[email protected]>

---

Quoted 23 lines · On Thu, 6 Mar 2025 15:37:13 +0200 Gregory Etelson <[email protected]> wrote:

The patch converts include files with DPDK API to RUST and binds new RUST API files info dpdklib package.

The RUST dpdklib files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdklib package as dependency in Cargo.toml file.

RUST dpdklib package is installed into
MESON_INSTALL_DESTDIR_PREFIX/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

RUST dpdklib installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create MESON_INSTALL_DESTDIR_PREFIX/rust directory.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

Quoted 2 lines

Signed-off-by Gregory Etelson <[email protected]>

---

Re-implementing test-pmd, l3fwd, etc in Rust is OK but not huge leap. The real benefit would the ability to support PMD's built in Rust. That would be much more invasive

Re-implementing test-pmd, l3fwd, etc in Rust is OK but not huge leap.

The real benefit would the ability to support PMD's built in Rust. That would be much more invasive

It's not sure when and even if vendors decide to work on RUST PMD.

The real benefit would the ability to support PMD's built in Rust.

Quoted 2 lines · Stephen Hemminger

The real benefit would the ability to support PMD's built in Rust.

Having DPDK libraries as Rust crates would be beneficial as well. The mempool library in particular is something I've wanted to use in some Rust projects. I've previously considered either porting this library or writing a safe API around bindings, but never actually got to implementing it yet. IMO, the benefit to DPDK would be more users, more contributors, etc.

The patch converts include files with DPDK API to RUST and binds new RUST API files into raw module under dpdk crate.

The RUST files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdk crate as dependency in Cargo.toml file.

RUST dpdk crate is installed into $MESON_INSTALL_DESTDIR_PREFIX/$libdir/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

RUST dpdk installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create $MESON_INSTALL_DESTDIR_PREFIX/$libdir/rust crate.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

Signed-off-by Gregory Etelson <[email protected]>

---
v2:
Change rust crate name from dpdklib to dpdk.
Add raw module for to link with C API.
Add "cargo:rerun-if-changed=build.rs".
v3:
Move init_port_config() to Port.
Move start_port() to Port.
Remove Cargo.lock from git repository
Reformat code.

---
 buildtools/meson.build               |   4 +
 buildtools/rust-env.sh               |  81 ++++++++++
 examples/rust/helloworld/Cargo.toml  |   7 +
 examples/rust/helloworld/build.rs    |  24 +++
 examples/rust/helloworld/src/main.rs | 219 +++++++++++++++++++++++++++
 meson_options.txt                    |   2 +
 6 files changed, 337 insertions(+)
 create mode 100755 buildtools/rust-env.sh
 create mode 100644 examples/rust/helloworld/Cargo.toml
 create mode 100644 examples/rust/helloworld/build.rs
 create mode 100644 examples/rust/helloworld/src/main.rs

buildtools/meson.build +4 -0

index 4e2c1217a2..b9d0092f07 100644
@@ -50,3 +50,7 @@ else
     pmdinfo += 'ar'
     pmdinfogen += 'elf'
 endif
+
+if get_option('enable_rust')
+    meson.add_install_script(['rust-env.sh', get_option('libdir')])
+endif

buildtools/rust-env.sh new file +15 -0

new file mode 100755
index 0000000000..fe0877643b
@@ -0,0 +1,81 @@
+#! /bin/sh
+
+# Convert DPDK API files into RUST.
+# DPDK files selection is on demand.
+#
+# The coversion is done in 4 stages:
+# 1. Preparation [Optional]
+#    Due to the bindgen conversion utility limitations source file may need
+#    manual adjustment.
+# 2. Preprocessing [Mandatory]
+#    Run preprocessor on a source file before conversion.
+# 3. Conversion [Mandatory]
+#    Convert preprocessed C file into RUST file
+# 4. Post translation [Optional]
+#    Manually fix translation.

buildtools/rust-env.sh new file +44 -0

+libdir="$1"
+rust_dir="${MESON_INSTALL_DESTDIR_PREFIX}/$libdir/rust"
+include_dir="${MESON_INSTALL_DESTDIR_PREFIX}/include"
+
+if test -d "$rust_dir"; then
+  rm -rf "$rust_dir"
+fi
+
+mkdir -p "$rust_dir/src/raw"
+if ! test -d "$rust_dir"; then
+  echo "failed to create Rust library $rust_dir"
+  exit 255
+fi
+
+bindgen_opt='--no-layout-tests --no-derive-debug'
+bindgen_clang_opt='-Wno-unused-command-line-argument'
+
+create_rust_lib ()
+{
+  base=$1
+
+  cp $include_dir/${base}.h /tmp/${base}.h
+
+# bindgen cannot process complex macro definitions
+# manually simplify macros before conversion
+  sed -i -e 's/RTE_BIT64(\([0-9]*\))/(1UL << \1)/g' /tmp/${base}.h
+  sed -i -e 's/RTE_BIT32(\([0-9]*\))/(1U << \1)/g' /tmp/${base}.h
+  sed -i -e 's/UINT64_C(\([0-9]*\))/\1/g' /tmp/${base}.h
+
+  # clang output has better integration with bindgen than GCC
+  clang -E -dD -I$include_dir /tmp/${base}.h > /tmp/$base.i
+  bindgen $bindgen_opt --output $rust_dir/src/raw/$base.rs /tmp/$base.i -- $bindgen_clang_opt
+  rm -f /tmp/$base.i /tmp/$base.h
+}
+
+echo 'pub mod raw;' > "$rust_dir/src/lib.rs"
+
+touch "$rust_dir/src/raw/mod.rs"
+for file in $files; do
+  base=$(basename $file | cut -d. -f 1)
+  create_rust_lib $base
+  echo "pub mod $base;" >> "$rust_dir/src/raw/mod.rs"
+done
+

buildtools/rust-env.sh new file +2 -0

+
+echo "Install RUST DPDK crate in $rust_dir"

examples/rust/helloworld/Cargo.toml new file +7 -0

new file mode 100644
index 0000000000..ceeecf958d
@@ -0,0 +1,7 @@
+[package]
+name = "helloworld"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+dpdk = {path = $MESON_INSTALL_DESTDIR_PREFIX/$libdir/rust }

examples/rust/helloworld/build.rs new file +14 -0

new file mode 100644
index 0000000000..bd5737d209
@@ -0,0 +1,24 @@
+use std::process::Command;
+
+pub fn main() {
+    let mut pkgconfig = Command::new("pkg-config");
+
+    match pkgconfig.args(["--libs", "libdpdk"]).output() {
+        Ok(output) => {
+            let stdout = String::from_utf8_lossy(&output.stdout)
+                .trim_end()
+                .to_string();
+            for token in stdout.split_ascii_whitespace().filter(|s| !s.is_empty()) {
+                if token.starts_with("-L") {
+                    println!("cargo::rustc-link-search=native={}", &token[2..]);
+                } else if token.starts_with("-l") {

examples/rust/helloworld/src/main.rs new file +219 -0

new file mode 100644
index 0000000000..0c057cb39f
@@ -0,0 +1,219 @@
+/// Usage: helloworld -a <port 1 params> -a <port 2 params> ...
+use std::env;
+use std::ffi::CStr;
+use std::ffi::CString;
+use std::os::raw::{c_char, c_int};
+
+use dpdk::raw::rte_eal::{
+    rte_eal_cleanup,
+    // Functions
+    rte_eal_init,
+};
+
+use dpdk::raw::rte_ethdev::{
+    RTE_ETH_DEV_NO_OWNER,
+    RTE_ETH_NAME_MAX_LEN,
+    RTE_ETH_RSS_IP,
+    rte_eth_conf,
+    rte_eth_dev_configure,
+    // Functions
+    rte_eth_dev_get_name_by_port,
+    // Structures
+    rte_eth_dev_info,
+    rte_eth_dev_info_get,
+    rte_eth_dev_start,
+    rte_eth_find_next_owned_by,
+    rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_RSS,
+    rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_VMDQ_DCB_RSS,
+
+    rte_eth_rx_queue_setup,
+    rte_eth_rxconf,
+
+    rte_eth_tx_queue_setup,
+    rte_eth_txconf,
+};
+
+use dpdk::raw::rte_build_config::RTE_MAX_ETHPORTS;
+
+use dpdk::raw::rte_mbuf::rte_pktmbuf_pool_create;
+
+use dpdk::raw::rte_mbuf_core::RTE_MBUF_DEFAULT_BUF_SIZE;
+
+pub type DpdkPort = u16;
+pub struct Port {
+    pub port_id: DpdkPort,
+    pub dev_info: rte_eth_dev_info,
+    pub dev_conf: rte_eth_conf,
+    pub rxq_num: u16,
+    pub txq_num: u16,
+}
+
+impl Port {
+    unsafe fn new(id: DpdkPort) -> Self {
+        Port {
+            port_id: id,
+            dev_info: unsafe {
+                let uninit: ::std::mem::MaybeUninit<rte_eth_dev_info> =
+                    ::std::mem::MaybeUninit::zeroed().assume_init();
+                *uninit.as_ptr()
+            },
+            dev_conf: unsafe {
+                let uninit: ::std::mem::MaybeUninit<rte_eth_conf> =
+                    ::std::mem::MaybeUninit::zeroed().assume_init();
+                *uninit.as_ptr()
+            },
+            rxq_num: 1,
+            txq_num: 1,
+        }
+    }
+
+    pub unsafe fn init_port_config(&mut self) {
+        let ret = unsafe {
+            rte_eth_dev_info_get(self.port_id, &mut self.dev_info as *mut rte_eth_dev_info)
+        };
+        if ret != 0 {
+            panic!("self-{}: failed to get dev info {ret}", self.port_id);
+        }
+
+        self.dev_conf.rx_adv_conf.rss_conf.rss_key = std::ptr::null_mut();
+        self.dev_conf.rx_adv_conf.rss_conf.rss_hf = if self.rxq_num > 1 {
+            RTE_ETH_RSS_IP as u64 & self.dev_info.flow_type_rss_offloads
+        } else {
+            0
+        };
+
+        if self.dev_conf.rx_adv_conf.rss_conf.rss_hf != 0 {
+            self.dev_conf.rxmode.mq_mode = rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_VMDQ_DCB_RSS
+                & rte_eth_rx_mq_mode_RTE_ETH_MQ_RX_RSS;
+        }
+    }
+
+    unsafe fn start_port(&mut self) {
+        let mut rc = unsafe {
+            rte_eth_dev_configure(
+                self.port_id,
+                self.rxq_num,
+                self.txq_num,
+                &self.dev_conf as *const rte_eth_conf,
+            )
+        };
+        if rc != 0 {
+            panic!("failed to configure self-{}: {rc}", self.port_id)
+        }
+        println!("self-{} configured", self.port_id);
+
+        rc = unsafe { rte_eth_tx_queue_setup(self.port_id, 0, 64, 0, 0 as *const rte_eth_txconf) };
+        if rc != 0 {
+            panic!("self-{}: failed to configure TX queue 0 {rc}", self.port_id)
+        }
+        println!("self-{} configured TX queue 0", self.port_id);
+
+        let mbuf_pool_name = CString::new(format!("mbuf pool self-{}", self.port_id)).unwrap();
+        let mbuf_pool: *mut dpdk::raw::rte_mbuf::rte_mempool = unsafe {
+            rte_pktmbuf_pool_create(
+                mbuf_pool_name.as_ptr(),
+                1024,
+                0,
+                0,
+                RTE_MBUF_DEFAULT_BUF_SIZE as u16,
+                0,
+            )
+        };
+        if mbuf_pool == 0 as *mut dpdk::raw::rte_mbuf::rte_mempool {
+            panic!("self-{}: failed to allocate mempool {rc}", self.port_id)
+        }
+        println!("self-{} mempool ready", self.port_id);
+
+        let mut rxq_conf: rte_eth_rxconf = self.dev_info.default_rxconf.clone();
+        rxq_conf.offloads = 0;
+        rc = unsafe {
+            rte_eth_rx_queue_setup(
+                self.port_id,
+                0,
+                64,
+                0,
+                &mut rxq_conf as *mut rte_eth_rxconf,
+                mbuf_pool as *mut dpdk::raw::rte_ethdev::rte_mempool,
+            )
+        };
+        if rc != 0 {
+            panic!("self-{}: failed to configure RX queue 0 {rc}", self.port_id)
+        }
+        println!("self-{} configured RX queue 0", self.port_id);
+        rc = unsafe { rte_eth_dev_start(self.port_id) };
+        if rc != 0 {
+            panic!("failed to start self-{}: {rc}", self.port_id)
+        }
+        println!("self-{} started", self.port_id);
+    }
+}
+
+pub unsafe fn iter_rte_eth_dev_owned_by(owner_id: u64) -> impl Iterator<Item = DpdkPort> {
+    let mut port_id: DpdkPort = 0 as DpdkPort;
+    std::iter::from_fn(move || {
+        let cur = port_id;
+        port_id = unsafe { rte_eth_find_next_owned_by(cur, owner_id) as DpdkPort };
+        if port_id == RTE_MAX_ETHPORTS as DpdkPort {
+            return None;
+        }
+        if cur == port_id {
+            port_id += 1
+        }
+        Some(cur)
+    })
+}
+
+pub unsafe fn iter_rte_eth_dev() -> impl Iterator<Item = DpdkPort> {
+    unsafe { iter_rte_eth_dev_owned_by(RTE_ETH_DEV_NO_OWNER as u64) }
+}
+
+pub unsafe fn show_ports_summary(ports: &Vec<Port>) {
+    let mut name_buf: [c_char; RTE_ETH_NAME_MAX_LEN as usize] =
+        [0 as c_char; RTE_ETH_NAME_MAX_LEN as usize];
+    let title = format!("{:<4}    {:<32} {:<14}", "Port", "Name", "Driver");
+    println!("{title}");
+    ports.iter().for_each(|p| unsafe {
+        let _rc = rte_eth_dev_get_name_by_port(p.port_id, name_buf.as_mut_ptr());
+        let name = CStr::from_ptr(name_buf.as_ptr());
+        let drv = CStr::from_ptr(p.dev_info.driver_name);
+        let summary = format!(
+            "{:<4}    {:<32} {:<14}",
+            p.port_id,
+            name.to_str().unwrap(),
+            drv.to_str().unwrap()
+        );
+        println!("{summary}");
+    });
+}
+
+fn main() {
+    let mut argv: Vec<*mut c_char> = env::args()
+        .map(|arg| CString::new(arg).unwrap().into_raw())
+        .collect();
+
+    let rc = unsafe { rte_eal_init(env::args().len() as c_int, argv.as_mut_ptr()) };
+    if rc == -1 {
+        unsafe {
+            rte_eal_cleanup();
+        }
+    }
+
+    let mut ports: Vec<Port> = vec![];
+    unsafe {
+        for port_id in
+            iter_rte_eth_dev().take(dpdk::raw::rte_build_config::RTE_MAX_ETHPORTS as usize)
+        {
+            let mut port = Port::new(port_id);
+            port.init_port_config();
+            println!("init port {port_id}");
+            port.start_port();
+            ports.push(port);
+        }
+    }
+
+    unsafe {
+        show_ports_summary(&ports);
+    }
+
+    println!("Hello, world!");
+}

meson_options.txt +2 -0

index e49b2fc089..d37b9ba1dc 100644
@@ -60,3 +60,5 @@ option('tests', type: 'boolean', value: true, description:
        'build unit tests')
 option('use_hpet', type: 'boolean', value: false, description:
        'use HPET timer in EAL')
+option('enable_rust', type: 'boolean', value: false, description:
+       'enable RUST')

Signature · 1 line

2.45.2

Quoted 14 lines

examples/rust/helloworld/build.rs new file +14 -0

+use std::process::Command;
+
+pub fn main() {
+    let mut pkgconfig = Command::new("pkg-config");
+
+    match pkgconfig.args(["--libs", "libdpdk"]).output() {
+        Ok(output) => {
+            let stdout = String::from_utf8_lossy(&output.stdout)
+                .trim_end()
+                .to_string();
+            for token in stdout.split_ascii_whitespace().filter(|s| !s.is_empty()) {
+                if token.starts_with("-L") {
+                    println!("cargo::rustc-link-search=native={}", &token[2..]);
+                } else if token.starts_with("-l") {

examples/rust/helloworld/build.rs line 24

Quoted 10 lines

examples/rust/helloworld/build.rs new file +10 -0

+                    println!("cargo::rustc-link-lib={}", &token[2..]);
+                }
+            }
+            println!("cargo:rerun-if-changed=build.rs");
+        }
+        Err(error) => {
+            panic!("failed to read libdpdk package: {:?}", error);
+        }
+    }
+}

What do you think about using pkg_config crate in build scripts?
(https://crates.io/crates/pkg-config)

This would allow to remove manual command execution and output parsing with the following:

	fn main() {
	  pkg_config::probe_library("libdpdk").expect("Unable to find libdpdk");
	}

Also, what do you think about moving this logic to dpdk crate? This way dependency resolution would be shared by all examples/applications which use the dpdk crate.

The patch converts include files with DPDK API to RUST and binds new RUST API files into raw module under dpdk crate.

The RUST files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdk crate as dependency in Cargo.toml file.

RUST dpdk crate is installed into $MESON_INSTALL_DESTDIR_PREFIX/$libdir/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

RUST dpdk installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create $MESON_INSTALL_DESTDIR_PREFIX/$libdir/rust crate.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

Signed-off-by Gregory Etelson <[email protected]>

---
v2:
Change rust crate name from dpdklib to dpdk.
Add raw module for to link with C API.
Add "cargo:rerun-if-changed=build.rs".
v3:
Move init_port_config() to Port.
Move start_port() to Port.
Remove Cargo.lock from git repository
Reformat code.
v4:
Blocked bindgen to convert stdlib functions with u128 type. Allow compilation of C style symbols.

---
 buildtools/meson.build               |   4 +
 buildtools/rust-env.sh               |  96 ++++++++++++
 examples/rust/helloworld/Cargo.toml  |   7 +
 examples/rust/helloworld/build.rs    |  24 +++
 examples/rust/helloworld/src/main.rs | 219 +++++++++++++++++++++++++++
 meson_options.txt                    |   2 +
 6 files changed, 352 insertions(+)
 create mode 100755 buildtools/rust-env.sh
 create mode 100644 examples/rust/helloworld/Cargo.toml
 create mode 100644 examples/rust/helloworld/build.rs
 create mode 100644 examples/rust/helloworld/src/main.rs

Hi Gregory, some high-level feedback:

* I'd suggest for future revisions splitting this into two patches. The rust example should be separate from a patch adding the basic rust infrastructure.

* For the example, I'd suggest that the helloworld rust example should correspond to the regular "C" helloworld example, i.e just init DPDK and print helloworld. If we want a basic packet handling example, it should be an l2fwd one - again to align with the "C" examples.

* However, in terms of the examples, if the idea is to provide higher level "rustic" APIs for DPDK, the examples should be written to use that. Any use of the low-level C APIs should be in a testing app only, rather than an example app. IMHO We want to encourage proper rust usage, not C-code just rewritten to use a different compiler.

The patch converts include files with DPDK API to RUST and binds new RUST API files into raw module under dpdk crate.

The RUST files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

RUST DPDK application must specify the dpdk crate as dependency in Cargo.toml file.

RUST dpdk crate is installed into $MESON_INSTALL_DESTDIR_PREFIX/$libdir/rust directory.

Software requirements:
- clang
- RUST installation
- bindgen-cli crate

RUST dpdk installation instructions:
1. Configure DPDK with -Deanble_rust=true
2. Build and install DPDK. The installation procedure will create $MESON_INSTALL_DESTDIR_PREFIX/$libdir/rust crate.
3. Update PKG_CONFIG_PATH to point to DPDK installation.

Signed-off-by Gregory Etelson <[email protected]>

---
v2:
Change rust crate name from dpdklib to dpdk.
Add raw module for to link with C API.
Add "cargo:rerun-if-changed=build.rs".

v3:
Move init_port_config() to Port.
Move start_port() to Port.
Remove Cargo.lock from git repository
Reformat code.
v4:
Blocked bindgen to convert stdlib functions with u128 type. Allow compilation of C style symbols.

---
 buildtools/meson.build               |   4 +
 buildtools/rust-env.sh               |  96 ++++++++++++
 examples/rust/helloworld/Cargo.toml  |   7 +
 examples/rust/helloworld/build.rs    |  24 +++
 examples/rust/helloworld/src/main.rs | 219 +++++++++++++++++++++++++++
 meson_options.txt                    |   2 +
 6 files changed, 352 insertions(+)
 create mode 100755 buildtools/rust-env.sh
 create mode 100644 examples/rust/helloworld/Cargo.toml
 create mode 100644 examples/rust/helloworld/build.rs
 create mode 100644 examples/rust/helloworld/src/main.rs

buildtools/meson.build +0 -0

index 4e2c1217a2..b9d0092f07 100644

buildtools/rust-env.sh new file +5 -0

new file mode 100755
index 0000000000..a239432a28
@@ -0,0 +1,96 @@
+#! /bin/sh
+
+# Convert DPDK API files into RUST.
+# DPDK files selection is on demand.
+#

examples/rust/helloworld/build.rs new file +18 -0

+        Ok(output) => {
+            let stdout = String::from_utf8_lossy(&output.stdout)
+                .trim_end()
+                .to_string();
+            for token in stdout.split_ascii_whitespace().filter(|s| !s.is_empty()) {
+                if token.starts_with("-L") {
+                    println!("cargo::rustc-link-search=native={}", &token[2..]);
+                } else if token.starts_with("-l") {
+                    println!("cargo::rustc-link-lib={}", &token[2..]);
+                }
+            }
+            println!("cargo:rerun-if-changed=build.rs");
+        }
+        Err(error) => {
+            panic!("failed to read libdpdk package: {:?}", error);
+        }
+    }
+}

When using bindgen, are we better to take the approach (as in this patch) of running it on everything in the headers and just excluding some things, or taking the opposite conservative approach of just listing the functions and defines we actually do want exposed (with wildcarding as necessary)? When playing with rust apps on top of DPDK myself, I've tended toward the latter scheme, but maybe for this effort we may want the former.

I'm not convinced by having this done as a post-install script. Instead I'd tend towards having a rust crate hosted somewhere that does the bindgen as part of the rust build.

<snip>

Review

Quoted 2 lines

(quoted diff) +2 -0

+
+    match pkgconfig.args(["--libs", "libdpdk"]).output() {

This work of using pkgconfig should not be necessary in the application build.rs file. If we switch to actually producing a proper crate, the pkgconfig handling and linking should be covered there (I would hope, anyway).

From: Gregory Etelson [mailto:[email protected]]
Sent: Thursday, 6 March 2025 14.37
Subject: [PATCH] rust: support DPDK API

The patch converts include files with DPDK API to RUST and binds new RUST API files info dpdklib package.

The RUST dpdklib files and DPDK libraries build from C sources allow creation of DPDK application in RUST.

Do we want the DPDK project itself to support rust? Or should parts of this be a DPDK hosted project, like grout?

I don't object to supporting rust, quite the opposite. I'm only trying to think ahead...

I would hate to see a DPDK patch being rejected because it doesn't support rust, or needs additional work to not break DPDK for rust.

And how about the CI - do we want it to test "DPDK for rust", and how many resources are we going to put into this?

Hello Morten,

Thank you for raising these questions !

Quoted 1 line

Quoted 2 lines

Do we want the DPDK project itself to support rust? Or should parts of this be a DPDK hosted project, like grout?

Rust packages management is different.
Also DPDK Rust code will eventually provide a different API. At this stage, DPDK hosted project looks like a good idea.

Quoted 8 lines

Hello Morten,

Thank you for raising these questions !

Quoted 3 lines

Do we want the DPDK project itself to support rust? Or should parts of this be a DPDK hosted project, like grout?

Quoted 4 lines

Rust packages management is different.
Also DPDK Rust code will eventually provide a different API. At this stage, DPDK hosted project looks like a good idea.

For ease of use, that would mean hosting a cargo registry, no?

Quoted 13 lines

Quoted 12 lines

Hello Morten,

Thank you for raising these questions !

Quoted 3 lines

Do we want the DPDK project itself to support rust? Or should parts of this be a DPDK hosted project, like grout?

Rust packages management is different.
Also DPDK Rust code will eventually provide a different API. At this stage, DPDK hosted project looks like a good idea.

Quoted 2 lines

For ease of use, that would mean hosting a cargo registry, no?

That's correct - cargo registry is the native way. Also we may consider splitting the code between several crates. That approach can provide more flexible way to arrange files.

Quoted 16 lines · Gregory

Quoted 15 lines

Quoted 5 lines

Hello Morten,

Thank you for raising these questions !

Quoted 1 line

Quoted 7 lines

Quoted 2 lines

Do we want the DPDK project itself to support rust? Or should parts of this be a DPDK hosted project, like grout?

Rust packages management is different.
Also DPDK Rust code will eventually provide a different API. At this stage, DPDK hosted project looks like a good idea.

For ease of use, that would mean hosting a cargo registry, no?

Quoted 3 lines

That's correct - cargo registry is the native way. Also we may consider splitting the code between several crates. That approach can provide more flexible way to arrange files.

Talk to Luca. The current rust cargo registry model is causing lots of grief for distro's such as Debian, Redhat, Ubuntu and SUSE.

Packaging is always a pain

Quoted 23 lines · Stephen Hemminger

Quoted 19 lines · Gregory

Quoted 8 lines

Quoted 8 lines

Hello Morten,

Thank you for raising these questions !

Quoted 3 lines

Do we want the DPDK project itself to support rust? Or should parts of this be a DPDK hosted project, like grout?

Quoted 7 lines

Quoted 4 lines

Rust packages management is different.
Also DPDK Rust code will eventually provide a different API. At this stage, DPDK hosted project looks like a good idea.

For ease of use, that would mean hosting a cargo registry, no?

That's correct - cargo registry is the native way. Also we may consider splitting the code between several crates. That approach can provide more flexible way to arrange files.

Quoted 4 lines

Talk to Luca. The current rust cargo registry model is causing lots of grief for distro's such as Debian, Redhat, Ubuntu and SUSE.

Packaging is always a pain

Yes, but cargo is just the way the rust ecosystem works right now. If we want to have DPDK available for rust developers it needs to be accessible via cargo.

Quoted 8 lines

Hello Morten,

Thank you for raising these questions !

Quoted 3 lines

Do we want the DPDK project itself to support rust? Or should parts of this be a DPDK hosted project, like grout?

Quoted 4 lines

Rust packages management is different.
Also DPDK Rust code will eventually provide a different API. At this stage, DPDK hosted project looks like a good idea.

For ease of use, that would mean hosting a cargo registry, no?

27/03/2025 17:17, Bruce Richardson:

Quoted 9 lines · Gregory

Quoted 8 lines

Hello Morten,

Thank you for raising these questions !

Quoted 3 lines

Do we want the DPDK project itself to support rust? Or should parts of this be a DPDK hosted project, like grout?

Quoted 6 lines

Quoted 4 lines

Rust packages management is different.
Also DPDK Rust code will eventually provide a different API. At this stage, DPDK hosted project looks like a good idea.

For ease of use, that would mean hosting a cargo registry, no?

Please could you explain why it is easier to have a cargo registry?

Add a Cargo.toml file in the root folder and a number of other scripts and rust-related files into buildtools/rust, which then enables DPDK to be cloned and built as a rust crate - all-be-it one with only two
functions: rte_eal_init and rte_eal_cleanup.

Signed-off-by Bruce Richardson <[email protected]>

---

This RFC is proposed as an alternative approach to enabling rust support in DPDK. The key difference vs previous is that we are taking the whole DPDK project here as a rust "crate", which can then be used by other higher-level crates as a dependency. Building the crate does a (minimal) build of DPDK and statically links it in, so there is no "install" step or anything needed - the Rust app just adds DPDK to their Cargo.toml file and then should have everything they need.

---
 Cargo.toml                                | 16 +++++++
 buildtools/meson.build                    |  1 +
 buildtools/rust/build.rs                  | 45 ++++++++++++++++++++
 buildtools/rust/gen-cargo-bindgen-info.py | 52 +++++++++++++++++++++++
 buildtools/rust/lib.rs                    | 25 +++++++++++
 buildtools/rust/wrapper.h                 |  5 +++
 meson.build                               |  3 ++
 7 files changed, 147 insertions(+)
 create mode 100644 Cargo.toml
 create mode 100644 buildtools/rust/build.rs
 create mode 100644 buildtools/rust/gen-cargo-bindgen-info.py
 create mode 100644 buildtools/rust/lib.rs
 create mode 100644 buildtools/rust/wrapper.h

buildtools/rust/lib.rs new file +15 -0

new file mode 100644
index 0000000000..f99c54ac42
@@ -0,0 +1,25 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2025 Intel Corporation
+ */
+
+#![allow(non_upper_case_globals)]
+#![allow(non_camel_case_types)]
+#![allow(non_snake_case)]
+
+include!(concat!(env!("OUT_DIR"), "/bindings.rs"));
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]

Add a Cargo.toml file in the root folder and a number of other scripts and rust-related files into buildtools/rust, which then enables DPDK to be cloned and built as a rust crate - all-be-it one with only two
functions: rte_eal_init and rte_eal_cleanup.

Signed-off-by Bruce Richardson <[email protected]>

---

This RFC is proposed as an alternative approach to enabling rust support in DPDK. The key difference vs previous is that we are taking the whole DPDK project here as a rust "crate", which can then be used by other higher-level crates as a dependency. Building the crate does a (minimal) build of DPDK and statically links it in, so there is no "install" step or anything needed - the Rust app just adds DPDK to their Cargo.toml file and then should have everything they need.

Cargo.toml new file +16 -0

new file mode 100644
index 0000000000..fe0843975a
@@ -0,0 +1,16 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2025 Intel Corporation
+
+[package]
+name = "dpdk-c"
+version = "25.0.7"
+build = "buildtools/rust/build.rs"
+edition = "2021"
+
+[lib]
+path = "buildtools/rust/lib.rs"
+doctest = false
+
+[build-dependencies]
+bindgen = "0.71"
+meson-next = "1"

buildtools/meson.build +1 -0

index 4e2c1217a2..a13b5189c1 100644
@@ -26,6 +26,7 @@ header_gen_cmd = py3 + files('gen-header.py')
 has_hugepages_cmd = py3 + files('has-hugepages.py')
 cmdline_gen_cmd = py3 + files('dpdk-cmdline-gen.py')
 check_dts_requirements = py3 + files('check-dts-requirements.py')
+gen_cargo_bindgen_info = py3 + files('rust/gen-cargo-bindgen-info.py')
 
 # install any build tools that end-users might want also

install_data([

buildtools/rust/build.rs new file +25 -0

new file mode 100644
index 0000000000..1ffdf03d2f
@@ -0,0 +1,45 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2025 Intel Corporation
+ */
+
+extern crate meson_next as meson;
+use std::collections::HashMap;
+use std::env;
+use std::path::PathBuf;
+
+fn main() {
+    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
+    let build_dir = out_path.join("build");
+
+    let meson_cfg = meson::Config::new().options(HashMap::from([
+        ("enable_libs", "eal"),
+        ("enable_drivers", "net/*,net/intel/*"),
+        ("enable_apps", "test")
+    ]));
+    meson::build(".", build_dir.to_str().unwrap(), meson_cfg);
+
+    /* open and print file 'cargo_rules.txt' from build_dir */
+    let cargo_ldflags_file = build_dir.join("cargo_ldflags.txt");
+    println!("cargo:rerun-if-changed={}", cargo_ldflags_file.display());
+    print!("{}", std::fs::read_to_string(cargo_ldflags_file).unwrap());
+

buildtools/rust/gen-cargo-bindgen-info.py new file +52 -0

new file mode 100644
index 0000000000..bea432ead3
@@ -0,0 +1,52 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2025 Intel Corporation
+
+# Script to generate cargo rules for static linking in rust builds
+# outputs one line per library, for drivers and libraries
+
+import os
+import os.path
+import sys
+import subprocess
+
+if 'MESON_BUILD_ROOT' not in os.environ:
+    print('This script must be called from a meson build environment')
+    sys.exit(1)
+
+pkgconf = sys.argv[1]
+os.environ['PKG_CONFIG_PATH'] = os.path.join(os.environ['MESON_BUILD_ROOT'], 'meson-uninstalled')
+linker_flags = subprocess.check_output([pkgconf, '--libs', '--static', 'libdpdk']).decode('utf-8')
+cflags = subprocess.check_output([pkgconf, '--cflags', 'libdpdk']).decode('utf-8')
+
+whole_archive = False
+with open(os.path.join(os.environ['MESON_BUILD_ROOT'], 'cargo_ldflags.txt'), 'w') as dst:
+    for flag in linker_flags.split():
+        if flag == '-pthread':
+            continue
+        elif flag == '-Wl,--whole-archive':
+            whole_archive = True
+        elif flag == '-Wl,--no-whole-archive':
+            whole_archive = False
+        elif flag.startswith('-L'):
+            dst.write(f'cargo:rustc-link-search=native={flag[2:]}\n')
+        elif flag.startswith('-l:'):
+            libname = flag[3:]
+            if libname.startswith('lib'):
+                libname = libname[3:]
+            if libname.endswith('.a'):
+                libname = libname[:-2]
+            if whole_archive:
+                dst.write(f'cargo:rustc-link-lib=static:+whole-archive={libname}\n')
+            else:
+                dst.write(f'cargo:rustc-link-lib=static={libname}\n')
+        elif flag.startswith('-lrte_'):
+            # skip any other DPDK lib flags, we already have them above
+            continue
+        elif flag.startswith('-l'):
+            dst.write(f'cargo:rustc-link-lib={flag[2:]}\n')
+        else:
+            print(f'Warning: Unknown flag: {flag}', file=sys.stderr)
+
+with open(os.path.join(os.environ['MESON_BUILD_ROOT'], 'bindgen_cflags.txt'), 'w') as dst:
+    for flag in cflags.split():
+        dst.write(f'{flag}\n')

buildtools/rust/lib.rs new file +10 -0

new file mode 100644
index 0000000000..f99c54ac42
@@ -0,0 +1,25 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2025 Intel Corporation
+ */
+
+#![allow(non_upper_case_globals)]
+#![allow(non_camel_case_types)]
+#![allow(non_snake_case)]
+
+include!(concat!(env!("OUT_DIR"), "/bindings.rs"));
+