[Python-checkins] bpo-29564:_PyMem_DumpTraceback() suggests enabling tracemalloc (GH-10510)

[Victor Stinner]

https://github.com/python/cpython/commit/f966e5397ed8f5c42c185223fc9b4d750a678d02
commit: f966e5397ed8f5c42c185223fc9b4d750a678d02
branch: master
author: Victor Stinner <vstinner at redhat.com>
committer: GitHub <noreply at github.com>
date: 2018-11-13T15:14:58+01:00
summary:

bpo-29564:_PyMem_DumpTraceback() suggests enabling tracemalloc (GH-10510)

If tracemalloc is not tracing Python memory allocations,
_PyMem_DumpTraceback() now suggests to enable tracemalloc
to get the traceback where the memory block has been allocated.

files:
M Lib/test/test_capi.py
M Modules/_tracemalloc.c

diff --git a/Lib/test/test_capi.py b/Lib/test/test_capi.py
index b3600ebe993d..3c8c3f02bf78 100644
--- a/Lib/test/test_capi.py
+++ b/Lib/test/test_capi.py
@@ -486,6 +486,8 @@ def test_buffer_overflow(self):
                  r"    The block was made by call #[0-9]+ to debug malloc/realloc.\n"
                  r"    Data at p: cb cb cb .*\n"
                  r"\n"
+                 r"Enable tracemalloc to get the memory block allocation traceback\n"
+                 r"\n"
                  r"Fatal Python error: bad trailing pad byte")
         regex = regex.format(ptr=self.PTR_REGEX)
         regex = re.compile(regex, flags=re.DOTALL)
@@ -500,6 +502,8 @@ def test_api_misuse(self):
                  r"    The block was made by call #[0-9]+ to debug malloc/realloc.\n"
                  r"    Data at p: cb cb cb .*\n"
                  r"\n"
+                 r"Enable tracemalloc to get the memory block allocation traceback\n"
+                 r"\n"
                  r"Fatal Python error: bad ID: Allocated using API 'm', verified using API 'r'\n")
         regex = regex.format(ptr=self.PTR_REGEX)
         self.assertRegex(out, regex)
diff --git a/Modules/_tracemalloc.c b/Modules/_tracemalloc.c
index 1005f2ea4d87..c5d5671032eb 100644
--- a/Modules/_tracemalloc.c
+++ b/Modules/_tracemalloc.c
@@ -1471,6 +1471,12 @@ _PyMem_DumpTraceback(int fd, const void *ptr)
     traceback_t *traceback;
     int i;
 
+    if (!_Py_tracemalloc_config.tracing) {
+        PUTS(fd, "Enable tracemalloc to get the memory block "
+                 "allocation traceback\n\n");
+        return;
+    }
+
     traceback = tracemalloc_get_traceback(DEFAULT_DOMAIN, (uintptr_t)ptr);
     if (traceback == NULL)
         return;