ibverbs-rs 0.4.1

Safe, ergonomic Rust bindings for the InfiniBand libibverbs API
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

use crate::channel::Channel;
use crate::channel::PreparedChannel;
use crate::ibverbs::access_config::AccessFlags;
use crate::ibverbs::error::{IbvError, IbvResult};
use crate::ibverbs::protection_domain::ProtectionDomain;
use crate::ibverbs::queue_pair::builder::QueuePairEndpoint;
use crate::ibverbs::queue_pair::config::{
    AckTimeout, MaxAckRetries, MaxRnrRetries, MaximumTransferUnit, MinRnrTimer,
    PacketSequenceNumber,
};
use crate::multi_channel::MultiChannel;
use bon::bon;

#[bon]
impl MultiChannel {
    #[builder(state_mod(vis = "pub"))]
    pub fn builder(
        num_channels: usize,
        pd: &ProtectionDomain,
        #[builder(default =
            AccessFlags::new()
                .with_local_write()
                .with_remote_read()
                .with_remote_write()
        )]
        access: AccessFlags,
        #[builder(default = 32)] min_cq_entries: u32,
        #[builder(default = 16)] max_send_wr: u32,
        #[builder(default = 16)] max_recv_wr: u32,
        #[builder(default = 16)] max_send_sge: u32,
        #[builder(default = 16)] max_recv_sge: u32,
        #[builder(default)] max_rnr_retries: MaxRnrRetries,
        #[builder(default)] max_ack_retries: MaxAckRetries,
        #[builder(default)] min_rnr_timer: MinRnrTimer,
        #[builder(default)] ack_timeout: AckTimeout,
        #[builder(default)] mtu: MaximumTransferUnit,
        #[builder(default)] send_psn: PacketSequenceNumber,
        #[builder(default)] recv_psn: PacketSequenceNumber,
    ) -> IbvResult<PreparedMultiChannel> {
        let channels = (0..num_channels)
            .map(|_| {
                Channel::builder()
                    .pd(pd)
                    .min_cq_entries(min_cq_entries)
                    .access(access)
                    .max_send_wr(max_send_wr)
                    .max_recv_wr(max_recv_wr)
                    .max_send_sge(max_send_sge)
                    .max_recv_sge(max_recv_sge)
                    .max_rnr_retries(max_rnr_retries)
                    .max_ack_retries(max_ack_retries)
                    .min_rnr_timer(min_rnr_timer)
                    .ack_timeout(ack_timeout)
                    .mtu(mtu)
                    .send_psn(send_psn)
                    .recv_psn(recv_psn)
                    .build()
            })
            .collect::<IbvResult<_>>()?;

        Ok(PreparedMultiChannel {
            channels,
            pd: pd.clone(),
        })
    }
}

/// A [`MultiChannel`] that has been configured but not yet connected to a remote peer.
///
/// Created by [`MultiChannel::builder`]. Call [`endpoints`](Self::endpoints) to obtain the
/// local connection information for each channel, exchange them with the remote side, then
/// call [`handshake`](Self::handshake) with the remote's endpoints to finish the connections.
pub struct PreparedMultiChannel {
    channels: Box<[PreparedChannel]>,
    pd: ProtectionDomain,
}

impl PreparedMultiChannel {
    /// Returns the local endpoint information for each channel, needed by the remote peer.
    pub fn endpoints(&self) -> Box<[QueuePairEndpoint]> {
        self.channels.iter().map(|c| c.endpoint()).collect()
    }

    /// Connects each channel to the remote endpoint at the same index and returns a ready-to-use [`MultiChannel`].
    pub fn handshake<I>(self, endpoints: I) -> IbvResult<MultiChannel>
    where
        I: IntoIterator<Item = QueuePairEndpoint>,
        I::IntoIter: ExactSizeIterator,
    {
        let endpoints = endpoints.into_iter();
        if self.channels.len() != endpoints.len() {
            return Err(IbvError::InvalidInput(format!(
                "Expected {} endpoints but got {}",
                self.channels.len(),
                endpoints.len()
            )));
        }

        let channels = self
            .channels
            .into_iter()
            .zip(endpoints)
            .map(|(channel, endpoint)| channel.handshake(endpoint))
            .collect::<Result<_, _>>()?;

        Ok(MultiChannel {
            channels,
            pd: self.pd,
        })
    }
}