From: James Henderson Date: Wed, 23 Jan 2019 17:27:48 +0000 (+0000) Subject: [llvm-symbolizer] Improve compatibility of --functions with GNU addr2line X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0c8614fd4d276a31d2b5907b1c75d0003251cbf0;p=llvm [llvm-symbolizer] Improve compatibility of --functions with GNU addr2line This fixes https://bugs.llvm.org/show_bug.cgi?id=40072. GNU addr2line's --functions switch is off by default, has a short alias of -f, and does not take an argument. This patch changes llvm-symbolizer to allow the second and third point (changing the default behaviour may have negative impacts on users). If the option is missing a value, it now treats it as "linkage". This change does cause one previously valid command-line to behave differently. Before --functions was accepted, but now only --functions= is allowed (as well as --functions). The old behaviour will result in the value being treated as a positional argument. The previous testing for --functions=short has been pulled out into a new test that also tests the other accepted values and option formats. Reviewed by: ruiu Differential Revision: https://reviews.llvm.org/D57049 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@351968 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/CommandGuide/llvm-symbolizer.rst b/docs/CommandGuide/llvm-symbolizer.rst index bfe8f3ee6bb..2e69a20442c 100644 --- a/docs/CommandGuide/llvm-symbolizer.rst +++ b/docs/CommandGuide/llvm-symbolizer.rst @@ -72,7 +72,7 @@ OPTIONS Path to object file to be symbolized. -.. option:: -functions=[none|short|linkage] +.. option:: -functions[=], -f Specify the way function names are printed (omit function name, print short function name, or print full linkage name, respectively). diff --git a/test/DebugInfo/llvm-symbolizer.test b/test/DebugInfo/llvm-symbolizer.test index 81b69ba0f4c..33d83c45cf5 100644 --- a/test/DebugInfo/llvm-symbolizer.test +++ b/test/DebugInfo/llvm-symbolizer.test @@ -207,23 +207,22 @@ RUN: | FileCheck %s --check-prefix=STRIPPED STRIPPED: global_func -RUN: echo "%p/Inputs/dwarfdump-test4.elf-x86-64 0x62c" > %t.input7 -RUN: llvm-symbolizer --functions=short --demangle=false < %t.input7 \ -RUN: | FileCheck %s --check-prefix=SHORT_FUNCTION_NAME -RUN: llvm-symbolizer --functions=short -C=false < %t.input7 \ -RUN: | FileCheck %s --check-prefix=SHORT_FUNCTION_NAME - -SHORT_FUNCTION_NAME-NOT: _Z1cv - ; Check that the last of --demangle and --no-demangle wins. +RUN: echo "%p/Inputs/dwarfdump-test4.elf-x86-64 0x62c" > %t.input7 RUN: llvm-symbolizer --demangle < %t.input7 \ RUN: | FileCheck %s --check-prefix=DEMANGLED_FUNCTION_NAME +RUN: llvm-symbolizer -C < %t.input7 \ +RUN: | FileCheck %s --check-prefix=DEMANGLED_FUNCTION_NAME RUN: llvm-symbolizer --no-demangle < %t.input7 \ RUN: | FileCheck %s --check-prefix=MANGLED_FUNCTION_NAME RUN: llvm-symbolizer --demangle --no-demangle < %t.input7 \ RUN: | FileCheck %s --check-prefix=MANGLED_FUNCTION_NAME +RUN: llvm-symbolizer -C --no-demangle < %t.input7 \ +RUN: | FileCheck %s --check-prefix=MANGLED_FUNCTION_NAME RUN: llvm-symbolizer --no-demangle --demangle < %t.input7 \ RUN: | FileCheck %s --check-prefix=DEMANGLED_FUNCTION_NAME +RUN: llvm-symbolizer --no-demangle -C < %t.input7 \ +RUN: | FileCheck %s --check-prefix=DEMANGLED_FUNCTION_NAME MANGLED_FUNCTION_NAME: _Z1cv DEMANGLED_FUNCTION_NAME: c() diff --git a/test/tools/llvm-symbolizer/flag-grouping.test b/test/tools/llvm-symbolizer/flag-grouping.test index ec032689e15..c8ae547a5fc 100644 --- a/test/tools/llvm-symbolizer/flag-grouping.test +++ b/test/tools/llvm-symbolizer/flag-grouping.test @@ -1,4 +1,4 @@ -RUN: llvm-symbolizer -inlining -apC -obj=%p/Inputs/addr.exe < %p/Inputs/addr.inp | FileCheck %s +RUN: llvm-symbolizer -inlining -apfC -obj=%p/Inputs/addr.exe < %p/Inputs/addr.inp | FileCheck %s CHECK: some text CHECK: 0x40054d: inctwo diff --git a/test/tools/llvm-symbolizer/functions.s b/test/tools/llvm-symbolizer/functions.s new file mode 100644 index 00000000000..93cca51a0c1 --- /dev/null +++ b/test/tools/llvm-symbolizer/functions.s @@ -0,0 +1,109 @@ +# REQUIRES: x86-registered-target + +# RUN: llvm-mc -filetype=obj -triple=x86_64-pc-linux %s -o %t.o + +# RUN: llvm-symbolizer 0 --obj=%t.o | FileCheck %s --check-prefix=LINKAGE +# RUN: llvm-symbolizer 0 --functions --obj=%t.o | FileCheck %s --check-prefix=LINKAGE +# RUN: llvm-symbolizer 0 --functions=linkage --obj=%t.o | FileCheck %s --check-prefix=LINKAGE +# RUN: llvm-symbolizer 0 --functions=short --obj=%t.o | FileCheck %s --check-prefix=SHORT +# RUN: llvm-symbolizer 0 --functions=none --obj=%t.o | FileCheck %s --check-prefix=NONE + +## Characterise behaviour for no '=' sign. llvm-symbolizer treats the next option as an +## input address, and just prints it. +# RUN: llvm-symbolizer 0 --functions none --obj=%t.o | FileCheck %s --check-prefixes=LINKAGE,ERR + +# LINKAGE: {{^}}foo(int){{$}} +# LINKAGE-NEXT: functions.cpp:2:0 + +# SHORT: {{^}}foo{{$}} +# SHORT-NEXT: functions.cpp:2:0 + +# NONE-NOT: foo +# NONE: functions.cpp:2:0 + +# ERR: none + +# The assembly below is a stripped down version of the output of: +# clang -S -g --target=x86_64-pc-linux +# for the following C++ source: +# void foo(int bar) {} + .type _Z3fooi,@function +_Z3fooi: +.Lfunc_begin0: + .file 1 "/llvm-symbolizer/Inputs" "functions.cpp" + .loc 1 2 0 # functions.cpp:2:0 + nop + .loc 1 2 20 prologue_end # functions.cpp:2:20 +.Lfunc_end0: + + .section .debug_str,"MS",@progbits,1 +.Linfo_string1: + .asciz "functions.cpp" +.Linfo_string2: + .asciz "/llvm-symbolizer/Inputs" +.Linfo_string3: + .asciz "_Z3fooi" +.Linfo_string4: + .asciz "foo" + + .section .debug_abbrev,"",@progbits + .byte 1 # Abbreviation Code + .byte 17 # DW_TAG_compile_unit + .byte 1 # DW_CHILDREN_yes + .byte 3 # DW_AT_name + .byte 14 # DW_FORM_strp + .byte 16 # DW_AT_stmt_list + .byte 23 # DW_FORM_sec_offset + .byte 27 # DW_AT_comp_dir + .byte 14 # DW_FORM_strp + .byte 17 # DW_AT_low_pc + .byte 1 # DW_FORM_addr + .byte 18 # DW_AT_high_pc + .byte 6 # DW_FORM_data4 + .byte 0 # EOM(1) + .byte 0 # EOM(2) + .byte 2 # Abbreviation Code + .byte 46 # DW_TAG_subprogram + .byte 0 # DW_CHILDREN_no + .byte 17 # DW_AT_low_pc + .byte 1 # DW_FORM_addr + .byte 18 # DW_AT_high_pc + .byte 6 # DW_FORM_data4 + .byte 110 # DW_AT_linkage_name + .byte 14 # DW_FORM_strp + .byte 3 # DW_AT_name + .byte 14 # DW_FORM_strp + .byte 58 # DW_AT_decl_file + .byte 11 # DW_FORM_data1 + .byte 59 # DW_AT_decl_line + .byte 11 # DW_FORM_data1 + .byte 0 # EOM(1) + .byte 0 # EOM(2) + .byte 0 # EOM(3) + + .section .debug_info,"",@progbits +.Lcu_begin0: + .long .Ldebug_info_end0-.Ldebug_info_start0 # Length of Unit +.Ldebug_info_start0: + .short 4 # DWARF version number + .long .debug_abbrev # Offset Into Abbrev. Section + .byte 8 # Address Size (in bytes) + .byte 1 # Abbrev [1] 0xb:0x4f DW_TAG_compile_unit + .long .Linfo_string1 # DW_AT_name + .long .Lline_table_start0 # DW_AT_stmt_list + .long .Linfo_string2 # DW_AT_comp_dir + .quad .Lfunc_begin0 # DW_AT_low_pc + .long .Lfunc_end0-.Lfunc_begin0 # DW_AT_high_pc + .byte 2 # Abbrev [2] 0x2a:0x28 DW_TAG_subprogram + .quad .Lfunc_begin0 # DW_AT_low_pc + .long .Lfunc_end0-.Lfunc_begin0 # DW_AT_high_pc + .long .Linfo_string3 # DW_AT_linkage_name + .long .Linfo_string4 # DW_AT_name + .byte 1 # DW_AT_decl_file + .byte 2 # DW_AT_decl_line + .byte 0 # End Of Children Mark + .byte 0 # End Of Children Mark +.Ldebug_info_end0: + + .section .debug_line,"",@progbits +.Lline_table_start0: diff --git a/tools/llvm-symbolizer/llvm-symbolizer.cpp b/tools/llvm-symbolizer/llvm-symbolizer.cpp index 7affb0fdd33..83b39d9d018 100644 --- a/tools/llvm-symbolizer/llvm-symbolizer.cpp +++ b/tools/llvm-symbolizer/llvm-symbolizer.cpp @@ -38,12 +38,17 @@ ClUseSymbolTable("use-symbol-table", cl::init(true), static cl::opt ClPrintFunctions( "functions", cl::init(FunctionNameKind::LinkageName), - cl::desc("Print function name for a given address:"), + cl::desc("Print function name for a given address:"), cl::ValueOptional, cl::values(clEnumValN(FunctionNameKind::None, "none", "omit function name"), clEnumValN(FunctionNameKind::ShortName, "short", "print short function name"), clEnumValN(FunctionNameKind::LinkageName, "linkage", - "print function linkage name"))); + "print function linkage name (default)"), + // Sentinel value for unspecified value. + clEnumValN(FunctionNameKind::LinkageName, "", ""))); +static cl::alias ClPrintFunctionsShort("f", cl::desc("Alias for -functions"), + cl::NotHidden, cl::Grouping, + cl::aliasopt(ClPrintFunctions)); static cl::opt ClUseRelativeAddress("relative-address", cl::init(false),