mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-26 04:32:44 +01:00
fa9d44b037
We have llvm-readobj for dumping CodeView from object files, and llvm-pdbutil has always been more focused on PDB. However, llvm-pdbutil has a lot of useful options for summarizing debug information in aggregate and presenting high level statistical views. Furthermore, it's arguably better as a testing tool since we don't have to write tests to conform to a state-machine like structure where you match multiple lines in succession, each depending on a previous match. llvm-pdbutil dumps much more concisely, so it's possible to use single-line matches in many cases where as with readobj tests you have to use multi-line matches with an implicit state machine. Because of this, I'm adding object file support to llvm-pdbutil. In fact, this mirrors the cvdump tool from Microsoft, which also supports both object files and pdb files. In the future we could perhaps rename this tool llvm-cvutil. In the meantime, this allows us to deep dive into object files the same way we already can with PDB files. llvm-svn: 312358
148 lines
4.0 KiB
C++
148 lines
4.0 KiB
C++
//===- InputFile.h -------------------------------------------- *- C++ --*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_TOOLS_LLVMPDBDUMP_INPUTFILE_H
|
|
#define LLVM_TOOLS_LLVMPDBDUMP_INPUTFILE_H
|
|
|
|
#include "llvm/ADT/Optional.h"
|
|
#include "llvm/ADT/PointerUnion.h"
|
|
#include "llvm/ADT/StringMap.h"
|
|
#include "llvm/ADT/iterator.h"
|
|
#include "llvm/DebugInfo/CodeView/DebugChecksumsSubsection.h"
|
|
#include "llvm/DebugInfo/CodeView/StringsAndChecksums.h"
|
|
#include "llvm/DebugInfo/PDB/Native/ModuleDebugStream.h"
|
|
#include "llvm/Object/Binary.h"
|
|
#include "llvm/Object/ObjectFile.h"
|
|
#include "llvm/Support/Error.h"
|
|
|
|
namespace llvm {
|
|
namespace codeview {
|
|
class LazyRandomTypeCollection;
|
|
}
|
|
namespace object {
|
|
class COFFObjectFile;
|
|
class SectionRef;
|
|
} // namespace object
|
|
|
|
namespace pdb {
|
|
class InputFile;
|
|
class LinePrinter;
|
|
class PDBFile;
|
|
class NativeSession;
|
|
class SymbolGroupIterator;
|
|
class SymbolGroup;
|
|
|
|
class InputFile {
|
|
InputFile();
|
|
|
|
std::unique_ptr<NativeSession> PdbSession;
|
|
object::OwningBinary<object::Binary> CoffObject;
|
|
PointerUnion<PDBFile *, object::COFFObjectFile *> PdbOrObj;
|
|
|
|
using TypeCollectionPtr = std::unique_ptr<codeview::LazyRandomTypeCollection>;
|
|
|
|
TypeCollectionPtr Types;
|
|
TypeCollectionPtr Ids;
|
|
|
|
enum TypeCollectionKind { kTypes, kIds };
|
|
codeview::LazyRandomTypeCollection &
|
|
getOrCreateTypeCollection(TypeCollectionKind Kind);
|
|
|
|
public:
|
|
~InputFile();
|
|
InputFile(InputFile &&Other) = default;
|
|
|
|
static Expected<InputFile> open(StringRef Path);
|
|
|
|
PDBFile &pdb();
|
|
const PDBFile &pdb() const;
|
|
object::COFFObjectFile &obj();
|
|
const object::COFFObjectFile &obj() const;
|
|
|
|
bool hasTypes() const;
|
|
bool hasIds() const;
|
|
|
|
codeview::LazyRandomTypeCollection &types();
|
|
codeview::LazyRandomTypeCollection &ids();
|
|
|
|
iterator_range<SymbolGroupIterator> symbol_groups();
|
|
SymbolGroupIterator symbol_groups_begin();
|
|
SymbolGroupIterator symbol_groups_end();
|
|
|
|
bool isPdb() const;
|
|
bool isObj() const;
|
|
};
|
|
|
|
class SymbolGroup {
|
|
friend class SymbolGroupIterator;
|
|
|
|
public:
|
|
explicit SymbolGroup(InputFile *File, uint32_t GroupIndex = 0);
|
|
|
|
Expected<StringRef> getNameFromStringTable(uint32_t Offset) const;
|
|
|
|
void formatFromFileName(LinePrinter &Printer, StringRef File,
|
|
bool Append = false) const;
|
|
|
|
void formatFromChecksumsOffset(LinePrinter &Printer, uint32_t Offset,
|
|
bool Append = false) const;
|
|
|
|
StringRef name() const;
|
|
|
|
codeview::DebugSubsectionArray getDebugSubsections() const {
|
|
return Subsections;
|
|
}
|
|
const ModuleDebugStreamRef &getPdbModuleStream() const;
|
|
|
|
const InputFile &getFile() const { return *File; }
|
|
InputFile &getFile() { return *File; }
|
|
|
|
private:
|
|
void initializeForPdb(uint32_t Modi);
|
|
void updatePdbModi(uint32_t Modi);
|
|
void updateDebugS(const codeview::DebugSubsectionArray &SS);
|
|
|
|
void rebuildChecksumMap();
|
|
InputFile *File = nullptr;
|
|
StringRef Name;
|
|
codeview::DebugSubsectionArray Subsections;
|
|
std::shared_ptr<ModuleDebugStreamRef> DebugStream;
|
|
codeview::StringsAndChecksumsRef SC;
|
|
StringMap<codeview::FileChecksumEntry> ChecksumsByFile;
|
|
};
|
|
|
|
class SymbolGroupIterator
|
|
: public iterator_facade_base<SymbolGroupIterator,
|
|
std::forward_iterator_tag, SymbolGroup> {
|
|
public:
|
|
SymbolGroupIterator();
|
|
explicit SymbolGroupIterator(InputFile &File);
|
|
SymbolGroupIterator(const SymbolGroupIterator &Other) = default;
|
|
SymbolGroupIterator &operator=(const SymbolGroupIterator &R) = default;
|
|
|
|
const SymbolGroup &operator*() const;
|
|
SymbolGroup &operator*();
|
|
|
|
bool operator==(const SymbolGroupIterator &R) const;
|
|
SymbolGroupIterator &operator++();
|
|
|
|
private:
|
|
void scanToNextDebugS();
|
|
bool isEnd() const;
|
|
|
|
uint32_t Index = 0;
|
|
Optional<object::section_iterator> SectionIter;
|
|
SymbolGroup Value;
|
|
};
|
|
|
|
} // namespace pdb
|
|
} // namespace llvm
|
|
|
|
#endif
|