Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-44895: Introduce PYTHONDUMPREFSFILE variable for refcount dumping (GH-27767)

This commit is contained in:
Dong-hee Na 2021-08-17 15:52:50 +00:00 committed by GitHub
parent 96346cb6d0
commit c2c857b40f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Doc/using/cmdline.rst
View File

@ -975,3 +975,12 @@ Debug-mode variables
shutting down the interpreter.
Need Python configured with the :option:`--with-trace-refs` build option.
.. envvar:: PYTHONDUMPREFSFILE=FILENAME
If set, Python will dump objects and reference counts still alive
after shutting down the interpreter into a file called *FILENAME*.
Need Python configured with the :option:`--with-trace-refs` build option.
.. versionadded:: 3.11

1
Include/cpython/initconfig.h
View File

@ -143,6 +143,7 @@ typedef struct PyConfig {
int no_debug_ranges;
int show_ref_count;
int dump_refs;
wchar_t *dump_refs_file;
int malloc_stats;
wchar_t *filesystem_encoding;
wchar_t *filesystem_errors;

2
Misc/NEWS.d/next/Core and Builtins/2021-08-14-20-13-21.bpo-44895.Ic9m90.rst Normal file
View File

@ -0,0 +1,2 @@
A debug variable :envvar:`PYTHONDUMPREFSFILE` is added for creating a dump file
which is generated by :option:`--with-trace-refs`. Patch by Dong-hee Na.

9
Python/initconfig.c
View File

@ -898,6 +898,7 @@ _PyConfig_Copy(PyConfig *config, const PyConfig *config2)
COPY_ATTR(no_debug_ranges);
COPY_ATTR(show_ref_count);
COPY_ATTR(dump_refs);
COPY_ATTR(dump_refs_file);
COPY_ATTR(malloc_stats);
COPY_WSTR_ATTR(pycache_prefix);
@ -1701,6 +1702,14 @@ config_read_env_vars(PyConfig *config)
config->malloc_stats = 1;
}
if (config->dump_refs_file == NULL) {
status = CONFIG_GET_ENV_DUP(config, &config->dump_refs_file,
L"PYTHONDUMPREFSFILE", "PYTHONDUMPREFSFILE");
if (_PyStatus_EXCEPTION(status)) {
return status;
}
}
if (config->pythonpath_env == NULL) {
status = CONFIG_GET_ENV_DUP(config, &config->pythonpath_env,
L"PYTHONPATH", "PYTHONPATH");

20
Python/pylifecycle.c
View File

@ -1737,6 +1737,7 @@ Py_FinalizeEx(void)
#endif
#ifdef Py_TRACE_REFS
int dump_refs = tstate->interp->config.dump_refs;
wchar_t *dump_refs_file = tstate->interp->config.dump_refs_file;
#endif
#ifdef WITH_PYMALLOC
int malloc_stats = tstate->interp->config.malloc_stats;
@ -1835,9 +1836,22 @@ Py_FinalizeEx(void)
* Alas, a lot of stuff may still be alive now that will be cleaned
* up later.
*/
FILE *dump_refs_fp = NULL;
if (dump_refs_file != NULL) {
dump_refs_fp = _Py_wfopen(dump_refs_file, L"w");
if (dump_refs_fp == NULL) {
fprintf(stderr, "PYTHONDUMPREFSFILE: cannot create file: %ls\n", dump_refs_file);
}
}
if (dump_refs) {
_Py_PrintReferences(stderr);
}
if (dump_refs_fp != NULL) {
_Py_PrintReferences(dump_refs_fp);
}
#endif /* Py_TRACE_REFS */
finalize_interp_clear(tstate);
@ -1848,9 +1862,15 @@ Py_FinalizeEx(void)
* An address can be used to find the repr of the object, printed
* above by _Py_PrintReferences.
*/
if (dump_refs) {
_Py_PrintReferenceAddresses(stderr);
}
if (dump_refs_fp != NULL) {
_Py_PrintReferenceAddresses(dump_refs_fp);
fclose(dump_refs_fp);
}
#endif /* Py_TRACE_REFS */
#ifdef WITH_PYMALLOC
if (malloc_stats) {