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 5f 57 41 4c 5f 48 5f 0a 23 ifndef _WAL_H_.#
0260: 64 65 66 69 6e 65 20 5f 57 41 4c 5f 48 5f 0a 0a define _WAL_H_..
0270: 23 69 6e 63 6c 75 64 65 20 22 73 71 6c 69 74 65 #include "sqlite
0280: 49 6e 74 2e 68 22 0a 0a 2f 2a 20 41 64 64 69 74 Int.h"../* Addit
0290: 69 6f 6e 61 6c 20 76 61 6c 75 65 73 20 74 68 61 ional values tha
02a0: 74 20 63 61 6e 20 62 65 20 61 64 64 65 64 20 74 t can be added t
02b0: 6f 20 74 68 65 20 73 79 6e 63 5f 66 6c 61 67 73 o the sync_flags
02c0: 20 61 72 67 75 6d 65 6e 74 20 6f 66 0a 2a 2a 20 argument of.**
02d0: 73 71 6c 69 74 65 33 57 61 6c 46 72 61 6d 65 73 sqlite3WalFrames
02e0: 28 29 3a 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 57 ():.*/.#define W
02f0: 41 4c 5f 53 59 4e 43 5f 54 52 41 4e 53 41 43 54 AL_SYNC_TRANSACT
0300: 49 4f 4e 53 20 20 30 78 32 30 20 20 20 2f 2a 20 IONS 0x20 /*
0310: 53 79 6e 63 20 61 74 20 74 68 65 20 65 6e 64 20 Sync at the end
0320: 6f 66 20 65 61 63 68 20 74 72 61 6e 73 61 63 74 of each transact
0330: 69 6f 6e 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 ion */.#define S
0340: 51 4c 49 54 45 5f 53 59 4e 43 5f 4d 41 53 4b 20 QLITE_SYNC_MASK
0350: 20 20 20 20 20 20 30 78 31 33 20 20 20 2f 2a 20 0x13 /*
0360: 4d 61 73 6b 20 6f 66 66 20 74 68 65 20 53 51 4c Mask off the SQL
0370: 49 54 45 5f 53 59 4e 43 5f 2a 20 76 61 6c 75 65 ITE_SYNC_* value
0380: 73 20 2a 2f 0a 0a 23 69 66 64 65 66 20 53 51 4c s */..#ifdef SQL
0390: 49 54 45 5f 4f 4d 49 54 5f 57 41 4c 0a 23 20 64 ITE_OMIT_WAL.# d
03a0: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c efine sqlite3Wal
03b0: 4f 70 65 6e 28 78 2c 79 2c 7a 29 20 20 20 20 20 Open(x,y,z)
03c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0a 0.
03d0: 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 # define sqlite3
03e0: 57 61 6c 4c 69 6d 69 74 28 78 2c 79 29 0a 23 20 WalLimit(x,y).#
03f0: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 define sqlite3Wa
0400: 6c 43 6c 6f 73 65 28 77 2c 78 2c 79 2c 7a 29 20 lClose(w,x,y,z)
0410: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0
0420: 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 .# define sqlite
0430: 33 57 61 6c 42 65 67 69 6e 52 65 61 64 54 72 61 3WalBeginReadTra
0440: 6e 73 61 63 74 69 6f 6e 28 79 2c 7a 29 20 20 20 nsaction(y,z)
0450: 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 0.# define sql
0460: 69 74 65 33 57 61 6c 45 6e 64 52 65 61 64 54 72 ite3WalEndReadTr
0470: 61 6e 73 61 63 74 69 6f 6e 28 7a 29 0a 23 20 64 ansaction(z).# d
0480: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c efine sqlite3Wal
0490: 44 62 73 69 7a 65 28 79 29 20 20 20 20 20 20 20 Dbsize(y)
04a0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0a 0.
04b0: 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 # define sqlite3
04c0: 57 61 6c 42 65 67 69 6e 57 72 69 74 65 54 72 61 WalBeginWriteTra
04d0: 6e 73 61 63 74 69 6f 6e 28 79 29 20 20 20 20 20 nsaction(y)
04e0: 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 0.# define sqli
04f0: 74 65 33 57 61 6c 45 6e 64 57 72 69 74 65 54 72 te3WalEndWriteTr
0500: 61 6e 73 61 63 74 69 6f 6e 28 78 29 20 20 20 20 ansaction(x)
0510: 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73 0.# define s
0520: 71 6c 69 74 65 33 57 61 6c 55 6e 64 6f 28 78 2c qlite3WalUndo(x,
0530: 79 2c 7a 29 20 20 20 20 20 20 20 20 20 20 20 20 y,z)
0540: 20 20 20 20 20 20 20 30 0a 23 20 64 65 66 69 6e 0.# defin
0550: 65 20 73 71 6c 69 74 65 33 57 61 6c 53 61 76 65 e sqlite3WalSave
0560: 70 6f 69 6e 74 28 79 2c 7a 29 0a 23 20 64 65 66 point(y,z).# def
0570: 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 53 61 ine sqlite3WalSa
0580: 76 65 70 6f 69 6e 74 55 6e 64 6f 28 79 2c 7a 29 vepointUndo(y,z)
0590: 20 20 20 20 20 20 20 20 20 20 20 20 30 0a 23 20 0.#
05a0: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 define sqlite3Wa
05b0: 6c 46 72 61 6d 65 73 28 75 2c 76 2c 77 2c 78 2c lFrames(u,v,w,x,
05c0: 79 2c 7a 29 20 20 20 20 20 20 20 20 20 20 20 30 y,z) 0
05d0: 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 .# define sqlite
05e0: 33 57 61 6c 43 68 65 63 6b 70 6f 69 6e 74 28 72 3WalCheckpoint(r
05f0: 2c 73 2c 74 2c 75 2c 76 2c 77 2c 78 2c 79 2c 7a ,s,t,u,v,w,x,y,z
0600: 29 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c ) 0.# define sql
0610: 69 74 65 33 57 61 6c 43 61 6c 6c 62 61 63 6b 28 ite3WalCallback(
0620: 7a 29 20 20 20 20 20 20 20 20 20 20 20 20 20 20 z)
0630: 20 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20 0.# define
0640: 73 71 6c 69 74 65 33 57 61 6c 45 78 63 6c 75 73 sqlite3WalExclus
0650: 69 76 65 4d 6f 64 65 28 79 2c 7a 29 20 20 20 20 iveMode(y,z)
0660: 20 20 20 20 20 20 20 20 30 0a 23 20 64 65 66 69 0.# defi
0670: 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 48 65 61 ne sqlite3WalHea
0680: 70 4d 65 6d 6f 72 79 28 7a 29 20 20 20 20 20 20 pMemory(z)
0690: 20 20 20 20 20 20 20 20 20 20 20 30 0a 23 20 64 0.# d
06a0: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c efine sqlite3Wal
06b0: 46 72 61 6d 65 73 69 7a 65 28 7a 29 20 20 20 20 Framesize(z)
06c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0a 0.
06d0: 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 # define sqlite3
06e0: 57 61 6c 46 69 6e 64 46 72 61 6d 65 28 78 2c 79 WalFindFrame(x,y
06f0: 2c 7a 29 20 20 20 20 20 20 20 20 20 20 20 20 20 ,z)
0700: 20 30 0a 23 65 6c 73 65 0a 0a 23 64 65 66 69 6e 0.#else..#defin
0710: 65 20 57 41 4c 5f 53 41 56 45 50 4f 49 4e 54 5f e WAL_SAVEPOINT_
0720: 4e 44 41 54 41 20 34 0a 0a 2f 2a 20 43 6f 6e 6e NDATA 4../* Conn
0730: 65 63 74 69 6f 6e 20 74 6f 20 61 20 77 72 69 74 ection to a writ
0740: 65 2d 61 68 65 61 64 20 6c 6f 67 20 28 57 41 4c e-ahead log (WAL
0750: 29 20 66 69 6c 65 2e 20 0a 2a 2a 20 54 68 65 72 ) file. .** Ther
0760: 65 20 69 73 20 6f 6e 65 20 6f 62 6a 65 63 74 20 e is one object
0770: 6f 66 20 74 68 69 73 20 74 79 70 65 20 66 6f 72 of this type for
0780: 20 65 61 63 68 20 70 61 67 65 72 2e 20 0a 2a 2f each pager. .*/
0790: 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20 .typedef struct
07a0: 57 61 6c 20 57 61 6c 3b 0a 0a 2f 2a 20 4f 70 65 Wal Wal;../* Ope
07b0: 6e 20 61 6e 64 20 63 6c 6f 73 65 20 61 20 63 6f n and close a co
07c0: 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 61 20 77 72 nnection to a wr
07d0: 69 74 65 2d 61 68 65 61 64 20 6c 6f 67 2e 20 2a ite-ahead log. *
07e0: 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c /.int sqlite3Wal
07f0: 4f 70 65 6e 28 73 71 6c 69 74 65 33 5f 76 66 73 Open(sqlite3_vfs
0800: 2a 2c 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a *, sqlite3_file*
0810: 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 2c 20 , const char *,
0820: 69 6e 74 2c 20 69 36 34 2c 20 57 61 6c 2a 2a 29 int, i64, Wal**)
0830: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c ;.int sqlite3Wal
0840: 43 6c 6f 73 65 28 57 61 6c 20 2a 70 57 61 6c 2c Close(Wal *pWal,
0850: 20 69 6e 74 20 73 79 6e 63 5f 66 6c 61 67 73 2c int sync_flags,
0860: 20 69 6e 74 2c 20 75 38 20 2a 29 3b 0a 0a 2f 2a int, u8 *);../*
0870: 20 53 65 74 20 74 68 65 20 6c 69 6d 69 74 69 6e Set the limitin
0880: 67 20 73 69 7a 65 20 6f 66 20 61 20 57 41 4c 20 g size of a WAL
0890: 66 69 6c 65 2e 20 2a 2f 0a 76 6f 69 64 20 73 71 file. */.void sq
08a0: 6c 69 74 65 33 57 61 6c 4c 69 6d 69 74 28 57 61 lite3WalLimit(Wa
08b0: 6c 2a 2c 20 69 36 34 29 3b 0a 0a 2f 2a 20 55 73 l*, i64);../* Us
08c0: 65 64 20 62 79 20 72 65 61 64 65 72 73 20 74 6f ed by readers to
08d0: 20 6f 70 65 6e 20 28 6c 6f 63 6b 29 20 61 6e 64 open (lock) and
08e0: 20 63 6c 6f 73 65 20 28 75 6e 6c 6f 63 6b 29 20 close (unlock)
08f0: 61 20 73 6e 61 70 73 68 6f 74 2e 20 20 41 20 0a a snapshot. A .
0900: 2a 2a 20 73 6e 61 70 73 68 6f 74 20 69 73 20 6c ** snapshot is l
0910: 69 6b 65 20 61 20 72 65 61 64 2d 74 72 61 6e 73 ike a read-trans
0920: 61 63 74 69 6f 6e 2e 20 20 49 74 20 69 73 20 74 action. It is t
0930: 68 65 20 73 74 61 74 65 20 6f 66 20 74 68 65 20 he state of the
0940: 64 61 74 61 62 61 73 65 0a 2a 2a 20 61 74 20 61 database.** at a
0950: 6e 20 69 6e 73 74 61 6e 74 20 69 6e 20 74 69 6d n instant in tim
0960: 65 2e 20 20 73 71 6c 69 74 65 33 57 61 6c 4f 70 e. sqlite3WalOp
0970: 65 6e 53 6e 61 70 73 68 6f 74 20 67 65 74 73 20 enSnapshot gets
0980: 61 20 72 65 61 64 20 6c 6f 63 6b 20 61 6e 64 0a a read lock and.
0990: 2a 2a 20 70 72 65 73 65 72 76 65 73 20 74 68 65 ** preserves the
09a0: 20 63 75 72 72 65 6e 74 20 73 74 61 74 65 20 65 current state e
09b0: 76 65 6e 20 69 66 20 74 68 65 20 6f 74 68 65 72 ven if the other
09c0: 20 74 68 72 65 61 64 73 20 6f 72 20 70 72 6f 63 threads or proc
09d0: 65 73 73 65 73 0a 2a 2a 20 77 72 69 74 65 20 74 esses.** write t
09e0: 6f 20 6f 72 20 63 68 65 63 6b 70 6f 69 6e 74 20 o or checkpoint
09f0: 74 68 65 20 57 41 4c 2e 20 20 73 71 6c 69 74 65 the WAL. sqlite
0a00: 33 57 61 6c 43 6c 6f 73 65 53 6e 61 70 73 68 6f 3WalCloseSnapsho
0a10: 74 28 29 20 63 6c 6f 73 65 73 20 74 68 65 0a 2a t() closes the.*
0a20: 2a 20 74 72 61 6e 73 61 63 74 69 6f 6e 20 61 6e * transaction an
0a30: 64 20 72 65 6c 65 61 73 65 73 20 74 68 65 20 6c d releases the l
0a40: 6f 63 6b 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 ock..*/.int sqli
0a50: 74 65 33 57 61 6c 42 65 67 69 6e 52 65 61 64 54 te3WalBeginReadT
0a60: 72 61 6e 73 61 63 74 69 6f 6e 28 57 61 6c 20 2a ransaction(Wal *
0a70: 70 57 61 6c 2c 20 69 6e 74 20 2a 29 3b 0a 76 6f pWal, int *);.vo
0a80: 69 64 20 73 71 6c 69 74 65 33 57 61 6c 45 6e 64 id sqlite3WalEnd
0a90: 52 65 61 64 54 72 61 6e 73 61 63 74 69 6f 6e 28 ReadTransaction(
0aa0: 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20 Wal *pWal);../*
0ab0: 52 65 61 64 20 61 20 70 61 67 65 20 66 72 6f 6d Read a page from
0ac0: 20 74 68 65 20 77 72 69 74 65 2d 61 68 65 61 64 the write-ahead
0ad0: 20 6c 6f 67 2c 20 69 66 20 69 74 20 69 73 20 70 log, if it is p
0ae0: 72 65 73 65 6e 74 2e 20 2a 2f 0a 69 6e 74 20 73 resent. */.int s
0af0: 71 6c 69 74 65 33 57 61 6c 46 69 6e 64 46 72 61 qlite3WalFindFra
0b00: 6d 65 28 57 61 6c 20 2a 2c 20 50 67 6e 6f 2c 20 me(Wal *, Pgno,
0b10: 75 33 32 20 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 u32 *);.int sqli
0b20: 74 65 33 57 61 6c 52 65 61 64 46 72 61 6d 65 28 te3WalReadFrame(
0b30: 57 61 6c 20 2a 2c 20 75 33 32 2c 20 69 6e 74 2c Wal *, u32, int,
0b40: 20 75 38 20 2a 29 3b 0a 0a 2f 2a 20 49 66 20 74 u8 *);../* If t
0b50: 68 65 20 57 41 4c 20 69 73 20 6e 6f 74 20 65 6d he WAL is not em
0b60: 70 74 79 2c 20 72 65 74 75 72 6e 20 74 68 65 20 pty, return the
0b70: 73 69 7a 65 20 6f 66 20 74 68 65 20 64 61 74 61 size of the data
0b80: 62 61 73 65 2e 20 2a 2f 0a 50 67 6e 6f 20 73 71 base. */.Pgno sq
0b90: 6c 69 74 65 33 57 61 6c 44 62 73 69 7a 65 28 57 lite3WalDbsize(W
0ba0: 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20 4f al *pWal);../* O
0bb0: 62 74 61 69 6e 20 6f 72 20 72 65 6c 65 61 73 65 btain or release
0bc0: 20 74 68 65 20 57 52 49 54 45 52 20 6c 6f 63 6b the WRITER lock
0bd0: 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 . */.int sqlite3
0be0: 57 61 6c 42 65 67 69 6e 57 72 69 74 65 54 72 61 WalBeginWriteTra
0bf0: 6e 73 61 63 74 69 6f 6e 28 57 61 6c 20 2a 70 57 nsaction(Wal *pW
0c00: 61 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 al);.int sqlite3
0c10: 57 61 6c 45 6e 64 57 72 69 74 65 54 72 61 6e 73 WalEndWriteTrans
0c20: 61 63 74 69 6f 6e 28 57 61 6c 20 2a 70 57 61 6c action(Wal *pWal
0c30: 29 3b 0a 0a 2f 2a 20 55 6e 64 6f 20 61 6e 79 20 );../* Undo any
0c40: 66 72 61 6d 65 73 20 77 72 69 74 74 65 6e 20 28 frames written (
0c50: 62 75 74 20 6e 6f 74 20 63 6f 6d 6d 69 74 74 65 but not committe
0c60: 64 29 20 74 6f 20 74 68 65 20 6c 6f 67 20 2a 2f d) to the log */
0c70: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 55 .int sqlite3WalU
0c80: 6e 64 6f 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69 ndo(Wal *pWal, i
0c90: 6e 74 20 28 2a 78 55 6e 64 6f 29 28 76 6f 69 64 nt (*xUndo)(void
0ca0: 20 2a 2c 20 50 67 6e 6f 29 2c 20 76 6f 69 64 20 *, Pgno), void
0cb0: 2a 70 55 6e 64 6f 43 74 78 29 3b 0a 0a 2f 2a 20 *pUndoCtx);../*
0cc0: 52 65 74 75 72 6e 20 61 6e 20 69 6e 74 65 67 65 Return an intege
0cd0: 72 20 74 68 61 74 20 72 65 63 6f 72 64 73 20 74 r that records t
0ce0: 68 65 20 63 75 72 72 65 6e 74 20 28 75 6e 63 6f he current (unco
0cf0: 6d 6d 69 74 74 65 64 29 20 77 72 69 74 65 0a 2a mmitted) write.*
0d00: 2a 20 70 6f 73 69 74 69 6f 6e 20 69 6e 20 74 68 * position in th
0d10: 65 20 57 41 4c 20 2a 2f 0a 76 6f 69 64 20 73 71 e WAL */.void sq
0d20: 6c 69 74 65 33 57 61 6c 53 61 76 65 70 6f 69 6e lite3WalSavepoin
0d30: 74 28 57 61 6c 20 2a 70 57 61 6c 2c 20 75 33 32 t(Wal *pWal, u32
0d40: 20 2a 61 57 61 6c 44 61 74 61 29 3b 0a 0a 2f 2a *aWalData);../*
0d50: 20 4d 6f 76 65 20 74 68 65 20 77 72 69 74 65 20 Move the write
0d60: 70 6f 73 69 74 69 6f 6e 20 6f 66 20 74 68 65 20 position of the
0d70: 57 41 4c 20 62 61 63 6b 20 74 6f 20 69 46 72 61 WAL back to iFra
0d80: 6d 65 2e 20 20 43 61 6c 6c 65 64 20 69 6e 0a 2a me. Called in.*
0d90: 2a 20 72 65 73 70 6f 6e 73 65 20 74 6f 20 61 20 * response to a
0da0: 52 4f 4c 4c 42 41 43 4b 20 54 4f 20 63 6f 6d 6d ROLLBACK TO comm
0db0: 61 6e 64 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 and. */.int sqli
0dc0: 74 65 33 57 61 6c 53 61 76 65 70 6f 69 6e 74 55 te3WalSavepointU
0dd0: 6e 64 6f 28 57 61 6c 20 2a 70 57 61 6c 2c 20 75 ndo(Wal *pWal, u
0de0: 33 32 20 2a 61 57 61 6c 44 61 74 61 29 3b 0a 0a 32 *aWalData);..
0df0: 2f 2a 20 57 72 69 74 65 20 61 20 66 72 61 6d 65 /* Write a frame
0e00: 20 6f 72 20 66 72 61 6d 65 73 20 74 6f 20 74 68 or frames to th
0e10: 65 20 6c 6f 67 2e 20 2a 2f 0a 69 6e 74 20 73 71 e log. */.int sq
0e20: 6c 69 74 65 33 57 61 6c 46 72 61 6d 65 73 28 57 lite3WalFrames(W
0e30: 61 6c 20 2a 70 57 61 6c 2c 20 69 6e 74 2c 20 50 al *pWal, int, P
0e40: 67 48 64 72 20 2a 2c 20 50 67 6e 6f 2c 20 69 6e gHdr *, Pgno, in
0e50: 74 2c 20 69 6e 74 29 3b 0a 0a 2f 2a 20 43 6f 70 t, int);../* Cop
0e60: 79 20 70 61 67 65 73 20 66 72 6f 6d 20 74 68 65 y pages from the
0e70: 20 6c 6f 67 20 74 6f 20 74 68 65 20 64 61 74 61 log to the data
0e80: 62 61 73 65 20 66 69 6c 65 20 2a 2f 20 0a 69 6e base file */ .in
0e90: 74 20 73 71 6c 69 74 65 33 57 61 6c 43 68 65 63 t sqlite3WalChec
0ea0: 6b 70 6f 69 6e 74 28 0a 20 20 57 61 6c 20 2a 70 kpoint(. Wal *p
0eb0: 57 61 6c 2c 20 20 20 20 20 20 20 20 20 20 20 20 Wal,
0ec0: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 57 72 69 /* Wri
0ed0: 74 65 2d 61 68 65 61 64 20 6c 6f 67 20 63 6f 6e te-ahead log con
0ee0: 6e 65 63 74 69 6f 6e 20 2a 2f 0a 20 20 69 6e 74 nection */. int
0ef0: 20 65 4d 6f 64 65 2c 20 20 20 20 20 20 20 20 20 eMode,
0f00: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 /*
0f10: 4f 6e 65 20 6f 66 20 50 41 53 53 49 56 45 2c 20 One of PASSIVE,
0f20: 46 55 4c 4c 20 61 6e 64 20 52 45 53 54 41 52 54 FULL and RESTART
0f30: 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 42 75 73 */. int (*xBus
0f40: 79 29 28 76 6f 69 64 2a 29 2c 20 20 20 20 20 20 y)(void*),
0f50: 20 20 20 20 20 20 2f 2a 20 46 75 6e 63 74 69 6f /* Functio
0f60: 6e 20 74 6f 20 63 61 6c 6c 20 77 68 65 6e 20 62 n to call when b
0f70: 75 73 79 20 2a 2f 0a 20 20 76 6f 69 64 20 2a 70 usy */. void *p
0f80: 42 75 73 79 41 72 67 2c 20 20 20 20 20 20 20 20 BusyArg,
0f90: 20 20 20 20 20 20 20 20 20 2f 2a 20 43 6f 6e 74 /* Cont
0fa0: 65 78 74 20 61 72 67 75 6d 65 6e 74 20 66 6f 72 ext argument for
0fb0: 20 78 42 75 73 79 48 61 6e 64 6c 65 72 20 2a 2f xBusyHandler */
0fc0: 0a 20 20 69 6e 74 20 73 79 6e 63 5f 66 6c 61 67 . int sync_flag
0fd0: 73 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 s,
0fe0: 20 20 20 2f 2a 20 46 6c 61 67 73 20 74 6f 20 73 /* Flags to s
0ff0: 79 6e 63 20 64 62 20 66 69 6c 65 20 77 69 74 68 ync db file with
1000: 20 28 6f 72 20 30 29 20 2a 2f 0a 20 20 69 6e 74 (or 0) */. int
1010: 20 6e 42 75 66 2c 20 20 20 20 20 20 20 20 20 20 nBuf,
1020: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 /*
1030: 53 69 7a 65 20 6f 66 20 62 75 66 66 65 72 20 6e Size of buffer n
1040: 42 75 66 20 2a 2f 0a 20 20 75 38 20 2a 7a 42 75 Buf */. u8 *zBu
1050: 66 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 f,
1060: 20 20 20 20 20 20 20 20 20 2f 2a 20 54 65 6d 70 /* Temp
1070: 6f 72 61 72 79 20 62 75 66 66 65 72 20 74 6f 20 orary buffer to
1080: 75 73 65 20 2a 2f 0a 20 20 69 6e 74 20 2a 70 6e use */. int *pn
1090: 4c 6f 67 2c 20 20 20 20 20 20 20 20 20 20 20 20 Log,
10a0: 20 20 20 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a /* OUT:
10b0: 20 4e 75 6d 62 65 72 20 6f 66 20 66 72 61 6d 65 Number of frame
10c0: 73 20 69 6e 20 57 41 4c 20 2a 2f 0a 20 20 69 6e s in WAL */. in
10d0: 74 20 2a 70 6e 43 6b 70 74 20 20 20 20 20 20 20 t *pnCkpt
10e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a /*
10f0: 20 4f 55 54 3a 20 4e 75 6d 62 65 72 20 6f 66 20 OUT: Number of
1100: 62 61 63 6b 66 69 6c 6c 65 64 20 66 72 61 6d 65 backfilled frame
1110: 73 20 69 6e 20 57 41 4c 20 2a 2f 0a 29 3b 0a 0a s in WAL */.);..
1120: 2f 2a 20 52 65 74 75 72 6e 20 74 68 65 20 76 61 /* Return the va
1130: 6c 75 65 20 74 6f 20 70 61 73 73 20 74 6f 20 61 lue to pass to a
1140: 20 73 71 6c 69 74 65 33 5f 77 61 6c 5f 68 6f 6f sqlite3_wal_hoo
1150: 6b 20 63 61 6c 6c 62 61 63 6b 2c 20 74 68 65 0a k callback, the.
1160: 2a 2a 20 6e 75 6d 62 65 72 20 6f 66 20 66 72 61 ** number of fra
1170: 6d 65 73 20 69 6e 20 74 68 65 20 57 41 4c 20 61 mes in the WAL a
1180: 74 20 74 68 65 20 70 6f 69 6e 74 20 6f 66 20 74 t the point of t
1190: 68 65 20 6c 61 73 74 20 63 6f 6d 6d 69 74 20 73 he last commit s
11a0: 69 6e 63 65 0a 2a 2a 20 73 71 6c 69 74 65 33 57 ince.** sqlite3W
11b0: 61 6c 43 61 6c 6c 62 61 63 6b 28 29 20 77 61 73 alCallback() was
11c0: 20 63 61 6c 6c 65 64 2e 20 20 49 66 20 6e 6f 20 called. If no
11d0: 63 6f 6d 6d 69 74 73 20 68 61 76 65 20 6f 63 63 commits have occ
11e0: 75 72 72 65 64 20 73 69 6e 63 65 0a 2a 2a 20 74 urred since.** t
11f0: 68 65 20 6c 61 73 74 20 63 61 6c 6c 2c 20 74 68 he last call, th
1200: 65 6e 20 72 65 74 75 72 6e 20 30 2e 0a 2a 2f 0a en return 0..*/.
1210: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 43 61 int sqlite3WalCa
1220: 6c 6c 62 61 63 6b 28 57 61 6c 20 2a 70 57 61 6c llback(Wal *pWal
1230: 29 3b 0a 0a 2f 2a 20 54 65 6c 6c 20 74 68 65 20 );../* Tell the
1240: 77 61 6c 20 6c 61 79 65 72 20 74 68 61 74 20 61 wal layer that a
1250: 6e 20 45 58 43 4c 55 53 49 56 45 20 6c 6f 63 6b n EXCLUSIVE lock
1260: 20 68 61 73 20 62 65 65 6e 20 6f 62 74 61 69 6e has been obtain
1270: 65 64 20 28 6f 72 20 72 65 6c 65 61 73 65 64 29 ed (or released)
1280: 0a 2a 2a 20 62 79 20 74 68 65 20 70 61 67 65 72 .** by the pager
1290: 20 6c 61 79 65 72 20 6f 6e 20 74 68 65 20 64 61 layer on the da
12a0: 74 61 62 61 73 65 20 66 69 6c 65 2e 0a 2a 2f 0a tabase file..*/.
12b0: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 45 78 int sqlite3WalEx
12c0: 63 6c 75 73 69 76 65 4d 6f 64 65 28 57 61 6c 20 clusiveMode(Wal
12d0: 2a 70 57 61 6c 2c 20 69 6e 74 20 6f 70 29 3b 0a *pWal, int op);.
12e0: 0a 2f 2a 20 52 65 74 75 72 6e 20 74 72 75 65 20 ./* Return true
12f0: 69 66 20 74 68 65 20 61 72 67 75 6d 65 6e 74 20 if the argument
1300: 69 73 20 6e 6f 6e 2d 4e 55 4c 4c 20 61 6e 64 20 is non-NULL and
1310: 74 68 65 20 57 41 4c 20 6d 6f 64 75 6c 65 20 69 the WAL module i
1320: 73 20 75 73 69 6e 67 0a 2a 2a 20 68 65 61 70 2d s using.** heap-
1330: 6d 65 6d 6f 72 79 20 66 6f 72 20 74 68 65 20 77 memory for the w
1340: 61 6c 2d 69 6e 64 65 78 2e 20 4f 74 68 65 72 77 al-index. Otherw
1350: 69 73 65 2c 20 69 66 20 74 68 65 20 61 72 67 75 ise, if the argu
1360: 6d 65 6e 74 20 69 73 20 4e 55 4c 4c 20 6f 72 20 ment is NULL or
1370: 74 68 65 0a 2a 2a 20 57 41 4c 20 6d 6f 64 75 6c the.** WAL modul
1380: 65 20 69 73 20 75 73 69 6e 67 20 73 68 61 72 65 e is using share
1390: 64 2d 6d 65 6d 6f 72 79 2c 20 72 65 74 75 72 6e d-memory, return
13a0: 20 66 61 6c 73 65 2e 20 0a 2a 2f 0a 69 6e 74 20 false. .*/.int
13b0: 73 71 6c 69 74 65 33 57 61 6c 48 65 61 70 4d 65 sqlite3WalHeapMe
13c0: 6d 6f 72 79 28 57 61 6c 20 2a 70 57 61 6c 29 3b mory(Wal *pWal);
13d0: 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c ..int sqlite3Wal
13e0: 43 68 65 63 6b 53 61 6c 74 28 57 61 6c 20 2a 70 CheckSalt(Wal *p
13f0: 57 61 6c 2c 20 73 71 6c 69 74 65 33 5f 66 69 6c Wal, sqlite3_fil
1400: 65 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 e*);..int sqlite
1410: 33 57 61 6c 43 68 65 63 6b 70 6f 69 6e 74 53 74 3WalCheckpointSt
1420: 61 72 74 28 73 71 6c 69 74 65 33 20 2a 2c 0a 20 art(sqlite3 *,.
1430: 20 57 61 6c 20 2a 70 57 61 6c 2c 20 20 20 20 20 Wal *pWal,
1440: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
1450: 20 2f 2a 20 57 61 6c 20 63 6f 6e 6e 65 63 74 69 /* Wal connecti
1460: 6f 6e 20 2a 2f 0a 20 20 75 38 20 2a 61 53 74 61 on */. u8 *aSta
1470: 74 65 2c 20 69 6e 74 20 6e 53 74 61 74 65 2c 20 te, int nState,
1480: 20 20 20 20 20 20 20 20 2f 2a 20 43 68 65 63 6b /* Check
1490: 70 6f 69 6e 74 20 73 74 61 74 65 20 74 6f 20 72 point state to r
14a0: 65 73 74 6f 72 65 20 2a 2f 0a 20 20 69 6e 74 20 estore */. int
14b0: 28 2a 78 42 75 73 79 29 28 76 6f 69 64 2a 29 2c (*xBusy)(void*),
14c0: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46 /* F
14d0: 75 6e 63 74 69 6f 6e 20 74 6f 20 63 61 6c 6c 20 unction to call
14e0: 77 68 65 6e 20 62 75 73 79 20 2a 2f 0a 20 20 76 when busy */. v
14f0: 6f 69 64 20 2a 70 42 75 73 79 41 72 67 2c 20 20 oid *pBusyArg,
1500: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f /
1510: 2a 20 43 6f 6e 74 65 78 74 20 61 72 67 75 6d 65 * Context argume
1520: 6e 74 20 66 6f 72 20 78 42 75 73 79 48 61 6e 64 nt for xBusyHand
1530: 6c 65 72 20 2a 2f 0a 20 20 69 6e 74 20 73 79 6e ler */. int syn
1540: 63 5f 66 6c 61 67 73 2c 20 20 20 20 20 20 20 20 c_flags,
1550: 20 20 20 20 20 20 20 20 20 2f 2a 20 46 6c 61 67 /* Flag
1560: 73 20 74 6f 20 73 79 6e 63 20 64 62 20 66 69 6c s to sync db fil
1570: 65 20 77 69 74 68 20 28 6f 72 20 30 29 20 2a 2f e with (or 0) */
1580: 0a 20 20 73 71 6c 69 74 65 33 5f 63 6b 70 74 20 . sqlite3_ckpt
1590: 2a 2a 70 70 43 6b 70 74 20 20 20 20 20 20 20 20 **ppCkpt
15a0: 20 20 20 2f 2a 20 4f 55 54 3a 20 49 6e 63 72 65 /* OUT: Incre
15b0: 6d 65 6e 74 61 6c 20 63 68 65 63 6b 70 6f 69 6e mental checkpoin
15c0: 74 20 6f 62 6a 65 63 74 20 2a 2f 0a 29 3b 0a 0a t object */.);..
15d0: 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 45 4e #ifdef SQLITE_EN
15e0: 41 42 4c 45 5f 5a 49 50 56 46 53 0a 2f 2a 20 49 ABLE_ZIPVFS./* I
15f0: 66 20 74 68 65 20 57 41 4c 20 66 69 6c 65 20 69 f the WAL file i
1600: 73 20 6e 6f 74 20 65 6d 70 74 79 2c 20 72 65 74 s not empty, ret
1610: 75 72 6e 20 74 68 65 20 6e 75 6d 62 65 72 20 6f urn the number o
1620: 66 20 62 79 74 65 73 20 6f 66 20 63 6f 6e 74 65 f bytes of conte
1630: 6e 74 0a 2a 2a 20 73 74 6f 72 65 64 20 69 6e 20 nt.** stored in
1640: 65 61 63 68 20 66 72 61 6d 65 20 28 69 2e 65 2e each frame (i.e.
1650: 20 74 68 65 20 64 62 20 70 61 67 65 2d 73 69 7a the db page-siz
1660: 65 20 77 68 65 6e 20 74 68 65 20 57 41 4c 20 77 e when the WAL w
1670: 61 73 20 63 72 65 61 74 65 64 29 2e 0a 2a 2f 0a as created)..*/.
1680: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 46 72 int sqlite3WalFr
1690: 61 6d 65 73 69 7a 65 28 57 61 6c 20 2a 70 57 61 amesize(Wal *pWa
16a0: 6c 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 65 6e 64 l);.#endif..#end
16b0: 69 66 20 2f 2a 20 69 66 6e 64 65 66 20 53 51 4c if /* ifndef SQL
16c0: 49 54 45 5f 4f 4d 49 54 5f 57 41 4c 20 2a 2f 0a ITE_OMIT_WAL */.
16d0: 23 65 6e 64 69 66 20 2f 2a 20 5f 57 41 4c 5f 48 #endif /* _WAL_H
16e0: 5f 20 2a 2f 0a _ */.