src/third_party/WebKit/Source/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 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 #ifndef DatabaseThread_h
  29 #define DatabaseThread_h
  30
  31 #include "platform/WebThreadSupportingGC.h"
  32 #include "platform/heap/Handle.h"
  33 #include "wtf/Deque.h"
  34 #include "wtf/HashMap.h"
  35 #include "wtf/HashSet.h"
  36 #include "wtf/OwnPtr.h"
  37 #include "wtf/PassOwnPtr.h"
  38 #include "wtf/PassRefPtr.h"
  39 #include "wtf/RefPtr.h"
  40 #include "wtf/ThreadSafeRefCounted.h"
  41 #include "wtf/ThreadingPrimitives.h"
  42
  43 namespace blink {
  44
  45 class Database;
  46 class DatabaseTask;
  47 class Document;
  48 class MessageLoopInterruptor;
  49 class PendingGCRunner;
  50 class SQLTransactionClient;
  51 class SQLTransactionCoordinator;
  52 class TaskSynchronizer;
  53
  54 class DatabaseThread : public ThreadSafeRefCountedWillBeGarbageCollectedFinalized<DatabaseThread> {
  55 public:
  56     static PassRefPtrWillBeRawPtr<DatabaseThread> create() { return adoptRefWillBeNoop(new DatabaseThread); }
  57     ~DatabaseThread();
  58     void trace(Visitor*);
  59
  60     void start();
  61     void terminate();
  62     bool terminationRequested() const;
  63
  64     void scheduleTask(PassOwnPtr<DatabaseTask>);
  65
  66     void recordDatabaseOpen(Database*);
  67     void recordDatabaseClosed(Database*);
  68     bool isDatabaseOpen(Database*);
  69
  70     bool isDatabaseThread() { return m_thread && m_thread->isCurrentThread(); }
  71
  72     SQLTransactionClient* transactionClient() { return m_transactionClient.get(); }
  73     SQLTransactionCoordinator* transactionCoordinator() { return m_transactionCoordinator.get(); }
  74
  75 private:
  76     DatabaseThread();
  77
  78     void setupDatabaseThread();
  79     void cleanupDatabaseThread();
  80     void cleanupDatabaseThreadCompleted();
  81
  82     OwnPtr<WebThreadSupportingGC> m_thread;
  83
  84     // This set keeps track of the open databases that have been used on this thread.
  85     // This must be updated in the database thread though it is constructed and
  86     // destructed in the context thread.
  87     WillBeHeapHashSet<RefPtrWillBeMember<Database> > m_openDatabaseSet;
  88
  89     OwnPtr<SQLTransactionClient> m_transactionClient;
  90     OwnPtrWillBeMember<SQLTransactionCoordinator> m_transactionCoordinator;
  91     TaskSynchronizer* m_cleanupSync;
  92
  93     mutable Mutex m_terminationRequestedMutex;
  94     bool m_terminationRequested;
  95 };
  96
  97 } // namespace blink
  98
  99 #endif // DatabaseThread_h