Merge pull request #10 from NikolasK-source/main

v1.0.0

Author: NikolasK-source

.gitmodules

@@ -1,3 +1,9 @@
 [submodule "libs/cxxopts"]
     path = libs/cxxopts
     url = https://github.com/NikolasK-source/cxxopts.git
+[submodule "libs/cxxshm"]
+	path = libs/cxxshm
+	url = https://github.com/NikolasK-source/cxxshm.git
+[submodule "libs/cxxsemaphore"]
+	path = libs/cxxsemaphore
+	url = https://github.com/NikolasK-source/cxxsemaphore.git

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.13.4 FATAL_ERROR)
 # ======================================================================================================================
 
 # project
-project(write-shm LANGUAGES CXX VERSION 0.1.3)
+project(write-shm LANGUAGES CXX VERSION 1.0.0)
 
 # settings
 set(Target "write-shm")    # Executable name (without file extension!)

docs/index.md

@@ -45,7 +45,19 @@ write-shm -n mem < file
 write-shm -n mem -r < file
 ```
 
-## Using the Flatpak package
+## Install
+
+### Using the Arch User Repository (recommended for Arch based Linux distributions)
+The application is available as [write-shm](https://aur.archlinux.org/packages/write-shm) in the [Arch User Repository](https://aur.archlinux.org/).
+See the [Arch Wiki](https://wiki.archlinux.org/title/Arch_User_Repository) for information about how to install AUR packages.
+
+
+### Using the Modbus Collection Flatpak Package: Shared Memory Modbus
+[SHM-Modbus](https://nikolask-source.github.io/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](https://github.com/NikolasK-source/write_shm/releases):
 
@@ -62,7 +74,7 @@ To enable calling with ```write-shm``` [this script](https://gist.github.com/Nik
 In order to be executable everywhere, the path in which the script is placed must be in the ```PATH``` environment variable.
 
 
-## Build from Source
+### Build from Source
 
 The following packages are required for building the application:
 - cmake

libs/CMakeLists.txt

@@ -2,11 +2,14 @@
 # ---------------------------------------- subdirectories --------------------------------------------------------------
 # ======================================================================================================================
 
-
+add_subdirectory(cxxopts EXCLUDE_FROM_ALL)
+add_subdirectory(cxxsemaphore)
+add_subdirectory(cxxshm)
 
 # ---------------------------------------- link libraries --------------------------------------------------------------
 # ======================================================================================================================
-target_link_libraries(${Target} PRIVATE rt)
 
-add_subdirectory(cxxopts EXCLUDE_FROM_ALL)
+target_link_libraries(${Target} PRIVATE rt)
 target_link_libraries(${Target} PRIVATE cxxopts)
+target_link_libraries(${Target} PRIVATE cxxsemaphore)
+target_link_libraries(${Target} PRIVATE cxxshm)

libs/cxxsemaphore

@@ -1,6 +1,6 @@
 id: network.koesling.test-write-shm
 runtime: org.freedesktop.Platform
-runtime-version: '21.08'
+runtime-version: '23.08'
 sdk: org.freedesktop.Sdk
 command: write-shm
 finish-args:

libs/cxxshm

@@ -1,6 +1,6 @@
 id: network.koesling.write-shm
 runtime: org.freedesktop.Platform
-runtime-version: '21.08'
+runtime-version: '23.08'
 sdk: org.freedesktop.Sdk
 command: write-shm
 finish-args:

network.koesling.test-write-shm.yml

@@ -2,13 +2,11 @@
 # ======================================================================================================================
 
 target_sources(${Target} PRIVATE main.cpp)
-target_sources(${Target} PRIVATE SHM.cpp)
 target_sources(${Target} PRIVATE license.cpp)
 
 # ---------------------------------------- header files (*.jpp, *.h, ...) ----------------------------------------------
 # ======================================================================================================================
 
-target_sources(${Target} PRIVATE SHM.hpp)
 target_sources(${Target} PRIVATE license.hpp)
 
 # ---------------------------------------- subdirectories --------------------------------------------------------------

network.koesling.write-shm.yml

@@ -3,10 +3,11 @@
  * This program is free software. You can redistribute it and/or modify it under the terms of the MIT License.
  */
 
-#include "SHM.hpp"
 #include "license.hpp"
 
 #include <cxxopts.hpp>
+#include <cxxsemaphore.hpp>
+#include <cxxshm.hpp>
 #include <filesystem>
 #include <iostream>
 #include <memory>
@@ -29,6 +30,9 @@ int main(int argc, char **argv) {
     options.add_options()("p,passthrough",
                           "output everything that is written to the shared memory to stdout",
                           cxxopts::value<bool>()->default_value("false"));
+    options.add_options()("s,semaphore",
+                          "protect the shared memory with an existing named semaphore against simultaneous access",
+                          cxxopts::value<std::string>());
     options.add_options()("h,help", "print usage");
     options.add_options()("version", "print version information");
     options.add_options()("license", "show licenses");
@@ -67,15 +71,28 @@ int main(int argc, char **argv) {
     }
 
     // open shm
-    std::unique_ptr<SHM> shm;
+    std::unique_ptr<cxxshm::SharedMemory> shm;
     try {
-        shm = std::make_unique<SHM>(args["name"].as<std::string>());
+        shm = std::make_unique<cxxshm::SharedMemory>(args["name"].as<std::string>());
     } catch (const std::system_error &e) {
         std::cerr << e.what() << std::endl;
         exit(EX_OSERR);
     } catch (const cxxopts::option_has_no_value_exception &) {
         std::cerr << "Specifying an shared memory name is mandatory." << std::endl;
         exit_usage();
+    } catch (const std::exception &e) {
+        std::cerr << e.what() << std::endl;
+        exit(EX_SOFTWARE);
+    }
+
+    std::unique_ptr<cxxsemaphore::Semaphore> semaphore;
+    if (args.count("semaphore")) {
+        try {
+            semaphore = std::make_unique<cxxsemaphore::Semaphore>(args["semaphore"].as<std::string>());
+        } catch (std::exception &e) {
+            std::cerr << e.what() << std::endl;
+            return EX_SOFTWARE;
+        }
     }
 
     const auto SHM_SIZE = shm->get_size();
@@ -88,6 +105,8 @@ int main(int argc, char **argv) {
 
     const int INVERT_MASK = args["invert"].as<bool>() ? ~0 : 0;
 
+    if (semaphore) semaphore->wait();
+
     // copy file to shm (and buffer)
     std::size_t remaining = SHM_SIZE;
     std::size_t pos       = 0;
@@ -124,4 +143,6 @@ int main(int argc, char **argv) {
             remaining -= COPY_SIZE;
         }
     }
+
+    if (semaphore) semaphore->post();
 }