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