Reproducible null deref under ScriptedAnimationController::createDisplayRefreshMonitor
[WebKit-https.git] / Source / WebCore / platform / graphics / DisplayRefreshMonitor.cpp
1 /*
2  * Copyright (C) 2010, 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "DisplayRefreshMonitor.h"
28
29 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
30
31 #include "DisplayRefreshMonitorClient.h"
32 #include "DisplayRefreshMonitorIOS.h"
33 #include "DisplayRefreshMonitorMac.h"
34 #include "DisplayRefreshMonitorManager.h"
35
36 namespace WebCore {
37
38 RefPtr<DisplayRefreshMonitor> DisplayRefreshMonitor::create(DisplayRefreshMonitorClient* client)
39 {
40     PlatformDisplayID displayID = client->displayID();
41
42     if (Optional<RefPtr<DisplayRefreshMonitor>> monitor = client->createDisplayRefreshMonitor(displayID))
43         return monitor.value();
44
45     // If ChromeClient returned Nullopt, we'll go ahead and make one of the default type.
46
47 #if PLATFORM(MAC)
48     return DisplayRefreshMonitorMac::create(displayID);
49 #endif
50 #if PLATFORM(IOS)
51     return DisplayRefreshMonitorIOS::create(displayID);
52 #endif
53 }
54
55 DisplayRefreshMonitor::DisplayRefreshMonitor(PlatformDisplayID displayID)
56     : m_monotonicAnimationStartTime(0)
57     , m_active(true)
58     , m_scheduled(false)
59     , m_previousFrameDone(true)
60     , m_unscheduledFireCount(0)
61     , m_displayID(displayID)
62     , m_clientsToBeNotified(nullptr)
63 {
64 }
65
66 DisplayRefreshMonitor::~DisplayRefreshMonitor()
67 {
68 }
69
70 void DisplayRefreshMonitor::handleDisplayRefreshedNotificationOnMainThread(void* data)
71 {
72     DisplayRefreshMonitor* monitor = static_cast<DisplayRefreshMonitor*>(data);
73     monitor->displayDidRefresh();
74 }
75
76 void DisplayRefreshMonitor::addClient(DisplayRefreshMonitorClient* client)
77 {
78     m_clients.add(client);
79 }
80
81 bool DisplayRefreshMonitor::removeClient(DisplayRefreshMonitorClient* client)
82 {
83     if (m_clientsToBeNotified)
84         m_clientsToBeNotified->remove(client);
85     return m_clients.remove(client);
86 }
87
88 void DisplayRefreshMonitor::displayDidRefresh()
89 {
90     double monotonicAnimationStartTime;
91
92     {
93         MutexLocker lock(m_mutex);
94         if (!m_scheduled)
95             ++m_unscheduledFireCount;
96         else
97             m_unscheduledFireCount = 0;
98
99         m_scheduled = false;
100         monotonicAnimationStartTime = m_monotonicAnimationStartTime;
101     }
102
103     // The call back can cause all our clients to be unregistered, so we need to protect
104     // against deletion until the end of the method.
105     Ref<DisplayRefreshMonitor> protect(*this);
106
107     // Copy the hash table and remove clients from it one by one so we don't notify
108     // any client twice, but can respond to removal of clients during the delivery process.
109     HashSet<DisplayRefreshMonitorClient*> clientsToBeNotified = m_clients;
110     m_clientsToBeNotified = &clientsToBeNotified;
111     while (!clientsToBeNotified.isEmpty()) {
112         DisplayRefreshMonitorClient* client = clientsToBeNotified.takeAny();
113         client->fireDisplayRefreshIfNeeded(monotonicAnimationStartTime);
114
115         // This checks if this function was reentered. In that case, stop iterating
116         // since it's not safe to use the set any more.
117         if (m_clientsToBeNotified != &clientsToBeNotified)
118             break;
119     }
120
121     if (m_clientsToBeNotified == &clientsToBeNotified)
122         m_clientsToBeNotified = nullptr;
123
124     {
125         MutexLocker lock(m_mutex);
126         m_previousFrameDone = true;
127     }
128     
129     DisplayRefreshMonitorManager::sharedManager().displayDidRefresh(this);
130 }
131
132 }
133
134 #endif // USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)