MIPS instruction decoder
Go to file
2022-12-15 16:06:48 -03:00
.github/workflows Try to make logic check tests 2022-12-15 16:06:48 -03:00
cplusplus readsR* functions 2022-12-14 18:03:13 -03:00
include Try to make logic check tests 2022-12-15 16:06:48 -03:00
rabbitizer readsR* functions 2022-12-14 18:03:13 -03:00
src Try to make logic check tests 2022-12-15 16:06:48 -03:00
tests Try to make logic check tests 2022-12-15 16:06:48 -03:00
.clang-format Format files with clang-format and add a format rule to makefile 2022-07-09 17:40:53 -04:00
.clang-tidy add more checks to clang tidy 2022-07-09 18:12:21 -04:00
.gitattributes
.gitignore Starting to workout the disassembly 2022-06-03 20:19:58 -04:00
LICENSE
Makefile move tests to tests folder 2022-10-12 11:26:28 -03:00
MANIFEST.in "Proper" InstrId enum 2022-06-09 14:30:39 -04:00
pyproject.toml Add build-backend to pyproject 2022-07-09 14:48:56 -04:00
README.md Update references 2022-12-14 15:27:16 -03:00
setup.cfg Fix RSP's jalr being marked as invalid 2022-11-30 13:14:21 -03:00
setup.py InstrCategory.fromStr 2022-10-14 18:49:59 -03:00

rabbitizer

PyPI - Downloads GitHub GitHub release (latest SemVer) PyPI GitHub contributors

A MIPS instruction decoder API.

Currently supports all the CPU instructions for MIPS I, II, III and IV.

Installing

The recommended way to install is using from the PyPi release, via pip:

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:

pip install git+https://github.com/Decompollaborate/rabbitizer.git@develop

NOTE: Installing the development version is not recommended. Proceed at your own risk.

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.
  • 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.
  • N64 RSP instruction decoding support.
    • RSP decoding has been tested to build back to matching assemblies with armips.
  • R5900 (PS2's Emotion Engine processor) decoding support.

References