rocm-rt 0.2.2

ROCm abstraction runtime core
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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
use core::{cell::UnsafeCell, marker::PhantomData, mem::ManuallyDrop, slice::from_raw_parts};

use rocm_sys::hip::{
    hipFree, hipHostFree, hipHostMalloc, hipHostRegister, hipHostUnregister, hipMalloc,
    hipMemPool_t, hipMemcpyDtoD, hipMemcpyDtoH, hipMemcpyHtoD, hipMemset,
};

use crate::hip::{HipError, device::Device};

/// Handle to CPU memory, mapped to all GPUs on the device
#[derive(Debug)]
pub struct DevMapped<'a> {
    pub(crate) data: &'a [u8],
    _marker: PhantomData<UnsafeCell<()>>,
}

impl<'a> DevMapped<'a> {
    pub fn new(data: &'a mut [u8]) -> Result<Self, HipError> {
        unsafe {
            try_err!(hipHostRegister(data.as_mut_ptr().cast(), data.len(), 0));
        }

        Ok(Self {
            data,
            _marker: PhantomData,
        })
    }

    pub const unsafe fn from_slice(data: &'a [u8]) -> Self {
        Self {
            data,
            _marker: PhantomData,
        }
    }

    pub const fn as_slice(&self) -> &[u8] {
        self.data
    }

    pub const fn size(&self) -> usize {
        self.data.len()
    }

    /// Maps the buffer such that is is accessible
    // TODO: remove `unsafe`
    pub unsafe fn map(&self) -> Result<(), HipError> {
        unsafe {
            try_err!(
                hipHostRegister(self.data.as_ptr() as *mut _, self.data.len(), 0),
                Ok(())
            )
        }
    }

    /// Unmaps the buffer such that is is inaccessible
    ///
    /// # Safety
    ///
    /// The buffer must never be deallocated again or dropped.
    pub unsafe fn unmap(&self) -> Result<(), HipError> {
        unsafe { try_err!(hipHostUnregister(self.data.as_ptr() as *mut _), Ok(())) }
    }

    pub fn copy_to_dev(
        &self,
        other: &Buffer,
        src_off: usize,
        dst_off: usize,
        len: usize,
    ) -> Result<(), HipError> {
        if src_off.checked_add(len).is_none_or(|end| end > self.size())
            || dst_off
                .checked_add(len)
                .is_none_or(|end| end > other.size as usize)
        {
            return Err(HipError::InvalidValue);
        }

        unsafe { self.copy_to_dev_unchecked(other, src_off, dst_off, len) }
    }

    pub unsafe fn copy_to_dev_unchecked(
        &self,
        other: &Buffer,
        src_off: usize,
        dst_off: usize,
        len: usize,
    ) -> Result<(), HipError> {
        unsafe {
            try_err!(
                hipMemcpyHtoD(
                    other.ptr.add(dst_off).cast(),
                    self.data.as_ptr().add(src_off).cast(),
                    len
                ),
                Ok(())
            )
        }
    }

    pub fn copy_from_dev(
        &self,
        other: &Buffer,
        src_off: usize,
        dst_off: usize,
        len: usize,
    ) -> Result<(), HipError> {
        if src_off.checked_add(len).is_none_or(|end| end > self.size())
            || dst_off
                .checked_add(len)
                .is_none_or(|end| end > other.size as usize)
        {
            return Err(HipError::InvalidValue);
        }

        unsafe { self.copy_from_dev_unchecked(other, src_off, dst_off, len) }
    }

    pub unsafe fn copy_from_dev_unchecked(
        &self,
        other: &Buffer,
        src_off: usize,
        dst_off: usize,
        len: usize,
    ) -> Result<(), HipError> {
        unsafe {
            try_err!(
                hipMemcpyDtoH(
                    self.data.as_ptr().add(src_off) as *mut _,
                    other.ptr.add(dst_off).cast(),
                    len
                ),
                Ok(())
            )
        }
    }
}

/// Handle to CPU memory, mapped to all GPUs on the device
#[repr(C)]
#[derive(Debug)]
pub struct DevMappedAlloc {
    pub(crate) ptr: *mut u8,
    pub(crate) size: usize,
    _marker: PhantomData<UnsafeCell<()>>,
}

impl DevMappedAlloc {
    pub fn new(data: &[u8]) -> Result<Self, HipError> {
        let size = data.len();

        let buf = Self::alloc(size)?;

        unsafe {
            buf.ptr.copy_from_nonoverlapping(data.as_ptr(), size);
        }

        Ok(buf)
    }

    /// Allocates `size` bytes and makes it accessible from all HIP devices
    pub fn alloc(size: usize) -> Result<Self, HipError> {
        let ptr: Result<*mut u8, HipError> =
            unsafe { wrap_sys_res!(|ptr| hipHostMalloc((&raw mut ptr).cast(), size, 0)) };
        let ptr = ptr?;

        if ptr.is_null() {
            return Err(HipError::InvalidValue);
        }

        Ok(Self {
            ptr,
            size,
            _marker: PhantomData,
        })
    }

    pub const unsafe fn from_raw_parts(ptr: *mut u8, size: usize) -> Self {
        Self {
            ptr,
            size,
            _marker: PhantomData,
        }
    }

    pub fn borrowed(&mut self) -> DevMapped<'_> {
        unsafe { DevMapped::from_slice(self.as_slice()) }
    }

    pub const fn as_ptr(&self) -> *mut u8 {
        self.ptr
    }

    pub const fn as_slice(&self) -> &[u8] {
        unsafe { from_raw_parts(self.ptr, self.size) }
    }

    pub const fn size(&self) -> usize {
        self.size
    }

    /// Deallocates the GPU-accessible buffer and synchronizes
    ///
    /// This allows you to safely handle errors which would normally panic when dropped.
    pub fn dealloc(self) -> Result<(), HipError> {
        let handle = ManuallyDrop::new(self);

        unsafe {
            handle.dealloc_unchecked()?;
        }

        Ok(())
    }

    /// Deallocates the GPU-accessible buffer and synchronizes
    ///
    /// # Safety
    ///
    /// The buffer must never be deallocated again or dropped and the buffer can't be used again.
    pub unsafe fn dealloc_unchecked(&self) -> Result<(), HipError> {
        unsafe { try_err!(hipHostFree(self.ptr.cast()), Ok(())) }
    }
}

impl Drop for DevMappedAlloc {
    fn drop(&mut self) {
        unsafe {
            let _ = self.dealloc_unchecked();
        }
    }
}

/// Handle to an allocation on the GPU
#[repr(C)]
#[derive(Debug)]
pub struct Buffer {
    pub(crate) ptr: *mut u8,
    pub(crate) size: u32,
    pub(crate) dev: Device, // check ptr and dev on use
    _marker: PhantomData<UnsafeCell<()>>,
}

impl Device {
    /// Allocates `size` bytes on the default device
    pub fn alloc(self, size: u32) -> Result<Buffer, HipError> {
        self.set_default()?;

        let ptr: Result<*mut u8, HipError> =
            unsafe { wrap_sys_res!(|ptr| hipMalloc((&raw mut ptr).cast(), size as usize)) };
        let ptr = ptr?;

        if ptr.is_null() {
            return Err(HipError::InvalidValue);
        }

        Ok(Buffer {
            ptr,
            size,
            dev: self,
            _marker: PhantomData,
        })
    }

    /// Allocates `size` zeroed bytes on the default device
    pub fn alloc_zeroed(self, size: u32) -> Result<Buffer, HipError> {
        self.set_default()?;

        let ptr: Result<*mut u8, HipError> =
            unsafe { wrap_sys_res!(|ptr| hipMalloc((&raw mut ptr).cast(), size as usize)) };
        let ptr = ptr?;

        if ptr.is_null() {
            return Err(HipError::InvalidValue);
        }

        unsafe {
            try_err!(hipMemset(ptr.cast(), 0, size as usize));
        }

        Ok(Buffer {
            ptr,
            size,
            dev: self,
            _marker: PhantomData,
        })
    }
}

impl Buffer {
    /// Constructs a GPU buffer from a raw pointer and size
    pub const unsafe fn from_raw_parts(ptr: *mut u8, size: u32, dev: Device) -> Self {
        Self {
            ptr,
            size,
            dev,
            _marker: PhantomData,
        }
    }

    /// Gets the pointer to GPU memory
    pub const fn as_ptr(&self) -> *mut u8 {
        self.ptr
    }

    /// Gets the size of the allocation
    pub const fn size(&self) -> u32 {
        self.size
    }

    /// Deallocates a buffer
    ///
    /// This allows you to safely handle errors which would normally panic when dropped.
    pub fn dealloc(self) -> Result<(), HipError> {
        let handle = ManuallyDrop::new(self);

        unsafe {
            handle.dealloc_unchecked()?;
        }

        Ok(())
    }

    /// Deallocates a buffer
    ///
    /// # Safety
    ///
    /// The buffer must never be deallocated again or dropped.
    pub unsafe fn dealloc_unchecked(&self) -> Result<(), HipError> {
        unsafe { try_err!(hipFree(self.ptr.cast()), Ok(())) }
    }

    pub fn copy_to_host(
        &self,
        dst: &DevMapped,
        src_off: usize,
        dst_off: usize,
        len: usize,
    ) -> Result<(), HipError> {
        if src_off
            .checked_add(len)
            .is_none_or(|end| end > self.size as usize)
            || dst_off.checked_add(len).is_none_or(|end| end > dst.size())
        {
            return Err(HipError::InvalidValue);
        }

        unsafe { self.copy_to_host_unchecked(dst, src_off, dst_off, len) }
    }

    pub unsafe fn copy_to_host_unchecked(
        &self,
        dst: &DevMapped,
        src_off: usize,
        dst_off: usize,
        len: usize,
    ) -> Result<(), HipError> {
        unsafe {
            try_err!(
                hipMemcpyDtoH(
                    dst.data.as_ptr().add(dst_off) as *mut _,
                    self.ptr.add(src_off).cast(),
                    len
                ),
                Ok(())
            )
        }
    }

    pub fn copy_from_host(
        &self,
        src: &DevMapped,
        src_off: usize,
        dst_off: usize,
        len: usize,
    ) -> Result<(), HipError> {
        if src_off.checked_add(len).is_none_or(|end| end > src.size())
            || dst_off
                .checked_add(len)
                .is_none_or(|end| end > self.size as usize)
        {
            return Err(HipError::InvalidValue);
        }

        unsafe { self.copy_from_host_unchecked(src, src_off, dst_off, len) }
    }

    pub unsafe fn copy_from_host_unchecked(
        &self,
        src: &DevMapped,
        src_off: usize,
        dst_off: usize,
        len: usize,
    ) -> Result<(), HipError> {
        unsafe {
            try_err!(
                hipMemcpyHtoD(
                    self.ptr.add(dst_off).cast(),
                    src.data.as_ptr().add(src_off).cast(),
                    len
                ),
                Ok(())
            )
        }
    }

    pub fn copy_from(
        &self,
        src: &Self,
        src_off: usize,
        dst_off: usize,
        len: usize,
    ) -> Result<(), HipError> {
        if src_off
            .checked_add(len)
            .is_none_or(|end| end > src.size as usize)
            || dst_off
                .checked_add(len)
                .is_none_or(|end| end > self.size as usize)
            || self.ptr == src.ptr
            || self.dev != src.dev
        {
            return Err(HipError::InvalidValue);
        }

        unsafe { self.copy_from_unchecked(src, src_off, dst_off, len) }
    }

    pub fn copy_to(
        &self,
        dst: &Self,
        src_off: usize,
        dst_off: usize,
        len: usize,
    ) -> Result<(), HipError> {
        if src_off
            .checked_add(len)
            .is_none_or(|end| end > self.size as usize)
            || dst_off
                .checked_add(len)
                .is_none_or(|end| end > dst.size as usize)
            || self.ptr == dst.ptr
            || self.dev != dst.dev
        {
            return Err(HipError::InvalidValue);
        }

        unsafe { dst.copy_from_unchecked(self, src_off, dst_off, len) }
    }

    pub unsafe fn copy_from_unchecked(
        &self,
        src: &Self,
        src_off: usize,
        dst_off: usize,
        len: usize,
    ) -> Result<(), HipError> {
        unsafe {
            try_err!(
                hipMemcpyDtoD(
                    self.ptr.add(dst_off).cast(),
                    src.ptr.add(src_off).cast(),
                    len
                ),
                Ok(())
            )
        }
    }
}

impl Drop for Buffer {
    fn drop(&mut self) {
        unsafe {
            let _ = self.dealloc_unchecked();
        }
    }
}

#[repr(transparent)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct MemPool {
    mem_pool: hipMemPool_t,
}