micro-ROS Rolling patch

* micro-ROS changes over dashing
  - Remove security directory (#2)
  - Remove test_security_directory test (#4)
  - Moving allocators init (#5)

* Avoid logging on build time based on RCutils flags (#6)

* Fix remapping (#7)

* Fix disabled logging (#8)

* Release micro-ROS Foxy (#9)
  - Add the RCL_COMMAND_LINE_ENABLED and RCL_LOGGING_ENABLED CMake options, both
    disabled by default
  - Leave the arguments, remapping and logging sources out of the build, along
    with rcl_yaml_param_parser and the logging implementation

* Updates 17092020
  - Guard the arguments check of rcl_node_options_copy()

* Add the micro-ROS fork update checker workflow

* Disable logger name (#11) (#13)

* Avoid uint64_t operation when handling context (#16) (#18)
  - Replace the atomic instance id storage by a plain uint32_t counter
  - Clean the id rollover check to avoid the invalid value instead of failing

* Update fork checker for Humble

* Update fork checker for Rolling

* Iron release (#19) (#20)

* Update micro-ROS conditional compilation
  - Replace both flags by a single RCL_MICROROS option, enabled by default, and
    the inverse RCL_MICROROS_COMPLETE_IMPL public definition
  - Ignore rcl_yaml_param_parser on the micro-ROS build (COLCON_IGNORE)

* Disable get_type_description service (#22)

* Remove type cache register methods (#23)
  - Exclude node_type_cache and the type hash emission from publishers,
    subscriptions, services, clients and action entities
  - Keep type_description_conversions and type_hash out of the build

* Address memory issue of type hash
  - Store the type hash in each entity implementation instead of querying the
    node type cache on finalization

* Fix tracetools
  - Export the tracetools dependency also on micro-ROS builds

* exclude rcl_validate_enclave_name and rcl_get_security_options_from_environment
  from micro-ROS (#24)

Dropped during the rebase as superseded by upstream:
* Remove security directory (#2)
* Remove test_security_directory test (#4)
* Moving allocators init (#5)

Co-authored-by: Pablo Garrido <pablogs9@gmail.com>
Co-authored-by: Julián Bermúdez Ortega <julianbermudez@eprosima.com>
Co-authored-by: acuadros95 <acuadros1995@gmail.com>
Co-authored-by: Antón Casas <antoncasas@eprosima.com>
Signed-off-by: David Laseca Perez <davidlaseca@eprosima.com>

Author: 5 people

.github/workflows/fork_checker.yml

@@ -0,0 +1,36 @@
+name: micro-ROS fork Update Checker
+on:
+  workflow_dispatch:
+    inputs:
+      name:
+        description: "Manual trigger"
+  schedule:
+    - cron:  '0 4 * * *'
+
+jobs:
+    micro_ros_fork_update_check:
+        runs-on: ubuntu-latest
+        container: ubuntu:20.04
+        strategy:
+          fail-fast: false
+          matrix:
+            branches: [humble, jazzy, kilted, lyrical, rolling]
+        steps:
+          - name: Check
+            id: check
+            shell: bash
+            run: |
+              apt update; apt install -y git
+              REPO=$(echo ${{ github.repository }} | awk '{split($0,a,"/"); print a[2]}')
+              git clone -b ${{ matrix.branches }} https://github.com/micro-ros/$REPO
+              cd $REPO
+              git remote add ros2 https://github.com/ros2/$REPO
+              git fetch ros2
+              git fetch origin
+              echo "::set-output name=merge_required::true"
+              CMP=$(git rev-list --left-right --count ros2/${{ matrix.branches }}...origin/${{ matrix.branches }} | awk '{print $1}')
+              if [ $CMP = "0" ]; then echo "::set-output name=merge_required::false"; fi
+
+          - name: Alert
+            if: ${{ steps.check.outputs.merge_required  == 'true' }}
+            run: exit 1

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "files.associations": {
+        "*.uml": "plantuml",
+        "service_event_publisher.h": "c"
+    }
+}

rcl/CMakeLists.txt

@@ -2,36 +2,43 @@ cmake_minimum_required(VERSION 3.20)
 
 project(rcl)
 
+option(RCL_MICROROS "micro-ROS build mode" ON)
+
 find_package(ament_cmake_ros REQUIRED)
 find_package(ament_cmake_ros_core REQUIRED)
 find_package(ament_cmake_gen_version_h REQUIRED)
 
-find_package(libyaml_vendor REQUIRED)
 find_package(rcl_interfaces REQUIRED)
 find_package(rcl_logging_interface REQUIRED)
-find_package(rcl_yaml_param_parser REQUIRED)
 find_package(rcutils REQUIRED)
 find_package(rmw REQUIRED)
 find_package(rmw_implementation REQUIRED)
 find_package(rosidl_runtime_c REQUIRED)
 find_package(service_msgs REQUIRED)
 find_package(tracetools REQUIRED)
 find_package(type_description_interfaces REQUIRED)
-find_package(yaml REQUIRED)
+
+if(NOT RCL_MICROROS)
+  find_package(libyaml_vendor REQUIRED)
+  find_package(yaml REQUIRED)
+  find_package(rcl_yaml_param_parser REQUIRED)
+endif()
 
 include(cmake/rcl_set_symbol_visibility_hidden.cmake)
 
-# Determine the logging implementation to use
-include(cmake/get_default_rcl_logging_implementation.cmake)
-get_default_rcl_logging_implementation(RCL_LOGGING_IMPL)
-message(STATUS "RCL_LOGGING_IMPLEMENTATION: ${RCL_LOGGING_IMPL}")
+if(NOT RCL_MICROROS)
+  # Determine the logging implementation to use
+  include(cmake/get_default_rcl_logging_implementation.cmake)
+  get_default_rcl_logging_implementation(RCL_LOGGING_IMPL)
+  message(STATUS "RCL_LOGGING_IMPLEMENTATION: ${RCL_LOGGING_IMPL}")
+endif()
 
 if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
   add_compile_options(-Wall -Wextra -Wpedantic)
 endif()
 
 set(${PROJECT_NAME}_sources
-  src/rcl/arguments.c
+  $<$<NOT:$<BOOL:${RCL_MICROROS}>>:src/rcl/arguments.c>
   src/rcl/client.c
   src/rcl/common.c
   src/rcl/context.c
@@ -47,13 +54,13 @@ set(${PROJECT_NAME}_sources
   src/rcl/init_options.c
   src/rcl/lexer.c
   src/rcl/lexer_lookahead.c
-  src/rcl/logging_rosout.c
-  src/rcl/logging.c
-  src/rcl/log_level.c
+  $<$<NOT:$<BOOL:${RCL_MICROROS}>>:src/rcl/logging_rosout.c>
+  $<$<NOT:$<BOOL:${RCL_MICROROS}>>:src/rcl/logging.c>
+  $<$<NOT:$<BOOL:${RCL_MICROROS}>>:src/rcl/log_level.c>
   src/rcl/network_flow_endpoints.c
   src/rcl/node.c
   src/rcl/node_options.c
-  src/rcl/node_type_cache.c
+  $<$<NOT:$<BOOL:${RCL_MICROROS}>>:src/rcl/node_type_cache.c>
   src/rcl/publisher.c
   src/rcl/remap.c
   src/rcl/node_resolve_name.c
@@ -65,7 +72,7 @@ set(${PROJECT_NAME}_sources
   src/rcl/time.c
   src/rcl/timer.c
   src/rcl/type_hash.c
-  src/rcl/type_description_conversions.c
+  $<$<NOT:$<BOOL:${RCL_MICROROS}>>:src/rcl/type_description_conversions.c>
   src/rcl/validate_enclave_name.c
   src/rcl/validate_topic_name.c
   src/rcl/wait.c
@@ -79,36 +86,62 @@ target_include_directories(${PROJECT_NAME} PUBLIC
 target_link_libraries(${PROJECT_NAME} PUBLIC
   ament_cmake_ros_core::ament_ros_defaults
   # TODO(clalancette): rcl_interfaces should be PRIVATE, but downstream depends on it for now
-  rcl_interfaces::rcl_interfaces
+  $<$<NOT:$<BOOL:${RCL_MICROROS}>>:rcl_interfaces::rcl_interfaces>
   # TODO(clalancette): rcl_logging_interface should be PRIVATE, but downstream depends on it for now
-  rcl_logging_interface::rcl_logging_interface
-  rcl_yaml_param_parser::rcl_yaml_param_parser
+  $<$<NOT:$<BOOL:${RCL_MICROROS}>>:rcl_logging_interface::rcl_logging_interface>
   rcutils::rcutils
   rmw::rmw
   # TODO(clalancette): rmw_implementation should be PRIVATE, but downstream depends on it for now
   rmw_implementation::rmw_implementation
   rosidl_runtime_c::rosidl_runtime_c
   type_description_interfaces::type_description_interfaces
 )
+
 target_link_libraries(${PROJECT_NAME} PRIVATE
-  service_msgs::service_msgs
   tracetools::tracetools
-  yaml
 )
 
-# Link logging implementation based on configuration
-if(RCL_LOGGING_IMPL STREQUAL "rcl_logging_implementation")
-  # Dynamic loading: use rcl_logging_implementation abstraction
+if(NOT RCL_MICROROS)
   target_link_libraries(${PROJECT_NAME} PRIVATE
-    rcl_logging_implementation::rcl_logging_implementation
+    service_msgs::service_msgs
+    yaml
   )
-else()
-  # Static linking: use specific logging implementation
-  target_link_libraries(${PROJECT_NAME} PRIVATE
-    ${RCL_LOGGING_IMPL}::${RCL_LOGGING_IMPL}
+endif()
+
+if(NOT RCL_MICROROS)
+  ament_target_dependencies(${PROJECT_NAME}
+    "rcl_yaml_param_parser"
+  )
+endif()
+
+if(NOT RCL_MICROROS)
+  ament_target_dependencies(${PROJECT_NAME}
+    ${RCL_LOGGING_IMPL}
   )
 endif()
 
+if(NOT RCL_MICROROS)
+target_compile_definitions(${PROJECT_NAME}
+  PUBLIC
+    RCL_MICROROS_COMPLETE_IMPL
+  )
+endif()
+
+if(NOT RCL_MICROROS)
+  # Link logging implementation based on configuration
+  if(RCL_LOGGING_IMPL STREQUAL "rcl_logging_implementation")
+    # Dynamic loading: use rcl_logging_implementation abstraction
+    target_link_libraries(${PROJECT_NAME} PRIVATE
+      rcl_logging_implementation::rcl_logging_implementation
+    )
+  else()
+    # Static linking: use specific logging implementation
+    target_link_libraries(${PROJECT_NAME} PRIVATE
+      ${RCL_LOGGING_IMPL}::${RCL_LOGGING_IMPL}
+    )
+  endif()
+endif()
+
 # Allow configuring the default discovery range
 if(DEFINED RCL_DEFAULT_DISCOVERY_RANGE)
 target_compile_definitions(${PROJECT_NAME} PRIVATE
@@ -145,14 +178,21 @@ ament_export_dependencies(ament_cmake_ros_core)
 ament_export_dependencies(rcl_interfaces)
 # TODO(clalancette): rcl_logging_interface shouldn't be exported, but downstream depends on it for now
 ament_export_dependencies(rcl_logging_interface)
-ament_export_dependencies(rcl_yaml_param_parser)
 ament_export_dependencies(rcutils)
 ament_export_dependencies(rmw)
 # TODO(clalancette): rmw_implementation shouldn't be exported, but downstream depends on it for now
 ament_export_dependencies(rmw_implementation)
 ament_export_dependencies(rosidl_runtime_c)
 ament_export_dependencies(type_description_interfaces)
-ament_generate_version_header(${PROJECT_NAME})
+ament_export_dependencies(tracetools)
+
+if(NOT RCL_MICROROS)
+  ament_export_dependencies(rcl_yaml_param_parser)
+endif()
+
+if(NOT RCL_MICROROS)
+  ament_export_dependencies(${RCL_LOGGING_IMPL})
+endif()
 
 if(BUILD_TESTING)
   find_package(ament_lint_auto REQUIRED)

rcl/include/rcl/arguments.h

@@ -22,7 +22,11 @@
 #include "rcl/macros.h"
 #include "rcl/types.h"
 #include "rcl/visibility_control.h"
+#ifdef RCL_MICROROS_COMPLETE_IMPL
 #include "rcl_yaml_param_parser/types.h"
+#else
+typedef struct rcl_params_s rcl_params_t;
+#endif  // RCL_MICROROS_COMPLETE_IMPL
 
 #ifdef __cplusplus
 extern "C"

rcl/include/rcl/context.h

@@ -28,7 +28,9 @@ extern "C"
 
 #include "rmw/init.h"
 
+#ifdef RCL_MICROROS_COMPLETE_IMPL
 #include "rcl/arguments.h"
+#endif  // RCL_MICROROS_COMPLETE_IMPL
 #include "rcl/init_options.h"
 #include "rcl/macros.h"
 #include "rcl/types.h"
@@ -115,21 +117,18 @@ typedef struct rcl_context_impl_s rcl_context_impl_t;
  */
 typedef struct rcl_context_s
 {
+#ifdef RCL_MICROROS_COMPLETE_IMPL
   /// Global arguments for all nodes which share this context.
   /** Typically generated by the parsing of argc/argv in rcl_init(). */
   rcl_arguments_t global_arguments;
+#endif  // RCL_MICROROS_COMPLETE_IMPL
 
   /// Implementation specific pointer.
   rcl_context_impl_t * impl;
 
   // The assumption that this is big enough for an atomic_uint_least64_t is
   // ensured with a static_assert in the context.c file.
   // In most cases it should just be a plain uint64_t.
-/// @cond Doxygen_Suppress
-#if !defined(RCL_CONTEXT_ATOMIC_INSTANCE_ID_STORAGE_SIZE)
-#define RCL_CONTEXT_ATOMIC_INSTANCE_ID_STORAGE_SIZE sizeof(uint_least64_t)
-#endif
-/// @endcond
   /// Private storage for instance ID atomic.
   /**
    * Accessing the instance id should be done using the function
@@ -149,7 +148,7 @@ typedef struct rcl_context_s
    * See this paper for an effort to make this possible in the future:
    *   http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2018/p0943r1.html
    */
-  RCL_ALIGNAS(8) uint8_t instance_id_storage[RCL_CONTEXT_ATOMIC_INSTANCE_ID_STORAGE_SIZE];
+  uint32_t instance_id_storage;
 } rcl_context_t;
 
 /// Return a zero initialization context object.

rcl/include/rcl/node.h

@@ -27,7 +27,9 @@ extern "C"
 #include <stdint.h>
 
 #include "rcl/allocator.h"
+#ifdef RCL_MICROROS_COMPLETE_IMPL
 #include "rcl/arguments.h"
+#endif  // RCL_MICROROS_COMPLETE_IMPL
 #include "rcl/context.h"
 #include "rcl/guard_condition.h"
 #include "rcl/macros.h"

rcl/include/rcl/node_options.h

@@ -25,7 +25,9 @@ extern "C"
 #include <stdbool.h>
 
 #include "rcl/allocator.h"
+#ifdef RCL_MICROROS_COMPLETE_IMPL
 #include "rcl/arguments.h"
+#endif  // RCL_MICROROS_COMPLETE_IMPL
 #include "rcl/domain_id.h"
 #include "rcl/macros.h"
 #include "rcl/types.h"
@@ -52,8 +54,10 @@ typedef struct rcl_node_options_s
   /// If false then only use arguments in this struct, otherwise use global arguments also.
   bool use_global_arguments;
 
+#ifdef RCL_MICROROS_COMPLETE_IMPL
   /// Command line arguments that apply only to this node.
   rcl_arguments_t arguments;
+#endif  // RCL_MICROROS_COMPLETE_IMPL
 
   /// Flag to enable rosout for this node
   bool enable_rosout;

rcl/include/rcl/timer.h

@@ -35,6 +35,11 @@ extern "C"
 #include "rcl/types.h"
 #include "rcl/visibility_control.h"
 
+// TEMPORARY (micro-ROS): ros2/rcl#1334 dropped this include, but downstream C code
+// (e.g. ros2/rclc rclc_parameter) still relies on getting rmw/qos_profiles.h through it.
+// Remove once rclc includes rmw/qos_profiles.h directly.
+#include "rmw/rmw.h"
+
 typedef struct rcl_timer_impl_s rcl_timer_impl_t;
 
 /// Structure which encapsulates a ROS Timer.

rcl/src/rcl/arguments_impl.h

@@ -20,7 +20,6 @@
 #include "rcl/allocator.h"
 #include "rcl/arguments.h"
 #include "rcl/log_level.h"
-#include "rcl_yaml_param_parser/types.h"
 #include "./remap_impl.h"
 
 #ifdef __cplusplus

rcl/src/rcl/client.c

@@ -26,7 +26,9 @@ extern "C"
 #include "rcl/allocator.h"
 #include "rcl/error_handling.h"
 #include "rcl/node.h"
+#ifdef RCL_MICROROS_COMPLETE_IMPL
 #include "rcl/node_type_cache.h"
+#endif  // RCL_MICROROS_COMPLETE_IMPL
 #include "rcl/publisher.h"
 #include "rcl/time.h"
 #include "rcl/types.h"
@@ -176,6 +178,7 @@ rcl_client_init(
   atomic_init(&client->impl->sequence_number, 0);
   client->impl->in_use_by_waitset = false;
 
+#ifdef RCL_MICROROS_COMPLETE_IMPL
   const rosidl_type_hash_t * hash = type_support->get_type_hash_func(type_support);
   if (hash == NULL) {
     RCL_SET_ERROR_MSG("Failed to get the type hash");
@@ -193,6 +196,7 @@ rcl_client_init(
     goto destroy_client;
   }
   client->impl->type_hash = *hash;
+#endif  // RCL_MICROROS_COMPLETE_IMPL
 
   RCUTILS_LOG_DEBUG_NAMED(ROS_PACKAGE_NAME, "Client initialized");
   TRACETOOLS_TRACEPOINT(
@@ -254,15 +258,15 @@ rcl_client_fini(rcl_client_t * client, rcl_node_t * node)
       RCL_SET_ERROR_MSG(rmw_get_error_string().str);
       result = RCL_RET_ERROR;
     }
-
+#ifdef RCL_MICROROS_COMPLETE_IMPL
     if (
       ROSIDL_TYPE_HASH_VERSION_UNSET != client->impl->type_hash.version &&
       RCL_RET_OK != rcl_node_type_cache_unregister_type(node, &client->impl->type_hash))
     {
       RCUTILS_SAFE_FWRITE_TO_STDERR(rcl_get_error_string().str);
       result = RCL_RET_ERROR;
     }
-
+#endif  // RCL_MICROROS_COMPLETE_IMPL
     allocator.deallocate(client->impl->remapped_service_name, allocator.state);
     client->impl->remapped_service_name = NULL;