Version 0222
- Philipp Dominik Schubert (philipp.schubert@upb.de) and others
- Please also refer to https://phasar.org/
PhASAR requires C++-17.
PhASAR is currently set up to support LLVM-14.0.
PhASAR is a LLVM-based static analysis framework written in C++. It allows users to specify arbitrary data-flow problems which are then solved in a fully-automated manner on the specified LLVM IR target code. Computing points-to information, call-graph(s), etc. is done by the framework, thus you can focus on what matters.
We have some documentation on PhASAR in our wiki. You probably would like to read this README first and then have a look on the material provided on https://phasar.org/ as well. Please also have a look on PhASAR's project directory and notice the project directory examples/ as well as the custom tool tools/myphasartool.cpp.
If you cannot work with one of the pre-built versions of PhASAR and would like to compile PhASAR yourself, then please check the wiki for installing the prerequisites and compilation. It is recommended to compile PhASAR yourself in order to get the full C++ experience and to have full control over the build mode.
You are using PhASAR and would like to help us in the future? Then please support us by filling out this web form.
By giving us feedback you help to decide in what direction PhASAR should stride in the future and give us clues about our user base. Thank you very much!
PhASAR can be installed using the installer scripts as explained in the following.
In the following, we would like to give an complete example of how to install PhASAR using an Ubuntu or Unix-like system.
Therefore, we provide an installation script. To install PhASAR, just navigate to the top-level directory of PhASAR and use the following command:
$ sudo ./bootstrap.sh
Done!
Due to unfortunate updates to MacOS and the handling of C++, especially on the newer M1 processors, we can't support native development on Mac.
The easiest solution to develop PhASAR on a Mac right now is to use dockers development environments. Clone this repository as described in their documentation. Afterwards, you have to login once manually, as a root user by running docker exec -it -u root <container name> /bin/bash to complete the rest of the install process as described in this readme (install submodules, run bootstrap.sh, ...).
Now you can just attach your docker container to VS Code or any other IDE, which supports remote development.
Set the system's variables for the C and C++ compiler to clang:
$ export CC=/usr/local/bin/clang
$ export CXX=/usr/local/bin/clang++
You may need to adjust the paths according to your system. When you cloned PhASAR from Github you need to initialize PhASAR's submodules before building it:
$ git submodule init
$ git submodule update
If you downloaded PhASAR as a compressed release (e.g. .zip or .tar.gz) you can use the init-submodules-release.sh script that manually clones the required submodules:
$ utils/init-submodules-release.sh
Navigate into the PhASAR directory. The following commands will do the job and compile the PhASAR framework:
$ mkdir build
$ cd build/
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make -j $(nproc) # or use a different number of cores to compile it
$ sudo make install # if you wish to install PhASAR system wide
When you have used the bootstrap.sh script to install PhASAR, the above steps are already done.
Use them as a reference if you wish to modify PhASAR and recompile it.
After compilation using cmake the following two binaries can be found in the build/ directory:
- phasar-llvm - the actual PhASAR command-line tool
- myphasartool - an example tool that shows how tools can be build on top of PhASAR
Use the command:
$ ./phasar-llvm --help
in order to display the manual and help message.
$ sudo make install
Please be careful and check if errors occur during the compilation.
When using CMake to compile PhASAR the following optional parameters can be used:
| Parameter : Type | Effect |
|---|---|
| BUILD_SHARED_LIBS : BOOL | Build shared libraries (default is ON) |
| CMAKE_BUILD_TYPE : STRING | Build PhASAR in 'Debug' or 'Release' mode (default is 'Debug') |
| CMAKE_INSTALL_PREFIX : PATH | Path where PhASAR will be installed if “make install” is invoked or the “install” target is built (default is /usr/local/phasar) |
| PHASAR_BUILD_DOC : BOOL | Build PhASAR documentation (default is OFF) |
| PHASAR_BUILD_UNITTESTS : BOOL | Build PhASAR unit tests (default is ON) |
| PHASAR_BUILD_IR : BOOL | Build PhASAR IR (required for running the unit tests) (default is ON) |
| PHASAR_BUILD_OPENSSL_TS_UNITTESTS : BOOL | Build PhASAR unit tests that require OpenSSL (default is OFF) |
| PHASAR_ENABLE_PAMM : STRING | Enable the performance measurement mechanism ('Off', 'Core' or 'Full', default is Off) |
| PHASAR_ENABLE_PIC : BOOL | Build Position-Independed Code (default is ON) |
| PHASAR_ENABLE_WARNINGS : BOOL | Enable compiler warnings (default is ON) |
You can use these parameters either directly or modify the installer-script bootstrap.sh
C++'s long compile times are always a pain. As shown in the above, when using cmake the compilation can easily be run in parallel, resulting in shorter compilation times. Make use of it!
To test if everything works as expected please run the following command:
$ phasar-llvm --module test/build_systems_tests/installation_tests/module.ll -D ifds-solvertest
If you obtain output other than a segmentation fault or an exception terminating the program abnormally everything works as expected.
Please consult our PhASAR wiki pages.
You are very much welcome to contribute to the PhASAR project. Please make sure that you install our pre-commit hook that ensures your commit adheres to the most important coding rules of the PhASAR project. For more details please consult Coding Conventions and Contributing to PhASAR.
To install the pre-commit hook, please run the following commands in PhASAR's root directory:
$ pip install pre-commit
$ pre-commit install
Thanks. And have fun with the project.