Remove debug instructions if target-specific setting is NONE

This helps to address shader-slang#6092.
aleino-nv · Jan 30, 2025 · 0ec7208 · 0ec7208
1 parent 2487ca3
commit 0ec7208
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 0 deletions.
diff --git a/source/slang/slang-emit.cpp b/source/slang/slang-emit.cpp
@@ -93,6 +93,7 @@
 #include "slang-ir-ssa-simplification.h"
 #include "slang-ir-ssa.h"
 #include "slang-ir-string-hash.h"
+#include "slang-ir-strip-debug-info.h"
 #include "slang-ir-strip-default-construct.h"
 #include "slang-ir-strip-legalization-insts.h"
 #include "slang-ir-synthesize-active-mask.h"
@@ -300,6 +301,7 @@ struct LinkingAndOptimizationOptions
 //
 struct RequiredLoweringPassSet
 {
+    bool debugInfo;
     bool resultType;
     bool optionalType;
     bool combinedTextureSamplers;
@@ -331,6 +333,13 @@ void calcRequiredLoweringPassSet(
 {
     switch (inst->getOp())
     {
+    case kIROp_DebugValue:
+    case kIROp_DebugVar:
+    case kIROp_DebugLine:
+    case kIROp_DebugLocationDecoration:
+    case kIROp_DebugSource:
+        result.debugInfo = true;
+        break;
     case kIROp_ResultType:
         result.resultType = true;
         break;
@@ -583,6 +592,7 @@ Result linkAndOptimizeIR(
     auto target = codeGenContext->getTargetFormat();
     auto targetRequest = codeGenContext->getTargetReq();
     auto targetProgram = codeGenContext->getTargetProgram();
+    auto targetCompilerOptions = targetRequest->getOptionSet();
 
     // Get the artifact desc for the target
     const auto artifactDesc = ArtifactDescUtil::makeDescForCompileTarget(asExternal(target));
@@ -614,6 +624,13 @@ Result linkAndOptimizeIR(
     RequiredLoweringPassSet requiredLoweringPassSet = {};
     calcRequiredLoweringPassSet(requiredLoweringPassSet, codeGenContext, irModule->getModuleInst());
 
+    // Debug info is added by the front-end, and therefore needs to be stripped out by targets that
+    // opt out of debug info.
+    if (requiredLoweringPassSet.debugInfo &&
+        (targetCompilerOptions.getIntOption(CompilerOptionName::DebugInformation) ==
+         SLANG_DEBUG_INFO_LEVEL_NONE))
+        stripDebugInfo(irModule);
+
     if (!isKhronosTarget(targetRequest) && requiredLoweringPassSet.glslSSBO)
         lowerGLSLShaderStorageBufferObjectsToStructuredBuffers(irModule, sink);
 

diff --git a/source/slang/slang-ir-strip-debug-info.cpp b/source/slang/slang-ir-strip-debug-info.cpp
@@ -0,0 +1,33 @@
+#include "slang-ir-strip-debug-info.h"
+
+#include "slang-ir-insts.h"
+
+namespace Slang
+{
+static void findDebugInfo(IRInst* inst, List<IRInst*>& debugInstructions)
+{
+    switch (inst->getOp())
+    {
+    case kIROp_DebugValue:
+    case kIROp_DebugVar:
+    case kIROp_DebugLine:
+    case kIROp_DebugLocationDecoration:
+    case kIROp_DebugSource:
+        debugInstructions.add(inst);
+        break;
+    default:
+        break;
+    }
+
+    for (auto child : inst->getChildren())
+        findDebugInfo(child, debugInstructions);
+}
+
+void stripDebugInfo(IRModule* irModule)
+{
+    List<IRInst*> debugInstructions;
+    findDebugInfo(irModule->getModuleInst(), debugInstructions);
+    for (auto debugInst : debugInstructions)
+        debugInst->removeAndDeallocate();
+}
+} // namespace Slang
diff --git a/source/slang/slang-ir-strip-debug-info.h b/source/slang/slang-ir-strip-debug-info.h
@@ -0,0 +1,9 @@
+#pragma once
+
+namespace Slang
+{
+struct IRModule;
+
+/// Strip all debug info instructions from `irModule`
+void stripDebugInfo(IRModule* irModule);
+} // namespace Slang