[DebugInfo] Unify dumping of address ranges

[JDevlieghere]

Summary

This patch unifies the printing of address ranges as [0x0, 0x1).

rdar://34822059

[dblaikie]

Looks good to me

test/tools/dsymutil/X86/basic-lto-dw4-linking-x86.test

110–111

Looks like there's an opportunity to print these ranges similarly.

include/llvm/DebugInfo/DWARF/DWARFDebugArangeSet.h

struct Header {
     uint8_t SegSize;
   };
 
   struct Descriptor {
     uint64_t Address;
     uint64_t Length;
 
     uint64_t getEndAddress() const { return Address + Length; }
+    void dump(raw_ostream &OS, uint32_t AddressSize) const;
   };
 
 private:
   using DescriptorColl = std::vector<Descriptor>;
   using desc_iterator_range = iterator_range<DescriptorColl::const_iterator>;
 
   uint32_t Offset;
   Header HeaderData;

include/llvm/DebugInfo/DWARF/DWARFDebugRangeList.h

struct DWARFAddressRange {
   }
 
   /// Returns true if [LowPC, HighPC) fully contains [RHS.LowPC, RHS.HighPC).
   bool contains(const DWARFAddressRange &RHS) const {
     if (LowPC <= RHS.LowPC && RHS.LowPC <= HighPC)
       return LowPC <= RHS.HighPC && RHS.HighPC <= HighPC;
     return false;
   }
+
+  void dump(raw_ostream &OS, uint32_t AddressSize) const;
 };
 
 static inline bool operator<(const DWARFAddressRange &LHS,
                              const DWARFAddressRange &RHS) {
   return std::tie(LHS.LowPC, LHS.HighPC) < std::tie(RHS.LowPC, RHS.HighPC);
 }
 
 raw_ostream &operator<<(raw_ostream &OS, const DWARFAddressRange &R);

lib/DebugInfo/DWARF/DWARFDebugArangeSet.cpp

 #include "llvm/Support/raw_ostream.h"
 #include <cassert>
 #include <cinttypes>
 #include <cstdint>
 #include <cstring>
 
 using namespace llvm;
 
+void DWARFDebugArangeSet::Descriptor::dump(raw_ostream &OS,
+                                           uint32_t AddressSize) const {
+  OS << format("[0x%*.*" PRIx64 ", ", AddressSize * 2, AddressSize * 2, Address)
+     << format(" 0x%*.*" PRIx64 ")", AddressSize * 2, AddressSize * 2,
+               getEndAddress());
+}
+
 void DWARFDebugArangeSet::clear() {
   Offset = -1U;
   std::memset(&HeaderData, 0, sizeof(Header));
   ArangeDescriptors.clear();
 }
 
 bool
 DWARFDebugArangeSet::extract(DataExtractor data, uint32_t *offset_ptr) {

 }
 
 void DWARFDebugArangeSet::dump(raw_ostream &OS) const {
   OS << format("Address Range Header: length = 0x%8.8x, version = 0x%4.4x, ",
                HeaderData.Length, HeaderData.Version)
      << format("cu_offset = 0x%8.8x, addr_size = 0x%2.2x, seg_size = 0x%2.2x\n",
                HeaderData.CuOffset, HeaderData.AddrSize, HeaderData.SegSize);
 
-  const uint32_t hex_width = HeaderData.AddrSize * 2;
   for (const auto &Desc : ArangeDescriptors) {
-    OS << format("[0x%*.*" PRIx64 " -", hex_width, hex_width, Desc.Address)
-       << format(" 0x%*.*" PRIx64 ")\n",
-                 hex_width, hex_width, Desc.getEndAddress());
+    Desc.dump(OS, HeaderData.AddrSize);
+    OS << '\n';
   }
 }

lib/DebugInfo/DWARF/DWARFDebugRangeList.cpp

 #include "llvm/Support/Format.h"
 #include "llvm/Support/raw_ostream.h"
 #include <cinttypes>
 #include <cstdint>
 #include <utility>
 
 using namespace llvm;
 
+void DWARFAddressRange::dump(raw_ostream &OS, uint32_t AddressSize) const {
+
+  OS << format("[0x%*.*" PRIx64 ", ", AddressSize * 2, AddressSize * 2, LowPC)
+     << format(" 0x%*.*" PRIx64 ")", AddressSize * 2, AddressSize * 2, HighPC);
+}
+
 raw_ostream &llvm::operator<<(raw_ostream &OS, const DWARFAddressRange &R) {
-  return OS << format("[0x%16.16" PRIx64 ", 0x%16.16" PRIx64 ")", R.LowPC,
-                      R.HighPC);
+  R.dump(OS, /* AddressSize */ 8);
+  return OS;
 }
 
 void DWARFDebugRangeList::clear() {
   Offset = -1U;
   AddressSize = 0;
   Entries.clear();
 }
 

lib/DebugInfo/DWARF/DWARFDie.cpp

 static void dumpRanges(const DWARFObject &Obj, raw_ostream &OS,
                        const DWARFAddressRangesVector &Ranges,
                        unsigned AddressSize, unsigned Indent,
                        const DIDumpOptions &DumpOpts) {
   ArrayRef<SectionName> SectionNames;
   if (DumpOpts.Verbose)
     SectionNames = Obj.getSectionNames();
 
-  for (size_t I = 0; I < Ranges.size(); ++I) {
-    const DWARFAddressRange &R = Ranges[I];
+  for (const DWARFAddressRange &R : Ranges) {
 
     OS << '\n';
     OS.indent(Indent);
-    OS << format("[0x%0*" PRIx64 " - 0x%0*" PRIx64 ")", AddressSize * 2,
-                 R.LowPC, AddressSize * 2, R.HighPC);
+    R.dump(OS, AddressSize);
 
     if (SectionNames.empty() || R.SectionIndex == -1ULL)
       continue;
 
     StringRef Name = SectionNames[R.SectionIndex].Name;
     OS << " \"" << Name << '\"';
 
     // Print section index if name is not unique.

test/DebugInfo/X86/dwarfdump-ranges-baseaddr-exe.s

 # RUN: llvm-dwarfdump -v %S/../Inputs/dwarfdump-ranges-baseaddr-exe.elf-x86-64 \
 # RUN:  | FileCheck %s
 
-## Executable binary for test produced from object built in 
+## Executable binary for test produced from object built in
 ## dwarfdump-ranges-baseaddr.s testcase.
 
 # CHECK: .debug_info contents:
 # CHECK: 0x0000000b: DW_TAG_compile_unit [1]
 # CHECK:             DW_AT_low_pc [DW_FORM_addr]       (0x0000000000400078)
 # CHECK-NEXT:        DW_AT_ranges [DW_FORM_sec_offset] (0x00000000
-# CHECK-NEXT:    [0x0000000000400078 - 0x0000000000400079)
-# CHECK-NEXT:    [0x000000000040007b - 0x000000000040007e)
-# CHECK-NEXT:    [0x000000000040007f - 0x0000000000400080))
+# CHECK-NEXT:    [0x0000000000400078, 0x0000000000400079)
+# CHECK-NEXT:    [0x000000000040007b, 0x000000000040007e)
+# CHECK-NEXT:    [0x000000000040007f, 0x0000000000400080))

test/DebugInfo/X86/dwarfdump-ranges-baseaddr.s

 # RUN: llvm-mc -triple x86_64-pc-linux -filetype=obj %s -o %t
 # RUN: llvm-dwarfdump -v %t | FileCheck %s
 
 # CHECK: .debug_info contents:
 # CHECK: 0x0000000b: DW_TAG_compile_unit [1]
 # CHECK:             DW_AT_low_pc [DW_FORM_addr]       (0x0000000000000000)
 # CHECK-NEXT:        DW_AT_ranges [DW_FORM_sec_offset] (0x00000000
-# CHECK-NEXT:    [0x0000000000000000 - 0x0000000000000001) ".text"
-# CHECK-NEXT:    [0x0000000000000003 - 0x0000000000000006) ".text"
-# CHECK-NEXT:    [0x0000000000000001 - 0x0000000000000002) ".text.foo1")
+# CHECK-NEXT:    [0x0000000000000000, 0x0000000000000001) ".text"
+# CHECK-NEXT:    [0x0000000000000003, 0x0000000000000006) ".text"
+# CHECK-NEXT:    [0x0000000000000001, 0x0000000000000002) ".text.foo1")
 
 .text
 .globl foo
 .type foo,@function
-foo: 
+foo:
 .Lfunc_begin0:
   nop
 .Ltmp0:
   nop
   nop
 .Ltmp1:
   nop
   nop
   nop
 .Ltmp2:
 
 .section .text.foo1,"ax",@progbits
 .Ltmp3:
  nop
-.Ltmp4: 
+.Ltmp4:
  nop
 .Ltmp5:
 
 .section .debug_abbrev,"",@progbits
 .byte 1                       # Abbreviation Code
 .byte 17                      # DW_TAG_compile_unit
 .byte 0                       # DW_CHILDREN_no
 .byte 37                      # DW_AT_producer

test/DebugInfo/X86/dwarfdump-ranges-unrelocated.s

 # RUN: llvm-mc -triple x86_64-pc-linux -filetype=obj %s -o %t
 # RUN: llvm-dwarfdump -v %t | FileCheck %s
 
 # CHECK: .debug_info contents:
 # CHECK: DW_TAG_compile_unit
 # CHECK: DW_AT_ranges [DW_FORM_sec_offset] (0x00000000
-# CHECK-NEXT:  [0x0000000000000000 - 0x0000000000000001) ".text.foo1"
-# CHECK-NEXT:  [0x0000000000000000 - 0x0000000000000002) ".text.foo2" [4]
-# CHECK-NEXT:  [0x0000000000000000 - 0x0000000000000003) ".text.foo2" [5])
+# CHECK-NEXT:  [0x0000000000000000, 0x0000000000000001) ".text.foo1"
+# CHECK-NEXT:  [0x0000000000000000, 0x0000000000000002) ".text.foo2" [4]
+# CHECK-NEXT:  [0x0000000000000000, 0x0000000000000003) ".text.foo2" [5])
 
 # CHECK: .debug_ranges contents:
 # CHECK:   00000000 0000000000000000 0000000000000001
 # CHECK:   00000000 0000000000000000 0000000000000002
 # CHECK:   00000000 0000000000000000 0000000000000003
 # CHECK:   00000000 <End of list>
 
 # RUN: llvm-dwarfdump %t | FileCheck %s --check-prefix=BRIEF
 # BRIEF: DW_TAG_compile_unit
 # BRIEF: DW_AT_ranges         (0x00000000
-# BRIEF-NEXT:  [0x0000000000000000 - 0x0000000000000001)
-# BRIEF-NEXT:  [0x0000000000000000 - 0x0000000000000002)
-# BRIEF-NEXT:  [0x0000000000000000 - 0x0000000000000003))
+# BRIEF-NEXT:  [0x0000000000000000, 0x0000000000000001)
+# BRIEF-NEXT:  [0x0000000000000000, 0x0000000000000002)
+# BRIEF-NEXT:  [0x0000000000000000, 0x0000000000000003))
 
 ## Asm code for testcase is a reduced and modified output from next
 ## invocation and source:
 # clang test.cpp -S -o test.s -gmlt -ffunction-sections
 # test.cpp:
-#   void foo1() { }  
-#   void foo2() { }  
+#   void foo1() { }
+#   void foo2() { }
 
 .section .text.foo1,"ax",@progbits
 .Lfunc_begin0:
  nop
 .Lfunc_end0:
 
 .section .text.foo2,"ax",@progbits, unique, 1
 .Lfunc_begin1:

test/DebugInfo/dwarfdump-ranges.test

 RUN: llvm-dwarfdump -v %p/Inputs/dwarfdump-test4.elf-x86-64 | FileCheck %s
 
 CHECK: .debug_info contents:
 CHECK: DW_TAG_compile_unit
 CHECK-NOT: TAG
 CHECK:  DW_AT_ranges [DW_FORM_data4]      (0x00000000
-CHECK-NEXT:          [0x000000000000062c - 0x0000000000000637)
-CHECK-NEXT:          [0x0000000000000637 - 0x000000000000063d))
+CHECK-NEXT:          [0x000000000000062c, 0x0000000000000637)
+CHECK-NEXT:          [0x0000000000000637, 0x000000000000063d))
 
 CHECK: DW_TAG_compile_unit
 CHECK-NOT: TAG
 CHECK:  DW_AT_ranges [DW_FORM_data4]      (0x00000030
-CHECK-NEXT:          [0x0000000000000640 - 0x000000000000064b)
-CHECK-NEXT:          [0x0000000000000637 - 0x000000000000063d))
+CHECK-NEXT:          [0x0000000000000640, 0x000000000000064b)
+CHECK-NEXT:          [0x0000000000000637, 0x000000000000063d))
 
 
 CHECK:      .debug_ranges contents:
 CHECK-NEXT: 00000000 000000000000062c 0000000000000637
 CHECK-NEXT: 00000000 0000000000000637 000000000000063d
 CHECK-NEXT: 00000000 <End of list>
 CHECK-NEXT: 00000030 0000000000000640 000000000000064b
 CHECK-NEXT: 00000030 0000000000000637 000000000000063d
 CHECK-NEXT: 00000030 <End of list>
 

test/tools/dsymutil/X86/basic-linking-x86.test

 CHECK:      DW_AT_frame_base (DW_OP_reg6 RBP)
 
 CHECK:    NULL
 
 CHECK-NOT: .debug_loc contents
 
 CHECK:.debug_aranges contents:
 CHECK-NEXT:Address Range Header: length = 0x0000002c, version = 0x0002, cu_offset = 0x00000000, addr_size = 0x08, seg_size = 0x00
-CHECK-NEXT:[0x0000000100000ea0 - 0x0000000100000ec4)
+CHECK-NEXT:[0x0000000100000ea0, 0x0000000100000ec4)
 CHECK-NEXT:Address Range Header: length = 0x0000003c, version = 0x0002, cu_offset = 0x00000081, addr_size = 0x08, seg_size = 0x00
-CHECK-NEXT:[0x0000000100000ed0 - 0x0000000100000f19)
-CHECK-NEXT:[0x0000000100000f20 - 0x0000000100000f37)
+CHECK-NEXT:[0x0000000100000ed0, 0x0000000100000f19)
+CHECK-NEXT:[0x0000000100000f20, 0x0000000100000f37)
 CHECK-NEXT:Address Range Header: length = 0x0000003c, version = 0x0002, cu_offset = 0x00000126, addr_size = 0x08, seg_size = 0x00
-CHECK-NEXT:[0x0000000100000f40 - 0x0000000100000f84)
-CHECK-NEXT:[0x0000000100000f90 - 0x0000000100000fa9)
+CHECK-NEXT:[0x0000000100000f40, 0x0000000100000f84)
+CHECK-NEXT:[0x0000000100000f90, 0x0000000100000fa9)
 
 CHECK: .debug_line contents:
 CHECK:                Dir  Mod Time   File Len   File Name
 CHECK-NEXT:                 ---- ---------- ---------- ---------------------------
 CHECK-NEXT: file_names[  1]    0 0x00000000 0x00000000 basic1.c
 CHECK: Address            Line   Column File   ISA Discriminator Flags
 CHECK-NEXT: ------------------ ------ ------ ------ --- ------------- -------------
 CHECK-NEXT: 0x0000000100000ea0     23      0      1   0             0  is_stmt

test/tools/dsymutil/X86/basic-lto-dw4-linking-x86.test

 CHECK:      DW_AT_inline (DW_INL_inlined)
 CHECK:    DW_TAG_subprogram
 CHECK:      DW_AT_low_pc (0x0000000100000f90)
 CHECK:      DW_AT_high_pc (0x0000000100000fb4)
 CHECK:      DW_AT_frame_base (DW_OP_reg6 RBP)
 CHECK:      DW_AT_name ("bar")
 CHECK:      DW_TAG_formal_parameter
 CHECK:        DW_AT_location (0x00000025
 CHECK:          0x0000000000000000 - 0x000000000000000f: DW_OP_reg5 RDI, DW_OP_piece 0x4
 CHECK:          0x0000000000000019 - 0x000000000000001d: DW_OP_reg5 RDI, DW_OP_piece 0x4)
 CHECK:        DW_AT_name ("arg")
 CHECK:      DW_TAG_inlined_subroutine
 CHECK:        DW_AT_abstract_origin (cu + 0x0044 "inc")
 CHECK:        DW_AT_ranges (0x00000000
-CHECK:           [0x0000000100000f94 - 0x0000000100000f9a)
-CHECK:           [0x0000000100000f9f - 0x0000000100000fa7))
+CHECK:           [0x0000000100000f94, 0x0000000100000f9a)
+CHECK:           [0x0000000100000f9f, 0x0000000100000fa7))
 
 CHECK:      NULL
 CHECK:    NULL
 
 
 CHECK: .debug_loc contents:
 CHECK-NEXT: 0x00000000:
 CHECK-NEXT:              0x0000000000000000 - 0x000000000000000c: DW_OP_reg5 RDI, DW_OP_piece 0x4
 CHECK-NOT: :
 CHECK:      0x00000025:
 CHECK-NEXT:              0x0000000000000000 - 0x000000000000000f: DW_OP_reg5 RDI, DW_OP_piece 0x4
 CHECK-NEXT:              0x0000000000000019 - 0x000000000000001d: DW_OP_reg5 RDI, DW_OP_piece 0x4
 
 
 CHECK: .debug_aranges contents:
 CHECK-NEXT: Address Range Header: length = 0x0000002c, version = 0x0002, cu_offset = 0x00000000, addr_size = 0x08, seg_size = 0x00
-CHECK-NEXT: [0x0000000100000f40 - 0x0000000100000f4b)
+CHECK-NEXT: [0x0000000100000f40,  0x0000000100000f4b)
 CHECK-NEXT: Address Range Header: length = 0x0000002c, version = 0x0002, cu_offset = 0x00000077, addr_size = 0x08, seg_size = 0x00
-CHECK-NEXT: [0x0000000100000f50 - 0x0000000100000f87)
+CHECK-NEXT: [0x0000000100000f50, 0x0000000100000f87)
 CHECK-NEXT: Address Range Header: length = 0x0000002c, version = 0x0002, cu_offset = 0x0000011b, addr_size = 0x08, seg_size = 0x00
-CHECK-NEXT: [0x0000000100000f90 - 0x0000000100000fb4)
+CHECK-NEXT: [0x0000000100000f90, 0x0000000100000fb4)
 
 CHECK: .debug_line contents:
 CHECK:                 Dir  Mod Time   File Len   File Name
 CHECK-NEXT:                 ---- ---------- ---------- ---------------------------
 CHECK-NEXT: file_names[  1]    0 0x00000000 0x00000000 basic1.c
 CHECK: Address            Line   Column File   ISA Discriminator Flags
 CHECK-NEXT: ------------------ ------ ------ ------ --- ------------- -------------
 CHECK-NEXT: 0x0000000100000f40     26      0      1   0             0  is_stmt

test/tools/dsymutil/X86/basic-lto-linking-x86.test

 CHECK:          0x0000000000000000 - 0x000000000000000f: DW_OP_reg5 RDI, DW_OP_piece 0x4
 CHECK:          0x0000000000000019 - 0x000000000000001d: DW_OP_reg5 RDI, DW_OP_piece 0x4)
 CHECK:      DW_TAG_lexical_block
 CHECK:        DW_AT_low_pc (0x0000000100000f94)
 CHECK:        DW_AT_high_pc (0x0000000100000fa7)
 CHECK:        DW_TAG_inlined_subroutine
 CHECK:          DW_AT_abstract_origin (cu + 0x009a "inc")
 CHECK:          DW_AT_ranges (0x00000000
-CHECK:             [0x0000000100000f94 - 0x0000000100000f9a)
-CHECK:             [0x0000000100000f9f - 0x0000000100000fa7))
+CHECK:             [0x0000000100000f94, 0x0000000100000f9a)
+CHECK:             [0x0000000100000f9f, 0x0000000100000fa7))
 CHECK:        NULL
 CHECK:      NULL
 CHECK:    DW_TAG_subprogram
 CHECK:      DW_AT_name ("inc")
 CHECK:      DW_AT_type (0x0000000000000063
 CHECK:    NULL
 
 CHECK: .debug_loc contents:
 CHECK-NEXT: 0x00000000:
 CHECK-NEXT:              0x0000000000000000 - 0x000000000000000e: DW_OP_reg5 RDI, DW_OP_piece 0x4
 CHECK-NOT: :
 CHECK:      0x00000025:
 CHECK-NEXT:              0x0000000000000000 - 0x000000000000000f: DW_OP_reg5 RDI, DW_OP_piece 0x4
 CHECK-NEXT:              0x0000000000000019 - 0x000000000000001d: DW_OP_reg5 RDI, DW_OP_piece 0x4
 
 CHECK: .debug_aranges contents:
 CHECK-NEXT: Address Range Header: length = 0x0000002c, version = 0x0002, cu_offset = 0x00000000, addr_size = 0x08, seg_size = 0x00
-CHECK-NEXT: [0x0000000100000f40 - 0x0000000100000f4b)
+CHECK-NEXT: [0x0000000100000f40, 0x0000000100000f4b)
 CHECK-NEXT: Address Range Header: length = 0x0000002c, version = 0x0002, cu_offset = 0x00000081, addr_size = 0x08, seg_size = 0x00
-CHECK-NEXT: [0x0000000100000f50 - 0x0000000100000f89)
+CHECK-NEXT: [0x0000000100000f50, 0x0000000100000f89)
 CHECK-NEXT: Address Range Header: length = 0x0000002c, version = 0x0002, cu_offset = 0x0000013a, addr_size = 0x08, seg_size = 0x00
-CHECK-NEXT: [0x0000000100000f90 - 0x0000000100000fb4)
+CHECK-NEXT: [0x0000000100000f90, 0x0000000100000fb4)
 
 
 CHECK: .debug_line contents
 CHECK:                 Dir  Mod Time   File Len   File Name
 CHECK-NEXT:                 ---- ---------- ---------- ---------------------------
 CHECK-NEXT: file_names[  1]    0 0x00000000 0x00000000 basic1.c
 CHECK: 0x0000000100000f40     23      0      1   0             0  is_stmt
 CHECK: 0x0000000100000f44     24      0      1   0             0  is_stmt prologue_end