5e659eaaf49581b7f38db2207491a2d628d13676
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / leveldb / IDBTransactionBackendLevelDB.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 IDBTransactionBackendLevelDB_h
27 #define IDBTransactionBackendLevelDB_h
28
29 #if ENABLE(INDEXED_DATABASE) && USE(LEVELDB)
30
31 #include "IDBBackingStoreLevelDB.h"
32 #include "IDBDatabaseBackendInterface.h"
33 #include "IDBDatabaseBackendLevelDB.h"
34 #include "IDBDatabaseError.h"
35 #include "IDBTransactionBackendInterface.h"
36 #include "Timer.h"
37 #include <wtf/Deque.h>
38 #include <wtf/HashSet.h>
39 #include <wtf/RefPtr.h>
40
41 namespace WebCore {
42
43 class IDBBackingStoreLevelDB;
44 class IDBCursorBackendLevelDB;
45 class IDBDatabaseCallbacks;
46
47 class IDBTransactionBackendLevelDB FINAL : public IDBTransactionBackendInterface {
48 public:
49     static PassRefPtr<IDBTransactionBackendLevelDB> create(IDBDatabaseBackendLevelDB*, int64_t transactionId, PassRefPtr<IDBDatabaseCallbacks>, const Vector<int64_t>& objectStoreIds, IndexedDB::TransactionMode);
50     virtual ~IDBTransactionBackendLevelDB();
51
52     virtual void commit() OVERRIDE FINAL;
53     virtual void abort() OVERRIDE FINAL;
54     virtual void abort(PassRefPtr<IDBDatabaseError>) OVERRIDE FINAL;
55
56     class Operation {
57     public:
58         virtual ~Operation() { }
59         virtual void perform() = 0;
60     };
61
62     virtual void run() OVERRIDE;
63     virtual IndexedDB::TransactionMode mode() const OVERRIDE FINAL { return m_mode; }
64     const HashSet<int64_t>& scope() const OVERRIDE { return m_objectStoreIds; }
65     void scheduleTask(PassOwnPtr<Operation> task, PassOwnPtr<Operation> abortTask = nullptr) { scheduleTask(IDBDatabaseBackendInterface::NormalTask, task, abortTask); }
66     void scheduleTask(IDBDatabaseBackendInterface::TaskType, PassOwnPtr<Operation>, PassOwnPtr<Operation> abortTask = nullptr);
67     void registerOpenCursor(IDBCursorBackendLevelDB*);
68     void unregisterOpenCursor(IDBCursorBackendLevelDB*);
69     void addPreemptiveEvent() { m_pendingPreemptiveEvents++; }
70     void didCompletePreemptiveEvent() { m_pendingPreemptiveEvents--; ASSERT(m_pendingPreemptiveEvents >= 0); }
71     virtual IDBBackingStoreInterface::Transaction* backingStoreTransaction() { return &m_transaction; }
72
73     IDBDatabaseBackendLevelDB* database() const { return m_database.get(); }
74
75     virtual void scheduleCreateObjectStoreOperation(const IDBObjectStoreMetadata&) OVERRIDE FINAL;
76     virtual void scheduleDeleteObjectStoreOperation(const IDBObjectStoreMetadata&) OVERRIDE FINAL;
77     virtual void scheduleVersionChangeOperation(int64_t transactionId, int64_t requestedVersion, PassRefPtr<IDBCallbacks>, PassRefPtr<IDBDatabaseCallbacks>, const IDBDatabaseMetadata&) OVERRIDE FINAL;
78     virtual void scheduleCreateIndexOperation(int64_t objectStoreId, const IDBIndexMetadata&) OVERRIDE FINAL;
79     virtual void scheduleDeleteIndexOperation(int64_t objectStoreId, const IDBIndexMetadata&) OVERRIDE FINAL;
80     virtual void scheduleGetOperation(const IDBDatabaseMetadata&, int64_t objectStoreId, int64_t indexId, PassRefPtr<IDBKeyRange>, IndexedDB::CursorType, PassRefPtr<IDBCallbacks>) OVERRIDE FINAL;
81     virtual void schedulePutOperation(const IDBObjectStoreMetadata&, PassRefPtr<SharedBuffer> value, PassRefPtr<IDBKey>, IDBDatabaseBackendInterface::PutMode, PassRefPtr<IDBCallbacks>, const Vector<int64_t>& indexIds, const Vector<IndexKeys>&) OVERRIDE FINAL;
82     virtual void scheduleSetIndexesReadyOperation(size_t indexCount) OVERRIDE FINAL;
83     virtual void scheduleOpenCursorOperation(int64_t objectStoreId, int64_t indexId, PassRefPtr<IDBKeyRange>, IndexedDB::CursorDirection, IndexedDB::CursorType, IDBDatabaseBackendInterface::TaskType, PassRefPtr<IDBCallbacks>) OVERRIDE FINAL;
84     virtual void scheduleCountOperation(int64_t objectStoreId, int64_t indexId, PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>) OVERRIDE FINAL;
85     virtual void scheduleDeleteRangeOperation(int64_t objectStoreId, PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>) OVERRIDE FINAL;
86     virtual void scheduleClearOperation(int64_t objectStoreId, PassRefPtr<IDBCallbacks>) OVERRIDE FINAL;
87     
88 private:
89     IDBTransactionBackendLevelDB(IDBDatabaseBackendLevelDB*, int64_t id, PassRefPtr<IDBDatabaseCallbacks>, const HashSet<int64_t>& objectStoreIds, IndexedDB::TransactionMode);
90
91     enum State {
92         Unused, // Created, but no tasks yet.
93         StartPending, // Enqueued tasks, but backing store transaction not yet started.
94         Running, // Backing store transaction started but not yet finished.
95         Finished, // Either aborted or committed.
96     };
97
98     void start();
99
100     bool isTaskQueueEmpty() const;
101     bool hasPendingTasks() const;
102
103     void taskTimerFired(Timer<IDBTransactionBackendLevelDB>*);
104     void closeOpenCursors();
105
106     const HashSet<int64_t> m_objectStoreIds;
107     const IndexedDB::TransactionMode m_mode;
108
109     State m_state;
110     bool m_commitPending;
111     RefPtr<IDBDatabaseCallbacks> m_callbacks;
112     RefPtr<IDBDatabaseBackendLevelDB> m_database;
113
114     typedef Deque<OwnPtr<Operation>> TaskQueue;
115     TaskQueue m_taskQueue;
116     TaskQueue m_preemptiveTaskQueue;
117     TaskQueue m_abortTaskQueue;
118
119     IDBBackingStoreLevelDB::Transaction m_transaction;
120
121     // FIXME: delete the timer once we have threads instead.
122     Timer<IDBTransactionBackendLevelDB> m_taskTimer;
123     int m_pendingPreemptiveEvents;
124
125     HashSet<IDBCursorBackendLevelDB*> m_openCursors;
126     
127     RefPtr<IDBBackingStoreInterface> m_backingStore;
128 };
129
130 } // namespace WebCore
131
132 #endif // ENABLE(INDEXED_DATABASE) && USE(LEVELDB)
133
134 #endif // IDBTransactionBackendLevelDB_h