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

Fix max_stack_depth when combined with other filters #521

Merged
merged 3 commits into from
Nov 18, 2024
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 56 additions & 25 deletions src/viztracer/modules/snaptrace.c
Original file line number Diff line number Diff line change
Expand Up @@ -338,25 +338,17 @@ prepare_before_trace(TracerObject* self, int is_call, struct ThreadInfo** info_o
}

if (info->ignore_stack_depth > 0) {
if (is_call) {
info->ignore_stack_depth += 1;
return 0;
} else {
info->ignore_stack_depth -= 1;
return 0;
}
return 0;
}

if (CHECK_FLAG(self->check_flags, SNAPTRACE_MAX_STACK_DEPTH)) {
if (is_call) {
if (info->curr_stack_depth >= self->max_stack_depth) {
info->curr_stack_depth += 1;
return 0;
}
} else {
if (info->curr_stack_depth > 0) {
if (info->curr_stack_depth > self->max_stack_depth) {
info->curr_stack_depth -= 1;
return 0;
}
}
Expand All @@ -374,16 +366,15 @@ tracer_pycall_callback(TracerObject* self, PyCodeObject* code)
if (prepare_before_trace(self, 1, &info) <= 0) {
// For now we think -1 and 0 should both return because we should not
// have the -1 case.
return 0;
goto cleanup_ignore;
}

PyObject* co_filename = code->co_filename;

if (!CHECK_FLAG(self->check_flags, SNAPTRACE_TRACE_SELF)) {
if (self->lib_file_path && co_filename && PyUnicode_Check(co_filename) &&
startswith(PyUnicode_AsUTF8(co_filename), self->lib_file_path)) {
info->ignore_stack_depth += 1;
goto cleanup;
goto cleanup_ignore;
}
}

Expand All @@ -408,18 +399,16 @@ tracer_pycall_callback(TracerObject* self, PyCodeObject* code)
}
}
if (record == 0) {
info->ignore_stack_depth += 1;
goto cleanup;
goto cleanup_ignore;
}
} else {
goto cleanup;
goto cleanup_ignore;
}
}

if (CHECK_FLAG(self->check_flags, SNAPTRACE_IGNORE_FROZEN)) {
if (startswith(PyUnicode_AsUTF8(co_filename), "<frozen")) {
info->ignore_stack_depth += 1;
goto cleanup;
goto cleanup_ignore;
}
}

Expand Down Expand Up @@ -456,10 +445,17 @@ tracer_pycall_callback(TracerObject* self, PyCodeObject* code)
log_func_args(info->stack_top, PyEval_GetFrame(), self->log_func_repr);
}

cleanup:

info->curr_stack_depth += 1;

return 0;

cleanup_ignore:

if (info) {
info->ignore_stack_depth += 1;
info->curr_stack_depth += 1;
}

return 0;
}

Expand All @@ -471,15 +467,13 @@ tracer_ccall_callback(TracerObject* self, PyCodeObject* code, PyObject* arg)
if (prepare_before_trace(self, 1, &info) <= 0) {
// For now we think -1 and 0 should both return because we should not
// have the -1 case.
return 0;
goto cleanup_ignore;
}

PyCFunctionObject* cfunc = (PyCFunctionObject*) arg;

if (cfunc->m_self == (PyObject*)self) {
info->ignore_stack_depth += 1;
info->curr_stack_depth += 1;
return 0;
goto cleanup_ignore;
}

// If it's a call, we need a new node, and we need to update the stack
Expand All @@ -496,6 +490,15 @@ tracer_ccall_callback(TracerObject* self, PyCodeObject* code, PyObject* arg)

info->curr_stack_depth += 1;

return 0;

cleanup_ignore:

if (info) {
info->ignore_stack_depth += 1;
info->curr_stack_depth += 1;
}

return 0;
}

Expand All @@ -507,7 +510,7 @@ tracer_pyreturn_callback(TracerObject* self, PyCodeObject* code, PyObject* arg)
if (prepare_before_trace(self, 0, &info) <= 0) {
// For now we think -1 and 0 should both return because we should not
// have the -1 case.
return 0;
goto cleanup_ignore;
}

struct FunctionNode* stack_top = info->stack_top;
Expand Down Expand Up @@ -571,6 +574,20 @@ tracer_pyreturn_callback(TracerObject* self, PyCodeObject* code, PyObject* arg)
info->curr_stack_depth -= 1;
}

return 0;

cleanup_ignore:

if (info) {
if (info->curr_stack_depth > 0) {
info->curr_stack_depth -= 1;
}

if (info->ignore_stack_depth > 0) {
info->ignore_stack_depth -= 1;
}
}

return 0;
}

Expand All @@ -582,7 +599,7 @@ tracer_creturn_callback(TracerObject* self, PyCodeObject* code, PyObject* arg)
if (prepare_before_trace(self, 0, &info) <= 0) {
// For now we think -1 and 0 should both return because we should not
// have the -1 case.
return 0;
goto cleanup_ignore;
}

struct FunctionNode* stack_top = info->stack_top;
Expand Down Expand Up @@ -639,6 +656,20 @@ tracer_creturn_callback(TracerObject* self, PyCodeObject* code, PyObject* arg)
info->curr_stack_depth -= 1;
}

return 0;

cleanup_ignore:

if (info) {
if (info->curr_stack_depth > 0) {
info->curr_stack_depth -= 1;
}

if (info->ignore_stack_depth > 0) {
info->ignore_stack_depth -= 1;
}
}

return 0;
}

Expand Down
24 changes: 24 additions & 0 deletions tests/test_regression.py
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,30 @@ def test_issue162_os_popen(self):
script=issue162_code_os_popen, expected_stdout=r".*test_issue162.*")


class TestIssue508(CmdlineTmpl):
def test_issue508(self):
script = """
import inspect
import os
import viztracer

exclude = os.path.dirname(inspect.__file__)

def call_self(n):
if n == 0:
return
call_self(n - 1)

with viztracer.VizTracer(exclude_files=[exclude], max_stack_depth=6):
inspect.getsource(call_self)
call_self(10)
"""

self.template(["python", "cmdline_test.py"], script=script,
expected_output_file="result.json",
expected_entries=6)


file_timestamp_disorder = """
def g():
pass
Expand Down
Loading