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

//! Provides informations about the software system, such as OpenCL, CUDA, that contains the set of
//! components to support [hardwares][hardware] with kernel execution.
//! [hardware]: ../hardware/index.html
//!
//! ## Ontology
//!
//! OpenCL device -> Hardware
//! OpenCL context -> Device

pub use self::api::{Error, API};
pub use self::context::Context;
pub use self::device::{Device, DeviceInfo};
pub use self::event::Event;
pub use self::kernel::Kernel;
pub use self::memory::{Memory, MemoryFlags};
pub use self::platform::Platform;
pub use self::program::Program;
pub use self::queue::{Queue, QueueFlags};
use backend::{Backend, IBackend};
use framework::IFramework;

mod api;
pub mod context;
pub mod device;
pub mod event;
pub mod kernel;
pub mod memory;
pub mod platform;
pub mod program;
pub mod queue;

#[derive(Debug, Clone)]
/// Provides the OpenCL Framework.
pub struct OpenCL {
    hardwares: Vec<Device>,
    binary: Program,
}

/// Provides the OpenCL framework trait for explicit Backend behaviour.
///
/// You usually would not need to care about this trait.
pub trait IOpenCL {}

impl IOpenCL for OpenCL {}

impl IFramework for OpenCL {
    type H = Device;
    type D = Context;
    type B = Program;

    fn ID() -> &'static str {
        "OPENCL"
    }

    fn new() -> OpenCL {
        let hardwares = OpenCL::load_hardwares().expect("Acquiring hw never fails. qed");
        Self {
            hardwares,
            binary: Program::from_isize(1),
        }
    }

    fn load_hardwares() -> Result<Vec<Device>, ::framework::Error> {
        let platforms = API::load_platforms()?;

        let mut hardware_container: Vec<Device> = vec![];
        for platform in &platforms {
            if let Ok(hardwares) = API::load_devices(platform) {
                hardware_container.append(&mut hardwares.clone())
            }
        }
        Ok(hardware_container)
    }

    fn hardwares(&self) -> &[Device] {
        &self.hardwares
    }

    fn binary(&self) -> &Self::B {
        &self.binary
    }

    /// Creates a new OpenCL context over one or many devices ready for computation.
    ///
    /// Contexts are used by the OpenCL runtime for managing objects such as command-queues,
    /// memory, program and kernel objects and for executing kernels on one or more hardwares
    /// specified in the context.
    /// OpenCL allows to move memory within one context from one device to another without
    /// any explicit API calls.
    fn new_device(&self, hardwares: &[Device]) -> Result<Self::D, ::framework::Error> {
        Ok(Context::new(hardwares.to_vec())?)
    }
}

impl IBackend for Backend<OpenCL> {
    type F = OpenCL;

    fn device(&self) -> &Context {
        &self.device()
    }
}