doc: add basic perf documentation

This commit is contained in:
Leonardo de Moura
2021-09-06 07:12:36 -07:00
parent 20022f3c6d
commit 65509c5617

20
doc/perf.md Normal file
View File

@@ -0,0 +1,20 @@
Using `perf`
------------
On Linux machines, we use `perf` + `hotspot` to profile `lean`.
Suppose, we are in the `lean4` root directory, and have a release build at `build/release`.
Then, we can collect profile data using the following command:
```
perf record --call-graph dwarf build/release/stage1/bin/lean src/Lean/Elab/Term.lean
```
Recall that, if you have `elan` installed in your system, `lean` is
actually the `elan` binary that selects which `lean` to execute.
To visualize the data, we use `hotspot`:
```
hotspot
```