mirror of
https://github.com/python/cpython.git
synced 2025-11-01 14:11:41 +00:00
[3.13] gh-137400: Fix thread-safety issues when profiling all threads (gh-137518) (gh-137733)
There were a few thread-safety issues when profiling or tracing all
threads via PyEval_SetProfileAllThreads or PyEval_SetTraceAllThreads:
* The loop over thread states could crash if a thread exits concurrently
(in both the free threading and default build)
* The modification of `c_profilefunc` and `c_tracefunc` wasn't
thread-safe on the free threading build.
(cherry picked from commit a10152f8fd)
This commit is contained in:
parent
f6186a3709
commit
16d2e97cf3
12 changed files with 29814 additions and 29714 deletions
File diff suppressed because it is too large
Load diff
|
|
@ -19,8 +19,10 @@ struct _ceval_runtime_state;
|
||||||
|
|
||||||
// Export for '_lsprof' shared extension
|
// Export for '_lsprof' shared extension
|
||||||
PyAPI_FUNC(int) _PyEval_SetProfile(PyThreadState *tstate, Py_tracefunc func, PyObject *arg);
|
PyAPI_FUNC(int) _PyEval_SetProfile(PyThreadState *tstate, Py_tracefunc func, PyObject *arg);
|
||||||
|
extern int _PyEval_SetProfileAllThreads(PyInterpreterState *interp, Py_tracefunc func, PyObject *arg);
|
||||||
|
|
||||||
extern int _PyEval_SetTrace(PyThreadState *tstate, Py_tracefunc func, PyObject *arg);
|
extern int _PyEval_SetTrace(PyThreadState *tstate, Py_tracefunc func, PyObject *arg);
|
||||||
|
extern int _PyEval_SetTraceAllThreads(PyInterpreterState *interp, Py_tracefunc func, PyObject *arg);
|
||||||
|
|
||||||
extern int _PyEval_SetOpcodeTrace(PyFrameObject *f, bool enable);
|
extern int _PyEval_SetOpcodeTrace(PyFrameObject *f, bool enable);
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -262,8 +262,8 @@ struct _is {
|
||||||
PyDict_WatchCallback builtins_dict_watcher;
|
PyDict_WatchCallback builtins_dict_watcher;
|
||||||
|
|
||||||
_Py_GlobalMonitors monitors;
|
_Py_GlobalMonitors monitors;
|
||||||
bool sys_profile_initialized;
|
_PyOnceFlag sys_profile_once_flag;
|
||||||
bool sys_trace_initialized;
|
_PyOnceFlag sys_trace_once_flag;
|
||||||
Py_ssize_t sys_profiling_threads; /* Count of threads with c_profilefunc set */
|
Py_ssize_t sys_profiling_threads; /* Count of threads with c_profilefunc set */
|
||||||
Py_ssize_t sys_tracing_threads; /* Count of threads with c_tracefunc set */
|
Py_ssize_t sys_tracing_threads; /* Count of threads with c_tracefunc set */
|
||||||
PyObject *monitoring_callables[PY_MONITORING_TOOL_IDS][_PY_MONITORING_EVENTS];
|
PyObject *monitoring_callables[PY_MONITORING_TOOL_IDS][_PY_MONITORING_EVENTS];
|
||||||
|
|
|
||||||
|
|
@ -193,6 +193,32 @@ def during_threads(self):
|
||||||
self.set = not self.set
|
self.set = not self.set
|
||||||
|
|
||||||
|
|
||||||
|
@threading_helper.requires_working_threading()
|
||||||
|
class SetProfileAllThreadsMultiThreaded(InstrumentationMultiThreadedMixin, TestCase):
|
||||||
|
"""Uses threading.setprofile_all_threads and repeatedly toggles instrumentation on and off"""
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
self.set = False
|
||||||
|
self.called = False
|
||||||
|
|
||||||
|
def after_test(self):
|
||||||
|
self.assertTrue(self.called)
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
threading.setprofile_all_threads(None)
|
||||||
|
|
||||||
|
def trace_func(self, frame, event, arg):
|
||||||
|
self.called = True
|
||||||
|
return self.trace_func
|
||||||
|
|
||||||
|
def during_threads(self):
|
||||||
|
if self.set:
|
||||||
|
threading.setprofile_all_threads(self.trace_func)
|
||||||
|
else:
|
||||||
|
threading.setprofile_all_threads(None)
|
||||||
|
self.set = not self.set
|
||||||
|
|
||||||
|
|
||||||
@threading_helper.requires_working_threading()
|
@threading_helper.requires_working_threading()
|
||||||
class SetProfileAllMultiThreaded(TestCase):
|
class SetProfileAllMultiThreaded(TestCase):
|
||||||
def test_profile_all_threads(self):
|
def test_profile_all_threads(self):
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
Fix a crash in the :term:`free threading` build when disabling profiling or
|
||||||
|
tracing across all threads with :c:func:`PyEval_SetProfileAllThreads` or
|
||||||
|
:c:func:`PyEval_SetTraceAllThreads` or their Python equivalents
|
||||||
|
:func:`threading.settrace_all_threads` and
|
||||||
|
:func:`threading.setprofile_all_threads`.
|
||||||
|
|
@ -148,7 +148,15 @@ dummy_func(
|
||||||
|
|
||||||
tier1 inst(RESUME, (--)) {
|
tier1 inst(RESUME, (--)) {
|
||||||
assert(frame == tstate->current_frame);
|
assert(frame == tstate->current_frame);
|
||||||
if (tstate->tracing == 0) {
|
#ifdef Py_GIL_DISABLED
|
||||||
|
// For thread-safety, we need to check instrumentation version
|
||||||
|
// even when tracing. Otherwise, another thread may concurrently
|
||||||
|
// re-write the bytecode while we are executing this function.
|
||||||
|
int check_instrumentation = 1;
|
||||||
|
#else
|
||||||
|
int check_instrumentation = (tstate->tracing == 0);
|
||||||
|
#endif
|
||||||
|
if (check_instrumentation) {
|
||||||
uintptr_t global_version =
|
uintptr_t global_version =
|
||||||
_Py_atomic_load_uintptr_relaxed(&tstate->eval_breaker) &
|
_Py_atomic_load_uintptr_relaxed(&tstate->eval_breaker) &
|
||||||
~_PY_EVAL_EVENTS_MASK;
|
~_PY_EVAL_EVENTS_MASK;
|
||||||
|
|
|
||||||
|
|
@ -2338,22 +2338,11 @@ PyEval_SetProfile(Py_tracefunc func, PyObject *arg)
|
||||||
void
|
void
|
||||||
PyEval_SetProfileAllThreads(Py_tracefunc func, PyObject *arg)
|
PyEval_SetProfileAllThreads(Py_tracefunc func, PyObject *arg)
|
||||||
{
|
{
|
||||||
PyThreadState *this_tstate = _PyThreadState_GET();
|
PyInterpreterState *interp = _PyInterpreterState_GET();
|
||||||
PyInterpreterState* interp = this_tstate->interp;
|
if (_PyEval_SetProfileAllThreads(interp, func, arg) < 0) {
|
||||||
|
/* Log _PySys_Audit() error */
|
||||||
_PyRuntimeState *runtime = &_PyRuntime;
|
|
||||||
HEAD_LOCK(runtime);
|
|
||||||
PyThreadState* ts = PyInterpreterState_ThreadHead(interp);
|
|
||||||
HEAD_UNLOCK(runtime);
|
|
||||||
|
|
||||||
while (ts) {
|
|
||||||
if (_PyEval_SetProfile(ts, func, arg) < 0) {
|
|
||||||
PyErr_FormatUnraisable("Exception ignored in PyEval_SetProfileAllThreads");
|
PyErr_FormatUnraisable("Exception ignored in PyEval_SetProfileAllThreads");
|
||||||
}
|
}
|
||||||
HEAD_LOCK(runtime);
|
|
||||||
ts = PyThreadState_Next(ts);
|
|
||||||
HEAD_UNLOCK(runtime);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void
|
void
|
||||||
|
|
@ -2369,22 +2358,11 @@ PyEval_SetTrace(Py_tracefunc func, PyObject *arg)
|
||||||
void
|
void
|
||||||
PyEval_SetTraceAllThreads(Py_tracefunc func, PyObject *arg)
|
PyEval_SetTraceAllThreads(Py_tracefunc func, PyObject *arg)
|
||||||
{
|
{
|
||||||
PyThreadState *this_tstate = _PyThreadState_GET();
|
PyInterpreterState *interp = _PyInterpreterState_GET();
|
||||||
PyInterpreterState* interp = this_tstate->interp;
|
if (_PyEval_SetTraceAllThreads(interp, func, arg) < 0) {
|
||||||
|
/* Log _PySys_Audit() error */
|
||||||
_PyRuntimeState *runtime = &_PyRuntime;
|
|
||||||
HEAD_LOCK(runtime);
|
|
||||||
PyThreadState* ts = PyInterpreterState_ThreadHead(interp);
|
|
||||||
HEAD_UNLOCK(runtime);
|
|
||||||
|
|
||||||
while (ts) {
|
|
||||||
if (_PyEval_SetTrace(ts, func, arg) < 0) {
|
|
||||||
PyErr_FormatUnraisable("Exception ignored in PyEval_SetTraceAllThreads");
|
PyErr_FormatUnraisable("Exception ignored in PyEval_SetTraceAllThreads");
|
||||||
}
|
}
|
||||||
HEAD_LOCK(runtime);
|
|
||||||
ts = PyThreadState_Next(ts);
|
|
||||||
HEAD_UNLOCK(runtime);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
int
|
int
|
||||||
|
|
|
||||||
10
Python/generated_cases.c.h
generated
10
Python/generated_cases.c.h
generated
|
|
@ -5151,7 +5151,15 @@
|
||||||
_Py_CODEUNIT *this_instr = next_instr - 1;
|
_Py_CODEUNIT *this_instr = next_instr - 1;
|
||||||
(void)this_instr;
|
(void)this_instr;
|
||||||
assert(frame == tstate->current_frame);
|
assert(frame == tstate->current_frame);
|
||||||
if (tstate->tracing == 0) {
|
#ifdef Py_GIL_DISABLED
|
||||||
|
// For thread-safety, we need to check instrumentation version
|
||||||
|
// even when tracing. Otherwise, another thread may concurrently
|
||||||
|
// re-write the bytecode while we are executing this function.
|
||||||
|
int check_instrumentation = 1;
|
||||||
|
#else
|
||||||
|
int check_instrumentation = (tstate->tracing == 0);
|
||||||
|
#endif
|
||||||
|
if (check_instrumentation) {
|
||||||
uintptr_t global_version =
|
uintptr_t global_version =
|
||||||
_Py_atomic_load_uintptr_relaxed(&tstate->eval_breaker) &
|
_Py_atomic_load_uintptr_relaxed(&tstate->eval_breaker) &
|
||||||
~_PY_EVAL_EVENTS_MASK;
|
~_PY_EVAL_EVENTS_MASK;
|
||||||
|
|
|
||||||
|
|
@ -1012,6 +1012,8 @@ set_version_raw(uintptr_t *ptr, uint32_t version)
|
||||||
static void
|
static void
|
||||||
set_global_version(PyThreadState *tstate, uint32_t version)
|
set_global_version(PyThreadState *tstate, uint32_t version)
|
||||||
{
|
{
|
||||||
|
ASSERT_WORLD_STOPPED();
|
||||||
|
|
||||||
assert((version & _PY_EVAL_EVENTS_MASK) == 0);
|
assert((version & _PY_EVAL_EVENTS_MASK) == 0);
|
||||||
PyInterpreterState *interp = tstate->interp;
|
PyInterpreterState *interp = tstate->interp;
|
||||||
set_version_raw(&interp->ceval.instrumentation_version, version);
|
set_version_raw(&interp->ceval.instrumentation_version, version);
|
||||||
|
|
@ -1908,28 +1910,27 @@ _Py_Instrument(PyCodeObject *code, PyInterpreterState *interp)
|
||||||
|
|
||||||
|
|
||||||
static int
|
static int
|
||||||
instrument_all_executing_code_objects(PyInterpreterState *interp) {
|
instrument_all_executing_code_objects(PyInterpreterState *interp)
|
||||||
|
{
|
||||||
ASSERT_WORLD_STOPPED();
|
ASSERT_WORLD_STOPPED();
|
||||||
|
|
||||||
_PyRuntimeState *runtime = &_PyRuntime;
|
int err = 0;
|
||||||
HEAD_LOCK(runtime);
|
HEAD_LOCK(&_PyRuntime);
|
||||||
PyThreadState* ts = PyInterpreterState_ThreadHead(interp);
|
for (PyThreadState *ts = interp->threads.head; ts != NULL; ts = ts->next) {
|
||||||
HEAD_UNLOCK(runtime);
|
|
||||||
while (ts) {
|
|
||||||
_PyInterpreterFrame *frame = ts->current_frame;
|
_PyInterpreterFrame *frame = ts->current_frame;
|
||||||
while (frame) {
|
while (frame) {
|
||||||
if (frame->owner != FRAME_OWNED_BY_CSTACK) {
|
if (frame->owner != FRAME_OWNED_BY_CSTACK) {
|
||||||
if (instrument_lock_held(_PyFrame_GetCode(frame), interp)) {
|
err = instrument_lock_held(_PyFrame_GetCode(frame), interp);
|
||||||
return -1;
|
if (err) {
|
||||||
|
goto done;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
frame = frame->previous;
|
frame = frame->previous;
|
||||||
}
|
}
|
||||||
HEAD_LOCK(runtime);
|
|
||||||
ts = PyThreadState_Next(ts);
|
|
||||||
HEAD_UNLOCK(runtime);
|
|
||||||
}
|
}
|
||||||
return 0;
|
done:
|
||||||
|
HEAD_UNLOCK(&_PyRuntime);
|
||||||
|
return err;
|
||||||
}
|
}
|
||||||
|
|
||||||
static void
|
static void
|
||||||
|
|
@ -1975,6 +1976,7 @@ check_tool(PyInterpreterState *interp, int tool_id)
|
||||||
int
|
int
|
||||||
_PyMonitoring_SetEvents(int tool_id, _PyMonitoringEventSet events)
|
_PyMonitoring_SetEvents(int tool_id, _PyMonitoringEventSet events)
|
||||||
{
|
{
|
||||||
|
ASSERT_WORLD_STOPPED();
|
||||||
assert(0 <= tool_id && tool_id < PY_MONITORING_TOOL_IDS);
|
assert(0 <= tool_id && tool_id < PY_MONITORING_TOOL_IDS);
|
||||||
PyThreadState *tstate = _PyThreadState_GET();
|
PyThreadState *tstate = _PyThreadState_GET();
|
||||||
PyInterpreterState *interp = tstate->interp;
|
PyInterpreterState *interp = tstate->interp;
|
||||||
|
|
@ -1983,33 +1985,28 @@ _PyMonitoring_SetEvents(int tool_id, _PyMonitoringEventSet events)
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
|
|
||||||
int res;
|
|
||||||
_PyEval_StopTheWorld(interp);
|
|
||||||
uint32_t existing_events = get_events(&interp->monitors, tool_id);
|
uint32_t existing_events = get_events(&interp->monitors, tool_id);
|
||||||
if (existing_events == events) {
|
if (existing_events == events) {
|
||||||
res = 0;
|
return 0;
|
||||||
goto done;
|
|
||||||
}
|
}
|
||||||
set_events(&interp->monitors, tool_id, events);
|
set_events(&interp->monitors, tool_id, events);
|
||||||
uint32_t new_version = global_version(interp) + MONITORING_VERSION_INCREMENT;
|
uint32_t new_version = global_version(interp) + MONITORING_VERSION_INCREMENT;
|
||||||
if (new_version == 0) {
|
if (new_version == 0) {
|
||||||
PyErr_Format(PyExc_OverflowError, "events set too many times");
|
PyErr_Format(PyExc_OverflowError, "events set too many times");
|
||||||
res = -1;
|
return -1;
|
||||||
goto done;
|
|
||||||
}
|
}
|
||||||
set_global_version(tstate, new_version);
|
set_global_version(tstate, new_version);
|
||||||
#ifdef _Py_TIER2
|
#ifdef _Py_TIER2
|
||||||
_Py_Executors_InvalidateAll(interp, 1);
|
_Py_Executors_InvalidateAll(interp, 1);
|
||||||
#endif
|
#endif
|
||||||
res = instrument_all_executing_code_objects(interp);
|
return instrument_all_executing_code_objects(interp);
|
||||||
done:
|
|
||||||
_PyEval_StartTheWorld(interp);
|
|
||||||
return res;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
int
|
int
|
||||||
_PyMonitoring_SetLocalEvents(PyCodeObject *code, int tool_id, _PyMonitoringEventSet events)
|
_PyMonitoring_SetLocalEvents(PyCodeObject *code, int tool_id, _PyMonitoringEventSet events)
|
||||||
{
|
{
|
||||||
|
ASSERT_WORLD_STOPPED();
|
||||||
|
|
||||||
assert(0 <= tool_id && tool_id < PY_MONITORING_TOOL_IDS);
|
assert(0 <= tool_id && tool_id < PY_MONITORING_TOOL_IDS);
|
||||||
PyInterpreterState *interp = _PyInterpreterState_GET();
|
PyInterpreterState *interp = _PyInterpreterState_GET();
|
||||||
assert(events < (1 << _PY_MONITORING_LOCAL_EVENTS));
|
assert(events < (1 << _PY_MONITORING_LOCAL_EVENTS));
|
||||||
|
|
@ -2021,26 +2018,18 @@ _PyMonitoring_SetLocalEvents(PyCodeObject *code, int tool_id, _PyMonitoringEvent
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
|
|
||||||
int res;
|
|
||||||
_PyEval_StopTheWorld(interp);
|
|
||||||
if (allocate_instrumentation_data(code)) {
|
if (allocate_instrumentation_data(code)) {
|
||||||
res = -1;
|
return -1;
|
||||||
goto done;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
_Py_LocalMonitors *local = &code->_co_monitoring->local_monitors;
|
_Py_LocalMonitors *local = &code->_co_monitoring->local_monitors;
|
||||||
uint32_t existing_events = get_local_events(local, tool_id);
|
uint32_t existing_events = get_local_events(local, tool_id);
|
||||||
if (existing_events == events) {
|
if (existing_events == events) {
|
||||||
res = 0;
|
return 0;
|
||||||
goto done;
|
|
||||||
}
|
}
|
||||||
set_local_events(local, tool_id, events);
|
set_local_events(local, tool_id, events);
|
||||||
|
|
||||||
res = force_instrument_lock_held(code, interp);
|
return force_instrument_lock_held(code, interp);
|
||||||
|
|
||||||
done:
|
|
||||||
_PyEval_StartTheWorld(interp);
|
|
||||||
return res;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
int
|
int
|
||||||
|
|
@ -2238,7 +2227,11 @@ monitoring_set_events_impl(PyObject *module, int tool_id, int event_set)
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
event_set &= ~C_RETURN_EVENTS;
|
event_set &= ~C_RETURN_EVENTS;
|
||||||
if (_PyMonitoring_SetEvents(tool_id, event_set)) {
|
PyInterpreterState *interp = _PyInterpreterState_GET();
|
||||||
|
_PyEval_StopTheWorld(interp);
|
||||||
|
int err = _PyMonitoring_SetEvents(tool_id, event_set);
|
||||||
|
_PyEval_StartTheWorld(interp);
|
||||||
|
if (err) {
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
Py_RETURN_NONE;
|
Py_RETURN_NONE;
|
||||||
|
|
@ -2315,7 +2308,11 @@ monitoring_set_local_events_impl(PyObject *module, int tool_id,
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (_PyMonitoring_SetLocalEvents((PyCodeObject*)code, tool_id, event_set)) {
|
PyInterpreterState *interp = _PyInterpreterState_GET();
|
||||||
|
_PyEval_StopTheWorld(interp);
|
||||||
|
int err = _PyMonitoring_SetLocalEvents((PyCodeObject*)code, tool_id, event_set);
|
||||||
|
_PyEval_StartTheWorld(interp);
|
||||||
|
if (err) {
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
Py_RETURN_NONE;
|
Py_RETURN_NONE;
|
||||||
|
|
|
||||||
|
|
@ -137,17 +137,10 @@ sys_profile_call_or_return(
|
||||||
Py_RETURN_NONE;
|
Py_RETURN_NONE;
|
||||||
}
|
}
|
||||||
|
|
||||||
int
|
static int
|
||||||
_PyEval_SetOpcodeTrace(
|
set_opcode_trace_world_stopped(PyCodeObject *code, bool enable)
|
||||||
PyFrameObject *frame,
|
{
|
||||||
bool enable
|
|
||||||
) {
|
|
||||||
assert(frame != NULL);
|
|
||||||
assert(PyCode_Check(frame->f_frame->f_executable));
|
|
||||||
|
|
||||||
PyCodeObject *code = (PyCodeObject *)frame->f_frame->f_executable;
|
|
||||||
_PyMonitoringEventSet events = 0;
|
_PyMonitoringEventSet events = 0;
|
||||||
|
|
||||||
if (_PyMonitoring_GetLocalEvents(code, PY_MONITORING_SYS_TRACE_ID, &events) < 0) {
|
if (_PyMonitoring_GetLocalEvents(code, PY_MONITORING_SYS_TRACE_ID, &events) < 0) {
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
|
|
@ -166,6 +159,32 @@ _PyEval_SetOpcodeTrace(
|
||||||
return _PyMonitoring_SetLocalEvents(code, PY_MONITORING_SYS_TRACE_ID, events);
|
return _PyMonitoring_SetLocalEvents(code, PY_MONITORING_SYS_TRACE_ID, events);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
int
|
||||||
|
_PyEval_SetOpcodeTrace(PyFrameObject *frame, bool enable)
|
||||||
|
{
|
||||||
|
assert(frame != NULL);
|
||||||
|
|
||||||
|
PyCodeObject *code = _PyFrame_GetCode(frame->f_frame);
|
||||||
|
|
||||||
|
#ifdef Py_GIL_DISABLED
|
||||||
|
// First check if a change is necessary outside of the stop-the-world pause
|
||||||
|
_PyMonitoringEventSet events = 0;
|
||||||
|
if (_PyMonitoring_GetLocalEvents(code, PY_MONITORING_SYS_TRACE_ID, &events) < 0) {
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
int is_enabled = (events & (1 << PY_MONITORING_EVENT_INSTRUCTION)) != 0;
|
||||||
|
if (is_enabled == enable) {
|
||||||
|
return 0; // No change needed
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
PyInterpreterState *interp = _PyInterpreterState_GET();
|
||||||
|
_PyEval_StopTheWorld(interp);
|
||||||
|
int res = set_opcode_trace_world_stopped(code, enable);
|
||||||
|
_PyEval_StartTheWorld(interp);
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
|
||||||
static PyObject *
|
static PyObject *
|
||||||
call_trace_func(_PyLegacyEventHandler *self, PyObject *arg)
|
call_trace_func(_PyLegacyEventHandler *self, PyObject *arg)
|
||||||
{
|
{
|
||||||
|
|
@ -435,13 +454,10 @@ is_tstate_valid(PyThreadState *tstate)
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
static Py_ssize_t
|
static int
|
||||||
setup_profile(PyThreadState *tstate, Py_tracefunc func, PyObject *arg, PyObject **old_profileobj)
|
setup_profile_callbacks(void *Py_UNUSED(arg))
|
||||||
{
|
{
|
||||||
*old_profileobj = NULL;
|
|
||||||
/* Setup PEP 669 monitoring callbacks and events. */
|
/* Setup PEP 669 monitoring callbacks and events. */
|
||||||
if (!tstate->interp->sys_profile_initialized) {
|
|
||||||
tstate->interp->sys_profile_initialized = true;
|
|
||||||
if (set_callbacks(PY_MONITORING_SYS_PROFILE_ID,
|
if (set_callbacks(PY_MONITORING_SYS_PROFILE_ID,
|
||||||
(vectorcallfunc)sys_profile_start, PyTrace_CALL,
|
(vectorcallfunc)sys_profile_start, PyTrace_CALL,
|
||||||
PY_MONITORING_EVENT_PY_START, PY_MONITORING_EVENT_PY_RESUME)) {
|
PY_MONITORING_EVENT_PY_START, PY_MONITORING_EVENT_PY_RESUME)) {
|
||||||
|
|
@ -477,18 +493,33 @@ setup_profile(PyThreadState *tstate, Py_tracefunc func, PyObject *arg, PyObject
|
||||||
PY_MONITORING_EVENT_C_RAISE, -1)) {
|
PY_MONITORING_EVENT_C_RAISE, -1)) {
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
}
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
_PyEval_StopTheWorld(tstate->interp);
|
static PyObject *
|
||||||
|
swap_profile_func_arg(PyThreadState *tstate, Py_tracefunc func, PyObject *arg)
|
||||||
|
{
|
||||||
int delta = (func != NULL) - (tstate->c_profilefunc != NULL);
|
int delta = (func != NULL) - (tstate->c_profilefunc != NULL);
|
||||||
tstate->c_profilefunc = func;
|
tstate->c_profilefunc = func;
|
||||||
*old_profileobj = tstate->c_profileobj;
|
PyObject *old_profileobj = tstate->c_profileobj;
|
||||||
tstate->c_profileobj = Py_XNewRef(arg);
|
tstate->c_profileobj = Py_XNewRef(arg);
|
||||||
tstate->interp->sys_profiling_threads += delta;
|
tstate->interp->sys_profiling_threads += delta;
|
||||||
assert(tstate->interp->sys_profiling_threads >= 0);
|
assert(tstate->interp->sys_profiling_threads >= 0);
|
||||||
Py_ssize_t profiling_threads = tstate->interp->sys_profiling_threads;
|
return old_profileobj;
|
||||||
_PyEval_StartTheWorld(tstate->interp);
|
}
|
||||||
return profiling_threads;
|
|
||||||
|
static int
|
||||||
|
set_monitoring_profile_events(PyInterpreterState *interp)
|
||||||
|
{
|
||||||
|
uint32_t events = 0;
|
||||||
|
if (interp->sys_profiling_threads) {
|
||||||
|
events =
|
||||||
|
(1 << PY_MONITORING_EVENT_PY_START) | (1 << PY_MONITORING_EVENT_PY_RESUME) |
|
||||||
|
(1 << PY_MONITORING_EVENT_PY_RETURN) | (1 << PY_MONITORING_EVENT_PY_YIELD) |
|
||||||
|
(1 << PY_MONITORING_EVENT_CALL) | (1 << PY_MONITORING_EVENT_PY_UNWIND) |
|
||||||
|
(1 << PY_MONITORING_EVENT_PY_THROW);
|
||||||
|
}
|
||||||
|
return _PyMonitoring_SetEvents(PY_MONITORING_SYS_PROFILE_ID, events);
|
||||||
}
|
}
|
||||||
|
|
||||||
int
|
int
|
||||||
|
|
@ -505,31 +536,64 @@ _PyEval_SetProfile(PyThreadState *tstate, Py_tracefunc func, PyObject *arg)
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
|
|
||||||
// needs to be decref'd outside of the lock
|
PyInterpreterState *interp = tstate->interp;
|
||||||
PyObject *old_profileobj;
|
if (_PyOnceFlag_CallOnce(&interp->sys_profile_once_flag,
|
||||||
LOCK_SETUP();
|
setup_profile_callbacks, NULL) < 0) {
|
||||||
Py_ssize_t profiling_threads = setup_profile(tstate, func, arg, &old_profileobj);
|
return -1;
|
||||||
UNLOCK_SETUP();
|
|
||||||
Py_XDECREF(old_profileobj);
|
|
||||||
|
|
||||||
uint32_t events = 0;
|
|
||||||
if (profiling_threads) {
|
|
||||||
events =
|
|
||||||
(1 << PY_MONITORING_EVENT_PY_START) | (1 << PY_MONITORING_EVENT_PY_RESUME) |
|
|
||||||
(1 << PY_MONITORING_EVENT_PY_RETURN) | (1 << PY_MONITORING_EVENT_PY_YIELD) |
|
|
||||||
(1 << PY_MONITORING_EVENT_CALL) | (1 << PY_MONITORING_EVENT_PY_UNWIND) |
|
|
||||||
(1 << PY_MONITORING_EVENT_PY_THROW);
|
|
||||||
}
|
}
|
||||||
return _PyMonitoring_SetEvents(PY_MONITORING_SYS_PROFILE_ID, events);
|
|
||||||
|
_PyEval_StopTheWorld(interp);
|
||||||
|
PyObject *old_profileobj = swap_profile_func_arg(tstate, func, arg);
|
||||||
|
int ret = set_monitoring_profile_events(interp);
|
||||||
|
_PyEval_StartTheWorld(interp);
|
||||||
|
Py_XDECREF(old_profileobj); // needs to be decref'd outside of stop-the-world
|
||||||
|
return ret;
|
||||||
}
|
}
|
||||||
|
|
||||||
static Py_ssize_t
|
int
|
||||||
setup_tracing(PyThreadState *tstate, Py_tracefunc func, PyObject *arg, PyObject **old_traceobj)
|
_PyEval_SetProfileAllThreads(PyInterpreterState *interp, Py_tracefunc func, PyObject *arg)
|
||||||
|
{
|
||||||
|
PyThreadState *current_tstate = _PyThreadState_GET();
|
||||||
|
assert(is_tstate_valid(current_tstate));
|
||||||
|
assert(current_tstate->interp == interp);
|
||||||
|
|
||||||
|
if (_PySys_Audit(current_tstate, "sys.setprofile", NULL) < 0) {
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (_PyOnceFlag_CallOnce(&interp->sys_profile_once_flag,
|
||||||
|
setup_profile_callbacks, NULL) < 0) {
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
PyObject *old_profileobjs = NULL;
|
||||||
|
_PyEval_StopTheWorld(interp);
|
||||||
|
HEAD_LOCK(&_PyRuntime);
|
||||||
|
Py_ssize_t num_thread_states = 0;
|
||||||
|
for (PyThreadState *p = interp->threads.head; p; p = p->next) {
|
||||||
|
num_thread_states++;
|
||||||
|
}
|
||||||
|
old_profileobjs = PyTuple_New(num_thread_states);
|
||||||
|
if (old_profileobjs == NULL) {
|
||||||
|
HEAD_UNLOCK(&_PyRuntime);
|
||||||
|
_PyEval_StartTheWorld(interp);
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
for (PyThreadState *tstate = interp->threads.head; tstate; tstate = tstate->next) {
|
||||||
|
PyObject *old = swap_profile_func_arg(tstate, func, arg);
|
||||||
|
PyTuple_SET_ITEM(old_profileobjs, --num_thread_states, old);
|
||||||
|
}
|
||||||
|
HEAD_UNLOCK(&_PyRuntime);
|
||||||
|
int ret = set_monitoring_profile_events(interp);
|
||||||
|
_PyEval_StartTheWorld(interp);
|
||||||
|
Py_XDECREF(old_profileobjs); // needs to be decref'd outside of stop-the-world
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
static int
|
||||||
|
setup_trace_callbacks(void *Py_UNUSED(arg))
|
||||||
{
|
{
|
||||||
*old_traceobj = NULL;
|
|
||||||
/* Setup PEP 669 monitoring callbacks and events. */
|
/* Setup PEP 669 monitoring callbacks and events. */
|
||||||
if (!tstate->interp->sys_trace_initialized) {
|
|
||||||
tstate->interp->sys_trace_initialized = true;
|
|
||||||
if (set_callbacks(PY_MONITORING_SYS_TRACE_ID,
|
if (set_callbacks(PY_MONITORING_SYS_TRACE_ID,
|
||||||
(vectorcallfunc)sys_trace_start, PyTrace_CALL,
|
(vectorcallfunc)sys_trace_start, PyTrace_CALL,
|
||||||
PY_MONITORING_EVENT_PY_START, PY_MONITORING_EVENT_PY_RESUME)) {
|
PY_MONITORING_EVENT_PY_START, PY_MONITORING_EVENT_PY_RESUME)) {
|
||||||
|
|
@ -575,18 +639,50 @@ setup_tracing(PyThreadState *tstate, Py_tracefunc func, PyObject *arg, PyObject
|
||||||
PY_MONITORING_EVENT_INSTRUCTION, -1)) {
|
PY_MONITORING_EVENT_INSTRUCTION, -1)) {
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
}
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
_PyEval_StopTheWorld(tstate->interp);
|
static PyObject *
|
||||||
|
swap_trace_func_arg(PyThreadState *tstate, Py_tracefunc func, PyObject *arg)
|
||||||
|
{
|
||||||
int delta = (func != NULL) - (tstate->c_tracefunc != NULL);
|
int delta = (func != NULL) - (tstate->c_tracefunc != NULL);
|
||||||
tstate->c_tracefunc = func;
|
tstate->c_tracefunc = func;
|
||||||
*old_traceobj = tstate->c_traceobj;
|
PyObject *old_traceobj = tstate->c_traceobj;
|
||||||
tstate->c_traceobj = Py_XNewRef(arg);
|
tstate->c_traceobj = Py_XNewRef(arg);
|
||||||
tstate->interp->sys_tracing_threads += delta;
|
tstate->interp->sys_tracing_threads += delta;
|
||||||
assert(tstate->interp->sys_tracing_threads >= 0);
|
assert(tstate->interp->sys_tracing_threads >= 0);
|
||||||
Py_ssize_t tracing_threads = tstate->interp->sys_tracing_threads;
|
return old_traceobj;
|
||||||
_PyEval_StartTheWorld(tstate->interp);
|
}
|
||||||
return tracing_threads;
|
|
||||||
|
static int
|
||||||
|
set_monitoring_trace_events(PyInterpreterState *interp)
|
||||||
|
{
|
||||||
|
uint32_t events = 0;
|
||||||
|
if (interp->sys_tracing_threads) {
|
||||||
|
events =
|
||||||
|
(1 << PY_MONITORING_EVENT_PY_START) | (1 << PY_MONITORING_EVENT_PY_RESUME) |
|
||||||
|
(1 << PY_MONITORING_EVENT_PY_RETURN) | (1 << PY_MONITORING_EVENT_PY_YIELD) |
|
||||||
|
(1 << PY_MONITORING_EVENT_RAISE) | (1 << PY_MONITORING_EVENT_LINE) |
|
||||||
|
(1 << PY_MONITORING_EVENT_JUMP) |
|
||||||
|
(1 << PY_MONITORING_EVENT_PY_UNWIND) | (1 << PY_MONITORING_EVENT_PY_THROW) |
|
||||||
|
(1 << PY_MONITORING_EVENT_STOP_ITERATION);
|
||||||
|
}
|
||||||
|
return _PyMonitoring_SetEvents(PY_MONITORING_SYS_TRACE_ID, events);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enable opcode tracing for the thread's current frame if needed.
|
||||||
|
static int
|
||||||
|
maybe_set_opcode_trace(PyThreadState *tstate)
|
||||||
|
{
|
||||||
|
_PyInterpreterFrame *iframe = tstate->current_frame;
|
||||||
|
if (iframe == NULL) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
PyFrameObject *frame = iframe->frame_obj;
|
||||||
|
if (frame == NULL || !frame->f_trace_opcodes) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
return set_opcode_trace_world_stopped(_PyFrame_GetCode(iframe), true);
|
||||||
}
|
}
|
||||||
|
|
||||||
int
|
int
|
||||||
|
|
@ -602,35 +698,76 @@ _PyEval_SetTrace(PyThreadState *tstate, Py_tracefunc func, PyObject *arg)
|
||||||
if (_PySys_Audit(current_tstate, "sys.settrace", NULL) < 0) {
|
if (_PySys_Audit(current_tstate, "sys.settrace", NULL) < 0) {
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
// needs to be decref'd outside of the lock
|
|
||||||
PyObject *old_traceobj;
|
PyInterpreterState *interp = tstate->interp;
|
||||||
LOCK_SETUP();
|
if (_PyOnceFlag_CallOnce(&interp->sys_trace_once_flag,
|
||||||
assert(tstate->interp->sys_tracing_threads >= 0);
|
setup_trace_callbacks, NULL) < 0) {
|
||||||
Py_ssize_t tracing_threads = setup_tracing(tstate, func, arg, &old_traceobj);
|
|
||||||
UNLOCK_SETUP();
|
|
||||||
Py_XDECREF(old_traceobj);
|
|
||||||
if (tracing_threads < 0) {
|
|
||||||
return -1;
|
return -1;
|
||||||
}
|
}
|
||||||
|
|
||||||
uint32_t events = 0;
|
int err = 0;
|
||||||
if (tracing_threads) {
|
_PyEval_StopTheWorld(interp);
|
||||||
events =
|
PyObject *old_traceobj = swap_trace_func_arg(tstate, func, arg);
|
||||||
(1 << PY_MONITORING_EVENT_PY_START) | (1 << PY_MONITORING_EVENT_PY_RESUME) |
|
err = set_monitoring_trace_events(interp);
|
||||||
(1 << PY_MONITORING_EVENT_PY_RETURN) | (1 << PY_MONITORING_EVENT_PY_YIELD) |
|
if (err != 0) {
|
||||||
(1 << PY_MONITORING_EVENT_RAISE) | (1 << PY_MONITORING_EVENT_LINE) |
|
goto done;
|
||||||
(1 << PY_MONITORING_EVENT_JUMP) |
|
|
||||||
(1 << PY_MONITORING_EVENT_PY_UNWIND) | (1 << PY_MONITORING_EVENT_PY_THROW) |
|
|
||||||
(1 << PY_MONITORING_EVENT_STOP_ITERATION);
|
|
||||||
|
|
||||||
PyFrameObject* frame = PyEval_GetFrame();
|
|
||||||
if (frame && frame->f_trace_opcodes) {
|
|
||||||
int ret = _PyEval_SetOpcodeTrace(frame, true);
|
|
||||||
if (ret != 0) {
|
|
||||||
return ret;
|
|
||||||
}
|
}
|
||||||
|
if (interp->sys_tracing_threads) {
|
||||||
|
err = maybe_set_opcode_trace(tstate);
|
||||||
}
|
}
|
||||||
}
|
done:
|
||||||
|
_PyEval_StartTheWorld(interp);
|
||||||
return _PyMonitoring_SetEvents(PY_MONITORING_SYS_TRACE_ID, events);
|
Py_XDECREF(old_traceobj); // needs to be decref'd outside stop-the-world
|
||||||
|
return err;
|
||||||
|
}
|
||||||
|
|
||||||
|
int
|
||||||
|
_PyEval_SetTraceAllThreads(PyInterpreterState *interp, Py_tracefunc func, PyObject *arg)
|
||||||
|
{
|
||||||
|
PyThreadState *current_tstate = _PyThreadState_GET();
|
||||||
|
assert(is_tstate_valid(current_tstate));
|
||||||
|
assert(current_tstate->interp == interp);
|
||||||
|
|
||||||
|
if (_PySys_Audit(current_tstate, "sys.settrace", NULL) < 0) {
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (_PyOnceFlag_CallOnce(&interp->sys_trace_once_flag,
|
||||||
|
setup_trace_callbacks, NULL) < 0) {
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
PyObject *old_trace_objs = NULL;
|
||||||
|
_PyEval_StopTheWorld(interp);
|
||||||
|
HEAD_LOCK(&_PyRuntime);
|
||||||
|
Py_ssize_t num_thread_states = 0;
|
||||||
|
for (PyThreadState *p = interp->threads.head; p; p = p->next) {
|
||||||
|
num_thread_states++;
|
||||||
|
}
|
||||||
|
old_trace_objs = PyTuple_New(num_thread_states);
|
||||||
|
if (old_trace_objs == NULL) {
|
||||||
|
HEAD_UNLOCK(&_PyRuntime);
|
||||||
|
_PyEval_StartTheWorld(interp);
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
for (PyThreadState *tstate = interp->threads.head; tstate; tstate = tstate->next) {
|
||||||
|
PyObject *old = swap_trace_func_arg(tstate, func, arg);
|
||||||
|
PyTuple_SET_ITEM(old_trace_objs, --num_thread_states, old);
|
||||||
|
}
|
||||||
|
if (interp->sys_tracing_threads) {
|
||||||
|
for (PyThreadState *tstate = interp->threads.head; tstate; tstate = tstate->next) {
|
||||||
|
int err = maybe_set_opcode_trace(tstate);
|
||||||
|
if (err != 0) {
|
||||||
|
HEAD_UNLOCK(&_PyRuntime);
|
||||||
|
_PyEval_StartTheWorld(interp);
|
||||||
|
Py_XDECREF(old_trace_objs);
|
||||||
|
return -1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
HEAD_UNLOCK(&_PyRuntime);
|
||||||
|
int err = set_monitoring_trace_events(interp);
|
||||||
|
_PyEval_StartTheWorld(interp);
|
||||||
|
Py_XDECREF(old_trace_objs); // needs to be decref'd outside of stop-the-world
|
||||||
|
return err;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -399,7 +399,6 @@ _Py_COMP_DIAG_POP
|
||||||
&(runtime)->unicode_state.ids.mutex, \
|
&(runtime)->unicode_state.ids.mutex, \
|
||||||
&(runtime)->imports.extensions.mutex, \
|
&(runtime)->imports.extensions.mutex, \
|
||||||
&(runtime)->ceval.pending_mainthread.mutex, \
|
&(runtime)->ceval.pending_mainthread.mutex, \
|
||||||
&(runtime)->ceval.sys_trace_profile_mutex, \
|
|
||||||
&(runtime)->atexit.mutex, \
|
&(runtime)->atexit.mutex, \
|
||||||
&(runtime)->audit_hooks.mutex, \
|
&(runtime)->audit_hooks.mutex, \
|
||||||
&(runtime)->allocators.mutex, \
|
&(runtime)->allocators.mutex, \
|
||||||
|
|
@ -654,8 +653,6 @@ init_interpreter(PyInterpreterState *interp,
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
interp->sys_profile_initialized = false;
|
|
||||||
interp->sys_trace_initialized = false;
|
|
||||||
#ifdef _Py_TIER2
|
#ifdef _Py_TIER2
|
||||||
(void)_Py_SetOptimizer(interp, NULL);
|
(void)_Py_SetOptimizer(interp, NULL);
|
||||||
interp->executor_list_head = NULL;
|
interp->executor_list_head = NULL;
|
||||||
|
|
@ -838,8 +835,6 @@ interpreter_clear(PyInterpreterState *interp, PyThreadState *tstate)
|
||||||
Py_CLEAR(interp->monitoring_callables[t][e]);
|
Py_CLEAR(interp->monitoring_callables[t][e]);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
interp->sys_profile_initialized = false;
|
|
||||||
interp->sys_trace_initialized = false;
|
|
||||||
for (int t = 0; t < PY_MONITORING_TOOL_IDS; t++) {
|
for (int t = 0; t < PY_MONITORING_TOOL_IDS; t++) {
|
||||||
Py_CLEAR(interp->monitoring_tool_names[t]);
|
Py_CLEAR(interp->monitoring_tool_names[t]);
|
||||||
}
|
}
|
||||||
|
|
@ -1724,11 +1719,11 @@ PyThreadState_Clear(PyThreadState *tstate)
|
||||||
}
|
}
|
||||||
|
|
||||||
if (tstate->c_profilefunc != NULL) {
|
if (tstate->c_profilefunc != NULL) {
|
||||||
tstate->interp->sys_profiling_threads--;
|
_Py_atomic_add_ssize(&tstate->interp->sys_profiling_threads, -1);
|
||||||
tstate->c_profilefunc = NULL;
|
tstate->c_profilefunc = NULL;
|
||||||
}
|
}
|
||||||
if (tstate->c_tracefunc != NULL) {
|
if (tstate->c_tracefunc != NULL) {
|
||||||
tstate->interp->sys_tracing_threads--;
|
_Py_atomic_add_ssize(&tstate->interp->sys_tracing_threads, -1);
|
||||||
tstate->c_tracefunc = NULL;
|
tstate->c_tracefunc = NULL;
|
||||||
}
|
}
|
||||||
Py_CLEAR(tstate->c_profileobj);
|
Py_CLEAR(tstate->c_profileobj);
|
||||||
|
|
|
||||||
|
|
@ -1206,9 +1206,10 @@ sys__settraceallthreads(PyObject *module, PyObject *arg)
|
||||||
argument = arg;
|
argument = arg;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
PyInterpreterState *interp = _PyInterpreterState_GET();
|
||||||
PyEval_SetTraceAllThreads(func, argument);
|
if (_PyEval_SetTraceAllThreads(interp, func, argument) < 0) {
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
Py_RETURN_NONE;
|
Py_RETURN_NONE;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -1286,8 +1287,10 @@ sys__setprofileallthreads(PyObject *module, PyObject *arg)
|
||||||
argument = arg;
|
argument = arg;
|
||||||
}
|
}
|
||||||
|
|
||||||
PyEval_SetProfileAllThreads(func, argument);
|
PyInterpreterState *interp = _PyInterpreterState_GET();
|
||||||
|
if (_PyEval_SetProfileAllThreads(interp, func, argument) < 0) {
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
Py_RETURN_NONE;
|
Py_RETURN_NONE;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue