diff options
| author | Ellis Hoag <ellis.sparky.hoag@gmail.com> | 2023-04-12 10:21:38 -0700 |
|---|---|---|
| committer | Ellis Hoag <ellis.sparky.hoag@gmail.com> | 2023-04-13 10:37:05 -0700 |
| commit | 4bddef4117403a305727d145a9abf6bda700f8ff (patch) | |
| tree | fecf699626134bbc6558209bb1a4b1b0134349d4 /llvm/docs/CommandGuide | |
| parent | aca110f9dd17f2ec6492e56472a49bd409c185ae (diff) | |
| download | llvm-4bddef4117403a305727d145a9abf6bda700f8ff.zip llvm-4bddef4117403a305727d145a9abf6bda700f8ff.tar.gz llvm-4bddef4117403a305727d145a9abf6bda700f8ff.tar.bz2 | |
[InstrProf][Temporal] Add weight field to traces
As discussed in [0], add a `weight` field to temporal profiling traces found in profiles. This allows users to use the `--weighted-input=` flag in the `llvm-profdata merge` command to weight traces from different scenarios differently.
Note that this is a breaking change, but since [1] landed very recently and there is no way to "use" this trace data, there should be no users of this feature. We believe it is acceptable to land this change without bumping the profile format version.
[0] https://reviews.llvm.org/D147812#4259507
[1] https://reviews.llvm.org/D147287
Reviewed By: snehasish
Differential Revision: https://reviews.llvm.org/D148150
Diffstat (limited to 'llvm/docs/CommandGuide')
| -rw-r--r-- | llvm/docs/CommandGuide/llvm-profdata.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/llvm/docs/CommandGuide/llvm-profdata.rst b/llvm/docs/CommandGuide/llvm-profdata.rst index 515c18b..c0a551f 100644 --- a/llvm/docs/CommandGuide/llvm-profdata.rst +++ b/llvm/docs/CommandGuide/llvm-profdata.rst @@ -197,6 +197,18 @@ OPTIONS When ``-debug-info-correlate`` was used for instrumentation, use this option to correlate the raw profile. +.. option:: --temporal-profile-trace-reservoir-size + + The maximum number of temporal profile traces to be stored in the output + profile. If more traces are added, we will use reservoir sampling to select + which traces to keep. Note that changing this value between different merge + invocations on the same indexed profile could result in sample bias. The + default value is 100. + +.. option:: --temporal-profile-max-trace-length + + The maximum number of functions in a single temporal profile trace. Longer + traces will be truncated. The default value is 1000. EXAMPLES ^^^^^^^^ |