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