lldb/Expression/ObjectFileJIT.h

0001 //===-- ObjectFileJIT.h -----------------------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLDB_EXPRESSION_OBJECTFILEJIT_H
0010 #define LLDB_EXPRESSION_OBJECTFILEJIT_H
0011
0012 #include "lldb/Core/Address.h"
0013 #include "lldb/Core/Section.h"
0014 #include "lldb/Symbol/ObjectFile.h"
0015 #include "lldb/Symbol/Symtab.h"
0016 #include "lldb/Utility/ArchSpec.h"
0017
0018 namespace lldb_private {
0019
0020 class ObjectFileJITDelegate {
0021 public:
0022   ObjectFileJITDelegate() = default;
0023   virtual ~ObjectFileJITDelegate() = default;
0024   virtual lldb::ByteOrder GetByteOrder() const = 0;
0025   virtual uint32_t GetAddressByteSize() const = 0;
0026   virtual void PopulateSymtab(lldb_private::ObjectFile *obj_file,
0027                               lldb_private::Symtab &symtab) = 0;
0028   virtual void PopulateSectionList(lldb_private::ObjectFile *obj_file,
0029                                    lldb_private::SectionList &section_list) = 0;
0030   virtual ArchSpec GetArchitecture() = 0;
0031 };
0032
0033 class ObjectFileJIT : public ObjectFile {
0034 public:
0035   ObjectFileJIT(const lldb::ModuleSP &module_sp,
0036                 const lldb::ObjectFileJITDelegateSP &delegate_sp);
0037
0038   ~ObjectFileJIT() override;
0039
0040   // Static Functions
0041   static void Initialize();
0042
0043   static void Terminate();
0044
0045   static llvm::StringRef GetPluginNameStatic() { return "jit"; }
0046
0047   static llvm::StringRef GetPluginDescriptionStatic() {
0048     return "JIT code object file";
0049   }
0050
0051   static lldb_private::ObjectFile *
0052   CreateInstance(const lldb::ModuleSP &module_sp, lldb::DataBufferSP data_sp,
0053                  lldb::offset_t data_offset, const lldb_private::FileSpec *file,
0054                  lldb::offset_t file_offset, lldb::offset_t length);
0055
0056   static lldb_private::ObjectFile *CreateMemoryInstance(
0057       const lldb::ModuleSP &module_sp, lldb::WritableDataBufferSP data_sp,
0058       const lldb::ProcessSP &process_sp, lldb::addr_t header_addr);
0059
0060   static size_t GetModuleSpecifications(const lldb_private::FileSpec &file,
0061                                         lldb::DataBufferSP &data_sp,
0062                                         lldb::offset_t data_offset,
0063                                         lldb::offset_t file_offset,
0064                                         lldb::offset_t length,
0065                                         lldb_private::ModuleSpecList &specs);
0066
0067   // LLVM RTTI support
0068   static char ID;
0069   bool isA(const void *ClassID) const override {
0070     return ClassID == &ID || ObjectFile::isA(ClassID);
0071   }
0072   static bool classof(const ObjectFile *obj) { return obj->isA(&ID); }
0073
0074   // Member Functions
0075   bool ParseHeader() override;
0076
0077   bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value,
0078                       bool value_is_offset) override;
0079
0080   lldb::ByteOrder GetByteOrder() const override;
0081
0082   bool IsExecutable() const override;
0083
0084   uint32_t GetAddressByteSize() const override;
0085
0086   void ParseSymtab(lldb_private::Symtab &symtab) override;
0087
0088   bool IsStripped() override;
0089
0090   void CreateSections(lldb_private::SectionList &unified_section_list) override;
0091
0092   void Dump(lldb_private::Stream *s) override;
0093
0094   lldb_private::ArchSpec GetArchitecture() override;
0095
0096   lldb_private::UUID GetUUID() override;
0097
0098   uint32_t GetDependentModules(lldb_private::FileSpecList &files) override;
0099
0100   size_t ReadSectionData(lldb_private::Section *section,
0101                          lldb::offset_t section_offset, void *dst,
0102                          size_t dst_len) override;
0103
0104   size_t ReadSectionData(lldb_private::Section *section,
0105                          lldb_private::DataExtractor &section_data) override;
0106
0107   lldb_private::Address GetEntryPointAddress() override;
0108
0109   lldb_private::Address GetBaseAddress() override;
0110
0111   ObjectFile::Type CalculateType() override;
0112
0113   ObjectFile::Strata CalculateStrata() override;
0114
0115   // PluginInterface protocol
0116   llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
0117
0118 protected:
0119   lldb::ObjectFileJITDelegateWP m_delegate_wp;
0120 };
0121 } // namespace lldb_private
0122
0123 #endif // LLDB_EXPRESSION_OBJECTFILEJIT_H