Integration problem using iceoryx2 in custom C++ project

[C137Engineer]

Hi everyone,

I’m currently trying to use iceoryx2 in my c++ Project but ran into some issue.

I started with the Quickstart Guide in the iceoryx2 Book. For installation, I cloned iceoryx2 into my home directory and followed the Build Instructions for integrator instruction. I also installed all dependencies on my machine using the install_dependencies_ubuntu.sh script.

For testing, I copied the example folder request_response into my home directory and adapted the CMakeLists.txt according to the Quickstart Guide:

Click to expand

cmake_minimum_required(VERSION 3.22)
project(example_cxx_request_response LANGUAGES CXX)

set(CMAKE_PREFIX_PATH "~/iceoryx2/target/ff/cc/install" ${CMAKE_PREFIX_PATH})

find_package(iceoryx2 REQUIRED)

add_executable(example_cxx_request_response_client src/client.cpp)
target_link_libraries(example_cxx_request_response_client iceoryx2-cxx)

add_executable(example_cxx_request_response_server src/server.cpp)
target_link_libraries(example_cxx_request_response_server iceoryx2-cxx)

But this results in the following error:

Click to expand

CMake Error at CMakeLists.txt:33 (find_package):
  By not providing "Findiceoryx2.cmake" in CMAKE_MODULE_PATH this project has
  asked CMake to find a package configuration file provided by "iceoryx2",
  but CMake did not find one.

  Could not find a package configuration file provided by "iceoryx2" with any
  of the following names:

    iceoryx2Config.cmake
    iceoryx2-config.cmake

  Add the installation prefix of "iceoryx2" to CMAKE_PREFIX_PATH or set
  "iceoryx2_DIR" to a directory containing one of the above files.  If
  "iceoryx2" provides a separate development package or SDK, be sure it has
  been installed.

Then I tried to align more closely with the original CMake configuration from the repo:

Click to expand

cmake_minimum_required(VERSION 3.22)
project(example_cxx_request_response LANGUAGES CXX)

set(CMAKE_PREFIX_PATH "~/iceoryx2/target/ff/cc/install" ${CMAKE_PREFIX_PATH})

find_package(iceoryx2-cxx 0.7.0 REQUIRED)

add_executable(example_cxx_request_response_client src/client.cpp)
target_link_libraries(example_cxx_request_response_client iceoryx2-cxx::static-lib-cxx)

add_executable(example_cxx_request_response_server src/server.cpp)
target_link_libraries(example_cxx_request_response_server iceoryx2-cxx::static-lib-cxx)

This compiles, but running the binary fails with:

./example_cxx_request_response_server: error while loading shared libraries: libiceoryx_platform.so.2: cannot open shared object file: No such file or directory

If I set the library path manually, it works, but this workaround feels wrong, as if something is missing or faulty.

LD_LIBRARY_PATH=~/iceoryx2/target/ff/cc/install/lib ./build/example_cxx_request_response_server

Is there something I’m missing during installation or linking and should find_package(iceoryx2) work, or is iceoryx2-cxx currently the correct way to integrate it?
Any suggestions or hints would be helpful, thanks!

System environment:

• Ubuntu 24.04 (fresh install)

• Build commands:

  cmake -S . -B build
  cmake --build build
  

[elBoberido]

We need to adjust the quickstart guide. Please no not set the CMAKE_PREFIX_PATH in the CMakeLists.txt.

Please check these instructions: https://github.com/eclipse-iceoryx/iceoryx2/blob/main/iceoryx2-cxx/README.md

We'll work on a cmake template which will use FetchContent to simplify the setup. Additionally, we will move the parts of iceoryx classic, which are used for the C++ bindings into the iceoryx2 repo. This should also help.

[C137Engineer]

okay thanks, I followed the instructions and built my test project again using:

cmake -S . -B ./build -DCMAKE_PREFIX_PATH=$HOME/iceoryx2/target/ff/cc/install
cmake --build build

and cmake:

cmake_minimum_required(VERSION 3.22)
project(example_cxx_request_response LANGUAGES CXX)

find_package(iceoryx2-cxx REQUIRED)

add_executable(example_cxx_request_response_client src/client.cpp)
target_link_libraries(example_cxx_request_response_client
    PRIVATE iceoryx2-cxx::static-lib-cxx)

add_executable(example_cxx_request_response_server src/server.cpp)
target_link_libraries(example_cxx_request_response_server
    PRIVATE iceoryx2-cxx::static-lib-cxx)

It compiles, but when I try to run it, I get the same error saying the shared library libiceoryx_platform.so.2 cannot be found.

I have now just added the path to the linker's configs folder, to avoid having to specify the path manually every time:

echo "$HOME/iceoryx2/target/ff/cc/install/lib" | sudo tee /etc/ld.so.conf.d/iceoryx2.conf
sudo ldconfig

It works, but something seems to have gone wrong with my setup.