python / python/cpython

Structseq objects created with PyStructSequence_New() are not tracked by the GC

Aperta
#157,443 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

3.13 3.14 3.15 3.16 interpreter-core type-bug
Lingua principale
Python
Stelle
77.2k
Fork
35.9k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Bug report

PyStructSequence_New() allocates the object with PyObject_GC_NewVar() but never calls PyObject_GC_Track(). Only structseq_new_impl() (calling the type from Python) and __replace__() track the result (bpo-37126, gh-145376). All 45 C callers of PyStructSequence_New() in the tree, including make_unraisable_hook_args() in Python/errors.c, produce objects which the GC never sees, so a reference cycle through them is never collected.

Most structseq objects hold only ints and strings, but sys.UnraisableHookArgs holds the exception and its traceback, which keeps the frames alive (the current frame, when the exception has no traceback, format_unraisable_v() synthesizes one from it). Storing the hook argument in something reachable from those frames creates an uncollectable cycle:

import gc
import sys
import weakref

class Holder:
    pass

def f():
    holder = Holder()
    def hook(unraisable):
        holder.unraisable = unraisable
    sys.unraisablehook = hook
    class C:
        def __del__(self):
            raise ValueError
    C()
    print(gc.is_tracked(holder.unraisable))
    return weakref.ref(holder)

wr = f()
sys.unraisablehook = sys.__unraisablehook__
gc.collect()
print(wr())

Output (3.13 and main):

False
<__main__.Holder object at 0x7a7fda9d22c0>

Expected: True and None.

test.support.catch_unraisable_exception() works around this by deleting its unraisable attribute on exit (bpo-37261). I hit it in test_class.test_detach_materialized_dict_no_memory(), which leaks about 140 references per run as soon as it keeps ex.unraisable in a local variable.

The simplest fix is to call _PyObject_GC_TRACK() in PyStructSequence_New(), as PyTuple_New() does, and drop the explicit calls in structseq_new_impl() and structseq_replace(). Py_VISIT() handles the NULL items of a partially filled object.

Linked PRs
  • gh-157447

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia in Python/errors.c, da make_unraisable_hook_args(), quindi esamina PyStructSequence_New() e i chiamanti di structseq_new_impl() e structseq_replace() descritti nel report. Esegui test_class.test_detach_materialized_dict_no_memory() e riproduci l’esempio di gc.is_tracked(). Il lavoro è completato quando gli oggetti structseq creati tramite la C API sono tracciati e il ciclo di riferimenti dimostrato viene raccolto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
c, python
Ambito
backend
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.