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