Skip to content

gh-131238: Move _Py_VISIT_STACKREF() to pycore_stackref.h #131560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 21, 2025

Conversation

vstinner
Copy link
Member

@vstinner vstinner commented Mar 21, 2025

  • Move _Py_VISIT_STACKREF() from pycore_gc.h to pycore_stackref.h.
  • Remove pycore_interpframe.h include from pycore_genobject.h.
  • Remove now useless includes from C files.
  • Add pycore_interpframe_structs.h to Makefile.pre.in and pythoncore.vcxproj.

* Move _Py_VISIT_STACKREF() from pycore_gc.h to pycore_stackref.h.
* Remove pycore_interpframe.h include from pycore_genobject.h.
* Remove now useless includes from C files.
* Add pycore_interpframe_structs.h to Makefile.pre.in and
  pythoncore.vcxproj.
@vstinner vstinner requested review from a team and erlend-aasland as code owners March 21, 2025 17:45
#define _Py_VISIT_STACKREF(ref) \
do { \
if (!PyStackRef_IsNull(ref)) { \
int vret = _PyGC_VisitStackRef(&(ref), visit, arg); \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This depends on _PyGC_VisitStackRef, which is in pycore_gc.h.

What's the motivation for moving the macro here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pycore_stackref.h depends on pycore_object.h which depends on pycore_gc.h.

_Py_VISIT_STACKREF() (currently defined in pycore_gc.h) uses PyStackRef_IsNull() which is defined in pycore_stackref.h.

Problem: If dependencies are made explicit (that's part of my work), pycore_gc.h should depend on pycore_stackref.h which creates a dependency cycle!

Moving _Py_VISIT_STACKREF() to pycore_stackref.h breaks this cycle.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previously, using _Py_VISIT_STACKREF() without including pycore_stackref.h worked thanks to luck and the fact that including one header pulled dozens of other headers. With my work on reducing dependencies, this luck is gone, and dependencies must be written explicitly.

@vstinner vstinner merged commit 7101cba into python:main Mar 21, 2025
41 checks passed
@vstinner vstinner deleted the visit_stackref branch March 21, 2025 22:24
seehwan pushed a commit to seehwan/cpython that referenced this pull request Apr 16, 2025
…on#131560)

* Move _Py_VISIT_STACKREF() from pycore_gc.h to pycore_stackref.h.
* Remove pycore_interpframe.h include from pycore_genobject.h.
* Remove now useless includes from C files.
* Add pycore_interpframe_structs.h to Makefile.pre.in and
  pythoncore.vcxproj.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants