Update manual version numbers and minor fixes
[dyninst.git] / parseAPI / doc / 1-Intro.tex
1 \section{Introduction}
2 \label{sec:intro}
3
4 A binary code parser converts the machine code representation of a program,
5 library, or code snippet to abstractions such as the instructions, basic
6 blocks, functions, and loops that the binary code represents. The ParseAPI is a
7 multi-platform library for creating such abstractions from binary code sources.
8 The current incarnation uses the Dyninst SymtabAPI as the default binary code
9 source; all platforms and architectures handled by the SymtabAPI are supported.
10 The ParseAPI has cross-architecture binary analysis capabilities in analyzing
11 ELF binaries (parsing of ARM binaries on x86 and vice versa, for example).
12 The ParseAPI is designed to be easily extensible to other binary code sources.
13 Support for parsing binary code in memory dumps or other formats requires only
14 implementation of a small interface as described in this document.
15
16 This API provides the user with a control flow-oriented view of a binary code
17 source. Each code object such as a program binary or library is represented as
18 a top-level collection containing the loops, functions, basic blocks, and edges that
19 represent the control flow graph. A simple query interface is provided for
20 retrieving lower level objects like functions and basic blocks through address
21 or other attribute lookups. These objects can be used to navigate the program
22 structure as described below.