blob: 1185e1ec89955586efd3e775ac51e22792c32c18 [file] [log] [blame]
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001//===-- ObjectFileMachO.h ---------------------------------------*- C++ -*-===//
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
Chris Lattner30fdc8d2010-06-08 16:52:24 +00006//
7//===----------------------------------------------------------------------===//
8
9#ifndef liblldb_ObjectFileMachO_h_
10#define liblldb_ObjectFileMachO_h_
11
Jim Ingham672e6f52011-03-07 23:44:08 +000012#include "lldb/Core/Address.h"
Jim Inghamfbe0b9a2014-05-21 03:58:03 +000013#include "lldb/Core/FileSpecList.h"
Pavel Labath77044732018-09-12 12:26:05 +000014#include "lldb/Host/SafeMachO.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000015#include "lldb/Symbol/ObjectFile.h"
Zachary Turner5713a052017-03-22 18:40:07 +000016#include "lldb/Utility/FileSpec.h"
Pavel Labathb8093312019-03-06 14:41:43 +000017#include "lldb/Utility/RangeMap.h"
Jason Molenda9b7fcdc2017-04-12 23:33:30 +000018#include "lldb/Utility/UUID.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000019
Chris Lattner30fdc8d2010-06-08 16:52:24 +000020// This class needs to be hidden as eventually belongs in a plugin that
21// will export the ObjectFile protocol
Kate Stoneb9c1b512016-09-06 20:57:50 +000022class ObjectFileMachO : public lldb_private::ObjectFile {
Chris Lattner30fdc8d2010-06-08 16:52:24 +000023public:
Kate Stoneb9c1b512016-09-06 20:57:50 +000024 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);
Eugene Zelenko8157a882015-10-23 16:56:07 +000028
Kate Stoneb9c1b512016-09-06 20:57:50 +000029 ObjectFileMachO(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
30 const lldb::ProcessSP &process_sp, lldb::addr_t header_addr);
Eugene Zelenko8157a882015-10-23 16:56:07 +000031
Kate Stoneb9c1b512016-09-06 20:57:50 +000032 ~ObjectFileMachO() override = default;
Eugene Zelenko8157a882015-10-23 16:56:07 +000033
Kate Stoneb9c1b512016-09-06 20:57:50 +000034 // Static Functions
Kate Stoneb9c1b512016-09-06 20:57:50 +000035 static void Initialize();
Chris Lattner30fdc8d2010-06-08 16:52:24 +000036
Kate Stoneb9c1b512016-09-06 20:57:50 +000037 static void Terminate();
Chris Lattner30fdc8d2010-06-08 16:52:24 +000038
Kate Stoneb9c1b512016-09-06 20:57:50 +000039 static lldb_private::ConstString GetPluginNameStatic();
Chris Lattner30fdc8d2010-06-08 16:52:24 +000040
Kate Stoneb9c1b512016-09-06 20:57:50 +000041 static const char *GetPluginDescriptionStatic();
Chris Lattner30fdc8d2010-06-08 16:52:24 +000042
Kate Stoneb9c1b512016-09-06 20:57:50 +000043 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);
Chris Lattner30fdc8d2010-06-08 16:52:24 +000047
Kate Stoneb9c1b512016-09-06 20:57:50 +000048 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);
Greg Claytonc9660542012-02-05 02:38:54 +000051
Kate Stoneb9c1b512016-09-06 20:57:50 +000052 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);
Greg Claytonf4d6de62013-04-24 22:29:28 +000058
Kate Stoneb9c1b512016-09-06 20:57:50 +000059 static bool SaveCore(const lldb::ProcessSP &process_sp,
60 const lldb_private::FileSpec &outfile,
Zachary Turner97206d52017-05-12 04:51:55 +000061 lldb_private::Status &error);
Greg Claytona2715cf2014-06-13 00:54:12 +000062
Kate Stoneb9c1b512016-09-06 20:57:50 +000063 static bool MagicBytesMatch(lldb::DataBufferSP &data_sp, lldb::addr_t offset,
64 lldb::addr_t length);
Chris Lattner30fdc8d2010-06-08 16:52:24 +000065
Pavel Labathe84f7842019-07-31 11:57:34 +000066 // 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
Kate Stoneb9c1b512016-09-06 20:57:50 +000073 // Member Functions
Kate Stoneb9c1b512016-09-06 20:57:50 +000074 bool ParseHeader() override;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000075
Kate Stoneb9c1b512016-09-06 20:57:50 +000076 bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value,
77 bool value_is_offset) override;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000078
Kate Stoneb9c1b512016-09-06 20:57:50 +000079 lldb::ByteOrder GetByteOrder() const override;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000080
Kate Stoneb9c1b512016-09-06 20:57:50 +000081 bool IsExecutable() const override;
Greg Claytonded470d2011-03-19 01:12:21 +000082
Jason Molenda956761a2019-07-18 20:55:24 +000083 bool IsDynamicLoader() const;
84
Kate Stoneb9c1b512016-09-06 20:57:50 +000085 uint32_t GetAddressByteSize() const override;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000086
Tatyana Krasnukha9e1a1172018-06-27 06:50:10 +000087 lldb_private::AddressClass GetAddressClass(lldb::addr_t file_addr) override;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000088
Kate Stoneb9c1b512016-09-06 20:57:50 +000089 lldb_private::Symtab *GetSymtab() override;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000090
Kate Stoneb9c1b512016-09-06 20:57:50 +000091 bool IsStripped() override;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000092
Kate Stoneb9c1b512016-09-06 20:57:50 +000093 void CreateSections(lldb_private::SectionList &unified_section_list) override;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000094
Kate Stoneb9c1b512016-09-06 20:57:50 +000095 void Dump(lldb_private::Stream *s) override;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000096
Pavel Labathf760f5a2019-01-03 10:37:19 +000097 lldb_private::ArchSpec GetArchitecture() override;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000098
Pavel Labathbd334ef2019-02-11 16:14:02 +000099 lldb_private::UUID GetUUID() override;
Greg Claytonc3776bf2012-02-09 06:16:32 +0000100
Kate Stoneb9c1b512016-09-06 20:57:50 +0000101 uint32_t GetDependentModules(lldb_private::FileSpecList &files) override;
Greg Clayton9e00b6a652011-07-09 00:41:34 +0000102
Kate Stoneb9c1b512016-09-06 20:57:50 +0000103 lldb_private::FileSpecList GetReExportedLibraries() override {
104 return m_reexported_dylibs;
105 }
Greg Claytonc2ff9312012-02-22 19:41:02 +0000106
Kate Stoneb9c1b512016-09-06 20:57:50 +0000107 lldb_private::Address GetEntryPointAddress() override;
Greg Clayton08928f32015-02-05 02:01:34 +0000108
Pavel Labathd1e3fe22018-12-11 15:21:15 +0000109 lldb_private::Address GetBaseAddress() override;
Greg Clayton08928f32015-02-05 02:01:34 +0000110
Kate Stoneb9c1b512016-09-06 20:57:50 +0000111 uint32_t GetNumThreadContexts() override;
Jason Molenda955dcf22016-05-04 03:09:40 +0000112
Jason Molenda3533cec2017-04-06 01:50:11 +0000113 std::string GetIdentifierString() override;
114
Jason Molenda9b7fcdc2017-04-12 23:33:30 +0000115 bool GetCorefileMainBinaryInfo (lldb::addr_t &address, lldb_private::UUID &uuid) override;
116
Kate Stoneb9c1b512016-09-06 20:57:50 +0000117 lldb::RegisterContextSP
118 GetThreadContextAtIndex(uint32_t idx, lldb_private::Thread &thread) override;
Eugene Zelenko8157a882015-10-23 16:56:07 +0000119
Kate Stoneb9c1b512016-09-06 20:57:50 +0000120 ObjectFile::Type CalculateType() override;
121
122 ObjectFile::Strata CalculateStrata() override;
123
Pavel Labath2272c482018-06-18 15:02:23 +0000124 llvm::VersionTuple GetVersion() override;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000125
Pavel Labath2272c482018-06-18 15:02:23 +0000126 llvm::VersionTuple GetMinimumOSVersion() override;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000127
Raphael Isemanne0afcd82019-07-03 22:21:10 +0000128 llvm::VersionTuple GetSDKVersion() override;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000129
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
Kate Stoneb9c1b512016-09-06 20:57:50 +0000138 // PluginInterface protocol
Kate Stoneb9c1b512016-09-06 20:57:50 +0000139 lldb_private::ConstString GetPluginName() override;
140
141 uint32_t GetPluginVersion() override;
Eugene Zelenko8157a882015-10-23 16:56:07 +0000142
Greg Clayton9cbd3c62014-03-07 19:24:39 +0000143protected:
Pavel Labathbd334ef2019-02-11 16:14:02 +0000144 static lldb_private::UUID
Kate Stoneb9c1b512016-09-06 20:57:50 +0000145 GetUUID(const llvm::MachO::mach_header &header,
146 const lldb_private::DataExtractor &data,
Pavel Labathbd334ef2019-02-11 16:14:02 +0000147 lldb::offset_t lc_offset); // Offset to the first load command
Greg Clayton7ab7f892014-05-29 21:33:45 +0000148
Pavel Labathf760f5a2019-01-03 10:37:19 +0000149 static lldb_private::ArchSpec
150 GetArchitecture(const llvm::MachO::mach_header &header,
151 const lldb_private::DataExtractor &data,
152 lldb::offset_t lc_offset);
Jason Molenda0e0954c2013-04-16 06:24:42 +0000153
Kate Stoneb9c1b512016-09-06 20:57:50 +0000154 // Intended for same-host arm device debugging where lldb needs to
155 // detect libraries in the shared cache and augment the nlist entries
156 // with an on-disk dyld_shared_cache file. The process will record
157 // the shared cache UUID so the on-disk cache can be matched or rejected
158 // correctly.
Jason Molenda07580ff2018-05-04 00:59:37 +0000159 void GetProcessSharedCacheUUID(lldb_private::Process *, lldb::addr_t &base_addr, lldb_private::UUID &uuid);
Jason Molenda0e0954c2013-04-16 06:24:42 +0000160
Kate Stoneb9c1b512016-09-06 20:57:50 +0000161 // Intended for same-host arm device debugging where lldb will read
162 // shared cache libraries out of its own memory instead of the remote
163 // process' memory as an optimization. If lldb's shared cache UUID
164 // does not match the process' shared cache UUID, this optimization
165 // should not be used.
Jason Molenda07580ff2018-05-04 00:59:37 +0000166 void GetLLDBSharedCacheUUID(lldb::addr_t &base_addir, lldb_private::UUID &uuid);
Greg Clayton07347372015-06-08 21:53:11 +0000167
Kate Stoneb9c1b512016-09-06 20:57:50 +0000168 lldb_private::Section *GetMachHeaderSection();
Greg Clayton07347372015-06-08 21:53:11 +0000169
Kate Stoneb9c1b512016-09-06 20:57:50 +0000170 lldb::addr_t CalculateSectionLoadAddressForMemoryImage(
171 lldb::addr_t mach_header_load_address,
172 const lldb_private::Section *mach_header_section,
173 const lldb_private::Section *section);
Jason Molenda649a6072015-11-10 05:21:54 +0000174
Kate Stoneb9c1b512016-09-06 20:57:50 +0000175 lldb_private::UUID
176 GetSharedCacheUUID(lldb_private::FileSpec dyld_shared_cache,
177 const lldb::ByteOrder byte_order,
178 const uint32_t addr_byte_size);
Eugene Zelenko8157a882015-10-23 16:56:07 +0000179
Kate Stoneb9c1b512016-09-06 20:57:50 +0000180 size_t ParseSymtab();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000181
Pavel Labathb417eea2018-03-06 13:53:26 +0000182 typedef lldb_private::RangeArray<uint32_t, uint32_t, 8> EncryptedFileRanges;
183 EncryptedFileRanges GetEncryptedFileRanges();
184
185 struct SegmentParsingContext;
186 void ProcessDysymtabCommand(const llvm::MachO::load_command &load_cmd,
187 lldb::offset_t offset);
188 void ProcessSegmentCommand(const llvm::MachO::load_command &load_cmd,
189 lldb::offset_t offset, uint32_t cmd_idx,
190 SegmentParsingContext &context);
191 void SanitizeSegmentCommand(llvm::MachO::segment_command_64 &seg_cmd,
192 uint32_t cmd_idx);
193
Greg Clayton57577c02018-12-21 17:04:18 +0000194 bool SectionIsLoadable(const lldb_private::Section *section);
195
Kate Stoneb9c1b512016-09-06 20:57:50 +0000196 llvm::MachO::mach_header m_header;
Adrian Prantl0e4c4822019-03-06 21:22:25 +0000197 static lldb_private::ConstString GetSegmentNameTEXT();
198 static lldb_private::ConstString GetSegmentNameDATA();
199 static lldb_private::ConstString GetSegmentNameDATA_DIRTY();
200 static lldb_private::ConstString GetSegmentNameDATA_CONST();
201 static lldb_private::ConstString GetSegmentNameOBJC();
202 static lldb_private::ConstString GetSegmentNameLINKEDIT();
203 static lldb_private::ConstString GetSegmentNameDWARF();
204 static lldb_private::ConstString GetSectionNameEHFrame();
Kate Stoneb9c1b512016-09-06 20:57:50 +0000205
206 llvm::MachO::dysymtab_command m_dysymtab;
207 std::vector<llvm::MachO::segment_command_64> m_mach_segments;
208 std::vector<llvm::MachO::section_64> m_mach_sections;
Pavel Labath2272c482018-06-18 15:02:23 +0000209 llvm::Optional<llvm::VersionTuple> m_min_os_version;
Raphael Isemanne0afcd82019-07-03 22:21:10 +0000210 llvm::Optional<llvm::VersionTuple> m_sdk_versions;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000211 typedef lldb_private::RangeVector<uint32_t, uint32_t> FileRangeArray;
212 lldb_private::Address m_entry_point_address;
213 FileRangeArray m_thread_context_offsets;
214 bool m_thread_context_offsets_valid;
215 lldb_private::FileSpecList m_reexported_dylibs;
216 bool m_allow_assembly_emulation_unwind_plans;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000217};
218
Eugene Zelenko8157a882015-10-23 16:56:07 +0000219#endif // liblldb_ObjectFileMachO_h_