/ Hex Artifact Content
Login
SQLite training in Houston TX on 2019-11-05 (details)
Part of the 2019 Tcl Conference

Artifact b42fc8081cd1765d4d4dd99b33f2db2f71128f4e25ff8c08d1a346f5af62e27a:


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 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 69 6e 74 2c 69 36 34  t char *,int,i64
0850: 2c 69 6e 74 2c 57 61 6c 2a 2a 29 3b 0a 69 6e 74  ,int,Wal**);.int
0860: 20 73 71 6c 69 74 65 33 57 61 6c 43 6c 6f 73 65   sqlite3WalClose
0870: 28 57 61 6c 20 2a 70 57 61 6c 2c 20 73 71 6c 69  (Wal *pWal, sqli
0880: 74 65 33 2a 2c 20 69 6e 74 20 73 79 6e 63 5f 66  te3*, int sync_f
0890: 6c 61 67 73 2c 20 69 6e 74 2c 20 75 38 20 2a 29  lags, int, u8 *)
08a0: 3b 0a 0a 2f 2a 20 53 65 74 20 74 68 65 20 6c 69  ;../* Set the li
08b0: 6d 69 74 69 6e 67 20 73 69 7a 65 20 6f 66 20 61  miting size of a
08c0: 20 57 41 4c 20 66 69 6c 65 2e 20 2a 2f 0a 76 6f   WAL file. */.vo
08d0: 69 64 20 73 71 6c 69 74 65 33 57 61 6c 4c 69 6d  id sqlite3WalLim
08e0: 69 74 28 57 61 6c 2a 2c 20 69 36 34 29 3b 0a 0a  it(Wal*, i64);..
08f0: 2f 2a 20 55 73 65 64 20 62 79 20 72 65 61 64 65  /* Used by reade
0900: 72 73 20 74 6f 20 6f 70 65 6e 20 28 6c 6f 63 6b  rs to open (lock
0910: 29 20 61 6e 64 20 63 6c 6f 73 65 20 28 75 6e 6c  ) and close (unl
0920: 6f 63 6b 29 20 61 20 73 6e 61 70 73 68 6f 74 2e  ock) a snapshot.
0930: 20 20 41 20 0a 2a 2a 20 73 6e 61 70 73 68 6f 74    A .** snapshot
0940: 20 69 73 20 6c 69 6b 65 20 61 20 72 65 61 64 2d   is like a read-
0950: 74 72 61 6e 73 61 63 74 69 6f 6e 2e 20 20 49 74  transaction.  It
0960: 20 69 73 20 74 68 65 20 73 74 61 74 65 20 6f 66   is the state of
0970: 20 74 68 65 20 64 61 74 61 62 61 73 65 0a 2a 2a   the database.**
0980: 20 61 74 20 61 6e 20 69 6e 73 74 61 6e 74 20 69   at an instant i
0990: 6e 20 74 69 6d 65 2e 20 20 73 71 6c 69 74 65 33  n time.  sqlite3
09a0: 57 61 6c 4f 70 65 6e 53 6e 61 70 73 68 6f 74 20  WalOpenSnapshot 
09b0: 67 65 74 73 20 61 20 72 65 61 64 20 6c 6f 63 6b  gets a read lock
09c0: 20 61 6e 64 0a 2a 2a 20 70 72 65 73 65 72 76 65   and.** preserve
09d0: 73 20 74 68 65 20 63 75 72 72 65 6e 74 20 73 74  s the current st
09e0: 61 74 65 20 65 76 65 6e 20 69 66 20 74 68 65 20  ate even if the 
09f0: 6f 74 68 65 72 20 74 68 72 65 61 64 73 20 6f 72  other threads or
0a00: 20 70 72 6f 63 65 73 73 65 73 0a 2a 2a 20 77 72   processes.** wr
0a10: 69 74 65 20 74 6f 20 6f 72 20 63 68 65 63 6b 70  ite to or checkp
0a20: 6f 69 6e 74 20 74 68 65 20 57 41 4c 2e 20 20 73  oint the WAL.  s
0a30: 71 6c 69 74 65 33 57 61 6c 43 6c 6f 73 65 53 6e  qlite3WalCloseSn
0a40: 61 70 73 68 6f 74 28 29 20 63 6c 6f 73 65 73 20  apshot() closes 
0a50: 74 68 65 0a 2a 2a 20 74 72 61 6e 73 61 63 74 69  the.** transacti
0a60: 6f 6e 20 61 6e 64 20 72 65 6c 65 61 73 65 73 20  on and releases 
0a70: 74 68 65 20 6c 6f 63 6b 2e 0a 2a 2f 0a 69 6e 74  the lock..*/.int
0a80: 20 73 71 6c 69 74 65 33 57 61 6c 42 65 67 69 6e   sqlite3WalBegin
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 2c 20 69 6e 74 20 2a  Wal *pWal, int *
0ab0: 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57  );.void sqlite3W
0ac0: 61 6c 45 6e 64 52 65 61 64 54 72 61 6e 73 61 63  alEndReadTransac
0ad0: 74 69 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 29 3b  tion(Wal *pWal);
0ae0: 0a 0a 2f 2a 20 52 65 61 64 20 61 20 70 61 67 65  ../* Read a page
0af0: 20 66 72 6f 6d 20 74 68 65 20 77 72 69 74 65 2d   from the write-
0b00: 61 68 65 61 64 20 6c 6f 67 2c 20 69 66 20 69 74  ahead log, if it
0b10: 20 69 73 20 70 72 65 73 65 6e 74 2e 20 2a 2f 0a   is present. */.
0b20: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 46 69  int sqlite3WalFi
0b30: 6e 64 46 72 61 6d 65 28 57 61 6c 20 2a 2c 20 50  ndFrame(Wal *, P
0b40: 67 6e 6f 2c 20 75 33 32 20 2a 29 3b 0a 69 6e 74  gno, u32 *);.int
0b50: 20 73 71 6c 69 74 65 33 57 61 6c 52 65 61 64 46   sqlite3WalReadF
0b60: 72 61 6d 65 28 57 61 6c 20 2a 2c 20 75 33 32 2c  rame(Wal *, u32,
0b70: 20 69 6e 74 2c 20 75 38 20 2a 29 3b 0a 0a 2f 2a   int, u8 *);../*
0b80: 20 49 66 20 74 68 65 20 57 41 4c 20 69 73 20 6e   If the WAL is n
0b90: 6f 74 20 65 6d 70 74 79 2c 20 72 65 74 75 72 6e  ot empty, return
0ba0: 20 74 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65   the size of the
0bb0: 20 64 61 74 61 62 61 73 65 2e 20 2a 2f 0a 50 67   database. */.Pg
0bc0: 6e 6f 20 73 71 6c 69 74 65 33 57 61 6c 44 62 73  no sqlite3WalDbs
0bd0: 69 7a 65 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a  ize(Wal *pWal);.
0be0: 0a 2f 2a 20 4f 62 74 61 69 6e 20 6f 72 20 72 65  ./* Obtain or re
0bf0: 6c 65 61 73 65 20 74 68 65 20 57 52 49 54 45 52  lease the WRITER
0c00: 20 6c 6f 63 6b 2e 20 2a 2f 0a 69 6e 74 20 73 71   lock. */.int sq
0c10: 6c 69 74 65 33 57 61 6c 42 65 67 69 6e 57 72 69  lite3WalBeginWri
0c20: 74 65 54 72 61 6e 73 61 63 74 69 6f 6e 28 57 61  teTransaction(Wa
0c30: 6c 20 2a 70 57 61 6c 29 3b 0a 69 6e 74 20 73 71  l *pWal);.int sq
0c40: 6c 69 74 65 33 57 61 6c 45 6e 64 57 72 69 74 65  lite3WalEndWrite
0c50: 54 72 61 6e 73 61 63 74 69 6f 6e 28 57 61 6c 20  Transaction(Wal 
0c60: 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20 55 6e 64 6f  *pWal);../* Undo
0c70: 20 61 6e 79 20 66 72 61 6d 65 73 20 77 72 69 74   any frames writ
0c80: 74 65 6e 20 28 62 75 74 20 6e 6f 74 20 63 6f 6d  ten (but not com
0c90: 6d 69 74 74 65 64 29 20 74 6f 20 74 68 65 20 6c  mitted) to the l
0ca0: 6f 67 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  og */.int sqlite
0cb0: 33 57 61 6c 55 6e 64 6f 28 57 61 6c 20 2a 70 57  3WalUndo(Wal *pW
0cc0: 61 6c 2c 20 69 6e 74 20 28 2a 78 55 6e 64 6f 29  al, int (*xUndo)
0cd0: 28 76 6f 69 64 20 2a 2c 20 50 67 6e 6f 29 2c 20  (void *, Pgno), 
0ce0: 76 6f 69 64 20 2a 70 55 6e 64 6f 43 74 78 29 3b  void *pUndoCtx);
0cf0: 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 61 6e 20 69  ../* Return an i
0d00: 6e 74 65 67 65 72 20 74 68 61 74 20 72 65 63 6f  nteger that reco
0d10: 72 64 73 20 74 68 65 20 63 75 72 72 65 6e 74 20  rds the current 
0d20: 28 75 6e 63 6f 6d 6d 69 74 74 65 64 29 20 77 72  (uncommitted) wr
0d30: 69 74 65 0a 2a 2a 20 70 6f 73 69 74 69 6f 6e 20  ite.** position 
0d40: 69 6e 20 74 68 65 20 57 41 4c 20 2a 2f 0a 76 6f  in the WAL */.vo
0d50: 69 64 20 73 71 6c 69 74 65 33 57 61 6c 53 61 76  id sqlite3WalSav
0d60: 65 70 6f 69 6e 74 28 57 61 6c 20 2a 70 57 61 6c  epoint(Wal *pWal
0d70: 2c 20 75 33 32 20 2a 61 57 61 6c 44 61 74 61 29  , u32 *aWalData)
0d80: 3b 0a 0a 2f 2a 20 4d 6f 76 65 20 74 68 65 20 77  ;../* Move the w
0d90: 72 69 74 65 20 70 6f 73 69 74 69 6f 6e 20 6f 66  rite position of
0da0: 20 74 68 65 20 57 41 4c 20 62 61 63 6b 20 74 6f   the WAL back to
0db0: 20 69 46 72 61 6d 65 2e 20 20 43 61 6c 6c 65 64   iFrame.  Called
0dc0: 20 69 6e 0a 2a 2a 20 72 65 73 70 6f 6e 73 65 20   in.** response 
0dd0: 74 6f 20 61 20 52 4f 4c 4c 42 41 43 4b 20 54 4f  to a ROLLBACK TO
0de0: 20 63 6f 6d 6d 61 6e 64 2e 20 2a 2f 0a 69 6e 74   command. */.int
0df0: 20 73 71 6c 69 74 65 33 57 61 6c 53 61 76 65 70   sqlite3WalSavep
0e00: 6f 69 6e 74 55 6e 64 6f 28 57 61 6c 20 2a 70 57  ointUndo(Wal *pW
0e10: 61 6c 2c 20 75 33 32 20 2a 61 57 61 6c 44 61 74  al, u32 *aWalDat
0e20: 61 29 3b 0a 0a 2f 2a 20 57 72 69 74 65 20 61 20  a);../* Write a 
0e30: 66 72 61 6d 65 20 6f 72 20 66 72 61 6d 65 73 20  frame or frames 
0e40: 74 6f 20 74 68 65 20 6c 6f 67 2e 20 2a 2f 0a 69  to the log. */.i
0e50: 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 46 72 61  nt sqlite3WalFra
0e60: 6d 65 73 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69  mes(Wal *pWal, i
0e70: 6e 74 2c 20 50 67 48 64 72 20 2a 2c 20 50 67 6e  nt, PgHdr *, Pgn
0e80: 6f 2c 20 69 6e 74 2c 20 69 6e 74 29 3b 0a 0a 2f  o, int, int);../
0e90: 2a 20 43 6f 70 79 20 70 61 67 65 73 20 66 72 6f  * Copy pages fro
0ea0: 6d 20 74 68 65 20 6c 6f 67 20 74 6f 20 74 68 65  m the log to the
0eb0: 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 2a   database file *
0ec0: 2f 20 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  / .int sqlite3Wa
0ed0: 6c 43 68 65 63 6b 70 6f 69 6e 74 28 0a 20 20 57  lCheckpoint(.  W
0ee0: 61 6c 20 2a 70 57 61 6c 2c 20 20 20 20 20 20 20  al *pWal,       
0ef0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
0f00: 2a 20 57 72 69 74 65 2d 61 68 65 61 64 20 6c 6f  * Write-ahead lo
0f10: 67 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 2a 2f 0a  g connection */.
0f20: 20 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 20 20    sqlite3 *db,  
0f30: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0f40: 20 20 2f 2a 20 43 68 65 63 6b 20 74 68 69 73 20    /* Check this 
0f50: 68 61 6e 64 6c 65 27 73 20 69 6e 74 65 72 72 75  handle's interru
0f60: 70 74 20 66 6c 61 67 20 2a 2f 0a 20 20 69 6e 74  pt flag */.  int
0f70: 20 65 4d 6f 64 65 2c 20 20 20 20 20 20 20 20 20   eMode,         
0f80: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
0f90: 4f 6e 65 20 6f 66 20 50 41 53 53 49 56 45 2c 20  One of PASSIVE, 
0fa0: 46 55 4c 4c 20 61 6e 64 20 52 45 53 54 41 52 54  FULL and RESTART
0fb0: 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 42 75 73   */.  int (*xBus
0fc0: 79 29 28 76 6f 69 64 2a 29 2c 20 20 20 20 20 20  y)(void*),      
0fd0: 20 20 20 20 20 20 2f 2a 20 46 75 6e 63 74 69 6f        /* Functio
0fe0: 6e 20 74 6f 20 63 61 6c 6c 20 77 68 65 6e 20 62  n to call when b
0ff0: 75 73 79 20 2a 2f 0a 20 20 76 6f 69 64 20 2a 70  usy */.  void *p
1000: 42 75 73 79 41 72 67 2c 20 20 20 20 20 20 20 20  BusyArg,        
1010: 20 20 20 20 20 20 20 20 20 2f 2a 20 43 6f 6e 74           /* Cont
1020: 65 78 74 20 61 72 67 75 6d 65 6e 74 20 66 6f 72  ext argument for
1030: 20 78 42 75 73 79 48 61 6e 64 6c 65 72 20 2a 2f   xBusyHandler */
1040: 0a 20 20 69 6e 74 20 73 79 6e 63 5f 66 6c 61 67  .  int sync_flag
1050: 73 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  s,              
1060: 20 20 20 2f 2a 20 46 6c 61 67 73 20 74 6f 20 73     /* Flags to s
1070: 79 6e 63 20 64 62 20 66 69 6c 65 20 77 69 74 68  ync db file with
1080: 20 28 6f 72 20 30 29 20 2a 2f 0a 20 20 69 6e 74   (or 0) */.  int
1090: 20 6e 42 75 66 2c 20 20 20 20 20 20 20 20 20 20   nBuf,          
10a0: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
10b0: 53 69 7a 65 20 6f 66 20 62 75 66 66 65 72 20 6e  Size of buffer n
10c0: 42 75 66 20 2a 2f 0a 20 20 75 38 20 2a 7a 42 75  Buf */.  u8 *zBu
10d0: 66 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  f,              
10e0: 20 20 20 20 20 20 20 20 20 2f 2a 20 54 65 6d 70           /* Temp
10f0: 6f 72 61 72 79 20 62 75 66 66 65 72 20 74 6f 20  orary buffer to 
1100: 75 73 65 20 2a 2f 0a 20 20 69 6e 74 20 2a 70 6e  use */.  int *pn
1110: 4c 6f 67 2c 20 20 20 20 20 20 20 20 20 20 20 20  Log,            
1120: 20 20 20 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a           /* OUT:
1130: 20 4e 75 6d 62 65 72 20 6f 66 20 66 72 61 6d 65   Number of frame
1140: 73 20 69 6e 20 57 41 4c 20 2a 2f 0a 20 20 69 6e  s in WAL */.  in
1150: 74 20 2a 70 6e 43 6b 70 74 20 20 20 20 20 20 20  t *pnCkpt       
1160: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a                /*
1170: 20 4f 55 54 3a 20 4e 75 6d 62 65 72 20 6f 66 20   OUT: Number of 
1180: 62 61 63 6b 66 69 6c 6c 65 64 20 66 72 61 6d 65  backfilled frame
1190: 73 20 69 6e 20 57 41 4c 20 2a 2f 0a 29 3b 0a 0a  s in WAL */.);..
11a0: 2f 2a 20 52 65 74 75 72 6e 20 74 68 65 20 76 61  /* Return the va
11b0: 6c 75 65 20 74 6f 20 70 61 73 73 20 74 6f 20 61  lue to pass to a
11c0: 20 73 71 6c 69 74 65 33 5f 77 61 6c 5f 68 6f 6f   sqlite3_wal_hoo
11d0: 6b 20 63 61 6c 6c 62 61 63 6b 2c 20 74 68 65 0a  k callback, the.
11e0: 2a 2a 20 6e 75 6d 62 65 72 20 6f 66 20 66 72 61  ** number of fra
11f0: 6d 65 73 20 69 6e 20 74 68 65 20 57 41 4c 20 61  mes in the WAL a
1200: 74 20 74 68 65 20 70 6f 69 6e 74 20 6f 66 20 74  t the point of t
1210: 68 65 20 6c 61 73 74 20 63 6f 6d 6d 69 74 20 73  he last commit s
1220: 69 6e 63 65 0a 2a 2a 20 73 71 6c 69 74 65 33 57  ince.** sqlite3W
1230: 61 6c 43 61 6c 6c 62 61 63 6b 28 29 20 77 61 73  alCallback() was
1240: 20 63 61 6c 6c 65 64 2e 20 20 49 66 20 6e 6f 20   called.  If no 
1250: 63 6f 6d 6d 69 74 73 20 68 61 76 65 20 6f 63 63  commits have occ
1260: 75 72 72 65 64 20 73 69 6e 63 65 0a 2a 2a 20 74  urred since.** t
1270: 68 65 20 6c 61 73 74 20 63 61 6c 6c 2c 20 74 68  he last call, th
1280: 65 6e 20 72 65 74 75 72 6e 20 30 2e 0a 2a 2f 0a  en return 0..*/.
1290: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 43 61  int sqlite3WalCa
12a0: 6c 6c 62 61 63 6b 28 57 61 6c 20 2a 70 57 61 6c  llback(Wal *pWal
12b0: 29 3b 0a 0a 2f 2a 20 54 65 6c 6c 20 74 68 65 20  );../* Tell the 
12c0: 77 61 6c 20 6c 61 79 65 72 20 74 68 61 74 20 61  wal layer that a
12d0: 6e 20 45 58 43 4c 55 53 49 56 45 20 6c 6f 63 6b  n EXCLUSIVE lock
12e0: 20 68 61 73 20 62 65 65 6e 20 6f 62 74 61 69 6e   has been obtain
12f0: 65 64 20 28 6f 72 20 72 65 6c 65 61 73 65 64 29  ed (or released)
1300: 0a 2a 2a 20 62 79 20 74 68 65 20 70 61 67 65 72  .** by the pager
1310: 20 6c 61 79 65 72 20 6f 6e 20 74 68 65 20 64 61   layer on the da
1320: 74 61 62 61 73 65 20 66 69 6c 65 2e 0a 2a 2f 0a  tabase file..*/.
1330: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 45 78  int sqlite3WalEx
1340: 63 6c 75 73 69 76 65 4d 6f 64 65 28 57 61 6c 20  clusiveMode(Wal 
1350: 2a 70 57 61 6c 2c 20 69 6e 74 20 6f 70 29 3b 0a  *pWal, int op);.
1360: 0a 2f 2a 20 52 65 74 75 72 6e 20 74 72 75 65 20  ./* Return true 
1370: 69 66 20 74 68 65 20 61 72 67 75 6d 65 6e 74 20  if the argument 
1380: 69 73 20 6e 6f 6e 2d 4e 55 4c 4c 20 61 6e 64 20  is non-NULL and 
1390: 74 68 65 20 57 41 4c 20 6d 6f 64 75 6c 65 20 69  the WAL module i
13a0: 73 20 75 73 69 6e 67 0a 2a 2a 20 68 65 61 70 2d  s using.** heap-
13b0: 6d 65 6d 6f 72 79 20 66 6f 72 20 74 68 65 20 77  memory for the w
13c0: 61 6c 2d 69 6e 64 65 78 2e 20 4f 74 68 65 72 77  al-index. Otherw
13d0: 69 73 65 2c 20 69 66 20 74 68 65 20 61 72 67 75  ise, if the argu
13e0: 6d 65 6e 74 20 69 73 20 4e 55 4c 4c 20 6f 72 20  ment is NULL or 
13f0: 74 68 65 0a 2a 2a 20 57 41 4c 20 6d 6f 64 75 6c  the.** WAL modul
1400: 65 20 69 73 20 75 73 69 6e 67 20 73 68 61 72 65  e is using share
1410: 64 2d 6d 65 6d 6f 72 79 2c 20 72 65 74 75 72 6e  d-memory, return
1420: 20 66 61 6c 73 65 2e 20 0a 2a 2f 0a 69 6e 74 20   false. .*/.int 
1430: 73 71 6c 69 74 65 33 57 61 6c 48 65 61 70 4d 65  sqlite3WalHeapMe
1440: 6d 6f 72 79 28 57 61 6c 20 2a 70 57 61 6c 29 3b  mory(Wal *pWal);
1450: 0a 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f  ..#ifdef SQLITE_
1460: 45 4e 41 42 4c 45 5f 53 4e 41 50 53 48 4f 54 0a  ENABLE_SNAPSHOT.
1470: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 53 6e  int sqlite3WalSn
1480: 61 70 73 68 6f 74 47 65 74 28 57 61 6c 20 2a 70  apshotGet(Wal *p
1490: 57 61 6c 2c 20 73 71 6c 69 74 65 33 5f 73 6e 61  Wal, sqlite3_sna
14a0: 70 73 68 6f 74 20 2a 2a 70 70 53 6e 61 70 73 68  pshot **ppSnapsh
14b0: 6f 74 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65  ot);.void sqlite
14c0: 33 57 61 6c 53 6e 61 70 73 68 6f 74 4f 70 65 6e  3WalSnapshotOpen
14d0: 28 57 61 6c 20 2a 70 57 61 6c 2c 20 73 71 6c 69  (Wal *pWal, sqli
14e0: 74 65 33 5f 73 6e 61 70 73 68 6f 74 20 2a 70 53  te3_snapshot *pS
14f0: 6e 61 70 73 68 6f 74 29 3b 0a 69 6e 74 20 73 71  napshot);.int sq
1500: 6c 69 74 65 33 57 61 6c 53 6e 61 70 73 68 6f 74  lite3WalSnapshot
1510: 52 65 63 6f 76 65 72 28 57 61 6c 20 2a 70 57 61  Recover(Wal *pWa
1520: 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 57  l);.int sqlite3W
1530: 61 6c 53 6e 61 70 73 68 6f 74 43 68 65 63 6b 28  alSnapshotCheck(
1540: 57 61 6c 20 2a 70 57 61 6c 2c 20 73 71 6c 69 74  Wal *pWal, sqlit
1550: 65 33 5f 73 6e 61 70 73 68 6f 74 20 2a 70 53 6e  e3_snapshot *pSn
1560: 61 70 73 68 6f 74 29 3b 0a 76 6f 69 64 20 73 71  apshot);.void sq
1570: 6c 69 74 65 33 57 61 6c 53 6e 61 70 73 68 6f 74  lite3WalSnapshot
1580: 55 6e 6c 6f 63 6b 28 57 61 6c 20 2a 70 57 61 6c  Unlock(Wal *pWal
1590: 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 69 66 6e 64  );.#endif..#ifnd
15a0: 65 66 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 43  ef SQLITE_OMIT_C
15b0: 4f 4e 43 55 52 52 45 4e 54 0a 2f 2a 20 54 65 6c  ONCURRENT./* Tel
15c0: 6c 20 74 68 65 20 77 61 6c 20 6c 61 79 65 72 20  l the wal layer 
15d0: 74 68 61 74 20 77 65 20 77 61 6e 74 20 74 6f 20  that we want to 
15e0: 63 6f 6d 6d 69 74 20 61 20 63 6f 6e 63 75 72 72  commit a concurr
15f0: 65 6e 74 20 74 72 61 6e 73 61 63 74 69 6f 6e 20  ent transaction 
1600: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  */.int sqlite3Wa
1610: 6c 4c 6f 63 6b 46 6f 72 43 6f 6d 6d 69 74 28 57  lLockForCommit(W
1620: 61 6c 20 2a 70 57 61 6c 2c 20 50 67 48 64 72 20  al *pWal, PgHdr 
1630: 2a 70 50 67 2c 20 42 69 74 76 65 63 20 2a 70 52  *pPg, Bitvec *pR
1640: 65 61 64 2c 20 50 67 6e 6f 2a 29 3b 0a 0a 2f 2a  ead, Pgno*);../*
1650: 20 55 70 67 72 61 64 65 20 74 68 65 20 73 74 61   Upgrade the sta
1660: 74 65 20 6f 66 20 74 68 65 20 63 6c 69 65 6e 74  te of the client
1670: 20 74 6f 20 74 61 6b 65 20 69 6e 74 6f 20 61 63   to take into ac
1680: 63 6f 75 6e 74 20 63 68 61 6e 67 65 73 20 77 72  count changes wr
1690: 69 74 74 65 6e 0a 2a 2a 20 62 79 20 6f 74 68 65  itten.** by othe
16a0: 72 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 20 2a 2f  r connections */
16b0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 55  .int sqlite3WalU
16c0: 70 67 72 61 64 65 53 6e 61 70 73 68 6f 74 28 57  pgradeSnapshot(W
16d0: 61 6c 20 2a 70 57 61 6c 29 3b 0a 23 65 6e 64 69  al *pWal);.#endi
16e0: 66 20 2f 2a 20 53 51 4c 49 54 45 5f 4f 4d 49 54  f /* SQLITE_OMIT
16f0: 5f 43 4f 4e 43 55 52 52 45 4e 54 20 2a 2f 0a 0a  _CONCURRENT */..
1700: 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 45 4e  #ifdef SQLITE_EN
1710: 41 42 4c 45 5f 5a 49 50 56 46 53 0a 2f 2a 20 49  ABLE_ZIPVFS./* I
1720: 66 20 74 68 65 20 57 41 4c 20 66 69 6c 65 20 69  f the WAL file i
1730: 73 20 6e 6f 74 20 65 6d 70 74 79 2c 20 72 65 74  s not empty, ret
1740: 75 72 6e 20 74 68 65 20 6e 75 6d 62 65 72 20 6f  urn the number o
1750: 66 20 62 79 74 65 73 20 6f 66 20 63 6f 6e 74 65  f bytes of conte
1760: 6e 74 0a 2a 2a 20 73 74 6f 72 65 64 20 69 6e 20  nt.** stored in 
1770: 65 61 63 68 20 66 72 61 6d 65 20 28 69 2e 65 2e  each frame (i.e.
1780: 20 74 68 65 20 64 62 20 70 61 67 65 2d 73 69 7a   the db page-siz
1790: 65 20 77 68 65 6e 20 74 68 65 20 57 41 4c 20 77  e when the WAL w
17a0: 61 73 20 63 72 65 61 74 65 64 29 2e 0a 2a 2f 0a  as created)..*/.
17b0: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 46 72  int sqlite3WalFr
17c0: 61 6d 65 73 69 7a 65 28 57 61 6c 20 2a 70 57 61  amesize(Wal *pWa
17d0: 6c 29 3b 0a 23 65 6e 64 69 66 0a 0a 2f 2a 20 52  l);.#endif../* R
17e0: 65 74 75 72 6e 20 74 68 65 20 73 71 6c 69 74 65  eturn the sqlite
17f0: 33 5f 66 69 6c 65 20 6f 62 6a 65 63 74 20 66 6f  3_file object fo
1800: 72 20 74 68 65 20 57 41 4c 20 66 69 6c 65 20 2a  r the WAL file *
1810: 2f 0a 73 71 6c 69 74 65 33 5f 66 69 6c 65 20 2a  /.sqlite3_file *
1820: 73 71 6c 69 74 65 33 57 61 6c 46 69 6c 65 28 57  sqlite3WalFile(W
1830: 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20 73  al *pWal);../* s
1840: 71 6c 69 74 65 33 5f 77 61 6c 5f 69 6e 66 6f 28  qlite3_wal_info(
1850: 29 20 64 61 74 61 20 2a 2f 0a 69 6e 74 20 73 71  ) data */.int sq
1860: 6c 69 74 65 33 57 61 6c 49 6e 66 6f 28 57 61 6c  lite3WalInfo(Wal
1870: 20 2a 70 57 61 6c 2c 20 75 33 32 20 2a 70 6e 50   *pWal, u32 *pnP
1880: 72 69 6f 72 2c 20 75 33 32 20 2a 70 6e 46 72 61  rior, u32 *pnFra
1890: 6d 65 29 3b 0a 0a 23 65 6e 64 69 66 20 2f 2a 20  me);..#endif /* 
18a0: 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d  ifndef SQLITE_OM
18b0: 49 54 5f 57 41 4c 20 2a 2f 0a 23 65 6e 64 69 66  IT_WAL */.#endif
18c0: 20 2f 2a 20 53 51 4c 49 54 45 5f 57 41 4c 5f 48   /* SQLITE_WAL_H
18d0: 20 2a 2f 0a                                       */.