gecko-dev/dom/indexedDB/AsyncConnectionHelper.cpp

678 lines
18 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=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 "base/basictypes.h"
#include "AsyncConnectionHelper.h"
#include "mozilla/dom/quota/QuotaManager.h"
#include "mozilla/storage.h"
#include "nsComponentManagerUtils.h"
#include "nsContentUtils.h"
#include "nsProxyRelease.h"
#include "nsThreadUtils.h"
#include "nsWrapperCacheInlines.h"
#include "IDBEvents.h"
#include "IDBTransaction.h"
#include "IndexedDatabaseManager.h"
#include "TransactionThreadPool.h"
#include "ipc/IndexedDBChild.h"
#include "ipc/IndexedDBParent.h"
USING_INDEXEDDB_NAMESPACE
using mozilla::dom::quota::QuotaManager;
namespace {
IDBTransaction* gCurrentTransaction = nullptr;
const uint32_t kProgressHandlerGranularity = 1000;
class TransactionPoolEventTarget : public StackBasedEventTarget
{
public:
NS_DECL_NSIEVENTTARGET
TransactionPoolEventTarget(IDBTransaction* aTransaction)
: mTransaction(aTransaction)
{ }
private:
IDBTransaction* mTransaction;
};
// This inline is just so that we always clear aBuffers appropriately even if
// something fails.
inline
nsresult
ConvertCloneReadInfosToArrayInternal(
JSContext* aCx,
nsTArray<StructuredCloneReadInfo>& aReadInfos,
jsval* aResult)
{
JSObject* array = JS_NewArrayObject(aCx, 0, nullptr);
if (!array) {
NS_WARNING("Failed to make array!");
return NS_ERROR_DOM_INDEXEDDB_UNKNOWN_ERR;
}
if (!aReadInfos.IsEmpty()) {
if (!JS_SetArrayLength(aCx, array, uint32_t(aReadInfos.Length()))) {
NS_WARNING("Failed to set array length!");
return NS_ERROR_DOM_INDEXEDDB_UNKNOWN_ERR;
}
for (uint32_t index = 0, count = aReadInfos.Length(); index < count;
index++) {
StructuredCloneReadInfo& readInfo = aReadInfos[index];
jsval val;
if (!IDBObjectStore::DeserializeValue(aCx, readInfo, &val)) {
NS_WARNING("Failed to decode!");
return NS_ERROR_DOM_DATA_CLONE_ERR;
}
if (!JS_SetElement(aCx, array, index, &val)) {
NS_WARNING("Failed to set array element!");
return NS_ERROR_DOM_INDEXEDDB_UNKNOWN_ERR;
}
}
}
*aResult = OBJECT_TO_JSVAL(array);
return NS_OK;
}
} // anonymous namespace
HelperBase::~HelperBase()
{
if (!NS_IsMainThread()) {
IDBRequest* request;
mRequest.forget(&request);
if (request) {
nsCOMPtr<nsIThread> mainThread;
NS_GetMainThread(getter_AddRefs(mainThread));
NS_WARN_IF_FALSE(mainThread, "Couldn't get the main thread!");
if (mainThread) {
NS_ProxyRelease(mainThread, static_cast<nsIDOMEventTarget*>(request));
}
}
}
}
nsresult
HelperBase::WrapNative(JSContext* aCx,
nsISupports* aNative,
jsval* aResult)
{
NS_ASSERTION(aCx, "Null context!");
NS_ASSERTION(aNative, "Null pointer!");
NS_ASSERTION(aResult, "Null pointer!");
NS_ASSERTION(mRequest, "Null request!");
JSObject* global = mRequest->GetParentObject();
NS_ASSERTION(global, "This should never be null!");
nsresult rv =
nsContentUtils::WrapNative(aCx, global, aNative, aResult);
NS_ENSURE_SUCCESS(rv, NS_ERROR_DOM_INDEXEDDB_UNKNOWN_ERR);
return NS_OK;
}
void
HelperBase::ReleaseMainThreadObjects()
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
mRequest = nullptr;
}
AsyncConnectionHelper::AsyncConnectionHelper(IDBDatabase* aDatabase,
IDBRequest* aRequest)
: HelperBase(aRequest),
mDatabase(aDatabase),
mResultCode(NS_OK),
mDispatched(false)
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
}
AsyncConnectionHelper::AsyncConnectionHelper(IDBTransaction* aTransaction,
IDBRequest* aRequest)
: HelperBase(aRequest),
mDatabase(aTransaction->mDatabase),
mTransaction(aTransaction),
mResultCode(NS_OK),
mDispatched(false)
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
}
AsyncConnectionHelper::~AsyncConnectionHelper()
{
if (!NS_IsMainThread()) {
IDBDatabase* database;
mDatabase.forget(&database);
IDBTransaction* transaction;
mTransaction.forget(&transaction);
nsCOMPtr<nsIThread> mainThread;
NS_GetMainThread(getter_AddRefs(mainThread));
NS_WARN_IF_FALSE(mainThread, "Couldn't get the main thread!");
if (mainThread) {
if (database) {
NS_ProxyRelease(mainThread, static_cast<nsIIDBDatabase*>(database));
}
if (transaction) {
NS_ProxyRelease(mainThread,
static_cast<nsIIDBTransaction*>(transaction));
}
}
}
NS_ASSERTION(!mOldProgressHandler, "Should not have anything here!");
}
NS_IMPL_THREADSAFE_ISUPPORTS2(AsyncConnectionHelper, nsIRunnable,
mozIStorageProgressHandler)
NS_IMETHODIMP
AsyncConnectionHelper::Run()
{
if (NS_IsMainThread()) {
if (mTransaction &&
mTransaction->IsAborted()) {
// Always fire a "error" event with ABORT_ERR if the transaction was
// aborted, even if the request succeeded or failed with another error.
mResultCode = NS_ERROR_DOM_INDEXEDDB_ABORT_ERR;
}
IDBTransaction* oldTransaction = gCurrentTransaction;
gCurrentTransaction = mTransaction;
ChildProcessSendResult sendResult =
IndexedDatabaseManager::IsMainProcess() ?
MaybeSendResponseToChildProcess(mResultCode) :
Success_NotSent;
switch (sendResult) {
case Success_Sent: {
if (mRequest) {
mRequest->NotifyHelperSentResultsToChildProcess(NS_OK);
}
break;
}
case Success_NotSent: {
if (mRequest) {
nsresult rv = mRequest->NotifyHelperCompleted(this);
if (NS_SUCCEEDED(mResultCode) && NS_FAILED(rv)) {
mResultCode = rv;
}
}
// Call OnError if the database had an error or if the OnSuccess
// handler has an error.
if (NS_FAILED(mResultCode) ||
NS_FAILED((mResultCode = OnSuccess()))) {
OnError();
}
break;
}
case Success_ActorDisconnected: {
// Nothing needs to be done here.
break;
}
case Error: {
NS_WARNING("MaybeSendResultsToChildProcess failed!");
mResultCode = NS_ERROR_DOM_INDEXEDDB_UNKNOWN_ERR;
if (mRequest) {
mRequest->NotifyHelperSentResultsToChildProcess(mResultCode);
}
break;
}
default:
MOZ_NOT_REACHED("Unknown value for ChildProcessSendResult!");
}
NS_ASSERTION(gCurrentTransaction == mTransaction, "Should be unchanged!");
gCurrentTransaction = oldTransaction;
if (mDispatched && mTransaction) {
mTransaction->OnRequestFinished();
}
ReleaseMainThreadObjects();
NS_ASSERTION(!(mDatabase || mTransaction || mRequest), "Subclass didn't "
"call AsyncConnectionHelper::ReleaseMainThreadObjects!");
return NS_OK;
}
NS_ASSERTION(IndexedDatabaseManager::IsMainProcess(), "Wrong process!");
nsresult rv = NS_OK;
nsCOMPtr<mozIStorageConnection> connection;
if (mTransaction) {
rv = mTransaction->GetOrCreateConnection(getter_AddRefs(connection));
if (NS_SUCCEEDED(rv)) {
NS_ASSERTION(connection, "This should never be null!");
}
}
bool setProgressHandler = false;
if (connection) {
rv = connection->SetProgressHandler(kProgressHandlerGranularity, this,
getter_AddRefs(mOldProgressHandler));
NS_WARN_IF_FALSE(NS_SUCCEEDED(rv), "SetProgressHandler failed!");
if (NS_SUCCEEDED(rv)) {
setProgressHandler = true;
}
}
if (NS_SUCCEEDED(rv)) {
bool hasSavepoint = false;
if (mDatabase) {
QuotaManager::SetCurrentWindow(mDatabase->GetOwner());
// Make the first savepoint.
if (mTransaction) {
if (!(hasSavepoint = mTransaction->StartSavepoint())) {
NS_WARNING("Failed to make savepoint!");
}
}
}
mResultCode = DoDatabaseWork(connection);
if (mDatabase) {
// Release or roll back the savepoint depending on the error code.
if (hasSavepoint) {
NS_ASSERTION(mTransaction, "Huh?!");
if (NS_SUCCEEDED(mResultCode)) {
mTransaction->ReleaseSavepoint();
}
else {
mTransaction->RollbackSavepoint();
}
}
// Don't unset this until we're sure that all SQLite activity has
// completed!
QuotaManager::SetCurrentWindow(nullptr);
}
}
else {
// NS_ERROR_NOT_AVAILABLE is our special code for "database is invalidated"
// and we should fail with RECOVERABLE_ERR.
if (rv == NS_ERROR_NOT_AVAILABLE) {
mResultCode = NS_ERROR_DOM_INDEXEDDB_RECOVERABLE_ERR;
}
else {
mResultCode = NS_ERROR_DOM_INDEXEDDB_UNKNOWN_ERR;
}
}
if (setProgressHandler) {
nsCOMPtr<mozIStorageProgressHandler> handler;
rv = connection->RemoveProgressHandler(getter_AddRefs(handler));
NS_WARN_IF_FALSE(NS_SUCCEEDED(rv), "RemoveProgressHandler failed!");
#ifdef DEBUG
if (NS_SUCCEEDED(rv)) {
NS_ASSERTION(SameCOMIdentity(handler, static_cast<nsIRunnable*>(this)),
"Mismatch!");
}
#endif
}
return NS_DispatchToMainThread(this, NS_DISPATCH_NORMAL);
}
NS_IMETHODIMP
AsyncConnectionHelper::OnProgress(mozIStorageConnection* aConnection,
bool* _retval)
{
if (mDatabase && mDatabase->IsInvalidated()) {
// Someone is trying to delete the database file. Exit lightningfast!
*_retval = true;
return NS_OK;
}
if (mOldProgressHandler) {
return mOldProgressHandler->OnProgress(aConnection, _retval);
}
*_retval = false;
return NS_OK;
}
nsresult
AsyncConnectionHelper::Dispatch(nsIEventTarget* aTarget)
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
nsresult rv = Init();
if (NS_FAILED(rv)) {
return rv;
}
rv = aTarget->Dispatch(this, NS_DISPATCH_NORMAL);
NS_ENSURE_SUCCESS(rv, rv);
if (mTransaction) {
mTransaction->OnNewRequest();
}
mDispatched = true;
return NS_OK;
}
nsresult
AsyncConnectionHelper::DispatchToTransactionPool()
{
NS_ASSERTION(mTransaction, "Only ok to call this with a transaction!");
TransactionPoolEventTarget target(mTransaction);
return Dispatch(&target);
}
// static
void
AsyncConnectionHelper::SetCurrentTransaction(IDBTransaction* aTransaction)
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
NS_ASSERTION(!aTransaction || !gCurrentTransaction,
"Stepping on another transaction!");
gCurrentTransaction = aTransaction;
}
// static
IDBTransaction*
AsyncConnectionHelper::GetCurrentTransaction()
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
return gCurrentTransaction;
}
nsresult
AsyncConnectionHelper::Init()
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
return NS_OK;
}
already_AddRefed<nsDOMEvent>
AsyncConnectionHelper::CreateSuccessEvent()
{
return CreateGenericEvent(NS_LITERAL_STRING(SUCCESS_EVT_STR),
eDoesNotBubble, eNotCancelable);
}
nsresult
AsyncConnectionHelper::OnSuccess()
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
NS_ASSERTION(mRequest, "Null request!");
nsRefPtr<nsDOMEvent> event = CreateSuccessEvent();
if (!event) {
NS_ERROR("Failed to create event!");
return NS_ERROR_DOM_INDEXEDDB_UNKNOWN_ERR;
}
bool dummy;
nsresult rv = mRequest->DispatchEvent(event, &dummy);
NS_ENSURE_SUCCESS(rv, NS_ERROR_DOM_INDEXEDDB_UNKNOWN_ERR);
nsEvent* internalEvent = event->GetInternalNSEvent();
NS_ASSERTION(internalEvent, "This should never be null!");
NS_ASSERTION(!mTransaction ||
mTransaction->IsOpen() ||
mTransaction->IsAborted(),
"How else can this be closed?!");
if (internalEvent->mFlags.mExceptionHasBeenRisen &&
mTransaction &&
mTransaction->IsOpen()) {
rv = mTransaction->Abort(NS_ERROR_DOM_INDEXEDDB_ABORT_ERR);
NS_ENSURE_SUCCESS(rv, rv);
}
return NS_OK;
}
void
AsyncConnectionHelper::OnError()
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
NS_ASSERTION(mRequest, "Null request!");
// Make an error event and fire it at the target.
nsRefPtr<nsDOMEvent> event =
CreateGenericEvent(NS_LITERAL_STRING(ERROR_EVT_STR), eDoesBubble,
eCancelable);
if (!event) {
NS_ERROR("Failed to create event!");
return;
}
bool doDefault;
nsresult rv = mRequest->DispatchEvent(event, &doDefault);
if (NS_SUCCEEDED(rv)) {
NS_ASSERTION(!mTransaction ||
mTransaction->IsOpen() ||
mTransaction->IsAborted(),
"How else can this be closed?!");
nsEvent* internalEvent = event->GetInternalNSEvent();
NS_ASSERTION(internalEvent, "This should never be null!");
if (internalEvent->mFlags.mExceptionHasBeenRisen &&
mTransaction &&
mTransaction->IsOpen() &&
NS_FAILED(mTransaction->Abort(NS_ERROR_DOM_INDEXEDDB_ABORT_ERR))) {
NS_WARNING("Failed to abort transaction!");
}
if (doDefault &&
mTransaction &&
mTransaction->IsOpen() &&
NS_FAILED(mTransaction->Abort(mRequest))) {
NS_WARNING("Failed to abort transaction!");
}
}
else {
NS_WARNING("DispatchEvent failed!");
}
}
nsresult
AsyncConnectionHelper::GetSuccessResult(JSContext* aCx,
jsval* aVal)
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
*aVal = JSVAL_VOID;
return NS_OK;
}
void
AsyncConnectionHelper::ReleaseMainThreadObjects()
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
mDatabase = nullptr;
mTransaction = nullptr;
HelperBase::ReleaseMainThreadObjects();
}
AsyncConnectionHelper::ChildProcessSendResult
AsyncConnectionHelper::MaybeSendResponseToChildProcess(nsresult aResultCode)
{
NS_ASSERTION(NS_IsMainThread(), "Wrong thread!");
NS_ASSERTION(IndexedDatabaseManager::IsMainProcess(), "Wrong process!");
// If there's no request, there could never have been an actor, and so there
// is nothing to do.
if (!mRequest) {
return Success_NotSent;
}
IDBTransaction* trans = GetCurrentTransaction();
// We may not have a transaction, e.g. for deleteDatabase
if (!trans) {
return Success_NotSent;
}
// Are we shutting down the child?
IndexedDBDatabaseParent* dbActor = trans->Database()->GetActorParent();
if (dbActor && dbActor->IsDisconnected()) {
return Success_ActorDisconnected;
}
IndexedDBRequestParentBase* actor = mRequest->GetActorParent();
if (!actor) {
return Success_NotSent;
}
return SendResponseToChildProcess(aResultCode);
}
nsresult
AsyncConnectionHelper::OnParentProcessRequestComplete(
const ResponseValue& aResponseValue)
{
NS_ASSERTION(!IndexedDatabaseManager::IsMainProcess(), "Wrong process!");
if (aResponseValue.type() == ResponseValue::Tnsresult) {
NS_ASSERTION(NS_FAILED(aResponseValue.get_nsresult()), "Huh?");
SetError(aResponseValue.get_nsresult());
}
else {
nsresult rv = UnpackResponseFromParentProcess(aResponseValue);
NS_ENSURE_SUCCESS(rv, rv);
}
return Run();
}
// static
nsresult
AsyncConnectionHelper::ConvertToArrayAndCleanup(
JSContext* aCx,
nsTArray<StructuredCloneReadInfo>& aReadInfos,
jsval* aResult)
{
NS_ASSERTION(aCx, "Null context!");
NS_ASSERTION(aResult, "Null pointer!");
JSAutoRequest ar(aCx);
nsresult rv = ConvertCloneReadInfosToArrayInternal(aCx, aReadInfos, aResult);
for (uint32_t index = 0; index < aReadInfos.Length(); index++) {
aReadInfos[index].mCloneBuffer.clear();
}
aReadInfos.Clear();
return rv;
}
NS_IMETHODIMP_(nsrefcnt)
StackBasedEventTarget::AddRef()
{
NS_NOTREACHED("Don't call me!");
return 2;
}
NS_IMETHODIMP_(nsrefcnt)
StackBasedEventTarget::Release()
{
NS_NOTREACHED("Don't call me!");
return 1;
}
NS_IMETHODIMP
StackBasedEventTarget::QueryInterface(REFNSIID aIID,
void** aInstancePtr)
{
NS_NOTREACHED("Don't call me!");
return NS_NOINTERFACE;
}
NS_IMETHODIMP
MainThreadEventTarget::Dispatch(nsIRunnable* aRunnable,
uint32_t aFlags)
{
NS_ASSERTION(aRunnable, "Null pointer!");
nsCOMPtr<nsIRunnable> runnable = aRunnable;
return NS_DispatchToMainThread(aRunnable, aFlags);
}
NS_IMETHODIMP
MainThreadEventTarget::IsOnCurrentThread(bool* aIsOnCurrentThread)
{
*aIsOnCurrentThread = NS_IsMainThread();
return NS_OK;
}
NS_IMETHODIMP
TransactionPoolEventTarget::Dispatch(nsIRunnable* aRunnable,
uint32_t aFlags)
{
NS_ASSERTION(aRunnable, "Null pointer!");
NS_ASSERTION(aFlags == NS_DISPATCH_NORMAL, "Unsupported!");
TransactionThreadPool* pool = TransactionThreadPool::GetOrCreate();
NS_ENSURE_TRUE(pool, NS_ERROR_UNEXPECTED);
nsresult rv = pool->Dispatch(mTransaction, aRunnable, false, nullptr);
NS_ENSURE_SUCCESS(rv, rv);
return NS_OK;
}
NS_IMETHODIMP
TransactionPoolEventTarget::IsOnCurrentThread(bool* aIsOnCurrentThread)
{
*aIsOnCurrentThread = false;
return NS_OK;
}
NS_IMETHODIMP
NoDispatchEventTarget::Dispatch(nsIRunnable* aRunnable,
uint32_t aFlags)
{
nsCOMPtr<nsIRunnable> runnable = aRunnable;
return NS_OK;
}
NS_IMETHODIMP
NoDispatchEventTarget::IsOnCurrentThread(bool* aIsOnCurrentThread)
{
*aIsOnCurrentThread = true;
return NS_OK;
}