Modern IDB: IDBObjectStore.deleteIndex() support.
[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 deleteIndex(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& indexName, ErrorCallback);
83     void putOrAdd(const IDBRequestData&, const IDBKeyData&, const ThreadSafeDataBuffer& valueData, IndexedDB::ObjectStoreOverwriteMode, KeyDataCallback);
84     void getRecord(const IDBRequestData&, const IDBKeyRangeData&, GetResultCallback);
85     void getCount(const IDBRequestData&, const IDBKeyRangeData&, CountCallback);
86     void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&, ErrorCallback);
87     void openCursor(const IDBRequestData&, const IDBCursorInfo&, GetResultCallback);
88     void iterateCursor(const IDBRequestData&, const IDBKeyData&, unsigned long count, GetResultCallback);
89     void commitTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
90     void abortTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
91     void transactionDestroyed(UniqueIDBDatabaseTransaction&);
92     void connectionClosedFromClient(UniqueIDBDatabaseConnection&);
93
94     void enqueueTransaction(Ref<UniqueIDBDatabaseTransaction>&&);
95
96 private:
97     UniqueIDBDatabase(IDBServer&, const IDBDatabaseIdentifier&);
98     
99     void handleOpenDatabaseOperations();
100     void addOpenDatabaseConnection(Ref<UniqueIDBDatabaseConnection>&&);
101     bool hasAnyOpenConnections() const;
102
103     void startVersionChangeTransaction();
104     void notifyConnectionsOfVersionChange();
105
106     void activateTransactionInBackingStore(UniqueIDBDatabaseTransaction&);
107     void inProgressTransactionCompleted(const IDBResourceIdentifier&);
108
109     // Database thread operations
110     void openBackingStore(const IDBDatabaseIdentifier&);
111     void performCommitTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
112     void performAbortTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
113     void beginTransactionInBackingStore(const IDBTransactionInfo&);
114     void performCreateObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&);
115     void performDeleteObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const String& objectStoreName);
116     void performClearObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier);
117     void performCreateIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBIndexInfo&);
118     void performDeleteIndex(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const String& indexName);
119     void performPutOrAdd(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyData&, const ThreadSafeDataBuffer& valueData, IndexedDB::ObjectStoreOverwriteMode);
120     void performGetRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&);
121     void performGetIndexRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, IndexedDB::IndexRecordType, const IDBKeyRangeData&);
122     void performGetCount(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const IDBKeyRangeData&);
123     void performDeleteRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&);
124     void performOpenCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBCursorInfo&);
125     void performIterateCursor(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBResourceIdentifier& cursorIdentifier, const IDBKeyData&, unsigned long count);
126     void performActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBTransactionInfo&);
127
128     // Main thread callbacks
129     void didOpenBackingStore(const IDBDatabaseInfo&);
130     void didPerformCreateObjectStore(uint64_t callbackIdentifier, const IDBError&, const IDBObjectStoreInfo&);
131     void didPerformDeleteObjectStore(uint64_t callbackIdentifier, const IDBError&, const String& objectStoreName);
132     void didPerformClearObjectStore(uint64_t callbackIdentifier, const IDBError&);
133     void didPerformCreateIndex(uint64_t callbackIdentifier, const IDBError&, const IDBIndexInfo&);
134     void didPerformDeleteIndex(uint64_t callbackIdentifier, const IDBError&, uint64_t objectStoreIdentifier, const String& indexName);
135     void didPerformPutOrAdd(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
136     void didPerformGetRecord(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
137     void didPerformGetCount(uint64_t callbackIdentifier, const IDBError&, uint64_t);
138     void didPerformDeleteRecord(uint64_t callbackIdentifier, const IDBError&);
139     void didPerformOpenCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
140     void didPerformIterateCursor(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
141     void didPerformCommitTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
142     void didPerformAbortTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
143     void didPerformActivateTransactionInBackingStore(uint64_t callbackIdentifier, const IDBError&);
144
145     uint64_t storeCallback(ErrorCallback);
146     uint64_t storeCallback(KeyDataCallback);
147     uint64_t storeCallback(GetResultCallback);
148     uint64_t storeCallback(CountCallback);
149
150     void performErrorCallback(uint64_t callbackIdentifier, const IDBError&);
151     void performKeyDataCallback(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
152     void performGetResultCallback(uint64_t callbackIdentifier, const IDBError&, const IDBGetResult&);
153     void performCountCallback(uint64_t callbackIdentifier, const IDBError&, uint64_t);
154
155     void invokeTransactionScheduler();
156     void transactionSchedulingTimerFired();
157     RefPtr<UniqueIDBDatabaseTransaction> takeNextRunnableTransaction(bool& hadDeferredTransactions);
158
159     IDBServer& m_server;
160     IDBDatabaseIdentifier m_identifier;
161     
162     Deque<Ref<IDBServerOperation>> m_pendingOpenDatabaseOperations;
163
164     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_openDatabaseConnections;
165     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_closePendingDatabaseConnections;
166
167     RefPtr<IDBServerOperation> m_versionChangeOperation;
168     RefPtr<UniqueIDBDatabaseConnection> m_versionChangeDatabaseConnection;
169     UniqueIDBDatabaseTransaction* m_versionChangeTransaction { nullptr };
170
171     std::unique_ptr<IDBBackingStore> m_backingStore;
172     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
173
174     HashMap<uint64_t, ErrorCallback> m_errorCallbacks;
175     HashMap<uint64_t, KeyDataCallback> m_keyDataCallbacks;
176     HashMap<uint64_t, GetResultCallback> m_getResultCallbacks;
177     HashMap<uint64_t, CountCallback> m_countCallbacks;
178
179     Timer m_transactionSchedulingTimer;
180
181     Deque<RefPtr<UniqueIDBDatabaseTransaction>> m_pendingTransactions;
182     HashMap<IDBResourceIdentifier, RefPtr<UniqueIDBDatabaseTransaction>> m_inProgressTransactions;
183
184     // The key into this set is the object store ID.
185     // The set counts how many transactions are open to the given object store.
186     // This helps make sure opening narrowly scoped transactions (one or two object stores)
187     // doesn't continuously block widely scoped write transactions.
188     HashCountedSet<uint64_t> m_objectStoreTransactionCounts;
189 };
190
191 } // namespace IDBServer
192 } // namespace WebCore
193
194 #endif // ENABLE(INDEXED_DATABASE)
195 #endif // UniqueIDBDatabase_h