gh-120642: Move private PyCode APIs to the internal C API #120643

vstinner · 2024-06-17T14:18:51Z

Move _Py_BackoffCounter to pycore_backoff.h.
Move _Py_CODEUNIT and related functions to pycore_code.h.
Move Include/cpython/optimizer.h content to pycore_optimizer.h.
Remove Include/cpython/optimizer.h.

Issue: [C API] Move private PyCode and PyOptimizer API to the internal C API #120642

* Move _Py_BackoffCounter to pycore_backoff.h. * Move _Py_CODEUNIT and related functions to pycore_code.h. * Move Include/cpython/optimizer.h content to pycore_optimizer.h. * Remove Include/cpython/optimizer.h.

vstinner · 2024-06-17T14:20:36Z

@markshannon @iritkatriel @encukou: What do you think of this change?

The main effect is that 6 PyUnstable optimizer functions are moved to the internal C API (pycore_optimizer.h):

PyUnstable_Replace_Executor()
PyUnstable_SetOptimizer()
PyUnstable_GetOptimizer()
PyUnstable_GetExecutor()
PyUnstable_Optimizer_NewCounter()
PyUnstable_Optimizer_NewUOpOptimizer()

An alternative is to modify structures to add names to unions and structures, and then modify functions using it.

zooba · 2024-06-17T14:49:44Z

We already went through and added union names to some of these, but I guess whichever developer keeps adding them didn't notice.

Looking at the number of CI failures, possibly adding the names is going to be less disruptive! 😆

vstinner · 2024-06-17T15:14:43Z

Looking at the number of CI failures, possibly adding the names is going to be less disruptive! 😆

I just forgot to push a local change, I'm ashamed :-(

vstinner · 2024-06-17T15:15:46Z

We already went through and added union names to some of these, but I guess whichever developer keeps adding them didn't notice.

test_cext and test_cppext are supposed to catch such issue, but we don't suppot "strict ISO C99" for now.

We can update these tests once a decision will be taken: capi-workgroup/decisions#30

Include/Python.h

Remove PyUnstable_Replace_Executor(). Rename functions: * PyUnstable_GetExecutor() => _Py_GetExecutor() * PyUnstable_GetOptimizer() => _Py_GetOptimizer() * PyUnstable_SetOptimizer() => _Py_SetOptimizerAPI() * PyUnstable_Optimizer_NewCounter() => _PyOptimizer_NewCounter() * PyUnstable_Optimizer_NewUOpOptimizer() => _PyOptimizer_NewUOpOptimizer()

vstinner · 2024-06-20T09:58:34Z

If possible, I would like to backport this change to 3.13 to solve a C99 compatibility issue in the Python C API.

Include/cpython/code.h

Yhg1s · 2024-06-26T09:44:41Z

Since this is removing (unstable) C API functions added in 3.13 that everyone agrees we should remove, we should backport this to 3.13, yes.

markshannon · 2024-06-26T09:44:22Z

Python/optimizer.c

@@ -195,7 +182,7 @@ _Py_SetOptimizer(PyInterpreterState *interp, _PyOptimizerObject *optimizer)
 }

 int
-PyUnstable_SetOptimizer(_PyOptimizerObject *optimizer)
+_Py_SetOptimizerAPI(_PyOptimizerObject *optimizer)


Why the API suffix?
Maybe Py_SetTier2Optimizer (to distinguish it from the AST, bytecode or tier 1 optimizers)

There is another _Py_SetOptimizer() function with a different API. This one adds more boilerplate code and calls the first one.

I renamed the function to _Py_SetTier2Optimizer() (I added an underscore prefix).

markshannon · 2024-06-26T09:46:18Z

Include/internal/pycore_code.h

+static inline _Py_CODEUNIT
+_py_make_codeunit(uint8_t opcode, uint8_t oparg)
+{
+    // No designated initialisers because of C++ compat


This is an internal header. Why does it need to be C++ compatible?

No idea, I just moved code. For now, I prefer to leave it as it is. I can be reworked later.

miss-islington-app · 2024-06-26T11:54:07Z

Thanks @vstinner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington-app · 2024-06-26T11:54:11Z

Sorry, @vstinner, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 9e4a81f00fef689c6e18a64245aa064eaadc7ac7 3.13

…on#120643) * Move _Py_CODEUNIT and related functions to pycore_code.h. * Move _Py_BackoffCounter to pycore_backoff.h. * Move Include/cpython/optimizer.h content to pycore_optimizer.h. * Remove Include/cpython/optimizer.h. * Remove PyUnstable_Replace_Executor(). Rename functions: * PyUnstable_GetExecutor() => _Py_GetExecutor() * PyUnstable_GetOptimizer() => _Py_GetOptimizer() * PyUnstable_SetOptimizer() => _Py_SetTier2Optimizer() * PyUnstable_Optimizer_NewCounter() => _PyOptimizer_NewCounter() * PyUnstable_Optimizer_NewUOpOptimizer() => _PyOptimizer_NewUOpOptimizer() (cherry picked from commit 9e4a81f)

bedevere-app · 2024-06-26T12:05:36Z

GH-121043 is a backport of this pull request to the 3.13 branch.

…0643) (#121043) gh-120642: Move private PyCode APIs to the internal C API (#120643) * Move _Py_CODEUNIT and related functions to pycore_code.h. * Move _Py_BackoffCounter to pycore_backoff.h. * Move Include/cpython/optimizer.h content to pycore_optimizer.h. * Remove Include/cpython/optimizer.h. * Remove PyUnstable_Replace_Executor(). Rename functions: * PyUnstable_GetExecutor() => _Py_GetExecutor() * PyUnstable_GetOptimizer() => _Py_GetOptimizer() * PyUnstable_SetOptimizer() => _Py_SetTier2Optimizer() * PyUnstable_Optimizer_NewCounter() => _PyOptimizer_NewCounter() * PyUnstable_Optimizer_NewUOpOptimizer() => _PyOptimizer_NewUOpOptimizer() (cherry picked from commit 9e4a81f)

…on#120643) * Move _Py_CODEUNIT and related functions to pycore_code.h. * Move _Py_BackoffCounter to pycore_backoff.h. * Move Include/cpython/optimizer.h content to pycore_optimizer.h. * Remove Include/cpython/optimizer.h. * Remove PyUnstable_Replace_Executor(). Rename functions: * PyUnstable_GetExecutor() => _Py_GetExecutor() * PyUnstable_GetOptimizer() => _Py_GetOptimizer() * PyUnstable_SetOptimizer() => _Py_SetTier2Optimizer() * PyUnstable_Optimizer_NewCounter() => _PyOptimizer_NewCounter() * PyUnstable_Optimizer_NewUOpOptimizer() => _PyOptimizer_NewUOpOptimizer()

gvanrossum · 2024-07-11T20:47:45Z

FYI there are two mention of _PyCode_CODE left in Include/cpython/code.h:

#define _PyCode_CODE(CO) _Py_RVALUE((_Py_CODEUNIT *)(CO)->co_code_adaptive)
#define _PyCode_NBYTES(CO) (Py_SIZE(CO) * (Py_ssize_t)sizeof(_Py_CODEUNIT))

This seems out of place, since those macros cannot work unless one also includes pycore_code.h.

vstinner · 2024-07-12T11:17:32Z

FYI there are two mention of _PyCode_CODE left in Include/cpython/code.h

Oh correct, I wrote PR gh-121644 to move these 2 macros to internal C API.

…on#120643) * Move _Py_CODEUNIT and related functions to pycore_code.h. * Move _Py_BackoffCounter to pycore_backoff.h. * Move Include/cpython/optimizer.h content to pycore_optimizer.h. * Remove Include/cpython/optimizer.h. * Remove PyUnstable_Replace_Executor(). Rename functions: * PyUnstable_GetExecutor() => _Py_GetExecutor() * PyUnstable_GetOptimizer() => _Py_GetOptimizer() * PyUnstable_SetOptimizer() => _Py_SetTier2Optimizer() * PyUnstable_Optimizer_NewCounter() => _PyOptimizer_NewCounter() * PyUnstable_Optimizer_NewUOpOptimizer() => _PyOptimizer_NewUOpOptimizer()

pythongh-120642: Move private PyCode APIs to the internal C API

118f88f

* Move _Py_BackoffCounter to pycore_backoff.h. * Move _Py_CODEUNIT and related functions to pycore_code.h. * Move Include/cpython/optimizer.h content to pycore_optimizer.h. * Remove Include/cpython/optimizer.h.

vstinner requested review from a team, ericsnowcurrently and erlend-aasland as code owners June 17, 2024 14:18

bedevere-app bot mentioned this pull request Jun 17, 2024

[C API] Move private PyCode and PyOptimizer API to the internal C API #120642

Closed

bedevere-app bot added the awaiting core review label Jun 17, 2024

vstinner added the skip news label Jun 17, 2024

Update Python/pylifecycle.c

7e4f175

vstinner mentioned this pull request Jun 17, 2024

C standard for public headers capi-workgroup/decisions#30

Open

shihai1991 reviewed Jun 19, 2024

View reviewed changes

Include/Python.h Show resolved Hide resolved

Add NEWS entry

711cdc0

vstinner removed the skip news label Jun 19, 2024

vstinner requested a review from markshannon as a code owner June 20, 2024 09:46

Update code for the JIT compiler

464fc8d

vstinner requested a review from Fidget-Spinner as a code owner June 20, 2024 09:54

vstinner mentioned this pull request Jun 20, 2024

Pluggable optimizer API #104584

Open

vstinner added the needs backport to 3.13 bugs and security fixes label Jun 20, 2024

Fidget-Spinner reviewed Jun 20, 2024

View reviewed changes

Include/cpython/code.h Show resolved Hide resolved

vstinner added 2 commits June 26, 2024 11:21

Merge branch 'main' into internal_code

5588b7a

Document _Py_CODEUNIT removal

3f73bf3

vstinner force-pushed the internal_code branch from 05ae5f3 to 3f73bf3 Compare June 26, 2024 09:29

markshannon reviewed Jun 26, 2024

View reviewed changes

Rename _Py_SetOptimizerAPI() to _Py_SetTier2Optimizer().

1e8a1c0

vstinner merged commit 9e4a81f into python:main Jun 26, 2024
56 checks passed

vstinner deleted the internal_code branch June 26, 2024 11:54

bedevere-app bot removed the awaiting core review label Jun 26, 2024

miss-islington-app bot assigned vstinner Jun 26, 2024

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jun 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-120642: Move private PyCode APIs to the internal C API #120643

gh-120642: Move private PyCode APIs to the internal C API #120643

vstinner commented Jun 17, 2024 •

edited by bedevere-app bot

Loading

vstinner commented Jun 17, 2024

zooba commented Jun 17, 2024

vstinner commented Jun 17, 2024

vstinner commented Jun 17, 2024

vstinner commented Jun 20, 2024

Yhg1s commented Jun 26, 2024

markshannon Jun 26, 2024

vstinner Jun 26, 2024

vstinner Jun 26, 2024

markshannon Jun 26, 2024

vstinner Jun 26, 2024

miss-islington-app bot commented Jun 26, 2024

miss-islington-app bot commented Jun 26, 2024

bedevere-app bot commented Jun 26, 2024

gvanrossum commented Jul 11, 2024

vstinner commented Jul 12, 2024

gh-120642: Move private PyCode APIs to the internal C API #120643

gh-120642: Move private PyCode APIs to the internal C API #120643

Conversation

vstinner commented Jun 17, 2024 • edited by bedevere-app bot Loading

vstinner commented Jun 17, 2024

zooba commented Jun 17, 2024

vstinner commented Jun 17, 2024

vstinner commented Jun 17, 2024

vstinner commented Jun 20, 2024

Yhg1s commented Jun 26, 2024

markshannon Jun 26, 2024

Choose a reason for hiding this comment

vstinner Jun 26, 2024

Choose a reason for hiding this comment

vstinner Jun 26, 2024

Choose a reason for hiding this comment

markshannon Jun 26, 2024

Choose a reason for hiding this comment

vstinner Jun 26, 2024

Choose a reason for hiding this comment

miss-islington-app bot commented Jun 26, 2024

miss-islington-app bot commented Jun 26, 2024

bedevere-app bot commented Jun 26, 2024

gvanrossum commented Jul 11, 2024

vstinner commented Jul 12, 2024

vstinner commented Jun 17, 2024 •

edited by bedevere-app bot

Loading