Skip to content

Commit

Permalink
Backport Do not feed &"" to D3DCompile (#5812) to 0.20 (#5831)
Browse files Browse the repository at this point in the history
A recent change by rustc, now in 1.79-stable, makes empty str constants
point to the same location: 0x01. This is an optimization of sorts, not
stable behavior. Code must not rely on constants having stable addresses
nor should it pass &"" to APIs expecting CStrs or NULL addresses.
D3DCompile will segfault if you give it such a pointer, or worse:
read random garbage addresses!

Pass the NULL pointer to D3DCompile if wgpu lacks a decent CString.

refs:
- https://learn.microsoft.com/en-us/windows/win32/api/d3dcompiler/nf-d3dcompiler-d3dcompile

Co-authored-by: Jubilee <[email protected]>
Co-authored-by: Jan Hohenheim <[email protected]>
Co-authored-by: Brezak <[email protected]>
  • Loading branch information
4 people authored Jun 18, 2024
1 parent 098c56f commit 32d21c8
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
7 changes: 1 addition & 6 deletions wgpu-hal/src/dx12/device.rs
Original file line number Diff line number Diff line change
Expand Up @@ -263,12 +263,7 @@ impl super::Device {
.as_ref()
.map_err(|e| crate::PipelineError::Linkage(stage_bit, format!("{e}")))?;

let source_name = stage
.module
.raw_name
.as_ref()
.and_then(|cstr| cstr.to_str().ok())
.unwrap_or_default();
let source_name = stage.module.raw_name.as_deref();

// Compile with DXC if available, otherwise fall back to FXC
let (result, log_level) = if let Some(ref dxc_container) = self.dxc_container {
Expand Down
19 changes: 15 additions & 4 deletions wgpu-hal/src/dx12/shader_compilation.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use std::ffi::CStr;
use std::ptr;

pub(super) use dxc::{compile_dxc, get_dxc_container, DxcContainer};
Expand All @@ -14,7 +15,7 @@ use crate::auxil::dxgi::result::HResult;
pub(super) fn compile_fxc(
device: &super::Device,
source: &str,
source_name: &str,
source_name: Option<&CStr>,
raw_ep: &std::ffi::CString,
stage_bit: wgt::ShaderStages,
full_stage: String,
Expand All @@ -32,13 +33,17 @@ pub(super) fn compile_fxc(
{
compile_flags |= d3dcompiler::D3DCOMPILE_DEBUG | d3dcompiler::D3DCOMPILE_SKIP_OPTIMIZATION;
}

// If no name has been set, D3DCompile wants the null pointer.
let source_name = source_name.map(|cstr| cstr.as_ptr()).unwrap_or(ptr::null());

let mut error = d3d12::Blob::null();
let hr = unsafe {
profiling::scope!("d3dcompiler::D3DCompile");
d3dcompiler::D3DCompile(
source.as_ptr().cast(),
source.len(),
source_name.as_ptr().cast(),
source_name.cast(),
ptr::null(),
ptr::null_mut(),
raw_ep.as_ptr(),
Expand Down Expand Up @@ -78,6 +83,7 @@ pub(super) fn compile_fxc(
// The Dxc implementation is behind a feature flag so that users who don't want to use dxc can disable the feature.
#[cfg(feature = "dxc_shader_compiler")]
mod dxc {
use std::ffi::CStr;
use std::path::PathBuf;

// Destructor order should be fine since _dxil and _dxc don't rely on each other.
Expand Down Expand Up @@ -132,7 +138,7 @@ mod dxc {
pub(crate) fn compile_dxc(
device: &crate::dx12::Device,
source: &str,
source_name: &str,
source_name: Option<&CStr>,
raw_ep: &str,
stage_bit: wgt::ShaderStages,
full_stage: String,
Expand Down Expand Up @@ -166,6 +172,10 @@ mod dxc {
Err(e) => return (Err(e), log::Level::Error),
};

let source_name = source_name
.and_then(|cstr| cstr.to_str().ok())
.unwrap_or("");

let compiled = dxc_container.compiler.compile(
&blob,
source_name,
Expand Down Expand Up @@ -263,6 +273,7 @@ mod dxc {
// These are stubs for when the `dxc_shader_compiler` feature is disabled.
#[cfg(not(feature = "dxc_shader_compiler"))]
mod dxc {
use std::ffi::CStr;
use std::path::PathBuf;

pub(crate) struct DxcContainer {}
Expand All @@ -280,7 +291,7 @@ mod dxc {
pub(crate) fn compile_dxc(
_device: &crate::dx12::Device,
_source: &str,
_source_name: &str,
_source_name: Option<&CStr>,
_raw_ep: &str,
_stage_bit: wgt::ShaderStages,
_full_stage: String,
Expand Down

0 comments on commit 32d21c8

Please sign in to comment.