Remove unnecessary network process assertion for IDB close
[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 class StorageQuotaManager;
58
59 enum class IDBGetRecordDataType;
60
61 namespace IndexedDB {
62 enum class IndexRecordType;
63 }
64
65 namespace IDBServer {
66
67 class IDBConnectionToClient;
68 class IDBServer;
69
70 typedef Function<void(const IDBError&)> ErrorCallback;
71 typedef Function<void(const IDBError&, const IDBKeyData&)> KeyDataCallback;
72 typedef Function<void(const IDBError&, const IDBGetResult&)> GetResultCallback;
73 typedef Function<void(const IDBError&, const IDBGetAllResult&)> GetAllResultsCallback;
74 typedef Function<void(const IDBError&, uint64_t)> CountCallback;
75
76 class UniqueIDBDatabase : public CanMakeWeakPtr<UniqueIDBDatabase> {
77     WTF_MAKE_FAST_ALLOCATED;
78 public:
79     UniqueIDBDatabase(IDBServer&, const IDBDatabaseIdentifier&);
80     UniqueIDBDatabase(UniqueIDBDatabase&) = delete;
81     WEBCORE_EXPORT ~UniqueIDBDatabase();
82
83     void openDatabaseConnection(IDBConnectionToClient&, const IDBRequestData&);
84
85     const IDBDatabaseInfo& info() const;
86     IDBServer& server() { return m_server.get(); }
87     const IDBDatabaseIdentifier& identifier() const { return m_identifier; }
88
89     void createObjectStore(UniqueIDBDatabaseTransaction&, const IDBObjectStoreInfo&, ErrorCallback);
90     void deleteObjectStore(UniqueIDBDatabaseTransaction&, const String& objectStoreName, ErrorCallback);
91     void renameObjectStore(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& newName, ErrorCallback);
92     void clearObjectStore(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, ErrorCallback);
93     void createIndex(UniqueIDBDatabaseTransaction&, const IDBIndexInfo&, ErrorCallback);
94     void deleteIndex(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& indexName, ErrorCallback);
95     void renameIndex(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName, ErrorCallback);
96     void putOrAdd(const IDBRequestData&, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode, KeyDataCallback);
97     void getRecord(const IDBRequestData&, const IDBGetRecordData&, GetResultCallback);
98     void getAllRecords(const IDBRequestData&, const IDBGetAllRecordsData&, GetAllResultsCallback);
99     void getCount(const IDBRequestData&, const IDBKeyRangeData&, CountCallback);
100     void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&, ErrorCallback);
101     void openCursor(const IDBRequestData&, const IDBCursorInfo&, GetResultCallback);
102     void iterateCursor(const IDBRequestData&, const IDBIterateCursorData&, GetResultCallback);
103     void commitTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
104
105     enum class WaitForPendingTasks { No, Yes };
106     void abortTransaction(UniqueIDBDatabaseTransaction&, WaitForPendingTasks, ErrorCallback);
107
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     uint64_t spaceUsed() const;
127
128     void setQuota(uint64_t);
129
130 private:
131     void handleDatabaseOperations();
132     void handleCurrentOperation();
133     void performCurrentOpenOperation();
134     void performCurrentDeleteOperation();
135     void addOpenDatabaseConnection(Ref<UniqueIDBDatabaseConnection>&&);
136     bool hasAnyOpenConnections() const;
137     bool allConnectionsAreClosedOrClosing() const;
138
139     void startVersionChangeTransaction();
140     void maybeNotifyConnectionsOfVersionChange();
141     void notifyCurrentRequestConnectionClosedOrFiredVersionChangeEvent(uint64_t connectionIdentifier);
142     bool isVersionChangeInProgress();
143
144     void activateTransactionInBackingStore(UniqueIDBDatabaseTransaction&);
145     void transactionCompleted(RefPtr<UniqueIDBDatabaseTransaction>&&);
146
147     void connectionClosedFromServer(UniqueIDBDatabaseConnection&);
148
149     void scheduleShutdownForClose();
150
151     void createObjectStoreAfterQuotaCheck(uint64_t taskSize, UniqueIDBDatabaseTransaction&, const IDBObjectStoreInfo&, ErrorCallback);
152     void renameObjectStoreAfterQuotaCheck(uint64_t taskSize, UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& newName, ErrorCallback);
153     void createIndexAfterQuotaCheck(uint64_t taskSize, UniqueIDBDatabaseTransaction&, const IDBIndexInfo&, ErrorCallback);
154     void renameIndexAfterQuotaCheck(uint64_t taskSize, UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName, ErrorCallback);
155     void putOrAddAfterQuotaCheck(uint64_t taskSize, const IDBRequestData&, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode, KeyDataCallback);
156     void deleteRecordAfterQuotaCheck(const IDBRequestData&, const IDBKeyRangeData&, ErrorCallback);
157
158     void deleteObjectStoreAfterQuotaCheck(UniqueIDBDatabaseTransaction&, const String& objectStoreName, ErrorCallback);
159     void clearObjectStoreAfetQuotaCheck(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, ErrorCallback);
160     void deleteIndexAfterQuotaCheck(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String&, ErrorCallback);
161     void getRecordAfterQuotaCheck(const IDBRequestData&, const IDBGetRecordData&, GetResultCallback);
162     void getAllRecordsAfterQuotaCheck(const IDBRequestData&, const IDBGetAllRecordsData&, GetAllResultsCallback);
163     void getCountAfterQuotaCheck(const IDBRequestData&, const IDBKeyRangeData&, CountCallback);
164     void openCursorAfterQuotaCheck(const IDBRequestData&, const IDBCursorInfo&, GetResultCallback);
165     void iterateCursorAfterQuotaCheck(const IDBRequestData&, const IDBIterateCursorData&, GetResultCallback);
166     void commitTransactionAfterQuotaCheck(UniqueIDBDatabaseTransaction&, ErrorCallback);
167
168     // Database thread operations
169     void deleteBackingStore(const IDBDatabaseIdentifier&);
170     void openBackingStore(const IDBDatabaseIdentifier&);
171     void performCommitTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
172     void performAbortTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
173     void beginTransactionInBackingStore(const IDBTransactionInfo&);
174     void performCreateObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&);
175     void performDeleteObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier);
176     void performRenameObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const String& newName);
177     void performClearObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier);
178     void performCreateIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBIndexInfo&);
179     void performDeleteIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier);
180     void performRenameIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName);
181     void performPutOrAdd(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode);
182     void performGetRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&, IDBGetRecordDataType);
183     void performGetAllRecords(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBGetAllRecordsData&);
184     void performGetIndexRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, IndexedDB::IndexRecordType, const IDBKeyRangeData&);
185     void performGetCount(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const IDBKeyRangeData&);
186     void performDeleteRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&);
187     void performOpenCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBCursorInfo&);
188     void performIterateCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBResourceIdentifier& cursorIdentifier, const IDBIterateCursorData&);
189     void performPrefetchCursor(const IDBResourceIdentifier& transactionIdentifier, const IDBResourceIdentifier& cursorIdentifier);
190
191     void performActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBTransactionInfo&);
192     void performUnconditionalDeleteBackingStore();
193     void shutdownForClose();
194
195     // Main thread callbacks
196     void didDeleteBackingStore(uint64_t deletedVersion);
197     void didOpenBackingStore(const IDBDatabaseInfo&, const IDBError&);
198     void didPerformCreateObjectStore(uint64_t callbackIdentifier, const IDBError&, const IDBObjectStoreInfo&);
199     void didPerformDeleteObjectStore(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier);
200     void didPerformRenameObjectStore(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, const String& newName);
201     void didPerformClearObjectStore(uint64_t callbackIdentifier, const IDBError&);
202     void didPerformCreateIndex(uint64_t callbackIdentifier, const IDBError&, const IDBIndexInfo&);
203     void didPerformDeleteIndex(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier);
204     void didPerformRenameIndex(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName);
205     void didPerformPutOrAdd(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
206     void didPerformGetRecord(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
207     void didPerformGetAllRecords(uint64_t callbackIdentifier, const IDBError&, const IDBGetAllResult&);
208     void didPerformGetCount(uint64_t callbackIdentifier, const IDBError&, uint64_t);
209     void didPerformDeleteRecord(uint64_t callbackIdentifier, const IDBError&);
210     void didPerformOpenCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
211     void didPerformIterateCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
212     void didPerformCommitTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
213     void didPerformAbortTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
214     void didPerformActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBError&);
215     void didPerformUnconditionalDeleteBackingStore();
216     void didShutdownForClose();
217
218     uint64_t storeCallbackOrFireError(ErrorCallback&&, uint64_t taskSize = 0);
219     uint64_t storeCallbackOrFireError(KeyDataCallback&&, uint64_t taskSize = 0);
220     uint64_t storeCallbackOrFireError(GetAllResultsCallback&&);
221     uint64_t storeCallbackOrFireError(GetResultCallback&&);
222     uint64_t storeCallbackOrFireError(CountCallback&&);
223
224     void performErrorCallback(uint64_t callbackIdentifier, const IDBError&);
225     void performKeyDataCallback(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
226     void performGetResultCallback(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
227     void performGetAllResultsCallback(uint64_t callbackIdentifier, const IDBError&, const IDBGetAllResult&);
228     void performCountCallback(uint64_t callbackIdentifier, const IDBError&, uint64_t);
229
230     void forgetErrorCallback(uint64_t callbackIdentifier);
231
232     bool hasAnyPendingCallbacks() const;
233     bool isCurrentlyInUse() const;
234     bool hasUnfinishedTransactions() const;
235
236     void invokeOperationAndTransactionTimer();
237     void operationAndTransactionTimerFired();
238     RefPtr<UniqueIDBDatabaseTransaction> takeNextRunnableTransaction(bool& hadDeferredTransactions);
239
240     bool prepareToFinishTransaction(UniqueIDBDatabaseTransaction&);
241     
242     void clearStalePendingOpenDBRequests();
243
244     void postDatabaseTask(CrossThreadTask&&);
245     void postDatabaseTaskReply(CrossThreadTask&&);
246     void executeNextDatabaseTask();
247     void executeNextDatabaseTaskReply();
248
249     void maybeFinishHardClose();
250     bool isDoneWithHardClose();
251
252     void requestSpace(uint64_t taskSize, const char* errorMessage, CompletionHandler<void(Optional<IDBError>&&)>&&);
253     void waitForRequestSpaceCompletion(CompletionHandler<void(Optional<IDBError>&&)>&&);
254     void updateSpaceUsedIfNeeded(uint64_t callbackIdentifier);
255
256     Ref<IDBServer> m_server;
257     IDBDatabaseIdentifier m_identifier;
258
259     ListHashSet<RefPtr<ServerOpenDBRequest>> m_pendingOpenDBRequests;
260     RefPtr<ServerOpenDBRequest> m_currentOpenDBRequest;
261
262     ListHashSet<RefPtr<UniqueIDBDatabaseConnection>> m_openDatabaseConnections;
263     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_clientClosePendingDatabaseConnections;
264     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_serverClosePendingDatabaseConnections;
265
266     RefPtr<UniqueIDBDatabaseConnection> m_versionChangeDatabaseConnection;
267     RefPtr<UniqueIDBDatabaseTransaction> m_versionChangeTransaction;
268
269     bool m_isOpeningBackingStore { false };
270     IDBError m_backingStoreOpenError;
271     std::unique_ptr<IDBBackingStore> m_backingStore;
272     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
273     std::unique_ptr<IDBDatabaseInfo> m_mostRecentDeletedDatabaseInfo;
274
275     bool m_backingStoreSupportsSimultaneousTransactions { false };
276     bool m_backingStoreIsEphemeral { false };
277
278     HashMap<uint64_t, ErrorCallback> m_errorCallbacks;
279     HashMap<uint64_t, KeyDataCallback> m_keyDataCallbacks;
280     HashMap<uint64_t, GetResultCallback> m_getResultCallbacks;
281     HashMap<uint64_t, GetAllResultsCallback> m_getAllResultsCallbacks;
282     HashMap<uint64_t, CountCallback> m_countCallbacks;
283     Deque<uint64_t> m_callbackQueue;
284
285     Timer m_operationAndTransactionTimer;
286
287     Deque<RefPtr<UniqueIDBDatabaseTransaction>> m_pendingTransactions;
288     HashMap<IDBResourceIdentifier, RefPtr<UniqueIDBDatabaseTransaction>> m_inProgressTransactions;
289     HashMap<IDBResourceIdentifier, RefPtr<UniqueIDBDatabaseTransaction>> m_finishingTransactions;
290
291     // The keys into these sets are the object store ID.
292     // These sets help to decide which transactions can be started and which must be deferred.
293     HashCountedSet<uint64_t> m_objectStoreTransactionCounts;
294     HashSet<uint64_t> m_objectStoreWriteTransactions;
295
296     bool m_deleteBackingStoreInProgress { false };
297
298     CrossThreadQueue<CrossThreadTask> m_databaseQueue;
299     CrossThreadQueue<CrossThreadTask> m_databaseReplyQueue;
300
301     bool m_hardClosedForUserDelete { false };
302     bool m_owningPointerReleaseScheduled { false };
303     std::unique_ptr<UniqueIDBDatabase> m_owningPointerForClose;
304
305     HashSet<IDBResourceIdentifier> m_cursorPrefetches;
306
307     HashMap<uint64_t, uint64_t> m_pendingSpaceIncreasingTasks;
308     uint64_t m_databasesSizeForOrigin { 0 };
309 };
310
311 } // namespace IDBServer
312 } // namespace WebCore
313
314 #endif // ENABLE(INDEXED_DATABASE)