bolt/docs/BinaryAnalysis.md

   1 # BOLT-based binary analysis
   2
   3 As part of post-link-time optimizing, BOLT needs to perform a range of analyses
   4 on binaries such as recontructing control flow graphs, and more.
   5
   6 The `llvm-bolt-binary-analysis` tool enables running requested binary analyses
   7 on binaries, and generating reports. It does this by building on top of the
   8 analyses implemented in the BOLT libraries.
   9
  10 ## Which binary analyses are implemented?
  11
  12 At the moment, no binary analyses are implemented.
  13
  14 The goal is to make it easy using a plug-in framework to add your own analyses.
  15
  16 ## How to add your own binary analysis
  17
  18 _TODO: this section needs to be written. Ideally, we should have a simple
  19 "example" or "template" analysis that can be the starting point for implementing
  20 custom analyses_