DyninstAPI defensive mode manual update.
[dyninst.git] / instructionAPI / doc / latex / group__instruction__ast__module.tex
1 \subsection{InstructionAST Hierarchy}
2 \label{group__instruction__ast__module}\index{InstructionAST Hierarchy@{InstructionAST Hierarchy}}
3 The AST representation of an operand encapsulates the operations performed on registers and immediates to produce an operand for the machine language instruction.
4
5 The inheritance hierarchy of the AST classes is shown in Figure 3. 
6 \begin{DoxyImage}
7 \includegraphics{full_inheritance_graph}
8 \caption{The InstructionAST inheritance hierarchy}
9 \end{DoxyImage}
10  The grammar for these AST representations is simple: all leaves must be RegisterAST or Immediate nodes. These nodes may be combined using a BinaryFunction node, which may be constructed as either an addition or a multiplication. Also, a single node may descend from a Dereference node, which treats its child as a memory address. Figure 4 shows the allowable parent/child relationships within a given tree, and Figure 5 shows how an example IA32 instruction is represented using these objects. 
11 \begin{DoxyImage}
12 \includegraphics{ast_ownership}
13 \caption{InstructionAST intermediate node types and the objects they own}
14 \end{DoxyImage}
15  
16 \begin{DoxyImage}
17 \includegraphics{instruction_representation}
18 \caption{The decomposition of {\ttfamily mov} {\ttfamily \%eax}, ({\ttfamily \%esi})}
19 \end{DoxyImage}
20  These ASTs may be searched for leaf elements or subtrees (via {\ttfamily getUses} and {\ttfamily isUsed}) and traversed breadth-\/first or depth-\/first (via {\ttfamily getChildren}).
21
22 Any node in these ASTs may be evaluated. Evaluation attempts to determine the value represented by a node. If successful, it will return that value and cache it in the node. The tree structure, combined with the evaluation mechanism, allows the substitution of known register and memory values into an operand, regardless of whether those values are known at the time an instruction is decoded. More details on this mechanism may be found in \doxyref{Dyninst::InstructionAPI::Expression}{p.}{classDyninst_1_1InstructionAPI_1_1Expression}.