build/docs/pgo.rst

   1 .. _pgo:
   2
   3 ===========================
   4 Profile Guided Optimization
   5 ===========================
   6
   7 :abbr:`PGO (Profile Guided Optimization)` is the process of adding
   8 probes to a compiled binary, running said binary, then using the
   9 run-time information to *recompile* the binary to (hopefully) make it
  10 faster.
  11
  12 How PGO Builds Work
  13 ===================
  14
  15 The supported interface for invoking a PGO build is to add ``MOZ_PGO=1`` to
  16 configure flags and then build. e.g. in your mozconfig::
  17
  18     ac_add_options MOZ_PGO=1
  19
  20 Then::
  21
  22     $ ./mach build
  23
  24 This is roughly equivalent to::
  25
  26 #. Perform a build with *--enable-profile-generate* in $topobjdir/instrumented
  27 #. Perform a run of the instrumented binaries with build/pgo/profileserver.py
  28 #. Perform a build with *--enable-profile-use* in $topobjdir