|
| 1 | +<!DOCTYPE html> |
| 2 | +<html class="writer-html5" lang="en" > |
| 3 | +<head> |
| 4 | + <meta charset="utf-8" /> |
| 5 | + <meta http-equiv="X-UA-Compatible" content="IE=edge" /> |
| 6 | + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| 7 | + <link rel="shortcut icon" href="../img/favicon.ico" /> |
| 8 | + <title>Compatibility - Ghidralib</title> |
| 9 | + <link rel="stylesheet" href="../css/theme.css" /> |
| 10 | + <link rel="stylesheet" href="../css/theme_extra.css" /> |
| 11 | + <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" /> |
| 12 | + <link href="../assets/_mkdocstrings.css" rel="stylesheet" /> |
| 13 | + |
| 14 | + <script> |
| 15 | + // Current page data |
| 16 | + var mkdocs_page_name = "Compatibility"; |
| 17 | + var mkdocs_page_input_path = "compatibility.md"; |
| 18 | + var mkdocs_page_url = null; |
| 19 | + </script> |
| 20 | + |
| 21 | + <!--[if lt IE 9]> |
| 22 | + <script src="../js/html5shiv.min.js"></script> |
| 23 | + <![endif]--> |
| 24 | + <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script> |
| 25 | + <script>hljs.highlightAll();</script> |
| 26 | +</head> |
| 27 | + |
| 28 | +<body class="wy-body-for-nav" role="document"> |
| 29 | + |
| 30 | + <div class="wy-grid-for-nav"> |
| 31 | + <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> |
| 32 | + <div class="wy-side-scroll"> |
| 33 | + <div class="wy-side-nav-search"> |
| 34 | + <a href=".." class="icon icon-home"> Ghidralib |
| 35 | + </a><div role="search"> |
| 36 | + <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| 37 | + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" /> |
| 38 | + </form> |
| 39 | +</div> |
| 40 | + </div> |
| 41 | + |
| 42 | + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| 43 | + <ul> |
| 44 | + <li class="toctree-l1"><a class="reference internal" href="..">Ghidralib</a> |
| 45 | + </li> |
| 46 | + </ul> |
| 47 | + <ul class="current"> |
| 48 | + <li class="toctree-l1 current"><a class="reference internal current" href="#">Compatibility</a> |
| 49 | + <ul class="current"> |
| 50 | + <li class="toctree-l2"><a class="reference internal" href="#compatibility-matrix">Compatibility matrix</a> |
| 51 | + </li> |
| 52 | + <li class="toctree-l2"><a class="reference internal" href="#architectures">Architectures</a> |
| 53 | + </li> |
| 54 | + <li class="toctree-l2"><a class="reference internal" href="#python-3">Python 3</a> |
| 55 | + </li> |
| 56 | + </ul> |
| 57 | + </li> |
| 58 | + </ul> |
| 59 | + <ul> |
| 60 | + <li class="toctree-l1"><a class="reference internal" href="../getting_started/">Getting Started</a> |
| 61 | + </li> |
| 62 | + </ul> |
| 63 | + <ul> |
| 64 | + <li class="toctree-l1"><a class="reference internal" href="../reference/">API reference</a> |
| 65 | + </li> |
| 66 | + </ul> |
| 67 | + </div> |
| 68 | + </div> |
| 69 | + </nav> |
| 70 | + |
| 71 | + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| 72 | + <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu"> |
| 73 | + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 74 | + <a href="..">Ghidralib</a> |
| 75 | + |
| 76 | + </nav> |
| 77 | + <div class="wy-nav-content"> |
| 78 | + <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> |
| 79 | + <ul class="wy-breadcrumbs"> |
| 80 | + <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li> |
| 81 | + <li class="breadcrumb-item active">Compatibility</li> |
| 82 | + <li class="wy-breadcrumbs-aside"> |
| 83 | + </li> |
| 84 | + </ul> |
| 85 | + <hr/> |
| 86 | +</div> |
| 87 | + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| 88 | + <div class="section" itemprop="articleBody"> |
| 89 | + |
| 90 | + <h1 id="compatibility">Compatibility</h1> |
| 91 | +<p>This library uses unstable Ghidra APIs, so it's expected to break from time to time |
| 92 | +(when Ghidra changes internal implementation details).</p> |
| 93 | +<p>In this document I'll keep track of the compatibility status of the library. I don't |
| 94 | +to backport fixes and do complex hacks to support more than one Ghidra version at once. |
| 95 | +Instead, for each Ghidra version I'll try to provide a working ghidralib version.</p> |
| 96 | +<p>Keep in mind, that this library is still in rapid development, and the API may and will |
| 97 | +change before we reach the first stable release (v1.0).</p> |
| 98 | +<h3 id="compatibility-matrix">Compatibility matrix</h3> |
| 99 | +<p>Here is a compatibility matrix of tested Ghidra and ghidralib versions:</p> |
| 100 | +<table> |
| 101 | +<thead> |
| 102 | +<tr> |
| 103 | +<th>ghidralib \ ghidra</th> |
| 104 | +<th>11.2.1</th> |
| 105 | +</tr> |
| 106 | +</thead> |
| 107 | +<tbody> |
| 108 | +<tr> |
| 109 | +<td>0.1.0</td> |
| 110 | +<td>✅</td> |
| 111 | +</tr> |
| 112 | +</tbody> |
| 113 | +</table> |
| 114 | +<p>(Compatibility is checked by running a <a href="../tests/ghidralib_test.py">testsuite</a> |
| 115 | +on a test binary)</p> |
| 116 | +<h3 id="architectures">Architectures</h3> |
| 117 | +<p>I work almost exclusively on x86 and x86_64, so the library is tested |
| 118 | +on these architectures. There is nothing specific to x86 in the code, |
| 119 | +but I expect that some exotic architectures will not work correctly. |
| 120 | +Freel free to submit issues/PRs if you find something is broken.</p> |
| 121 | +<h3 id="python-3">Python 3</h3> |
| 122 | +<p>I plan to support the Python 3 built into Ghidra (PyGhidra), as soon as it's released |
| 123 | +and I manage to get it working. I hope to support both Jython and Python3 |
| 124 | +with the same codebase.</p> |
| 125 | +<p>I don't personally use Ghidrathon, so I don't plan to provide any support for it. |
| 126 | +That would be nice to have, and I suspect the steps required are the same as for |
| 127 | +PyGhidra, so if anyone wants to take a shot at it, PRs are welcome.</p> |
| 128 | + |
| 129 | + </div> |
| 130 | + </div><footer> |
| 131 | + <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> |
| 132 | + <a href=".." class="btn btn-neutral float-left" title="Ghidralib"><span class="icon icon-circle-arrow-left"></span> Previous</a> |
| 133 | + <a href="../getting_started/" class="btn btn-neutral float-right" title="Getting Started">Next <span class="icon icon-circle-arrow-right"></span></a> |
| 134 | + </div> |
| 135 | + |
| 136 | + <hr/> |
| 137 | + |
| 138 | + <div role="contentinfo"> |
| 139 | + <!-- Copyright etc --> |
| 140 | + </div> |
| 141 | + |
| 142 | + 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>. |
| 143 | +</footer> |
| 144 | + |
| 145 | + </div> |
| 146 | + </div> |
| 147 | + |
| 148 | + </section> |
| 149 | + |
| 150 | + </div> |
| 151 | + |
| 152 | + <div class="rst-versions" role="note" aria-label="Versions"> |
| 153 | + <span class="rst-current-version" data-toggle="rst-current-version"> |
| 154 | + |
| 155 | + |
| 156 | + <span><a href=".." style="color: #fcfcfc">« Previous</a></span> |
| 157 | + |
| 158 | + |
| 159 | + <span><a href="../getting_started/" style="color: #fcfcfc">Next »</a></span> |
| 160 | + |
| 161 | + </span> |
| 162 | +</div> |
| 163 | + <script src="../js/jquery-3.6.0.min.js"></script> |
| 164 | + <script>var base_url = "..";</script> |
| 165 | + <script src="../js/theme_extra.js"></script> |
| 166 | + <script src="../js/theme.js"></script> |
| 167 | + <script src="../search/main.js"></script> |
| 168 | + <script> |
| 169 | + jQuery(function () { |
| 170 | + SphinxRtdTheme.Navigation.enable(true); |
| 171 | + }); |
| 172 | + </script> |
| 173 | + |
| 174 | +</body> |
| 175 | +</html> |
0 commit comments