/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* vim:set ts=2 sw=2 sts=2 et cindent: */ /* 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/. */ #if !defined(MediaPromise_h_) #define MediaPromise_h_ #include "mozilla/Logging.h" #include "AbstractThread.h" #include "nsTArray.h" #include "nsThreadUtils.h" #include "mozilla/DebugOnly.h" #include "mozilla/Maybe.h" #include "mozilla/Mutex.h" #include "mozilla/Monitor.h" #include "mozilla/unused.h" /* Polyfill __func__ on MSVC for consumers to pass to the MediaPromise API. */ #ifdef _MSC_VER #define __func__ __FUNCTION__ #endif namespace mozilla { extern PRLogModuleInfo* gMediaPromiseLog; #define PROMISE_LOG(x, ...) \ MOZ_ASSERT(gMediaPromiseLog); \ MOZ_LOG(gMediaPromiseLog, PR_LOG_DEBUG, (x, ##__VA_ARGS__)) /* * A promise manages an asynchronous request that may or may not be able to be * fulfilled immediately. When an API returns a promise, the consumer may attach * callbacks to be invoked (asynchronously, on a specified thread) when the * request is either completed (resolved) or cannot be completed (rejected). * * When IsExclusive is true, the MediaPromise does a release-mode assertion that * there is at most one call to either Then(...) or ChainTo(...). */ class MediaPromiseBase { public: NS_INLINE_DECL_THREADSAFE_REFCOUNTING(MediaPromiseBase) protected: virtual ~MediaPromiseBase() {} }; template class MediaPromiseHolder; template class MediaPromise : public MediaPromiseBase { public: typedef ResolveValueT ResolveValueType; typedef RejectValueT RejectValueType; class ResolveOrRejectValue { public: void SetResolve(ResolveValueType& aResolveValue) { MOZ_ASSERT(IsNothing()); mResolveValue.emplace(aResolveValue); } void SetReject(RejectValueType& aRejectValue) { MOZ_ASSERT(IsNothing()); mRejectValue.emplace(aRejectValue); } bool IsResolve() const { return mResolveValue.isSome(); } bool IsReject() const { return mRejectValue.isSome(); } bool IsNothing() const { return mResolveValue.isNothing() && mRejectValue.isNothing(); } ResolveValueType& ResolveValue() { return mResolveValue.ref(); } RejectValueType& RejectValue() { return mRejectValue.ref(); } private: Maybe mResolveValue; Maybe mRejectValue; }; protected: // MediaPromise is the public type, and never constructed directly. Construct // a MediaPromise::Private, defined below. explicit MediaPromise(const char* aCreationSite) : mCreationSite(aCreationSite) , mMutex("MediaPromise Mutex") , mHaveConsumer(false) { PROMISE_LOG("%s creating MediaPromise (%p)", mCreationSite, this); } public: // MediaPromise::Private allows us to separate the public interface (upon which // consumers of the promise may invoke methods like Then()) from the private // interface (upon which the creator of the promise may invoke Resolve() or // Reject()). APIs should create and store a MediaPromise::Private (usually // via a MediaPromiseHolder), and return a MediaPromise to consumers. // // NB: We can include the definition of this class inline once B2G ICS is gone. class Private; static nsRefPtr CreateAndResolve(ResolveValueType aResolveValue, const char* aResolveSite) { nsRefPtr p = new MediaPromise::Private(aResolveSite); p->Resolve(aResolveValue, aResolveSite); return Move(p); } static nsRefPtr CreateAndReject(RejectValueType aRejectValue, const char* aRejectSite) { nsRefPtr p = new MediaPromise::Private(aRejectSite); p->Reject(aRejectValue, aRejectSite); return Move(p); } class Consumer { public: NS_INLINE_DECL_THREADSAFE_REFCOUNTING(Consumer) virtual void Disconnect() = 0; // MSVC complains when an inner class (ThenValueBase::{Resolve,Reject}Runnable) // tries to access an inherited protected member. bool IsDisconnected() const { return mDisconnected; } protected: Consumer() : mComplete(false), mDisconnected(false) {} virtual ~Consumer() {} bool mComplete; bool mDisconnected; }; protected: /* * A ThenValue tracks a single consumer waiting on the promise. When a consumer * invokes promise->Then(...), a ThenValue is created. Once the Promise is * resolved or rejected, a {Resolve,Reject}Runnable is dispatched, which * invokes the resolve/reject method and then deletes the ThenValue. */ class ThenValueBase : public Consumer { public: class ResolveOrRejectRunnable : public nsRunnable { public: ResolveOrRejectRunnable(ThenValueBase* aThenValue, ResolveOrRejectValue& aValue) : mThenValue(aThenValue) , mValue(aValue) {} ~ResolveOrRejectRunnable() { MOZ_DIAGNOSTIC_ASSERT(!mThenValue || mThenValue->IsDisconnected()); } NS_IMETHODIMP Run() { PROMISE_LOG("ResolveOrRejectRunnable::Run() [this=%p]", this); mThenValue->DoResolveOrReject(mValue); mThenValue = nullptr; return NS_OK; } private: nsRefPtr mThenValue; ResolveOrRejectValue mValue; }; explicit ThenValueBase(AbstractThread* aResponseTarget, const char* aCallSite) : mResponseTarget(aResponseTarget), mCallSite(aCallSite) {} void Dispatch(MediaPromise *aPromise) { aPromise->mMutex.AssertCurrentThreadOwns(); MOZ_ASSERT(!aPromise->IsPending()); nsRefPtr runnable = static_cast(new (typename ThenValueBase::ResolveOrRejectRunnable)(this, aPromise->mValue)); PROMISE_LOG("%s Then() call made from %s [Runnable=%p, Promise=%p, ThenValue=%p]", aPromise->mValue.IsResolve() ? "Resolving" : "Rejecting", ThenValueBase::mCallSite, runnable.get(), aPromise, this); // Promise consumers are allowed to disconnect the Consumer object and // then shut down the thread or task queue that the promise result would // be dispatched on. So we unfortunately can't assert that promise // dispatch succeeds. :-( mResponseTarget->Dispatch(runnable.forget(), AbstractThread::DontAssertDispatchSuccess); } virtual void Disconnect() override { MOZ_ASSERT(ThenValueBase::mResponseTarget->IsCurrentThreadIn()); MOZ_DIAGNOSTIC_ASSERT(!Consumer::mComplete); Consumer::mDisconnected = true; } protected: virtual void DoResolveOrRejectInternal(ResolveOrRejectValue& aValue) = 0; void DoResolveOrReject(ResolveOrRejectValue& aValue) { Consumer::mComplete = true; if (Consumer::mDisconnected) { PROMISE_LOG("ThenValue::DoResolveOrReject disconnected - bailing out [this=%p]", this); return; } DoResolveOrRejectInternal(aValue); } nsRefPtr mResponseTarget; // May be released on any thread. const char* mCallSite; }; /* * We create two overloads for invoking Resolve/Reject Methods so as to * make the resolve/reject value argument "optional". */ // Avoid confusing the compiler when the callback accepts T* but the ValueType // is nsRefPtr. See bug 1109954 comment 6. template struct NonDeduced { typedef T type; }; template static void InvokeCallbackMethod(ThisType* aThisVal, void(ThisType::*aMethod)(ValueType), typename NonDeduced::type aValue) { ((*aThisVal).*aMethod)(aValue); } template static void InvokeCallbackMethod(ThisType* aThisVal, void(ThisType::*aMethod)(), ValueType aValue) { ((*aThisVal).*aMethod)(); } template class MethodThenValue : public ThenValueBase { public: MethodThenValue(AbstractThread* aResponseTarget, ThisType* aThisVal, ResolveMethodType aResolveMethod, RejectMethodType aRejectMethod, const char* aCallSite) : ThenValueBase(aResponseTarget, aCallSite) , mThisVal(aThisVal) , mResolveMethod(aResolveMethod) , mRejectMethod(aRejectMethod) {} virtual void Disconnect() override { ThenValueBase::Disconnect(); // If a Consumer has been disconnected, we don't guarantee that the // resolve/reject runnable will be dispatched. Null out our refcounted // this-value now so that it's released predictably on the dispatch thread. mThisVal = nullptr; } protected: virtual void DoResolveOrRejectInternal(ResolveOrRejectValue& aValue) override { if (aValue.IsResolve()) { InvokeCallbackMethod(mThisVal.get(), mResolveMethod, aValue.ResolveValue()); } else { InvokeCallbackMethod(mThisVal.get(), mRejectMethod, aValue.RejectValue()); } // Null out mThisVal after invoking the callback so that any references are // released predictably on the dispatch thread. Otherwise, it would be // released on whatever thread last drops its reference to the ThenValue, // which may or may not be ok. mThisVal = nullptr; } private: nsRefPtr mThisVal; // Only accessed and refcounted on dispatch thread. ResolveMethodType mResolveMethod; RejectMethodType mRejectMethod; }; // NB: We could use std::function here instead of a template if it were supported. :-( template class FunctionThenValue : public ThenValueBase { public: FunctionThenValue(AbstractThread* aResponseTarget, ResolveFunction&& aResolveFunction, RejectFunction&& aRejectFunction, const char* aCallSite) : ThenValueBase(aResponseTarget, aCallSite) { mResolveFunction.emplace(Move(aResolveFunction)); mRejectFunction.emplace(Move(aRejectFunction)); } virtual void Disconnect() override { ThenValueBase::Disconnect(); // If a Consumer has been disconnected, we don't guarantee that the // resolve/reject runnable will be dispatched. Destroy our callbacks // now so that any references in closures are released predictable on // the dispatch thread. mResolveFunction.reset(); mRejectFunction.reset(); } protected: virtual void DoResolveOrRejectInternal(ResolveOrRejectValue& aValue) override { if (aValue.IsResolve()) { mResolveFunction.ref()(aValue.ResolveValue()); } else { mRejectFunction.ref()(aValue.RejectValue()); } // Destroy callbacks after invocation so that any references in closures are // released predictably on the dispatch thread. Otherwise, they would be // released on whatever thread last drops its reference to the ThenValue, // which may or may not be ok. mResolveFunction.reset(); mRejectFunction.reset(); } private: Maybe mResolveFunction; // Only accessed and deleted on dispatch thread. Maybe mRejectFunction; // Only accessed and deleted on dispatch thread. }; public: void ThenInternal(AbstractThread* aResponseThread, ThenValueBase* aThenValue, const char* aCallSite) { MutexAutoLock lock(mMutex); MOZ_ASSERT(aResponseThread->IsDispatchReliable()); MOZ_DIAGNOSTIC_ASSERT(!IsExclusive || !mHaveConsumer); mHaveConsumer = true; PROMISE_LOG("%s invoking Then() [this=%p, aThenValue=%p, isPending=%d]", aCallSite, this, aThenValue, (int) IsPending()); if (!IsPending()) { aThenValue->Dispatch(this); } else { mThenValues.AppendElement(aThenValue); } } public: template already_AddRefed RefableThen(AbstractThread* aResponseThread, const char* aCallSite, ThisType* aThisVal, ResolveMethodType aResolveMethod, RejectMethodType aRejectMethod) { nsRefPtr thenValue = new MethodThenValue( aResponseThread, aThisVal, aResolveMethod, aRejectMethod, aCallSite); ThenInternal(aResponseThread, thenValue, aCallSite); return thenValue.forget(); } template already_AddRefed RefableThen(AbstractThread* aResponseThread, const char* aCallSite, ResolveFunction&& aResolveFunction, RejectFunction&& aRejectFunction) { nsRefPtr thenValue = new FunctionThenValue(aResponseThread, Move(aResolveFunction), Move(aRejectFunction), aCallSite); ThenInternal(aResponseThread, thenValue, aCallSite); return thenValue.forget(); } template void Then(AbstractThread* aResponseThread, const char* aCallSite, ThisType* aThisVal, ResolveMethodType aResolveMethod, RejectMethodType aRejectMethod) { nsRefPtr c = RefableThen(aResponseThread, aCallSite, aThisVal, aResolveMethod, aRejectMethod); return; } template void Then(AbstractThread* aResponseThread, const char* aCallSite, ResolveFunction&& aResolveFunction, RejectFunction&& aRejectFunction) { nsRefPtr c = RefableThen(aResponseThread, aCallSite, Move(aResolveFunction), Move(aRejectFunction)); return; } void ChainTo(already_AddRefed aChainedPromise, const char* aCallSite) { MutexAutoLock lock(mMutex); MOZ_DIAGNOSTIC_ASSERT(!IsExclusive || !mHaveConsumer); mHaveConsumer = true; nsRefPtr chainedPromise = aChainedPromise; PROMISE_LOG("%s invoking Chain() [this=%p, chainedPromise=%p, isPending=%d]", aCallSite, this, chainedPromise.get(), (int) IsPending()); if (!IsPending()) { ForwardTo(chainedPromise); } else { mChainedPromises.AppendElement(chainedPromise); } } protected: bool IsPending() { return mValue.IsNothing(); } void DispatchAll() { mMutex.AssertCurrentThreadOwns(); for (size_t i = 0; i < mThenValues.Length(); ++i) { mThenValues[i]->Dispatch(this); } mThenValues.Clear(); for (size_t i = 0; i < mChainedPromises.Length(); ++i) { ForwardTo(mChainedPromises[i]); } mChainedPromises.Clear(); } void ForwardTo(Private* aOther) { MOZ_ASSERT(!IsPending()); if (mValue.IsResolve()) { aOther->Resolve(mValue.ResolveValue(), ""); } else { aOther->Reject(mValue.RejectValue(), ""); } } virtual ~MediaPromise() { PROMISE_LOG("MediaPromise::~MediaPromise [this=%p]", this); MOZ_ASSERT(!IsPending()); MOZ_ASSERT(mThenValues.IsEmpty()); MOZ_ASSERT(mChainedPromises.IsEmpty()); }; const char* mCreationSite; // For logging Mutex mMutex; ResolveOrRejectValue mValue; nsTArray> mThenValues; nsTArray> mChainedPromises; bool mHaveConsumer; }; template class MediaPromise::Private : public MediaPromise { public: explicit Private(const char* aCreationSite) : MediaPromise(aCreationSite) {} void Resolve(ResolveValueT aResolveValue, const char* aResolveSite) { MutexAutoLock lock(mMutex); MOZ_ASSERT(IsPending()); PROMISE_LOG("%s resolving MediaPromise (%p created at %s)", aResolveSite, this, mCreationSite); mValue.SetResolve(aResolveValue); DispatchAll(); } void Reject(RejectValueT aRejectValue, const char* aRejectSite) { MutexAutoLock lock(mMutex); MOZ_ASSERT(IsPending()); PROMISE_LOG("%s rejecting MediaPromise (%p created at %s)", aRejectSite, this, mCreationSite); mValue.SetReject(aRejectValue); DispatchAll(); } }; /* * Class to encapsulate a promise for a particular role. Use this as the member * variable for a class whose method returns a promise. */ template class MediaPromiseHolder { public: MediaPromiseHolder() : mMonitor(nullptr) {} // Move semantics. MediaPromiseHolder& operator=(MediaPromiseHolder&& aOther) { MOZ_ASSERT(!mMonitor && !aOther.mMonitor); MOZ_DIAGNOSTIC_ASSERT(!mPromise); mPromise = aOther.mPromise; aOther.mPromise = nullptr; return *this; } ~MediaPromiseHolder() { MOZ_ASSERT(!mPromise); } already_AddRefed Ensure(const char* aMethodName) { if (mMonitor) { mMonitor->AssertCurrentThreadOwns(); } if (!mPromise) { mPromise = new (typename PromiseType::Private)(aMethodName); } nsRefPtr p = mPromise.get(); return p.forget(); } // Provide a Monitor that should always be held when accessing this instance. void SetMonitor(Monitor* aMonitor) { mMonitor = aMonitor; } bool IsEmpty() { if (mMonitor) { mMonitor->AssertCurrentThreadOwns(); } return !mPromise; } already_AddRefed Steal() { if (mMonitor) { mMonitor->AssertCurrentThreadOwns(); } nsRefPtr p = mPromise; mPromise = nullptr; return p.forget(); } void Resolve(typename PromiseType::ResolveValueType aResolveValue, const char* aMethodName) { if (mMonitor) { mMonitor->AssertCurrentThreadOwns(); } MOZ_ASSERT(mPromise); mPromise->Resolve(aResolveValue, aMethodName); mPromise = nullptr; } void ResolveIfExists(typename PromiseType::ResolveValueType aResolveValue, const char* aMethodName) { if (!IsEmpty()) { Resolve(aResolveValue, aMethodName); } } void Reject(typename PromiseType::RejectValueType aRejectValue, const char* aMethodName) { if (mMonitor) { mMonitor->AssertCurrentThreadOwns(); } MOZ_ASSERT(mPromise); mPromise->Reject(aRejectValue, aMethodName); mPromise = nullptr; } void RejectIfExists(typename PromiseType::RejectValueType aRejectValue, const char* aMethodName) { if (!IsEmpty()) { Reject(aRejectValue, aMethodName); } } private: Monitor* mMonitor; nsRefPtr mPromise; }; /* * Class to encapsulate a MediaPromise::Consumer reference. Use this as the member * variable for a class waiting on a media promise. */ template class MediaPromiseConsumerHolder { public: MediaPromiseConsumerHolder() {} ~MediaPromiseConsumerHolder() { MOZ_ASSERT(!mConsumer); } void Begin(already_AddRefed aConsumer) { MOZ_DIAGNOSTIC_ASSERT(!Exists()); mConsumer = aConsumer; } void Complete() { MOZ_DIAGNOSTIC_ASSERT(Exists()); mConsumer = nullptr; } // Disconnects and forgets an outstanding promise. The resolve/reject methods // will never be called. void Disconnect() { MOZ_ASSERT(Exists()); mConsumer->Disconnect(); mConsumer = nullptr; } void DisconnectIfExists() { if (Exists()) { Disconnect(); } } bool Exists() { return !!mConsumer; } private: nsRefPtr mConsumer; }; // Proxy Media Calls. // // This machinery allows callers to schedule a promise-returning method to be // invoked asynchronously on a given thread, while at the same time receiving // a promise upon which to invoke Then() immediately. ProxyMediaCall dispatches // a task to invoke the method on the proper thread and also chain the resulting // promise to the one that the caller received, so that resolve/reject values // are forwarded through. namespace detail { template class MethodCallBase { public: MethodCallBase() { MOZ_COUNT_CTOR(MethodCallBase); } virtual nsRefPtr Invoke() = 0; virtual ~MethodCallBase() { MOZ_COUNT_DTOR(MethodCallBase); }; }; template class MethodCallWithNoArgs : public MethodCallBase { public: typedef nsRefPtr(ThisType::*Type)(); MethodCallWithNoArgs(ThisType* aThisVal, Type aMethod) : mThisVal(aThisVal), mMethod(aMethod) {} nsRefPtr Invoke() override { return ((*mThisVal).*mMethod)(); } protected: nsRefPtr mThisVal; Type mMethod; }; template class MethodCallWithOneArg : public MethodCallBase { public: typedef nsRefPtr(ThisType::*Type)(Arg1Type); MethodCallWithOneArg(ThisType* aThisVal, Type aMethod, Arg1Type aArg1) : mThisVal(aThisVal), mMethod(aMethod), mArg1(aArg1) {} nsRefPtr Invoke() override { return ((*mThisVal).*mMethod)(mArg1); } protected: nsRefPtr mThisVal; Type mMethod; Arg1Type mArg1; }; template class MethodCallWithTwoArgs : public MethodCallBase { public: typedef nsRefPtr(ThisType::*Type)(Arg1Type, Arg2Type); MethodCallWithTwoArgs(ThisType* aThisVal, Type aMethod, Arg1Type aArg1, Arg2Type aArg2) : mThisVal(aThisVal), mMethod(aMethod), mArg1(aArg1), mArg2(aArg2) {} nsRefPtr Invoke() override { return ((*mThisVal).*mMethod)(mArg1, mArg2); } protected: nsRefPtr mThisVal; Type mMethod; Arg1Type mArg1; Arg2Type mArg2; }; template class ProxyRunnable : public nsRunnable { public: ProxyRunnable(typename PromiseType::Private* aProxyPromise, MethodCallBase* aMethodCall) : mProxyPromise(aProxyPromise), mMethodCall(aMethodCall) {} NS_IMETHODIMP Run() { nsRefPtr p = mMethodCall->Invoke(); mMethodCall = nullptr; p->ChainTo(mProxyPromise.forget(), ""); return NS_OK; } private: nsRefPtr mProxyPromise; nsAutoPtr> mMethodCall; }; template static nsRefPtr ProxyInternal(AbstractThread* aTarget, MethodCallBase* aMethodCall, const char* aCallerName) { nsRefPtr p = new (typename PromiseType::Private)(aCallerName); nsRefPtr> r = new ProxyRunnable(p, aMethodCall); MOZ_ASSERT(aTarget->IsDispatchReliable()); aTarget->Dispatch(r.forget()); return Move(p); } } // namespace detail template static nsRefPtr ProxyMediaCall(AbstractThread* aTarget, ThisType* aThisVal, const char* aCallerName, nsRefPtr(ThisType::*aMethod)()) { typedef detail::MethodCallWithNoArgs MethodCallType; MethodCallType* methodCall = new MethodCallType(aThisVal, aMethod); return detail::ProxyInternal(aTarget, methodCall, aCallerName); } template static nsRefPtr ProxyMediaCall(AbstractThread* aTarget, ThisType* aThisVal, const char* aCallerName, nsRefPtr(ThisType::*aMethod)(Arg1Type), Arg1Type aArg1) { typedef detail::MethodCallWithOneArg MethodCallType; MethodCallType* methodCall = new MethodCallType(aThisVal, aMethod, aArg1); return detail::ProxyInternal(aTarget, methodCall, aCallerName); } template static nsRefPtr ProxyMediaCall(AbstractThread* aTarget, ThisType* aThisVal, const char* aCallerName, nsRefPtr(ThisType::*aMethod)(Arg1Type, Arg2Type), Arg1Type aArg1, Arg2Type aArg2) { typedef detail::MethodCallWithTwoArgs MethodCallType; MethodCallType* methodCall = new MethodCallType(aThisVal, aMethod, aArg1, aArg2); return detail::ProxyInternal(aTarget, methodCall, aCallerName); } #undef PROMISE_LOG } // namespace mozilla #endif