diff options
| author | Alexander Smundak <asmundak@google.com> | 2022-11-22 20:14:36 +0000 |
|---|---|---|
| committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | 2022-11-22 20:14:36 +0000 |
| commit | 12034786712850e92fdce752661b010be3fbe816 (patch) | |
| tree | 7506268acc4798fadf18da3523e8d6cb4dbf9d71 /docs | |
| parent | 17461742ecae497c936d71dda6d538688224c1a2 (diff) | |
| parent | 3ff7d3fe83dbe0cb4a0e7273d1951d5887705671 (diff) | |
Merge "Allow profiling Soong from the full build" am: 2f213d0946 am: 516d6f6f6a am: 3ff7d3fe83
Original change: https://android-review.googlesource.com/c/platform/build/soong/+/2309616
Change-Id: I0b147c9fe4bd4a01967ab1bc838f2ed823226ced
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/perf.md | 21 |
1 files changed, 17 insertions, 4 deletions
diff --git a/docs/perf.md b/docs/perf.md index 694dcf135..5b53c8de8 100644 --- a/docs/perf.md +++ b/docs/perf.md @@ -42,16 +42,29 @@ critical path: ``` If the elapsed time is much longer than the critical path then additional -parallelism on the build machine will improve total build times. If there are +parallelism on the build machine will improve total build times. If there are long individual times listed in the critical path then improving build times for those steps or adjusting dependencies so that those steps can run earlier in the build graph will improve total build times. ### Soong -Soong can be traced and profiled using the standard Go tools. It understands -the `-cpuprofile`, `-trace`, and `-memprofile` command line arguments, but we -don't currently have an easy way to enable them in the context of a full build. +Soong proper (i.e., `soong_build` executable that processes the blueprint +files) can be traced and profiled using the standard Go tools. It understands +the `-trace`, `-cpuprofile`, and `-memprofile` command line arguments. +Setting `SOONG_PROFILE_CPU` and/or `SOONG_PROFILE_MEM` environment variables +for the build enables respective profiling, e.g., running + +```shell +SOONG_PROFILE_CPU=/tmp/foo m ..._ +``` + +saves CPU profile for each Soong invocation in /tmp/foo._step_ file, where +_step_ is Soong execution step. The main step is `build`. The others as +`bp2build_files`, `bp2build_workspace`, `modulegraph`, `queryview`, +`api_bp2build`, `soong_docs` (not all of them necessarily run during the build). +The profiles can be inspected with `go tool pprof` from the command line or +with _Run>Open Profiler Snapshot_ in IntelliJ IDEA. ### Kati |