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 502 503 504 505 506 507 508 509
// Copyright (c) 2016 The vulkano developers
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or https://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 super::{
CommandBufferInheritanceInfo, CommandBufferResourcesUsage, CommandBufferState,
CommandBufferUsage, SecondaryCommandBufferResourcesUsage, SemaphoreSubmitInfo, SubmitInfo,
};
use crate::{
buffer::Buffer,
device::{Device, DeviceOwned, Queue},
image::{Image, ImageLayout},
swapchain::Swapchain,
sync::{
future::{now, AccessCheckError, AccessError, GpuFuture, NowFuture, SubmitAnyBuilder},
PipelineStages,
},
DeviceSize, SafeDeref, Validated, ValidationError, VulkanError, VulkanObject,
};
use parking_lot::{Mutex, MutexGuard};
use std::{
borrow::Cow,
error::Error,
fmt::{Debug, Display, Error as FmtError, Formatter},
ops::Range,
sync::{
atomic::{AtomicBool, Ordering},
Arc,
},
thread,
};
pub unsafe trait PrimaryCommandBufferAbstract:
VulkanObject<Handle = ash::vk::CommandBuffer> + DeviceOwned + Send + Sync
{
/// Returns the usage of this command buffer.
fn usage(&self) -> CommandBufferUsage;
/// Executes this command buffer on a queue.
///
/// This function returns an object that implements the [`GpuFuture`] trait. See the
/// documentation of the [`future`][crate::sync::future] module for more information.
///
/// The command buffer is not actually executed until you call [`flush()`][GpuFuture::flush] on
/// the future. You are encouraged to chain together as many futures as possible prior to
/// calling [`flush()`][GpuFuture::flush]. In order to know when the future has completed, call
/// one of [`then_signal_fence()`][GpuFuture::then_signal_fence] or
/// [`then_signal_semaphore()`][GpuFuture::then_signal_semaphore]. You can do both together
/// with [`then_signal_fence_and_flush()`][GpuFuture::then_signal_fence_and_flush] or
/// [`then_signal_semaphore_and_flush()`][GpuFuture::then_signal_semaphore_and_flush],
/// respectively.
///
/// > **Note**: In the future this function may return `-> impl GpuFuture` instead of a
/// > concrete type.
///
/// > **Note**: This is just a shortcut for `execute_after(vulkano::sync::now(), queue)`.
///
/// # Panics
///
/// - Panics if the device of the command buffer is not the same as the device of the future.
#[inline]
fn execute(
self: Arc<Self>,
queue: Arc<Queue>,
) -> Result<CommandBufferExecFuture<NowFuture>, CommandBufferExecError>
where
Self: Sized + 'static,
{
let device = queue.device().clone();
self.execute_after(now(device), queue)
}
/// Executes the command buffer after an existing future.
///
/// This function returns an object that implements the [`GpuFuture`] trait. See the
/// documentation of the [`future`][crate::sync::future] module for more information.
///
/// The command buffer is not actually executed until you call [`flush()`][GpuFuture::flush] on
/// the future. You are encouraged to chain together as many futures as possible prior to
/// calling [`flush()`][GpuFuture::flush]. In order to know when the future has completed, call
/// one of [`then_signal_fence()`][GpuFuture::then_signal_fence] or
/// [`then_signal_semaphore()`][GpuFuture::then_signal_semaphore]. You can do both together
/// with [`then_signal_fence_and_flush()`][GpuFuture::then_signal_fence_and_flush] or
/// [`then_signal_semaphore_and_flush()`][GpuFuture::then_signal_semaphore_and_flush],
/// respectively.
///
/// > **Note**: In the future this function may return `-> impl GpuFuture` instead of a
/// > concrete type.
///
/// This function requires the `'static` lifetime to be on the command buffer. This is because
/// this function returns a `CommandBufferExecFuture` whose job is to lock resources and keep
/// them alive while they are in use by the GPU. If `'static` wasn't required, you could call
/// `std::mem::forget` on that object and "unlock" these resources. For more information about
/// this problem, search the web for "rust thread scoped leakpocalypse".
///
/// # Panics
///
/// - Panics if the device of the command buffer is not the same as the device of the future.
fn execute_after<F>(
self: Arc<Self>,
future: F,
queue: Arc<Queue>,
) -> Result<CommandBufferExecFuture<F>, CommandBufferExecError>
where
Self: Sized + 'static,
F: GpuFuture,
{
assert_eq!(self.device().handle(), future.device().handle());
if !future.queue_change_allowed() {
assert!(future.queue().unwrap() == queue);
}
Ok(CommandBufferExecFuture {
previous: future,
command_buffer: self,
queue,
submitted: Mutex::new(false),
finished: AtomicBool::new(false),
})
}
#[doc(hidden)]
fn state(&self) -> MutexGuard<'_, CommandBufferState>;
#[doc(hidden)]
fn resources_usage(&self) -> &CommandBufferResourcesUsage;
}
impl Debug for dyn PrimaryCommandBufferAbstract {
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
Debug::fmt(&self.handle(), f)
}
}
unsafe impl<T> PrimaryCommandBufferAbstract for T
where
T: VulkanObject<Handle = ash::vk::CommandBuffer> + SafeDeref + Send + Sync,
T::Target: PrimaryCommandBufferAbstract,
{
fn usage(&self) -> CommandBufferUsage {
(**self).usage()
}
fn state(&self) -> MutexGuard<'_, CommandBufferState> {
(**self).state()
}
fn resources_usage(&self) -> &CommandBufferResourcesUsage {
(**self).resources_usage()
}
}
pub unsafe trait SecondaryCommandBufferAbstract:
VulkanObject<Handle = ash::vk::CommandBuffer> + DeviceOwned + Send + Sync
{
/// Returns the usage of this command buffer.
fn usage(&self) -> CommandBufferUsage;
/// Returns a `CommandBufferInheritance` value describing the properties that the command
/// buffer inherits from its parent primary command buffer.
fn inheritance_info(&self) -> &CommandBufferInheritanceInfo;
/// Checks whether this command buffer is allowed to be recorded to a command buffer,
/// and if so locks it.
///
/// If you call this function, then you should call `unlock` afterwards.
fn lock_record(&self) -> Result<(), Box<ValidationError>>;
/// Unlocks the command buffer. Should be called once for each call to `lock_record`.
///
/// # Safety
///
/// Must not be called if you haven't called `lock_record` before.
unsafe fn unlock(&self);
#[doc(hidden)]
fn resources_usage(&self) -> &SecondaryCommandBufferResourcesUsage;
}
unsafe impl<T> SecondaryCommandBufferAbstract for T
where
T: VulkanObject<Handle = ash::vk::CommandBuffer> + SafeDeref + Send + Sync,
T::Target: SecondaryCommandBufferAbstract,
{
fn usage(&self) -> CommandBufferUsage {
(**self).usage()
}
fn inheritance_info(&self) -> &CommandBufferInheritanceInfo {
(**self).inheritance_info()
}
fn lock_record(&self) -> Result<(), Box<ValidationError>> {
(**self).lock_record()
}
unsafe fn unlock(&self) {
(**self).unlock();
}
fn resources_usage(&self) -> &SecondaryCommandBufferResourcesUsage {
(**self).resources_usage()
}
}
/// Represents a command buffer being executed by the GPU and the moment when the execution
/// finishes.
#[derive(Debug)]
#[must_use = "Dropping this object will immediately block the thread until the GPU has finished processing the submission"]
pub struct CommandBufferExecFuture<F>
where
F: GpuFuture,
{
previous: F,
command_buffer: Arc<dyn PrimaryCommandBufferAbstract>,
queue: Arc<Queue>,
// True if the command buffer has already been submitted.
// If flush is called multiple times, we want to block so that only one flushing is executed.
// Therefore we use a `Mutex<bool>` and not an `AtomicBool`.
submitted: Mutex<bool>,
finished: AtomicBool,
}
impl<F> CommandBufferExecFuture<F>
where
F: GpuFuture,
{
// Implementation of `build_submission`. Doesn't check whenever the future was already flushed.
// You must make sure to not submit same command buffer multiple times.
unsafe fn build_submission_impl(&self) -> Result<SubmitAnyBuilder, Validated<VulkanError>> {
Ok(match self.previous.build_submission()? {
SubmitAnyBuilder::Empty => SubmitAnyBuilder::CommandBuffer(
SubmitInfo {
command_buffers: vec![self.command_buffer.clone()],
..Default::default()
},
None,
),
SubmitAnyBuilder::SemaphoresWait(semaphores) => {
SubmitAnyBuilder::CommandBuffer(
SubmitInfo {
wait_semaphores: semaphores
.into_iter()
.map(|semaphore| {
SemaphoreSubmitInfo {
// TODO: correct stages ; hard
stages: PipelineStages::ALL_COMMANDS,
..SemaphoreSubmitInfo::semaphore(semaphore)
}
})
.collect(),
command_buffers: vec![self.command_buffer.clone()],
..Default::default()
},
None,
)
}
SubmitAnyBuilder::CommandBuffer(mut submit_info, fence) => {
// FIXME: add pipeline barrier
submit_info
.command_buffers
.push(self.command_buffer.clone());
SubmitAnyBuilder::CommandBuffer(submit_info, fence)
}
SubmitAnyBuilder::QueuePresent(_) | SubmitAnyBuilder::BindSparse(_, _) => {
unimplemented!() // TODO:
/*present.submit(); // TODO: wrong
let mut builder = SubmitCommandBufferBuilder::new();
builder.add_command_buffer(self.command_buffer.inner());
SubmitAnyBuilder::CommandBuffer(builder)*/
}
})
}
}
unsafe impl<F> GpuFuture for CommandBufferExecFuture<F>
where
F: GpuFuture,
{
fn cleanup_finished(&mut self) {
self.previous.cleanup_finished();
}
unsafe fn build_submission(&self) -> Result<SubmitAnyBuilder, Validated<VulkanError>> {
if *self.submitted.lock() {
return Ok(SubmitAnyBuilder::Empty);
}
self.build_submission_impl()
}
fn flush(&self) -> Result<(), Validated<VulkanError>> {
unsafe {
let mut submitted = self.submitted.lock();
if *submitted {
return Ok(());
}
match self.build_submission_impl()? {
SubmitAnyBuilder::Empty => {}
SubmitAnyBuilder::CommandBuffer(submit_info, fence) => {
self.queue.with(|mut q| {
q.submit_with_future(submit_info, fence, &self.previous, &self.queue)
})?;
}
_ => unreachable!(),
};
// Only write `true` here in order to try again next time if we failed to submit.
*submitted = true;
Ok(())
}
}
unsafe fn signal_finished(&self) {
self.finished.store(true, Ordering::SeqCst);
self.previous.signal_finished();
}
fn queue_change_allowed(&self) -> bool {
false
}
fn queue(&self) -> Option<Arc<Queue>> {
Some(self.queue.clone())
}
fn check_buffer_access(
&self,
buffer: &Buffer,
range: Range<DeviceSize>,
exclusive: bool,
queue: &Queue,
) -> Result<(), AccessCheckError> {
let resources_usage = self.command_buffer.resources_usage();
let usage = match resources_usage.buffer_indices.get(buffer) {
Some(&index) => &resources_usage.buffers[index],
None => return Err(AccessCheckError::Unknown),
};
// TODO: check the queue family
let result = usage
.ranges
.range(&range)
.try_fold((), |_, (_range, range_usage)| {
if !range_usage.mutable && exclusive {
Err(AccessCheckError::Unknown)
} else {
Ok(())
}
});
match result {
Ok(()) => Ok(()),
Err(AccessCheckError::Denied(err)) => Err(AccessCheckError::Denied(err)),
Err(AccessCheckError::Unknown) => self
.previous
.check_buffer_access(buffer, range, exclusive, queue),
}
}
fn check_image_access(
&self,
image: &Image,
range: Range<DeviceSize>,
exclusive: bool,
expected_layout: ImageLayout,
queue: &Queue,
) -> Result<(), AccessCheckError> {
let resources_usage = self.command_buffer.resources_usage();
let usage = match resources_usage.image_indices.get(image) {
Some(&index) => &resources_usage.images[index],
None => return Err(AccessCheckError::Unknown),
};
// TODO: check the queue family
let result = usage
.ranges
.range(&range)
.try_fold((), |_, (_range, range_usage)| {
if expected_layout != ImageLayout::Undefined
&& range_usage.final_layout != expected_layout
{
return Err(AccessCheckError::Denied(
AccessError::UnexpectedImageLayout {
allowed: range_usage.final_layout,
requested: expected_layout,
},
));
}
if !range_usage.mutable && exclusive {
Err(AccessCheckError::Unknown)
} else {
Ok(())
}
});
match result {
Ok(()) => Ok(()),
Err(AccessCheckError::Denied(err)) => Err(AccessCheckError::Denied(err)),
Err(AccessCheckError::Unknown) => {
self.previous
.check_image_access(image, range, exclusive, expected_layout, queue)
}
}
}
#[inline]
fn check_swapchain_image_acquired(
&self,
swapchain: &Swapchain,
image_index: u32,
_before: bool,
) -> Result<(), AccessCheckError> {
self.previous
.check_swapchain_image_acquired(swapchain, image_index, false)
}
}
unsafe impl<F> DeviceOwned for CommandBufferExecFuture<F>
where
F: GpuFuture,
{
fn device(&self) -> &Arc<Device> {
self.command_buffer.device()
}
}
impl<F> Drop for CommandBufferExecFuture<F>
where
F: GpuFuture,
{
fn drop(&mut self) {
if !*self.finished.get_mut() && !thread::panicking() {
// TODO: handle errors?
self.flush().unwrap();
// Block until the queue finished.
self.queue.with(|mut q| q.wait_idle()).unwrap();
unsafe { self.previous.signal_finished() };
}
}
}
/// Error that can happen when attempting to execute a command buffer.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum CommandBufferExecError {
/// Access to a resource has been denied.
AccessError {
error: AccessError,
command_name: Cow<'static, str>,
command_param: Cow<'static, str>,
command_offset: usize,
},
/// The command buffer or one of the secondary command buffers it executes was created with the
/// "one time submit" flag, but has already been submitted it the past.
OneTimeSubmitAlreadySubmitted,
/// The command buffer or one of the secondary command buffers it executes is already in use by
/// the GPU and was not created with the "concurrent" flag.
ExclusiveAlreadyInUse,
// TODO: missing entries (eg. wrong queue family, secondary command buffer)
}
impl Error for CommandBufferExecError {
fn source(&self) -> Option<&(dyn Error + 'static)> {
match self {
CommandBufferExecError::AccessError { error, .. } => Some(error),
_ => None,
}
}
}
impl Display for CommandBufferExecError {
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
match self {
CommandBufferExecError::AccessError {
error: _,
command_name,
command_offset,
command_param,
} => write!(
f,
"access to a resource has been denied on command {} (offset: {}, param: {})",
command_name, command_offset, command_param,
),
CommandBufferExecError::OneTimeSubmitAlreadySubmitted => write!(
f,
"the command buffer or one of the secondary command buffers it executes was \
created with the \"one time submit\" flag, but has already been submitted in \
the past",
),
CommandBufferExecError::ExclusiveAlreadyInUse => write!(
f,
"the command buffer or one of the secondary command buffers it executes is \
already in use was not created with the \"concurrent\" flag"
),
}
}
}