README.md

C-instrumentator

A C instrumentation library

Loop Unroller

Applies a unrolling of loops of static bounds in-source. Currently it only supports: for-loops, </<=/>/>= operators, ++/-- increments.

int main() { int a; for (int i = 3; i > 1; i--) a++; return 0; }

is transformed into

int main() {
  int a;
  int i = 3;
  {
    a++;

    i--;
  }
  {
    a++;

    i--;
  }

  return 0;
}

To run, just invoke ./loop-unroller input.c output.c. This requires clang-format to be on path and it needs to be >= 15.

Goal Injector

The objective of this instrumentation is to extend and reimplement some ideas from FuSeBMC in a way that is easier to integrate with ESBMC tools.

Example

int main() {
  while(1)
    while(1) ;
  return 0;
})";

is transformed into

int main() {__ESBMC_assert(0, "0");
  while(1)
    {__ESBMC_assert(0, "1");while(1) {__ESBMC_assert(0, "2");;}}
  return 0;
})";

Building

Ubuntu

• Install dependencies: sudo apt-get install clang llvm clang-tidy git linux-libc-dev libclang-dev libclang-cpp-dev cmake build-essential
• Configure: mkdir build && cd build && cmake .. -DBUILD_TESTING=1 -DClang_DIR=/usr/lib/cmake/clang-14 -DLLVM_DIR=/usr/lib/llvm-14/lib/cmake/llvm
• Build: make -j4

macOS

• Install dependencies: brew install llvm@16
• Configure: mkdir build && cd build && cmake .. -DBUILD_TESTING=1 -DLLVM_DIR=/opt/homebrew/opt/llvm@14 -DClang_DIR=/opt/homebrew/opt/llvm@14
• Build: make -j4

Project Structure

The project is structured as follows:

• .github: Actions scripts
• include: Header files
• src: Library files
• unit: Unit tests

Dependencies

I want to keep the dependencies at a minimum. So far, the required dependencies are:

• LLVM/Clang >= 14
• fmt
• clang-format

Please, avoid adding dependencies. The idea is for this to be used as a library.