onednnl 0.0.1

high-level bindings to oneDNN Deep Learning library
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

use {
    crate::error::DnnlError,
    onednnl_sys::{
        dnnl_engine_create, dnnl_engine_destroy, dnnl_engine_get_count, dnnl_engine_get_kind,
        dnnl_engine_kind_t, dnnl_engine_t, dnnl_status_t,
    },
    std::sync::Arc,
};

#[derive(Debug)]
pub struct Engine {
    pub(crate) handle: dnnl_engine_t,
}

impl Engine {
    pub const GPU: dnnl_engine_kind_t::Type = dnnl_engine_kind_t::dnnl_gpu;

    pub const ANY: dnnl_engine_kind_t::Type = dnnl_engine_kind_t::dnnl_any_engine;

    pub const CPU: dnnl_engine_kind_t::Type = dnnl_engine_kind_t::dnnl_cpu;

    /// Create an Engine of a specific kind
    ///
    /// ```
    /// use onednnl::engine::Engine;
    ///
    /// let engine = Engine::new(Engine::CPU, 0);
    ///
    /// assert!(engine.is_ok());
    /// ```
    pub fn new(kind: dnnl_engine_kind_t::Type, index: usize) -> Result<Arc<Self>, DnnlError> {
        let mut handle: dnnl_engine_t = std::ptr::null_mut();
        let status = unsafe { dnnl_engine_create(&mut handle, kind, index) };
        if status == dnnl_status_t::dnnl_success {
            Ok(Arc::new(Self { handle }))
        } else {
            Err(status.into())
        }
    }

    /// Get the kind of an Engine
    ///
    /// ```
    /// use onednnl::engine::Engine;
    ///
    /// let engine = Engine::new(Engine::CPU, 0);
    ///
    /// assert!(engine.is_ok());
    ///
    /// let engine = engine.unwrap();
    ///
    /// assert_eq!(engine.get_kind(), Ok(Engine::CPU));
    /// ```
    pub fn get_kind(self: &Arc<Self>) -> Result<dnnl_engine_kind_t::Type, DnnlError> {
        let mut kind: dnnl_engine_kind_t::Type = 0; // Initialize a variable to store the kind
        let status = unsafe { dnnl_engine_get_kind(self.handle, &mut kind) }; // Pass a mutable reference

        if status == dnnl_status_t::dnnl_success {
            Ok(kind) // Return the kind if successful
        } else {
            Err(status.into()) // Convert the status into a DnnlError
        }
    }

    /// Get the count of an Engine of a particular type
    ///
    /// ```
    /// use onednnl::engine::Engine;
    ///
    /// assert!(Engine::get_count(Engine::CPU) > 0);
    /// ```
    pub fn get_count(kind: dnnl_engine_kind_t::Type) -> usize {
        unsafe { dnnl_engine_get_count(kind) }
    }
}

impl Drop for Engine {
    fn drop(&mut self) {
        unsafe { dnnl_engine_destroy(self.handle) };
    }
}

unsafe impl Sync for Engine {}
unsafe impl Send for Engine {}