/ Hex Artifact Content
Login

Artifact 1ea51dc499d6451529b822a8aaac053eafeef10b7fd9e5a4c9cc413182be429f:


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 41 64 64 69 74 69 6f 6e 61 6c 20  ../* Additional 
02a0: 76 61 6c 75 65 73 20 74 68 61 74 20 63 61 6e 20  values that can 
02b0: 62 65 20 61 64 64 65 64 20 74 6f 20 74 68 65 20  be added to the 
02c0: 73 79 6e 63 5f 66 6c 61 67 73 20 61 72 67 75 6d  sync_flags argum
02d0: 65 6e 74 20 6f 66 0a 2a 2a 20 73 71 6c 69 74 65  ent of.** sqlite
02e0: 33 57 61 6c 46 72 61 6d 65 73 28 29 3a 0a 2a 2f  3WalFrames():.*/
02f0: 0a 23 64 65 66 69 6e 65 20 57 41 4c 5f 53 59 4e  .#define WAL_SYN
0300: 43 5f 54 52 41 4e 53 41 43 54 49 4f 4e 53 20 20  C_TRANSACTIONS  
0310: 30 78 32 30 20 20 20 2f 2a 20 53 79 6e 63 20 61  0x20   /* Sync a
0320: 74 20 74 68 65 20 65 6e 64 20 6f 66 20 65 61 63  t the end of eac
0330: 68 20 74 72 61 6e 73 61 63 74 69 6f 6e 20 2a 2f  h transaction */
0340: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
0350: 53 59 4e 43 5f 4d 41 53 4b 20 20 20 20 20 20 20  SYNC_MASK       
0360: 30 78 31 33 20 20 20 2f 2a 20 4d 61 73 6b 20 6f  0x13   /* Mask o
0370: 66 66 20 74 68 65 20 53 51 4c 49 54 45 5f 53 59  ff the SQLITE_SY
0380: 4e 43 5f 2a 20 76 61 6c 75 65 73 20 2a 2f 0a 0a  NC_* values */..
0390: 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d  #ifdef SQLITE_OM
03a0: 49 54 5f 57 41 4c 0a 23 20 64 65 66 69 6e 65 20  IT_WAL.# define 
03b0: 73 71 6c 69 74 65 33 57 61 6c 4f 70 65 6e 28 78  sqlite3WalOpen(x
03c0: 2c 79 2c 7a 29 20 20 20 20 20 20 20 20 20 20 20  ,y,z)           
03d0: 20 20 20 20 20 20 20 20 30 0a 23 20 64 65 66 69          0.# defi
03e0: 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 4c 69 6d  ne sqlite3WalLim
03f0: 69 74 28 78 2c 79 29 0a 23 20 64 65 66 69 6e 65  it(x,y).# define
0400: 20 73 71 6c 69 74 65 33 57 61 6c 43 6c 6f 73 65   sqlite3WalClose
0410: 28 76 2c 77 2c 78 2c 79 2c 7a 29 20 20 20 20 20  (v,w,x,y,z)     
0420: 20 20 20 20 20 20 20 20 20 30 0a 23 20 64 65 66           0.# def
0430: 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 42 65  ine sqlite3WalBe
0440: 67 69 6e 52 65 61 64 54 72 61 6e 73 61 63 74 69  ginReadTransacti
0450: 6f 6e 28 79 2c 7a 29 20 20 20 20 20 30 0a 23 20  on(y,z)     0.# 
0460: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61  define sqlite3Wa
0470: 6c 45 6e 64 52 65 61 64 54 72 61 6e 73 61 63 74  lEndReadTransact
0480: 69 6f 6e 28 7a 29 0a 23 20 64 65 66 69 6e 65 20  ion(z).# define 
0490: 73 71 6c 69 74 65 33 57 61 6c 44 62 73 69 7a 65  sqlite3WalDbsize
04a0: 28 79 29 20 20 20 20 20 20 20 20 20 20 20 20 20  (y)             
04b0: 20 20 20 20 20 20 20 20 30 0a 23 20 64 65 66 69          0.# defi
04c0: 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 42 65 67  ne sqlite3WalBeg
04d0: 69 6e 57 72 69 74 65 54 72 61 6e 73 61 63 74 69  inWriteTransacti
04e0: 6f 6e 28 79 29 20 20 20 20 20 20 30 0a 23 20 64  on(y)      0.# d
04f0: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c  efine sqlite3Wal
0500: 45 6e 64 57 72 69 74 65 54 72 61 6e 73 61 63 74  EndWriteTransact
0510: 69 6f 6e 28 78 29 20 20 20 20 20 20 20 20 30 0a  ion(x)        0.
0520: 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33  # define sqlite3
0530: 57 61 6c 55 6e 64 6f 28 78 2c 79 2c 7a 29 20 20  WalUndo(x,y,z)  
0540: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0550: 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69   0.# define sqli
0560: 74 65 33 57 61 6c 53 61 76 65 70 6f 69 6e 74 28  te3WalSavepoint(
0570: 79 2c 7a 29 0a 23 20 64 65 66 69 6e 65 20 73 71  y,z).# define sq
0580: 6c 69 74 65 33 57 61 6c 53 61 76 65 70 6f 69 6e  lite3WalSavepoin
0590: 74 55 6e 64 6f 28 79 2c 7a 29 20 20 20 20 20 20  tUndo(y,z)      
05a0: 20 20 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65        0.# define
05b0: 20 73 71 6c 69 74 65 33 57 61 6c 46 72 61 6d 65   sqlite3WalFrame
05c0: 73 28 75 2c 76 2c 77 2c 78 2c 79 2c 7a 29 20 20  s(u,v,w,x,y,z)  
05d0: 20 20 20 20 20 20 20 20 20 30 0a 23 20 64 65 66           0.# def
05e0: 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 43 68  ine sqlite3WalCh
05f0: 65 63 6b 70 6f 69 6e 74 28 71 2c 72 2c 73 2c 74  eckpoint(q,r,s,t
0600: 2c 75 2c 76 2c 77 2c 78 2c 79 2c 7a 29 20 30 0a  ,u,v,w,x,y,z) 0.
0610: 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33  # define sqlite3
0620: 57 61 6c 43 61 6c 6c 62 61 63 6b 28 7a 29 20 20  WalCallback(z)  
0630: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0640: 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69   0.# define sqli
0650: 74 65 33 57 61 6c 45 78 63 6c 75 73 69 76 65 4d  te3WalExclusiveM
0660: 6f 64 65 28 79 2c 7a 29 20 20 20 20 20 20 20 20  ode(y,z)        
0670: 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73      0.# define s
0680: 71 6c 69 74 65 33 57 61 6c 48 65 61 70 4d 65 6d  qlite3WalHeapMem
0690: 6f 72 79 28 7a 29 20 20 20 20 20 20 20 20 20 20  ory(z)          
06a0: 20 20 20 20 20 20 20 30 0a 23 20 64 65 66 69 6e         0.# defin
06b0: 65 20 73 71 6c 69 74 65 33 57 61 6c 46 72 61 6d  e sqlite3WalFram
06c0: 65 73 69 7a 65 28 7a 29 20 20 20 20 20 20 20 20  esize(z)        
06d0: 20 20 20 20 20 20 20 20 20 20 30 0a 23 20 64 65            0.# de
06e0: 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 46  fine sqlite3WalF
06f0: 69 6e 64 46 72 61 6d 65 28 78 2c 79 2c 7a 29 20  indFrame(x,y,z) 
0700: 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0a 23               0.#
0710: 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57   define sqlite3W
0720: 61 6c 46 69 6c 65 28 78 29 20 20 20 20 20 20 20  alFile(x)       
0730: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0740: 30 0a 23 65 6c 73 65 0a 0a 23 64 65 66 69 6e 65  0.#else..#define
0750: 20 57 41 4c 5f 53 41 56 45 50 4f 49 4e 54 5f 4e   WAL_SAVEPOINT_N
0760: 44 41 54 41 20 34 0a 0a 2f 2a 20 43 6f 6e 6e 65  DATA 4../* Conne
0770: 63 74 69 6f 6e 20 74 6f 20 61 20 77 72 69 74 65  ction to a write
0780: 2d 61 68 65 61 64 20 6c 6f 67 20 28 57 41 4c 29  -ahead log (WAL)
0790: 20 66 69 6c 65 2e 20 0a 2a 2a 20 54 68 65 72 65   file. .** There
07a0: 20 69 73 20 6f 6e 65 20 6f 62 6a 65 63 74 20 6f   is one object o
07b0: 66 20 74 68 69 73 20 74 79 70 65 20 66 6f 72 20  f this type for 
07c0: 65 61 63 68 20 70 61 67 65 72 2e 20 0a 2a 2f 0a  each pager. .*/.
07d0: 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20 57  typedef struct W
07e0: 61 6c 20 57 61 6c 3b 0a 0a 2f 2a 20 4f 70 65 6e  al Wal;../* Open
07f0: 20 61 6e 64 20 63 6c 6f 73 65 20 61 20 63 6f 6e   and close a con
0800: 6e 65 63 74 69 6f 6e 20 74 6f 20 61 20 77 72 69  nection to a wri
0810: 74 65 2d 61 68 65 61 64 20 6c 6f 67 2e 20 2a 2f  te-ahead log. */
0820: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 4f  .int sqlite3WalO
0830: 70 65 6e 28 73 71 6c 69 74 65 33 5f 76 66 73 2a  pen(sqlite3_vfs*
0840: 2c 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c  , sqlite3_file*,
0850: 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 2c 20 69   const char *, i
0860: 6e 74 2c 20 69 36 34 2c 20 57 61 6c 2a 2a 29 3b  nt, i64, Wal**);
0870: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 43  .int sqlite3WalC
0880: 6c 6f 73 65 28 57 61 6c 20 2a 70 57 61 6c 2c 20  lose(Wal *pWal, 
0890: 73 71 6c 69 74 65 33 2a 2c 20 69 6e 74 20 73 79  sqlite3*, int sy
08a0: 6e 63 5f 66 6c 61 67 73 2c 20 69 6e 74 2c 20 75  nc_flags, int, u
08b0: 38 20 2a 29 3b 0a 0a 2f 2a 20 53 65 74 20 74 68  8 *);../* Set th
08c0: 65 20 6c 69 6d 69 74 69 6e 67 20 73 69 7a 65 20  e limiting size 
08d0: 6f 66 20 61 20 57 41 4c 20 66 69 6c 65 2e 20 2a  of a WAL file. *
08e0: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61  /.void sqlite3Wa
08f0: 6c 4c 69 6d 69 74 28 57 61 6c 2a 2c 20 69 36 34  lLimit(Wal*, i64
0900: 29 3b 0a 0a 2f 2a 20 55 73 65 64 20 62 79 20 72  );../* Used by r
0910: 65 61 64 65 72 73 20 74 6f 20 6f 70 65 6e 20 28  eaders to open (
0920: 6c 6f 63 6b 29 20 61 6e 64 20 63 6c 6f 73 65 20  lock) and close 
0930: 28 75 6e 6c 6f 63 6b 29 20 61 20 73 6e 61 70 73  (unlock) a snaps
0940: 68 6f 74 2e 20 20 41 20 0a 2a 2a 20 73 6e 61 70  hot.  A .** snap
0950: 73 68 6f 74 20 69 73 20 6c 69 6b 65 20 61 20 72  shot is like a r
0960: 65 61 64 2d 74 72 61 6e 73 61 63 74 69 6f 6e 2e  ead-transaction.
0970: 20 20 49 74 20 69 73 20 74 68 65 20 73 74 61 74    It is the stat
0980: 65 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73  e of the databas
0990: 65 0a 2a 2a 20 61 74 20 61 6e 20 69 6e 73 74 61  e.** at an insta
09a0: 6e 74 20 69 6e 20 74 69 6d 65 2e 20 20 73 71 6c  nt in time.  sql
09b0: 69 74 65 33 57 61 6c 4f 70 65 6e 53 6e 61 70 73  ite3WalOpenSnaps
09c0: 68 6f 74 20 67 65 74 73 20 61 20 72 65 61 64 20  hot gets a read 
09d0: 6c 6f 63 6b 20 61 6e 64 0a 2a 2a 20 70 72 65 73  lock and.** pres
09e0: 65 72 76 65 73 20 74 68 65 20 63 75 72 72 65 6e  erves the curren
09f0: 74 20 73 74 61 74 65 20 65 76 65 6e 20 69 66 20  t state even if 
0a00: 74 68 65 20 6f 74 68 65 72 20 74 68 72 65 61 64  the other thread
0a10: 73 20 6f 72 20 70 72 6f 63 65 73 73 65 73 0a 2a  s or processes.*
0a20: 2a 20 77 72 69 74 65 20 74 6f 20 6f 72 20 63 68  * write to or ch
0a30: 65 63 6b 70 6f 69 6e 74 20 74 68 65 20 57 41 4c  eckpoint the WAL
0a40: 2e 20 20 73 71 6c 69 74 65 33 57 61 6c 43 6c 6f  .  sqlite3WalClo
0a50: 73 65 53 6e 61 70 73 68 6f 74 28 29 20 63 6c 6f  seSnapshot() clo
0a60: 73 65 73 20 74 68 65 0a 2a 2a 20 74 72 61 6e 73  ses the.** trans
0a70: 61 63 74 69 6f 6e 20 61 6e 64 20 72 65 6c 65 61  action and relea
0a80: 73 65 73 20 74 68 65 20 6c 6f 63 6b 2e 0a 2a 2f  ses the lock..*/
0a90: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 42  .int sqlite3WalB
0aa0: 65 67 69 6e 52 65 61 64 54 72 61 6e 73 61 63 74  eginReadTransact
0ab0: 69 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69  ion(Wal *pWal, i
0ac0: 6e 74 20 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69  nt *);.void sqli
0ad0: 74 65 33 57 61 6c 45 6e 64 52 65 61 64 54 72 61  te3WalEndReadTra
0ae0: 6e 73 61 63 74 69 6f 6e 28 57 61 6c 20 2a 70 57  nsaction(Wal *pW
0af0: 61 6c 29 3b 0a 0a 2f 2a 20 52 65 61 64 20 61 20  al);../* Read a 
0b00: 70 61 67 65 20 66 72 6f 6d 20 74 68 65 20 77 72  page from the wr
0b10: 69 74 65 2d 61 68 65 61 64 20 6c 6f 67 2c 20 69  ite-ahead log, i
0b20: 66 20 69 74 20 69 73 20 70 72 65 73 65 6e 74 2e  f it is present.
0b30: 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57   */.int sqlite3W
0b40: 61 6c 46 69 6e 64 46 72 61 6d 65 28 57 61 6c 20  alFindFrame(Wal 
0b50: 2a 2c 20 50 67 6e 6f 2c 20 75 33 32 20 2a 29 3b  *, Pgno, u32 *);
0b60: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 52  .int sqlite3WalR
0b70: 65 61 64 46 72 61 6d 65 28 57 61 6c 20 2a 2c 20  eadFrame(Wal *, 
0b80: 75 33 32 2c 20 69 6e 74 2c 20 75 38 20 2a 29 3b  u32, int, u8 *);
0b90: 0a 0a 2f 2a 20 49 66 20 74 68 65 20 57 41 4c 20  ../* If the WAL 
0ba0: 69 73 20 6e 6f 74 20 65 6d 70 74 79 2c 20 72 65  is not empty, re
0bb0: 74 75 72 6e 20 74 68 65 20 73 69 7a 65 20 6f 66  turn the size of
0bc0: 20 74 68 65 20 64 61 74 61 62 61 73 65 2e 20 2a   the database. *
0bd0: 2f 0a 50 67 6e 6f 20 73 71 6c 69 74 65 33 57 61  /.Pgno sqlite3Wa
0be0: 6c 44 62 73 69 7a 65 28 57 61 6c 20 2a 70 57 61  lDbsize(Wal *pWa
0bf0: 6c 29 3b 0a 0a 2f 2a 20 4f 62 74 61 69 6e 20 6f  l);../* Obtain o
0c00: 72 20 72 65 6c 65 61 73 65 20 74 68 65 20 57 52  r release the WR
0c10: 49 54 45 52 20 6c 6f 63 6b 2e 20 2a 2f 0a 69 6e  ITER lock. */.in
0c20: 74 20 73 71 6c 69 74 65 33 57 61 6c 42 65 67 69  t sqlite3WalBegi
0c30: 6e 57 72 69 74 65 54 72 61 6e 73 61 63 74 69 6f  nWriteTransactio
0c40: 6e 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 69 6e  n(Wal *pWal);.in
0c50: 74 20 73 71 6c 69 74 65 33 57 61 6c 45 6e 64 57  t sqlite3WalEndW
0c60: 72 69 74 65 54 72 61 6e 73 61 63 74 69 6f 6e 28  riteTransaction(
0c70: 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20  Wal *pWal);../* 
0c80: 55 6e 64 6f 20 61 6e 79 20 66 72 61 6d 65 73 20  Undo any frames 
0c90: 77 72 69 74 74 65 6e 20 28 62 75 74 20 6e 6f 74  written (but not
0ca0: 20 63 6f 6d 6d 69 74 74 65 64 29 20 74 6f 20 74   committed) to t
0cb0: 68 65 20 6c 6f 67 20 2a 2f 0a 69 6e 74 20 73 71  he log */.int sq
0cc0: 6c 69 74 65 33 57 61 6c 55 6e 64 6f 28 57 61 6c  lite3WalUndo(Wal
0cd0: 20 2a 70 57 61 6c 2c 20 69 6e 74 20 28 2a 78 55   *pWal, int (*xU
0ce0: 6e 64 6f 29 28 76 6f 69 64 20 2a 2c 20 50 67 6e  ndo)(void *, Pgn
0cf0: 6f 29 2c 20 76 6f 69 64 20 2a 70 55 6e 64 6f 43  o), void *pUndoC
0d00: 74 78 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20  tx);../* Return 
0d10: 61 6e 20 69 6e 74 65 67 65 72 20 74 68 61 74 20  an integer that 
0d20: 72 65 63 6f 72 64 73 20 74 68 65 20 63 75 72 72  records the curr
0d30: 65 6e 74 20 28 75 6e 63 6f 6d 6d 69 74 74 65 64  ent (uncommitted
0d40: 29 20 77 72 69 74 65 0a 2a 2a 20 70 6f 73 69 74  ) write.** posit
0d50: 69 6f 6e 20 69 6e 20 74 68 65 20 57 41 4c 20 2a  ion in the WAL *
0d60: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61  /.void sqlite3Wa
0d70: 6c 53 61 76 65 70 6f 69 6e 74 28 57 61 6c 20 2a  lSavepoint(Wal *
0d80: 70 57 61 6c 2c 20 75 33 32 20 2a 61 57 61 6c 44  pWal, u32 *aWalD
0d90: 61 74 61 29 3b 0a 0a 2f 2a 20 4d 6f 76 65 20 74  ata);../* Move t
0da0: 68 65 20 77 72 69 74 65 20 70 6f 73 69 74 69 6f  he write positio
0db0: 6e 20 6f 66 20 74 68 65 20 57 41 4c 20 62 61 63  n of the WAL bac
0dc0: 6b 20 74 6f 20 69 46 72 61 6d 65 2e 20 20 43 61  k to iFrame.  Ca
0dd0: 6c 6c 65 64 20 69 6e 0a 2a 2a 20 72 65 73 70 6f  lled in.** respo
0de0: 6e 73 65 20 74 6f 20 61 20 52 4f 4c 4c 42 41 43  nse to a ROLLBAC
0df0: 4b 20 54 4f 20 63 6f 6d 6d 61 6e 64 2e 20 2a 2f  K TO command. */
0e00: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 53  .int sqlite3WalS
0e10: 61 76 65 70 6f 69 6e 74 55 6e 64 6f 28 57 61 6c  avepointUndo(Wal
0e20: 20 2a 70 57 61 6c 2c 20 75 33 32 20 2a 61 57 61   *pWal, u32 *aWa
0e30: 6c 44 61 74 61 29 3b 0a 0a 2f 2a 20 57 72 69 74  lData);../* Writ
0e40: 65 20 61 20 66 72 61 6d 65 20 6f 72 20 66 72 61  e a frame or fra
0e50: 6d 65 73 20 74 6f 20 74 68 65 20 6c 6f 67 2e 20  mes to the log. 
0e60: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  */.int sqlite3Wa
0e70: 6c 46 72 61 6d 65 73 28 57 61 6c 20 2a 70 57 61  lFrames(Wal *pWa
0e80: 6c 2c 20 69 6e 74 2c 20 50 67 48 64 72 20 2a 2c  l, int, PgHdr *,
0e90: 20 50 67 6e 6f 2c 20 69 6e 74 2c 20 69 6e 74 29   Pgno, int, int)
0ea0: 3b 0a 0a 2f 2a 20 43 6f 70 79 20 70 61 67 65 73  ;../* Copy pages
0eb0: 20 66 72 6f 6d 20 74 68 65 20 6c 6f 67 20 74 6f   from the log to
0ec0: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69   the database fi
0ed0: 6c 65 20 2a 2f 20 0a 69 6e 74 20 73 71 6c 69 74  le */ .int sqlit
0ee0: 65 33 57 61 6c 43 68 65 63 6b 70 6f 69 6e 74 28  e3WalCheckpoint(
0ef0: 0a 20 20 57 61 6c 20 2a 70 57 61 6c 2c 20 20 20  .  Wal *pWal,   
0f00: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0f10: 20 20 20 2f 2a 20 57 72 69 74 65 2d 61 68 65 61     /* Write-ahea
0f20: 64 20 6c 6f 67 20 63 6f 6e 6e 65 63 74 69 6f 6e  d log connection
0f30: 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 20 2a 64   */.  sqlite3 *d
0f40: 62 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  b,              
0f50: 20 20 20 20 20 20 2f 2a 20 43 68 65 63 6b 20 74        /* Check t
0f60: 68 69 73 20 68 61 6e 64 6c 65 27 73 20 69 6e 74  his handle's int
0f70: 65 72 72 75 70 74 20 66 6c 61 67 20 2a 2f 0a 20  errupt flag */. 
0f80: 20 69 6e 74 20 65 4d 6f 64 65 2c 20 20 20 20 20   int eMode,     
0f90: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0fa0: 20 2f 2a 20 4f 6e 65 20 6f 66 20 50 41 53 53 49   /* One of PASSI
0fb0: 56 45 2c 20 46 55 4c 4c 20 61 6e 64 20 52 45 53  VE, FULL and RES
0fc0: 54 41 52 54 20 2a 2f 0a 20 20 69 6e 74 20 28 2a  TART */.  int (*
0fd0: 78 42 75 73 79 29 28 76 6f 69 64 2a 29 2c 20 20  xBusy)(void*),  
0fe0: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46 75 6e            /* Fun
0ff0: 63 74 69 6f 6e 20 74 6f 20 63 61 6c 6c 20 77 68  ction to call wh
1000: 65 6e 20 62 75 73 79 20 2a 2f 0a 20 20 76 6f 69  en busy */.  voi
1010: 64 20 2a 70 42 75 73 79 41 72 67 2c 20 20 20 20  d *pBusyArg,    
1020: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
1030: 43 6f 6e 74 65 78 74 20 61 72 67 75 6d 65 6e 74  Context argument
1040: 20 66 6f 72 20 78 42 75 73 79 48 61 6e 64 6c 65   for xBusyHandle
1050: 72 20 2a 2f 0a 20 20 69 6e 74 20 73 79 6e 63 5f  r */.  int sync_
1060: 66 6c 61 67 73 2c 20 20 20 20 20 20 20 20 20 20  flags,          
1070: 20 20 20 20 20 20 20 2f 2a 20 46 6c 61 67 73 20         /* Flags 
1080: 74 6f 20 73 79 6e 63 20 64 62 20 66 69 6c 65 20  to sync db file 
1090: 77 69 74 68 20 28 6f 72 20 30 29 20 2a 2f 0a 20  with (or 0) */. 
10a0: 20 69 6e 74 20 6e 42 75 66 2c 20 20 20 20 20 20   int nBuf,      
10b0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
10c0: 20 2f 2a 20 53 69 7a 65 20 6f 66 20 62 75 66 66   /* Size of buff
10d0: 65 72 20 6e 42 75 66 20 2a 2f 0a 20 20 75 38 20  er nBuf */.  u8 
10e0: 2a 7a 42 75 66 2c 20 20 20 20 20 20 20 20 20 20  *zBuf,          
10f0: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
1100: 54 65 6d 70 6f 72 61 72 79 20 62 75 66 66 65 72  Temporary buffer
1110: 20 74 6f 20 75 73 65 20 2a 2f 0a 20 20 69 6e 74   to use */.  int
1120: 20 2a 70 6e 4c 6f 67 2c 20 20 20 20 20 20 20 20   *pnLog,        
1130: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
1140: 4f 55 54 3a 20 4e 75 6d 62 65 72 20 6f 66 20 66  OUT: Number of f
1150: 72 61 6d 65 73 20 69 6e 20 57 41 4c 20 2a 2f 0a  rames in WAL */.
1160: 20 20 69 6e 74 20 2a 70 6e 43 6b 70 74 20 20 20    int *pnCkpt   
1170: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1180: 20 20 2f 2a 20 4f 55 54 3a 20 4e 75 6d 62 65 72    /* OUT: Number
1190: 20 6f 66 20 62 61 63 6b 66 69 6c 6c 65 64 20 66   of backfilled f
11a0: 72 61 6d 65 73 20 69 6e 20 57 41 4c 20 2a 2f 0a  rames in WAL */.
11b0: 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74 68  );../* Return th
11c0: 65 20 76 61 6c 75 65 20 74 6f 20 70 61 73 73 20  e value to pass 
11d0: 74 6f 20 61 20 73 71 6c 69 74 65 33 5f 77 61 6c  to a sqlite3_wal
11e0: 5f 68 6f 6f 6b 20 63 61 6c 6c 62 61 63 6b 2c 20  _hook callback, 
11f0: 74 68 65 0a 2a 2a 20 6e 75 6d 62 65 72 20 6f 66  the.** number of
1200: 20 66 72 61 6d 65 73 20 69 6e 20 74 68 65 20 57   frames in the W
1210: 41 4c 20 61 74 20 74 68 65 20 70 6f 69 6e 74 20  AL at the point 
1220: 6f 66 20 74 68 65 20 6c 61 73 74 20 63 6f 6d 6d  of the last comm
1230: 69 74 20 73 69 6e 63 65 0a 2a 2a 20 73 71 6c 69  it since.** sqli
1240: 74 65 33 57 61 6c 43 61 6c 6c 62 61 63 6b 28 29  te3WalCallback()
1250: 20 77 61 73 20 63 61 6c 6c 65 64 2e 20 20 49 66   was called.  If
1260: 20 6e 6f 20 63 6f 6d 6d 69 74 73 20 68 61 76 65   no commits have
1270: 20 6f 63 63 75 72 72 65 64 20 73 69 6e 63 65 0a   occurred since.
1280: 2a 2a 20 74 68 65 20 6c 61 73 74 20 63 61 6c 6c  ** the last call
1290: 2c 20 74 68 65 6e 20 72 65 74 75 72 6e 20 30 2e  , then return 0.
12a0: 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57  .*/.int sqlite3W
12b0: 61 6c 43 61 6c 6c 62 61 63 6b 28 57 61 6c 20 2a  alCallback(Wal *
12c0: 70 57 61 6c 29 3b 0a 0a 2f 2a 20 54 65 6c 6c 20  pWal);../* Tell 
12d0: 74 68 65 20 77 61 6c 20 6c 61 79 65 72 20 74 68  the wal layer th
12e0: 61 74 20 61 6e 20 45 58 43 4c 55 53 49 56 45 20  at an EXCLUSIVE 
12f0: 6c 6f 63 6b 20 68 61 73 20 62 65 65 6e 20 6f 62  lock has been ob
1300: 74 61 69 6e 65 64 20 28 6f 72 20 72 65 6c 65 61  tained (or relea
1310: 73 65 64 29 0a 2a 2a 20 62 79 20 74 68 65 20 70  sed).** by the p
1320: 61 67 65 72 20 6c 61 79 65 72 20 6f 6e 20 74 68  ager layer on th
1330: 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 2e  e database file.
1340: 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57  .*/.int sqlite3W
1350: 61 6c 45 78 63 6c 75 73 69 76 65 4d 6f 64 65 28  alExclusiveMode(
1360: 57 61 6c 20 2a 70 57 61 6c 2c 20 69 6e 74 20 6f  Wal *pWal, int o
1370: 70 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74  p);../* Return t
1380: 72 75 65 20 69 66 20 74 68 65 20 61 72 67 75 6d  rue if the argum
1390: 65 6e 74 20 69 73 20 6e 6f 6e 2d 4e 55 4c 4c 20  ent is non-NULL 
13a0: 61 6e 64 20 74 68 65 20 57 41 4c 20 6d 6f 64 75  and the WAL modu
13b0: 6c 65 20 69 73 20 75 73 69 6e 67 0a 2a 2a 20 68  le is using.** h
13c0: 65 61 70 2d 6d 65 6d 6f 72 79 20 66 6f 72 20 74  eap-memory for t
13d0: 68 65 20 77 61 6c 2d 69 6e 64 65 78 2e 20 4f 74  he wal-index. Ot
13e0: 68 65 72 77 69 73 65 2c 20 69 66 20 74 68 65 20  herwise, if the 
13f0: 61 72 67 75 6d 65 6e 74 20 69 73 20 4e 55 4c 4c  argument is NULL
1400: 20 6f 72 20 74 68 65 0a 2a 2a 20 57 41 4c 20 6d   or the.** WAL m
1410: 6f 64 75 6c 65 20 69 73 20 75 73 69 6e 67 20 73  odule is using s
1420: 68 61 72 65 64 2d 6d 65 6d 6f 72 79 2c 20 72 65  hared-memory, re
1430: 74 75 72 6e 20 66 61 6c 73 65 2e 20 0a 2a 2f 0a  turn false. .*/.
1440: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 48 65  int sqlite3WalHe
1450: 61 70 4d 65 6d 6f 72 79 28 57 61 6c 20 2a 70 57  apMemory(Wal *pW
1460: 61 6c 29 3b 0a 0a 23 69 66 64 65 66 20 53 51 4c  al);..#ifdef SQL
1470: 49 54 45 5f 45 4e 41 42 4c 45 5f 53 4e 41 50 53  ITE_ENABLE_SNAPS
1480: 48 4f 54 0a 69 6e 74 20 73 71 6c 69 74 65 33 57  HOT.int sqlite3W
1490: 61 6c 53 6e 61 70 73 68 6f 74 47 65 74 28 57 61  alSnapshotGet(Wa
14a0: 6c 20 2a 70 57 61 6c 2c 20 73 71 6c 69 74 65 33  l *pWal, sqlite3
14b0: 5f 73 6e 61 70 73 68 6f 74 20 2a 2a 70 70 53 6e  _snapshot **ppSn
14c0: 61 70 73 68 6f 74 29 3b 0a 76 6f 69 64 20 73 71  apshot);.void sq
14d0: 6c 69 74 65 33 57 61 6c 53 6e 61 70 73 68 6f 74  lite3WalSnapshot
14e0: 4f 70 65 6e 28 57 61 6c 20 2a 70 57 61 6c 2c 20  Open(Wal *pWal, 
14f0: 73 71 6c 69 74 65 33 5f 73 6e 61 70 73 68 6f 74  sqlite3_snapshot
1500: 20 2a 70 53 6e 61 70 73 68 6f 74 29 3b 0a 69 6e   *pSnapshot);.in
1510: 74 20 73 71 6c 69 74 65 33 57 61 6c 53 6e 61 70  t sqlite3WalSnap
1520: 73 68 6f 74 52 65 63 6f 76 65 72 28 57 61 6c 20  shotRecover(Wal 
1530: 2a 70 57 61 6c 29 3b 0a 23 65 6e 64 69 66 0a 0a  *pWal);.#endif..
1540: 23 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f  #ifndef SQLITE_O
1550: 4d 49 54 5f 43 4f 4e 43 55 52 52 45 4e 54 0a 2f  MIT_CONCURRENT./
1560: 2a 20 54 65 6c 6c 20 74 68 65 20 77 61 6c 20 6c  * Tell the wal l
1570: 61 79 65 72 20 74 68 61 74 20 77 65 20 77 61 6e  ayer that we wan
1580: 74 20 74 6f 20 63 6f 6d 6d 69 74 20 61 20 63 6f  t to commit a co
1590: 6e 63 75 72 72 65 6e 74 20 74 72 61 6e 73 61 63  ncurrent transac
15a0: 74 69 6f 6e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69  tion */.int sqli
15b0: 74 65 33 57 61 6c 4c 6f 63 6b 46 6f 72 43 6f 6d  te3WalLockForCom
15c0: 6d 69 74 28 57 61 6c 20 2a 70 57 61 6c 2c 20 50  mit(Wal *pWal, P
15d0: 67 48 64 72 20 2a 70 50 67 2c 20 42 69 74 76 65  gHdr *pPg, Bitve
15e0: 63 20 2a 70 52 65 61 64 2c 20 50 67 6e 6f 2a 29  c *pRead, Pgno*)
15f0: 3b 0a 0a 2f 2a 20 55 70 67 72 61 64 65 20 74 68  ;../* Upgrade th
1600: 65 20 73 74 61 74 65 20 6f 66 20 74 68 65 20 63  e state of the c
1610: 6c 69 65 6e 74 20 74 6f 20 74 61 6b 65 20 69 6e  lient to take in
1620: 74 6f 20 61 63 63 6f 75 6e 74 20 63 68 61 6e 67  to account chang
1630: 65 73 20 77 72 69 74 74 65 6e 0a 2a 2a 20 62 79  es written.** by
1640: 20 6f 74 68 65 72 20 63 6f 6e 6e 65 63 74 69 6f   other connectio
1650: 6e 73 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  ns */.int sqlite
1660: 33 57 61 6c 55 70 67 72 61 64 65 53 6e 61 70 73  3WalUpgradeSnaps
1670: 68 6f 74 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a  hot(Wal *pWal);.
1680: 23 65 6e 64 69 66 20 2f 2a 20 53 51 4c 49 54 45  #endif /* SQLITE
1690: 5f 4f 4d 49 54 5f 43 4f 4e 43 55 52 52 45 4e 54  _OMIT_CONCURRENT
16a0: 20 2a 2f 0a 0a 23 69 66 64 65 66 20 53 51 4c 49   */..#ifdef SQLI
16b0: 54 45 5f 45 4e 41 42 4c 45 5f 5a 49 50 56 46 53  TE_ENABLE_ZIPVFS
16c0: 0a 2f 2a 20 49 66 20 74 68 65 20 57 41 4c 20 66  ./* If the WAL f
16d0: 69 6c 65 20 69 73 20 6e 6f 74 20 65 6d 70 74 79  ile is not empty
16e0: 2c 20 72 65 74 75 72 6e 20 74 68 65 20 6e 75 6d  , return the num
16f0: 62 65 72 20 6f 66 20 62 79 74 65 73 20 6f 66 20  ber of bytes of 
1700: 63 6f 6e 74 65 6e 74 0a 2a 2a 20 73 74 6f 72 65  content.** store
1710: 64 20 69 6e 20 65 61 63 68 20 66 72 61 6d 65 20  d in each frame 
1720: 28 69 2e 65 2e 20 74 68 65 20 64 62 20 70 61 67  (i.e. the db pag
1730: 65 2d 73 69 7a 65 20 77 68 65 6e 20 74 68 65 20  e-size when the 
1740: 57 41 4c 20 77 61 73 20 63 72 65 61 74 65 64 29  WAL was created)
1750: 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
1760: 57 61 6c 46 72 61 6d 65 73 69 7a 65 28 57 61 6c  WalFramesize(Wal
1770: 20 2a 70 57 61 6c 29 3b 0a 23 65 6e 64 69 66 0a   *pWal);.#endif.
1780: 0a 2f 2a 20 52 65 74 75 72 6e 20 74 68 65 20 73  ./* Return the s
1790: 71 6c 69 74 65 33 5f 66 69 6c 65 20 6f 62 6a 65  qlite3_file obje
17a0: 63 74 20 66 6f 72 20 74 68 65 20 57 41 4c 20 66  ct for the WAL f
17b0: 69 6c 65 20 2a 2f 0a 73 71 6c 69 74 65 33 5f 66  ile */.sqlite3_f
17c0: 69 6c 65 20 2a 73 71 6c 69 74 65 33 57 61 6c 46  ile *sqlite3WalF
17d0: 69 6c 65 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a  ile(Wal *pWal);.
17e0: 0a 2f 2a 20 73 71 6c 69 74 65 33 5f 77 61 6c 5f  ./* sqlite3_wal_
17f0: 69 6e 66 6f 28 29 20 64 61 74 61 20 2a 2f 0a 69  info() data */.i
1800: 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 49 6e 66  nt sqlite3WalInf
1810: 6f 28 57 61 6c 20 2a 70 57 61 6c 2c 20 75 33 32  o(Wal *pWal, u32
1820: 20 2a 70 6e 50 72 69 6f 72 2c 20 75 33 32 20 2a   *pnPrior, u32 *
1830: 70 6e 46 72 61 6d 65 29 3b 0a 0a 23 65 6e 64 69  pnFrame);..#endi
1840: 66 20 2f 2a 20 69 66 6e 64 65 66 20 53 51 4c 49  f /* ifndef SQLI
1850: 54 45 5f 4f 4d 49 54 5f 57 41 4c 20 2a 2f 0a 23  TE_OMIT_WAL */.#
1860: 65 6e 64 69 66 20 2f 2a 20 53 51 4c 49 54 45 5f  endif /* SQLITE_
1870: 57 41 4c 5f 48 20 2a 2f 0a                       WAL_H */.