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 LLDB_SOURCE_PLUGINS_OBJECTFILE_MACH_O_OBJECTFILEMACHO_H
10 #define LLDB_SOURCE_PLUGINS_OBJECTFILE_MACH_O_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;
isA(const void * ClassID)68   bool isA(const void *ClassID) const override {
69     return ClassID == &ID || ObjectFile::isA(ClassID);
70   }
classof(const ObjectFile * obj)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 
GetReExportedLibraries()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,
116                                  lldb_private::UUID &uuid,
117                                  ObjectFile::BinaryType &type) override;
118 
119   lldb::RegisterContextSP
120   GetThreadContextAtIndex(uint32_t idx, lldb_private::Thread &thread) override;
121 
122   ObjectFile::Type CalculateType() override;
123 
124   ObjectFile::Strata CalculateStrata() override;
125 
126   llvm::VersionTuple GetVersion() override;
127 
128   llvm::VersionTuple GetMinimumOSVersion() override;
129 
130   llvm::VersionTuple GetSDKVersion() override;
131 
132   bool GetIsDynamicLinkEditor() override;
133 
134   static bool ParseHeader(lldb_private::DataExtractor &data,
135                           lldb::offset_t *data_offset_ptr,
136                           llvm::MachO::mach_header &header);
137 
138   bool AllowAssemblyEmulationUnwindPlans() override;
139 
140   // PluginInterface protocol
141   lldb_private::ConstString GetPluginName() override;
142 
143   uint32_t GetPluginVersion() override;
144 
145 protected:
146   static lldb_private::UUID
147   GetUUID(const llvm::MachO::mach_header &header,
148           const lldb_private::DataExtractor &data,
149           lldb::offset_t lc_offset); // Offset to the first load command
150 
151   static lldb_private::ArchSpec GetArchitecture(
152       lldb::ModuleSP module_sp, const llvm::MachO::mach_header &header,
153       const lldb_private::DataExtractor &data, lldb::offset_t lc_offset);
154 
155   /// Enumerate all ArchSpecs supported by this Mach-O file.
156   ///
157   /// On macOS one Mach-O slice can contain multiple load commands:
158   /// One load command for being loaded into a macOS process and one
159   /// load command for being loaded into a macCatalyst process. In
160   /// contrast to ObjectContainerUniversalMachO, this is the same
161   /// binary that can be loaded into different contexts.
162   static void GetAllArchSpecs(const llvm::MachO::mach_header &header,
163                               const lldb_private::DataExtractor &data,
164                               lldb::offset_t lc_offset,
165                               lldb_private::ModuleSpec &base_spec,
166                               lldb_private::ModuleSpecList &all_specs);
167 
168   /// Intended for same-host arm device debugging where lldb needs to
169   /// detect libraries in the shared cache and augment the nlist entries
170   /// with an on-disk dyld_shared_cache file.  The process will record
171   /// the shared cache UUID so the on-disk cache can be matched or rejected
172   /// correctly.
173   void GetProcessSharedCacheUUID(lldb_private::Process *,
174                                  lldb::addr_t &base_addr,
175                                  lldb_private::UUID &uuid);
176 
177   /// Intended for same-host arm device debugging where lldb will read
178   /// shared cache libraries out of its own memory instead of the remote
179   /// process' memory as an optimization.  If lldb's shared cache UUID
180   /// does not match the process' shared cache UUID, this optimization
181   /// should not be used.
182   void GetLLDBSharedCacheUUID(lldb::addr_t &base_addir, lldb_private::UUID &uuid);
183 
184   lldb_private::Section *GetMachHeaderSection();
185 
186   lldb::addr_t CalculateSectionLoadAddressForMemoryImage(
187       lldb::addr_t mach_header_load_address,
188       const lldb_private::Section *mach_header_section,
189       const lldb_private::Section *section);
190 
191   lldb_private::UUID
192   GetSharedCacheUUID(lldb_private::FileSpec dyld_shared_cache,
193                      const lldb::ByteOrder byte_order,
194                      const uint32_t addr_byte_size);
195 
196   size_t ParseSymtab();
197 
198   typedef lldb_private::RangeVector<uint32_t, uint32_t, 8> EncryptedFileRanges;
199   EncryptedFileRanges GetEncryptedFileRanges();
200 
201   struct SegmentParsingContext;
202   void ProcessDysymtabCommand(const llvm::MachO::load_command &load_cmd,
203                               lldb::offset_t offset);
204   void ProcessSegmentCommand(const llvm::MachO::load_command &load_cmd,
205                              lldb::offset_t offset, uint32_t cmd_idx,
206                              SegmentParsingContext &context);
207   void SanitizeSegmentCommand(llvm::MachO::segment_command_64 &seg_cmd,
208                               uint32_t cmd_idx);
209 
210   bool SectionIsLoadable(const lldb_private::Section *section);
211 
212   llvm::MachO::mach_header m_header;
213   static lldb_private::ConstString GetSegmentNameTEXT();
214   static lldb_private::ConstString GetSegmentNameDATA();
215   static lldb_private::ConstString GetSegmentNameDATA_DIRTY();
216   static lldb_private::ConstString GetSegmentNameDATA_CONST();
217   static lldb_private::ConstString GetSegmentNameOBJC();
218   static lldb_private::ConstString GetSegmentNameLINKEDIT();
219   static lldb_private::ConstString GetSegmentNameDWARF();
220   static lldb_private::ConstString GetSectionNameEHFrame();
221 
222   llvm::MachO::dysymtab_command m_dysymtab;
223   std::vector<llvm::MachO::segment_command_64> m_mach_segments;
224   std::vector<llvm::MachO::section_64> m_mach_sections;
225   llvm::Optional<llvm::VersionTuple> m_min_os_version;
226   llvm::Optional<llvm::VersionTuple> m_sdk_versions;
227   typedef lldb_private::RangeVector<uint32_t, uint32_t> FileRangeArray;
228   lldb_private::Address m_entry_point_address;
229   FileRangeArray m_thread_context_offsets;
230   lldb::offset_t m_linkedit_original_offset;
231   lldb::addr_t m_text_address;
232   bool m_thread_context_offsets_valid;
233   lldb_private::FileSpecList m_reexported_dylibs;
234   bool m_allow_assembly_emulation_unwind_plans;
235 };
236 
237 #endif // LLDB_SOURCE_PLUGINS_OBJECTFILE_MACH_O_OBJECTFILEMACHO_H
238