f6655346ba7c4e359d8f2babebd3379f7605608d
[WebKit-https.git] / Source / WebCore / platform / ThreadTimers.cpp
1 /*
2  * Copyright (C) 2006-2016 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 Seconds maxDurationOfFiringTimers { 50_ms };
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 {
53     if (isUIThread())
54         setSharedTimer(&MainThreadSharedTimer::singleton());
55 }
56
57 // A worker thread may initialize SharedTimer after some timers are created.
58 // Also, SharedTimer can be replaced with nullptr before all timers are destroyed.
59 void ThreadTimers::setSharedTimer(SharedTimer* sharedTimer)
60 {
61     if (m_sharedTimer) {
62         m_sharedTimer->setFiredFunction(nullptr);
63         m_sharedTimer->stop();
64         m_pendingSharedTimerFireTime = MonotonicTime { };
65     }
66     
67     m_sharedTimer = sharedTimer;
68     
69     if (sharedTimer) {
70         m_sharedTimer->setFiredFunction([] { threadGlobalData().threadTimers().sharedTimerFiredInternal(); });
71         updateSharedTimer();
72     }
73 }
74
75 void ThreadTimers::updateSharedTimer()
76 {
77     if (!m_sharedTimer)
78         return;
79         
80     if (m_firingTimers || m_timerHeap.isEmpty()) {
81         m_pendingSharedTimerFireTime = MonotonicTime { };
82         m_sharedTimer->stop();
83     } else {
84         MonotonicTime nextFireTime = m_timerHeap.first()->m_nextFireTime;
85         MonotonicTime currentMonotonicTime = MonotonicTime::now();
86         if (m_pendingSharedTimerFireTime) {
87             // No need to restart the timer if both the pending fire time and the new fire time are in the past.
88             if (m_pendingSharedTimerFireTime <= currentMonotonicTime && nextFireTime <= currentMonotonicTime)
89                 return;
90         } 
91         m_pendingSharedTimerFireTime = nextFireTime;
92         m_sharedTimer->setFireInterval(std::max(nextFireTime - currentMonotonicTime, 0_s));
93     }
94 }
95
96 void ThreadTimers::sharedTimerFiredInternal()
97 {
98     ASSERT(isMainThread() || (!isWebThread() && !isUIThread()));
99     // Do a re-entrancy check.
100     if (m_firingTimers)
101         return;
102     m_firingTimers = true;
103     m_pendingSharedTimerFireTime = MonotonicTime { };
104
105     MonotonicTime fireTime = MonotonicTime::now();
106     MonotonicTime timeToQuit = fireTime + maxDurationOfFiringTimers;
107
108     while (!m_timerHeap.isEmpty() && m_timerHeap.first()->m_nextFireTime <= fireTime) {
109         TimerBase* timer = m_timerHeap.first();
110         timer->m_nextFireTime = MonotonicTime { };
111         timer->m_unalignedNextFireTime = MonotonicTime { };
112         timer->heapDeleteMin();
113
114         Seconds interval = timer->repeatInterval();
115         timer->setNextFireTime(interval ? fireTime + interval : MonotonicTime { });
116
117         // Once the timer has been fired, it may be deleted, so do nothing else with it after this point.
118         timer->fired();
119
120         // Catch the case where the timer asked timers to fire in a nested event loop, or we are over time limit.
121         if (!m_firingTimers || timeToQuit < MonotonicTime::now())
122             break;
123     }
124
125     m_firingTimers = false;
126
127     updateSharedTimer();
128 }
129
130 void ThreadTimers::fireTimersInNestedEventLoop()
131 {
132     // Reset the reentrancy guard so the timers can fire again.
133     m_firingTimers = false;
134
135     if (m_sharedTimer) {
136         m_sharedTimer->invalidate();
137         m_pendingSharedTimerFireTime = MonotonicTime { };
138     }
139
140     updateSharedTimer();
141 }
142
143 } // namespace WebCore
144