[llvm] 1ab3d6c - [DWARFYAML] Implement the .debug_rnglists section.
Xing GUO via llvm-commits
llvm-commits at lists.llvm.org
Sun Jul 19 19:42:53 PDT 2020
Author: Xing GUO
Date: 2020-07-20T10:42:27+08:00
New Revision: 1ab3d6c81902022da245707697dfe173cc5a07a2
URL: https://github.com/llvm/llvm-project/commit/1ab3d6c81902022da245707697dfe173cc5a07a2
DIFF: https://github.com/llvm/llvm-project/commit/1ab3d6c81902022da245707697dfe173cc5a07a2.diff
LOG: [DWARFYAML] Implement the .debug_rnglists section.
This patch implements the .debug_rnglists section. We are able to
produce the .debug_rnglists section by the following syntax.
```
debug_rnglists:
- Format: DWARF32 ## Optional
Length: 0x1234 ## Optional
Version: 5 ## Optional
AddressSize: 0x08 ## Optional
SegmentSelectorSize: 0x00 ## Optional
OffsetEntryCount: 2 ## Optional
Offsets: [1, 2] ## Optional
Lists:
- Entries:
- Operator: DW_RLE_base_address
Values: [ 0x1234 ]
```
The generated .debug_rnglists is verified by llvm-dwarfdump, except for
the operator DW_RLE_startx_endx, since llvm-dwarfdump doesn't support
it.
Reviewed By: jhenderson
Differential Revision: https://reviews.llvm.org/D83624
Added:
llvm/test/tools/yaml2obj/ELF/DWARF/debug-rnglists.yaml
Modified:
llvm/include/llvm/ObjectYAML/DWARFEmitter.h
llvm/include/llvm/ObjectYAML/DWARFYAML.h
llvm/lib/ObjectYAML/DWARFEmitter.cpp
llvm/lib/ObjectYAML/DWARFYAML.cpp
llvm/lib/ObjectYAML/ELFEmitter.cpp
Removed:
################################################################################
diff --git a/llvm/include/llvm/ObjectYAML/DWARFEmitter.h b/llvm/include/llvm/ObjectYAML/DWARFEmitter.h
index 1552ec7c178e..ff07ddaca951 100644
--- a/llvm/include/llvm/ObjectYAML/DWARFEmitter.h
+++ b/llvm/include/llvm/ObjectYAML/DWARFEmitter.h
@@ -39,6 +39,7 @@ Error emitDebugInfo(raw_ostream &OS, const Data &DI);
Error emitDebugLine(raw_ostream &OS, const Data &DI);
Error emitDebugAddr(raw_ostream &OS, const Data &DI);
Error emitDebugStrOffsets(raw_ostream &OS, const Data &DI);
+Error emitDebugRnglists(raw_ostream &OS, const Data &DI);
Expected<StringMap<std::unique_ptr<MemoryBuffer>>>
emitDebugSections(StringRef YAMLString, bool ApplyFixups = false,
diff --git a/llvm/include/llvm/ObjectYAML/DWARFYAML.h b/llvm/include/llvm/ObjectYAML/DWARFYAML.h
index 244a5ff19298..4ece647655bf 100644
--- a/llvm/include/llvm/ObjectYAML/DWARFYAML.h
+++ b/llvm/include/llvm/ObjectYAML/DWARFYAML.h
@@ -185,6 +185,26 @@ struct StringOffsetsTable {
std::vector<yaml::Hex64> Offsets;
};
+struct RnglistEntry {
+ dwarf::RnglistEntries Operator;
+ std::vector<yaml::Hex64> Values;
+};
+
+struct Rnglist {
+ std::vector<RnglistEntry> Entries;
+};
+
+struct RnglistTable {
+ dwarf::DwarfFormat Format;
+ Optional<yaml::Hex64> Length;
+ yaml::Hex16 Version;
+ Optional<yaml::Hex8> AddrSize;
+ yaml::Hex8 SegSelectorSize;
+ Optional<uint32_t> OffsetEntryCount;
+ Optional<std::vector<yaml::Hex64>> Offsets;
+ std::vector<Rnglist> Lists;
+};
+
struct Data {
bool IsLittleEndian;
bool Is64BitAddrSize;
@@ -203,6 +223,7 @@ struct Data {
std::vector<Unit> CompileUnits;
std::vector<LineTable> DebugLines;
+ Optional<std::vector<RnglistTable>> DebugRnglists;
bool isEmpty() const;
@@ -228,6 +249,9 @@ LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DWARFYAML::LineTableOpcode)
LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DWARFYAML::SegAddrPair)
LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DWARFYAML::AddrTableEntry)
LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DWARFYAML::StringOffsetsTable)
+LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DWARFYAML::RnglistTable)
+LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DWARFYAML::Rnglist)
+LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::DWARFYAML::RnglistEntry)
namespace llvm {
namespace yaml {
@@ -296,6 +320,18 @@ template <> struct MappingTraits<DWARFYAML::SegAddrPair> {
static void mapping(IO &IO, DWARFYAML::SegAddrPair &SegAddrPair);
};
+template <> struct MappingTraits<DWARFYAML::RnglistTable> {
+ static void mapping(IO &IO, DWARFYAML::RnglistTable &RnglistTable);
+};
+
+template <> struct MappingTraits<DWARFYAML::Rnglist> {
+ static void mapping(IO &IO, DWARFYAML::Rnglist &Rnglist);
+};
+
+template <> struct MappingTraits<DWARFYAML::RnglistEntry> {
+ static void mapping(IO &IO, DWARFYAML::RnglistEntry &RnglistEntry);
+};
+
template <> struct MappingTraits<DWARFYAML::AddrTableEntry> {
static void mapping(IO &IO, DWARFYAML::AddrTableEntry &AddrTable);
};
@@ -383,6 +419,15 @@ template <> struct ScalarEnumerationTraits<dwarf::Constants> {
}
};
+#define HANDLE_DW_RLE(unused, name) \
+ io.enumCase(value, "DW_RLE_" #name, dwarf::DW_RLE_##name);
+
+template <> struct ScalarEnumerationTraits<dwarf::RnglistEntries> {
+ static void enumeration(IO &io, dwarf::RnglistEntries &value) {
+#include "llvm/BinaryFormat/Dwarf.def"
+ }
+};
+
} // end namespace yaml
} // end namespace llvm
diff --git a/llvm/lib/ObjectYAML/DWARFEmitter.cpp b/llvm/lib/ObjectYAML/DWARFEmitter.cpp
index dc815cd69c12..425c802ec93b 100644
--- a/llvm/lib/ObjectYAML/DWARFEmitter.cpp
+++ b/llvm/lib/ObjectYAML/DWARFEmitter.cpp
@@ -441,6 +441,162 @@ Error DWARFYAML::emitDebugStrOffsets(raw_ostream &OS, const Data &DI) {
return Error::success();
}
+static Expected<uint64_t>
+writeRnglistEntry(raw_ostream &OS, const DWARFYAML::RnglistEntry &Entry,
+ uint8_t AddrSize, bool IsLittleEndian) {
+ uint64_t BeginOffset = OS.tell();
+ writeInteger((uint8_t)Entry.Operator, OS, IsLittleEndian);
+
+ auto CheckOperands = [&](uint64_t ExpectedOperands) -> Error {
+ if (Entry.Values.size() != ExpectedOperands) {
+ return createStringError(
+ errc::invalid_argument,
+ "invalid number (%zu) of operands for the operator: %s, %" PRIu64
+ " expected",
+ Entry.Values.size(),
+ dwarf::RangeListEncodingString(Entry.Operator).str().c_str(),
+ ExpectedOperands);
+ }
+
+ return Error::success();
+ };
+
+ auto WriteAddress = [&](uint64_t Addr) -> Error {
+ if (Error Err =
+ writeVariableSizedInteger(Addr, AddrSize, OS, IsLittleEndian))
+ return createStringError(
+ errc::not_supported,
+ "unable to write address for the operator %s: %s",
+ dwarf::RangeListEncodingString(Entry.Operator).str().c_str(),
+ toString(std::move(Err)).c_str());
+ return Error::success();
+ };
+
+ switch (Entry.Operator) {
+ case dwarf::DW_RLE_end_of_list:
+ if (Error Err = CheckOperands(0))
+ return std::move(Err);
+ break;
+ case dwarf::DW_RLE_base_addressx:
+ if (Error Err = CheckOperands(1))
+ return std::move(Err);
+ encodeULEB128(Entry.Values[0], OS);
+ break;
+ case dwarf::DW_RLE_startx_endx:
+ case dwarf::DW_RLE_startx_length:
+ case dwarf::DW_RLE_offset_pair:
+ if (Error Err = CheckOperands(2))
+ return std::move(Err);
+ encodeULEB128(Entry.Values[0], OS);
+ encodeULEB128(Entry.Values[1], OS);
+ break;
+ case dwarf::DW_RLE_base_address:
+ if (Error Err = CheckOperands(1))
+ return std::move(Err);
+ if (Error Err = WriteAddress(Entry.Values[0]))
+ return std::move(Err);
+ break;
+ case dwarf::DW_RLE_start_end:
+ if (Error Err = CheckOperands(2))
+ return std::move(Err);
+ if (Error Err = WriteAddress(Entry.Values[0]))
+ return std::move(Err);
+ cantFail(WriteAddress(Entry.Values[1]));
+ break;
+ case dwarf::DW_RLE_start_length:
+ if (Error Err = CheckOperands(2))
+ return std::move(Err);
+ if (Error Err = WriteAddress(Entry.Values[0]))
+ return std::move(Err);
+ encodeULEB128(Entry.Values[1], OS);
+ break;
+ default:
+ llvm_unreachable("unrecognized range list encoding");
+ }
+
+ return OS.tell() - BeginOffset;
+}
+
+Error DWARFYAML::emitDebugRnglists(raw_ostream &OS, const Data &DI) {
+ assert(DI.DebugRnglists && "unexpected emitDebugRnglists() call");
+ for (const DWARFYAML::RnglistTable &Table : *DI.DebugRnglists) {
+ // sizeof(version) + sizeof(address_size) + sizeof(segment_selector_size) +
+ // sizeof(offset_entry_count) = 8
+ uint64_t Length = 8;
+
+ uint8_t AddrSize;
+ if (Table.AddrSize)
+ AddrSize = *Table.AddrSize;
+ else
+ AddrSize = DI.Is64BitAddrSize ? 8 : 4;
+
+ // Since the length of the current range lists entry is undetermined yet, we
+ // firstly write the content of the range lists to a buffer to calculate the
+ // length and then serialize the buffer content to the actual output stream.
+ std::string ListBuffer;
+ raw_string_ostream ListBufferOS(ListBuffer);
+
+ // Offsets holds offsets for each range list. The i-th element is the offset
+ // from the beginning of the first range list to the location of the i-th
+ // range list.
+ std::vector<uint64_t> Offsets;
+
+ for (const DWARFYAML::Rnglist &List : Table.Lists) {
+ Offsets.push_back(ListBufferOS.tell());
+ for (const DWARFYAML::RnglistEntry &Entry : List.Entries) {
+ Expected<uint64_t> EntrySize =
+ writeRnglistEntry(ListBufferOS, Entry, AddrSize, DI.IsLittleEndian);
+ if (!EntrySize)
+ return EntrySize.takeError();
+ Length += *EntrySize;
+ }
+ }
+
+ // If the offset_entry_count field isn't specified, yaml2obj will infer it
+ // from the 'Offsets' field in the YAML description. If the 'Offsets' field
+ // isn't specified either, yaml2obj will infer it from the auto-generated
+ // offsets.
+ uint32_t OffsetEntryCount;
+ if (Table.OffsetEntryCount)
+ OffsetEntryCount = *Table.OffsetEntryCount;
+ else
+ OffsetEntryCount = Table.Offsets ? Table.Offsets->size() : Offsets.size();
+ uint64_t OffsetsSize =
+ OffsetEntryCount * (Table.Format == dwarf::DWARF64 ? 8 : 4);
+ Length += OffsetsSize;
+
+ // If the length is specified in the YAML description, we use it instead of
+ // the actual length.
+ if (Table.Length)
+ Length = *Table.Length;
+
+ writeInitialLength(Table.Format, Length, OS, DI.IsLittleEndian);
+ writeInteger((uint16_t)Table.Version, OS, DI.IsLittleEndian);
+ writeInteger((uint8_t)AddrSize, OS, DI.IsLittleEndian);
+ writeInteger((uint8_t)Table.SegSelectorSize, OS, DI.IsLittleEndian);
+ writeInteger((uint32_t)OffsetEntryCount, OS, DI.IsLittleEndian);
+
+ auto EmitOffsets = [&](ArrayRef<uint64_t> Offsets, uint64_t OffsetsSize) {
+ for (uint64_t Offset : Offsets) {
+ cantFail(writeVariableSizedInteger(
+ OffsetsSize + Offset, Table.Format == dwarf::DWARF64 ? 8 : 4, OS,
+ DI.IsLittleEndian));
+ }
+ };
+
+ if (Table.Offsets)
+ EmitOffsets(ArrayRef<uint64_t>((const uint64_t *)Table.Offsets->data(),
+ Table.Offsets->size()),
+ 0);
+ else
+ EmitOffsets(Offsets, OffsetsSize);
+
+ OS.write(ListBuffer.data(), ListBuffer.size());
+ }
+
+ return Error::success();
+}
+
using EmitFuncType = Error (*)(raw_ostream &, const DWARFYAML::Data &);
static Error
diff --git a/llvm/lib/ObjectYAML/DWARFYAML.cpp b/llvm/lib/ObjectYAML/DWARFYAML.cpp
index 4ed3b48b6785..4cef29a6b428 100644
--- a/llvm/lib/ObjectYAML/DWARFYAML.cpp
+++ b/llvm/lib/ObjectYAML/DWARFYAML.cpp
@@ -48,6 +48,8 @@ SetVector<StringRef> DWARFYAML::Data::getUsedSectionNames() const {
SecNames.insert("debug_gnu_pubtypes");
if (DebugStrOffsets)
SecNames.insert("debug_str_offsets");
+ if (DebugRnglists)
+ SecNames.insert("debug_rnglists");
return SecNames;
}
@@ -72,6 +74,7 @@ void MappingTraits<DWARFYAML::Data>::mapping(IO &IO, DWARFYAML::Data &DWARF) {
IO.mapOptional("debug_line", DWARF.DebugLines);
IO.mapOptional("debug_addr", DWARF.DebugAddr);
IO.mapOptional("debug_str_offsets", DWARF.DebugStrOffsets);
+ IO.mapOptional("debug_rnglists", DWARF.DebugRnglists);
IO.setContext(OldContext);
}
@@ -233,6 +236,29 @@ void MappingTraits<DWARFYAML::StringOffsetsTable>::mapping(
IO.mapOptional("Offsets", StrOffsetsTable.Offsets);
}
+void MappingTraits<DWARFYAML::RnglistEntry>::mapping(
+ IO &IO, DWARFYAML::RnglistEntry &RnglistEntry) {
+ IO.mapRequired("Operator", RnglistEntry.Operator);
+ IO.mapOptional("Values", RnglistEntry.Values);
+}
+
+void MappingTraits<DWARFYAML::Rnglist>::mapping(IO &IO,
+ DWARFYAML::Rnglist &Rnglist) {
+ IO.mapOptional("Entries", Rnglist.Entries);
+}
+
+void MappingTraits<DWARFYAML::RnglistTable>::mapping(
+ IO &IO, DWARFYAML::RnglistTable &RnglistTable) {
+ IO.mapOptional("Format", RnglistTable.Format, dwarf::DWARF32);
+ IO.mapOptional("Length", RnglistTable.Length);
+ IO.mapOptional("Version", RnglistTable.Version, 5);
+ IO.mapOptional("AddressSize", RnglistTable.AddrSize);
+ IO.mapOptional("SegmentSelectorSize", RnglistTable.SegSelectorSize, 0);
+ IO.mapOptional("OffsetEntryCount", RnglistTable.OffsetEntryCount);
+ IO.mapOptional("Offsets", RnglistTable.Offsets);
+ IO.mapOptional("Lists", RnglistTable.Lists);
+}
+
void MappingTraits<DWARFYAML::InitialLength>::mapping(
IO &IO, DWARFYAML::InitialLength &InitialLength) {
IO.mapRequired("TotalLength", InitialLength.TotalLength);
diff --git a/llvm/lib/ObjectYAML/ELFEmitter.cpp b/llvm/lib/ObjectYAML/ELFEmitter.cpp
index 26fe1236752f..fc80839064ee 100644
--- a/llvm/lib/ObjectYAML/ELFEmitter.cpp
+++ b/llvm/lib/ObjectYAML/ELFEmitter.cpp
@@ -976,6 +976,8 @@ Expected<uint64_t> emitDWARF(typename ELFT::Shdr &SHeader, StringRef Name,
DWARF.IsLittleEndian, /*IsGNUStyle=*/true);
else if (Name == ".debug_str_offsets")
Err = DWARFYAML::emitDebugStrOffsets(*OS, DWARF);
+ else if (Name == ".debug_rnglists")
+ Err = DWARFYAML::emitDebugRnglists(*OS, DWARF);
else
llvm_unreachable("unexpected emitDWARF() call");
diff --git a/llvm/test/tools/yaml2obj/ELF/DWARF/debug-rnglists.yaml b/llvm/test/tools/yaml2obj/ELF/DWARF/debug-rnglists.yaml
new file mode 100644
index 000000000000..80dc9b9fdeb3
--- /dev/null
+++ b/llvm/test/tools/yaml2obj/ELF/DWARF/debug-rnglists.yaml
@@ -0,0 +1,610 @@
+## Test that yaml2obj emits a .debug_rnglists section when requested.
+
+## a) Generate and verify a little endian DWARF32 .debug_rnglists section in a 64-bit object file.
+
+# RUN: yaml2obj --docnum=1 -DENDIAN=ELFDATA2LSB %s -o %t1.le.dwarf32.o
+# RUN: llvm-readobj --sections --section-data %t1.le.dwarf32.o | \
+# RUN: FileCheck -DSIZE=99 -DADDRALIGN=1 %s --check-prefixes=SHDR,DWARF32-LE
+
+# SHDR: Index: 1
+# SHDR-NEXT: Name: .debug_rnglists (1)
+# SHDR-NEXT: Type: SHT_PROGBITS (0x1)
+# SHDR-NEXT: Flags [ (0x0)
+# SHDR-NEXT: ]
+# SHDR-NEXT: Address: 0x0
+# SHDR-NEXT: Offset: 0x40
+# SHDR-NEXT: Size: [[SIZE]]
+# SHDR-NEXT: Link: 0
+# SHDR-NEXT: Info: 0
+# SHDR-NEXT: AddressAlignment: [[ADDRALIGN]]
+# SHDR-NEXT: EntrySize: 0
+# DWARF32-LE-NEXT: SectionData (
+# DWARF32-LE-NEXT: 0000: 24000000 05000800 02000000 08000000 |$...............|
+## ^------- unit_length (4-byte)
+## ^--- version (2-byte)
+## ^- address_size (1-byte)
+## ^- segment_selector_size (1-byte)
+## ^------- offset_entry_count (4-byte)
+## ^------- offsets[0] (4-byte)
+# DWARF32-LE-NEXT: 0010: 11000000 01B42402 B424B424 0003B424 |......$..$.$...$|
+## ^------- offsets[1] (4-byte)
+## ^- DW_RLE_base_addressx (1-byte)
+## ^--- operands[0] (ULEB128) 0x1234
+## ^- DW_RLE_startx_endx (1-byte)
+## ^--- operands[0] (ULEB128) 0x1234
+## ^--- operands[1] (ULEB128) 0x1234
+## ^- DW_RLE_end_of_list (1-byte)
+## ^- DW_RLE_startx_length (1-byte)
+## ^--- operands[0] (ULEB128) 0x1234
+# DWARF32-LE-NEXT: 0020: B42404B4 24B42400 37000000 05000800 |.$..$.$.7.......|
+## ^--- operands[1] (ULEB128) 0x1234
+## ^- DW_RLE_offset_pair (1-byte)
+## ^---- operands[0] (ULEB128) 0x1234
+## ^--- operands[1] (ULEB128) 0x1234
+## ^- DW_RLE_end_of_list (1-byte)
+## ^------- unit_length (4-byte)
+## ^--- version (2-byte)
+## ^- address_size (1-byte)
+## ^- segment_selector_size (1-byte)
+# DWARF32-LE-NEXT: 0030: 02000000 08000000 23000000 05341200 |........#....4..|
+## ^------- offset_entry_count (4-byte)
+## ^------- offsets[0] (4-byte)
+## ^------- offsets[1] (4-byte)
+## ^- DW_RLE_base_address (1-byte)
+## ^----- operands[0] (8-byte)
+# DWARF32-LE-NEXT: 0040: 00000000 00063412 00000000 00003412 |......4.......4.|
+## -----------
+## ^- DW_RLE_start_end (1-byte)
+## ^----------------- operands[0] (8-byte)
+## ^--- operands[1] (8-byte)
+# DWARF32-LE-NEXT: 0050: 00000000 00000007 34120000 00000000 |........4.......|
+## -------------
+## ^- DW_RLE_end_of_list (1-byte)
+## ^- DW_RLE_start_length (1-byte)
+## ^---------------- operands[0] (8-byte)
+# DWARF32-LE-NEXT: 0060: B42400 |.$.|
+## ^--- operands[1] (ULEB128) 0x1234
+## ^- DW_RLE_end_of_list (1-byte)
+# DWARF32-LE-NEXT: )
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: [[ENDIAN]]
+ Type: ET_EXEC
+ Machine: EM_X86_64
+DWARF:
+ debug_rnglists:
+ - Lists:
+ - Entries:
+ - Operator: DW_RLE_base_addressx
+ Values: [ 0x1234 ]
+ - Operator: DW_RLE_startx_endx
+ Values: [ 0x1234, 0x1234 ]
+ - Operator: DW_RLE_end_of_list
+ - Entries:
+ - Operator: DW_RLE_startx_length
+ Values: [ 0x1234, 0x1234 ]
+ - Operator: DW_RLE_offset_pair
+ Values: [ 0x1234, 0x1234 ]
+ - Operator: DW_RLE_end_of_list
+ - Lists:
+ - Entries:
+ - Operator: DW_RLE_base_address
+ Values: [ 0x1234 ]
+ - Operator: DW_RLE_start_end
+ Values: [ 0x1234, 0x1234 ]
+ - Operator: DW_RLE_end_of_list
+ - Entries:
+ - Operator: DW_RLE_start_length
+ Values: [ 0x1234, 0x1234 ]
+ - Operator: DW_RLE_end_of_list
+
+## b) Generate and verify a big endian DWARF32 .debug_rnglists section in a 64-bit object file.
+
+# RUN: yaml2obj --docnum=1 -DENDIAN=ELFDATA2MSB %s -o %t1.be.dwarf32.o
+# RUN: llvm-readobj --sections --section-data %t1.be.dwarf32.o | \
+# RUN: FileCheck -DSIZE=99 -DADDRALIGN=1 %s --check-prefixes=SHDR,DWARF32-BE
+
+# DWARF32-BE-NEXT: SectionData (
+# DWARF32-BE-NEXT: 0000: 00000024 00050800 00000002 00000008 |...$............|
+## ^------- unit_length (4-byte)
+## ^--- version (2-byte)
+## ^- address_size (1-byte)
+## ^- segment_selector_size (1-byte)
+## ^------- offset_entry_count (4-byte)
+## ^------- offsets[0] (4-byte)
+# DWARF32-BE-NEXT: 0010: 00000011 01B42402 B424B424 0003B424 |......$..$.$...$|
+## ^------- offsets[1] (4-byte)
+## ^- DW_RLE_base_addressx (1-byte)
+## ^--- operands[0] (ULEB128) 0x1234
+## ^- DW_RLE_startx_endx (1-byte)
+## ^--- operands[0] (ULEB128) 0x1234
+## ^--- operands[1] (ULEB128) 0x1234
+## ^- DW_RLE_end_of_list (1-byte)
+## ^- DW_RLE_startx_length (1-byte)
+## ^--- operands[0] (ULEB128) 0x1234
+# DWARF32-BE-NEXT: 0020: B42404B4 24B42400 00000037 00050800 |.$..$.$....7....|
+## ^--- operands[1] (ULEB128) 0x1234
+## ^- DW_RLE_offset_pair (1-byte)
+## ^---- operands[0] (ULEB128) 0x1234
+## ^--- operands[1] (ULEB128) 0x1234
+## ^- DW_RLE_end_of_list (1-byte)
+## ^------- unit_length (4-byte)
+## ^--- version (2-byte)
+## ^- address_size (1-byte)
+## ^- segment_selector_size (1-byte)
+# DWARF32-BE-NEXT: 0030: 00000002 00000008 00000023 05000000 |...........#....|
+## ^------- offset_entry_count (4-byte)
+## ^------- offsets[0] (4-byte)
+## ^------- offsets[1] (4-byte)
+## ^- DW_RLE_base_address (1-byte)
+## ^----- operands[0] (8-byte)
+# DWARF32-BE-NEXT: 0040: 00000012 34060000 00000000 12340000 |....4........4..|
+## -----------
+## ^- DW_RLE_start_end (1-byte)
+## ^----------------- operands[0] (8-byte)
+## ^--- operands[1] (8-byte)
+# DWARF32-BE-NEXT: 0050: 00000000 12340007 00000000 00001234 |.....4.........4|
+## -------------
+## ^- DW_RLE_end_of_list (1-byte)
+## ^- DW_RLE_start_length (1-byte)
+## ^---------------- operands[0] (8-byte)
+# DWARF32-BE-NEXT: 0060: B42400 |.$.|
+## ^--- operands[1] (ULEB128) 0x1234
+## ^- DW_RLE_end_of_list (1-byte)
+# DWARF32-BE-NEXT: )
+
+## c) Generate and verify a little endian DWARF64 .debug_rnglists section in a 64-bit object file.
+
+# RUN: yaml2obj --docnum=2 -DENDIAN=ELFDATA2LSB %s -o %t2.le.dwarf64.o
+# RUN: llvm-readobj --sections --section-data %t2.le.dwarf64.o | \
+# RUN: FileCheck -DSIZE=38 -DADDRALIGN=1 %s --check-prefixes=SHDR,DWARF64-LE
+
+# DWARF64-LE-NEXT: SectionData (
+# DWARF64-LE-NEXT: 0000: FFFFFFFF 1A000000 00000000 05000800 |................|
+## ^------------------------- unit_length (12-byte)
+## ^--- version (2-byte)
+## ^- address_size (1-byte)
+## ^- segment_selector_size (1-byte)
+# DWARF64-LE-NEXT: 0010: 02000000 10000000 00000000 11000000 |................|
+## ^------- offset_entry_count (4-byte)
+## ^---------------- offsets[0] (8-byte)
+## ^------- offsets[1] (8-byte)
+# DWARF64-LE-NEXT: 0020: 00000000 0000 |......|
+## --------
+## ^- DW_RLE_end_of_list (1-byte)
+## ^- DW_RLE_end_of_list (1-byte)
+# DWARF64-LE-NEXT: )
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: [[ENDIAN]]
+ Type: ET_EXEC
+ Machine: EM_X86_64
+DWARF:
+ debug_rnglists:
+ - Format: DWARF64
+ Lists:
+ - Entries:
+ - Operator: DW_RLE_end_of_list
+ - Entries:
+ - Operator: DW_RLE_end_of_list
+
+## d) Generate and verify a big endian DWARF64 .debug_rnglists section in a 64-bit object file.
+
+# RUN: yaml2obj --docnum=2 -DENDIAN=ELFDATA2MSB %s -o %t2.be.dwarf64.o
+# RUN: llvm-readobj --sections --section-data %t2.be.dwarf64.o | \
+# RUN: FileCheck -DSIZE=38 -DADDRALIGN=1 %s --check-prefixes=SHDR,DWARF64-BE
+
+# DWARF64-BE-NEXT: SectionData (
+# DWARF64-BE-NEXT: 0000: FFFFFFFF 00000000 0000001A 00050800 |................|
+## ^------------------------- unit_length (12-byte)
+## ^--- version (2-byte)
+## ^- address_size (1-byte)
+## ^- segment_selector_size (1-byte)
+# DWARF64-BE-NEXT: 0010: 00000002 00000000 00000010 00000000 |................|
+## ^------- offset_entry_count (4-byte)
+## ^---------------- offsets[0] (8-byte)
+## ^------- offsets[1] (8-byte)
+# DWARF64-BE-NEXT: 0020: 00000011 0000 |......|
+## --------
+## ^- DW_RLE_end_of_list (1-byte)
+## ^- DW_RLE_end_of_list (1-byte)
+# DWARF64-BE-NEXT: )
+
+## e) Test that the length, version, segment_selector_size, address_size, offset_entry_count
+## and offsets fields can be specified manually.
+
+# RUN: yaml2obj --docnum=3 %s -o %t3.o
+# RUN: llvm-readelf --hex-dump=.debug_rnglists %t3.o | \
+# RUN: FileCheck %s --check-prefix=OVERWRITE
+
+# OVERWRITE: Hex dump of section '.debug_rnglists':
+# OVERWRITE-NEXT: 0x00000000 34120000 06000303 04000000 01000000 4...............
+## ^------- unit_length (4-byte)
+## ^--- version (2-byte)
+## ^- address_size (1-byte)
+## ^- segment_selector_size (1-byte)
+## ^------- offset_entry_count (4-byte)
+## ^------- offsets[0] (4-byte)
+# OVERWRITE-NEXT: 0x00000010 0000 ..
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+DWARF:
+ debug_rnglists:
+ - Length: 0x1234
+ Version: 6
+ AddressSize: 3
+ SegmentSelectorSize: 3
+ OffsetEntryCount: 4
+ Offsets: [ 0x01 ]
+ Lists:
+ - Entries:
+ - Operator: DW_RLE_end_of_list
+ - Entries:
+ - Operator: DW_RLE_end_of_list
+
+## f) Test that the default value of the address_size field in a 32-bit object file is 4.
+
+# RUN: yaml2obj --docnum=4 %s -o %t4.o
+# RUN: llvm-readelf --hex-dump=.debug_rnglists %t4.o | \
+# RUN: FileCheck %s --check-prefix=ADDRSIZE32
+
+# ADDRSIZE32: Hex dump of section '.debug_rnglists':
+# ADDRSIZE32-NEXT: 0x00000000 22000000 05000400 01000000 04000000 "...............
+## ^- address_size (1-byte)
+# ADDRSIZE32-NEXT: 0x00000010 05341200 00063412 00002143 00000734 .4....4...!C...4
+## ^- DW_RLE_base_address (1-byte)
+## ^-------- operands[0] (4-byte)
+## ^- DW_RLE_start_end (1-byte)
+## ^-------- operands[0] (4-byte)
+## ^-------- operands[1] (4-byte)
+## ^- DW_RLE_start_length (1-byte)
+## ^- operands[0] (4-byte)
+# ADDRSIZE32-NEXT: 0x00000020 120000a1 8601 ......
+## ------
+## ^------ operands[1] (ULEB128) 0x4321
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS32
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+DWARF:
+ debug_rnglists:
+ - Lists:
+ - Entries:
+ - Operator: DW_RLE_base_address
+ Values: [ 0x1234 ]
+ - Operator: DW_RLE_start_end
+ Values: [ 0x1234, 0x4321 ]
+ - Operator: DW_RLE_start_length
+ Values: [ 0x1234, 0x4321 ]
+
+## g) Test that the address_size field can be specified manually and the size of
+## corresponding operands will be changed accordingly.
+
+# RUN: yaml2obj --docnum=5 %s -o %t5.o
+# RUN: llvm-readelf --hex-dump=.debug_rnglists %t5.o | \
+# RUN: FileCheck %s --check-prefix=ADDRSIZE
+
+# ADDRSIZE: Hex dump of section '.debug_rnglists':
+# ADDRSIZE-NEXT: 0x00000000 22000000 05000400 01000000 04000000 "...............
+## ^- address_size 0x04
+# ADDRSIZE-NEXT: 0x00000010 05341200 00063412 00002143 00000734 .4....4...!C...4
+## ^- DW_RLE_base_address
+## ^-------- operands[0] (4-byte)
+## ^- DW_RLE_start_end
+## ^-------- operands[0] (4-byte)
+## ^-------- operands[1] (4-byte)
+## ^- DW_RLE_start_length
+## ^- operands[0] (4-byte)
+# ADDRSIZE-NEXT: 0x00000020 120000b4 2400 ....$.
+## ------
+## ^---- operands[1] (ULEB128)
+## ^- DW_RLE_end_of_list
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+DWARF:
+ debug_rnglists:
+ - AddressSize: 4
+ Lists:
+ - Entries:
+ - Operator: DW_RLE_base_address
+ Values: [ 0x1234 ]
+ - Operator: DW_RLE_start_end
+ Values: [ 0x1234, 0x4321 ]
+ - Operator: DW_RLE_start_length
+ Values: [ 0x1234, 0x1234 ]
+ - Operator: DW_RLE_end_of_list
+
+## h) Test that yaml2obj emits an error message if we try to assign an invalid value to
+## 'AddressSize' when there is an entry whose operands contain address.
+
+# RUN: not yaml2obj -DOPERATOR=base_address -DVALUES=[0x01] --docnum=6 %s 2>&1 | \
+# RUN: FileCheck -DOPERATOR=base_address %s --check-prefix=INVALID-ADDRSIZE
+
+# RUN: not yaml2obj -DOPERATOR=start_end -DVALUES=[0x01,0x02] --docnum=6 %s 2>&1 | \
+# RUN: FileCheck -DOPERATOR=start_end %s --check-prefix=INVALID-ADDRSIZE
+
+# RUN: not yaml2obj -DOPERATOR=start_length -DVALUES=[0x01,0x02] --docnum=6 %s 2>&1 | \
+# RUN: FileCheck -DOPERATOR=start_length %s --check-prefix=INVALID-ADDRSIZE
+
+# INVALID-ADDRSIZE: yaml2obj: error: unable to write address for the operator DW_RLE_[[OPERATOR]]: invalid integer write size: 3
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+DWARF:
+ debug_rnglists:
+ - AddressSize: 3
+ Lists:
+ - Entries:
+ - Operator: DW_RLE_[[OPERATOR]]
+ Values: [[VALUES]]
+
+## i) Test that an invalid address_size can be used when there are no address-using operators.
+
+# RUN: yaml2obj --docnum=7 %s -o %t7.o
+# RUN: llvm-readelf --hex-dump=.debug_rnglists %t7.o | \
+# RUN: FileCheck %s --check-prefix=ADDRSIZE-NOERROR
+
+# ADDRSIZE-NOERROR: Hex dump of section '.debug_rnglists':
+# ADDRSIZE-NOERROR-NEXT: 0x00000000 0e000000 05000300 01000000 04000000 ................
+## ^- address_size (1-byte) 0x03
+# ADDRSIZE-NOERROR-NEXT: 0x00000010 0101 ..
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+DWARF:
+ debug_rnglists:
+ - AddressSize: 3
+ Lists:
+ - Entries:
+ - Operator: DW_RLE_base_addressx
+ Values: [ 0x01 ]
+
+## j) Test that yaml2obj emits an error message if we specify invalid numbers of operands
+## for an operator.
+
+# RUN: not yaml2obj -DOPERATOR=end_of_list -DVALUES=[0x01] --docnum=8 %s 2>&1 | \
+# RUN: FileCheck -DOPERATOR=end_of_list -DACTUAL=1 -DEXPECTED=0 %s --check-prefix=INVALID-OPERANDS
+
+# RUN: not yaml2obj -DOPERATOR=base_addressx -DVALUES=[] --docnum=8 %s 2>&1 | \
+# RUN: FileCheck -DOPERATOR=base_addressx -DACTUAL=0 -DEXPECTED=1 %s --check-prefix=INVALID-OPERANDS
+
+# RUN: not yaml2obj -DOPERATOR=startx_endx -DVALUES=[0x01] --docnum=8 %s 2>&1 | \
+# RUN: FileCheck -DOPERATOR=startx_endx -DACTUAL=1 -DEXPECTED=2 %s --check-prefix=INVALID-OPERANDS
+
+# RUN: not yaml2obj -DOPERATOR=startx_length -DVALUES=[0x01] --docnum=8 %s 2>&1 | \
+# RUN: FileCheck -DOPERATOR=startx_length -DACTUAL=1 -DEXPECTED=2 %s --check-prefix=INVALID-OPERANDS
+
+# RUN: not yaml2obj -DOPERATOR=offset_pair -DVALUES=[] --docnum=8 %s 2>&1 | \
+# RUN: FileCheck -DOPERATOR=offset_pair -DACTUAL=0 -DEXPECTED=2 %s --check-prefix=INVALID-OPERANDS
+
+# RUN: not yaml2obj -DOPERATOR=base_address -DVALUES=[0x01,0x02] --docnum=8 %s 2>&1 | \
+# RUN: FileCheck -DOPERATOR=base_address -DACTUAL=2 -DEXPECTED=1 %s --check-prefix=INVALID-OPERANDS
+
+# RUN: not yaml2obj -DOPERATOR=start_end -DVALUES=[0x01,0x02,0x03] --docnum=8 %s 2>&1 | \
+# RUN: FileCheck -DOPERATOR=start_end -DACTUAL=3 -DEXPECTED=2 %s --check-prefix=INVALID-OPERANDS
+
+# RUN: not yaml2obj -DOPERATOR=start_length -DVALUES=[0x01] --docnum=8 %s 2>&1 | \
+# RUN: FileCheck -DOPERATOR=start_length -DACTUAL=1 -DEXPECTED=2 %s --check-prefix=INVALID-OPERANDS
+
+# INVALID-OPERANDS: yaml2obj: error: invalid number ([[ACTUAL]]) of operands for the operator: DW_RLE_[[OPERATOR]], [[EXPECTED]] expected
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+DWARF:
+ debug_rnglists:
+ - AddressSize: 3
+ Lists:
+ - Entries:
+ - Operator: DW_RLE_[[OPERATOR]]
+ Values: [[VALUES]]
+
+## k) Test that an empty list is allowed for a range list table.
+
+# RUN: yaml2obj --docnum=9 %s -o %t9.o
+# RUN: llvm-readelf --hex-dump=.debug_rnglists %t9.o | \
+# RUN: FileCheck %s --check-prefix=EMPTY-LIST
+
+# EMPTY-LIST: Hex dump of section '.debug_rnglists':
+# EMPTY-LIST-NEXT: 0x00000000 08000000 05000800 00000000 ............
+## ^------- unit_length (4-byte)
+## ^--- version (2-byte)
+## ^--- address_size (1-byte)
+## ^------- offset_entry_count (4-byte)
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+DWARF:
+ debug_rnglists:
+ - Lists: []
+
+## l) Generate the .debug_rnglists section from raw section content.
+
+# RUN: yaml2obj --docnum=10 %s -o %t10.o
+# RUN: llvm-readobj --sections --section-data %t10.o | \
+# RUN: FileCheck %s -DSIZE=3 -DADDRALIGN=0 --check-prefixes=SHDR,ARBITRARY-CONTENT
+
+# ARBITRARY-CONTENT: SectionData (
+# ARBITRARY-CONTENT-NEXT: 0000: 112233
+# ARBITRARY-CONTENT-NEXT: )
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+Sections:
+ - Name: .debug_rnglists
+ Type: SHT_PROGBITS
+ Content: "112233"
+
+## m) Generate the .debug_rnglists section when the "Size" is specified.
+
+# RUN: yaml2obj --docnum=11 %s -o %t11.o
+# RUN: llvm-readelf --hex-dump=.debug_rnglists %t11.o | \
+# RUN: FileCheck %s --check-prefix=SIZE
+
+# SIZE: Hex dump of section '.debug_rnglists':
+# SIZE-NEXT: 0x00000000 00000000 00000000 00000000 00000000 ................
+# SIZE-EMPTY:
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+Sections:
+ - Name: .debug_rnglists
+ Type: SHT_PROGBITS
+ Size: 0x10
+
+## n) Test that yaml2obj emits an error message when both the "Size" and the
+## "debug_rnglists" entry are specified at the same time.
+
+# RUN: not yaml2obj --docnum=12 %s 2>&1 | FileCheck %s --check-prefix=ERROR
+
+# ERROR: yaml2obj: error: cannot specify section '.debug_rnglists' contents in the 'DWARF' entry and the 'Content' or 'Size' in the 'Sections' entry at the same time
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+Sections:
+ - Name: .debug_rnglists
+ Type: SHT_PROGBITS
+ Size: 0x10
+DWARF:
+ debug_rnglists:
+ - Lists: []
+
+## o) Test that yaml2obj emits an error message when both the "Content" and the
+## "debug_rnglists" entry are specified at the same time.
+
+# RUN: not yaml2obj --docnum=13 %s 2>&1 | FileCheck %s --check-prefix=ERROR
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+Sections:
+ - Name: .debug_rnglists
+ Type: SHT_PROGBITS
+ Content: "00"
+DWARF:
+ debug_rnglists:
+ - Lists: []
+
+## p) Test that all the properties can be overridden by the section header when
+## the "debug_rnglists" entry doesn't exist.
+
+# RUN: yaml2obj --docnum=14 %s -o %t14.o
+# RUN: llvm-readelf --sections %t14.o | FileCheck %s --check-prefix=OVERRIDDEN
+
+# OVERRIDDEN: [Nr] Name Type Address Off Size ES Flg Lk Inf Al
+# OVERRIDDEN: [ 1] .debug_rnglists STRTAB 0000000000002020 000050 00000c 01 A 2 1 2
+# OVERRIDDEN-NEXT: [ 2] .sec STRTAB 0000000000000000 00005c 000000 00 0 0 0
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+Sections:
+ - Name: .debug_rnglists
+ Type: SHT_STRTAB ## SHT_PROGBITS by default.
+ Flags: [SHF_ALLOC] ## 0 by default.
+ Link: .sec ## 0 by default.
+ EntSize: 1 ## 0 by default.
+ Info: 1 ## 0 by default.
+ AddressAlign: 2 ## 0 by default.
+ Address: 0x2020 ## 0x00 by default.
+ Offset: 0x50 ## 0x40 for the first section.
+ Size: 0x0c ## Set the "Size" so that we can reuse the check tag "OVERRIDDEN".
+ - Name: .sec ## Linked by .debug_rnglists.
+ Type: SHT_STRTAB
+
+## q) Test that all the properties can be overridden by the section header when
+## the "debug_rnglists" entry exists.
+
+# RUN: yaml2obj --docnum=15 %s -o %t15.o
+# RUN: llvm-readelf --sections %t15.o | FileCheck %s --check-prefix=OVERRIDDEN
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+Sections:
+ - Name: .debug_rnglists
+ Type: SHT_STRTAB ## SHT_PROGBITS by default.
+ Flags: [SHF_ALLOC] ## 0 by default.
+ Link: .sec ## 0 by default.
+ EntSize: 1 ## 0 by default.
+ Info: 1 ## 0 by default.
+ AddressAlign: 2 ## 1 by default.
+ Address: 0x2020 ## 0x00 by default.
+ Offset: 0x50 ## 0x40 for the first section.
+ - Name: .sec ## Linked by .debug_rnglists.
+ Type: SHT_STRTAB
+DWARF:
+ debug_rnglists:
+ - Lists: []
+
+## r) Test that the .debug_rnglists section header is emitted if the "debug_rnglists"
+## entry is empty.
+
+# RUN: yaml2obj --docnum=16 %s -o %t16.o
+# RUN: llvm-readobj --sections --section-data %t16.o | \
+# RUN: FileCheck -DSIZE=0 -DADDRALIGN=1 %s --check-prefixes=SHDR,EMPTY-CONTENT
+
+# EMPTY-CONTENT-NEXT: SectionData (
+# EMPTY-CONTENT-NEXT: )
+
+--- !ELF
+FileHeader:
+ Class: ELFCLASS64
+ Data: ELFDATA2LSB
+ Type: ET_EXEC
+ Machine: EM_X86_64
+DWARF:
+ debug_rnglists: []
More information about the llvm-commits
mailing list