lldb/source/Plugins/ObjectFile/Mach-O/ObjectFileMachO.h - llvm-project - Git at Google

 //===-- ObjectFileMachO.h ---------------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//

 #ifndef LLDB_SOURCE_PLUGINS_OBJECTFILE_MACH_O_OBJECTFILEMACHO_H
 #define LLDB_SOURCE_PLUGINS_OBJECTFILE_MACH_O_OBJECTFILEMACHO_H

 #include "lldb/Core/Address.h"
 #include "lldb/Core/FileSpecList.h"
 #include "lldb/Host/SafeMachO.h"
 #include "lldb/Symbol/ObjectFile.h"
 #include "lldb/Utility/FileSpec.h"
 #include "lldb/Utility/RangeMap.h"
 #include "lldb/Utility/StreamString.h"
 #include "lldb/Utility/UUID.h"

 // This class needs to be hidden as eventually belongs in a plugin that
 // will export the ObjectFile protocol
 class ObjectFileMachO : public lldb_private::ObjectFile {
 public:
   ObjectFileMachO(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
                   lldb::offset_t data_offset,
                   const lldb_private::FileSpec *file, lldb::offset_t offset,
                   lldb::offset_t length);

   ObjectFileMachO(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
                   const lldb::ProcessSP &process_sp, lldb::addr_t header_addr);

   ~ObjectFileMachO() override = default;

   // Static Functions
   static void Initialize();

   static void Terminate();

   static llvm::StringRef GetPluginNameStatic() { return "mach-o"; }

   static llvm::StringRef GetPluginDescriptionStatic() {
     return "Mach-o object file reader (32 and 64 bit)";
   }

   static lldb_private::ObjectFile *
   CreateInstance(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
                  lldb::offset_t data_offset, const lldb_private::FileSpec *file,
                  lldb::offset_t file_offset, lldb::offset_t length);

   static lldb_private::ObjectFile *CreateMemoryInstance(
       const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
       const lldb::ProcessSP &process_sp, lldb::addr_t header_addr);

   static size_t GetModuleSpecifications(const lldb_private::FileSpec &file,
                                         lldb::DataBufferSP &data_sp,
                                         lldb::offset_t data_offset,
                                         lldb::offset_t file_offset,
                                         lldb::offset_t length,
                                         lldb_private::ModuleSpecList &specs);

   static bool SaveCore(const lldb::ProcessSP &process_sp,
                        const lldb_private::FileSpec &outfile,
                        lldb::SaveCoreStyle &core_style,
                        lldb_private::Status &error);

   static bool MagicBytesMatch(lldb::DataBufferSP &data_sp, lldb::addr_t offset,
                               lldb::addr_t length);

   // LLVM RTTI support
   static char ID;
   bool isA(const void *ClassID) const override {
     return ClassID == &ID || ObjectFile::isA(ClassID);
   }
   static bool classof(const ObjectFile *obj) { return obj->isA(&ID); }

   // Member Functions
   bool ParseHeader() override;

   bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value,
                       bool value_is_offset) override;

   lldb::ByteOrder GetByteOrder() const override;

   bool IsExecutable() const override;

   bool IsDynamicLoader() const;

   bool IsSharedCacheBinary() const;

   uint32_t GetAddressByteSize() const override;

   lldb_private::AddressClass GetAddressClass(lldb::addr_t file_addr) override;

   void ParseSymtab(lldb_private::Symtab &symtab) override;

   bool IsStripped() override;

   void CreateSections(lldb_private::SectionList &unified_section_list) override;

   void Dump(lldb_private::Stream *s) override;

   lldb_private::ArchSpec GetArchitecture() override;

   lldb_private::UUID GetUUID() override;

   uint32_t GetDependentModules(lldb_private::FileSpecList &files) override;

   lldb_private::FileSpecList GetReExportedLibraries() override {
     return m_reexported_dylibs;
   }

   lldb_private::Address GetEntryPointAddress() override;

   lldb_private::Address GetBaseAddress() override;

   uint32_t GetNumThreadContexts() override;

   std::string GetIdentifierString() override;

   lldb::addr_t GetAddressMask() override;

   bool GetCorefileMainBinaryInfo(lldb::addr_t &address,
                                  lldb_private::UUID &uuid,
                                  ObjectFile::BinaryType &type) override;

   bool LoadCoreFileImages(lldb_private::Process &process) override;

   lldb::RegisterContextSP
   GetThreadContextAtIndex(uint32_t idx, lldb_private::Thread &thread) override;

   ObjectFile::Type CalculateType() override;

   ObjectFile::Strata CalculateStrata() override;

   llvm::VersionTuple GetVersion() override;

   llvm::VersionTuple GetMinimumOSVersion() override;

   llvm::VersionTuple GetSDKVersion() override;

   bool GetIsDynamicLinkEditor() override;

   static bool ParseHeader(lldb_private::DataExtractor &data,
                           lldb::offset_t *data_offset_ptr,
                           llvm::MachO::mach_header &header);

   bool AllowAssemblyEmulationUnwindPlans() override;

   // PluginInterface protocol
   llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }

 protected:
   static lldb_private::UUID
   GetUUID(const llvm::MachO::mach_header &header,
           const lldb_private::DataExtractor &data,
           lldb::offset_t lc_offset); // Offset to the first load command

   static lldb_private::ArchSpec GetArchitecture(
       lldb::ModuleSP module_sp, const llvm::MachO::mach_header &header,
       const lldb_private::DataExtractor &data, lldb::offset_t lc_offset);

   /// Enumerate all ArchSpecs supported by this Mach-O file.
   ///
   /// On macOS one Mach-O slice can contain multiple load commands:
   /// One load command for being loaded into a macOS process and one
   /// load command for being loaded into a macCatalyst process. In
   /// contrast to ObjectContainerUniversalMachO, this is the same
   /// binary that can be loaded into different contexts.
   static void GetAllArchSpecs(const llvm::MachO::mach_header &header,
                               const lldb_private::DataExtractor &data,
                               lldb::offset_t lc_offset,
                               lldb_private::ModuleSpec &base_spec,
                               lldb_private::ModuleSpecList &all_specs);

   /// Intended for same-host arm device debugging where lldb needs to
   /// detect libraries in the shared cache and augment the nlist entries
   /// with an on-disk dyld_shared_cache file.  The process will record
   /// the shared cache UUID so the on-disk cache can be matched or rejected
   /// correctly.
   void GetProcessSharedCacheUUID(lldb_private::Process *,
                                  lldb::addr_t &base_addr,
                                  lldb_private::UUID &uuid);

   /// Intended for same-host arm device debugging where lldb will read
   /// shared cache libraries out of its own memory instead of the remote
   /// process' memory as an optimization.  If lldb's shared cache UUID
   /// does not match the process' shared cache UUID, this optimization
   /// should not be used.
   void GetLLDBSharedCacheUUID(lldb::addr_t &base_addir, lldb_private::UUID &uuid);

   lldb_private::Section *GetMachHeaderSection();

   lldb::addr_t CalculateSectionLoadAddressForMemoryImage(
       lldb::addr_t mach_header_load_address,
       const lldb_private::Section *mach_header_section,
       const lldb_private::Section *section);

   lldb_private::UUID
   GetSharedCacheUUID(lldb_private::FileSpec dyld_shared_cache,
                      const lldb::ByteOrder byte_order,
                      const uint32_t addr_byte_size);

   size_t ParseSymtab();

   typedef lldb_private::RangeVector<uint32_t, uint32_t, 8> EncryptedFileRanges;
   EncryptedFileRanges GetEncryptedFileRanges();

   struct SegmentParsingContext;
   void ProcessDysymtabCommand(const llvm::MachO::load_command &load_cmd,
                               lldb::offset_t offset);
   void ProcessSegmentCommand(const llvm::MachO::load_command &load_cmd,
                              lldb::offset_t offset, uint32_t cmd_idx,
                              SegmentParsingContext &context);
   void SanitizeSegmentCommand(llvm::MachO::segment_command_64 &seg_cmd,
                               uint32_t cmd_idx);

   bool SectionIsLoadable(const lldb_private::Section *section);

   /// A corefile may include metadata about all of the binaries that were
   /// present in the process when the corefile was taken.  This is only
   /// implemented for Mach-O files for now; we'll generalize it when we
   /// have other systems that can include the same.
   struct MachOCorefileImageEntry {
     std::string filename;
     lldb_private::UUID uuid;
     lldb::addr_t load_address = LLDB_INVALID_ADDRESS;
     bool currently_executing;
     std::vector<std::tuple<lldb_private::ConstString, lldb::addr_t>>
         segment_load_addresses;
   };

   struct LCNoteEntry {
     LCNoteEntry(uint32_t addr_byte_size, lldb::ByteOrder byte_order)
         : payload(lldb_private::Stream::eBinary, addr_byte_size, byte_order) {}

     std::string name;
     lldb::addr_t payload_file_offset = 0;
     lldb_private::StreamString payload;
   };

   struct MachOCorefileAllImageInfos {
     std::vector<MachOCorefileImageEntry> all_image_infos;
     bool IsValid() { return all_image_infos.size() > 0; }
   };

   /// Get the list of binary images that were present in the process
   /// when the corefile was produced.
   /// \return
   ///     The MachOCorefileAllImageInfos object returned will have
   ///     IsValid() == false if the information is unavailable.
   MachOCorefileAllImageInfos GetCorefileAllImageInfos();

   llvm::MachO::mach_header m_header;
   static lldb_private::ConstString GetSegmentNameTEXT();
   static lldb_private::ConstString GetSegmentNameDATA();
   static lldb_private::ConstString GetSegmentNameDATA_DIRTY();
   static lldb_private::ConstString GetSegmentNameDATA_CONST();
   static lldb_private::ConstString GetSegmentNameOBJC();
   static lldb_private::ConstString GetSegmentNameLINKEDIT();
   static lldb_private::ConstString GetSegmentNameDWARF();
   static lldb_private::ConstString GetSectionNameEHFrame();

   llvm::MachO::dysymtab_command m_dysymtab;
   std::vector<llvm::MachO::segment_command_64> m_mach_segments;
   std::vector<llvm::MachO::section_64> m_mach_sections;
   llvm::Optional<llvm::VersionTuple> m_min_os_version;
   llvm::Optional<llvm::VersionTuple> m_sdk_versions;
   typedef lldb_private::RangeVector<uint32_t, uint32_t> FileRangeArray;
   lldb_private::Address m_entry_point_address;
   FileRangeArray m_thread_context_offsets;
   lldb::offset_t m_linkedit_original_offset;
   lldb::addr_t m_text_address;
   bool m_thread_context_offsets_valid;
   lldb_private::FileSpecList m_reexported_dylibs;
   bool m_allow_assembly_emulation_unwind_plans;
 };

 #endif // LLDB_SOURCE_PLUGINS_OBJECTFILE_MACH_O_OBJECTFILEMACHO_H
	//===-- ObjectFileMachO.h ---------------------------------------- C++ --===//
	//
	// 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
	//
	//===----------------------------------------------------------------------===//

	#ifndef LLDB_SOURCE_PLUGINS_OBJECTFILE_MACH_O_OBJECTFILEMACHO_H
	#define LLDB_SOURCE_PLUGINS_OBJECTFILE_MACH_O_OBJECTFILEMACHO_H

	#include "lldb/Core/Address.h"
	#include "lldb/Core/FileSpecList.h"
	#include "lldb/Host/SafeMachO.h"
	#include "lldb/Symbol/ObjectFile.h"
	#include "lldb/Utility/FileSpec.h"
	#include "lldb/Utility/RangeMap.h"
	#include "lldb/Utility/StreamString.h"
	#include "lldb/Utility/UUID.h"

	// This class needs to be hidden as eventually belongs in a plugin that
	// will export the ObjectFile protocol
	class ObjectFileMachO : public lldb_private::ObjectFile {
	public:
	ObjectFileMachO(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
	lldb::offset_t data_offset,
	const lldb_private::FileSpec *file, lldb::offset_t offset,
	lldb::offset_t length);

	ObjectFileMachO(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
	const lldb::ProcessSP &process_sp, lldb::addr_t header_addr);

	~ObjectFileMachO() override = default;

	// Static Functions
	static void Initialize();

	static void Terminate();

	static llvm::StringRef GetPluginNameStatic() { return "mach-o"; }

	static llvm::StringRef GetPluginDescriptionStatic() {
	return "Mach-o object file reader (32 and 64 bit)";
	}

	static lldb_private::ObjectFile *
	CreateInstance(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
	lldb::offset_t data_offset, const lldb_private::FileSpec *file,
	lldb::offset_t file_offset, lldb::offset_t length);

	static lldb_private::ObjectFile *CreateMemoryInstance(
	const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
	const lldb::ProcessSP &process_sp, lldb::addr_t header_addr);

	static size_t GetModuleSpecifications(const lldb_private::FileSpec &file,
	lldb::DataBufferSP &data_sp,
	lldb::offset_t data_offset,
	lldb::offset_t file_offset,
	lldb::offset_t length,
	lldb_private::ModuleSpecList &specs);

	static bool SaveCore(const lldb::ProcessSP &process_sp,
	const lldb_private::FileSpec &outfile,
	lldb::SaveCoreStyle &core_style,
	lldb_private::Status &error);

	static bool MagicBytesMatch(lldb::DataBufferSP &data_sp, lldb::addr_t offset,
	lldb::addr_t length);

	// LLVM RTTI support
	static char ID;
	bool isA(const void *ClassID) const override {
	return ClassID == &ID \|\| ObjectFile::isA(ClassID);
	}
	static bool classof(const ObjectFile *obj) { return obj->isA(&ID); }

	// Member Functions
	bool ParseHeader() override;

	bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value,
	bool value_is_offset) override;

	lldb::ByteOrder GetByteOrder() const override;

	bool IsExecutable() const override;

	bool IsDynamicLoader() const;

	bool IsSharedCacheBinary() const;

	uint32_t GetAddressByteSize() const override;

	lldb_private::AddressClass GetAddressClass(lldb::addr_t file_addr) override;

	void ParseSymtab(lldb_private::Symtab &symtab) override;

	bool IsStripped() override;

	void CreateSections(lldb_private::SectionList &unified_section_list) override;

	void Dump(lldb_private::Stream *s) override;

	lldb_private::ArchSpec GetArchitecture() override;

	lldb_private::UUID GetUUID() override;

	uint32_t GetDependentModules(lldb_private::FileSpecList &files) override;

	lldb_private::FileSpecList GetReExportedLibraries() override {
	return m_reexported_dylibs;
	}

	lldb_private::Address GetEntryPointAddress() override;

	lldb_private::Address GetBaseAddress() override;

	uint32_t GetNumThreadContexts() override;

	std::string GetIdentifierString() override;

	lldb::addr_t GetAddressMask() override;

	bool GetCorefileMainBinaryInfo(lldb::addr_t &address,
	lldb_private::UUID &uuid,
	ObjectFile::BinaryType &type) override;

	bool LoadCoreFileImages(lldb_private::Process &process) override;

	lldb::RegisterContextSP
	GetThreadContextAtIndex(uint32_t idx, lldb_private::Thread &thread) override;

	ObjectFile::Type CalculateType() override;

	ObjectFile::Strata CalculateStrata() override;

	llvm::VersionTuple GetVersion() override;

	llvm::VersionTuple GetMinimumOSVersion() override;

	llvm::VersionTuple GetSDKVersion() override;

	bool GetIsDynamicLinkEditor() override;

	static bool ParseHeader(lldb_private::DataExtractor &data,
	lldb::offset_t *data_offset_ptr,
	llvm::MachO::mach_header &header);

	bool AllowAssemblyEmulationUnwindPlans() override;

	// PluginInterface protocol
	llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }

	protected:
	static lldb_private::UUID
	GetUUID(const llvm::MachO::mach_header &header,
	const lldb_private::DataExtractor &data,
	lldb::offset_t lc_offset); // Offset to the first load command

	static lldb_private::ArchSpec GetArchitecture(
	lldb::ModuleSP module_sp, const llvm::MachO::mach_header &header,
	const lldb_private::DataExtractor &data, lldb::offset_t lc_offset);

	/// Enumerate all ArchSpecs supported by this Mach-O file.
	///
	/// On macOS one Mach-O slice can contain multiple load commands:
	/// One load command for being loaded into a macOS process and one
	/// load command for being loaded into a macCatalyst process. In
	/// contrast to ObjectContainerUniversalMachO, this is the same
	/// binary that can be loaded into different contexts.
	static void GetAllArchSpecs(const llvm::MachO::mach_header &header,
	const lldb_private::DataExtractor &data,
	lldb::offset_t lc_offset,
	lldb_private::ModuleSpec &base_spec,
	lldb_private::ModuleSpecList &all_specs);

	/// Intended for same-host arm device debugging where lldb needs to
	/// detect libraries in the shared cache and augment the nlist entries
	/// with an on-disk dyld_shared_cache file. The process will record
	/// the shared cache UUID so the on-disk cache can be matched or rejected
	/// correctly.
	void GetProcessSharedCacheUUID(lldb_private::Process *,
	lldb::addr_t &base_addr,
	lldb_private::UUID &uuid);

	/// Intended for same-host arm device debugging where lldb will read
	/// shared cache libraries out of its own memory instead of the remote
	/// process' memory as an optimization. If lldb's shared cache UUID
	/// does not match the process' shared cache UUID, this optimization
	/// should not be used.
	void GetLLDBSharedCacheUUID(lldb::addr_t &base_addir, lldb_private::UUID &uuid);

	lldb_private::Section *GetMachHeaderSection();

	lldb::addr_t CalculateSectionLoadAddressForMemoryImage(
	lldb::addr_t mach_header_load_address,
	const lldb_private::Section *mach_header_section,
	const lldb_private::Section *section);

	lldb_private::UUID
	GetSharedCacheUUID(lldb_private::FileSpec dyld_shared_cache,
	const lldb::ByteOrder byte_order,
	const uint32_t addr_byte_size);

	size_t ParseSymtab();

	typedef lldb_private::RangeVector<uint32_t, uint32_t, 8> EncryptedFileRanges;
	EncryptedFileRanges GetEncryptedFileRanges();

	struct SegmentParsingContext;
	void ProcessDysymtabCommand(const llvm::MachO::load_command &load_cmd,
	lldb::offset_t offset);
	void ProcessSegmentCommand(const llvm::MachO::load_command &load_cmd,
	lldb::offset_t offset, uint32_t cmd_idx,
	SegmentParsingContext &context);
	void SanitizeSegmentCommand(llvm::MachO::segment_command_64 &seg_cmd,
	uint32_t cmd_idx);

	bool SectionIsLoadable(const lldb_private::Section *section);

	/// A corefile may include metadata about all of the binaries that were
	/// present in the process when the corefile was taken. This is only
	/// implemented for Mach-O files for now; we'll generalize it when we
	/// have other systems that can include the same.
	struct MachOCorefileImageEntry {
	std::string filename;
	lldb_private::UUID uuid;
	lldb::addr_t load_address = LLDB_INVALID_ADDRESS;
	bool currently_executing;
	std::vector<std::tuple<lldb_private::ConstString, lldb::addr_t>>
	segment_load_addresses;
	};

	struct LCNoteEntry {
	LCNoteEntry(uint32_t addr_byte_size, lldb::ByteOrder byte_order)
	: payload(lldb_private::Stream::eBinary, addr_byte_size, byte_order) {}

	std::string name;
	lldb::addr_t payload_file_offset = 0;
	lldb_private::StreamString payload;
	};

	struct MachOCorefileAllImageInfos {
	std::vector<MachOCorefileImageEntry> all_image_infos;
	bool IsValid() { return all_image_infos.size() > 0; }
	};

	/// Get the list of binary images that were present in the process
	/// when the corefile was produced.
	/// \return
	/// The MachOCorefileAllImageInfos object returned will have
	/// IsValid() == false if the information is unavailable.
	MachOCorefileAllImageInfos GetCorefileAllImageInfos();

	llvm::MachO::mach_header m_header;
	static lldb_private::ConstString GetSegmentNameTEXT();
	static lldb_private::ConstString GetSegmentNameDATA();
	static lldb_private::ConstString GetSegmentNameDATA_DIRTY();
	static lldb_private::ConstString GetSegmentNameDATA_CONST();
	static lldb_private::ConstString GetSegmentNameOBJC();
	static lldb_private::ConstString GetSegmentNameLINKEDIT();
	static lldb_private::ConstString GetSegmentNameDWARF();
	static lldb_private::ConstString GetSectionNameEHFrame();

	llvm::MachO::dysymtab_command m_dysymtab;
	std::vector<llvm::MachO::segment_command_64> m_mach_segments;
	std::vector<llvm::MachO::section_64> m_mach_sections;
	llvm::Optional<llvm::VersionTuple> m_min_os_version;
	llvm::Optional<llvm::VersionTuple> m_sdk_versions;
	typedef lldb_private::RangeVector<uint32_t, uint32_t> FileRangeArray;
	lldb_private::Address m_entry_point_address;
	FileRangeArray m_thread_context_offsets;
	lldb::offset_t m_linkedit_original_offset;
	lldb::addr_t m_text_address;
	bool m_thread_context_offsets_valid;
	lldb_private::FileSpecList m_reexported_dylibs;
	bool m_allow_assembly_emulation_unwind_plans;
	};

	#endif // LLDB_SOURCE_PLUGINS_OBJECTFILE_MACH_O_OBJECTFILEMACHO_H