llvm/docs/CommandGuide/llvm-profgen.rst

   1 llvm-profgen - LLVM SPGO profile generation tool
   2 ================================================
   3
   4 .. program:: llvm-profgen
   5
   6 SYNOPSIS
   7 --------
   8
   9 :program:`llvm-profgen` [*commands*] [*options*]
  10
  11 DESCRIPTION
  12 -----------
  13
  14 The :program:`llvm-profgen` utility generates a profile data file
  15 from given perf script data files for sample-based profile guided
  16 optimization(SPGO).
  17
  18 COMMANDS
  19 --------
  20 At least one of the following commands are required:
  21
  22 .. option:: --perfscript=<string[,string,...]>
  23
  24   Path of perf-script trace created by Linux perf tool with `script`
  25   command(the raw perf.data should be profiled with -b).
  26
  27 .. option:: --binary=<string[,string,...]>
  28
  29   Path of the input profiled binary files.
  30
  31 .. option:: --output=<string>
  32
  33   Path of the output profile file.
  34
  35 OPTIONS
  36 -------
  37 :program:`llvm-profgen` supports the following options:
  38
  39 .. option:: --format=[text|binary|extbinary|compbinary|gcc]
  40
  41   Specify the format of the generated profile. Supported <format>  are `text`,
  42   `binary`, `extbinary`, `compbinary`, `gcc`, see `llvm-profdata` for more
  43   descriptions of the format.
  44
  45 .. option:: --show-mmap-events
  46
  47   Print mmap events.
  48
  49 .. option:: --show-disassembly
  50
  51   Print disassembled code.
  52
  53 .. option:: --x86-asm-syntax=[att|intel]
  54
  55   Specify whether to print assembly code in AT&T syntax (the default) or Intel
  56   syntax.