ParseAPI manual update
[dyninst.git] / parseAPI / doc / parseapi.tex
1 \documentclass{article}
2
3 \usepackage{booktabs}
4 \usepackage{color}
5 \usepackage{pgf}
6 \usepackage{tikz}
7 \usetikzlibrary{arrows,positioning,fit,shapes,decorations,decorations.pathmorphing,decorations.pathreplacing,calc,patterns,scopes,matrix}
8 \pgfrealjobname{parseapi}
9
10 \usepackage{helvet}
11 \usepackage{enumitem}
12 \usepackage[letterpaper]{geometry}
13 \usepackage{listings}
14 \usepackage{verbatim}
15 \usepackage[T1]{fontenc}
16
17 \setlength{\parindent}{0.0in}
18 \setlength{\parskip}{0.1in}
19
20 \newenvironment{apient}{\small\verbatim}{\endverbatim}
21
22 \newcommand{\apidesc}[1]{%
23 {\addtolength{\leftskip}{4em}%
24 #1\par\medskip}
25 }
26
27 \begin{document}
28 \thispagestyle{empty}
29
30 \begin{titlepage}
31 \beginpgfgraphicnamed{titlepage}
32 \begin{tikzpicture}[remember picture, overlay]
33     \path
34         (current page.north west) coordinate (origin)
35         (current page.north) coordinate (topcenter);
36
37     % Header
38     \node [font=\sffamily] (pppt) at ($(topcenter) - (0,1.0in)$) 
39         {\fontsize{24}{36}\selectfont Paradyn Parallel Performance Tools};
40
41     % Document Title
42 % older versions of pgf have a bug for matrices in overlay mode;
43 % have to specify positions manually
44 %    \matrix (Title) [%
45 %        matrix of nodes,%
46 %        nodes={font=\sffamily,right},%
47 %        matrix anchor=west,%
48 %        row sep=12pt
49 %        ] at ($(origin)+(0.75in,-3.0in)$)
50 %    {
51 %        \fontsize{48}{56}\selectfont ParseAPI \\
52 %        \fontsize{44}{56}\selectfont Programmer's Guide \\
53 %    };
54
55     \node [anchor=west,font=\sffamily] (title1) at ($(origin)+(0.75in,-3.0in)$)
56         {\fontsize{48}{56}\selectfont ParseAPI};
57     \node [anchor=west,font=\sffamily] (title2) at ($(title1.west)+(0in,-56pt)$)
58         {\fontsize{48}{56}\selectfont Programmer's Guide};
59
60     % Release information
61 %    \matrix (Releaseinfo) [%
62 %        matrix of nodes,%
63 %        nodes={font=\sffamily,right},%
64 %        matrix anchor=west,%
65 %        row sep=8pt
66 %        ] at ($(origin)+(0.75in,-5.0in)$)
67 %    {
68 %        %\fontsize{24}{32}\selectfont Release 0.1 \\
69 %        \fontsize{24}{32}\selectfont Beta Release \\
70 %        \fontsize{24}{32}\selectfont Oct 2010 \\
71 %    };
72
73     \node [anchor=west,font=\sffamily] (rel1) at ($(origin)+(0.75in,-5.0in)$)
74         {\fontsize{24}{32}\selectfont Beta Release};
75     \node [anchor=west,font=\sffamily] (rel2) at ($(rel1.west)+(0in,-32pt)$)
76         {\fontsize{24}{32}\selectfont Oct 2010};
77
78     % Contact information
79 %    \matrix (UWaddress) [%
80 %        matrix of nodes,%
81 %        nodes={font=\sffamily\large,right},%
82 %        matrix anchor=north west
83 %        ] at ($(origin)+(0.75in,-7in)$)
84 %    {
85 %        Computer Science Department \\
86 %        University of Wisconsin--Madison \\
87 %        Madison, WI 53711 \\
88 %    };
89
90     \node [anchor=west,font=\sffamily\large] (uw1) at ($(origin)+(0.75in,-7.0in)$)
91         {Computer Science Department};
92     \node [anchor=west,font=\sffamily\large] (uw2) at ($(uw1.west)+(0in,-20pt)$)
93         {University of Wisconsin--Madison};
94     \node [anchor=west,font=\sffamily\large] (uw3) at ($(uw2.west)+(0in,-20pt)$)
95         {Madison, WI 53711};
96
97
98 %    \matrix (UMDaddress) [%
99 %        matrix of nodes,%
100 %        nodes={font=\sffamily\large,right},%
101 %        matrix anchor=north west,
102 %        below=1em of UWaddress.south west
103 %        ]
104 %    {
105 %        Computer Science Department \\
106 %        University of Maryland \\
107 %        College Park, MD 20742 \\
108 %    };
109
110     \node [anchor=west,font=\sffamily\large] (umd1) at ($(uw3.south west)+(0in,-2.5em)$)
111         {Computer Science Department};
112     \node [anchor=west,font=\sffamily\large] (umd2) at ($(umd1.west)+(0in,-20pt)$)
113         {University of Maryland};
114     \node [anchor=west,font=\sffamily\large] (umd3) at ($(umd2.west)+(0in,-20pt)$)
115         {College Park, MD 20742};
116
117 %    \matrix (Emails) [%
118 %        matrix of nodes,%
119 %        nodes={font=\sffamily,right},%
120 %        matrix anchor=north west,%
121 %        below=1em of UMDaddress.south west,%
122 %        anchor=base
123 %        ]
124 %    {
125 %        Email & \texttt{bugs@dyninst.org} \\
126 %        Web & \texttt{www.dyninst.org} \\
127 %    };
128
129     \node [anchor=west,font=\sffamily] (email1) at ($(umd3.south west)+(-0.5em,-2.5em)$)
130         %{Email \texttt{bugs@dyninst.org}};
131         {\begin{tabular}{ll}%
132          Email & \texttt{bugs@dyninst.org} \\
133          Web & \texttt{www.dyinst.org} \\
134         \end{tabular}};
135         
136
137     % Logo
138     \path 
139         node (logo) at ($(origin)+(4.0in,-7.0in)$) [%
140             anchor=north west]
141         {%
142             \includegraphics[width=3.25in]{paradyn_logo}
143         }; 
144
145
146 \end{tikzpicture}
147 \endpgfgraphicnamed
148 \end{titlepage}
149
150 \tableofcontents
151 \clearpage
152
153 \section{Introduction}
154 \label{sec:intro}
155
156 A binary code parser converts the machine code representation of a program,
157 library, or code snippet to abstractions such as the instructions, basic
158 blocks, and functions that the binary code represents. The ParseAPI is a
159 multi-platform library for creating such abstractions from binary code sources.
160 The current incarnation uses the Dyninst SymtabAPI as the default binary code
161 source; all platforms and architectures handled by the SymtabAPI are supported.
162 The ParseAPI is designed to be easily extensible to other binary code sources.
163 Support for parsing binary code in memory dumps or other formats requires only
164 implementation of a small interface as described in this document.
165
166 This API provides the user with a control flow-oriented view of a binary code
167 source. Each code object such as a program binary or library is represented as
168 a top-level collection containing the functions, basic blocks, and edges that
169 represent the control flow graph. A simple query interface is provided for
170 retrieving lower level objects like functions and basic blocks through address
171 or other attribute lookups. These objects can be used to navigate the program
172 structure as described below.
173
174 \emph{The ParseAPI is currently released as a public beta. The interfaces
175 described in this manual are subject to change in future versions. Feedback and
176 comments are welcome; please email bugs@dyninst.org.}
177
178 \section{Abstractions}
179 \label{sec:abstractions}
180
181 The basic representation of code in this API is the control flow
182 graph (CFG). Binary code objects are represented as regions of contiguous bytes that, when parsed, form the nodes and edges of this graph. The following abstractions make up this CFG-oriented representation of binary code:
183
184 % CFG representation abastractions
185 %
186 % Function, Block, and Edge
187 \begin{itemize}[leftmargin=0pt,label=$\circ$]
188
189
190 {\item {\scshape block}: Nodes in the CFG represent \emph{basic blocks}:
191 straight line sequences of instructions $I_i \ldots I_j$ where for each $i < k
192 \le j$, $I_k$ postdominates $I_{k-1}$. Importantly, on some instruction set architectures basic blocks can \emph{overlap} on the same address range---variable length instruction sets allow for multiple interpretations of the bytes making up the basic block.
193 }
194
195 {\item {\scshape edge}: Typed edges beween the nodes in the CFG represent
196 execution control flow, such as conditional and unconditional branches,
197 fallthrough edges, and calls and returns. The graph therefore represents both
198 \emph{inter-} and \emph{intraprocedural} control flow: travseral of nodes and
199 edges can cross the boundaries of the higher level abstractions like
200 \emph{functions}.
201 }
202
203 {\item {\scshape function}: The \emph{function} is the primary semantic grouping of code in the binary, mirroring the familiar abstraction of procedural languages like C. Functions represent the set of all basic blocks reachable from a \emph{function entry point} through intraprocedural control flow only (that is, no calls or returns). Function entry points are determined in a variety of ways, such as hints from debugging symbols and recursive traversal along call edges.
204 }
205
206 \end{itemize}
207
208 % binary code representation abstractions
209 %
210 % code object, code source, and instruction source
211 \begin{itemize}[leftmargin=0pt,label=$\circ$]
212
213 {\item {\scshape code object}: A collection of distinct code regions are represented as a single code object, such as an executable or library. Code objects can normally be thought of as a single, discontiguous unique address space. However, the ParseAPI supports code objects in which the different regions have overlapping address spaces, such as UNIX archive files containing unlinked code.
214 }% end code object
215
216 {\item {\scshape instruction source}: An instruction source describes a backing store containing binary code. A binary file, a library, a memory dump or a process's executing memory image can all be described as an instruction source, allowing parsing of a variety of binary code objects.
217 }% end instruction source
218
219 {\item {\scshape code source}: The code source implements the instruction source interface, exporting methods that can access the underlying bytes of the binary code for parsing. It also exports a number of additional helper methods that do things such as returning the location of structured exception handling routines and function symbols. Code sources are tailored to particular binary types; the ParseAPI provides a SymtabAPI-based code source that understands ELF, COFF and PE file formats.
220 }% end code source
221
222 \end{itemize}
223
224 \section{A simple example}
225 \label{sec:example}
226
227 The following complete example uses the ParseAPI to parse a binary and dump its control flow graph in the Graphviz file format.
228
229 \lstset{language=[GNU]C++,basicstyle=\fontfamily{fvm}\selectfont\small}
230 \lstset{numbers=left, numberstyle=\tiny, stepnumber=5, numbersep=5pt}
231 \lstset{showstringspaces=false}
232 \lstinputlisting{example.cc}
233
234 \section{The Parsing API}
235 \label{sec:api}
236
237 \subsection{Class CodeObject}
238
239 The CodeObject class describes an individual binary code object, such as an
240 executable or library. It is the top-level container for parsing the object as
241 well as accessing that parse data. The following API routines and data types
242 are provided to support parsing and retrieving parsing products.
243
244 \begin{apient}
245 typedef ContainerWrapper<vector<Function*>,Function*,Function*> funclist
246 \end{apient}
247 \apidesc{Container for access to functions. Refer to Section \ref{sec:containers} for details. Library users \emph{must not} rely on the underlying container type of ContainerWrapper lists, as it is subject to change.}
248
249 \begin{apient}
250 CodeObject(CodeSource * cs,
251     CFGFactory * fact = NULL,
252     ParseCallback * cb = NULL,
253     bool defensiveMode = false)
254 \end{apient}
255 \apidesc{Constructs a new CodeObject from the provided CodeSource and
256 optional object factory and callback handlers. Any parsing hints provided
257 by the CodeSource are processed, but the binary is not parsed when this
258 constructor returns.
259
260 \medskip\noindent The \texttt{defensiveMode}
261 parameter optionally trades off coverage for safety; this mode is not
262 recommended for most applications as it makes very conservative assumptions
263 about control flow transfer instructions (see Section \ref{sec:defmode}.}
264
265 \begin{apient}
266 void parse()
267 \end{apient}
268 \apidesc{Recursively parses the binary represented by this CodeObject from all
269 known function entry points (i.e., the hints provided by the CodeSource). This
270 method and the following parsing methods may safely be invoked repeatedly if
271 new information about function locations is provided through the CodeSource.}
272
273 \begin{apient}
274 void parse(Address target, bool recursive)
275 \end{apient}
276 \apidesc{Parses the binary starting with the instruction at the provided target address. If \texttt{recursive} is {\scshape true}, recursive traversal parsing is used as in the default \texttt{parse()} method; otherwise only instructions reachable through intraprocedural control flow are visited.}
277
278 \begin{apient}
279 void parseGaps(CodeRegion *cr)
280 \end{apient}
281 \apidesc{Speculatively parse the indicated region of the binary using pattern matching to find likely function entry points. Only enabled on the x86 32-bit platform.}
282
283 \begin{apient}
284 Function * findFuncByEntry(CodeRegion * cr, Address entry)
285 \end{apient}
286 \apidesc{Find the function starting at address \texttt{entry} in the indicated CodeRegion. Returns {\scshape null} if no such function exists.}
287
288 \begin{apient}
289 int findFuncs(CodeRegion * cr, Address addr, std::set<Function*> & funcs)
290 \end{apient}
291 \apidesc{Finds all functions spanning \texttt{addr} in the code region, adding each to \texttt{funcs}. The number of results of this stabbing query are returned.}
292
293 \begin{apient}
294 funclist & funcs()
295 \end{apient}
296 \apidesc{Returns a reference to a container of all functions in the binary. Refer to Section \ref{sec:containers} for container access details.}
297
298 \begin{apient}
299 Block * findBlockByEntry(CodeRegion * cr, Address entry)
300 \end{apient}
301 \apidesc{Find the basic block starting at address \texttt{entry}. Returns {\scshape null} if no such block exists.}
302
303 \begin{apient}
304 int findBlocks(CodeRegion * cr, Address addr, std::set<Block*> & blocks)
305 \end{apient}
306 \apidesc{Finds all blocks spanning \texttt{addr} in the code region, adding each to \texttt{blocks}. Multiple blocks can be returned only on platforms with variable-length instruction sets (such as IA32) for which overlapping instructions are possible; at most one block will be returned on all other platforms.}
307
308 \begin{apient}
309 void finalize()
310 \end{apient}
311 \apidesc{Force complete parsing of the CodeObject; parsing operations are otherwise completed only as needed to answer queries.}
312
313 \begin{apient}
314 CodeSource * cs()
315 \end{apient}
316 \apidesc{Return a reference to the underlying CodeSource.}
317
318 \begin{apient}
319 CFGFactory * fact()
320 \end{apient}
321 \apidesc{Return a reference to the CFG object factory.}
322
323 \subsection{Class CodeSource}
324 \label{sec:codesource}
325
326 The CodeSource interface is used by the ParseAPI to retrieve binary code from
327 an executable, library, or other binary code object; it also can provide hints
328 of function entry points (such as those derived from debugging symbols) to seed
329 the parser. The ParseAPI provides a default implementation based on the
330 SymtabAPI that supports many common binary formats. For details on implementing
331 a custom CodeSource, see Appendix \ref{sec:extend}.
332
333 \begin{apient}
334 virtual bool nonReturning(Address func_entry)
335 virtual bool nonReturning(std::string func_name)
336 \end{apient}
337 \apidesc{Looks up whether a function returns (by name or location). This information may be statically known for some code sources, and can lead to better parsing accuracy.}
338
339 \begin{apient}
340 virtual Address baseAddress()
341 virtual Address loadAddress()
342 \end{apient}
343 \apidesc{If the binary file type supplies non-zero base or load addresses (e.g. Windows PE), implementations should override these functions.}
344
345 \begin{apient}
346 std::map< Address, std::string > & linkage()
347 \end{apient}
348 \apidesc{Returns a reference to the external linkage map, which may or may not be filled in for a particular CodeSource implementation.}
349
350 \begin{apient}
351 std::vector<CodeRegion *> const& regions()
352 \end{apient}
353 \apidesc{Returns a read-only vector of code regions within the binary represented by this code source.}
354
355 \begin{apient}
356 int findRegions(Address addr, set<CodeRegion *> & ret)
357 \end{apient}
358 \apidesc{Finds all CodeRegion objects that overlap the provided address. Some code sources (e.g. archive files) may have several regions with overlapping address ranges; others (e.g. ELF binaries) do not.}
359
360 \begin{apient}
361 bool regionsOverlap() 
362 \end{apient}
363 \apidesc{Indicates whether the CodeSource contains overlapping regions.}
364
365 \subsection{Class CodeRegion}
366
367 The CodeRegion interface is an accounting structure used to divide CodeSources into distinct regions. This interface is mostly of interest to CodeSource implementors.
368
369 \begin{apient}
370 void names(Address addr, vector<std::string> & names)
371 \end{apient}
372 \apidesc{Fills the provided vector with any names associated with the function at a given address in the region, e.g. symbol names in an ELF or PE binary.}
373
374 \begin{apient}
375 virtual bool findCatchBlock(Address addr, Address & catchStart)
376 \end{apient}
377 \apidesc{Finds the exception handler associated with an address, if one exists. This routine is only implemented for binary code sources that support structured exception handling, such as the SymtabAPI-based SymtabCodeSource provided as part of the ParseAPI.}
378
379 \begin{apient}
380 Address low()
381 \end{apient}
382 \apidesc{The lower bound of the interval of address space covered by this region.}
383
384 \begin{apient}
385 Address high()
386 \end{apient}
387 \apidesc{The upper bound of the interval of address space covered by this region.}
388
389 \begin{apient}
390 bool contains(Address addr)
391 \end{apient}
392 \apidesc{Returns {\scshape true} if $\texttt{addr} \in [\texttt{low()},\texttt{high()})$, {\scshape false} otherwise.}
393
394 \subsection{Class Function}
395
396 The Function class represents the protion of the program CFG that is reachable through intraprocedural control flow transfers from the function's entry block. Functions in the ParseAPI have only a single entry point; multiple-entry functions such as those found in Fortran programs are represented as several functions that ``share'' a subset of the CFG. 
397
398 \begin{center}
399 \begin{tabular}{ll}
400 \toprule
401 FuncSource & Meaning \\
402 \midrule
403 RT & recursive traversal (default) \\
404 HINT & specified in CodeSource hints \\
405 GAP & speculative parsing heuristics \\
406 GAPRT & recursive traversal from speculative parse \\
407 ONDEMAND & dynamically discovered at runtime \\
408 \bottomrule
409 \end{tabular}
410 \end{center}
411
412 \apidesc{Return type of function \texttt{src()} see description below.}
413
414 \begin{center}
415 \begin{tabular}{ll}
416 \toprule
417 FuncReturnStatus & Meaning \\
418 \midrule
419 UNSET & unparsed function (default) \\
420 NORETURN & will not return \\
421 UNKNOWN & cannot be determined statically \\
422 RETURN & may return \\
423 \bottomrule
424 \end{tabular}
425 \end{center}
426
427 \apidesc{Return type of function \texttt{retstatus()}, see description below.}
428
429 \begin{apient}
430 typedef ContainerWrapper<vector<Block*>,Block*,Block*> blocklist
431 typedef ContainerWrapper<vector<Edge*>,Edge*,Edge*> edgelist
432 \end{apient}
433 \apidesc{Containers for block and edge access. Refer to Section \ref{sec:containers} for details on \texttt{ContainerWrapper}. Library users \emph{must not} rely on the underlying container type of ContainerWrapper lists, as it is subject to change.}
434
435 \begin{apient}
436 const string & name()
437 \end{apient}
438 \apidesc{Returns the name of this function.}
439
440 \begin{apient}
441 CodeRegion * region()
442 \end{apient}
443 \apidesc{Returns the CodeRegion that contains this function's entry point (functions can span multiple regions).}
444
445 \begin{apient}
446 InstructionSource * isrc()
447 \end{apient}
448 \apidesc{Returns the InstructionSource for this function.}
449
450 \begin{apient}
451 CodeObject * obj()
452 \end{apient}
453 \apidesc{Returns the CodeObject containing this function.}
454
455 \begin{apient}
456 FuncSource src()
457 \end{apient}
458 \apidesc{Returns the type of hint that identified this function's entry point.}
459
460 \begin{apient}
461 FuncReturnStatus retstatus()
462 \end{apient}
463 \apidesc{Returns the best-effort determination of whether this function may return or not. Return status cannot always be statically determined, and at most can guarantee that a function \emph{may} return, not that it \emph{will} return.}
464
465 \begin{apient}
466 Block * entry()
467 \end{apient}
468 \apidesc{Returns the basic block at this function's entry point.}
469
470 \begin{apient}
471 bool parsed()
472 \end{apient}
473 \apidesc{Indicates whether this function has been parsed.}
474
475 \begin{apient}
476 blocklist & blocks()
477 \end{apient}
478 \apidesc{Returns a list of the basic blocks comprised by this function. The blocks are guaranteed to be sorted by starting address.}
479
480 \begin{apient}
481 bool contains(Block *b)
482 \end{apient}
483 \apidesc{Returns {\scshape true} if the block is contained in this function.}
484
485 \begin{apient}
486 edgelist & callEdges()
487 \end{apient}
488 \apidesc{Returns a list of all outgoing call edges from this function.}
489
490 \begin{apient}
491 blocklist & returnBlocks()
492 \end{apient}
493 \apidesc{Returns a list of all blocks ending in a \texttt{return} instruction.}
494
495 \begin{apient}
496 std::vector<FuncExtent *> const& extents()
497 \end{apient}
498 \apidesc{Returns a list of contiguous extents of binary code within the function.}
499
500 [The following methods provide additional details about functions to support instrumentation applications and are probably of no interest to most users.]
501
502 \begin{apient}
503 bool hasNoStackFrame()
504 \end{apient}
505 \apidesc{Indicates whether the function sets up a stack frame.}
506
507 \begin{apient}
508 bool savesFramePointer()
509 \end{apient}
510 \apidesc{Indicates whether the function saves a stack frame pointer.}
511
512 \begin{apient}
513 bool cleansOwnStack()
514 \end{apient}
515 \apidesc{Indicates whether the function tears down its own stack on return.}
516
517 \subsection{Class FuncExtent}
518
519 Function Extents are used internally for accounting and lookup purposes. They may be useful for users who wish to precisely identify the ranges of the address space spanned by functions (functions are often discontiguous, particularly on architectures with variable length instruction sets).
520
521 \begin{apient}
522 Address start()
523 \end{apient}
524 \apidesc{The start of this contiguous code extent.}
525
526 \begin{apient}
527 Address end()
528 \end{apient}
529 \apidesc{The end of this contiguous code extent (exclusive).}
530
531 \subsection{Class Block}
532
533 A Block represents a basic block as defined in Section \ref{sec:abstractions}, and is the lowest level representation of code in the CFG.
534
535 \begin{apient}
536 typedef ContainerWrapper<vector<Edge*>,Edge*,Edge*> edgelist
537 \end{apient}
538 \apidesc{Container for edge access. Refer to Section \ref{sec:containers} for details. Library users \emph{must not} rely on the underlying container type of ContainerWrapper lists, as it is subject to change.}
539
540
541 \begin{apient}
542 Address start()
543 \end{apient}
544 \apidesc{Returns the lower bound of this block (the address of the first instruction).}
545
546 \begin{apient}
547 Address end()
548 \end{apient}
549 \apidesc{Returns the upper bound (open) of this block (the address immediately
550 following the last byte in the last instruction). }
551
552 \begin{apient}
553 Address lastInsnAddr()
554 \end{apient}
555 \apidesc{Returns the address of the last instruction in this block.}
556
557 \begin{apient}
558 Address size()
559 \end{apient}
560 \apidesc{Returns $\texttt{end()} - \texttt{start()}$.}
561
562 \begin{apient}
563 bool parsed()
564 \end{apient}
565 \apidesc{Indicates whether this block has been parsed.}
566
567 \begin{apient}
568 CodeObject * obj()
569 \end{apient}
570 \apidesc{Returns the CodeObject containing this block.}
571
572 \begin{apient}
573 CodeRegion * region()
574 \end{apient}
575 \apidesc{Returns the CodeRegion containing this block.}
576
577 \begin{apient}
578 edgelist & sources()
579 \end{apient}
580 \apidesc{Return a list of all incomming edges to the block.}
581
582 \begin{apient}
583 edgelist & targets()
584 \end{apient}
585 \apidesc{Return a list of all outgoing edges from the block.}
586
587 \begin{apient}
588 bool consistent(Address addr, Address & prev_insn)
589 \end{apient}
590 \apidesc{Check whether address \texttt{addr} is \emph{consistent} with this basic block. An address is consistent if it is the boundary between two instructions in the block. As long as \texttt{addr} is within the range of the block, \texttt{prev\_insn} will contain the address of the previous instruction boundary before \texttt{addr}, regardless of whether \texttt{addr} is consistent or not.}
591
592 \begin{apient}
593 int containingFuncs()
594 \end{apient}
595 \apidesc{Returns the number of functions that contain this block.}
596
597 \begin{apient}
598 void getFuncs(std::vector<Function *> & funcs)
599 \end{apient}
600 \apidesc{Fills in the provided vector with all functions that share this basic block.}
601
602 \subsection{Class Edge}
603
604 Typed Edges join two blocks in the CFG, indicating the type of control flow
605 transfer instruction that joins the blocks to each other. Edges may not correspond
606 to a control flow transfer instruction at all, as in the case of the {\scshape
607 fallthrough} edge that indicates where straight-line control flow is split by
608 incoming transfers from another location, such as a branch. While not all
609 blocks end in a control transfer instruction, all control transfer instructions
610 end basic blocks and have outgoing edges; in the case of unresolvable control
611 flow, the edge will target a special ``sink'' block (see \texttt{sinkEdge()},
612 below.
613
614 \begin{center}
615 \begin{tabular}{ll}
616 \toprule
617 EdgeTypeEnum & Meaning \\
618 \midrule
619 CALL & call edge \\
620 COND\_TAKEN & conditional branch--taken \\
621 COND\_NOT\_TAKEN & conditional branch--not taken \\
622 INDIRECT & branch indirect \\
623 DIRECT & branch direct \\
624 FALLTHROUGH & direct fallthrough (no branch) \\
625 CATCH & exception handler \\
626 CALL\_FT & post-call fallthrough \\
627 RET & return \\
628 \bottomrule
629 \end{tabular}
630 \end{center}
631
632 \begin{apient}
633 Block * src()
634 \end{apient}
635 \apidesc{Returns the source block of this edge.}
636
637 \begin{apient}
638 Block * trg()
639 \end{apient}
640 \apidesc{Returns the target block of this edge.}
641
642 \begin{apient}
643 EdgeTypeEnum type()
644 \end{apient}
645 \apidesc{Returns the edge type.}
646
647 \begin{apient}
648 bool sinkEdge()
649 \end{apient}
650 \apidesc{Indicates whether this edge targets the special \emph{sink} block.}
651
652 \begin{apient}
653 bool interproc()
654 \end{apient}
655 \apidesc{Returns {\scshape true} if the edge should be interpreted as interprocedural (e.g. calls, returns, direct branches under certain circumstances).}
656
657 \subsection{Class EdgePredicate}
658 \label{sec:pred}
659
660 Edge predicates control iteration over edges. For example, the provided
661 \texttt{Intraproc} edge predicate can be passed to an edge iterator
662 constructor, ensuring that only intraprocedural edges are visited during
663 iteration. Two other implementations of EdgePredicate are provided: 
664 \texttt{SingleContext} only visits edges that stay in a single
665 function context, and \texttt{NoSinkPredicate} does not visit edges to 
666 the \emph{sink} block.  The following code traverses 
667 all of the basic blocks within a
668 function:
669
670 \lstset{language=[GNU]C++,basicstyle=\fontfamily{fvm}\selectfont\small}
671 \lstset{numbers=left, numberstyle=\tiny, stepnumber=5, numbersep=5pt}
672 \begin{lstlisting}
673     vector<Block*> work;
674     std::map<Block*,bool> seen; // avoid loops
675     Intraproc epred; // ignore calls, returns
676    
677     work.push_back(func->entry()); // assuming `func' is a Function*
678     seen[func->entry()] = true;
679     while(!work.empty()) {
680         Block * b = work.back();
681         work.pop_back();
682
683         // do some stuff with b...
684    
685         Block::edgelist & targets = block->targets();
686         Block::edgelist::iterator eit = targets.begin(&epred);
687         for( ; eit != targets.end(); ++eit) {
688             Edge * e = (*eit);
689             if(seen.find(e->trg()) == seen.end())
690                 work.push_back(e->trg());
691         }
692     } 
693 \end{lstlisting}
694
695 New edge predicates can be created by implementing the following simple interface:
696
697 \begin{apient}
698 EdgePredicate()
699 EdgePredicate(EdgePredicate * next)
700 \end{apient}
701 \apidesc{Constructs a predicate, either with or without a previously existing predicate to chain it to. Chained predicates return the logical AND over all predicates in the chain.}
702
703 \begin{apient}
704 virtual bool pred_impl(Edge *)
705 \end{apient}
706 \apidesc{Evaluates the predicate on the provided edge.}
707
708 \subsection{Class ParseCallback}
709
710 The ParseCallback class allows ParseAPI users to be notified of various events
711 during parsing. For most users this notification is unnecessary, and an
712 instantiation of the default ParseCallback can be passed to the CodeObject during initialization. Users who wish to be notified must implement a class that inherits from ParseCallback, and implement one or more of the methods described below to receive notification of those events.
713
714 \begin{apient}
715 struct default_details {
716     default_details(unsigned char*b,size_t s, bool ib) : ibuf(b), isize(s), isbranch(ib) { }
717     unsigned char * ibuf;
718     size_t isize;
719     bool isbranch;
720 }
721 \end{apient}
722 \apidesc{Details used in the \texttt{unresolved\_cf} and \texttt{abruptEnd\_cf}
723 callbacks.}
724
725 \begin{apient}
726 virtual void instruction_cb(Function*,Address,insn_details*)
727 \end{apient}
728 \apidesc{Invoked for each instruction decoded during parsing. Implementing this callback may incur significant overhead.}
729
730 \begin{apient}
731 struct insn_details {
732     InsnAdapter::InstructionAdapter * insn;
733 }
734 \end{apient}
735
736 \begin{apient}
737 void interproc_cf(Function*,Address,interproc_details*)
738 \end{apient}
739 \apidesc{Invoked for each interprocedural control flow instruction.}
740
741 \begin{apient}  
742 struct interproc_details {
743     typedef enum {
744         ret,
745         call,
746         branch_interproc, // tail calls, branches to plts
747         syscall
748     } type_t;
749     unsigned char * ibuf;
750     size_t isize;
751     type_t type;
752     union {
753         struct {
754             Address target;
755             bool absolute_address;
756             bool dynamic_call;
757         } call;
758     } data;
759 }
760 \end{apient}
761 \apidesc{Details used in the \texttt{interproc\_cf} callback.}
762
763 \begin{apient}
764 void overlapping_blocks(Block*,Block*)
765 \end{apient}
766 \apidesc{Noification of inconsistent parse data (overlapping blocks).}
767
768 \subsection{Containers}
769 \label{sec:containers}
770
771 Several of the ParseAPI data structures export containers of CFG objects; the
772 CodeObject provides a list of functions in the binary, for example, while
773 functions provide lists of blocks and so on. To avoid tying the internal
774 storage for these structures to any particular container type, ParseAPI objects
775 export a ContainerWrapper that provides an iterator interface to the internal
776 containers. These wrappers and predicate interfaces are designed to add minimal
777 overhead while protecting ParseAPI users from exposure to internal container
778 storage details. Users \emph{must not} rely on properties of the underlying
779 container type (e.g. storage order) unless that property is explicity stated in
780 this manual.
781
782 \noindent
783 ContainerWrapper containers export the following interface (\texttt{iterator} types vary depending on the template parameters of the ContainerWrapper, but are always instantiations of the PredicateIterator described below):
784
785 \begin{apient}
786 iterator begin()
787 iterator begin(predicate *)
788 \end{apient}
789 \apidesc{Return an iterator pointing to the beginning of the container, with or without a filtering predicate implementation (see Section \ref{sec:pred} for details on filter predicates).}
790
791 \begin{apient}
792 iterator const& end()
793 \end{apient}
794 \apidesc{Return the iterator pointing to the end of the container (past the last element).}
795
796 \begin{apient}
797 size_t size()
798 \end{apient}
799 \apidesc{Returns the number of elements in the container. Execution cost may vary depending on the underlying container type.}
800
801 \begin{apient}
802 bool empty()
803 \end{apient}
804 \apidesc{Indicates whether the container is empty or not.}
805
806 \noindent
807 The elements in ParseAPI containers can be accessed by iteration using an instantiation of the PredicateIterator. These iterators can optionally act as filters, evaluating a boolean predicate for each element and only returning those elements for which the predicate returns {\scshape true}. \emph{Iterators with non-{\scshape null} predicates may return fewer elements during iteration than their \texttt{size()} method indicates.} Currently PredicateIterators only support forward iteration. The operators \texttt{++} (prefix and postfix), \texttt{==}, \texttt{!=}, and \texttt{*} (dereference) are supported.
808
809
810 \appendix
811 \section{Extending ParseAPI}
812 \label{sec:extend}
813
814 The ParseAPI is design to be a low level toolkit for binary analysis tools.
815 Users can extend the ParseAPI in two ways: by extending the control flow
816 structures (Functions, Blocks, and Edges) to incorporate additional data to
817 support various analysis applications, and by adding additional binary code
818 sources that are unsupported by the default SymtabAPI-based code source. For
819 example, a code source that represents a program image in memory could be
820 implemented by fulfilling the CodeSource and InstructionSource interfaces
821 described in Section \ref{sec:codesource} and below. Implementations that
822 extend the CFG structures need only provide a custom allocation factory in
823 order for these objects to be allocated during parsing.
824
825 \subsection{Instruction and Code Sources}
826
827 A CodeSource, as described above, exports its own and the InstructionSource interface for access to binary code and other details. In addition to implementing the virtual methods in the CodeSource base class (Section \ref{sec:codesource}), the methods in the pure-virtual InstructionSource class must be implemented:
828
829 \begin{apient}
830 virtual bool isValidAddress(const Address) 
831 \end{apient}
832 \apidesc{Returns {\scshape true} if the address is a valid code location.}
833
834 \begin{apient}
835 virtual void* getPtrToInstruction(const Address)
836 \end{apient}
837 \apidesc{Returns pointer to raw memory in the binary at the provided address.}
838
839 \begin{apient}
840 virtual void* getPtrToData(const Address)
841 \end{apient}
842 \apidesc{Returns pointer to raw memory in the binary at the provided address. The address need not correspond to an executable code region.}
843
844 \begin{apient}
845 virtual unsigned int getAddressWidth()
846 \end{apient}
847 \apidesc{Returns the address width (e.g. four or eight bytes) for the represented binary.}
848
849 \begin{apient}
850 virtual bool isCode(const Address)
851 \end{apient}
852 \apidesc{Indicates whether the location is in a code region.}
853
854 \begin{apient}
855 virtual bool isData(const Address)
856 \end{apient}
857 \apidesc{Indicates whether the location is in a data region.}
858
859 \begin{apient}
860 virtual Address offset()
861 \end{apient}
862 \apidesc{The start of the region covered by this instruction source.}
863
864 \begin{apient}
865 virtual Address length()
866 \end{apient}
867 \apidesc{The size of the region.}
868
869 \begin{apient}
870 virtual Architecture getArch()
871 \end{apient}
872 \apidesc{The architecture of the instruction source. See the Dyninst manual for details on architecture differences.}
873
874 \begin{apient}
875 virtual bool isAligned(const Address)
876 \end{apient}
877 \apidesc{For fixed-width instruction architectures, must return {\scshape true} if the address is a valid instruction boundary and {\scshape false} otherwise; otherwise returns {\scshape true}. This method has a default implementation that should be sufficient.}
878
879 CodeSource implementors need to fill in several data structures in the base CodeSource class:
880
881 \begin{apient}
882 std::map<Address, std::string> _linkage
883 \end{apient}
884 \apidesc{Entries in the linkage map represent external linkage, e.g. the PLT in ELF binaries. Filling in this map is optional.}
885
886 \begin{apient}
887 Address _table_of_contents
888 \end{apient}
889 \apidesc{Many binary format have ``table of contents'' structures for position
890 independant references. If such a structure exists, its address should be filled in.}
891
892 \begin{apient}
893 std::vector<CodeRegion *> _regions
894 Dyninst::IBSTree<CodeRegion> _region_tree
895 \end{apient}
896 \apidesc{One or more contiguous regions of code or data in the binary object must be registered with the base class. Keeping these structures in sync is the responsibility of the implementing class.}
897
898 \begin{apient}
899 std::vector<Hint> _hints
900 \end{apient}
901 \apidesc{CodeSource implementors can supply a set of Hint objects describing where functions are known to start in the binary. These hints are used to seed the parsing algorithm. Refer to the CodeSource header file for implementation details.}
902
903 \subsection{CFG Object Factories}
904 \label{sec:factories}
905
906 Users who which to incorporate the ParseAPI into large projects may need to store additional information about CFG objects like Functions, Blocks, and Edges. The simplest way to associate the ParseAPI-level CFG representation with higher-level implementation is to extend the CFG classes provided as part of the ParseAPI. Because the parser itself does not know how to construct such extended types, implementors must provide an implementation of the CFGFactory that is specialized for their CFG classes. The CFGFactory exports the following simple interface:
907
908 \begin{apient}
909 virtual Function * mkfunc(Address addr, 
910     FuncSource src,
911     std::string name, 
912     CodeObject * obj, 
913     CodeRegion * region,
914     Dyninst::InstructionSource * isrc)
915 \end{apient}
916 \apidesc{Returns an object derived from Function as though the provided parameters had been passed to the Function constructor. The ParseAPI parser will never invoke \texttt{mkfunc()} twice with identical \texttt{addr}, and \texttt{region} parameters---that is, Functions are guaranteed to be unique by address within a region.}
917
918 \begin{apient}
919 virtual Block * mkblock(Function * func, CodeRegion * region, Address addr)
920 \end{apient}
921 \apidesc{Returns an object derived from Block as though the provided parameters had been passed to the Block constructor. The parser will never invoke \texttt{mkblock()} with identical \texttt{addr} and \texttt{region} parameters.}
922
923 \begin{apient}
924 virtual Edge * mkedge(Block * src, Block * trg, EdgeTypeEnum type)
925 \end{apient}
926 \apidesc{Returns an object derived from Edge as though the provided parameters had been passed to the Edge constructor. The parser \emph{may} invoke \texttt{mkedge()} multiple times with identical parameters.}
927
928 \begin{apient}
929 virtual Block * mksink(CodeObject *obj, CodeRegion *r)
930 \end{apient}
931 \apidesc{Returns a ``sink'' block derived from Block to which all unresolvable control flow instructions will be linked. Implementors may return a unique sink block per CodeObject or a single global sink.}
932
933 Implementors of extended CFG classes are required to override the default implementations of the \emph{mk*} functions to allocate and return the appropriate derived types statically cast to the base type. Implementors must also add all allocated objects to the following internal lists:
934
935 \begin{apient}
936 fact_list<Edge> edges_
937 fact_list<Block> blocks_
938 fact_list<Function> funcs_
939 \end{apient}
940 \apidesc{O(1) allocation lists for CFG types. See the CFG.h header file for list insertion and removal operations.}
941
942 Implementors \emph{may} but are \emph{not required to} override the
943 deallocation following deallocation routines. The primary reason to override
944 these routines is if additional action or cleanup is necessary upon CFG object
945 release; the default routines simply remove the objects from the allocation
946 list and invoke their destructors.
947
948 \begin{apient}
949 virtual void free_func(Function * f)
950 virtual void free_block(Block * b)
951 virtual void free_edge(Edge * e)
952 virtual void free_all()
953 \end{apient}
954 \apidesc{CFG objects should be freed using these functions, rather than delete, to avoid leaking memory.}
955
956 \section{Defensive Mode Parsing}
957 \label{sec:defmode}
958
959 Binary code that defends itself against analysis may violate the
960 assumptions made by the the ParseAPI's standard parsing algorithm.
961 Enabling defensive mode parsing activates more conservative
962 assumptions that substantially reduce the percentage of code that is
963 analyzed by the ParseAPI.  For this reason, defensive mode parsing is
964 best-suited for use of ParseAPI in conjunction with dynamic analysis
965 techniques that can compensate for its limited coverage of the binary
966 code.  This mode of parsing will be brought to full functionality in 
967 an upcoming release.  
968
969 \end{document}