Bitcoin Core  24.99.0
P2P Digital Currency
time.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2022 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 <compat/compat.h>
10 
11 #include <chrono> // IWYU pragma: export
12 #include <cstdint>
13 #include <string>
14 
15 using namespace std::chrono_literals;
16 
18 struct NodeClock : public std::chrono::system_clock {
19  using time_point = std::chrono::time_point<NodeClock>;
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 
46 template <typename Dur1, typename Dur2>
47 constexpr auto Ticks(Dur2 d)
48 {
49  return std::chrono::duration_cast<Dur1>(d).count();
50 }
51 template <typename Duration, typename Timepoint>
52 constexpr auto TicksSinceEpoch(Timepoint t)
53 {
54  return Ticks<Duration>(t.time_since_epoch());
55 }
56 constexpr int64_t count_seconds(std::chrono::seconds t) { return t.count(); }
57 constexpr int64_t count_milliseconds(std::chrono::milliseconds t) { return t.count(); }
58 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 
72 int64_t GetTime();
73 
75 int64_t GetTimeMillis();
76 
83 void SetMockTime(int64_t nMockTimeIn);
84 
86 void SetMockTime(std::chrono::seconds mock_time_in);
87 
89 std::chrono::seconds GetMockTime();
90 
95 template <typename T>
96 T Now()
97 {
98  return std::chrono::time_point_cast<typename T::duration>(T::clock::now());
99 }
101 template <typename T>
103 {
104  return Now<std::chrono::time_point<NodeClock, T>>().time_since_epoch();
105 }
106 
111 std::string FormatISO8601DateTime(int64_t nTime);
112 std::string FormatISO8601Date(int64_t nTime);
113 
117 struct timeval MillisToTimeval(int64_t nTimeout);
118 
122 struct timeval MillisToTimeval(std::chrono::milliseconds ms);
123 
125 bool ChronoSanityCheck();
126 
127 #endif // BITCOIN_UTIL_TIME_H
#define T(expected, seed, data)
Mockable clock in the context of tests, otherwise the system clock.
Definition: time.h:18
std::chrono::time_point< NodeClock > time_point
Definition: time.h:19
constexpr int64_t count_milliseconds(std::chrono::milliseconds t)
Definition: time.h:57
struct timeval MillisToTimeval(int64_t nTimeout)
Convert milliseconds to a struct timeval for e.g.
Definition: time.cpp:138
int64_t GetTimeMillis()
Returns the system time (not mockable)
Definition: time.cpp:105
std::chrono::duration< double, std::chrono::seconds::period > SecondsDouble
Definition: time.h:61
std::chrono::duration< double, std::chrono::hours::period > HoursDouble
Definition: time.h:60
std::chrono::steady_clock SteadyClock
Definition: time.h:27
std::chrono::duration< double, std::chrono::milliseconds::period > MillisecondsDouble
Definition: time.h:62
void UninterruptibleSleep(const std::chrono::microseconds &n)
Definition: time.cpp:23
std::chrono::seconds GetMockTime()
For testing.
Definition: time.cpp:100
int64_t GetTime()
DEPRECATED Use either ClockType::now() or Now<TimePointType>() if a cast is needed.
Definition: time.h:102
constexpr auto TicksSinceEpoch(Timepoint t)
Definition: time.h:52
std::string FormatISO8601Date(int64_t nTime)
Definition: time.cpp:125
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
Definition: time.cpp:89
T Now()
Return the current time point cast to the given precision.
Definition: time.h:96
std::chrono::system_clock SystemClock
Definition: time.h:32
constexpr int64_t count_microseconds(std::chrono::microseconds t)
Definition: time.h:58
constexpr int64_t count_seconds(std::chrono::seconds t)
Definition: time.h:56
std::chrono::time_point< std::chrono::steady_clock, std::chrono::microseconds > SteadyMicroseconds
Definition: time.h:30
std::chrono::time_point< NodeClock, std::chrono::seconds > NodeSeconds
Definition: time.h:25
std::chrono::time_point< std::chrono::steady_clock, std::chrono::seconds > SteadySeconds
Definition: time.h:28
constexpr auto Ticks(Dur2 d)
Helper to count the seconds of a duration/time_point.
Definition: time.h:47
bool ChronoSanityCheck()
Sanity check epoch match normal Unix epoch.
Definition: time.cpp:27
std::string FormatISO8601DateTime(int64_t nTime)
ISO 8601 formatting is preferred.
Definition: time.cpp:112
std::chrono::time_point< std::chrono::steady_clock, std::chrono::milliseconds > SteadyMilliseconds
Definition: time.h:29