Prevent deadlocks in `ctypes.util.dllist()` on Linux (and maybe other Unices)
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 35.9k
- PR 合并指标
- PR 指标待抓取
描述
On Linux, ctypes.util.dllist() uses dl_iterate_phdr, which due to the way it works is prone to deadlocks when used from Python. It would be good if Python guaranteed that this form of deadlock won't happen. Update: See reproducer below, in the comments.
This is relevant to threadpoolctl (183 million PyPI downloads last month), which has started to use ctypes.util.dlllist() in its latest release, and in an ideal world would only rely on it once Python 3.14 is the oldest supported release.
Background: A real deadlock bug involving dl_iterate_phdr I encountered in the real world
In older releases, threadpoolctl would use dl_iterate_phdr itself (using ctypes). Importantly, this C API uses callbacks, and so threadpoolctl had the callbacks call back into Python.
Meanwhile, NumPy on Linux also calls dl_iterate_phdr indirectly (via backtrace API on Linux, some sort of temporary array optimization). NumPy holds the GIL while doing so (I will file an issue about that too).
threadpoolctl is very often used together with NumPy, so now that threading is becoming more commonly used, this interaction is a likely scenario. And presumably other libraries use dl_iterate_phdr, either directly, or indirectly as NumPy does.
So here's the scenario:
- Thread A is calling
dl_iterate_phdrviathreadpoolctl. - Thread B is calling
dl_iterate_phdrvia NumPy.
The following sequence of events can happen:
- Thread A calls
dl_iterate_phdr. This acquires an internal lock inside thedlsystem; we'll call this DL-LOCK. - Thread A calls into Python, and the GIL gets released inside that callback.
- Thread B gets scheduled, it holds the GIL.
- Thread B calls
dl_iterate_phdr, which tries to acquireDL-LOCK... but it's held by thread A. Meanwhile, thread A is waiting for the GIL, which is held by thread B.
At this point the program is deadlocked, and no Python thread will ever run again.
ctypes.util.dllist() in CPython seems potentially vulnerable to this deadlock
Looking at the relevant code in CPython, the same deadlock could happen if PyUnicode_DecodeFSDefault or PyList_Append release the GIL.
The former at least ends up dealing with the whole codec lookup system, plus some specific filesystem encoding infrastructure, so what it does is pretty complex. It might release the GIL, or it might not. And it might potentially change to not be OK in future versions.
The solution
When using dl_iterate_phdr, dllist() should have as part of its contract that the GIL can't be released and reacquired while calling dl_iterate_phdr.
More concretely:
- Not call into Python at all in the
dl_iterate_phdrcallback. Instead, accumulate the paths in pure C data structures, and then do the Python transformation oncedl_iterate_phdris done. - Since
dl_iterate_phdris acquiring an external non-Python lock, it should also be wrapped withPy_BEGIN_ALLOW_THREADS.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 Modules/_ctypes/callproc.c 中链接的 dllist() 实现开始,然后阅读 dl_iterate_phdr 的契约以及注释中引用的复现程序。确保在库迭代处于活动状态时 callback 不会调用 Python,并验证所报告的 GIL/DL-LOCK 死锁场景已不再可能发生。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- c, linux, python
- 领域
- backend, operating-systems
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 活跃
- 描述清晰度
- 基本清楚
- 新手友好度
- 48/100