1 //===-- ObjectFileMachO.h ---------------------------------------*- C++ -*-===// 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 #ifndef liblldb_ObjectFileMachO_h_ 10 #define liblldb_ObjectFileMachO_h_ 11 12 #include "lldb/Core/Address.h" 13 #include "lldb/Core/FileSpecList.h" 14 #include "lldb/Host/SafeMachO.h" 15 #include "lldb/Symbol/ObjectFile.h" 16 #include "lldb/Utility/FileSpec.h" 17 #include "lldb/Utility/RangeMap.h" 18 #include "lldb/Utility/UUID.h" 19 20 // This class needs to be hidden as eventually belongs in a plugin that 21 // will export the ObjectFile protocol 22 class ObjectFileMachO : public lldb_private::ObjectFile { 23 public: 24 ObjectFileMachO(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, 25 lldb::offset_t data_offset, 26 const lldb_private::FileSpec *file, lldb::offset_t offset, 27 lldb::offset_t length); 28 29 ObjectFileMachO(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, 30 const lldb::ProcessSP &process_sp, lldb::addr_t header_addr); 31 32 ~ObjectFileMachO() override = default; 33 34 // Static Functions 35 static void Initialize(); 36 37 static void Terminate(); 38 39 static lldb_private::ConstString GetPluginNameStatic(); 40 41 static const char *GetPluginDescriptionStatic(); 42 43 static lldb_private::ObjectFile * 44 CreateInstance(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, 45 lldb::offset_t data_offset, const lldb_private::FileSpec *file, 46 lldb::offset_t file_offset, lldb::offset_t length); 47 48 static lldb_private::ObjectFile *CreateMemoryInstance( 49 const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, 50 const lldb::ProcessSP &process_sp, lldb::addr_t header_addr); 51 52 static size_t GetModuleSpecifications(const lldb_private::FileSpec &file, 53 lldb::DataBufferSP &data_sp, 54 lldb::offset_t data_offset, 55 lldb::offset_t file_offset, 56 lldb::offset_t length, 57 lldb_private::ModuleSpecList &specs); 58 59 static bool SaveCore(const lldb::ProcessSP &process_sp, 60 const lldb_private::FileSpec &outfile, 61 lldb_private::Status &error); 62 63 static bool MagicBytesMatch(lldb::DataBufferSP &data_sp, lldb::addr_t offset, 64 lldb::addr_t length); 65 66 // LLVM RTTI support 67 static char ID; 68 bool isA(const void *ClassID) const override { 69 return ClassID == &ID || ObjectFile::isA(ClassID); 70 } 71 static bool classof(const ObjectFile *obj) { return obj->isA(&ID); } 72 73 // Member Functions 74 bool ParseHeader() override; 75 76 bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value, 77 bool value_is_offset) override; 78 79 lldb::ByteOrder GetByteOrder() const override; 80 81 bool IsExecutable() const override; 82 83 bool IsDynamicLoader() const; 84 85 uint32_t GetAddressByteSize() const override; 86 87 lldb_private::AddressClass GetAddressClass(lldb::addr_t file_addr) override; 88 89 lldb_private::Symtab *GetSymtab() override; 90 91 bool IsStripped() override; 92 93 void CreateSections(lldb_private::SectionList &unified_section_list) override; 94 95 void Dump(lldb_private::Stream *s) override; 96 97 lldb_private::ArchSpec GetArchitecture() override; 98 99 lldb_private::UUID GetUUID() override; 100 101 uint32_t GetDependentModules(lldb_private::FileSpecList &files) override; 102 103 lldb_private::FileSpecList GetReExportedLibraries() override { 104 return m_reexported_dylibs; 105 } 106 107 lldb_private::Address GetEntryPointAddress() override; 108 109 lldb_private::Address GetBaseAddress() override; 110 111 uint32_t GetNumThreadContexts() override; 112 113 std::string GetIdentifierString() override; 114 115 bool GetCorefileMainBinaryInfo (lldb::addr_t &address, lldb_private::UUID &uuid) override; 116 117 lldb::RegisterContextSP 118 GetThreadContextAtIndex(uint32_t idx, lldb_private::Thread &thread) override; 119 120 ObjectFile::Type CalculateType() override; 121 122 ObjectFile::Strata CalculateStrata() override; 123 124 llvm::VersionTuple GetVersion() override; 125 126 llvm::VersionTuple GetMinimumOSVersion() override; 127 128 llvm::VersionTuple GetSDKVersion() override; 129 130 bool GetIsDynamicLinkEditor() override; 131 132 static bool ParseHeader(lldb_private::DataExtractor &data, 133 lldb::offset_t *data_offset_ptr, 134 llvm::MachO::mach_header &header); 135 136 bool AllowAssemblyEmulationUnwindPlans() override; 137 138 // PluginInterface protocol 139 lldb_private::ConstString GetPluginName() override; 140 141 uint32_t GetPluginVersion() override; 142 143 protected: 144 static lldb_private::UUID 145 GetUUID(const llvm::MachO::mach_header &header, 146 const lldb_private::DataExtractor &data, 147 lldb::offset_t lc_offset); // Offset to the first load command 148 149 static lldb_private::ArchSpec GetArchitecture( 150 lldb::ModuleSP module_sp, const llvm::MachO::mach_header &header, 151 const lldb_private::DataExtractor &data, lldb::offset_t lc_offset); 152 153 /// Enumerate all ArchSpecs supported by this Mach-O file. 154 /// 155 /// On macOS one Mach-O slice can contain multiple load commands: 156 /// One load command for being loaded into a macOS process and one 157 /// load command for being loaded into a macCatalyst process. In 158 /// contrast to ObjectContainerUniversalMachO, this is the same 159 /// binary that can be loaded into different contexts. 160 static void GetAllArchSpecs(const llvm::MachO::mach_header &header, 161 const lldb_private::DataExtractor &data, 162 lldb::offset_t lc_offset, 163 lldb_private::ModuleSpec &base_spec, 164 lldb_private::ModuleSpecList &all_specs); 165 166 /// Intended for same-host arm device debugging where lldb needs to 167 /// detect libraries in the shared cache and augment the nlist entries 168 /// with an on-disk dyld_shared_cache file. The process will record 169 /// the shared cache UUID so the on-disk cache can be matched or rejected 170 /// correctly. 171 void GetProcessSharedCacheUUID(lldb_private::Process *, 172 lldb::addr_t &base_addr, 173 lldb_private::UUID &uuid); 174 175 /// Intended for same-host arm device debugging where lldb will read 176 /// shared cache libraries out of its own memory instead of the remote 177 /// process' memory as an optimization. If lldb's shared cache UUID 178 /// does not match the process' shared cache UUID, this optimization 179 /// should not be used. 180 void GetLLDBSharedCacheUUID(lldb::addr_t &base_addir, lldb_private::UUID &uuid); 181 182 lldb_private::Section *GetMachHeaderSection(); 183 184 lldb::addr_t CalculateSectionLoadAddressForMemoryImage( 185 lldb::addr_t mach_header_load_address, 186 const lldb_private::Section *mach_header_section, 187 const lldb_private::Section *section); 188 189 lldb_private::UUID 190 GetSharedCacheUUID(lldb_private::FileSpec dyld_shared_cache, 191 const lldb::ByteOrder byte_order, 192 const uint32_t addr_byte_size); 193 194 size_t ParseSymtab(); 195 196 typedef lldb_private::RangeArray<uint32_t, uint32_t, 8> EncryptedFileRanges; 197 EncryptedFileRanges GetEncryptedFileRanges(); 198 199 struct SegmentParsingContext; 200 void ProcessDysymtabCommand(const llvm::MachO::load_command &load_cmd, 201 lldb::offset_t offset); 202 void ProcessSegmentCommand(const llvm::MachO::load_command &load_cmd, 203 lldb::offset_t offset, uint32_t cmd_idx, 204 SegmentParsingContext &context); 205 void SanitizeSegmentCommand(llvm::MachO::segment_command_64 &seg_cmd, 206 uint32_t cmd_idx); 207 208 bool SectionIsLoadable(const lldb_private::Section *section); 209 210 llvm::MachO::mach_header m_header; 211 static lldb_private::ConstString GetSegmentNameTEXT(); 212 static lldb_private::ConstString GetSegmentNameDATA(); 213 static lldb_private::ConstString GetSegmentNameDATA_DIRTY(); 214 static lldb_private::ConstString GetSegmentNameDATA_CONST(); 215 static lldb_private::ConstString GetSegmentNameOBJC(); 216 static lldb_private::ConstString GetSegmentNameLINKEDIT(); 217 static lldb_private::ConstString GetSegmentNameDWARF(); 218 static lldb_private::ConstString GetSectionNameEHFrame(); 219 220 llvm::MachO::dysymtab_command m_dysymtab; 221 std::vector<llvm::MachO::segment_command_64> m_mach_segments; 222 std::vector<llvm::MachO::section_64> m_mach_sections; 223 llvm::Optional<llvm::VersionTuple> m_min_os_version; 224 llvm::Optional<llvm::VersionTuple> m_sdk_versions; 225 typedef lldb_private::RangeVector<uint32_t, uint32_t> FileRangeArray; 226 lldb_private::Address m_entry_point_address; 227 FileRangeArray m_thread_context_offsets; 228 bool m_thread_context_offsets_valid; 229 lldb_private::FileSpecList m_reexported_dylibs; 230 bool m_allow_assembly_emulation_unwind_plans; 231 }; 232 233 #endif // liblldb_ObjectFileMachO_h_ 234