Modern IDB: storage/indexeddb/intversion-gated-on-delete.html is flaky.
[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 #ifndef UniqueIDBDatabase_h
27 #define UniqueIDBDatabase_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBBackingStore.h"
32 #include "IDBBindingUtilities.h"
33 #include "IDBDatabaseIdentifier.h"
34 #include "IDBDatabaseInfo.h"
35 #include "IDBGetResult.h"
36 #include "ServerOpenDBRequest.h"
37 #include "ThreadSafeDataBuffer.h"
38 #include "Timer.h"
39 #include "UniqueIDBDatabaseConnection.h"
40 #include "UniqueIDBDatabaseTransaction.h"
41 #include <wtf/Deque.h>
42 #include <wtf/HashCountedSet.h>
43 #include <wtf/HashSet.h>
44 #include <wtf/ListHashSet.h>
45 #include <wtf/Ref.h>
46 #include <wtf/ThreadSafeRefCounted.h>
47
48 namespace WebCore {
49
50 class IDBError;
51 class IDBRequestData;
52 class IDBTransactionInfo;
53
54 namespace IndexedDB {
55 enum class IndexRecordType;
56 }
57
58 namespace IDBServer {
59
60 class IDBConnectionToClient;
61 class IDBServer;
62
63 typedef std::function<void(const IDBError&)> ErrorCallback;
64 typedef std::function<void(const IDBError&, const IDBKeyData&)> KeyDataCallback;
65 typedef std::function<void(const IDBError&, const IDBGetResult&)> GetResultCallback;
66 typedef std::function<void(const IDBError&, uint64_t)> CountCallback;
67
68 class UniqueIDBDatabase : public ThreadSafeRefCounted<UniqueIDBDatabase> {
69 public:
70     static Ref<UniqueIDBDatabase> create(IDBServer& server, const IDBDatabaseIdentifier& identifier)
71     {
72         return adoptRef(*new UniqueIDBDatabase(server, identifier));
73     }
74
75     ~UniqueIDBDatabase();
76
77     void openDatabaseConnection(IDBConnectionToClient&, const IDBRequestData&);
78
79     const IDBDatabaseInfo& info() const;
80     IDBServer& server() { return m_server; }
81     const IDBDatabaseIdentifier& identifier() const { return m_identifier; }
82
83     void createObjectStore(UniqueIDBDatabaseTransaction&, const IDBObjectStoreInfo&, ErrorCallback);
84     void deleteObjectStore(UniqueIDBDatabaseTransaction&, const String& objectStoreName, ErrorCallback);
85     void clearObjectStore(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, ErrorCallback);
86     void createIndex(UniqueIDBDatabaseTransaction&, const IDBIndexInfo&, ErrorCallback);
87     void deleteIndex(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& indexName, ErrorCallback);
88     void putOrAdd(const IDBRequestData&, const IDBKeyData&, const ThreadSafeDataBuffer& valueData, IndexedDB::ObjectStoreOverwriteMode, KeyDataCallback);
89     void getRecord(const IDBRequestData&, const IDBKeyRangeData&, GetResultCallback);
90     void getCount(const IDBRequestData&, const IDBKeyRangeData&, CountCallback);
91     void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&, ErrorCallback);
92     void openCursor(const IDBRequestData&, const IDBCursorInfo&, GetResultCallback);
93     void iterateCursor(const IDBRequestData&, const IDBKeyData&, unsigned long count, GetResultCallback);
94     void commitTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
95     void abortTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
96     void didFinishHandlingVersionChange(UniqueIDBDatabaseTransaction&);
97     void transactionDestroyed(UniqueIDBDatabaseTransaction&);
98     void connectionClosedFromClient(UniqueIDBDatabaseConnection&);
99     void didFireVersionChangeEvent(UniqueIDBDatabaseConnection&, const IDBResourceIdentifier& requestIdentifier);
100
101     void enqueueTransaction(Ref<UniqueIDBDatabaseTransaction>&&);
102
103     void handleDelete(IDBConnectionToClient&, const IDBRequestData&);
104     bool deletePending() const { return m_deletePending; }
105
106     static JSC::VM& databaseThreadVM();
107     static JSC::ExecState& databaseThreadExecState();
108
109 private:
110     UniqueIDBDatabase(IDBServer&, const IDBDatabaseIdentifier&);
111     
112     void handleDatabaseOperations();
113     void handleCurrentOperation();
114     void performCurrentOpenOperation();
115     void performCurrentDeleteOperation();
116     void addOpenDatabaseConnection(Ref<UniqueIDBDatabaseConnection>&&);
117     bool hasAnyOpenConnections() const;
118
119     void startVersionChangeTransaction();
120     void maybeNotifyConnectionsOfVersionChange();
121     void notifyCurrentRequestConnectionClosedOrFiredVersionChangeEvent(uint64_t connectionIdentifier);
122     bool isVersionChangeInProgress();
123
124     void activateTransactionInBackingStore(UniqueIDBDatabaseTransaction&);
125     void inProgressTransactionCompleted(const IDBResourceIdentifier&);
126
127     // Database thread operations
128     void deleteBackingStore();
129     void openBackingStore(const IDBDatabaseIdentifier&);
130     void performCommitTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
131     void performAbortTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
132     void beginTransactionInBackingStore(const IDBTransactionInfo&);
133     void performCreateObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&);
134     void performDeleteObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const String& objectStoreName);
135     void performClearObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier);
136     void performCreateIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBIndexInfo&);
137     void performDeleteIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const String& indexName);
138     void performPutOrAdd(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyData&, const ThreadSafeDataBuffer& valueData, IndexedDB::ObjectStoreOverwriteMode);
139     void performGetRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&);
140     void performGetIndexRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, IndexedDB::IndexRecordType, const IDBKeyRangeData&);
141     void performGetCount(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const IDBKeyRangeData&);
142     void performDeleteRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&);
143     void performOpenCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBCursorInfo&);
144     void performIterateCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBResourceIdentifier& cursorIdentifier, const IDBKeyData&, unsigned long count);
145     void performActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBTransactionInfo&);
146
147     // Main thread callbacks
148     void didDeleteBackingStore();
149     void didOpenBackingStore(const IDBDatabaseInfo&);
150     void didPerformCreateObjectStore(uint64_t callbackIdentifier, const IDBError&, const IDBObjectStoreInfo&);
151     void didPerformDeleteObjectStore(uint64_t callbackIdentifier, const IDBError&, const String& objectStoreName);
152     void didPerformClearObjectStore(uint64_t callbackIdentifier, const IDBError&);
153     void didPerformCreateIndex(uint64_t callbackIdentifier, const IDBError&, const IDBIndexInfo&);
154     void didPerformDeleteIndex(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, const String& indexName);
155     void didPerformPutOrAdd(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
156     void didPerformGetRecord(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
157     void didPerformGetCount(uint64_t callbackIdentifier, const IDBError&, uint64_t);
158     void didPerformDeleteRecord(uint64_t callbackIdentifier, const IDBError&);
159     void didPerformOpenCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
160     void didPerformIterateCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
161     void didPerformCommitTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
162     void didPerformAbortTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
163     void didPerformActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBError&);
164
165     uint64_t storeCallback(ErrorCallback);
166     uint64_t storeCallback(KeyDataCallback);
167     uint64_t storeCallback(GetResultCallback);
168     uint64_t storeCallback(CountCallback);
169
170     void performErrorCallback(uint64_t callbackIdentifier, const IDBError&);
171     void performKeyDataCallback(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
172     void performGetResultCallback(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
173     void performCountCallback(uint64_t callbackIdentifier, const IDBError&, uint64_t);
174
175     bool hasAnyPendingCallbacks() const;
176
177     void invokeOperationAndTransactionTimer();
178     void operationAndTransactionTimerFired();
179     RefPtr<UniqueIDBDatabaseTransaction> takeNextRunnableTransaction(bool& hadDeferredTransactions);
180
181     IDBServer& m_server;
182     IDBDatabaseIdentifier m_identifier;
183     
184     Deque<Ref<ServerOpenDBRequest>> m_pendingOpenDBRequests;
185     RefPtr<ServerOpenDBRequest> m_currentOpenDBRequest;
186
187     ListHashSet<RefPtr<UniqueIDBDatabaseConnection>> m_openDatabaseConnections;
188     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_closePendingDatabaseConnections;
189
190     RefPtr<UniqueIDBDatabaseConnection> m_versionChangeDatabaseConnection;
191     RefPtr<UniqueIDBDatabaseTransaction> m_versionChangeTransaction;
192
193     bool m_isOpeningBackingStore { false };
194     std::unique_ptr<IDBBackingStore> m_backingStore;
195     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
196
197     HashMap<uint64_t, ErrorCallback> m_errorCallbacks;
198     HashMap<uint64_t, KeyDataCallback> m_keyDataCallbacks;
199     HashMap<uint64_t, GetResultCallback> m_getResultCallbacks;
200     HashMap<uint64_t, CountCallback> m_countCallbacks;
201
202     Timer m_operationAndTransactionTimer;
203
204     Deque<RefPtr<UniqueIDBDatabaseTransaction>> m_pendingTransactions;
205     HashMap<IDBResourceIdentifier, RefPtr<UniqueIDBDatabaseTransaction>> m_inProgressTransactions;
206
207     // The keys into these sets are the object store ID.
208     // These sets help to decide which transactions can be started and which must be deferred.
209     HashCountedSet<uint64_t> m_objectStoreTransactionCounts;
210     HashSet<uint64_t> m_objectStoreWriteTransactions;
211
212     bool m_deletePending { false };
213     bool m_deleteBackingStoreInProgress { false };
214 };
215
216 } // namespace IDBServer
217 } // namespace WebCore
218
219 #endif // ENABLE(INDEXED_DATABASE)
220 #endif // UniqueIDBDatabase_h