[BOLT][DWARF] Handle zero size DW_TAG_inlined_subroutine

We were resetting DW_AT_low_pc to zero when DW_AT_high_pc was zero, or
DW_AT_low_pc == DW_AT_high_pc. This resulted in LLDB to print error "adding
range [0x0-0x0) which has a base that is less than the function's low PC".

Changed it so that when this case arises we set DW_AT_low_pc to the start
address.

Reviewed By: rafauler

Differential Revision: https://reviews.llvm.org/D132059
This commit is contained in:
Alexander Yermolovich 2022-08-17 17:29:38 -07:00
parent 28733d86cf
commit ccbf28b09d
3 changed files with 391 additions and 11 deletions

View File

@ -113,6 +113,7 @@ private:
uint64_t DebugRangesOffset,
SimpleBinaryPatcher &DebugInfoPatcher,
DebugAbbrevWriter &AbbrevWriter,
uint64_t LowPCToUse,
Optional<uint64_t> RangesBase = None);
std::unique_ptr<DebugBufferVector>
@ -171,6 +172,7 @@ private:
/// function above.
void convertToRangesPatchDebugInfo(DWARFDie DIE, uint64_t RangesSectionOffset,
SimpleBinaryPatcher &DebugInfoPatcher,
uint64_t LowPCToUse,
Optional<uint64_t> RangesBase = None);
/// Helper function for creating and returning per-DWO patchers/writers.

View File

@ -413,7 +413,7 @@ void DWARFRewriter::updateUnitDebugInfo(
ARangesSectionWriter->addCURanges(Unit.getOffset(),
std::move(OutputRanges));
updateDWARFObjectAddressRanges(DIE, RangesSectionOffset, DebugInfoPatcher,
AbbrevWriter, RangesBase);
AbbrevWriter, 0, RangesBase);
break;
}
case dwarf::DW_TAG_subprogram: {
@ -448,7 +448,7 @@ void DWARFRewriter::updateUnitDebugInfo(
updateDWARFObjectAddressRanges(
DIE, RangesSectionWriter.addRanges(FunctionRanges), DebugInfoPatcher,
AbbrevWriter);
AbbrevWriter, 0);
break;
}
@ -463,21 +463,34 @@ void DWARFRewriter::updateUnitDebugInfo(
? BC.getBinaryFunctionContainingAddress(
RangesOrError->front().LowPC)
: nullptr;
DebugAddressRangesVector OutputRanges;
bool ErrorState = false;
if (Function) {
DebugAddressRangesVector OutputRanges =
Function->translateInputToOutputRanges(*RangesOrError);
OutputRanges = Function->translateInputToOutputRanges(*RangesOrError);
LLVM_DEBUG(if (OutputRanges.empty() != RangesOrError->empty()) {
dbgs() << "BOLT-DEBUG: problem with DIE at 0x"
<< Twine::utohexstr(DIE.getOffset()) << " in CU at 0x"
<< Twine::utohexstr(Unit.getOffset()) << '\n';
});
RangesSectionOffset = RangesSectionWriter.addRanges(
std::move(OutputRanges), CachedRanges);
} else if (!RangesOrError) {
ErrorState = true;
consumeError(RangesOrError.takeError());
}
uint64_t LowPCToUse = 0;
if (!ErrorState && RangesOrError.get().size() == 1 &&
RangesOrError.get().begin()->LowPC ==
RangesOrError.get().begin()->HighPC) {
if (!OutputRanges.empty())
LowPCToUse = OutputRanges.front().LowPC;
else
LowPCToUse = RangesOrError.get().begin()->LowPC;
}
updateDWARFObjectAddressRanges(DIE, RangesSectionOffset, DebugInfoPatcher,
AbbrevWriter);
AbbrevWriter, LowPCToUse);
break;
}
case dwarf::DW_TAG_call_site: {
@ -779,7 +792,7 @@ void DWARFRewriter::updateUnitDebugInfo(
void DWARFRewriter::updateDWARFObjectAddressRanges(
const DWARFDie DIE, uint64_t DebugRangesOffset,
SimpleBinaryPatcher &DebugInfoPatcher, DebugAbbrevWriter &AbbrevWriter,
Optional<uint64_t> RangesBase) {
uint64_t LowPCToUse, Optional<uint64_t> RangesBase) {
// Some objects don't have an associated DIE and cannot be updated (such as
// compiler-generated functions).
@ -841,7 +854,7 @@ void DWARFRewriter::updateDWARFObjectAddressRanges(
if (LowPCAttrInfo &&
LowPCAttrInfo->V.getForm() != dwarf::DW_FORM_GNU_addr_index &&
LowPCAttrInfo->V.getForm() != dwarf::DW_FORM_addrx)
DebugInfoPatcher.addLE64Patch(LowPCAttrInfo->Offset, 0);
DebugInfoPatcher.addLE64Patch(LowPCAttrInfo->Offset, LowPCToUse);
return;
}
@ -871,7 +884,7 @@ void DWARFRewriter::updateDWARFObjectAddressRanges(
convertToRangesPatchAbbrev(*DIE.getDwarfUnit(), AbbreviationDecl,
AbbrevWriter, RangesBase);
convertToRangesPatchDebugInfo(DIE, DebugRangesOffset, DebugInfoPatcher,
RangesBase);
LowPCToUse, RangesBase);
} else {
if (opts::Verbosity >= 1)
errs() << "BOLT-ERROR: cannot update ranges for DIE at offset 0x"
@ -1873,7 +1886,8 @@ void DWARFRewriter::convertToRangesPatchAbbrev(
void DWARFRewriter::convertToRangesPatchDebugInfo(
DWARFDie DIE, uint64_t RangesSectionOffset,
SimpleBinaryPatcher &DebugInfoPatcher, Optional<uint64_t> RangesBase) {
SimpleBinaryPatcher &DebugInfoPatcher, uint64_t LowPCToUse,
Optional<uint64_t> RangesBase) {
Optional<AttrInfo> LowPCVal = None;
Optional<AttrInfo> HighPCVal = None;
getRangeAttrData(DIE, LowPCVal, HighPCVal);
@ -1900,10 +1914,10 @@ void DWARFRewriter::convertToRangesPatchDebugInfo(
// when it's absent.
if (LowForm == dwarf::DW_FORM_addrx) {
const uint32_t Index =
AddrWriter->getIndexFromAddress(0, *DIE.getDwarfUnit());
AddrWriter->getIndexFromAddress(LowPCToUse, *DIE.getDwarfUnit());
DebugInfoPatcher.addUDataPatch(LowPCOffset, Index, LowPCVal->Size);
} else
DebugInfoPatcher.addLE64Patch(LowPCOffset, 0);
DebugInfoPatcher.addLE64Patch(LowPCOffset, LowPCToUse);
// Original CU didn't have DW_AT_*_base. We converted it's children (or
// dwo), so need to insert it into CU.

View File

@ -0,0 +1,364 @@
# REQUIRES: system-linux
# RUN: llvm-mc -dwarf-version=4 -filetype=obj -triple x86_64-unknown-linux %s -o %tmain.o
# RUN: %clang %cflags -dwarf-5 %tmain.o -o %t.exe -Wl,-q
# RUN: llvm-bolt %t.exe -o %t.bolt --update-debug-sections
# RUN: llvm-dwarfdump --show-form --verbose --debug-info %t.bolt | FileCheck --check-prefix=CHECK %s
# CHECK: DW_TAG_inlined_subroutine
# CHECK: DW_AT_low_pc [DW_FORM_addr] (0x[[#%.16x,ADDR:]])
# CHECK: DW_AT_ranges [DW_FORM_sec_offset]
# CHECK-NEXT: [0x[[#ADDR]], 0x[[#ADDR]])
# Testing BOLT handles correctly when size of DW_AT_inlined_subroutine is 0.
# In other words DW_AT_high_pc is 0 or DW_AT_low_pc == DW_AT_high_pc.
# Modified assembly manually to set DW_AT_high_pc to 0.
# static int helper(int i) {
# return ++i;
# }
#
# int main(int argc, char *argv[]) {
# return helper(argc);
# }
.text
.file "main.cpp"
.globl _Z6helperi # -- Begin function _Z6helperi
.p2align 4, 0x90
.type _Z6helperi,@function
_Z6helperi: # @_Z6helperi
.Lfunc_begin0:
.file 1 "." "main.cpp"
.loc 1 1 0 # main.cpp:1:0
.cfi_startproc
# %bb.0: # %entry
#DEBUG_VALUE: helper:i <- $edi
# kill: def $edi killed $edi def $rdi
.loc 1 2 10 prologue_end # main.cpp:2:10
leal 1(%rdi), %eax
.Ltmp0:
#DEBUG_VALUE: helper:i <- $eax
.loc 1 2 3 is_stmt 0 # main.cpp:2:3
retq
.Ltmp1:
.Lfunc_end0:
.size _Z6helperi, .Lfunc_end0-_Z6helperi
.cfi_endproc
# -- End function
.globl main # -- Begin function main
.p2align 4, 0x90
.type main,@function
main: # @main
.Lfunc_begin1:
.loc 1 5 0 is_stmt 1 # main.cpp:5:0
.cfi_startproc
# %bb.0: # %entry
#DEBUG_VALUE: main:argc <- $edi
#DEBUG_VALUE: main:argv <- $rsi
#DEBUG_VALUE: helper:i <- $edi
# kill: def $edi killed $edi def $rdi
.loc 1 2 10 prologue_end # main.cpp:2:10
leal 1(%rdi), %eax
.Ltmp2:
#DEBUG_VALUE: helper:i <- $eax
.loc 1 6 3 # main.cpp:6:3
retq
.Ltmp3:
.Lfunc_end1:
.size main, .Lfunc_end1-main
.cfi_endproc
# -- End function
.section .debug_loc,"",@progbits
.Ldebug_loc0:
.quad .Lfunc_begin0-.Lfunc_begin0
.quad .Ltmp0-.Lfunc_begin0
.short 1 # Loc expr size
.byte 85 # super-register DW_OP_reg5
.quad .Ltmp0-.Lfunc_begin0
.quad .Lfunc_end0-.Lfunc_begin0
.short 1 # Loc expr size
.byte 80 # super-register DW_OP_reg0
.quad 0
.quad 0
.Ldebug_loc1:
.quad .Lfunc_begin1-.Lfunc_begin0
.quad .Ltmp2-.Lfunc_begin0
.short 1 # Loc expr size
.byte 85 # super-register DW_OP_reg5
.quad .Ltmp2-.Lfunc_begin0
.quad .Lfunc_end1-.Lfunc_begin0
.short 1 # Loc expr size
.byte 80 # super-register DW_OP_reg0
.quad 0
.quad 0
.section .debug_abbrev,"",@progbits
.byte 1 # Abbreviation Code
.byte 17 # DW_TAG_compile_unit
.byte 1 # DW_CHILDREN_yes
.byte 37 # DW_AT_producer
.byte 14 # DW_FORM_strp
.byte 19 # DW_AT_language
.byte 5 # DW_FORM_data2
.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 1 # DW_CHILDREN_yes
.byte 17 # DW_AT_low_pc
.byte 1 # DW_FORM_addr
.byte 18 # DW_AT_high_pc
.byte 6 # DW_FORM_data4
.byte 64 # DW_AT_frame_base
.byte 24 # DW_FORM_exprloc
.ascii "\227B" # DW_AT_GNU_all_call_sites
.byte 25 # DW_FORM_flag_present
.byte 49 # DW_AT_abstract_origin
.byte 19 # DW_FORM_ref4
.byte 0 # EOM(1)
.byte 0 # EOM(2)
.byte 3 # Abbreviation Code
.byte 5 # DW_TAG_formal_parameter
.byte 0 # DW_CHILDREN_no
.byte 2 # DW_AT_location
.byte 23 # DW_FORM_sec_offset
.byte 49 # DW_AT_abstract_origin
.byte 19 # DW_FORM_ref4
.byte 0 # EOM(1)
.byte 0 # EOM(2)
.byte 4 # Abbreviation Code
.byte 46 # DW_TAG_subprogram
.byte 1 # DW_CHILDREN_yes
.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 73 # DW_AT_type
.byte 19 # DW_FORM_ref4
.byte 63 # DW_AT_external
.byte 25 # DW_FORM_flag_present
.byte 32 # DW_AT_inline
.byte 11 # DW_FORM_data1
.byte 0 # EOM(1)
.byte 0 # EOM(2)
.byte 5 # Abbreviation Code
.byte 5 # DW_TAG_formal_parameter
.byte 0 # DW_CHILDREN_no
.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 73 # DW_AT_type
.byte 19 # DW_FORM_ref4
.byte 0 # EOM(1)
.byte 0 # EOM(2)
.byte 6 # Abbreviation Code
.byte 36 # DW_TAG_base_type
.byte 0 # DW_CHILDREN_no
.byte 3 # DW_AT_name
.byte 14 # DW_FORM_strp
.byte 62 # DW_AT_encoding
.byte 11 # DW_FORM_data1
.byte 11 # DW_AT_byte_size
.byte 11 # DW_FORM_data1
.byte 0 # EOM(1)
.byte 0 # EOM(2)
.byte 7 # Abbreviation Code
.byte 46 # DW_TAG_subprogram
.byte 1 # DW_CHILDREN_yes
.byte 17 # DW_AT_low_pc
.byte 1 # DW_FORM_addr
.byte 18 # DW_AT_high_pc
.byte 6 # DW_FORM_data4
.byte 64 # DW_AT_frame_base
.byte 24 # DW_FORM_exprloc
.ascii "\227B" # DW_AT_GNU_all_call_sites
.byte 25 # DW_FORM_flag_present
.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 73 # DW_AT_type
.byte 19 # DW_FORM_ref4
.byte 63 # DW_AT_external
.byte 25 # DW_FORM_flag_present
.byte 0 # EOM(1)
.byte 0 # EOM(2)
.byte 8 # Abbreviation Code
.byte 5 # DW_TAG_formal_parameter
.byte 0 # DW_CHILDREN_no
.byte 2 # DW_AT_location
.byte 24 # DW_FORM_exprloc
.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 73 # DW_AT_type
.byte 19 # DW_FORM_ref4
.byte 0 # EOM(1)
.byte 0 # EOM(2)
.byte 9 # Abbreviation Code
.byte 29 # DW_TAG_inlined_subroutine
.byte 1 # DW_CHILDREN_yes
.byte 49 # DW_AT_abstract_origin
.byte 19 # DW_FORM_ref4
.byte 17 # DW_AT_low_pc
.byte 1 # DW_FORM_addr
.byte 18 # DW_AT_high_pc
.byte 6 # DW_FORM_data4
.byte 88 # DW_AT_call_file
.byte 11 # DW_FORM_data1
.byte 89 # DW_AT_call_line
.byte 11 # DW_FORM_data1
.byte 87 # DW_AT_call_column
.byte 11 # DW_FORM_data1
.byte 0 # EOM(1)
.byte 0 # EOM(2)
.byte 10 # Abbreviation Code
.byte 15 # DW_TAG_pointer_type
.byte 0 # DW_CHILDREN_no
.byte 73 # DW_AT_type
.byte 19 # DW_FORM_ref4
.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:0xc3 DW_TAG_compile_unit
.long .Linfo_string0 # DW_AT_producer
.short 33 # DW_AT_language
.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_end1-.Lfunc_begin0 # DW_AT_high_pc
.byte 2 # Abbrev [2] 0x2a:0x1d DW_TAG_subprogram
.quad .Lfunc_begin0 # DW_AT_low_pc
.long .Lfunc_end0-.Lfunc_begin0 # DW_AT_high_pc
.byte 1 # DW_AT_frame_base
.byte 87
# DW_AT_GNU_all_call_sites
.long 71 # DW_AT_abstract_origin
.byte 3 # Abbrev [3] 0x3d:0x9 DW_TAG_formal_parameter
.long .Ldebug_loc0 # DW_AT_location
.long 87 # DW_AT_abstract_origin
.byte 0 # End Of Children Mark
.byte 4 # Abbrev [4] 0x47:0x1c DW_TAG_subprogram
.long .Linfo_string3 # DW_AT_linkage_name
.long .Linfo_string4 # DW_AT_name
.byte 1 # DW_AT_decl_file
.byte 1 # DW_AT_decl_line
.long 99 # DW_AT_type
# DW_AT_external
.byte 1 # DW_AT_inline
.byte 5 # Abbrev [5] 0x57:0xb DW_TAG_formal_parameter
.long .Linfo_string6 # DW_AT_name
.byte 1 # DW_AT_decl_file
.byte 1 # DW_AT_decl_line
.long 99 # DW_AT_type
.byte 0 # End Of Children Mark
.byte 6 # Abbrev [6] 0x63:0x7 DW_TAG_base_type
.long .Linfo_string5 # DW_AT_name
.byte 5 # DW_AT_encoding
.byte 4 # DW_AT_byte_size
.byte 7 # Abbrev [7] 0x6a:0x52 DW_TAG_subprogram
.quad .Lfunc_begin1 # DW_AT_low_pc
.long .Lfunc_end1-.Lfunc_begin1 # DW_AT_high_pc
.byte 1 # DW_AT_frame_base
.byte 87
# DW_AT_GNU_all_call_sites
.long .Linfo_string7 # DW_AT_name
.byte 1 # DW_AT_decl_file
.byte 5 # DW_AT_decl_line
.long 99 # DW_AT_type
# DW_AT_external
.byte 8 # Abbrev [8] 0x83:0xd DW_TAG_formal_parameter
.byte 1 # DW_AT_location
.byte 85
.long .Linfo_string8 # DW_AT_name
.byte 1 # DW_AT_decl_file
.byte 5 # DW_AT_decl_line
.long 99 # DW_AT_type
.byte 8 # Abbrev [8] 0x90:0xd DW_TAG_formal_parameter
.byte 1 # DW_AT_location
.byte 84
.long .Linfo_string9 # DW_AT_name
.byte 1 # DW_AT_decl_file
.byte 5 # DW_AT_decl_line
.long 188 # DW_AT_type
.byte 9 # Abbrev [9] 0x9d:0x1e DW_TAG_inlined_subroutine
.long 71 # DW_AT_abstract_origin
.quad .Lfunc_begin1 # DW_AT_low_pc
.long 0 # DW_AT_high_pc # This was manually modified to be 0
.byte 1 # DW_AT_call_file
.byte 6 # DW_AT_call_line
.byte 10 # DW_AT_call_column
.byte 3 # Abbrev [3] 0xb1:0x9 DW_TAG_formal_parameter
.long .Ldebug_loc1 # DW_AT_location
.long 87 # DW_AT_abstract_origin
.byte 0 # End Of Children Mark
.byte 0 # End Of Children Mark
.byte 10 # Abbrev [10] 0xbc:0x5 DW_TAG_pointer_type
.long 193 # DW_AT_type
.byte 10 # Abbrev [10] 0xc1:0x5 DW_TAG_pointer_type
.long 198 # DW_AT_type
.byte 6 # Abbrev [6] 0xc6:0x7 DW_TAG_base_type
.long .Linfo_string10 # DW_AT_name
.byte 6 # DW_AT_encoding
.byte 1 # DW_AT_byte_size
.byte 0 # End Of Children Mark
.Ldebug_info_end0:
.section .debug_str,"MS",@progbits,1
.Linfo_string0:
.asciz "clang version 15.0.0" # string offset=0
.Linfo_string1:
.asciz "main.cpp" # string offset=134
.Linfo_string2:
.asciz "." # string offset=143
.Linfo_string3:
.asciz "_Z6helperi" # string offset=181
.Linfo_string4:
.asciz "helper" # string offset=192
.Linfo_string5:
.asciz "int" # string offset=199
.Linfo_string6:
.asciz "i" # string offset=203
.Linfo_string7:
.asciz "main" # string offset=205
.Linfo_string8:
.asciz "argc" # string offset=210
.Linfo_string9:
.asciz "argv" # string offset=215
.Linfo_string10:
.asciz "char" # string offset=220
.ident "clang version 15.0.0"
.section ".note.GNU-stack","",@progbits
.addrsig
.section .debug_line,"",@progbits
.Lline_table_start0: