Bitcoin Core  29.1.0
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 <tinyformat.h>
10 #include <util/check.h>
11 #include <util/strencodings.h>
12 
13 #include <atomic>
14 #include <chrono>
15 #include <optional>
16 #include <string>
17 #include <string_view>
18 #include <thread>
19 
20 void UninterruptibleSleep(const std::chrono::microseconds& n) { std::this_thread::sleep_for(n); }
21 
22 static std::atomic<std::chrono::seconds> g_mock_time{};
23 std::atomic<bool> g_used_system_time{false};
24 static std::atomic<std::chrono::milliseconds> g_mock_steady_time{};
25 
27 {
28  const auto mocktime{g_mock_time.load(std::memory_order_relaxed)};
29  if (!mocktime.count()) {
30  g_used_system_time = true;
31  }
32  const auto ret{
33  mocktime.count() ?
34  mocktime :
35  std::chrono::system_clock::now().time_since_epoch()};
36  assert(ret > 0s);
37  return time_point{ret};
38 };
39 
40 void SetMockTime(int64_t nMockTimeIn) { SetMockTime(std::chrono::seconds{nMockTimeIn}); }
41 void SetMockTime(std::chrono::seconds mock_time_in)
42 {
43  Assert(mock_time_in >= 0s);
44  g_mock_time.store(mock_time_in, std::memory_order_relaxed);
45 }
46 
47 std::chrono::seconds GetMockTime()
48 {
49  return g_mock_time.load(std::memory_order_relaxed);
50 }
51 
53 {
54  const auto mocktime{g_mock_steady_time.load(std::memory_order_relaxed)};
55  if (!mocktime.count()) {
56  g_used_system_time = true;
57  }
58  const auto ret{
59  mocktime.count() ?
60  mocktime :
61  std::chrono::steady_clock::now().time_since_epoch()};
62  return time_point{ret};
63 };
64 
65 void MockableSteadyClock::SetMockTime(std::chrono::milliseconds mock_time_in)
66 {
67  Assert(mock_time_in >= 0s);
68  g_mock_steady_time.store(mock_time_in, std::memory_order_relaxed);
69 }
70 
72 {
73  g_mock_steady_time.store(0ms, std::memory_order_relaxed);
74 }
75 
76 int64_t GetTime() { return GetTime<std::chrono::seconds>().count(); }
77 
78 std::string FormatISO8601DateTime(int64_t nTime)
79 {
80  const std::chrono::sys_seconds secs{std::chrono::seconds{nTime}};
81  const auto days{std::chrono::floor<std::chrono::days>(secs)};
82  const std::chrono::year_month_day ymd{days};
83  const std::chrono::hh_mm_ss hms{secs - days};
84  return strprintf("%04i-%02u-%02uT%02i:%02i:%02iZ", signed{ymd.year()}, unsigned{ymd.month()}, unsigned{ymd.day()}, hms.hours().count(), hms.minutes().count(), hms.seconds().count());
85 }
86 
87 std::string FormatISO8601Date(int64_t nTime)
88 {
89  const std::chrono::sys_seconds secs{std::chrono::seconds{nTime}};
90  const auto days{std::chrono::floor<std::chrono::days>(secs)};
91  const std::chrono::year_month_day ymd{days};
92  return strprintf("%04i-%02u-%02u", signed{ymd.year()}, unsigned{ymd.month()}, unsigned{ymd.day()});
93 }
94 
95 std::optional<int64_t> ParseISO8601DateTime(std::string_view str)
96 {
97  constexpr auto FMT_SIZE{std::string_view{"2000-01-01T01:01:01Z"}.size()};
98  if (str.size() != FMT_SIZE || str[4] != '-' || str[7] != '-' || str[10] != 'T' || str[13] != ':' || str[16] != ':' || str[19] != 'Z') {
99  return {};
100  }
101  const auto year{ToIntegral<uint16_t>(str.substr(0, 4))};
102  const auto month{ToIntegral<uint8_t>(str.substr(5, 2))};
103  const auto day{ToIntegral<uint8_t>(str.substr(8, 2))};
104  const auto hour{ToIntegral<uint8_t>(str.substr(11, 2))};
105  const auto min{ToIntegral<uint8_t>(str.substr(14, 2))};
106  const auto sec{ToIntegral<uint8_t>(str.substr(17, 2))};
107  if (!year || !month || !day || !hour || !min || !sec) {
108  return {};
109  }
110  const std::chrono::year_month_day ymd{std::chrono::year{*year}, std::chrono::month{*month}, std::chrono::day{*day}};
111  if (!ymd.ok()) {
112  return {};
113  }
114  const auto time{std::chrono::hours{*hour} + std::chrono::minutes{*min} + std::chrono::seconds{*sec}};
115  const auto tp{std::chrono::sys_days{ymd} + time};
116  return int64_t{TicksSinceEpoch<std::chrono::seconds>(tp)};
117 }
118 
119 struct timeval MillisToTimeval(int64_t nTimeout)
120 {
121  struct timeval timeout;
122  timeout.tv_sec = nTimeout / 1000;
123  timeout.tv_usec = (nTimeout % 1000) * 1000;
124  return timeout;
125 }
126 
127 struct timeval MillisToTimeval(std::chrono::milliseconds ms)
128 {
130 }
static std::atomic< std::chrono::seconds > g_mock_time
For testing.
Definition: time.cpp:22
static time_point now() noexcept
Return current system time or mocked time, if set.
Definition: time.cpp:52
int ret
static void ClearMockTime()
Clear mock time, go back to system steady clock.
Definition: time.cpp:71
std::chrono::time_point< NodeClock > time_point
Definition: time.h:19
std::chrono::seconds GetMockTime()
For testing.
Definition: time.cpp:47
assert(!tx.IsCoinBase())
std::string FormatISO8601Date(int64_t nTime)
Definition: time.cpp:87
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
std::string FormatISO8601DateTime(int64_t nTime)
ISO 8601 formatting is preferred.
Definition: time.cpp:78
static void SetMockTime(std::chrono::milliseconds mock_time_in)
Set mock time for testing.
Definition: time.cpp:65
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
Definition: time.cpp:40
constexpr int64_t count_milliseconds(std::chrono::milliseconds t)
Definition: time.h:82
std::optional< int64_t > ParseISO8601DateTime(std::string_view str)
Definition: time.cpp:95
std::chrono::time_point< MockableSteadyClock > time_point
Definition: time.h:39
static time_point now() noexcept
Return current system time or mocked time, if set.
Definition: time.cpp:26
void UninterruptibleSleep(const std::chrono::microseconds &n)
Definition: time.cpp:20
struct timeval MillisToTimeval(int64_t nTimeout)
Convert milliseconds to a struct timeval for e.g.
Definition: time.cpp:119
static int count
static std::atomic< std::chrono::milliseconds > g_mock_steady_time
For testing.
Definition: time.cpp:24
int64_t GetTime()
DEPRECATED, see GetTime.
Definition: time.cpp:76
std::atomic< bool > g_used_system_time
Definition: time.cpp:23
#define Assert(val)
Identity function.
Definition: check.h:85