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

//! Provides a representation for one or many ready to use hardwares.
//!
//! Devices are a set of hardwares, which were initialized by the framework, in the order that they
//! were ready to receive kernel executions, event processing, memory synchronization, etc. You can
//! turn available hardware into a device, through the [backend][backend].
//!
//! [backend]: ../backend/index.html
use std::any::Any;

#[cfg(feature = "cuda")]
use crate::frameworks::cuda::DriverError as CudaError;
#[cfg(feature = "native")]
use crate::frameworks::native::Error as NativeError;
use crate::hardware::IHardware;
#[cfg(feature = "opencl")]
use frameworks::opencl::Error as OpenCLError;
use std::{error, fmt};

/// Marker trait for backing memory.
pub trait IMemory {}

/// Specifies Hardware behavior across frameworks.
pub trait IDevice
where
    Self: Any + Clone + Eq + Any + MemorySync,
{
    /// The Hardware representation for this Device.
    type H: IHardware;
    /// The Memory representation for this Device.
    type M: IMemory + Any;
    /// Returns the unique identifier of the Device.
    fn id(&self) -> &isize;
    /// Returns the hardwares, which define the Device.
    fn hardwares(&self) -> &Vec<Self::H>;
    /// Allocate memory on the Device.
    fn alloc_memory(&self, size: usize) -> Result<Self::M, Error>;
}

/// This trait should be implemented for `Device`.
/// Use of `Any` everywhere is ugly, but it looks like there is no other way
/// to do it if we want to extract CUDA stuff into its own crate completely,
/// so that base crate knows nothing about it at all.
pub trait MemorySync {
    /// FIXME
    fn sync_in(
        &self,
        my_memory: &mut dyn Any,
        src_device: &dyn Any,
        src_memory: &dyn Any,
    ) -> Result<(), Error>;
    /// FIXME
    fn sync_out(
        &self,
        my_memory: &dyn Any,
        dst_device: &dyn Any,
        dst_memory: &mut dyn Any,
    ) -> Result<(), Error>;
}

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
/// Defines a generic set of Memory Errors.
pub enum Error {
    /// No route found for memory transfer between devices
    NoMemorySyncRoute,
    /// Framework error at memory synchronization.
    MemorySyncError,
    /// Framework error at memory allocation.
    MemoryAllocationError,

    /// Failures related to the Native framework implementation.
    #[cfg(feature = "native")]
    Native(NativeError),
    /// Failures related to the OpenCL framework implementation.
    #[cfg(feature = "opencl")]
    OpenCL(OpenCLError),
    /// Failures related to the Cuda framework implementation.
    #[cfg(feature = "cuda")]
    Cuda(CudaError),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let msg = match *self {
            Error::NoMemorySyncRoute => "No available memory synchronization route".to_string(),
            Error::MemorySyncError => "Memory synchronization failed".to_string(),
            Error::MemoryAllocationError => "Memory allocation failed".to_string(),

            #[cfg(feature = "native")]
            Error::Native(ref err) => format!("Native error: {}", err.to_string()),
            #[cfg(feature = "opencl")]
            Error::OpenCL(ref err) => format!("OpenCL error: {}", err.to_string()),
            #[cfg(feature = "cuda")]
            Error::Cuda(ref err) => format!("Cuda error: {}", err.to_string()),
        };

        write!(f, "{}", msg)
    }
}

impl error::Error for Error {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match *self {
            Error::NoMemorySyncRoute => None,
            Error::MemorySyncError => None,
            Error::MemoryAllocationError => None,

            #[cfg(feature = "native")]
            Error::Native(ref err) => Some(err),
            #[cfg(feature = "opencl")]
            Error::OpenCL(ref err) => Some(err),
            #[cfg(feature = "cuda")]
            Error::Cuda(ref err) => Some(err),
        }
    }
}

#[cfg(feature = "native")]
impl From<NativeError> for Error {
    fn from(err: NativeError) -> Error {
        Error::Native(err)
    }
}

#[cfg(feature = "opencl")]
impl From<OpenCLError> for Error {
    fn from(err: OpenCLError) -> Error {
        Error::OpenCL(err)
    }
}

#[cfg(feature = "cuda")]
impl From<CudaError> for Error {
    fn from(err: CudaError) -> Error {
        Error::Cuda(err)
    }
}