Skip to content

[lldb] Eliminate InitializePythonRAII::InitializeThreadsPrivate (NFC) #151780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 4, 2025
Merged

[lldb] Eliminate InitializePythonRAII::InitializeThreadsPrivate (NFC) #151780

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 10 additions & 41 deletions lldb/source/Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,16 @@ struct InitializePythonRAII {
config.install_signal_handlers = 0;
Py_InitializeFromConfig(&config);
PyConfig_Clear(&config);
InitializeThreadsPrivate();

// The only case we should go further and acquire the GIL: it is unlocked.
if (PyGILState_Check())
return;

m_was_already_initialized = true;
m_gil_state = PyGILState_Ensure();
LLDB_LOGV(GetLog(LLDBLog::Script),
"Ensured PyGILState. Previous state = {0}locked\n",
m_gil_state == PyGILState_UNLOCKED ? "un" : "");
Comment on lines +148 to +149
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: this is more readable.

Suggested change
"Ensured PyGILState. Previous state = {0}locked\n",
m_gil_state == PyGILState_UNLOCKED ? "un" : "");
"Ensured PyGILState. Previous state = {0}\n",
m_gil_state == PyGILState_UNLOCKED ? "unlocked" : "locked");

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed that this is better, but there's 3 other instances, 2 of which are unrelated so I'll do it separately. 👍

}

~InitializePythonRAII() {
Expand All @@ -153,46 +162,6 @@ struct InitializePythonRAII {
}

private:
void InitializeThreadsPrivate() {
// Since Python 3.7 `Py_Initialize` calls `PyEval_InitThreads` inside
// itself, so there is no way to determine whether the embedded interpreter
// was already initialized by some external code.
// `PyEval_ThreadsInitialized` would always return `true` and
// `PyGILState_Ensure/Release` flow would be executed instead of unlocking
// GIL with `PyEval_SaveThread`. When an another thread calls
// `PyGILState_Ensure` it would get stuck in deadlock.

// The only case we should go further and acquire the GIL: it is unlocked.
if (PyGILState_Check())
return;

// `PyEval_ThreadsInitialized` was deprecated in Python 3.9 and removed in
// Python 3.13. It has been returning `true` always since Python 3.7.
#if PY_VERSION_HEX < 0x03090000
if (PyEval_ThreadsInitialized()) {
#else
if (true) {
#endif
Log *log = GetLog(LLDBLog::Script);

m_was_already_initialized = true;
m_gil_state = PyGILState_Ensure();
LLDB_LOGV(log, "Ensured PyGILState. Previous state = {0}locked\n",
m_gil_state == PyGILState_UNLOCKED ? "un" : "");

// `PyEval_InitThreads` was deprecated in Python 3.9 and removed in
// Python 3.13.
#if PY_VERSION_HEX < 0x03090000
return;
}

// InitThreads acquires the GIL if it hasn't been called before.
PyEval_InitThreads();
#else
}
#endif
}

PyGILState_STATE m_gil_state = PyGILState_UNLOCKED;
bool m_was_already_initialized = false;
};
Expand Down
Loading