      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
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501

    // Copyright (c) 2017 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.

    use smallvec::SmallVec;
    use std::error;
    use std::fmt;
    use std::marker::PhantomData;
    use std::ptr;

    use buffer::sys::UnsafeBuffer;
    use device::Queue;
    use image::sys::UnsafeImage;
    use memory::DeviceMemory;
    use sync::Fence;
    use sync::Semaphore;

    use Error;
    use OomError;
    use SynchronizedVulkanObject;
    use VulkanObject;
    use check_errors;
    use vk;

    // TODO: correctly implement Debug on all the structs of this module

    /// Prototype for a submission that binds sparse memory.
    // TODO: example here
    pub struct SubmitBindSparseBuilder<'a> {
        infos: SmallVec<[SubmitBindSparseBatchBuilder<'a>; 1]>,
        fence: vk::Fence,
    }

    impl<'a> SubmitBindSparseBuilder<'a> {
        /// Builds a new empty `SubmitBindSparseBuilder`.
        #[inline]
        pub fn new() -> SubmitBindSparseBuilder<'a> {
            SubmitBindSparseBuilder {
                infos: SmallVec::new(),
                fence: 0,
            }
        }

        /// Adds a batch to the command.
        ///
        /// Batches start execution in order, but can finish in a different order. In other words any
        /// wait semaphore added to a batch will apply to further batches as well, but when a semaphore
        /// is signalled, it does **not** mean that previous batches have been completed.
        #[inline]
        pub fn add(&mut self, builder: SubmitBindSparseBatchBuilder<'a>) {
            self.infos.push(builder);
        }

        /// Returns true if this builder will signal a fence when submitted.
        ///
        /// # Example
        ///
        /// ```
        /// use vulkano::command_buffer::submit::SubmitBindSparseBuilder;
        /// use vulkano::sync::Fence;
        /// # let device: std::sync::Arc<vulkano::device::Device> = return;
        ///
        /// unsafe {
        ///     let fence = Fence::from_pool(device.clone()).unwrap();
        ///
        ///     let mut builder = SubmitBindSparseBuilder::new();
        ///     assert!(!builder.has_fence());
        ///     builder.set_fence_signal(&fence);
        ///     assert!(builder.has_fence());
        /// }
        /// ```
        #[inline]
        pub fn has_fence(&self) -> bool {
            self.fence != 0
        }

        /// Adds an operation that signals a fence after this submission ends.
        ///
        /// # Example
        ///
        /// ```
        /// use std::time::Duration;
        /// use vulkano::command_buffer::submit::SubmitBindSparseBuilder;
        /// use vulkano::sync::Fence;
        /// # let device: std::sync::Arc<vulkano::device::Device> = return;
        /// # let queue: std::sync::Arc<vulkano::device::Queue> = return;
        ///
        /// unsafe {
        ///     let fence = Fence::from_pool(device.clone()).unwrap();
        ///
        ///     let mut builder = SubmitBindSparseBuilder::new();
        ///     builder.set_fence_signal(&fence);
        ///
        ///     builder.submit(&queue).unwrap();
        ///
        ///     // We must not destroy the fence before it is signaled.
        ///     fence.wait(None).unwrap();
        /// }
        /// ```
        ///
        /// # Safety
        ///
        /// - The fence must not be signaled at the time when you call `submit()`.
        ///
        /// - If you use the fence for multiple submissions, only one at a time must be executed by the
        ///   GPU. In other words, you must submit one, wait for the fence to be signaled, then reset
        ///   the fence, and then only submit the second.
        ///
        /// - If you submit this builder, the fence must be kept alive until it is signaled by the GPU.
        ///   Destroying the fence earlier is an undefined behavior.
        ///
        /// - The fence, buffers, images, and semaphores must all belong to the same device.
        ///
        #[inline]
        pub unsafe fn set_fence_signal(&mut self, fence: &'a Fence) {
            self.fence = fence.internal_object();
        }

        /// Attempts to merge this builder with another one.
        ///
        /// If both builders have a fence already set, then this function will return `other` as an
        /// error.
        #[inline]
        pub fn merge(&mut self, other: SubmitBindSparseBuilder<'a>)
                     -> Result<(), SubmitBindSparseBuilder<'a>> {
            if self.fence != 0 && other.fence != 0 {
                return Err(other);
            }

            self.infos.extend(other.infos.into_iter());
            Ok(())
        }

        /// Submits the command. Calls `vkQueueBindSparse`.
        pub fn submit(self, queue: &Queue) -> Result<(), SubmitBindSparseError> {
            unsafe {
                debug_assert!(queue.family().supports_sparse_binding());

                let vk = queue.device().pointers();
                let queue = queue.internal_object_guard();

                // We start by storing all the `VkSparseBufferMemoryBindInfo`s of the whole command
                // in the same collection.
                let buffer_binds_storage: SmallVec<[_; 4]> = self.infos
                    .iter()
                    .flat_map(|infos| infos.buffer_binds.iter())
                    .map(|buf_bind| {
                             vk::SparseBufferMemoryBindInfo {
                                 buffer: buf_bind.buffer,
                                 bindCount: buf_bind.binds.len() as u32,
                                 pBinds: buf_bind.binds.as_ptr(),
                             }
                         })
                    .collect();

                // Same for all the `VkSparseImageOpaqueMemoryBindInfo`s.
                let image_opaque_binds_storage: SmallVec<[_; 4]> = self.infos
                    .iter()
                    .flat_map(|infos| infos.image_opaque_binds.iter())
                    .map(|img_bind| {
                             vk::SparseImageOpaqueMemoryBindInfo {
                                 image: img_bind.image,
                                 bindCount: img_bind.binds.len() as u32,
                                 pBinds: img_bind.binds.as_ptr(),
                             }
                         })
                    .collect();

                // And finally the `VkSparseImageMemoryBindInfo`s.
                let image_binds_storage: SmallVec<[_; 4]> = self.infos
                    .iter()
                    .flat_map(|infos| infos.image_binds.iter())
                    .map(|img_bind| {
                             vk::SparseImageMemoryBindInfo {
                                 image: img_bind.image,
                                 bindCount: img_bind.binds.len() as u32,
                                 pBinds: img_bind.binds.as_ptr(),
                             }
                         })
                    .collect();

                // Now building the collection of `VkBindSparseInfo`s.
                let bs_infos = {
                    let mut bs_infos: SmallVec<[_; 4]> = SmallVec::new();

                    // Since we stores all the bind infos contiguously, we keep track of the current
                    // offset within these containers.
                    let mut next_buffer_bind = 0;
                    let mut next_image_opaque_bind = 0;
                    let mut next_image_bind = 0;

                    for builder in self.infos.iter() {
                        bs_infos.push(vk::BindSparseInfo {
                            sType: vk::STRUCTURE_TYPE_BIND_SPARSE_INFO,
                            pNext: ptr::null(),
                            waitSemaphoreCount: builder.wait_semaphores.len() as u32,
                            pWaitSemaphores: builder.wait_semaphores.as_ptr(),
                            bufferBindCount: builder.buffer_binds.len() as u32,
                            pBufferBinds: if next_buffer_bind != 0 {
                                // We need that `if` because `.as_ptr().offset(0)` is technically UB.
                                buffer_binds_storage.as_ptr().offset(next_buffer_bind)
                            } else {
                                buffer_binds_storage.as_ptr()
                            },
                            imageOpaqueBindCount: builder.image_opaque_binds.len() as u32,
                            pImageOpaqueBinds: if next_image_opaque_bind != 0 {
                                // We need that `if` because `.as_ptr().offset(0)` is technically UB.
                                image_opaque_binds_storage.as_ptr().offset(next_image_opaque_bind)
                            } else {
                                image_opaque_binds_storage.as_ptr()
                            },
                            imageBindCount: builder.image_binds.len() as u32,
                            pImageBinds: if next_image_bind != 0 {
                                // We need that `if` because `.as_ptr().offset(0)` is technically UB.
                                image_binds_storage.as_ptr().offset(next_image_bind)
                            } else {
                                image_binds_storage.as_ptr()
                            },
                            signalSemaphoreCount: builder.signal_semaphores.len() as u32,
                            pSignalSemaphores: builder.signal_semaphores.as_ptr(),

                        });

                        next_buffer_bind += builder.buffer_binds.len() as isize;
                        next_image_opaque_bind += builder.image_opaque_binds.len() as isize;
                        next_image_bind += builder.image_binds.len() as isize;
                    }

                    // If these assertions fail, then there's something wrong in the code above.
                    debug_assert_eq!(next_buffer_bind as usize, buffer_binds_storage.len());
                    debug_assert_eq!(next_image_opaque_bind as usize,
                                     image_opaque_binds_storage.len());
                    debug_assert_eq!(next_image_bind as usize, image_binds_storage.len());

                    bs_infos
                };

                // Finally executing the command.
                check_errors(vk.QueueBindSparse(*queue,
                                                bs_infos.len() as u32,
                                                bs_infos.as_ptr(),
                                                self.fence))?;
                Ok(())
            }
        }
    }

    impl<'a> fmt::Debug for SubmitBindSparseBuilder<'a> {
        #[inline]
        fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
            write!(fmt, "<Bind sparse operation>")
        }
    }

    /// A single batch of a sparse bind operation.
    pub struct SubmitBindSparseBatchBuilder<'a> {
        wait_semaphores: SmallVec<[vk::Semaphore; 8]>,
        buffer_binds: SmallVec<[SubmitBindSparseBufferBindBuilder<'a>; 2]>,
        image_opaque_binds: SmallVec<[SubmitBindSparseImageOpaqueBindBuilder<'a>; 2]>,
        image_binds: SmallVec<[SubmitBindSparseImageBindBuilder<'a>; 2]>,
        signal_semaphores: SmallVec<[vk::Semaphore; 8]>,
        marker: PhantomData<&'a ()>,
    }

    impl<'a> SubmitBindSparseBatchBuilder<'a> {
        /// Builds a new empty `SubmitBindSparseBatchBuilder`.
        #[inline]
        pub fn new() -> SubmitBindSparseBatchBuilder<'a> {
            SubmitBindSparseBatchBuilder {
                wait_semaphores: SmallVec::new(),
                buffer_binds: SmallVec::new(),
                image_opaque_binds: SmallVec::new(),
                image_binds: SmallVec::new(),
                signal_semaphores: SmallVec::new(),
                marker: PhantomData,
            }
        }

        /// Adds an operation that binds memory to a buffer.
        pub fn add_buffer(&mut self, cmd: SubmitBindSparseBufferBindBuilder<'a>) {
            self.buffer_binds.push(cmd);
        }

        /// Adds an operation that binds memory to an opaque image.
        pub fn add_image_opaque(&mut self, cmd: SubmitBindSparseImageOpaqueBindBuilder<'a>) {
            self.image_opaque_binds.push(cmd);
        }

        /// Adds an operation that binds memory to an image.
        pub fn add_image(&mut self, cmd: SubmitBindSparseImageBindBuilder<'a>) {
            self.image_binds.push(cmd);
        }

        /// Adds a semaphore to be waited upon before the sparse binding is executed.
        ///
        /// # Safety
        ///
        /// - If you submit this builder, the semaphore must be kept alive until you are guaranteed
        ///   that the GPU has at least started executing the operation.
        ///
        /// - If you submit this builder, no other queue must be waiting on these semaphores. In other
        ///   words, each semaphore signal can only correspond to one semaphore wait.
        ///
        /// - If you submit this builder, the semaphores must be signaled when the queue execution
        ///   reaches this submission, or there must be one or more submissions in queues that are
        ///   going to signal these semaphores. In other words, you must not block the queue with
        ///   semaphores that can't get signaled.
        ///
        /// - The fence, buffers, images, and semaphores must all belong to the same device.
        ///
        #[inline]
        pub unsafe fn add_wait_semaphore(&mut self, semaphore: &'a Semaphore) {
            self.wait_semaphores.push(semaphore.internal_object());
        }

        /// Returns the number of semaphores to signal.
        ///
        /// In other words, this is the number of times `add_signal_semaphore` has been called.
        #[inline]
        pub fn num_signal_semaphores(&self) -> usize {
            self.signal_semaphores.len()
        }

        /// Adds a semaphore that is going to be signaled at the end of the submission.
        ///
        /// # Safety
        ///
        /// - If you submit this builder, the semaphore must be kept alive until you are guaranteed
        ///   that the GPU has finished executing this submission.
        ///
        /// - The semaphore must be in the unsignaled state when queue execution reaches this
        ///   submission.
        ///
        /// - The fence, buffers, images, and semaphores must all belong to the same device.
        ///
        #[inline]
        pub unsafe fn add_signal_semaphore(&mut self, semaphore: &'a Semaphore) {
            self.signal_semaphores.push(semaphore.internal_object());
        }
    }

    pub struct SubmitBindSparseBufferBindBuilder<'a> {
        buffer: vk::Buffer,
        binds: SmallVec<[vk::SparseMemoryBind; 1]>,
        marker: PhantomData<&'a ()>,
    }

    impl<'a> SubmitBindSparseBufferBindBuilder<'a> {
        ///
        /// # Safety
        ///
        /// - `buffer` must be a buffer with sparse binding enabled.
        pub unsafe fn new(buffer: &'a UnsafeBuffer) -> SubmitBindSparseBufferBindBuilder {
            SubmitBindSparseBufferBindBuilder {
                buffer: buffer.internal_object(),
                binds: SmallVec::new(),
                marker: PhantomData,
            }
        }

        pub unsafe fn add_bind(&mut self, offset: usize, size: usize, memory: &DeviceMemory,
                               memory_offset: usize) {
            self.binds.push(vk::SparseMemoryBind {
                                resourceOffset: offset as vk::DeviceSize,
                                size: size as vk::DeviceSize,
                                memory: memory.internal_object(),
                                memoryOffset: memory_offset as vk::DeviceSize,
                                flags: 0, // Flags are only relevant for images.
                            });
        }

        pub unsafe fn add_unbind(&mut self, offset: usize, size: usize) {
            self.binds.push(vk::SparseMemoryBind {
                                resourceOffset: offset as vk::DeviceSize,
                                size: size as vk::DeviceSize,
                                memory: 0,
                                memoryOffset: 0,
                                flags: 0,
                            });
        }
    }

    pub struct SubmitBindSparseImageOpaqueBindBuilder<'a> {
        image: vk::Image,
        binds: SmallVec<[vk::SparseMemoryBind; 1]>,
        marker: PhantomData<&'a ()>,
    }

    impl<'a> SubmitBindSparseImageOpaqueBindBuilder<'a> {
        ///
        /// # Safety
        ///
        /// - `image` must be an image with sparse binding enabled.
        pub unsafe fn new(image: &'a UnsafeImage) -> SubmitBindSparseImageOpaqueBindBuilder {
            SubmitBindSparseImageOpaqueBindBuilder {
                image: image.internal_object(),
                binds: SmallVec::new(),
                marker: PhantomData,
            }
        }

        pub unsafe fn add_bind(&mut self, offset: usize, size: usize, memory: &DeviceMemory,
                               memory_offset: usize, bind_metadata: bool) {
            self.binds.push(vk::SparseMemoryBind {
                                resourceOffset: offset as vk::DeviceSize,
                                size: size as vk::DeviceSize,
                                memory: memory.internal_object(),
                                memoryOffset: memory_offset as vk::DeviceSize,
                                flags: if bind_metadata {
                                    vk::SPARSE_MEMORY_BIND_METADATA_BIT
                                } else {
                                    0
                                },
                            });
        }

        pub unsafe fn add_unbind(&mut self, offset: usize, size: usize) {
            self.binds.push(vk::SparseMemoryBind {
                                resourceOffset: offset as vk::DeviceSize,
                                size: size as vk::DeviceSize,
                                memory: 0,
                                memoryOffset: 0,
                                flags: 0, // TODO: is that relevant?
                            });
        }
    }

    pub struct SubmitBindSparseImageBindBuilder<'a> {
        image: vk::Image,
        binds: SmallVec<[vk::SparseImageMemoryBind; 1]>,
        marker: PhantomData<&'a ()>,
    }

    impl<'a> SubmitBindSparseImageBindBuilder<'a> {
        ///
        /// # Safety
        ///
        /// - `image` must be an image with sparse binding enabled.
        pub unsafe fn new(image: &'a UnsafeImage) -> SubmitBindSparseImageBindBuilder {
            SubmitBindSparseImageBindBuilder {
                image: image.internal_object(),
                binds: SmallVec::new(),
                marker: PhantomData,
            }
        }

        // TODO: finish
    }

    /// Error that can happen when submitting the present prototype.
    #[derive(Copy, Clone, Debug, PartialEq, Eq)]
    #[repr(u32)]
    pub enum SubmitBindSparseError {
        /// Not enough memory.
        OomError(OomError),

        /// The connection to the device has been lost.
        DeviceLost,
    }

    impl error::Error for SubmitBindSparseError {
        #[inline]
        fn description(&self) -> &str {
            match *self {
                SubmitBindSparseError::OomError(_) => "not enough memory",
                SubmitBindSparseError::DeviceLost => "the connection to the device has been lost",
            }
        }

        #[inline]
        fn cause(&self) -> Option<&dyn error::Error> {
            match *self {
                SubmitBindSparseError::OomError(ref err) => Some(err),
                _ => None,
            }
        }
    }

    impl fmt::Display for SubmitBindSparseError {
        #[inline]
        fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
            write!(fmt, "{}", error::Error::description(self))
        }
    }

    impl From<Error> for SubmitBindSparseError {
        #[inline]
        fn from(err: Error) -> SubmitBindSparseError {
            match err {
                err @ Error::OutOfHostMemory => SubmitBindSparseError::OomError(OomError::from(err)),
                err @ Error::OutOfDeviceMemory => SubmitBindSparseError::OomError(OomError::from(err)),
                Error::DeviceLost => SubmitBindSparseError::DeviceLost,
                _ => panic!("unexpected error: {:?}", err),
            }
        }
    }

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