3cef9762ae1027e8884e9826f4791f6364a34b06
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBTransactionBackendImpl.h
1 /*
2  * Copyright (C) 2010 Google 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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef IDBTransactionBackendImpl_h
27 #define IDBTransactionBackendImpl_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBBackingStore.h"
32 #include "IDBDatabaseBackendInterface.h"
33 #include "IDBDatabaseError.h"
34 #include "IDBTransaction.h"
35 #include "Timer.h"
36 #include <wtf/Deque.h>
37 #include <wtf/HashSet.h>
38 #include <wtf/RefPtr.h>
39
40 namespace WebCore {
41
42 class IDBDatabaseBackendImpl;
43 class IDBCursorBackendImpl;
44 class IDBDatabaseCallbacks;
45
46 class IDBTransactionBackendImpl : public RefCounted<IDBTransactionBackendImpl> {
47 public:
48     static PassRefPtr<IDBTransactionBackendImpl> create(int64_t transactionId, PassRefPtr<IDBDatabaseCallbacks>, const Vector<int64_t>&, IDBTransaction::Mode, IDBDatabaseBackendImpl*);
49     virtual ~IDBTransactionBackendImpl();
50
51     virtual void abort();
52     void commit();
53
54     class Operation {
55     public:
56         virtual ~Operation() { }
57         virtual void perform(IDBTransactionBackendImpl*) = 0;
58     };
59
60     void abort(PassRefPtr<IDBDatabaseError>);
61     void run();
62     IDBTransaction::Mode mode() const { return m_mode; }
63     const HashSet<int64_t>& scope() const { return m_objectStoreIds; }
64     void scheduleTask(PassOwnPtr<Operation> task, PassOwnPtr<Operation> abortTask = nullptr) { scheduleTask(IDBDatabaseBackendInterface::NormalTask, task, abortTask); }
65     void scheduleTask(IDBDatabaseBackendInterface::TaskType, PassOwnPtr<Operation>, PassOwnPtr<Operation> abortTask = nullptr);
66     void registerOpenCursor(IDBCursorBackendImpl*);
67     void unregisterOpenCursor(IDBCursorBackendImpl*);
68     void addPreemptiveEvent() { m_pendingPreemptiveEvents++; }
69     void didCompletePreemptiveEvent() { m_pendingPreemptiveEvents--; ASSERT(m_pendingPreemptiveEvents >= 0); }
70     IDBBackingStore::Transaction* backingStoreTransaction() { return &m_transaction; }
71     int64_t id() const { return m_id; }
72
73     IDBDatabaseBackendImpl* database() const { return m_database.get(); }
74
75 private:
76     IDBTransactionBackendImpl(int64_t id, PassRefPtr<IDBDatabaseCallbacks>, const HashSet<int64_t>& objectStoreIds, IDBTransaction::Mode, IDBDatabaseBackendImpl*);
77
78     enum State {
79         Unused, // Created, but no tasks yet.
80         StartPending, // Enqueued tasks, but backing store transaction not yet started.
81         Running, // Backing store transaction started but not yet finished.
82         Finished, // Either aborted or committed.
83     };
84
85     void start();
86
87     bool isTaskQueueEmpty() const;
88     bool hasPendingTasks() const;
89
90     void taskTimerFired(Timer<IDBTransactionBackendImpl>*);
91     void closeOpenCursors();
92
93     const int64_t m_id;
94     const HashSet<int64_t> m_objectStoreIds;
95     const IDBTransaction::Mode m_mode;
96
97     State m_state;
98     bool m_commitPending;
99     RefPtr<IDBDatabaseCallbacks> m_callbacks;
100     RefPtr<IDBDatabaseBackendImpl> m_database;
101
102     typedef Deque<OwnPtr<Operation> > TaskQueue;
103     TaskQueue m_taskQueue;
104     TaskQueue m_preemptiveTaskQueue;
105     TaskQueue m_abortTaskQueue;
106
107     IDBBackingStore::Transaction m_transaction;
108
109     // FIXME: delete the timer once we have threads instead.
110     Timer<IDBTransactionBackendImpl> m_taskTimer;
111     int m_pendingPreemptiveEvents;
112
113     HashSet<IDBCursorBackendImpl*> m_openCursors;
114 };
115
116 } // namespace WebCore
117
118 #endif // ENABLE(INDEXED_DATABASE)
119
120 #endif // IDBTransactionBackendImpl_h