/ Hex Artifact Content
Login

Artifact 9b559127b83f84ff76d735c8262f04853be0c59a:


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 73 71 6c 69 74 65 33  gHdr {.  sqlite3
0290: 5f 70 63 61 63 68 65 5f 70 61 67 65 20 2a 70 50  _pcache_page *pP
02a0: 61 67 65 3b 20 20 20 20 2f 2a 20 50 63 61 63 68  age;    /* Pcach
02b0: 65 20 6f 62 6a 65 63 74 20 70 61 67 65 20 68 61  e object page ha
02c0: 6e 64 6c 65 20 2a 2f 0a 20 20 76 6f 69 64 20 2a  ndle */.  void *
02d0: 70 44 61 74 61 3b 20 20 20 20 20 20 20 20 20 20  pData;          
02e0: 20 20 20 20 20 20 20 20 20 2f 2a 20 50 61 67 65           /* Page
02f0: 20 64 61 74 61 20 2a 2f 0a 20 20 76 6f 69 64 20   data */.  void 
0300: 2a 70 45 78 74 72 61 3b 20 20 20 20 20 20 20 20  *pExtra;        
0310: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 45 78 74            /* Ext
0320: 72 61 20 63 6f 6e 74 65 6e 74 20 2a 2f 0a 20 20  ra content */.  
0330: 50 67 48 64 72 20 2a 70 44 69 72 74 79 3b 20 20  PgHdr *pDirty;  
0340: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
0350: 2a 20 54 72 61 6e 73 69 65 6e 74 20 6c 69 73 74  * Transient list
0360: 20 6f 66 20 64 69 72 74 79 20 70 61 67 65 73 20   of dirty pages 
0370: 2a 2f 0a 20 20 50 61 67 65 72 20 2a 70 50 61 67  */.  Pager *pPag
0380: 65 72 3b 20 20 20 20 20 20 20 20 20 20 20 20 20  er;             
0390: 20 20 20 20 2f 2a 20 54 68 65 20 70 61 67 65 72      /* The pager
03a0: 20 74 68 69 73 20 70 61 67 65 20 69 73 20 70 61   this page is pa
03b0: 72 74 20 6f 66 20 2a 2f 0a 20 20 50 67 6e 6f 20  rt of */.  Pgno 
03c0: 70 67 6e 6f 3b 20 20 20 20 20 20 20 20 20 20 20  pgno;           
03d0: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 50 61 67            /* Pag
03e0: 65 20 6e 75 6d 62 65 72 20 66 6f 72 20 74 68 69  e number for thi
03f0: 73 20 70 61 67 65 20 2a 2f 0a 23 69 66 64 65 66  s page */.#ifdef
0400: 20 53 51 4c 49 54 45 5f 43 48 45 43 4b 5f 50 41   SQLITE_CHECK_PA
0410: 47 45 53 0a 20 20 75 33 32 20 70 61 67 65 48 61  GES.  u32 pageHa
0420: 73 68 3b 20 20 20 20 20 20 20 20 20 20 20 20 20  sh;             
0430: 20 20 20 20 20 2f 2a 20 48 61 73 68 20 6f 66 20       /* Hash of 
0440: 70 61 67 65 20 63 6f 6e 74 65 6e 74 20 2a 2f 0a  page content */.
0450: 23 65 6e 64 69 66 0a 20 20 75 31 36 20 66 6c 61  #endif.  u16 fla
0460: 67 73 3b 20 20 20 20 20 20 20 20 20 20 20 20 20  gs;             
0470: 20 20 20 20 20 20 20 20 2f 2a 20 50 47 48 44 52          /* PGHDR
0480: 20 66 6c 61 67 73 20 64 65 66 69 6e 65 64 20 62   flags defined b
0490: 65 6c 6f 77 20 2a 2f 0a 0a 20 20 2f 2a 2a 2a 2a  elow */..  /****
04a0: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
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 0a 20 20 2a 2a 20 45 6c 65 6d 65 6e 74 73  **.  ** Elements
04f0: 20 61 62 6f 76 65 20 61 72 65 20 70 75 62 6c 69   above are publi
0500: 63 2e 20 20 41 6c 6c 20 74 68 61 74 20 66 6f 6c  c.  All that fol
0510: 6c 6f 77 73 20 69 73 20 70 72 69 76 61 74 65 20  lows is private 
0520: 74 6f 20 70 63 61 63 68 65 2e 63 0a 20 20 2a 2a  to pcache.c.  **
0530: 20 61 6e 64 20 73 68 6f 75 6c 64 20 6e 6f 74 20   and should not 
0540: 62 65 20 61 63 63 65 73 73 65 64 20 62 79 20 6f  be accessed by o
0550: 74 68 65 72 20 6d 6f 64 75 6c 65 73 2e 0a 20 20  ther modules..  
0560: 2a 2f 0a 20 20 69 31 36 20 6e 52 65 66 3b 20 20  */.  i16 nRef;  
0570: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0580: 20 20 20 20 2f 2a 20 4e 75 6d 62 65 72 20 6f 66      /* Number of
0590: 20 75 73 65 72 73 20 6f 66 20 74 68 69 73 20 70   users of this p
05a0: 61 67 65 20 2a 2f 0a 20 20 50 43 61 63 68 65 20  age */.  PCache 
05b0: 2a 70 43 61 63 68 65 3b 20 20 20 20 20 20 20 20  *pCache;        
05c0: 20 20 20 20 20 20 20 20 2f 2a 20 43 61 63 68 65          /* Cache
05d0: 20 74 68 61 74 20 6f 77 6e 73 20 74 68 69 73 20   that owns this 
05e0: 70 61 67 65 20 2a 2f 0a 0a 20 20 50 67 48 64 72  page */..  PgHdr
05f0: 20 2a 70 44 69 72 74 79 4e 65 78 74 3b 20 20 20   *pDirtyNext;   
0600: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4e 65 78            /* Nex
0610: 74 20 65 6c 65 6d 65 6e 74 20 69 6e 20 6c 69 73  t element in lis
0620: 74 20 6f 66 20 64 69 72 74 79 20 70 61 67 65 73  t of dirty pages
0630: 20 2a 2f 0a 20 20 50 67 48 64 72 20 2a 70 44 69   */.  PgHdr *pDi
0640: 72 74 79 50 72 65 76 3b 20 20 20 20 20 20 20 20  rtyPrev;        
0650: 20 20 20 20 20 2f 2a 20 50 72 65 76 69 6f 75 73       /* Previous
0660: 20 65 6c 65 6d 65 6e 74 20 69 6e 20 6c 69 73 74   element in list
0670: 20 6f 66 20 64 69 72 74 79 20 70 61 67 65 73 20   of dirty pages 
0680: 2a 2f 0a 7d 3b 0a 0a 2f 2a 20 42 69 74 20 76 61  */.};../* Bit va
0690: 6c 75 65 73 20 66 6f 72 20 50 67 48 64 72 2e 66  lues for PgHdr.f
06a0: 6c 61 67 73 20 2a 2f 0a 23 64 65 66 69 6e 65 20  lags */.#define 
06b0: 50 47 48 44 52 5f 44 49 52 54 59 20 20 20 20 20  PGHDR_DIRTY     
06c0: 20 20 20 20 20 20 20 20 30 78 30 30 32 20 20 2f          0x002  /
06d0: 2a 20 50 61 67 65 20 68 61 73 20 63 68 61 6e 67  * Page has chang
06e0: 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 47  ed */.#define PG
06f0: 48 44 52 5f 4e 45 45 44 5f 53 59 4e 43 20 20 20  HDR_NEED_SYNC   
0700: 20 20 20 20 20 20 30 78 30 30 34 20 20 2f 2a 20        0x004  /* 
0710: 46 73 79 6e 63 20 74 68 65 20 72 6f 6c 6c 62 61  Fsync the rollba
0720: 63 6b 20 6a 6f 75 72 6e 61 6c 20 62 65 66 6f 72  ck journal befor
0730: 65 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 20  e.              
0740: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0750: 20 20 20 20 20 20 20 20 20 2a 2a 20 77 72 69 74           ** writ
0760: 69 6e 67 20 74 68 69 73 20 70 61 67 65 20 74 6f  ing this page to
0770: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 2a 2f   the database */
0780: 0a 23 64 65 66 69 6e 65 20 50 47 48 44 52 5f 4e  .#define PGHDR_N
0790: 45 45 44 5f 52 45 41 44 20 20 20 20 20 20 20 20  EED_READ        
07a0: 20 30 78 30 30 38 20 20 2f 2a 20 43 6f 6e 74 65   0x008  /* Conte
07b0: 6e 74 20 69 73 20 75 6e 72 65 61 64 20 2a 2f 0a  nt is unread */.
07c0: 23 64 65 66 69 6e 65 20 50 47 48 44 52 5f 52 45  #define PGHDR_RE
07d0: 55 53 45 5f 55 4e 4c 49 4b 45 4c 59 20 20 20 20  USE_UNLIKELY    
07e0: 30 78 30 31 30 20 20 2f 2a 20 41 20 68 69 6e 74  0x010  /* A hint
07f0: 20 74 68 61 74 20 72 65 75 73 65 20 69 73 20 75   that reuse is u
0800: 6e 6c 69 6b 65 6c 79 20 2a 2f 0a 23 64 65 66 69  nlikely */.#defi
0810: 6e 65 20 50 47 48 44 52 5f 44 4f 4e 54 5f 57 52  ne PGHDR_DONT_WR
0820: 49 54 45 20 20 20 20 20 20 20 20 30 78 30 32 30  ITE        0x020
0830: 20 20 2f 2a 20 44 6f 20 6e 6f 74 20 77 72 69 74    /* Do not writ
0840: 65 20 63 6f 6e 74 65 6e 74 20 74 6f 20 64 69 73  e content to dis
0850: 6b 20 2a 2f 0a 0a 23 64 65 66 69 6e 65 20 50 47  k */..#define PG
0860: 48 44 52 5f 4d 4d 41 50 20 20 20 20 20 20 20 20  HDR_MMAP        
0870: 20 20 20 20 20 20 30 78 30 34 30 20 20 2f 2a 20        0x040  /* 
0880: 54 68 69 73 20 69 73 20 61 6e 20 6d 6d 61 70 20  This is an mmap 
0890: 70 61 67 65 20 6f 62 6a 65 63 74 20 2a 2f 0a 0a  page object */..
08a0: 2f 2a 20 49 6e 69 74 69 61 6c 69 7a 65 20 61 6e  /* Initialize an
08b0: 64 20 73 68 75 74 64 6f 77 6e 20 74 68 65 20 70  d shutdown the p
08c0: 61 67 65 20 63 61 63 68 65 20 73 75 62 73 79 73  age cache subsys
08d0: 74 65 6d 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  tem */.int sqlit
08e0: 65 33 50 63 61 63 68 65 49 6e 69 74 69 61 6c 69  e3PcacheInitiali
08f0: 7a 65 28 76 6f 69 64 29 3b 0a 76 6f 69 64 20 73  ze(void);.void s
0900: 71 6c 69 74 65 33 50 63 61 63 68 65 53 68 75 74  qlite3PcacheShut
0910: 64 6f 77 6e 28 76 6f 69 64 29 3b 0a 0a 2f 2a 20  down(void);../* 
0920: 50 61 67 65 20 63 61 63 68 65 20 62 75 66 66 65  Page cache buffe
0930: 72 20 6d 61 6e 61 67 65 6d 65 6e 74 3a 0a 2a 2a  r management:.**
0940: 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20   These routines 
0950: 69 6d 70 6c 65 6d 65 6e 74 20 53 51 4c 49 54 45  implement SQLITE
0960: 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43 41 43 48  _CONFIG_PAGECACH
0970: 45 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74  E..*/.void sqlit
0980: 65 33 50 43 61 63 68 65 42 75 66 66 65 72 53 65  e3PCacheBufferSe
0990: 74 75 70 28 76 6f 69 64 20 2a 2c 20 69 6e 74 20  tup(void *, int 
09a0: 73 7a 2c 20 69 6e 74 20 6e 29 3b 0a 0a 2f 2a 20  sz, int n);../* 
09b0: 43 72 65 61 74 65 20 61 20 6e 65 77 20 70 61 67  Create a new pag
09c0: 65 72 20 63 61 63 68 65 2e 0a 2a 2a 20 55 6e 64  er cache..** Und
09d0: 65 72 20 6d 65 6d 6f 72 79 20 73 74 72 65 73 73  er memory stress
09e0: 2c 20 69 6e 76 6f 6b 65 20 78 53 74 72 65 73 73  , invoke xStress
09f0: 20 74 6f 20 74 72 79 20 74 6f 20 6d 61 6b 65 20   to try to make 
0a00: 70 61 67 65 73 20 63 6c 65 61 6e 2e 0a 2a 2a 20  pages clean..** 
0a10: 4f 6e 6c 79 20 63 6c 65 61 6e 20 61 6e 64 20 75  Only clean and u
0a20: 6e 70 69 6e 6e 65 64 20 70 61 67 65 73 20 63 61  npinned pages ca
0a30: 6e 20 62 65 20 72 65 63 6c 61 69 6d 65 64 2e 0a  n be reclaimed..
0a40: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63  */.int sqlite3Pc
0a50: 61 63 68 65 4f 70 65 6e 28 0a 20 20 69 6e 74 20  acheOpen(.  int 
0a60: 73 7a 50 61 67 65 2c 20 20 20 20 20 20 20 20 20  szPage,         
0a70: 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 53 69             /* Si
0a80: 7a 65 20 6f 66 20 65 76 65 72 79 20 70 61 67 65  ze of every page
0a90: 20 2a 2f 0a 20 20 69 6e 74 20 73 7a 45 78 74 72   */.  int szExtr
0aa0: 61 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  a,              
0ab0: 20 20 20 20 20 2f 2a 20 45 78 74 72 61 20 73 70       /* Extra sp
0ac0: 61 63 65 20 61 73 73 6f 63 69 61 74 65 64 20 77  ace associated w
0ad0: 69 74 68 20 65 61 63 68 20 70 61 67 65 20 2a 2f  ith each page */
0ae0: 0a 20 20 69 6e 74 20 62 50 75 72 67 65 61 62 6c  .  int bPurgeabl
0af0: 65 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  e,              
0b00: 20 20 2f 2a 20 54 72 75 65 20 69 66 20 70 61 67    /* True if pag
0b10: 65 73 20 61 72 65 20 6f 6e 20 62 61 63 6b 69 6e  es are on backin
0b20: 67 20 73 74 6f 72 65 20 2a 2f 0a 20 20 69 6e 74  g store */.  int
0b30: 20 28 2a 78 53 74 72 65 73 73 29 28 76 6f 69 64   (*xStress)(void
0b40: 2a 2c 20 50 67 48 64 72 2a 29 2c 20 2f 2a 20 43  *, PgHdr*), /* C
0b50: 61 6c 6c 20 74 6f 20 74 72 79 20 74 6f 20 6d 61  all to try to ma
0b60: 6b 65 20 70 61 67 65 73 20 63 6c 65 61 6e 20 2a  ke pages clean *
0b70: 2f 0a 20 20 76 6f 69 64 20 2a 70 53 74 72 65 73  /.  void *pStres
0b80: 73 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  s,              
0b90: 20 20 20 2f 2a 20 41 72 67 75 6d 65 6e 74 20 74     /* Argument t
0ba0: 6f 20 78 53 74 72 65 73 73 20 2a 2f 0a 20 20 50  o xStress */.  P
0bb0: 43 61 63 68 65 20 2a 70 54 6f 49 6e 69 74 20 20  Cache *pToInit  
0bc0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a                /*
0bd0: 20 50 72 65 61 6c 6c 6f 63 61 74 65 64 20 73 70   Preallocated sp
0be0: 61 63 65 20 66 6f 72 20 74 68 65 20 50 43 61 63  ace for the PCac
0bf0: 68 65 20 2a 2f 0a 29 3b 0a 0a 2f 2a 20 4d 6f 64  he */.);../* Mod
0c00: 69 66 79 20 74 68 65 20 70 61 67 65 2d 73 69 7a  ify the page-siz
0c10: 65 20 61 66 74 65 72 20 74 68 65 20 63 61 63 68  e after the cach
0c20: 65 20 68 61 73 20 62 65 65 6e 20 63 72 65 61 74  e has been creat
0c30: 65 64 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  ed. */.int sqlit
0c40: 65 33 50 63 61 63 68 65 53 65 74 50 61 67 65 53  e3PcacheSetPageS
0c50: 69 7a 65 28 50 43 61 63 68 65 20 2a 2c 20 69 6e  ize(PCache *, in
0c60: 74 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74  t);../* Return t
0c70: 68 65 20 73 69 7a 65 20 69 6e 20 62 79 74 65 73  he size in bytes
0c80: 20 6f 66 20 61 20 50 43 61 63 68 65 20 6f 62 6a   of a PCache obj
0c90: 65 63 74 2e 20 20 55 73 65 64 20 74 6f 20 70 72  ect.  Used to pr
0ca0: 65 61 6c 6c 6f 63 61 74 65 0a 2a 2a 20 73 74 6f  eallocate.** sto
0cb0: 72 61 67 65 20 73 70 61 63 65 2e 0a 2a 2f 0a 69  rage space..*/.i
0cc0: 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  nt sqlite3Pcache
0cd0: 53 69 7a 65 28 76 6f 69 64 29 3b 0a 0a 2f 2a 20  Size(void);../* 
0ce0: 4f 6e 65 20 72 65 6c 65 61 73 65 20 70 65 72 20  One release per 
0cf0: 73 75 63 63 65 73 73 66 75 6c 20 66 65 74 63 68  successful fetch
0d00: 2e 20 20 50 61 67 65 20 69 73 20 70 69 6e 6e 65  .  Page is pinne
0d10: 64 20 75 6e 74 69 6c 20 72 65 6c 65 61 73 65 64  d until released
0d20: 2e 0a 2a 2a 20 52 65 66 65 72 65 6e 63 65 20 63  ..** Reference c
0d30: 6f 75 6e 74 65 64 2e 20 0a 2a 2f 0a 73 71 6c 69  ounted. .*/.sqli
0d40: 74 65 33 5f 70 63 61 63 68 65 5f 70 61 67 65 20  te3_pcache_page 
0d50: 2a 73 71 6c 69 74 65 33 50 63 61 63 68 65 46 65  *sqlite3PcacheFe
0d60: 74 63 68 28 50 43 61 63 68 65 2a 2c 20 50 67 6e  tch(PCache*, Pgn
0d70: 6f 2c 20 69 6e 74 20 63 72 65 61 74 65 46 6c 61  o, int createFla
0d80: 67 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 50  g);.int sqlite3P
0d90: 63 61 63 68 65 46 65 74 63 68 53 74 72 65 73 73  cacheFetchStress
0da0: 28 50 43 61 63 68 65 2a 2c 20 50 67 6e 6f 2c 20  (PCache*, Pgno, 
0db0: 73 71 6c 69 74 65 33 5f 70 63 61 63 68 65 5f 70  sqlite3_pcache_p
0dc0: 61 67 65 2a 2a 29 3b 0a 50 67 48 64 72 20 2a 73  age**);.PgHdr *s
0dd0: 71 6c 69 74 65 33 50 63 61 63 68 65 46 65 74 63  qlite3PcacheFetc
0de0: 68 46 69 6e 69 73 68 28 50 43 61 63 68 65 2a 2c  hFinish(PCache*,
0df0: 20 50 67 6e 6f 2c 20 73 71 6c 69 74 65 33 5f 70   Pgno, sqlite3_p
0e00: 63 61 63 68 65 5f 70 61 67 65 20 2a 70 50 61 67  cache_page *pPag
0e10: 65 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  e);.void sqlite3
0e20: 50 63 61 63 68 65 52 65 6c 65 61 73 65 28 50 67  PcacheRelease(Pg
0e30: 48 64 72 2a 29 3b 0a 0a 76 6f 69 64 20 73 71 6c  Hdr*);..void sql
0e40: 69 74 65 33 50 63 61 63 68 65 44 72 6f 70 28 50  ite3PcacheDrop(P
0e50: 67 48 64 72 2a 29 3b 20 20 20 20 20 20 20 20 20  gHdr*);         
0e60: 2f 2a 20 52 65 6d 6f 76 65 20 70 61 67 65 20 66  /* Remove page f
0e70: 72 6f 6d 20 63 61 63 68 65 20 2a 2f 0a 76 6f 69  rom cache */.voi
0e80: 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 4d  d sqlite3PcacheM
0e90: 61 6b 65 44 69 72 74 79 28 50 67 48 64 72 2a 29  akeDirty(PgHdr*)
0ea0: 3b 20 20 20 20 2f 2a 20 4d 61 6b 65 20 73 75 72  ;    /* Make sur
0eb0: 65 20 70 61 67 65 20 69 73 20 6d 61 72 6b 65 64  e page is marked
0ec0: 20 64 69 72 74 79 20 2a 2f 0a 76 6f 69 64 20 73   dirty */.void s
0ed0: 71 6c 69 74 65 33 50 63 61 63 68 65 4d 61 6b 65  qlite3PcacheMake
0ee0: 43 6c 65 61 6e 28 50 67 48 64 72 2a 29 3b 20 20  Clean(PgHdr*);  
0ef0: 20 20 2f 2a 20 4d 61 72 6b 20 61 20 73 69 6e 67    /* Mark a sing
0f00: 6c 65 20 70 61 67 65 20 61 73 20 63 6c 65 61 6e  le page as clean
0f10: 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33   */.void sqlite3
0f20: 50 63 61 63 68 65 43 6c 65 61 6e 41 6c 6c 28 50  PcacheCleanAll(P
0f30: 43 61 63 68 65 2a 29 3b 20 20 20 20 2f 2a 20 4d  Cache*);    /* M
0f40: 61 72 6b 20 61 6c 6c 20 64 69 72 74 79 20 6c 69  ark all dirty li
0f50: 73 74 20 70 61 67 65 73 20 61 73 20 63 6c 65 61  st pages as clea
0f60: 6e 20 2a 2f 0a 0a 2f 2a 20 43 68 61 6e 67 65 20  n */../* Change 
0f70: 61 20 70 61 67 65 20 6e 75 6d 62 65 72 2e 20 20  a page number.  
0f80: 55 73 65 64 20 62 79 20 69 6e 63 72 2d 76 61 63  Used by incr-vac
0f90: 75 75 6d 2e 20 2a 2f 0a 76 6f 69 64 20 73 71 6c  uum. */.void sql
0fa0: 69 74 65 33 50 63 61 63 68 65 4d 6f 76 65 28 50  ite3PcacheMove(P
0fb0: 67 48 64 72 2a 2c 20 50 67 6e 6f 29 3b 0a 0a 2f  gHdr*, Pgno);../
0fc0: 2a 20 52 65 6d 6f 76 65 20 61 6c 6c 20 70 61 67  * Remove all pag
0fd0: 65 73 20 77 69 74 68 20 70 67 6e 6f 3e 78 2e 20  es with pgno>x. 
0fe0: 20 52 65 73 65 74 20 74 68 65 20 63 61 63 68 65   Reset the cache
0ff0: 20 69 66 20 78 3d 3d 30 20 2a 2f 0a 76 6f 69 64   if x==0 */.void
1000: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 54 72   sqlite3PcacheTr
1010: 75 6e 63 61 74 65 28 50 43 61 63 68 65 2a 2c 20  uncate(PCache*, 
1020: 50 67 6e 6f 20 78 29 3b 0a 0a 2f 2a 20 47 65 74  Pgno x);../* Get
1030: 20 61 20 6c 69 73 74 20 6f 66 20 61 6c 6c 20 64   a list of all d
1040: 69 72 74 79 20 70 61 67 65 73 20 69 6e 20 74 68  irty pages in th
1050: 65 20 63 61 63 68 65 2c 20 73 6f 72 74 65 64 20  e cache, sorted 
1060: 62 79 20 70 61 67 65 20 6e 75 6d 62 65 72 20 2a  by page number *
1070: 2f 0a 50 67 48 64 72 20 2a 73 71 6c 69 74 65 33  /.PgHdr *sqlite3
1080: 50 63 61 63 68 65 44 69 72 74 79 4c 69 73 74 28  PcacheDirtyList(
1090: 50 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a 20 52 65  PCache*);../* Re
10a0: 73 65 74 20 61 6e 64 20 63 6c 6f 73 65 20 74 68  set and close th
10b0: 65 20 63 61 63 68 65 20 6f 62 6a 65 63 74 20 2a  e cache object *
10c0: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  /.void sqlite3Pc
10d0: 61 63 68 65 43 6c 6f 73 65 28 50 43 61 63 68 65  acheClose(PCache
10e0: 2a 29 3b 0a 0a 2f 2a 20 43 6c 65 61 72 20 66 6c  *);../* Clear fl
10f0: 61 67 73 20 66 72 6f 6d 20 70 61 67 65 73 20 6f  ags from pages o
1100: 66 20 74 68 65 20 70 61 67 65 20 63 61 63 68 65  f the page cache
1110: 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33   */.void sqlite3
1120: 50 63 61 63 68 65 43 6c 65 61 72 53 79 6e 63 46  PcacheClearSyncF
1130: 6c 61 67 73 28 50 43 61 63 68 65 20 2a 29 3b 0a  lags(PCache *);.
1140: 0a 2f 2a 20 44 69 73 63 61 72 64 20 74 68 65 20  ./* Discard the 
1150: 63 6f 6e 74 65 6e 74 73 20 6f 66 20 74 68 65 20  contents of the 
1160: 63 61 63 68 65 20 2a 2f 0a 76 6f 69 64 20 73 71  cache */.void sq
1170: 6c 69 74 65 33 50 63 61 63 68 65 43 6c 65 61 72  lite3PcacheClear
1180: 28 50 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a 20 52  (PCache*);../* R
1190: 65 74 75 72 6e 20 74 68 65 20 74 6f 74 61 6c 20  eturn the total 
11a0: 6e 75 6d 62 65 72 20 6f 66 20 6f 75 74 73 74 61  number of outsta
11b0: 6e 64 69 6e 67 20 70 61 67 65 20 72 65 66 65 72  nding page refer
11c0: 65 6e 63 65 73 20 2a 2f 0a 69 6e 74 20 73 71 6c  ences */.int sql
11d0: 69 74 65 33 50 63 61 63 68 65 52 65 66 43 6f 75  ite3PcacheRefCou
11e0: 6e 74 28 50 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a  nt(PCache*);../*
11f0: 20 49 6e 63 72 65 6d 65 6e 74 20 74 68 65 20 72   Increment the r
1200: 65 66 65 72 65 6e 63 65 20 63 6f 75 6e 74 20 6f  eference count o
1210: 66 20 61 6e 20 65 78 69 73 74 69 6e 67 20 70 61  f an existing pa
1220: 67 65 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74  ge */.void sqlit
1230: 65 33 50 63 61 63 68 65 52 65 66 28 50 67 48 64  e3PcacheRef(PgHd
1240: 72 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65  r*);..int sqlite
1250: 33 50 63 61 63 68 65 50 61 67 65 52 65 66 63 6f  3PcachePageRefco
1260: 75 6e 74 28 50 67 48 64 72 2a 29 3b 0a 0a 2f 2a  unt(PgHdr*);../*
1270: 20 52 65 74 75 72 6e 20 74 68 65 20 74 6f 74 61   Return the tota
1280: 6c 20 6e 75 6d 62 65 72 20 6f 66 20 70 61 67 65  l number of page
1290: 73 20 73 74 6f 72 65 64 20 69 6e 20 74 68 65 20  s stored in the 
12a0: 63 61 63 68 65 20 2a 2f 0a 69 6e 74 20 73 71 6c  cache */.int sql
12b0: 69 74 65 33 50 63 61 63 68 65 50 61 67 65 63 6f  ite3PcachePageco
12c0: 75 6e 74 28 50 43 61 63 68 65 2a 29 3b 0a 0a 23  unt(PCache*);..#
12d0: 69 66 20 64 65 66 69 6e 65 64 28 53 51 4c 49 54  if defined(SQLIT
12e0: 45 5f 43 48 45 43 4b 5f 50 41 47 45 53 29 20 7c  E_CHECK_PAGES) |
12f0: 7c 20 64 65 66 69 6e 65 64 28 53 51 4c 49 54 45  | defined(SQLITE
1300: 5f 44 45 42 55 47 29 0a 2f 2a 20 49 74 65 72 61  _DEBUG)./* Itera
1310: 74 65 20 74 68 72 6f 75 67 68 20 61 6c 6c 20 64  te through all d
1320: 69 72 74 79 20 70 61 67 65 73 20 63 75 72 72 65  irty pages curre
1330: 6e 74 6c 79 20 73 74 6f 72 65 64 20 69 6e 20 74  ntly stored in t
1340: 68 65 20 63 61 63 68 65 2e 20 54 68 69 73 0a 2a  he cache. This.*
1350: 2a 20 69 6e 74 65 72 66 61 63 65 20 69 73 20 6f  * interface is o
1360: 6e 6c 79 20 61 76 61 69 6c 61 62 6c 65 20 69 66  nly available if
1370: 20 53 51 4c 49 54 45 5f 43 48 45 43 4b 5f 50 41   SQLITE_CHECK_PA
1380: 47 45 53 20 69 73 20 64 65 66 69 6e 65 64 20 77  GES is defined w
1390: 68 65 6e 20 74 68 65 20 0a 2a 2a 20 6c 69 62 72  hen the .** libr
13a0: 61 72 79 20 69 73 20 62 75 69 6c 74 2e 0a 2a 2f  ary is built..*/
13b0: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61  .void sqlite3Pca
13c0: 63 68 65 49 74 65 72 61 74 65 44 69 72 74 79 28  cheIterateDirty(
13d0: 50 43 61 63 68 65 20 2a 70 43 61 63 68 65 2c 20  PCache *pCache, 
13e0: 76 6f 69 64 20 28 2a 78 49 74 65 72 29 28 50 67  void (*xIter)(Pg
13f0: 48 64 72 20 2a 29 29 3b 0a 23 65 6e 64 69 66 0a  Hdr *));.#endif.
1400: 0a 2f 2a 20 53 65 74 20 61 6e 64 20 67 65 74 20  ./* Set and get 
1410: 74 68 65 20 73 75 67 67 65 73 74 65 64 20 63 61  the suggested ca
1420: 63 68 65 2d 73 69 7a 65 20 66 6f 72 20 74 68 65  che-size for the
1430: 20 73 70 65 63 69 66 69 65 64 20 70 61 67 65 72   specified pager
1440: 2d 63 61 63 68 65 2e 0a 2a 2a 0a 2a 2a 20 49 66  -cache..**.** If
1450: 20 6e 6f 20 67 6c 6f 62 61 6c 20 6d 61 78 69 6d   no global maxim
1460: 75 6d 20 69 73 20 63 6f 6e 66 69 67 75 72 65 64  um is configured
1470: 2c 20 74 68 65 6e 20 74 68 65 20 73 79 73 74 65  , then the syste
1480: 6d 20 61 74 74 65 6d 70 74 73 20 74 6f 20 6c 69  m attempts to li
1490: 6d 69 74 0a 2a 2a 20 74 68 65 20 74 6f 74 61 6c  mit.** the total
14a0: 20 6e 75 6d 62 65 72 20 6f 66 20 70 61 67 65 73   number of pages
14b0: 20 63 61 63 68 65 64 20 62 79 20 70 75 72 67 65   cached by purge
14c0: 61 62 6c 65 20 70 61 67 65 72 2d 63 61 63 68 65  able pager-cache
14d0: 73 20 74 6f 20 74 68 65 20 73 75 6d 0a 2a 2a 20  s to the sum.** 
14e0: 6f 66 20 74 68 65 20 73 75 67 67 65 73 74 65 64  of the suggested
14f0: 20 63 61 63 68 65 2d 73 69 7a 65 73 2e 0a 2a 2f   cache-sizes..*/
1500: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61  .void sqlite3Pca
1510: 63 68 65 53 65 74 43 61 63 68 65 73 69 7a 65 28  cheSetCachesize(
1520: 50 43 61 63 68 65 20 2a 2c 20 69 6e 74 29 3b 0a  PCache *, int);.
1530: 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 54 45  #ifdef SQLITE_TE
1540: 53 54 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63  ST.int sqlite3Pc
1550: 61 63 68 65 47 65 74 43 61 63 68 65 73 69 7a 65  acheGetCachesize
1560: 28 50 43 61 63 68 65 20 2a 29 3b 0a 23 65 6e 64  (PCache *);.#end
1570: 69 66 0a 0a 2f 2a 20 46 72 65 65 20 75 70 20 61  if../* Free up a
1580: 73 20 6d 75 63 68 20 6d 65 6d 6f 72 79 20 61 73  s much memory as
1590: 20 70 6f 73 73 69 62 6c 65 20 66 72 6f 6d 20 74   possible from t
15a0: 68 65 20 70 61 67 65 20 63 61 63 68 65 20 2a 2f  he page cache */
15b0: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61  .void sqlite3Pca
15c0: 63 68 65 53 68 72 69 6e 6b 28 50 43 61 63 68 65  cheShrink(PCache
15d0: 2a 29 3b 0a 0a 23 69 66 64 65 66 20 53 51 4c 49  *);..#ifdef SQLI
15e0: 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d 4f 52 59  TE_ENABLE_MEMORY
15f0: 5f 4d 41 4e 41 47 45 4d 45 4e 54 0a 2f 2a 20 54  _MANAGEMENT./* T
1600: 72 79 20 74 6f 20 72 65 74 75 72 6e 20 6d 65 6d  ry to return mem
1610: 6f 72 79 20 75 73 65 64 20 62 79 20 74 68 65 20  ory used by the 
1620: 70 63 61 63 68 65 20 6d 6f 64 75 6c 65 20 74 6f  pcache module to
1630: 20 74 68 65 20 6d 61 69 6e 20 6d 65 6d 6f 72 79   the main memory
1640: 20 68 65 61 70 20 2a 2f 0a 69 6e 74 20 73 71 6c   heap */.int sql
1650: 69 74 65 33 50 63 61 63 68 65 52 65 6c 65 61 73  ite3PcacheReleas
1660: 65 4d 65 6d 6f 72 79 28 69 6e 74 29 3b 0a 23 65  eMemory(int);.#e
1670: 6e 64 69 66 0a 0a 23 69 66 64 65 66 20 53 51 4c  ndif..#ifdef SQL
1680: 49 54 45 5f 54 45 53 54 0a 76 6f 69 64 20 73 71  ITE_TEST.void sq
1690: 6c 69 74 65 33 50 63 61 63 68 65 53 74 61 74 73  lite3PcacheStats
16a0: 28 69 6e 74 2a 2c 69 6e 74 2a 2c 69 6e 74 2a 2c  (int*,int*,int*,
16b0: 69 6e 74 2a 29 3b 0a 23 65 6e 64 69 66 0a 0a 76  int*);.#endif..v
16c0: 6f 69 64 20 73 71 6c 69 74 65 33 50 43 61 63 68  oid sqlite3PCach
16d0: 65 53 65 74 44 65 66 61 75 6c 74 28 76 6f 69 64  eSetDefault(void
16e0: 29 3b 0a 0a 23 65 6e 64 69 66 20 2f 2a 20 5f 50  );..#endif /* _P
16f0: 43 41 43 48 45 5f 48 5f 20 2a 2f 0a              CACHE_H_ */.