/ Hex Artifact Content
Login

Artifact 6b3a67ecd7172dcc9f18fc9cd4d76dc4c2166e68:


0000: 2f 2a 0a 2a 2a 20 32 30 31 30 20 46 65 62 72 75  /*.** 2010 Febru
0010: 61 72 79 20 31 0a 2a 2a 0a 2a 2a 20 54 68 65 20  ary 1.**.** The 
0020: 61 75 74 68 6f 72 20 64 69 73 63 6c 61 69 6d 73  author disclaims
0030: 20 63 6f 70 79 72 69 67 68 74 20 74 6f 20 74 68   copyright to th
0040: 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65 2e 20  is source code. 
0050: 20 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a 2a 20   In place of.** 
0060: 61 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65 2c 20  a legal notice, 
0070: 68 65 72 65 20 69 73 20 61 20 62 6c 65 73 73 69  here is a blessi
0080: 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d 61 79  ng:.**.**    May
0090: 20 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61 6e 64   you do good and
00a0: 20 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20 20 20   not evil..**   
00b0: 20 4d 61 79 20 79 6f 75 20 66 69 6e 64 20 66 6f   May you find fo
00c0: 72 67 69 76 65 6e 65 73 73 20 66 6f 72 20 79 6f  rgiveness for yo
00d0: 75 72 73 65 6c 66 20 61 6e 64 20 66 6f 72 67 69  urself and forgi
00e0: 76 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20 20 20  ve others..**   
00f0: 20 4d 61 79 20 79 6f 75 20 73 68 61 72 65 20 66   May you share f
0100: 72 65 65 6c 79 2c 20 6e 65 76 65 72 20 74 61 6b  reely, never tak
0110: 69 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20 79 6f  ing more than yo
0120: 75 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a 2a 2a  u give..**.*****
0130: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0140: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0150: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0160: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0170: 2a 2a 2a 2a 0a 2a 2a 20 54 68 69 73 20 68 65 61  ****.** This hea
0180: 64 65 72 20 66 69 6c 65 20 64 65 66 69 6e 65 73  der file defines
0190: 20 74 68 65 20 69 6e 74 65 72 66 61 63 65 20 74   the interface t
01a0: 6f 20 74 68 65 20 77 72 69 74 65 2d 61 68 65 61  o the write-ahea
01b0: 64 20 6c 6f 67 67 69 6e 67 20 0a 2a 2a 20 73 79  d logging .** sy
01c0: 73 74 65 6d 2e 20 52 65 66 65 72 20 74 6f 20 74  stem. Refer to t
01d0: 68 65 20 63 6f 6d 6d 65 6e 74 73 20 62 65 6c 6f  he comments belo
01e0: 77 20 61 6e 64 20 74 68 65 20 68 65 61 64 65 72  w and the header
01f0: 20 63 6f 6d 6d 65 6e 74 20 61 74 74 61 63 68 65   comment attache
0200: 64 20 74 6f 20 0a 2a 2a 20 74 68 65 20 69 6d 70  d to .** the imp
0210: 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 65  lementation of e
0220: 61 63 68 20 66 75 6e 63 74 69 6f 6e 20 69 6e 20  ach function in 
0230: 6c 6f 67 2e 63 20 66 6f 72 20 66 75 72 74 68 65  log.c for furthe
0240: 72 20 64 65 74 61 69 6c 73 2e 0a 2a 2f 0a 0a 23  r details..*/..#
0250: 69 66 6e 64 65 66 20 5f 57 41 4c 5f 48 5f 0a 23  ifndef _WAL_H_.#
0260: 64 65 66 69 6e 65 20 5f 57 41 4c 5f 48 5f 0a 0a  define _WAL_H_..
0270: 23 69 6e 63 6c 75 64 65 20 22 73 71 6c 69 74 65  #include "sqlite
0280: 49 6e 74 2e 68 22 0a 0a 2f 2a 20 41 64 64 69 74  Int.h"../* Addit
0290: 69 6f 6e 61 6c 20 76 61 6c 75 65 73 20 74 68 61  ional values tha
02a0: 74 20 63 61 6e 20 62 65 20 61 64 64 65 64 20 74  t can be added t
02b0: 6f 20 74 68 65 20 73 79 6e 63 5f 66 6c 61 67 73  o the sync_flags
02c0: 20 61 72 67 75 6d 65 6e 74 20 6f 66 0a 2a 2a 20   argument of.** 
02d0: 73 71 6c 69 74 65 33 57 61 6c 46 72 61 6d 65 73  sqlite3WalFrames
02e0: 28 29 3a 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 57  ():.*/.#define W
02f0: 41 4c 5f 53 59 4e 43 5f 54 52 41 4e 53 41 43 54  AL_SYNC_TRANSACT
0300: 49 4f 4e 53 20 20 30 78 32 30 20 20 20 2f 2a 20  IONS  0x20   /* 
0310: 53 79 6e 63 20 61 74 20 74 68 65 20 65 6e 64 20  Sync at the end 
0320: 6f 66 20 65 61 63 68 20 74 72 61 6e 73 61 63 74  of each transact
0330: 69 6f 6e 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ion */.#define S
0340: 51 4c 49 54 45 5f 53 59 4e 43 5f 4d 41 53 4b 20  QLITE_SYNC_MASK 
0350: 20 20 20 20 20 20 30 78 31 33 20 20 20 2f 2a 20        0x13   /* 
0360: 4d 61 73 6b 20 6f 66 66 20 74 68 65 20 53 51 4c  Mask off the SQL
0370: 49 54 45 5f 53 59 4e 43 5f 2a 20 76 61 6c 75 65  ITE_SYNC_* value
0380: 73 20 2a 2f 0a 0a 23 69 66 64 65 66 20 53 51 4c  s */..#ifdef SQL
0390: 49 54 45 5f 4f 4d 49 54 5f 57 41 4c 0a 23 20 64  ITE_OMIT_WAL.# d
03a0: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c  efine sqlite3Wal
03b0: 4f 70 65 6e 28 78 2c 79 2c 7a 29 20 20 20 20 20  Open(x,y,z)     
03c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0a                0.
03d0: 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33  # define sqlite3
03e0: 57 61 6c 4c 69 6d 69 74 28 78 2c 79 29 0a 23 20  WalLimit(x,y).# 
03f0: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61  define sqlite3Wa
0400: 6c 43 6c 6f 73 65 28 77 2c 78 2c 79 2c 7a 29 20  lClose(w,x,y,z) 
0410: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30                 0
0420: 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65  .# define sqlite
0430: 33 57 61 6c 42 65 67 69 6e 52 65 61 64 54 72 61  3WalBeginReadTra
0440: 6e 73 61 63 74 69 6f 6e 28 79 2c 7a 29 20 20 20  nsaction(y,z)   
0450: 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c    0.# define sql
0460: 69 74 65 33 57 61 6c 45 6e 64 52 65 61 64 54 72  ite3WalEndReadTr
0470: 61 6e 73 61 63 74 69 6f 6e 28 7a 29 0a 23 20 64  ansaction(z).# d
0480: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c  efine sqlite3Wal
0490: 44 62 73 69 7a 65 28 79 29 20 20 20 20 20 20 20  Dbsize(y)       
04a0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0a                0.
04b0: 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33  # define sqlite3
04c0: 57 61 6c 42 65 67 69 6e 57 72 69 74 65 54 72 61  WalBeginWriteTra
04d0: 6e 73 61 63 74 69 6f 6e 28 79 29 20 20 20 20 20  nsaction(y)     
04e0: 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69   0.# define sqli
04f0: 74 65 33 57 61 6c 45 6e 64 57 72 69 74 65 54 72  te3WalEndWriteTr
0500: 61 6e 73 61 63 74 69 6f 6e 28 78 29 20 20 20 20  ansaction(x)    
0510: 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73      0.# define s
0520: 71 6c 69 74 65 33 57 61 6c 55 6e 64 6f 28 78 2c  qlite3WalUndo(x,
0530: 79 2c 7a 29 20 20 20 20 20 20 20 20 20 20 20 20  y,z)            
0540: 20 20 20 20 20 20 20 30 0a 23 20 64 65 66 69 6e         0.# defin
0550: 65 20 73 71 6c 69 74 65 33 57 61 6c 53 61 76 65  e sqlite3WalSave
0560: 70 6f 69 6e 74 28 79 2c 7a 29 0a 23 20 64 65 66  point(y,z).# def
0570: 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 53 61  ine sqlite3WalSa
0580: 76 65 70 6f 69 6e 74 55 6e 64 6f 28 79 2c 7a 29  vepointUndo(y,z)
0590: 20 20 20 20 20 20 20 20 20 20 20 20 30 0a 23 20              0.# 
05a0: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61  define sqlite3Wa
05b0: 6c 46 72 61 6d 65 73 28 75 2c 76 2c 77 2c 78 2c  lFrames(u,v,w,x,
05c0: 79 2c 7a 29 20 20 20 20 20 20 20 20 20 20 20 30  y,z)           0
05d0: 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65  .# define sqlite
05e0: 33 57 61 6c 43 68 65 63 6b 70 6f 69 6e 74 28 72  3WalCheckpoint(r
05f0: 2c 73 2c 74 2c 75 2c 76 2c 77 2c 78 2c 79 2c 7a  ,s,t,u,v,w,x,y,z
0600: 29 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c  ) 0.# define sql
0610: 69 74 65 33 57 61 6c 43 61 6c 6c 62 61 63 6b 28  ite3WalCallback(
0620: 7a 29 20 20 20 20 20 20 20 20 20 20 20 20 20 20  z)              
0630: 20 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20       0.# define 
0640: 73 71 6c 69 74 65 33 57 61 6c 45 78 63 6c 75 73  sqlite3WalExclus
0650: 69 76 65 4d 6f 64 65 28 79 2c 7a 29 20 20 20 20  iveMode(y,z)    
0660: 20 20 20 20 20 20 20 20 30 0a 23 20 64 65 66 69          0.# defi
0670: 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 48 65 61  ne sqlite3WalHea
0680: 70 4d 65 6d 6f 72 79 28 7a 29 20 20 20 20 20 20  pMemory(z)      
0690: 20 20 20 20 20 20 20 20 20 20 20 30 0a 23 20 64             0.# d
06a0: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c  efine sqlite3Wal
06b0: 46 72 61 6d 65 73 69 7a 65 28 7a 29 20 20 20 20  Framesize(z)    
06c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0a                0.
06d0: 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33  # define sqlite3
06e0: 57 61 6c 46 69 6e 64 46 72 61 6d 65 28 78 2c 79  WalFindFrame(x,y
06f0: 2c 7a 29 20 20 20 20 20 20 20 20 20 20 20 20 20  ,z)             
0700: 20 30 0a 23 65 6c 73 65 0a 0a 23 64 65 66 69 6e   0.#else..#defin
0710: 65 20 57 41 4c 5f 53 41 56 45 50 4f 49 4e 54 5f  e WAL_SAVEPOINT_
0720: 4e 44 41 54 41 20 34 0a 0a 2f 2a 20 43 6f 6e 6e  NDATA 4../* Conn
0730: 65 63 74 69 6f 6e 20 74 6f 20 61 20 77 72 69 74  ection to a writ
0740: 65 2d 61 68 65 61 64 20 6c 6f 67 20 28 57 41 4c  e-ahead log (WAL
0750: 29 20 66 69 6c 65 2e 20 0a 2a 2a 20 54 68 65 72  ) file. .** Ther
0760: 65 20 69 73 20 6f 6e 65 20 6f 62 6a 65 63 74 20  e is one object 
0770: 6f 66 20 74 68 69 73 20 74 79 70 65 20 66 6f 72  of this type for
0780: 20 65 61 63 68 20 70 61 67 65 72 2e 20 0a 2a 2f   each pager. .*/
0790: 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
07a0: 57 61 6c 20 57 61 6c 3b 0a 0a 2f 2a 20 4f 70 65  Wal Wal;../* Ope
07b0: 6e 20 61 6e 64 20 63 6c 6f 73 65 20 61 20 63 6f  n and close a co
07c0: 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 61 20 77 72  nnection to a wr
07d0: 69 74 65 2d 61 68 65 61 64 20 6c 6f 67 2e 20 2a  ite-ahead log. *
07e0: 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c  /.int sqlite3Wal
07f0: 4f 70 65 6e 28 73 71 6c 69 74 65 33 5f 76 66 73  Open(sqlite3_vfs
0800: 2a 2c 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a  *, sqlite3_file*
0810: 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 2c 20  , const char *, 
0820: 69 6e 74 2c 20 69 36 34 2c 20 69 6e 74 2c 20 57  int, i64, int, W
0830: 61 6c 2a 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  al**);.int sqlit
0840: 65 33 57 61 6c 43 6c 6f 73 65 28 57 61 6c 20 2a  e3WalClose(Wal *
0850: 70 57 61 6c 2c 20 69 6e 74 20 73 79 6e 63 5f 66  pWal, int sync_f
0860: 6c 61 67 73 2c 20 69 6e 74 2c 20 75 38 20 2a 29  lags, int, u8 *)
0870: 3b 0a 0a 2f 2a 20 53 65 74 20 74 68 65 20 6c 69  ;../* Set the li
0880: 6d 69 74 69 6e 67 20 73 69 7a 65 20 6f 66 20 61  miting size of a
0890: 20 57 41 4c 20 66 69 6c 65 2e 20 2a 2f 0a 76 6f   WAL file. */.vo
08a0: 69 64 20 73 71 6c 69 74 65 33 57 61 6c 4c 69 6d  id sqlite3WalLim
08b0: 69 74 28 57 61 6c 2a 2c 20 69 36 34 29 3b 0a 0a  it(Wal*, i64);..
08c0: 2f 2a 20 55 73 65 64 20 62 79 20 72 65 61 64 65  /* Used by reade
08d0: 72 73 20 74 6f 20 6f 70 65 6e 20 28 6c 6f 63 6b  rs to open (lock
08e0: 29 20 61 6e 64 20 63 6c 6f 73 65 20 28 75 6e 6c  ) and close (unl
08f0: 6f 63 6b 29 20 61 20 73 6e 61 70 73 68 6f 74 2e  ock) a snapshot.
0900: 20 20 41 20 0a 2a 2a 20 73 6e 61 70 73 68 6f 74    A .** snapshot
0910: 20 69 73 20 6c 69 6b 65 20 61 20 72 65 61 64 2d   is like a read-
0920: 74 72 61 6e 73 61 63 74 69 6f 6e 2e 20 20 49 74  transaction.  It
0930: 20 69 73 20 74 68 65 20 73 74 61 74 65 20 6f 66   is the state of
0940: 20 74 68 65 20 64 61 74 61 62 61 73 65 0a 2a 2a   the database.**
0950: 20 61 74 20 61 6e 20 69 6e 73 74 61 6e 74 20 69   at an instant i
0960: 6e 20 74 69 6d 65 2e 20 20 73 71 6c 69 74 65 33  n time.  sqlite3
0970: 57 61 6c 4f 70 65 6e 53 6e 61 70 73 68 6f 74 20  WalOpenSnapshot 
0980: 67 65 74 73 20 61 20 72 65 61 64 20 6c 6f 63 6b  gets a read lock
0990: 20 61 6e 64 0a 2a 2a 20 70 72 65 73 65 72 76 65   and.** preserve
09a0: 73 20 74 68 65 20 63 75 72 72 65 6e 74 20 73 74  s the current st
09b0: 61 74 65 20 65 76 65 6e 20 69 66 20 74 68 65 20  ate even if the 
09c0: 6f 74 68 65 72 20 74 68 72 65 61 64 73 20 6f 72  other threads or
09d0: 20 70 72 6f 63 65 73 73 65 73 0a 2a 2a 20 77 72   processes.** wr
09e0: 69 74 65 20 74 6f 20 6f 72 20 63 68 65 63 6b 70  ite to or checkp
09f0: 6f 69 6e 74 20 74 68 65 20 57 41 4c 2e 20 20 73  oint the WAL.  s
0a00: 71 6c 69 74 65 33 57 61 6c 43 6c 6f 73 65 53 6e  qlite3WalCloseSn
0a10: 61 70 73 68 6f 74 28 29 20 63 6c 6f 73 65 73 20  apshot() closes 
0a20: 74 68 65 0a 2a 2a 20 74 72 61 6e 73 61 63 74 69  the.** transacti
0a30: 6f 6e 20 61 6e 64 20 72 65 6c 65 61 73 65 73 20  on and releases 
0a40: 74 68 65 20 6c 6f 63 6b 2e 0a 2a 2f 0a 69 6e 74  the lock..*/.int
0a50: 20 73 71 6c 69 74 65 33 57 61 6c 42 65 67 69 6e   sqlite3WalBegin
0a60: 52 65 61 64 54 72 61 6e 73 61 63 74 69 6f 6e 28  ReadTransaction(
0a70: 57 61 6c 20 2a 70 57 61 6c 2c 20 69 6e 74 20 2a  Wal *pWal, int *
0a80: 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57  );.void sqlite3W
0a90: 61 6c 45 6e 64 52 65 61 64 54 72 61 6e 73 61 63  alEndReadTransac
0aa0: 74 69 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 29 3b  tion(Wal *pWal);
0ab0: 0a 0a 2f 2a 20 52 65 61 64 20 61 20 70 61 67 65  ../* Read a page
0ac0: 20 66 72 6f 6d 20 74 68 65 20 77 72 69 74 65 2d   from the write-
0ad0: 61 68 65 61 64 20 6c 6f 67 2c 20 69 66 20 69 74  ahead log, if it
0ae0: 20 69 73 20 70 72 65 73 65 6e 74 2e 20 2a 2f 0a   is present. */.
0af0: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 46 69  int sqlite3WalFi
0b00: 6e 64 46 72 61 6d 65 28 57 61 6c 20 2a 2c 20 50  ndFrame(Wal *, P
0b10: 67 6e 6f 2c 20 75 33 32 20 2a 29 3b 0a 69 6e 74  gno, u32 *);.int
0b20: 20 73 71 6c 69 74 65 33 57 61 6c 52 65 61 64 46   sqlite3WalReadF
0b30: 72 61 6d 65 28 57 61 6c 20 2a 2c 20 75 33 32 2c  rame(Wal *, u32,
0b40: 20 69 6e 74 2c 20 75 38 20 2a 29 3b 0a 0a 2f 2a   int, u8 *);../*
0b50: 20 49 66 20 74 68 65 20 57 41 4c 20 69 73 20 6e   If the WAL is n
0b60: 6f 74 20 65 6d 70 74 79 2c 20 72 65 74 75 72 6e  ot empty, return
0b70: 20 74 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65   the size of the
0b80: 20 64 61 74 61 62 61 73 65 2e 20 2a 2f 0a 50 67   database. */.Pg
0b90: 6e 6f 20 73 71 6c 69 74 65 33 57 61 6c 44 62 73  no sqlite3WalDbs
0ba0: 69 7a 65 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a  ize(Wal *pWal);.
0bb0: 0a 2f 2a 20 49 66 20 61 20 57 41 4c 20 6a 6f 75  ./* If a WAL jou
0bc0: 72 6e 61 6c 20 66 69 6c 65 20 68 61 73 20 62 65  rnal file has be
0bd0: 65 6e 20 63 72 65 61 74 65 64 2c 20 72 65 74 75  en created, retu
0be0: 72 6e 20 69 74 20 2a 2f 0a 73 71 6c 69 74 65 33  rn it */.sqlite3
0bf0: 5f 66 69 6c 65 20 2a 73 71 6c 69 74 65 33 57 61  _file *sqlite3Wa
0c00: 6c 46 69 6c 65 28 57 61 6c 20 2a 70 57 61 6c 29  lFile(Wal *pWal)
0c10: 3b 0a 20 20 0a 2f 2a 20 4f 62 74 61 69 6e 20 6f  ;.  ./* Obtain o
0c20: 72 20 72 65 6c 65 61 73 65 20 74 68 65 20 57 52  r release the WR
0c30: 49 54 45 52 20 6c 6f 63 6b 2e 20 2a 2f 0a 69 6e  ITER lock. */.in
0c40: 74 20 73 71 6c 69 74 65 33 57 61 6c 42 65 67 69  t sqlite3WalBegi
0c50: 6e 57 72 69 74 65 54 72 61 6e 73 61 63 74 69 6f  nWriteTransactio
0c60: 6e 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 69 6e  n(Wal *pWal);.in
0c70: 74 20 73 71 6c 69 74 65 33 57 61 6c 45 6e 64 57  t sqlite3WalEndW
0c80: 72 69 74 65 54 72 61 6e 73 61 63 74 69 6f 6e 28  riteTransaction(
0c90: 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20  Wal *pWal);../* 
0ca0: 55 6e 64 6f 20 61 6e 79 20 66 72 61 6d 65 73 20  Undo any frames 
0cb0: 77 72 69 74 74 65 6e 20 28 62 75 74 20 6e 6f 74  written (but not
0cc0: 20 63 6f 6d 6d 69 74 74 65 64 29 20 74 6f 20 74   committed) to t
0cd0: 68 65 20 6c 6f 67 20 2a 2f 0a 69 6e 74 20 73 71  he log */.int sq
0ce0: 6c 69 74 65 33 57 61 6c 55 6e 64 6f 28 57 61 6c  lite3WalUndo(Wal
0cf0: 20 2a 70 57 61 6c 2c 20 69 6e 74 20 28 2a 78 55   *pWal, int (*xU
0d00: 6e 64 6f 29 28 76 6f 69 64 20 2a 2c 20 50 67 6e  ndo)(void *, Pgn
0d10: 6f 29 2c 20 76 6f 69 64 20 2a 70 55 6e 64 6f 43  o), void *pUndoC
0d20: 74 78 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20  tx);../* Return 
0d30: 61 6e 20 69 6e 74 65 67 65 72 20 74 68 61 74 20  an integer that 
0d40: 72 65 63 6f 72 64 73 20 74 68 65 20 63 75 72 72  records the curr
0d50: 65 6e 74 20 28 75 6e 63 6f 6d 6d 69 74 74 65 64  ent (uncommitted
0d60: 29 20 77 72 69 74 65 0a 2a 2a 20 70 6f 73 69 74  ) write.** posit
0d70: 69 6f 6e 20 69 6e 20 74 68 65 20 57 41 4c 20 2a  ion in the WAL *
0d80: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61  /.void sqlite3Wa
0d90: 6c 53 61 76 65 70 6f 69 6e 74 28 57 61 6c 20 2a  lSavepoint(Wal *
0da0: 70 57 61 6c 2c 20 75 33 32 20 2a 61 57 61 6c 44  pWal, u32 *aWalD
0db0: 61 74 61 29 3b 0a 0a 2f 2a 20 4d 6f 76 65 20 74  ata);../* Move t
0dc0: 68 65 20 77 72 69 74 65 20 70 6f 73 69 74 69 6f  he write positio
0dd0: 6e 20 6f 66 20 74 68 65 20 57 41 4c 20 62 61 63  n of the WAL bac
0de0: 6b 20 74 6f 20 69 46 72 61 6d 65 2e 20 20 43 61  k to iFrame.  Ca
0df0: 6c 6c 65 64 20 69 6e 0a 2a 2a 20 72 65 73 70 6f  lled in.** respo
0e00: 6e 73 65 20 74 6f 20 61 20 52 4f 4c 4c 42 41 43  nse to a ROLLBAC
0e10: 4b 20 54 4f 20 63 6f 6d 6d 61 6e 64 2e 20 2a 2f  K TO command. */
0e20: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 53  .int sqlite3WalS
0e30: 61 76 65 70 6f 69 6e 74 55 6e 64 6f 28 57 61 6c  avepointUndo(Wal
0e40: 20 2a 70 57 61 6c 2c 20 75 33 32 20 2a 61 57 61   *pWal, u32 *aWa
0e50: 6c 44 61 74 61 29 3b 0a 0a 2f 2a 20 57 72 69 74  lData);../* Writ
0e60: 65 20 61 20 66 72 61 6d 65 20 6f 72 20 66 72 61  e a frame or fra
0e70: 6d 65 73 20 74 6f 20 74 68 65 20 6c 6f 67 2e 20  mes to the log. 
0e80: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  */.int sqlite3Wa
0e90: 6c 46 72 61 6d 65 73 28 57 61 6c 20 2a 70 57 61  lFrames(Wal *pWa
0ea0: 6c 2c 20 69 6e 74 2c 20 50 67 48 64 72 20 2a 2c  l, int, PgHdr *,
0eb0: 20 50 67 6e 6f 2c 20 69 6e 74 2c 20 69 6e 74 29   Pgno, int, int)
0ec0: 3b 0a 0a 2f 2a 20 43 6f 70 79 20 70 61 67 65 73  ;../* Copy pages
0ed0: 20 66 72 6f 6d 20 74 68 65 20 6c 6f 67 20 74 6f   from the log to
0ee0: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69   the database fi
0ef0: 6c 65 20 2a 2f 20 0a 69 6e 74 20 73 71 6c 69 74  le */ .int sqlit
0f00: 65 33 57 61 6c 43 68 65 63 6b 70 6f 69 6e 74 28  e3WalCheckpoint(
0f10: 0a 20 20 57 61 6c 20 2a 70 57 61 6c 2c 20 20 20  .  Wal *pWal,   
0f20: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0f30: 20 20 20 2f 2a 20 57 72 69 74 65 2d 61 68 65 61     /* Write-ahea
0f40: 64 20 6c 6f 67 20 63 6f 6e 6e 65 63 74 69 6f 6e  d log connection
0f50: 20 2a 2f 0a 20 20 69 6e 74 20 65 4d 6f 64 65 2c   */.  int eMode,
0f60: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0f70: 20 20 20 20 20 20 2f 2a 20 4f 6e 65 20 6f 66 20        /* One of 
0f80: 50 41 53 53 49 56 45 2c 20 46 55 4c 4c 20 61 6e  PASSIVE, FULL an
0f90: 64 20 52 45 53 54 41 52 54 20 2a 2f 0a 20 20 69  d RESTART */.  i
0fa0: 6e 74 20 28 2a 78 42 75 73 79 29 28 76 6f 69 64  nt (*xBusy)(void
0fb0: 2a 29 2c 20 20 20 20 20 20 20 20 20 20 20 20 2f  *),            /
0fc0: 2a 20 46 75 6e 63 74 69 6f 6e 20 74 6f 20 63 61  * Function to ca
0fd0: 6c 6c 20 77 68 65 6e 20 62 75 73 79 20 2a 2f 0a  ll when busy */.
0fe0: 20 20 76 6f 69 64 20 2a 70 42 75 73 79 41 72 67    void *pBusyArg
0ff0: 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ,               
1000: 20 20 2f 2a 20 43 6f 6e 74 65 78 74 20 61 72 67    /* Context arg
1010: 75 6d 65 6e 74 20 66 6f 72 20 78 42 75 73 79 48  ument for xBusyH
1020: 61 6e 64 6c 65 72 20 2a 2f 0a 20 20 69 6e 74 20  andler */.  int 
1030: 73 79 6e 63 5f 66 6c 61 67 73 2c 20 20 20 20 20  sync_flags,     
1040: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46              /* F
1050: 6c 61 67 73 20 74 6f 20 73 79 6e 63 20 64 62 20  lags to sync db 
1060: 66 69 6c 65 20 77 69 74 68 20 28 6f 72 20 30 29  file with (or 0)
1070: 20 2a 2f 0a 20 20 69 6e 74 20 6e 42 75 66 2c 20   */.  int nBuf, 
1080: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1090: 20 20 20 20 20 20 2f 2a 20 53 69 7a 65 20 6f 66        /* Size of
10a0: 20 62 75 66 66 65 72 20 6e 42 75 66 20 2a 2f 0a   buffer nBuf */.
10b0: 20 20 75 38 20 2a 7a 42 75 66 2c 20 20 20 20 20    u8 *zBuf,     
10c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
10d0: 20 20 2f 2a 20 54 65 6d 70 6f 72 61 72 79 20 62    /* Temporary b
10e0: 75 66 66 65 72 20 74 6f 20 75 73 65 20 2a 2f 0a  uffer to use */.
10f0: 20 20 69 6e 74 20 2a 70 6e 4c 6f 67 2c 20 20 20    int *pnLog,   
1100: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1110: 20 20 2f 2a 20 4f 55 54 3a 20 4e 75 6d 62 65 72    /* OUT: Number
1120: 20 6f 66 20 66 72 61 6d 65 73 20 69 6e 20 57 41   of frames in WA
1130: 4c 20 2a 2f 0a 20 20 69 6e 74 20 2a 70 6e 43 6b  L */.  int *pnCk
1140: 70 74 20 20 20 20 20 20 20 20 20 20 20 20 20 20  pt              
1150: 20 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a 20 4e         /* OUT: N
1160: 75 6d 62 65 72 20 6f 66 20 62 61 63 6b 66 69 6c  umber of backfil
1170: 6c 65 64 20 66 72 61 6d 65 73 20 69 6e 20 57 41  led frames in WA
1180: 4c 20 2a 2f 0a 29 3b 0a 0a 2f 2a 20 52 65 74 75  L */.);../* Retu
1190: 72 6e 20 74 68 65 20 76 61 6c 75 65 20 74 6f 20  rn the value to 
11a0: 70 61 73 73 20 74 6f 20 61 20 73 71 6c 69 74 65  pass to a sqlite
11b0: 33 5f 77 61 6c 5f 68 6f 6f 6b 20 63 61 6c 6c 62  3_wal_hook callb
11c0: 61 63 6b 2c 20 74 68 65 0a 2a 2a 20 6e 75 6d 62  ack, the.** numb
11d0: 65 72 20 6f 66 20 66 72 61 6d 65 73 20 69 6e 20  er of frames in 
11e0: 74 68 65 20 57 41 4c 20 61 74 20 74 68 65 20 70  the WAL at the p
11f0: 6f 69 6e 74 20 6f 66 20 74 68 65 20 6c 61 73 74  oint of the last
1200: 20 63 6f 6d 6d 69 74 20 73 69 6e 63 65 0a 2a 2a   commit since.**
1210: 20 73 71 6c 69 74 65 33 57 61 6c 43 61 6c 6c 62   sqlite3WalCallb
1220: 61 63 6b 28 29 20 77 61 73 20 63 61 6c 6c 65 64  ack() was called
1230: 2e 20 20 49 66 20 6e 6f 20 63 6f 6d 6d 69 74 73  .  If no commits
1240: 20 68 61 76 65 20 6f 63 63 75 72 72 65 64 20 73   have occurred s
1250: 69 6e 63 65 0a 2a 2a 20 74 68 65 20 6c 61 73 74  ince.** the last
1260: 20 63 61 6c 6c 2c 20 74 68 65 6e 20 72 65 74 75   call, then retu
1270: 72 6e 20 30 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  rn 0..*/.int sql
1280: 69 74 65 33 57 61 6c 43 61 6c 6c 62 61 63 6b 28  ite3WalCallback(
1290: 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20  Wal *pWal);../* 
12a0: 54 65 6c 6c 20 74 68 65 20 77 61 6c 20 6c 61 79  Tell the wal lay
12b0: 65 72 20 74 68 61 74 20 61 6e 20 45 58 43 4c 55  er that an EXCLU
12c0: 53 49 56 45 20 6c 6f 63 6b 20 68 61 73 20 62 65  SIVE lock has be
12d0: 65 6e 20 6f 62 74 61 69 6e 65 64 20 28 6f 72 20  en obtained (or 
12e0: 72 65 6c 65 61 73 65 64 29 0a 2a 2a 20 62 79 20  released).** by 
12f0: 74 68 65 20 70 61 67 65 72 20 6c 61 79 65 72 20  the pager layer 
1300: 6f 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20  on the database 
1310: 66 69 6c 65 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  file..*/.int sql
1320: 69 74 65 33 57 61 6c 45 78 63 6c 75 73 69 76 65  ite3WalExclusive
1330: 4d 6f 64 65 28 57 61 6c 20 2a 70 57 61 6c 2c 20  Mode(Wal *pWal, 
1340: 69 6e 74 20 6f 70 29 3b 0a 0a 2f 2a 20 52 65 74  int op);../* Ret
1350: 75 72 6e 20 74 72 75 65 20 69 66 20 74 68 65 20  urn true if the 
1360: 61 72 67 75 6d 65 6e 74 20 69 73 20 6e 6f 6e 2d  argument is non-
1370: 4e 55 4c 4c 20 61 6e 64 20 74 68 65 20 57 41 4c  NULL and the WAL
1380: 20 6d 6f 64 75 6c 65 20 69 73 20 75 73 69 6e 67   module is using
1390: 0a 2a 2a 20 68 65 61 70 2d 6d 65 6d 6f 72 79 20  .** heap-memory 
13a0: 66 6f 72 20 74 68 65 20 77 61 6c 2d 69 6e 64 65  for the wal-inde
13b0: 78 2e 20 4f 74 68 65 72 77 69 73 65 2c 20 69 66  x. Otherwise, if
13c0: 20 74 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73   the argument is
13d0: 20 4e 55 4c 4c 20 6f 72 20 74 68 65 0a 2a 2a 20   NULL or the.** 
13e0: 57 41 4c 20 6d 6f 64 75 6c 65 20 69 73 20 75 73  WAL module is us
13f0: 69 6e 67 20 73 68 61 72 65 64 2d 6d 65 6d 6f 72  ing shared-memor
1400: 79 2c 20 72 65 74 75 72 6e 20 66 61 6c 73 65 2e  y, return false.
1410: 20 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33   .*/.int sqlite3
1420: 57 61 6c 48 65 61 70 4d 65 6d 6f 72 79 28 57 61  WalHeapMemory(Wa
1430: 6c 20 2a 70 57 61 6c 29 3b 0a 0a 23 69 66 64 65  l *pWal);..#ifde
1440: 66 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f  f SQLITE_ENABLE_
1450: 5a 49 50 56 46 53 0a 2f 2a 20 49 66 20 74 68 65  ZIPVFS./* If the
1460: 20 57 41 4c 20 66 69 6c 65 20 69 73 20 6e 6f 74   WAL file is not
1470: 20 65 6d 70 74 79 2c 20 72 65 74 75 72 6e 20 74   empty, return t
1480: 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74  he number of byt
1490: 65 73 20 6f 66 20 63 6f 6e 74 65 6e 74 0a 2a 2a  es of content.**
14a0: 20 73 74 6f 72 65 64 20 69 6e 20 65 61 63 68 20   stored in each 
14b0: 66 72 61 6d 65 20 28 69 2e 65 2e 20 74 68 65 20  frame (i.e. the 
14c0: 64 62 20 70 61 67 65 2d 73 69 7a 65 20 77 68 65  db page-size whe
14d0: 6e 20 74 68 65 20 57 41 4c 20 77 61 73 20 63 72  n the WAL was cr
14e0: 65 61 74 65 64 29 2e 0a 2a 2f 0a 69 6e 74 20 73  eated)..*/.int s
14f0: 71 6c 69 74 65 33 57 61 6c 46 72 61 6d 65 73 69  qlite3WalFramesi
1500: 7a 65 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 23  ze(Wal *pWal);.#
1510: 65 6e 64 69 66 0a 0a 23 65 6e 64 69 66 20 2f 2a  endif..#endif /*
1520: 20 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f   ifndef SQLITE_O
1530: 4d 49 54 5f 57 41 4c 20 2a 2f 0a 23 65 6e 64 69  MIT_WAL */.#endi
1540: 66 20 2f 2a 20 5f 57 41 4c 5f 48 5f 20 2a 2f 0a  f /* _WAL_H_ */.