819a5ead5d4e668ac40e9f5e3c6e29f06a158840
[WebKit-https.git] / 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/Function.h>
44 #include <wtf/HashCountedSet.h>
45 #include <wtf/HashSet.h>
46 #include <wtf/ListHashSet.h>
47 #include <wtf/Ref.h>
48 #include <wtf/ThreadSafeRefCounted.h>
49
50 namespace JSC {
51 class VM;
52 }
53
54 namespace WebCore {
55
56 class IDBError;
57 class IDBGetAllResult;
58 class IDBRequestData;
59 class IDBTransactionInfo;
60
61 enum class IDBGetRecordDataType;
62
63 namespace IndexedDB {
64 enum class IndexRecordType;
65 }
66
67 namespace IDBServer {
68
69 class IDBConnectionToClient;
70 class IDBServer;
71
72 typedef Function<void(const IDBError&)> ErrorCallback;
73 typedef Function<void(const IDBError&, const IDBKeyData&)> KeyDataCallback;
74 typedef Function<void(const IDBError&, const IDBGetResult&)> GetResultCallback;
75 typedef Function<void(const IDBError&, const IDBGetAllResult&)> GetAllResultsCallback;
76 typedef Function<void(const IDBError&, uint64_t)> CountCallback;
77
78 class UniqueIDBDatabase : public ThreadSafeRefCounted<UniqueIDBDatabase> {
79 public:
80     static Ref<UniqueIDBDatabase> create(IDBServer& server, const IDBDatabaseIdentifier& identifier)
81     {
82         return adoptRef(*new UniqueIDBDatabase(server, identifier));
83     }
84
85     WEBCORE_EXPORT ~UniqueIDBDatabase();
86
87     void openDatabaseConnection(IDBConnectionToClient&, const IDBRequestData&);
88
89     const IDBDatabaseInfo& info() const;
90     IDBServer& server() { return m_server; }
91     const IDBDatabaseIdentifier& identifier() const { return m_identifier; }
92
93     void createObjectStore(UniqueIDBDatabaseTransaction&, const IDBObjectStoreInfo&, ErrorCallback);
94     void deleteObjectStore(UniqueIDBDatabaseTransaction&, const String& objectStoreName, ErrorCallback);
95     void renameObjectStore(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& newName, ErrorCallback);
96     void clearObjectStore(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, ErrorCallback);
97     void createIndex(UniqueIDBDatabaseTransaction&, const IDBIndexInfo&, ErrorCallback);
98     void deleteIndex(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& indexName, ErrorCallback);
99     void renameIndex(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName, ErrorCallback);
100     void putOrAdd(const IDBRequestData&, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode, KeyDataCallback);
101     void getRecord(const IDBRequestData&, const IDBGetRecordData&, GetResultCallback);
102     void getAllRecords(const IDBRequestData&, const IDBGetAllRecordsData&, GetAllResultsCallback);
103     void getCount(const IDBRequestData&, const IDBKeyRangeData&, CountCallback);
104     void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&, ErrorCallback);
105     void openCursor(const IDBRequestData&, const IDBCursorInfo&, GetResultCallback);
106     void iterateCursor(const IDBRequestData&, const IDBIterateCursorData&, GetResultCallback);
107     void commitTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
108     void abortTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
109     void didFinishHandlingVersionChange(UniqueIDBDatabaseConnection&, const IDBResourceIdentifier& transactionIdentifier);
110     void transactionDestroyed(UniqueIDBDatabaseTransaction&);
111     void connectionClosedFromClient(UniqueIDBDatabaseConnection&);
112     void confirmConnectionClosedOnServer(UniqueIDBDatabaseConnection&);
113     void didFireVersionChangeEvent(UniqueIDBDatabaseConnection&, const IDBResourceIdentifier& requestIdentifier);
114     void openDBRequestCancelled(const IDBResourceIdentifier& requestIdentifier);
115     void confirmDidCloseFromServer(UniqueIDBDatabaseConnection&);
116
117     void enqueueTransaction(Ref<UniqueIDBDatabaseTransaction>&&);
118
119     void handleDelete(IDBConnectionToClient&, const IDBRequestData&);
120     void immediateCloseForUserDelete();
121
122     static JSC::VM& databaseThreadVM();
123     static JSC::ExecState& databaseThreadExecState();
124
125     bool hardClosedForUserDelete() const { return m_hardClosedForUserDelete; }
126
127 private:
128     UniqueIDBDatabase(IDBServer&, const IDBDatabaseIdentifier&);
129     
130     void handleDatabaseOperations();
131     void handleCurrentOperation();
132     void performCurrentOpenOperation();
133     void performCurrentDeleteOperation();
134     void addOpenDatabaseConnection(Ref<UniqueIDBDatabaseConnection>&&);
135     bool hasAnyOpenConnections() const;
136     bool allConnectionsAreClosedOrClosing() const;
137
138     void startVersionChangeTransaction();
139     void maybeNotifyConnectionsOfVersionChange();
140     void notifyCurrentRequestConnectionClosedOrFiredVersionChangeEvent(uint64_t connectionIdentifier);
141     bool isVersionChangeInProgress();
142
143     void activateTransactionInBackingStore(UniqueIDBDatabaseTransaction&);
144     void transactionCompleted(RefPtr<UniqueIDBDatabaseTransaction>&&);
145
146     void connectionClosedFromServer(UniqueIDBDatabaseConnection&);
147
148     // Database thread operations
149     void deleteBackingStore(const IDBDatabaseIdentifier&);
150     void openBackingStore(const IDBDatabaseIdentifier&);
151     void performCommitTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
152     void performAbortTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
153     void beginTransactionInBackingStore(const IDBTransactionInfo&);
154     void performCreateObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&);
155     void performDeleteObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier);
156     void performRenameObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const String& newName);
157     void performClearObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier);
158     void performCreateIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBIndexInfo&);
159     void performDeleteIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier);
160     void performRenameIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName);
161     void performPutOrAdd(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode);
162     void performGetRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&, IDBGetRecordDataType);
163     void performGetAllRecords(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBGetAllRecordsData&);
164     void performGetIndexRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, IndexedDB::IndexRecordType, const IDBKeyRangeData&);
165     void performGetCount(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const IDBKeyRangeData&);
166     void performDeleteRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&);
167     void performOpenCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBCursorInfo&);
168     void performIterateCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBResourceIdentifier& cursorIdentifier, const IDBIterateCursorData&);
169     void performPrefetchCursor(const IDBResourceIdentifier& transactionIdentifier, const IDBResourceIdentifier& cursorIdentifier);
170
171     void performActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBTransactionInfo&);
172     void performUnconditionalDeleteBackingStore();
173
174     // Main thread callbacks
175     void didDeleteBackingStore(uint64_t deletedVersion);
176     void didOpenBackingStore(const IDBDatabaseInfo&, const IDBError&);
177     void didPerformCreateObjectStore(uint64_t callbackIdentifier, const IDBError&, const IDBObjectStoreInfo&);
178     void didPerformDeleteObjectStore(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier);
179     void didPerformRenameObjectStore(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, const String& newName);
180     void didPerformClearObjectStore(uint64_t callbackIdentifier, const IDBError&);
181     void didPerformCreateIndex(uint64_t callbackIdentifier, const IDBError&, const IDBIndexInfo&);
182     void didPerformDeleteIndex(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier);
183     void didPerformRenameIndex(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName);
184     void didPerformPutOrAdd(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
185     void didPerformGetRecord(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
186     void didPerformGetAllRecords(uint64_t callbackIdentifier, const IDBError&, const IDBGetAllResult&);
187     void didPerformGetCount(uint64_t callbackIdentifier, const IDBError&, uint64_t);
188     void didPerformDeleteRecord(uint64_t callbackIdentifier, const IDBError&);
189     void didPerformOpenCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
190     void didPerformIterateCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
191     void didPerformCommitTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
192     void didPerformAbortTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
193     void didPerformActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBError&);
194     void didPerformUnconditionalDeleteBackingStore();
195
196     uint64_t storeCallbackOrFireError(ErrorCallback&&);
197     uint64_t storeCallbackOrFireError(KeyDataCallback&&);
198     uint64_t storeCallbackOrFireError(GetAllResultsCallback&&);
199     uint64_t storeCallbackOrFireError(GetResultCallback&&);
200     uint64_t storeCallbackOrFireError(CountCallback&&);
201
202     void performErrorCallback(uint64_t callbackIdentifier, const IDBError&);
203     void performKeyDataCallback(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
204     void performGetResultCallback(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
205     void performGetAllResultsCallback(uint64_t callbackIdentifier, const IDBError&, const IDBGetAllResult&);
206     void performCountCallback(uint64_t callbackIdentifier, const IDBError&, uint64_t);
207
208     void forgetErrorCallback(uint64_t callbackIdentifier);
209
210     bool hasAnyPendingCallbacks() const;
211     bool isCurrentlyInUse() const;
212     bool hasUnfinishedTransactions() const;
213
214     void invokeOperationAndTransactionTimer();
215     void operationAndTransactionTimerFired();
216     RefPtr<UniqueIDBDatabaseTransaction> takeNextRunnableTransaction(bool& hadDeferredTransactions);
217
218     bool prepareToFinishTransaction(UniqueIDBDatabaseTransaction&);
219
220     void postDatabaseTask(CrossThreadTask&&);
221     void postDatabaseTaskReply(CrossThreadTask&&);
222     void executeNextDatabaseTask();
223     void executeNextDatabaseTaskReply();
224
225     void maybeFinishHardClose();
226     bool isDoneWithHardClose();
227
228     IDBServer& m_server;
229     IDBDatabaseIdentifier m_identifier;
230     
231     ListHashSet<RefPtr<ServerOpenDBRequest>> m_pendingOpenDBRequests;
232     RefPtr<ServerOpenDBRequest> m_currentOpenDBRequest;
233
234     ListHashSet<RefPtr<UniqueIDBDatabaseConnection>> m_openDatabaseConnections;
235     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_clientClosePendingDatabaseConnections;
236     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_serverClosePendingDatabaseConnections;
237
238     RefPtr<UniqueIDBDatabaseConnection> m_versionChangeDatabaseConnection;
239     RefPtr<UniqueIDBDatabaseTransaction> m_versionChangeTransaction;
240
241     bool m_isOpeningBackingStore { false };
242     IDBError m_backingStoreOpenError;
243     std::unique_ptr<IDBBackingStore> m_backingStore;
244     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
245     std::unique_ptr<IDBDatabaseInfo> m_mostRecentDeletedDatabaseInfo;
246
247     bool m_backingStoreSupportsSimultaneousTransactions { false };
248     bool m_backingStoreIsEphemeral { false };
249
250     HashMap<uint64_t, ErrorCallback> m_errorCallbacks;
251     HashMap<uint64_t, KeyDataCallback> m_keyDataCallbacks;
252     HashMap<uint64_t, GetResultCallback> m_getResultCallbacks;
253     HashMap<uint64_t, GetAllResultsCallback> m_getAllResultsCallbacks;
254     HashMap<uint64_t, CountCallback> m_countCallbacks;
255
256     Timer m_operationAndTransactionTimer;
257
258     Deque<RefPtr<UniqueIDBDatabaseTransaction>> m_pendingTransactions;
259     HashMap<IDBResourceIdentifier, RefPtr<UniqueIDBDatabaseTransaction>> m_inProgressTransactions;
260     HashMap<IDBResourceIdentifier, RefPtr<UniqueIDBDatabaseTransaction>> m_finishingTransactions;
261
262     // The keys into these sets are the object store ID.
263     // These sets help to decide which transactions can be started and which must be deferred.
264     HashCountedSet<uint64_t> m_objectStoreTransactionCounts;
265     HashSet<uint64_t> m_objectStoreWriteTransactions;
266
267     bool m_deleteBackingStoreInProgress { false };
268
269     CrossThreadQueue<CrossThreadTask> m_databaseQueue;
270     CrossThreadQueue<CrossThreadTask> m_databaseReplyQueue;
271     std::atomic<uint64_t> m_queuedTaskCount { 0 };
272
273     bool m_hardClosedForUserDelete { false };
274     RefPtr<UniqueIDBDatabase> m_hardCloseProtector;
275
276     HashMap<IDBResourceIdentifier, RefPtr<UniqueIDBDatabase>> m_prefetchProtectors;
277 };
278
279 } // namespace IDBServer
280 } // namespace WebCore
281
282 #endif // ENABLE(INDEXED_DATABASE)