[iOS] Add assert to catch improper use of WebCore::Timer in UI Process
[WebKit-https.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 "Logging.h"
31 #include "RuntimeApplicationChecks.h"
32 #include "SharedTimer.h"
33 #include "ThreadGlobalData.h"
34 #include "ThreadTimers.h"
35 #include <limits.h>
36 #include <limits>
37 #include <math.h>
38 #include <wtf/Compiler.h>
39 #include <wtf/MainThread.h>
40 #include <wtf/Vector.h>
41
42 #if USE(WEB_THREAD)
43 #include "WebCoreThread.h"
44 #endif
45
46 namespace WebCore {
47
48 class TimerHeapReference;
49
50 // Timers are stored in a heap data structure, used to implement a priority queue.
51 // This allows us to efficiently determine which timer needs to fire the soonest.
52 // Then we set a single shared system timer to fire at that time.
53 //
54 // When a timer's "next fire time" changes, we need to move it around in the priority queue.
55 static Vector<TimerBase*>& threadGlobalTimerHeap()
56 {
57     return threadGlobalData().threadTimers().timerHeap();
58 }
59 // ----------------
60
61 class TimerHeapPointer {
62 public:
63     TimerHeapPointer(TimerBase** pointer) : m_pointer(pointer) { }
64     TimerHeapReference operator*() const;
65     TimerBase* operator->() const { return *m_pointer; }
66 private:
67     TimerBase** m_pointer;
68 };
69
70 class TimerHeapReference {
71 public:
72     TimerHeapReference(TimerBase*& reference) : m_reference(reference) { }
73     operator TimerBase*() const { return m_reference; }
74     TimerHeapPointer operator&() const { return &m_reference; }
75     TimerHeapReference& operator=(TimerBase*);
76     TimerHeapReference& operator=(TimerHeapReference);
77 private:
78     TimerBase*& m_reference;
79 };
80
81 inline TimerHeapReference TimerHeapPointer::operator*() const
82 {
83     return *m_pointer;
84 }
85
86 inline TimerHeapReference& TimerHeapReference::operator=(TimerBase* timer)
87 {
88     m_reference = timer;
89     Vector<TimerBase*>& heap = timer->timerHeap();
90     if (&m_reference >= heap.data() && &m_reference < heap.data() + heap.size())
91         timer->m_heapIndex = &m_reference - heap.data();
92     return *this;
93 }
94
95 inline TimerHeapReference& TimerHeapReference::operator=(TimerHeapReference b)
96 {
97     TimerBase* timer = b;
98     return *this = timer;
99 }
100
101 inline void swap(TimerHeapReference a, TimerHeapReference b)
102 {
103     TimerBase* timerA = a;
104     TimerBase* timerB = b;
105
106     // Invoke the assignment operator, since that takes care of updating m_heapIndex.
107     a = timerB;
108     b = timerA;
109 }
110
111 // ----------------
112
113 // Class to represent iterators in the heap when calling the standard library heap algorithms.
114 // Uses a custom pointer and reference type that update indices for pointers in the heap.
115 class TimerHeapIterator : public std::iterator<std::random_access_iterator_tag, TimerBase*, ptrdiff_t, TimerHeapPointer, TimerHeapReference> {
116 public:
117     explicit TimerHeapIterator(TimerBase** pointer) : m_pointer(pointer) { checkConsistency(); }
118
119     TimerHeapIterator& operator++() { checkConsistency(); ++m_pointer; checkConsistency(); return *this; }
120     TimerHeapIterator operator++(int) { checkConsistency(1); return TimerHeapIterator(m_pointer++); }
121
122     TimerHeapIterator& operator--() { checkConsistency(); --m_pointer; checkConsistency(); return *this; }
123     TimerHeapIterator operator--(int) { checkConsistency(-1); return TimerHeapIterator(m_pointer--); }
124
125     TimerHeapIterator& operator+=(ptrdiff_t i) { checkConsistency(); m_pointer += i; checkConsistency(); return *this; }
126     TimerHeapIterator& operator-=(ptrdiff_t i) { checkConsistency(); m_pointer -= i; checkConsistency(); return *this; }
127
128     TimerHeapReference operator*() const { return TimerHeapReference(*m_pointer); }
129     TimerHeapReference operator[](ptrdiff_t i) const { return TimerHeapReference(m_pointer[i]); }
130     TimerBase* operator->() const { return *m_pointer; }
131
132 private:
133     void checkConsistency(ptrdiff_t offset = 0) const
134     {
135         ASSERT(m_pointer >= threadGlobalTimerHeap().data());
136         ASSERT(m_pointer <= threadGlobalTimerHeap().data() + threadGlobalTimerHeap().size());
137         ASSERT_UNUSED(offset, m_pointer + offset >= threadGlobalTimerHeap().data());
138         ASSERT_UNUSED(offset, m_pointer + offset <= threadGlobalTimerHeap().data() + threadGlobalTimerHeap().size());
139     }
140
141     friend bool operator==(TimerHeapIterator, TimerHeapIterator);
142     friend bool operator!=(TimerHeapIterator, TimerHeapIterator);
143     friend bool operator<(TimerHeapIterator, TimerHeapIterator);
144     friend bool operator>(TimerHeapIterator, TimerHeapIterator);
145     friend bool operator<=(TimerHeapIterator, TimerHeapIterator);
146     friend bool operator>=(TimerHeapIterator, TimerHeapIterator);
147     
148     friend TimerHeapIterator operator+(TimerHeapIterator, size_t);
149     friend TimerHeapIterator operator+(size_t, TimerHeapIterator);
150     
151     friend TimerHeapIterator operator-(TimerHeapIterator, size_t);
152     friend ptrdiff_t operator-(TimerHeapIterator, TimerHeapIterator);
153
154     TimerBase** m_pointer;
155 };
156
157 inline bool operator==(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer == b.m_pointer; }
158 inline bool operator!=(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer != b.m_pointer; }
159 inline bool operator<(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer < b.m_pointer; }
160 inline bool operator>(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer > b.m_pointer; }
161 inline bool operator<=(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer <= b.m_pointer; }
162 inline bool operator>=(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer >= b.m_pointer; }
163
164 inline TimerHeapIterator operator+(TimerHeapIterator a, size_t b) { return TimerHeapIterator(a.m_pointer + b); }
165 inline TimerHeapIterator operator+(size_t a, TimerHeapIterator b) { return TimerHeapIterator(a + b.m_pointer); }
166
167 inline TimerHeapIterator operator-(TimerHeapIterator a, size_t b) { return TimerHeapIterator(a.m_pointer - b); }
168 inline ptrdiff_t operator-(TimerHeapIterator a, TimerHeapIterator b) { return a.m_pointer - b.m_pointer; }
169
170 // ----------------
171
172 class TimerHeapLessThanFunction {
173 public:
174     bool operator()(const TimerBase*, const TimerBase*) const;
175 };
176
177 inline bool TimerHeapLessThanFunction::operator()(const TimerBase* a, const TimerBase* b) const
178 {
179     // The comparisons below are "backwards" because the heap puts the largest 
180     // element first and we want the lowest time to be the first one in the heap.
181     MonotonicTime aFireTime = a->m_nextFireTime;
182     MonotonicTime bFireTime = b->m_nextFireTime;
183     if (bFireTime != aFireTime)
184         return bFireTime < aFireTime;
185     
186     // We need to look at the difference of the insertion orders instead of comparing the two 
187     // outright in case of overflow. 
188     unsigned difference = a->m_heapInsertionOrder - b->m_heapInsertionOrder;
189     return difference < std::numeric_limits<unsigned>::max() / 2;
190 }
191
192 // ----------------
193
194 TimerBase::TimerBase()
195 {
196 #if PLATFORM(IOS)
197     if (UNLIKELY(!isAllowed())) {
198 #define WEBCORE_TIMERBASE_ASSERTION_MESSAGE "WebCore::Timer should not be used in UI Process."
199         ASSERT_WITH_MESSAGE(false, WEBCORE_TIMERBASE_ASSERTION_MESSAGE);
200         RELEASE_LOG_FAULT(Threading, WEBCORE_TIMERBASE_ASSERTION_MESSAGE);
201 #undef WEBCORE_TIMERBASE_ASSERTION_MESSAGE
202     }
203 #endif
204 }
205
206 TimerBase::~TimerBase()
207 {
208     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(canAccessThreadLocalDataForThread(m_thread.get()));
209     stop();
210     ASSERT(!inHeap());
211     m_wasDeleted = true;
212 }
213
214 void TimerBase::start(Seconds nextFireInterval, Seconds repeatInterval)
215 {
216     ASSERT(canAccessThreadLocalDataForThread(m_thread.get()));
217
218     m_repeatInterval = repeatInterval;
219     setNextFireTime(MonotonicTime::now() + nextFireInterval);
220 }
221
222 void TimerBase::stop()
223 {
224     ASSERT(canAccessThreadLocalDataForThread(m_thread.get()));
225
226     m_repeatInterval = 0_s;
227     setNextFireTime(MonotonicTime { });
228
229     ASSERT(!static_cast<bool>(m_nextFireTime));
230     ASSERT(m_repeatInterval == 0_s);
231     ASSERT(!inHeap());
232 }
233
234 Seconds TimerBase::nextFireInterval() const
235 {
236     ASSERT(isActive());
237     MonotonicTime current = MonotonicTime::now();
238     if (m_nextFireTime < current)
239         return 0_s;
240     return m_nextFireTime - current;
241 }
242
243 inline void TimerBase::checkHeapIndex() const
244 {
245     ASSERT(timerHeap() == threadGlobalTimerHeap());
246     ASSERT(!timerHeap().isEmpty());
247     ASSERT(m_heapIndex >= 0);
248     ASSERT(m_heapIndex < static_cast<int>(timerHeap().size()));
249     ASSERT(timerHeap()[m_heapIndex] == this);
250 }
251
252 inline void TimerBase::checkConsistency() const
253 {
254     // Timers should be in the heap if and only if they have a non-zero next fire time.
255     ASSERT(inHeap() == static_cast<bool>(m_nextFireTime));
256     if (inHeap())
257         checkHeapIndex();
258 }
259
260 bool TimerBase::isAllowed()
261 {
262 #if PLATFORM(IOS)
263     if (isInWebProcess() || isInNetworkProcess() || isInStorageProcess())
264         return true;
265
266 #if USE(WEB_THREAD)
267     if (WebThreadIsEnabled() && (WebThreadIsCurrent() || WebThreadIsLocked()))
268         return true;
269 #endif
270
271     return false;
272 #else
273     return true;
274 #endif
275 }
276
277 void TimerBase::heapDecreaseKey()
278 {
279     ASSERT(static_cast<bool>(m_nextFireTime));
280     checkHeapIndex();
281     TimerBase** heapData = timerHeap().data();
282     push_heap(TimerHeapIterator(heapData), TimerHeapIterator(heapData + m_heapIndex + 1), TimerHeapLessThanFunction());
283     checkHeapIndex();
284 }
285
286 inline void TimerBase::heapDelete()
287 {
288     ASSERT(!static_cast<bool>(m_nextFireTime));
289     heapPop();
290     timerHeap().removeLast();
291     m_heapIndex = -1;
292 }
293
294 void TimerBase::heapDeleteMin()
295 {
296     ASSERT(!static_cast<bool>(m_nextFireTime));
297     heapPopMin();
298     timerHeap().removeLast();
299     m_heapIndex = -1;
300 }
301
302 inline void TimerBase::heapIncreaseKey()
303 {
304     ASSERT(static_cast<bool>(m_nextFireTime));
305     heapPop();
306     heapDecreaseKey();
307 }
308
309 inline void TimerBase::heapInsert()
310 {
311     ASSERT(!inHeap());
312     timerHeap().append(this);
313     m_heapIndex = timerHeap().size() - 1;
314     heapDecreaseKey();
315 }
316
317 inline void TimerBase::heapPop()
318 {
319     // Temporarily force this timer to have the minimum key so we can pop it.
320     MonotonicTime fireTime = m_nextFireTime;
321     m_nextFireTime = -MonotonicTime::infinity();
322     heapDecreaseKey();
323     heapPopMin();
324     m_nextFireTime = fireTime;
325 }
326
327 void TimerBase::heapPopMin()
328 {
329     ASSERT(this == timerHeap().first());
330     checkHeapIndex();
331     Vector<TimerBase*>& heap = timerHeap();
332     TimerBase** heapData = heap.data();
333     pop_heap(TimerHeapIterator(heapData), TimerHeapIterator(heapData + heap.size()), TimerHeapLessThanFunction());
334     checkHeapIndex();
335     ASSERT(this == timerHeap().last());
336 }
337
338 static inline bool parentHeapPropertyHolds(const TimerBase* current, const Vector<TimerBase*>& heap, unsigned currentIndex)
339 {
340     if (!currentIndex)
341         return true;
342     unsigned parentIndex = (currentIndex - 1) / 2;
343     TimerHeapLessThanFunction compareHeapPosition;
344     return compareHeapPosition(current, heap[parentIndex]);
345 }
346
347 static inline bool childHeapPropertyHolds(const TimerBase* current, const Vector<TimerBase*>& heap, unsigned childIndex)
348 {
349     if (childIndex >= heap.size())
350         return true;
351     TimerHeapLessThanFunction compareHeapPosition;
352     return compareHeapPosition(heap[childIndex], current);
353 }
354
355 bool TimerBase::hasValidHeapPosition() const
356 {
357     ASSERT(m_nextFireTime);
358     if (!inHeap())
359         return false;
360     // Check if the heap property still holds with the new fire time. If it does we don't need to do anything.
361     // This assumes that the STL heap is a standard binary heap. In an unlikely event it is not, the assertions
362     // in updateHeapIfNeeded() will get hit.
363     const Vector<TimerBase*>& heap = timerHeap();
364     if (!parentHeapPropertyHolds(this, heap, m_heapIndex))
365         return false;
366     unsigned childIndex1 = 2 * m_heapIndex + 1;
367     unsigned childIndex2 = childIndex1 + 1;
368     return childHeapPropertyHolds(this, heap, childIndex1) && childHeapPropertyHolds(this, heap, childIndex2);
369 }
370
371 void TimerBase::updateHeapIfNeeded(MonotonicTime oldTime)
372 {
373     if (m_nextFireTime && hasValidHeapPosition())
374         return;
375 #ifndef NDEBUG
376     int oldHeapIndex = m_heapIndex;
377 #endif
378     if (!oldTime)
379         heapInsert();
380     else if (!m_nextFireTime)
381         heapDelete();
382     else if (m_nextFireTime < oldTime)
383         heapDecreaseKey();
384     else
385         heapIncreaseKey();
386     ASSERT(m_heapIndex != oldHeapIndex);
387     ASSERT(!inHeap() || hasValidHeapPosition());
388 }
389
390 void TimerBase::setNextFireTime(MonotonicTime newTime)
391 {
392     ASSERT(canAccessThreadLocalDataForThread(m_thread.get()));
393     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(!m_wasDeleted);
394
395     if (m_unalignedNextFireTime != newTime)
396         m_unalignedNextFireTime = newTime;
397
398     // Accessing thread global data is slow. Cache the heap pointer.
399     if (!m_cachedThreadGlobalTimerHeap)
400         m_cachedThreadGlobalTimerHeap = &threadGlobalTimerHeap();
401
402     // Keep heap valid while changing the next-fire time.
403     MonotonicTime oldTime = m_nextFireTime;
404     // Don't realign zero-delay timers.
405     if (newTime) {
406         if (auto newAlignedTime = alignedFireTime(newTime))
407             newTime = newAlignedTime.value();
408     }
409
410     if (oldTime != newTime) {
411         m_nextFireTime = newTime;
412         // FIXME: This should be part of ThreadTimers, or another per-thread structure.
413         static std::atomic<unsigned> currentHeapInsertionOrder;
414         m_heapInsertionOrder = currentHeapInsertionOrder++;
415
416         bool wasFirstTimerInHeap = m_heapIndex == 0;
417
418         updateHeapIfNeeded(oldTime);
419
420         bool isFirstTimerInHeap = m_heapIndex == 0;
421
422         if (wasFirstTimerInHeap || isFirstTimerInHeap)
423             threadGlobalData().threadTimers().updateSharedTimer();
424     }
425
426     checkConsistency();
427 }
428
429 void TimerBase::fireTimersInNestedEventLoop()
430 {
431     // Redirect to ThreadTimers.
432     threadGlobalData().threadTimers().fireTimersInNestedEventLoop();
433 }
434
435 void TimerBase::didChangeAlignmentInterval()
436 {
437     setNextFireTime(m_unalignedNextFireTime);
438 }
439
440 Seconds TimerBase::nextUnalignedFireInterval() const
441 {
442     ASSERT(isActive());
443     return std::max(m_unalignedNextFireTime - MonotonicTime::now(), 0_s);
444 }
445
446 } // namespace WebCore
447