Merge branch 'main' of github.com:microsoft/DirectXShaderCompiler into devshFixes

Author: AnastaZIuk

appveyor.yml

@@ -47,9 +47,9 @@ test_script:
 - ps:  utils\appveyor\appveyor_test.ps1
 - cmd: call utils\hct\hcttest -rel clang
 - sh: ./bin/dxc --help
-- sh: ./bin/dxc -T ps_6_0 ../tools/clang/test/CodeGenSPIRV/passthru-ps.hlsl2spv
-- sh: ./bin/dxc -T ps_6_0 -Fo passthru-ps.dxil ../tools/clang/test/CodeGenSPIRV/passthru-ps.hlsl2spv
-- sh: ./bin/dxc -T ps_6_0 -Fo passthru-ps.spv ../tools/clang/test/CodeGenSPIRV/passthru-ps.hlsl2spv -spirv
+- sh: ./bin/dxc -T ps_6_0 ../tools/clang/test/CodeGenSPIRV_Lit/passthru-ps.hlsl2spv
+- sh: ./bin/dxc -T ps_6_0 -Fo passthru-ps.dxil ../tools/clang/test/CodeGenSPIRV_Lit/passthru-ps.hlsl2spv
+- sh: ./bin/dxc -T ps_6_0 -Fo passthru-ps.spv ../tools/clang/test/CodeGenSPIRV_Lit/passthru-ps.hlsl2spv -spirv
 - sh: ./tools/clang/unittests/SPIRV/ClangSPIRVTests --spirv-test-root ../tools/clang/test/CodeGenSPIRV/
 - sh: ./tools/clang/unittests/HLSL/ClangHLSLTests --HlslDataDir $PWD/../tools/clang/test/HLSL/
 

external/SPIRV-Headers

@@ -14,6 +14,13 @@
 #include "DxcPixTypes.h"
 #include "DxilDiaSession.h"
 
+static CA2W GetTypeNameOrDefault(llvm::DIType *diType) {
+  auto stringRef = diType->getName();
+  if (stringRef.empty())
+    return CA2W("<unnamed>");
+  return CA2W(stringRef.data());
+}
+
 HRESULT dxil_debug_info::CreateDxcPixType(
     DxcPixDxilDebugInfo *pDxilDebugInfo,
     llvm::DIType *diType,
@@ -89,7 +96,9 @@ STDMETHODIMP dxil_debug_info::DxcPixConstType::GetName(
   CComBSTR BaseName;
   IFR(BaseType->GetName(&BaseName));
 
-  *Name = CComBSTR((L"const " + std::wstring(BaseName)).c_str()).Detach();
+  *Name =
+      CComBSTR((L"const " + std::wstring(BaseName)).c_str())
+          .Detach();
   return S_OK;
 }
 
@@ -111,7 +120,8 @@ STDMETHODIMP dxil_debug_info::DxcPixConstType::UnAlias(
 STDMETHODIMP dxil_debug_info::DxcPixTypedefType::GetName(
     _Outptr_result_z_ BSTR *Name)
 {
-  *Name = CComBSTR(CA2W(m_pType->getName().data())).Detach();
+  *Name =
+      CComBSTR(GetTypeNameOrDefault(m_pType)).Detach();
   return S_OK;
 }
 
@@ -133,7 +143,8 @@ STDMETHODIMP dxil_debug_info::DxcPixTypedefType::UnAlias(
 STDMETHODIMP dxil_debug_info::DxcPixScalarType::GetName(
     _Outptr_result_z_ BSTR *Name)
 {
-  *Name = CComBSTR(CA2W(m_pType->getName().data())).Detach();
+  *Name =
+      CComBSTR(GetTypeNameOrDefault(m_pType)).Detach();
   return S_OK;
 }
 
@@ -155,7 +166,7 @@ STDMETHODIMP dxil_debug_info::DxcPixScalarType::UnAlias(
 STDMETHODIMP dxil_debug_info::DxcPixArrayType::GetName(
     _Outptr_result_z_ BSTR *Name)
 {
-  CComBSTR name(CA2W(m_pBaseType->getName().data()));
+  CComBSTR name(GetTypeNameOrDefault(m_pBaseType));
   name.Append(L"[]");
   *Name = name.Detach();
   return S_OK;
@@ -225,7 +236,8 @@ STDMETHODIMP dxil_debug_info::DxcPixArrayType::GetElementType(
 STDMETHODIMP dxil_debug_info::DxcPixStructType::GetName(
     _Outptr_result_z_ BSTR *Name)
 {
-  *Name = CComBSTR(CA2W(m_pStruct->getName().data())).Detach();
+  *Name =
+      CComBSTR(GetTypeNameOrDefault(m_pStruct)).Detach();
   return S_OK;
 }
 
@@ -357,7 +369,8 @@ STDMETHODIMP dxil_debug_info::DxcPixStructType::GetBaseType(
 STDMETHODIMP dxil_debug_info::DxcPixStructField::GetName(
     _Outptr_result_z_ BSTR *Name) 
 {
-  *Name = CComBSTR(CA2W(m_pField->getName().data())).Detach();
+  *Name =
+      CComBSTR(GetTypeNameOrDefault(m_pField)).Detach();
   return S_OK;
 }
 

external/SPIRV-Tools

@@ -133,11 +133,33 @@ bool DxilAnnotateWithVirtualRegister::runOnModule(llvm::Module &M) {
 
   auto instrumentableFunctions = PIXPassHelpers::GetAllInstrumentableFunctions(*m_DM);
 
-  for (auto * F : instrumentableFunctions) {
+  for (auto *F : instrumentableFunctions) {
+    for (auto &block : F->getBasicBlockList()) {
+      for (llvm::Instruction &I : block.getInstList()) {
+        AnnotateValues(&I);
+      }
+    }
+  }
+
+  for (auto *F : instrumentableFunctions) {
+    for (auto &block : F->getBasicBlockList()) {
+      for (llvm::Instruction &I : block.getInstList()) {
+        AnnotateStore(&I);
+      }
+    }
+  }
+
+  for (auto *F : instrumentableFunctions) {
     int InstructionRangeStart = InstNum;
     int InstructionRangeEnd = InstNum;
     for (auto &block : F->getBasicBlockList()) {
       for (llvm::Instruction &I : block.getInstList()) {
+        // If the instruction is part of the debug value instrumentation added by this pass, 
+        // it doesn't need to be instrumented for the PIX user.
+        uint32_t unused1, unused2;
+        if (auto *Alloca = llvm::dyn_cast<llvm::AllocaInst>(&I))
+            if (PixAllocaReg::FromInst(Alloca, &unused1, &unused2))
+                continue;
         if (!llvm::isa<llvm::DbgDeclareInst>(&I)) {
           pix_dxil::PixDxilInstNum::AddMD(M.getContext(), &I, InstNum++);
           InstructionRangeEnd = InstNum;
@@ -163,22 +185,6 @@ bool DxilAnnotateWithVirtualRegister::runOnModule(llvm::Module &M) {
     *OSOverride << "\nInstructionCount:" << InstNum << "\n";
   }
 
-  for (auto * F : instrumentableFunctions) {
-    for (auto &block : F->getBasicBlockList()) {
-      for (llvm::Instruction &I : block.getInstList()) {
-        AnnotateValues(&I);
-      }
-    }
-  }
-
-  for (auto * F : instrumentableFunctions) {
-    for (auto &block : F->getBasicBlockList()) {
-      for (llvm::Instruction &I : block.getInstList()) {
-        AnnotateStore(&I);
-      }
-    }
-  }
-
   m_DM = nullptr;
   return m_uVReg > 0;
 }

lib/DxilDia/DxcPixTypes.cpp

@@ -212,6 +212,8 @@ class DxilDebugInstrumentation : public ModulePass {
       unsigned InstanceId;
     } VertexShader;
   };
+  unsigned m_FirstInstruction = 0;
+  unsigned m_LastInstruction = static_cast<unsigned>(-1);
 
   uint64_t m_UAVSize = 1024 * 1024;
   struct PerFunctionValues
@@ -290,6 +292,9 @@ class DxilDebugInstrumentation : public ModulePass {
 };
 
 void DxilDebugInstrumentation::applyOptions(PassOptions O) {
+  GetPassOptionUnsigned(O, "FirstInstruction", &m_FirstInstruction, 0);
+  GetPassOptionUnsigned(O, "LastInstruction", &m_LastInstruction,
+                        static_cast<unsigned>(-1));
   GetPassOptionUnsigned(O, "parameter0", &m_Parameters.Parameters[0], 0);
   GetPassOptionUnsigned(O, "parameter1", &m_Parameters.Parameters[1], 0);
   GetPassOptionUnsigned(O, "parameter2", &m_Parameters.Parameters[2], 0);
@@ -1008,7 +1013,13 @@ bool DxilDebugInstrumentation::RunOnFunction(
   for (inst_iterator I = inst_begin(entryFunction),
                      E = inst_end(entryFunction);
        I != E; ++I) {
-    AllInstructions.push_back(&*I);
+    std::uint32_t InstructionNumber;
+    if (pix_dxil::PixDxilInstNum::FromInst(&*I, &InstructionNumber)) {
+      if (InstructionNumber < m_FirstInstruction ||
+          InstructionNumber >= m_LastInstruction)
+        continue;
+      AllInstructions.push_back(&*I);
+    }
   }
 
   // Branchless instrumentation requires taking care of a few things:
@@ -1121,6 +1132,8 @@ bool DxilDebugInstrumentation::RunOnFunction(
         if (!pix_dxil::PixDxilInstNum::FromInst(ValueNPhi.Phi, &InstNum)) {
           continue;
         }
+        if (InstNum < m_FirstInstruction || InstNum >= m_LastInstruction)
+          continue;
 
         BuilderContext BC{M, DM, Ctx, HlslOP, Builder};
         addStepDebugEntryValue(BC, InstNum, ValueNPhi.Val, RegNum,

lib/DxilPIXPasses/DxilAnnotateWithVirtualRegister.cpp

@@ -43,6 +43,7 @@ enum class Extension {
   EXT_descriptor_indexing,
   EXT_fragment_fully_covered,
   EXT_fragment_invocation_density,
+  EXT_fragment_shader_interlock,
   EXT_mesh_shader,
   EXT_shader_stencil_export,
   EXT_shader_viewport_index_layer,

lib/DxilPIXPasses/DxilDebugInstrumentation.cpp

@@ -23,6 +23,20 @@ void CapabilityVisitor::addExtension(Extension ext, llvm::StringRef target,
     spvBuilder.requireExtension(featureManager.getExtensionName(ext), loc);
 }
 
+bool CapabilityVisitor::addExtensionAndCapabilitiesIfEnabled(
+    Extension ext, llvm::ArrayRef<spv::Capability> capabilities) {
+  if (!featureManager.isExtensionEnabled(ext)) {
+    return false;
+  }
+
+  addExtension(ext, "", {});
+
+  for (auto cap : capabilities) {
+    addCapability(cap);
+  }
+  return true;
+}
+
 void CapabilityVisitor::addCapability(spv::Capability cap, SourceLocation loc) {
   if (cap != spv::Capability::Max) {
     spvBuilder.requireCapability(cap, loc);
@@ -214,18 +228,6 @@ void CapabilityVisitor::addCapabilityForType(const SpirvType *type,
     for (auto field : structType->getFields())
       addCapabilityForType(field.type, loc, sc);
   }
-  // AccelerationStructureTypeNV and RayQueryTypeKHR type
-  // Note: Because AccelerationStructureType can be provided by both
-  // SPV_KHR_ray_query and SPV_{NV,KHR}_ray_tracing extensions, this logic will
-  // result in SPV_KHR_ray_query being unnecessarily required in some cases. If
-  // this is an issue in future (more devices are identified that support
-  // ray_tracing but not ray_query), then we should consider addressing this
-  // interaction with a spirv-opt pass instead.
-  else if (isa<AccelerationStructureTypeNV>(type) ||
-           isa<RayQueryTypeKHR>(type)) {
-    addCapability(spv::Capability::RayQueryKHR);
-    addExtension(Extension::KHR_ray_query, "SPV_KHR_ray_query", {});
-  }
 }
 
 bool CapabilityVisitor::visit(SpirvDecoration *decor) {
@@ -869,6 +871,26 @@ bool CapabilityVisitor::visit(SpirvModule *, Visitor::Phase phase) {
   // supports only some capabilities. This list should be expanded to match the
   // supported capabilities.
   addCapability(spv::Capability::MinLod);
+
+  addExtensionAndCapabilitiesIfEnabled(
+      Extension::EXT_fragment_shader_interlock,
+      {
+          spv::Capability::FragmentShaderSampleInterlockEXT,
+          spv::Capability::FragmentShaderPixelInterlockEXT,
+          spv::Capability::FragmentShaderShadingRateInterlockEXT,
+      });
+
+  // AccelerationStructureType or RayQueryType can be provided by both
+  // ray_tracing and ray_query extension. By default, we select ray_query to
+  // provide it. This is an arbitrary decision. If the user wants avoid one
+  // extension (lack of support by ex), if can be done by providing the list
+  // of enabled extensions.
+  if (!addExtensionAndCapabilitiesIfEnabled(Extension::KHR_ray_query,
+                                            {spv::Capability::RayQueryKHR})) {
+    addExtensionAndCapabilitiesIfEnabled(Extension::KHR_ray_tracing,
+                                         {spv::Capability::RayTracingKHR});
+  }
+
   return true;
 }
 

tools/clang/include/clang/SPIRV/FeatureManager.h

@@ -64,6 +64,12 @@ class CapabilityVisitor : public Visitor {
   /// the given extension to the SPIR-V module in memory.
   void addExtension(Extension ext, llvm::StringRef target, SourceLocation loc);
 
+  /// Checks that the given extension is enabled based on command line arguments
+  /// before calling addExtension and addCapability.
+  /// Returns `true` if the extension was enabled, `false` otherwise.
+  bool addExtensionAndCapabilitiesIfEnabled(
+      Extension ext, llvm::ArrayRef<spv::Capability> capabilities);
+
   /// Checks that the given capability is a valid capability. And if so,
   /// utilizes the SpirvBuilder to add the given capability to the SPIR-V module
   /// in memory.

tools/clang/lib/SPIRV/CapabilityVisitor.cpp

@@ -172,6 +172,8 @@ Extension FeatureManager::getExtensionSymbol(llvm::StringRef name) {
             Extension::EXT_fragment_fully_covered)
       .Case("SPV_EXT_fragment_invocation_density",
             Extension::EXT_fragment_invocation_density)
+      .Case("SPV_EXT_fragment_shader_interlock",
+            Extension::EXT_fragment_shader_interlock)
       .Case("SPV_EXT_mesh_shader", Extension::EXT_mesh_shader)
       .Case("SPV_EXT_shader_stencil_export",
             Extension::EXT_shader_stencil_export)
@@ -228,6 +230,8 @@ const char *FeatureManager::getExtensionName(Extension symbol) {
     return "SPV_EXT_fragment_fully_covered";
   case Extension::EXT_fragment_invocation_density:
     return "SPV_EXT_fragment_invocation_density";
+  case Extension::EXT_fragment_shader_interlock:
+    return "SPV_EXT_fragment_shader_interlock";
   case Extension::EXT_mesh_shader:
     return "SPV_EXT_mesh_shader";
   case Extension::EXT_shader_stencil_export: