Observably effectful nodes in DFG IR should come last in their byteco…

…de instruction (i.e. forExit section), except for Hint nodes

https://bugs.webkit.org/show_bug.cgi?id=142920

Reviewed by Oliver Hunt, Geoffrey Garen, and Mark Lam.

Observably effectful, n.: If we reexecute the bytecode instruction after this node has
executed, then something other than the bytecode instruction's specified outcome will
happen.

We almost never had observably effectful nodes except at the end of the bytecode
instruction.  The exception is a lowered transitioning PutById:

PutStructure(@o, S1 -> S2)
PutByOffset(@o, @o, @v)

The PutStructure is observably effectful: if you try to reexecute the bytecode after
doing the PutStructure, then we'll most likely crash.  The generic PutById handling means
first checking what the old structure of the object is; but if we reexecute, the old
structure will seem to be the new structure.  But the property ensured by the new
structure hasn't been stored yet, so any attempt to load it or scan it will crash.

Intriguingly, however, none of the other operations involved in the PutById are
observably effectful.  Consider this example:

PutByOffset(@o, @o, @v)
PutStructure(@o, S1 -> S2)

Note that the PutStructure node doesn't reallocate property storage; see further below
for an example that does that. Because no property storage is happening, we know that we
already had room for the new property.  This means that the PutByOffset is no observable
until the PutStructure executes and "reveals" the property.  Hence, PutByOffset is not
observably effectful.

Now consider this:

b: AllocatePropertyStorage(@o)
PutByOffset(@b, @o, @v)
PutStructure(@o, S1 -> S2)

Surprisingly, this is also safe, because the AllocatePropertyStorage is not observably
effectful. It *does* reallocate the property storage and the new property storage pointer
is stored into the object. But until the PutStructure occurs, the world will just think
that the reallocation didn't happen, in the sense that we'll think that the property
storage is using less memory than what we just allocated. That's harmless.

The AllocatePropertyStorage is safe in other ways, too. Even if we GC'd after the
AllocatePropertyStorage but before the PutByOffset (or before the PutStructure),
everything could be expected to be fine, so long as all of @o, @v and @b are on the
stack. If they are all on the stack, then the GC will leave the property storage alone
(so the extra memory we just allocated would be safe). The GC will not scan the part of
the property storage that contains @v, but that's fine, so long as @v is on the stack.

The better long-term solution is probably bug 142921.

But for now, this:

- Fixes an object materialization bug, exemplified by the two tests, that previously
  crashed 100% of the time with FTL enabled and concurrent JIT disabled.

- Allows us to remove the workaround introduced in r174856.

* dfg/DFGByteCodeParser.cpp:
(JSC::DFG::ByteCodeParser::handlePutById):
* dfg/DFGConstantFoldingPhase.cpp:
(JSC::DFG::ConstantFoldingPhase::emitPutByOffset):
* dfg/DFGFixupPhase.cpp:
(JSC::DFG::FixupPhase::insertCheck):
(JSC::DFG::FixupPhase::indexOfNode): Deleted.
(JSC::DFG::FixupPhase::indexOfFirstNodeOfExitOrigin): Deleted.
* dfg/DFGInsertionSet.h:
(JSC::DFG::InsertionSet::insertOutOfOrder): Deleted.
(JSC::DFG::InsertionSet::insertOutOfOrderNode): Deleted.
* tests/stress/materialize-past-butterfly-allocation.js: Added.
(bar):
(foo0):
(foo1):
(foo2):
(foo3):
(foo4):
* tests/stress/materialize-past-put-structure.js: Added.
(foo):



Canonical link: https://commits.webkit.org/160949@main
git-svn-id: https://svn.webkit.org/repository/webkit/trunk@181817 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/JavaScriptCore/ChangeLog

@@ -1,3 +1,87 @@
+2015-03-20  Filip Pizlo  <fpizlo@apple.com>
+
+        Observably effectful nodes in DFG IR should come last in their bytecode instruction (i.e. forExit section), except for Hint nodes
+        https://bugs.webkit.org/show_bug.cgi?id=142920
+
+        Reviewed by Oliver Hunt, Geoffrey Garen, and Mark Lam.
+
+        Observably effectful, n.: If we reexecute the bytecode instruction after this node has
+        executed, then something other than the bytecode instruction's specified outcome will
+        happen.
+
+        We almost never had observably effectful nodes except at the end of the bytecode
+        instruction.  The exception is a lowered transitioning PutById:
+
+        PutStructure(@o, S1 -> S2)
+        PutByOffset(@o, @o, @v)
+
+        The PutStructure is observably effectful: if you try to reexecute the bytecode after
+        doing the PutStructure, then we'll most likely crash.  The generic PutById handling means
+        first checking what the old structure of the object is; but if we reexecute, the old
+        structure will seem to be the new structure.  But the property ensured by the new
+        structure hasn't been stored yet, so any attempt to load it or scan it will crash.
+
+        Intriguingly, however, none of the other operations involved in the PutById are
+        observably effectful.  Consider this example:
+
+        PutByOffset(@o, @o, @v)
+        PutStructure(@o, S1 -> S2)
+
+        Note that the PutStructure node doesn't reallocate property storage; see further below
+        for an example that does that. Because no property storage is happening, we know that we
+        already had room for the new property.  This means that the PutByOffset is no observable
+        until the PutStructure executes and "reveals" the property.  Hence, PutByOffset is not
+        observably effectful.
+
+        Now consider this:
+
+        b: AllocatePropertyStorage(@o)
+        PutByOffset(@b, @o, @v)
+        PutStructure(@o, S1 -> S2)
+
+        Surprisingly, this is also safe, because the AllocatePropertyStorage is not observably
+        effectful. It *does* reallocate the property storage and the new property storage pointer
+        is stored into the object. But until the PutStructure occurs, the world will just think
+        that the reallocation didn't happen, in the sense that we'll think that the property
+        storage is using less memory than what we just allocated. That's harmless.
+
+        The AllocatePropertyStorage is safe in other ways, too. Even if we GC'd after the
+        AllocatePropertyStorage but before the PutByOffset (or before the PutStructure),
+        everything could be expected to be fine, so long as all of @o, @v and @b are on the
+        stack. If they are all on the stack, then the GC will leave the property storage alone
+        (so the extra memory we just allocated would be safe). The GC will not scan the part of
+        the property storage that contains @v, but that's fine, so long as @v is on the stack.
+
+        The better long-term solution is probably bug 142921.
+
+        But for now, this:
+
+        - Fixes an object materialization bug, exemplified by the two tests, that previously
+          crashed 100% of the time with FTL enabled and concurrent JIT disabled.
+
+        - Allows us to remove the workaround introduced in r174856.
+
+        * dfg/DFGByteCodeParser.cpp:
+        (JSC::DFG::ByteCodeParser::handlePutById):
+        * dfg/DFGConstantFoldingPhase.cpp:
+        (JSC::DFG::ConstantFoldingPhase::emitPutByOffset):
+        * dfg/DFGFixupPhase.cpp:
+        (JSC::DFG::FixupPhase::insertCheck):
+        (JSC::DFG::FixupPhase::indexOfNode): Deleted.
+        (JSC::DFG::FixupPhase::indexOfFirstNodeOfExitOrigin): Deleted.
+        * dfg/DFGInsertionSet.h:
+        (JSC::DFG::InsertionSet::insertOutOfOrder): Deleted.
+        (JSC::DFG::InsertionSet::insertOutOfOrderNode): Deleted.
+        * tests/stress/materialize-past-butterfly-allocation.js: Added.
+        (bar):
+        (foo0):
+        (foo1):
+        (foo2):
+        (foo3):
+        (foo4):
+        * tests/stress/materialize-past-put-structure.js: Added.
+        (foo):
+
 2015-03-20  Yusuke Suzuki  <utatane.tea@gmail.com>
 
         REGRESSION (r179429): Potential Use after free in JavaScriptCore`WTF::StringImpl::ref + 83

Source/JavaScriptCore/dfg/DFGByteCodeParser.cpp

@@ -2422,8 +2422,6 @@ void ByteCodeParser::handlePutById(
                 propertyStorage = addToGraph(GetButterfly, base);
         }
 
-        addToGraph(PutStructure, OpInfo(transition), base);
-
         StorageAccessData* data = m_graph.m_storageAccessData.add();
         data->offset = variant.offset();
         data->identifierNumber = identifierNumber;
@@ -2435,6 +2433,11 @@ void ByteCodeParser::handlePutById(
             base,
             value);
 
+        // FIXME: PutStructure goes last until we fix either
+        // https://bugs.webkit.org/show_bug.cgi?id=142921 or
+        // https://bugs.webkit.org/show_bug.cgi?id=142924.
+        addToGraph(PutStructure, OpInfo(transition), base);
+
         if (m_graph.compilation())
             m_graph.compilation()->noticeInlinedPutById();
         return;

Source/JavaScriptCore/dfg/DFGConstantFoldingPhase.cpp

@@ -568,20 +568,19 @@ class ConstantFoldingPhase : public Phase {
             propertyStorage = Edge(reallocatePropertyStorage);
         }
 
-        if (variant.kind() == PutByIdVariant::Transition) {
-            Node* putStructure = m_graph.addNode(SpecNone, PutStructure, origin, OpInfo(transition), childEdge);
-            m_insertionSet.insertNode(indexInBlock, SpecNone, StoreBarrier, origin, Edge(node->child1().node(), KnownCellUse));
-            m_insertionSet.insert(indexInBlock, putStructure);
-        }
-
         StorageAccessData& data = *m_graph.m_storageAccessData.add();
         data.offset = variant.offset();
         data.identifierNumber = identifierNumber;
 
         node->convertToPutByOffset(data, propertyStorage);
-        m_insertionSet.insertNode(
-            indexInBlock, SpecNone, StoreBarrier, origin, 
-            Edge(node->child2().node(), KnownCellUse));
+
+        if (variant.kind() == PutByIdVariant::Transition) {
+            // FIXME: PutStructure goes last until we fix either
+            // https://bugs.webkit.org/show_bug.cgi?id=142921 or
+            // https://bugs.webkit.org/show_bug.cgi?id=142924.
+            m_insertionSet.insertNode(
+                indexInBlock + 1, SpecNone, PutStructure, origin, OpInfo(transition), childEdge);
+        }
     }
 
     void addBaseCheck(

Source/JavaScriptCore/dfg/DFGFixupPhase.cpp

@@ -89,33 +89,6 @@ class FixupPhase : public Phase {
         m_insertionSet.execute(block);
     }
 
-    inline unsigned indexOfNode(Node* node, unsigned indexToSearchFrom)
-    {
-        unsigned index = indexToSearchFrom;
-        while (index) {
-            if (m_block->at(index) == node)
-                break;
-            index--;
-        }
-        ASSERT(m_block->at(index) == node);
-        return index;
-    }
-
-    inline unsigned indexOfFirstNodeOfExitOrigin(CodeOrigin& originForExit, unsigned indexToSearchFrom)
-    {
-        unsigned index = indexToSearchFrom;
-        ASSERT(m_block->at(index)->origin.forExit == originForExit);
-        while (index) {
-            index--;
-            if (m_block->at(index)->origin.forExit != originForExit) {
-                index++;
-                break;
-            }
-        }
-        ASSERT(m_block->at(index)->origin.forExit == originForExit);
-        return index;
-    }
-
     void fixupNode(Node* node)
     {
         NodeType op = node->op();
@@ -1782,19 +1755,7 @@ class FixupPhase : public Phase {
     void insertCheck(unsigned indexInBlock, Node* node)
     {
         observeUseKindOnNode<useKind>(node);
-        CodeOrigin& checkedNodeOrigin = node->origin.forExit;
-        CodeOrigin& currentNodeOrigin = m_currentNode->origin.forExit;
-        if (currentNodeOrigin == checkedNodeOrigin) {
-            // The checked node is within the same bytecode. Hence, the earliest
-            // position we can insert the check is right after the checked node.
-            indexInBlock = indexOfNode(node, indexInBlock) + 1;
-        } else {
-            // The checked node is from a preceding bytecode. Hence, the earliest
-            // position we can insert the check is at the start of the current
-            // bytecode.
-            indexInBlock = indexOfFirstNodeOfExitOrigin(currentNodeOrigin, indexInBlock);
-        }
-        m_insertionSet.insertOutOfOrderNode(
+        m_insertionSet.insertNode(
             indexInBlock, SpecNone, Check, m_currentNode->origin, Edge(node, useKind));
     }
 

Source/JavaScriptCore/dfg/DFGInsertionSet.h

@@ -125,32 +125,6 @@ class InsertionSet {
         return insertConstantForUse(index, origin, jsUndefined(), useKind);
     }
 
-    Node* insertOutOfOrder(const Insertion& insertion)
-    {
-        size_t targetIndex = insertion.index();
-        size_t entry = m_insertions.size();
-        while (entry) {
-            entry--;
-            if (m_insertions[entry].index() <= targetIndex) {
-                entry++;
-                break;
-            }
-        }
-        m_insertions.insert(entry, insertion);
-        return insertion.element();
-    }
-
-    Node* insertOutOfOrder(size_t index, Node* element)
-    {
-        return insertOutOfOrder(Insertion(index, element));
-    }
-
-    template<typename... Params>
-    Node* insertOutOfOrderNode(size_t index, SpeculatedType type, Params... params)
-    {
-        return insertOutOfOrder(index, m_graph.addNode(type, params...));
-    }
-
     void execute(BasicBlock* block)
     {
         executeInsertions(*block, m_insertions);

Source/JavaScriptCore/tests/stress/materialize-past-butterfly-allocation.js

@@ -0,0 +1,89 @@
+function bar() {
+    return {f:42};
+}
+
+noInline(bar);
+
+function foo0(b) {
+    var o = {f:42};
+    if (b) {
+        var p = bar();
+        p.g = o;
+        return p;
+    }
+}
+
+function foo1(b) {
+    var o = {f:42};
+    if (b) {
+        var p = bar();
+        p.f1 = 1;
+        p.g = o;
+        return p;
+    }
+}
+
+function foo2(b) {
+    var o = {f:42};
+    if (b) {
+        var p = bar();
+        p.f1 = 1;
+        p.f2 = 2;
+        p.g = o;
+        return p;
+    }
+}
+
+function foo3(b) {
+    var o = {f:42};
+    if (b) {
+        var p = bar();
+        p.f1 = 1;
+        p.f2 = 2;
+        p.f3 = 3;
+        p.g = o;
+        return p;
+    }
+}
+
+function foo4(b) {
+    var o = {f:42};
+    if (b) {
+        var p = bar();
+        p.f1 = 1;
+        p.f2 = 2;
+        p.f3 = 3;
+        p.f4 = 4;
+        p.g = o;
+        return p;
+    }
+}
+
+noInline(foo0);
+noInline(foo1);
+noInline(foo2);
+noInline(foo3);
+noInline(foo4);
+
+var array = new Array(1000);
+for (var i = 0; i < 4000000; ++i) {
+    var o = foo0(true);
+    array[i % array.length] = o;
+}
+for (var i = 0; i < 4000000; ++i) {
+    var o = foo1(true);
+    array[i % array.length] = o;
+}
+for (var i = 0; i < 4000000; ++i) {
+    var o = foo2(true);
+    array[i % array.length] = o;
+}
+for (var i = 0; i < 4000000; ++i) {
+    var o = foo3(true);
+    array[i % array.length] = o;
+}
+for (var i = 0; i < 4000000; ++i) {
+    var o = foo4(true);
+    array[i % array.length] = o;
+}
+

Source/JavaScriptCore/tests/stress/materialize-past-put-structure.js

@@ -0,0 +1,14 @@
+function foo(p) {
+    var o = {f:42};
+    if (p)
+        return {f:42, g:o};
+}
+
+noInline(foo);
+
+var array = new Array(1000);
+for (var i = 0; i < 4000000; ++i) {
+    var o = foo(true);
+    array[i % array.length] = o;
+}
+