Shared Memory Dump

This tool outputs the content of a shared memory to stdout.

Use the Application

To use the application, simply call it with the name of the shared memory to be output as an argument.

To display the content you can for example use hexdump:

dump-shm -n <name> | hexdump -C -v

Under linux the following command has the same effect:

cat /dev/shm/<name> | hexdump -C -v

Install

Using the Arch User Repository (recommended for Arch based Linux distributions)

The application is available as dump-shm in the Arch User Repository. See the Arch Wiki for information about how to install AUR packages.

Using the Modbus Collection Flatpak Package: Shared Memory Modbus

SHM-Modbus is a collection of the shared memory modbus tools. It is available as flatpak and published on flathub as network.koesling.shm-modbs.

Using the Standalone Flatpak package

The flatpak package can be installed via the .flatpak file. This can be downloaded from the GitHub projects release page:

flatpak install --user dump-shm.flatpak

The application is then executed as follows:

flatpak run network.koesling.dump-shm

To enable calling with dump-shm this script can be used. In order to be executable everywhere, the path in which the script is placed must be in the PATH environment variable.

Build from Source

The following packages are required for building the application:

• cmake
• clang or gcc

Use the following commands to build the application:

git clone https://github.com/NikolasK-source/dump_shm.git
cd dump_shm
mkdir build
cmake -B build . -DCMAKE_BUILD_TYPE=Release -DCLANG_FORMAT=OFF -DCOMPILER_WARNINGS=OFF
cmake --build build

The binary is located in the build directory.

Links to related projects

General Shared Memory Tools

• Shared Memory Dump
• Shared Memory Write
• Shared Memory Random

Modbus Clients

• RTU
• TCP

Modbus Shared Memory Tools

• STDIN to Modbus
• Float converter

License

MIT License

Copyright (c) 2021-2022 Nikolas Koesling

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.