gecko-dev/dom/media/gmp/ChromiumCDMProxy.cpp
Bryce Van Dyk c10bad5275 Bug 1540136 - P5: Handle if ChromiumCDMProxy is shutdown in the middle of init. r=cpearce
- Watch for if a proxy shuts down during init and if so, shutdown the CDM parent
  that is being initialized.
- Make ChromiumCDMParent only store a pointer to a ChromiumCDMProxy when it has
  successfully initialized. This avoid the lopsided relationship where a if a
  ChromiumCDMParent fails to initialize it may keep a pointer to a proxy, but
  the proxy will never have a reference to that CDM parent.

Differential Revision: https://phabricator.services.mozilla.com/D26208

--HG--
extra : moz-landing-system : lando
2019-04-09 15:07:49 +00:00

553 lines
20 KiB
C++

/* -*- 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 "ChromiumCDMProxy.h"
#include "ChromiumCDMCallbackProxy.h"
#include "MediaResult.h"
#include "mozilla/dom/MediaKeySession.h"
#include "GMPUtils.h"
#include "nsPrintfCString.h"
#include "GMPService.h"
#include "content_decryption_module.h"
#define NS_DispatchToMainThread(...) CompileError_UseAbstractMainThreadInstead
namespace mozilla {
ChromiumCDMProxy::ChromiumCDMProxy(dom::MediaKeys* aKeys,
const nsAString& aKeySystem,
GMPCrashHelper* aCrashHelper,
bool aDistinctiveIdentifierRequired,
bool aPersistentStateRequired,
nsISerialEventTarget* aMainThread)
: CDMProxy(aKeys, aKeySystem, aDistinctiveIdentifierRequired,
aPersistentStateRequired, aMainThread),
mCrashHelper(aCrashHelper),
mCDMMutex("ChromiumCDMProxy"),
mGMPThread(GetGMPAbstractThread()) {
MOZ_ASSERT(NS_IsMainThread());
}
ChromiumCDMProxy::~ChromiumCDMProxy() {
EME_LOG("ChromiumCDMProxy::~ChromiumCDMProxy(this=%p)", this);
}
void ChromiumCDMProxy::Init(PromiseId aPromiseId, const nsAString& aOrigin,
const nsAString& aTopLevelOrigin,
const nsAString& aGMPName) {
MOZ_ASSERT(NS_IsMainThread());
RefPtr<GMPCrashHelper> helper(std::move(mCrashHelper));
NS_ENSURE_TRUE_VOID(!mKeys.IsNull());
EME_LOG("ChromiumCDMProxy::Init(this=%p, pid=%" PRIu32
", origin=%s, topLevelOrigin=%s, "
"gmp=%s)",
this, aPromiseId, NS_ConvertUTF16toUTF8(aOrigin).get(),
NS_ConvertUTF16toUTF8(aTopLevelOrigin).get(),
NS_ConvertUTF16toUTF8(aGMPName).get());
if (!mGMPThread) {
RejectPromise(
aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
NS_LITERAL_CSTRING("Couldn't get GMP thread ChromiumCDMProxy::Init"));
return;
}
if (aGMPName.IsEmpty()) {
RejectPromise(aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
nsPrintfCString("Unknown GMP for keysystem '%s'",
NS_ConvertUTF16toUTF8(mKeySystem).get()));
return;
}
gmp::NodeId nodeId(aOrigin, aTopLevelOrigin, aGMPName);
RefPtr<AbstractThread> thread = mGMPThread;
RefPtr<ChromiumCDMProxy> self(this);
nsCString keySystem = NS_ConvertUTF16toUTF8(mKeySystem);
RefPtr<Runnable> task(NS_NewRunnableFunction(
"ChromiumCDMProxy::Init",
[self, nodeId, helper, aPromiseId, thread, keySystem]() -> void {
MOZ_ASSERT(self->IsOnOwnerThread());
RefPtr<gmp::GeckoMediaPluginService> service =
gmp::GeckoMediaPluginService::GetGeckoMediaPluginService();
if (!service) {
self->RejectPromise(
aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
NS_LITERAL_CSTRING("Couldn't get GeckoMediaPluginService in "
"ChromiumCDMProxy::Init"));
return;
}
RefPtr<gmp::GetCDMParentPromise> promise =
service->GetCDM(nodeId, {keySystem}, helper);
promise->Then(
thread, __func__,
[self, aPromiseId, thread](RefPtr<gmp::ChromiumCDMParent> cdm) {
// service->GetCDM succeeded
self->mCallback =
MakeUnique<ChromiumCDMCallbackProxy>(self, self->mMainThread);
cdm->Init(self->mCallback.get(),
self->mDistinctiveIdentifierRequired,
self->mPersistentStateRequired, self->mMainThread)
->Then(
self->mMainThread, __func__,
[self, aPromiseId, cdm](bool /* unused */) {
// CDM init succeeded
{
MutexAutoLock lock(self->mCDMMutex);
self->mCDM = cdm;
}
if (self->mIsShutdown) {
self->RejectPromise(
aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
NS_LITERAL_CSTRING(
"ChromiumCDMProxy shutdown during "
"ChromiumCDMProxy::Init"));
// If shutdown happened while waiting to init, we
// need to explicitly shutdown the CDM to avoid it
// referencing this proxy which is on its way out.
self->ShutdownCDMIfExists();
return;
}
self->OnCDMCreated(aPromiseId);
},
[self, aPromiseId](MediaResult aResult) {
// CDM init failed
self->RejectPromise(aPromiseId, aResult.Code(),
aResult.Message());
});
},
[self, aPromiseId](MediaResult rv) {
// service->GetCDM failed
self->RejectPromise(aPromiseId, rv.Code(), rv.Description());
});
}));
mGMPThread->Dispatch(task.forget());
}
void ChromiumCDMProxy::OnCDMCreated(uint32_t aPromiseId) {
EME_LOG("ChromiumCDMProxy::OnCDMCreated(this=%p, pid=%" PRIu32
") isMainThread=%d",
this, aPromiseId, NS_IsMainThread());
MOZ_ASSERT(NS_IsMainThread());
if (mKeys.IsNull()) {
return;
}
RefPtr<gmp::ChromiumCDMParent> cdm = GetCDMParent();
// This should only be called once the CDM has been created.
MOZ_ASSERT(cdm);
if (cdm) {
mKeys->OnCDMCreated(aPromiseId, cdm->PluginId());
} else {
// No CDM? Shouldn't be possible, but reject the promise anyway...
mKeys->RejectPromise(aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
NS_LITERAL_CSTRING("Null CDM in OnCDMCreated()"));
}
}
void ChromiumCDMProxy::ShutdownCDMIfExists() {
EME_LOG(
"ChromiumCDMProxy::ShutdownCDMIfExists(this=%p) mCDM=%p, mIsShutdown=%s",
this, mCDM.get(), mIsShutdown ? "true" : "false");
MOZ_ASSERT(NS_IsMainThread());
MOZ_ASSERT(mGMPThread);
MOZ_ASSERT(mIsShutdown,
"Should only shutdown the CDM if the proxy is shutting down");
RefPtr<gmp::ChromiumCDMParent> cdm;
{
MutexAutoLock lock(mCDMMutex);
cdm.swap(mCDM);
}
if (cdm) {
// We need to keep this proxy alive until the parent has finished its
// Shutdown (as it may still try to use the proxy until then).
RefPtr<ChromiumCDMProxy> self(this);
nsCOMPtr<nsIRunnable> task = NS_NewRunnableFunction(
"ChromiumCDMProxy::Shutdown", [self, cdm]() { cdm->Shutdown(); });
mGMPThread->Dispatch(task.forget());
}
}
#ifdef DEBUG
bool ChromiumCDMProxy::IsOnOwnerThread() {
return mGMPThread->IsCurrentThreadIn();
}
#endif
static uint32_t ToCDMSessionType(dom::MediaKeySessionType aSessionType) {
switch (aSessionType) {
case dom::MediaKeySessionType::Temporary:
return static_cast<uint32_t>(cdm::kTemporary);
case dom::MediaKeySessionType::Persistent_license:
return static_cast<uint32_t>(cdm::kPersistentLicense);
default:
return static_cast<uint32_t>(cdm::kTemporary);
};
};
static uint32_t ToCDMInitDataType(const nsAString& aInitDataType) {
if (aInitDataType.EqualsLiteral("cenc")) {
return static_cast<uint32_t>(cdm::kCenc);
}
if (aInitDataType.EqualsLiteral("webm")) {
return static_cast<uint32_t>(cdm::kWebM);
}
if (aInitDataType.EqualsLiteral("keyids")) {
return static_cast<uint32_t>(cdm::kKeyIds);
}
return static_cast<uint32_t>(cdm::kCenc);
}
void ChromiumCDMProxy::CreateSession(uint32_t aCreateSessionToken,
dom::MediaKeySessionType aSessionType,
PromiseId aPromiseId,
const nsAString& aInitDataType,
nsTArray<uint8_t>& aInitData) {
MOZ_ASSERT(NS_IsMainThread());
EME_LOG("ChromiumCDMProxy::CreateSession(this=%p, token=%" PRIu32
", type=%d, pid=%" PRIu32
") "
"initDataLen=%zu",
this, aCreateSessionToken, (int)aSessionType, aPromiseId,
aInitData.Length());
uint32_t sessionType = ToCDMSessionType(aSessionType);
uint32_t initDataType = ToCDMInitDataType(aInitDataType);
RefPtr<gmp::ChromiumCDMParent> cdm = GetCDMParent();
if (!cdm) {
RejectPromise(aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
NS_LITERAL_CSTRING("Null CDM in CreateSession"));
return;
}
mGMPThread->Dispatch(NewRunnableMethod<uint32_t, uint32_t, uint32_t, uint32_t,
nsTArray<uint8_t>>(
"gmp::ChromiumCDMParent::CreateSession", cdm,
&gmp::ChromiumCDMParent::CreateSession, aCreateSessionToken, sessionType,
initDataType, aPromiseId, std::move(aInitData)));
}
void ChromiumCDMProxy::LoadSession(PromiseId aPromiseId,
dom::MediaKeySessionType aSessionType,
const nsAString& aSessionId) {
MOZ_ASSERT(NS_IsMainThread());
RefPtr<gmp::ChromiumCDMParent> cdm = GetCDMParent();
if (!cdm) {
RejectPromise(aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
NS_LITERAL_CSTRING("Null CDM in LoadSession"));
return;
}
mGMPThread->Dispatch(NewRunnableMethod<uint32_t, uint32_t, nsString>(
"gmp::ChromiumCDMParent::LoadSession", cdm,
&gmp::ChromiumCDMParent::LoadSession, aPromiseId,
ToCDMSessionType(aSessionType), aSessionId));
}
void ChromiumCDMProxy::SetServerCertificate(PromiseId aPromiseId,
nsTArray<uint8_t>& aCert) {
MOZ_ASSERT(NS_IsMainThread());
EME_LOG("ChromiumCDMProxy::SetServerCertificate(this=%p, pid=%" PRIu32
") certLen=%zu",
this, aPromiseId, aCert.Length());
RefPtr<gmp::ChromiumCDMParent> cdm = GetCDMParent();
if (!cdm) {
RejectPromise(aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
NS_LITERAL_CSTRING("Null CDM in SetServerCertificate"));
return;
}
mGMPThread->Dispatch(NewRunnableMethod<uint32_t, nsTArray<uint8_t>>(
"gmp::ChromiumCDMParent::SetServerCertificate", cdm,
&gmp::ChromiumCDMParent::SetServerCertificate, aPromiseId,
std::move(aCert)));
}
void ChromiumCDMProxy::UpdateSession(const nsAString& aSessionId,
PromiseId aPromiseId,
nsTArray<uint8_t>& aResponse) {
MOZ_ASSERT(NS_IsMainThread());
EME_LOG("ChromiumCDMProxy::UpdateSession(this=%p, sid='%s', pid=%" PRIu32
") "
"responseLen=%zu",
this, NS_ConvertUTF16toUTF8(aSessionId).get(), aPromiseId,
aResponse.Length());
RefPtr<gmp::ChromiumCDMParent> cdm = GetCDMParent();
if (!cdm) {
RejectPromise(aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
NS_LITERAL_CSTRING("Null CDM in UpdateSession"));
return;
}
mGMPThread->Dispatch(
NewRunnableMethod<nsCString, uint32_t, nsTArray<uint8_t>>(
"gmp::ChromiumCDMParent::UpdateSession", cdm,
&gmp::ChromiumCDMParent::UpdateSession,
NS_ConvertUTF16toUTF8(aSessionId), aPromiseId, std::move(aResponse)));
}
void ChromiumCDMProxy::CloseSession(const nsAString& aSessionId,
PromiseId aPromiseId) {
MOZ_ASSERT(NS_IsMainThread());
EME_LOG("ChromiumCDMProxy::CloseSession(this=%p, sid='%s', pid=%" PRIu32 ")",
this, NS_ConvertUTF16toUTF8(aSessionId).get(), aPromiseId);
RefPtr<gmp::ChromiumCDMParent> cdm = GetCDMParent();
if (!cdm) {
RejectPromise(aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
NS_LITERAL_CSTRING("Null CDM in CloseSession"));
return;
}
mGMPThread->Dispatch(NewRunnableMethod<nsCString, uint32_t>(
"gmp::ChromiumCDMParent::CloseSession", cdm,
&gmp::ChromiumCDMParent::CloseSession, NS_ConvertUTF16toUTF8(aSessionId),
aPromiseId));
}
void ChromiumCDMProxy::RemoveSession(const nsAString& aSessionId,
PromiseId aPromiseId) {
MOZ_ASSERT(NS_IsMainThread());
EME_LOG("ChromiumCDMProxy::RemoveSession(this=%p, sid='%s', pid=%" PRIu32 ")",
this, NS_ConvertUTF16toUTF8(aSessionId).get(), aPromiseId);
RefPtr<gmp::ChromiumCDMParent> cdm = GetCDMParent();
if (!cdm) {
RejectPromise(aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
NS_LITERAL_CSTRING("Null CDM in RemoveSession"));
return;
}
mGMPThread->Dispatch(NewRunnableMethod<nsCString, uint32_t>(
"gmp::ChromiumCDMParent::RemoveSession", cdm,
&gmp::ChromiumCDMParent::RemoveSession, NS_ConvertUTF16toUTF8(aSessionId),
aPromiseId));
}
void ChromiumCDMProxy::Shutdown() {
MOZ_ASSERT(NS_IsMainThread());
EME_LOG("ChromiumCDMProxy::Shutdown(this=%p) mCDM=%p, mIsShutdown=%s", this,
mCDM.get(), mIsShutdown ? "true" : "false");
if (mIsShutdown) {
return;
}
mIsShutdown = true;
mKeys.Clear();
ShutdownCDMIfExists();
}
void ChromiumCDMProxy::RejectPromise(PromiseId aId, nsresult aCode,
const nsCString& aReason) {
if (!NS_IsMainThread()) {
mMainThread->Dispatch(
NewRunnableMethod<PromiseId, nsresult, nsCString>(
"ChromiumCDMProxy::RejectPromise", this,
&ChromiumCDMProxy::RejectPromise, aId, aCode, aReason),
NS_DISPATCH_NORMAL);
return;
}
EME_LOG("ChromiumCDMProxy::RejectPromise(this=%p, pid=%" PRIu32
", code=0x%x, "
"reason='%s')",
this, aId, static_cast<uint32_t>(aCode), aReason.get());
if (!mKeys.IsNull()) {
mKeys->RejectPromise(aId, aCode, aReason);
}
}
void ChromiumCDMProxy::ResolvePromise(PromiseId aId) {
if (!NS_IsMainThread()) {
mMainThread->Dispatch(
NewRunnableMethod<PromiseId>("ChromiumCDMProxy::ResolvePromise", this,
&ChromiumCDMProxy::ResolvePromise, aId),
NS_DISPATCH_NORMAL);
return;
}
EME_LOG("ChromiumCDMProxy::ResolvePromise(this=%p, pid=%" PRIu32 ")", this,
aId);
if (!mKeys.IsNull()) {
mKeys->ResolvePromise(aId);
} else {
NS_WARNING("ChromiumCDMProxy unable to resolve promise!");
}
}
const nsCString& ChromiumCDMProxy::GetNodeId() const { return mNodeId; }
void ChromiumCDMProxy::OnSetSessionId(uint32_t aCreateSessionToken,
const nsAString& aSessionId) {
MOZ_ASSERT(NS_IsMainThread());
EME_LOG("ChromiumCDMProxy::OnSetSessionId(this=%p, token=%" PRIu32
", sid='%s')",
this, aCreateSessionToken, NS_ConvertUTF16toUTF8(aSessionId).get());
if (mKeys.IsNull()) {
return;
}
RefPtr<dom::MediaKeySession> session(
mKeys->GetPendingSession(aCreateSessionToken));
if (session) {
session->SetSessionId(aSessionId);
}
}
void ChromiumCDMProxy::OnResolveLoadSessionPromise(uint32_t aPromiseId,
bool aSuccess) {
MOZ_ASSERT(NS_IsMainThread());
if (mKeys.IsNull()) {
return;
}
mKeys->OnSessionLoaded(aPromiseId, aSuccess);
}
void ChromiumCDMProxy::OnResolvePromiseWithKeyStatus(
uint32_t aPromiseId, dom::MediaKeyStatus aKeyStatus) {
MOZ_ASSERT(NS_IsMainThread());
if (mKeys.IsNull()) {
return;
}
mKeys->ResolvePromiseWithKeyStatus(aPromiseId, aKeyStatus);
}
void ChromiumCDMProxy::OnSessionMessage(const nsAString& aSessionId,
dom::MediaKeyMessageType aMessageType,
const nsTArray<uint8_t>& aMessage) {
MOZ_ASSERT(NS_IsMainThread());
if (mKeys.IsNull()) {
return;
}
RefPtr<dom::MediaKeySession> session(mKeys->GetSession(aSessionId));
if (session) {
session->DispatchKeyMessage(aMessageType, aMessage);
}
}
void ChromiumCDMProxy::OnKeyStatusesChange(const nsAString& aSessionId) {
MOZ_ASSERT(NS_IsMainThread());
if (mKeys.IsNull()) {
return;
}
RefPtr<dom::MediaKeySession> session(mKeys->GetSession(aSessionId));
if (session) {
session->DispatchKeyStatusesChange();
}
}
void ChromiumCDMProxy::OnExpirationChange(const nsAString& aSessionId,
UnixTime aExpiryTime) {
MOZ_ASSERT(NS_IsMainThread());
if (mKeys.IsNull()) {
return;
}
RefPtr<dom::MediaKeySession> session(mKeys->GetSession(aSessionId));
if (session) {
// Expiry of 0 is interpreted as "never expire". See bug 1345341.
double t = (aExpiryTime == 0) ? std::numeric_limits<double>::quiet_NaN()
: static_cast<double>(aExpiryTime);
session->SetExpiration(t);
}
}
void ChromiumCDMProxy::OnSessionClosed(const nsAString& aSessionId) {
MOZ_ASSERT(NS_IsMainThread());
bool keyStatusesChange = false;
{
auto caps = Capabilites().Lock();
keyStatusesChange = caps->RemoveKeysForSession(nsString(aSessionId));
}
if (keyStatusesChange) {
OnKeyStatusesChange(aSessionId);
}
if (mKeys.IsNull()) {
return;
}
RefPtr<dom::MediaKeySession> session(mKeys->GetSession(aSessionId));
if (session) {
session->OnClosed();
}
}
void ChromiumCDMProxy::OnDecrypted(uint32_t aId, DecryptStatus aResult,
const nsTArray<uint8_t>& aDecryptedData) {}
void ChromiumCDMProxy::OnSessionError(const nsAString& aSessionId,
nsresult aException, uint32_t aSystemCode,
const nsAString& aMsg) {
MOZ_ASSERT(NS_IsMainThread());
if (mKeys.IsNull()) {
return;
}
RefPtr<dom::MediaKeySession> session(mKeys->GetSession(aSessionId));
if (session) {
session->DispatchKeyError(aSystemCode);
}
LogToConsole(aMsg);
}
void ChromiumCDMProxy::OnRejectPromise(uint32_t aPromiseId,
nsresult aDOMException,
const nsCString& aMsg) {
MOZ_ASSERT(NS_IsMainThread());
RejectPromise(aPromiseId, aDOMException, aMsg);
}
const nsString& ChromiumCDMProxy::KeySystem() const { return mKeySystem; }
DataMutex<CDMCaps>& ChromiumCDMProxy::Capabilites() { return mCapabilites; }
RefPtr<DecryptPromise> ChromiumCDMProxy::Decrypt(MediaRawData* aSample) {
RefPtr<gmp::ChromiumCDMParent> cdm = GetCDMParent();
if (!cdm) {
return DecryptPromise::CreateAndReject(
DecryptResult(eme::AbortedErr, aSample), __func__);
}
RefPtr<MediaRawData> sample = aSample;
return InvokeAsync(mGMPThread, __func__,
[cdm, sample]() { return cdm->Decrypt(sample); });
}
void ChromiumCDMProxy::GetStatusForPolicy(PromiseId aPromiseId,
const nsAString& aMinHdcpVersion) {
MOZ_ASSERT(NS_IsMainThread());
EME_LOG("ChromiumCDMProxy::GetStatusForPolicy(this=%p, pid=%" PRIu32
") minHdcpVersion=%s",
this, aPromiseId, NS_ConvertUTF16toUTF8(aMinHdcpVersion).get());
RefPtr<gmp::ChromiumCDMParent> cdm = GetCDMParent();
if (!cdm) {
RejectPromise(aPromiseId, NS_ERROR_DOM_INVALID_STATE_ERR,
NS_LITERAL_CSTRING("Null CDM in GetStatusForPolicy"));
return;
}
mGMPThread->Dispatch(NewRunnableMethod<uint32_t, nsCString>(
"gmp::ChromiumCDMParent::GetStatusForPolicy", cdm,
&gmp::ChromiumCDMParent::GetStatusForPolicy, aPromiseId,
NS_ConvertUTF16toUTF8(aMinHdcpVersion)));
}
void ChromiumCDMProxy::Terminated() {
if (!mKeys.IsNull()) {
mKeys->Terminated();
}
}
already_AddRefed<gmp::ChromiumCDMParent> ChromiumCDMProxy::GetCDMParent() {
MutexAutoLock lock(mCDMMutex);
RefPtr<gmp::ChromiumCDMParent> cdm = mCDM;
return cdm.forget();
}
} // namespace mozilla
#undef NS_DispatchToMainThread