//===- MachOYAML.cpp - MachO YAMLIO implementation ------------------------===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// // // This file defines classes for handling the YAML representation of MachO. // //===----------------------------------------------------------------------===// #include "llvm/ObjectYAML/MachOYAML.h" #include "llvm/ADT/StringRef.h" #include "llvm/BinaryFormat/MachO.h" #include "llvm/Support/Format.h" #include "llvm/Support/YAMLTraits.h" #include "llvm/Support/raw_ostream.h" #include "llvm/TargetParser/Host.h" #include #include #include namespace llvm { MachOYAML::LoadCommand::~LoadCommand() = default; bool MachOYAML::LinkEditData::isEmpty() const { return 0 == RebaseOpcodes.size() + BindOpcodes.size() + WeakBindOpcodes.size() + LazyBindOpcodes.size() + ExportTrie.Children.size() + NameList.size() + StringTable.size() + FunctionStarts.size() + ChainedFixups.size() + DataInCode.size(); } namespace yaml { void ScalarTraits::output(const char_16 &Val, void *, raw_ostream &Out) { auto Len = strnlen(&Val[0], 16); Out << StringRef(&Val[0], Len); } StringRef ScalarTraits::input(StringRef Scalar, void *, char_16 &Val) { size_t CopySize = 16 >= Scalar.size() ? 16 : Scalar.size(); memcpy((void *)Val, Scalar.data(), CopySize); if (Scalar.size() < 16) { memset((void *)&Val[Scalar.size()], 0, 16 - Scalar.size()); } return StringRef(); } QuotingType ScalarTraits::mustQuote(StringRef S) { return needsQuotes(S); } void ScalarTraits::output(const uuid_t &Val, void *, raw_ostream &Out) { Out.write_uuid(Val); } StringRef ScalarTraits::input(StringRef Scalar, void *, uuid_t &Val) { size_t OutIdx = 0; for (size_t Idx = 0; Idx < Scalar.size(); ++Idx) { if (Scalar[Idx] == '-' || OutIdx >= 16) continue; unsigned long long TempInt; if (getAsUnsignedInteger(Scalar.slice(Idx, Idx + 2), 16, TempInt)) return "invalid number"; if (TempInt > 0xFF) return "out of range number"; Val[OutIdx] = static_cast(TempInt); ++Idx; // increment idx an extra time because we're consuming 2 chars ++OutIdx; } return StringRef(); } QuotingType ScalarTraits::mustQuote(StringRef S) { return needsQuotes(S); } void MappingTraits::mapping( IO &IO, MachOYAML::FileHeader &FileHdr) { IO.mapRequired("magic", FileHdr.magic); IO.mapRequired("cputype", FileHdr.cputype); IO.mapRequired("cpusubtype", FileHdr.cpusubtype); IO.mapRequired("filetype", FileHdr.filetype); IO.mapRequired("ncmds", FileHdr.ncmds); IO.mapRequired("sizeofcmds", FileHdr.sizeofcmds); IO.mapRequired("flags", FileHdr.flags); if (FileHdr.magic == MachO::MH_MAGIC_64 || FileHdr.magic == MachO::MH_CIGAM_64) IO.mapRequired("reserved", FileHdr.reserved); } void MappingTraits::mapping(IO &IO, MachOYAML::Object &Object) { // If the context isn't already set, tag the document as !mach-o. // For Fat files there will be a different tag so they can be differentiated. if (!IO.getContext()) { IO.setContext(&Object); } IO.mapTag("!mach-o", true); IO.mapOptional("IsLittleEndian", Object.IsLittleEndian, sys::IsLittleEndianHost); Object.DWARF.IsLittleEndian = Object.IsLittleEndian; IO.mapRequired("FileHeader", Object.Header); Object.DWARF.Is64BitAddrSize = Object.Header.magic == MachO::MH_MAGIC_64 || Object.Header.magic == MachO::MH_CIGAM_64; IO.mapOptional("LoadCommands", Object.LoadCommands); if (Object.RawLinkEditSegment || !IO.outputting()) IO.mapOptional("__LINKEDIT", Object.RawLinkEditSegment); if(!Object.LinkEdit.isEmpty() || !IO.outputting()) IO.mapOptional("LinkEditData", Object.LinkEdit); if(!Object.DWARF.isEmpty() || !IO.outputting()) IO.mapOptional("DWARF", Object.DWARF); if (IO.getContext() == &Object) IO.setContext(nullptr); } void MappingTraits::mapping( IO &IO, MachOYAML::FatHeader &FatHeader) { IO.mapRequired("magic", FatHeader.magic); IO.mapRequired("nfat_arch", FatHeader.nfat_arch); } void MappingTraits::mapping(IO &IO, MachOYAML::FatArch &FatArch) { IO.mapRequired("cputype", FatArch.cputype); IO.mapRequired("cpusubtype", FatArch.cpusubtype); IO.mapRequired("offset", FatArch.offset); IO.mapRequired("size", FatArch.size); IO.mapRequired("align", FatArch.align); IO.mapOptional("reserved", FatArch.reserved, static_cast(0)); } void MappingTraits::mapping( IO &IO, MachOYAML::UniversalBinary &UniversalBinary) { if (!IO.getContext()) { IO.setContext(&UniversalBinary); IO.mapTag("!fat-mach-o", true); } IO.mapRequired("FatHeader", UniversalBinary.Header); IO.mapRequired("FatArchs", UniversalBinary.FatArchs); IO.mapRequired("Slices", UniversalBinary.Slices); if (IO.getContext() == &UniversalBinary) IO.setContext(nullptr); } void MappingTraits::mapping( IO &IO, MachOYAML::LinkEditData &LinkEditData) { IO.mapOptional("RebaseOpcodes", LinkEditData.RebaseOpcodes); IO.mapOptional("BindOpcodes", LinkEditData.BindOpcodes); IO.mapOptional("WeakBindOpcodes", LinkEditData.WeakBindOpcodes); IO.mapOptional("LazyBindOpcodes", LinkEditData.LazyBindOpcodes); if (!LinkEditData.ExportTrie.Children.empty() || !IO.outputting()) IO.mapOptional("ExportTrie", LinkEditData.ExportTrie); IO.mapOptional("NameList", LinkEditData.NameList); IO.mapOptional("StringTable", LinkEditData.StringTable); IO.mapOptional("IndirectSymbols", LinkEditData.IndirectSymbols); IO.mapOptional("FunctionStarts", LinkEditData.FunctionStarts); IO.mapOptional("ChainedFixups", LinkEditData.ChainedFixups); IO.mapOptional("DataInCode", LinkEditData.DataInCode); } void MappingTraits::mapping( IO &IO, MachOYAML::RebaseOpcode &RebaseOpcode) { IO.mapRequired("Opcode", RebaseOpcode.Opcode); IO.mapRequired("Imm", RebaseOpcode.Imm); IO.mapOptional("ExtraData", RebaseOpcode.ExtraData); } void MappingTraits::mapping( IO &IO, MachOYAML::BindOpcode &BindOpcode) { IO.mapRequired("Opcode", BindOpcode.Opcode); IO.mapRequired("Imm", BindOpcode.Imm); IO.mapOptional("ULEBExtraData", BindOpcode.ULEBExtraData); IO.mapOptional("SLEBExtraData", BindOpcode.SLEBExtraData); IO.mapOptional("Symbol", BindOpcode.Symbol); } void MappingTraits::mapping( IO &IO, MachOYAML::ExportEntry &ExportEntry) { IO.mapRequired("TerminalSize", ExportEntry.TerminalSize); IO.mapOptional("NodeOffset", ExportEntry.NodeOffset); IO.mapOptional("Name", ExportEntry.Name); IO.mapOptional("Flags", ExportEntry.Flags); IO.mapOptional("Address", ExportEntry.Address); IO.mapOptional("Other", ExportEntry.Other); IO.mapOptional("ImportName", ExportEntry.ImportName); IO.mapOptional("Children", ExportEntry.Children); } void MappingTraits::mapping( IO &IO, MachOYAML::NListEntry &NListEntry) { IO.mapRequired("n_strx", NListEntry.n_strx); IO.mapRequired("n_type", NListEntry.n_type); IO.mapRequired("n_sect", NListEntry.n_sect); IO.mapRequired("n_desc", NListEntry.n_desc); IO.mapRequired("n_value", NListEntry.n_value); } void MappingTraits::mapping( IO &IO, MachOYAML::DataInCodeEntry &DataInCodeEntry) { IO.mapRequired("Offset", DataInCodeEntry.Offset); IO.mapRequired("Length", DataInCodeEntry.Length); IO.mapRequired("Kind", DataInCodeEntry.Kind); } template void mapLoadCommandData(IO &IO, MachOYAML::LoadCommand &LoadCommand) {} template <> void mapLoadCommandData( IO &IO, MachOYAML::LoadCommand &LoadCommand) { IO.mapOptional("Sections", LoadCommand.Sections); } template <> void mapLoadCommandData( IO &IO, MachOYAML::LoadCommand &LoadCommand) { IO.mapOptional("Sections", LoadCommand.Sections); } template <> void mapLoadCommandData( IO &IO, MachOYAML::LoadCommand &LoadCommand) { IO.mapOptional("Content", LoadCommand.Content); } template <> void mapLoadCommandData( IO &IO, MachOYAML::LoadCommand &LoadCommand) { IO.mapOptional("Content", LoadCommand.Content); } template <> void mapLoadCommandData( IO &IO, MachOYAML::LoadCommand &LoadCommand) { IO.mapOptional("Content", LoadCommand.Content); } template <> void mapLoadCommandData( IO &IO, MachOYAML::LoadCommand &LoadCommand) { IO.mapOptional("Content", LoadCommand.Content); } template <> void mapLoadCommandData( IO &IO, MachOYAML::LoadCommand &LoadCommand) { IO.mapOptional("Content", LoadCommand.Content); } template <> void mapLoadCommandData( IO &IO, MachOYAML::LoadCommand &LoadCommand) { IO.mapOptional("Content", LoadCommand.Content); } template <> void mapLoadCommandData( IO &IO, MachOYAML::LoadCommand &LoadCommand) { IO.mapOptional("Content", LoadCommand.Content); } template <> void mapLoadCommandData( IO &IO, MachOYAML::LoadCommand &LoadCommand) { IO.mapOptional("Tools", LoadCommand.Tools); } void MappingTraits::mapping( IO &IO, MachOYAML::LoadCommand &LoadCommand) { MachO::LoadCommandType TempCmd = static_cast( LoadCommand.Data.load_command_data.cmd); IO.mapRequired("cmd", TempCmd); LoadCommand.Data.load_command_data.cmd = TempCmd; IO.mapRequired("cmdsize", LoadCommand.Data.load_command_data.cmdsize); #define HANDLE_LOAD_COMMAND(LCName, LCValue, LCStruct) \ case MachO::LCName: \ MappingTraits::mapping(IO, \ LoadCommand.Data.LCStruct##_data); \ mapLoadCommandData(IO, LoadCommand); \ break; switch (LoadCommand.Data.load_command_data.cmd) { #include "llvm/BinaryFormat/MachO.def" } IO.mapOptional("PayloadBytes", LoadCommand.PayloadBytes); IO.mapOptional("ZeroPadBytes", LoadCommand.ZeroPadBytes, (uint64_t)0ull); } void MappingTraits::mapping( IO &IO, MachO::dyld_info_command &LoadCommand) { IO.mapRequired("rebase_off", LoadCommand.rebase_off); IO.mapRequired("rebase_size", LoadCommand.rebase_size); IO.mapRequired("bind_off", LoadCommand.bind_off); IO.mapRequired("bind_size", LoadCommand.bind_size); IO.mapRequired("weak_bind_off", LoadCommand.weak_bind_off); IO.mapRequired("weak_bind_size", LoadCommand.weak_bind_size); IO.mapRequired("lazy_bind_off", LoadCommand.lazy_bind_off); IO.mapRequired("lazy_bind_size", LoadCommand.lazy_bind_size); IO.mapRequired("export_off", LoadCommand.export_off); IO.mapRequired("export_size", LoadCommand.export_size); } void MappingTraits::mapping( IO &IO, MachOYAML::Relocation &Relocation) { IO.mapRequired("address", Relocation.address); IO.mapRequired("symbolnum", Relocation.symbolnum); IO.mapRequired("pcrel", Relocation.is_pcrel); IO.mapRequired("length", Relocation.length); IO.mapRequired("extern", Relocation.is_extern); IO.mapRequired("type", Relocation.type); IO.mapRequired("scattered", Relocation.is_scattered); IO.mapRequired("value", Relocation.value); } void MappingTraits::mapping(IO &IO, MachOYAML::Section &Section) { IO.mapRequired("sectname", Section.sectname); IO.mapRequired("segname", Section.segname); IO.mapRequired("addr", Section.addr); IO.mapRequired("size", Section.size); IO.mapRequired("offset", Section.offset); IO.mapRequired("align", Section.align); IO.mapRequired("reloff", Section.reloff); IO.mapRequired("nreloc", Section.nreloc); IO.mapRequired("flags", Section.flags); IO.mapRequired("reserved1", Section.reserved1); IO.mapRequired("reserved2", Section.reserved2); IO.mapOptional("reserved3", Section.reserved3); IO.mapOptional("content", Section.content); IO.mapOptional("relocations", Section.relocations); } std::string MappingTraits::validate(IO &IO, MachOYAML::Section &Section) { if (Section.content && Section.size < Section.content->binary_size()) return "Section size must be greater than or equal to the content size"; return ""; } void MappingTraits::mapping( IO &IO, MachO::build_tool_version &tool) { IO.mapRequired("tool", tool.tool); IO.mapRequired("version", tool.version); } void MappingTraits::mapping(IO &IO, MachO::dylib &DylibStruct) { IO.mapRequired("name", DylibStruct.name); IO.mapRequired("timestamp", DylibStruct.timestamp); IO.mapRequired("current_version", DylibStruct.current_version); IO.mapRequired("compatibility_version", DylibStruct.compatibility_version); } void MappingTraits::mapping( IO &IO, MachO::dylib_command &LoadCommand) { IO.mapRequired("dylib", LoadCommand.dylib); } void MappingTraits::mapping( IO &IO, MachO::dylinker_command &LoadCommand) { IO.mapRequired("name", LoadCommand.name); } void MappingTraits::mapping( IO &IO, MachO::dysymtab_command &LoadCommand) { IO.mapRequired("ilocalsym", LoadCommand.ilocalsym); IO.mapRequired("nlocalsym", LoadCommand.nlocalsym); IO.mapRequired("iextdefsym", LoadCommand.iextdefsym); IO.mapRequired("nextdefsym", LoadCommand.nextdefsym); IO.mapRequired("iundefsym", LoadCommand.iundefsym); IO.mapRequired("nundefsym", LoadCommand.nundefsym); IO.mapRequired("tocoff", LoadCommand.tocoff); IO.mapRequired("ntoc", LoadCommand.ntoc); IO.mapRequired("modtaboff", LoadCommand.modtaboff); IO.mapRequired("nmodtab", LoadCommand.nmodtab); IO.mapRequired("extrefsymoff", LoadCommand.extrefsymoff); IO.mapRequired("nextrefsyms", LoadCommand.nextrefsyms); IO.mapRequired("indirectsymoff", LoadCommand.indirectsymoff); IO.mapRequired("nindirectsyms", LoadCommand.nindirectsyms); IO.mapRequired("extreloff", LoadCommand.extreloff); IO.mapRequired("nextrel", LoadCommand.nextrel); IO.mapRequired("locreloff", LoadCommand.locreloff); IO.mapRequired("nlocrel", LoadCommand.nlocrel); } void MappingTraits::mapping( IO &IO, MachO::encryption_info_command &LoadCommand) { IO.mapRequired("cryptoff", LoadCommand.cryptoff); IO.mapRequired("cryptsize", LoadCommand.cryptsize); IO.mapRequired("cryptid", LoadCommand.cryptid); } void MappingTraits::mapping( IO &IO, MachO::encryption_info_command_64 &LoadCommand) { IO.mapRequired("cryptoff", LoadCommand.cryptoff); IO.mapRequired("cryptsize", LoadCommand.cryptsize); IO.mapRequired("cryptid", LoadCommand.cryptid); IO.mapRequired("pad", LoadCommand.pad); } void MappingTraits::mapping( IO &IO, MachO::entry_point_command &LoadCommand) { IO.mapRequired("entryoff", LoadCommand.entryoff); IO.mapRequired("stacksize", LoadCommand.stacksize); } void MappingTraits::mapping( IO &IO, MachO::fvmfile_command &LoadCommand) { IO.mapRequired("name", LoadCommand.name); IO.mapRequired("header_addr", LoadCommand.header_addr); } void MappingTraits::mapping(IO &IO, MachO::fvmlib &FVMLib) { IO.mapRequired("name", FVMLib.name); IO.mapRequired("minor_version", FVMLib.minor_version); IO.mapRequired("header_addr", FVMLib.header_addr); } void MappingTraits::mapping( IO &IO, MachO::fvmlib_command &LoadCommand) { IO.mapRequired("fvmlib", LoadCommand.fvmlib); } void MappingTraits::mapping( IO &IO, MachO::ident_command &LoadCommand) {} void MappingTraits::mapping( IO &IO, MachO::linkedit_data_command &LoadCommand) { IO.mapRequired("dataoff", LoadCommand.dataoff); IO.mapRequired("datasize", LoadCommand.datasize); } void MappingTraits::mapping( IO &IO, MachO::linker_option_command &LoadCommand) { IO.mapRequired("count", LoadCommand.count); } void MappingTraits::mapping( IO &IO, MachO::prebind_cksum_command &LoadCommand) { IO.mapRequired("cksum", LoadCommand.cksum); } void MappingTraits::mapping( IO &IO, MachO::load_command &LoadCommand) {} void MappingTraits::mapping( IO &IO, MachO::prebound_dylib_command &LoadCommand) { IO.mapRequired("name", LoadCommand.name); IO.mapRequired("nmodules", LoadCommand.nmodules); IO.mapRequired("linked_modules", LoadCommand.linked_modules); } void MappingTraits::mapping( IO &IO, MachO::routines_command &LoadCommand) { IO.mapRequired("init_address", LoadCommand.init_address); IO.mapRequired("init_module", LoadCommand.init_module); IO.mapRequired("reserved1", LoadCommand.reserved1); IO.mapRequired("reserved2", LoadCommand.reserved2); IO.mapRequired("reserved3", LoadCommand.reserved3); IO.mapRequired("reserved4", LoadCommand.reserved4); IO.mapRequired("reserved5", LoadCommand.reserved5); IO.mapRequired("reserved6", LoadCommand.reserved6); } void MappingTraits::mapping( IO &IO, MachO::routines_command_64 &LoadCommand) { IO.mapRequired("init_address", LoadCommand.init_address); IO.mapRequired("init_module", LoadCommand.init_module); IO.mapRequired("reserved1", LoadCommand.reserved1); IO.mapRequired("reserved2", LoadCommand.reserved2); IO.mapRequired("reserved3", LoadCommand.reserved3); IO.mapRequired("reserved4", LoadCommand.reserved4); IO.mapRequired("reserved5", LoadCommand.reserved5); IO.mapRequired("reserved6", LoadCommand.reserved6); } void MappingTraits::mapping( IO &IO, MachO::rpath_command &LoadCommand) { IO.mapRequired("path", LoadCommand.path); } void MappingTraits::mapping(IO &IO, MachO::section &Section) { IO.mapRequired("sectname", Section.sectname); IO.mapRequired("segname", Section.segname); IO.mapRequired("addr", Section.addr); IO.mapRequired("size", Section.size); IO.mapRequired("offset", Section.offset); IO.mapRequired("align", Section.align); IO.mapRequired("reloff", Section.reloff); IO.mapRequired("nreloc", Section.nreloc); IO.mapRequired("flags", Section.flags); IO.mapRequired("reserved1", Section.reserved1); IO.mapRequired("reserved2", Section.reserved2); } void MappingTraits::mapping(IO &IO, MachO::section_64 &Section) { IO.mapRequired("sectname", Section.sectname); IO.mapRequired("segname", Section.segname); IO.mapRequired("addr", Section.addr); IO.mapRequired("size", Section.size); IO.mapRequired("offset", Section.offset); IO.mapRequired("align", Section.align); IO.mapRequired("reloff", Section.reloff); IO.mapRequired("nreloc", Section.nreloc); IO.mapRequired("flags", Section.flags); IO.mapRequired("reserved1", Section.reserved1); IO.mapRequired("reserved2", Section.reserved2); IO.mapRequired("reserved3", Section.reserved3); } void MappingTraits::mapping( IO &IO, MachO::segment_command &LoadCommand) { IO.mapRequired("segname", LoadCommand.segname); IO.mapRequired("vmaddr", LoadCommand.vmaddr); IO.mapRequired("vmsize", LoadCommand.vmsize); IO.mapRequired("fileoff", LoadCommand.fileoff); IO.mapRequired("filesize", LoadCommand.filesize); IO.mapRequired("maxprot", LoadCommand.maxprot); IO.mapRequired("initprot", LoadCommand.initprot); IO.mapRequired("nsects", LoadCommand.nsects); IO.mapRequired("flags", LoadCommand.flags); } void MappingTraits::mapping( IO &IO, MachO::segment_command_64 &LoadCommand) { IO.mapRequired("segname", LoadCommand.segname); IO.mapRequired("vmaddr", LoadCommand.vmaddr); IO.mapRequired("vmsize", LoadCommand.vmsize); IO.mapRequired("fileoff", LoadCommand.fileoff); IO.mapRequired("filesize", LoadCommand.filesize); IO.mapRequired("maxprot", LoadCommand.maxprot); IO.mapRequired("initprot", LoadCommand.initprot); IO.mapRequired("nsects", LoadCommand.nsects); IO.mapRequired("flags", LoadCommand.flags); } void MappingTraits::mapping( IO &IO, MachO::source_version_command &LoadCommand) { IO.mapRequired("version", LoadCommand.version); } void MappingTraits::mapping( IO &IO, MachO::sub_client_command &LoadCommand) { IO.mapRequired("client", LoadCommand.client); } void MappingTraits::mapping( IO &IO, MachO::sub_framework_command &LoadCommand) { IO.mapRequired("umbrella", LoadCommand.umbrella); } void MappingTraits::mapping( IO &IO, MachO::sub_library_command &LoadCommand) { IO.mapRequired("sub_library", LoadCommand.sub_library); } void MappingTraits::mapping( IO &IO, MachO::sub_umbrella_command &LoadCommand) { IO.mapRequired("sub_umbrella", LoadCommand.sub_umbrella); } void MappingTraits::mapping( IO &IO, MachO::symseg_command &LoadCommand) { IO.mapRequired("offset", LoadCommand.offset); IO.mapRequired("size", LoadCommand.size); } void MappingTraits::mapping( IO &IO, MachO::symtab_command &LoadCommand) { IO.mapRequired("symoff", LoadCommand.symoff); IO.mapRequired("nsyms", LoadCommand.nsyms); IO.mapRequired("stroff", LoadCommand.stroff); IO.mapRequired("strsize", LoadCommand.strsize); } void MappingTraits::mapping( IO &IO, MachO::thread_command &LoadCommand) {} void MappingTraits::mapping( IO &IO, MachO::twolevel_hints_command &LoadCommand) { IO.mapRequired("offset", LoadCommand.offset); IO.mapRequired("nhints", LoadCommand.nhints); } void MappingTraits::mapping( IO &IO, MachO::uuid_command &LoadCommand) { IO.mapRequired("uuid", LoadCommand.uuid); } void MappingTraits::mapping( IO &IO, MachO::version_min_command &LoadCommand) { IO.mapRequired("version", LoadCommand.version); IO.mapRequired("sdk", LoadCommand.sdk); } void MappingTraits::mapping( IO &IO, MachO::note_command &LoadCommand) { IO.mapRequired("data_owner", LoadCommand.data_owner); IO.mapRequired("offset", LoadCommand.offset); IO.mapRequired("size", LoadCommand.size); } void MappingTraits::mapping( IO &IO, MachO::build_version_command &LoadCommand) { IO.mapRequired("platform", LoadCommand.platform); IO.mapRequired("minos", LoadCommand.minos); IO.mapRequired("sdk", LoadCommand.sdk); IO.mapRequired("ntools", LoadCommand.ntools); } void MappingTraits::mapping( IO &IO, MachO::fileset_entry_command &LoadCommand) { IO.mapRequired("vmaddr", LoadCommand.vmaddr); IO.mapRequired("fileoff", LoadCommand.fileoff); IO.mapRequired("id", LoadCommand.entry_id); } } // end namespace yaml } // end namespace llvm