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