https://github.com/nugine/rdma
Low-level RDMA API
https://github.com/nugine/rdma
rdma rust
Last synced: 18 days ago
JSON representation
Low-level RDMA API
- Host: GitHub
- URL: https://github.com/nugine/rdma
- Owner: Nugine
- License: mit
- Created: 2022-05-22T11:37:57.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-22T06:47:00.000Z (over 1 year ago)
- Last Synced: 2024-11-21T22:31:01.310Z (5 months ago)
- Topics: rdma, rust
- Language: Rust
- Homepage:
- Size: 564 KB
- Stars: 30
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rdma
[![Latest Version]][crates.io]
[![Documentation]][docs.rs]
![License]
Low-level RDMA API.
[crates.io]: https://crates.io/crates/rdma
[Latest Version]: https://img.shields.io/crates/v/rdma.svg
[Documentation]: https://docs.rs/rdma/badge.svg
[docs.rs]: https://docs.rs/rdma
[License]: https://img.shields.io/crates/l/rdma.svg
# Environment
This crate requires the latest [rdma-core](https://github.com/linux-rdma/rdma-core) installation.
Please make sure the following commands work:
```bash
$ pkg-config --modversion libibverbs
1.14.41.0
$ pkg-config --modversion librdmacm
1.3.41.0
```
The output also shows the minimum required versions.
# Develop
## Examples
Add a Soft-RoCE device:
```bash
sudo rdma link add rxe0 type rxe netdev ens33
```
`rxe0` is the RDMA device name. You can name it whatever you want. `ens33` is the name of a network device. The name of the network device may be different. You can see it by running command `ifconfig`.
There is a tutorial for Chinese users: .
Please install the tool [just](https://github.com/casey/just) if you don't have it.
Install the examples:
```bash
just install-examples
```
Run the example `rdma-devices`:
```
$ rdma-devices
| name | guid |
| ---- | ---------------- |
| rxe0 | 26418cfffe021df9 |
```
Run the example `rdma-pingpong`:
+ RC service
+ server side
```bash
rdma-pingpong rc
```
+ client side
```bash
rdma-pingpong rc 127.0.0.1
```
+ UD service
+ server side
```bash
rdma-pingpong ud
```
+ client side
```bash
rdma-pingpong ud 127.0.0.1
```
Run the benchmarks:
```bash
just bench-pingpong-rc
just bench-pingpong-ud
```
Run the example `rdma-async`:
```bash
rdma-async-rpc
```
## Memory Management
All the APIs related with raw memory are unsafe.
We are exploring how to provide a safe and easy way to manage memory in RDMA.
The example [rdma-async](examples/rdma-async/src/bin/rdma-async-rpc.rs) may give you inspiration.
## Resource Management
The RDMA resources are managed by reference counting.
The graph below shows the relations between resources.
