Timer scheduling should be based off the monotonic clock
[WebKit-https.git] / Source / WebCore / platform / ThreadTimers.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 COMPUTER, 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 COMPUTER, 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 "ThreadTimers.h"
29
30 #include "SharedTimer.h"
31 #include "ThreadGlobalData.h"
32 #include "Timer.h"
33 #include <wtf/CurrentTime.h>
34
35 using namespace std;
36
37 namespace WebCore {
38
39 // Fire timers for this length of time, and then quit to let the run loop process user input events.
40 // 100ms is about a perceptable delay in UI, so use a half of that as a threshold.
41 // This is to prevent UI freeze when there are too many timers or machine performance is low.
42 static const double maxDurationOfFiringTimers = 0.050;
43
44 // Timers are created, started and fired on the same thread, and each thread has its own ThreadTimers
45 // copy to keep the heap and a set of currently firing timers.
46
47 static MainThreadSharedTimer* mainThreadSharedTimer()
48 {
49     static MainThreadSharedTimer* timer = new MainThreadSharedTimer;
50     return timer;
51 }
52
53 ThreadTimers::ThreadTimers()
54     : m_sharedTimer(0)
55     , m_firingTimers(false)
56 {
57     if (isMainThread())
58         setSharedTimer(mainThreadSharedTimer());
59 }
60
61 // A worker thread may initialize SharedTimer after some timers are created.
62 // Also, SharedTimer can be replaced with 0 before all timers are destroyed.
63 void ThreadTimers::setSharedTimer(SharedTimer* sharedTimer)
64 {
65     if (m_sharedTimer) {
66         m_sharedTimer->setFiredFunction(0);
67         m_sharedTimer->stop();
68     }
69     
70     m_sharedTimer = sharedTimer;
71     
72     if (sharedTimer) {
73         m_sharedTimer->setFiredFunction(ThreadTimers::sharedTimerFired);
74         updateSharedTimer();
75     }
76 }
77
78 void ThreadTimers::updateSharedTimer()
79 {
80     if (!m_sharedTimer)
81         return;
82         
83     if (m_firingTimers || m_timerHeap.isEmpty())
84         m_sharedTimer->stop();
85     else
86         m_sharedTimer->setFireInterval(max(m_timerHeap.first()->m_nextFireTime - monotonicallyIncreasingTime(), 0.0));
87 }
88
89 void ThreadTimers::sharedTimerFired()
90 {
91     // Redirect to non-static method.
92     threadGlobalData().threadTimers().sharedTimerFiredInternal();
93 }
94
95 void ThreadTimers::sharedTimerFiredInternal()
96 {
97     // Do a re-entrancy check.
98     if (m_firingTimers)
99         return;
100     m_firingTimers = true;
101
102     double fireTime = monotonicallyIncreasingTime();
103     double timeToQuit = fireTime + maxDurationOfFiringTimers;
104
105     while (!m_timerHeap.isEmpty() && m_timerHeap.first()->m_nextFireTime <= fireTime) {
106         TimerBase* timer = m_timerHeap.first();
107         timer->m_nextFireTime = 0;
108         timer->heapDeleteMin();
109
110         double interval = timer->repeatInterval();
111         timer->setNextFireTime(interval ? fireTime + interval : 0);
112
113         // Once the timer has been fired, it may be deleted, so do nothing else with it after this point.
114         timer->fired();
115
116         // Catch the case where the timer asked timers to fire in a nested event loop, or we are over time limit.
117         if (!m_firingTimers || timeToQuit < monotonicallyIncreasingTime())
118             break;
119     }
120
121     m_firingTimers = false;
122
123     updateSharedTimer();
124 }
125
126 void ThreadTimers::fireTimersInNestedEventLoop()
127 {
128     // Reset the reentrancy guard so the timers can fire again.
129     m_firingTimers = false;
130     updateSharedTimer();
131 }
132
133 } // namespace WebCore
134