1 //===- DWARFYAML.cpp - DWARF YAMLIO implementation ------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines classes for handling the YAML representation of DWARF Debug
10 // Info.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/ObjectYAML/DWARFYAML.h"
15 #include "llvm/BinaryFormat/Dwarf.h"
16 
17 namespace llvm {
18 
19 bool DWARFYAML::Data::isEmpty() const {
20   return DebugStrings.empty() && AbbrevDecls.empty() && ARanges.empty() &&
21          DebugRanges.empty() && !PubNames && !PubTypes && !GNUPubNames &&
22          !GNUPubTypes && CompileUnits.empty() && DebugLines.empty();
23 }
24 
25 SetVector<StringRef> DWARFYAML::Data::getUsedSectionNames() const {
26   SetVector<StringRef> SecNames;
27   if (!DebugStrings.empty())
28     SecNames.insert("debug_str");
29   if (!ARanges.empty())
30     SecNames.insert("debug_aranges");
31   if (!DebugRanges.empty())
32     SecNames.insert("debug_ranges");
33   if (!DebugLines.empty())
34     SecNames.insert("debug_line");
35   if (!DebugAddr.empty())
36     SecNames.insert("debug_addr");
37   if (!AbbrevDecls.empty())
38     SecNames.insert("debug_abbrev");
39   if (!CompileUnits.empty())
40     SecNames.insert("debug_info");
41   if (PubNames)
42     SecNames.insert("debug_pubnames");
43   if (PubTypes)
44     SecNames.insert("debug_pubtypes");
45   return SecNames;
46 }
47 
48 namespace yaml {
49 
50 void MappingTraits<DWARFYAML::Data>::mapping(IO &IO, DWARFYAML::Data &DWARF) {
51   IO.mapOptional("debug_str", DWARF.DebugStrings);
52   IO.mapOptional("debug_abbrev", DWARF.AbbrevDecls);
53   if (!DWARF.ARanges.empty() || !IO.outputting())
54     IO.mapOptional("debug_aranges", DWARF.ARanges);
55   if (!DWARF.DebugRanges.empty() || !IO.outputting())
56     IO.mapOptional("debug_ranges", DWARF.DebugRanges);
57   IO.mapOptional("debug_pubnames", DWARF.PubNames);
58   IO.mapOptional("debug_pubtypes", DWARF.PubTypes);
59   IO.mapOptional("debug_gnu_pubnames", DWARF.GNUPubNames);
60   IO.mapOptional("debug_gnu_pubtypes", DWARF.GNUPubTypes);
61   IO.mapOptional("debug_info", DWARF.CompileUnits);
62   IO.mapOptional("debug_line", DWARF.DebugLines);
63   IO.mapOptional("debug_addr", DWARF.DebugAddr);
64 }
65 
66 void MappingTraits<DWARFYAML::Abbrev>::mapping(IO &IO,
67                                                DWARFYAML::Abbrev &Abbrev) {
68   IO.mapOptional("Code", Abbrev.Code);
69   IO.mapRequired("Tag", Abbrev.Tag);
70   IO.mapRequired("Children", Abbrev.Children);
71   IO.mapRequired("Attributes", Abbrev.Attributes);
72 }
73 
74 void MappingTraits<DWARFYAML::AttributeAbbrev>::mapping(
75     IO &IO, DWARFYAML::AttributeAbbrev &AttAbbrev) {
76   IO.mapRequired("Attribute", AttAbbrev.Attribute);
77   IO.mapRequired("Form", AttAbbrev.Form);
78   if(AttAbbrev.Form == dwarf::DW_FORM_implicit_const)
79     IO.mapRequired("Value", AttAbbrev.Value);
80 }
81 
82 void MappingTraits<DWARFYAML::ARangeDescriptor>::mapping(
83     IO &IO, DWARFYAML::ARangeDescriptor &Descriptor) {
84   IO.mapRequired("Address", Descriptor.Address);
85   IO.mapRequired("Length", Descriptor.Length);
86 }
87 
88 void MappingTraits<DWARFYAML::ARange>::mapping(IO &IO,
89                                                DWARFYAML::ARange &ARange) {
90   IO.mapOptional("Format", ARange.Format, dwarf::DWARF32);
91   IO.mapRequired("Length", ARange.Length);
92   IO.mapRequired("Version", ARange.Version);
93   IO.mapRequired("CuOffset", ARange.CuOffset);
94   IO.mapRequired("AddrSize", ARange.AddrSize);
95   IO.mapRequired("SegSize", ARange.SegSize);
96   IO.mapRequired("Descriptors", ARange.Descriptors);
97 }
98 
99 void MappingTraits<DWARFYAML::RangeEntry>::mapping(
100     IO &IO, DWARFYAML::RangeEntry &Descriptor) {
101   IO.mapRequired("LowOffset", Descriptor.LowOffset);
102   IO.mapRequired("HighOffset", Descriptor.HighOffset);
103 }
104 
105 void MappingTraits<DWARFYAML::Ranges>::mapping(IO &IO,
106                                                DWARFYAML::Ranges &DebugRanges) {
107   IO.mapOptional("Offset", DebugRanges.Offset);
108   IO.mapOptional("AddrSize", DebugRanges.AddrSize);
109   IO.mapRequired("Entries", DebugRanges.Entries);
110 }
111 
112 void MappingTraits<DWARFYAML::PubEntry>::mapping(IO &IO,
113                                                  DWARFYAML::PubEntry &Entry) {
114   IO.mapRequired("DieOffset", Entry.DieOffset);
115   if (reinterpret_cast<DWARFYAML::PubSection *>(IO.getContext())->IsGNUStyle)
116     IO.mapRequired("Descriptor", Entry.Descriptor);
117   IO.mapRequired("Name", Entry.Name);
118 }
119 
120 void MappingTraits<DWARFYAML::PubSection>::mapping(
121     IO &IO, DWARFYAML::PubSection &Section) {
122   auto OldContext = IO.getContext();
123   IO.setContext(&Section);
124 
125   IO.mapRequired("Length", Section.Length);
126   IO.mapRequired("Version", Section.Version);
127   IO.mapRequired("UnitOffset", Section.UnitOffset);
128   IO.mapRequired("UnitSize", Section.UnitSize);
129   IO.mapRequired("Entries", Section.Entries);
130 
131   IO.setContext(OldContext);
132 }
133 
134 void MappingTraits<DWARFYAML::Unit>::mapping(IO &IO, DWARFYAML::Unit &Unit) {
135   IO.mapRequired("Length", Unit.Length);
136   IO.mapRequired("Version", Unit.Version);
137   if (Unit.Version >= 5)
138     IO.mapRequired("UnitType", Unit.Type);
139   IO.mapRequired("AbbrOffset", Unit.AbbrOffset);
140   IO.mapRequired("AddrSize", Unit.AddrSize);
141   IO.mapOptional("Entries", Unit.Entries);
142 }
143 
144 void MappingTraits<DWARFYAML::Entry>::mapping(IO &IO, DWARFYAML::Entry &Entry) {
145   IO.mapRequired("AbbrCode", Entry.AbbrCode);
146   IO.mapRequired("Values", Entry.Values);
147 }
148 
149 void MappingTraits<DWARFYAML::FormValue>::mapping(
150     IO &IO, DWARFYAML::FormValue &FormValue) {
151   IO.mapOptional("Value", FormValue.Value);
152   if (!FormValue.CStr.empty() || !IO.outputting())
153     IO.mapOptional("CStr", FormValue.CStr);
154   if (!FormValue.BlockData.empty() || !IO.outputting())
155     IO.mapOptional("BlockData", FormValue.BlockData);
156 }
157 
158 void MappingTraits<DWARFYAML::File>::mapping(IO &IO, DWARFYAML::File &File) {
159   IO.mapRequired("Name", File.Name);
160   IO.mapRequired("DirIdx", File.DirIdx);
161   IO.mapRequired("ModTime", File.ModTime);
162   IO.mapRequired("Length", File.Length);
163 }
164 
165 void MappingTraits<DWARFYAML::LineTableOpcode>::mapping(
166     IO &IO, DWARFYAML::LineTableOpcode &LineTableOpcode) {
167   IO.mapRequired("Opcode", LineTableOpcode.Opcode);
168   if (LineTableOpcode.Opcode == dwarf::DW_LNS_extended_op) {
169     IO.mapRequired("ExtLen", LineTableOpcode.ExtLen);
170     IO.mapRequired("SubOpcode", LineTableOpcode.SubOpcode);
171   }
172 
173   if (!LineTableOpcode.UnknownOpcodeData.empty() || !IO.outputting())
174     IO.mapOptional("UnknownOpcodeData", LineTableOpcode.UnknownOpcodeData);
175   if (!LineTableOpcode.UnknownOpcodeData.empty() || !IO.outputting())
176     IO.mapOptional("StandardOpcodeData", LineTableOpcode.StandardOpcodeData);
177   if (!LineTableOpcode.FileEntry.Name.empty() || !IO.outputting())
178     IO.mapOptional("FileEntry", LineTableOpcode.FileEntry);
179   if (LineTableOpcode.Opcode == dwarf::DW_LNS_advance_line || !IO.outputting())
180     IO.mapOptional("SData", LineTableOpcode.SData);
181   IO.mapOptional("Data", LineTableOpcode.Data);
182 }
183 
184 void MappingTraits<DWARFYAML::LineTable>::mapping(
185     IO &IO, DWARFYAML::LineTable &LineTable) {
186   IO.mapOptional("Format", LineTable.Format, dwarf::DWARF32);
187   IO.mapRequired("Length", LineTable.Length);
188   IO.mapRequired("Version", LineTable.Version);
189   IO.mapRequired("PrologueLength", LineTable.PrologueLength);
190   IO.mapRequired("MinInstLength", LineTable.MinInstLength);
191   if(LineTable.Version >= 4)
192     IO.mapRequired("MaxOpsPerInst", LineTable.MaxOpsPerInst);
193   IO.mapRequired("DefaultIsStmt", LineTable.DefaultIsStmt);
194   IO.mapRequired("LineBase", LineTable.LineBase);
195   IO.mapRequired("LineRange", LineTable.LineRange);
196   IO.mapRequired("OpcodeBase", LineTable.OpcodeBase);
197   IO.mapRequired("StandardOpcodeLengths", LineTable.StandardOpcodeLengths);
198   IO.mapRequired("IncludeDirs", LineTable.IncludeDirs);
199   IO.mapRequired("Files", LineTable.Files);
200   IO.mapRequired("Opcodes", LineTable.Opcodes);
201 }
202 
203 void MappingTraits<DWARFYAML::SegAddrPair>::mapping(
204     IO &IO, DWARFYAML::SegAddrPair &SegAddrPair) {
205   IO.mapOptional("Segment", SegAddrPair.Segment, 0);
206   IO.mapOptional("Address", SegAddrPair.Address, 0);
207 }
208 
209 void MappingTraits<DWARFYAML::AddrTableEntry>::mapping(
210     IO &IO, DWARFYAML::AddrTableEntry &AddrTable) {
211   IO.mapOptional("Format", AddrTable.Format, dwarf::DWARF32);
212   IO.mapOptional("Length", AddrTable.Length);
213   IO.mapRequired("Version", AddrTable.Version);
214   IO.mapOptional("AddressSize", AddrTable.AddrSize);
215   IO.mapOptional("SegmentSelectorSize", AddrTable.SegSelectorSize, 0);
216   IO.mapOptional("Entries", AddrTable.SegAddrPairs);
217 }
218 
219 void MappingTraits<DWARFYAML::InitialLength>::mapping(
220     IO &IO, DWARFYAML::InitialLength &InitialLength) {
221   IO.mapRequired("TotalLength", InitialLength.TotalLength);
222   if (InitialLength.isDWARF64())
223     IO.mapRequired("TotalLength64", InitialLength.TotalLength64);
224 }
225 
226 } // end namespace yaml
227 
228 } // end namespace llvm
229