[Vulkan] Add debug config flag for generating shader debug info

Author: hyazinthh

paket.dependencies

@@ -30,7 +30,7 @@ nuget FShade.Debug                                  ~> 5.6.0
 
 nuget Unofficial.OpenVR					            ~> 1.1.0
 nuget CommonMark.NET                                ~> 0.15.1
-nuget GLSLangSharp                                  ~> 0.4.14
+nuget GLSLangSharp                                  ~> 0.5.0
 
 nuget Unofficial.LibTessDotNet                      ~> 2.0.2
 nuget Aardvark.Data.Assimp                          ~> 1.0.1

paket.lock

@@ -205,8 +205,8 @@ NUGET
       FSharp.Core (>= 4.7)
     FuzzySharp (2.0.2)
     Gee.External.Capstone (2.3)
-    GLSLangSharp (0.4.15)
-      FSharp.Core (>= 5.0)
+    GLSLangSharp (0.5)
+      FSharp.Core (>= 8.0)
     glTF2Loader (1.1.4-alpha)
       NETStandard.Library (>= 1.6.1)
       Newtonsoft.Json (>= 10.0.3)

src/Aardvark.Rendering.Vulkan/Core/Common/Config.fs

@@ -123,6 +123,12 @@ type DebugConfig =
 
         /// Verbosity of the logger to be used to print instance and device information.
         PlatformInformationVerbosity : int
+
+        /// Generate SPIR-V debug information (required to inspect source code in Nsight Graphics).
+        GenerateShaderDebugInfo : bool
+
+        /// Optimize shaders after compiling.
+        OptimizeShaders : bool
     }
 
     member internal x.DebugReportEnabled =
@@ -143,14 +149,16 @@ type DebugConfig =
           VerifyShaderCacheIntegrity    = false
           PlatformInformationVerbosity  = 4
           PrintShaderCode               = false
-          PrintRenderTaskRecompile      = false }
+          PrintRenderTaskRecompile      = false
+          GenerateShaderDebugInfo       = false
+          OptimizeShaders               = true }
 
     /// Enables validation layers, printing warnings and errors.
     static member Minimal =
         { DebugConfig.None with
             DebugReport                  = Some DebugReportConfig.Minimal
             ValidationLayer              = Some ValidationLayerConfig.Standard
-            PlatformInformationVerbosity = 2}
+            PlatformInformationVerbosity = 2 }
 
     /// Enables validation layers, printing everything except debug messages.
     /// Also prints shader code and render task recompilation.
@@ -165,7 +173,9 @@ type DebugConfig =
         { DebugConfig.Normal with
             DebugReport                = Some DebugReportConfig.Full
             ValidationLayer            = Some ValidationLayerConfig.Full
-            VerifyShaderCacheIntegrity = true }
+            VerifyShaderCacheIntegrity = true
+            GenerateShaderDebugInfo    = true
+            OptimizeShaders            = false }
 
     interface IDebugConfig
 

src/Aardvark.Rendering.Vulkan/Core/Device/Device.fs

@@ -79,7 +79,7 @@ type Device private (physicalDevice: PhysicalDevice, wantedExtensions: string se
         ]
 
     let wantedExtensions =
-        if instance.DebugConfig.DebugPrintEnabled then
+        if instance.DebugConfig.DebugPrintEnabled || instance.DebugConfig.GenerateShaderDebugInfo then
             List.ofSeq wantedExtensions @ [KHRShaderNonSemanticInfo.Name]
         else
             List.ofSeq wantedExtensions

src/Aardvark.Rendering.Vulkan/Resources/Raytracing/RaytracingProgram.fs

@@ -351,7 +351,7 @@ module RaytracingProgram =
 
         let private tryGetCacheFile (device : Device) (id : string) =
             device.ShaderCachePath |> Option.map (fun prefix ->
-                let hash = ShaderProgram.FileCacheName.ofString id
+                let hash = ShaderProgram.FileCacheName.ofEffectId device id
                 Path.combine [prefix; hash + ".rtx"]
             )
 

src/Aardvark.Rendering.Vulkan/Resources/Shaders/ComputeProgram.fs

@@ -188,7 +188,7 @@ module ComputeProgram =
         device.GetCached(cache, shader, fun shader ->
             match device.ShaderCachePath with
             | Some shaderCachePath ->
-                let fileName = ShaderProgram.FileCacheName.ofString shader.csId
+                let fileName = ShaderProgram.FileCacheName.ofEffectId device shader.csId
                 let file = Path.Combine(shaderCachePath, fileName + ".compute")
 
                 match tryRead file device with

src/Aardvark.Rendering.Vulkan/Resources/Shaders/ShaderModule.fs

@@ -65,16 +65,20 @@ module ShaderModule =
     let ofGLSLWithTarget (target : GLSLang.Target) (slot : FShade.ShaderSlot) (info : FShade.GLSL.GLSLShader) (device : Device) =
         let siface = info.iface.shaders.[slot]
         let defines = [slot.Conditional]
+        let config = device.DebugConfig
 
-        match GLSLang.GLSLang.tryCompileWithTarget target (glslangStage slot) siface.shaderEntry defines info.code with
+        match GLSLang.GLSLang.tryCompileWithTarget target (glslangStage slot) siface.shaderEntry config.GenerateShaderDebugInfo defines info.code with
         | Some binary, _ ->
-            let binary = GLSLang.GLSLang.optimizeDefault binary
+            let binary =
+                if not config.OptimizeShaders then binary
+                else GLSLang.GLSLang.optimizeDefault binary
+
             let handle = device |> createRaw binary
             let result = new ShaderModule(device, handle, slot, binary)
             result
 
         | None, err ->
-            if not device.DebugConfig.PrintShaderCode then
+            if not config.PrintShaderCode then
                 ShaderCodeReporting.logLines "Failed to compile shader" info.code
 
             let err = ShaderCodeReporting.normalizeLineEndings err

src/Aardvark.Rendering.Vulkan/Resources/Shaders/ShaderProgram.fs

@@ -339,13 +339,31 @@ module ShaderProgram =
             let hash = pickler.ComputeHash value
             hash.Hash |> Guid |> string
 
-        let ofEffectKey (key : EffectCacheKey) =
-            let colors = key.layout.ColorAttachments |> Map.map (fun _ att -> string att.Name)
-            let depth = key.layout.DepthStencilAttachment
-            if key.layout.LayerCount > 1 then
-                getHash (key.effect.Id, key.topology, colors, depth, key.layout.LayerCount, key.layout.PerLayerUniforms, FShadeConfig.depthRange)
-            else
-                getHash (key.effect.Id, colors, depth, FShadeConfig.depthRange)
+        type private ShaderSignature =
+            { id         : string
+              debug      : bool
+              optimized  : bool
+              outputs    : Map<int, string * TextureFormat>
+              layered    : Set<string>
+              layerCount : int
+              depthRange : Range1d }
+
+        let ofEffectKey (device: Device) (key: EffectCacheKey) =
+            let signature =
+                let outputs = key.layout.ColorAttachments |> Map.map (fun _ att -> string att.Name, att.Format)
+
+                { id         = key.effect.Id
+                  debug      = device.DebugConfig.GenerateShaderDebugInfo
+                  optimized  = device.DebugConfig.OptimizeShaders
+                  outputs    = outputs
+                  layered    = key.layout.PerLayerUniforms
+                  layerCount = key.layout.LayerCount
+                  depthRange = FShadeConfig.depthRange }
+
+            getHash signature
+
+        let ofEffectId (device: Device) (id: string) =
+            getHash (id, device.DebugConfig.GenerateShaderDebugInfo, device.DebugConfig.OptimizeShaders)
 
         let ofString (value : string) =
             getHash value
@@ -590,7 +608,7 @@ module ShaderProgram =
             match device.ShaderCachePath with
             | Some shaderCachePath ->
                 let cacheFile =
-                    let name = FileCacheName.ofEffectKey key
+                    let name = FileCacheName.ofEffectKey device key
                     Path.Combine(shaderCachePath, name + ".effect")
 
                 match tryRead None cacheFile device with