      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
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252

    // Copyright (c) 2016 The vulkano developers
    // Licensed under the Apache License, Version 2.0
    // <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT
    // license <LICENSE-MIT or http://opensource.org/licenses/MIT>,
    // at your option. All files in the project carrying such
    // notice may not be copied, modified, or distributed except
    // according to those terms.

    //! Cache the pipeline objects to disk for faster reloads.
    //!
    //! A pipeline cache is an opaque type that allow you to cache your graphics and compute
    //! pipelines on the disk.
    //!
    //! You can create either an empty cache or a cache from some initial data. Whenever you create a
    //! graphics or compute pipeline, you have the possibility to pass a reference to that cache.
    //! TODO: ^ that's not the case yet
    //! The Vulkan implementation will then look in the cache for an existing entry, or add one if it
    //! doesn't exist.
    //!
    //! Once that is done, you can extract the data from the cache and store it. See the documentation
    //! of [`get_data`](struct.PipelineCache.html#method.get_data) for example of how to store the data
    //! on the disk, and [`with_data`](struct.PipelineCache.html#method.with_data) for how to reload it.
    //!

    use std::mem;
    use std::ptr;
    use std::sync::Arc;

    use device::Device;

    use OomError;
    use VulkanObject;
    use check_errors;
    use vk;

    /// Opaque cache that contains pipeline objects.
    ///
    /// See [the documentation of the module](index.html) for more info.
    pub struct PipelineCache {
        device: Arc<Device>,
        cache: vk::PipelineCache,
    }

    impl PipelineCache {
        /// Builds a new pipeline cache from existing data. The data must have been previously obtained
        /// with [`get_data`](#method.get_data).
        ///
        /// The data passed to this function will most likely be blindly trusted by the Vulkan
        /// implementation. Therefore you can easily crash your application or the system by passing
        /// wrong data. Hence why this function is unsafe.
        ///
        /// # Example
        ///
        /// This example loads a cache from a file, if it exists.
        /// See [`get_data`](#method.get_data) for how to store the data in a file.
        /// TODO: there's a header in the cached data that must be checked ; talk about this
        ///
        /// ```
        /// # use std::sync::Arc;
        /// # use vulkano::device::Device;
        /// use std::fs::File;
        /// use std::io::Read;
        /// use vulkano::pipeline::cache::PipelineCache;
        /// # let device: Arc<Device> = return;
        ///
        /// let data = {
        ///     let file = File::open("pipeline_cache.bin");
        ///     if let Ok(mut file) = file {
        ///         let mut data = Vec::new();
        ///         if let Ok(_) = file.read_to_end(&mut data) {
        ///             Some(data)
        ///         } else { None }
        ///     } else { None }
        /// };
        ///
        /// let cache = if let Some(data) = data {
        ///     // This is unsafe because there is no way to be sure that the file contains valid data.
        ///     unsafe { PipelineCache::with_data(device.clone(), &data).unwrap() }
        /// } else {
        ///     PipelineCache::empty(device.clone()).unwrap()
        /// };
        /// ```
        #[inline]
        pub unsafe fn with_data(device: Arc<Device>, initial_data: &[u8])
                                -> Result<Arc<PipelineCache>, OomError> {
            PipelineCache::new_impl(device, Some(initial_data))
        }

        /// Builds a new empty pipeline cache.
        ///
        /// # Example
        ///
        /// ```
        /// # use std::sync::Arc;
        /// # use vulkano::device::Device;
        /// use vulkano::pipeline::cache::PipelineCache;
        /// # let device: Arc<Device> = return;
        /// let cache = PipelineCache::empty(device.clone()).unwrap();
        /// ```
        #[inline]
        pub fn empty(device: Arc<Device>) -> Result<Arc<PipelineCache>, OomError> {
            unsafe { PipelineCache::new_impl(device, None) }
        }

        // Actual implementation of the constructor.
        unsafe fn new_impl(device: Arc<Device>, initial_data: Option<&[u8]>)
                           -> Result<Arc<PipelineCache>, OomError> {
            let vk = device.pointers();

            let cache = {
                let infos = vk::PipelineCacheCreateInfo {
                    sType: vk::STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO,
                    pNext: ptr::null(),
                    flags: 0, // reserved
                    initialDataSize: initial_data.map(|d| d.len()).unwrap_or(0),
                    pInitialData: initial_data
                        .map(|d| d.as_ptr() as *const _)
                        .unwrap_or(ptr::null()),
                };

                let mut output = mem::uninitialized();
                check_errors(vk.CreatePipelineCache(device.internal_object(),
                                                    &infos,
                                                    ptr::null(),
                                                    &mut output))?;
                output
            };

            Ok(Arc::new(PipelineCache {
                            device: device.clone(),
                            cache: cache,
                        }))
        }

        /// Merges other pipeline caches into this one.
        ///
        /// It is `self` that is modified here. The pipeline caches passed as parameter are untouched.
        ///
        /// # Panic
        ///
        /// - Panics if `self` is included in the list of other pipelines.
        ///
        // FIXME: vkMergePipelineCaches is not thread safe for the destination cache
        // TODO: write example
        pub fn merge<'a, I>(&self, pipelines: I) -> Result<(), OomError>
            where I: IntoIterator<Item = &'a &'a Arc<PipelineCache>>
        {
            unsafe {
                let vk = self.device.pointers();

                let pipelines = pipelines
                    .into_iter()
                    .map(|pipeline| {
                             assert!(&***pipeline as *const _ != &*self as *const _);
                             pipeline.cache
                         })
                    .collect::<Vec<_>>();

                check_errors(vk.MergePipelineCaches(self.device.internal_object(),
                                                    self.cache,
                                                    pipelines.len() as u32,
                                                    pipelines.as_ptr()))?;

                Ok(())
            }
        }

        /// Obtains the data from the cache.
        ///
        /// This data can be stored and then reloaded and passed to `PipelineCache::with_data`.
        ///
        /// # Example
        ///
        /// This example stores the data of a pipeline cache on the disk.
        /// See [`with_data`](#method.with_data) for how to reload it.
        ///
        /// ```
        /// use std::fs;
        /// use std::fs::File;
        /// use std::io::Write;
        /// # use std::sync::Arc;
        /// # use vulkano::pipeline::cache::PipelineCache;
        ///
        /// # let cache: Arc<PipelineCache> = return;
        /// // If an error happens (eg. no permission for the file) we simply skip storing the cache.
        /// if let Ok(data) = cache.get_data() {
        ///     if let Ok(mut file) = File::create("pipeline_cache.bin.tmp") {
        ///         if let Ok(_) = file.write_all(&data) {
        ///             let _ = fs::rename("pipeline_cache.bin.tmp", "pipeline_cache.bin");
        ///         } else {
        ///             let _ = fs::remove_file("pipeline_cache.bin.tmp");
        ///         }
        ///     }
        /// }
        /// ```
        pub fn get_data(&self) -> Result<Vec<u8>, OomError> {
            unsafe {
                let vk = self.device.pointers();

                let mut num = 0;
                check_errors(vk.GetPipelineCacheData(self.device.internal_object(),
                                                     self.cache,
                                                     &mut num,
                                                     ptr::null_mut()))?;

                let mut data: Vec<u8> = Vec::with_capacity(num as usize);
                check_errors(vk.GetPipelineCacheData(self.device.internal_object(),
                                                     self.cache,
                                                     &mut num,
                                                     data.as_mut_ptr() as *mut _))?;
                data.set_len(num as usize);

                Ok(data)
            }
        }
    }

    unsafe impl VulkanObject for PipelineCache {
        type Object = vk::PipelineCache;

        const TYPE: vk::DebugReportObjectTypeEXT = vk::DEBUG_REPORT_OBJECT_TYPE_PIPELINE_CACHE_EXT;

        #[inline]
        fn internal_object(&self) -> vk::PipelineCache {
            self.cache
        }
    }

    impl Drop for PipelineCache {
        #[inline]
        fn drop(&mut self) {
            unsafe {
                let vk = self.device.pointers();
                vk.DestroyPipelineCache(self.device.internal_object(), self.cache, ptr::null());
            }
        }
    }

    #[cfg(test)]
    mod tests {
        use pipeline::cache::PipelineCache;

        #[test]
        fn merge_self_forbidden() {
            let (device, queue) = gfx_dev_and_queue!();
            let pipeline = PipelineCache::empty(device).unwrap();
            assert_should_panic!({
                                     pipeline.merge(&[&pipeline]).unwrap();
                                 });
        }
    }

# 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`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)