NFC: Refactor library-specific mappings of scalar maths functions to their vector...
[llvm-core.git] / tools / yaml2obj / yaml2macho.cpp
blob2df03fd390128a950661adc31b27ce2c6a2e1644
1 //===- yaml2macho - Convert YAML to a Mach object file --------------------===//
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 /// \file
10 /// The Mach component of yaml2obj.
11 ///
12 //===----------------------------------------------------------------------===//
14 #include "yaml2obj.h"
15 #include "llvm/BinaryFormat/MachO.h"
16 #include "llvm/ObjectYAML/DWARFEmitter.h"
17 #include "llvm/ObjectYAML/ObjectYAML.h"
18 #include "llvm/Support/Error.h"
19 #include "llvm/Support/LEB128.h"
20 #include "llvm/Support/YAMLTraits.h"
21 #include "llvm/Support/raw_ostream.h"
23 #include "llvm/Support/Format.h"
25 using namespace llvm;
27 namespace {
29 class MachOWriter {
30 public:
31 MachOWriter(MachOYAML::Object &Obj) : Obj(Obj), is64Bit(true), fileStart(0) {
32 is64Bit = Obj.Header.magic == MachO::MH_MAGIC_64 ||
33 Obj.Header.magic == MachO::MH_CIGAM_64;
34 memset(reinterpret_cast<void *>(&Header), 0, sizeof(MachO::mach_header_64));
37 Error writeMachO(raw_ostream &OS);
39 private:
40 Error writeHeader(raw_ostream &OS);
41 Error writeLoadCommands(raw_ostream &OS);
42 Error writeSectionData(raw_ostream &OS);
43 Error writeLinkEditData(raw_ostream &OS);
45 void writeBindOpcodes(raw_ostream &OS,
46 std::vector<MachOYAML::BindOpcode> &BindOpcodes);
47 // LinkEdit writers
48 Error writeRebaseOpcodes(raw_ostream &OS);
49 Error writeBasicBindOpcodes(raw_ostream &OS);
50 Error writeWeakBindOpcodes(raw_ostream &OS);
51 Error writeLazyBindOpcodes(raw_ostream &OS);
52 Error writeNameList(raw_ostream &OS);
53 Error writeStringTable(raw_ostream &OS);
54 Error writeExportTrie(raw_ostream &OS);
56 void dumpExportEntry(raw_ostream &OS, MachOYAML::ExportEntry &Entry);
57 void ZeroToOffset(raw_ostream &OS, size_t offset);
59 MachOYAML::Object &Obj;
60 bool is64Bit;
61 uint64_t fileStart;
63 MachO::mach_header_64 Header;
66 Error MachOWriter::writeMachO(raw_ostream &OS) {
67 fileStart = OS.tell();
68 if (auto Err = writeHeader(OS))
69 return Err;
70 if (auto Err = writeLoadCommands(OS))
71 return Err;
72 if (auto Err = writeSectionData(OS))
73 return Err;
74 return Error::success();
77 Error MachOWriter::writeHeader(raw_ostream &OS) {
78 Header.magic = Obj.Header.magic;
79 Header.cputype = Obj.Header.cputype;
80 Header.cpusubtype = Obj.Header.cpusubtype;
81 Header.filetype = Obj.Header.filetype;
82 Header.ncmds = Obj.Header.ncmds;
83 Header.sizeofcmds = Obj.Header.sizeofcmds;
84 Header.flags = Obj.Header.flags;
85 Header.reserved = Obj.Header.reserved;
87 if (Obj.IsLittleEndian != sys::IsLittleEndianHost)
88 MachO::swapStruct(Header);
90 auto header_size =
91 is64Bit ? sizeof(MachO::mach_header_64) : sizeof(MachO::mach_header);
92 OS.write((const char *)&Header, header_size);
94 return Error::success();
97 template <typename SectionType>
98 SectionType constructSection(MachOYAML::Section Sec) {
99 SectionType TempSec;
100 memcpy(reinterpret_cast<void *>(&TempSec.sectname[0]), &Sec.sectname[0], 16);
101 memcpy(reinterpret_cast<void *>(&TempSec.segname[0]), &Sec.segname[0], 16);
102 TempSec.addr = Sec.addr;
103 TempSec.size = Sec.size;
104 TempSec.offset = Sec.offset;
105 TempSec.align = Sec.align;
106 TempSec.reloff = Sec.reloff;
107 TempSec.nreloc = Sec.nreloc;
108 TempSec.flags = Sec.flags;
109 TempSec.reserved1 = Sec.reserved1;
110 TempSec.reserved2 = Sec.reserved2;
111 return TempSec;
114 template <typename StructType>
115 size_t writeLoadCommandData(MachOYAML::LoadCommand &LC, raw_ostream &OS,
116 bool IsLittleEndian) {
117 return 0;
120 template <>
121 size_t writeLoadCommandData<MachO::segment_command>(MachOYAML::LoadCommand &LC,
122 raw_ostream &OS,
123 bool IsLittleEndian) {
124 size_t BytesWritten = 0;
125 for (const auto &Sec : LC.Sections) {
126 auto TempSec = constructSection<MachO::section>(Sec);
127 if (IsLittleEndian != sys::IsLittleEndianHost)
128 MachO::swapStruct(TempSec);
129 OS.write(reinterpret_cast<const char *>(&(TempSec)),
130 sizeof(MachO::section));
131 BytesWritten += sizeof(MachO::section);
133 return BytesWritten;
136 template <>
137 size_t writeLoadCommandData<MachO::segment_command_64>(
138 MachOYAML::LoadCommand &LC, raw_ostream &OS, bool IsLittleEndian) {
139 size_t BytesWritten = 0;
140 for (const auto &Sec : LC.Sections) {
141 auto TempSec = constructSection<MachO::section_64>(Sec);
142 TempSec.reserved3 = Sec.reserved3;
143 if (IsLittleEndian != sys::IsLittleEndianHost)
144 MachO::swapStruct(TempSec);
145 OS.write(reinterpret_cast<const char *>(&(TempSec)),
146 sizeof(MachO::section_64));
147 BytesWritten += sizeof(MachO::section_64);
149 return BytesWritten;
152 size_t writePayloadString(MachOYAML::LoadCommand &LC, raw_ostream &OS) {
153 size_t BytesWritten = 0;
154 if (!LC.PayloadString.empty()) {
155 OS.write(LC.PayloadString.c_str(), LC.PayloadString.length());
156 BytesWritten = LC.PayloadString.length();
158 return BytesWritten;
161 template <>
162 size_t writeLoadCommandData<MachO::dylib_command>(MachOYAML::LoadCommand &LC,
163 raw_ostream &OS,
164 bool IsLittleEndian) {
165 return writePayloadString(LC, OS);
168 template <>
169 size_t writeLoadCommandData<MachO::dylinker_command>(MachOYAML::LoadCommand &LC,
170 raw_ostream &OS,
171 bool IsLittleEndian) {
172 return writePayloadString(LC, OS);
175 template <>
176 size_t writeLoadCommandData<MachO::rpath_command>(MachOYAML::LoadCommand &LC,
177 raw_ostream &OS,
178 bool IsLittleEndian) {
179 return writePayloadString(LC, OS);
182 template <>
183 size_t writeLoadCommandData<MachO::build_version_command>(
184 MachOYAML::LoadCommand &LC, raw_ostream &OS, bool IsLittleEndian) {
185 size_t BytesWritten = 0;
186 for (const auto &T : LC.Tools) {
187 struct MachO::build_tool_version tool = T;
188 if (IsLittleEndian != sys::IsLittleEndianHost)
189 MachO::swapStruct(tool);
190 OS.write(reinterpret_cast<const char *>(&tool),
191 sizeof(MachO::build_tool_version));
192 BytesWritten += sizeof(MachO::build_tool_version);
194 return BytesWritten;
197 void ZeroFillBytes(raw_ostream &OS, size_t Size) {
198 std::vector<uint8_t> FillData;
199 FillData.insert(FillData.begin(), Size, 0);
200 OS.write(reinterpret_cast<char *>(FillData.data()), Size);
203 void Fill(raw_ostream &OS, size_t Size, uint32_t Data) {
204 std::vector<uint32_t> FillData;
205 FillData.insert(FillData.begin(), (Size / 4) + 1, Data);
206 OS.write(reinterpret_cast<char *>(FillData.data()), Size);
209 void MachOWriter::ZeroToOffset(raw_ostream &OS, size_t Offset) {
210 auto currOffset = OS.tell() - fileStart;
211 if (currOffset < Offset)
212 ZeroFillBytes(OS, Offset - currOffset);
215 Error MachOWriter::writeLoadCommands(raw_ostream &OS) {
216 for (auto &LC : Obj.LoadCommands) {
217 size_t BytesWritten = 0;
218 llvm::MachO::macho_load_command Data = LC.Data;
220 #define HANDLE_LOAD_COMMAND(LCName, LCValue, LCStruct) \
221 case MachO::LCName: \
222 if (Obj.IsLittleEndian != sys::IsLittleEndianHost) \
223 MachO::swapStruct(Data.LCStruct##_data); \
224 OS.write(reinterpret_cast<const char *>(&(Data.LCStruct##_data)), \
225 sizeof(MachO::LCStruct)); \
226 BytesWritten = sizeof(MachO::LCStruct); \
227 BytesWritten += \
228 writeLoadCommandData<MachO::LCStruct>(LC, OS, Obj.IsLittleEndian); \
229 break;
231 switch (LC.Data.load_command_data.cmd) {
232 default:
233 if (Obj.IsLittleEndian != sys::IsLittleEndianHost)
234 MachO::swapStruct(Data.load_command_data);
235 OS.write(reinterpret_cast<const char *>(&(Data.load_command_data)),
236 sizeof(MachO::load_command));
237 BytesWritten = sizeof(MachO::load_command);
238 BytesWritten +=
239 writeLoadCommandData<MachO::load_command>(LC, OS, Obj.IsLittleEndian);
240 break;
241 #include "llvm/BinaryFormat/MachO.def"
244 if (LC.PayloadBytes.size() > 0) {
245 OS.write(reinterpret_cast<const char *>(LC.PayloadBytes.data()),
246 LC.PayloadBytes.size());
247 BytesWritten += LC.PayloadBytes.size();
250 if (LC.ZeroPadBytes > 0) {
251 ZeroFillBytes(OS, LC.ZeroPadBytes);
252 BytesWritten += LC.ZeroPadBytes;
255 // Fill remaining bytes with 0. This will only get hit in partially
256 // specified test cases.
257 auto BytesRemaining = LC.Data.load_command_data.cmdsize - BytesWritten;
258 if (BytesRemaining > 0) {
259 ZeroFillBytes(OS, BytesRemaining);
262 return Error::success();
265 Error MachOWriter::writeSectionData(raw_ostream &OS) {
266 bool FoundLinkEditSeg = false;
267 for (auto &LC : Obj.LoadCommands) {
268 switch (LC.Data.load_command_data.cmd) {
269 case MachO::LC_SEGMENT:
270 case MachO::LC_SEGMENT_64:
271 uint64_t segOff = is64Bit ? LC.Data.segment_command_64_data.fileoff
272 : LC.Data.segment_command_data.fileoff;
273 if (0 == strncmp(&LC.Data.segment_command_data.segname[0], "__LINKEDIT", 16)) {
274 FoundLinkEditSeg = true;
275 if (auto Err = writeLinkEditData(OS))
276 return Err;
278 for (auto &Sec : LC.Sections) {
279 ZeroToOffset(OS, Sec.offset);
280 // Zero Fill any data between the end of the last thing we wrote and the
281 // start of this section.
282 assert((OS.tell() - fileStart <= Sec.offset ||
283 Sec.offset == (uint32_t)0) &&
284 "Wrote too much data somewhere, section offsets don't line up.");
285 if (0 == strncmp(&Sec.segname[0], "__DWARF", 16)) {
286 if (0 == strncmp(&Sec.sectname[0], "__debug_str", 16)) {
287 DWARFYAML::EmitDebugStr(OS, Obj.DWARF);
288 } else if (0 == strncmp(&Sec.sectname[0], "__debug_abbrev", 16)) {
289 DWARFYAML::EmitDebugAbbrev(OS, Obj.DWARF);
290 } else if (0 == strncmp(&Sec.sectname[0], "__debug_aranges", 16)) {
291 DWARFYAML::EmitDebugAranges(OS, Obj.DWARF);
292 } else if (0 == strncmp(&Sec.sectname[0], "__debug_pubnames", 16)) {
293 DWARFYAML::EmitPubSection(OS, Obj.DWARF.PubNames,
294 Obj.IsLittleEndian);
295 } else if (0 == strncmp(&Sec.sectname[0], "__debug_pubtypes", 16)) {
296 DWARFYAML::EmitPubSection(OS, Obj.DWARF.PubTypes,
297 Obj.IsLittleEndian);
298 } else if (0 == strncmp(&Sec.sectname[0], "__debug_info", 16)) {
299 DWARFYAML::EmitDebugInfo(OS, Obj.DWARF);
300 } else if (0 == strncmp(&Sec.sectname[0], "__debug_line", 16)) {
301 DWARFYAML::EmitDebugLine(OS, Obj.DWARF);
303 } else {
304 // Fills section data with 0xDEADBEEF
305 Fill(OS, Sec.size, 0xDEADBEEFu);
308 uint64_t segSize = is64Bit ? LC.Data.segment_command_64_data.filesize
309 : LC.Data.segment_command_data.filesize;
310 ZeroToOffset(OS, segOff + segSize);
311 break;
314 // Old PPC Object Files didn't have __LINKEDIT segments, the data was just
315 // stuck at the end of the file.
316 if (!FoundLinkEditSeg) {
317 if (auto Err = writeLinkEditData(OS))
318 return Err;
320 return Error::success();
323 void MachOWriter::writeBindOpcodes(
324 raw_ostream &OS, std::vector<MachOYAML::BindOpcode> &BindOpcodes) {
326 for (auto Opcode : BindOpcodes) {
327 uint8_t OpByte = Opcode.Opcode | Opcode.Imm;
328 OS.write(reinterpret_cast<char *>(&OpByte), 1);
329 for (auto Data : Opcode.ULEBExtraData) {
330 encodeULEB128(Data, OS);
332 for (auto Data : Opcode.SLEBExtraData) {
333 encodeSLEB128(Data, OS);
335 if (!Opcode.Symbol.empty()) {
336 OS.write(Opcode.Symbol.data(), Opcode.Symbol.size());
337 OS.write('\0');
342 void MachOWriter::dumpExportEntry(raw_ostream &OS,
343 MachOYAML::ExportEntry &Entry) {
344 encodeSLEB128(Entry.TerminalSize, OS);
345 if (Entry.TerminalSize > 0) {
346 encodeSLEB128(Entry.Flags, OS);
347 if (Entry.Flags & MachO::EXPORT_SYMBOL_FLAGS_REEXPORT) {
348 encodeSLEB128(Entry.Other, OS);
349 OS << Entry.ImportName;
350 OS.write('\0');
351 } else {
352 encodeSLEB128(Entry.Address, OS);
353 if (Entry.Flags & MachO::EXPORT_SYMBOL_FLAGS_STUB_AND_RESOLVER)
354 encodeSLEB128(Entry.Other, OS);
357 OS.write(static_cast<uint8_t>(Entry.Children.size()));
358 for (auto EE : Entry.Children) {
359 OS << EE.Name;
360 OS.write('\0');
361 encodeSLEB128(EE.NodeOffset, OS);
363 for (auto EE : Entry.Children)
364 dumpExportEntry(OS, EE);
367 Error MachOWriter::writeExportTrie(raw_ostream &OS) {
368 dumpExportEntry(OS, Obj.LinkEdit.ExportTrie);
369 return Error::success();
372 template <typename NListType>
373 void writeNListEntry(MachOYAML::NListEntry &NLE, raw_ostream &OS,
374 bool IsLittleEndian) {
375 NListType ListEntry;
376 ListEntry.n_strx = NLE.n_strx;
377 ListEntry.n_type = NLE.n_type;
378 ListEntry.n_sect = NLE.n_sect;
379 ListEntry.n_desc = NLE.n_desc;
380 ListEntry.n_value = NLE.n_value;
382 if (IsLittleEndian != sys::IsLittleEndianHost)
383 MachO::swapStruct(ListEntry);
384 OS.write(reinterpret_cast<const char *>(&ListEntry), sizeof(NListType));
387 Error MachOWriter::writeLinkEditData(raw_ostream &OS) {
388 typedef Error (MachOWriter::*writeHandler)(raw_ostream &);
389 typedef std::pair<uint64_t, writeHandler> writeOperation;
390 std::vector<writeOperation> WriteQueue;
392 MachO::dyld_info_command *DyldInfoOnlyCmd = 0;
393 MachO::symtab_command *SymtabCmd = 0;
394 for (auto &LC : Obj.LoadCommands) {
395 switch (LC.Data.load_command_data.cmd) {
396 case MachO::LC_SYMTAB:
397 SymtabCmd = &LC.Data.symtab_command_data;
398 WriteQueue.push_back(
399 std::make_pair(SymtabCmd->symoff, &MachOWriter::writeNameList));
400 WriteQueue.push_back(
401 std::make_pair(SymtabCmd->stroff, &MachOWriter::writeStringTable));
402 break;
403 case MachO::LC_DYLD_INFO_ONLY:
404 DyldInfoOnlyCmd = &LC.Data.dyld_info_command_data;
405 WriteQueue.push_back(std::make_pair(DyldInfoOnlyCmd->rebase_off,
406 &MachOWriter::writeRebaseOpcodes));
407 WriteQueue.push_back(std::make_pair(DyldInfoOnlyCmd->bind_off,
408 &MachOWriter::writeBasicBindOpcodes));
409 WriteQueue.push_back(std::make_pair(DyldInfoOnlyCmd->weak_bind_off,
410 &MachOWriter::writeWeakBindOpcodes));
411 WriteQueue.push_back(std::make_pair(DyldInfoOnlyCmd->lazy_bind_off,
412 &MachOWriter::writeLazyBindOpcodes));
413 WriteQueue.push_back(std::make_pair(DyldInfoOnlyCmd->export_off,
414 &MachOWriter::writeExportTrie));
415 break;
419 llvm::sort(WriteQueue, [](const writeOperation &a, const writeOperation &b) {
420 return a.first < b.first;
423 for (auto writeOp : WriteQueue) {
424 ZeroToOffset(OS, writeOp.first);
425 if (auto Err = (this->*writeOp.second)(OS))
426 return Err;
429 return Error::success();
432 Error MachOWriter::writeRebaseOpcodes(raw_ostream &OS) {
433 MachOYAML::LinkEditData &LinkEdit = Obj.LinkEdit;
435 for (auto Opcode : LinkEdit.RebaseOpcodes) {
436 uint8_t OpByte = Opcode.Opcode | Opcode.Imm;
437 OS.write(reinterpret_cast<char *>(&OpByte), 1);
438 for (auto Data : Opcode.ExtraData) {
439 encodeULEB128(Data, OS);
442 return Error::success();
445 Error MachOWriter::writeBasicBindOpcodes(raw_ostream &OS) {
446 writeBindOpcodes(OS, Obj.LinkEdit.BindOpcodes);
447 return Error::success();
450 Error MachOWriter::writeWeakBindOpcodes(raw_ostream &OS) {
451 writeBindOpcodes(OS, Obj.LinkEdit.WeakBindOpcodes);
452 return Error::success();
455 Error MachOWriter::writeLazyBindOpcodes(raw_ostream &OS) {
456 writeBindOpcodes(OS, Obj.LinkEdit.LazyBindOpcodes);
457 return Error::success();
460 Error MachOWriter::writeNameList(raw_ostream &OS) {
461 for (auto NLE : Obj.LinkEdit.NameList) {
462 if (is64Bit)
463 writeNListEntry<MachO::nlist_64>(NLE, OS, Obj.IsLittleEndian);
464 else
465 writeNListEntry<MachO::nlist>(NLE, OS, Obj.IsLittleEndian);
467 return Error::success();
470 Error MachOWriter::writeStringTable(raw_ostream &OS) {
471 for (auto Str : Obj.LinkEdit.StringTable) {
472 OS.write(Str.data(), Str.size());
473 OS.write('\0');
475 return Error::success();
478 class UniversalWriter {
479 public:
480 UniversalWriter(yaml::YamlObjectFile &ObjectFile)
481 : ObjectFile(ObjectFile), fileStart(0) {}
483 Error writeMachO(raw_ostream &OS);
485 private:
486 Error writeFatHeader(raw_ostream &OS);
487 Error writeFatArchs(raw_ostream &OS);
489 void ZeroToOffset(raw_ostream &OS, size_t offset);
491 yaml::YamlObjectFile &ObjectFile;
492 uint64_t fileStart;
495 Error UniversalWriter::writeMachO(raw_ostream &OS) {
496 fileStart = OS.tell();
497 if (ObjectFile.MachO) {
498 MachOWriter Writer(*ObjectFile.MachO);
499 return Writer.writeMachO(OS);
501 if (auto Err = writeFatHeader(OS))
502 return Err;
503 if (auto Err = writeFatArchs(OS))
504 return Err;
505 auto &FatFile = *ObjectFile.FatMachO;
506 assert(FatFile.FatArchs.size() == FatFile.Slices.size());
507 for (size_t i = 0; i < FatFile.Slices.size(); i++) {
508 ZeroToOffset(OS, FatFile.FatArchs[i].offset);
509 MachOWriter Writer(FatFile.Slices[i]);
510 if (auto Err = Writer.writeMachO(OS))
511 return Err;
512 auto SliceEnd = FatFile.FatArchs[i].offset + FatFile.FatArchs[i].size;
513 ZeroToOffset(OS, SliceEnd);
515 return Error::success();
518 Error UniversalWriter::writeFatHeader(raw_ostream &OS) {
519 auto &FatFile = *ObjectFile.FatMachO;
520 MachO::fat_header header;
521 header.magic = FatFile.Header.magic;
522 header.nfat_arch = FatFile.Header.nfat_arch;
523 if (sys::IsLittleEndianHost)
524 swapStruct(header);
525 OS.write(reinterpret_cast<const char *>(&header), sizeof(MachO::fat_header));
526 return Error::success();
529 template <typename FatArchType>
530 FatArchType constructFatArch(MachOYAML::FatArch &Arch) {
531 FatArchType FatArch;
532 FatArch.cputype = Arch.cputype;
533 FatArch.cpusubtype = Arch.cpusubtype;
534 FatArch.offset = Arch.offset;
535 FatArch.size = Arch.size;
536 FatArch.align = Arch.align;
537 return FatArch;
540 template <typename StructType>
541 void writeFatArch(MachOYAML::FatArch &LC, raw_ostream &OS) {}
543 template <>
544 void writeFatArch<MachO::fat_arch>(MachOYAML::FatArch &Arch, raw_ostream &OS) {
545 auto FatArch = constructFatArch<MachO::fat_arch>(Arch);
546 if (sys::IsLittleEndianHost)
547 swapStruct(FatArch);
548 OS.write(reinterpret_cast<const char *>(&FatArch), sizeof(MachO::fat_arch));
551 template <>
552 void writeFatArch<MachO::fat_arch_64>(MachOYAML::FatArch &Arch,
553 raw_ostream &OS) {
554 auto FatArch = constructFatArch<MachO::fat_arch_64>(Arch);
555 FatArch.reserved = Arch.reserved;
556 if (sys::IsLittleEndianHost)
557 swapStruct(FatArch);
558 OS.write(reinterpret_cast<const char *>(&FatArch),
559 sizeof(MachO::fat_arch_64));
562 Error UniversalWriter::writeFatArchs(raw_ostream &OS) {
563 auto &FatFile = *ObjectFile.FatMachO;
564 bool is64Bit = FatFile.Header.magic == MachO::FAT_MAGIC_64;
565 for (auto Arch : FatFile.FatArchs) {
566 if (is64Bit)
567 writeFatArch<MachO::fat_arch_64>(Arch, OS);
568 else
569 writeFatArch<MachO::fat_arch>(Arch, OS);
572 return Error::success();
575 void UniversalWriter::ZeroToOffset(raw_ostream &OS, size_t Offset) {
576 auto currOffset = OS.tell() - fileStart;
577 if (currOffset < Offset)
578 ZeroFillBytes(OS, Offset - currOffset);
581 } // end anonymous namespace
583 int yaml2macho(yaml::YamlObjectFile &Doc, raw_ostream &Out) {
584 UniversalWriter Writer(Doc);
585 if (auto Err = Writer.writeMachO(Out)) {
586 errs() << toString(std::move(Err));
587 return 1;
589 return 0;