InstructionAPI .tex files for DOxygen->regular LaTeX update, and 8.0 versioning
[dyninst.git] / instructionAPI / doc / latex / classDyninst_1_1InstructionAPI_1_1Operation.tex
1 \subsection{Operation Class}
2 \label{classDyninst_1_1InstructionAPI_1_1Operation}\index{Dyninst::InstructionAPI::Operation@{Dyninst::InstructionAPI::Operation}}
3 \subsubsection*{Public Member Functions}
4 \begin{DoxyCompactItemize}
5 \item 
6  std::string {\textbf format} () const 
7 \item 
8  entryID {\textbf getID} () const 
9 \item 
10  prefixEntryID {\textbf getPrefixID} () const 
11 \end{DoxyCompactItemize}
12
13
14
15 An Operation object represents a family of opcodes (operation encodings) that perform the same task (e.g. the {\ttfamily MOV} family). It includes information about the number of operands, their read/write semantics, the implicit register reads and writes, and the control flow behavior of a particular assembly language operation. It additionally provides access to the assembly mnemonic, which allows any semantic details that are not encoded in the Instruction representation to be added by higher layers of analysis.
16
17 As an example, the {\ttfamily CMP} operation on IA32/AMD64 processors has the following properties:
18 \begin{DoxyItemize}
19 \item Operand 1 is read, but not written
20 \item Operand 2 is read, but not written
21 \item The following flags are written:
22 \begin{DoxyItemize}
23 \item Overflow
24 \item Sign
25 \item Zero
26 \item Parity
27 \item Carry
28 \item Auxiliary
29 \end{DoxyItemize}
30 \item No other registers are read, and no implicit memory operations are performed
31 \end{DoxyItemize}
32
33 Operations are constructed by the InstructionDecoder as part of the process of constructing an Instruction. 
34
35 \subsubsection{Member Functions}
36 \index{Dyninst::InstructionAPI::Operation@{Dyninst::InstructionAPI::Operation}!format@{format}}
37 \index{format@{format}!Dyninst::InstructionAPI::Operation@{Dyninst::InstructionAPI::Operation}}
38 \paragraph[{format}]{\setlength{\rightskip}{0pt plus 5cm}std::string format (
39 \begin{DoxyParamCaption}
40 {}
41 \end{DoxyParamCaption}
42 ) const}\hfill\label{classDyninst_1_1InstructionAPI_1_1Operation_a204c75f752ee13cb64ccc2b7af3f687c}
43 Returns the mnemonic for the operation. Like {\ttfamily instruction::format}, this is exposed for debugging and will be replaced with stream operators in the public interface. \index{Dyninst::InstructionAPI::Operation@{Dyninst::InstructionAPI::Operation}!getID@{getID}}
44 \index{getID@{getID}!Dyninst::InstructionAPI::Operation@{Dyninst::InstructionAPI::Operation}}
45 \paragraph[{getID}]{\setlength{\rightskip}{0pt plus 5cm}entryID getID (
46 \begin{DoxyParamCaption}
47 {}
48 \end{DoxyParamCaption}
49 ) const}\hfill\label{classDyninst_1_1InstructionAPI_1_1Operation_a36f4818569bf4881244ab4a4c7f2ba06}
50 Returns the entry ID corresponding to this operation. Entry IDs are enumerated values that correspond to assembly mnemonics. \index{Dyninst::InstructionAPI::Operation@{Dyninst::InstructionAPI::Operation}!getPrefixID@{getPrefixID}}
51 \index{getPrefixID@{getPrefixID}!Dyninst::InstructionAPI::Operation@{Dyninst::InstructionAPI::Operation}}
52 \paragraph[{getPrefixID}]{\setlength{\rightskip}{0pt plus 5cm}prefixEntryID getPrefixID (
53 \begin{DoxyParamCaption}
54 {}
55 \end{DoxyParamCaption}
56 ) const}\hfill\label{classDyninst_1_1InstructionAPI_1_1Operation_a8ae500d97f21b771c252a6814fcf5c4a}
57 Returns the prefix entry ID corresponding to this operation, if any. Prefix IDs are enumerated values that correspond to assembly prefix mnemonics.