[DebugInfo] Common behavior for error types

Following D50807, and heading towards D50664, this intermediary change does the following:

1. Upgrade all custom Error types in llvm/trunk/lib/DebugInfo/ to use the new StringError behavior (D50807).
2. Implement std::is_error_code_enum and make_error_code() for DebugInfo error enumerations.
3. Rename GenericError -> PDBError (the file will be renamed in a subsequent commit)
4. Update custom error messages to follow the same formatting: (\w\s*)+\.
5. Keep generic "file not found" (ENOENT) errors as they are in PDB code. Previously, there used to be a custom enumeration for that purpose.
6. Remove a few extraneous LF in log() implementations. Printing LF is a responsability at a higher level, not at the error level.

Differential Revision: https://reviews.llvm.org/D51499

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@341228 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Alexandre Ganea 2018-08-31 17:41:58 +00:00
parent 3bdab0c31e
commit 0444f57668
24 changed files with 156 additions and 239 deletions

View File

@ -24,23 +24,32 @@ enum class cv_error_code {
no_records, no_records,
unknown_member_record, unknown_member_record,
}; };
} // namespace codeview
} // namespace llvm
namespace std {
template <>
struct is_error_code_enum<llvm::codeview::cv_error_code> : std::true_type {};
} // namespace std
namespace llvm {
namespace codeview {
const std::error_category &CVErrorCategory();
inline std::error_code make_error_code(cv_error_code E) {
return std::error_code(static_cast<int>(E), CVErrorCategory());
}
/// Base class for errors originating when parsing raw PDB files /// Base class for errors originating when parsing raw PDB files
class CodeViewError : public ErrorInfo<CodeViewError> { class CodeViewError : public ErrorInfo<CodeViewError, StringError> {
public: public:
using ErrorInfo<CodeViewError,
StringError>::ErrorInfo; // inherit constructors
CodeViewError(const Twine &S) : ErrorInfo(S, cv_error_code::unspecified) {}
static char ID; static char ID;
CodeViewError(cv_error_code C);
CodeViewError(const std::string &Context);
CodeViewError(cv_error_code C, const std::string &Context);
void log(raw_ostream &OS) const override;
const std::string &getErrorMessage() const;
std::error_code convertToErrorCode() const override;
private:
std::string ErrMsg;
cv_error_code Code;
}; };
}
} } // namespace codeview
} // namespace llvm
#endif #endif

View File

@ -24,22 +24,28 @@ enum class msf_error_code {
invalid_format, invalid_format,
block_in_use block_in_use
}; };
} // namespace msf
} // namespace llvm
namespace std {
template <>
struct is_error_code_enum<llvm::msf::msf_error_code> : std::true_type {};
} // namespace std
namespace llvm {
namespace msf {
const std::error_category &MSFErrCategory();
inline std::error_code make_error_code(msf_error_code E) {
return std::error_code(static_cast<int>(E), MSFErrCategory());
}
/// Base class for errors originating when parsing raw PDB files /// Base class for errors originating when parsing raw PDB files
class MSFError : public ErrorInfo<MSFError> { class MSFError : public ErrorInfo<MSFError, StringError> {
public: public:
using ErrorInfo<MSFError, StringError>::ErrorInfo; // inherit constructors
MSFError(const Twine &S) : ErrorInfo(S, msf_error_code::unspecified) {}
static char ID; static char ID;
MSFError(msf_error_code C);
MSFError(const std::string &Context);
MSFError(msf_error_code C, const std::string &Context);
void log(raw_ostream &OS) const override;
const std::string &getErrorMessage() const;
std::error_code convertToErrorCode() const override;
private:
std::string ErrMsg;
msf_error_code Code;
}; };
} // namespace msf } // namespace msf
} // namespace llvm } // namespace llvm

View File

@ -23,23 +23,29 @@ enum class dia_error_code {
already_loaded, already_loaded,
debug_info_mismatch, debug_info_mismatch,
}; };
} // namespace pdb
} // namespace llvm
namespace std {
template <>
struct is_error_code_enum<llvm::pdb::dia_error_code> : std::true_type {};
} // namespace std
namespace llvm {
namespace pdb {
const std::error_category &DIAErrCategory();
inline std::error_code make_error_code(dia_error_code E) {
return std::error_code(static_cast<int>(E), DIAErrCategory());
}
/// Base class for errors originating in DIA SDK, e.g. COM calls /// Base class for errors originating in DIA SDK, e.g. COM calls
class DIAError : public ErrorInfo<DIAError> { class DIAError : public ErrorInfo<DIAError, StringError> {
public: public:
using ErrorInfo<DIAError, StringError>::ErrorInfo;
DIAError(const Twine &S) : ErrorInfo(S, dia_error_code::unspecified) {}
static char ID; static char ID;
DIAError(dia_error_code C);
DIAError(StringRef Context);
DIAError(dia_error_code C, StringRef Context);
void log(raw_ostream &OS) const override;
StringRef getErrorMessage() const;
std::error_code convertToErrorCode() const override;
private:
std::string ErrMsg;
dia_error_code Code;
}; };
} } // namespace pdb
} } // namespace llvm
#endif #endif

View File

@ -16,29 +16,37 @@
namespace llvm { namespace llvm {
namespace pdb { namespace pdb {
enum class generic_error_code { enum class pdb_error_code {
invalid_path = 1, invalid_utf8_path = 1,
dia_sdk_not_present, dia_sdk_not_present,
dia_failed_loading,
signature_out_of_date,
type_server_not_found, type_server_not_found,
unspecified, unspecified,
}; };
} // namespace codeview
} // namespace llvm
namespace std {
template <>
struct is_error_code_enum<llvm::pdb::pdb_error_code> : std::true_type {};
} // namespace std
namespace llvm {
namespace pdb {
const std::error_category &PDBErrCategory();
inline std::error_code make_error_code(pdb_error_code E) {
return std::error_code(static_cast<int>(E), PDBErrCategory());
}
/// Base class for errors originating when parsing raw PDB files /// Base class for errors originating when parsing raw PDB files
class GenericError : public ErrorInfo<GenericError> { class PDBError : public ErrorInfo<PDBError, StringError> {
public: public:
using ErrorInfo<PDBError, StringError>::ErrorInfo; // inherit constructors
PDBError(const Twine &S) : ErrorInfo(S, pdb_error_code::unspecified) {}
static char ID; static char ID;
GenericError(generic_error_code C);
GenericError(StringRef Context);
GenericError(generic_error_code C, StringRef Context);
void log(raw_ostream &OS) const override;
StringRef getErrorMessage() const;
std::error_code convertToErrorCode() const override;
private:
std::string ErrMsg;
generic_error_code Code;
}; };
} } // namespace pdb
} } // namespace llvm
#endif #endif

View File

@ -31,23 +31,29 @@ enum class raw_error_code {
stream_too_long, stream_too_long,
invalid_tpi_hash, invalid_tpi_hash,
}; };
} // namespace pdb
} // namespace llvm
namespace std {
template <>
struct is_error_code_enum<llvm::pdb::raw_error_code> : std::true_type {};
} // namespace std
namespace llvm {
namespace pdb {
const std::error_category &RawErrCategory();
inline std::error_code make_error_code(raw_error_code E) {
return std::error_code(static_cast<int>(E), RawErrCategory());
}
/// Base class for errors originating when parsing raw PDB files /// Base class for errors originating when parsing raw PDB files
class RawError : public ErrorInfo<RawError> { class RawError : public ErrorInfo<RawError, StringError> {
public: public:
using ErrorInfo<RawError, StringError>::ErrorInfo; // inherit constructors
RawError(const Twine &S) : ErrorInfo(S, raw_error_code::unspecified) {}
static char ID; static char ID;
RawError(raw_error_code C);
RawError(const std::string &Context);
RawError(raw_error_code C, const std::string &Context);
void log(raw_ostream &OS) const override;
const std::string &getErrorMessage() const;
std::error_code convertToErrorCode() const override;
private:
std::string ErrMsg;
raw_error_code Code;
}; };
} } // namespace pdb
} } // namespace llvm
#endif #endif

View File

@ -14,25 +14,23 @@
using namespace llvm; using namespace llvm;
using namespace llvm::codeview; using namespace llvm::codeview;
namespace {
// FIXME: This class is only here to support the transition to llvm::Error. It // FIXME: This class is only here to support the transition to llvm::Error. It
// will be removed once this transition is complete. Clients should prefer to // will be removed once this transition is complete. Clients should prefer to
// deal with the Error value directly, rather than converting to error_code. // deal with the Error value directly, rather than converting to error_code.
class CodeViewErrorCategory : public std::error_category { class CodeViewErrorCategory : public std::error_category {
public: public:
const char *name() const noexcept override { return "llvm.codeview"; } const char *name() const noexcept override { return "llvm.codeview"; }
std::string message(int Condition) const override { std::string message(int Condition) const override {
switch (static_cast<cv_error_code>(Condition)) { switch (static_cast<cv_error_code>(Condition)) {
case cv_error_code::unspecified: case cv_error_code::unspecified:
return "An unknown error has occurred."; return "An unknown CodeView error has occurred.";
case cv_error_code::insufficient_buffer: case cv_error_code::insufficient_buffer:
return "The buffer is not large enough to read the requested number of " return "The buffer is not large enough to read the requested number of "
"bytes."; "bytes.";
case cv_error_code::corrupt_record: case cv_error_code::corrupt_record:
return "The CodeView record is corrupted."; return "The CodeView record is corrupted.";
case cv_error_code::no_records: case cv_error_code::no_records:
return "There are no records"; return "There are no records.";
case cv_error_code::operation_unsupported: case cv_error_code::operation_unsupported:
return "The requested operation is not supported."; return "The requested operation is not supported.";
case cv_error_code::unknown_member_record: case cv_error_code::unknown_member_record:
@ -41,31 +39,8 @@ public:
llvm_unreachable("Unrecognized cv_error_code"); llvm_unreachable("Unrecognized cv_error_code");
} }
}; };
} // end anonymous namespace
static ManagedStatic<CodeViewErrorCategory> Category; static llvm::ManagedStatic<CodeViewErrorCategory> CodeViewErrCategory;
const std::error_category &llvm::codeview::CVErrorCategory() { return *CodeViewErrCategory; }
char CodeViewError::ID = 0; char CodeViewError::ID;
CodeViewError::CodeViewError(cv_error_code C) : CodeViewError(C, "") {}
CodeViewError::CodeViewError(const std::string &Context)
: CodeViewError(cv_error_code::unspecified, Context) {}
CodeViewError::CodeViewError(cv_error_code C, const std::string &Context)
: Code(C) {
ErrMsg = "CodeView Error: ";
std::error_code EC = convertToErrorCode();
if (Code != cv_error_code::unspecified)
ErrMsg += EC.message() + " ";
if (!Context.empty())
ErrMsg += Context;
}
void CodeViewError::log(raw_ostream &OS) const { OS << ErrMsg << "\n"; }
const std::string &CodeViewError::getErrorMessage() const { return ErrMsg; }
std::error_code CodeViewError::convertToErrorCode() const {
return std::error_code(static_cast<int>(Code), *Category);
}

View File

@ -326,7 +326,7 @@ Error TypeStreamMerger::doit(const CVTypeArray &Types) {
"second pass found more bad indices"); "second pass found more bad indices");
if (!LastError && NumBadIndices == BadIndicesRemaining) { if (!LastError && NumBadIndices == BadIndicesRemaining) {
return llvm::make_error<CodeViewError>( return llvm::make_error<CodeViewError>(
cv_error_code::corrupt_record, "input type graph contains cycles"); cv_error_code::corrupt_record, "Input type graph contains cycles");
} }
} }

View File

@ -14,14 +14,12 @@
using namespace llvm; using namespace llvm;
using namespace llvm::msf; using namespace llvm::msf;
namespace {
// FIXME: This class is only here to support the transition to llvm::Error. It // FIXME: This class is only here to support the transition to llvm::Error. It
// will be removed once this transition is complete. Clients should prefer to // will be removed once this transition is complete. Clients should prefer to
// deal with the Error value directly, rather than converting to error_code. // deal with the Error value directly, rather than converting to error_code.
class MSFErrorCategory : public std::error_category { class MSFErrorCategory : public std::error_category {
public: public:
const char *name() const noexcept override { return "llvm.msf"; } const char *name() const noexcept override { return "llvm.msf"; }
std::string message(int Condition) const override { std::string message(int Condition) const override {
switch (static_cast<msf_error_code>(Condition)) { switch (static_cast<msf_error_code>(Condition)) {
case msf_error_code::unspecified: case msf_error_code::unspecified:
@ -41,30 +39,8 @@ public:
llvm_unreachable("Unrecognized msf_error_code"); llvm_unreachable("Unrecognized msf_error_code");
} }
}; };
} // end anonymous namespace
static ManagedStatic<MSFErrorCategory> Category; static llvm::ManagedStatic<MSFErrorCategory> MSFCategory;
const std::error_category &llvm::msf::MSFErrCategory() { return *MSFCategory; }
char MSFError::ID = 0; char MSFError::ID;
MSFError::MSFError(msf_error_code C) : MSFError(C, "") {}
MSFError::MSFError(const std::string &Context)
: MSFError(msf_error_code::unspecified, Context) {}
MSFError::MSFError(msf_error_code C, const std::string &Context) : Code(C) {
ErrMsg = "MSF Error: ";
std::error_code EC = convertToErrorCode();
if (Code != msf_error_code::unspecified)
ErrMsg += EC.message() + " ";
if (!Context.empty())
ErrMsg += Context;
}
void MSFError::log(raw_ostream &OS) const { OS << ErrMsg << "\n"; }
const std::string &MSFError::getErrorMessage() const { return ErrMsg; }
std::error_code MSFError::convertToErrorCode() const {
return std::error_code(static_cast<int>(Code), *Category);
}

View File

@ -11,14 +11,13 @@ using namespace llvm::pdb;
class DIAErrorCategory : public std::error_category { class DIAErrorCategory : public std::error_category {
public: public:
const char *name() const noexcept override { return "llvm.pdb.dia"; } const char *name() const noexcept override { return "llvm.pdb.dia"; }
std::string message(int Condition) const override { std::string message(int Condition) const override {
switch (static_cast<dia_error_code>(Condition)) { switch (static_cast<dia_error_code>(Condition)) {
case dia_error_code::could_not_create_impl: case dia_error_code::could_not_create_impl:
return "Failed to connect to DIA at runtime. Verify that Visual Studio " return "Failed to connect to DIA at runtime. Verify that Visual Studio "
"is properly installed, or that msdiaXX.dll is in your PATH."; "is properly installed, or that msdiaXX.dll is in your PATH.";
case dia_error_code::invalid_file_format: case dia_error_code::invalid_file_format:
return "Unable to load PDB. The file has an unrecognized format."; return "Unable to load PDB. The file has an unrecognized format.";
case dia_error_code::invalid_parameter: case dia_error_code::invalid_parameter:
return "The parameter is incorrect."; return "The parameter is incorrect.";
case dia_error_code::already_loaded: case dia_error_code::already_loaded:
@ -32,27 +31,7 @@ public:
} }
}; };
static ManagedStatic<DIAErrorCategory> Category; static llvm::ManagedStatic<DIAErrorCategory> DIACategory;
const std::error_category &llvm::pdb::DIAErrCategory() { return *DIACategory; }
char DIAError::ID = 0; char DIAError::ID;
DIAError::DIAError(dia_error_code C) : DIAError(C, "") {}
DIAError::DIAError(StringRef Context)
: DIAError(dia_error_code::unspecified, Context) {}
DIAError::DIAError(dia_error_code C, StringRef Context) : Code(C) {
ErrMsg = "DIA Error: ";
std::error_code EC = convertToErrorCode();
ErrMsg += EC.message() + " ";
if (!Context.empty())
ErrMsg += Context;
}
void DIAError::log(raw_ostream &OS) const { OS << ErrMsg << "\n"; }
StringRef DIAError::getErrorMessage() const { return ErrMsg; }
std::error_code DIAError::convertToErrorCode() const {
return std::error_code(static_cast<int>(Code), *Category);
}

View File

@ -42,7 +42,7 @@ static Error ErrorFromHResult(HRESULT Result, const char *Str, Ts &&... Args) {
switch (Result) { switch (Result) {
case E_PDB_NOT_FOUND: case E_PDB_NOT_FOUND:
return make_error<GenericError>(generic_error_code::invalid_path, Context); return errorCodeToError(std::error_code(ENOENT, std::generic_category()));
case E_PDB_FORMAT: case E_PDB_FORMAT:
return make_error<DIAError>(dia_error_code::invalid_file_format, Context); return make_error<DIAError>(dia_error_code::invalid_file_format, Context);
case E_INVALIDARG: case E_INVALIDARG:
@ -71,8 +71,7 @@ static Error LoadDIA(CComPtr<IDiaDataSource> &DiaDataSource) {
// If the CoCreateInstance call above failed, msdia*.dll is not registered. // If the CoCreateInstance call above failed, msdia*.dll is not registered.
// Try loading the DLL corresponding to the #included DIA SDK. // Try loading the DLL corresponding to the #included DIA SDK.
#if !defined(_MSC_VER) #if !defined(_MSC_VER)
return llvm::make_error<GenericError>( return llvm::make_error<PDBError>(pdb_error_code::dia_failed_loading);
"DIA is only supported when using MSVC.");
#else #else
const wchar_t *msdia_dll = nullptr; const wchar_t *msdia_dll = nullptr;
#if _MSC_VER >= 1900 && _MSC_VER < 2000 #if _MSC_VER >= 1900 && _MSC_VER < 2000
@ -104,7 +103,7 @@ Error DIASession::createFromPdb(StringRef Path,
llvm::SmallVector<UTF16, 128> Path16; llvm::SmallVector<UTF16, 128> Path16;
if (!llvm::convertUTF8ToUTF16String(Path, Path16)) if (!llvm::convertUTF8ToUTF16String(Path, Path16))
return make_error<GenericError>(generic_error_code::invalid_path); return make_error<PDBError>(pdb_error_code::invalid_utf8_path, Path);
const wchar_t *Path16Str = reinterpret_cast<const wchar_t *>(Path16.data()); const wchar_t *Path16Str = reinterpret_cast<const wchar_t *>(Path16.data());
HRESULT HR; HRESULT HR;
@ -130,7 +129,7 @@ Error DIASession::createFromExe(StringRef Path,
llvm::SmallVector<UTF16, 128> Path16; llvm::SmallVector<UTF16, 128> Path16;
if (!llvm::convertUTF8ToUTF16String(Path, Path16)) if (!llvm::convertUTF8ToUTF16String(Path, Path16))
return make_error<GenericError>(generic_error_code::invalid_path, Path); return make_error<PDBError>(pdb_error_code::invalid_utf8_path, Path);
const wchar_t *Path16Str = reinterpret_cast<const wchar_t *>(Path16.data()); const wchar_t *Path16Str = reinterpret_cast<const wchar_t *>(Path16.data());
HRESULT HR; HRESULT HR;

View File

@ -14,55 +14,34 @@
using namespace llvm; using namespace llvm;
using namespace llvm::pdb; using namespace llvm::pdb;
namespace {
// FIXME: This class is only here to support the transition to llvm::Error. It // FIXME: This class is only here to support the transition to llvm::Error. It
// will be removed once this transition is complete. Clients should prefer to // will be removed once this transition is complete. Clients should prefer to
// deal with the Error value directly, rather than converting to error_code. // deal with the Error value directly, rather than converting to error_code.
class GenericErrorCategory : public std::error_category { class PDBErrorCategory : public std::error_category {
public: public:
const char *name() const noexcept override { return "llvm.pdb"; } const char *name() const noexcept override { return "llvm.pdb"; }
std::string message(int Condition) const override { std::string message(int Condition) const override {
switch (static_cast<generic_error_code>(Condition)) { switch (static_cast<pdb_error_code>(Condition)) {
case generic_error_code::unspecified: case pdb_error_code::unspecified:
return "An unknown error has occurred."; return "An unknown error has occurred.";
case generic_error_code::type_server_not_found: case pdb_error_code::type_server_not_found:
return "Type server PDB was not found."; return "Type server PDB was not found.";
case generic_error_code::dia_sdk_not_present: case pdb_error_code::dia_sdk_not_present:
return "LLVM was not compiled with support for DIA. This usually means " return "LLVM was not compiled with support for DIA. This usually means "
"that you are not using MSVC, or your Visual Studio " "that you are not using MSVC, or your Visual Studio "
"installation " "installation is corrupt.";
"is corrupt."; case pdb_error_code::dia_failed_loading:
case generic_error_code::invalid_path: return "DIA is only supported when using MSVC.";
return "Unable to load PDB. Make sure the file exists and is readable."; case pdb_error_code::invalid_utf8_path:
return "The PDB file path is an invalid UTF8 sequence.";
case pdb_error_code::signature_out_of_date:
return "The signature does not match; the file(s) might be out of date";
} }
llvm_unreachable("Unrecognized generic_error_code"); llvm_unreachable("Unrecognized generic_error_code");
} }
}; };
} // end anonymous namespace
static ManagedStatic<GenericErrorCategory> Category; static llvm::ManagedStatic<PDBErrorCategory> PDBCategory;
const std::error_category &llvm::pdb::PDBErrCategory() { return *PDBCategory; }
char GenericError::ID = 0; char PDBError::ID;
GenericError::GenericError(generic_error_code C) : GenericError(C, "") {}
GenericError::GenericError(StringRef Context)
: GenericError(generic_error_code::unspecified, Context) {}
GenericError::GenericError(generic_error_code C, StringRef Context) : Code(C) {
ErrMsg = "PDB Error: ";
std::error_code EC = convertToErrorCode();
if (Code != generic_error_code::unspecified)
ErrMsg += EC.message() + " ";
if (!Context.empty())
ErrMsg += Context;
}
void GenericError::log(raw_ostream &OS) const { OS << ErrMsg << "\n"; }
StringRef GenericError::getErrorMessage() const { return ErrMsg; }
std::error_code GenericError::convertToErrorCode() const {
return std::error_code(static_cast<int>(Code), *Category);
}

View File

@ -11,7 +11,6 @@
#include "llvm/ADT/STLExtras.h" #include "llvm/ADT/STLExtras.h"
#include "llvm/DebugInfo/CodeView/TypeIndex.h" #include "llvm/DebugInfo/CodeView/TypeIndex.h"
#include "llvm/DebugInfo/PDB/GenericError.h"
#include "llvm/DebugInfo/PDB/IPDBEnumChildren.h" #include "llvm/DebugInfo/PDB/IPDBEnumChildren.h"
#include "llvm/DebugInfo/PDB/IPDBSourceFile.h" #include "llvm/DebugInfo/PDB/IPDBSourceFile.h"
#include "llvm/DebugInfo/PDB/Native/NativeBuiltinSymbol.h" #include "llvm/DebugInfo/PDB/Native/NativeBuiltinSymbol.h"

View File

@ -125,7 +125,7 @@ Error PDBFile::parseFileHeaders() {
if (auto EC = Reader.readObject(SB)) { if (auto EC = Reader.readObject(SB)) {
consumeError(std::move(EC)); consumeError(std::move(EC));
return make_error<RawError>(raw_error_code::corrupt_file, return make_error<RawError>(raw_error_code::corrupt_file,
"Does not contain superblock"); "MSF superblock is missing");
} }
if (auto EC = msf::validateSuperBlock(*SB)) if (auto EC = msf::validateSuperBlock(*SB))

View File

@ -12,7 +12,6 @@
#include "llvm/ADT/BitVector.h" #include "llvm/ADT/BitVector.h"
#include "llvm/DebugInfo/MSF/MSFBuilder.h" #include "llvm/DebugInfo/MSF/MSFBuilder.h"
#include "llvm/DebugInfo/PDB/GenericError.h"
#include "llvm/DebugInfo/PDB/Native/DbiStream.h" #include "llvm/DebugInfo/PDB/Native/DbiStream.h"
#include "llvm/DebugInfo/PDB/Native/DbiStreamBuilder.h" #include "llvm/DebugInfo/PDB/Native/DbiStreamBuilder.h"
#include "llvm/DebugInfo/PDB/Native/GSIStreamBuilder.h" #include "llvm/DebugInfo/PDB/Native/GSIStreamBuilder.h"

View File

@ -5,14 +5,12 @@
using namespace llvm; using namespace llvm;
using namespace llvm::pdb; using namespace llvm::pdb;
namespace {
// FIXME: This class is only here to support the transition to llvm::Error. It // FIXME: This class is only here to support the transition to llvm::Error. It
// will be removed once this transition is complete. Clients should prefer to // will be removed once this transition is complete. Clients should prefer to
// deal with the Error value directly, rather than converting to error_code. // deal with the Error value directly, rather than converting to error_code.
class RawErrorCategory : public std::error_category { class RawErrorCategory : public std::error_category {
public: public:
const char *name() const noexcept override { return "llvm.pdb.raw"; } const char *name() const noexcept override { return "llvm.pdb.raw"; }
std::string message(int Condition) const override { std::string message(int Condition) const override {
switch (static_cast<raw_error_code>(Condition)) { switch (static_cast<raw_error_code>(Condition)) {
case raw_error_code::unspecified: case raw_error_code::unspecified:
@ -46,30 +44,8 @@ public:
llvm_unreachable("Unrecognized raw_error_code"); llvm_unreachable("Unrecognized raw_error_code");
} }
}; };
} // end anonymous namespace
static ManagedStatic<RawErrorCategory> Category; static llvm::ManagedStatic<RawErrorCategory> RawCategory;
const std::error_category &llvm::pdb::RawErrCategory() { return *RawCategory; }
char RawError::ID = 0; char RawError::ID;
RawError::RawError(raw_error_code C) : RawError(C, "") {}
RawError::RawError(const std::string &Context)
: RawError(raw_error_code::unspecified, Context) {}
RawError::RawError(raw_error_code C, const std::string &Context) : Code(C) {
ErrMsg = "Native PDB Error: ";
std::error_code EC = convertToErrorCode();
if (Code != raw_error_code::unspecified)
ErrMsg += EC.message() + " ";
if (!Context.empty())
ErrMsg += Context;
}
void RawError::log(raw_ostream &OS) const { OS << ErrMsg << "\n"; }
const std::string &RawError::getErrorMessage() const { return ErrMsg; }
std::error_code RawError::convertToErrorCode() const {
return std::error_code(static_cast<int>(Code), *Category);
}

View File

@ -29,7 +29,7 @@ Error llvm::pdb::loadDataForPDB(PDB_ReaderType Type, StringRef Path,
MemoryBuffer::getFileOrSTDIN(Path, /*FileSize=*/-1, MemoryBuffer::getFileOrSTDIN(Path, /*FileSize=*/-1,
/*RequiresNullTerminator=*/false); /*RequiresNullTerminator=*/false);
if (!ErrorOrBuffer) if (!ErrorOrBuffer)
return make_error<GenericError>(generic_error_code::invalid_path, Path); return errorCodeToError(ErrorOrBuffer.getError());
return NativeSession::createFromPdb(std::move(*ErrorOrBuffer), Session); return NativeSession::createFromPdb(std::move(*ErrorOrBuffer), Session);
} }
@ -37,7 +37,7 @@ Error llvm::pdb::loadDataForPDB(PDB_ReaderType Type, StringRef Path,
#if LLVM_ENABLE_DIA_SDK #if LLVM_ENABLE_DIA_SDK
return DIASession::createFromPdb(Path, Session); return DIASession::createFromPdb(Path, Session);
#else #else
return make_error<GenericError>("DIA is not installed on the system"); return make_error<PDBError>(pdb_error_code::dia_sdk_not_present);
#endif #endif
} }
@ -50,6 +50,6 @@ Error llvm::pdb::loadDataForEXE(PDB_ReaderType Type, StringRef Path,
#if LLVM_ENABLE_DIA_SDK #if LLVM_ENABLE_DIA_SDK
return DIASession::createFromExe(Path, Session); return DIASession::createFromExe(Path, Session);
#else #else
return make_error<GenericError>("DIA is not installed on the system"); return make_error<PDBError>(pdb_error_code::dia_sdk_not_present);
#endif #endif
} }

View File

@ -410,7 +410,8 @@ LLVMSymbolizer::getOrCreateModuleInfo(const std::string &ModuleName,
Objects.first->getFileName(), Session)) { Objects.first->getFileName(), Session)) {
Modules.insert( Modules.insert(
std::make_pair(ModuleName, std::unique_ptr<SymbolizableModule>())); std::make_pair(ModuleName, std::unique_ptr<SymbolizableModule>()));
return std::move(Err); // Return along the PDB filename to provide more context
return createFileError(PDBFileName, std::move(Err));
} }
Context.reset(new PDBContext(*CoffObject, std::move(Session))); Context.reset(new PDBContext(*CoffObject, std::move(Session)));
} }

View File

@ -47,7 +47,7 @@ BinaryStreamError::BinaryStreamError(stream_error_code C, StringRef Context)
} }
} }
void BinaryStreamError::log(raw_ostream &OS) const { OS << ErrMsg << "\n"; } void BinaryStreamError::log(raw_ostream &OS) const { OS << ErrMsg; }
StringRef BinaryStreamError::getErrorMessage() const { return ErrMsg; } StringRef BinaryStreamError::getErrorMessage() const { return ErrMsg; }

View File

@ -2,7 +2,7 @@
# RUN: llvm-pdbutil yaml2pdb -pdb=%t2.pdb %s # RUN: llvm-pdbutil yaml2pdb -pdb=%t2.pdb %s
# RUN: not llvm-pdbutil merge -pdb=%t.pdb %t1.pdb %t2.pdb 2>&1 | FileCheck %s # RUN: not llvm-pdbutil merge -pdb=%t.pdb %t1.pdb %t2.pdb 2>&1 | FileCheck %s
# CHECK: CodeView Error: The CodeView record is corrupted. # CHECK: The CodeView record is corrupted
--- ---
TpiStream: TpiStream:

View File

@ -1167,4 +1167,4 @@ BIG-NEXT: Mod 0045 | `Import:api-ms-win-crt-heap-l1-1-0.dll`:
BIG-NEXT: Mod 0046 | `api-ms-win-crt-heap-l1-1-0.dll`: BIG-NEXT: Mod 0046 | `api-ms-win-crt-heap-l1-1-0.dll`:
BIG-NEXT: Mod 0047 | `* Linker *`: BIG-NEXT: Mod 0047 | `* Linker *`:
BAD-BLOCK-SIZE: Native PDB Error: The PDB file is corrupt. Does not contain superblock BAD-BLOCK-SIZE: The PDB file is corrupt. MSF superblock is missing

View File

@ -1,6 +1,6 @@
; RUN: not llvm-readobj -codeview-merged-types %S/Inputs/codeview-cycle.obj 2>&1 | FileCheck %s ; RUN: not llvm-readobj -codeview-merged-types %S/Inputs/codeview-cycle.obj 2>&1 | FileCheck %s
; CHECK: Error{{.*}} input type graph contains cycles ; CHECK: Error{{.*}} Input type graph contains cycles
; To reproduce codeview-cycle.obj: ; To reproduce codeview-cycle.obj:
; $ cat codeview-cycle.asm ; $ cat codeview-cycle.asm

View File

@ -8,7 +8,7 @@ ADDR: 0x401001
llvm-symbolizer should print one error and two unknown line info records. llvm-symbolizer should print one error and two unknown line info records.
ERROR: LLVMSymbolizer: error reading file: PDB Error: Unable to load PDB. Make sure the file exists and is readable. ERROR: LLVMSymbolizer: error reading file: {{.*}}: {{N|n}}o such file or directory
ERROR-NOT: error reading file ERROR-NOT: error reading file
CHECK: ?? CHECK: ??

View File

@ -46,7 +46,6 @@
#include "llvm/DebugInfo/CodeView/StringsAndChecksums.h" #include "llvm/DebugInfo/CodeView/StringsAndChecksums.h"
#include "llvm/DebugInfo/CodeView/TypeStreamMerger.h" #include "llvm/DebugInfo/CodeView/TypeStreamMerger.h"
#include "llvm/DebugInfo/MSF/MSFBuilder.h" #include "llvm/DebugInfo/MSF/MSFBuilder.h"
#include "llvm/DebugInfo/PDB/GenericError.h"
#include "llvm/DebugInfo/PDB/IPDBEnumChildren.h" #include "llvm/DebugInfo/PDB/IPDBEnumChildren.h"
#include "llvm/DebugInfo/PDB/IPDBInjectedSource.h" #include "llvm/DebugInfo/PDB/IPDBInjectedSource.h"
#include "llvm/DebugInfo/PDB/IPDBRawSymbol.h" #include "llvm/DebugInfo/PDB/IPDBRawSymbol.h"
@ -681,7 +680,7 @@ static void yamlToPdb(StringRef Path) {
/*RequiresNullTerminator=*/false); /*RequiresNullTerminator=*/false);
if (ErrorOrBuffer.getError()) { if (ErrorOrBuffer.getError()) {
ExitOnErr(make_error<GenericError>(generic_error_code::invalid_path, Path)); ExitOnErr(createFileError(Path, errorCodeToError(ErrorOrBuffer.getError())));
} }
std::unique_ptr<MemoryBuffer> &Buffer = ErrorOrBuffer.get(); std::unique_ptr<MemoryBuffer> &Buffer = ErrorOrBuffer.get();

View File

@ -53,7 +53,7 @@ const std::error_category &obj2yaml_category() {
char Obj2YamlError::ID = 0; char Obj2YamlError::ID = 0;
void Obj2YamlError::log(raw_ostream &OS) const { OS << ErrMsg << "\n"; } void Obj2YamlError::log(raw_ostream &OS) const { OS << ErrMsg; }
std::error_code Obj2YamlError::convertToErrorCode() const { std::error_code Obj2YamlError::convertToErrorCode() const {
return std::error_code(static_cast<int>(Code), obj2yaml_category()); return std::error_code(static_cast<int>(Code), obj2yaml_category());