Add verbose printing of line info in LLVM Symbolizer

[sque]

Summary

The verbose mode prints out all the fields of DILineInfo in human-readable form.

Verbose mode is enabled by a command-line switch "-verbose" that is off by default. Example:

With verbose flag:

sque@sque3:~/code/llvm-build$ bin/llvm-symbolizer -obj bin/llvm-symbolizer -verbose
0x414edf
isWhitespace(char)
  Filename: /usr/local/google/home/sque/code/llvm/lib/Support/CommandLine.cpp
  Line: 702
  Column: 0
  Discriminator: 0

Without verbose flag:

sque@sque3:~/code/llvm-build$ bin/llvm-symbolizer -obj bin/llvm-symbolizer
0x414edf
isWhitespace(char)
/usr/local/google/home/sque/code/llvm/lib/Support/CommandLine.cpp:702:0

[sque]

lib/DebugInfo/Symbolize/DIPrinter.cpp

85 ↗

(On Diff #85623)

Should this be marked as DWARF-only, or placed in a DWARF-only section?

[dblaikie]

Needs test coverage

lib/DebugInfo/Symbolize/DIPrinter.cpp

85 ↗

(On Diff #85623)

I'm /guessing/ (though you can probably reproduce this by running -verbose on a checked in COFF/CodeView file - I assume/imagine we have some of those in the dumper testing) that the Discriminator is 0 when not provided?

Perhaps it'd be easy enough to not print it when it's zero? If that works/you can confirm CodeView is doing what I assume it is - add a test? (for either CV, or a case a zero or not present discriminator in ELF).

[sque]

lib/DebugInfo/Symbolize/DIPrinter.cpp

85 ↗

(On Diff #85623)

I am not familiar with possible values of the discriminator. Does discriminator == 0 mean it's invalid? Could it have a valid value of 0?

[sque]

Print discriminator only if nonzero; Add regression test

[dblaikie]

Looks good - thanks!

If the test case be reduced any before committing, that'd be great.

lib/DebugInfo/Symbolize/DIPrinter.cpp

81–91 ↗

(On Diff #86237)

To reduce indentation, invert the condition and return early:

if (!Verbose) {
  OS << ...
  printContext(...);
  return;
}
OS << ...

Maybe that doesn't help - anyway, an idea if you like it (LLVM tends towards finding ways to reduce indentation like that, but it doesn't necessarily improve readability in all cases)

test/tools/llvm-symbolizer/Inputs/discrim.inp

2–8 ↗

(On Diff #86237)

Are these all interesting addresses to test - I'd have expected one zero discriminator and one non-zero would suffice?

[sque]

Adjusted logic for indentation; Reduced number of addresses to test

[sque]

I don't have commit access. I need someone to commit this for me.

[sque]

The new files didn't get committed.

llvm/trunk/include/llvm/DebugInfo/Symbolize/DIPrinter.h

 
 namespace symbolize {
 
 class DIPrinter {
   raw_ostream &OS;
   bool PrintFunctionNames;
   bool PrintPretty;
   int PrintSourceContext;
+  bool Verbose;
 
   void print(const DILineInfo &Info, bool Inlined);
   void printContext(const std::string &FileName, int64_t Line);
 
 public:
   DIPrinter(raw_ostream &OS, bool PrintFunctionNames = true,
-            bool PrintPretty = false, int PrintSourceContext = 0)
+            bool PrintPretty = false, int PrintSourceContext = 0,
+            bool Verbose = false)
       : OS(OS), PrintFunctionNames(PrintFunctionNames),
-        PrintPretty(PrintPretty), PrintSourceContext(PrintSourceContext) {}
+        PrintPretty(PrintPretty), PrintSourceContext(PrintSourceContext),
+        Verbose(Verbose) {}
 
   DIPrinter &operator<<(const DILineInfo &Info);
   DIPrinter &operator<<(const DIInliningInfo &Info);
   DIPrinter &operator<<(const DIGlobal &Global);
 };
 }
 }
 
 #endif
 

llvm/trunk/lib/DebugInfo/Symbolize/DIPrinter.cpp

if (PrintFunctionNames) {
 
     StringRef Delimiter = PrintPretty ? " at " : "\n";
     StringRef Prefix = (PrintPretty && Inlined) ? " (inlined by) " : "";
     OS << Prefix << FunctionName << Delimiter;
   }
   std::string Filename = Info.FileName;
   if (Filename == kDILineInfoBadString)
     Filename = kBadString;
+  if (!Verbose) {
     OS << Filename << ":" << Info.Line << ":" << Info.Column << "\n";
     printContext(Filename, Info.Line);
+    return;
+  }
+  OS << "  Filename: " << Filename << "\n";
+  OS << "  Line: " << Info.Line << "\n";
+  OS << "  Column: " << Info.Column << "\n";
+  if (Info.Discriminator)
+    OS << "  Discriminator: " << Info.Discriminator << "\n";
 }
 
 DIPrinter &DIPrinter::operator<<(const DILineInfo &Info) {
   print(Info, false);
   return *this;
 }
 
 DIPrinter &DIPrinter::operator<<(const DIInliningInfo &Info) {

llvm/trunk/tools/llvm-symbolizer/llvm-symbolizer.cpp

 static cl::opt<bool>
     ClPrettyPrint("pretty-print", cl::init(false),
                   cl::desc("Make the output more human friendly"));
 
 static cl::opt<int> ClPrintSourceContextLines(
     "print-source-context-lines", cl::init(0),
     cl::desc("Print N number of source file context"));
 
+static cl::opt<bool> ClVerbose("verbose", cl::init(false),
+                               cl::desc("Print verbose line info"));
+
 template<typename T>
 static bool error(Expected<T> &ResOrErr) {
   if (ResOrErr)
     return false;
   logAllUnhandledErrors(ResOrErr.takeError(), errs(),
                         "LLVMSymbolizer: error reading file: ");
   return true;
 }
for (const auto &hint : ClDsymHint) {
     } else {
       errs() << "Warning: invalid dSYM hint: \"" << hint <<
                 "\" (must have the '.dSYM' extension).\n";
     }
   }
   LLVMSymbolizer Symbolizer(Opts);
 
   DIPrinter Printer(outs(), ClPrintFunctions != FunctionNameKind::None,
-                    ClPrettyPrint, ClPrintSourceContextLines);
+                    ClPrettyPrint, ClPrintSourceContextLines, ClVerbose);
 
   const int kMaxInputStringLength = 1024;
   char InputString[kMaxInputStringLength];
 
   while (true) {
     if (!fgets(InputString, sizeof(InputString), stdin))
       break;