<!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>[170737] 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/170737">170737</a></dd>
<dt>Author</dt> <dd>barraclough@apple.com</dd>
<dt>Date</dt> <dd>2014-07-02 17:55:37 -0700 (Wed, 02 Jul 2014)</dd>
</dl>

<h3>Log Message</h3>
<pre>ProcessAssertion should also prevent UIApp suspension
https://bugs.webkit.org/show_bug.cgi?id=134563

Reviewed by Dan Bernstein.

If the application suspends then the child processes will, too.
Use beginBackgroundTaskWithName:expirationHandler: to request that the application remain runnable
while waiting for background tasks to complete.

* UIProcess/ProcessAssertion.cpp:
(WebKit::ProcessAssertion::~ProcessAssertion):
    - Added destructor.
* UIProcess/ProcessAssertion.h:
    - Added destructor.
* UIProcess/ios/ProcessAssertionIOS.mm:
(+[WKProcessAssertionBackgroundTaskManager shared]):
    - singleton WKProcessAssertionBackgroundTaskManager.
(-[WKProcessAssertionBackgroundTaskManager init]):
(-[WKProcessAssertionBackgroundTaskManager dealloc]):
    - register/remove notification handlers.
(-[WKProcessAssertionBackgroundTaskManager _updateBackgroundTask]):
    - if we need to be runnable make sure we're holding a BackgroundTask, if not release it.
(-[WKProcessAssertionBackgroundTaskManager _applicationDidEnterBackgroundOrWillEnterForeground:]):
    - detect when the app enters/leaves foreground; calls to _updateBackgroundTask.
(-[WKProcessAssertionBackgroundTaskManager incrementNeedsToRunInBackgroundCount]):
(-[WKProcessAssertionBackgroundTaskManager decrementNeedsToRunInBackgroundCount]):
    - interface to update the count; calls to _updateBackgroundTask.
(WebKit::ProcessAssertion::ProcessAssertion):
(WebKit::ProcessAssertion::~ProcessAssertion):
    - count ProcessAssertions in and out of existance.
(WebKit::ProcessAssertion::setState):
    - count when the state changes.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessProcessAssertioncpp">trunk/Source/WebKit2/UIProcess/ProcessAssertion.cpp</a></li>
<li><a href="#trunkSourceWebKit2UIProcessProcessAssertionh">trunk/Source/WebKit2/UIProcess/ProcessAssertion.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessiosProcessAssertionIOSmm">trunk/Source/WebKit2/UIProcess/ios/ProcessAssertionIOS.mm</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (170736 => 170737)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog        2014-07-02 23:41:08 UTC (rev 170736)
+++ trunk/Source/WebKit2/ChangeLog        2014-07-03 00:55:37 UTC (rev 170737)
</span><span class="lines">@@ -1,3 +1,38 @@
</span><ins>+2014-07-02  Gavin Barraclough  &lt;baraclough@apple.com&gt;
+
+        ProcessAssertion should also prevent UIApp suspension
+        https://bugs.webkit.org/show_bug.cgi?id=134563
+
+        Reviewed by Dan Bernstein.
+
+        If the application suspends then the child processes will, too.
+        Use beginBackgroundTaskWithName:expirationHandler: to request that the application remain runnable
+        while waiting for background tasks to complete.
+
+        * UIProcess/ProcessAssertion.cpp:
+        (WebKit::ProcessAssertion::~ProcessAssertion):
+            - Added destructor.
+        * UIProcess/ProcessAssertion.h:
+            - Added destructor.
+        * UIProcess/ios/ProcessAssertionIOS.mm:
+        (+[WKProcessAssertionBackgroundTaskManager shared]):
+            - singleton WKProcessAssertionBackgroundTaskManager.
+        (-[WKProcessAssertionBackgroundTaskManager init]):
+        (-[WKProcessAssertionBackgroundTaskManager dealloc]):
+            - register/remove notification handlers.
+        (-[WKProcessAssertionBackgroundTaskManager _updateBackgroundTask]):
+            - if we need to be runnable make sure we're holding a BackgroundTask, if not release it.
+        (-[WKProcessAssertionBackgroundTaskManager _applicationDidEnterBackgroundOrWillEnterForeground:]):
+            - detect when the app enters/leaves foreground; calls to _updateBackgroundTask.
+        (-[WKProcessAssertionBackgroundTaskManager incrementNeedsToRunInBackgroundCount]):
+        (-[WKProcessAssertionBackgroundTaskManager decrementNeedsToRunInBackgroundCount]):
+            - interface to update the count; calls to _updateBackgroundTask.
+        (WebKit::ProcessAssertion::ProcessAssertion):
+        (WebKit::ProcessAssertion::~ProcessAssertion):
+            - count ProcessAssertions in and out of existance.
+        (WebKit::ProcessAssertion::setState):
+            - count when the state changes.
+
</ins><span class="cx"> 2014-07-01  Mark Rowe  &lt;mrowe@apple.com&gt;
</span><span class="cx"> 
</span><span class="cx">         &lt;https://webkit.org/b/134522&gt; Remove duplication in code that prepares the user agent string on Mac and iOS
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessProcessAssertioncpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/ProcessAssertion.cpp (170736 => 170737)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/ProcessAssertion.cpp        2014-07-02 23:41:08 UTC (rev 170736)
+++ trunk/Source/WebKit2/UIProcess/ProcessAssertion.cpp        2014-07-03 00:55:37 UTC (rev 170737)
</span><span class="lines">@@ -35,6 +35,10 @@
</span><span class="cx">     m_assertionState = assertionState;
</span><span class="cx"> }
</span><span class="cx"> 
</span><ins>+ProcessAssertion::~ProcessAssertion()
+{
+}
+
</ins><span class="cx"> void ProcessAssertion::setState(AssertionState assertionState)
</span><span class="cx"> {
</span><span class="cx">     if (m_assertionState == assertionState)
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessProcessAssertionh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/ProcessAssertion.h (170736 => 170737)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/ProcessAssertion.h        2014-07-02 23:41:08 UTC (rev 170736)
+++ trunk/Source/WebKit2/UIProcess/ProcessAssertion.h        2014-07-03 00:55:37 UTC (rev 170737)
</span><span class="lines">@@ -42,6 +42,7 @@
</span><span class="cx"> class ProcessAssertion {
</span><span class="cx"> public:
</span><span class="cx">     ProcessAssertion(pid_t, AssertionState);
</span><ins>+    ~ProcessAssertion();
</ins><span class="cx">     
</span><span class="cx">     AssertionState state() const { return m_assertionState; }
</span><span class="cx">     
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessiosProcessAssertionIOSmm"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/ios/ProcessAssertionIOS.mm (170736 => 170737)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/ios/ProcessAssertionIOS.mm        2014-07-02 23:41:08 UTC (rev 170736)
+++ trunk/Source/WebKit2/UIProcess/ios/ProcessAssertionIOS.mm        2014-07-03 00:55:37 UTC (rev 170737)
</span><span class="lines">@@ -29,10 +29,100 @@
</span><span class="cx"> #if PLATFORM(IOS)
</span><span class="cx"> 
</span><span class="cx"> #import &lt;AssertionServices/BKSProcessAssertion.h&gt;
</span><ins>+#import &lt;UIKit/UIApplication.h&gt;
</ins><span class="cx"> 
</span><ins>+#if !PLATFORM(IOS_SIMULATOR)
+
+@interface WKProcessAssertionBackgroundTaskManager : NSObject
+
++ (WKProcessAssertionBackgroundTaskManager *)shared;
+
+- (void)incrementNeedsToRunInBackgroundCount;
+- (void)decrementNeedsToRunInBackgroundCount;
+
+@end
+
+@implementation WKProcessAssertionBackgroundTaskManager
+{
+    unsigned _needsToRunInBackgroundCount;
+    BOOL _appIsBackground;
+    UIBackgroundTaskIdentifier _backgroundTask;
+}
+
++ (WKProcessAssertionBackgroundTaskManager *)shared
+{
+    static WKProcessAssertionBackgroundTaskManager *shared = [WKProcessAssertionBackgroundTaskManager new];
+    return shared;
+}
+
+- (instancetype)init
+{
+    self = [super init];
+    if (!self)
+        return nil;
+
+    _appIsBackground = [UIApplication sharedApplication].applicationState == UIApplicationStateBackground;
+    _backgroundTask = UIBackgroundTaskInvalid;
+
+    NSNotificationCenter *center = [NSNotificationCenter defaultCenter];
+    [center addObserver:self selector:@selector(_applicationDidEnterBackgroundOrWillEnterForeground:) name:UIApplicationWillEnterForegroundNotification object:nil];
+    [center addObserver:self selector:@selector(_applicationDidEnterBackgroundOrWillEnterForeground:) name:UIApplicationDidEnterBackgroundNotification object:nil];
+
+    return self;
+}
+
+- (void)dealloc
+{
+    NSNotificationCenter *center = [NSNotificationCenter defaultCenter];
+    [center removeObserver:self name:UIApplicationWillEnterForegroundNotification object:nil];
+    [center removeObserver:self name:UIApplicationDidEnterBackgroundNotification object:nil];
+
+    if (_backgroundTask != UIBackgroundTaskInvalid)
+        [[UIApplication sharedApplication] endBackgroundTask:_backgroundTask];
+
+    [super dealloc];
+}
+
+- (void)_updateBackgroundTask
+{
+    bool shouldHoldTask = _needsToRunInBackgroundCount &amp;&amp; _appIsBackground;
+
+    if (shouldHoldTask &amp;&amp; _backgroundTask == UIBackgroundTaskInvalid) {
+        __block UIBackgroundTaskIdentifier task = [[UIApplication sharedApplication] beginBackgroundTaskWithName:@&quot;com.apple.WebKit.ProcessAssertion&quot; expirationHandler:^{
+            NSLog(@&quot;Background task expired while holding WebKit ProcessAssertion.&quot;);
+            [[UIApplication sharedApplication] endBackgroundTask:task];
+        }];
+        _backgroundTask = task;
+    }
+
+    if (!shouldHoldTask &amp;&amp; _backgroundTask != UIBackgroundTaskInvalid) {
+        [[UIApplication sharedApplication] endBackgroundTask:_backgroundTask];
+        _backgroundTask = UIBackgroundTaskInvalid;
+    }
+}
+
+- (void)_applicationDidEnterBackgroundOrWillEnterForeground:(NSNotification *)notification
+{
+    _appIsBackground = [UIApplication sharedApplication].applicationState == UIApplicationStateBackground;
+    [self _updateBackgroundTask];
+}
+
+- (void)incrementNeedsToRunInBackgroundCount
+{
+    ++_needsToRunInBackgroundCount;
+    [self _updateBackgroundTask];
+}
+
+- (void)decrementNeedsToRunInBackgroundCount
+{
+    --_needsToRunInBackgroundCount;
+    [self _updateBackgroundTask];
+}
+
+@end
+
</ins><span class="cx"> namespace WebKit {
</span><span class="cx"> 
</span><del>-#if !PLATFORM(IOS_SIMULATOR)
</del><span class="cx"> const BKSProcessAssertionFlags suspendedTabFlags = (BKSProcessAssertionAllowIdleSleep);
</span><span class="cx"> const BKSProcessAssertionFlags backgroundTabFlags = (BKSProcessAssertionAllowIdleSleep | BKSProcessAssertionPreventTaskSuspend | BKSProcessAssertionAllowSuspendOnSleep);
</span><span class="cx"> const BKSProcessAssertionFlags foregroundTabFlags = (BKSProcessAssertionAllowIdleSleep | BKSProcessAssertionPreventTaskSuspend | BKSProcessAssertionAllowSuspendOnSleep | BKSProcessAssertionWantsForegroundResourcePriority | BKSProcessAssertionPreventTaskThrottleDown);
</span><span class="lines">@@ -48,15 +138,11 @@
</span><span class="cx">         return foregroundTabFlags;
</span><span class="cx">     }
</span><span class="cx"> }
</span><del>-#endif
</del><span class="cx"> 
</span><span class="cx"> ProcessAssertion::ProcessAssertion(pid_t pid, AssertionState assertionState)
</span><span class="cx"> {
</span><span class="cx">     m_assertionState = assertionState;
</span><span class="cx">     
</span><del>-#if PLATFORM(IOS_SIMULATOR)
-    UNUSED_PARAM(pid);
-#else
</del><span class="cx">     BKSProcessAssertionAcquisitionHandler handler = ^(BOOL acquired) {
</span><span class="cx">         if (!acquired) {
</span><span class="cx">             LOG_ERROR(&quot;Unable to acquire assertion for process %d&quot;, pid);
</span><span class="lines">@@ -64,20 +150,53 @@
</span><span class="cx">         }
</span><span class="cx">     };
</span><span class="cx">     m_assertion = adoptNS([[BKSProcessAssertion alloc] initWithPID:pid flags:flagsForState(assertionState) reason:BKSProcessAssertionReasonExtension name:@&quot;Web content visible&quot; withHandler:handler]);
</span><del>-#endif
</del><ins>+
+    if (m_assertionState != AssertionState::Suspended)
+        [[WKProcessAssertionBackgroundTaskManager shared] incrementNeedsToRunInBackgroundCount];
</ins><span class="cx"> }
</span><span class="cx"> 
</span><ins>+ProcessAssertion::~ProcessAssertion()
+{
+    if (m_assertionState != AssertionState::Suspended)
+        [[WKProcessAssertionBackgroundTaskManager shared] decrementNeedsToRunInBackgroundCount];
+}
+
</ins><span class="cx"> void ProcessAssertion::setState(AssertionState assertionState)
</span><span class="cx"> {
</span><span class="cx">     if (m_assertionState == assertionState)
</span><span class="cx">         return;
</span><span class="cx"> 
</span><ins>+    if ((m_assertionState != AssertionState::Suspended) &amp;&amp; (assertionState == AssertionState::Suspended))
+        [[WKProcessAssertionBackgroundTaskManager shared] decrementNeedsToRunInBackgroundCount];
+    if ((m_assertionState == AssertionState::Suspended) &amp;&amp; (assertionState != AssertionState::Suspended))
+        [[WKProcessAssertionBackgroundTaskManager shared] incrementNeedsToRunInBackgroundCount];
+
</ins><span class="cx">     m_assertionState = assertionState;
</span><del>-#if !PLATFORM(IOS_SIMULATOR)
</del><span class="cx">     [m_assertion setFlags:flagsForState(assertionState)];
</span><del>-#endif
</del><span class="cx"> }
</span><del>-    
</del><ins>+
+} // namespace WebKit
+
+#else // PLATFORM(IOS_SIMULATOR)
+
+namespace WebKit {
+
+ProcessAssertion::ProcessAssertion(pid_t, AssertionState assertionState)
+{
+    m_assertionState = assertionState;
</ins><span class="cx"> }
</span><span class="cx"> 
</span><ins>+ProcessAssertion::~ProcessAssertion()
+{
+}
+
+void ProcessAssertion::setState(AssertionState assertionState)
+{
+    m_assertionState = assertionState;
+}
+
+} // namespace WebKit
+
+#endif // PLATFORM(IOS_SIMULATOR)
+
</ins><span class="cx"> #endif // PLATFORM(IOS)
</span></span></pre>
</div>
</div>

</body>
</html>