Copy DatabaseTask.{h,cpp} to TaskSynchronizer.{h,cpp}

This CL just copies a file just to make the diff of
https://codereview.chromium.org/198673002/ saner.

TBR=tkent
NOTRY=true

Review URL: https://codereview.chromium.org/220703002

git-svn-id: svn://svn.chromium.org/blink/trunk@170531 bbb929c8-8fbe-4397-9dbb-9b2b20218538

third_party/WebKit/Source/platform/TaskSynchronizer.cpp

+/*
+ * Copyright (C) 2007, 2008, 2013 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1.  Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ * 2.  Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
+ *     its contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#include "config.h"
+#include "modules/webdatabase/DatabaseTask.h"
+
+#include "platform/Logging.h"
+#include "modules/webdatabase/Database.h"
+#include "modules/webdatabase/DatabaseContext.h"
+#include "modules/webdatabase/DatabaseThread.h"
+
+namespace WebCore {
+
+DatabaseTaskSynchronizer::DatabaseTaskSynchronizer()
+    : m_taskCompleted(false)
+#ifndef NDEBUG
+    , m_hasCheckedForTermination(false)
+#endif
+{
+}
+
+void DatabaseTaskSynchronizer::waitForTaskCompletion()
+{
+    // Prevent the deadlock between park request by other threads and blocking
+    // by m_synchronousCondition.
+    ThreadState::SafePointScope scope(ThreadState::HeapPointersOnStack);
+    m_synchronousMutex.lock();
+    while (!m_taskCompleted)
+        m_synchronousCondition.wait(m_synchronousMutex);
+    m_synchronousMutex.unlock();
+}
+
+void DatabaseTaskSynchronizer::taskCompleted()
+{
+    m_synchronousMutex.lock();
+    m_taskCompleted = true;
+    m_synchronousCondition.signal();
+    m_synchronousMutex.unlock();
+}
+
+DatabaseTask::DatabaseTask(DatabaseBackend* database, DatabaseTaskSynchronizer* synchronizer)
+    : m_database(database)
+    , m_synchronizer(synchronizer)
+#if !LOG_DISABLED
+    , m_complete(false)
+#endif
+{
+}
+
+DatabaseTask::~DatabaseTask()
+{
+#if !LOG_DISABLED
+    ASSERT(m_complete || !m_synchronizer);
+#endif
+}
+
+void DatabaseTask::run()
+{
+    // Database tasks are meant to be used only once, so make sure this one hasn't been performed before.
+#if !LOG_DISABLED
+    ASSERT(!m_complete);
+#endif
+
+    if (!m_synchronizer && !m_database->databaseContext()->databaseThread()->isDatabaseOpen(m_database.get())) {
+        taskCancelled();
+#if !LOG_DISABLED
+        m_complete = true;
+#endif
+        return;
+    }
+
+    WTF_LOG(StorageAPI, "Performing %s %p\n", debugTaskName(), this);
+
+    m_database->resetAuthorizer();
+    doPerformTask();
+
+    if (m_synchronizer)
+        m_synchronizer->taskCompleted();
+
+#if !LOG_DISABLED
+    m_complete = true;
+#endif
+}
+
+// *** DatabaseOpenTask ***
+// Opens the database file and verifies the version matches the expected version.
+
+DatabaseBackend::DatabaseOpenTask::DatabaseOpenTask(DatabaseBackend* database, bool setVersionInNewDatabase, DatabaseTaskSynchronizer* synchronizer, DatabaseError& error, String& errorMessage, bool& success)
+    : DatabaseTask(database, synchronizer)
+    , m_setVersionInNewDatabase(setVersionInNewDatabase)
+    , m_error(error)
+    , m_errorMessage(errorMessage)
+    , m_success(success)
+{
+    ASSERT(synchronizer); // A task with output parameters is supposed to be synchronous.
+}
+
+void DatabaseBackend::DatabaseOpenTask::doPerformTask()
+{
+    String errorMessage;
+    m_success = database()->performOpenAndVerify(m_setVersionInNewDatabase, m_error, errorMessage);
+    if (!m_success)
+        m_errorMessage = errorMessage.isolatedCopy();
+}
+
+#if !LOG_DISABLED
+const char* DatabaseBackend::DatabaseOpenTask::debugTaskName() const
+{
+    return "DatabaseOpenTask";
+}
+#endif
+
+// *** DatabaseCloseTask ***
+// Closes the database.
+
+DatabaseBackend::DatabaseCloseTask::DatabaseCloseTask(DatabaseBackend* database, DatabaseTaskSynchronizer* synchronizer)
+    : DatabaseTask(database, synchronizer)
+{
+}
+
+void DatabaseBackend::DatabaseCloseTask::doPerformTask()
+{
+    Database::from(database())->close();
+}
+
+#if !LOG_DISABLED
+const char* DatabaseBackend::DatabaseCloseTask::debugTaskName() const
+{
+    return "DatabaseCloseTask";
+}
+#endif
+
+// *** DatabaseTransactionTask ***
+// Starts a transaction that will report its results via a callback.
+
+DatabaseBackend::DatabaseTransactionTask::DatabaseTransactionTask(PassRefPtrWillBeRawPtr<SQLTransactionBackend> transaction)
+    : DatabaseTask(Database::from(transaction->database()), 0)
+    , m_transaction(transaction)
+{
+}
+
+DatabaseBackend::DatabaseTransactionTask::~DatabaseTransactionTask()
+{
+}
+
+void DatabaseBackend::DatabaseTransactionTask::doPerformTask()
+{
+    m_transaction->performNextStep();
+}
+
+void DatabaseBackend::DatabaseTransactionTask::taskCancelled()
+{
+    // If the task is being destructed without the transaction ever being run,
+    // then we must either have an error or an interruption. Give the
+    // transaction a chance to clean up since it may not have been able to
+    // run to its clean up state.
+
+    // Transaction phase 2 cleanup. See comment on "What happens if a
+    // transaction is interrupted?" at the top of SQLTransactionBackend.cpp.
+
+    m_transaction->notifyDatabaseThreadIsShuttingDown();
+}
+
+#if !LOG_DISABLED
+const char* DatabaseBackend::DatabaseTransactionTask::debugTaskName() const
+{
+    return "DatabaseTransactionTask";
+}
+#endif
+
+// *** DatabaseTableNamesTask ***
+// Retrieves a list of all tables in the database - for WebInspector support.
+
+DatabaseBackend::DatabaseTableNamesTask::DatabaseTableNamesTask(DatabaseBackend* database, DatabaseTaskSynchronizer* synchronizer, Vector<String>& names)
+    : DatabaseTask(database, synchronizer)
+    , m_tableNames(names)
+{
+    ASSERT(synchronizer); // A task with output parameters is supposed to be synchronous.
+}
+
+void DatabaseBackend::DatabaseTableNamesTask::doPerformTask()
+{
+    m_tableNames = Database::from(database())->performGetTableNames();
+}
+
+#if !LOG_DISABLED
+const char* DatabaseBackend::DatabaseTableNamesTask::debugTaskName() const
+{
+    return "DatabaseTableNamesTask";
+}
+#endif
+
+} // namespace WebCore

third_party/WebKit/Source/platform/TaskSynchronizer.h

+/*
+ * Copyright (C) 2007, 2008, 2013 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1.  Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ * 2.  Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
+ *     its contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#ifndef DatabaseTask_h
+#define DatabaseTask_h
+
+#include "heap/Handle.h"
+#include "modules/webdatabase/DatabaseBackend.h"
+#include "modules/webdatabase/DatabaseBasicTypes.h"
+#include "modules/webdatabase/DatabaseError.h"
+#include "modules/webdatabase/SQLTransactionBackend.h"
+#include "platform/Task.h"
+#include "wtf/OwnPtr.h"
+#include "wtf/PassOwnPtr.h"
+#include "wtf/PassRefPtr.h"
+#include "wtf/RefPtr.h"
+#include "wtf/Threading.h"
+#include "wtf/Vector.h"
+#include "wtf/text/WTFString.h"
+
+namespace WebCore {
+
+// Can be used to wait until DatabaseTask is completed.
+// Has to be passed into DatabaseTask::create to be associated with the task.
+class DatabaseTaskSynchronizer {
+    WTF_MAKE_NONCOPYABLE(DatabaseTaskSynchronizer);
+public:
+    DatabaseTaskSynchronizer();
+
+    // Called from main thread to wait until task is completed.
+    void waitForTaskCompletion();
+
+    // Called by the task.
+    void taskCompleted();
+
+#ifndef NDEBUG
+    bool hasCheckedForTermination() const { return m_hasCheckedForTermination; }
+    void setHasCheckedForTermination() { m_hasCheckedForTermination = true; }
+#endif
+
+private:
+    bool m_taskCompleted;
+    Mutex m_synchronousMutex;
+    ThreadCondition m_synchronousCondition;
+#ifndef NDEBUG
+    bool m_hasCheckedForTermination;
+#endif
+};
+
+class DatabaseTask : public blink::WebThread::Task {
+    WTF_MAKE_NONCOPYABLE(DatabaseTask); WTF_MAKE_FAST_ALLOCATED;
+public:
+    virtual ~DatabaseTask();
+
+    virtual void run() OVERRIDE FINAL;
+
+    DatabaseBackend* database() const { return m_database.get(); }
+#ifndef NDEBUG
+    bool hasSynchronizer() const { return m_synchronizer; }
+    bool hasCheckedForTermination() const { return m_synchronizer->hasCheckedForTermination(); }
+#endif
+
+protected:
+    DatabaseTask(DatabaseBackend*, DatabaseTaskSynchronizer*);
+
+private:
+    virtual void doPerformTask() = 0;
+    virtual void taskCancelled() { }
+
+    RefPtrWillBeCrossThreadPersistent<DatabaseBackend> m_database;
+    DatabaseTaskSynchronizer* m_synchronizer;
+
+#if !LOG_DISABLED
+    virtual const char* debugTaskName() const = 0;
+    bool m_complete;
+#endif
+};
+
+class DatabaseBackend::DatabaseOpenTask FINAL : public DatabaseTask {
+public:
+    static PassOwnPtr<DatabaseOpenTask> create(DatabaseBackend* db, bool setVersionInNewDatabase, DatabaseTaskSynchronizer* synchronizer, DatabaseError& error, String& errorMessage, bool& success)
+    {
+        return adoptPtr(new DatabaseOpenTask(db, setVersionInNewDatabase, synchronizer, error, errorMessage, success));
+    }
+
+private:
+    DatabaseOpenTask(DatabaseBackend*, bool setVersionInNewDatabase, DatabaseTaskSynchronizer*, DatabaseError&, String& errorMessage, bool& success);
+
+    virtual void doPerformTask() OVERRIDE;
+#if !LOG_DISABLED
+    virtual const char* debugTaskName() const OVERRIDE;
+#endif
+
+    bool m_setVersionInNewDatabase;
+    DatabaseError& m_error;
+    String& m_errorMessage;
+    bool& m_success;
+};
+
+class DatabaseBackend::DatabaseCloseTask FINAL : public DatabaseTask {
+public:
+    static PassOwnPtr<DatabaseCloseTask> create(DatabaseBackend* db, DatabaseTaskSynchronizer* synchronizer)
+    {
+        return adoptPtr(new DatabaseCloseTask(db, synchronizer));
+    }
+
+private:
+    DatabaseCloseTask(DatabaseBackend*, DatabaseTaskSynchronizer*);
+
+    virtual void doPerformTask() OVERRIDE;
+#if !LOG_DISABLED
+    virtual const char* debugTaskName() const OVERRIDE;
+#endif
+};
+
+class DatabaseBackend::DatabaseTransactionTask FINAL : public DatabaseTask {
+public:
+    virtual ~DatabaseTransactionTask();
+
+    // Transaction task is never synchronous, so no 'synchronizer' parameter.
+    static PassOwnPtr<DatabaseTransactionTask> create(PassRefPtrWillBeRawPtr<SQLTransactionBackend> transaction)
+    {
+        return adoptPtr(new DatabaseTransactionTask(transaction));
+    }
+
+    SQLTransactionBackend* transaction() const { return m_transaction.get(); }
+
+private:
+    explicit DatabaseTransactionTask(PassRefPtrWillBeRawPtr<SQLTransactionBackend>);
+
+    virtual void doPerformTask() OVERRIDE;
+    virtual void taskCancelled() OVERRIDE;
+#if !LOG_DISABLED
+    virtual const char* debugTaskName() const OVERRIDE;
+#endif
+
+    RefPtrWillBeCrossThreadPersistent<SQLTransactionBackend> m_transaction;
+};
+
+class DatabaseBackend::DatabaseTableNamesTask FINAL : public DatabaseTask {
+public:
+    static PassOwnPtr<DatabaseTableNamesTask> create(DatabaseBackend* db, DatabaseTaskSynchronizer* synchronizer, Vector<String>& names)
+    {
+        return adoptPtr(new DatabaseTableNamesTask(db, synchronizer, names));
+    }
+
+private:
+    DatabaseTableNamesTask(DatabaseBackend*, DatabaseTaskSynchronizer*, Vector<String>& names);
+
+    virtual void doPerformTask() OVERRIDE;
+#if !LOG_DISABLED
+    virtual const char* debugTaskName() const OVERRIDE;
+#endif
+
+    Vector<String>& m_tableNames;
+};
+
+} // namespace WebCore
+
+#endif // DatabaseTask_h