Files
llvm-tms34010/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedFrameProviderPythonInterface.cpp
T
Charles Zablit 2384d2872b [lldb][windows] remove mandatory ordering of the lldb-python.h header (#197298)
`PosixApi.h` typedef'd `pid_t` as `uint32_t`, while Python's
`pyconfig.h` on Windows typedef's it as `int`. C++ forbids redeclaring a
typedef with a different type, so the two headers cannot coexist. The
`NO_PID_T` macro in `lldb-python.h` suppressed LLDB's typedef, but only
if `lldb-python.h` got included before `PosixApi.h`.

`pid_t` on Windows was originally defined in d87fc157d2. At this time,
there was no Python support for LLDB on Windows and `uint32_t` matches
the `DWORD` type used by the Win32 API for process IDs.

This patch matches the Python type in `PosixApi.h`, removing the need
for the include ordering.

This is a follow up to https://github.com/llvm/llvm-project/pull/197048.
2026-05-13 11:18:28 +02:00

126 lines
4.5 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
//
//===----------------------------------------------------------------------===//
#include "../lldb-python.h"
#include "lldb/Core/PluginManager.h"
#include "lldb/Target/Thread.h"
#include "lldb/Utility/Log.h"
#include "lldb/lldb-enumerations.h"
#include "../SWIGPythonBridge.h"
#include "../ScriptInterpreterPythonImpl.h"
#include "ScriptedFrameProviderPythonInterface.h"
#include <optional>
using namespace lldb;
using namespace lldb_private;
using namespace lldb_private::python;
using Locker = ScriptInterpreterPythonImpl::Locker;
ScriptedFrameProviderPythonInterface::ScriptedFrameProviderPythonInterface(
ScriptInterpreterPythonImpl &interpreter)
: ScriptedFrameProviderInterface(), ScriptedPythonInterface(interpreter) {}
bool ScriptedFrameProviderPythonInterface::AppliesToThread(
llvm::StringRef class_name, lldb::ThreadSP thread_sp) {
// If there is any issue with this method, we will just assume it also applies
// to this thread which is the default behavior.
constexpr bool fail_value = true;
Status error;
StructuredData::ObjectSP obj =
CallStaticMethod(class_name, "applies_to_thread", error, thread_sp);
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
error))
return fail_value;
return obj->GetBooleanValue(fail_value);
}
llvm::Expected<StructuredData::GenericSP>
ScriptedFrameProviderPythonInterface::CreatePluginObject(
const llvm::StringRef class_name, lldb::StackFrameListSP input_frames,
StructuredData::DictionarySP args_sp) {
if (!input_frames)
return llvm::createStringError("invalid frame list");
StructuredDataImpl sd_impl(args_sp);
return ScriptedPythonInterface::CreatePluginObject(class_name, nullptr,
input_frames, sd_impl);
}
std::string ScriptedFrameProviderPythonInterface::GetDescription(
llvm::StringRef class_name) {
Status error;
StructuredData::ObjectSP obj =
CallStaticMethod(class_name, "get_description", error);
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
error))
return {};
return obj->GetStringValue().str();
}
std::optional<uint32_t>
ScriptedFrameProviderPythonInterface::GetPriority(llvm::StringRef class_name) {
Status error;
StructuredData::ObjectSP obj =
CallStaticMethod(class_name, "get_priority", error);
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
error))
return std::nullopt;
// Try to extract as unsigned integer. Return nullopt if Python returned None
// or if extraction fails.
if (StructuredData::UnsignedInteger *int_obj = obj->GetAsUnsignedInteger())
return static_cast<uint32_t>(int_obj->GetValue());
return std::nullopt;
}
StructuredData::ObjectSP
ScriptedFrameProviderPythonInterface::GetFrameAtIndex(uint32_t index) {
Status error;
StructuredData::ObjectSP obj = Dispatch("get_frame_at_index", error, index);
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
error))
return {};
return obj;
}
bool ScriptedFrameProviderPythonInterface::CreateInstance(
lldb::ScriptLanguage language, ScriptedInterfaceUsages usages) {
if (language != eScriptLanguagePython)
return false;
return true;
}
void ScriptedFrameProviderPythonInterface::Initialize() {
const std::vector<llvm::StringRef> ci_usages = {
"target frame-provider register -C <script-name> [-k key -v value ...]",
"target frame-provider list",
"target frame-provider remove <provider-name>",
"target frame-provider clear"};
const std::vector<llvm::StringRef> api_usages = {
"SBTarget.RegisterScriptedFrameProvider",
"SBTarget.RemoveScriptedFrameProvider",
"SBTarget.ClearScriptedFrameProvider"};
PluginManager::RegisterPlugin(
GetPluginNameStatic(),
llvm::StringRef("Provide scripted stack frames for threads"),
CreateInstance, eScriptLanguagePython, {ci_usages, api_usages});
}
void ScriptedFrameProviderPythonInterface::Terminate() {
PluginManager::UnregisterPlugin(CreateInstance);
}