Try to print repr() when an C-level assert fails (in the garbage collector, beyond?)

[davidmalcolm]

BPO	9263
Nosy	@loewis, @ncoghlan, @pitrou, @vstinner, @davidmalcolm, @serhiy-storchaka
PRs	bpo-9263: _PyObject_Dump() detects freed memory #10061 bpo-9263: Dump Python object on GC assertion failure #10062 bpo-9263: CheckConsistency() use _PyObject_ASSERT() #10108 bpo-9263: _Py_NegativeRefcount() use _PyObject_AssertFailed() #10109 bpo-9263: Use _PyObject_ASSERT() in object.c #10110 bpo-9263: Use _PyObject_ASSERT() in typeobject.c #10111 bpo-9263: Use _PyObject_ASSERT() in gcmodule.c #10112 bpo-9263: Fix _PyObject_Dump() for freed object #10661 [3.7] bpo-9263: _PyObject_Dump() detects freed memory (GH-10061) #10662 [3.6] bpo-9263: _PyObject_Dump() detects freed memory (GH-10061) (GH-10662) #10663
Files	py3k-repr-on-gcmodule-assertions.patch py3k-objdump-on-gcmodule-assertions-2010-11-22-001.patch py3k-objdump-on-gcmodule-assertions-2011-01-10-001.patch py3k-objdump-on-gcmodule-assertions-2011-01-10-002.patch 00170-gc-assertions.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2018-10-26.17:13:51.209>
created_at = <Date 2010-07-14.23:50:49.130>
labels = ['interpreter-core', 'type-feature']
title = 'Try to print repr() when an C-level assert fails (in the garbage collector, beyond?)'
updated_at = <Date 2018-11-22.16:40:57.760>
user = 'https://github.com/davidmalcolm'

bugs.python.org fields:

activity = <Date 2018-11-22.16:40:57.760>
actor = 'vstinner'
assignee = 'none'
closed = True
closed_date = <Date 2018-10-26.17:13:51.209>
closer = 'vstinner'
components = ['Interpreter Core']
creation = <Date 2010-07-14.23:50:49.130>
creator = 'dmalcolm'
dependencies = []
files = ['18007', '19777', '20343', '20344', '30532']
hgrepos = []
issue_num = 9263
keywords = ['patch']
message_count = 20.0
messages = ['110341', '122170', '125959', '125960', '131016', '131036', '190929', '328323', '328327', '328452', '328507', '328560', '328566', '328568', '328569', '328575', '328576', '330266', '330267', '330270']
nosy_count = 7.0
nosy_names = ['loewis', 'ncoghlan', 'pitrou', 'vstinner', 'dmalcolm', 'serhiy.storchaka', 'bkabrda']
pr_nums = ['10061', '10062', '10108', '10109', '10110', '10111', '10112', '10661', '10662', '10663']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue9263'
versions = ['Python 3.3']

Linked PRs

• gh-53509: Move _PyObject_ASSERT() to the internal C API #139872

[davidmalcolm]

Modules/gcmodule.c contains various assertions which can fail due to reference counting errors elsewhere in either python, or an extension module. These can be difficult to track down.

In the hope of maximizing the information from crash reports, the attached patch (against py3k) introduces a new assertion macro to Objects/object.h and Objects.c, which provides a richer debug message. In particular, it identifies which object has the issue, and can more clearly spell out the problem.

The patch replaces all uses of assert() in Modules/gcmodule.c for which a specific object has an issue (e.g. bogus reference count).

The implementation may play somewhat fast-and-loose with rules about object invariants: you might have an only partially valid object, but the process is about to abort, so it seems acceptable to try to glean extra information on stderr. (This may turn an abort into a segfault, of course)

Caveats:

• exact name of the API probably could be better
• I don't yet have a specific use for the "callback" idea; I was thinking of trying to display all objects that reference that object. Might need a void* closure to be useful. Might be a useless complication.
• Only tested on gcc-4.4.3 so far; the __STRING(expr) and __PRETTY_FUNCTION__ look non-portable.
• no test case; I thought about using ctypes to extract PyObject_IncRef from the implementation, but this is likely to lead to brittle test cases. Alternatively, is xxmodule to be used for this kind of thing?

Thoughts?

[davidmalcolm]

Attaching a simplified version of the patch; I got rid of the callbacks.

Still doesn't have test cases.

I suspect that the use of __STRING and __PRETTY_FUNCTION__ may be compatibility issues. I believe that __FILE__ and __LINE__ and standard C though.

[davidmalcolm]

Attaching updated version of the patch.

I've added a selftest which (in a sacrificial subprocess) abuses ctypes to break an ob_refcnt, and then triggers a garbage collection.

I also changed the printing to stderr to directly use fprintf and fflush to ensure that data leaves the process before abort kills it (not sure if this is a cross-platform or unicode no-no, though).

[davidmalcolm]

As above, but I added an extra call to fflush in case the call to _PyObject_Dump leads to a segfault.

[pitrou]

How about turning these asserts into Py_FatalError()s and then enabling Victor's faulthandler extension?

[ncoghlan]

I'd suggest calling Py_FatalError rather than calling abort() directly in _PyObject_AssertFailed, but otherwise this looks like a nice improvement over standard C asserts for state invariants that may be broken by buggy C extensions.

For the tests, take a look at test.script_helper - it provides some convenience wrappers for spawning subprocesses for tests that would cause problems if run in the current process.

[bkabrda]

I'm currently patching Python 3.3.2 with this, so I thought it might be nice to attach an up-to-date patch. The only notable difference is that I added self.preclean() at the beginning of test_refcount_errors - without it, running test suite produced a huge number of these lines:

Exception AttributeError: "'GCCallbackTests' object has no attribute 'visit'" in <bound method GCCallbackTests.cb1 of <main.GCCallbackTests testMethod=test_refcount_errors>> ignored

[vstinner]

New changeset 82af0b6 by Victor Stinner in branch 'master':
bpo-9263: _PyObject_Dump() detects freed memory (GH-10061)
82af0b6

[vstinner]

00170-gc-assertions.patch is used in the Fedora package of Python.

I converted the patch to a pull request: PR 10062.

My PR only uses the new assertion macro once. I plan to write more changes to use the new assertion macros in more places, once the first PR is merged.

[vstinner]

New changeset 626bff8 by Victor Stinner in branch 'master':
bpo-9263: Dump Python object on GC assertion failure (GH-10062)
626bff8

[vstinner]

New changeset 3ec9af7 by Victor Stinner in branch 'master':
bpo-9263: _Py_NegativeRefcount() use _PyObject_AssertFailed() (GH-10109)
3ec9af7

[vstinner]

New changeset 2470204 by Victor Stinner in branch 'master':
bpo-9263: Use _PyObject_ASSERT() in object.c (GH-10110)
2470204

[vstinner]

New changeset a4b2bc7 by Victor Stinner in branch 'master':
bpo-9263: Use _PyObject_ASSERT() in gcmodule.c (GH-10112)
a4b2bc7