/ Hex Artifact Content
Login

Artifact 5cd760857707529b403837d813d86b68938d6183:


0000: 2f 2a 0a 2a 2a 20 32 30 30 31 20 53 65 70 74 65  /*.** 2001 Septe
0010: 6d 62 65 72 20 31 35 0a 2a 2a 0a 2a 2a 20 54 68  mber 15.**.** Th
0020: 65 20 61 75 74 68 6f 72 20 64 69 73 63 6c 61 69  e author disclai
0030: 6d 73 20 63 6f 70 79 72 69 67 68 74 20 74 6f 20  ms copyright to 
0040: 74 68 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65  this source code
0050: 2e 20 20 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a  .  In place of.*
0060: 2a 20 61 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65  * a legal notice
0070: 2c 20 68 65 72 65 20 69 73 20 61 20 62 6c 65 73  , here is a bles
0080: 73 69 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d  sing:.**.**    M
0090: 61 79 20 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61  ay you do good a
00a0: 6e 64 20 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20  nd not evil..** 
00b0: 20 20 20 4d 61 79 20 79 6f 75 20 66 69 6e 64 20     May you find 
00c0: 66 6f 72 67 69 76 65 6e 65 73 73 20 66 6f 72 20  forgiveness for 
00d0: 79 6f 75 72 73 65 6c 66 20 61 6e 64 20 66 6f 72  yourself and for
00e0: 67 69 76 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20  give others..** 
00f0: 20 20 20 4d 61 79 20 79 6f 75 20 73 68 61 72 65     May you share
0100: 20 66 72 65 65 6c 79 2c 20 6e 65 76 65 72 20 74   freely, never t
0110: 61 6b 69 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20  aking more than 
0120: 79 6f 75 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a  you 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 2a 2a 0a 2a 2a 20 54 68 69 73 20 68  ******.** This h
0180: 65 61 64 65 72 20 66 69 6c 65 20 64 65 66 69 6e  eader file defin
0190: 65 73 20 74 68 65 20 69 6e 74 65 72 66 61 63 65  es the interface
01a0: 20 74 68 61 74 20 74 68 65 20 73 71 6c 69 74 65   that the sqlite
01b0: 20 70 61 67 65 20 63 61 63 68 65 0a 2a 2a 20 73   page cache.** s
01c0: 75 62 73 79 73 74 65 6d 2e 20 20 54 68 65 20 70  ubsystem.  The p
01d0: 61 67 65 20 63 61 63 68 65 20 73 75 62 73 79 73  age cache subsys
01e0: 74 65 6d 20 72 65 61 64 73 20 61 6e 64 20 77 72  tem reads and wr
01f0: 69 74 65 73 20 61 20 66 69 6c 65 20 61 20 70 61  ites a file a pa
0200: 67 65 0a 2a 2a 20 61 74 20 61 20 74 69 6d 65 20  ge.** at a time 
0210: 61 6e 64 20 70 72 6f 76 69 64 65 73 20 61 20 6a  and provides a j
0220: 6f 75 72 6e 61 6c 20 66 6f 72 20 72 6f 6c 6c 62  ournal for rollb
0230: 61 63 6b 2e 0a 2a 2f 0a 0a 23 69 66 6e 64 65 66  ack..*/..#ifndef
0240: 20 5f 50 41 47 45 52 5f 48 5f 0a 23 64 65 66 69   _PAGER_H_.#defi
0250: 6e 65 20 5f 50 41 47 45 52 5f 48 5f 0a 0a 2f 2a  ne _PAGER_H_../*
0260: 0a 2a 2a 20 44 65 66 61 75 6c 74 20 6d 61 78 69  .** Default maxi
0270: 6d 75 6d 20 73 69 7a 65 20 66 6f 72 20 70 65 72  mum size for per
0280: 73 69 73 74 65 6e 74 20 6a 6f 75 72 6e 61 6c 20  sistent journal 
0290: 66 69 6c 65 73 2e 20 41 20 6e 65 67 61 74 69 76  files. A negativ
02a0: 65 20 0a 2a 2a 20 76 61 6c 75 65 20 6d 65 61 6e  e .** value mean
02b0: 73 20 6e 6f 20 6c 69 6d 69 74 2e 20 54 68 69 73  s no limit. This
02c0: 20 76 61 6c 75 65 20 6d 61 79 20 62 65 20 6f 76   value may be ov
02d0: 65 72 72 69 64 64 65 6e 20 75 73 69 6e 67 20 74  erridden using t
02e0: 68 65 20 0a 2a 2a 20 73 71 6c 69 74 65 33 50 61  he .** sqlite3Pa
02f0: 67 65 72 4a 6f 75 72 6e 61 6c 53 69 7a 65 4c 69  gerJournalSizeLi
0300: 6d 69 74 28 29 20 41 50 49 2e 20 53 65 65 20 61  mit() API. See a
0310: 6c 73 6f 20 22 50 52 41 47 4d 41 20 6a 6f 75 72  lso "PRAGMA jour
0320: 6e 61 6c 5f 73 69 7a 65 5f 6c 69 6d 69 74 22 2e  nal_size_limit".
0330: 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 53 51 4c 49  .*/.#ifndef SQLI
0340: 54 45 5f 44 45 46 41 55 4c 54 5f 4a 4f 55 52 4e  TE_DEFAULT_JOURN
0350: 41 4c 5f 53 49 5a 45 5f 4c 49 4d 49 54 0a 20 20  AL_SIZE_LIMIT.  
0360: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44  #define SQLITE_D
0370: 45 46 41 55 4c 54 5f 4a 4f 55 52 4e 41 4c 5f 53  EFAULT_JOURNAL_S
0380: 49 5a 45 5f 4c 49 4d 49 54 20 2d 31 0a 23 65 6e  IZE_LIMIT -1.#en
0390: 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20 74  dif../*.** The t
03a0: 79 70 65 20 75 73 65 64 20 74 6f 20 72 65 70 72  ype used to repr
03b0: 65 73 65 6e 74 20 61 20 70 61 67 65 20 6e 75 6d  esent a page num
03c0: 62 65 72 2e 20 20 54 68 65 20 66 69 72 73 74 20  ber.  The first 
03d0: 70 61 67 65 20 69 6e 20 61 20 66 69 6c 65 0a 2a  page in a file.*
03e0: 2a 20 69 73 20 63 61 6c 6c 65 64 20 70 61 67 65  * is called page
03f0: 20 31 2e 20 20 30 20 69 73 20 75 73 65 64 20 74   1.  0 is used t
0400: 6f 20 72 65 70 72 65 73 65 6e 74 20 22 6e 6f 74  o represent "not
0410: 20 61 20 70 61 67 65 22 2e 0a 2a 2f 0a 74 79 70   a page"..*/.typ
0420: 65 64 65 66 20 75 33 32 20 50 67 6e 6f 3b 0a 0a  edef u32 Pgno;..
0430: 2f 2a 0a 2a 2a 20 45 61 63 68 20 6f 70 65 6e 20  /*.** Each open 
0440: 66 69 6c 65 20 69 73 20 6d 61 6e 61 67 65 64 20  file is managed 
0450: 62 79 20 61 20 73 65 70 61 72 61 74 65 20 69 6e  by a separate in
0460: 73 74 61 6e 63 65 20 6f 66 20 74 68 65 20 22 50  stance of the "P
0470: 61 67 65 72 22 20 73 74 72 75 63 74 75 72 65 2e  ager" structure.
0480: 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74 72 75  .*/.typedef stru
0490: 63 74 20 50 61 67 65 72 20 50 61 67 65 72 3b 0a  ct Pager Pager;.
04a0: 0a 2f 2a 0a 2a 2a 20 48 61 6e 64 6c 65 20 74 79  ./*.** Handle ty
04b0: 70 65 20 66 6f 72 20 70 61 67 65 73 2e 0a 2a 2f  pe for pages..*/
04c0: 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
04d0: 50 67 48 64 72 20 44 62 50 61 67 65 3b 0a 0a 2f  PgHdr DbPage;../
04e0: 2a 0a 2a 2a 20 50 61 67 65 20 6e 75 6d 62 65 72  *.** Page number
04f0: 20 50 41 47 45 52 5f 4d 4a 5f 50 47 4e 4f 20 69   PAGER_MJ_PGNO i
0500: 73 20 6e 65 76 65 72 20 75 73 65 64 20 69 6e 20  s never used in 
0510: 61 6e 20 53 51 4c 69 74 65 20 64 61 74 61 62 61  an SQLite databa
0520: 73 65 20 28 69 74 20 69 73 0a 2a 2a 20 72 65 73  se (it is.** res
0530: 65 72 76 65 64 20 66 6f 72 20 77 6f 72 6b 69 6e  erved for workin
0540: 67 20 61 72 6f 75 6e 64 20 61 20 77 69 6e 64 6f  g around a windo
0550: 77 73 2f 70 6f 73 69 78 20 69 6e 63 6f 6d 70 61  ws/posix incompa
0560: 74 69 62 69 6c 69 74 79 29 2e 20 49 74 20 69 73  tibility). It is
0570: 0a 2a 2a 20 75 73 65 64 20 69 6e 20 74 68 65 20  .** used in the 
0580: 6a 6f 75 72 6e 61 6c 20 74 6f 20 73 69 67 6e 69  journal to signi
0590: 66 79 20 74 68 61 74 20 74 68 65 20 72 65 6d 61  fy that the rema
05a0: 69 6e 64 65 72 20 6f 66 20 74 68 65 20 6a 6f 75  inder of the jou
05b0: 72 6e 61 6c 20 66 69 6c 65 20 0a 2a 2a 20 69 73  rnal file .** is
05c0: 20 64 65 76 6f 74 65 64 20 74 6f 20 73 74 6f 72   devoted to stor
05d0: 69 6e 67 20 61 20 6d 61 73 74 65 72 20 6a 6f 75  ing a master jou
05e0: 72 6e 61 6c 20 6e 61 6d 65 20 2d 20 74 68 65 72  rnal name - ther
05f0: 65 20 61 72 65 20 6e 6f 20 6d 6f 72 65 20 70 61  e are no more pa
0600: 67 65 73 20 74 6f 0a 2a 2a 20 72 6f 6c 6c 20 62  ges to.** roll b
0610: 61 63 6b 2e 20 53 65 65 20 63 6f 6d 6d 65 6e 74  ack. See comment
0620: 73 20 66 6f 72 20 66 75 6e 63 74 69 6f 6e 20 77  s for function w
0630: 72 69 74 65 4d 61 73 74 65 72 4a 6f 75 72 6e 61  riteMasterJourna
0640: 6c 28 29 20 69 6e 20 70 61 67 65 72 2e 63 20 0a  l() in pager.c .
0650: 2a 2a 20 66 6f 72 20 64 65 74 61 69 6c 73 2e 0a  ** for details..
0660: 2a 2f 0a 23 64 65 66 69 6e 65 20 50 41 47 45 52  */.#define PAGER
0670: 5f 4d 4a 5f 50 47 4e 4f 28 78 29 20 28 28 50 67  _MJ_PGNO(x) ((Pg
0680: 6e 6f 29 28 28 50 45 4e 44 49 4e 47 5f 42 59 54  no)((PENDING_BYT
0690: 45 2f 28 28 78 29 2d 3e 70 61 67 65 53 69 7a 65  E/((x)->pageSize
06a0: 29 29 2b 31 29 29 0a 0a 2f 2a 0a 2a 2a 20 41 6c  ))+1))../*.** Al
06b0: 6c 6f 77 65 64 20 76 61 6c 75 65 73 20 66 6f 72  lowed values for
06c0: 20 74 68 65 20 66 6c 61 67 73 20 70 61 72 61 6d   the flags param
06d0: 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 50  eter to sqlite3P
06e0: 61 67 65 72 4f 70 65 6e 28 29 2e 0a 2a 2a 0a 2a  agerOpen()..**.*
06f0: 2a 20 4e 4f 54 45 3a 20 54 68 65 73 65 20 76 61  * NOTE: These va
0700: 6c 75 65 73 20 6d 75 73 74 20 6d 61 74 63 68 20  lues must match 
0710: 74 68 65 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e  the correspondin
0720: 67 20 42 54 52 45 45 5f 20 76 61 6c 75 65 73 20  g BTREE_ values 
0730: 69 6e 20 62 74 72 65 65 2e 68 2e 0a 2a 2f 0a 23  in btree.h..*/.#
0740: 64 65 66 69 6e 65 20 50 41 47 45 52 5f 4f 4d 49  define PAGER_OMI
0750: 54 5f 4a 4f 55 52 4e 41 4c 20 20 30 78 30 30 30  T_JOURNAL  0x000
0760: 31 20 20 20 20 2f 2a 20 44 6f 20 6e 6f 74 20 75  1    /* Do not u
0770: 73 65 20 61 20 72 6f 6c 6c 62 61 63 6b 20 6a 6f  se a rollback jo
0780: 75 72 6e 61 6c 20 2a 2f 0a 23 64 65 66 69 6e 65  urnal */.#define
0790: 20 50 41 47 45 52 5f 4e 4f 5f 52 45 41 44 4c 4f   PAGER_NO_READLO
07a0: 43 4b 20 20 20 30 78 30 30 30 32 20 20 20 20 2f  CK   0x0002    /
07b0: 2a 20 4f 6d 69 74 20 72 65 61 64 6c 6f 63 6b 73  * Omit readlocks
07c0: 20 6f 6e 20 72 65 61 64 6f 6e 6c 79 20 66 69 6c   on readonly fil
07d0: 65 73 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 41  es */.#define PA
07e0: 47 45 52 5f 4d 45 4d 4f 52 59 20 20 20 20 20 20  GER_MEMORY      
07f0: 20 20 30 78 30 30 30 34 20 20 20 20 2f 2a 20 49    0x0004    /* I
0800: 6e 2d 6d 65 6d 6f 72 79 20 64 61 74 61 62 61 73  n-memory databas
0810: 65 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 56 61 6c 69  e */../*.** Vali
0820: 64 20 76 61 6c 75 65 73 20 66 6f 72 20 74 68 65  d values for the
0830: 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
0840: 20 74 6f 20 73 71 6c 69 74 65 33 50 61 67 65 72   to sqlite3Pager
0850: 4c 6f 63 6b 69 6e 67 4d 6f 64 65 28 29 2e 0a 2a  LockingMode()..*
0860: 2f 0a 23 64 65 66 69 6e 65 20 50 41 47 45 52 5f  /.#define PAGER_
0870: 4c 4f 43 4b 49 4e 47 4d 4f 44 45 5f 51 55 45 52  LOCKINGMODE_QUER
0880: 59 20 20 20 20 20 20 2d 31 0a 23 64 65 66 69 6e  Y      -1.#defin
0890: 65 20 50 41 47 45 52 5f 4c 4f 43 4b 49 4e 47 4d  e PAGER_LOCKINGM
08a0: 4f 44 45 5f 4e 4f 52 4d 41 4c 20 20 20 20 20 20  ODE_NORMAL      
08b0: 30 0a 23 64 65 66 69 6e 65 20 50 41 47 45 52 5f  0.#define PAGER_
08c0: 4c 4f 43 4b 49 4e 47 4d 4f 44 45 5f 45 58 43 4c  LOCKINGMODE_EXCL
08d0: 55 53 49 56 45 20 20 20 31 0a 0a 2f 2a 0a 2a 2a  USIVE   1../*.**
08e0: 20 4e 75 6d 65 72 69 63 20 63 6f 6e 73 74 61 6e   Numeric constan
08f0: 74 73 20 74 68 61 74 20 65 6e 63 6f 64 65 20 74  ts that encode t
0900: 68 65 20 6a 6f 75 72 6e 61 6c 6d 6f 64 65 2e 20  he journalmode. 
0910: 20 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 50 41 47   .*/.#define PAG
0920: 45 52 5f 4a 4f 55 52 4e 41 4c 4d 4f 44 45 5f 51  ER_JOURNALMODE_Q
0930: 55 45 52 59 20 20 20 20 20 28 2d 31 29 20 20 2f  UERY     (-1)  /
0940: 2a 20 51 75 65 72 79 20 74 68 65 20 76 61 6c 75  * Query the valu
0950: 65 20 6f 66 20 6a 6f 75 72 6e 61 6c 6d 6f 64 65  e of journalmode
0960: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 41 47 45   */.#define PAGE
0970: 52 5f 4a 4f 55 52 4e 41 4c 4d 4f 44 45 5f 44 45  R_JOURNALMODE_DE
0980: 4c 45 54 45 20 20 20 20 20 20 30 20 20 20 2f 2a  LETE      0   /*
0990: 20 43 6f 6d 6d 69 74 20 62 79 20 64 65 6c 65 74   Commit by delet
09a0: 69 6e 67 20 6a 6f 75 72 6e 61 6c 20 66 69 6c 65  ing journal file
09b0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 41 47 45   */.#define PAGE
09c0: 52 5f 4a 4f 55 52 4e 41 4c 4d 4f 44 45 5f 50 45  R_JOURNALMODE_PE
09d0: 52 53 49 53 54 20 20 20 20 20 31 20 20 20 2f 2a  RSIST     1   /*
09e0: 20 43 6f 6d 6d 69 74 20 62 79 20 7a 65 72 6f 69   Commit by zeroi
09f0: 6e 67 20 6a 6f 75 72 6e 61 6c 20 68 65 61 64 65  ng journal heade
0a00: 72 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 41 47  r */.#define PAG
0a10: 45 52 5f 4a 4f 55 52 4e 41 4c 4d 4f 44 45 5f 4f  ER_JOURNALMODE_O
0a20: 46 46 20 20 20 20 20 20 20 20 20 32 20 20 20 2f  FF         2   /
0a30: 2a 20 4a 6f 75 72 6e 61 6c 20 6f 6d 69 74 74 65  * Journal omitte
0a40: 64 2e 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50  d.  */.#define P
0a50: 41 47 45 52 5f 4a 4f 55 52 4e 41 4c 4d 4f 44 45  AGER_JOURNALMODE
0a60: 5f 54 52 55 4e 43 41 54 45 20 20 20 20 33 20 20  _TRUNCATE    3  
0a70: 20 2f 2a 20 43 6f 6d 6d 69 74 20 62 79 20 74 72   /* Commit by tr
0a80: 75 6e 63 61 74 69 6e 67 20 6a 6f 75 72 6e 61 6c  uncating journal
0a90: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 41 47 45   */.#define PAGE
0aa0: 52 5f 4a 4f 55 52 4e 41 4c 4d 4f 44 45 5f 4d 45  R_JOURNALMODE_ME
0ab0: 4d 4f 52 59 20 20 20 20 20 20 34 20 20 20 2f 2a  MORY      4   /*
0ac0: 20 49 6e 2d 6d 65 6d 6f 72 79 20 6a 6f 75 72 6e   In-memory journ
0ad0: 61 6c 20 66 69 6c 65 20 2a 2f 0a 23 64 65 66 69  al file */.#defi
0ae0: 6e 65 20 50 41 47 45 52 5f 4a 4f 55 52 4e 41 4c  ne PAGER_JOURNAL
0af0: 4d 4f 44 45 5f 57 41 4c 20 20 20 20 20 20 20 20  MODE_WAL        
0b00: 20 35 20 20 20 2f 2a 20 55 73 65 20 77 72 69 74   5   /* Use writ
0b10: 65 2d 61 68 65 61 64 20 6c 6f 67 67 69 6e 67 20  e-ahead logging 
0b20: 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20 72 65  */../*.** The re
0b30: 6d 61 69 6e 64 65 72 20 6f 66 20 74 68 69 73 20  mainder of this 
0b40: 66 69 6c 65 20 63 6f 6e 74 61 69 6e 73 20 74 68  file contains th
0b50: 65 20 64 65 63 6c 61 72 61 74 69 6f 6e 73 20 6f  e declarations o
0b60: 66 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 73 0a  f the functions.
0b70: 2a 2a 20 74 68 61 74 20 6d 61 6b 65 20 75 70 20  ** that make up 
0b80: 74 68 65 20 50 61 67 65 72 20 73 75 62 2d 73 79  the Pager sub-sy
0b90: 73 74 65 6d 20 41 50 49 2e 20 53 65 65 20 73 6f  stem API. See so
0ba0: 75 72 63 65 20 63 6f 64 65 20 63 6f 6d 6d 65 6e  urce code commen
0bb0: 74 73 20 66 6f 72 20 0a 2a 2a 20 61 20 64 65 74  ts for .** a det
0bc0: 61 69 6c 65 64 20 64 65 73 63 72 69 70 74 69 6f  ailed descriptio
0bd0: 6e 20 6f 66 20 65 61 63 68 20 72 6f 75 74 69 6e  n of each routin
0be0: 65 2e 0a 2a 2f 0a 0a 2f 2a 20 4f 70 65 6e 20 61  e..*/../* Open a
0bf0: 6e 64 20 63 6c 6f 73 65 20 61 20 50 61 67 65 72  nd close a Pager
0c00: 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 20 2a 2f 20   connection. */ 
0c10: 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 61 67 65  .int sqlite3Page
0c20: 72 4f 70 65 6e 28 0a 20 20 73 71 6c 69 74 65 33  rOpen(.  sqlite3
0c30: 5f 76 66 73 2a 2c 0a 20 20 50 61 67 65 72 20 2a  _vfs*,.  Pager *
0c40: 2a 70 70 50 61 67 65 72 2c 0a 20 20 63 6f 6e 73  *ppPager,.  cons
0c50: 74 20 63 68 61 72 2a 2c 0a 20 20 69 6e 74 2c 0a  t char*,.  int,.
0c60: 20 20 69 6e 74 2c 0a 20 20 69 6e 74 2c 0a 20 20    int,.  int,.  
0c70: 76 6f 69 64 28 2a 29 28 44 62 50 61 67 65 2a 29  void(*)(DbPage*)
0c80: 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 50  .);.int sqlite3P
0c90: 61 67 65 72 43 6c 6f 73 65 28 50 61 67 65 72 20  agerClose(Pager 
0ca0: 2a 70 50 61 67 65 72 29 3b 0a 69 6e 74 20 73 71  *pPager);.int sq
0cb0: 6c 69 74 65 33 50 61 67 65 72 52 65 61 64 46 69  lite3PagerReadFi
0cc0: 6c 65 68 65 61 64 65 72 28 50 61 67 65 72 2a 2c  leheader(Pager*,
0cd0: 20 69 6e 74 2c 20 75 6e 73 69 67 6e 65 64 20 63   int, unsigned c
0ce0: 68 61 72 2a 29 3b 0a 0a 2f 2a 20 46 75 6e 63 74  har*);../* Funct
0cf0: 69 6f 6e 73 20 75 73 65 64 20 74 6f 20 63 6f 6e  ions used to con
0d00: 66 69 67 75 72 65 20 61 20 50 61 67 65 72 20 6f  figure a Pager o
0d10: 62 6a 65 63 74 2e 20 2a 2f 0a 76 6f 69 64 20 73  bject. */.void s
0d20: 71 6c 69 74 65 33 50 61 67 65 72 53 65 74 42 75  qlite3PagerSetBu
0d30: 73 79 68 61 6e 64 6c 65 72 28 50 61 67 65 72 2a  syhandler(Pager*
0d40: 2c 20 69 6e 74 28 2a 29 28 76 6f 69 64 20 2a 29  , int(*)(void *)
0d50: 2c 20 76 6f 69 64 20 2a 29 3b 0a 69 6e 74 20 73  , void *);.int s
0d60: 71 6c 69 74 65 33 50 61 67 65 72 53 65 74 50 61  qlite3PagerSetPa
0d70: 67 65 73 69 7a 65 28 50 61 67 65 72 2a 2c 20 75  gesize(Pager*, u
0d80: 33 32 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73  32*, int);.int s
0d90: 71 6c 69 74 65 33 50 61 67 65 72 4d 61 78 50 61  qlite3PagerMaxPa
0da0: 67 65 43 6f 75 6e 74 28 50 61 67 65 72 2a 2c 20  geCount(Pager*, 
0db0: 69 6e 74 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74  int);.void sqlit
0dc0: 65 33 50 61 67 65 72 53 65 74 43 61 63 68 65 73  e3PagerSetCaches
0dd0: 69 7a 65 28 50 61 67 65 72 2a 2c 20 69 6e 74 29  ize(Pager*, int)
0de0: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 61  ;.void sqlite3Pa
0df0: 67 65 72 53 68 72 69 6e 6b 28 50 61 67 65 72 2a  gerShrink(Pager*
0e00: 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50  );.void sqlite3P
0e10: 61 67 65 72 53 65 74 53 61 66 65 74 79 4c 65 76  agerSetSafetyLev
0e20: 65 6c 28 50 61 67 65 72 2a 2c 69 6e 74 2c 69 6e  el(Pager*,int,in
0e30: 74 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69  t,int);.int sqli
0e40: 74 65 33 50 61 67 65 72 4c 6f 63 6b 69 6e 67 4d  te3PagerLockingM
0e50: 6f 64 65 28 50 61 67 65 72 20 2a 2c 20 69 6e 74  ode(Pager *, int
0e60: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 61  );.int sqlite3Pa
0e70: 67 65 72 53 65 74 4a 6f 75 72 6e 61 6c 4d 6f 64  gerSetJournalMod
0e80: 65 28 50 61 67 65 72 20 2a 2c 20 69 6e 74 29 3b  e(Pager *, int);
0e90: 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 61 67 65  .int sqlite3Page
0ea0: 72 47 65 74 4a 6f 75 72 6e 61 6c 4d 6f 64 65 28  rGetJournalMode(
0eb0: 50 61 67 65 72 2a 29 3b 0a 69 6e 74 20 73 71 6c  Pager*);.int sql
0ec0: 69 74 65 33 50 61 67 65 72 4f 6b 54 6f 43 68 61  ite3PagerOkToCha
0ed0: 6e 67 65 4a 6f 75 72 6e 61 6c 4d 6f 64 65 28 50  ngeJournalMode(P
0ee0: 61 67 65 72 2a 29 3b 0a 69 36 34 20 73 71 6c 69  ager*);.i64 sqli
0ef0: 74 65 33 50 61 67 65 72 4a 6f 75 72 6e 61 6c 53  te3PagerJournalS
0f00: 69 7a 65 4c 69 6d 69 74 28 50 61 67 65 72 20 2a  izeLimit(Pager *
0f10: 2c 20 69 36 34 29 3b 0a 73 71 6c 69 74 65 33 5f  , i64);.sqlite3_
0f20: 62 61 63 6b 75 70 20 2a 2a 73 71 6c 69 74 65 33  backup **sqlite3
0f30: 50 61 67 65 72 42 61 63 6b 75 70 50 74 72 28 50  PagerBackupPtr(P
0f40: 61 67 65 72 2a 29 3b 0a 0a 2f 2a 20 46 75 6e 63  ager*);../* Func
0f50: 74 69 6f 6e 73 20 75 73 65 64 20 74 6f 20 6f 62  tions used to ob
0f60: 74 61 69 6e 20 61 6e 64 20 72 65 6c 65 61 73 65  tain and release
0f70: 20 70 61 67 65 20 72 65 66 65 72 65 6e 63 65 73   page references
0f80: 2e 20 2a 2f 20 0a 69 6e 74 20 73 71 6c 69 74 65  . */ .int sqlite
0f90: 33 50 61 67 65 72 41 63 71 75 69 72 65 28 50 61  3PagerAcquire(Pa
0fa0: 67 65 72 20 2a 70 50 61 67 65 72 2c 20 50 67 6e  ger *pPager, Pgn
0fb0: 6f 20 70 67 6e 6f 2c 20 44 62 50 61 67 65 20 2a  o pgno, DbPage *
0fc0: 2a 70 70 50 61 67 65 2c 20 69 6e 74 20 63 6c 72  *ppPage, int clr
0fd0: 46 6c 61 67 29 3b 0a 23 64 65 66 69 6e 65 20 73  Flag);.#define s
0fe0: 71 6c 69 74 65 33 50 61 67 65 72 47 65 74 28 41  qlite3PagerGet(A
0ff0: 2c 42 2c 43 29 20 73 71 6c 69 74 65 33 50 61 67  ,B,C) sqlite3Pag
1000: 65 72 41 63 71 75 69 72 65 28 41 2c 42 2c 43 2c  erAcquire(A,B,C,
1010: 30 29 0a 44 62 50 61 67 65 20 2a 73 71 6c 69 74  0).DbPage *sqlit
1020: 65 33 50 61 67 65 72 4c 6f 6f 6b 75 70 28 50 61  e3PagerLookup(Pa
1030: 67 65 72 20 2a 70 50 61 67 65 72 2c 20 50 67 6e  ger *pPager, Pgn
1040: 6f 20 70 67 6e 6f 29 3b 0a 76 6f 69 64 20 73 71  o pgno);.void sq
1050: 6c 69 74 65 33 50 61 67 65 72 52 65 66 28 44 62  lite3PagerRef(Db
1060: 50 61 67 65 2a 29 3b 0a 76 6f 69 64 20 73 71 6c  Page*);.void sql
1070: 69 74 65 33 50 61 67 65 72 55 6e 72 65 66 28 44  ite3PagerUnref(D
1080: 62 50 61 67 65 2a 29 3b 0a 0a 2f 2a 20 4f 70 65  bPage*);../* Ope
1090: 72 61 74 69 6f 6e 73 20 6f 6e 20 70 61 67 65 20  rations on page 
10a0: 72 65 66 65 72 65 6e 63 65 73 2e 20 2a 2f 0a 69  references. */.i
10b0: 6e 74 20 73 71 6c 69 74 65 33 50 61 67 65 72 57  nt sqlite3PagerW
10c0: 72 69 74 65 28 44 62 50 61 67 65 2a 29 3b 0a 76  rite(DbPage*);.v
10d0: 6f 69 64 20 73 71 6c 69 74 65 33 50 61 67 65 72  oid sqlite3Pager
10e0: 44 6f 6e 74 57 72 69 74 65 28 44 62 50 61 67 65  DontWrite(DbPage
10f0: 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 50  *);.int sqlite3P
1100: 61 67 65 72 4d 6f 76 65 70 61 67 65 28 50 61 67  agerMovepage(Pag
1110: 65 72 2a 2c 44 62 50 61 67 65 2a 2c 50 67 6e 6f  er*,DbPage*,Pgno
1120: 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74  ,int);.int sqlit
1130: 65 33 50 61 67 65 72 50 61 67 65 52 65 66 63 6f  e3PagerPageRefco
1140: 75 6e 74 28 44 62 50 61 67 65 2a 29 3b 0a 76 6f  unt(DbPage*);.vo
1150: 69 64 20 2a 73 71 6c 69 74 65 33 50 61 67 65 72  id *sqlite3Pager
1160: 47 65 74 44 61 74 61 28 44 62 50 61 67 65 20 2a  GetData(DbPage *
1170: 29 3b 20 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65  ); .void *sqlite
1180: 33 50 61 67 65 72 47 65 74 45 78 74 72 61 28 44  3PagerGetExtra(D
1190: 62 50 61 67 65 20 2a 29 3b 20 0a 0a 2f 2a 20 46  bPage *); ../* F
11a0: 75 6e 63 74 69 6f 6e 73 20 75 73 65 64 20 74 6f  unctions used to
11b0: 20 6d 61 6e 61 67 65 20 70 61 67 65 72 20 74 72   manage pager tr
11c0: 61 6e 73 61 63 74 69 6f 6e 73 20 61 6e 64 20 73  ansactions and s
11d0: 61 76 65 70 6f 69 6e 74 73 2e 20 2a 2f 0a 76 6f  avepoints. */.vo
11e0: 69 64 20 73 71 6c 69 74 65 33 50 61 67 65 72 50  id sqlite3PagerP
11f0: 61 67 65 63 6f 75 6e 74 28 50 61 67 65 72 2a 2c  agecount(Pager*,
1200: 20 69 6e 74 2a 29 3b 0a 69 6e 74 20 73 71 6c 69   int*);.int sqli
1210: 74 65 33 50 61 67 65 72 42 65 67 69 6e 28 50 61  te3PagerBegin(Pa
1220: 67 65 72 2a 2c 20 69 6e 74 20 65 78 46 6c 61 67  ger*, int exFlag
1230: 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69  , int);.int sqli
1240: 74 65 33 50 61 67 65 72 43 6f 6d 6d 69 74 50 68  te3PagerCommitPh
1250: 61 73 65 4f 6e 65 28 50 61 67 65 72 2a 2c 63 6f  aseOne(Pager*,co
1260: 6e 73 74 20 63 68 61 72 20 2a 7a 4d 61 73 74 65  nst char *zMaste
1270: 72 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c  r, int);.int sql
1280: 69 74 65 33 50 61 67 65 72 45 78 63 6c 75 73 69  ite3PagerExclusi
1290: 76 65 4c 6f 63 6b 28 50 61 67 65 72 2a 29 3b 0a  veLock(Pager*);.
12a0: 69 6e 74 20 73 71 6c 69 74 65 33 50 61 67 65 72  int sqlite3Pager
12b0: 53 79 6e 63 28 50 61 67 65 72 20 2a 70 50 61 67  Sync(Pager *pPag
12c0: 65 72 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  er);.int sqlite3
12d0: 50 61 67 65 72 43 6f 6d 6d 69 74 50 68 61 73 65  PagerCommitPhase
12e0: 54 77 6f 28 50 61 67 65 72 2a 29 3b 0a 69 6e 74  Two(Pager*);.int
12f0: 20 73 71 6c 69 74 65 33 50 61 67 65 72 52 6f 6c   sqlite3PagerRol
1300: 6c 62 61 63 6b 28 50 61 67 65 72 2a 29 3b 0a 69  lback(Pager*);.i
1310: 6e 74 20 73 71 6c 69 74 65 33 50 61 67 65 72 4f  nt sqlite3PagerO
1320: 70 65 6e 53 61 76 65 70 6f 69 6e 74 28 50 61 67  penSavepoint(Pag
1330: 65 72 20 2a 70 50 61 67 65 72 2c 20 69 6e 74 20  er *pPager, int 
1340: 6e 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 50  n);.int sqlite3P
1350: 61 67 65 72 53 61 76 65 70 6f 69 6e 74 28 50 61  agerSavepoint(Pa
1360: 67 65 72 20 2a 70 50 61 67 65 72 2c 20 69 6e 74  ger *pPager, int
1370: 20 6f 70 2c 20 69 6e 74 20 69 53 61 76 65 70 6f   op, int iSavepo
1380: 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  int);.int sqlite
1390: 33 50 61 67 65 72 53 68 61 72 65 64 4c 6f 63 6b  3PagerSharedLock
13a0: 28 50 61 67 65 72 20 2a 70 50 61 67 65 72 29 3b  (Pager *pPager);
13b0: 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 61 67  ..int sqlite3Pag
13c0: 65 72 43 68 65 63 6b 70 6f 69 6e 74 28 50 61 67  erCheckpoint(Pag
13d0: 65 72 20 2a 70 50 61 67 65 72 2c 20 69 6e 74 2c  er *pPager, int,
13e0: 20 69 6e 74 2a 2c 20 69 6e 74 2a 29 3b 0a 69 6e   int*, int*);.in
13f0: 74 20 73 71 6c 69 74 65 33 50 61 67 65 72 57 61  t sqlite3PagerWa
1400: 6c 53 75 70 70 6f 72 74 65 64 28 50 61 67 65 72  lSupported(Pager
1410: 20 2a 70 50 61 67 65 72 29 3b 0a 69 6e 74 20 73   *pPager);.int s
1420: 71 6c 69 74 65 33 50 61 67 65 72 57 61 6c 43 61  qlite3PagerWalCa
1430: 6c 6c 62 61 63 6b 28 50 61 67 65 72 20 2a 70 50  llback(Pager *pP
1440: 61 67 65 72 29 3b 0a 69 6e 74 20 73 71 6c 69 74  ager);.int sqlit
1450: 65 33 50 61 67 65 72 4f 70 65 6e 57 61 6c 28 50  e3PagerOpenWal(P
1460: 61 67 65 72 20 2a 70 50 61 67 65 72 2c 20 69 6e  ager *pPager, in
1470: 74 20 2a 70 69 73 4f 70 65 6e 29 3b 0a 69 6e 74  t *pisOpen);.int
1480: 20 73 71 6c 69 74 65 33 50 61 67 65 72 43 6c 6f   sqlite3PagerClo
1490: 73 65 57 61 6c 28 50 61 67 65 72 20 2a 70 50 61  seWal(Pager *pPa
14a0: 67 65 72 29 3b 0a 0a 2f 2a 20 46 75 6e 63 74 69  ger);../* Functi
14b0: 6f 6e 73 20 75 73 65 64 20 74 6f 20 71 75 65 72  ons used to quer
14c0: 79 20 70 61 67 65 72 20 73 74 61 74 65 20 61 6e  y pager state an
14d0: 64 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2e  d configuration.
14e0: 20 2a 2f 0a 75 38 20 73 71 6c 69 74 65 33 50 61   */.u8 sqlite3Pa
14f0: 67 65 72 49 73 72 65 61 64 6f 6e 6c 79 28 50 61  gerIsreadonly(Pa
1500: 67 65 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  ger*);.int sqlit
1510: 65 33 50 61 67 65 72 52 65 66 63 6f 75 6e 74 28  e3PagerRefcount(
1520: 50 61 67 65 72 2a 29 3b 0a 69 6e 74 20 73 71 6c  Pager*);.int sql
1530: 69 74 65 33 50 61 67 65 72 4d 65 6d 55 73 65 64  ite3PagerMemUsed
1540: 28 50 61 67 65 72 2a 29 3b 0a 63 6f 6e 73 74 20  (Pager*);.const 
1550: 63 68 61 72 20 2a 73 71 6c 69 74 65 33 50 61 67  char *sqlite3Pag
1560: 65 72 46 69 6c 65 6e 61 6d 65 28 50 61 67 65 72  erFilename(Pager
1570: 2a 29 3b 0a 63 6f 6e 73 74 20 73 71 6c 69 74 65  *);.const sqlite
1580: 33 5f 76 66 73 20 2a 73 71 6c 69 74 65 33 50 61  3_vfs *sqlite3Pa
1590: 67 65 72 56 66 73 28 50 61 67 65 72 2a 29 3b 0a  gerVfs(Pager*);.
15a0: 73 71 6c 69 74 65 33 5f 66 69 6c 65 20 2a 73 71  sqlite3_file *sq
15b0: 6c 69 74 65 33 50 61 67 65 72 46 69 6c 65 28 50  lite3PagerFile(P
15c0: 61 67 65 72 2a 29 3b 0a 63 6f 6e 73 74 20 63 68  ager*);.const ch
15d0: 61 72 20 2a 73 71 6c 69 74 65 33 50 61 67 65 72  ar *sqlite3Pager
15e0: 4a 6f 75 72 6e 61 6c 6e 61 6d 65 28 50 61 67 65  Journalname(Page
15f0: 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  r*);.int sqlite3
1600: 50 61 67 65 72 4e 6f 73 79 6e 63 28 50 61 67 65  PagerNosync(Page
1610: 72 2a 29 3b 0a 76 6f 69 64 20 2a 73 71 6c 69 74  r*);.void *sqlit
1620: 65 33 50 61 67 65 72 54 65 6d 70 53 70 61 63 65  e3PagerTempSpace
1630: 28 50 61 67 65 72 2a 29 3b 0a 69 6e 74 20 73 71  (Pager*);.int sq
1640: 6c 69 74 65 33 50 61 67 65 72 49 73 4d 65 6d 64  lite3PagerIsMemd
1650: 62 28 50 61 67 65 72 2a 29 3b 0a 76 6f 69 64 20  b(Pager*);.void 
1660: 73 71 6c 69 74 65 33 50 61 67 65 72 43 61 63 68  sqlite3PagerCach
1670: 65 53 74 61 74 28 50 61 67 65 72 20 2a 2c 20 69  eStat(Pager *, i
1680: 6e 74 2c 20 69 6e 74 2c 20 69 6e 74 20 2a 29 3b  nt, int, int *);
1690: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 61 67  .void sqlite3Pag
16a0: 65 72 43 6c 65 61 72 43 61 63 68 65 28 50 61 67  erClearCache(Pag
16b0: 65 72 20 2a 29 3b 0a 0a 2f 2a 20 46 75 6e 63 74  er *);../* Funct
16c0: 69 6f 6e 73 20 75 73 65 64 20 74 6f 20 74 72 75  ions used to tru
16d0: 6e 63 61 74 65 20 74 68 65 20 64 61 74 61 62 61  ncate the databa
16e0: 73 65 20 66 69 6c 65 2e 20 2a 2f 0a 76 6f 69 64  se file. */.void
16f0: 20 73 71 6c 69 74 65 33 50 61 67 65 72 54 72 75   sqlite3PagerTru
1700: 6e 63 61 74 65 49 6d 61 67 65 28 50 61 67 65 72  ncateImage(Pager
1710: 2a 2c 50 67 6e 6f 29 3b 0a 0a 23 69 66 20 64 65  *,Pgno);..#if de
1720: 66 69 6e 65 64 28 53 51 4c 49 54 45 5f 48 41 53  fined(SQLITE_HAS
1730: 5f 43 4f 44 45 43 29 20 26 26 20 21 64 65 66 69  _CODEC) && !defi
1740: 6e 65 64 28 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ned(SQLITE_OMIT_
1750: 57 41 4c 29 0a 76 6f 69 64 20 2a 73 71 6c 69 74  WAL).void *sqlit
1760: 65 33 50 61 67 65 72 43 6f 64 65 63 28 44 62 50  e3PagerCodec(DbP
1770: 61 67 65 20 2a 29 3b 0a 23 65 6e 64 69 66 0a 0a  age *);.#endif..
1780: 2f 2a 20 46 75 6e 63 74 69 6f 6e 73 20 74 6f 20  /* Functions to 
1790: 73 75 70 70 6f 72 74 20 74 65 73 74 69 6e 67 20  support testing 
17a0: 61 6e 64 20 64 65 62 75 67 67 69 6e 67 2e 20 2a  and debugging. *
17b0: 2f 0a 23 69 66 20 21 64 65 66 69 6e 65 64 28 4e  /.#if !defined(N
17c0: 44 45 42 55 47 29 20 7c 7c 20 64 65 66 69 6e 65  DEBUG) || define
17d0: 64 28 53 51 4c 49 54 45 5f 54 45 53 54 29 0a 20  d(SQLITE_TEST). 
17e0: 20 50 67 6e 6f 20 73 71 6c 69 74 65 33 50 61 67   Pgno sqlite3Pag
17f0: 65 72 50 61 67 65 6e 75 6d 62 65 72 28 44 62 50  erPagenumber(DbP
1800: 61 67 65 2a 29 3b 0a 20 20 69 6e 74 20 73 71 6c  age*);.  int sql
1810: 69 74 65 33 50 61 67 65 72 49 73 77 72 69 74 65  ite3PagerIswrite
1820: 61 62 6c 65 28 44 62 50 61 67 65 2a 29 3b 0a 23  able(DbPage*);.#
1830: 65 6e 64 69 66 0a 23 69 66 64 65 66 20 53 51 4c  endif.#ifdef SQL
1840: 49 54 45 5f 54 45 53 54 0a 20 20 69 6e 74 20 2a  ITE_TEST.  int *
1850: 73 71 6c 69 74 65 33 50 61 67 65 72 53 74 61 74  sqlite3PagerStat
1860: 73 28 50 61 67 65 72 2a 29 3b 0a 20 20 76 6f 69  s(Pager*);.  voi
1870: 64 20 73 71 6c 69 74 65 33 50 61 67 65 72 52 65  d sqlite3PagerRe
1880: 66 64 75 6d 70 28 50 61 67 65 72 2a 29 3b 0a 20  fdump(Pager*);. 
1890: 20 76 6f 69 64 20 64 69 73 61 62 6c 65 5f 73 69   void disable_si
18a0: 6d 75 6c 61 74 65 64 5f 69 6f 5f 65 72 72 6f 72  mulated_io_error
18b0: 73 28 76 6f 69 64 29 3b 0a 20 20 76 6f 69 64 20  s(void);.  void 
18c0: 65 6e 61 62 6c 65 5f 73 69 6d 75 6c 61 74 65 64  enable_simulated
18d0: 5f 69 6f 5f 65 72 72 6f 72 73 28 76 6f 69 64 29  _io_errors(void)
18e0: 3b 0a 23 65 6c 73 65 0a 23 20 64 65 66 69 6e 65  ;.#else.# define
18f0: 20 64 69 73 61 62 6c 65 5f 73 69 6d 75 6c 61 74   disable_simulat
1900: 65 64 5f 69 6f 5f 65 72 72 6f 72 73 28 29 0a 23  ed_io_errors().#
1910: 20 64 65 66 69 6e 65 20 65 6e 61 62 6c 65 5f 73   define enable_s
1920: 69 6d 75 6c 61 74 65 64 5f 69 6f 5f 65 72 72 6f  imulated_io_erro
1930: 72 73 28 29 0a 23 65 6e 64 69 66 0a 0a 23 65 6e  rs().#endif..#en
1940: 64 69 66 20 2f 2a 20 5f 50 41 47 45 52 5f 48 5f  dif /* _PAGER_H_
1950: 20 2a 2f 0a                                       */.