Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #ifndef BITCOIN_UTIL_TIME_H
7 : : #define BITCOIN_UTIL_TIME_H
8 : :
9 : : #include <chrono> // IWYU pragma: export
10 : : #include <cstdint>
11 : : #include <optional>
12 : : #include <string>
13 : : #include <string_view>
14 : :
15 : : using namespace std::chrono_literals;
16 : :
17 : : /** Mockable clock in the context of tests, otherwise the system clock */
18 : : struct NodeClock : public std::chrono::system_clock {
19 : : using time_point = std::chrono::time_point<NodeClock>;
20 : : /** Return current system time or mocked time, if set */
21 : : static time_point now() noexcept;
22 : : static std::time_t to_time_t(const time_point&) = delete; // unused
23 : : static time_point from_time_t(std::time_t) = delete; // unused
24 : : };
25 : : using NodeSeconds = std::chrono::time_point<NodeClock, std::chrono::seconds>;
26 : :
27 : : using SteadyClock = std::chrono::steady_clock;
28 : : using SteadySeconds = std::chrono::time_point<std::chrono::steady_clock, std::chrono::seconds>;
29 : : using SteadyMilliseconds = std::chrono::time_point<std::chrono::steady_clock, std::chrono::milliseconds>;
30 : : using SteadyMicroseconds = std::chrono::time_point<std::chrono::steady_clock, std::chrono::microseconds>;
31 : :
32 : : using SystemClock = std::chrono::system_clock;
33 : :
34 : : void UninterruptibleSleep(const std::chrono::microseconds& n);
35 : :
36 : : /**
37 : : * Helper to count the seconds of a duration/time_point.
38 : : *
39 : : * All durations/time_points should be using std::chrono and calling this should generally
40 : : * be avoided in code. Though, it is still preferred to an inline t.count() to
41 : : * protect against a reliance on the exact type of t.
42 : : *
43 : : * This helper is used to convert durations/time_points before passing them over an
44 : : * interface that doesn't support std::chrono (e.g. RPC, debug log, or the GUI)
45 : : */
46 : : template <typename Dur1, typename Dur2>
47 [ + - ]: 16354007 : constexpr auto Ticks(Dur2 d)
[ + - + - ]
48 : : {
49 [ + - ]: 16354007 : return std::chrono::duration_cast<Dur1>(d).count();
[ + - + - ]
50 : : }
51 : : template <typename Duration, typename Timepoint>
52 : 5649014 : constexpr auto TicksSinceEpoch(Timepoint t)
53 : : {
54 : 5649014 : return Ticks<Duration>(t.time_since_epoch());
55 : : }
56 [ + + ][ + - : 1011518 : constexpr int64_t count_seconds(std::chrono::seconds t) { return t.count(); }
- - - - ]
[ + - + -
# # # # #
# # # #
# ][ + - +
- + - + -
+ - + - +
- ]
57 [ + - ]: 528414 : constexpr int64_t count_milliseconds(std::chrono::milliseconds t) { return t.count(); }
58 : 1 : constexpr int64_t count_microseconds(std::chrono::microseconds t) { return t.count(); }
59 : :
60 : : using HoursDouble = std::chrono::duration<double, std::chrono::hours::period>;
61 : : using SecondsDouble = std::chrono::duration<double, std::chrono::seconds::period>;
62 : : using MillisecondsDouble = std::chrono::duration<double, std::chrono::milliseconds::period>;
63 : :
64 : : /**
65 : : * DEPRECATED
66 : : * Use either ClockType::now() or Now<TimePointType>() if a cast is needed.
67 : : * ClockType is
68 : : * - SteadyClock/std::chrono::steady_clock for steady time
69 : : * - SystemClock/std::chrono::system_clock for system time
70 : : * - NodeClock for mockable system time
71 : : */
72 : : int64_t GetTime();
73 : :
74 : : /**
75 : : * DEPRECATED
76 : : * Use SetMockTime with chrono type
77 : : *
78 : : * @param[in] nMockTimeIn Time in seconds.
79 : : */
80 : : void SetMockTime(int64_t nMockTimeIn);
81 : :
82 : : /** For testing. Set e.g. with the setmocktime rpc, or -mocktime argument */
83 : : void SetMockTime(std::chrono::seconds mock_time_in);
84 : :
85 : : /** For testing */
86 : : std::chrono::seconds GetMockTime();
87 : :
88 : : /**
89 : : * Return the current time point cast to the given precision. Only use this
90 : : * when an exact precision is needed, otherwise use T::clock::now() directly.
91 : : */
92 : : template <typename T>
93 : 3069045 : T Now()
94 : : {
95 : 3069045 : return std::chrono::time_point_cast<typename T::duration>(T::clock::now());
96 : : }
97 : : /** DEPRECATED, see GetTime */
98 : : template <typename T>
99 : 2872525 : T GetTime()
100 : : {
101 : 2872525 : return Now<std::chrono::time_point<NodeClock, T>>().time_since_epoch();
102 : : }
103 : :
104 : : /**
105 : : * ISO 8601 formatting is preferred. Use the FormatISO8601{DateTime,Date}
106 : : * helper functions if possible.
107 : : */
108 : : std::string FormatISO8601DateTime(int64_t nTime);
109 : : std::string FormatISO8601Date(int64_t nTime);
110 : : std::optional<int64_t> ParseISO8601DateTime(std::string_view str);
111 : :
112 : : /**
113 : : * Convert milliseconds to a struct timeval for e.g. select.
114 : : */
115 : : struct timeval MillisToTimeval(int64_t nTimeout);
116 : :
117 : : /**
118 : : * Convert milliseconds to a struct timeval for e.g. select.
119 : : */
120 : : struct timeval MillisToTimeval(std::chrono::milliseconds ms);
121 : :
122 : : #endif // BITCOIN_UTIL_TIME_H
|
