Fix strict real-time in Flow Controller (#3735)

* Refs #13803. Fix realtime in flowcontroller Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #13803. Fix error Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #13803. Update realtime tests to DDS API Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #13803. Fix blocking lock when removing from flowcontroller Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #13803. Fix compilation without STRICT_REALTIME Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #19254. Fix bug in readers Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #19254. Document tests Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #19254. Improve doxygen documentation Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #19254. Fix bug in readers Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #19254. Fix warning on windows Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #19254. Apply suggestion Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #19254. Apply suggestion Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #19254. Apply suggestions Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #19254. Apply suggestions Signed-off-by: Ricardo González Moreno <[email protected]> --------- Signed-off-by: Ricardo González Moreno <[email protected]>
eProsima · Sep 13, 2023 · a575bbb · a575bbb
1 parent a8a4f42
commit a575bbb
Show file tree

Hide file tree

Showing 45 changed files with 1,414 additions and 704 deletions.
diff --git a/include/fastdds/rtps/history/History.h b/include/fastdds/rtps/history/History.h
@@ -145,6 +145,19 @@ class History
             const_iterator removal,
             bool release = true);
 
+    /**
+     * Remove a specific change from the history.
+     * No Thread Safe
+     * @param removal iterator to the CacheChange_t to remove.
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
+     * @param release defaults to true and hints if the CacheChange_t should return to the pool
+     * @return iterator to the next CacheChange_t or end iterator.
+     */
+    RTPS_DllAPI virtual iterator remove_change_nts(
+            const_iterator removal,
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time,
+            bool release = true);
+
     /**
      * Remove all changes from the History
      * @return True if everything was correctly removed.
@@ -159,6 +172,16 @@ class History
     RTPS_DllAPI bool remove_change(
             CacheChange_t* ch);
 
+    /**
+     * Remove a specific change from the history.
+     * @param ch Pointer to the CacheChange_t.
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
+     * @return True if removed.
+     */
+    RTPS_DllAPI bool remove_change(
+            CacheChange_t* ch,
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time);
+
     /**
      * Find a specific change in the history using the matches_change method criteria.
      * @param ch Pointer to the CacheChange_t to search for.

diff --git a/include/fastdds/rtps/history/ReaderHistory.h b/include/fastdds/rtps/history/ReaderHistory.h
@@ -156,6 +156,19 @@ class ReaderHistory : public History
             const_iterator removal,
             bool release = true) override;
 
+    /**
+     * Remove a specific change from the history.
+     * No Thread Safe
+     * @param removal iterator to the change for removal
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
+     * @param release specifies if the change must be returned to the pool
+     * @return iterator to the next change if any
+     */
+    RTPS_DllAPI iterator remove_change_nts(
+            const_iterator removal,
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time,
+            bool release = true) override;
+
     /**
      * Criteria to search a specific CacheChange_t on history
      * @param inner change to compare

diff --git a/include/fastdds/rtps/history/WriterHistory.h b/include/fastdds/rtps/history/WriterHistory.h
@@ -83,6 +83,19 @@ class WriterHistory : public rtps::History
             const_iterator removal,
             bool release = true) override;
 
+    /**
+     * Remove a specific change from the history.
+     * No Thread Safe
+     * @param removal iterator to the change for removal
+     * @param release specifies if the change should be return to the pool
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
+     * @return iterator to the next change if any
+     */
+    RTPS_DllAPI iterator remove_change_nts(
+            const_iterator removal,
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time,
+            bool release = true) override;
+
     /**
      * Criteria to search a specific CacheChange_t on history
      * @param inner change to compare
@@ -99,6 +112,10 @@ class WriterHistory : public rtps::History
     RTPS_DllAPI virtual bool remove_change_g(
             CacheChange_t* a_change);
 
+    RTPS_DllAPI virtual bool remove_change_g(
+            CacheChange_t* a_change,
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time);
+
     RTPS_DllAPI bool remove_change(
             const SequenceNumber_t& sequence_number);
 
@@ -111,6 +128,14 @@ class WriterHistory : public rtps::History
      */
     RTPS_DllAPI bool remove_min_change();
 
+    /**
+     * Remove the CacheChange_t with the minimum sequenceNumber.
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
+     * @return True if correctly removed.
+     */
+    RTPS_DllAPI bool remove_min_change(
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time);
+
     RTPS_DllAPI SequenceNumber_t next_sequence_number() const
     {
         return m_lastCacheChangeSeqNum + 1;

diff --git a/include/fastdds/rtps/messages/RTPSMessageGroup.h b/include/fastdds/rtps/messages/RTPSMessageGroup.h
@@ -83,11 +83,14 @@ class RTPSMessageGroup
      * Constructs a RTPSMessageGroup allowing to allocate its own buffer.
      * @param participant Pointer to the participant sending data.
      * @param internal_buffer true indicates this object to allocate its own buffer. false indicates to get a buffer
+     * @param max_blocking_time_point Future time point where blocking send should end.
      * from the participant.
      */
     RTPSMessageGroup(
             RTPSParticipantImpl* participant,
-            bool internal_buffer = false);
+            bool internal_buffer = false,
+            std::chrono::steady_clock::time_point max_blocking_time_point =
+            std::chrono::steady_clock::now() + std::chrono::hours(24));
 
     /**
      * Basic constructor.
@@ -313,8 +316,6 @@ class RTPSMessageGroup
 
     std::chrono::steady_clock::time_point max_blocking_time_point_;
 
-    bool max_blocking_time_is_set_ = false;
-
     std::unique_ptr<RTPSMessageGroup_t> send_buffer_;
 
     bool internal_buffer_ = false;

diff --git a/include/fastdds/rtps/writer/LocatorSelectorSender.hpp b/include/fastdds/rtps/writer/LocatorSelectorSender.hpp
@@ -4,8 +4,7 @@
 #include <fastdds/rtps/common/LocatorSelector.hpp>
 #include <fastdds/rtps/messages/RTPSMessageSenderInterface.hpp>
 #include <fastrtps/utils/collections/ResourceLimitedVector.hpp>
-
-#include <mutex>
+#include <fastrtps/utils/TimedMutex.hpp>
 
 namespace eprosima {
 namespace fastrtps {
@@ -95,6 +94,18 @@ class LocatorSelectorSender : public RTPSMessageSenderInterface
         mutex_.unlock();
     }
 
+    /*!
+     * Try to lock the object.
+     *
+     * This kind of object needs to be locked because could be used outside the writer's mutex.
+     */
+    template <class Clock, class Duration>
+    bool try_lock_until(
+            const std::chrono::time_point<Clock, Duration>& abs_time)
+    {
+        return mutex_.try_lock_until(abs_time);
+    }
+
     fastrtps::rtps::LocatorSelector locator_selector;
 
     ResourceLimitedVector<GUID_t> all_remote_readers;
@@ -105,7 +116,7 @@ class LocatorSelectorSender : public RTPSMessageSenderInterface
 
     RTPSWriter& writer_;
 
-    std::recursive_mutex mutex_;
+    RecursiveTimedMutex mutex_;
 };
 
 } // namespace rtps

diff --git a/include/fastdds/rtps/writer/RTPSWriter.h b/include/fastdds/rtps/writer/RTPSWriter.h
@@ -535,7 +535,7 @@ class RTPSWriter
     /**
      * Add a change to the unsent list.
      * @param change Pointer to the change to add.
-     * @param max_blocking_time
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
      */
     virtual void unsent_change_added_to_history(
             CacheChange_t* change,
@@ -544,10 +544,12 @@ class RTPSWriter
     /**
      * Indicate the writer that a change has been removed by the history due to some HistoryQos requirement.
      * @param a_change Pointer to the change that is going to be removed.
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
      * @return True if removed correctly.
      */
     virtual bool change_removed_by_history(
-            CacheChange_t* a_change) = 0;
+            CacheChange_t* a_change,
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time) = 0;
 
     bool is_datasharing_compatible_with(
             const ReaderProxyData& rdata) const;

diff --git a/include/fastdds/rtps/writer/StatefulPersistentWriter.h b/include/fastdds/rtps/writer/StatefulPersistentWriter.h
@@ -83,7 +83,7 @@ class StatefulPersistentWriter : public StatefulWriter, private PersistentWriter
     /**
      * Add a specific change to all ReaderLocators.
      * @param p Pointer to the change.
-     * @param max_blocking_time
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
      */
     void unsent_change_added_to_history(
             CacheChange_t* p,
@@ -92,10 +92,12 @@ class StatefulPersistentWriter : public StatefulWriter, private PersistentWriter
     /**
      * Indicate the writer that a change has been removed by the history due to some HistoryQos requirement.
      * @param a_change Pointer to the change that is going to be removed.
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
      * @return True if removed correctly.
      */
     bool change_removed_by_history(
-            CacheChange_t* a_change) override;
+            CacheChange_t* a_change,
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time) override;
 };
 
 } // namespace rtps

diff --git a/include/fastdds/rtps/writer/StatefulWriter.h b/include/fastdds/rtps/writer/StatefulWriter.h
@@ -134,7 +134,7 @@ class StatefulWriter : public RTPSWriter
     /**
      * Add a specific change to all ReaderLocators.
      * @param p Pointer to the change.
-     * @param max_blocking_time
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
      */
     void unsent_change_added_to_history(
             CacheChange_t* p,
@@ -143,10 +143,12 @@ class StatefulWriter : public RTPSWriter
     /**
      * Indicate the writer that a change has been removed by the history due to some HistoryQos requirement.
      * @param a_change Pointer to the change that is going to be removed.
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
      * @return True if removed correctly.
      */
     bool change_removed_by_history(
-            CacheChange_t* a_change) override;
+            CacheChange_t* a_change,
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time) override;
 
     /**
      * Sends a change directly to a intraprocess reader.

diff --git a/include/fastdds/rtps/writer/StatelessPersistentWriter.h b/include/fastdds/rtps/writer/StatelessPersistentWriter.h
@@ -74,7 +74,7 @@ class StatelessPersistentWriter : public StatelessWriter, private PersistentWrit
     /**
      * Add a specific change to all ReaderLocators.
      * @param p Pointer to the change.
-     * @param max_blocking_time
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
      */
     void unsent_change_added_to_history(
             CacheChange_t* p,
@@ -83,10 +83,12 @@ class StatelessPersistentWriter : public StatelessWriter, private PersistentWrit
     /**
      * Indicate the writer that a change has been removed by the history due to some HistoryQos requirement.
      * @param a_change Pointer to the change that is going to be removed.
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
      * @return True if removed correctly.
      */
     bool change_removed_by_history(
-            CacheChange_t* a_change) override;
+            CacheChange_t* a_change,
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time) override;
 };
 
 } // namespace rtps

diff --git a/include/fastdds/rtps/writer/StatelessWriter.h b/include/fastdds/rtps/writer/StatelessWriter.h
@@ -83,7 +83,7 @@ class StatelessWriter : public RTPSWriter
     /**
      * Add a specific change to all ReaderLocators.
      * @param change Pointer to the change.
-     * @param max_blocking_time
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
      */
     void unsent_change_added_to_history(
             CacheChange_t* change,
@@ -92,10 +92,12 @@ class StatelessWriter : public RTPSWriter
     /**
      * Indicate the writer that a change has been removed by the history due to some HistoryQos requirement.
      * @param change Pointer to the change that is going to be removed.
+     * @param[in] max_blocking_time Maximum time this method has to complete the task.
      * @return True if removed correctly.
      */
     bool change_removed_by_history(
-            CacheChange_t* change) override;
+            CacheChange_t* change,
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time) override;
 
     /**
      * Add a matched reader.

diff --git a/include/fastrtps/attributes/LibrarySettingsAttributes.h b/include/fastrtps/attributes/LibrarySettingsAttributes.h
@@ -38,19 +38,26 @@ class LibrarySettingsAttributes
 {
 public:
 
-    LibrarySettingsAttributes() {
+    LibrarySettingsAttributes()
+    {
     }
 
-    virtual ~LibrarySettingsAttributes() {
+    virtual ~LibrarySettingsAttributes()
+    {
     }
 
-    bool operator==(
+    bool operator ==(
             const LibrarySettingsAttributes& b) const
     {
         return (intraprocess_delivery == b.intraprocess_delivery);
     }
 
-    IntraprocessDeliveryType intraprocess_delivery = INTRAPROCESS_FULL;
+    IntraprocessDeliveryType intraprocess_delivery =
+#if HAVE_STRICT_REALTIME
+            INTRAPROCESS_OFF;
+#else
+            INTRAPROCESS_FULL;
+#endif // if HAVE_STRICT_REALTIME
 };
 
 }  // namespace fastrtps

diff --git a/include/fastrtps/publisher/PublisherHistory.h b/include/fastrtps/publisher/PublisherHistory.h
@@ -110,8 +110,12 @@ class PublisherHistory : public rtps::WriterHistory
     bool remove_change_pub(
             rtps::CacheChange_t* change);
 
-    virtual bool remove_change_g(
-            rtps::CacheChange_t* a_change);
+    bool remove_change_g(
+            rtps::CacheChange_t* a_change) override;
+
+    bool remove_change_g(
+            rtps::CacheChange_t* a_change,
+            const std::chrono::time_point<std::chrono::steady_clock>& max_blocking_time) override;
 
     bool remove_instance_changes(
             const rtps::InstanceHandle_t& handle,

diff --git a/include/fastrtps/utils/TimedConditionVariable.hpp b/include/fastrtps/utils/TimedConditionVariable.hpp
@@ -55,6 +55,7 @@
 #endif // if HAVE_STRICT_REALTIME && defined(__unix__)
 
 #include <mutex>
+#include <condition_variable>
 #include <chrono>
 #include <functional>
 
@@ -115,6 +116,25 @@ class TimedConditionVariable
         return ret_value;
     }
 
+    template<typename Mutex>
+    std::cv_status wait_for(
+            std::unique_lock<Mutex>& lock,
+            const std::chrono::nanoseconds& max_blocking_time)
+    {
+        auto nsecs = max_blocking_time;
+        struct timespec max_wait = {
+            0, 0
+        };
+        clock_gettime(CLOCK_MONOTONIC, &max_wait);
+        nsecs = nsecs + std::chrono::nanoseconds(max_wait.tv_nsec);
+        auto secs = std::chrono::duration_cast<std::chrono::seconds>(nsecs);
+        nsecs -= secs;
+        max_wait.tv_sec += secs.count();
+        max_wait.tv_nsec = (long)nsecs.count();
+        return (CV_TIMEDWAIT_(cv_, lock.mutex()->native_handle(),
+               &max_wait) == 0) ? std::cv_status::no_timeout : std::cv_status::timeout;
+    }
+
     template<typename Mutex>
     bool wait_until(
             std::unique_lock<Mutex>& lock,
@@ -137,7 +157,7 @@ class TimedConditionVariable
     }
 
     template<typename Mutex>
-    bool wait_until(
+    std::cv_status wait_until(
             std::unique_lock<Mutex>& lock,
             const std::chrono::steady_clock::time_point& max_blocking_time)
     {
@@ -147,7 +167,8 @@ class TimedConditionVariable
         struct timespec max_wait = {
             secs.time_since_epoch().count(), ns.count()
         };
-        return (CV_TIMEDWAIT_(cv_, lock.mutex()->native_handle(), &max_wait) == 0);
+        return (CV_TIMEDWAIT_(cv_, lock.mutex()->native_handle(),
+               &max_wait) == 0) ? std::cv_status::no_timeout : std::cv_status::timeout;
     }
 
     void notify_one()