[llvm] [DebugInfo] Report errors when DWARFUnitHeader::applyIndexEntry fails (PR #89156)
Alex Langford via llvm-commits
llvm-commits at lists.llvm.org
Mon Apr 22 14:18:41 PDT 2024
https://github.com/bulbazord updated https://github.com/llvm/llvm-project/pull/89156
>From 0cded0039f6fdaa5ab6f881bb7492fab9b75f2ff Mon Sep 17 00:00:00 2001
From: Alex Langford <alangford at apple.com>
Date: Wed, 17 Apr 2024 16:26:47 -0700
Subject: [PATCH 1/4] [DebugInfo] Report errors when
DWARFUnitHeader::applyIndexEntry fails
Motivation: LLDB is able to report errors about these scenarios whereas
LLVM's DWARF parser only gives a boolean success/fail. I want to migrate
LLDB to using LLVM's DWARFUnitHeader class, but I don't want to lose
some of the error reporting, so I'm adding it to the LLVM class first.
---
llvm/include/llvm/DebugInfo/DWARF/DWARFUnit.h | 2 +-
llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp | 30 ++++++++++++++-----
2 files changed, 24 insertions(+), 8 deletions(-)
diff --git a/llvm/include/llvm/DebugInfo/DWARF/DWARFUnit.h b/llvm/include/llvm/DebugInfo/DWARF/DWARFUnit.h
index f20e71781f46be..80c27aea893123 100644
--- a/llvm/include/llvm/DebugInfo/DWARF/DWARFUnit.h
+++ b/llvm/include/llvm/DebugInfo/DWARF/DWARFUnit.h
@@ -85,7 +85,7 @@ class DWARFUnitHeader {
uint64_t *offset_ptr, DWARFSectionKind SectionKind);
// For units in DWARF Package File, remember the index entry and update
// the abbreviation offset read by extract().
- bool applyIndexEntry(const DWARFUnitIndex::Entry *Entry);
+ Error applyIndexEntry(const DWARFUnitIndex::Entry *Entry);
uint64_t getOffset() const { return Offset; }
const dwarf::FormParams &getFormParams() const { return FormParams; }
uint16_t getVersion() const { return FormParams.Version; }
diff --git a/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp b/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
index 9f455fa7e96a7e..985566ad329f63 100644
--- a/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
+++ b/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
@@ -98,8 +98,12 @@ void DWARFUnitVector::addUnitsImpl(
if (!IndexEntry)
IndexEntry = Index.getFromOffset(Header.getOffset());
}
- if (IndexEntry && !Header.applyIndexEntry(IndexEntry))
- return nullptr;
+ if (IndexEntry) {
+ if (Error ApplicationErr = Header.applyIndexEntry(IndexEntry)) {
+ Context.getWarningHandler()(std::move(ApplicationErr));
+ return nullptr;
+ }
+ }
std::unique_ptr<DWARFUnit> U;
if (Header.isTypeUnit())
U = std::make_unique<DWARFTypeUnit>(Context, InfoSection, Header, DA,
@@ -334,21 +338,33 @@ Error DWARFUnitHeader::extract(DWARFContext &Context,
return Error::success();
}
-bool DWARFUnitHeader::applyIndexEntry(const DWARFUnitIndex::Entry *Entry) {
+Error DWARFUnitHeader::applyIndexEntry(const DWARFUnitIndex::Entry *Entry) {
assert(Entry);
assert(!IndexEntry);
IndexEntry = Entry;
if (AbbrOffset)
- return false;
+ return createStringError(errc::invalid_argument,
+ "DWARF package unit from offset 0x%8.8" PRIx64
+ " has a non-zero abbreviation offset",
+ Offset);
+
auto *UnitContrib = IndexEntry->getContribution();
if (!UnitContrib ||
UnitContrib->getLength() != (getLength() + getUnitLengthFieldByteSize()))
- return false;
+ return createStringError(errc::invalid_argument,
+ "DWARF package unit at offset 0x%8.8" PRIx64
+ "has an inconsistent index",
+ Offset);
+
auto *AbbrEntry = IndexEntry->getContribution(DW_SECT_ABBREV);
if (!AbbrEntry)
- return false;
+ return createStringError(errc::invalid_argument,
+ "DWARF package unit at offset 0x%8.8 " PRIx64
+ " mising abbreviation column",
+ Offset);
+
AbbrOffset = AbbrEntry->getOffset();
- return true;
+ return Error::success();
}
Error DWARFUnit::extractRangeList(uint64_t RangeListOffset,
>From 6291e13cec48ebb3b4b990301906ba3919964d9b Mon Sep 17 00:00:00 2001
From: Alex Langford <alangford at apple.com>
Date: Thu, 18 Apr 2024 16:31:35 -0700
Subject: [PATCH 2/4] Add tests and correct error messages
---
llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp | 4 +-
.../X86/invalid-cu-abbrev-contribution-dwp.s | 58 +++++++++++++++++++
.../X86/invalid-cu-abbrev-offset-dwp.s | 58 +++++++++++++++++++
.../DebugInfo/X86/invalid-cu-length-dwp.s | 4 +-
4 files changed, 121 insertions(+), 3 deletions(-)
create mode 100644 llvm/test/DebugInfo/X86/invalid-cu-abbrev-contribution-dwp.s
create mode 100644 llvm/test/DebugInfo/X86/invalid-cu-abbrev-offset-dwp.s
diff --git a/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp b/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
index 985566ad329f63..95db2ddee45d0d 100644
--- a/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
+++ b/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
@@ -344,7 +344,7 @@ Error DWARFUnitHeader::applyIndexEntry(const DWARFUnitIndex::Entry *Entry) {
IndexEntry = Entry;
if (AbbrOffset)
return createStringError(errc::invalid_argument,
- "DWARF package unit from offset 0x%8.8" PRIx64
+ "DWARF package unit at offset 0x%8.8" PRIx64
" has a non-zero abbreviation offset",
Offset);
@@ -353,7 +353,7 @@ Error DWARFUnitHeader::applyIndexEntry(const DWARFUnitIndex::Entry *Entry) {
UnitContrib->getLength() != (getLength() + getUnitLengthFieldByteSize()))
return createStringError(errc::invalid_argument,
"DWARF package unit at offset 0x%8.8" PRIx64
- "has an inconsistent index",
+ " has an inconsistent index",
Offset);
auto *AbbrEntry = IndexEntry->getContribution(DW_SECT_ABBREV);
diff --git a/llvm/test/DebugInfo/X86/invalid-cu-abbrev-contribution-dwp.s b/llvm/test/DebugInfo/X86/invalid-cu-abbrev-contribution-dwp.s
new file mode 100644
index 00000000000000..bfd28b503cbadd
--- /dev/null
+++ b/llvm/test/DebugInfo/X86/invalid-cu-abbrev-contribution-dwp.s
@@ -0,0 +1,58 @@
+# RUN: llvm-mc -triple x86_64-unknown-linux %s -filetype=obj -o - | \
+# RUN: llvm-dwarfdump -debug-info - 2>&1 | FileCheck %s
+
+# CHECK: warning: DWARF package unit at offset 0x00000000 mising abbreviation column
+
+ .section .debug_abbrev.dwo, "e", @progbits
+.LAbbrBegin:
+ .uleb128 1 # Abbreviation Code
+ .uleb128 17 # DW_TAG_compile_unit
+ .byte 0 # DW_CHILDREN_no
+ .uleb128 3 # DW_AT_name
+ .uleb128 8 # DW_FORM_string
+ .uleb128 0x2131 # DW_AT_GNU_dwo_id
+ .uleb128 7 # DW_FORM_data8
+ .byte 0 # EOM(1)
+ .byte 0 # EOM(2)
+ .byte 0 # EOM(3)
+.LAbbrEnd:
+
+ .section .debug_info.dwo, "e", @progbits
+.LCUBegin:
+ .long .LCUEnd-.LCUVersion # Length
+.LCUVersion:
+ .short 4 # Version
+ .long 0 # Abbrev offset
+ .byte 4 # Address size
+ .uleb128 1 # Abbrev [1] DW_TAG_compile_unit
+ .asciz "a.c" # DW_AT_name
+ .quad 0x1100001122222222 # DW_AT_GNU_dwo_id
+.LCUEnd:
+
+ .section .debug_cu_index, "", @progbits
+## Header:
+ .short 2 # Version
+ .space 2 # Padding
+ .long 1 # Section count (Invalid, should be 2)
+ .long 1 # Unit count
+ .long 4 # Slot count
+## Hash Table of Signatures:
+ .quad 0
+ .quad 0
+ .quad 0x1100001122222222
+ .quad 0
+## Parallel Table of Indexes:
+ .long 0
+ .long 0
+ .long 1
+ .long 0
+## Table of Section Offsets:
+## Row 0:
+ .long 1 # DW_SECT_INFO
+# .long 3 # DW_SECT_ABBREV (Intentionally omitted)
+## Row 1:
+ .long .LCUBegin-.debug_info.dwo # Offset in .debug_info.dwo
+# .long .LAbbrBegin-.debug_abbrev.dwo # Offset in .debug_abbrev.dwo (Intentionally omitted)
+## Table of Section Sizes:
+ .long .LCUEnd-.LCUBegin # Size of the contribution in .debug_info.dwo
+ .long .LAbbrEnd-.LAbbrBegin # Size of the contribution in .debug_abbrev.dwo (Intentionally omitted)
diff --git a/llvm/test/DebugInfo/X86/invalid-cu-abbrev-offset-dwp.s b/llvm/test/DebugInfo/X86/invalid-cu-abbrev-offset-dwp.s
new file mode 100644
index 00000000000000..b9e769e3ed4a5b
--- /dev/null
+++ b/llvm/test/DebugInfo/X86/invalid-cu-abbrev-offset-dwp.s
@@ -0,0 +1,58 @@
+# RUN: llvm-mc -triple x86_64-unknown-linux %s -filetype=obj -o - | \
+# RUN: llvm-dwarfdump -debug-info - 2>&1 | FileCheck %s
+
+# CHECK: warning: DWARF package unit at offset 0x00000000 has a non-zero abbreviation offset
+
+ .section .debug_abbrev.dwo, "e", @progbits
+.LAbbrBegin:
+ .uleb128 1 # Abbreviation Code
+ .uleb128 17 # DW_TAG_compile_unit
+ .byte 0 # DW_CHILDREN_no
+ .uleb128 3 # DW_AT_name
+ .uleb128 8 # DW_FORM_string
+ .uleb128 0x2131 # DW_AT_GNU_dwo_id
+ .uleb128 7 # DW_FORM_data8
+ .byte 0 # EOM(1)
+ .byte 0 # EOM(2)
+ .byte 0 # EOM(3)
+.LAbbrEnd:
+
+ .section .debug_info.dwo, "e", @progbits
+.LCUBegin:
+ .long .LCUEnd-.LCUVersion # Length
+.LCUVersion:
+ .short 4 # Version
+ .long 1 # Abbrev offset (Invalid, should be 0)
+ .byte 4 # Address size
+ .uleb128 1 # Abbrev [1] DW_TAG_compile_unit
+ .asciz "a.c" # DW_AT_name
+ .quad 0x1100001122222222 # DW_AT_GNU_dwo_id
+.LCUEnd:
+
+ .section .debug_cu_index, "", @progbits
+## Header:
+ .short 2 # Version
+ .space 2 # Padding
+ .long 2 # Section count
+ .long 1 # Unit count
+ .long 4 # Slot count
+## Hash Table of Signatures:
+ .quad 0
+ .quad 0
+ .quad 0x1100001122222222
+ .quad 0
+## Parallel Table of Indexes:
+ .long 0
+ .long 0
+ .long 1
+ .long 0
+## Table of Section Offsets:
+## Row 0:
+ .long 1 # DW_SECT_INFO
+ .long 3 # DW_SECT_ABBREV
+## Row 1:
+ .long .LCUBegin-.debug_info.dwo # Offset in .debug_info.dwo
+ .long .LAbbrBegin-.debug_abbrev.dwo # Offset in .debug_abbrev.dwo
+## Table of Section Sizes:
+ .long .LCUEnd-.LCUBegin
+ .long .LAbbrEnd-.LAbbrBegin
diff --git a/llvm/test/DebugInfo/X86/invalid-cu-length-dwp.s b/llvm/test/DebugInfo/X86/invalid-cu-length-dwp.s
index 299bea1bf1a708..f8db0579c21a0e 100644
--- a/llvm/test/DebugInfo/X86/invalid-cu-length-dwp.s
+++ b/llvm/test/DebugInfo/X86/invalid-cu-length-dwp.s
@@ -1,9 +1,11 @@
# RUN: llvm-mc -triple x86_64-unknown-linux %s -filetype=obj -o - | \
-# RUN: llvm-dwarfdump -debug-info -
+# RUN: llvm-dwarfdump -debug-info - 2>&1 | FileCheck %s
## llvm-dwarfdump used to crash with this input because of an invalid size
## of the compilation unit contribution in the .debug_cu_index section.
+# CHECK: warning: DWARF package unit at offset 0x00000000 has an inconsistent index
+
.section .debug_abbrev.dwo, "e", @progbits
.LAbbrBegin:
.uleb128 1 # Abbreviation Code
>From 5ab819fb550d4fed9596c66a0572c3ac3269b01b Mon Sep 17 00:00:00 2001
From: Alex Langford <alangford at apple.com>
Date: Mon, 22 Apr 2024 11:19:36 -0700
Subject: [PATCH 3/4] [lldb] Split up checks and add info to error
---
llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp | 13 ++++++++++---
llvm/test/DebugInfo/X86/invalid-cu-length-dwp.s | 2 +-
2 files changed, 11 insertions(+), 4 deletions(-)
diff --git a/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp b/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
index 95db2ddee45d0d..0f6cb947ad2b0e 100644
--- a/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
+++ b/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
@@ -349,13 +349,20 @@ Error DWARFUnitHeader::applyIndexEntry(const DWARFUnitIndex::Entry *Entry) {
Offset);
auto *UnitContrib = IndexEntry->getContribution();
- if (!UnitContrib ||
- UnitContrib->getLength() != (getLength() + getUnitLengthFieldByteSize()))
+ if (!UnitContrib)
return createStringError(errc::invalid_argument,
"DWARF package unit at offset 0x%8.8" PRIx64
- " has an inconsistent index",
+ " has no contribution index",
Offset);
+ uint64_t IndexLength = getLength() + getUnitLengthFieldByteSize();
+ if (UnitContrib->getLength() != IndexLength)
+ return createStringError(errc::invalid_argument,
+ "DWARF package unit at offset 0x%8.8" PRIx64
+ " has an inconsistent index (expected: %" PRIu64
+ ", actual: %" PRIu64 ")",
+ Offset, UnitContrib->getLength(), IndexLength);
+
auto *AbbrEntry = IndexEntry->getContribution(DW_SECT_ABBREV);
if (!AbbrEntry)
return createStringError(errc::invalid_argument,
diff --git a/llvm/test/DebugInfo/X86/invalid-cu-length-dwp.s b/llvm/test/DebugInfo/X86/invalid-cu-length-dwp.s
index f8db0579c21a0e..d67416736093b4 100644
--- a/llvm/test/DebugInfo/X86/invalid-cu-length-dwp.s
+++ b/llvm/test/DebugInfo/X86/invalid-cu-length-dwp.s
@@ -4,7 +4,7 @@
## llvm-dwarfdump used to crash with this input because of an invalid size
## of the compilation unit contribution in the .debug_cu_index section.
-# CHECK: warning: DWARF package unit at offset 0x00000000 has an inconsistent index
+# CHECK: warning: DWARF package unit at offset 0x00000000 has an inconsistent index (expected: 23, actual: 24)
.section .debug_abbrev.dwo, "e", @progbits
.LAbbrBegin:
>From 8f9bcd148766bd47403d09184396efea3b12053d Mon Sep 17 00:00:00 2001
From: Alex Langford <alangford at apple.com>
Date: Mon, 22 Apr 2024 14:18:17 -0700
Subject: [PATCH 4/4] Fix spelling and format specifier
---
llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp | 4 ++--
llvm/test/DebugInfo/X86/invalid-cu-abbrev-contribution-dwp.s | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp b/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
index 0f6cb947ad2b0e..bdd04b00f557bd 100644
--- a/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
+++ b/llvm/lib/DebugInfo/DWARF/DWARFUnit.cpp
@@ -366,8 +366,8 @@ Error DWARFUnitHeader::applyIndexEntry(const DWARFUnitIndex::Entry *Entry) {
auto *AbbrEntry = IndexEntry->getContribution(DW_SECT_ABBREV);
if (!AbbrEntry)
return createStringError(errc::invalid_argument,
- "DWARF package unit at offset 0x%8.8 " PRIx64
- " mising abbreviation column",
+ "DWARF package unit at offset 0x%8.8" PRIx64
+ " missing abbreviation column",
Offset);
AbbrOffset = AbbrEntry->getOffset();
diff --git a/llvm/test/DebugInfo/X86/invalid-cu-abbrev-contribution-dwp.s b/llvm/test/DebugInfo/X86/invalid-cu-abbrev-contribution-dwp.s
index bfd28b503cbadd..6cc539cf8594f2 100644
--- a/llvm/test/DebugInfo/X86/invalid-cu-abbrev-contribution-dwp.s
+++ b/llvm/test/DebugInfo/X86/invalid-cu-abbrev-contribution-dwp.s
@@ -1,7 +1,7 @@
# RUN: llvm-mc -triple x86_64-unknown-linux %s -filetype=obj -o - | \
# RUN: llvm-dwarfdump -debug-info - 2>&1 | FileCheck %s
-# CHECK: warning: DWARF package unit at offset 0x00000000 mising abbreviation column
+# CHECK: warning: DWARF package unit at offset 0x00000000 missing abbreviation column
.section .debug_abbrev.dwo, "e", @progbits
.LAbbrBegin:
More information about the llvm-commits
mailing list