From 2d33cfba4177a8d34b677e51caa040a370178688 Mon Sep 17 00:00:00 2001 From: Kittywhiskers Van Gogh <63189531+kwvg@users.noreply.github.com> Date: Sat, 7 Dec 2024 15:50:41 +0000 Subject: [PATCH] merge bitcoin#25101: Add mockable clock type --- src/bitcoin-cli.cpp | 3 +-- src/test/util_tests.cpp | 4 ++++ src/util/time.cpp | 12 ++++-------- src/util/time.h | 31 ++++++++++++++++++++++++------- 4 files changed, 33 insertions(+), 17 deletions(-) diff --git a/src/bitcoin-cli.cpp b/src/bitcoin-cli.cpp index 6d2a858259..479049e6a3 100644 --- a/src/bitcoin-cli.cpp +++ b/src/bitcoin-cli.cpp @@ -47,7 +47,6 @@ // trivial to get the mocked time from the server, nor is it needed for now, so // just use a plain system_clock. using CliClock = std::chrono::system_clock; -using CliSeconds = std::chrono::time_point; const std::function G_TRANSLATION_FUN = nullptr; UrlDecodeFn* const URL_DECODE = urlDecode; @@ -491,7 +490,7 @@ public: if (networkinfo["version"].get_int() < 200000) { throw std::runtime_error("-netinfo requires dashd server to be running v20.0 and up"); } - const int64_t time_now{count_seconds(Now())}; + const int64_t time_now{TicksSinceEpoch(CliClock::now())}; // Count peer connection totals, and if DetailsRequested(), store peer data in a vector of structs. for (const UniValue& peer : batch[ID_PEERINFO]["result"].getValues()) { diff --git a/src/test/util_tests.cpp b/src/test/util_tests.cpp index f396c4f7e0..1a53f5cb16 100644 --- a/src/test/util_tests.cpp +++ b/src/test/util_tests.cpp @@ -1525,8 +1525,12 @@ BOOST_AUTO_TEST_CASE(util_time_GetTime) for (const auto& num_sleep : {0ms, 1ms}) { UninterruptibleSleep(num_sleep); BOOST_CHECK_EQUAL(111, GetTime()); // Deprecated time getter + BOOST_CHECK_EQUAL(111, Now().time_since_epoch().count()); + BOOST_CHECK_EQUAL(111, TicksSinceEpoch(NodeClock::now())); + BOOST_CHECK_EQUAL(111, TicksSinceEpoch(Now())); BOOST_CHECK_EQUAL(111, GetTime().count()); BOOST_CHECK_EQUAL(111000, GetTime().count()); + BOOST_CHECK_EQUAL(111000, TicksSinceEpoch(NodeClock::now())); BOOST_CHECK_EQUAL(111000000, GetTime().count()); } diff --git a/src/util/time.cpp b/src/util/time.cpp index 1f2609080f..2b9a469d9a 100644 --- a/src/util/time.cpp +++ b/src/util/time.cpp @@ -66,20 +66,16 @@ bool ChronoSanityCheck() return true; } -template -T GetTime() +NodeClock::time_point NodeClock::now() noexcept { const auto mocktime{g_mock_time.load(std::memory_order_relaxed)}; const auto ret{ mocktime.count() ? mocktime : - std::chrono::duration_cast(std::chrono::system_clock::now().time_since_epoch())}; + std::chrono::system_clock::now().time_since_epoch()}; assert(ret > 0s); - return ret; -} -template std::chrono::seconds GetTime(); -template std::chrono::milliseconds GetTime(); -template std::chrono::microseconds GetTime(); + return time_point{ret}; +}; template static T GetSystemTime() diff --git a/src/util/time.h b/src/util/time.h index b05cfe449d..54e5524250 100644 --- a/src/util/time.h +++ b/src/util/time.h @@ -14,6 +14,16 @@ using namespace std::chrono_literals; +/** Mockable clock in the context of tests, otherwise the system clock */ +struct NodeClock : public std::chrono::system_clock { + using time_point = std::chrono::time_point; + /** Return current system time or mocked time, if set */ + static time_point now() noexcept; + static std::time_t to_time_t(const time_point&) = delete; // unused + static time_point from_time_t(std::time_t) = delete; // unused +}; +using NodeSeconds = std::chrono::time_point; + using SteadyClock = std::chrono::steady_clock; using SteadySeconds = std::chrono::time_point; using SteadyMilliseconds = std::chrono::time_point; @@ -31,10 +41,10 @@ void UninterruptibleSleep(const std::chrono::microseconds& n); * This helper is used to convert durations/time_points before passing them over an * interface that doesn't support std::chrono (e.g. RPC, debug log, or the GUI) */ -template -constexpr int64_t count_seconds(std::chrono::time_point t) +template +constexpr auto TicksSinceEpoch(Timepoint t) { - return t.time_since_epoch().count(); + return std::chrono::time_point_cast(t).time_since_epoch().count(); } constexpr int64_t count_seconds(std::chrono::seconds t) { return t.count(); } constexpr int64_t count_milliseconds(std::chrono::milliseconds t) { return t.count(); } @@ -49,7 +59,11 @@ inline double CountSecondsDouble(SecondsDouble t) { return t.count(); } /** * DEPRECATED - * Use either GetTimeSeconds (not mockable) or GetTime (mockable) + * Use either ClockType::now() or Now() if a cast is needed. + * ClockType is + * - std::chrono::steady_clock for steady time + * - std::chrono::system_clock for system time + * - NodeClock for mockable system time */ int64_t GetTime(); @@ -72,9 +86,6 @@ void SetMockTime(std::chrono::seconds mock_time_in); /** For testing */ std::chrono::seconds GetMockTime(); -/** Return system time (or mocked time, if set) */ -template -T GetTime(); /** * Return the current time point cast to the given precicion. Only use this * when an exact precicion is needed, otherwise use T::clock::now() directly. @@ -84,6 +95,12 @@ T Now() { return std::chrono::time_point_cast(T::clock::now()); } +/** DEPRECATED, see GetTime */ +template +T GetTime() +{ + return Now>().time_since_epoch(); +} /** * ISO 8601 formatting is preferred. Use the FormatISO8601{DateTime,Date,Time}