2464 lines
201 KiB
HTML
2464 lines
201 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>architecture module — Binary Ninja API Documentation v1.1</title>
|
||
|
||
|
||
|
||
|
||
<link rel="shortcut icon" href="_static/favicon.ico"/>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/other.css" type="text/css" />
|
||
|
||
|
||
|
||
<link rel="index" title="Index"
|
||
href="genindex.html"/>
|
||
<link rel="search" title="Search" href="search.html"/>
|
||
<link rel="top" title="Binary Ninja API Documentation v1.1" href="index.html"/>
|
||
<link rel="next" title="binaryninja.architecture.Architecture" href="binaryninja.architecture.Architecture.html"/>
|
||
<link rel="prev" title="Binary Ninja Python API Documentation" href="index.html"/>
|
||
|
||
|
||
<script src="_static/js/modernizr.min.js"></script>
|
||
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav" role="document">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search">
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> Binary Ninja API
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
<script>
|
||
window.addEventListener("load", function() {
|
||
var ver = document.getElementsByClassName("version");
|
||
ver[0].innerHTML = DOCUMENTATION_OPTIONS['VERSION'];
|
||
});
|
||
</script>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">architecture</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="binaryninja.architecture.Architecture.html">binaryninja.architecture.Architecture</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="binaryninja.architecture.ArchitectureHook.html">binaryninja.architecture.ArchitectureHook</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="binaryninja.architecture.CoreArchitecture.html">binaryninja.architecture.CoreArchitecture</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="binaryninja.architecture.ReferenceSource.html">binaryninja.architecture.ReferenceSource</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="binaryninja.architecture.long.html">binaryninja.architecture.long</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="binaryninja.architecture.range.html">binaryninja.architecture.range</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="binaryninja.architecture.with_metaclass.html">binaryninja.architecture.with_metaclass</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.atexit-module.html">atexit</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.basicblock-module.html">basicblock</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.binaryview-module.html">binaryview</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.callingconvention-module.html">callingconvention</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.databuffer-module.html">databuffer</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.datarender-module.html">datarender</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.demangle-module.html">demangle</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.downloadprovider-module.html">downloadprovider</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.enums-module.html">enums</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.fileaccessor-module.html">fileaccessor</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.filemetadata-module.html">filemetadata</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.flowgraph-module.html">flowgraph</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.function-module.html">function</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.functionrecognizer-module.html">functionrecognizer</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.highlight-module.html">highlight</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.interaction-module.html">interaction</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lineardisassembly-module.html">lineardisassembly</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.log-module.html">log</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lowlevelil-module.html">lowlevelil</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mainthread-module.html">mainthread</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mediumlevelil-module.html">mediumlevelil</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.metadata-module.html">metadata</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.numbers-module.html">numbers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.platform-module.html">platform</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.plugin-module.html">plugin</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.pluginmanager-module.html">pluginmanager</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.scriptingprovider-module.html">scriptingprovider</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.settings-module.html">settings</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.transform-module.html">transform</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.types-module.html">types</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.undoaction-module.html">undoaction</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="binaryninja.update-module.html">update</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">Binary Ninja API</a>
|
||
|
||
</nav>
|
||
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html">Docs</a> »</li>
|
||
|
||
<li>architecture module</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/binaryninja.architecture-module.rst.txt" rel="nofollow"> View page source</a>
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="architecture-module">
|
||
<h1>architecture module<a class="headerlink" href="#architecture-module" title="Permalink to this headline">¶</a></h1>
|
||
<table border="1" class="longtable docutils">
|
||
<colgroup>
|
||
<col width="10%" />
|
||
<col width="90%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.architecture.Architecture.html#binaryninja.architecture.Architecture" title="binaryninja.architecture.Architecture"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.architecture.Architecture</span></code></a>()</td>
|
||
<td><code class="docutils literal notranslate"><span class="pre">class</span> <span class="pre">Architecture</span></code> is the parent class for all CPU architectures.</td>
|
||
</tr>
|
||
<tr class="row-even"><td><a class="reference internal" href="binaryninja.architecture.ArchitectureHook.html#binaryninja.architecture.ArchitectureHook" title="binaryninja.architecture.ArchitectureHook"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.architecture.ArchitectureHook</span></code></a>(…)</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.architecture.CoreArchitecture.html#binaryninja.architecture.CoreArchitecture" title="binaryninja.architecture.CoreArchitecture"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.architecture.CoreArchitecture</span></code></a>(handle)</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><a class="reference internal" href="binaryninja.architecture.ReferenceSource.html#binaryninja.architecture.ReferenceSource" title="binaryninja.architecture.ReferenceSource"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.architecture.ReferenceSource</span></code></a>(…)</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.architecture.long.html#binaryninja.architecture.long" title="binaryninja.architecture.long"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.architecture.long</span></code></a>([x])</td>
|
||
<td>long(x, base=10) -> long</td>
|
||
</tr>
|
||
<tr class="row-even"><td><a class="reference internal" href="binaryninja.architecture.range.html#binaryninja.architecture.range" title="binaryninja.architecture.range"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.architecture.range</span></code></a>(*args)</td>
|
||
<td>A Python2 and Python3 Compatible Range Generator</td>
|
||
</tr>
|
||
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.architecture.with_metaclass.html#binaryninja.architecture.with_metaclass" title="binaryninja.architecture.with_metaclass"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.architecture.with_metaclass</span></code></a>(…)</td>
|
||
<td>Create a base class with a metaclass.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="toctree-wrapper compound">
|
||
</div>
|
||
<span class="target" id="module-binaryninja.architecture"></span><dl class="class">
|
||
<dt id="binaryninja.architecture.Architecture">
|
||
<em class="property">class </em><code class="descname">Architecture</code><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
|
||
<p><code class="docutils literal notranslate"><span class="pre">class</span> <span class="pre">Architecture</span></code> is the parent class for all CPU architectures. Subclasses of Architecture implement assembly,
|
||
disassembly, IL lifting, and patching.</p>
|
||
<p><code class="docutils literal notranslate"><span class="pre">class</span> <span class="pre">Architecture</span></code> has a metaclass with the additional methods <code class="docutils literal notranslate"><span class="pre">register</span></code>, and supports
|
||
iteration:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="c1">#List the architectures</span>
|
||
<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">Architecture</span><span class="p">)</span>
|
||
<span class="go">[<arch: aarch64>, <arch: armv7>, <arch: armv7eb>, <arch: mipsel32>, <arch: mips32>, <arch: powerpc>,</span>
|
||
<span class="go"><arch: x86>, <arch: x86_64>]</span>
|
||
<span class="gp">>>> </span><span class="c1">#Register a new Architecture</span>
|
||
<span class="gp">>>> </span><span class="k">class</span> <span class="nc">MyArch</span><span class="p">(</span><span class="n">Architecture</span><span class="p">):</span>
|
||
<span class="gp">... </span> <span class="n">name</span> <span class="o">=</span> <span class="s2">"MyArch"</span>
|
||
<span class="gp">...</span>
|
||
<span class="gp">>>> </span><span class="n">MyArch</span><span class="o">.</span><span class="n">register</span><span class="p">()</span>
|
||
<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">Architecture</span><span class="p">)</span>
|
||
<span class="go">[<arch: aarch64>, <arch: armv7>, <arch: armv7eb>, <arch: mipsel32>, <arch: mips32>, <arch: powerpc>,</span>
|
||
<span class="go"><arch: x86>, <arch: x86_64>, <arch: MyArch>]</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
<p>For the purposes of this documentation the variable <code class="docutils literal notranslate"><span class="pre">arch</span></code> will be used in the following context</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">binaryninja</span> <span class="k">import</span> <span class="o">*</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span> <span class="o">=</span> <span class="n">Architecture</span><span class="p">[</span><span class="s1">'x86'</span><span class="p">]</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.always_branch">
|
||
<code class="descname">always_branch</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.always_branch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.always_branch" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">always_branch</span></code> reads the instruction(s) in <code class="docutils literal notranslate"><span class="pre">data</span></code> at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> and returns a string of bytes
|
||
of the same length which always branches.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be converted</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">string containing len(data) which always branches to the same location as the provided instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">bytes</span> <span class="o">=</span> <span class="n">arch</span><span class="o">.</span><span class="n">always_branch</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="nb">bytes</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['nop '], 1L)</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="nb">bytes</span><span class="p">[</span><span class="mi">1</span><span class="p">:],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['jmp ', '0x9'], 5L)</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.assemble">
|
||
<code class="descname">assemble</code><span class="sig-paren">(</span><em>code</em>, <em>addr=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.assemble"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.assemble" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">assemble</span></code> converts the string of assembly instructions <code class="docutils literal notranslate"><span class="pre">code</span></code> loaded at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> to the
|
||
byte representation of those instructions.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<p>Architecture plugins can override this method to provide assembler functionality. This can be done by
|
||
simply shelling out to an assembler like yasm or llvm-mc, since this method isn’t performance sensitive.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">It is important that the assembler used accepts a syntax identical to the one emitted by the disassembler. This will prevent confusing the user.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>code</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – string representation of the instructions to be assembled</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address that the instructions will be loaded at</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the bytes for the assembled instructions</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Python3 - a ‘bytes’ object; Python2 - a ‘bytes’ object</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)</span>
|
||
<span class="go">'\x0f\x84\x04\x00\x00\x00'</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.convert_to_nop">
|
||
<code class="descname">convert_to_nop</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.convert_to_nop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.convert_to_nop" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">convert_to_nop</span></code> reads the instruction(s) in <code class="docutils literal notranslate"><span class="pre">data</span></code> at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> and returns a string of nop
|
||
instructions of the same length as data.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be converted</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">string containing len(data) worth of no-operation instructions</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">convert_to_nop</span><span class="p">(</span><span class="s2">"</span><span class="se">\x00\x00</span><span class="s2">"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">'\x90\x90'</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_associated_arch_by_address">
|
||
<code class="descname">get_associated_arch_by_address</code><span class="sig-paren">(</span><em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_associated_arch_by_address"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_associated_arch_by_address" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_default_flag_condition_low_level_il">
|
||
<code class="descname">get_default_flag_condition_low_level_il</code><span class="sig-paren">(</span><em>cond</em>, <em>sem_class</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_default_flag_condition_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_default_flag_condition_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>cond</strong> (<a class="reference internal" href="binaryninja.enums.LowLevelILFlagCondition.html#binaryninja.enums.LowLevelILFlagCondition" title="binaryninja.enums.LowLevelILFlagCondition"><em>LowLevelILFlagCondition</em></a>) – </li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – </li>
|
||
<li><strong>sem_class</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.lowlevelil.LowLevelILExpr.html#binaryninja.lowlevelil.LowLevelILExpr" title="binaryninja.lowlevelil.LowLevelILExpr">LowLevelILExpr</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_default_flag_write_low_level_il">
|
||
<code class="descname">get_default_flag_write_low_level_il</code><span class="sig-paren">(</span><em>op</em>, <em>size</em>, <em>role</em>, <em>operands</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_default_flag_write_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_default_flag_write_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>op</strong> (<a class="reference internal" href="binaryninja.enums.LowLevelILOperation.html#binaryninja.enums.LowLevelILOperation" title="binaryninja.enums.LowLevelILOperation"><em>LowLevelILOperation</em></a>) – </li>
|
||
<li><strong>size</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
|
||
<li><strong>role</strong> (<a class="reference internal" href="binaryninja.enums.FlagRole.html#binaryninja.enums.FlagRole" title="binaryninja.enums.FlagRole"><em>FlagRole</em></a>) – </li>
|
||
<li><strong>or int</strong><strong>) </strong><strong>operands</strong> (<em>list</em><em>(</em><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – a list of either items that are either string register names or constant integer values</li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">LowLevelILExpr index</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_flag_by_name">
|
||
<code class="descname">get_flag_by_name</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_flag_by_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_flag_by_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_flag_by_name</span></code> get flag name for flag index.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>flag</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – flag index</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">flag name for flag index</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_flag_condition_low_level_il">
|
||
<code class="descname">get_flag_condition_low_level_il</code><span class="sig-paren">(</span><em>cond</em>, <em>sem_class</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_flag_condition_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_flag_condition_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>cond</strong> (<a class="reference internal" href="binaryninja.enums.LowLevelILFlagCondition.html#binaryninja.enums.LowLevelILFlagCondition" title="binaryninja.enums.LowLevelILFlagCondition"><em>LowLevelILFlagCondition</em></a>) – Flag condition to be computed</li>
|
||
<li><strong>sem_class</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Semantic class to be used (None for default semantics)</li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – LowLevelILFunction object to append LowLevelILExpr objects to</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.lowlevelil.LowLevelILExpr.html#binaryninja.lowlevelil.LowLevelILExpr" title="binaryninja.lowlevelil.LowLevelILExpr">LowLevelILExpr</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_flag_index">
|
||
<code class="descname">get_flag_index</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_flag_index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_flag_index" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_flag_name">
|
||
<code class="descname">get_flag_name</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_flag_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_flag_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_flag_name</span></code> gets a flag name from a flag number.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reg</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – register number</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the corresponding register string</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_flag_role">
|
||
<code class="descname">get_flag_role</code><span class="sig-paren">(</span><em>flag</em>, <em>sem_class=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_flag_role"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_flag_role" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_flag_role</span></code> gets the role of a given flag.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>flag</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – flag</li>
|
||
<li><strong>sem_class</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – optional semantic flag class</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">flag role</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.enums.FlagRole.html#binaryninja.enums.FlagRole" title="binaryninja.enums.FlagRole">FlagRole</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_flag_write_low_level_il">
|
||
<code class="descname">get_flag_write_low_level_il</code><span class="sig-paren">(</span><em>op</em>, <em>size</em>, <em>write_type</em>, <em>flag</em>, <em>operands</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_flag_write_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_flag_write_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>op</strong> (<a class="reference internal" href="binaryninja.enums.LowLevelILOperation.html#binaryninja.enums.LowLevelILOperation" title="binaryninja.enums.LowLevelILOperation"><em>LowLevelILOperation</em></a>) – </li>
|
||
<li><strong>size</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
|
||
<li><strong>write_type</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – </li>
|
||
<li><strong>or int</strong><strong>) </strong><strong>operands</strong> (<em>list</em><em>(</em><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – a list of either items that are either string register names or constant integer values</li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.lowlevelil.LowLevelILExpr.html#binaryninja.lowlevelil.LowLevelILExpr" title="binaryninja.lowlevelil.LowLevelILExpr">LowLevelILExpr</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_flag_write_type_by_name">
|
||
<code class="descname">get_flag_write_type_by_name</code><span class="sig-paren">(</span><em>write_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_flag_write_type_by_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_flag_write_type_by_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_flag_write_type_by_name</span></code> gets the flag write type name for the flag write type.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>write_type</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – flag write type</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">flag write type</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_flag_write_type_name">
|
||
<code class="descname">get_flag_write_type_name</code><span class="sig-paren">(</span><em>write_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_flag_write_type_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_flag_write_type_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_flag_write_type_name</span></code> gets the flag write type name for the given flag.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>write_type</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – flag</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">flag write type name</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_flags_required_for_flag_condition">
|
||
<code class="descname">get_flags_required_for_flag_condition</code><span class="sig-paren">(</span><em>cond</em>, <em>sem_class=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_flags_required_for_flag_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_flags_required_for_flag_condition" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_instruction_info">
|
||
<code class="descname">get_instruction_info</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_instruction_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_instruction_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_instruction_info</span></code> returns an InstructionInfo object for the instruction at the given virtual address
|
||
<code class="docutils literal notranslate"><span class="pre">addr</span></code> with data <code class="docutils literal notranslate"><span class="pre">data</span></code>.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">The instruction info object should always set the InstructionInfo.length to the instruction length, and the branches of the proper types should be added if the instruction is a branch.</p>
|
||
</div>
|
||
<p>If the instruction is a branch instruction architecture plugins should add a branch of the proper type:</p>
|
||
<blockquote>
|
||
<div><table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="29%" />
|
||
<col width="71%" />
|
||
</colgroup>
|
||
<thead valign="bottom">
|
||
<tr class="row-odd"><th class="head">BranchType</th>
|
||
<th class="head">Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody valign="top">
|
||
<tr class="row-even"><td>UnconditionalBranch</td>
|
||
<td>Branch will always be taken</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>FalseBranch</td>
|
||
<td>False branch condition</td>
|
||
</tr>
|
||
<tr class="row-even"><td>TrueBranch</td>
|
||
<td>True branch condition</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>CallDestination</td>
|
||
<td>Branch is a call instruction (Branch with Link)</td>
|
||
</tr>
|
||
<tr class="row-even"><td>FunctionReturn</td>
|
||
<td>Branch returns from a function</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>SystemCall</td>
|
||
<td>System call instruction</td>
|
||
</tr>
|
||
<tr class="row-even"><td>IndirectBranch</td>
|
||
<td>Branch destination is a memory address or register</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>UnresolvedBranch</td>
|
||
<td>Branch destination is an unknown address</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div></blockquote>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – max_instruction_length bytes from the binary at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code></li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address of bytes in <code class="docutils literal notranslate"><span class="pre">data</span></code></li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the InstructionInfo for the current instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.function.InstructionInfo.html#binaryninja.function.InstructionInfo" title="binaryninja.function.InstructionInfo">InstructionInfo</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_instruction_low_level_il">
|
||
<code class="descname">get_instruction_low_level_il</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_instruction_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_instruction_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_instruction_low_level_il</span></code> appends LowLevelILExpr objects to <code class="docutils literal notranslate"><span class="pre">il</span></code> for the instruction at the given
|
||
virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> with data <code class="docutils literal notranslate"><span class="pre">data</span></code>.</p>
|
||
<p>This is used to analyze arbitrary data at an address, if you are working with an existing binary, you likely
|
||
want to be using <code class="docutils literal notranslate"><span class="pre">Function.get_low_level_il_at</span></code>.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – max_instruction_length bytes from the binary at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code></li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address of bytes in <code class="docutils literal notranslate"><span class="pre">data</span></code></li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – The function the current instruction belongs to</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the length of the current instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_instruction_low_level_il_instruction">
|
||
<code class="descname">get_instruction_low_level_il_instruction</code><span class="sig-paren">(</span><em>bv</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_instruction_low_level_il_instruction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_instruction_low_level_il_instruction" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_instruction_text">
|
||
<code class="descname">get_instruction_text</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_instruction_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_instruction_text" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_instruction_text</span></code> returns a list of InstructionTextToken objects for the instruction at the given virtual
|
||
address <code class="docutils literal notranslate"><span class="pre">addr</span></code> with data <code class="docutils literal notranslate"><span class="pre">data</span></code>.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – max_instruction_length bytes from the binary at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code></li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address of bytes in <code class="docutils literal notranslate"><span class="pre">data</span></code></li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">an InstructionTextToken list for the current instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list(<a class="reference internal" href="binaryninja.datarender.InstructionTextToken.html#binaryninja.datarender.InstructionTextToken" title="binaryninja.datarender.InstructionTextToken">InstructionTextToken</a>)</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_intrinsic_index">
|
||
<code class="descname">get_intrinsic_index</code><span class="sig-paren">(</span><em>intrinsic</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_intrinsic_index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_intrinsic_index" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_intrinsic_name">
|
||
<code class="descname">get_intrinsic_name</code><span class="sig-paren">(</span><em>intrinsic</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_intrinsic_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_intrinsic_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_intrinsic_name</span></code> gets an intrinsic name from an intrinsic number.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>intrinsic</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – intrinsic number</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the corresponding intrinsic string</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_low_level_il_from_bytes">
|
||
<code class="descname">get_low_level_il_from_bytes</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_low_level_il_from_bytes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_low_level_il_from_bytes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_low_level_il_from_bytes</span></code> converts the instruction in bytes to <code class="docutils literal notranslate"><span class="pre">il</span></code> at the given virtual address</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the bytes of the instruction</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address of bytes in <code class="docutils literal notranslate"><span class="pre">data</span></code></li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="binaryninja.lowlevelil.LowLevelILInstruction.html#binaryninja.lowlevelil.LowLevelILInstruction" title="binaryninja.lowlevelil.LowLevelILInstruction">LowLevelILInstruction</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_low_level_il_from_bytes</span><span class="p">(</span><span class="s1">'ëþ'</span><span class="p">,</span> <span class="mh">0x40DEAD</span><span class="p">)</span>
|
||
<span class="go"><il: jump(0x40dead)></span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_modified_regs_on_write">
|
||
<code class="descname">get_modified_regs_on_write</code><span class="sig-paren">(</span><em>reg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_modified_regs_on_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_modified_regs_on_write" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_modified_regs_on_write</span></code> returns a list of register names that are modified when <code class="docutils literal notranslate"><span class="pre">reg</span></code> is written.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reg</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – string register name</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of register names</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list(<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a>)</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_reg_index">
|
||
<code class="descname">get_reg_index</code><span class="sig-paren">(</span><em>reg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_reg_index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_reg_index" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_reg_name">
|
||
<code class="descname">get_reg_name</code><span class="sig-paren">(</span><em>reg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_reg_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_reg_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_reg_name</span></code> gets a register name from a register number.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reg</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – register number</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the corresponding register string</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_reg_stack_for_reg">
|
||
<code class="descname">get_reg_stack_for_reg</code><span class="sig-paren">(</span><em>reg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_reg_stack_for_reg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_reg_stack_for_reg" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_reg_stack_index">
|
||
<code class="descname">get_reg_stack_index</code><span class="sig-paren">(</span><em>reg_stack</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_reg_stack_index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_reg_stack_index" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_reg_stack_name">
|
||
<code class="descname">get_reg_stack_name</code><span class="sig-paren">(</span><em>reg_stack</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_reg_stack_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_reg_stack_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_reg_stack_name</span></code> gets a register stack name from a register stack number.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reg_stack</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – register stack number</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the corresponding register string</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_semantic_flag_class_by_name">
|
||
<code class="descname">get_semantic_flag_class_by_name</code><span class="sig-paren">(</span><em>sem_class</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_semantic_flag_class_by_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_semantic_flag_class_by_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_semantic_flag_class_by_name</span></code> gets the semantic flag class index by name.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sem_class</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – semantic flag class</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">semantic flag class index</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_semantic_flag_class_index">
|
||
<code class="descname">get_semantic_flag_class_index</code><span class="sig-paren">(</span><em>sem_class</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_semantic_flag_class_index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_semantic_flag_class_index" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_semantic_flag_class_name">
|
||
<code class="descname">get_semantic_flag_class_name</code><span class="sig-paren">(</span><em>class_index</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_semantic_flag_class_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_semantic_flag_class_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_semantic_flag_class_name</span></code> gets the name of a semantic flag class from the index.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>_index</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – class_index</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the name of the semantic flag class</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_semantic_flag_group_by_name">
|
||
<code class="descname">get_semantic_flag_group_by_name</code><span class="sig-paren">(</span><em>sem_group</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_semantic_flag_group_by_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_semantic_flag_group_by_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_semantic_flag_group_by_name</span></code> gets the semantic flag group index by name.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sem_group</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – semantic flag group</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">semantic flag group index</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_semantic_flag_group_index">
|
||
<code class="descname">get_semantic_flag_group_index</code><span class="sig-paren">(</span><em>sem_group</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_semantic_flag_group_index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_semantic_flag_group_index" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_semantic_flag_group_low_level_il">
|
||
<code class="descname">get_semantic_flag_group_low_level_il</code><span class="sig-paren">(</span><em>sem_group</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_semantic_flag_group_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_semantic_flag_group_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>sem_group</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – </li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.lowlevelil.LowLevelILExpr.html#binaryninja.lowlevelil.LowLevelILExpr" title="binaryninja.lowlevelil.LowLevelILExpr">LowLevelILExpr</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_semantic_flag_group_name">
|
||
<code class="descname">get_semantic_flag_group_name</code><span class="sig-paren">(</span><em>group_index</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_semantic_flag_group_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_semantic_flag_group_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_semantic_flag_group_name</span></code> gets the name of a semantic flag group from the index.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>group_index</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – group_index</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the name of the semantic flag group</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.get_view_type_constant">
|
||
<code class="descname">get_view_type_constant</code><span class="sig-paren">(</span><em>type_name</em>, <em>const_name</em>, <em>default_value=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.get_view_type_constant"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.get_view_type_constant" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_view_type_constant</span></code> retrieves the view type constant for the given type_name and const_name.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>type_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the BinaryView type name of the constant to be retrieved</li>
|
||
<li><strong>const_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the constant name to retrieved</li>
|
||
<li><strong>value</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – optional default value if the type_name is not present. default value is zero.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The BinaryView type constant or the default_value if not found</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">ELF_RELOC_COPY</span> <span class="o">=</span> <span class="mi">5</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">set_view_type_constant</span><span class="p">(</span><span class="s2">"ELF"</span><span class="p">,</span> <span class="s2">"R_COPY"</span><span class="p">,</span> <span class="n">ELF_RELOC_COPY</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_view_type_constant</span><span class="p">(</span><span class="s2">"ELF"</span><span class="p">,</span> <span class="s2">"R_COPY"</span><span class="p">)</span>
|
||
<span class="go">5L</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_view_type_constant</span><span class="p">(</span><span class="s2">"ELF"</span><span class="p">,</span> <span class="s2">"NOT_HERE"</span><span class="p">,</span> <span class="mi">100</span><span class="p">)</span>
|
||
<span class="go">100L</span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.invert_branch">
|
||
<code class="descname">invert_branch</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.invert_branch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.invert_branch" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">invert_branch</span></code> reads the instruction(s) in <code class="docutils literal notranslate"><span class="pre">data</span></code> at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> and returns a string of bytes
|
||
of the same length which inverts the branch of provided instruction.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be converted</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">string containing len(data) which always branches to the same location as the provided instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">invert_branch</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">),</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['jne ', '0xa'], 6L)</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">invert_branch</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"jo 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">),</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['jno ', '0xa'], 6L)</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">invert_branch</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"jge 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">),</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['jl ', '0xa'], 6L)</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.is_always_branch_patch_available">
|
||
<code class="descname">is_always_branch_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.is_always_branch_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.is_always_branch_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">is_always_branch_patch_available</span></code> determines if the instruction <code class="docutils literal notranslate"><span class="pre">data</span></code> at <code class="docutils literal notranslate"><span class="pre">addr</span></code> can be made to
|
||
<strong>always branch</strong>.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_always_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_always_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"nop"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">False</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.is_invert_branch_patch_available">
|
||
<code class="descname">is_invert_branch_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.is_invert_branch_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.is_invert_branch_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">is_always_branch_patch_available</span></code> determines if the instruction <code class="docutils literal notranslate"><span class="pre">data</span></code> at <code class="docutils literal notranslate"><span class="pre">addr</span></code> can be inverted.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_invert_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_invert_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"nop"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">False</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.is_never_branch_patch_available">
|
||
<code class="descname">is_never_branch_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.is_never_branch_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.is_never_branch_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">is_never_branch_patch_available</span></code> determines if the instruction <code class="docutils literal notranslate"><span class="pre">data</span></code> at <code class="docutils literal notranslate"><span class="pre">addr</span></code> can be made to <strong>never branch</strong>.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_never_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_never_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"nop"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">False</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.is_skip_and_return_value_patch_available">
|
||
<code class="descname">is_skip_and_return_value_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.is_skip_and_return_value_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.is_skip_and_return_value_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">is_skip_and_return_value_patch_available</span></code> determines if the instruction <code class="docutils literal notranslate"><span class="pre">data</span></code> at <code class="docutils literal notranslate"><span class="pre">addr</span></code> is a <em>call-like</em>
|
||
instruction that can be made into an instruction <em>returns a value</em>.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_skip_and_return_value_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"call 0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_skip_and_return_value_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"jmp eax"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">False</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.is_skip_and_return_zero_patch_available">
|
||
<code class="descname">is_skip_and_return_zero_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.is_skip_and_return_zero_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.is_skip_and_return_zero_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">is_skip_and_return_zero_patch_available</span></code> determines if the instruction <code class="docutils literal notranslate"><span class="pre">data</span></code> at <code class="docutils literal notranslate"><span class="pre">addr</span></code> is a <em>call-like</em>
|
||
instruction that can be made into an instruction <em>returns zero</em>.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_skip_and_return_zero_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"call 0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_skip_and_return_zero_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"call eax"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_skip_and_return_zero_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"jmp eax"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">False</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.is_view_type_constant_defined">
|
||
<code class="descname">is_view_type_constant_defined</code><span class="sig-paren">(</span><em>type_name</em>, <em>const_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.is_view_type_constant_defined"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.is_view_type_constant_defined" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>type_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the BinaryView type name of the constant to query</li>
|
||
<li><strong>const_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the constant name to query</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">set_view_type_constant</span><span class="p">(</span><span class="s2">"ELF"</span><span class="p">,</span> <span class="s2">"R_COPY"</span><span class="p">,</span> <span class="n">ELF_RELOC_COPY</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_view_type_constant_defined</span><span class="p">(</span><span class="s2">"ELF"</span><span class="p">,</span> <span class="s2">"R_COPY"</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_view_type_constant_defined</span><span class="p">(</span><span class="s2">"ELF"</span><span class="p">,</span> <span class="s2">"NOT_THERE"</span><span class="p">)</span>
|
||
<span class="go">False</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_always_branch">
|
||
<code class="descname">perform_always_branch</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_always_branch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_always_branch" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">always_branch</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The bytes of the replacement unconditional branch instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_assemble">
|
||
<code class="descname">perform_assemble</code><span class="sig-paren">(</span><em>code</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_assemble"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_assemble" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">assemble</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>code</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – string representation of the instructions to be assembled</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address that the instructions will be loaded at</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the bytes for the assembled instructions or error string</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">(a tuple of instructions and empty string) or (or None and error string)</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_convert_to_nop">
|
||
<code class="descname">perform_convert_to_nop</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_convert_to_nop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_convert_to_nop" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">convert_to_nop</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code></li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">nop sequence of same length as <code class="docutils literal notranslate"><span class="pre">data</span></code> or None</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a> or <a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_get_associated_arch_by_address">
|
||
<code class="descname">perform_get_associated_arch_by_address</code><span class="sig-paren">(</span><em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_get_associated_arch_by_address"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_get_associated_arch_by_address" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">get_associated_arch_by_address</span></code>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_get_flag_condition_low_level_il">
|
||
<code class="descname">perform_get_flag_condition_low_level_il</code><span class="sig-paren">(</span><em>cond</em>, <em>sem_class</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_get_flag_condition_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_get_flag_condition_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">get_flag_condition_low_level_il</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>cond</strong> (<a class="reference internal" href="binaryninja.enums.LowLevelILFlagCondition.html#binaryninja.enums.LowLevelILFlagCondition" title="binaryninja.enums.LowLevelILFlagCondition"><em>LowLevelILFlagCondition</em></a>) – Flag condition to be computed</li>
|
||
<li><strong>sem_class</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Semantic class to be used (None for default semantics)</li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – LowLevelILFunction object to append LowLevelILExpr objects to</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.lowlevelil.LowLevelILExpr.html#binaryninja.lowlevelil.LowLevelILExpr" title="binaryninja.lowlevelil.LowLevelILExpr">LowLevelILExpr</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_get_flag_role">
|
||
<code class="descname">perform_get_flag_role</code><span class="sig-paren">(</span><em>flag</em>, <em>sem_class</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_get_flag_role"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_get_flag_role" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">get_flag_role</span></code>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_get_flag_write_low_level_il">
|
||
<code class="descname">perform_get_flag_write_low_level_il</code><span class="sig-paren">(</span><em>op</em>, <em>size</em>, <em>write_type</em>, <em>flag</em>, <em>operands</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_get_flag_write_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_get_flag_write_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">get_flag_write_low_level_il</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>op</strong> (<a class="reference internal" href="binaryninja.enums.LowLevelILOperation.html#binaryninja.enums.LowLevelILOperation" title="binaryninja.enums.LowLevelILOperation"><em>LowLevelILOperation</em></a>) – </li>
|
||
<li><strong>size</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
|
||
<li><strong>write_type</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
|
||
<li><strong>flag</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
|
||
<li><strong>list</strong><strong>(</strong><strong>int_or_str</strong><strong>)</strong> – </li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.lowlevelil.LowLevelILExpr.html#binaryninja.lowlevelil.LowLevelILExpr" title="binaryninja.lowlevelil.LowLevelILExpr">LowLevelILExpr</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_get_flags_required_for_flag_condition">
|
||
<code class="descname">perform_get_flags_required_for_flag_condition</code><span class="sig-paren">(</span><em>cond</em>, <em>sem_class</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_get_flags_required_for_flag_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_get_flags_required_for_flag_condition" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">get_flags_required_for_flag_condition</span></code>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_get_instruction_info">
|
||
<code class="descname">perform_get_instruction_info</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_get_instruction_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_get_instruction_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">get_instruction_info</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes to decode</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address of the byte to be decoded</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">a <code class="xref py py-class docutils literal notranslate"><span class="pre">InstructionInfo</span></code> object containing the length and branch types for the given instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.function.InstructionInfo.html#binaryninja.function.InstructionInfo" title="binaryninja.function.InstructionInfo">InstructionInfo</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_get_instruction_low_level_il">
|
||
<code class="descname">perform_get_instruction_low_level_il</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_get_instruction_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_get_instruction_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">get_instruction_low_level_il</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes to be interpreted as low-level IL instructions</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address of start of <code class="docutils literal notranslate"><span class="pre">data</span></code></li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – LowLevelILFunction object to append LowLevelILExpr objects to</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">length of bytes read on success, None on failure</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_get_instruction_text">
|
||
<code class="descname">perform_get_instruction_text</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_get_instruction_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_get_instruction_text" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">get_instruction_text</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes to decode</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address of the byte to be decoded</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">a tuple of list(InstructionTextToken) and length of instruction decoded</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">tuple(list(<a class="reference internal" href="binaryninja.datarender.InstructionTextToken.html#binaryninja.datarender.InstructionTextToken" title="binaryninja.datarender.InstructionTextToken">InstructionTextToken</a>), <a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a>)</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_get_semantic_flag_group_low_level_il">
|
||
<code class="descname">perform_get_semantic_flag_group_low_level_il</code><span class="sig-paren">(</span><em>sem_group</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_get_semantic_flag_group_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_get_semantic_flag_group_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">get_semantic_flag_group_low_level_il</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>sem_group</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Semantic group to be computed</li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – LowLevelILFunction object to append LowLevelILExpr objects to</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.lowlevelil.LowLevelILExpr.html#binaryninja.lowlevelil.LowLevelILExpr" title="binaryninja.lowlevelil.LowLevelILExpr">LowLevelILExpr</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_invert_branch">
|
||
<code class="descname">perform_invert_branch</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_invert_branch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_invert_branch" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">invert_branch</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The bytes of the replacement unconditional branch instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_is_always_branch_patch_available">
|
||
<code class="descname">perform_is_always_branch_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_is_always_branch_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_is_always_branch_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">is_always_branch_patch_available</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_is_invert_branch_patch_available">
|
||
<code class="descname">perform_is_invert_branch_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_is_invert_branch_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_is_invert_branch_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">is_invert_branch_patch_available</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the instruction can be patched, False otherwise</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_is_never_branch_patch_available">
|
||
<code class="descname">perform_is_never_branch_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_is_never_branch_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_is_never_branch_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">is_never_branch_patch_available</span></code>.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<div class="admonition warning">
|
||
<p class="first admonition-title">Warning</p>
|
||
<p class="last">This method should never be called directly.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_is_skip_and_return_value_patch_available">
|
||
<code class="descname">perform_is_skip_and_return_value_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_is_skip_and_return_value_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_is_skip_and_return_value_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">is_skip_and_return_value_patch_available</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_is_skip_and_return_zero_patch_available">
|
||
<code class="descname">perform_is_skip_and_return_zero_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_is_skip_and_return_zero_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_is_skip_and_return_zero_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">is_skip_and_return_zero_patch_available</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.perform_skip_and_return_value">
|
||
<code class="descname">perform_skip_and_return_value</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.perform_skip_and_return_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.perform_skip_and_return_value" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deprecated method provided for compatibility. Architecture plugins should override <code class="docutils literal notranslate"><span class="pre">skip_and_return_value</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
<li><strong>value</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – value to be returned</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The bytes of the replacement unconditional branch instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.register_calling_convention">
|
||
<code class="descname">register_calling_convention</code><span class="sig-paren">(</span><em>cc</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.register_calling_convention"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.register_calling_convention" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">register_calling_convention</span></code> registers a new calling convention for the Architecture.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cc</strong> (<a class="reference internal" href="binaryninja.callingconvention.CallingConvention.html#binaryninja.callingconvention.CallingConvention" title="binaryninja.callingconvention.CallingConvention"><em>CallingConvention</em></a>) – CallingConvention object to be registered</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.set_view_type_constant">
|
||
<code class="descname">set_view_type_constant</code><span class="sig-paren">(</span><em>type_name</em>, <em>const_name</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.set_view_type_constant"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.set_view_type_constant" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">set_view_type_constant</span></code> creates a new binaryview type constant.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>type_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the BinaryView type name of the constant to be registered</li>
|
||
<li><strong>const_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the constant name to register</li>
|
||
<li><strong>value</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the value of the constant</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">ELF_RELOC_COPY</span> <span class="o">=</span> <span class="mi">5</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">set_view_type_constant</span><span class="p">(</span><span class="s2">"ELF"</span><span class="p">,</span> <span class="s2">"R_COPY"</span><span class="p">,</span> <span class="n">ELF_RELOC_COPY</span><span class="p">)</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.Architecture.skip_and_return_value">
|
||
<code class="descname">skip_and_return_value</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#Architecture.skip_and_return_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.Architecture.skip_and_return_value" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">skip_and_return_value</span></code> reads the instruction(s) in <code class="docutils literal notranslate"><span class="pre">data</span></code> at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> and returns a string of
|
||
bytes of the same length which doesn’t call and instead <em>return a value</em>.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Architecture subclasses should implement this method.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be converted</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">string containing len(data) which always branches to the same location as the provided instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">skip_and_return_value</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"call 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['mov ', 'eax', ', ', '0x0'], 5L)</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.address_size">
|
||
<code class="descname">address_size</code><em class="property"> = 8</em><a class="headerlink" href="#binaryninja.architecture.Architecture.address_size" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.calling_conventions">
|
||
<code class="descname">calling_conventions</code><a class="headerlink" href="#binaryninja.architecture.Architecture.calling_conventions" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Dict of CallingConvention objects (read-only)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.default_int_size">
|
||
<code class="descname">default_int_size</code><em class="property"> = 4</em><a class="headerlink" href="#binaryninja.architecture.Architecture.default_int_size" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.endianness">
|
||
<code class="descname">endianness</code><em class="property"> = <Endianness.LittleEndian: 0></em><a class="headerlink" href="#binaryninja.architecture.Architecture.endianness" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.flag_conditions_for_semantic_flag_group">
|
||
<code class="descname">flag_conditions_for_semantic_flag_group</code><em class="property"> = {}</em><a class="headerlink" href="#binaryninja.architecture.Architecture.flag_conditions_for_semantic_flag_group" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.flag_roles">
|
||
<code class="descname">flag_roles</code><em class="property"> = {}</em><a class="headerlink" href="#binaryninja.architecture.Architecture.flag_roles" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.flag_write_types">
|
||
<code class="descname">flag_write_types</code><em class="property"> = []</em><a class="headerlink" href="#binaryninja.architecture.Architecture.flag_write_types" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.flags">
|
||
<code class="descname">flags</code><em class="property"> = []</em><a class="headerlink" href="#binaryninja.architecture.Architecture.flags" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.flags_required_for_flag_condition">
|
||
<code class="descname">flags_required_for_flag_condition</code><em class="property"> = {}</em><a class="headerlink" href="#binaryninja.architecture.Architecture.flags_required_for_flag_condition" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.flags_required_for_semantic_flag_group">
|
||
<code class="descname">flags_required_for_semantic_flag_group</code><em class="property"> = {}</em><a class="headerlink" href="#binaryninja.architecture.Architecture.flags_required_for_semantic_flag_group" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.flags_written_by_flag_write_type">
|
||
<code class="descname">flags_written_by_flag_write_type</code><em class="property"> = {}</em><a class="headerlink" href="#binaryninja.architecture.Architecture.flags_written_by_flag_write_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.full_width_regs">
|
||
<code class="descname">full_width_regs</code><a class="headerlink" href="#binaryninja.architecture.Architecture.full_width_regs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List of full width register strings (read-only)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.global_regs">
|
||
<code class="descname">global_regs</code><em class="property"> = []</em><a class="headerlink" href="#binaryninja.architecture.Architecture.global_regs" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.instr_alignment">
|
||
<code class="descname">instr_alignment</code><em class="property"> = 1</em><a class="headerlink" href="#binaryninja.architecture.Architecture.instr_alignment" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.intrinsics">
|
||
<code class="descname">intrinsics</code><em class="property"> = {}</em><a class="headerlink" href="#binaryninja.architecture.Architecture.intrinsics" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.link_reg">
|
||
<code class="descname">link_reg</code><em class="property"> = None</em><a class="headerlink" href="#binaryninja.architecture.Architecture.link_reg" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.list">
|
||
<code class="descname">list</code><em class="property"> = []</em><a class="headerlink" href="#binaryninja.architecture.Architecture.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.max_instr_length">
|
||
<code class="descname">max_instr_length</code><em class="property"> = 16</em><a class="headerlink" href="#binaryninja.architecture.Architecture.max_instr_length" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.name">
|
||
<code class="descname">name</code><em class="property"> = None</em><a class="headerlink" href="#binaryninja.architecture.Architecture.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.next_address">
|
||
<code class="descname">next_address</code><em class="property"> = 0</em><a class="headerlink" href="#binaryninja.architecture.Architecture.next_address" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.opcode_display_length">
|
||
<code class="descname">opcode_display_length</code><em class="property"> = 8</em><a class="headerlink" href="#binaryninja.architecture.Architecture.opcode_display_length" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.reg_stacks">
|
||
<code class="descname">reg_stacks</code><em class="property"> = {}</em><a class="headerlink" href="#binaryninja.architecture.Architecture.reg_stacks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.regs">
|
||
<code class="descname">regs</code><em class="property"> = {}</em><a class="headerlink" href="#binaryninja.architecture.Architecture.regs" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.semantic_class_for_flag_write_type">
|
||
<code class="descname">semantic_class_for_flag_write_type</code><em class="property"> = {}</em><a class="headerlink" href="#binaryninja.architecture.Architecture.semantic_class_for_flag_write_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.semantic_flag_classes">
|
||
<code class="descname">semantic_flag_classes</code><em class="property"> = []</em><a class="headerlink" href="#binaryninja.architecture.Architecture.semantic_flag_classes" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.semantic_flag_groups">
|
||
<code class="descname">semantic_flag_groups</code><em class="property"> = []</em><a class="headerlink" href="#binaryninja.architecture.Architecture.semantic_flag_groups" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.stack_pointer">
|
||
<code class="descname">stack_pointer</code><em class="property"> = None</em><a class="headerlink" href="#binaryninja.architecture.Architecture.stack_pointer" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.architecture.Architecture.standalone_platform">
|
||
<code class="descname">standalone_platform</code><a class="headerlink" href="#binaryninja.architecture.Architecture.standalone_platform" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Architecture standalone platform (read-only)</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="binaryninja.architecture.ArchitectureHook">
|
||
<em class="property">class </em><code class="descname">ArchitectureHook</code><span class="sig-paren">(</span><em>base_arch</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#ArchitectureHook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.ArchitectureHook" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="binaryninja.architecture.CoreArchitecture.html#binaryninja.architecture.CoreArchitecture" title="binaryninja.architecture.CoreArchitecture"><code class="xref py py-class docutils literal notranslate"><span class="pre">binaryninja.architecture.CoreArchitecture</span></code></a></p>
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.ArchitectureHook.register">
|
||
<code class="descname">register</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#ArchitectureHook.register"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.ArchitectureHook.register" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="binaryninja.architecture.CoreArchitecture">
|
||
<em class="property">class </em><code class="descname">CoreArchitecture</code><span class="sig-paren">(</span><em>handle</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="binaryninja.architecture.Architecture.html#binaryninja.architecture.Architecture" title="binaryninja.architecture.Architecture"><code class="xref py py-class docutils literal notranslate"><span class="pre">binaryninja.architecture.Architecture</span></code></a></p>
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.always_branch">
|
||
<code class="descname">always_branch</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.always_branch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.always_branch" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">always_branch</span></code> reads the instruction(s) in <code class="docutils literal notranslate"><span class="pre">data</span></code> at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> and returns a string of bytes
|
||
of the same length which always branches.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be converted</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">string containing len(data) which always branches to the same location as the provided instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">bytes</span> <span class="o">=</span> <span class="n">arch</span><span class="o">.</span><span class="n">always_branch</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="nb">bytes</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['nop '], 1L)</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="nb">bytes</span><span class="p">[</span><span class="mi">1</span><span class="p">:],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['jmp ', '0x9'], 5L)</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.assemble">
|
||
<code class="descname">assemble</code><span class="sig-paren">(</span><em>code</em>, <em>addr=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.assemble"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.assemble" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">assemble</span></code> converts the string of assembly instructions <code class="docutils literal notranslate"><span class="pre">code</span></code> loaded at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> to the
|
||
byte representation of those instructions.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>code</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – string representation of the instructions to be assembled</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address that the instructions will be loaded at</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the bytes for the assembled instructions</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Python3 - a ‘bytes’ object; Python2 - a ‘bytes’ object</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)</span>
|
||
<span class="go">'\x0f\x84\x04\x00\x00\x00'</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.convert_to_nop">
|
||
<code class="descname">convert_to_nop</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.convert_to_nop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.convert_to_nop" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">convert_to_nop</span></code> reads the instruction(s) in <code class="docutils literal notranslate"><span class="pre">data</span></code> at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> and returns a string of nop
|
||
instructions of the same length as data.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be converted</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">string containing len(data) worth of no-operation instructions</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">convert_to_nop</span><span class="p">(</span><span class="s2">"</span><span class="se">\x00\x00</span><span class="s2">"</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">'\x90\x90'</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.get_associated_arch_by_address">
|
||
<code class="descname">get_associated_arch_by_address</code><span class="sig-paren">(</span><em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.get_associated_arch_by_address"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.get_associated_arch_by_address" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.get_flag_condition_low_level_il">
|
||
<code class="descname">get_flag_condition_low_level_il</code><span class="sig-paren">(</span><em>cond</em>, <em>sem_class</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.get_flag_condition_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.get_flag_condition_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>cond</strong> (<a class="reference internal" href="binaryninja.enums.LowLevelILFlagCondition.html#binaryninja.enums.LowLevelILFlagCondition" title="binaryninja.enums.LowLevelILFlagCondition"><em>LowLevelILFlagCondition</em></a>) – Flag condition to be computed</li>
|
||
<li><strong>sem_class</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Semantic class to be used (None for default semantics)</li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – LowLevelILFunction object to append LowLevelILExpr objects to</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.lowlevelil.LowLevelILExpr.html#binaryninja.lowlevelil.LowLevelILExpr" title="binaryninja.lowlevelil.LowLevelILExpr">LowLevelILExpr</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.get_flag_role">
|
||
<code class="descname">get_flag_role</code><span class="sig-paren">(</span><em>flag</em>, <em>sem_class=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.get_flag_role"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.get_flag_role" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_flag_role</span></code> gets the role of a given flag.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>flag</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – flag</li>
|
||
<li><strong>sem_class</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – optional semantic flag class</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">flag role</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.enums.FlagRole.html#binaryninja.enums.FlagRole" title="binaryninja.enums.FlagRole">FlagRole</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.get_flag_write_low_level_il">
|
||
<code class="descname">get_flag_write_low_level_il</code><span class="sig-paren">(</span><em>op</em>, <em>size</em>, <em>write_type</em>, <em>flag</em>, <em>operands</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.get_flag_write_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.get_flag_write_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>op</strong> (<a class="reference internal" href="binaryninja.enums.LowLevelILOperation.html#binaryninja.enums.LowLevelILOperation" title="binaryninja.enums.LowLevelILOperation"><em>LowLevelILOperation</em></a>) – </li>
|
||
<li><strong>size</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
|
||
<li><strong>write_type</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – </li>
|
||
<li><strong>or int</strong><strong>) </strong><strong>operands</strong> (<em>list</em><em>(</em><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – a list of either items that are either string register names or constant integer values</li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.lowlevelil.LowLevelILExpr.html#binaryninja.lowlevelil.LowLevelILExpr" title="binaryninja.lowlevelil.LowLevelILExpr">LowLevelILExpr</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.get_flags_required_for_flag_condition">
|
||
<code class="descname">get_flags_required_for_flag_condition</code><span class="sig-paren">(</span><em>cond</em>, <em>sem_class=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.get_flags_required_for_flag_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.get_flags_required_for_flag_condition" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.get_instruction_info">
|
||
<code class="descname">get_instruction_info</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.get_instruction_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.get_instruction_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_instruction_info</span></code> returns an InstructionInfo object for the instruction at the given virtual address
|
||
<code class="docutils literal notranslate"><span class="pre">addr</span></code> with data <code class="docutils literal notranslate"><span class="pre">data</span></code>.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">The instruction info object should always set the InstructionInfo.length to the instruction length, and the branches of the proper types should be added if the instruction is a branch.</p>
|
||
</div>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – max_instruction_length bytes from the binary at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code></li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address of bytes in <code class="docutils literal notranslate"><span class="pre">data</span></code></li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the InstructionInfo for the current instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.function.InstructionInfo.html#binaryninja.function.InstructionInfo" title="binaryninja.function.InstructionInfo">InstructionInfo</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.get_instruction_low_level_il">
|
||
<code class="descname">get_instruction_low_level_il</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.get_instruction_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.get_instruction_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_instruction_low_level_il</span></code> appends LowLevelILExpr objects to <code class="docutils literal notranslate"><span class="pre">il</span></code> for the instruction at the given
|
||
virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> with data <code class="docutils literal notranslate"><span class="pre">data</span></code>.</p>
|
||
<p>This is used to analyze arbitrary data at an address, if you are working with an existing binary, you likely
|
||
want to be using <code class="docutils literal notranslate"><span class="pre">Function.get_low_level_il_at</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – max_instruction_length bytes from the binary at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code></li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address of bytes in <code class="docutils literal notranslate"><span class="pre">data</span></code></li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – The function the current instruction belongs to</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the length of the current instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.get_instruction_text">
|
||
<code class="descname">get_instruction_text</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.get_instruction_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.get_instruction_text" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">get_instruction_text</span></code> returns a list of InstructionTextToken objects for the instruction at the given virtual
|
||
address <code class="docutils literal notranslate"><span class="pre">addr</span></code> with data <code class="docutils literal notranslate"><span class="pre">data</span></code>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – max_instruction_length bytes from the binary at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code></li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – virtual address of bytes in <code class="docutils literal notranslate"><span class="pre">data</span></code></li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">an InstructionTextToken list for the current instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list(<a class="reference internal" href="binaryninja.datarender.InstructionTextToken.html#binaryninja.datarender.InstructionTextToken" title="binaryninja.datarender.InstructionTextToken">InstructionTextToken</a>)</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.get_semantic_flag_group_low_level_il">
|
||
<code class="descname">get_semantic_flag_group_low_level_il</code><span class="sig-paren">(</span><em>sem_group</em>, <em>il</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.get_semantic_flag_group_low_level_il"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.get_semantic_flag_group_low_level_il" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>sem_group</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – </li>
|
||
<li><strong>il</strong> (<a class="reference internal" href="binaryninja.lowlevelil.LowLevelILFunction.html#binaryninja.lowlevelil.LowLevelILFunction" title="binaryninja.lowlevelil.LowLevelILFunction"><em>LowLevelILFunction</em></a>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="binaryninja.lowlevelil.LowLevelILExpr.html#binaryninja.lowlevelil.LowLevelILExpr" title="binaryninja.lowlevelil.LowLevelILExpr">LowLevelILExpr</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.invert_branch">
|
||
<code class="descname">invert_branch</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.invert_branch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.invert_branch" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">invert_branch</span></code> reads the instruction(s) in <code class="docutils literal notranslate"><span class="pre">data</span></code> at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> and returns a string of bytes
|
||
of the same length which inverts the branch of provided instruction.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be converted</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">string containing len(data) which always branches to the same location as the provided instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">invert_branch</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">),</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['jne ', '0xa'], 6L)</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">invert_branch</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"jo 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">),</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['jno ', '0xa'], 6L)</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">invert_branch</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"jge 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">),</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['jl ', '0xa'], 6L)</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.is_always_branch_patch_available">
|
||
<code class="descname">is_always_branch_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.is_always_branch_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.is_always_branch_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">is_always_branch_patch_available</span></code> determines if the instruction <code class="docutils literal notranslate"><span class="pre">data</span></code> at <code class="docutils literal notranslate"><span class="pre">addr</span></code> can be made to
|
||
<strong>always branch</strong>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_always_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_always_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"nop"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">False</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.is_invert_branch_patch_available">
|
||
<code class="descname">is_invert_branch_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.is_invert_branch_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.is_invert_branch_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">is_always_branch_patch_available</span></code> determines if the instruction <code class="docutils literal notranslate"><span class="pre">data</span></code> at <code class="docutils literal notranslate"><span class="pre">addr</span></code> can be inverted.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_invert_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_invert_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"nop"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">False</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.is_never_branch_patch_available">
|
||
<code class="descname">is_never_branch_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.is_never_branch_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.is_never_branch_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">is_never_branch_patch_available</span></code> determines if the instruction <code class="docutils literal notranslate"><span class="pre">data</span></code> at <code class="docutils literal notranslate"><span class="pre">addr</span></code> can be made to <strong>never branch</strong>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_never_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"je 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_never_branch_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"nop"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">False</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.is_skip_and_return_value_patch_available">
|
||
<code class="descname">is_skip_and_return_value_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.is_skip_and_return_value_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.is_skip_and_return_value_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">is_skip_and_return_value_patch_available</span></code> determines if the instruction <code class="docutils literal notranslate"><span class="pre">data</span></code> at <code class="docutils literal notranslate"><span class="pre">addr</span></code> is a <em>call-like</em>
|
||
instruction that can be made into an instruction <em>returns a value</em>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_skip_and_return_value_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"call 0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_skip_and_return_value_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"jmp eax"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">False</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.is_skip_and_return_zero_patch_available">
|
||
<code class="descname">is_skip_and_return_zero_patch_available</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.is_skip_and_return_zero_patch_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.is_skip_and_return_zero_patch_available" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">is_skip_and_return_zero_patch_available</span></code> determines if the instruction <code class="docutils literal notranslate"><span class="pre">data</span></code> at <code class="docutils literal notranslate"><span class="pre">addr</span></code> is a <em>call-like</em>
|
||
instruction that can be made into an instruction <em>returns zero</em>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be checked</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the instruction can be patched, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_skip_and_return_zero_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"call 0"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_skip_and_return_zero_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"call eax"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">is_skip_and_return_zero_patch_available</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"jmp eax"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">False</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.architecture.CoreArchitecture.skip_and_return_value">
|
||
<code class="descname">skip_and_return_value</code><span class="sig-paren">(</span><em>data</em>, <em>addr</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#CoreArchitecture.skip_and_return_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.CoreArchitecture.skip_and_return_value" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">skip_and_return_value</span></code> reads the instruction(s) in <code class="docutils literal notranslate"><span class="pre">data</span></code> at virtual address <code class="docutils literal notranslate"><span class="pre">addr</span></code> and returns a string of
|
||
bytes of the same length which doesn’t call and instead <em>return a value</em>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – bytes for the instruction to be converted</li>
|
||
<li><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – the virtual address of the instruction to be patched</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">string containing len(data) which always branches to the same location as the provided instruction</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">arch</span><span class="o">.</span><span class="n">get_instruction_text</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">skip_and_return_value</span><span class="p">(</span><span class="n">arch</span><span class="o">.</span><span class="n">assemble</span><span class="p">(</span><span class="s2">"call 10"</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="mi">0</span><span class="p">)</span>
|
||
<span class="go">(['mov ', 'eax', ', ', '0x0'], 5L)</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="binaryninja.architecture.ReferenceSource">
|
||
<em class="property">class </em><code class="descname">ReferenceSource</code><span class="sig-paren">(</span><em>func</em>, <em>arch</em>, <em>addr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/architecture.html#ReferenceSource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.architecture.ReferenceSource" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="binaryninja.architecture.Architecture.html" class="btn btn-neutral float-right" title="binaryninja.architecture.Architecture" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="index.html" class="btn btn-neutral" title="Binary Ninja Python API Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2015-2019, Vector 35 Inc.
|
||
|
||
</p>
|
||
</div>
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.StickyNav.enable();
|
||
});
|
||
</script>
|
||
|
||
|
||
</body>
|
||
</html> |