dom/quota/CachingDatabaseConnection.cpp

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "mozilla/dom/quota/CachingDatabaseConnection.h"
   8
   9 #include "GeckoProfiler.h"
  10 #include "mozilla/ipc/BackgroundParent.h"
  11
  12 namespace mozilla::dom::quota {
  13
  14 CachingDatabaseConnection::CachingDatabaseConnection(
  15     MovingNotNull<nsCOMPtr<mozIStorageConnection>> aStorageConnection)
  16     :
  17 #ifdef MOZ_THREAD_SAFETY_OWNERSHIP_CHECKS_SUPPORTED
  18       mOwningThread{nsAutoOwningThread{}},
  19 #endif
  20       mStorageConnection(std::move(aStorageConnection)) {
  21 }
  22
  23 void CachingDatabaseConnection::LazyInit(
  24     MovingNotNull<nsCOMPtr<mozIStorageConnection>> aStorageConnection) {
  25 #ifdef MOZ_THREAD_SAFETY_OWNERSHIP_CHECKS_SUPPORTED
  26   mOwningThread.init();
  27 #endif
  28   mStorageConnection.init(std::move(aStorageConnection));
  29 }
  30
  31 Result<CachingDatabaseConnection::CachedStatement, nsresult>
  32 CachingDatabaseConnection::GetCachedStatement(const nsACString& aQuery) {
  33   AssertIsOnConnectionThread();
  34   MOZ_ASSERT(!aQuery.IsEmpty());
  35   MOZ_ASSERT(mStorageConnection);
  36
  37   AUTO_PROFILER_LABEL("CachingDatabaseConnection::GetCachedStatement", DOM);
  38
  39   nsCOMPtr<mozIStorageStatement> stmt;
  40
  41   if (!mCachedStatements.Get(aQuery, getter_AddRefs(stmt))) {
  42     const auto extraInfo =
  43         ScopedLogExtraInfo{ScopedLogExtraInfo::kTagQuery, aQuery};
  44
  45     QM_TRY_UNWRAP(
  46         stmt,
  47         MOZ_TO_RESULT_INVOKE_TYPED(nsCOMPtr<mozIStorageStatement>,
  48                                    **mStorageConnection, CreateStatement,
  49                                    aQuery),
  50         QM_PROPAGATE,
  51         ([&aQuery, &storageConnection = **mStorageConnection](const auto&) {
  52 #ifdef DEBUG
  53           nsCString msg;
  54           MOZ_ALWAYS_SUCCEEDS(storageConnection.GetLastErrorString(msg));
  55
  56           nsAutoCString error =
  57               "The statement '"_ns + aQuery +
  58               "' failed to compile with the error message '"_ns + msg + "'."_ns;
  59
  60           NS_WARNING(error.get());
  61 #else
  62           (void)aQuery;
  63 #endif
  64         }));
  65
  66     mCachedStatements.Put(aQuery, stmt);
  67   }
  68
  69   return CachedStatement{this, std::move(stmt), aQuery};
  70 }
  71
  72 Result<CachingDatabaseConnection::BorrowedStatement, nsresult>
  73 CachingDatabaseConnection::BorrowCachedStatement(const nsACString& aQuery) {
  74   QM_TRY_UNWRAP(auto cachedStatement, GetCachedStatement(aQuery));
  75
  76   return cachedStatement.Borrow();
  77 }
  78
  79 nsresult CachingDatabaseConnection::ExecuteCachedStatement(
  80     const nsACString& aQuery) {
  81   return ExecuteCachedStatement(aQuery, [](auto&) { return NS_OK; });
  82 }
  83
  84 void CachingDatabaseConnection::Close() {
  85   AssertIsOnConnectionThread();
  86   MOZ_ASSERT(HasStorageConnection());
  87
  88   AUTO_PROFILER_LABEL("CachingDatabaseConnection::Close", DOM);
  89
  90   mCachedStatements.Clear();
  91
  92   MOZ_ALWAYS_SUCCEEDS((*mStorageConnection)->Close());
  93   mStorageConnection.destroy();
  94 }
  95
  96 #if defined(DEBUG) || defined(NS_BUILD_REFCNT_LOGGING)
  97 CachingDatabaseConnection::CachedStatement::CachedStatement()
  98 #  ifdef DEBUG
  99     : mDEBUGConnection(nullptr)
 100 #  endif
 101 {
 102   AssertIsOnConnectionThread();
 103
 104   MOZ_COUNT_CTOR(CachingDatabaseConnection::CachedStatement);
 105 }
 106
 107 CachingDatabaseConnection::CachedStatement::~CachedStatement() {
 108   AssertIsOnConnectionThread();
 109
 110   MOZ_COUNT_DTOR(CachingDatabaseConnection::CachedStatement);
 111 }
 112 #endif
 113
 114 CachingDatabaseConnection::CachedStatement::operator bool() const {
 115   AssertIsOnConnectionThread();
 116
 117   return mStatement;
 118 }
 119
 120 mozIStorageStatement& CachingDatabaseConnection::BorrowedStatement::operator*()
 121     const {
 122   return *operator->();
 123 }
 124
 125 mozIStorageStatement* CachingDatabaseConnection::BorrowedStatement::operator->()
 126     const {
 127   MOZ_ASSERT(mStatement);
 128
 129   return mStatement;
 130 }
 131
 132 CachingDatabaseConnection::BorrowedStatement
 133 CachingDatabaseConnection::CachedStatement::Borrow() const {
 134   AssertIsOnConnectionThread();
 135
 136 #if defined(EARLY_BETA_OR_EARLIER) || defined(DEBUG)
 137   return BorrowedStatement{WrapNotNull(mStatement), mQuery};
 138 #else
 139   return BorrowedStatement{WrapNotNull(mStatement)};
 140 #endif
 141 }
 142
 143 CachingDatabaseConnection::CachedStatement::CachedStatement(
 144     CachingDatabaseConnection* aConnection,
 145     nsCOMPtr<mozIStorageStatement> aStatement, const nsACString& aQuery)
 146     : mStatement(std::move(aStatement))
 147 #if defined(EARLY_BETA_OR_EARLIER) || defined(DEBUG)
 148       ,
 149       mQuery(aQuery)
 150 #endif
 151 #if defined(DEBUG)
 152       ,
 153       mDEBUGConnection(aConnection)
 154 #endif
 155 {
 156 #ifdef DEBUG
 157   MOZ_ASSERT(aConnection);
 158   aConnection->AssertIsOnConnectionThread();
 159 #endif
 160   MOZ_ASSERT(mStatement);
 161   AssertIsOnConnectionThread();
 162
 163   MOZ_COUNT_CTOR(CachingDatabaseConnection::CachedStatement);
 164 }
 165
 166 void CachingDatabaseConnection::CachedStatement::AssertIsOnConnectionThread()
 167     const {
 168 #ifdef DEBUG
 169   if (mDEBUGConnection) {
 170     mDEBUGConnection->AssertIsOnConnectionThread();
 171   }
 172   MOZ_ASSERT(!NS_IsMainThread());
 173   MOZ_ASSERT(!mozilla::ipc::IsOnBackgroundThread());
 174 #endif
 175 }
 176
 177 Result<CachingDatabaseConnection::BorrowedStatement, nsresult>
 178 CachingDatabaseConnection::LazyStatement::Borrow() {
 179   if (!mCachedStatement) {
 180     QM_TRY(Initialize());
 181   }
 182
 183   return mCachedStatement.Borrow();
 184 }
 185
 186 Result<Ok, nsresult> CachingDatabaseConnection::LazyStatement::Initialize() {
 187   QM_TRY_UNWRAP(mCachedStatement, mConnection.GetCachedStatement(mQueryString));
 188   return Ok{};
 189 }
 190
 191 }  // namespace mozilla::dom::quota