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   return SecNames;
42 }
43 
44 namespace yaml {
45 
46 void MappingTraits<DWARFYAML::Data>::mapping(IO &IO, DWARFYAML::Data &DWARF) {
47   auto oldContext = IO.getContext();
48   IO.setContext(&DWARF);
49   IO.mapOptional("debug_str", DWARF.DebugStrings);
50   IO.mapOptional("debug_abbrev", DWARF.AbbrevDecls);
51   if (!DWARF.ARanges.empty() || !IO.outputting())
52     IO.mapOptional("debug_aranges", DWARF.ARanges);
53   if (!DWARF.DebugRanges.empty() || !IO.outputting())
54     IO.mapOptional("debug_ranges", DWARF.DebugRanges);
55   IO.mapOptional("debug_pubnames", DWARF.PubNames);
56   IO.mapOptional("debug_pubtypes", DWARF.PubTypes);
57   IO.mapOptional("debug_gnu_pubnames", DWARF.GNUPubNames);
58   IO.mapOptional("debug_gnu_pubtypes", DWARF.GNUPubTypes);
59   IO.mapOptional("debug_info", DWARF.CompileUnits);
60   IO.mapOptional("debug_line", DWARF.DebugLines);
61   IO.mapOptional("debug_addr", DWARF.DebugAddr);
62   IO.setContext(&oldContext);
63 }
64 
65 void MappingTraits<DWARFYAML::Abbrev>::mapping(IO &IO,
66                                                DWARFYAML::Abbrev &Abbrev) {
67   IO.mapOptional("Code", Abbrev.Code);
68   IO.mapRequired("Tag", Abbrev.Tag);
69   IO.mapRequired("Children", Abbrev.Children);
70   IO.mapRequired("Attributes", Abbrev.Attributes);
71 }
72 
73 void MappingTraits<DWARFYAML::AttributeAbbrev>::mapping(
74     IO &IO, DWARFYAML::AttributeAbbrev &AttAbbrev) {
75   IO.mapRequired("Attribute", AttAbbrev.Attribute);
76   IO.mapRequired("Form", AttAbbrev.Form);
77   if(AttAbbrev.Form == dwarf::DW_FORM_implicit_const)
78     IO.mapRequired("Value", AttAbbrev.Value);
79 }
80 
81 void MappingTraits<DWARFYAML::ARangeDescriptor>::mapping(
82     IO &IO, DWARFYAML::ARangeDescriptor &Descriptor) {
83   IO.mapRequired("Address", Descriptor.Address);
84   IO.mapRequired("Length", Descriptor.Length);
85 }
86 
87 void MappingTraits<DWARFYAML::ARange>::mapping(IO &IO,
88                                                DWARFYAML::ARange &ARange) {
89   IO.mapOptional("Format", ARange.Format, dwarf::DWARF32);
90   IO.mapRequired("Length", ARange.Length);
91   IO.mapRequired("Version", ARange.Version);
92   IO.mapRequired("CuOffset", ARange.CuOffset);
93   IO.mapRequired("AddrSize", ARange.AddrSize);
94   IO.mapRequired("SegSize", ARange.SegSize);
95   IO.mapRequired("Descriptors", ARange.Descriptors);
96 }
97 
98 void MappingTraits<DWARFYAML::RangeEntry>::mapping(
99     IO &IO, DWARFYAML::RangeEntry &Descriptor) {
100   IO.mapRequired("LowOffset", Descriptor.LowOffset);
101   IO.mapRequired("HighOffset", Descriptor.HighOffset);
102 }
103 
104 void MappingTraits<DWARFYAML::Ranges>::mapping(IO &IO,
105                                                DWARFYAML::Ranges &DebugRanges) {
106   IO.mapOptional("Offset", DebugRanges.Offset);
107   IO.mapOptional("AddrSize", DebugRanges.AddrSize);
108   IO.mapRequired("Entries", DebugRanges.Entries);
109 }
110 
111 void MappingTraits<DWARFYAML::PubEntry>::mapping(IO &IO,
112                                                  DWARFYAML::PubEntry &Entry) {
113   IO.mapRequired("DieOffset", Entry.DieOffset);
114   if (reinterpret_cast<DWARFYAML::PubSection *>(IO.getContext())->IsGNUStyle)
115     IO.mapRequired("Descriptor", Entry.Descriptor);
116   IO.mapRequired("Name", Entry.Name);
117 }
118 
119 void MappingTraits<DWARFYAML::PubSection>::mapping(
120     IO &IO, DWARFYAML::PubSection &Section) {
121   auto OldContext = IO.getContext();
122   IO.setContext(&Section);
123 
124   IO.mapRequired("Length", Section.Length);
125   IO.mapRequired("Version", Section.Version);
126   IO.mapRequired("UnitOffset", Section.UnitOffset);
127   IO.mapRequired("UnitSize", Section.UnitSize);
128   IO.mapRequired("Entries", Section.Entries);
129 
130   IO.setContext(OldContext);
131 }
132 
133 void MappingTraits<DWARFYAML::Unit>::mapping(IO &IO, DWARFYAML::Unit &Unit) {
134   IO.mapRequired("Length", Unit.Length);
135   IO.mapRequired("Version", Unit.Version);
136   if (Unit.Version >= 5)
137     IO.mapRequired("UnitType", Unit.Type);
138   IO.mapRequired("AbbrOffset", Unit.AbbrOffset);
139   IO.mapRequired("AddrSize", Unit.AddrSize);
140   IO.mapOptional("Entries", Unit.Entries);
141 }
142 
143 void MappingTraits<DWARFYAML::Entry>::mapping(IO &IO, DWARFYAML::Entry &Entry) {
144   IO.mapRequired("AbbrCode", Entry.AbbrCode);
145   IO.mapRequired("Values", Entry.Values);
146 }
147 
148 void MappingTraits<DWARFYAML::FormValue>::mapping(
149     IO &IO, DWARFYAML::FormValue &FormValue) {
150   IO.mapOptional("Value", FormValue.Value);
151   if (!FormValue.CStr.empty() || !IO.outputting())
152     IO.mapOptional("CStr", FormValue.CStr);
153   if (!FormValue.BlockData.empty() || !IO.outputting())
154     IO.mapOptional("BlockData", FormValue.BlockData);
155 }
156 
157 void MappingTraits<DWARFYAML::File>::mapping(IO &IO, DWARFYAML::File &File) {
158   IO.mapRequired("Name", File.Name);
159   IO.mapRequired("DirIdx", File.DirIdx);
160   IO.mapRequired("ModTime", File.ModTime);
161   IO.mapRequired("Length", File.Length);
162 }
163 
164 void MappingTraits<DWARFYAML::LineTableOpcode>::mapping(
165     IO &IO, DWARFYAML::LineTableOpcode &LineTableOpcode) {
166   IO.mapRequired("Opcode", LineTableOpcode.Opcode);
167   if (LineTableOpcode.Opcode == dwarf::DW_LNS_extended_op) {
168     IO.mapRequired("ExtLen", LineTableOpcode.ExtLen);
169     IO.mapRequired("SubOpcode", LineTableOpcode.SubOpcode);
170   }
171 
172   if (!LineTableOpcode.UnknownOpcodeData.empty() || !IO.outputting())
173     IO.mapOptional("UnknownOpcodeData", LineTableOpcode.UnknownOpcodeData);
174   if (!LineTableOpcode.UnknownOpcodeData.empty() || !IO.outputting())
175     IO.mapOptional("StandardOpcodeData", LineTableOpcode.StandardOpcodeData);
176   if (!LineTableOpcode.FileEntry.Name.empty() || !IO.outputting())
177     IO.mapOptional("FileEntry", LineTableOpcode.FileEntry);
178   if (LineTableOpcode.Opcode == dwarf::DW_LNS_advance_line || !IO.outputting())
179     IO.mapOptional("SData", LineTableOpcode.SData);
180   IO.mapOptional("Data", LineTableOpcode.Data);
181 }
182 
183 void MappingTraits<DWARFYAML::LineTable>::mapping(
184     IO &IO, DWARFYAML::LineTable &LineTable) {
185   IO.mapOptional("Format", LineTable.Format, dwarf::DWARF32);
186   IO.mapRequired("Length", LineTable.Length);
187   IO.mapRequired("Version", LineTable.Version);
188   IO.mapRequired("PrologueLength", LineTable.PrologueLength);
189   IO.mapRequired("MinInstLength", LineTable.MinInstLength);
190   if(LineTable.Version >= 4)
191     IO.mapRequired("MaxOpsPerInst", LineTable.MaxOpsPerInst);
192   IO.mapRequired("DefaultIsStmt", LineTable.DefaultIsStmt);
193   IO.mapRequired("LineBase", LineTable.LineBase);
194   IO.mapRequired("LineRange", LineTable.LineRange);
195   IO.mapRequired("OpcodeBase", LineTable.OpcodeBase);
196   IO.mapRequired("StandardOpcodeLengths", LineTable.StandardOpcodeLengths);
197   IO.mapRequired("IncludeDirs", LineTable.IncludeDirs);
198   IO.mapRequired("Files", LineTable.Files);
199   IO.mapRequired("Opcodes", LineTable.Opcodes);
200 }
201 
202 void MappingTraits<DWARFYAML::SegAddrPair>::mapping(
203     IO &IO, DWARFYAML::SegAddrPair &SegAddrPair) {
204   IO.mapOptional("Segment", SegAddrPair.Segment, 0);
205   IO.mapOptional("Address", SegAddrPair.Address, 0);
206 }
207 
208 void MappingTraits<DWARFYAML::AddrTableEntry>::mapping(
209     IO &IO, DWARFYAML::AddrTableEntry &AddrTable) {
210   IO.mapOptional("Format", AddrTable.Format, dwarf::DWARF32);
211   IO.mapOptional("Length", AddrTable.Length);
212   IO.mapRequired("Version", AddrTable.Version);
213   IO.mapOptional("AddressSize", AddrTable.AddrSize);
214   IO.mapOptional("SegmentSelectorSize", AddrTable.SegSelectorSize, 0);
215   IO.mapOptional("Entries", AddrTable.SegAddrPairs);
216 }
217 
218 void MappingTraits<DWARFYAML::InitialLength>::mapping(
219     IO &IO, DWARFYAML::InitialLength &InitialLength) {
220   IO.mapRequired("TotalLength", InitialLength.TotalLength);
221   if (InitialLength.isDWARF64())
222     IO.mapRequired("TotalLength64", InitialLength.TotalLength64);
223 }
224 
225 } // end namespace yaml
226 
227 } // end namespace llvm
228