REGRESSION (r196268): Many assertion failures and crashes on SVG path animation tests...
authorsaid@apple.com <said@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 25 Feb 2016 19:55:55 +0000 (19:55 +0000)
committersaid@apple.com <said@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 25 Feb 2016 19:55:55 +0000 (19:55 +0000)
https://bugs.webkit.org/show_bug.cgi?id=154331

Reviewed by Darin Adler.

This is not an actual regression. The bug did exist before r196268 but
the whole document was leaking once an SVGAnimatedProperty was created
so there was no way to produce this bug. After fixing the leak, one crash
and one assert got uncovered. Both of them happen because of the fact:
"if an SVGAnimatedProperty is not referenced it will be deleted."

* svg/SVGPathElement.cpp:
(WebCore::SVGPathElement::lookupOrCreateDWrapper):
The code in this function was assuming that the wrapper will be created
only once which happens when SVGAnimatedProperty::lookupOrCreateWrapper()
is called. Before making this single call, lookupOrCreateDWrapper() was
building an initial SVGPathSegList from byte stream. But now
SVGAnimatedProperty::lookupWrapper() can return false even after creating
the SVGAnimatedProperty because it was deleted later. Calling
buildSVGPathSegListFromByteStream() more than once was causing
SVGAnimatedListPropertyTearOff::animationStarted() to fire the assertion
ASSERT(m_values.size() == m_wrappers.size()) because the path segments were
appended twice to m_values which is in fact SVGPathElement::m_pathSegList.value.
The fix is to build the initial SVGPathSegList only once which should happen
when m_pathSegList.value.isEmpty().

(WebCore::SVGPathElement::animatedPropertyWillBeDeleted):
* svg/SVGPathElement.h:
* svg/properties/SVGAnimatedPathSegListPropertyTearOff.h:
(WebCore::SVGAnimatedPathSegListPropertyTearOff::~SVGAnimatedPathSegListPropertyTearOff):
SVGPathElement is assuming the following equivalence relation:
m_pathSegList.shouldSynchronize ~ SVGAnimatedProperty_is_created_and_not_null.
SVGPathElement::animatedPathSegList() and animatedNormalizedPathSegList()
set m_pathSegList.shouldSynchronize to true when SVGAnimatedProperty is
created but nothing sets m_pathSegList.shouldSynchronize back to false.
This was not a problem when the SVGAnimatedProperty was leaking but after
ensuring it is deleted when it is not referenced this equivalence relation
becomes untrue sometimes. This caused SVGPathElement::svgAttributeChanged()
to crash when we check m_pathSegList.shouldSynchronize and if it is true we
assume that SVGAnimatedProperty::lookupWrapper() will return a non-null pointer
and therefore we deference this pointer and call SVGAnimatedProperty::isAnimating().
To fix this crash we need to set m_pathSegList.shouldSynchronize back to false
when the associated SVGAnimatedProperty is deleted.

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@197125 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/WebCore/ChangeLog
Source/WebCore/svg/SVGPathElement.cpp
Source/WebCore/svg/SVGPathElement.h
Source/WebCore/svg/properties/SVGAnimatedPathSegListPropertyTearOff.h

index 4802989..fe35983 100644 (file)
@@ -1,3 +1,49 @@
+2016-02-25  Said Abou-Hallawa  <sabouhallawa@apple.com>
+
+        REGRESSION (r196268): Many assertion failures and crashes on SVG path animation tests when JS garbage collection happens quickly
+        https://bugs.webkit.org/show_bug.cgi?id=154331
+
+        Reviewed by Darin Adler.
+
+        This is not an actual regression. The bug did exist before r196268 but
+        the whole document was leaking once an SVGAnimatedProperty was created
+        so there was no way to produce this bug. After fixing the leak, one crash
+        and one assert got uncovered. Both of them happen because of the fact:
+        "if an SVGAnimatedProperty is not referenced it will be deleted."
+
+        * svg/SVGPathElement.cpp:
+        (WebCore::SVGPathElement::lookupOrCreateDWrapper):
+        The code in this function was assuming that the wrapper will be created
+        only once which happens when SVGAnimatedProperty::lookupOrCreateWrapper()
+        is called. Before making this single call, lookupOrCreateDWrapper() was
+        building an initial SVGPathSegList from byte stream. But now
+        SVGAnimatedProperty::lookupWrapper() can return false even after creating
+        the SVGAnimatedProperty because it was deleted later. Calling
+        buildSVGPathSegListFromByteStream() more than once was causing
+        SVGAnimatedListPropertyTearOff::animationStarted() to fire the assertion
+        ASSERT(m_values.size() == m_wrappers.size()) because the path segments were
+        appended twice to m_values which is in fact SVGPathElement::m_pathSegList.value.
+        The fix is to build the initial SVGPathSegList only once which should happen
+        when m_pathSegList.value.isEmpty().
+        
+        (WebCore::SVGPathElement::animatedPropertyWillBeDeleted):
+        * svg/SVGPathElement.h:
+        * svg/properties/SVGAnimatedPathSegListPropertyTearOff.h:
+        (WebCore::SVGAnimatedPathSegListPropertyTearOff::~SVGAnimatedPathSegListPropertyTearOff):
+        SVGPathElement is assuming the following equivalence relation:
+        m_pathSegList.shouldSynchronize ~ SVGAnimatedProperty_is_created_and_not_null.
+        SVGPathElement::animatedPathSegList() and animatedNormalizedPathSegList()
+        set m_pathSegList.shouldSynchronize to true when SVGAnimatedProperty is
+        created but nothing sets m_pathSegList.shouldSynchronize back to false.
+        This was not a problem when the SVGAnimatedProperty was leaking but after
+        ensuring it is deleted when it is not referenced this equivalence relation
+        becomes untrue sometimes. This caused SVGPathElement::svgAttributeChanged()
+        to crash when we check m_pathSegList.shouldSynchronize and if it is true we
+        assume that SVGAnimatedProperty::lookupWrapper() will return a non-null pointer
+        and therefore we deference this pointer and call SVGAnimatedProperty::isAnimating().
+        To fix this crash we need to set m_pathSegList.shouldSynchronize back to false
+        when the associated SVGAnimatedProperty is deleted.
+
 2016-02-25  Brady Eidson  <beidson@apple.com>
 
         Modern IDB: WebKit 2 IPC layer.
index c86f7ed..ed297a5 100644 (file)
@@ -313,8 +313,8 @@ Ref<SVGAnimatedProperty> SVGPathElement::lookupOrCreateDWrapper(SVGElement* cont
     if (auto property = SVGAnimatedProperty::lookupWrapper<SVGPathElement, SVGAnimatedPathSegListPropertyTearOff>(&ownerType, dPropertyInfo()))
         return *property;
 
-    // Build initial SVGPathSegList.
-    buildSVGPathSegListFromByteStream(ownerType.m_pathByteStream, ownerType, ownerType.m_pathSegList.value, UnalteredParsing);
+    if (ownerType.m_pathSegList.value.isEmpty())
+        buildSVGPathSegListFromByteStream(ownerType.m_pathByteStream, ownerType, ownerType.m_pathSegList.value, UnalteredParsing);
 
     return SVGAnimatedProperty::lookupOrCreateWrapper<SVGPathElement, SVGAnimatedPathSegListPropertyTearOff, SVGPathSegList>
         (&ownerType, dPropertyInfo(), ownerType.m_pathSegList.value);
@@ -329,6 +329,15 @@ void SVGPathElement::synchronizeD(SVGElement* contextElement)
     ownerType.m_pathSegList.synchronize(&ownerType, dPropertyInfo()->attributeName, ownerType.m_pathSegList.value.valueAsString());
 }
 
+void SVGPathElement::animatedPropertyWillBeDeleted()
+{
+    // m_pathSegList.shouldSynchronize is set to true when the 'd' wrapper for m_pathSegList
+    // is created and cached. We need to reset it back to false when this wrapper is deleted
+    // so we can be sure if shouldSynchronize is true, SVGAnimatedProperty::lookupWrapper()
+    // will return a valid cached 'd' wrapper for the m_pathSegList.
+    m_pathSegList.shouldSynchronize = false;
+}
+
 RefPtr<SVGPathSegListPropertyTearOff> SVGPathElement::pathSegList()
 {
     m_pathSegList.shouldSynchronize = true;
index 170dfb3..89cc3d2 100644 (file)
@@ -99,6 +99,8 @@ public:
 
     WeakPtr<SVGPathElement> createWeakPtr() const { return m_weakPtrFactory.createWeakPtr(); }
 
+    void animatedPropertyWillBeDeleted();
+
 private:
     SVGPathElement(const QualifiedName&, Document&);
 
index c1644d8..83b6d6f 100644 (file)
@@ -112,6 +112,13 @@ private:
         : SVGAnimatedListPropertyTearOff<SVGPathSegList>(contextElement, attributeName, animatedPropertyType, values)
         , m_animatedPathByteStream(nullptr)
     {
+        ASSERT(contextElement);
+        ASSERT(is<SVGPathElement>(contextElement));
+    }
+
+    virtual ~SVGAnimatedPathSegListPropertyTearOff()
+    {
+        downcast<SVGPathElement>(contextElement())->animatedPropertyWillBeDeleted();
     }
 
     SVGPathByteStream* m_animatedPathByteStream;