Data race on the GC debug flag (gc.set_debug/get_debug) in free-threading builds
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 35.9k
- PR マージ指標
- PR 指標を取得中
説明
Bug report
In a free-threading build (--disable-gil), the garbage collector debug flag
gcstate->debug is read and written without synchronisation:
- Write:
gc_set_debug_impl()(Modules/gcmodule.c) does a plain
gcstate->debug = flags. Unlikegc_set_threshold_impl(), which runs its
free-threading branch under_PyEval_StopTheWorld(),gc.set_debug()takes
no lock and does not stop the world. - Read:
gc_get_debug_impl()returnsgcstate->debugdirectly, and the
collector inPython/gc_free_threading.creadsgcstate->debug/
interp->gc.debugin several places while walking the graph.
So one thread calling gc.set_debug() concurrently with another calling
gc.get_debug() or triggering a collection is an unsynchronised read/write of
the same int. The flag is only an int, so the effect stays benign at the
Python level, but it is undefined behaviour under C11 and ThreadSanitizer
reports it as a data race.
This is the same class of issue already fixed for sys dlopenflags
(gh-151644) and gc.get_stats() (gh-151646). gc.enable() / gc.disable()
in the same file already access gcstate->enabled atomically; the debug flag
was missed.
ThreadSanitizer output
Built with ./configure --with-thread-sanitizer --disable-gil and stressed
with concurrent gc.set_debug() / gc.get_debug() plus a thread churning
cyclic garbage so the collector runs:
WARNING: ThreadSanitizer: data race
Write of size 4 at 0x...6c by thread T2:
#0 gc_set_debug gcmodule.c.h:186
Previous write of size 4 at 0x...6c by thread T1:
#0 gc_set_debug gcmodule.c.h:186
Location is global '_PyRuntime'
How to reproduce
./configure --with-thread-sanitizer --disable-gil && make- Run a script that starts a few threads calling
gc.set_debug(...)/
gc.get_debug()in a loop, plus a thread that builds reference cycles and
callsgc.collect(). - TSan reports the write/write race on
gcstate->debug.
Suggested fix
Access the flag with FT_ATOMIC_STORE_INT_RELAXED / FT_ATOMIC_LOAD_INT_RELAXED
in gc_set_debug_impl() / gc_get_debug_impl() and in the collector reads,
matching how gcstate->enabled and dlopenflags are already handled. Relaxed
ordering is correct for an independent int flag. These wrappers compile to a
plain load/store in the default (GIL) build, so there is no change there.
Linked PRs
- gh-153015
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まずリンクされている PR gh-153015 を確認し、その後 Modules/gcmodule.c の gc_set_debug_impl() と gc_get_debug_impl()、および Python/gc_free_threading.c の gcstate-debug の読み取りを調査します。--with-thread-sanitizer --disable-gil を指定して再ビルドし、gc.set_debug()、gc.get_debug()、コレクションを同時に実行する再現プログラムを実行します。報告された race が発生しなくなれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- c, python
- 領域
- backend
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 25/100