coaster 0.2.0

high-performance computation on any hardware
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

//! Provides the OpenCL API with its device functionality.
//!
//! At Coaster hardware can be understood as a synonym to OpenCL's device.

use super::ffi::*;
use super::types as cl;
use frameworks::opencl::{Device, DeviceInfo, Platform};
use frameworks::opencl::{Error, API};
use libc;
use std::iter::repeat;
use std::ptr;

impl API {
    /// Returns fully initialized devices for a specific platform.
    ///
    /// Combines the fetching of all device ids and the fetching of the individual device
    /// information.
    pub fn load_devices(platform: &Platform) -> Result<Vec<Device>, Error> {
        match API::load_device_list(platform) {
            Ok(device_list) => Ok(device_list
                .iter()
                .map(|device| {
                    device
                        .clone()
                        .load_name()
                        .load_device_type()
                        .load_compute_units()
                })
                .collect()),
            Err(err) => Err(err),
        }
    }

    /// Returns a list of available devices for the provided platform.
    pub fn load_device_list(platform: &Platform) -> Result<Vec<Device>, Error> {
        let mut num_devices = 0;

        // load how many devices are available
        unsafe {
            API::ffi_get_device_ids(
                platform.id_c(),
                cl::CL_DEVICE_TYPE_ALL,
                0,
                ptr::null_mut(),
                &mut num_devices,
            )
        }?;

        // prepare device id list
        let mut ids: Vec<cl::device_id> = repeat(0 as cl::device_id)
            .take(num_devices as usize)
            .collect();

        // load the specific devices
        unsafe {
            API::ffi_get_device_ids(
                platform.id_c(),
                cl::CL_DEVICE_TYPE_ALL,
                ids.len() as cl::uint,
                ids.as_mut_ptr(),
                ptr::null_mut(),
            )
        }?;

        Ok(ids.iter().map(|id| Device::from_c(*id)).collect())
    }

    /// Returns the requested DeviceInfo for the provided device.
    pub fn load_device_info(device: &Device, info: cl::device_info) -> Result<DeviceInfo, Error> {
        let mut size = 0;

        unsafe { API::ffi_get_device_info(device.id_c(), info, 0, ptr::null_mut(), &mut size) }?;

        let mut buf: Vec<u8> = repeat(0u8).take(size).collect();
        let buf_ptr = buf.as_mut_ptr() as *mut libc::c_void;

        unsafe { API::ffi_get_device_info(device.id_c(), info, size, buf_ptr, ptr::null_mut()) }?;

        Ok(DeviceInfo::new(buf))
    }

    unsafe fn ffi_get_device_ids(
        platform: cl::platform_id,
        device_type: cl::device_type,
        num_entries: cl::uint,
        devices: *mut cl::device_id,
        num_devices: *mut cl::uint,
    ) -> Result<(), Error> {
        match clGetDeviceIDs(platform, device_type, num_entries, devices, num_devices) {
            cl::Status::SUCCESS => Ok(()),
            cl::Status::INVALID_PLATFORM => {
                Err(Error::InvalidPlatform("`platform` is not a valid platform"))
            }
            cl::Status::INVALID_DEVICE_TYPE => Err(Error::InvalidDeviceType(
                "`device type` is not a valid device type",
            )),
            cl::Status::DEVICE_NOT_FOUND => {
                Err(Error::DeviceNotFound("no devices for `device type` found"))
            }
            cl::Status::OUT_OF_RESOURCES => Err(Error::OutOfResources(
                "Failure to allocate resources on the device",
            )),
            cl::Status::OUT_OF_HOST_MEMORY => Err(Error::OutOfHostMemory(
                "Failure to allocate resources on the host",
            )),
            _ => Err(Error::Other("Unable to get device ids")),
        }
    }

    unsafe fn ffi_get_device_info(
        device: cl::device_id,
        param_name: cl::device_info,
        param_value_size: libc::size_t,
        param_value: *mut libc::c_void,
        param_value_size_ret: *mut libc::size_t,
    ) -> Result<(), Error> {
        match clGetDeviceInfo(
            device,
            param_name,
            param_value_size,
            param_value,
            param_value_size_ret,
        ) {
            cl::Status::SUCCESS => Ok(()),
            cl::Status::INVALID_VALUE => Err(Error::InvalidValue(
                "`param_name` is not one of the supported values",
            )),
            cl::Status::OUT_OF_RESOURCES => Err(Error::OutOfResources(
                "Failure to allocate resources on the device",
            )),
            cl::Status::OUT_OF_HOST_MEMORY => Err(Error::OutOfHostMemory(
                "Failure to allocate resources on the host",
            )),
            _ => Err(Error::Other("Unable to get device info string length")),
        }
    }
}