Expose GraphicsClient through ScriptExecutionContext

https://bugs.webkit.org/show_bug.cgi?id=261272 rdar://115108907 Reviewed by Matt Woodrow. Expose GraphicsClient through ScriptExecutionContext All DOM objects that construct graphics objects must do so via a factory that is able to create graphics objects (either local or remote). This factory interface is GraphicsClient. The objects obtain the instance via ScriptExecutionContext, either: - Document (via Chrome) - WorkerGlobalScope (via WorkerClient) Add ScriptExecutionContext::graphicsClient() to avoid doing various error-prone downcasting sequences. Make SerializedImageBuffer::sinkIntoImageBuffer() a similar function to ImageBuffer::create(), where the polymorphism is added with the GraphicsClient* and in-process variant is invoked if the instance is nullptr. * Source/WebCore/dom/Document.cpp: (WebCore::Document::graphicsClient): * Source/WebCore/dom/Document.h: * Source/WebCore/dom/ScriptExecutionContext.h: (WebCore::ScriptExecutionContext::graphicsClient): * Source/WebCore/html/CanvasBase.cpp: (WebCore::CanvasBase::allocateImageBuffer const): (WebCore::CanvasBase::graphicsClient const): Deleted. * Source/WebCore/html/CanvasBase.h: * Source/WebCore/html/ImageBitmap.cpp: (WebCore::ImageBitmap::createImageBuffer): * Source/WebCore/html/ImageBitmapBacking.cpp: (WebCore::ImageBitmapBacking::connect): * Source/WebCore/html/OffscreenCanvas.cpp: (WebCore::DetachedOffscreenCanvas::takeImageBuffer): (WebCore::OffscreenCanvas::pushBufferToPlaceholder): * Source/WebCore/html/canvas/WebGLRenderingContextBase.cpp: (WebCore::WebGLRenderingContextBase::create): (WebCore::WebGLRenderingContextBase::maybeRestoreContext): * Source/WebCore/platform/GraphicsClient.h: * Source/WebCore/platform/graphics/ImageBuffer.cpp: (WebCore::SerializedImageBuffer::sinkIntoImageBuffer): * Source/WebCore/platform/graphics/ImageBuffer.h: * Source/WebCore/workers/WorkerGlobalScope.cpp: (WebCore::WorkerGlobalScope::graphicsClient): * Source/WebCore/workers/WorkerGlobalScope.h: Canonical link: https://commits.webkit.org/267938@main
WebKit · Sep 13, 2023 · a8f5521 · a8f5521
1 parent 44bf0d7
commit a8f5521
Show file tree

Hide file tree

Showing 14 changed files with 40 additions and 52 deletions.
diff --git a/Source/WebCore/dom/Document.cpp b/Source/WebCore/dom/Document.cpp
@@ -9510,6 +9510,14 @@ NotificationClient* Document::notificationClient()
 #endif
 }
 
+GraphicsClient* Document::graphicsClient()
+{
+    auto* page = this->page();
+    if (!page)
+        return nullptr;
+    return &page->chrome();
+}
+
 std::optional<PAL::SessionID> Document::sessionID() const
 {
     if (auto* page = this->page())

diff --git a/Source/WebCore/dom/Document.h b/Source/WebCore/dom/Document.h
@@ -133,6 +133,7 @@ class FormController;
 class FrameSelection;
 class FullscreenManager;
 class GPUCanvasContext;
+class GraphicsClient;
 class HTMLAllCollection;
 class HTMLAttachmentElement;
 class HTMLBodyElement;
@@ -690,6 +691,7 @@ class Document
     void suspendActiveDOMObjects(ReasonForSuspension) final;
     void resumeActiveDOMObjects(ReasonForSuspension) final;
     void stopActiveDOMObjects() final;
+    GraphicsClient* graphicsClient() final;
 
     const Settings::Values& settingsValues() const final { return settings().values(); }
 

diff --git a/Source/WebCore/dom/ScriptExecutionContext.h b/Source/WebCore/dom/ScriptExecutionContext.h
@@ -72,6 +72,7 @@ class EventQueue;
 class EventLoopTaskGroup;
 class EventTarget;
 class FontLoadRequest;
+class GraphicsClient;
 class MessagePort;
 class NotificationClient;
 class PublicURLManager;
@@ -129,6 +130,8 @@ class ScriptExecutionContext : public SecurityContext, public CanMakeCheckedPtr,
 
     virtual SocketProvider* socketProvider() = 0;
 
+    virtual GraphicsClient* graphicsClient() { return nullptr; }
+
     virtual std::optional<uint64_t> noiseInjectionHashSalt() const = 0;
 
     virtual RefPtr<RTCDataChannelRemoteHandlerConnection> createRTCDataChannelRemoteHandlerConnection();

diff --git a/Source/WebCore/html/CanvasBase.cpp b/Source/WebCore/html/CanvasBase.cpp
@@ -300,16 +300,6 @@ RefPtr<ImageBuffer> CanvasBase::setImageBuffer(RefPtr<ImageBuffer>&& buffer) con
     return returnBuffer;
 }
 
-GraphicsClient* CanvasBase::graphicsClient() const
-{
-    if (scriptExecutionContext()->isDocument() && downcast<Document>(scriptExecutionContext())->page())
-        return &downcast<Document>(scriptExecutionContext())->page()->chrome();
-    if (is<WorkerGlobalScope>(scriptExecutionContext()))
-        return downcast<WorkerGlobalScope>(scriptExecutionContext())->workerClient();
-
-    return nullptr;
-}
-
 bool CanvasBase::shouldAccelerate(const IntSize& size) const
 {
     auto checkedArea = size.area<RecordOverflow>();
@@ -358,7 +348,7 @@ RefPtr<ImageBuffer> CanvasBase::allocateImageBuffer() const
         pixelFormat = context->pixelFormat();
     }
 
-    return ImageBuffer::create(size(), RenderingPurpose::Canvas, 1, colorSpace, pixelFormat, bufferOptions, graphicsClient());
+    return ImageBuffer::create(size(), RenderingPurpose::Canvas, 1, colorSpace, pixelFormat, bufferOptions, scriptExecutionContext()->graphicsClient());
 }
 
 bool CanvasBase::shouldInjectNoiseBeforeReadback() const

diff --git a/Source/WebCore/html/CanvasBase.h b/Source/WebCore/html/CanvasBase.h
@@ -42,7 +42,6 @@ class CanvasObserver;
 class CanvasRenderingContext;
 class Element;
 class Event;
-class GraphicsClient;
 class GraphicsContext;
 class GraphicsContextStateSaver;
 class Image;
@@ -114,8 +113,6 @@ class CanvasBase {
     virtual GraphicsContext* drawingContext() const;
     virtual GraphicsContext* existingDrawingContext() const;
 
-    GraphicsClient* graphicsClient() const;
-
     void didDraw(const std::optional<FloatRect>& rect) { return didDraw(rect, ShouldApplyPostProcessingToDirtyRect::Yes); }
     virtual void didDraw(const std::optional<FloatRect>&, ShouldApplyPostProcessingToDirtyRect);
 

diff --git a/Source/WebCore/html/ImageBitmap.cpp b/Source/WebCore/html/ImageBitmap.cpp
@@ -96,17 +96,7 @@ RefPtr<ImageBuffer> ImageBitmap::createImageBuffer(ScriptExecutionContext& scrip
     }
 
     auto bufferOptions = bufferOptionsForRendingMode(renderingMode);
-
-    GraphicsClient* client = nullptr;
-    if (scriptExecutionContext.isDocument()) {
-        auto& document = downcast<Document>(scriptExecutionContext);
-        if (document.view() && document.view()->root()) {
-            client = document.view()->root()->hostWindow();
-        }
-    } else if (scriptExecutionContext.isWorkerGlobalScope())
-        client = downcast<WorkerGlobalScope>(scriptExecutionContext).workerClient();
-
-    return ImageBuffer::create(size, RenderingPurpose::Canvas, resolutionScale, *imageBufferColorSpace, PixelFormat::BGRA8, bufferOptions, client);
+    return ImageBuffer::create(size, RenderingPurpose::Canvas, resolutionScale, *imageBufferColorSpace, PixelFormat::BGRA8, bufferOptions, scriptExecutionContext.graphicsClient());
 }
 
 void ImageBitmap::createCompletionHandler(ScriptExecutionContext& scriptExecutionContext, ImageBitmap::Source&& source, ImageBitmapOptions&& options, ImageBitmapCompletionHandler&& completionHandler)

diff --git a/Source/WebCore/html/ImageBitmapBacking.cpp b/Source/WebCore/html/ImageBitmapBacking.cpp
@@ -88,15 +88,7 @@ void ImageBitmapBacking::connect(ScriptExecutionContext& context)
     ASSERT(!m_bitmapData);
     if (!m_serializedBitmap)
         return;
-
-    if (is<WorkerGlobalScope>(context) && downcast<WorkerGlobalScope>(context).workerClient()) {
-        auto* client = downcast<WorkerGlobalScope>(context).workerClient();
-        m_bitmapData = client->sinkIntoImageBuffer(WTFMove(m_serializedBitmap));
-    } else if (is<Document>(context)) {
-        ASSERT(downcast<Document>(context).page());
-        m_bitmapData = downcast<Document>(context).page()->chrome().sinkIntoImageBuffer(WTFMove(m_serializedBitmap));
-    } else
-        m_bitmapData = SerializedImageBuffer::sinkIntoImageBuffer(WTFMove(m_serializedBitmap));
+    m_bitmapData = SerializedImageBuffer::sinkIntoImageBuffer(WTFMove(m_serializedBitmap), context.graphicsClient());
 }
 
 } // namespace WebCore
diff --git a/Source/WebCore/html/OffscreenCanvas.cpp b/Source/WebCore/html/OffscreenCanvas.cpp
@@ -68,16 +68,7 @@ RefPtr<ImageBuffer> DetachedOffscreenCanvas::takeImageBuffer(ScriptExecutionCont
 {
     if (!m_buffer)
         return nullptr;
-    GraphicsClient* client = nullptr;
-    if (is<WorkerGlobalScope>(context)) {
-        client = downcast<WorkerGlobalScope>(context).workerClient();
-        ASSERT(client);
-    } else if (is<Document>(context)) {
-        ASSERT(downcast<Document>(context).page());
-        client = &downcast<Document>(context).page()->chrome();
-    }
-    ASSERT(client);
-    return client->sinkIntoImageBuffer(WTFMove(m_buffer));
+    return SerializedImageBuffer::sinkIntoImageBuffer(WTFMove(m_buffer), context.graphicsClient());
 }
 
 WeakPtr<HTMLCanvasElement, WeakPtrImplWithEventTargetData> DetachedOffscreenCanvas::takePlaceholderCanvas()
@@ -493,9 +484,8 @@ void OffscreenCanvas::pushBufferToPlaceholder()
     callOnMainThread([placeholderData = Ref { *m_placeholderData }] () mutable {
         Locker locker { placeholderData->bufferLock };
         if (RefPtr canvas = placeholderData->canvas.get()) {
-            if (canvas->document().page() && placeholderData->pendingCommitBuffer) {
-                GraphicsClient& client = canvas->document().page()->chrome();
-                auto imageBuffer = client.sinkIntoImageBuffer(WTFMove(placeholderData->pendingCommitBuffer));
+            if (placeholderData->pendingCommitBuffer) {
+                auto imageBuffer = SerializedImageBuffer::sinkIntoImageBuffer(WTFMove(placeholderData->pendingCommitBuffer), canvas->document().graphicsClient());
                 canvas->setImageBufferAndMarkDirty(WTFMove(imageBuffer));
             }
         }

diff --git a/Source/WebCore/html/canvas/WebGLRenderingContextBase.cpp b/Source/WebCore/html/canvas/WebGLRenderingContextBase.cpp
@@ -573,7 +573,7 @@ std::unique_ptr<WebGLRenderingContextBase> WebGLRenderingContextBase::create(Can
     if (!scriptExecutionContext)
         return nullptr;
 
-    GraphicsClient* graphicsClient = canvas.graphicsClient();
+    GraphicsClient* graphicsClient = scriptExecutionContext->graphicsClient();
 
     auto* canvasElement = dynamicDowncast<HTMLCanvasElement>(canvas);
 
@@ -5636,7 +5636,7 @@ void WebGLRenderingContextBase::maybeRestoreContext()
     if (!scriptExecutionContext->settingsValues().webGLEnabled)
         return;
 
-    GraphicsClient* graphicsClient = canvasBase().graphicsClient();
+    GraphicsClient* graphicsClient = scriptExecutionContext->graphicsClient();
     if (!graphicsClient)
         return;
 

diff --git a/Source/WebCore/platform/GraphicsClient.h b/Source/WebCore/platform/GraphicsClient.h
@@ -48,12 +48,19 @@ class GraphicsClient {
 
     virtual PlatformDisplayID displayID() const = 0;
 
-    virtual RefPtr<ImageBuffer> createImageBuffer(const FloatSize&, RenderingMode, RenderingPurpose, float resolutionScale, const DestinationColorSpace&, PixelFormat, bool avoidBackendSizeCheck = false) const = 0;
 #if ENABLE(WEBGL)
     virtual RefPtr<GraphicsContextGL> createGraphicsContextGL(const GraphicsContextGLAttributes&) const = 0;
 #endif
 
+private:
+    // Called by passing GraphicsClient into ImageBuffer functions.
+    virtual RefPtr<ImageBuffer> createImageBuffer(const FloatSize&, RenderingMode, RenderingPurpose, float resolutionScale, const DestinationColorSpace&, PixelFormat, bool avoidBackendSizeCheck = false) const = 0;
+
+    // Called by passing GraphicsClient into SerializedImageBuffer functions.
     virtual RefPtr<WebCore::ImageBuffer> sinkIntoImageBuffer(std::unique_ptr<WebCore::SerializedImageBuffer>) = 0;
+
+    friend class ImageBuffer;
+    friend class SerializedImageBuffer;
 };
 
 } // namespace WebCore
diff --git a/Source/WebCore/platform/graphics/ImageBuffer.cpp b/Source/WebCore/platform/graphics/ImageBuffer.cpp
@@ -120,8 +120,10 @@ bool ImageBuffer::sizeNeedsClamping(const FloatSize& size)
     return floorf(size.height()) * floorf(size.width()) > MaxClampedArea;
 }
 
-RefPtr<ImageBuffer> SerializedImageBuffer::sinkIntoImageBuffer(std::unique_ptr<SerializedImageBuffer> buffer)
+RefPtr<ImageBuffer> SerializedImageBuffer::sinkIntoImageBuffer(std::unique_ptr<SerializedImageBuffer> buffer, GraphicsClient* graphicsClient)
 {
+    if (graphicsClient)
+        return graphicsClient->sinkIntoImageBuffer(WTFMove(buffer));
     return buffer->sinkIntoImageBuffer();
 }
 

diff --git a/Source/WebCore/platform/graphics/ImageBuffer.h b/Source/WebCore/platform/graphics/ImageBuffer.h
@@ -229,7 +229,7 @@ class SerializedImageBuffer {
 
     virtual size_t memoryCost() = 0;
 
-    WEBCORE_EXPORT static RefPtr<ImageBuffer> sinkIntoImageBuffer(std::unique_ptr<SerializedImageBuffer>);
+    WEBCORE_EXPORT static RefPtr<ImageBuffer> sinkIntoImageBuffer(std::unique_ptr<SerializedImageBuffer>, GraphicsClient* = nullptr);
 
     virtual bool isRemoteSerializedImageBufferProxy() const { return false; }
 

diff --git a/Source/WebCore/workers/WorkerGlobalScope.cpp b/Source/WebCore/workers/WorkerGlobalScope.cpp
@@ -229,6 +229,11 @@ IDBClient::IDBConnectionProxy* WorkerGlobalScope::idbConnectionProxy()
     return m_connectionProxy.get();
 }
 
+GraphicsClient* WorkerGlobalScope::graphicsClient()
+{
+    return workerClient();
+}
+
 void WorkerGlobalScope::stopIndexedDatabase()
 {
     if (m_connectionProxy)

diff --git a/Source/WebCore/workers/WorkerGlobalScope.h b/Source/WebCore/workers/WorkerGlobalScope.h
@@ -94,6 +94,8 @@ class WorkerGlobalScope : public Supplementable<WorkerGlobalScope>, public Base6
     IDBClient::IDBConnectionProxy* idbConnectionProxy() final;
     void suspend() final;
     void resume() final;
+    GraphicsClient* graphicsClient() final;
+
 
     using EventTarget::weakPtrFactory;
     using EventTarget::WeakValueType;