Add -address option to symbolizer

[khemant]

Summary

When llvm-symbolizer is passed a list of address, its nice to have an option which will print address corresponding line information. This improves human readability.

[samsonov]

Please see http://llvm.org/docs/Phabricator.html on how to upload patches with more context.

I don't understand why you need to pass the value of "-address" option down to LLVMSymbolizer class - you can just handle it inside main(). I would also prefer option name to be more verbose like "-print-address".

[samsonov]

test/tools/llvm-symbolizer/addr.test

1 ↗

(On Diff #36755)

Where did you get addr.exe from? I'd prefer to either use existing executable file, or commit the source file with description of build procedure. (the former is better).

[khemant]

You are right. I did not pay much attention to the driver.

[khemant]

Option is handled inside main. Source is present as comment in test case.

[samsonov]

LGTM

test/tools/llvm-symbolizer/sym.test

18 ↗

(On Diff #36980)

Please watch the Windows bots after the commit - you may need to relax slashes into "slash or backslash" here.

llvm/trunk/docs/CommandGuide/llvm-symbolizer.rst

  address will not be symbolized. Defaults to empty string.
 
 .. option:: -dsym-hint=<path/to/file.dSYM>
 
  (Darwin-only flag). If the debug info for a binary isn't present in the default
  location, look for the debug info at the .dSYM path provided via the
  ``-dsym-hint`` flag. This flag can be used multiple times.
 
+.. option:: -print-address
+ Print address before the source code location. Defaults to false.
 
 EXIT STATUS
 -----------
 
 :program:`llvm-symbolizer` returns 0. Other exit codes imply internal program error.

llvm/trunk/test/tools/llvm-symbolizer/Inputs/addr.inp

+0x40054d

llvm/trunk/test/tools/llvm-symbolizer/sym.test

+#Source:
+##include <stdio.h>
+#static inline int inc (int *a) {
+#  printf ("%d\n",(*a)++);
+#  return (*a)++;
+#}
+#
+#int main () {
+#  int x = 1;
+#  return inc(&x);
+#}
+#Build as : clang -g -O2 addr.c
+
+RUN: llvm-symbolizer -inlining -print-address -obj=%p/Inputs/addr.exe < %p/Inputs/addr.inp | FileCheck %s
+
+#CHECK: 0x40054d
+#CHECK: main
+#CHECK: {{[/\]+}}tmp{{[/\]+}}x.c:9:0
+

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

 ClBinaryName("obj", cl::init(""),
              cl::desc("Path to object file to be symbolized (if not provided, "
                       "object file should be specified for each input line)"));
 
 static cl::list<std::string>
 ClDsymHint("dsym-hint", cl::ZeroOrMore,
            cl::desc("Path to .dSYM bundles to search for debug info for the "
                     "object files"));
+static cl::opt<bool>
+    ClPrintAddress("print-address", cl::init(false),
+                   cl::desc("Show address before line information"));
 
 static bool parseCommand(bool &IsData, std::string &ModuleName,
                          uint64_t &ModuleOffset) {
   const char *kDataCmd = "DATA ";
   const char *kCodeCmd = "CODE ";
   const int kMaxInputStringLength = 1024;
   const char kDelimiters[] = " \n";
   char InputString[kMaxInputStringLength];
int main(int argc, char **argv) {
 
   bool IsData = false;
   std::string ModuleName;
   uint64_t ModuleOffset;
   while (parseCommand(IsData, ModuleName, ModuleOffset)) {
     std::string Result =
         IsData ? Symbolizer.symbolizeData(ModuleName, ModuleOffset)
                : Symbolizer.symbolizeCode(ModuleName, ModuleOffset);
+    if (ClPrintAddress) {
+      outs() << "0x";
+      outs().write_hex(ModuleOffset);
+      outs() << "\n";
+    }
     outs() << Result << "\n";
     outs().flush();
   }
 
   return 0;
 }