docs/CommandGuide/llvm-profdata.rst

   1 llvm-profdata - Profile data tool
   2 =================================
   3
   4 SYNOPSIS
   5 --------
   6
   7 :program:`llvm-profdata` *command* [*args...*]
   8
   9 DESCRIPTION
  10 -----------
  11
  12 The :program:`llvm-profdata` tool is a small utility for working with profile
  13 data files.
  14
  15 COMMANDS
  16 --------
  17
  18 * :ref:`merge <profdata-merge>`
  19 * :ref:`show <profdata-show>`
  20
  21 .. program:: llvm-profdata merge
  22
  23 .. _profdata-merge:
  24
  25 MERGE
  26 -----
  27
  28 SYNOPSIS
  29 ^^^^^^^^
  30
  31 :program:`llvm-profdata merge` [*options*] [*filenames...*]
  32
  33 DESCRIPTION
  34 ^^^^^^^^^^^
  35
  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.
  39
  40 OPTIONS
  41 ^^^^^^^
  42
  43 .. option:: -help
  44
  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
  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
  74 .. program:: llvm-profdata show
  75
  76 .. _profdata-show:
  77
  78 SHOW
  79 ----
  80
  81 SYNOPSIS
  82 ^^^^^^^^
  83
  84 :program:`llvm-profdata show` [*options*] [*filename*]
  85
  86 DESCRIPTION
  87 ^^^^^^^^^^^
  88
  89 :program:`llvm-profdata show` takes a profile data file and displays the
  90 information about the profile counters for this file and
  91 for any of the specified function(s).
  92
  93 If *filename* is omitted or is ``-``, then **llvm-profdata show** reads its
  94 input from standard input.
  95
  96 OPTIONS
  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.
 119
 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
 128 EXIT STATUS
 129 -----------
 130
 131 :program:`llvm-profdata` returns 1 if the command is omitted or is invalid,
 132 if it cannot read input files, or if there is a mismatch between their data.