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