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. When
55 using instrumentation-based profiles, the format of the generated file
56 can be generated in one of the two ways:
58 .. option:: -binary (default)
60 Emit the profile using a binary encoding in indexed profile format.
64 Emit the profile in text format.
68 Specify that the input profile is a sample-based profile. When using
69 sample-based profiles, the format of the generated file can be generated
72 .. option:: -binary (default)
74 Emit the profile using a binary encoding.
78 Emit the profile in text mode.
82 Emit the profile using GCC's gcov format (Not yet supported).
84 .. program:: llvm-profdata show
94 :program:`llvm-profdata show` [*options*] [*filename*]
99 :program:`llvm-profdata show` takes a profile data file and displays the
100 information about the profile counters for this file and
101 for any of the specified function(s).
103 If *filename* is omitted or is ``-``, then **llvm-profdata show** reads its
104 input from standard input.
109 .. option:: -all-functions
111 Print details for every function.
115 Print the counter values for the displayed functions.
117 .. option:: -function=string
119 Print details for a function if the function's name contains the given string.
123 Print a summary of command line options.
125 .. option:: -output=output, -o=output
127 Specify the output file name. If *output* is ``-`` or it isn't specified,
128 then the output is sent to standard output.
130 .. option:: -instr (default)
132 Specify that the input profile is an instrumentation-based profile.
136 Instruct the profile dumper to show profile counts in the text format of the
137 instrumentation-based profile data representation. By default, the profile
138 information is dumped in a more human readable form (also in text) with
143 Specify that the input profile is a sample-based profile.
148 :program:`llvm-profdata` returns 1 if the command is omitted or is invalid,
149 if it cannot read input files, or if there is a mismatch between their data.