Merge pull request #5 from NikolasK-source/main

release 1.0.5

Author: NikolasK-source

.gitmodules

@@ -1,3 +1,6 @@
 [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

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.13.4 FATAL_ERROR)
 # ======================================================================================================================
 
 # project
-project(shared-mem-random LANGUAGES CXX VERSION 1.0.4)
+project(shared-mem-random LANGUAGES CXX VERSION 1.0.5)
 
 # settings
 set(Target "shared-mem-random")          # Executable name (without file extension!)

libs/CMakeLists.txt

@@ -6,7 +6,11 @@
 
 # ---------------------------------------- link libraries --------------------------------------------------------------
 # ======================================================================================================================
-target_link_libraries(${Target} PRIVATE rt)
-
 add_subdirectory(cxxopts EXCLUDE_FROM_ALL)
 target_link_libraries(${Target} PRIVATE cxxopts)
+
+add_subdirectory(cxxshm EXCLUDE_FROM_ALL)
+target_link_libraries(${Target} PRIVATE cxxshm)
+
+target_link_libraries(${Target} PRIVATE rt)
+

libs/cxxshm

@@ -54,4 +54,29 @@ void print_licenses(std::ostream &o) {
     o << "    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM," << std::endl;
     o << "    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN" << std::endl;
     o << "    THE SOFTWARE." << std::endl;
+    o << std::endl;
+    o << std::endl;
+    o << "cxxshm Library (https://github.com/NikolasK-source/cxxshm)" << std::endl;
+    o << std::endl;
+    o << "    MIT License" << std::endl;
+    o << std::endl;
+    o << "    Copyright (c) 2022 Nikolas Koesling" << std::endl;
+    o << std::endl;
+    o << "    Permission is hereby granted, free of charge, to any person obtaining a copy" << std::endl;
+    o << "    of this software and associated documentation files (the \"Software\"), to deal" << std::endl;
+    o << "    in the Software without restriction, including without limitation the rights" << std::endl;
+    o << "    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell" << std::endl;
+    o << "    copies of the Software, and to permit persons to whom the Software is" << std::endl;
+    o << "    furnished to do so, subject to the following conditions:" << std::endl;
+    o << std::endl;
+    o << "    The above copyright notice and this permission notice shall be included in" << std::endl;
+    o << "    all copies or substantial portions of the Software." << std::endl;
+    o << std::endl;
+    o << "    THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR" << std::endl;
+    o << "    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY," << std::endl;
+    o << "    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE" << std::endl;
+    o << "    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER" << std::endl;
+    o << "    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM," << std::endl;
+    o << "    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN" << std::endl;
+    o << "    THE SOFTWARE." << std::endl;
 }

src/license.cpp

@@ -5,11 +5,13 @@
 
 #include "license.hpp"
 
+#include "cxxshm.hpp"
 #include <csignal>
 #include <cxxopts.hpp>
 #include <fcntl.h>
 #include <filesystem>
 #include <iostream>
+#include <memory>
 #include <random>
 #include <sys/mman.h>
 #include <sys/stat.h>
@@ -81,6 +83,7 @@ int main(int argc, char **argv) {
         std::cout << std::endl;
         std::cout << "This application uses the following libraries:" << std::endl;
         std::cout << "  - cxxopts by jarro2783 (https://github.com/jarro2783/cxxopts)" << std::endl;
+        std::cout << "  - cxxshm (https://github.com/NikolasK-source/cxxshm)" << std::endl;
         exit(EX_OK);
     }
 
@@ -152,34 +155,20 @@ int main(int argc, char **argv) {
         }
     }
 
-    if (signal(SIGINT, sig_term_handler) || signal(SIGTERM, sig_term_handler)) {
+    if (signal(SIGINT, sig_term_handler) == SIG_ERR || signal(SIGTERM, sig_term_handler) == SIG_ERR) {
         perror("signal");
         exit(EX_OSERR);
     }
 
-    // open shared memory
-    int fd = shm_open(shm_name.c_str(), O_RDWR, 0660);
-    if (fd < 0) {
-        perror(("failed to open shared memory '" + shm_name + '\'').c_str());
-        exit(EX_OSERR);
-    }
-
-    // determine size of shared memory
-    struct stat shm_stats {};
-    if (fstat(fd, &shm_stats)) {
-        perror("fstat");
-        close(fd);
-        exit(EX_OSERR);
+    std::unique_ptr<cxxshm::SharedMemory> shm;
+    try {
+        shm = std::make_unique<cxxshm::SharedMemory>(shm_name);
+    } catch (std::exception &e) {
+        std::cerr << e.what() << std::endl;
+        return EX_OSERR;
     }
-    const auto SIZE = static_cast<std::size_t>(shm_stats.st_size);
 
-    // map shared memory
-    void *data = mmap(nullptr, SIZE, PROT_WRITE, MAP_SHARED, fd, 0);
-    if (data == MAP_FAILED || data == nullptr) {
-        perror("mmap");
-        if (close(fd)) { perror("close"); }
-        exit(EX_OSERR);
-    }
+    const auto SIZE = shm->get_size();
 
     std::cerr << "Opened shared memory '" << shm_name << "'. Size: " << SIZE << (SIZE != 1 ? " bytes" : " byte") << '.'
               << std::endl;
@@ -196,7 +185,7 @@ int main(int argc, char **argv) {
     switch (alignment) {
         case BYTE:
             while (!terminate) {
-                random_data<uint8_t>(data, shm_elements, bitmask);
+                random_data<uint8_t>(shm->get_addr(), shm_elements, bitmask);
                 nanosleep(&sleep_time, nullptr);
 
                 if (interval_counter) {
@@ -206,7 +195,7 @@ int main(int argc, char **argv) {
             break;
         case WORD:
             while (!terminate) {
-                random_data<uint16_t>(data, shm_elements, bitmask);
+                random_data<uint16_t>(shm->get_addr(), shm_elements, bitmask);
                 nanosleep(&sleep_time, nullptr);
 
                 if (interval_counter) {
@@ -216,7 +205,7 @@ int main(int argc, char **argv) {
             break;
         case DWORD:
             while (!terminate) {
-                random_data<uint32_t>(data, shm_elements, bitmask);
+                random_data<uint32_t>(shm->get_addr(), shm_elements, bitmask);
                 nanosleep(&sleep_time, nullptr);
 
                 if (interval_counter) {
@@ -226,7 +215,7 @@ int main(int argc, char **argv) {
             break;
         case QWORD:
             while (!terminate) {
-                random_data<uint64_t>(data, shm_elements, bitmask);
+                random_data<uint64_t>(shm->get_addr(), shm_elements, bitmask);
                 nanosleep(&sleep_time, nullptr);
 
                 if (interval_counter) {
@@ -236,9 +225,5 @@ int main(int argc, char **argv) {
             break;
     }
 
-    // clean
-    if (munmap(data, SIZE)) { perror("munmap"); }
-    if (close(fd)) { perror("close"); }
-
     std::cerr << "Terminating..." << std::endl;
 }