feat: add opt-in strict bool normalization (#315) (#319)

Signed-off-by: Mirko Morati <mirkomorati@gmail.com>

Author: mirkomorati

.github/workflows/reusable-ci.yml

@@ -68,10 +68,13 @@ jobs:
       matrix:
         cmake-build-type:
           - 'RelWithDebInfo'
+        strict-bool:
+          - false
+          - true
 
     steps:
     - name: Add ci-pending label if PR
-      if: ${{ github.event_name == 'pull_request' && inputs.add-label == true}}
+      if: ${{ github.event_name == 'pull_request' && inputs.add-label == true && matrix.strict-bool == false }}
       uses: eProsima/eProsima-CI/external/add_labels@v0
       with:
         labels: ci-pending
@@ -122,7 +125,7 @@ jobs:
         colcon_meta_file: ${{ github.workspace }}/src/fastcdr/.github/workflows/config/build.meta
         colcon_build_args: ${{ inputs.colcon-args }}
         colcon_build_args_default: --event-handlers=console_direct+
-        cmake_args: ${{ inputs.cmake-args }}
+        cmake_args: ${{ inputs.cmake-args }} ${{ matrix.strict-bool == true && '-DSTRICT_BOOL=ON' || '' }}
         cmake_args_default: ${{ env.colcon-build-default-cmake-args }} ${{ env.toolset }}
         cmake_build_type: ${{ matrix.cmake-build-type }}
         workspace: ${{ github.workspace }}
@@ -137,7 +140,7 @@ jobs:
         ctest_args: ${{ inputs.ctest-args }}
         packages_names: fastcdr
         workspace: ${{ github.workspace }}
-        test_report_artifact: ${{ inputs.label }}
+        test_report_artifact: ${{ inputs.label }}${{ matrix.strict-bool == true && '-strict-bool' || '' }}
 
     - name: Fast CDR Test summary
       uses: eProsima/eProsima-CI/multiplatform/junit_summary@v0
@@ -153,5 +156,5 @@ jobs:
       if: always()
       uses: eProsima/eProsima-CI/external/upload-artifact@v0
       with:
-        name: test-results-${{ inputs.label }}
+        name: test-results-${{ inputs.label }}${{ matrix.strict-bool == true && '-strict-bool' || '' }}
         path: log/latest_test/fastcdr

CMakeLists.txt

@@ -63,6 +63,11 @@ endif()
 # unless the library was explicitly added as a static library.
 option(BUILD_SHARED_LIBS "Create shared libraries by default" ON)
 
+###############################################################################
+# Strict bool
+###############################################################################
+option(STRICT_BOOL "Enforce bool values to 0/1 during serialization" OFF)
+
 ###############################################################################
 # Test system configuration
 ###############################################################################

include/fastcdr/Cdr.h

@@ -3007,6 +3007,16 @@ class Cdr
             std::wstring*& sequence_t,
             size_t& num_elements);
 
+    /*!
+     * @brief Serializes the canonical @c uint8_t representation of @p bool_t.
+     *
+     * When @c FASTCDR_STRICT_BOOL is defined the serialized value is guaranteed to be exactly @c 0 or @c 1.
+     *
+     * @param[in] bool_t The boolean value to serialize.
+     */
+    Cdr_DllAPI void serialize_bool(
+            bool bool_t);
+
     /*!
      * @brief This function template detects the content type of the STD container array and serializes the array.
      * @param array_t The array that will be serialized in the buffer.

include/fastcdr/FastCdr.h

@@ -2041,6 +2041,16 @@ class Cdr_DllAPI FastCdr
     FastCdr& deserialize_bool_sequence(
             std::vector<bool>& vector_t);
 
+    /*!
+     * @brief Serializes the canonical @c uint8_t representation of @p bool_t.
+     *
+     * When @c FASTCDR_STRICT_BOOL is defined the serialized value is guaranteed to be exactly @c 0 or @c 1.
+     *
+     * @param[in] bool_t The boolean value to serialize.
+     */
+    void serialize_bool(
+            bool bool_t);
+
     FastCdr& deserialize_string_sequence(
             std::string*& sequence_t,
             size_t& num_elements);

src/cpp/CMakeLists.txt

@@ -32,6 +32,7 @@ set(${PROJECT_NAME}_source_files
     exceptions/Exception.cpp
     exceptions/LockedExternalAccessException.cpp
     exceptions/NotEnoughMemoryException.cpp
+    helpers/memory_helpers.cpp
     FastCdr.rc
     )
 
@@ -57,6 +58,7 @@ set_target_properties(${PROJECT_NAME} PROPERTIES
 target_compile_definitions(${PROJECT_NAME}
     PRIVATE
     ${PROJECT_NAME_UPPER}_SOURCE
+    $<$<BOOL:${STRICT_BOOL}>:${PROJECT_NAME_UPPER}_STRICT_BOOL>
     INTERFACE
     $<$<BOOL:${WIN32}>:${PROJECT_NAME_UPPER}_NO_LIB>
     PUBLIC

src/cpp/Cdr.cpp

@@ -16,6 +16,7 @@
 #include <limits>
 
 #include <fastcdr/Cdr.h>
+#include "helpers/memory_helpers.hpp"
 
 namespace eprosima {
 namespace fastcdr {
@@ -821,14 +822,7 @@ Cdr& Cdr::serialize(
         // Save last datasize.
         last_data_size_ = sizeof(uint8_t);
 
-        if (bool_t)
-        {
-            offset_++ << static_cast<uint8_t>(1);
-        }
-        else
-        {
-            offset_++ << static_cast<uint8_t>(0);
-        }
+        serialize_bool(bool_t);
 
         return *this;
     }
@@ -929,13 +923,7 @@ Cdr& Cdr::serialize_array(
 
         for (size_t count = 0; count < num_elements; ++count)
         {
-            uint8_t value = 0;
-
-            if (bool_t[count])
-            {
-                value = 1;
-            }
-            offset_++ << value;
+            serialize_bool(bool_t[count]);
         }
 
         return *this;
@@ -2179,6 +2167,16 @@ Cdr& Cdr::operator <<(
     return *this;
 }
 
+inline void Cdr::serialize_bool(
+        bool bool_t)
+{
+#if FASTCDR_STRICT_BOOL
+    offset_++ <<  static_cast<uint8_t>(normalize_bool(bool_t));
+#else
+    offset_++ << (bool_t ? static_cast<uint8_t>(1) : static_cast<uint8_t>(0));
+#endif // if FASTCDR_STRICT_BOOL
+}
+
 Cdr& Cdr::serialize_bool_array(
         const std::vector<bool>& vector_t)
 {
@@ -2193,14 +2191,7 @@ Cdr& Cdr::serialize_bool_array(
 
         for (size_t count = 0; count < vector_t.size(); ++count)
         {
-            uint8_t value = 0;
-            std::vector<bool>::const_reference ref = vector_t[count];
-
-            if (ref)
-            {
-                value = 1;
-            }
-            offset_++ << value;
+            serialize_bool(vector_t[count]);
         }
     }
     else
@@ -2233,14 +2224,7 @@ Cdr& Cdr::serialize_bool_sequence(
 
         for (size_t count = 0; count < vector_t.size(); ++count)
         {
-            uint8_t value = 0;
-            std::vector<bool>::const_reference ref = vector_t[count];
-
-            if (ref)
-            {
-                value = 1;
-            }
-            offset_++ << value;
+            serialize_bool(vector_t[count]);
         }
     }
     else

src/cpp/FastCdr.cpp

@@ -15,6 +15,7 @@
 #include <fastcdr/FastCdr.h>
 #include <fastcdr/exceptions/BadParamException.h>
 #include <string.h>
+#include "helpers/memory_helpers.hpp"
 
 using namespace eprosima::fastcdr;
 using namespace ::exception;
@@ -90,15 +91,9 @@ bool FastCdr::resize(
 FastCdr& FastCdr::serialize(
         const bool bool_t)
 {
-    uint8_t value = 0;
-
     if (((last_position_ - current_position_) >= sizeof(uint8_t)) || resize(sizeof(uint8_t)))
     {
-        if (bool_t)
-        {
-            value = 1;
-        }
-        current_position_++ << value;
+        serialize_bool(bool_t);
 
         return *this;
     }
@@ -190,13 +185,7 @@ FastCdr& FastCdr::serialize_array(
     {
         for (size_t count = 0; count < num_elements; ++count)
         {
-            uint8_t value = 0;
-
-            if (bool_t[count])
-            {
-                value = 1;
-            }
-            current_position_++ << value;
+            serialize_bool(bool_t[count]);
         }
 
         return *this;
@@ -691,6 +680,16 @@ FastCdr& FastCdr::deserialize_array(
     throw NotEnoughMemoryException(NotEnoughMemoryException::NOT_ENOUGH_MEMORY_MESSAGE_DEFAULT);
 }
 
+inline void FastCdr::serialize_bool(
+        bool bool_t)
+{
+#if FASTCDR_STRICT_BOOL
+    current_position_++ << static_cast<uint8_t>(normalize_bool(bool_t));
+#else
+    current_position_++ << (bool_t ? static_cast<uint8_t>(1) : static_cast<uint8_t>(0));
+#endif // if FASTCDR_STRICT_BOOL
+}
+
 FastCdr& FastCdr::serialize_bool_sequence(
         const std::vector<bool>& vector_t)
 {
@@ -704,14 +703,7 @@ FastCdr& FastCdr::serialize_bool_sequence(
     {
         for (size_t count = 0; count < vector_t.size(); ++count)
         {
-            uint8_t value = 0;
-            std::vector<bool>::const_reference ref = vector_t[count];
-
-            if (ref)
-            {
-                value = 1;
-            }
-            current_position_++ << value;
+            serialize_bool(vector_t[count]);
         }
     }
     else

src/cpp/helpers/memory_helpers.cpp

@@ -0,0 +1,25 @@
+// Copyright 2026 Proyectos y Sistemas de Mantenimiento SL (eProsima).
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "memory_helpers.hpp"
+
+namespace {
+void const volatile* volatile global_force_escape_pointer;
+} // namespace
+
+void eprosima::fastcdr::internal::use_char_pointer(
+        char const volatile *const v)
+{
+    global_force_escape_pointer = reinterpret_cast<void const volatile*>(v);
+}