blob: efcdc51e16703be58185bdc197dc50c5afc963cc [file] [log] [blame]
Sean Silva3b76e402013-06-05 19:56:47 +00001//===- yaml2coff - Convert YAML to a COFF object file ---------------------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// 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
Sean Silva3b76e402013-06-05 19:56:47 +00006//
7//===----------------------------------------------------------------------===//
8///
9/// \file
Adrian Prantl5f8f34e42018-05-01 15:54:18 +000010/// The COFF component of yaml2obj.
Sean Silva3b76e402013-06-05 19:56:47 +000011///
12//===----------------------------------------------------------------------===//
13
David Majnemerddf28f22014-03-19 04:47:47 +000014#include "llvm/ADT/STLExtras.h"
Sean Silva3b76e402013-06-05 19:56:47 +000015#include "llvm/ADT/StringExtras.h"
16#include "llvm/ADT/StringMap.h"
17#include "llvm/ADT/StringSwitch.h"
Zachary Turnera8cfc292017-06-14 15:59:27 +000018#include "llvm/DebugInfo/CodeView/DebugStringTableSubsection.h"
19#include "llvm/DebugInfo/CodeView/StringsAndChecksums.h"
David Majnemerf69b05852014-11-14 08:15:42 +000020#include "llvm/Object/COFF.h"
Chris Bieneman8ff0c112016-06-27 19:53:53 +000021#include "llvm/ObjectYAML/ObjectYAML.h"
Alex Brachetc22d9662019-08-07 02:44:49 +000022#include "llvm/ObjectYAML/yaml2obj.h"
Sean Silva3b76e402013-06-05 19:56:47 +000023#include "llvm/Support/Endian.h"
24#include "llvm/Support/MemoryBuffer.h"
25#include "llvm/Support/SourceMgr.h"
Martin Storsjo93a71372019-01-07 20:55:33 +000026#include "llvm/Support/WithColor.h"
Sean Silva3b76e402013-06-05 19:56:47 +000027#include "llvm/Support/raw_ostream.h"
28#include <vector>
29
30using namespace llvm;
31
Alex Brachetc22d9662019-08-07 02:44:49 +000032namespace {
33
Sean Silva3b76e402013-06-05 19:56:47 +000034/// This parses a yaml stream that represents a COFF object file.
35/// See docs/yaml2obj for the yaml scheema.
36struct COFFParser {
George Rimar85011022019-09-13 16:00:16 +000037 COFFParser(COFFYAML::Object &Obj, yaml::ErrorHandler EH)
38 : Obj(Obj), SectionTableStart(0), SectionTableSize(0), ErrHandler(EH) {
Sean Silva3b76e402013-06-05 19:56:47 +000039 // A COFF string table always starts with a 4 byte size field. Offsets into
40 // it include this size, so allocate it now.
Will Dietz0b48c732013-10-12 21:29:16 +000041 StringTable.append(4, char(0));
Sean Silva3b76e402013-06-05 19:56:47 +000042 }
43
David Majnemer2cbc1382014-09-16 03:52:46 +000044 bool useBigObj() const {
Aaron Ballman4934e4b2014-10-22 13:09:43 +000045 return static_cast<int32_t>(Obj.Sections.size()) >
46 COFF::MaxNumberOfSections16;
David Majnemer2cbc1382014-09-16 03:52:46 +000047 }
48
David Majnemerf69b05852014-11-14 08:15:42 +000049 bool isPE() const { return Obj.OptionalHeader.hasValue(); }
50 bool is64Bit() const {
Martin Storsjo5db3d332018-11-27 20:47:38 +000051 return Obj.Header.Machine == COFF::IMAGE_FILE_MACHINE_AMD64 ||
52 Obj.Header.Machine == COFF::IMAGE_FILE_MACHINE_ARM64;
David Majnemerf69b05852014-11-14 08:15:42 +000053 }
54
55 uint32_t getFileAlignment() const {
56 return Obj.OptionalHeader->Header.FileAlignment;
57 }
58
David Majnemer2cbc1382014-09-16 03:52:46 +000059 unsigned getHeaderSize() const {
60 return useBigObj() ? COFF::Header32Size : COFF::Header16Size;
61 }
62
63 unsigned getSymbolSize() const {
64 return useBigObj() ? COFF::Symbol32Size : COFF::Symbol16Size;
65 }
66
Sean Silva3b76e402013-06-05 19:56:47 +000067 bool parseSections() {
68 for (std::vector<COFFYAML::Section>::iterator i = Obj.Sections.begin(),
Alex Brachetc22d9662019-08-07 02:44:49 +000069 e = Obj.Sections.end();
70 i != e; ++i) {
Sean Silva3b76e402013-06-05 19:56:47 +000071 COFFYAML::Section &Sec = *i;
72
73 // If the name is less than 8 bytes, store it in place, otherwise
74 // store it in the string table.
75 StringRef Name = Sec.Name;
76
77 if (Name.size() <= COFF::NameSize) {
78 std::copy(Name.begin(), Name.end(), Sec.Header.Name);
79 } else {
80 // Add string to the string table and format the index for output.
81 unsigned Index = getStringIndex(Name);
82 std::string str = utostr(Index);
83 if (str.size() > 7) {
George Rimar85011022019-09-13 16:00:16 +000084 ErrHandler("string table got too large");
Sean Silva3b76e402013-06-05 19:56:47 +000085 return false;
86 }
87 Sec.Header.Name[0] = '/';
88 std::copy(str.begin(), str.end(), Sec.Header.Name + 1);
89 }
90
David Majnemer6f66f0a2016-03-17 05:43:26 +000091 if (Sec.Alignment) {
92 if (Sec.Alignment > 8192) {
George Rimar85011022019-09-13 16:00:16 +000093 ErrHandler("section alignment is too large");
David Majnemer6f66f0a2016-03-17 05:43:26 +000094 return false;
95 }
96 if (!isPowerOf2_32(Sec.Alignment)) {
George Rimar85011022019-09-13 16:00:16 +000097 ErrHandler("section alignment is not a power of 2");
David Majnemer6f66f0a2016-03-17 05:43:26 +000098 return false;
99 }
100 Sec.Header.Characteristics |= (Log2_32(Sec.Alignment) + 1) << 20;
101 }
Sean Silva3b76e402013-06-05 19:56:47 +0000102 }
103 return true;
104 }
105
106 bool parseSymbols() {
107 for (std::vector<COFFYAML::Symbol>::iterator i = Obj.Symbols.begin(),
Alex Brachetc22d9662019-08-07 02:44:49 +0000108 e = Obj.Symbols.end();
109 i != e; ++i) {
Sean Silva3b76e402013-06-05 19:56:47 +0000110 COFFYAML::Symbol &Sym = *i;
111
112 // If the name is less than 8 bytes, store it in place, otherwise
113 // store it in the string table.
114 StringRef Name = Sym.Name;
115 if (Name.size() <= COFF::NameSize) {
116 std::copy(Name.begin(), Name.end(), Sym.Header.Name);
117 } else {
118 // Add string to the string table and format the index for output.
119 unsigned Index = getStringIndex(Name);
Alex Brachetc22d9662019-08-07 02:44:49 +0000120 *reinterpret_cast<support::aligned_ulittle32_t *>(Sym.Header.Name + 4) =
121 Index;
Sean Silva3b76e402013-06-05 19:56:47 +0000122 }
123
124 Sym.Header.Type = Sym.SimpleType;
125 Sym.Header.Type |= Sym.ComplexType << COFF::SCT_COMPLEX_TYPE_SHIFT;
126 }
127 return true;
128 }
129
130 bool parse() {
131 if (!parseSections())
132 return false;
133 if (!parseSymbols())
134 return false;
135 return true;
136 }
137
138 unsigned getStringIndex(StringRef Str) {
139 StringMap<unsigned>::iterator i = StringTableMap.find(Str);
140 if (i == StringTableMap.end()) {
141 unsigned Index = StringTable.size();
142 StringTable.append(Str.begin(), Str.end());
143 StringTable.push_back(0);
144 StringTableMap[Str] = Index;
145 return Index;
146 }
147 return i->second;
148 }
149
150 COFFYAML::Object &Obj;
151
Zachary Turnera8cfc292017-06-14 15:59:27 +0000152 codeview::StringsAndChecksums StringsAndChecksums;
153 BumpPtrAllocator Allocator;
Sean Silva3b76e402013-06-05 19:56:47 +0000154 StringMap<unsigned> StringTableMap;
155 std::string StringTable;
David Majnemerf69b05852014-11-14 08:15:42 +0000156 uint32_t SectionTableStart;
157 uint32_t SectionTableSize;
George Rimar85011022019-09-13 16:00:16 +0000158
159 yaml::ErrorHandler ErrHandler;
Sean Silva3b76e402013-06-05 19:56:47 +0000160};
161
Alex Brachetc22d9662019-08-07 02:44:49 +0000162enum { DOSStubSize = 128 };
163
164} // end anonymous namespace
165
Sean Silva3b76e402013-06-05 19:56:47 +0000166// Take a CP and assign addresses and sizes to everything. Returns false if the
167// layout is not valid to do.
David Majnemerf69b05852014-11-14 08:15:42 +0000168static bool layoutOptionalHeader(COFFParser &CP) {
169 if (!CP.isPE())
170 return true;
David Majnemer966064c2014-11-14 19:35:59 +0000171 unsigned PEHeaderSize = CP.is64Bit() ? sizeof(object::pe32plus_header)
172 : sizeof(object::pe32_header);
David Majnemerf69b05852014-11-14 08:15:42 +0000173 CP.Obj.Header.SizeOfOptionalHeader =
David Majnemer966064c2014-11-14 19:35:59 +0000174 PEHeaderSize +
175 sizeof(object::data_directory) * (COFF::NUM_DATA_DIRECTORIES + 1);
David Majnemerf69b05852014-11-14 08:15:42 +0000176 return true;
177}
Sean Silva3b76e402013-06-05 19:56:47 +0000178
Zachary Turnera8cfc292017-06-14 15:59:27 +0000179static yaml::BinaryRef
180toDebugS(ArrayRef<CodeViewYAML::YAMLDebugSubsection> Subsections,
181 const codeview::StringsAndChecksums &SC, BumpPtrAllocator &Allocator) {
182 using namespace codeview;
183 ExitOnError Err("Error occurred writing .debug$S section");
184 auto CVSS =
185 Err(CodeViewYAML::toCodeViewSubsectionList(Allocator, Subsections, SC));
186
187 std::vector<DebugSubsectionRecordBuilder> Builders;
188 uint32_t Size = sizeof(uint32_t);
189 for (auto &SS : CVSS) {
190 DebugSubsectionRecordBuilder B(SS, CodeViewContainer::ObjectFile);
191 Size += B.calculateSerializedLength();
192 Builders.push_back(std::move(B));
193 }
194 uint8_t *Buffer = Allocator.Allocate<uint8_t>(Size);
195 MutableArrayRef<uint8_t> Output(Buffer, Size);
196 BinaryStreamWriter Writer(Output, support::little);
197
198 Err(Writer.writeInteger<uint32_t>(COFF::DEBUG_SECTION_MAGIC));
199 for (const auto &B : Builders) {
200 Err(B.commit(Writer));
201 }
202 return {Output};
203}
204
David Majnemerf69b05852014-11-14 08:15:42 +0000205// Take a CP and assign addresses and sizes to everything. Returns false if the
206// layout is not valid to do.
207static bool layoutCOFF(COFFParser &CP) {
Sean Silva3b76e402013-06-05 19:56:47 +0000208 // The section table starts immediately after the header, including the
209 // optional header.
David Majnemerf69b05852014-11-14 08:15:42 +0000210 CP.SectionTableStart =
211 CP.getHeaderSize() + CP.Obj.Header.SizeOfOptionalHeader;
David Majnemer646f47f2014-11-15 02:03:59 +0000212 if (CP.isPE())
213 CP.SectionTableStart += DOSStubSize + sizeof(COFF::PEMagic);
David Majnemerf69b05852014-11-14 08:15:42 +0000214 CP.SectionTableSize = COFF::SectionSize * CP.Obj.Sections.size();
Sean Silva3b76e402013-06-05 19:56:47 +0000215
David Majnemerf69b05852014-11-14 08:15:42 +0000216 uint32_t CurrentSectionDataOffset =
217 CP.SectionTableStart + CP.SectionTableSize;
Sean Silva3b76e402013-06-05 19:56:47 +0000218
Zachary Turnera8cfc292017-06-14 15:59:27 +0000219 for (COFFYAML::Section &S : CP.Obj.Sections) {
220 // We support specifying exactly one of SectionData or Subsections. So if
221 // there is already some SectionData, then we don't need to do any of this.
222 if (S.Name == ".debug$S" && S.SectionData.binary_size() == 0) {
223 CodeViewYAML::initializeStringsAndChecksums(S.DebugS,
224 CP.StringsAndChecksums);
225 if (CP.StringsAndChecksums.hasChecksums() &&
226 CP.StringsAndChecksums.hasStrings())
227 break;
228 }
229 }
230
Sean Silva3b76e402013-06-05 19:56:47 +0000231 // Assign each section data address consecutively.
David Majnemerf69b05852014-11-14 08:15:42 +0000232 for (COFFYAML::Section &S : CP.Obj.Sections) {
Zachary Turnera8cfc292017-06-14 15:59:27 +0000233 if (S.Name == ".debug$S") {
234 if (S.SectionData.binary_size() == 0) {
235 assert(CP.StringsAndChecksums.hasStrings() &&
236 "Object file does not have debug string table!");
237
238 S.SectionData =
239 toDebugS(S.DebugS, CP.StringsAndChecksums, CP.Allocator);
240 }
241 } else if (S.Name == ".debug$T") {
242 if (S.SectionData.binary_size() == 0)
Alexandre Ganead9e96742018-04-09 20:17:56 +0000243 S.SectionData = CodeViewYAML::toDebugT(S.DebugT, CP.Allocator, S.Name);
244 } else if (S.Name == ".debug$P") {
245 if (S.SectionData.binary_size() == 0)
246 S.SectionData = CodeViewYAML::toDebugT(S.DebugP, CP.Allocator, S.Name);
Zachary Turnerc221dc72017-12-06 18:58:48 +0000247 } else if (S.Name == ".debug$H") {
248 if (S.DebugH.hasValue() && S.SectionData.binary_size() == 0)
249 S.SectionData = CodeViewYAML::toDebugH(*S.DebugH, CP.Allocator);
Zachary Turnera8cfc292017-06-14 15:59:27 +0000250 }
251
David Majnemerf69b05852014-11-14 08:15:42 +0000252 if (S.SectionData.binary_size() > 0) {
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000253 CurrentSectionDataOffset = alignTo(CurrentSectionDataOffset,
254 CP.isPE() ? CP.getFileAlignment() : 4);
David Majnemerf69b05852014-11-14 08:15:42 +0000255 S.Header.SizeOfRawData = S.SectionData.binary_size();
256 if (CP.isPE())
257 S.Header.SizeOfRawData =
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000258 alignTo(S.Header.SizeOfRawData, CP.getFileAlignment());
David Majnemerf69b05852014-11-14 08:15:42 +0000259 S.Header.PointerToRawData = CurrentSectionDataOffset;
260 CurrentSectionDataOffset += S.Header.SizeOfRawData;
261 if (!S.Relocations.empty()) {
262 S.Header.PointerToRelocations = CurrentSectionDataOffset;
263 S.Header.NumberOfRelocations = S.Relocations.size();
264 CurrentSectionDataOffset +=
265 S.Header.NumberOfRelocations * COFF::RelocationSize;
Sean Silva3b76e402013-06-05 19:56:47 +0000266 }
Sean Silva3b76e402013-06-05 19:56:47 +0000267 } else {
Reid Kleckner7eb6b5f2019-05-10 21:53:44 +0000268 // Leave SizeOfRawData unaltered. For .bss sections in object files, it
269 // carries the section size.
David Majnemerf69b05852014-11-14 08:15:42 +0000270 S.Header.PointerToRawData = 0;
Sean Silva3b76e402013-06-05 19:56:47 +0000271 }
272 }
273
274 uint32_t SymbolTableStart = CurrentSectionDataOffset;
275
276 // Calculate number of symbols.
277 uint32_t NumberOfSymbols = 0;
278 for (std::vector<COFFYAML::Symbol>::iterator i = CP.Obj.Symbols.begin(),
279 e = CP.Obj.Symbols.end();
Alex Brachetc22d9662019-08-07 02:44:49 +0000280 i != e; ++i) {
David Majnemerddf28f22014-03-19 04:47:47 +0000281 uint32_t NumberOfAuxSymbols = 0;
282 if (i->FunctionDefinition)
283 NumberOfAuxSymbols += 1;
284 if (i->bfAndefSymbol)
285 NumberOfAuxSymbols += 1;
286 if (i->WeakExternal)
287 NumberOfAuxSymbols += 1;
288 if (!i->File.empty())
289 NumberOfAuxSymbols +=
David Majnemer2cbc1382014-09-16 03:52:46 +0000290 (i->File.size() + CP.getSymbolSize() - 1) / CP.getSymbolSize();
David Majnemerddf28f22014-03-19 04:47:47 +0000291 if (i->SectionDefinition)
292 NumberOfAuxSymbols += 1;
293 if (i->CLRToken)
294 NumberOfAuxSymbols += 1;
295 i->Header.NumberOfAuxSymbols = NumberOfAuxSymbols;
296 NumberOfSymbols += 1 + NumberOfAuxSymbols;
Sean Silva3b76e402013-06-05 19:56:47 +0000297 }
298
299 // Store all the allocated start addresses in the header.
300 CP.Obj.Header.NumberOfSections = CP.Obj.Sections.size();
301 CP.Obj.Header.NumberOfSymbols = NumberOfSymbols;
David Majnemerf69b05852014-11-14 08:15:42 +0000302 if (NumberOfSymbols > 0 || CP.StringTable.size() > 4)
303 CP.Obj.Header.PointerToSymbolTable = SymbolTableStart;
304 else
305 CP.Obj.Header.PointerToSymbolTable = 0;
Sean Silva3b76e402013-06-05 19:56:47 +0000306
Alex Brachetc22d9662019-08-07 02:44:49 +0000307 *reinterpret_cast<support::ulittle32_t *>(&CP.StringTable[0]) =
308 CP.StringTable.size();
Sean Silva3b76e402013-06-05 19:56:47 +0000309
310 return true;
311}
312
Alex Brachetc22d9662019-08-07 02:44:49 +0000313template <typename value_type> struct binary_le_impl {
Sean Silva3b76e402013-06-05 19:56:47 +0000314 value_type Value;
315 binary_le_impl(value_type V) : Value(V) {}
316};
317
318template <typename value_type>
Alex Brachetc22d9662019-08-07 02:44:49 +0000319raw_ostream &operator<<(raw_ostream &OS,
320 const binary_le_impl<value_type> &BLE) {
Sean Silva3b76e402013-06-05 19:56:47 +0000321 char Buffer[sizeof(BLE.Value)];
322 support::endian::write<value_type, support::little, support::unaligned>(
Alex Brachetc22d9662019-08-07 02:44:49 +0000323 Buffer, BLE.Value);
Sean Silva3b76e402013-06-05 19:56:47 +0000324 OS.write(Buffer, sizeof(BLE.Value));
325 return OS;
326}
327
328template <typename value_type>
329binary_le_impl<value_type> binary_le(value_type V) {
330 return binary_le_impl<value_type>(V);
331}
332
Benjamin Kramer79de6e62015-04-11 18:57:14 +0000333template <size_t NumBytes> struct zeros_impl {};
David Majnemerddf28f22014-03-19 04:47:47 +0000334
335template <size_t NumBytes>
336raw_ostream &operator<<(raw_ostream &OS, const zeros_impl<NumBytes> &) {
337 char Buffer[NumBytes];
338 memset(Buffer, 0, sizeof(Buffer));
339 OS.write(Buffer, sizeof(Buffer));
340 return OS;
341}
342
Alex Brachetc22d9662019-08-07 02:44:49 +0000343template <typename T> zeros_impl<sizeof(T)> zeros(const T &) {
David Majnemerddf28f22014-03-19 04:47:47 +0000344 return zeros_impl<sizeof(T)>();
345}
346
David Majnemerf69b05852014-11-14 08:15:42 +0000347template <typename T>
Alex Brachetc22d9662019-08-07 02:44:49 +0000348static uint32_t initializeOptionalHeader(COFFParser &CP, uint16_t Magic,
349 T Header) {
David Majnemerf69b05852014-11-14 08:15:42 +0000350 memset(Header, 0, sizeof(*Header));
351 Header->Magic = Magic;
352 Header->SectionAlignment = CP.Obj.OptionalHeader->Header.SectionAlignment;
David Majnemer966064c2014-11-14 19:35:59 +0000353 Header->FileAlignment = CP.Obj.OptionalHeader->Header.FileAlignment;
David Majnemerf69b05852014-11-14 08:15:42 +0000354 uint32_t SizeOfCode = 0, SizeOfInitializedData = 0,
355 SizeOfUninitializedData = 0;
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000356 uint32_t SizeOfHeaders = alignTo(CP.SectionTableStart + CP.SectionTableSize,
357 Header->FileAlignment);
358 uint32_t SizeOfImage = alignTo(SizeOfHeaders, Header->SectionAlignment);
David Majnemer966064c2014-11-14 19:35:59 +0000359 uint32_t BaseOfData = 0;
David Majnemerf69b05852014-11-14 08:15:42 +0000360 for (const COFFYAML::Section &S : CP.Obj.Sections) {
361 if (S.Header.Characteristics & COFF::IMAGE_SCN_CNT_CODE)
362 SizeOfCode += S.Header.SizeOfRawData;
363 if (S.Header.Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
364 SizeOfInitializedData += S.Header.SizeOfRawData;
365 if (S.Header.Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
366 SizeOfUninitializedData += S.Header.SizeOfRawData;
367 if (S.Name.equals(".text"))
David Majnemer966064c2014-11-14 19:35:59 +0000368 Header->BaseOfCode = S.Header.VirtualAddress; // RVA
369 else if (S.Name.equals(".data"))
370 BaseOfData = S.Header.VirtualAddress; // RVA
David Majnemerf69b05852014-11-14 08:15:42 +0000371 if (S.Header.VirtualAddress)
Rui Ueyamada00f2f2016-01-14 21:06:47 +0000372 SizeOfImage += alignTo(S.Header.VirtualSize, Header->SectionAlignment);
David Majnemerf69b05852014-11-14 08:15:42 +0000373 }
374 Header->SizeOfCode = SizeOfCode;
375 Header->SizeOfInitializedData = SizeOfInitializedData;
376 Header->SizeOfUninitializedData = SizeOfUninitializedData;
377 Header->AddressOfEntryPoint =
378 CP.Obj.OptionalHeader->Header.AddressOfEntryPoint; // RVA
379 Header->ImageBase = CP.Obj.OptionalHeader->Header.ImageBase;
David Majnemerf69b05852014-11-14 08:15:42 +0000380 Header->MajorOperatingSystemVersion =
381 CP.Obj.OptionalHeader->Header.MajorOperatingSystemVersion;
382 Header->MinorOperatingSystemVersion =
383 CP.Obj.OptionalHeader->Header.MinorOperatingSystemVersion;
Alex Brachetc22d9662019-08-07 02:44:49 +0000384 Header->MajorImageVersion = CP.Obj.OptionalHeader->Header.MajorImageVersion;
385 Header->MinorImageVersion = CP.Obj.OptionalHeader->Header.MinorImageVersion;
David Majnemerf69b05852014-11-14 08:15:42 +0000386 Header->MajorSubsystemVersion =
387 CP.Obj.OptionalHeader->Header.MajorSubsystemVersion;
388 Header->MinorSubsystemVersion =
389 CP.Obj.OptionalHeader->Header.MinorSubsystemVersion;
390 Header->SizeOfImage = SizeOfImage;
391 Header->SizeOfHeaders = SizeOfHeaders;
392 Header->Subsystem = CP.Obj.OptionalHeader->Header.Subsystem;
393 Header->DLLCharacteristics = CP.Obj.OptionalHeader->Header.DLLCharacteristics;
394 Header->SizeOfStackReserve = CP.Obj.OptionalHeader->Header.SizeOfStackReserve;
395 Header->SizeOfStackCommit = CP.Obj.OptionalHeader->Header.SizeOfStackCommit;
396 Header->SizeOfHeapReserve = CP.Obj.OptionalHeader->Header.SizeOfHeapReserve;
397 Header->SizeOfHeapCommit = CP.Obj.OptionalHeader->Header.SizeOfHeapCommit;
398 Header->NumberOfRvaAndSize = COFF::NUM_DATA_DIRECTORIES + 1;
David Majnemer966064c2014-11-14 19:35:59 +0000399 return BaseOfData;
David Majnemerf69b05852014-11-14 08:15:42 +0000400}
401
402static bool writeCOFF(COFFParser &CP, raw_ostream &OS) {
403 if (CP.isPE()) {
404 // PE files start with a DOS stub.
405 object::dos_header DH;
406 memset(&DH, 0, sizeof(DH));
407
408 // DOS EXEs start with "MZ" magic.
409 DH.Magic[0] = 'M';
410 DH.Magic[1] = 'Z';
411 // Initializing the AddressOfRelocationTable is strictly optional but
412 // mollifies certain tools which expect it to have a value greater than
413 // 0x40.
414 DH.AddressOfRelocationTable = sizeof(DH);
415 // This is the address of the PE signature.
David Majnemer646f47f2014-11-15 02:03:59 +0000416 DH.AddressOfNewExeHeader = DOSStubSize;
David Majnemerf69b05852014-11-14 08:15:42 +0000417
418 // Write out our DOS stub.
419 OS.write(reinterpret_cast<char *>(&DH), sizeof(DH));
420 // Write padding until we reach the position of where our PE signature
421 // should live.
Fangrui Songde0462a2019-04-24 13:23:15 +0000422 OS.write_zeros(DOSStubSize - sizeof(DH));
David Majnemerf69b05852014-11-14 08:15:42 +0000423 // Write out the PE signature.
424 OS.write(COFF::PEMagic, sizeof(COFF::PEMagic));
425 }
David Majnemer2cbc1382014-09-16 03:52:46 +0000426 if (CP.useBigObj()) {
427 OS << binary_le(static_cast<uint16_t>(COFF::IMAGE_FILE_MACHINE_UNKNOWN))
428 << binary_le(static_cast<uint16_t>(0xffff))
Alex Brachetc22d9662019-08-07 02:44:49 +0000429 << binary_le(
430 static_cast<uint16_t>(COFF::BigObjHeader::MinBigObjectVersion))
David Majnemer2cbc1382014-09-16 03:52:46 +0000431 << binary_le(CP.Obj.Header.Machine)
432 << binary_le(CP.Obj.Header.TimeDateStamp);
433 OS.write(COFF::BigObjMagic, sizeof(COFF::BigObjMagic));
Alex Brachetc22d9662019-08-07 02:44:49 +0000434 OS << zeros(uint32_t(0)) << zeros(uint32_t(0)) << zeros(uint32_t(0))
435 << zeros(uint32_t(0)) << binary_le(CP.Obj.Header.NumberOfSections)
David Majnemer2cbc1382014-09-16 03:52:46 +0000436 << binary_le(CP.Obj.Header.PointerToSymbolTable)
437 << binary_le(CP.Obj.Header.NumberOfSymbols);
438 } else {
439 OS << binary_le(CP.Obj.Header.Machine)
440 << binary_le(static_cast<int16_t>(CP.Obj.Header.NumberOfSections))
441 << binary_le(CP.Obj.Header.TimeDateStamp)
442 << binary_le(CP.Obj.Header.PointerToSymbolTable)
443 << binary_le(CP.Obj.Header.NumberOfSymbols)
444 << binary_le(CP.Obj.Header.SizeOfOptionalHeader)
445 << binary_le(CP.Obj.Header.Characteristics);
446 }
David Majnemerf69b05852014-11-14 08:15:42 +0000447 if (CP.isPE()) {
448 if (CP.is64Bit()) {
449 object::pe32plus_header PEH;
450 initializeOptionalHeader(CP, COFF::PE32Header::PE32_PLUS, &PEH);
451 OS.write(reinterpret_cast<char *>(&PEH), sizeof(PEH));
452 } else {
453 object::pe32_header PEH;
Alex Brachetc22d9662019-08-07 02:44:49 +0000454 uint32_t BaseOfData =
455 initializeOptionalHeader(CP, COFF::PE32Header::PE32, &PEH);
David Majnemer966064c2014-11-14 19:35:59 +0000456 PEH.BaseOfData = BaseOfData;
David Majnemerf69b05852014-11-14 08:15:42 +0000457 OS.write(reinterpret_cast<char *>(&PEH), sizeof(PEH));
458 }
459 for (const Optional<COFF::DataDirectory> &DD :
460 CP.Obj.OptionalHeader->DataDirectories) {
461 if (!DD.hasValue()) {
462 OS << zeros(uint32_t(0));
463 OS << zeros(uint32_t(0));
464 } else {
465 OS << binary_le(DD->RelativeVirtualAddress);
466 OS << binary_le(DD->Size);
467 }
468 }
469 OS << zeros(uint32_t(0));
470 OS << zeros(uint32_t(0));
471 }
Sean Silva3b76e402013-06-05 19:56:47 +0000472
David Majnemer646f47f2014-11-15 02:03:59 +0000473 assert(OS.tell() == CP.SectionTableStart);
Sean Silva3b76e402013-06-05 19:56:47 +0000474 // Output section table.
475 for (std::vector<COFFYAML::Section>::iterator i = CP.Obj.Sections.begin(),
476 e = CP.Obj.Sections.end();
Alex Brachetc22d9662019-08-07 02:44:49 +0000477 i != e; ++i) {
Sean Silva3b76e402013-06-05 19:56:47 +0000478 OS.write(i->Header.Name, COFF::NameSize);
479 OS << binary_le(i->Header.VirtualSize)
480 << binary_le(i->Header.VirtualAddress)
481 << binary_le(i->Header.SizeOfRawData)
482 << binary_le(i->Header.PointerToRawData)
483 << binary_le(i->Header.PointerToRelocations)
484 << binary_le(i->Header.PointerToLineNumbers)
485 << binary_le(i->Header.NumberOfRelocations)
486 << binary_le(i->Header.NumberOfLineNumbers)
487 << binary_le(i->Header.Characteristics);
488 }
David Majnemer646f47f2014-11-15 02:03:59 +0000489 assert(OS.tell() == CP.SectionTableStart + CP.SectionTableSize);
Sean Silva3b76e402013-06-05 19:56:47 +0000490
Rafael Espindolae2e741e2013-06-06 13:06:17 +0000491 unsigned CurSymbol = 0;
492 StringMap<unsigned> SymbolTableIndexMap;
493 for (std::vector<COFFYAML::Symbol>::iterator I = CP.Obj.Symbols.begin(),
494 E = CP.Obj.Symbols.end();
495 I != E; ++I) {
496 SymbolTableIndexMap[I->Name] = CurSymbol;
497 CurSymbol += 1 + I->Header.NumberOfAuxSymbols;
498 }
499
Sean Silva3b76e402013-06-05 19:56:47 +0000500 // Output section data.
David Majnemerf69b05852014-11-14 08:15:42 +0000501 for (const COFFYAML::Section &S : CP.Obj.Sections) {
Reid Kleckner7eb6b5f2019-05-10 21:53:44 +0000502 if (S.Header.SizeOfRawData == 0 || S.Header.PointerToRawData == 0)
David Majnemerf69b05852014-11-14 08:15:42 +0000503 continue;
David Majnemer646f47f2014-11-15 02:03:59 +0000504 assert(S.Header.PointerToRawData >= OS.tell());
Fangrui Songde0462a2019-04-24 13:23:15 +0000505 OS.write_zeros(S.Header.PointerToRawData - OS.tell());
David Majnemerf69b05852014-11-14 08:15:42 +0000506 S.SectionData.writeAsBinary(OS);
David Majnemer646f47f2014-11-15 02:03:59 +0000507 assert(S.Header.SizeOfRawData >= S.SectionData.binary_size());
Fangrui Songde0462a2019-04-24 13:23:15 +0000508 OS.write_zeros(S.Header.SizeOfRawData - S.SectionData.binary_size());
David Majnemerf69b05852014-11-14 08:15:42 +0000509 for (const COFFYAML::Relocation &R : S.Relocations) {
Martin Storsjo93a71372019-01-07 20:55:33 +0000510 uint32_t SymbolTableIndex;
511 if (R.SymbolTableIndex) {
512 if (!R.SymbolName.empty())
513 WithColor::error()
514 << "Both SymbolName and SymbolTableIndex specified\n";
515 SymbolTableIndex = *R.SymbolTableIndex;
516 } else {
517 SymbolTableIndex = SymbolTableIndexMap[R.SymbolName];
518 }
Alex Brachetc22d9662019-08-07 02:44:49 +0000519 OS << binary_le(R.VirtualAddress) << binary_le(SymbolTableIndex)
Sean Silva3b76e402013-06-05 19:56:47 +0000520 << binary_le(R.Type);
521 }
522 }
523
524 // Output symbol table.
525
526 for (std::vector<COFFYAML::Symbol>::const_iterator i = CP.Obj.Symbols.begin(),
527 e = CP.Obj.Symbols.end();
Alex Brachetc22d9662019-08-07 02:44:49 +0000528 i != e; ++i) {
Sean Silva3b76e402013-06-05 19:56:47 +0000529 OS.write(i->Header.Name, COFF::NameSize);
David Majnemer2cbc1382014-09-16 03:52:46 +0000530 OS << binary_le(i->Header.Value);
531 if (CP.useBigObj())
Alex Brachetc22d9662019-08-07 02:44:49 +0000532 OS << binary_le(i->Header.SectionNumber);
David Majnemer2cbc1382014-09-16 03:52:46 +0000533 else
Alex Brachetc22d9662019-08-07 02:44:49 +0000534 OS << binary_le(static_cast<int16_t>(i->Header.SectionNumber));
535 OS << binary_le(i->Header.Type) << binary_le(i->Header.StorageClass)
Sean Silva3b76e402013-06-05 19:56:47 +0000536 << binary_le(i->Header.NumberOfAuxSymbols);
David Majnemerddf28f22014-03-19 04:47:47 +0000537
Fangrui Songde0462a2019-04-24 13:23:15 +0000538 if (i->FunctionDefinition) {
David Majnemerddf28f22014-03-19 04:47:47 +0000539 OS << binary_le(i->FunctionDefinition->TagIndex)
540 << binary_le(i->FunctionDefinition->TotalSize)
541 << binary_le(i->FunctionDefinition->PointerToLinenumber)
542 << binary_le(i->FunctionDefinition->PointerToNextFunction)
Fangrui Songde0462a2019-04-24 13:23:15 +0000543 << zeros(i->FunctionDefinition->unused);
544 OS.write_zeros(CP.getSymbolSize() - COFF::Symbol16Size);
545 }
546 if (i->bfAndefSymbol) {
David Majnemerddf28f22014-03-19 04:47:47 +0000547 OS << zeros(i->bfAndefSymbol->unused1)
548 << binary_le(i->bfAndefSymbol->Linenumber)
549 << zeros(i->bfAndefSymbol->unused2)
550 << binary_le(i->bfAndefSymbol->PointerToNextFunction)
Fangrui Songde0462a2019-04-24 13:23:15 +0000551 << zeros(i->bfAndefSymbol->unused3);
552 OS.write_zeros(CP.getSymbolSize() - COFF::Symbol16Size);
553 }
554 if (i->WeakExternal) {
David Majnemerddf28f22014-03-19 04:47:47 +0000555 OS << binary_le(i->WeakExternal->TagIndex)
556 << binary_le(i->WeakExternal->Characteristics)
Fangrui Songde0462a2019-04-24 13:23:15 +0000557 << zeros(i->WeakExternal->unused);
558 OS.write_zeros(CP.getSymbolSize() - COFF::Symbol16Size);
559 }
David Majnemerddf28f22014-03-19 04:47:47 +0000560 if (!i->File.empty()) {
David Majnemer2cbc1382014-09-16 03:52:46 +0000561 unsigned SymbolSize = CP.getSymbolSize();
David Majnemerddf28f22014-03-19 04:47:47 +0000562 uint32_t NumberOfAuxRecords =
David Majnemer2cbc1382014-09-16 03:52:46 +0000563 (i->File.size() + SymbolSize - 1) / SymbolSize;
564 uint32_t NumberOfAuxBytes = NumberOfAuxRecords * SymbolSize;
David Majnemerddf28f22014-03-19 04:47:47 +0000565 uint32_t NumZeros = NumberOfAuxBytes - i->File.size();
566 OS.write(i->File.data(), i->File.size());
Fangrui Songde0462a2019-04-24 13:23:15 +0000567 OS.write_zeros(NumZeros);
David Majnemerddf28f22014-03-19 04:47:47 +0000568 }
Fangrui Songde0462a2019-04-24 13:23:15 +0000569 if (i->SectionDefinition) {
David Majnemerddf28f22014-03-19 04:47:47 +0000570 OS << binary_le(i->SectionDefinition->Length)
571 << binary_le(i->SectionDefinition->NumberOfRelocations)
572 << binary_le(i->SectionDefinition->NumberOfLinenumbers)
573 << binary_le(i->SectionDefinition->CheckSum)
David Majnemer4d571592014-09-15 19:42:42 +0000574 << binary_le(static_cast<int16_t>(i->SectionDefinition->Number))
David Majnemerddf28f22014-03-19 04:47:47 +0000575 << binary_le(i->SectionDefinition->Selection)
David Majnemer4d571592014-09-15 19:42:42 +0000576 << zeros(i->SectionDefinition->unused)
Fangrui Songde0462a2019-04-24 13:23:15 +0000577 << binary_le(static_cast<int16_t>(i->SectionDefinition->Number >> 16));
578 OS.write_zeros(CP.getSymbolSize() - COFF::Symbol16Size);
579 }
580 if (i->CLRToken) {
Alex Brachetc22d9662019-08-07 02:44:49 +0000581 OS << binary_le(i->CLRToken->AuxType) << zeros(i->CLRToken->unused1)
David Majnemerddf28f22014-03-19 04:47:47 +0000582 << binary_le(i->CLRToken->SymbolTableIndex)
Fangrui Songde0462a2019-04-24 13:23:15 +0000583 << zeros(i->CLRToken->unused2);
584 OS.write_zeros(CP.getSymbolSize() - COFF::Symbol16Size);
585 }
Sean Silva3b76e402013-06-05 19:56:47 +0000586 }
587
588 // Output string table.
David Majnemerf69b05852014-11-14 08:15:42 +0000589 if (CP.Obj.Header.PointerToSymbolTable)
590 OS.write(&CP.StringTable[0], CP.StringTable.size());
Sean Silva3b76e402013-06-05 19:56:47 +0000591 return true;
592}
593
Alex Brachetc22d9662019-08-07 02:44:49 +0000594namespace llvm {
595namespace yaml {
596
George Rimar85011022019-09-13 16:00:16 +0000597bool yaml2coff(llvm::COFFYAML::Object &Doc, raw_ostream &Out,
598 ErrorHandler ErrHandler) {
599 COFFParser CP(Doc, ErrHandler);
Sean Silva3b76e402013-06-05 19:56:47 +0000600 if (!CP.parse()) {
George Rimar85011022019-09-13 16:00:16 +0000601 ErrHandler("failed to parse YAML file");
George Rimar7da559f2019-09-13 09:12:38 +0000602 return false;
Sean Silva3b76e402013-06-05 19:56:47 +0000603 }
604
David Majnemerf69b05852014-11-14 08:15:42 +0000605 if (!layoutOptionalHeader(CP)) {
George Rimar85011022019-09-13 16:00:16 +0000606 ErrHandler("failed to layout optional header for COFF file");
George Rimar7da559f2019-09-13 09:12:38 +0000607 return false;
David Majnemerf69b05852014-11-14 08:15:42 +0000608 }
Zachary Turnera8cfc292017-06-14 15:59:27 +0000609
Sean Silva3b76e402013-06-05 19:56:47 +0000610 if (!layoutCOFF(CP)) {
George Rimar85011022019-09-13 16:00:16 +0000611 ErrHandler("failed to layout COFF file");
George Rimar7da559f2019-09-13 09:12:38 +0000612 return false;
Sean Silva3b76e402013-06-05 19:56:47 +0000613 }
614 if (!writeCOFF(CP, Out)) {
George Rimar85011022019-09-13 16:00:16 +0000615 ErrHandler("failed to write COFF file");
George Rimar7da559f2019-09-13 09:12:38 +0000616 return false;
Sean Silva3b76e402013-06-05 19:56:47 +0000617 }
George Rimar7da559f2019-09-13 09:12:38 +0000618 return true;
Sean Silva3b76e402013-06-05 19:56:47 +0000619}
Alex Brachetc22d9662019-08-07 02:44:49 +0000620
621} // namespace yaml
622} // namespace llvm