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 <array>
 14  #include <atomic>
 15  #include <chrono>
 16  #include <optional>
 17  #include <string>
 18  #include <string_view>
 19  #include <thread>
 20  
 21  static constexpr std::array<std::string_view, 7> weekdays{"Thu", "Fri", "Sat", "Sun", "Mon", "Tue", "Wed"}; // 1970-01-01 was a Thursday.
 22  static constexpr std::array<std::string_view, 12> months{"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"};
 23  
 24  void UninterruptibleSleep(const std::chrono::microseconds& n) { std::this_thread::sleep_for(n); }
 25  
 26  static std::atomic<std::chrono::seconds> g_mock_time{}; //!< For testing
 27  std::atomic<bool> g_used_system_time{false};
 28  static std::atomic<MockableSteadyClock::mock_time_point::duration> g_mock_steady_time{}; //!< For testing
 29  
 30  NodeClock::time_point NodeClock::now() noexcept
 31  {
 32      const auto mocktime{g_mock_time.load(std::memory_order_relaxed)};
 33      if (!mocktime.count()) {
 34          g_used_system_time = true;
 35      }
 36      const auto ret{
 37          mocktime.count() ?
 38              mocktime :
 39              std::chrono::system_clock::now().time_since_epoch()};
 40      assert(ret > 0s);
 41      return time_point{ret};
 42  };
 43  
 44  void SetMockTime(int64_t nMockTimeIn) { SetMockTime(std::chrono::seconds{nMockTimeIn}); }
 45  void SetMockTime(std::chrono::time_point<NodeClock, std::chrono::seconds> mock) { SetMockTime(mock.time_since_epoch()); }
 46  void SetMockTime(std::chrono::seconds mock_time_in)
 47  {
 48      Assert(mock_time_in >= 0s);
 49      g_mock_time.store(mock_time_in, std::memory_order_relaxed);
 50  }
 51  
 52  std::chrono::seconds GetMockTime()
 53  {
 54      return g_mock_time.load(std::memory_order_relaxed);
 55  }
 56  
 57  MockableSteadyClock::time_point MockableSteadyClock::now() noexcept
 58  {
 59      const auto mocktime{g_mock_steady_time.load(std::memory_order_relaxed)};
 60      if (!mocktime.count()) {
 61          g_used_system_time = true;
 62      }
 63      const auto ret{
 64          mocktime.count() ?
 65              mocktime :
 66              std::chrono::steady_clock::now().time_since_epoch()};
 67      return time_point{ret};
 68  };
 69  
 70  void MockableSteadyClock::SetMockTime(mock_time_point::duration mock_time_in)
 71  {
 72      Assert(mock_time_in >= 0s);
 73      g_mock_steady_time.store(mock_time_in, std::memory_order_relaxed);
 74  }
 75  
 76  void MockableSteadyClock::ClearMockTime()
 77  {
 78      g_mock_steady_time.store(0ms, std::memory_order_relaxed);
 79  }
 80  
 81  int64_t GetTime() { return GetTime<std::chrono::seconds>().count(); }
 82  
 83  std::string FormatISO8601DateTime(int64_t nTime)
 84  {
 85      const std::chrono::sys_seconds secs{std::chrono::seconds{nTime}};
 86      const auto days{std::chrono::floor<std::chrono::days>(secs)};
 87      const std::chrono::year_month_day ymd{days};
 88      const std::chrono::hh_mm_ss hms{secs - days};
 89      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());
 90  }
 91  
 92  std::string FormatISO8601Date(int64_t nTime)
 93  {
 94      const std::chrono::sys_seconds secs{std::chrono::seconds{nTime}};
 95      const auto days{std::chrono::floor<std::chrono::days>(secs)};
 96      const std::chrono::year_month_day ymd{days};
 97      return strprintf("%04i-%02u-%02u", signed{ymd.year()}, unsigned{ymd.month()}, unsigned{ymd.day()});
 98  }
 99  
100  std::optional<int64_t> ParseISO8601DateTime(std::string_view str)
101  {
102      constexpr auto FMT_SIZE{std::string_view{"2000-01-01T01:01:01Z"}.size()};
103      if (str.size() != FMT_SIZE || str[4] != '-' || str[7] != '-' || str[10] != 'T' || str[13] != ':' || str[16] != ':' || str[19] != 'Z') {
104          return {};
105      }
106      const auto year{ToIntegral<uint16_t>(str.substr(0, 4))};
107      const auto month{ToIntegral<uint8_t>(str.substr(5, 2))};
108      const auto day{ToIntegral<uint8_t>(str.substr(8, 2))};
109      const auto hour{ToIntegral<uint8_t>(str.substr(11, 2))};
110      const auto min{ToIntegral<uint8_t>(str.substr(14, 2))};
111      const auto sec{ToIntegral<uint8_t>(str.substr(17, 2))};
112      if (!year || !month || !day || !hour || !min || !sec) {
113          return {};
114      }
115      const std::chrono::year_month_day ymd{std::chrono::year{*year}, std::chrono::month{*month}, std::chrono::day{*day}};
116      if (!ymd.ok()) {
117          return {};
118      }
119      const auto time{std::chrono::hours{*hour} + std::chrono::minutes{*min} + std::chrono::seconds{*sec}};
120      const auto tp{std::chrono::sys_days{ymd} + time};
121      return int64_t{TicksSinceEpoch<std::chrono::seconds>(tp)};
122  }
123  
124  std::string FormatRFC1123DateTime(int64_t time)
125  {
126      if (time < -62167219200 || 253402300799 < time) {
127          // 4-digit year, so only support years 0 to 9999
128          return "";
129      }
130      const std::chrono::sys_seconds secs{std::chrono::seconds{time}};
131      const auto days{std::chrono::floor<std::chrono::days>(secs)};
132      const auto w{days.time_since_epoch().count() % 7}; // will be in the range [-6, 6]
133      std::string_view weekday{weekdays.at(w >= 0 ? w : w + 7)};
134      const std::chrono::year_month_day ymd{days};
135      std::string_view month{months.at(unsigned{ymd.month()} - 1)};
136      const std::chrono::hh_mm_ss hms{secs - days};
137      // examples: Mon, 27 Jul 2009 12:28:53 GMT
138      //           Fri, 31 May 2024 19:18:04 GMT
139      return strprintf("%03s, %02u %03s %04i %02i:%02i:%02i GMT", weekday, unsigned{ymd.day()}, month, signed{ymd.year()}, hms.hours().count(), hms.minutes().count(), hms.seconds().count());
140  }
141  
142  struct timeval MillisToTimeval(int64_t nTimeout)
143  {
144      struct timeval timeout;
145      timeout.tv_sec  = nTimeout / 1000;
146      timeout.tv_usec = (nTimeout % 1000) * 1000;
147      return timeout;
148  }
149  
150  struct timeval MillisToTimeval(std::chrono::milliseconds ms)
151  {
152      return MillisToTimeval(count_milliseconds(ms));
153  }