      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
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222

    //! An `OpenCL` platform identifier.
    //!
    //! Documentation copied from [https://www.khronos.org/registry/cl/sdk/1.2/doc
    //! s/man/xhtml/clGetPlatformInfo.html](https://www.khronos.org/registry/cl/sd
    //! k/1.2/docs/man/xhtml/clGetPlatformInfo.html)

    use std;
    use std::ops::{Deref, DerefMut};
    use std::str::SplitWhitespace;
    use ffi::cl_platform_id;
    use core::{self, PlatformId as PlatformIdCore, PlatformInfo, PlatformInfoResult, ClPlatformIdPtr};
    use core::error::{Result as OclCoreResult};
    use error::{Result as OclResult};

    #[derive(Debug, Fail)]
    pub enum PlatformError {
        #[fail(display = "No platforms found.")]
        NoPlatforms,
    }

    /// Extensions of a platform.
    #[derive(Debug, Clone)]
    pub struct Extensions {
        inner: String,
    }

    impl Extensions {
        /// Iterate over platform extensions, split at whitespace.
        pub fn iter(&self) -> SplitWhitespace {
            self.inner.split_whitespace()
        }

        pub fn as_str(&self) -> &str {
            &self.inner
        }
    }

    /// A platform identifier.
    ///
    #[repr(C)]
    #[derive(Clone, Copy, Debug)]
    pub struct Platform(PlatformIdCore);

    impl Platform {
        /// Returns a list of all platforms avaliable on the host machine.
        pub fn list() -> Vec<Platform> {
            let list_core = core::get_platform_ids()
                .expect("Platform::list: Error retrieving platform list");

            list_core.into_iter().map(Platform::new).collect()
        }

        /// Returns the first available platform.
        ///
        /// This method differs from `Platform::default()` in two ways. First, it
        /// ignores the `OCL_DEFAULT_PLATFORM_IDX` environment variable
        /// (`Platform::default` always respects it). Second, this function will
        /// not panic if no platforms are available but will instead return an
        /// error.
        pub fn first() -> OclResult<Platform> {
            core::get_platform_ids()?
                .first()
                .map(|&p| Platform::new(p))
                .ok_or(PlatformError::NoPlatforms.into())
        }

        /// Creates a new `Platform` from a `PlatformIdCore`.
        ///
        /// ## Safety
        ///
        /// Not meant to be called unless you know what you're doing.
        ///
        /// Use list to get a list of platforms.
        pub fn new(id_core: PlatformIdCore) -> Platform {
            Platform(id_core)
        }

        /// Returns a list of `Platform`s from a list of `PlatformIdCore`s
        pub fn list_from_core(platforms: Vec<PlatformIdCore>) -> Vec<Platform> {
            platforms.into_iter().map(Platform::new).collect()
        }

        /// Returns info about the platform.
        pub fn info(&self, info_kind: PlatformInfo) -> OclCoreResult<PlatformInfoResult> {
            core::get_platform_info(&self.0, info_kind)
        }

        /// Returns the platform profile as a string.
        ///
        /// Returns the profile name supported by the implementation. The profile
        /// name returned can be one of the following strings:
        ///
        /// * FULL_PROFILE - if the implementation supports the OpenCL
        ///   specification (functionality defined as part of the core
        ///   specification and does not require any extensions to be supported).
        ///
        /// * EMBEDDED_PROFILE - if the implementation supports the OpenCL
        ///   embedded profile. The embedded profile is defined to be a subset for
        ///   each version of OpenCL.
        ///
        pub fn profile(&self) -> OclCoreResult<String> {
            core::get_platform_info(&self.0, PlatformInfo::Profile).map(|r| r.into())
        }

        /// Returns the platform driver version as a string.
        ///
        /// Returns the OpenCL version supported by the implementation. This
        /// version string has the following format:
        ///
        /// * OpenCL<space><major_version.minor_version><space><platform-specific
        ///   information>
        ///
        /// * The major_version.minor_version value returned will be '1.2'.
        ///
        /// * TODO: Convert this to new version system returning an `OpenclVersion`.
        pub fn version(&self) -> OclCoreResult<String> {
            core::get_platform_info(&self.0, PlatformInfo::Version).map(|r| r.into())
        }

        /// Returns the platform name as a string.
        pub fn name(&self) -> OclCoreResult<String> {
            core::get_platform_info(&self.0, PlatformInfo::Name).map(|r| r.into())
        }

        /// Returns the platform vendor as a string.
        pub fn vendor(&self) -> OclCoreResult<String> {
            core::get_platform_info(&self.0, PlatformInfo::Vendor).map(|r| r.into())
        }

        /// Returns the list of platform extensions.
        ///
        /// Extensions defined here must be supported by all devices associated
        /// with this platform.
        pub fn extensions(&self) -> OclCoreResult<Extensions> {
            let extensions = core::get_platform_info(&self.0, PlatformInfo::Extensions);
            extensions.map(|e| Extensions { inner: e.into() })
        }

        /// Returns a reference to the underlying `PlatformIdCore`.
        pub fn as_core(&self) -> &PlatformIdCore {
            &self.0
        }

        fn fmt_info(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
            f.debug_struct("Platform")
                .field("Profile", &self.info(PlatformInfo::Profile))
                .field("Version", &self.info(PlatformInfo::Version))
                .field("Name", &self.info(PlatformInfo::Name))
                .field("Vendor", &self.info(PlatformInfo::Vendor))
                .field("Extensions", &self.info(PlatformInfo::Extensions))
                .finish()
        }
    }

    unsafe impl ClPlatformIdPtr for Platform {
        fn as_ptr(&self) -> cl_platform_id {
            self.0.as_ptr()
        }
    }
    // unsafe impl<'a> ClPlatformIdPtr for &'a Platform {}

    impl Default for Platform {
        /// Returns the first (0th) platform available, or the platform specified
        /// by the `OCL_DEFAULT_PLATFORM_IDX` environment variable if it is set.
        ///
        /// ### Panics
        ///
        /// Panics upon any OpenCL API error.
        ///
        fn default() -> Platform {
            let dflt_plat_core = core::default_platform().expect("Platform::default()");
            Platform::new(dflt_plat_core)
        }
    }

    impl From<PlatformIdCore> for Platform {
        fn from(core: PlatformIdCore) -> Platform {
            Platform(core)
        }
    }

    impl From<Platform> for String {
        fn from(p: Platform) -> String {
            format!("{}", p)
        }
    }

    impl From<Platform> for PlatformIdCore {
        fn from(p: Platform) -> PlatformIdCore {
            p.0
        }
    }

    impl<'a> From<&'a Platform> for PlatformIdCore {
        fn from(p: &Platform) -> PlatformIdCore {
            p.0.clone()
        }
    }

    impl std::fmt::Display for Platform {
        fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
            self.fmt_info(f)
        }
    }

    impl Deref for Platform {
        type Target = PlatformIdCore;

        fn deref(&self) -> &PlatformIdCore {
            &self.0
        }
    }

    impl DerefMut for Platform {
        fn deref_mut(&mut self) -> &mut PlatformIdCore {
            &mut self.0
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)