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