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

Artifact 1598818fe90532a622ecdec5baa959f94e10062e:


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 69 6e 74 2c 20 57 61  nt, i64, int, Wa
0870: 6c 2a 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  l**);.int sqlite
0880: 33 57 61 6c 43 6c 6f 73 65 28 57 61 6c 20 2a 70  3WalClose(Wal *p
0890: 57 61 6c 2c 20 73 71 6c 69 74 65 33 2a 2c 20 69  Wal, sqlite3*, i
08a0: 6e 74 20 73 79 6e 63 5f 66 6c 61 67 73 2c 20 69  nt sync_flags, i
08b0: 6e 74 2c 20 75 38 20 2a 29 3b 0a 0a 2f 2a 20 53  nt, u8 *);../* S
08c0: 65 74 20 74 68 65 20 6c 69 6d 69 74 69 6e 67 20  et the limiting 
08d0: 73 69 7a 65 20 6f 66 20 61 20 57 41 4c 20 66 69  size of a WAL fi
08e0: 6c 65 2e 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69  le. */.void sqli
08f0: 74 65 33 57 61 6c 4c 69 6d 69 74 28 57 61 6c 2a  te3WalLimit(Wal*
0900: 2c 20 69 36 34 29 3b 0a 0a 2f 2a 20 55 73 65 64  , i64);../* Used
0910: 20 62 79 20 72 65 61 64 65 72 73 20 74 6f 20 6f   by readers to o
0920: 70 65 6e 20 28 6c 6f 63 6b 29 20 61 6e 64 20 63  pen (lock) and c
0930: 6c 6f 73 65 20 28 75 6e 6c 6f 63 6b 29 20 61 20  lose (unlock) a 
0940: 73 6e 61 70 73 68 6f 74 2e 20 20 41 20 0a 2a 2a  snapshot.  A .**
0950: 20 73 6e 61 70 73 68 6f 74 20 69 73 20 6c 69 6b   snapshot is lik
0960: 65 20 61 20 72 65 61 64 2d 74 72 61 6e 73 61 63  e a read-transac
0970: 74 69 6f 6e 2e 20 20 49 74 20 69 73 20 74 68 65  tion.  It is the
0980: 20 73 74 61 74 65 20 6f 66 20 74 68 65 20 64 61   state of the da
0990: 74 61 62 61 73 65 0a 2a 2a 20 61 74 20 61 6e 20  tabase.** at an 
09a0: 69 6e 73 74 61 6e 74 20 69 6e 20 74 69 6d 65 2e  instant in time.
09b0: 20 20 73 71 6c 69 74 65 33 57 61 6c 4f 70 65 6e    sqlite3WalOpen
09c0: 53 6e 61 70 73 68 6f 74 20 67 65 74 73 20 61 20  Snapshot gets a 
09d0: 72 65 61 64 20 6c 6f 63 6b 20 61 6e 64 0a 2a 2a  read lock and.**
09e0: 20 70 72 65 73 65 72 76 65 73 20 74 68 65 20 63   preserves the c
09f0: 75 72 72 65 6e 74 20 73 74 61 74 65 20 65 76 65  urrent state eve
0a00: 6e 20 69 66 20 74 68 65 20 6f 74 68 65 72 20 74  n if the other t
0a10: 68 72 65 61 64 73 20 6f 72 20 70 72 6f 63 65 73  hreads or proces
0a20: 73 65 73 0a 2a 2a 20 77 72 69 74 65 20 74 6f 20  ses.** write to 
0a30: 6f 72 20 63 68 65 63 6b 70 6f 69 6e 74 20 74 68  or checkpoint th
0a40: 65 20 57 41 4c 2e 20 20 73 71 6c 69 74 65 33 57  e WAL.  sqlite3W
0a50: 61 6c 43 6c 6f 73 65 53 6e 61 70 73 68 6f 74 28  alCloseSnapshot(
0a60: 29 20 63 6c 6f 73 65 73 20 74 68 65 0a 2a 2a 20  ) closes the.** 
0a70: 74 72 61 6e 73 61 63 74 69 6f 6e 20 61 6e 64 20  transaction and 
0a80: 72 65 6c 65 61 73 65 73 20 74 68 65 20 6c 6f 63  releases the loc
0a90: 6b 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  k..*/.int sqlite
0aa0: 33 57 61 6c 42 65 67 69 6e 52 65 61 64 54 72 61  3WalBeginReadTra
0ab0: 6e 73 61 63 74 69 6f 6e 28 57 61 6c 20 2a 70 57  nsaction(Wal *pW
0ac0: 61 6c 2c 20 69 6e 74 20 2a 29 3b 0a 76 6f 69 64  al, int *);.void
0ad0: 20 73 71 6c 69 74 65 33 57 61 6c 45 6e 64 52 65   sqlite3WalEndRe
0ae0: 61 64 54 72 61 6e 73 61 63 74 69 6f 6e 28 57 61  adTransaction(Wa
0af0: 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20 52 65  l *pWal);../* Re
0b00: 61 64 20 61 20 70 61 67 65 20 66 72 6f 6d 20 74  ad a page from t
0b10: 68 65 20 77 72 69 74 65 2d 61 68 65 61 64 20 6c  he write-ahead l
0b20: 6f 67 2c 20 69 66 20 69 74 20 69 73 20 70 72 65  og, if it is pre
0b30: 73 65 6e 74 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c  sent. */.int sql
0b40: 69 74 65 33 57 61 6c 46 69 6e 64 46 72 61 6d 65  ite3WalFindFrame
0b50: 28 57 61 6c 20 2a 2c 20 50 67 6e 6f 2c 20 75 33  (Wal *, Pgno, u3
0b60: 32 20 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  2 *);.int sqlite
0b70: 33 57 61 6c 52 65 61 64 46 72 61 6d 65 28 57 61  3WalReadFrame(Wa
0b80: 6c 20 2a 2c 20 75 33 32 2c 20 69 6e 74 2c 20 75  l *, u32, int, u
0b90: 38 20 2a 29 3b 0a 0a 2f 2a 20 49 66 20 74 68 65  8 *);../* If the
0ba0: 20 57 41 4c 20 69 73 20 6e 6f 74 20 65 6d 70 74   WAL is not empt
0bb0: 79 2c 20 72 65 74 75 72 6e 20 74 68 65 20 73 69  y, return the si
0bc0: 7a 65 20 6f 66 20 74 68 65 20 64 61 74 61 62 61  ze of the databa
0bd0: 73 65 2e 20 2a 2f 0a 50 67 6e 6f 20 73 71 6c 69  se. */.Pgno sqli
0be0: 74 65 33 57 61 6c 44 62 73 69 7a 65 28 57 61 6c  te3WalDbsize(Wal
0bf0: 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20 49 66 20   *pWal);../* If 
0c00: 61 20 57 41 4c 20 6a 6f 75 72 6e 61 6c 20 66 69  a WAL journal fi
0c10: 6c 65 20 68 61 73 20 62 65 65 6e 20 63 72 65 61  le has been crea
0c20: 74 65 64 2c 20 72 65 74 75 72 6e 20 69 74 20 2a  ted, return it *
0c30: 2f 0a 73 71 6c 69 74 65 33 5f 66 69 6c 65 20 2a  /.sqlite3_file *
0c40: 73 71 6c 69 74 65 33 57 61 6c 46 69 6c 65 28 57  sqlite3WalFile(W
0c50: 61 6c 20 2a 70 57 61 6c 29 3b 0a 20 20 0a 2f 2a  al *pWal);.  ./*
0c60: 20 4f 62 74 61 69 6e 20 6f 72 20 72 65 6c 65 61   Obtain or relea
0c70: 73 65 20 74 68 65 20 57 52 49 54 45 52 20 6c 6f  se the WRITER lo
0c80: 63 6b 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  ck. */.int sqlit
0c90: 65 33 57 61 6c 42 65 67 69 6e 57 72 69 74 65 54  e3WalBeginWriteT
0ca0: 72 61 6e 73 61 63 74 69 6f 6e 28 57 61 6c 20 2a  ransaction(Wal *
0cb0: 70 57 61 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74  pWal);.int sqlit
0cc0: 65 33 57 61 6c 45 6e 64 57 72 69 74 65 54 72 61  e3WalEndWriteTra
0cd0: 6e 73 61 63 74 69 6f 6e 28 57 61 6c 20 2a 70 57  nsaction(Wal *pW
0ce0: 61 6c 29 3b 0a 0a 2f 2a 20 55 6e 64 6f 20 61 6e  al);../* Undo an
0cf0: 79 20 66 72 61 6d 65 73 20 77 72 69 74 74 65 6e  y frames written
0d00: 20 28 62 75 74 20 6e 6f 74 20 63 6f 6d 6d 69 74   (but not commit
0d10: 74 65 64 29 20 74 6f 20 74 68 65 20 6c 6f 67 20  ted) to the log 
0d20: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  */.int sqlite3Wa
0d30: 6c 55 6e 64 6f 28 57 61 6c 20 2a 70 57 61 6c 2c  lUndo(Wal *pWal,
0d40: 20 69 6e 74 20 28 2a 78 55 6e 64 6f 29 28 76 6f   int (*xUndo)(vo
0d50: 69 64 20 2a 2c 20 50 67 6e 6f 29 2c 20 76 6f 69  id *, Pgno), voi
0d60: 64 20 2a 70 55 6e 64 6f 43 74 78 29 3b 0a 0a 2f  d *pUndoCtx);../
0d70: 2a 20 52 65 74 75 72 6e 20 61 6e 20 69 6e 74 65  * Return an inte
0d80: 67 65 72 20 74 68 61 74 20 72 65 63 6f 72 64 73  ger that records
0d90: 20 74 68 65 20 63 75 72 72 65 6e 74 20 28 75 6e   the current (un
0da0: 63 6f 6d 6d 69 74 74 65 64 29 20 77 72 69 74 65  committed) write
0db0: 0a 2a 2a 20 70 6f 73 69 74 69 6f 6e 20 69 6e 20  .** position in 
0dc0: 74 68 65 20 57 41 4c 20 2a 2f 0a 76 6f 69 64 20  the WAL */.void 
0dd0: 73 71 6c 69 74 65 33 57 61 6c 53 61 76 65 70 6f  sqlite3WalSavepo
0de0: 69 6e 74 28 57 61 6c 20 2a 70 57 61 6c 2c 20 75  int(Wal *pWal, u
0df0: 33 32 20 2a 61 57 61 6c 44 61 74 61 29 3b 0a 0a  32 *aWalData);..
0e00: 2f 2a 20 4d 6f 76 65 20 74 68 65 20 77 72 69 74  /* Move the writ
0e10: 65 20 70 6f 73 69 74 69 6f 6e 20 6f 66 20 74 68  e position of th
0e20: 65 20 57 41 4c 20 62 61 63 6b 20 74 6f 20 69 46  e WAL back to iF
0e30: 72 61 6d 65 2e 20 20 43 61 6c 6c 65 64 20 69 6e  rame.  Called in
0e40: 0a 2a 2a 20 72 65 73 70 6f 6e 73 65 20 74 6f 20  .** response to 
0e50: 61 20 52 4f 4c 4c 42 41 43 4b 20 54 4f 20 63 6f  a ROLLBACK TO co
0e60: 6d 6d 61 6e 64 2e 20 2a 2f 0a 69 6e 74 20 73 71  mmand. */.int sq
0e70: 6c 69 74 65 33 57 61 6c 53 61 76 65 70 6f 69 6e  lite3WalSavepoin
0e80: 74 55 6e 64 6f 28 57 61 6c 20 2a 70 57 61 6c 2c  tUndo(Wal *pWal,
0e90: 20 75 33 32 20 2a 61 57 61 6c 44 61 74 61 29 3b   u32 *aWalData);
0ea0: 0a 0a 2f 2a 20 57 72 69 74 65 20 61 20 66 72 61  ../* Write a fra
0eb0: 6d 65 20 6f 72 20 66 72 61 6d 65 73 20 74 6f 20  me or frames to 
0ec0: 74 68 65 20 6c 6f 67 2e 20 2a 2f 0a 69 6e 74 20  the log. */.int 
0ed0: 73 71 6c 69 74 65 33 57 61 6c 46 72 61 6d 65 73  sqlite3WalFrames
0ee0: 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69 6e 74 2c  (Wal *pWal, int,
0ef0: 20 50 67 48 64 72 20 2a 2c 20 50 67 6e 6f 2c 20   PgHdr *, Pgno, 
0f00: 69 6e 74 2c 20 69 6e 74 29 3b 0a 0a 2f 2a 20 43  int, int);../* C
0f10: 6f 70 79 20 70 61 67 65 73 20 66 72 6f 6d 20 74  opy pages from t
0f20: 68 65 20 6c 6f 67 20 74 6f 20 74 68 65 20 64 61  he log to the da
0f30: 74 61 62 61 73 65 20 66 69 6c 65 20 2a 2f 20 0a  tabase file */ .
0f40: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 43 68  int sqlite3WalCh
0f50: 65 63 6b 70 6f 69 6e 74 28 0a 20 20 57 61 6c 20  eckpoint(.  Wal 
0f60: 2a 70 57 61 6c 2c 20 20 20 20 20 20 20 20 20 20  *pWal,          
0f70: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 57              /* W
0f80: 72 69 74 65 2d 61 68 65 61 64 20 6c 6f 67 20 63  rite-ahead log c
0f90: 6f 6e 6e 65 63 74 69 6f 6e 20 2a 2f 0a 20 20 73  onnection */.  s
0fa0: 71 6c 69 74 65 33 20 2a 64 62 2c 20 20 20 20 20  qlite3 *db,     
0fb0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
0fc0: 2a 20 43 68 65 63 6b 20 74 68 69 73 20 68 61 6e  * Check this han
0fd0: 64 6c 65 27 73 20 69 6e 74 65 72 72 75 70 74 20  dle's interrupt 
0fe0: 66 6c 61 67 20 2a 2f 0a 20 20 69 6e 74 20 65 4d  flag */.  int eM
0ff0: 6f 64 65 2c 20 20 20 20 20 20 20 20 20 20 20 20  ode,            
1000: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4f 6e 65            /* One
1010: 20 6f 66 20 50 41 53 53 49 56 45 2c 20 46 55 4c   of PASSIVE, FUL
1020: 4c 20 61 6e 64 20 52 45 53 54 41 52 54 20 2a 2f  L and RESTART */
1030: 0a 20 20 69 6e 74 20 28 2a 78 42 75 73 79 29 28  .  int (*xBusy)(
1040: 76 6f 69 64 2a 29 2c 20 20 20 20 20 20 20 20 20  void*),         
1050: 20 20 20 2f 2a 20 46 75 6e 63 74 69 6f 6e 20 74     /* Function t
1060: 6f 20 63 61 6c 6c 20 77 68 65 6e 20 62 75 73 79  o call when busy
1070: 20 2a 2f 0a 20 20 76 6f 69 64 20 2a 70 42 75 73   */.  void *pBus
1080: 79 41 72 67 2c 20 20 20 20 20 20 20 20 20 20 20  yArg,           
1090: 20 20 20 20 20 20 2f 2a 20 43 6f 6e 74 65 78 74        /* Context
10a0: 20 61 72 67 75 6d 65 6e 74 20 66 6f 72 20 78 42   argument for xB
10b0: 75 73 79 48 61 6e 64 6c 65 72 20 2a 2f 0a 20 20  usyHandler */.  
10c0: 69 6e 74 20 73 79 6e 63 5f 66 6c 61 67 73 2c 20  int sync_flags, 
10d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
10e0: 2f 2a 20 46 6c 61 67 73 20 74 6f 20 73 79 6e 63  /* Flags to sync
10f0: 20 64 62 20 66 69 6c 65 20 77 69 74 68 20 28 6f   db file with (o
1100: 72 20 30 29 20 2a 2f 0a 20 20 69 6e 74 20 6e 42  r 0) */.  int nB
1110: 75 66 2c 20 20 20 20 20 20 20 20 20 20 20 20 20  uf,             
1120: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 53 69 7a            /* Siz
1130: 65 20 6f 66 20 62 75 66 66 65 72 20 6e 42 75 66  e of buffer nBuf
1140: 20 2a 2f 0a 20 20 75 38 20 2a 7a 42 75 66 2c 20   */.  u8 *zBuf, 
1150: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1160: 20 20 20 20 20 20 2f 2a 20 54 65 6d 70 6f 72 61        /* Tempora
1170: 72 79 20 62 75 66 66 65 72 20 74 6f 20 75 73 65  ry buffer to use
1180: 20 2a 2f 0a 20 20 69 6e 74 20 2a 70 6e 4c 6f 67   */.  int *pnLog
1190: 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ,               
11a0: 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a 20 4e 75        /* OUT: Nu
11b0: 6d 62 65 72 20 6f 66 20 66 72 61 6d 65 73 20 69  mber of frames i
11c0: 6e 20 57 41 4c 20 2a 2f 0a 20 20 69 6e 74 20 2a  n WAL */.  int *
11d0: 70 6e 43 6b 70 74 20 20 20 20 20 20 20 20 20 20  pnCkpt          
11e0: 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4f 55             /* OU
11f0: 54 3a 20 4e 75 6d 62 65 72 20 6f 66 20 62 61 63  T: Number of bac
1200: 6b 66 69 6c 6c 65 64 20 66 72 61 6d 65 73 20 69  kfilled frames i
1210: 6e 20 57 41 4c 20 2a 2f 0a 29 3b 0a 0a 2f 2a 20  n WAL */.);../* 
1220: 52 65 74 75 72 6e 20 74 68 65 20 76 61 6c 75 65  Return the value
1230: 20 74 6f 20 70 61 73 73 20 74 6f 20 61 20 73 71   to pass to a sq
1240: 6c 69 74 65 33 5f 77 61 6c 5f 68 6f 6f 6b 20 63  lite3_wal_hook c
1250: 61 6c 6c 62 61 63 6b 2c 20 74 68 65 0a 2a 2a 20  allback, the.** 
1260: 6e 75 6d 62 65 72 20 6f 66 20 66 72 61 6d 65 73  number of frames
1270: 20 69 6e 20 74 68 65 20 57 41 4c 20 61 74 20 74   in the WAL at t
1280: 68 65 20 70 6f 69 6e 74 20 6f 66 20 74 68 65 20  he point of the 
1290: 6c 61 73 74 20 63 6f 6d 6d 69 74 20 73 69 6e 63  last commit sinc
12a0: 65 0a 2a 2a 20 73 71 6c 69 74 65 33 57 61 6c 43  e.** sqlite3WalC
12b0: 61 6c 6c 62 61 63 6b 28 29 20 77 61 73 20 63 61  allback() was ca
12c0: 6c 6c 65 64 2e 20 20 49 66 20 6e 6f 20 63 6f 6d  lled.  If no com
12d0: 6d 69 74 73 20 68 61 76 65 20 6f 63 63 75 72 72  mits have occurr
12e0: 65 64 20 73 69 6e 63 65 0a 2a 2a 20 74 68 65 20  ed since.** the 
12f0: 6c 61 73 74 20 63 61 6c 6c 2c 20 74 68 65 6e 20  last call, then 
1300: 72 65 74 75 72 6e 20 30 2e 0a 2a 2f 0a 69 6e 74  return 0..*/.int
1310: 20 73 71 6c 69 74 65 33 57 61 6c 43 61 6c 6c 62   sqlite3WalCallb
1320: 61 63 6b 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a  ack(Wal *pWal);.
1330: 0a 2f 2a 20 54 65 6c 6c 20 74 68 65 20 77 61 6c  ./* Tell the wal
1340: 20 6c 61 79 65 72 20 74 68 61 74 20 61 6e 20 45   layer that an E
1350: 58 43 4c 55 53 49 56 45 20 6c 6f 63 6b 20 68 61  XCLUSIVE lock ha
1360: 73 20 62 65 65 6e 20 6f 62 74 61 69 6e 65 64 20  s been obtained 
1370: 28 6f 72 20 72 65 6c 65 61 73 65 64 29 0a 2a 2a  (or released).**
1380: 20 62 79 20 74 68 65 20 70 61 67 65 72 20 6c 61   by the pager la
1390: 79 65 72 20 6f 6e 20 74 68 65 20 64 61 74 61 62  yer on the datab
13a0: 61 73 65 20 66 69 6c 65 2e 0a 2a 2f 0a 69 6e 74  ase file..*/.int
13b0: 20 73 71 6c 69 74 65 33 57 61 6c 45 78 63 6c 75   sqlite3WalExclu
13c0: 73 69 76 65 4d 6f 64 65 28 57 61 6c 20 2a 70 57  siveMode(Wal *pW
13d0: 61 6c 2c 20 69 6e 74 20 6f 70 29 3b 0a 0a 2f 2a  al, int op);../*
13e0: 20 52 65 74 75 72 6e 20 74 72 75 65 20 69 66 20   Return true if 
13f0: 74 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20  the argument is 
1400: 6e 6f 6e 2d 4e 55 4c 4c 20 61 6e 64 20 74 68 65  non-NULL and the
1410: 20 57 41 4c 20 6d 6f 64 75 6c 65 20 69 73 20 75   WAL module is u
1420: 73 69 6e 67 0a 2a 2a 20 68 65 61 70 2d 6d 65 6d  sing.** heap-mem
1430: 6f 72 79 20 66 6f 72 20 74 68 65 20 77 61 6c 2d  ory for the wal-
1440: 69 6e 64 65 78 2e 20 4f 74 68 65 72 77 69 73 65  index. Otherwise
1450: 2c 20 69 66 20 74 68 65 20 61 72 67 75 6d 65 6e  , if the argumen
1460: 74 20 69 73 20 4e 55 4c 4c 20 6f 72 20 74 68 65  t is NULL or the
1470: 0a 2a 2a 20 57 41 4c 20 6d 6f 64 75 6c 65 20 69  .** WAL module i
1480: 73 20 75 73 69 6e 67 20 73 68 61 72 65 64 2d 6d  s using shared-m
1490: 65 6d 6f 72 79 2c 20 72 65 74 75 72 6e 20 66 61  emory, return fa
14a0: 6c 73 65 2e 20 0a 2a 2f 0a 69 6e 74 20 73 71 6c  lse. .*/.int sql
14b0: 69 74 65 33 57 61 6c 48 65 61 70 4d 65 6d 6f 72  ite3WalHeapMemor
14c0: 79 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 23  y(Wal *pWal);..#
14d0: 69 66 64 65 66 20 53 51 4c 49 54 45 5f 45 4e 41  ifdef SQLITE_ENA
14e0: 42 4c 45 5f 53 4e 41 50 53 48 4f 54 0a 69 6e 74  BLE_SNAPSHOT.int
14f0: 20 73 71 6c 69 74 65 33 57 61 6c 53 6e 61 70 73   sqlite3WalSnaps
1500: 68 6f 74 47 65 74 28 57 61 6c 20 2a 70 57 61 6c  hotGet(Wal *pWal
1510: 2c 20 73 71 6c 69 74 65 33 5f 73 6e 61 70 73 68  , sqlite3_snapsh
1520: 6f 74 20 2a 2a 70 70 53 6e 61 70 73 68 6f 74 29  ot **ppSnapshot)
1530: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61  ;.void sqlite3Wa
1540: 6c 53 6e 61 70 73 68 6f 74 4f 70 65 6e 28 57 61  lSnapshotOpen(Wa
1550: 6c 20 2a 70 57 61 6c 2c 20 73 71 6c 69 74 65 33  l *pWal, sqlite3
1560: 5f 73 6e 61 70 73 68 6f 74 20 2a 70 53 6e 61 70  _snapshot *pSnap
1570: 73 68 6f 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74  shot);.int sqlit
1580: 65 33 57 61 6c 53 6e 61 70 73 68 6f 74 52 65 63  e3WalSnapshotRec
1590: 6f 76 65 72 28 57 61 6c 20 2a 70 57 61 6c 29 3b  over(Wal *pWal);
15a0: 0a 23 65 6e 64 69 66 0a 0a 23 69 66 64 65 66 20  .#endif..#ifdef 
15b0: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 5a 49  SQLITE_ENABLE_ZI
15c0: 50 56 46 53 0a 2f 2a 20 49 66 20 74 68 65 20 57  PVFS./* If the W
15d0: 41 4c 20 66 69 6c 65 20 69 73 20 6e 6f 74 20 65  AL file is not e
15e0: 6d 70 74 79 2c 20 72 65 74 75 72 6e 20 74 68 65  mpty, return the
15f0: 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73   number of bytes
1600: 20 6f 66 20 63 6f 6e 74 65 6e 74 0a 2a 2a 20 73   of content.** s
1610: 74 6f 72 65 64 20 69 6e 20 65 61 63 68 20 66 72  tored in each fr
1620: 61 6d 65 20 28 69 2e 65 2e 20 74 68 65 20 64 62  ame (i.e. the db
1630: 20 70 61 67 65 2d 73 69 7a 65 20 77 68 65 6e 20   page-size when 
1640: 74 68 65 20 57 41 4c 20 77 61 73 20 63 72 65 61  the WAL was crea
1650: 74 65 64 29 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  ted)..*/.int sql
1660: 69 74 65 33 57 61 6c 46 72 61 6d 65 73 69 7a 65  ite3WalFramesize
1670: 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 23 65 6e  (Wal *pWal);.#en
1680: 64 69 66 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74  dif../* Return t
1690: 68 65 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 20  he sqlite3_file 
16a0: 6f 62 6a 65 63 74 20 66 6f 72 20 74 68 65 20 57  object for the W
16b0: 41 4c 20 66 69 6c 65 20 2a 2f 0a 73 71 6c 69 74  AL file */.sqlit
16c0: 65 33 5f 66 69 6c 65 20 2a 73 71 6c 69 74 65 33  e3_file *sqlite3
16d0: 57 61 6c 46 69 6c 65 28 57 61 6c 20 2a 70 57 61  WalFile(Wal *pWa
16e0: 6c 29 3b 0a 0a 23 65 6e 64 69 66 20 2f 2a 20 69  l);..#endif /* i
16f0: 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d 49  fndef SQLITE_OMI
1700: 54 5f 57 41 4c 20 2a 2f 0a 23 65 6e 64 69 66 20  T_WAL */.#endif 
1710: 2f 2a 20 53 51 4c 49 54 45 5f 57 41 4c 5f 48 20  /* SQLITE_WAL_H 
1720: 2a 2f 0a                                         */.