SpyC is an application which main purpose is to help developer analyze complex C codebase. Its very first version allows to scan C code looking for function definitions and calls and output results as a digraph in dot format.

In order to build SpyC, you need to install first:

• cmake 3.10
• C++ compiler: GCC8 or Clang9
• LLVM and clang development libraries (version 9.0) with dependencies
• Googletest if running unittests For a complete reference see Dockerfile.

To build project clone repo and simply run:

cmake -B build .
cmake --build build

It will create spyc binary in the build/src subdirectory.

Apart of standard cmake variables, following variables changes cmake default behavior:

• Clang_HINT - specify Clangs sysroot,
• GTest_HINT - specify GTest sysroot,
• SPYC_TESTS=ON - turn on building unittests.

SpyC uses same invocation like other LLVM tools. Basic usage:

spyc <soucefile> -- 

It is possible to process multiple source files at once:

spyc <soucefile1> <sourcefile2> ... <sourcefileN> -- 

To add compiler flags specify them after -- or use a compilation database file:

spyc <sourcefile> -- -I /usr/local/include
spyc <sourcefile> compilation_database.json

It is possible to generate diagram with either all calls found during code parsing (default) or a graph generated starting from specified method using --diagram-type=graph option. Default starting point is main, which can be changed with --graph-start option.

Generate and display callgraph in PNG format (graphviz is required):

./build/spyc test/basic.c -- | dot -Tpng > basic.png && eog basic.png