mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-23 19:23:23 +01:00
bafdd700f2
llvm-svn: 305818
447 lines
15 KiB
C++
447 lines
15 KiB
C++
//===- Diff.cpp - PDB diff utility ------------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "Diff.h"
|
|
|
|
#include "StreamUtil.h"
|
|
#include "llvm-pdbutil.h"
|
|
|
|
#include "llvm/DebugInfo/PDB/Native/Formatters.h"
|
|
#include "llvm/DebugInfo/PDB/Native/InfoStream.h"
|
|
#include "llvm/DebugInfo/PDB/Native/PDBFile.h"
|
|
#include "llvm/DebugInfo/PDB/Native/PDBStringTable.h"
|
|
#include "llvm/DebugInfo/PDB/Native/RawConstants.h"
|
|
|
|
#include "llvm/Support/FormatAdapters.h"
|
|
#include "llvm/Support/FormatProviders.h"
|
|
#include "llvm/Support/FormatVariadic.h"
|
|
|
|
using namespace llvm;
|
|
using namespace llvm::pdb;
|
|
|
|
namespace llvm {
|
|
template <> struct format_provider<PdbRaw_FeatureSig> {
|
|
static void format(const PdbRaw_FeatureSig &Sig, raw_ostream &Stream,
|
|
StringRef Style) {
|
|
switch (Sig) {
|
|
case PdbRaw_FeatureSig::MinimalDebugInfo:
|
|
Stream << "MinimalDebugInfo";
|
|
break;
|
|
case PdbRaw_FeatureSig::NoTypeMerge:
|
|
Stream << "NoTypeMerge";
|
|
break;
|
|
case PdbRaw_FeatureSig::VC110:
|
|
Stream << "VC110";
|
|
break;
|
|
case PdbRaw_FeatureSig::VC140:
|
|
Stream << "VC140";
|
|
break;
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
template <typename R> using ValueOfRange = llvm::detail::ValueOfRange<R>;
|
|
|
|
template <typename Range, typename Comp>
|
|
static void set_differences(Range &&R1, Range &&R2,
|
|
SmallVectorImpl<ValueOfRange<Range>> *OnlyLeft,
|
|
SmallVectorImpl<ValueOfRange<Range>> *OnlyRight,
|
|
SmallVectorImpl<ValueOfRange<Range>> *Intersection,
|
|
Comp Comparator) {
|
|
|
|
std::sort(R1.begin(), R1.end(), Comparator);
|
|
std::sort(R2.begin(), R2.end(), Comparator);
|
|
|
|
if (OnlyLeft) {
|
|
OnlyLeft->reserve(R1.size());
|
|
auto End = std::set_difference(R1.begin(), R1.end(), R2.begin(), R2.end(),
|
|
OnlyLeft->begin(), Comparator);
|
|
OnlyLeft->set_size(std::distance(OnlyLeft->begin(), End));
|
|
}
|
|
if (OnlyRight) {
|
|
OnlyLeft->reserve(R2.size());
|
|
auto End = std::set_difference(R2.begin(), R2.end(), R1.begin(), R1.end(),
|
|
OnlyRight->begin(), Comparator);
|
|
OnlyRight->set_size(std::distance(OnlyRight->begin(), End));
|
|
}
|
|
if (Intersection) {
|
|
Intersection->reserve(std::min(R1.size(), R2.size()));
|
|
auto End = std::set_intersection(R1.begin(), R1.end(), R2.begin(), R2.end(),
|
|
Intersection->begin(), Comparator);
|
|
Intersection->set_size(std::distance(Intersection->begin(), End));
|
|
}
|
|
}
|
|
|
|
template <typename Range>
|
|
static void
|
|
set_differences(Range &&R1, Range &&R2,
|
|
SmallVectorImpl<ValueOfRange<Range>> *OnlyLeft,
|
|
SmallVectorImpl<ValueOfRange<Range>> *OnlyRight,
|
|
SmallVectorImpl<ValueOfRange<Range>> *Intersection = nullptr) {
|
|
std::less<ValueOfRange<Range>> Comp;
|
|
set_differences(std::forward<Range>(R1), std::forward<Range>(R2), OnlyLeft,
|
|
OnlyRight, Intersection, Comp);
|
|
}
|
|
|
|
DiffStyle::DiffStyle(PDBFile &File1, PDBFile &File2)
|
|
: File1(File1), File2(File2) {}
|
|
|
|
Error DiffStyle::dump() {
|
|
if (auto EC = diffSuperBlock())
|
|
return EC;
|
|
|
|
if (auto EC = diffFreePageMap())
|
|
return EC;
|
|
|
|
if (auto EC = diffStreamDirectory())
|
|
return EC;
|
|
|
|
if (auto EC = diffStringTable())
|
|
return EC;
|
|
|
|
if (auto EC = diffInfoStream())
|
|
return EC;
|
|
|
|
if (auto EC = diffDbiStream())
|
|
return EC;
|
|
|
|
if (auto EC = diffSectionContribs())
|
|
return EC;
|
|
|
|
if (auto EC = diffSectionMap())
|
|
return EC;
|
|
|
|
if (auto EC = diffFpoStream())
|
|
return EC;
|
|
|
|
if (auto EC = diffTpiStream(StreamTPI))
|
|
return EC;
|
|
|
|
if (auto EC = diffTpiStream(StreamIPI))
|
|
return EC;
|
|
|
|
if (auto EC = diffPublics())
|
|
return EC;
|
|
|
|
if (auto EC = diffGlobals())
|
|
return EC;
|
|
|
|
return Error::success();
|
|
}
|
|
|
|
template <typename T>
|
|
static bool diffAndPrint(StringRef Label, PDBFile &File1, PDBFile &File2, T V1,
|
|
T V2) {
|
|
if (V1 == V2) {
|
|
outs() << formatv(" {0}: No differences detected!\n", Label);
|
|
return false;
|
|
}
|
|
|
|
outs().indent(2) << Label << "\n";
|
|
outs().indent(4) << formatv("{0}: {1}\n", File1.getFilePath(), V1);
|
|
outs().indent(4) << formatv("{0}: {1}\n", File2.getFilePath(), V2);
|
|
return true;
|
|
}
|
|
|
|
template <typename T>
|
|
static bool diffAndPrint(StringRef Label, PDBFile &File1, PDBFile &File2,
|
|
ArrayRef<T> V1, ArrayRef<T> V2) {
|
|
if (V1 == V2) {
|
|
outs() << formatv(" {0}: No differences detected!\n", Label);
|
|
return false;
|
|
}
|
|
|
|
outs().indent(2) << Label << "\n";
|
|
outs().indent(4) << formatv("{0}: {1}\n", File1.getFilePath(),
|
|
make_range(V1.begin(), V1.end()));
|
|
outs().indent(4) << formatv("{0}: {1}\n", File2.getFilePath(),
|
|
make_range(V2.begin(), V2.end()));
|
|
return true;
|
|
}
|
|
|
|
template <typename T>
|
|
static bool printSymmetricDifferences(PDBFile &File1, PDBFile &File2,
|
|
T &&OnlyRange1, T &&OnlyRange2,
|
|
StringRef Label) {
|
|
bool HasDiff = false;
|
|
if (!OnlyRange1.empty()) {
|
|
HasDiff = true;
|
|
outs() << formatv(" {0} {1}(s) only in ({2})\n", OnlyRange1.size(), Label,
|
|
File1.getFilePath());
|
|
for (const auto &Item : OnlyRange1)
|
|
outs() << formatv(" {0}\n", Label, Item);
|
|
}
|
|
if (!OnlyRange2.empty()) {
|
|
HasDiff = true;
|
|
outs() << formatv(" {0} {1}(s) only in ({2})\n", OnlyRange2.size(),
|
|
File2.getFilePath());
|
|
for (const auto &Item : OnlyRange2)
|
|
outs() << formatv(" {0}\n", Item);
|
|
}
|
|
return HasDiff;
|
|
}
|
|
|
|
Error DiffStyle::diffSuperBlock() {
|
|
outs() << "MSF Super Block: Searching for differences...\n";
|
|
bool Diffs = false;
|
|
|
|
Diffs |= diffAndPrint("Block Size", File1, File2, File1.getBlockSize(),
|
|
File2.getBlockSize());
|
|
Diffs |= diffAndPrint("Block Count", File1, File2, File1.getBlockCount(),
|
|
File2.getBlockCount());
|
|
Diffs |= diffAndPrint("Unknown 1", File1, File2, File1.getUnknown1(),
|
|
File2.getUnknown1());
|
|
if (!Diffs)
|
|
outs() << "MSF Super Block: No differences detected...\n";
|
|
return Error::success();
|
|
}
|
|
|
|
Error DiffStyle::diffStreamDirectory() {
|
|
SmallVector<std::string, 32> P;
|
|
SmallVector<std::string, 32> Q;
|
|
discoverStreamPurposes(File1, P);
|
|
discoverStreamPurposes(File2, Q);
|
|
outs() << "Stream Directory: Searching for differences...\n";
|
|
|
|
bool HasDifferences = false;
|
|
auto PI = to_vector<32>(enumerate(P));
|
|
auto QI = to_vector<32>(enumerate(Q));
|
|
|
|
typedef decltype(PI) ContainerType;
|
|
typedef typename ContainerType::value_type value_type;
|
|
|
|
auto Comparator = [](const value_type &I1, const value_type &I2) {
|
|
return I1.value() < I2.value();
|
|
};
|
|
|
|
decltype(PI) OnlyP;
|
|
decltype(QI) OnlyQ;
|
|
decltype(PI) Common;
|
|
|
|
set_differences(PI, QI, &OnlyP, &OnlyQ, &Common, Comparator);
|
|
|
|
if (!OnlyP.empty()) {
|
|
HasDifferences = true;
|
|
outs().indent(2) << formatv("{0} Stream(s) only in ({1})\n", OnlyP.size(),
|
|
File1.getFilePath());
|
|
for (auto &Item : OnlyP) {
|
|
outs().indent(4) << formatv("Stream {0} - {1}\n", Item.index(),
|
|
Item.value());
|
|
}
|
|
}
|
|
|
|
if (!OnlyQ.empty()) {
|
|
HasDifferences = true;
|
|
outs().indent(2) << formatv("{0} Streams(s) only in ({1})\n", OnlyQ.size(),
|
|
File2.getFilePath());
|
|
for (auto &Item : OnlyQ) {
|
|
outs().indent(4) << formatv("Stream {0} - {1}\n", Item.index(),
|
|
Item.value());
|
|
}
|
|
}
|
|
if (!Common.empty()) {
|
|
outs().indent(2) << formatv("Found {0} common streams. Searching for "
|
|
"intra-stream differences.\n",
|
|
Common.size());
|
|
bool HasCommonDifferences = false;
|
|
for (const auto &Left : Common) {
|
|
// Left was copied from the first range so its index refers to a stream
|
|
// index in the first file. Find the corresponding stream index in the
|
|
// second file.
|
|
auto Range =
|
|
std::equal_range(QI.begin(), QI.end(), Left,
|
|
[](const value_type &L, const value_type &R) {
|
|
return L.value() < R.value();
|
|
});
|
|
const auto &Right = *Range.first;
|
|
assert(Left.value() == Right.value());
|
|
uint32_t LeftSize = File1.getStreamByteSize(Left.index());
|
|
uint32_t RightSize = File2.getStreamByteSize(Right.index());
|
|
if (LeftSize != RightSize) {
|
|
HasDifferences = true;
|
|
HasCommonDifferences = true;
|
|
outs().indent(4) << formatv("{0} ({1}: {2} bytes, {3}: {4} bytes)\n",
|
|
Left.value(), File1.getFilePath(), LeftSize,
|
|
File2.getFilePath(), RightSize);
|
|
}
|
|
}
|
|
if (!HasCommonDifferences)
|
|
outs().indent(2) << "Common Streams: No differences detected!\n";
|
|
}
|
|
if (!HasDifferences)
|
|
outs() << "Stream Directory: No differences detected!\n";
|
|
|
|
return Error::success();
|
|
}
|
|
|
|
Error DiffStyle::diffStringTable() {
|
|
auto ExpectedST1 = File1.getStringTable();
|
|
auto ExpectedST2 = File2.getStringTable();
|
|
outs() << "String Table: Searching for differences...\n";
|
|
bool Has1 = !!ExpectedST1;
|
|
bool Has2 = !!ExpectedST2;
|
|
if (!(Has1 && Has2)) {
|
|
// If one has a string table and the other doesn't, we can print less
|
|
// output.
|
|
if (Has1 != Has2) {
|
|
if (Has1) {
|
|
outs() << formatv(" {0}: ({1} strings)\n", File1.getFilePath(),
|
|
ExpectedST1->getNameCount());
|
|
outs() << formatv(" {0}: (string table not present)\n",
|
|
File2.getFilePath());
|
|
} else {
|
|
outs() << formatv(" {0}: (string table not present)\n",
|
|
File1.getFilePath());
|
|
outs() << formatv(" {0}: ({1})\n", File2.getFilePath(),
|
|
ExpectedST2->getNameCount());
|
|
}
|
|
}
|
|
consumeError(ExpectedST1.takeError());
|
|
consumeError(ExpectedST2.takeError());
|
|
return Error::success();
|
|
}
|
|
|
|
bool HasDiff = false;
|
|
auto &ST1 = *ExpectedST1;
|
|
auto &ST2 = *ExpectedST2;
|
|
|
|
if (ST1.getByteSize() != ST2.getByteSize()) {
|
|
outs() << " Stream Size\n";
|
|
outs() << formatv(" {0} - {1} byte(s)\n", File1.getFilePath(),
|
|
ST1.getByteSize());
|
|
outs() << formatv(" {0} - {1} byte(s)\n", File2.getFilePath(),
|
|
ST2.getByteSize());
|
|
outs() << formatv(" Difference: {0} bytes\n",
|
|
AbsoluteDifference(ST1.getByteSize(), ST2.getByteSize()));
|
|
HasDiff = true;
|
|
}
|
|
HasDiff |= diffAndPrint("Hash Version", File1, File2, ST1.getHashVersion(),
|
|
ST1.getHashVersion());
|
|
HasDiff |= diffAndPrint("Signature", File1, File2, ST1.getSignature(),
|
|
ST1.getSignature());
|
|
|
|
// Both have a valid string table, dive in and compare individual strings.
|
|
|
|
auto IdList1 = ST1.name_ids();
|
|
auto IdList2 = ST2.name_ids();
|
|
std::vector<StringRef> Strings1, Strings2;
|
|
Strings1.reserve(IdList1.size());
|
|
Strings2.reserve(IdList2.size());
|
|
for (auto ID : IdList1) {
|
|
auto S = ST1.getStringForID(ID);
|
|
if (!S)
|
|
return S.takeError();
|
|
Strings1.push_back(*S);
|
|
}
|
|
for (auto ID : IdList2) {
|
|
auto S = ST2.getStringForID(ID);
|
|
if (!S)
|
|
return S.takeError();
|
|
Strings2.push_back(*S);
|
|
}
|
|
|
|
SmallVector<StringRef, 64> OnlyP;
|
|
SmallVector<StringRef, 64> OnlyQ;
|
|
auto End1 = std::remove(Strings1.begin(), Strings1.end(), "");
|
|
auto End2 = std::remove(Strings2.begin(), Strings2.end(), "");
|
|
uint32_t Empty1 = std::distance(End1, Strings1.end());
|
|
uint32_t Empty2 = std::distance(End2, Strings2.end());
|
|
Strings1.erase(End1, Strings1.end());
|
|
Strings2.erase(End2, Strings2.end());
|
|
set_differences(Strings1, Strings2, &OnlyP, &OnlyQ);
|
|
printSymmetricDifferences(File1, File2, OnlyP, OnlyQ, "String");
|
|
|
|
if (Empty1 != Empty2) {
|
|
PDBFile &MoreF = (Empty1 > Empty2) ? File1 : File2;
|
|
PDBFile &LessF = (Empty1 < Empty2) ? File1 : File2;
|
|
uint32_t Difference = AbsoluteDifference(Empty1, Empty2);
|
|
outs() << formatv(" {0} had {1} more empty strings than {2}\n",
|
|
MoreF.getFilePath(), Difference, LessF.getFilePath());
|
|
}
|
|
if (!HasDiff)
|
|
outs() << "String Table: No differences detected!\n";
|
|
return Error::success();
|
|
}
|
|
|
|
Error DiffStyle::diffFreePageMap() { return Error::success(); }
|
|
|
|
Error DiffStyle::diffInfoStream() {
|
|
auto ExpectedInfo1 = File1.getPDBInfoStream();
|
|
auto ExpectedInfo2 = File2.getPDBInfoStream();
|
|
|
|
outs() << "PDB Stream: Searching for differences...\n";
|
|
bool Has1 = !!ExpectedInfo1;
|
|
bool Has2 = !!ExpectedInfo2;
|
|
if (!(Has1 && Has2)) {
|
|
if (Has1 != Has2)
|
|
outs() << formatv("{0} does not have a PDB Stream!\n",
|
|
Has1 ? File1.getFilePath() : File2.getFilePath());
|
|
consumeError(ExpectedInfo2.takeError());
|
|
consumeError(ExpectedInfo2.takeError());
|
|
return Error::success();
|
|
}
|
|
|
|
bool HasDiff = false;
|
|
auto &IS1 = *ExpectedInfo1;
|
|
auto &IS2 = *ExpectedInfo2;
|
|
if (IS1.getStreamSize() != IS2.getStreamSize()) {
|
|
outs() << " Stream Size\n";
|
|
outs() << formatv(" {0} - {1} byte(s)\n", File1.getFilePath(),
|
|
IS1.getStreamSize());
|
|
outs() << formatv(" {0} - {1} byte(s)\n", File2.getFilePath(),
|
|
IS2.getStreamSize());
|
|
outs() << formatv(
|
|
" Difference: {0} bytes\n",
|
|
AbsoluteDifference(IS1.getStreamSize(), IS2.getStreamSize()));
|
|
HasDiff = true;
|
|
}
|
|
HasDiff |= diffAndPrint("Age", File1, File2, IS1.getAge(), IS2.getAge());
|
|
HasDiff |= diffAndPrint("Guid", File1, File2, IS1.getGuid(), IS2.getGuid());
|
|
HasDiff |= diffAndPrint("Signature", File1, File2, IS1.getSignature(),
|
|
IS2.getSignature());
|
|
HasDiff |=
|
|
diffAndPrint("Version", File1, File2, IS1.getVersion(), IS2.getVersion());
|
|
HasDiff |= diffAndPrint("Features", File1, File2, IS1.getFeatureSignatures(),
|
|
IS2.getFeatureSignatures());
|
|
HasDiff |= diffAndPrint("Named Stream Byte Size", File1, File2,
|
|
IS1.getNamedStreamMapByteSize(),
|
|
IS2.getNamedStreamMapByteSize());
|
|
SmallVector<StringRef, 4> NS1;
|
|
SmallVector<StringRef, 4> NS2;
|
|
for (const auto &X : IS1.getNamedStreams().entries())
|
|
NS1.push_back(X.getKey());
|
|
for (const auto &X : IS2.getNamedStreams().entries())
|
|
NS2.push_back(X.getKey());
|
|
SmallVector<StringRef, 4> OnlyP;
|
|
SmallVector<StringRef, 4> OnlyQ;
|
|
set_differences(NS1, NS2, &OnlyP, &OnlyQ);
|
|
printSymmetricDifferences(File1, File2, OnlyP, OnlyQ, "Named Streams");
|
|
if (!HasDiff)
|
|
outs() << "PDB Stream: No differences detected!\n";
|
|
|
|
return Error::success();
|
|
}
|
|
|
|
Error DiffStyle::diffDbiStream() { return Error::success(); }
|
|
|
|
Error DiffStyle::diffSectionContribs() { return Error::success(); }
|
|
|
|
Error DiffStyle::diffSectionMap() { return Error::success(); }
|
|
|
|
Error DiffStyle::diffFpoStream() { return Error::success(); }
|
|
|
|
Error DiffStyle::diffTpiStream(int Index) { return Error::success(); }
|
|
|
|
Error DiffStyle::diffModuleInfoStream(int Index) { return Error::success(); }
|
|
|
|
Error DiffStyle::diffPublics() { return Error::success(); }
|
|
|
|
Error DiffStyle::diffGlobals() { return Error::success(); }
|