DIModule SPIRV extension (part 3)

DIModule SPIRV extension (part 3), added debug info emission of Imported Entity

Author: mtargows

IGC/AdaptorOCL/SPIRV/SPIRVReader.cpp

@@ -1089,6 +1089,24 @@ class SPIRVToLLVMDbgTran {
       return addMDNode(inst, createLocation(line, 0, scope, iat));
   }
 
+  // Encode a line number, a file name and a directory to a string, where a line no., file name
+  // and directory are separated by '?' character: lineNumber?fileName?directory
+  // There is a workaround for DIModule creation in earlier LLVM versions, where a line and a file
+  // parameters are not supported in DIBuilder.
+  void encodeLineAndFileForISysRoot(unsigned int line, llvm::DIFile* file, std::string& lineAndFile)
+  {
+#if LLVM_VERSION_MAJOR < 11
+      lineAndFile.append(std::to_string(line));
+      lineAndFile.append("?");
+      if (file)
+      {
+          lineAndFile.append(file->getDirectory().str());
+          lineAndFile.append("?");
+          lineAndFile.append(file->getFilename().str());
+      }
+#endif  // LLVM_VERSION_MAJOR < 11.
+  }
+
   DIModule* createModuleINTEL(SPIRVExtInst* inst)
   {
       if (auto n = getExistingNode<DIModule*>(inst))
@@ -1100,28 +1118,21 @@ class SPIRVToLLVMDbgTran {
       auto& name = BM->get<SPIRVString>(moduleINTEL.getName())->getStr();
       auto cfgMacros = BM->get<SPIRVString>(moduleINTEL.getConfigurationMacros())->getStr();
       auto inclPath = BM->get<SPIRVString>(moduleINTEL.getIncludePath())->getStr();
-
-      DIModule* diModule;
-
-#if LLVM_VERSION_MAJOR <= 10
-      llvm::StringRef iSysRoot = StringRef();  // Empty string
-      diModule = addMDNode(inst, Builder.createModule(scope, name, cfgMacros, inclPath, iSysRoot));
-#else  // LLVM_VERSION_MAJOR >= 11
       auto file = getDIFile(BM->get<SPIRVExtInst>(moduleINTEL.getSource()));
       auto line = moduleINTEL.getLine();
       auto apiNotesFile = BM->get<SPIRVString>(moduleINTEL.getAPINotesFile())->getStr();
-#if LLVM_VERSION_MAJOR == 11
-      diModule = addMDNode(inst, Builder.createModule(scope, name, cfgMacros, inclPath, apiNotesFile, file, line));
-#elif LLVM_VERSION_MAJOR >= 12
       bool isDecl = moduleINTEL.getIsDecl() ? true : false;
-      diModule = addMDNode(inst, Builder.createModule(scope, name, cfgMacros, inclPath, apiNotesFile, file, line, isDecl));
-#endif
-#endif  // LLVM_VERSION_MAJOR >= 11.
+
+      std::string encodedLineAndFile = "";
+      encodeLineAndFileForISysRoot(line, file, encodedLineAndFile);
+      llvm::StringRef iSysRoot = StringRef(encodedLineAndFile);
+
+      DIModule* diModule = addMDNode(inst, Builder.createModule(scope, name, cfgMacros, inclPath, apiNotesFile, file, line, isDecl, iSysRoot));
 
       return diModule;
   }
 
-  DINode* createImportedEntity(SPIRVExtInst* inst)
+  DINode* createImportedEntity(SPIRVExtInst* inst, SmallVector<TrackingMDNodeRef, 4>& allImportedModules)
   {
       if (auto n = getExistingNode<DINode*>(inst))
           return n;
@@ -1137,8 +1148,20 @@ class SPIRVToLLVMDbgTran {
 
       if (BM->get<SPIRVExtInst>(entity)->getExtOp() == OCLExtOpDbgKind::ModuleINTEL)
       {
-          auto diModule = createModuleINTEL(BM->get<SPIRVExtInst>(entity));
-          diNode = addMDNode(inst, Builder.createImportedModule(scope, diModule, file, line));
+          auto* diModule = createModuleINTEL(BM->get<SPIRVExtInst>(entity));
+          IGC_ASSERT(diModule);
+          DIImportedEntity* IE = Builder.createImportedModule(scope, diModule, file, line);
+          diNode = addMDNode(inst, IE);
+
+          IGC_ASSERT_MESSAGE(scope, "Invalid Scope encoding!");
+          if (isa<DILocalScope>(scope))
+          {
+              allImportedModules.emplace_back(IE);
+          }
+          else
+          {
+              // TODO? ReplaceImportedEntities = true;
+          }
       }
 
       return diNode;
@@ -1311,12 +1334,20 @@ class SPIRVToLLVMDbgTran {
       if (!Enable)
           return;
 
+      DICompileUnit* CU = getCompileUnit();
+
       auto importedEntities = BM->getImportedEntities();
 
+      SmallVector<TrackingMDNodeRef, 4> AllImportedModules;
       for (auto& importedEntity : importedEntities)
-      {
-          (void)createImportedEntity(importedEntity);
-      }
+          (void)createImportedEntity(importedEntity, AllImportedModules);
+
+
+      if (!AllImportedModules.empty())
+          CU->replaceImportedEntities(
+              MDTuple::get(CU->getContext(), SmallVector<Metadata*, 16>(AllImportedModules.begin(), AllImportedModules.end())));
+      else
+          CU->replaceImportedEntities(nullptr);  // If there were no local scope imported entities, we can map the whole list to nullptr.
   }
 
   void transDbgInfo(SPIRVValue *SV, Value *V);

IGC/DebugInfo/DwarfCompileUnit.cpp

@@ -203,7 +203,7 @@ int64_t CompileUnit::getDefaultLowerBound() const
 }
 
 /// Check whether the DIE for this MDNode can be shared across CUs.
-static bool isShareableAcrossCUs(llvm::MDNode* D)
+static bool isShareableAcrossCUs(const llvm::MDNode* D)
 {
     // When the MDNode can be part of the type system, the DIE can be
     // shared across CUs.
@@ -440,6 +440,20 @@ void CompileUnit::addSourceLine(DIE* Die, DIScope* S, unsigned Line)
     addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
 }
 
+/// addSourceLine - Add location information to specified debug information
+/// entry.
+void CompileUnit::addSourceLine(DIE* Die, DIImportedEntity* IE, unsigned Line)
+{
+    // If the line number is 0, don't add it.
+    if (Line == 0)
+        return;
+
+    unsigned FileID = DD->getOrCreateSourceID(IE->getFile()->getFilename(), IE->getFile()->getDirectory(), getUniqueID());
+    IGC_ASSERT_MESSAGE(FileID, "Invalid file id");
+    addUInt(Die, dwarf::DW_AT_decl_file, None, FileID);
+    addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
+}
+
 /// addSourceLine - Add location information to specified debug information
 /// entry.
 void CompileUnit::addSourceLine(DIE* Die, DIVariable* V)
@@ -736,7 +750,6 @@ IGC::DIE* CompileUnit::getOrCreateContextDIE(DIScope* Context)
         return getOrCreateModuleDIE(MD);
 
     return getDIE(Context);
-
 }
 
 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
@@ -1658,6 +1671,27 @@ std::string CompileUnit::getParentContextString(DIScope* Context) const
     return CS;
 }
 
+// Decode line number, file name and location from a string, where a line no., file name
+// and directory are separated by '?' character: lineNumber?fileName?directory
+// There is a workaround for DIModule creation in earlier LLVM versions, where a line and a file
+// parameters are not supported in DIBuilder.
+void CompileUnit::decodeLineAndFileForISysRoot(StringRef& lineAndFile, unsigned int* line, std::string* file,
+    std::string* directory)
+{
+#if LLVM_VERSION_MAJOR < 11
+    SmallVector<StringRef, 8> splitStr;
+    lineAndFile.split(splitStr, "?");//   substr(0, posOfLineAndDirSeparator).str().copy()
+    unsigned int posOfFirstQ = lineAndFile.find_first_of('?', 0);
+    std::string lineStr = "";
+    lineStr.append(splitStr[0].str().c_str(), posOfFirstQ);
+    unsigned int posOfSecondQ = lineAndFile.find_first_of('?', posOfFirstQ + 1);
+
+    directory->append(splitStr[1].str().c_str(), posOfSecondQ - posOfFirstQ);
+    file->append(splitStr[2].str().c_str(), splitStr[2].size());
+    *line = (unsigned int)std::atoi(splitStr[0].data());
+#endif // LLVM_VERSION_MAJOR < 11
+}
+
 /// constructTypeDIE - Construct basic type die from DIBasicType.
 void CompileUnit::constructTypeDIE(DIE& Buffer, DIBasicType* BTy)
 {
@@ -2013,6 +2047,42 @@ void CompileUnit::constructTemplateValueParameterDIE(
 }
 
 
+/// constructImportedEntityDIE - Create a DIE for DIImportedEntity.
+IGC::DIE* CompileUnit::constructImportedEntityDIE(
+    DIImportedEntity* Module)
+{
+    DINode* Entity = Module->getEntity();
+    if (auto* GV = dyn_cast<DIGlobalVariable>(Entity))
+        return nullptr;  // Missing support for imported entity linked to a global variable
+
+    DIE* IMDie = new DIE(Module->getTag());
+    insertDIE(Module, IMDie);
+
+    DIE* EntityDie;
+    if (auto* NS = dyn_cast<DINamespace>(Entity))
+        EntityDie = getOrCreateNameSpace(NS);
+    else if (auto* M = dyn_cast<DIModule>(Entity))
+        EntityDie = getOrCreateModuleDIE(M);
+    else if (auto* SP = dyn_cast<DISubprogram>(Entity))
+        EntityDie = getOrCreateSubprogramDIE(SP);
+    else if (auto* T = dyn_cast<DIType>(Entity))
+        EntityDie = getOrCreateTypeDIE(T);
+    //else if (auto* GV = dyn_cast<DIGlobalVariable>(Entity))  // TODO missing support
+    //    EntityDie = getOrCreateGlobalVariableDIE(GV, {});
+    else
+        EntityDie = getDIE(Entity);
+
+    assert(EntityDie);
+
+    addSourceLine(IMDie, Module, Module->getLine());
+    addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
+    StringRef Name = Module->getName();
+    if (!Name.empty())
+        addString(IMDie, dwarf::DW_AT_name, Name);
+
+    return IMDie;
+}
+
 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
 IGC::DIE* CompileUnit::getOrCreateNameSpace(DINamespace* NS)
 {
@@ -2145,6 +2215,8 @@ IGC::DIE* CompileUnit::getOrCreateSubprogramDIE(DISubprogram* SP)
         {
             DIE* Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, *SPDie);
             DIType* ATy = resolve(Args[i]);
+            if (!ATy)
+                continue;
             addType(Arg, ATy);
             if (ATy->isArtificial())
             {
@@ -2176,10 +2248,58 @@ IGC::DIE* CompileUnit::getOrCreateModuleDIE(DIModule* MD)
     // Construct the context before querying for the existence of the DIE in case
     // such construction creates the DIE (as is the case for member function
     // declarations).
+    DIE* ContextDIE = getOrCreateContextDIE(MD->getScope());
+    DIE* MDDie = getDIE(MD);
+    if (MDDie)
+        return MDDie;
+
+    MDDie = createAndAddDIE(dwarf::DW_TAG_module, *ContextDIE, MD);
+    IGC_ASSERT(MDDie);
+
+    if (!MD->getName().empty())
+    {
+        addString(MDDie, dwarf::DW_AT_name, MD->getName());
+    }
+
+#if LLVM_VERSION_MAJOR < 11
+#if LLVM_VERSION_MAJOR < 10
+    StringRef iSysRoot = MD->getISysRoot();
+#else // LLVM_VERSION_MAJOR == 10
+    StringRef iSysRoot = MD->getSysRoot();
+#endif // LLVM_VERSION_MAJOR == 10
+    unsigned int line;
+    std::string file = "";
+    std::string directory = "";
+
+    decodeLineAndFileForISysRoot(iSysRoot, &line, &file, &directory);
 
-    IGC_ASSERT_MESSAGE(false, "Missing implementation for DIModule!");
+    // Emit a line number and a file only if line number is significant
+    if (line > 0)
+        addUInt(MDDie, dwarf::DW_AT_decl_line, None, line);
+    // Emit a file if not empty name
+    if (!file.empty() || !directory.empty())
+    {
+        StringRef fileRef(file);
+        StringRef dirRef(directory);
+        unsigned FileID = DD->getOrCreateSourceID(fileRef, dirRef, getUniqueID());
+        addUInt(MDDie, dwarf::DW_AT_decl_file, None, FileID);
+    }
+#else // LLVM_VERSION_MAJOR >= 11
+#if LLVM_VERSION_MAJOR == 11
+    addSourceLine(MDDie, MD, MD->getLineNo());
+#elif LLVM_VERSION_MAJOR >= 12
+    if (!MD->getIsDecl())
+    {
+        addSourceLine(MDDie, MD, MD->getLineNo());
+    }
+    else
+    {
+        addFlag(MDDie, dwarf::DW_AT_declaration);
+    }
+#endif // LLVM_VERSION_MAJOR >= 12
+#endif // LLVM_VERSION_MAJOR >= 11.
 
-    return nullptr;
+    return MDDie;
 }
 
 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.

IGC/DebugInfo/DwarfCompileUnit.hpp

@@ -22,9 +22,11 @@ See LICENSE.TXT for details.
 #include "llvm/Config/llvm-config.h"
 
 #include "common/LLVMWarningsPush.hpp"
-#include "llvm/ADT/DenseMap.h"
 #include "llvm/ADT/Optional.h"
+#include "llvm/ADT/DenseMap.h"
+#include "llvm/ADT/SmallVector.h"
 #include "llvm/ADT/StringMap.h"
+#include "llvm/ADT/StringRef.h"
 #include "llvm/IR/DebugInfo.h"
 #include "llvm/IR/GlobalValue.h"
 #include "common/LLVMWarningsPop.hpp"
@@ -102,6 +104,11 @@ namespace IGC
             StreamEmitter* A, IGC::DwarfDebug* DW);
         ~CompileUnit();
 
+        using ImportedEntityList = llvm::SmallVector<const llvm::MDNode*, 8>;
+        using ImportedEntityMap = llvm::DenseMap<const llvm::MDNode*, ImportedEntityList>;
+
+        ImportedEntityMap ImportedEntities;
+
         // Accessors.
         unsigned getUniqueID() const { return UniqueID; }
         uint16_t getLanguage() const { return (uint16_t)Node->getSourceLanguage(); }
@@ -205,6 +212,7 @@ namespace IGC
         /// addSourceLine - Add location information to specified debug information
         /// entry.
         void addSourceLine(DIE* Die, llvm::DIScope* S, unsigned Line);
+        void addSourceLine(DIE* Die, llvm::DIImportedEntity* IE, unsigned Line);
         void addSourceLine(DIE* Die, llvm::DIVariable* V);
         void addSourceLine(DIE* Die, llvm::DISubprogram* SP);
         void addSourceLine(DIE* Die, llvm::DIType* Ty);
@@ -298,6 +306,16 @@ namespace IGC
                                     const DbgDecoder::LiveIntervalsVISA& lr,
                                     uint64_t varSizeInBits, uint64_t offsetInBits);
 
+        // Decode line number, file name and location from a string, where a line no. and file name
+        // (including directory) are separated by '-' character: lineNumber-fileNameIncludingDirectory
+        // There is a workaround for DIModule creation in earlier LLVM versions, where a line and a file
+        // parameters are not supported in DIBuilder.
+        void decodeLineAndFileForISysRoot(llvm::StringRef& lineAndFile, unsigned int* line, std::string* file,
+            std::string* directory);
+
+        /// Construct import_module DIE.
+        IGC::DIE* constructImportedEntityDIE(llvm::DIImportedEntity* Module);
+
         /// getOrCreateNameSpace - Create a DIE for DINameSpace.
         DIE* getOrCreateNameSpace(llvm::DINamespace* NS);
 
@@ -325,6 +343,20 @@ namespace IGC
         /// call insertDIE if MD is not null.
         DIE* createAndAddDIE(unsigned Tag, DIE& Parent, llvm::DINode* N = nullptr);
 
+        void addImportedEntity(const llvm::DIImportedEntity* IE)
+        {
+            llvm::DIScope* Scope = IE->getScope();
+            assert(Scope && "Invalid Scope encoding!");
+            if (!llvm::isa<llvm::DILocalScope>(Scope))
+            {
+                // No need to add imported enities that are not local declaration.
+                return;
+            }
+
+            auto* LocalScope = llvm::cast<llvm::DILocalScope>(Scope)->getNonLexicalBlockFileScope();
+            ImportedEntities[LocalScope].push_back(IE);
+        }
+
         /// Compute the size of a header for this unit, not including the initial
         /// length field.
         unsigned getHeaderSize() const