How to install LibCSP 

CSP supports three build systems:

Using Meson 

In order to compile CSP with meson, you run the following commands:

meson setup builddir
cd builddir
ninja

You can use meson configure to change the core options as well as compiler or project options.

In order to compile CSP with waf, you first need to configure the toolchain, what operating system to compile for, the location of required libraries and whether to enable certain optional features.

To configure CSP to build with the AVR32 toolchain for FreeRTOS and output the compiled libcsp.a and header files to the install directory, issue:

./waf configure --toolchain=avr32- --with-os=freertos --prefix=install

When compiling for FreeRTOS, the path to the FreeRTOS header files must be specified with --includes=PATH.

A number of optional features can be enabled by from the configure script. ./waf configure --help to list the available configure options.

The CAN driver (based on socketcan) can be enabled by appending the configure option --enable-can-socketcan.

To build and copy the library to the location specified with –prefix, use:

./waf build install

Using CMake 

Make sure Ninja is installed on your system first. You can now run the following commands to compile CSP with cmake:

cmake -G Ninja -B builddir
cmake --build builddir

Please note that other build system generators might work as well, but Ninja is the officially supported and tested build system when using CMake. To install the compiled libcsp.so and header files to the install directory, you run the following command:

cmake --install builddir

Please note that sudo might be required to install files into the default install directories. By default, it will be installed in /usr/local/lib and /usr/local/include, but if you wish to change it, you can specify -DCMAKE_INSTALL_PREFIX=<path> during the build process, and it will be installed in <path>/lib and <path>/include.

To install only the libcsp.so runtime library, use the following command:

cmake --install builddir --component runtime

Building All Samples with CMake 

if you want to build tools and samples, define CSP_BUILD_SAMPLES=ON when you run cmake.

cmake -B builddir -DCSP_BUILD_SAMPLES=ON

Python Bindings with CMake 

If you want to build Python bindings, define CSP_ENABLE_PYTHON3_BINDINGS=ON when you run cmake. You also need to enable the routing table (CSP_USE_RTABLE) when building the Python bindings.

cmake -B builddir -DCSP_ENABLE_PYTHON3_BINDINGS=ON -DCSP_USE_RTABLE=ON

To use the bindings, you need to install them to a location where Python searches by default or specify the path to Python:

PYTHONPATH=builddir python3 -c 'import libcsp_py3 as csp'

Reproducible Builds 

libcsp supports Reproducible Builds. To enable it, set CSP_REPRODUCIBLE_BUILDS to 1.

Please note that, when reproducible builds are enabled, CSP_CMP_IDENT does not return the compilation date and time.

When reproducible builds are enabled, both the BuildID and hash values of generated binaries remain consistent for each build. Our reproducible builds also support building in different directories. Thus, different users should generate precisely the same binaries, given the same source code and build environment.

You can learn more about reproducible builds at https://reproducible-builds.org/.

Use the following commands for each build system:

Waf 

./waf configure --enable-reproducible-builds

Meson 

meson setup builddir . -Denable_reproducible_builds=true

CMake 

cmake -G Ninja -B builddir -DCSP_REPRODUCIBLE_BUILDS=ON

Note: By default, CMake embeds the build directory in the binaries, resulting in non-deterministic builds. To address this, use CMAKE_BUILD_RPATH_USE_ORIGIN=ON or CMAKE_SKIP_RPATH=ON as follows:

cmake -G Ninja -B builddir -DCSP_REPRODUCIBLE_BUILDS=ON -DCMAKE_BUILD_RPATH_USE_ORIGIN=ON

See Reproducible Builds site or CMake document for more details.