Initial commit

Author: crazyboycjr

.gitignore

@@ -0,0 +1,21 @@
+bindings.rs
+Cargo.lock
+
+# build
+build/
+# clangd
+.clangd/
+.cache/clangd/
+compile_commands.json
+
+# vim session file
+Session.vim
+# vscode
+*.workspace
+*.code-workspace
+.vscode/
+
+
+# Added by cargo
+
+/target

Cargo.toml

@@ -0,0 +1,29 @@
+[package]
+name = "rdma"
+version = "0.1.0"
+edition = "2021"
+links = "libibverbs"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[build-dependencies]
+bindgen = "0.69.4"
+cc = "1.0.70"
+
+[dependencies]
+phoenix-api = { git = "https://github.com/phoenix-dataplane/phoenix-api", tag = "v0.1.0", optional = true }
+mmap = { git = "https://github.com/phoenix-dataplane/mmap-rs", tag = "v0.1.0", optional = true }
+
+thiserror = "1.0.29"
+log = "0.4.14"
+libc = "0.2.103"
+static_assertions = "1.1.0"
+socket2 = "0.4.7"
+memfd = "0.4.1"
+bincode = { version = "1.3.3", optional = true }
+serde = { version = "1.0.130", features = ["derive"], optional = true }
+spin = { version = "0.9.3", optional = true }
+lazy_static = { version = "1.4.0", optional = true }
+nix = { version = "0.25.0", default-features = false, features = ["socket", "net"] }
+
+[features]
+phoenix = ["dep:phoenix-api", "dep:serde", "dep:bincode", "dep:mmap", "dep:spin", "dep:lazy_static"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 phoenix-dataplane
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,34 @@
+# rdma-rs
+
+Rust API wrapping the `ibverbs` and `rdmacm` Remote Direct Memory Access (RDMA) library.
+
+TODO:
+- add docs to APIs
+- remove in function assertions and logs
+- add examples
+
+To manually generate the binding, use this
+```
+~/.cargo/bin/bindgen \
+	-o bindings.rs \
+	--blocklist-type max_align_t \
+	--blocklist-type ibv_wc \
+	--no-prepend-enum-name \
+	--bitfield-enum ibv_access_flags \
+	--bitfield-enum ibv_qp_attr_mask \
+	--bitfield-enum ibv_wc_flags \
+	--bitfield-enum ibv_send_flags \
+	--bitfield-enum ibv_port_cap_flags \
+	--constified-enum-module ibv_qp_type \
+	--constified-enum-module ibv_qp_state \
+	--constified-enum-module ibv_port_state \
+	--constified-enum-module ibv_wc_opcode \
+	--constified-enum-module ibv_wr_opcode \
+	--constified-enum-module ibv_wc_status \
+	--constified-enum-module rdma_port_space \
+	--constified-enum-module rdma_cm_event_type \
+	src/rdma_verbs_wrapper.h -- -I/usr/include
+```
+
+# Acknowledgement
+This crate is developed based on [rust-ibverbs](https://github.com/jonhoo/rust-ibverbs).

build.rs

@@ -0,0 +1,86 @@
+extern crate bindgen;
+
+use std::env;
+use std::path::PathBuf;
+
+fn main() {
+    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
+
+    println!("You need to have librdmacm and libibverbs installed in your system.");
+    println!("cargo:rerun-if-changed=src/rdma_verbs_wrapper.c");
+
+    // let mut cc_command = cc::Build::new()
+    //     .warnings(true)
+    //     .opt_level(3)
+    //     .cargo_metadata(false)
+    //     .pic(true)
+    //     .use_plt(false)
+    //     .shared_flag(true)
+    //     .static_flag(true)
+    //     .get_compiler()
+    //     .to_command();
+
+    // // Compile dynamic library manually as cc-rs is not intended to create dynamic library.
+    // cc_command.args([
+    //     "src/rdma_verbs_wrapper.c",
+    //     "-o",
+    //     &out_path.join("librdma_verbs_wrapper.so").to_string_lossy(),
+    // ]);
+
+    // // COMMENT(cjr): Remove this comment to see the compiler command.
+    // // println!("cargo:warning=compiler command: {:?}", cc_command);
+    // cc_command
+    //     .spawn()
+    //     .expect("Failed to build the shared library");
+
+    cc::Build::new()
+        .warnings(true)
+        .opt_level(3)
+        .cargo_metadata(false)
+        .pic(true)
+        .use_plt(false)
+        .shared_flag(true)
+        .static_flag(true)
+        .file("src/rdma_verbs_wrapper.c")
+        .compile("rdma_verbs_wrapper");
+
+    let bindings = bindgen::Builder::default()
+        .header("src/rdma_verbs_wrapper.h")
+        .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
+        .blocklist_type("max_align_t")
+        .blocklist_type("ibv_wc")
+        .bitfield_enum("ibv_access_flags")
+        .bitfield_enum("ibv_qp_attr_mask")
+        .bitfield_enum("ibv_wc_flags")
+        .bitfield_enum("ibv_send_flags")
+        .bitfield_enum("ibv_port_cap_flags")
+        .constified_enum_module("ibv_qp_type")
+        .constified_enum_module("ibv_qp_state")
+        .constified_enum_module("ibv_port_state")
+        .constified_enum_module("ibv_wc_opcode")
+        .constified_enum_module("ibv_wr_opcode")
+        .constified_enum_module("ibv_wc_status")
+        .constified_enum_module("rdma_port_space")
+        .constified_enum_module("rdma_cm_event_type")
+        .derive_default(true)
+        .derive_debug(true)
+        .generate()
+        .expect("Unable to generate bindings");
+
+    // Write the bindings to the $OUT_DIR/bindings.rs file.
+    bindings
+        .write_to_file(out_path.join("bindings.rs"))
+        .expect("Couldn't write bindings!");
+
+    println!("cargo:rustc-link-search=native={}", out_path.display());
+    println!("cargo:rustc-link-lib=static=rdma_verbs_wrapper");
+    // println!("cargo:rustc-link-lib=dylib=rdma_verbs_wrapper");
+    // println!("cargo:rustc-link-arg=-Wl,-rpath={}", out_path.display());
+    // println!(
+    //     "cargo:rustc-cdylib-link-arg=-Wl,-rpath={}",
+    //     out_path.display()
+    // );
+
+    println!("cargo:rustc-link-lib=ibverbs");
+    println!("cargo:rustc-link-lib=rdmacm");
+}