/ Hex Artifact Content
Login

Artifact a56b8998f5bf71c31c3d7bcfe0149880a21c442a:


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 2a 0a 2a 2a 20 40 28  ystem. .**.** @(
01d0: 23 29 20 24 49 64 3a 20 70 63 61 63 68 65 2e 68  #) $Id: pcache.h
01e0: 2c 76 20 31 2e 31 37 20 32 30 30 39 2f 30 31 2f  ,v 1.17 2009/01/
01f0: 31 36 20 31 35 3a 32 31 3a 30 36 20 64 61 6e 69  16 15:21:06 dani
0200: 65 6c 6b 31 39 37 37 20 45 78 70 20 24 0a 2a 2f  elk1977 Exp $.*/
0210: 0a 0a 23 69 66 6e 64 65 66 20 5f 50 43 41 43 48  ..#ifndef _PCACH
0220: 45 5f 48 5f 0a 0a 74 79 70 65 64 65 66 20 73 74  E_H_..typedef st
0230: 72 75 63 74 20 50 67 48 64 72 20 50 67 48 64 72  ruct PgHdr PgHdr
0240: 3b 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74  ;.typedef struct
0250: 20 50 43 61 63 68 65 20 50 43 61 63 68 65 3b 0a   PCache PCache;.
0260: 0a 2f 2a 0a 2a 2a 20 45 76 65 72 79 20 70 61 67  ./*.** Every pag
0270: 65 20 69 6e 20 74 68 65 20 63 61 63 68 65 20 69  e in the cache i
0280: 73 20 63 6f 6e 74 72 6f 6c 6c 65 64 20 62 79 20  s controlled by 
0290: 61 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 20 74  an instance of t
02a0: 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 0a 2a 2a 20  he following.** 
02b0: 73 74 72 75 63 74 75 72 65 2e 0a 2a 2f 0a 73 74  structure..*/.st
02c0: 72 75 63 74 20 50 67 48 64 72 20 7b 0a 20 20 76  ruct PgHdr {.  v
02d0: 6f 69 64 20 2a 70 44 61 74 61 3b 20 20 20 20 20  oid *pData;     
02e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a                /*
02f0: 20 43 6f 6e 74 65 6e 74 20 6f 66 20 74 68 69 73   Content of this
0300: 20 70 61 67 65 20 2a 2f 0a 20 20 76 6f 69 64 20   page */.  void 
0310: 2a 70 45 78 74 72 61 3b 20 20 20 20 20 20 20 20  *pExtra;        
0320: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 45 78 74            /* Ext
0330: 72 61 20 63 6f 6e 74 65 6e 74 20 2a 2f 0a 20 20  ra content */.  
0340: 50 67 48 64 72 20 2a 70 44 69 72 74 79 3b 20 20  PgHdr *pDirty;  
0350: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
0360: 2a 20 54 72 61 6e 73 69 65 6e 74 20 6c 69 73 74  * Transient list
0370: 20 6f 66 20 64 69 72 74 79 20 70 61 67 65 73 20   of dirty pages 
0380: 2a 2f 0a 20 20 50 67 6e 6f 20 70 67 6e 6f 3b 20  */.  Pgno pgno; 
0390: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
03a0: 20 20 20 20 2f 2a 20 50 61 67 65 20 6e 75 6d 62      /* Page numb
03b0: 65 72 20 66 6f 72 20 74 68 69 73 20 70 61 67 65  er for this page
03c0: 20 2a 2f 0a 20 20 50 61 67 65 72 20 2a 70 50 61   */.  Pager *pPa
03d0: 67 65 72 3b 20 20 20 20 20 20 20 20 20 20 20 20  ger;            
03e0: 20 20 20 20 20 2f 2a 20 54 68 65 20 70 61 67 65       /* The page
03f0: 72 20 74 68 69 73 20 70 61 67 65 20 69 73 20 70  r this page is p
0400: 61 72 74 20 6f 66 20 2a 2f 0a 23 69 66 64 65 66  art of */.#ifdef
0410: 20 53 51 4c 49 54 45 5f 43 48 45 43 4b 5f 50 41   SQLITE_CHECK_PA
0420: 47 45 53 0a 20 20 75 33 32 20 70 61 67 65 48 61  GES.  u32 pageHa
0430: 73 68 3b 20 20 20 20 20 20 20 20 20 20 20 20 20  sh;             
0440: 20 20 20 20 20 2f 2a 20 48 61 73 68 20 6f 66 20       /* Hash of 
0450: 70 61 67 65 20 63 6f 6e 74 65 6e 74 20 2a 2f 0a  page content */.
0460: 23 65 6e 64 69 66 0a 20 20 75 31 36 20 66 6c 61  #endif.  u16 fla
0470: 67 73 3b 20 20 20 20 20 20 20 20 20 20 20 20 20  gs;             
0480: 20 20 20 20 20 20 20 20 2f 2a 20 50 47 48 44 52          /* PGHDR
0490: 20 66 6c 61 67 73 20 64 65 66 69 6e 65 64 20 62   flags defined b
04a0: 65 6c 6f 77 20 2a 2f 0a 0a 20 20 2f 2a 2a 2a 2a  elow */..  /****
04b0: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
04c0: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
04d0: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
04e0: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
04f0: 2a 2a 0a 20 20 2a 2a 20 45 6c 65 6d 65 6e 74 73  **.  ** Elements
0500: 20 61 62 6f 76 65 20 61 72 65 20 70 75 62 6c 69   above are publi
0510: 63 2e 20 20 41 6c 6c 20 74 68 61 74 20 66 6f 6c  c.  All that fol
0520: 6c 6f 77 73 20 69 73 20 70 72 69 76 61 74 65 20  lows is private 
0530: 74 6f 20 70 63 61 63 68 65 2e 63 0a 20 20 2a 2a  to pcache.c.  **
0540: 20 61 6e 64 20 73 68 6f 75 6c 64 20 6e 6f 74 20   and should not 
0550: 62 65 20 61 63 63 65 73 73 65 64 20 62 79 20 6f  be accessed by o
0560: 74 68 65 72 20 6d 6f 64 75 6c 65 73 2e 0a 20 20  ther modules..  
0570: 2a 2f 0a 20 20 69 31 36 20 6e 52 65 66 3b 20 20  */.  i16 nRef;  
0580: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0590: 20 20 20 20 2f 2a 20 4e 75 6d 62 65 72 20 6f 66      /* Number of
05a0: 20 75 73 65 72 73 20 6f 66 20 74 68 69 73 20 70   users of this p
05b0: 61 67 65 20 2a 2f 0a 20 20 50 43 61 63 68 65 20  age */.  PCache 
05c0: 2a 70 43 61 63 68 65 3b 20 20 20 20 20 20 20 20  *pCache;        
05d0: 20 20 20 20 20 20 20 20 2f 2a 20 43 61 63 68 65          /* Cache
05e0: 20 74 68 61 74 20 6f 77 6e 73 20 74 68 69 73 20   that owns this 
05f0: 70 61 67 65 20 2a 2f 0a 0a 20 20 50 67 48 64 72  page */..  PgHdr
0600: 20 2a 70 44 69 72 74 79 4e 65 78 74 3b 20 20 20   *pDirtyNext;   
0610: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4e 65 78            /* Nex
0620: 74 20 65 6c 65 6d 65 6e 74 20 69 6e 20 6c 69 73  t element in lis
0630: 74 20 6f 66 20 64 69 72 74 79 20 70 61 67 65 73  t of dirty pages
0640: 20 2a 2f 0a 20 20 50 67 48 64 72 20 2a 70 44 69   */.  PgHdr *pDi
0650: 72 74 79 50 72 65 76 3b 20 20 20 20 20 20 20 20  rtyPrev;        
0660: 20 20 20 20 20 2f 2a 20 50 72 65 76 69 6f 75 73       /* Previous
0670: 20 65 6c 65 6d 65 6e 74 20 69 6e 20 6c 69 73 74   element in list
0680: 20 6f 66 20 64 69 72 74 79 20 70 61 67 65 73 20   of dirty pages 
0690: 2a 2f 0a 7d 3b 0a 0a 2f 2a 20 42 69 74 20 76 61  */.};../* Bit va
06a0: 6c 75 65 73 20 66 6f 72 20 50 67 48 64 72 2e 66  lues for PgHdr.f
06b0: 6c 61 67 73 20 2a 2f 0a 23 64 65 66 69 6e 65 20  lags */.#define 
06c0: 50 47 48 44 52 5f 44 49 52 54 59 20 20 20 20 20  PGHDR_DIRTY     
06d0: 20 20 20 20 20 20 20 20 30 78 30 30 32 20 20 2f          0x002  /
06e0: 2a 20 50 61 67 65 20 68 61 73 20 63 68 61 6e 67  * Page has chang
06f0: 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 47  ed */.#define PG
0700: 48 44 52 5f 4e 45 45 44 5f 53 59 4e 43 20 20 20  HDR_NEED_SYNC   
0710: 20 20 20 20 20 20 30 78 30 30 34 20 20 2f 2a 20        0x004  /* 
0720: 46 73 79 6e 63 20 74 68 65 20 72 6f 6c 6c 62 61  Fsync the rollba
0730: 63 6b 20 6a 6f 75 72 6e 61 6c 20 62 65 66 6f 72  ck journal befor
0740: 65 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 20  e.              
0750: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0760: 20 20 20 20 20 20 20 20 20 2a 2a 20 77 72 69 74           ** writ
0770: 69 6e 67 20 74 68 69 73 20 70 61 67 65 20 74 6f  ing this page to
0780: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 2a 2f   the database */
0790: 0a 23 64 65 66 69 6e 65 20 50 47 48 44 52 5f 4e  .#define PGHDR_N
07a0: 45 45 44 5f 52 45 41 44 20 20 20 20 20 20 20 20  EED_READ        
07b0: 20 30 78 30 30 38 20 20 2f 2a 20 43 6f 6e 74 65   0x008  /* Conte
07c0: 6e 74 20 69 73 20 75 6e 72 65 61 64 20 2a 2f 0a  nt is unread */.
07d0: 23 64 65 66 69 6e 65 20 50 47 48 44 52 5f 52 45  #define PGHDR_RE
07e0: 55 53 45 5f 55 4e 4c 49 4b 45 4c 59 20 20 20 20  USE_UNLIKELY    
07f0: 30 78 30 31 30 20 20 2f 2a 20 41 20 68 69 6e 74  0x010  /* A hint
0800: 20 74 68 61 74 20 72 65 75 73 65 20 69 73 20 75   that reuse is u
0810: 6e 6c 69 6b 65 6c 79 20 2a 2f 0a 23 64 65 66 69  nlikely */.#defi
0820: 6e 65 20 50 47 48 44 52 5f 44 4f 4e 54 5f 57 52  ne PGHDR_DONT_WR
0830: 49 54 45 20 20 20 20 20 20 20 20 30 78 30 32 30  ITE        0x020
0840: 20 20 2f 2a 20 44 6f 20 6e 6f 74 20 77 72 69 74    /* Do not writ
0850: 65 20 63 6f 6e 74 65 6e 74 20 74 6f 20 64 69 73  e content to dis
0860: 6b 20 2a 2f 0a 0a 2f 2a 20 49 6e 69 74 69 61 6c  k */../* Initial
0870: 69 7a 65 20 61 6e 64 20 73 68 75 74 64 6f 77 6e  ize and shutdown
0880: 20 74 68 65 20 70 61 67 65 20 63 61 63 68 65 20   the page cache 
0890: 73 75 62 73 79 73 74 65 6d 20 2a 2f 0a 69 6e 74  subsystem */.int
08a0: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 49 6e   sqlite3PcacheIn
08b0: 69 74 69 61 6c 69 7a 65 28 76 6f 69 64 29 3b 0a  itialize(void);.
08c0: 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63  void sqlite3Pcac
08d0: 68 65 53 68 75 74 64 6f 77 6e 28 76 6f 69 64 29  heShutdown(void)
08e0: 3b 0a 0a 2f 2a 20 50 61 67 65 20 63 61 63 68 65  ;../* Page cache
08f0: 20 62 75 66 66 65 72 20 6d 61 6e 61 67 65 6d 65   buffer manageme
0900: 6e 74 3a 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75  nt:.** These rou
0910: 74 69 6e 65 73 20 69 6d 70 6c 65 6d 65 6e 74 20  tines implement 
0920: 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 41  SQLITE_CONFIG_PA
0930: 47 45 43 41 43 48 45 2e 0a 2a 2f 0a 76 6f 69 64  GECACHE..*/.void
0940: 20 73 71 6c 69 74 65 33 50 43 61 63 68 65 42 75   sqlite3PCacheBu
0950: 66 66 65 72 53 65 74 75 70 28 76 6f 69 64 20 2a  fferSetup(void *
0960: 2c 20 69 6e 74 20 73 7a 2c 20 69 6e 74 20 6e 29  , int sz, int n)
0970: 3b 0a 0a 2f 2a 20 43 72 65 61 74 65 20 61 20 6e  ;../* Create a n
0980: 65 77 20 70 61 67 65 72 20 63 61 63 68 65 2e 0a  ew pager cache..
0990: 2a 2a 20 55 6e 64 65 72 20 6d 65 6d 6f 72 79 20  ** Under memory 
09a0: 73 74 72 65 73 73 2c 20 69 6e 76 6f 6b 65 20 78  stress, invoke x
09b0: 53 74 72 65 73 73 20 74 6f 20 74 72 79 20 74 6f  Stress to try to
09c0: 20 6d 61 6b 65 20 70 61 67 65 73 20 63 6c 65 61   make pages clea
09d0: 6e 2e 0a 2a 2a 20 4f 6e 6c 79 20 63 6c 65 61 6e  n..** Only clean
09e0: 20 61 6e 64 20 75 6e 70 69 6e 6e 65 64 20 70 61   and unpinned pa
09f0: 67 65 73 20 63 61 6e 20 62 65 20 72 65 63 6c 61  ges can be recla
0a00: 69 6d 65 64 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71  imed..*/.void sq
0a10: 6c 69 74 65 33 50 63 61 63 68 65 4f 70 65 6e 28  lite3PcacheOpen(
0a20: 0a 20 20 69 6e 74 20 73 7a 50 61 67 65 2c 20 20  .  int szPage,  
0a30: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0a40: 20 20 2f 2a 20 53 69 7a 65 20 6f 66 20 65 76 65    /* Size of eve
0a50: 72 79 20 70 61 67 65 20 2a 2f 0a 20 20 69 6e 74  ry page */.  int
0a60: 20 73 7a 45 78 74 72 61 2c 20 20 20 20 20 20 20   szExtra,       
0a70: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 45              /* E
0a80: 78 74 72 61 20 73 70 61 63 65 20 61 73 73 6f 63  xtra space assoc
0a90: 69 61 74 65 64 20 77 69 74 68 20 65 61 63 68 20  iated with each 
0aa0: 70 61 67 65 20 2a 2f 0a 20 20 69 6e 74 20 62 50  page */.  int bP
0ab0: 75 72 67 65 61 62 6c 65 2c 20 20 20 20 20 20 20  urgeable,       
0ac0: 20 20 20 20 20 20 20 20 20 2f 2a 20 54 72 75 65           /* True
0ad0: 20 69 66 20 70 61 67 65 73 20 61 72 65 20 6f 6e   if pages are on
0ae0: 20 62 61 63 6b 69 6e 67 20 73 74 6f 72 65 20 2a   backing store *
0af0: 2f 0a 20 20 69 6e 74 20 28 2a 78 53 74 72 65 73  /.  int (*xStres
0b00: 73 29 28 76 6f 69 64 2a 2c 20 50 67 48 64 72 2a  s)(void*, PgHdr*
0b10: 29 2c 20 2f 2a 20 43 61 6c 6c 20 74 6f 20 74 72  ), /* Call to tr
0b20: 79 20 74 6f 20 6d 61 6b 65 20 70 61 67 65 73 20  y to make pages 
0b30: 63 6c 65 61 6e 20 2a 2f 0a 20 20 76 6f 69 64 20  clean */.  void 
0b40: 2a 70 53 74 72 65 73 73 2c 20 20 20 20 20 20 20  *pStress,       
0b50: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 41 72 67            /* Arg
0b60: 75 6d 65 6e 74 20 74 6f 20 78 53 74 72 65 73 73  ument to xStress
0b70: 20 2a 2f 0a 20 20 50 43 61 63 68 65 20 2a 70 54   */.  PCache *pT
0b80: 6f 49 6e 69 74 20 20 20 20 20 20 20 20 20 20 20  oInit           
0b90: 20 20 20 20 20 2f 2a 20 50 72 65 61 6c 6c 6f 63       /* Prealloc
0ba0: 61 74 65 64 20 73 70 61 63 65 20 66 6f 72 20 74  ated space for t
0bb0: 68 65 20 50 43 61 63 68 65 20 2a 2f 0a 29 3b 0a  he PCache */.);.
0bc0: 0a 2f 2a 20 4d 6f 64 69 66 79 20 74 68 65 20 70  ./* Modify the p
0bd0: 61 67 65 2d 73 69 7a 65 20 61 66 74 65 72 20 74  age-size after t
0be0: 68 65 20 63 61 63 68 65 20 68 61 73 20 62 65 65  he cache has bee
0bf0: 6e 20 63 72 65 61 74 65 64 2e 20 2a 2f 0a 76 6f  n created. */.vo
0c00: 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  id sqlite3Pcache
0c10: 53 65 74 50 61 67 65 53 69 7a 65 28 50 43 61 63  SetPageSize(PCac
0c20: 68 65 20 2a 2c 20 69 6e 74 29 3b 0a 0a 2f 2a 20  he *, int);../* 
0c30: 52 65 74 75 72 6e 20 74 68 65 20 73 69 7a 65 20  Return the size 
0c40: 69 6e 20 62 79 74 65 73 20 6f 66 20 61 20 50 43  in bytes of a PC
0c50: 61 63 68 65 20 6f 62 6a 65 63 74 2e 20 20 55 73  ache object.  Us
0c60: 65 64 20 74 6f 20 70 72 65 61 6c 6c 6f 63 61 74  ed to preallocat
0c70: 65 0a 2a 2a 20 73 74 6f 72 61 67 65 20 73 70 61  e.** storage spa
0c80: 63 65 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  ce..*/.int sqlit
0c90: 65 33 50 63 61 63 68 65 53 69 7a 65 28 76 6f 69  e3PcacheSize(voi
0ca0: 64 29 3b 0a 0a 2f 2a 20 4f 6e 65 20 72 65 6c 65  d);../* One rele
0cb0: 61 73 65 20 70 65 72 20 73 75 63 63 65 73 73 66  ase per successf
0cc0: 75 6c 20 66 65 74 63 68 2e 20 20 50 61 67 65 20  ul fetch.  Page 
0cd0: 69 73 20 70 69 6e 6e 65 64 20 75 6e 74 69 6c 20  is pinned until 
0ce0: 72 65 6c 65 61 73 65 64 2e 0a 2a 2a 20 52 65 66  released..** Ref
0cf0: 65 72 65 6e 63 65 20 63 6f 75 6e 74 65 64 2e 20  erence counted. 
0d00: 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50  .*/.int sqlite3P
0d10: 63 61 63 68 65 46 65 74 63 68 28 50 43 61 63 68  cacheFetch(PCach
0d20: 65 2a 2c 20 50 67 6e 6f 2c 20 69 6e 74 20 63 72  e*, Pgno, int cr
0d30: 65 61 74 65 46 6c 61 67 2c 20 50 67 48 64 72 2a  eateFlag, PgHdr*
0d40: 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  *);.void sqlite3
0d50: 50 63 61 63 68 65 52 65 6c 65 61 73 65 28 50 67  PcacheRelease(Pg
0d60: 48 64 72 2a 29 3b 0a 0a 76 6f 69 64 20 73 71 6c  Hdr*);..void sql
0d70: 69 74 65 33 50 63 61 63 68 65 44 72 6f 70 28 50  ite3PcacheDrop(P
0d80: 67 48 64 72 2a 29 3b 20 20 20 20 20 20 20 20 20  gHdr*);         
0d90: 2f 2a 20 52 65 6d 6f 76 65 20 70 61 67 65 20 66  /* Remove page f
0da0: 72 6f 6d 20 63 61 63 68 65 20 2a 2f 0a 76 6f 69  rom cache */.voi
0db0: 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 4d  d sqlite3PcacheM
0dc0: 61 6b 65 44 69 72 74 79 28 50 67 48 64 72 2a 29  akeDirty(PgHdr*)
0dd0: 3b 20 20 20 20 2f 2a 20 4d 61 6b 65 20 73 75 72  ;    /* Make sur
0de0: 65 20 70 61 67 65 20 69 73 20 6d 61 72 6b 65 64  e page is marked
0df0: 20 64 69 72 74 79 20 2a 2f 0a 76 6f 69 64 20 73   dirty */.void s
0e00: 71 6c 69 74 65 33 50 63 61 63 68 65 4d 61 6b 65  qlite3PcacheMake
0e10: 43 6c 65 61 6e 28 50 67 48 64 72 2a 29 3b 20 20  Clean(PgHdr*);  
0e20: 20 20 2f 2a 20 4d 61 72 6b 20 61 20 73 69 6e 67    /* Mark a sing
0e30: 6c 65 20 70 61 67 65 20 61 73 20 63 6c 65 61 6e  le page as clean
0e40: 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33   */.void sqlite3
0e50: 50 63 61 63 68 65 43 6c 65 61 6e 41 6c 6c 28 50  PcacheCleanAll(P
0e60: 43 61 63 68 65 2a 29 3b 20 20 20 20 2f 2a 20 4d  Cache*);    /* M
0e70: 61 72 6b 20 61 6c 6c 20 64 69 72 74 79 20 6c 69  ark all dirty li
0e80: 73 74 20 70 61 67 65 73 20 61 73 20 63 6c 65 61  st pages as clea
0e90: 6e 20 2a 2f 0a 0a 2f 2a 20 43 68 61 6e 67 65 20  n */../* Change 
0ea0: 61 20 70 61 67 65 20 6e 75 6d 62 65 72 2e 20 20  a page number.  
0eb0: 55 73 65 64 20 62 79 20 69 6e 63 72 2d 76 61 63  Used by incr-vac
0ec0: 75 75 6d 2e 20 2a 2f 0a 76 6f 69 64 20 73 71 6c  uum. */.void sql
0ed0: 69 74 65 33 50 63 61 63 68 65 4d 6f 76 65 28 50  ite3PcacheMove(P
0ee0: 67 48 64 72 2a 2c 20 50 67 6e 6f 29 3b 0a 0a 2f  gHdr*, Pgno);../
0ef0: 2a 20 52 65 6d 6f 76 65 20 61 6c 6c 20 70 61 67  * Remove all pag
0f00: 65 73 20 77 69 74 68 20 70 67 6e 6f 3e 78 2e 20  es with pgno>x. 
0f10: 20 52 65 73 65 74 20 74 68 65 20 63 61 63 68 65   Reset the cache
0f20: 20 69 66 20 78 3d 3d 30 20 2a 2f 0a 76 6f 69 64   if x==0 */.void
0f30: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 54 72   sqlite3PcacheTr
0f40: 75 6e 63 61 74 65 28 50 43 61 63 68 65 2a 2c 20  uncate(PCache*, 
0f50: 50 67 6e 6f 20 78 29 3b 0a 0a 2f 2a 20 47 65 74  Pgno x);../* Get
0f60: 20 61 20 6c 69 73 74 20 6f 66 20 61 6c 6c 20 64   a list of all d
0f70: 69 72 74 79 20 70 61 67 65 73 20 69 6e 20 74 68  irty pages in th
0f80: 65 20 63 61 63 68 65 2c 20 73 6f 72 74 65 64 20  e cache, sorted 
0f90: 62 79 20 70 61 67 65 20 6e 75 6d 62 65 72 20 2a  by page number *
0fa0: 2f 0a 50 67 48 64 72 20 2a 73 71 6c 69 74 65 33  /.PgHdr *sqlite3
0fb0: 50 63 61 63 68 65 44 69 72 74 79 4c 69 73 74 28  PcacheDirtyList(
0fc0: 50 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a 20 52 65  PCache*);../* Re
0fd0: 73 65 74 20 61 6e 64 20 63 6c 6f 73 65 20 74 68  set and close th
0fe0: 65 20 63 61 63 68 65 20 6f 62 6a 65 63 74 20 2a  e cache object *
0ff0: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  /.void sqlite3Pc
1000: 61 63 68 65 43 6c 6f 73 65 28 50 43 61 63 68 65  acheClose(PCache
1010: 2a 29 3b 0a 0a 2f 2a 20 43 6c 65 61 72 20 66 6c  *);../* Clear fl
1020: 61 67 73 20 66 72 6f 6d 20 70 61 67 65 73 20 6f  ags from pages o
1030: 66 20 74 68 65 20 70 61 67 65 20 63 61 63 68 65  f the page cache
1040: 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33   */.void sqlite3
1050: 50 63 61 63 68 65 43 6c 65 61 72 53 79 6e 63 46  PcacheClearSyncF
1060: 6c 61 67 73 28 50 43 61 63 68 65 20 2a 29 3b 0a  lags(PCache *);.
1070: 0a 2f 2a 20 44 69 73 63 61 72 64 20 74 68 65 20  ./* Discard the 
1080: 63 6f 6e 74 65 6e 74 73 20 6f 66 20 74 68 65 20  contents of the 
1090: 63 61 63 68 65 20 2a 2f 0a 76 6f 69 64 20 73 71  cache */.void sq
10a0: 6c 69 74 65 33 50 63 61 63 68 65 43 6c 65 61 72  lite3PcacheClear
10b0: 28 50 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a 20 52  (PCache*);../* R
10c0: 65 74 75 72 6e 20 74 68 65 20 74 6f 74 61 6c 20  eturn the total 
10d0: 6e 75 6d 62 65 72 20 6f 66 20 6f 75 74 73 74 61  number of outsta
10e0: 6e 64 69 6e 67 20 70 61 67 65 20 72 65 66 65 72  nding page refer
10f0: 65 6e 63 65 73 20 2a 2f 0a 69 6e 74 20 73 71 6c  ences */.int sql
1100: 69 74 65 33 50 63 61 63 68 65 52 65 66 43 6f 75  ite3PcacheRefCou
1110: 6e 74 28 50 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a  nt(PCache*);../*
1120: 20 49 6e 63 72 65 6d 65 6e 74 20 74 68 65 20 72   Increment the r
1130: 65 66 65 72 65 6e 63 65 20 63 6f 75 6e 74 20 6f  eference count o
1140: 66 20 61 6e 20 65 78 69 73 74 69 6e 67 20 70 61  f an existing pa
1150: 67 65 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74  ge */.void sqlit
1160: 65 33 50 63 61 63 68 65 52 65 66 28 50 67 48 64  e3PcacheRef(PgHd
1170: 72 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65  r*);..int sqlite
1180: 33 50 63 61 63 68 65 50 61 67 65 52 65 66 63 6f  3PcachePageRefco
1190: 75 6e 74 28 50 67 48 64 72 2a 29 3b 0a 0a 2f 2a  unt(PgHdr*);../*
11a0: 20 52 65 74 75 72 6e 20 74 68 65 20 74 6f 74 61   Return the tota
11b0: 6c 20 6e 75 6d 62 65 72 20 6f 66 20 70 61 67 65  l number of page
11c0: 73 20 73 74 6f 72 65 64 20 69 6e 20 74 68 65 20  s stored in the 
11d0: 63 61 63 68 65 20 2a 2f 0a 69 6e 74 20 73 71 6c  cache */.int sql
11e0: 69 74 65 33 50 63 61 63 68 65 50 61 67 65 63 6f  ite3PcachePageco
11f0: 75 6e 74 28 50 43 61 63 68 65 2a 29 3b 0a 0a 23  unt(PCache*);..#
1200: 69 66 64 65 66 20 53 51 4c 49 54 45 5f 43 48 45  ifdef SQLITE_CHE
1210: 43 4b 5f 50 41 47 45 53 0a 2f 2a 20 49 74 65 72  CK_PAGES./* Iter
1220: 61 74 65 20 74 68 72 6f 75 67 68 20 61 6c 6c 20  ate through all 
1230: 64 69 72 74 79 20 70 61 67 65 73 20 63 75 72 72  dirty pages curr
1240: 65 6e 74 6c 79 20 73 74 6f 72 65 64 20 69 6e 20  ently stored in 
1250: 74 68 65 20 63 61 63 68 65 2e 20 54 68 69 73 0a  the cache. This.
1260: 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 69 73 20  ** interface is 
1270: 6f 6e 6c 79 20 61 76 61 69 6c 61 62 6c 65 20 69  only available i
1280: 66 20 53 51 4c 49 54 45 5f 43 48 45 43 4b 5f 50  f SQLITE_CHECK_P
1290: 41 47 45 53 20 69 73 20 64 65 66 69 6e 65 64 20  AGES is defined 
12a0: 77 68 65 6e 20 74 68 65 20 0a 2a 2a 20 6c 69 62  when the .** lib
12b0: 72 61 72 79 20 69 73 20 62 75 69 6c 74 2e 0a 2a  rary is built..*
12c0: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  /.void sqlite3Pc
12d0: 61 63 68 65 49 74 65 72 61 74 65 44 69 72 74 79  acheIterateDirty
12e0: 28 50 43 61 63 68 65 20 2a 70 43 61 63 68 65 2c  (PCache *pCache,
12f0: 20 76 6f 69 64 20 28 2a 78 49 74 65 72 29 28 50   void (*xIter)(P
1300: 67 48 64 72 20 2a 29 29 3b 0a 23 65 6e 64 69 66  gHdr *));.#endif
1310: 0a 0a 2f 2a 20 53 65 74 20 61 6e 64 20 67 65 74  ../* Set and get
1320: 20 74 68 65 20 73 75 67 67 65 73 74 65 64 20 63   the suggested c
1330: 61 63 68 65 2d 73 69 7a 65 20 66 6f 72 20 74 68  ache-size for th
1340: 65 20 73 70 65 63 69 66 69 65 64 20 70 61 67 65  e specified page
1350: 72 2d 63 61 63 68 65 2e 0a 2a 2a 0a 2a 2a 20 49  r-cache..**.** I
1360: 66 20 6e 6f 20 67 6c 6f 62 61 6c 20 6d 61 78 69  f no global maxi
1370: 6d 75 6d 20 69 73 20 63 6f 6e 66 69 67 75 72 65  mum is configure
1380: 64 2c 20 74 68 65 6e 20 74 68 65 20 73 79 73 74  d, then the syst
1390: 65 6d 20 61 74 74 65 6d 70 74 73 20 74 6f 20 6c  em attempts to l
13a0: 69 6d 69 74 0a 2a 2a 20 74 68 65 20 74 6f 74 61  imit.** the tota
13b0: 6c 20 6e 75 6d 62 65 72 20 6f 66 20 70 61 67 65  l number of page
13c0: 73 20 63 61 63 68 65 64 20 62 79 20 70 75 72 67  s cached by purg
13d0: 65 61 62 6c 65 20 70 61 67 65 72 2d 63 61 63 68  eable pager-cach
13e0: 65 73 20 74 6f 20 74 68 65 20 73 75 6d 0a 2a 2a  es to the sum.**
13f0: 20 6f 66 20 74 68 65 20 73 75 67 67 65 73 74 65   of the suggeste
1400: 64 20 63 61 63 68 65 2d 73 69 7a 65 73 2e 0a 2a  d cache-sizes..*
1410: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  /.void sqlite3Pc
1420: 61 63 68 65 53 65 74 43 61 63 68 65 73 69 7a 65  acheSetCachesize
1430: 28 50 43 61 63 68 65 20 2a 2c 20 69 6e 74 29 3b  (PCache *, int);
1440: 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 54  .#ifdef SQLITE_T
1450: 45 53 54 0a 69 6e 74 20 73 71 6c 69 74 65 33 50  EST.int sqlite3P
1460: 63 61 63 68 65 47 65 74 43 61 63 68 65 73 69 7a  cacheGetCachesiz
1470: 65 28 50 43 61 63 68 65 20 2a 29 3b 0a 23 65 6e  e(PCache *);.#en
1480: 64 69 66 0a 0a 23 69 66 64 65 66 20 53 51 4c 49  dif..#ifdef SQLI
1490: 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d 4f 52 59  TE_ENABLE_MEMORY
14a0: 5f 4d 41 4e 41 47 45 4d 45 4e 54 0a 2f 2a 20 54  _MANAGEMENT./* T
14b0: 72 79 20 74 6f 20 72 65 74 75 72 6e 20 6d 65 6d  ry to return mem
14c0: 6f 72 79 20 75 73 65 64 20 62 79 20 74 68 65 20  ory used by the 
14d0: 70 63 61 63 68 65 20 6d 6f 64 75 6c 65 20 74 6f  pcache module to
14e0: 20 74 68 65 20 6d 61 69 6e 20 6d 65 6d 6f 72 79   the main memory
14f0: 20 68 65 61 70 20 2a 2f 0a 69 6e 74 20 73 71 6c   heap */.int sql
1500: 69 74 65 33 50 63 61 63 68 65 52 65 6c 65 61 73  ite3PcacheReleas
1510: 65 4d 65 6d 6f 72 79 28 69 6e 74 29 3b 0a 23 65  eMemory(int);.#e
1520: 6e 64 69 66 0a 0a 23 69 66 64 65 66 20 53 51 4c  ndif..#ifdef SQL
1530: 49 54 45 5f 54 45 53 54 0a 76 6f 69 64 20 73 71  ITE_TEST.void sq
1540: 6c 69 74 65 33 50 63 61 63 68 65 53 74 61 74 73  lite3PcacheStats
1550: 28 69 6e 74 2a 2c 69 6e 74 2a 2c 69 6e 74 2a 2c  (int*,int*,int*,
1560: 69 6e 74 2a 29 3b 0a 23 65 6e 64 69 66 0a 0a 76  int*);.#endif..v
1570: 6f 69 64 20 73 71 6c 69 74 65 33 50 43 61 63 68  oid sqlite3PCach
1580: 65 53 65 74 44 65 66 61 75 6c 74 28 76 6f 69 64  eSetDefault(void
1590: 29 3b 0a 0a 23 65 6e 64 69 66 20 2f 2a 20 5f 50  );..#endif /* _P
15a0: 43 41 43 48 45 5f 48 5f 20 2a 2f 0a              CACHE_H_ */.