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