/* * Copyright (C) 2013-2018 Apple Inc. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import "config.h" #import "RemoteLayerBackingStore.h" #import "ArgumentCoders.h" #import "MachPort.h" #import "PlatformCALayerRemote.h" #import "PlatformRemoteImageBufferProxy.h" #import "RemoteLayerBackingStoreCollection.h" #import "RemoteLayerTreeContext.h" #import "ShareableBitmap.h" #import "WebCoreArgumentCoders.h" #import "WebProcess.h" #import #import #import #import #import #import #import #import namespace WebKit { RemoteLayerBackingStore::RemoteLayerBackingStore(PlatformCALayerRemote* layer) : m_layer(layer) , m_isOpaque(false) , m_lastDisplayTime(-MonotonicTime::infinity()) { if (!m_layer) return; if (RemoteLayerTreeContext* context = m_layer->context()) context->backingStoreWasCreated(*this); } RemoteLayerBackingStore::~RemoteLayerBackingStore() { clearBackingStore(); if (!m_layer) return; if (RemoteLayerTreeContext* context = m_layer->context()) context->backingStoreWillBeDestroyed(*this); } void RemoteLayerBackingStore::ensureBackingStore(WebCore::FloatSize size, float scale, bool acceleratesDrawing, bool deepColor, bool isOpaque) { if (m_size == size && m_scale == scale && m_deepColor == deepColor && m_acceleratesDrawing == acceleratesDrawing && m_isOpaque == isOpaque) return; m_size = size; m_scale = scale; m_acceleratesDrawing = acceleratesDrawing; m_deepColor = deepColor; m_isOpaque = isOpaque; if (m_frontBuffer) { // If we have a valid backing store, we need to ensure that it gets completely // repainted the next time display() is called. setNeedsDisplay(); } clearBackingStore(); } void RemoteLayerBackingStore::clearBackingStore() { m_frontBuffer.discard(); m_backBuffer.discard(); m_secondaryBackBuffer.discard(); } void RemoteLayerBackingStore::encode(IPC::Encoder& encoder) const { encoder << m_size; encoder << m_scale; encoder << m_acceleratesDrawing; encoder << m_isOpaque; Optional handle; if (m_frontBuffer.imageBuffer) { if (m_frontBuffer.imageBuffer->renderingMode() == WebCore::RenderingMode::Unaccelerated) handle = static_cast(*m_frontBuffer.imageBuffer->ensureBackendCreated()).createImageBufferBackendHandle(); else if (m_frontBuffer.imageBuffer->canMapBackingStore()) handle = static_cast(*m_frontBuffer.imageBuffer->ensureBackendCreated()).createImageBufferBackendHandle(); else handle = static_cast(*m_frontBuffer.imageBuffer->ensureBackendCreated()).createImageBufferBackendHandle(); } encoder << handle; } bool RemoteLayerBackingStore::decode(IPC::Decoder& decoder, RemoteLayerBackingStore& result) { if (!decoder.decode(result.m_size)) return false; if (!decoder.decode(result.m_scale)) return false; if (!decoder.decode(result.m_acceleratesDrawing)) return false; if (!decoder.decode(result.m_isOpaque)) return false; if (!decoder.decode(result.m_bufferHandle)) return false; return true; } void RemoteLayerBackingStore::setNeedsDisplay(const WebCore::IntRect rect) { m_dirtyRegion.unite(rect); } void RemoteLayerBackingStore::setNeedsDisplay() { setNeedsDisplay(WebCore::IntRect(WebCore::IntPoint(), WebCore::expandedIntSize(m_size))); } WebCore::IntSize RemoteLayerBackingStore::backingStoreSize() const { WebCore::FloatSize scaledSize = m_size; scaledSize.scale(m_scale); return roundedIntSize(scaledSize); } WebCore::PixelFormat RemoteLayerBackingStore::pixelFormat() const { #if HAVE(IOSURFACE_RGB10) if (m_acceleratesDrawing && m_deepColor) return m_isOpaque ? WebCore::PixelFormat::RGB10 : WebCore::PixelFormat::RGB10A8; #endif return WebCore::PixelFormat::BGRA8; } unsigned RemoteLayerBackingStore::bytesPerPixel() const { switch (pixelFormat()) { case WebCore::PixelFormat::RGBA8: return 4; case WebCore::PixelFormat::BGRA8: return 4; case WebCore::PixelFormat::RGB10: return 4; case WebCore::PixelFormat::RGB10A8: return 5; } return 4; } void RemoteLayerBackingStore::swapToValidFrontBuffer() { // Sometimes, we can get two swaps ahead of the render server. // If we're using shared IOSurfaces, we must wait to modify // a surface until it no longer has outstanding clients. if (m_acceleratesDrawing) { if (!m_backBuffer.imageBuffer || m_backBuffer.imageBuffer->isInUse()) { std::swap(m_backBuffer, m_secondaryBackBuffer); // When pulling the secondary back buffer out of hibernation (to become // the new front buffer), if it is somehow still in use (e.g. we got // three swaps ahead of the render server), just give up and discard it. if (m_backBuffer.imageBuffer && m_backBuffer.imageBuffer->isInUse()) m_backBuffer.discard(); } } std::swap(m_frontBuffer, m_backBuffer); if (m_frontBuffer.imageBuffer) return; auto renderingMode = m_acceleratesDrawing ? WebCore::RenderingMode::Accelerated : WebCore::RenderingMode::Unaccelerated; if (WebProcess::singleton().shouldUseRemoteRenderingFor(WebCore::RenderingPurpose::DOM)) m_frontBuffer.imageBuffer = m_layer->context()->ensureRemoteRenderingBackendProxy().createImageBuffer(backingStoreSize(), renderingMode, 1, WebCore::DestinationColorSpace::SRGB, pixelFormat()); else if (renderingMode == WebCore::RenderingMode::Accelerated) m_frontBuffer.imageBuffer = WebCore::ConcreteImageBuffer::create(backingStoreSize(), 1, WebCore::DestinationColorSpace::SRGB, pixelFormat(), nullptr); else m_frontBuffer.imageBuffer = WebCore::ConcreteImageBuffer::create(backingStoreSize(), 1, WebCore::DestinationColorSpace::SRGB, pixelFormat(), nullptr); } bool RemoteLayerBackingStore::display() { ASSERT(!m_frontBufferFlusher); m_lastDisplayTime = MonotonicTime::now(); bool needToEncodeBackingStore = false; if (RemoteLayerTreeContext* context = m_layer->context()) needToEncodeBackingStore = context->backingStoreWillBeDisplayed(*this); // Make the previous front buffer non-volatile early, so that we can dirty the whole layer if it comes back empty. setBufferVolatility(BufferType::Front, false); WebCore::IntSize expandedScaledSize = backingStoreSize(); if (m_dirtyRegion.isEmpty() || expandedScaledSize.isEmpty()) return needToEncodeBackingStore; WebCore::IntRect layerBounds(WebCore::IntPoint(), WebCore::expandedIntSize(m_size)); if (!hasFrontBuffer()) m_dirtyRegion.unite(layerBounds); if (m_layer->owner()->platformCALayerShowRepaintCounter(m_layer)) { WebCore::IntRect indicatorRect(0, 0, 52, 27); m_dirtyRegion.unite(indicatorRect); } WebCore::IntRect expandedScaledLayerBounds(WebCore::IntPoint(), expandedScaledSize); swapToValidFrontBuffer(); if (!m_frontBuffer.imageBuffer) return true; WebCore::GraphicsContext& context = m_frontBuffer.imageBuffer->context(); WebCore::GraphicsContextStateSaver stateSaver(context); WebCore::FloatSize scaledSize = m_size; scaledSize.scale(m_scale); WebCore::IntRect scaledLayerBounds(WebCore::IntPoint(), WebCore::roundedIntSize(scaledSize)); // If we have less than webLayerMaxRectsToPaint rects to paint and they cover less // than webLayerWastedSpaceThreshold of the total dirty area, we'll repaint each rect separately. // Otherwise, repaint the entire bounding box of the dirty region. WebCore::IntRect dirtyBounds = m_dirtyRegion.bounds(); auto dirtyRects = m_dirtyRegion.rects(); if (dirtyRects.size() > WebCore::PlatformCALayer::webLayerMaxRectsToPaint || m_dirtyRegion.totalArea() > WebCore::PlatformCALayer::webLayerWastedSpaceThreshold * dirtyBounds.width() * dirtyBounds.height()) { dirtyRects.clear(); dirtyRects.append(dirtyBounds); } // FIXME: find a consistent way to scale and snap dirty and CG clip rects. for (const auto& rect : dirtyRects) { WebCore::FloatRect scaledRect(rect); scaledRect.scale(m_scale); scaledRect = WebCore::enclosingIntRect(scaledRect); scaledRect.scale(1 / m_scale); m_paintingRects.append(scaledRect); } if (!m_dirtyRegion.contains(layerBounds)) { ASSERT(m_backBuffer.imageBuffer); context.drawImageBuffer(*m_backBuffer.imageBuffer, { 0, 0 }, { WebCore::CompositeOperator::Copy }); } if (m_paintingRects.size() == 1) { WebCore::FloatRect scaledPaintingRect = m_paintingRects[0]; scaledPaintingRect.scale(m_scale); context.clip(scaledPaintingRect); } else { WebCore::Path clipPath; for (auto rect : m_paintingRects) { rect.scale(m_scale); clipPath.addRect(rect); } context.clipPath(clipPath); } if (!m_isOpaque) context.clearRect(scaledLayerBounds); #ifndef NDEBUG if (m_isOpaque) context.fillRect(scaledLayerBounds, WebCore::SRGBA { 255, 47, 146 }); #endif context.scale(m_scale); // FIXME: Clarify that WebCore::GraphicsLayerPaintSnapshotting is just about image decoding. auto flags = m_layer->context() && m_layer->context()->nextRenderingUpdateRequiresSynchronousImageDecoding() ? WebCore::GraphicsLayerPaintSnapshotting : WebCore::GraphicsLayerPaintNormal; // FIXME: This should be moved to PlatformCALayerRemote for better layering. switch (m_layer->layerType()) { case WebCore::PlatformCALayer::LayerTypeSimpleLayer: case WebCore::PlatformCALayer::LayerTypeTiledBackingTileLayer: m_layer->owner()->platformCALayerPaintContents(m_layer, context, dirtyBounds, flags); break; case WebCore::PlatformCALayer::LayerTypeWebLayer: case WebCore::PlatformCALayer::LayerTypeBackdropLayer: WebCore::PlatformCALayer::drawLayerContents(context, m_layer, m_paintingRects, flags); break; case WebCore::PlatformCALayer::LayerTypeDarkSystemBackdropLayer: case WebCore::PlatformCALayer::LayerTypeLightSystemBackdropLayer: // FIXME: These have a more complicated layer hierarchy. We need to paint into // a child layer in order to see the rendered results. WebCore::PlatformCALayer::drawLayerContents(context, m_layer, m_paintingRects, flags); break; case WebCore::PlatformCALayer::LayerTypeLayer: case WebCore::PlatformCALayer::LayerTypeTransformLayer: case WebCore::PlatformCALayer::LayerTypeTiledBackingLayer: case WebCore::PlatformCALayer::LayerTypePageTiledBackingLayer: case WebCore::PlatformCALayer::LayerTypeRootLayer: case WebCore::PlatformCALayer::LayerTypeAVPlayerLayer: case WebCore::PlatformCALayer::LayerTypeContentsProvidedLayer: case WebCore::PlatformCALayer::LayerTypeShapeLayer: case WebCore::PlatformCALayer::LayerTypeScrollContainerLayer: case WebCore::PlatformCALayer::LayerTypeCustom: ASSERT_NOT_REACHED(); break; }; m_dirtyRegion = WebCore::Region(); m_paintingRects.clear(); m_layer->owner()->platformCALayerLayerDidDisplay(m_layer); m_frontBuffer.imageBuffer->flushDrawingContextAsync(); m_frontBufferFlusher = m_frontBuffer.imageBuffer->createFlusher(); return true; } void RemoteLayerBackingStore::enumerateRectsBeingDrawn(WebCore::GraphicsContext& context, void (^block)(WebCore::FloatRect)) { CGAffineTransform inverseTransform = CGAffineTransformInvert(context.getCTM()); // We don't want to un-apply the flipping or contentsScale, // because they're not applied to repaint rects. inverseTransform = CGAffineTransformScale(inverseTransform, m_scale, -m_scale); inverseTransform = CGAffineTransformTranslate(inverseTransform, 0, -m_size.height()); for (const auto& rect : m_paintingRects) { CGRect rectToDraw = CGRectApplyAffineTransform(rect, inverseTransform); block(rectToDraw); } } void RemoteLayerBackingStore::applyBackingStoreToLayer(CALayer *layer, LayerContentsType contentsType) { ASSERT(m_bufferHandle); layer.contentsOpaque = m_isOpaque; if (acceleratesDrawing()) { switch (contentsType) { case LayerContentsType::IOSurface: { auto surface = WebCore::IOSurface::createFromSendRight(WTFMove(WTF::get(*m_bufferHandle)), WebCore::sRGBColorSpaceRef()); layer.contents = surface ? surface->asLayerContents() : nil; break; } case LayerContentsType::CAMachPort: layer.contents = (__bridge id)adoptCF(CAMachPortCreate(WTF::get(*m_bufferHandle).leakSendRight())).get(); break; } return; } ASSERT(!acceleratesDrawing()); auto bitmap = ShareableBitmap::create(WTF::get(*m_bufferHandle)); layer.contents = (__bridge id)bitmap->makeCGImageCopy().get(); } std::unique_ptr RemoteLayerBackingStore::takePendingFlusher() { return std::exchange(m_frontBufferFlusher, nullptr); } bool RemoteLayerBackingStore::setBufferVolatility(BufferType type, bool isVolatile) { if (!acceleratesDrawing()) return true; // Return value is true if we succeeded in making volatile. auto makeVolatile = [] (Buffer& buffer) -> bool { if (!buffer.imageBuffer || buffer.isVolatile) return true; buffer.imageBuffer->releaseGraphicsContext(); if (!buffer.imageBuffer->isInUse()) { buffer.imageBuffer->setVolatile(true); buffer.isVolatile = true; return true; } return false; }; // Return value is true if we need to repaint. auto makeNonVolatile = [] (Buffer& buffer) -> bool { if (!buffer.imageBuffer || !buffer.isVolatile) return false; auto previousState = buffer.imageBuffer->setVolatile(false); buffer.isVolatile = false; return previousState == WebCore::VolatilityState::Empty; }; switch (type) { case BufferType::Front: if (isVolatile) return makeVolatile(m_frontBuffer); // Becoming non-volatile and the front buffer was purged, so we need to repaint. if (makeNonVolatile(m_frontBuffer)) setNeedsDisplay(); break; case BufferType::Back: if (isVolatile) return makeVolatile(m_backBuffer); makeNonVolatile(m_backBuffer); break; case BufferType::SecondaryBack: if (isVolatile) return makeVolatile(m_secondaryBackBuffer); makeNonVolatile(m_secondaryBackBuffer); break; } return true; } void RemoteLayerBackingStore::Buffer::discard() { isVolatile = false; if (imageBuffer) imageBuffer->releaseBufferToPool(); imageBuffer = nullptr; } } // namespace WebKit