Modern IDB: Pipe through cursor functions from client to server.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / IDBServer.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 IDBServer_h
27 #define IDBServer_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "CrossThreadTask.h"
32 #include "IDBConnectionToClient.h"
33 #include "IDBDatabaseIdentifier.h"
34 #include "UniqueIDBDatabase.h"
35 #include "UniqueIDBDatabaseConnection.h"
36 #include <wtf/HashMap.h>
37 #include <wtf/Lock.h>
38 #include <wtf/MessageQueue.h>
39 #include <wtf/Ref.h>
40 #include <wtf/RefCounted.h>
41 #include <wtf/RefPtr.h>
42
43 namespace WebCore {
44
45 class CrossThreadTask;
46 class IDBCursorInfo;
47 class IDBRequestData;
48
49 namespace IDBServer {
50
51 class IDBServer : public RefCounted<IDBServer> {
52 public:
53     static Ref<IDBServer> create();
54
55     void registerConnection(IDBConnectionToClient&);
56     void unregisterConnection(IDBConnectionToClient&);
57
58     // Operations requested by the client.
59     void openDatabase(const IDBRequestData&);
60     void deleteDatabase(const IDBRequestData&);
61     void abortTransaction(const IDBResourceIdentifier&);
62     void commitTransaction(const IDBResourceIdentifier&);
63     void createObjectStore(const IDBRequestData&, const IDBObjectStoreInfo&);
64     void deleteObjectStore(const IDBRequestData&, const String& objectStoreName);
65     void clearObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier);
66     void createIndex(const IDBRequestData&, const IDBIndexInfo&);
67     void putOrAdd(const IDBRequestData&, const IDBKeyData&, const ThreadSafeDataBuffer& valueData, IndexedDB::ObjectStoreOverwriteMode);
68     void getRecord(const IDBRequestData&, const IDBKeyRangeData&);
69     void getCount(const IDBRequestData&, const IDBKeyRangeData&);
70     void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&);
71     void openCursor(const IDBRequestData&, const IDBCursorInfo&);
72     void iterateCursor(const IDBRequestData&, const IDBKeyData&, unsigned long count);
73
74     void establishTransaction(uint64_t databaseConnectionIdentifier, const IDBTransactionInfo&);
75     void databaseConnectionClosed(uint64_t databaseConnectionIdentifier);
76
77     void postDatabaseTask(std::unique_ptr<CrossThreadTask>&&);
78     void postDatabaseTaskReply(std::unique_ptr<CrossThreadTask>&&);
79
80     void registerDatabaseConnection(UniqueIDBDatabaseConnection&);
81     void unregisterDatabaseConnection(UniqueIDBDatabaseConnection&);
82     void registerTransaction(UniqueIDBDatabaseTransaction&);
83     void unregisterTransaction(UniqueIDBDatabaseTransaction&);
84
85     std::unique_ptr<IDBBackingStore> createBackingStore(const IDBDatabaseIdentifier&);
86
87 private:
88     IDBServer();
89
90     UniqueIDBDatabase& getOrCreateUniqueIDBDatabase(const IDBDatabaseIdentifier&);
91
92     static void databaseThreadEntry(void*);
93     void databaseRunLoop();
94     void handleTaskRepliesOnMainThread();
95
96     HashMap<uint64_t, RefPtr<IDBConnectionToClient>> m_connectionMap;
97     HashMap<IDBDatabaseIdentifier, RefPtr<UniqueIDBDatabase>> m_uniqueIDBDatabaseMap;
98
99     ThreadIdentifier m_threadID { 0 };
100     Lock m_databaseThreadCreationLock;
101     Lock m_mainThreadReplyLock;
102     bool m_mainThreadReplyScheduled { false };
103
104     MessageQueue<CrossThreadTask> m_databaseQueue;
105     MessageQueue<CrossThreadTask> m_databaseReplyQueue;
106
107     HashMap<uint64_t, UniqueIDBDatabaseConnection*> m_databaseConnections;
108     HashMap<IDBResourceIdentifier, UniqueIDBDatabaseTransaction*> m_transactions;
109 };
110
111 } // namespace IDBServer
112 } // namespace WebCore
113
114 #endif // ENABLE(INDEXED_DATABASE)
115 #endif // IDBServer_h