0000: 2f 2a 0a 2a 2a 20 32 30 31 30 20 46 65 62 72 75 /*.** 2010 Febru
0010: 61 72 79 20 31 0a 2a 2a 0a 2a 2a 20 54 68 65 20 ary 1.**.** The
0020: 61 75 74 68 6f 72 20 64 69 73 63 6c 61 69 6d 73 author disclaims
0030: 20 63 6f 70 79 72 69 67 68 74 20 74 6f 20 74 68 copyright to th
0040: 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65 2e 20 is source code.
0050: 20 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a 2a 20 In place of.**
0060: 61 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65 2c 20 a legal notice,
0070: 68 65 72 65 20 69 73 20 61 20 62 6c 65 73 73 69 here is a blessi
0080: 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d 61 79 ng:.**.** May
0090: 20 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61 6e 64 you do good and
00a0: 20 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20 20 20 not evil..**
00b0: 20 4d 61 79 20 79 6f 75 20 66 69 6e 64 20 66 6f May you find fo
00c0: 72 67 69 76 65 6e 65 73 73 20 66 6f 72 20 79 6f rgiveness for yo
00d0: 75 72 73 65 6c 66 20 61 6e 64 20 66 6f 72 67 69 urself and forgi
00e0: 76 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20 20 20 ve others..**
00f0: 20 4d 61 79 20 79 6f 75 20 73 68 61 72 65 20 66 May you share f
0100: 72 65 65 6c 79 2c 20 6e 65 76 65 72 20 74 61 6b reely, never tak
0110: 69 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20 79 6f ing more than yo
0120: 75 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a 2a 2a u give..**.*****
0130: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a ****************
0140: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a ****************
0150: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a ****************
0160: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a ****************
0170: 2a 2a 2a 2a 0a 2a 2a 20 54 68 69 73 20 68 65 61 ****.** This hea
0180: 64 65 72 20 66 69 6c 65 20 64 65 66 69 6e 65 73 der file defines
0190: 20 74 68 65 20 69 6e 74 65 72 66 61 63 65 20 74 the interface t
01a0: 6f 20 74 68 65 20 77 72 69 74 65 2d 61 68 65 61 o the write-ahea
01b0: 64 20 6c 6f 67 67 69 6e 67 20 0a 2a 2a 20 73 79 d logging .** sy
01c0: 73 74 65 6d 2e 20 52 65 66 65 72 20 74 6f 20 74 stem. Refer to t
01d0: 68 65 20 63 6f 6d 6d 65 6e 74 73 20 62 65 6c 6f he comments belo
01e0: 77 20 61 6e 64 20 74 68 65 20 68 65 61 64 65 72 w and the header
01f0: 20 63 6f 6d 6d 65 6e 74 20 61 74 74 61 63 68 65 comment attache
0200: 64 20 74 6f 20 0a 2a 2a 20 74 68 65 20 69 6d 70 d to .** the imp
0210: 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 65 lementation of e
0220: 61 63 68 20 66 75 6e 63 74 69 6f 6e 20 69 6e 20 ach function in
0230: 6c 6f 67 2e 63 20 66 6f 72 20 66 75 72 74 68 65 log.c for furthe
0240: 72 20 64 65 74 61 69 6c 73 2e 0a 2a 2f 0a 0a 23 r details..*/..#
0250: 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 57 41 ifndef SQLITE_WA
0260: 4c 5f 48 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 L_H.#define SQLI
0270: 54 45 5f 57 41 4c 5f 48 0a 0a 23 69 6e 63 6c 75 TE_WAL_H..#inclu
0280: 64 65 20 22 73 71 6c 69 74 65 49 6e 74 2e 68 22 de "sqliteInt.h"
0290: 0a 0a 2f 2a 20 4d 61 63 72 6f 73 20 66 6f 72 20 ../* Macros for
02a0: 65 78 74 72 61 63 74 69 6e 67 20 61 70 70 72 6f extracting appro
02b0: 70 72 69 61 74 65 20 73 79 6e 63 20 66 6c 61 67 priate sync flag
02c0: 73 20 66 6f 72 20 65 69 74 68 65 72 20 74 72 61 s for either tra
02d0: 6e 73 61 63 74 69 6f 6e 0a 2a 2a 20 63 6f 6d 6d nsaction.** comm
02e0: 69 74 73 20 28 57 41 4c 5f 53 59 4e 43 5f 46 4c its (WAL_SYNC_FL
02f0: 41 47 53 28 58 29 29 20 6f 72 20 66 6f 72 20 63 AGS(X)) or for c
0300: 68 65 63 6b 70 6f 69 6e 74 20 6f 70 73 20 28 43 heckpoint ops (C
0310: 4b 50 54 5f 53 59 4e 43 5f 46 4c 41 47 53 28 58 KPT_SYNC_FLAGS(X
0320: 29 29 3a 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 57 )):.*/.#define W
0330: 41 4c 5f 53 59 4e 43 5f 46 4c 41 47 53 28 58 29 AL_SYNC_FLAGS(X)
0340: 20 20 20 28 28 58 29 26 30 78 30 33 29 0a 23 64 ((X)&0x03).#d
0350: 65 66 69 6e 65 20 43 4b 50 54 5f 53 59 4e 43 5f efine CKPT_SYNC_
0360: 46 4c 41 47 53 28 58 29 20 20 28 28 28 58 29 3e FLAGS(X) (((X)>
0370: 3e 32 29 26 30 78 30 33 29 0a 0a 23 69 66 64 65 >2)&0x03)..#ifde
0380: 66 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 57 41 f SQLITE_OMIT_WA
0390: 4c 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 L.# define sqlit
03a0: 65 33 57 61 6c 4f 70 65 6e 28 77 2c 78 2c 79 2c e3WalOpen(w,x,y,
03b0: 7a 29 20 20 20 20 20 20 20 20 20 20 20 20 20 20 z)
03c0: 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 0.# define sq
03d0: 6c 69 74 65 33 57 61 6c 4c 69 6d 69 74 28 78 2c lite3WalLimit(x,
03e0: 79 29 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 y).# define sqli
03f0: 74 65 33 57 61 6c 43 6c 6f 73 65 28 76 2c 77 2c te3WalClose(v,w,
0400: 78 2c 79 2c 7a 29 20 20 20 20 20 20 20 20 20 20 x,y,z)
0410: 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73 0.# define s
0420: 71 6c 69 74 65 33 57 61 6c 42 65 67 69 6e 52 65 qlite3WalBeginRe
0430: 61 64 54 72 61 6e 73 61 63 74 69 6f 6e 28 79 2c adTransaction(y,
0440: 7a 29 20 20 20 20 20 30 0a 23 20 64 65 66 69 6e z) 0.# defin
0450: 65 20 73 71 6c 69 74 65 33 57 61 6c 45 6e 64 52 e sqlite3WalEndR
0460: 65 61 64 54 72 61 6e 73 61 63 74 69 6f 6e 28 7a eadTransaction(z
0470: 29 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 ).# define sqlit
0480: 65 33 57 61 6c 44 62 73 69 7a 65 28 79 29 20 20 e3WalDbsize(y)
0490: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
04a0: 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 0.# define sq
04b0: 6c 69 74 65 33 57 61 6c 42 65 67 69 6e 57 72 69 lite3WalBeginWri
04c0: 74 65 54 72 61 6e 73 61 63 74 69 6f 6e 28 79 29 teTransaction(y)
04d0: 20 20 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65 0.# define
04e0: 20 73 71 6c 69 74 65 33 57 61 6c 45 6e 64 57 72 sqlite3WalEndWr
04f0: 69 74 65 54 72 61 6e 73 61 63 74 69 6f 6e 28 78 iteTransaction(x
0500: 29 20 20 20 20 20 20 20 20 30 0a 23 20 64 65 66 ) 0.# def
0510: 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 55 6e ine sqlite3WalUn
0520: 64 6f 28 77 2c 78 2c 79 2c 7a 29 20 20 20 20 20 do(w,x,y,z)
0530: 20 20 20 20 20 20 20 20 20 20 20 20 30 0a 23 20 0.#
0540: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 define sqlite3Wa
0550: 6c 53 61 76 65 70 6f 69 6e 74 28 79 2c 7a 29 0a lSavepoint(y,z).
0560: 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 # define sqlite3
0570: 57 61 6c 53 61 76 65 70 6f 69 6e 74 55 6e 64 6f WalSavepointUndo
0580: 28 79 2c 7a 29 20 20 20 20 20 20 20 20 20 20 20 (y,z)
0590: 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 0.# define sqli
05a0: 74 65 33 57 61 6c 46 72 61 6d 65 73 28 75 2c 76 te3WalFrames(u,v
05b0: 2c 77 2c 78 2c 79 2c 7a 29 20 20 20 20 20 20 20 ,w,x,y,z)
05c0: 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73 0.# define s
05d0: 71 6c 69 74 65 33 57 61 6c 43 68 65 63 6b 70 6f qlite3WalCheckpo
05e0: 69 6e 74 28 71 2c 72 2c 73 2c 74 2c 75 2c 76 2c int(q,r,s,t,u,v,
05f0: 77 2c 78 2c 79 2c 7a 29 20 30 0a 23 20 64 65 66 w,x,y,z) 0.# def
0600: 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 43 61 ine sqlite3WalCa
0610: 6c 6c 62 61 63 6b 28 7a 29 20 20 20 20 20 20 20 llback(z)
0620: 20 20 20 20 20 20 20 20 20 20 20 20 30 0a 23 20 0.#
0630: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 define sqlite3Wa
0640: 6c 45 78 63 6c 75 73 69 76 65 4d 6f 64 65 28 79 lExclusiveMode(y
0650: 2c 7a 29 20 20 20 20 20 20 20 20 20 20 20 20 30 ,z) 0
0660: 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 .# define sqlite
0670: 33 57 61 6c 48 65 61 70 4d 65 6d 6f 72 79 28 7a 3WalHeapMemory(z
0680: 29 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 )
0690: 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 0.# define sql
06a0: 69 74 65 33 57 61 6c 46 72 61 6d 65 73 69 7a 65 ite3WalFramesize
06b0: 28 7a 29 20 20 20 20 20 20 20 20 20 20 20 20 20 (z)
06c0: 20 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20 0.# define
06d0: 73 71 6c 69 74 65 33 57 61 6c 46 69 6e 64 46 72 sqlite3WalFindFr
06e0: 61 6d 65 28 78 2c 79 2c 7a 29 20 20 20 20 20 20 ame(x,y,z)
06f0: 20 20 20 20 20 20 20 20 30 0a 23 20 64 65 66 69 0.# defi
0700: 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 46 69 6c ne sqlite3WalFil
0710: 65 28 78 29 20 20 20 20 20 20 20 20 20 20 20 20 e(x)
0720: 20 20 20 20 20 20 20 20 20 20 20 30 0a 23 20 64 0.# d
0730: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c efine sqlite3Wal
0740: 4a 6f 75 72 6e 61 6c 4d 6f 64 65 28 78 29 20 20 JournalMode(x)
0750: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0a 0.
0760: 23 65 6c 73 65 0a 0a 23 64 65 66 69 6e 65 20 57 #else..#define W
0770: 41 4c 5f 53 41 56 45 50 4f 49 4e 54 5f 4e 44 41 AL_SAVEPOINT_NDA
0780: 54 41 20 34 0a 0a 2f 2a 20 43 6f 6e 6e 65 63 74 TA 4../* Connect
0790: 69 6f 6e 20 74 6f 20 61 20 77 72 69 74 65 2d 61 ion to a write-a
07a0: 68 65 61 64 20 6c 6f 67 20 28 57 41 4c 29 20 66 head log (WAL) f
07b0: 69 6c 65 2e 20 0a 2a 2a 20 54 68 65 72 65 20 69 ile. .** There i
07c0: 73 20 6f 6e 65 20 6f 62 6a 65 63 74 20 6f 66 20 s one object of
07d0: 74 68 69 73 20 74 79 70 65 20 66 6f 72 20 65 61 this type for ea
07e0: 63 68 20 70 61 67 65 72 2e 20 0a 2a 2f 0a 74 79 ch pager. .*/.ty
07f0: 70 65 64 65 66 20 73 74 72 75 63 74 20 57 61 6c pedef struct Wal
0800: 20 57 61 6c 3b 0a 0a 2f 2a 20 4f 70 65 6e 20 61 Wal;../* Open a
0810: 6e 64 20 63 6c 6f 73 65 20 61 20 63 6f 6e 6e 65 nd close a conne
0820: 63 74 69 6f 6e 20 74 6f 20 61 20 77 72 69 74 65 ction to a write
0830: 2d 61 68 65 61 64 20 6c 6f 67 2e 20 2a 2f 0a 69 -ahead log. */.i
0840: 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 4f 70 65 nt sqlite3WalOpe
0850: 6e 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 n(sqlite3_vfs*,
0860: 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 63 sqlite3_file*, c
0870: 6f 6e 73 74 20 63 68 61 72 20 2a 2c 69 6e 74 2c onst char *,int,
0880: 69 36 34 2c 69 6e 74 2c 57 61 6c 2a 2a 29 3b 0a i64,int,Wal**);.
0890: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 43 6c int sqlite3WalCl
08a0: 6f 73 65 28 57 61 6c 20 2a 70 57 61 6c 2c 20 73 ose(Wal *pWal, s
08b0: 71 6c 69 74 65 33 2a 2c 20 69 6e 74 20 73 79 6e qlite3*, int syn
08c0: 63 5f 66 6c 61 67 73 2c 20 69 6e 74 2c 20 75 38 c_flags, int, u8
08d0: 20 2a 29 3b 0a 0a 2f 2a 20 53 65 74 20 74 68 65 *);../* Set the
08e0: 20 6c 69 6d 69 74 69 6e 67 20 73 69 7a 65 20 6f limiting size o
08f0: 66 20 61 20 57 41 4c 20 66 69 6c 65 2e 20 2a 2f f a WAL file. */
0900: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61 6c .void sqlite3Wal
0910: 4c 69 6d 69 74 28 57 61 6c 2a 2c 20 69 36 34 29 Limit(Wal*, i64)
0920: 3b 0a 0a 2f 2a 20 55 73 65 64 20 62 79 20 72 65 ;../* Used by re
0930: 61 64 65 72 73 20 74 6f 20 6f 70 65 6e 20 28 6c aders to open (l
0940: 6f 63 6b 29 20 61 6e 64 20 63 6c 6f 73 65 20 28 ock) and close (
0950: 75 6e 6c 6f 63 6b 29 20 61 20 73 6e 61 70 73 68 unlock) a snapsh
0960: 6f 74 2e 20 20 41 20 0a 2a 2a 20 73 6e 61 70 73 ot. A .** snaps
0970: 68 6f 74 20 69 73 20 6c 69 6b 65 20 61 20 72 65 hot is like a re
0980: 61 64 2d 74 72 61 6e 73 61 63 74 69 6f 6e 2e 20 ad-transaction.
0990: 20 49 74 20 69 73 20 74 68 65 20 73 74 61 74 65 It is the state
09a0: 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73 65 of the database
09b0: 0a 2a 2a 20 61 74 20 61 6e 20 69 6e 73 74 61 6e .** at an instan
09c0: 74 20 69 6e 20 74 69 6d 65 2e 20 20 73 71 6c 69 t in time. sqli
09d0: 74 65 33 57 61 6c 4f 70 65 6e 53 6e 61 70 73 68 te3WalOpenSnapsh
09e0: 6f 74 20 67 65 74 73 20 61 20 72 65 61 64 20 6c ot gets a read l
09f0: 6f 63 6b 20 61 6e 64 0a 2a 2a 20 70 72 65 73 65 ock and.** prese
0a00: 72 76 65 73 20 74 68 65 20 63 75 72 72 65 6e 74 rves the current
0a10: 20 73 74 61 74 65 20 65 76 65 6e 20 69 66 20 74 state even if t
0a20: 68 65 20 6f 74 68 65 72 20 74 68 72 65 61 64 73 he other threads
0a30: 20 6f 72 20 70 72 6f 63 65 73 73 65 73 0a 2a 2a or processes.**
0a40: 20 77 72 69 74 65 20 74 6f 20 6f 72 20 63 68 65 write to or che
0a50: 63 6b 70 6f 69 6e 74 20 74 68 65 20 57 41 4c 2e ckpoint the WAL.
0a60: 20 20 73 71 6c 69 74 65 33 57 61 6c 43 6c 6f 73 sqlite3WalClos
0a70: 65 53 6e 61 70 73 68 6f 74 28 29 20 63 6c 6f 73 eSnapshot() clos
0a80: 65 73 20 74 68 65 0a 2a 2a 20 74 72 61 6e 73 61 es the.** transa
0a90: 63 74 69 6f 6e 20 61 6e 64 20 72 65 6c 65 61 73 ction and releas
0aa0: 65 73 20 74 68 65 20 6c 6f 63 6b 2e 0a 2a 2f 0a es the lock..*/.
0ab0: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 42 65 int sqlite3WalBe
0ac0: 67 69 6e 52 65 61 64 54 72 61 6e 73 61 63 74 69 ginReadTransacti
0ad0: 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69 6e on(Wal *pWal, in
0ae0: 74 20 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 t *);.void sqlit
0af0: 65 33 57 61 6c 45 6e 64 52 65 61 64 54 72 61 6e e3WalEndReadTran
0b00: 73 61 63 74 69 6f 6e 28 57 61 6c 20 2a 70 57 61 saction(Wal *pWa
0b10: 6c 29 3b 0a 0a 2f 2a 20 52 65 61 64 20 61 20 70 l);../* Read a p
0b20: 61 67 65 20 66 72 6f 6d 20 74 68 65 20 77 72 69 age from the wri
0b30: 74 65 2d 61 68 65 61 64 20 6c 6f 67 2c 20 69 66 te-ahead log, if
0b40: 20 69 74 20 69 73 20 70 72 65 73 65 6e 74 2e 20 it is present.
0b50: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 */.int sqlite3Wa
0b60: 6c 46 69 6e 64 46 72 61 6d 65 28 57 61 6c 20 2a lFindFrame(Wal *
0b70: 2c 20 50 67 6e 6f 2c 20 75 33 32 20 2a 29 3b 0a , Pgno, u32 *);.
0b80: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 52 65 int sqlite3WalRe
0b90: 61 64 46 72 61 6d 65 28 57 61 6c 20 2a 2c 20 75 adFrame(Wal *, u
0ba0: 33 32 2c 20 69 6e 74 2c 20 75 38 20 2a 29 3b 0a 32, int, u8 *);.
0bb0: 0a 2f 2a 20 49 66 20 74 68 65 20 57 41 4c 20 69 ./* If the WAL i
0bc0: 73 20 6e 6f 74 20 65 6d 70 74 79 2c 20 72 65 74 s not empty, ret
0bd0: 75 72 6e 20 74 68 65 20 73 69 7a 65 20 6f 66 20 urn the size of
0be0: 74 68 65 20 64 61 74 61 62 61 73 65 2e 20 2a 2f the database. */
0bf0: 0a 50 67 6e 6f 20 73 71 6c 69 74 65 33 57 61 6c .Pgno sqlite3Wal
0c00: 44 62 73 69 7a 65 28 57 61 6c 20 2a 70 57 61 6c Dbsize(Wal *pWal
0c10: 29 3b 0a 0a 2f 2a 20 4f 62 74 61 69 6e 20 6f 72 );../* Obtain or
0c20: 20 72 65 6c 65 61 73 65 20 74 68 65 20 57 52 49 release the WRI
0c30: 54 45 52 20 6c 6f 63 6b 2e 20 2a 2f 0a 69 6e 74 TER lock. */.int
0c40: 20 73 71 6c 69 74 65 33 57 61 6c 42 65 67 69 6e sqlite3WalBegin
0c50: 57 72 69 74 65 54 72 61 6e 73 61 63 74 69 6f 6e WriteTransaction
0c60: 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 69 6e 74 (Wal *pWal);.int
0c70: 20 73 71 6c 69 74 65 33 57 61 6c 45 6e 64 57 72 sqlite3WalEndWr
0c80: 69 74 65 54 72 61 6e 73 61 63 74 69 6f 6e 28 57 iteTransaction(W
0c90: 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20 55 al *pWal);../* U
0ca0: 6e 64 6f 20 61 6e 79 20 66 72 61 6d 65 73 20 77 ndo any frames w
0cb0: 72 69 74 74 65 6e 20 28 62 75 74 20 6e 6f 74 20 ritten (but not
0cc0: 63 6f 6d 6d 69 74 74 65 64 29 20 74 6f 20 74 68 committed) to th
0cd0: 65 20 6c 6f 67 20 2a 2f 0a 69 6e 74 20 73 71 6c e log */.int sql
0ce0: 69 74 65 33 57 61 6c 55 6e 64 6f 28 57 61 6c 20 ite3WalUndo(Wal
0cf0: 2a 70 57 61 6c 2c 20 69 6e 74 20 28 2a 78 55 6e *pWal, int (*xUn
0d00: 64 6f 29 28 76 6f 69 64 20 2a 2c 20 50 67 6e 6f do)(void *, Pgno
0d10: 29 2c 20 76 6f 69 64 20 2a 70 55 6e 64 6f 43 74 ), void *pUndoCt
0d20: 78 2c 20 69 6e 74 29 3b 0a 0a 2f 2a 20 52 65 74 x, int);../* Ret
0d30: 75 72 6e 20 61 6e 20 69 6e 74 65 67 65 72 20 74 urn an integer t
0d40: 68 61 74 20 72 65 63 6f 72 64 73 20 74 68 65 20 hat records the
0d50: 63 75 72 72 65 6e 74 20 28 75 6e 63 6f 6d 6d 69 current (uncommi
0d60: 74 74 65 64 29 20 77 72 69 74 65 0a 2a 2a 20 70 tted) write.** p
0d70: 6f 73 69 74 69 6f 6e 20 69 6e 20 74 68 65 20 57 osition in the W
0d80: 41 4c 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 AL */.void sqlit
0d90: 65 33 57 61 6c 53 61 76 65 70 6f 69 6e 74 28 57 e3WalSavepoint(W
0da0: 61 6c 20 2a 70 57 61 6c 2c 20 75 33 32 20 2a 61 al *pWal, u32 *a
0db0: 57 61 6c 44 61 74 61 29 3b 0a 0a 2f 2a 20 4d 6f WalData);../* Mo
0dc0: 76 65 20 74 68 65 20 77 72 69 74 65 20 70 6f 73 ve the write pos
0dd0: 69 74 69 6f 6e 20 6f 66 20 74 68 65 20 57 41 4c ition of the WAL
0de0: 20 62 61 63 6b 20 74 6f 20 69 46 72 61 6d 65 2e back to iFrame.
0df0: 20 20 43 61 6c 6c 65 64 20 69 6e 0a 2a 2a 20 72 Called in.** r
0e00: 65 73 70 6f 6e 73 65 20 74 6f 20 61 20 52 4f 4c esponse to a ROL
0e10: 4c 42 41 43 4b 20 54 4f 20 63 6f 6d 6d 61 6e 64 LBACK TO command
0e20: 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 . */.int sqlite3
0e30: 57 61 6c 53 61 76 65 70 6f 69 6e 74 55 6e 64 6f WalSavepointUndo
0e40: 28 57 61 6c 20 2a 70 57 61 6c 2c 20 75 33 32 20 (Wal *pWal, u32
0e50: 2a 61 57 61 6c 44 61 74 61 29 3b 0a 0a 2f 2a 20 *aWalData);../*
0e60: 57 72 69 74 65 20 61 20 66 72 61 6d 65 20 6f 72 Write a frame or
0e70: 20 66 72 61 6d 65 73 20 74 6f 20 74 68 65 20 6c frames to the l
0e80: 6f 67 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 og. */.int sqlit
0e90: 65 33 57 61 6c 46 72 61 6d 65 73 28 57 61 6c 20 e3WalFrames(Wal
0ea0: 2a 70 57 61 6c 2c 20 69 6e 74 2c 20 50 67 48 64 *pWal, int, PgHd
0eb0: 72 20 2a 2c 20 50 67 6e 6f 2c 20 69 6e 74 2c 20 r *, Pgno, int,
0ec0: 69 6e 74 29 3b 0a 0a 2f 2a 20 43 6f 70 79 20 70 int);../* Copy p
0ed0: 61 67 65 73 20 66 72 6f 6d 20 74 68 65 20 6c 6f ages from the lo
0ee0: 67 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73 g to the databas
0ef0: 65 20 66 69 6c 65 20 2a 2f 20 0a 69 6e 74 20 73 e file */ .int s
0f00: 71 6c 69 74 65 33 57 61 6c 43 68 65 63 6b 70 6f qlite3WalCheckpo
0f10: 69 6e 74 28 0a 20 20 57 61 6c 20 2a 70 57 61 6c int(. Wal *pWal
0f20: 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 ,
0f30: 20 20 20 20 20 20 20 2f 2a 20 57 72 69 74 65 2d /* Write-
0f40: 61 68 65 61 64 20 6c 6f 67 20 63 6f 6e 6e 65 63 ahead log connec
0f50: 74 69 6f 6e 20 2a 2f 0a 20 20 73 71 6c 69 74 65 tion */. sqlite
0f60: 33 20 2a 64 62 2c 20 20 20 20 20 20 20 20 20 20 3 *db,
0f70: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 43 68 65 /* Che
0f80: 63 6b 20 74 68 69 73 20 68 61 6e 64 6c 65 27 73 ck this handle's
0f90: 20 69 6e 74 65 72 72 75 70 74 20 66 6c 61 67 20 interrupt flag
0fa0: 2a 2f 0a 20 20 69 6e 74 20 65 4d 6f 64 65 2c 20 */. int eMode,
0fb0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
0fc0: 20 20 20 20 20 2f 2a 20 4f 6e 65 20 6f 66 20 50 /* One of P
0fd0: 41 53 53 49 56 45 2c 20 46 55 4c 4c 20 61 6e 64 ASSIVE, FULL and
0fe0: 20 52 45 53 54 41 52 54 20 2a 2f 0a 20 20 69 6e RESTART */. in
0ff0: 74 20 28 2a 78 42 75 73 79 29 28 76 6f 69 64 2a t (*xBusy)(void*
1000: 29 2c 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a ), /*
1010: 20 46 75 6e 63 74 69 6f 6e 20 74 6f 20 63 61 6c Function to cal
1020: 6c 20 77 68 65 6e 20 62 75 73 79 20 2a 2f 0a 20 l when busy */.
1030: 20 76 6f 69 64 20 2a 70 42 75 73 79 41 72 67 2c void *pBusyArg,
1040: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
1050: 20 2f 2a 20 43 6f 6e 74 65 78 74 20 61 72 67 75 /* Context argu
1060: 6d 65 6e 74 20 66 6f 72 20 78 42 75 73 79 48 61 ment for xBusyHa
1070: 6e 64 6c 65 72 20 2a 2f 0a 20 20 69 6e 74 20 73 ndler */. int s
1080: 79 6e 63 5f 66 6c 61 67 73 2c 20 20 20 20 20 20 ync_flags,
1090: 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46 6c /* Fl
10a0: 61 67 73 20 74 6f 20 73 79 6e 63 20 64 62 20 66 ags to sync db f
10b0: 69 6c 65 20 77 69 74 68 20 28 6f 72 20 30 29 20 ile with (or 0)
10c0: 2a 2f 0a 20 20 69 6e 74 20 6e 42 75 66 2c 20 20 */. int nBuf,
10d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
10e0: 20 20 20 20 20 2f 2a 20 53 69 7a 65 20 6f 66 20 /* Size of
10f0: 62 75 66 66 65 72 20 6e 42 75 66 20 2a 2f 0a 20 buffer nBuf */.
1100: 20 75 38 20 2a 7a 42 75 66 2c 20 20 20 20 20 20 u8 *zBuf,
1110: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
1120: 20 2f 2a 20 54 65 6d 70 6f 72 61 72 79 20 62 75 /* Temporary bu
1130: 66 66 65 72 20 74 6f 20 75 73 65 20 2a 2f 0a 20 ffer to use */.
1140: 20 69 6e 74 20 2a 70 6e 4c 6f 67 2c 20 20 20 20 int *pnLog,
1150: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
1160: 20 2f 2a 20 4f 55 54 3a 20 4e 75 6d 62 65 72 20 /* OUT: Number
1170: 6f 66 20 66 72 61 6d 65 73 20 69 6e 20 57 41 4c of frames in WAL
1180: 20 2a 2f 0a 20 20 69 6e 74 20 2a 70 6e 43 6b 70 */. int *pnCkp
1190: 74 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 t
11a0: 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a 20 4e 75 /* OUT: Nu
11b0: 6d 62 65 72 20 6f 66 20 62 61 63 6b 66 69 6c 6c mber of backfill
11c0: 65 64 20 66 72 61 6d 65 73 20 69 6e 20 57 41 4c ed frames in WAL
11d0: 20 2a 2f 0a 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 */.);../* Retur
11e0: 6e 20 74 68 65 20 76 61 6c 75 65 20 74 6f 20 70 n the value to p
11f0: 61 73 73 20 74 6f 20 61 20 73 71 6c 69 74 65 33 ass to a sqlite3
1200: 5f 77 61 6c 5f 68 6f 6f 6b 20 63 61 6c 6c 62 61 _wal_hook callba
1210: 63 6b 2c 20 74 68 65 0a 2a 2a 20 6e 75 6d 62 65 ck, the.** numbe
1220: 72 20 6f 66 20 66 72 61 6d 65 73 20 69 6e 20 74 r of frames in t
1230: 68 65 20 57 41 4c 20 61 74 20 74 68 65 20 70 6f he WAL at the po
1240: 69 6e 74 20 6f 66 20 74 68 65 20 6c 61 73 74 20 int of the last
1250: 63 6f 6d 6d 69 74 20 73 69 6e 63 65 0a 2a 2a 20 commit since.**
1260: 73 71 6c 69 74 65 33 57 61 6c 43 61 6c 6c 62 61 sqlite3WalCallba
1270: 63 6b 28 29 20 77 61 73 20 63 61 6c 6c 65 64 2e ck() was called.
1280: 20 20 49 66 20 6e 6f 20 63 6f 6d 6d 69 74 73 20 If no commits
1290: 68 61 76 65 20 6f 63 63 75 72 72 65 64 20 73 69 have occurred si
12a0: 6e 63 65 0a 2a 2a 20 74 68 65 20 6c 61 73 74 20 nce.** the last
12b0: 63 61 6c 6c 2c 20 74 68 65 6e 20 72 65 74 75 72 call, then retur
12c0: 6e 20 30 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 n 0..*/.int sqli
12d0: 74 65 33 57 61 6c 43 61 6c 6c 62 61 63 6b 28 57 te3WalCallback(W
12e0: 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20 54 al *pWal);../* T
12f0: 65 6c 6c 20 74 68 65 20 77 61 6c 20 6c 61 79 65 ell the wal laye
1300: 72 20 74 68 61 74 20 61 6e 20 45 58 43 4c 55 53 r that an EXCLUS
1310: 49 56 45 20 6c 6f 63 6b 20 68 61 73 20 62 65 65 IVE lock has bee
1320: 6e 20 6f 62 74 61 69 6e 65 64 20 28 6f 72 20 72 n obtained (or r
1330: 65 6c 65 61 73 65 64 29 0a 2a 2a 20 62 79 20 74 eleased).** by t
1340: 68 65 20 70 61 67 65 72 20 6c 61 79 65 72 20 6f he pager layer o
1350: 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66 n the database f
1360: 69 6c 65 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 ile..*/.int sqli
1370: 74 65 33 57 61 6c 45 78 63 6c 75 73 69 76 65 4d te3WalExclusiveM
1380: 6f 64 65 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69 ode(Wal *pWal, i
1390: 6e 74 20 6f 70 29 3b 0a 0a 2f 2a 20 52 65 74 75 nt op);../* Retu
13a0: 72 6e 20 74 72 75 65 20 69 66 20 74 68 65 20 61 rn true if the a
13b0: 72 67 75 6d 65 6e 74 20 69 73 20 6e 6f 6e 2d 4e rgument is non-N
13c0: 55 4c 4c 20 61 6e 64 20 74 68 65 20 57 41 4c 20 ULL and the WAL
13d0: 6d 6f 64 75 6c 65 20 69 73 20 75 73 69 6e 67 0a module is using.
13e0: 2a 2a 20 68 65 61 70 2d 6d 65 6d 6f 72 79 20 66 ** heap-memory f
13f0: 6f 72 20 74 68 65 20 77 61 6c 2d 69 6e 64 65 78 or the wal-index
1400: 2e 20 4f 74 68 65 72 77 69 73 65 2c 20 69 66 20 . Otherwise, if
1410: 74 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20 the argument is
1420: 4e 55 4c 4c 20 6f 72 20 74 68 65 0a 2a 2a 20 57 NULL or the.** W
1430: 41 4c 20 6d 6f 64 75 6c 65 20 69 73 20 75 73 69 AL module is usi
1440: 6e 67 20 73 68 61 72 65 64 2d 6d 65 6d 6f 72 79 ng shared-memory
1450: 2c 20 72 65 74 75 72 6e 20 66 61 6c 73 65 2e 20 , return false.
1460: 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 .*/.int sqlite3W
1470: 61 6c 48 65 61 70 4d 65 6d 6f 72 79 28 57 61 6c alHeapMemory(Wal
1480: 20 2a 70 57 61 6c 29 3b 0a 0a 23 69 66 64 65 66 *pWal);..#ifdef
1490: 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 SQLITE_ENABLE_S
14a0: 4e 41 50 53 48 4f 54 0a 69 6e 74 20 73 71 6c 69 NAPSHOT.int sqli
14b0: 74 65 33 57 61 6c 53 6e 61 70 73 68 6f 74 47 65 te3WalSnapshotGe
14c0: 74 28 57 61 6c 20 2a 70 57 61 6c 2c 20 73 71 6c t(Wal *pWal, sql
14d0: 69 74 65 33 5f 73 6e 61 70 73 68 6f 74 20 2a 2a ite3_snapshot **
14e0: 70 70 53 6e 61 70 73 68 6f 74 29 3b 0a 76 6f 69 ppSnapshot);.voi
14f0: 64 20 73 71 6c 69 74 65 33 57 61 6c 53 6e 61 70 d sqlite3WalSnap
1500: 73 68 6f 74 4f 70 65 6e 28 57 61 6c 20 2a 70 57 shotOpen(Wal *pW
1510: 61 6c 2c 20 73 71 6c 69 74 65 33 5f 73 6e 61 70 al, sqlite3_snap
1520: 73 68 6f 74 20 2a 70 53 6e 61 70 73 68 6f 74 29 shot *pSnapshot)
1530: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c ;.int sqlite3Wal
1540: 53 6e 61 70 73 68 6f 74 52 65 63 6f 76 65 72 28 SnapshotRecover(
1550: 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 69 6e 74 20 Wal *pWal);.int
1560: 73 71 6c 69 74 65 33 57 61 6c 53 6e 61 70 73 68 sqlite3WalSnapsh
1570: 6f 74 43 68 65 63 6b 28 57 61 6c 20 2a 70 57 61 otCheck(Wal *pWa
1580: 6c 2c 20 73 71 6c 69 74 65 33 5f 73 6e 61 70 73 l, sqlite3_snaps
1590: 68 6f 74 20 2a 70 53 6e 61 70 73 68 6f 74 29 3b hot *pSnapshot);
15a0: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61 6c .void sqlite3Wal
15b0: 53 6e 61 70 73 68 6f 74 55 6e 6c 6f 63 6b 28 57 SnapshotUnlock(W
15c0: 61 6c 20 2a 70 57 61 6c 29 3b 0a 23 65 6e 64 69 al *pWal);.#endi
15d0: 66 0a 0a 23 69 66 6e 64 65 66 20 53 51 4c 49 54 f..#ifndef SQLIT
15e0: 45 5f 4f 4d 49 54 5f 43 4f 4e 43 55 52 52 45 4e E_OMIT_CONCURREN
15f0: 54 0a 2f 2a 20 54 65 6c 6c 20 74 68 65 20 77 61 T./* Tell the wa
1600: 6c 20 6c 61 79 65 72 20 74 68 61 74 20 77 65 20 l layer that we
1610: 77 61 6e 74 20 74 6f 20 63 6f 6d 6d 69 74 20 61 want to commit a
1620: 20 63 6f 6e 63 75 72 72 65 6e 74 20 74 72 61 6e concurrent tran
1630: 73 61 63 74 69 6f 6e 20 2a 2f 0a 69 6e 74 20 73 saction */.int s
1640: 71 6c 69 74 65 33 57 61 6c 4c 6f 63 6b 46 6f 72 qlite3WalLockFor
1650: 43 6f 6d 6d 69 74 28 57 61 6c 20 2a 70 57 61 6c Commit(Wal *pWal
1660: 2c 20 50 67 48 64 72 20 2a 70 50 67 2c 20 42 69 , PgHdr *pPg, Bi
1670: 74 76 65 63 20 2a 70 52 65 61 64 2c 20 50 67 6e tvec *pRead, Pgn
1680: 6f 2a 29 3b 0a 0a 2f 2a 20 55 70 67 72 61 64 65 o*);../* Upgrade
1690: 20 74 68 65 20 73 74 61 74 65 20 6f 66 20 74 68 the state of th
16a0: 65 20 63 6c 69 65 6e 74 20 74 6f 20 74 61 6b 65 e client to take
16b0: 20 69 6e 74 6f 20 61 63 63 6f 75 6e 74 20 63 68 into account ch
16c0: 61 6e 67 65 73 20 77 72 69 74 74 65 6e 0a 2a 2a anges written.**
16d0: 20 62 79 20 6f 74 68 65 72 20 63 6f 6e 6e 65 63 by other connec
16e0: 74 69 6f 6e 73 20 2a 2f 0a 69 6e 74 20 73 71 6c tions */.int sql
16f0: 69 74 65 33 57 61 6c 55 70 67 72 61 64 65 53 6e ite3WalUpgradeSn
1700: 61 70 73 68 6f 74 28 57 61 6c 20 2a 70 57 61 6c apshot(Wal *pWal
1710: 29 3b 0a 23 65 6e 64 69 66 20 2f 2a 20 53 51 4c );.#endif /* SQL
1720: 49 54 45 5f 4f 4d 49 54 5f 43 4f 4e 43 55 52 52 ITE_OMIT_CONCURR
1730: 45 4e 54 20 2a 2f 0a 0a 23 69 66 64 65 66 20 53 ENT */..#ifdef S
1740: 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 5a 49 50 QLITE_ENABLE_ZIP
1750: 56 46 53 0a 2f 2a 20 49 66 20 74 68 65 20 57 41 VFS./* If the WA
1760: 4c 20 66 69 6c 65 20 69 73 20 6e 6f 74 20 65 6d L file is not em
1770: 70 74 79 2c 20 72 65 74 75 72 6e 20 74 68 65 20 pty, return the
1780: 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20 number of bytes
1790: 6f 66 20 63 6f 6e 74 65 6e 74 0a 2a 2a 20 73 74 of content.** st
17a0: 6f 72 65 64 20 69 6e 20 65 61 63 68 20 66 72 61 ored in each fra
17b0: 6d 65 20 28 69 2e 65 2e 20 74 68 65 20 64 62 20 me (i.e. the db
17c0: 70 61 67 65 2d 73 69 7a 65 20 77 68 65 6e 20 74 page-size when t
17d0: 68 65 20 57 41 4c 20 77 61 73 20 63 72 65 61 74 he WAL was creat
17e0: 65 64 29 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 ed)..*/.int sqli
17f0: 74 65 33 57 61 6c 46 72 61 6d 65 73 69 7a 65 28 te3WalFramesize(
1800: 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 23 65 6e 64 Wal *pWal);.#end
1810: 69 66 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74 68 if../* Return th
1820: 65 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 20 6f e sqlite3_file o
1830: 62 6a 65 63 74 20 66 6f 72 20 74 68 65 20 57 41 bject for the WA
1840: 4c 20 66 69 6c 65 20 2a 2f 0a 73 71 6c 69 74 65 L file */.sqlite
1850: 33 5f 66 69 6c 65 20 2a 73 71 6c 69 74 65 33 57 3_file *sqlite3W
1860: 61 6c 46 69 6c 65 28 57 61 6c 20 2a 70 57 61 6c alFile(Wal *pWal
1870: 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74 68 );../* Return th
1880: 65 20 6a 6f 75 72 6e 61 6c 20 6d 6f 64 65 20 28 e journal mode (
1890: 57 41 4c 20 6f 72 20 57 41 4c 32 29 20 75 73 65 WAL or WAL2) use
18a0: 64 20 62 79 20 74 68 69 73 20 57 61 6c 20 6f 62 d by this Wal ob
18b0: 6a 65 63 74 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c ject. */.int sql
18c0: 69 74 65 33 57 61 6c 4a 6f 75 72 6e 61 6c 4d 6f ite3WalJournalMo
18d0: 64 65 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a de(Wal *pWal);..
18e0: 2f 2a 20 73 71 6c 69 74 65 33 5f 77 61 6c 5f 69 /* sqlite3_wal_i
18f0: 6e 66 6f 28 29 20 64 61 74 61 20 2a 2f 0a 69 6e nfo() data */.in
1900: 74 20 73 71 6c 69 74 65 33 57 61 6c 49 6e 66 6f t sqlite3WalInfo
1910: 28 57 61 6c 20 2a 70 57 61 6c 2c 20 75 33 32 20 (Wal *pWal, u32
1920: 2a 70 6e 50 72 69 6f 72 2c 20 75 33 32 20 2a 70 *pnPrior, u32 *p
1930: 6e 46 72 61 6d 65 29 3b 0a 0a 23 65 6e 64 69 66 nFrame);..#endif
1940: 20 2f 2a 20 69 66 6e 64 65 66 20 53 51 4c 49 54 /* ifndef SQLIT
1950: 45 5f 4f 4d 49 54 5f 57 41 4c 20 2a 2f 0a 23 65 E_OMIT_WAL */.#e
1960: 6e 64 69 66 20 2f 2a 20 53 51 4c 49 54 45 5f 57 ndif /* SQLITE_W
1970: 41 4c 5f 48 20 2a 2f 0a AL_H */.