[lldb] Introduce ScriptedFrame affordance (#149622)
This patch introduces a new scripting affordance in lldb: `ScriptedFrame`. This allows user to produce mock stackframes in scripted threads and scripted processes from a python script. With this change, StackFrame can be synthetized from different sources: - Either from a dictionary containing a load address, and a frame index, which is the legacy way. - Or by creating a ScriptedFrame python object. One particularity of synthezising stackframes from the ScriptedFrame python object, is that these frame have an optional PC, meaning that they don't have a report a valid PC and they can act as shells that just contain static information, like the frame function name, the list of variables or registers, etc. It can also provide a symbol context. rdar://157260006 Signed-off-by: Med Ismail Bennani <ismail@bennani.ma> Signed-off-by: Med Ismail Bennani <ismail@bennani.ma>
This commit is contained in:
1 parent
78fbca4a33
commit
84b56202fb
23 files changed
+871
-32
No files matched your search
+157
@@ -0,0 +1,157 @@
|
||||
//===----------------------------------------------------------------------===//
|
||||
//
|
||||
// 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/Host/Config.h"
|
||||
#include "lldb/Target/ExecutionContext.h"
|
||||
#include "lldb/Utility/Log.h"
|
||||
#include "lldb/lldb-enumerations.h"
|
||||
|
||||
#if LLDB_ENABLE_PYTHON
|
||||
|
||||
// LLDB Python header must be included first
|
||||
#include "../lldb-python.h"
|
||||
|
||||
#include "../SWIGPythonBridge.h"
|
||||
#include "../ScriptInterpreterPythonImpl.h"
|
||||
#include "ScriptedFramePythonInterface.h"
|
||||
#include <optional>
|
||||
|
||||
using namespace lldb;
|
||||
using namespace lldb_private;
|
||||
using namespace lldb_private::python;
|
||||
using Locker = ScriptInterpreterPythonImpl::Locker;
|
||||
|
||||
ScriptedFramePythonInterface::ScriptedFramePythonInterface(
|
||||
ScriptInterpreterPythonImpl &interpreter)
|
||||
: ScriptedFrameInterface(), ScriptedPythonInterface(interpreter) {}
|
||||
|
||||
llvm::Expected<StructuredData::GenericSP>
|
||||
ScriptedFramePythonInterface::CreatePluginObject(
|
||||
const llvm::StringRef class_name, ExecutionContext &exe_ctx,
|
||||
StructuredData::DictionarySP args_sp, StructuredData::Generic *script_obj) {
|
||||
ExecutionContextRefSP exe_ctx_ref_sp =
|
||||
std::make_shared<ExecutionContextRef>(exe_ctx);
|
||||
StructuredDataImpl sd_impl(args_sp);
|
||||
return ScriptedPythonInterface::CreatePluginObject(class_name, script_obj,
|
||||
exe_ctx_ref_sp, sd_impl);
|
||||
}
|
||||
|
||||
lldb::user_id_t ScriptedFramePythonInterface::GetID() {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("get_id", error);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error))
|
||||
return LLDB_INVALID_FRAME_ID;
|
||||
|
||||
return obj->GetUnsignedIntegerValue(LLDB_INVALID_FRAME_ID);
|
||||
}
|
||||
|
||||
lldb::addr_t ScriptedFramePythonInterface::GetPC() {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("get_pc", error);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error))
|
||||
return LLDB_INVALID_ADDRESS;
|
||||
|
||||
return obj->GetUnsignedIntegerValue(LLDB_INVALID_ADDRESS);
|
||||
}
|
||||
|
||||
std::optional<SymbolContext> ScriptedFramePythonInterface::GetSymbolContext() {
|
||||
Status error;
|
||||
auto sym_ctx = Dispatch<SymbolContext>("get_symbol_context", error);
|
||||
|
||||
if (error.Fail()) {
|
||||
return ErrorWithMessage<SymbolContext>(LLVM_PRETTY_FUNCTION,
|
||||
error.AsCString(), error);
|
||||
}
|
||||
|
||||
return sym_ctx;
|
||||
}
|
||||
|
||||
std::optional<std::string> ScriptedFramePythonInterface::GetFunctionName() {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("get_function_name", error);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error))
|
||||
return {};
|
||||
|
||||
return obj->GetStringValue().str();
|
||||
}
|
||||
|
||||
std::optional<std::string>
|
||||
ScriptedFramePythonInterface::GetDisplayFunctionName() {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("get_display_function_name", error);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error))
|
||||
return {};
|
||||
|
||||
return obj->GetStringValue().str();
|
||||
}
|
||||
|
||||
bool ScriptedFramePythonInterface::IsInlined() {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("is_inlined", error);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error))
|
||||
return false;
|
||||
|
||||
return obj->GetBooleanValue();
|
||||
}
|
||||
|
||||
bool ScriptedFramePythonInterface::IsArtificial() {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("is_artificial", error);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error))
|
||||
return false;
|
||||
|
||||
return obj->GetBooleanValue();
|
||||
}
|
||||
|
||||
bool ScriptedFramePythonInterface::IsHidden() {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("is_hidden", error);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error))
|
||||
return false;
|
||||
|
||||
return obj->GetBooleanValue();
|
||||
}
|
||||
|
||||
StructuredData::DictionarySP ScriptedFramePythonInterface::GetRegisterInfo() {
|
||||
Status error;
|
||||
StructuredData::DictionarySP dict =
|
||||
Dispatch<StructuredData::DictionarySP>("get_register_info", error);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, dict,
|
||||
error))
|
||||
return {};
|
||||
|
||||
return dict;
|
||||
}
|
||||
|
||||
std::optional<std::string> ScriptedFramePythonInterface::GetRegisterContext() {
|
||||
Status error;
|
||||
StructuredData::ObjectSP obj = Dispatch("get_register_context", error);
|
||||
|
||||
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
||||
error))
|
||||
return {};
|
||||
|
||||
return obj->GetAsString()->GetValue().str();
|
||||
}
|
||||
|
||||
#endif
|
||||
Reference in new issue
Block a user