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
#![allow(non_snake_case)]
use {
crate::{engine::Engine, error::DnnlError},
buffer::AlignedBuffer,
descriptor::MemoryDescriptor,
onednnl_sys::{
dnnl_data_type_size,
dnnl_data_type_t::{self, dnnl_f32},
dnnl_engine_kind_t, dnnl_memory, dnnl_memory_create, dnnl_memory_destroy,
dnnl_memory_get_data_handle, dnnl_memory_t, dnnl_status_t, DNNL_GPU_RUNTIME,
DNNL_RUNTIME_OCL, DNNL_RUNTIME_SYCL,
},
std::{ffi::c_void, sync::Arc},
};
/// Get the size for a data type.
pub fn data_type_size(ty: dnnl_data_type_t::Type) -> usize {
unsafe { dnnl_data_type_size(ty) }
}
/// Memory without an underlying buffer
pub const DNNL_MEMORY_NONE: *mut c_void = std::ptr::null_mut();
/// Memory with library allocated buffer
pub const DNNL_MEMORY_ALLOCATE: *mut c_void = (usize::MAX) as *mut c_void;
pub mod buffer;
pub mod descriptor;
#[allow(non_camel_case_types)]
pub mod format_tag;
#[derive(Debug)]
pub enum BufferType<T> {
UserAllocated(AlignedBuffer<T>),
LibraryAllocated,
None,
}
#[derive(Debug)]
pub struct Memory<T> {
pub(crate) handle: dnnl_memory_t,
pub engine: Arc<Engine>,
pub buffer_type: BufferType<T>,
pub desc: MemoryDescriptor,
}
impl<T> Memory<T> {
/// Creates a new memory object with a user-allocated buffer.
///
/// This function initializes a `Memory` instance using a buffer provided by the user.
/// The library does **not** take ownership of the buffer; therefore, the user is responsible
/// for ensuring that the buffer remains valid for the lifetime of the `Memory` object.
///
/// # Safety
///
/// - The user must ensure that the buffer remains valid for the lifetime of the `Memory` object.
/// - The buffer must be properly aligned and sized according to `memory_desc`.
///
/// # Parameters
///
/// - `engine`: An `Arc<Engine>` instance representing the engine to associate with this memory.
/// - `desc`: A `MemoryDescriptor` describing the memory layout.
/// - `buffer`: A raw pointer to the user-allocated buffer.
///
/// # Returns
///
/// - `Ok(Memory)` if the memory object is successfully created.
/// - `Err(DnnlError)` if the creation fails.
///
/// # Example
///
/// ```
/// use {
/// onednnl::{
/// engine::Engine,
/// error::DnnlError,
/// memory::{
/// buffer::AlignedBuffer, data_type_size, descriptor::MemoryDescriptor,
/// format_tag::abcdef, Memory,
/// },
/// },
/// onednnl_sys::dnnl_data_type_t::dnnl_f32,
/// std::{ffi::c_void, sync::Arc},
/// };
///
/// let engine = Arc::new(Engine::new(Engine::CPU, 0).unwrap());
///
/// let dims = [1, 3, 224, 224, 112, 112];
///
/// let mem_desc = MemoryDescriptor::new::<6, abcdef>(dims, dnnl_f32).unwrap();
/// let mut buffer =
/// AlignedBuffer::<f32>::zeroed(mem_desc.get_size() / data_type_size(dnnl_f32)).unwrap();
/// let memory = Memory::new_with_user_buffer(Arc::clone(&engine), mem_desc, buffer);
/// assert!(memory.is_ok());
/// ```
pub fn new_with_user_buffer(
engine: Arc<Engine>,
desc: MemoryDescriptor,
buffer: AlignedBuffer<T>,
) -> Result<Self, DnnlError> {
let mut handle = std::ptr::null_mut::<dnnl_memory>();
let status = match engine.get_kind() {
Ok(dnnl_engine_kind_t::dnnl_cpu) => unsafe {
dnnl_memory_create(
&mut handle,
desc.handle,
engine.handle,
buffer.ptr.as_ptr() as *mut c_void,
)
},
Ok(dnnl_engine_kind_t::dnnl_gpu) => {
if DNNL_GPU_RUNTIME == DNNL_RUNTIME_SYCL {
todo!("Add SYCL interop")
} else if DNNL_GPU_RUNTIME == DNNL_RUNTIME_OCL {
todo!("Add OCL interop")
} else {
todo!("Return Error for lack of a GPU Runtime")
}
}
Ok(dnnl_engine_kind_t::dnnl_any_engine) => {
todo!("Add DNNL ANY interop")
}
Ok(_) => {
panic!("Unexpected engine kind type type")
}
Err(e) => return Err(e),
};
if status == dnnl_status_t::dnnl_success {
Ok(Memory {
handle,
engine,
buffer_type: BufferType::UserAllocated(buffer),
desc,
})
} else {
Err(status.into())
}
}
/// Creates a new memory object with a library-allocated buffer.
/// # Example
///
/// ```
/// use {
/// onednnl::{
/// engine::Engine,
/// error::DnnlError,
/// memory::{descriptor::MemoryDescriptor, format_tag::abcd, Memory},
/// },
/// onednnl_sys::dnnl_data_type_t::dnnl_f32,
/// std::{ffi::c_void, sync::Arc},
/// };
///
/// let engine = Arc::new(Engine::new(Engine::CPU, 0).unwrap());
///
/// let dims = [1, 3, 224, 224];
///
/// let mem_desc = MemoryDescriptor::new::<4, abcd>(dims, dnnl_f32).unwrap();
///
/// let memory = Memory::<f32>::new_with_library_buffer(Arc::clone(&engine), mem_desc);
/// assert!(memory.is_ok());
/// ```
pub fn new_with_library_buffer(
engine: Arc<Engine>,
desc: MemoryDescriptor,
) -> Result<Self, DnnlError> {
let mut handle = std::ptr::null_mut::<dnnl_memory>();
let status = unsafe {
dnnl_memory_create(
&mut handle,
desc.handle,
engine.handle,
DNNL_MEMORY_ALLOCATE,
)
};
if status == dnnl_status_t::dnnl_success {
Ok(Self {
handle,
buffer_type: BufferType::LibraryAllocated,
engine,
desc,
})
} else {
Err(status.into())
}
}
/// Creates a new memory object without an underlying buffer.
/// # Example
///
/// ```
/// use {
/// onednnl::{
/// engine::Engine,
/// error::DnnlError,
/// memory::{descriptor::MemoryDescriptor, format_tag::abcdef, Memory},
/// },
/// onednnl_sys::dnnl_data_type_t::dnnl_f32,
/// std::{ffi::c_void, sync::Arc},
/// };
///
/// let engine = Arc::new(Engine::new(Engine::CPU, 0).unwrap());
///
/// let dims = [1, 3, 224, 224, 112, 112];
///
/// let mem_desc = MemoryDescriptor::new::<6, abcdef>(dims, dnnl_f32).unwrap();
///
/// let memory = Memory::<f32>::new_without_buffer(Arc::clone(&engine), mem_desc);
/// assert!(memory.is_ok());
/// ```
pub fn new_without_buffer(
engine: Arc<Engine>,
desc: MemoryDescriptor,
) -> Result<Self, DnnlError> {
let mut handle = std::ptr::null_mut::<dnnl_memory>();
let status = unsafe {
dnnl_memory_create(&mut handle, desc.handle, engine.handle, DNNL_MEMORY_NONE)
};
if status == dnnl_status_t::dnnl_success {
Ok(Self {
handle,
buffer_type: BufferType::None,
engine,
desc,
})
} else {
Err(status.into())
}
}
pub fn to_vec(&self) -> Result<Vec<T>, DnnlError>
where
T: Clone,
{
match self.engine.get_kind() {
Ok(Engine::CPU) => match &self.buffer_type {
BufferType::UserAllocated(buffer) => Ok(buffer.as_slice().to_vec()),
BufferType::LibraryAllocated => {
let mut buffer_ptr = std::ptr::null_mut();
let status = unsafe {
dnnl_memory_get_data_handle(
self.handle,
&mut buffer_ptr as *mut *mut _ as *mut *mut c_void,
)
};
if status == dnnl_status_t::dnnl_success {
Ok(unsafe {
std::slice::from_raw_parts(
buffer_ptr as *const T,
self.desc.get_size() / data_type_size(dnnl_f32),
)
}
.to_vec())
} else {
Err(status.into())
}
}
BufferType::None => todo!("return error"),
},
Ok(Engine::GPU) => {
todo!("Return the right data")
}
Ok(dnnl_engine_kind_t::dnnl_any_engine) => {
todo!("Return the right data")
}
Ok(t) => {
panic!("Received incorrect engine_kind_t: {}", t)
}
Err(e) => Err(e),
}
}
}
impl<T> Drop for Memory<T> {
fn drop(&mut self) {
unsafe { dnnl_memory_destroy(self.handle) };
}
}
unsafe impl<T> Sync for Memory<T> {}
unsafe impl<T> Send for Memory<T> {}