Unreviewed, roll out http://trac.webkit.org/changeset/187972.
[WebKit-https.git] / Source / WebCore / Modules / webdatabase / SQLTransactionBackend.cpp
1 /*
2  * Copyright (C) 2007, 2008, 2013 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 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
29 #include "config.h"
30 #include "SQLTransactionBackend.h"
31
32 #include "Database.h"
33 #include "DatabaseAuthorizer.h"
34 #include "DatabaseContext.h"
35 #include "DatabaseThread.h"
36 #include "DatabaseTracker.h"
37 #include "ExceptionCode.h"
38 #include "Logging.h"
39 #include "OriginLock.h"
40 #include "SQLError.h"
41 #include "SQLStatementBackend.h"
42 #include "SQLStatementCallback.h"
43 #include "SQLStatementErrorCallback.h"
44 #include "SQLTransaction.h"
45 #include "SQLTransactionClient.h"
46 #include "SQLTransactionCoordinator.h"
47 #include "SQLValue.h"
48 #include "SQLiteTransaction.h"
49 #include <wtf/StdLibExtras.h>
50 #include <wtf/text/WTFString.h>
51
52
53 // How does a SQLTransaction work?
54 // ==============================
55 // The SQLTransaction is a state machine that executes a series of states / steps.
56 //
57 // The work of the transaction states are defined in section of 4.3.2 of the
58 // webdatabase spec: http://dev.w3.org/html5/webdatabase/#processing-model
59 //
60 // the State Transition Graph at a glance:
61 // ======================================
62 //
63 //     Backend                          .   Frontend
64 //     (works with SQLiteDatabase)      .   (works with Script)
65 //     ===========================      .   ===================
66 //                                      .
67 //     1. Idle                          .
68 //         v                            .
69 //     2. AcquireLock                   .
70 //         v                            .
71 //     3. OpenTransactionAndPreflight ------------------------------------------.
72 //         |                            .                                       |
73 //         `-------------------------------> 8. DeliverTransactionCallback --.  |
74 //                                      .        |                           v  v
75 //         ,-------------------------------------'   9. DeliverTransactionErrorCallback +
76 //         |                            .                                    ^  ^  ^    |
77 //         v                            .                                    |  |  |    |
78 //     4. RunStatements -----------------------------------------------------'  |  |    |
79 //         |        ^  ^ |  ^ |         .                                       |  |    |
80 //         |--------'  | |  | `------------> 10. DeliverStatementCallback +-----'  |    |
81 //         |           | |  `---------------------------------------------'        |    |
82 //         |           | `-----------------> 11. DeliverQuotaIncreaseCallback +    |    |
83 //         |            `-----------------------------------------------------'    |    |
84 //         v                            .                                          |    |
85 //     5. PostflightAndCommit --+--------------------------------------------------'    |
86 //                              |----------> 12. DeliverSuccessCallback +               |
87 //         ,--------------------'       .                               |               |
88 //         v                            .                               |               |
89 //     6. CleanupAndTerminate <-----------------------------------------'               |
90 //         v           ^                .                                               |
91 //     0. End          |                .                                               |
92 //                     |                .                                               |
93 //                7: CleanupAfterTransactionErrorCallback <----------------------------'
94 //                                      .
95 //
96 // the States and State Transitions:
97 // ================================
98 //     0. SQLTransactionState::End
99 //         - the end state.
100 //
101 //     1. SQLTransactionState::Idle
102 //         - placeholder state while waiting on frontend/backend, etc. See comment on
103 //           "State transitions between SQLTransaction and SQLTransactionBackend"
104 //           below.
105 //
106 //     2. SQLTransactionState::AcquireLock (runs in backend)
107 //         - this is the start state.
108 //         - acquire the "lock".
109 //         - on "lock" acquisition, goto SQLTransactionState::OpenTransactionAndPreflight.
110 //
111 //     3. SQLTransactionState::openTransactionAndPreflight (runs in backend)
112 //         - Sets up an SQLiteTransaction.
113 //         - begin the SQLiteTransaction.
114 //         - call the SQLTransactionWrapper preflight if available.
115 //         - schedule script callback.
116 //         - on error, goto SQLTransactionState::DeliverTransactionErrorCallback.
117 //         - goto SQLTransactionState::DeliverTransactionCallback.
118 //
119 //     4. SQLTransactionState::DeliverTransactionCallback (runs in frontend)
120 //         - invoke the script function callback() if available.
121 //         - on error, goto SQLTransactionState::DeliverTransactionErrorCallback.
122 //         - goto SQLTransactionState::RunStatements.
123 //
124 //     5. SQLTransactionState::DeliverTransactionErrorCallback (runs in frontend)
125 //         - invoke the script function errorCallback if available.
126 //         - goto SQLTransactionState::CleanupAfterTransactionErrorCallback.
127 //
128 //     6. SQLTransactionState::RunStatements (runs in backend)
129 //         - while there are statements {
130 //             - run a statement.
131 //             - if statementCallback is available, goto SQLTransactionState::DeliverStatementCallback.
132 //             - on error,
133 //               goto SQLTransactionState::DeliverQuotaIncreaseCallback, or
134 //               goto SQLTransactionState::DeliverStatementCallback, or
135 //               goto SQLTransactionState::deliverTransactionErrorCallback.
136 //           }
137 //         - goto SQLTransactionState::PostflightAndCommit.
138 //
139 //     7. SQLTransactionState::DeliverStatementCallback (runs in frontend)
140 //         - invoke script statement callback (assume available).
141 //         - on error, goto SQLTransactionState::DeliverTransactionErrorCallback.
142 //         - goto SQLTransactionState::RunStatements.
143 //
144 //     8. SQLTransactionState::DeliverQuotaIncreaseCallback (runs in frontend)
145 //         - give client a chance to increase the quota.
146 //         - goto SQLTransactionState::RunStatements.
147 //
148 //     9. SQLTransactionState::PostflightAndCommit (runs in backend)
149 //         - call the SQLTransactionWrapper postflight if available.
150 //         - commit the SQLiteTansaction.
151 //         - on error, goto SQLTransactionState::DeliverTransactionErrorCallback.
152 //         - if successCallback is available, goto SQLTransactionState::DeliverSuccessCallback.
153 //           else goto SQLTransactionState::CleanupAndTerminate.
154 //
155 //     10. SQLTransactionState::DeliverSuccessCallback (runs in frontend)
156 //         - invoke the script function successCallback() if available.
157 //         - goto SQLTransactionState::CleanupAndTerminate.
158 //
159 //     11. SQLTransactionState::CleanupAndTerminate (runs in backend)
160 //         - stop and clear the SQLiteTransaction.
161 //         - release the "lock".
162 //         - goto SQLTransactionState::End.
163 //
164 //     12. SQLTransactionState::CleanupAfterTransactionErrorCallback (runs in backend)
165 //         - rollback the SQLiteTransaction.
166 //         - goto SQLTransactionState::CleanupAndTerminate.
167 //
168 // State transitions between SQLTransaction and SQLTransactionBackend
169 // ==================================================================
170 // As shown above, there are state transitions that crosses the boundary between
171 // the frontend and backend. For example,
172 //
173 //     OpenTransactionAndPreflight (state 3 in the backend)
174 //     transitions to DeliverTransactionCallback (state 8 in the frontend),
175 //     which in turn transitions to RunStatements (state 4 in the backend).
176 //
177 // This cross boundary transition is done by posting transition requests to the
178 // other side and letting the other side's state machine execute the state
179 // transition in the appropriate thread (i.e. the script thread for the frontend,
180 // and the database thread for the backend).
181 //
182 // Logically, the state transitions work as shown in the graph above. But
183 // physically, the transition mechanism uses the Idle state (both in the frontend
184 // and backend) as a waiting state for further activity. For example, taking a
185 // closer look at the 3 state transition example above, what actually happens
186 // is as follows:
187 //
188 //     Step 1:
189 //     ======
190 //     In the frontend thread:
191 //     - waiting quietly is Idle. Not doing any work.
192 //
193 //     In the backend:
194 //     - is in OpenTransactionAndPreflight, and doing its work.
195 //     - when done, it transits to the backend DeliverTransactionCallback.
196 //     - the backend DeliverTransactionCallback sends a request to the frontend
197 //       to transit to DeliverTransactionCallback, and then itself transits to
198 //       Idle.
199 //
200 //     Step 2:
201 //     ======
202 //     In the frontend thread:
203 //     - transits to DeliverTransactionCallback and does its work.
204 //     - when done, it transits to the frontend RunStatements.
205 //     - the frontend RunStatements sends a request to the backend to transit
206 //       to RunStatements, and then itself transits to Idle.
207 //
208 //     In the backend:
209 //     - waiting quietly in Idle.
210 //
211 //     Step 3:
212 //     ======
213 //     In the frontend thread:
214 //     - waiting quietly is Idle. Not doing any work.
215 //
216 //     In the backend:
217 //     - transits to RunStatements, and does its work.
218 //        ...
219 //
220 // So, when the frontend or backend are not active, they will park themselves in
221 // their Idle states. This means their m_nextState is set to Idle, but they never
222 // actually run the corresponding state function. Note: for both the frontend and
223 // backend, the state function for Idle is unreachableState().
224 //
225 // The states that send a request to their peer across the front/back boundary
226 // are implemented with just 2 functions: SQLTransaction::sendToBackendState()
227 // and SQLTransactionBackend::sendToFrontendState(). These state functions do
228 // nothing but sends a request to the other side to transit to the current
229 // state (indicated by m_nextState), and then transits itself to the Idle state
230 // to wait for further action.
231
232
233 // The Life-Cycle of a SQLTransaction i.e. Who's keeping the SQLTransaction alive? 
234 // ==============================================================================
235 // The RefPtr chain goes something like this:
236 //
237 //     At birth (in DatabaseBackend::runTransaction()):
238 //     ====================================================
239 //     DatabaseBackend                    // Deque<RefPtr<SQLTransactionBackend>> m_transactionQueue points to ...
240 //     --> SQLTransactionBackend          // RefPtr<SQLTransaction> m_frontend points to ...
241 //         --> SQLTransaction             // RefPtr<SQLTransactionBackend> m_backend points to ...
242 //             --> SQLTransactionBackend  // which is a circular reference.
243 //
244 //     Note: there's a circular reference between the SQLTransaction front-end and
245 //     back-end. This circular reference is established in the constructor of the
246 //     SQLTransactionBackend. The circular reference will be broken by calling
247 //     doCleanup() to nullify m_frontend. This is done at the end of the transaction's
248 //     clean up state (i.e. when the transaction should no longer be in use thereafter),
249 //     or if the database was interrupted. See comments on "What happens if a transaction
250 //     is interrupted?" below for details.
251 //
252 //     After scheduling the transaction with the DatabaseThread (DatabaseBackend::scheduleTransaction()):
253 //     ======================================================================================================
254 //     DatabaseThread                         // MessageQueue<DatabaseTask> m_queue points to ...
255 //     --> DatabaseTransactionTask            // RefPtr<SQLTransactionBackend> m_transaction points to ...
256 //         --> SQLTransactionBackend          // RefPtr<SQLTransaction> m_frontend points to ...
257 //             --> SQLTransaction             // RefPtr<SQLTransactionBackend> m_backend points to ...
258 //                 --> SQLTransactionBackend  // which is a circular reference.
259 //
260 //     When executing the transaction (in DatabaseThread::databaseThread()):
261 //     ====================================================================
262 //     std::unique_ptr<DatabaseTask> task;    // points to ...
263 //     --> DatabaseTransactionTask            // RefPtr<SQLTransactionBackend> m_transaction points to ...
264 //         --> SQLTransactionBackend          // RefPtr<SQLTransaction> m_frontend;
265 //             --> SQLTransaction             // RefPtr<SQLTransactionBackend> m_backend points to ...
266 //                 --> SQLTransactionBackend  // which is a circular reference.
267 //
268 //     At the end of cleanupAndTerminate():
269 //     ===================================
270 //     At the end of the cleanup state, the SQLTransactionBackend::m_frontend is nullified.
271 //     If by then, a JSObject wrapper is referring to the SQLTransaction, then the reference
272 //     chain looks like this:
273 //
274 //     JSObjectWrapper
275 //     --> SQLTransaction             // in RefPtr<SQLTransactionBackend> m_backend points to ...
276 //         --> SQLTransactionBackend  // which no longer points back to its SQLTransaction.
277 //
278 //     When the GC collects the corresponding JSObject, the above chain will be cleaned up
279 //     and deleted.
280 //
281 //     If there is no JSObject wrapper referring to the SQLTransaction when the cleanup
282 //     states nullify SQLTransactionBackend::m_frontend, the SQLTransaction will deleted then.
283 //     However, there will still be a DatabaseTask pointing to the SQLTransactionBackend (see
284 //     the "When executing the transaction" chain above). This will keep the
285 //     SQLTransactionBackend alive until DatabaseThread::databaseThread() releases its
286 //     task std::unique_ptr.
287 //
288 //     What happens if a transaction is interrupted?
289 //     ============================================
290 //     If the transaction is interrupted half way, it won't get to run to state
291 //     CleanupAndTerminate, and hence, would not have called SQLTransactionBackend's
292 //     doCleanup(). doCleanup() is where we nullify SQLTransactionBackend::m_frontend
293 //     to break the reference cycle between the frontend and backend. Hence, we need
294 //     to cleanup the transaction by other means.
295 //
296 //     Note: calling SQLTransactionBackend::notifyDatabaseThreadIsShuttingDown()
297 //     is effectively the same as calling SQLTransactionBackend::doClean().
298 //
299 //     In terms of who needs to call doCleanup(), there are 5 phases in the
300 //     SQLTransactionBackend life-cycle. These are the phases and how the clean
301 //     up is done:
302 //
303 //     Phase 1. After Birth, before scheduling
304 //
305 //     - To clean up, DatabaseThread::databaseThread() will call
306 //       DatabaseBackend::close() during its shutdown.
307 //     - DatabaseBackend::close() will iterate
308 //       DatabaseBackend::m_transactionQueue and call
309 //       notifyDatabaseThreadIsShuttingDown() on each transaction there.
310 //        
311 //     Phase 2. After scheduling, before state AcquireLock
312 //
313 //     - If the interruption occures before the DatabaseTransactionTask is
314 //       scheduled in DatabaseThread::m_queue but hasn't gotten to execute
315 //       (i.e. DatabaseTransactionTask::performTask() has not been called),
316 //       then the DatabaseTransactionTask may get destructed before it ever
317 //       gets to execute.
318 //     - To clean up, the destructor will check if the task's m_wasExecuted is
319 //       set. If not, it will call notifyDatabaseThreadIsShuttingDown() on
320 //       the task's transaction.
321 //
322 //     Phase 3. After state AcquireLock, before "lockAcquired"
323 //
324 //     - In this phase, the transaction would have been added to the
325 //       SQLTransactionCoordinator's CoordinationInfo's pendingTransactions.
326 //     - To clean up, during shutdown, DatabaseThread::databaseThread() calls
327 //       SQLTransactionCoordinator::shutdown(), which calls
328 //       notifyDatabaseThreadIsShuttingDown().
329 //
330 //     Phase 4: After "lockAcquired", before state CleanupAndTerminate
331 //
332 //     - In this phase, the transaction would have been added either to the
333 //       SQLTransactionCoordinator's CoordinationInfo's activeWriteTransaction
334 //       or activeReadTransactions.
335 //     - To clean up, during shutdown, DatabaseThread::databaseThread() calls
336 //       SQLTransactionCoordinator::shutdown(), which calls
337 //       notifyDatabaseThreadIsShuttingDown().
338 //
339 //     Phase 5: After state CleanupAndTerminate
340 //
341 //     - This is how a transaction ends normally.
342 //     - state CleanupAndTerminate calls doCleanup().
343
344 namespace WebCore {
345
346 Ref<SQLTransactionBackend> SQLTransactionBackend::create(Database* db, PassRefPtr<SQLTransaction> frontend, PassRefPtr<SQLTransactionWrapper> wrapper, bool readOnly)
347 {
348     return adoptRef(*new SQLTransactionBackend(db, frontend, wrapper, readOnly));
349 }
350
351 SQLTransactionBackend::SQLTransactionBackend(Database* db, PassRefPtr<SQLTransaction> frontend, PassRefPtr<SQLTransactionWrapper> wrapper, bool readOnly)
352     : m_frontend(frontend)
353     , m_database(db)
354     , m_wrapper(wrapper)
355     , m_hasCallback(m_frontend->hasCallback())
356     , m_hasSuccessCallback(m_frontend->hasSuccessCallback())
357     , m_hasErrorCallback(m_frontend->hasErrorCallback())
358     , m_shouldRetryCurrentStatement(false)
359     , m_modifiedDatabase(false)
360     , m_lockAcquired(false)
361     , m_readOnly(readOnly)
362     , m_hasVersionMismatch(false)
363 {
364     ASSERT(m_database);
365     m_frontend->setBackend(this);
366     m_requestedState = SQLTransactionState::AcquireLock;
367 }
368
369 SQLTransactionBackend::~SQLTransactionBackend()
370 {
371     ASSERT(!m_sqliteTransaction);
372 }
373
374 void SQLTransactionBackend::doCleanup()
375 {
376     if (!m_frontend)
377         return;
378     m_frontend = nullptr; // Break the reference cycle. See comment about the life-cycle above.
379
380     ASSERT(currentThread() == database()->databaseContext()->databaseThread()->getThreadID());
381
382     releaseOriginLockIfNeeded();
383
384     MutexLocker locker(m_statementMutex);
385     m_statementQueue.clear();
386
387     if (m_sqliteTransaction) {
388         // In the event we got here because of an interruption or error (i.e. if
389         // the transaction is in progress), we should roll it back here. Clearing
390         // m_sqliteTransaction invokes SQLiteTransaction's destructor which does
391         // just that. We might as well do this unconditionally and free up its
392         // resources because we're already terminating.
393         m_sqliteTransaction = nullptr;
394     }
395
396     // Release the lock on this database
397     if (m_lockAcquired)
398         m_database->transactionCoordinator()->releaseLock(this);
399
400     // Do some aggresive clean up here except for m_database.
401     //
402     // We can't clear m_database here because the frontend may asynchronously
403     // invoke SQLTransactionBackend::requestTransitToState(), and that function
404     // uses m_database to schedule a state transition. This may occur because
405     // the frontend (being in another thread) may already be on the way to
406     // requesting our next state before it detects an interruption.
407     //
408     // There is no harm in letting it finish making the request. It'll set
409     // m_requestedState, but we won't execute a transition to that state because
410     // we've already shut down the transaction.
411     //
412     // We also can't clear m_currentStatementBackend and m_transactionError.
413     // m_currentStatementBackend may be accessed asynchronously by the
414     // frontend's deliverStatementCallback() state. Similarly,
415     // m_transactionError may be accessed by deliverTransactionErrorCallback().
416     // This occurs if requests for transition to those states have already been
417     // registered with the frontend just prior to a clean up request arriving.
418     //
419     // So instead, let our destructor handle their clean up since this
420     // SQLTransactionBackend is guaranteed to not destruct until the frontend
421     // is also destructing.
422
423     m_wrapper = nullptr;
424 }
425
426 SQLStatement* SQLTransactionBackend::currentStatement()
427 {
428     return m_currentStatementBackend->frontend();
429 }
430
431 PassRefPtr<SQLError> SQLTransactionBackend::transactionError()
432 {
433     return m_transactionError;
434 }
435
436 void SQLTransactionBackend::setShouldRetryCurrentStatement(bool shouldRetry)
437 {
438     ASSERT(!m_shouldRetryCurrentStatement);
439     m_shouldRetryCurrentStatement = shouldRetry;
440 }
441
442 SQLTransactionBackend::StateFunction SQLTransactionBackend::stateFunctionFor(SQLTransactionState state)
443 {
444     static const StateFunction stateFunctions[] = {
445         &SQLTransactionBackend::unreachableState,            // 0. end
446         &SQLTransactionBackend::unreachableState,            // 1. idle
447         &SQLTransactionBackend::acquireLock,                 // 2.
448         &SQLTransactionBackend::openTransactionAndPreflight, // 3.
449         &SQLTransactionBackend::runStatements,               // 4.
450         &SQLTransactionBackend::postflightAndCommit,         // 5.
451         &SQLTransactionBackend::cleanupAndTerminate,         // 6.
452         &SQLTransactionBackend::cleanupAfterTransactionErrorCallback, // 7.
453         &SQLTransactionBackend::sendToFrontendState,         // 8. deliverTransactionCallback
454         &SQLTransactionBackend::sendToFrontendState,         // 9. deliverTransactionErrorCallback
455         &SQLTransactionBackend::sendToFrontendState,         // 10. deliverStatementCallback
456         &SQLTransactionBackend::sendToFrontendState,         // 11. deliverQuotaIncreaseCallback
457         &SQLTransactionBackend::sendToFrontendState          // 12. deliverSuccessCallback
458     };
459
460     ASSERT(WTF_ARRAY_LENGTH(stateFunctions) == static_cast<int>(SQLTransactionState::NumberOfStates));
461     ASSERT(state < SQLTransactionState::NumberOfStates);
462
463     return stateFunctions[static_cast<int>(state)];
464 }
465
466 void SQLTransactionBackend::enqueueStatementBackend(PassRefPtr<SQLStatementBackend> statementBackend)
467 {
468     MutexLocker locker(m_statementMutex);
469     m_statementQueue.append(statementBackend);
470 }
471
472 void SQLTransactionBackend::computeNextStateAndCleanupIfNeeded()
473 {
474     // Only honor the requested state transition if we're not supposed to be
475     // cleaning up and shutting down:
476     if (m_database->opened()) {
477         setStateToRequestedState();
478         ASSERT(m_nextState == SQLTransactionState::AcquireLock
479             || m_nextState == SQLTransactionState::OpenTransactionAndPreflight
480             || m_nextState == SQLTransactionState::RunStatements
481             || m_nextState == SQLTransactionState::PostflightAndCommit
482             || m_nextState == SQLTransactionState::CleanupAndTerminate
483             || m_nextState == SQLTransactionState::CleanupAfterTransactionErrorCallback);
484
485         LOG(StorageAPI, "State %s\n", nameForSQLTransactionState(m_nextState));
486         return;
487     }
488
489     // If we get here, then we should be shutting down. Do clean up if needed:
490     if (m_nextState == SQLTransactionState::End)
491         return;
492     m_nextState = SQLTransactionState::End;
493
494     // If the database was stopped, don't do anything and cancel queued work
495     LOG(StorageAPI, "Database was stopped or interrupted - cancelling work for this transaction");
496
497     // The current SQLite transaction should be stopped, as well
498     if (m_sqliteTransaction) {
499         m_sqliteTransaction->stop();
500         m_sqliteTransaction = nullptr;
501     }
502
503     // Terminate the frontend state machine. This also gets the frontend to
504     // call computeNextStateAndCleanupIfNeeded() and clear its wrappers
505     // if needed.
506     m_frontend->requestTransitToState(SQLTransactionState::End);
507
508     // Redirect to the end state to abort, clean up, and end the transaction.
509     doCleanup();
510 }
511
512 void SQLTransactionBackend::performNextStep()
513 {
514     computeNextStateAndCleanupIfNeeded();
515     runStateMachine();
516 }
517
518 #if PLATFORM(IOS)
519 bool SQLTransactionBackend::shouldPerformWhilePaused() const
520 {
521     // SQLTransactions should only run-while-paused if they have progressed passed the first transaction step.
522     return m_nextState != SQLTransactionState::AcquireLock;
523 }
524 #endif
525
526 void SQLTransactionBackend::executeSQL(std::unique_ptr<SQLStatement> statement, const String& sqlStatement, const Vector<SQLValue>& arguments, int permissions)
527 {
528     RefPtr<SQLStatementBackend> statementBackend;
529     statementBackend = SQLStatementBackend::create(WTF::move(statement), sqlStatement, arguments, permissions);
530
531     if (m_database->deleted())
532         statementBackend->setDatabaseDeletedError();
533
534     enqueueStatementBackend(statementBackend);
535 }
536
537 void SQLTransactionBackend::notifyDatabaseThreadIsShuttingDown()
538 {
539     ASSERT(currentThread() == database()->databaseContext()->databaseThread()->getThreadID());
540
541     // If the transaction is in progress, we should roll it back here, since this
542     // is our last opportunity to do something related to this transaction on the
543     // DB thread. Amongst other work, doCleanup() will clear m_sqliteTransaction
544     // which invokes SQLiteTransaction's destructor, which will do the roll back
545     // if necessary.
546     doCleanup();
547 }
548
549 SQLTransactionState SQLTransactionBackend::acquireLock()
550 {
551     m_database->transactionCoordinator()->acquireLock(this);
552     return SQLTransactionState::Idle;
553 }
554
555 void SQLTransactionBackend::lockAcquired()
556 {
557     m_lockAcquired = true;
558     requestTransitToState(SQLTransactionState::OpenTransactionAndPreflight);
559 }
560
561 SQLTransactionState SQLTransactionBackend::openTransactionAndPreflight()
562 {
563     ASSERT(!m_database->sqliteDatabase().transactionInProgress());
564     ASSERT(m_lockAcquired);
565
566     LOG(StorageAPI, "Opening and preflighting transaction %p", this);
567
568     // If the database was deleted, jump to the error callback
569     if (m_database->deleted()) {
570         m_transactionError = SQLError::create(SQLError::UNKNOWN_ERR, "unable to open a transaction, because the user deleted the database");
571         return nextStateForTransactionError();
572     }
573
574     // Set the maximum usage for this transaction if this transactions is not read-only
575     if (!m_readOnly) {
576         acquireOriginLock();
577         m_database->sqliteDatabase().setMaximumSize(m_database->maximumSize());
578     }
579
580     ASSERT(!m_sqliteTransaction);
581     m_sqliteTransaction = std::make_unique<SQLiteTransaction>(m_database->sqliteDatabase(), m_readOnly);
582
583     m_database->resetDeletes();
584     m_database->disableAuthorizer();
585     m_sqliteTransaction->begin();
586     m_database->enableAuthorizer();
587
588     // Spec 4.3.2.1+2: Open a transaction to the database, jumping to the error callback if that fails
589     if (!m_sqliteTransaction->inProgress()) {
590         ASSERT(!m_database->sqliteDatabase().transactionInProgress());
591         m_transactionError = SQLError::create(SQLError::DATABASE_ERR, "unable to begin transaction",
592             m_database->sqliteDatabase().lastError(), m_database->sqliteDatabase().lastErrorMsg());
593         m_sqliteTransaction = nullptr;
594         return nextStateForTransactionError();
595     }
596
597     // Note: We intentionally retrieve the actual version even with an empty expected version.
598     // In multi-process browsers, we take this opportinutiy to update the cached value for
599     // the actual version. In single-process browsers, this is just a map lookup.
600     String actualVersion;
601     if (!m_database->getActualVersionForTransaction(actualVersion)) {
602         m_transactionError = SQLError::create(SQLError::DATABASE_ERR, "unable to read version",
603             m_database->sqliteDatabase().lastError(), m_database->sqliteDatabase().lastErrorMsg());
604         m_database->disableAuthorizer();
605         m_sqliteTransaction = nullptr;
606         m_database->enableAuthorizer();
607         return nextStateForTransactionError();
608     }
609     m_hasVersionMismatch = !m_database->expectedVersion().isEmpty() && (m_database->expectedVersion() != actualVersion);
610
611     // Spec 4.3.2.3: Perform preflight steps, jumping to the error callback if they fail
612     if (m_wrapper && !m_wrapper->performPreflight(this)) {
613         m_database->disableAuthorizer();
614         m_sqliteTransaction = nullptr;
615         m_database->enableAuthorizer();
616         m_transactionError = m_wrapper->sqlError();
617         if (!m_transactionError)
618             m_transactionError = SQLError::create(SQLError::UNKNOWN_ERR, "unknown error occurred during transaction preflight");
619         return nextStateForTransactionError();
620     }
621
622     // Spec 4.3.2.4: Invoke the transaction callback with the new SQLTransaction object
623     if (m_hasCallback)
624         return SQLTransactionState::DeliverTransactionCallback;
625
626     // If we have no callback to make, skip pass to the state after:
627     return SQLTransactionState::RunStatements;
628 }
629
630 SQLTransactionState SQLTransactionBackend::runStatements()
631 {
632     ASSERT(m_lockAcquired);
633     SQLTransactionState nextState;
634
635     // If there is a series of statements queued up that are all successful and have no associated
636     // SQLStatementCallback objects, then we can burn through the queue
637     do {
638         if (m_shouldRetryCurrentStatement && !m_sqliteTransaction->wasRolledBackBySqlite()) {
639             m_shouldRetryCurrentStatement = false;
640             // FIXME - Another place that needs fixing up after <rdar://problem/5628468> is addressed.
641             // See ::openTransactionAndPreflight() for discussion
642
643             // Reset the maximum size here, as it was increased to allow us to retry this statement.
644             // m_shouldRetryCurrentStatement is set to true only when a statement exceeds
645             // the quota, which can happen only in a read-write transaction. Therefore, there
646             // is no need to check here if the transaction is read-write.
647             m_database->sqliteDatabase().setMaximumSize(m_database->maximumSize());
648         } else {
649             // If the current statement has already been run, failed due to quota constraints, and we're not retrying it,
650             // that means it ended in an error. Handle it now
651             if (m_currentStatementBackend && m_currentStatementBackend->lastExecutionFailedDueToQuota()) {
652                 return nextStateForCurrentStatementError();
653             }
654
655             // Otherwise, advance to the next statement
656             getNextStatement();
657         }
658         nextState = runCurrentStatementAndGetNextState();
659     } while (nextState == SQLTransactionState::RunStatements);
660
661     return nextState;
662 }
663
664 void SQLTransactionBackend::getNextStatement()
665 {
666     m_currentStatementBackend = nullptr;
667
668     MutexLocker locker(m_statementMutex);
669     if (!m_statementQueue.isEmpty())
670         m_currentStatementBackend = m_statementQueue.takeFirst();
671 }
672
673 SQLTransactionState SQLTransactionBackend::runCurrentStatementAndGetNextState()
674 {
675     if (!m_currentStatementBackend) {
676         // No more statements to run. So move on to the next state.
677         return SQLTransactionState::PostflightAndCommit;
678     }
679
680     m_database->resetAuthorizer();
681
682     if (m_hasVersionMismatch)
683         m_currentStatementBackend->setVersionMismatchedError();
684
685     if (m_currentStatementBackend->execute(*m_database)) {
686         if (m_database->lastActionChangedDatabase()) {
687             // Flag this transaction as having changed the database for later delegate notification
688             m_modifiedDatabase = true;
689         }
690
691         if (m_currentStatementBackend->hasStatementCallback()) {
692             return SQLTransactionState::DeliverStatementCallback;
693         }
694
695         // If we get here, then the statement doesn't have a callback to invoke.
696         // We can move on to the next statement. Hence, stay in this state.
697         return SQLTransactionState::RunStatements;
698     }
699
700     if (m_currentStatementBackend->lastExecutionFailedDueToQuota()) {
701         return SQLTransactionState::DeliverQuotaIncreaseCallback;
702     }
703
704     return nextStateForCurrentStatementError();
705 }
706
707 SQLTransactionState SQLTransactionBackend::nextStateForCurrentStatementError()
708 {
709     // Spec 4.3.2.6.6: error - Call the statement's error callback, but if there was no error callback,
710     // or the transaction was rolled back, jump to the transaction error callback
711     if (m_currentStatementBackend->hasStatementErrorCallback() && !m_sqliteTransaction->wasRolledBackBySqlite())
712         return SQLTransactionState::DeliverStatementCallback;
713
714     m_transactionError = m_currentStatementBackend->sqlError();
715     if (!m_transactionError)
716         m_transactionError = SQLError::create(SQLError::DATABASE_ERR, "the statement failed to execute");
717     return nextStateForTransactionError();
718 }
719
720 SQLTransactionState SQLTransactionBackend::postflightAndCommit()
721 {
722     ASSERT(m_lockAcquired);
723
724     // Spec 4.3.2.7: Perform postflight steps, jumping to the error callback if they fail.
725     if (m_wrapper && !m_wrapper->performPostflight(this)) {
726         m_transactionError = m_wrapper->sqlError();
727         if (!m_transactionError)
728             m_transactionError = SQLError::create(SQLError::UNKNOWN_ERR, "unknown error occurred during transaction postflight");
729         return nextStateForTransactionError();
730     }
731
732     // Spec 4.3.2.7: Commit the transaction, jumping to the error callback if that fails.
733     ASSERT(m_sqliteTransaction);
734
735     m_database->disableAuthorizer();
736     m_sqliteTransaction->commit();
737     m_database->enableAuthorizer();
738
739     releaseOriginLockIfNeeded();
740
741     // If the commit failed, the transaction will still be marked as "in progress"
742     if (m_sqliteTransaction->inProgress()) {
743         if (m_wrapper)
744             m_wrapper->handleCommitFailedAfterPostflight(this);
745         m_transactionError = SQLError::create(SQLError::DATABASE_ERR, "unable to commit transaction",
746             m_database->sqliteDatabase().lastError(), m_database->sqliteDatabase().lastErrorMsg());
747         return nextStateForTransactionError();
748     }
749
750     // Vacuum the database if anything was deleted.
751     if (m_database->hadDeletes())
752         m_database->incrementalVacuumIfNeeded();
753
754     // The commit was successful. If the transaction modified this database, notify the delegates.
755     if (m_modifiedDatabase)
756         m_database->transactionClient()->didCommitWriteTransaction(database());
757
758     // Spec 4.3.2.8: Deliver success callback, if there is one.
759     return SQLTransactionState::DeliverSuccessCallback;
760 }
761
762 SQLTransactionState SQLTransactionBackend::cleanupAndTerminate()
763 {
764     ASSERT(m_lockAcquired);
765
766     // Spec 4.3.2.9: End transaction steps. There is no next step.
767     LOG(StorageAPI, "Transaction %p is complete\n", this);
768     ASSERT(!m_database->sqliteDatabase().transactionInProgress());
769
770     // Phase 5 cleanup. See comment on the SQLTransaction life-cycle above.
771     doCleanup();
772     m_database->inProgressTransactionCompleted();
773     return SQLTransactionState::End;
774 }
775
776 SQLTransactionState SQLTransactionBackend::nextStateForTransactionError()
777 {
778     ASSERT(m_transactionError);
779     if (m_hasErrorCallback)
780         return SQLTransactionState::DeliverTransactionErrorCallback;
781
782     // No error callback, so fast-forward to the next state and rollback the
783     // transaction.
784     return SQLTransactionState::CleanupAfterTransactionErrorCallback;
785 }
786
787 SQLTransactionState SQLTransactionBackend::cleanupAfterTransactionErrorCallback()
788 {
789     ASSERT(m_lockAcquired);
790
791     LOG(StorageAPI, "Transaction %p is complete with an error\n", this);
792     m_database->disableAuthorizer();
793     if (m_sqliteTransaction) {
794         // Spec 4.3.2.10: Rollback the transaction.
795         m_sqliteTransaction->rollback();
796
797         ASSERT(!m_database->sqliteDatabase().transactionInProgress());
798         m_sqliteTransaction = nullptr;
799     }
800     m_database->enableAuthorizer();
801
802     releaseOriginLockIfNeeded();
803
804     ASSERT(!m_database->sqliteDatabase().transactionInProgress());
805
806     return SQLTransactionState::CleanupAndTerminate;
807 }
808
809 // requestTransitToState() can be called from the frontend. Hence, it should
810 // NOT be modifying SQLTransactionBackend in general. The only safe field to
811 // modify is m_requestedState which is meant for this purpose.
812 void SQLTransactionBackend::requestTransitToState(SQLTransactionState nextState)
813 {
814     LOG(StorageAPI, "Scheduling %s for transaction %p\n", nameForSQLTransactionState(nextState), this);
815     m_requestedState = nextState;
816     ASSERT(m_requestedState != SQLTransactionState::End);
817     m_database->scheduleTransactionStep(this);
818 }
819
820 // This state function is used as a stub function to plug unimplemented states
821 // in the state dispatch table. They are unimplemented because they should
822 // never be reached in the course of correct execution.
823 SQLTransactionState SQLTransactionBackend::unreachableState()
824 {
825     ASSERT_NOT_REACHED();
826     return SQLTransactionState::End;
827 }
828
829 SQLTransactionState SQLTransactionBackend::sendToFrontendState()
830 {
831     ASSERT(m_nextState != SQLTransactionState::Idle);
832     m_frontend->requestTransitToState(m_nextState);
833     return SQLTransactionState::Idle;
834 }
835
836 void SQLTransactionBackend::acquireOriginLock()
837 {
838     ASSERT(!m_originLock);
839     m_originLock = DatabaseTracker::tracker().originLockFor(m_database->securityOrigin());
840     m_originLock->lock();
841 }
842
843 void SQLTransactionBackend::releaseOriginLockIfNeeded()
844 {
845     if (m_originLock) {
846         m_originLock->unlock();
847         m_originLock = nullptr;
848     }
849 }
850
851 } // namespace WebCore