Skip to content
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

gh-112367: Only free perf trampoline arenas at shutdown #112368

Merged
merged 1 commit into from
Dec 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions Include/internal/pycore_ceval.h
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ extern int _PyPerfTrampoline_SetCallbacks(_PyPerf_Callbacks *);
extern void _PyPerfTrampoline_GetCallbacks(_PyPerf_Callbacks *);
extern int _PyPerfTrampoline_Init(int activate);
extern int _PyPerfTrampoline_Fini(void);
extern void _PyPerfTrampoline_FreeArenas(void);
extern int _PyIsPerfTrampolineActive(void);
extern PyStatus _PyPerfTrampoline_AfterFork_Child(void);
#ifdef PY_HAVE_PERF_TRAMPOLINE
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Avoid undefined behaviour when using the perf trampolines by not freeing the
code arenas until shutdown. Patch by Pablo Galindo
40 changes: 35 additions & 5 deletions Python/perf_trampoline.c
Original file line number Diff line number Diff line change
Expand Up @@ -216,10 +216,24 @@ perf_map_write_entry(void *state, const void *code_addr,
PyMem_RawFree(perf_map_entry);
}

static void*
perf_map_init_state(void)
{
PyUnstable_PerfMapState_Init();
return NULL;
}

static int
perf_map_free_state(void *state)
{
PyUnstable_PerfMapState_Fini();
return 0;
}

_PyPerf_Callbacks _Py_perfmap_callbacks = {
NULL,
&perf_map_init_state,
&perf_map_write_entry,
NULL,
&perf_map_free_state,
};

static int
Expand Down Expand Up @@ -415,7 +429,6 @@ _PyPerfTrampoline_SetCallbacks(_PyPerf_Callbacks *callbacks)
trampoline_api.write_state = callbacks->write_state;
trampoline_api.free_state = callbacks->free_state;
trampoline_api.state = NULL;
perf_status = PERF_STATUS_OK;
#endif
return 0;
}
Expand All @@ -434,6 +447,7 @@ _PyPerfTrampoline_Init(int activate)
}
if (!activate) {
tstate->interp->eval_frame = NULL;
perf_status = PERF_STATUS_NO_INIT;
}
else {
tstate->interp->eval_frame = py_trampoline_evaluator;
Expand All @@ -444,6 +458,9 @@ _PyPerfTrampoline_Init(int activate)
if (extra_code_index == -1) {
return -1;
}
if (trampoline_api.state == NULL && trampoline_api.init_state != NULL) {
trampoline_api.state = trampoline_api.init_state();
}
perf_status = PERF_STATUS_OK;
}
#endif
Expand All @@ -454,16 +471,29 @@ int
_PyPerfTrampoline_Fini(void)
{
#ifdef PY_HAVE_PERF_TRAMPOLINE
if (perf_status != PERF_STATUS_OK) {
return 0;
}
PyThreadState *tstate = _PyThreadState_GET();
if (tstate->interp->eval_frame == py_trampoline_evaluator) {
tstate->interp->eval_frame = NULL;
}
free_code_arenas();
if (perf_status == PERF_STATUS_OK) {
trampoline_api.free_state(trampoline_api.state);
}
extra_code_index = -1;
perf_status = PERF_STATUS_NO_INIT;
#endif
return 0;
}

void _PyPerfTrampoline_FreeArenas(void) {
#ifdef PY_HAVE_PERF_TRAMPOLINE
free_code_arenas();
#endif
return;
}

int
PyUnstable_PerfTrampoline_SetPersistAfterFork(int enable){
#ifdef PY_HAVE_PERF_TRAMPOLINE
Expand All @@ -477,8 +507,8 @@ PyStatus
_PyPerfTrampoline_AfterFork_Child(void)
{
#ifdef PY_HAVE_PERF_TRAMPOLINE
PyUnstable_PerfMapState_Fini();
if (persist_after_fork) {
_PyPerfTrampoline_Fini();
char filename[256];
pid_t parent_pid = getppid();
snprintf(filename, sizeof(filename), "/tmp/perf-%d.map", parent_pid);
Expand Down
2 changes: 1 addition & 1 deletion Python/pylifecycle.c
Original file line number Diff line number Diff line change
Expand Up @@ -1797,6 +1797,7 @@ finalize_interp_clear(PyThreadState *tstate)
_PyArg_Fini();
_Py_ClearFileSystemEncoding();
_PyPerfTrampoline_Fini();
_PyPerfTrampoline_FreeArenas();
}

finalize_interp_types(tstate->interp);
Expand Down Expand Up @@ -1854,7 +1855,6 @@ Py_FinalizeEx(void)
*/

_PyAtExit_Call(tstate->interp);
PyUnstable_PerfMapState_Fini();

/* Copy the core config, PyInterpreterState_Delete() free
the core config memory */
Expand Down