Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 4.11 KB

BUILDING.md

File metadata and controls

83 lines (58 loc) · 4.11 KB
Raw

Building & installing with CMake

Build

This project requires a few dependencies:

  • GMP - libgmp for big-sized arithmetic
  • Z3 - for constraint solving
    • Can be disabled with CMake option -Dmaat_USE_Z3=OFF during configuration
  • LIEF - for automatic binary loading
    • Can be disabled with CMake option -Dmaat_USE_LIEF=OFF during configuration
  • sleigh - for Ghidra sleigh pcode handling
    • Vendored version can be built with CMake option -Dmaat_USE_EXTERNAL_SLEIGH=OFF during configuration after you pull the submodule (git submodule update --init --recursive)
  • Python3 development headers and library - for Python bindings
    • Bindings can be skipped with CMake option -Dmaat_BUILD_PYTHON_BINDINGS=OFF during configuration

You can use our Dockerfile as a reference for how to download and install dependencies. Note that if building the Dockerfile, it uses a submodule'd sleigh project, so you must either clone Maat with git clone --recursive ... or run git submodule update --init --recursive after cloning before building the Docker image.

Assuming the above are installed into a system location (where CMake will automatically find them), here are the steps for building in release mode with a single-configuration generator, like the Unix Makefiles one:

cmake -S . -B build -D CMAKE_BUILD_TYPE=Release
cmake --build build

Here are the steps for building in release mode with a multi-configuration generator, like the Visual Studio ones:

cmake -S . -B build
cmake --build build --config Release

If the dependencies are installed into a non-system/default directory, then you can pass hints to CMake on where to find the respective packages (something like -D<PackageName>_DIR or -D<PackageName>_ROOT depending on what/how the package was installed; see the package's documentation on how to correctly use it with CMake).

Install

This project doesn't require any special command-line flags to install to keep things simple. As a prerequisite, the project has to be built with the above commands already.

The below commands require at least CMake 3.15 to run, because that is the version in which Install a Project was added.

Here is the command for installing the release mode artifacts with a single-configuration generator, like the Unix Makefiles one:

cmake --install build

Here is the command for installing the release mode artifacts with a multi-configuration generator, like the Visual Studio ones:

cmake --install build --config Release

Python bindings

Python bindings should be built and installed by default. If not, make sure the project is configured with the option -Dmaat_BUILD_PYTHON_BINDINGS=ON.

CMake will install the Python module to the location specified by maat_INSTALL_PYTHONMODULEDIR; if it is an absolute path, it will be installed to that location, but if it is a relative path, then it will be located relative to the installation prefix.

If maat_INSTALL_PYTHONMODULEDIR isn't specified, CMake uses a default location that matches the most common use-case for regular users, in a way that is equivalent to:

# If you're configuring outside a virtualenv
prefix="$(python3 -m site --user-site)"
# If you're configuring inside a virtualenv
prefix="$(python3 -c 'import sysconfig as sc; print(sc.get_path("platlib"))')"

cmake -S . -B build "-Dmaat_INSTALL_PYTHONMODULEDIR=${prefix}" -Dmaat_BUILD_PYTHON_BINDINGS=ON
cmake --build build
cmake --install build

NOTE: CMake configuration and installation should both take place either inside or outside of the virtual environment or else the install path for the Python module could be incorrect (especially on macOS).

If you are packaging this project, you will likely want to change the default value of maat_INSTALL_PYTHONMODULEDIR.