xref: /freebsd/usr.bin/clang/llvm-profdata/llvm-profdata.1 (revision b9f654b163bce26de79705e77b872427c9f2afa1)
$FreeBSD$
Man page generated from reStructuredText.
.
"LLVM-PROFDATA" "1" "2018-08-02" "7" "LLVM"
NAME
llvm-profdata - Profile data tool . .nr rst2man-indent-level 0 . \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .rstReportMargin pre:
. RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .rstReportMargin post:
.. . RE indent \\n[an-margin]
old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1 new: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
SYNOPSIS
llvm-profdata command [args...]
DESCRIPTION
The llvm-profdata tool is a small utility for working with profile data files.
COMMANDS
NDENT 0.0
\(bu 2
\%merge
\(bu 2
\%show NINDENT
MERGE
SYNOPSIS
llvm-profdata merge [options] [filename...]
DESCRIPTION
llvm-profdata merge takes several profile data files generated by PGO instrumentation and merges them together into a single indexed profile data file. By default profile data is merged without modification. This means that the relative importance of each input file is proportional to the number of samples or counts it contains. In general, the input from a longer training run will be interpreted as relatively more important than a shorter run. Depending on the nature of the training runs it may be useful to adjust the weight given to each input file by using the -weighted-input option. Profiles passed in via -weighted-input, -input-files, or via positional arguments are processed once for each time they are seen.
OPTIONS
NDENT 0.0

-help Print a summary of command line options. NINDENT NDENT 0.0

-output=output, -o=output Specify the output file name. Output cannot be - as the resulting indexed profile data can\(aqt be written to standard output. NINDENT NDENT 0.0

-weighted-input=weight,filename Specify an input file name along with a weight. The profile counts of the supplied filename will be scaled (multiplied) by the supplied weight, where where weight is a decimal integer >= 1. Input files specified without using this option are assigned a default weight of 1. Examples are shown below. NINDENT NDENT 0.0

-input-files=path, -f=path Specify a file which contains a list of files to merge. The entries in this file are newline-separated. Lines starting with \(aq#\(aq are skipped. Entries may be of the form <filename> or <weight>,<filename>. NINDENT NDENT 0.0

-instr (default) Specify that the input profile is an instrumentation-based profile. NINDENT NDENT 0.0

-sample Specify that the input profile is a sample-based profile. The format of the generated file can be generated in one of three ways: NDENT 7.0

-binary (default) NINDENT Emit the profile using a binary encoding. For instrumentation-based profile the output format is the indexed binary format. NDENT 7.0

-text NINDENT Emit the profile in text mode. This option can also be used with both sample-based and instrumentation-based profile. When this option is used the profile will be dumped in the text format that is parsable by the profile reader. NDENT 7.0

-gcc NINDENT Emit the profile using GCC\(aqs gcov format (Not yet supported). NINDENT NDENT 0.0

-sparse[=true|false] Do not emit function records with 0 execution count. Can only be used in conjunction with -instr. Defaults to false, since it can inhibit compiler optimization during PGO. NINDENT NDENT 0.0

-num-threads=N, -j=N Use N threads to perform profile merging. When N=0, llvm-profdata auto-detects an appropriate number of threads to use. This is the default. NINDENT

EXAMPLES
Basic Usage
Merge three profiles: NDENT 0.0 NDENT 3.5
llvm-profdata merge foo.profdata bar.profdata baz.profdata -output merged.profdata
NINDENT NINDENT
Weighted Input
The input file foo.profdata is especially important, multiply its counts by 10: NDENT 0.0 NDENT 3.5
llvm-profdata merge -weighted-input=10,foo.profdata bar.profdata baz.profdata -output merged.profdata
NINDENT NINDENT Exactly equivalent to the previous invocation (explicit form; useful for programmatic invocation): NDENT 0.0 NDENT 3.5
llvm-profdata merge -weighted-input=10,foo.profdata -weighted-input=1,bar.profdata -weighted-input=1,baz.profdata -output merged.profdata
NINDENT NINDENT
SHOW
SYNOPSIS
llvm-profdata show [options] [filename]
DESCRIPTION
llvm-profdata show takes a profile data file and displays the information about the profile counters for this file and for any of the specified function(s). If filename is omitted or is -, then llvm-profdata show reads its input from standard input.
OPTIONS
NDENT 0.0

-all-functions Print details for every function. NINDENT NDENT 0.0

-counts Print the counter values for the displayed functions. NINDENT NDENT 0.0

-function=string Print details for a function if the function\(aqs name contains the given string. NINDENT NDENT 0.0

-help Print a summary of command line options. NINDENT NDENT 0.0

-output=output, -o=output Specify the output file name. If output is - or it isn\(aqt specified, then the output is sent to standard output. NINDENT NDENT 0.0

-instr (default) Specify that the input profile is an instrumentation-based profile. NINDENT NDENT 0.0

-text Instruct the profile dumper to show profile counts in the text format of the instrumentation-based profile data representation. By default, the profile information is dumped in a more human readable form (also in text) with annotations. NINDENT NDENT 0.0

-topn=n Instruct the profile dumper to show the top n functions with the hottest basic blocks in the summary section. By default, the topn functions are not dumped. NINDENT NDENT 0.0

-sample Specify that the input profile is a sample-based profile. NINDENT NDENT 0.0

-memop-sizes Show the profiled sizes of the memory intrinsic calls for shown functions. NINDENT

EXIT STATUS
llvm-profdata returns 1 if the command is omitted or is invalid, if it cannot read input files, or if there is a mismatch between their data.
AUTHOR
Maintained by The LLVM Team (http://llvm.org/).
COPYRIGHT
2003-2018, LLVM Project Generated by docutils manpage writer.
.