From e144ae54dcb96838a6176fd9eef21028935ccd4f Mon Sep 17 00:00:00 2001 From: Serge Pavlov Date: Mon, 3 Apr 2023 23:28:50 +0700 Subject: [PATCH] [symbolizer] Support symbol lookup Recent versions of GNU binutils starting from 2.39 support symbol+offset lookup in addition to the usual numeric address lookup. This change adds symbol lookup to llvm-symbolize and llvm-addr2line. Now llvm-symbolize behaves closer to GNU addr2line, - if the value specified as address in command line or input stream is not a number, it is treated as a symbol name. For example: llvm-symbolize --obj=abc.so func_22 llvm-symbolize --obj=abc.so "CODE func_22" This lookup is now supported only for functions. Specification with offset is not supported yet. This is a recommit of 2b27948783e4bbc1132d3220d8517ef62607b558, reverted in 39fec5457c0925bd39f67f63fe17391584e08258 because the test llvm/test/Support/interrupts.test started failing on Windows. The test was changed in 18f036d0105589c3175bb51a518c5d272dae61e2 and is also updated in this commit. Differential Revision: https://reviews.llvm.org/D149759 --- llvm/docs/CommandGuide/llvm-symbolizer.rst | 13 +++- llvm/docs/ReleaseNotes.rst | 2 + .../llvm/DebugInfo/Symbolize/DIPrinter.h | 7 ++ .../DebugInfo/Symbolize/SymbolizableModule.h | 3 + .../Symbolize/SymbolizableObjectFile.h | 2 + .../llvm/DebugInfo/Symbolize/Symbolize.h | 11 +++ llvm/lib/DebugInfo/Symbolize/DIPrinter.cpp | 26 +++++++ .../Symbolize/SymbolizableObjectFile.cpp | 13 ++++ llvm/lib/DebugInfo/Symbolize/Symbolize.cpp | 44 ++++++++++++ llvm/test/Support/interrupts.test | 5 +- .../tools/llvm-symbolizer/Inputs/addr.inp | 4 +- .../tools/llvm-symbolizer/Inputs/discrim.inp | 2 +- .../tools/llvm-symbolizer/Inputs/symbols.h | 19 +++++ .../llvm-symbolizer/Inputs/symbols.part1.cpp | 25 +++++++ .../llvm-symbolizer/Inputs/symbols.part2.cpp | 18 +++++ .../llvm-symbolizer/Inputs/symbols.part3.c | 12 ++++ .../llvm-symbolizer/Inputs/symbols.part4.c | 13 ++++ .../tools/llvm-symbolizer/Inputs/symbols.so | Bin 0 -> 19496 bytes .../output-style-json-code.test | 21 +++--- .../output-style-json-data.test | 4 +- .../output-style-json-frame.ll | 4 +- .../tools/llvm-symbolizer/symbol-search.test | 65 ++++++++++++++++++ .../tools/llvm-symbolizer/llvm-symbolizer.cpp | 58 +++++++++------- llvm/unittests/ProfileData/MemProfTest.cpp | 4 ++ 24 files changed, 333 insertions(+), 42 deletions(-) create mode 100644 llvm/test/tools/llvm-symbolizer/Inputs/symbols.h create mode 100644 llvm/test/tools/llvm-symbolizer/Inputs/symbols.part1.cpp create mode 100644 llvm/test/tools/llvm-symbolizer/Inputs/symbols.part2.cpp create mode 100644 llvm/test/tools/llvm-symbolizer/Inputs/symbols.part3.c create mode 100644 llvm/test/tools/llvm-symbolizer/Inputs/symbols.part4.c create mode 100755 llvm/test/tools/llvm-symbolizer/Inputs/symbols.so create mode 100644 llvm/test/tools/llvm-symbolizer/symbol-search.test diff --git a/llvm/docs/CommandGuide/llvm-symbolizer.rst b/llvm/docs/CommandGuide/llvm-symbolizer.rst index fe5df077b45664d..59c0ab6d196ace1 100644 --- a/llvm/docs/CommandGuide/llvm-symbolizer.rst +++ b/llvm/docs/CommandGuide/llvm-symbolizer.rst @@ -14,7 +14,7 @@ DESCRIPTION :program:`llvm-symbolizer` reads input names and addresses from the command-line and prints corresponding source code locations to standard output. It can also symbolize logs containing :doc:`Symbolizer Markup ` via -:option:`--filter-markup`. +:option:`--filter-markup`. Addresses may be specified as numbers or symbol names. If no address is specified on the command-line, it reads the addresses from standard input. If no input name is specified on the command-line, but addresses @@ -196,6 +196,17 @@ shows --relativenames. main foo/test.cpp:15:0 +Example 7 - Addresses as symbol names: + +.. code-block:: console + + $ llvm-symbolizer --obj=test.elf main + main + /tmp/test.cpp:14:0 + $ llvm-symbolizer --obj=test.elf "CODE foz" + foz + /tmp/test.h:1:0 + OPTIONS ------- diff --git a/llvm/docs/ReleaseNotes.rst b/llvm/docs/ReleaseNotes.rst index a1277171e8a54ec..25817e6e1d7f413 100644 --- a/llvm/docs/ReleaseNotes.rst +++ b/llvm/docs/ReleaseNotes.rst @@ -201,6 +201,8 @@ Changes to the LLVM tools * ``llvm-nm`` now supports the ``--line-numbers`` (``-l``) option to use debugging information to print symbols' filenames and line numbers. +* llvm-symbolizer and llvm-addr2line now support addresses specified as symbol names. + Changes to LLDB --------------------------------- diff --git a/llvm/include/llvm/DebugInfo/Symbolize/DIPrinter.h b/llvm/include/llvm/DebugInfo/Symbolize/DIPrinter.h index 026f917ced5bc1f..72ffdd29f1b72d5 100644 --- a/llvm/include/llvm/DebugInfo/Symbolize/DIPrinter.h +++ b/llvm/include/llvm/DebugInfo/Symbolize/DIPrinter.h @@ -34,6 +34,7 @@ class SourceCode; struct Request { StringRef ModuleName; std::optional Address; + StringRef Symbol; }; class DIPrinter { @@ -46,6 +47,8 @@ class DIPrinter { virtual void print(const Request &Request, const DIGlobal &Global) = 0; virtual void print(const Request &Request, const std::vector &Locals) = 0; + virtual void print(const Request &Request, + const std::vector &Locations) = 0; virtual bool printError(const Request &Request, const ErrorInfoBase &ErrorInfo) = 0; @@ -91,6 +94,8 @@ class PlainPrinterBase : public DIPrinter { void print(const Request &Request, const DIGlobal &Global) override; void print(const Request &Request, const std::vector &Locals) override; + void print(const Request &Request, + const std::vector &Locations) override; bool printError(const Request &Request, const ErrorInfoBase &ErrorInfo) override; @@ -141,6 +146,8 @@ class JSONPrinter : public DIPrinter { void print(const Request &Request, const DIGlobal &Global) override; void print(const Request &Request, const std::vector &Locals) override; + void print(const Request &Request, + const std::vector &Locations) override; bool printError(const Request &Request, const ErrorInfoBase &ErrorInfo) override; diff --git a/llvm/include/llvm/DebugInfo/Symbolize/SymbolizableModule.h b/llvm/include/llvm/DebugInfo/Symbolize/SymbolizableModule.h index 51e92b83eadbac0..255932d35cda114 100644 --- a/llvm/include/llvm/DebugInfo/Symbolize/SymbolizableModule.h +++ b/llvm/include/llvm/DebugInfo/Symbolize/SymbolizableModule.h @@ -36,6 +36,9 @@ class SymbolizableModule { virtual std::vector symbolizeFrame(object::SectionedAddress ModuleOffset) const = 0; + virtual std::vector + findSymbol(StringRef Symbol) const = 0; + // Return true if this is a 32-bit x86 PE COFF module. virtual bool isWin32Module() const = 0; diff --git a/llvm/include/llvm/DebugInfo/Symbolize/SymbolizableObjectFile.h b/llvm/include/llvm/DebugInfo/Symbolize/SymbolizableObjectFile.h index 075dbe3e0e372ed..311fa201d900e4a 100644 --- a/llvm/include/llvm/DebugInfo/Symbolize/SymbolizableObjectFile.h +++ b/llvm/include/llvm/DebugInfo/Symbolize/SymbolizableObjectFile.h @@ -43,6 +43,8 @@ class SymbolizableObjectFile : public SymbolizableModule { DIGlobal symbolizeData(object::SectionedAddress ModuleOffset) const override; std::vector symbolizeFrame(object::SectionedAddress ModuleOffset) const override; + std::vector + findSymbol(StringRef Symbol) const override; // Return true if this is a 32-bit x86 PE COFF module. bool isWin32Module() const override; diff --git a/llvm/include/llvm/DebugInfo/Symbolize/Symbolize.h b/llvm/include/llvm/DebugInfo/Symbolize/Symbolize.h index 99a7f219baaa09f..bc4aa74073a6557 100644 --- a/llvm/include/llvm/DebugInfo/Symbolize/Symbolize.h +++ b/llvm/include/llvm/DebugInfo/Symbolize/Symbolize.h @@ -104,6 +104,14 @@ class LLVMSymbolizer { Expected> symbolizeFrame(ArrayRef BuildID, object::SectionedAddress ModuleOffset); + + Expected> findSymbol(const ObjectFile &Obj, + StringRef Symbol); + Expected> findSymbol(StringRef ModuleName, + StringRef Symbol); + Expected> findSymbol(ArrayRef BuildID, + StringRef Symbol); + void flush(); // Evict entries from the binary cache until it is under the maximum size @@ -146,6 +154,9 @@ class LLVMSymbolizer { Expected> symbolizeFrameCommon(const T &ModuleSpecifier, object::SectionedAddress ModuleOffset); + template + Expected> findSymbolCommon(const T &ModuleSpecifier, + StringRef Symbol); Expected getOrCreateModuleInfo(const ObjectFile &Obj); diff --git a/llvm/lib/DebugInfo/Symbolize/DIPrinter.cpp b/llvm/lib/DebugInfo/Symbolize/DIPrinter.cpp index dcf5eee2bb32b61..d7b33ce1d0f062d 100644 --- a/llvm/lib/DebugInfo/Symbolize/DIPrinter.cpp +++ b/llvm/lib/DebugInfo/Symbolize/DIPrinter.cpp @@ -260,6 +260,17 @@ void PlainPrinterBase::print(const Request &Request, printFooter(); } +void PlainPrinterBase::print(const Request &Request, + const std::vector &Locations) { + if (Locations.empty()) { + print(Request, DILineInfo()); + } else { + for (const DILineInfo &L : Locations) + print(L, false); + printFooter(); + } +} + bool PlainPrinterBase::printError(const Request &Request, const ErrorInfoBase &ErrorInfo) { ErrHandler(ErrorInfo, Request.ModuleName); @@ -273,6 +284,8 @@ static std::string toHex(uint64_t V) { static json::Object toJSON(const Request &Request, StringRef ErrorMsg = "") { json::Object Json({{"ModuleName", Request.ModuleName.str()}}); + if (!Request.Symbol.empty()) + Json["SymName"] = Request.Symbol.str(); if (Request.Address) Json["Address"] = toHex(*Request.Address); if (!ErrorMsg.empty()) @@ -362,6 +375,19 @@ void JSONPrinter::print(const Request &Request, printJSON(std::move(Json)); } +void JSONPrinter::print(const Request &Request, + const std::vector &Locations) { + json::Array Definitions; + for (const DILineInfo &L : Locations) + Definitions.push_back(toJSON(L)); + json::Object Json = toJSON(Request); + Json["Loc"] = std::move(Definitions); + if (ObjectList) + ObjectList->push_back(std::move(Json)); + else + printJSON(std::move(Json)); +} + bool JSONPrinter::printError(const Request &Request, const ErrorInfoBase &ErrorInfo) { json::Object Json = toJSON(Request, ErrorInfo.message()); diff --git a/llvm/lib/DebugInfo/Symbolize/SymbolizableObjectFile.cpp b/llvm/lib/DebugInfo/Symbolize/SymbolizableObjectFile.cpp index 6b8068a531c05fa..697303038507a96 100644 --- a/llvm/lib/DebugInfo/Symbolize/SymbolizableObjectFile.cpp +++ b/llvm/lib/DebugInfo/Symbolize/SymbolizableObjectFile.cpp @@ -351,6 +351,19 @@ std::vector SymbolizableObjectFile::symbolizeFrame( return DebugInfoContext->getLocalsForAddress(ModuleOffset); } +std::vector +SymbolizableObjectFile::findSymbol(StringRef Symbol) const { + std::vector Result; + for (const SymbolDesc &Sym : Symbols) { + if (Sym.Name.equals(Symbol)) { + object::SectionedAddress A{Sym.Addr, + getModuleSectionIndexForAddress(Sym.Addr)}; + Result.push_back(A); + } + } + return Result; +} + /// Search for the first occurence of specified Address in ObjectFile. uint64_t SymbolizableObjectFile::getModuleSectionIndexForAddress( uint64_t Address) const { diff --git a/llvm/lib/DebugInfo/Symbolize/Symbolize.cpp b/llvm/lib/DebugInfo/Symbolize/Symbolize.cpp index 517f1e7dc284f9c..36d112a5f3fb299 100644 --- a/llvm/lib/DebugInfo/Symbolize/Symbolize.cpp +++ b/llvm/lib/DebugInfo/Symbolize/Symbolize.cpp @@ -231,6 +231,50 @@ LLVMSymbolizer::symbolizeFrame(ArrayRef BuildID, return symbolizeFrameCommon(BuildID, ModuleOffset); } +template +Expected> +LLVMSymbolizer::findSymbolCommon(const T &ModuleSpecifier, StringRef Symbol) { + auto InfoOrErr = getOrCreateModuleInfo(ModuleSpecifier); + if (!InfoOrErr) + return InfoOrErr.takeError(); + + SymbolizableModule *Info = *InfoOrErr; + std::vector Result; + + // A null module means an error has already been reported. Return an empty + // result. + if (!Info) + return Result; + + for (object::SectionedAddress A : Info->findSymbol(Symbol)) { + DILineInfo LineInfo = Info->symbolizeCode( + A, DILineInfoSpecifier(Opts.PathStyle, Opts.PrintFunctions), + Opts.UseSymbolTable); + if (LineInfo.FileName != DILineInfo::BadString) { + if (Opts.Demangle) + LineInfo.FunctionName = DemangleName(LineInfo.FunctionName, Info); + Result.push_back(LineInfo); + } + } + + return Result; +} + +Expected> +LLVMSymbolizer::findSymbol(const ObjectFile &Obj, StringRef Symbol) { + return findSymbolCommon(Obj, Symbol); +} + +Expected> +LLVMSymbolizer::findSymbol(StringRef ModuleName, StringRef Symbol) { + return findSymbolCommon(ModuleName.str(), Symbol); +} + +Expected> +LLVMSymbolizer::findSymbol(ArrayRef BuildID, StringRef Symbol) { + return findSymbolCommon(BuildID, Symbol); +} + void LLVMSymbolizer::flush() { ObjectForUBPathAndArch.clear(); LRUBinaries.clear(); diff --git a/llvm/test/Support/interrupts.test b/llvm/test/Support/interrupts.test index 752426c5292b098..4768ac61dff0260 100644 --- a/llvm/test/Support/interrupts.test +++ b/llvm/test/Support/interrupts.test @@ -1,7 +1,10 @@ ## Show that SIGINT and similar signals don't cause crash messages to be ## reported. # RUN: %python %s wrapper llvm-symbolizer 2> %t.err -# RUN: count 0 < %t.err +# RUN: FileCheck --input-file=%t.err %s + +# CHECK: {{.*}} error: 'foo': {{[Nn]}}o such file or directory +# CHECK-NOT: {{.+}} import os import signal diff --git a/llvm/test/tools/llvm-symbolizer/Inputs/addr.inp b/llvm/test/tools/llvm-symbolizer/Inputs/addr.inp index b5e146b114e254f..b19992175bf9952 100644 --- a/llvm/test/tools/llvm-symbolizer/Inputs/addr.inp +++ b/llvm/test/tools/llvm-symbolizer/Inputs/addr.inp @@ -1,3 +1,3 @@ -some text +something not a valid address 0x40054d -some text2 +some text possibly a symbol diff --git a/llvm/test/tools/llvm-symbolizer/Inputs/discrim.inp b/llvm/test/tools/llvm-symbolizer/Inputs/discrim.inp index a5cfcb2558f3594..2c4d722e3286237 100644 --- a/llvm/test/tools/llvm-symbolizer/Inputs/discrim.inp +++ b/llvm/test/tools/llvm-symbolizer/Inputs/discrim.inp @@ -5,4 +5,4 @@ some text 0x4005b9 0x4005ce 0x4005d4 -some more text +another text diff --git a/llvm/test/tools/llvm-symbolizer/Inputs/symbols.h b/llvm/test/tools/llvm-symbolizer/Inputs/symbols.h new file mode 100644 index 000000000000000..b097c4d9dc00a73 --- /dev/null +++ b/llvm/test/tools/llvm-symbolizer/Inputs/symbols.h @@ -0,0 +1,19 @@ +// This file is a part of sources used to build `symbols.so`, which is used to +// test symbol location search made by llvm-symbolizer. +// +// Build instructions: +// $ mkdir /tmp/dbginfo +// $ cp symbols.h symbols.part1.cpp symbols.part2.cpp symbols.part3.c symbols.part4.c /tmp/dbginfo/ +// $ cd /tmp/dbginfo +// $ gcc -osymbols.so -shared -fPIC -g symbols.part1.cpp symbols.part2.cpp symbols.part3.c symbols.part4.c + + +extern "C" { +extern int global_01; +int func_01(); +int func_02(int); +} + +template T func_03(T x) { + return x + T(1); +} diff --git a/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part1.cpp b/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part1.cpp new file mode 100644 index 000000000000000..ad4b3e34411aa40 --- /dev/null +++ b/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part1.cpp @@ -0,0 +1,25 @@ +#include "symbols.h" + +int global_01 = 22; + +int static static_var = 0; + +static int static_func_01(int x) { + static_var = x; + return global_01; +} + +int func_01() { + int res = 1; + return res + static_func_01(22); +} + +int func_04() { + static_var = 0; + return 22; +} + +int func_04(int x) { + int res = static_var; + return res + func_03(x); +} diff --git a/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part2.cpp b/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part2.cpp new file mode 100644 index 000000000000000..35e66d62622f89c --- /dev/null +++ b/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part2.cpp @@ -0,0 +1,18 @@ +#include "symbols.h" + +int static static_var = 4; + +static int static_func_01(int x) { + static_var--; + return x; +} + +int func_02(int x) { + static_var = x; + return static_func_01(x); +} + +int func_05(int x) { + int res = static_var; + return res + func_03(x); +} diff --git a/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part3.c b/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part3.c new file mode 100644 index 000000000000000..1284be505b6bac4 --- /dev/null +++ b/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part3.c @@ -0,0 +1,12 @@ +static int static_func(int); +static int static_var = 0; + +int static_func(int x) { + static_var++; + return static_var + x; +} + +int func_06(int x) { + return static_func(x); +} + diff --git a/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part4.c b/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part4.c new file mode 100644 index 000000000000000..de2ac81d2a78cc4 --- /dev/null +++ b/llvm/test/tools/llvm-symbolizer/Inputs/symbols.part4.c @@ -0,0 +1,13 @@ +static int static_func(int); +static int static_var = 5; + +int static_func(int x) { + static_var++; + return static_var + x; +} + +int func_07(int x) { + static_var++; + return static_func(x); +} + diff --git a/llvm/test/tools/llvm-symbolizer/Inputs/symbols.so b/llvm/test/tools/llvm-symbolizer/Inputs/symbols.so new file mode 100755 index 0000000000000000000000000000000000000000..ceacd9845a8d880e82d3f3b98d181af670e350d3 GIT binary patch literal 19496 zcmeHP4~!Jm8Go~TbN~MW2X`XeLb0NF%N-nWfXKq#!JY*@;jp0CVefA5ZtdRgW&glI zv=UM4HpUSDG^RDF8cmJbG**ljsHqkko0v9fuq_4?Yt>>yDPjBj-h1Ef?63>5 zO-$R&OLo5Z{r}!KZ{EC_d2jFN*|fo97=nveTqAOr5CP42s*5Fv)+wrRoG<1{*^(UV zyjoMKA~6*83MU^XRW(hG9 zJTiWl_Q#O@-2gp(YPH0L0iWhA+F!Br@UqS)LygLOk`3xJ8?W0Yke)*ni&wj)`V5T| ze`;gA^|7D4b$agRr_R0C^uqG%{yZEfQIaPcWLL)j^x+aCAbdot#IG8^Ex*3y==Xnf z*-`(|r_UC^f?%3}?vpe#^8 zYy)f%jbdRy5%@ek0+i%WY56M@TigLSAM{5xeY&P6wS3wk|3gjho~8t6YxxmP->K!B zHT_vlzemeosp*!ccWQZ#Us%@2SUhGWQ=vr4vV_&!zu6iJC&D9^$JpOpPlq2joWPJM#Q zNgG`c6_WLdjn3BwF;3g)+&75c6riIJW%zMSlHeZP47eF^GvH>x&48N$Hv?`4{x37| zx4OA!f(Je-4^EjMF2;2B?n5b0=2-B+8|AOd_GXs-5#-M@m;DK#u0@diC~-df@cm3C zb3ftWJ|wx_Lh^yX!g%n$HSeGvyw7}-z{=C9M!4Edb-1d?9ItEHPv&0N5b{q*`DKp~ zxZ+%J@{{0eAFmC*cG?>>4hP>kmzn_st=d3&=J;@33;eP^#j}6S4zNXf(YD}$HD~C- zJvezHRUMpK;|Kj@FXBEqgu`L89k_7|bo2B-+yf>V+6KMJ+s{t*oSihQ$m5jxB+N~T zTV7{2a#w$(=PXUlU!94=$v2=owe75N?3Y=YBj%g>?ZL|=lBevOy#1po^I7mGd*JA! z$s;F!dhR?6Du@Gz5Gy+-l6foi4xBV5%@Bpvb2i7ObIPH2D<(|8ir{i_K}Na%irxLH z!tTvl@^uKlOfuJ)X_X$0V+DO4Ie940m5lZfRHTKMNVoC%;ug$@SoAwe2(dq(H7NUQ zwud64ZgDf8xEXLW;AX(hfSZAfX26*3U40j%>hSY@lF2*{7yvv9 z*avtVu=&$W<}_d@U=yBncLH_-rUADDJ_JJpZ?4SWmE)fRe=hj)+bi?0&GBcT{SDw3i?0Lx zdhm{`iyB51RM`7^W}t&^lOOM$E-rU!H&9Ooe|SD_)>`$tB_pY_Z3zGTSj*qv_M9P3r- z!!@Ornzym5Yn5-|wt;jkmG-r_`PYL4RMu9m5^q=JoawT zsW_J(D{Ahj^mpMwQt3ah^`lzkV*0e~+9U2n2ugpB?tbfYF7j$hej(0^lDD+{4S7;I zWG5msg&~E#?V!&i9w}un03x82&{MXjx_UW)Sz<l@W3X*gGP8wZynLDFIkTa+V#Q6}5S z-9f(LATtLkl(H6<6?1idOUaDPFTG5m{9+M8wmgcOSLL)sX3$$rsjcu{6;Lv!ErY~4 zKZAFITG}t<8Ic*J8fCDo7Osst^9*pJITz9!2Y&%7g&*8cHS znJlvl6QSI1tZiofSZ(k024h-TplM&Tf%k$HixEICDwTz$Zj(|~eo@#2h9SEi+g4gN zeuLdIV;|j?&(Fg7P4?#6m)Ck~kZE`6Y)~mTsI0J*3awn`-F6}>?9v>ql0{}N&d1yQp@*vyCLtP_9(uhc&A@3B@W3r_;eF4)n2nuRgA%CC^^dPNIV9{;IIwPZK}%cx3X`|(tEUWVjZ?E zTG@SAOLUu;30qdOd$eT3|I3=K+OC<3$ULGf^$+GrbO4{LyC3zeGQOtoHp=+2oG#|rCHT6E+5||oSfTNxM0}cY z@@cy3!K8PW{o@;GwVHmvgFa8w`FRnjEGuv{#7xlP zp@^NQL8m-qr)a>be2gE(!=n&SWzK+JC>~{}QDi4kWCVrn@Q}lHik;s|FbsSpo|v!n z?Z-lXo22|S;e5WFC+UsZJhL5|oEq4_>I*PM!BwDp=wZy!e*&P(-sMwreB3JKYXrY% zVEPVeA5ZZCrYIN(z0iKzJ(}*EVcr3Hp?$WKp!@PoOYC87$NAXsWD$9q+|I}O&0Vg_ z=sQK^|Dx?X=j)$q`gzZ5n1EAzolj~Nn(ll+Yy`bfyTo83l}x3FhcV>jw&_}_F>8=E z>L#(DcPMV@4Y)(NMI^0IdO{4w$Ht@KRCvhWR#<{I??$XpA`#kag=4A2UNM{qjfJhD z^w`*5sMs(IlBqmV``D<4RqLir?QOQ3B;g&ly9M?HNAiZyB7kX2fMcj*>quT+;si= zb(^f~H*DC7oyh&`)^F;`ZARuBNN#7dmA~aVdl$uBQtqKHyic09LECP>7uayEye_xh zj(6+ZtbIo{9Om!g7Ji%%Oc?-E2?a;F7Q@WJKN3s(F^3orCsKQbKT8@&N1{Wmks%=k zMlqET{-M1w7*jBn5dK6s8X}^ujYm_$FB9uW)jtvkN|j`IQ20~f382)mgg-p0yU^$m ztT3i@RbNt)T!)L$SOi93k}M*EP%0$+1IeWDqc@MClY$l=NRL1z6dOU;*QmUeGizWV z5#G(5Xe1WqIugQFB4Y!57Ei=RqS*aTTk`+oLho10@WbUSOR@i>&}{wsi!t@O#jaoM ze<@gl?|Y1|L*?&y=gI#0y)DC_7Gyp7MvavLX_8!pAM5jbU50%a@2JrGNvg6wo=0Wb ziX%Ptus**hX858K%O174EPgX;6dUUY$Po&|LlRRmRCW3fgGT!6iAjYw`D@5=k_^3T zcIwALqnKDNdq33oMLNIs!g*vG&6Di`T@;g$Z~9kafaV===W&` zLzXM1|80l zdwoih;VEL;3ZH)_{TLOROY@^U&ujUARGjjRGo*Pez58Q*o=5ljK}2CWh2?OjzYYfV zJ=W)W9se)RejUHQEVB0aJnV%oiLgHZ-^F|Mx&mdP0@)+`Wk~aFyS@l$(KZEr8fCzG z41WuTUEdc_l0L1^-*=q)jQ<`Lvc>W9^GS!+uVz6Fo#+2J=;U9EYbhaEe^HjADkMvV z;fJ=mWaxvX4IZ}>QD;3SpDsWn-dcL8j`B7)OrhuLm%yOYCW+Q8QwrJtX)2;Wt%&}c z^uUMmfy1~1l^+6#=FH!7E2X+P>`-8o;T5P*-KoEOwbG~Y-CkIa;YzJ %t.1.stderr | FileCheck --check-prefix=NONEXISTENT %s +RUN: FileCheck --input-file=%t.1.stderr --check-prefix=BINARY-NOT-FOUND -DMSG=%errc_ENOENT %s +RUN: llvm-symbolizer "%p/Inputs/666.so func_01" 2> %t.2.stderr | FileCheck --check-prefix=NONEXISTENT %s +RUN: FileCheck --input-file=%t.2.stderr --check-prefix=BINARY-NOT-FOUND -DMSG=%errc_ENOENT %s +BINARY-NOT-FOUND: error: '{{.*}}666.so': [[MSG]] diff --git a/llvm/tools/llvm-symbolizer/llvm-symbolizer.cpp b/llvm/tools/llvm-symbolizer/llvm-symbolizer.cpp index 78a0e6772f3fb36..447c18abadc1743 100644 --- a/llvm/tools/llvm-symbolizer/llvm-symbolizer.cpp +++ b/llvm/tools/llvm-symbolizer/llvm-symbolizer.cpp @@ -159,7 +159,7 @@ static Error makeStringError(StringRef Msg) { static Error parseCommand(StringRef BinaryName, bool IsAddr2Line, StringRef InputString, Command &Cmd, std::string &ModuleName, object::BuildID &BuildID, - uint64_t &ModuleOffset) { + StringRef &Symbol, uint64_t &ModuleOffset) { ModuleName = BinaryName; if (InputString.consume_front("CODE ")) { Cmd = Command::Code; @@ -224,35 +224,41 @@ static Error parseCommand(StringRef BinaryName, bool IsAddr2Line, return makeStringError("no input filename has been specified"); } - // Parse module offset. + // Parse module offset, which can be specified as a number or as a symbol. InputString = InputString.ltrim(); if (InputString.empty()) return makeStringError("no module offset has been specified"); + + // If input string contains a space, ignore everything after it. This behavior + // is consistent with GNU addr2line. int OffsetLength = InputString.find_first_of(" \n\r"); StringRef Offset = InputString.substr(0, OffsetLength); + // GNU addr2line assumes the offset is hexadecimal and allows a redundant // "0x" or "0X" prefix; do the same for compatibility. if (IsAddr2Line) Offset.consume_front("0x") || Offset.consume_front("0X"); - // If the input is not a valid module offset, it is not an error, but its - // lookup does not make sense. Return error of different kind to distinguish - // from error or success. - if (Offset.getAsInteger(IsAddr2Line ? 16 : 0, ModuleOffset)) - return errorCodeToError(errc::invalid_argument); + // If the input is not a number, treat it is a symbol. + if (Offset.getAsInteger(IsAddr2Line ? 16 : 0, ModuleOffset)) { + Symbol = Offset; + ModuleOffset = 0; + } return Error::success(); } template void executeCommand(StringRef ModuleName, const T &ModuleSpec, Command Cmd, - uint64_t Offset, uint64_t AdjustVMA, bool ShouldInline, - OutputStyle Style, LLVMSymbolizer &Symbolizer, - DIPrinter &Printer) { + StringRef Symbol, uint64_t Offset, uint64_t AdjustVMA, + bool ShouldInline, OutputStyle Style, + LLVMSymbolizer &Symbolizer, DIPrinter &Printer) { uint64_t AdjustedOffset = Offset - AdjustVMA; object::SectionedAddress Address = {AdjustedOffset, object::SectionedAddress::UndefSection}; - Request SymRequest = {ModuleName, Offset}; + Request SymRequest = { + ModuleName, Symbol.empty() ? std::make_optional(Offset) : std::nullopt, + Symbol}; if (Cmd == Command::Data) { Expected ResOrErr = Symbolizer.symbolizeData(ModuleSpec, Address); print(SymRequest, ResOrErr, Printer); @@ -260,6 +266,10 @@ void executeCommand(StringRef ModuleName, const T &ModuleSpec, Command Cmd, Expected> ResOrErr = Symbolizer.symbolizeFrame(ModuleSpec, Address); print(SymRequest, ResOrErr, Printer); + } else if (!Symbol.empty()) { + Expected> ResOrErr = + Symbolizer.findSymbol(ModuleSpec, Symbol); + print(SymRequest, ResOrErr, Printer); } else if (ShouldInline) { Expected ResOrErr = Symbolizer.symbolizeInlinedCode(ModuleSpec, Address); @@ -288,7 +298,7 @@ void executeCommand(StringRef ModuleName, const T &ModuleSpec, Command Cmd, } static void printUnknownLineInfo(std::string ModuleName, DIPrinter &Printer) { - Request SymRequest = {ModuleName, std::nullopt}; + Request SymRequest = {ModuleName, std::nullopt, StringRef()}; Printer.print(SymRequest, DILineInfo()); } @@ -301,16 +311,14 @@ static void symbolizeInput(const opt::InputArgList &Args, std::string ModuleName; object::BuildID BuildID(IncomingBuildID.begin(), IncomingBuildID.end()); uint64_t Offset = 0; + StringRef Symbol; if (Error E = parseCommand(Args.getLastArgValue(OPT_obj_EQ), IsAddr2Line, StringRef(InputString), Cmd, ModuleName, BuildID, - Offset)) { - handleAllErrors( - std::move(E), - [&](const StringError &EI) { - printError(EI, InputString); - printUnknownLineInfo(ModuleName, Printer); - }, - [&](const ECError &EI) { printUnknownLineInfo(ModuleName, Printer); }); + Symbol, Offset)) { + handleAllErrors(std::move(E), [&](const StringError &EI) { + printError(EI, InputString); + printUnknownLineInfo(ModuleName, Printer); + }); return; } bool ShouldInline = Args.hasFlag(OPT_inlines, OPT_no_inlines, !IsAddr2Line); @@ -319,11 +327,11 @@ static void symbolizeInput(const opt::InputArgList &Args, if (!Args.hasArg(OPT_no_debuginfod)) enableDebuginfod(Symbolizer, Args); std::string BuildIDStr = toHex(BuildID); - executeCommand(BuildIDStr, BuildID, Cmd, Offset, AdjustVMA, ShouldInline, - Style, Symbolizer, Printer); + executeCommand(BuildIDStr, BuildID, Cmd, Symbol, Offset, AdjustVMA, + ShouldInline, Style, Symbolizer, Printer); } else { - executeCommand(ModuleName, ModuleName, Cmd, Offset, AdjustVMA, ShouldInline, - Style, Symbolizer, Printer); + executeCommand(ModuleName, ModuleName, Cmd, Symbol, Offset, AdjustVMA, + ShouldInline, Style, Symbolizer, Printer); } } @@ -527,7 +535,7 @@ int llvm_symbolizer_main(int argc, char **argv, const llvm::ToolContext &) { if (auto *Arg = Args.getLastArg(OPT_obj_EQ); Arg) { auto Status = Symbolizer.getOrCreateModuleInfo(Arg->getValue()); if (!Status) { - Request SymRequest = {Arg->getValue(), 0}; + Request SymRequest = {Arg->getValue(), 0, StringRef()}; handleAllErrors(Status.takeError(), [&](const ErrorInfoBase &EI) { Printer->printError(SymRequest, EI); }); diff --git a/llvm/unittests/ProfileData/MemProfTest.cpp b/llvm/unittests/ProfileData/MemProfTest.cpp index 5984be98d798a86..682f79a540cdc5c 100644 --- a/llvm/unittests/ProfileData/MemProfTest.cpp +++ b/llvm/unittests/ProfileData/MemProfTest.cpp @@ -20,6 +20,7 @@ using ::llvm::DIInliningInfo; using ::llvm::DILineInfo; using ::llvm::DILineInfoSpecifier; using ::llvm::DILocal; +using ::llvm::StringRef; using ::llvm::memprof::CallStackMap; using ::llvm::memprof::Frame; using ::llvm::memprof::FrameId; @@ -53,6 +54,9 @@ class MockSymbolizer : public SymbolizableModule { virtual std::vector symbolizeFrame(SectionedAddress) const { llvm_unreachable("unused"); } + virtual std::vector findSymbol(StringRef Symbol) const { + llvm_unreachable("unused"); + } virtual bool isWin32Module() const { llvm_unreachable("unused"); } virtual uint64_t getModulePreferredBase() const { llvm_unreachable("unused");