GitHub/ImmunityDebugger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
ImmunityDebugger/1.85/Documentation/Ref/Libs.libanalyze.Function-class.html
T
Kiran Bandla f926e8a880 Added 1.85
2013-03-29 11:54:46 -04:00

522 lines
20 KiB
HTML
Executable File
Raw Permalink Blame History

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Libs.libanalyze.Function</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>Immunity Debugger API Reference</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package&nbsp;Libs ::
<a href="Libs.libanalyze-module.html">Module&nbsp;libanalyze</a> ::
Class&nbsp;Function
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="Libs.libanalyze.Function-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Function</h1><p class="nomargin-top"><span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function">source&nbsp;code</a></span></p>
<p>Class that contains information about a Function</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libanalyze.Function-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">imm</span>,
<span class="summary-sig-arg">start</span>)</span><br />
Class that contains information about a Function</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.__init__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libanalyze.Function-class.html#setStart" class="summary-sig-name">setStart</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">address</span>)</span><br />
Change the start of a Function</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.setStart">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">DWORD</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libanalyze.Function-class.html#getStart" class="summary-sig-name">getStart</a>(<span class="summary-sig-arg">self</span>)</span><br />
Get the Address of the Function</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.getStart">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">STRING</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libanalyze.Function-class.html#getName" class="summary-sig-name">getName</a>(<span class="summary-sig-arg">self</span>)</span><br />
Get the name of the Function</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.getName">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="getFunctionEnd"></a><span class="summary-sig-name">getFunctionEnd</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.getFunctionEnd">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">LIST of BasicBlock</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libanalyze.Function-class.html#getEnd" class="summary-sig-name">getEnd</a>(<span class="summary-sig-arg">self</span>)</span><br />
Get the end of the Function (Understanding end as the Basic Block
with a ret inside)</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.getEnd">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libanalyze.Function-class.html#findRetValue" class="summary-sig-name">findRetValue</a>(<span class="summary-sig-arg">self</span>)</span><br />
Find all the possible ret values on a function (Beta) Note: This
function only check the modifiers on a Ret BasicBlock, so the result
might not be precise.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.findRetValue">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">BasicBlock object</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libanalyze.Function-class.html#hasAddress" class="summary-sig-name">hasAddress</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">address</span>)</span><br />
Check if the given address is part of the Function</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.hasAddress">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">LIST of BasicBlock objects</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Libs.libanalyze.Function-class.html#getBasicBlocks" class="summary-sig-name">getBasicBlocks</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">force</span>=<span class="summary-sig-default">False</span>)</span><br />
Get basic block from the current Function</td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.getBasicBlocks">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_getBB"></a><span class="summary-sig-name">_getBB</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">address</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function._getBB">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">imm</span>,
<span class="sig-arg">start</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.__init__">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Class that contains information about a Function</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>imm</code></strong> (Debbuger OBJECT) - Debbuger</li>
<li><strong class="pname"><code>start</code></strong> (DWORD) - Address of the begging of the function</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setStart"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setStart</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">address</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.setStart">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Change the start of a Function</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>address</code></strong> (DWORD) - New address of the function</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getStart"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getStart</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.getStart">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Get the Address of the Function</p>
<dl class="fields">
<dt>Returns: DWORD</dt>
<dd>Address of the function</dd>
</dl>
</td></tr></table>
</div>
<a name="getName"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getName</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.getName">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Get the name of the Function</p>
<dl class="fields">
<dt>Returns: STRING</dt>
<dd>Name of the Function</dd>
</dl>
</td></tr></table>
</div>
<a name="getEnd"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getEnd</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.getEnd">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Get the end of the Function (Understanding end as the Basic Block with
a ret inside)</p>
<dl class="fields">
<dt>Returns: LIST of BasicBlock</dt>
<dd>A list of all the basic block that end the function</dd>
</dl>
</td></tr></table>
</div>
<a name="findRetValue"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">findRetValue</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.findRetValue">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Find all the possible ret values on a function (Beta) Note: This
function only check the modifiers on a Ret BasicBlock, so the result
might not be precise.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>start</code></strong> (LIST OF OPCODE) - Return all the possible modifiers of EAX</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="hasAddress"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">hasAddress</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">address</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.hasAddress">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Check if the given address is part of the Function</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>force</code></strong> - Address of the instruction to check</li>
<li><strong class="pname"><code>address</code></strong> (DWORD)</li>
</ul></dd>
<dt>Returns: BasicBlock object</dt>
<dd>If true, returns the corresponding Basic block else returns None</dd>
</dl>
</td></tr></table>
</div>
<a name="getBasicBlocks"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getBasicBlocks</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">force</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Libs.libanalyze-pysrc.html#Function.getBasicBlocks">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Get basic block from the current Function</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>force</code></strong> (BOOLEAN) - (Optional, Def: False) Force to Function to reparse the basic
blocks</li>
</ul></dd>
<dt>Returns: LIST of BasicBlock objects</dt>
<dd>Basic blocks of the current function
<p>TODO: Recursion here is bad - we need to make this an
iterative process with a work queue</p></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>Immunity Debugger API Reference</th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Thu Mar 17 18:43:02 2011
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink