xref: /sqlite-3.40.0/test/walprotocol.test (revision fb32c44e)
1# 2016 February 4
2#
3# The author disclaims copyright to this source code.  In place of
4# a legal notice, here is a blessing:
5#
6#    May you do good and not evil.
7#    May you find forgiveness for yourself and forgive others.
8#    May you share freely, never taking more than you give.
9#
10#***********************************************************************
11# This file implements regression tests for SQLite library.  The
12# focus of this file is testing the operation of the library in
13# "PRAGMA journal_mode=WAL" mode.
14#
15# More specifically, it tests "locking protocol" errors - errors that
16# may be caused if one or more SQLite clients does not follow the expected
17# locking protocol when accessing a wal-mode database. These tests take
18# quite a while to run.
19#
20
21set testdir [file dirname $argv0]
22source $testdir/tester.tcl
23source $testdir/lock_common.tcl
24source $testdir/wal_common.tcl
25ifcapable !wal {finish_test ; return }
26
27set testprefix walprotocol
28
29#-------------------------------------------------------------------------
30# When recovering the contents of a WAL file, a process obtains the WRITER
31# lock, then locks all other bytes before commencing recovery. If it fails
32# to lock all other bytes (because some other process is holding a read
33# lock) it should retry up to 100 times. Then return SQLITE_PROTOCOL to the
34# caller. Test this (test case 1.3).
35#
36# Also test the effect of hitting an SQLITE_BUSY while attempting to obtain
37# the WRITER lock (should be the same). Test case 1.4.
38#
39do_execsql_test 1.0 {
40  PRAGMA journal_mode = wal;
41  CREATE TABLE x(y);
42  INSERT INTO x VALUES('z');
43} {wal}
44
45proc lock_callback {method filename handle lock} {
46  lappend ::locks $lock
47}
48do_test 1.1 {
49  testvfs T
50  T filter xShmLock
51  T script lock_callback
52  set ::locks [list]
53  sqlite3 db test.db -vfs T
54  execsql { SELECT * FROM x }
55  lrange $::locks 0 5
56} [list {0 1 lock exclusive} {1 2 lock exclusive} {4 4 lock exclusive} \
57        {1 2 unlock exclusive} {4 4 unlock exclusive} {0 1 unlock exclusive}  \
58]
59do_test 1.2 {
60  db close
61  set ::locks [list]
62  sqlite3 db test.db -vfs T
63  execsql { SELECT * FROM x }
64  lrange $::locks 0 5
65} [list {0 1 lock exclusive} {1 2 lock exclusive} {4 4 lock exclusive} \
66        {1 2 unlock exclusive} {4 4 unlock exclusive} {0 1 unlock exclusive}  \
67]
68proc lock_callback {method filename handle lock} {
69  if {$lock == "1 2 lock exclusive"} { return SQLITE_BUSY }
70  return SQLITE_OK
71}
72puts "# Warning: This next test case causes SQLite to call xSleep(1) 100 times."
73puts "# Normally this equates to a delay of roughly 10 seconds, but if SQLite"
74puts "# is built on unix without HAVE_USLEEP defined, it may be much longer."
75do_test 1.3 {
76  db close
77  set ::locks [list]
78  sqlite3 db test.db -vfs T
79  catchsql { SELECT * FROM x }
80} {1 {locking protocol}}
81
82puts "# Warning: Same again!"
83proc lock_callback {method filename handle lock} {
84  if {$lock == "0 1 lock exclusive"} { return SQLITE_BUSY }
85  return SQLITE_OK
86}
87do_test 1.4 {
88  db close
89  set ::locks [list]
90  sqlite3 db test.db -vfs T
91  catchsql { SELECT * FROM x }
92} {1 {locking protocol}}
93
94puts "# Warning: Third time!"
95proc lock_callback {method filename handle lock} {
96  if {$lock == "4 4 lock exclusive"} { return SQLITE_BUSY }
97  return SQLITE_OK
98}
99do_test 1.5 {
100  db close
101  set ::locks [list]
102  sqlite3 db test.db -vfs T
103  catchsql { SELECT * FROM x }
104} {1 {locking protocol}}
105db close
106T delete
107
108#-------------------------------------------------------------------------
109#
110do_test 2.1 {
111  forcedelete test.db test.db-journal test.db wal
112  sqlite3 db test.db
113  sqlite3 db2 test.db
114  execsql {
115    PRAGMA auto_vacuum = off;
116    PRAGMA journal_mode = WAL;
117    CREATE TABLE b(c);
118    INSERT INTO b VALUES('Tehran');
119    INSERT INTO b VALUES('Qom');
120    INSERT INTO b VALUES('Markazi');
121    PRAGMA wal_checkpoint;
122  }
123} {wal 0 5 5}
124do_test 2.2 {
125  execsql { SELECT * FROM b }
126} {Tehran Qom Markazi}
127do_test 2.3 {
128  db eval { SELECT * FROM b } {
129    db eval { INSERT INTO b VALUES('Qazvin') }
130    set r [db2 eval { SELECT * FROM b }]
131    break
132  }
133  set r
134} {Tehran Qom Markazi Qazvin}
135do_test 2.4 {
136  execsql {
137    INSERT INTO b VALUES('Gilan');
138    INSERT INTO b VALUES('Ardabil');
139  }
140} {}
141db2 close
142
143faultsim_save_and_close
144testvfs T -default 1
145faultsim_restore_and_reopen
146T filter xShmLock
147T script lock_callback
148
149proc lock_callback {method file handle spec} {
150  if {$spec == "1 2 unlock exclusive"} {
151    T filter {}
152    set ::r [catchsql { SELECT * FROM b } db2]
153  }
154}
155sqlite3 db test.db
156sqlite3 db2 test.db
157puts "# Warning: Another slow test!"
158do_test 2.5 {
159  execsql { SELECT * FROM b }
160} {Tehran Qom Markazi Qazvin Gilan Ardabil}
161do_test 2.6 {
162  set ::r
163} {1 {locking protocol}}
164
165db close
166db2 close
167
168faultsim_restore_and_reopen
169sqlite3 db2 test.db
170T filter xShmLock
171T script lock_callback
172proc lock_callback {method file handle spec} {
173  if {$spec == "1 2 unlock exclusive"} {
174    T filter {}
175    set ::r [catchsql { SELECT * FROM b } db2]
176  }
177}
178unset ::r
179puts "# Warning: Last one!"
180do_test 2.7 {
181  execsql { SELECT * FROM b }
182} {Tehran Qom Markazi Qazvin Gilan Ardabil}
183do_test 2.8 {
184  set ::r
185} {1 {locking protocol}}
186
187db close
188db2 close
189T delete
190
191finish_test
192