1llvm-profdata - Profile data tool
2=================================
3
4.. program:: llvm-profdata
5
6SYNOPSIS
7--------
8
9:program:`llvm-profdata` *command* [*args...*]
10
11DESCRIPTION
12-----------
13
14The :program:`llvm-profdata` tool is a small utility for working with profile
15data files.
16
17COMMANDS
18--------
19
20* :ref:`merge <profdata-merge>`
21* :ref:`show <profdata-show>`
22* :ref:`overlap <profdata-overlap>`
23
24.. program:: llvm-profdata merge
25
26.. _profdata-merge:
27
28MERGE
29-----
30
31SYNOPSIS
32^^^^^^^^
33
34:program:`llvm-profdata merge` [*options*] [*filename...*]
35
36DESCRIPTION
37^^^^^^^^^^^
38
39:program:`llvm-profdata merge` takes several profile data files
40generated by PGO instrumentation and merges them together into a single
41indexed profile data file.
42
43By default profile data is merged without modification. This means that the
44relative importance of each input file is proportional to the number of samples
45or counts it contains. In general, the input from a longer training run will be
46interpreted as relatively more important than a shorter run. Depending on the
47nature of the training runs it may be useful to adjust the weight given to each
48input file by using the ``-weighted-input`` option.
49
50Profiles passed in via ``-weighted-input``, ``-input-files``, or via positional
51arguments are processed once for each time they are seen.
52
53
54OPTIONS
55^^^^^^^
56
57.. option:: -help
58
59 Print a summary of command line options.
60
61.. option:: -output=output, -o=output
62
63 Specify the output file name.  *Output* cannot be ``-`` as the resulting
64 indexed profile data can't be written to standard output.
65
66.. option:: -weighted-input=weight,filename
67
68 Specify an input file name along with a weight. The profile counts of the
69 supplied ``filename`` will be scaled (multiplied) by the supplied
70 ``weight``, where ``weight`` is a decimal integer >= 1.
71 Input files specified without using this option are assigned a default
72 weight of 1. Examples are shown below.
73
74.. option:: -input-files=path, -f=path
75
76  Specify a file which contains a list of files to merge. The entries in this
77  file are newline-separated. Lines starting with '#' are skipped. Entries may
78  be of the form <filename> or <weight>,<filename>.
79
80.. option:: -remapping-file=path, -r=path
81
82  Specify a file which contains a remapping from symbol names in the input
83  profile to the symbol names that should be used in the output profile. The
84  file should consist of lines of the form ``<input-symbol> <output-symbol>``.
85  Blank lines and lines starting with ``#`` are skipped.
86
87  The :doc:`llvm-cxxmap <llvm-cxxmap>` tool can be used to generate the symbol
88  remapping file.
89
90.. option:: -instr (default)
91
92 Specify that the input profile is an instrumentation-based profile.
93
94.. option:: -sample
95
96 Specify that the input profile is a sample-based profile.
97
98 The format of the generated file can be generated in one of three ways:
99
100 .. option:: -binary (default)
101
102 Emit the profile using a binary encoding. For instrumentation-based profile
103 the output format is the indexed binary format.
104
105 .. option:: -extbinary
106
107 Emit the profile using an extensible binary encoding. This option can only
108 be used with sample-based profile. The extensible binary encoding can be
109 more compact with compression enabled and can be loaded faster than the
110 default binary encoding.
111
112 .. option:: -text
113
114 Emit the profile in text mode. This option can also be used with both
115 sample-based and instrumentation-based profile. When this option is used
116 the profile will be dumped in the text format that is parsable by the profile
117 reader.
118
119 .. option:: -gcc
120
121 Emit the profile using GCC's gcov format (Not yet supported).
122
123.. option:: -sparse[=true|false]
124
125 Do not emit function records with 0 execution count. Can only be used in
126 conjunction with -instr. Defaults to false, since it can inhibit compiler
127 optimization during PGO.
128
129.. option:: -num-threads=N, -j=N
130
131 Use N threads to perform profile merging. When N=0, llvm-profdata auto-detects
132 an appropriate number of threads to use. This is the default.
133
134.. option:: -failure-mode=[any|all]
135
136 Set the failure mode. There are two options: 'any' causes the merge command to
137 fail if any profiles are invalid, and 'all' causes the merge command to fail
138 only if all profiles are invalid. If 'all' is set, information from any
139 invalid profiles is excluded from the final merged product. The default
140 failure mode is 'any'.
141
142.. option:: -prof-sym-list=path
143
144 Specify a file which contains a list of symbols to generate profile symbol
145 list in the profile. This option can only be used with sample-based profile
146 in extbinary format. The entries in this file are newline-separated.
147
148.. option:: -compress-all-sections=[true|false]
149
150 Compress all sections when writing the profile. This option can only be used
151 with sample-based profile in extbinary format.
152
153.. option:: -use-md5=[true|false]
154
155 Use MD5 to represent string in name table when writing the profile.
156 This option can only be used with sample-based profile in extbinary format.
157
158.. option:: -gen-partial-profile=[true|false]
159
160 Mark the profile to be a partial profile which only provides partial profile
161 coverage for the optimized target. This option can only be used with
162 sample-based profile in extbinary format.
163
164.. option:: -supplement-instr-with-sample=path_to_sample_profile
165
166 Supplement an instrumentation profile with sample profile. The sample profile
167 is the input of the flag. Output will be in instrumentation format (only works
168 with -instr).
169
170.. option:: -zero-counter-threshold=threshold_float_number
171
172 For the function which is cold in instr profile but hot in sample profile, if
173 the ratio of the number of zero counters divided by the the total number of
174 counters is above the threshold, the profile of the function will be regarded
175 as being harmful for performance and will be dropped.
176
177.. option:: -instr-prof-cold-threshold=threshold_int_number
178
179 User specified cold threshold for instr profile which will override the cold
180 threshold got from profile summary.
181
182.. option:: -suppl-min-size-threshold=threshold_int_number
183
184 If the size of a function is smaller than the threshold, assume it can be
185 inlined by PGO early inliner and it will not be adjusted based on sample
186 profile.
187
188EXAMPLES
189^^^^^^^^
190Basic Usage
191+++++++++++
192Merge three profiles:
193
194::
195
196    llvm-profdata merge foo.profdata bar.profdata baz.profdata -output merged.profdata
197
198Weighted Input
199++++++++++++++
200The input file `foo.profdata` is especially important, multiply its counts by 10:
201
202::
203
204    llvm-profdata merge -weighted-input=10,foo.profdata bar.profdata baz.profdata -output merged.profdata
205
206Exactly equivalent to the previous invocation (explicit form; useful for programmatic invocation):
207
208::
209
210    llvm-profdata merge -weighted-input=10,foo.profdata -weighted-input=1,bar.profdata -weighted-input=1,baz.profdata -output merged.profdata
211
212.. program:: llvm-profdata show
213
214.. _profdata-show:
215
216SHOW
217----
218
219SYNOPSIS
220^^^^^^^^
221
222:program:`llvm-profdata show` [*options*] [*filename*]
223
224DESCRIPTION
225^^^^^^^^^^^
226
227:program:`llvm-profdata show` takes a profile data file and displays the
228information about the profile counters for this file and
229for any of the specified function(s).
230
231If *filename* is omitted or is ``-``, then **llvm-profdata show** reads its
232input from standard input.
233
234OPTIONS
235^^^^^^^
236
237.. option:: -all-functions
238
239 Print details for every function.
240
241.. option:: -counts
242
243 Print the counter values for the displayed functions.
244
245.. option:: -function=string
246
247 Print details for a function if the function's name contains the given string.
248
249.. option:: -help
250
251 Print a summary of command line options.
252
253.. option:: -output=output, -o=output
254
255 Specify the output file name.  If *output* is ``-`` or it isn't specified,
256 then the output is sent to standard output.
257
258.. option:: -instr (default)
259
260 Specify that the input profile is an instrumentation-based profile.
261
262.. option:: -text
263
264 Instruct the profile dumper to show profile counts in the text format of the
265 instrumentation-based profile data representation. By default, the profile
266 information is dumped in a more human readable form (also in text) with
267 annotations.
268
269.. option:: -topn=n
270
271 Instruct the profile dumper to show the top ``n`` functions with the
272 hottest basic blocks in the summary section. By default, the topn functions
273 are not dumped.
274
275.. option:: -sample
276
277 Specify that the input profile is a sample-based profile.
278
279.. option:: -memop-sizes
280
281 Show the profiled sizes of the memory intrinsic calls for shown functions.
282
283.. option:: -value-cutoff=n
284
285 Show only those functions whose max count values are greater or equal to ``n``.
286 By default, the value-cutoff is set to 0.
287
288.. option:: -list-below-cutoff
289
290 Only output names of functions whose max count value are below the cutoff
291 value.
292
293.. option:: -showcs
294
295 Only show context sensitive profile counts. The default is to filter all
296 context sensitive profile counts.
297
298.. option:: -show-prof-sym-list=[true|false]
299
300 Show profile symbol list if it exists in the profile. This option is only
301 meaningful for sample-based profile in extbinary format.
302
303.. option:: -show-sec-info-only=[true|false]
304
305 Show basic information about each section in the profile. This option is
306 only meaningful for sample-based profile in extbinary format.
307
308.. program:: llvm-profdata overlap
309
310.. _profdata-overlap:
311
312OVERLAP
313-------
314
315SYNOPSIS
316^^^^^^^^
317
318:program:`llvm-profdata overlap` [*options*] [*base profile file*] [*test profile file*]
319
320DESCRIPTION
321^^^^^^^^^^^
322
323:program:`llvm-profdata overlap` takes two profile data files and displays the
324*overlap* of counter distribution between the whole files and between any of the
325specified functions.
326
327In this command, *overlap* is defined as follows:
328Suppose *base profile file* has the following counts:
329{c1_1, c1_2, ..., c1_n, c1_u_1, c2_u_2, ..., c2_u_s},
330and *test profile file* has
331{c2_1, c2_2, ..., c2_n, c2_v_1, c2_v_2, ..., c2_v_t}.
332Here c{1|2}_i (i = 1 .. n) are matched counters and c1_u_i (i = 1 .. s) and
333c2_v_i (i = 1 .. v) are unmatched counters (or counters only existing in)
334*base profile file* and *test profile file*, respectively.
335Let sum_1 = c1_1 + c1_2 +  ... + c1_n +  c1_u_1 + c2_u_2 + ... + c2_u_s, and
336sum_2 = c2_1 + c2_2 + ... + c2_n + c2_v_1 + c2_v_2 + ... + c2_v_t.
337*overlap* = min(c1_1/sum_1, c2_1/sum_2) + min(c1_2/sum_1, c2_2/sum_2) + ...
338+ min(c1_n/sum_1, c2_n/sum_2).
339
340The result overlap distribution is a percentage number, ranging from 0.0% to
341100.0%, where 0.0% means there is no overlap and 100.0% means a perfect
342overlap.
343
344Here is an example, if *base profile file* has counts of {400, 600}, and
345*test profile file* has matched counts of {60000, 40000}. The *overlap* is 80%.
346
347OPTIONS
348^^^^^^^
349
350.. option:: -function=string
351
352 Print details for a function if the function's name contains the given string.
353
354.. option:: -help
355
356 Print a summary of command line options.
357
358.. option:: -o=output or -o output
359
360 Specify the output file name.  If *output* is ``-`` or it isn't specified,
361 then the output is sent to standard output.
362
363.. option:: -value-cutoff=n
364
365 Show only those functions whose max count values are greater or equal to ``n``.
366 By default, the value-cutoff is set to max of unsigned long long.
367
368.. option:: -cs
369
370 Only show overlap for the context sensitive profile counts. The default is to show
371 non-context sensitive profile counts.
372
373EXIT STATUS
374-----------
375
376:program:`llvm-profdata` returns 1 if the command is omitted or is invalid,
377if it cannot read input files, or if there is a mismatch between their data.
378