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(adoptPtrWillBeNoop(new SQLTransactionCoordinator()))
  46     , m_cleanupSync(0)
  47     , m_terminationRequested(false)
  48 {
  49 }
  50
  51 DatabaseThread::~DatabaseThread()
  52 {
  53     ASSERT(m_openDatabaseSet.isEmpty());
  54     // Oilpan: The database thread must have finished its cleanup tasks before
  55     // the following clear(). Otherwise, WebThread destructor blocks the caller
  56     // thread, and causes a deadlock with ThreadState cleanup.
  57     // DatabaseContext::stop() asks the database thread to close all of
  58     // databases, and wait until GC heap cleanup of the database thread. So we
  59     // can safely destruct WebThread here.
  60     m_thread.clear();
  61 }
  62
  63 void DatabaseThread::trace(Visitor* visitor)
  64 {
  65 #if ENABLE(OILPAN)
  66     visitor->trace(m_openDatabaseSet);
  67     visitor->trace(m_transactionCoordinator);
  68 #endif
  69 }
  70
  71 void DatabaseThread::start()
  72 {
  73     if (m_thread)
  74         return;
  75     m_thread = adoptPtr(Platform::current()->createThread("WebCore: Database"));
  76     m_thread->postTask(new Task(WTF::bind(&DatabaseThread::setupDatabaseThread, this)));
  77 }
  78
  79 void DatabaseThread::setupDatabaseThread()
  80 {
  81     m_pendingGCRunner = adoptPtr(new PendingGCRunner);
  82     m_messageLoopInterruptor = adoptPtr(new MessageLoopInterruptor(m_thread.get()));
  83     m_thread->addTaskObserver(m_pendingGCRunner.get());
  84     ThreadState::attach();
  85     ThreadState::current()->addInterruptor(m_messageLoopInterruptor.get());
  86 }
  87
  88 void DatabaseThread::requestTermination(TaskSynchronizer *cleanupSync)
  89 {
  90     MutexLocker lock(m_terminationRequestedMutex);
  91     ASSERT(!m_terminationRequested);
  92     m_terminationRequested = true;
  93     m_cleanupSync = cleanupSync;
  94     WTF_LOG(StorageAPI, "DatabaseThread %p was asked to terminate\n", this);
  95     m_thread->postTask(new Task(WTF::bind(&DatabaseThread::cleanupDatabaseThread, this)));
  96 }
  97
  98 bool DatabaseThread::terminationRequested(TaskSynchronizer* taskSynchronizer) const
  99 {
 100 #if ENABLE(ASSERT)
 101     if (taskSynchronizer)
 102         taskSynchronizer->setHasCheckedForTermination();
 103 #endif
 104
 105     MutexLocker lock(m_terminationRequestedMutex);
 106     return m_terminationRequested;
 107 }
 108
 109 void DatabaseThread::cleanupDatabaseThread()
 110 {
 111     WTF_LOG(StorageAPI, "Cleaning up DatabaseThread %p", this);
 112
 113     // Clean up the list of all pending transactions on this database thread
 114     m_transactionCoordinator->shutdown();
 115
 116     // 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
 117     // inconsistent or locked state.
 118     if (m_openDatabaseSet.size() > 0) {
 119         // As the call to close will modify the original set, we must take a copy to iterate over.
 120         WillBeHeapHashSet<RefPtrWillBeMember<DatabaseBackend> > openSetCopy;
 121         openSetCopy.swap(m_openDatabaseSet);
 122         WillBeHeapHashSet<RefPtrWillBeMember<DatabaseBackend> >::iterator end = openSetCopy.end();
 123         for (WillBeHeapHashSet<RefPtrWillBeMember<DatabaseBackend> >::iterator it = openSetCopy.begin(); it != end; ++it)
 124             (*it)->close();
 125     }
 126
 127     m_thread->postTask(new Task(WTF::bind(&DatabaseThread::cleanupDatabaseThreadCompleted, this)));
 128 }
 129
 130 void DatabaseThread::cleanupDatabaseThreadCompleted()
 131 {
 132     ThreadState::current()->removeInterruptor(m_messageLoopInterruptor.get());
 133     ThreadState::detach();
 134     // We need to unregister PendingGCRunner before finising this task to avoid
 135     // PendingGCRunner::didProcessTask accesses dead ThreadState.
 136     m_thread->removeTaskObserver(m_pendingGCRunner.get());
 137
 138     if (m_cleanupSync) // Someone wanted to know when we were done cleaning up.
 139         m_cleanupSync->taskCompleted();
 140 }
 141
 142 void DatabaseThread::recordDatabaseOpen(DatabaseBackend* database)
 143 {
 144     ASSERT(isDatabaseThread());
 145     ASSERT(database);
 146     ASSERT(!m_openDatabaseSet.contains(database));
 147     m_openDatabaseSet.add(database);
 148 }
 149
 150 void DatabaseThread::recordDatabaseClosed(DatabaseBackend* database)
 151 {
 152     ASSERT(isDatabaseThread());
 153     ASSERT(database);
 154     ASSERT(m_terminationRequested || m_openDatabaseSet.contains(database));
 155     m_openDatabaseSet.remove(database);
 156 }
 157
 158 bool DatabaseThread::isDatabaseOpen(DatabaseBackend* database)
 159 {
 160     ASSERT(isDatabaseThread());
 161     ASSERT(database);
 162     MutexLocker lock(m_terminationRequestedMutex);
 163     return !m_terminationRequested && m_openDatabaseSet.contains(database);
 164 }
 165
 166 void DatabaseThread::scheduleTask(PassOwnPtr<DatabaseTask> task)
 167 {
 168     ASSERT(m_thread);
 169     ASSERT(!task->hasSynchronizer() || task->hasCheckedForTermination());
 170     // WebThread takes ownership of the task.
 171     m_thread->postTask(task.leakPtr());
 172 }
 173
 174 } // namespace blink