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

Artifact bc4bdd9ee970c9d62197fa4139d7782f4d96d75152d1e6d4ead4d45dd684187d:


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 78 2c 79 2c 7a 29 20 20 20 20 20 20 20  do(x,y,z)       
0530: 20 20 20 20 20 20 20 20 20 20 20 20 30 0a 23 20              0.# 
0540: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61  define sqlite3Wa
0550: 6c 53 61 76 65 70 6f 69 6e 74 28 79 2c 7a 29 0a  lSavepoint(y,z).
0560: 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33  # define sqlite3
0570: 57 61 6c 53 61 76 65 70 6f 69 6e 74 55 6e 64 6f  WalSavepointUndo
0580: 28 79 2c 7a 29 20 20 20 20 20 20 20 20 20 20 20  (y,z)           
0590: 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69   0.# define sqli
05a0: 74 65 33 57 61 6c 46 72 61 6d 65 73 28 75 2c 76  te3WalFrames(u,v
05b0: 2c 77 2c 78 2c 79 2c 7a 29 20 20 20 20 20 20 20  ,w,x,y,z)       
05c0: 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73      0.# define s
05d0: 71 6c 69 74 65 33 57 61 6c 43 68 65 63 6b 70 6f  qlite3WalCheckpo
05e0: 69 6e 74 28 71 2c 72 2c 73 2c 74 2c 75 2c 76 2c  int(q,r,s,t,u,v,
05f0: 77 2c 78 2c 79 2c 7a 29 20 30 0a 23 20 64 65 66  w,x,y,z) 0.# def
0600: 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 43 61  ine sqlite3WalCa
0610: 6c 6c 62 61 63 6b 28 7a 29 20 20 20 20 20 20 20  llback(z)       
0620: 20 20 20 20 20 20 20 20 20 20 20 20 30 0a 23 20              0.# 
0630: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61  define sqlite3Wa
0640: 6c 45 78 63 6c 75 73 69 76 65 4d 6f 64 65 28 79  lExclusiveMode(y
0650: 2c 7a 29 20 20 20 20 20 20 20 20 20 20 20 20 30  ,z)            0
0660: 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65  .# define sqlite
0670: 33 57 61 6c 48 65 61 70 4d 65 6d 6f 72 79 28 7a  3WalHeapMemory(z
0680: 29 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  )               
0690: 20 20 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c    0.# define sql
06a0: 69 74 65 33 57 61 6c 46 72 61 6d 65 73 69 7a 65  ite3WalFramesize
06b0: 28 7a 29 20 20 20 20 20 20 20 20 20 20 20 20 20  (z)             
06c0: 20 20 20 20 20 30 0a 23 20 64 65 66 69 6e 65 20       0.# define 
06d0: 73 71 6c 69 74 65 33 57 61 6c 46 69 6e 64 46 72  sqlite3WalFindFr
06e0: 61 6d 65 28 78 2c 79 2c 7a 29 20 20 20 20 20 20  ame(x,y,z)      
06f0: 20 20 20 20 20 20 20 20 30 0a 23 20 64 65 66 69          0.# defi
0700: 6e 65 20 73 71 6c 69 74 65 33 57 61 6c 46 69 6c  ne sqlite3WalFil
0710: 65 28 78 29 20 20 20 20 20 20 20 20 20 20 20 20  e(x)            
0720: 20 20 20 20 20 20 20 20 20 20 20 30 0a 23 65 6c             0.#el
0730: 73 65 0a 0a 23 64 65 66 69 6e 65 20 57 41 4c 5f  se..#define WAL_
0740: 53 41 56 45 50 4f 49 4e 54 5f 4e 44 41 54 41 20  SAVEPOINT_NDATA 
0750: 34 0a 0a 2f 2a 20 43 6f 6e 6e 65 63 74 69 6f 6e  4../* Connection
0760: 20 74 6f 20 61 20 77 72 69 74 65 2d 61 68 65 61   to a write-ahea
0770: 64 20 6c 6f 67 20 28 57 41 4c 29 20 66 69 6c 65  d log (WAL) file
0780: 2e 20 0a 2a 2a 20 54 68 65 72 65 20 69 73 20 6f  . .** There is o
0790: 6e 65 20 6f 62 6a 65 63 74 20 6f 66 20 74 68 69  ne object of thi
07a0: 73 20 74 79 70 65 20 66 6f 72 20 65 61 63 68 20  s type for each 
07b0: 70 61 67 65 72 2e 20 0a 2a 2f 0a 74 79 70 65 64  pager. .*/.typed
07c0: 65 66 20 73 74 72 75 63 74 20 57 61 6c 20 57 61  ef struct Wal Wa
07d0: 6c 3b 0a 0a 2f 2a 20 4f 70 65 6e 20 61 6e 64 20  l;../* Open and 
07e0: 63 6c 6f 73 65 20 61 20 63 6f 6e 6e 65 63 74 69  close a connecti
07f0: 6f 6e 20 74 6f 20 61 20 77 72 69 74 65 2d 61 68  on to a write-ah
0800: 65 61 64 20 6c 6f 67 2e 20 2a 2f 0a 69 6e 74 20  ead log. */.int 
0810: 73 71 6c 69 74 65 33 57 61 6c 4f 70 65 6e 28 73  sqlite3WalOpen(s
0820: 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 73 71 6c  qlite3_vfs*, sql
0830: 69 74 65 33 5f 66 69 6c 65 2a 2c 20 63 6f 6e 73  ite3_file*, cons
0840: 74 20 63 68 61 72 20 2a 2c 20 69 6e 74 2c 20 69  t char *, int, i
0850: 36 34 2c 20 69 6e 74 2c 20 57 61 6c 2a 2a 29 3b  64, int, Wal**);
0860: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 43  .int sqlite3WalC
0870: 6c 6f 73 65 28 57 61 6c 20 2a 70 57 61 6c 2c 20  lose(Wal *pWal, 
0880: 73 71 6c 69 74 65 33 2a 2c 20 69 6e 74 20 73 79  sqlite3*, int sy
0890: 6e 63 5f 66 6c 61 67 73 2c 20 69 6e 74 2c 20 75  nc_flags, int, u
08a0: 38 20 2a 29 3b 0a 0a 2f 2a 20 53 65 74 20 74 68  8 *);../* Set th
08b0: 65 20 6c 69 6d 69 74 69 6e 67 20 73 69 7a 65 20  e limiting size 
08c0: 6f 66 20 61 20 57 41 4c 20 66 69 6c 65 2e 20 2a  of a WAL file. *
08d0: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61  /.void sqlite3Wa
08e0: 6c 4c 69 6d 69 74 28 57 61 6c 2a 2c 20 69 36 34  lLimit(Wal*, i64
08f0: 29 3b 0a 0a 2f 2a 20 55 73 65 64 20 62 79 20 72  );../* Used by r
0900: 65 61 64 65 72 73 20 74 6f 20 6f 70 65 6e 20 28  eaders to open (
0910: 6c 6f 63 6b 29 20 61 6e 64 20 63 6c 6f 73 65 20  lock) and close 
0920: 28 75 6e 6c 6f 63 6b 29 20 61 20 73 6e 61 70 73  (unlock) a snaps
0930: 68 6f 74 2e 20 20 41 20 0a 2a 2a 20 73 6e 61 70  hot.  A .** snap
0940: 73 68 6f 74 20 69 73 20 6c 69 6b 65 20 61 20 72  shot is like a r
0950: 65 61 64 2d 74 72 61 6e 73 61 63 74 69 6f 6e 2e  ead-transaction.
0960: 20 20 49 74 20 69 73 20 74 68 65 20 73 74 61 74    It is the stat
0970: 65 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73  e of the databas
0980: 65 0a 2a 2a 20 61 74 20 61 6e 20 69 6e 73 74 61  e.** at an insta
0990: 6e 74 20 69 6e 20 74 69 6d 65 2e 20 20 73 71 6c  nt in time.  sql
09a0: 69 74 65 33 57 61 6c 4f 70 65 6e 53 6e 61 70 73  ite3WalOpenSnaps
09b0: 68 6f 74 20 67 65 74 73 20 61 20 72 65 61 64 20  hot gets a read 
09c0: 6c 6f 63 6b 20 61 6e 64 0a 2a 2a 20 70 72 65 73  lock and.** pres
09d0: 65 72 76 65 73 20 74 68 65 20 63 75 72 72 65 6e  erves the curren
09e0: 74 20 73 74 61 74 65 20 65 76 65 6e 20 69 66 20  t state even if 
09f0: 74 68 65 20 6f 74 68 65 72 20 74 68 72 65 61 64  the other thread
0a00: 73 20 6f 72 20 70 72 6f 63 65 73 73 65 73 0a 2a  s or processes.*
0a10: 2a 20 77 72 69 74 65 20 74 6f 20 6f 72 20 63 68  * write to or ch
0a20: 65 63 6b 70 6f 69 6e 74 20 74 68 65 20 57 41 4c  eckpoint the WAL
0a30: 2e 20 20 73 71 6c 69 74 65 33 57 61 6c 43 6c 6f  .  sqlite3WalClo
0a40: 73 65 53 6e 61 70 73 68 6f 74 28 29 20 63 6c 6f  seSnapshot() clo
0a50: 73 65 73 20 74 68 65 0a 2a 2a 20 74 72 61 6e 73  ses the.** trans
0a60: 61 63 74 69 6f 6e 20 61 6e 64 20 72 65 6c 65 61  action and relea
0a70: 73 65 73 20 74 68 65 20 6c 6f 63 6b 2e 0a 2a 2f  ses the lock..*/
0a80: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 42  .int sqlite3WalB
0a90: 65 67 69 6e 52 65 61 64 54 72 61 6e 73 61 63 74  eginReadTransact
0aa0: 69 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69  ion(Wal *pWal, i
0ab0: 6e 74 20 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69  nt *);.void sqli
0ac0: 74 65 33 57 61 6c 45 6e 64 52 65 61 64 54 72 61  te3WalEndReadTra
0ad0: 6e 73 61 63 74 69 6f 6e 28 57 61 6c 20 2a 70 57  nsaction(Wal *pW
0ae0: 61 6c 29 3b 0a 0a 2f 2a 20 52 65 61 64 20 61 20  al);../* Read a 
0af0: 70 61 67 65 20 66 72 6f 6d 20 74 68 65 20 77 72  page from the wr
0b00: 69 74 65 2d 61 68 65 61 64 20 6c 6f 67 2c 20 69  ite-ahead log, i
0b10: 66 20 69 74 20 69 73 20 70 72 65 73 65 6e 74 2e  f it is present.
0b20: 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57   */.int sqlite3W
0b30: 61 6c 46 69 6e 64 46 72 61 6d 65 28 57 61 6c 20  alFindFrame(Wal 
0b40: 2a 2c 20 50 67 6e 6f 2c 20 75 33 32 20 2a 29 3b  *, Pgno, u32 *);
0b50: 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 52  .int sqlite3WalR
0b60: 65 61 64 46 72 61 6d 65 28 57 61 6c 20 2a 2c 20  eadFrame(Wal *, 
0b70: 75 33 32 2c 20 69 6e 74 2c 20 75 38 20 2a 29 3b  u32, int, u8 *);
0b80: 0a 0a 2f 2a 20 49 66 20 74 68 65 20 57 41 4c 20  ../* If the WAL 
0b90: 69 73 20 6e 6f 74 20 65 6d 70 74 79 2c 20 72 65  is not empty, re
0ba0: 74 75 72 6e 20 74 68 65 20 73 69 7a 65 20 6f 66  turn the size of
0bb0: 20 74 68 65 20 64 61 74 61 62 61 73 65 2e 20 2a   the database. *
0bc0: 2f 0a 50 67 6e 6f 20 73 71 6c 69 74 65 33 57 61  /.Pgno sqlite3Wa
0bd0: 6c 44 62 73 69 7a 65 28 57 61 6c 20 2a 70 57 61  lDbsize(Wal *pWa
0be0: 6c 29 3b 0a 0a 2f 2a 20 49 66 20 61 20 57 41 4c  l);../* If a WAL
0bf0: 20 6a 6f 75 72 6e 61 6c 20 66 69 6c 65 20 68 61   journal file ha
0c00: 73 20 62 65 65 6e 20 63 72 65 61 74 65 64 2c 20  s been created, 
0c10: 72 65 74 75 72 6e 20 69 74 20 2a 2f 0a 73 71 6c  return it */.sql
0c20: 69 74 65 33 5f 66 69 6c 65 20 2a 73 71 6c 69 74  ite3_file *sqlit
0c30: 65 33 57 61 6c 46 69 6c 65 28 57 61 6c 20 2a 70  e3WalFile(Wal *p
0c40: 57 61 6c 29 3b 0a 20 20 0a 2f 2a 20 4f 62 74 61  Wal);.  ./* Obta
0c50: 69 6e 20 6f 72 20 72 65 6c 65 61 73 65 20 74 68  in or release th
0c60: 65 20 57 52 49 54 45 52 20 6c 6f 63 6b 2e 20 2a  e WRITER lock. *
0c70: 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c  /.int sqlite3Wal
0c80: 42 65 67 69 6e 57 72 69 74 65 54 72 61 6e 73 61  BeginWriteTransa
0c90: 63 74 69 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 29  ction(Wal *pWal)
0ca0: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c  ;.int sqlite3Wal
0cb0: 45 6e 64 57 72 69 74 65 54 72 61 6e 73 61 63 74  EndWriteTransact
0cc0: 69 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a  ion(Wal *pWal);.
0cd0: 0a 2f 2a 20 55 6e 64 6f 20 61 6e 79 20 66 72 61  ./* Undo any fra
0ce0: 6d 65 73 20 77 72 69 74 74 65 6e 20 28 62 75 74  mes written (but
0cf0: 20 6e 6f 74 20 63 6f 6d 6d 69 74 74 65 64 29 20   not committed) 
0d00: 74 6f 20 74 68 65 20 6c 6f 67 20 2a 2f 0a 69 6e  to the log */.in
0d10: 74 20 73 71 6c 69 74 65 33 57 61 6c 55 6e 64 6f  t sqlite3WalUndo
0d20: 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69 6e 74 20  (Wal *pWal, int 
0d30: 28 2a 78 55 6e 64 6f 29 28 76 6f 69 64 20 2a 2c  (*xUndo)(void *,
0d40: 20 50 67 6e 6f 29 2c 20 76 6f 69 64 20 2a 70 55   Pgno), void *pU
0d50: 6e 64 6f 43 74 78 29 3b 0a 0a 2f 2a 20 52 65 74  ndoCtx);../* Ret
0d60: 75 72 6e 20 61 6e 20 69 6e 74 65 67 65 72 20 74  urn an integer t
0d70: 68 61 74 20 72 65 63 6f 72 64 73 20 74 68 65 20  hat records the 
0d80: 63 75 72 72 65 6e 74 20 28 75 6e 63 6f 6d 6d 69  current (uncommi
0d90: 74 74 65 64 29 20 77 72 69 74 65 0a 2a 2a 20 70  tted) write.** p
0da0: 6f 73 69 74 69 6f 6e 20 69 6e 20 74 68 65 20 57  osition in the W
0db0: 41 4c 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74  AL */.void sqlit
0dc0: 65 33 57 61 6c 53 61 76 65 70 6f 69 6e 74 28 57  e3WalSavepoint(W
0dd0: 61 6c 20 2a 70 57 61 6c 2c 20 75 33 32 20 2a 61  al *pWal, u32 *a
0de0: 57 61 6c 44 61 74 61 29 3b 0a 0a 2f 2a 20 4d 6f  WalData);../* Mo
0df0: 76 65 20 74 68 65 20 77 72 69 74 65 20 70 6f 73  ve the write pos
0e00: 69 74 69 6f 6e 20 6f 66 20 74 68 65 20 57 41 4c  ition of the WAL
0e10: 20 62 61 63 6b 20 74 6f 20 69 46 72 61 6d 65 2e   back to iFrame.
0e20: 20 20 43 61 6c 6c 65 64 20 69 6e 0a 2a 2a 20 72    Called in.** r
0e30: 65 73 70 6f 6e 73 65 20 74 6f 20 61 20 52 4f 4c  esponse to a ROL
0e40: 4c 42 41 43 4b 20 54 4f 20 63 6f 6d 6d 61 6e 64  LBACK TO command
0e50: 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  . */.int sqlite3
0e60: 57 61 6c 53 61 76 65 70 6f 69 6e 74 55 6e 64 6f  WalSavepointUndo
0e70: 28 57 61 6c 20 2a 70 57 61 6c 2c 20 75 33 32 20  (Wal *pWal, u32 
0e80: 2a 61 57 61 6c 44 61 74 61 29 3b 0a 0a 2f 2a 20  *aWalData);../* 
0e90: 57 72 69 74 65 20 61 20 66 72 61 6d 65 20 6f 72  Write a frame or
0ea0: 20 66 72 61 6d 65 73 20 74 6f 20 74 68 65 20 6c   frames to the l
0eb0: 6f 67 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  og. */.int sqlit
0ec0: 65 33 57 61 6c 46 72 61 6d 65 73 28 57 61 6c 20  e3WalFrames(Wal 
0ed0: 2a 70 57 61 6c 2c 20 69 6e 74 2c 20 50 67 48 64  *pWal, int, PgHd
0ee0: 72 20 2a 2c 20 50 67 6e 6f 2c 20 69 6e 74 2c 20  r *, Pgno, int, 
0ef0: 69 6e 74 29 3b 0a 0a 2f 2a 20 43 6f 70 79 20 70  int);../* Copy p
0f00: 61 67 65 73 20 66 72 6f 6d 20 74 68 65 20 6c 6f  ages from the lo
0f10: 67 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73  g to the databas
0f20: 65 20 66 69 6c 65 20 2a 2f 20 0a 69 6e 74 20 73  e file */ .int s
0f30: 71 6c 69 74 65 33 57 61 6c 43 68 65 63 6b 70 6f  qlite3WalCheckpo
0f40: 69 6e 74 28 0a 20 20 57 61 6c 20 2a 70 57 61 6c  int(.  Wal *pWal
0f50: 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ,               
0f60: 20 20 20 20 20 20 20 2f 2a 20 57 72 69 74 65 2d         /* Write-
0f70: 61 68 65 61 64 20 6c 6f 67 20 63 6f 6e 6e 65 63  ahead log connec
0f80: 74 69 6f 6e 20 2a 2f 0a 20 20 73 71 6c 69 74 65  tion */.  sqlite
0f90: 33 20 2a 64 62 2c 20 20 20 20 20 20 20 20 20 20  3 *db,          
0fa0: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 43 68 65            /* Che
0fb0: 63 6b 20 74 68 69 73 20 68 61 6e 64 6c 65 27 73  ck this handle's
0fc0: 20 69 6e 74 65 72 72 75 70 74 20 66 6c 61 67 20   interrupt flag 
0fd0: 2a 2f 0a 20 20 69 6e 74 20 65 4d 6f 64 65 2c 20  */.  int eMode, 
0fe0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0ff0: 20 20 20 20 20 2f 2a 20 4f 6e 65 20 6f 66 20 50       /* One of P
1000: 41 53 53 49 56 45 2c 20 46 55 4c 4c 20 61 6e 64  ASSIVE, FULL and
1010: 20 52 45 53 54 41 52 54 20 2a 2f 0a 20 20 69 6e   RESTART */.  in
1020: 74 20 28 2a 78 42 75 73 79 29 28 76 6f 69 64 2a  t (*xBusy)(void*
1030: 29 2c 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a  ),            /*
1040: 20 46 75 6e 63 74 69 6f 6e 20 74 6f 20 63 61 6c   Function to cal
1050: 6c 20 77 68 65 6e 20 62 75 73 79 20 2a 2f 0a 20  l when busy */. 
1060: 20 76 6f 69 64 20 2a 70 42 75 73 79 41 72 67 2c   void *pBusyArg,
1070: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1080: 20 2f 2a 20 43 6f 6e 74 65 78 74 20 61 72 67 75   /* Context argu
1090: 6d 65 6e 74 20 66 6f 72 20 78 42 75 73 79 48 61  ment for xBusyHa
10a0: 6e 64 6c 65 72 20 2a 2f 0a 20 20 69 6e 74 20 73  ndler */.  int s
10b0: 79 6e 63 5f 66 6c 61 67 73 2c 20 20 20 20 20 20  ync_flags,      
10c0: 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46 6c             /* Fl
10d0: 61 67 73 20 74 6f 20 73 79 6e 63 20 64 62 20 66  ags to sync db f
10e0: 69 6c 65 20 77 69 74 68 20 28 6f 72 20 30 29 20  ile with (or 0) 
10f0: 2a 2f 0a 20 20 69 6e 74 20 6e 42 75 66 2c 20 20  */.  int nBuf,  
1100: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1110: 20 20 20 20 20 2f 2a 20 53 69 7a 65 20 6f 66 20       /* Size of 
1120: 62 75 66 66 65 72 20 6e 42 75 66 20 2a 2f 0a 20  buffer nBuf */. 
1130: 20 75 38 20 2a 7a 42 75 66 2c 20 20 20 20 20 20   u8 *zBuf,      
1140: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1150: 20 2f 2a 20 54 65 6d 70 6f 72 61 72 79 20 62 75   /* Temporary bu
1160: 66 66 65 72 20 74 6f 20 75 73 65 20 2a 2f 0a 20  ffer to use */. 
1170: 20 69 6e 74 20 2a 70 6e 4c 6f 67 2c 20 20 20 20   int *pnLog,    
1180: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1190: 20 2f 2a 20 4f 55 54 3a 20 4e 75 6d 62 65 72 20   /* OUT: Number 
11a0: 6f 66 20 66 72 61 6d 65 73 20 69 6e 20 57 41 4c  of frames in WAL
11b0: 20 2a 2f 0a 20 20 69 6e 74 20 2a 70 6e 43 6b 70   */.  int *pnCkp
11c0: 74 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  t               
11d0: 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a 20 4e 75        /* OUT: Nu
11e0: 6d 62 65 72 20 6f 66 20 62 61 63 6b 66 69 6c 6c  mber of backfill
11f0: 65 64 20 66 72 61 6d 65 73 20 69 6e 20 57 41 4c  ed frames in WAL
1200: 20 2a 2f 0a 29 3b 0a 0a 2f 2a 20 52 65 74 75 72   */.);../* Retur
1210: 6e 20 74 68 65 20 76 61 6c 75 65 20 74 6f 20 70  n the value to p
1220: 61 73 73 20 74 6f 20 61 20 73 71 6c 69 74 65 33  ass to a sqlite3
1230: 5f 77 61 6c 5f 68 6f 6f 6b 20 63 61 6c 6c 62 61  _wal_hook callba
1240: 63 6b 2c 20 74 68 65 0a 2a 2a 20 6e 75 6d 62 65  ck, the.** numbe
1250: 72 20 6f 66 20 66 72 61 6d 65 73 20 69 6e 20 74  r of frames in t
1260: 68 65 20 57 41 4c 20 61 74 20 74 68 65 20 70 6f  he WAL at the po
1270: 69 6e 74 20 6f 66 20 74 68 65 20 6c 61 73 74 20  int of the last 
1280: 63 6f 6d 6d 69 74 20 73 69 6e 63 65 0a 2a 2a 20  commit since.** 
1290: 73 71 6c 69 74 65 33 57 61 6c 43 61 6c 6c 62 61  sqlite3WalCallba
12a0: 63 6b 28 29 20 77 61 73 20 63 61 6c 6c 65 64 2e  ck() was called.
12b0: 20 20 49 66 20 6e 6f 20 63 6f 6d 6d 69 74 73 20    If no commits 
12c0: 68 61 76 65 20 6f 63 63 75 72 72 65 64 20 73 69  have occurred si
12d0: 6e 63 65 0a 2a 2a 20 74 68 65 20 6c 61 73 74 20  nce.** the last 
12e0: 63 61 6c 6c 2c 20 74 68 65 6e 20 72 65 74 75 72  call, then retur
12f0: 6e 20 30 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  n 0..*/.int sqli
1300: 74 65 33 57 61 6c 43 61 6c 6c 62 61 63 6b 28 57  te3WalCallback(W
1310: 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20 54  al *pWal);../* T
1320: 65 6c 6c 20 74 68 65 20 77 61 6c 20 6c 61 79 65  ell the wal laye
1330: 72 20 74 68 61 74 20 61 6e 20 45 58 43 4c 55 53  r that an EXCLUS
1340: 49 56 45 20 6c 6f 63 6b 20 68 61 73 20 62 65 65  IVE lock has bee
1350: 6e 20 6f 62 74 61 69 6e 65 64 20 28 6f 72 20 72  n obtained (or r
1360: 65 6c 65 61 73 65 64 29 0a 2a 2a 20 62 79 20 74  eleased).** by t
1370: 68 65 20 70 61 67 65 72 20 6c 61 79 65 72 20 6f  he pager layer o
1380: 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66  n the database f
1390: 69 6c 65 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  ile..*/.int sqli
13a0: 74 65 33 57 61 6c 45 78 63 6c 75 73 69 76 65 4d  te3WalExclusiveM
13b0: 6f 64 65 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69  ode(Wal *pWal, i
13c0: 6e 74 20 6f 70 29 3b 0a 0a 2f 2a 20 52 65 74 75  nt op);../* Retu
13d0: 72 6e 20 74 72 75 65 20 69 66 20 74 68 65 20 61  rn true if the a
13e0: 72 67 75 6d 65 6e 74 20 69 73 20 6e 6f 6e 2d 4e  rgument is non-N
13f0: 55 4c 4c 20 61 6e 64 20 74 68 65 20 57 41 4c 20  ULL and the WAL 
1400: 6d 6f 64 75 6c 65 20 69 73 20 75 73 69 6e 67 0a  module is using.
1410: 2a 2a 20 68 65 61 70 2d 6d 65 6d 6f 72 79 20 66  ** heap-memory f
1420: 6f 72 20 74 68 65 20 77 61 6c 2d 69 6e 64 65 78  or the wal-index
1430: 2e 20 4f 74 68 65 72 77 69 73 65 2c 20 69 66 20  . Otherwise, if 
1440: 74 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20  the argument is 
1450: 4e 55 4c 4c 20 6f 72 20 74 68 65 0a 2a 2a 20 57  NULL or the.** W
1460: 41 4c 20 6d 6f 64 75 6c 65 20 69 73 20 75 73 69  AL module is usi
1470: 6e 67 20 73 68 61 72 65 64 2d 6d 65 6d 6f 72 79  ng shared-memory
1480: 2c 20 72 65 74 75 72 6e 20 66 61 6c 73 65 2e 20  , return false. 
1490: 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57  .*/.int sqlite3W
14a0: 61 6c 48 65 61 70 4d 65 6d 6f 72 79 28 57 61 6c  alHeapMemory(Wal
14b0: 20 2a 70 57 61 6c 29 3b 0a 0a 23 69 66 64 65 66   *pWal);..#ifdef
14c0: 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53   SQLITE_ENABLE_S
14d0: 4e 41 50 53 48 4f 54 0a 69 6e 74 20 73 71 6c 69  NAPSHOT.int sqli
14e0: 74 65 33 57 61 6c 53 6e 61 70 73 68 6f 74 47 65  te3WalSnapshotGe
14f0: 74 28 57 61 6c 20 2a 70 57 61 6c 2c 20 73 71 6c  t(Wal *pWal, sql
1500: 69 74 65 33 5f 73 6e 61 70 73 68 6f 74 20 2a 2a  ite3_snapshot **
1510: 70 70 53 6e 61 70 73 68 6f 74 29 3b 0a 76 6f 69  ppSnapshot);.voi
1520: 64 20 73 71 6c 69 74 65 33 57 61 6c 53 6e 61 70  d sqlite3WalSnap
1530: 73 68 6f 74 4f 70 65 6e 28 57 61 6c 20 2a 70 57  shotOpen(Wal *pW
1540: 61 6c 2c 20 73 71 6c 69 74 65 33 5f 73 6e 61 70  al, sqlite3_snap
1550: 73 68 6f 74 20 2a 70 53 6e 61 70 73 68 6f 74 29  shot *pSnapshot)
1560: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c  ;.int sqlite3Wal
1570: 53 6e 61 70 73 68 6f 74 52 65 63 6f 76 65 72 28  SnapshotRecover(
1580: 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 69 6e 74 20  Wal *pWal);.int 
1590: 73 71 6c 69 74 65 33 57 61 6c 53 6e 61 70 73 68  sqlite3WalSnapsh
15a0: 6f 74 43 68 65 63 6b 28 57 61 6c 20 2a 70 57 61  otCheck(Wal *pWa
15b0: 6c 2c 20 73 71 6c 69 74 65 33 5f 73 6e 61 70 73  l, sqlite3_snaps
15c0: 68 6f 74 20 2a 70 53 6e 61 70 73 68 6f 74 29 3b  hot *pSnapshot);
15d0: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61 6c  .void sqlite3Wal
15e0: 53 6e 61 70 73 68 6f 74 55 6e 6c 6f 63 6b 28 57  SnapshotUnlock(W
15f0: 61 6c 20 2a 70 57 61 6c 29 3b 0a 23 65 6e 64 69  al *pWal);.#endi
1600: 66 0a 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45  f..#ifdef SQLITE
1610: 5f 45 4e 41 42 4c 45 5f 5a 49 50 56 46 53 0a 2f  _ENABLE_ZIPVFS./
1620: 2a 20 49 66 20 74 68 65 20 57 41 4c 20 66 69 6c  * If the WAL fil
1630: 65 20 69 73 20 6e 6f 74 20 65 6d 70 74 79 2c 20  e is not empty, 
1640: 72 65 74 75 72 6e 20 74 68 65 20 6e 75 6d 62 65  return the numbe
1650: 72 20 6f 66 20 62 79 74 65 73 20 6f 66 20 63 6f  r of bytes of co
1660: 6e 74 65 6e 74 0a 2a 2a 20 73 74 6f 72 65 64 20  ntent.** stored 
1670: 69 6e 20 65 61 63 68 20 66 72 61 6d 65 20 28 69  in each frame (i
1680: 2e 65 2e 20 74 68 65 20 64 62 20 70 61 67 65 2d  .e. the db page-
1690: 73 69 7a 65 20 77 68 65 6e 20 74 68 65 20 57 41  size when the WA
16a0: 4c 20 77 61 73 20 63 72 65 61 74 65 64 29 2e 0a  L was created)..
16b0: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  */.int sqlite3Wa
16c0: 6c 46 72 61 6d 65 73 69 7a 65 28 57 61 6c 20 2a  lFramesize(Wal *
16d0: 70 57 61 6c 29 3b 0a 23 65 6e 64 69 66 0a 0a 2f  pWal);.#endif../
16e0: 2a 20 52 65 74 75 72 6e 20 74 68 65 20 73 71 6c  * Return the sql
16f0: 69 74 65 33 5f 66 69 6c 65 20 6f 62 6a 65 63 74  ite3_file object
1700: 20 66 6f 72 20 74 68 65 20 57 41 4c 20 66 69 6c   for the WAL fil
1710: 65 20 2a 2f 0a 73 71 6c 69 74 65 33 5f 66 69 6c  e */.sqlite3_fil
1720: 65 20 2a 73 71 6c 69 74 65 33 57 61 6c 46 69 6c  e *sqlite3WalFil
1730: 65 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 23  e(Wal *pWal);..#
1740: 65 6e 64 69 66 20 2f 2a 20 69 66 6e 64 65 66 20  endif /* ifndef 
1750: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 57 41 4c 20  SQLITE_OMIT_WAL 
1760: 2a 2f 0a 23 65 6e 64 69 66 20 2f 2a 20 53 51 4c  */.#endif /* SQL
1770: 49 54 45 5f 57 41 4c 5f 48 20 2a 2f 0a           ITE_WAL_H */.