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
use std::{
    marker::PhantomData,
    mem::ManuallyDrop,
    ops::{Deref, DerefMut},
};

use const_type_layout::TypeGraphLayout;
use rustacuda::{
    context::Context,
    error::CudaError,
    event::Event,
    memory::{CopyDestination, DeviceBox, DeviceBuffer, LockedBox, LockedBuffer},
    module::Module,
};

use crate::{
    safety::PortableBitSemantics,
    utils::{
        adapter::DeviceCopyWithPortableBitSemantics,
        ffi::{
            DeviceConstPointer, DeviceConstRef, DeviceMutPointer, DeviceMutRef, DeviceOwnedPointer,
            DeviceOwnedRef,
        },
        r#async::{Async, NoCompletion},
    },
};

type InvariantLifetime<'brand> = PhantomData<fn(&'brand ()) -> &'brand ()>;

#[derive(Copy, Clone)]
#[repr(transparent)]
pub struct Stream<'stream> {
    stream: &'stream rustacuda::stream::Stream,
    _brand: InvariantLifetime<'stream>,
}

impl<'stream> Deref for Stream<'stream> {
    type Target = rustacuda::stream::Stream;

    fn deref(&self) -> &Self::Target {
        self.stream
    }
}

impl<'stream> Stream<'stream> {
    #[allow(clippy::needless_pass_by_ref_mut)]
    /// Create a new uniquely branded [`Stream`], which can bind async
    /// operations to the [`Stream`] that they are computed on.
    ///
    /// The uniqueness guarantees are provided by using branded types,
    /// as inspired by the Ghost Cell paper by Yanovski, J., Dang, H.-H.,
    /// Jung, R., and Dreyer, D.: <https://doi.org/10.1145/3473597>.
    ///
    /// # Examples
    ///
    /// The following example shows that two [`Stream`]'s with different
    /// `'stream` lifetime brands cannot be used interchangeably.
    ///
    /// ```rust, compile_fail
    /// use rust_cuda::host::Stream;
    ///
    /// fn check_same<'stream>(_stream_a: Stream<'stream>, _stream_b: Stream<'stream>) {}
    ///
    /// fn two_streams<'stream_a, 'stream_b>(stream_a: Stream<'stream_a>, stream_b: Stream<'stream_b>) {
    ///     check_same(stream_a, stream_b);
    /// }
    /// ```
    pub fn with<O>(
        stream: &mut rustacuda::stream::Stream,
        inner: impl for<'new_stream> FnOnce(Stream<'new_stream>) -> O,
    ) -> O {
        inner(Stream {
            stream,
            _brand: InvariantLifetime::default(),
        })
    }
}

pub trait CudaDroppable: Sized {
    #[allow(clippy::missing_errors_doc)]
    fn drop(val: Self) -> Result<(), (rustacuda::error::CudaError, Self)>;
}

#[repr(transparent)]
pub struct CudaDropWrapper<C: CudaDroppable>(ManuallyDrop<C>);
impl<C: CudaDroppable> crate::alloc::CudaAlloc for CudaDropWrapper<C> {}
impl<C: CudaDroppable> crate::alloc::sealed::alloc::Sealed for CudaDropWrapper<C> {}
impl<C: CudaDroppable> From<C> for CudaDropWrapper<C> {
    fn from(val: C) -> Self {
        Self(ManuallyDrop::new(val))
    }
}
impl<C: CudaDroppable> Drop for CudaDropWrapper<C> {
    fn drop(&mut self) {
        // Safety: drop is only ever called once
        let val = unsafe { ManuallyDrop::take(&mut self.0) };

        if let Err((_err, val)) = C::drop(val) {
            core::mem::forget(val);
        }
    }
}
impl<C: CudaDroppable> Deref for CudaDropWrapper<C> {
    type Target = C;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl<C: CudaDroppable> DerefMut for CudaDropWrapper<C> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<T> CudaDroppable for DeviceBox<T> {
    fn drop(val: Self) -> Result<(), (CudaError, Self)> {
        Self::drop(val)
    }
}

impl<T: rustacuda_core::DeviceCopy> CudaDroppable for DeviceBuffer<T> {
    fn drop(val: Self) -> Result<(), (CudaError, Self)> {
        Self::drop(val)
    }
}

impl<T> CudaDroppable for LockedBox<T> {
    fn drop(val: Self) -> Result<(), (CudaError, Self)> {
        Self::drop(val)
    }
}

impl<T: rustacuda_core::DeviceCopy> CudaDroppable for LockedBuffer<T> {
    fn drop(val: Self) -> Result<(), (CudaError, Self)> {
        Self::drop(val)
    }
}

macro_rules! impl_sealed_drop_value {
    ($type:ty) => {
        impl CudaDroppable for $type {
            fn drop(val: Self) -> Result<(), (CudaError, Self)> {
                Self::drop(val)
            }
        }
    };
}

impl_sealed_drop_value!(Module);
impl_sealed_drop_value!(rustacuda::stream::Stream);
impl_sealed_drop_value!(Context);
impl_sealed_drop_value!(Event);

#[allow(clippy::module_name_repetitions)]
pub struct HostAndDeviceMutRef<'a, T: PortableBitSemantics + TypeGraphLayout> {
    device_box: &'a mut DeviceBox<DeviceCopyWithPortableBitSemantics<T>>,
    host_ref: &'a mut T,
}

impl<'a, T: PortableBitSemantics + TypeGraphLayout> HostAndDeviceMutRef<'a, T> {
    /// # Errors
    ///
    /// Returns a [`CudaError`] iff `value` cannot be moved
    ///  to CUDA or an error occurs inside `inner`.
    pub fn with_new<
        O,
        E: From<CudaError>,
        F: for<'b> FnOnce(HostAndDeviceMutRef<'b, T>) -> Result<O, E>,
    >(
        host_ref: &mut T,
        inner: F,
    ) -> Result<O, E> {
        let mut device_box = CudaDropWrapper::from(DeviceBox::new(
            DeviceCopyWithPortableBitSemantics::from_ref(host_ref),
        )?);

        // Safety: `device_box` contains exactly the device copy of `host_ref`
        let result = inner(HostAndDeviceMutRef {
            device_box: &mut device_box,
            host_ref,
        });

        // Copy back any changes made
        device_box.copy_to(DeviceCopyWithPortableBitSemantics::from_mut(host_ref))?;

        core::mem::drop(device_box);

        result
    }

    /// # Safety
    ///
    /// `device_box` must contain EXACTLY the device copy of `host_ref`
    pub(crate) unsafe fn new_unchecked(
        device_box: &'a mut DeviceBox<DeviceCopyWithPortableBitSemantics<T>>,
        host_ref: &'a mut T,
    ) -> Self {
        Self {
            device_box,
            host_ref,
        }
    }

    #[must_use]
    pub(crate) fn for_device<'b>(&'b mut self) -> DeviceMutRef<'a, T>
    where
        'a: 'b,
    {
        DeviceMutRef {
            pointer: DeviceMutPointer(self.device_box.as_device_ptr().as_raw_mut().cast()),
            reference: PhantomData,
        }
    }

    #[must_use]
    pub(crate) fn for_host<'b: 'a>(&'b self) -> &'a T {
        self.host_ref
    }

    #[must_use]
    pub fn as_ref<'b>(&'b self) -> HostAndDeviceConstRef<'b, T>
    where
        'a: 'b,
    {
        HostAndDeviceConstRef {
            device_box: self.device_box,
            host_ref: self.host_ref,
        }
    }

    #[must_use]
    pub(crate) unsafe fn as_mut<'b>(&'b mut self) -> HostAndDeviceMutRef<'b, T>
    where
        'a: 'b,
    {
        HostAndDeviceMutRef {
            device_box: self.device_box,
            host_ref: self.host_ref,
        }
    }

    #[must_use]
    pub fn into_mut<'b>(self) -> HostAndDeviceMutRef<'b, T>
    where
        'a: 'b,
    {
        HostAndDeviceMutRef {
            device_box: self.device_box,
            host_ref: self.host_ref,
        }
    }

    #[must_use]
    pub fn into_async<'b, 'stream>(
        self,
        stream: Stream<'stream>,
    ) -> Async<'b, 'stream, HostAndDeviceMutRef<'b, T>, NoCompletion>
    where
        'a: 'b,
    {
        Async::ready(self.into_mut(), stream)
    }
}

#[allow(clippy::module_name_repetitions)]
pub struct HostAndDeviceConstRef<'a, T: PortableBitSemantics + TypeGraphLayout> {
    device_box: &'a DeviceBox<DeviceCopyWithPortableBitSemantics<T>>,
    host_ref: &'a T,
}

impl<'a, T: PortableBitSemantics + TypeGraphLayout> Clone for HostAndDeviceConstRef<'a, T> {
    fn clone(&self) -> Self {
        *self
    }
}

impl<'a, T: PortableBitSemantics + TypeGraphLayout> Copy for HostAndDeviceConstRef<'a, T> {}

impl<'a, T: PortableBitSemantics + TypeGraphLayout> HostAndDeviceConstRef<'a, T> {
    /// # Errors
    ///
    /// Returns a [`CudaError`] iff `value` cannot be moved
    ///  to CUDA or an error occurs inside `inner`.
    pub fn with_new<
        O,
        E: From<CudaError>,
        F: for<'b> FnOnce(HostAndDeviceConstRef<'b, T>) -> Result<O, E>,
    >(
        host_ref: &T,
        inner: F,
    ) -> Result<O, E> {
        let device_box = CudaDropWrapper::from(DeviceBox::new(
            DeviceCopyWithPortableBitSemantics::from_ref(host_ref),
        )?);

        // Safety: `device_box` contains exactly the device copy of `host_ref`
        let result = inner(HostAndDeviceConstRef {
            device_box: &device_box,
            host_ref,
        });

        core::mem::drop(device_box);

        result
    }

    /// # Safety
    ///
    /// `device_box` must contain EXACTLY the device copy of `host_ref`
    pub(crate) const unsafe fn new_unchecked(
        device_box: &'a DeviceBox<DeviceCopyWithPortableBitSemantics<T>>,
        host_ref: &'a T,
    ) -> Self {
        Self {
            device_box,
            host_ref,
        }
    }

    #[must_use]
    pub(crate) fn for_device<'b>(&'b self) -> DeviceConstRef<'a, T>
    where
        'a: 'b,
    {
        let mut hack = ManuallyDrop::new(unsafe { std::ptr::read(self.device_box) });

        DeviceConstRef {
            pointer: DeviceConstPointer(hack.as_device_ptr().as_raw().cast()),
            reference: PhantomData,
        }
    }

    #[must_use]
    pub(crate) const fn for_host(&'a self) -> &'a T {
        self.host_ref
    }

    #[must_use]
    pub const fn as_ref<'b>(&'b self) -> HostAndDeviceConstRef<'b, T>
    where
        'a: 'b,
    {
        *self
    }

    #[must_use]
    pub const fn as_async<'b, 'stream>(
        &'b self,
        stream: Stream<'stream>,
    ) -> Async<'b, 'stream, HostAndDeviceConstRef<'b, T>, NoCompletion>
    where
        'a: 'b,
    {
        Async::ready(
            HostAndDeviceConstRef {
                device_box: self.device_box,
                host_ref: self.host_ref,
            },
            stream,
        )
    }
}

#[allow(clippy::module_name_repetitions)]
pub struct HostAndDeviceOwned<'a, T: PortableBitSemantics + TypeGraphLayout> {
    device_box: &'a mut DeviceBox<DeviceCopyWithPortableBitSemantics<T>>,
    host_val: &'a mut T,
}

impl<'a, T: PortableBitSemantics + TypeGraphLayout> HostAndDeviceOwned<'a, T> {
    /// # Errors
    ///
    /// Returns a [`CudaError`] iff `value` cannot be moved
    ///  to CUDA or an error occurs inside `inner`.
    pub fn with_new<O, E: From<CudaError>, F: FnOnce(HostAndDeviceOwned<T>) -> Result<O, E>>(
        mut value: T,
        inner: F,
    ) -> Result<O, E> {
        let mut device_box = CudaDropWrapper::from(DeviceBox::new(
            DeviceCopyWithPortableBitSemantics::from_ref(&value),
        )?);

        // Safety: `device_box` contains exactly the device copy of `value`
        inner(HostAndDeviceOwned {
            device_box: &mut device_box,
            host_val: &mut value,
        })
    }

    #[must_use]
    pub(crate) fn for_device(self) -> DeviceOwnedRef<'a, T> {
        DeviceOwnedRef {
            pointer: DeviceOwnedPointer(self.device_box.as_device_ptr().as_raw_mut().cast()),
            marker: PhantomData::<T>,
            reference: PhantomData::<&'a mut ()>,
        }
    }

    #[must_use]
    pub(crate) fn for_host(&self) -> &T {
        self.host_val
    }

    #[must_use]
    pub const fn into_async<'stream>(
        self,
        stream: Stream<'stream>,
    ) -> Async<'a, 'stream, Self, NoCompletion> {
        Async::ready(self, stream)
    }
}