Rust-GPU / Rust-GPU/rust-gpu

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

Ouverte
#68 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Rust
Étoiles
3.4k
Forks
126
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la déclaration du paramètre du point d’entrée du shader en utilisant #[spirv(..., uniform)] vertex_input_buffer: &[f32] et suivez le chemin du compilateur qui gère les tableaux de taille variable dans le stockage uniform. Reproduisez le build avec spirv-opt et spirv-val, puis confirmez que le compilateur signale la combinaison invalide de uniform et de tableau de taille variable avant d’émettre un SPIR-V invalide.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
rust
Domaine
compilers
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.