1 //===------ utils/obj2yaml.cpp - obj2yaml conversion tool -------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "obj2yaml.h"
11 #include "llvm/Object/COFF.h"
12 #include "llvm/ObjectYAML/COFFYAML.h"
13 #include "llvm/Support/ErrorHandling.h"
14 #include "llvm/Support/YAMLTraits.h"
15 
16 using namespace llvm;
17 
18 namespace {
19 
20 class COFFDumper {
21   const object::COFFObjectFile &Obj;
22   COFFYAML::Object YAMLObj;
23   template <typename T>
24   void dumpOptionalHeader(T OptionalHeader);
25   void dumpHeader();
26   void dumpSections(unsigned numSections);
27   void dumpSymbols(unsigned numSymbols);
28 
29 public:
30   COFFDumper(const object::COFFObjectFile &Obj);
31   COFFYAML::Object &getYAMLObj();
32 };
33 
34 }
35 
36 COFFDumper::COFFDumper(const object::COFFObjectFile &Obj) : Obj(Obj) {
37   const object::pe32_header *PE32Header = nullptr;
38   Obj.getPE32Header(PE32Header);
39   if (PE32Header) {
40     dumpOptionalHeader(PE32Header);
41   } else {
42     const object::pe32plus_header *PE32PlusHeader = nullptr;
43     Obj.getPE32PlusHeader(PE32PlusHeader);
44     if (PE32PlusHeader) {
45       dumpOptionalHeader(PE32PlusHeader);
46     }
47   }
48   dumpHeader();
49   dumpSections(Obj.getNumberOfSections());
50   dumpSymbols(Obj.getNumberOfSymbols());
51 }
52 
53 template <typename T> void COFFDumper::dumpOptionalHeader(T OptionalHeader) {
54   YAMLObj.OptionalHeader = COFFYAML::PEHeader();
55   YAMLObj.OptionalHeader->Header.AddressOfEntryPoint =
56       OptionalHeader->AddressOfEntryPoint;
57   YAMLObj.OptionalHeader->Header.AddressOfEntryPoint =
58       OptionalHeader->AddressOfEntryPoint;
59   YAMLObj.OptionalHeader->Header.ImageBase = OptionalHeader->ImageBase;
60   YAMLObj.OptionalHeader->Header.SectionAlignment =
61       OptionalHeader->SectionAlignment;
62   YAMLObj.OptionalHeader->Header.FileAlignment = OptionalHeader->FileAlignment;
63   YAMLObj.OptionalHeader->Header.MajorOperatingSystemVersion =
64       OptionalHeader->MajorOperatingSystemVersion;
65   YAMLObj.OptionalHeader->Header.MinorOperatingSystemVersion =
66       OptionalHeader->MinorOperatingSystemVersion;
67   YAMLObj.OptionalHeader->Header.MajorImageVersion =
68       OptionalHeader->MajorImageVersion;
69   YAMLObj.OptionalHeader->Header.MinorImageVersion =
70       OptionalHeader->MinorImageVersion;
71   YAMLObj.OptionalHeader->Header.MajorSubsystemVersion =
72       OptionalHeader->MajorSubsystemVersion;
73   YAMLObj.OptionalHeader->Header.MinorSubsystemVersion =
74       OptionalHeader->MinorSubsystemVersion;
75   YAMLObj.OptionalHeader->Header.Subsystem = OptionalHeader->Subsystem;
76   YAMLObj.OptionalHeader->Header.DLLCharacteristics =
77       OptionalHeader->DLLCharacteristics;
78   YAMLObj.OptionalHeader->Header.SizeOfStackReserve =
79       OptionalHeader->SizeOfStackReserve;
80   YAMLObj.OptionalHeader->Header.SizeOfStackCommit =
81       OptionalHeader->SizeOfStackCommit;
82   YAMLObj.OptionalHeader->Header.SizeOfHeapReserve =
83       OptionalHeader->SizeOfHeapReserve;
84   YAMLObj.OptionalHeader->Header.SizeOfHeapCommit =
85       OptionalHeader->SizeOfHeapCommit;
86   unsigned I = 0;
87   for (auto &DestDD : YAMLObj.OptionalHeader->DataDirectories) {
88     const object::data_directory *DD;
89     if (Obj.getDataDirectory(I++, DD))
90       continue;
91     DestDD = COFF::DataDirectory();
92     DestDD->RelativeVirtualAddress = DD->RelativeVirtualAddress;
93     DestDD->Size = DD->Size;
94   }
95 }
96 
97 void COFFDumper::dumpHeader() {
98   YAMLObj.Header.Machine = Obj.getMachine();
99   YAMLObj.Header.Characteristics = Obj.getCharacteristics();
100 }
101 
102 void COFFDumper::dumpSections(unsigned NumSections) {
103   std::vector<COFFYAML::Section> &YAMLSections = YAMLObj.Sections;
104   for (const auto &ObjSection : Obj.sections()) {
105     const object::coff_section *COFFSection = Obj.getCOFFSection(ObjSection);
106     COFFYAML::Section NewYAMLSection;
107     ObjSection.getName(NewYAMLSection.Name);
108     NewYAMLSection.Header.Characteristics = COFFSection->Characteristics;
109     NewYAMLSection.Header.VirtualAddress = ObjSection.getAddress();
110     NewYAMLSection.Header.VirtualSize = COFFSection->VirtualSize;
111     NewYAMLSection.Alignment = ObjSection.getAlignment();
112     assert(NewYAMLSection.Alignment <= 8192);
113 
114     ArrayRef<uint8_t> sectionData;
115     if (!ObjSection.isBSS())
116       Obj.getSectionContents(COFFSection, sectionData);
117     NewYAMLSection.SectionData = yaml::BinaryRef(sectionData);
118 
119     std::vector<COFFYAML::Relocation> Relocations;
120     for (const auto &Reloc : ObjSection.relocations()) {
121       const object::coff_relocation *reloc = Obj.getCOFFRelocation(Reloc);
122       COFFYAML::Relocation Rel;
123       object::symbol_iterator Sym = Reloc.getSymbol();
124       ErrorOr<StringRef> SymbolNameOrErr = Sym->getName();
125       if (std::error_code EC = SymbolNameOrErr.getError())
126         report_fatal_error(EC.message());
127       Rel.SymbolName = *SymbolNameOrErr;
128       Rel.VirtualAddress = reloc->VirtualAddress;
129       Rel.Type = reloc->Type;
130       Relocations.push_back(Rel);
131     }
132     NewYAMLSection.Relocations = Relocations;
133     YAMLSections.push_back(NewYAMLSection);
134   }
135 }
136 
137 static void
138 dumpFunctionDefinition(COFFYAML::Symbol *Sym,
139                        const object::coff_aux_function_definition *ObjFD) {
140   COFF::AuxiliaryFunctionDefinition YAMLFD;
141   YAMLFD.TagIndex = ObjFD->TagIndex;
142   YAMLFD.TotalSize = ObjFD->TotalSize;
143   YAMLFD.PointerToLinenumber = ObjFD->PointerToLinenumber;
144   YAMLFD.PointerToNextFunction = ObjFD->PointerToNextFunction;
145 
146   Sym->FunctionDefinition = YAMLFD;
147 }
148 
149 static void
150 dumpbfAndEfLineInfo(COFFYAML::Symbol *Sym,
151                     const object::coff_aux_bf_and_ef_symbol *ObjBES) {
152   COFF::AuxiliarybfAndefSymbol YAMLAAS;
153   YAMLAAS.Linenumber = ObjBES->Linenumber;
154   YAMLAAS.PointerToNextFunction = ObjBES->PointerToNextFunction;
155 
156   Sym->bfAndefSymbol = YAMLAAS;
157 }
158 
159 static void dumpWeakExternal(COFFYAML::Symbol *Sym,
160                              const object::coff_aux_weak_external *ObjWE) {
161   COFF::AuxiliaryWeakExternal YAMLWE;
162   YAMLWE.TagIndex = ObjWE->TagIndex;
163   YAMLWE.Characteristics = ObjWE->Characteristics;
164 
165   Sym->WeakExternal = YAMLWE;
166 }
167 
168 static void
169 dumpSectionDefinition(COFFYAML::Symbol *Sym,
170                       const object::coff_aux_section_definition *ObjSD,
171                       bool IsBigObj) {
172   COFF::AuxiliarySectionDefinition YAMLASD;
173   int32_t AuxNumber = ObjSD->getNumber(IsBigObj);
174   YAMLASD.Length = ObjSD->Length;
175   YAMLASD.NumberOfRelocations = ObjSD->NumberOfRelocations;
176   YAMLASD.NumberOfLinenumbers = ObjSD->NumberOfLinenumbers;
177   YAMLASD.CheckSum = ObjSD->CheckSum;
178   YAMLASD.Number = AuxNumber;
179   YAMLASD.Selection = ObjSD->Selection;
180 
181   Sym->SectionDefinition = YAMLASD;
182 }
183 
184 static void
185 dumpCLRTokenDefinition(COFFYAML::Symbol *Sym,
186                        const object::coff_aux_clr_token *ObjCLRToken) {
187   COFF::AuxiliaryCLRToken YAMLCLRToken;
188   YAMLCLRToken.AuxType = ObjCLRToken->AuxType;
189   YAMLCLRToken.SymbolTableIndex = ObjCLRToken->SymbolTableIndex;
190 
191   Sym->CLRToken = YAMLCLRToken;
192 }
193 
194 void COFFDumper::dumpSymbols(unsigned NumSymbols) {
195   std::vector<COFFYAML::Symbol> &Symbols = YAMLObj.Symbols;
196   for (const auto &S : Obj.symbols()) {
197     object::COFFSymbolRef Symbol = Obj.getCOFFSymbol(S);
198     COFFYAML::Symbol Sym;
199     Obj.getSymbolName(Symbol, Sym.Name);
200     Sym.SimpleType = COFF::SymbolBaseType(Symbol.getBaseType());
201     Sym.ComplexType = COFF::SymbolComplexType(Symbol.getComplexType());
202     Sym.Header.StorageClass = Symbol.getStorageClass();
203     Sym.Header.Value = Symbol.getValue();
204     Sym.Header.SectionNumber = Symbol.getSectionNumber();
205     Sym.Header.NumberOfAuxSymbols = Symbol.getNumberOfAuxSymbols();
206 
207     if (Symbol.getNumberOfAuxSymbols() > 0) {
208       ArrayRef<uint8_t> AuxData = Obj.getSymbolAuxData(Symbol);
209       if (Symbol.isFunctionDefinition()) {
210         // This symbol represents a function definition.
211         assert(Symbol.getNumberOfAuxSymbols() == 1 &&
212                "Expected a single aux symbol to describe this function!");
213 
214         const object::coff_aux_function_definition *ObjFD =
215             reinterpret_cast<const object::coff_aux_function_definition *>(
216                 AuxData.data());
217         dumpFunctionDefinition(&Sym, ObjFD);
218       } else if (Symbol.isFunctionLineInfo()) {
219         // This symbol describes function line number information.
220         assert(Symbol.getNumberOfAuxSymbols() == 1 &&
221                "Expected a single aux symbol to describe this function!");
222 
223         const object::coff_aux_bf_and_ef_symbol *ObjBES =
224             reinterpret_cast<const object::coff_aux_bf_and_ef_symbol *>(
225                 AuxData.data());
226         dumpbfAndEfLineInfo(&Sym, ObjBES);
227       } else if (Symbol.isAnyUndefined()) {
228         // This symbol represents a weak external definition.
229         assert(Symbol.getNumberOfAuxSymbols() == 1 &&
230                "Expected a single aux symbol to describe this weak symbol!");
231 
232         const object::coff_aux_weak_external *ObjWE =
233             reinterpret_cast<const object::coff_aux_weak_external *>(
234                 AuxData.data());
235         dumpWeakExternal(&Sym, ObjWE);
236       } else if (Symbol.isFileRecord()) {
237         // This symbol represents a file record.
238         Sym.File = StringRef(reinterpret_cast<const char *>(AuxData.data()),
239                              Symbol.getNumberOfAuxSymbols() *
240                                  Obj.getSymbolTableEntrySize())
241                        .rtrim(StringRef("\0", /*length=*/1));
242       } else if (Symbol.isSectionDefinition()) {
243         // This symbol represents a section definition.
244         assert(Symbol.getNumberOfAuxSymbols() == 1 &&
245                "Expected a single aux symbol to describe this section!");
246 
247         const object::coff_aux_section_definition *ObjSD =
248             reinterpret_cast<const object::coff_aux_section_definition *>(
249                 AuxData.data());
250         dumpSectionDefinition(&Sym, ObjSD, Symbol.isBigObj());
251       } else if (Symbol.isCLRToken()) {
252         // This symbol represents a CLR token definition.
253         assert(Symbol.getNumberOfAuxSymbols() == 1 &&
254                "Expected a single aux symbol to describe this CLR Token!");
255 
256         const object::coff_aux_clr_token *ObjCLRToken =
257             reinterpret_cast<const object::coff_aux_clr_token *>(
258                 AuxData.data());
259         dumpCLRTokenDefinition(&Sym, ObjCLRToken);
260       } else {
261         llvm_unreachable("Unhandled auxiliary symbol!");
262       }
263     }
264     Symbols.push_back(Sym);
265   }
266 }
267 
268 COFFYAML::Object &COFFDumper::getYAMLObj() {
269   return YAMLObj;
270 }
271 
272 std::error_code coff2yaml(raw_ostream &Out, const object::COFFObjectFile &Obj) {
273   COFFDumper Dumper(Obj);
274 
275   yaml::Output Yout(Out);
276   Yout << Dumper.getYAMLObj();
277 
278   return std::error_code();
279 }
280