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"
22#include "lldb/Target/Target.h"
24#include "lldb/Utility/Timer.h"
25
26using namespace lldb;
27using namespace lldb_private;
28using namespace lldb_private::wasm;
29
31
32// SymbolVendorWasm constructor
33SymbolVendorWasm::SymbolVendorWasm(const lldb::ModuleSP &module_sp)
34 : SymbolVendor(module_sp) {}
35
39}
40
43}
44
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.
56SymbolVendorWasm::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();
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 =
84 if (!symbol_file_spec)
85 return nullptr;
86 module_spec.GetSymbolFileSpec() = *symbol_file_spec;
87
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 if (!module_section_list || !objfile_section_list)
113 return nullptr;
114
115 static const SectionType g_sections[] = {
126 for (SectionType section_type : g_sections) {
127 if (SectionSP section_sp =
128 objfile_section_list->FindSectionByType(section_type, true)) {
129 if (SectionSP module_section_sp =
130 module_section_list->FindSectionByType(section_type, true))
131 module_section_list->ReplaceSection(module_section_sp->GetID(),
132 section_sp);
133 else
134 module_section_list->AddSection(section_sp);
135 }
136 }
137
138 symbol_vendor->AddSymbolFileRepresentation(sym_objfile_sp);
139 return symbol_vendor;
140}
#define LLDB_PLUGIN_DEFINE(PluginName)
Definition: PluginManager.h:31
#define LLDB_SCOPED_TIMERF(...)
Definition: Timer.h:86
A file collection class.
Definition: FileSpecList.h:24
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.
@ eTypeDebugInfo
An object file that contains only debug information.
Definition: ObjectFile.h:54
virtual FileSpec & GetFileSpec()
Get accessor to the object file specification.
Definition: ObjectFile.h:273
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
static bool RegisterPlugin(llvm::StringRef name, llvm::StringRef description, ABICreateInstance create_callback)
static bool UnregisterPlugin(ABICreateInstance create_callback)
size_t AddSection(const lldb::SectionSP &section_sp)
Definition: Section.cpp:469
bool ReplaceSection(lldb::user_id_t sect_id, const lldb::SectionSP &section_sp, uint32_t depth=UINT32_MAX)
Definition: Section.cpp:509
lldb::SectionSP FindSectionByType(lldb::SectionType sect_type, bool check_children, size_t start_idx=0) const
Definition: Section.cpp:586
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
void AddSymbolFileRepresentation(const lldb::ObjectFileSP &objfile_sp)
static FileSpec LocateExecutableSymbolFile(const ModuleSpec &module_spec, const FileSpecList &default_search_paths)
static FileSpecList GetDefaultDebugFileSearchPaths()
Definition: Target.cpp:2524
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
@ 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