2016-11-17 05:15:24 +08:00
|
|
|
//===-- OperatingSystemPython.cpp --------------------------------*- C++-*-===//
|
2012-08-24 05:17:11 +08:00
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
2012-12-05 08:20:57 +08:00
|
|
|
|
2012-08-24 05:17:11 +08:00
|
|
|
#ifndef LLDB_DISABLE_PYTHON
|
|
|
|
|
|
|
|
#include "OperatingSystemPython.h"
|
|
|
|
// C Includes
|
|
|
|
// C++ Includes
|
|
|
|
// Other libraries and framework includes
|
2016-09-07 04:57:50 +08:00
|
|
|
#include "Plugins/Process/Utility/DynamicRegisterInfo.h"
|
|
|
|
#include "Plugins/Process/Utility/RegisterContextDummy.h"
|
|
|
|
#include "Plugins/Process/Utility/RegisterContextMemory.h"
|
|
|
|
#include "Plugins/Process/Utility/ThreadMemory.h"
|
2012-08-24 08:30:47 +08:00
|
|
|
#include "lldb/Core/Debugger.h"
|
2012-08-24 05:17:11 +08:00
|
|
|
#include "lldb/Core/Module.h"
|
|
|
|
#include "lldb/Core/PluginManager.h"
|
|
|
|
#include "lldb/Core/ValueObjectVariable.h"
|
2012-08-24 08:30:47 +08:00
|
|
|
#include "lldb/Interpreter/CommandInterpreter.h"
|
2015-03-18 04:04:04 +08:00
|
|
|
#include "lldb/Interpreter/ScriptInterpreter.h"
|
2012-08-24 05:17:11 +08:00
|
|
|
#include "lldb/Symbol/ObjectFile.h"
|
|
|
|
#include "lldb/Symbol/VariableList.h"
|
|
|
|
#include "lldb/Target/Process.h"
|
|
|
|
#include "lldb/Target/StopInfo.h"
|
|
|
|
#include "lldb/Target/Target.h"
|
|
|
|
#include "lldb/Target/Thread.h"
|
2016-09-07 04:57:50 +08:00
|
|
|
#include "lldb/Target/ThreadList.h"
|
2017-03-04 09:30:05 +08:00
|
|
|
#include "lldb/Utility/DataBufferHeap.h"
|
2018-08-07 19:07:21 +08:00
|
|
|
#include "lldb/Utility/RegisterValue.h"
|
2017-02-03 05:39:50 +08:00
|
|
|
#include "lldb/Utility/StreamString.h"
|
2017-06-27 18:45:31 +08:00
|
|
|
#include "lldb/Utility/StructuredData.h"
|
2012-08-24 05:17:11 +08:00
|
|
|
|
|
|
|
using namespace lldb;
|
|
|
|
using namespace lldb_private;
|
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
void OperatingSystemPython::Initialize() {
|
|
|
|
PluginManager::RegisterPlugin(GetPluginNameStatic(),
|
|
|
|
GetPluginDescriptionStatic(), CreateInstance,
|
|
|
|
nullptr);
|
2012-08-24 05:17:11 +08:00
|
|
|
}
|
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
void OperatingSystemPython::Terminate() {
|
|
|
|
PluginManager::UnregisterPlugin(CreateInstance);
|
2012-08-24 05:17:11 +08:00
|
|
|
}
|
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
OperatingSystem *OperatingSystemPython::CreateInstance(Process *process,
|
|
|
|
bool force) {
|
2018-05-01 00:49:04 +08:00
|
|
|
// Python OperatingSystem plug-ins must be requested by name, so force must
|
|
|
|
// be true
|
2016-09-07 04:57:50 +08:00
|
|
|
FileSpec python_os_plugin_spec(process->GetPythonOSPluginPath());
|
|
|
|
if (python_os_plugin_spec && python_os_plugin_spec.Exists()) {
|
|
|
|
std::unique_ptr<OperatingSystemPython> os_ap(
|
|
|
|
new OperatingSystemPython(process, python_os_plugin_spec));
|
|
|
|
if (os_ap.get() && os_ap->IsValid())
|
|
|
|
return os_ap.release();
|
|
|
|
}
|
|
|
|
return NULL;
|
2012-08-24 05:17:11 +08:00
|
|
|
}
|
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
ConstString OperatingSystemPython::GetPluginNameStatic() {
|
|
|
|
static ConstString g_name("python");
|
|
|
|
return g_name;
|
2012-08-24 05:17:11 +08:00
|
|
|
}
|
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
const char *OperatingSystemPython::GetPluginDescriptionStatic() {
|
|
|
|
return "Operating system plug-in that gathers OS information from a python "
|
|
|
|
"class that implements the necessary OperatingSystem functionality.";
|
2012-08-24 05:17:11 +08:00
|
|
|
}
|
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
OperatingSystemPython::OperatingSystemPython(lldb_private::Process *process,
|
|
|
|
const FileSpec &python_module_path)
|
|
|
|
: OperatingSystem(process), m_thread_list_valobj_sp(), m_register_info_ap(),
|
|
|
|
m_interpreter(NULL), m_python_object_sp() {
|
|
|
|
if (!process)
|
|
|
|
return;
|
|
|
|
TargetSP target_sp = process->CalculateTarget();
|
|
|
|
if (!target_sp)
|
|
|
|
return;
|
|
|
|
m_interpreter =
|
|
|
|
target_sp->GetDebugger().GetCommandInterpreter().GetScriptInterpreter();
|
|
|
|
if (m_interpreter) {
|
|
|
|
|
|
|
|
std::string os_plugin_class_name(
|
|
|
|
python_module_path.GetFilename().AsCString(""));
|
|
|
|
if (!os_plugin_class_name.empty()) {
|
|
|
|
const bool init_session = false;
|
|
|
|
const bool allow_reload = true;
|
|
|
|
char python_module_path_cstr[PATH_MAX];
|
|
|
|
python_module_path.GetPath(python_module_path_cstr,
|
|
|
|
sizeof(python_module_path_cstr));
|
2017-05-12 12:51:55 +08:00
|
|
|
Status error;
|
2016-09-07 04:57:50 +08:00
|
|
|
if (m_interpreter->LoadScriptingModule(
|
|
|
|
python_module_path_cstr, allow_reload, init_session, error)) {
|
|
|
|
// Strip the ".py" extension if there is one
|
|
|
|
size_t py_extension_pos = os_plugin_class_name.rfind(".py");
|
|
|
|
if (py_extension_pos != std::string::npos)
|
|
|
|
os_plugin_class_name.erase(py_extension_pos);
|
|
|
|
// Add ".OperatingSystemPlugIn" to the module name to get a string like
|
|
|
|
// "modulename.OperatingSystemPlugIn"
|
|
|
|
os_plugin_class_name += ".OperatingSystemPlugIn";
|
|
|
|
StructuredData::ObjectSP object_sp =
|
|
|
|
m_interpreter->OSPlugin_CreatePluginObject(
|
|
|
|
os_plugin_class_name.c_str(), process->CalculateProcess());
|
|
|
|
if (object_sp && object_sp->IsValid())
|
|
|
|
m_python_object_sp = object_sp;
|
|
|
|
}
|
2012-08-24 08:30:47 +08:00
|
|
|
}
|
2016-09-07 04:57:50 +08:00
|
|
|
}
|
2012-08-24 05:17:11 +08:00
|
|
|
}
|
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
OperatingSystemPython::~OperatingSystemPython() {}
|
2012-08-24 05:17:11 +08:00
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
DynamicRegisterInfo *OperatingSystemPython::GetDynamicRegisterInfo() {
|
|
|
|
if (m_register_info_ap.get() == NULL) {
|
|
|
|
if (!m_interpreter || !m_python_object_sp)
|
|
|
|
return NULL;
|
|
|
|
Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OS));
|
|
|
|
|
|
|
|
if (log)
|
|
|
|
log->Printf("OperatingSystemPython::GetDynamicRegisterInfo() fetching "
|
|
|
|
"thread register definitions from python for pid %" PRIu64,
|
|
|
|
m_process->GetID());
|
|
|
|
|
|
|
|
StructuredData::DictionarySP dictionary =
|
|
|
|
m_interpreter->OSPlugin_RegisterInfo(m_python_object_sp);
|
|
|
|
if (!dictionary)
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
m_register_info_ap.reset(new DynamicRegisterInfo(
|
|
|
|
*dictionary, m_process->GetTarget().GetArchitecture()));
|
|
|
|
assert(m_register_info_ap->GetNumRegisters() > 0);
|
|
|
|
assert(m_register_info_ap->GetNumRegisterSets() > 0);
|
|
|
|
}
|
|
|
|
return m_register_info_ap.get();
|
2012-08-24 05:17:11 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
//------------------------------------------------------------------
|
|
|
|
// PluginInterface protocol
|
|
|
|
//------------------------------------------------------------------
|
2016-09-07 04:57:50 +08:00
|
|
|
ConstString OperatingSystemPython::GetPluginName() {
|
|
|
|
return GetPluginNameStatic();
|
2012-08-24 05:17:11 +08:00
|
|
|
}
|
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
uint32_t OperatingSystemPython::GetPluginVersion() { return 1; }
|
|
|
|
|
|
|
|
bool OperatingSystemPython::UpdateThreadList(ThreadList &old_thread_list,
|
|
|
|
ThreadList &core_thread_list,
|
|
|
|
ThreadList &new_thread_list) {
|
|
|
|
if (!m_interpreter || !m_python_object_sp)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OS));
|
|
|
|
|
Prevent deadlock in OS Plugins
Summary:
When performing a synchronous resume, the API mutex is held until the
process is stopped. This is fine, except for when the OS plugins are processing
an event before the main thread is aware of it, in which case we end up with a
deadlock because in the internal thread we acquire a resource lock first, and
then wait for the API lock, while in the main thread we do the opposite, we
already hold the API mutex but are now waiting for the event mutex to handle
the event.
This patch fixes this by relaxing the need for the API lock in the OS plugins.
We can get away with this because we now this code is executed in the main
thread. As stated in the comment above, we just want to ensure nobody else
messes with the API while we're making a change. In theory it's possible that
the main thread would release the lock while we're executing the function, but
prevent this would require a more structural solution (which we want, but do
not have today).
The same workaround was already present, but this patch generalizes it to the
whole file.
This will allow me to re-land r329891.
Reviewers: clayborg, jingham, labath
Subscribers: llvm-commits, lldb-commits
Differential Revision: https://reviews.llvm.org/D45586
llvm-svn: 330002
2018-04-13 18:25:23 +08:00
|
|
|
// First thing we have to do is to try to get the API lock, and the
|
|
|
|
// interpreter lock. We're going to change the thread content of the process,
|
|
|
|
// and we're going to use python, which requires the API lock to do it. We
|
|
|
|
// need the interpreter lock to make sure thread_info_dict stays alive.
|
2016-09-07 04:57:50 +08:00
|
|
|
//
|
|
|
|
// If someone already has the API lock, that is ok, we just want to avoid
|
|
|
|
// external code from making new API calls while this call is happening.
|
|
|
|
//
|
|
|
|
// This is a recursive lock so we can grant it to any Python code called on
|
|
|
|
// the stack below us.
|
|
|
|
Target &target = m_process->GetTarget();
|
Prevent deadlock in OS Plugins
Summary:
When performing a synchronous resume, the API mutex is held until the
process is stopped. This is fine, except for when the OS plugins are processing
an event before the main thread is aware of it, in which case we end up with a
deadlock because in the internal thread we acquire a resource lock first, and
then wait for the API lock, while in the main thread we do the opposite, we
already hold the API mutex but are now waiting for the event mutex to handle
the event.
This patch fixes this by relaxing the need for the API lock in the OS plugins.
We can get away with this because we now this code is executed in the main
thread. As stated in the comment above, we just want to ensure nobody else
messes with the API while we're making a change. In theory it's possible that
the main thread would release the lock while we're executing the function, but
prevent this would require a more structural solution (which we want, but do
not have today).
The same workaround was already present, but this patch generalizes it to the
whole file.
This will allow me to re-land r329891.
Reviewers: clayborg, jingham, labath
Subscribers: llvm-commits, lldb-commits
Differential Revision: https://reviews.llvm.org/D45586
llvm-svn: 330002
2018-04-13 18:25:23 +08:00
|
|
|
std::unique_lock<std::recursive_mutex> api_lock(target.GetAPIMutex(),
|
|
|
|
std::defer_lock);
|
|
|
|
api_lock.try_lock();
|
|
|
|
auto interpreter_lock = m_interpreter->AcquireInterpreterLock();
|
2016-09-07 04:57:50 +08:00
|
|
|
|
|
|
|
if (log)
|
|
|
|
log->Printf("OperatingSystemPython::UpdateThreadList() fetching thread "
|
|
|
|
"data from python for pid %" PRIu64,
|
|
|
|
m_process->GetID());
|
|
|
|
|
|
|
|
// The threads that are in "new_thread_list" upon entry are the threads from
|
Prevent deadlock in OS Plugins
Summary:
When performing a synchronous resume, the API mutex is held until the
process is stopped. This is fine, except for when the OS plugins are processing
an event before the main thread is aware of it, in which case we end up with a
deadlock because in the internal thread we acquire a resource lock first, and
then wait for the API lock, while in the main thread we do the opposite, we
already hold the API mutex but are now waiting for the event mutex to handle
the event.
This patch fixes this by relaxing the need for the API lock in the OS plugins.
We can get away with this because we now this code is executed in the main
thread. As stated in the comment above, we just want to ensure nobody else
messes with the API while we're making a change. In theory it's possible that
the main thread would release the lock while we're executing the function, but
prevent this would require a more structural solution (which we want, but do
not have today).
The same workaround was already present, but this patch generalizes it to the
whole file.
This will allow me to re-land r329891.
Reviewers: clayborg, jingham, labath
Subscribers: llvm-commits, lldb-commits
Differential Revision: https://reviews.llvm.org/D45586
llvm-svn: 330002
2018-04-13 18:25:23 +08:00
|
|
|
// the lldb_private::Process subclass, no memory threads will be in this
|
|
|
|
// list.
|
2016-09-07 04:57:50 +08:00
|
|
|
StructuredData::ArraySP threads_list =
|
|
|
|
m_interpreter->OSPlugin_ThreadsInfo(m_python_object_sp);
|
|
|
|
|
|
|
|
const uint32_t num_cores = core_thread_list.GetSize(false);
|
|
|
|
|
|
|
|
// Make a map so we can keep track of which cores were used from the
|
2018-05-01 00:49:04 +08:00
|
|
|
// core_thread list. Any real threads/cores that weren't used should later be
|
|
|
|
// put back into the "new_thread_list".
|
2016-09-07 04:57:50 +08:00
|
|
|
std::vector<bool> core_used_map(num_cores, false);
|
|
|
|
if (threads_list) {
|
|
|
|
if (log) {
|
|
|
|
StreamString strm;
|
|
|
|
threads_list->Dump(strm);
|
2016-11-17 05:15:24 +08:00
|
|
|
log->Printf("threads_list = %s", strm.GetData());
|
2012-08-24 13:45:15 +08:00
|
|
|
}
|
2014-02-14 07:34:38 +08:00
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
const uint32_t num_threads = threads_list->GetSize();
|
|
|
|
for (uint32_t i = 0; i < num_threads; ++i) {
|
|
|
|
StructuredData::ObjectSP thread_dict_obj =
|
|
|
|
threads_list->GetItemAtIndex(i);
|
|
|
|
if (auto thread_dict = thread_dict_obj->GetAsDictionary()) {
|
|
|
|
ThreadSP thread_sp(
|
|
|
|
CreateThreadFromThreadInfo(*thread_dict, core_thread_list,
|
|
|
|
old_thread_list, core_used_map, NULL));
|
|
|
|
if (thread_sp)
|
|
|
|
new_thread_list.AddThread(thread_sp);
|
|
|
|
}
|
2014-02-14 07:34:38 +08:00
|
|
|
}
|
2016-09-07 04:57:50 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
// Any real core threads that didn't end up backing a memory thread should
|
|
|
|
// still be in the main thread list, and they should be inserted at the
|
2018-05-01 00:49:04 +08:00
|
|
|
// beginning of the list
|
2016-09-07 04:57:50 +08:00
|
|
|
uint32_t insert_idx = 0;
|
|
|
|
for (uint32_t core_idx = 0; core_idx < num_cores; ++core_idx) {
|
|
|
|
if (core_used_map[core_idx] == false) {
|
|
|
|
new_thread_list.InsertThread(
|
|
|
|
core_thread_list.GetThreadAtIndex(core_idx, false), insert_idx);
|
|
|
|
++insert_idx;
|
|
|
|
}
|
|
|
|
}
|
2013-05-09 09:55:29 +08:00
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
return new_thread_list.GetSize(false) > 0;
|
2012-08-24 05:17:11 +08:00
|
|
|
}
|
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
ThreadSP OperatingSystemPython::CreateThreadFromThreadInfo(
|
|
|
|
StructuredData::Dictionary &thread_dict, ThreadList &core_thread_list,
|
|
|
|
ThreadList &old_thread_list, std::vector<bool> &core_used_map,
|
|
|
|
bool *did_create_ptr) {
|
|
|
|
ThreadSP thread_sp;
|
|
|
|
tid_t tid = LLDB_INVALID_THREAD_ID;
|
|
|
|
if (!thread_dict.GetValueForKeyAsInteger("tid", tid))
|
|
|
|
return ThreadSP();
|
2015-03-18 04:04:04 +08:00
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
uint32_t core_number;
|
|
|
|
addr_t reg_data_addr;
|
2017-05-12 13:49:54 +08:00
|
|
|
llvm::StringRef name;
|
|
|
|
llvm::StringRef queue;
|
2016-09-07 04:57:50 +08:00
|
|
|
|
|
|
|
thread_dict.GetValueForKeyAsInteger("core", core_number, UINT32_MAX);
|
|
|
|
thread_dict.GetValueForKeyAsInteger("register_data_addr", reg_data_addr,
|
|
|
|
LLDB_INVALID_ADDRESS);
|
|
|
|
thread_dict.GetValueForKeyAsString("name", name);
|
|
|
|
thread_dict.GetValueForKeyAsString("queue", queue);
|
|
|
|
|
|
|
|
// See if a thread already exists for "tid"
|
|
|
|
thread_sp = old_thread_list.FindThreadByID(tid, false);
|
|
|
|
if (thread_sp) {
|
|
|
|
// A thread already does exist for "tid", make sure it was an operating
|
|
|
|
// system
|
|
|
|
// plug-in generated thread.
|
|
|
|
if (!IsOperatingSystemPluginThread(thread_sp)) {
|
|
|
|
// We have thread ID overlap between the protocol threads and the
|
2018-05-01 00:49:04 +08:00
|
|
|
// operating system threads, clear the thread so we create an operating
|
|
|
|
// system thread for this.
|
2016-09-07 04:57:50 +08:00
|
|
|
thread_sp.reset();
|
2015-03-18 04:04:04 +08:00
|
|
|
}
|
2016-09-07 04:57:50 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!thread_sp) {
|
|
|
|
if (did_create_ptr)
|
|
|
|
*did_create_ptr = true;
|
2017-05-12 13:49:54 +08:00
|
|
|
thread_sp.reset(
|
|
|
|
new ThreadMemory(*m_process, tid, name, queue, reg_data_addr));
|
2016-09-07 04:57:50 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
if (core_number < core_thread_list.GetSize(false)) {
|
|
|
|
ThreadSP core_thread_sp(
|
|
|
|
core_thread_list.GetThreadAtIndex(core_number, false));
|
|
|
|
if (core_thread_sp) {
|
|
|
|
// Keep track of which cores were set as the backing thread for memory
|
|
|
|
// threads...
|
|
|
|
if (core_number < core_used_map.size())
|
|
|
|
core_used_map[core_number] = true;
|
|
|
|
|
|
|
|
ThreadSP backing_core_thread_sp(core_thread_sp->GetBackingThread());
|
|
|
|
if (backing_core_thread_sp) {
|
|
|
|
thread_sp->SetBackingThread(backing_core_thread_sp);
|
|
|
|
} else {
|
|
|
|
thread_sp->SetBackingThread(core_thread_sp);
|
|
|
|
}
|
<rdar://problem/13010007>
Added the ability for OS plug-ins to lazily populate the thread this. The python OS plug-in classes can now implement the following method:
class OperatingSystemPlugin:
def create_thread(self, tid, context):
# Return a dictionary for a new thread to create it on demand
This will add a new thread to the thread list if it doesn't already exist. The example code in lldb/examples/python/operating_system.py has been updated to show how this call us used.
Cleaned up the code in PythonDataObjects.cpp/h:
- renamed all classes that started with PythonData* to be Python*.
- renamed PythonArray to PythonList. Cleaned up the code to use inheritance where
- Centralized the code that does ref counting in the PythonObject class to a single function.
- Made the "bool PythonObject::Reset(PyObject *)" function be virtual so each subclass can correctly check to ensure a PyObject is of the right type before adopting the object.
- Cleaned up all APIs and added new constructors for the Python* classes to they can all construct form:
- PyObject *
- const PythonObject &
- const lldb::ScriptInterpreterObjectSP &
Cleaned up code in ScriptInterpreterPython:
- Made calling python functions safer by templatizing the production of value formats. Python specifies the value formats based on built in C types (long, long long, etc), and code often uses typedefs for uint32_t, uint64_t, etc when passing arguments down to python. We will now always produce correct value formats as the templatized code will "do the right thing" all the time.
- Fixed issues with the ScriptInterpreterPython::Locker where entering the session and leaving the session had a bunch of issues that could cause the "lldb" module globals lldb.debugger, lldb.target, lldb.process, lldb.thread, and lldb.frame to not be initialized.
llvm-svn: 172873
2013-01-19 07:41:08 +08:00
|
|
|
}
|
2016-09-07 04:57:50 +08:00
|
|
|
}
|
|
|
|
return thread_sp;
|
<rdar://problem/13010007>
Added the ability for OS plug-ins to lazily populate the thread this. The python OS plug-in classes can now implement the following method:
class OperatingSystemPlugin:
def create_thread(self, tid, context):
# Return a dictionary for a new thread to create it on demand
This will add a new thread to the thread list if it doesn't already exist. The example code in lldb/examples/python/operating_system.py has been updated to show how this call us used.
Cleaned up the code in PythonDataObjects.cpp/h:
- renamed all classes that started with PythonData* to be Python*.
- renamed PythonArray to PythonList. Cleaned up the code to use inheritance where
- Centralized the code that does ref counting in the PythonObject class to a single function.
- Made the "bool PythonObject::Reset(PyObject *)" function be virtual so each subclass can correctly check to ensure a PyObject is of the right type before adopting the object.
- Cleaned up all APIs and added new constructors for the Python* classes to they can all construct form:
- PyObject *
- const PythonObject &
- const lldb::ScriptInterpreterObjectSP &
Cleaned up code in ScriptInterpreterPython:
- Made calling python functions safer by templatizing the production of value formats. Python specifies the value formats based on built in C types (long, long long, etc), and code often uses typedefs for uint32_t, uint64_t, etc when passing arguments down to python. We will now always produce correct value formats as the templatized code will "do the right thing" all the time.
- Fixed issues with the ScriptInterpreterPython::Locker where entering the session and leaving the session had a bunch of issues that could cause the "lldb" module globals lldb.debugger, lldb.target, lldb.process, lldb.thread, and lldb.frame to not be initialized.
llvm-svn: 172873
2013-01-19 07:41:08 +08:00
|
|
|
}
|
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
void OperatingSystemPython::ThreadWasSelected(Thread *thread) {}
|
2012-08-24 05:17:11 +08:00
|
|
|
|
|
|
|
RegisterContextSP
|
2016-09-07 04:57:50 +08:00
|
|
|
OperatingSystemPython::CreateRegisterContextForThread(Thread *thread,
|
|
|
|
addr_t reg_data_addr) {
|
|
|
|
RegisterContextSP reg_ctx_sp;
|
|
|
|
if (!m_interpreter || !m_python_object_sp || !thread)
|
|
|
|
return reg_ctx_sp;
|
2012-12-08 01:42:15 +08:00
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
if (!IsOperatingSystemPluginThread(thread->shared_from_this()))
|
|
|
|
return reg_ctx_sp;
|
|
|
|
|
Prevent deadlock in OS Plugins
Summary:
When performing a synchronous resume, the API mutex is held until the
process is stopped. This is fine, except for when the OS plugins are processing
an event before the main thread is aware of it, in which case we end up with a
deadlock because in the internal thread we acquire a resource lock first, and
then wait for the API lock, while in the main thread we do the opposite, we
already hold the API mutex but are now waiting for the event mutex to handle
the event.
This patch fixes this by relaxing the need for the API lock in the OS plugins.
We can get away with this because we now this code is executed in the main
thread. As stated in the comment above, we just want to ensure nobody else
messes with the API while we're making a change. In theory it's possible that
the main thread would release the lock while we're executing the function, but
prevent this would require a more structural solution (which we want, but do
not have today).
The same workaround was already present, but this patch generalizes it to the
whole file.
This will allow me to re-land r329891.
Reviewers: clayborg, jingham, labath
Subscribers: llvm-commits, lldb-commits
Differential Revision: https://reviews.llvm.org/D45586
llvm-svn: 330002
2018-04-13 18:25:23 +08:00
|
|
|
// First thing we have to do is to try to get the API lock, and the
|
|
|
|
// interpreter lock. We're going to change the thread content of the process,
|
|
|
|
// and we're going to use python, which requires the API lock to do it. We
|
|
|
|
// need the interpreter lock to make sure thread_info_dict stays alive.
|
|
|
|
//
|
|
|
|
// If someone already has the API lock, that is ok, we just want to avoid
|
|
|
|
// external code from making new API calls while this call is happening.
|
|
|
|
//
|
|
|
|
// This is a recursive lock so we can grant it to any Python code called on
|
|
|
|
// the stack below us.
|
2016-09-07 04:57:50 +08:00
|
|
|
Target &target = m_process->GetTarget();
|
Prevent deadlock in OS Plugins
Summary:
When performing a synchronous resume, the API mutex is held until the
process is stopped. This is fine, except for when the OS plugins are processing
an event before the main thread is aware of it, in which case we end up with a
deadlock because in the internal thread we acquire a resource lock first, and
then wait for the API lock, while in the main thread we do the opposite, we
already hold the API mutex but are now waiting for the event mutex to handle
the event.
This patch fixes this by relaxing the need for the API lock in the OS plugins.
We can get away with this because we now this code is executed in the main
thread. As stated in the comment above, we just want to ensure nobody else
messes with the API while we're making a change. In theory it's possible that
the main thread would release the lock while we're executing the function, but
prevent this would require a more structural solution (which we want, but do
not have today).
The same workaround was already present, but this patch generalizes it to the
whole file.
This will allow me to re-land r329891.
Reviewers: clayborg, jingham, labath
Subscribers: llvm-commits, lldb-commits
Differential Revision: https://reviews.llvm.org/D45586
llvm-svn: 330002
2018-04-13 18:25:23 +08:00
|
|
|
std::unique_lock<std::recursive_mutex> api_lock(target.GetAPIMutex(),
|
|
|
|
std::defer_lock);
|
|
|
|
api_lock.try_lock();
|
|
|
|
auto interpreter_lock = m_interpreter->AcquireInterpreterLock();
|
2016-09-07 04:57:50 +08:00
|
|
|
|
|
|
|
Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_THREAD));
|
|
|
|
|
|
|
|
if (reg_data_addr != LLDB_INVALID_ADDRESS) {
|
|
|
|
// The registers data is in contiguous memory, just create the register
|
|
|
|
// context using the address provided
|
|
|
|
if (log)
|
|
|
|
log->Printf("OperatingSystemPython::CreateRegisterContextForThread (tid "
|
|
|
|
"= 0x%" PRIx64 ", 0x%" PRIx64 ", reg_data_addr = 0x%" PRIx64
|
|
|
|
") creating memory register context",
|
|
|
|
thread->GetID(), thread->GetProtocolID(), reg_data_addr);
|
|
|
|
reg_ctx_sp.reset(new RegisterContextMemory(
|
|
|
|
*thread, 0, *GetDynamicRegisterInfo(), reg_data_addr));
|
|
|
|
} else {
|
2018-05-01 00:49:04 +08:00
|
|
|
// No register data address is provided, query the python plug-in to let it
|
|
|
|
// make up the data as it sees fit
|
2016-09-07 04:57:50 +08:00
|
|
|
if (log)
|
|
|
|
log->Printf("OperatingSystemPython::CreateRegisterContextForThread (tid "
|
|
|
|
"= 0x%" PRIx64 ", 0x%" PRIx64
|
|
|
|
") fetching register data from python",
|
|
|
|
thread->GetID(), thread->GetProtocolID());
|
|
|
|
|
|
|
|
StructuredData::StringSP reg_context_data =
|
|
|
|
m_interpreter->OSPlugin_RegisterContextData(m_python_object_sp,
|
|
|
|
thread->GetID());
|
|
|
|
if (reg_context_data) {
|
|
|
|
std::string value = reg_context_data->GetValue();
|
|
|
|
DataBufferSP data_sp(new DataBufferHeap(value.c_str(), value.length()));
|
|
|
|
if (data_sp->GetByteSize()) {
|
|
|
|
RegisterContextMemory *reg_ctx_memory = new RegisterContextMemory(
|
|
|
|
*thread, 0, *GetDynamicRegisterInfo(), LLDB_INVALID_ADDRESS);
|
|
|
|
if (reg_ctx_memory) {
|
|
|
|
reg_ctx_sp.reset(reg_ctx_memory);
|
|
|
|
reg_ctx_memory->SetAllRegisterData(data_sp);
|
2012-08-24 13:45:15 +08:00
|
|
|
}
|
2016-09-07 04:57:50 +08:00
|
|
|
}
|
2012-08-24 13:45:15 +08:00
|
|
|
}
|
2016-09-07 04:57:50 +08:00
|
|
|
}
|
|
|
|
// if we still have no register data, fallback on a dummy context to avoid
|
|
|
|
// crashing
|
|
|
|
if (!reg_ctx_sp) {
|
|
|
|
if (log)
|
|
|
|
log->Printf("OperatingSystemPython::CreateRegisterContextForThread (tid "
|
|
|
|
"= 0x%" PRIx64 ") forcing a dummy register context",
|
|
|
|
thread->GetID());
|
|
|
|
reg_ctx_sp.reset(new RegisterContextDummy(
|
|
|
|
*thread, 0, target.GetArchitecture().GetAddressByteSize()));
|
|
|
|
}
|
|
|
|
return reg_ctx_sp;
|
2012-08-24 05:17:11 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
StopInfoSP
|
2016-09-07 04:57:50 +08:00
|
|
|
OperatingSystemPython::CreateThreadStopReason(lldb_private::Thread *thread) {
|
|
|
|
// We should have gotten the thread stop info from the dictionary of data for
|
|
|
|
// the thread in the initial call to get_thread_info(), this should have been
|
|
|
|
// cached so we can return it here
|
|
|
|
StopInfoSP
|
|
|
|
stop_info_sp; //(StopInfo::CreateStopReasonWithSignal (*thread, SIGSTOP));
|
|
|
|
return stop_info_sp;
|
2012-08-24 05:17:11 +08:00
|
|
|
}
|
|
|
|
|
2016-09-07 04:57:50 +08:00
|
|
|
lldb::ThreadSP OperatingSystemPython::CreateThread(lldb::tid_t tid,
|
|
|
|
addr_t context) {
|
|
|
|
Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_THREAD));
|
|
|
|
|
|
|
|
if (log)
|
|
|
|
log->Printf("OperatingSystemPython::CreateThread (tid = 0x%" PRIx64
|
|
|
|
", context = 0x%" PRIx64 ") fetching register data from python",
|
|
|
|
tid, context);
|
|
|
|
|
|
|
|
if (m_interpreter && m_python_object_sp) {
|
Prevent deadlock in OS Plugins
Summary:
When performing a synchronous resume, the API mutex is held until the
process is stopped. This is fine, except for when the OS plugins are processing
an event before the main thread is aware of it, in which case we end up with a
deadlock because in the internal thread we acquire a resource lock first, and
then wait for the API lock, while in the main thread we do the opposite, we
already hold the API mutex but are now waiting for the event mutex to handle
the event.
This patch fixes this by relaxing the need for the API lock in the OS plugins.
We can get away with this because we now this code is executed in the main
thread. As stated in the comment above, we just want to ensure nobody else
messes with the API while we're making a change. In theory it's possible that
the main thread would release the lock while we're executing the function, but
prevent this would require a more structural solution (which we want, but do
not have today).
The same workaround was already present, but this patch generalizes it to the
whole file.
This will allow me to re-land r329891.
Reviewers: clayborg, jingham, labath
Subscribers: llvm-commits, lldb-commits
Differential Revision: https://reviews.llvm.org/D45586
llvm-svn: 330002
2018-04-13 18:25:23 +08:00
|
|
|
// First thing we have to do is to try to get the API lock, and the
|
|
|
|
// interpreter lock. We're going to change the thread content of the
|
|
|
|
// process, and we're going to use python, which requires the API lock to
|
|
|
|
// do it. We need the interpreter lock to make sure thread_info_dict stays
|
|
|
|
// alive.
|
|
|
|
//
|
|
|
|
// If someone already has the API lock, that is ok, we just want to avoid
|
|
|
|
// external code from making new API calls while this call is happening.
|
|
|
|
//
|
|
|
|
// This is a recursive lock so we can grant it to any Python code called on
|
|
|
|
// the stack below us.
|
2016-09-07 04:57:50 +08:00
|
|
|
Target &target = m_process->GetTarget();
|
Prevent deadlock in OS Plugins
Summary:
When performing a synchronous resume, the API mutex is held until the
process is stopped. This is fine, except for when the OS plugins are processing
an event before the main thread is aware of it, in which case we end up with a
deadlock because in the internal thread we acquire a resource lock first, and
then wait for the API lock, while in the main thread we do the opposite, we
already hold the API mutex but are now waiting for the event mutex to handle
the event.
This patch fixes this by relaxing the need for the API lock in the OS plugins.
We can get away with this because we now this code is executed in the main
thread. As stated in the comment above, we just want to ensure nobody else
messes with the API while we're making a change. In theory it's possible that
the main thread would release the lock while we're executing the function, but
prevent this would require a more structural solution (which we want, but do
not have today).
The same workaround was already present, but this patch generalizes it to the
whole file.
This will allow me to re-land r329891.
Reviewers: clayborg, jingham, labath
Subscribers: llvm-commits, lldb-commits
Differential Revision: https://reviews.llvm.org/D45586
llvm-svn: 330002
2018-04-13 18:25:23 +08:00
|
|
|
std::unique_lock<std::recursive_mutex> api_lock(target.GetAPIMutex(),
|
|
|
|
std::defer_lock);
|
|
|
|
api_lock.try_lock();
|
|
|
|
auto interpreter_lock = m_interpreter->AcquireInterpreterLock();
|
2016-09-07 04:57:50 +08:00
|
|
|
|
|
|
|
StructuredData::DictionarySP thread_info_dict =
|
|
|
|
m_interpreter->OSPlugin_CreateThread(m_python_object_sp, tid, context);
|
|
|
|
std::vector<bool> core_used_map;
|
|
|
|
if (thread_info_dict) {
|
|
|
|
ThreadList core_threads(m_process);
|
|
|
|
ThreadList &thread_list = m_process->GetThreadList();
|
|
|
|
bool did_create = false;
|
|
|
|
ThreadSP thread_sp(
|
|
|
|
CreateThreadFromThreadInfo(*thread_info_dict, core_threads,
|
|
|
|
thread_list, core_used_map, &did_create));
|
|
|
|
if (did_create)
|
|
|
|
thread_list.AddThread(thread_sp);
|
|
|
|
return thread_sp;
|
<rdar://problem/13010007>
Added the ability for OS plug-ins to lazily populate the thread this. The python OS plug-in classes can now implement the following method:
class OperatingSystemPlugin:
def create_thread(self, tid, context):
# Return a dictionary for a new thread to create it on demand
This will add a new thread to the thread list if it doesn't already exist. The example code in lldb/examples/python/operating_system.py has been updated to show how this call us used.
Cleaned up the code in PythonDataObjects.cpp/h:
- renamed all classes that started with PythonData* to be Python*.
- renamed PythonArray to PythonList. Cleaned up the code to use inheritance where
- Centralized the code that does ref counting in the PythonObject class to a single function.
- Made the "bool PythonObject::Reset(PyObject *)" function be virtual so each subclass can correctly check to ensure a PyObject is of the right type before adopting the object.
- Cleaned up all APIs and added new constructors for the Python* classes to they can all construct form:
- PyObject *
- const PythonObject &
- const lldb::ScriptInterpreterObjectSP &
Cleaned up code in ScriptInterpreterPython:
- Made calling python functions safer by templatizing the production of value formats. Python specifies the value formats based on built in C types (long, long long, etc), and code often uses typedefs for uint32_t, uint64_t, etc when passing arguments down to python. We will now always produce correct value formats as the templatized code will "do the right thing" all the time.
- Fixed issues with the ScriptInterpreterPython::Locker where entering the session and leaving the session had a bunch of issues that could cause the "lldb" module globals lldb.debugger, lldb.target, lldb.process, lldb.thread, and lldb.frame to not be initialized.
llvm-svn: 172873
2013-01-19 07:41:08 +08:00
|
|
|
}
|
2016-09-07 04:57:50 +08:00
|
|
|
}
|
|
|
|
return ThreadSP();
|
<rdar://problem/13010007>
Added the ability for OS plug-ins to lazily populate the thread this. The python OS plug-in classes can now implement the following method:
class OperatingSystemPlugin:
def create_thread(self, tid, context):
# Return a dictionary for a new thread to create it on demand
This will add a new thread to the thread list if it doesn't already exist. The example code in lldb/examples/python/operating_system.py has been updated to show how this call us used.
Cleaned up the code in PythonDataObjects.cpp/h:
- renamed all classes that started with PythonData* to be Python*.
- renamed PythonArray to PythonList. Cleaned up the code to use inheritance where
- Centralized the code that does ref counting in the PythonObject class to a single function.
- Made the "bool PythonObject::Reset(PyObject *)" function be virtual so each subclass can correctly check to ensure a PyObject is of the right type before adopting the object.
- Cleaned up all APIs and added new constructors for the Python* classes to they can all construct form:
- PyObject *
- const PythonObject &
- const lldb::ScriptInterpreterObjectSP &
Cleaned up code in ScriptInterpreterPython:
- Made calling python functions safer by templatizing the production of value formats. Python specifies the value formats based on built in C types (long, long long, etc), and code often uses typedefs for uint32_t, uint64_t, etc when passing arguments down to python. We will now always produce correct value formats as the templatized code will "do the right thing" all the time.
- Fixed issues with the ScriptInterpreterPython::Locker where entering the session and leaving the session had a bunch of issues that could cause the "lldb" module globals lldb.debugger, lldb.target, lldb.process, lldb.thread, and lldb.frame to not be initialized.
llvm-svn: 172873
2013-01-19 07:41:08 +08:00
|
|
|
}
|
|
|
|
|
2012-08-24 05:17:11 +08:00
|
|
|
#endif // #ifndef LLDB_DISABLE_PYTHON
|