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