ScopedGIL.h

Go to the documentation of this file.

/*
 * Copyright (C) by
 *   MetraLabs GmbH (MLAB), GERMANY
 *  and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Redistribution and modification of this code is strictly prohibited.
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

/*
 * @file ScopedGIL.h
 *    Scoped GIL lock classes.
 *
 * @author Christian Vollmer, Tim Langner
 * @date:  2011/03/02
  */

#ifndef _MIRA_TOOLBOXES_PYTHON_SCOPEDGIL_H_
#define _MIRA_TOOLBOXES_PYTHON_SCOPEDGIL_H_

#include <Python.h>

namespace mira { namespace python {


class ScopedGILLock
{
public:

    ScopedGILLock()
    {
        mState = PyGILState_Ensure();
        mLocked = true;
    }

    ~ScopedGILLock()
    {
        unlock();
    }

    void unlock()
    {
        if (mLocked)
        {
            PyGILState_Release(mState);
            mLocked = false;
        }
    }

private:
    PyGILState_STATE mState;
    bool mLocked;
};

class ScopedGILThreadLock
{
public:
    ScopedGILThreadLock()
    {
        mState = PyEval_SaveThread();
        mLocked = true;
    }
    ~ScopedGILThreadLock()
    {
        unlock();
    }

    void unlock()
    {
        if (mLocked)
        {
            PyEval_RestoreThread(mState);
            mLocked = false;
        }
    }

private:
    PyThreadState* mState;
    bool mLocked;
};


}}

#endif /* _MIRA_TOOLBOXES_PYTHON_SCOPEDGIL_H_ */