python / python/cpython

_remote_debugging: quadratic replay time for RLE records with alternating status

Open
#152,721 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

extension-modules topic-profiling type-bug
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Bug report

Bug description

The binary profile reader in _remote_debugging (used by python -m profiling.sampling replay and --diff-flamegraph) reconstructs
run-length-encoded (STACK_REPEAT) samples in binary_reader_replay. On every
status change within a repeat record it allocates a fresh timestamp list sized to
the whole remaining sample count (PyList_New(count - i)) and later trims it with
PyList_SetSlice. When the per-sample status byte alternates, this allocates and
trims an ~count-sized list for every sample, so replaying a single repeat record
is O(count**2) in time.

count is bounded only by the file size (remaining_data / 2), so a large but
otherwise valid .pyb file reaches the quadratic regime. Memory stays bounded;
only CPU time is unbounded (a ~2 MB profile takes minutes, and it scales
quadratically from there).

Reproducer

import os, tempfile, time
from _remote_debugging import (
    FrameInfo, LocationInfo, ThreadInfo, InterpreterInfo, THREAD_STATUS_HAS_GIL,
)
from profiling.sampling.binary_collector import BinaryCollector
from profiling.sampling.binary_reader import BinaryReader

class NullCollector:
    def collect(self, samples, timestamps): pass
    def export(self, filename): pass

def timed(n):
    fn = tempfile.mktemp(suffix=".pyb")
    frame = FrameInfo(("rle.py", LocationInfo((1, 1, 0, 0)), "f", None))
    writer = BinaryCollector(fn, 1000, compression="none")
    for i in range(n):
        status = THREAD_STATUS_HAS_GIL if i % 2 else 0
        interp = InterpreterInfo((0, [ThreadInfo((1, status, [frame]))]))
        writer.collect([interp], timestamp_us=1000 + i)   # same stack -> one repeat record
    writer.export(None)
    t0 = time.perf_counter()
    with BinaryReader(fn) as reader:
        reader.replay_samples(NullCollector())
    os.unlink(fn)
    return time.perf_counter() - t0

for n in (50_000, 100_000, 200_000):
    print(n, f"{timed(n):.2f}s")
# Doubling n roughly quadruples the time (quadratic).

Expected behavior

Replay time should be linear in the number of samples. The list for each
status run should be built to its exact length (e.g. PyList_New(0) +
PyList_Append) instead of over-allocating to the remaining count and trimming
per status change.

Linked PRs
  • gh-152722

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at profiling/sampling/binary_reader.py and the binary_reader_replay entry point, then review linked PR gh-152722. Reproduce with the supplied alternating-status profile and verify replay remains linear in sample count while preserving the replayed samples and timestamps.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, python
Domain
performance, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.