Changeset 201561 in webkit

Timestamp:

Jun 1, 2016, 11:50:09 AM (10 years ago)

Author:

commit-queue@webkit.org

Message:

SVGImage should report its memory cost to JS garbage collector
​https://bugs.webkit.org/show_bug.cgi?id=158139

Patch by Said Abou-Hallawa <​sabouhallawa@apple.com> on 2016-06-01
Reviewed by Geoffrey Garen.

Like what we do in HTMLImageLoader::notifyFinished() by reporting the memory
cost of the BitmapImage, we need to do something similar for the SVGImage. In
SVGImage::dataChange() and when allDataReceived is true, we can calculate
the size of all DOM nodes and their renderers. The size of the encoded data
has to be added as well to the total memory cost. An approximation for the
memory cost has to be used since it is costly to get an accurate number.

• bindings/js/JSDocumentCustom.cpp:

(WebCore::reportMemoryForDocumentIfFrameless): Use Node::approximateMemoryCost()
instead of sizeof(Node). A Node's descendant can override this function and
return a more accurate memory cost.

• dom/Node.h:

(WebCore::Node::approximateMemoryCost): Define this new virtual function in the
Node class. Its default value is sizeof(Node) but any descendant can return a
more accurate number.

• platform/graphics/Image.h:

(WebCore::Image::data): Define a const version of data() so it can be called
the const function SVGImage::reportApproximateMemoryCost().

• svg/SVGGraphicsElement.h: Override approximateMemoryCost() to return

sizeof(SVGGraphicsElement).

• svg/SVGPathElement.cpp:

(WebCore::SVGPathElement::approximateMemoryCost): Override this function to return
the memory cost of the points and the m_path of the renderer.

• svg/SVGPathElement.h:

• svg/SVGPolyElement.cpp:

(WebCore::SVGPolyElement::approximateMemoryCost): Override this function to return
the memory cost of the points and the m_path of the renderer.

• svg/SVGPolyElement.h:

• svg/graphics/SVGImage.cpp:

(WebCore::SVGImage::reportApproximateMemoryCost): Calculate the memory cost of the
nodes in the SVGDocument of an SVGImage. Then report this number to the JS garbage
collector.

(WebCore::SVGImage::dataChanged): After loading all the SVG encoded data and building
its DOM tree and the render tree, report the total memory cost to the JS garbage collector.

• svg/graphics/SVGImage.h:

Location:

trunk/Source/WebCore

Files:

• ChangeLog (modified) (1 diff)
• bindings/js/JSDocumentCustom.cpp (modified) (1 diff)
• dom/Node.h (modified) (1 diff)
• platform/graphics/Image.h (modified) (1 diff)
• svg/SVGGraphicsElement.h (modified) (1 diff)
• svg/SVGPathElement.cpp (modified) (1 diff)
• svg/SVGPathElement.h (modified) (1 diff)
• svg/SVGPolyElement.cpp (modified) (1 diff)
• svg/SVGPolyElement.h (modified) (1 diff)
• svg/graphics/SVGImage.cpp (modified) (5 diffs)
• svg/graphics/SVGImage.h (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2016-06-01  Said Abou-Hallawa  <sabouhallawa@apple.com>
+
+        SVGImage should report its memory cost to JS garbage collector
+        https://bugs.webkit.org/show_bug.cgi?id=158139
+
+        Reviewed by Geoffrey Garen.
+
+        Like what we do in HTMLImageLoader::notifyFinished() by reporting the memory
+        cost of the BitmapImage, we need to do something similar for the SVGImage. In
+        SVGImage::dataChange() and when allDataReceived is true, we can calculate
+        the size of all DOM nodes and their renderers. The size of the encoded data
+        has to be added as well to the total memory cost. An approximation for the
+        memory cost has to be used since it is costly to get an accurate number.
+
+        * bindings/js/JSDocumentCustom.cpp: 
+        (WebCore::reportMemoryForDocumentIfFrameless): Use Node::approximateMemoryCost()
+        instead of sizeof(Node). A Node's descendant can override this function and
+        return a more accurate memory cost.
+        
+        * dom/Node.h:
+        (WebCore::Node::approximateMemoryCost): Define this new virtual function in the
+        Node class. Its default value is sizeof(Node) but any descendant can return a
+        more accurate number.
+        
+        * platform/graphics/Image.h:
+        (WebCore::Image::data): Define a const version of data() so it can be called
+        the const function SVGImage::reportApproximateMemoryCost().
+        
+        * svg/SVGGraphicsElement.h: Override approximateMemoryCost() to return 
+        sizeof(SVGGraphicsElement).
+        
+        * svg/SVGPathElement.cpp:
+        (WebCore::SVGPathElement::approximateMemoryCost): Override this function to return
+        the memory cost of the points and the m_path of the renderer.
+        * svg/SVGPathElement.h:
+        
+        * svg/SVGPolyElement.cpp:
+        (WebCore::SVGPolyElement::approximateMemoryCost): Override this function to return
+        the memory cost of the points and the m_path of the renderer.
+        * svg/SVGPolyElement.h:
+        
+        * svg/graphics/SVGImage.cpp:
+        (WebCore::SVGImage::reportApproximateMemoryCost): Calculate the memory cost of the 
+        nodes in the SVGDocument of an SVGImage. Then report this number to the JS garbage 
+        collector.
+        
+        (WebCore::SVGImage::dataChanged): After loading all the SVG encoded data and building
+        its DOM tree and the render tree, report the total memory cost to the JS garbage collector.
+        * svg/graphics/SVGImage.h:
+
 2016-06-01  Andreas Kling  <akling@apple.com>
 

trunk/Source/WebCore/bindings/js/JSDocumentCustom.cpp

@@ -90 +90 @@
         return;
 
-    size_t nodeCount = 0;
+    size_t memoryCost = 0;
     for (Node* node = &document; node; node = NodeTraversal::next(*node))
-        ++nodeCount;
+        memoryCost += node->approximateMemoryCost();
 
     // FIXME: Adopt reportExtraMemoryVisited, and switch to reportExtraMemoryAllocated.
     // https://bugs.webkit.org/show_bug.cgi?id=142595
-    state.heap()->deprecatedReportExtraMemory(nodeCount * sizeof(Node));
+    state.heap()->deprecatedReportExtraMemory(memoryCost);
 }
 

trunk/Source/WebCore/dom/Node.h

@@ -144 +144 @@
     virtual void setNodeValue(const String&, ExceptionCode&);
     virtual NodeType nodeType() const = 0;
+    virtual size_t approximateMemoryCost() const { return sizeof(*this); }
     ContainerNode* parentNode() const;
     static ptrdiff_t parentNodeMemoryOffset() { return OBJECT_OFFSETOF(Node, m_parentNode); }

trunk/Source/WebCore/platform/graphics/Image.h

@@ -123 +123 @@
 
     SharedBuffer* data() { return m_encodedImageData.get(); }
+    const SharedBuffer* data() const { return m_encodedImageData.get(); }
 
     // Animation begins whenever someone draws the image, so startAnimation() is not normally called.

trunk/Source/WebCore/svg/SVGGraphicsElement.h

@@ -54 +54 @@
     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
 
+    size_t approximateMemoryCost() const override { return sizeof(*this); }
+
 protected:
     SVGGraphicsElement(const QualifiedName&, Document&);

trunk/Source/WebCore/svg/SVGPathElement.cpp

@@ -364 +364 @@
 }
 
+size_t SVGPathElement::approximateMemoryCost() const
+{
+    // This is an approximation for path memory cost since the path is parsed on demand.
+    size_t pathMemoryCost = (m_pathByteStream.size() / 10) * sizeof(FloatPoint);
+    // We need to account for the memory which is allocated by the RenderSVGPath::m_path.
+    return sizeof(*this) + (renderer() ? pathMemoryCost * 2 + sizeof(RenderSVGPath) : pathMemoryCost);
+}
+
 void SVGPathElement::pathSegListChanged(SVGPathSegRole role, ListModification listModification)
 {

trunk/Source/WebCore/svg/SVGPathElement.h

@@ -102 +102 @@
     void animatedPropertyWillBeDeleted();
 
+    size_t approximateMemoryCost() const override;
+
 private:
     SVGPathElement(const QualifiedName&, Document&);

trunk/Source/WebCore/svg/SVGPolyElement.cpp

@@ -131 +131 @@
 }
 
+size_t SVGPolyElement::approximateMemoryCost() const
+{
+    size_t pointsCost = pointList().size() * sizeof(FloatPoint);
+    // We need to account for the memory which is allocated by the RenderSVGPath::m_path.
+    return sizeof(*this) + (renderer() ? pointsCost * 2 + sizeof(RenderSVGPath) : pointsCost);
 }
+
+}

trunk/Source/WebCore/svg/SVGPolyElement.h

@@ -39 +39 @@
     static const SVGPropertyInfo* pointsPropertyInfo();
 
+    size_t approximateMemoryCost() const override;
+
 protected:
     SVGPolyElement(const QualifiedName&, Document&);

trunk/Source/WebCore/svg/graphics/SVGImage.cpp

@@ -30 +30 @@
 
 #include "Chrome.h"
+#include "DOMWindow.h"
 #include "DocumentLoader.h"
 #include "ElementIterator.h"
@@ -37 +38 @@
 #include "ImageObserver.h"
 #include "IntRect.h"
+#include "JSDOMWindowBase.h"
 #include "MainFrame.h"
 #include "PageConfiguration.h"
@@ -49 +51 @@
 #include "Settings.h"
 #include "TextStream.h"
+#include <runtime/JSCInlines.h>
+#include <runtime/JSLock.h>
 
 namespace WebCore {
@@ -354 +358 @@
 }
 
+void SVGImage::reportApproximateMemoryCost() const
+{
+    Document* document = m_page->mainFrame().document();
+    size_t decodedImageMemoryCost = 0;
+
+    for (Node* node = document; node; node = NodeTraversal::next(*node))
+        decodedImageMemoryCost += node->approximateMemoryCost();
+
+    JSC::VM& vm = JSDOMWindowBase::commonVM();
+    JSC::JSLockHolder lock(vm);
+    // FIXME: Adopt reportExtraMemoryVisited, and switch to reportExtraMemoryAllocated.
+    // https://bugs.webkit.org/show_bug.cgi?id=142595
+    vm.heap.deprecatedReportExtraMemory(decodedImageMemoryCost + data()->size());
+}
+
 bool SVGImage::dataChanged(bool allDataReceived)
 {
@@ -394 +413 @@
         // Set the intrinsic size before a container size is available.
         m_intrinsicSize = containerSize();
+        reportApproximateMemoryCost();
     }
 

trunk/Source/WebCore/svg/graphics/SVGImage.h

@@ -83 +83 @@
     void computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio) override;
 
+    void reportApproximateMemoryCost() const;
     bool dataChanged(bool allDataReceived) override;