Skip to content

[lldb][Module] Only call LoadScriptingResourceInTarget via ModuleList #190136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Michael137 merged 3 commits into from
Apr 3, 2026
Merged

[lldb][Module] Only call LoadScriptingResourceInTarget via ModuleList #190136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92b22d4
[lldb][Module] Only call LoadScriptingResourceInTarget via ModuleList
Michael137 Apr 2, 2026
450127a
fixup! fix whitespace; more readable constructor call
Michael137 Apr 3, 2026
8ddda38
fixup! clang-format
Michael137 Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions lldb/include/lldb/Core/Module.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,8 +510,6 @@ class Module : public std::enable_shared_from_this<Module>,
/// \b true if it is, \b false otherwise.
bool IsLoadedInTarget(Target *target);

bool LoadScriptingResourceInTarget(Target *target, Status &error);

/// Get the number of compile units for this module.
///
/// \return
Expand Down
5 changes: 5 additions & 0 deletions lldb/include/lldb/Core/ModuleList.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,11 @@ class ModuleList {
/// An orphaned module that lives only in the ModuleList has a count of 1.
static constexpr long kUseCountModuleListOrphaned = 1;

private:
static bool LoadScriptingResourceInTargetForModule(Module &module,
Target &target,
Status &error);

public:
typedef LockingAdaptedIterable<std::recursive_mutex, collection>
ModuleIterable;
Expand Down
14 changes: 4 additions & 10 deletions lldb/source/Commands/CommandObjectTarget.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4400,16 +4400,10 @@ class CommandObjectTargetSymbolsAdd : public CommandObjectParsed {

// Make sure we load any scripting resources that may be embedded
// in the debug info files in case the platform supports that.
Status error;
module_sp->LoadScriptingResourceInTarget(target, error);
if (error.Fail() && error.AsCString())
result.AppendWarningWithFormat(
"unable to load scripting data for module %s - error "
"reported was %s",
module_sp->GetFileSpec()
.GetFileNameStrippingExtension()
.GetCString(),
error.AsCString());
std::list<Status> errors;
module_list.LoadScriptingResourcesInTarget(target, errors);
for (const auto &err : errors)
result.AppendWarning(err.AsCString());

flush = true;
result.SetStatus(eReturnStatusSuccessFinishResult);
Expand Down
87 changes: 0 additions & 87 deletions lldb/source/Core/Module.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1419,93 +1419,6 @@ bool Module::IsLoadedInTarget(Target *target) {
return false;
}

static bool LoadScriptingModule(const FileSpec &scripting_fspec,
ScriptInterpreter &script_interpreter,
Target &target, Status &error) {
assert(scripting_fspec);

StreamString scripting_stream;
scripting_fspec.Dump(scripting_stream.AsRawOstream());
LoadScriptOptions options;
return script_interpreter.LoadScriptingModule(
scripting_stream.GetData(), options, error,
/*module_sp*/ nullptr, /*extra_path*/ {}, target.shared_from_this());
}

bool Module::LoadScriptingResourceInTarget(Target *target, Status &error) {
Log *log = GetLog(LLDBLog::Modules);

if (!target) {
error = Status::FromErrorString("invalid destination Target");
return false;
}

Debugger &debugger = target->GetDebugger();
const ScriptLanguage script_language = debugger.GetScriptLanguage();
if (script_language == eScriptLanguageNone)
return true;

ScriptInterpreter *script_interpreter = debugger.GetScriptInterpreter();
if (!script_interpreter) {
error = Status::FromErrorString("invalid ScriptInterpreter");
return false;
}

PlatformSP platform_sp(target->GetPlatform());

if (!platform_sp) {
error = Status::FromErrorString("invalid Platform");
return false;
}

StreamString feedback_stream;
llvm::SmallDenseMap<FileSpec, LoadScriptFromSymFile> file_specs =
platform_sp->LocateExecutableScriptingResources(target, *this,
feedback_stream);

if (!feedback_stream.Empty())
debugger.ReportWarning(feedback_stream.GetString().str(), debugger.GetID());

for (const auto &[scripting_fspec, load_style] : file_specs) {
if (load_style == eLoadScriptFromSymFileFalse)
continue;

if (!FileSystem::Instance().Exists(scripting_fspec))
continue;

if (load_style == eLoadScriptFromSymFileWarn) {
// clang-format off
debugger.ReportWarning(
llvm::formatv(
R"('{0}' contains a debug script. To run this script in this debug session:

command script import "{1}"

To run all discovered debug scripts in this session:

settings set target.load-script-from-symbol-file true
)",
GetFileSpec().GetFileNameStrippingExtension(),
scripting_fspec.GetPath()),
debugger.GetID());
// clang-format on

return false;
}

LLDB_LOG(log, "Auto-loading {0}", scripting_fspec.GetPath());

if (!LoadScriptingModule(scripting_fspec, *script_interpreter, *target,
error)) {
LLDB_LOG(log, "Failed to load '{0}'. Remaining scripts won't be loaded.",
scripting_fspec.GetPath());
return false;
}
}

return true;
}

bool Module::SetArchitecture(const ArchSpec &new_arch) {
if (!m_arch.IsValid()) {
m_arch = new_arch;
Expand Down
85 changes: 84 additions & 1 deletion lldb/source/Core/ModuleList.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1332,6 +1332,89 @@ bool ModuleList::RemoveSharedModuleIfOrphaned(const ModuleWP module_wp) {
return GetSharedModuleList().RemoveIfOrphaned(module_wp);
}

static bool LoadScriptingModule(const FileSpec &scripting_fspec,
ScriptInterpreter &script_interpreter,
Target &target, Status &error) {
assert(scripting_fspec);

StreamString scripting_stream;
scripting_fspec.Dump(scripting_stream.AsRawOstream());
LoadScriptOptions options;
return script_interpreter.LoadScriptingModule(
scripting_stream.GetData(), options, error,
/*module_sp*/ nullptr, /*extra_path*/ {}, target.shared_from_this());
}

bool ModuleList::LoadScriptingResourceInTargetForModule(Module &module,
Target &target,
Status &error) {
Comment on lines +1348 to +1350

@JDevlieghere JDevlieghere Apr 2, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this return an llvm::Error?

@Michael137 Michael137 Apr 3, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be better, agreed. Though I'll do that in a separate PR because it's not as straightforward as hoped (mainly because the API we call also populate Status).

Log *log = GetLog(LLDBLog::Modules);

Debugger &debugger = target.GetDebugger();
const ScriptLanguage script_language = debugger.GetScriptLanguage();
if (script_language == eScriptLanguageNone)
return true;

ScriptInterpreter *script_interpreter = debugger.GetScriptInterpreter();
if (!script_interpreter) {
error = Status::FromErrorString("invalid ScriptInterpreter");
return false;
}

PlatformSP platform_sp = target.GetPlatform();
if (!platform_sp) {
error = Status::FromErrorString("invalid Platform");
return false;
}

StreamString feedback_stream;
llvm::SmallDenseMap<FileSpec, LoadScriptFromSymFile> file_specs =
platform_sp->LocateExecutableScriptingResources(&target, module,
feedback_stream);

if (!feedback_stream.Empty())
debugger.ReportWarning(feedback_stream.GetString().str(), debugger.GetID());

for (const auto &[scripting_fspec, load_style] : file_specs) {
if (load_style == eLoadScriptFromSymFileFalse)
continue;

if (!FileSystem::Instance().Exists(scripting_fspec))
continue;

if (load_style == eLoadScriptFromSymFileWarn) {
// clang-format off
debugger.ReportWarning(
llvm::formatv(
R"('{0}' contains a debug script. To run this script in this debug session:

command script import "{1}"

To run all discovered debug scripts in this session:

settings set target.load-script-from-symbol-file true
)",
module.GetFileSpec().GetFileNameStrippingExtension(),
scripting_fspec.GetPath()),
debugger.GetID());
// clang-format on

return false;
}

LLDB_LOG(log, "Auto-loading {0}", scripting_fspec.GetPath());

if (!LoadScriptingModule(scripting_fspec, *script_interpreter, target,
error)) {
LLDB_LOG(log, "Failed to load '{0}'. Remaining scripts won't be loaded.",
scripting_fspec.GetPath());
return false;
}
}

return true;
}

bool ModuleList::LoadScriptingResourcesInTarget(Target *target,
std::list<Status> &errors,
bool continue_on_error) {
Expand All @@ -1347,7 +1430,7 @@ bool ModuleList::LoadScriptingResourcesInTarget(Target *target,
for (auto module : tmp_module_list.ModulesNoLocking()) {
if (module) {
Status error;
if (!module->LoadScriptingResourceInTarget(target, error)) {
if (!LoadScriptingResourceInTargetForModule(*module, *target, error)) {
if (error.Fail() && error.AsCString()) {
error = Status::FromErrorStringWithFormat(
"unable to load scripting data for "
Expand Down
19 changes: 5 additions & 14 deletions lldb/source/Target/Target.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1542,19 +1542,6 @@ Module *Target::GetExecutableModulePointer() {
return GetExecutableModule().get();
}

static void LoadScriptingResourceForModule(const ModuleSP &module_sp,
Target *target) {
Status error;
if (module_sp && !module_sp->LoadScriptingResourceInTarget(target, error)) {
if (error.AsCString())
target->GetDebugger().GetAsyncErrorStream()->Printf(
"unable to load scripting data for module %s - error reported was "
"%s\n",
module_sp->GetFileSpec().GetFileNameStrippingExtension().GetCString(),
error.AsCString());
}
}

void Target::ClearModules(bool delete_locations) {
ModulesDidUnload(m_images, delete_locations);
m_section_load_history.Clear();
Expand Down Expand Up @@ -1857,9 +1844,13 @@ void Target::ModulesDidLoad(ModuleList &module_list) {

const size_t num_images = module_list.GetSize();
if (m_valid && num_images) {
std::list<Status> errors;
module_list.LoadScriptingResourcesInTarget(this, errors);
for (const auto &err : errors)
GetDebugger().GetAsyncErrorStream()->PutCString(err.AsCString());

for (size_t idx = 0; idx < num_images; ++idx) {
ModuleSP module_sp(module_list.GetModuleAtIndex(idx));
LoadScriptingResourceForModule(module_sp, this);
LoadTypeSummariesForModule(module_sp);
LoadFormattersForModule(module_sp);
}
Expand Down
Loading