In this document are tips and hints documented which can help for troubleshooting on RouDi.
Does iceoryx run in a docker environment🔗
Yes. Take a look at the icedocker example
iox-roudi fails on startup🔗
An error message like
user@iceoryx-host:/# iox-roudi Log level set to: [Warning] SharedMemory still there, doing an unlink of /iceoryx_mgmt Reserving 59736448 bytes in the shared memory [/iceoryx_mgmt] [ Reserving shared memory successful ] SharedMemory still there, doing an unlink of /root Reserving 27902400 bytes in the shared memory [/root] While setting the acquired shared memory to zero a fatal SIGBUS signal appeared caused by memset. The shared memory object with the following properties [ name = /root, sizeInBytes = 27902400, access mode = AccessMode::READ_WRITE, ownership = OwnerShip::MINE, baseAddressHint = (nil), permissions = 0 ] maybe requires more memory than it is currently available in the system.
indicates that there is not enough shared memory available. Check with
df -H /dev/shm
if you have enough memory available. In this exemplary error message we require
59736448 (iceoryx management data) +
27902400 (user samples) ~
of shared memory.
Stack size handling🔗
The iceoryx middleware utilize stack memory from the system for book-keeping of
Most Linux distributions offers 8 Megabyte of stack memory for a process which is enough
for iceoryx. You can check this with the output from
On other platforms like windows other rules apply for the stack memory.
On windows there is only 1 Megabyte of stack available.
Increasing the stack size generally on iceoryx is not recommended since
could consume lots of memory without using it.
Especially using RouDi in a multi-threaded context can run out the stack memory and
lead to memory errors.
Single process example shows that when compiling and executing it on windows.
Without setting the stack size the application will throw a
Stack overflow exception
when entering the
This can be solved in CMake by adding a linker flag:
target_link_options(single_process BEFORE PRIVATE /STACK:3500000)
For other platforms apply other flags or solutions.
CI fails but error is locally not reproducable🔗
One can use
tools/scripts/ice_env.sh to create an iceoryx development environment
with a configuration very similar to the CI target.
When for instance the target ubuntu 18.04 fails one can create a docker container
cd tools/scripts ./ice-env.sh enter ubuntu:18.04
This starts the container, installs all dependencies which iceoryx requires and enters the environment.
When you are in a docker environment check if there is enough memory available in your docker.
# docker stats CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS 367b9fae6c2f nifty_galileo 0.00% 4.48MiB / 1GiB 0.44% 11.6kB / 0B 17.6MB / 0B 1
If not you can restart the docker container with
--shm-size="2g" to increase
the total amount of available shared memory.
docker run -it --shm-size="2g" ubuntu
Termination of RouDi and processes🔗
To avoid undefined behavior of iceoryx posh it is recommended to terminate RouDi and the corresponding middleware processes with SIGINT or SIGTERM. In RouDi, we have integrated a sighandler that catches the signals and gives RouDi the chance to exit and clean-up everything. This also applies for processes. Therefore, we recommend adding a signalhandler to your process (see this example).