Update ANGLE
[WebKit-https.git] / Source / WebCore / platform / Timer.h
1 /*
2  * Copyright (C) 2006 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 Timer_h
27 #define Timer_h
28
29 #include <chrono>
30 #include <functional>
31 #include <wtf/Noncopyable.h>
32 #include <wtf/Optional.h>
33 #include <wtf/Threading.h>
34 #include <wtf/Vector.h>
35
36 #if PLATFORM(IOS)
37 #include "WebCoreThread.h"
38 #endif
39
40 namespace WebCore {
41
42 // Time intervals are all in seconds.
43
44 class TimerHeapElement;
45
46 class TimerBase {
47     WTF_MAKE_NONCOPYABLE(TimerBase);
48     WTF_MAKE_FAST_ALLOCATED;
49 protected:
50     static inline double msToSeconds(std::chrono::milliseconds duration) { return duration.count() * 0.001; }
51     static inline std::chrono::milliseconds secondsToMS(double duration) { return std::chrono::milliseconds((std::chrono::milliseconds::rep)(duration * 1000)); }
52
53 public:
54     WEBCORE_EXPORT TimerBase();
55     WEBCORE_EXPORT virtual ~TimerBase();
56
57     WEBCORE_EXPORT void start(double nextFireInterval, double repeatInterval);
58
59     void startRepeating(double repeatInterval) { start(repeatInterval, repeatInterval); }
60     void startRepeating(std::chrono::milliseconds repeatInterval) { startRepeating(msToSeconds(repeatInterval)); }
61     void startOneShot(double interval) { start(interval, 0); }
62     void startOneShot(std::chrono::milliseconds interval) { startOneShot(msToSeconds(interval)); }
63
64     WEBCORE_EXPORT void stop();
65     bool isActive() const;
66
67     double nextFireInterval() const;
68     double nextUnalignedFireInterval() const;
69     double repeatInterval() const { return m_repeatInterval; }
70     std::chrono::milliseconds repeatIntervalMS() const { return secondsToMS(repeatInterval()); }
71
72     void augmentFireInterval(double delta) { setNextFireTime(m_nextFireTime + delta); }
73     void augmentFireInterval(std::chrono::milliseconds delta) { augmentFireInterval(msToSeconds(delta)); }
74     void augmentRepeatInterval(double delta) { augmentFireInterval(delta); m_repeatInterval += delta; }
75     void augmentRepeatInterval(std::chrono::milliseconds delta) { augmentRepeatInterval(msToSeconds(delta)); }
76
77     void didChangeAlignmentInterval();
78
79     static void fireTimersInNestedEventLoop();
80
81 private:
82     virtual void fired() = 0;
83
84     virtual Optional<std::chrono::milliseconds> alignedFireTime(std::chrono::milliseconds) const { return Nullopt; }
85
86     void checkConsistency() const;
87     void checkHeapIndex() const;
88
89     void setNextFireTime(double);
90
91     bool inHeap() const { return m_heapIndex != -1; }
92
93     bool hasValidHeapPosition() const;
94     void updateHeapIfNeeded(double oldTime);
95
96     void heapDecreaseKey();
97     void heapDelete();
98     void heapDeleteMin();
99     void heapIncreaseKey();
100     void heapInsert();
101     void heapPop();
102     void heapPopMin();
103
104     Vector<TimerBase*>& timerHeap() const { ASSERT(m_cachedThreadGlobalTimerHeap); return *m_cachedThreadGlobalTimerHeap; }
105
106     double m_nextFireTime; // 0 if inactive
107     double m_unalignedNextFireTime; // m_nextFireTime not considering alignment interval
108     double m_repeatInterval; // 0 if not repeating
109     int m_heapIndex; // -1 if not in heap
110     unsigned m_heapInsertionOrder; // Used to keep order among equal-fire-time timers
111     Vector<TimerBase*>* m_cachedThreadGlobalTimerHeap;
112
113 #ifndef NDEBUG
114     ThreadIdentifier m_thread;
115     bool m_wasDeleted;
116 #endif
117
118     friend class ThreadTimers;
119     friend class TimerHeapLessThanFunction;
120     friend class TimerHeapReference;
121 };
122
123
124 class Timer : public TimerBase {
125     WTF_MAKE_FAST_ALLOCATED;
126 public:
127     template <typename TimerFiredClass, typename TimerFiredBaseClass>
128     Timer(TimerFiredClass& object, void (TimerFiredBaseClass::*function)())
129         : m_function(std::bind(function, &object))
130     {
131     }
132
133     Timer(std::function<void ()> function)
134         : m_function(WTFMove(function))
135     {
136     }
137
138 private:
139     void fired() override
140     {
141         m_function();
142     }
143     
144     std::function<void ()> m_function;
145 };
146
147 inline bool TimerBase::isActive() const
148 {
149     // FIXME: Write this in terms of USE(WEB_THREAD) instead of PLATFORM(IOS).
150 #if !PLATFORM(IOS)
151     ASSERT(m_thread == currentThread());
152 #else
153     ASSERT(WebThreadIsCurrent() || pthread_main_np() || m_thread == currentThread());
154 #endif // PLATFORM(IOS)
155     return m_nextFireTime;
156 }
157
158 class DeferrableOneShotTimer : protected TimerBase {
159 public:
160     template<typename TimerFiredClass>
161     DeferrableOneShotTimer(TimerFiredClass& object, void (TimerFiredClass::*function)(), std::chrono::milliseconds delay)
162         : DeferrableOneShotTimer(std::bind(function, &object), delay)
163     {
164     }
165
166     DeferrableOneShotTimer(std::function<void ()> function, std::chrono::milliseconds delay)
167         : m_function(WTFMove(function))
168         , m_delay(delay)
169         , m_shouldRestartWhenTimerFires(false)
170     {
171     }
172
173     void restart()
174     {
175         // Setting this boolean is much more efficient than calling startOneShot
176         // again, which might result in rescheduling the system timer which
177         // can be quite expensive.
178
179         if (isActive()) {
180             m_shouldRestartWhenTimerFires = true;
181             return;
182         }
183         startOneShot(m_delay);
184     }
185
186     void stop()
187     {
188         m_shouldRestartWhenTimerFires = false;
189         TimerBase::stop();
190     }
191
192     using TimerBase::isActive;
193
194 private:
195     void fired() override
196     {
197         if (m_shouldRestartWhenTimerFires) {
198             m_shouldRestartWhenTimerFires = false;
199             startOneShot(m_delay);
200             return;
201         }
202
203         m_function();
204     }
205
206     std::function<void ()> m_function;
207
208     std::chrono::milliseconds m_delay;
209     bool m_shouldRestartWhenTimerFires;
210 };
211
212 }
213
214 #endif