/ Hex Artifact Content
Login

Artifact 29c2a284ddd9c665199273dadc7255a227092291:


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 20 64 65 66 69 6e 65 20 73 71 6c 69   0.# define sqli
0710: 74 65 33 57 61 6c 46 69 6c 65 28 78 29 20 20 20  te3WalFile(x)   
0720: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0730: 20 20 20 20 30 0a 23 65 6c 73 65 0a 0a 23 64 65      0.#else..#de
0740: 66 69 6e 65 20 57 41 4c 5f 53 41 56 45 50 4f 49  fine WAL_SAVEPOI
0750: 4e 54 5f 4e 44 41 54 41 20 34 0a 0a 2f 2a 20 43  NT_NDATA 4../* C
0760: 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 61 20 77  onnection to a w
0770: 72 69 74 65 2d 61 68 65 61 64 20 6c 6f 67 20 28  rite-ahead log (
0780: 57 41 4c 29 20 66 69 6c 65 2e 20 0a 2a 2a 20 54  WAL) file. .** T
0790: 68 65 72 65 20 69 73 20 6f 6e 65 20 6f 62 6a 65  here is one obje
07a0: 63 74 20 6f 66 20 74 68 69 73 20 74 79 70 65 20  ct of this type 
07b0: 66 6f 72 20 65 61 63 68 20 70 61 67 65 72 2e 20  for each pager. 
07c0: 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74 72 75  .*/.typedef stru
07d0: 63 74 20 57 61 6c 20 57 61 6c 3b 0a 0a 2f 2a 20  ct Wal Wal;../* 
07e0: 4f 70 65 6e 20 61 6e 64 20 63 6c 6f 73 65 20 61  Open and close a
07f0: 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 61   connection to a
0800: 20 77 72 69 74 65 2d 61 68 65 61 64 20 6c 6f 67   write-ahead log
0810: 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  . */.int sqlite3
0820: 57 61 6c 4f 70 65 6e 28 73 71 6c 69 74 65 33 5f  WalOpen(sqlite3_
0830: 76 66 73 2a 2c 20 73 71 6c 69 74 65 33 5f 66 69  vfs*, sqlite3_fi
0840: 6c 65 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72 20  le*, const char 
0850: 2a 2c 20 69 6e 74 2c 20 69 36 34 2c 20 69 6e 74  *, int, i64, int
0860: 2c 20 57 61 6c 2a 2a 29 3b 0a 69 6e 74 20 73 71  , Wal**);.int sq
0870: 6c 69 74 65 33 57 61 6c 43 6c 6f 73 65 28 57 61  lite3WalClose(Wa
0880: 6c 20 2a 70 57 61 6c 2c 20 69 6e 74 20 73 79 6e  l *pWal, int syn
0890: 63 5f 66 6c 61 67 73 2c 20 69 6e 74 2c 20 75 38  c_flags, int, u8
08a0: 20 2a 29 3b 0a 0a 2f 2a 20 53 65 74 20 74 68 65   *);../* Set the
08b0: 20 6c 69 6d 69 74 69 6e 67 20 73 69 7a 65 20 6f   limiting size o
08c0: 66 20 61 20 57 41 4c 20 66 69 6c 65 2e 20 2a 2f  f a WAL file. */
08d0: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61 6c  .void sqlite3Wal
08e0: 4c 69 6d 69 74 28 57 61 6c 2a 2c 20 69 36 34 29  Limit(Wal*, i64)
08f0: 3b 0a 0a 2f 2a 20 55 73 65 64 20 62 79 20 72 65  ;../* Used by re
0900: 61 64 65 72 73 20 74 6f 20 6f 70 65 6e 20 28 6c  aders to open (l
0910: 6f 63 6b 29 20 61 6e 64 20 63 6c 6f 73 65 20 28  ock) and close (
0920: 75 6e 6c 6f 63 6b 29 20 61 20 73 6e 61 70 73 68  unlock) a snapsh
0930: 6f 74 2e 20 20 41 20 0a 2a 2a 20 73 6e 61 70 73  ot.  A .** snaps
0940: 68 6f 74 20 69 73 20 6c 69 6b 65 20 61 20 72 65  hot is like a re
0950: 61 64 2d 74 72 61 6e 73 61 63 74 69 6f 6e 2e 20  ad-transaction. 
0960: 20 49 74 20 69 73 20 74 68 65 20 73 74 61 74 65   It is the state
0970: 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73 65   of the database
0980: 0a 2a 2a 20 61 74 20 61 6e 20 69 6e 73 74 61 6e  .** at an instan
0990: 74 20 69 6e 20 74 69 6d 65 2e 20 20 73 71 6c 69  t in time.  sqli
09a0: 74 65 33 57 61 6c 4f 70 65 6e 53 6e 61 70 73 68  te3WalOpenSnapsh
09b0: 6f 74 20 67 65 74 73 20 61 20 72 65 61 64 20 6c  ot gets a read l
09c0: 6f 63 6b 20 61 6e 64 0a 2a 2a 20 70 72 65 73 65  ock and.** prese
09d0: 72 76 65 73 20 74 68 65 20 63 75 72 72 65 6e 74  rves the current
09e0: 20 73 74 61 74 65 20 65 76 65 6e 20 69 66 20 74   state even if t
09f0: 68 65 20 6f 74 68 65 72 20 74 68 72 65 61 64 73  he other threads
0a00: 20 6f 72 20 70 72 6f 63 65 73 73 65 73 0a 2a 2a   or processes.**
0a10: 20 77 72 69 74 65 20 74 6f 20 6f 72 20 63 68 65   write to or che
0a20: 63 6b 70 6f 69 6e 74 20 74 68 65 20 57 41 4c 2e  ckpoint the WAL.
0a30: 20 20 73 71 6c 69 74 65 33 57 61 6c 43 6c 6f 73    sqlite3WalClos
0a40: 65 53 6e 61 70 73 68 6f 74 28 29 20 63 6c 6f 73  eSnapshot() clos
0a50: 65 73 20 74 68 65 0a 2a 2a 20 74 72 61 6e 73 61  es the.** transa
0a60: 63 74 69 6f 6e 20 61 6e 64 20 72 65 6c 65 61 73  ction and releas
0a70: 65 73 20 74 68 65 20 6c 6f 63 6b 2e 0a 2a 2f 0a  es the lock..*/.
0a80: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 42 65  int sqlite3WalBe
0a90: 67 69 6e 52 65 61 64 54 72 61 6e 73 61 63 74 69  ginReadTransacti
0aa0: 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69 6e  on(Wal *pWal, in
0ab0: 74 20 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74  t *);.void sqlit
0ac0: 65 33 57 61 6c 45 6e 64 52 65 61 64 54 72 61 6e  e3WalEndReadTran
0ad0: 73 61 63 74 69 6f 6e 28 57 61 6c 20 2a 70 57 61  saction(Wal *pWa
0ae0: 6c 29 3b 0a 0a 2f 2a 20 52 65 61 64 20 61 20 70  l);../* Read a p
0af0: 61 67 65 20 66 72 6f 6d 20 74 68 65 20 77 72 69  age from the wri
0b00: 74 65 2d 61 68 65 61 64 20 6c 6f 67 2c 20 69 66  te-ahead log, if
0b10: 20 69 74 20 69 73 20 70 72 65 73 65 6e 74 2e 20   it is present. 
0b20: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  */.int sqlite3Wa
0b30: 6c 46 69 6e 64 46 72 61 6d 65 28 57 61 6c 20 2a  lFindFrame(Wal *
0b40: 2c 20 50 67 6e 6f 2c 20 75 33 32 20 2a 29 3b 0a  , Pgno, u32 *);.
0b50: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 52 65  int sqlite3WalRe
0b60: 61 64 46 72 61 6d 65 28 57 61 6c 20 2a 2c 20 75  adFrame(Wal *, u
0b70: 33 32 2c 20 69 6e 74 2c 20 75 38 20 2a 29 3b 0a  32, int, u8 *);.
0b80: 0a 2f 2a 20 49 66 20 74 68 65 20 57 41 4c 20 69  ./* If the WAL i
0b90: 73 20 6e 6f 74 20 65 6d 70 74 79 2c 20 72 65 74  s not empty, ret
0ba0: 75 72 6e 20 74 68 65 20 73 69 7a 65 20 6f 66 20  urn the size of 
0bb0: 74 68 65 20 64 61 74 61 62 61 73 65 2e 20 2a 2f  the database. */
0bc0: 0a 50 67 6e 6f 20 73 71 6c 69 74 65 33 57 61 6c  .Pgno sqlite3Wal
0bd0: 44 62 73 69 7a 65 28 57 61 6c 20 2a 70 57 61 6c  Dbsize(Wal *pWal
0be0: 29 3b 0a 0a 2f 2a 20 49 66 20 61 20 57 41 4c 20  );../* If a WAL 
0bf0: 6a 6f 75 72 6e 61 6c 20 66 69 6c 65 20 68 61 73  journal file has
0c00: 20 62 65 65 6e 20 63 72 65 61 74 65 64 2c 20 72   been created, r
0c10: 65 74 75 72 6e 20 69 74 20 2a 2f 0a 73 71 6c 69  eturn it */.sqli
0c20: 74 65 33 5f 66 69 6c 65 20 2a 73 71 6c 69 74 65  te3_file *sqlite
0c30: 33 57 61 6c 46 69 6c 65 28 57 61 6c 20 2a 70 57  3WalFile(Wal *pW
0c40: 61 6c 29 3b 0a 20 20 0a 2f 2a 20 4f 62 74 61 69  al);.  ./* Obtai
0c50: 6e 20 6f 72 20 72 65 6c 65 61 73 65 20 74 68 65  n or release the
0c60: 20 57 52 49 54 45 52 20 6c 6f 63 6b 2e 20 2a 2f   WRITER lock. */
0c70: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 42  .int sqlite3WalB
0c80: 65 67 69 6e 57 72 69 74 65 54 72 61 6e 73 61 63  eginWriteTransac
0c90: 74 69 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 29 3b  tion(Wal *pWal);
0ca0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 45  .int sqlite3WalE
0cb0: 6e 64 57 72 69 74 65 54 72 61 6e 73 61 63 74 69  ndWriteTransacti
0cc0: 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a  on(Wal *pWal);..
0cd0: 2f 2a 20 55 6e 64 6f 20 61 6e 79 20 66 72 61 6d  /* Undo any fram
0ce0: 65 73 20 77 72 69 74 74 65 6e 20 28 62 75 74 20  es written (but 
0cf0: 6e 6f 74 20 63 6f 6d 6d 69 74 74 65 64 29 20 74  not committed) t
0d00: 6f 20 74 68 65 20 6c 6f 67 20 2a 2f 0a 69 6e 74  o the log */.int
0d10: 20 73 71 6c 69 74 65 33 57 61 6c 55 6e 64 6f 28   sqlite3WalUndo(
0d20: 57 61 6c 20 2a 70 57 61 6c 2c 20 69 6e 74 20 28  Wal *pWal, int (
0d30: 2a 78 55 6e 64 6f 29 28 76 6f 69 64 20 2a 2c 20  *xUndo)(void *, 
0d40: 50 67 6e 6f 29 2c 20 76 6f 69 64 20 2a 70 55 6e  Pgno), void *pUn
0d50: 64 6f 43 74 78 29 3b 0a 0a 2f 2a 20 52 65 74 75  doCtx);../* Retu
0d60: 72 6e 20 61 6e 20 69 6e 74 65 67 65 72 20 74 68  rn an integer th
0d70: 61 74 20 72 65 63 6f 72 64 73 20 74 68 65 20 63  at records the c
0d80: 75 72 72 65 6e 74 20 28 75 6e 63 6f 6d 6d 69 74  urrent (uncommit
0d90: 74 65 64 29 20 77 72 69 74 65 0a 2a 2a 20 70 6f  ted) write.** po
0da0: 73 69 74 69 6f 6e 20 69 6e 20 74 68 65 20 57 41  sition in the WA
0db0: 4c 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65  L */.void sqlite
0dc0: 33 57 61 6c 53 61 76 65 70 6f 69 6e 74 28 57 61  3WalSavepoint(Wa
0dd0: 6c 20 2a 70 57 61 6c 2c 20 75 33 32 20 2a 61 57  l *pWal, u32 *aW
0de0: 61 6c 44 61 74 61 29 3b 0a 0a 2f 2a 20 4d 6f 76  alData);../* Mov
0df0: 65 20 74 68 65 20 77 72 69 74 65 20 70 6f 73 69  e the write posi
0e00: 74 69 6f 6e 20 6f 66 20 74 68 65 20 57 41 4c 20  tion of the WAL 
0e10: 62 61 63 6b 20 74 6f 20 69 46 72 61 6d 65 2e 20  back to iFrame. 
0e20: 20 43 61 6c 6c 65 64 20 69 6e 0a 2a 2a 20 72 65   Called in.** re
0e30: 73 70 6f 6e 73 65 20 74 6f 20 61 20 52 4f 4c 4c  sponse to a ROLL
0e40: 42 41 43 4b 20 54 4f 20 63 6f 6d 6d 61 6e 64 2e  BACK TO command.
0e50: 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57   */.int sqlite3W
0e60: 61 6c 53 61 76 65 70 6f 69 6e 74 55 6e 64 6f 28  alSavepointUndo(
0e70: 57 61 6c 20 2a 70 57 61 6c 2c 20 75 33 32 20 2a  Wal *pWal, u32 *
0e80: 61 57 61 6c 44 61 74 61 29 3b 0a 0a 2f 2a 20 57  aWalData);../* W
0e90: 72 69 74 65 20 61 20 66 72 61 6d 65 20 6f 72 20  rite a frame or 
0ea0: 66 72 61 6d 65 73 20 74 6f 20 74 68 65 20 6c 6f  frames to the lo
0eb0: 67 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  g. */.int sqlite
0ec0: 33 57 61 6c 46 72 61 6d 65 73 28 57 61 6c 20 2a  3WalFrames(Wal *
0ed0: 70 57 61 6c 2c 20 69 6e 74 2c 20 50 67 48 64 72  pWal, int, PgHdr
0ee0: 20 2a 2c 20 50 67 6e 6f 2c 20 69 6e 74 2c 20 69   *, Pgno, int, i
0ef0: 6e 74 29 3b 0a 0a 2f 2a 20 43 6f 70 79 20 70 61  nt);../* Copy pa
0f00: 67 65 73 20 66 72 6f 6d 20 74 68 65 20 6c 6f 67  ges from the log
0f10: 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73 65   to the database
0f20: 20 66 69 6c 65 20 2a 2f 20 0a 69 6e 74 20 73 71   file */ .int sq
0f30: 6c 69 74 65 33 57 61 6c 43 68 65 63 6b 70 6f 69  lite3WalCheckpoi
0f40: 6e 74 28 0a 20 20 57 61 6c 20 2a 70 57 61 6c 2c  nt(.  Wal *pWal,
0f50: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0f60: 20 20 20 20 20 20 2f 2a 20 57 72 69 74 65 2d 61        /* Write-a
0f70: 68 65 61 64 20 6c 6f 67 20 63 6f 6e 6e 65 63 74  head log connect
0f80: 69 6f 6e 20 2a 2f 0a 20 20 69 6e 74 20 65 4d 6f  ion */.  int eMo
0f90: 64 65 2c 20 20 20 20 20 20 20 20 20 20 20 20 20  de,             
0fa0: 20 20 20 20 20 20 20 20 20 2f 2a 20 4f 6e 65 20           /* One 
0fb0: 6f 66 20 50 41 53 53 49 56 45 2c 20 46 55 4c 4c  of PASSIVE, FULL
0fc0: 20 61 6e 64 20 52 45 53 54 41 52 54 20 2a 2f 0a   and RESTART */.
0fd0: 20 20 69 6e 74 20 28 2a 78 42 75 73 79 29 28 76    int (*xBusy)(v
0fe0: 6f 69 64 2a 29 2c 20 20 20 20 20 20 20 20 20 20  oid*),          
0ff0: 20 20 2f 2a 20 46 75 6e 63 74 69 6f 6e 20 74 6f    /* Function to
1000: 20 63 61 6c 6c 20 77 68 65 6e 20 62 75 73 79 20   call when busy 
1010: 2a 2f 0a 20 20 76 6f 69 64 20 2a 70 42 75 73 79  */.  void *pBusy
1020: 41 72 67 2c 20 20 20 20 20 20 20 20 20 20 20 20  Arg,            
1030: 20 20 20 20 20 2f 2a 20 43 6f 6e 74 65 78 74 20       /* Context 
1040: 61 72 67 75 6d 65 6e 74 20 66 6f 72 20 78 42 75  argument for xBu
1050: 73 79 48 61 6e 64 6c 65 72 20 2a 2f 0a 20 20 69  syHandler */.  i
1060: 6e 74 20 73 79 6e 63 5f 66 6c 61 67 73 2c 20 20  nt sync_flags,  
1070: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
1080: 2a 20 46 6c 61 67 73 20 74 6f 20 73 79 6e 63 20  * Flags to sync 
1090: 64 62 20 66 69 6c 65 20 77 69 74 68 20 28 6f 72  db file with (or
10a0: 20 30 29 20 2a 2f 0a 20 20 69 6e 74 20 6e 42 75   0) */.  int nBu
10b0: 66 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  f,              
10c0: 20 20 20 20 20 20 20 20 20 2f 2a 20 53 69 7a 65           /* Size
10d0: 20 6f 66 20 62 75 66 66 65 72 20 6e 42 75 66 20   of buffer nBuf 
10e0: 2a 2f 0a 20 20 75 38 20 2a 7a 42 75 66 2c 20 20  */.  u8 *zBuf,  
10f0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1100: 20 20 20 20 20 2f 2a 20 54 65 6d 70 6f 72 61 72       /* Temporar
1110: 79 20 62 75 66 66 65 72 20 74 6f 20 75 73 65 20  y buffer to use 
1120: 2a 2f 0a 20 20 69 6e 74 20 2a 70 6e 4c 6f 67 2c  */.  int *pnLog,
1130: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1140: 20 20 20 20 20 2f 2a 20 4f 55 54 3a 20 4e 75 6d       /* OUT: Num
1150: 62 65 72 20 6f 66 20 66 72 61 6d 65 73 20 69 6e  ber of frames in
1160: 20 57 41 4c 20 2a 2f 0a 20 20 69 6e 74 20 2a 70   WAL */.  int *p
1170: 6e 43 6b 70 74 20 20 20 20 20 20 20 20 20 20 20  nCkpt           
1180: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4f 55 54            /* OUT
1190: 3a 20 4e 75 6d 62 65 72 20 6f 66 20 62 61 63 6b  : Number of back
11a0: 66 69 6c 6c 65 64 20 66 72 61 6d 65 73 20 69 6e  filled frames in
11b0: 20 57 41 4c 20 2a 2f 0a 29 3b 0a 0a 2f 2a 20 52   WAL */.);../* R
11c0: 65 74 75 72 6e 20 74 68 65 20 76 61 6c 75 65 20  eturn the value 
11d0: 74 6f 20 70 61 73 73 20 74 6f 20 61 20 73 71 6c  to pass to a sql
11e0: 69 74 65 33 5f 77 61 6c 5f 68 6f 6f 6b 20 63 61  ite3_wal_hook ca
11f0: 6c 6c 62 61 63 6b 2c 20 74 68 65 0a 2a 2a 20 6e  llback, the.** n
1200: 75 6d 62 65 72 20 6f 66 20 66 72 61 6d 65 73 20  umber of frames 
1210: 69 6e 20 74 68 65 20 57 41 4c 20 61 74 20 74 68  in the WAL at th
1220: 65 20 70 6f 69 6e 74 20 6f 66 20 74 68 65 20 6c  e point of the l
1230: 61 73 74 20 63 6f 6d 6d 69 74 20 73 69 6e 63 65  ast commit since
1240: 0a 2a 2a 20 73 71 6c 69 74 65 33 57 61 6c 43 61  .** sqlite3WalCa
1250: 6c 6c 62 61 63 6b 28 29 20 77 61 73 20 63 61 6c  llback() was cal
1260: 6c 65 64 2e 20 20 49 66 20 6e 6f 20 63 6f 6d 6d  led.  If no comm
1270: 69 74 73 20 68 61 76 65 20 6f 63 63 75 72 72 65  its have occurre
1280: 64 20 73 69 6e 63 65 0a 2a 2a 20 74 68 65 20 6c  d since.** the l
1290: 61 73 74 20 63 61 6c 6c 2c 20 74 68 65 6e 20 72  ast call, then r
12a0: 65 74 75 72 6e 20 30 2e 0a 2a 2f 0a 69 6e 74 20  eturn 0..*/.int 
12b0: 73 71 6c 69 74 65 33 57 61 6c 43 61 6c 6c 62 61  sqlite3WalCallba
12c0: 63 6b 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a  ck(Wal *pWal);..
12d0: 2f 2a 20 54 65 6c 6c 20 74 68 65 20 77 61 6c 20  /* Tell the wal 
12e0: 6c 61 79 65 72 20 74 68 61 74 20 61 6e 20 45 58  layer that an EX
12f0: 43 4c 55 53 49 56 45 20 6c 6f 63 6b 20 68 61 73  CLUSIVE lock has
1300: 20 62 65 65 6e 20 6f 62 74 61 69 6e 65 64 20 28   been obtained (
1310: 6f 72 20 72 65 6c 65 61 73 65 64 29 0a 2a 2a 20  or released).** 
1320: 62 79 20 74 68 65 20 70 61 67 65 72 20 6c 61 79  by the pager lay
1330: 65 72 20 6f 6e 20 74 68 65 20 64 61 74 61 62 61  er on the databa
1340: 73 65 20 66 69 6c 65 2e 0a 2a 2f 0a 69 6e 74 20  se file..*/.int 
1350: 73 71 6c 69 74 65 33 57 61 6c 45 78 63 6c 75 73  sqlite3WalExclus
1360: 69 76 65 4d 6f 64 65 28 57 61 6c 20 2a 70 57 61  iveMode(Wal *pWa
1370: 6c 2c 20 69 6e 74 20 6f 70 29 3b 0a 0a 2f 2a 20  l, int op);../* 
1380: 52 65 74 75 72 6e 20 74 72 75 65 20 69 66 20 74  Return true if t
1390: 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20 6e  he argument is n
13a0: 6f 6e 2d 4e 55 4c 4c 20 61 6e 64 20 74 68 65 20  on-NULL and the 
13b0: 57 41 4c 20 6d 6f 64 75 6c 65 20 69 73 20 75 73  WAL module is us
13c0: 69 6e 67 0a 2a 2a 20 68 65 61 70 2d 6d 65 6d 6f  ing.** heap-memo
13d0: 72 79 20 66 6f 72 20 74 68 65 20 77 61 6c 2d 69  ry for the wal-i
13e0: 6e 64 65 78 2e 20 4f 74 68 65 72 77 69 73 65 2c  ndex. Otherwise,
13f0: 20 69 66 20 74 68 65 20 61 72 67 75 6d 65 6e 74   if the argument
1400: 20 69 73 20 4e 55 4c 4c 20 6f 72 20 74 68 65 0a   is NULL or the.
1410: 2a 2a 20 57 41 4c 20 6d 6f 64 75 6c 65 20 69 73  ** WAL module is
1420: 20 75 73 69 6e 67 20 73 68 61 72 65 64 2d 6d 65   using shared-me
1430: 6d 6f 72 79 2c 20 72 65 74 75 72 6e 20 66 61 6c  mory, return fal
1440: 73 65 2e 20 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  se. .*/.int sqli
1450: 74 65 33 57 61 6c 48 65 61 70 4d 65 6d 6f 72 79  te3WalHeapMemory
1460: 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 23 69  (Wal *pWal);..#i
1470: 66 64 65 66 20 53 51 4c 49 54 45 5f 45 4e 41 42  fdef SQLITE_ENAB
1480: 4c 45 5f 53 4e 41 50 53 48 4f 54 0a 69 6e 74 20  LE_SNAPSHOT.int 
1490: 73 71 6c 69 74 65 33 57 61 6c 53 6e 61 70 73 68  sqlite3WalSnapsh
14a0: 6f 74 47 65 74 28 57 61 6c 20 2a 70 57 61 6c 2c  otGet(Wal *pWal,
14b0: 20 73 71 6c 69 74 65 33 5f 73 6e 61 70 73 68 6f   sqlite3_snapsho
14c0: 74 20 2a 2a 70 70 53 6e 61 70 73 68 6f 74 29 3b  t **ppSnapshot);
14d0: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61 6c  .void sqlite3Wal
14e0: 53 6e 61 70 73 68 6f 74 4f 70 65 6e 28 57 61 6c  SnapshotOpen(Wal
14f0: 20 2a 70 57 61 6c 2c 20 73 71 6c 69 74 65 33 5f   *pWal, sqlite3_
1500: 73 6e 61 70 73 68 6f 74 20 2a 70 53 6e 61 70 73  snapshot *pSnaps
1510: 68 6f 74 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 69  hot);.#endif..#i
1520: 66 64 65 66 20 53 51 4c 49 54 45 5f 45 4e 41 42  fdef SQLITE_ENAB
1530: 4c 45 5f 5a 49 50 56 46 53 0a 2f 2a 20 49 66 20  LE_ZIPVFS./* If 
1540: 74 68 65 20 57 41 4c 20 66 69 6c 65 20 69 73 20  the WAL file is 
1550: 6e 6f 74 20 65 6d 70 74 79 2c 20 72 65 74 75 72  not empty, retur
1560: 6e 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  n the number of 
1570: 62 79 74 65 73 20 6f 66 20 63 6f 6e 74 65 6e 74  bytes of content
1580: 0a 2a 2a 20 73 74 6f 72 65 64 20 69 6e 20 65 61  .** stored in ea
1590: 63 68 20 66 72 61 6d 65 20 28 69 2e 65 2e 20 74  ch frame (i.e. t
15a0: 68 65 20 64 62 20 70 61 67 65 2d 73 69 7a 65 20  he db page-size 
15b0: 77 68 65 6e 20 74 68 65 20 57 41 4c 20 77 61 73  when the WAL was
15c0: 20 63 72 65 61 74 65 64 29 2e 0a 2a 2f 0a 69 6e   created)..*/.in
15d0: 74 20 73 71 6c 69 74 65 33 57 61 6c 46 72 61 6d  t sqlite3WalFram
15e0: 65 73 69 7a 65 28 57 61 6c 20 2a 70 57 61 6c 29  esize(Wal *pWal)
15f0: 3b 0a 23 65 6e 64 69 66 0a 0a 2f 2a 20 52 65 74  ;.#endif../* Ret
1600: 75 72 6e 20 74 68 65 20 73 71 6c 69 74 65 33 5f  urn the sqlite3_
1610: 66 69 6c 65 20 6f 62 6a 65 63 74 20 66 6f 72 20  file object for 
1620: 74 68 65 20 57 41 4c 20 66 69 6c 65 20 2a 2f 0a  the WAL file */.
1630: 73 71 6c 69 74 65 33 5f 66 69 6c 65 20 2a 73 71  sqlite3_file *sq
1640: 6c 69 74 65 33 57 61 6c 46 69 6c 65 28 57 61 6c  lite3WalFile(Wal
1650: 20 2a 70 57 61 6c 29 3b 0a 0a 23 65 6e 64 69 66   *pWal);..#endif
1660: 20 2f 2a 20 69 66 6e 64 65 66 20 53 51 4c 49 54   /* ifndef SQLIT
1670: 45 5f 4f 4d 49 54 5f 57 41 4c 20 2a 2f 0a 23 65  E_OMIT_WAL */.#e
1680: 6e 64 69 66 20 2f 2a 20 5f 57 41 4c 5f 48 5f 20  ndif /* _WAL_H_ 
1690: 2a 2f 0a                                         */.