1 //===- yaml2coff - Convert YAML to a COFF object file ---------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief The COFF component of yaml2obj.
13 //===----------------------------------------------------------------------===//
16 #include "llvm/ADT/SmallString.h"
17 #include "llvm/ADT/STLExtras.h"
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/ADT/StringMap.h"
20 #include "llvm/ADT/StringSwitch.h"
21 #include "llvm/Object/COFFYAML.h"
22 #include "llvm/Object/COFF.h"
23 #include "llvm/Support/Endian.h"
24 #include "llvm/Support/MemoryBuffer.h"
25 #include "llvm/Support/SourceMgr.h"
26 #include "llvm/Support/raw_ostream.h"
31 /// This parses a yaml stream that represents a COFF object file.
32 /// See docs/yaml2obj for the yaml scheema.
34 COFFParser(COFFYAML::Object &Obj)
35 : Obj(Obj), SectionTableStart(0), SectionTableSize(0) {
36 // A COFF string table always starts with a 4 byte size field. Offsets into
37 // it include this size, so allocate it now.
38 StringTable.append(4, char(0));
41 bool useBigObj() const {
42 return static_cast<int32_t>(Obj.Sections.size()) >
43 COFF::MaxNumberOfSections16;
46 bool isPE() const { return Obj.OptionalHeader.hasValue(); }
47 bool is64Bit() const {
48 return Obj.Header.Machine == COFF::IMAGE_FILE_MACHINE_AMD64;
51 uint32_t getFileAlignment() const {
52 return Obj.OptionalHeader->Header.FileAlignment;
55 unsigned getHeaderSize() const {
56 return useBigObj() ? COFF::Header32Size : COFF::Header16Size;
59 unsigned getSymbolSize() const {
60 return useBigObj() ? COFF::Symbol32Size : COFF::Symbol16Size;
63 bool parseSections() {
64 for (std::vector<COFFYAML::Section>::iterator i = Obj.Sections.begin(),
65 e = Obj.Sections.end(); i != e; ++i) {
66 COFFYAML::Section &Sec = *i;
68 // If the name is less than 8 bytes, store it in place, otherwise
69 // store it in the string table.
70 StringRef Name = Sec.Name;
72 if (Name.size() <= COFF::NameSize) {
73 std::copy(Name.begin(), Name.end(), Sec.Header.Name);
75 // Add string to the string table and format the index for output.
76 unsigned Index = getStringIndex(Name);
77 std::string str = utostr(Index);
79 errs() << "String table got too large";
82 Sec.Header.Name[0] = '/';
83 std::copy(str.begin(), str.end(), Sec.Header.Name + 1);
86 Sec.Header.Characteristics |= (Log2_32(Sec.Alignment) + 1) << 20;
92 for (std::vector<COFFYAML::Symbol>::iterator i = Obj.Symbols.begin(),
93 e = Obj.Symbols.end(); i != e; ++i) {
94 COFFYAML::Symbol &Sym = *i;
96 // If the name is less than 8 bytes, store it in place, otherwise
97 // store it in the string table.
98 StringRef Name = Sym.Name;
99 if (Name.size() <= COFF::NameSize) {
100 std::copy(Name.begin(), Name.end(), Sym.Header.Name);
102 // Add string to the string table and format the index for output.
103 unsigned Index = getStringIndex(Name);
104 *reinterpret_cast<support::aligned_ulittle32_t*>(
105 Sym.Header.Name + 4) = Index;
108 Sym.Header.Type = Sym.SimpleType;
109 Sym.Header.Type |= Sym.ComplexType << COFF::SCT_COMPLEX_TYPE_SHIFT;
115 if (!parseSections())
122 unsigned getStringIndex(StringRef Str) {
123 StringMap<unsigned>::iterator i = StringTableMap.find(Str);
124 if (i == StringTableMap.end()) {
125 unsigned Index = StringTable.size();
126 StringTable.append(Str.begin(), Str.end());
127 StringTable.push_back(0);
128 StringTableMap[Str] = Index;
134 COFFYAML::Object &Obj;
136 StringMap<unsigned> StringTableMap;
137 std::string StringTable;
138 uint32_t SectionTableStart;
139 uint32_t SectionTableSize;
142 // Take a CP and assign addresses and sizes to everything. Returns false if the
143 // layout is not valid to do.
144 static bool layoutOptionalHeader(COFFParser &CP) {
147 CP.Obj.Header.SizeOfOptionalHeader =
148 (CP.is64Bit() ? sizeof(object::pe32plus_header)
149 : sizeof(object::pe32_header)) +
150 (sizeof(object::data_directory) * (COFF::NUM_DATA_DIRECTORIES + 1));
154 // Take a CP and assign addresses and sizes to everything. Returns false if the
155 // layout is not valid to do.
156 static bool layoutCOFF(COFFParser &CP) {
157 // The section table starts immediately after the header, including the
159 CP.SectionTableStart =
160 CP.getHeaderSize() + CP.Obj.Header.SizeOfOptionalHeader;
161 CP.SectionTableSize = COFF::SectionSize * CP.Obj.Sections.size();
163 uint32_t CurrentSectionDataOffset =
164 CP.SectionTableStart + CP.SectionTableSize;
166 // Assign each section data address consecutively.
167 for (COFFYAML::Section &S : CP.Obj.Sections) {
168 if (S.SectionData.binary_size() > 0) {
169 CurrentSectionDataOffset = RoundUpToAlignment(
170 CurrentSectionDataOffset, CP.isPE() ? CP.getFileAlignment() : 4);
171 S.Header.SizeOfRawData = S.SectionData.binary_size();
173 S.Header.SizeOfRawData =
174 RoundUpToAlignment(S.Header.SizeOfRawData, CP.getFileAlignment());
175 S.Header.PointerToRawData = CurrentSectionDataOffset;
176 CurrentSectionDataOffset += S.Header.SizeOfRawData;
177 if (!S.Relocations.empty()) {
178 S.Header.PointerToRelocations = CurrentSectionDataOffset;
179 S.Header.NumberOfRelocations = S.Relocations.size();
180 CurrentSectionDataOffset +=
181 S.Header.NumberOfRelocations * COFF::RelocationSize;
184 S.Header.SizeOfRawData = 0;
185 S.Header.PointerToRawData = 0;
189 uint32_t SymbolTableStart = CurrentSectionDataOffset;
191 // Calculate number of symbols.
192 uint32_t NumberOfSymbols = 0;
193 for (std::vector<COFFYAML::Symbol>::iterator i = CP.Obj.Symbols.begin(),
194 e = CP.Obj.Symbols.end();
196 uint32_t NumberOfAuxSymbols = 0;
197 if (i->FunctionDefinition)
198 NumberOfAuxSymbols += 1;
199 if (i->bfAndefSymbol)
200 NumberOfAuxSymbols += 1;
202 NumberOfAuxSymbols += 1;
203 if (!i->File.empty())
204 NumberOfAuxSymbols +=
205 (i->File.size() + CP.getSymbolSize() - 1) / CP.getSymbolSize();
206 if (i->SectionDefinition)
207 NumberOfAuxSymbols += 1;
209 NumberOfAuxSymbols += 1;
210 i->Header.NumberOfAuxSymbols = NumberOfAuxSymbols;
211 NumberOfSymbols += 1 + NumberOfAuxSymbols;
214 // Store all the allocated start addresses in the header.
215 CP.Obj.Header.NumberOfSections = CP.Obj.Sections.size();
216 CP.Obj.Header.NumberOfSymbols = NumberOfSymbols;
217 if (NumberOfSymbols > 0 || CP.StringTable.size() > 4)
218 CP.Obj.Header.PointerToSymbolTable = SymbolTableStart;
220 CP.Obj.Header.PointerToSymbolTable = 0;
222 *reinterpret_cast<support::ulittle32_t *>(&CP.StringTable[0])
223 = CP.StringTable.size();
228 template <typename value_type>
229 struct binary_le_impl {
231 binary_le_impl(value_type V) : Value(V) {}
234 template <typename value_type>
235 raw_ostream &operator <<( raw_ostream &OS
236 , const binary_le_impl<value_type> &BLE) {
237 char Buffer[sizeof(BLE.Value)];
238 support::endian::write<value_type, support::little, support::unaligned>(
240 OS.write(Buffer, sizeof(BLE.Value));
244 template <typename value_type>
245 binary_le_impl<value_type> binary_le(value_type V) {
246 return binary_le_impl<value_type>(V);
249 template <size_t NumBytes>
254 template <size_t NumBytes>
255 raw_ostream &operator<<(raw_ostream &OS, const zeros_impl<NumBytes> &) {
256 char Buffer[NumBytes];
257 memset(Buffer, 0, sizeof(Buffer));
258 OS.write(Buffer, sizeof(Buffer));
262 template <typename T>
263 zeros_impl<sizeof(T)> zeros(const T &) {
264 return zeros_impl<sizeof(T)>();
267 struct num_zeros_impl {
269 num_zeros_impl(size_t N) : N(N) {}
272 raw_ostream &operator<<(raw_ostream &OS, const num_zeros_impl &NZI) {
273 for (size_t I = 0; I != NZI.N; ++I)
278 num_zeros_impl num_zeros(size_t N) {
279 num_zeros_impl NZI(N);
283 template <typename T>
284 static void initializeOptionalHeader(COFFParser &CP, uint16_t Magic, T Header) {
285 memset(Header, 0, sizeof(*Header));
286 Header->Magic = Magic;
287 Header->SectionAlignment = CP.Obj.OptionalHeader->Header.SectionAlignment;
288 uint32_t SizeOfCode = 0, SizeOfInitializedData = 0,
289 SizeOfUninitializedData = 0;
290 uint32_t SizeOfHeaders = RoundUpToAlignment(
291 CP.SectionTableStart + CP.SectionTableSize, Header->SectionAlignment);
292 uint32_t SizeOfImage = SizeOfHeaders;
293 for (const COFFYAML::Section &S : CP.Obj.Sections) {
294 if (S.Header.Characteristics & COFF::IMAGE_SCN_CNT_CODE)
295 SizeOfCode += S.Header.SizeOfRawData;
296 if (S.Header.Characteristics & COFF::IMAGE_SCN_CNT_INITIALIZED_DATA)
297 SizeOfInitializedData += S.Header.SizeOfRawData;
298 if (S.Header.Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)
299 SizeOfUninitializedData += S.Header.SizeOfRawData;
300 if (S.Name.equals(".text"))
301 Header->BaseOfCode = S.Header.VirtualAddress; // RVA
302 if (S.Header.VirtualAddress)
304 RoundUpToAlignment(S.Header.VirtualSize, Header->SectionAlignment);
306 Header->SizeOfCode = SizeOfCode;
307 Header->SizeOfInitializedData = SizeOfInitializedData;
308 Header->SizeOfUninitializedData = SizeOfUninitializedData;
309 Header->AddressOfEntryPoint =
310 CP.Obj.OptionalHeader->Header.AddressOfEntryPoint; // RVA
311 Header->ImageBase = CP.Obj.OptionalHeader->Header.ImageBase;
312 Header->FileAlignment = CP.Obj.OptionalHeader->Header.FileAlignment;
313 Header->MajorOperatingSystemVersion =
314 CP.Obj.OptionalHeader->Header.MajorOperatingSystemVersion;
315 Header->MinorOperatingSystemVersion =
316 CP.Obj.OptionalHeader->Header.MinorOperatingSystemVersion;
317 Header->MajorImageVersion =
318 CP.Obj.OptionalHeader->Header.MajorImageVersion;
319 Header->MinorImageVersion =
320 CP.Obj.OptionalHeader->Header.MinorImageVersion;
321 Header->MajorSubsystemVersion =
322 CP.Obj.OptionalHeader->Header.MajorSubsystemVersion;
323 Header->MinorSubsystemVersion =
324 CP.Obj.OptionalHeader->Header.MinorSubsystemVersion;
325 Header->SizeOfImage = SizeOfImage;
326 Header->SizeOfHeaders = SizeOfHeaders;
327 Header->Subsystem = CP.Obj.OptionalHeader->Header.Subsystem;
328 Header->DLLCharacteristics = CP.Obj.OptionalHeader->Header.DLLCharacteristics;
329 Header->SizeOfStackReserve = CP.Obj.OptionalHeader->Header.SizeOfStackReserve;
330 Header->SizeOfStackCommit = CP.Obj.OptionalHeader->Header.SizeOfStackCommit;
331 Header->SizeOfHeapReserve = CP.Obj.OptionalHeader->Header.SizeOfHeapReserve;
332 Header->SizeOfHeapCommit = CP.Obj.OptionalHeader->Header.SizeOfHeapCommit;
333 Header->NumberOfRvaAndSize = COFF::NUM_DATA_DIRECTORIES + 1;
336 static bool writeCOFF(COFFParser &CP, raw_ostream &OS) {
338 // PE files start with a DOS stub.
339 object::dos_header DH;
340 memset(&DH, 0, sizeof(DH));
342 // DOS EXEs start with "MZ" magic.
345 // Initializing the AddressOfRelocationTable is strictly optional but
346 // mollifies certain tools which expect it to have a value greater than
348 DH.AddressOfRelocationTable = sizeof(DH);
349 // This is the address of the PE signature.
350 DH.AddressOfNewExeHeader = 128;
352 // Write out our DOS stub.
353 OS.write(reinterpret_cast<char *>(&DH), sizeof(DH));
354 // Write padding until we reach the position of where our PE signature
356 OS << num_zeros(DH.AddressOfNewExeHeader - sizeof(DH));
357 // Write out the PE signature.
358 OS.write(COFF::PEMagic, sizeof(COFF::PEMagic));
360 if (CP.useBigObj()) {
361 OS << binary_le(static_cast<uint16_t>(COFF::IMAGE_FILE_MACHINE_UNKNOWN))
362 << binary_le(static_cast<uint16_t>(0xffff))
363 << binary_le(static_cast<uint16_t>(COFF::BigObjHeader::MinBigObjectVersion))
364 << binary_le(CP.Obj.Header.Machine)
365 << binary_le(CP.Obj.Header.TimeDateStamp);
366 OS.write(COFF::BigObjMagic, sizeof(COFF::BigObjMagic));
367 OS << zeros(uint32_t(0))
368 << zeros(uint32_t(0))
369 << zeros(uint32_t(0))
370 << zeros(uint32_t(0))
371 << binary_le(CP.Obj.Header.NumberOfSections)
372 << binary_le(CP.Obj.Header.PointerToSymbolTable)
373 << binary_le(CP.Obj.Header.NumberOfSymbols);
375 OS << binary_le(CP.Obj.Header.Machine)
376 << binary_le(static_cast<int16_t>(CP.Obj.Header.NumberOfSections))
377 << binary_le(CP.Obj.Header.TimeDateStamp)
378 << binary_le(CP.Obj.Header.PointerToSymbolTable)
379 << binary_le(CP.Obj.Header.NumberOfSymbols)
380 << binary_le(CP.Obj.Header.SizeOfOptionalHeader)
381 << binary_le(CP.Obj.Header.Characteristics);
385 object::pe32plus_header PEH;
386 initializeOptionalHeader(CP, COFF::PE32Header::PE32_PLUS, &PEH);
387 OS.write(reinterpret_cast<char *>(&PEH), sizeof(PEH));
389 object::pe32_header PEH;
390 initializeOptionalHeader(CP, COFF::PE32Header::PE32, &PEH);
391 OS.write(reinterpret_cast<char *>(&PEH), sizeof(PEH));
393 for (const Optional<COFF::DataDirectory> &DD :
394 CP.Obj.OptionalHeader->DataDirectories) {
395 if (!DD.hasValue()) {
396 OS << zeros(uint32_t(0));
397 OS << zeros(uint32_t(0));
399 OS << binary_le(DD->RelativeVirtualAddress);
400 OS << binary_le(DD->Size);
403 OS << zeros(uint32_t(0));
404 OS << zeros(uint32_t(0));
407 // Output section table.
408 for (std::vector<COFFYAML::Section>::iterator i = CP.Obj.Sections.begin(),
409 e = CP.Obj.Sections.end();
411 OS.write(i->Header.Name, COFF::NameSize);
412 OS << binary_le(i->Header.VirtualSize)
413 << binary_le(i->Header.VirtualAddress)
414 << binary_le(i->Header.SizeOfRawData)
415 << binary_le(i->Header.PointerToRawData)
416 << binary_le(i->Header.PointerToRelocations)
417 << binary_le(i->Header.PointerToLineNumbers)
418 << binary_le(i->Header.NumberOfRelocations)
419 << binary_le(i->Header.NumberOfLineNumbers)
420 << binary_le(i->Header.Characteristics);
423 unsigned CurSymbol = 0;
424 StringMap<unsigned> SymbolTableIndexMap;
425 for (std::vector<COFFYAML::Symbol>::iterator I = CP.Obj.Symbols.begin(),
426 E = CP.Obj.Symbols.end();
428 SymbolTableIndexMap[I->Name] = CurSymbol;
429 CurSymbol += 1 + I->Header.NumberOfAuxSymbols;
432 // Output section data.
433 for (const COFFYAML::Section &S : CP.Obj.Sections) {
434 if (!S.Header.SizeOfRawData)
436 OS << num_zeros(S.Header.PointerToRawData - OS.tell());
437 S.SectionData.writeAsBinary(OS);
438 OS << num_zeros(S.Header.SizeOfRawData - S.SectionData.binary_size());
439 for (const COFFYAML::Relocation &R : S.Relocations) {
440 uint32_t SymbolTableIndex = SymbolTableIndexMap[R.SymbolName];
441 OS << binary_le(R.VirtualAddress)
442 << binary_le(SymbolTableIndex)
443 << binary_le(R.Type);
447 // Output symbol table.
449 for (std::vector<COFFYAML::Symbol>::const_iterator i = CP.Obj.Symbols.begin(),
450 e = CP.Obj.Symbols.end();
452 OS.write(i->Header.Name, COFF::NameSize);
453 OS << binary_le(i->Header.Value);
455 OS << binary_le(i->Header.SectionNumber);
457 OS << binary_le(static_cast<int16_t>(i->Header.SectionNumber));
458 OS << binary_le(i->Header.Type)
459 << binary_le(i->Header.StorageClass)
460 << binary_le(i->Header.NumberOfAuxSymbols);
462 if (i->FunctionDefinition)
463 OS << binary_le(i->FunctionDefinition->TagIndex)
464 << binary_le(i->FunctionDefinition->TotalSize)
465 << binary_le(i->FunctionDefinition->PointerToLinenumber)
466 << binary_le(i->FunctionDefinition->PointerToNextFunction)
467 << zeros(i->FunctionDefinition->unused)
468 << num_zeros(CP.getSymbolSize() - COFF::Symbol16Size);
469 if (i->bfAndefSymbol)
470 OS << zeros(i->bfAndefSymbol->unused1)
471 << binary_le(i->bfAndefSymbol->Linenumber)
472 << zeros(i->bfAndefSymbol->unused2)
473 << binary_le(i->bfAndefSymbol->PointerToNextFunction)
474 << zeros(i->bfAndefSymbol->unused3)
475 << num_zeros(CP.getSymbolSize() - COFF::Symbol16Size);
477 OS << binary_le(i->WeakExternal->TagIndex)
478 << binary_le(i->WeakExternal->Characteristics)
479 << zeros(i->WeakExternal->unused)
480 << num_zeros(CP.getSymbolSize() - COFF::Symbol16Size);
481 if (!i->File.empty()) {
482 unsigned SymbolSize = CP.getSymbolSize();
483 uint32_t NumberOfAuxRecords =
484 (i->File.size() + SymbolSize - 1) / SymbolSize;
485 uint32_t NumberOfAuxBytes = NumberOfAuxRecords * SymbolSize;
486 uint32_t NumZeros = NumberOfAuxBytes - i->File.size();
487 OS.write(i->File.data(), i->File.size());
488 OS << num_zeros(NumZeros);
490 if (i->SectionDefinition)
491 OS << binary_le(i->SectionDefinition->Length)
492 << binary_le(i->SectionDefinition->NumberOfRelocations)
493 << binary_le(i->SectionDefinition->NumberOfLinenumbers)
494 << binary_le(i->SectionDefinition->CheckSum)
495 << binary_le(static_cast<int16_t>(i->SectionDefinition->Number))
496 << binary_le(i->SectionDefinition->Selection)
497 << zeros(i->SectionDefinition->unused)
498 << binary_le(static_cast<int16_t>(i->SectionDefinition->Number >> 16))
499 << num_zeros(CP.getSymbolSize() - COFF::Symbol16Size);
501 OS << binary_le(i->CLRToken->AuxType)
502 << zeros(i->CLRToken->unused1)
503 << binary_le(i->CLRToken->SymbolTableIndex)
504 << zeros(i->CLRToken->unused2)
505 << num_zeros(CP.getSymbolSize() - COFF::Symbol16Size);
508 // Output string table.
509 if (CP.Obj.Header.PointerToSymbolTable)
510 OS.write(&CP.StringTable[0], CP.StringTable.size());
514 int yaml2coff(yaml::Input &YIn, raw_ostream &Out) {
515 COFFYAML::Object Doc;
518 errs() << "yaml2obj: Failed to parse YAML file!\n";
524 errs() << "yaml2obj: Failed to parse YAML file!\n";
528 if (!layoutOptionalHeader(CP)) {
529 errs() << "yaml2obj: Failed to layout optional header for COFF file!\n";
532 if (!layoutCOFF(CP)) {
533 errs() << "yaml2obj: Failed to layout COFF file!\n";
536 if (!writeCOFF(CP, Out)) {
537 errs() << "yaml2obj: Failed to write COFF file!\n";