Flexus Instructions

How to Build Environment

• Install a compatible version of gcc:

$ export GCC_VERSION="8"
$ sudo apt-get update
$ sudo apt-get -y install gcc-${GCC_VERSION} g++-${GCC_VERSION}

• Set the recently installed version of gcc as default:

$ sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-${GCC_VERSION} 20
$ sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-${GCC_VERSION} 20
$ sudo update-alternatives --config gcc
$ sudo update-alternatives --config g++

• Install a compatible version of boost library:

Using the package manager (1.65 on Ubuntu 18.04)

$ sudo apt-get -y install libboost-all-dev

or build from scratch

$ export BOOST="boost_1_70_0"
$ export BOOST_VERSION="1.70.0"
$ wget https://dl.bintray.com/boostorg/release/${BOOST_VERSION}/source/${BOOST}.tar.gz -O /tmp/${BOOST}.tar.gz
$ tar -xf /tmp/${BOOST}.tar.gz
$ cd ./${BOOST}/
$ ./bootstrap.sh --prefix=/usr/local
$ ./b2 -j8
$ sudo ./b2 install

How to Use CMake to Compile Flexus

• The default settings are:

-DTARGET_PLATFORM=arm
-DSELECTED_DEBUG=vverb
-DSIMULATOR=KnottyKraken
-DCMAKE_C_COMPILER=/usr/bin/gcc
-DCMAKE_CXX_COMPILER=/usr/bin/g++
-DBOOST_INCLUDEDIR=/usr/local/include
-DBOOST_LIBRARYDIR=/usr/local/lib

• Add options by -D${OPTION_NAME}=${OPTION} after cmake.

$ cmake -DSIMULATOR=KnottyKraken . && make -j

• Use make clean to only remove *.a and *.so files.
• Use make clean_cmake to remove all of the files and folders that cmake produces.
• If you are using non-default install paths for boost and/or gcc, modify the location of dynamic libraries before executing make

$ LD_LIBRARY_PATH=<path to dynamic libraries> make -j

How to Use CMake to Compile Flexus Testing Harness

• Set the SIMULATOR variable to Harness while running cmake:

$ cmake -DSIMULATOR=Harness . && make -j

• The default value of other variables are:

-DTARGET_PLATFORM=arm
-DSELECTED_DEBUG=vverb
-DCMAKE_C_COMPILER=/usr/bin/gcc
-DCMAKE_CXX_COMPILER=/usr/bin/g++
-DBOOST_INCLUDEDIR=/usr/local/include
-DBOOST_LIBRARYDIR=/usr/local/lib

• Use make clean to only remove *.a and *.so files.
• Use make clean_cmake to remove all of the files and folders that cmake produces.
• Run the tests by executing testing_harness:

$ ./testing_harness

• If you are using non-default install paths for boost and/or gcc, modify the location of dynamic libraries before executing make and testing_harness

$ LD_LIBRARY_PATH=<path to dynamic libraries> make -j
$ LD_LIBRARY_PATH=<path to dynamic libraries> ./testing_harness

Flexus Code Formatting

The preferred version of Ubuntu is 18.04. When you contribute to this project, please clang-format the code at first. Please follow these instructions:

$ sudo apt-get install clang-format-6.0

Use the .clang-format file from repository and locate it in the folder where you want to format the code.

Within the folder, use this command to format .cpp/.hpp/.c/.h files:

$ find . -type f -and \( -name "*.hpp" -or -name "*.cpp" -or -name "*.h" -or -name "*.c" \) | xargs clang-format -i -style=file

Use the clang_format_test.sh file to check whether the formatting is successful or not. If it is successful, there will be green works showing All source code in commit are properly formatted. Otherwise, there will be red warning showing Found formatting errors! and which file where the problem is in.