/ Hex Artifact Content
Login

Artifact c398e0269e8f37495cedb63b5e288c2aac6f6d103d05fb55f4affec21311615d:


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 77 2c 78 2c 79 2c  e3WalOpen(w,x,y,
03b0: 7a 29 20 20 20 20 20 20 20 20 20 20 20 20 20 20  z)              
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 20 64             0.# d
0730: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 57 61 6c  efine sqlite3Wal
0740: 4a 6f 75 72 6e 61 6c 4d 6f 64 65 28 78 29 20 20  JournalMode(x)  
0750: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0a                0.
0760: 23 65 6c 73 65 0a 0a 23 64 65 66 69 6e 65 20 57  #else..#define W
0770: 41 4c 5f 53 41 56 45 50 4f 49 4e 54 5f 4e 44 41  AL_SAVEPOINT_NDA
0780: 54 41 20 34 0a 0a 2f 2a 20 43 6f 6e 6e 65 63 74  TA 4../* Connect
0790: 69 6f 6e 20 74 6f 20 61 20 77 72 69 74 65 2d 61  ion to a write-a
07a0: 68 65 61 64 20 6c 6f 67 20 28 57 41 4c 29 20 66  head log (WAL) f
07b0: 69 6c 65 2e 20 0a 2a 2a 20 54 68 65 72 65 20 69  ile. .** There i
07c0: 73 20 6f 6e 65 20 6f 62 6a 65 63 74 20 6f 66 20  s one object of 
07d0: 74 68 69 73 20 74 79 70 65 20 66 6f 72 20 65 61  this type for ea
07e0: 63 68 20 70 61 67 65 72 2e 20 0a 2a 2f 0a 74 79  ch pager. .*/.ty
07f0: 70 65 64 65 66 20 73 74 72 75 63 74 20 57 61 6c  pedef struct Wal
0800: 20 57 61 6c 3b 0a 0a 2f 2a 20 4f 70 65 6e 20 61   Wal;../* Open a
0810: 6e 64 20 63 6c 6f 73 65 20 61 20 63 6f 6e 6e 65  nd close a conne
0820: 63 74 69 6f 6e 20 74 6f 20 61 20 77 72 69 74 65  ction to a write
0830: 2d 61 68 65 61 64 20 6c 6f 67 2e 20 2a 2f 0a 69  -ahead log. */.i
0840: 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 4f 70 65  nt sqlite3WalOpe
0850: 6e 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20  n(sqlite3_vfs*, 
0860: 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 63  sqlite3_file*, c
0870: 6f 6e 73 74 20 63 68 61 72 20 2a 2c 69 6e 74 2c  onst char *,int,
0880: 69 36 34 2c 69 6e 74 2c 57 61 6c 2a 2a 29 3b 0a  i64,int,Wal**);.
0890: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 43 6c  int sqlite3WalCl
08a0: 6f 73 65 28 57 61 6c 20 2a 70 57 61 6c 2c 20 73  ose(Wal *pWal, s
08b0: 71 6c 69 74 65 33 2a 2c 20 69 6e 74 20 73 79 6e  qlite3*, int syn
08c0: 63 5f 66 6c 61 67 73 2c 20 69 6e 74 2c 20 75 38  c_flags, int, u8
08d0: 20 2a 29 3b 0a 0a 2f 2a 20 53 65 74 20 74 68 65   *);../* Set the
08e0: 20 6c 69 6d 69 74 69 6e 67 20 73 69 7a 65 20 6f   limiting size o
08f0: 66 20 61 20 57 41 4c 20 66 69 6c 65 2e 20 2a 2f  f a WAL file. */
0900: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61 6c  .void sqlite3Wal
0910: 4c 69 6d 69 74 28 57 61 6c 2a 2c 20 69 36 34 29  Limit(Wal*, i64)
0920: 3b 0a 0a 2f 2a 20 55 73 65 64 20 62 79 20 72 65  ;../* Used by re
0930: 61 64 65 72 73 20 74 6f 20 6f 70 65 6e 20 28 6c  aders to open (l
0940: 6f 63 6b 29 20 61 6e 64 20 63 6c 6f 73 65 20 28  ock) and close (
0950: 75 6e 6c 6f 63 6b 29 20 61 20 73 6e 61 70 73 68  unlock) a snapsh
0960: 6f 74 2e 20 20 41 20 0a 2a 2a 20 73 6e 61 70 73  ot.  A .** snaps
0970: 68 6f 74 20 69 73 20 6c 69 6b 65 20 61 20 72 65  hot is like a re
0980: 61 64 2d 74 72 61 6e 73 61 63 74 69 6f 6e 2e 20  ad-transaction. 
0990: 20 49 74 20 69 73 20 74 68 65 20 73 74 61 74 65   It is the state
09a0: 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73 65   of the database
09b0: 0a 2a 2a 20 61 74 20 61 6e 20 69 6e 73 74 61 6e  .** at an instan
09c0: 74 20 69 6e 20 74 69 6d 65 2e 20 20 73 71 6c 69  t in time.  sqli
09d0: 74 65 33 57 61 6c 4f 70 65 6e 53 6e 61 70 73 68  te3WalOpenSnapsh
09e0: 6f 74 20 67 65 74 73 20 61 20 72 65 61 64 20 6c  ot gets a read l
09f0: 6f 63 6b 20 61 6e 64 0a 2a 2a 20 70 72 65 73 65  ock and.** prese
0a00: 72 76 65 73 20 74 68 65 20 63 75 72 72 65 6e 74  rves the current
0a10: 20 73 74 61 74 65 20 65 76 65 6e 20 69 66 20 74   state even if t
0a20: 68 65 20 6f 74 68 65 72 20 74 68 72 65 61 64 73  he other threads
0a30: 20 6f 72 20 70 72 6f 63 65 73 73 65 73 0a 2a 2a   or processes.**
0a40: 20 77 72 69 74 65 20 74 6f 20 6f 72 20 63 68 65   write to or che
0a50: 63 6b 70 6f 69 6e 74 20 74 68 65 20 57 41 4c 2e  ckpoint the WAL.
0a60: 20 20 73 71 6c 69 74 65 33 57 61 6c 43 6c 6f 73    sqlite3WalClos
0a70: 65 53 6e 61 70 73 68 6f 74 28 29 20 63 6c 6f 73  eSnapshot() clos
0a80: 65 73 20 74 68 65 0a 2a 2a 20 74 72 61 6e 73 61  es the.** transa
0a90: 63 74 69 6f 6e 20 61 6e 64 20 72 65 6c 65 61 73  ction and releas
0aa0: 65 73 20 74 68 65 20 6c 6f 63 6b 2e 0a 2a 2f 0a  es the lock..*/.
0ab0: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 42 65  int sqlite3WalBe
0ac0: 67 69 6e 52 65 61 64 54 72 61 6e 73 61 63 74 69  ginReadTransacti
0ad0: 6f 6e 28 57 61 6c 20 2a 70 57 61 6c 2c 20 69 6e  on(Wal *pWal, in
0ae0: 74 20 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74  t *);.void sqlit
0af0: 65 33 57 61 6c 45 6e 64 52 65 61 64 54 72 61 6e  e3WalEndReadTran
0b00: 73 61 63 74 69 6f 6e 28 57 61 6c 20 2a 70 57 61  saction(Wal *pWa
0b10: 6c 29 3b 0a 0a 2f 2a 20 52 65 61 64 20 61 20 70  l);../* Read a p
0b20: 61 67 65 20 66 72 6f 6d 20 74 68 65 20 77 72 69  age from the wri
0b30: 74 65 2d 61 68 65 61 64 20 6c 6f 67 2c 20 69 66  te-ahead log, if
0b40: 20 69 74 20 69 73 20 70 72 65 73 65 6e 74 2e 20   it is present. 
0b50: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  */.int sqlite3Wa
0b60: 6c 46 69 6e 64 46 72 61 6d 65 28 57 61 6c 20 2a  lFindFrame(Wal *
0b70: 2c 20 50 67 6e 6f 2c 20 75 33 32 20 2a 29 3b 0a  , Pgno, u32 *);.
0b80: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 52 65  int sqlite3WalRe
0b90: 61 64 46 72 61 6d 65 28 57 61 6c 20 2a 2c 20 75  adFrame(Wal *, u
0ba0: 33 32 2c 20 69 6e 74 2c 20 75 38 20 2a 29 3b 0a  32, int, u8 *);.
0bb0: 0a 2f 2a 20 49 66 20 74 68 65 20 57 41 4c 20 69  ./* If the WAL i
0bc0: 73 20 6e 6f 74 20 65 6d 70 74 79 2c 20 72 65 74  s not empty, ret
0bd0: 75 72 6e 20 74 68 65 20 73 69 7a 65 20 6f 66 20  urn the size of 
0be0: 74 68 65 20 64 61 74 61 62 61 73 65 2e 20 2a 2f  the database. */
0bf0: 0a 50 67 6e 6f 20 73 71 6c 69 74 65 33 57 61 6c  .Pgno sqlite3Wal
0c00: 44 62 73 69 7a 65 28 57 61 6c 20 2a 70 57 61 6c  Dbsize(Wal *pWal
0c10: 29 3b 0a 0a 2f 2a 20 4f 62 74 61 69 6e 20 6f 72  );../* Obtain or
0c20: 20 72 65 6c 65 61 73 65 20 74 68 65 20 57 52 49   release the WRI
0c30: 54 45 52 20 6c 6f 63 6b 2e 20 2a 2f 0a 69 6e 74  TER lock. */.int
0c40: 20 73 71 6c 69 74 65 33 57 61 6c 42 65 67 69 6e   sqlite3WalBegin
0c50: 57 72 69 74 65 54 72 61 6e 73 61 63 74 69 6f 6e  WriteTransaction
0c60: 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 69 6e 74  (Wal *pWal);.int
0c70: 20 73 71 6c 69 74 65 33 57 61 6c 45 6e 64 57 72   sqlite3WalEndWr
0c80: 69 74 65 54 72 61 6e 73 61 63 74 69 6f 6e 28 57  iteTransaction(W
0c90: 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20 55  al *pWal);../* U
0ca0: 6e 64 6f 20 61 6e 79 20 66 72 61 6d 65 73 20 77  ndo any frames w
0cb0: 72 69 74 74 65 6e 20 28 62 75 74 20 6e 6f 74 20  ritten (but not 
0cc0: 63 6f 6d 6d 69 74 74 65 64 29 20 74 6f 20 74 68  committed) to th
0cd0: 65 20 6c 6f 67 20 2a 2f 0a 69 6e 74 20 73 71 6c  e log */.int sql
0ce0: 69 74 65 33 57 61 6c 55 6e 64 6f 28 57 61 6c 20  ite3WalUndo(Wal 
0cf0: 2a 70 57 61 6c 2c 20 69 6e 74 20 28 2a 78 55 6e  *pWal, int (*xUn
0d00: 64 6f 29 28 76 6f 69 64 20 2a 2c 20 50 67 6e 6f  do)(void *, Pgno
0d10: 29 2c 20 76 6f 69 64 20 2a 70 55 6e 64 6f 43 74  ), void *pUndoCt
0d20: 78 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 61  x);../* Return a
0d30: 6e 20 69 6e 74 65 67 65 72 20 74 68 61 74 20 72  n integer that r
0d40: 65 63 6f 72 64 73 20 74 68 65 20 63 75 72 72 65  ecords the curre
0d50: 6e 74 20 28 75 6e 63 6f 6d 6d 69 74 74 65 64 29  nt (uncommitted)
0d60: 20 77 72 69 74 65 0a 2a 2a 20 70 6f 73 69 74 69   write.** positi
0d70: 6f 6e 20 69 6e 20 74 68 65 20 57 41 4c 20 2a 2f  on in the WAL */
0d80: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 57 61 6c  .void sqlite3Wal
0d90: 53 61 76 65 70 6f 69 6e 74 28 57 61 6c 20 2a 70  Savepoint(Wal *p
0da0: 57 61 6c 2c 20 75 33 32 20 2a 61 57 61 6c 44 61  Wal, u32 *aWalDa
0db0: 74 61 29 3b 0a 0a 2f 2a 20 4d 6f 76 65 20 74 68  ta);../* Move th
0dc0: 65 20 77 72 69 74 65 20 70 6f 73 69 74 69 6f 6e  e write position
0dd0: 20 6f 66 20 74 68 65 20 57 41 4c 20 62 61 63 6b   of the WAL back
0de0: 20 74 6f 20 69 46 72 61 6d 65 2e 20 20 43 61 6c   to iFrame.  Cal
0df0: 6c 65 64 20 69 6e 0a 2a 2a 20 72 65 73 70 6f 6e  led in.** respon
0e00: 73 65 20 74 6f 20 61 20 52 4f 4c 4c 42 41 43 4b  se to a ROLLBACK
0e10: 20 54 4f 20 63 6f 6d 6d 61 6e 64 2e 20 2a 2f 0a   TO command. */.
0e20: 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 53 61  int sqlite3WalSa
0e30: 76 65 70 6f 69 6e 74 55 6e 64 6f 28 57 61 6c 20  vepointUndo(Wal 
0e40: 2a 70 57 61 6c 2c 20 75 33 32 20 2a 61 57 61 6c  *pWal, u32 *aWal
0e50: 44 61 74 61 29 3b 0a 0a 2f 2a 20 57 72 69 74 65  Data);../* Write
0e60: 20 61 20 66 72 61 6d 65 20 6f 72 20 66 72 61 6d   a frame or fram
0e70: 65 73 20 74 6f 20 74 68 65 20 6c 6f 67 2e 20 2a  es to the log. *
0e80: 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61 6c  /.int sqlite3Wal
0e90: 46 72 61 6d 65 73 28 57 61 6c 20 2a 70 57 61 6c  Frames(Wal *pWal
0ea0: 2c 20 69 6e 74 2c 20 50 67 48 64 72 20 2a 2c 20  , int, PgHdr *, 
0eb0: 50 67 6e 6f 2c 20 69 6e 74 2c 20 69 6e 74 29 3b  Pgno, int, int);
0ec0: 0a 0a 2f 2a 20 43 6f 70 79 20 70 61 67 65 73 20  ../* Copy pages 
0ed0: 66 72 6f 6d 20 74 68 65 20 6c 6f 67 20 74 6f 20  from the log to 
0ee0: 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c  the database fil
0ef0: 65 20 2a 2f 20 0a 69 6e 74 20 73 71 6c 69 74 65  e */ .int sqlite
0f00: 33 57 61 6c 43 68 65 63 6b 70 6f 69 6e 74 28 0a  3WalCheckpoint(.
0f10: 20 20 57 61 6c 20 2a 70 57 61 6c 2c 20 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 2f 2a 20 57 72 69 74 65 2d 61 68 65 61 64    /* Write-ahead
0f40: 20 6c 6f 67 20 63 6f 6e 6e 65 63 74 69 6f 6e 20   log connection 
0f50: 2a 2f 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62  */.  sqlite3 *db
0f60: 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ,               
0f70: 20 20 20 20 20 2f 2a 20 43 68 65 63 6b 20 74 68       /* Check th
0f80: 69 73 20 68 61 6e 64 6c 65 27 73 20 69 6e 74 65  is handle's inte
0f90: 72 72 75 70 74 20 66 6c 61 67 20 2a 2f 0a 20 20  rrupt flag */.  
0fa0: 69 6e 74 20 65 4d 6f 64 65 2c 20 20 20 20 20 20  int eMode,      
0fb0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0fc0: 2f 2a 20 4f 6e 65 20 6f 66 20 50 41 53 53 49 56  /* One of PASSIV
0fd0: 45 2c 20 46 55 4c 4c 20 61 6e 64 20 52 45 53 54  E, FULL and REST
0fe0: 41 52 54 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78  ART */.  int (*x
0ff0: 42 75 73 79 29 28 76 6f 69 64 2a 29 2c 20 20 20  Busy)(void*),   
1000: 20 20 20 20 20 20 20 20 20 2f 2a 20 46 75 6e 63           /* Func
1010: 74 69 6f 6e 20 74 6f 20 63 61 6c 6c 20 77 68 65  tion to call whe
1020: 6e 20 62 75 73 79 20 2a 2f 0a 20 20 76 6f 69 64  n busy */.  void
1030: 20 2a 70 42 75 73 79 41 72 67 2c 20 20 20 20 20   *pBusyArg,     
1040: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 43              /* C
1050: 6f 6e 74 65 78 74 20 61 72 67 75 6d 65 6e 74 20  ontext argument 
1060: 66 6f 72 20 78 42 75 73 79 48 61 6e 64 6c 65 72  for xBusyHandler
1070: 20 2a 2f 0a 20 20 69 6e 74 20 73 79 6e 63 5f 66   */.  int sync_f
1080: 6c 61 67 73 2c 20 20 20 20 20 20 20 20 20 20 20  lags,           
1090: 20 20 20 20 20 20 2f 2a 20 46 6c 61 67 73 20 74        /* Flags t
10a0: 6f 20 73 79 6e 63 20 64 62 20 66 69 6c 65 20 77  o sync db file w
10b0: 69 74 68 20 28 6f 72 20 30 29 20 2a 2f 0a 20 20  ith (or 0) */.  
10c0: 69 6e 74 20 6e 42 75 66 2c 20 20 20 20 20 20 20  int nBuf,       
10d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
10e0: 2f 2a 20 53 69 7a 65 20 6f 66 20 62 75 66 66 65  /* Size of buffe
10f0: 72 20 6e 42 75 66 20 2a 2f 0a 20 20 75 38 20 2a  r nBuf */.  u8 *
1100: 7a 42 75 66 2c 20 20 20 20 20 20 20 20 20 20 20  zBuf,           
1110: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 54              /* T
1120: 65 6d 70 6f 72 61 72 79 20 62 75 66 66 65 72 20  emporary buffer 
1130: 74 6f 20 75 73 65 20 2a 2f 0a 20 20 69 6e 74 20  to use */.  int 
1140: 2a 70 6e 4c 6f 67 2c 20 20 20 20 20 20 20 20 20  *pnLog,         
1150: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4f              /* O
1160: 55 54 3a 20 4e 75 6d 62 65 72 20 6f 66 20 66 72  UT: Number of fr
1170: 61 6d 65 73 20 69 6e 20 57 41 4c 20 2a 2f 0a 20  ames in WAL */. 
1180: 20 69 6e 74 20 2a 70 6e 43 6b 70 74 20 20 20 20   int *pnCkpt    
1190: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
11a0: 20 2f 2a 20 4f 55 54 3a 20 4e 75 6d 62 65 72 20   /* OUT: Number 
11b0: 6f 66 20 62 61 63 6b 66 69 6c 6c 65 64 20 66 72  of backfilled fr
11c0: 61 6d 65 73 20 69 6e 20 57 41 4c 20 2a 2f 0a 29  ames in WAL */.)
11d0: 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74 68 65  ;../* Return the
11e0: 20 76 61 6c 75 65 20 74 6f 20 70 61 73 73 20 74   value to pass t
11f0: 6f 20 61 20 73 71 6c 69 74 65 33 5f 77 61 6c 5f  o a sqlite3_wal_
1200: 68 6f 6f 6b 20 63 61 6c 6c 62 61 63 6b 2c 20 74  hook callback, t
1210: 68 65 0a 2a 2a 20 6e 75 6d 62 65 72 20 6f 66 20  he.** number of 
1220: 66 72 61 6d 65 73 20 69 6e 20 74 68 65 20 57 41  frames in the WA
1230: 4c 20 61 74 20 74 68 65 20 70 6f 69 6e 74 20 6f  L at the point o
1240: 66 20 74 68 65 20 6c 61 73 74 20 63 6f 6d 6d 69  f the last commi
1250: 74 20 73 69 6e 63 65 0a 2a 2a 20 73 71 6c 69 74  t since.** sqlit
1260: 65 33 57 61 6c 43 61 6c 6c 62 61 63 6b 28 29 20  e3WalCallback() 
1270: 77 61 73 20 63 61 6c 6c 65 64 2e 20 20 49 66 20  was called.  If 
1280: 6e 6f 20 63 6f 6d 6d 69 74 73 20 68 61 76 65 20  no commits have 
1290: 6f 63 63 75 72 72 65 64 20 73 69 6e 63 65 0a 2a  occurred since.*
12a0: 2a 20 74 68 65 20 6c 61 73 74 20 63 61 6c 6c 2c  * the last call,
12b0: 20 74 68 65 6e 20 72 65 74 75 72 6e 20 30 2e 0a   then return 0..
12c0: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  */.int sqlite3Wa
12d0: 6c 43 61 6c 6c 62 61 63 6b 28 57 61 6c 20 2a 70  lCallback(Wal *p
12e0: 57 61 6c 29 3b 0a 0a 2f 2a 20 54 65 6c 6c 20 74  Wal);../* Tell t
12f0: 68 65 20 77 61 6c 20 6c 61 79 65 72 20 74 68 61  he wal layer tha
1300: 74 20 61 6e 20 45 58 43 4c 55 53 49 56 45 20 6c  t an EXCLUSIVE l
1310: 6f 63 6b 20 68 61 73 20 62 65 65 6e 20 6f 62 74  ock has been obt
1320: 61 69 6e 65 64 20 28 6f 72 20 72 65 6c 65 61 73  ained (or releas
1330: 65 64 29 0a 2a 2a 20 62 79 20 74 68 65 20 70 61  ed).** by the pa
1340: 67 65 72 20 6c 61 79 65 72 20 6f 6e 20 74 68 65  ger layer on the
1350: 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 2e 0a   database file..
1360: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  */.int sqlite3Wa
1370: 6c 45 78 63 6c 75 73 69 76 65 4d 6f 64 65 28 57  lExclusiveMode(W
1380: 61 6c 20 2a 70 57 61 6c 2c 20 69 6e 74 20 6f 70  al *pWal, int op
1390: 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74 72  );../* Return tr
13a0: 75 65 20 69 66 20 74 68 65 20 61 72 67 75 6d 65  ue if the argume
13b0: 6e 74 20 69 73 20 6e 6f 6e 2d 4e 55 4c 4c 20 61  nt is non-NULL a
13c0: 6e 64 20 74 68 65 20 57 41 4c 20 6d 6f 64 75 6c  nd the WAL modul
13d0: 65 20 69 73 20 75 73 69 6e 67 0a 2a 2a 20 68 65  e is using.** he
13e0: 61 70 2d 6d 65 6d 6f 72 79 20 66 6f 72 20 74 68  ap-memory for th
13f0: 65 20 77 61 6c 2d 69 6e 64 65 78 2e 20 4f 74 68  e wal-index. Oth
1400: 65 72 77 69 73 65 2c 20 69 66 20 74 68 65 20 61  erwise, if the a
1410: 72 67 75 6d 65 6e 74 20 69 73 20 4e 55 4c 4c 20  rgument is NULL 
1420: 6f 72 20 74 68 65 0a 2a 2a 20 57 41 4c 20 6d 6f  or the.** WAL mo
1430: 64 75 6c 65 20 69 73 20 75 73 69 6e 67 20 73 68  dule is using sh
1440: 61 72 65 64 2d 6d 65 6d 6f 72 79 2c 20 72 65 74  ared-memory, ret
1450: 75 72 6e 20 66 61 6c 73 65 2e 20 0a 2a 2f 0a 69  urn false. .*/.i
1460: 6e 74 20 73 71 6c 69 74 65 33 57 61 6c 48 65 61  nt sqlite3WalHea
1470: 70 4d 65 6d 6f 72 79 28 57 61 6c 20 2a 70 57 61  pMemory(Wal *pWa
1480: 6c 29 3b 0a 0a 23 69 66 64 65 66 20 53 51 4c 49  l);..#ifdef SQLI
1490: 54 45 5f 45 4e 41 42 4c 45 5f 53 4e 41 50 53 48  TE_ENABLE_SNAPSH
14a0: 4f 54 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  OT.int sqlite3Wa
14b0: 6c 53 6e 61 70 73 68 6f 74 47 65 74 28 57 61 6c  lSnapshotGet(Wal
14c0: 20 2a 70 57 61 6c 2c 20 73 71 6c 69 74 65 33 5f   *pWal, sqlite3_
14d0: 73 6e 61 70 73 68 6f 74 20 2a 2a 70 70 53 6e 61  snapshot **ppSna
14e0: 70 73 68 6f 74 29 3b 0a 76 6f 69 64 20 73 71 6c  pshot);.void sql
14f0: 69 74 65 33 57 61 6c 53 6e 61 70 73 68 6f 74 4f  ite3WalSnapshotO
1500: 70 65 6e 28 57 61 6c 20 2a 70 57 61 6c 2c 20 73  pen(Wal *pWal, s
1510: 71 6c 69 74 65 33 5f 73 6e 61 70 73 68 6f 74 20  qlite3_snapshot 
1520: 2a 70 53 6e 61 70 73 68 6f 74 29 3b 0a 69 6e 74  *pSnapshot);.int
1530: 20 73 71 6c 69 74 65 33 57 61 6c 53 6e 61 70 73   sqlite3WalSnaps
1540: 68 6f 74 52 65 63 6f 76 65 72 28 57 61 6c 20 2a  hotRecover(Wal *
1550: 70 57 61 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74  pWal);.int sqlit
1560: 65 33 57 61 6c 53 6e 61 70 73 68 6f 74 43 68 65  e3WalSnapshotChe
1570: 63 6b 28 57 61 6c 20 2a 70 57 61 6c 2c 20 73 71  ck(Wal *pWal, sq
1580: 6c 69 74 65 33 5f 73 6e 61 70 73 68 6f 74 20 2a  lite3_snapshot *
1590: 70 53 6e 61 70 73 68 6f 74 29 3b 0a 76 6f 69 64  pSnapshot);.void
15a0: 20 73 71 6c 69 74 65 33 57 61 6c 53 6e 61 70 73   sqlite3WalSnaps
15b0: 68 6f 74 55 6e 6c 6f 63 6b 28 57 61 6c 20 2a 70  hotUnlock(Wal *p
15c0: 57 61 6c 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 69  Wal);.#endif..#i
15d0: 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d 49  fndef SQLITE_OMI
15e0: 54 5f 43 4f 4e 43 55 52 52 45 4e 54 0a 2f 2a 20  T_CONCURRENT./* 
15f0: 54 65 6c 6c 20 74 68 65 20 77 61 6c 20 6c 61 79  Tell the wal lay
1600: 65 72 20 74 68 61 74 20 77 65 20 77 61 6e 74 20  er that we want 
1610: 74 6f 20 63 6f 6d 6d 69 74 20 61 20 63 6f 6e 63  to commit a conc
1620: 75 72 72 65 6e 74 20 74 72 61 6e 73 61 63 74 69  urrent transacti
1630: 6f 6e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  on */.int sqlite
1640: 33 57 61 6c 4c 6f 63 6b 46 6f 72 43 6f 6d 6d 69  3WalLockForCommi
1650: 74 28 57 61 6c 20 2a 70 57 61 6c 2c 20 50 67 48  t(Wal *pWal, PgH
1660: 64 72 20 2a 70 50 67 2c 20 42 69 74 76 65 63 20  dr *pPg, Bitvec 
1670: 2a 70 52 65 61 64 2c 20 50 67 6e 6f 2a 29 3b 0a  *pRead, Pgno*);.
1680: 0a 2f 2a 20 55 70 67 72 61 64 65 20 74 68 65 20  ./* Upgrade the 
1690: 73 74 61 74 65 20 6f 66 20 74 68 65 20 63 6c 69  state of the cli
16a0: 65 6e 74 20 74 6f 20 74 61 6b 65 20 69 6e 74 6f  ent to take into
16b0: 20 61 63 63 6f 75 6e 74 20 63 68 61 6e 67 65 73   account changes
16c0: 20 77 72 69 74 74 65 6e 0a 2a 2a 20 62 79 20 6f   written.** by o
16d0: 74 68 65 72 20 63 6f 6e 6e 65 63 74 69 6f 6e 73  ther connections
16e0: 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57   */.int sqlite3W
16f0: 61 6c 55 70 67 72 61 64 65 53 6e 61 70 73 68 6f  alUpgradeSnapsho
1700: 74 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 23 65  t(Wal *pWal);.#e
1710: 6e 64 69 66 20 2f 2a 20 53 51 4c 49 54 45 5f 4f  ndif /* SQLITE_O
1720: 4d 49 54 5f 43 4f 4e 43 55 52 52 45 4e 54 20 2a  MIT_CONCURRENT *
1730: 2f 0a 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45  /..#ifdef SQLITE
1740: 5f 45 4e 41 42 4c 45 5f 5a 49 50 56 46 53 0a 2f  _ENABLE_ZIPVFS./
1750: 2a 20 49 66 20 74 68 65 20 57 41 4c 20 66 69 6c  * If the WAL fil
1760: 65 20 69 73 20 6e 6f 74 20 65 6d 70 74 79 2c 20  e is not empty, 
1770: 72 65 74 75 72 6e 20 74 68 65 20 6e 75 6d 62 65  return the numbe
1780: 72 20 6f 66 20 62 79 74 65 73 20 6f 66 20 63 6f  r of bytes of co
1790: 6e 74 65 6e 74 0a 2a 2a 20 73 74 6f 72 65 64 20  ntent.** stored 
17a0: 69 6e 20 65 61 63 68 20 66 72 61 6d 65 20 28 69  in each frame (i
17b0: 2e 65 2e 20 74 68 65 20 64 62 20 70 61 67 65 2d  .e. the db page-
17c0: 73 69 7a 65 20 77 68 65 6e 20 74 68 65 20 57 41  size when the WA
17d0: 4c 20 77 61 73 20 63 72 65 61 74 65 64 29 2e 0a  L was created)..
17e0: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57 61  */.int sqlite3Wa
17f0: 6c 46 72 61 6d 65 73 69 7a 65 28 57 61 6c 20 2a  lFramesize(Wal *
1800: 70 57 61 6c 29 3b 0a 23 65 6e 64 69 66 0a 0a 2f  pWal);.#endif../
1810: 2a 20 52 65 74 75 72 6e 20 74 68 65 20 73 71 6c  * Return the sql
1820: 69 74 65 33 5f 66 69 6c 65 20 6f 62 6a 65 63 74  ite3_file object
1830: 20 66 6f 72 20 74 68 65 20 57 41 4c 20 66 69 6c   for the WAL fil
1840: 65 20 2a 2f 0a 73 71 6c 69 74 65 33 5f 66 69 6c  e */.sqlite3_fil
1850: 65 20 2a 73 71 6c 69 74 65 33 57 61 6c 46 69 6c  e *sqlite3WalFil
1860: 65 28 57 61 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f  e(Wal *pWal);../
1870: 2a 20 52 65 74 75 72 6e 20 74 68 65 20 6a 6f 75  * Return the jou
1880: 72 6e 61 6c 20 6d 6f 64 65 20 28 57 41 4c 20 6f  rnal mode (WAL o
1890: 72 20 57 41 4c 32 29 20 75 73 65 64 20 62 79 20  r WAL2) used by 
18a0: 74 68 69 73 20 57 61 6c 20 6f 62 6a 65 63 74 2e  this Wal object.
18b0: 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 57   */.int sqlite3W
18c0: 61 6c 4a 6f 75 72 6e 61 6c 4d 6f 64 65 28 57 61  alJournalMode(Wa
18d0: 6c 20 2a 70 57 61 6c 29 3b 0a 0a 2f 2a 20 73 71  l *pWal);../* sq
18e0: 6c 69 74 65 33 5f 77 61 6c 5f 69 6e 66 6f 28 29  lite3_wal_info()
18f0: 20 64 61 74 61 20 2a 2f 0a 69 6e 74 20 73 71 6c   data */.int sql
1900: 69 74 65 33 57 61 6c 49 6e 66 6f 28 57 61 6c 20  ite3WalInfo(Wal 
1910: 2a 70 57 61 6c 2c 20 75 33 32 20 2a 70 6e 50 72  *pWal, u32 *pnPr
1920: 69 6f 72 2c 20 75 33 32 20 2a 70 6e 46 72 61 6d  ior, u32 *pnFram
1930: 65 29 3b 0a 0a 23 65 6e 64 69 66 20 2f 2a 20 69  e);..#endif /* i
1940: 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d 49  fndef SQLITE_OMI
1950: 54 5f 57 41 4c 20 2a 2f 0a 23 65 6e 64 69 66 20  T_WAL */.#endif 
1960: 2f 2a 20 53 51 4c 49 54 45 5f 57 41 4c 5f 48 20  /* SQLITE_WAL_H 
1970: 2a 2f 0a                                         */.