<!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>[184774] trunk/Source/WebKit2</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/184774">184774</a></dd>
<dt>Author</dt> <dd>barraclough@apple.com</dd>
<dt>Date</dt> <dd>2015-05-22 10:19:39 -0700 (Fri, 22 May 2015)</dd>
</dl>

<h3>Log Message</h3>
<pre>Networking process sometimes suspended while WebContent runnable
https://bugs.webkit.org/show_bug.cgi?id=145291
&lt;rdar://problem/21033029&gt;

Reviewed by Andreas Kling.

There is an asymmetry in how the Networking process suspension is managed.
We drop the assertion (&amp; suspend the process) whenever the WebProcess says
it is ready to suspend, but we only take the assertion (&amp; resume execution)
when the WebContent process is actually resumed. This leaves a race – where
the WebContent process was willing to be suspended, but the UI app changed
its mind suspending it. Since the WebContent process never actually suspended
(we only prepared it to), we never send a resume, and since we never resume,
we never wake the Networking process.

The fix is pretty clean. A web process should take a token on the networking
process precisely whenever it holds an assertion on the web content process.
This also enables a nice refinement, that when holding a BG assertion on the
WebContent process we only need to hold a BG assertion on the networking
process.

* UIProcess/Network/NetworkProcessProxy.cpp:
(WebKit::NetworkProcessProxy::didSetAssertionState):
    - no-op
* UIProcess/Network/NetworkProcessProxy.h:
    - added didSetAssertionState.
* UIProcess/ProcessThrottler.cpp:
(WebKit::ProcessThrottler::updateAssertionNow):
(WebKit::ProcessThrottler::updateAssertion):
(WebKit::ProcessThrottler::didConnectToProcess):
    - whenever taking/updating the assertion, inform the client via didSetAssertionState.
* UIProcess/ProcessThrottlerClient.h:
    - added didSetAssertionState.
* UIProcess/WebProcessProxy.cpp:
(WebKit::WebProcessProxy::didFinishLaunching):
    removed initializeNetworkProcessActivityToken - this is taken via ProcessThrottler::didConnectToProcess.
(WebKit::WebProcessProxy::sendProcessDidResume):
    - removed call to initializeNetworkProcessActivityToken - updated via didSetAssertionState.
(WebKit::WebProcessProxy::processReadyToSuspend):
    - removed update of m_tokenForNetworkProcess - updated via didSetAssertionState.
(WebKit::WebProcessProxy::didSetAssertionState):
    - update m_backgroundTokenForNetworkProcess/m_foregroundTokenForNetworkProcess.
(WebKit::WebProcessProxy::initializeNetworkProcessActivityToken): Deleted.
    - updated via didSetAssertionState.
* UIProcess/WebProcessProxy.h:
    - added didSetAssertionState, added separate FG/BG activity tokens for Networking process.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessNetworkNetworkProcessProxycpp">trunk/Source/WebKit2/UIProcess/Network/NetworkProcessProxy.cpp</a></li>
<li><a href="#trunkSourceWebKit2UIProcessNetworkNetworkProcessProxyh">trunk/Source/WebKit2/UIProcess/Network/NetworkProcessProxy.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessProcessThrottlercpp">trunk/Source/WebKit2/UIProcess/ProcessThrottler.cpp</a></li>
<li><a href="#trunkSourceWebKit2UIProcessProcessThrottlerClienth">trunk/Source/WebKit2/UIProcess/ProcessThrottlerClient.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessWebProcessProxycpp">trunk/Source/WebKit2/UIProcess/WebProcessProxy.cpp</a></li>
<li><a href="#trunkSourceWebKit2UIProcessWebProcessProxyh">trunk/Source/WebKit2/UIProcess/WebProcessProxy.h</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (184773 => 184774)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog        2015-05-22 17:09:12 UTC (rev 184773)
+++ trunk/Source/WebKit2/ChangeLog        2015-05-22 17:19:39 UTC (rev 184774)
</span><span class="lines">@@ -1,3 +1,52 @@
</span><ins>+2015-05-21  Gavin Barraclough  &lt;barraclough@apple.com&gt;
+
+        Networking process sometimes suspended while WebContent runnable
+        https://bugs.webkit.org/show_bug.cgi?id=145291
+        &lt;rdar://problem/21033029&gt;
+
+        Reviewed by Andreas Kling.
+
+        There is an asymmetry in how the Networking process suspension is managed.
+        We drop the assertion (&amp; suspend the process) whenever the WebProcess says
+        it is ready to suspend, but we only take the assertion (&amp; resume execution)
+        when the WebContent process is actually resumed. This leaves a race – where
+        the WebContent process was willing to be suspended, but the UI app changed
+        its mind suspending it. Since the WebContent process never actually suspended
+        (we only prepared it to), we never send a resume, and since we never resume,
+        we never wake the Networking process.
+
+        The fix is pretty clean. A web process should take a token on the networking
+        process precisely whenever it holds an assertion on the web content process.
+        This also enables a nice refinement, that when holding a BG assertion on the
+        WebContent process we only need to hold a BG assertion on the networking
+        process.
+
+        * UIProcess/Network/NetworkProcessProxy.cpp:
+        (WebKit::NetworkProcessProxy::didSetAssertionState):
+            - no-op
+        * UIProcess/Network/NetworkProcessProxy.h:
+            - added didSetAssertionState.
+        * UIProcess/ProcessThrottler.cpp:
+        (WebKit::ProcessThrottler::updateAssertionNow):
+        (WebKit::ProcessThrottler::updateAssertion):
+        (WebKit::ProcessThrottler::didConnectToProcess):
+            - whenever taking/updating the assertion, inform the client via didSetAssertionState.
+        * UIProcess/ProcessThrottlerClient.h:
+            - added didSetAssertionState.
+        * UIProcess/WebProcessProxy.cpp:
+        (WebKit::WebProcessProxy::didFinishLaunching):
+            removed initializeNetworkProcessActivityToken - this is taken via ProcessThrottler::didConnectToProcess.
+        (WebKit::WebProcessProxy::sendProcessDidResume):
+            - removed call to initializeNetworkProcessActivityToken - updated via didSetAssertionState.
+        (WebKit::WebProcessProxy::processReadyToSuspend):
+            - removed update of m_tokenForNetworkProcess - updated via didSetAssertionState.
+        (WebKit::WebProcessProxy::didSetAssertionState):
+            - update m_backgroundTokenForNetworkProcess/m_foregroundTokenForNetworkProcess.
+        (WebKit::WebProcessProxy::initializeNetworkProcessActivityToken): Deleted.
+            - updated via didSetAssertionState.
+        * UIProcess/WebProcessProxy.h:
+            - added didSetAssertionState, added separate FG/BG activity tokens for Networking process.
+
</ins><span class="cx"> 2015-05-22  Dan Bernstein  &lt;mitz@apple.com&gt;
</span><span class="cx"> 
</span><span class="cx">         Fixed the fix for &lt;rdar://problem/20830673&gt; Symlink the WebKit dylib instead of just the framework directory
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessNetworkNetworkProcessProxycpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/Network/NetworkProcessProxy.cpp (184773 => 184774)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/Network/NetworkProcessProxy.cpp        2015-05-22 17:09:12 UTC (rev 184773)
+++ trunk/Source/WebKit2/UIProcess/Network/NetworkProcessProxy.cpp        2015-05-22 17:19:39 UTC (rev 184774)
</span><span class="lines">@@ -356,6 +356,10 @@
</span><span class="cx">     m_throttler.processReadyToSuspend();
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+void NetworkProcessProxy::didSetAssertionState(AssertionState)
+{
+}
+    
</ins><span class="cx"> void NetworkProcessProxy::setIsHoldingLockedFiles(bool isHoldingLockedFiles)
</span><span class="cx"> {
</span><span class="cx">     if (!isHoldingLockedFiles) {
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessNetworkNetworkProcessProxyh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/Network/NetworkProcessProxy.h (184773 => 184774)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/Network/NetworkProcessProxy.h        2015-05-22 17:09:12 UTC (rev 184773)
+++ trunk/Source/WebKit2/UIProcess/Network/NetworkProcessProxy.h        2015-05-22 17:19:39 UTC (rev 184774)
</span><span class="lines">@@ -92,6 +92,7 @@
</span><span class="cx">     void sendPrepareToSuspend() override;
</span><span class="cx">     void sendCancelPrepareToSuspend() override;
</span><span class="cx">     void sendProcessDidResume() override;
</span><ins>+    void didSetAssertionState(AssertionState) override;
</ins><span class="cx"> 
</span><span class="cx">     // IPC::Connection::Client
</span><span class="cx">     virtual void didReceiveMessage(IPC::Connection&amp;, IPC::MessageDecoder&amp;) override;
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessProcessThrottlercpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/ProcessThrottler.cpp (184773 => 184774)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/ProcessThrottler.cpp        2015-05-22 17:09:12 UTC (rev 184773)
+++ trunk/Source/WebKit2/UIProcess/ProcessThrottler.cpp        2015-05-22 17:19:39 UTC (rev 184774)
</span><span class="lines">@@ -55,8 +55,10 @@
</span><span class="cx"> void ProcessThrottler::updateAssertionNow()
</span><span class="cx"> {
</span><span class="cx">     m_suspendTimer.stop();
</span><del>-    if (m_assertion)
</del><ins>+    if (m_assertion) {
</ins><span class="cx">         m_assertion-&gt;setState(assertionState());
</span><ins>+        m_process.didSetAssertionState(assertionState());
+    }
</ins><span class="cx"> }
</span><span class="cx">     
</span><span class="cx"> void ProcessThrottler::updateAssertion()
</span><span class="lines">@@ -69,6 +71,7 @@
</span><span class="cx">         m_process.sendPrepareToSuspend();
</span><span class="cx">         m_suspendTimer.startOneShot(processSuspensionTimeout);
</span><span class="cx">         m_assertion-&gt;setState(AssertionState::Background);
</span><ins>+        m_process.didSetAssertionState(AssertionState::Background);
</ins><span class="cx">         return;
</span><span class="cx">     }
</span><span class="cx">     
</span><span class="lines">@@ -88,6 +91,7 @@
</span><span class="cx"> {
</span><span class="cx">     m_suspendTimer.stop();
</span><span class="cx">     m_assertion = std::make_unique&lt;ProcessAndUIAssertion&gt;(pid, assertionState());
</span><ins>+    m_process.didSetAssertionState(assertionState());
</ins><span class="cx">     m_assertion-&gt;setClient(*this);
</span><span class="cx"> }
</span><span class="cx">     
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessProcessThrottlerClienth"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/ProcessThrottlerClient.h (184773 => 184774)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/ProcessThrottlerClient.h        2015-05-22 17:09:12 UTC (rev 184773)
+++ trunk/Source/WebKit2/UIProcess/ProcessThrottlerClient.h        2015-05-22 17:19:39 UTC (rev 184774)
</span><span class="lines">@@ -26,6 +26,8 @@
</span><span class="cx"> #ifndef ProcessThrottlerClient_h
</span><span class="cx"> #define ProcessThrottlerClient_h
</span><span class="cx"> 
</span><ins>+#include &quot;ProcessAssertion.h&quot;
+
</ins><span class="cx"> namespace WebKit {
</span><span class="cx"> 
</span><span class="cx"> class ProcessThrottlerClient {
</span><span class="lines">@@ -36,6 +38,8 @@
</span><span class="cx">     virtual void sendPrepareToSuspend() = 0;
</span><span class="cx">     virtual void sendCancelPrepareToSuspend() = 0;
</span><span class="cx">     virtual void sendProcessDidResume() = 0;
</span><ins>+
+    virtual void didSetAssertionState(AssertionState) = 0;
</ins><span class="cx"> };
</span><span class="cx"> 
</span><span class="cx"> } // namespace WebKit
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessWebProcessProxycpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/WebProcessProxy.cpp (184773 => 184774)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/WebProcessProxy.cpp        2015-05-22 17:09:12 UTC (rev 184773)
+++ trunk/Source/WebKit2/UIProcess/WebProcessProxy.cpp        2015-05-22 17:19:39 UTC (rev 184774)
</span><span class="lines">@@ -580,8 +580,6 @@
</span><span class="cx">     ASSERT(xpcConnection);
</span><span class="cx">     m_throttler.didConnectToProcess(xpc_connection_get_pid(xpcConnection));
</span><span class="cx"> #endif
</span><del>-
-    initializeNetworkProcessActivityToken();
</del><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> WebFrameProxy* WebProcessProxy::webFrame(uint64_t frameID) const
</span><span class="lines">@@ -901,28 +899,15 @@
</span><span class="cx">         send(Messages::WebProcess::CancelPrepareToSuspend(), 0);
</span><span class="cx"> }
</span><span class="cx"> 
</span><del>-void WebProcessProxy::initializeNetworkProcessActivityToken()
-{
-#if PLATFORM(IOS) &amp;&amp; ENABLE(NETWORK_PROCESS)
-    if (processPool().usesNetworkProcess())
-        m_tokenForNetworkProcess = processPool().ensureNetworkProcess().throttler().foregroundActivityToken();
-#endif
-}
-
</del><span class="cx"> void WebProcessProxy::sendProcessDidResume()
</span><span class="cx"> {
</span><del>-    initializeNetworkProcessActivityToken();
-
</del><span class="cx">     if (canSendMessage())
</span><span class="cx">         send(Messages::WebProcess::ProcessDidResume(), 0);
</span><span class="cx"> }
</span><del>-    
</del><ins>+
</ins><span class="cx"> void WebProcessProxy::processReadyToSuspend()
</span><span class="cx"> {
</span><span class="cx">     m_throttler.processReadyToSuspend();
</span><del>-#if PLATFORM(IOS) &amp;&amp; ENABLE(NETWORK_PROCESS)
-    m_tokenForNetworkProcess = nullptr;
-#endif
</del><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> void WebProcessProxy::didCancelProcessSuspension()
</span><span class="lines">@@ -930,6 +915,32 @@
</span><span class="cx">     m_throttler.didCancelProcessSuspension();
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+void WebProcessProxy::didSetAssertionState(AssertionState state)
+{
+#if PLATFORM(IOS) &amp;&amp; ENABLE(NETWORK_PROCESS)
+    switch (state) {
+    case AssertionState::Suspended:
+        m_foregroundTokenForNetworkProcess = nullptr;
+        m_backgroundTokenForNetworkProcess = nullptr;
+        break;
+
+    case AssertionState::Background:
+        if (processPool().usesNetworkProcess())
+            m_backgroundTokenForNetworkProcess = processPool().ensureNetworkProcess().throttler().backgroundActivityToken();
+        m_foregroundTokenForNetworkProcess = nullptr;
+        break;
+    
+    case AssertionState::Foreground:
+        if (processPool().usesNetworkProcess())
+            m_foregroundTokenForNetworkProcess = processPool().ensureNetworkProcess().throttler().foregroundActivityToken();
+        m_backgroundTokenForNetworkProcess = nullptr;
+        break;
+    }
+#else
+    UNUSED_PARAM(state);
+#endif
+}
+    
</ins><span class="cx"> void WebProcessProxy::setIsHoldingLockedFiles(bool isHoldingLockedFiles)
</span><span class="cx"> {
</span><span class="cx">     if (!isHoldingLockedFiles) {
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessWebProcessProxyh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/WebProcessProxy.h (184773 => 184774)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/WebProcessProxy.h        2015-05-22 17:09:12 UTC (rev 184773)
+++ trunk/Source/WebKit2/UIProcess/WebProcessProxy.h        2015-05-22 17:19:39 UTC (rev 184774)
</span><span class="lines">@@ -210,6 +210,7 @@
</span><span class="cx">     void sendPrepareToSuspend() override;
</span><span class="cx">     void sendCancelPrepareToSuspend() override;
</span><span class="cx">     void sendProcessDidResume() override;
</span><ins>+    void didSetAssertionState(AssertionState) override;
</ins><span class="cx"> 
</span><span class="cx">     // ProcessLauncher::Client
</span><span class="cx">     virtual void didFinishLaunching(ProcessLauncher*, IPC::Connection::Identifier) override;
</span><span class="lines">@@ -220,8 +221,6 @@
</span><span class="cx"> 
</span><span class="cx">     bool canTerminateChildProcess();
</span><span class="cx"> 
</span><del>-    void initializeNetworkProcessActivityToken();
-
</del><span class="cx">     ResponsivenessTimer m_responsivenessTimer;
</span><span class="cx">     
</span><span class="cx">     RefPtr&lt;WebConnectionToWebProcess&gt; m_webConnection;
</span><span class="lines">@@ -248,7 +247,8 @@
</span><span class="cx">     ProcessThrottler m_throttler;
</span><span class="cx">     ProcessThrottler::BackgroundActivityToken m_tokenForHoldingLockedFiles;
</span><span class="cx"> #if PLATFORM(IOS) &amp;&amp; ENABLE(NETWORK_PROCESS)
</span><del>-    ProcessThrottler::ForegroundActivityToken m_tokenForNetworkProcess;
</del><ins>+    ProcessThrottler::ForegroundActivityToken m_foregroundTokenForNetworkProcess;
+    ProcessThrottler::BackgroundActivityToken m_backgroundTokenForNetworkProcess;
</ins><span class="cx"> #endif
</span><span class="cx"> 
</span><span class="cx">     HashMap&lt;String, uint64_t&gt; m_pageURLRetainCountMap;
</span></span></pre>
</div>
</div>

</body>
</html>