Blame 00170-gc-assertions.patch

e32ce1
Index: Include/object.h
e32ce1
===================================================================
e32ce1
--- Include/object.h	(revision 87911)
e32ce1
+++ Include/object.h	(working copy)
e32ce1
@@ -914,6 +914,49 @@
e32ce1
 _PyObject_DebugTypeStats(FILE *out);
e32ce1
 #endif /* ifndef Py_LIMITED_API */
e32ce1
 
e32ce1
+/* 
e32ce1
+   Define a pair of assertion macros.
e32ce1
+
e32ce1
+   These work like the regular C assert(), in that they will abort the
e32ce1
+   process with a message on stderr if the given condition fails to hold,
e32ce1
+   but compile away to nothing if NDEBUG is defined.
e32ce1
+
e32ce1
+   However, before aborting, Python will also try to call _PyObject_Dump() on
e32ce1
+   the given object.  This may be of use when investigating bugs in which a
e32ce1
+   particular object is corrupt (e.g. buggy a tp_visit method in an extension
e32ce1
+   module breaking the garbage collector), to help locate the broken objects.
e32ce1
+
e32ce1
+   The WITH_MSG variant allows you to supply an additional message that Python
e32ce1
+   will attempt to print to stderr, after the object dump.
e32ce1
+*/
e32ce1
+#ifdef NDEBUG
e32ce1
+/* No debugging: compile away the assertions: */
e32ce1
+#define PyObject_ASSERT_WITH_MSG(obj, expr, msg) ((void)0)
e32ce1
+#else
e32ce1
+/* With debugging: generate checks: */
e32ce1
+#define PyObject_ASSERT_WITH_MSG(obj, expr, msg) \
e32ce1
+  ((expr)                                           \
e32ce1
+   ? (void)(0)                                      \
e32ce1
+   : _PyObject_AssertFailed((obj),                  \
e32ce1
+                            (msg),                  \
e32ce1
+                            (__STRING(expr)),       \
e32ce1
+                            (__FILE__),             \
e32ce1
+                            (__LINE__),             \
e32ce1
+                            (__PRETTY_FUNCTION__)))
e32ce1
+#endif
e32ce1
+
e32ce1
+#define PyObject_ASSERT(obj, expr) \
e32ce1
+  PyObject_ASSERT_WITH_MSG(obj, expr, NULL)
e32ce1
+
e32ce1
+/* 
e32ce1
+   Declare and define the entrypoint even when NDEBUG is defined, to avoid
e32ce1
+   causing compiler/linker errors when building extensions without NDEBUG
e32ce1
+   against a Python built with NDEBUG defined
e32ce1
+*/
e32ce1
+PyAPI_FUNC(void) _PyObject_AssertFailed(PyObject *,  const char *,
e32ce1
+                                        const char *, const char *, int,
e32ce1
+                                        const char *);
e32ce1
+
e32ce1
 #ifdef __cplusplus
e32ce1
 }
e32ce1
 #endif
e32ce1
Index: Objects/object.c
e32ce1
===================================================================
e32ce1
--- Objects/object.c	(revision 87911)
e32ce1
+++ Objects/object.c	(working copy)
e32ce1
@@ -1899,6 +1899,35 @@
e32ce1
     }
e32ce1
 }
e32ce1
 
e32ce1
+PyAPI_FUNC(void)
e32ce1
+_PyObject_AssertFailed(PyObject *obj, const char *msg, const char *expr,
e32ce1
+		       const char *file, int line, const char *function)
e32ce1
+{
e32ce1
+    fprintf(stderr,
e32ce1
+            "%s:%d: %s: Assertion \"%s\" failed.\n",
e32ce1
+            file, line, function, expr);
e32ce1
+    if (msg) {
e32ce1
+        fprintf(stderr, "%s\n", msg);
e32ce1
+    }
e32ce1
+
e32ce1
+    fflush(stderr);
e32ce1
+
e32ce1
+    if (obj) {
e32ce1
+        /* This might succeed or fail, but we're about to abort, so at least
e32ce1
+           try to provide any extra info we can: */
e32ce1
+        _PyObject_Dump(obj);
e32ce1
+    }
e32ce1
+    else {
e32ce1
+        fprintf(stderr, "NULL object\n");
e32ce1
+    }
e32ce1
+
e32ce1
+    fflush(stdout);
e32ce1
+    fflush(stderr);
e32ce1
+
e32ce1
+    /* Terminate the process: */
e32ce1
+    abort();
e32ce1
+}
e32ce1
+
e32ce1
 #ifndef Py_TRACE_REFS
e32ce1
 /* For Py_LIMITED_API, we need an out-of-line version of _Py_Dealloc.
e32ce1
    Define this here, so we can undefine the macro. */
e32ce1
Index: Lib/test/test_gc.py
e32ce1
===================================================================
e32ce1
--- Lib/test/test_gc.py	(revision 87911)
e32ce1
+++ Lib/test/test_gc.py	(working copy)
e32ce1
@@ -1,6 +1,6 @@
e32ce1
 import unittest
e32ce1
 from test.support import (verbose, refcount_test, run_unittest,
e32ce1
-                            strip_python_stderr, cpython_only)
e32ce1
+                            strip_python_stderr, cpython_only, import_module)
e32ce1
 from test.script_helper import assert_python_ok, make_script, temp_dir
e32ce1
e32ce1
 import sys
e32ce1
@@ -512,6 +512,48 @@
e32ce1
         self.assertEqual(len(gc.garbage), 0)
e32ce1
 
e32ce1
 
e32ce1
+    def test_refcount_errors(self):
e32ce1
+        self.preclean()
e32ce1
+        # Verify the "handling" of objects with broken refcounts
e32ce1
+        import_module("ctypes") #skip if not supported
e32ce1
+
e32ce1
+        import subprocess
e32ce1
+        code = '''if 1:
e32ce1
+        a = []
e32ce1
+        b = [a]
e32ce1
+
e32ce1
+        # Simulate the refcount of "a" being too low (compared to the
e32ce1
+        # references held on it by live data), but keeping it above zero
e32ce1
+        # (to avoid deallocating it):
e32ce1
+        import ctypes
e32ce1
+        ctypes.pythonapi.Py_DecRef(ctypes.py_object(a))
e32ce1
+
e32ce1
+        # The garbage collector should now have a fatal error when it reaches
e32ce1
+        # the broken object:
e32ce1
+        import gc
e32ce1
+        gc.collect()
e32ce1
+        '''
e32ce1
+        p = subprocess.Popen([sys.executable, "-c", code],
e32ce1
+                             stdout=subprocess.PIPE,
e32ce1
+                             stderr=subprocess.PIPE)
e32ce1
+        stdout, stderr = p.communicate()
e32ce1
+        p.stdout.close()
e32ce1
+        p.stderr.close()
e32ce1
+        # Verify that stderr has a useful error message:
e32ce1
+        self.assertRegex(stderr,
e32ce1
+            b'Modules/gcmodule.c:[0-9]+: visit_decref: Assertion "\(\(gc\)->gc.gc_refs >> \(1\)\) != 0" failed.')
e32ce1
+        self.assertRegex(stderr,
e32ce1
+            b'refcount was too small')
e32ce1
+        self.assertRegex(stderr,
e32ce1
+            b'object  : \[\]')
e32ce1
+        self.assertRegex(stderr,
e32ce1
+            b'type    : list')
e32ce1
+        self.assertRegex(stderr,
e32ce1
+            b'refcount: 1')
e32ce1
+        self.assertRegex(stderr,
e32ce1
+            b'address : 0x[0-9a-f]+')
e32ce1
+
e32ce1
+
e32ce1
 class GCTogglingTests(unittest.TestCase):
e32ce1
     def setUp(self):
e32ce1
         gc.enable()
e32ce1
diff -up Modules/gcmodule.c.orig2 Modules/gcmodule.c
e32ce1
--- Modules/gcmodule.c.orig2	2014-12-08 10:54:14.251742911 +0100
e32ce1
+++ Modules/gcmodule.c	2014-12-08 10:52:45.674771917 +0100
e32ce1
@@ -341,7 +341,8 @@ update_refs(PyGC_Head *containers)
e32ce1
 {
e32ce1
     PyGC_Head *gc = containers->gc.gc_next;
e32ce1
     for (; gc != containers; gc = gc->gc.gc_next) {
e32ce1
-        assert(_PyGCHead_REFS(gc) == GC_REACHABLE);
e32ce1
+        PyObject_ASSERT(FROM_GC(gc),
e32ce1
+                        _PyGCHead_REFS(gc) == GC_REACHABLE);
e32ce1
         _PyGCHead_SET_REFS(gc, Py_REFCNT(FROM_GC(gc)));
e32ce1
         /* Python's cyclic gc should never see an incoming refcount
e32ce1
          * of 0:  if something decref'ed to 0, it should have been
e32ce1
@@ -361,7 +362,8 @@ update_refs(PyGC_Head *containers)
e32ce1
          * so serious that maybe this should be a release-build
e32ce1
          * check instead of an assert?
e32ce1
          */
e32ce1
-        assert(_PyGCHead_REFS(gc) != 0);
e32ce1
+        PyObject_ASSERT(FROM_GC(gc),
e32ce1
+                        _PyGCHead_REFS(gc) != 0);
e32ce1
     }
e32ce1
 }
e32ce1
 
e32ce1
@@ -376,7 +378,9 @@ visit_decref(PyObject *op, void *data)
e32ce1
          * generation being collected, which can be recognized
e32ce1
          * because only they have positive gc_refs.
e32ce1
          */
e32ce1
-        assert(_PyGCHead_REFS(gc) != 0); /* else refcount was too small */
e32ce1
+        PyObject_ASSERT_WITH_MSG(FROM_GC(gc),
e32ce1
+                        _PyGCHead_REFS(gc) != 0,
e32ce1
+                        "refcount was too small"); /* else refcount was too small */
e32ce1
         if (_PyGCHead_REFS(gc) > 0)
e32ce1
             _PyGCHead_DECREF(gc);
e32ce1
     }
e32ce1
@@ -436,9 +440,10 @@ visit_reachable(PyObject *op, PyGC_Head
e32ce1
          * If gc_refs == GC_UNTRACKED, it must be ignored.
e32ce1
          */
e32ce1
          else {
e32ce1
-            assert(gc_refs > 0
e32ce1
-                   || gc_refs == GC_REACHABLE
e32ce1
-                   || gc_refs == GC_UNTRACKED);
e32ce1
+             PyObject_ASSERT(FROM_GC(gc),
e32ce1
+                             gc_refs > 0
e32ce1
+                             || gc_refs == GC_REACHABLE
e32ce1
+                             || gc_refs == GC_UNTRACKED);
e32ce1
          }
e32ce1
     }
e32ce1
     return 0;
e32ce1
@@ -480,7 +485,7 @@ move_unreachable(PyGC_Head *young, PyGC_
e32ce1
              */
e32ce1
             PyObject *op = FROM_GC(gc);
e32ce1
             traverseproc traverse = Py_TYPE(op)->tp_traverse;
e32ce1
-            assert(_PyGCHead_REFS(gc) > 0);
e32ce1
+            PyObject_ASSERT(op, _PyGCHead_REFS(gc) > 0);
e32ce1
             _PyGCHead_SET_REFS(gc, GC_REACHABLE);
e32ce1
             (void) traverse(op,
e32ce1
                             (visitproc)visit_reachable,
e32ce1
@@ -543,7 +548,7 @@ move_legacy_finalizers(PyGC_Head *unreac
e32ce1
     for (gc = unreachable->gc.gc_next; gc != unreachable; gc = next) {
e32ce1
         PyObject *op = FROM_GC(gc);
e32ce1
 
e32ce1
-        assert(IS_TENTATIVELY_UNREACHABLE(op));
e32ce1
+        PyObject_ASSERT(op, IS_TENTATIVELY_UNREACHABLE(op));
e32ce1
         next = gc->gc.gc_next;
e32ce1
 
e32ce1
         if (has_legacy_finalizer(op)) {
e32ce1
@@ -619,7 +624,7 @@ handle_weakrefs(PyGC_Head *unreachable,
e32ce1
         PyWeakReference **wrlist;
e32ce1
 
e32ce1
         op = FROM_GC(gc);
e32ce1
-        assert(IS_TENTATIVELY_UNREACHABLE(op));
e32ce1
+        PyObject_ASSERT(op, IS_TENTATIVELY_UNREACHABLE(op));
e32ce1
         next = gc->gc.gc_next;
e32ce1
 
e32ce1
         if (! PyType_SUPPORTS_WEAKREFS(Py_TYPE(op)))
e32ce1
@@ -640,9 +645,9 @@ handle_weakrefs(PyGC_Head *unreachable,
e32ce1
              * the callback pointer intact.  Obscure:  it also
e32ce1
              * changes *wrlist.
e32ce1
              */
e32ce1
-            assert(wr->wr_object == op);
e32ce1
+            PyObject_ASSERT(wr->wr_object, wr->wr_object == op);
e32ce1
             _PyWeakref_ClearRef(wr);
e32ce1
-            assert(wr->wr_object == Py_None);
e32ce1
+            PyObject_ASSERT(wr->wr_object, wr->wr_object == Py_None);
e32ce1
             if (wr->wr_callback == NULL)
e32ce1
                 continue;                       /* no callback */
e32ce1
 
e32ce1
@@ -676,7 +681,7 @@ handle_weakrefs(PyGC_Head *unreachable,
e32ce1
      */
e32ce1
             if (IS_TENTATIVELY_UNREACHABLE(wr))
e32ce1
                 continue;
e32ce1
-            assert(IS_REACHABLE(wr));
e32ce1
+            PyObject_ASSERT(op, IS_REACHABLE(wr));
e32ce1
 
e32ce1
             /* Create a new reference so that wr can't go away
e32ce1
              * before we can process it again.
e32ce1
@@ -685,7 +690,8 @@ handle_weakrefs(PyGC_Head *unreachable,
e32ce1
 
e32ce1
             /* Move wr to wrcb_to_call, for the next pass. */
e32ce1
             wrasgc = AS_GC(wr);
e32ce1
-            assert(wrasgc != next); /* wrasgc is reachable, but
e32ce1
+            PyObject_ASSERT(op, wrasgc != next);
e32ce1
+                                    /* wrasgc is reachable, but
e32ce1
                                        next isn't, so they can't
e32ce1
                                        be the same */
e32ce1
             gc_list_move(wrasgc, &wrcb_to_call);
e32ce1
@@ -701,11 +707,11 @@ handle_weakrefs(PyGC_Head *unreachable,
e32ce1
 
e32ce1
         gc = wrcb_to_call.gc.gc_next;
e32ce1
         op = FROM_GC(gc);
e32ce1
-        assert(IS_REACHABLE(op));
e32ce1
-        assert(PyWeakref_Check(op));
e32ce1
+        PyObject_ASSERT(op, IS_REACHABLE(op));
e32ce1
+        PyObject_ASSERT(op, PyWeakref_Check(op));
e32ce1
         wr = (PyWeakReference *)op;
e32ce1
         callback = wr->wr_callback;
e32ce1
-        assert(callback != NULL);
e32ce1
+        PyObject_ASSERT(op, callback != NULL);
e32ce1
 
e32ce1
         /* copy-paste of weakrefobject.c's handle_callback() */
e32ce1
         temp = PyObject_CallFunctionObjArgs(callback, wr, NULL);
e32ce1
@@ -822,12 +828,14 @@ check_garbage(PyGC_Head *collectable)
e32ce1
     for (gc = collectable->gc.gc_next; gc != collectable;
e32ce1
          gc = gc->gc.gc_next) {
e32ce1
         _PyGCHead_SET_REFS(gc, Py_REFCNT(FROM_GC(gc)));
e32ce1
-        assert(_PyGCHead_REFS(gc) != 0);
e32ce1
+        PyObject_ASSERT(FROM_GC(gc),
e32ce1
+                        _PyGCHead_REFS(gc) != 0);
e32ce1
     }
e32ce1
     subtract_refs(collectable);
e32ce1
     for (gc = collectable->gc.gc_next; gc != collectable;
e32ce1
          gc = gc->gc.gc_next) {
e32ce1
-        assert(_PyGCHead_REFS(gc) >= 0);
e32ce1
+        PyObject_ASSERT(FROM_GC(gc),
e32ce1
+                        _PyGCHead_REFS(gc) >= 0);
e32ce1
         if (_PyGCHead_REFS(gc) != 0)
e32ce1
             return -1;
e32ce1
     }
e32ce1
diff -up Lib/test/test_gc.py.old Lib/test/test_gc.py
e32ce1
--- Lib/test/test_gc.py.old	2014-12-10 11:19:33.503982288 +0100
e32ce1
+++ Lib/test/test_gc.py	2014-12-10 11:21:13.220021364 +0100
e32ce1
@@ -49,6 +49,8 @@ class GC_Detector(object):
e32ce1
         # gc collects it.
e32ce1
         self.wr = weakref.ref(C1055820(666), it_happened)
e32ce1
 
e32ce1
+BUILD_WITH_NDEBUG = ('-DNDEBUG' in sysconfig.get_config_vars()['PY_CFLAGS'])
e32ce1
+
e32ce1
 @with_tp_del
e32ce1
 class Uncollectable(object):
e32ce1
     """Create a reference cycle with multiple __del__ methods.
e32ce1
@@ -854,6 +856,8 @@ class GCCallbackTests(unittest.TestCase)
e32ce1
         self.assertEqual(len(gc.garbage), 0)
e32ce1
 
e32ce1
 
e32ce1
+    @unittest.skipIf(BUILD_WITH_NDEBUG,
e32ce1
+                     'built with -NDEBUG')
e32ce1
     def test_refcount_errors(self):
e32ce1
         self.preclean()
e32ce1
         # Verify the "handling" of objects with broken refcounts
e32ce1
diff -up Lib/test/test_gc.py.old Lib/test/test_gc.py
e32ce1
--- Lib/test/test_gc.py.old	2014-12-10 12:50:58.252121318 +0100
e32ce1
+++ Lib/test/test_gc.py	2014-12-10 12:51:08.594266653 +0100
e32ce1
@@ -4,6 +4,7 @@ from test.support import (verbose, refco
e32ce1
 from test.script_helper import assert_python_ok, make_script, temp_dir
e32ce1
 
e32ce1
 import sys
e32ce1
+import sysconfig
e32ce1
 import time
e32ce1
 import gc
e32ce1
 import weakref