llvm-profdata.rst 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. llvm-profdata - Profile data tool
  2. =================================
  3. SYNOPSIS
  4. --------
  5. :program:`llvm-profdata` *command* [*args...*]
  6. DESCRIPTION
  7. -----------
  8. The :program:`llvm-profdata` tool is a small utility for working with profile
  9. data files.
  10. COMMANDS
  11. --------
  12. * :ref:`merge <profdata-merge>`
  13. * :ref:`show <profdata-show>`
  14. .. program:: llvm-profdata merge
  15. .. _profdata-merge:
  16. MERGE
  17. -----
  18. SYNOPSIS
  19. ^^^^^^^^
  20. :program:`llvm-profdata merge` [*options*] [*filenames...*]
  21. DESCRIPTION
  22. ^^^^^^^^^^^
  23. :program:`llvm-profdata merge` takes several profile data files
  24. generated by PGO instrumentation and merges them together into a single
  25. indexed profile data file.
  26. OPTIONS
  27. ^^^^^^^
  28. .. option:: -help
  29. Print a summary of command line options.
  30. .. option:: -output=output, -o=output
  31. Specify the output file name. *Output* cannot be ``-`` as the resulting
  32. indexed profile data can't be written to standard output.
  33. .. option:: -instr (default)
  34. Specify that the input profile is an instrumentation-based profile.
  35. .. option:: -sample
  36. Specify that the input profile is a sample-based profile. When using
  37. sample-based profiles, the format of the generated file can be generated
  38. in one of three ways:
  39. .. option:: -binary (default)
  40. Emit the profile using a binary encoding.
  41. .. option:: -text
  42. Emit the profile in text mode.
  43. .. option:: -gcc
  44. Emit the profile using GCC's gcov format (Not yet supported).
  45. .. program:: llvm-profdata show
  46. .. _profdata-show:
  47. SHOW
  48. ----
  49. SYNOPSIS
  50. ^^^^^^^^
  51. :program:`llvm-profdata show` [*options*] [*filename*]
  52. DESCRIPTION
  53. ^^^^^^^^^^^
  54. :program:`llvm-profdata show` takes a profile data file and displays the
  55. information about the profile counters for this file and
  56. for any of the specified function(s).
  57. If *filename* is omitted or is ``-``, then **llvm-profdata show** reads its
  58. input from standard input.
  59. OPTIONS
  60. ^^^^^^^
  61. .. option:: -all-functions
  62. Print details for every function.
  63. .. option:: -counts
  64. Print the counter values for the displayed functions.
  65. .. option:: -function=string
  66. Print details for a function if the function's name contains the given string.
  67. .. option:: -help
  68. Print a summary of command line options.
  69. .. option:: -output=output, -o=output
  70. Specify the output file name. If *output* is ``-`` or it isn't specified,
  71. then the output is sent to standard output.
  72. .. option:: -instr (default)
  73. Specify that the input profile is an instrumentation-based profile.
  74. .. option:: -sample
  75. Specify that the input profile is a sample-based profile.
  76. EXIT STATUS
  77. -----------
  78. :program:`llvm-profdata` returns 1 if the command is omitted or is invalid,
  79. if it cannot read input files, or if there is a mismatch between their data.