This is an archive of the discontinued LLVM Phabricator instance.

Differential D79911

[llvm-profdata] Update CommandGuide
ClosedPublic

Authored by wmi on May 13 2020, 3:30 PM.

Details

Reviewers
davidxl
wenlei
Commits
rG67bb16049af1: [llvm-profdata] Update CommandGuide
Summary

Add a bunch of SampleFDO related flags added recently into llvm-profdata to its command guide.

Diff Detail

Repository
rL LLVM

Event Timeline

wmi created this revision.May 13 2020, 3:30 PM
Herald added a project: Restricted Project. · View Herald TranscriptMay 13 2020, 3:30 PM
davidxl added inline comments.May 13 2020, 3:58 PM
llvm/docs/CommandGuide/llvm-profdata.rst
156

can only be used with sample-based profile in extbinary format.

162

used with sample-based profile in extbinary format. Similarly in other places.

wmi marked 2 inline comments as done.May 13 2020, 4:51 PM
wmi added inline comments.
llvm/docs/CommandGuide/llvm-profdata.rst
156

Fixed.

162

Fixed here and other places.

wmi updated this revision to Diff 263891.May 13 2020, 4:52 PM

Address David's comment.

davidxl accepted this revision.May 14 2020, 9:14 AM

lgtm

This revision is now accepted and ready to land.May 14 2020, 9:14 AM
Closed by commit rG67bb16049af1: [llvm-profdata] Update CommandGuide (authored by wmi). · Explain WhyMay 14 2020, 2:09 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
llvm/
docs/
CommandGuide/
39 lines

Diff 263872

llvm/docs/CommandGuide/llvm-profdata.rst

Show First 20 Lines • Show All 96 Lines • ▼ Show 20 Lines
The format of the generated file can be generated in one of three ways: The format of the generated file can be generated in one of three ways:
.. option:: -binary (default) .. option:: -binary (default)
Emit the profile using a binary encoding. For instrumentation-based profile Emit the profile using a binary encoding. For instrumentation-based profile
the output format is the indexed binary format. the output format is the indexed binary format.
.. option:: -extbinary
Emit the profile using an extensible binary encoding. This option can only
be used with sample-based profile. The extensible binary encoding can be
more compact with compression enabled and can be loaded faster than the
default binary encoding.
.. option:: -text .. option:: -text
Emit the profile in text mode. This option can also be used with both Emit the profile in text mode. This option can also be used with both
sample-based and instrumentation-based profile. When this option is used sample-based and instrumentation-based profile. When this option is used
the profile will be dumped in the text format that is parsable by the profile the profile will be dumped in the text format that is parsable by the profile
reader. reader.
.. option:: -gcc .. option:: -gcc
Show All 14 Lines
.. option:: -failure-mode=[any|all] .. option:: -failure-mode=[any|all]
Set the failure mode. There are two options: 'any' causes the merge command to Set the failure mode. There are two options: 'any' causes the merge command to
fail if any profiles are invalid, and 'all' causes the merge command to fail fail if any profiles are invalid, and 'all' causes the merge command to fail
only if all profiles are invalid. If 'all' is set, information from any only if all profiles are invalid. If 'all' is set, information from any
invalid profiles is excluded from the final merged product. The default invalid profiles is excluded from the final merged product. The default
failure mode is 'any'. failure mode is 'any'.
.. option:: -prof-sym-list=path
Specify a file which contains a list of symbols to generate profile symbol
list in the profile. This option can only be used with sample-based profile.
The entries in this file are newline-separated.
.. option:: -compress-all-sections=[true|false]
Compress all sections when writing the profile. This option can only be used
with extbinary format sample-based profile.
.. option:: -use-md5=[true|false]
Use MD5 to represent string in name table when writing the profile.
This option can only be used with extbinary format sample-based profile.
davidxlUnsubmitted
Not Done
ReplyInline Actions

can only be used with sample-based profile in extbinary format.

davidxl: can only be used with sample-based profile in extbinary format.
wmiAuthorUnsubmitted
Done
ReplyInline Actions

Fixed.

wmi: Fixed.
.. option:: -gen-partial-profile=[true|false]
Mark the profile to be a partial profile which only provides partial profile
coverage for the optimized target. This option can only be used with extbinary
format sample-based profile.
davidxlUnsubmitted
Not Done
ReplyInline Actions

used with sample-based profile in extbinary format. Similarly in other places.

davidxl: used with sample-based profile in extbinary format. Similarly in other places.
wmiAuthorUnsubmitted
Done
ReplyInline Actions

Fixed here and other places.

wmi: Fixed here and other places.
EXAMPLES EXAMPLES
^^^^^^^^ ^^^^^^^^
Basic Usage Basic Usage
+++++++++++ +++++++++++
Merge three profiles: Merge three profiles:
:: ::
▲ Show 20 Lines • Show All 94 Lines • ▼ Show 20 Lines
Only output names of functions whose max count value are below the cutoff Only output names of functions whose max count value are below the cutoff
value. value.
.. option:: -showcs .. option:: -showcs
Only show context sensitive profile counts. The default is to filter all Only show context sensitive profile counts. The default is to filter all
context sensitive profile counts. context sensitive profile counts.
.. option:: -show-prof-sym-list=[true|false]
Show profile symbol list if it exists in the profile. This option is only
meaningful for extbinary format sample-based profile.
.. option:: -show-sec-info-only=[true|false]
Show basic information about each section in the profile. This option is
only meaningful for extbinary format sample-based profile.
.. program:: llvm-profdata overlap .. program:: llvm-profdata overlap
.. _profdata-overlap: .. _profdata-overlap:
OVERLAP OVERLAP
------- -------
SYNOPSIS SYNOPSIS
▲ Show 20 Lines • Show All 62 Lines • Show Last 20 Lines