Merge pull request #2064 from eclipse-iceoryx/iox-1391-move-dust-head…

…er-from-legacy-path-to-module-path-part-3 iox-#1391 Move dust header from legacy path to module path part 3
eclipse-iceoryx · Nov 15, 2023 · 4144844 · 4144844
2 parents 421cb50 + 6f6a714
commit 4144844
Show file tree

Hide file tree

Showing 63 changed files with 181 additions and 162 deletions.
diff --git a/.lycheeignore b/.lycheeignore
@@ -1,4 +1,5 @@
 https://github.com/eclipse-iceoryx/iceoryx/compare/vx.x.x...vx.x.x
 https://github.com/eclipse-iceoryx/iceoryx/tree/vx.x.x
+https://www.misra.org.uk/
 
 [email protected]
diff --git a/doc/website/release-notes/iceoryx-unreleased.md b/doc/website/release-notes/iceoryx-unreleased.md
@@ -1000,23 +1000,23 @@
     #include "iceoryx_hoofs/posix_wrapper/internal/message_queue.hpp"
 
     // after
-    #include "iceoryx_dust/posix_wrapper/message_queue.hpp"
+    #include "iox/posix/message_queue.hpp"
     ```
 
     ```cpp
     // before
     #include "iceoryx_hoofs/posix_wrapper/named_pipe.hpp"
 
     // after
-    #include "iceoryx_dust/posix_wrapper/named_pipe.hpp"
+    #include "iox/posix/named_pipe.hpp"
     ```
 
     ```cpp
     // before
     #include "iceoryx_hoofs/posix_wrapper/signal_watcher.hpp"
 
     // after
-    #include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
+    #include "iox/posix/signal_watcher.hpp"
     ```
 
     ```cpp

diff --git a/iceoryx_binding_c/source/c_runtime.cpp b/iceoryx_binding_c/source/c_runtime.cpp
@@ -27,9 +27,9 @@ extern "C" {
 
 void iox_runtime_init(const char* const name)
 {
-    IOX_EXPECTS(name != nullptr && "Runtime name is a nullptr!");
-    IOX_EXPECTS(strnlen(name, iox::MAX_RUNTIME_NAME_LENGTH + 1) <= MAX_RUNTIME_NAME_LENGTH
-                && "Runtime name has more than 100 characters!");
+    IOX_EXPECTS_WITH_MSG(name != nullptr, "Runtime name is a nullptr!");
+    IOX_EXPECTS_WITH_MSG(strnlen(name, iox::MAX_RUNTIME_NAME_LENGTH + 1) <= MAX_RUNTIME_NAME_LENGTH,
+                         "Runtime name has more than 100 characters!");
 
     PoshRuntime::initRuntime(RuntimeName_t(iox::TruncateToCapacity, name));
 }

diff --git a/iceoryx_dust/BUILD.bazel b/iceoryx_dust/BUILD.bazel
@@ -20,7 +20,7 @@ load("//bazel:configure_file.bzl", "configure_file")
 configure_file(
     name = "iceoryx_dust_deployment_hpp",
     src = "cmake/iceoryx_dust_deployment.hpp.in",
-    out = "include/iox/iceoryx_dust_deployment.hpp",
+    out = "generated/include/iox/iceoryx_dust_deployment.hpp",
     config = {
         "IOX_MAX_NAMED_PIPE_MESSAGE_SIZE": "4096",
         "IOX_MAX_NAMED_PIPE_NUMBER_OF_MESSAGES": "10",
@@ -32,18 +32,20 @@ cc_library(
     srcs = glob([
         "cli/source/**/*.cpp",
         "filesystem/source/**/*.cpp",
-        "source/**/*.cpp",
-        "source/**/*.hpp",
+        "posix/ipc/source/**/*.cpp",
+        "posix/sync/source/**/*.cpp",
     ]),
-    hdrs = glob(["include/**"]) + glob(["cli/**"]) + glob(["container/**"]) + glob(["filesystem/**"]) + glob(["memory/**"]) + glob(["utility/**"]) + glob(["vocabulary/**"]) + [
+    hdrs = glob(["cli/**"]) + glob(["container/**"]) + glob(["filesystem/**"]) + glob(["memory/**"]) + glob(["utility/**"]) + glob(["posix/ipc/**"]) + glob(["posix/sync/**"]) + glob(["vocabulary/**"]) + [
         ":iceoryx_dust_deployment_hpp",
     ],
     includes = [
         "cli/include/",
         "container/include/",
         "filesystem/include/",
-        "include",
+        "generated/include/",
         "memory/include/",
+        "posix/ipc/include/",
+        "posix/sync/include/",
         "utility/include/",
         "vocabulary/include/",
     ],

diff --git a/iceoryx_dust/CMakeLists.txt b/iceoryx_dust/CMakeLists.txt
@@ -46,20 +46,22 @@ iox_add_library(
     PRIVATE_LIBS                ${ICEORYX_SANITIZER_FLAGS}
     PRIVATE_LIBS_LINUX          ${CODE_COVERAGE_LIBS}
     PUBLIC_LIBS                 iceoryx_hoofs::iceoryx_hoofs
-    BUILD_INTERFACE             ${PROJECT_SOURCE_DIR}/include
-                                ${PROJECT_SOURCE_DIR}/cli/include
+    BUILD_INTERFACE             ${PROJECT_SOURCE_DIR}/cli/include
                                 ${PROJECT_SOURCE_DIR}/container/include
                                 ${PROJECT_SOURCE_DIR}/filesystem/include
                                 ${PROJECT_SOURCE_DIR}/memory/include
+                                ${PROJECT_SOURCE_DIR}/posix/ipc/include
+                                ${PROJECT_SOURCE_DIR}/posix/sync/include
                                 ${PROJECT_SOURCE_DIR}/utility/include
                                 ${PROJECT_SOURCE_DIR}/vocabulary/include
                                 ${CMAKE_BINARY_DIR}/generated/iceoryx_dust/include
     INSTALL_INTERFACE           include/${PREFIX}
-    EXPORT_INCLUDE_DIRS         include/
-                                cli/include/
+    EXPORT_INCLUDE_DIRS         cli/include/
                                 container/include/
                                 filesystem/include/
                                 memory/include/
+                                posix/ipc/include/
+                                posix/sync/include/
                                 utility/include/
                                 vocabulary/include/
     FILES
@@ -69,9 +71,9 @@ iox_add_library(
         cli/source/option_definition.cpp
         cli/source/option_manager.cpp
         filesystem/source/file_reader.cpp
-        source/posix_wrapper/named_pipe.cpp
-        source/posix_wrapper/signal_watcher.cpp
-        source/posix_wrapper/message_queue.cpp
+        posix/ipc/source/message_queue.cpp
+        posix/ipc/source/named_pipe.cpp
+        posix/sync/source/signal_watcher.cpp
 )
 
 configure_file("${CMAKE_CURRENT_SOURCE_DIR}/cmake/iceoryx_dust_deployment.hpp.in"

diff --git a/iceoryx_dust/container/include/iox/detail/forward_list.inl b/iceoryx_dust/container/include/iox/detail/forward_list.inl
@@ -329,15 +329,15 @@ template <typename T, uint64_t Capacity>
 inline T& forward_list<T, Capacity>::front() noexcept
 {
     auto iter = begin();
-    IOX_EXPECTS(isValidElementIdx(iter.m_iterListNodeIdx) && "Invalid list element");
+    IOX_EXPECTS_WITH_MSG(isValidElementIdx(iter.m_iterListNodeIdx), "Invalid list element");
     return *iter;
 }
 
 template <typename T, uint64_t Capacity>
 inline const T& forward_list<T, Capacity>::front() const noexcept
 {
     auto citer = cbegin();
-    IOX_EXPECTS(isValidElementIdx(citer.m_iterListNodeIdx) && "Invalid list element");
+    IOX_EXPECTS_WITH_MSG(isValidElementIdx(citer.m_iterListNodeIdx), "Invalid list element");
     return *citer;
 }
 
@@ -556,7 +556,7 @@ inline void forward_list<T, Capacity>::setNextIdx(const size_type idx, const siz
 template <typename T, uint64_t Capacity>
 inline const T* forward_list<T, Capacity>::getDataPtrFromIdx(const size_type idx) const noexcept
 {
-    IOX_EXPECTS(isValidElementIdx(idx) && "Invalid list element");
+    IOX_EXPECTS_WITH_MSG(isValidElementIdx(idx), "Invalid list element");
 
     // safe since m_data entries are aligned to T
     // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
@@ -597,14 +597,14 @@ inline bool forward_list<T, Capacity>::isInvalidIterator(const const_iterator& i
 {
     // iterator's member m_iterListNodeIdx and nextIndex are not checked here to be <= END_INDEX as this
     // should (can) never happen though normal list operations.
-    IOX_EXPECTS(!isInvalidElement(iter.m_iterListNodeIdx) && "invalidated iterator");
+    IOX_EXPECTS_WITH_MSG(!isInvalidElement(iter.m_iterListNodeIdx), "invalidated iterator");
     return false;
 }
 
 template <typename T, uint64_t Capacity>
 inline bool forward_list<T, Capacity>::isInvalidIterOrDifferentLists(const const_iterator& iter) const noexcept
 {
-    IOX_EXPECTS((this == iter.m_list) && "iterator of other list can't be used");
+    IOX_EXPECTS_WITH_MSG((this == iter.m_list), "iterator of other list can't be used");
     return isInvalidIterator(iter);
 }
 

diff --git a/...oryx_dust/posix_wrapper/message_queue.hpp → ...x/ipc/include/iox/posix/message_queue.hpp b/...oryx_dust/posix_wrapper/message_queue.hpp → ...x/ipc/include/iox/posix/message_queue.hpp
@@ -15,8 +15,9 @@
 // limitations under the License.
 //
 // SPDX-License-Identifier: Apache-2.0
-#ifndef IOX_DUST_POSIX_WRAPPER_MESSAGE_QUEUE_HPP
-#define IOX_DUST_POSIX_WRAPPER_MESSAGE_QUEUE_HPP
+
+#ifndef IOX_DUST_POSIX_IPC_MESSAGE_QUEUE_HPP
+#define IOX_DUST_POSIX_IPC_MESSAGE_QUEUE_HPP
 
 #include "iceoryx_hoofs/internal/posix_wrapper/ipc_channel.hpp"
 #include "iceoryx_platform/fcntl.hpp"
@@ -149,4 +150,4 @@ class MessageQueueBuilder
 } // namespace posix
 } // namespace iox
 
-#endif // IOX_DUST_POSIX_WRAPPER_MESSAGE_QUEUE_HPP
+#endif // IOX_DUST_POSIX_IPC_MESSAGE_QUEUE_HPP
diff --git a/...iceoryx_dust/posix_wrapper/named_pipe.hpp → ...osix/ipc/include/iox/posix/named_pipe.hpp b/...iceoryx_dust/posix_wrapper/named_pipe.hpp → ...osix/ipc/include/iox/posix/named_pipe.hpp
@@ -14,8 +14,9 @@
 // limitations under the License.
 //
 // SPDX-License-Identifier: Apache-2.0
-#ifndef IOX_DUST_POSIX_WRAPPER_NAMED_PIPE_HPP
-#define IOX_DUST_POSIX_WRAPPER_NAMED_PIPE_HPP
+
+#ifndef IOX_DUST_POSIX_IPC_NAMED_PIPE_HPP
+#define IOX_DUST_POSIX_IPC_NAMED_PIPE_HPP
 
 #include "iceoryx_hoofs/concurrent/lockfree_queue.hpp"
 #include "iceoryx_hoofs/internal/posix_wrapper/ipc_channel.hpp"
@@ -177,4 +178,4 @@ class NamedPipeBuilder
 } // namespace posix
 } // namespace iox
 
-#endif
+#endif // IOX_DUST_POSIX_IPC_NAMED_PIPE_HPP
diff --git a/...st/source/posix_wrapper/message_queue.cpp → ...x_dust/posix/ipc/source/message_queue.cpp b/...st/source/posix_wrapper/message_queue.cpp → ...x_dust/posix/ipc/source/message_queue.cpp
@@ -16,7 +16,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_dust/posix_wrapper/message_queue.hpp"
+#include "iox/posix/message_queue.hpp"
 #include "iceoryx_hoofs/posix_wrapper/posix_call.hpp"
 #include "iceoryx_platform/fcntl.hpp"
 #include "iceoryx_platform/platform_correction.hpp"

diff --git a/..._dust/source/posix_wrapper/named_pipe.cpp → iceoryx_dust/posix/ipc/source/named_pipe.cpp b/..._dust/source/posix_wrapper/named_pipe.cpp → iceoryx_dust/posix/ipc/source/named_pipe.cpp
@@ -15,7 +15,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_dust/posix_wrapper/named_pipe.hpp"
+#include "iox/posix/named_pipe.hpp"
 #include "iox/bump_allocator.hpp"
 #include "iox/deadline_timer.hpp"
 #include "iox/filesystem.hpp"

diff --git a/...ryx_dust/posix_wrapper/signal_watcher.hpp → ...sync/include/iox/posix/signal_watcher.hpp b/...ryx_dust/posix_wrapper/signal_watcher.hpp → ...sync/include/iox/posix/signal_watcher.hpp
@@ -13,8 +13,9 @@
 // limitations under the License.
 //
 // SPDX-License-Identifier: Apache-2.0
-#ifndef IOX_DUST_POSIX_WRAPPER_SIGNAL_WATCHER_HPP
-#define IOX_DUST_POSIX_WRAPPER_SIGNAL_WATCHER_HPP
+
+#ifndef IOX_DUST_POSIX_SYNC_SIGNAL_WATCHER_HPP
+#define IOX_DUST_POSIX_SYNC_SIGNAL_WATCHER_HPP
 
 #include "iceoryx_hoofs/posix_wrapper/signal_handler.hpp"
 #include "iceoryx_hoofs/posix_wrapper/unnamed_semaphore.hpp"
@@ -85,4 +86,4 @@ bool hasTerminationRequested() noexcept;
 } // namespace posix
 } // namespace iox
 
-#endif
+#endif // IOX_DUST_POSIX_SYNC_SIGNAL_WATCHER_HPP
diff --git a/...t/source/posix_wrapper/signal_watcher.cpp → ...dust/posix/sync/source/signal_watcher.cpp b/...t/source/posix_wrapper/signal_watcher.cpp → ...dust/posix/sync/source/signal_watcher.cpp
@@ -13,7 +13,8 @@
 // limitations under the License.
 //
 // SPDX-License-Identifier: Apache-2.0
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
+
+#include "iox/posix/signal_watcher.hpp"
 #include "iceoryx_platform/unistd.hpp"
 
 namespace iox

diff --git a/...moduletests/test_posix_signal_watcher.cpp → ...etests/test_posix_sync_signal_watcher.cpp b/...moduletests/test_posix_signal_watcher.cpp → ...etests/test_posix_sync_signal_watcher.cpp
@@ -14,9 +14,9 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_hoofs/testing/barrier.hpp"
 #include "iceoryx_hoofs/testing/watch_dog.hpp"
+#include "iox/posix/signal_watcher.hpp"
 #include "test.hpp"
 #include <atomic>
 

diff --git a/iceoryx_examples/callbacks/ice_callbacks_listener_as_class_member.cpp b/iceoryx_examples/callbacks/ice_callbacks_listener_as_class_member.cpp
@@ -14,12 +14,12 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/popo/listener.hpp"
 #include "iceoryx_posh/popo/subscriber.hpp"
 #include "iceoryx_posh/popo/user_trigger.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
 #include "iox/optional.hpp"
+#include "iox/posix/signal_watcher.hpp"
 #include "topic_data.hpp"
 
 #include <chrono>

diff --git a/iceoryx_examples/callbacks/ice_callbacks_publisher.cpp b/iceoryx_examples/callbacks/ice_callbacks_publisher.cpp
@@ -14,9 +14,9 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/popo/publisher.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
+#include "iox/posix/signal_watcher.hpp"
 #include "topic_data.hpp"
 
 #include <chrono>

diff --git a/iceoryx_examples/callbacks/ice_callbacks_subscriber.cpp b/iceoryx_examples/callbacks/ice_callbacks_subscriber.cpp
@@ -14,12 +14,12 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/popo/listener.hpp"
 #include "iceoryx_posh/popo/subscriber.hpp"
 #include "iceoryx_posh/popo/user_trigger.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
 #include "iox/optional.hpp"
+#include "iox/posix/signal_watcher.hpp"
 #include "topic_data.hpp"
 
 #include <chrono>

diff --git a/iceoryx_examples/complexdata/iox_publisher_complexdata.cpp b/iceoryx_examples/complexdata/iox_publisher_complexdata.cpp
@@ -16,9 +16,9 @@
 
 #include "topic_data.hpp"
 
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/popo/publisher.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
+#include "iox/posix/signal_watcher.hpp"
 
 constexpr char APP_NAME[] = "iox-cpp-publisher-complexdata";
 

diff --git a/iceoryx_examples/complexdata/iox_publisher_vector.cpp b/iceoryx_examples/complexdata/iox_publisher_vector.cpp
@@ -16,9 +16,9 @@
 
 #include "iox/vector.hpp"
 
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/popo/publisher.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
+#include "iox/posix/signal_watcher.hpp"
 
 constexpr char APP_NAME[] = "iox-cpp-publisher-vector";
 

diff --git a/iceoryx_examples/complexdata/iox_subscriber_complexdata.cpp b/iceoryx_examples/complexdata/iox_subscriber_complexdata.cpp
@@ -16,9 +16,9 @@
 
 #include "topic_data.hpp"
 
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/popo/subscriber.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
+#include "iox/posix/signal_watcher.hpp"
 #include "iox/string.hpp"
 
 constexpr char APP_NAME[] = "iox-cpp-subscriber-complexdata";

diff --git a/iceoryx_examples/complexdata/iox_subscriber_vector.cpp b/iceoryx_examples/complexdata/iox_subscriber_vector.cpp
@@ -14,9 +14,9 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/popo/subscriber.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
+#include "iox/posix/signal_watcher.hpp"
 #include "iox/string.hpp"
 #include "iox/vector.hpp"
 

diff --git a/iceoryx_examples/ice_access_control/iox_display_app.cpp b/iceoryx_examples/ice_access_control/iox_display_app.cpp
@@ -16,10 +16,10 @@
 
 #include "topic_data.hpp"
 
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/popo/publisher.hpp"
 #include "iceoryx_posh/popo/subscriber.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
+#include "iox/posix/signal_watcher.hpp"
 
 #include <iostream>
 

diff --git a/iceoryx_examples/ice_access_control/iox_radar_app.cpp b/iceoryx_examples/ice_access_control/iox_radar_app.cpp
@@ -16,9 +16,9 @@
 
 #include "topic_data.hpp"
 
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/popo/publisher.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
+#include "iox/posix/signal_watcher.hpp"
 
 #include <iostream>
 

diff --git a/iceoryx_examples/icedelivery/iox_publisher.cpp b/iceoryx_examples/icedelivery/iox_publisher.cpp
@@ -20,8 +20,8 @@
 //! [include publisher]
 #include "iceoryx_posh/popo/publisher.hpp"
 //! [include publisher]
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
+#include "iox/posix/signal_watcher.hpp"
 
 #include <iostream>
 

diff --git a/iceoryx_examples/icedelivery/iox_publisher_untyped.cpp b/iceoryx_examples/icedelivery/iox_publisher_untyped.cpp
@@ -20,9 +20,9 @@
 //! [include topic data]
 
 //! [includes]
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/popo/untyped_publisher.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
+#include "iox/posix/signal_watcher.hpp"
 //! [includes]
 
 #include <iostream>

diff --git a/iceoryx_examples/icedelivery/iox_subscriber.cpp b/iceoryx_examples/icedelivery/iox_subscriber.cpp
@@ -20,8 +20,8 @@
 //! [include subscriber]
 #include "iceoryx_posh/popo/subscriber.hpp"
 //! [include subscriber]
-#include "iceoryx_dust/posix_wrapper/signal_watcher.hpp"
 #include "iceoryx_posh/runtime/posh_runtime.hpp"
+#include "iox/posix/signal_watcher.hpp"
 
 #include <iostream>