Add a "post rendering frame" hook #8020

smfr · 2022-12-22T21:56:37Z

`bf82da4`

Add a "post rendering frame" hook
https://bugs.webkit.org/show_bug.cgi?id=249807
rdar://103648840

Reviewed by Chris Dumez and Ryosuke Niwa.

We need to add a Page-level "post rendering frame" hook so we can do things like hook up
postRequestAnimationFrame() (webkit.org/b/249798), possibly run the WindowEventLoop
(webkit.org/b/249684) and correctly implement Inspectors "frame end" event (webkit.org/b/249796).

For Core Animation-driven drawing clients (TiledCoreAnimationDrawingArea, WebKitLegacy) we want this
post-rendering frame hook to run after CA's runloop observer returns, since this callback may run
arbitrary script at some point and we need to avoid any possible re-entrancy issues. So we use a
second CFRunLoopObserver, ordered as CoreAnimationCommit+2 (after InspectorFrameEnd).

For RemoteLayerTreeDrawingArea, we can just call the entry point after
didCompleteRenderingUpdateDisplay().

* Source/WebCore/inspector/agents/InspectorTimelineAgent.cpp:
(WebCore::InspectorTimelineAgent::internalStart):
* Source/WebCore/page/Page.cpp:
(WebCore::Page::didCompleteRenderingFrame):
* Source/WebCore/page/Page.h:
* Source/WebCore/platform/cf/RunLoopObserver.cpp:
(WebCore::RunLoopObserver::schedule):
* Source/WebCore/platform/cf/RunLoopObserver.h: Modernize terminology: LayerFlush -> RenderingUpdate and add PostRenderingUpdate.
* Source/WebKit/WebProcess/WebPage/DrawingArea.cpp:
(WebKit::DrawingArea::didCompleteRenderingFrame):
* Source/WebKit/WebProcess/WebPage/DrawingArea.h:
* Source/WebKit/WebProcess/WebPage/RemoteLayerTree/RemoteLayerTreeDrawingArea.mm:
(WebKit::RemoteLayerTreeDrawingArea::updateRendering):
* Source/WebKit/WebProcess/WebPage/WebPage.cpp:
(WebKit::WebPage::didCompleteRenderingFrame):
* Source/WebKit/WebProcess/WebPage/WebPage.h:
* Source/WebKit/WebProcess/WebPage/mac/TiledCoreAnimationDrawingArea.h:
* Source/WebKit/WebProcess/WebPage/mac/TiledCoreAnimationDrawingArea.mm:
(WebKit::TiledCoreAnimationDrawingArea::TiledCoreAnimationDrawingArea):
(WebKit::TiledCoreAnimationDrawingArea::~TiledCoreAnimationDrawingArea):
(WebKit::TiledCoreAnimationDrawingArea::setLayerTreeStateIsFrozen):
(WebKit::TiledCoreAnimationDrawingArea::dispatchAfterEnsuringUpdatedScrollPosition):
(WebKit::TiledCoreAnimationDrawingArea::didCompleteRenderingUpdateDisplay):
(WebKit::TiledCoreAnimationDrawingArea::scheduleRenderingUpdateRunLoopObserver):
(WebKit::TiledCoreAnimationDrawingArea::invalidateRenderingUpdateRunLoopObserver):
(WebKit::TiledCoreAnimationDrawingArea::renderingUpdateRunLoopCallback):
(WebKit::TiledCoreAnimationDrawingArea::schedulePostRenderingUpdateRunLoopObserver):
(WebKit::TiledCoreAnimationDrawingArea::invalidatePostRenderingUpdateRunLoopObserver):
(WebKit::TiledCoreAnimationDrawingArea::postRenderingUpdateRunLoopCallback):
(WebKit::TiledCoreAnimationDrawingArea::updateRenderingRunLoopCallback): Deleted.
* Source/WebKitLegacy/mac/WebView/WebView.mm:
(-[WebView _didCompleteRenderingUpdateDisplay]):
* Source/WebKitLegacy/mac/WebView/WebViewData.mm:
(WebViewLayerFlushScheduler::WebViewLayerFlushScheduler):

Canonical link: https://commits.webkit.org/258311@main

118d365

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🛠 gtk	✅ 🛠 wincairo
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	✅ 🧪 mac-wk1	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk2
	✅ 🛠 tv-sim	✅ 🧪 mac-AS-debug-wk2
	✅ 🛠 watch	✅ 🧪 mac-wk2-stress
✅ 🛠 🧪 merge	✅ 🛠 watch-sim

webkit-early-warning-system · 2022-12-22T21:58:53Z

EWS run on previous version of this PR (hash e5a810d)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	⏳ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🛠 gtk	⏳ 🛠 wincairo
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	~~🧪 api-mac~~	~~🧪 gtk-wk2~~
	~~🧪 api-ios~~	~~🧪 mac-wk1~~	~~🧪 api-gtk~~
	⏳ 🛠 tv	~~🧪 mac-wk2~~
	✅ 🛠 tv-sim	~~🧪 mac-AS-debug-wk2~~
	⏳ 🛠 watch	✅ 🧪 mac-wk2-stress
	✅ 🛠 watch-sim

webkit-early-warning-system · 2022-12-22T22:33:19Z

EWS run on previous version of this PR (hash 7203718)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🛠 gtk	✅ 🛠 wincairo
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	✅ 🧪 mac-wk1	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk2
	✅ 🛠 tv-sim	✅ 🧪 mac-AS-debug-wk2
	✅ 🛠 watch	✅ 🧪 mac-wk2-stress
	✅ 🛠 watch-sim

rniwa · 2022-12-23T00:44:21Z

Source/WebKit/WebProcess/WebPage/RemoteLayerTree/RemoteLayerTreeDrawingArea.mm

Can we add an assertion that this is back to the main/web thread?

rniwa · 2022-12-23T00:59:00Z

Source/WebCore/page/Page.cpp

It would be ideal to all these updating per WindowEventLoop object. e.g. cross-site contents in a single Page may not share EventLoop object (this is especially true once site isolation is implemented).

Agreed, but I'd rather do that later. It should be pretty clean; the Page updateRendering code is in a good state.

cdumez

LGTM

cdumez · 2022-12-23T00:58:45Z

Source/WebKitLegacy/mac/WebView/WebViewData.mm

nit: We don't need to specify the whole type nowadays:

RefPtr protectedFlushController { m_flushController };

webkit-early-warning-system · 2022-12-23T18:31:24Z

EWS run on current version of this PR (hash 118d365)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🛠 gtk	✅ 🛠 wincairo
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	✅ 🧪 mac-wk1	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk2
	✅ 🛠 tv-sim	✅ 🧪 mac-AS-debug-wk2
	✅ 🛠 watch	✅ 🧪 mac-wk2-stress
✅ 🛠 🧪 merge	✅ 🛠 watch-sim

https://bugs.webkit.org/show_bug.cgi?id=249807 rdar://103648840 Reviewed by Chris Dumez and Ryosuke Niwa. We need to add a Page-level "post rendering frame" hook so we can do things like hook up postRequestAnimationFrame() (webkit.org/b/249798), possibly run the WindowEventLoop (webkit.org/b/249684) and correctly implement Inspectors "frame end" event (webkit.org/b/249796). For Core Animation-driven drawing clients (TiledCoreAnimationDrawingArea, WebKitLegacy) we want this post-rendering frame hook to run after CA's runloop observer returns, since this callback may run arbitrary script at some point and we need to avoid any possible re-entrancy issues. So we use a second CFRunLoopObserver, ordered as CoreAnimationCommit+2 (after InspectorFrameEnd). For RemoteLayerTreeDrawingArea, we can just call the entry point after didCompleteRenderingUpdateDisplay(). * Source/WebCore/inspector/agents/InspectorTimelineAgent.cpp: (WebCore::InspectorTimelineAgent::internalStart): * Source/WebCore/page/Page.cpp: (WebCore::Page::didCompleteRenderingFrame): * Source/WebCore/page/Page.h: * Source/WebCore/platform/cf/RunLoopObserver.cpp: (WebCore::RunLoopObserver::schedule): * Source/WebCore/platform/cf/RunLoopObserver.h: Modernize terminology: LayerFlush -> RenderingUpdate and add PostRenderingUpdate. * Source/WebKit/WebProcess/WebPage/DrawingArea.cpp: (WebKit::DrawingArea::didCompleteRenderingFrame): * Source/WebKit/WebProcess/WebPage/DrawingArea.h: * Source/WebKit/WebProcess/WebPage/RemoteLayerTree/RemoteLayerTreeDrawingArea.mm: (WebKit::RemoteLayerTreeDrawingArea::updateRendering): * Source/WebKit/WebProcess/WebPage/WebPage.cpp: (WebKit::WebPage::didCompleteRenderingFrame): * Source/WebKit/WebProcess/WebPage/WebPage.h: * Source/WebKit/WebProcess/WebPage/mac/TiledCoreAnimationDrawingArea.h: * Source/WebKit/WebProcess/WebPage/mac/TiledCoreAnimationDrawingArea.mm: (WebKit::TiledCoreAnimationDrawingArea::TiledCoreAnimationDrawingArea): (WebKit::TiledCoreAnimationDrawingArea::~TiledCoreAnimationDrawingArea): (WebKit::TiledCoreAnimationDrawingArea::setLayerTreeStateIsFrozen): (WebKit::TiledCoreAnimationDrawingArea::dispatchAfterEnsuringUpdatedScrollPosition): (WebKit::TiledCoreAnimationDrawingArea::didCompleteRenderingUpdateDisplay): (WebKit::TiledCoreAnimationDrawingArea::scheduleRenderingUpdateRunLoopObserver): (WebKit::TiledCoreAnimationDrawingArea::invalidateRenderingUpdateRunLoopObserver): (WebKit::TiledCoreAnimationDrawingArea::renderingUpdateRunLoopCallback): (WebKit::TiledCoreAnimationDrawingArea::schedulePostRenderingUpdateRunLoopObserver): (WebKit::TiledCoreAnimationDrawingArea::invalidatePostRenderingUpdateRunLoopObserver): (WebKit::TiledCoreAnimationDrawingArea::postRenderingUpdateRunLoopCallback): (WebKit::TiledCoreAnimationDrawingArea::updateRenderingRunLoopCallback): Deleted. * Source/WebKitLegacy/mac/WebView/WebView.mm: (-[WebView _didCompleteRenderingUpdateDisplay]): * Source/WebKitLegacy/mac/WebView/WebViewData.mm: (WebViewLayerFlushScheduler::WebViewLayerFlushScheduler): Canonical link: https://commits.webkit.org/258311@main

webkit-commit-queue · 2022-12-23T23:58:18Z

Committed 258311@main (bf82da4): https://commits.webkit.org/258311@main

Reviewed commits have been landed. Closing PR #8020 and removing active labels.

smfr requested review from cdumez and patrickangle as code owners December 22, 2022 21:56

smfr self-assigned this Dec 22, 2022

smfr added the DOM For bugs specific to XML/HTML DOM elements (including parsing). label Dec 22, 2022

smfr force-pushed the eng/Add-a-post-rendering-frame-hook branch from e5a810d to 7203718 Compare December 22, 2022 22:33

smfr requested a review from rniwa December 23, 2022 00:34

rniwa reviewed Dec 23, 2022

View reviewed changes

cdumez approved these changes Dec 23, 2022

View reviewed changes

rniwa approved these changes Dec 23, 2022

View reviewed changes

smfr force-pushed the eng/Add-a-post-rendering-frame-hook branch from 7203718 to 118d365 Compare December 23, 2022 18:27

smfr added the merge-queue Applied to send a pull request to merge-queue label Dec 23, 2022

webkit-commit-queue force-pushed the eng/Add-a-post-rendering-frame-hook branch from 118d365 to bf82da4 Compare December 23, 2022 23:58

webkit-commit-queue merged commit bf82da4 into WebKit:main Dec 23, 2022

webkit-commit-queue removed the merge-queue Applied to send a pull request to merge-queue label Dec 23, 2022

smfr deleted the eng/Add-a-post-rendering-frame-hook branch January 9, 2023 17:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add a "post rendering frame" hook #8020

Add a "post rendering frame" hook #8020

Uh oh!

smfr commented Dec 22, 2022 •

edited by webkit-early-warning-system

Loading

Uh oh!

webkit-early-warning-system commented Dec 22, 2022 •

edited

Loading

Uh oh!

webkit-early-warning-system commented Dec 22, 2022 •

edited

Loading

Uh oh!

rniwa Dec 23, 2022

Uh oh!

rniwa Dec 23, 2022

Uh oh!

smfr Dec 23, 2022

Uh oh!

cdumez left a comment

Uh oh!

cdumez Dec 23, 2022

Uh oh!

webkit-early-warning-system commented Dec 23, 2022 •

edited

Loading

Uh oh!

webkit-commit-queue commented Dec 23, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Add a "post rendering frame" hook #8020

Add a "post rendering frame" hook #8020

Uh oh!

Conversation

smfr commented Dec 22, 2022 • edited by webkit-early-warning-system Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

bf82da4

Uh oh!

webkit-early-warning-system commented Dec 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Dec 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rniwa Dec 23, 2022

Choose a reason for hiding this comment

Uh oh!

rniwa Dec 23, 2022

Choose a reason for hiding this comment

Uh oh!

smfr Dec 23, 2022

Choose a reason for hiding this comment

Uh oh!

cdumez left a comment

Choose a reason for hiding this comment

Uh oh!

cdumez Dec 23, 2022

Choose a reason for hiding this comment

Uh oh!

webkit-early-warning-system commented Dec 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-commit-queue commented Dec 23, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

smfr commented Dec 22, 2022 •

edited by webkit-early-warning-system

Loading

`bf82da4`

webkit-early-warning-system commented Dec 22, 2022 •

edited

Loading

webkit-early-warning-system commented Dec 22, 2022 •

edited

Loading

webkit-early-warning-system commented Dec 23, 2022 •

edited

Loading