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   // Member Functions
67   bool ParseHeader() override;
68 
69   bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value,
70                       bool value_is_offset) override;
71 
72   lldb::ByteOrder GetByteOrder() const override;
73 
74   bool IsExecutable() const override;
75 
76   uint32_t GetAddressByteSize() const override;
77 
78   lldb_private::AddressClass GetAddressClass(lldb::addr_t file_addr) override;
79 
80   lldb_private::Symtab *GetSymtab() override;
81 
82   bool IsStripped() override;
83 
84   void CreateSections(lldb_private::SectionList &unified_section_list) override;
85 
86   void Dump(lldb_private::Stream *s) override;
87 
88   lldb_private::ArchSpec GetArchitecture() override;
89 
90   lldb_private::UUID GetUUID() override;
91 
92   uint32_t GetDependentModules(lldb_private::FileSpecList &files) override;
93 
94   lldb_private::FileSpecList GetReExportedLibraries() override {
95     return m_reexported_dylibs;
96   }
97 
98   lldb_private::Address GetEntryPointAddress() override;
99 
100   lldb_private::Address GetBaseAddress() override;
101 
102   uint32_t GetNumThreadContexts() override;
103 
104   std::string GetIdentifierString() override;
105 
106   bool GetCorefileMainBinaryInfo (lldb::addr_t &address, lldb_private::UUID &uuid) override;
107 
108   lldb::RegisterContextSP
109   GetThreadContextAtIndex(uint32_t idx, lldb_private::Thread &thread) override;
110 
111   ObjectFile::Type CalculateType() override;
112 
113   ObjectFile::Strata CalculateStrata() override;
114 
115   llvm::VersionTuple GetVersion() override;
116 
117   llvm::VersionTuple GetMinimumOSVersion() override;
118 
119   uint32_t GetSDKVersion(uint32_t *versions, uint32_t num_versions) override;
120 
121   bool GetIsDynamicLinkEditor() override;
122 
123   static bool ParseHeader(lldb_private::DataExtractor &data,
124                           lldb::offset_t *data_offset_ptr,
125                           llvm::MachO::mach_header &header);
126 
127   bool AllowAssemblyEmulationUnwindPlans() override;
128 
129   // PluginInterface protocol
130   lldb_private::ConstString GetPluginName() override;
131 
132   uint32_t GetPluginVersion() override;
133 
134 protected:
135   static lldb_private::UUID
136   GetUUID(const llvm::MachO::mach_header &header,
137           const lldb_private::DataExtractor &data,
138           lldb::offset_t lc_offset); // Offset to the first load command
139 
140   static lldb_private::ArchSpec
141   GetArchitecture(const llvm::MachO::mach_header &header,
142                   const lldb_private::DataExtractor &data,
143                   lldb::offset_t lc_offset);
144 
145   // Intended for same-host arm device debugging where lldb needs to
146   // detect libraries in the shared cache and augment the nlist entries
147   // with an on-disk dyld_shared_cache file.  The process will record
148   // the shared cache UUID so the on-disk cache can be matched or rejected
149   // correctly.
150   void GetProcessSharedCacheUUID(lldb_private::Process *, lldb::addr_t &base_addr, lldb_private::UUID &uuid);
151 
152   // Intended for same-host arm device debugging where lldb will read
153   // shared cache libraries out of its own memory instead of the remote
154   // process' memory as an optimization.  If lldb's shared cache UUID
155   // does not match the process' shared cache UUID, this optimization
156   // should not be used.
157   void GetLLDBSharedCacheUUID(lldb::addr_t &base_addir, lldb_private::UUID &uuid);
158 
159   lldb_private::Section *GetMachHeaderSection();
160 
161   lldb::addr_t CalculateSectionLoadAddressForMemoryImage(
162       lldb::addr_t mach_header_load_address,
163       const lldb_private::Section *mach_header_section,
164       const lldb_private::Section *section);
165 
166   lldb_private::UUID
167   GetSharedCacheUUID(lldb_private::FileSpec dyld_shared_cache,
168                      const lldb::ByteOrder byte_order,
169                      const uint32_t addr_byte_size);
170 
171   size_t ParseSymtab();
172 
173   typedef lldb_private::RangeArray<uint32_t, uint32_t, 8> EncryptedFileRanges;
174   EncryptedFileRanges GetEncryptedFileRanges();
175 
176   struct SegmentParsingContext;
177   void ProcessDysymtabCommand(const llvm::MachO::load_command &load_cmd,
178                               lldb::offset_t offset);
179   void ProcessSegmentCommand(const llvm::MachO::load_command &load_cmd,
180                              lldb::offset_t offset, uint32_t cmd_idx,
181                              SegmentParsingContext &context);
182   void SanitizeSegmentCommand(llvm::MachO::segment_command_64 &seg_cmd,
183                               uint32_t cmd_idx);
184 
185   bool SectionIsLoadable(const lldb_private::Section *section);
186 
187   llvm::MachO::mach_header m_header;
188   static lldb_private::ConstString GetSegmentNameTEXT();
189   static lldb_private::ConstString GetSegmentNameDATA();
190   static lldb_private::ConstString GetSegmentNameDATA_DIRTY();
191   static lldb_private::ConstString GetSegmentNameDATA_CONST();
192   static lldb_private::ConstString GetSegmentNameOBJC();
193   static lldb_private::ConstString GetSegmentNameLINKEDIT();
194   static lldb_private::ConstString GetSegmentNameDWARF();
195   static lldb_private::ConstString GetSectionNameEHFrame();
196 
197   llvm::MachO::dysymtab_command m_dysymtab;
198   std::vector<llvm::MachO::segment_command_64> m_mach_segments;
199   std::vector<llvm::MachO::section_64> m_mach_sections;
200   llvm::Optional<llvm::VersionTuple> m_min_os_version;
201   std::vector<uint32_t> m_sdk_versions;
202   typedef lldb_private::RangeVector<uint32_t, uint32_t> FileRangeArray;
203   lldb_private::Address m_entry_point_address;
204   FileRangeArray m_thread_context_offsets;
205   bool m_thread_context_offsets_valid;
206   lldb_private::FileSpecList m_reexported_dylibs;
207   bool m_allow_assembly_emulation_unwind_plans;
208 };
209 
210 #endif // liblldb_ObjectFileMachO_h_
211