DBG: fix missing module name in symbol log and implement source mapping

Author: mrexodia

src/dbg/symbolinfo.cpp

@@ -12,6 +12,7 @@
 #include "dbghelp_safe.h"
 #include "exception.h"
 #include "WinInet-Downloader/downslib.h"
+#include <shlwapi.h>
 
 struct SYMBOLCBDATA
 {
@@ -377,8 +378,39 @@ bool SymGetSourceLine(duint Cip, char* FileName, int* Line, DWORD* disp)
         *Line = lineInfo.lineNumber;
 
     if(FileName)
+    {
         strncpy_s(FileName, MAX_STRING_SIZE, lineInfo.sourceFile.c_str(), _TRUNCATE);
 
+        // Check if it was a full path
+        if(!PathIsRelativeW(StringUtils::Utf8ToUtf16(lineInfo.sourceFile).c_str()))
+            return true;
+
+        // Construct full path from pdb path
+        {
+            SHARED_ACQUIRE(LockModules);
+            MODINFO* info = ModInfoFromAddr(Cip);
+            if(!info)
+                return true;
+
+            String sourceFilePath = info->symbols->loadedSymbolPath();
+
+            // Strip the name, leaving only the file directory
+            size_t bslash = sourceFilePath.rfind('\\');
+            if(bslash != String::npos)
+                sourceFilePath.resize(bslash + 1);
+            sourceFilePath += lineInfo.sourceFile;
+
+            // Attempt to remap the source file if it exists (more heuristics could be added in the future)
+            if(FileExists(sourceFilePath.c_str()))
+            {
+                if(info->symbols->mapSourceFilePdbToDisk(lineInfo.sourceFile, sourceFilePath))
+                {
+                    strncpy_s(FileName, MAX_STRING_SIZE, sourceFilePath.c_str(), _TRUNCATE);
+                }
+            }
+        }
+    }
+
     return true;
 }
 

src/dbg/symbolsourcebase.cpp

@@ -0,0 +1,59 @@
+#include "symbolsourcebase.h"
+#include <algorithm>
+
+bool SymbolSourceBase::mapSourceFilePdbToDisk(const std::string & pdb, const std::string & disk)
+{
+    std::string pdblower = pdb, disklower = disk;
+    std::transform(pdblower.begin(), pdblower.end(), pdblower.begin(), tolower);
+    std::transform(disklower.begin(), disklower.end(), disklower.begin(), tolower);
+
+    // Abort if the disk file doesn't exist
+    if(!FileExists(disklower.c_str()))
+        return false;
+
+    // Remove existing mapping if found
+    auto found = _sourceFileMapPdbToDisk.find(pdblower);
+    if(found != _sourceFileMapPdbToDisk.end())
+    {
+        // Abort if there is already an existing mapping for the destination (we want 1 to 1 mapping)
+        // Done here because we can avoid corrupting the state
+        if(disklower != found->second && _sourceFileMapDiskToPdb.count(disklower))
+            return false;
+
+        // Remove existing mapping
+        _sourceFileMapDiskToPdb.erase(found->second);
+        _sourceFileMapPdbToDisk.erase(found);
+    }
+    // Abort if there is already an existing mapping for the destination (we want 1 to 1 mapping)
+    else if(_sourceFileMapDiskToPdb.count(disklower))
+    {
+        return false;
+    }
+
+    // Insert destinations
+    _sourceFileMapPdbToDisk.insert({ pdblower, disk });
+    _sourceFileMapDiskToPdb.insert({ disklower, pdb });
+    return true;
+}
+
+bool SymbolSourceBase::getSourceFileDiskToPdb(const std::string & disk, std::string & pdb) const
+{
+    std::string disklower = disk;
+    std::transform(disklower.begin(), disklower.end(), disklower.begin(), tolower);
+    auto found = _sourceFileMapDiskToPdb.find(disklower);
+    if(found == _sourceFileMapDiskToPdb.end())
+        return false;
+    pdb = found->second;
+    return true;
+}
+
+bool SymbolSourceBase::getSourceFilePdbToDisk(const std::string & pdb, std::string & disk) const
+{
+    std::string pdblower = pdb;
+    std::transform(pdblower.begin(), pdblower.end(), pdblower.begin(), tolower);
+    auto found = _sourceFileMapPdbToDisk.find(pdblower);
+    if(found == _sourceFileMapPdbToDisk.end())
+        return false;
+    disk = found->second;
+    return true;
+}

src/dbg/symbolsourcebase.h

@@ -6,6 +6,7 @@
 #include <stdint.h>
 #include <vector>
 #include <functional>
+#include <map>
 
 struct SymbolInfoGui
 {
@@ -47,6 +48,8 @@ class SymbolSourceBase
 {
 private:
     std::vector<uint8_t> _symbolBitmap; // TODO: what is the maximum size for this?
+    std::map<std::string, std::string> _sourceFileMapPdbToDisk; // pdb source path -> disk source path
+    std::map<std::string, std::string> _sourceFileMapDiskToPdb; // disk source path -> pdb source path
 
 public:
     virtual ~SymbolSourceBase() = default;
@@ -129,6 +132,15 @@ class SymbolSourceBase
     {
         return false; // Stub
     }
+
+    virtual std::string loadedSymbolPath() const
+    {
+        return ""; // Stub
+    }
+
+    bool mapSourceFilePdbToDisk(const std::string & pdb, const std::string & disk);
+    bool getSourceFilePdbToDisk(const std::string & pdb, std::string & disk) const;
+    bool getSourceFileDiskToPdb(const std::string & disk, std::string & pdb) const;
 };
 
 static SymbolSourceBase EmptySymbolSource;

src/dbg/symbolsourcedia.cpp

@@ -51,6 +51,7 @@ bool SymbolSourceDIA::loadPDB(const std::string & path, const std::string & modn
     {
         _path = path;
         _imageSize = imageSize;
+        _modname = modname;
         _imageBase = imageBase;
         _requiresShutdown = false;
         _symbolsLoaded = false;
@@ -339,12 +340,17 @@ bool SymbolSourceDIA::loadSourceLinesAsync()
 
 uint32_t SymbolSourceDIA::findSourceFile(const std::string & fileName) const
 {
+    // Map the disk file name back to PDB file name
+    std::string mappedFileName;
+    if(!getSourceFileDiskToPdb(fileName, mappedFileName))
+        mappedFileName = fileName;
+
     //TODO: make this fast
     uint32_t idx = -1;
     for(uint32_t n = 0; n < _sourceFiles.size(); n++)
     {
         const String & str = _sourceFiles[n];
-        if(_stricmp(str.c_str(), fileName.c_str()) == 0)
+        if(_stricmp(str.c_str(), mappedFileName.c_str()) == 0)
         {
             idx = n;
             break;
@@ -436,6 +442,7 @@ bool SymbolSourceDIA::findSourceLineInfo(duint rva, LineInfo & lineInfo)
     lineInfo.disp = 0;
     lineInfo.size = 0;
     lineInfo.sourceFile = _sourceFiles[cached.sourceFileIdx];
+    getSourceFilePdbToDisk(lineInfo.sourceFile, lineInfo.sourceFile);
     return true;
 }
 
@@ -458,6 +465,7 @@ bool SymbolSourceDIA::findSourceLineInfo(const std::string & file, int line, Lin
     lineInfo.disp = 0;
     lineInfo.size = 0;
     lineInfo.sourceFile = _sourceFiles[cached.sourceFileIdx];
+    getSourceFilePdbToDisk(lineInfo.sourceFile, lineInfo.sourceFile);
     return true;
 }
 
@@ -541,3 +549,8 @@ bool SymbolSourceDIA::findSymbolsByPrefix(const std::string & prefix, const std:
 
     return result;
 }
+
+std::string SymbolSourceDIA::loadedSymbolPath() const
+{
+    return _path;
+}

src/dbg/symbolsourcedia.h

@@ -158,6 +158,8 @@ class SymbolSourceDIA : public SymbolSourceBase
 
     virtual bool findSymbolsByPrefix(const std::string & prefix, const std::function<bool(const SymbolInfo &)> & cbSymbol, bool caseSensitive) override;
 
+    virtual std::string loadedSymbolPath() const override;
+
 public:
     bool loadPDB(const std::string & path, const std::string & modname, duint imageBase, duint imageSize, DiaValidationData_t* validationData);
 

src/dbg/x64dbg_dbg.vcxproj

@@ -100,6 +100,7 @@
     <ClCompile Include="stringformat.cpp" />
     <ClCompile Include="stringutils.cpp" />
     <ClCompile Include="symbolinfo.cpp" />
+    <ClCompile Include="symbolsourcebase.cpp" />
     <ClCompile Include="symbolsourcedia.cpp" />
     <ClCompile Include="symcache.cpp" />
     <ClCompile Include="tcpconnections.cpp" />

src/dbg/x64dbg_dbg.vcxproj.filters

@@ -455,6 +455,9 @@
     <ClCompile Include="WinInet-Downloader\downslib.cpp">
       <Filter>Source Files\Third Party\WinInet-Downloader</Filter>
     </ClCompile>
+    <ClCompile Include="symbolsourcebase.cpp">
+      <Filter>Source Files\Symbols</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="dbghelp\dbghelp.h">