rdma 0.3.0

Low-level RDMA 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
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

use crate::bindings as C;
use crate::device::Gid;
use crate::error::create_resource;
use crate::pd::ProtectionDomain;

use std::io;
use std::mem;
use std::ptr::NonNull;
use std::sync::Arc;

#[derive(Clone)]
pub struct AddressHandle(Arc<Owner>);

impl AddressHandle {
    pub(crate) fn ffi_ptr(&self) -> *mut C::ibv_ah {
        self.0.ffi_ptr()
    }

    #[inline]
    #[must_use]
    pub fn options() -> AddressHandleOptions {
        AddressHandleOptions::default()
    }

    #[inline]
    pub fn create(pd: &ProtectionDomain, mut options: AddressHandleOptions) -> io::Result<Self> {
        // SAFETY: ffi
        let owner = unsafe {
            let attr = &mut options.attr;
            let ah = create_resource(
                || C::ibv_create_ah(pd.ffi_ptr(), attr),
                || "failed to create address handle",
            )?;
            Arc::new(Owner {
                ah,
                _pd: pd.clone(),
            })
        };
        Ok(Self(owner))
    }
}

struct Owner {
    ah: NonNull<C::ibv_ah>,

    _pd: ProtectionDomain,
}

// SAFETY: owned type
unsafe impl Send for Owner {}
// SAFETY: owned type
unsafe impl Sync for Owner {}

impl Owner {
    fn ffi_ptr(&self) -> *mut C::ibv_ah {
        self.ah.as_ptr()
    }
}

impl Drop for Owner {
    fn drop(&mut self) {
        // SAFETY: ffi
        unsafe {
            let ah = self.ffi_ptr();
            let ret = C::ibv_destroy_ah(ah);
            assert_eq!(ret, 0);
        }
    }
}

#[derive(Clone)]
pub struct AddressHandleOptions {
    attr: C::ibv_ah_attr,
}

impl Default for AddressHandleOptions {
    #[inline]
    fn default() -> Self {
        Self {
            // SAFETY: POD ffi type
            attr: unsafe { mem::zeroed() },
        }
    }
}

impl AddressHandleOptions {
    pub(crate) fn into_ctype(self) -> C::ibv_ah_attr {
        self.attr
    }

    #[inline]
    pub fn dest_lid(&mut self, dest_lid: u16) -> &mut Self {
        self.attr.dlid = dest_lid;
        self
    }

    #[inline]
    pub fn service_level(&mut self, service_level: u8) -> &mut Self {
        self.attr.sl = service_level;
        self
    }

    #[inline]
    pub fn port_num(&mut self, port_num: u8) -> &mut Self {
        self.attr.port_num = port_num;
        self
    }

    #[inline]
    pub fn global_route_header(&mut self, global_route_header: GlobalRoute) -> &mut Self {
        self.attr.is_global = 1;
        self.attr.grh = global_route_header.into_ctype();
        self
    }
}

#[repr(C)]
pub struct GlobalRoute {
    pub dest_gid: Gid,
    pub flow_label: u32,
    pub sgid_index: u8,
    pub hop_limit: u8,
    pub traffic_class: u8,
}

impl GlobalRoute {
    fn into_ctype(self) -> C::ibv_global_route {
        // SAFETY: same repr
        unsafe { mem::transmute(self) }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn global_route_layout() {
        assert_eq!(
            mem::size_of::<GlobalRoute>(),
            mem::size_of::<C::ibv_global_route>()
        );
        assert_eq!(
            mem::align_of::<GlobalRoute>(),
            mem::align_of::<C::ibv_global_route>()
        );

        assert_eq!(
            offset_of!(GlobalRoute, dest_gid),
            offset_of!(C::ibv_global_route, dgid)
        );
        assert_eq!(
            offset_of!(GlobalRoute, flow_label),
            offset_of!(C::ibv_global_route, flow_label)
        );
        assert_eq!(
            offset_of!(GlobalRoute, sgid_index),
            offset_of!(C::ibv_global_route, sgid_index)
        );
        assert_eq!(
            offset_of!(GlobalRoute, hop_limit),
            offset_of!(C::ibv_global_route, hop_limit)
        );
        assert_eq!(
            offset_of!(GlobalRoute, traffic_class),
            offset_of!(C::ibv_global_route, traffic_class)
        );
    }
}