Rocq Prover 性能剖析实战指南:用 perf 做时间剖析、用 memtrace 做内存剖析
Rocq Prover 性能剖析实战指南:用 perf 做时间剖析、用 memtrace 做内存剖析
本文是 Rocq Prover(coq 仓库的交互式定理证明器)性能剖析的实战指南,完整源自仓库文档 dev/doc/profiling.md。Rocq 的证明脚本(尤其是依赖 Ltac 自动化、typeclass 搜索和大型标准库编译的场景)常出现"编译卡顿"或"内存暴涨"问题,本文给出作者在开发过程中实际使用的两套剖析方案:基于 Linux perf 的时间剖析(含组件级火焰图生成),以及基于 OCaml Memprof / memtrace 的统计内存剖析。读完本文,你将能对单个 .v 文件、单个运行进程乃至整个标准库的构建过程进行采样、可视化并定位热点,同时理解这些工具在 Rocq 源码中的集成方式。
一、环境前提:只支持 Linux,推荐专用 OCaml switch
perf 与 memtrace 两条路线都以 Linux 为运行前提(perf 依赖内核 perf_event 子系统,见下文仓库自带的 perf/perf.c 实现)。文档作者主要使用两个 OCaml 分支来分别剖析时间与内存消耗:
- 时间剖析:
opam switch 4.14.0+trunk+fp。+fp指 OCaml 的 flat float array(扁平浮点数组)分支,该布局对数值密集的代码路径更友好,也便于获得稳定的调用栈采样; - 内存剖析:需要额外安装
memtrace库(详见第三节)。
在 Rocq 源码目录下,make world 构建主二进制与库(world 目标在 Makefile 中执行 dune build 构建 rocq-runtime.install、coq-core.install 等主安装目标);make states 只是 world 的别名(Makefile),火焰图流程中用它仅为重建二进制。
二、时间剖析:对单个 .v 文件的整体采样
在 Rocq 源码目录中按以下步骤操作:
opam switch 4.14.0+trunk+fp
make world
perf record -g _build/install/default/bin/coqc file.v
perf report -g fractal,callee --no-children
各步骤含义:
opam switch 4.14.0+trunk+fp:切换 OCaml 编译环境;make world:构建coqc等主二进制,产物位于_build/install/default/bin/下;perf record -g:以调用栈(call graph)模式采样coqc file.v的整个编译过程,生成perf.data;perf report -g fractal,callee --no-children:交互式查看报告。fractal是折叠式占比显示,callee表示展开被调方视角,--no-children让每个函数只统计自身(不含子调用)的开销,便于定位真正的自耗时热点。
值得一提的仓库细节:Rocq 自带一个名为 rocq-runtime.perf 的 OCaml 库(见 perf/dune),通过 perf/perf.c 中的 C stub 直接调用 Linux SYS_perf_event_open 打开硬件指令计数器(PERF_COUNT_HW_INSTRUCTIONS),并暴露 init / peek / drop 三个 OCaml 函数(perf/perf.mli)。它提供的是进程内精确的 CPU 指令计数而非采样剖析,适合在 OCaml 代码层面对关键函数做细粒度计量,进一步印证了该仓库的性能分析工具链以 Linux 为根基。
三、时间剖析:只剖析文件的一部分
当 .v 文件很大、只想剖析其中某一段时,先启动交互式会话把文件完整加载进来,再以附加(attach)方式对已运行进程采样:
bin/coqtop -l file.v
在另一个终端查看 coqtop 的进程号 PID,然后:
perf record -g -p PID
perf record -g -p PID 会附加到该 coqtop 进程并按其调用栈持续采样,直到你手动停止(Ctrl-C)。这样可以在 coqtop 中执行(或回放)关心的具体命令,只记录该阶段的开销;停止采集后同样用 perf report -g fractal,callee --no-children 查看。
四、组件级火焰图:剖析整个标准库构建
由于 Ltac 解释器的栈会反映在 OCaml 调用栈中,同一个原语可能出现在大量本质等价的栈顶上(例如 _apply 辅助函数、Logic_monad__fun 匿名函数、带数字后缀的编译器生成帧),直接生成的火焰图非常嘈杂。有两种处理思路:
- 编辑栈轨迹、合并"等价"的帧;
- 按组件(component)聚合查看整体占比——这是作者 Andres Erbsen 采用并推荐的方案,他对标准库整体构建产出了按最外层组件分类的火焰图。
按组件聚合的完整脚本如下:
#!/usr/bin/env bash
make clean
make states
perf record -F99 `# ~1GB of data` --call-graph=dwarf -- make world
perf script --time '0%-100%' |
stackcollapse-perf.pl |
grep Coqtop__compile |
sed -rf <(cat <<'EOF'
s/;caml/;/g
s/_[0-9]*;/;/g
s/Logic_monad__fun;//g
s/_apply[0-9];//g
s/;System/@&@/
s/;Hashcons/@&@/
s/;Grammar/@&@/
s/;Declaremods/@&@/
s/;Tactics/@&@/
s/;Pretyping/@&@/
s/;Typeops/@&@/
s/;Reduction/@&@/
s/;Unification/@&@/
s/;Evarutil/@&@/
s/;Evd/@&@/
s/;EConstr/@&@/
s/;Constr/@&@/
s/;Univ/@&@/
s/;Ugraph/@&@/
s/;UState/@&@/
s/;Micromega/@&@/
s/;Omega/@&@/
s/;Auto/@&@/
s/;Ltac_plugin__Tacinterp/@&@/
s/;Ltac_plugin__Rewrite/@&@/
s/[^@]*@;([^@]*)@/\1;\1/
s/@//g
:a; s/;([^;]+);\1;/;\1;/g;ta
EOF
) |
flamegraph.pl
流水线逐步拆解:
make clean+make states:先清理再构建,保证接下来整个make world都在采样范围内重建;perf record -F99 --call-graph=dwarf -- make world:以 99Hz 频率(约产生 1GB 采样数据)对完整标准库构建过程采样,--call-graph=dwarf用 DWARF 调试信息展开用户态调用栈(Rocq 以 OCaml 原生代码运行,无 frame pointer,故需 DWARF 模式才能拿到完整栈);perf script --time '0%-100%':把采样数据导出为脚本文本流;stackcollapse-perf.pl:FlameGraph 工具集中的栈折叠脚本,把采样折叠成每条独立栈轨迹一行;grep Coqtop__compile:只保留编译主路径Coqtop__compile之下的栈(即真正花在编译 .v 上的时间,滤掉构建系统、链接等外围开销);sed脚本分三类规约:- 清理噪声帧:
;caml前缀统一为;,删除_[0-9]*这类 OCaml 编译器自动生成的数字后缀帧,删除Logic_monad__fun匿名函数帧和_apply[0-9]apply 辅助帧; - 标记组件边界:以
@把System、Hashcons、Grammar、Declaremods、Tactics、Pretyping、Typeops、Reduction、Unification、Evarutil、Evd、EConstr、Constr、Univ、Ugraph、UState、Micromega、Omega、Auto、Ltac_plugin__Tacinterp、Ltac_plugin__Rewrite等模块的帧与其余部分分隔开——这些正是 Rocq 内核/引擎/预定型/tactic 层的核心模块(对应仓库中的 kernel/、engine/、pretyping/、tactics/ 等目录); - 合并等价帧:把每个组件段规约成"组件名;组件名"的重复帧,再用
:a; s/;([^;]+);\1;/;\1;/g;ta循环合并相邻重复帧;
- 清理噪声帧:
flamegraph.pl:把规约后的栈生成 SVG 火焰图,每个"组件"变成图中一个可辨识的块,从而一眼看出标准库编译时间主要花在 Reduction、Unification、Typeops 还是 Ltac 解释等哪个组件上。
这一流程得到的组件聚合火焰图与第三节的"附加到进程"技巧配合,基本覆盖了时间侧的所有剖析诉求。
五、内存剖析:memtrace + 统计采样
5.1 原理与仓库集成方式
memtrace 是 Jane Street 开发的客户端库,基于 OCaml 的 Memprof 统计内存剖析器(statistical memory profiler),通过概率采样记录分配点(allocation site)与存活对象归属,配合其查看器即可发现内存泄漏与分配热点。
Rocq 仓库对 memtrace 的集成很清晰,可以从源码中看到完整的接入链路:
- dune-project 声明
(depopts rocq-native (memprof-limits (>= 0.3.0)) memtrace),即memtrace是可选依赖(opam 层面); - toplevel/dune 使用 dune 的
select机制按是否安装 memtrace 二选一编译初始化模块:(select memtrace_init.ml from (memtrace -> memtrace_init.memtrace.ml) (!memtrace -> memtrace_init.default.ml)); - 启用时编译 toplevel/memtrace_init.memtrace.ml(其内容为
Memtrace.trace_if_requested ()),未启用时编译空操作的 toplevel/memtrace_init.default.ml; - 初始化点在 toplevel/coqc.ml 的
main函数:let () = Memtrace_init.init () in Coqtop.start_coq custom_coqc args,即在启动coqc参数解析后、进入主循环前完成trace_if_requested。
Memtrace.trace_if_requested 意味着:只有当进程环境中设置了 MEMTRACE 环境变量(指向 trace 文件路径)时才开始采样,未设置则完全无开销——这正是下面命令序列中 MEMTRACE=trace-byte.tcr 的作用。
5.2 完整操作序列
要剖析一个 .v 文件的内存行为,需要先安装 memtrace 库并重编译 Rocq。文档作者还建议先把 .v 文件复制一份(例如在标准库上工作时,避免剖析过程与构建产物互相干扰)。完整序列:
opam install memtrace
make world # to build deps
cp theories/Corelib/Classes/RelationClasses.v /tmp
MEMTRACE=trace-byte.tcr dune exec -- rocq c /tmp/RelationClasses.v
memtrace-viewer trace-byte.tcr
逐步说明:
opam install memtrace:安装 memtrace 库(此时它会作为可选依赖被 dune 感知,下一次构建自动选择 memtrace 版初始化模块);make world:重编译 Rocq 主二进制,把 memtrace 支持链接进去;cp theories/Corelib/Classes/RelationClasses.v /tmp:复制待剖析文件。之所以选 theories/Corelib/Classes/RelationClasses.v,是因为它定义了Reflexive、Symmetric、Transitive、PreOrder、Equivalence等基于 typeclass 的关系理论(约 547 行),是标准库中大量依赖 setoid 重写与 typeclass 搜索的典型代表,非常适合观察搜索/重写过程中的内存分配特征;复制到/tmp是为了避免覆盖仓库内构建产物或触发增量构建干扰;MEMTRACE=trace-byte.tcr dune exec -- rocq c /tmp/RelationClasses.v:通过环境变量开启 memtrace 采样并写入trace-byte.tcr。注意当前仓库的命令名是rocq(对应coqc的编译入口,c即 compile,与 toplevel/coqc.ml 实现的coqc子命令同源),dune exec保证使用刚构建出的、带 memtrace 支持的二进制;memtrace-viewer trace-byte.tcr:启动 Jane Street 的 memtrace 查看器(GUI),以火焰图/调用树形式展示采样到的分配站点与内存占用分布,定位泄漏或高分配路径。
5.3 实践要点
- 采样是统计性的:
trace-byte.tcr只记录采样点而非每次分配,因此更适合定位"占大头"的分配热点,而非逐字节精确统计; - 重编译前提:必须先
opam install memtrace再make world,否则运行的二进制里Memtrace_init.init是空操作(toplevel/memtrace_init.default.ml),MEMTRACE环境变量不会产生任何 trace 文件; - 文件复制是防御性操作:在标准库目录下直接剖析可能受
.vo产物、dune 缓存等因素干扰,复制到/tmp后路径更干净、可复现性更好; - 与时间剖析的联动:内存与时间两个维度可以分开进行——内存侧用 memtrace 采样分配点,时间侧用 perf 采样 CPU 栈,二者结合即可覆盖"慢在哪"与"内存去哪了"两个问题。
六、小结
Rocq 的性能剖析手段可归纳为一条主线、两个维度:
| 维度 | 工具 | 采样目标 | 典型命令 |
|---|---|---|---|
| 时间 | Linux perf |
整个 coqc file.v 编译 |
perf record -g ... && perf report -g fractal,callee --no-children |
| 时间(局部) | Linux perf |
已运行的 coqtop 进程 |
coqtop -l file.v 后 perf record -g -p PID |
| 时间(整库) | perf + FlameGraph 工具集 |
make world 全过程 |
见第四节完整脚本,按组件聚合生成火焰图 |
| 内存 | OCaml Memprof + memtrace | rocq c file.v 的分配站点 |
MEMTRACE=trace-byte.tcr dune exec -- rocq c ... 后 memtrace-viewer |
以上操作全部以本文档 dev/doc/profiling.md 为直接依据,并可由仓库源码交叉印证:memtrace 的接入点见 toplevel/coqc.ml 与 toplevel/dune,可选依赖声明见 dune-project,构建目标 states/world 见 Makefile,Linux 指令计数的 C 实现见 perf/perf.c。需要提醒的是,上述命令均为 Linux 环境专用,且以当前仓库的开发版构建布局(_build/install/default/bin/、dune exec)为准,若在其它 OCaml switch 或发行版安装方式下,路径与二进制名可能略有差异。