[llvm-symbolizer] Print out non-address lines verbatim.

[aizatsky]

nits & test

[kcc]

Makes sense.
Can you also update http://llvm.org/docs/CommandGuide/llvm-symbolizer.html ?

[samsonov]

Out of curiosity, why do you need this? What is addr2line behavior for non-address lines?

tools/llvm-symbolizer/llvm-symbolizer.cpp

93 ↗

(On Diff #43942)

Argument should at least be const char*, and go before output parameters. Or make it a StringRef.

[aizatsky]

review

[aizatsky]

Out of curiosity, why do you need this?

To be able to pipe a complicate output through symbolizer. E.g. fuzzers can print out coverage addresses.

What is addr2line behavior for non-address lines?

I don't think addr2line behavior is relevant here. This is not addr2line, right?

addr2line is not smart at all:

$ echo "hello" | addr2line -e /usr/bin/addr2line
??:0

[aizatsky]

Can you also update http://llvm.org/docs/CommandGuide/llvm-symbolizer.html ?

done

[samsonov]

LGTM, but please address comments.

tools/llvm-symbolizer/llvm-symbolizer.cpp

92 ↗

(On Diff #44275)

Pass StringRef by value.

100 ↗

(On Diff #44275)

So, once we have StringRef, let's use its methods instead of a C string functions.
We have a bunch of them: startswith, drop_front, ltrim, find_first_not_of etc.
This can be done in a follow-up commit, but please do so.

170 ↗

(On Diff #44275)

Reduce the indentation:

if (!parseCommand(...)) {
  outs() << InputString;
  continue;
}
// existing code

[aizatsky]

review

[aizatsky]

thanks. submitting.

tools/llvm-symbolizer/llvm-symbolizer.cpp

100 ↗

(On Diff #44275)

I suggest we do this later. I don't see a point in this rewrite now.

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

 llvm-symbolizer - convert addresses into source code locations
 ==============================================================
 
 SYNOPSIS
 --------
 
 :program:`llvm-symbolizer` [options]
 
 DESCRIPTION
 -----------
 
 :program:`llvm-symbolizer` reads object file names and addresses from standard
 input and prints corresponding source code locations to standard output.
-If object file is specified in command line, :program:`llvm-symbolizer` reads
-only addresses from standard input. This
-program uses debug info sections and symbol table in the object files.
+If object file is specified in command line, :program:`llvm-symbolizer` 
+processes only addresses from standard input, the rest is output verbatim.
+This program uses debug info sections and symbol table in the object files.
 
 EXAMPLE
 --------
 
 .. code-block:: console
 
   $ cat addr.txt
   a.out 0x4004f4

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

+some text
 0x40054d
+some text2

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

 #  return inc(&x);
 #}
 #
 #Build as : clang -g -O2 addr.c
 
 RUN: llvm-symbolizer -print-address -obj=%p/Inputs/addr.exe < %p/Inputs/addr.inp | FileCheck %s
 RUN: llvm-symbolizer -inlining -print-address -pretty-print -obj=%p/Inputs/addr.exe < %p/Inputs/addr.inp | FileCheck --check-prefix="PRETTY" %s 
 
+#CHECK: some text
 #CHECK: 0x40054d
 #CHECK: main
 #CHECK: {{[/\]+}}tmp{{[/\]+}}x.c:14:0
+#CHECK: some text2
 #
+#PRETTY: some text
 #PRETTY: {{[0x]+}}40054d: inctwo at {{[/\]+}}tmp{{[/\]+}}x.c:3:3
 #PRETTY:  (inlined by) inc at {{[/\]+}}tmp{{[/\]+}}x.c:7:0
 #PRETTY   (inlined by) main at {{[/\]+}}tmp{{[/\]+}}x.c:14:0
+#PRETTY: some text2
 

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

 
 static bool error(std::error_code ec) {
   if (!ec)
     return false;
   errs() << "LLVMSymbolizer: error reading file: " << ec.message() << ".\n";
   return true;
 }
 
-static bool parseCommand(bool &IsData, std::string &ModuleName,
-                         uint64_t &ModuleOffset) {
+static bool parseCommand(StringRef InputString, 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];
-  if (!fgets(InputString, sizeof(InputString), stdin))
-    return false;
+  const char kDelimiters[] = " \n\r";
   IsData = false;
   ModuleName = "";
-  char *pos = InputString;
+  const char *pos = InputString.data();
   if (strncmp(pos, kDataCmd, strlen(kDataCmd)) == 0) {
     IsData = true;
     pos += strlen(kDataCmd);
   } else if (strncmp(pos, kCodeCmd, strlen(kCodeCmd)) == 0) {
     IsData = false;
     pos += strlen(kCodeCmd);
   } else {
     // If no cmd, assume it's CODE.
     IsData = false;
   }
   // Skip delimiters and parse input filename (if needed).
   if (ClBinaryName == "") {
     pos += strspn(pos, kDelimiters);
     if (*pos == '"' || *pos == '\'') {
       char quote = *pos;
       pos++;
-      char *end = strchr(pos, quote);
+      const char *end = strchr(pos, quote);
       if (!end)
         return false;
       ModuleName = std::string(pos, end - pos);
       pos = end + 1;
     } else {
       int name_length = strcspn(pos, kDelimiters);
       ModuleName = std::string(pos, name_length);
       pos += name_length;
if (sys::path::extension(hint) == ".dSYM") {
       Opts.DsymHints.push_back(hint);
     } else {
       errs() << "Warning: invalid dSYM hint: \"" << hint <<
                 "\" (must have the '.dSYM' extension).\n";
     }
   }
   LLVMSymbolizer Symbolizer(Opts);
 
-  bool IsData = false;
-  std::string ModuleName;
-  uint64_t ModuleOffset;
   DIPrinter Printer(outs(), ClPrintFunctions != FunctionNameKind::None,
                     ClPrettyPrint);
 
-  while (parseCommand(IsData, ModuleName, ModuleOffset)) {
+  const int kMaxInputStringLength = 1024;
+  char InputString[kMaxInputStringLength];
+
+  while (true) {
+    if (!fgets(InputString, sizeof(InputString), stdin))
+      break;
+
+    bool IsData = false;
+    std::string ModuleName;
+    uint64_t ModuleOffset = 0;
+    if (!parseCommand(StringRef(InputString), IsData, ModuleName,
+                      ModuleOffset)) {
+      outs() << InputString;
+      continue;
+    }
+
     if (ClPrintAddress) {
       outs() << "0x";
       outs().write_hex(ModuleOffset);
       StringRef Delimiter = (ClPrettyPrint == true) ? ": " : "\n";
       outs() << Delimiter;
     }
     if (IsData) {
       auto ResOrErr = Symbolizer.symbolizeData(ModuleName, ModuleOffset);