setup.md

February 17, 2023 · View on GitHub

Setup

Install Python's build dependencies using pip3:

$ pip3 install -r requirements.txt

It is recommended to do so in a separate venv environment. One time initialization:

$ python3 -m venv venv

Then activate the environment by sourcing its bin/activate file:

$ source venv/bin/activate

Install Binary Ninja Python API:

$ python3 ${HOME}/binaryninja/scripts/install_api.py

Download plugin's third party repositories:

$ git submodule update --init

Build the plugin using cmake:

$ mkdir build
$ cd build
$ cmake ..
$ make -j

The build process accepts the following variables, set using cmake -D command line argument:

BN_INSTALL_DIR: Binary Ninja installation directory. This parameter is required in order to find BN's core library. If not specified, cmakes tries to find BN at its default install location.
USE_DOCKER_BUILD: Tells build system to cross-compile Hexagon targets in a custom Docker image. Image is downloaded from QEMU's registry.

To build using clang override CC environment variable and include clang_overrides.cmake as follows:

$ CC="$(which clang)" CXX="$(which clang++)" cmake .. \
  -DCMAKE_USER_MAKE_RULES_OVERRIDE="${PWD}/../cmake/clang_overrides.cmake"

make check runs all unit tests. Note, a BN professional license is required in order to run the headless e2e tests.

Add a symlink to the plugin binary:

$ ln -s ${PWD}/plugin/libarch_hexagon.so ${HOME}/.binaryninja/plugins/libarch_hexagon.so