Update copyright
[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 7. 0 Release};
75     \node [anchor=west,font=\sffamily] (rel2) at ($(rel1.west)+(0in,-32pt)$)
76         {\fontsize{24}{32}\selectfont Mar 2011};
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 int findFuncs(CodeRegion * cr, Address start, Address end, std::set<Function*> & funcs)
295 \end{apient}
296 \apidesc{Finds all functions overlapping the range \texttt{[start,end)} in the code region, adding each to \texttt{funcs}. The number of results of this stabbing query are returned.}
297
298 \begin{apient}
299 funclist & funcs()
300 \end{apient}
301 \apidesc{Returns a reference to a container of all functions in the binary. Refer to Section \ref{sec:containers} for container access details.}
302
303 \begin{apient}
304 Block * findBlockByEntry(CodeRegion * cr, Address entry)
305 \end{apient}
306 \apidesc{Find the basic block starting at address \texttt{entry}. Returns {\scshape null} if no such block exists.}
307
308 \begin{apient}
309 int findBlocks(CodeRegion * cr, Address addr, std::set<Block*> & blocks)
310 \end{apient}
311 \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.}
312
313 \begin{apient}
314 void finalize()
315 \end{apient}
316 \apidesc{Force complete parsing of the CodeObject; parsing operations are otherwise completed only as needed to answer queries.}
317
318 \begin{apient}
319 CodeSource * cs()
320 \end{apient}
321 \apidesc{Return a reference to the underlying CodeSource.}
322
323 \begin{apient}
324 CFGFactory * fact()
325 \end{apient}
326 \apidesc{Return a reference to the CFG object factory.}
327
328 \subsection{Class CodeSource}
329 \label{sec:codesource}
330
331 The CodeSource interface is used by the ParseAPI to retrieve binary code from
332 an executable, library, or other binary code object; it also can provide hints
333 of function entry points (such as those derived from debugging symbols) to seed
334 the parser. The ParseAPI provides a default implementation based on the
335 SymtabAPI that supports many common binary formats. For details on implementing
336 a custom CodeSource, see Appendix \ref{sec:extend}.
337
338 \begin{apient}
339 virtual bool nonReturning(Address func_entry)
340 virtual bool nonReturning(std::string func_name)
341 \end{apient}
342 \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.}
343
344 \begin{apient}
345 virtual Address baseAddress()
346 virtual Address loadAddress()
347 \end{apient}
348 \apidesc{If the binary file type supplies non-zero base or load addresses (e.g. Windows PE), implementations should override these functions.}
349
350 \begin{apient}
351 std::map< Address, std::string > & linkage()
352 \end{apient}
353 \apidesc{Returns a reference to the external linkage map, which may or may not be filled in for a particular CodeSource implementation.}
354
355 \begin{apient}
356 std::vector<CodeRegion *> const& regions()
357 \end{apient}
358 \apidesc{Returns a read-only vector of code regions within the binary represented by this code source.}
359
360 \begin{apient}
361 int findRegions(Address addr, set<CodeRegion *> & ret)
362 \end{apient}
363 \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.}
364
365 \begin{apient}
366 bool regionsOverlap() 
367 \end{apient}
368 \apidesc{Indicates whether the CodeSource contains overlapping regions.}
369
370 \subsection{Class CodeRegion}
371
372 The CodeRegion interface is an accounting structure used to divide CodeSources into distinct regions. This interface is mostly of interest to CodeSource implementors.
373
374 \begin{apient}
375 void names(Address addr, vector<std::string> & names)
376 \end{apient}
377 \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.}
378
379 \begin{apient}
380 virtual bool findCatchBlock(Address addr, Address & catchStart)
381 \end{apient}
382 \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.}
383
384 \begin{apient}
385 Address low()
386 \end{apient}
387 \apidesc{The lower bound of the interval of address space covered by this region.}
388
389 \begin{apient}
390 Address high()
391 \end{apient}
392 \apidesc{The upper bound of the interval of address space covered by this region.}
393
394 \begin{apient}
395 bool contains(Address addr)
396 \end{apient}
397 \apidesc{Returns {\scshape true} if $\texttt{addr} \in [\texttt{low()},\texttt{high()})$, {\scshape false} otherwise.}
398
399 \subsection{Class Function}
400
401 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. 
402
403 \begin{center}
404 \begin{tabular}{ll}
405 \toprule
406 FuncSource & Meaning \\
407 \midrule
408 RT & recursive traversal (default) \\
409 HINT & specified in CodeSource hints \\
410 GAP & speculative parsing heuristics \\
411 GAPRT & recursive traversal from speculative parse \\
412 ONDEMAND & dynamically discovered at runtime \\
413 \bottomrule
414 \end{tabular}
415 \end{center}
416
417 \apidesc{Return type of function \texttt{src()} see description below.}
418
419 \begin{center}
420 \begin{tabular}{ll}
421 \toprule
422 FuncReturnStatus & Meaning \\
423 \midrule
424 UNSET & unparsed function (default) \\
425 NORETURN & will not return \\
426 UNKNOWN & cannot be determined statically \\
427 RETURN & may return \\
428 \bottomrule
429 \end{tabular}
430 \end{center}
431
432 \apidesc{Return type of function \texttt{retstatus()}, see description below.}
433
434 \begin{apient}
435 typedef ContainerWrapper<vector<Block*>,Block*,Block*> blocklist
436 typedef ContainerWrapper<vector<Edge*>,Edge*,Edge*> edgelist
437 \end{apient}
438 \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.}
439
440 \begin{apient}
441 const string & name()
442 \end{apient}
443 \apidesc{Returns the name of this function.}
444
445 \begin{apient}
446 CodeRegion * region()
447 \end{apient}
448 \apidesc{Returns the CodeRegion that contains this function's entry point (functions can span multiple regions).}
449
450 \begin{apient}
451 InstructionSource * isrc()
452 \end{apient}
453 \apidesc{Returns the InstructionSource for this function.}
454
455 \begin{apient}
456 CodeObject * obj()
457 \end{apient}
458 \apidesc{Returns the CodeObject containing this function.}
459
460 \begin{apient}
461 FuncSource src()
462 \end{apient}
463 \apidesc{Returns the type of hint that identified this function's entry point.}
464
465 \begin{apient}
466 FuncReturnStatus retstatus()
467 \end{apient}
468 \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.}
469
470 \begin{apient}
471 Block * entry()
472 \end{apient}
473 \apidesc{Returns the basic block at this function's entry point.}
474
475 \begin{apient}
476 bool parsed()
477 \end{apient}
478 \apidesc{Indicates whether this function has been parsed.}
479
480 \begin{apient}
481 blocklist & blocks()
482 \end{apient}
483 \apidesc{Returns a list of the basic blocks comprised by this function. The blocks are guaranteed to be sorted by starting address.}
484
485 \begin{apient}
486 bool contains(Block *b)
487 \end{apient}
488 \apidesc{Returns {\scshape true} if the block is contained in this function.}
489
490 \begin{apient}
491 edgelist & callEdges()
492 \end{apient}
493 \apidesc{Returns a list of all outgoing call edges from this function.}
494
495 \begin{apient}
496 blocklist & returnBlocks()
497 \end{apient}
498 \apidesc{Returns a list of all blocks ending in a \texttt{return} instruction.}
499
500 \begin{apient}
501 std::vector<FuncExtent *> const& extents()
502 \end{apient}
503 \apidesc{Returns a list of contiguous extents of binary code within the function.}
504
505 [The following methods provide additional details about functions to support instrumentation applications and are probably of no interest to most users.]
506
507 \begin{apient}
508 bool hasNoStackFrame()
509 \end{apient}
510 \apidesc{Indicates whether the function sets up a stack frame.}
511
512 \begin{apient}
513 bool savesFramePointer()
514 \end{apient}
515 \apidesc{Indicates whether the function saves a stack frame pointer.}
516
517 \begin{apient}
518 bool cleansOwnStack()
519 \end{apient}
520 \apidesc{Indicates whether the function tears down its own stack on return.}
521
522 \subsection{Class FuncExtent}
523
524 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).
525
526 \begin{apient}
527 Address start()
528 \end{apient}
529 \apidesc{The start of this contiguous code extent.}
530
531 \begin{apient}
532 Address end()
533 \end{apient}
534 \apidesc{The end of this contiguous code extent (exclusive).}
535
536 \subsection{Class Block}
537
538 A Block represents a basic block as defined in Section \ref{sec:abstractions}, and is the lowest level representation of code in the CFG.
539
540 \begin{apient}
541 typedef ContainerWrapper<vector<Edge*>,Edge*,Edge*> edgelist
542 \end{apient}
543 \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.}
544
545
546 \begin{apient}
547 Address start()
548 \end{apient}
549 \apidesc{Returns the lower bound of this block (the address of the first instruction).}
550
551 \begin{apient}
552 Address end()
553 \end{apient}
554 \apidesc{Returns the upper bound (open) of this block (the address immediately
555 following the last byte in the last instruction). }
556
557 \begin{apient}
558 Address lastInsnAddr()
559 \end{apient}
560 \apidesc{Returns the address of the last instruction in this block.}
561
562 \begin{apient}
563 Address size()
564 \end{apient}
565 \apidesc{Returns $\texttt{end()} - \texttt{start()}$.}
566
567 \begin{apient}
568 bool parsed()
569 \end{apient}
570 \apidesc{Indicates whether this block has been parsed.}
571
572 \begin{apient}
573 CodeObject * obj()
574 \end{apient}
575 \apidesc{Returns the CodeObject containing this block.}
576
577 \begin{apient}
578 CodeRegion * region()
579 \end{apient}
580 \apidesc{Returns the CodeRegion containing this block.}
581
582 \begin{apient}
583 edgelist & sources()
584 \end{apient}
585 \apidesc{Return a list of all incomming edges to the block.}
586
587 \begin{apient}
588 edgelist & targets()
589 \end{apient}
590 \apidesc{Return a list of all outgoing edges from the block.}
591
592 \begin{apient}
593 bool consistent(Address addr, Address & prev_insn)
594 \end{apient}
595 \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.}
596
597 \begin{apient}
598 int containingFuncs()
599 \end{apient}
600 \apidesc{Returns the number of functions that contain this block.}
601
602 \begin{apient}
603 void getFuncs(std::vector<Function *> & funcs)
604 \end{apient}
605 \apidesc{Fills in the provided vector with all functions that share this basic block.}
606
607 \subsection{Class Edge}
608
609 Typed Edges join two blocks in the CFG, indicating the type of control flow
610 transfer instruction that joins the blocks to each other. Edges may not correspond
611 to a control flow transfer instruction at all, as in the case of the {\scshape
612 fallthrough} edge that indicates where straight-line control flow is split by
613 incoming transfers from another location, such as a branch. While not all
614 blocks end in a control transfer instruction, all control transfer instructions
615 end basic blocks and have outgoing edges; in the case of unresolvable control
616 flow, the edge will target a special ``sink'' block (see \texttt{sinkEdge()},
617 below.
618
619 \begin{center}
620 \begin{tabular}{ll}
621 \toprule
622 EdgeTypeEnum & Meaning \\
623 \midrule
624 CALL & call edge \\
625 COND\_TAKEN & conditional branch--taken \\
626 COND\_NOT\_TAKEN & conditional branch--not taken \\
627 INDIRECT & branch indirect \\
628 DIRECT & branch direct \\
629 FALLTHROUGH & direct fallthrough (no branch) \\
630 CATCH & exception handler \\
631 CALL\_FT & post-call fallthrough \\
632 RET & return \\
633 \bottomrule
634 \end{tabular}
635 \end{center}
636
637 \begin{apient}
638 Block * src()
639 \end{apient}
640 \apidesc{Returns the source block of this edge.}
641
642 \begin{apient}
643 Block * trg()
644 \end{apient}
645 \apidesc{Returns the target block of this edge.}
646
647 \begin{apient}
648 EdgeTypeEnum type()
649 \end{apient}
650 \apidesc{Returns the edge type.}
651
652 \begin{apient}
653 bool sinkEdge()
654 \end{apient}
655 \apidesc{Indicates whether this edge targets the special \emph{sink} block.}
656
657 \begin{apient}
658 bool interproc()
659 \end{apient}
660 \apidesc{Returns {\scshape true} if the edge should be interpreted as interprocedural (e.g. calls, returns, direct branches under certain circumstances).}
661
662 \subsection{Class EdgePredicate}
663 \label{sec:pred}
664
665 Edge predicates control iteration over edges. For example, the provided
666 \texttt{Intraproc} edge predicate can be passed to an edge iterator
667 constructor, ensuring that only intraprocedural edges are visited during
668 iteration. Two other implementations of EdgePredicate are provided: 
669 \texttt{SingleContext} only visits edges that stay in a single
670 function context, and \texttt{NoSinkPredicate} does not visit edges to 
671 the \emph{sink} block.  The following code traverses 
672 all of the basic blocks within a
673 function:
674
675 \lstset{language=[GNU]C++,basicstyle=\fontfamily{fvm}\selectfont\small}
676 \lstset{numbers=left, numberstyle=\tiny, stepnumber=5, numbersep=5pt}
677 \begin{lstlisting}
678     vector<Block*> work;
679     std::map<Block*,bool> seen; // avoid loops
680     Intraproc epred; // ignore calls, returns
681    
682     work.push_back(func->entry()); // assuming `func' is a Function*
683     seen[func->entry()] = true;
684     while(!work.empty()) {
685         Block * b = work.back();
686         work.pop_back();
687
688         // do some stuff with b...
689    
690         Block::edgelist & targets = block->targets();
691         Block::edgelist::iterator eit = targets.begin(&epred);
692         for( ; eit != targets.end(); ++eit) {
693             Edge * e = (*eit);
694             if(seen.find(e->trg()) == seen.end())
695                 work.push_back(e->trg());
696         }
697     } 
698 \end{lstlisting}
699
700 New edge predicates can be created by implementing the following simple interface:
701
702 \begin{apient}
703 EdgePredicate()
704 EdgePredicate(EdgePredicate * next)
705 \end{apient}
706 \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.}
707
708 \begin{apient}
709 virtual bool pred_impl(Edge *)
710 \end{apient}
711 \apidesc{Evaluates the predicate on the provided edge.}
712
713 \subsection{Class ParseCallback}
714
715 The ParseCallback class allows ParseAPI users to be notified of various events
716 during parsing. For most users this notification is unnecessary, and an
717 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.
718
719 \begin{apient}
720 struct default_details {
721     default_details(unsigned char*b,size_t s, bool ib) : ibuf(b), isize(s), isbranch(ib) { }
722     unsigned char * ibuf;
723     size_t isize;
724     bool isbranch;
725 }
726 \end{apient}
727 \apidesc{Details used in the \texttt{unresolved\_cf} and \texttt{abruptEnd\_cf}
728 callbacks.}
729
730 \begin{apient}
731 virtual void instruction_cb(Function*,Address,insn_details*)
732 \end{apient}
733 \apidesc{Invoked for each instruction decoded during parsing. Implementing this callback may incur significant overhead.}
734
735 \begin{apient}
736 struct insn_details {
737     InsnAdapter::InstructionAdapter * insn;
738 }
739 \end{apient}
740
741 \begin{apient}
742 void interproc_cf(Function*,Address,interproc_details*)
743 \end{apient}
744 \apidesc{Invoked for each interprocedural control flow instruction.}
745
746 \begin{apient}  
747 struct interproc_details {
748     typedef enum {
749         ret,
750         call,
751         branch_interproc, // tail calls, branches to plts
752         syscall
753     } type_t;
754     unsigned char * ibuf;
755     size_t isize;
756     type_t type;
757     union {
758         struct {
759             Address target;
760             bool absolute_address;
761             bool dynamic_call;
762         } call;
763     } data;
764 }
765 \end{apient}
766 \apidesc{Details used in the \texttt{interproc\_cf} callback.}
767
768 \begin{apient}
769 void overlapping_blocks(Block*,Block*)
770 \end{apient}
771 \apidesc{Noification of inconsistent parse data (overlapping blocks).}
772
773 \subsection{Containers}
774 \label{sec:containers}
775
776 Several of the ParseAPI data structures export containers of CFG objects; the
777 CodeObject provides a list of functions in the binary, for example, while
778 functions provide lists of blocks and so on. To avoid tying the internal
779 storage for these structures to any particular container type, ParseAPI objects
780 export a ContainerWrapper that provides an iterator interface to the internal
781 containers. These wrappers and predicate interfaces are designed to add minimal
782 overhead while protecting ParseAPI users from exposure to internal container
783 storage details. Users \emph{must not} rely on properties of the underlying
784 container type (e.g. storage order) unless that property is explicity stated in
785 this manual.
786
787 \noindent
788 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):
789
790 \begin{apient}
791 iterator begin()
792 iterator begin(predicate *)
793 \end{apient}
794 \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).}
795
796 \begin{apient}
797 iterator const& end()
798 \end{apient}
799 \apidesc{Return the iterator pointing to the end of the container (past the last element).}
800
801 \begin{apient}
802 size_t size()
803 \end{apient}
804 \apidesc{Returns the number of elements in the container. Execution cost may vary depending on the underlying container type.}
805
806 \begin{apient}
807 bool empty()
808 \end{apient}
809 \apidesc{Indicates whether the container is empty or not.}
810
811 \noindent
812 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.
813
814
815 \appendix
816 \section{Extending ParseAPI}
817 \label{sec:extend}
818
819 The ParseAPI is design to be a low level toolkit for binary analysis tools.
820 Users can extend the ParseAPI in two ways: by extending the control flow
821 structures (Functions, Blocks, and Edges) to incorporate additional data to
822 support various analysis applications, and by adding additional binary code
823 sources that are unsupported by the default SymtabAPI-based code source. For
824 example, a code source that represents a program image in memory could be
825 implemented by fulfilling the CodeSource and InstructionSource interfaces
826 described in Section \ref{sec:codesource} and below. Implementations that
827 extend the CFG structures need only provide a custom allocation factory in
828 order for these objects to be allocated during parsing.
829
830 \subsection{Instruction and Code Sources}
831
832 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:
833
834 \begin{apient}
835 virtual bool isValidAddress(const Address) 
836 \end{apient}
837 \apidesc{Returns {\scshape true} if the address is a valid code location.}
838
839 \begin{apient}
840 virtual void* getPtrToInstruction(const Address)
841 \end{apient}
842 \apidesc{Returns pointer to raw memory in the binary at the provided address.}
843
844 \begin{apient}
845 virtual void* getPtrToData(const Address)
846 \end{apient}
847 \apidesc{Returns pointer to raw memory in the binary at the provided address. The address need not correspond to an executable code region.}
848
849 \begin{apient}
850 virtual unsigned int getAddressWidth()
851 \end{apient}
852 \apidesc{Returns the address width (e.g. four or eight bytes) for the represented binary.}
853
854 \begin{apient}
855 virtual bool isCode(const Address)
856 \end{apient}
857 \apidesc{Indicates whether the location is in a code region.}
858
859 \begin{apient}
860 virtual bool isData(const Address)
861 \end{apient}
862 \apidesc{Indicates whether the location is in a data region.}
863
864 \begin{apient}
865 virtual Address offset()
866 \end{apient}
867 \apidesc{The start of the region covered by this instruction source.}
868
869 \begin{apient}
870 virtual Address length()
871 \end{apient}
872 \apidesc{The size of the region.}
873
874 \begin{apient}
875 virtual Architecture getArch()
876 \end{apient}
877 \apidesc{The architecture of the instruction source. See the Dyninst manual for details on architecture differences.}
878
879 \begin{apient}
880 virtual bool isAligned(const Address)
881 \end{apient}
882 \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.}
883
884 CodeSource implementors need to fill in several data structures in the base CodeSource class:
885
886 \begin{apient}
887 std::map<Address, std::string> _linkage
888 \end{apient}
889 \apidesc{Entries in the linkage map represent external linkage, e.g. the PLT in ELF binaries. Filling in this map is optional.}
890
891 \begin{apient}
892 Address _table_of_contents
893 \end{apient}
894 \apidesc{Many binary format have ``table of contents'' structures for position
895 independant references. If such a structure exists, its address should be filled in.}
896
897 \begin{apient}
898 std::vector<CodeRegion *> _regions
899 Dyninst::IBSTree<CodeRegion> _region_tree
900 \end{apient}
901 \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.}
902
903 \begin{apient}
904 std::vector<Hint> _hints
905 \end{apient}
906 \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.}
907
908 \subsection{CFG Object Factories}
909 \label{sec:factories}
910
911 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:
912
913 \begin{apient}
914 virtual Function * mkfunc(Address addr, 
915     FuncSource src,
916     std::string name, 
917     CodeObject * obj, 
918     CodeRegion * region,
919     Dyninst::InstructionSource * isrc)
920 \end{apient}
921 \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.}
922
923 \begin{apient}
924 virtual Block * mkblock(Function * func, CodeRegion * region, Address addr)
925 \end{apient}
926 \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.}
927
928 \begin{apient}
929 virtual Edge * mkedge(Block * src, Block * trg, EdgeTypeEnum type)
930 \end{apient}
931 \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.}
932
933 \begin{apient}
934 virtual Block * mksink(CodeObject *obj, CodeRegion *r)
935 \end{apient}
936 \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.}
937
938 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:
939
940 \begin{apient}
941 fact_list<Edge> edges_
942 fact_list<Block> blocks_
943 fact_list<Function> funcs_
944 \end{apient}
945 \apidesc{O(1) allocation lists for CFG types. See the CFG.h header file for list insertion and removal operations.}
946
947 Implementors \emph{may} but are \emph{not required to} override the
948 deallocation following deallocation routines. The primary reason to override
949 these routines is if additional action or cleanup is necessary upon CFG object
950 release; the default routines simply remove the objects from the allocation
951 list and invoke their destructors.
952
953 \begin{apient}
954 virtual void free_func(Function * f)
955 virtual void free_block(Block * b)
956 virtual void free_edge(Edge * e)
957 virtual void free_all()
958 \end{apient}
959 \apidesc{CFG objects should be freed using these functions, rather than delete, to avoid leaking memory.}
960
961 \section{Defensive Mode Parsing}
962 \label{sec:defmode}
963
964 Binary code that defends itself against analysis may violate the
965 assumptions made by the the ParseAPI's standard parsing algorithm.
966 Enabling defensive mode parsing activates more conservative
967 assumptions that substantially reduce the percentage of code that is
968 analyzed by the ParseAPI.  For this reason, defensive mode parsing is
969 best-suited for use of ParseAPI in conjunction with dynamic analysis
970 techniques that can compensate for its limited coverage of the binary
971 code.  This mode of parsing will be brought to full functionality in 
972 an upcoming release.  
973
974 \end{document}