-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deployed 3978aa9 with MkDocs version: 1.6.1
- Loading branch information
Showing
8 changed files
with
2,921 additions
and
2,328 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| <!DOCTYPE html> | ||
| <html class="writer-html5" lang="en" > | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <link rel="shortcut icon" href="../img/favicon.ico" /> | ||
| <title>Compatibility - Ghidralib</title> | ||
| <link rel="stylesheet" href="../css/theme.css" /> | ||
| <link rel="stylesheet" href="../css/theme_extra.css" /> | ||
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" /> | ||
| <link href="../assets/_mkdocstrings.css" rel="stylesheet" /> | ||
|
|
||
| <script> | ||
| // Current page data | ||
| var mkdocs_page_name = "Compatibility"; | ||
| var mkdocs_page_input_path = "compatibility.md"; | ||
| var mkdocs_page_url = null; | ||
| </script> | ||
|
|
||
| <!--[if lt IE 9]> | ||
| <script src="../js/html5shiv.min.js"></script> | ||
| <![endif]--> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script> | ||
| <script>hljs.highlightAll();</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 stickynav"> | ||
| <div class="wy-side-scroll"> | ||
| <div class="wy-side-nav-search"> | ||
| <a href=".." class="icon icon-home"> Ghidralib | ||
| </a><div role="search"> | ||
| <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> | ||
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" /> | ||
| </form> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="..">Ghidralib</a> | ||
| </li> | ||
| </ul> | ||
| <ul class="current"> | ||
| <li class="toctree-l1 current"><a class="reference internal current" href="#">Compatibility</a> | ||
| <ul class="current"> | ||
| <li class="toctree-l2"><a class="reference internal" href="#compatibility-matrix">Compatibility matrix</a> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#architectures">Architectures</a> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#python-3">Python 3</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="../getting_started/">Getting Started</a> | ||
| </li> | ||
| </ul> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="../reference/">API reference</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="Mobile navigation menu"> | ||
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| <a href="..">Ghidralib</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=".." class="icon icon-home" aria-label="Docs"></a></li> | ||
| <li class="breadcrumb-item active">Compatibility</li> | ||
| <li class="wy-breadcrumbs-aside"> | ||
| </li> | ||
| </ul> | ||
| <hr/> | ||
| </div> | ||
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
| <div class="section" itemprop="articleBody"> | ||
|
|
||
| <h1 id="compatibility">Compatibility</h1> | ||
| <p>This library uses unstable Ghidra APIs, so it's expected to break from time to time | ||
| (when Ghidra changes internal implementation details).</p> | ||
| <p>In this document I'll keep track of the compatibility status of the library. I don't | ||
| to backport fixes and do complex hacks to support more than one Ghidra version at once. | ||
| Instead, for each Ghidra version I'll try to provide a working ghidralib version.</p> | ||
| <p>Keep in mind, that this library is still in rapid development, and the API may and will | ||
| change before we reach the first stable release (v1.0).</p> | ||
| <h3 id="compatibility-matrix">Compatibility matrix</h3> | ||
| <p>Here is a compatibility matrix of tested Ghidra and ghidralib versions:</p> | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>ghidralib \ ghidra</th> | ||
| <th>11.2.1</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>0.1.0</td> | ||
| <td>✅</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| <p>(Compatibility is checked by running a <a href="../tests/ghidralib_test.py">testsuite</a> | ||
| on a test binary)</p> | ||
| <h3 id="architectures">Architectures</h3> | ||
| <p>I work almost exclusively on x86 and x86_64, so the library is tested | ||
| on these architectures. There is nothing specific to x86 in the code, | ||
| but I expect that some exotic architectures will not work correctly. | ||
| Freel free to submit issues/PRs if you find something is broken.</p> | ||
| <h3 id="python-3">Python 3</h3> | ||
| <p>I plan to support the Python 3 built into Ghidra (PyGhidra), as soon as it's released | ||
| and I manage to get it working. I hope to support both Jython and Python3 | ||
| with the same codebase.</p> | ||
| <p>I don't personally use Ghidrathon, so I don't plan to provide any support for it. | ||
| That would be nice to have, and I suspect the steps required are the same as for | ||
| PyGhidra, so if anyone wants to take a shot at it, PRs are welcome.</p> | ||
|
|
||
| </div> | ||
| </div><footer> | ||
| <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> | ||
| <a href=".." class="btn btn-neutral float-left" title="Ghidralib"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| <a href="../getting_started/" class="btn btn-neutral float-right" title="Getting Started">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| </div> | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <!-- Copyright etc --> | ||
| </div> | ||
|
|
||
| Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. | ||
| </footer> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
| </section> | ||
|
|
||
| </div> | ||
|
|
||
| <div class="rst-versions" role="note" aria-label="Versions"> | ||
| <span class="rst-current-version" data-toggle="rst-current-version"> | ||
|
|
||
|
|
||
| <span><a href=".." style="color: #fcfcfc">« Previous</a></span> | ||
|
|
||
|
|
||
| <span><a href="../getting_started/" style="color: #fcfcfc">Next »</a></span> | ||
|
|
||
| </span> | ||
| </div> | ||
| <script src="../js/jquery-3.6.0.min.js"></script> | ||
| <script>var base_url = "..";</script> | ||
| <script src="../js/theme_extra.js"></script> | ||
| <script src="../js/theme.js"></script> | ||
| <script src="../search/main.js"></script> | ||
| <script> | ||
| jQuery(function () { | ||
| SphinxRtdTheme.Navigation.enable(true); | ||
| }); | ||
| </script> | ||
|
|
||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Oops, something went wrong.