[llvm-pdbutil] Improve diff mode.

We're getting to the point that some MS tools (e.g. DIA) can recognize
our PDBs but others (e.g. link.exe) cannot. I think the way forward is
to improve our tooling to help us find differences more easily. For
example, if we can compile the same program with clang-cl and cl and
have a tool tell us all the places where the PDBs differ, this could
tell us what we're doing wrong. It's tricky though, because there are a
lot of "benign" differences in a PDB. For example, if the string table
in one PDB consists of "foo" followed by "bar" and in the other PDB it
consists of "bar" followed by "foo", this is not necessarily a critical
difference, as long as the uses of these strings also refer to the
correct location. On the other hand, if the second PDB doesn't even
contain the string "foo" at all, this is a critical difference.

diff mode has been in llvm-pdbutil for quite a while, but because of the
above challenge along with some others, it's been hard to make it
useful. I think this patch addresses that. It looks for all the same
things, but it now prints the output in tabular format (carefully
formatted and aligned into tables and fields), and it highlights
critical differences in red, non-critical differences in yellow, and
identical fields in green.  This makes it easy to spot the places we
differ, and the general concept of outputting arbitrary fields in
tabular format can be extended to provide analysis into many of the
different types of information that show up in a PDB.

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

llvm-svn: 307421

1 files changed, 106 insertions, 0 deletions

diff --git a/llvm/tools/llvm-pdbutil/DiffPrinter.cpp b/llvm/tools/llvm-pdbutil/DiffPrinter.cpp
new file mode 100644
index 00000000000..b608d54d0e2
--- /dev/null
+++ b/llvm/tools/llvm-pdbutil/DiffPrinter.cpp
@@ -0,0 +1,106 @@
+
+#include "DiffPrinter.h"
+
+#include "llvm/Support/FormatAdapters.h"
+
+using namespace llvm;
+using namespace llvm::pdb;
+
+static void setColor(llvm::raw_ostream &OS, DiffResult Result) {
+  switch (Result) {
+  case DiffResult::IDENTICAL:
+    OS.changeColor(raw_ostream::Colors::GREEN, false);
+    break;
+  case DiffResult::EQUIVALENT:
+    OS.changeColor(raw_ostream::Colors::YELLOW, true);
+    break;
+  default:
+    OS.changeColor(raw_ostream::Colors::RED, false);
+    break;
+  }
+}
+
+DiffPrinter::DiffPrinter(uint32_t Indent, StringRef Header,
+                         uint32_t PropertyWidth, uint32_t FieldWidth,
+                         raw_ostream &Stream)
+    : Indent(Indent), PropertyWidth(PropertyWidth), FieldWidth(FieldWidth),
+      OS(Stream) {
+  printHeaderRow();
+  printFullRow(Header);
+}
+
+DiffPrinter::~DiffPrinter() {}
+
+void DiffPrinter::printFullRow(StringRef Text) {
+  newLine();
+  printField(Text, DiffResult::UNSPECIFIED, AlignStyle::Center,
+             PropertyWidth + 1 + FieldWidth + 1 + FieldWidth);
+  printSeparatorRow();
+}
+
+void DiffPrinter::printSeparatorRow() {
+  newLine();
+  OS << formatv("{0}", fmt_repeat('-', PropertyWidth));
+  OS << '+';
+  OS << formatv("{0}", fmt_repeat('-', FieldWidth));
+  OS << '+';
+  OS << formatv("{0}", fmt_repeat('-', FieldWidth));
+  OS << '|';
+}
+
+void DiffPrinter::printHeaderRow() {
+  newLine('-');
+  OS << formatv("{0}", fmt_repeat('-', PropertyWidth + 2 * FieldWidth + 3));
+}
+
+void DiffPrinter::newLine(char InitialChar) {
+  OS << "\n";
+  OS.indent(Indent) << InitialChar;
+}
+
+void DiffPrinter::printExplicit(StringRef Property, DiffResult C,
+                                StringRef Left, StringRef Right) {
+  newLine();
+  printField(Property, DiffResult::UNSPECIFIED, AlignStyle::Right,
+             PropertyWidth);
+  printField(Left, C, AlignStyle::Center, FieldWidth);
+  printField(Right, C, AlignStyle::Center, FieldWidth);
+  printSeparatorRow();
+}
+
+void DiffPrinter::printSame(StringRef Property, StringRef Value) {
+  newLine();
+  printField(Property, DiffResult::UNSPECIFIED, AlignStyle::Right,
+             PropertyWidth);
+  printField(Value, DiffResult::IDENTICAL, AlignStyle::Center,
+             FieldWidth + 1 + FieldWidth);
+  printSeparatorRow();
+}
+
+void DiffPrinter::printDifferent(StringRef Property, StringRef Left,
+                                 StringRef Right) {
+  newLine();
+  printField(Property, DiffResult::UNSPECIFIED, AlignStyle::Right,
+             PropertyWidth);
+  printField(Left, DiffResult::DIFFERENT, AlignStyle::Center, FieldWidth);
+  printField(Right, DiffResult::DIFFERENT, AlignStyle::Center, FieldWidth);
+  printSeparatorRow();
+}
+
+void DiffPrinter::printField(StringRef Value, DiffResult C, AlignStyle Style,
+                             uint32_t Width) {
+  if (Style == AlignStyle::Right)
+    --Width;
+
+  std::string FormattedItem =
+      formatv("{0}", fmt_align(Value, Style, Width)).str();
+  if (C != DiffResult::UNSPECIFIED) {
+    setColor(OS, C);
+    OS << FormattedItem;
+    OS.resetColor();
+  } else
+    OS << FormattedItem;
+  if (Style == AlignStyle::Right)
+    OS << ' ';
+  OS << '|';
+}