#
8.1 Thread State and the Global Interpreter Lock

The Python interpreter is not fully thread safe. In order to support multi-threaded Python programs, there's a global lock that must be held by the current thread before it can safely access Python objects. Without the lock, even the simplest operations could cause problems in a multi-threaded program: for example, when two threads simultaneously increment the reference count of the same object, the reference count could end up being incremented only once instead of twice.

Therefore, the rule exists that only the thread that has acquired the global interpreter lock may operate on Python objects or call Python/C API functions. In order to support multi-threaded Python programs, the interpreter regularly releases and reacquires the lock -- by default, every 100 bytecode instructions (this can be changed with `sys.setcheckinterval()`). The lock is also released and reacquired around potentially blocking I/O operations like reading or writing a file, so that other threads can run while the thread that requests the I/O is waiting for the I/O operation to complete.

The Python interpreter needs to keep some bookkeeping information separate per thread -- for this it uses a data structure called `PyThreadState`. There's one global variable, however: the pointer to the current `PyThreadState` structure. While most thread packages have a way to store ``per-thread global data,'' Python's internal platform independent thread abstraction doesn't support this yet. Therefore, the current thread state must be manipulated explicitly.

This is easy enough in most cases. Most code manipulating the global interpreter lock has the following simple structure:

    Save the thread state in a local variable.
    Release the interpreter lock.
    ...Do some blocking I/O operation...
    Reacquire the interpreter lock.
    Restore the thread state from the local variable.

This is so common that a pair of macros exists to simplify it:

    Py_BEGIN_ALLOW_THREADS
    ...Do some blocking I/O operation...
    Py_END_ALLOW_THREADS

The Py_BEGIN_ALLOW_THREADS macro opens a new block and declares a hidden local variable; the Py_END_ALLOW_THREADS macro closes the block. Another advantage of using these two macros is that when Python is compiled without thread support, they are defined empty, thus saving the thread state and lock manipulations.

When thread support is enabled, the block above expands to the following code:

        PyThreadState *_save;

        _save = PyEval_SaveThread();
        ...Do some blocking I/O operation...
        PyEval_RestoreThread(_save);

Using even lower level primitives, we can get roughly the same effect as follows:

        PyThreadState *_save;

        _save = PyThreadState_Swap(NULL);
        PyEval_ReleaseLock();
        ...Do some blocking I/O operation...
        PyEval_AcquireLock();
        PyThreadState_Swap(_save);

There are some subtle differences; in particular, `PyEval_RestoreThread()` saves and restores the value of the global variable `errno`, since the lock manipulation does not guarantee that `errno` is left alone. Also, when thread support is disabled, `PyEval_SaveThread()` and `PyEval_RestoreThread()` don't manipulate the lock; in this case, `PyEval_ReleaseLock()` and `PyEval_AcquireLock()` are not available. This is done so that dynamically loaded extensions compiled with thread support enabled can be loaded by an interpreter that was compiled with disabled thread support.

The global interpreter lock is used to protect the pointer to the current thread state. When releasing the lock and saving the thread state, the current thread state pointer must be retrieved before the lock is released (since another thread could immediately acquire the lock and store its own thread state in the global variable). Conversely, when acquiring the lock and restoring the thread state, the lock must be acquired before storing the thread state pointer.

Why am I going on with so much detail about this? Because when threads are created from C, they don't have the global interpreter lock, nor is there a thread state data structure for them. Such threads must bootstrap themselves into existence, by first creating a thread state data structure, then acquiring the lock, and finally storing their thread state pointer, before they can start using the Python/C API. When they are done, they should reset the thread state pointer, release the lock, and finally free their thread state data structure.

Beginning with version 2.3, threads can now take advantage of the `PyGILState_*()` functions to do all of the above automatically. The typical idiom for calling into Python from a C thread is now:

        PyGILState_STATE gstate;
        gstate = PyGILState_Ensure();

        /* Perform Python actions here.  */
        result = CallSomeFunction();
        /* evaluate result */

        /* Release the thread. No Python API allowed beyond this point. */
        PyGILState_Release(gstate);

Note that the `PyGILState_*()` functions assume there is only one global interpreter (created automatically by `Py_Initialize()`). Python still supports the creation of additional interpreters (using `Py_NewInterpreter()`), but mixing multiple interpreters and the `PyGILState_*()` API is unsupported.

`PyInterpreterState`
  This data structure represents the state shared by a number of cooperating threads. Threads belonging to the same interpreter share their module administration and a few other internal items. There are no public members in this structure.

  Threads belonging to different interpreters initially share nothing, except process state like available memory, open file descriptors and such. The global interpreter lock is also shared by all threads, regardless of to which interpreter they belong.

`PyThreadState`
  This data structure represents the state of a single thread. The only public data member is `PyInterpreterState *``interp`, which points to this thread's interpreter state.

void `PyEval_InitThreads`( | )

  Initialize and acquire the global interpreter lock. It should be called in the main thread before creating a second thread or engaging in any other thread operations such as `PyEval_ReleaseLock()` or `PyEval_ReleaseThread(tstate)`. It is not needed before calling `PyEval_SaveThread()` or `PyEval_RestoreThread()`.

  This is a no-op when called for a second time. It is safe to call this function before calling `Py_Initialize()`.

  When only the main thread exists, no lock operations are needed. This is a common situation (most Python programs do not use threads), and the lock operations slow the interpreter down a bit. Therefore, the lock is not created initially. This situation is equivalent to having acquired the lock: when there is only a single thread, all object accesses are safe. Therefore, when this function initializes the lock, it also acquires it. Before the Python `thread` module creates a new thread, knowing that either it has the lock or the lock hasn't been created yet, it calls `PyEval_InitThreads()`. When this call returns, it is guaranteed that the lock has been created and that the calling thread has acquired it.

  It is not safe to call this function when it is unknown which thread (if any) currently has the global interpreter lock.

  This function is not available when thread support is disabled at compile time.

int `PyEval_ThreadsInitialized`( | )

  Returns a non-zero value if `PyEval_InitThreads()` has been called. This function can be called without holding the lock, and therefore can be used to avoid calls to the locking API when running single-threaded. This function is not available when thread support is disabled at compile time. New in version 2.4.

void `PyEval_AcquireLock`( | )

  Acquire the global interpreter lock. The lock must have been created earlier. If this thread already has the lock, a deadlock ensues. This function is not available when thread support is disabled at compile time.

void `PyEval_ReleaseLock`( | )

  Release the global interpreter lock. The lock must have been created earlier. This function is not available when thread support is disabled at compile time.

void `PyEval_AcquireThread`( | PyThreadState *tstate)

  Acquire the global interpreter lock and set the current thread state to tstate, which should not be `NULL`. The lock must have been created earlier. If this thread already has the lock, deadlock ensues. This function is not available when thread support is disabled at compile time.

void `PyEval_ReleaseThread`( | PyThreadState *tstate)

  Reset the current thread state to `NULL` and release the global interpreter lock. The lock must have been created earlier and must be held by the current thread. The tstate argument, which must not be `NULL`, is only used to check that it represents the current thread state -- if it isn't, a fatal error is reported. This function is not available when thread support is disabled at compile time.

PyThreadState* `PyEval_SaveThread`( | )

  Release the interpreter lock (if it has been created and thread support is enabled) and reset the thread state to `NULL`, returning the previous thread state (which is not `NULL`). If the lock has been created, the current thread must have acquired it. (This function is available even when thread support is disabled at compile time.)

void `PyEval_RestoreThread`( | PyThreadState *tstate)

  Acquire the interpreter lock (if it has been created and thread support is enabled) and set the thread state to tstate, which must not be `NULL`. If the lock has been created, the current thread must not have acquired it, otherwise deadlock ensues. (This function is available even when thread support is disabled at compile time.)

The following macros are normally used without a trailing semicolon; look for example usage in the Python source distribution.

`Py_BEGIN_ALLOW_THREADS`
  This macro expands to "`{ PyThreadState *_save; _save = PyEval_SaveThread();`". Note that it contains an opening brace; it must be matched with a following Py_END_ALLOW_THREADS macro. See above for further discussion of this macro. It is a no-op when thread support is disabled at compile time.

`Py_END_ALLOW_THREADS`
  This macro expands to "`PyEval_RestoreThread(_save); }`". Note that it contains a closing brace; it must be matched with an earlier Py_BEGIN_ALLOW_THREADS macro. See above for further discussion of this macro. It is a no-op when thread support is disabled at compile time.

`Py_BLOCK_THREADS`
  This macro expands to "`PyEval_RestoreThread(_save);`": it is equivalent to Py_END_ALLOW_THREADS without the closing brace. It is a no-op when thread support is disabled at compile time.

`Py_UNBLOCK_THREADS`
  This macro expands to "`_save = PyEval_SaveThread();`": it is equivalent to Py_BEGIN_ALLOW_THREADS without the opening brace and variable declaration. It is a no-op when thread support is disabled at compile time.

All of the following functions are only available when thread support is enabled at compile time, and must be called only when the interpreter lock has been created.

PyInterpreterState* `PyInterpreterState_New`( | )

  Create a new interpreter state object. The interpreter lock need not be held, but may be held if it is necessary to serialize calls to this function.

void `PyInterpreterState_Clear`( | PyInterpreterState *interp)

  Reset all information in an interpreter state object. The interpreter lock must be held.

void `PyInterpreterState_Delete`( | PyInterpreterState *interp)

  Destroy an interpreter state object. The interpreter lock need not be held. The interpreter state must have been reset with a previous call to `PyInterpreterState_Clear()`.

PyThreadState* `PyThreadState_New`( | PyInterpreterState *interp)

  Create a new thread state object belonging to the given interpreter object. The interpreter lock need not be held, but may be held if it is necessary to serialize calls to this function.

void `PyThreadState_Clear`( | PyThreadState *tstate)

  Reset all information in a thread state object. The interpreter lock must be held.

void `PyThreadState_Delete`( | PyThreadState *tstate)

  Destroy a thread state object. The interpreter lock need not be held. The thread state must have been reset with a previous call to `PyThreadState_Clear()`.

PyThreadState* `PyThreadState_Get`( | )

  Return the current thread state. The interpreter lock must be held. When the current thread state is `NULL`, this issues a fatal error (so that the caller needn't check for `NULL`).

PyThreadState* `PyThreadState_Swap`( | PyThreadState *tstate)

  Swap the current thread state with the thread state given by the argument tstate, which may be `NULL`. The interpreter lock must be held.

PyObject* `PyThreadState_GetDict`( | )

  Return value: Borrowed reference.
  Return a dictionary in which extensions can store thread-specific state information. Each extension should use a unique key to use to store state in the dictionary. It is okay to call this function when no current thread state is available. If this function returns `NULL`, no exception has been raised and the caller should assume no current thread state is available. Changed in version 2.3: Previously this could only be called when a current thread is active, and `NULL` meant that an exception was raised.

int `PyThreadState_SetAsyncExc`( | long id, PyObject *exc)

  Asynchronously raise an exception in a thread. The id argument is the thread id of the target thread; exc is the exception object to be raised. This function does not steal any references to exc. To prevent naive misuse, you must write your own C extension to call this. Must be called with the GIL held. Returns the number of thread states modified; this is normally one, but will be zero if the thread id isn't found. If exc is `NULL`, the pending exception (if any) for the thread is cleared. This raises no exceptions. New in version 2.3.

PyGILState_STATE `PyGILState_Ensure`( | )

  Ensure that the current thread is ready to call the Python C API regardless of the current state of Python, or of its thread lock. This may be called as many times as desired by a thread as long as each call is matched with a call to `PyGILState_Release()`. In general, other thread-related APIs may be used between `PyGILState_Ensure()` and `PyGILState_Release()` calls as long as the thread state is restored to its previous state before the Release(). For example, normal usage of the Py_BEGIN_ALLOW_THREADS and Py_END_ALLOW_THREADS macros is acceptable.

  The return value is an opaque "handle" to the thread state when `PyGILState_Acquire()` was called, and must be passed to `PyGILState_Release()` to ensure Python is left in the same state. Even though recursive calls are allowed, these handles cannot be shared - each unique call to `PyGILState_Ensure` must save the handle for its call to `PyGILState_Release`.

  When the function returns, the current thread will hold the GIL. Failure is a fatal error. New in version 2.3.

void `PyGILState_Release`( | PyGILState_STATE)

  Release any resources previously acquired. After this call, Python's state will be the same as it was prior to the corresponding `PyGILState_Ensure` call (but generally this state will be unknown to the caller, hence the use of the GILState API.)

  Every call to `PyGILState_Ensure()` must be matched by a call to `PyGILState_Release()` on the same thread. New in version 2.3.