Bitcoin ABC 0.32.11
P2P Digital Currency
time.cpp
Go to the documentation of this file.
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#include <util/time.h>
7
8#include <compat/compat.h>
9#include <util/check.h>
10#include <util/strencodings.h>
11
12#include <tinyformat.h>
13
14#include <atomic>
15#include <chrono>
16#include <optional>
17#include <string>
18#include <string_view>
19#include <thread>
20
21void UninterruptibleSleep(const std::chrono::microseconds &n) {
22 std::this_thread::sleep_for(n);
23}
24
26static std::atomic<int64_t> nMockTime(0);
27
29 const std::chrono::seconds mocktime{
30 nMockTime.load(std::memory_order_relaxed)};
31
32 const auto ret{mocktime.count()
33 ? mocktime
34 : std::chrono::system_clock::now().time_since_epoch()};
35 assert(ret > 0s);
36 return time_point{ret};
37};
38
39template <typename T> static T GetSystemTime() {
40 const auto now = std::chrono::duration_cast<T>(
41 std::chrono::system_clock::now().time_since_epoch());
42 assert(now.count() > 0);
43 return now;
44}
45
46void SetMockTime(int64_t nMockTimeIn) {
47 Assert(nMockTimeIn >= 0);
48 nMockTime.store(nMockTimeIn, std::memory_order_relaxed);
49}
50
51void SetMockTime(std::chrono::seconds mock_time_in) {
52 nMockTime.store(mock_time_in.count(), std::memory_order_relaxed);
53}
54std::chrono::seconds GetMockTime() {
55 return std::chrono::seconds(nMockTime.load(std::memory_order_relaxed));
56}
57
58int64_t GetTimeMillis() {
59 return int64_t{GetSystemTime<std::chrono::milliseconds>().count()};
60}
61
62int64_t GetTime() {
63 return GetTime<std::chrono::seconds>().count();
64}
65
66// According to https://en.cppreference.com/w/cpp/chrono/year.html, the
67// valid year range is [-32767, 32767].
68// Rejecting values outside this year range guards against
69// a segfault (obeserved with GCC 13.3.0 + Debug build) for very negative
70// values (e.g. std::numeric_limits<int64_t>::min()), and is consistent
71// with the behavior of std::chrono::year_month_day::ok()
72static bool IsInvalidTimestamp(int64_t nTime) {
73 constexpr int64_t december_31st_32767{971890963199};
74 constexpr int64_t january_1st_minus32767{-1096193779200};
75 return nTime > december_31st_32767 || nTime < january_1st_minus32767;
76}
77
78std::string FormatISO8601DateTime(int64_t nTime) {
79 if (IsInvalidTimestamp(nTime)) {
80 return {};
81 }
82 const std::chrono::sys_seconds secs{std::chrono::seconds{nTime}};
83 const auto days{std::chrono::floor<std::chrono::days>(secs)};
84 const std::chrono::year_month_day ymd{days};
85 const std::chrono::hh_mm_ss hms{secs - days};
86 return strprintf("%04i-%02u-%02uT%02i:%02i:%02iZ", signed{ymd.year()},
87 unsigned{ymd.month()}, unsigned{ymd.day()},
88 hms.hours().count(), hms.minutes().count(),
89 hms.seconds().count());
90}
91
92std::string FormatISO8601Date(int64_t nTime) {
93 if (IsInvalidTimestamp(nTime)) {
94 return {};
95 }
96 const std::chrono::sys_seconds secs{std::chrono::seconds{nTime}};
97 const auto days{std::chrono::floor<std::chrono::days>(secs)};
98 const std::chrono::year_month_day ymd{days};
99 return strprintf("%04i-%02u-%02u", signed{ymd.year()},
100 unsigned{ymd.month()}, unsigned{ymd.day()});
101}
102
103std::optional<int64_t> ParseISO8601DateTime(std::string_view str) {
104 constexpr auto FMT_SIZE{std::string_view{"2000-01-01T01:01:01Z"}.size()};
105 if (str.size() != FMT_SIZE || str[4] != '-' || str[7] != '-' ||
106 str[10] != 'T' || str[13] != ':' || str[16] != ':' || str[19] != 'Z') {
107 return {};
108 }
109 const auto year{ToIntegral<uint16_t>(str.substr(0, 4))};
110 const auto month{ToIntegral<uint8_t>(str.substr(5, 2))};
111 const auto day{ToIntegral<uint8_t>(str.substr(8, 2))};
112 const auto hour{ToIntegral<uint8_t>(str.substr(11, 2))};
113 const auto min{ToIntegral<uint8_t>(str.substr(14, 2))};
114 const auto sec{ToIntegral<uint8_t>(str.substr(17, 2))};
115 if (!year || !month || !day || !hour || !min || !sec) {
116 return {};
117 }
118 const std::chrono::year_month_day ymd{std::chrono::year{*year},
119 std::chrono::month{*month},
120 std::chrono::day{*day}};
121 if (!ymd.ok()) {
122 return {};
123 }
124 const auto time{std::chrono::hours{*hour} + std::chrono::minutes{*min} +
125 std::chrono::seconds{*sec}};
126 const auto tp{std::chrono::sys_days{ymd} + time};
127 return int64_t{TicksSinceEpoch<std::chrono::seconds>(tp)};
128}
129
130struct timeval MillisToTimeval(int64_t nTimeout) {
131 struct timeval timeout;
132 timeout.tv_sec = nTimeout / 1000;
133 timeout.tv_usec = (nTimeout % 1000) * 1000;
134 return timeout;
135}
136
137struct timeval MillisToTimeval(std::chrono::milliseconds ms) {
139}
#define Assert(val)
Identity function.
Definition: check.h:84
Implement std::hash so RCUPtr can be used as a key for maps or sets.
Definition: rcu.h:259
static time_point now() noexcept
Return current system time or mocked time, if set.
Definition: time.cpp:28
std::chrono::time_point< NodeClock > time_point
Definition: time.h:21
static int count
struct timeval MillisToTimeval(int64_t nTimeout)
Convert milliseconds to a struct timeval for e.g.
Definition: time.cpp:130
int64_t GetTimeMillis()
Returns the system time (not mockable)
Definition: time.cpp:58
void UninterruptibleSleep(const std::chrono::microseconds &n)
Definition: time.cpp:21
static std::atomic< int64_t > nMockTime(0)
For testing.
std::chrono::seconds GetMockTime()
For testing.
Definition: time.cpp:54
int64_t GetTime()
DEPRECATED Use either ClockType::now() or Now<TimePointType>() if a cast is needed.
Definition: time.cpp:62
std::string FormatISO8601Date(int64_t nTime)
Definition: time.cpp:92
static bool IsInvalidTimestamp(int64_t nTime)
Definition: time.cpp:72
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
Definition: time.cpp:46
std::optional< int64_t > ParseISO8601DateTime(std::string_view str)
Definition: time.cpp:103
static T GetSystemTime()
Definition: time.cpp:39
std::string FormatISO8601DateTime(int64_t nTime)
ISO 8601 formatting is preferred.
Definition: time.cpp:78
constexpr int64_t count_milliseconds(std::chrono::milliseconds t)
Definition: time.h:62
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1202
assert(!tx.IsCoinBase())