xref: /llvm-project/bolt/docs/BinaryAnalysis.md (revision ceb7214be0287f536b292a41f8a7dc2e1467d72d)
1# BOLT-based binary analysis
2
3As part of post-link-time optimizing, BOLT needs to perform a range of analyses
4on binaries such as recontructing control flow graphs, and more.
5
6The `llvm-bolt-binary-analysis` tool enables running requested binary analyses
7on binaries, and generating reports. It does this by building on top of the
8analyses implemented in the BOLT libraries.
9
10## Which binary analyses are implemented?
11
12At the moment, no binary analyses are implemented.
13
14The 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
20custom analyses_
21