<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[243122] trunk/Source/WebCore</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/243122">243122</a></dd>
<dt>Author</dt> <dd>rniwa@webkit.org</dd>
<dt>Date</dt> <dd>2019-03-18 18:32:04 -0700 (Mon, 18 Mar 2019)</dd>
</dl>

<h3>Log Message</h3>
<pre>Reduce the size of Node::deref by eliminating an explicit parentNode check
https://bugs.webkit.org/show_bug.cgi?id=195776

Reviewed by Geoffrey Garen.

This patch eliminates the nullity check of m_parentNode in Node::deref as well as the store to
m_refCount in the case of invoking Node::removedLastRef() as done for RefCounted in <a href="http://trac.webkit.org/projects/webkit/changeset/30042">r30042</a>.
Together, this patch shrinks WebCore's size by 46KB or ~0.7%.

To do this, we take we take a similar approach as WTF::String by using the lowest bit of m_refCount
to indicate whether a node has a parent or not. Regular ref-counting is done on the upper 31 bits.
Node::setParentNode updates this flag, and Node::deref() would only `delete this` if m_refCount
is identically equal to 0.

For a Document, we set m_refCounted to 0 before in the case of non-zero m_referencingNodeCount
since decrementReferencingNodeCount needs to be able to tell if there is an outstanding Ref/RefPtr
or not when m_referencingNodeCount becomes 0.

No new tests since there should be no behavioral change.

* dom/Document.cpp:
(WebCore::Document::removedLastRef):
* dom/Document.h:
(WebCore::Document::decrementReferencingNodeCount):
* dom/Node.cpp:
(WebCore::Node::Node): Moved the initialization of m_refCount to the member variable declaration.
(WebCore::Node::~Node):
(WebCore::Node::removedLastRef):
* dom/Node.h:
(WebCore::Node): Changed the type of m_refCount from signed int to uint32_t. It was changed from
unsigned int to signed int back in <a href="http://trac.webkit.org/projects/webkit/changeset/11492">r11492</a> but I don't think the signedness is needed.
(WebCore::Node::ref): Increment the ref count by 2 (upper 31-bit).
(WebCore::Node::deref): Implemented the optimization. This is what shrinks the WebCore binary size.
(WebCore::Node::hasOneRef const):
(WebCore::Node::refCount const): Ignore the lowest bit. Without this fix, the optimization in
replaceChildrenWithFragment to avoid replacing the text node is disabled whenever there is a parent.
(WebCore::Node::setParentNode): Sets the lowest bit to 1 if the node has a parent and 0 otherwise.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebCoreChangeLog">trunk/Source/WebCore/ChangeLog</a></li>
<li><a href="#trunkSourceWebCoredomDocumentcpp">trunk/Source/WebCore/dom/Document.cpp</a></li>
<li><a href="#trunkSourceWebCoredomDocumenth">trunk/Source/WebCore/dom/Document.h</a></li>
<li><a href="#trunkSourceWebCoredomNodecpp">trunk/Source/WebCore/dom/Node.cpp</a></li>
<li><a href="#trunkSourceWebCoredomNodeh">trunk/Source/WebCore/dom/Node.h</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebCoreChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/ChangeLog (243121 => 243122)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/ChangeLog   2019-03-19 00:39:41 UTC (rev 243121)
+++ trunk/Source/WebCore/ChangeLog      2019-03-19 01:32:04 UTC (rev 243122)
</span><span class="lines">@@ -1,3 +1,43 @@
</span><ins>+2019-03-18  Ryosuke Niwa  <rniwa@webkit.org>
+
+        Reduce the size of Node::deref by eliminating an explicit parentNode check
+        https://bugs.webkit.org/show_bug.cgi?id=195776
+
+        Reviewed by Geoffrey Garen.
+
+        This patch eliminates the nullity check of m_parentNode in Node::deref as well as the store to
+        m_refCount in the case of invoking Node::removedLastRef() as done for RefCounted in r30042.
+        Together, this patch shrinks WebCore's size by 46KB or ~0.7%.
+
+        To do this, we take we take a similar approach as WTF::String by using the lowest bit of m_refCount
+        to indicate whether a node has a parent or not. Regular ref-counting is done on the upper 31 bits.
+        Node::setParentNode updates this flag, and Node::deref() would only `delete this` if m_refCount
+        is identically equal to 0.
+
+        For a Document, we set m_refCounted to 0 before in the case of non-zero m_referencingNodeCount
+        since decrementReferencingNodeCount needs to be able to tell if there is an outstanding Ref/RefPtr
+        or not when m_referencingNodeCount becomes 0.
+
+        No new tests since there should be no behavioral change.
+
+        * dom/Document.cpp:
+        (WebCore::Document::removedLastRef):
+        * dom/Document.h:
+        (WebCore::Document::decrementReferencingNodeCount):
+        * dom/Node.cpp:
+        (WebCore::Node::Node): Moved the initialization of m_refCount to the member variable declaration.
+        (WebCore::Node::~Node):
+        (WebCore::Node::removedLastRef):
+        * dom/Node.h:
+        (WebCore::Node): Changed the type of m_refCount from signed int to uint32_t. It was changed from
+        unsigned int to signed int back in r11492 but I don't think the signedness is needed.
+        (WebCore::Node::ref): Increment the ref count by 2 (upper 31-bit).
+        (WebCore::Node::deref): Implemented the optimization. This is what shrinks the WebCore binary size.
+        (WebCore::Node::hasOneRef const):
+        (WebCore::Node::refCount const): Ignore the lowest bit. Without this fix, the optimization in
+        replaceChildrenWithFragment to avoid replacing the text node is disabled whenever there is a parent.
+        (WebCore::Node::setParentNode): Sets the lowest bit to 1 if the node has a parent and 0 otherwise.
+
</ins><span class="cx"> 2019-03-18  Said Abou-Hallawa  <sabouhallawa@apple.com>
</span><span class="cx"> 
</span><span class="cx">         Remove the SVG property tear off objects for SVGAnimatedBoolean
</span></span></pre></div>
<a id="trunkSourceWebCoredomDocumentcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/dom/Document.cpp (243121 => 243122)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/dom/Document.cpp    2019-03-19 00:39:41 UTC (rev 243121)
+++ trunk/Source/WebCore/dom/Document.cpp       2019-03-19 01:32:04 UTC (rev 243122)
</span><span class="lines">@@ -669,6 +669,10 @@
</span><span class="cx"> {
</span><span class="cx">     ASSERT(!m_deletionHasBegun);
</span><span class="cx">     if (m_referencingNodeCount) {
</span><ins>+        // Node::removedLastRef doesn't set refCount() to zero because it's not observable.
+        // But we need to remember that our refCount reached zero in subsequent calls to decrementReferencingNodeCount()
+        m_refCountAndParentBit = 0;
+
</ins><span class="cx">         // If removing a child removes the last node reference, we don't want the scope to be destroyed
</span><span class="cx">         // until after removeDetachedChildren returns, so we protect ourselves.
</span><span class="cx">         incrementReferencingNodeCount();
</span><span class="lines">@@ -718,7 +722,6 @@
</span><span class="cx">         m_inRemovedLastRefFunction = false;
</span><span class="cx">         m_deletionHasBegun = true;
</span><span class="cx"> #endif
</span><del>-        m_refCount = 1; // Avoid double destruction through use of RefPtr<T>. (This is a security mitigation in case of programmer error. It will ASSERT in debug builds.)
</del><span class="cx">         delete this;
</span><span class="cx">     }
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkSourceWebCoredomDocumenth"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/dom/Document.h (243121 => 243122)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/dom/Document.h      2019-03-19 00:39:41 UTC (rev 243121)
+++ trunk/Source/WebCore/dom/Document.h 2019-03-19 01:32:04 UTC (rev 243122)
</span><span class="lines">@@ -376,7 +376,7 @@
</span><span class="cx"> #if !ASSERT_DISABLED
</span><span class="cx">             m_deletionHasBegun = true;
</span><span class="cx"> #endif
</span><del>-            m_refCount = 1; // Avoid double destruction through use of RefPtr<T>. (This is a security mitigation in case of programmer error. It will ASSERT in debug builds.)
</del><ins>+            m_refCountAndParentBit = s_refCountIncrement; // Avoid double destruction through use of Ref<T>/RefPtr<T>. (This is a security mitigation in case of programmer error. It will ASSERT in debug builds.)
</ins><span class="cx">             delete this;
</span><span class="cx">         }
</span><span class="cx">     }
</span></span></pre></div>
<a id="trunkSourceWebCoredomNodecpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/dom/Node.cpp (243121 => 243122)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/dom/Node.cpp        2019-03-19 00:39:41 UTC (rev 243121)
+++ trunk/Source/WebCore/dom/Node.cpp   2019-03-19 01:32:04 UTC (rev 243122)
</span><span class="lines">@@ -316,8 +316,7 @@
</span><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> Node::Node(Document& document, ConstructionType type)
</span><del>-    : m_refCount(1)
-    , m_nodeFlags(type)
</del><ins>+    : m_nodeFlags(type)
</ins><span class="cx">     , m_treeScope(&document)
</span><span class="cx"> {
</span><span class="cx">     ASSERT(isMainThread());
</span><span class="lines">@@ -332,9 +331,9 @@
</span><span class="cx"> Node::~Node()
</span><span class="cx"> {
</span><span class="cx">     ASSERT(isMainThread());
</span><del>-    // We set m_refCount to 1 before calling delete to avoid double destruction through use of Ref<T>/RefPtr<T>.
</del><ins>+    // We set m_refCount to 2 before calling delete to avoid double destruction through use of Ref<T>/RefPtr<T>.
</ins><span class="cx">     // This is a security mitigation in case of programmer errorm (caught by a debug assertion).
</span><del>-    ASSERT(m_refCount == 1);
</del><ins>+    ASSERT(m_refCountAndParentBit == s_refCountIncrement);
</ins><span class="cx">     ASSERT(m_deletionHasBegun);
</span><span class="cx">     ASSERT(!m_adoptionIsRequired);
</span><span class="cx"> 
</span><span class="lines">@@ -2523,6 +2522,10 @@
</span><span class="cx"> // delete a Node at each deref call site.
</span><span class="cx"> void Node::removedLastRef()
</span><span class="cx"> {
</span><ins>+    // This avoids double destruction even when there is a programming error to use Ref<T> / RefPtr<T> on this node.
+    // There are debug assertions in Node::ref() / Node::deref() to catch such a programming error.
+    ASSERT(m_refCountAndParentBit == s_refCountIncrement);
+
</ins><span class="cx">     // An explicit check for Document here is better than a virtual function since it is
</span><span class="cx">     // faster for non-Document nodes, and because the call to removedLastRef that is inlined
</span><span class="cx">     // at all deref call sites is smaller if it's a non-virtual function.
</span><span class="lines">@@ -2534,7 +2537,6 @@
</span><span class="cx"> #ifndef NDEBUG
</span><span class="cx">     m_deletionHasBegun = true;
</span><span class="cx"> #endif
</span><del>-    m_refCount = 1; // Avoid double destruction through use of RefPtr<T>. (This is a security mitigation in case of programmer error. It will ASSERT in debug builds.)
</del><span class="cx">     delete this;
</span><span class="cx"> }
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkSourceWebCoredomNodeh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/dom/Node.h (243121 => 243122)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/dom/Node.h  2019-03-19 00:39:41 UTC (rev 243121)
+++ trunk/Source/WebCore/dom/Node.h     2019-03-19 01:32:04 UTC (rev 243122)
</span><span class="lines">@@ -500,7 +500,7 @@
</span><span class="cx">     void ref();
</span><span class="cx">     void deref();
</span><span class="cx">     bool hasOneRef() const;
</span><del>-    int refCount() const;
</del><ins>+    unsigned refCount() const;
</ins><span class="cx"> 
</span><span class="cx"> #ifndef NDEBUG
</span><span class="cx">     bool m_deletionHasBegun { false };
</span><span class="lines">@@ -618,6 +618,9 @@
</span><span class="cx">     };
</span><span class="cx">     Node(Document&, ConstructionType);
</span><span class="cx"> 
</span><ins>+    static constexpr uint32_t s_refCountIncrement = 2;
+    static constexpr uint32_t s_refCountMask = ~static_cast<uint32_t>(0x1);
+
</ins><span class="cx">     virtual void addSubresourceAttributeURLs(ListHashSet<URL>&) const { }
</span><span class="cx"> 
</span><span class="cx">     bool hasRareData() const { return getFlag(HasRareDataFlag); }
</span><span class="lines">@@ -664,7 +667,7 @@
</span><span class="cx">     static void moveTreeToNewScope(Node&, TreeScope& oldScope, TreeScope& newScope);
</span><span class="cx">     void moveNodeToNewDocument(Document& oldDocument, Document& newDocument);
</span><span class="cx"> 
</span><del>-    int m_refCount;
</del><ins>+    uint32_t m_refCountAndParentBit { s_refCountIncrement };
</ins><span class="cx">     mutable uint32_t m_nodeFlags;
</span><span class="cx"> 
</span><span class="cx">     ContainerNode* m_parentNode { nullptr };
</span><span class="lines">@@ -695,22 +698,25 @@
</span><span class="cx">     ASSERT(!m_deletionHasBegun);
</span><span class="cx">     ASSERT(!m_inRemovedLastRefFunction);
</span><span class="cx">     ASSERT(!m_adoptionIsRequired);
</span><del>-    ++m_refCount;
</del><ins>+    m_refCountAndParentBit += s_refCountIncrement;
</ins><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> ALWAYS_INLINE void Node::deref()
</span><span class="cx"> {
</span><span class="cx">     ASSERT(isMainThread());
</span><del>-    ASSERT(m_refCount >= 0);
</del><ins>+    ASSERT(refCount());
</ins><span class="cx">     ASSERT(!m_deletionHasBegun);
</span><span class="cx">     ASSERT(!m_inRemovedLastRefFunction);
</span><span class="cx">     ASSERT(!m_adoptionIsRequired);
</span><del>-    if (--m_refCount <= 0 && !parentNode()) {
</del><ins>+    auto tempRefCount = m_refCountAndParentBit - s_refCountIncrement;
+    if (!tempRefCount) {
</ins><span class="cx"> #ifndef NDEBUG
</span><span class="cx">         m_inRemovedLastRefFunction = true;
</span><span class="cx"> #endif
</span><span class="cx">         removedLastRef();
</span><ins>+        return;
</ins><span class="cx">     }
</span><ins>+    m_refCountAndParentBit = tempRefCount;
</ins><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> ALWAYS_INLINE bool Node::hasOneRef() const
</span><span class="lines">@@ -717,12 +723,12 @@
</span><span class="cx"> {
</span><span class="cx">     ASSERT(!m_deletionHasBegun);
</span><span class="cx">     ASSERT(!m_inRemovedLastRefFunction);
</span><del>-    return m_refCount == 1;
</del><ins>+    return refCount() == 1;
</ins><span class="cx"> }
</span><span class="cx"> 
</span><del>-ALWAYS_INLINE int Node::refCount() const
</del><ins>+ALWAYS_INLINE unsigned Node::refCount() const
</ins><span class="cx"> {
</span><del>-    return m_refCount;
</del><ins>+    return m_refCountAndParentBit / s_refCountIncrement;
</ins><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> // Used in Node::addSubresourceAttributeURLs() and in addSubresourceStyleURLs()
</span><span class="lines">@@ -736,6 +742,8 @@
</span><span class="cx"> {
</span><span class="cx">     ASSERT(isMainThread());
</span><span class="cx">     m_parentNode = parent;
</span><ins>+    auto refCountWithoutParentBit = m_refCountAndParentBit & s_refCountMask;
+    m_refCountAndParentBit = refCountWithoutParentBit | !!parent;
</ins><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> inline ContainerNode* Node::parentNode() const
</span></span></pre>
</div>
</div>

</body>
</html>