[FEAT] Add performance benchmarking and profiling infrastructure

未关闭
  • 哪里不对？
#970 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
github-actions, python
领域
ci-cd, performance, testing, tooling

调研方向

首先检查 integration/data/prove-rs/ 下现有的程序、pyk/testing/_profiler.py、kmir.py、smir.py，以及 test.yml 中的 Docker 设置。在决定 benchmark 和 profiling 的入口点如何衔接之前，先梳理 pytest 集成测试和 Makefile 的组织方式。满足列出的验收标准即视为完成，包括 benchmark 产物、CI 摘要、profiling 输出以及 docs/dev/ 中的文档。

由索引模型根据 Issue 内容生成。

描述

Motivation

As the MIR semantics grows in complexity and test coverage expands (see #964), there is no systematic way to detect performance regressions or identify bottlenecks in symbolic execution. Issue #655 shows that performance problems have already surfaced (slow use functions), but we lack the tooling to investigate them systematically or to catch regressions automatically.

Proposed Feature

1. Benchmark Suite

Define a curated set of prove-rs test cases as a benchmark suite — a subset of the existing integration/data/prove-rs/ programs chosen to cover representative workloads (arithmetic, branching, enums, closures, iterators, etc.).

Each benchmark would record:

  • Wall-clock time for kmir prove-rs
  • Number of proof steps / rewrite rule applications (via K's --statistics output)
  • Peak memory usage

Results are stored as a JSON artifact (e.g., bench-results.json) committed or uploaded as a workflow artifact for comparison.

2. Python-level Profiling via pyk.testing.Profiler

pyk already ships a cProfile-based Profiler class (pyk/testing/_profiler.py). We can integrate it into the pytest integration-test runner to generate .prof files for selected tests, enabling:

  • Identification of hot Python functions in the SMIR→K transformation pipeline (kmir.py, smir.py)
  • Easy investigation of issues like #655 without manual instrumentation

A --profile pytest option (or a dedicated make profile-integration target) would enable this on demand.

3. GitHub Actions Workflow: benchmark.yml

A new workflow triggered on:

  • push to master — baseline tracking
  • workflow_dispatch — on-demand profiling for PRs under investigation
  • Optionally: pull_request with a label like perf to gate on demand

Steps:

  1. Build stable-mir-json + kmir (reuse Docker setup from test.yml)
  2. Run the benchmark suite, capturing timing/step counts
  3. Upload bench-results.json as a workflow artifact
  4. On master push: compare against the previous baseline stored in a GitHub Actions cache and post a summary to the job summary ($GITHUB_STEP_SUMMARY)
  5. Optionally: use benchmark-action/github-action-benchmark to track trends over time and comment on PRs when a regression threshold is exceeded
4. make benchmark Target

A local Makefile target for developers to run the benchmark suite locally and view a summary, mirroring CI behaviour.

Acceptance Criteria

  • Benchmark suite defined (list of representative test cases with expected step counts)
  • make benchmark target runs locally and outputs a timing/step-count table
  • --profile mode generates .prof files for pytest integration tests using pyk.testing.Profiler
  • benchmark.yml GitHub Actions workflow uploads benchmark artifacts on every master push
  • CI posts a step-summary table comparing current vs. baseline results
  • Documentation added to docs/dev/ on how to run benchmarks and interpret results

Related

  • #655 — slow use functions investigation
  • #964 — external test suite integration (benchmark suite could overlap)
  • pyk/testing/_profiler.py — existing profiler infrastructure available in the pyk dependency
主要语言
Python
星标
55
派生
5
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

runtimeverification/mir-semantics 的其他 Issue

查看 runtimeverification/mir-semantics 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。