src/third_party/WebKit/Source/modules/webdatabase/DatabaseThread.cpp

   1 /*
   2  * Copyright (C) 2007, 2008, 2013 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 "modules/webdatabase/DatabaseThread.h"
  31
  32 #include "modules/webdatabase/Database.h"
  33 #include "modules/webdatabase/DatabaseTask.h"
  34 #include "modules/webdatabase/SQLTransactionClient.h"
  35 #include "modules/webdatabase/SQLTransactionCoordinator.h"
  36 #include "platform/Logging.h"
  37 #include "platform/heap/glue/MessageLoopInterruptor.h"
  38 #include "platform/heap/glue/PendingGCRunner.h"
  39 #include "public/platform/Platform.h"
  40
  41 namespace blink {
  42
  43 DatabaseThread::DatabaseThread()
  44     : m_transactionClient(adoptPtr(new SQLTransactionClient()))
  45     , m_transactionCoordinator(new SQLTransactionCoordinator())
  46     , m_cleanupSync(0)
  47     , m_terminationRequested(false)
  48 {
  49 }
  50
  51 DatabaseThread::~DatabaseThread()
  52 {
  53     ASSERT(m_openDatabaseSet.isEmpty());
  54     ASSERT(!m_thread);
  55 }
  56
  57 void DatabaseThread::trace(Visitor* visitor)
  58 {
  59     visitor->trace(m_openDatabaseSet);
  60     visitor->trace(m_transactionCoordinator);
  61 }
  62
  63 void DatabaseThread::start()
  64 {
  65     if (m_thread)
  66         return;
  67     m_thread = WebThreadSupportingGC::create("WebCore: Database");
  68     m_thread->postTask(new Task(WTF::bind(&DatabaseThread::setupDatabaseThread, this)));
  69 }
  70
  71 void DatabaseThread::setupDatabaseThread()
  72 {
  73     m_thread->attachGC();
  74 }
  75
  76 void DatabaseThread::terminate()
  77 {
  78     TaskSynchronizer sync;
  79     {
  80         MutexLocker lock(m_terminationRequestedMutex);
  81         ASSERT(!m_terminationRequested);
  82         m_terminationRequested = true;
  83         m_cleanupSync = &sync;
  84         WTF_LOG(StorageAPI, "DatabaseThread %p was asked to terminate\n", this);
  85         m_thread->postTask(new Task(WTF::bind(&DatabaseThread::cleanupDatabaseThread, this)));
  86     }
  87     sync.waitForTaskCompletion();
  88     // The WebThread destructor blocks until all the tasks of the database
  89     // thread are processed. However, it shouldn't block at all because
  90     // the database thread has already finished processing the cleanup task.
  91     m_thread.clear();
  92 }
  93
  94 bool DatabaseThread::terminationRequested() const
  95 {
  96     MutexLocker lock(m_terminationRequestedMutex);
  97     return m_terminationRequested;
  98 }
  99
 100 void DatabaseThread::cleanupDatabaseThread()
 101 {
 102     WTF_LOG(StorageAPI, "Cleaning up DatabaseThread %p", this);
 103
 104     // Clean up the list of all pending transactions on this database thread
 105     m_transactionCoordinator->shutdown();
 106
 107     // Close the databases that we ran transactions on. This ensures that if any transactions are still open, they are rolled back and we don't leave the database in an
 108     // inconsistent or locked state.
 109     if (m_openDatabaseSet.size() > 0) {
 110         // As the call to close will modify the original set, we must take a copy to iterate over.
 111         HeapHashSet<Member<Database> > openSetCopy;
 112         openSetCopy.swap(m_openDatabaseSet);
 113         HeapHashSet<Member<Database> >::iterator end = openSetCopy.end();
 114         for (HeapHashSet<Member<Database> >::iterator it = openSetCopy.begin(); it != end; ++it)
 115             (*it)->close();
 116     }
 117     m_openDatabaseSet.clear();
 118
 119     m_thread->postTask(new Task(WTF::bind(&DatabaseThread::cleanupDatabaseThreadCompleted, this)));
 120 }
 121
 122 void DatabaseThread::cleanupDatabaseThreadCompleted()
 123 {
 124     m_thread->detachGC();
 125     if (m_cleanupSync) // Someone wanted to know when we were done cleaning up.
 126         m_cleanupSync->taskCompleted();
 127 }
 128
 129 void DatabaseThread::recordDatabaseOpen(Database* database)
 130 {
 131     ASSERT(isDatabaseThread());
 132     ASSERT(database);
 133     ASSERT(!m_openDatabaseSet.contains(database));
 134     MutexLocker lock(m_terminationRequestedMutex);
 135     if (!m_terminationRequested)
 136         m_openDatabaseSet.add(database);
 137 }
 138
 139 void DatabaseThread::recordDatabaseClosed(Database* database)
 140 {
 141     ASSERT(isDatabaseThread());
 142     ASSERT(database);
 143     ASSERT(m_terminationRequested || m_openDatabaseSet.contains(database));
 144     m_openDatabaseSet.remove(database);
 145 }
 146
 147 bool DatabaseThread::isDatabaseOpen(Database* database)
 148 {
 149     ASSERT(isDatabaseThread());
 150     ASSERT(database);
 151     MutexLocker lock(m_terminationRequestedMutex);
 152     return !m_terminationRequested && m_openDatabaseSet.contains(database);
 153 }
 154
 155 void DatabaseThread::scheduleTask(PassOwnPtr<DatabaseTask> task)
 156 {
 157     ASSERT(m_thread);
 158     ASSERT(!terminationRequested());
 159     // WebThread takes ownership of the task.
 160     m_thread->postTask(task.leakPtr());
 161 }
 162
 163 } // namespace blink