109467b48Spatrick //===- DWARFDebugMacro.cpp ------------------------------------------------===//
209467b48Spatrick //
309467b48Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
409467b48Spatrick // See https://llvm.org/LICENSE.txt for license information.
509467b48Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
609467b48Spatrick //
709467b48Spatrick //===----------------------------------------------------------------------===//
809467b48Spatrick
909467b48Spatrick #include "llvm/DebugInfo/DWARF/DWARFDebugMacro.h"
10*d415bd75Srobert #include "llvm/ADT/DenseMap.h"
1109467b48Spatrick #include "llvm/BinaryFormat/Dwarf.h"
12097a140dSpatrick #include "llvm/DebugInfo/DWARF/DWARFDataExtractor.h"
13*d415bd75Srobert #include "llvm/DebugInfo/DWARF/DWARFDie.h"
14*d415bd75Srobert #include "llvm/DebugInfo/DWARF/DWARFFormValue.h"
15*d415bd75Srobert #include "llvm/Support/Errc.h"
1609467b48Spatrick #include "llvm/Support/WithColor.h"
1709467b48Spatrick #include "llvm/Support/raw_ostream.h"
1809467b48Spatrick #include <cstdint>
1909467b48Spatrick
2009467b48Spatrick using namespace llvm;
2109467b48Spatrick using namespace dwarf;
2209467b48Spatrick
getDwarfFormat() const23097a140dSpatrick DwarfFormat DWARFDebugMacro::MacroHeader::getDwarfFormat() const {
24097a140dSpatrick return Flags & MACRO_OFFSET_SIZE ? DWARF64 : DWARF32;
25097a140dSpatrick }
26097a140dSpatrick
getOffsetByteSize() const27097a140dSpatrick uint8_t DWARFDebugMacro::MacroHeader::getOffsetByteSize() const {
28097a140dSpatrick return getDwarfOffsetByteSize(getDwarfFormat());
29097a140dSpatrick }
30097a140dSpatrick
dumpMacroHeader(raw_ostream & OS) const31097a140dSpatrick void DWARFDebugMacro::MacroHeader::dumpMacroHeader(raw_ostream &OS) const {
32097a140dSpatrick // FIXME: Add support for dumping opcode_operands_table
33097a140dSpatrick OS << format("macro header: version = 0x%04" PRIx16, Version)
34097a140dSpatrick << format(", flags = 0x%02" PRIx8, Flags)
35097a140dSpatrick << ", format = " << FormatString(getDwarfFormat());
36097a140dSpatrick if (Flags & MACRO_DEBUG_LINE_OFFSET)
37097a140dSpatrick OS << format(", debug_line_offset = 0x%0*" PRIx64, 2 * getOffsetByteSize(),
38097a140dSpatrick DebugLineOffset);
39097a140dSpatrick OS << "\n";
40097a140dSpatrick }
41097a140dSpatrick
dump(raw_ostream & OS) const4209467b48Spatrick void DWARFDebugMacro::dump(raw_ostream &OS) const {
4309467b48Spatrick unsigned IndLevel = 0;
4409467b48Spatrick for (const auto &Macros : MacroLists) {
45097a140dSpatrick OS << format("0x%08" PRIx64 ":\n", Macros.Offset);
4673471bf0Spatrick if (Macros.IsDebugMacro)
47097a140dSpatrick Macros.Header.dumpMacroHeader(OS);
48097a140dSpatrick for (const Entry &E : Macros.Macros) {
4909467b48Spatrick // There should not be DW_MACINFO_end_file when IndLevel is Zero. However,
5009467b48Spatrick // this check handles the case of corrupted ".debug_macinfo" section.
5109467b48Spatrick if (IndLevel > 0)
5209467b48Spatrick IndLevel -= (E.Type == DW_MACINFO_end_file);
5309467b48Spatrick // Print indentation.
5409467b48Spatrick for (unsigned I = 0; I < IndLevel; I++)
5509467b48Spatrick OS << " ";
5609467b48Spatrick IndLevel += (E.Type == DW_MACINFO_start_file);
57097a140dSpatrick // Based on which version we are handling choose appropriate macro forms.
5873471bf0Spatrick if (Macros.IsDebugMacro)
5973471bf0Spatrick WithColor(OS, HighlightColor::Macro).get()
6073471bf0Spatrick << (Macros.Header.Version < 5 ? GnuMacroString(E.Type)
6173471bf0Spatrick : MacroString(E.Type));
62097a140dSpatrick else
6309467b48Spatrick WithColor(OS, HighlightColor::Macro).get() << MacinfoString(E.Type);
6409467b48Spatrick switch (E.Type) {
6509467b48Spatrick default:
66097a140dSpatrick // Got a corrupted ".debug_macinfo/.debug_macro" section (invalid
67097a140dSpatrick // macinfo type).
6809467b48Spatrick break;
69097a140dSpatrick // debug_macro and debug_macinfo share some common encodings.
70097a140dSpatrick // DW_MACRO_define == DW_MACINFO_define
71097a140dSpatrick // DW_MACRO_undef == DW_MACINFO_undef
72097a140dSpatrick // DW_MACRO_start_file == DW_MACINFO_start_file
73097a140dSpatrick // DW_MACRO_end_file == DW_MACINFO_end_file
74097a140dSpatrick // For readability/uniformity we are using DW_MACRO_*.
7573471bf0Spatrick //
7673471bf0Spatrick // The GNU .debug_macro extension's entries have the same encoding
7773471bf0Spatrick // as DWARF 5's DW_MACRO_* entries, so we only use the latter here.
78097a140dSpatrick case DW_MACRO_define:
79097a140dSpatrick case DW_MACRO_undef:
80097a140dSpatrick case DW_MACRO_define_strp:
81097a140dSpatrick case DW_MACRO_undef_strp:
82097a140dSpatrick case DW_MACRO_define_strx:
83097a140dSpatrick case DW_MACRO_undef_strx:
8409467b48Spatrick OS << " - lineno: " << E.Line;
8509467b48Spatrick OS << " macro: " << E.MacroStr;
8609467b48Spatrick break;
87097a140dSpatrick case DW_MACRO_start_file:
8809467b48Spatrick OS << " - lineno: " << E.Line;
8909467b48Spatrick OS << " filenum: " << E.File;
9009467b48Spatrick break;
91097a140dSpatrick case DW_MACRO_import:
92097a140dSpatrick OS << format(" - import offset: 0x%0*" PRIx64,
93097a140dSpatrick 2 * Macros.Header.getOffsetByteSize(), E.ImportOffset);
94097a140dSpatrick break;
95097a140dSpatrick case DW_MACRO_end_file:
9609467b48Spatrick break;
9709467b48Spatrick case DW_MACINFO_vendor_ext:
9809467b48Spatrick OS << " - constant: " << E.ExtConstant;
9909467b48Spatrick OS << " string: " << E.ExtStr;
10009467b48Spatrick break;
10109467b48Spatrick }
10209467b48Spatrick OS << "\n";
10309467b48Spatrick }
10409467b48Spatrick }
10509467b48Spatrick }
10609467b48Spatrick
parseImpl(std::optional<DWARFUnitVector::compile_unit_range> Units,std::optional<DataExtractor> StringExtractor,DWARFDataExtractor Data,bool IsMacro)107097a140dSpatrick Error DWARFDebugMacro::parseImpl(
108*d415bd75Srobert std::optional<DWARFUnitVector::compile_unit_range> Units,
109*d415bd75Srobert std::optional<DataExtractor> StringExtractor, DWARFDataExtractor Data,
110097a140dSpatrick bool IsMacro) {
11109467b48Spatrick uint64_t Offset = 0;
11209467b48Spatrick MacroList *M = nullptr;
113097a140dSpatrick using MacroToUnitsMap = DenseMap<uint64_t, DWARFUnit *>;
114097a140dSpatrick MacroToUnitsMap MacroToUnits;
115097a140dSpatrick if (IsMacro && Data.isValidOffset(Offset)) {
116097a140dSpatrick // Keep a mapping from Macro contribution to CUs, this will
117097a140dSpatrick // be needed while retrieving macro from DW_MACRO_define_strx form.
118*d415bd75Srobert for (const auto &U : *Units)
119097a140dSpatrick if (auto CUDIE = U->getUnitDIE())
120097a140dSpatrick // Skip units which does not contibutes to macro section.
121097a140dSpatrick if (auto MacroOffset = toSectionOffset(CUDIE.find(DW_AT_macros)))
122097a140dSpatrick MacroToUnits.try_emplace(*MacroOffset, U.get());
123097a140dSpatrick }
124097a140dSpatrick while (Data.isValidOffset(Offset)) {
12509467b48Spatrick if (!M) {
12609467b48Spatrick MacroLists.emplace_back();
12709467b48Spatrick M = &MacroLists.back();
128097a140dSpatrick M->Offset = Offset;
12973471bf0Spatrick M->IsDebugMacro = IsMacro;
130097a140dSpatrick if (IsMacro) {
131097a140dSpatrick auto Err = M->Header.parseMacroHeader(Data, &Offset);
132097a140dSpatrick if (Err)
133097a140dSpatrick return Err;
134097a140dSpatrick }
13509467b48Spatrick }
13609467b48Spatrick // A macro list entry consists of:
137097a140dSpatrick M->Macros.emplace_back();
138097a140dSpatrick Entry &E = M->Macros.back();
13909467b48Spatrick // 1. Macinfo type
140097a140dSpatrick E.Type = Data.getULEB128(&Offset);
14109467b48Spatrick
14209467b48Spatrick if (E.Type == 0) {
143097a140dSpatrick // Reached end of a ".debug_macinfo/debug_macro" section contribution.
144097a140dSpatrick M = nullptr;
14509467b48Spatrick continue;
14609467b48Spatrick }
14709467b48Spatrick
14809467b48Spatrick switch (E.Type) {
14909467b48Spatrick default:
15009467b48Spatrick // Got a corrupted ".debug_macinfo" section (invalid macinfo type).
15109467b48Spatrick // Push the corrupted entry to the list and halt parsing.
15209467b48Spatrick E.Type = DW_MACINFO_invalid;
153097a140dSpatrick return Error::success();
154097a140dSpatrick // debug_macro and debug_macinfo share some common encodings.
155097a140dSpatrick // DW_MACRO_define == DW_MACINFO_define
156097a140dSpatrick // DW_MACRO_undef == DW_MACINFO_undef
157097a140dSpatrick // DW_MACRO_start_file == DW_MACINFO_start_file
158097a140dSpatrick // DW_MACRO_end_file == DW_MACINFO_end_file
159097a140dSpatrick // For readibility/uniformity we are using DW_MACRO_*.
160097a140dSpatrick case DW_MACRO_define:
161097a140dSpatrick case DW_MACRO_undef:
16209467b48Spatrick // 2. Source line
163097a140dSpatrick E.Line = Data.getULEB128(&Offset);
16409467b48Spatrick // 3. Macro string
165097a140dSpatrick E.MacroStr = Data.getCStr(&Offset);
16609467b48Spatrick break;
167097a140dSpatrick case DW_MACRO_define_strp:
168097a140dSpatrick case DW_MACRO_undef_strp: {
169097a140dSpatrick if (!IsMacro) {
170097a140dSpatrick // DW_MACRO_define_strp is a new form introduced in DWARFv5, it is
171097a140dSpatrick // not supported in debug_macinfo[.dwo] sections. Assume it as an
172097a140dSpatrick // invalid entry, push it and halt parsing.
173097a140dSpatrick E.Type = DW_MACINFO_invalid;
174097a140dSpatrick return Error::success();
175097a140dSpatrick }
176097a140dSpatrick uint64_t StrOffset = 0;
17709467b48Spatrick // 2. Source line
178097a140dSpatrick E.Line = Data.getULEB128(&Offset);
179097a140dSpatrick // 3. Macro string
180097a140dSpatrick StrOffset =
181097a140dSpatrick Data.getRelocatedValue(M->Header.getOffsetByteSize(), &Offset);
182097a140dSpatrick assert(StringExtractor && "String Extractor not found");
183097a140dSpatrick E.MacroStr = StringExtractor->getCStr(&StrOffset);
18409467b48Spatrick break;
185097a140dSpatrick }
186097a140dSpatrick case DW_MACRO_define_strx:
187097a140dSpatrick case DW_MACRO_undef_strx: {
188097a140dSpatrick if (!IsMacro) {
189097a140dSpatrick // DW_MACRO_define_strx is a new form introduced in DWARFv5, it is
190097a140dSpatrick // not supported in debug_macinfo[.dwo] sections. Assume it as an
191097a140dSpatrick // invalid entry, push it and halt parsing.
192097a140dSpatrick E.Type = DW_MACINFO_invalid;
193097a140dSpatrick return Error::success();
194097a140dSpatrick }
195097a140dSpatrick E.Line = Data.getULEB128(&Offset);
196097a140dSpatrick auto MacroContributionOffset = MacroToUnits.find(M->Offset);
197097a140dSpatrick if (MacroContributionOffset == MacroToUnits.end())
198097a140dSpatrick return createStringError(errc::invalid_argument,
199097a140dSpatrick "Macro contribution of the unit not found");
200*d415bd75Srobert Expected<uint64_t> StrOffset =
201097a140dSpatrick MacroContributionOffset->second->getStringOffsetSectionItem(
202097a140dSpatrick Data.getULEB128(&Offset));
203097a140dSpatrick if (!StrOffset)
204*d415bd75Srobert return StrOffset.takeError();
205097a140dSpatrick E.MacroStr =
206097a140dSpatrick MacroContributionOffset->second->getStringExtractor().getCStr(
207097a140dSpatrick &*StrOffset);
208097a140dSpatrick break;
209097a140dSpatrick }
210097a140dSpatrick case DW_MACRO_start_file:
211097a140dSpatrick // 2. Source line
212097a140dSpatrick E.Line = Data.getULEB128(&Offset);
213097a140dSpatrick // 3. Source file id
214097a140dSpatrick E.File = Data.getULEB128(&Offset);
215097a140dSpatrick break;
216097a140dSpatrick case DW_MACRO_end_file:
217097a140dSpatrick break;
218097a140dSpatrick case DW_MACRO_import:
219097a140dSpatrick E.ImportOffset =
220097a140dSpatrick Data.getRelocatedValue(M->Header.getOffsetByteSize(), &Offset);
22109467b48Spatrick break;
22209467b48Spatrick case DW_MACINFO_vendor_ext:
22309467b48Spatrick // 2. Vendor extension constant
224097a140dSpatrick E.ExtConstant = Data.getULEB128(&Offset);
22509467b48Spatrick // 3. Vendor extension string
226097a140dSpatrick E.ExtStr = Data.getCStr(&Offset);
22709467b48Spatrick break;
22809467b48Spatrick }
22909467b48Spatrick }
230097a140dSpatrick return Error::success();
231097a140dSpatrick }
232097a140dSpatrick
parseMacroHeader(DWARFDataExtractor Data,uint64_t * Offset)233097a140dSpatrick Error DWARFDebugMacro::MacroHeader::parseMacroHeader(DWARFDataExtractor Data,
234097a140dSpatrick uint64_t *Offset) {
235097a140dSpatrick Version = Data.getU16(Offset);
236097a140dSpatrick uint8_t FlagData = Data.getU8(Offset);
237097a140dSpatrick
238097a140dSpatrick // FIXME: Add support for parsing opcode_operands_table
239097a140dSpatrick if (FlagData & MACRO_OPCODE_OPERANDS_TABLE)
240097a140dSpatrick return createStringError(errc::not_supported,
241097a140dSpatrick "opcode_operands_table is not supported");
242097a140dSpatrick Flags = FlagData;
243097a140dSpatrick if (Flags & MACRO_DEBUG_LINE_OFFSET)
244097a140dSpatrick DebugLineOffset = Data.getUnsigned(Offset, getOffsetByteSize());
245097a140dSpatrick return Error::success();
24609467b48Spatrick }
247