Skip to content

Commit

Permalink
GH-38626: [Python] Fix segfault when PyArrow is imported at shutdown (#…
Browse files Browse the repository at this point in the history
…38637)

### Rationale for this change

Some C++ destructors may be called after the Python interpreter has ceased to exist.
If such a destructor tries to call back in the Python interpreter, for example by calling `Py_DECREF`, we get a crash.

### What changes are included in this PR?

Protect `OwnedRef` and `OwneRefNoGIL` destructors against decref'ing a Python object after Python finalization.

### Are these changes tested?

Yes.

### Are there any user-facing changes?

No.
* Closes: #38626

Authored-by: Antoine Pitrou <antoine@python.org>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
  • Loading branch information
pitrou committed Nov 14, 2023
1 parent a408020 commit f3ec224
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 7 deletions.
17 changes: 10 additions & 7 deletions python/pyarrow/src/arrow/python/common.h
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,12 @@ class ARROW_PYTHON_EXPORT OwnedRef {
return *this;
}

~OwnedRef() { reset(); }
~OwnedRef() {
// GH-38626: destructor may be called after the Python interpreter is finalized.
if (Py_IsInitialized()) {
reset();
}
}

void reset(PyObject* obj) {
Py_XDECREF(obj_);
Expand Down Expand Up @@ -225,13 +230,11 @@ class ARROW_PYTHON_EXPORT OwnedRefNoGIL : public OwnedRef {
explicit OwnedRefNoGIL(PyObject* obj) : OwnedRef(obj) {}

~OwnedRefNoGIL() {
// This destructor may be called after the Python interpreter is finalized.
// At least avoid spurious attempts to take the GIL when not necessary.
if (obj() == NULLPTR) {
return;
// GH-38626: destructor may be called after the Python interpreter is finalized.
if (Py_IsInitialized() && obj() != NULLPTR) {
PyAcquireGIL lock;
reset();
}
PyAcquireGIL lock;
reset();
}
};

Expand Down
13 changes: 13 additions & 0 deletions python/pyarrow/tests/test_misc.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,19 @@ def test_runtime_info():
subprocess.check_call([sys.executable, "-c", code], env=env)


def test_import_at_shutdown():
# GH-38626: importing PyArrow at interpreter shutdown would crash
code = """if 1:
import atexit
def import_arrow():
import pyarrow
atexit.register(import_arrow)
"""
subprocess.check_call([sys.executable, "-c", code])


@pytest.mark.skipif(sys.platform == "win32",
reason="Path to timezone database is not configurable "
"on non-Windows platforms")
Expand Down

0 comments on commit f3ec224

Please sign in to comment.