Unreviewed, rolling out r234489.
[WebKit-https.git] / Source / WTF / wtf / WallTime.h
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef WTF_WallTime_h
27 #define WTF_WallTime_h
28
29 #include <wtf/ClockType.h>
30 #include <wtf/Seconds.h>
31
32 namespace WTF {
33
34 class MonotonicTime;
35 class PrintStream;
36
37 // The current time according to a wall clock (aka real time clock). This uses floating point
38 // internally so that you can reason about infinity and other things that arise in math. It's
39 // acceptable to use this to wrap NaN times, negative times, and infinite times, so long as they
40 // are relative to the same clock. Use this only if wall clock time is needed. For elapsed time
41 // measurement use MonotonicTime instead.
42 class WallTime {
43 public:
44     static const ClockType clockType = ClockType::Wall;
45     
46     // This is the epoch. So, x.secondsSinceEpoch() should be the same as x - WallTime().
47     constexpr WallTime() { }
48     
49     // Call this if you know for sure that the double represents time according to
50     // WTF::currentTime(). It must be in seconds and it must be from the same time source.
51     static constexpr WallTime fromRawSeconds(double value)
52     {
53         return WallTime(value);
54     }
55     
56     WTF_EXPORT_PRIVATE static WallTime now();
57     
58     static constexpr WallTime infinity() { return fromRawSeconds(std::numeric_limits<double>::infinity()); }
59     
60     constexpr Seconds secondsSinceEpoch() const { return Seconds(m_value); }
61     
62     WallTime approximateWallTime() const { return *this; }
63     WTF_EXPORT_PRIVATE MonotonicTime approximateMonotonicTime() const;
64     
65     explicit constexpr operator bool() const { return !!m_value; }
66     
67     constexpr WallTime operator+(Seconds other) const
68     {
69         return fromRawSeconds(m_value + other.value());
70     }
71     
72     constexpr WallTime operator-(Seconds other) const
73     {
74         return fromRawSeconds(m_value - other.value());
75     }
76     
77     // Time is a scalar and scalars can be negated as this could arise from algebraic
78     // transformations. So, we allow it.
79     constexpr WallTime operator-() const
80     {
81         return fromRawSeconds(-m_value);
82     }
83     
84     WallTime& operator+=(Seconds other)
85     {
86         return *this = *this + other;
87     }
88     
89     WallTime& operator-=(Seconds other)
90     {
91         return *this = *this - other;
92     }
93     
94     constexpr Seconds operator-(WallTime other) const
95     {
96         return Seconds(m_value - other.m_value);
97     }
98     
99     constexpr bool operator==(WallTime other) const
100     {
101         return m_value == other.m_value;
102     }
103     
104     constexpr bool operator!=(WallTime other) const
105     {
106         return m_value != other.m_value;
107     }
108     
109     constexpr bool operator<(WallTime other) const
110     {
111         return m_value < other.m_value;
112     }
113     
114     constexpr bool operator>(WallTime other) const
115     {
116         return m_value > other.m_value;
117     }
118     
119     constexpr bool operator<=(WallTime other) const
120     {
121         return m_value <= other.m_value;
122     }
123     
124     constexpr bool operator>=(WallTime other) const
125     {
126         return m_value >= other.m_value;
127     }
128     
129     WTF_EXPORT_PRIVATE void dump(PrintStream&) const;
130     
131     WallTime isolatedCopy() const
132     {
133         return *this;
134     }
135 private:
136     constexpr WallTime(double rawValue)
137         : m_value(rawValue)
138     {
139     }
140
141     double m_value { 0 };
142 };
143
144 WTF_EXPORT_PRIVATE void sleep(WallTime);
145
146 } // namespace WTF
147
148 namespace std {
149
150 inline bool isnan(WTF::WallTime time)
151 {
152     return std::isnan(time.secondsSinceEpoch().value());
153 }
154
155 inline bool isinf(WTF::WallTime time)
156 {
157     return std::isinf(time.secondsSinceEpoch().value());
158 }
159
160 inline bool isfinite(WTF::WallTime time)
161 {
162     return std::isfinite(time.secondsSinceEpoch().value());
163 }
164
165 } // namespace std
166
167 using WTF::WallTime;
168
169 #endif // WTF_WallTime_h