DevTools: expose layer compositing reasons and paint count via layer tree agent

Source/core/inspector/InspectorLayerTreeAgent.cpp

 /*
  * Copyright (C) 2012 Apple Inc. All rights reserved.
  * Copyright (C) 2013 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.
@@ skipping 28 matching lines @@
 #include "core/inspector/InspectorState.h"
 #include "core/inspector/InstrumentingAgents.h"
 #include "core/loader/DocumentLoader.h"
 #include "core/page/Page.h"
 #include "core/platform/graphics/IntRect.h"
 #include "core/platform/graphics/transforms/TransformationMatrix.h"
 #include "core/rendering/RenderLayer.h"
 #include "core/rendering/RenderLayerBacking.h"
 #include "core/rendering/RenderLayerCompositor.h"
 #include "core/rendering/RenderView.h"
+#include "public/platform/WebCompositingReasons.h"
 #include "public/platform/WebLayer.h"
 
 namespace WebCore {
 
 namespace LayerTreeAgentState {
 static const char layerTreeAgentEnabled[] = "layerTreeAgentEnabled";
 };
 
 static PassRefPtr<TypeBuilder::LayerTree::Layer> buildObjectForLayer(GraphicsLayer* graphicsLayer, int nodeId, bool forceRoot)
 {
     RefPtr<TypeBuilder::LayerTree::Layer> layerObject = TypeBuilder::LayerTree::Layer::create()
         .setLayerId(String::number(graphicsLayer->platformLayer()->id()))
         .setNodeId(nodeId)
         .setOffsetX(graphicsLayer->position().x())
         .setOffsetY(graphicsLayer->position().y())
         .setWidth(graphicsLayer->size().width())
         .setHeight(graphicsLayer->size().height())
-        .setPaintCount(graphicsLayer->repaintCount());
+        .setPaintCount(graphicsLayer->paintCount());
 
     // Artificially clip tree at root renger layer's graphic layer -- it might be not the real
     // root of graphics layer hierarchy, as platform adds containing layers (e.g. for overflosw scroll).

[trchen, 2013/08/22 23:02:35]

I knew you didn't add this, but this comment is full of typos. :(

s/renger layer/render layer/
s/overflosw scroll/frame scrolling/

-    if (graphicsLayer->parent() && !forceRoot)
-        layerObject->setParentLayerId(String::number(graphicsLayer->parent()->platformLayer()->id()));
-
+    if (!forceRoot) {
+        GraphicsLayer* parent = graphicsLayer->parent();
+        if (!parent)
+            parent = graphicsLayer->replicatedLayer();
+        if (parent)
+            layerObject->setParentLayerId(String::number(parent->platformLayer()->id()));
+    }
     const TransformationMatrix& transform = graphicsLayer->transform();
     if (!transform.isIdentity()) {
         TransformationMatrix::FloatMatrix4 flattenedMatrix;
         transform.toColumnMajorFloatArray(flattenedMatrix);
         RefPtr<TypeBuilder::Array<double> > transformArray = TypeBuilder::Array<double>::create();
         for (size_t i = 0; i < WTF_ARRAY_LENGTH(flattenedMatrix); ++i)
             transformArray->addItem(flattenedMatrix[i]);
         layerObject->setTransform(transformArray);
         const FloatPoint3D& anchor = graphicsLayer->anchorPoint();
         layerObject->setAnchorX(anchor.x());
@@ skipping 61 matching lines @@
 
 void InspectorLayerTreeAgent::layerTreeDidChange()
 {
     m_frontend->layerTreeDidChange();
 }
 
 void InspectorLayerTreeAgent::getLayers(ErrorString* errorString, const int* nodeId, RefPtr<TypeBuilder::Array<TypeBuilder::LayerTree::Layer> >& layers)
 {
     layers = TypeBuilder::Array<TypeBuilder::LayerTree::Layer>::create();
 
-    RenderView* renderView = m_page->mainFrame()->contentRenderer();
-    RenderLayerCompositor* compositor = renderView ? renderView->compositor() : 0;
+    RenderLayerCompositor* compositor = renderLayerCompositor(errorString);
     if (!compositor) {
         *errorString = "Not in compositing mode";

[trchen, 2013/08/22 23:02:35]

errorString is already set.

         return;
     }
     if (!nodeId) {
         gatherLayersUsingRenderLayerHierarchy(errorString, compositor->rootRenderLayer(), layers);
         return;
     }
     Node* node = m_instrumentingAgents->inspectorDOMAgent()->nodeForId(*nodeId);
     if (!node) {
         *errorString = "Provided node id doesn't match any known node";
         return;
     }
     RenderObject* renderer = node->renderer();
     if (!renderer) {
         *errorString = "Node for provided node id doesn't have a renderer";
         return;
     }
     gatherLayersUsingRenderObjectHierarchy(errorString, renderer, layers);
 }
 
 void InspectorLayerTreeAgent::addRenderLayerBacking(ErrorString* errorString, RenderLayerBacking* layerBacking, Node* node, RefPtr<TypeBuilder::Array<TypeBuilder::LayerTree::Layer> >& layers)
 {
     int nodeId = idForNode(errorString, node);
-    RenderLayerCompositor* compositor = layerBacking->owningLayer()->compositor();
+    RenderLayerCompositor* compositor = renderLayerCompositor(errorString);

[trchen, 2013/08/22 23:02:35]

Unused. Can we remove this variable?

     bool forceRoot = layerBacking->owningLayer()->isRootLayer();
     if (layerBacking->ancestorClippingLayer()) {
         maybeAddGraphicsLayer(layerBacking->ancestorClippingLayer(), nodeId, layers, forceRoot);
         forceRoot = false;
     }
     maybeAddGraphicsLayer(layerBacking->graphicsLayer(), nodeId, layers, forceRoot);
     maybeAddGraphicsLayer(layerBacking->clippingLayer(), nodeId, layers);
     maybeAddGraphicsLayer(layerBacking->foregroundLayer(), nodeId, layers);
     maybeAddGraphicsLayer(layerBacking->backgroundLayer(), nodeId, layers);
     maybeAddGraphicsLayer(layerBacking->scrollingLayer(), nodeId, layers);
@@ skipping 27 matching lines @@
 {
     InspectorDOMAgent* domAgent = m_instrumentingAgents->inspectorDOMAgent();
 
     int nodeId = domAgent->boundNodeId(node);
     if (!nodeId)
         nodeId = domAgent->pushNodeToFrontend(errorString, domAgent->boundNodeId(node->document()), node);
 
     return nodeId;
 }
 
+RenderLayerCompositor* InspectorLayerTreeAgent::renderLayerCompositor(ErrorString* errorString)
+{
+    RenderView* renderView = m_page->mainFrame()->contentRenderer();
+    RenderLayerCompositor* compositor = renderView ? renderView->compositor() : 0;
+    if (!compositor)
+        *errorString = "Not in the compositing mode";
+    return compositor;
+}
+
+GraphicsLayer* InspectorLayerTreeAgent::layerById(ErrorString* errorString, const String& layerId)
+{
+    bool ok;
+    int id = layerId.toInt(&ok);
+    if (!ok) {
+        *errorString = "Invalid layer id";
+        return 0;
+    }
+    RenderLayerCompositor* compositor = renderLayerCompositor(errorString);
+    if (!compositor)
+        return 0;
+    Vector<std::pair<GraphicsLayer*, size_t> > stack;

[trchen, 2013/08/22 23:02:35]

Any reason why not use recursion here?

+    stack.append(std::make_pair(compositor->rootGraphicsLayer(), 0));
+    while (!stack.isEmpty()) {
+        GraphicsLayer* layer = stack.last().first;
+        size_t& childIndex = stack.last().second;
+        if (childIndex < layer->children().size()) {
+            stack.append(std::make_pair(layer->children()[childIndex], 0));
+            childIndex++;
+            continue;
+        }
+        if (layer->platformLayer()->id() == id)
+            return layer;
+        stack.removeLast();
+    }
+    *errorString = "No layer matching given id found";
+    return 0;
+}
+
+void InspectorLayerTreeAgent::reasonsForCompositingLayer(ErrorString* errorString, const String& layerId, RefPtr<TypeBuilder::LayerTree::CompositingReasons>& compositingReasons)
+{
+    const GraphicsLayer* graphicsLayer = layerById(errorString, layerId);
+    if (!graphicsLayer)
+        return;
+
+    WebKit::WebCompositingReasons reasonsBitmask = graphicsLayer->compositingReasons();
+    compositingReasons = TypeBuilder::LayerTree::CompositingReasons::create();
+
+    if (reasonsBitmask & CompositingReason3DTransform)
+        compositingReasons->setTransform3D(true);
+
+    if (reasonsBitmask & CompositingReasonVideo)
+        compositingReasons->setVideo(true);
+    else if (reasonsBitmask & CompositingReasonCanvas)
+        compositingReasons->setCanvas(true);
+    else if (reasonsBitmask & CompositingReasonPlugin)
+        compositingReasons->setPlugin(true);
+    else if (reasonsBitmask & CompositingReasonIFrame)
+        compositingReasons->setIFrame(true);
+
+    if (reasonsBitmask & CompositingReasonBackfaceVisibilityHidden)
+        compositingReasons->setBackfaceVisibilityHidden(true);
+
+    if (reasonsBitmask & CompositingReasonAnimation)
+        compositingReasons->setAnimation(true);
+
+    if (reasonsBitmask & CompositingReasonFilters)
+        compositingReasons->setFilters(true);
+
+    if (reasonsBitmask & CompositingReasonPositionFixed)
+        compositingReasons->setPositionFixed(true);
+
+    if (reasonsBitmask & CompositingReasonPositionSticky)
+        compositingReasons->setPositionSticky(true);
+
+    if (reasonsBitmask & CompositingReasonOverflowScrollingTouch)
+        compositingReasons->setOverflowScrollingTouch(true);
+
+    if (reasonsBitmask & CompositingReasonAssumedOverlap)
+        compositingReasons->setAssumedOverlap(true);
+
+    if (reasonsBitmask & CompositingReasonOverlap)
+        compositingReasons->setOverlap(true);
+
+    if (reasonsBitmask & CompositingReasonNegativeZIndexChildren)
+        compositingReasons->setNegativeZIndexChildren(true);
+
+    if (reasonsBitmask & CompositingReasonTransformWithCompositedDescendants)
+        compositingReasons->setTransformWithCompositedDescendants(true);
+
+    if (reasonsBitmask & CompositingReasonOpacityWithCompositedDescendants)
+        compositingReasons->setOpacityWithCompositedDescendants(true);
+
+    if (reasonsBitmask & CompositingReasonMaskWithCompositedDescendants)
+        compositingReasons->setMaskWithCompositedDescendants(true);
+
+    if (reasonsBitmask & CompositingReasonReflectionWithCompositedDescendants)
+        compositingReasons->setReflectionWithCompositedDescendants(true);
+
+    if (reasonsBitmask & CompositingReasonFilterWithCompositedDescendants)
+        compositingReasons->setFilterWithCompositedDescendants(true);
+
+    if (reasonsBitmask & CompositingReasonBlendingWithCompositedDescendants)
+        compositingReasons->setBlendingWithCompositedDescendants(true);
+
+    if (reasonsBitmask & CompositingReasonClipsCompositingDescendants)
+        compositingReasons->setClipsCompositingDescendants(true);
+
+    if (reasonsBitmask & CompositingReasonPerspective)
+        compositingReasons->setPerspective(true);
+
+    if (reasonsBitmask & CompositingReasonPreserve3D)
+        compositingReasons->setPreserve3D(true);
+
+    if (reasonsBitmask & CompositingReasonRoot)
+        compositingReasons->setRoot(true);
+
+    if (reasonsBitmask & CompositingReasonLayerForClip)
+        compositingReasons->setLayerForClip(true);
+
+    if (reasonsBitmask & CompositingReasonLayerForScrollbar)
+        compositingReasons->setLayerForScrollbar(true);
+
+    if (reasonsBitmask & CompositingReasonLayerForScrollingContainer)
+        compositingReasons->setLayerForScrollingContainer(true);
+
+    if (reasonsBitmask & CompositingReasonLayerForForeground)
+        compositingReasons->setLayerForForeground(true);
+
+    if (reasonsBitmask & CompositingReasonLayerForBackground)
+        compositingReasons->setLayerForBackground(true);
+
+    if (reasonsBitmask & CompositingReasonLayerForMask)
+        compositingReasons->setLayerForMask(true);
+
+    if (reasonsBitmask & CompositingReasonLayerForVideoOverlay)
+        compositingReasons->setLayerForVideoOverlay(true);
+}
+
 } // namespace WebCore