| Alex Lorenz | bf4508b | 2014-07-30 20:30:11 +0000 | [diff] [blame^] | 1 | llvm-profdata - Profile data tool |
| 2 | ================================= |
| Duncan P. N. Exon Smith | 846a627 | 2014-02-17 23:22:49 +0000 | [diff] [blame] | 3 | |
| 4 | SYNOPSIS |
| 5 | -------- |
| 6 | |
| Alex Lorenz | bf4508b | 2014-07-30 20:30:11 +0000 | [diff] [blame^] | 7 | :program:`llvm-profdata` *command* [*args...*] |
| Duncan P. N. Exon Smith | 846a627 | 2014-02-17 23:22:49 +0000 | [diff] [blame] | 8 | |
| 9 | DESCRIPTION |
| 10 | ----------- |
| 11 | |
| Alex Lorenz | bf4508b | 2014-07-30 20:30:11 +0000 | [diff] [blame^] | 12 | The :program:`llvm-profdata` tool is a small utility for working with profile |
| 13 | data files. |
| Duncan P. N. Exon Smith | 846a627 | 2014-02-17 23:22:49 +0000 | [diff] [blame] | 14 | |
| Alex Lorenz | bf4508b | 2014-07-30 20:30:11 +0000 | [diff] [blame^] | 15 | COMMANDS |
| 16 | -------- |
| 17 | |
| 18 | * `merge <profdata_merge_>`_ |
| 19 | * `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. |
| Duncan P. N. Exon Smith | 846a627 | 2014-02-17 23:22:49 +0000 | [diff] [blame] | 39 | |
| 40 | OPTIONS |
| Alex Lorenz | bf4508b | 2014-07-30 20:30:11 +0000 | [diff] [blame^] | 41 | ^^^^^^^ |
| Duncan P. N. Exon Smith | 846a627 | 2014-02-17 23:22:49 +0000 | [diff] [blame] | 42 | |
| Alex Lorenz | bf4508b | 2014-07-30 20:30:11 +0000 | [diff] [blame^] | 43 | .. option:: -help |
| Duncan P. N. Exon Smith | 846a627 | 2014-02-17 23:22:49 +0000 | [diff] [blame] | 44 | |
| Alex Lorenz | bf4508b | 2014-07-30 20:30:11 +0000 | [diff] [blame^] | 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 | .. program:: llvm-profdata show |
| 53 | |
| 54 | .. _profdata_show: |
| 55 | |
| 56 | SHOW |
| 57 | ---- |
| 58 | |
| 59 | SYNOPSIS |
| 60 | ^^^^^^^^ |
| 61 | |
| 62 | :program:`llvm-profdata show` [*options*] [*filename*] |
| 63 | |
| 64 | DESCRIPTION |
| 65 | ^^^^^^^^^^^ |
| 66 | |
| 67 | :program:`llvm-profdata show` takes a profile data file and displays the |
| 68 | information about the profile counters for this file and |
| 69 | for any of the specified function(s). |
| 70 | |
| 71 | If *filename* is omitted or is ``-``, then **llvm-profdata show** reads its |
| 72 | input from standard input. |
| 73 | |
| 74 | OPTIONS |
| 75 | ^^^^^^^ |
| 76 | |
| 77 | .. option:: -all-functions |
| 78 | |
| 79 | Print details for every function. |
| 80 | |
| 81 | .. option:: -counts |
| 82 | |
| 83 | Print the counter values for the displayed functions. |
| 84 | |
| 85 | .. option:: -function=string |
| 86 | |
| 87 | Print details for a function if the function's name contains the given string. |
| 88 | |
| 89 | .. option:: -help |
| 90 | |
| 91 | Print a summary of command line options. |
| 92 | |
| 93 | .. option:: -output=output, -o=output |
| 94 | |
| 95 | Specify the output file name. If *output* is ``-`` or it isn't specified, |
| 96 | then the output is sent to standard output. |
| Duncan P. N. Exon Smith | 846a627 | 2014-02-17 23:22:49 +0000 | [diff] [blame] | 97 | |
| 98 | EXIT STATUS |
| 99 | ----------- |
| 100 | |
| Alex Lorenz | bf4508b | 2014-07-30 20:30:11 +0000 | [diff] [blame^] | 101 | :program:`llvm-profdata` returns 1 if the command is omitted or is invalid, |
| 102 | if it cannot read input files, or if there is a mismatch between their data. |