9ccb4021f503378a86224e4a6d751da48a932677
[WebKit.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     MonotonicTime aFireTime = a->m_nextFireTime;
176     MonotonicTime 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 #ifndef NDEBUG
190     : m_thread(currentThread())
191 #endif
192 {
193 }
194
195 TimerBase::~TimerBase()
196 {
197     stop();
198     ASSERT(!inHeap());
199 #ifndef NDEBUG
200     m_wasDeleted = true;
201 #endif
202 }
203
204 void TimerBase::start(Seconds nextFireInterval, Seconds repeatInterval)
205 {
206     ASSERT(canAccessThreadLocalDataForThread(m_thread));
207
208     m_repeatInterval = repeatInterval;
209     setNextFireTime(MonotonicTime::now() + nextFireInterval);
210 }
211
212 void TimerBase::stop()
213 {
214     ASSERT(canAccessThreadLocalDataForThread(m_thread));
215
216     m_repeatInterval = 0_s;
217     setNextFireTime(MonotonicTime { });
218
219     ASSERT(!static_cast<bool>(m_nextFireTime));
220     ASSERT(m_repeatInterval == 0_s);
221     ASSERT(!inHeap());
222 }
223
224 Seconds TimerBase::nextFireInterval() const
225 {
226     ASSERT(isActive());
227     MonotonicTime current = MonotonicTime::now();
228     if (m_nextFireTime < current)
229         return 0_s;
230     return m_nextFireTime - current;
231 }
232
233 inline void TimerBase::checkHeapIndex() const
234 {
235     ASSERT(timerHeap() == threadGlobalTimerHeap());
236     ASSERT(!timerHeap().isEmpty());
237     ASSERT(m_heapIndex >= 0);
238     ASSERT(m_heapIndex < static_cast<int>(timerHeap().size()));
239     ASSERT(timerHeap()[m_heapIndex] == this);
240 }
241
242 inline void TimerBase::checkConsistency() const
243 {
244     // Timers should be in the heap if and only if they have a non-zero next fire time.
245     ASSERT(inHeap() == static_cast<bool>(m_nextFireTime));
246     if (inHeap())
247         checkHeapIndex();
248 }
249
250 void TimerBase::heapDecreaseKey()
251 {
252     ASSERT(static_cast<bool>(m_nextFireTime));
253     checkHeapIndex();
254     TimerBase** heapData = timerHeap().data();
255     push_heap(TimerHeapIterator(heapData), TimerHeapIterator(heapData + m_heapIndex + 1), TimerHeapLessThanFunction());
256     checkHeapIndex();
257 }
258
259 inline void TimerBase::heapDelete()
260 {
261     ASSERT(!static_cast<bool>(m_nextFireTime));
262     heapPop();
263     timerHeap().removeLast();
264     m_heapIndex = -1;
265 }
266
267 void TimerBase::heapDeleteMin()
268 {
269     ASSERT(!static_cast<bool>(m_nextFireTime));
270     heapPopMin();
271     timerHeap().removeLast();
272     m_heapIndex = -1;
273 }
274
275 inline void TimerBase::heapIncreaseKey()
276 {
277     ASSERT(static_cast<bool>(m_nextFireTime));
278     heapPop();
279     heapDecreaseKey();
280 }
281
282 inline void TimerBase::heapInsert()
283 {
284     ASSERT(!inHeap());
285     timerHeap().append(this);
286     m_heapIndex = timerHeap().size() - 1;
287     heapDecreaseKey();
288 }
289
290 inline void TimerBase::heapPop()
291 {
292     // Temporarily force this timer to have the minimum key so we can pop it.
293     MonotonicTime fireTime = m_nextFireTime;
294     m_nextFireTime = -MonotonicTime::infinity();
295     heapDecreaseKey();
296     heapPopMin();
297     m_nextFireTime = fireTime;
298 }
299
300 void TimerBase::heapPopMin()
301 {
302     ASSERT(this == timerHeap().first());
303     checkHeapIndex();
304     Vector<TimerBase*>& heap = timerHeap();
305     TimerBase** heapData = heap.data();
306     pop_heap(TimerHeapIterator(heapData), TimerHeapIterator(heapData + heap.size()), TimerHeapLessThanFunction());
307     checkHeapIndex();
308     ASSERT(this == timerHeap().last());
309 }
310
311 static inline bool parentHeapPropertyHolds(const TimerBase* current, const Vector<TimerBase*>& heap, unsigned currentIndex)
312 {
313     if (!currentIndex)
314         return true;
315     unsigned parentIndex = (currentIndex - 1) / 2;
316     TimerHeapLessThanFunction compareHeapPosition;
317     return compareHeapPosition(current, heap[parentIndex]);
318 }
319
320 static inline bool childHeapPropertyHolds(const TimerBase* current, const Vector<TimerBase*>& heap, unsigned childIndex)
321 {
322     if (childIndex >= heap.size())
323         return true;
324     TimerHeapLessThanFunction compareHeapPosition;
325     return compareHeapPosition(heap[childIndex], current);
326 }
327
328 bool TimerBase::hasValidHeapPosition() const
329 {
330     ASSERT(m_nextFireTime);
331     if (!inHeap())
332         return false;
333     // Check if the heap property still holds with the new fire time. If it does we don't need to do anything.
334     // This assumes that the STL heap is a standard binary heap. In an unlikely event it is not, the assertions
335     // in updateHeapIfNeeded() will get hit.
336     const Vector<TimerBase*>& heap = timerHeap();
337     if (!parentHeapPropertyHolds(this, heap, m_heapIndex))
338         return false;
339     unsigned childIndex1 = 2 * m_heapIndex + 1;
340     unsigned childIndex2 = childIndex1 + 1;
341     return childHeapPropertyHolds(this, heap, childIndex1) && childHeapPropertyHolds(this, heap, childIndex2);
342 }
343
344 void TimerBase::updateHeapIfNeeded(MonotonicTime oldTime)
345 {
346     if (m_nextFireTime && hasValidHeapPosition())
347         return;
348 #ifndef NDEBUG
349     int oldHeapIndex = m_heapIndex;
350 #endif
351     if (!oldTime)
352         heapInsert();
353     else if (!m_nextFireTime)
354         heapDelete();
355     else if (m_nextFireTime < oldTime)
356         heapDecreaseKey();
357     else
358         heapIncreaseKey();
359     ASSERT(m_heapIndex != oldHeapIndex);
360     ASSERT(!inHeap() || hasValidHeapPosition());
361 }
362
363 void TimerBase::setNextFireTime(MonotonicTime newTime)
364 {
365     ASSERT(canAccessThreadLocalDataForThread(m_thread));
366     ASSERT(!m_wasDeleted);
367
368     if (m_unalignedNextFireTime != newTime)
369         m_unalignedNextFireTime = newTime;
370
371     // Accessing thread global data is slow. Cache the heap pointer.
372     if (!m_cachedThreadGlobalTimerHeap)
373         m_cachedThreadGlobalTimerHeap = &threadGlobalTimerHeap();
374
375     // Keep heap valid while changing the next-fire time.
376     MonotonicTime oldTime = m_nextFireTime;
377     // Don't realign zero-delay timers.
378     if (newTime) {
379         if (auto newAlignedTime = alignedFireTime(newTime))
380             newTime = newAlignedTime.value();
381     }
382
383     if (oldTime != newTime) {
384         m_nextFireTime = newTime;
385         // FIXME: This should be part of ThreadTimers, or another per-thread structure.
386         static std::atomic<unsigned> currentHeapInsertionOrder;
387         m_heapInsertionOrder = currentHeapInsertionOrder++;
388
389         bool wasFirstTimerInHeap = m_heapIndex == 0;
390
391         updateHeapIfNeeded(oldTime);
392
393         bool isFirstTimerInHeap = m_heapIndex == 0;
394
395         if (wasFirstTimerInHeap || isFirstTimerInHeap)
396             threadGlobalData().threadTimers().updateSharedTimer();
397     }
398
399     checkConsistency();
400 }
401
402 void TimerBase::fireTimersInNestedEventLoop()
403 {
404     // Redirect to ThreadTimers.
405     threadGlobalData().threadTimers().fireTimersInNestedEventLoop();
406 }
407
408 void TimerBase::didChangeAlignmentInterval()
409 {
410     setNextFireTime(m_unalignedNextFireTime);
411 }
412
413 Seconds TimerBase::nextUnalignedFireInterval() const
414 {
415     ASSERT(isActive());
416     return std::max(m_unalignedNextFireTime - MonotonicTime::now(), 0_s);
417 }
418
419 } // namespace WebCore
420