/ Hex Artifact Content
Login

Artifact ac2100eeda406a4492b8c183154507532d23ab9d5a8e32e208adfe4f9ea554f9:


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 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 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 2c 20 69  oid *pUndoCtx, i
0cf0: 6e 74 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20  nt);../* Return 
0d00: 61 6e 20 69 6e 74 65 67 65 72 20 74 68 61 74 20  an integer that 
0d10: 72 65 63 6f 72 64 73 20 74 68 65 20 63 75 72 72  records the curr
0d20: 65 6e 74 20 28 75 6e 63 6f 6d 6d 69 74 74 65 64  ent (uncommitted
0d30: 29 20 77 72 69 74 65 0a 2a 2a 20 70 6f 73 69 74  ) write.** posit
0d40: 69 6f 6e 20 69 6e 20 74 68 65 20 57 41 4c 20 2a  ion in the WAL *
0d50: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61  /.void sqlite3Wa
0d60: 6c 53 61 76 65 70 6f 69 6e 74 28 57 61 6c 20 2a  lSavepoint(Wal *
0d70: 70 57 61 6c 2c 20 75 33 32 20 2a 61 57 61 6c 44  pWal, u32 *aWalD
0d80: 61 74 61 29 3b 0a 0a 2f 2a 20 4d 6f 76 65 20 74  ata);../* Move t
0d90: 68 65 20 77 72 69 74 65 20 70 6f 73 69 74 69 6f  he write positio
0da0: 6e 20 6f 66 20 74 68 65 20 57 41 4c 20 62 61 63  n of the WAL bac
0db0: 6b 20 74 6f 20 69 46 72 61 6d 65 2e 20 20 43 61  k to iFrame.  Ca
0dc0: 6c 6c 65 64 20 69 6e 0a 2a 2a 20 72 65 73 70 6f  lled in.** respo
0dd0: 6e 73 65 20 74 6f 20 61 20 52 4f 4c 4c 42 41 43  nse to a ROLLBAC
0de0: 4b 20 54 4f 20 63 6f 6d 6d 61 6e 64 2e 20 2a 2f  K TO command. */
0df0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 53  .int sqlite3WalS
0e00: 61 76 65 70 6f 69 6e 74 55 6e 64 6f 28 57 61 6c  avepointUndo(Wal
0e10: 20 2a 70 57 61 6c 2c 20 75 33 32 20 2a 61 57 61   *pWal, u32 *aWa
0e20: 6c 44 61 74 61 29 3b 0a 0a 2f 2a 20 57 72 69 74  lData);../* Writ
0e30: 65 20 61 20 66 72 61 6d 65 20 6f 72 20 66 72 61  e a frame or fra
0e40: 6d 65 73 20 74 6f 20 74 68 65 20 6c 6f 67 2e 20  mes to the log. 
0e50: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  */.int sqlite3Wa
0e60: 6c 46 72 61 6d 65 73 28 57 61 6c 20 2a 70 57 61  lFrames(Wal *pWa
0e70: 6c 2c 20 69 6e 74 2c 20 50 67 48 64 72 20 2a 2c  l, int, PgHdr *,
0e80: 20 50 67 6e 6f 2c 20 69 6e 74 2c 20 69 6e 74 29   Pgno, int, int)
0e90: 3b 0a 0a 2f 2a 20 43 6f 70 79 20 70 61 67 65 73  ;../* Copy pages
0ea0: 20 66 72 6f 6d 20 74 68 65 20 6c 6f 67 20 74 6f   from the log to
0eb0: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69   the database fi
0ec0: 6c 65 20 2a 2f 20 0a 69 6e 74 20 73 71 6c 69 74  le */ .int sqlit
0ed0: 65 33 57 61 6c 43 68 65 63 6b 70 6f 69 6e 74 28  e3WalCheckpoint(
0ee0: 0a 20 20 57 61 6c 20 2a 70 57 61 6c 2c 20 20 20  .  Wal *pWal,   
0ef0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0f00: 20 20 20 2f 2a 20 57 72 69 74 65 2d 61 68 65 61     /* Write-ahea
0f10: 64 20 6c 6f 67 20 63 6f 6e 6e 65 63 74 69 6f 6e  d log connection
0f20: 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 20 2a 64   */.  sqlite3 *d
0f30: 62 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  b,              
0f40: 20 20 20 20 20 20 2f 2a 20 43 68 65 63 6b 20 74        /* Check t
0f50: 68 69 73 20 68 61 6e 64 6c 65 27 73 20 69 6e 74  his handle's int
0f60: 65 72 72 75 70 74 20 66 6c 61 67 20 2a 2f 0a 20  errupt flag */. 
0f70: 20 69 6e 74 20 65 4d 6f 64 65 2c 20 20 20 20 20   int eMode,     
0f80: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0f90: 20 2f 2a 20 4f 6e 65 20 6f 66 20 50 41 53 53 49   /* One of PASSI
0fa0: 56 45 2c 20 46 55 4c 4c 20 61 6e 64 20 52 45 53  VE, FULL and RES
0fb0: 54 41 52 54 20 2a 2f 0a 20 20 69 6e 74 20 28 2a  TART */.  int (*
0fc0: 78 42 75 73 79 29 28 76 6f 69 64 2a 29 2c 20 20  xBusy)(void*),  
0fd0: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46 75 6e            /* Fun
0fe0: 63 74 69 6f 6e 20 74 6f 20 63 61 6c 6c 20 77 68  ction to call wh
0ff0: 65 6e 20 62 75 73 79 20 2a 2f 0a 20 20 76 6f 69  en busy */.  voi
1000: 64 20 2a 70 42 75 73 79 41 72 67 2c 20 20 20 20  d *pBusyArg,    
1010: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
1020: 43 6f 6e 74 65 78 74 20 61 72 67 75 6d 65 6e 74  Context argument
1030: 20 66 6f 72 20 78 42 75 73 79 48 61 6e 64 6c 65   for xBusyHandle
1040: 72 20 2a 2f 0a 20 20 69 6e 74 20 73 79 6e 63 5f  r */.  int sync_
1050: 66 6c 61 67 73 2c 20 20 20 20 20 20 20 20 20 20  flags,          
1060: 20 20 20 20 20 20 20 2f 2a 20 46 6c 61 67 73 20         /* Flags 
1070: 74 6f 20 73 79 6e 63 20 64 62 20 66 69 6c 65 20  to sync db file 
1080: 77 69 74 68 20 28 6f 72 20 30 29 20 2a 2f 0a 20  with (or 0) */. 
1090: 20 69 6e 74 20 6e 42 75 66 2c 20 20 20 20 20 20   int nBuf,      
10a0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
10b0: 20 2f 2a 20 53 69 7a 65 20 6f 66 20 62 75 66 66   /* Size of buff
10c0: 65 72 20 6e 42 75 66 20 2a 2f 0a 20 20 75 38 20  er nBuf */.  u8 
10d0: 2a 7a 42 75 66 2c 20 20 20 20 20 20 20 20 20 20  *zBuf,          
10e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
10f0: 54 65 6d 70 6f 72 61 72 79 20 62 75 66 66 65 72  Temporary buffer
1100: 20 74 6f 20 75 73 65 20 2a 2f 0a 20 20 69 6e 74   to use */.  int
1110: 20 2a 70 6e 4c 6f 67 2c 20 20 20 20 20 20 20 20   *pnLog,        
1120: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
1130: 4f 55 54 3a 20 4e 75 6d 62 65 72 20 6f 66 20 66  OUT: Number of f
1140: 72 61 6d 65 73 20 69 6e 20 57 41 4c 20 2a 2f 0a  rames in WAL */.
1150: 20 20 69 6e 74 20 2a 70 6e 43 6b 70 74 20 20 20    int *pnCkpt   
1160: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1170: 20 20 2f 2a 20 4f 55 54 3a 20 4e 75 6d 62 65 72    /* OUT: Number
1180: 20 6f 66 20 62 61 63 6b 66 69 6c 6c 65 64 20 66   of backfilled f
1190: 72 61 6d 65 73 20 69 6e 20 57 41 4c 20 2a 2f 0a  rames in WAL */.
11a0: 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74 68  );../* Return th
11b0: 65 20 76 61 6c 75 65 20 74 6f 20 70 61 73 73 20  e value to pass 
11c0: 74 6f 20 61 20 73 71 6c 69 74 65 33 5f 77 61 6c  to a sqlite3_wal
11d0: 5f 68 6f 6f 6b 20 63 61 6c 6c 62 61 63 6b 2c 20  _hook callback, 
11e0: 74 68 65 0a 2a 2a 20 6e 75 6d 62 65 72 20 6f 66  the.** number of
11f0: 20 66 72 61 6d 65 73 20 69 6e 20 74 68 65 20 57   frames in the W
1200: 41 4c 20 61 74 20 74 68 65 20 70 6f 69 6e 74 20  AL at the point 
1210: 6f 66 20 74 68 65 20 6c 61 73 74 20 63 6f 6d 6d  of the last comm
1220: 69 74 20 73 69 6e 63 65 0a 2a 2a 20 73 71 6c 69  it since.** sqli
1230: 74 65 33 57 61 6c 43 61 6c 6c 62 61 63 6b 28 29  te3WalCallback()
1240: 20 77 61 73 20 63 61 6c 6c 65 64 2e 20 20 49 66   was called.  If
1250: 20 6e 6f 20 63 6f 6d 6d 69 74 73 20 68 61 76 65   no commits have
1260: 20 6f 63 63 75 72 72 65 64 20 73 69 6e 63 65 0a   occurred since.
1270: 2a 2a 20 74 68 65 20 6c 61 73 74 20 63 61 6c 6c  ** the last call
1280: 2c 20 74 68 65 6e 20 72 65 74 75 72 6e 20 30 2e  , then return 0.
1290: 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57  .*/.int sqlite3W
12a0: 61 6c 43 61 6c 6c 62 61 63 6b 28 57 61 6c 20 2a  alCallback(Wal *
12b0: 70 57 61 6c 29 3b 0a 0a 2f 2a 20 54 65 6c 6c 20  pWal);../* Tell 
12c0: 74 68 65 20 77 61 6c 20 6c 61 79 65 72 20 74 68  the wal layer th
12d0: 61 74 20 61 6e 20 45 58 43 4c 55 53 49 56 45 20  at an EXCLUSIVE 
12e0: 6c 6f 63 6b 20 68 61 73 20 62 65 65 6e 20 6f 62  lock has been ob
12f0: 74 61 69 6e 65 64 20 28 6f 72 20 72 65 6c 65 61  tained (or relea
1300: 73 65 64 29 0a 2a 2a 20 62 79 20 74 68 65 20 70  sed).** by the p
1310: 61 67 65 72 20 6c 61 79 65 72 20 6f 6e 20 74 68  ager layer on th
1320: 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 2e  e database file.
1330: 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57  .*/.int sqlite3W
1340: 61 6c 45 78 63 6c 75 73 69 76 65 4d 6f 64 65 28  alExclusiveMode(
1350: 57 61 6c 20 2a 70 57 61 6c 2c 20 69 6e 74 20 6f  Wal *pWal, int o
1360: 70 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74  p);../* Return t
1370: 72 75 65 20 69 66 20 74 68 65 20 61 72 67 75 6d  rue if the argum
1380: 65 6e 74 20 69 73 20 6e 6f 6e 2d 4e 55 4c 4c 20  ent is non-NULL 
1390: 61 6e 64 20 74 68 65 20 57 41 4c 20 6d 6f 64 75  and the WAL modu
13a0: 6c 65 20 69 73 20 75 73 69 6e 67 0a 2a 2a 20 68  le is using.** h
13b0: 65 61 70 2d 6d 65 6d 6f 72 79 20 66 6f 72 20 74  eap-memory for t
13c0: 68 65 20 77 61 6c 2d 69 6e 64 65 78 2e 20 4f 74  he wal-index. Ot
13d0: 68 65 72 77 69 73 65 2c 20 69 66 20 74 68 65 20  herwise, if the 
13e0: 61 72 67 75 6d 65 6e 74 20 69 73 20 4e 55 4c 4c  argument is NULL
13f0: 20 6f 72 20 74 68 65 0a 2a 2a 20 57 41 4c 20 6d   or the.** WAL m
1400: 6f 64 75 6c 65 20 69 73 20 75 73 69 6e 67 20 73  odule is using s
1410: 68 61 72 65 64 2d 6d 65 6d 6f 72 79 2c 20 72 65  hared-memory, re
1420: 74 75 72 6e 20 66 61 6c 73 65 2e 20 0a 2a 2f 0a  turn false. .*/.
1430: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 48 65  int sqlite3WalHe
1440: 61 70 4d 65 6d 6f 72 79 28 57 61 6c 20 2a 70 57  apMemory(Wal *pW
1450: 61 6c 29 3b 0a 0a 23 69 66 64 65 66 20 53 51 4c  al);..#ifdef SQL
1460: 49 54 45 5f 45 4e 41 42 4c 45 5f 53 4e 41 50 53  ITE_ENABLE_SNAPS
1470: 48 4f 54 0a 69 6e 74 20 73 71 6c 69 74 65 33 57  HOT.int sqlite3W
1480: 61 6c 53 6e 61 70 73 68 6f 74 47 65 74 28 57 61  alSnapshotGet(Wa
1490: 6c 20 2a 70 57 61 6c 2c 20 73 71 6c 69 74 65 33  l *pWal, sqlite3
14a0: 5f 73 6e 61 70 73 68 6f 74 20 2a 2a 70 70 53 6e  _snapshot **ppSn
14b0: 61 70 73 68 6f 74 29 3b 0a 76 6f 69 64 20 73 71  apshot);.void sq
14c0: 6c 69 74 65 33 57 61 6c 53 6e 61 70 73 68 6f 74  lite3WalSnapshot
14d0: 4f 70 65 6e 28 57 61 6c 20 2a 70 57 61 6c 2c 20  Open(Wal *pWal, 
14e0: 73 71 6c 69 74 65 33 5f 73 6e 61 70 73 68 6f 74  sqlite3_snapshot
14f0: 20 2a 70 53 6e 61 70 73 68 6f 74 29 3b 0a 69 6e   *pSnapshot);.in
1500: 74 20 73 71 6c 69 74 65 33 57 61 6c 53 6e 61 70  t sqlite3WalSnap
1510: 73 68 6f 74 52 65 63 6f 76 65 72 28 57 61 6c 20  shotRecover(Wal 
1520: 2a 70 57 61 6c 29 3b 0a 69 6e 74 20 73 71 6c 69  *pWal);.int sqli
1530: 74 65 33 57 61 6c 53 6e 61 70 73 68 6f 74 43 68  te3WalSnapshotCh
1540: 65 63 6b 28 57 61 6c 20 2a 70 57 61 6c 2c 20 73  eck(Wal *pWal, s
1550: 71 6c 69 74 65 33 5f 73 6e 61 70 73 68 6f 74 20  qlite3_snapshot 
1560: 2a 70 53 6e 61 70 73 68 6f 74 29 3b 0a 76 6f 69  *pSnapshot);.voi
1570: 64 20 73 71 6c 69 74 65 33 57 61 6c 53 6e 61 70  d sqlite3WalSnap
1580: 73 68 6f 74 55 6e 6c 6f 63 6b 28 57 61 6c 20 2a  shotUnlock(Wal *
1590: 70 57 61 6c 29 3b 0a 23 65 6e 64 69 66 0a 0a 23  pWal);.#endif..#
15a0: 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d  ifndef SQLITE_OM
15b0: 49 54 5f 43 4f 4e 43 55 52 52 45 4e 54 0a 2f 2a  IT_CONCURRENT./*
15c0: 20 54 65 6c 6c 20 74 68 65 20 77 61 6c 20 6c 61   Tell the wal la
15d0: 79 65 72 20 74 68 61 74 20 77 65 20 77 61 6e 74  yer that we want
15e0: 20 74 6f 20 63 6f 6d 6d 69 74 20 61 20 63 6f 6e   to commit a con
15f0: 63 75 72 72 65 6e 74 20 74 72 61 6e 73 61 63 74  current transact
1600: 69 6f 6e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  ion */.int sqlit
1610: 65 33 57 61 6c 4c 6f 63 6b 46 6f 72 43 6f 6d 6d  e3WalLockForComm
1620: 69 74 28 57 61 6c 20 2a 70 57 61 6c 2c 20 50 67  it(Wal *pWal, Pg
1630: 48 64 72 20 2a 70 50 67 2c 20 42 69 74 76 65 63  Hdr *pPg, Bitvec
1640: 20 2a 70 52 65 61 64 2c 20 50 67 6e 6f 2a 29 3b   *pRead, Pgno*);
1650: 0a 0a 2f 2a 20 55 70 67 72 61 64 65 20 74 68 65  ../* Upgrade the
1660: 20 73 74 61 74 65 20 6f 66 20 74 68 65 20 63 6c   state of the cl
1670: 69 65 6e 74 20 74 6f 20 74 61 6b 65 20 69 6e 74  ient to take int
1680: 6f 20 61 63 63 6f 75 6e 74 20 63 68 61 6e 67 65  o account change
1690: 73 20 77 72 69 74 74 65 6e 0a 2a 2a 20 62 79 20  s written.** by 
16a0: 6f 74 68 65 72 20 63 6f 6e 6e 65 63 74 69 6f 6e  other connection
16b0: 73 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  s */.int sqlite3
16c0: 57 61 6c 55 70 67 72 61 64 65 53 6e 61 70 73 68  WalUpgradeSnapsh
16d0: 6f 74 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 23  ot(Wal *pWal);.#
16e0: 65 6e 64 69 66 20 2f 2a 20 53 51 4c 49 54 45 5f  endif /* SQLITE_
16f0: 4f 4d 49 54 5f 43 4f 4e 43 55 52 52 45 4e 54 20  OMIT_CONCURRENT 
1700: 2a 2f 0a 0a 23 69 66 64 65 66 20 53 51 4c 49 54  */..#ifdef SQLIT
1710: 45 5f 45 4e 41 42 4c 45 5f 5a 49 50 56 46 53 0a  E_ENABLE_ZIPVFS.
1720: 2f 2a 20 49 66 20 74 68 65 20 57 41 4c 20 66 69  /* If the WAL fi
1730: 6c 65 20 69 73 20 6e 6f 74 20 65 6d 70 74 79 2c  le is not empty,
1740: 20 72 65 74 75 72 6e 20 74 68 65 20 6e 75 6d 62   return the numb
1750: 65 72 20 6f 66 20 62 79 74 65 73 20 6f 66 20 63  er of bytes of c
1760: 6f 6e 74 65 6e 74 0a 2a 2a 20 73 74 6f 72 65 64  ontent.** stored
1770: 20 69 6e 20 65 61 63 68 20 66 72 61 6d 65 20 28   in each frame (
1780: 69 2e 65 2e 20 74 68 65 20 64 62 20 70 61 67 65  i.e. the db page
1790: 2d 73 69 7a 65 20 77 68 65 6e 20 74 68 65 20 57  -size when the W
17a0: 41 4c 20 77 61 73 20 63 72 65 61 74 65 64 29 2e  AL was created).
17b0: 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57  .*/.int sqlite3W
17c0: 61 6c 46 72 61 6d 65 73 69 7a 65 28 57 61 6c 20  alFramesize(Wal 
17d0: 2a 70 57 61 6c 29 3b 0a 23 65 6e 64 69 66 0a 0a  *pWal);.#endif..
17e0: 2f 2a 20 52 65 74 75 72 6e 20 74 68 65 20 73 71  /* Return the sq
17f0: 6c 69 74 65 33 5f 66 69 6c 65 20 6f 62 6a 65 63  lite3_file objec
1800: 74 20 66 6f 72 20 74 68 65 20 57 41 4c 20 66 69  t for the WAL fi
1810: 6c 65 20 2a 2f 0a 73 71 6c 69 74 65 33 5f 66 69  le */.sqlite3_fi
1820: 6c 65 20 2a 73 71 6c 69 74 65 33 57 61 6c 46 69  le *sqlite3WalFi
1830: 6c 65 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a  le(Wal *pWal);..
1840: 2f 2a 20 73 71 6c 69 74 65 33 5f 77 61 6c 5f 69  /* sqlite3_wal_i
1850: 6e 66 6f 28 29 20 64 61 74 61 20 2a 2f 0a 69 6e  nfo() data */.in
1860: 74 20 73 71 6c 69 74 65 33 57 61 6c 49 6e 66 6f  t sqlite3WalInfo
1870: 28 57 61 6c 20 2a 70 57 61 6c 2c 20 75 33 32 20  (Wal *pWal, u32 
1880: 2a 70 6e 50 72 69 6f 72 2c 20 75 33 32 20 2a 70  *pnPrior, u32 *p
1890: 6e 46 72 61 6d 65 29 3b 0a 0a 23 65 6e 64 69 66  nFrame);..#endif
18a0: 20 2f 2a 20 69 66 6e 64 65 66 20 53 51 4c 49 54   /* ifndef SQLIT
18b0: 45 5f 4f 4d 49 54 5f 57 41 4c 20 2a 2f 0a 23 65  E_OMIT_WAL */.#e
18c0: 6e 64 69 66 20 2f 2a 20 53 51 4c 49 54 45 5f 57  ndif /* SQLITE_W
18d0: 41 4c 5f 48 20 2a 2f 0a                          AL_H */.