LLDB  mainline
SymbolVendorWasm.cpp
Go to the documentation of this file.
1 //===-- SymbolVendorWasm.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 "SymbolVendorWasm.h"
10 
11 #include <cstring>
12 #include <optional>
13 
15 #include "lldb/Core/Module.h"
16 #include "lldb/Core/ModuleSpec.h"
18 #include "lldb/Core/Section.h"
19 #include "lldb/Host/Host.h"
21 #include "lldb/Symbol/ObjectFile.h"
22 #include "lldb/Target/Target.h"
24 #include "lldb/Utility/Timer.h"
25 
26 using namespace lldb;
27 using namespace lldb_private;
28 using namespace lldb_private::wasm;
29 
31 
32 // SymbolVendorWasm constructor
33 SymbolVendorWasm::SymbolVendorWasm(const lldb::ModuleSP &module_sp)
34  : SymbolVendor(module_sp) {}
35 
36 void SymbolVendorWasm::Initialize() {
37  PluginManager::RegisterPlugin(GetPluginNameStatic(),
38  GetPluginDescriptionStatic(), CreateInstance);
39 }
40 
41 void SymbolVendorWasm::Terminate() {
42  PluginManager::UnregisterPlugin(CreateInstance);
43 }
44 
45 llvm::StringRef SymbolVendorWasm::GetPluginDescriptionStatic() {
46  return "Symbol vendor for WASM that looks for dwo files that match "
47  "executables.";
48 }
49 
50 // CreateInstance
51 //
52 // Platforms can register a callback to use when creating symbol vendors to
53 // allow for complex debug information file setups, and to also allow for
54 // finding separate debug information files.
56 SymbolVendorWasm::CreateInstance(const lldb::ModuleSP &module_sp,
57  lldb_private::Stream *feedback_strm) {
58  if (!module_sp)
59  return nullptr;
60 
61  ObjectFileWasm *obj_file =
62  llvm::dyn_cast_or_null<ObjectFileWasm>(module_sp->GetObjectFile());
63  if (!obj_file)
64  return nullptr;
65 
66  // If the main object file already contains debug info, then we are done.
67  if (obj_file->GetSectionList()->FindSectionByType(
69  return nullptr;
70 
71  LLDB_SCOPED_TIMERF("SymbolVendorWasm::CreateInstance (module = %s)",
72  module_sp->GetFileSpec().GetPath().c_str());
73 
74  ModuleSpec module_spec;
75  module_spec.GetFileSpec() = obj_file->GetFileSpec();
76  FileSystem::Instance().Resolve(module_spec.GetFileSpec());
77  module_spec.GetUUID() = obj_file->GetUUID();
78 
79  // A Wasm module may have a custom section named "external_debug_info" whose
80  // content is the absolute or relative path of the Wasm module that contains
81  // debug symbols for this module.
82  std::optional<FileSpec> symbol_file_spec =
83  obj_file->GetExternalDebugInfoFileSpec();
84  if (!symbol_file_spec)
85  return nullptr;
86  module_spec.GetSymbolFileSpec() = *symbol_file_spec;
87 
88  FileSpecList search_paths = Target::GetDefaultDebugFileSearchPaths();
89  FileSpec sym_fspec =
90  Symbols::LocateExecutableSymbolFile(module_spec, search_paths);
91  if (!sym_fspec)
92  return nullptr;
93 
94  DataBufferSP sym_file_data_sp;
95  lldb::offset_t sym_file_data_offset = 0;
96  ObjectFileSP sym_objfile_sp = ObjectFile::FindPlugin(
97  module_sp, &sym_fspec, 0, FileSystem::Instance().GetByteSize(sym_fspec),
98  sym_file_data_sp, sym_file_data_offset);
99  if (!sym_objfile_sp)
100  return nullptr;
101 
102  // This objfile is for debugging purposes.
103  sym_objfile_sp->SetType(ObjectFile::eTypeDebugInfo);
104 
105  SymbolVendorWasm *symbol_vendor = new SymbolVendorWasm(module_sp);
106 
107  // Get the module unified section list and add our debug sections to
108  // that.
109  SectionList *module_section_list = module_sp->GetSectionList();
110  SectionList *objfile_section_list = sym_objfile_sp->GetSectionList();
111 
112  static const SectionType g_sections[] = {
123  for (SectionType section_type : g_sections) {
124  if (SectionSP section_sp =
125  objfile_section_list->FindSectionByType(section_type, true)) {
126  if (SectionSP module_section_sp =
127  module_section_list->FindSectionByType(section_type, true))
128  module_section_list->ReplaceSection(module_section_sp->GetID(),
129  section_sp);
130  else
131  module_section_list->AddSection(section_sp);
132  }
133  }
134 
135  symbol_vendor->AddSymbolFileRepresentation(sym_objfile_sp);
136  return symbol_vendor;
137 }
lldb_private::wasm::ObjectFileWasm::GetExternalDebugInfoFileSpec
std::optional< FileSpec > GetExternalDebugInfoFileSpec()
A Wasm module that has external DWARF debug information should contain a custom section named "extern...
Definition: ObjectFileWasm.cpp:416
lldb_private::SectionList::ReplaceSection
bool ReplaceSection(lldb::user_id_t sect_id, const lldb::SectionSP &section_sp, uint32_t depth=UINT32_MAX)
Definition: Section.cpp:509
lldb::eSectionTypeDWARFDebugLoc
@ eSectionTypeDWARFDebugLoc
Definition: lldb-enumerations.h:683
LLDB_SCOPED_TIMERF
#define LLDB_SCOPED_TIMERF(...)
Definition: Timer.h:86
lldb_private::ObjectFile::GetFileSpec
virtual FileSpec & GetFileSpec()
Get accessor to the object file specification.
Definition: ObjectFile.h:292
lldb_private::SymbolVendor::AddSymbolFileRepresentation
void AddSymbolFileRepresentation(const lldb::ObjectFileSP &objfile_sp)
Definition: SymbolVendor.cpp:64
ModuleSpec.h
lldb_private::wasm::ObjectFileWasm::GetUUID
UUID GetUUID() override
Gets the UUID for this object file.
Definition: ObjectFileWasm.h:92
Host.h
ObjectFileWasm.h
lldb::eSectionTypeDWARFDebugAranges
@ eSectionTypeDWARFDebugAranges
Definition: lldb-enumerations.h:678
lldb_private::wasm
Definition: DynamicLoaderWasmDYLD.h:15
lldb::eSectionTypeDWARFDebugRanges
@ eSectionTypeDWARFDebugRanges
Definition: lldb-enumerations.h:688
lldb::eSectionTypeDWARFDebugMacro
@ eSectionTypeDWARFDebugMacro
Definition: lldb-enumerations.h:685
lldb::eSectionTypeDWARFDebugFrame
@ eSectionTypeDWARFDebugFrame
Definition: lldb-enumerations.h:680
Module.h
lldb::eSectionTypeDWARFDebugLine
@ eSectionTypeDWARFDebugLine
Definition: lldb-enumerations.h:682
lldb::eSectionTypeDWARFDebugAddr
@ eSectionTypeDWARFDebugAddr
Definition: lldb-enumerations.h:677
LocateSymbolFile.h
lldb_private::SectionList
Definition: Section.h:34
lldb::offset_t
uint64_t offset_t
Definition: lldb-types.h:87
lldb_private::Stream
Definition: Stream.h:28
lldb::eSectionTypeDWARFDebugStrOffsets
@ eSectionTypeDWARFDebugStrOffsets
Definition: lldb-enumerations.h:690
lldb_private::wasm::ObjectFileWasm
Generic Wasm object file reader.
Definition: ObjectFileWasm.h:23
Section.h
lldb_private::SymbolVendor
Definition: SymbolVendor.h:31
lldb_private::ModuleSpec::GetSymbolFileSpec
FileSpec & GetSymbolFileSpec()
Definition: ModuleSpec.h:77
Target.h
lldb_private::ModuleSpec::GetUUID
UUID & GetUUID()
Definition: ModuleSpec.h:99
lldb_private::SectionList::AddSection
size_t AddSection(const lldb::SectionSP &section_sp)
Definition: Section.cpp:469
lldb_private::FileSpec
Definition: FileSpec.h:56
lldb_private::ObjectFile::GetSectionList
virtual SectionList * GetSectionList(bool update_module_section_list=true)
Gets the section list for the currently selected architecture (and object for archives).
Definition: ObjectFile.cpp:588
lldb::eSectionTypeDWARFDebugAbbrev
@ eSectionTypeDWARFDebugAbbrev
Definition: lldb-enumerations.h:676
lldb::eSectionTypeDWARFDebugStr
@ eSectionTypeDWARFDebugStr
Definition: lldb-enumerations.h:689
StreamString.h
lldb::eSectionTypeDWARFDebugInfo
@ eSectionTypeDWARFDebugInfo
Definition: lldb-enumerations.h:681
Timer.h
lldb::eSectionTypeDWARFDebugTypes
@ eSectionTypeDWARFDebugTypes
DWARF .debug_types section.
Definition: lldb-enumerations.h:708
lldb::eSectionTypeDWARFDebugCuIndex
@ eSectionTypeDWARFDebugCuIndex
Definition: lldb-enumerations.h:679
ObjectFile.h
lldb_private::wasm::SymbolVendorWasm
Definition: SymbolVendorWasm.h:18
lldb_private::SectionList::FindSectionByType
lldb::SectionSP FindSectionByType(lldb::SectionType sect_type, bool check_children, size_t start_idx=0) const
Definition: Section.cpp:586
lldb_private::ModuleSpec::GetFileSpec
FileSpec & GetFileSpec()
Definition: ModuleSpec.h:53
lldb_private::ModuleSpec
Definition: ModuleSpec.h:27
lldb::SectionType
SectionType
Definition: lldb-enumerations.h:659
lldb::eSectionTypeDWARFDebugPubTypes
@ eSectionTypeDWARFDebugPubTypes
Definition: lldb-enumerations.h:687
lldb::eSectionTypeDWARFDebugPubNames
@ eSectionTypeDWARFDebugPubNames
Definition: lldb-enumerations.h:686
lldb::eSectionTypeDWARFDebugLineStr
@ eSectionTypeDWARFDebugLineStr
DWARF v5 .debug_line_str.
Definition: lldb-enumerations.h:711
PluginManager.h
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
SymbolVendorWasm.h
LLDB_PLUGIN_DEFINE
#define LLDB_PLUGIN_DEFINE(PluginName)
Definition: PluginManager.h:31
lldb::eSectionTypeDWARFDebugMacInfo
@ eSectionTypeDWARFDebugMacInfo
Definition: lldb-enumerations.h:684
lldb
Definition: SBAddress.h:15
lldb::eSectionTypeDWARFDebugLocLists
@ eSectionTypeDWARFDebugLocLists
DWARF v5 .debug_loclists.
Definition: lldb-enumerations.h:713
lldb::eSectionTypeDWARFDebugRngLists
@ eSectionTypeDWARFDebugRngLists
DWARF v5 .debug_rnglists.
Definition: lldb-enumerations.h:712