Blink changes to record interest rects for http://w3c.github.io/frame-timing/

Source/web/WebViewImpl.cpp

 /*
  * Copyright (C) 2011, 2012 Google 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:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 69 matching lines @@
 #include "core/page/DragSession.h"
 #include "core/page/EventHandler.h"
 #include "core/page/FocusController.h"
 #include "core/page/FrameTree.h"
 #include "core/page/InjectedStyleSheets.h"
 #include "core/page/Page.h"
 #include "core/page/PagePopupClient.h"
 #include "core/page/PointerLockController.h"
 #include "core/page/ScopedPageLoadDeferrer.h"
 #include "core/page/TouchDisambiguation.h"
+#include "core/timing/DOMWindowPerformance.h"
+#include "core/timing/Performance.h"
 #include "modules/accessibility/AXObject.h"
 #include "modules/accessibility/AXObjectCacheImpl.h"
 #include "modules/credentialmanager/CredentialManagerClient.h"
 #include "modules/encryptedmedia/MediaKeysController.h"
 #include "modules/storage/StorageNamespaceController.h"
 #include "platform/ContextMenu.h"
 #include "platform/ContextMenuItem.h"
 #include "platform/Cursor.h"
 #include "platform/KeyboardCodes.h"
 #include "platform/Logging.h"
@@ skipping 19 matching lines @@
 #include "public/platform/WebFloatPoint.h"
 #include "public/platform/WebGestureCurve.h"
 #include "public/platform/WebImage.h"
 #include "public/platform/WebLayerTreeView.h"
 #include "public/platform/WebURLRequest.h"
 #include "public/platform/WebVector.h"
 #include "public/web/WebAXObject.h"
 #include "public/web/WebActiveWheelFlingParameters.h"
 #include "public/web/WebAutofillClient.h"
 #include "public/web/WebBeginFrameArgs.h"
+#include "public/web/WebFrame.h"
 #include "public/web/WebFrameClient.h"
 #include "public/web/WebHitTestResult.h"
 #include "public/web/WebInputElement.h"
 #include "public/web/WebMediaPlayerAction.h"
 #include "public/web/WebNode.h"
 #include "public/web/WebPlugin.h"
 #include "public/web/WebPluginAction.h"
 #include "public/web/WebRange.h"
 #include "public/web/WebTextInputInfo.h"
 #include "public/web/WebViewClient.h"
@@ skipping 1790 matching lines @@
     // FIXME: This should probably be using the local root?
     if (m_page->mainFrame()->isLocalFrame())
         PageWidgetDelegate::animate(*m_page, validFrameTime.lastFrameTimeMonotonic, *m_page->deprecatedLocalMainFrame());
 
     if (m_continuousPaintingEnabled) {
         ContinuousPainter::setNeedsDisplayRecursive(m_rootGraphicsLayer, m_pageOverlays.get());
         m_client->scheduleAnimation();
     }
 }
 
+static void pushFrameTimingRequestRectsToGraphicsLayer(Page* page)
+{
+    typedef WTF::HashMap<const GraphicsLayer*,
+        std::vector<std::pair<int64_t, WebRect>>>
+        GraphicsLayerFrameTimingRequests;
+
+    GraphicsLayerFrameTimingRequests glRequests;
+
+    for (Frame* frame = page ? page->mainFrame() : 0; frame;
+        frame = frame->tree().traverseNext()) {
+
+        // Need a LocalFrame to get the GraphicsLayer to use.
+        if (!frame->isLocalFrame())
+            continue;
+
+        LocalFrame* localframe = toLocalFrame(frame);
+        Document* document = localframe->document();
+        HTMLFrameOwnerElement* ownerElement = document->ownerElement();
+
+        const GraphicsLayer* graphicsLayer;
+
+        // Find frame's rect in graphics layer space
+        LayoutRect rect = localframe->contentRenderer()->viewRect();
+        Layer::mapRectToPaintInvalidationBacking(localframe->contentRenderer(),
+            localframe->contentRenderer()->containerForPaintInvalidation(),
+            rect);
+
+        if (document->layoutView()->enclosingLayer()->compositingState()

[chrishtr, 2015/03/27 01:13:02]

Why do you need this complicated conditional instead of a simple
Layer::mapRectToPaintInvalidationBacking(document->layoutView(), ...)?

I remember we went back and forth on this in the other CL, but let's relitigate.
:)

[MikeB, 2015/04/14 18:05:46]

I can't find us actually going back and forth last time.. 
https://codereview.chromium.org/390193003/diff/20001/Source/web/WebViewImpl.c...
Looks like you just said it looked more or less correct. 

This was replicating functionality in a different projection routine. Maybe
things have been cleaned up in the time since I started this project? Happy to
try the simpler API and if anything turns up in testing, we can start doing
things the more complicated way.

+            == PaintsIntoOwnBacking || !ownerElement) {
+            graphicsLayer = document->layoutView()->enclosingLayer()
+                ->enclosingLayerForPaintInvalidationCrossingFrameBoundaries()
+                ->graphicsLayerBacking();
+        } else {
+            if (!ownerElement->layoutObject())
+                continue;
+            graphicsLayer = ownerElement->layoutObject()->enclosingLayer()
+                ->enclosingLayerForPaintInvalidationCrossingFrameBoundaries()
+                ->graphicsLayerBacking();
+
+            Layer::mapRectToPaintInvalidationBacking(
+                ownerElement->layoutObject(),
+                ownerElement->layoutObject()->containerForPaintInvalidation(),
+                rect);
+        }
+
+        GraphicsLayerFrameTimingRequests::iterator glIter = glRequests.find(graphicsLayer);

[chrishtr, 2015/03/27 01:13:02]

s/glIter/requestIterator/

[MikeB, 2015/04/14 18:05:46]

Done.

+        std::vector<std::pair<int64_t, WebRect>> *glVector;

[chrishtr, 2015/03/27 01:13:03]

s/glVector/graphicsLayerTimingRect/

[MikeB, 2015/04/14 18:05:46]

Done.

+        if (glIter == glRequests.end()) {
+            glVector = &glRequests.add(graphicsLayer,
+                std::vector<std::pair<int64_t, WebRect>>()).storedValue->value;
+        } else {
+            glVector = &glIter->value;
+        }
+        glVector->push_back(std::make_pair(frame->frameID(), enclosingIntRect(rect)));
+    }
+
+    for (GraphicsLayerFrameTimingRequests::const_iterator iter = glRequests.begin(); iter != glRequests.end(); ++iter) {
+        const GraphicsLayer* graphicsLayer = iter->key;
+        graphicsLayer->platformLayer()->setFrameTimingRequests(iter->value);
+    }
+}
+
 void WebViewImpl::layout()
 {
     TRACE_EVENT0("blink", "WebViewImpl::layout");
     if (!mainFrameImpl())
         return;
 
     PageWidgetDelegate::layout(*m_page, *mainFrameImpl()->frame());
     updateLayerTreeBackgroundColor();
 
     for (size_t i = 0; i < m_linkHighlights.size(); ++i)
         m_linkHighlights[i]->updateGeometry();
+
+    pushFrameTimingRequestRectsToGraphicsLayer(m_page.get());
 }
 
 void WebViewImpl::paint(WebCanvas* canvas, const WebRect& rect)
 {
     // This should only be used when compositing is not being used for this
     // WebView, and it is painting into the recording of its parent.
     ASSERT(!isAcceleratedCompositingActive());
 
     double paintStart = currentTime();
     PageWidgetDelegate::paint(*m_page, pageOverlays(), canvas, rect, *m_page->deprecatedLocalMainFrame());
@@ skipping 2539 matching lines @@
         WebSize scrollOffset = mainFrame()->scrollOffset();
         scrollOffset.width += scrollDelta.width;
         scrollOffset.height += scrollDelta.height;
 
         WebPoint scrollPoint(scrollOffset.width, scrollOffset.height);
         setPageScaleFactor(pageScaleFactor() * pageScaleDelta, scrollPoint);
         m_doubleTapZoomPending = false;
     }
 }
 
+void WebViewImpl::recordFrameTimingEvent(FrameTimingEventType eventType, int64_t FrameId, const WebVector<std::pair<int, double>>& events)
+{
+    if (!mainFrameImpl() || !mainFrameImpl()->frameView())

[chrishtr, 2015/03/27 01:13:03]

In what situation do you need this conditional?

[MikeB, 2015/04/14 18:05:45]

Most of the routines in this file (at least, the ones I was using for
inspiration) made this check. Upon further review, they seem to actually USE
mainFrameImpl()->frameView() for an explicit call (most of the time) so I should
be ok to drop it.

+        return;
+
+    Frame* frame = m_page ? m_page->mainFrame() : 0;

[chrishtr, 2015/03/27 01:13:03]

Ditto.

[MikeB, 2015/04/14 18:05:46]

For this one, I don't feel comfortable dereferencing a pointer if I don't know
100% that it won't be null. So if m_page is null, I just set frame = 0.

+
+    while (frame && frame->frameID() != FrameId) {
+        frame = frame->tree().traverseNext();
+    }
+
+    if (!frame || !frame->domWindow() || !frame->domWindow()->document())
+        return; // ASSERT? Other way to report error?

[chrishtr, 2015/03/27 01:13:03]

Is the frameID supposed to be guaranteed to exist?

Then use ASSERT_NOT_REACHED();

[MikeB, 2015/04/14 18:05:46]

No, there is a possibility that the frame has since been removed from the DOM
and I should just return. 

+
+    ASSERT(frame->isLocalFrame());

[chrishtr, 2015/03/27 01:13:03]

Why is this guaranteed?

[MikeB, 2015/04/14 18:05:46]

No longer required. I was using localframe-only APIs to get the performance
timeline. Looks like that's been refactored since. 

+
+    blink::DOMWindow* domWindow = frame->domWindow();
+    blink::Performance* performance = DOMWindowPerformance::performance(*domWindow);
+    for (size_t i = 0; i < events.size(); ++i) {
+        if (eventType == CompositeEvent)
+            performance->addCompositeTiming(domWindow->document(), events[i].first, events[i].second);
+        else if (eventType == RenderEvent)
+            performance->addRenderTiming(domWindow->document(), events[i].first, events[i].second);
+    }
+}
+
 void WebViewImpl::updateLayerTreeViewport()
 {
     if (!page() || !m_layerTreeView)
         return;
 
     m_layerTreeView->setPageScaleFactorAndLimits(pageScaleFactor(), minimumPageScaleFactor(), maximumPageScaleFactor());
 }
 
 void WebViewImpl::updateLayerTreeBackgroundColor()
 {
@@ skipping 140 matching lines @@
     return mainFrameImpl()->frameView()->layoutSize().width() == m_size.width
         || (constraints.minimumScale == constraints.maximumScale && constraints.minimumScale != -1);
 }
 
 void WebViewImpl::forceNextWebGLContextCreationToFail()
 {
     WebGLRenderingContext::forceNextWebGLContextCreationToFail();
 }
 
 } // namespace blink