/ Hex Artifact Content
Login

Artifact 11852d044c86cf5a9d6e34171fb0c4fcf1f6265f:


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 2a 0a 2a 2a 20 40 28 23 29 20  ack..**.** @(#) 
0240: 24 49 64 3a 20 70 61 67 65 72 2e 68 2c 76 20 31  $Id: pager.h,v 1
0250: 2e 31 30 34 20 32 30 30 39 2f 30 37 2f 32 34 20  .104 2009/07/24 
0260: 31 39 3a 30 31 3a 31 39 20 64 72 68 20 45 78 70  19:01:19 drh Exp
0270: 20 24 0a 2a 2f 0a 0a 23 69 66 6e 64 65 66 20 5f   $.*/..#ifndef _
0280: 50 41 47 45 52 5f 48 5f 0a 23 64 65 66 69 6e 65  PAGER_H_.#define
0290: 20 5f 50 41 47 45 52 5f 48 5f 0a 0a 2f 2a 0a 2a   _PAGER_H_../*.*
02a0: 2a 20 44 65 66 61 75 6c 74 20 6d 61 78 69 6d 75  * Default maximu
02b0: 6d 20 73 69 7a 65 20 66 6f 72 20 70 65 72 73 69  m size for persi
02c0: 73 74 65 6e 74 20 6a 6f 75 72 6e 61 6c 20 66 69  stent journal fi
02d0: 6c 65 73 2e 20 41 20 6e 65 67 61 74 69 76 65 20  les. A negative 
02e0: 0a 2a 2a 20 76 61 6c 75 65 20 6d 65 61 6e 73 20  .** value means 
02f0: 6e 6f 20 6c 69 6d 69 74 2e 20 54 68 69 73 20 76  no limit. This v
0300: 61 6c 75 65 20 6d 61 79 20 62 65 20 6f 76 65 72  alue may be over
0310: 72 69 64 64 65 6e 20 75 73 69 6e 67 20 74 68 65  ridden using the
0320: 20 0a 2a 2a 20 73 71 6c 69 74 65 33 50 61 67 65   .** sqlite3Page
0330: 72 4a 6f 75 72 6e 61 6c 53 69 7a 65 4c 69 6d 69  rJournalSizeLimi
0340: 74 28 29 20 41 50 49 2e 20 53 65 65 20 61 6c 73  t() API. See als
0350: 6f 20 22 50 52 41 47 4d 41 20 6a 6f 75 72 6e 61  o "PRAGMA journa
0360: 6c 5f 73 69 7a 65 5f 6c 69 6d 69 74 22 2e 0a 2a  l_size_limit"..*
0370: 2f 0a 23 69 66 6e 64 65 66 20 53 51 4c 49 54 45  /.#ifndef SQLITE
0380: 5f 44 45 46 41 55 4c 54 5f 4a 4f 55 52 4e 41 4c  _DEFAULT_JOURNAL
0390: 5f 53 49 5a 45 5f 4c 49 4d 49 54 0a 20 20 23 64  _SIZE_LIMIT.  #d
03a0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 45 46  efine SQLITE_DEF
03b0: 41 55 4c 54 5f 4a 4f 55 52 4e 41 4c 5f 53 49 5a  AULT_JOURNAL_SIZ
03c0: 45 5f 4c 49 4d 49 54 20 2d 31 0a 23 65 6e 64 69  E_LIMIT -1.#endi
03d0: 66 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20 74 79 70  f../*.** The typ
03e0: 65 20 75 73 65 64 20 74 6f 20 72 65 70 72 65 73  e used to repres
03f0: 65 6e 74 20 61 20 70 61 67 65 20 6e 75 6d 62 65  ent a page numbe
0400: 72 2e 20 20 54 68 65 20 66 69 72 73 74 20 70 61  r.  The first pa
0410: 67 65 20 69 6e 20 61 20 66 69 6c 65 0a 2a 2a 20  ge in a file.** 
0420: 69 73 20 63 61 6c 6c 65 64 20 70 61 67 65 20 31  is called page 1
0430: 2e 20 20 30 20 69 73 20 75 73 65 64 20 74 6f 20  .  0 is used to 
0440: 72 65 70 72 65 73 65 6e 74 20 22 6e 6f 74 20 61  represent "not a
0450: 20 70 61 67 65 22 2e 0a 2a 2f 0a 74 79 70 65 64   page"..*/.typed
0460: 65 66 20 75 33 32 20 50 67 6e 6f 3b 0a 0a 2f 2a  ef u32 Pgno;../*
0470: 0a 2a 2a 20 45 61 63 68 20 6f 70 65 6e 20 66 69  .** Each open fi
0480: 6c 65 20 69 73 20 6d 61 6e 61 67 65 64 20 62 79  le is managed by
0490: 20 61 20 73 65 70 61 72 61 74 65 20 69 6e 73 74   a separate inst
04a0: 61 6e 63 65 20 6f 66 20 74 68 65 20 22 50 61 67  ance of the "Pag
04b0: 65 72 22 20 73 74 72 75 63 74 75 72 65 2e 0a 2a  er" structure..*
04c0: 2f 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74  /.typedef struct
04d0: 20 50 61 67 65 72 20 50 61 67 65 72 3b 0a 0a 2f   Pager Pager;../
04e0: 2a 0a 2a 2a 20 48 61 6e 64 6c 65 20 74 79 70 65  *.** Handle type
04f0: 20 66 6f 72 20 70 61 67 65 73 2e 0a 2a 2f 0a 74   for pages..*/.t
0500: 79 70 65 64 65 66 20 73 74 72 75 63 74 20 50 67  ypedef struct Pg
0510: 48 64 72 20 44 62 50 61 67 65 3b 0a 0a 2f 2a 0a  Hdr DbPage;../*.
0520: 2a 2a 20 50 61 67 65 20 6e 75 6d 62 65 72 20 50  ** Page number P
0530: 41 47 45 52 5f 4d 4a 5f 50 47 4e 4f 20 69 73 20  AGER_MJ_PGNO is 
0540: 6e 65 76 65 72 20 75 73 65 64 20 69 6e 20 61 6e  never used in an
0550: 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73 65   SQLite database
0560: 20 28 69 74 20 69 73 0a 2a 2a 20 72 65 73 65 72   (it is.** reser
0570: 76 65 64 20 66 6f 72 20 77 6f 72 6b 69 6e 67 20  ved for working 
0580: 61 72 6f 75 6e 64 20 61 20 77 69 6e 64 6f 77 73  around a windows
0590: 2f 70 6f 73 69 78 20 69 6e 63 6f 6d 70 61 74 69  /posix incompati
05a0: 62 69 6c 69 74 79 29 2e 20 49 74 20 69 73 0a 2a  bility). It is.*
05b0: 2a 20 75 73 65 64 20 69 6e 20 74 68 65 20 6a 6f  * used in the jo
05c0: 75 72 6e 61 6c 20 74 6f 20 73 69 67 6e 69 66 79  urnal to signify
05d0: 20 74 68 61 74 20 74 68 65 20 72 65 6d 61 69 6e   that the remain
05e0: 64 65 72 20 6f 66 20 74 68 65 20 6a 6f 75 72 6e  der of the journ
05f0: 61 6c 20 66 69 6c 65 20 0a 2a 2a 20 69 73 20 64  al file .** is d
0600: 65 76 6f 74 65 64 20 74 6f 20 73 74 6f 72 69 6e  evoted to storin
0610: 67 20 61 20 6d 61 73 74 65 72 20 6a 6f 75 72 6e  g a master journ
0620: 61 6c 20 6e 61 6d 65 20 2d 20 74 68 65 72 65 20  al name - there 
0630: 61 72 65 20 6e 6f 20 6d 6f 72 65 20 70 61 67 65  are no more page
0640: 73 20 74 6f 0a 2a 2a 20 72 6f 6c 6c 20 62 61 63  s to.** roll bac
0650: 6b 2e 20 53 65 65 20 63 6f 6d 6d 65 6e 74 73 20  k. See comments 
0660: 66 6f 72 20 66 75 6e 63 74 69 6f 6e 20 77 72 69  for function wri
0670: 74 65 4d 61 73 74 65 72 4a 6f 75 72 6e 61 6c 28  teMasterJournal(
0680: 29 20 69 6e 20 70 61 67 65 72 2e 63 20 0a 2a 2a  ) in pager.c .**
0690: 20 66 6f 72 20 64 65 74 61 69 6c 73 2e 0a 2a 2f   for details..*/
06a0: 0a 23 64 65 66 69 6e 65 20 50 41 47 45 52 5f 4d  .#define PAGER_M
06b0: 4a 5f 50 47 4e 4f 28 78 29 20 28 28 50 67 6e 6f  J_PGNO(x) ((Pgno
06c0: 29 28 28 50 45 4e 44 49 4e 47 5f 42 59 54 45 2f  )((PENDING_BYTE/
06d0: 28 28 78 29 2d 3e 70 61 67 65 53 69 7a 65 29 29  ((x)->pageSize))
06e0: 2b 31 29 29 0a 0a 2f 2a 0a 2a 2a 20 41 6c 6c 6f  +1))../*.** Allo
06f0: 77 65 64 20 76 61 6c 75 65 73 20 66 6f 72 20 74  wed values for t
0700: 68 65 20 66 6c 61 67 73 20 70 61 72 61 6d 65 74  he flags paramet
0710: 65 72 20 74 6f 20 73 71 6c 69 74 65 33 50 61 67  er to sqlite3Pag
0720: 65 72 4f 70 65 6e 28 29 2e 0a 2a 2a 0a 2a 2a 20  erOpen()..**.** 
0730: 4e 4f 54 45 3a 20 54 68 65 73 65 20 76 61 6c 75  NOTE: These valu
0740: 65 73 20 6d 75 73 74 20 6d 61 74 63 68 20 74 68  es must match th
0750: 65 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20  e corresponding 
0760: 42 54 52 45 45 5f 20 76 61 6c 75 65 73 20 69 6e  BTREE_ values in
0770: 20 62 74 72 65 65 2e 68 2e 0a 2a 2f 0a 23 64 65   btree.h..*/.#de
0780: 66 69 6e 65 20 50 41 47 45 52 5f 4f 4d 49 54 5f  fine PAGER_OMIT_
0790: 4a 4f 55 52 4e 41 4c 20 20 30 78 30 30 30 31 20  JOURNAL  0x0001 
07a0: 20 20 20 2f 2a 20 44 6f 20 6e 6f 74 20 75 73 65     /* Do not use
07b0: 20 61 20 72 6f 6c 6c 62 61 63 6b 20 6a 6f 75 72   a rollback jour
07c0: 6e 61 6c 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50  nal */.#define P
07d0: 41 47 45 52 5f 4e 4f 5f 52 45 41 44 4c 4f 43 4b  AGER_NO_READLOCK
07e0: 20 20 20 30 78 30 30 30 32 20 20 20 20 2f 2a 20     0x0002    /* 
07f0: 4f 6d 69 74 20 72 65 61 64 6c 6f 63 6b 73 20 6f  Omit readlocks o
0800: 6e 20 72 65 61 64 6f 6e 6c 79 20 66 69 6c 65 73  n readonly files
0810: 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 56 61 6c 69 64   */../*.** Valid
0820: 20 76 61 6c 75 65 73 20 66 6f 72 20 74 68 65 20   values for the 
0830: 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20  second argument 
0840: 74 6f 20 73 71 6c 69 74 65 33 50 61 67 65 72 4c  to sqlite3PagerL
0850: 6f 63 6b 69 6e 67 4d 6f 64 65 28 29 2e 0a 2a 2f  ockingMode()..*/
0860: 0a 23 64 65 66 69 6e 65 20 50 41 47 45 52 5f 4c  .#define PAGER_L
0870: 4f 43 4b 49 4e 47 4d 4f 44 45 5f 51 55 45 52 59  OCKINGMODE_QUERY
0880: 20 20 20 20 20 20 2d 31 0a 23 64 65 66 69 6e 65        -1.#define
0890: 20 50 41 47 45 52 5f 4c 4f 43 4b 49 4e 47 4d 4f   PAGER_LOCKINGMO
08a0: 44 45 5f 4e 4f 52 4d 41 4c 20 20 20 20 20 20 30  DE_NORMAL      0
08b0: 0a 23 64 65 66 69 6e 65 20 50 41 47 45 52 5f 4c  .#define PAGER_L
08c0: 4f 43 4b 49 4e 47 4d 4f 44 45 5f 45 58 43 4c 55  OCKINGMODE_EXCLU
08d0: 53 49 56 45 20 20 20 31 0a 0a 2f 2a 0a 2a 2a 20  SIVE   1../*.** 
08e0: 56 61 6c 69 64 20 76 61 6c 75 65 73 20 66 6f 72  Valid values for
08f0: 20 74 68 65 20 73 65 63 6f 6e 64 20 61 72 67 75   the second argu
0900: 6d 65 6e 74 20 74 6f 20 73 71 6c 69 74 65 33 50  ment to sqlite3P
0910: 61 67 65 72 4a 6f 75 72 6e 61 6c 4d 6f 64 65 28  agerJournalMode(
0920: 29 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 50 41  )..*/.#define PA
0930: 47 45 52 5f 4a 4f 55 52 4e 41 4c 4d 4f 44 45 5f  GER_JOURNALMODE_
0940: 51 55 45 52 59 20 20 20 20 20 20 2d 31 0a 23 64  QUERY      -1.#d
0950: 65 66 69 6e 65 20 50 41 47 45 52 5f 4a 4f 55 52  efine PAGER_JOUR
0960: 4e 41 4c 4d 4f 44 45 5f 44 45 4c 45 54 45 20 20  NALMODE_DELETE  
0970: 20 20 20 20 30 20 20 20 2f 2a 20 43 6f 6d 6d 69      0   /* Commi
0980: 74 20 62 79 20 64 65 6c 65 74 69 6e 67 20 6a 6f  t by deleting jo
0990: 75 72 6e 61 6c 20 66 69 6c 65 20 2a 2f 0a 23 64  urnal file */.#d
09a0: 65 66 69 6e 65 20 50 41 47 45 52 5f 4a 4f 55 52  efine PAGER_JOUR
09b0: 4e 41 4c 4d 4f 44 45 5f 50 45 52 53 49 53 54 20  NALMODE_PERSIST 
09c0: 20 20 20 20 31 20 20 20 2f 2a 20 43 6f 6d 6d 69      1   /* Commi
09d0: 74 20 62 79 20 7a 65 72 6f 69 6e 67 20 6a 6f 75  t by zeroing jou
09e0: 72 6e 61 6c 20 68 65 61 64 65 72 20 2a 2f 0a 23  rnal header */.#
09f0: 64 65 66 69 6e 65 20 50 41 47 45 52 5f 4a 4f 55  define PAGER_JOU
0a00: 52 4e 41 4c 4d 4f 44 45 5f 4f 46 46 20 20 20 20  RNALMODE_OFF    
0a10: 20 20 20 20 20 32 20 20 20 2f 2a 20 4a 6f 75 72       2   /* Jour
0a20: 6e 61 6c 20 6f 6d 69 74 74 65 64 2e 20 20 2a 2f  nal omitted.  */
0a30: 0a 23 64 65 66 69 6e 65 20 50 41 47 45 52 5f 4a  .#define PAGER_J
0a40: 4f 55 52 4e 41 4c 4d 4f 44 45 5f 54 52 55 4e 43  OURNALMODE_TRUNC
0a50: 41 54 45 20 20 20 20 33 20 20 20 2f 2a 20 43 6f  ATE    3   /* Co
0a60: 6d 6d 69 74 20 62 79 20 74 72 75 6e 63 61 74 69  mmit by truncati
0a70: 6e 67 20 6a 6f 75 72 6e 61 6c 20 2a 2f 0a 23 64  ng journal */.#d
0a80: 65 66 69 6e 65 20 50 41 47 45 52 5f 4a 4f 55 52  efine PAGER_JOUR
0a90: 4e 41 4c 4d 4f 44 45 5f 4d 45 4d 4f 52 59 20 20  NALMODE_MEMORY  
0aa0: 20 20 20 20 34 20 20 20 2f 2a 20 49 6e 2d 6d 65      4   /* In-me
0ab0: 6d 6f 72 79 20 6a 6f 75 72 6e 61 6c 20 66 69 6c  mory journal fil
0ac0: 65 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20  e */../*.** The 
0ad0: 72 65 6d 61 69 6e 64 65 72 20 6f 66 20 74 68 69  remainder of thi
0ae0: 73 20 66 69 6c 65 20 63 6f 6e 74 61 69 6e 73 20  s file contains 
0af0: 74 68 65 20 64 65 63 6c 61 72 61 74 69 6f 6e 73  the declarations
0b00: 20 6f 66 20 74 68 65 20 66 75 6e 63 74 69 6f 6e   of the function
0b10: 73 0a 2a 2a 20 74 68 61 74 20 6d 61 6b 65 20 75  s.** that make u
0b20: 70 20 74 68 65 20 50 61 67 65 72 20 73 75 62 2d  p the Pager sub-
0b30: 73 79 73 74 65 6d 20 41 50 49 2e 20 53 65 65 20  system API. See 
0b40: 73 6f 75 72 63 65 20 63 6f 64 65 20 63 6f 6d 6d  source code comm
0b50: 65 6e 74 73 20 66 6f 72 20 0a 2a 2a 20 61 20 64  ents for .** a d
0b60: 65 74 61 69 6c 65 64 20 64 65 73 63 72 69 70 74  etailed descript
0b70: 69 6f 6e 20 6f 66 20 65 61 63 68 20 72 6f 75 74  ion of each rout
0b80: 69 6e 65 2e 0a 2a 2f 0a 0a 2f 2a 20 4f 70 65 6e  ine..*/../* Open
0b90: 20 61 6e 64 20 63 6c 6f 73 65 20 61 20 50 61 67   and close a Pag
0ba0: 65 72 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 20 2a  er connection. *
0bb0: 2f 20 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 61  / .int sqlite3Pa
0bc0: 67 65 72 4f 70 65 6e 28 0a 20 20 73 71 6c 69 74  gerOpen(.  sqlit
0bd0: 65 33 5f 76 66 73 2a 2c 0a 20 20 50 61 67 65 72  e3_vfs*,.  Pager
0be0: 20 2a 2a 70 70 50 61 67 65 72 2c 0a 20 20 63 6f   **ppPager,.  co
0bf0: 6e 73 74 20 63 68 61 72 2a 2c 0a 20 20 69 6e 74  nst char*,.  int
0c00: 2c 0a 20 20 69 6e 74 2c 0a 20 20 69 6e 74 2c 0a  ,.  int,.  int,.
0c10: 20 20 76 6f 69 64 28 2a 29 28 44 62 50 61 67 65    void(*)(DbPage
0c20: 2a 29 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  *).);.int sqlite
0c30: 33 50 61 67 65 72 43 6c 6f 73 65 28 50 61 67 65  3PagerClose(Page
0c40: 72 20 2a 70 50 61 67 65 72 29 3b 0a 69 6e 74 20  r *pPager);.int 
0c50: 73 71 6c 69 74 65 33 50 61 67 65 72 52 65 61 64  sqlite3PagerRead
0c60: 46 69 6c 65 68 65 61 64 65 72 28 50 61 67 65 72  Fileheader(Pager
0c70: 2a 2c 20 69 6e 74 2c 20 75 6e 73 69 67 6e 65 64  *, int, unsigned
0c80: 20 63 68 61 72 2a 29 3b 0a 0a 2f 2a 20 46 75 6e   char*);../* Fun
0c90: 63 74 69 6f 6e 73 20 75 73 65 64 20 74 6f 20 63  ctions used to c
0ca0: 6f 6e 66 69 67 75 72 65 20 61 20 50 61 67 65 72  onfigure a Pager
0cb0: 20 6f 62 6a 65 63 74 2e 20 2a 2f 0a 76 6f 69 64   object. */.void
0cc0: 20 73 71 6c 69 74 65 33 50 61 67 65 72 53 65 74   sqlite3PagerSet
0cd0: 42 75 73 79 68 61 6e 64 6c 65 72 28 50 61 67 65  Busyhandler(Page
0ce0: 72 2a 2c 20 69 6e 74 28 2a 29 28 76 6f 69 64 20  r*, int(*)(void 
0cf0: 2a 29 2c 20 76 6f 69 64 20 2a 29 3b 0a 69 6e 74  *), void *);.int
0d00: 20 73 71 6c 69 74 65 33 50 61 67 65 72 53 65 74   sqlite3PagerSet
0d10: 50 61 67 65 73 69 7a 65 28 50 61 67 65 72 2a 2c  Pagesize(Pager*,
0d20: 20 75 31 36 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74   u16*, int);.int
0d30: 20 73 71 6c 69 74 65 33 50 61 67 65 72 4d 61 78   sqlite3PagerMax
0d40: 50 61 67 65 43 6f 75 6e 74 28 50 61 67 65 72 2a  PageCount(Pager*
0d50: 2c 20 69 6e 74 29 3b 0a 76 6f 69 64 20 73 71 6c  , int);.void sql
0d60: 69 74 65 33 50 61 67 65 72 53 65 74 43 61 63 68  ite3PagerSetCach
0d70: 65 73 69 7a 65 28 50 61 67 65 72 2a 2c 20 69 6e  esize(Pager*, in
0d80: 74 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  t);.void sqlite3
0d90: 50 61 67 65 72 53 65 74 53 61 66 65 74 79 4c 65  PagerSetSafetyLe
0da0: 76 65 6c 28 50 61 67 65 72 2a 2c 69 6e 74 2c 69  vel(Pager*,int,i
0db0: 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  nt);.int sqlite3
0dc0: 50 61 67 65 72 4c 6f 63 6b 69 6e 67 4d 6f 64 65  PagerLockingMode
0dd0: 28 50 61 67 65 72 20 2a 2c 20 69 6e 74 29 3b 0a  (Pager *, int);.
0de0: 69 6e 74 20 73 71 6c 69 74 65 33 50 61 67 65 72  int sqlite3Pager
0df0: 4a 6f 75 72 6e 61 6c 4d 6f 64 65 28 50 61 67 65  JournalMode(Page
0e00: 72 20 2a 2c 20 69 6e 74 29 3b 0a 69 36 34 20 73  r *, int);.i64 s
0e10: 71 6c 69 74 65 33 50 61 67 65 72 4a 6f 75 72 6e  qlite3PagerJourn
0e20: 61 6c 53 69 7a 65 4c 69 6d 69 74 28 50 61 67 65  alSizeLimit(Page
0e30: 72 20 2a 2c 20 69 36 34 29 3b 0a 73 71 6c 69 74  r *, i64);.sqlit
0e40: 65 33 5f 62 61 63 6b 75 70 20 2a 2a 73 71 6c 69  e3_backup **sqli
0e50: 74 65 33 50 61 67 65 72 42 61 63 6b 75 70 50 74  te3PagerBackupPt
0e60: 72 28 50 61 67 65 72 2a 29 3b 0a 0a 2f 2a 20 46  r(Pager*);../* F
0e70: 75 6e 63 74 69 6f 6e 73 20 75 73 65 64 20 74 6f  unctions used to
0e80: 20 6f 62 74 61 69 6e 20 61 6e 64 20 72 65 6c 65   obtain and rele
0e90: 61 73 65 20 70 61 67 65 20 72 65 66 65 72 65 6e  ase page referen
0ea0: 63 65 73 2e 20 2a 2f 20 0a 69 6e 74 20 73 71 6c  ces. */ .int sql
0eb0: 69 74 65 33 50 61 67 65 72 41 63 71 75 69 72 65  ite3PagerAcquire
0ec0: 28 50 61 67 65 72 20 2a 70 50 61 67 65 72 2c 20  (Pager *pPager, 
0ed0: 50 67 6e 6f 20 70 67 6e 6f 2c 20 44 62 50 61 67  Pgno pgno, DbPag
0ee0: 65 20 2a 2a 70 70 50 61 67 65 2c 20 69 6e 74 20  e **ppPage, int 
0ef0: 63 6c 72 46 6c 61 67 29 3b 0a 23 64 65 66 69 6e  clrFlag);.#defin
0f00: 65 20 73 71 6c 69 74 65 33 50 61 67 65 72 47 65  e sqlite3PagerGe
0f10: 74 28 41 2c 42 2c 43 29 20 73 71 6c 69 74 65 33  t(A,B,C) sqlite3
0f20: 50 61 67 65 72 41 63 71 75 69 72 65 28 41 2c 42  PagerAcquire(A,B
0f30: 2c 43 2c 30 29 0a 44 62 50 61 67 65 20 2a 73 71  ,C,0).DbPage *sq
0f40: 6c 69 74 65 33 50 61 67 65 72 4c 6f 6f 6b 75 70  lite3PagerLookup
0f50: 28 50 61 67 65 72 20 2a 70 50 61 67 65 72 2c 20  (Pager *pPager, 
0f60: 50 67 6e 6f 20 70 67 6e 6f 29 3b 0a 76 6f 69 64  Pgno pgno);.void
0f70: 20 73 71 6c 69 74 65 33 50 61 67 65 72 52 65 66   sqlite3PagerRef
0f80: 28 44 62 50 61 67 65 2a 29 3b 0a 76 6f 69 64 20  (DbPage*);.void 
0f90: 73 71 6c 69 74 65 33 50 61 67 65 72 55 6e 72 65  sqlite3PagerUnre
0fa0: 66 28 44 62 50 61 67 65 2a 29 3b 0a 0a 2f 2a 20  f(DbPage*);../* 
0fb0: 4f 70 65 72 61 74 69 6f 6e 73 20 6f 6e 20 70 61  Operations on pa
0fc0: 67 65 20 72 65 66 65 72 65 6e 63 65 73 2e 20 2a  ge references. *
0fd0: 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 61 67  /.int sqlite3Pag
0fe0: 65 72 57 72 69 74 65 28 44 62 50 61 67 65 2a 29  erWrite(DbPage*)
0ff0: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 61  ;.void sqlite3Pa
1000: 67 65 72 44 6f 6e 74 57 72 69 74 65 28 44 62 50  gerDontWrite(DbP
1010: 61 67 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  age*);.int sqlit
1020: 65 33 50 61 67 65 72 4d 6f 76 65 70 61 67 65 28  e3PagerMovepage(
1030: 50 61 67 65 72 2a 2c 44 62 50 61 67 65 2a 2c 50  Pager*,DbPage*,P
1040: 67 6e 6f 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71  gno,int);.int sq
1050: 6c 69 74 65 33 50 61 67 65 72 50 61 67 65 52 65  lite3PagerPageRe
1060: 66 63 6f 75 6e 74 28 44 62 50 61 67 65 2a 29 3b  fcount(DbPage*);
1070: 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 50 61  .void *sqlite3Pa
1080: 67 65 72 47 65 74 44 61 74 61 28 44 62 50 61 67  gerGetData(DbPag
1090: 65 20 2a 29 3b 20 0a 76 6f 69 64 20 2a 73 71 6c  e *); .void *sql
10a0: 69 74 65 33 50 61 67 65 72 47 65 74 45 78 74 72  ite3PagerGetExtr
10b0: 61 28 44 62 50 61 67 65 20 2a 29 3b 20 0a 0a 2f  a(DbPage *); ../
10c0: 2a 20 46 75 6e 63 74 69 6f 6e 73 20 75 73 65 64  * Functions used
10d0: 20 74 6f 20 6d 61 6e 61 67 65 20 70 61 67 65 72   to manage pager
10e0: 20 74 72 61 6e 73 61 63 74 69 6f 6e 73 20 61 6e   transactions an
10f0: 64 20 73 61 76 65 70 6f 69 6e 74 73 2e 20 2a 2f  d savepoints. */
1100: 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 61 67 65  .int sqlite3Page
1110: 72 50 61 67 65 63 6f 75 6e 74 28 50 61 67 65 72  rPagecount(Pager
1120: 2a 2c 20 69 6e 74 2a 29 3b 0a 69 6e 74 20 73 71  *, int*);.int sq
1130: 6c 69 74 65 33 50 61 67 65 72 42 65 67 69 6e 28  lite3PagerBegin(
1140: 50 61 67 65 72 2a 2c 20 69 6e 74 20 65 78 46 6c  Pager*, int exFl
1150: 61 67 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71  ag, int);.int sq
1160: 6c 69 74 65 33 50 61 67 65 72 43 6f 6d 6d 69 74  lite3PagerCommit
1170: 50 68 61 73 65 4f 6e 65 28 50 61 67 65 72 2a 2c  PhaseOne(Pager*,
1180: 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4d 61 73  const char *zMas
1190: 74 65 72 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73  ter, int);.int s
11a0: 71 6c 69 74 65 33 50 61 67 65 72 53 79 6e 63 28  qlite3PagerSync(
11b0: 50 61 67 65 72 20 2a 70 50 61 67 65 72 29 3b 0a  Pager *pPager);.
11c0: 69 6e 74 20 73 71 6c 69 74 65 33 50 61 67 65 72  int sqlite3Pager
11d0: 43 6f 6d 6d 69 74 50 68 61 73 65 54 77 6f 28 50  CommitPhaseTwo(P
11e0: 61 67 65 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69  ager*);.int sqli
11f0: 74 65 33 50 61 67 65 72 52 6f 6c 6c 62 61 63 6b  te3PagerRollback
1200: 28 50 61 67 65 72 2a 29 3b 0a 69 6e 74 20 73 71  (Pager*);.int sq
1210: 6c 69 74 65 33 50 61 67 65 72 4f 70 65 6e 53 61  lite3PagerOpenSa
1220: 76 65 70 6f 69 6e 74 28 50 61 67 65 72 20 2a 70  vepoint(Pager *p
1230: 50 61 67 65 72 2c 20 69 6e 74 20 6e 29 3b 0a 69  Pager, int n);.i
1240: 6e 74 20 73 71 6c 69 74 65 33 50 61 67 65 72 53  nt sqlite3PagerS
1250: 61 76 65 70 6f 69 6e 74 28 50 61 67 65 72 20 2a  avepoint(Pager *
1260: 70 50 61 67 65 72 2c 20 69 6e 74 20 6f 70 2c 20  pPager, int op, 
1270: 69 6e 74 20 69 53 61 76 65 70 6f 69 6e 74 29 3b  int iSavepoint);
1280: 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 61 67 65  .int sqlite3Page
1290: 72 53 68 61 72 65 64 4c 6f 63 6b 28 50 61 67 65  rSharedLock(Page
12a0: 72 20 2a 70 50 61 67 65 72 29 3b 0a 0a 2f 2a 20  r *pPager);../* 
12b0: 46 75 6e 63 74 69 6f 6e 73 20 75 73 65 64 20 74  Functions used t
12c0: 6f 20 71 75 65 72 79 20 70 61 67 65 72 20 73 74  o query pager st
12d0: 61 74 65 20 61 6e 64 20 63 6f 6e 66 69 67 75 72  ate and configur
12e0: 61 74 69 6f 6e 2e 20 2a 2f 0a 75 38 20 73 71 6c  ation. */.u8 sql
12f0: 69 74 65 33 50 61 67 65 72 49 73 72 65 61 64 6f  ite3PagerIsreado
1300: 6e 6c 79 28 50 61 67 65 72 2a 29 3b 0a 69 6e 74  nly(Pager*);.int
1310: 20 73 71 6c 69 74 65 33 50 61 67 65 72 52 65 66   sqlite3PagerRef
1320: 63 6f 75 6e 74 28 50 61 67 65 72 2a 29 3b 0a 63  count(Pager*);.c
1330: 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74  onst char *sqlit
1340: 65 33 50 61 67 65 72 46 69 6c 65 6e 61 6d 65 28  e3PagerFilename(
1350: 50 61 67 65 72 2a 29 3b 0a 63 6f 6e 73 74 20 73  Pager*);.const s
1360: 71 6c 69 74 65 33 5f 76 66 73 20 2a 73 71 6c 69  qlite3_vfs *sqli
1370: 74 65 33 50 61 67 65 72 56 66 73 28 50 61 67 65  te3PagerVfs(Page
1380: 72 2a 29 3b 0a 73 71 6c 69 74 65 33 5f 66 69 6c  r*);.sqlite3_fil
1390: 65 20 2a 73 71 6c 69 74 65 33 50 61 67 65 72 46  e *sqlite3PagerF
13a0: 69 6c 65 28 50 61 67 65 72 2a 29 3b 0a 63 6f 6e  ile(Pager*);.con
13b0: 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33  st char *sqlite3
13c0: 50 61 67 65 72 4a 6f 75 72 6e 61 6c 6e 61 6d 65  PagerJournalname
13d0: 28 50 61 67 65 72 2a 29 3b 0a 69 6e 74 20 73 71  (Pager*);.int sq
13e0: 6c 69 74 65 33 50 61 67 65 72 4e 6f 73 79 6e 63  lite3PagerNosync
13f0: 28 50 61 67 65 72 2a 29 3b 0a 76 6f 69 64 20 2a  (Pager*);.void *
1400: 73 71 6c 69 74 65 33 50 61 67 65 72 54 65 6d 70  sqlite3PagerTemp
1410: 53 70 61 63 65 28 50 61 67 65 72 2a 29 3b 0a 69  Space(Pager*);.i
1420: 6e 74 20 73 71 6c 69 74 65 33 50 61 67 65 72 49  nt sqlite3PagerI
1430: 73 4d 65 6d 64 62 28 50 61 67 65 72 2a 29 3b 0a  sMemdb(Pager*);.
1440: 0a 2f 2a 20 46 75 6e 63 74 69 6f 6e 73 20 75 73  ./* Functions us
1450: 65 64 20 74 6f 20 74 72 75 6e 63 61 74 65 20 74  ed to truncate t
1460: 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65  he database file
1470: 2e 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65  . */.void sqlite
1480: 33 50 61 67 65 72 54 72 75 6e 63 61 74 65 49 6d  3PagerTruncateIm
1490: 61 67 65 28 50 61 67 65 72 2a 2c 50 67 6e 6f 29  age(Pager*,Pgno)
14a0: 3b 0a 0a 2f 2a 20 46 75 6e 63 74 69 6f 6e 73 20  ;../* Functions 
14b0: 74 6f 20 73 75 70 70 6f 72 74 20 74 65 73 74 69  to support testi
14c0: 6e 67 20 61 6e 64 20 64 65 62 75 67 67 69 6e 67  ng and debugging
14d0: 2e 20 2a 2f 0a 23 69 66 20 21 64 65 66 69 6e 65  . */.#if !define
14e0: 64 28 4e 44 45 42 55 47 29 20 7c 7c 20 64 65 66  d(NDEBUG) || def
14f0: 69 6e 65 64 28 53 51 4c 49 54 45 5f 54 45 53 54  ined(SQLITE_TEST
1500: 29 0a 20 20 50 67 6e 6f 20 73 71 6c 69 74 65 33  ).  Pgno sqlite3
1510: 50 61 67 65 72 50 61 67 65 6e 75 6d 62 65 72 28  PagerPagenumber(
1520: 44 62 50 61 67 65 2a 29 3b 0a 20 20 69 6e 74 20  DbPage*);.  int 
1530: 73 71 6c 69 74 65 33 50 61 67 65 72 49 73 77 72  sqlite3PagerIswr
1540: 69 74 65 61 62 6c 65 28 44 62 50 61 67 65 2a 29  iteable(DbPage*)
1550: 3b 0a 23 65 6e 64 69 66 0a 23 69 66 64 65 66 20  ;.#endif.#ifdef 
1560: 53 51 4c 49 54 45 5f 54 45 53 54 0a 20 20 69 6e  SQLITE_TEST.  in
1570: 74 20 2a 73 71 6c 69 74 65 33 50 61 67 65 72 53  t *sqlite3PagerS
1580: 74 61 74 73 28 50 61 67 65 72 2a 29 3b 0a 20 20  tats(Pager*);.  
1590: 76 6f 69 64 20 73 71 6c 69 74 65 33 50 61 67 65  void sqlite3Page
15a0: 72 52 65 66 64 75 6d 70 28 50 61 67 65 72 2a 29  rRefdump(Pager*)
15b0: 3b 0a 20 20 76 6f 69 64 20 64 69 73 61 62 6c 65  ;.  void disable
15c0: 5f 73 69 6d 75 6c 61 74 65 64 5f 69 6f 5f 65 72  _simulated_io_er
15d0: 72 6f 72 73 28 76 6f 69 64 29 3b 0a 20 20 76 6f  rors(void);.  vo
15e0: 69 64 20 65 6e 61 62 6c 65 5f 73 69 6d 75 6c 61  id enable_simula
15f0: 74 65 64 5f 69 6f 5f 65 72 72 6f 72 73 28 76 6f  ted_io_errors(vo
1600: 69 64 29 3b 0a 23 65 6c 73 65 0a 23 20 64 65 66  id);.#else.# def
1610: 69 6e 65 20 64 69 73 61 62 6c 65 5f 73 69 6d 75  ine disable_simu
1620: 6c 61 74 65 64 5f 69 6f 5f 65 72 72 6f 72 73 28  lated_io_errors(
1630: 29 0a 23 20 64 65 66 69 6e 65 20 65 6e 61 62 6c  ).# define enabl
1640: 65 5f 73 69 6d 75 6c 61 74 65 64 5f 69 6f 5f 65  e_simulated_io_e
1650: 72 72 6f 72 73 28 29 0a 23 65 6e 64 69 66 0a 0a  rrors().#endif..
1660: 23 65 6e 64 69 66 20 2f 2a 20 5f 50 41 47 45 52  #endif /* _PAGER
1670: 5f 48 5f 20 2a 2f 0a                             _H_ */.