LLDB mainline
ObjectFileBreakpad.h
Go to the documentation of this file.
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_SOURCE_PLUGINS_OBJECTFILE_BREAKPAD_OBJECTFILEBREAKPAD_H
10#define LLDB_SOURCE_PLUGINS_OBJECTFILE_BREAKPAD_OBJECTFILEBREAKPAD_H
11
14
15namespace lldb_private {
16namespace breakpad {
17
19public:
20 // Static Functions
21 static void Initialize();
22 static void Terminate();
23
24 static llvm::StringRef GetPluginNameStatic() { return "breakpad"; }
25 static const char *GetPluginDescriptionStatic() {
26 return "Breakpad object file reader.";
27 }
28
29 static ObjectFile *CreateInstance(const lldb::ModuleSP &module_sp,
30 lldb::DataExtractorSP extractor_sp,
31 lldb::offset_t data_offset,
32 const FileSpec *file,
33 lldb::offset_t file_offset,
34 lldb::offset_t length);
35
36 static ObjectFile *CreateMemoryInstance(const lldb::ModuleSP &module_sp,
38 const lldb::ProcessSP &process_sp,
39 lldb::addr_t header_addr);
40
41 static size_t GetModuleSpecifications(const FileSpec &file,
42 lldb::DataExtractorSP &extractor_sp,
43 lldb::offset_t data_offset,
44 lldb::offset_t file_offset,
45 lldb::offset_t length,
46 ModuleSpecList &specs);
47
48 // PluginInterface protocol
49 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
50
51 // LLVM RTTI support
52 static char ID;
53 bool isA(const void *ClassID) const override {
54 return ClassID == &ID || ObjectFile::isA(ClassID);
55 }
56 static bool classof(const ObjectFile *obj) { return obj->isA(&ID); }
57
58 // ObjectFile Protocol.
59
60 bool ParseHeader() override;
61
62 lldb::ByteOrder GetByteOrder() const override {
63 return m_arch.GetByteOrder();
64 }
65
66 bool IsExecutable() const override { return false; }
67
68 uint32_t GetAddressByteSize() const override {
69 return m_arch.GetAddressByteSize();
70 }
71
74 }
75
76 void ParseSymtab(lldb_private::Symtab &symtab) override;
77
78 bool IsStripped() override { return false; }
79
80 void CreateSections(SectionList &unified_section_list) override;
81
82 void Dump(Stream *s) override {}
83
84 ArchSpec GetArchitecture() override { return m_arch; }
85
86 UUID GetUUID() override { return m_uuid; }
87
88 uint32_t GetDependentModules(FileSpecList &files) override { return 0; }
89
90 Type CalculateType() override { return eTypeDebugInfo; }
91
92 Strata CalculateStrata() override { return eStrataUser; }
93
94private:
97
98 ObjectFileBreakpad(const lldb::ModuleSP &module_sp,
99 lldb::DataExtractorSP extractor_sp,
100 lldb::offset_t data_offset, const FileSpec *file,
101 lldb::offset_t offset, lldb::offset_t length,
102 ArchSpec arch, UUID uuid);
103};
104
105} // namespace breakpad
106} // namespace lldb_private
107#endif // LLDB_SOURCE_PLUGINS_OBJECTFILE_BREAKPAD_OBJECTFILEBREAKPAD_H
An architecture specification class.
Definition ArchSpec.h:31
A file collection class.
A file utility class.
Definition FileSpec.h:57
A plug-in interface definition class for object file parsers.
Definition ObjectFile.h:46
@ eTypeDebugInfo
An object file that contains only debug information.
Definition ObjectFile.h:57
virtual bool isA(const void *ClassID) const
Definition ObjectFile.h:218
ObjectFile(const lldb::ModuleSP &module_sp, const FileSpec *file_spec_ptr, lldb::offset_t file_offset, lldb::offset_t length, lldb::DataExtractorSP extractor_sp, lldb::offset_t data_offset)
Construct with a parent module, offset, and header data.
A stream class that can stream formatted output to a file.
Definition Stream.h:28
Represents UUID's of various sizes.
Definition UUID.h:27
lldb::ByteOrder GetByteOrder() const override
Gets whether endian swapping should occur when extracting data from this object file.
static ObjectFile * CreateMemoryInstance(const lldb::ModuleSP &module_sp, lldb::WritableDataBufferSP data_sp, const lldb::ProcessSP &process_sp, lldb::addr_t header_addr)
void Dump(Stream *s) override
Dump a description of this object to a Stream.
uint32_t GetDependentModules(FileSpecList &files) override
Extract the dependent modules from an object file.
ObjectFileBreakpad(const lldb::ModuleSP &module_sp, lldb::DataExtractorSP extractor_sp, lldb::offset_t data_offset, const FileSpec *file, lldb::offset_t offset, lldb::offset_t length, ArchSpec arch, UUID uuid)
Type CalculateType() override
The object file should be able to calculate its type by looking at its file header and possibly the s...
uint32_t GetAddressByteSize() const override
Gets the address size in bytes for the current object file.
void ParseSymtab(lldb_private::Symtab &symtab) override
Parse the symbol table into the provides symbol table object.
bool ParseHeader() override
Attempts to parse the object header.
static ObjectFile * CreateInstance(const lldb::ModuleSP &module_sp, lldb::DataExtractorSP extractor_sp, lldb::offset_t data_offset, const FileSpec *file, lldb::offset_t file_offset, lldb::offset_t length)
bool IsStripped() override
Detect if this object file has been stripped of local symbols.
void CreateSections(SectionList &unified_section_list) override
Strata CalculateStrata() override
The object file should be able to calculate the strata of the object file.
UUID GetUUID() override
Gets the UUID for this object file.
static size_t GetModuleSpecifications(const FileSpec &file, lldb::DataExtractorSP &extractor_sp, lldb::offset_t data_offset, lldb::offset_t file_offset, lldb::offset_t length, ModuleSpecList &specs)
bool isA(const void *ClassID) const override
bool IsExecutable() const override
Tells whether this object file is capable of being the main executable for a process.
static bool classof(const ObjectFile *obj)
ArchSpec GetArchitecture() override
Get the ArchSpec for this object file.
AddressClass GetAddressClass(lldb::addr_t file_addr) override
Get the address type given a file address in an object file.
A class that represents a running process on the host machine.
uint64_t offset_t
Definition lldb-types.h:85
std::shared_ptr< lldb_private::Process > ProcessSP
ByteOrder
Byte ordering definitions.
std::shared_ptr< lldb_private::WritableDataBuffer > WritableDataBufferSP
uint64_t addr_t
Definition lldb-types.h:80
std::shared_ptr< lldb_private::DataExtractor > DataExtractorSP
std::shared_ptr< lldb_private::Module > ModuleSP