Make every port implement MainThreadSharedTimer instead of using global functions
[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 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 "ThreadTimers.h"
29
30 #include "MainThreadSharedTimer.h"
31 #include "SharedTimer.h"
32 #include "ThreadGlobalData.h"
33 #include "Timer.h"
34 #include <wtf/CurrentTime.h>
35 #include <wtf/MainThread.h>
36
37 #if PLATFORM(IOS)
38 #include "WebCoreThread.h"
39 #endif
40
41 namespace WebCore {
42
43 // Fire timers for this length of time, and then quit to let the run loop process user input events.
44 // 100ms is about a perceptable delay in UI, so use a half of that as a threshold.
45 // This is to prevent UI freeze when there are too many timers or machine performance is low.
46 static const double maxDurationOfFiringTimers = 0.050;
47
48 // Timers are created, started and fired on the same thread, and each thread has its own ThreadTimers
49 // copy to keep the heap and a set of currently firing timers.
50
51 ThreadTimers::ThreadTimers()
52     : m_sharedTimer(0)
53     , m_firingTimers(false)
54     , m_pendingSharedTimerFireTime(0)
55 {
56     if (isUIThread())
57         setSharedTimer(&MainThreadSharedTimer::singleton());
58 }
59
60 // A worker thread may initialize SharedTimer after some timers are created.
61 // Also, SharedTimer can be replaced with nullptr before all timers are destroyed.
62 void ThreadTimers::setSharedTimer(SharedTimer* sharedTimer)
63 {
64     if (m_sharedTimer) {
65         m_sharedTimer->setFiredFunction(nullptr);
66         m_sharedTimer->stop();
67         m_pendingSharedTimerFireTime = 0;
68     }
69     
70     m_sharedTimer = sharedTimer;
71     
72     if (sharedTimer) {
73         m_sharedTimer->setFiredFunction([] { threadGlobalData().threadTimers().sharedTimerFiredInternal(); });
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_pendingSharedTimerFireTime = 0;
85         m_sharedTimer->stop();
86     } else {
87         double nextFireTime = m_timerHeap.first()->m_nextFireTime;
88         double currentMonotonicTime = monotonicallyIncreasingTime();
89         if (m_pendingSharedTimerFireTime) {
90             // No need to restart the timer if both the pending fire time and the new fire time are in the past.
91             if (m_pendingSharedTimerFireTime <= currentMonotonicTime && nextFireTime <= currentMonotonicTime)
92                 return;
93         } 
94         m_pendingSharedTimerFireTime = nextFireTime;
95         m_sharedTimer->setFireInterval(std::max(nextFireTime - currentMonotonicTime, 0.0));
96     }
97 }
98
99 void ThreadTimers::sharedTimerFiredInternal()
100 {
101     ASSERT(isMainThread() || (!isWebThread() && !isUIThread()));
102     // Do a re-entrancy check.
103     if (m_firingTimers)
104         return;
105     m_firingTimers = true;
106     m_pendingSharedTimerFireTime = 0;
107
108     double fireTime = monotonicallyIncreasingTime();
109     double timeToQuit = fireTime + maxDurationOfFiringTimers;
110
111     while (!m_timerHeap.isEmpty() && m_timerHeap.first()->m_nextFireTime <= fireTime) {
112         TimerBase* timer = m_timerHeap.first();
113         timer->m_nextFireTime = 0;
114         timer->m_unalignedNextFireTime = 0;
115         timer->heapDeleteMin();
116
117         double interval = timer->repeatInterval();
118         timer->setNextFireTime(interval ? fireTime + interval : 0);
119
120         // Once the timer has been fired, it may be deleted, so do nothing else with it after this point.
121         timer->fired();
122
123         // Catch the case where the timer asked timers to fire in a nested event loop, or we are over time limit.
124         if (!m_firingTimers || timeToQuit < monotonicallyIncreasingTime())
125             break;
126     }
127
128     m_firingTimers = false;
129
130     updateSharedTimer();
131 }
132
133 void ThreadTimers::fireTimersInNestedEventLoop()
134 {
135     // Reset the reentrancy guard so the timers can fire again.
136     m_firingTimers = false;
137
138     if (m_sharedTimer) {
139         m_sharedTimer->invalidate();
140         m_pendingSharedTimerFireTime = 0;
141     }
142
143     updateSharedTimer();
144 }
145
146 } // namespace WebCore
147