Introduce a unified target hook command system for LLDB that handles
multiple target lifecycle events (module load, module unload, process
stop) through a single Hook class.
The existing target stop-hook commands remain unchanged for now, meaning
stop-hooks can now be created through either target stop-hook add or
target hook add -S.
A future follow-up can alias target stop-hook to the unified system to
consolidate the two paths.
New commands:
- target hook add [-o cmd] [-P class] [-u] [-S] - create a hook (fires
on module load by default, optionally on unload/stop)
- target hook add-filter [filter-opts] <hook-id> - attach stop-event
filters (shlib, function, file/line, thread) to an existing hook
- target hook list / delete / enable / disable - manage hooks
- target hook {enable,disable} {module-loaded|module-unloaded|stop-hook}
<id> - per-event toggling
top-event filter options live on a separate add-filter command rather
than on target hook add, keeping the add command clean and making the
system safe for filters on other event types.
Ran the tests + Made sure stop tests are passing as well.
---------
Co-authored-by: Bar Soloveychik <barsolo@fb.com>
106 lines
3.7 KiB
C++
106 lines
3.7 KiB
C++
//===-- ScriptedHookPythonInterface.cpp -----------------------------------===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "lldb/Core/PluginManager.h"
|
|
#include "lldb/Target/ExecutionContext.h"
|
|
#include "lldb/Utility/Log.h"
|
|
#include "lldb/lldb-enumerations.h"
|
|
|
|
#include "../SWIGPythonBridge.h"
|
|
#include "../ScriptInterpreterPythonImpl.h"
|
|
#include "../lldb-python.h"
|
|
#include "ScriptedHookPythonInterface.h"
|
|
|
|
using namespace lldb;
|
|
using namespace lldb_private;
|
|
using namespace lldb_private::python;
|
|
|
|
ScriptedHookPythonInterface::ScriptedHookPythonInterface(
|
|
ScriptInterpreterPythonImpl &interpreter)
|
|
: ScriptedHookInterface(), ScriptedPythonInterface(interpreter) {}
|
|
|
|
ScriptedHookInterface::SupportedHookMethods
|
|
ScriptedHookPythonInterface::GetSupportedMethods() {
|
|
SupportedHookMethods methods;
|
|
// Qualify through ScriptedPythonInterface to resolve the diamond
|
|
// inheritance (both ScriptedHookInterface and ScriptedPythonInterface
|
|
// inherit ScriptedInterface which owns m_object_instance_sp).
|
|
auto &obj_sp = ScriptedPythonInterface::m_object_instance_sp;
|
|
if (!obj_sp)
|
|
return methods;
|
|
|
|
using Locker = ScriptInterpreterPythonImpl::Locker;
|
|
Locker py_lock(&m_interpreter, Locker::AcquireLock | Locker::NoSTDIN,
|
|
Locker::FreeLock);
|
|
|
|
PythonObject implementor(PyRefType::Borrowed, (PyObject *)obj_sp->GetValue());
|
|
if (!implementor.IsValid())
|
|
return methods;
|
|
|
|
methods.handle_module_loaded =
|
|
implementor.HasAttribute("handle_module_loaded");
|
|
methods.handle_module_unloaded =
|
|
implementor.HasAttribute("handle_module_unloaded");
|
|
methods.handle_stop = implementor.HasAttribute("handle_stop");
|
|
return methods;
|
|
}
|
|
|
|
llvm::Expected<StructuredData::GenericSP>
|
|
ScriptedHookPythonInterface::CreatePluginObject(
|
|
llvm::StringRef class_name, lldb::TargetSP target_sp,
|
|
const StructuredDataImpl &args_sp) {
|
|
return ScriptedPythonInterface::CreatePluginObject(class_name, nullptr,
|
|
target_sp, args_sp);
|
|
}
|
|
|
|
void ScriptedHookPythonInterface::HandleModuleLoaded(
|
|
lldb::StreamSP &output_sp) {
|
|
Status error;
|
|
Dispatch("handle_module_loaded", error, output_sp);
|
|
}
|
|
|
|
void ScriptedHookPythonInterface::HandleModuleUnloaded(
|
|
lldb::StreamSP &output_sp) {
|
|
Status error;
|
|
Dispatch("handle_module_unloaded", error, output_sp);
|
|
}
|
|
|
|
llvm::Expected<bool>
|
|
ScriptedHookPythonInterface::HandleStop(ExecutionContext &exe_ctx,
|
|
lldb::StreamSP &output_sp) {
|
|
ExecutionContextRefSP exe_ctx_ref_sp =
|
|
std::make_shared<ExecutionContextRef>(exe_ctx);
|
|
Status error;
|
|
StructuredData::ObjectSP obj =
|
|
Dispatch("handle_stop", error, exe_ctx_ref_sp, output_sp);
|
|
|
|
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
|
error)) {
|
|
if (!obj)
|
|
return true;
|
|
return error.ToError();
|
|
}
|
|
|
|
return obj->GetBooleanValue();
|
|
}
|
|
|
|
void ScriptedHookPythonInterface::Initialize() {
|
|
const std::vector<llvm::StringRef> ci_usages = {
|
|
"target hook add -P <script-name> [-k key -v value ...]"};
|
|
const std::vector<llvm::StringRef> api_usages = {};
|
|
PluginManager::RegisterPlugin(
|
|
GetPluginNameStatic(),
|
|
llvm::StringRef("Perform actions on target lifecycle events (module "
|
|
"load/unload, process stop)."),
|
|
CreateInstance, eScriptLanguagePython, {ci_usages, api_usages});
|
|
}
|
|
|
|
void ScriptedHookPythonInterface::Terminate() {
|
|
PluginManager::UnregisterPlugin(CreateInstance);
|
|
}
|