From 36d22d82aa202bb199967e9512281e9a53db42c9 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 21:33:14 +0200 Subject: Adding upstream version 115.7.0esr. Signed-off-by: Daniel Baumann --- dom/workers/WorkerRef.cpp | 245 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 245 insertions(+) create mode 100644 dom/workers/WorkerRef.cpp (limited to 'dom/workers/WorkerRef.cpp') diff --git a/dom/workers/WorkerRef.cpp b/dom/workers/WorkerRef.cpp new file mode 100644 index 0000000000..9fcf329495 --- /dev/null +++ b/dom/workers/WorkerRef.cpp @@ -0,0 +1,245 @@ +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=8 sts=2 et sw=2 tw=80: */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#include "mozilla/dom/WorkerRef.h" + +#include "nsDebug.h" +#include "WorkerRunnable.h" +#include "WorkerPrivate.h" + +namespace mozilla::dom { + +namespace { + +// This runnable is used to release the StrongWorkerRef on the worker thread +// when a ThreadSafeWorkerRef is released. +class ReleaseRefControlRunnable final : public WorkerControlRunnable { + public: + ReleaseRefControlRunnable(WorkerPrivate* aWorkerPrivate, + already_AddRefed aRef) + : WorkerControlRunnable(aWorkerPrivate, WorkerThreadUnchangedBusyCount), + mRef(std::move(aRef)) { + MOZ_ASSERT(mRef); + } + + bool PreDispatch(WorkerPrivate* aWorkerPrivate) override { return true; } + + void PostDispatch(WorkerPrivate* aWorkerPrivate, + bool aDispatchResult) override {} + + bool WorkerRun(JSContext* aCx, WorkerPrivate* aWorkerPrivate) override { + mRef = nullptr; + return true; + } + + private: + RefPtr mRef; +}; + +} // namespace + +// ---------------------------------------------------------------------------- +// WorkerRef + +WorkerRef::WorkerRef(WorkerPrivate* aWorkerPrivate, const char* aName, + bool aIsPreventingShutdown) + : mWorkerPrivate(aWorkerPrivate), + mName(aName), + mIsPreventingShutdown(aIsPreventingShutdown), + mHolding(false) { + MOZ_ASSERT(aWorkerPrivate); + MOZ_ASSERT(aName); + + aWorkerPrivate->AssertIsOnWorkerThread(); +} + +WorkerRef::~WorkerRef() { + NS_ASSERT_OWNINGTHREAD(WorkerRef); + ReleaseWorker(); +} + +void WorkerRef::ReleaseWorker() { + if (mHolding) { + MOZ_ASSERT(mWorkerPrivate); + + mWorkerPrivate->RemoveWorkerRef(this); + mWorkerPrivate = nullptr; + + mHolding = false; + } +} + +bool WorkerRef::HoldWorker(WorkerStatus aStatus) { + MOZ_ASSERT(mWorkerPrivate); + MOZ_ASSERT(!mHolding); + + if (NS_WARN_IF(!mWorkerPrivate->AddWorkerRef(this, aStatus))) { + return false; + } + + mHolding = true; + return true; +} + +void WorkerRef::Notify() { + NS_ASSERT_OWNINGTHREAD(WorkerRef); + + if (!mCallback) { + return; + } + + MoveOnlyFunction callback = std::move(mCallback); + MOZ_ASSERT(!mCallback); + + callback(); +} + +// ---------------------------------------------------------------------------- +// WeakWorkerRef + +/* static */ +already_AddRefed WeakWorkerRef::Create( + WorkerPrivate* aWorkerPrivate, MoveOnlyFunction&& aCallback) { + MOZ_ASSERT(aWorkerPrivate); + aWorkerPrivate->AssertIsOnWorkerThread(); + + RefPtr ref = new WeakWorkerRef(aWorkerPrivate); + if (!ref->HoldWorker(Canceling)) { + return nullptr; + } + + ref->mCallback = std::move(aCallback); + + return ref.forget(); +} + +WeakWorkerRef::WeakWorkerRef(WorkerPrivate* aWorkerPrivate) + : WorkerRef(aWorkerPrivate, "WeakWorkerRef", false) {} + +WeakWorkerRef::~WeakWorkerRef() = default; + +void WeakWorkerRef::Notify() { + MOZ_ASSERT(mHolding); + MOZ_ASSERT(mWorkerPrivate); + + // Notify could drop the last reference to this object. We must keep it alive + // in order to call ReleaseWorker() immediately after. + RefPtr kungFuGrip = this; + + WorkerRef::Notify(); + ReleaseWorker(); +} + +WorkerPrivate* WeakWorkerRef::GetPrivate() const { + NS_ASSERT_OWNINGTHREAD(WeakWorkerRef); + return mWorkerPrivate; +} + +WorkerPrivate* WeakWorkerRef::GetUnsafePrivate() const { + return mWorkerPrivate; +} + +// ---------------------------------------------------------------------------- +// StrongWorkerRef + +/* static */ +already_AddRefed StrongWorkerRef::Create( + WorkerPrivate* const aWorkerPrivate, const char* const aName, + MoveOnlyFunction&& aCallback) { + if (RefPtr ref = + CreateImpl(aWorkerPrivate, aName, Canceling)) { + ref->mCallback = std::move(aCallback); + return ref.forget(); + } + return nullptr; +} + +/* static */ +already_AddRefed StrongWorkerRef::CreateForcibly( + WorkerPrivate* const aWorkerPrivate, const char* const aName) { + return CreateImpl(aWorkerPrivate, aName, Killing); +} + +/* static */ +already_AddRefed StrongWorkerRef::CreateImpl( + WorkerPrivate* const aWorkerPrivate, const char* const aName, + WorkerStatus const aFailStatus) { + MOZ_ASSERT(aWorkerPrivate); + MOZ_ASSERT(aName); + + RefPtr ref = new StrongWorkerRef(aWorkerPrivate, aName); + if (!ref->HoldWorker(aFailStatus)) { + return nullptr; + } + + return ref.forget(); +} + +StrongWorkerRef::StrongWorkerRef(WorkerPrivate* aWorkerPrivate, + const char* aName) + : WorkerRef(aWorkerPrivate, aName, true) {} + +StrongWorkerRef::~StrongWorkerRef() = default; + +WorkerPrivate* StrongWorkerRef::Private() const { + NS_ASSERT_OWNINGTHREAD(StrongWorkerRef); + return mWorkerPrivate; +} + +// ---------------------------------------------------------------------------- +// ThreadSafeWorkerRef + +ThreadSafeWorkerRef::ThreadSafeWorkerRef(StrongWorkerRef* aRef) : mRef(aRef) { + MOZ_ASSERT(aRef); + aRef->Private()->AssertIsOnWorkerThread(); +} + +ThreadSafeWorkerRef::~ThreadSafeWorkerRef() { + // Let's release the StrongWorkerRef on the correct thread. + if (!mRef->mWorkerPrivate->IsOnWorkerThread()) { + WorkerPrivate* workerPrivate = mRef->mWorkerPrivate; + RefPtr r = + new ReleaseRefControlRunnable(workerPrivate, mRef.forget()); + r->Dispatch(); + return; + } +} + +WorkerPrivate* ThreadSafeWorkerRef::Private() const { + return mRef->mWorkerPrivate; +} + +// ---------------------------------------------------------------------------- +// IPCWorkerRef + +/* static */ +already_AddRefed IPCWorkerRef::Create( + WorkerPrivate* aWorkerPrivate, const char* aName, + MoveOnlyFunction&& aCallback) { + MOZ_ASSERT(aWorkerPrivate); + aWorkerPrivate->AssertIsOnWorkerThread(); + + RefPtr ref = new IPCWorkerRef(aWorkerPrivate, aName); + if (!ref->HoldWorker(Canceling)) { + return nullptr; + } + + ref->mCallback = std::move(aCallback); + + return ref.forget(); +} + +IPCWorkerRef::IPCWorkerRef(WorkerPrivate* aWorkerPrivate, const char* aName) + : WorkerRef(aWorkerPrivate, aName, false) {} + +IPCWorkerRef::~IPCWorkerRef() = default; + +WorkerPrivate* IPCWorkerRef::Private() const { + NS_ASSERT_OWNINGTHREAD(IPCWorkerRef); + return mWorkerPrivate; +} + +} // namespace mozilla::dom -- cgit v1.2.3