maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/tools/llvm-pdbutil/ExplainOutputStyle.cpp

421 lines
17 KiB
C++
Raw Normal View History

[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
//===- ExplainOutputStyle.cpp --------------------------------- *- C++ --*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "ExplainOutputStyle.h"
#include "FormatUtil.h"
#include "StreamUtil.h"
#include "llvm-pdbutil.h"
[llvm-pdbutil] Dig deeper into the PDB and DBI streams when explaining. This will show more detail when using `llvm-pdbutil explain` on an offset in the DBI or PDB streams. Specifically, it will dig into individual header fields and substreams to give a more precise description of what the byte represents. llvm-svn: 328878
2018-03-31 01:16:50 +08:00
#include "llvm/DebugInfo/CodeView/Formatters.h"
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
#include "llvm/DebugInfo/MSF/MappedBlockStream.h"
[llvm-pdbutil] Dig deeper into the PDB and DBI streams when explaining. This will show more detail when using `llvm-pdbutil explain` on an offset in the DBI or PDB streams. Specifically, it will dig into individual header fields and substreams to give a more precise description of what the byte represents. llvm-svn: 328878
2018-03-31 01:16:50 +08:00
#include "llvm/DebugInfo/PDB/Native/DbiStream.h"
#include "llvm/DebugInfo/PDB/Native/InfoStream.h"
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
#include "llvm/DebugInfo/PDB/Native/PDBFile.h"
[llvm-pdbutil] Dig deeper into the PDB and DBI streams when explaining. This will show more detail when using `llvm-pdbutil explain` on an offset in the DBI or PDB streams. Specifically, it will dig into individual header fields and substreams to give a more precise description of what the byte represents. llvm-svn: 328878
2018-03-31 01:16:50 +08:00
#include "llvm/DebugInfo/PDB/Native/RawTypes.h"
#include "llvm/Support/BinaryStreamArray.h"
#include "llvm/Support/Error.h"
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
using namespace llvm;
using namespace llvm::codeview;
using namespace llvm::msf;
using namespace llvm::pdb;
ExplainOutputStyle::ExplainOutputStyle(PDBFile &File, uint64_t FileOffset)
: File(File), FileOffset(FileOffset),
BlockIndex(FileOffset / File.getBlockSize()),
OffsetInBlock(FileOffset - BlockIndex * File.getBlockSize()),
P(2, false, outs()) {}
Error ExplainOutputStyle::dump() {
P.formatLine("Explaining file offset {0} of file '{1}'.", FileOffset,
File.getFilePath());
bool IsAllocated = explainBlockStatus();
if (!IsAllocated)
return Error::success();
AutoIndent Indent(P);
if (isSuperBlock())
explainSuperBlockOffset();
else if (isFpmBlock())
explainFpmBlockOffset();
else if (isBlockMapBlock())
explainBlockMapOffset();
else if (isStreamDirectoryBlock())
explainStreamDirectoryOffset();
else if (auto Index = getBlockStreamIndex())
explainStreamOffset(*Index);
else
explainUnknownBlock();
return Error::success();
}
bool ExplainOutputStyle::isSuperBlock() const { return BlockIndex == 0; }
bool ExplainOutputStyle::isFpm1() const {
return ((BlockIndex - 1) % File.getBlockSize() == 0);
}
bool ExplainOutputStyle::isFpm2() const {
return ((BlockIndex - 2) % File.getBlockSize() == 0);
}
bool ExplainOutputStyle::isFpmBlock() const { return isFpm1() || isFpm2(); }
bool ExplainOutputStyle::isBlockMapBlock() const {
return BlockIndex == File.getBlockMapIndex();
}
bool ExplainOutputStyle::isStreamDirectoryBlock() const {
const auto &Layout = File.getMsfLayout();
return llvm::is_contained(Layout.DirectoryBlocks, BlockIndex);
}
Optional<uint32_t> ExplainOutputStyle::getBlockStreamIndex() const {
const auto &Layout = File.getMsfLayout();
for (const auto &Entry : enumerate(Layout.StreamMap)) {
if (!llvm::is_contained(Entry.value(), BlockIndex))
continue;
return Entry.index();
}
return None;
}
bool ExplainOutputStyle::explainBlockStatus() {
if (FileOffset >= File.getFileSize()) {
P.formatLine("Address {0} is not in the file (file size = {1}).",
FileOffset, File.getFileSize());
return false;
}
P.formatLine("Block:Offset = {2:X-}:{1:X-4}.", FileOffset, OffsetInBlock,
BlockIndex);
bool IsFree = File.getMsfLayout().FreePageMap[BlockIndex];
P.formatLine("Address is in block {0} ({1}allocated).", BlockIndex,
IsFree ? "un" : "");
return !IsFree;
}
[PDB] Fix a bug in the explain subcommand. We were trying to dig into the super block fields and print a description of the field at the specified offset, but we were printing the wrong field due to an off-by-one-field-error. llvm-svn: 328804
2018-03-30 01:11:14 +08:00
#define endof(Class, Field) (offsetof(Class, Field) + sizeof(Class::Field))
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
void ExplainOutputStyle::explainSuperBlockOffset() {
[PDB] Fix a bug in the explain subcommand. We were trying to dig into the super block fields and print a description of the field at the specified offset, but we were printing the wrong field due to an off-by-one-field-error. llvm-svn: 328804
2018-03-30 01:11:14 +08:00
P.formatLine("This corresponds to offset {0} of the MSF super block, ",
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
OffsetInBlock);
[PDB] Fix a bug in the explain subcommand. We were trying to dig into the super block fields and print a description of the field at the specified offset, but we were printing the wrong field due to an off-by-one-field-error. llvm-svn: 328804
2018-03-30 01:11:14 +08:00
if (OffsetInBlock < endof(SuperBlock, MagicBytes))
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
P.printLine("which is part of the MSF file magic.");
[PDB] Print some more details when explaining MSF fields. When we determine that a field belongs to an MSF super block or the free page map, we wouldn't print any additional information. With this patch, we now print the value of the field (for super block fields) or the allocation status of the specified byte (in the case of offsets in the FPM). llvm-svn: 328808
2018-03-30 01:45:34 +08:00
else if (OffsetInBlock < endof(SuperBlock, BlockSize)) {
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
P.printLine("which contains the block size of the file.");
[PDB] Print some more details when explaining MSF fields. When we determine that a field belongs to an MSF super block or the free page map, we wouldn't print any additional information. With this patch, we now print the value of the field (for super block fields) or the allocation status of the specified byte (in the case of offsets in the FPM). llvm-svn: 328808
2018-03-30 01:45:34 +08:00
P.formatLine("The current value is {0}.",
uint32_t(File.getMsfLayout().SB->BlockSize));
} else if (OffsetInBlock < endof(SuperBlock, FreeBlockMapBlock)) {
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
P.printLine("which contains the index of the FPM block (e.g. 1 or 2).");
[PDB] Print some more details when explaining MSF fields. When we determine that a field belongs to an MSF super block or the free page map, we wouldn't print any additional information. With this patch, we now print the value of the field (for super block fields) or the allocation status of the specified byte (in the case of offsets in the FPM). llvm-svn: 328808
2018-03-30 01:45:34 +08:00
P.formatLine("The current value is {0}.",
uint32_t(File.getMsfLayout().SB->FreeBlockMapBlock));
} else if (OffsetInBlock < endof(SuperBlock, NumBlocks)) {
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
P.printLine("which contains the number of blocks in the file.");
[PDB] Print some more details when explaining MSF fields. When we determine that a field belongs to an MSF super block or the free page map, we wouldn't print any additional information. With this patch, we now print the value of the field (for super block fields) or the allocation status of the specified byte (in the case of offsets in the FPM). llvm-svn: 328808
2018-03-30 01:45:34 +08:00
P.formatLine("The current value is {0}.",
uint32_t(File.getMsfLayout().SB->NumBlocks));
} else if (OffsetInBlock < endof(SuperBlock, NumDirectoryBytes)) {
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
P.printLine("which contains the number of bytes in the stream directory.");
[PDB] Print some more details when explaining MSF fields. When we determine that a field belongs to an MSF super block or the free page map, we wouldn't print any additional information. With this patch, we now print the value of the field (for super block fields) or the allocation status of the specified byte (in the case of offsets in the FPM). llvm-svn: 328808
2018-03-30 01:45:34 +08:00
P.formatLine("The current value is {0}.",
uint32_t(File.getMsfLayout().SB->NumDirectoryBytes));
} else if (OffsetInBlock < endof(SuperBlock, Unknown1)) {
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
P.printLine("whose purpose is unknown.");
[PDB] Print some more details when explaining MSF fields. When we determine that a field belongs to an MSF super block or the free page map, we wouldn't print any additional information. With this patch, we now print the value of the field (for super block fields) or the allocation status of the specified byte (in the case of offsets in the FPM). llvm-svn: 328808
2018-03-30 01:45:34 +08:00
P.formatLine("The current value is {0}.",
uint32_t(File.getMsfLayout().SB->Unknown1));
} else if (OffsetInBlock < endof(SuperBlock, BlockMapAddr)) {
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
P.printLine("which contains the file offset of the block map.");
[PDB] Print some more details when explaining MSF fields. When we determine that a field belongs to an MSF super block or the free page map, we wouldn't print any additional information. With this patch, we now print the value of the field (for super block fields) or the allocation status of the specified byte (in the case of offsets in the FPM). llvm-svn: 328808
2018-03-30 01:45:34 +08:00
P.formatLine("The current value is {0}.",
uint32_t(File.getMsfLayout().SB->BlockMapAddr));
} else {
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
assert(OffsetInBlock > sizeof(SuperBlock));
P.printLine(
"which is outside the range of valid data for the super block.");
}
}
[PDB] Print some more details when explaining MSF fields. When we determine that a field belongs to an MSF super block or the free page map, we wouldn't print any additional information. With this patch, we now print the value of the field (for super block fields) or the allocation status of the specified byte (in the case of offsets in the FPM). llvm-svn: 328808
2018-03-30 01:45:34 +08:00
static std::string toBinaryString(uint8_t Byte) {
char Result[9] = {0};
for (int I = 0; I < 8; ++I) {
char C = (Byte & 1) ? '1' : '0';
Result[I] = C;
Byte >>= 1;
}
return std::string(Result);
}
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
void ExplainOutputStyle::explainFpmBlockOffset() {
const MSFLayout &Layout = File.getMsfLayout();
uint32_t MainFpm = Layout.mainFpmBlock();
uint32_t AltFpm = Layout.alternateFpmBlock();
assert(isFpmBlock());
uint32_t Fpm = isFpm1() ? 1 : 2;
uint32_t FpmChunk = BlockIndex / File.getBlockSize();
assert((Fpm == MainFpm) || (Fpm == AltFpm));
(void)AltFpm;
bool IsMain = (Fpm == MainFpm);
P.formatLine("Address is in FPM{0} ({1} FPM)", Fpm, IsMain ? "Main" : "Alt");
uint32_t DescribedBlockStart =
8 * (FpmChunk * File.getBlockSize() + OffsetInBlock);
if (DescribedBlockStart > File.getBlockCount()) {
P.printLine("Address is in extraneous FPM space.");
return;
}
P.formatLine("Address describes the allocation status of blocks [{0},{1})",
DescribedBlockStart, DescribedBlockStart + 8);
[PDB] Print some more details when explaining MSF fields. When we determine that a field belongs to an MSF super block or the free page map, we wouldn't print any additional information. With this patch, we now print the value of the field (for super block fields) or the allocation status of the specified byte (in the case of offsets in the FPM). llvm-svn: 328808
2018-03-30 01:45:34 +08:00
ArrayRef<uint8_t> Bytes;
cantFail(File.getMsfBuffer().readBytes(FileOffset, 1, Bytes));
P.formatLine("Status = {0} (Note: 0 = allocated, 1 = free)",
toBinaryString(Bytes[0]));
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
}
void ExplainOutputStyle::explainBlockMapOffset() {
uint64_t BlockMapOffset = File.getBlockMapOffset();
uint32_t OffsetInBlock = FileOffset - BlockMapOffset;
P.formatLine("Address is at offset {0} of the directory block list",
OffsetInBlock);
}
static uint32_t getOffsetInStream(ArrayRef<support::ulittle32_t> StreamBlocks,
uint64_t FileOffset, uint32_t BlockSize) {
uint32_t BlockIndex = FileOffset / BlockSize;
uint32_t OffsetInBlock = FileOffset - BlockIndex * BlockSize;
auto Iter = llvm::find(StreamBlocks, BlockIndex);
assert(Iter != StreamBlocks.end());
uint32_t StreamBlockIndex = std::distance(StreamBlocks.begin(), Iter);
return StreamBlockIndex * BlockSize + OffsetInBlock;
}
void ExplainOutputStyle::explainStreamOffset(uint32_t Stream) {
SmallVector<StreamInfo, 12> Streams;
discoverStreamPurposes(File, Streams);
assert(Stream <= Streams.size());
const StreamInfo &S = Streams[Stream];
const auto &Layout = File.getStreamLayout(Stream);
uint32_t StreamOff =
getOffsetInStream(Layout.Blocks, FileOffset, File.getBlockSize());
P.formatLine("Address is at offset {0}/{1} of Stream {2} ({3}){4}.",
StreamOff, Layout.Length, Stream, S.getLongName(),
(StreamOff > Layout.Length) ? " in unused space" : "");
[llvm-pdbutil] Dig deeper into the PDB and DBI streams when explaining. This will show more detail when using `llvm-pdbutil explain` on an offset in the DBI or PDB streams. Specifically, it will dig into individual header fields and substreams to give a more precise description of what the byte represents. llvm-svn: 328878
2018-03-31 01:16:50 +08:00
switch (S.getPurpose()) {
case StreamPurpose::DBI:
explainDbiStream(Stream, StreamOff);
break;
case StreamPurpose::PDB:
explainPdbStream(Stream, StreamOff);
break;
case StreamPurpose::IPI:
case StreamPurpose::TPI:
case StreamPurpose::ModuleStream:
case StreamPurpose::NamedStream:
default:
break;
}
[PDB] Add an explain subcommand. When investigating various things, we often have a file offset and what to know what's in the PDB at that address. For example we may be doing a binary comparison of two LLD-generated PDBs to look for sources of non-determinism, or we may wish to compare an LLD-generated PDB with a Microsoft generated PDB for sources of byte-for-byte incompatibility. In these cases, we can do a binary diff of the two files, and once we find a mismatched byte we can use explain to figure out what that byte is, immediately honining in on the problem. This patch implements this by trying to narrow the meaning of a particular file offset down as much as possible. Differential Revision: https://reviews.llvm.org/D44959 llvm-svn: 328799
2018-03-30 00:28:20 +08:00
}
void ExplainOutputStyle::explainStreamDirectoryOffset() {
auto DirectoryBlocks = File.getDirectoryBlockArray();
const auto &Layout = File.getMsfLayout();
uint32_t StreamOff =
getOffsetInStream(DirectoryBlocks, FileOffset, File.getBlockSize());
P.formatLine("Address is at offset {0}/{1} of Stream Directory{2}.",
StreamOff, uint32_t(Layout.SB->NumDirectoryBytes),
uint32_t(StreamOff > Layout.SB->NumDirectoryBytes)
? " in unused space"
: "");
}
void ExplainOutputStyle::explainUnknownBlock() {
P.formatLine("Address has unknown purpose.");
}
[llvm-pdbutil] Dig deeper into the PDB and DBI streams when explaining. This will show more detail when using `llvm-pdbutil explain` on an offset in the DBI or PDB streams. Specifically, it will dig into individual header fields and substreams to give a more precise description of what the byte represents. llvm-svn: 328878
2018-03-31 01:16:50 +08:00
template <typename T>
static void printStructField(LinePrinter &P, StringRef Label, T Value) {
P.formatLine("which contains {0}.", Label);
P.formatLine("The current value is {0}.", Value);
}
static void explainDbiHeaderOffset(LinePrinter &P, DbiStream &Dbi,
uint32_t Offset) {
const DbiStreamHeader *Header = Dbi.getHeader();
assert(Header != nullptr);
if (Offset < endof(DbiStreamHeader, VersionSignature))
printStructField(P, "the DBI Stream Version Signature",
int32_t(Header->VersionSignature));
else if (Offset < endof(DbiStreamHeader, VersionHeader))
printStructField(P, "the DBI Stream Version Header",
uint32_t(Header->VersionHeader));
else if (Offset < endof(DbiStreamHeader, Age))
printStructField(P, "the age of the DBI Stream", uint32_t(Header->Age));
else if (Offset < endof(DbiStreamHeader, GlobalSymbolStreamIndex))
printStructField(P, "the index of the Global Symbol Stream",
uint16_t(Header->GlobalSymbolStreamIndex));
else if (Offset < endof(DbiStreamHeader, BuildNumber))
printStructField(P, "the build number", uint16_t(Header->BuildNumber));
else if (Offset < endof(DbiStreamHeader, PublicSymbolStreamIndex))
printStructField(P, "the index of the Public Symbol Stream",
uint16_t(Header->PublicSymbolStreamIndex));
else if (Offset < endof(DbiStreamHeader, PdbDllVersion))
printStructField(P, "the version of mspdb.dll",
uint16_t(Header->PdbDllVersion));
else if (Offset < endof(DbiStreamHeader, SymRecordStreamIndex))
printStructField(P, "the index of the Symbol Record Stream",
uint16_t(Header->SymRecordStreamIndex));
else if (Offset < endof(DbiStreamHeader, PdbDllRbld))
printStructField(P, "the rbld of mspdb.dll", uint16_t(Header->PdbDllRbld));
else if (Offset < endof(DbiStreamHeader, ModiSubstreamSize))
printStructField(P, "the size of the Module Info Substream",
int32_t(Header->ModiSubstreamSize));
else if (Offset < endof(DbiStreamHeader, SecContrSubstreamSize))
printStructField(P, "the size of the Section Contribution Substream",
int32_t(Header->SecContrSubstreamSize));
else if (Offset < endof(DbiStreamHeader, SectionMapSize))
printStructField(P, "the size of the Section Map Substream",
int32_t(Header->SectionMapSize));
else if (Offset < endof(DbiStreamHeader, FileInfoSize))
printStructField(P, "the size of the File Info Substream",
int32_t(Header->FileInfoSize));
else if (Offset < endof(DbiStreamHeader, TypeServerSize))
printStructField(P, "the size of the Type Server Map",
int32_t(Header->TypeServerSize));
else if (Offset < endof(DbiStreamHeader, MFCTypeServerIndex))
printStructField(P, "the index of the MFC Type Server stream",
uint32_t(Header->MFCTypeServerIndex));
else if (Offset < endof(DbiStreamHeader, OptionalDbgHdrSize))
printStructField(P, "the size of the Optional Debug Stream array",
int32_t(Header->OptionalDbgHdrSize));
else if (Offset < endof(DbiStreamHeader, ECSubstreamSize))
printStructField(P, "the size of the Edit & Continue Substream",
int32_t(Header->ECSubstreamSize));
else if (Offset < endof(DbiStreamHeader, Flags))
printStructField(P, "the DBI Stream flags", uint16_t(Header->Flags));
else if (Offset < endof(DbiStreamHeader, MachineType))
printStructField(P, "the machine type", uint16_t(Header->MachineType));
else if (Offset < endof(DbiStreamHeader, Reserved))
printStructField(P, "reserved data", uint32_t(Header->Reserved));
}
static void explainDbiModiSubstreamOffset(LinePrinter &P, DbiStream &Dbi,
uint32_t Offset) {
VarStreamArray<DbiModuleDescriptor> ModuleDescriptors;
BinaryStreamRef ModiSubstreamData = Dbi.getModiSubstreamData().StreamData;
BinaryStreamReader Reader(ModiSubstreamData);
cantFail(Reader.readArray(ModuleDescriptors, ModiSubstreamData.getLength()));
auto Prev = ModuleDescriptors.begin();
assert(Prev.offset() == 0);
auto Current = Prev;
uint32_t Index = 0;
while (true) {
Prev = Current;
++Current;
if (Current == ModuleDescriptors.end() || Offset < Current.offset())
break;
++Index;
}
DbiModuleDescriptor &Descriptor = *Prev;
P.formatLine("which contains the descriptor for module {0} ({1}).", Index,
Descriptor.getModuleName());
}
template <typename T>
static void dontExplain(LinePrinter &Printer, T &Stream, uint32_t Offset) {}
template <typename T, typename SubstreamRangeT>
static void explainSubstreamOffset(LinePrinter &P, uint32_t OffsetInStream,
T &Stream,
const SubstreamRangeT &Substreams) {
uint32_t SubOffset = OffsetInStream;
for (const auto &Entry : Substreams) {
if (Entry.Size == 0)
continue;
if (SubOffset < Entry.Size) {
P.formatLine("address is at offset {0}/{1} of the {2}.", SubOffset,
Entry.Size, Entry.Label);
Entry.Explain(P, Stream, SubOffset);
return;
}
SubOffset -= Entry.Size;
}
}
void ExplainOutputStyle::explainDbiStream(uint32_t StreamIdx,
uint32_t OffsetInStream) {
P.printLine("Within the DBI stream:");
DbiStream &Dbi = cantFail(File.getPDBDbiStream());
AutoIndent Indent(P);
const DbiStreamHeader *Header = Dbi.getHeader();
assert(Header != nullptr);
struct SubstreamInfo {
uint32_t Size;
StringRef Label;
void (*Explain)(LinePrinter &, DbiStream &, uint32_t);
} Substreams[] = {
{sizeof(DbiStreamHeader), "DBI Stream Header", explainDbiHeaderOffset},
{Header->ModiSubstreamSize, "Module Info Substream",
explainDbiModiSubstreamOffset},
{Header->SecContrSubstreamSize, "Section Contribution Substream",
dontExplain<DbiStream>},
{Header->SectionMapSize, "Section Map", dontExplain<DbiStream>},
{Header->FileInfoSize, "File Info Substream", dontExplain<DbiStream>},
{Header->TypeServerSize, "Type Server Map Substream",
dontExplain<DbiStream>},
{Header->ECSubstreamSize, "Edit & Continue Substream",
dontExplain<DbiStream>},
{Header->OptionalDbgHdrSize, "Optional Debug Stream Array",
dontExplain<DbiStream>},
};
explainSubstreamOffset(P, OffsetInStream, Dbi, Substreams);
}
static void explainPdbStreamHeaderOffset(LinePrinter &P, InfoStream &Info,
uint32_t Offset) {
const InfoStreamHeader *Header = Info.getHeader();
assert(Header != nullptr);
if (Offset < endof(InfoStreamHeader, Version))
printStructField(P, "the PDB Stream Version Signature",
uint32_t(Header->Version));
else if (Offset < endof(InfoStreamHeader, Signature))
printStructField(P, "the signature of the PDB Stream",
uint32_t(Header->Signature));
else if (Offset < endof(InfoStreamHeader, Age))
printStructField(P, "the age of the PDB", uint32_t(Header->Age));
else if (Offset < endof(InfoStreamHeader, Guid))
printStructField(P, "the guid of the PDB", fmt_guid(Header->Guid.Guid));
}
void ExplainOutputStyle::explainPdbStream(uint32_t StreamIdx,
uint32_t OffsetInStream) {
P.printLine("Within the PDB stream:");
InfoStream &Info = cantFail(File.getPDBInfoStream());
AutoIndent Indent(P);
struct SubstreamInfo {
uint32_t Size;
StringRef Label;
void (*Explain)(LinePrinter &, InfoStream &, uint32_t);
} Substreams[] = {{sizeof(InfoStreamHeader), "PDB Stream Header",
explainPdbStreamHeaderOffset},
{Info.getNamedStreamMapByteSize(), "Named Stream Map",
dontExplain<InfoStream>},
{Info.getStreamSize(), "PDB Feature Signatures",
dontExplain<InfoStream>}};
explainSubstreamOffset(P, OffsetInStream, Info, Substreams);
}