Fix NS debug bool type in SSBO/UBO. (KhronosGroup#4061)

For GLSL, bool types inside of a buffer or uniform block are translated to uint in SPIR-V. However, the debug info should still represent the type as a bool.

The fix is to construct a bool type in this special case and inject it into the makeMemberDebugType function.

This is more complicated than it should be, because the make*DebugType functions treat their ID argument as a real SPIR-V OpType instea

Author: qingyuanzNV

SPIRV/GlslangToSpv.cpp

@@ -5596,7 +5596,7 @@ spv::Id TGlslangToSpvTraverser::convertGlslangStructToSpvType(const glslang::TTy
     int memberDelta = 0;  // how much the member's index changes from glslang to SPIR-V, normally 0,
                           // except sometimes for blocks
     std::vector<std::pair<glslang::TType*, glslang::TQualifier> > deferredForwardPointers;
-    std::vector<spv::DebugTypeLoc> memberDebugInfo;
+    std::vector<spv::StructMemberDebugInfo> memberDebugInfo;
     for (int i = 0; i < (int)glslangMembers->size(); i++) {
         auto& glslangMember = (*glslangMembers)[i];
         if (glslangMember.type->hiddenMember()) {
@@ -5647,11 +5647,33 @@ spv::Id TGlslangToSpvTraverser::convertGlslangStructToSpvType(const glslang::TTy
             //  + Not as clean as desired. Traverser queries/sets persistent state. This is fragile.
             //  + Table lookup during creation of composite debug types. This really shouldn't be necessary.
             if(options.emitNonSemanticShaderDebugInfo) {
-                spv::DebugTypeLoc typeLoc{};
-                typeLoc.name = glslangMember.type->getFieldName().c_str();
-                typeLoc.line = glslangMember.loc.line;
-                typeLoc.column = glslangMember.loc.column;
-                memberDebugInfo.push_back(typeLoc);
+                spv::StructMemberDebugInfo debugInfo{};
+                debugInfo.name = glslangMember.type->getFieldName();
+                debugInfo.line = glslangMember.loc.line;
+                debugInfo.column = glslangMember.loc.column;
+
+                // Per the GLSL spec, bool variables inside of a uniform or buffer block are generated as uint.
+                // But for debug info, we want to represent them as bool because that is the original type in
+                // the source code. The bool type can be nested within a vector or a multidimensional array, 
+                // so we must construct the chain of types up from the scalar bool.
+                if (glslangIntermediate->getSource() == glslang::EShSourceGlsl && explicitLayout != glslang::ElpNone &&
+                    glslangMember.type->getBasicType() == glslang::EbtBool) {
+                    auto typeId = builder.makeBoolType();
+                    if (glslangMember.type->isVector()) {
+                        typeId = builder.makeVectorType(typeId, glslangMember.type->getVectorSize());
+                    }
+                    if (glslangMember.type->isArray()) {
+                        const auto* arraySizes = glslangMember.type->getArraySizes();
+                        int dims = arraySizes->getNumDims();
+                        for (int i = dims - 1; i >= 0; --i) {
+                            spv::Id size = builder.makeIntConstant(arraySizes->getDimSize(i));
+                            typeId = builder.makeArrayType(typeId, size, 0);
+                        }
+                    }
+                    debugInfo.debugTypeOverride = builder.getDebugType(typeId);
+                }
+
+                memberDebugInfo.push_back(debugInfo);
             }
         }
     }

SPIRV/SpvBuilder.cpp

@@ -420,7 +420,7 @@ Id Builder::makeFloatE4M3Type()
 // needed as the result of some instructions, which does
 // check for duplicates.
 // For compiler-generated structs, debug info is ignored.
-Id Builder::makeStructType(const std::vector<Id>& members, const std::vector<spv::DebugTypeLoc>& memberDebugInfo,
+Id Builder::makeStructType(const std::vector<Id>& members, const std::vector<spv::StructMemberDebugInfo>& memberDebugInfo,
                            const char* name, bool const compilerGenerated)
 {
     // Don't look for previous one, because in the general case,
@@ -1156,7 +1156,7 @@ Id Builder::makeMatrixDebugType(Id const vectorType, int const vectorCount, bool
     return type->getResultId();
 }
 
-Id Builder::makeMemberDebugType(Id const memberType, DebugTypeLoc const& debugTypeLoc)
+Id Builder::makeMemberDebugType(Id const memberType, StructMemberDebugInfo const& debugTypeLoc)
 {
     assert(debugId[memberType] != 0);
 
@@ -1165,12 +1165,13 @@ Id Builder::makeMemberDebugType(Id const memberType, DebugTypeLoc const& debugTy
     type->addIdOperand(nonSemanticShaderDebugInfo);
     type->addImmediateOperand(NonSemanticShaderDebugInfo100DebugTypeMember);
     type->addIdOperand(getStringId(debugTypeLoc.name)); // name id
-    type->addIdOperand(debugId[memberType]); // type id
-    type->addIdOperand(makeDebugSource(currentFileId)); // source id
-    type->addIdOperand(makeUintConstant(debugTypeLoc.line)); // line id TODO: currentLine is always zero
+    type->addIdOperand(debugTypeLoc.debugTypeOverride != 0 ? debugTypeLoc.debugTypeOverride
+                                                           : debugId[memberType]); // type id
+    type->addIdOperand(makeDebugSource(currentFileId));                            // source id
+    type->addIdOperand(makeUintConstant(debugTypeLoc.line));   // line id TODO: currentLine is always zero
     type->addIdOperand(makeUintConstant(debugTypeLoc.column)); // TODO: column id
-    type->addIdOperand(makeUintConstant(0)); // TODO: offset id
-    type->addIdOperand(makeUintConstant(0)); // TODO: size id
+    type->addIdOperand(makeUintConstant(0));                   // TODO: offset id
+    type->addIdOperand(makeUintConstant(0));                   // TODO: size id
     type->addIdOperand(makeUintConstant(NonSemanticShaderDebugInfo100FlagIsPublic)); // flags id
 
     groupedDebugTypes[NonSemanticShaderDebugInfo100DebugTypeMember].push_back(type);
@@ -1180,7 +1181,7 @@ Id Builder::makeMemberDebugType(Id const memberType, DebugTypeLoc const& debugTy
     return type->getResultId();
 }
 
-Id Builder::makeCompositeDebugType(std::vector<Id> const& memberTypes, std::vector<DebugTypeLoc> const& memberDebugInfo,
+Id Builder::makeCompositeDebugType(std::vector<Id> const& memberTypes, std::vector<StructMemberDebugInfo> const& memberDebugInfo,
                                    char const* const name, NonSemanticShaderDebugInfo100DebugCompositeType const tag)
 {
     // Create the debug member types.

SPIRV/SpvBuilder.h

@@ -82,10 +82,12 @@ typedef enum {
     Spv_1_6 = (1 << 16) | (6 << 8),
 } SpvVersion;
 
-struct DebugTypeLoc {
+struct StructMemberDebugInfo {
     std::string name {};
     int line {0};
     int column {0};
+    // Set if the caller knows a better debug type than what is associated with the functional SPIR-V type.
+    spv::Id debugTypeOverride {0};
 };
 
 class Builder {
@@ -204,6 +206,14 @@ class Builder {
         return id;
     }
 
+    // Maps the given OpType Id to a Non-Semantic DebugType Id.
+    Id getDebugType(Id type) {
+        if (emitNonSemanticShaderDebugInfo) {
+            return debugId[type];
+        }
+        return 0;
+    }
+
     // For creating new types (will return old type if the requested one was already made).
     Id makeVoidType();
     Id makeBoolType();
@@ -217,7 +227,7 @@ class Builder {
     Id makeBFloat16Type();
     Id makeFloatE5M2Type();
     Id makeFloatE4M3Type();
-    Id makeStructType(const std::vector<Id>& members, const std::vector<spv::DebugTypeLoc>& memberDebugInfo,
+    Id makeStructType(const std::vector<Id>& members, const std::vector<spv::StructMemberDebugInfo>& memberDebugInfo,
                       const char* name, bool const compilerGenerated = true);
     Id makeStructResultType(Id type0, Id type1);
     Id makeVectorType(Id component, int size);
@@ -244,8 +254,8 @@ class Builder {
     Id makeArrayDebugType(Id const baseType, Id const componentCount);
     Id makeVectorDebugType(Id const baseType, int const componentCount);
     Id makeMatrixDebugType(Id const vectorType, int const vectorCount, bool columnMajor = true);
-    Id makeMemberDebugType(Id const memberType, DebugTypeLoc const& debugTypeLoc);
-    Id makeCompositeDebugType(std::vector<Id> const& memberTypes, std::vector<DebugTypeLoc> const& memberDebugInfo,
+    Id makeMemberDebugType(Id const memberType, StructMemberDebugInfo const& debugTypeLoc);
+    Id makeCompositeDebugType(std::vector<Id> const& memberTypes, std::vector<StructMemberDebugInfo> const& memberDebugInfo,
                               char const* const name, NonSemanticShaderDebugInfo100DebugCompositeType const tag);
     Id makeOpaqueDebugType(char const* const name);
     Id makePointerDebugType(StorageClass storageClass, Id const baseType);