1ee03d1e09
## Summary
Based on discussion from
[RFC](https://discourse.llvm.org/t/rfc-python-callback-for-source-file-resolution/83545),
this PR adds a new `SymbolLocatorScripted` plugin that allows Python
scripts to implement custom symbol and source file resolution logic.
This enables downstream users to build custom symbol servers, source
file remapping, and build artifact resolution entirely in Python.
### Changes
- Adds `LocateSourceFile()` to the SymbolLocator plugin interface,
called during source path resolution with a fully loaded `ModuleSP`, so
the plugin has access to the module's UUID, file paths, and symbols.
- Adds `SymbolLocatorScripted` plugin that delegates all four
SymbolLocator methods (`LocateExecutableObjectFile`,
`LocateExecutableSymbolFile`, `DownloadObjectAndSymbolFile`,
`LocateSourceFile`) to a user-provided Python class.
- Adds `ScriptedSymbolLocatorPythonInterface` to bridge C++ calls to
Python, with proper GIL management and error handling.
- Results for `LocateSourceFile` are cached per (module UUID, source
file) pair.
- The Python class is configured via: `settings set
plugin.symbol-locator.scripted.script-class module.ClassName`
### Python class interface
```python
class MyLocator:
def __init__(self, exe_ctx, args): ...
def locate_source_file(self, module, original_source_file):
...
def locate_executable_object_file(self, module_spec): ...
def locate_executable_symbol_file(self, module_spec,
default_search_paths): ...
def download_object_and_symbol_file(self, module_spec,
force_lookup, copy_executable): ...
```
### Test plan
```
Added TestScriptedSymbolLocator.py with 3 test cases:
- test_locate_source_file — verifies the locator resolves source
files, receives a valid SBModule with UUID, and remaps paths correctly
- test_locate_source_file_none_fallthrough — verifies returning
None falls through to default LLDB resolution, and that having no script
class set works normally
- test_invalid_script_class — verifies graceful handling of
invalid class names without crashing
```
Co-authored-by: Rahul Reddy Chamala <rachamal@fb.com>
72 lines
2.6 KiB
C++
72 lines
2.6 KiB
C++
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLDB_PLUGINS_SCRIPTINTERPRETER_PYTHON_INTERFACES_SCRIPTEDSYMBOLLOCATORPYTHONINTERFACE_H
|
|
#define LLDB_PLUGINS_SCRIPTINTERPRETER_PYTHON_INTERFACES_SCRIPTEDSYMBOLLOCATORPYTHONINTERFACE_H
|
|
|
|
#include "lldb/Host/Config.h"
|
|
#include "lldb/Interpreter/Interfaces/ScriptedSymbolLocatorInterface.h"
|
|
|
|
#if LLDB_ENABLE_PYTHON
|
|
|
|
#include "ScriptedPythonInterface.h"
|
|
|
|
#include <optional>
|
|
|
|
namespace lldb_private {
|
|
class ScriptedSymbolLocatorPythonInterface
|
|
: public ScriptedSymbolLocatorInterface,
|
|
public ScriptedPythonInterface,
|
|
public PluginInterface {
|
|
public:
|
|
ScriptedSymbolLocatorPythonInterface(
|
|
ScriptInterpreterPythonImpl &interpreter);
|
|
|
|
llvm::Expected<StructuredData::GenericSP>
|
|
CreatePluginObject(const llvm::StringRef class_name,
|
|
ExecutionContext &exe_ctx,
|
|
StructuredData::DictionarySP args_sp,
|
|
StructuredData::Generic *script_obj = nullptr) override;
|
|
|
|
llvm::SmallVector<AbstractMethodRequirement>
|
|
GetAbstractMethodRequirements() const override {
|
|
return llvm::SmallVector<AbstractMethodRequirement>(
|
|
{{"locate_source_file", 2}});
|
|
}
|
|
|
|
std::optional<ModuleSpec>
|
|
LocateExecutableObjectFile(const ModuleSpec &module_spec,
|
|
Status &error) override;
|
|
|
|
std::optional<FileSpec>
|
|
LocateExecutableSymbolFile(const ModuleSpec &module_spec,
|
|
const FileSpecList &default_search_paths,
|
|
Status &error) override;
|
|
|
|
bool DownloadObjectAndSymbolFile(ModuleSpec &module_spec, Status &error,
|
|
bool force_lookup,
|
|
bool copy_executable) override;
|
|
|
|
std::optional<FileSpec> LocateSourceFile(const lldb::ModuleSP &module_sp,
|
|
const FileSpec &original_source_file,
|
|
Status &error) override;
|
|
|
|
static void Initialize();
|
|
static void Terminate();
|
|
|
|
static llvm::StringRef GetPluginNameStatic() {
|
|
return "ScriptedSymbolLocatorPythonInterface";
|
|
}
|
|
|
|
llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
|
|
};
|
|
} // namespace lldb_private
|
|
|
|
#endif // LLDB_ENABLE_PYTHON
|
|
#endif // LLDB_PLUGINS_SCRIPTINTERPRETER_PYTHON_INTERFACES_SCRIPTEDSYMBOLLOCATORPYTHONINTERFACE_H
|