[lldb/Commands] Add scripting template list command with auto discovery
This patch introduces a new `template` multiword sub-command to the `scripting` top-level command. As the name suggests, this sub-command operates on scripting templates, and currently has the ability to automatically discover the various scripting extensions that lldb supports. This was previously reviewed in #97273. Signed-off-by: Med Ismail Bennani <ismail@bennani.ma>
This commit is contained in:
1 parent
c7231e4909
commit
bccff3baef
15 files changed
+375
-10
No files matched your search
+16
@@ -0,0 +1,16 @@
|
||||
add_lldb_library(lldbPluginScriptInterpreterPythonScriptedThreadPlanPythonInterface PLUGIN
|
||||
|
||||
ScriptedThreadPlanPythonInterface.cpp
|
||||
|
||||
LINK_LIBS
|
||||
lldbCore
|
||||
lldbHost
|
||||
lldbInterpreter
|
||||
lldbTarget
|
||||
lldbPluginScriptInterpreterPython
|
||||
${Python3_LIBRARIES}
|
||||
${LLDB_LIBEDIT_LIBS}
|
||||
|
||||
LINK_COMPONENTS
|
||||
Support
|
||||
)
|
||||
+125
@@ -0,0 +1,125 @@
|
||||
//===-- ScriptedThreadPlanPythonInterface.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/Host/Config.h"
|
||||
#include "lldb/Utility/Log.h"
|
||||
#include "lldb/lldb-enumerations.h"
|
||||
|
||||
#if LLDB_ENABLE_PYTHON
|
||||
|
||||
// clang-format off
|
||||
// LLDB Python header must be included first
|
||||
#include "../../lldb-python.h"
|
||||
//clang-format on
|
||||
|
||||
#include "../../SWIGPythonBridge.h"
|
||||
#include "../../ScriptInterpreterPythonImpl.h"
|
||||
#include "ScriptedThreadPlanPythonInterface.h"
|
||||
|
||||
using namespace lldb;
|
||||
using namespace lldb_private;
|
||||
using namespace lldb_private::python;
|
||||
|
||||
LLDB_PLUGIN_DEFINE_ADV(ScriptedThreadPlanPythonInterface, ScriptInterpreterPythonScriptedThreadPlanPythonInterface)
|
||||
|
||||
ScriptedThreadPlanPythonInterface::ScriptedThreadPlanPythonInterface(
|
||||
ScriptInterpreterPythonImpl &interpreter)
|
||||
: ScriptedThreadPlanInterface(), ScriptedPythonInterface(interpreter) {}
|
||||
|
||||
llvm::Expected<StructuredData::GenericSP>
|
||||
ScriptedThreadPlanPythonInterface::CreatePluginObject(
|
||||
const llvm::StringRef class_name, lldb::ThreadPlanSP thread_plan_sp,
|
||||
const StructuredDataImpl &args_sp) {
|
||||
return ScriptedPythonInterface::CreatePluginObject(class_name, nullptr,
|
||||
thread_plan_sp, args_sp);
|
||||
}
|
||||
|
||||
llvm::Expected<bool>
|
||||
ScriptedThreadPlanPythonInterface::ExplainsStop(Event *event) {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("explains_stop", error, event);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error)) {
|
||||
if (!obj)
|
||||
return false;
|
||||
return error.ToError();
|
||||
}
|
||||
|
||||
return obj->GetBooleanValue();
|
||||
}
|
||||
|
||||
llvm::Expected<bool>
|
||||
ScriptedThreadPlanPythonInterface::ShouldStop(Event *event) {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("should_stop", error, event);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error)) {
|
||||
if (!obj)
|
||||
return false;
|
||||
return error.ToError();
|
||||
}
|
||||
|
||||
return obj->GetBooleanValue();
|
||||
}
|
||||
|
||||
llvm::Expected<bool> ScriptedThreadPlanPythonInterface::IsStale() {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("is_stale", error);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error)) {
|
||||
if (!obj)
|
||||
return false;
|
||||
return error.ToError();
|
||||
}
|
||||
|
||||
return obj->GetBooleanValue();
|
||||
}
|
||||
|
||||
lldb::StateType ScriptedThreadPlanPythonInterface::GetRunState() {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("should_step", error);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error))
|
||||
return lldb::eStateStepping;
|
||||
|
||||
return static_cast<lldb::StateType>(obj->GetUnsignedIntegerValue(
|
||||
static_cast<uint32_t>(lldb::eStateStepping)));
|
||||
}
|
||||
|
||||
llvm::Error
|
||||
ScriptedThreadPlanPythonInterface::GetStopDescription(lldb::StreamSP &stream) {
|
||||
Status error;
|
||||
Dispatch("stop_description", error, stream);
|
||||
|
||||
if (error.Fail())
|
||||
return error.ToError();
|
||||
|
||||
return llvm::Error::success();
|
||||
}
|
||||
|
||||
void ScriptedThreadPlanPythonInterface::Initialize() {
|
||||
const std::vector<llvm::StringRef> ci_usages = {
|
||||
"thread step-scripted -C <script-name> [-k key -v value ...]"};
|
||||
const std::vector<llvm::StringRef> api_usages = {
|
||||
"SBThread.StepUsingScriptedThreadPlan"};
|
||||
PluginManager::RegisterPlugin(
|
||||
GetPluginNameStatic(),
|
||||
llvm::StringRef("Alter thread stepping logic and stop reason"),
|
||||
CreateInstance, eScriptLanguagePython, {ci_usages, api_usages});
|
||||
}
|
||||
|
||||
void ScriptedThreadPlanPythonInterface::Terminate() {
|
||||
PluginManager::UnregisterPlugin(CreateInstance);
|
||||
}
|
||||
|
||||
#endif
|
||||
+60
@@ -0,0 +1,60 @@
|
||||
//===-- ScriptedThreadPlanPythonInterface.h ---------------------*- 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_SCRIPTEDTHREADPLANPYTHONINTERFACE_H
|
||||
#define LLDB_PLUGINS_SCRIPTINTERPRETER_PYTHON_INTERFACES_SCRIPTEDTHREADPLANPYTHONINTERFACE_H
|
||||
|
||||
#include "lldb/Host/Config.h"
|
||||
#include "lldb/Interpreter/Interfaces/ScriptedThreadPlanInterface.h"
|
||||
|
||||
#if LLDB_ENABLE_PYTHON
|
||||
|
||||
#include "../ScriptedPythonInterface.h"
|
||||
|
||||
#include <optional>
|
||||
|
||||
namespace lldb_private {
|
||||
class ScriptedThreadPlanPythonInterface : public ScriptedThreadPlanInterface,
|
||||
public ScriptedPythonInterface,
|
||||
public PluginInterface {
|
||||
public:
|
||||
ScriptedThreadPlanPythonInterface(ScriptInterpreterPythonImpl &interpreter);
|
||||
|
||||
llvm::Expected<StructuredData::GenericSP>
|
||||
CreatePluginObject(const llvm::StringRef class_name,
|
||||
lldb::ThreadPlanSP thread_plan_sp,
|
||||
const StructuredDataImpl &args_sp) override;
|
||||
|
||||
llvm::SmallVector<llvm::StringLiteral> GetAbstractMethods() const override {
|
||||
return {};
|
||||
}
|
||||
|
||||
llvm::Expected<bool> ExplainsStop(Event *event) override;
|
||||
|
||||
llvm::Expected<bool> ShouldStop(Event *event) override;
|
||||
|
||||
llvm::Expected<bool> IsStale() override;
|
||||
|
||||
lldb::StateType GetRunState() override;
|
||||
|
||||
llvm::Error GetStopDescription(lldb::StreamSP &stream) override;
|
||||
|
||||
static void Initialize();
|
||||
|
||||
static void Terminate();
|
||||
|
||||
static llvm::StringRef GetPluginNameStatic() {
|
||||
return "ScriptedThreadPlanPythonInterface";
|
||||
}
|
||||
|
||||
llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
|
||||
};
|
||||
} // namespace lldb_private
|
||||
|
||||
#endif // LLDB_ENABLE_PYTHON
|
||||
#endif // LLDB_PLUGINS_SCRIPTINTERPRETER_PYTHON_INTERFACES_SCRIPTEDTHREADPLANPYTHONINTERFACE_H
|
||||
Reference in new issue
Block a user