superghidra 0.2.0__tar.gz

superghidra-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 SuperGhidra Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

superghidra-0.2.0/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.4
+Name: superghidra
+Version: 0.2.0
+Summary: SuperGhidra: High-Performance Ghidra Architecture & GPU Acceleration Suite
+Author: yuatemycat
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/yuatemycat/SuperGhidra
+Project-URL: Repository, https://github.com/yuatemycat/SuperGhidra
+Project-URL: Documentation, https://github.com/yuatemycat/SuperGhidra/tree/master/docs
+Project-URL: Issue Tracker, https://github.com/yuatemycat/SuperGhidra/issues
+Keywords: ghidra,reverse-engineering,decompiler,gpu-acceleration,vulkan,directx12,z3,smt,pcode,arm64,x86-64,disassembler,binary-analysis,mcp
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Topic :: Software Development :: Disassemblers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Provides-Extra: smt
+Requires-Dist: z3-solver; extra == "smt"
+Provides-Extra: gpu
+Requires-Dist: wgpu; extra == "gpu"
+Provides-Extra: storage
+Requires-Dist: lz4; extra == "storage"
+Requires-Dist: zstandard; extra == "storage"
+Provides-Extra: frida
+Requires-Dist: frida; extra == "frida"
+Provides-Extra: ghidra
+Requires-Dist: pyghidra; extra == "ghidra"
+Provides-Extra: all
+Requires-Dist: z3-solver; extra == "all"
+Requires-Dist: wgpu; extra == "all"
+Requires-Dist: lz4; extra == "all"
+Requires-Dist: zstandard; extra == "all"
+Requires-Dist: frida; extra == "all"
+Requires-Dist: pyghidra; extra == "all"
+Dynamic: license-file
+
+# SuperGhidra
+
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Python 3.10+](https://img.shields.io/badge/Python-3.10+-3776AB.svg)](https://www.python.org/)
+[![CI](https://github.com/yuatemycat/SuperGhidra/actions/workflows/ci.yml/badge.svg)](https://github.com/yuatemycat/SuperGhidra/actions/workflows/ci.yml)
+
+Python tools that make Ghidra faster to script against, plus a few analyses it doesn't do out of the box: MFC/C++ class recovery, `Serialize()` layout tracing, cross-version function matching, and a Z3 equivalence checker for P-code.
+
+## Why
+
+Ghidra's analysis is excellent, but driving it from scripts is slow. Each headless run pays 5–15 seconds of JVM startup. A project lock stops a second process from reading. Bulk jobs such as sweeping a 20 MB ARM64 `.text` section or matching 45,000 functions between two builds run on a single CPU thread.
+
+SuperGhidra keeps one read-only Ghidra project loaded in a background daemon and caches its answers. Bulk work moves into plain Python, NumPy or GPU compute shaders. Much of the format and class-recovery work doesn't need Ghidra at all.
+
+## What's inside
+
+| Package | What it does |
+| :--- | :--- |
+| `core` | Daemon on `127.0.0.1:5073` with a SQLite cache. Renames and comments go to a JSON overlay, never into the `.rep`. Also includes a resource governor (`eco` / `balanced` / `turbo` / `auto`) and shared-memory IPC. |
+| `formats` | ELF / PE / Mach-O loader, MSVC RTTI and MFC `CRuntimeClass` recovery, `Serialize()` tracing, a CArchive decoder, and DWARF 5 / Breakpad / map export. None of these need Ghidra. |
+| `lifters` | ARM64 → P-code lifter (integer subset), x86 and ARM/Thumb decoders, and a Z3 checker that proves two snippets equivalent or answers `UNKNOWN`. |
+| `diff` | Matches functions across versions with CFG feature vectors, then finds struct fields whose offsets moved and rewrites the accesses. |
+| `acceleration` | WGPU shaders that scan ARM64 for `ADRP+ADD/LDR` pairs and function prologues, with a SIMD CPU fallback. |
+| `storage` | LZ4 / Zstd codec for Ghidra's 16 KB buffer pages, plus a standalone Java `BufferFile` codec. |
+| `integrations` | APK ↔ JNI cross-referencer, Android emulator memory reader with a device allow-list, and an LLM naming pipeline. |
+
+Each package has its own README under [`superghidra/`](superghidra/).
+
+## Results so far
+
+- **MFC class recovery:** 52 of 52 serializable classes in `mfc140u.dll` are linked to their `Serialize()`. The same holds for 118 of 118 in SOLIDWORKS' `swdocumentmgr.dll`.
+- **`Serialize()` tracing:** 115 classes in `swdocumentmgr.dll` are traced in about 2 seconds. 83 of them have matching load and store paths.
+- **CArchive decoding:** the layouts recovered from that DLL alone decode the model history in a real SOLIDWORKS part file: feature names, IDs, timestamps and configurations. The file uses a newer format than the DLL, so the end of the stream is still undecoded.
+- **x86 decoder:** instruction lengths match Capstone on about 6.7M instructions of Windows code, including AVX-512.
+- **Storage:** pages shrink by 79% with LZ4 and by 86% with Zstd. These figures come from synthetic Ghidra-like pages, not real projects.
+- **Throughput:** function seeding runs at 12M instructions/s on WGPU and 50M/s with SIMD. A shared-memory round trip takes about 5 µs.
+
+All numbers come from one Windows development machine. The full reports are in [`docs/benchmarks/`](docs/benchmarks/).
+
+## Quick start
+
+```bash
+git clone https://github.com/yuatemycat/SuperGhidra
+cd SuperGhidra
+pip install -e ".[all]"      # or pick extras: smt, gpu, storage, ghidra, frida
+python -m pytest -q
+```
+
+**Unified CLI:**
+
+SuperGhidra ships with an integrated standalone command-line executable `superghidra`:
+
+```bash
+# Display version and hardware acceleration telemetry
+superghidra version
+
+# Staged P-code decompiler (MBA simplification, opaque branch pruning, goto-free C)
+superghidra decompile target.dll --rva 0x140001000 --arch x86_64 -o decompiled.c
+
+# Import IDA Pro .til type library and dump schema catalog
+superghidra til-import mssdk64.til -o catalog.json
+
+# Match binary bytes against IDA FLIRT signature database
+superghidra flirt-match vc32rtf.sig target.exe --rva 0x1000
+
+# Recover MSVC / MFC C++ class hierarchies, RTTI structures, and virtual call tables
+superghidra rtti-recover app.dll -o classes.json
+
+# Filter raw decompiler output into clean, compilable C
+superghidra filter raw_decompile.c -o clean.c
+```
+
+**Inspect a Windows binary (no Ghidra needed):**
+
+```bash
+python -m superghidra.formats.binary_loader app.dll          # sections, imports, exports
+python -m superghidra.formats.msvc_class_recovery app.dll    # RTTI + MFC classes
+python -m superghidra.formats.serialize_trace app.dll CMyDoc # Serialize() field layout
+```
+
+**From Python:**
+
+```python
+from superghidra.formats.binary_loader import load_binary
+from superghidra.formats.msvc_class_recovery import recover_classes
+import superghidra as sg
+
+img = load_binary("app.dll")
+print(img.format, img.arch, len(img.sections))
+
+report = recover_classes("app.dll")
+print(len(report.mfc_classes), "MFC classes")
+
+# Lift one ARM64 instruction and check it against itself with Z3
+ops = sg.ARM64PcodeLifter().lift_instruction(0x1000, 0x91008041)  # add x1, x2, #0x20
+print(sg.SMTPcodeVerifier().verify_equivalence(ops, ops).equivalent)
+```
+
+**Query a Ghidra project through the daemon** (needs JDK 21, Ghidra 11+ and `pyghidra`):
+
+```bash
+export GHIDRA_INSTALL_DIR=/path/to/ghidra
+python ghidra_oracle.py --project-dir ~/re/proj --project-name game --program-name libgame.so status
+python ghidra_oracle.py decompile 0x00CF2D84   # first call boots Ghidra, later calls hit the cache
+python ghidra_oracle.py rename 0x00CF2D84 World_tick
+python ghidra_oracle.py mode eco               # throttle CPU use
+python ghidra_oracle.py stop
+```
+
+Run `python ghidra_oracle.py --help` to list every command.
+
+**Configuration** is read from environment variables, and nothing is tied to a particular machine:
+
+| Variable | Used for |
+| :--- | :--- |
+| `GHIDRA_INSTALL_DIR`, `JAVA_HOME` | Ghidra and JDK locations (daemon, headless runs, Java codec build) |
+| `SUPERGHIDRA_PROJECTS` | Default projects for the daemon: `dir,name[,program]` entries joined by `;` |
+| `SUPERGHIDRA_MSVC_ROOT` | Portable MSVC folder, used when gcc/clang aren't on `PATH` |
+| `SUPERGHIDRA_TEST_ARM64_ELF`, `SUPERGHIDRA_TEST_SWDM`, `SUPERGHIDRA_TEST_SW_ROOT` | Optional real binaries / a SOLIDWORKS install for the integration tests. Those tests skip when unset. |
+
+## MCP
+
+Most modules are also exposed as MCP tools through a [pyghidra-mcp](https://github.com/clearbluejar/pyghidra-mcp) fork, including `recover_cpp_classes`, `trace_serialize`, `decode_carchive`, `diff_binaries`, `verify_smt_equivalence` and `gpu_adrp_scan`. This lets an AI agent drive them directly.
+
+## Known limitations
+
+- The Java codec doesn't compress Ghidra projects transparently. Ghidra has no hook for replacing its buffer file, so you have to call the codec explicitly.
+- PDB export is experimental, and MSVC/LLVM tools may not load the output. Use DWARF export instead.
+- The SMT checker is sound but incomplete. Floats, calls, unhandled ops and long loops return `UNKNOWN`.
+- The ARM64 lifter covers integer instructions only. Atomics lift as `UNIMPLEMENTED`.
+- The LLM naming stage needs a real endpoint. Without one, it falls back to neutral names such as `sub_<addr>`, labelled `heuristic-fallback`.
+
+More detail is in [PLAN.md](PLAN.md).
+
+## Repository layout
+
+```
+superghidra/   the package, split into the seven areas above
+tests/         pytest suites, one folder per area
+docs/          benchmark reports and design notes
+ghidra_extension_skeleton/   Java BufferFile codec
+*.py           thin shims so `import binary_loader` etc. keep working for older callers
+```
+
+If you're an AI agent, start with [AGENTS.md](AGENTS.md).
+
+## Contributing
+
+Issues and PRs are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the test workflow and the safety rules: read-only projects, verified symbol commits and the emulator allow-list. Report security issues as described in [SECURITY.md](SECURITY.md).
+
+## License
+
+[Apache 2.0](LICENSE) © 2026 yuatemycat and contributors.

superghidra-0.2.0/README.md

@@ -0,0 +1,153 @@
+# SuperGhidra
+
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Python 3.10+](https://img.shields.io/badge/Python-3.10+-3776AB.svg)](https://www.python.org/)
+[![CI](https://github.com/yuatemycat/SuperGhidra/actions/workflows/ci.yml/badge.svg)](https://github.com/yuatemycat/SuperGhidra/actions/workflows/ci.yml)
+
+Python tools that make Ghidra faster to script against, plus a few analyses it doesn't do out of the box: MFC/C++ class recovery, `Serialize()` layout tracing, cross-version function matching, and a Z3 equivalence checker for P-code.
+
+## Why
+
+Ghidra's analysis is excellent, but driving it from scripts is slow. Each headless run pays 5–15 seconds of JVM startup. A project lock stops a second process from reading. Bulk jobs such as sweeping a 20 MB ARM64 `.text` section or matching 45,000 functions between two builds run on a single CPU thread.
+
+SuperGhidra keeps one read-only Ghidra project loaded in a background daemon and caches its answers. Bulk work moves into plain Python, NumPy or GPU compute shaders. Much of the format and class-recovery work doesn't need Ghidra at all.
+
+## What's inside
+
+| Package | What it does |
+| :--- | :--- |
+| `core` | Daemon on `127.0.0.1:5073` with a SQLite cache. Renames and comments go to a JSON overlay, never into the `.rep`. Also includes a resource governor (`eco` / `balanced` / `turbo` / `auto`) and shared-memory IPC. |
+| `formats` | ELF / PE / Mach-O loader, MSVC RTTI and MFC `CRuntimeClass` recovery, `Serialize()` tracing, a CArchive decoder, and DWARF 5 / Breakpad / map export. None of these need Ghidra. |
+| `lifters` | ARM64 → P-code lifter (integer subset), x86 and ARM/Thumb decoders, and a Z3 checker that proves two snippets equivalent or answers `UNKNOWN`. |
+| `diff` | Matches functions across versions with CFG feature vectors, then finds struct fields whose offsets moved and rewrites the accesses. |
+| `acceleration` | WGPU shaders that scan ARM64 for `ADRP+ADD/LDR` pairs and function prologues, with a SIMD CPU fallback. |
+| `storage` | LZ4 / Zstd codec for Ghidra's 16 KB buffer pages, plus a standalone Java `BufferFile` codec. |
+| `integrations` | APK ↔ JNI cross-referencer, Android emulator memory reader with a device allow-list, and an LLM naming pipeline. |
+
+Each package has its own README under [`superghidra/`](superghidra/).
+
+## Results so far
+
+- **MFC class recovery:** 52 of 52 serializable classes in `mfc140u.dll` are linked to their `Serialize()`. The same holds for 118 of 118 in SOLIDWORKS' `swdocumentmgr.dll`.
+- **`Serialize()` tracing:** 115 classes in `swdocumentmgr.dll` are traced in about 2 seconds. 83 of them have matching load and store paths.
+- **CArchive decoding:** the layouts recovered from that DLL alone decode the model history in a real SOLIDWORKS part file: feature names, IDs, timestamps and configurations. The file uses a newer format than the DLL, so the end of the stream is still undecoded.
+- **x86 decoder:** instruction lengths match Capstone on about 6.7M instructions of Windows code, including AVX-512.
+- **Storage:** pages shrink by 79% with LZ4 and by 86% with Zstd. These figures come from synthetic Ghidra-like pages, not real projects.
+- **Throughput:** function seeding runs at 12M instructions/s on WGPU and 50M/s with SIMD. A shared-memory round trip takes about 5 µs.
+
+All numbers come from one Windows development machine. The full reports are in [`docs/benchmarks/`](docs/benchmarks/).
+
+## Quick start
+
+```bash
+git clone https://github.com/yuatemycat/SuperGhidra
+cd SuperGhidra
+pip install -e ".[all]"      # or pick extras: smt, gpu, storage, ghidra, frida
+python -m pytest -q
+```
+
+**Unified CLI:**
+
+SuperGhidra ships with an integrated standalone command-line executable `superghidra`:
+
+```bash
+# Display version and hardware acceleration telemetry
+superghidra version
+
+# Staged P-code decompiler (MBA simplification, opaque branch pruning, goto-free C)
+superghidra decompile target.dll --rva 0x140001000 --arch x86_64 -o decompiled.c
+
+# Import IDA Pro .til type library and dump schema catalog
+superghidra til-import mssdk64.til -o catalog.json
+
+# Match binary bytes against IDA FLIRT signature database
+superghidra flirt-match vc32rtf.sig target.exe --rva 0x1000
+
+# Recover MSVC / MFC C++ class hierarchies, RTTI structures, and virtual call tables
+superghidra rtti-recover app.dll -o classes.json
+
+# Filter raw decompiler output into clean, compilable C
+superghidra filter raw_decompile.c -o clean.c
+```
+
+**Inspect a Windows binary (no Ghidra needed):**
+
+```bash
+python -m superghidra.formats.binary_loader app.dll          # sections, imports, exports
+python -m superghidra.formats.msvc_class_recovery app.dll    # RTTI + MFC classes
+python -m superghidra.formats.serialize_trace app.dll CMyDoc # Serialize() field layout
+```
+
+**From Python:**
+
+```python
+from superghidra.formats.binary_loader import load_binary
+from superghidra.formats.msvc_class_recovery import recover_classes
+import superghidra as sg
+
+img = load_binary("app.dll")
+print(img.format, img.arch, len(img.sections))
+
+report = recover_classes("app.dll")
+print(len(report.mfc_classes), "MFC classes")
+
+# Lift one ARM64 instruction and check it against itself with Z3
+ops = sg.ARM64PcodeLifter().lift_instruction(0x1000, 0x91008041)  # add x1, x2, #0x20
+print(sg.SMTPcodeVerifier().verify_equivalence(ops, ops).equivalent)
+```
+
+**Query a Ghidra project through the daemon** (needs JDK 21, Ghidra 11+ and `pyghidra`):
+
+```bash
+export GHIDRA_INSTALL_DIR=/path/to/ghidra
+python ghidra_oracle.py --project-dir ~/re/proj --project-name game --program-name libgame.so status
+python ghidra_oracle.py decompile 0x00CF2D84   # first call boots Ghidra, later calls hit the cache
+python ghidra_oracle.py rename 0x00CF2D84 World_tick
+python ghidra_oracle.py mode eco               # throttle CPU use
+python ghidra_oracle.py stop
+```
+
+Run `python ghidra_oracle.py --help` to list every command.
+
+**Configuration** is read from environment variables, and nothing is tied to a particular machine:
+
+| Variable | Used for |
+| :--- | :--- |
+| `GHIDRA_INSTALL_DIR`, `JAVA_HOME` | Ghidra and JDK locations (daemon, headless runs, Java codec build) |
+| `SUPERGHIDRA_PROJECTS` | Default projects for the daemon: `dir,name[,program]` entries joined by `;` |
+| `SUPERGHIDRA_MSVC_ROOT` | Portable MSVC folder, used when gcc/clang aren't on `PATH` |
+| `SUPERGHIDRA_TEST_ARM64_ELF`, `SUPERGHIDRA_TEST_SWDM`, `SUPERGHIDRA_TEST_SW_ROOT` | Optional real binaries / a SOLIDWORKS install for the integration tests. Those tests skip when unset. |
+
+## MCP
+
+Most modules are also exposed as MCP tools through a [pyghidra-mcp](https://github.com/clearbluejar/pyghidra-mcp) fork, including `recover_cpp_classes`, `trace_serialize`, `decode_carchive`, `diff_binaries`, `verify_smt_equivalence` and `gpu_adrp_scan`. This lets an AI agent drive them directly.
+
+## Known limitations
+
+- The Java codec doesn't compress Ghidra projects transparently. Ghidra has no hook for replacing its buffer file, so you have to call the codec explicitly.
+- PDB export is experimental, and MSVC/LLVM tools may not load the output. Use DWARF export instead.
+- The SMT checker is sound but incomplete. Floats, calls, unhandled ops and long loops return `UNKNOWN`.
+- The ARM64 lifter covers integer instructions only. Atomics lift as `UNIMPLEMENTED`.
+- The LLM naming stage needs a real endpoint. Without one, it falls back to neutral names such as `sub_<addr>`, labelled `heuristic-fallback`.
+
+More detail is in [PLAN.md](PLAN.md).
+
+## Repository layout
+
+```
+superghidra/   the package, split into the seven areas above
+tests/         pytest suites, one folder per area
+docs/          benchmark reports and design notes
+ghidra_extension_skeleton/   Java BufferFile codec
+*.py           thin shims so `import binary_loader` etc. keep working for older callers
+```
+
+If you're an AI agent, start with [AGENTS.md](AGENTS.md).
+
+## Contributing
+
+Issues and PRs are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the test workflow and the safety rules: read-only projects, verified symbol commits and the emulator allow-list. Report security issues as described in [SECURITY.md](SECURITY.md).
+
+## License
+
+[Apache 2.0](LICENSE) © 2026 yuatemycat and contributors.

superghidra-0.2.0/apk_jni_cross_referencer.py

@@ -0,0 +1,15 @@
+"""Backward-compatibility shim for `apk_jni_cross_referencer`.
+
+Canonical location: `superghidra.integrations.apk_jni_cross_referencer`.
+"""
+from __future__ import annotations
+
+import sys as _sys
+from superghidra.integrations import apk_jni_cross_referencer as _mod
+from superghidra.integrations.apk_jni_cross_referencer import *  # noqa: F401,F403
+
+if __name__ == "__main__":
+    import runpy as _runpy
+    _runpy.run_module("superghidra.integrations.apk_jni_cross_referencer", run_name="__main__", alter_sys=True)
+else:
+    _sys.modules[__name__] = _mod

superghidra-0.2.0/arm_thumb_decode.py

@@ -0,0 +1,15 @@
+"""Backward-compatibility shim for `arm_thumb_decode`.
+
+Canonical location: `superghidra.lifters.arm_thumb_decode`.
+"""
+from __future__ import annotations
+
+import sys as _sys
+from superghidra.lifters import arm_thumb_decode as _mod
+from superghidra.lifters.arm_thumb_decode import *  # noqa: F401,F403
+
+if __name__ == "__main__":
+    import runpy as _runpy
+    _runpy.run_module("superghidra.lifters.arm_thumb_decode", run_name="__main__", alter_sys=True)
+else:
+    _sys.modules[__name__] = _mod

superghidra-0.2.0/binary_diff_engine.py

@@ -0,0 +1,15 @@
+"""Backward-compatibility shim for `binary_diff_engine`.
+
+Canonical location: `superghidra.diff.binary_diff_engine`.
+"""
+from __future__ import annotations
+
+import sys as _sys
+from superghidra.diff import binary_diff_engine as _mod
+from superghidra.diff.binary_diff_engine import *  # noqa: F401,F403
+
+if __name__ == "__main__":
+    import runpy as _runpy
+    _runpy.run_module("superghidra.diff.binary_diff_engine", run_name="__main__", alter_sys=True)
+else:
+    _sys.modules[__name__] = _mod

superghidra-0.2.0/binary_loader.py

@@ -0,0 +1,15 @@
+"""Backward-compatibility shim for `binary_loader`.
+
+Canonical location: `superghidra.formats.binary_loader`.
+"""
+from __future__ import annotations
+
+import sys as _sys
+from superghidra.formats import binary_loader as _mod
+from superghidra.formats.binary_loader import *  # noqa: F401,F403
+
+if __name__ == "__main__":
+    import runpy as _runpy
+    _runpy.run_module("superghidra.formats.binary_loader", run_name="__main__", alter_sys=True)
+else:
+    _sys.modules[__name__] = _mod

superghidra-0.2.0/colab_cloud_orchestrator.py

@@ -0,0 +1,15 @@
+"""Backward-compatibility shim for `colab_cloud_orchestrator`.
+
+Canonical location: `superghidra.integrations.colab_cloud_orchestrator`.
+"""
+from __future__ import annotations
+
+import sys as _sys
+from superghidra.integrations import colab_cloud_orchestrator as _mod
+from superghidra.integrations.colab_cloud_orchestrator import *  # noqa: F401,F403
+
+if __name__ == "__main__":
+    import runpy as _runpy
+    _runpy.run_module("superghidra.integrations.colab_cloud_orchestrator", run_name="__main__", alter_sys=True)
+else:
+    _sys.modules[__name__] = _mod

superghidra-0.2.0/cross_platform_headless_harness.py

@@ -0,0 +1,15 @@
+"""Backward-compatibility shim for `cross_platform_headless_harness`.
+
+Canonical location: `superghidra.core.cross_platform_headless_harness`.
+"""
+from __future__ import annotations
+
+import sys as _sys
+from superghidra.core import cross_platform_headless_harness as _mod
+from superghidra.core.cross_platform_headless_harness import *  # noqa: F401,F403
+
+if __name__ == "__main__":
+    import runpy as _runpy
+    _runpy.run_module("superghidra.core.cross_platform_headless_harness", run_name="__main__", alter_sys=True)
+else:
+    _sys.modules[__name__] = _mod