1 //===-- ObjectFileBreakpad.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_PLUGINS_OBJECTFILE_BREAKPAD_OBJECTFILEBREAKPAD_H
10 #define LLDB_PLUGINS_OBJECTFILE_BREAKPAD_OBJECTFILEBREAKPAD_H
11 
12 #include "lldb/Symbol/ObjectFile.h"
13 #include "lldb/Utility/ArchSpec.h"
14 
15 namespace lldb_private {
16 namespace breakpad {
17 
18 class ObjectFileBreakpad : public ObjectFile {
19 public:
20   //------------------------------------------------------------------
21   // Static Functions
22   //------------------------------------------------------------------
23   static void Initialize();
24   static void Terminate();
25 
26   static ConstString GetPluginNameStatic();
27   static const char *GetPluginDescriptionStatic() {
28     return "Breakpad object file reader.";
29   }
30 
31   static ObjectFile *
32   CreateInstance(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
33                  lldb::offset_t data_offset, const FileSpec *file,
34                  lldb::offset_t file_offset, lldb::offset_t length);
35 
36   static ObjectFile *CreateMemoryInstance(const lldb::ModuleSP &module_sp,
37                                           lldb::DataBufferSP &data_sp,
38                                           const lldb::ProcessSP &process_sp,
39                                           lldb::addr_t header_addr);
40 
41   static size_t GetModuleSpecifications(const FileSpec &file,
42                                         lldb::DataBufferSP &data_sp,
43                                         lldb::offset_t data_offset,
44                                         lldb::offset_t file_offset,
45                                         lldb::offset_t length,
46                                         ModuleSpecList &specs);
47 
48   //------------------------------------------------------------------
49   // PluginInterface protocol
50   //------------------------------------------------------------------
51   ConstString GetPluginName() override { return GetPluginNameStatic(); }
52 
53   uint32_t GetPluginVersion() override { return 1; }
54 
55   //------------------------------------------------------------------
56   // ObjectFile Protocol.
57   //------------------------------------------------------------------
58 
59   bool ParseHeader() override;
60 
61   lldb::ByteOrder GetByteOrder() const override {
62     return m_arch.GetByteOrder();
63   }
64 
65   bool IsExecutable() const override { return false; }
66 
67   uint32_t GetAddressByteSize() const override {
68     return m_arch.GetAddressByteSize();
69   }
70 
71   AddressClass GetAddressClass(lldb::addr_t file_addr) override {
72     return AddressClass::eInvalid;
73   }
74 
75   Symtab *GetSymtab() override;
76 
77   bool IsStripped() override { return false; }
78 
79   void CreateSections(SectionList &unified_section_list) override;
80 
81   void Dump(Stream *s) override {}
82 
83   ArchSpec GetArchitecture() override { return m_arch; }
84 
85   UUID GetUUID() override { return m_uuid; }
86 
87   FileSpecList GetDebugSymbolFilePaths() override { return FileSpecList(); }
88 
89   uint32_t GetDependentModules(FileSpecList &files) override { return 0; }
90 
91   Type CalculateType() override { return eTypeDebugInfo; }
92 
93   Strata CalculateStrata() override { return eStrataUser; }
94 
95 private:
96   ArchSpec m_arch;
97   UUID m_uuid;
98 
99   ObjectFileBreakpad(const lldb::ModuleSP &module_sp,
100                      lldb::DataBufferSP &data_sp, lldb::offset_t data_offset,
101                      const FileSpec *file, lldb::offset_t offset,
102                      lldb::offset_t length, ArchSpec arch, UUID uuid);
103 };
104 
105 } // namespace breakpad
106 } // namespace lldb_private
107 #endif // LLDB_PLUGINS_OBJECTFILE_BREAKPAD_OBJECTFILEBREAKPAD_H
108