obrah 3.3.0

High-level Rust wrapper around OpenCL using OBWIO
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

use crate::runtime::Env;
use obwio::*;

/// Buffer is a struct that holds, well, a buffer.
/// It is returned by Buffer::new().
///
/// # Examples
///
/// ```rust
/// use obrah::data::Buffer;
/// use obrah::runtime::Env;
///
/// let mut env = Env::new(0, 0);
/// let mut data = vec![1.0f32; 10];
/// let buf = Buffer::new(&mut env, &mut data);
/// ```

pub struct Buffer {
    pub buffer: cl_mem,
    pub data: Vec<f32>,
}

impl Buffer {
    pub fn to(&mut self, env: &mut Env) {
        let mut data = self.data.clone();
        to_gpu(env, &mut data, self);
    }
    pub fn from(&mut self, data: &mut Vec<f32>, env: &mut Env) {
        from_gpu(env, data, self);
    }
    pub fn new(env: &mut Env, data: &[f32]) -> Buffer {
        buffer_write(env, data)
    }
}

impl Drop for Buffer {
    fn drop(&mut self) {
        cleanvar(self);
    }
}

/// Create a buffer in order to be sent to the GPU. This function is used implicitly by Buffer::new().
/// You don't have to call it.
fn buffer_write(env: &mut Env, data: &[f32]) -> Buffer {
    unsafe {
        let size = data.len() * std::mem::size_of::<f32>();
        let buf = clCreateBuffer(
            env.context,
            CL_MEM_READ_WRITE.into(),
            size,
            std::ptr::null_mut(),
            &mut env.err,
        );
        if env.err != 0 {
            panic!("OpenCL error: {}", env.err);
        }

        Buffer {
            buffer: buf,
            data: data.to_vec(),
        }
    }
}

/// Send the buffer, and the data supposed to be in the buffer, to the GPU.
/// Used by Buffer.to().
fn to_gpu(env: &mut Env, data: &mut Vec<f32>, buffer: &mut Buffer) {
    unsafe {
        let size = data.len() * std::mem::size_of::<f32>();
        clEnqueueWriteBuffer(
            env.queue,
            buffer.buffer,
            CL_TRUE,
            0,
            size,
            data.as_ptr() as *const _,
            0,
            std::ptr::null_mut(),
            std::ptr::null_mut(),
        );
        if env.err != 0 {
            panic!("OpenCL error: {}", env.err);
        }
    }
}

/// Get data from the GPU, from a specific buffer.
/// Used by Buffer.from().
fn from_gpu(env: &mut Env, data: &mut Vec<f32>, buf: &mut Buffer) {
    unsafe {
        let size = data.len() * std::mem::size_of::<f32>();
        clEnqueueReadBuffer(
            env.queue,
            buf.buffer,
            CL_TRUE,
            0,
            size,
            data.as_mut_ptr() as *mut _,
            0,
            std::ptr::null_mut(),
            std::ptr::null_mut(),
        );

        if env.err != 0 {
            panic!("OpenCL error: {}", env.err);
        }
    }
}

/// cleanvar() cleans the buffer. This function is used automatically by Drop for the Buffer struct.
///
/// # Examples
///
/// ```rust
/// use obrah::data::Buffer;
/// use obrah::runtime::Env;
/// {
///     let mut env = Env::new(0, 0);
///     let mut data = vec![1.0f32; 10];
///     let buf = Buffer::new(&mut env, &mut data);
/// } // <- automatically dropped here
/// ```
fn cleanvar(buf: &mut Buffer) {
    unsafe {
        clReleaseMemObject(buf.buffer);
    }
}