<rdar://problem/9523192> REGRESSION (5.0.5-ToT, WebKit2): Flash to white when navigat...
[WebKit-https.git] / Source / WebKit2 / WebProcess / WebPage / ca / mac / LayerTreeHostCAMac.mm
1 /*
2  * Copyright (C) 2011 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import "config.h"
27 #import "LayerTreeHostCAMac.h"
28
29 #import "WebProcess.h"
30 #import <QuartzCore/CATransaction.h>
31 #import <WebCore/GraphicsLayer.h>
32 #import <WebKitSystemInterface.h>
33
34 using namespace WebCore;
35
36 @interface CATransaction (Details)
37 + (void)synchronize;
38 @end
39
40 namespace WebKit {
41
42 PassRefPtr<LayerTreeHostCAMac> LayerTreeHostCAMac::create(WebPage* webPage)
43 {
44     RefPtr<LayerTreeHostCAMac> host = adoptRef(new LayerTreeHostCAMac(webPage));
45     host->initialize();
46     return host.release();
47 }
48
49 LayerTreeHostCAMac::LayerTreeHostCAMac(WebPage* webPage)
50     : LayerTreeHostCA(webPage)
51 {
52 }
53
54 LayerTreeHostCAMac::~LayerTreeHostCAMac()
55 {
56     ASSERT(!m_flushPendingLayerChangesRunLoopObserver);
57     ASSERT(!m_remoteLayerClient);
58 }
59
60 void LayerTreeHostCAMac::platformInitialize(LayerTreeContext& layerTreeContext)
61 {
62     mach_port_t serverPort = WebProcess::shared().compositingRenderServerPort();
63     m_remoteLayerClient = WKCARemoteLayerClientMakeWithServerPort(serverPort);
64
65     WKCARemoteLayerClientSetLayer(m_remoteLayerClient.get(), rootLayer()->platformLayer());
66
67     layerTreeContext.contextID = WKCARemoteLayerClientGetClientId(m_remoteLayerClient.get());
68 }
69
70 void LayerTreeHostCAMac::scheduleLayerFlush()
71 {
72     if (!m_layerFlushSchedulingEnabled)
73         return;
74
75     CFRunLoopRef currentRunLoop = CFRunLoopGetCurrent();
76     
77     // Make sure we wake up the loop or the observer could be delayed until some other source fires.
78     CFRunLoopWakeUp(currentRunLoop);
79
80     if (m_flushPendingLayerChangesRunLoopObserver)
81         return;
82
83     // Run before the Core Animation commit observer, which has order 2000000.
84     const CFIndex runLoopOrder = 2000000 - 1;
85     CFRunLoopObserverContext context = { 0, this, 0, 0, 0 };
86     m_flushPendingLayerChangesRunLoopObserver.adoptCF(CFRunLoopObserverCreate(0, kCFRunLoopBeforeWaiting | kCFRunLoopExit, true, runLoopOrder, flushPendingLayerChangesRunLoopObserverCallback, &context));
87
88     CFRunLoopAddObserver(currentRunLoop, m_flushPendingLayerChangesRunLoopObserver.get(), kCFRunLoopCommonModes);
89 }
90
91 void LayerTreeHostCAMac::setLayerFlushSchedulingEnabled(bool layerFlushingEnabled)
92 {
93     if (m_layerFlushSchedulingEnabled == layerFlushingEnabled)
94         return;
95
96     m_layerFlushSchedulingEnabled = layerFlushingEnabled;
97
98     if (m_layerFlushSchedulingEnabled)
99         return;
100
101     if (!m_flushPendingLayerChangesRunLoopObserver)
102         return;
103
104     CFRunLoopObserverInvalidate(m_flushPendingLayerChangesRunLoopObserver.get());
105     m_flushPendingLayerChangesRunLoopObserver = nullptr;
106 }
107
108 void LayerTreeHostCAMac::invalidate()
109 {
110     if (m_flushPendingLayerChangesRunLoopObserver) {
111         CFRunLoopObserverInvalidate(m_flushPendingLayerChangesRunLoopObserver.get());
112         m_flushPendingLayerChangesRunLoopObserver = nullptr;
113     }
114
115     WKCARemoteLayerClientInvalidate(m_remoteLayerClient.get());
116     m_remoteLayerClient = nullptr;
117
118     LayerTreeHostCA::invalidate();
119 }
120
121 void LayerTreeHostCAMac::sizeDidChange(const IntSize& newSize)
122 {
123     LayerTreeHostCA::sizeDidChange(newSize);
124     [CATransaction flush];
125     [CATransaction synchronize];
126 }
127
128 void LayerTreeHostCAMac::forceRepaint()
129 {
130     LayerTreeHostCA::forceRepaint();
131     [CATransaction flush];
132     [CATransaction synchronize];
133 }
134
135 void LayerTreeHostCAMac::pauseRendering()
136 {
137     CALayer* root = rootLayer()->platformLayer();
138     [root setValue:(id)kCFBooleanTrue forKey:@"NSCAViewRenderPaused"];
139     [[NSNotificationCenter defaultCenter] postNotificationName:@"NSCAViewRenderDidPauseNotification" object:nil userInfo:[NSDictionary dictionaryWithObject:root forKey:@"layer"]];
140 }
141
142 void LayerTreeHostCAMac::resumeRendering()
143 {
144     CALayer* root = rootLayer()->platformLayer();
145     [root setValue:(id)kCFBooleanFalse forKey:@"NSCAViewRenderPaused"];
146     [[NSNotificationCenter defaultCenter] postNotificationName:@"NSCAViewRenderDidResumeNotification" object:nil userInfo:[NSDictionary dictionaryWithObject:root forKey:@"layer"]];
147 }
148
149 void LayerTreeHostCAMac::flushPendingLayerChangesRunLoopObserverCallback(CFRunLoopObserverRef, CFRunLoopActivity, void* context)
150 {
151     LayerTreeHostCAMac* layerTreeHost = static_cast<LayerTreeHostCAMac*>(context);
152
153     ASSERT(layerTreeHost->m_layerFlushSchedulingEnabled);
154
155     // This gets called outside of the normal event loop so wrap in an autorelease pool
156     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
157     layerTreeHost->performScheduledLayerFlush();
158     [pool drain];
159 }
160
161 void LayerTreeHostCAMac::didPerformScheduledLayerFlush()
162 {
163     // We successfully flushed the pending layer changes, remove the run loop observer.
164     ASSERT(m_flushPendingLayerChangesRunLoopObserver);
165     CFRunLoopObserverInvalidate(m_flushPendingLayerChangesRunLoopObserver.get());
166     m_flushPendingLayerChangesRunLoopObserver = 0;
167
168     LayerTreeHostCA::didPerformScheduledLayerFlush();
169 }
170
171 } // namespace WebKit