W3C importer should be able to update the import expectations file
[WebKit-https.git] / Source / WebCore / platform / Timer.cpp
1 /*
2  * Copyright (C) 2006, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #include "config.h"
28 #include "Timer.h"
29
30 #include "SharedTimer.h"
31 #include "ThreadGlobalData.h"
32 #include "ThreadTimers.h"
33 #include <limits.h>
34 #include <limits>
35 #include <math.h>
36 #include <wtf/CurrentTime.h>
37 #include <wtf/MainThread.h>
38 #include <wtf/Vector.h>
39
40 namespace WebCore {
41
42 class TimerHeapReference;
43
44 // Timers are stored in a heap data structure, used to implement a priority queue.
45 // This allows us to efficiently determine which timer needs to fire the soonest.
46 // Then we set a single shared system timer to fire at that time.
47 //
48 // When a timer's "next fire time" changes, we need to move it around in the priority queue.
49 static Vector<TimerBase*>& threadGlobalTimerHeap()
50 {
51     return threadGlobalData().threadTimers().timerHeap();
52 }
53 // ----------------
54
55 class TimerHeapPointer {
56 public:
57     TimerHeapPointer(TimerBase** pointer) : m_pointer(pointer) { }
58     TimerHeapReference operator*() const;
59     TimerBase* operator->() const { return *m_pointer; }
60 private:
61     TimerBase** m_pointer;
62 };
63
64 class TimerHeapReference {
65 public:
66     TimerHeapReference(TimerBase*& reference) : m_reference(reference) { }
67     operator TimerBase*() const { return m_reference; }
68     TimerHeapPointer operator&() const { return &m_reference; }
69     TimerHeapReference& operator=(TimerBase*);
70     TimerHeapReference& operator=(TimerHeapReference);
71 private:
72     TimerBase*& m_reference;
73 };
74
75 inline TimerHeapReference TimerHeapPointer::operator*() const
76 {
77     return *m_pointer;
78 }
79
80 inline TimerHeapReference& TimerHeapReference::operator=(TimerBase* timer)
81 {
82     m_reference = timer;
83     Vector<TimerBase*>& heap = timer->timerHeap();
84     if (&m_reference >= heap.data() && &m_reference < heap.data() + heap.size())
85         timer->m_heapIndex = &m_reference - heap.data();
86     return *this;
87 }
88
89 inline TimerHeapReference& TimerHeapReference::operator=(TimerHeapReference b)
90 {
91     TimerBase* timer = b;
92     return *this = timer;
93 }
94
95 inline void swap(TimerHeapReference a, TimerHeapReference b)
96 {
97     TimerBase* timerA = a;
98     TimerBase* timerB = b;
99
100     // Invoke the assignment operator, since that takes care of updating m_heapIndex.
101     a = timerB;
102     b = timerA;
103 }
104
105 // ----------------
106
107 // Class to represent iterators in the heap when calling the standard library heap algorithms.
108 // Uses a custom pointer and reference type that update indices for pointers in the heap.
109 class TimerHeapIterator : public std::iterator<std::random_access_iterator_tag, TimerBase*, ptrdiff_t, TimerHeapPointer, TimerHeapReference> {
110 public:
111     explicit TimerHeapIterator(TimerBase** pointer) : m_pointer(pointer) { checkConsistency(); }
112
113     TimerHeapIterator& operator++() { checkConsistency(); ++m_pointer; checkConsistency(); return *this; }
114     TimerHeapIterator operator++(int) { checkConsistency(1); return TimerHeapIterator(m_pointer++); }
115
116     TimerHeapIterator& operator--() { checkConsistency(); --m_pointer; checkConsistency(); return *this; }
117     TimerHeapIterator operator--(int) { checkConsistency(-1); return TimerHeapIterator(m_pointer--); }
118
119     TimerHeapIterator& operator+=(ptrdiff_t i) { checkConsistency(); m_pointer += i; checkConsistency(); return *this; }
120     TimerHeapIterator& operator-=(ptrdiff_t i) { checkConsistency(); m_pointer -= i; checkConsistency(); return *this; }
121
122     TimerHeapReference operator*() const { return TimerHeapReference(*m_pointer); }
123     TimerHeapReference operator[](ptrdiff_t i) const { return TimerHeapReference(m_pointer[i]); }
124     TimerBase* operator->() const { return *m_pointer; }
125
126 private:
127     void checkConsistency(ptrdiff_t offset = 0) const
128     {
129         ASSERT(m_pointer >= threadGlobalTimerHeap().data());
130         ASSERT(m_pointer <= threadGlobalTimerHeap().data() + threadGlobalTimerHeap().size());
131         ASSERT_UNUSED(offset, m_pointer + offset >= threadGlobalTimerHeap().data());
132         ASSERT_UNUSED(offset, m_pointer + offset <= threadGlobalTimerHeap().data() + threadGlobalTimerHeap().size());
133     }
134
135     friend bool operator==(TimerHeapIterator, TimerHeapIterator);
136     friend bool operator!=(TimerHeapIterator, TimerHeapIterator);
137     friend bool operator<(TimerHeapIterator, TimerHeapIterator);
138     friend bool operator>(TimerHeapIterator, TimerHeapIterator);
139     friend bool operator<=(TimerHeapIterator, TimerHeapIterator);
140     friend bool operator>=(TimerHeapIterator, TimerHeapIterator);
141     
142     friend TimerHeapIterator operator+(TimerHeapIterator, size_t);
143     friend TimerHeapIterator operator+(size_t, TimerHeapIterator);
144     
145     friend TimerHeapIterator operator-(TimerHeapIterator, size_t);
146     friend ptrdiff_t operator-(TimerHeapIterator, TimerHeapIterator);
147
148     TimerBase** m_pointer;
149 };
150
151 inline bool operator==(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer == b.m_pointer; }
152 inline bool operator!=(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer != b.m_pointer; }
153 inline bool operator<(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer < b.m_pointer; }
154 inline bool operator>(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer > b.m_pointer; }
155 inline bool operator<=(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer <= b.m_pointer; }
156 inline bool operator>=(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer >= b.m_pointer; }
157
158 inline TimerHeapIterator operator+(TimerHeapIterator a, size_t b) { return TimerHeapIterator(a.m_pointer + b); }
159 inline TimerHeapIterator operator+(size_t a, TimerHeapIterator b) { return TimerHeapIterator(a + b.m_pointer); }
160
161 inline TimerHeapIterator operator-(TimerHeapIterator a, size_t b) { return TimerHeapIterator(a.m_pointer - b); }
162 inline ptrdiff_t operator-(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer - b.m_pointer; }
163
164 // ----------------
165
166 class TimerHeapLessThanFunction {
167 public:
168     bool operator()(const TimerBase*, const TimerBase*) const;
169 };
170
171 inline bool TimerHeapLessThanFunction::operator()(const TimerBase* a, const TimerBase* b) const
172 {
173     // The comparisons below are "backwards" because the heap puts the largest 
174     // element first and we want the lowest time to be the first one in the heap.
175     double aFireTime = a->m_nextFireTime;
176     double bFireTime = b->m_nextFireTime;
177     if (bFireTime != aFireTime)
178         return bFireTime < aFireTime;
179     
180     // We need to look at the difference of the insertion orders instead of comparing the two 
181     // outright in case of overflow. 
182     unsigned difference = a->m_heapInsertionOrder - b->m_heapInsertionOrder;
183     return difference < std::numeric_limits<unsigned>::max() / 2;
184 }
185
186 // ----------------
187
188 TimerBase::TimerBase()
189     : m_nextFireTime(0)
190     , m_unalignedNextFireTime(0)
191     , m_repeatInterval(0)
192     , m_heapIndex(-1)
193     , m_cachedThreadGlobalTimerHeap(0)
194 #ifndef NDEBUG
195     , m_thread(currentThread())
196     , m_wasDeleted(false)
197 #endif
198 {
199 }
200
201 TimerBase::~TimerBase()
202 {
203     stop();
204     ASSERT(!inHeap());
205 #ifndef NDEBUG
206     m_wasDeleted = true;
207 #endif
208 }
209
210 void TimerBase::start(double nextFireInterval, double repeatInterval)
211 {
212     ASSERT(canAccessThreadLocalDataForThread(m_thread));
213
214     m_repeatInterval = repeatInterval;
215     setNextFireTime(monotonicallyIncreasingTime() + nextFireInterval);
216 }
217
218 void TimerBase::stop()
219 {
220     ASSERT(canAccessThreadLocalDataForThread(m_thread));
221
222     m_repeatInterval = 0;
223     setNextFireTime(0);
224
225     ASSERT(m_nextFireTime == 0);
226     ASSERT(m_repeatInterval == 0);
227     ASSERT(!inHeap());
228 }
229
230 double TimerBase::nextFireInterval() const
231 {
232     ASSERT(isActive());
233     double current = monotonicallyIncreasingTime();
234     if (m_nextFireTime < current)
235         return 0;
236     return m_nextFireTime - current;
237 }
238
239 inline void TimerBase::checkHeapIndex() const
240 {
241     ASSERT(timerHeap() == threadGlobalTimerHeap());
242     ASSERT(!timerHeap().isEmpty());
243     ASSERT(m_heapIndex >= 0);
244     ASSERT(m_heapIndex < static_cast<int>(timerHeap().size()));
245     ASSERT(timerHeap()[m_heapIndex] == this);
246 }
247
248 inline void TimerBase::checkConsistency() const
249 {
250     // Timers should be in the heap if and only if they have a non-zero next fire time.
251     ASSERT(inHeap() == (m_nextFireTime != 0));
252     if (inHeap())
253         checkHeapIndex();
254 }
255
256 void TimerBase::heapDecreaseKey()
257 {
258     ASSERT(m_nextFireTime != 0);
259     checkHeapIndex();
260     TimerBase** heapData = timerHeap().data();
261     push_heap(TimerHeapIterator(heapData), TimerHeapIterator(heapData + m_heapIndex + 1), TimerHeapLessThanFunction());
262     checkHeapIndex();
263 }
264
265 inline void TimerBase::heapDelete()
266 {
267     ASSERT(m_nextFireTime == 0);
268     heapPop();
269     timerHeap().removeLast();
270     m_heapIndex = -1;
271 }
272
273 void TimerBase::heapDeleteMin()
274 {
275     ASSERT(m_nextFireTime == 0);
276     heapPopMin();
277     timerHeap().removeLast();
278     m_heapIndex = -1;
279 }
280
281 inline void TimerBase::heapIncreaseKey()
282 {
283     ASSERT(m_nextFireTime != 0);
284     heapPop();
285     heapDecreaseKey();
286 }
287
288 inline void TimerBase::heapInsert()
289 {
290     ASSERT(!inHeap());
291     timerHeap().append(this);
292     m_heapIndex = timerHeap().size() - 1;
293     heapDecreaseKey();
294 }
295
296 inline void TimerBase::heapPop()
297 {
298     // Temporarily force this timer to have the minimum key so we can pop it.
299     double fireTime = m_nextFireTime;
300     m_nextFireTime = -std::numeric_limits<double>::infinity();
301     heapDecreaseKey();
302     heapPopMin();
303     m_nextFireTime = fireTime;
304 }
305
306 void TimerBase::heapPopMin()
307 {
308     ASSERT(this == timerHeap().first());
309     checkHeapIndex();
310     Vector<TimerBase*>& heap = timerHeap();
311     TimerBase** heapData = heap.data();
312     pop_heap(TimerHeapIterator(heapData), TimerHeapIterator(heapData + heap.size()), TimerHeapLessThanFunction());
313     checkHeapIndex();
314     ASSERT(this == timerHeap().last());
315 }
316
317 static inline bool parentHeapPropertyHolds(const TimerBase* current, const Vector<TimerBase*>& heap, unsigned currentIndex)
318 {
319     if (!currentIndex)
320         return true;
321     unsigned parentIndex = (currentIndex - 1) / 2;
322     TimerHeapLessThanFunction compareHeapPosition;
323     return compareHeapPosition(current, heap[parentIndex]);
324 }
325
326 static inline bool childHeapPropertyHolds(const TimerBase* current, const Vector<TimerBase*>& heap, unsigned childIndex)
327 {
328     if (childIndex >= heap.size())
329         return true;
330     TimerHeapLessThanFunction compareHeapPosition;
331     return compareHeapPosition(heap[childIndex], current);
332 }
333
334 bool TimerBase::hasValidHeapPosition() const
335 {
336     ASSERT(m_nextFireTime);
337     if (!inHeap())
338         return false;
339     // Check if the heap property still holds with the new fire time. If it does we don't need to do anything.
340     // This assumes that the STL heap is a standard binary heap. In an unlikely event it is not, the assertions
341     // in updateHeapIfNeeded() will get hit.
342     const Vector<TimerBase*>& heap = timerHeap();
343     if (!parentHeapPropertyHolds(this, heap, m_heapIndex))
344         return false;
345     unsigned childIndex1 = 2 * m_heapIndex + 1;
346     unsigned childIndex2 = childIndex1 + 1;
347     return childHeapPropertyHolds(this, heap, childIndex1) && childHeapPropertyHolds(this, heap, childIndex2);
348 }
349
350 void TimerBase::updateHeapIfNeeded(double oldTime)
351 {
352     if (m_nextFireTime && hasValidHeapPosition())
353         return;
354 #ifndef NDEBUG
355     int oldHeapIndex = m_heapIndex;
356 #endif
357     if (!oldTime)
358         heapInsert();
359     else if (!m_nextFireTime)
360         heapDelete();
361     else if (m_nextFireTime < oldTime)
362         heapDecreaseKey();
363     else
364         heapIncreaseKey();
365     ASSERT(m_heapIndex != oldHeapIndex);
366     ASSERT(!inHeap() || hasValidHeapPosition());
367 }
368
369 void TimerBase::setNextFireTime(double newTime)
370 {
371     ASSERT(canAccessThreadLocalDataForThread(m_thread));
372     ASSERT(!m_wasDeleted);
373
374     if (m_unalignedNextFireTime != newTime)
375         m_unalignedNextFireTime = newTime;
376
377     // Accessing thread global data is slow. Cache the heap pointer.
378     if (!m_cachedThreadGlobalTimerHeap)
379         m_cachedThreadGlobalTimerHeap = &threadGlobalTimerHeap();
380
381     // Keep heap valid while changing the next-fire time.
382     double oldTime = m_nextFireTime;
383     // Don't realign zero-delay timers.
384     if (newTime) {
385         if (auto newAlignedTime = alignedFireTime(secondsToMS(newTime)))
386             newTime = msToSeconds(newAlignedTime.value());
387     }
388
389     if (oldTime != newTime) {
390         m_nextFireTime = newTime;
391         // FIXME: This should be part of ThreadTimers, or another per-thread structure.
392         static std::atomic<unsigned> currentHeapInsertionOrder;
393         m_heapInsertionOrder = currentHeapInsertionOrder++;
394
395         bool wasFirstTimerInHeap = m_heapIndex == 0;
396
397         updateHeapIfNeeded(oldTime);
398
399         bool isFirstTimerInHeap = m_heapIndex == 0;
400
401         if (wasFirstTimerInHeap || isFirstTimerInHeap)
402             threadGlobalData().threadTimers().updateSharedTimer();
403     }
404
405     checkConsistency();
406 }
407
408 void TimerBase::fireTimersInNestedEventLoop()
409 {
410     // Redirect to ThreadTimers.
411     threadGlobalData().threadTimers().fireTimersInNestedEventLoop();
412 }
413
414 void TimerBase::didChangeAlignmentInterval()
415 {
416     setNextFireTime(m_unalignedNextFireTime);
417 }
418
419 double TimerBase::nextUnalignedFireInterval() const
420 {
421     ASSERT(isActive());
422     return std::max(m_unalignedNextFireTime - monotonicallyIncreasingTime(), 0.0);
423 }
424
425 } // namespace WebCore
426