Skip to content

linux.rst

Latest commit

 

History

History
381 lines (259 loc) · 12.3 KB

linux.rst

File metadata and controls

381 lines (259 loc) · 12.3 KB
Raw

Linux installation from sources

The instructions for installing the |ddsrouter| application from sources and its required dependencies are provided in this page. It is organized as follows:

Dependencies installation

|ddsrouter| depends on eProsima Fast DDS library and certain Debian packages. This section describes the instructions for installing |ddsrouter| dependencies and requirements in a Linux environment from sources. The following packages will be installed:

  • foonathan_memory_vendor, an STL compatible C++ memory allocation library.
  • fastcdr, a C++ library that serializes according to the standard CDR serialization mechanism.
  • fastdds, the core library of eProsima Fast DDS library.
  • cmake_utils, an eProsima utils library for CMake.
  • cpp_utils, an eProsima utils library for C++.

First of all, the :ref:`Requirements <requirements>` and :ref:`Dependencies <dependencies>` detailed below need to be met. Afterwards, the user can choose whether to follow either the :ref:`colcon <colcon_installation>` or the :ref:`CMake <cmake_installation>` installation instructions.

Requirements

The installation of |ddsrouter| in a Linux environment from sources requires the following tools to be installed in the system:

CMake, g++, pip, wget and git

These packages provide the tools required to install |ddsrouter| and its dependencies from command line. Install CMake, g++, pip, wget and git using the package manager of the appropriate Linux distribution. For example, on Ubuntu use the command:

sudo apt install cmake g++ pip wget git

Colcon

colcon is a command line tool based on CMake aimed at building sets of software packages. Install the ROS 2 development tools (colcon and vcstool) by executing the following command:

pip3 install -U colcon-common-extensions vcstool

Note

If this fails due to an Environment Error, add the --user flag to the pip3 installation command.

Gtest

Gtest is a unit testing library for C++. By default, |ddsrouter| does not compile tests. It is possible to activate them with the opportune CMake options when calling colcon or CMake. For more details, please refer to the :ref:`cmake_options` section. For a detailed description of the Gtest installation process, please refer to the Gtest Installation Guide.

It is also possible to clone the Gtest Github repository into the |ddsrouter| workspace and compile it with colcon as a dependency package. Use the following command to download the code:

git clone --branch release-1.12.0 https://github.com/google/googletest src/googletest-distribution

Dependencies

|ddsrouter| has the following dependencies, when installed from sources in a Linux environment:

Asio and TinyXML2 libraries

Asio is a cross-platform C++ library for network and low-level I/O programming, which provides a consistent asynchronous model. TinyXML2 is a simple, small and efficient C++ XML parser. Install these libraries using the package manager of the appropriate Linux distribution. For example, on Ubuntu use the command:

sudo apt install libasio-dev libtinyxml2-dev

OpenSSL

OpenSSL is a robust toolkit for the TLS and SSL protocols and a general-purpose cryptography library. Install OpenSSL using the package manager of the appropriate Linux distribution. For example, on Ubuntu use the command:

sudo apt install libssl-dev

yaml-cpp

yaml-cpp is a YAML parser and emitter in C++ matching the YAML 1.2 spec, and is used by DDS Router application to parse the provided configuration files. Install yaml-cpp using the package manager of the appropriate Linux distribution. For example, on Ubuntu use the command:

sudo apt install libyaml-cpp-dev

eProsima dependencies

If it already exists in the system an installation of Fast DDS library with version greater than 2.4.0, just source this library when building the |ddsrouter| application by using the command:

source <fastdds-installation-path>/install/setup.bash

In other case, just download Fast DDS project from sources and build it together with |ddsrouter| using colcon as it is explained in section :ref:`colcon_installation`.

Colcon installation

  1. Create a DDS-Router directory and download the .repos file that will be used to install |ddsrouter| and its dependencies:

    mkdir -p ~/DDS-Router/src
cd ~/DDS-Router
wget https://raw.githubusercontent.com/eProsima/DDS-Router/main/ddsrouter.repos
vcs import src < ddsrouter.repos

    Note

    In case there is already a Fast DDS installation in the system it is not required to download and build every dependency in the .repos file. It is just needed to download and build the |ddsrouter| project having sourced its dependencies. Refer to section :ref:`eprosima_dependencies` in order to check how to source Fast DDS library.

  2. Build the packages:

    colcon build

Note

Being based on CMake, it is possible to pass the CMake configuration options to the colcon build command. For more information on the specific syntax, please refer to the CMake specific arguments page of the colcon manual.

CMake installation

This section explains how to compile |ddsrouter| with CMake, either :ref:`locally <local_installation_sl>` or :ref:`globally <global_installation_sl>`.

Local installation

  1. Create a DDS-Router directory where to download and build |ddsrouter| and its dependencies:

    mkdir -p ~/DDS-Router/src
mkdir -p ~/DDS-Router/build
cd ~/DDS-Router
wget https://raw.githubusercontent.com/eProsima/DDS-Router/main/ddsrouter.repos
vcs import src < ddsrouter.repos

  2. Compile all dependencies using CMake.

    • Foonathan memory

      cd ~/DDS-Router
mkdir build/foonathan_memory_vendor
cd build/foonathan_memory_vendor
cmake ~/DDS-Router/src/foonathan_memory_vendor -DCMAKE_INSTALL_PREFIX=~/DDS-Router/install -DBUILD_SHARED_LIBS=ON
cmake --build . --target install

    • Fast CDR

      cd ~/DDS-Router
mkdir build/fastcdr
cd build/fastcdr
cmake ~/DDS-Router/src/fastcdr -DCMAKE_INSTALL_PREFIX=~/DDS-Router/install
cmake --build . --target install

    • Fast DDS

      cd ~/DDS-Router
mkdir build/fastdds
cd build/fastdds
cmake ~/DDS-Router/src/fastdds -DCMAKE_INSTALL_PREFIX=~/DDS-Router/install -DCMAKE_PREFIX_PATH=~/DDS-Router/install
cmake --build . --target install

    • Dev Utils

      # CMake Utils
cd ~/DDS-Router
mkdir build/cmake_utils
cd build/cmake_utils
cmake ~/DDS-Router/src/dev-utils/cmake_utils -DCMAKE_INSTALL_PREFIX=~/DDS-Router/install -DCMAKE_PREFIX_PATH=~/DDS-Router/install
cmake --build . --target install

# C++ Utils
cd ~/DDS-Router
mkdir build/cpp_utils
cd build/cpp_utils
cmake ~/DDS-Router/src/dev-utils/cpp_utils -DCMAKE_INSTALL_PREFIX=~/DDS-Router/install -DCMAKE_PREFIX_PATH=~/DDS-Router/install
cmake --build . --target install

    • DDS Pipe

      # ddspipe_core
cd ~/DDS-Router
mkdir build/ddspipe_core
cd build/ddspipe_core
cmake ~/DDS-Router/src/ddspipe/ddspipe_core -DCMAKE_INSTALL_PREFIX=~/DDS-Router/install -DCMAKE_PREFIX_PATH=~/DDS-Router/install
cmake --build . --target install

# ddspipe_participants
cd ~/DDS-Router
mkdir build/ddspipe_participants
cd build/ddspipe_participants
cmake ~/DDS-Router/src/ddspipe/ddspipe_participants -DCMAKE_INSTALL_PREFIX=~/DDS-Router/install -DCMAKE_PREFIX_PATH=~/DDS-Router/install
cmake --build . --target install

# ddspipe_yaml
cd ~/DDS-Router
mkdir build/ddspipe_yaml
cd build/ddspipe_yaml
cmake ~/DDS-Router/src/ddspipe/ddspipe_yaml -DCMAKE_INSTALL_PREFIX=~/DDS-Router/install -DCMAKE_PREFIX_PATH=~/DDS-Router/install
cmake --build . --target install

  3. Once all dependencies are installed, install |ddsrouter|:

    # ddsrouter_core
cd ~/DDS-Router
mkdir build/ddsrouter_core
cd build/ddsrouter_core
cmake ~/DDS-Router/src/ddsrouter/ddsrouter_core -DCMAKE_INSTALL_PREFIX=~/DDS-Router/install -DCMAKE_PREFIX_PATH=~/DDS-Router/install
cmake --build . --target install

# ddsrouter_yaml
cd ~/DDS-Router
mkdir build/ddsrouter_yaml
cd build/ddsrouter_yaml
cmake ~/DDS-Router/src/ddsrouter/ddsrouter_yaml -DCMAKE_INSTALL_PREFIX=~/DDS-Router/install -DCMAKE_PREFIX_PATH=~/DDS-Router/install
cmake --build . --target install

# ddsrouter_tool
cd ~/DDS-Router
mkdir build/ddsrouter_tool
cd build/ddsrouter_tool
cmake ~/DDS-Router/src/ddsrouter/tools/ddsrouter_tool -DCMAKE_INSTALL_PREFIX=~/DDS-Router/install -DCMAKE_PREFIX_PATH=~/DDS-Router/install
cmake --build . --target install

Note

By default, |ddsrouter| does not compile tests. However, they can be activated by downloading and installing Gtest and building with CMake option -DBUILD_TESTS=ON.

Global installation

To install |ddsrouter| system-wide instead of locally, remove all the flags that appear in the configuration steps of Fast-CDR, Fast-DDS, and DDS-Router, and change the first in the configuration step of foonathan_memory_vendor to the following:

-DCMAKE_INSTALL_PREFIX=/usr/local/ -DBUILD_SHARED_LIBS=ON

Run an application

To run the |ddsrouter| application, source the Fast DDS library and execute the executable file that has been installed in <install-path>/ddsrouter_tool/bin/ddsrouter:

# If built has been done using colcon, all projects could be sourced as follows
source install/setup.bash
./<install-path>/ddsrouter_tool/bin/ddsrouter

Be sure that this executable has execute permissions.