This is an archive of the discontinued LLVM Phabricator instance.

Fix DWARFDie::getDeclFile(...) to work with DW_AT_specification.
ClosedPublic

Authored by clayborg on Aug 20 2021, 12:17 PM.

Download Raw Diff

Details

Reviewers

labath
aprantl
JDevlieghere
dblaikie

Commits

rGa58c2e4af06c: Fix DWARFDie::getDeclFile(...) to work with DW_AT_specification.

Summary

DWARFDie::getDeclFile(...) previously only supported getting the DW_AT_decl_file if the DIE itself contained the DW_AT_decl_file attribute, or if the DIE had a DW_AT_abstract_origin that pointed to another DIE that had a DW_AT_decl_file. This patch allows the function to get the right attribute value if there is a DW_AT_specification that points to another DIE. We also test that if a DW_AT_abtract_origin or DW_AT_specification points to a DIE in another CU with a DW_FORM_ref_addr, that the right line table is used to extract the file index.

Full tests were added for the following cases:

DIE has a DW_AT_decl_file attribute
DIE has a DW_AT_abtract_origin that points to another die in the same CU
DIE has a DW_AT_abtract_origin that points to another die in another CU
DIE has a DW_AT_specification that points to another die in the same CU
DIE has a DW_AT_specification that points to another die in another CU

Diff Detail

Repository: rG LLVM Github Monorepo

Unit TestsFailed

	Time	Test
	30 ms	x64 windows > LLVM-Unit.DebugInfo/DWARF/_/DebugInfoDWARFTests_exe::DWARFDie.getDeclFile
	30 ms	x64 windows > LLVM-Unit.DebugInfo/DWARF/_/DebugInfoDWARFTests_exe::DWARFDie.getDeclFileAbstractOrigin
	30 ms	x64 windows > LLVM-Unit.DebugInfo/DWARF/_/DebugInfoDWARFTests_exe::DWARFDie.getDeclFileAbstractOriginAcrossCUBoundary
	30 ms	x64 windows > LLVM-Unit.DebugInfo/DWARF/_/DebugInfoDWARFTests_exe::DWARFDie.getDeclFileSpecification
	30 ms	x64 windows > LLVM-Unit.DebugInfo/DWARF/_/DebugInfoDWARFTests_exe::DWARFDie.getDeclFileSpecificationAcrossCUBoundary

Event Timeline

clayborg created this revision.Aug 20 2021, 12:17 PM

Herald added a subscriber: hiraditya. · View Herald TranscriptAug 20 2021, 12:17 PM

clayborg requested review of this revision.Aug 20 2021, 12:17 PM

Herald added a project: Restricted Project. · View Herald TranscriptAug 20 2021, 12:17 PM

Herald added a subscriber: llvm-commits. · View Herald Transcript

Harbormaster completed remote builds in B120605: Diff 367866.Aug 20 2021, 1:29 PM

Given the textual overhead of DWARF unit test yaml at the moment, I think it might be reasonable to put the various examples in one test file/one YAML rather than multiple separate tests with all the overhead of describing standalone DWARF in each test. Or, at least, trimming them down substantially to just the bare necessities.

llvm/unittests/DebugInfo/DWARF/DWARFDieTest.cpp
114–135	Could probably strip most of this out - keep just the DW_TAG_compile_unit's DW_AT_stmt_list, and the DW_TAG_subprogram's DW_AT_decl_file?
174–202	Can this all be stripped, or does it have to be here for some reason? (maybe it can just be the single end_sequence?)

Reduced DWARF yaml to absolute minimum needed as suggested in review.

Harbormaster completed remote builds in B120644: Diff 367918.Aug 20 2021, 4:11 PM

Sounds alright

This revision is now accepted and ready to land.Aug 20 2021, 6:02 PM

kyulee added a subscriber: kyulee.Aug 23 2021, 9:49 AM

This revision was landed with ongoing or failed builds.Aug 23 2021, 3:43 PM

Closed by commit rGa58c2e4af06c: Fix DWARFDie::getDeclFile(...) to work with DW_AT_specification. (authored by clayborg). · Explain Why

This revision was automatically updated to reflect the committed changes.

clayborg added a commit: rGa58c2e4af06c: Fix DWARFDie::getDeclFile(...) to work with DW_AT_specification..

Revision Contents

Path

Size

llvm/

include/

llvm/

DebugInfo/

DWARF/

DWARFFormValue.h

13 lines

lib/

DebugInfo/

DWARF/

DWARFDie.cpp

16 lines

DWARFFormValue.cpp

16 lines

unittests/

DebugInfo/

DWARF/

DWARFDieTest.cpp

874 lines

Diff 367866

llvm/include/llvm/DebugInfo/DWARF/DWARFFormValue.h

Show First 20 Lines • Show All 113 Lines • ▼ Show 20 Lines	public:
Optional<int64_t> getAsSignedConstant() const;		Optional<int64_t> getAsSignedConstant() const;
Optional<const char *> getAsCString() const;		Optional<const char *> getAsCString() const;
Optional<uint64_t> getAsAddress() const;		Optional<uint64_t> getAsAddress() const;
Optional<object::SectionedAddress> getAsSectionedAddress() const;		Optional<object::SectionedAddress> getAsSectionedAddress() const;
Optional<uint64_t> getAsSectionOffset() const;		Optional<uint64_t> getAsSectionOffset() const;
Optional<ArrayRef<uint8_t>> getAsBlock() const;		Optional<ArrayRef<uint8_t>> getAsBlock() const;
Optional<uint64_t> getAsCStringOffset() const;		Optional<uint64_t> getAsCStringOffset() const;
Optional<uint64_t> getAsReferenceUVal() const;		Optional<uint64_t> getAsReferenceUVal() const;
		/// Correctly extract any file paths from a form value.
		///
		/// These attributes can be in the from DW_AT_decl_file or DW_AT_call_file
		/// attributes. We need to use the file index in the correct DWARFUnit's line
		/// table prologue, and each DWARFFormValue has the DWARFUnit the form value
		/// was extracted from.
		///
		/// \param Kind The kind of path to extract.
		///
		/// \returns A valid string value on success, or llvm::None if the form class
		/// is not FC_Constant, or if the file index is not valid.
		Optional<std::string>
		getAsFile(DILineInfoSpecifier::FileLineInfoKind Kind) const;

/// Skip a form's value in \p DebugInfoData at the offset specified by		/// Skip a form's value in \p DebugInfoData at the offset specified by
/// \p OffsetPtr.		/// \p OffsetPtr.
///		///
/// Skips the bytes for the current form and updates the offset.		/// Skips the bytes for the current form and updates the offset.
///		///
/// \param DebugInfoData The data where we want to skip the value.		/// \param DebugInfoData The data where we want to skip the value.
/// \param OffsetPtr A reference to the offset that will be updated.		/// \param OffsetPtr A reference to the offset that will be updated.
▲ Show 20 Lines • Show All 193 Lines • Show Last 20 Lines

llvm/lib/DebugInfo/DWARF/DWARFDie.cpp

	Show First 20 Lines • Show All 560 Lines • ▼ Show 20 Lines
	}			}

	uint64_t DWARFDie::getDeclLine() const {			uint64_t DWARFDie::getDeclLine() const {
	return toUnsigned(findRecursively(DW_AT_decl_line), 0);			return toUnsigned(findRecursively(DW_AT_decl_line), 0);
	}			}

	std::string			std::string
	DWARFDie::getDeclFile(DILineInfoSpecifier::FileLineInfoKind Kind) const {			DWARFDie::getDeclFile(DILineInfoSpecifier::FileLineInfoKind Kind) const {
	auto D = getAttributeValueAsReferencedDie(DW_AT_abstract_origin);			if (auto FormValue = findRecursively(DW_AT_decl_file))
	if (!D)			if (auto OptString = FormValue->getAsFile(Kind))
	D = *this;			return *OptString;
	std::string FileName;			return {};
	if (auto DeclFile = toUnsigned(D.find(DW_AT_decl_file))) {
	if (const auto *LineTable =
	getDwarfUnit()->getContext().getLineTableForUnit(
	D.getDwarfUnit()->getLinkedUnit()))
	LineTable->getFileNameByIndex(
	*DeclFile, D.getDwarfUnit()->getCompilationDir(), Kind, FileName);
	}
	return FileName;
	}			}

	void DWARFDie::getCallerFrame(uint32_t &CallFile, uint32_t &CallLine,			void DWARFDie::getCallerFrame(uint32_t &CallFile, uint32_t &CallLine,
	uint32_t &CallColumn,			uint32_t &CallColumn,
	uint32_t &CallDiscriminator) const {			uint32_t &CallDiscriminator) const {
	CallFile = toUnsigned(find(DW_AT_call_file), 0);			CallFile = toUnsigned(find(DW_AT_call_file), 0);
	CallLine = toUnsigned(find(DW_AT_call_line), 0);			CallLine = toUnsigned(find(DW_AT_call_line), 0);
	CallColumn = toUnsigned(find(DW_AT_call_column), 0);			CallColumn = toUnsigned(find(DW_AT_call_column), 0);
	▲ Show 20 Lines • Show All 208 Lines • Show Last 20 Lines

llvm/lib/DebugInfo/DWARF/DWARFFormValue.cpp

Show First 20 Lines • Show All 684 Lines • ▼ Show 20 Lines	DWARFFormValue::getAsSectionedAddress() const {
return {{Value.uval, Value.SectionIndex}};		return {{Value.uval, Value.SectionIndex}};
}		}

Optional<uint64_t> DWARFFormValue::getAsReference() const {		Optional<uint64_t> DWARFFormValue::getAsReference() const {
if (auto R = getAsRelativeReference())		if (auto R = getAsRelativeReference())
return R->Unit ? R->Unit->getOffset() + R->Offset : R->Offset;		return R->Unit ? R->Unit->getOffset() + R->Offset : R->Offset;
return None;		return None;
}		}

Optional<DWARFFormValue::UnitOffset> DWARFFormValue::getAsRelativeReference() const {		Optional<DWARFFormValue::UnitOffset> DWARFFormValue::getAsRelativeReference() const {
if (!isFormClass(FC_Reference))		if (!isFormClass(FC_Reference))
return None;		return None;
switch (Form) {		switch (Form) {
case DW_FORM_ref1:		case DW_FORM_ref1:
case DW_FORM_ref2:		case DW_FORM_ref2:
case DW_FORM_ref4:		case DW_FORM_ref4:
case DW_FORM_ref8:		case DW_FORM_ref8:
▲ Show 20 Lines • Show All 55 Lines • ▼ Show 20 Lines	Optional<uint64_t> DWARFFormValue::getAsCStringOffset() const {
return Value.uval;		return Value.uval;
}		}

Optional<uint64_t> DWARFFormValue::getAsReferenceUVal() const {		Optional<uint64_t> DWARFFormValue::getAsReferenceUVal() const {
if (!isFormClass(FC_Reference))		if (!isFormClass(FC_Reference))
return None;		return None;
return Value.uval;		return Value.uval;
}		}

		Optional<std::string>
		DWARFFormValue::getAsFile(DILineInfoSpecifier::FileLineInfoKind Kind) const {
		if (U == nullptr \|\| !isFormClass(FC_Constant))
		return None;
		DWARFUnit DU = const_cast<DWARFUnit >(U);
		if (auto *LT = U->getContext().getLineTableForUnit(DU->getLinkedUnit())) {
		std::string FileName;
		if (LT->getFileNameByIndex(Value.uval, DU->getCompilationDir(), Kind,
		FileName))
		return FileName;
		}
		return None;
		}

llvm/unittests/DebugInfo/DWARF/DWARFDieTest.cpp

Show First 20 Lines • Show All 94 Lines • ▼ Show 20 Lines	EXPECT_THAT_EXPECTED(
"unexpected end of data at offset 0x20 while reading [0x20, 0x21)"));		"unexpected end of data at offset 0x20 while reading [0x20, 0x21)"));

EXPECT_THAT_EXPECTED(		EXPECT_THAT_EXPECTED(
Die.getLocations(DW_AT_call_data_value),		Die.getLocations(DW_AT_call_data_value),
Failed<ErrorInfoBase>(testing::Property(&ErrorInfoBase::message,		Failed<ErrorInfoBase>(testing::Property(&ErrorInfoBase::message,
"No DW_AT_call_data_value")));		"No DW_AT_call_data_value")));
}		}

		TEST(DWARFDie, getDeclFile) {
		const char *yamldata = R"(
		Lint: Pre-merge checks Inline Actions clang-tidy: warning: invalid case style for variable 'yamldata' [readability-identifier-naming] not useful Lint: Pre-merge checks: clang-tidy: warning: invalid case style for variable 'yamldata' [readability-identifier-naming]…
		debug_str:
		- ''
		- '/tmp/main.cpp'
		- main
		debug_abbrev:
		- ID: 0
		Table:
		- Code: 0x1
		Tag: DW_TAG_compile_unit
		Children: DW_CHILDREN_yes
		Attributes:
		- Attribute: DW_AT_name
		Form: DW_FORM_strp
		- Attribute: DW_AT_language
		Form: DW_FORM_udata
		- Attribute: DW_AT_stmt_list
		Form: DW_FORM_sec_offset
		- Code: 0x2
		Tag: DW_TAG_subprogram
		Children: DW_CHILDREN_no
		Attributes:
		- Attribute: DW_AT_low_pc
		Form: DW_FORM_addr
		- Attribute: DW_AT_high_pc
		Form: DW_FORM_addr
		- Attribute: DW_AT_name
		Form: DW_FORM_strp
		- Attribute: DW_AT_decl_file
		Form: DW_FORM_data1
		- Attribute: DW_AT_decl_line
		Form: DW_FORM_data1
		dblaikieUnsubmitted Not Done Reply Inline Actions Could probably strip most of this out - keep just the DW_TAG_compile_unit's DW_AT_stmt_list, and the DW_TAG_subprogram's DW_AT_decl_file? dblaikie: Could probably strip most of this out - keep just the DW_TAG_compile_unit's DW_AT_stmt_list…
		debug_info:
		- Length: 0x29
		Version: 4
		AbbrevTableID: 0
		AbbrOffset: 0x0
		AddrSize: 8
		Entries:
		- AbbrCode: 0x1
		Values:
		- Value: 0x1
		- Value: 0x2
		- Value: 0x0
		- AbbrCode: 0x2
		Values:
		- Value: 0x1000
		- Value: 0x1050
		- Value: 0xF
		- Value: 0x1
		- Value: 0x14
		- AbbrCode: 0x0
		debug_line:
		- Length: 80
		Version: 2
		PrologueLength: 36
		MinInstLength: 1
		DefaultIsStmt: 1
		LineBase: 251
		LineRange: 14
		OpcodeBase: 13
		StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
		IncludeDirs:
		- '/tmp'
		Files:
		- Name: main.cpp
		DirIdx: 1
		ModTime: 0
		Length: 0
		Opcodes:
		- Opcode: DW_LNS_extended_op
		ExtLen: 9
		SubOpcode: DW_LNE_set_address
		Data: 4096
		- Opcode: DW_LNS_advance_line
		SData: 9
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 16
		- Opcode: DW_LNS_advance_line
		SData: 1
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 16
		- Opcode: DW_LNS_advance_line
		SData: 1
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 18446744073709548538
		- Opcode: DW_LNS_extended_op
		ExtLen: 1
		SubOpcode: DW_LNE_end_sequence
		Data: 0
		dblaikieUnsubmitted Not Done Reply Inline Actions Can this all be stripped, or does it have to be here for some reason? (maybe it can just be the single end_sequence?) dblaikie: Can this all be stripped, or does it have to be here for some reason? (maybe it can just be the…
		)";

		// Given DWARF like this:
		//
		// 0x0000000b: DW_TAG_compile_unit
		// DW_AT_name ("/tmp/main.cpp")
		// DW_AT_language (DW_LANG_C)
		// DW_AT_stmt_list (0x00000000)
		//
		// 0x00000015: DW_TAG_subprogram
		// DW_AT_low_pc (0x0000000000001000)
		// DW_AT_high_pc (0x0000000000001050)
		// DW_AT_name ("main")
		// DW_AT_decl_file ("/tmp/main.cpp")
		// DW_AT_decl_line (20)
		//
		// 0x0000002c: NULL
		//
		// This tests that we can extract the right DW_AT_decl_file from a DIE that
		// has a DW_AT_decl_file attribute.

		Expected<StringMap<std::unique_ptr<MemoryBuffer>>> Sections =
		DWARFYAML::emitDebugSections(StringRef(yamldata),
		/IsLittleEndian=/true,
		/Is64BitAddrSize=/true);
		ASSERT_THAT_EXPECTED(Sections, Succeeded());
		std::unique_ptr<DWARFContext> Ctx =
		DWARFContext::create(Sections, 4, /isLittleEndian=*/true);
		DWARFCompileUnit *CU = Ctx->getCompileUnitForOffset(0);
		ASSERT_NE(nullptr, CU);
		DWARFDie Die = CU->getUnitDIE(/ExtractUnitDIEOnly=/false);
		ASSERT_TRUE(Die.isValid());

		DWARFDie MainDie = Die.getFirstChild();
		ASSERT_TRUE(MainDie.isValid());

		std::string DeclFile = MainDie.getDeclFile(
		DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath);

		EXPECT_EQ(DeclFile, "/tmp/main.cpp");
		}

		TEST(DWARFDie, getDeclFileAbstractOrigin) {
		const char *yamldata = R"(
		Lint: Pre-merge checks Inline Actions clang-tidy: warning: invalid case style for variable 'yamldata' [readability-identifier-naming] not useful Lint: Pre-merge checks: clang-tidy: warning: invalid case style for variable 'yamldata' [readability-identifier-naming]…
		debug_str:
		- ''
		- '/tmp/main.cpp'
		- main
		debug_abbrev:
		- ID: 0
		Table:
		- Code: 0x1
		Tag: DW_TAG_compile_unit
		Children: DW_CHILDREN_yes
		Attributes:
		- Attribute: DW_AT_name
		Form: DW_FORM_strp
		- Attribute: DW_AT_language
		Form: DW_FORM_udata
		- Attribute: DW_AT_stmt_list
		Form: DW_FORM_sec_offset
		- Code: 0x2
		Tag: DW_TAG_subprogram
		Children: DW_CHILDREN_no
		Attributes:
		- Attribute: DW_AT_low_pc
		Form: DW_FORM_addr
		- Attribute: DW_AT_high_pc
		Form: DW_FORM_addr
		- Attribute: DW_AT_abstract_origin
		Form: DW_FORM_ref4
		- Code: 0x3
		Tag: DW_TAG_subprogram
		Children: DW_CHILDREN_no
		Attributes:
		- Attribute: DW_AT_name
		Form: DW_FORM_strp
		- Attribute: DW_AT_decl_file
		Form: DW_FORM_data1
		- Attribute: DW_AT_decl_line
		Form: DW_FORM_data1
		debug_info:
		- Length: 0x2E
		Version: 4
		AbbrevTableID: 0
		AbbrOffset: 0x0
		AddrSize: 8
		Entries:
		- AbbrCode: 0x1
		Values:
		- Value: 0x1
		- Value: 0x2
		- Value: 0x0
		- AbbrCode: 0x2
		Values:
		- Value: 0x1000
		- Value: 0x1050
		- Value: 0x2A
		- AbbrCode: 0x3
		Values:
		- Value: 0xF
		- Value: 0x1
		- Value: 0x14
		- AbbrCode: 0x0
		debug_line:
		- Length: 80
		Version: 2
		PrologueLength: 36
		MinInstLength: 1
		DefaultIsStmt: 1
		LineBase: 251
		LineRange: 14
		OpcodeBase: 13
		StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
		IncludeDirs:
		- '/tmp'
		Files:
		- Name: main.cpp
		DirIdx: 1
		ModTime: 0
		Length: 0
		Opcodes:
		- Opcode: DW_LNS_extended_op
		ExtLen: 9
		SubOpcode: DW_LNE_set_address
		Data: 4096
		- Opcode: DW_LNS_advance_line
		SData: 9
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 16
		- Opcode: DW_LNS_advance_line
		SData: 1
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 16
		- Opcode: DW_LNS_advance_line
		SData: 1
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 18446744073709548538
		- Opcode: DW_LNS_extended_op
		ExtLen: 1
		SubOpcode: DW_LNE_end_sequence
		Data: 0
		)";

		// Given DWARF like this:
		//
		// 0x0000000b: DW_TAG_compile_unit
		// DW_AT_name ("/tmp/main.cpp")
		// DW_AT_language (DW_LANG_C)
		// DW_AT_stmt_list (0x00000000)
		//
		// 0x00000015: DW_TAG_subprogram
		// DW_AT_low_pc (0x0000000000001000)
		// DW_AT_high_pc (0x0000000000001050)
		// DW_AT_abstract_origin (0x0000002a "main")
		//
		// 0x0000002a: DW_TAG_subprogram
		// DW_AT_name ("main")
		// DW_AT_decl_file ("/tmp/main.cpp")
		// DW_AT_decl_line (20)
		//
		// 0x00000031: NULL

		//
		// The DIE at 0x00000015 uses a DW_AT_abstract_origin to point to the DIE at
		// 0x0000002a, make sure that DWARFDie::getDeclFile() succeeds by extracting
		// the right file name of "/tmp/main.cpp".
		//
		// This tests that when we have a DW_AT_abstract_origin with a compile unit
		// relative form (DW_FORM_ref4) to another DIE that we get the right
		// DW_AT_decl_file value.

		Expected<StringMap<std::unique_ptr<MemoryBuffer>>> Sections =
		DWARFYAML::emitDebugSections(StringRef(yamldata),
		/IsLittleEndian=/true,
		/Is64BitAddrSize=/true);
		ASSERT_THAT_EXPECTED(Sections, Succeeded());
		std::unique_ptr<DWARFContext> Ctx =
		DWARFContext::create(Sections, 4, /isLittleEndian=*/true);
		DWARFCompileUnit *CU = Ctx->getCompileUnitForOffset(0);
		ASSERT_NE(nullptr, CU);
		DWARFDie Die = CU->getUnitDIE(/ExtractUnitDIEOnly=/false);
		ASSERT_TRUE(Die.isValid());

		DWARFDie MainDie = Die.getFirstChild();
		ASSERT_TRUE(MainDie.isValid());

		std::string DeclFile = MainDie.getDeclFile(
		DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath);

		EXPECT_EQ(DeclFile, "/tmp/main.cpp");
		}

		TEST(DWARFDie, getDeclFileSpecification) {
		const char *yamldata = R"(
		Lint: Pre-merge checks Inline Actions clang-tidy: warning: invalid case style for variable 'yamldata' [readability-identifier-naming] not useful Lint: Pre-merge checks: clang-tidy: warning: invalid case style for variable 'yamldata' [readability-identifier-naming]…
		debug_str:
		- ''
		- '/tmp/main.cpp'
		- main
		debug_abbrev:
		- ID: 0
		Table:
		- Code: 0x1
		Tag: DW_TAG_compile_unit
		Children: DW_CHILDREN_yes
		Attributes:
		- Attribute: DW_AT_name
		Form: DW_FORM_strp
		- Attribute: DW_AT_language
		Form: DW_FORM_udata
		- Attribute: DW_AT_stmt_list
		Form: DW_FORM_sec_offset
		- Code: 0x2
		Tag: DW_TAG_subprogram
		Children: DW_CHILDREN_no
		Attributes:
		- Attribute: DW_AT_low_pc
		Form: DW_FORM_addr
		- Attribute: DW_AT_high_pc
		Form: DW_FORM_addr
		- Attribute: DW_AT_specification
		Form: DW_FORM_ref4
		- Code: 0x3
		Tag: DW_TAG_subprogram
		Children: DW_CHILDREN_no
		Attributes:
		- Attribute: DW_AT_name
		Form: DW_FORM_strp
		- Attribute: DW_AT_decl_file
		Form: DW_FORM_data1
		- Attribute: DW_AT_decl_line
		Form: DW_FORM_data1
		debug_info:
		- Length: 0x2E
		Version: 4
		AbbrevTableID: 0
		AbbrOffset: 0x0
		AddrSize: 8
		Entries:
		- AbbrCode: 0x1
		Values:
		- Value: 0x1
		- Value: 0x2
		- Value: 0x0
		- AbbrCode: 0x2
		Values:
		- Value: 0x1000
		- Value: 0x1050
		- Value: 0x2A
		- AbbrCode: 0x3
		Values:
		- Value: 0xF
		- Value: 0x1
		- Value: 0x14
		- AbbrCode: 0x0
		debug_line:
		- Length: 80
		Version: 2
		PrologueLength: 36
		MinInstLength: 1
		DefaultIsStmt: 1
		LineBase: 251
		LineRange: 14
		OpcodeBase: 13
		StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
		IncludeDirs:
		- '/tmp'
		Files:
		- Name: main.cpp
		DirIdx: 1
		ModTime: 0
		Length: 0
		Opcodes:
		- Opcode: DW_LNS_extended_op
		ExtLen: 9
		SubOpcode: DW_LNE_set_address
		Data: 4096
		- Opcode: DW_LNS_advance_line
		SData: 9
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 16
		- Opcode: DW_LNS_advance_line
		SData: 1
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 16
		- Opcode: DW_LNS_advance_line
		SData: 1
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 18446744073709548538
		- Opcode: DW_LNS_extended_op
		ExtLen: 1
		SubOpcode: DW_LNE_end_sequence
		Data: 0
		)";

		// Given DWARF like this:
		//
		// 0x0000000b: DW_TAG_compile_unit
		// DW_AT_name ("/tmp/main.cpp")
		// DW_AT_language (DW_LANG_C)
		// DW_AT_stmt_list (0x00000000)
		//
		// 0x00000015: DW_TAG_subprogram
		// DW_AT_low_pc (0x0000000000001000)
		// DW_AT_high_pc (0x0000000000001050)
		// DW_AT_specification (0x0000002a "main")
		//
		// 0x0000002a: DW_TAG_subprogram
		// DW_AT_name ("main")
		// DW_AT_decl_file ("/tmp/main.cpp")
		// DW_AT_decl_line (20)
		//
		// 0x00000031: NULL

		//
		// The DIE at 0x00000015 uses a DW_AT_specification to point to the DIE at
		// 0x0000002a, make sure that DWARFDie::getDeclFile() succeeds by extracting
		// the right file name of "/tmp/main.cpp".
		//
		// This tests that when we have a DW_AT_specification with a compile unit
		// relative form (DW_FORM_ref4) to another DIE that we get the right
		// DW_AT_decl_file value.

		Expected<StringMap<std::unique_ptr<MemoryBuffer>>> Sections =
		DWARFYAML::emitDebugSections(StringRef(yamldata),
		/IsLittleEndian=/true,
		/Is64BitAddrSize=/true);
		ASSERT_THAT_EXPECTED(Sections, Succeeded());
		std::unique_ptr<DWARFContext> Ctx =
		DWARFContext::create(Sections, 4, /isLittleEndian=*/true);
		DWARFCompileUnit *CU = Ctx->getCompileUnitForOffset(0);
		ASSERT_NE(nullptr, CU);
		DWARFDie Die = CU->getUnitDIE(/ExtractUnitDIEOnly=/false);
		ASSERT_TRUE(Die.isValid());

		DWARFDie MainDie = Die.getFirstChild();
		ASSERT_TRUE(MainDie.isValid());

		std::string DeclFile = MainDie.getDeclFile(
		DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath);

		EXPECT_EQ(DeclFile, "/tmp/main.cpp");
		}

		TEST(DWARFDie, getDeclFileAbstractOriginAcrossCUBoundary) {
		const char *yamldata = R"(
		Lint: Pre-merge checks Inline Actions clang-tidy: warning: invalid case style for variable 'yamldata' [readability-identifier-naming] not useful Lint: Pre-merge checks: clang-tidy: warning: invalid case style for variable 'yamldata' [readability-identifier-naming]…
		debug_str:
		- ''
		- '/tmp/foo.cpp'
		- '/tmp/main.cpp'
		- main
		debug_abbrev:
		- ID: 0
		Table:
		- Code: 0x1
		Tag: DW_TAG_compile_unit
		Children: DW_CHILDREN_yes
		Attributes:
		- Attribute: DW_AT_name
		Form: DW_FORM_strp
		- Attribute: DW_AT_language
		Form: DW_FORM_udata
		- Attribute: DW_AT_stmt_list
		Form: DW_FORM_sec_offset
		- Code: 0x2
		Tag: DW_TAG_subprogram
		Children: DW_CHILDREN_no
		Attributes:
		- Attribute: DW_AT_abstract_origin
		Form: DW_FORM_ref_addr
		- Attribute: DW_AT_low_pc
		Form: DW_FORM_addr
		- Attribute: DW_AT_high_pc
		Form: DW_FORM_addr
		- Code: 0x3
		Tag: DW_TAG_subprogram
		Children: DW_CHILDREN_no
		Attributes:
		- Attribute: DW_AT_name
		Form: DW_FORM_strp
		- Attribute: DW_AT_decl_file
		Form: DW_FORM_data1
		- Attribute: DW_AT_decl_line
		Form: DW_FORM_data1
		debug_info:
		- Length: 0x27
		Version: 4
		AbbrevTableID: 0
		AbbrOffset: 0x0
		AddrSize: 8
		Entries:
		- AbbrCode: 0x1
		Values:
		- Value: 0x1
		- Value: 0x2
		- Value: 0x0
		- AbbrCode: 0x2
		Values:
		- Value: 0x40
		- Value: 0x1000
		- Value: 0x1050
		- AbbrCode: 0x0
		- Length: 0x19
		Version: 4
		AbbrevTableID: 0
		AbbrOffset: 0x0
		AddrSize: 8
		Entries:
		- AbbrCode: 0x1
		Values:
		- Value: 0xE
		- Value: 0x2
		- Value: 0x53
		- AbbrCode: 0x3
		Values:
		- Value: 0x1C
		- Value: 0x1
		- Value: 0x14
		- AbbrCode: 0x0
		debug_line:
		- Length: 79
		Version: 2
		PrologueLength: 35
		MinInstLength: 1
		DefaultIsStmt: 1
		LineBase: 251
		LineRange: 14
		OpcodeBase: 13
		StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
		IncludeDirs:
		- '/tmp'
		Files:
		- Name: foo.cpp
		DirIdx: 1
		ModTime: 0
		Length: 0
		Opcodes:
		- Opcode: DW_LNS_extended_op
		ExtLen: 9
		SubOpcode: DW_LNE_set_address
		Data: 4096
		- Opcode: DW_LNS_advance_line
		SData: 9
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 16
		- Opcode: DW_LNS_advance_line
		SData: 1
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 16
		- Opcode: DW_LNS_advance_line
		SData: 1
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 18446744073709548538
		- Opcode: DW_LNS_extended_op
		ExtLen: 1
		SubOpcode: DW_LNE_end_sequence
		Data: 0
		- Length: 56
		Version: 2
		PrologueLength: 36
		MinInstLength: 1
		DefaultIsStmt: 1
		LineBase: 251
		LineRange: 14
		OpcodeBase: 13
		StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
		IncludeDirs:
		- '/tmp'
		Files:
		- Name: main.cpp
		DirIdx: 1
		ModTime: 0
		Length: 0
		Opcodes:
		- Opcode: DW_LNS_extended_op
		ExtLen: 9
		SubOpcode: DW_LNE_set_address
		Data: 0
		- Opcode: DW_LNS_extended_op
		ExtLen: 1
		SubOpcode: DW_LNE_end_sequence
		Data: 0
		)";

		// Given DWARF like this:
		//
		// 0x0000000b: DW_TAG_compile_unit
		// DW_AT_name ("/tmp/foo.cpp")
		// DW_AT_language (DW_LANG_C)
		// DW_AT_stmt_list (0x00000000)
		//
		// 0x00000015: DW_TAG_subprogram
		// DW_AT_abstract_origin (0x0000000000000040 "main")
		// DW_AT_low_pc (0x0000000000001000)
		// DW_AT_high_pc (0x0000000000001050)
		//
		// 0x0000002a: NULL
		//
		// 0x00000036: DW_TAG_compile_unit
		// DW_AT_name ("/tmp/main.cpp")
		// DW_AT_language (DW_LANG_C)
		// DW_AT_stmt_list (0x00000053)
		//
		// 0x00000040: DW_TAG_subprogram
		// DW_AT_name ("main")
		// DW_AT_decl_file ("/tmp/main.cpp")
		// DW_AT_decl_line (20)
		//
		// 0x00000047: NULL
		//
		// This tests that when we have a DW_AT_abstract_origin with a
		// DW_FORM_ref_addr to another DIE in another compile unit that we use the
		// right file table when converting the file index of the DW_AT_decl_file.
		//
		// The DIE at 0x00000015 uses a DW_AT_abstract_origin to point to the DIE at
		// 0x00000040, make sure that DWARFDie::getDeclFile() succeeds by extracting
		// the right file name of "/tmp/main.cpp". The DW_AT_decl_file must grab the
		// file from the line table prologue of the compile unit at offset
		// 0x00000036.

		Expected<StringMap<std::unique_ptr<MemoryBuffer>>> Sections =
		DWARFYAML::emitDebugSections(StringRef(yamldata),
		/IsLittleEndian=/true,
		/Is64BitAddrSize=/true);
		ASSERT_THAT_EXPECTED(Sections, Succeeded());
		std::unique_ptr<DWARFContext> Ctx =
		DWARFContext::create(Sections, 4, /isLittleEndian=*/true);
		DWARFCompileUnit *CU = Ctx->getCompileUnitForOffset(0);
		ASSERT_NE(nullptr, CU);
		DWARFDie Die = CU->getUnitDIE(/ExtractUnitDIEOnly=/false);
		ASSERT_TRUE(Die.isValid());

		DWARFDie MainDie = Die.getFirstChild();
		ASSERT_TRUE(MainDie.isValid());

		std::string DeclFile = MainDie.getDeclFile(
		DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath);

		EXPECT_EQ(DeclFile, "/tmp/main.cpp");
		}

		TEST(DWARFDie, getDeclFileSpecificationAcrossCUBoundary) {
		const char *yamldata = R"(
		Lint: Pre-merge checks Inline Actions clang-tidy: warning: invalid case style for variable 'yamldata' [readability-identifier-naming] not useful Lint: Pre-merge checks: clang-tidy: warning: invalid case style for variable 'yamldata' [readability-identifier-naming]…
		debug_str:
		- ''
		- '/tmp/foo.cpp'
		- '/tmp/main.cpp'
		- main
		debug_abbrev:
		- ID: 0
		Table:
		- Code: 0x1
		Tag: DW_TAG_compile_unit
		Children: DW_CHILDREN_yes
		Attributes:
		- Attribute: DW_AT_name
		Form: DW_FORM_strp
		- Attribute: DW_AT_language
		Form: DW_FORM_udata
		- Attribute: DW_AT_stmt_list
		Form: DW_FORM_sec_offset
		- Code: 0x2
		Tag: DW_TAG_subprogram
		Children: DW_CHILDREN_no
		Attributes:
		- Attribute: DW_AT_specification
		Form: DW_FORM_ref_addr
		- Attribute: DW_AT_low_pc
		Form: DW_FORM_addr
		- Attribute: DW_AT_high_pc
		Form: DW_FORM_addr
		- Code: 0x3
		Tag: DW_TAG_subprogram
		Children: DW_CHILDREN_no
		Attributes:
		- Attribute: DW_AT_name
		Form: DW_FORM_strp
		- Attribute: DW_AT_decl_file
		Form: DW_FORM_data1
		- Attribute: DW_AT_decl_line
		Form: DW_FORM_data1
		debug_info:
		- Length: 0x27
		Version: 4
		AbbrevTableID: 0
		AbbrOffset: 0x0
		AddrSize: 8
		Entries:
		- AbbrCode: 0x1
		Values:
		- Value: 0x1
		- Value: 0x2
		- Value: 0x0
		- AbbrCode: 0x2
		Values:
		- Value: 0x40
		- Value: 0x1000
		- Value: 0x1050
		- AbbrCode: 0x0
		- Length: 0x19
		Version: 4
		AbbrevTableID: 0
		AbbrOffset: 0x0
		AddrSize: 8
		Entries:
		- AbbrCode: 0x1
		Values:
		- Value: 0xE
		- Value: 0x2
		- Value: 0x53
		- AbbrCode: 0x3
		Values:
		- Value: 0x1C
		- Value: 0x1
		- Value: 0x14
		- AbbrCode: 0x0
		debug_line:
		- Length: 79
		Version: 2
		PrologueLength: 35
		MinInstLength: 1
		DefaultIsStmt: 1
		LineBase: 251
		LineRange: 14
		OpcodeBase: 13
		StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
		IncludeDirs:
		- '/tmp'
		Files:
		- Name: foo.cpp
		DirIdx: 1
		ModTime: 0
		Length: 0
		Opcodes:
		- Opcode: DW_LNS_extended_op
		ExtLen: 9
		SubOpcode: DW_LNE_set_address
		Data: 4096
		- Opcode: DW_LNS_advance_line
		SData: 9
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 16
		- Opcode: DW_LNS_advance_line
		SData: 1
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 16
		- Opcode: DW_LNS_advance_line
		SData: 1
		Data: 0
		- Opcode: DW_LNS_copy
		Data: 0
		- Opcode: DW_LNS_advance_pc
		Data: 18446744073709548538
		- Opcode: DW_LNS_extended_op
		ExtLen: 1
		SubOpcode: DW_LNE_end_sequence
		Data: 0
		- Length: 56
		Version: 2
		PrologueLength: 36
		MinInstLength: 1
		DefaultIsStmt: 1
		LineBase: 251
		LineRange: 14
		OpcodeBase: 13
		StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ]
		IncludeDirs:
		- '/tmp'
		Files:
		- Name: main.cpp
		DirIdx: 1
		ModTime: 0
		Length: 0
		Opcodes:
		- Opcode: DW_LNS_extended_op
		ExtLen: 9
		SubOpcode: DW_LNE_set_address
		Data: 0
		- Opcode: DW_LNS_extended_op
		ExtLen: 1
		SubOpcode: DW_LNE_end_sequence
		Data: 0
		)";

		// Given DWARF like this:
		//
		// 0x0000000b: DW_TAG_compile_unit
		// DW_AT_name ("/tmp/foo.cpp")
		// DW_AT_language (DW_LANG_C)
		// DW_AT_stmt_list (0x00000000)
		//
		// 0x00000015: DW_TAG_subprogram
		// DW_AT_specification (0x0000000000000040 "main")
		// DW_AT_low_pc (0x0000000000001000)
		// DW_AT_high_pc (0x0000000000001050)
		//
		// 0x0000002a: NULL
		//
		// 0x00000036: DW_TAG_compile_unit
		// DW_AT_name ("/tmp/main.cpp")
		// DW_AT_language (DW_LANG_C)
		// DW_AT_stmt_list (0x00000053)
		//
		// 0x00000040: DW_TAG_subprogram
		// DW_AT_name ("main")
		// DW_AT_decl_file ("/tmp/main.cpp")
		// DW_AT_decl_line (20)
		//
		// 0x00000047: NULL
		//
		// This tests that when we have a DW_AT_specification with a
		// DW_FORM_ref_addr to another DIE in another compile unit that we use the
		// right file table when converting the file index of the DW_AT_decl_file.
		//
		// The DIE at 0x00000015 uses a DW_AT_specification to point to the DIE at
		// 0x00000040, make sure that DWARFDie::getDeclFile() succeeds by extracting
		// the right file name of "/tmp/main.cpp". The DW_AT_decl_file must grab the
		// file from the line table prologue of the compile unit at offset
		// 0x00000036.

		Expected<StringMap<std::unique_ptr<MemoryBuffer>>> Sections =
		DWARFYAML::emitDebugSections(StringRef(yamldata),
		/IsLittleEndian=/true,
		/Is64BitAddrSize=/true);
		ASSERT_THAT_EXPECTED(Sections, Succeeded());
		std::unique_ptr<DWARFContext> Ctx =
		DWARFContext::create(Sections, 4, /isLittleEndian=*/true);
		DWARFCompileUnit *CU = Ctx->getCompileUnitForOffset(0);
		ASSERT_NE(nullptr, CU);
		DWARFDie Die = CU->getUnitDIE(/ExtractUnitDIEOnly=/false);
		ASSERT_TRUE(Die.isValid());

		DWARFDie MainDie = Die.getFirstChild();
		ASSERT_TRUE(MainDie.isValid());

		std::string DeclFile = MainDie.getDeclFile(
		DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath);

		EXPECT_EQ(DeclFile, "/tmp/main.cpp");
		}

} // end anonymous namespace		} // end anonymous namespace

This is an archive of the discontinued LLVM Phabricator instance.

Fix DWARFDie::getDeclFile(...) to work with DW_AT_specification.ClosedPublic

Details

Diff Detail

Unit TestsFailed

Event Timeline

Revision Contents

Diff 367866

llvm/include/llvm/DebugInfo/DWARF/DWARFFormValue.h

llvm/lib/DebugInfo/DWARF/DWARFDie.cpp

llvm/lib/DebugInfo/DWARF/DWARFFormValue.cpp

llvm/unittests/DebugInfo/DWARF/DWARFDieTest.cpp

Fix DWARFDie::getDeclFile(...) to work with DW_AT_specification.
ClosedPublic