xref: /aosp_15_r20/external/openscreen/platform/impl/time.cc (revision 3f982cf4871df8771c9d4abe6e9a6f8d829b2736)
1*3f982cf4SFabien Sanglard // Copyright 2018 The Chromium Authors. All rights reserved.
2*3f982cf4SFabien Sanglard // Use of this source code is governed by a BSD-style license that can be
3*3f982cf4SFabien Sanglard // found in the LICENSE file.
4*3f982cf4SFabien Sanglard 
5*3f982cf4SFabien Sanglard #include "platform/api/time.h"
6*3f982cf4SFabien Sanglard 
7*3f982cf4SFabien Sanglard #include <chrono>
8*3f982cf4SFabien Sanglard #include <ctime>
9*3f982cf4SFabien Sanglard #include <ratio>
10*3f982cf4SFabien Sanglard 
11*3f982cf4SFabien Sanglard #include "util/chrono_helpers.h"
12*3f982cf4SFabien Sanglard #include "util/osp_logging.h"
13*3f982cf4SFabien Sanglard 
14*3f982cf4SFabien Sanglard using std::chrono::high_resolution_clock;
15*3f982cf4SFabien Sanglard using std::chrono::steady_clock;
16*3f982cf4SFabien Sanglard using std::chrono::system_clock;
17*3f982cf4SFabien Sanglard 
18*3f982cf4SFabien Sanglard namespace openscreen {
19*3f982cf4SFabien Sanglard 
now()20*3f982cf4SFabien Sanglard Clock::time_point Clock::now() noexcept {
21*3f982cf4SFabien Sanglard   constexpr bool can_use_steady_clock =
22*3f982cf4SFabien Sanglard       std::ratio_less_equal<steady_clock::period,
23*3f982cf4SFabien Sanglard                             Clock::kRequiredResolution>::value;
24*3f982cf4SFabien Sanglard   constexpr bool can_use_high_resolution_clock =
25*3f982cf4SFabien Sanglard       std::ratio_less_equal<high_resolution_clock::period,
26*3f982cf4SFabien Sanglard                             Clock::kRequiredResolution>::value &&
27*3f982cf4SFabien Sanglard       high_resolution_clock::is_steady;
28*3f982cf4SFabien Sanglard   static_assert(can_use_steady_clock || can_use_high_resolution_clock,
29*3f982cf4SFabien Sanglard                 "no suitable default clock on this platform");
30*3f982cf4SFabien Sanglard 
31*3f982cf4SFabien Sanglard   // Choose whether to use the steady_clock or the high_resolution_clock. The
32*3f982cf4SFabien Sanglard   // general assumption here is that steady_clock will be the lesser expensive
33*3f982cf4SFabien Sanglard   // to use. Only fall-back to high_resolution_clock if steady_clock does not
34*3f982cf4SFabien Sanglard   // meet the resolution requirement.
35*3f982cf4SFabien Sanglard   //
36*3f982cf4SFabien Sanglard   // Note: Most of the expression below should be reduced at compile-time (by
37*3f982cf4SFabien Sanglard   // any half-decent optimizing compiler), and so there won't be any branching
38*3f982cf4SFabien Sanglard   // or significant math actually taking place here.
39*3f982cf4SFabien Sanglard   if (can_use_steady_clock) {
40*3f982cf4SFabien Sanglard     return Clock::time_point(
41*3f982cf4SFabien Sanglard         Clock::to_duration(steady_clock::now().time_since_epoch()));
42*3f982cf4SFabien Sanglard   }
43*3f982cf4SFabien Sanglard   return Clock::time_point(
44*3f982cf4SFabien Sanglard       Clock::to_duration(high_resolution_clock::now().time_since_epoch()));
45*3f982cf4SFabien Sanglard }
46*3f982cf4SFabien Sanglard 
GetWallTimeSinceUnixEpoch()47*3f982cf4SFabien Sanglard std::chrono::seconds GetWallTimeSinceUnixEpoch() noexcept {
48*3f982cf4SFabien Sanglard   // Note: Even though std::time_t is not necessarily "seconds since UNIX epoch"
49*3f982cf4SFabien Sanglard   // before C++20, it is almost universally implemented that way on all
50*3f982cf4SFabien Sanglard   // platforms. There is a unit test to confirm this behavior, so don't worry
51*3f982cf4SFabien Sanglard   // about it here.
52*3f982cf4SFabien Sanglard   const std::time_t since_epoch = system_clock::to_time_t(system_clock::now());
53*3f982cf4SFabien Sanglard 
54*3f982cf4SFabien Sanglard   // std::time_t is unspecified by the spec. If it's only a 32-bit integer, it's
55*3f982cf4SFabien Sanglard   // possible that values will overflow in early 2038. Warn future developers a
56*3f982cf4SFabien Sanglard   // year ahead of time.
57*3f982cf4SFabien Sanglard   if (sizeof(std::time_t) <= 4) {
58*3f982cf4SFabien Sanglard     constexpr std::time_t a_year_before_overflow =
59*3f982cf4SFabien Sanglard         std::numeric_limits<std::time_t>::max() -
60*3f982cf4SFabien Sanglard         to_seconds(365 * hours(24)).count();
61*3f982cf4SFabien Sanglard     OSP_DCHECK_LE(since_epoch, a_year_before_overflow);
62*3f982cf4SFabien Sanglard   }
63*3f982cf4SFabien Sanglard 
64*3f982cf4SFabien Sanglard   return std::chrono::seconds(since_epoch);
65*3f982cf4SFabien Sanglard }
66*3f982cf4SFabien Sanglard 
67*3f982cf4SFabien Sanglard }  // namespace openscreen
68