8fdab790c9aabfeaffa6c4a3076038d705889f31
[WebKit-https.git] / Source / WebCore / Modules / webdatabase / DatabaseThread.h
1 /*
2  * Copyright (C) 2007, 2008 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef DatabaseThread_h
29 #define DatabaseThread_h
30
31 #include <memory>
32 #include <wtf/Deque.h>
33 #include <wtf/HashMap.h>
34 #include <wtf/HashSet.h>
35 #include <wtf/MessageQueue.h>
36 #include <wtf/RefPtr.h>
37 #include <wtf/Threading.h>
38
39 namespace WebCore {
40
41 class Database;
42 class DatabaseTask;
43 class DatabaseTaskSynchronizer;
44 class Document;
45 class SQLTransactionClient;
46 class SQLTransactionCoordinator;
47
48 class DatabaseThread : public ThreadSafeRefCounted<DatabaseThread> {
49 public:
50     static Ref<DatabaseThread> create() { return adoptRef(*new DatabaseThread); }
51     ~DatabaseThread();
52
53     bool start();
54     void requestTermination(DatabaseTaskSynchronizer* cleanupSync);
55     bool terminationRequested(DatabaseTaskSynchronizer* = nullptr) const;
56
57     void scheduleTask(std::unique_ptr<DatabaseTask>);
58     void scheduleImmediateTask(std::unique_ptr<DatabaseTask>); // This just adds the task to the front of the queue - the caller needs to be extremely careful not to create deadlocks when waiting for completion.
59     void unscheduleDatabaseTasks(Database*);
60     bool hasPendingDatabaseActivity() const;
61
62     void recordDatabaseOpen(Database*);
63     void recordDatabaseClosed(Database*);
64     ThreadIdentifier getThreadID() { return m_threadID; }
65
66     SQLTransactionClient* transactionClient() { return m_transactionClient.get(); }
67     SQLTransactionCoordinator* transactionCoordinator() { return m_transactionCoordinator.get(); }
68
69 private:
70     DatabaseThread();
71
72     static void databaseThreadStart(void*);
73     void databaseThread();
74
75     DeprecatedMutex m_threadCreationMutex;
76     ThreadIdentifier m_threadID;
77     RefPtr<DatabaseThread> m_selfRef;
78
79     MessageQueue<DatabaseTask> m_queue;
80
81     // This set keeps track of the open databases that have been used on this thread.
82     typedef HashSet<RefPtr<Database>> DatabaseSet;
83     DatabaseSet m_openDatabaseSet;
84
85     std::unique_ptr<SQLTransactionClient> m_transactionClient;
86     std::unique_ptr<SQLTransactionCoordinator> m_transactionCoordinator;
87     DatabaseTaskSynchronizer* m_cleanupSync;
88 };
89
90 } // namespace WebCore
91
92 #endif // DatabaseThread_h