1 //===-- YAMLModuleTester.cpp ----------------------------------------------===//
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 #include "TestingSupport/Symbol/YAMLModuleTester.h"
10 #include "lldb/Core/Section.h"
11 #include "llvm/ObjectYAML/DWARFEmitter.h"
12 
13 using namespace lldb_private;
14 
15 /// A mock module holding an object file parsed from YAML.
16 class YAMLModule : public lldb_private::Module {
17 public:
18   YAMLModule(ArchSpec &arch) : Module(FileSpec("test"), arch) {}
19   void SetObjectFile(lldb::ObjectFileSP obj_file) { m_objfile_sp = obj_file; }
20   ObjectFile *GetObjectFile() override { return m_objfile_sp.get(); }
21 };
22 
23 /// A mock object file that can be parsed from YAML.
24 class YAMLObjectFile : public lldb_private::ObjectFile {
25   const lldb::ModuleSP m_module_sp;
26   llvm::StringMap<std::unique_ptr<llvm::MemoryBuffer>> &m_section_map;
27   /// Because there is only one DataExtractor in the ObjectFile
28   /// interface, all sections are copied into a contiguous buffer.
29   std::vector<char> m_buffer;
30 
31 public:
32   YAMLObjectFile(const lldb::ModuleSP &module_sp,
33                  llvm::StringMap<std::unique_ptr<llvm::MemoryBuffer>> &map)
34       : ObjectFile(module_sp, &module_sp->GetFileSpec(), /*file_offset*/ 0,
35                    /*length*/ 0, /*data_sp*/ nullptr, /*data_offset*/ 0),
36         m_module_sp(module_sp), m_section_map(map) {}
37 
38   /// Callback for initializing the module's list of sections.
39   void CreateSections(SectionList &unified_section_list) override {
40     lldb::offset_t total_bytes = 0;
41     for (auto &entry : m_section_map)
42       total_bytes += entry.getValue()->getBufferSize();
43     m_buffer.reserve(total_bytes);
44     m_data =
45         DataExtractor(m_buffer.data(), total_bytes, lldb::eByteOrderLittle, 4);
46 
47     lldb::user_id_t sect_id = 1;
48     for (auto &entry : m_section_map) {
49       llvm::StringRef name = entry.getKey();
50       lldb::SectionType sect_type =
51           llvm::StringSwitch<lldb::SectionType>(name)
52               .Case("debug_info", lldb::eSectionTypeDWARFDebugInfo)
53               .Case("debug_abbrev", lldb::eSectionTypeDWARFDebugAbbrev);
54       auto &membuf = entry.getValue();
55       lldb::addr_t file_vm_addr = 0;
56       lldb::addr_t vm_size = 0;
57       lldb::offset_t file_offset = m_buffer.size();
58       lldb::offset_t file_size = membuf->getBufferSize();
59       m_buffer.resize(file_offset + file_size);
60       memcpy(m_buffer.data() + file_offset, membuf->getBufferStart(),
61              file_size);
62       uint32_t log2align = 0;
63       uint32_t flags = 0;
64       auto section_sp = std::make_shared<lldb_private::Section>(
65           m_module_sp, this, sect_id++, ConstString(name), sect_type,
66           file_vm_addr, vm_size, file_offset, file_size, log2align, flags);
67       unified_section_list.AddSection(section_sp);
68     }
69   }
70 
71   /// \{
72   /// Stub methods that aren't needed here.
73   ConstString GetPluginName() override { return ConstString("YAMLObjectFile"); }
74   uint32_t GetPluginVersion() override { return 0; }
75   void Dump(Stream *s) override {}
76   uint32_t GetAddressByteSize() const override { return 8; }
77   uint32_t GetDependentModules(FileSpecList &file_list) override { return 0; }
78   bool IsExecutable() const override { return 0; }
79   ArchSpec GetArchitecture() override { return {}; }
80   Symtab *GetSymtab() override { return nullptr; }
81   bool IsStripped() override { return false; }
82   UUID GetUUID() override { return {}; }
83   lldb::ByteOrder GetByteOrder() const override {
84     return lldb::eByteOrderLittle;
85   }
86   bool ParseHeader() override { return false; }
87   Type CalculateType() override { return {}; }
88   Strata CalculateStrata() override { return {}; }
89   /// \}
90 };
91 
92 YAMLModuleTester::YAMLModuleTester(llvm::StringRef yaml_data,
93                                    llvm::StringRef triple) {
94   auto sections_map = llvm::DWARFYAML::EmitDebugSections(yaml_data, true);
95   if (!sections_map)
96     return;
97   m_sections_map = std::move(*sections_map);
98   ArchSpec arch(triple);
99   m_module_sp = std::make_shared<YAMLModule>(arch);
100   m_objfile_sp = std::make_shared<YAMLObjectFile>(m_module_sp, m_sections_map);
101   static_cast<YAMLModule *>(m_module_sp.get())->SetObjectFile(m_objfile_sp);
102 
103   lldb::user_id_t uid = 0;
104   llvm::StringRef raw_debug_info = m_sections_map["debug_info"]->getBuffer();
105   lldb_private::DataExtractor debug_info(
106       raw_debug_info.data(), raw_debug_info.size(),
107       m_objfile_sp->GetByteOrder(), m_objfile_sp->GetAddressByteSize());
108   lldb::offset_t offset_ptr = 0;
109   m_symfile_dwarf = std::make_unique<SymbolFileDWARF>(m_objfile_sp, nullptr);
110   llvm::Expected<DWARFUnitSP> dwarf_unit = DWARFUnit::extract(
111       *m_symfile_dwarf, uid,
112       *static_cast<lldb_private::DWARFDataExtractor *>(&debug_info),
113       DIERef::DebugInfo, &offset_ptr);
114   if (dwarf_unit)
115     m_dwarf_unit = dwarf_unit.get();
116 }
117