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
//! Computing pipeline types
use {
super::{
device::Device,
shader::{DescriptorBindingMap, PipelineDescriptorInfo, Shader},
DriverError,
},
ash::vk,
derive_builder::{Builder, UninitializedFieldError},
log::{trace, warn},
std::{ffi::CString, ops::Deref, sync::Arc, thread::panicking},
};
/// Smart pointer handle to a [pipeline] object.
///
/// Also contains information about the object.
///
/// ## `Deref` behavior
///
/// `ComputePipeline` automatically dereferences to [`vk::Pipeline`] (via the [`Deref`]
/// trait), so you can call `vk::Pipeline`'s methods on a value of type `ComputePipeline`.
///
/// [pipeline]: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkPipeline.html
/// [deref]: core::ops::Deref
#[derive(Debug)]
pub struct ComputePipeline {
pub(crate) descriptor_bindings: DescriptorBindingMap,
pub(crate) descriptor_info: PipelineDescriptorInfo,
device: Arc<Device>,
pub(crate) layout: vk::PipelineLayout,
/// Information used to create this object.
pub info: ComputePipelineInfo,
/// A descriptive name used in debugging messages.
pub name: Option<String>,
pipeline: vk::Pipeline,
pub(crate) push_constants: Option<vk::PushConstantRange>,
}
impl ComputePipeline {
/// Creates a new compute pipeline on the given device.
///
/// # Panics
///
/// If shader code is not a multiple of four bytes.
///
/// # Examples
///
/// Basic usage:
///
/// ```no_run
/// # use std::sync::Arc;
/// # use ash::vk;
/// # use screen_13::driver::DriverError;
/// # use screen_13::driver::device::{Device, DeviceInfo};
/// # use screen_13::driver::compute::{ComputePipeline, ComputePipelineInfo};
/// # use screen_13::driver::shader::{Shader};
/// # fn main() -> Result<(), DriverError> {
/// # let device = Arc::new(Device::create_headless(DeviceInfo::new())?);
/// # let my_shader_code = [0u8; 1];
/// // my_shader_code is raw SPIR-V code as bytes
/// let shader = Shader::new_compute(my_shader_code.as_slice());
/// let pipeline = ComputePipeline::create(&device, ComputePipelineInfo::default(), shader)?;
///
/// assert_ne!(*pipeline, vk::Pipeline::null());
/// # Ok(()) }
/// ```
#[profiling::function]
pub fn create(
device: &Arc<Device>,
info: impl Into<ComputePipelineInfo>,
shader: impl Into<Shader>,
) -> Result<Self, DriverError> {
use std::slice::from_ref;
trace!("create");
let device = Arc::clone(device);
let info: ComputePipelineInfo = info.into();
let shader = shader.into();
// Use SPIR-V reflection to get the types and counts of all descriptors
let mut descriptor_bindings = shader.descriptor_bindings(&device)?;
for (descriptor_info, _) in descriptor_bindings.values_mut() {
if descriptor_info.binding_count() == 0 {
descriptor_info.set_binding_count(info.bindless_descriptor_count);
}
}
let descriptor_info = PipelineDescriptorInfo::create(&device, &descriptor_bindings)?;
let descriptor_set_layouts = descriptor_info
.layouts
.values()
.map(|descriptor_set_layout| **descriptor_set_layout)
.collect::<Box<[_]>>();
unsafe {
let shader_module_create_info = vk::ShaderModuleCreateInfo {
code_size: shader.spirv.len(),
p_code: shader.spirv.as_ptr() as *const u32,
..Default::default()
};
let shader_module = device
.create_shader_module(&shader_module_create_info, None)
.map_err(|err| {
warn!("{err}");
DriverError::Unsupported
})?;
let entry_name = CString::new(shader.entry_name.as_bytes()).unwrap();
let mut stage_create_info = vk::PipelineShaderStageCreateInfo::builder()
.module(shader_module)
.stage(shader.stage)
.name(&entry_name);
let specialization_info = shader.specialization_info.as_ref().map(|info| {
vk::SpecializationInfo::builder()
.map_entries(&info.map_entries)
.data(&info.data)
.build()
});
if let Some(specialization_info) = &specialization_info {
stage_create_info = stage_create_info.specialization_info(specialization_info);
}
let mut layout_info =
vk::PipelineLayoutCreateInfo::builder().set_layouts(&descriptor_set_layouts);
let push_constants = shader.push_constant_range();
if let Some(push_constants) = &push_constants {
layout_info = layout_info.push_constant_ranges(from_ref(push_constants));
}
let layout = device
.create_pipeline_layout(&layout_info, None)
.map_err(|err| {
warn!("{err}");
DriverError::Unsupported
})?;
let pipeline_info = vk::ComputePipelineCreateInfo::builder()
.stage(stage_create_info.build())
.layout(layout);
let pipeline = device
.create_compute_pipelines(
vk::PipelineCache::null(),
from_ref(&pipeline_info.build()),
None,
)
.map_err(|(_, err)| {
warn!("{err}");
DriverError::Unsupported
})?[0];
device.destroy_shader_module(shader_module, None);
Ok(ComputePipeline {
descriptor_bindings,
descriptor_info,
device,
info,
layout,
name: None,
pipeline,
push_constants,
})
}
}
/// Sets the debugging name assigned to this pipeline.
pub fn with_name(mut this: Self, name: impl Into<String>) -> Self {
this.name = Some(name.into());
this
}
}
impl Deref for ComputePipeline {
type Target = vk::Pipeline;
fn deref(&self) -> &Self::Target {
&self.pipeline
}
}
impl Drop for ComputePipeline {
#[profiling::function]
fn drop(&mut self) {
if panicking() {
return;
}
unsafe {
self.device.destroy_pipeline(self.pipeline, None);
self.device.destroy_pipeline_layout(self.layout, None);
}
}
}
/// Information used to create a [`ComputePipeline`] instance.
#[derive(Builder, Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[builder(
build_fn(
private,
name = "fallible_build",
error = "ComputePipelineInfoBuilderError"
),
derive(Clone, Copy, Debug),
pattern = "owned"
)]
#[non_exhaustive]
pub struct ComputePipelineInfo {
/// The number of descriptors to allocate for a given binding when using bindless (unbounded)
/// syntax.
///
/// The default is `8192`.
///
/// # Examples
///
/// Basic usage (GLSL):
///
/// ```
/// # inline_spirv::inline_spirv!(r#"
/// #version 460 core
/// #extension GL_EXT_nonuniform_qualifier : require
///
/// layout(set = 0, binding = 0, rgba8) writeonly uniform image2D my_binding[];
///
/// void main()
/// {
/// // my_binding will have space for 8,192 images by default
/// }
/// # "#, comp);
/// ```
#[builder(default = "8192")]
pub bindless_descriptor_count: u32,
}
impl ComputePipelineInfo {
/// Converts a `ComputePipelineInfo` into a `ComputePipelineInfoBuilder`.
#[inline(always)]
pub fn to_builder(self) -> ComputePipelineInfoBuilder {
ComputePipelineInfoBuilder {
bindless_descriptor_count: Some(self.bindless_descriptor_count),
}
}
}
impl Default for ComputePipelineInfo {
fn default() -> Self {
Self {
bindless_descriptor_count: 8192,
}
}
}
impl From<ComputePipelineInfoBuilder> for ComputePipelineInfo {
fn from(info: ComputePipelineInfoBuilder) -> Self {
info.build()
}
}
impl ComputePipelineInfoBuilder {
/// Builds a new `ComputePipelineInfo`.
#[inline(always)]
pub fn build(self) -> ComputePipelineInfo {
let res = self.fallible_build();
#[cfg(test)]
let res = res.unwrap();
#[cfg(not(test))]
let res = unsafe { res.unwrap_unchecked() };
res
}
}
#[derive(Debug)]
struct ComputePipelineInfoBuilderError;
impl From<UninitializedFieldError> for ComputePipelineInfoBuilderError {
fn from(_: UninitializedFieldError) -> Self {
Self
}
}
#[cfg(test)]
mod tests {
use super::*;
type Info = ComputePipelineInfo;
type Builder = ComputePipelineInfoBuilder;
#[test]
pub fn compute_pipeline_info() {
let info = Info::default();
let builder = info.to_builder().build();
assert_eq!(info, builder);
}
#[test]
pub fn compute_pipeline_info_builder() {
let info = Info::default();
let builder = Builder::default().build();
assert_eq!(info, builder);
}
}