2022-06-03 17:46:51 +00:00
|
|
|
|
# rabbitizer
|
2022-06-23 04:29:41 +00:00
|
|
|
|
|
|
|
|
|
|
[](https://pypi.org/project/rabbitizer/)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2022-12-18 21:37:07 +00:00
|
|
|
|
|
2022-06-23 04:29:41 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
A MIPS instruction decoder API.
|
|
|
|
|
|
|
|
|
|
|
|
Currently supports all the CPU instructions for MIPS I, II, III and IV.
|
|
|
|
|
|
|
|
|
|
|
|
## Installing
|
|
|
|
|
|
|
2022-12-18 21:37:07 +00:00
|
|
|
|
### Python bindings
|
|
|
|
|
|
|
2022-06-23 04:29:41 +00:00
|
|
|
|
The recommended way to install is using from the PyPi release, via `pip`:
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
pip install rabbitizer
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
In case you want to mess with the latest development version without wanting to clone the repository, then you could use the following command:
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
pip install git+https://github.com/Decompollaborate/rabbitizer.git@develop
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
NOTE: Installing the development version is not recommended. Proceed at your own risk.
|
|
|
|
|
|
|
2022-12-18 21:37:07 +00:00
|
|
|
|
See this package at <https://pypi.org/project/rabbitizer/>.
|
|
|
|
|
|
|
|
|
|
|
|
### Rust bindings
|
|
|
|
|
|
|
|
|
|
|
|
Add this crate to your `Cargo.toml` via:
|
|
|
|
|
|
|
|
|
|
|
|
```toml
|
|
|
|
|
|
[build]
|
2022-12-19 00:09:14 +00:00
|
|
|
|
rabbitizer = "1.5.5"
|
2022-12-18 21:37:07 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
See this crate at <https://crates.io/crates/rabbitizer>.
|
|
|
|
|
|
|
2022-06-23 04:29:41 +00:00
|
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
|
|
- Should produces matching assembly.
|
|
|
|
|
|
- Fully written in C for fast decoding.
|
|
|
|
|
|
- Python bindings.
|
|
|
|
|
|
- The minimal Python version is 3.7, older versions are not guaranteed to work.
|
2022-12-18 18:15:39 +00:00
|
|
|
|
- C++ bindings
|
|
|
|
|
|
- Rust bindings
|
2022-06-23 04:29:41 +00:00
|
|
|
|
- Includes some minor tools to build your own pointer/symbol detection.
|
|
|
|
|
|
- Configurable, many features can be turned on and off.
|
|
|
|
|
|
- MIPS instructions features:
|
|
|
|
|
|
- Named registers for MIPS VR4300's coprocessors.
|
|
|
|
|
|
- Support for many pseudoinstructions.
|
|
|
|
|
|
- Properly handle move to/from coprocessor instructions.
|
|
|
|
|
|
- Support for numeric, o32, n32 and n64 ABI register names.
|
|
|
|
|
|
- Some workarounds for some specific compilers/assemblers:
|
|
|
|
|
|
- `SN64`:
|
|
|
|
|
|
- `div`/`divu` fix: tweaks a bit the produced `div`, `divu` and `break` instructions.
|
2022-08-22 20:27:51 +00:00
|
|
|
|
- N64 RSP instruction decoding support.
|
|
|
|
|
|
- RSP decoding has been tested to build back to matching assemblies with [armips](https://github.com/Kingcom/armips/).
|
2022-08-27 16:22:48 +00:00
|
|
|
|
- R5900 (PS2's Emotion Engine processor) decoding support.
|
|
|
|
|
|
|
|
|
|
|
|
## References
|
|
|
|
|
|
|
2022-12-14 18:27:16 +00:00
|
|
|
|
- MIPS CPU:
|
|
|
|
|
|
- MIPS IV Instruction Set (Revision 3.2): <https://www.cs.cmu.edu/afs/cs/academic/class/15740-f97/public/doc/mips-isa.pdf>
|
|
|
|
|
|
- MIPS Calling Convention Summary: <https://courses.cs.washington.edu/courses/cse410/09sp/examples/MIPSCallingConventionsSummary.pdf>
|
|
|
|
|
|
- mipt-mips pseudo instructions: <https://github.com/MIPT-ILab/mipt-mips/wiki/MIPS-pseudo-instructions>
|
|
|
|
|
|
|
|
|
|
|
|
- N64's RSP (Reality Signal Processor):
|
|
|
|
|
|
- Nintendo Ultra64 RSP Programmer’s Guide: <https://ultra64.ca/files/documentation/silicon-graphics/SGI_Nintendo_64_RSP_Programmers_Guide.pdf>
|
|
|
|
|
|
- N64brew Reality Signal Processor/CPU Core: <https://n64brew.dev/wiki/Reality_Signal_Processor/CPU_Core>
|
|
|
|
|
|
|
2022-08-27 16:22:48 +00:00
|
|
|
|
- R5900:
|
|
|
|
|
|
- EmotionEngine instruction decoding: <https://psi-rockin.github.io/ps2tek/#eeinstructiondecoding>
|
|
|
|
|
|
- Official documentation from Toshiba: <https://wiki.qemu.org/images/2/2a/C790.pdf>
|
|
|
|
|
|
- VU instruction manual: <http://lukasz.dk/files/vu-instruction-manual.pdf>
|
|
|
|
|
|
- GNU binutils: <https://github.com/bminor/binutils-gdb/blob/master/opcodes/mips-opc.c>
|
