mirror of
https://github.com/RPCS3/llvm.git
synced 2026-01-31 01:25:19 +01:00
2219387eaf
This was reverted because it was breaking some builds, and because of incorrect error code usage. Since the CL was large and contained many different things, I'm resubmitting it in pieces. This portion is NFC, and consists of: 1) Renaming classes to follow a consistent naming convention. 2) Fixing the const-ness of the interface methods. 3) Adding detailed doxygen comments. 4) Fixing a few instances of passing `const BinaryStream& X`. These are now passed as `BinaryStreamRef X`. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@296394 91177308-0d34-0410-b5e6-96231b3b80d8
133 lines
5.0 KiB
C++
133 lines
5.0 KiB
C++
//===- ModuleSubstreamVisitor.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_DEBUGINFO_CODEVIEW_MODULESUBSTREAMVISITOR_H
|
|
#define LLVM_DEBUGINFO_CODEVIEW_MODULESUBSTREAMVISITOR_H
|
|
|
|
#include "llvm/ADT/ArrayRef.h"
|
|
#include "llvm/DebugInfo/CodeView/CodeView.h"
|
|
#include "llvm/DebugInfo/CodeView/CodeViewError.h"
|
|
#include "llvm/DebugInfo/CodeView/Line.h"
|
|
#include "llvm/DebugInfo/CodeView/ModuleSubstream.h"
|
|
#include "llvm/DebugInfo/MSF/BinaryStreamArray.h"
|
|
#include "llvm/DebugInfo/MSF/BinaryStreamReader.h"
|
|
#include "llvm/DebugInfo/MSF/BinaryStreamRef.h"
|
|
#include "llvm/Support/Endian.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include <cstdint>
|
|
|
|
namespace llvm {
|
|
|
|
namespace codeview {
|
|
|
|
struct LineColumnEntry {
|
|
support::ulittle32_t NameIndex;
|
|
FixedStreamArray<LineNumberEntry> LineNumbers;
|
|
FixedStreamArray<ColumnNumberEntry> Columns;
|
|
};
|
|
|
|
struct FileChecksumEntry {
|
|
uint32_t FileNameOffset; // Byte offset of filename in global stringtable.
|
|
FileChecksumKind Kind; // The type of checksum.
|
|
ArrayRef<uint8_t> Checksum; // The bytes of the checksum.
|
|
};
|
|
|
|
typedef VarStreamArray<LineColumnEntry> LineInfoArray;
|
|
typedef VarStreamArray<FileChecksumEntry> FileChecksumArray;
|
|
|
|
class IModuleSubstreamVisitor {
|
|
public:
|
|
virtual ~IModuleSubstreamVisitor() = default;
|
|
|
|
virtual Error visitUnknown(ModuleSubstreamKind Kind,
|
|
BinaryStreamRef Data) = 0;
|
|
virtual Error visitSymbols(BinaryStreamRef Data);
|
|
virtual Error visitLines(BinaryStreamRef Data,
|
|
const LineSubstreamHeader *Header,
|
|
const LineInfoArray &Lines);
|
|
virtual Error visitStringTable(BinaryStreamRef Data);
|
|
virtual Error visitFileChecksums(BinaryStreamRef Data,
|
|
const FileChecksumArray &Checksums);
|
|
virtual Error visitFrameData(BinaryStreamRef Data);
|
|
virtual Error visitInlineeLines(BinaryStreamRef Data);
|
|
virtual Error visitCrossScopeImports(BinaryStreamRef Data);
|
|
virtual Error visitCrossScopeExports(BinaryStreamRef Data);
|
|
virtual Error visitILLines(BinaryStreamRef Data);
|
|
virtual Error visitFuncMDTokenMap(BinaryStreamRef Data);
|
|
virtual Error visitTypeMDTokenMap(BinaryStreamRef Data);
|
|
virtual Error visitMergedAssemblyInput(BinaryStreamRef Data);
|
|
virtual Error visitCoffSymbolRVA(BinaryStreamRef Data);
|
|
};
|
|
|
|
Error visitModuleSubstream(const ModuleSubstream &R,
|
|
IModuleSubstreamVisitor &V);
|
|
} // end namespace codeview
|
|
|
|
template <> class VarStreamArrayExtractor<codeview::LineColumnEntry> {
|
|
public:
|
|
VarStreamArrayExtractor(const codeview::LineSubstreamHeader *Header)
|
|
: Header(Header) {}
|
|
|
|
Error operator()(BinaryStreamRef Stream, uint32_t &Len,
|
|
codeview::LineColumnEntry &Item) const {
|
|
using namespace codeview;
|
|
const LineFileBlockHeader *BlockHeader;
|
|
BinaryStreamReader Reader(Stream);
|
|
if (auto EC = Reader.readObject(BlockHeader))
|
|
return EC;
|
|
bool HasColumn = Header->Flags & LineFlags::HaveColumns;
|
|
uint32_t LineInfoSize =
|
|
BlockHeader->NumLines *
|
|
(sizeof(LineNumberEntry) + (HasColumn ? sizeof(ColumnNumberEntry) : 0));
|
|
if (BlockHeader->BlockSize < sizeof(LineFileBlockHeader))
|
|
return make_error<CodeViewError>(cv_error_code::corrupt_record,
|
|
"Invalid line block record size");
|
|
uint32_t Size = BlockHeader->BlockSize - sizeof(LineFileBlockHeader);
|
|
if (LineInfoSize > Size)
|
|
return make_error<CodeViewError>(cv_error_code::corrupt_record,
|
|
"Invalid line block record size");
|
|
// The value recorded in BlockHeader->BlockSize includes the size of
|
|
// LineFileBlockHeader.
|
|
Len = BlockHeader->BlockSize;
|
|
Item.NameIndex = BlockHeader->NameIndex;
|
|
if (auto EC = Reader.readArray(Item.LineNumbers, BlockHeader->NumLines))
|
|
return EC;
|
|
if (HasColumn) {
|
|
if (auto EC = Reader.readArray(Item.Columns, BlockHeader->NumLines))
|
|
return EC;
|
|
}
|
|
return Error::success();
|
|
}
|
|
|
|
private:
|
|
const codeview::LineSubstreamHeader *Header;
|
|
};
|
|
|
|
template <> class VarStreamArrayExtractor<codeview::FileChecksumEntry> {
|
|
public:
|
|
Error operator()(BinaryStreamRef Stream, uint32_t &Len,
|
|
codeview::FileChecksumEntry &Item) const {
|
|
using namespace codeview;
|
|
const FileChecksum *Header;
|
|
BinaryStreamReader Reader(Stream);
|
|
if (auto EC = Reader.readObject(Header))
|
|
return EC;
|
|
Item.FileNameOffset = Header->FileNameOffset;
|
|
Item.Kind = static_cast<FileChecksumKind>(Header->ChecksumKind);
|
|
if (auto EC = Reader.readBytes(Item.Checksum, Header->ChecksumSize))
|
|
return EC;
|
|
Len = sizeof(FileChecksum) + Header->ChecksumSize;
|
|
return Error::success();
|
|
}
|
|
};
|
|
|
|
} // end namespace llvm
|
|
|
|
#endif // LLVM_DEBUGINFO_CODEVIEW_MODULESUBSTREAMVISITOR_H
|