haikuwebkit/Source/WTF/wtf/SuspendableWorkQueue.h

67 lines
2.7 KiB
C
Raw Permalink Normal View History

Suspend WorkQueue of ResourceLoadStatistics and LocalStorage sooner https://bugs.webkit.org/show_bug.cgi?id=228748 <rdar://problem/81626714> Reviewed by Chris Dumez. Source/WebKit: When suspending ResourceLoadStatistics and LocalStorage, we dispatched a suspend task, which waits on a condition, to their WorkQueue. That means the queue will be suspended after completing all tasks scheduled before the suspend task. These tasks may take a long time to complete and assertion may be timed out. When network process receives PrepareToSuspend message, we want the queues to suspend as soon as possible. To achieve that, now we check if the queue needs to be suspended before each task, which ensures the queue execute as most one task after suspend(). * NetworkProcess/Classifier/ResourceLoadStatisticsDatabaseStore.cpp: (WebKit::ResourceLoadStatisticsDatabaseStore::ResourceLoadStatisticsDatabaseStore): * NetworkProcess/Classifier/ResourceLoadStatisticsDatabaseStore.h: * NetworkProcess/Classifier/ResourceLoadStatisticsMemoryStore.cpp: (WebKit::ResourceLoadStatisticsMemoryStore::ResourceLoadStatisticsMemoryStore): * NetworkProcess/Classifier/ResourceLoadStatisticsMemoryStore.h: * NetworkProcess/Classifier/ResourceLoadStatisticsStore.cpp: (WebKit::ResourceLoadStatisticsStore::ResourceLoadStatisticsStore): * NetworkProcess/Classifier/ResourceLoadStatisticsStore.h: (WebKit::ResourceLoadStatisticsStore::workQueue): * NetworkProcess/Classifier/WebResourceLoadStatisticsStore.cpp: (WebKit::sharedStatisticsQueue): (WebKit::WebResourceLoadStatisticsStore::suspend): (WebKit::WebResourceLoadStatisticsStore::resume): (WebKit::WTF_GUARDED_BY_LOCK): Deleted. * NetworkProcess/Classifier/WebResourceLoadStatisticsStore.h: * NetworkProcess/WebStorage/LocalStorageDatabase.cpp: (WebKit::LocalStorageDatabase::create): (WebKit::LocalStorageDatabase::LocalStorageDatabase): * NetworkProcess/WebStorage/LocalStorageDatabase.h: * NetworkProcess/WebStorage/LocalStorageNamespace.cpp: (WebKit::LocalStorageNamespace::getOrCreateStorageArea): * NetworkProcess/WebStorage/LocalStorageNamespace.h: * NetworkProcess/WebStorage/SessionStorageNamespace.cpp: (WebKit::SessionStorageNamespace::getOrCreateStorageArea): * NetworkProcess/WebStorage/SessionStorageNamespace.h: * NetworkProcess/WebStorage/StorageArea.cpp: (WebKit::StorageArea::StorageArea): * NetworkProcess/WebStorage/StorageArea.h: * NetworkProcess/WebStorage/StorageManager.cpp: (WebKit::StorageManager::createLocalStorageArea): (WebKit::StorageManager::createTransientLocalStorageArea): (WebKit::StorageManager::createSessionStorageArea): * NetworkProcess/WebStorage/StorageManager.h: * NetworkProcess/WebStorage/StorageManagerSet.cpp: (WebKit::StorageManagerSet::StorageManagerSet): (WebKit::StorageManagerSet::suspend): (WebKit::StorageManagerSet::resume): * NetworkProcess/WebStorage/StorageManagerSet.h: (WebKit::StorageManagerSet::WTF_GUARDED_BY_LOCK): Deleted. * NetworkProcess/WebStorage/TransientLocalStorageNamespace.cpp: (WebKit::TransientLocalStorageNamespace::getOrCreateStorageArea): * NetworkProcess/WebStorage/TransientLocalStorageNamespace.h: Source/WTF: Add SuspendableWorkQueue that would perform suspend check before each task. * WTF.xcodeproj/project.pbxproj: * wtf/CMakeLists.txt: * wtf/Forward.h: * wtf/SuspendableWorkQueue.cpp: Added. (WTF::SuspendableWorkQueue::create): (WTF::SuspendableWorkQueue::SuspendableWorkQueue): (WTF::SuspendableWorkQueue::suspend): (WTF::SuspendableWorkQueue::resume): (WTF::SuspendableWorkQueue::dispatch): (WTF::SuspendableWorkQueue::dispatchAfter): (WTF::SuspendableWorkQueue::dispatchSync): (WTF::SuspendableWorkQueue::invokeAllSuspensionCompletionHandlers): (WTF::SuspendableWorkQueue::suspendIfNeeded): * wtf/SuspendableWorkQueue.h: Added. * wtf/WorkQueue.h: (): Deleted. Canonical link: https://commits.webkit.org/240451@main git-svn-id: https://svn.webkit.org/repository/webkit/trunk@280934 268f45cc-cd09-0410-ab3c-d52691b4dbfc
2021-08-11 22:25:56 +00:00
/*
* Copyright (C) 2021 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <wtf/CompletionHandler.h>
#include <wtf/Condition.h>
#include <wtf/Deque.h>
#include <wtf/Lock.h>
#include <wtf/WorkQueue.h>
namespace WTF {
class SuspendableWorkQueue final : public WorkQueue {
public:
using QOS = WorkQueue::QOS;
WTF_EXPORT_PRIVATE static Ref<SuspendableWorkQueue> create(const char* name, QOS = QOS::Default);
WTF_EXPORT_PRIVATE void suspend(Function<void()>&& suspendFunction, CompletionHandler<void()>&& suspensionCompletionHandler);
WTF_EXPORT_PRIVATE void resume();
WTF_EXPORT_PRIVATE void dispatch(Function<void()>&&) final;
WTF_EXPORT_PRIVATE void dispatchAfter(Seconds, Function<void()>&&) final;
WTF_EXPORT_PRIVATE void dispatchSync(Function<void()>&&) final;
private:
SuspendableWorkQueue(const char* name, QOS);
void invokeAllSuspensionCompletionHandlers() WTF_REQUIRES_LOCK(m_suspensionLock);
void suspendIfNeeded();
#if USE(COCOA_EVENT_LOOP)
using WorkQueue::dispatchQueue;
#else
using WorkQueue::runLoop;
#endif
Lock m_suspensionLock;
Condition m_suspensionCondition;
bool m_isOrWillBeSuspended WTF_GUARDED_BY_LOCK(m_suspensionLock) { false };
Function<void()> m_suspendFunction WTF_GUARDED_BY_LOCK(m_suspensionLock);
Vector<CompletionHandler<void()>> m_suspensionCompletionHandlers WTF_GUARDED_BY_LOCK(m_suspensionLock);
};
} // namespace WTF
using WTF::SuspendableWorkQueue;