python / python/cpython

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

Ouverte
#157,443 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

3.13 3.14 3.15 3.16 interpreter-core type-bug
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez dans Python/errors.c, au niveau de make_unraisable_hook_args(), puis examinez PyStructSequence_New() ainsi que les appelants de structseq_new_impl() et structseq_replace() décrits dans le rapport. Exécutez test_class.test_detach_materialized_dict_no_memory() et reproduisez l’exemple de gc.is_tracked(). Le travail est terminé lorsque les objets structseq créés via la C API sont suivis et que le cycle de références démontré est collecté.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
c, python
Domaine
backend
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.