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"
18#include "lldb/Core/Section.h"
19#include "lldb/Host/Host.h"
21#include "lldb/Target/Target.h"
23#include "lldb/Utility/Timer.h"
24
25using namespace lldb;
26using namespace lldb_private;
27using namespace lldb_private::wasm;
28
30
31// SymbolVendorWasm constructor
33 : SymbolVendor(module_sp) {}
34
38}
39
42}
43
45 return "Symbol vendor for WASM that looks for dwo files that match "
46 "executables.";
47}
48
49// CreateInstance
50//
51// Platforms can register a callback to use when creating symbol vendors to
52// allow for complex debug information file setups, and to also allow for
53// finding separate debug information files.
56 lldb_private::Stream *feedback_strm) {
57 if (!module_sp)
58 return nullptr;
59
60 ObjectFileWasm *obj_file =
61 llvm::dyn_cast_or_null<ObjectFileWasm>(module_sp->GetObjectFile());
62 if (!obj_file)
63 return nullptr;
64
65 // If the main object file already contains debug info, then we are done.
66 if (obj_file->GetSectionList()->FindSectionByType(
68 return nullptr;
69
70 LLDB_SCOPED_TIMERF("SymbolVendorWasm::CreateInstance (module = %s)",
71 module_sp->GetFileSpec().GetPath().c_str());
72
73 ModuleSpec module_spec;
74 module_spec.GetFileSpec() = obj_file->GetFileSpec();
76 module_spec.GetUUID() = obj_file->GetUUID();
77
78 // A Wasm module may have a custom section named "external_debug_info" whose
79 // content is the absolute or relative path of the Wasm module that contains
80 // debug symbols for this module.
81 std::optional<FileSpec> symbol_file_spec =
83 if (!symbol_file_spec)
84 return nullptr;
85 module_spec.GetSymbolFileSpec() = *symbol_file_spec;
86
88 FileSpec sym_fspec =
89 PluginManager::LocateExecutableSymbolFile(module_spec, search_paths);
90 if (!sym_fspec)
91 return nullptr;
92
93 DataBufferSP sym_file_data_sp;
94 lldb::offset_t sym_file_data_offset = 0;
95 ObjectFileSP sym_objfile_sp = ObjectFile::FindPlugin(
96 module_sp, &sym_fspec, 0, FileSystem::Instance().GetByteSize(sym_fspec),
97 sym_file_data_sp, sym_file_data_offset);
98 if (!sym_objfile_sp)
99 return nullptr;
100
101 // This objfile is for debugging purposes.
102 sym_objfile_sp->SetType(ObjectFile::eTypeDebugInfo);
103
104 SymbolVendorWasm *symbol_vendor = new SymbolVendorWasm(module_sp);
105
106 // Get the module unified section list and add our debug sections to
107 // that.
108 SectionList *module_section_list = module_sp->GetSectionList();
109 SectionList *objfile_section_list = sym_objfile_sp->GetSectionList();
110
111 if (!module_section_list || !objfile_section_list)
112 return nullptr;
113
114 static const SectionType g_sections[] = {
125 for (SectionType section_type : g_sections) {
126 if (SectionSP section_sp =
127 objfile_section_list->FindSectionByType(section_type, true)) {
128 if (SectionSP module_section_sp =
129 module_section_list->FindSectionByType(section_type, true))
130 module_section_list->ReplaceSection(module_section_sp->GetID(),
131 section_sp);
132 else
133 module_section_list->AddSection(section_sp);
134 }
135 }
136
137 symbol_vendor->AddSymbolFileRepresentation(sym_objfile_sp);
138 return symbol_vendor;
139}
#define LLDB_PLUGIN_DEFINE(PluginName)
Definition: PluginManager.h:31
#define LLDB_SCOPED_TIMERF(...)
Definition: Timer.h:86
A file collection class.
Definition: FileSpecList.h:85
A file utility class.
Definition: FileSpec.h:56
void Resolve(llvm::SmallVectorImpl< char > &path)
Resolve path to make it canonical.
static FileSystem & Instance()
FileSpec & GetFileSpec()
Definition: ModuleSpec.h:53
FileSpec & GetSymbolFileSpec()
Definition: ModuleSpec.h:77
static lldb::ObjectFileSP FindPlugin(const lldb::ModuleSP &module_sp, const FileSpec *file_spec, lldb::offset_t file_offset, lldb::offset_t file_size, lldb::DataBufferSP &data_sp, lldb::offset_t &data_offset)
Find a ObjectFile plug-in that can parse file_spec.
Definition: ObjectFile.cpp:53
@ eTypeDebugInfo
An object file that contains only debug information.
Definition: ObjectFile.h:55
virtual FileSpec & GetFileSpec()
Get accessor to the object file specification.
Definition: ObjectFile.h:274
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:590
static bool RegisterPlugin(llvm::StringRef name, llvm::StringRef description, ABICreateInstance create_callback)
static FileSpec LocateExecutableSymbolFile(const ModuleSpec &module_spec, const FileSpecList &default_search_paths)
static bool UnregisterPlugin(ABICreateInstance create_callback)
size_t AddSection(const lldb::SectionSP &section_sp)
Definition: Section.cpp:475
bool ReplaceSection(lldb::user_id_t sect_id, const lldb::SectionSP &section_sp, uint32_t depth=UINT32_MAX)
Definition: Section.cpp:515
lldb::SectionSP FindSectionByType(lldb::SectionType sect_type, bool check_children, size_t start_idx=0) const
Definition: Section.cpp:592
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
void AddSymbolFileRepresentation(const lldb::ObjectFileSP &objfile_sp)
static FileSpecList GetDefaultDebugFileSearchPaths()
Definition: Target.cpp:2606
Generic Wasm object file reader.
std::optional< FileSpec > GetExternalDebugInfoFileSpec()
A Wasm module that has external DWARF debug information should contain a custom section named "extern...
UUID GetUUID() override
Gets the UUID for this object file.
static llvm::StringRef GetPluginDescriptionStatic()
static llvm::StringRef GetPluginNameStatic()
static lldb_private::SymbolVendor * CreateInstance(const lldb::ModuleSP &module_sp, lldb_private::Stream *feedback_strm)
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
Definition: SBAddress.h:15
uint64_t offset_t
Definition: lldb-types.h:83
std::shared_ptr< lldb_private::ObjectFile > ObjectFileSP
Definition: lldb-forward.h:367
std::shared_ptr< lldb_private::DataBuffer > DataBufferSP
Definition: lldb-forward.h:328
std::shared_ptr< lldb_private::Section > SectionSP
Definition: lldb-forward.h:406
@ eSectionTypeDWARFDebugStrOffsets
@ eSectionTypeDWARFDebugPubNames
@ eSectionTypeDWARFDebugFrame
@ eSectionTypeDWARFDebugLocLists
DWARF v5 .debug_loclists.
@ eSectionTypeDWARFDebugTypes
DWARF .debug_types section.
@ eSectionTypeDWARFDebugMacInfo
@ eSectionTypeDWARFDebugRngLists
DWARF v5 .debug_rnglists.
@ eSectionTypeDWARFDebugMacro
@ eSectionTypeDWARFDebugInfo
@ eSectionTypeDWARFDebugRanges
@ eSectionTypeDWARFDebugLine
@ eSectionTypeDWARFDebugPubTypes
@ eSectionTypeDWARFDebugStr
@ eSectionTypeDWARFDebugLineStr
DWARF v5 .debug_line_str.
@ eSectionTypeDWARFDebugLoc
@ eSectionTypeDWARFDebugCuIndex
@ eSectionTypeDWARFDebugAranges
@ eSectionTypeDWARFDebugAbbrev
@ eSectionTypeDWARFDebugAddr
std::shared_ptr< lldb_private::Module > ModuleSP
Definition: lldb-forward.h:365