Skip to content

Commit

Permalink
Allow copying example shell scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
@workingjubilee @michaelwoerister
workingjubilee authored and michaelwoerister committed Dec 7, 2023
1 parent 306a7d2 commit 2371077
Showing 1 changed file with 78 additions and 78 deletions.
156 changes: 78 additions & 78 deletions summarize/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Summarize is a tool to produce a human readable summary of `measureme` profiling
To use this tool you will first want to install it:

```bash
$ cargo install --git https://github.com/rust-lang/measureme --branch stable summarize
cargo install --git https://github.com/rust-lang/measureme --branch stable summarize
```

## Profiling the nightly compiler
Expand All @@ -23,9 +23,9 @@ profile the [regex][regex-crate] crate.
[regex-crate]: https://github.com/rust-lang/regex

```bash
$ git clone https://github.com/rust-lang/regex.git
$ cd regex
$ cargo +nightly rustc -- -Z self-profile
git clone https://github.com/rust-lang/regex.git
cd regex
cargo +nightly rustc -- -Z self-profile
```

The commands above will run `rustc` with the flag that enables profiling. You should now
Expand All @@ -38,36 +38,36 @@ You can now use the `summarize` tool we installed in the previous section to vie
contents of these files:

```bash
$ summarize summarize regex-{pid}.mm_profdata
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| Item | Self time | % of total time | Item count | Cache hits | Blocked time | Incremental load time |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| LLVM_emit_obj | 4.51s | 41.432 | 141 | 0 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| LLVM_module_passes | 1.05s | 9.626 | 140 | 0 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| LLVM_make_bitcode | 712.94ms | 6.543 | 140 | 0 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| typeck_tables_of | 542.23ms | 4.976 | 17470 | 16520 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| codegen | 366.82ms | 3.366 | 141 | 0 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| optimized_mir | 188.22ms | 1.727 | 11668 | 9114 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| mir_built | 156.30ms | 1.434 | 2040 | 1020 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| evaluate_obligation | 151.95ms | 1.394 | 33134 | 23817 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| LLVM_compress_bitcode | 126.55ms | 1.161 | 140 | 0 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| codegen crate | 119.08ms | 1.093 | 1 | 0 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| mir_const | 117.82ms | 1.081 | 1050 | 30 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+

(rows elided)

Total cpu time: 10.896488447s
summarize summarize regex-{pid}.mm_profdata
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | Item | Self time | % of total time | Item count | Cache hits | Blocked time | Incremental load time |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | LLVM_emit_obj | 4.51s | 41.432 | 141 | 0 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | LLVM_module_passes | 1.05s | 9.626 | 140 | 0 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | LLVM_make_bitcode | 712.94ms | 6.543 | 140 | 0 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | typeck_tables_of | 542.23ms | 4.976 | 17470 | 16520 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | codegen | 366.82ms | 3.366 | 141 | 0 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | optimized_mir | 188.22ms | 1.727 | 11668 | 9114 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | mir_built | 156.30ms | 1.434 | 2040 | 1020 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | evaluate_obligation | 151.95ms | 1.394 | 33134 | 23817 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | LLVM_compress_bitcode | 126.55ms | 1.161 | 140 | 0 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | codegen crate | 119.08ms | 1.093 | 1 | 0 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | mir_const | 117.82ms | 1.081 | 1050 | 30 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
#
# (rows elided)
#
# Total cpu time: 10.896488447s
```

## Profiling your own build of rustc
Expand All @@ -80,41 +80,41 @@ You can also profile your own custom build of rustc. First you'll have to clone
[compiling-rust]: https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html

```bash
$ git clone https://github.com/rust-lang/rust.git
$ ./x.py build
git clone https://github.com/rust-lang/rust.git
./x.py build
# This will take a while...
$ rustup toolchain link mytoolchain build/x86_64-unknown-linux-gnu/stage1
rustup toolchain link mytoolchain build/x86_64-unknown-linux-gnu/stage1
```

Where `mytoolchain` is the name of your custom toolchain. Now we do more or less the same
as before: (with regex as example)

```bash
$ git clone https://github.com/rust-lang/regex.git
$ cd regex
$ cargo +mytoolchain rustc -- -Z self-profile
$ summarize summarize regex-{pid}.mm_profdata
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| Item | Self time | % of total time | Item count | Cache hits | Blocked time | Incremental load time |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| LLVM_emit_obj | 4.51s | 41.432 | 141 | 0 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| LLVM_module_passes | 1.05s | 9.626 | 140 | 0 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| LLVM_make_bitcode | 712.94ms | 6.543 | 140 | 0 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| typeck_tables_of | 542.23ms | 4.976 | 17470 | 16520 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| codegen | 366.82ms | 3.366 | 141 | 0 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| optimized_mir | 188.22ms | 1.727 | 11668 | 9114 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
| mir_built | 156.30ms | 1.434 | 2040 | 1020 | 0.00ns | 0.00ns |
+------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+

(rows elided)

Total cpu time: 10.896488447s
git clone https://github.com/rust-lang/regex.git
cd regex
cargo +mytoolchain rustc -- -Z self-profile
summarize summarize regex-{pid}.mm_profdata
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | Item | Self time | % of total time | Item count | Cache hits | Blocked time | Incremental load time |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | LLVM_emit_obj | 4.51s | 41.432 | 141 | 0 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | LLVM_module_passes | 1.05s | 9.626 | 140 | 0 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | LLVM_make_bitcode | 712.94ms | 6.543 | 140 | 0 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | typeck_tables_of | 542.23ms | 4.976 | 17470 | 16520 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | codegen | 366.82ms | 3.366 | 141 | 0 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | optimized_mir | 188.22ms | 1.727 | 11668 | 9114 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
# | mir_built | 156.30ms | 1.434 | 2040 | 1020 | 0.00ns | 0.00ns |
# +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
#
# (rows elided)
#
# Total cpu time: 10.896488447s
```

Note that your custom build of the compiler must not use a newer version of the
Expand Down Expand Up @@ -147,22 +147,22 @@ The `diff` sub command allows you to compare the performance of two different pr
The output is a table like that of the `summarize` sub command but it instead shows the differences in each metric.

```bash
$ summarize diff base-profile.mm_profdata changed-profile.mm_profdata
+---------------------------+--------------+------------+------------+--------------+-----------------------+
| Item | Self Time | Item count | Cache hits | Blocked time | Incremental load time |
+---------------------------+--------------+------------+------------+--------------+-----------------------+
| LLVM_module_passes | -66.626471ms | +0 | +0 | +0ns | +0ns |
+---------------------------+--------------+------------+------------+--------------+-----------------------+
| LLVM_emit_obj | -38.700719ms | +0 | +0 | +0ns | +0ns |
+---------------------------+--------------+------------+------------+--------------+-----------------------+
| LLVM_make_bitcode | +32.006706ms | +0 | +0 | +0ns | +0ns |
+---------------------------+--------------+------------+------------+--------------+-----------------------+
| mir_borrowck | -12.808322ms | +0 | +0 | +0ns | +0ns |
+---------------------------+--------------+------------+------------+--------------+-----------------------+
| typeck_tables_of | -10.325247ms | +0 | +0 | +0ns | +0ns |
+---------------------------+--------------+------------+------------+--------------+-----------------------+
(rows elided)
Total cpu time: -155.177548ms
summarize diff base-profile.mm_profdata changed-profile.mm_profdata
# +---------------------------+--------------+------------+------------+--------------+-----------------------+
# | Item | Self Time | Item count | Cache hits | Blocked time | Incremental load time |
# +---------------------------+--------------+------------+------------+--------------+-----------------------+
# | LLVM_module_passes | -66.626471ms | +0 | +0 | +0ns | +0ns |
# +---------------------------+--------------+------------+------------+--------------+-----------------------+
# | LLVM_emit_obj | -38.700719ms | +0 | +0 | +0ns | +0ns |
# +---------------------------+--------------+------------+------------+--------------+-----------------------+
# | LLVM_make_bitcode | +32.006706ms | +0 | +0 | +0ns | +0ns |
# +---------------------------+--------------+------------+------------+--------------+-----------------------+
# | mir_borrowck | -12.808322ms | +0 | +0 | +0ns | +0ns |
# +---------------------------+--------------+------------+------------+--------------+-----------------------+
# | typeck_tables_of | -10.325247ms | +0 | +0 | +0ns | +0ns |
# +---------------------------+--------------+------------+------------+--------------+-----------------------+
# (rows elided)
# Total cpu time: -155.177548ms
```

The table is sorted by the absolute value of `Self time` descending.

0 comments on commit 2371077

Please sign in to comment.