Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[21314] Improve resilience against clock adjustments #5018

Merged
merged 10 commits into from
Sep 2, 2024

Conversation

ma30002000
Copy link
Contributor

@ma30002000 ma30002000 commented Jul 2, 2024

Description

When investigating a system undergoing larger system clock adjustments, I noticed that in some places, std::chrono::system_clock and std::chrono::high_resolution_clock are used for handling timeouts and status check intervals.
However, std::chrono::system_clock is definitely not steady, and std::chrono::high_resolution_clock is not steady quite often (see cppreference).

When undergoing clock adjustments (manually or due to clock server synchronization), timeouts and status checks might no longer be triggered when relying on timestamps based on std::chrono::system_clock.

@Mergifyio backport 2.14.x 2.10.x

Contributor Checklist

  • Commit messages follow the project guidelines.
  • The code follows the style guidelines of this project.
  • Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
  • N/A Any new/modified methods have been properly documented using Doxygen.
  • N/A Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
  • Changes are backport compatible: they do NOT break ABI nor change library core behavior.
  • Changes are API compatible.
  • N/A New feature has been added to the versions.md file (if applicable).
  • N/A New feature has been documented/Current behavior is correctly described in the documentation.
  • Applicable backports have been included in the description.

Reviewer Checklist

  • The PR has a milestone assigned.
  • The title and description correctly express the PR's purpose.
  • Check contributor checklist is correct.
  • N/A If this is a critical bug fix, backports to the critical-only supported branches have been requested.
  • Check CI results: changes do not issue any warning.
  • Check CI results: failing tests are unrelated with the changes.

@ma30002000 ma30002000 force-pushed the bugfix/steady-clock branch 3 times, most recently from b5fad03 to 519524c Compare July 2, 2024 13:19
@EduPonz EduPonz added this to the v3.0.0 milestone Jul 3, 2024
@ma30002000
Copy link
Contributor Author

Is there anything I need to to in order to get CI results?

@JesusPoderoso
Copy link
Contributor

Hi @ma30002000, thanks for your contribution.
We will look at it in the following days and order CI.
Thanks for your patience!

@elianalf elianalf added the needs-review PR that is ready to be reviewed label Jul 11, 2024
@EduPonz EduPonz modified the milestones: v3.0.0, v3.0.1 Jul 19, 2024
ma30002000 and others added 5 commits August 28, 2024 10:50
…high_resolution_clock might not be steady depending on STL impl)

Signed-off-by: Matthias Schneider <[email protected]>
Signed-off-by: Matthias Schneider <[email protected]>
Signed-off-by: Miguel Company <[email protected]>
Copy link
Member

@MiguelCompany MiguelCompany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ma30002000

First of all, thank you for your patience waiting for this to be reviewed.

I took the liberty of rebasing this PR, and added a commit to fix one build issue.

Except for the changes in SharedMemGlobal.hpp, the changes look good to me.

src/cpp/rtps/transport/shared_mem/SharedMemGlobal.hpp Outdated Show resolved Hide resolved
@MiguelCompany MiguelCompany changed the title More use of std::chrono::steady_clock for resilience against clock adjustments [21314] More use of std::chrono::steady_clock for resilience against clock adjustments Aug 29, 2024
…checks (high_resolution_clock might not be steady depending on STL impl)"

This reverts commit d69eb91.
@MiguelCompany MiguelCompany changed the title [21314] More use of std::chrono::steady_clock for resilience against clock adjustments [21314] Improve resilience against clock adjustments Aug 29, 2024
@MiguelCompany
Copy link
Member

Manual CIs:

Copy link
Member

@Mario-DL Mario-DL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with green CI

@JesusPoderoso JesusPoderoso added ready-to-merge Ready to be merged. CI and changes have been reviewed and approved. and removed needs-review PR that is ready to be reviewed labels Sep 2, 2024
@MiguelCompany
Copy link
Member

@Mergifyio backport 2.14.x 2.10.x

Copy link
Contributor

mergify bot commented Sep 2, 2024

backport 2.14.x 2.10.x

✅ Backports have been created

@MiguelCompany MiguelCompany merged commit ccc690c into eProsima:master Sep 2, 2024
25 of 31 checks passed
mergify bot pushed a commit that referenced this pull request Sep 2, 2024
* Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)

Signed-off-by: Matthias Schneider <[email protected]>

* Use steady_clock instead for system_clock for calculating timeouts

Signed-off-by: Matthias Schneider <[email protected]>

* Use correct clock's duration for duration_cast

Signed-off-by: Matthias Schneider <[email protected]>

* Use Time_t::now()

Signed-off-by: Matthias Schneider <[email protected]>

* Fix build.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataWriterImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataReaderImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on StatefulWriter.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Protect current_time_since_unix_epoch against clock adjustments.

Signed-off-by: Miguel Company <[email protected]>

* Revert "Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)"

This reverts commit d69eb91.

---------

Signed-off-by: Matthias Schneider <[email protected]>
Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit ccc690c)

# Conflicts:
#	include/fastdds/rtps/writer/StatefulWriter.h
#	src/cpp/fastdds/publisher/DataWriterImpl.cpp
#	src/cpp/fastdds/subscriber/DataReaderImpl.cpp
#	src/cpp/utils/time_t_helpers.hpp
mergify bot pushed a commit that referenced this pull request Sep 2, 2024
* Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)

Signed-off-by: Matthias Schneider <[email protected]>

* Use steady_clock instead for system_clock for calculating timeouts

Signed-off-by: Matthias Schneider <[email protected]>

* Use correct clock's duration for duration_cast

Signed-off-by: Matthias Schneider <[email protected]>

* Use Time_t::now()

Signed-off-by: Matthias Schneider <[email protected]>

* Fix build.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataWriterImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataReaderImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on StatefulWriter.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Protect current_time_since_unix_epoch against clock adjustments.

Signed-off-by: Miguel Company <[email protected]>

* Revert "Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)"

This reverts commit d69eb91.

---------

Signed-off-by: Matthias Schneider <[email protected]>
Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit ccc690c)

# Conflicts:
#	include/fastdds/rtps/writer/StatefulWriter.h
#	src/cpp/fastdds/publisher/DataWriterImpl.cpp
#	src/cpp/fastdds/subscriber/DataReaderImpl.cpp
#	src/cpp/utils/time_t_helpers.hpp
paxifaer pushed a commit to paxifaer/Fast-DDS that referenced this pull request Sep 7, 2024
* Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)

Signed-off-by: Matthias Schneider <[email protected]>

* Use steady_clock instead for system_clock for calculating timeouts

Signed-off-by: Matthias Schneider <[email protected]>

* Use correct clock's duration for duration_cast

Signed-off-by: Matthias Schneider <[email protected]>

* Use Time_t::now()

Signed-off-by: Matthias Schneider <[email protected]>

* Fix build.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataWriterImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataReaderImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on StatefulWriter.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Protect current_time_since_unix_epoch against clock adjustments.

Signed-off-by: Miguel Company <[email protected]>

* Revert "Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)"

This reverts commit d69eb91.

---------

Signed-off-by: Matthias Schneider <[email protected]>
Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
Signed-off-by: paxifaer <[email protected]>
JesusPoderoso pushed a commit that referenced this pull request Sep 23, 2024
* Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)

Signed-off-by: Matthias Schneider <[email protected]>

* Use steady_clock instead for system_clock for calculating timeouts

Signed-off-by: Matthias Schneider <[email protected]>

* Use correct clock's duration for duration_cast

Signed-off-by: Matthias Schneider <[email protected]>

* Use Time_t::now()

Signed-off-by: Matthias Schneider <[email protected]>

* Fix build.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataWriterImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataReaderImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on StatefulWriter.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Protect current_time_since_unix_epoch against clock adjustments.

Signed-off-by: Miguel Company <[email protected]>

* Revert "Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)"

This reverts commit d69eb91.

---------

Signed-off-by: Matthias Schneider <[email protected]>
Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit ccc690c)

# Conflicts:
#	include/fastdds/rtps/writer/StatefulWriter.h
#	src/cpp/fastdds/publisher/DataWriterImpl.cpp
#	src/cpp/fastdds/subscriber/DataReaderImpl.cpp
#	src/cpp/utils/time_t_helpers.hpp
JesusPoderoso pushed a commit that referenced this pull request Sep 23, 2024
* Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)

Signed-off-by: Matthias Schneider <[email protected]>

* Use steady_clock instead for system_clock for calculating timeouts

Signed-off-by: Matthias Schneider <[email protected]>

* Use correct clock's duration for duration_cast

Signed-off-by: Matthias Schneider <[email protected]>

* Use Time_t::now()

Signed-off-by: Matthias Schneider <[email protected]>

* Fix build.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataWriterImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataReaderImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on StatefulWriter.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Protect current_time_since_unix_epoch against clock adjustments.

Signed-off-by: Miguel Company <[email protected]>

* Revert "Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)"

This reverts commit d69eb91.

---------

Signed-off-by: Matthias Schneider <[email protected]>
Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit ccc690c)

# Conflicts:
#	include/fastdds/rtps/writer/StatefulWriter.h
#	src/cpp/fastdds/publisher/DataWriterImpl.cpp
#	src/cpp/fastdds/subscriber/DataReaderImpl.cpp
#	src/cpp/utils/time_t_helpers.hpp
JesusPoderoso pushed a commit that referenced this pull request Sep 23, 2024
* Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)

Signed-off-by: Matthias Schneider <[email protected]>

* Use steady_clock instead for system_clock for calculating timeouts

Signed-off-by: Matthias Schneider <[email protected]>

* Use correct clock's duration for duration_cast

Signed-off-by: Matthias Schneider <[email protected]>

* Use Time_t::now()

Signed-off-by: Matthias Schneider <[email protected]>

* Fix build.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataWriterImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataReaderImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on StatefulWriter.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Protect current_time_since_unix_epoch against clock adjustments.

Signed-off-by: Miguel Company <[email protected]>

* Revert "Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)"

This reverts commit d69eb91.

---------

Signed-off-by: Matthias Schneider <[email protected]>
Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit ccc690c)
@ma30002000
Copy link
Contributor Author

Hi, sorry for the late response, could you please provide some more details on why you have not included the change of std::chrono::high_resolution_clock to std::chrono::steady_clock? Using a (on some systems) non-steady clock for timeout checks will have undesired effects. I also do not see a drawback of using steady_clock instead.

@MiguelCompany
Copy link
Member

@ma30002000 Because the changes affected the PortNode structure, which is part of the Shared Memory port segment. This means the changes would break interoperability with previous versions, which we should not do on a patch release.

@ma30002000
Copy link
Contributor Author

@MiguelCompany I understand - how and when can we address the issue in the future then? Unfortunately this change did not make it into 3.x...

MiguelCompany pushed a commit that referenced this pull request Nov 15, 2024
* Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)

Signed-off-by: Matthias Schneider <[email protected]>

* Use steady_clock instead for system_clock for calculating timeouts

Signed-off-by: Matthias Schneider <[email protected]>

* Use correct clock's duration for duration_cast

Signed-off-by: Matthias Schneider <[email protected]>

* Use Time_t::now()

Signed-off-by: Matthias Schneider <[email protected]>

* Fix build.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataWriterImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on DataReaderImpl.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Refactor on StatefulWriter.

Signed-off-by: Miguel Company <[email protected]>

* Refs #21314. Protect current_time_since_unix_epoch against clock adjustments.

Signed-off-by: Miguel Company <[email protected]>

* Revert "Use steady_clock instead of high_resolution_clock for status checks (high_resolution_clock might not be steady depending on STL impl)"

This reverts commit d69eb91.

---------

Signed-off-by: Matthias Schneider <[email protected]>
Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit ccc690c)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-to-merge Ready to be merged. CI and changes have been reviewed and approved.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants