Skip to content

[3.13] gh-141004: Document unstable perf map functions in ceval.h (GH-143492) #153996

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.

Sign up for GitHub

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
ZeroIntensity merged 1 commit into from
Jul 18, 2026
+47 −14
Merged

[3.13] gh-141004: Document unstable perf map functions in ceval.h (GH-143492) #153996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions Doc/c-api/perfmaps.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,43 @@ Note that holding the Global Interpreter Lock (GIL) is not required for these AP
This is called by the runtime itself during interpreter shut-down. In
general, there shouldn't be a reason to explicitly call this, except to
handle specific scenarios such as forking.

.. c:function:: int PyUnstable_CopyPerfMapFile(const char *parent_filename)

Open the ``/tmp/perf-$pid.map`` file and append the content of *parent_filename*
to it.

This function is available on all platforms but only generates output on platforms
that support perf maps (currently only Linux). On other platforms, it does nothing.

.. versionadded:: 3.13

.. c:function:: int PyUnstable_PerfTrampoline_CompileCode(PyCodeObject *code)

Compile the given code object using the current perf trampoline.

The "current" trampoline is the one set by the runtime or the most recent
:c:func:`PyUnstable_PerfTrampoline_SetPersistAfterFork` call.

If no trampoline is set, falls back to normal compilation (no perf map entry).

:param code: The code object to compile.
:return: 0 on success, -1 on failure.

.. versionadded:: 3.13

.. c:function:: int PyUnstable_PerfTrampoline_SetPersistAfterFork(int enable)

Set whether the perf trampoline should persist after a fork.

* If ``enable`` is true (non-zero): perf map file remains open/valid post-fork.
Child process inherits all existing perf map entries.
* If ``enable`` is false (zero): perf map closes post-fork.
Child process gets empty perf map.

Default: false (clears on fork).

:param enable: 1 to enable, 0 to disable.
:return: 0 on success, -1 on failure.

.. versionadded:: 3.13
21 changes: 7 additions & 14 deletions Tools/check-c-api-docs/ignored_c_api.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,6 @@ PyWrapperFlag_KEYWORDS
PyFile_NewStdPrinter
PyStdPrinter_Type
Py_UniversalNewlineFgets
# cpython/setobject.h
PySet_MINSIZE
# cpython/ceval.h
PyUnstable_CopyPerfMapFile
PyUnstable_PerfTrampoline_CompileCode
PyUnstable_PerfTrampoline_SetPersistAfterFork
# cpython/genobject.h
PyAsyncGenASend_CheckExact
# cpython/longintrepr.h
PyLong_BASE
PyLong_MASK
PyLong_SHIFT
# cpython/pyerrors.h
PyException_HEAD
# cpython/pyframe.h
PyUnstable_EXECUTABLE_KINDS
PyUnstable_EXECUTABLE_KIND_BUILTIN_FUNCTION
Expand Down Expand Up @@ -142,3 +128,10 @@ PyUnicode_IS_READY
PYTHON_ABI_VERSION
PySequence_In
PYOS_STACK_MARGIN
# Soft-deprecated in 3.14; will remain undocumented in 3.13
PySet_MINSIZE
PyAsyncGenASend_CheckExact
PyLong_BASE
PyLong_MASK
PyLong_SHIFT
PyException_HEAD
Loading