Skip to content

Specialize Py_DECREF() for Py_REF_DEBUG #16781

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

Closed
wants to merge 1 commit into from
Closed

Specialize Py_DECREF() for Py_REF_DEBUG #16781

wants to merge 1 commit into from

Conversation

vstinner
Copy link
Member

Simplify Py_DECREF() code for release mode: don't pass FILE and
LINE to the static inline function.

Simplify Py_DECREF() code for release mode: don't pass __FILE__ and
__LINE__ to the static inline function.
@vstinner
Copy link
Member Author

In Python 3.7, Py_DECREF() was a macro. I converted it to a static inline function in PR #10079 of https://bugs.python.org/issue35059 The new static inline function always require filename and lineno arguments, even in release mode. I'm not sure that all compilers are smart enough to remove the arguments, so I prefer to help compilers to ensure that the emited machine code is as efficient as Python 3.7.

@serhiy-storchaka
Copy link
Member

Why so complicated? Why not use just macros?

@vstinner
Copy link
Member Author

vstinner commented Oct 14, 2019

Why so complicated? Why not use just macros?

Oh, see https://bugs.python.org/issue35059#msg328367 for the rationale.

_Py_NegativeRefcount(filename, lineno, op);
}
#endif
_Py_RefTotal--;
Copy link
Member

Choose a reason for hiding this comment

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

So this _Py_DEC_REFTOTAL would be converted in your plan?

Copy link
Member Author

Choose a reason for hiding this comment

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

_Py_DEC_REFTOTAL = _Py_RefTotal-- when Py_REF_DEBUG is defined. I prefer to put directly the real code, it may help debugging. It avoids the indirection of the preprocessor.

@ghost
Copy link

ghost commented Oct 18, 2019

I'm not sure that all compilers are smart enough to remove the arguments

I tested almost all versions of gcc/clang/msvc/icc:
https://godbolt.org/z/w-N-Kt

All versions have the same behavior:
If with -O1 option, compilers are smart enough to remove the arguments.
If without any option, the extra machine code was emited.

@vstinner
Copy link
Member Author

Why not use just macros?

Static inline functions have multiple benefits over macros. Let me give you one example.

Today we get a bug report on Fedora on Python 3.8 which uses static inline functions rather than macros. Thanks to that, the line number in the gdb traceback was more accurate and so more usefull. (Sadly, the bug report is private because it's an automated crash report and it might contain sensitive information, so I cannot share it.)

#endif
_Py_RefTotal--;
if (--op->ob_refcnt == 0) {
_Py_Dealloc(op);
Copy link
Member

Choose a reason for hiding this comment

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

This code dupe irks me. Can't you make the REF_DEBUG version call the regular version instead?

@vstinner
Copy link
Member Author

vstinner commented Jan 6, 2020

This code dupe irks me. Can't you make the REF_DEBUG version call the regular version instead?

_Py_DECREF() function cannot use __FILE__ and __LINE__ preprocessor magic macros. Only a macro can use them.

I wrote PR #17870 to avoid duplicated code and avoid passing __FILE__ and __LINE__ in release mode (when Py_REF_DEBUG is not set).

@vstinner
Copy link
Member Author

I merged PR #17870 instead, commit f3a0a6b.

@vstinner vstinner closed this Jan 25, 2020
@vstinner vstinner deleted the decref branch January 25, 2020 11:49
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.

6 participants