Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 22b9f6a12d816b22198e44f0c4bb249761046d35 / . / llvm / docs / CommandGuide / llvm-profdata.rst
blob: 45f70731d69ef868de444286b6670d1f80a2c36f [file] [log] [blame]
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]1llvm-profdata - Profile data tool
2=================================
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +0000[diff] [blame]3
4SYNOPSIS
5--------
6
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]7:program:`llvm-profdata` *command* [*args...*]
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +0000[diff] [blame]8
9DESCRIPTION
10-----------
11
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]12The :program:`llvm-profdata` tool is a small utility for working with profile
13data files.
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +0000[diff] [blame]14
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]15COMMANDS
16--------
17
Justin Bogner22b9f6a2015-03-12 01:38:50 +0000[diff] [blame^]18* :ref:`merge <profdata-merge>`
19* :ref:`show <profdata-show>`
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]20
21.. program:: llvm-profdata merge
22
Justin Bogner22b9f6a2015-03-12 01:38:50 +0000[diff] [blame^]23.. _profdata-merge:
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]24
25MERGE
26-----
27
28SYNOPSIS
29^^^^^^^^
30
31:program:`llvm-profdata merge` [*options*] [*filenames...*]
32
33DESCRIPTION
34^^^^^^^^^^^
35
36:program:`llvm-profdata merge` takes several profile data files
37generated by PGO instrumentation and merges them together into a single
38indexed profile data file.
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +0000[diff] [blame]39
40OPTIONS
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]41^^^^^^^
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +0000[diff] [blame]42
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]43.. option:: -help
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +0000[diff] [blame]44
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]45 Print a summary of command line options.
46
47.. option:: -output=output, -o=output
48
49 Specify the output file name. *Output* cannot be ``-`` as the resulting
50 indexed profile data can't be written to standard output.
51
52.. program:: llvm-profdata show
53
Justin Bogner22b9f6a2015-03-12 01:38:50 +0000[diff] [blame^]54.. _profdata-show:
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]55
56SHOW
57----
58
59SYNOPSIS
60^^^^^^^^
61
62:program:`llvm-profdata show` [*options*] [*filename*]
63
64DESCRIPTION
65^^^^^^^^^^^
66
67:program:`llvm-profdata show` takes a profile data file and displays the
68information about the profile counters for this file and
69for any of the specified function(s).
70
71If *filename* is omitted or is ``-``, then **llvm-profdata show** reads its
72input from standard input.
73
74OPTIONS
75^^^^^^^
76
77.. option:: -all-functions
78
79 Print details for every function.
80
81.. option:: -counts
82
83 Print the counter values for the displayed functions.
84
85.. option:: -function=string
86
87 Print details for a function if the function's name contains the given string.
88
89.. option:: -help
90
91 Print a summary of command line options.
92
93.. option:: -output=output, -o=output
94
95 Specify the output file name. If *output* is ``-`` or it isn't specified,
96 then the output is sent to standard output.
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +0000[diff] [blame]97
98EXIT STATUS
99-----------
100
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]101:program:`llvm-profdata` returns 1 if the command is omitted or is invalid,
102if it cannot read input files, or if there is a mismatch between their data.