Rust-GPU / Rust-GPU/rust-gpu

[Migrated] RuntimeArray as uniform creates invalid spv instead of erroring

Offen
#68 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Rust
Sterne
3.4k
Forks
126
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Issue automatically imported from old repo: https://github.com/EmbarkStudios/rust-gpu/issues/1098
Old labels: t: bug
Originally creatd by Firestar99 on 2023-11-13T10:30:24Z


Expected Behaviour

In the following example, you can't have a uniform with a variable amount of data, so it must be a storage_buffer instead. Currently, rust-gpu compiles it to an invalid spv, that is then caught by spirv-opt running afterwards, noticing the invalid spv and failing the build. Rust-gpu should probably catch this mistake earlier in the build pipeline and not even produce an invalid spv in the first place.

#[spirv(descriptor_set = 0, binding = 0, uniform)] vertex_input_buffer: &[f32],
Example & Steps To Reproduce
  1. have a shader entry point with the parameter declaration above
  2. compile the shader crate
  3. observe compile failing due to invalid spv being optimized

System Info

  • Rust: nightly-2023-05-27
  • OS: Ubuntu 23.04
  • GPU: irrevelant
  • SPIR-V: v2023.5 unknown hash, 2023-10-17T17:19:41

Backtrace

Backtrace

   Compiling space-engine v0.1.0 (<project dir>/space-engine)
error: failed to run custom build command for `space-engine v0.1.0 (<project dir>/space-engine)`
note: To improve backtraces for build dependencies, set the CARGO_PROFILE_DEV_BUILD_OVERRIDE_DEBUG=true environment variable to enable debug information generation.
Caused by:
  process didn't exit successfully: `<project dir>/target/debug/build/space-engine-ab7683b3782ee376/build-script-build` (exit status: 1)
  --- stdout
  cargo:rerun-if-env-changed=RUSTGPU_CODEGEN_ARGS
  cargo:rerun-if-env-changed=RUSTGPU_RUSTFLAGS
  --- stderr
     Compiling space-engine-shader v0.1.0 (<project dir>/space-engine-shader)
warning: error:0:0 - [VUID-StandaloneSpirv-OpTypeRuntimeArray-04680] For Vulkan, an OpTypeStruct variable containing an OpTypeRuntimeArray must be decorated with BufferBlock if it has storage class Uniform.
    |
    = note: spirv-opt failed, leaving as unoptimized
    = note: module `<project dir>/target/spirv-builder/spirv-unknown-vulkan1.2/release/deps/space_engine_shader.spvs/space-renderer-lod_obj-opaque_shader-opaque_vs.spv`
  error: error:0:0 - [VUID-StandaloneSpirv-OpTypeRuntimeArray-04680] For Vulkan, an OpTypeStruct variable containing an OpTypeRuntimeArray must be decorated with BufferBlock if it has storage class Uniform.
    |
    = note: spirv-val failed
    = note: module `<project dir>/target/spirv-builder/spirv-unknown-vulkan1.2/release/deps/space_engine_shader.spvs/space-renderer-lod_obj-opaque_shader-opaque_vs.spv`
  warning: `space-engine-shader` (lib) generated 1 warning
  error: could not compile `space-engine-shader` (lib) due to previous error; 1 warning emitted
  Error: SpirvBuilderError(BuildFailed)
Process finished with exit code 101

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Parameterdeklaration des Shader-Einstiegspunkts unter Verwendung von #[spirv(..., uniform)] vertex_input_buffer: &[f32] und verfolge den Compilerpfad, der Runtime-Arrays im Uniform-Speicher verarbeitet. Reproduziere den Build mit spirv-opt und spirv-val und bestätige anschließend, dass der Compiler die ungültige Kombination aus Uniform und Runtime-Array meldet, bevor er ungültiges SPIR-V ausgibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rust
Bereich
compilers
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.