[llvm-pdbdump] Print a better error message when DIA fails to load a PDB

[thakis]

Thanks!

tools/llvm-pdbdump/llvm-pdbdump.cpp

630 ↗

(On Diff #54106)

Is that true? I thought I read somewhere that express doesn't include the dia SDK. Not sure though.

llvm/trunk/include/llvm/DebugInfo/PDB/PDBTypes.h

enum class PDB_RegisterId {
   R14 = 342,
   R15 = 343,
 };
 
 enum class PDB_MemberAccess { Private = 1, Protected = 2, Public = 3 };
 
 enum class PDB_ErrorCode {
   Success,
-  NoPdbImpl,
+  NoDiaSupport,
+  CouldNotCreateImpl,
   InvalidPath,
   InvalidFileFormat,
   InvalidParameter,
   AlreadyLoaded,
   UnknownError,
   NoMemory,
   DebugInfoMismatch
 };

llvm/trunk/lib/DebugInfo/PDB/DIA/DIASession.cpp

 #include "llvm/Support/ConvertUTF.h"
 
 #include <diacreate.h>
 
 using namespace llvm;
 
 namespace {
 
-bool LoadDIA(CComPtr<IDiaDataSource>& DiaDataSource) {
+PDB_ErrorCode LoadDIA(CComPtr<IDiaDataSource> &DiaDataSource) {
   if (SUCCEEDED(CoCreateInstance(CLSID_DiaSource, nullptr, CLSCTX_INPROC_SERVER,
                                  IID_IDiaDataSource,
                                  reinterpret_cast<LPVOID *>(&DiaDataSource))))
-    return true;
+    return PDB_ErrorCode::Success;
 
   // If the CoCreateInstance call above failed, msdia*.dll is not registered.
   // Try loading the DLL corresponding to the #included DIA SDK.
 #if !defined(_MSC_VER)
-  return false;
-#else
+  return PDB_ErrorCode::NoDiaSupport;
+#endif
+
   const wchar_t *msdia_dll = nullptr;
 #if _MSC_VER == 1900
   msdia_dll = L"msdia140.dll"; // VS2015
 #elif _MSC_VER == 1800
   msdia_dll = L"msdia120.dll"; // VS2013
 #else
 #error "Unknown Visual Studio version."
 #endif
-  return msdia_dll &&
-         SUCCEEDED(NoRegCoCreate(msdia_dll, CLSID_DiaSource, IID_IDiaDataSource,
-                                 reinterpret_cast<LPVOID *>(&DiaDataSource)));
-#endif
+
+  if (SUCCEEDED(NoRegCoCreate(msdia_dll, CLSID_DiaSource, IID_IDiaDataSource,
+                              reinterpret_cast<LPVOID *>(&DiaDataSource))))
+    return PDB_ErrorCode::Success;
+  else
+    return PDB_ErrorCode::CouldNotCreateImpl;
 }
 
 }
 
 DIASession::DIASession(CComPtr<IDiaSession> DiaSession) : Session(DiaSession) {}
 
 PDB_ErrorCode DIASession::createFromPdb(StringRef Path,
                                         std::unique_ptr<IPDBSession> &Session) {
   CComPtr<IDiaDataSource> DiaDataSource;
   CComPtr<IDiaSession> DiaSession;
 
   // We assume that CoInitializeEx has already been called by the executable.
-  if (!LoadDIA(DiaDataSource))
-    return PDB_ErrorCode::NoPdbImpl;
+  PDB_ErrorCode result = LoadDIA(DiaDataSource);
+  if (result != PDB_ErrorCode::Success)
+    return result;
 
   llvm::SmallVector<UTF16, 128> Path16;
   if (!llvm::convertUTF8ToUTF16String(Path, Path16))
     return PDB_ErrorCode::InvalidPath;
 
   const wchar_t *Path16Str = reinterpret_cast<const wchar_t*>(Path16.data());
   HRESULT Result;
   if (FAILED(Result = DiaDataSource->loadDataFromPdb(Path16Str))) {

 }
 
 PDB_ErrorCode DIASession::createFromExe(StringRef Path,
                                         std::unique_ptr<IPDBSession> &Session) {
   CComPtr<IDiaDataSource> DiaDataSource;
   CComPtr<IDiaSession> DiaSession;
 
   // We assume that CoInitializeEx has already been called by the executable.
-  if (!LoadDIA(DiaDataSource))
-    return PDB_ErrorCode::NoPdbImpl;
+  PDB_ErrorCode result = LoadDIA(DiaDataSource);
+  if (result != PDB_ErrorCode::Success)
+    return result;
 
   llvm::SmallVector<UTF16, 128> Path16;
   if (!llvm::convertUTF8ToUTF16String(Path, Path16))
     return PDB_ErrorCode::InvalidPath;
 
   const wchar_t *Path16Str = reinterpret_cast<const wchar_t *>(Path16.data());
   HRESULT Result;
   if (FAILED(Result =

llvm/trunk/lib/DebugInfo/PDB/PDB.cpp

 using namespace llvm;
 
 PDB_ErrorCode llvm::loadDataForPDB(PDB_ReaderType Type, StringRef Path,
                                    std::unique_ptr<IPDBSession> &Session) {
   // Create the correct concrete instance type based on the value of Type.
 #if HAVE_DIA_SDK
   return DIASession::createFromPdb(Path, Session);
 #endif
-  return PDB_ErrorCode::NoPdbImpl;
+  return PDB_ErrorCode::NoDiaSupport;
 }
 
 PDB_ErrorCode llvm::loadDataForEXE(PDB_ReaderType Type, StringRef Path,
                                    std::unique_ptr<IPDBSession> &Session) {
   // Create the correct concrete instance type based on the value of Type.
 #if HAVE_DIA_SDK
   return DIASession::createFromExe(Path, Session);
 #endif
-  return PDB_ErrorCode::NoPdbImpl;
+  return PDB_ErrorCode::NoDiaSupport;
 }

llvm/trunk/tools/llvm-pdbdump/llvm-pdbdump.cpp

if (opts::DumpHeaders || !opts::DumpStreamData.empty()) {
     return;
   }
 
   std::unique_ptr<IPDBSession> Session;
   PDB_ErrorCode Error = loadDataForPDB(PDB_ReaderType::DIA, Path, Session);
   switch (Error) {
   case PDB_ErrorCode::Success:
     break;
-  case PDB_ErrorCode::NoPdbImpl:
-    outs() << "Reading PDBs is not supported on this platform.\n";
+  case PDB_ErrorCode::NoDiaSupport:
+    outs() << "LLVM was not compiled with support for DIA.  This usually means "
+              "that either LLVM was not compiled with MSVC, or your MSVC "
+              "installation is corrupt.\n";
+    return;
+  case PDB_ErrorCode::CouldNotCreateImpl:
+    outs() << "Failed to connect to DIA at runtime.  Verify that Visual Studio "
+              "is properly installed, or that msdiaXX.dll is in your PATH.\n";
     return;
   case PDB_ErrorCode::InvalidPath:
     outs() << "Unable to load PDB at '" << Path
            << "'.  Check that the file exists and is readable.\n";
     return;
   case PDB_ErrorCode::InvalidFileFormat:
     outs() << "Unable to load PDB at '" << Path
            << "'.  The file has an unrecognized format.\n";