1 llvm-profdata - Profile data tool
2 =================================
7 :program:`llvm-profdata` *command* [*args...*]
12 The :program:`llvm-profdata` tool is a small utility for working with profile
18 * :ref:`merge <profdata-merge>`
19 * :ref:`show <profdata-show>`
21 .. program:: llvm-profdata merge
31 :program:`llvm-profdata merge` [*options*] [*filenames...*]
36 :program:`llvm-profdata merge` takes several profile data files
37 generated by PGO instrumentation and merges them together into a single
38 indexed profile data file.
45 Print a summary of command line options.
47 .. option:: -output=output, -o=output
49 Specify the output file name. *Output* cannot be ``-`` as the resulting
50 indexed profile data can't be written to standard output.
52 .. option:: -instr (default)
54 Specify that the input profile is an instrumentation-based profile.
58 Specify that the input profile is a sample-based profile.
60 The format of the generated file can be generated in one of three ways:
62 .. option:: -binary (default)
64 Emit the profile using a binary encoding. For instrumentation-based profile
65 the output format is the indexed binary format.
69 Emit the profile in text mode. This option can also be used with both
70 sample-based and instrumentation-based profile. When this option is used
71 the profile will be dumped in the text format that is parsable by the profile
76 Emit the profile using GCC's gcov format (Not yet supported).
78 .. program:: llvm-profdata show
88 :program:`llvm-profdata show` [*options*] [*filename*]
93 :program:`llvm-profdata show` takes a profile data file and displays the
94 information about the profile counters for this file and
95 for any of the specified function(s).
97 If *filename* is omitted or is ``-``, then **llvm-profdata show** reads its
98 input from standard input.
103 .. option:: -all-functions
105 Print details for every function.
109 Print the counter values for the displayed functions.
111 .. option:: -function=string
113 Print details for a function if the function's name contains the given string.
117 Print a summary of command line options.
119 .. option:: -output=output, -o=output
121 Specify the output file name. If *output* is ``-`` or it isn't specified,
122 then the output is sent to standard output.
124 .. option:: -instr (default)
126 Specify that the input profile is an instrumentation-based profile.
130 Instruct the profile dumper to show profile counts in the text format of the
131 instrumentation-based profile data representation. By default, the profile
132 information is dumped in a more human readable form (also in text) with
137 Specify that the input profile is a sample-based profile.
142 :program:`llvm-profdata` returns 1 if the command is omitted or is invalid,
143 if it cannot read input files, or if there is a mismatch between their data.