Source/WebCore/Modules/indexeddb/server/UniqueIDBDatabase.h

   1 /*
   2  * Copyright (C) 2015 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #pragma once
  27
  28 #if ENABLE(INDEXED_DATABASE)
  29
  30 #include "IDBBackingStore.h"
  31 #include "IDBBindingUtilities.h"
  32 #include "IDBDatabaseIdentifier.h"
  33 #include "IDBDatabaseInfo.h"
  34 #include "IDBGetResult.h"
  35 #include "ServerOpenDBRequest.h"
  36 #include "ThreadSafeDataBuffer.h"
  37 #include "Timer.h"
  38 #include "UniqueIDBDatabaseConnection.h"
  39 #include "UniqueIDBDatabaseTransaction.h"
  40 #include <wtf/CrossThreadQueue.h>
  41 #include <wtf/CrossThreadTask.h>
  42 #include <wtf/Deque.h>
  43 #include <wtf/HashCountedSet.h>
  44 #include <wtf/HashSet.h>
  45 #include <wtf/ListHashSet.h>
  46 #include <wtf/Ref.h>
  47 #include <wtf/ThreadSafeRefCounted.h>
  48
  49 namespace JSC {
  50 class VM;
  51 }
  52
  53 namespace WebCore {
  54
  55 class IDBError;
  56 class IDBGetAllResult;
  57 class IDBRequestData;
  58 class IDBTransactionInfo;
  59
  60 enum class IDBGetRecordDataType;
  61
  62 namespace IndexedDB {
  63 enum class IndexRecordType;
  64 }
  65
  66 namespace IDBServer {
  67
  68 class IDBConnectionToClient;
  69 class IDBServer;
  70
  71 typedef std::function<void(const IDBError&)> ErrorCallback;
  72 typedef std::function<void(const IDBError&, const IDBKeyData&)> KeyDataCallback;
  73 typedef std::function<void(const IDBError&, const IDBGetResult&)> GetResultCallback;
  74 typedef std::function<void(const IDBError&, const IDBGetAllResult&)> GetAllResultsCallback;
  75 typedef std::function<void(const IDBError&, uint64_t)> CountCallback;
  76
  77 class UniqueIDBDatabase : public ThreadSafeRefCounted<UniqueIDBDatabase> {
  78 public:
  79     static Ref<UniqueIDBDatabase> create(IDBServer& server, const IDBDatabaseIdentifier& identifier)
  80     {
  81         return adoptRef(*new UniqueIDBDatabase(server, identifier));
  82     }
  83
  84     WEBCORE_EXPORT ~UniqueIDBDatabase();
  85
  86     void openDatabaseConnection(IDBConnectionToClient&, const IDBRequestData&);
  87
  88     const IDBDatabaseInfo& info() const;
  89     IDBServer& server() { return m_server; }
  90     const IDBDatabaseIdentifier& identifier() const { return m_identifier; }
  91
  92     void createObjectStore(UniqueIDBDatabaseTransaction&, const IDBObjectStoreInfo&, ErrorCallback);
  93     void deleteObjectStore(UniqueIDBDatabaseTransaction&, const String& objectStoreName, ErrorCallback);
  94     void renameObjectStore(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& newName, ErrorCallback);
  95     void clearObjectStore(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, ErrorCallback);
  96     void createIndex(UniqueIDBDatabaseTransaction&, const IDBIndexInfo&, ErrorCallback);
  97     void deleteIndex(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& indexName, ErrorCallback);
  98     void renameIndex(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName, ErrorCallback);
  99     void putOrAdd(const IDBRequestData&, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode, KeyDataCallback);
 100     void getRecord(const IDBRequestData&, const IDBGetRecordData&, GetResultCallback);
 101     void getAllRecords(const IDBRequestData&, const IDBGetAllRecordsData&, GetAllResultsCallback);
 102     void getCount(const IDBRequestData&, const IDBKeyRangeData&, CountCallback);
 103     void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&, ErrorCallback);
 104     void openCursor(const IDBRequestData&, const IDBCursorInfo&, GetResultCallback);
 105     void iterateCursor(const IDBRequestData&, const IDBIterateCursorData&, GetResultCallback);
 106     void commitTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
 107     void abortTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
 108     void didFinishHandlingVersionChange(UniqueIDBDatabaseConnection&, const IDBResourceIdentifier& transactionIdentifier);
 109     void transactionDestroyed(UniqueIDBDatabaseTransaction&);
 110     void connectionClosedFromClient(UniqueIDBDatabaseConnection&);
 111     void confirmConnectionClosedOnServer(UniqueIDBDatabaseConnection&);
 112     void didFireVersionChangeEvent(UniqueIDBDatabaseConnection&, const IDBResourceIdentifier& requestIdentifier);
 113     void openDBRequestCancelled(const IDBResourceIdentifier& requestIdentifier);
 114     void confirmDidCloseFromServer(UniqueIDBDatabaseConnection&);
 115
 116     void enqueueTransaction(Ref<UniqueIDBDatabaseTransaction>&&);
 117
 118     void handleDelete(IDBConnectionToClient&, const IDBRequestData&);
 119     void immediateCloseForUserDelete();
 120
 121     static JSC::VM& databaseThreadVM();
 122     static JSC::ExecState& databaseThreadExecState();
 123
 124     bool hardClosedForUserDelete() const { return m_hardClosedForUserDelete; }
 125
 126 private:
 127     UniqueIDBDatabase(IDBServer&, const IDBDatabaseIdentifier&);
 128
 129     void handleDatabaseOperations();
 130     void handleCurrentOperation();
 131     void performCurrentOpenOperation();
 132     void performCurrentDeleteOperation();
 133     void addOpenDatabaseConnection(Ref<UniqueIDBDatabaseConnection>&&);
 134     bool hasAnyOpenConnections() const;
 135     bool allConnectionsAreClosedOrClosing() const;
 136
 137     void startVersionChangeTransaction();
 138     void maybeNotifyConnectionsOfVersionChange();
 139     void notifyCurrentRequestConnectionClosedOrFiredVersionChangeEvent(uint64_t connectionIdentifier);
 140     bool isVersionChangeInProgress();
 141
 142     void activateTransactionInBackingStore(UniqueIDBDatabaseTransaction&);
 143     void transactionCompleted(RefPtr<UniqueIDBDatabaseTransaction>&&);
 144
 145     void connectionClosedFromServer(UniqueIDBDatabaseConnection&);
 146
 147     // Database thread operations
 148     void deleteBackingStore(const IDBDatabaseIdentifier&);
 149     void openBackingStore(const IDBDatabaseIdentifier&);
 150     void performCommitTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
 151     void performAbortTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
 152     void beginTransactionInBackingStore(const IDBTransactionInfo&);
 153     void performCreateObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&);
 154     void performDeleteObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier);
 155     void performRenameObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const String& newName);
 156     void performClearObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier);
 157     void performCreateIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBIndexInfo&);
 158     void performDeleteIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier);
 159     void performRenameIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName);
 160     void performPutOrAdd(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode);
 161     void performGetRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&, IDBGetRecordDataType);
 162     void performGetAllRecords(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBGetAllRecordsData&);
 163     void performGetIndexRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, IndexedDB::IndexRecordType, const IDBKeyRangeData&);
 164     void performGetCount(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const IDBKeyRangeData&);
 165     void performDeleteRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&);
 166     void performOpenCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBCursorInfo&);
 167     void performIterateCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBResourceIdentifier& cursorIdentifier, const IDBIterateCursorData&);
 168     void performPrefetchCursor(const IDBResourceIdentifier& transactionIdentifier, const IDBResourceIdentifier& cursorIdentifier);
 169
 170     void performActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBTransactionInfo&);
 171     void performUnconditionalDeleteBackingStore();
 172
 173     // Main thread callbacks
 174     void didDeleteBackingStore(uint64_t deletedVersion);
 175     void didOpenBackingStore(const IDBDatabaseInfo&, const IDBError&);
 176     void didPerformCreateObjectStore(uint64_t callbackIdentifier, const IDBError&, const IDBObjectStoreInfo&);
 177     void didPerformDeleteObjectStore(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier);
 178     void didPerformRenameObjectStore(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, const String& newName);
 179     void didPerformClearObjectStore(uint64_t callbackIdentifier, const IDBError&);
 180     void didPerformCreateIndex(uint64_t callbackIdentifier, const IDBError&, const IDBIndexInfo&);
 181     void didPerformDeleteIndex(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier);
 182     void didPerformRenameIndex(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName);
 183     void didPerformPutOrAdd(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
 184     void didPerformGetRecord(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
 185     void didPerformGetAllRecords(uint64_t callbackIdentifier, const IDBError&, const IDBGetAllResult&);
 186     void didPerformGetCount(uint64_t callbackIdentifier, const IDBError&, uint64_t);
 187     void didPerformDeleteRecord(uint64_t callbackIdentifier, const IDBError&);
 188     void didPerformOpenCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
 189     void didPerformIterateCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
 190     void didPerformCommitTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
 191     void didPerformAbortTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
 192     void didPerformActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBError&);
 193     void didPerformUnconditionalDeleteBackingStore();
 194
 195     uint64_t storeCallbackOrFireError(ErrorCallback);
 196     uint64_t storeCallbackOrFireError(KeyDataCallback);
 197     uint64_t storeCallbackOrFireError(GetAllResultsCallback);
 198     uint64_t storeCallbackOrFireError(GetResultCallback);
 199     uint64_t storeCallbackOrFireError(CountCallback);
 200
 201     void performErrorCallback(uint64_t callbackIdentifier, const IDBError&);
 202     void performKeyDataCallback(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
 203     void performGetResultCallback(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
 204     void performGetAllResultsCallback(uint64_t callbackIdentifier, const IDBError&, const IDBGetAllResult&);
 205     void performCountCallback(uint64_t callbackIdentifier, const IDBError&, uint64_t);
 206
 207     void forgetErrorCallback(uint64_t callbackIdentifier);
 208
 209     bool hasAnyPendingCallbacks() const;
 210     bool isCurrentlyInUse() const;
 211     bool hasUnfinishedTransactions() const;
 212
 213     void invokeOperationAndTransactionTimer();
 214     void operationAndTransactionTimerFired();
 215     RefPtr<UniqueIDBDatabaseTransaction> takeNextRunnableTransaction(bool& hadDeferredTransactions);
 216
 217     bool prepareToFinishTransaction(UniqueIDBDatabaseTransaction&);
 218
 219     void postDatabaseTask(CrossThreadTask&&);
 220     void postDatabaseTaskReply(CrossThreadTask&&);
 221     void executeNextDatabaseTask();
 222     void executeNextDatabaseTaskReply();
 223
 224     void maybeFinishHardClose();
 225     bool isDoneWithHardClose();
 226
 227     IDBServer& m_server;
 228     IDBDatabaseIdentifier m_identifier;
 229
 230     ListHashSet<RefPtr<ServerOpenDBRequest>> m_pendingOpenDBRequests;
 231     RefPtr<ServerOpenDBRequest> m_currentOpenDBRequest;
 232
 233     ListHashSet<RefPtr<UniqueIDBDatabaseConnection>> m_openDatabaseConnections;
 234     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_clientClosePendingDatabaseConnections;
 235     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_serverClosePendingDatabaseConnections;
 236
 237     RefPtr<UniqueIDBDatabaseConnection> m_versionChangeDatabaseConnection;
 238     RefPtr<UniqueIDBDatabaseTransaction> m_versionChangeTransaction;
 239
 240     bool m_isOpeningBackingStore { false };
 241     IDBError m_backingStoreOpenError;
 242     std::unique_ptr<IDBBackingStore> m_backingStore;
 243     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
 244     std::unique_ptr<IDBDatabaseInfo> m_mostRecentDeletedDatabaseInfo;
 245
 246     bool m_backingStoreSupportsSimultaneousTransactions { false };
 247     bool m_backingStoreIsEphemeral { false };
 248
 249     HashMap<uint64_t, ErrorCallback> m_errorCallbacks;
 250     HashMap<uint64_t, KeyDataCallback> m_keyDataCallbacks;
 251     HashMap<uint64_t, GetResultCallback> m_getResultCallbacks;
 252     HashMap<uint64_t, GetAllResultsCallback> m_getAllResultsCallbacks;
 253     HashMap<uint64_t, CountCallback> m_countCallbacks;
 254
 255     Timer m_operationAndTransactionTimer;
 256
 257     Deque<RefPtr<UniqueIDBDatabaseTransaction>> m_pendingTransactions;
 258     HashMap<IDBResourceIdentifier, RefPtr<UniqueIDBDatabaseTransaction>> m_inProgressTransactions;
 259     HashMap<IDBResourceIdentifier, RefPtr<UniqueIDBDatabaseTransaction>> m_finishingTransactions;
 260
 261     // The keys into these sets are the object store ID.
 262     // These sets help to decide which transactions can be started and which must be deferred.
 263     HashCountedSet<uint64_t> m_objectStoreTransactionCounts;
 264     HashSet<uint64_t> m_objectStoreWriteTransactions;
 265
 266     bool m_deleteBackingStoreInProgress { false };
 267
 268     CrossThreadQueue<CrossThreadTask> m_databaseQueue;
 269     CrossThreadQueue<CrossThreadTask> m_databaseReplyQueue;
 270     std::atomic<uint64_t> m_queuedTaskCount { 0 };
 271
 272     bool m_hardClosedForUserDelete { false };
 273     RefPtr<UniqueIDBDatabase> m_hardCloseProtector;
 274 };
 275
 276 } // namespace IDBServer
 277 } // namespace WebCore
 278
 279 #endif // ENABLE(INDEXED_DATABASE)