2009-03-11 Darin Adler <darin@apple.com>
[WebKit-https.git] / WebCore / storage / DatabaseThread.cpp
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 Computer, 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
29 #include "config.h"
30 #include "DatabaseThread.h"
31
32 #include "AutodrainedPool.h"
33 #include "Database.h"
34 #include "DatabaseTask.h"
35 #include "Logging.h"
36
37 namespace WebCore {
38
39 DatabaseThread::DatabaseThread()
40     : m_threadID(0)
41 {
42     m_selfRef = this;
43 }
44
45 DatabaseThread::~DatabaseThread()
46 {
47     // FIXME: Any cleanup required here?  Since the thread deletes itself after running its detached course, I don't think so.  Lets be sure.
48 }
49
50 bool DatabaseThread::start()
51 {
52     MutexLocker lock(m_threadCreationMutex);
53
54     if (m_threadID)
55         return true;
56
57     m_threadID = createThread(DatabaseThread::databaseThreadStart, this, "WebCore: Database");
58
59     return m_threadID;
60 }
61
62 void DatabaseThread::requestTermination()
63 {
64     LOG(StorageAPI, "DatabaseThread %p was asked to terminate\n", this);
65     m_queue.kill();
66 }
67
68 bool DatabaseThread::terminationRequested() const
69 {
70     return m_queue.killed();
71 }
72
73 void* DatabaseThread::databaseThreadStart(void* vDatabaseThread)
74 {
75     DatabaseThread* dbThread = static_cast<DatabaseThread*>(vDatabaseThread);
76     return dbThread->databaseThread();
77 }
78
79 void* DatabaseThread::databaseThread()
80 {
81     {
82         // Wait for DatabaseThread::start() to complete.
83         MutexLocker lock(m_threadCreationMutex);
84         LOG(StorageAPI, "Started DatabaseThread %p", this);
85     }
86
87     AutodrainedPool pool;
88     while (true) {
89         RefPtr<DatabaseTask> task;
90         if (!m_queue.waitForMessage(task))
91             break;
92
93         task->performTask();
94
95         pool.cycle();
96     }
97
98     LOG(StorageAPI, "About to detach thread %i and clear the ref to DatabaseThread %p, which currently has %i ref(s)", m_threadID, this, refCount());
99
100     // Detach the thread so its resources are no longer of any concern to anyone else
101     detachThread(m_threadID);
102
103     // Clear the self refptr, possibly resulting in deletion
104     m_selfRef = 0;
105
106     return 0;
107 }
108
109 void DatabaseThread::scheduleTask(PassRefPtr<DatabaseTask> task)
110 {
111     m_queue.append(task);
112 }
113
114 void DatabaseThread::scheduleImmediateTask(PassRefPtr<DatabaseTask> task)
115 {
116     m_queue.prepend(task);
117 }
118
119 void DatabaseThread::unscheduleDatabaseTasks(Database* database)
120 {
121     // Note that the thread loop is running, so some tasks for the database
122     // may still be executed. This is unavoidable.
123
124     Deque<RefPtr<DatabaseTask> > filteredReverseQueue;
125     RefPtr<DatabaseTask> task;
126     while (m_queue.tryGetMessage(task)) {
127         if (task->database() != database)
128             filteredReverseQueue.append(task);
129     }
130
131     while (!filteredReverseQueue.isEmpty()) {
132         m_queue.append(filteredReverseQueue.first());
133         filteredReverseQueue.removeFirst();
134     }
135 }
136
137 } // namespace WebCore