xref: /freebsd-src/contrib/llvm-project/lldb/source/Plugins/ObjectFile/Placeholder/ObjectFilePlaceholder.h (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1*06c3fb27SDimitry Andric //===-- ObjectFilePlaceholder.h ---------------------------------*- C++ -*-===//
2*06c3fb27SDimitry Andric //
3*06c3fb27SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*06c3fb27SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*06c3fb27SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*06c3fb27SDimitry Andric //
7*06c3fb27SDimitry Andric //===----------------------------------------------------------------------===//
8*06c3fb27SDimitry Andric 
9*06c3fb27SDimitry Andric #ifndef LLDB_SOURCE_PLUGINS_OBJECTFILE_PLACEHOLDER_OBJECTFILEPLACEHOLDER_H
10*06c3fb27SDimitry Andric #define LLDB_SOURCE_PLUGINS_OBJECTFILE_PLACEHOLDER_OBJECTFILEPLACEHOLDER_H
11*06c3fb27SDimitry Andric 
12*06c3fb27SDimitry Andric #include "lldb/Symbol/ObjectFile.h"
13*06c3fb27SDimitry Andric 
14*06c3fb27SDimitry Andric #include "lldb/Target/Target.h"
15*06c3fb27SDimitry Andric #include "lldb/Utility/ArchSpec.h"
16*06c3fb27SDimitry Andric #include "lldb/Utility/FileSpec.h"
17*06c3fb27SDimitry Andric #include "lldb/Utility/UUID.h"
18*06c3fb27SDimitry Andric #include "lldb/lldb-private.h"
19*06c3fb27SDimitry Andric 
20*06c3fb27SDimitry Andric /// A minimal ObjectFile implementation providing a dummy object file for the
21*06c3fb27SDimitry Andric /// cases when the real module binary is not available. This allows the module
22*06c3fb27SDimitry Andric /// to show up in "image list" and symbols to be added to it.
23*06c3fb27SDimitry Andric class ObjectFilePlaceholder : public lldb_private::ObjectFile {
24*06c3fb27SDimitry Andric public:
25*06c3fb27SDimitry Andric   // Static Functions
Initialize()26*06c3fb27SDimitry Andric   static void Initialize() {}
27*06c3fb27SDimitry Andric 
Terminate()28*06c3fb27SDimitry Andric   static void Terminate() {}
29*06c3fb27SDimitry Andric 
GetPluginNameStatic()30*06c3fb27SDimitry Andric   static llvm::StringRef GetPluginNameStatic() { return "placeholder"; }
31*06c3fb27SDimitry Andric 
32*06c3fb27SDimitry Andric   ObjectFilePlaceholder(const lldb::ModuleSP &module_sp,
33*06c3fb27SDimitry Andric                         const lldb_private::ModuleSpec &module_spec,
34*06c3fb27SDimitry Andric                         lldb::addr_t base, lldb::addr_t size);
35*06c3fb27SDimitry Andric 
GetPluginName()36*06c3fb27SDimitry Andric   llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
ParseHeader()37*06c3fb27SDimitry Andric   bool ParseHeader() override { return true; }
CalculateType()38*06c3fb27SDimitry Andric   Type CalculateType() override { return eTypeUnknown; }
CalculateStrata()39*06c3fb27SDimitry Andric   Strata CalculateStrata() override { return eStrataUnknown; }
GetDependentModules(lldb_private::FileSpecList & file_list)40*06c3fb27SDimitry Andric   uint32_t GetDependentModules(lldb_private::FileSpecList &file_list) override {
41*06c3fb27SDimitry Andric     return 0;
42*06c3fb27SDimitry Andric   }
IsExecutable()43*06c3fb27SDimitry Andric   bool IsExecutable() const override { return false; }
GetArchitecture()44*06c3fb27SDimitry Andric   lldb_private::ArchSpec GetArchitecture() override { return m_arch; }
GetUUID()45*06c3fb27SDimitry Andric   lldb_private::UUID GetUUID() override { return m_uuid; }
ParseSymtab(lldb_private::Symtab & symtab)46*06c3fb27SDimitry Andric   void ParseSymtab(lldb_private::Symtab &symtab) override {}
IsStripped()47*06c3fb27SDimitry Andric   bool IsStripped() override { return true; }
GetByteOrder()48*06c3fb27SDimitry Andric   lldb::ByteOrder GetByteOrder() const override {
49*06c3fb27SDimitry Andric     return m_arch.GetByteOrder();
50*06c3fb27SDimitry Andric   }
51*06c3fb27SDimitry Andric 
GetAddressByteSize()52*06c3fb27SDimitry Andric   uint32_t GetAddressByteSize() const override {
53*06c3fb27SDimitry Andric     return m_arch.GetAddressByteSize();
54*06c3fb27SDimitry Andric   }
55*06c3fb27SDimitry Andric 
56*06c3fb27SDimitry Andric   lldb_private::Address GetBaseAddress() override;
57*06c3fb27SDimitry Andric 
58*06c3fb27SDimitry Andric   void CreateSections(lldb_private::SectionList &unified_section_list) override;
59*06c3fb27SDimitry Andric 
60*06c3fb27SDimitry Andric   bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value,
61*06c3fb27SDimitry Andric                       bool value_is_offset) override;
62*06c3fb27SDimitry Andric 
63*06c3fb27SDimitry Andric   void Dump(lldb_private::Stream *s) override;
64*06c3fb27SDimitry Andric 
GetBaseImageAddress()65*06c3fb27SDimitry Andric   lldb::addr_t GetBaseImageAddress() const { return m_base; }
66*06c3fb27SDimitry Andric 
67*06c3fb27SDimitry Andric private:
68*06c3fb27SDimitry Andric   lldb_private::ArchSpec m_arch;
69*06c3fb27SDimitry Andric   lldb_private::UUID m_uuid;
70*06c3fb27SDimitry Andric   lldb::addr_t m_base;
71*06c3fb27SDimitry Andric   lldb::addr_t m_size;
72*06c3fb27SDimitry Andric };
73*06c3fb27SDimitry Andric 
74*06c3fb27SDimitry Andric #endif // LLDB_SOURCE_PLUGINS_OBJECTFILE_PLACEHOLDER_OBJECTFILEPLACEHOLDER_H
75