Pix: Fix crash getting type name of unnamed structs (microsoft#5658)

...and other types while I'm at it. There are tests for all of the
possible unnamed types (structs, members, arrays). Don't think I can
express an unnamed scalar or typededf so there's no test for those.
(This was hit in the wild while debugging a pixel shader in a WinPIX
capture of a Large Well-Known Engine.)

Author: jeffnn

lib/DxilDia/DxcPixTypes.cpp

@@ -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;
 }
 

tools/clang/unittests/HLSL/PixTest.cpp

@@ -237,6 +237,10 @@ class PixTest {
   TEST_METHOD(DxcPixDxilDebugInfo_StructContainedResource)
   TEST_METHOD(DxcPixDxilDebugInfo_StructStaticInit)
   TEST_METHOD(DxcPixDxilDebugInfo_StructMemberFnFirst)
+  TEST_METHOD(DxcPixDxilDebugInfo_UnnamedConstStruct)
+  TEST_METHOD(DxcPixDxilDebugInfo_UnnamedStruct)
+  TEST_METHOD(DxcPixDxilDebugInfo_UnnamedArray)
+  TEST_METHOD(DxcPixDxilDebugInfo_UnnamedField)
 
   TEST_METHOD(VirtualRegisters_InstructionCounts)
   TEST_METHOD(VirtualRegisters_AlignedOffsets)
@@ -250,6 +254,9 @@ class PixTest {
   dxc::DxcDllSupport m_dllSupport;
   VersionSupportInfo m_ver;
 
+  void PixTest::TestUnnamedTypeCase(const char *hlsl,
+                                    const wchar_t *expectedTypeName);
+
   void CreateBlobPinned(_In_bytecount_(size) LPCVOID data, SIZE_T size,
                         UINT32 codePage, _Outptr_ IDxcBlobEncoding **ppBlob) {
     CComPtr<IDxcLibrary> library;
@@ -3048,6 +3055,155 @@ void main()
   VERIFY_IS_TRUE(FoundTheStruct);
 }
 
+void PixTest::TestUnnamedTypeCase(const char* hlsl, const wchar_t* expectedTypeName) {
+  if (m_ver.SkipDxilVersion(1, 2))
+    return;
+  auto dxilDebugger = CompileAndCreateDxcDebug(hlsl, L"cs_6_0");
+  auto liveVariables =
+      GetLiveVariablesAt(hlsl, "InterestingLine", dxilDebugger);
+  DWORD count;
+  VERIFY_SUCCEEDED(liveVariables->GetCount(&count));
+  bool FoundTheVariable = false;
+  for (DWORD i = 0; i < count; ++i) {
+    CComPtr<IDxcPixVariable> variable;
+    VERIFY_SUCCEEDED(liveVariables->GetVariableByIndex(i, &variable));
+    CComBSTR name;
+    variable->GetName(&name);
+    if (0 == wcscmp(name, L"glbl")) {
+      FoundTheVariable = true;
+      CComPtr<IDxcPixType> type;
+      VERIFY_SUCCEEDED(variable->GetType(&type));
+      CComBSTR typeName;
+      VERIFY_SUCCEEDED(type->GetName(&typeName));
+      VERIFY_ARE_EQUAL(typeName, expectedTypeName);
+      break;
+    }
+  }
+  VERIFY_IS_TRUE(FoundTheVariable);
+}
+
+TEST_F(PixTest, DxcPixDxilDebugInfo_UnnamedConstStruct) {
+  const char *hlsl = R"(
+RWStructuredBuffer<float> floatRWUAV: register(u0);
+
+[numthreads(1, 1, 1)]
+void main()
+{
+  const struct
+  {
+    float fg;
+    RWStructuredBuffer<float> buf;
+  } glbl = {42.f, floatRWUAV};
+
+  float f = glbl.fg + glbl.buf[1]; // InterestingLine
+  floatRWUAV[0] = f;
+}
+
+)";
+
+  TestUnnamedTypeCase(hlsl, L"const <unnamed>");
+}
+
+TEST_F(PixTest, DxcPixDxilDebugInfo_UnnamedStruct) {
+  const char *hlsl = R"(
+RWStructuredBuffer<float> floatRWUAV: register(u0);
+
+[numthreads(1, 1, 1)]
+void main()
+{
+  struct
+  {
+    float fg;
+    RWStructuredBuffer<float> buf;
+  } glbl = {42.f, floatRWUAV};
+  glbl.fg = 41.f;
+  float f = glbl.fg + glbl.buf[1]; // InterestingLine
+  floatRWUAV[0] = f;
+}
+
+)";
+
+  TestUnnamedTypeCase(hlsl, L"<unnamed>");
+}
+
+TEST_F(PixTest, DxcPixDxilDebugInfo_UnnamedArray) {
+  const char *hlsl = R"(
+RWStructuredBuffer<float> floatRWUAV: register(u0);
+
+[numthreads(1, 1, 1)]
+void main()
+{
+  struct
+  {
+    float fg;
+    RWStructuredBuffer<float> buf;
+  } glbl[2] = {{42.f, floatRWUAV},{43.f, floatRWUAV}};
+  float f = glbl[0].fg + glbl[1].buf[1]; // InterestingLine
+  floatRWUAV[0] = f;
+}
+
+)";
+
+  TestUnnamedTypeCase(hlsl, L"<unnamed>[]");
+}
+
+TEST_F(PixTest, DxcPixDxilDebugInfo_UnnamedField) {
+  const char *hlsl = R"(
+RWStructuredBuffer<float> floatRWUAV: register(u0);
+
+[numthreads(1, 1, 1)]
+void main()
+{
+  struct
+  {
+    struct {
+      float fg;
+      RWStructuredBuffer<float> buf;
+    } contained;
+  } glbl = { {42.f, floatRWUAV} };
+  float f = glbl.contained.fg + glbl.contained.buf[1]; // InterestingLine
+  floatRWUAV[0] = f;
+}
+
+)";
+
+  if (m_ver.SkipDxilVersion(1, 2))
+    return;
+  auto dxilDebugger = CompileAndCreateDxcDebug(hlsl, L"cs_6_0");
+  auto liveVariables =
+      GetLiveVariablesAt(hlsl, "InterestingLine", dxilDebugger);
+  DWORD count;
+  VERIFY_SUCCEEDED(liveVariables->GetCount(&count));
+  bool FoundTheVariable = false;
+  for (DWORD i = 0; i < count; ++i) {
+    CComPtr<IDxcPixVariable> variable;
+    VERIFY_SUCCEEDED(liveVariables->GetVariableByIndex(i, &variable));
+    CComBSTR name;
+    variable->GetName(&name);
+    if (0 == wcscmp(name, L"glbl")) {
+      CComPtr<IDxcPixType> type;
+      VERIFY_SUCCEEDED(variable->GetType(&type));
+      CComPtr<IDxcPixStructType> structType;
+      VERIFY_SUCCEEDED(type->QueryInterface(IID_PPV_ARGS(&structType)));
+      DWORD fieldCount = 0;
+      VERIFY_SUCCEEDED(structType->GetNumFields(&fieldCount));
+      VERIFY_ARE_EQUAL(fieldCount, 1);
+      //Just a crash test:
+      CComPtr<IDxcPixStructField> structField;
+      structType->GetFieldByName(L"", & structField);
+      VERIFY_SUCCEEDED(structType->GetFieldByIndex(0, &structField));
+      FoundTheVariable = true;
+      CComPtr<IDxcPixType> fieldType;
+      VERIFY_SUCCEEDED(structField->GetType(&fieldType));
+      CComBSTR typeName;
+      VERIFY_SUCCEEDED(fieldType->GetName(&typeName));
+      VERIFY_ARE_EQUAL(typeName, L"<unnamed>");
+      break;
+    }
+  }
+  VERIFY_IS_TRUE(FoundTheVariable);
+}
+
 CComPtr<IDxcBlob> PixTest::RunShaderAccessTrackingPass(IDxcBlob *blob) {
   CComPtr<IDxcOptimizer> pOptimizer;
   VERIFY_SUCCEEDED(