rdma-io 0.0.2

Safe async Rust bindings for RDMA programming over libibverbs and librdmacm
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
//! SendRecvTransport — concrete [`Transport`](crate::transport::Transport) using RDMA Send/Recv.
//!
//! Owns the QP, buffers, CQ state, and CM connection lifecycle. Created via
//! [`connect`](SendRecvTransport::connect) (client) or
//! [`accept`](SendRecvTransport::accept) (server).

use std::net::SocketAddr;
use std::os::unix::io::RawFd;
use std::sync::Arc;
use std::task::{Context, Poll};

use tokio::io::unix::AsyncFd;

use crate::async_cm::{AsyncCmId, AsyncCmListener};
use crate::async_cq::{AsyncCq, CqPollState};
use crate::async_qp::AsyncQp;
use crate::cm::{CmId, ConnParam, EventChannel, PortSpace};
use crate::mr::{AccessFlags, OwnedMemoryRegion};
use crate::pd::ProtectionDomain;
use crate::qp::QpInitAttr;
use crate::transport::{RecvCompletion, Transport, TransportBuilder};
use crate::wc::WorkCompletion;
use crate::wr::QpType;

/// Configuration for creating an [`SendRecvTransport`].
#[derive(Debug, Clone)]
pub struct SendRecvConfig {
    /// Size of each buffer (send and recv).
    pub buf_size: usize,
    /// Number of pre-posted recv buffers.
    pub num_recv_bufs: usize,
    /// Number of send buffers.
    pub num_send_bufs: usize,
    /// Max inline data size (0 = disabled).
    pub max_inline_data: u32,
    /// QP type (RC for both initially).
    pub qp_type: QpType,
}

impl Default for SendRecvConfig {
    fn default() -> Self {
        Self::stream()
    }
}

impl SendRecvConfig {
    /// Configuration tuned for byte stream workloads (gRPC/tonic).
    pub fn stream() -> Self {
        Self {
            buf_size: 64 * 1024,
            num_recv_bufs: 8,
            num_send_bufs: 1,
            max_inline_data: 0,
            qp_type: QpType::Rc,
        }
    }

    /// Configuration tuned for datagram workloads (Quinn/QUIC).
    pub fn datagram() -> Self {
        Self {
            buf_size: 1500,
            num_recv_bufs: 64,
            num_send_bufs: 4,
            max_inline_data: 64,
            qp_type: QpType::Rc,
        }
    }
}

/// RDMA transport using Send/Recv (two-sided) verbs.
///
/// **Drop order is critical.** Fields drop in declaration order:
/// 1. State fields (no RDMA teardown)
/// 2. QP (destroys QP, flushes all outstanding WRs — CQs are inside AsyncQp)
/// 3. MRs (safe to deregister after QP destroy flushed all WRs)
/// 4. PD (ref-counted, safe anytime)
/// 5. cm_async_fd (deregister from epoll BEFORE closing the fd)
/// 6. cm_id (disconnect/destroy)
/// 7. event_channel (closes the fd — must be LAST)
pub struct SendRecvTransport {
    // -- State (no RDMA teardown) --
    send_cq_state: CqPollState,
    recv_cq_state: CqPollState,
    disconnected: bool,
    peer_disconnected: bool,
    next_send_idx: usize,
    send_in_flight: Vec<bool>,
    config: SendRecvConfig,

    // -- RDMA data-path resources (drop: QP → MRs → PD) --
    qp: AsyncQp,
    send_bufs: Vec<OwnedMemoryRegion>,
    recv_bufs: Vec<OwnedMemoryRegion>,
    _pd: Arc<ProtectionDomain>,

    // -- CM resources (drop: AsyncFd → CmId → EventChannel) --
    cm_async_fd: AsyncFd<RawFd>,
    cm_id: CmId,
    event_channel: EventChannel,
}

impl SendRecvTransport {
    /// Connect to a remote RDMA endpoint (client side).
    pub async fn connect(addr: &SocketAddr, config: SendRecvConfig) -> crate::Result<Self> {
        let async_cm = AsyncCmId::new(PortSpace::Tcp)?;
        async_cm.resolve_addr(None, addr, 2000).await?;
        async_cm.resolve_route(2000).await?;

        let ctx = async_cm
            .verbs_context()
            .ok_or(crate::Error::InvalidArg("no verbs context".into()))?;
        let pd = async_cm.alloc_pd()?;

        let send_cq_depth = config.num_send_bufs as i32 + 1;
        let recv_cq_depth = config.num_recv_bufs as i32 + 1;
        let send_cq = AsyncCq::create_tokio(ctx.clone(), send_cq_depth)?;
        let recv_cq = AsyncCq::create_tokio(ctx, recv_cq_depth)?;

        let qp_attr = make_qp_attr(&config);
        let cmqp =
            async_cm.create_qp_with_cq(&pd, &qp_attr, Some(send_cq.cq()), Some(recv_cq.cq()))?;

        let (send_bufs, recv_bufs) = alloc_buffers(&pd, &config)?;
        let qp = AsyncQp::new(cmqp, send_cq, recv_cq);

        for (i, mr) in recv_bufs.iter().enumerate() {
            qp.post_recv_buffer(mr, i as u64)?;
        }

        async_cm.connect(&ConnParam::default()).await?;

        let (event_channel, cm_id) = async_cm.into_parts();
        let cm_async_fd = AsyncFd::new(event_channel.fd()).map_err(crate::Error::Verbs)?;

        Ok(Self::from_parts(
            qp,
            cm_async_fd,
            cm_id,
            event_channel,
            pd,
            send_bufs,
            recv_bufs,
            config,
        ))
    }

    /// Accept a connection from a listener (server side).
    pub async fn accept(listener: &AsyncCmListener, config: SendRecvConfig) -> crate::Result<Self> {
        let conn_id = listener.get_request().await?;
        Self::complete_accept(conn_id, listener, config).await
    }

    /// Complete accept using a pre-obtained `CmId` from `poll_get_request`.
    ///
    /// Sets up QP, buffers, runs the accept handshake, and migrates the
    /// connection to its own event channel.
    pub async fn complete_accept(
        conn_id: crate::cm::CmId,
        listener: &AsyncCmListener,
        config: SendRecvConfig,
    ) -> crate::Result<Self> {
        let ctx = conn_id
            .verbs_context()
            .ok_or(crate::Error::InvalidArg("no verbs context".into()))?;
        let pd = conn_id.alloc_pd()?;

        let send_cq_depth = config.num_send_bufs as i32 + 1;
        let recv_cq_depth = config.num_recv_bufs as i32 + 1;
        let send_cq = AsyncCq::create_tokio(ctx.clone(), send_cq_depth)?;
        let recv_cq = AsyncCq::create_tokio(ctx, recv_cq_depth)?;

        let qp_attr = make_qp_attr(&config);
        let cmqp =
            conn_id.create_qp_with_cq(&pd, &qp_attr, Some(send_cq.cq()), Some(recv_cq.cq()))?;

        let (send_bufs, recv_bufs) = alloc_buffers(&pd, &config)?;
        let qp = AsyncQp::new(cmqp, send_cq, recv_cq);

        for (i, mr) in recv_bufs.iter().enumerate() {
            qp.post_recv_buffer(mr, i as u64)?;
        }

        let async_cm = listener
            .complete_accept(conn_id, &ConnParam::default())
            .await?;

        let (event_channel, cm_id) = async_cm.into_parts();
        let cm_async_fd = AsyncFd::new(event_channel.fd()).map_err(crate::Error::Verbs)?;

        Ok(Self::from_parts(
            qp,
            cm_async_fd,
            cm_id,
            event_channel,
            pd,
            send_bufs,
            recv_bufs,
            config,
        ))
    }

    #[allow(clippy::too_many_arguments)]
    fn from_parts(
        qp: AsyncQp,
        cm_async_fd: AsyncFd<RawFd>,
        cm_id: CmId,
        event_channel: EventChannel,
        pd: Arc<ProtectionDomain>,
        send_bufs: Vec<OwnedMemoryRegion>,
        recv_bufs: Vec<OwnedMemoryRegion>,
        config: SendRecvConfig,
    ) -> Self {
        let num_send = config.num_send_bufs;
        Self {
            send_cq_state: CqPollState::default(),
            recv_cq_state: CqPollState::default(),
            disconnected: false,
            peer_disconnected: false,
            next_send_idx: 0,
            send_in_flight: vec![false; num_send],
            config,
            qp,
            send_bufs,
            recv_bufs,
            _pd: pd,
            cm_async_fd,
            cm_id,
            event_channel,
        }
    }

    fn check_cm_event(&mut self) -> bool {
        match self.event_channel.try_get_event() {
            Ok(ev) => {
                let etype = ev.event_type();
                ev.ack();
                if etype == crate::cm::CmEventType::Disconnected {
                    self.peer_disconnected = true;
                }
                self.peer_disconnected
            }
            Err(crate::Error::WouldBlock) => false,
            Err(_) => {
                self.peer_disconnected = true;
                true
            }
        }
    }
}

impl Transport for SendRecvTransport {
    fn send_copy(&mut self, data: &[u8]) -> crate::Result<usize> {
        // Find a free send buffer (round-robin with in-flight check)
        let n = self.send_bufs.len();
        let start = self.next_send_idx % n;
        let mut idx = start;
        loop {
            if !self.send_in_flight[idx] {
                break;
            }
            idx = (idx + 1) % n;
            if idx == start {
                return Ok(0); // All send buffers occupied
            }
        }

        let mr = &mut self.send_bufs[idx];
        let len = data.len().min(mr.as_slice().len());
        mr.as_mut_slice()[..len].copy_from_slice(&data[..len]);
        let wr_id = self.config.num_recv_bufs as u64 + idx as u64;
        self.qp.post_send_signaled(mr, 0, len, wr_id)?;
        self.send_in_flight[idx] = true;
        self.next_send_idx = (idx + 1) % n;
        Ok(len)
    }

    fn poll_send_completion(&mut self, cx: &mut Context<'_>) -> Poll<crate::Result<()>> {
        let mut wc_buf = [WorkCompletion::default(); 4];
        let n = match self
            .qp
            .poll_send_cq(cx, &mut self.send_cq_state, &mut wc_buf)
        {
            Poll::Pending => return Poll::Pending,
            Poll::Ready(Err(e)) => return Poll::Ready(Err(e)),
            Poll::Ready(Ok(n)) => n,
        };
        for wc in &wc_buf[..n] {
            if !wc.is_success() {
                self.peer_disconnected = true;
                return Poll::Ready(Err(crate::Error::WorkCompletion {
                    status: wc.status_raw(),
                    vendor_err: wc.vendor_err(),
                }));
            }
            let wr_id = wc.wr_id() as usize;
            if let Some(buf_idx) = wr_id
                .checked_sub(self.config.num_recv_bufs)
                .filter(|&idx| idx < self.send_in_flight.len())
            {
                self.send_in_flight[buf_idx] = false;
            }
        }
        Poll::Ready(Ok(()))
    }

    fn poll_recv(
        &mut self,
        cx: &mut Context<'_>,
        out: &mut [RecvCompletion],
    ) -> Poll<crate::Result<usize>> {
        let max = out.len().min(8);
        let mut wc_buf = [WorkCompletion::default(); 8];
        let n = match self
            .qp
            .poll_recv_cq(cx, &mut self.recv_cq_state, &mut wc_buf[..max])
        {
            Poll::Pending => return Poll::Pending,
            Poll::Ready(Err(e)) => return Poll::Ready(Err(e)),
            Poll::Ready(Ok(n)) => n,
        };
        for i in 0..n {
            if !wc_buf[i].is_success() {
                self.peer_disconnected = true;
                return Poll::Ready(Err(crate::Error::WorkCompletion {
                    status: wc_buf[i].status_raw(),
                    vendor_err: wc_buf[i].vendor_err(),
                }));
            }
            out[i] = RecvCompletion {
                buf_idx: wc_buf[i].wr_id() as usize,
                byte_len: (wc_buf[i].byte_len() as usize).min(self.config.buf_size),
            };
        }
        Poll::Ready(Ok(n))
    }

    fn recv_buf(&self, buf_idx: usize) -> &[u8] {
        self.recv_bufs[buf_idx].as_slice()
    }

    fn repost_recv(&mut self, buf_idx: usize) -> crate::Result<()> {
        self.qp
            .post_recv_buffer(&self.recv_bufs[buf_idx], buf_idx as u64)
    }

    fn poll_disconnect(&mut self, cx: &mut Context<'_>) -> bool {
        if self.peer_disconnected {
            return true;
        }
        loop {
            match self.cm_async_fd.poll_read_ready(cx) {
                Poll::Ready(Ok(mut guard)) => {
                    guard.clear_ready();
                    if self.check_cm_event() {
                        return true;
                    }
                }
                Poll::Pending => {
                    return false;
                }
                Poll::Ready(Err(_)) => {
                    self.peer_disconnected = true;
                    return true;
                }
            }
        }
    }

    fn disconnect(&mut self) -> crate::Result<()> {
        if !self.disconnected {
            self.cm_id.disconnect()?;
            self.disconnected = true;
        }
        Ok(())
    }

    fn local_addr(&self) -> Option<SocketAddr> {
        self.cm_id.local_addr()
    }

    fn peer_addr(&self) -> Option<SocketAddr> {
        self.cm_id.peer_addr()
    }
}

impl Drop for SendRecvTransport {
    fn drop(&mut self) {
        if !self.disconnected {
            let _ = self.cm_id.disconnect();
        }
        // Drain CQ flush completions so the QP releases MR references
        // before MRs are deregistered (field drop order: qp → MRs).
        let mut wc = [crate::wc::WorkCompletion::default(); 16];
        loop {
            match self.qp.send_cq().cq().poll(&mut wc) {
                Ok(0) | Err(_) => break,
                Ok(_) => continue,
            }
        }
        loop {
            match self.qp.recv_cq().cq().poll(&mut wc) {
                Ok(0) | Err(_) => break,
                Ok(_) => continue,
            }
        }
    }
}

// --- Helpers ---

fn make_qp_attr(config: &SendRecvConfig) -> QpInitAttr {
    QpInitAttr {
        qp_type: config.qp_type,
        max_send_wr: config.num_send_bufs as u32 + 1,
        max_recv_wr: config.num_recv_bufs as u32 + 1,
        max_send_sge: 1,
        max_recv_sge: 1,
        max_inline_data: config.max_inline_data,
        sq_sig_all: true,
    }
}

fn alloc_buffers(
    pd: &Arc<ProtectionDomain>,
    config: &SendRecvConfig,
) -> crate::Result<(Vec<OwnedMemoryRegion>, Vec<OwnedMemoryRegion>)> {
    let access = AccessFlags::LOCAL_WRITE;
    let send_bufs = (0..config.num_send_bufs)
        .map(|_| pd.reg_mr_owned(vec![0u8; config.buf_size], access))
        .collect::<crate::Result<Vec<_>>>()?;
    let recv_bufs = (0..config.num_recv_bufs)
        .map(|_| pd.reg_mr_owned(vec![0u8; config.buf_size], access))
        .collect::<crate::Result<Vec<_>>>()?;
    Ok((send_bufs, recv_bufs))
}

impl TransportBuilder for SendRecvConfig {
    type Transport = SendRecvTransport;

    async fn connect(&self, addr: &SocketAddr) -> crate::Result<SendRecvTransport> {
        SendRecvTransport::connect(addr, self.clone()).await
    }

    async fn accept(&self, listener: &AsyncCmListener) -> crate::Result<SendRecvTransport> {
        SendRecvTransport::accept(listener, self.clone()).await
    }
}