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