/ Hex Artifact Content
Login

Artifact 606292549f5a7be50b6227bd685fa76e3a4affad71bb8ac5ce4cb5c79f6a176a:


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 78 2c 79 2c 7a 29  e3WalOpen(x,y,z)
03b0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
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 78 2c 79 2c 7a 29 20 20 20 20 20 20 20  do(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 65 6c             0.#el
0730: 73 65 0a 0a 23 64 65 66 69 6e 65 20 57 41 4c 5f  se..#define WAL_
0740: 53 41 56 45 50 4f 49 4e 54 5f 4e 44 41 54 41 20  SAVEPOINT_NDATA 
0750: 34 0a 0a 2f 2a 20 43 6f 6e 6e 65 63 74 69 6f 6e  4../* Connection
0760: 20 74 6f 20 61 20 77 72 69 74 65 2d 61 68 65 61   to a write-ahea
0770: 64 20 6c 6f 67 20 28 57 41 4c 29 20 66 69 6c 65  d log (WAL) file
0780: 2e 20 0a 2a 2a 20 54 68 65 72 65 20 69 73 20 6f  . .** There is o
0790: 6e 65 20 6f 62 6a 65 63 74 20 6f 66 20 74 68 69  ne object of thi
07a0: 73 20 74 79 70 65 20 66 6f 72 20 65 61 63 68 20  s type for each 
07b0: 70 61 67 65 72 2e 20 0a 2a 2f 0a 74 79 70 65 64  pager. .*/.typed
07c0: 65 66 20 73 74 72 75 63 74 20 57 61 6c 20 57 61  ef struct Wal Wa
07d0: 6c 3b 0a 0a 2f 2a 20 4f 70 65 6e 20 61 6e 64 20  l;../* Open and 
07e0: 63 6c 6f 73 65 20 61 20 63 6f 6e 6e 65 63 74 69  close a connecti
07f0: 6f 6e 20 74 6f 20 61 20 77 72 69 74 65 2d 61 68  on to a write-ah
0800: 65 61 64 20 6c 6f 67 2e 20 2a 2f 0a 69 6e 74 20  ead log. */.int 
0810: 73 71 6c 69 74 65 33 57 61 6c 4f 70 65 6e 28 73  sqlite3WalOpen(s
0820: 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 73 71 6c  qlite3_vfs*, sql
0830: 69 74 65 33 5f 66 69 6c 65 2a 2c 20 63 6f 6e 73  ite3_file*, cons
0840: 74 20 63 68 61 72 20 2a 2c 20 69 6e 74 2c 20 69  t char *, int, i
0850: 36 34 2c 20 57 61 6c 2a 2a 29 3b 0a 69 6e 74 20  64, Wal**);.int 
0860: 73 71 6c 69 74 65 33 57 61 6c 43 6c 6f 73 65 28  sqlite3WalClose(
0870: 57 61 6c 20 2a 70 57 61 6c 2c 20 73 71 6c 69 74  Wal *pWal, sqlit
0880: 65 33 2a 2c 20 69 6e 74 20 73 79 6e 63 5f 66 6c  e3*, int sync_fl
0890: 61 67 73 2c 20 69 6e 74 2c 20 75 38 20 2a 29 3b  ags, int, u8 *);
08a0: 0a 0a 2f 2a 20 53 65 74 20 74 68 65 20 6c 69 6d  ../* Set the lim
08b0: 69 74 69 6e 67 20 73 69 7a 65 20 6f 66 20 61 20  iting size of a 
08c0: 57 41 4c 20 66 69 6c 65 2e 20 2a 2f 0a 76 6f 69  WAL file. */.voi
08d0: 64 20 73 71 6c 69 74 65 33 57 61 6c 4c 69 6d 69  d sqlite3WalLimi
08e0: 74 28 57 61 6c 2a 2c 20 69 36 34 29 3b 0a 0a 2f  t(Wal*, i64);../
08f0: 2a 20 55 73 65 64 20 62 79 20 72 65 61 64 65 72  * Used by reader
0900: 73 20 74 6f 20 6f 70 65 6e 20 28 6c 6f 63 6b 29  s to open (lock)
0910: 20 61 6e 64 20 63 6c 6f 73 65 20 28 75 6e 6c 6f   and close (unlo
0920: 63 6b 29 20 61 20 73 6e 61 70 73 68 6f 74 2e 20  ck) a snapshot. 
0930: 20 41 20 0a 2a 2a 20 73 6e 61 70 73 68 6f 74 20   A .** snapshot 
0940: 69 73 20 6c 69 6b 65 20 61 20 72 65 61 64 2d 74  is like a read-t
0950: 72 61 6e 73 61 63 74 69 6f 6e 2e 20 20 49 74 20  ransaction.  It 
0960: 69 73 20 74 68 65 20 73 74 61 74 65 20 6f 66 20  is the state of 
0970: 74 68 65 20 64 61 74 61 62 61 73 65 0a 2a 2a 20  the database.** 
0980: 61 74 20 61 6e 20 69 6e 73 74 61 6e 74 20 69 6e  at an instant in
0990: 20 74 69 6d 65 2e 20 20 73 71 6c 69 74 65 33 57   time.  sqlite3W
09a0: 61 6c 4f 70 65 6e 53 6e 61 70 73 68 6f 74 20 67  alOpenSnapshot g
09b0: 65 74 73 20 61 20 72 65 61 64 20 6c 6f 63 6b 20  ets a read lock 
09c0: 61 6e 64 0a 2a 2a 20 70 72 65 73 65 72 76 65 73  and.** preserves
09d0: 20 74 68 65 20 63 75 72 72 65 6e 74 20 73 74 61   the current sta
09e0: 74 65 20 65 76 65 6e 20 69 66 20 74 68 65 20 6f  te even if the o
09f0: 74 68 65 72 20 74 68 72 65 61 64 73 20 6f 72 20  ther threads or 
0a00: 70 72 6f 63 65 73 73 65 73 0a 2a 2a 20 77 72 69  processes.** wri
0a10: 74 65 20 74 6f 20 6f 72 20 63 68 65 63 6b 70 6f  te to or checkpo
0a20: 69 6e 74 20 74 68 65 20 57 41 4c 2e 20 20 73 71  int the WAL.  sq
0a30: 6c 69 74 65 33 57 61 6c 43 6c 6f 73 65 53 6e 61  lite3WalCloseSna
0a40: 70 73 68 6f 74 28 29 20 63 6c 6f 73 65 73 20 74  pshot() closes t
0a50: 68 65 0a 2a 2a 20 74 72 61 6e 73 61 63 74 69 6f  he.** transactio
0a60: 6e 20 61 6e 64 20 72 65 6c 65 61 73 65 73 20 74  n and releases t
0a70: 68 65 20 6c 6f 63 6b 2e 0a 2a 2f 0a 69 6e 74 20  he lock..*/.int 
0a80: 73 71 6c 69 74 65 33 57 61 6c 42 65 67 69 6e 52  sqlite3WalBeginR
0a90: 65 61 64 54 72 61 6e 73 61 63 74 69 6f 6e 28 57  eadTransaction(W
0aa0: 61 6c 20 2a 70 57 61 6c 2c 20 69 6e 74 20 2a 29  al *pWal, int *)
0ab0: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61  ;.void sqlite3Wa
0ac0: 6c 45 6e 64 52 65 61 64 54 72 61 6e 73 61 63 74  lEndReadTransact
0ad0: 69 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a  ion(Wal *pWal);.
0ae0: 0a 2f 2a 20 52 65 61 64 20 61 20 70 61 67 65 20  ./* Read a page 
0af0: 66 72 6f 6d 20 74 68 65 20 77 72 69 74 65 2d 61  from the write-a
0b00: 68 65 61 64 20 6c 6f 67 2c 20 69 66 20 69 74 20  head log, if it 
0b10: 69 73 20 70 72 65 73 65 6e 74 2e 20 2a 2f 0a 69  is present. */.i
0b20: 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 46 69 6e  nt sqlite3WalFin
0b30: 64 46 72 61 6d 65 28 57 61 6c 20 2a 2c 20 50 67  dFrame(Wal *, Pg
0b40: 6e 6f 2c 20 75 33 32 20 2a 29 3b 0a 69 6e 74 20  no, u32 *);.int 
0b50: 73 71 6c 69 74 65 33 57 61 6c 52 65 61 64 46 72  sqlite3WalReadFr
0b60: 61 6d 65 28 57 61 6c 20 2a 2c 20 75 33 32 2c 20  ame(Wal *, u32, 
0b70: 69 6e 74 2c 20 75 38 20 2a 29 3b 0a 0a 2f 2a 20  int, u8 *);../* 
0b80: 49 66 20 74 68 65 20 57 41 4c 20 69 73 20 6e 6f  If the WAL is no
0b90: 74 20 65 6d 70 74 79 2c 20 72 65 74 75 72 6e 20  t empty, return 
0ba0: 74 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65 20  the size of the 
0bb0: 64 61 74 61 62 61 73 65 2e 20 2a 2f 0a 50 67 6e  database. */.Pgn
0bc0: 6f 20 73 71 6c 69 74 65 33 57 61 6c 44 62 73 69  o sqlite3WalDbsi
0bd0: 7a 65 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a  ze(Wal *pWal);..
0be0: 2f 2a 20 4f 62 74 61 69 6e 20 6f 72 20 72 65 6c  /* Obtain or rel
0bf0: 65 61 73 65 20 74 68 65 20 57 52 49 54 45 52 20  ease the WRITER 
0c00: 6c 6f 63 6b 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c  lock. */.int sql
0c10: 69 74 65 33 57 61 6c 42 65 67 69 6e 57 72 69 74  ite3WalBeginWrit
0c20: 65 54 72 61 6e 73 61 63 74 69 6f 6e 28 57 61 6c  eTransaction(Wal
0c30: 20 2a 70 57 61 6c 29 3b 0a 69 6e 74 20 73 71 6c   *pWal);.int sql
0c40: 69 74 65 33 57 61 6c 45 6e 64 57 72 69 74 65 54  ite3WalEndWriteT
0c50: 72 61 6e 73 61 63 74 69 6f 6e 28 57 61 6c 20 2a  ransaction(Wal *
0c60: 70 57 61 6c 29 3b 0a 0a 2f 2a 20 55 6e 64 6f 20  pWal);../* Undo 
0c70: 61 6e 79 20 66 72 61 6d 65 73 20 77 72 69 74 74  any frames writt
0c80: 65 6e 20 28 62 75 74 20 6e 6f 74 20 63 6f 6d 6d  en (but not comm
0c90: 69 74 74 65 64 29 20 74 6f 20 74 68 65 20 6c 6f  itted) to the lo
0ca0: 67 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  g */.int sqlite3
0cb0: 57 61 6c 55 6e 64 6f 28 57 61 6c 20 2a 70 57 61  WalUndo(Wal *pWa
0cc0: 6c 2c 20 69 6e 74 20 28 2a 78 55 6e 64 6f 29 28  l, int (*xUndo)(
0cd0: 76 6f 69 64 20 2a 2c 20 50 67 6e 6f 29 2c 20 76  void *, Pgno), v
0ce0: 6f 69 64 20 2a 70 55 6e 64 6f 43 74 78 29 3b 0a  oid *pUndoCtx);.
0cf0: 0a 2f 2a 20 52 65 74 75 72 6e 20 61 6e 20 69 6e  ./* Return an in
0d00: 74 65 67 65 72 20 74 68 61 74 20 72 65 63 6f 72  teger that recor
0d10: 64 73 20 74 68 65 20 63 75 72 72 65 6e 74 20 28  ds the current (
0d20: 75 6e 63 6f 6d 6d 69 74 74 65 64 29 20 77 72 69  uncommitted) wri
0d30: 74 65 0a 2a 2a 20 70 6f 73 69 74 69 6f 6e 20 69  te.** position i
0d40: 6e 20 74 68 65 20 57 41 4c 20 2a 2f 0a 76 6f 69  n the WAL */.voi
0d50: 64 20 73 71 6c 69 74 65 33 57 61 6c 53 61 76 65  d sqlite3WalSave
0d60: 70 6f 69 6e 74 28 57 61 6c 20 2a 70 57 61 6c 2c  point(Wal *pWal,
0d70: 20 75 33 32 20 2a 61 57 61 6c 44 61 74 61 29 3b   u32 *aWalData);
0d80: 0a 0a 2f 2a 20 4d 6f 76 65 20 74 68 65 20 77 72  ../* Move the wr
0d90: 69 74 65 20 70 6f 73 69 74 69 6f 6e 20 6f 66 20  ite position of 
0da0: 74 68 65 20 57 41 4c 20 62 61 63 6b 20 74 6f 20  the WAL back to 
0db0: 69 46 72 61 6d 65 2e 20 20 43 61 6c 6c 65 64 20  iFrame.  Called 
0dc0: 69 6e 0a 2a 2a 20 72 65 73 70 6f 6e 73 65 20 74  in.** response t
0dd0: 6f 20 61 20 52 4f 4c 4c 42 41 43 4b 20 54 4f 20  o a ROLLBACK TO 
0de0: 63 6f 6d 6d 61 6e 64 2e 20 2a 2f 0a 69 6e 74 20  command. */.int 
0df0: 73 71 6c 69 74 65 33 57 61 6c 53 61 76 65 70 6f  sqlite3WalSavepo
0e00: 69 6e 74 55 6e 64 6f 28 57 61 6c 20 2a 70 57 61  intUndo(Wal *pWa
0e10: 6c 2c 20 75 33 32 20 2a 61 57 61 6c 44 61 74 61  l, u32 *aWalData
0e20: 29 3b 0a 0a 2f 2a 20 57 72 69 74 65 20 61 20 66  );../* Write a f
0e30: 72 61 6d 65 20 6f 72 20 66 72 61 6d 65 73 20 74  rame or frames t
0e40: 6f 20 74 68 65 20 6c 6f 67 2e 20 2a 2f 0a 69 6e  o the log. */.in
0e50: 74 20 73 71 6c 69 74 65 33 57 61 6c 46 72 61 6d  t sqlite3WalFram
0e60: 65 73 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69 6e  es(Wal *pWal, in
0e70: 74 2c 20 50 67 48 64 72 20 2a 2c 20 50 67 6e 6f  t, PgHdr *, Pgno
0e80: 2c 20 69 6e 74 2c 20 69 6e 74 29 3b 0a 0a 2f 2a  , int, int);../*
0e90: 20 43 6f 70 79 20 70 61 67 65 73 20 66 72 6f 6d   Copy pages from
0ea0: 20 74 68 65 20 6c 6f 67 20 74 6f 20 74 68 65 20   the log to the 
0eb0: 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 2a 2f  database file */
0ec0: 20 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c   .int sqlite3Wal
0ed0: 43 68 65 63 6b 70 6f 69 6e 74 28 0a 20 20 57 61  Checkpoint(.  Wa
0ee0: 6c 20 2a 70 57 61 6c 2c 20 20 20 20 20 20 20 20  l *pWal,        
0ef0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a                /*
0f00: 20 57 72 69 74 65 2d 61 68 65 61 64 20 6c 6f 67   Write-ahead log
0f10: 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 2a 2f 0a 20   connection */. 
0f20: 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 20 20 20   sqlite3 *db,   
0f30: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0f40: 20 2f 2a 20 43 68 65 63 6b 20 74 68 69 73 20 68   /* Check this h
0f50: 61 6e 64 6c 65 27 73 20 69 6e 74 65 72 72 75 70  andle's interrup
0f60: 74 20 66 6c 61 67 20 2a 2f 0a 20 20 69 6e 74 20  t flag */.  int 
0f70: 65 4d 6f 64 65 2c 20 20 20 20 20 20 20 20 20 20  eMode,          
0f80: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4f              /* O
0f90: 6e 65 20 6f 66 20 50 41 53 53 49 56 45 2c 20 46  ne of PASSIVE, F
0fa0: 55 4c 4c 20 61 6e 64 20 52 45 53 54 41 52 54 20  ULL and RESTART 
0fb0: 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 42 75 73 79  */.  int (*xBusy
0fc0: 29 28 76 6f 69 64 2a 29 2c 20 20 20 20 20 20 20  )(void*),       
0fd0: 20 20 20 20 20 2f 2a 20 46 75 6e 63 74 69 6f 6e       /* Function
0fe0: 20 74 6f 20 63 61 6c 6c 20 77 68 65 6e 20 62 75   to call when bu
0ff0: 73 79 20 2a 2f 0a 20 20 76 6f 69 64 20 2a 70 42  sy */.  void *pB
1000: 75 73 79 41 72 67 2c 20 20 20 20 20 20 20 20 20  usyArg,         
1010: 20 20 20 20 20 20 20 20 2f 2a 20 43 6f 6e 74 65          /* Conte
1020: 78 74 20 61 72 67 75 6d 65 6e 74 20 66 6f 72 20  xt argument for 
1030: 78 42 75 73 79 48 61 6e 64 6c 65 72 20 2a 2f 0a  xBusyHandler */.
1040: 20 20 69 6e 74 20 73 79 6e 63 5f 66 6c 61 67 73    int sync_flags
1050: 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ,               
1060: 20 20 2f 2a 20 46 6c 61 67 73 20 74 6f 20 73 79    /* Flags to sy
1070: 6e 63 20 64 62 20 66 69 6c 65 20 77 69 74 68 20  nc db file with 
1080: 28 6f 72 20 30 29 20 2a 2f 0a 20 20 69 6e 74 20  (or 0) */.  int 
1090: 6e 42 75 66 2c 20 20 20 20 20 20 20 20 20 20 20  nBuf,           
10a0: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 53              /* S
10b0: 69 7a 65 20 6f 66 20 62 75 66 66 65 72 20 6e 42  ize of buffer nB
10c0: 75 66 20 2a 2f 0a 20 20 75 38 20 2a 7a 42 75 66  uf */.  u8 *zBuf
10d0: 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ,               
10e0: 20 20 20 20 20 20 20 20 2f 2a 20 54 65 6d 70 6f          /* Tempo
10f0: 72 61 72 79 20 62 75 66 66 65 72 20 74 6f 20 75  rary buffer to u
1100: 73 65 20 2a 2f 0a 20 20 69 6e 74 20 2a 70 6e 4c  se */.  int *pnL
1110: 6f 67 2c 20 20 20 20 20 20 20 20 20 20 20 20 20  og,             
1120: 20 20 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a 20          /* OUT: 
1130: 4e 75 6d 62 65 72 20 6f 66 20 66 72 61 6d 65 73  Number of frames
1140: 20 69 6e 20 57 41 4c 20 2a 2f 0a 20 20 69 6e 74   in WAL */.  int
1150: 20 2a 70 6e 43 6b 70 74 20 20 20 20 20 20 20 20   *pnCkpt        
1160: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
1170: 4f 55 54 3a 20 4e 75 6d 62 65 72 20 6f 66 20 62  OUT: Number of b
1180: 61 63 6b 66 69 6c 6c 65 64 20 66 72 61 6d 65 73  ackfilled frames
1190: 20 69 6e 20 57 41 4c 20 2a 2f 0a 29 3b 0a 0a 2f   in WAL */.);../
11a0: 2a 20 52 65 74 75 72 6e 20 74 68 65 20 76 61 6c  * Return the val
11b0: 75 65 20 74 6f 20 70 61 73 73 20 74 6f 20 61 20  ue to pass to a 
11c0: 73 71 6c 69 74 65 33 5f 77 61 6c 5f 68 6f 6f 6b  sqlite3_wal_hook
11d0: 20 63 61 6c 6c 62 61 63 6b 2c 20 74 68 65 0a 2a   callback, the.*
11e0: 2a 20 6e 75 6d 62 65 72 20 6f 66 20 66 72 61 6d  * number of fram
11f0: 65 73 20 69 6e 20 74 68 65 20 57 41 4c 20 61 74  es in the WAL at
1200: 20 74 68 65 20 70 6f 69 6e 74 20 6f 66 20 74 68   the point of th
1210: 65 20 6c 61 73 74 20 63 6f 6d 6d 69 74 20 73 69  e last commit si
1220: 6e 63 65 0a 2a 2a 20 73 71 6c 69 74 65 33 57 61  nce.** sqlite3Wa
1230: 6c 43 61 6c 6c 62 61 63 6b 28 29 20 77 61 73 20  lCallback() was 
1240: 63 61 6c 6c 65 64 2e 20 20 49 66 20 6e 6f 20 63  called.  If no c
1250: 6f 6d 6d 69 74 73 20 68 61 76 65 20 6f 63 63 75  ommits have occu
1260: 72 72 65 64 20 73 69 6e 63 65 0a 2a 2a 20 74 68  rred since.** th
1270: 65 20 6c 61 73 74 20 63 61 6c 6c 2c 20 74 68 65  e last call, the
1280: 6e 20 72 65 74 75 72 6e 20 30 2e 0a 2a 2f 0a 69  n return 0..*/.i
1290: 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 43 61 6c  nt sqlite3WalCal
12a0: 6c 62 61 63 6b 28 57 61 6c 20 2a 70 57 61 6c 29  lback(Wal *pWal)
12b0: 3b 0a 0a 2f 2a 20 54 65 6c 6c 20 74 68 65 20 77  ;../* Tell the w
12c0: 61 6c 20 6c 61 79 65 72 20 74 68 61 74 20 61 6e  al layer that an
12d0: 20 45 58 43 4c 55 53 49 56 45 20 6c 6f 63 6b 20   EXCLUSIVE lock 
12e0: 68 61 73 20 62 65 65 6e 20 6f 62 74 61 69 6e 65  has been obtaine
12f0: 64 20 28 6f 72 20 72 65 6c 65 61 73 65 64 29 0a  d (or released).
1300: 2a 2a 20 62 79 20 74 68 65 20 70 61 67 65 72 20  ** by the pager 
1310: 6c 61 79 65 72 20 6f 6e 20 74 68 65 20 64 61 74  layer on the dat
1320: 61 62 61 73 65 20 66 69 6c 65 2e 0a 2a 2f 0a 69  abase file..*/.i
1330: 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 45 78 63  nt sqlite3WalExc
1340: 6c 75 73 69 76 65 4d 6f 64 65 28 57 61 6c 20 2a  lusiveMode(Wal *
1350: 70 57 61 6c 2c 20 69 6e 74 20 6f 70 29 3b 0a 0a  pWal, int op);..
1360: 2f 2a 20 52 65 74 75 72 6e 20 74 72 75 65 20 69  /* Return true i
1370: 66 20 74 68 65 20 61 72 67 75 6d 65 6e 74 20 69  f the argument i
1380: 73 20 6e 6f 6e 2d 4e 55 4c 4c 20 61 6e 64 20 74  s non-NULL and t
1390: 68 65 20 57 41 4c 20 6d 6f 64 75 6c 65 20 69 73  he WAL module is
13a0: 20 75 73 69 6e 67 0a 2a 2a 20 68 65 61 70 2d 6d   using.** heap-m
13b0: 65 6d 6f 72 79 20 66 6f 72 20 74 68 65 20 77 61  emory for the wa
13c0: 6c 2d 69 6e 64 65 78 2e 20 4f 74 68 65 72 77 69  l-index. Otherwi
13d0: 73 65 2c 20 69 66 20 74 68 65 20 61 72 67 75 6d  se, if the argum
13e0: 65 6e 74 20 69 73 20 4e 55 4c 4c 20 6f 72 20 74  ent is NULL or t
13f0: 68 65 0a 2a 2a 20 57 41 4c 20 6d 6f 64 75 6c 65  he.** WAL module
1400: 20 69 73 20 75 73 69 6e 67 20 73 68 61 72 65 64   is using shared
1410: 2d 6d 65 6d 6f 72 79 2c 20 72 65 74 75 72 6e 20  -memory, return 
1420: 66 61 6c 73 65 2e 20 0a 2a 2f 0a 69 6e 74 20 73  false. .*/.int s
1430: 71 6c 69 74 65 33 57 61 6c 48 65 61 70 4d 65 6d  qlite3WalHeapMem
1440: 6f 72 79 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a  ory(Wal *pWal);.
1450: 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 45  .#ifdef SQLITE_E
1460: 4e 41 42 4c 45 5f 53 4e 41 50 53 48 4f 54 0a 69  NABLE_SNAPSHOT.i
1470: 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 53 6e 61  nt sqlite3WalSna
1480: 70 73 68 6f 74 47 65 74 28 57 61 6c 20 2a 70 57  pshotGet(Wal *pW
1490: 61 6c 2c 20 73 71 6c 69 74 65 33 5f 73 6e 61 70  al, sqlite3_snap
14a0: 73 68 6f 74 20 2a 2a 70 70 53 6e 61 70 73 68 6f  shot **ppSnapsho
14b0: 74 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  t);.void sqlite3
14c0: 57 61 6c 53 6e 61 70 73 68 6f 74 4f 70 65 6e 28  WalSnapshotOpen(
14d0: 57 61 6c 20 2a 70 57 61 6c 2c 20 73 71 6c 69 74  Wal *pWal, sqlit
14e0: 65 33 5f 73 6e 61 70 73 68 6f 74 20 2a 70 53 6e  e3_snapshot *pSn
14f0: 61 70 73 68 6f 74 29 3b 0a 69 6e 74 20 73 71 6c  apshot);.int sql
1500: 69 74 65 33 57 61 6c 53 6e 61 70 73 68 6f 74 52  ite3WalSnapshotR
1510: 65 63 6f 76 65 72 28 57 61 6c 20 2a 70 57 61 6c  ecover(Wal *pWal
1520: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  );.int sqlite3Wa
1530: 6c 53 6e 61 70 73 68 6f 74 43 68 65 63 6b 28 57  lSnapshotCheck(W
1540: 61 6c 20 2a 70 57 61 6c 2c 20 73 71 6c 69 74 65  al *pWal, sqlite
1550: 33 5f 73 6e 61 70 73 68 6f 74 20 2a 70 53 6e 61  3_snapshot *pSna
1560: 70 73 68 6f 74 29 3b 0a 76 6f 69 64 20 73 71 6c  pshot);.void sql
1570: 69 74 65 33 57 61 6c 53 6e 61 70 73 68 6f 74 55  ite3WalSnapshotU
1580: 6e 6c 6f 63 6b 28 57 61 6c 20 2a 70 57 61 6c 29  nlock(Wal *pWal)
1590: 3b 0a 23 65 6e 64 69 66 0a 0a 23 69 66 64 65 66  ;.#endif..#ifdef
15a0: 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 5a   SQLITE_ENABLE_Z
15b0: 49 50 56 46 53 0a 2f 2a 20 49 66 20 74 68 65 20  IPVFS./* If the 
15c0: 57 41 4c 20 66 69 6c 65 20 69 73 20 6e 6f 74 20  WAL file is not 
15d0: 65 6d 70 74 79 2c 20 72 65 74 75 72 6e 20 74 68  empty, return th
15e0: 65 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65  e number of byte
15f0: 73 20 6f 66 20 63 6f 6e 74 65 6e 74 0a 2a 2a 20  s of content.** 
1600: 73 74 6f 72 65 64 20 69 6e 20 65 61 63 68 20 66  stored in each f
1610: 72 61 6d 65 20 28 69 2e 65 2e 20 74 68 65 20 64  rame (i.e. the d
1620: 62 20 70 61 67 65 2d 73 69 7a 65 20 77 68 65 6e  b page-size when
1630: 20 74 68 65 20 57 41 4c 20 77 61 73 20 63 72 65   the WAL was cre
1640: 61 74 65 64 29 2e 0a 2a 2f 0a 69 6e 74 20 73 71  ated)..*/.int sq
1650: 6c 69 74 65 33 57 61 6c 46 72 61 6d 65 73 69 7a  lite3WalFramesiz
1660: 65 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 23 65  e(Wal *pWal);.#e
1670: 6e 64 69 66 0a 0a 2f 2a 20 52 65 74 75 72 6e 20  ndif../* Return 
1680: 74 68 65 20 73 71 6c 69 74 65 33 5f 66 69 6c 65  the sqlite3_file
1690: 20 6f 62 6a 65 63 74 20 66 6f 72 20 74 68 65 20   object for the 
16a0: 57 41 4c 20 66 69 6c 65 20 2a 2f 0a 73 71 6c 69  WAL file */.sqli
16b0: 74 65 33 5f 66 69 6c 65 20 2a 73 71 6c 69 74 65  te3_file *sqlite
16c0: 33 57 61 6c 46 69 6c 65 28 57 61 6c 20 2a 70 57  3WalFile(Wal *pW
16d0: 61 6c 29 3b 0a 0a 23 65 6e 64 69 66 20 2f 2a 20  al);..#endif /* 
16e0: 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d  ifndef SQLITE_OM
16f0: 49 54 5f 57 41 4c 20 2a 2f 0a 23 65 6e 64 69 66  IT_WAL */.#endif
1700: 20 2f 2a 20 53 51 4c 49 54 45 5f 57 41 4c 5f 48   /* SQLITE_WAL_H
1710: 20 2a 2f 0a                                       */.