Issue 21149: logging._removeHandlerRef is not threadsafe during interpreter shutdown

If another thread is active during interpreter shutdown, it can hold the last reference to a handler; when it drops that reference, the weakref callback -- _removeHandlerRef -- will be executed in this other thread. So while this callback is running, the main thread is replacing module globals with None. This creates a data race for the globals in logging -- for example, _releaseLock can be replaced with None after the "_releaseLock is not None" check, but before it is used.

In principle I suspect this could cause a deadlock, in practice all I've seen are exception messages mentioning how None is not callable.

I have attached a patch that I think resolves this issue. The patch is written against 2.7, although I expect this issue affects all versions of Python prior to 3.4

BTW, the copyright for this patch belongs to my employer, Google; please let me know if there are any contributor agreements or such that my employer needs to look at.

> please let me know if there are any contributor agreements

Yes, there is a contributor agreement form which needs to be completed and signed:

https://www.python.org/psf/contrib/contrib-form-python/

Are you sure? There should have been many previous contributions by Google, so the relevant copyright agreements _should_ have already been signed.

I asked internally and was told that a corporate version of this agreement had been signed a long time ago.

Yes, I remember previous discussions of the corporate agreement from Google, so I'm sure it exists.

New changeset b6deab7204e6 by Vinay Sajip in branch '2.7':
Issue #21149: Improved thread-safety in logging cleanup during interpreter shutdown.
http://hg.python.org/cpython/rev/b6deab7204e6

New changeset b5c91b61991a by Vinay Sajip in branch '3.4':
Issue #21149: Improved thread-safety in logging cleanup during interpreter shutdown.
http://hg.python.org/cpython/rev/b5c91b61991a

New changeset 76689a706900 by Vinay Sajip in branch 'default':
Closes #21149: Improved thread-safety in logging cleanup during interpreter shutdown.
http://hg.python.org/cpython/rev/76689a706900

Please don't take my word for it, but my understanding is that this issue doesn't apply to 3.4+ since module globals are no longer set to None during interpreter shutdown. (So all the checks against None could even be deleted.)

The release notes say about PEP 442 that "As part of this change, module globals are no longer forcibly set to None during interpreter shutdown in most cases". I haven't looked at the PEP in detail, so I'm not sure specifically what "most cases" means - so I played it safe.

We're still seeing this (in 2.7.12, but the code at 2.7 head hasn't changed).  In this case the RLock being used within _acquireLock() still exists but is an incomplete object by the time we use it.

Here is a minimal example:

main.py:
    from pkg_a import lib_a
pkg_a/__init__.py
pkg_a/lib_a.py
    import logging
    import sys
    import pkg_a  # This is important
    handler = logging.StreamHandler(sys.stderr)

It does not happen in Python 3 though (3.5.3 at least).

New changeset e84f6d3817ad3d18fdfbb5223b8078606166cea0 by Gregory P. Smith in branch '2.7':
[2.7] bpo-21149: Workaround a GC finalization bug in logging. (#4368)
https://github.com/python/cpython/commit/e84f6d3817ad3d18fdfbb5223b8078606166cea0

nosy: + python-dev
messages: + msg215507

resolution: fixed
stage: resolved