From 23c3a075ee1a27e1b57fcb452a4d6ce53080264e Mon Sep 17 00:00:00 2001 From: John Spray Date: Tue, 22 Aug 2017 11:38:25 -0400 Subject: [PATCH] mgr: move Gil implementation into .cc The inclusion of Python.h in the .h was awkward for other files including Gil.h. Signed-off-by: John Spray --- src/CMakeLists.txt | 1 + src/mgr/Gil.cc | 72 ++++++++++++++++++++++++++++++++++++++++++++++ src/mgr/Gil.h | 65 ++++------------------------------------- 3 files changed, 79 insertions(+), 59 deletions(-) create mode 100644 src/mgr/Gil.cc diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 16ea6876ec97e..62a6ecc5d6eee 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -720,6 +720,7 @@ if (WITH_MGR) mgr/MgrPyModule.cc mgr/MgrStandby.cc mgr/Mgr.cc + mgr/Gil.cc mgr/mgr_commands.cc) add_executable(ceph-mgr ${mgr_srcs} $) diff --git a/src/mgr/Gil.cc b/src/mgr/Gil.cc new file mode 100644 index 0000000000000..53ecf99c37f05 --- /dev/null +++ b/src/mgr/Gil.cc @@ -0,0 +1,72 @@ +// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*- +// vim: ts=8 sw=2 smarttab +/* + * Ceph - scalable distributed file system + * + * Copyright (C) 2017 SUSE LLC + * + * This is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software + * Foundation. See file COPYING. + * + */ + + +#include "Python.h" + +#include "common/debug.h" + +#define dout_context g_ceph_context +#define dout_subsys ceph_subsys_mgr +#undef dout_prefix +#define dout_prefix *_dout << "mgr " << __func__ << " " + +#include "Gil.h" + +Gil::Gil(PyThreadState *ts, bool new_thread) : pThreadState(ts) +{ + assert(pThreadState != nullptr); + + // Acquire the GIL, set the current thread state + PyEval_RestoreThread(pThreadState); + dout(25) << "GIL acquired for thread state " << pThreadState << dendl; + + // + // If called from a separate OS thread (i.e. a thread not created + // by Python, that does't already have a python thread state that + // was created when that thread was active), we need to manually + // create and switch to a python thread state specifically for this + // OS thread. + // + // Note that instead of requring the caller to set new_thread == true + // when calling this from a separate OS thread, we could figure out + // if this was necessary automatically, as follows: + // + // if (pThreadState->thread_id != PyThread_get_thread_ident()) { + // + // However, this means we're accessing pThreadState->thread_id, but + // the Python C API docs say that "The only public data member is + // PyInterpreterState *interp", i.e. doing this would violate + // something that's meant to be a black box. + // + if (new_thread) { + pNewThreadState = PyThreadState_New(pThreadState->interp); + PyThreadState_Swap(pNewThreadState); + dout(20) << "Switched to new thread state " << pNewThreadState << dendl; + } +} + +Gil::~Gil() +{ + if (pNewThreadState != nullptr) { + dout(20) << "Destroying new thread state " << pNewThreadState << dendl; + PyThreadState_Swap(pThreadState); + PyThreadState_Clear(pNewThreadState); + PyThreadState_Delete(pNewThreadState); + } + // Release the GIL, reset the thread state to NULL + PyEval_SaveThread(); + dout(25) << "GIL released for thread state " << pThreadState << dendl; +} + diff --git a/src/mgr/Gil.h b/src/mgr/Gil.h index 0c401c0a91234..28ec8a5f38970 100644 --- a/src/mgr/Gil.h +++ b/src/mgr/Gil.h @@ -12,19 +12,11 @@ * */ -#ifndef GIL_H_ -#define GIL_H_ +#pragma once -#include "Python.h" +struct _ts; +typedef struct _ts PyThreadState; -#include "common/debug.h" - -#define dout_context g_ceph_context -#define dout_subsys ceph_subsys_mgr -#undef dout_prefix -#define dout_prefix *_dout << "mgr " << __func__ << " " - -// // Use one of these in any scope in which you need to hold Python's // Global Interpreter Lock. // @@ -34,63 +26,18 @@ // If in doubt, explicitly put a scope around the block of code you // know you need the GIL in. // -// See the comment below for when to set new_thread == true +// See the comment in Gil::Gil for when to set new_thread == true // class Gil { public: Gil(const Gil&) = delete; Gil& operator=(const Gil&) = delete; - Gil(PyThreadState *ts, bool new_thread = false) : pThreadState(ts) - { - assert(pThreadState != nullptr); - - // Acquire the GIL, set the current thread state - PyEval_RestoreThread(pThreadState); - dout(25) << "GIL acquired for thread state " << pThreadState << dendl; - - // - // If called from a separate OS thread (i.e. a thread not created - // by Python, that does't already have a python thread state that - // was created when that thread was active), we need to manually - // create and switch to a python thread state specifically for this - // OS thread. - // - // Note that instead of requring the caller to set new_thread == true - // when calling this from a separate OS thread, we could figure out - // if this was necessary automatically, as follows: - // - // if (pThreadState->thread_id != PyThread_get_thread_ident()) { - // - // However, this means we're accessing pThreadState->thread_id, but - // the Python C API docs say that "The only public data member is - // PyInterpreterState *interp", i.e. doing this would violate - // something that's meant to be a black box. - // - if (new_thread) { - pNewThreadState = PyThreadState_New(pThreadState->interp); - PyThreadState_Swap(pNewThreadState); - dout(20) << "Switched to new thread state " << pNewThreadState << dendl; - } - } - - ~Gil() - { - if (pNewThreadState != nullptr) { - dout(20) << "Destroying new thread state " << pNewThreadState << dendl; - PyThreadState_Swap(pThreadState); - PyThreadState_Clear(pNewThreadState); - PyThreadState_Delete(pNewThreadState); - } - // Release the GIL, reset the thread state to NULL - PyEval_SaveThread(); - dout(25) << "GIL released for thread state " << pThreadState << dendl; - } + Gil(PyThreadState *ts, bool new_thread = false); + ~Gil(); private: PyThreadState *pThreadState; PyThreadState *pNewThreadState = nullptr; }; -#endif - -- 2.39.5