Modern IDB: Refactor open/delete requests to exist in the same queue.
[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 "IDBServerOperation.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/Ref.h>
45 #include <wtf/ThreadSafeRefCounted.h>
46
47 namespace WebCore {
48
49 class IDBError;
50 class IDBRequestData;
51 class IDBTransactionInfo;
52
53 namespace IndexedDB {
54 enum class IndexRecordType;
55 }
56
57 namespace IDBServer {
58
59 class IDBConnectionToClient;
60 class IDBServer;
61
62 typedef std::function<void(const IDBError&)> ErrorCallback;
63 typedef std::function<void(const IDBError&, const IDBKeyData&)> KeyDataCallback;
64 typedef std::function<void(const IDBError&, const IDBGetResult&)> GetResultCallback;
65 typedef std::function<void(const IDBError&, uint64_t)> CountCallback;
66
67 class UniqueIDBDatabase : public ThreadSafeRefCounted<UniqueIDBDatabase> {
68 public:
69     static Ref<UniqueIDBDatabase> create(IDBServer& server, const IDBDatabaseIdentifier& identifier)
70     {
71         return adoptRef(*new UniqueIDBDatabase(server, identifier));
72     }
73
74     ~UniqueIDBDatabase();
75
76     void openDatabaseConnection(IDBConnectionToClient&, const IDBRequestData&);
77
78     const IDBDatabaseInfo& info() const;
79     IDBServer& server() { return m_server; }
80     const IDBDatabaseIdentifier& identifier() const { return m_identifier; }
81
82     void createObjectStore(UniqueIDBDatabaseTransaction&, const IDBObjectStoreInfo&, ErrorCallback);
83     void deleteObjectStore(UniqueIDBDatabaseTransaction&, const String& objectStoreName, ErrorCallback);
84     void clearObjectStore(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, ErrorCallback);
85     void createIndex(UniqueIDBDatabaseTransaction&, const IDBIndexInfo&, ErrorCallback);
86     void deleteIndex(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& indexName, ErrorCallback);
87     void putOrAdd(const IDBRequestData&, const IDBKeyData&, const ThreadSafeDataBuffer& valueData, IndexedDB::ObjectStoreOverwriteMode, KeyDataCallback);
88     void getRecord(const IDBRequestData&, const IDBKeyRangeData&, GetResultCallback);
89     void getCount(const IDBRequestData&, const IDBKeyRangeData&, CountCallback);
90     void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&, ErrorCallback);
91     void openCursor(const IDBRequestData&, const IDBCursorInfo&, GetResultCallback);
92     void iterateCursor(const IDBRequestData&, const IDBKeyData&, unsigned long count, GetResultCallback);
93     void commitTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
94     void abortTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
95     void transactionDestroyed(UniqueIDBDatabaseTransaction&);
96     void connectionClosedFromClient(UniqueIDBDatabaseConnection&);
97
98     void enqueueTransaction(Ref<UniqueIDBDatabaseTransaction>&&);
99
100     void handleDelete(IDBConnectionToClient&, const IDBRequestData&);
101     bool deletePending() const { return m_deletePending; }
102
103     static JSC::VM& databaseThreadVM();
104     static JSC::ExecState& databaseThreadExecState();
105
106 private:
107     UniqueIDBDatabase(IDBServer&, const IDBDatabaseIdentifier&);
108     
109     void handleDatabaseOperations();
110     void handleCurrentOperation();
111     void performCurrentOpenOperation();
112     void performCurrentDeleteOperation();
113     void addOpenDatabaseConnection(Ref<UniqueIDBDatabaseConnection>&&);
114     bool hasAnyOpenConnections() const;
115
116     void startVersionChangeTransaction();
117     void notifyConnectionsOfVersionChangeForUpgrade();
118     void notifyConnectionsOfVersionChange(uint64_t requestedVersion);
119     bool isVersionChangeInProgress();
120
121     void activateTransactionInBackingStore(UniqueIDBDatabaseTransaction&);
122     void inProgressTransactionCompleted(const IDBResourceIdentifier&);
123
124     // Database thread operations
125     void openBackingStore(const IDBDatabaseIdentifier&);
126     void performCommitTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
127     void performAbortTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
128     void beginTransactionInBackingStore(const IDBTransactionInfo&);
129     void performCreateObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&);
130     void performDeleteObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const String& objectStoreName);
131     void performClearObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier);
132     void performCreateIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBIndexInfo&);
133     void performDeleteIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const String& indexName);
134     void performPutOrAdd(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyData&, const ThreadSafeDataBuffer& valueData, IndexedDB::ObjectStoreOverwriteMode);
135     void performGetRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&);
136     void performGetIndexRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, IndexedDB::IndexRecordType, const IDBKeyRangeData&);
137     void performGetCount(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const IDBKeyRangeData&);
138     void performDeleteRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&);
139     void performOpenCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBCursorInfo&);
140     void performIterateCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBResourceIdentifier& cursorIdentifier, const IDBKeyData&, unsigned long count);
141     void performActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBTransactionInfo&);
142
143     // Main thread callbacks
144     void didOpenBackingStore(const IDBDatabaseInfo&);
145     void didPerformCreateObjectStore(uint64_t callbackIdentifier, const IDBError&, const IDBObjectStoreInfo&);
146     void didPerformDeleteObjectStore(uint64_t callbackIdentifier, const IDBError&, const String& objectStoreName);
147     void didPerformClearObjectStore(uint64_t callbackIdentifier, const IDBError&);
148     void didPerformCreateIndex(uint64_t callbackIdentifier, const IDBError&, const IDBIndexInfo&);
149     void didPerformDeleteIndex(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, const String& indexName);
150     void didPerformPutOrAdd(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
151     void didPerformGetRecord(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
152     void didPerformGetCount(uint64_t callbackIdentifier, const IDBError&, uint64_t);
153     void didPerformDeleteRecord(uint64_t callbackIdentifier, const IDBError&);
154     void didPerformOpenCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
155     void didPerformIterateCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
156     void didPerformCommitTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
157     void didPerformAbortTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
158     void didPerformActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBError&);
159
160     uint64_t storeCallback(ErrorCallback);
161     uint64_t storeCallback(KeyDataCallback);
162     uint64_t storeCallback(GetResultCallback);
163     uint64_t storeCallback(CountCallback);
164
165     void performErrorCallback(uint64_t callbackIdentifier, const IDBError&);
166     void performKeyDataCallback(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
167     void performGetResultCallback(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
168     void performCountCallback(uint64_t callbackIdentifier, const IDBError&, uint64_t);
169
170     bool hasAnyPendingCallbacks() const;
171
172     void invokeOperationAndTransactionTimer();
173     void operationAndTransactionTimerFired();
174     RefPtr<UniqueIDBDatabaseTransaction> takeNextRunnableTransaction(bool& hadDeferredTransactions);
175
176     IDBServer& m_server;
177     IDBDatabaseIdentifier m_identifier;
178     
179     Deque<Ref<IDBServerOperation>> m_pendingDatabaseOperations;
180     RefPtr<IDBServerOperation> m_currentOperation;
181
182     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_openDatabaseConnections;
183     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_closePendingDatabaseConnections;
184
185     RefPtr<UniqueIDBDatabaseConnection> m_versionChangeDatabaseConnection;
186     UniqueIDBDatabaseTransaction* m_versionChangeTransaction { nullptr };
187
188     bool m_isOpeningBackingStore { false };
189     std::unique_ptr<IDBBackingStore> m_backingStore;
190     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
191
192     HashMap<uint64_t, ErrorCallback> m_errorCallbacks;
193     HashMap<uint64_t, KeyDataCallback> m_keyDataCallbacks;
194     HashMap<uint64_t, GetResultCallback> m_getResultCallbacks;
195     HashMap<uint64_t, CountCallback> m_countCallbacks;
196
197     Timer m_operationAndTransactionTimer;
198
199     Deque<RefPtr<UniqueIDBDatabaseTransaction>> m_pendingTransactions;
200     HashMap<IDBResourceIdentifier, RefPtr<UniqueIDBDatabaseTransaction>> m_inProgressTransactions;
201
202     // The key into this set is the object store ID.
203     // The set counts how many transactions are open to the given object store.
204     // This helps make sure opening narrowly scoped transactions (one or two object stores)
205     // doesn't continuously block widely scoped write transactions.
206     HashCountedSet<uint64_t> m_objectStoreTransactionCounts;
207
208     bool m_deletePending { false };
209     bool m_hasNotifiedConnectionsOfDelete { false };
210 };
211
212 } // namespace IDBServer
213 } // namespace WebCore
214
215 #endif // ENABLE(INDEXED_DATABASE)
216 #endif // UniqueIDBDatabase_h