Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ValidationError-ify command buffers and command pools #2254

Merged
merged 1 commit into from
Jul 6, 2023
Merged

ValidationError-ify command buffers and command pools #2254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
ValidationError-ify command buffers and command pools
  • Loading branch information
@Rua
Rua committed Jul 6, 2023
commit 6ffb97c443cc1d5688e58aaf46a26675348f02eb
78 changes: 49 additions & 29 deletions vulkano/src/command_buffer/allocator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@
use super::{
pool::{
CommandBufferAllocateInfo, CommandPool, CommandPoolAlloc, CommandPoolCreateInfo,
CommandPoolCreationError,
CommandPoolResetFlags,
},
CommandBufferLevel,
};
use crate::{
device::{Device, DeviceOwned},
instance::InstanceOwnedDebugWrapper,
OomError,
Validated, VulkanError,
};
use crossbeam_queue::ArrayQueue;
use smallvec::{IntoIter, SmallVec};
Expand Down Expand Up @@ -72,7 +72,7 @@ pub unsafe trait CommandBufferAllocator: DeviceOwned {
queue_family_index: u32,
level: CommandBufferLevel,
command_buffer_count: u32,
) -> Result<Self::Iter, OomError>;
) -> Result<Self::Iter, VulkanError>;
}

/// A command buffer allocated from a pool and that can be recorded.
Expand Down Expand Up @@ -164,10 +164,10 @@ impl StandardCommandBufferAllocator {
pub fn try_reset_pool(
&self,
queue_family_index: u32,
release_resources: bool,
) -> Result<(), CommandPoolResetError> {
flags: CommandPoolResetFlags,
) -> Result<(), Validated<ResetCommandPoolError>> {
if let Some(entry) = unsafe { &mut *self.entry(queue_family_index) }.as_mut() {
entry.try_reset_pool(release_resources)
entry.try_reset_pool(flags)
} else {
Ok(())
}
Expand Down Expand Up @@ -223,7 +223,7 @@ unsafe impl CommandBufferAllocator for StandardCommandBufferAllocator {
queue_family_index: u32,
level: CommandBufferLevel,
command_buffer_count: u32,
) -> Result<Self::Iter, OomError> {
) -> Result<Self::Iter, VulkanError> {
// VUID-vkCreateCommandPool-queueFamilyIndex-01937
assert!(self
.device
Expand Down Expand Up @@ -251,7 +251,10 @@ unsafe impl CommandBufferAllocator for StandardCommandBufferAllocator {
}

// Else try to reset the pool.
if entry.try_reset_pool(false).is_err() {
if entry
.try_reset_pool(CommandPoolResetFlags::empty())
.is_err()
{
// If that fails too try to grab a pool from the reserve.
entry.pool = if let Some(inner) = entry.reserve.pop() {
Arc::new(Pool {
Expand Down Expand Up @@ -286,7 +289,7 @@ unsafe impl CommandBufferAllocator for Arc<StandardCommandBufferAllocator> {
queue_family_index: u32,
level: CommandBufferLevel,
command_buffer_count: u32,
) -> Result<Self::Iter, OomError> {
) -> Result<Self::Iter, VulkanError> {
(**self).allocate(queue_family_index, level, command_buffer_count)
}
}
Expand All @@ -312,16 +315,26 @@ struct Entry {
unsafe impl Send for Entry {}

impl Entry {
fn try_reset_pool(&mut self, release_resources: bool) -> Result<(), CommandPoolResetError> {
fn try_reset_pool(
&mut self,
flags: CommandPoolResetFlags,
) -> Result<(), Validated<ResetCommandPoolError>> {
if let Some(pool) = Arc::get_mut(&mut self.pool) {
unsafe { pool.inner.inner.reset(release_resources) }
.map_err(|_| CommandPoolResetError::OutOfDeviceMemory)?;
unsafe {
pool.inner.inner.reset(flags).map_err(|err| match err {
Validated::Error(err) => {
Validated::Error(ResetCommandPoolError::VulkanError(err))
}
Validated::ValidationError(err) => err.into(),
})?
};

*pool.inner.primary_allocations.get_mut() = 0;
*pool.inner.secondary_allocations.get_mut() = 0;

Ok(())
} else {
Err(CommandPoolResetError::InUse)
Err(ResetCommandPoolError::InUse.into())
}
}
}
Expand Down Expand Up @@ -353,20 +366,15 @@ impl Pool {
queue_family_index: u32,
reserve: Arc<ArrayQueue<PoolInner>>,
create_info: &StandardCommandBufferAllocatorCreateInfo,
) -> Result<Arc<Self>, OomError> {
) -> Result<Arc<Self>, VulkanError> {
let inner = CommandPool::new(
device,
CommandPoolCreateInfo {
queue_family_index,
..Default::default()
},
)
.map_err(|err| match err {
CommandPoolCreationError::OomError(err) => err,
// We check that the provided queue family index is active on the device, so it can't
// be out of range.
CommandPoolCreationError::QueueFamilyIndexOutOfRange { .. } => unreachable!(),
})?;
.map_err(Validated::unwrap)?;

let primary_pool = if create_info.primary_buffer_count > 0 {
let pool = ArrayQueue::new(create_info.primary_buffer_count);
Expand Down Expand Up @@ -505,7 +513,7 @@ impl Drop for Pool {
return;
}

unsafe { inner.inner.reset(false) }.unwrap();
unsafe { inner.inner.reset(CommandPoolResetFlags::empty()) }.unwrap();
inner.primary_allocations.set(0);
inner.secondary_allocations.set(0);

Expand Down Expand Up @@ -638,25 +646,37 @@ impl Drop for StandardCommandBufferAlloc {

/// Error that can be returned when resetting a [`CommandPool`].
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum CommandPoolResetError {
pub enum ResetCommandPoolError {
/// A runtime error occurred.
VulkanError(VulkanError),

/// The `CommandPool` is still in use.
InUse,

/// Out of device memory.
OutOfDeviceMemory,
}

impl Error for CommandPoolResetError {}
impl Error for ResetCommandPoolError {}

impl Display for CommandPoolResetError {
impl Display for ResetCommandPoolError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::InUse => write!(f, "the `CommandPool` is still in use"),
Self::OutOfDeviceMemory => write!(f, "out of device memory"),
Self::VulkanError(_) => write!(f, "a runtime error occurred"),
Self::InUse => write!(f, "the command pool is still in use"),
}
}
}

impl From<VulkanError> for ResetCommandPoolError {
fn from(err: VulkanError) -> Self {
Self::VulkanError(err)
}
}

impl From<ResetCommandPoolError> for Validated<ResetCommandPoolError> {
fn from(err: ResetCommandPoolError) -> Self {
Self::Error(err)
}
}

#[cfg(test)]
mod tests {
use super::*;
Expand Down
Loading