MIPS instruction decoder
Go to file
2022-07-09 19:19:53 -04:00
.github/workflows ci builds again... 2022-07-09 18:15:17 -04:00
include Annotate functions with attributes 2022-07-09 19:19:53 -04:00
rabbitizer Annotate functions with attributes 2022-07-09 19:19:53 -04:00
src Annotate functions with attributes 2022-07-09 19:19:53 -04: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 First commit 2022-06-03 01:37:52 -04:00
.gitignore Starting to workout the disassembly 2022-06-03 20:19:58 -04:00
LICENSE First commit 2022-06-03 01:37:52 -04:00
Makefile tidy target on makefile 2022-07-09 17:55:57 -04: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 Some readme work 2022-06-23 00:29:41 -04:00
setup.cfg Add build-backend to pyproject 2022-07-09 14:48:56 -04:00
setup.py Expose Gpr registers enums to python 2022-07-05 09:49:12 -04:00
test.c Add a makefile for testing and fix one warning 2022-07-09 16:54:42 -04: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.
  • (Experimental) N64 RSP disassembly support.
    • NOTE: This mode has not been tested to even be assemblable.