Map2Check is a bug hunting tool that automatically generates and checks safety properties in C programs. It tracks memory pointers and variable assignments to check user-specified assertions, overflow, and pointer safety. The generation of the test cases is based on assertions (safety properties) from the code instructions, adopting the LLVM framework version 16, LibFuzzer, KLEE to generate input values to the test cases generated by Map2Check.

Extra documentation is available at https://map2check.github.io

To use the Map2Check tool is necessary a Linux 64-bit OS system (Ubuntu 22.04 recommended). In the linux OS, you should install the requirements, typing the commands:

$ sudo apt install python3 libc6-dev

Our binary tool is avaliable at https://github.com/hbgit/Map2Check/releases

In order to install Map2Check on your PC, you should download and save the map2check zip file on your disk from https://github.com/hbgit/Map2Check/releases. After that, you should type the following command:

$ unzip map2check-rc-v7.3-svcomp20.zip
$ cd map2check-rc-v7.3-svcomp20

Map2Check can be invoked through a standard command-line interface. Map2Check should be called in the installation directory as follows:

$ ./map2check --memtrack svcomp_960521-1_false-valid-free.c

In this case, --memtrack is the option to check for memory errors. For help and others tool options:

$ ./map2check --help

When you use a LLVM bytecode as input for the tool, be sure to add -g flag when generating the file, it is not required, but map2check will provide better info (like line numbers).

You can build Map2Check using our development Docker image (Dockerfile.dev), which provides Ubuntu 22.04 with LLVM 16 and KLEE 3.1 pre-installed:

$ git clone https://github.com/hbgit/Map2Check.git
$ cd Map2Check
$ git submodule update --init --recursive
# Build the development Docker image
$ docker build -t map2check-dev -f Dockerfile.dev .
$ docker run -it --rm -v $(pwd):/workspace map2check-dev /bin/bash

Inside the container (or on a host with LLVM 16 installed):

$ mkdir build && cd build
$ cmake .. -G Ninja \
    -DLLVM_DIR=/usr/lib/llvm-16/lib/cmake/llvm \
    -DSKIP_LIB_FUZZER=ON -DSKIP_KLEE=ON
$ ninja && ninja install

Requires: CMake ≥ 3.20, C++17, LLVM 16, Boost.

More details at https://map2check.github.io/docker.html

Unit tests (no KLEE/LibFuzzer required):

$ mkdir build && cd build
$ cmake .. -G Ninja \
    -DLLVM_DIR=/usr/lib/llvm-16/lib/cmake/llvm \
    -DSKIP_LIB_FUZZER=ON -DSKIP_KLEE=ON -DENABLE_TEST=ON
$ ninja && ctest --output-on-failure

Regression tests require the Benchexec docker image available in the submodule:

$ docker build -t hrocha/benchexecrun --no-cache -f utils/benchexecrun/Dockerfile utils/benchexecrun/
# Running the regression testing
$ ./make-regression-test.sh t

Use the map2check-wrapper.py script in the Map2Check binary directory to verify each single test-case.

Usage:

$ ./map2check-wrapper.py -p propertyFile.prp file.i

Map2Check accepts the property file and the verification task and provides as verification result: TRUE + Witness, [FALSE|FALSE(p)] + Witness, or UNKNOWN. FALSE(p), with p in {valid-free, valid-deref, valid-memtrack, valid-memcleanup}, means that the (partial) property p is violated. For each verification result the witness file (called witness.graphml) is generated Map2Check root-path folder. There is timeout of 897 seconds set by this script, using "timeout" tool that is part of coreutils on debian. If these constraints are violated, it should be treated as UNKNOWN result.

Maintainers:

• Herbert O. Rocha (since 2014), Federal University of Roraima, Brazil - https://hbgit.github.io/
• Rafael Menezes (since 2016), Federal University of Roraima, Brazil - https://rafaelsa94.github.io/
• Guilherme Bernardo (since 2025), Federal University of Roraima, Brazil - https://github.com/GuilhermeBn198

Questions and bug reports:
E-mail: map2check.tool@gmail.com

      .-.          
      /v\
     // \\    > L I N U X - GPL <
    /(   )\
     ^^-^^