Remill is a static binary translator that translates machine code instructions into LLVM bitcode. It translates x86 and amd64 machine code (including AVX and AVX512) into LLVM bitcode. AArch64 support is underway.
Remill focuses on accurately lifting instructions. It is meant to be used as a library for other tools, e.g. McSema.
- How to contribute
- How to implement the semantics of an instruction
- How instructions are lifted
- The design and architecture of Remill
If you are experiencing undocumented problems with Remill then ask for help in the
#binary-lifting channel of the Empire Hacking Slack.
Remill is supported on Linux platforms and has been tested on Ubuntu 14.04, 16.04, and 18.04. Remill also works on macOS, and has experimental support for Windows.
Most of Remill's dependencies can be provided by the cxx-common repository. Trail of Bits hosts downloadable, pre-built versions of cxx-common, which makes it substantially easier to get up and running with Remill. Nonetheless, the following table represents most of Remill's dependencies.
Getting and Building the Code
First, update aptitude and get install the baseline dependencies.
sudo apt-get update sudo apt-get upgrade sudo apt-get install \ git \ python2.7 \ wget \ curl \ build-essential \ libtinfo-dev \ lsb-release \ zlib1g-dev # Ubuntu 14.04, 16.04 sudo apt-get install realpath
Next, clone the repository. This will clone the code into the
git clone email@example.com:trailofbits/remill.git
Next, we build Remill. This script will create another directory,
in the current working directory. All remaining dependencies needed
by Remill will be built in the
Next, we can install Remill. Remill itself is a library, and so there is no real way to try it. However, you can head on over to the McSema repository, which uses Remill for lifting instructions.
cd ./remill-build sudo make install
We can also build and run Remill's test suite.
cd ./remill-build make test_dependencies make test