Implement a Hit Test Cache.

Source/core/layout/LayoutView.cpp

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
@@ skipping 10 matching lines @@
 #include "config.h"
 #include "core/layout/LayoutView.h"
 
 #include "core/dom/Document.h"
 #include "core/dom/Element.h"
 #include "core/editing/FrameSelection.h"
 #include "core/frame/LocalFrame.h"
 #include "core/html/HTMLFrameOwnerElement.h"
 #include "core/html/HTMLIFrameElement.h"
 #include "core/layout/ColumnInfo.h"
-#include "core/layout/HitTestResult.h"
 #include "core/layout/LayoutFlowThread.h"
 #include "core/layout/LayoutGeometryMap.h"
 #include "core/layout/LayoutPart.h"
 #include "core/layout/LayoutQuote.h"
 #include "core/layout/LayoutScrollbarPart.h"
 #include "core/layout/compositing/DeprecatedPaintLayerCompositor.h"
 #include "core/page/Page.h"
 #include "core/paint/DeprecatedPaintLayer.h"
 #include "core/paint/ViewPainter.h"
 #include "core/svg/SVGDocumentExtensions.h"
 #include "platform/TraceEvent.h"
 #include "platform/geometry/FloatQuad.h"
 #include "platform/geometry/TransformState.h"
+#include "platform/graphics/GraphicsLayer.h"
 #include "platform/graphics/paint/DisplayItemList.h"
 
 namespace blink {
 
 LayoutView::LayoutView(Document* document)
     : LayoutBlockFlow(document)
     , m_frameView(document->view())
     , m_selectionStart(nullptr)
     , m_selectionEnd(nullptr)
     , m_selectionStartPos(-1)
     , m_selectionEndPos(-1)
     , m_pageLogicalHeight(0)
     , m_pageLogicalHeightChanged(false)
     , m_layoutState(0)
     , m_layoutQuoteHead(nullptr)
     , m_layoutCounterCount(0)
     , m_hitTestCount(0)
+    , m_hitTestCacheHits(0)
     , m_pendingSelection(PendingSelection::create())
 {
     // init LayoutObject attributes
     setInline(false);
 
     m_minPreferredLogicalWidth = 0;
     m_maxPreferredLogicalWidth = 0;
 
     setPreferredLogicalWidthsDirty(MarkOnlyThis);
 
     setPositionState(AbsolutePosition); // to 0,0 :)
 }
 
 LayoutView::~LayoutView()
 {
 }
 
 bool LayoutView::hitTest(HitTestResult& result)
 {
-    return hitTest(result.hitTestRequest(), result.hitTestLocation(), result);
-}
-
-bool LayoutView::hitTest(const HitTestRequest& request, const HitTestLocation& location, HitTestResult& result)
-{
     TRACE_EVENT0("blink", "LayoutView::hitTest");
     m_hitTestCount++;
 
-    ASSERT(!location.isRectBasedTest() || request.listBased());
+    ASSERT(!result.hitTestLocation().isRectBasedTest() || result.hitTestRequest().listBased());
 
     // We have to recursively update layout/style here because otherwise, when the hit test recurses
     // into a child document, it could trigger a layout on the parent document, which can destroy DeprecatedPaintLayer
     // that are higher up in the call stack, leading to crashes.
     // Note that Document::updateLayout calls its parent's updateLayout.
     // FIXME: It should be the caller's responsibility to ensure an up-to-date layout.
     frameView()->updateLayoutAndStyleForPainting();
     commitPendingSelection();
 
-    bool hitLayer = layer()->hitTest(request, location, result);
+    bool cacheHit = false;
+    // Determine if we should use the hit test cache.
+    if (frameView()->layoutCount() == m_hitTestCacheLayoutCount) {
+        if (!m_hitTestCacheResult.hitTestLocation().isRectBasedTest() && !result.hitTestLocation().isRectBasedTest() && m_hitTestCacheResult.validityRect().contains(result.hitTestLocation().point())) {
+            if (result.hitTestRequest().equalForCacheability(m_hitTestCacheResult.hitTestRequest())) {
+                m_hitTestCacheHits++;
+                cacheHit = true;
+            }
+        }
+    }
+    bool hitLayer = layer()->hitTest(result);
 
     // FrameView scrollbars are not the same as Layer scrollbars tested by Layer::hitTestOverflowControls,
     // so we need to test FrameView scrollbars separately here. Note that it's important we do this after
     // the hit test above, because that may overwrite the entire HitTestResult when it finds a hit.
-    IntPoint framePoint = frameView()->contentsToFrame(location.roundedPoint());
+    IntPoint framePoint = frameView()->contentsToFrame(result.hitTestLocation().roundedPoint());
     if (Scrollbar* frameScrollbar = frameView()->scrollbarAtFramePoint(framePoint))
         result.setScrollbar(frameScrollbar);
 
+    if (cacheHit) {
+        if (!m_hitTestCacheResult.equalForCacheability(result)) {
+            for (int i = 0; i < 10; ++i) {
+                layer()->hitTest(result);
+            }
+
+            WTF_LOG_ERROR("Hit failure with %lf %lf cache %lf %lf", result.hitTestLocation().point().x().toDouble(), result.hitTestLocation().point().y().toDouble(), m_hitTestCacheResult.hitTestLocation().point().x().toDouble(), m_hitTestCacheResult.hitTestLocation().point().y().toDouble());
+
+            // DCHECK that the cache hit is the same as the actual result
+            ASSERT(false);
+        }
+    }
+    if (hitLayer) {
+        m_hitTestCacheResult = result;
+        m_hitTestCacheLayoutCount = frameView()->layoutCount();
+
+        // TODO(dtapuska): We shouldn't send the hit cache result to the compositor if
+        // we aren't displaying it in HUD: as it slows everything down.
+        if (layer()->graphicsLayerBacking()) {
+            layer()->graphicsLayerBacking()->platformLayer()->setHitCacheRect(enclosingIntRect(m_hitTestCacheResult.validityRect()));
+        }
+    }
+
     return hitLayer;
 }
 
+void LayoutView::clearHitTestCache()
+{
+    m_hitTestCacheResult = HitTestResult();
+    m_hitTestCacheLayoutCount = 0;
+}
+
 void LayoutView::computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit, LogicalExtentComputedValues& computedValues) const
 {
     computedValues.m_extent = (!shouldUsePrintingLayout() && m_frameView) ? LayoutUnit(viewLogicalHeight()) : logicalHeight;
 }
 
 void LayoutView::updateLogicalWidth()
 {
     if (!shouldUsePrintingLayout() && m_frameView)
         setLogicalWidth(viewLogicalWidth());
 }
@@ skipping 755 matching lines @@
     if (shouldUsePrintingLayout())
         return pageLogicalHeight();
     return viewLogicalHeight();
 }
 
 float LayoutView::zoomFactor() const
 {
     return m_frameView->frame().pageZoomFactor();
 }
 
-void LayoutView::updateHitTestResult(HitTestResult& result, const LayoutPoint& point)
+void LayoutView::updateHitTestResult(HitTestResult& result, const LayoutPoint& point, const LayoutRect& rect)
 {
     if (result.innerNode())
         return;
 
+    result.intersectValidityRect(rect);
     Node* node = document().documentElement();
     if (node) {
         LayoutPoint adjustedPoint = point;
         offsetForContents(adjustedPoint);
         result.setNodeAndPosition(node, adjustedPoint);
     }
 }
 
 bool LayoutView::usesCompositing() const
 {
@@ skipping 42 matching lines @@
     return viewHeight(IncludeScrollbars) / scale;
 }
 
 void LayoutView::willBeDestroyed()
 {
     LayoutBlockFlow::willBeDestroyed();
     m_compositor.clear();
 }
 
 } // namespace blink