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   void AddFileManager(SafeRefPtr<DatabaseFileManager> aFileManager);
 103
 104   void InvalidateAllFileManagers();
 105
 106   void InvalidateFileManagers(PersistenceType aPersistenceType);
 107
 108   void InvalidateFileManagers(PersistenceType aPersistenceType,
 109                               const nsACString& aOrigin);
 110
 111   void InvalidateFileManager(PersistenceType aPersistenceType,
 112                              const nsACString& aOrigin,
 113                              const nsAString& aDatabaseName);
 114
 115   // Don't call this method in real code, it blocks the main thread!
 116   // It is intended to be used by mochitests to test correctness of the special
 117   // reference counting of stored blobs/files.
 118   nsresult BlockAndGetFileReferences(PersistenceType aPersistenceType,
 119                                      const nsACString& aOrigin,
 120                                      const nsAString& aDatabaseName,
 121                                      int64_t aFileId, int32_t* aRefCnt,
 122                                      int32_t* aDBRefCnt, bool* aResult);
 123
 124   nsresult FlushPendingFileDeletions();
 125
 126   static const nsCString& GetLocale();
 127
 128   static bool ResolveSandboxBinding(JSContext* aCx);
 129
 130   static bool DefineIndexedDB(JSContext* aCx, JS::Handle<JSObject*> aGlobal);
 131
 132  private:
 133   IndexedDatabaseManager();
 134   ~IndexedDatabaseManager();
 135
 136   nsresult Init();
 137
 138   void Destroy();
 139
 140   static void LoggingModePrefChangedCallback(const char* aPrefName,
 141                                              void* aClosure);
 142
 143   // Maintains a list of all DatabaseFileManager objects per origin. This list
 144   // isn't protected by any mutex but it is only ever touched on the IO thread.
 145   nsClassHashtable<nsCStringHashKey, FileManagerInfo> mFileManagerInfos;
 146
 147   nsClassHashtable<nsRefPtrHashKey<DatabaseFileManager>, nsTArray<int64_t>>
 148       mPendingDeleteInfos;
 149
 150   nsCString mLocale;
 151
 152   indexedDB::BackgroundUtilsChild* mBackgroundActor;
 153
 154   static bool sIsMainProcess;
 155   static bool sFullSynchronousMode;
 156   static LazyLogModule sLoggingModule;
 157   static Atomic<LoggingMode> sLoggingMode;
 158 };
 159
 160 }  // namespace dom
 161 }  // namespace mozilla
 162
 163 #endif  // mozilla_dom_indexeddatabasemanager_h__