IndexedDB 2.0: Cache and reuse SQLiteStatements in the SQLite backend.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / SQLiteIDBBackingStore.h
1 /*
2  * Copyright (C) 2016 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(INDEXED_DATABASE)
29
30 #include "IDBBackingStore.h"
31 #include "IDBDatabaseIdentifier.h"
32 #include "IDBDatabaseInfo.h"
33 #include "IDBResourceIdentifier.h"
34 #include "SQLiteIDBTransaction.h"
35 #include <JavaScriptCore/Strong.h>
36 #include <wtf/HashMap.h>
37
38 namespace WebCore {
39
40 class IndexKey;
41 class SQLiteDatabase;
42 class SQLiteStatement;
43
44 namespace IDBServer {
45
46 class SQLiteIDBCursor;
47
48 class SQLiteIDBBackingStore : public IDBBackingStore {
49 public:
50     SQLiteIDBBackingStore(const IDBDatabaseIdentifier&, const String& databaseRootDirectory, IDBBackingStoreTemporaryFileHandler&);
51     
52     ~SQLiteIDBBackingStore() final;
53
54     IDBError getOrEstablishDatabaseInfo(IDBDatabaseInfo&) final;
55
56     IDBError beginTransaction(const IDBTransactionInfo&) final;
57     IDBError abortTransaction(const IDBResourceIdentifier& transactionIdentifier) final;
58     IDBError commitTransaction(const IDBResourceIdentifier& transactionIdentifier) final;
59     IDBError createObjectStore(const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&) final;
60     IDBError deleteObjectStore(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier) final;
61     IDBError renameObjectStore(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const String& newName) final;
62     IDBError clearObjectStore(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier) final;
63     IDBError createIndex(const IDBResourceIdentifier& transactionIdentifier, const IDBIndexInfo&) final;
64     IDBError deleteIndex(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier) final;
65     IDBError renameIndex(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName) final;
66     IDBError keyExistsInObjectStore(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyData&, bool& keyExists) final;
67     IDBError deleteRange(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&) final;
68     IDBError addRecord(const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&, const IDBKeyData&, const IDBValue&) final;
69     IDBError getRecord(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&, IDBGetResult& outValue) final;
70     IDBError getAllRecords(const IDBResourceIdentifier& transactionIdentifier, const IDBGetAllRecordsData&, IDBGetAllResult& outValue) final;
71     IDBError getIndexRecord(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, IndexedDB::IndexRecordType, const IDBKeyRangeData&, IDBGetResult& outValue) final;
72     IDBError getCount(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const IDBKeyRangeData&, uint64_t& outCount) final;
73     IDBError generateKeyNumber(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t& keyNumber) final;
74     IDBError revertGeneratedKeyNumber(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t keyNumber) final;
75     IDBError maybeUpdateKeyGeneratorNumber(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, double newKeyNumber) final;
76     IDBError openCursor(const IDBResourceIdentifier& transactionIdentifier, const IDBCursorInfo&, IDBGetResult& outResult) final;
77     IDBError iterateCursor(const IDBResourceIdentifier& transactionIdentifier, const IDBResourceIdentifier& cursorIdentifier, const IDBIterateCursorData&, IDBGetResult& outResult) final;
78
79     IDBObjectStoreInfo* infoForObjectStore(uint64_t objectStoreIdentifier) final;
80     void deleteBackingStore() final;
81
82     bool supportsSimultaneousTransactions() final { return false; }
83     bool isEphemeral() final { return false; }
84
85     void unregisterCursor(SQLiteIDBCursor&);
86
87     String fullDatabaseDirectory() const;
88
89     IDBBackingStoreTemporaryFileHandler& temporaryFileHandler() const { return m_temporaryFileHandler; }
90
91     IDBError getBlobRecordsForObjectStoreRecord(int64_t objectStoreRecord, Vector<String>& blobURLs, Vector<String>& blobFilePaths);
92
93     static String databaseNameFromEncodedFilename(const String&);
94
95 private:
96     String filenameForDatabaseName() const;
97     String fullDatabasePath() const;
98
99     bool ensureValidRecordsTable();
100     bool ensureValidIndexRecordsTable();
101     bool ensureValidBlobTables();
102     std::unique_ptr<IDBDatabaseInfo> createAndPopulateInitialDatabaseInfo();
103     std::unique_ptr<IDBDatabaseInfo> extractExistingDatabaseInfo();
104
105     IDBError deleteRecord(SQLiteIDBTransaction&, int64_t objectStoreID, const IDBKeyData&);
106     IDBError uncheckedGetKeyGeneratorValue(int64_t objectStoreID, uint64_t& outValue);
107     IDBError uncheckedSetKeyGeneratorValue(int64_t objectStoreID, uint64_t value);
108
109     IDBError updateAllIndexesForAddRecord(const IDBObjectStoreInfo&, const IDBKeyData&, const ThreadSafeDataBuffer& value);
110     IDBError updateOneIndexForAddRecord(const IDBIndexInfo&, const IDBKeyData&, const ThreadSafeDataBuffer& value);
111     IDBError uncheckedPutIndexKey(const IDBIndexInfo&, const IDBKeyData& keyValue, const IndexKey&);
112     IDBError uncheckedPutIndexRecord(int64_t objectStoreID, int64_t indexID, const IDBKeyData& keyValue, const IDBKeyData& indexKey);
113     IDBError uncheckedHasIndexRecord(const IDBIndexInfo&, const IDBKeyData&, bool& hasRecord);
114
115     IDBError deleteUnusedBlobFileRecords(SQLiteIDBTransaction&);
116
117     IDBError getAllObjectStoreRecords(const IDBResourceIdentifier& transactionIdentifier, const IDBGetAllRecordsData&, IDBGetAllResult& outValue);
118     IDBError getAllIndexRecords(const IDBResourceIdentifier& transactionIdentifier, const IDBGetAllRecordsData&, IDBGetAllResult& outValue);
119
120     void closeSQLiteDB();
121
122     enum class SQL : size_t {
123         CreateObjectStoreInfo,
124         CreateObjectStoreKeyGenerator,
125         DeleteObjectStoreInfo,
126         DeleteObjectStoreKeyGenerator,
127         DeleteObjectStoreRecords,
128         DeleteObjectStoreIndexInfo,
129         DeleteObjectStoreIndexRecords,
130         DeleteObjectStoreBlobRecords,
131         RenameObjectStore,
132         ClearObjectStoreRecords,
133         ClearObjectStoreIndexRecords,
134         CreateIndexInfo,
135         DeleteIndexInfo,
136         HasIndexRecord,
137         PutIndexRecord,
138         DeleteIndexRecords,
139         RenameIndex,
140         KeyExistsInObjectStore,
141         GetUnusedBlobFilenames,
142         DeleteUnusedBlobs,
143         GetObjectStoreRecordID,
144         DeleteBlobRecord,
145         DeleteObjectStoreRecord,
146         DeleteObjectStoreIndexRecord,
147         AddObjectStoreRecord,
148         AddBlobRecord,
149         BlobFilenameForBlobURL,
150         AddBlobFilename,
151         GetBlobURL,
152         GetKeyGeneratorValue,
153         SetKeyGeneratorValue,
154         GetAllKeyRecordsLowerOpenUpperOpen,
155         GetAllKeyRecordsLowerOpenUpperClosed,
156         GetAllKeyRecordsLowerClosedUpperOpen,
157         GetAllKeyRecordsLowerClosedUpperClosed,
158         GetValueRecordsLowerOpenUpperOpen,
159         GetValueRecordsLowerOpenUpperClosed,
160         GetValueRecordsLowerClosedUpperOpen,
161         GetValueRecordsLowerClosedUpperClosed,
162         Count
163     };
164
165     SQLiteStatement* cachedStatement(SQL, const char*);
166     SQLiteStatement* cachedStatementForGetAllObjectStoreRecords(const IDBGetAllRecordsData&);
167
168     std::unique_ptr<SQLiteStatement> m_cachedStatements[static_cast<int>(SQL::Count)];
169
170     JSC::VM& vm();
171     JSC::JSGlobalObject& globalObject();
172     void initializeVM();
173
174     IDBDatabaseIdentifier m_identifier;
175     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
176     std::unique_ptr<IDBDatabaseInfo> m_originalDatabaseInfoBeforeVersionChange;
177
178     std::unique_ptr<SQLiteDatabase> m_sqliteDB;
179
180     HashMap<IDBResourceIdentifier, std::unique_ptr<SQLiteIDBTransaction>> m_transactions;
181     HashMap<IDBResourceIdentifier, SQLiteIDBCursor*> m_cursors;
182
183     String m_absoluteDatabaseDirectory;
184
185     RefPtr<JSC::VM> m_vm;
186     JSC::Strong<JSC::JSGlobalObject> m_globalObject;
187
188     IDBBackingStoreTemporaryFileHandler& m_temporaryFileHandler;
189 };
190
191 } // namespace IDBServer
192 } // namespace WebCore
193
194 #endif // ENABLE(INDEXED_DATABASE)