dom/indexedDB/IndexedDatabaseManager.h

   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
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_indexeddatabasemanager_h__
   8 #define mozilla_dom_indexeddatabasemanager_h__
   9
  10 #include "js/TypeDecls.h"
  11 #include "mozilla/Atomics.h"
  12 #include "mozilla/dom/quota/PersistenceType.h"
  13 #include "mozilla/Logging.h"
  14 #include "mozilla/Mutex.h"
  15 #include "nsClassHashtable.h"
  16 #include "nsHashKeys.h"
  17 #include "SafeRefPtr.h"
  18
  19 namespace mozilla {
  20
  21 class EventChainPostVisitor;
  22
  23 namespace dom {
  24
  25 class IDBFactory;
  26
  27 namespace indexedDB {
  28
  29 class BackgroundUtilsChild;
  30 class DatabaseFileManager;
  31 class FileManagerInfo;
  32
  33 }  // namespace indexedDB
  34
  35 class IndexedDatabaseManager final {
  36   using PersistenceType = mozilla::dom::quota::PersistenceType;
  37   using DatabaseFileManager = mozilla::dom::indexedDB::DatabaseFileManager;
  38   using FileManagerInfo = mozilla::dom::indexedDB::FileManagerInfo;
  39
  40  public:
  41   enum LoggingMode {
  42     Logging_Disabled = 0,
  43     Logging_Concise,
  44     Logging_Detailed,
  45     Logging_ConciseProfilerMarks,
  46     Logging_DetailedProfilerMarks
  47   };
  48
  49   NS_INLINE_DECL_REFCOUNTING_WITH_DESTROY(IndexedDatabaseManager, Destroy())
  50
  51   // Returns a non-owning reference.
  52   static IndexedDatabaseManager* GetOrCreate();
  53
  54   // Returns a non-owning reference.
  55   static IndexedDatabaseManager* Get();
  56
  57   static bool IsClosed();
  58
  59   static bool IsMainProcess()
  60 #ifdef DEBUG
  61       ;
  62 #else
  63   {
  64     return sIsMainProcess;
  65   }
  66 #endif
  67
  68   static bool FullSynchronous();
  69
  70   static LoggingMode GetLoggingMode()
  71 #ifdef DEBUG
  72       ;
  73 #else
  74   {
  75     return sLoggingMode;
  76   }
  77 #endif
  78
  79   static mozilla::LogModule* GetLoggingModule()
  80 #ifdef DEBUG
  81       ;
  82 #else
  83   {
  84     return sLoggingModule;
  85   }
  86 #endif
  87
  88   static uint32_t DataThreshold();
  89
  90   static uint32_t MaxSerializedMsgSize();
  91
  92   // The maximum number of extra entries to preload in an Cursor::OpenOp or
  93   // Cursor::ContinueOp.
  94   static int32_t MaxPreloadExtraRecords();
  95
  96   void ClearBackgroundActor();
  97
  98   [[nodiscard]] SafeRefPtr<DatabaseFileManager> GetFileManager(
  99       PersistenceType aPersistenceType, const nsACString& aOrigin,
 100       const nsAString& aDatabaseName);
 101
 102   [[nodiscard]] SafeRefPtr<DatabaseFileManager>
 103   GetFileManagerByDatabaseFilePath(PersistenceType aPersistenceType,
 104                                    const nsACString& aOrigin,
 105                                    const nsAString& aDatabaseFilePath);
 106
 107   const nsTArray<SafeRefPtr<DatabaseFileManager>>& GetFileManagers(
 108       PersistenceType aPersistenceType, const nsACString& aOrigin);
 109
 110   void AddFileManager(SafeRefPtr<DatabaseFileManager> aFileManager);
 111
 112   void InvalidateAllFileManagers();
 113
 114   void InvalidateFileManagers(PersistenceType aPersistenceType);
 115
 116   void InvalidateFileManagers(PersistenceType aPersistenceType,
 117                               const nsACString& aOrigin);
 118
 119   void InvalidateFileManager(PersistenceType aPersistenceType,
 120                              const nsACString& aOrigin,
 121                              const nsAString& aDatabaseName);
 122
 123   // Don't call this method in real code, it blocks the main thread!
 124   // It is intended to be used by mochitests to test correctness of the special
 125   // reference counting of stored blobs/files.
 126   nsresult BlockAndGetFileReferences(PersistenceType aPersistenceType,
 127                                      const nsACString& aOrigin,
 128                                      const nsAString& aDatabaseName,
 129                                      int64_t aFileId, int32_t* aRefCnt,
 130                                      int32_t* aDBRefCnt, bool* aResult);
 131
 132   nsresult FlushPendingFileDeletions();
 133
 134   // XXX This extra explicit initialization should go away with bug 1730706.
 135   nsresult EnsureLocale();
 136
 137   static const nsCString& GetLocale();
 138
 139   static bool ResolveSandboxBinding(JSContext* aCx);
 140
 141   static bool DefineIndexedDB(JSContext* aCx, JS::Handle<JSObject*> aGlobal);
 142
 143  private:
 144   IndexedDatabaseManager();
 145   ~IndexedDatabaseManager();
 146
 147   nsresult Init();
 148
 149   void Destroy();
 150
 151   static void LoggingModePrefChangedCallback(const char* aPrefName,
 152                                              void* aClosure);
 153
 154   // Maintains a list of all DatabaseFileManager objects per origin. This list
 155   // isn't protected by any mutex but it is only ever touched on the IO thread.
 156   nsClassHashtable<nsCStringHashKey, FileManagerInfo> mFileManagerInfos;
 157
 158   nsClassHashtable<nsRefPtrHashKey<DatabaseFileManager>, nsTArray<int64_t>>
 159       mPendingDeleteInfos;
 160
 161   nsCString mLocale;
 162
 163   indexedDB::BackgroundUtilsChild* mBackgroundActor;
 164
 165   static bool sIsMainProcess;
 166   static bool sFullSynchronousMode;
 167   static LazyLogModule sLoggingModule;
 168   static Atomic<LoggingMode> sLoggingMode;
 169 };
 170
 171 }  // namespace dom
 172 }  // namespace mozilla
 173
 174 #endif  // mozilla_dom_indexeddatabasemanager_h__