Extend LARGE_DATA configuration options (#4444)

* Refs #20493: Add Builtin config options Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Overload of RTPS API Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Update old methods with options parameter Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Overload of DomainParticipantQos API Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Make builtin-options const Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Add Env.var. parser Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Increase maximum msg_size of TCP Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Add blackbox tests Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Add Participant unittests Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Add units parser to utils Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Update xsd shcema Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Update XML parser with attributes and new format Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Update XML Tests Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Add xml tests to blackbox tests Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: change to_uppercase() method to fix windows build Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Uncrustify Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Update transport initialization with max_msg_size_no_frag Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Update QosPolicies to include max_msg_no_frag Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Correct and add Env.var tests Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Improve doxygen and use XML::ERROR type Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Uncrustify and try to fix windows again Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: fix doxygen Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Use int in toupper and move includes Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: tcp_negotiation_timeout in BuiltinTransportOptions Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Timeout in Env.var. Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Timeout in XML Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Tests for timeout and improvements Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Uncrustify Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Update XML schema to accept mode in complex type Signed-off-by: JesusPoderoso <[email protected]> * Refs #20493: Update test XML according to XSD update Signed-off-by: JesusPoderoso <[email protected]> * Refs #20493: Update unit test XML snippets according to XSD update Signed-off-by: JesusPoderoso <[email protected]> * Refs #20493: Update XMLParser to accept new schema Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Apply suggestions Signed-off-by: cferreiragonz <[email protected]> * Refs #20493: Abort use of std::toupper() Signed-off-by: cferreiragonz <[email protected]> --------- Signed-off-by: cferreiragonz <[email protected]> Signed-off-by: JesusPoderoso <[email protected]> Co-authored-by: JesusPoderoso <[email protected]>
eProsima · Mar 7, 2024 · 28ba14d · 28ba14d
1 parent f515668
commit 28ba14d
Show file tree

Hide file tree

Showing 44 changed files with 1,288 additions and 118 deletions.
diff --git a/include/fastdds/dds/core/policy/QosPolicies.hpp b/include/fastdds/dds/core/policy/QosPolicies.hpp
@@ -2747,6 +2747,7 @@ class TransportConfigQos : public QosPolicy
         , use_builtin_transports(true)
         , send_socket_buffer_size(0)
         , listen_socket_buffer_size(0)
+        , max_msg_size_no_frag(0)
     {
     }
 
@@ -2763,6 +2764,7 @@ class TransportConfigQos : public QosPolicy
                (this->send_socket_buffer_size == b.send_socket_buffer_size) &&
                (this->listen_socket_buffer_size == b.listen_socket_buffer_size) &&
                (this->builtin_transports_reception_threads_ == b.builtin_transports_reception_threads_) &&
+               (this->max_msg_size_no_frag == b.max_msg_size_no_frag) &&
                QosPolicy::operator ==(b);
     }
 
@@ -2791,6 +2793,12 @@ class TransportConfigQos : public QosPolicy
 
     //! Thread settings for the builtin transports reception threads
     rtps::ThreadSettings builtin_transports_reception_threads_;
+
+    /*! Maximum message size used to avoid fragmentation, set ONLY in LARGE_DATA. If this value is
+     * not zero, the network factory will allow the initialization of UDP transports with maxMessageSize
+     * higher than 65500K.
+     */
+    uint32_t max_msg_size_no_frag;
 };
 
 //! Qos Policy to configure the endpoint

diff --git a/include/fastdds/dds/domain/qos/DomainParticipantQos.hpp b/include/fastdds/dds/domain/qos/DomainParticipantQos.hpp
@@ -350,12 +350,15 @@ class DomainParticipantQos
     }
 
     /**
-     * Provides a way of easily configuring transport related configuration on certain pre-defined scenarios.
+     * Provides a way of easily configuring transport related configuration on certain pre-defined scenarios with
+     * certain options.
      *
      * @param transports Defines the transport configuration scenario to setup.
+     * @param options Defines the options to be used in the transport configuration.
      */
     RTPS_DllAPI void setup_transports(
-            rtps::BuiltinTransports transports);
+            rtps::BuiltinTransports transports,
+            const rtps::BuiltinTransportsOptions& options = rtps::BuiltinTransportsOptions());
 
     /**
      * Setter for the builtin flow controllers sender threads ThreadSettings

diff --git a/include/fastdds/rtps/attributes/BuiltinTransports.hpp b/include/fastdds/rtps/attributes/BuiltinTransports.hpp
@@ -21,11 +21,84 @@
 
 #include <ostream>
 #include <cstdint>
+#include <fastdds/rtps/transport/TransportInterface.h>
+
+#include <fastrtps/fastrtps_dll.h>
 
 namespace eprosima {
 namespace fastdds {
 namespace rtps {
 
+
+/**
+ * @brief Options for configuring the built-in transports when using LARGE_DATA mode.
+ */
+struct RTPS_DllAPI BuiltinTransportsOptions
+{
+    //! Whether to use non-blocking send operation.
+    bool non_blocking_send = false;
+
+    /**
+     * @brief The maximum message size to be used.
+     *
+     * It specifies the maximum message size that will be used by the Network Factory
+     * to register every transport.
+     *
+     */
+    uint32_t maxMessageSize = fastdds::rtps::s_maximumMessageSize;
+
+    /**
+     * @brief The value used to configure the send and receive fuffer sizes of the sockets.
+     *
+     * It specifies the value that will be used to configure the send and receive buffer sizes of the sockets
+     * used by the transports created with the builtin transports.
+     * Zero value indicates to use default system buffer size.
+     *
+     */
+    uint32_t sockets_buffer_size = 0;
+
+    /**
+     * @brief Time to wait for logical port negotiation (ms).
+     *
+     * It specifies the value that will be used to configure the honomym attribute of the TCPTransportDescriptor used.
+     * It only takes effect if the LARGE_DATA mode is used.
+     * Zero value means no waiting (default).
+     *
+     */
+    uint32_t tcp_negotiation_timeout = 0;
+};
+
+/**
+ * @brief Equal to operator.
+ *
+ * @param bto1 Left hand side BuiltinTransportsOptions being compared.
+ * @param bto2 Right hand side BuiltinTransportsOptions being compared.
+ * @return true if \c bto1 is equal to  \c bto2.
+ * @return false otherwise.
+ */
+inline bool operator ==(
+        const BuiltinTransportsOptions& bto1,
+        const BuiltinTransportsOptions& bto2)
+{
+    if (bto1.non_blocking_send != bto2.non_blocking_send)
+    {
+        return false;
+    }
+    if (bto1.maxMessageSize != bto2.maxMessageSize)
+    {
+        return false;
+    }
+    if (bto1.sockets_buffer_size != bto2.sockets_buffer_size)
+    {
+        return false;
+    }
+    if (bto1.tcp_negotiation_timeout != bto2.tcp_negotiation_timeout)
+    {
+        return false;
+    }
+    return true;
+}
+
 /**
  * Defines the kind of transports automatically instantiated upon the creation of a participant
  */

diff --git a/include/fastdds/rtps/attributes/RTPSParticipantAttributes.h b/include/fastdds/rtps/attributes/RTPSParticipantAttributes.h
@@ -487,12 +487,15 @@ class RTPSParticipantAttributes
     }
 
     /**
-     * Provides a way of easily configuring transport related configuration on certain pre-defined scenarios.
+     * Provides a way of easily configuring transport related configuration on certain pre-defined scenarios with
+     * certain options.
      *
      * @param transports Defines the transport configuration scenario to setup.
+     * @param options Defines the options to be used in the transport configuration.
      */
     RTPS_DllAPI void setup_transports(
-            fastdds::rtps::BuiltinTransports transports);
+            fastdds::rtps::BuiltinTransports transports,
+            const fastdds::rtps::BuiltinTransportsOptions& options = fastdds::rtps::BuiltinTransportsOptions());
 
     /**
      * Default list of Unicast Locators to be used for any Endpoint defined inside this RTPSParticipant in the case
@@ -600,6 +603,12 @@ class RTPSParticipantAttributes
     fastdds::rtps::ThreadSettings security_log_thread;
 #endif // if HAVE_SECURITY
 
+    /*! Maximum message size used to avoid fragmentation, set ONLY in LARGE_DATA. If this value is
+     * not zero, the network factory will allow the initialization of UDP transports with maxMessageSize
+     * higher than 65500K.
+     */
+    uint32_t max_msg_size_no_frag = 0;
+
 private:
 
     //! Name of the participant.

diff --git a/include/fastdds/rtps/transport/ChainingTransport.h b/include/fastdds/rtps/transport/ChainingTransport.h
@@ -70,12 +70,14 @@ class ChainingTransport : public TransportInterface
     /*!
      * Initialize the low-level transport. This method will prepare all the internals of the transport.
      * @param properties Optional policy to specify additional parameters of the created transport.
+     * @param max_msg_size_no_frag Optional maximum message size to avoid 65500 KB fragmentation limit.
      * @return True when the transport was correctly initialized.
      */
     RTPS_DllAPI bool init(
-            const fastrtps::rtps::PropertyPolicy* properties = nullptr) override
+            const fastrtps::rtps::PropertyPolicy* properties = nullptr,
+            const uint32_t& max_msg_size_no_frag = 0) override
     {
-        return low_level_transport_->init(properties);
+        return low_level_transport_->init(properties, max_msg_size_no_frag);
     }
 
     /*!

diff --git a/include/fastdds/rtps/transport/TransportInterface.h b/include/fastdds/rtps/transport/TransportInterface.h
@@ -86,10 +86,12 @@ class RTPS_DllAPI TransportInterface
     /**
      * Initialize this transport. This method will prepare all the internals of the transport.
      * @param properties Optional policy to specify additional parameters of the created transport.
+     * @param max_msg_size_no_frag Optional maximum message size to avoid 65500 KB fragmentation limit.
      * @return True when the transport was correctly initialized.
      */
     virtual bool init(
-            const fastrtps::rtps::PropertyPolicy* properties = nullptr) = 0;
+            const fastrtps::rtps::PropertyPolicy* properties = nullptr,
+            const uint32_t& max_msg_size_no_frag = 0) = 0;
 
     /**
      * Must report whether the input channel associated to this locator is open. Channels must either be

diff --git a/include/fastrtps/utils/UnitsParser.hpp b/include/fastrtps/utils/UnitsParser.hpp
@@ -0,0 +1,52 @@
+// Copyright 2024 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.
+
+/**
+ * @file UnitsParser.hpp
+ */
+
+#ifndef _FASTDDS_UTILS_UNITS_PARSER_HPP_
+#define _FASTDDS_UTILS_UNITS_PARSER_HPP_
+
+#include <string>
+
+namespace eprosima {
+namespace fastdds {
+namespace dds {
+namespace utils {
+
+/**
+ * Converts the string to uppercase.
+ *
+ * @param[in] st String to convert
+ */
+inline void to_uppercase(
+        std::string& st) noexcept;
+
+/**
+ * Converts a numeric value with units to bytes.
+ *
+ * @param[in] value Numeric value to convert
+ * @param[in] units Units to use for the conversion
+ * @return The value in bytes
+ */
+uint32_t parse_value_and_units(
+        std::string& value,
+        std::string units);
+
+} /* namespace utils */
+} /* namespace dds */
+} /* namespace fastdds */
+} /* namespace eprosima */
+#endif /* _FASTDDS_UTILS_UNITS_PARSER_HPP_ */
diff --git a/include/fastrtps/xmlparser/XMLParser.h b/include/fastrtps/xmlparser/XMLParser.h
@@ -673,6 +673,7 @@ class XMLParser
     RTPS_DllAPI static XMLP_ret getXMLBuiltinTransports(
             tinyxml2::XMLElement* elem,
             eprosima::fastdds::rtps::BuiltinTransports* bt,
+            eprosima::fastdds::rtps::BuiltinTransportsOptions* bt_opts,
             uint8_t ident);
 };
 

diff --git a/include/fastrtps/xmlparser/XMLParserCommon.h b/include/fastrtps/xmlparser/XMLParserCommon.h
@@ -139,6 +139,9 @@ extern const char* THROUGHPUT_CONT;
 extern const char* USER_TRANS;
 extern const char* USE_BUILTIN_TRANS;
 extern const char* BUILTIN_TRANS;
+extern const char* MAX_MSG_SIZE_LARGE_DATA;
+extern const char* SOCKETS_SIZE_LARGE_DATA;
+extern const char* NON_BLOCKING_LARGE_DATA;
 extern const char* PROPERTIES_POLICY;
 extern const char* NAME;
 extern const char* REMOTE_LOCATORS;

diff --git a/resources/xsd/fastRTPS_profiles.xsd b/resources/xsd/fastRTPS_profiles.xsd
@@ -129,7 +129,7 @@
             ├ userTransports                       [0~1],
             |   └ transport_id                     [1~*] [string],
             ├ useBuiltinTransports                 [bool],
-            ├ builtinTransports                    [0~1][string]
+            ├ builtinTransports                    [0~1],
             ├ propertiesPolicy                     [0~1],
             ├ allocation                           [0~1],
             ├ userData                             [0~1],
@@ -164,20 +164,7 @@
                             </xs:complexType>
                         </xs:element>
                         <xs:element name="useBuiltinTransports" type="boolean" minOccurs="0" maxOccurs="1"/>
-                        <xs:element name="builtinTransports" minOccurs="0" maxOccurs="1">
-                            <xs:simpleType>
-                                <xs:restriction base="xs:string">
-                                    <xs:enumeration value="NONE"/>
-                                    <xs:enumeration value="DEFAULT"/>
-                                    <xs:enumeration value="DEFAULTv6"/>
-                                    <xs:enumeration value="SHM"/>
-                                    <xs:enumeration value="UDPv4"/>
-                                    <xs:enumeration value="UDPv6"/>
-                                    <xs:enumeration value="LARGE_DATA"/>
-                                    <xs:enumeration value="LARGE_DATAv6"/>
-                                </xs:restriction>
-                            </xs:simpleType>
-                        </xs:element>
+                        <xs:element name="builtinTransports" type="builtinTransportsType" minOccurs="0" maxOccurs="1"/>
                         <xs:element name="propertiesPolicy" type="propertyPolicyType" minOccurs="0" maxOccurs="1"/>
                         <xs:element name="allocation" type="rtpsParticipantAllocationAttributesType"  minOccurs="0" maxOccurs="1"/>
                         <xs:element name="userData" type="octectVectorQosPolicyType" minOccurs="0" maxOccurs="1"/>
@@ -195,6 +182,25 @@
         <xs:attribute name="is_default_profile" type="boolean" use="optional"/>
     </xs:complexType>
 
+    <!--Builtin Transports Enum Type:
+        | ╠ att. max_msg_size             [string],
+        | ╠ att. sockets_size             [string],
+        | ╠ att. non_blocking             [string],
+        | ╚ att. tcp_negotiation_timeout  [string]
+        |
+        └ (raw_data)                      [string]-->
+
+    <xs:complexType name="builtinTransportsType">
+        <xs:simpleContent>
+            <xs:extension base="builtinTransportKind">
+                <xs:attribute name="max_msg_size" type="string" use="optional"/>
+                <xs:attribute name="sockets_size" type="string" use="optional"/>
+                <xs:attribute name="non_blocking" type="boolean" use="optional"/>
+                <xs:attribute name="tcp_negotiation_timeout" type="uint32" use="optional"/>
+            </xs:extension>
+        </xs:simpleContent>
+    </xs:complexType>
+
     <!--Data writer / publisher:
         | ╠ att. profile_name       [string] REQ,
         | ╚ att. is_default_profile [bool],
@@ -1797,6 +1803,22 @@
     </xs:complexType>
 
 
+    <!--Builtin Transport Kind list Type:
+        └ builtinTransport  [1]-->
+    <xs:simpleType name="builtinTransportKind">
+        <xs:restriction base="xs:string">
+            <xs:enumeration value="NONE" />
+            <xs:enumeration value="DEFAULT" />
+            <xs:enumeration value="DEFAULTv6" />
+            <xs:enumeration value="SHM" />
+            <xs:enumeration value="UDPv4" />
+            <xs:enumeration value="UDPv6" />
+            <xs:enumeration value="LARGE_DATA" />
+            <xs:enumeration value="LARGE_DATAv6" />
+        </xs:restriction>
+    </xs:simpleType>
+
+
     <!--| PRIMITIVE TYPES DEFINITION |-->
     <!--Primitive Types from Fast DDS docs-->
     <xs:simpleType name="primitiveTypes">

diff --git a/src/cpp/CMakeLists.txt b/src/cpp/CMakeLists.txt
@@ -239,6 +239,7 @@ set(${PROJECT_NAME}_source_files
     utils/SystemInfo.cpp
     utils/TimedConditionVariable.cpp
     utils/string_convert.cpp
+    utils/UnitsParser.cpp
 
     dds/core/types.cpp
     dds/core/Exception.cpp

diff --git a/src/cpp/fastdds/domain/qos/DomainParticipantQos.cpp b/src/cpp/fastdds/domain/qos/DomainParticipantQos.cpp
@@ -30,12 +30,13 @@ namespace dds {
 const DomainParticipantQos PARTICIPANT_QOS_DEFAULT;
 
 void DomainParticipantQos::setup_transports(
-        rtps::BuiltinTransports transports)
+        rtps::BuiltinTransports transports,
+        const rtps::BuiltinTransportsOptions& options)
 {
     fastrtps::rtps::RTPSParticipantAttributes attr;
     utils::set_attributes_from_qos(attr, *this);
 
-    attr.setup_transports(transports);
+    attr.setup_transports(transports, options);
 
     utils::set_qos_from_attributes(*this, attr);
 }

diff --git a/src/cpp/fastdds/utils/QosConverters.cpp b/src/cpp/fastdds/utils/QosConverters.cpp
@@ -154,6 +154,7 @@ void set_qos_from_attributes(
     qos.transport().use_builtin_transports = attr.useBuiltinTransports;
     qos.transport().send_socket_buffer_size = attr.sendSocketBufferSize;
     qos.transport().listen_socket_buffer_size = attr.listenSocketBufferSize;
+    qos.transport().max_msg_size_no_frag = attr.max_msg_size_no_frag;
     qos.name() = attr.getName();
     qos.flow_controllers() = attr.flow_controllers;
     qos.builtin_controllers_sender_thread() = attr.builtin_controllers_sender_thread;
@@ -200,6 +201,7 @@ void set_attributes_from_qos(
     attr.useBuiltinTransports = qos.transport().use_builtin_transports;
     attr.sendSocketBufferSize = qos.transport().send_socket_buffer_size;
     attr.listenSocketBufferSize = qos.transport().listen_socket_buffer_size;
+    attr.max_msg_size_no_frag = qos.transport().max_msg_size_no_frag;
     attr.userData = qos.user_data().data_vec();
     attr.flow_controllers = qos.flow_controllers();
     attr.builtin_controllers_sender_thread = qos.builtin_controllers_sender_thread();