Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 970c12eade40bd721e365e14285b97188cba9d8c / . / llvm / docs / CommandGuide / llvm-profdata.rst
blob: 7053b7fa710e66bfbb9a166d6144acd89dc3874f [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
Diego Novillo6555adb2015-05-28 21:57:17 +0000[diff] [blame]52.. option:: -instr (default)
53
54 Specify that the input profile is an instrumentation-based profile.
55
56.. option:: -sample
57
58 Specify that the input profile is a sample-based profile. When using
59 sample-based profiles, the format of the generated file can be generated
60 in one of three ways:
61
62 .. option:: -binary (default)
63
64 Emit the profile using a binary encoding.
65
66 .. option:: -text
67
68 Emit the profile in text mode.
69
70 .. option:: -gcc
71
72 Emit the profile using GCC's gcov format (Not yet supported).
73
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]74.. program:: llvm-profdata show
75
Justin Bogner22b9f6a2015-03-12 01:38:50 +0000[diff] [blame]76.. _profdata-show:
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]77
78SHOW
79----
80
81SYNOPSIS
82^^^^^^^^
83
84:program:`llvm-profdata show` [*options*] [*filename*]
85
86DESCRIPTION
87^^^^^^^^^^^
88
89:program:`llvm-profdata show` takes a profile data file and displays the
90information about the profile counters for this file and
91for any of the specified function(s).
92
93If *filename* is omitted or is ``-``, then **llvm-profdata show** reads its
94input from standard input.
95
96OPTIONS
97^^^^^^^
98
99.. option:: -all-functions
100
101 Print details for every function.
102
103.. option:: -counts
104
105 Print the counter values for the displayed functions.
106
107.. option:: -function=string
108
109 Print details for a function if the function's name contains the given string.
110
111.. option:: -help
112
113 Print a summary of command line options.
114
115.. option:: -output=output, -o=output
116
117 Specify the output file name. If *output* is ``-`` or it isn't specified,
118 then the output is sent to standard output.
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +0000[diff] [blame]119
Diego Novillo6555adb2015-05-28 21:57:17 +0000[diff] [blame]120.. option:: -instr (default)
121
122 Specify that the input profile is an instrumentation-based profile.
123
124.. option:: -sample
125
126 Specify that the input profile is a sample-based profile.
127
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +0000[diff] [blame]128EXIT STATUS
129-----------
130
Alex Lorenzbf4508b2014-07-30 20:30:11 +0000[diff] [blame]131:program:`llvm-profdata` returns 1 if the command is omitted or is invalid,
132if it cannot read input files, or if there is a mismatch between their data.