1*6777b538SAndroid Build Coastguard Worker // Copyright 2012 The Chromium Authors
2*6777b538SAndroid Build Coastguard Worker // Use of this source code is governed by a BSD-style license that can be
3*6777b538SAndroid Build Coastguard Worker // found in the LICENSE file.
4*6777b538SAndroid Build Coastguard Worker
5*6777b538SAndroid Build Coastguard Worker // `Time` represents an absolute point in coordinated universal time (UTC),
6*6777b538SAndroid Build Coastguard Worker // internally represented as microseconds (s/1,000,000) since the Windows epoch
7*6777b538SAndroid Build Coastguard Worker // (1601-01-01 00:00:00 UTC). System-dependent clock interface routines are
8*6777b538SAndroid Build Coastguard Worker // defined in time_PLATFORM.cc. Note that values for `Time` may skew and jump
9*6777b538SAndroid Build Coastguard Worker // around as the operating system makes adjustments to synchronize (e.g., with
10*6777b538SAndroid Build Coastguard Worker // NTP servers). Thus, client code that uses the `Time` class must account for
11*6777b538SAndroid Build Coastguard Worker // this.
12*6777b538SAndroid Build Coastguard Worker //
13*6777b538SAndroid Build Coastguard Worker // `TimeDelta` represents a duration of time, internally represented in
14*6777b538SAndroid Build Coastguard Worker // microseconds.
15*6777b538SAndroid Build Coastguard Worker //
16*6777b538SAndroid Build Coastguard Worker // `TimeTicks` and `ThreadTicks` represent an abstract time that is most of the
17*6777b538SAndroid Build Coastguard Worker // time incrementing, for use in measuring time durations. Internally, they are
18*6777b538SAndroid Build Coastguard Worker // represented in microseconds. They cannot be converted to a human-readable
19*6777b538SAndroid Build Coastguard Worker // time, but are guaranteed not to decrease (unlike the `Time` class). Note
20*6777b538SAndroid Build Coastguard Worker // that `TimeTicks` may "stand still" (e.g., if the computer is suspended), and
21*6777b538SAndroid Build Coastguard Worker // `ThreadTicks` will "stand still" whenever the thread has been de-scheduled
22*6777b538SAndroid Build Coastguard Worker // by the operating system.
23*6777b538SAndroid Build Coastguard Worker //
24*6777b538SAndroid Build Coastguard Worker // All time classes are copyable, assignable, and occupy 64 bits per instance.
25*6777b538SAndroid Build Coastguard Worker // Prefer to pass them by value, e.g.:
26*6777b538SAndroid Build Coastguard Worker //
27*6777b538SAndroid Build Coastguard Worker // void MyFunction(TimeDelta arg);
28*6777b538SAndroid Build Coastguard Worker //
29*6777b538SAndroid Build Coastguard Worker // All time classes support `operator<<` with logging streams, e.g. `LOG(INFO)`.
30*6777b538SAndroid Build Coastguard Worker // For human-readable formatting, use //base/i18n/time_formatting.h.
31*6777b538SAndroid Build Coastguard Worker //
32*6777b538SAndroid Build Coastguard Worker // Example use cases for different time classes:
33*6777b538SAndroid Build Coastguard Worker //
34*6777b538SAndroid Build Coastguard Worker // Time: Interpreting the wall-clock time provided by a remote system.
35*6777b538SAndroid Build Coastguard Worker // Detecting whether cached resources have expired. Providing the
36*6777b538SAndroid Build Coastguard Worker // user with a display of the current date and time. Determining
37*6777b538SAndroid Build Coastguard Worker // the amount of time between events across re-boots of the
38*6777b538SAndroid Build Coastguard Worker // machine.
39*6777b538SAndroid Build Coastguard Worker //
40*6777b538SAndroid Build Coastguard Worker // TimeTicks: Tracking the amount of time a task runs. Executing delayed
41*6777b538SAndroid Build Coastguard Worker // tasks at the right time. Computing presentation timestamps.
42*6777b538SAndroid Build Coastguard Worker // Synchronizing audio and video using TimeTicks as a common
43*6777b538SAndroid Build Coastguard Worker // reference clock (lip-sync). Measuring network round-trip
44*6777b538SAndroid Build Coastguard Worker // latency.
45*6777b538SAndroid Build Coastguard Worker //
46*6777b538SAndroid Build Coastguard Worker // ThreadTicks: Benchmarking how long the current thread has been doing actual
47*6777b538SAndroid Build Coastguard Worker // work.
48*6777b538SAndroid Build Coastguard Worker //
49*6777b538SAndroid Build Coastguard Worker // Serialization:
50*6777b538SAndroid Build Coastguard Worker //
51*6777b538SAndroid Build Coastguard Worker // Use the helpers in //base/json/values_util.h when serializing `Time`
52*6777b538SAndroid Build Coastguard Worker // or `TimeDelta` to/from `base::Value`.
53*6777b538SAndroid Build Coastguard Worker //
54*6777b538SAndroid Build Coastguard Worker // Otherwise:
55*6777b538SAndroid Build Coastguard Worker //
56*6777b538SAndroid Build Coastguard Worker // - Time: use `FromDeltaSinceWindowsEpoch()`/`ToDeltaSinceWindowsEpoch()`.
57*6777b538SAndroid Build Coastguard Worker // - TimeDelta: use `base::Microseconds()`/`InMicroseconds()`.
58*6777b538SAndroid Build Coastguard Worker //
59*6777b538SAndroid Build Coastguard Worker // `TimeTicks` and `ThreadTicks` do not have a stable origin; serialization for
60*6777b538SAndroid Build Coastguard Worker // the purpose of persistence is not supported.
61*6777b538SAndroid Build Coastguard Worker
62*6777b538SAndroid Build Coastguard Worker #ifndef BASE_TIME_TIME_H_
63*6777b538SAndroid Build Coastguard Worker #define BASE_TIME_TIME_H_
64*6777b538SAndroid Build Coastguard Worker
65*6777b538SAndroid Build Coastguard Worker #include <stdint.h>
66*6777b538SAndroid Build Coastguard Worker #include <time.h>
67*6777b538SAndroid Build Coastguard Worker
68*6777b538SAndroid Build Coastguard Worker #include <compare>
69*6777b538SAndroid Build Coastguard Worker #include <concepts>
70*6777b538SAndroid Build Coastguard Worker #include <iosfwd>
71*6777b538SAndroid Build Coastguard Worker #include <limits>
72*6777b538SAndroid Build Coastguard Worker #include <ostream>
73*6777b538SAndroid Build Coastguard Worker #include <type_traits>
74*6777b538SAndroid Build Coastguard Worker
75*6777b538SAndroid Build Coastguard Worker #include "base/base_export.h"
76*6777b538SAndroid Build Coastguard Worker #include "base/check.h"
77*6777b538SAndroid Build Coastguard Worker #include "base/check_op.h"
78*6777b538SAndroid Build Coastguard Worker #include "base/compiler_specific.h"
79*6777b538SAndroid Build Coastguard Worker #include "base/numerics/clamped_math.h"
80*6777b538SAndroid Build Coastguard Worker #include "build/build_config.h"
81*6777b538SAndroid Build Coastguard Worker #include "build/chromeos_buildflags.h"
82*6777b538SAndroid Build Coastguard Worker
83*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_FUCHSIA)
84*6777b538SAndroid Build Coastguard Worker #include <zircon/types.h>
85*6777b538SAndroid Build Coastguard Worker #endif
86*6777b538SAndroid Build Coastguard Worker
87*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_APPLE)
88*6777b538SAndroid Build Coastguard Worker #include <CoreFoundation/CoreFoundation.h>
89*6777b538SAndroid Build Coastguard Worker #include <mach/mach_time.h>
90*6777b538SAndroid Build Coastguard Worker // Avoid Mac system header macro leak.
91*6777b538SAndroid Build Coastguard Worker #undef TYPE_BOOL
92*6777b538SAndroid Build Coastguard Worker #endif
93*6777b538SAndroid Build Coastguard Worker
94*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_ANDROID)
95*6777b538SAndroid Build Coastguard Worker #include <jni.h>
96*6777b538SAndroid Build Coastguard Worker #endif
97*6777b538SAndroid Build Coastguard Worker
98*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
99*6777b538SAndroid Build Coastguard Worker #include <unistd.h>
100*6777b538SAndroid Build Coastguard Worker #include <sys/time.h>
101*6777b538SAndroid Build Coastguard Worker #endif
102*6777b538SAndroid Build Coastguard Worker
103*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
104*6777b538SAndroid Build Coastguard Worker #include "base/gtest_prod_util.h"
105*6777b538SAndroid Build Coastguard Worker #include "base/win/windows_types.h"
106*6777b538SAndroid Build Coastguard Worker
107*6777b538SAndroid Build Coastguard Worker namespace ABI {
108*6777b538SAndroid Build Coastguard Worker namespace Windows {
109*6777b538SAndroid Build Coastguard Worker namespace Foundation {
110*6777b538SAndroid Build Coastguard Worker struct DateTime;
111*6777b538SAndroid Build Coastguard Worker struct TimeSpan;
112*6777b538SAndroid Build Coastguard Worker } // namespace Foundation
113*6777b538SAndroid Build Coastguard Worker } // namespace Windows
114*6777b538SAndroid Build Coastguard Worker } // namespace ABI
115*6777b538SAndroid Build Coastguard Worker #endif
116*6777b538SAndroid Build Coastguard Worker
117*6777b538SAndroid Build Coastguard Worker namespace base {
118*6777b538SAndroid Build Coastguard Worker
119*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
120*6777b538SAndroid Build Coastguard Worker class PlatformThreadHandle;
121*6777b538SAndroid Build Coastguard Worker #endif
122*6777b538SAndroid Build Coastguard Worker class TimeDelta;
123*6777b538SAndroid Build Coastguard Worker
124*6777b538SAndroid Build Coastguard Worker template <typename T>
125*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta Microseconds(T n);
126*6777b538SAndroid Build Coastguard Worker
127*6777b538SAndroid Build Coastguard Worker namespace {
128*6777b538SAndroid Build Coastguard Worker
129*6777b538SAndroid Build Coastguard Worker // TODO: Replace usage of this with std::isnan() once Chromium uses C++23,
130*6777b538SAndroid Build Coastguard Worker // where that is constexpr.
isnan(double d)131*6777b538SAndroid Build Coastguard Worker constexpr bool isnan(double d) {
132*6777b538SAndroid Build Coastguard Worker return d != d;
133*6777b538SAndroid Build Coastguard Worker }
134*6777b538SAndroid Build Coastguard Worker
135*6777b538SAndroid Build Coastguard Worker }
136*6777b538SAndroid Build Coastguard Worker
137*6777b538SAndroid Build Coastguard Worker // TimeDelta ------------------------------------------------------------------
138*6777b538SAndroid Build Coastguard Worker
139*6777b538SAndroid Build Coastguard Worker class BASE_EXPORT TimeDelta {
140*6777b538SAndroid Build Coastguard Worker public:
141*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta() = default;
142*6777b538SAndroid Build Coastguard Worker
143*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
144*6777b538SAndroid Build Coastguard Worker static TimeDelta FromQPCValue(LONGLONG qpc_value);
145*6777b538SAndroid Build Coastguard Worker // TODO(crbug.com/989694): Avoid base::TimeDelta factory functions
146*6777b538SAndroid Build Coastguard Worker // based on absolute time
147*6777b538SAndroid Build Coastguard Worker static TimeDelta FromFileTime(FILETIME ft);
148*6777b538SAndroid Build Coastguard Worker static TimeDelta FromWinrtDateTime(ABI::Windows::Foundation::DateTime dt);
149*6777b538SAndroid Build Coastguard Worker static TimeDelta FromWinrtTimeSpan(ABI::Windows::Foundation::TimeSpan ts);
150*6777b538SAndroid Build Coastguard Worker #elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
151*6777b538SAndroid Build Coastguard Worker static TimeDelta FromTimeSpec(const timespec& ts);
152*6777b538SAndroid Build Coastguard Worker #endif
153*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_FUCHSIA)
154*6777b538SAndroid Build Coastguard Worker static TimeDelta FromZxDuration(zx_duration_t nanos);
155*6777b538SAndroid Build Coastguard Worker #endif
156*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_APPLE)
157*6777b538SAndroid Build Coastguard Worker static TimeDelta FromMachTime(uint64_t mach_time);
158*6777b538SAndroid Build Coastguard Worker #endif // BUILDFLAG(IS_APPLE)
159*6777b538SAndroid Build Coastguard Worker
160*6777b538SAndroid Build Coastguard Worker // Converts an integer value representing TimeDelta to a class. This is used
161*6777b538SAndroid Build Coastguard Worker // when deserializing a |TimeDelta| structure, using a value known to be
162*6777b538SAndroid Build Coastguard Worker // compatible. It is not provided as a constructor because the integer type
163*6777b538SAndroid Build Coastguard Worker // may be unclear from the perspective of a caller.
164*6777b538SAndroid Build Coastguard Worker //
165*6777b538SAndroid Build Coastguard Worker // DEPRECATED - Do not use in new code. http://crbug.com/634507
FromInternalValue(int64_t delta)166*6777b538SAndroid Build Coastguard Worker static constexpr TimeDelta FromInternalValue(int64_t delta) {
167*6777b538SAndroid Build Coastguard Worker return TimeDelta(delta);
168*6777b538SAndroid Build Coastguard Worker }
169*6777b538SAndroid Build Coastguard Worker
170*6777b538SAndroid Build Coastguard Worker // Returns the maximum time delta, which should be greater than any reasonable
171*6777b538SAndroid Build Coastguard Worker // time delta we might compare it to. If converted to double with ToDouble()
172*6777b538SAndroid Build Coastguard Worker // it becomes an IEEE double infinity. Use FiniteMax() if you want a very
173*6777b538SAndroid Build Coastguard Worker // large number that doesn't do this. TimeDelta math saturates at the end
174*6777b538SAndroid Build Coastguard Worker // points so adding to TimeDelta::Max() leaves the value unchanged.
175*6777b538SAndroid Build Coastguard Worker // Subtracting should leave the value unchanged but currently changes it
176*6777b538SAndroid Build Coastguard Worker // TODO(https://crbug.com/869387).
177*6777b538SAndroid Build Coastguard Worker static constexpr TimeDelta Max();
178*6777b538SAndroid Build Coastguard Worker
179*6777b538SAndroid Build Coastguard Worker // Returns the minimum time delta, which should be less than than any
180*6777b538SAndroid Build Coastguard Worker // reasonable time delta we might compare it to. For more details see the
181*6777b538SAndroid Build Coastguard Worker // comments for Max().
182*6777b538SAndroid Build Coastguard Worker static constexpr TimeDelta Min();
183*6777b538SAndroid Build Coastguard Worker
184*6777b538SAndroid Build Coastguard Worker // Returns the maximum time delta which is not equivalent to infinity. Only
185*6777b538SAndroid Build Coastguard Worker // subtracting a finite time delta from this time delta has a defined result.
186*6777b538SAndroid Build Coastguard Worker static constexpr TimeDelta FiniteMax();
187*6777b538SAndroid Build Coastguard Worker
188*6777b538SAndroid Build Coastguard Worker // Returns the minimum time delta which is not equivalent to -infinity. Only
189*6777b538SAndroid Build Coastguard Worker // adding a finite time delta to this time delta has a defined result.
190*6777b538SAndroid Build Coastguard Worker static constexpr TimeDelta FiniteMin();
191*6777b538SAndroid Build Coastguard Worker
192*6777b538SAndroid Build Coastguard Worker // Returns the internal numeric value of the TimeDelta object. Please don't
193*6777b538SAndroid Build Coastguard Worker // use this and do arithmetic on it, as it is more error prone than using the
194*6777b538SAndroid Build Coastguard Worker // provided operators.
195*6777b538SAndroid Build Coastguard Worker // For serializing, use FromInternalValue to reconstitute.
196*6777b538SAndroid Build Coastguard Worker //
197*6777b538SAndroid Build Coastguard Worker // DEPRECATED - Do not use in new code. http://crbug.com/634507
ToInternalValue()198*6777b538SAndroid Build Coastguard Worker constexpr int64_t ToInternalValue() const { return delta_; }
199*6777b538SAndroid Build Coastguard Worker
200*6777b538SAndroid Build Coastguard Worker // Returns the magnitude (absolute value) of this TimeDelta.
magnitude()201*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta magnitude() const { return TimeDelta(delta_.Abs()); }
202*6777b538SAndroid Build Coastguard Worker
203*6777b538SAndroid Build Coastguard Worker // Returns true if the time delta is a zero, positive or negative time delta.
is_zero()204*6777b538SAndroid Build Coastguard Worker constexpr bool is_zero() const { return delta_ == 0; }
is_positive()205*6777b538SAndroid Build Coastguard Worker constexpr bool is_positive() const { return delta_ > 0; }
is_negative()206*6777b538SAndroid Build Coastguard Worker constexpr bool is_negative() const { return delta_ < 0; }
207*6777b538SAndroid Build Coastguard Worker
208*6777b538SAndroid Build Coastguard Worker // Returns true if the time delta is the maximum/minimum time delta.
is_max()209*6777b538SAndroid Build Coastguard Worker constexpr bool is_max() const { return *this == Max(); }
is_min()210*6777b538SAndroid Build Coastguard Worker constexpr bool is_min() const { return *this == Min(); }
is_inf()211*6777b538SAndroid Build Coastguard Worker constexpr bool is_inf() const { return is_min() || is_max(); }
212*6777b538SAndroid Build Coastguard Worker
213*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
214*6777b538SAndroid Build Coastguard Worker struct timespec ToTimeSpec() const;
215*6777b538SAndroid Build Coastguard Worker #endif
216*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_FUCHSIA)
217*6777b538SAndroid Build Coastguard Worker zx_duration_t ToZxDuration() const;
218*6777b538SAndroid Build Coastguard Worker #endif
219*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
220*6777b538SAndroid Build Coastguard Worker ABI::Windows::Foundation::DateTime ToWinrtDateTime() const;
221*6777b538SAndroid Build Coastguard Worker ABI::Windows::Foundation::TimeSpan ToWinrtTimeSpan() const;
222*6777b538SAndroid Build Coastguard Worker #endif
223*6777b538SAndroid Build Coastguard Worker
224*6777b538SAndroid Build Coastguard Worker // Returns the frequency in Hertz (cycles per second) that has a period of
225*6777b538SAndroid Build Coastguard Worker // *this.
226*6777b538SAndroid Build Coastguard Worker constexpr double ToHz() const;
227*6777b538SAndroid Build Coastguard Worker
228*6777b538SAndroid Build Coastguard Worker // Returns the time delta in some unit. Minimum argument values return as
229*6777b538SAndroid Build Coastguard Worker // -inf for doubles and min type values otherwise. Maximum ones are treated as
230*6777b538SAndroid Build Coastguard Worker // +inf for doubles and max type values otherwise. Their results will produce
231*6777b538SAndroid Build Coastguard Worker // an is_min() or is_max() TimeDelta. The InXYZF versions return a floating
232*6777b538SAndroid Build Coastguard Worker // point value. The InXYZ versions return a truncated value (aka rounded
233*6777b538SAndroid Build Coastguard Worker // towards zero, std::trunc() behavior). The InXYZFloored() versions round to
234*6777b538SAndroid Build Coastguard Worker // lesser integers (std::floor() behavior). The XYZRoundedUp() versions round
235*6777b538SAndroid Build Coastguard Worker // up to greater integers (std::ceil() behavior). WARNING: Floating point
236*6777b538SAndroid Build Coastguard Worker // arithmetic is such that XXX(t.InXXXF()) may not precisely equal |t|.
237*6777b538SAndroid Build Coastguard Worker // Hence, floating point values should not be used for storage.
238*6777b538SAndroid Build Coastguard Worker constexpr int InDays() const;
239*6777b538SAndroid Build Coastguard Worker constexpr int InDaysFloored() const;
240*6777b538SAndroid Build Coastguard Worker constexpr int InHours() const;
241*6777b538SAndroid Build Coastguard Worker constexpr int InMinutes() const;
242*6777b538SAndroid Build Coastguard Worker constexpr double InSecondsF() const;
243*6777b538SAndroid Build Coastguard Worker constexpr int64_t InSeconds() const;
244*6777b538SAndroid Build Coastguard Worker constexpr int64_t InSecondsFloored() const;
245*6777b538SAndroid Build Coastguard Worker constexpr double InMillisecondsF() const;
246*6777b538SAndroid Build Coastguard Worker constexpr int64_t InMilliseconds() const;
247*6777b538SAndroid Build Coastguard Worker constexpr int64_t InMillisecondsRoundedUp() const;
InMicroseconds()248*6777b538SAndroid Build Coastguard Worker constexpr int64_t InMicroseconds() const { return delta_; }
249*6777b538SAndroid Build Coastguard Worker constexpr double InMicrosecondsF() const;
250*6777b538SAndroid Build Coastguard Worker constexpr int64_t InNanoseconds() const;
251*6777b538SAndroid Build Coastguard Worker
252*6777b538SAndroid Build Coastguard Worker // Computations with other deltas.
253*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta operator+(TimeDelta other) const;
254*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta operator-(TimeDelta other) const;
255*6777b538SAndroid Build Coastguard Worker
256*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta& operator+=(TimeDelta other) {
257*6777b538SAndroid Build Coastguard Worker return *this = (*this + other);
258*6777b538SAndroid Build Coastguard Worker }
259*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta& operator-=(TimeDelta other) {
260*6777b538SAndroid Build Coastguard Worker return *this = (*this - other);
261*6777b538SAndroid Build Coastguard Worker }
262*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta operator-() const {
263*6777b538SAndroid Build Coastguard Worker if (!is_inf())
264*6777b538SAndroid Build Coastguard Worker return TimeDelta(-delta_);
265*6777b538SAndroid Build Coastguard Worker return (delta_ < 0) ? Max() : Min();
266*6777b538SAndroid Build Coastguard Worker }
267*6777b538SAndroid Build Coastguard Worker
268*6777b538SAndroid Build Coastguard Worker // Computations with numeric types.
269*6777b538SAndroid Build Coastguard Worker template <typename T>
270*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta operator*(T a) const {
271*6777b538SAndroid Build Coastguard Worker return TimeDelta(int64_t{delta_ * a});
272*6777b538SAndroid Build Coastguard Worker }
273*6777b538SAndroid Build Coastguard Worker template <typename T>
274*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta operator/(T a) const {
275*6777b538SAndroid Build Coastguard Worker return TimeDelta(int64_t{delta_ / a});
276*6777b538SAndroid Build Coastguard Worker }
277*6777b538SAndroid Build Coastguard Worker template <typename T>
278*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta& operator*=(T a) {
279*6777b538SAndroid Build Coastguard Worker return *this = (*this * a);
280*6777b538SAndroid Build Coastguard Worker }
281*6777b538SAndroid Build Coastguard Worker template <typename T>
282*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta& operator/=(T a) {
283*6777b538SAndroid Build Coastguard Worker return *this = (*this / a);
284*6777b538SAndroid Build Coastguard Worker }
285*6777b538SAndroid Build Coastguard Worker
286*6777b538SAndroid Build Coastguard Worker // This does floating-point division. For an integer result, either call
287*6777b538SAndroid Build Coastguard Worker // IntDiv(), or (possibly clearer) use this operator with
288*6777b538SAndroid Build Coastguard Worker // base::Clamp{Ceil,Floor,Round}() or base::saturated_cast() (for truncation).
289*6777b538SAndroid Build Coastguard Worker // Note that converting to double here drops precision to 53 bits.
290*6777b538SAndroid Build Coastguard Worker constexpr double operator/(TimeDelta a) const {
291*6777b538SAndroid Build Coastguard Worker // 0/0 and inf/inf (any combination of positive and negative) are invalid
292*6777b538SAndroid Build Coastguard Worker // (they are almost certainly not intentional, and result in NaN, which
293*6777b538SAndroid Build Coastguard Worker // turns into 0 if clamped to an integer; this makes introducing subtle bugs
294*6777b538SAndroid Build Coastguard Worker // too easy).
295*6777b538SAndroid Build Coastguard Worker CHECK(!is_zero() || !a.is_zero());
296*6777b538SAndroid Build Coastguard Worker CHECK(!is_inf() || !a.is_inf());
297*6777b538SAndroid Build Coastguard Worker
298*6777b538SAndroid Build Coastguard Worker return ToDouble() / a.ToDouble();
299*6777b538SAndroid Build Coastguard Worker }
IntDiv(TimeDelta a)300*6777b538SAndroid Build Coastguard Worker constexpr int64_t IntDiv(TimeDelta a) const {
301*6777b538SAndroid Build Coastguard Worker if (!is_inf() && !a.is_zero())
302*6777b538SAndroid Build Coastguard Worker return int64_t{delta_ / a.delta_};
303*6777b538SAndroid Build Coastguard Worker
304*6777b538SAndroid Build Coastguard Worker // For consistency, use the same edge case CHECKs and behavior as the code
305*6777b538SAndroid Build Coastguard Worker // above.
306*6777b538SAndroid Build Coastguard Worker CHECK(!is_zero() || !a.is_zero());
307*6777b538SAndroid Build Coastguard Worker CHECK(!is_inf() || !a.is_inf());
308*6777b538SAndroid Build Coastguard Worker return ((delta_ < 0) == (a.delta_ < 0))
309*6777b538SAndroid Build Coastguard Worker ? std::numeric_limits<int64_t>::max()
310*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<int64_t>::min();
311*6777b538SAndroid Build Coastguard Worker }
312*6777b538SAndroid Build Coastguard Worker
313*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta operator%(TimeDelta a) const {
314*6777b538SAndroid Build Coastguard Worker return TimeDelta(
315*6777b538SAndroid Build Coastguard Worker (is_inf() || a.is_zero() || a.is_inf()) ? delta_ : (delta_ % a.delta_));
316*6777b538SAndroid Build Coastguard Worker }
317*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta& operator%=(TimeDelta other) {
318*6777b538SAndroid Build Coastguard Worker return *this = (*this % other);
319*6777b538SAndroid Build Coastguard Worker }
320*6777b538SAndroid Build Coastguard Worker
321*6777b538SAndroid Build Coastguard Worker // Comparison operators.
322*6777b538SAndroid Build Coastguard Worker friend constexpr bool operator==(TimeDelta, TimeDelta) = default;
323*6777b538SAndroid Build Coastguard Worker friend constexpr std::strong_ordering operator<=>(TimeDelta,
324*6777b538SAndroid Build Coastguard Worker TimeDelta) = default;
325*6777b538SAndroid Build Coastguard Worker
326*6777b538SAndroid Build Coastguard Worker // Returns this delta, ceiled/floored/rounded-away-from-zero to the nearest
327*6777b538SAndroid Build Coastguard Worker // multiple of |interval|.
328*6777b538SAndroid Build Coastguard Worker TimeDelta CeilToMultiple(TimeDelta interval) const;
329*6777b538SAndroid Build Coastguard Worker TimeDelta FloorToMultiple(TimeDelta interval) const;
330*6777b538SAndroid Build Coastguard Worker TimeDelta RoundToMultiple(TimeDelta interval) const;
331*6777b538SAndroid Build Coastguard Worker
332*6777b538SAndroid Build Coastguard Worker private:
333*6777b538SAndroid Build Coastguard Worker // Constructs a delta given the duration in microseconds. This is private
334*6777b538SAndroid Build Coastguard Worker // to avoid confusion by callers with an integer constructor. Use
335*6777b538SAndroid Build Coastguard Worker // base::Seconds, base::Milliseconds, etc. instead.
TimeDelta(int64_t delta_us)336*6777b538SAndroid Build Coastguard Worker constexpr explicit TimeDelta(int64_t delta_us) : delta_(delta_us) {}
TimeDelta(ClampedNumeric<int64_t> delta_us)337*6777b538SAndroid Build Coastguard Worker constexpr explicit TimeDelta(ClampedNumeric<int64_t> delta_us)
338*6777b538SAndroid Build Coastguard Worker : delta_(delta_us) {}
339*6777b538SAndroid Build Coastguard Worker
340*6777b538SAndroid Build Coastguard Worker // Returns a double representation of this TimeDelta's tick count. In
341*6777b538SAndroid Build Coastguard Worker // particular, Max()/Min() are converted to +/-infinity.
ToDouble()342*6777b538SAndroid Build Coastguard Worker constexpr double ToDouble() const {
343*6777b538SAndroid Build Coastguard Worker if (!is_inf())
344*6777b538SAndroid Build Coastguard Worker return static_cast<double>(delta_);
345*6777b538SAndroid Build Coastguard Worker return (delta_ < 0) ? -std::numeric_limits<double>::infinity()
346*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<double>::infinity();
347*6777b538SAndroid Build Coastguard Worker }
348*6777b538SAndroid Build Coastguard Worker
349*6777b538SAndroid Build Coastguard Worker // Delta in microseconds.
350*6777b538SAndroid Build Coastguard Worker ClampedNumeric<int64_t> delta_ = 0;
351*6777b538SAndroid Build Coastguard Worker };
352*6777b538SAndroid Build Coastguard Worker
353*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta TimeDelta::operator+(TimeDelta other) const {
354*6777b538SAndroid Build Coastguard Worker if (!other.is_inf())
355*6777b538SAndroid Build Coastguard Worker return TimeDelta(delta_ + other.delta_);
356*6777b538SAndroid Build Coastguard Worker
357*6777b538SAndroid Build Coastguard Worker // Additions involving two infinities are only valid if signs match.
358*6777b538SAndroid Build Coastguard Worker CHECK(!is_inf() || (delta_ == other.delta_));
359*6777b538SAndroid Build Coastguard Worker return other;
360*6777b538SAndroid Build Coastguard Worker }
361*6777b538SAndroid Build Coastguard Worker
362*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta TimeDelta::operator-(TimeDelta other) const {
363*6777b538SAndroid Build Coastguard Worker if (!other.is_inf())
364*6777b538SAndroid Build Coastguard Worker return TimeDelta(delta_ - other.delta_);
365*6777b538SAndroid Build Coastguard Worker
366*6777b538SAndroid Build Coastguard Worker // Subtractions involving two infinities are only valid if signs differ.
367*6777b538SAndroid Build Coastguard Worker CHECK_NE(int64_t{delta_}, int64_t{other.delta_});
368*6777b538SAndroid Build Coastguard Worker return (other.delta_ < 0) ? Max() : Min();
369*6777b538SAndroid Build Coastguard Worker }
370*6777b538SAndroid Build Coastguard Worker
371*6777b538SAndroid Build Coastguard Worker template <typename T>
372*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta operator*(T a, TimeDelta td) {
373*6777b538SAndroid Build Coastguard Worker return td * a;
374*6777b538SAndroid Build Coastguard Worker }
375*6777b538SAndroid Build Coastguard Worker
376*6777b538SAndroid Build Coastguard Worker // For logging use only.
377*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::ostream& operator<<(std::ostream& os, TimeDelta time_delta);
378*6777b538SAndroid Build Coastguard Worker
379*6777b538SAndroid Build Coastguard Worker // TimeBase--------------------------------------------------------------------
380*6777b538SAndroid Build Coastguard Worker
381*6777b538SAndroid Build Coastguard Worker // Do not reference the time_internal::TimeBase template class directly. Please
382*6777b538SAndroid Build Coastguard Worker // use one of the time subclasses instead, and only reference the public
383*6777b538SAndroid Build Coastguard Worker // TimeBase members via those classes.
384*6777b538SAndroid Build Coastguard Worker namespace time_internal {
385*6777b538SAndroid Build Coastguard Worker
386*6777b538SAndroid Build Coastguard Worker // Provides value storage and comparison/math operations common to all time
387*6777b538SAndroid Build Coastguard Worker // classes. Each subclass provides for strong type-checking to ensure
388*6777b538SAndroid Build Coastguard Worker // semantically meaningful comparison/math of time values from the same clock
389*6777b538SAndroid Build Coastguard Worker // source or timeline.
390*6777b538SAndroid Build Coastguard Worker template<class TimeClass>
391*6777b538SAndroid Build Coastguard Worker class TimeBase {
392*6777b538SAndroid Build Coastguard Worker public:
393*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kHoursPerDay = 24;
394*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kSecondsPerMinute = 60;
395*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kMinutesPerHour = 60;
396*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kSecondsPerHour =
397*6777b538SAndroid Build Coastguard Worker kSecondsPerMinute * kMinutesPerHour;
398*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kMillisecondsPerSecond = 1000;
399*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kMillisecondsPerDay =
400*6777b538SAndroid Build Coastguard Worker kMillisecondsPerSecond * kSecondsPerHour * kHoursPerDay;
401*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kMicrosecondsPerMillisecond = 1000;
402*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kMicrosecondsPerSecond =
403*6777b538SAndroid Build Coastguard Worker kMicrosecondsPerMillisecond * kMillisecondsPerSecond;
404*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kMicrosecondsPerMinute =
405*6777b538SAndroid Build Coastguard Worker kMicrosecondsPerSecond * kSecondsPerMinute;
406*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kMicrosecondsPerHour =
407*6777b538SAndroid Build Coastguard Worker kMicrosecondsPerMinute * kMinutesPerHour;
408*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kMicrosecondsPerDay =
409*6777b538SAndroid Build Coastguard Worker kMicrosecondsPerHour * kHoursPerDay;
410*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kMicrosecondsPerWeek = kMicrosecondsPerDay * 7;
411*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kNanosecondsPerMicrosecond = 1000;
412*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kNanosecondsPerSecond =
413*6777b538SAndroid Build Coastguard Worker kNanosecondsPerMicrosecond * kMicrosecondsPerSecond;
414*6777b538SAndroid Build Coastguard Worker
415*6777b538SAndroid Build Coastguard Worker // TODO(https://crbug.com/1392437): Remove concept of "null" from base::Time.
416*6777b538SAndroid Build Coastguard Worker //
417*6777b538SAndroid Build Coastguard Worker // Warning: Be careful when writing code that performs math on time values,
418*6777b538SAndroid Build Coastguard Worker // since it's possible to produce a valid "zero" result that should not be
419*6777b538SAndroid Build Coastguard Worker // interpreted as a "null" value. If you find yourself using this method or
420*6777b538SAndroid Build Coastguard Worker // the zero-arg default constructor, please consider using an optional to
421*6777b538SAndroid Build Coastguard Worker // express the null state.
422*6777b538SAndroid Build Coastguard Worker //
423*6777b538SAndroid Build Coastguard Worker // Returns true if this object has not been initialized (probably).
is_null()424*6777b538SAndroid Build Coastguard Worker constexpr bool is_null() const { return us_ == 0; }
425*6777b538SAndroid Build Coastguard Worker
426*6777b538SAndroid Build Coastguard Worker // Returns true if this object represents the maximum/minimum time.
is_max()427*6777b538SAndroid Build Coastguard Worker constexpr bool is_max() const { return *this == Max(); }
is_min()428*6777b538SAndroid Build Coastguard Worker constexpr bool is_min() const { return *this == Min(); }
is_inf()429*6777b538SAndroid Build Coastguard Worker constexpr bool is_inf() const { return is_min() || is_max(); }
430*6777b538SAndroid Build Coastguard Worker
431*6777b538SAndroid Build Coastguard Worker // Returns the maximum/minimum times, which should be greater/less than than
432*6777b538SAndroid Build Coastguard Worker // any reasonable time with which we might compare it.
Max()433*6777b538SAndroid Build Coastguard Worker static constexpr TimeClass Max() {
434*6777b538SAndroid Build Coastguard Worker return TimeClass(std::numeric_limits<int64_t>::max());
435*6777b538SAndroid Build Coastguard Worker }
436*6777b538SAndroid Build Coastguard Worker
Min()437*6777b538SAndroid Build Coastguard Worker static constexpr TimeClass Min() {
438*6777b538SAndroid Build Coastguard Worker return TimeClass(std::numeric_limits<int64_t>::min());
439*6777b538SAndroid Build Coastguard Worker }
440*6777b538SAndroid Build Coastguard Worker
441*6777b538SAndroid Build Coastguard Worker // For legacy serialization only. When serializing to `base::Value`, prefer
442*6777b538SAndroid Build Coastguard Worker // the helpers from //base/json/values_util.h instead. Otherwise, use
443*6777b538SAndroid Build Coastguard Worker // `Time::ToDeltaSinceWindowsEpoch()` for `Time` and
444*6777b538SAndroid Build Coastguard Worker // `TimeDelta::InMicroseconds()` for `TimeDelta`. See http://crbug.com/634507.
ToInternalValue()445*6777b538SAndroid Build Coastguard Worker constexpr int64_t ToInternalValue() const { return us_; }
446*6777b538SAndroid Build Coastguard Worker
447*6777b538SAndroid Build Coastguard Worker // The amount of time since the origin (or "zero") point. This is a syntactic
448*6777b538SAndroid Build Coastguard Worker // convenience to aid in code readability, mainly for debugging/testing use
449*6777b538SAndroid Build Coastguard Worker // cases.
450*6777b538SAndroid Build Coastguard Worker //
451*6777b538SAndroid Build Coastguard Worker // Warning: While the Time subclass has a fixed origin point, the origin for
452*6777b538SAndroid Build Coastguard Worker // the other subclasses can vary each time the application is restarted.
453*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta since_origin() const;
454*6777b538SAndroid Build Coastguard Worker
455*6777b538SAndroid Build Coastguard Worker // Compute the difference between two times.
456*6777b538SAndroid Build Coastguard Worker #if !defined(__aarch64__) && BUILDFLAG(IS_ANDROID)
457*6777b538SAndroid Build Coastguard Worker NOINLINE // https://crbug.com/1369775
458*6777b538SAndroid Build Coastguard Worker #endif
459*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta operator-(const TimeBase<TimeClass>& other) const;
460*6777b538SAndroid Build Coastguard Worker
461*6777b538SAndroid Build Coastguard Worker // Return a new time modified by some delta.
462*6777b538SAndroid Build Coastguard Worker constexpr TimeClass operator+(TimeDelta delta) const;
463*6777b538SAndroid Build Coastguard Worker constexpr TimeClass operator-(TimeDelta delta) const;
464*6777b538SAndroid Build Coastguard Worker
465*6777b538SAndroid Build Coastguard Worker // Modify by some time delta.
466*6777b538SAndroid Build Coastguard Worker constexpr TimeClass& operator+=(TimeDelta delta) {
467*6777b538SAndroid Build Coastguard Worker return static_cast<TimeClass&>(*this = (*this + delta));
468*6777b538SAndroid Build Coastguard Worker }
469*6777b538SAndroid Build Coastguard Worker constexpr TimeClass& operator-=(TimeDelta delta) {
470*6777b538SAndroid Build Coastguard Worker return static_cast<TimeClass&>(*this = (*this - delta));
471*6777b538SAndroid Build Coastguard Worker }
472*6777b538SAndroid Build Coastguard Worker
473*6777b538SAndroid Build Coastguard Worker // Comparison operators
474*6777b538SAndroid Build Coastguard Worker friend constexpr bool operator==(const TimeBase&, const TimeBase&) = default;
475*6777b538SAndroid Build Coastguard Worker friend constexpr std::strong_ordering operator<=>(const TimeBase&,
476*6777b538SAndroid Build Coastguard Worker const TimeBase&) = default;
477*6777b538SAndroid Build Coastguard Worker
478*6777b538SAndroid Build Coastguard Worker protected:
TimeBase(int64_t us)479*6777b538SAndroid Build Coastguard Worker constexpr explicit TimeBase(int64_t us) : us_(us) {}
480*6777b538SAndroid Build Coastguard Worker
481*6777b538SAndroid Build Coastguard Worker // Time value in a microsecond timebase.
482*6777b538SAndroid Build Coastguard Worker ClampedNumeric<int64_t> us_;
483*6777b538SAndroid Build Coastguard Worker };
484*6777b538SAndroid Build Coastguard Worker
485*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
486*6777b538SAndroid Build Coastguard Worker #if defined(ARCH_CPU_ARM64)
487*6777b538SAndroid Build Coastguard Worker // TSCTicksPerSecond is not supported on Windows on Arm systems because the
488*6777b538SAndroid Build Coastguard Worker // cycle-counting methods use the actual CPU cycle count, and not a consistent
489*6777b538SAndroid Build Coastguard Worker // incrementing counter.
490*6777b538SAndroid Build Coastguard Worker #else
491*6777b538SAndroid Build Coastguard Worker // Returns true if the CPU support constant rate TSC.
492*6777b538SAndroid Build Coastguard Worker [[nodiscard]] BASE_EXPORT bool HasConstantRateTSC();
493*6777b538SAndroid Build Coastguard Worker
494*6777b538SAndroid Build Coastguard Worker // Returns the frequency of the TSC in ticks per second, or 0 if it hasn't
495*6777b538SAndroid Build Coastguard Worker // been measured yet. Needs to be guarded with a call to HasConstantRateTSC().
496*6777b538SAndroid Build Coastguard Worker [[nodiscard]] BASE_EXPORT double TSCTicksPerSecond();
497*6777b538SAndroid Build Coastguard Worker #endif
498*6777b538SAndroid Build Coastguard Worker #endif // BUILDFLAG(IS_WIN)
499*6777b538SAndroid Build Coastguard Worker
500*6777b538SAndroid Build Coastguard Worker } // namespace time_internal
501*6777b538SAndroid Build Coastguard Worker
502*6777b538SAndroid Build Coastguard Worker template <class TimeClass>
503*6777b538SAndroid Build Coastguard Worker inline constexpr TimeClass operator+(TimeDelta delta, TimeClass t) {
504*6777b538SAndroid Build Coastguard Worker return t + delta;
505*6777b538SAndroid Build Coastguard Worker }
506*6777b538SAndroid Build Coastguard Worker
507*6777b538SAndroid Build Coastguard Worker // Time -----------------------------------------------------------------------
508*6777b538SAndroid Build Coastguard Worker
509*6777b538SAndroid Build Coastguard Worker // Represents a wall clock time in UTC. Values are not guaranteed to be
510*6777b538SAndroid Build Coastguard Worker // monotonically non-decreasing and are subject to large amounts of skew.
511*6777b538SAndroid Build Coastguard Worker // Time is stored internally as microseconds since the Windows epoch (1601).
512*6777b538SAndroid Build Coastguard Worker class BASE_EXPORT Time : public time_internal::TimeBase<Time> {
513*6777b538SAndroid Build Coastguard Worker public:
514*6777b538SAndroid Build Coastguard Worker // Offset of UNIX epoch (1970-01-01 00:00:00 UTC) from Windows FILETIME epoch
515*6777b538SAndroid Build Coastguard Worker // (1601-01-01 00:00:00 UTC), in microseconds. This value is derived from the
516*6777b538SAndroid Build Coastguard Worker // following: ((1970-1601)*365+89)*24*60*60*1000*1000, where 89 is the number
517*6777b538SAndroid Build Coastguard Worker // of leap year days between 1601 and 1970: (1970-1601)/4 excluding 1700,
518*6777b538SAndroid Build Coastguard Worker // 1800, and 1900.
519*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kTimeTToMicrosecondsOffset =
520*6777b538SAndroid Build Coastguard Worker INT64_C(11644473600000000);
521*6777b538SAndroid Build Coastguard Worker
522*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
523*6777b538SAndroid Build Coastguard Worker // To avoid overflow in QPC to Microseconds calculations, since we multiply
524*6777b538SAndroid Build Coastguard Worker // by kMicrosecondsPerSecond, then the QPC value should not exceed
525*6777b538SAndroid Build Coastguard Worker // (2^63 - 1) / 1E6. If it exceeds that threshold, we divide then multiply.
526*6777b538SAndroid Build Coastguard Worker static constexpr int64_t kQPCOverflowThreshold = INT64_C(0x8637BD05AF7);
527*6777b538SAndroid Build Coastguard Worker #endif
528*6777b538SAndroid Build Coastguard Worker
529*6777b538SAndroid Build Coastguard Worker // kExplodedMinYear and kExplodedMaxYear define the platform-specific limits
530*6777b538SAndroid Build Coastguard Worker // for values passed to FromUTCExploded() and FromLocalExploded(). Those
531*6777b538SAndroid Build Coastguard Worker // functions will return false if passed values outside these limits. The limits
532*6777b538SAndroid Build Coastguard Worker // are inclusive, meaning that the API should support all dates within a given
533*6777b538SAndroid Build Coastguard Worker // limit year.
534*6777b538SAndroid Build Coastguard Worker //
535*6777b538SAndroid Build Coastguard Worker // WARNING: These are not the same limits for the inverse functionality,
536*6777b538SAndroid Build Coastguard Worker // UTCExplode() and LocalExplode(). See method comments for further details.
537*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
538*6777b538SAndroid Build Coastguard Worker static constexpr int kExplodedMinYear = 1601;
539*6777b538SAndroid Build Coastguard Worker static constexpr int kExplodedMaxYear = 30827;
540*6777b538SAndroid Build Coastguard Worker #elif BUILDFLAG(IS_IOS) && !__LP64__
541*6777b538SAndroid Build Coastguard Worker static constexpr int kExplodedMinYear = std::numeric_limits<int>::min();
542*6777b538SAndroid Build Coastguard Worker static constexpr int kExplodedMaxYear = std::numeric_limits<int>::max();
543*6777b538SAndroid Build Coastguard Worker #elif BUILDFLAG(IS_APPLE)
544*6777b538SAndroid Build Coastguard Worker static constexpr int kExplodedMinYear = 1902;
545*6777b538SAndroid Build Coastguard Worker static constexpr int kExplodedMaxYear = std::numeric_limits<int>::max();
546*6777b538SAndroid Build Coastguard Worker #elif BUILDFLAG(IS_ANDROID)
547*6777b538SAndroid Build Coastguard Worker // Though we use 64-bit time APIs on both 32 and 64 bit Android, some OS
548*6777b538SAndroid Build Coastguard Worker // versions like KitKat (ARM but not x86 emulator) can't handle some early
549*6777b538SAndroid Build Coastguard Worker // dates (e.g. before 1170). So we set min conservatively here.
550*6777b538SAndroid Build Coastguard Worker static constexpr int kExplodedMinYear = 1902;
551*6777b538SAndroid Build Coastguard Worker static constexpr int kExplodedMaxYear = std::numeric_limits<int>::max();
552*6777b538SAndroid Build Coastguard Worker #else
553*6777b538SAndroid Build Coastguard Worker static constexpr int kExplodedMinYear =
554*6777b538SAndroid Build Coastguard Worker (sizeof(time_t) == 4 ? 1902 : std::numeric_limits<int>::min());
555*6777b538SAndroid Build Coastguard Worker static constexpr int kExplodedMaxYear =
556*6777b538SAndroid Build Coastguard Worker (sizeof(time_t) == 4 ? 2037 : std::numeric_limits<int>::max());
557*6777b538SAndroid Build Coastguard Worker #endif
558*6777b538SAndroid Build Coastguard Worker
559*6777b538SAndroid Build Coastguard Worker // Represents an exploded time. This is kind of like the Win32 SYSTEMTIME
560*6777b538SAndroid Build Coastguard Worker // structure or the Unix "struct tm" with a few additions and changes to
561*6777b538SAndroid Build Coastguard Worker // prevent errors.
562*6777b538SAndroid Build Coastguard Worker //
563*6777b538SAndroid Build Coastguard Worker // This structure always represents dates in the Gregorian calendar and always
564*6777b538SAndroid Build Coastguard Worker // encodes day_of_week as Sunday==0, Monday==1, .., Saturday==6. This means
565*6777b538SAndroid Build Coastguard Worker // that base::Time::LocalExplode and base::Time::FromLocalExploded only
566*6777b538SAndroid Build Coastguard Worker // respect the current local time zone in the conversion and do *not* use a
567*6777b538SAndroid Build Coastguard Worker // calendar or day-of-week encoding from the current locale.
568*6777b538SAndroid Build Coastguard Worker //
569*6777b538SAndroid Build Coastguard Worker // NOTE: Generally, you should prefer the functions in
570*6777b538SAndroid Build Coastguard Worker // base/i18n/time_formatting.h (in particular,
571*6777b538SAndroid Build Coastguard Worker // `UnlocalizedTimeFormatWithPattern()`) over trying to create a formatted
572*6777b538SAndroid Build Coastguard Worker // time string from this object.
573*6777b538SAndroid Build Coastguard Worker struct BASE_EXPORT Exploded {
574*6777b538SAndroid Build Coastguard Worker int year; // Four digit year "2007"
575*6777b538SAndroid Build Coastguard Worker int month; // 1-based month (values 1 = January, etc.)
576*6777b538SAndroid Build Coastguard Worker int day_of_week; // 0-based day of week (0 = Sunday, etc.)
577*6777b538SAndroid Build Coastguard Worker int day_of_month; // 1-based day of month (1-31)
578*6777b538SAndroid Build Coastguard Worker int hour; // Hour within the current day (0-23)
579*6777b538SAndroid Build Coastguard Worker int minute; // Minute within the current hour (0-59)
580*6777b538SAndroid Build Coastguard Worker int second; // Second within the current minute (0-59 plus leap
581*6777b538SAndroid Build Coastguard Worker // seconds which may take it up to 60).
582*6777b538SAndroid Build Coastguard Worker int millisecond; // Milliseconds within the current second (0-999)
583*6777b538SAndroid Build Coastguard Worker
584*6777b538SAndroid Build Coastguard Worker // A cursory test for whether the data members are within their
585*6777b538SAndroid Build Coastguard Worker // respective ranges. A 'true' return value does not guarantee the
586*6777b538SAndroid Build Coastguard Worker // Exploded value can be successfully converted to a Time value.
587*6777b538SAndroid Build Coastguard Worker bool HasValidValues() const;
588*6777b538SAndroid Build Coastguard Worker };
589*6777b538SAndroid Build Coastguard Worker
590*6777b538SAndroid Build Coastguard Worker // TODO(https://crbug.com/1392437): Remove concept of "null" from base::Time.
591*6777b538SAndroid Build Coastguard Worker //
592*6777b538SAndroid Build Coastguard Worker // Warning: Be careful when writing code that performs math on time values,
593*6777b538SAndroid Build Coastguard Worker // since it's possible to produce a valid "zero" result that should not be
594*6777b538SAndroid Build Coastguard Worker // interpreted as a "null" value. If you find yourself using this constructor
595*6777b538SAndroid Build Coastguard Worker // or the is_null() method, please consider using an optional to express the
596*6777b538SAndroid Build Coastguard Worker // null state.
597*6777b538SAndroid Build Coastguard Worker //
598*6777b538SAndroid Build Coastguard Worker // Contains the NULL time. Use Time::Now() to get the current time.
Time()599*6777b538SAndroid Build Coastguard Worker constexpr Time() : TimeBase(0) {}
600*6777b538SAndroid Build Coastguard Worker
601*6777b538SAndroid Build Coastguard Worker // Returns the time for epoch in Unix-like system (Jan 1, 1970).
UnixEpoch()602*6777b538SAndroid Build Coastguard Worker static constexpr Time UnixEpoch() { return Time(kTimeTToMicrosecondsOffset); }
603*6777b538SAndroid Build Coastguard Worker
604*6777b538SAndroid Build Coastguard Worker // Returns the current time. Watch out, the system might adjust its clock
605*6777b538SAndroid Build Coastguard Worker // in which case time will actually go backwards. We don't guarantee that
606*6777b538SAndroid Build Coastguard Worker // times are increasing, or that two calls to Now() won't be the same.
607*6777b538SAndroid Build Coastguard Worker static Time Now();
608*6777b538SAndroid Build Coastguard Worker
609*6777b538SAndroid Build Coastguard Worker // Returns the current time. Same as Now() except that this function always
610*6777b538SAndroid Build Coastguard Worker // uses system time so that there are no discrepancies between the returned
611*6777b538SAndroid Build Coastguard Worker // time and system time even on virtual environments including our test bot.
612*6777b538SAndroid Build Coastguard Worker // For timing sensitive unittests, this function should be used.
613*6777b538SAndroid Build Coastguard Worker static Time NowFromSystemTime();
614*6777b538SAndroid Build Coastguard Worker
615*6777b538SAndroid Build Coastguard Worker // Converts to/from TimeDeltas relative to the Windows epoch (1601-01-01
616*6777b538SAndroid Build Coastguard Worker // 00:00:00 UTC).
617*6777b538SAndroid Build Coastguard Worker //
618*6777b538SAndroid Build Coastguard Worker // For serialization, when handling `base::Value`, prefer the helpers in
619*6777b538SAndroid Build Coastguard Worker // //base/json/values_util.h instead. Otherwise, use these methods for
620*6777b538SAndroid Build Coastguard Worker // opaque serialization and deserialization, e.g.
621*6777b538SAndroid Build Coastguard Worker //
622*6777b538SAndroid Build Coastguard Worker // // Serialization:
623*6777b538SAndroid Build Coastguard Worker // base::Time last_updated = ...;
624*6777b538SAndroid Build Coastguard Worker // SaveToDatabase(last_updated.ToDeltaSinceWindowsEpoch().InMicroseconds());
625*6777b538SAndroid Build Coastguard Worker //
626*6777b538SAndroid Build Coastguard Worker // // Deserialization:
627*6777b538SAndroid Build Coastguard Worker // base::Time last_updated = base::Time::FromDeltaSinceWindowsEpoch(
628*6777b538SAndroid Build Coastguard Worker // base::Microseconds(LoadFromDatabase()));
629*6777b538SAndroid Build Coastguard Worker //
630*6777b538SAndroid Build Coastguard Worker // Do not use `FromInternalValue()` or `ToInternalValue()` for this purpose.
FromDeltaSinceWindowsEpoch(TimeDelta delta)631*6777b538SAndroid Build Coastguard Worker static constexpr Time FromDeltaSinceWindowsEpoch(TimeDelta delta) {
632*6777b538SAndroid Build Coastguard Worker return Time(delta.InMicroseconds());
633*6777b538SAndroid Build Coastguard Worker }
634*6777b538SAndroid Build Coastguard Worker
ToDeltaSinceWindowsEpoch()635*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta ToDeltaSinceWindowsEpoch() const {
636*6777b538SAndroid Build Coastguard Worker return Microseconds(us_);
637*6777b538SAndroid Build Coastguard Worker }
638*6777b538SAndroid Build Coastguard Worker
639*6777b538SAndroid Build Coastguard Worker // Converts to/from time_t in UTC and a Time class.
640*6777b538SAndroid Build Coastguard Worker static constexpr Time FromTimeT(time_t tt);
641*6777b538SAndroid Build Coastguard Worker constexpr time_t ToTimeT() const;
642*6777b538SAndroid Build Coastguard Worker
643*6777b538SAndroid Build Coastguard Worker // Converts time to/from a number of seconds since the Unix epoch (Jan 1,
644*6777b538SAndroid Build Coastguard Worker // 1970).
645*6777b538SAndroid Build Coastguard Worker //
646*6777b538SAndroid Build Coastguard Worker // TODO(crbug.com/1495550): Add integral versions and use them.
647*6777b538SAndroid Build Coastguard Worker // TODO(crbug.com/1495554): Add ...PreservingNull() versions; see comments in
648*6777b538SAndroid Build Coastguard Worker // the implementation of FromSecondsSinceUnixEpoch().
649*6777b538SAndroid Build Coastguard Worker static constexpr Time FromSecondsSinceUnixEpoch(double dt);
650*6777b538SAndroid Build Coastguard Worker constexpr double InSecondsFSinceUnixEpoch() const;
651*6777b538SAndroid Build Coastguard Worker
652*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
653*6777b538SAndroid Build Coastguard Worker // Converts the timespec structure to time. MacOS X 10.8.3 (and tentatively,
654*6777b538SAndroid Build Coastguard Worker // earlier versions) will have the |ts|'s tv_nsec component zeroed out,
655*6777b538SAndroid Build Coastguard Worker // having a 1 second resolution, which agrees with
656*6777b538SAndroid Build Coastguard Worker // https://developer.apple.com/legacy/library/#technotes/tn/tn1150.html#HFSPlusDates.
657*6777b538SAndroid Build Coastguard Worker static constexpr Time FromTimeSpec(const timespec& ts);
658*6777b538SAndroid Build Coastguard Worker #endif
659*6777b538SAndroid Build Coastguard Worker
660*6777b538SAndroid Build Coastguard Worker // Converts to/from a number of milliseconds since the Unix epoch.
661*6777b538SAndroid Build Coastguard Worker // TODO(crbug.com/1495554): Add ...PreservingNull() versions; see comments in
662*6777b538SAndroid Build Coastguard Worker // the implementation of FromMillisecondsSinceUnixEpoch().
663*6777b538SAndroid Build Coastguard Worker static constexpr Time FromMillisecondsSinceUnixEpoch(int64_t dt);
664*6777b538SAndroid Build Coastguard Worker static constexpr Time FromMillisecondsSinceUnixEpoch(double dt);
665*6777b538SAndroid Build Coastguard Worker // Explicitly forward calls with smaller integral types to the int64_t
666*6777b538SAndroid Build Coastguard Worker // version; otherwise such calls would need to manually cast their args to
667*6777b538SAndroid Build Coastguard Worker // int64_t, since the compiler isn't sure whether to promote to int64_t or
668*6777b538SAndroid Build Coastguard Worker // double.
669*6777b538SAndroid Build Coastguard Worker template <typename T>
670*6777b538SAndroid Build Coastguard Worker requires(std::integral<T> && !std::same_as<T, int64_t> &&
671*6777b538SAndroid Build Coastguard Worker (sizeof(T) < sizeof(int64_t) ||
672*6777b538SAndroid Build Coastguard Worker (sizeof(T) == sizeof(int64_t) && std::is_signed_v<T>)))
FromMillisecondsSinceUnixEpoch(T ms_since_epoch)673*6777b538SAndroid Build Coastguard Worker static constexpr Time FromMillisecondsSinceUnixEpoch(T ms_since_epoch) {
674*6777b538SAndroid Build Coastguard Worker return FromMillisecondsSinceUnixEpoch(int64_t{ms_since_epoch});
675*6777b538SAndroid Build Coastguard Worker }
676*6777b538SAndroid Build Coastguard Worker constexpr int64_t InMillisecondsSinceUnixEpoch() const;
677*6777b538SAndroid Build Coastguard Worker // Don't use InMillisecondsFSinceUnixEpoch() in new code, since it contains a
678*6777b538SAndroid Build Coastguard Worker // subtle hack (only exactly 1601-01-01 00:00 UTC is represented as 1970-01-01
679*6777b538SAndroid Build Coastguard Worker // 00:00 UTC), and that is not appropriate for general use. Try to use
680*6777b538SAndroid Build Coastguard Worker // InMillisecondsFSinceUnixEpochIgnoringNull() unless you have a very good
681*6777b538SAndroid Build Coastguard Worker // reason to use InMillisecondsFSinceUnixEpoch().
682*6777b538SAndroid Build Coastguard Worker //
683*6777b538SAndroid Build Coastguard Worker // TODO(crbug.com/1495554): Rename the no-suffix version to
684*6777b538SAndroid Build Coastguard Worker // "...PreservingNull()" and remove the suffix from the other version, to
685*6777b538SAndroid Build Coastguard Worker // guide people to the preferable API.
686*6777b538SAndroid Build Coastguard Worker constexpr double InMillisecondsFSinceUnixEpoch() const;
687*6777b538SAndroid Build Coastguard Worker constexpr double InMillisecondsFSinceUnixEpochIgnoringNull() const;
688*6777b538SAndroid Build Coastguard Worker
689*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
690*6777b538SAndroid Build Coastguard Worker static Time FromTimeVal(struct timeval t);
691*6777b538SAndroid Build Coastguard Worker struct timeval ToTimeVal() const;
692*6777b538SAndroid Build Coastguard Worker #endif
693*6777b538SAndroid Build Coastguard Worker
694*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_FUCHSIA)
695*6777b538SAndroid Build Coastguard Worker static Time FromZxTime(zx_time_t time);
696*6777b538SAndroid Build Coastguard Worker zx_time_t ToZxTime() const;
697*6777b538SAndroid Build Coastguard Worker #endif
698*6777b538SAndroid Build Coastguard Worker
699*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_APPLE)
700*6777b538SAndroid Build Coastguard Worker static Time FromCFAbsoluteTime(CFAbsoluteTime t);
701*6777b538SAndroid Build Coastguard Worker CFAbsoluteTime ToCFAbsoluteTime() const;
702*6777b538SAndroid Build Coastguard Worker #if defined(__OBJC__)
703*6777b538SAndroid Build Coastguard Worker static Time FromNSDate(NSDate* date);
704*6777b538SAndroid Build Coastguard Worker NSDate* ToNSDate() const;
705*6777b538SAndroid Build Coastguard Worker #endif
706*6777b538SAndroid Build Coastguard Worker #endif
707*6777b538SAndroid Build Coastguard Worker
708*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
709*6777b538SAndroid Build Coastguard Worker static Time FromFileTime(FILETIME ft);
710*6777b538SAndroid Build Coastguard Worker FILETIME ToFileTime() const;
711*6777b538SAndroid Build Coastguard Worker
712*6777b538SAndroid Build Coastguard Worker // The minimum time of a low resolution timer. This is basically a windows
713*6777b538SAndroid Build Coastguard Worker // constant of ~15.6ms. While it does vary on some older OS versions, we'll
714*6777b538SAndroid Build Coastguard Worker // treat it as static across all windows versions.
715*6777b538SAndroid Build Coastguard Worker static const int kMinLowResolutionThresholdMs = 16;
716*6777b538SAndroid Build Coastguard Worker
717*6777b538SAndroid Build Coastguard Worker // Enable or disable Windows high resolution timer.
718*6777b538SAndroid Build Coastguard Worker static void EnableHighResolutionTimer(bool enable);
719*6777b538SAndroid Build Coastguard Worker
720*6777b538SAndroid Build Coastguard Worker // Activates or deactivates the high resolution timer based on the |activate|
721*6777b538SAndroid Build Coastguard Worker // flag. If the HighResolutionTimer is not Enabled (see
722*6777b538SAndroid Build Coastguard Worker // EnableHighResolutionTimer), this function will return false. Otherwise
723*6777b538SAndroid Build Coastguard Worker // returns true. Each successful activate call must be paired with a
724*6777b538SAndroid Build Coastguard Worker // subsequent deactivate call.
725*6777b538SAndroid Build Coastguard Worker // All callers to activate the high resolution timer must eventually call
726*6777b538SAndroid Build Coastguard Worker // this function to deactivate the high resolution timer.
727*6777b538SAndroid Build Coastguard Worker static bool ActivateHighResolutionTimer(bool activate);
728*6777b538SAndroid Build Coastguard Worker
729*6777b538SAndroid Build Coastguard Worker // Returns true if the high resolution timer is both enabled and activated.
730*6777b538SAndroid Build Coastguard Worker // This is provided for testing only, and is not tracked in a thread-safe
731*6777b538SAndroid Build Coastguard Worker // way.
732*6777b538SAndroid Build Coastguard Worker static bool IsHighResolutionTimerInUse();
733*6777b538SAndroid Build Coastguard Worker
734*6777b538SAndroid Build Coastguard Worker // The following two functions are used to report the fraction of elapsed time
735*6777b538SAndroid Build Coastguard Worker // that the high resolution timer is activated.
736*6777b538SAndroid Build Coastguard Worker // ResetHighResolutionTimerUsage() resets the cumulative usage and starts the
737*6777b538SAndroid Build Coastguard Worker // measurement interval and GetHighResolutionTimerUsage() returns the
738*6777b538SAndroid Build Coastguard Worker // percentage of time since the reset that the high resolution timer was
739*6777b538SAndroid Build Coastguard Worker // activated.
740*6777b538SAndroid Build Coastguard Worker // ResetHighResolutionTimerUsage() must be called at least once before calling
741*6777b538SAndroid Build Coastguard Worker // GetHighResolutionTimerUsage(); otherwise the usage result would be
742*6777b538SAndroid Build Coastguard Worker // undefined.
743*6777b538SAndroid Build Coastguard Worker static void ResetHighResolutionTimerUsage();
744*6777b538SAndroid Build Coastguard Worker static double GetHighResolutionTimerUsage();
745*6777b538SAndroid Build Coastguard Worker #endif // BUILDFLAG(IS_WIN)
746*6777b538SAndroid Build Coastguard Worker
747*6777b538SAndroid Build Coastguard Worker // Converts an exploded structure representing either the local time or UTC
748*6777b538SAndroid Build Coastguard Worker // into a Time class. Returns false on a failure when, for example, a day of
749*6777b538SAndroid Build Coastguard Worker // month is set to 31 on a 28-30 day month. Returns Time(0) on overflow.
750*6777b538SAndroid Build Coastguard Worker // FromLocalExploded respects the current time zone but does not attempt to
751*6777b538SAndroid Build Coastguard Worker // use the calendar or day-of-week encoding from the current locale - see the
752*6777b538SAndroid Build Coastguard Worker // comments on Exploded for more information.
FromUTCExploded(const Exploded & exploded,Time * time)753*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool FromUTCExploded(const Exploded& exploded,
754*6777b538SAndroid Build Coastguard Worker Time* time) {
755*6777b538SAndroid Build Coastguard Worker return FromExploded(false, exploded, time);
756*6777b538SAndroid Build Coastguard Worker }
FromLocalExploded(const Exploded & exploded,Time * time)757*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool FromLocalExploded(const Exploded& exploded,
758*6777b538SAndroid Build Coastguard Worker Time* time) {
759*6777b538SAndroid Build Coastguard Worker return FromExploded(true, exploded, time);
760*6777b538SAndroid Build Coastguard Worker }
761*6777b538SAndroid Build Coastguard Worker
762*6777b538SAndroid Build Coastguard Worker // Converts a string representation of time to a Time object.
763*6777b538SAndroid Build Coastguard Worker // An example of a time string which is converted is as below:-
764*6777b538SAndroid Build Coastguard Worker // "Tue, 15 Nov 1994 12:45:26 GMT". If the timezone is not specified
765*6777b538SAndroid Build Coastguard Worker // in the input string, FromString assumes local time and FromUTCString
766*6777b538SAndroid Build Coastguard Worker // assumes UTC. A timezone that cannot be parsed (e.g. "UTC" which is not
767*6777b538SAndroid Build Coastguard Worker // specified in RFC822) is treated as if the timezone is not specified.
768*6777b538SAndroid Build Coastguard Worker //
769*6777b538SAndroid Build Coastguard Worker // WARNING: the underlying converter is very permissive. For example: it is
770*6777b538SAndroid Build Coastguard Worker // not checked whether a given day of the week matches the date; Feb 29
771*6777b538SAndroid Build Coastguard Worker // silently becomes Mar 1 in non-leap years; under certain conditions, whole
772*6777b538SAndroid Build Coastguard Worker // English sentences may be parsed successfully and yield unexpected results.
773*6777b538SAndroid Build Coastguard Worker //
774*6777b538SAndroid Build Coastguard Worker // TODO(iyengar) Move the FromString/FromTimeT/ToTimeT/FromFileTime to
775*6777b538SAndroid Build Coastguard Worker // a new time converter class.
FromString(const char * time_string,Time * parsed_time)776*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool FromString(const char* time_string,
777*6777b538SAndroid Build Coastguard Worker Time* parsed_time) {
778*6777b538SAndroid Build Coastguard Worker return FromStringInternal(time_string, true, parsed_time);
779*6777b538SAndroid Build Coastguard Worker }
FromUTCString(const char * time_string,Time * parsed_time)780*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool FromUTCString(const char* time_string,
781*6777b538SAndroid Build Coastguard Worker Time* parsed_time) {
782*6777b538SAndroid Build Coastguard Worker return FromStringInternal(time_string, false, parsed_time);
783*6777b538SAndroid Build Coastguard Worker }
784*6777b538SAndroid Build Coastguard Worker
785*6777b538SAndroid Build Coastguard Worker // Fills the given |exploded| structure with either the local time or UTC from
786*6777b538SAndroid Build Coastguard Worker // this Time instance. If the conversion cannot be made, the output will be
787*6777b538SAndroid Build Coastguard Worker // assigned invalid values. Use Exploded::HasValidValues() to confirm a
788*6777b538SAndroid Build Coastguard Worker // successful conversion.
789*6777b538SAndroid Build Coastguard Worker //
790*6777b538SAndroid Build Coastguard Worker // Y10K compliance: This method will successfully convert all Times that
791*6777b538SAndroid Build Coastguard Worker // represent dates on/after the start of the year 1601 and on/before the start
792*6777b538SAndroid Build Coastguard Worker // of the year 30828. Some platforms might convert over a wider input range.
793*6777b538SAndroid Build Coastguard Worker // LocalExplode respects the current time zone but does not attempt to use the
794*6777b538SAndroid Build Coastguard Worker // calendar or day-of-week encoding from the current locale - see the comments
795*6777b538SAndroid Build Coastguard Worker // on Exploded for more information.
UTCExplode(Exploded * exploded)796*6777b538SAndroid Build Coastguard Worker void UTCExplode(Exploded* exploded) const { Explode(false, exploded); }
LocalExplode(Exploded * exploded)797*6777b538SAndroid Build Coastguard Worker void LocalExplode(Exploded* exploded) const { Explode(true, exploded); }
798*6777b538SAndroid Build Coastguard Worker
799*6777b538SAndroid Build Coastguard Worker // The following two functions round down the time to the nearest day in
800*6777b538SAndroid Build Coastguard Worker // either UTC or local time. It will represent midnight on that day.
UTCMidnight()801*6777b538SAndroid Build Coastguard Worker Time UTCMidnight() const { return Midnight(false); }
LocalMidnight()802*6777b538SAndroid Build Coastguard Worker Time LocalMidnight() const { return Midnight(true); }
803*6777b538SAndroid Build Coastguard Worker
804*6777b538SAndroid Build Coastguard Worker // For legacy deserialization only. Converts an integer value representing
805*6777b538SAndroid Build Coastguard Worker // Time to a class. This may be used when deserializing a |Time| structure,
806*6777b538SAndroid Build Coastguard Worker // using a value known to be compatible. It is not provided as a constructor
807*6777b538SAndroid Build Coastguard Worker // because the integer type may be unclear from the perspective of a caller.
808*6777b538SAndroid Build Coastguard Worker //
809*6777b538SAndroid Build Coastguard Worker // DEPRECATED - Do not use in new code. When deserializing from `base::Value`,
810*6777b538SAndroid Build Coastguard Worker // prefer the helpers from //base/json/values_util.h instead.
811*6777b538SAndroid Build Coastguard Worker // Otherwise, use `Time::FromDeltaSinceWindowsEpoch()` for `Time` and
812*6777b538SAndroid Build Coastguard Worker // `Microseconds()` for `TimeDelta`. http://crbug.com/634507
FromInternalValue(int64_t us)813*6777b538SAndroid Build Coastguard Worker static constexpr Time FromInternalValue(int64_t us) { return Time(us); }
814*6777b538SAndroid Build Coastguard Worker
815*6777b538SAndroid Build Coastguard Worker private:
816*6777b538SAndroid Build Coastguard Worker friend class time_internal::TimeBase<Time>;
817*6777b538SAndroid Build Coastguard Worker
Time(int64_t microseconds_since_win_epoch)818*6777b538SAndroid Build Coastguard Worker constexpr explicit Time(int64_t microseconds_since_win_epoch)
819*6777b538SAndroid Build Coastguard Worker : TimeBase(microseconds_since_win_epoch) {}
820*6777b538SAndroid Build Coastguard Worker
821*6777b538SAndroid Build Coastguard Worker // Explodes the given time to either local time |is_local = true| or UTC
822*6777b538SAndroid Build Coastguard Worker // |is_local = false|.
823*6777b538SAndroid Build Coastguard Worker void Explode(bool is_local, Exploded* exploded) const;
824*6777b538SAndroid Build Coastguard Worker
825*6777b538SAndroid Build Coastguard Worker // Unexplodes a given time assuming the source is either local time
826*6777b538SAndroid Build Coastguard Worker // |is_local = true| or UTC |is_local = false|. Function returns false on
827*6777b538SAndroid Build Coastguard Worker // failure and sets |time| to Time(0). Otherwise returns true and sets |time|
828*6777b538SAndroid Build Coastguard Worker // to non-exploded time.
829*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool FromExploded(bool is_local,
830*6777b538SAndroid Build Coastguard Worker const Exploded& exploded,
831*6777b538SAndroid Build Coastguard Worker Time* time);
832*6777b538SAndroid Build Coastguard Worker
833*6777b538SAndroid Build Coastguard Worker // Some platforms use the ICU library to provide To/FromExploded, when their
834*6777b538SAndroid Build Coastguard Worker // native library implementations are insufficient in some way.
835*6777b538SAndroid Build Coastguard Worker static void ExplodeUsingIcu(int64_t millis_since_unix_epoch,
836*6777b538SAndroid Build Coastguard Worker bool is_local,
837*6777b538SAndroid Build Coastguard Worker Exploded* exploded);
838*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool FromExplodedUsingIcu(
839*6777b538SAndroid Build Coastguard Worker bool is_local,
840*6777b538SAndroid Build Coastguard Worker const Exploded& exploded,
841*6777b538SAndroid Build Coastguard Worker int64_t* millis_since_unix_epoch);
842*6777b538SAndroid Build Coastguard Worker
843*6777b538SAndroid Build Coastguard Worker // Rounds down the time to the nearest day in either local time
844*6777b538SAndroid Build Coastguard Worker // |is_local = true| or UTC |is_local = false|.
845*6777b538SAndroid Build Coastguard Worker Time Midnight(bool is_local) const;
846*6777b538SAndroid Build Coastguard Worker
847*6777b538SAndroid Build Coastguard Worker // Converts a string representation of time to a Time object.
848*6777b538SAndroid Build Coastguard Worker // An example of a time string which is converted is as below:-
849*6777b538SAndroid Build Coastguard Worker // "Tue, 15 Nov 1994 12:45:26 GMT". If the timezone is not specified
850*6777b538SAndroid Build Coastguard Worker // in the input string, local time |is_local = true| or
851*6777b538SAndroid Build Coastguard Worker // UTC |is_local = false| is assumed. A timezone that cannot be parsed
852*6777b538SAndroid Build Coastguard Worker // (e.g. "UTC" which is not specified in RFC822) is treated as if the
853*6777b538SAndroid Build Coastguard Worker // timezone is not specified.
854*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool FromStringInternal(const char* time_string,
855*6777b538SAndroid Build Coastguard Worker bool is_local,
856*6777b538SAndroid Build Coastguard Worker Time* parsed_time);
857*6777b538SAndroid Build Coastguard Worker
858*6777b538SAndroid Build Coastguard Worker // Comparison does not consider |day_of_week| when doing the operation.
859*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool ExplodedMostlyEquals(const Exploded& lhs,
860*6777b538SAndroid Build Coastguard Worker const Exploded& rhs);
861*6777b538SAndroid Build Coastguard Worker
862*6777b538SAndroid Build Coastguard Worker // Converts the provided time in milliseconds since the Unix epoch (1970) to a
863*6777b538SAndroid Build Coastguard Worker // Time object, avoiding overflows.
864*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool FromMillisecondsSinceUnixEpoch(
865*6777b538SAndroid Build Coastguard Worker int64_t unix_milliseconds,
866*6777b538SAndroid Build Coastguard Worker Time* time);
867*6777b538SAndroid Build Coastguard Worker
868*6777b538SAndroid Build Coastguard Worker // Returns the milliseconds since the Unix epoch (1970), rounding the
869*6777b538SAndroid Build Coastguard Worker // microseconds towards -infinity.
870*6777b538SAndroid Build Coastguard Worker int64_t ToRoundedDownMillisecondsSinceUnixEpoch() const;
871*6777b538SAndroid Build Coastguard Worker };
872*6777b538SAndroid Build Coastguard Worker
873*6777b538SAndroid Build Coastguard Worker // Factory methods that return a TimeDelta of the given unit.
874*6777b538SAndroid Build Coastguard Worker // WARNING: Floating point arithmetic is such that XXX(t.InXXXF()) may not
875*6777b538SAndroid Build Coastguard Worker // precisely equal |t|. Hence, floating point values should not be used for
876*6777b538SAndroid Build Coastguard Worker // storage.
877*6777b538SAndroid Build Coastguard Worker
878*6777b538SAndroid Build Coastguard Worker template <typename T>
Days(T n)879*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta Days(T n) {
880*6777b538SAndroid Build Coastguard Worker return TimeDelta::FromInternalValue(MakeClampedNum(n) *
881*6777b538SAndroid Build Coastguard Worker Time::kMicrosecondsPerDay);
882*6777b538SAndroid Build Coastguard Worker }
883*6777b538SAndroid Build Coastguard Worker template <typename T>
Hours(T n)884*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta Hours(T n) {
885*6777b538SAndroid Build Coastguard Worker return TimeDelta::FromInternalValue(MakeClampedNum(n) *
886*6777b538SAndroid Build Coastguard Worker Time::kMicrosecondsPerHour);
887*6777b538SAndroid Build Coastguard Worker }
888*6777b538SAndroid Build Coastguard Worker template <typename T>
Minutes(T n)889*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta Minutes(T n) {
890*6777b538SAndroid Build Coastguard Worker return TimeDelta::FromInternalValue(MakeClampedNum(n) *
891*6777b538SAndroid Build Coastguard Worker Time::kMicrosecondsPerMinute);
892*6777b538SAndroid Build Coastguard Worker }
893*6777b538SAndroid Build Coastguard Worker template <typename T>
Seconds(T n)894*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta Seconds(T n) {
895*6777b538SAndroid Build Coastguard Worker return TimeDelta::FromInternalValue(MakeClampedNum(n) *
896*6777b538SAndroid Build Coastguard Worker Time::kMicrosecondsPerSecond);
897*6777b538SAndroid Build Coastguard Worker }
898*6777b538SAndroid Build Coastguard Worker template <typename T>
Milliseconds(T n)899*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta Milliseconds(T n) {
900*6777b538SAndroid Build Coastguard Worker return TimeDelta::FromInternalValue(MakeClampedNum(n) *
901*6777b538SAndroid Build Coastguard Worker Time::kMicrosecondsPerMillisecond);
902*6777b538SAndroid Build Coastguard Worker }
903*6777b538SAndroid Build Coastguard Worker template <typename T>
Microseconds(T n)904*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta Microseconds(T n) {
905*6777b538SAndroid Build Coastguard Worker return TimeDelta::FromInternalValue(MakeClampedNum(n));
906*6777b538SAndroid Build Coastguard Worker }
907*6777b538SAndroid Build Coastguard Worker template <typename T>
Nanoseconds(T n)908*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta Nanoseconds(T n) {
909*6777b538SAndroid Build Coastguard Worker return TimeDelta::FromInternalValue(MakeClampedNum(n) /
910*6777b538SAndroid Build Coastguard Worker Time::kNanosecondsPerMicrosecond);
911*6777b538SAndroid Build Coastguard Worker }
912*6777b538SAndroid Build Coastguard Worker template <typename T>
Hertz(T n)913*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta Hertz(T n) {
914*6777b538SAndroid Build Coastguard Worker return n ? TimeDelta::FromInternalValue(Time::kMicrosecondsPerSecond /
915*6777b538SAndroid Build Coastguard Worker MakeClampedNum(n))
916*6777b538SAndroid Build Coastguard Worker : TimeDelta::Max();
917*6777b538SAndroid Build Coastguard Worker }
918*6777b538SAndroid Build Coastguard Worker
919*6777b538SAndroid Build Coastguard Worker // TimeDelta functions that must appear below the declarations of Time/TimeDelta
920*6777b538SAndroid Build Coastguard Worker
ToHz()921*6777b538SAndroid Build Coastguard Worker constexpr double TimeDelta::ToHz() const {
922*6777b538SAndroid Build Coastguard Worker return Seconds(1) / *this;
923*6777b538SAndroid Build Coastguard Worker }
924*6777b538SAndroid Build Coastguard Worker
InDays()925*6777b538SAndroid Build Coastguard Worker constexpr int TimeDelta::InDays() const {
926*6777b538SAndroid Build Coastguard Worker if (!is_inf()) {
927*6777b538SAndroid Build Coastguard Worker return static_cast<int>(delta_ / Time::kMicrosecondsPerDay);
928*6777b538SAndroid Build Coastguard Worker }
929*6777b538SAndroid Build Coastguard Worker return (delta_ < 0) ? std::numeric_limits<int>::min()
930*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<int>::max();
931*6777b538SAndroid Build Coastguard Worker }
932*6777b538SAndroid Build Coastguard Worker
InDaysFloored()933*6777b538SAndroid Build Coastguard Worker constexpr int TimeDelta::InDaysFloored() const {
934*6777b538SAndroid Build Coastguard Worker if (!is_inf()) {
935*6777b538SAndroid Build Coastguard Worker const int result = delta_ / Time::kMicrosecondsPerDay;
936*6777b538SAndroid Build Coastguard Worker // Convert |result| from truncating to flooring.
937*6777b538SAndroid Build Coastguard Worker return (result * Time::kMicrosecondsPerDay > delta_) ? (result - 1)
938*6777b538SAndroid Build Coastguard Worker : result;
939*6777b538SAndroid Build Coastguard Worker }
940*6777b538SAndroid Build Coastguard Worker return (delta_ < 0) ? std::numeric_limits<int>::min()
941*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<int>::max();
942*6777b538SAndroid Build Coastguard Worker }
943*6777b538SAndroid Build Coastguard Worker
InHours()944*6777b538SAndroid Build Coastguard Worker constexpr int TimeDelta::InHours() const {
945*6777b538SAndroid Build Coastguard Worker // saturated_cast<> is necessary since very large (but still less than
946*6777b538SAndroid Build Coastguard Worker // min/max) deltas would result in overflow.
947*6777b538SAndroid Build Coastguard Worker return saturated_cast<int>(delta_ / Time::kMicrosecondsPerHour);
948*6777b538SAndroid Build Coastguard Worker }
949*6777b538SAndroid Build Coastguard Worker
InMinutes()950*6777b538SAndroid Build Coastguard Worker constexpr int TimeDelta::InMinutes() const {
951*6777b538SAndroid Build Coastguard Worker // saturated_cast<> is necessary since very large (but still less than
952*6777b538SAndroid Build Coastguard Worker // min/max) deltas would result in overflow.
953*6777b538SAndroid Build Coastguard Worker return saturated_cast<int>(delta_ / Time::kMicrosecondsPerMinute);
954*6777b538SAndroid Build Coastguard Worker }
955*6777b538SAndroid Build Coastguard Worker
InSecondsF()956*6777b538SAndroid Build Coastguard Worker constexpr double TimeDelta::InSecondsF() const {
957*6777b538SAndroid Build Coastguard Worker if (!is_inf())
958*6777b538SAndroid Build Coastguard Worker return static_cast<double>(delta_) / Time::kMicrosecondsPerSecond;
959*6777b538SAndroid Build Coastguard Worker return (delta_ < 0) ? -std::numeric_limits<double>::infinity()
960*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<double>::infinity();
961*6777b538SAndroid Build Coastguard Worker }
962*6777b538SAndroid Build Coastguard Worker
InSeconds()963*6777b538SAndroid Build Coastguard Worker constexpr int64_t TimeDelta::InSeconds() const {
964*6777b538SAndroid Build Coastguard Worker return is_inf() ? delta_ : (delta_ / Time::kMicrosecondsPerSecond);
965*6777b538SAndroid Build Coastguard Worker }
966*6777b538SAndroid Build Coastguard Worker
InSecondsFloored()967*6777b538SAndroid Build Coastguard Worker constexpr int64_t TimeDelta::InSecondsFloored() const {
968*6777b538SAndroid Build Coastguard Worker if (!is_inf()) {
969*6777b538SAndroid Build Coastguard Worker const int64_t result = delta_ / Time::kMicrosecondsPerSecond;
970*6777b538SAndroid Build Coastguard Worker // Convert |result| from truncating to flooring.
971*6777b538SAndroid Build Coastguard Worker return (result * Time::kMicrosecondsPerSecond > delta_) ? (result - 1)
972*6777b538SAndroid Build Coastguard Worker : result;
973*6777b538SAndroid Build Coastguard Worker }
974*6777b538SAndroid Build Coastguard Worker return delta_;
975*6777b538SAndroid Build Coastguard Worker }
976*6777b538SAndroid Build Coastguard Worker
InMillisecondsF()977*6777b538SAndroid Build Coastguard Worker constexpr double TimeDelta::InMillisecondsF() const {
978*6777b538SAndroid Build Coastguard Worker if (!is_inf()) {
979*6777b538SAndroid Build Coastguard Worker return static_cast<double>(delta_) / Time::kMicrosecondsPerMillisecond;
980*6777b538SAndroid Build Coastguard Worker }
981*6777b538SAndroid Build Coastguard Worker return (delta_ < 0) ? -std::numeric_limits<double>::infinity()
982*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<double>::infinity();
983*6777b538SAndroid Build Coastguard Worker }
984*6777b538SAndroid Build Coastguard Worker
InMilliseconds()985*6777b538SAndroid Build Coastguard Worker constexpr int64_t TimeDelta::InMilliseconds() const {
986*6777b538SAndroid Build Coastguard Worker if (!is_inf()) {
987*6777b538SAndroid Build Coastguard Worker return delta_ / Time::kMicrosecondsPerMillisecond;
988*6777b538SAndroid Build Coastguard Worker }
989*6777b538SAndroid Build Coastguard Worker return (delta_ < 0) ? std::numeric_limits<int64_t>::min()
990*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<int64_t>::max();
991*6777b538SAndroid Build Coastguard Worker }
992*6777b538SAndroid Build Coastguard Worker
InMillisecondsRoundedUp()993*6777b538SAndroid Build Coastguard Worker constexpr int64_t TimeDelta::InMillisecondsRoundedUp() const {
994*6777b538SAndroid Build Coastguard Worker if (!is_inf()) {
995*6777b538SAndroid Build Coastguard Worker const int64_t result = delta_ / Time::kMicrosecondsPerMillisecond;
996*6777b538SAndroid Build Coastguard Worker // Convert |result| from truncating to ceiling.
997*6777b538SAndroid Build Coastguard Worker return (delta_ > result * Time::kMicrosecondsPerMillisecond) ? (result + 1)
998*6777b538SAndroid Build Coastguard Worker : result;
999*6777b538SAndroid Build Coastguard Worker }
1000*6777b538SAndroid Build Coastguard Worker return delta_;
1001*6777b538SAndroid Build Coastguard Worker }
1002*6777b538SAndroid Build Coastguard Worker
InMicrosecondsF()1003*6777b538SAndroid Build Coastguard Worker constexpr double TimeDelta::InMicrosecondsF() const {
1004*6777b538SAndroid Build Coastguard Worker if (!is_inf()) {
1005*6777b538SAndroid Build Coastguard Worker return static_cast<double>(delta_);
1006*6777b538SAndroid Build Coastguard Worker }
1007*6777b538SAndroid Build Coastguard Worker return (delta_ < 0) ? -std::numeric_limits<double>::infinity()
1008*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<double>::infinity();
1009*6777b538SAndroid Build Coastguard Worker }
1010*6777b538SAndroid Build Coastguard Worker
InNanoseconds()1011*6777b538SAndroid Build Coastguard Worker constexpr int64_t TimeDelta::InNanoseconds() const {
1012*6777b538SAndroid Build Coastguard Worker return base::ClampMul(delta_, Time::kNanosecondsPerMicrosecond);
1013*6777b538SAndroid Build Coastguard Worker }
1014*6777b538SAndroid Build Coastguard Worker
1015*6777b538SAndroid Build Coastguard Worker // static
Max()1016*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta TimeDelta::Max() {
1017*6777b538SAndroid Build Coastguard Worker return TimeDelta(std::numeric_limits<int64_t>::max());
1018*6777b538SAndroid Build Coastguard Worker }
1019*6777b538SAndroid Build Coastguard Worker
1020*6777b538SAndroid Build Coastguard Worker // static
Min()1021*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta TimeDelta::Min() {
1022*6777b538SAndroid Build Coastguard Worker return TimeDelta(std::numeric_limits<int64_t>::min());
1023*6777b538SAndroid Build Coastguard Worker }
1024*6777b538SAndroid Build Coastguard Worker
1025*6777b538SAndroid Build Coastguard Worker // static
FiniteMax()1026*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta TimeDelta::FiniteMax() {
1027*6777b538SAndroid Build Coastguard Worker return TimeDelta(std::numeric_limits<int64_t>::max() - 1);
1028*6777b538SAndroid Build Coastguard Worker }
1029*6777b538SAndroid Build Coastguard Worker
1030*6777b538SAndroid Build Coastguard Worker // static
FiniteMin()1031*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta TimeDelta::FiniteMin() {
1032*6777b538SAndroid Build Coastguard Worker return TimeDelta(std::numeric_limits<int64_t>::min() + 1);
1033*6777b538SAndroid Build Coastguard Worker }
1034*6777b538SAndroid Build Coastguard Worker
1035*6777b538SAndroid Build Coastguard Worker // TimeBase functions that must appear below the declarations of Time/TimeDelta
1036*6777b538SAndroid Build Coastguard Worker namespace time_internal {
1037*6777b538SAndroid Build Coastguard Worker
1038*6777b538SAndroid Build Coastguard Worker template <class TimeClass>
since_origin()1039*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta TimeBase<TimeClass>::since_origin() const {
1040*6777b538SAndroid Build Coastguard Worker return Microseconds(us_);
1041*6777b538SAndroid Build Coastguard Worker }
1042*6777b538SAndroid Build Coastguard Worker
1043*6777b538SAndroid Build Coastguard Worker template <class TimeClass>
1044*6777b538SAndroid Build Coastguard Worker constexpr TimeDelta TimeBase<TimeClass>::operator-(
1045*6777b538SAndroid Build Coastguard Worker const TimeBase<TimeClass>& other) const {
1046*6777b538SAndroid Build Coastguard Worker return Microseconds(us_ - other.us_);
1047*6777b538SAndroid Build Coastguard Worker }
1048*6777b538SAndroid Build Coastguard Worker
1049*6777b538SAndroid Build Coastguard Worker template <class TimeClass>
1050*6777b538SAndroid Build Coastguard Worker constexpr TimeClass TimeBase<TimeClass>::operator+(TimeDelta delta) const {
1051*6777b538SAndroid Build Coastguard Worker return TimeClass((Microseconds(us_) + delta).InMicroseconds());
1052*6777b538SAndroid Build Coastguard Worker }
1053*6777b538SAndroid Build Coastguard Worker
1054*6777b538SAndroid Build Coastguard Worker template <class TimeClass>
1055*6777b538SAndroid Build Coastguard Worker constexpr TimeClass TimeBase<TimeClass>::operator-(TimeDelta delta) const {
1056*6777b538SAndroid Build Coastguard Worker return TimeClass((Microseconds(us_) - delta).InMicroseconds());
1057*6777b538SAndroid Build Coastguard Worker }
1058*6777b538SAndroid Build Coastguard Worker
1059*6777b538SAndroid Build Coastguard Worker } // namespace time_internal
1060*6777b538SAndroid Build Coastguard Worker
1061*6777b538SAndroid Build Coastguard Worker // Time functions that must appear below the declarations of Time/TimeDelta
1062*6777b538SAndroid Build Coastguard Worker
1063*6777b538SAndroid Build Coastguard Worker // static
FromTimeT(time_t tt)1064*6777b538SAndroid Build Coastguard Worker constexpr Time Time::FromTimeT(time_t tt) {
1065*6777b538SAndroid Build Coastguard Worker if (tt == 0)
1066*6777b538SAndroid Build Coastguard Worker return Time(); // Preserve 0 so we can tell it doesn't exist.
1067*6777b538SAndroid Build Coastguard Worker return (tt == std::numeric_limits<time_t>::max())
1068*6777b538SAndroid Build Coastguard Worker ? Max()
1069*6777b538SAndroid Build Coastguard Worker : (UnixEpoch() + Seconds(tt));
1070*6777b538SAndroid Build Coastguard Worker }
1071*6777b538SAndroid Build Coastguard Worker
ToTimeT()1072*6777b538SAndroid Build Coastguard Worker constexpr time_t Time::ToTimeT() const {
1073*6777b538SAndroid Build Coastguard Worker if (is_null()) {
1074*6777b538SAndroid Build Coastguard Worker return 0; // Preserve 0 so we can tell it doesn't exist.
1075*6777b538SAndroid Build Coastguard Worker }
1076*6777b538SAndroid Build Coastguard Worker if (!is_inf()) {
1077*6777b538SAndroid Build Coastguard Worker return saturated_cast<time_t>((*this - UnixEpoch()).InSecondsFloored());
1078*6777b538SAndroid Build Coastguard Worker }
1079*6777b538SAndroid Build Coastguard Worker return (us_ < 0) ? std::numeric_limits<time_t>::min()
1080*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<time_t>::max();
1081*6777b538SAndroid Build Coastguard Worker }
1082*6777b538SAndroid Build Coastguard Worker
1083*6777b538SAndroid Build Coastguard Worker // static
FromSecondsSinceUnixEpoch(double dt)1084*6777b538SAndroid Build Coastguard Worker constexpr Time Time::FromSecondsSinceUnixEpoch(double dt) {
1085*6777b538SAndroid Build Coastguard Worker // Preserve 0.
1086*6777b538SAndroid Build Coastguard Worker //
1087*6777b538SAndroid Build Coastguard Worker // TODO(crbug.com/1495554): This is an unfortunate artifact of WebKit using 0
1088*6777b538SAndroid Build Coastguard Worker // to mean "no time". Add a "...PreservingNull()" version that does this,
1089*6777b538SAndroid Build Coastguard Worker // convert the minimum necessary set of callers to use it, and remove the zero
1090*6777b538SAndroid Build Coastguard Worker // check here.
1091*6777b538SAndroid Build Coastguard Worker return (dt == 0 || isnan(dt)) ? Time() : (UnixEpoch() + Seconds(dt));
1092*6777b538SAndroid Build Coastguard Worker }
1093*6777b538SAndroid Build Coastguard Worker
InSecondsFSinceUnixEpoch()1094*6777b538SAndroid Build Coastguard Worker constexpr double Time::InSecondsFSinceUnixEpoch() const {
1095*6777b538SAndroid Build Coastguard Worker // Preserve 0.
1096*6777b538SAndroid Build Coastguard Worker if (is_null()) {
1097*6777b538SAndroid Build Coastguard Worker return 0;
1098*6777b538SAndroid Build Coastguard Worker }
1099*6777b538SAndroid Build Coastguard Worker if (!is_inf()) {
1100*6777b538SAndroid Build Coastguard Worker return (*this - UnixEpoch()).InSecondsF();
1101*6777b538SAndroid Build Coastguard Worker }
1102*6777b538SAndroid Build Coastguard Worker return (us_ < 0) ? -std::numeric_limits<double>::infinity()
1103*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<double>::infinity();
1104*6777b538SAndroid Build Coastguard Worker }
1105*6777b538SAndroid Build Coastguard Worker
1106*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA)
1107*6777b538SAndroid Build Coastguard Worker // static
FromTimeSpec(const timespec & ts)1108*6777b538SAndroid Build Coastguard Worker constexpr Time Time::FromTimeSpec(const timespec& ts) {
1109*6777b538SAndroid Build Coastguard Worker return FromSecondsSinceUnixEpoch(ts.tv_sec + static_cast<double>(ts.tv_nsec) /
1110*6777b538SAndroid Build Coastguard Worker kNanosecondsPerSecond);
1111*6777b538SAndroid Build Coastguard Worker }
1112*6777b538SAndroid Build Coastguard Worker #endif
1113*6777b538SAndroid Build Coastguard Worker
1114*6777b538SAndroid Build Coastguard Worker // static
FromMillisecondsSinceUnixEpoch(int64_t dt)1115*6777b538SAndroid Build Coastguard Worker constexpr Time Time::FromMillisecondsSinceUnixEpoch(int64_t dt) {
1116*6777b538SAndroid Build Coastguard Worker // TODO(crbug.com/1495554): The lack of zero-preservation here doesn't match
1117*6777b538SAndroid Build Coastguard Worker // InMillisecondsSinceUnixEpoch(), which is dangerous since it means
1118*6777b538SAndroid Build Coastguard Worker // round-trips are not necessarily idempotent. Add "...PreservingNull()"
1119*6777b538SAndroid Build Coastguard Worker // versions that explicitly check for zeros, convert the minimum necessary set
1120*6777b538SAndroid Build Coastguard Worker // of callers to use them, and remove the null-check in
1121*6777b538SAndroid Build Coastguard Worker // InMillisecondsSinceUnixEpoch().
1122*6777b538SAndroid Build Coastguard Worker return UnixEpoch() + Milliseconds(dt);
1123*6777b538SAndroid Build Coastguard Worker }
1124*6777b538SAndroid Build Coastguard Worker
1125*6777b538SAndroid Build Coastguard Worker // static
FromMillisecondsSinceUnixEpoch(double dt)1126*6777b538SAndroid Build Coastguard Worker constexpr Time Time::FromMillisecondsSinceUnixEpoch(double dt) {
1127*6777b538SAndroid Build Coastguard Worker return isnan(dt) ? Time() : (UnixEpoch() + Milliseconds(dt));
1128*6777b538SAndroid Build Coastguard Worker }
1129*6777b538SAndroid Build Coastguard Worker
InMillisecondsSinceUnixEpoch()1130*6777b538SAndroid Build Coastguard Worker constexpr int64_t Time::InMillisecondsSinceUnixEpoch() const {
1131*6777b538SAndroid Build Coastguard Worker // Preserve 0.
1132*6777b538SAndroid Build Coastguard Worker if (is_null()) {
1133*6777b538SAndroid Build Coastguard Worker return 0;
1134*6777b538SAndroid Build Coastguard Worker }
1135*6777b538SAndroid Build Coastguard Worker if (!is_inf()) {
1136*6777b538SAndroid Build Coastguard Worker return (*this - UnixEpoch()).InMilliseconds();
1137*6777b538SAndroid Build Coastguard Worker }
1138*6777b538SAndroid Build Coastguard Worker return (us_ < 0) ? std::numeric_limits<int64_t>::min()
1139*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<int64_t>::max();
1140*6777b538SAndroid Build Coastguard Worker }
1141*6777b538SAndroid Build Coastguard Worker
InMillisecondsFSinceUnixEpoch()1142*6777b538SAndroid Build Coastguard Worker constexpr double Time::InMillisecondsFSinceUnixEpoch() const {
1143*6777b538SAndroid Build Coastguard Worker // Preserve 0.
1144*6777b538SAndroid Build Coastguard Worker return is_null() ? 0 : InMillisecondsFSinceUnixEpochIgnoringNull();
1145*6777b538SAndroid Build Coastguard Worker }
1146*6777b538SAndroid Build Coastguard Worker
InMillisecondsFSinceUnixEpochIgnoringNull()1147*6777b538SAndroid Build Coastguard Worker constexpr double Time::InMillisecondsFSinceUnixEpochIgnoringNull() const {
1148*6777b538SAndroid Build Coastguard Worker // Preserve max and min without offset to prevent over/underflow.
1149*6777b538SAndroid Build Coastguard Worker if (!is_inf()) {
1150*6777b538SAndroid Build Coastguard Worker return (*this - UnixEpoch()).InMillisecondsF();
1151*6777b538SAndroid Build Coastguard Worker }
1152*6777b538SAndroid Build Coastguard Worker return (us_ < 0) ? -std::numeric_limits<double>::infinity()
1153*6777b538SAndroid Build Coastguard Worker : std::numeric_limits<double>::infinity();
1154*6777b538SAndroid Build Coastguard Worker }
1155*6777b538SAndroid Build Coastguard Worker
1156*6777b538SAndroid Build Coastguard Worker // For logging use only.
1157*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::ostream& operator<<(std::ostream& os, Time time);
1158*6777b538SAndroid Build Coastguard Worker
1159*6777b538SAndroid Build Coastguard Worker // TimeTicks ------------------------------------------------------------------
1160*6777b538SAndroid Build Coastguard Worker
1161*6777b538SAndroid Build Coastguard Worker // Represents monotonically non-decreasing clock time.
1162*6777b538SAndroid Build Coastguard Worker class BASE_EXPORT TimeTicks : public time_internal::TimeBase<TimeTicks> {
1163*6777b538SAndroid Build Coastguard Worker public:
1164*6777b538SAndroid Build Coastguard Worker // The underlying clock used to generate new TimeTicks.
1165*6777b538SAndroid Build Coastguard Worker enum class Clock {
1166*6777b538SAndroid Build Coastguard Worker FUCHSIA_ZX_CLOCK_MONOTONIC,
1167*6777b538SAndroid Build Coastguard Worker LINUX_CLOCK_MONOTONIC,
1168*6777b538SAndroid Build Coastguard Worker IOS_CF_ABSOLUTE_TIME_MINUS_KERN_BOOTTIME,
1169*6777b538SAndroid Build Coastguard Worker MAC_MACH_ABSOLUTE_TIME,
1170*6777b538SAndroid Build Coastguard Worker WIN_QPC,
1171*6777b538SAndroid Build Coastguard Worker WIN_ROLLOVER_PROTECTED_TIME_GET_TIME
1172*6777b538SAndroid Build Coastguard Worker };
1173*6777b538SAndroid Build Coastguard Worker
TimeTicks()1174*6777b538SAndroid Build Coastguard Worker constexpr TimeTicks() : TimeBase(0) {}
1175*6777b538SAndroid Build Coastguard Worker
1176*6777b538SAndroid Build Coastguard Worker // Platform-dependent tick count representing "right now." When
1177*6777b538SAndroid Build Coastguard Worker // IsHighResolution() returns false, the resolution of the clock could be
1178*6777b538SAndroid Build Coastguard Worker // as coarse as ~15.6ms. Otherwise, the resolution should be no worse than one
1179*6777b538SAndroid Build Coastguard Worker // microsecond.
1180*6777b538SAndroid Build Coastguard Worker static TimeTicks Now();
1181*6777b538SAndroid Build Coastguard Worker
1182*6777b538SAndroid Build Coastguard Worker // Returns true if the high resolution clock is working on this system and
1183*6777b538SAndroid Build Coastguard Worker // Now() will return high resolution values. Note that, on systems where the
1184*6777b538SAndroid Build Coastguard Worker // high resolution clock works but is deemed inefficient, the low resolution
1185*6777b538SAndroid Build Coastguard Worker // clock will be used instead.
1186*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool IsHighResolution();
1187*6777b538SAndroid Build Coastguard Worker
1188*6777b538SAndroid Build Coastguard Worker // Returns true if TimeTicks is consistent across processes, meaning that
1189*6777b538SAndroid Build Coastguard Worker // timestamps taken on different processes can be safely compared with one
1190*6777b538SAndroid Build Coastguard Worker // another. (Note that, even on platforms where this returns true, time values
1191*6777b538SAndroid Build Coastguard Worker // from different threads that are within one tick of each other must be
1192*6777b538SAndroid Build Coastguard Worker // considered to have an ambiguous ordering.)
1193*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool IsConsistentAcrossProcesses();
1194*6777b538SAndroid Build Coastguard Worker
1195*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_FUCHSIA)
1196*6777b538SAndroid Build Coastguard Worker // Converts between TimeTicks and an ZX_CLOCK_MONOTONIC zx_time_t value.
1197*6777b538SAndroid Build Coastguard Worker static TimeTicks FromZxTime(zx_time_t nanos_since_boot);
1198*6777b538SAndroid Build Coastguard Worker zx_time_t ToZxTime() const;
1199*6777b538SAndroid Build Coastguard Worker #endif
1200*6777b538SAndroid Build Coastguard Worker
1201*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
1202*6777b538SAndroid Build Coastguard Worker // Translates an absolute QPC timestamp into a TimeTicks value. The returned
1203*6777b538SAndroid Build Coastguard Worker // value has the same origin as Now(). Do NOT attempt to use this if
1204*6777b538SAndroid Build Coastguard Worker // IsHighResolution() returns false.
1205*6777b538SAndroid Build Coastguard Worker static TimeTicks FromQPCValue(LONGLONG qpc_value);
1206*6777b538SAndroid Build Coastguard Worker #endif
1207*6777b538SAndroid Build Coastguard Worker
1208*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_APPLE)
1209*6777b538SAndroid Build Coastguard Worker static TimeTicks FromMachAbsoluteTime(uint64_t mach_absolute_time);
1210*6777b538SAndroid Build Coastguard Worker
1211*6777b538SAndroid Build Coastguard Worker // Sets the current Mach timebase to `timebase`. Returns the old timebase.
1212*6777b538SAndroid Build Coastguard Worker static mach_timebase_info_data_t SetMachTimebaseInfoForTesting(
1213*6777b538SAndroid Build Coastguard Worker mach_timebase_info_data_t timebase);
1214*6777b538SAndroid Build Coastguard Worker
1215*6777b538SAndroid Build Coastguard Worker #endif // BUILDFLAG(IS_APPLE)
1216*6777b538SAndroid Build Coastguard Worker
1217*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_CHROMEOS)
1218*6777b538SAndroid Build Coastguard Worker // Converts to TimeTicks the value obtained from SystemClock.uptimeMillis().
1219*6777b538SAndroid Build Coastguard Worker // Note: this conversion may be non-monotonic in relation to previously
1220*6777b538SAndroid Build Coastguard Worker // obtained TimeTicks::Now() values because of the truncation (to
1221*6777b538SAndroid Build Coastguard Worker // milliseconds) performed by uptimeMillis().
1222*6777b538SAndroid Build Coastguard Worker static TimeTicks FromUptimeMillis(int64_t uptime_millis_value);
1223*6777b538SAndroid Build Coastguard Worker
1224*6777b538SAndroid Build Coastguard Worker #endif // BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_CHROMEOS_ASH)
1225*6777b538SAndroid Build Coastguard Worker
1226*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_ANDROID)
1227*6777b538SAndroid Build Coastguard Worker // Converts to TimeTicks the value obtained from System.nanoTime(). This
1228*6777b538SAndroid Build Coastguard Worker // conversion will be monotonic in relation to previously obtained
1229*6777b538SAndroid Build Coastguard Worker // TimeTicks::Now() values as the clocks are based on the same posix monotonic
1230*6777b538SAndroid Build Coastguard Worker // clock, with nanoTime() potentially providing higher resolution.
1231*6777b538SAndroid Build Coastguard Worker static TimeTicks FromJavaNanoTime(int64_t nano_time_value);
1232*6777b538SAndroid Build Coastguard Worker
1233*6777b538SAndroid Build Coastguard Worker // Truncates the TimeTicks value to the precision of SystemClock#uptimeMillis.
1234*6777b538SAndroid Build Coastguard Worker // Note that the clocks already share the same monotonic clock source.
1235*6777b538SAndroid Build Coastguard Worker jlong ToUptimeMillis() const;
1236*6777b538SAndroid Build Coastguard Worker
1237*6777b538SAndroid Build Coastguard Worker // Returns the TimeTicks value as microseconds in the timebase of
1238*6777b538SAndroid Build Coastguard Worker // SystemClock#uptimeMillis.
1239*6777b538SAndroid Build Coastguard Worker // Note that the clocks already share the same monotonic clock source.
1240*6777b538SAndroid Build Coastguard Worker //
1241*6777b538SAndroid Build Coastguard Worker // System.nanoTime() may be used to get sub-millisecond precision in Java code
1242*6777b538SAndroid Build Coastguard Worker // and may be compared against this value as the two share the same clock
1243*6777b538SAndroid Build Coastguard Worker // source (though be sure to convert nanos to micros).
1244*6777b538SAndroid Build Coastguard Worker jlong ToUptimeMicros() const;
1245*6777b538SAndroid Build Coastguard Worker
1246*6777b538SAndroid Build Coastguard Worker #endif // BUILDFLAG(IS_ANDROID)
1247*6777b538SAndroid Build Coastguard Worker
1248*6777b538SAndroid Build Coastguard Worker // Get an estimate of the TimeTick value at the time of the UnixEpoch. Because
1249*6777b538SAndroid Build Coastguard Worker // Time and TimeTicks respond differently to user-set time and NTP
1250*6777b538SAndroid Build Coastguard Worker // adjustments, this number is only an estimate. Nevertheless, this can be
1251*6777b538SAndroid Build Coastguard Worker // useful when you need to relate the value of TimeTicks to a real time and
1252*6777b538SAndroid Build Coastguard Worker // date. Note: Upon first invocation, this function takes a snapshot of the
1253*6777b538SAndroid Build Coastguard Worker // realtime clock to establish a reference point. This function will return
1254*6777b538SAndroid Build Coastguard Worker // the same value for the duration of the application, but will be different
1255*6777b538SAndroid Build Coastguard Worker // in future application runs.
1256*6777b538SAndroid Build Coastguard Worker static TimeTicks UnixEpoch();
1257*6777b538SAndroid Build Coastguard Worker
1258*6777b538SAndroid Build Coastguard Worker static void SetSharedUnixEpoch(TimeTicks);
1259*6777b538SAndroid Build Coastguard Worker
1260*6777b538SAndroid Build Coastguard Worker // Returns |this| snapped to the next tick, given a |tick_phase| and
1261*6777b538SAndroid Build Coastguard Worker // repeating |tick_interval| in both directions. |this| may be before,
1262*6777b538SAndroid Build Coastguard Worker // after, or equal to the |tick_phase|.
1263*6777b538SAndroid Build Coastguard Worker TimeTicks SnappedToNextTick(TimeTicks tick_phase,
1264*6777b538SAndroid Build Coastguard Worker TimeDelta tick_interval) const;
1265*6777b538SAndroid Build Coastguard Worker
1266*6777b538SAndroid Build Coastguard Worker // Returns an enum indicating the underlying clock being used to generate
1267*6777b538SAndroid Build Coastguard Worker // TimeTicks timestamps. This function should only be used for debugging and
1268*6777b538SAndroid Build Coastguard Worker // logging purposes.
1269*6777b538SAndroid Build Coastguard Worker static Clock GetClock();
1270*6777b538SAndroid Build Coastguard Worker
1271*6777b538SAndroid Build Coastguard Worker // Converts an integer value representing TimeTicks to a class. This may be
1272*6777b538SAndroid Build Coastguard Worker // used when deserializing a |TimeTicks| structure, using a value known to be
1273*6777b538SAndroid Build Coastguard Worker // compatible. It is not provided as a constructor because the integer type
1274*6777b538SAndroid Build Coastguard Worker // may be unclear from the perspective of a caller.
1275*6777b538SAndroid Build Coastguard Worker //
1276*6777b538SAndroid Build Coastguard Worker // DEPRECATED - Do not use in new code. For deserializing TimeTicks values,
1277*6777b538SAndroid Build Coastguard Worker // prefer TimeTicks + TimeDelta(); however, be aware that the origin is not
1278*6777b538SAndroid Build Coastguard Worker // fixed and may vary. Serializing for persistence is strongly discouraged.
1279*6777b538SAndroid Build Coastguard Worker // http://crbug.com/634507
FromInternalValue(int64_t us)1280*6777b538SAndroid Build Coastguard Worker static constexpr TimeTicks FromInternalValue(int64_t us) {
1281*6777b538SAndroid Build Coastguard Worker return TimeTicks(us);
1282*6777b538SAndroid Build Coastguard Worker }
1283*6777b538SAndroid Build Coastguard Worker
1284*6777b538SAndroid Build Coastguard Worker protected:
1285*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
1286*6777b538SAndroid Build Coastguard Worker typedef DWORD (*TickFunctionType)(void);
1287*6777b538SAndroid Build Coastguard Worker static TickFunctionType SetMockTickFunction(TickFunctionType ticker);
1288*6777b538SAndroid Build Coastguard Worker #endif
1289*6777b538SAndroid Build Coastguard Worker
1290*6777b538SAndroid Build Coastguard Worker private:
1291*6777b538SAndroid Build Coastguard Worker friend class time_internal::TimeBase<TimeTicks>;
1292*6777b538SAndroid Build Coastguard Worker
1293*6777b538SAndroid Build Coastguard Worker // Please use Now() to create a new object. This is for internal use
1294*6777b538SAndroid Build Coastguard Worker // and testing.
TimeTicks(int64_t us)1295*6777b538SAndroid Build Coastguard Worker constexpr explicit TimeTicks(int64_t us) : TimeBase(us) {}
1296*6777b538SAndroid Build Coastguard Worker };
1297*6777b538SAndroid Build Coastguard Worker
1298*6777b538SAndroid Build Coastguard Worker // For logging use only.
1299*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::ostream& operator<<(std::ostream& os, TimeTicks time_ticks);
1300*6777b538SAndroid Build Coastguard Worker
1301*6777b538SAndroid Build Coastguard Worker // LiveTicks ------------------------------------------------------------------
1302*6777b538SAndroid Build Coastguard Worker
1303*6777b538SAndroid Build Coastguard Worker // Behaves similarly to `TimeTicks` (a monotonically non-decreasing clock time)
1304*6777b538SAndroid Build Coastguard Worker // with the main difference being that `LiveTicks` is guaranteed not to advance
1305*6777b538SAndroid Build Coastguard Worker // while the system is suspended.
1306*6777b538SAndroid Build Coastguard Worker class BASE_EXPORT LiveTicks : public time_internal::TimeBase<LiveTicks> {
1307*6777b538SAndroid Build Coastguard Worker public:
LiveTicks()1308*6777b538SAndroid Build Coastguard Worker constexpr LiveTicks() : TimeBase(0) {}
1309*6777b538SAndroid Build Coastguard Worker static LiveTicks Now();
1310*6777b538SAndroid Build Coastguard Worker
1311*6777b538SAndroid Build Coastguard Worker private:
1312*6777b538SAndroid Build Coastguard Worker friend class time_internal::TimeBase<LiveTicks>;
1313*6777b538SAndroid Build Coastguard Worker
1314*6777b538SAndroid Build Coastguard Worker // Please use Now() to create a new object. This is for internal use
1315*6777b538SAndroid Build Coastguard Worker // and testing.
LiveTicks(int64_t us)1316*6777b538SAndroid Build Coastguard Worker constexpr explicit LiveTicks(int64_t us) : TimeBase(us) {}
1317*6777b538SAndroid Build Coastguard Worker };
1318*6777b538SAndroid Build Coastguard Worker
1319*6777b538SAndroid Build Coastguard Worker // ThreadTicks ----------------------------------------------------------------
1320*6777b538SAndroid Build Coastguard Worker
1321*6777b538SAndroid Build Coastguard Worker // Represents a clock, specific to a particular thread, than runs only while the
1322*6777b538SAndroid Build Coastguard Worker // thread is running.
1323*6777b538SAndroid Build Coastguard Worker class BASE_EXPORT ThreadTicks : public time_internal::TimeBase<ThreadTicks> {
1324*6777b538SAndroid Build Coastguard Worker public:
ThreadTicks()1325*6777b538SAndroid Build Coastguard Worker constexpr ThreadTicks() : TimeBase(0) {}
1326*6777b538SAndroid Build Coastguard Worker
1327*6777b538SAndroid Build Coastguard Worker // Returns true if ThreadTicks::Now() is supported on this system.
IsSupported()1328*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool IsSupported() {
1329*6777b538SAndroid Build Coastguard Worker #if (defined(_POSIX_THREAD_CPUTIME) && (_POSIX_THREAD_CPUTIME >= 0)) || \
1330*6777b538SAndroid Build Coastguard Worker BUILDFLAG(IS_APPLE) || BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_FUCHSIA)
1331*6777b538SAndroid Build Coastguard Worker return true;
1332*6777b538SAndroid Build Coastguard Worker #elif BUILDFLAG(IS_WIN)
1333*6777b538SAndroid Build Coastguard Worker return IsSupportedWin();
1334*6777b538SAndroid Build Coastguard Worker #else
1335*6777b538SAndroid Build Coastguard Worker return false;
1336*6777b538SAndroid Build Coastguard Worker #endif
1337*6777b538SAndroid Build Coastguard Worker }
1338*6777b538SAndroid Build Coastguard Worker
1339*6777b538SAndroid Build Coastguard Worker // Waits until the initialization is completed. Needs to be guarded with a
1340*6777b538SAndroid Build Coastguard Worker // call to IsSupported().
WaitUntilInitialized()1341*6777b538SAndroid Build Coastguard Worker static void WaitUntilInitialized() {
1342*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
1343*6777b538SAndroid Build Coastguard Worker WaitUntilInitializedWin();
1344*6777b538SAndroid Build Coastguard Worker #endif
1345*6777b538SAndroid Build Coastguard Worker }
1346*6777b538SAndroid Build Coastguard Worker
1347*6777b538SAndroid Build Coastguard Worker // Returns thread-specific CPU-time on systems that support this feature.
1348*6777b538SAndroid Build Coastguard Worker // Needs to be guarded with a call to IsSupported(). Use this timer
1349*6777b538SAndroid Build Coastguard Worker // to (approximately) measure how much time the calling thread spent doing
1350*6777b538SAndroid Build Coastguard Worker // actual work vs. being de-scheduled. May return bogus results if the thread
1351*6777b538SAndroid Build Coastguard Worker // migrates to another CPU between two calls. Returns an empty ThreadTicks
1352*6777b538SAndroid Build Coastguard Worker // object until the initialization is completed. If a clock reading is
1353*6777b538SAndroid Build Coastguard Worker // absolutely needed, call WaitUntilInitialized() before this method.
1354*6777b538SAndroid Build Coastguard Worker static ThreadTicks Now();
1355*6777b538SAndroid Build Coastguard Worker
1356*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
1357*6777b538SAndroid Build Coastguard Worker // Similar to Now() above except this returns thread-specific CPU time for an
1358*6777b538SAndroid Build Coastguard Worker // arbitrary thread. All comments for Now() method above apply apply to this
1359*6777b538SAndroid Build Coastguard Worker // method as well.
1360*6777b538SAndroid Build Coastguard Worker static ThreadTicks GetForThread(const PlatformThreadHandle& thread_handle);
1361*6777b538SAndroid Build Coastguard Worker #endif
1362*6777b538SAndroid Build Coastguard Worker
1363*6777b538SAndroid Build Coastguard Worker // Converts an integer value representing ThreadTicks to a class. This may be
1364*6777b538SAndroid Build Coastguard Worker // used when deserializing a |ThreadTicks| structure, using a value known to
1365*6777b538SAndroid Build Coastguard Worker // be compatible. It is not provided as a constructor because the integer type
1366*6777b538SAndroid Build Coastguard Worker // may be unclear from the perspective of a caller.
1367*6777b538SAndroid Build Coastguard Worker //
1368*6777b538SAndroid Build Coastguard Worker // DEPRECATED - Do not use in new code. For deserializing ThreadTicks values,
1369*6777b538SAndroid Build Coastguard Worker // prefer ThreadTicks + TimeDelta(); however, be aware that the origin is not
1370*6777b538SAndroid Build Coastguard Worker // fixed and may vary. Serializing for persistence is strongly
1371*6777b538SAndroid Build Coastguard Worker // discouraged. http://crbug.com/634507
FromInternalValue(int64_t us)1372*6777b538SAndroid Build Coastguard Worker static constexpr ThreadTicks FromInternalValue(int64_t us) {
1373*6777b538SAndroid Build Coastguard Worker return ThreadTicks(us);
1374*6777b538SAndroid Build Coastguard Worker }
1375*6777b538SAndroid Build Coastguard Worker
1376*6777b538SAndroid Build Coastguard Worker private:
1377*6777b538SAndroid Build Coastguard Worker friend class time_internal::TimeBase<ThreadTicks>;
1378*6777b538SAndroid Build Coastguard Worker
1379*6777b538SAndroid Build Coastguard Worker // Please use Now() or GetForThread() to create a new object. This is for
1380*6777b538SAndroid Build Coastguard Worker // internal use and testing.
ThreadTicks(int64_t us)1381*6777b538SAndroid Build Coastguard Worker constexpr explicit ThreadTicks(int64_t us) : TimeBase(us) {}
1382*6777b538SAndroid Build Coastguard Worker
1383*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
1384*6777b538SAndroid Build Coastguard Worker [[nodiscard]] static bool IsSupportedWin();
1385*6777b538SAndroid Build Coastguard Worker static void WaitUntilInitializedWin();
1386*6777b538SAndroid Build Coastguard Worker #endif
1387*6777b538SAndroid Build Coastguard Worker };
1388*6777b538SAndroid Build Coastguard Worker
1389*6777b538SAndroid Build Coastguard Worker // For logging use only.
1390*6777b538SAndroid Build Coastguard Worker BASE_EXPORT std::ostream& operator<<(std::ostream& os, ThreadTicks time_ticks);
1391*6777b538SAndroid Build Coastguard Worker
1392*6777b538SAndroid Build Coastguard Worker } // namespace base
1393*6777b538SAndroid Build Coastguard Worker
1394*6777b538SAndroid Build Coastguard Worker #endif // BASE_TIME_TIME_H_
1395