deity-informant 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- deity_informant-0.1.0/LICENSE +201 -0
- deity_informant-0.1.0/PKG-INFO +103 -0
- deity_informant-0.1.0/README.md +66 -0
- deity_informant-0.1.0/deity_informant/__init__.py +52 -0
- deity_informant-0.1.0/deity_informant/cli.py +156 -0
- deity_informant-0.1.0/deity_informant/lifter.py +1221 -0
- deity_informant-0.1.0/deity_informant/vm.py +322 -0
- deity_informant-0.1.0/deity_informant.egg-info/PKG-INFO +103 -0
- deity_informant-0.1.0/deity_informant.egg-info/SOURCES.txt +18 -0
- deity_informant-0.1.0/deity_informant.egg-info/dependency_links.txt +1 -0
- deity_informant-0.1.0/deity_informant.egg-info/entry_points.txt +2 -0
- deity_informant-0.1.0/deity_informant.egg-info/requires.txt +17 -0
- deity_informant-0.1.0/deity_informant.egg-info/top_level.txt +1 -0
- deity_informant-0.1.0/pyproject.toml +80 -0
- deity_informant-0.1.0/setup.cfg +4 -0
- deity_informant-0.1.0/tests/test_cli.py +56 -0
- deity_informant-0.1.0/tests/test_coverage.py +108 -0
- deity_informant-0.1.0/tests/test_illegals.py +235 -0
- deity_informant-0.1.0/tests/test_lifter.py +96 -0
- deity_informant-0.1.0/tests/test_vm.py +156 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Josh Bailey
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: deity-informant
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: NMOS 6510 illegal-opcode toolkit: a standalone 6510 -> raw-P-Code lifter + pure-Python P-Code VM, and a 6510 Ghidra/pypcode SLEIGH processor module.
|
|
5
|
+
Author-email: Josh Bailey <josh@overlyspecific.com>
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/anarkiwi/deity-informant
|
|
8
|
+
Project-URL: Repository, https://github.com/anarkiwi/deity-informant
|
|
9
|
+
Keywords: 6502,6510,c64,ghidra,sleigh,pcode,illegal-opcodes,decompiler
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
15
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
16
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
17
|
+
Classifier: Topic :: Software Development :: Disassemblers
|
|
18
|
+
Classifier: Topic :: System :: Emulators
|
|
19
|
+
Requires-Python: >=3.10
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
License-File: LICENSE
|
|
22
|
+
Provides-Extra: oracle
|
|
23
|
+
Requires-Dist: py65; extra == "oracle"
|
|
24
|
+
Provides-Extra: ghidra
|
|
25
|
+
Requires-Dist: pypcode; extra == "ghidra"
|
|
26
|
+
Provides-Extra: dev
|
|
27
|
+
Requires-Dist: pytest; extra == "dev"
|
|
28
|
+
Requires-Dist: pytest-xdist; extra == "dev"
|
|
29
|
+
Requires-Dist: pytest-cov; extra == "dev"
|
|
30
|
+
Requires-Dist: build; extra == "dev"
|
|
31
|
+
Requires-Dist: black; extra == "dev"
|
|
32
|
+
Requires-Dist: pylint; extra == "dev"
|
|
33
|
+
Requires-Dist: py65; extra == "dev"
|
|
34
|
+
Requires-Dist: pypcode; extra == "dev"
|
|
35
|
+
Requires-Dist: numpy; extra == "dev"
|
|
36
|
+
Dynamic: license-file
|
|
37
|
+
|
|
38
|
+
# deity-informant
|
|
39
|
+
|
|
40
|
+
A 6510 illegal-opcode toolkit: a standalone 6510 -> raw-P-Code lifter + pure-Python P-Code VM, and a `6510` Ghidra/pypcode SLEIGH processor module. All 105 documented NMOS 6510 illegal opcodes are first-class. No runtime dependency on py65 or Ghidra.
|
|
41
|
+
|
|
42
|
+
## Why
|
|
43
|
+
|
|
44
|
+
Working on C64 code requires the NMOS 6510 illegal opcodes, and no existing backend handles them correctly:
|
|
45
|
+
|
|
46
|
+
- Real playroutines/demos use illegals as load-bearing instructions (A Mind Is Born runs `SRE`; Automatas runs `SBX`/`SAX`/`LAX`/`ANC`/`ALR`).
|
|
47
|
+
- Stock Ghidra's 6502 SLEIGH spec (and pypcode, which vendors it verbatim) defines zero illegals and has no catch-all — every illegal is a `BadDataError`, so it cannot even disassemble such code, let alone decompile it.
|
|
48
|
+
- Ghidra's decompiler only consumes P-Code from a *compiled* SLEIGH spec, so Python-generated P-Code cannot be injected — a SLEIGH language extension is the only way to make the decompiler illegal-aware.
|
|
49
|
+
- py65 is not a valid execution reference: it stubs the RMW illegals (`SLO/RLA/SRE/RRA/DCP/ISC`, `LAS/ANE/SH*`) as `inst_not_implemented` — a 2-byte, 0-cycle skip, silently wrong on real code.
|
|
50
|
+
- The known community 6510 Ghidra fork adds illegal *disassembly* only, with uncertain P-Code semantics — not trustworthy for decompilation or execution.
|
|
51
|
+
- deity-informant supplies both missing pieces: a compiled 6510 SLEIGH module (illegal-aware Ghidra/pypcode decompilation) and a hardware-validated lifter + VM (byte-exact vs sidplayfp) executing all 105 illegals.
|
|
52
|
+
|
|
53
|
+
## Two products
|
|
54
|
+
|
|
55
|
+
- **standalone lifter + VM** — `lift` (6510 -> raw P-Code), the `PcodeVM` interpreter, and the `run_sub`/`run_irq`/`run_irq_driven` drivers. Pure Python, no Ghidra, no py65.
|
|
56
|
+
- **`6510` SLEIGH module** (`ghidra/6510/`) — stock 6502 legal spec + generated `6510_illegal.sinc` that makes Ghidra's disassembler *and* decompiler, and pypcode, illegal-aware. Language id `6510:LE:16:default`.
|
|
57
|
+
|
|
58
|
+
## Install
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
pip install deity-informant # core, no deps
|
|
62
|
+
pip install deity-informant[oracle] # + py65 (legal-opcode differential oracle)
|
|
63
|
+
pip install deity-informant[ghidra] # + pypcode (SLEIGH build / lift backend)
|
|
64
|
+
pip install deity-informant[dev] # test + lint tooling
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## CLI
|
|
68
|
+
|
|
69
|
+
Console script `deity-informant`:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
deity-informant disasm IMAGE [--org ADDR] [--start ADDR] [--count N] # 6510 disassembly (illegal-aware)
|
|
73
|
+
deity-informant pcode IMAGE --at ADDR [--org ADDR] # raw P-Code for one instruction
|
|
74
|
+
deity-informant run IMAGE --init ADDR [--play ADDR --frames N] # execute in PcodeVM, dump $D400.. grid
|
|
75
|
+
deity-informant emit-sleigh [-o DIR] [--magic 0xEE] # build/install the 6510 SLEIGH module
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Python API
|
|
79
|
+
|
|
80
|
+
```python
|
|
81
|
+
from deity_informant import lift, PcodeVM, run_sub
|
|
82
|
+
insn = lift(mem, pc) # {"ops", "len", "cyc", "pen", "ctrl"}
|
|
83
|
+
vm = PcodeVM(mem); run_sub(vm, entry, {}, lift) # execute a subroutine to its RTS
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Use with Ghidra
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
python ghidra/6510/build.py --install "$GHIDRA_INSTALL_DIR/Ghidra/Processors/6510/data/languages"
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Compiles `6510.sla`, resolving the stock `6502.slaspec` + SLEIGH compiler from `$GHIDRA_INSTALL_DIR` (or a `pypcode` install). Restart Ghidra, import the C64 image as Raw Binary language `6510:LE:16:default` at base `$0000`; illegals now decode instead of BadData. Full steps: [docs/ghidra.md](docs/ghidra.md).
|
|
93
|
+
|
|
94
|
+
## Illegal opcodes
|
|
95
|
+
|
|
96
|
+
All 105 documented NMOS 6510 illegals lifted as genuine P-Code (not stubs), semantics/cycles per "No More Secrets — NMOS 6510 Unintended Opcodes" ([csdb.dk/release/?id=258111](https://csdb.dk/release/?id=258111)). Full table: [docs/illegal-opcodes.md](docs/illegal-opcodes.md).
|
|
97
|
+
|
|
98
|
+
## Docs
|
|
99
|
+
|
|
100
|
+
- [docs/design.md](docs/design.md) — architecture (lifter + VM, SLEIGH module, raw vs high P-Code, cycle layer).
|
|
101
|
+
- [docs/illegal-opcodes.md](docs/illegal-opcodes.md) — illegal-opcode reference.
|
|
102
|
+
- [docs/nms-provenance.md](docs/nms-provenance.md) — reference-source provenance.
|
|
103
|
+
- [docs/ghidra.md](docs/ghidra.md) — using the 6510 module with Ghidra / pypcode.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# deity-informant
|
|
2
|
+
|
|
3
|
+
A 6510 illegal-opcode toolkit: a standalone 6510 -> raw-P-Code lifter + pure-Python P-Code VM, and a `6510` Ghidra/pypcode SLEIGH processor module. All 105 documented NMOS 6510 illegal opcodes are first-class. No runtime dependency on py65 or Ghidra.
|
|
4
|
+
|
|
5
|
+
## Why
|
|
6
|
+
|
|
7
|
+
Working on C64 code requires the NMOS 6510 illegal opcodes, and no existing backend handles them correctly:
|
|
8
|
+
|
|
9
|
+
- Real playroutines/demos use illegals as load-bearing instructions (A Mind Is Born runs `SRE`; Automatas runs `SBX`/`SAX`/`LAX`/`ANC`/`ALR`).
|
|
10
|
+
- Stock Ghidra's 6502 SLEIGH spec (and pypcode, which vendors it verbatim) defines zero illegals and has no catch-all — every illegal is a `BadDataError`, so it cannot even disassemble such code, let alone decompile it.
|
|
11
|
+
- Ghidra's decompiler only consumes P-Code from a *compiled* SLEIGH spec, so Python-generated P-Code cannot be injected — a SLEIGH language extension is the only way to make the decompiler illegal-aware.
|
|
12
|
+
- py65 is not a valid execution reference: it stubs the RMW illegals (`SLO/RLA/SRE/RRA/DCP/ISC`, `LAS/ANE/SH*`) as `inst_not_implemented` — a 2-byte, 0-cycle skip, silently wrong on real code.
|
|
13
|
+
- The known community 6510 Ghidra fork adds illegal *disassembly* only, with uncertain P-Code semantics — not trustworthy for decompilation or execution.
|
|
14
|
+
- deity-informant supplies both missing pieces: a compiled 6510 SLEIGH module (illegal-aware Ghidra/pypcode decompilation) and a hardware-validated lifter + VM (byte-exact vs sidplayfp) executing all 105 illegals.
|
|
15
|
+
|
|
16
|
+
## Two products
|
|
17
|
+
|
|
18
|
+
- **standalone lifter + VM** — `lift` (6510 -> raw P-Code), the `PcodeVM` interpreter, and the `run_sub`/`run_irq`/`run_irq_driven` drivers. Pure Python, no Ghidra, no py65.
|
|
19
|
+
- **`6510` SLEIGH module** (`ghidra/6510/`) — stock 6502 legal spec + generated `6510_illegal.sinc` that makes Ghidra's disassembler *and* decompiler, and pypcode, illegal-aware. Language id `6510:LE:16:default`.
|
|
20
|
+
|
|
21
|
+
## Install
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
pip install deity-informant # core, no deps
|
|
25
|
+
pip install deity-informant[oracle] # + py65 (legal-opcode differential oracle)
|
|
26
|
+
pip install deity-informant[ghidra] # + pypcode (SLEIGH build / lift backend)
|
|
27
|
+
pip install deity-informant[dev] # test + lint tooling
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## CLI
|
|
31
|
+
|
|
32
|
+
Console script `deity-informant`:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
deity-informant disasm IMAGE [--org ADDR] [--start ADDR] [--count N] # 6510 disassembly (illegal-aware)
|
|
36
|
+
deity-informant pcode IMAGE --at ADDR [--org ADDR] # raw P-Code for one instruction
|
|
37
|
+
deity-informant run IMAGE --init ADDR [--play ADDR --frames N] # execute in PcodeVM, dump $D400.. grid
|
|
38
|
+
deity-informant emit-sleigh [-o DIR] [--magic 0xEE] # build/install the 6510 SLEIGH module
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Python API
|
|
42
|
+
|
|
43
|
+
```python
|
|
44
|
+
from deity_informant import lift, PcodeVM, run_sub
|
|
45
|
+
insn = lift(mem, pc) # {"ops", "len", "cyc", "pen", "ctrl"}
|
|
46
|
+
vm = PcodeVM(mem); run_sub(vm, entry, {}, lift) # execute a subroutine to its RTS
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Use with Ghidra
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
python ghidra/6510/build.py --install "$GHIDRA_INSTALL_DIR/Ghidra/Processors/6510/data/languages"
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Compiles `6510.sla`, resolving the stock `6502.slaspec` + SLEIGH compiler from `$GHIDRA_INSTALL_DIR` (or a `pypcode` install). Restart Ghidra, import the C64 image as Raw Binary language `6510:LE:16:default` at base `$0000`; illegals now decode instead of BadData. Full steps: [docs/ghidra.md](docs/ghidra.md).
|
|
56
|
+
|
|
57
|
+
## Illegal opcodes
|
|
58
|
+
|
|
59
|
+
All 105 documented NMOS 6510 illegals lifted as genuine P-Code (not stubs), semantics/cycles per "No More Secrets — NMOS 6510 Unintended Opcodes" ([csdb.dk/release/?id=258111](https://csdb.dk/release/?id=258111)). Full table: [docs/illegal-opcodes.md](docs/illegal-opcodes.md).
|
|
60
|
+
|
|
61
|
+
## Docs
|
|
62
|
+
|
|
63
|
+
- [docs/design.md](docs/design.md) — architecture (lifter + VM, SLEIGH module, raw vs high P-Code, cycle layer).
|
|
64
|
+
- [docs/illegal-opcodes.md](docs/illegal-opcodes.md) — illegal-opcode reference.
|
|
65
|
+
- [docs/nms-provenance.md](docs/nms-provenance.md) — reference-source provenance.
|
|
66
|
+
- [docs/ghidra.md](docs/ghidra.md) — using the 6510 module with Ghidra / pypcode.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"""deity_informant -- a 6510 -> raw-P-Code lifter and pure-Python P-Code interpreter.
|
|
2
|
+
|
|
3
|
+
Two products from one opcode table:
|
|
4
|
+
|
|
5
|
+
* **standalone** -- ``lift`` + ``PcodeVM`` run 6510 code (including every
|
|
6
|
+
documented NMOS illegal) as raw P-Code, with no Ghidra and no py65.
|
|
7
|
+
* **Ghidra / pypcode backend** -- the ``6510`` SLEIGH module under ``ghidra/6510``
|
|
8
|
+
(stock 6502 legal set + a generated illegal ``.sinc``) so Ghidra's disassembler
|
|
9
|
+
*and* decompiler, and pypcode, become illegal-aware.
|
|
10
|
+
|
|
11
|
+
Illegal-opcode semantics and cycles follow "No More Secrets - NMOS 6510
|
|
12
|
+
Unintended Opcodes" (v0.91); see ``docs/illegal-opcodes.md``.
|
|
13
|
+
"""
|
|
14
|
+
|
|
15
|
+
from __future__ import annotations
|
|
16
|
+
|
|
17
|
+
from .lifter import (
|
|
18
|
+
OPS,
|
|
19
|
+
MODE_LEN,
|
|
20
|
+
MEM_MODES,
|
|
21
|
+
ILLEGAL_OPCODES,
|
|
22
|
+
MAGIC,
|
|
23
|
+
lift,
|
|
24
|
+
load_cycle_tables,
|
|
25
|
+
CYCLETIME,
|
|
26
|
+
EXTRACYCLES,
|
|
27
|
+
)
|
|
28
|
+
from .vm import (
|
|
29
|
+
PcodeVM,
|
|
30
|
+
run_sub,
|
|
31
|
+
run_irq,
|
|
32
|
+
run_irq_driven,
|
|
33
|
+
)
|
|
34
|
+
|
|
35
|
+
__version__ = "0.1.0"
|
|
36
|
+
|
|
37
|
+
__all__ = [
|
|
38
|
+
"OPS",
|
|
39
|
+
"MODE_LEN",
|
|
40
|
+
"MEM_MODES",
|
|
41
|
+
"ILLEGAL_OPCODES",
|
|
42
|
+
"MAGIC",
|
|
43
|
+
"lift",
|
|
44
|
+
"load_cycle_tables",
|
|
45
|
+
"CYCLETIME",
|
|
46
|
+
"EXTRACYCLES",
|
|
47
|
+
"PcodeVM",
|
|
48
|
+
"run_sub",
|
|
49
|
+
"run_irq",
|
|
50
|
+
"run_irq_driven",
|
|
51
|
+
"__version__",
|
|
52
|
+
]
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
"""Command-line interface for deity-informant.
|
|
2
|
+
|
|
3
|
+
Subcommands:
|
|
4
|
+
disasm linear-lift a code region and print mnemonics (illegals included)
|
|
5
|
+
pcode dump the raw P-Code op list for one instruction
|
|
6
|
+
run drive a playroutine through PcodeVM and print the $D400.. grid
|
|
7
|
+
emit-sleigh build the 6510 Ghidra/pypcode SLEIGH module (delegates to build.py)
|
|
8
|
+
"""
|
|
9
|
+
|
|
10
|
+
from __future__ import annotations
|
|
11
|
+
|
|
12
|
+
import argparse
|
|
13
|
+
import subprocess
|
|
14
|
+
import sys
|
|
15
|
+
from pathlib import Path
|
|
16
|
+
|
|
17
|
+
from .lifter import OPS, MODE_LEN, ILLEGAL_OPCODES, lift
|
|
18
|
+
from .vm import PcodeVM, run_sub
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
# operand rendering per addressing mode (mnemonic already comes from OPS)
|
|
22
|
+
def _operand(mode, mem, pc):
|
|
23
|
+
lo = mem[(pc + 1) & 0xFFFF]
|
|
24
|
+
hi = mem[(pc + 2) & 0xFFFF]
|
|
25
|
+
word = lo | (hi << 8)
|
|
26
|
+
return {
|
|
27
|
+
"impl": "",
|
|
28
|
+
"acc": "A",
|
|
29
|
+
"imm": "#$%02X" % lo,
|
|
30
|
+
"zp": "$%02X" % lo,
|
|
31
|
+
"zpx": "$%02X,X" % lo,
|
|
32
|
+
"zpy": "$%02X,Y" % lo,
|
|
33
|
+
"abs": "$%04X" % word,
|
|
34
|
+
"absx": "$%04X,X" % word,
|
|
35
|
+
"absy": "$%04X,Y" % word,
|
|
36
|
+
"indx": "($%02X,X)" % lo,
|
|
37
|
+
"indy": "($%02X),Y" % lo,
|
|
38
|
+
"ind": "($%04X)" % word,
|
|
39
|
+
"rel": "$%04X" % ((pc + 2 + (lo - 256 if lo & 0x80 else lo)) & 0xFFFF),
|
|
40
|
+
}[mode]
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
def format_insn(mem, pc):
|
|
44
|
+
"""Return ``(length, text)`` for the instruction at ``pc``."""
|
|
45
|
+
op = mem[pc]
|
|
46
|
+
mn, mode = OPS[op]
|
|
47
|
+
text = "%-4s %s" % (mn, _operand(mode, mem, pc))
|
|
48
|
+
tag = " ; illegal" if op in ILLEGAL_OPCODES else ""
|
|
49
|
+
return MODE_LEN[mode], "$%04X: %02X %s%s" % (pc, op, text.rstrip(), tag)
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
def _load(path, org):
|
|
53
|
+
data = Path(path).read_bytes()
|
|
54
|
+
mem = bytearray(0x10000)
|
|
55
|
+
mem[org : org + len(data)] = data[: 0x10000 - org]
|
|
56
|
+
return mem, len(data)
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
def cmd_disasm(args):
|
|
60
|
+
mem, n = _load(args.file, args.org)
|
|
61
|
+
pc = args.start if args.start is not None else args.org
|
|
62
|
+
end = pc + args.count if args.count else args.org + n
|
|
63
|
+
while pc < end:
|
|
64
|
+
length, text = format_insn(mem, pc)
|
|
65
|
+
print(text)
|
|
66
|
+
pc += length
|
|
67
|
+
return 0
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
def cmd_pcode(args):
|
|
71
|
+
mem, _ = _load(args.file, args.org)
|
|
72
|
+
rec = lift(mem, args.at)
|
|
73
|
+
_, text = format_insn(mem, args.at)
|
|
74
|
+
print(text)
|
|
75
|
+
for mn, out, ins in rec["ops"]:
|
|
76
|
+
o = "" if out is None else "%s = " % (out,)
|
|
77
|
+
print(" %s%s %s" % (o, mn, ins))
|
|
78
|
+
print(" len=%d cyc=%d pen=%s ctrl=%s" % (rec["len"], rec["cyc"], rec["pen"], rec["ctrl"]))
|
|
79
|
+
return 0
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
def cmd_run(args):
|
|
83
|
+
mem, _ = _load(args.file, args.org)
|
|
84
|
+
vm = PcodeVM(mem)
|
|
85
|
+
vm.mem[0xD418] = 0x0F
|
|
86
|
+
cache = {}
|
|
87
|
+
run_sub(vm, args.init, cache, lift)
|
|
88
|
+
if args.play is None:
|
|
89
|
+
print("init done; $D400.. = " + " ".join("%02X" % vm.mem[0xD400 + i] for i in range(25)))
|
|
90
|
+
return 0
|
|
91
|
+
for f in range(args.frames):
|
|
92
|
+
run_sub(vm, args.play, cache, lift)
|
|
93
|
+
row = " ".join("%02X" % vm.mem[0xD400 + i] for i in range(25))
|
|
94
|
+
print("frame %4d: %s" % (f, row))
|
|
95
|
+
return 0
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
def cmd_emit_sleigh(args):
|
|
99
|
+
build = Path(__file__).resolve().parent.parent / "ghidra" / "6510" / "build.py"
|
|
100
|
+
if not build.is_file():
|
|
101
|
+
sys.stderr.write("ghidra/6510/build.py not found (run from a source checkout)\n")
|
|
102
|
+
return 1
|
|
103
|
+
cmd = [sys.executable, str(build)]
|
|
104
|
+
if args.out:
|
|
105
|
+
cmd += ["--install", args.out]
|
|
106
|
+
if args.magic:
|
|
107
|
+
cmd += ["--magic", args.magic]
|
|
108
|
+
return subprocess.call(cmd)
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
def main(argv=None):
|
|
112
|
+
ap = argparse.ArgumentParser(
|
|
113
|
+
prog="deity-informant",
|
|
114
|
+
description=__doc__,
|
|
115
|
+
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
116
|
+
)
|
|
117
|
+
sub = ap.add_subparsers(dest="cmd", required=True)
|
|
118
|
+
|
|
119
|
+
def org(p):
|
|
120
|
+
p.add_argument("file")
|
|
121
|
+
p.add_argument(
|
|
122
|
+
"--org",
|
|
123
|
+
type=lambda x: int(x, 0),
|
|
124
|
+
default=0x1000,
|
|
125
|
+
help="load address of FILE (default 0x1000)",
|
|
126
|
+
)
|
|
127
|
+
|
|
128
|
+
p = sub.add_parser("disasm", help="linear-lift a region and print mnemonics")
|
|
129
|
+
org(p)
|
|
130
|
+
p.add_argument("--start", type=lambda x: int(x, 0), default=None)
|
|
131
|
+
p.add_argument("--count", type=int, default=0, help="bytes to disassemble (default whole file)")
|
|
132
|
+
p.set_defaults(fn=cmd_disasm)
|
|
133
|
+
|
|
134
|
+
p = sub.add_parser("pcode", help="dump raw P-Code for one instruction")
|
|
135
|
+
org(p)
|
|
136
|
+
p.add_argument("--at", type=lambda x: int(x, 0), required=True)
|
|
137
|
+
p.set_defaults(fn=cmd_pcode)
|
|
138
|
+
|
|
139
|
+
p = sub.add_parser("run", help="drive a playroutine through PcodeVM")
|
|
140
|
+
org(p)
|
|
141
|
+
p.add_argument("--init", type=lambda x: int(x, 0), required=True)
|
|
142
|
+
p.add_argument("--play", type=lambda x: int(x, 0), default=None)
|
|
143
|
+
p.add_argument("--frames", type=int, default=1)
|
|
144
|
+
p.set_defaults(fn=cmd_run)
|
|
145
|
+
|
|
146
|
+
p = sub.add_parser("emit-sleigh", help="build the 6510 SLEIGH module")
|
|
147
|
+
p.add_argument("-o", "--out", help="languages dir to install the built module into")
|
|
148
|
+
p.add_argument("--magic", help="override the ANE/LXA magic constant, e.g. 0x00")
|
|
149
|
+
p.set_defaults(fn=cmd_emit_sleigh)
|
|
150
|
+
|
|
151
|
+
args = ap.parse_args(argv)
|
|
152
|
+
return args.fn(args)
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
if __name__ == "__main__":
|
|
156
|
+
raise SystemExit(main())
|