/ Hex Artifact Content
Login

Artifact c683390d50f856d4cd8e24342ae62027d1bb6050:


0000: 2f 2a 0a 2a 2a 20 32 30 30 38 20 41 75 67 75 73  /*.** 2008 Augus
0010: 74 20 30 35 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61  t 05.**.** The a
0020: 75 74 68 6f 72 20 64 69 73 63 6c 61 69 6d 73 20  uthor disclaims 
0030: 63 6f 70 79 72 69 67 68 74 20 74 6f 20 74 68 69  copyright to thi
0040: 73 20 73 6f 75 72 63 65 20 63 6f 64 65 2e 20 20  s source code.  
0050: 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a 2a 20 61  In place of.** a
0060: 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65 2c 20 68   legal notice, h
0070: 65 72 65 20 69 73 20 61 20 62 6c 65 73 73 69 6e  ere is a blessin
0080: 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d 61 79 20  g:.**.**    May 
0090: 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61 6e 64 20  you do good and 
00a0: 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20 20 20 20  not evil..**    
00b0: 4d 61 79 20 79 6f 75 20 66 69 6e 64 20 66 6f 72  May you find for
00c0: 67 69 76 65 6e 65 73 73 20 66 6f 72 20 79 6f 75  giveness for you
00d0: 72 73 65 6c 66 20 61 6e 64 20 66 6f 72 67 69 76  rself and forgiv
00e0: 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20 20 20 20  e others..**    
00f0: 4d 61 79 20 79 6f 75 20 73 68 61 72 65 20 66 72  May you share fr
0100: 65 65 6c 79 2c 20 6e 65 76 65 72 20 74 61 6b 69  eely, never taki
0110: 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20 79 6f 75  ng more than you
0120: 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a 2a 2a 2a   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 0a 2a 2a 20 54 68 69 73 20 68 65 61 64  ***.** This head
0180: 65 72 20 66 69 6c 65 20 64 65 66 69 6e 65 73 20  er file defines 
0190: 74 68 65 20 69 6e 74 65 72 66 61 63 65 20 74 68  the interface th
01a0: 61 74 20 74 68 65 20 73 71 6c 69 74 65 20 70 61  at the sqlite pa
01b0: 67 65 20 63 61 63 68 65 0a 2a 2a 20 73 75 62 73  ge cache.** subs
01c0: 79 73 74 65 6d 2e 20 0a 2a 2f 0a 0a 23 69 66 6e  ystem. .*/..#ifn
01d0: 64 65 66 20 5f 50 43 41 43 48 45 5f 48 5f 0a 0a  def _PCACHE_H_..
01e0: 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20 50  typedef struct P
01f0: 67 48 64 72 20 50 67 48 64 72 3b 0a 74 79 70 65  gHdr PgHdr;.type
0200: 64 65 66 20 73 74 72 75 63 74 20 50 43 61 63 68  def struct PCach
0210: 65 20 50 43 61 63 68 65 3b 0a 0a 2f 2a 0a 2a 2a  e PCache;../*.**
0220: 20 45 76 65 72 79 20 70 61 67 65 20 69 6e 20 74   Every page in t
0230: 68 65 20 63 61 63 68 65 20 69 73 20 63 6f 6e 74  he cache is cont
0240: 72 6f 6c 6c 65 64 20 62 79 20 61 6e 20 69 6e 73  rolled by an ins
0250: 74 61 6e 63 65 20 6f 66 20 74 68 65 20 66 6f 6c  tance of the fol
0260: 6c 6f 77 69 6e 67 0a 2a 2a 20 73 74 72 75 63 74  lowing.** struct
0270: 75 72 65 2e 0a 2a 2f 0a 73 74 72 75 63 74 20 50  ure..*/.struct P
0280: 67 48 64 72 20 7b 0a 20 20 76 6f 69 64 20 2a 70  gHdr {.  void *p
0290: 44 61 74 61 3b 20 20 20 20 20 20 20 20 20 20 20  Data;           
02a0: 20 20 20 20 20 20 20 20 2f 2a 20 43 6f 6e 74 65          /* Conte
02b0: 6e 74 20 6f 66 20 74 68 69 73 20 70 61 67 65 20  nt of this page 
02c0: 2a 2f 0a 20 20 76 6f 69 64 20 2a 70 45 78 74 72  */.  void *pExtr
02d0: 61 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 20  a;              
02e0: 20 20 20 20 2f 2a 20 45 78 74 72 61 20 63 6f 6e      /* Extra con
02f0: 74 65 6e 74 20 2a 2f 0a 20 20 50 67 48 64 72 20  tent */.  PgHdr 
0300: 2a 70 44 69 72 74 79 3b 20 20 20 20 20 20 20 20  *pDirty;        
0310: 20 20 20 20 20 20 20 20 20 2f 2a 20 54 72 61 6e           /* Tran
0320: 73 69 65 6e 74 20 6c 69 73 74 20 6f 66 20 64 69  sient list of di
0330: 72 74 79 20 70 61 67 65 73 20 2a 2f 0a 20 20 50  rty pages */.  P
0340: 67 6e 6f 20 70 67 6e 6f 3b 20 20 20 20 20 20 20  gno pgno;       
0350: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a                /*
0360: 20 50 61 67 65 20 6e 75 6d 62 65 72 20 66 6f 72   Page number for
0370: 20 74 68 69 73 20 70 61 67 65 20 2a 2f 0a 20 20   this page */.  
0380: 50 61 67 65 72 20 2a 70 50 61 67 65 72 3b 20 20  Pager *pPager;  
0390: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
03a0: 2a 20 54 68 65 20 70 61 67 65 72 20 74 68 69 73  * The pager this
03b0: 20 70 61 67 65 20 69 73 20 70 61 72 74 20 6f 66   page is part of
03c0: 20 2a 2f 0a 23 69 66 64 65 66 20 53 51 4c 49 54   */.#ifdef SQLIT
03d0: 45 5f 43 48 45 43 4b 5f 50 41 47 45 53 0a 20 20  E_CHECK_PAGES.  
03e0: 75 33 32 20 70 61 67 65 48 61 73 68 3b 20 20 20  u32 pageHash;   
03f0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
0400: 2a 20 48 61 73 68 20 6f 66 20 70 61 67 65 20 63  * Hash of page c
0410: 6f 6e 74 65 6e 74 20 2a 2f 0a 23 65 6e 64 69 66  ontent */.#endif
0420: 0a 20 20 75 31 36 20 66 6c 61 67 73 3b 20 20 20  .  u16 flags;   
0430: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0440: 20 20 2f 2a 20 50 47 48 44 52 20 66 6c 61 67 73    /* PGHDR flags
0450: 20 64 65 66 69 6e 65 64 20 62 65 6c 6f 77 20 2a   defined below *
0460: 2f 0a 0a 20 20 2f 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  /..  /**********
0470: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0480: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0490: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
04a0: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 0a 20 20 2a  ************.  *
04b0: 2a 20 45 6c 65 6d 65 6e 74 73 20 61 62 6f 76 65  * Elements above
04c0: 20 61 72 65 20 70 75 62 6c 69 63 2e 20 20 41 6c   are public.  Al
04d0: 6c 20 74 68 61 74 20 66 6f 6c 6c 6f 77 73 20 69  l that follows i
04e0: 73 20 70 72 69 76 61 74 65 20 74 6f 20 70 63 61  s private to pca
04f0: 63 68 65 2e 63 0a 20 20 2a 2a 20 61 6e 64 20 73  che.c.  ** and s
0500: 68 6f 75 6c 64 20 6e 6f 74 20 62 65 20 61 63 63  hould not be acc
0510: 65 73 73 65 64 20 62 79 20 6f 74 68 65 72 20 6d  essed by other m
0520: 6f 64 75 6c 65 73 2e 0a 20 20 2a 2f 0a 20 20 69  odules..  */.  i
0530: 31 36 20 6e 52 65 66 3b 20 20 20 20 20 20 20 20  16 nRef;        
0540: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a                /*
0550: 20 4e 75 6d 62 65 72 20 6f 66 20 75 73 65 72 73   Number of users
0560: 20 6f 66 20 74 68 69 73 20 70 61 67 65 20 2a 2f   of this page */
0570: 0a 20 20 50 43 61 63 68 65 20 2a 70 43 61 63 68  .  PCache *pCach
0580: 65 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 20  e;              
0590: 20 20 2f 2a 20 43 61 63 68 65 20 74 68 61 74 20    /* Cache that 
05a0: 6f 77 6e 73 20 74 68 69 73 20 70 61 67 65 20 2a  owns this page *
05b0: 2f 0a 0a 20 20 50 67 48 64 72 20 2a 70 44 69 72  /..  PgHdr *pDir
05c0: 74 79 4e 65 78 74 3b 20 20 20 20 20 20 20 20 20  tyNext;         
05d0: 20 20 20 20 2f 2a 20 4e 65 78 74 20 65 6c 65 6d      /* Next elem
05e0: 65 6e 74 20 69 6e 20 6c 69 73 74 20 6f 66 20 64  ent in list of d
05f0: 69 72 74 79 20 70 61 67 65 73 20 2a 2f 0a 20 20  irty pages */.  
0600: 50 67 48 64 72 20 2a 70 44 69 72 74 79 50 72 65  PgHdr *pDirtyPre
0610: 76 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 2f  v;             /
0620: 2a 20 50 72 65 76 69 6f 75 73 20 65 6c 65 6d 65  * Previous eleme
0630: 6e 74 20 69 6e 20 6c 69 73 74 20 6f 66 20 64 69  nt in list of di
0640: 72 74 79 20 70 61 67 65 73 20 2a 2f 0a 7d 3b 0a  rty pages */.};.
0650: 0a 2f 2a 20 42 69 74 20 76 61 6c 75 65 73 20 66  ./* Bit values f
0660: 6f 72 20 50 67 48 64 72 2e 66 6c 61 67 73 20 2a  or PgHdr.flags *
0670: 2f 0a 23 64 65 66 69 6e 65 20 50 47 48 44 52 5f  /.#define PGHDR_
0680: 44 49 52 54 59 20 20 20 20 20 20 20 20 20 20 20  DIRTY           
0690: 20 20 30 78 30 30 32 20 20 2f 2a 20 50 61 67 65    0x002  /* Page
06a0: 20 68 61 73 20 63 68 61 6e 67 65 64 20 2a 2f 0a   has changed */.
06b0: 23 64 65 66 69 6e 65 20 50 47 48 44 52 5f 4e 45  #define PGHDR_NE
06c0: 45 44 5f 53 59 4e 43 20 20 20 20 20 20 20 20 20  ED_SYNC         
06d0: 30 78 30 30 34 20 20 2f 2a 20 46 73 79 6e 63 20  0x004  /* Fsync 
06e0: 74 68 65 20 72 6f 6c 6c 62 61 63 6b 20 6a 6f 75  the rollback jou
06f0: 72 6e 61 6c 20 62 65 66 6f 72 65 0a 20 20 20 20  rnal before.    
0700: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0710: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0720: 20 20 20 2a 2a 20 77 72 69 74 69 6e 67 20 74 68     ** writing th
0730: 69 73 20 70 61 67 65 20 74 6f 20 74 68 65 20 64  is page to the d
0740: 61 74 61 62 61 73 65 20 2a 2f 0a 23 64 65 66 69  atabase */.#defi
0750: 6e 65 20 50 47 48 44 52 5f 4e 45 45 44 5f 52 45  ne PGHDR_NEED_RE
0760: 41 44 20 20 20 20 20 20 20 20 20 30 78 30 30 38  AD         0x008
0770: 20 20 2f 2a 20 43 6f 6e 74 65 6e 74 20 69 73 20    /* Content is 
0780: 75 6e 72 65 61 64 20 2a 2f 0a 23 64 65 66 69 6e  unread */.#defin
0790: 65 20 50 47 48 44 52 5f 52 45 55 53 45 5f 55 4e  e PGHDR_REUSE_UN
07a0: 4c 49 4b 45 4c 59 20 20 20 20 30 78 30 31 30 20  LIKELY    0x010 
07b0: 20 2f 2a 20 41 20 68 69 6e 74 20 74 68 61 74 20   /* A hint that 
07c0: 72 65 75 73 65 20 69 73 20 75 6e 6c 69 6b 65 6c  reuse is unlikel
07d0: 79 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 47 48  y */.#define PGH
07e0: 44 52 5f 44 4f 4e 54 5f 57 52 49 54 45 20 20 20  DR_DONT_WRITE   
07f0: 20 20 20 20 20 30 78 30 32 30 20 20 2f 2a 20 44       0x020  /* D
0800: 6f 20 6e 6f 74 20 77 72 69 74 65 20 63 6f 6e 74  o not write cont
0810: 65 6e 74 20 74 6f 20 64 69 73 6b 20 2a 2f 0a 0a  ent to disk */..
0820: 2f 2a 20 49 6e 69 74 69 61 6c 69 7a 65 20 61 6e  /* Initialize an
0830: 64 20 73 68 75 74 64 6f 77 6e 20 74 68 65 20 70  d shutdown the p
0840: 61 67 65 20 63 61 63 68 65 20 73 75 62 73 79 73  age cache subsys
0850: 74 65 6d 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  tem */.int sqlit
0860: 65 33 50 63 61 63 68 65 49 6e 69 74 69 61 6c 69  e3PcacheInitiali
0870: 7a 65 28 76 6f 69 64 29 3b 0a 76 6f 69 64 20 73  ze(void);.void s
0880: 71 6c 69 74 65 33 50 63 61 63 68 65 53 68 75 74  qlite3PcacheShut
0890: 64 6f 77 6e 28 76 6f 69 64 29 3b 0a 0a 2f 2a 20  down(void);../* 
08a0: 50 61 67 65 20 63 61 63 68 65 20 62 75 66 66 65  Page cache buffe
08b0: 72 20 6d 61 6e 61 67 65 6d 65 6e 74 3a 0a 2a 2a  r management:.**
08c0: 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20   These routines 
08d0: 69 6d 70 6c 65 6d 65 6e 74 20 53 51 4c 49 54 45  implement SQLITE
08e0: 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43 41 43 48  _CONFIG_PAGECACH
08f0: 45 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74  E..*/.void sqlit
0900: 65 33 50 43 61 63 68 65 42 75 66 66 65 72 53 65  e3PCacheBufferSe
0910: 74 75 70 28 76 6f 69 64 20 2a 2c 20 69 6e 74 20  tup(void *, int 
0920: 73 7a 2c 20 69 6e 74 20 6e 29 3b 0a 0a 2f 2a 20  sz, int n);../* 
0930: 43 72 65 61 74 65 20 61 20 6e 65 77 20 70 61 67  Create a new pag
0940: 65 72 20 63 61 63 68 65 2e 0a 2a 2a 20 55 6e 64  er cache..** Und
0950: 65 72 20 6d 65 6d 6f 72 79 20 73 74 72 65 73 73  er memory stress
0960: 2c 20 69 6e 76 6f 6b 65 20 78 53 74 72 65 73 73  , invoke xStress
0970: 20 74 6f 20 74 72 79 20 74 6f 20 6d 61 6b 65 20   to try to make 
0980: 70 61 67 65 73 20 63 6c 65 61 6e 2e 0a 2a 2a 20  pages clean..** 
0990: 4f 6e 6c 79 20 63 6c 65 61 6e 20 61 6e 64 20 75  Only clean and u
09a0: 6e 70 69 6e 6e 65 64 20 70 61 67 65 73 20 63 61  npinned pages ca
09b0: 6e 20 62 65 20 72 65 63 6c 61 69 6d 65 64 2e 0a  n be reclaimed..
09c0: 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50  */.void sqlite3P
09d0: 63 61 63 68 65 4f 70 65 6e 28 0a 20 20 69 6e 74  cacheOpen(.  int
09e0: 20 73 7a 50 61 67 65 2c 20 20 20 20 20 20 20 20   szPage,        
09f0: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 53              /* S
0a00: 69 7a 65 20 6f 66 20 65 76 65 72 79 20 70 61 67  ize of every pag
0a10: 65 20 2a 2f 0a 20 20 69 6e 74 20 73 7a 45 78 74  e */.  int szExt
0a20: 72 61 2c 20 20 20 20 20 20 20 20 20 20 20 20 20  ra,             
0a30: 20 20 20 20 20 20 2f 2a 20 45 78 74 72 61 20 73        /* Extra s
0a40: 70 61 63 65 20 61 73 73 6f 63 69 61 74 65 64 20  pace associated 
0a50: 77 69 74 68 20 65 61 63 68 20 70 61 67 65 20 2a  with each page *
0a60: 2f 0a 20 20 69 6e 74 20 62 50 75 72 67 65 61 62  /.  int bPurgeab
0a70: 6c 65 2c 20 20 20 20 20 20 20 20 20 20 20 20 20  le,             
0a80: 20 20 20 2f 2a 20 54 72 75 65 20 69 66 20 70 61     /* True if pa
0a90: 67 65 73 20 61 72 65 20 6f 6e 20 62 61 63 6b 69  ges are on backi
0aa0: 6e 67 20 73 74 6f 72 65 20 2a 2f 0a 20 20 69 6e  ng store */.  in
0ab0: 74 20 28 2a 78 53 74 72 65 73 73 29 28 76 6f 69  t (*xStress)(voi
0ac0: 64 2a 2c 20 50 67 48 64 72 2a 29 2c 20 2f 2a 20  d*, PgHdr*), /* 
0ad0: 43 61 6c 6c 20 74 6f 20 74 72 79 20 74 6f 20 6d  Call to try to m
0ae0: 61 6b 65 20 70 61 67 65 73 20 63 6c 65 61 6e 20  ake pages clean 
0af0: 2a 2f 0a 20 20 76 6f 69 64 20 2a 70 53 74 72 65  */.  void *pStre
0b00: 73 73 2c 20 20 20 20 20 20 20 20 20 20 20 20 20  ss,             
0b10: 20 20 20 20 2f 2a 20 41 72 67 75 6d 65 6e 74 20      /* Argument 
0b20: 74 6f 20 78 53 74 72 65 73 73 20 2a 2f 0a 20 20  to xStress */.  
0b30: 50 43 61 63 68 65 20 2a 70 54 6f 49 6e 69 74 20  PCache *pToInit 
0b40: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
0b50: 2a 20 50 72 65 61 6c 6c 6f 63 61 74 65 64 20 73  * Preallocated s
0b60: 70 61 63 65 20 66 6f 72 20 74 68 65 20 50 43 61  pace for the PCa
0b70: 63 68 65 20 2a 2f 0a 29 3b 0a 0a 2f 2a 20 4d 6f  che */.);../* Mo
0b80: 64 69 66 79 20 74 68 65 20 70 61 67 65 2d 73 69  dify the page-si
0b90: 7a 65 20 61 66 74 65 72 20 74 68 65 20 63 61 63  ze after the cac
0ba0: 68 65 20 68 61 73 20 62 65 65 6e 20 63 72 65 61  he has been crea
0bb0: 74 65 64 2e 20 2a 2f 0a 76 6f 69 64 20 73 71 6c  ted. */.void sql
0bc0: 69 74 65 33 50 63 61 63 68 65 53 65 74 50 61 67  ite3PcacheSetPag
0bd0: 65 53 69 7a 65 28 50 43 61 63 68 65 20 2a 2c 20  eSize(PCache *, 
0be0: 69 6e 74 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e  int);../* Return
0bf0: 20 74 68 65 20 73 69 7a 65 20 69 6e 20 62 79 74   the size in byt
0c00: 65 73 20 6f 66 20 61 20 50 43 61 63 68 65 20 6f  es of a PCache o
0c10: 62 6a 65 63 74 2e 20 20 55 73 65 64 20 74 6f 20  bject.  Used to 
0c20: 70 72 65 61 6c 6c 6f 63 61 74 65 0a 2a 2a 20 73  preallocate.** s
0c30: 74 6f 72 61 67 65 20 73 70 61 63 65 2e 0a 2a 2f  torage space..*/
0c40: 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63  .int sqlite3Pcac
0c50: 68 65 53 69 7a 65 28 76 6f 69 64 29 3b 0a 0a 2f  heSize(void);../
0c60: 2a 20 4f 6e 65 20 72 65 6c 65 61 73 65 20 70 65  * One release pe
0c70: 72 20 73 75 63 63 65 73 73 66 75 6c 20 66 65 74  r successful fet
0c80: 63 68 2e 20 20 50 61 67 65 20 69 73 20 70 69 6e  ch.  Page is pin
0c90: 6e 65 64 20 75 6e 74 69 6c 20 72 65 6c 65 61 73  ned until releas
0ca0: 65 64 2e 0a 2a 2a 20 52 65 66 65 72 65 6e 63 65  ed..** Reference
0cb0: 20 63 6f 75 6e 74 65 64 2e 20 0a 2a 2f 0a 69 6e   counted. .*/.in
0cc0: 74 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 46  t sqlite3PcacheF
0cd0: 65 74 63 68 28 50 43 61 63 68 65 2a 2c 20 50 67  etch(PCache*, Pg
0ce0: 6e 6f 2c 20 69 6e 74 20 63 72 65 61 74 65 46 6c  no, int createFl
0cf0: 61 67 2c 20 50 67 48 64 72 2a 2a 29 3b 0a 76 6f  ag, PgHdr**);.vo
0d00: 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  id sqlite3Pcache
0d10: 52 65 6c 65 61 73 65 28 50 67 48 64 72 2a 29 3b  Release(PgHdr*);
0d20: 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  ..void sqlite3Pc
0d30: 61 63 68 65 44 72 6f 70 28 50 67 48 64 72 2a 29  acheDrop(PgHdr*)
0d40: 3b 20 20 20 20 20 20 20 20 20 2f 2a 20 52 65 6d  ;         /* Rem
0d50: 6f 76 65 20 70 61 67 65 20 66 72 6f 6d 20 63 61  ove page from ca
0d60: 63 68 65 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69  che */.void sqli
0d70: 74 65 33 50 63 61 63 68 65 4d 61 6b 65 44 69 72  te3PcacheMakeDir
0d80: 74 79 28 50 67 48 64 72 2a 29 3b 20 20 20 20 2f  ty(PgHdr*);    /
0d90: 2a 20 4d 61 6b 65 20 73 75 72 65 20 70 61 67 65  * Make sure page
0da0: 20 69 73 20 6d 61 72 6b 65 64 20 64 69 72 74 79   is marked dirty
0db0: 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33   */.void sqlite3
0dc0: 50 63 61 63 68 65 4d 61 6b 65 43 6c 65 61 6e 28  PcacheMakeClean(
0dd0: 50 67 48 64 72 2a 29 3b 20 20 20 20 2f 2a 20 4d  PgHdr*);    /* M
0de0: 61 72 6b 20 61 20 73 69 6e 67 6c 65 20 70 61 67  ark a single pag
0df0: 65 20 61 73 20 63 6c 65 61 6e 20 2a 2f 0a 76 6f  e as clean */.vo
0e00: 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  id sqlite3Pcache
0e10: 43 6c 65 61 6e 41 6c 6c 28 50 43 61 63 68 65 2a  CleanAll(PCache*
0e20: 29 3b 20 20 20 20 2f 2a 20 4d 61 72 6b 20 61 6c  );    /* Mark al
0e30: 6c 20 64 69 72 74 79 20 6c 69 73 74 20 70 61 67  l dirty list pag
0e40: 65 73 20 61 73 20 63 6c 65 61 6e 20 2a 2f 0a 0a  es as clean */..
0e50: 2f 2a 20 43 68 61 6e 67 65 20 61 20 70 61 67 65  /* Change a page
0e60: 20 6e 75 6d 62 65 72 2e 20 20 55 73 65 64 20 62   number.  Used b
0e70: 79 20 69 6e 63 72 2d 76 61 63 75 75 6d 2e 20 2a  y incr-vacuum. *
0e80: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  /.void sqlite3Pc
0e90: 61 63 68 65 4d 6f 76 65 28 50 67 48 64 72 2a 2c  acheMove(PgHdr*,
0ea0: 20 50 67 6e 6f 29 3b 0a 0a 2f 2a 20 52 65 6d 6f   Pgno);../* Remo
0eb0: 76 65 20 61 6c 6c 20 70 61 67 65 73 20 77 69 74  ve all pages wit
0ec0: 68 20 70 67 6e 6f 3e 78 2e 20 20 52 65 73 65 74  h pgno>x.  Reset
0ed0: 20 74 68 65 20 63 61 63 68 65 20 69 66 20 78 3d   the cache if x=
0ee0: 3d 30 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74  =0 */.void sqlit
0ef0: 65 33 50 63 61 63 68 65 54 72 75 6e 63 61 74 65  e3PcacheTruncate
0f00: 28 50 43 61 63 68 65 2a 2c 20 50 67 6e 6f 20 78  (PCache*, Pgno x
0f10: 29 3b 0a 0a 2f 2a 20 47 65 74 20 61 20 6c 69 73  );../* Get a lis
0f20: 74 20 6f 66 20 61 6c 6c 20 64 69 72 74 79 20 70  t of all dirty p
0f30: 61 67 65 73 20 69 6e 20 74 68 65 20 63 61 63 68  ages in the cach
0f40: 65 2c 20 73 6f 72 74 65 64 20 62 79 20 70 61 67  e, sorted by pag
0f50: 65 20 6e 75 6d 62 65 72 20 2a 2f 0a 50 67 48 64  e number */.PgHd
0f60: 72 20 2a 73 71 6c 69 74 65 33 50 63 61 63 68 65  r *sqlite3Pcache
0f70: 44 69 72 74 79 4c 69 73 74 28 50 43 61 63 68 65  DirtyList(PCache
0f80: 2a 29 3b 0a 0a 2f 2a 20 52 65 73 65 74 20 61 6e  *);../* Reset an
0f90: 64 20 63 6c 6f 73 65 20 74 68 65 20 63 61 63 68  d close the cach
0fa0: 65 20 6f 62 6a 65 63 74 20 2a 2f 0a 76 6f 69 64  e object */.void
0fb0: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 43 6c   sqlite3PcacheCl
0fc0: 6f 73 65 28 50 43 61 63 68 65 2a 29 3b 0a 0a 2f  ose(PCache*);../
0fd0: 2a 20 43 6c 65 61 72 20 66 6c 61 67 73 20 66 72  * Clear flags fr
0fe0: 6f 6d 20 70 61 67 65 73 20 6f 66 20 74 68 65 20  om pages of the 
0ff0: 70 61 67 65 20 63 61 63 68 65 20 2a 2f 0a 76 6f  page cache */.vo
1000: 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  id sqlite3Pcache
1010: 43 6c 65 61 72 53 79 6e 63 46 6c 61 67 73 28 50  ClearSyncFlags(P
1020: 43 61 63 68 65 20 2a 29 3b 0a 0a 2f 2a 20 44 69  Cache *);../* Di
1030: 73 63 61 72 64 20 74 68 65 20 63 6f 6e 74 65 6e  scard the conten
1040: 74 73 20 6f 66 20 74 68 65 20 63 61 63 68 65 20  ts of the cache 
1050: 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50  */.void sqlite3P
1060: 63 61 63 68 65 43 6c 65 61 72 28 50 43 61 63 68  cacheClear(PCach
1070: 65 2a 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20  e*);../* Return 
1080: 74 68 65 20 74 6f 74 61 6c 20 6e 75 6d 62 65 72  the total number
1090: 20 6f 66 20 6f 75 74 73 74 61 6e 64 69 6e 67 20   of outstanding 
10a0: 70 61 67 65 20 72 65 66 65 72 65 6e 63 65 73 20  page references 
10b0: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63  */.int sqlite3Pc
10c0: 61 63 68 65 52 65 66 43 6f 75 6e 74 28 50 43 61  acheRefCount(PCa
10d0: 63 68 65 2a 29 3b 0a 0a 2f 2a 20 49 6e 63 72 65  che*);../* Incre
10e0: 6d 65 6e 74 20 74 68 65 20 72 65 66 65 72 65 6e  ment the referen
10f0: 63 65 20 63 6f 75 6e 74 20 6f 66 20 61 6e 20 65  ce count of an e
1100: 78 69 73 74 69 6e 67 20 70 61 67 65 20 2a 2f 0a  xisting page */.
1110: 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63  void sqlite3Pcac
1120: 68 65 52 65 66 28 50 67 48 64 72 2a 29 3b 0a 0a  heRef(PgHdr*);..
1130: 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63 68  int sqlite3Pcach
1140: 65 50 61 67 65 52 65 66 63 6f 75 6e 74 28 50 67  ePageRefcount(Pg
1150: 48 64 72 2a 29 3b 0a 0a 2f 2a 20 52 65 74 75 72  Hdr*);../* Retur
1160: 6e 20 74 68 65 20 74 6f 74 61 6c 20 6e 75 6d 62  n the total numb
1170: 65 72 20 6f 66 20 70 61 67 65 73 20 73 74 6f 72  er of pages stor
1180: 65 64 20 69 6e 20 74 68 65 20 63 61 63 68 65 20  ed in the cache 
1190: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63  */.int sqlite3Pc
11a0: 61 63 68 65 50 61 67 65 63 6f 75 6e 74 28 50 43  achePagecount(PC
11b0: 61 63 68 65 2a 29 3b 0a 0a 23 69 66 20 64 65 66  ache*);..#if def
11c0: 69 6e 65 64 28 53 51 4c 49 54 45 5f 43 48 45 43  ined(SQLITE_CHEC
11d0: 4b 5f 50 41 47 45 53 29 20 7c 7c 20 64 65 66 69  K_PAGES) || defi
11e0: 6e 65 64 28 53 51 4c 49 54 45 5f 44 45 42 55 47  ned(SQLITE_DEBUG
11f0: 29 0a 2f 2a 20 49 74 65 72 61 74 65 20 74 68 72  )./* Iterate thr
1200: 6f 75 67 68 20 61 6c 6c 20 64 69 72 74 79 20 70  ough all dirty p
1210: 61 67 65 73 20 63 75 72 72 65 6e 74 6c 79 20 73  ages currently s
1220: 74 6f 72 65 64 20 69 6e 20 74 68 65 20 63 61 63  tored in the cac
1230: 68 65 2e 20 54 68 69 73 0a 2a 2a 20 69 6e 74 65  he. This.** inte
1240: 72 66 61 63 65 20 69 73 20 6f 6e 6c 79 20 61 76  rface is only av
1250: 61 69 6c 61 62 6c 65 20 69 66 20 53 51 4c 49 54  ailable if SQLIT
1260: 45 5f 43 48 45 43 4b 5f 50 41 47 45 53 20 69 73  E_CHECK_PAGES is
1270: 20 64 65 66 69 6e 65 64 20 77 68 65 6e 20 74 68   defined when th
1280: 65 20 0a 2a 2a 20 6c 69 62 72 61 72 79 20 69 73  e .** library is
1290: 20 62 75 69 6c 74 2e 0a 2a 2f 0a 76 6f 69 64 20   built..*/.void 
12a0: 73 71 6c 69 74 65 33 50 63 61 63 68 65 49 74 65  sqlite3PcacheIte
12b0: 72 61 74 65 44 69 72 74 79 28 50 43 61 63 68 65  rateDirty(PCache
12c0: 20 2a 70 43 61 63 68 65 2c 20 76 6f 69 64 20 28   *pCache, void (
12d0: 2a 78 49 74 65 72 29 28 50 67 48 64 72 20 2a 29  *xIter)(PgHdr *)
12e0: 29 3b 0a 23 65 6e 64 69 66 0a 0a 2f 2a 20 53 65  );.#endif../* Se
12f0: 74 20 61 6e 64 20 67 65 74 20 74 68 65 20 73 75  t and get the su
1300: 67 67 65 73 74 65 64 20 63 61 63 68 65 2d 73 69  ggested cache-si
1310: 7a 65 20 66 6f 72 20 74 68 65 20 73 70 65 63 69  ze for the speci
1320: 66 69 65 64 20 70 61 67 65 72 2d 63 61 63 68 65  fied pager-cache
1330: 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 6e 6f 20 67 6c  ..**.** If no gl
1340: 6f 62 61 6c 20 6d 61 78 69 6d 75 6d 20 69 73 20  obal maximum is 
1350: 63 6f 6e 66 69 67 75 72 65 64 2c 20 74 68 65 6e  configured, then
1360: 20 74 68 65 20 73 79 73 74 65 6d 20 61 74 74 65   the system atte
1370: 6d 70 74 73 20 74 6f 20 6c 69 6d 69 74 0a 2a 2a  mpts to limit.**
1380: 20 74 68 65 20 74 6f 74 61 6c 20 6e 75 6d 62 65   the total numbe
1390: 72 20 6f 66 20 70 61 67 65 73 20 63 61 63 68 65  r of pages cache
13a0: 64 20 62 79 20 70 75 72 67 65 61 62 6c 65 20 70  d by purgeable p
13b0: 61 67 65 72 2d 63 61 63 68 65 73 20 74 6f 20 74  ager-caches to t
13c0: 68 65 20 73 75 6d 0a 2a 2a 20 6f 66 20 74 68 65  he sum.** of the
13d0: 20 73 75 67 67 65 73 74 65 64 20 63 61 63 68 65   suggested cache
13e0: 2d 73 69 7a 65 73 2e 0a 2a 2f 0a 76 6f 69 64 20  -sizes..*/.void 
13f0: 73 71 6c 69 74 65 33 50 63 61 63 68 65 53 65 74  sqlite3PcacheSet
1400: 43 61 63 68 65 73 69 7a 65 28 50 43 61 63 68 65  Cachesize(PCache
1410: 20 2a 2c 20 69 6e 74 29 3b 0a 23 69 66 64 65 66   *, int);.#ifdef
1420: 20 53 51 4c 49 54 45 5f 54 45 53 54 0a 69 6e 74   SQLITE_TEST.int
1430: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 47 65   sqlite3PcacheGe
1440: 74 43 61 63 68 65 73 69 7a 65 28 50 43 61 63 68  tCachesize(PCach
1450: 65 20 2a 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 69  e *);.#endif..#i
1460: 66 64 65 66 20 53 51 4c 49 54 45 5f 45 4e 41 42  fdef SQLITE_ENAB
1470: 4c 45 5f 4d 45 4d 4f 52 59 5f 4d 41 4e 41 47 45  LE_MEMORY_MANAGE
1480: 4d 45 4e 54 0a 2f 2a 20 54 72 79 20 74 6f 20 72  MENT./* Try to r
1490: 65 74 75 72 6e 20 6d 65 6d 6f 72 79 20 75 73 65  eturn memory use
14a0: 64 20 62 79 20 74 68 65 20 70 63 61 63 68 65 20  d by the pcache 
14b0: 6d 6f 64 75 6c 65 20 74 6f 20 74 68 65 20 6d 61  module to the ma
14c0: 69 6e 20 6d 65 6d 6f 72 79 20 68 65 61 70 20 2a  in memory heap *
14d0: 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61  /.int sqlite3Pca
14e0: 63 68 65 52 65 6c 65 61 73 65 4d 65 6d 6f 72 79  cheReleaseMemory
14f0: 28 69 6e 74 29 3b 0a 23 65 6e 64 69 66 0a 0a 23  (int);.#endif..#
1500: 69 66 64 65 66 20 53 51 4c 49 54 45 5f 54 45 53  ifdef SQLITE_TES
1510: 54 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  T.void sqlite3Pc
1520: 61 63 68 65 53 74 61 74 73 28 69 6e 74 2a 2c 69  acheStats(int*,i
1530: 6e 74 2a 2c 69 6e 74 2a 2c 69 6e 74 2a 29 3b 0a  nt*,int*,int*);.
1540: 23 65 6e 64 69 66 0a 0a 76 6f 69 64 20 73 71 6c  #endif..void sql
1550: 69 74 65 33 50 43 61 63 68 65 53 65 74 44 65 66  ite3PCacheSetDef
1560: 61 75 6c 74 28 76 6f 69 64 29 3b 0a 0a 23 65 6e  ault(void);..#en
1570: 64 69 66 20 2f 2a 20 5f 50 43 41 43 48 45 5f 48  dif /* _PCACHE_H
1580: 5f 20 2a 2f 0a                                   _ */.