[xray] add --symbolize-mangled cli opt for llvm-xray extract to output mangled names

[johnislarry]

Summary

This adds an additional cli flag for the llvm-xray extract tool. This is useful if you're more interested in consuming the mangled symbol name, instead of the default now which is demangled.

Test Plan: ninja check-llvm

[dblaikie]

The usual "naming of things" - are there flags with similar functionality in other tools (like llvm-symbolizer) that might provide inspiration for consistent naming here (perhaps the name you've chosen already was inspired by that)?

llvm/tools/llvm-xray/xray-extract.cpp

93–95

Usually LLVM code skips {} on single statement blocks.

[johnislarry]

Thanks @dblaikie - I fixed the curly braces, and decided to go with --no-demangle, which llvm-symbolizer happens to use, and which seems more standard

[dblaikie]

Looks good -t hanks!

[johnislarry]

Thanks @dblaikie! I don't have commit access so I believe that means I can't commit this directly. I'd appreciate it if you or anyone else could do that on my behalf!

llvm/test/tools/llvm-xray/AArch64/extract-instrmap-aarch64-mangled.test

+This test makes sure we can extract the instrumentation map from an
+XRay-instrumented PIE file.
+
+RUN: yaml2obj %S/Inputs/elf64-pic.yaml -o %t.so
+RUN: llvm-xray extract -s --no-demangle %t.so | FileCheck %s
+
+CHECK:      ---
+CHECK-NEXT: - { id: 1, address: 0x0000000000000420, function: 0x0000000000000420, kind: function-enter, always-instrument: true, function-name: _Z3foov }
+CHECK-NEXT: - { id: 1, address: 0x0000000000000440, function: 0x0000000000000420, kind: function-exit, always-instrument: true, function-name: _Z3foov }
+CHECK-NEXT: - { id: 2, address: 0x0000000000000464, function: 0x0000000000000464, kind: function-enter, always-instrument: true, function-name: _Z3barv }
+CHECK-NEXT: - { id: 2, address: 0x0000000000000484, function: 0x0000000000000464, kind: function-exit, always-instrument: true, function-name: _Z3barv }
+CHECK-NEXT: - { id: 3, address: 0x00000000000004A8, function: 0x00000000000004A8, kind: function-enter, always-instrument: true, function-name: _Z3jarv }
+CHECK-NEXT: - { id: 3, address: 0x00000000000004C8, function: 0x00000000000004A8, kind: function-exit, always-instrument: true, function-name: _Z3jarv }
+CHECK-NEXT: ...

llvm/tools/llvm-xray/xray-extract.cpp

 static cl::alias ExtractOutput2("o", cl::aliasopt(ExtractOutput),
                                 cl::desc("Alias for -output"));
 static cl::opt<bool> ExtractSymbolize("symbolize", cl::value_desc("symbolize"),
                                       cl::init(false),
                                       cl::desc("symbolize functions"),
                                       cl::sub(Extract));
 static cl::alias ExtractSymbolize2("s", cl::aliasopt(ExtractSymbolize),
                                    cl::desc("alias for -symbolize"));
+static cl::opt<bool> ExtractNoDemangle("no-demangle",
+                                       cl::value_desc("no-demangle"),
+                                       cl::init(false),
+                                       cl::desc("don't demangle symbols"),
+                                       cl::sub(Extract));
 
 namespace {
 
 void exportAsYAML(const InstrumentationMap &Map, raw_ostream &OS,
                   FuncIdConversionHelper &FH) {
   // First we translate the sleds into the YAMLXRaySledEntry objects in a deque.
   std::vector<YAMLXRaySledEntry> YAMLSleds;
   auto Sleds = Map.sleds();
static CommandRegistration Unused(&Extract, []() -> Error {
 
   std::error_code EC;
   raw_fd_ostream OS(ExtractOutput, EC, sys::fs::OpenFlags::OF_Text);
   if (EC)
     return make_error<StringError>(
         Twine("Cannot open file '") + ExtractOutput + "' for writing.", EC);
   const auto &FunctionAddresses =
       InstrumentationMapOrError->getFunctionAddresses();
-  symbolize::LLVMSymbolizer Symbolizer;
+  symbolize::LLVMSymbolizer::Options opts;
+  if (ExtractNoDemangle)
+    opts.Demangle = false;
+  symbolize::LLVMSymbolizer Symbolizer(opts);
   llvm::xray::FuncIdConversionHelper FuncIdHelper(ExtractInput, Symbolizer,
                                                   FunctionAddresses);
   exportAsYAML(*InstrumentationMapOrError, OS, FuncIdHelper);
   return Error::success();
 });