/ Hex Artifact Content
Login

Artifact 2caf2deb6cbaa75c423b8b96fc1411069ee77c75:


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 34 20 32 30 30 38 2f 31 30 2f  ,v 1.14 2008/10/
01f0: 31 37 20 31 38 3a 35 31 3a 35 33 20 64 61 6e 69  17 18:51:53 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 20 20 2f 2a 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 0a 20 20 2a 2a 20 45 6c 65 6d 65 6e 74 73 20  *.  ** Elements 
0500: 61 62 6f 76 65 20 61 72 65 20 70 75 62 6c 69 63  above are public
0510: 2e 20 20 41 6c 6c 20 74 68 61 74 20 66 6f 6c 6c  .  All that foll
0520: 6f 77 73 20 69 73 20 70 72 69 76 61 74 65 20 74  ows is private t
0530: 6f 20 70 63 61 63 68 65 2e 63 0a 20 20 2a 2a 20  o pcache.c.  ** 
0540: 61 6e 64 20 73 68 6f 75 6c 64 20 6e 6f 74 20 62  and should not b
0550: 65 20 61 63 63 65 73 73 65 64 20 62 79 20 6f 74  e accessed by ot
0560: 68 65 72 20 6d 6f 64 75 6c 65 73 2e 0a 20 20 2a  her modules..  *
0570: 2f 0a 20 20 69 31 36 20 6e 52 65 66 3b 20 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 2f 2a 20 4e 75 6d 62 65 72 20 6f 66 20     /* Number of 
05a0: 75 73 65 72 73 20 6f 66 20 74 68 69 73 20 70 61  users of this pa
05b0: 67 65 20 2a 2f 0a 20 20 50 43 61 63 68 65 20 2a  ge */.  PCache *
05c0: 70 43 61 63 68 65 3b 20 20 20 20 20 20 20 20 20  pCache;         
05d0: 20 20 20 20 20 20 20 2f 2a 20 43 61 63 68 65 20         /* Cache 
05e0: 74 68 61 74 20 6f 77 6e 73 20 74 68 69 73 20 70  that owns this p
05f0: 61 67 65 20 2a 2f 0a 0a 20 20 2f 2a 2a 2a 2a 2a  age */..  /*****
0600: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0610: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0620: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0630: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0640: 2a 0a 20 20 2a 2a 20 45 6c 65 6d 65 6e 74 73 20  *.  ** Elements 
0650: 61 62 6f 76 65 20 61 72 65 20 61 63 63 65 73 73  above are access
0660: 69 62 6c 65 20 61 74 20 61 6e 79 20 74 69 6d 65  ible at any time
0670: 20 62 79 20 74 68 65 20 6f 77 6e 65 72 20 6f 66   by the owner of
0680: 20 74 68 65 20 63 61 63 68 65 0a 20 20 2a 2a 20   the cache.  ** 
0690: 77 69 74 68 6f 75 74 20 74 68 65 20 6e 65 65 64  without the need
06a0: 20 66 6f 72 20 61 20 6d 75 74 65 78 2e 20 20 54   for a mutex.  T
06b0: 68 65 20 65 6c 65 6d 65 6e 74 73 20 74 68 61 74  he elements that
06c0: 20 66 6f 6c 6c 6f 77 20 63 61 6e 20 6f 6e 6c 79   follow can only
06d0: 20 62 65 0a 20 20 2a 2a 20 61 63 63 65 73 73 65   be.  ** accesse
06e0: 64 20 77 68 69 6c 65 20 68 6f 6c 64 69 6e 67 20  d while holding 
06f0: 74 68 65 20 53 51 4c 49 54 45 5f 4d 55 54 45 58  the SQLITE_MUTEX
0700: 5f 53 54 41 54 49 43 5f 4c 52 55 20 6d 75 74 65  _STATIC_LRU mute
0710: 78 2e 0a 20 20 2a 2f 0a 20 20 50 67 48 64 72 20  x..  */.  PgHdr 
0720: 2a 70 4e 65 78 74 48 61 73 68 2c 20 2a 70 50 72  *pNextHash, *pPr
0730: 65 76 48 61 73 68 3b 20 20 2f 2a 20 48 61 73 68  evHash;  /* Hash
0740: 20 63 6f 6c 6c 69 73 69 6f 6e 20 63 68 61 69 6e   collision chain
0750: 20 66 6f 72 20 50 67 48 64 72 2e 70 67 6e 6f 20   for PgHdr.pgno 
0760: 2a 2f 0a 20 20 50 67 48 64 72 20 2a 70 4e 65 78  */.  PgHdr *pNex
0770: 74 2c 20 2a 70 50 72 65 76 3b 20 20 20 20 20 20  t, *pPrev;      
0780: 20 20 20 20 2f 2a 20 4c 69 73 74 20 6f 66 20 63      /* List of c
0790: 6c 65 61 6e 20 6f 72 20 64 69 72 74 79 20 70 61  lean or dirty pa
07a0: 67 65 73 20 2a 2f 0a 20 20 50 67 48 64 72 20 2a  ges */.  PgHdr *
07b0: 70 4e 65 78 74 4c 72 75 2c 20 2a 70 50 72 65 76  pNextLru, *pPrev
07c0: 4c 72 75 3b 20 20 20 20 2f 2a 20 50 61 72 74 20  Lru;    /* Part 
07d0: 6f 66 20 67 6c 6f 62 61 6c 20 4c 52 55 20 6c 69  of global LRU li
07e0: 73 74 20 2a 2f 0a 7d 3b 0a 0a 2f 2a 20 42 69 74  st */.};../* Bit
07f0: 20 76 61 6c 75 65 73 20 66 6f 72 20 50 67 48 64   values for PgHd
0800: 72 2e 66 6c 61 67 73 20 2a 2f 0a 23 64 65 66 69  r.flags */.#defi
0810: 6e 65 20 50 47 48 44 52 5f 49 4e 5f 4a 4f 55 52  ne PGHDR_IN_JOUR
0820: 4e 41 4c 20 20 20 20 20 20 20 20 30 78 30 30 31  NAL        0x001
0830: 20 20 2f 2a 20 50 61 67 65 20 69 73 20 69 6e 20    /* Page is in 
0840: 72 6f 6c 6c 62 61 63 6b 20 6a 6f 75 72 6e 61 6c  rollback journal
0850: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 47 48 44   */.#define PGHD
0860: 52 5f 44 49 52 54 59 20 20 20 20 20 20 20 20 20  R_DIRTY         
0870: 20 20 20 20 30 78 30 30 32 20 20 2f 2a 20 50 61      0x002  /* Pa
0880: 67 65 20 68 61 73 20 63 68 61 6e 67 65 64 20 2a  ge has changed *
0890: 2f 0a 23 64 65 66 69 6e 65 20 50 47 48 44 52 5f  /.#define PGHDR_
08a0: 4e 45 45 44 5f 53 59 4e 43 20 20 20 20 20 20 20  NEED_SYNC       
08b0: 20 20 30 78 30 30 34 20 20 2f 2a 20 46 73 79 6e    0x004  /* Fsyn
08c0: 63 20 74 68 65 20 72 6f 6c 6c 62 61 63 6b 20 6a  c the rollback j
08d0: 6f 75 72 6e 61 6c 20 62 65 66 6f 72 65 0a 20 20  ournal before.  
08e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
08f0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0900: 20 20 20 20 20 2a 2a 20 77 72 69 74 69 6e 67 20       ** writing 
0910: 74 68 69 73 20 70 61 67 65 20 74 6f 20 74 68 65  this page to the
0920: 20 64 61 74 61 62 61 73 65 20 2a 2f 0a 23 64 65   database */.#de
0930: 66 69 6e 65 20 50 47 48 44 52 5f 4e 45 45 44 5f  fine PGHDR_NEED_
0940: 52 45 41 44 20 20 20 20 20 20 20 20 20 30 78 30  READ         0x0
0950: 30 38 20 20 2f 2a 20 43 6f 6e 74 65 6e 74 20 69  08  /* Content i
0960: 73 20 75 6e 72 65 61 64 20 2a 2f 0a 23 64 65 66  s unread */.#def
0970: 69 6e 65 20 50 47 48 44 52 5f 52 45 55 53 45 5f  ine PGHDR_REUSE_
0980: 55 4e 4c 49 4b 45 4c 59 20 20 20 20 30 78 30 31  UNLIKELY    0x01
0990: 30 20 20 2f 2a 20 41 20 68 69 6e 74 20 74 68 61  0  /* A hint tha
09a0: 74 20 72 65 75 73 65 20 69 73 20 75 6e 6c 69 6b  t reuse is unlik
09b0: 65 6c 79 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50  ely */.#define P
09c0: 47 48 44 52 5f 44 4f 4e 54 5f 57 52 49 54 45 20  GHDR_DONT_WRITE 
09d0: 20 20 20 20 20 20 20 30 78 30 32 30 20 20 2f 2a         0x020  /*
09e0: 20 44 6f 20 6e 6f 74 20 77 72 69 74 65 20 63 6f   Do not write co
09f0: 6e 74 65 6e 74 20 74 6f 20 64 69 73 6b 20 2a 2f  ntent to disk */
0a00: 0a 0a 2f 2a 20 49 6e 69 74 69 61 6c 69 7a 65 20  ../* Initialize 
0a10: 61 6e 64 20 73 68 75 74 64 6f 77 6e 20 74 68 65  and shutdown the
0a20: 20 70 61 67 65 20 63 61 63 68 65 20 73 75 62 73   page cache subs
0a30: 79 73 74 65 6d 20 2a 2f 0a 69 6e 74 20 73 71 6c  ystem */.int sql
0a40: 69 74 65 33 50 63 61 63 68 65 49 6e 69 74 69 61  ite3PcacheInitia
0a50: 6c 69 7a 65 28 76 6f 69 64 29 3b 0a 76 6f 69 64  lize(void);.void
0a60: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 53 68   sqlite3PcacheSh
0a70: 75 74 64 6f 77 6e 28 76 6f 69 64 29 3b 0a 0a 2f  utdown(void);../
0a80: 2a 20 50 61 67 65 20 63 61 63 68 65 20 62 75 66  * Page cache buf
0a90: 66 65 72 20 6d 61 6e 61 67 65 6d 65 6e 74 3a 0a  fer management:.
0aa0: 2a 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65  ** These routine
0ab0: 73 20 69 6d 70 6c 65 6d 65 6e 74 20 53 51 4c 49  s implement SQLI
0ac0: 54 45 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43 41  TE_CONFIG_PAGECA
0ad0: 43 48 45 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c  CHE..*/.void sql
0ae0: 69 74 65 33 50 43 61 63 68 65 42 75 66 66 65 72  ite3PCacheBuffer
0af0: 53 65 74 75 70 28 76 6f 69 64 20 2a 2c 20 69 6e  Setup(void *, in
0b00: 74 20 73 7a 2c 20 69 6e 74 20 6e 29 3b 0a 76 6f  t sz, int n);.vo
0b10: 69 64 20 2a 73 71 6c 69 74 65 33 50 43 61 63 68  id *sqlite3PCach
0b20: 65 4d 61 6c 6c 6f 63 28 69 6e 74 20 73 7a 29 3b  eMalloc(int sz);
0b30: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 43 61  .void sqlite3PCa
0b40: 63 68 65 46 72 65 65 28 76 6f 69 64 2a 29 3b 0a  cheFree(void*);.
0b50: 0a 2f 2a 20 43 72 65 61 74 65 20 61 20 6e 65 77  ./* Create a new
0b60: 20 70 61 67 65 72 20 63 61 63 68 65 2e 0a 2a 2a   pager cache..**
0b70: 20 55 6e 64 65 72 20 6d 65 6d 6f 72 79 20 73 74   Under memory st
0b80: 72 65 73 73 2c 20 69 6e 76 6f 6b 65 20 78 53 74  ress, invoke xSt
0b90: 72 65 73 73 20 74 6f 20 74 72 79 20 74 6f 20 6d  ress to try to m
0ba0: 61 6b 65 20 70 61 67 65 73 20 63 6c 65 61 6e 2e  ake pages clean.
0bb0: 0a 2a 2a 20 4f 6e 6c 79 20 63 6c 65 61 6e 20 61  .** Only clean a
0bc0: 6e 64 20 75 6e 70 69 6e 6e 65 64 20 70 61 67 65  nd unpinned page
0bd0: 73 20 63 61 6e 20 62 65 20 72 65 63 6c 61 69 6d  s can be reclaim
0be0: 65 64 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c 69  ed..*/.void sqli
0bf0: 74 65 33 50 63 61 63 68 65 4f 70 65 6e 28 0a 20  te3PcacheOpen(. 
0c00: 20 69 6e 74 20 73 7a 50 61 67 65 2c 20 20 20 20   int szPage,    
0c10: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0c20: 2f 2a 20 53 69 7a 65 20 6f 66 20 65 76 65 72 79  /* Size of every
0c30: 20 70 61 67 65 20 2a 2f 0a 20 20 69 6e 74 20 73   page */.  int s
0c40: 7a 45 78 74 72 61 2c 20 20 20 20 20 20 20 20 20  zExtra,         
0c50: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 45 78 74            /* Ext
0c60: 72 61 20 73 70 61 63 65 20 61 73 73 6f 63 69 61  ra space associa
0c70: 74 65 64 20 77 69 74 68 20 65 61 63 68 20 70 61  ted with each pa
0c80: 67 65 20 2a 2f 0a 20 20 69 6e 74 20 62 50 75 72  ge */.  int bPur
0c90: 67 65 61 62 6c 65 2c 20 20 20 20 20 20 20 20 20  geable,         
0ca0: 20 20 20 20 20 20 20 2f 2a 20 54 72 75 65 20 69         /* True i
0cb0: 66 20 70 61 67 65 73 20 61 72 65 20 6f 6e 20 62  f pages are on b
0cc0: 61 63 6b 69 6e 67 20 73 74 6f 72 65 20 2a 2f 0a  acking store */.
0cd0: 20 20 69 6e 74 20 28 2a 78 53 74 72 65 73 73 29    int (*xStress)
0ce0: 28 76 6f 69 64 2a 2c 20 50 67 48 64 72 2a 29 2c  (void*, PgHdr*),
0cf0: 20 2f 2a 20 43 61 6c 6c 20 74 6f 20 74 72 79 20   /* Call to try 
0d00: 74 6f 20 6d 61 6b 65 20 70 61 67 65 73 20 63 6c  to make pages cl
0d10: 65 61 6e 20 2a 2f 0a 20 20 76 6f 69 64 20 2a 70  ean */.  void *p
0d20: 53 74 72 65 73 73 2c 20 20 20 20 20 20 20 20 20  Stress,         
0d30: 20 20 20 20 20 20 20 20 2f 2a 20 41 72 67 75 6d          /* Argum
0d40: 65 6e 74 20 74 6f 20 78 53 74 72 65 73 73 20 2a  ent to xStress *
0d50: 2f 0a 20 20 50 43 61 63 68 65 20 2a 70 54 6f 49  /.  PCache *pToI
0d60: 6e 69 74 20 20 20 20 20 20 20 20 20 20 20 20 20  nit             
0d70: 20 20 20 2f 2a 20 50 72 65 61 6c 6c 6f 63 61 74     /* Preallocat
0d80: 65 64 20 73 70 61 63 65 20 66 6f 72 20 74 68 65  ed space for the
0d90: 20 50 43 61 63 68 65 20 2a 2f 0a 29 3b 0a 0a 2f   PCache */.);../
0da0: 2a 20 4d 6f 64 69 66 79 20 74 68 65 20 70 61 67  * Modify the pag
0db0: 65 2d 73 69 7a 65 20 61 66 74 65 72 20 74 68 65  e-size after the
0dc0: 20 63 61 63 68 65 20 68 61 73 20 62 65 65 6e 20   cache has been 
0dd0: 63 72 65 61 74 65 64 2e 20 2a 2f 0a 76 6f 69 64  created. */.void
0de0: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 53 65   sqlite3PcacheSe
0df0: 74 50 61 67 65 53 69 7a 65 28 50 43 61 63 68 65  tPageSize(PCache
0e00: 20 2a 2c 20 69 6e 74 29 3b 0a 0a 2f 2a 20 52 65   *, int);../* Re
0e10: 74 75 72 6e 20 74 68 65 20 73 69 7a 65 20 69 6e  turn the size in
0e20: 20 62 79 74 65 73 20 6f 66 20 61 20 50 43 61 63   bytes of a PCac
0e30: 68 65 20 6f 62 6a 65 63 74 2e 20 20 55 73 65 64  he object.  Used
0e40: 20 74 6f 20 70 72 65 61 6c 6c 6f 63 61 74 65 0a   to preallocate.
0e50: 2a 2a 20 73 74 6f 72 61 67 65 20 73 70 61 63 65  ** storage space
0e60: 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
0e70: 50 63 61 63 68 65 53 69 7a 65 28 76 6f 69 64 29  PcacheSize(void)
0e80: 3b 0a 0a 2f 2a 20 4f 6e 65 20 72 65 6c 65 61 73  ;../* One releas
0e90: 65 20 70 65 72 20 73 75 63 63 65 73 73 66 75 6c  e per successful
0ea0: 20 66 65 74 63 68 2e 20 20 50 61 67 65 20 69 73   fetch.  Page is
0eb0: 20 70 69 6e 6e 65 64 20 75 6e 74 69 6c 20 72 65   pinned until re
0ec0: 6c 65 61 73 65 64 2e 0a 2a 2a 20 52 65 66 65 72  leased..** Refer
0ed0: 65 6e 63 65 20 63 6f 75 6e 74 65 64 2e 20 0a 2a  ence counted. .*
0ee0: 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61  /.int sqlite3Pca
0ef0: 63 68 65 46 65 74 63 68 28 50 43 61 63 68 65 2a  cheFetch(PCache*
0f00: 2c 20 50 67 6e 6f 2c 20 69 6e 74 20 63 72 65 61  , Pgno, int crea
0f10: 74 65 46 6c 61 67 2c 20 50 67 48 64 72 2a 2a 29  teFlag, PgHdr**)
0f20: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  ;.void sqlite3Pc
0f30: 61 63 68 65 52 65 6c 65 61 73 65 28 50 67 48 64  acheRelease(PgHd
0f40: 72 2a 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69 74  r*);..void sqlit
0f50: 65 33 50 63 61 63 68 65 44 72 6f 70 28 50 67 48  e3PcacheDrop(PgH
0f60: 64 72 2a 29 3b 20 20 20 20 20 20 20 20 20 2f 2a  dr*);         /*
0f70: 20 52 65 6d 6f 76 65 20 70 61 67 65 20 66 72 6f   Remove page fro
0f80: 6d 20 63 61 63 68 65 20 2a 2f 0a 76 6f 69 64 20  m cache */.void 
0f90: 73 71 6c 69 74 65 33 50 63 61 63 68 65 4d 61 6b  sqlite3PcacheMak
0fa0: 65 44 69 72 74 79 28 50 67 48 64 72 2a 29 3b 20  eDirty(PgHdr*); 
0fb0: 20 20 20 2f 2a 20 4d 61 6b 65 20 73 75 72 65 20     /* Make sure 
0fc0: 70 61 67 65 20 69 73 20 6d 61 72 6b 65 64 20 64  page is marked d
0fd0: 69 72 74 79 20 2a 2f 0a 76 6f 69 64 20 73 71 6c  irty */.void sql
0fe0: 69 74 65 33 50 63 61 63 68 65 4d 61 6b 65 43 6c  ite3PcacheMakeCl
0ff0: 65 61 6e 28 50 67 48 64 72 2a 29 3b 20 20 20 20  ean(PgHdr*);    
1000: 2f 2a 20 4d 61 72 6b 20 61 20 73 69 6e 67 6c 65  /* Mark a single
1010: 20 70 61 67 65 20 61 73 20 63 6c 65 61 6e 20 2a   page as clean *
1020: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  /.void sqlite3Pc
1030: 61 63 68 65 43 6c 65 61 6e 41 6c 6c 28 50 43 61  acheCleanAll(PCa
1040: 63 68 65 2a 29 3b 20 20 20 20 2f 2a 20 4d 61 72  che*);    /* Mar
1050: 6b 20 61 6c 6c 20 64 69 72 74 79 20 6c 69 73 74  k all dirty list
1060: 20 70 61 67 65 73 20 61 73 20 63 6c 65 61 6e 20   pages as clean 
1070: 2a 2f 0a 0a 2f 2a 20 43 68 61 6e 67 65 20 61 20  */../* Change a 
1080: 70 61 67 65 20 6e 75 6d 62 65 72 2e 20 20 55 73  page number.  Us
1090: 65 64 20 62 79 20 69 6e 63 72 2d 76 61 63 75 75  ed by incr-vacuu
10a0: 6d 2e 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74  m. */.void sqlit
10b0: 65 33 50 63 61 63 68 65 4d 6f 76 65 28 50 67 48  e3PcacheMove(PgH
10c0: 64 72 2a 2c 20 50 67 6e 6f 29 3b 0a 0a 2f 2a 20  dr*, Pgno);../* 
10d0: 52 65 6d 6f 76 65 20 61 6c 6c 20 70 61 67 65 73  Remove all pages
10e0: 20 77 69 74 68 20 70 67 6e 6f 3e 78 2e 20 20 52   with pgno>x.  R
10f0: 65 73 65 74 20 74 68 65 20 63 61 63 68 65 20 69  eset the cache i
1100: 66 20 78 3d 3d 30 20 2a 2f 0a 76 6f 69 64 20 73  f x==0 */.void s
1110: 71 6c 69 74 65 33 50 63 61 63 68 65 54 72 75 6e  qlite3PcacheTrun
1120: 63 61 74 65 28 50 43 61 63 68 65 2a 2c 20 50 67  cate(PCache*, Pg
1130: 6e 6f 20 78 29 3b 0a 0a 2f 2a 20 47 65 74 20 61  no x);../* Get a
1140: 20 6c 69 73 74 20 6f 66 20 61 6c 6c 20 64 69 72   list of all dir
1150: 74 79 20 70 61 67 65 73 20 69 6e 20 74 68 65 20  ty pages in the 
1160: 63 61 63 68 65 2c 20 73 6f 72 74 65 64 20 62 79  cache, sorted by
1170: 20 70 61 67 65 20 6e 75 6d 62 65 72 20 2a 2f 0a   page number */.
1180: 50 67 48 64 72 20 2a 73 71 6c 69 74 65 33 50 63  PgHdr *sqlite3Pc
1190: 61 63 68 65 44 69 72 74 79 4c 69 73 74 28 50 43  acheDirtyList(PC
11a0: 61 63 68 65 2a 29 3b 0a 0a 2f 2a 20 52 65 73 65  ache*);../* Rese
11b0: 74 20 61 6e 64 20 63 6c 6f 73 65 20 74 68 65 20  t and close the 
11c0: 63 61 63 68 65 20 6f 62 6a 65 63 74 20 2a 2f 0a  cache object */.
11d0: 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63  void sqlite3Pcac
11e0: 68 65 43 6c 6f 73 65 28 50 43 61 63 68 65 2a 29  heClose(PCache*)
11f0: 3b 0a 0a 2f 2a 20 43 6c 65 61 72 20 66 6c 61 67  ;../* Clear flag
1200: 73 20 66 72 6f 6d 20 70 61 67 65 73 20 6f 66 20  s from pages of 
1210: 74 68 65 20 70 61 67 65 20 63 61 63 68 65 20 2a  the page cache *
1220: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  /.void sqlite3Pc
1230: 61 63 68 65 43 6c 65 61 72 46 6c 61 67 73 28 50  acheClearFlags(P
1240: 43 61 63 68 65 2a 2c 20 69 6e 74 20 6d 61 73 6b  Cache*, int mask
1250: 29 3b 0a 0a 2f 2a 20 41 73 73 65 72 74 20 66 6c  );../* Assert fl
1260: 61 67 73 20 73 65 74 74 69 6e 67 73 20 6f 6e 20  ags settings on 
1270: 61 6c 6c 20 70 61 67 65 73 2e 20 20 44 65 62 75  all pages.  Debu
1280: 67 67 69 6e 67 20 6f 6e 6c 79 20 2a 2f 0a 23 69  gging only */.#i
1290: 66 6e 64 65 66 20 4e 44 45 42 55 47 0a 20 20 76  fndef NDEBUG.  v
12a0: 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68  oid sqlite3Pcach
12b0: 65 41 73 73 65 72 74 46 6c 61 67 73 28 50 43 61  eAssertFlags(PCa
12c0: 63 68 65 2a 2c 20 69 6e 74 20 74 72 75 65 4d 61  che*, int trueMa
12d0: 73 6b 2c 20 69 6e 74 20 66 61 6c 73 65 4d 61 73  sk, int falseMas
12e0: 6b 29 3b 0a 23 65 6c 73 65 0a 23 20 64 65 66 69  k);.#else.# defi
12f0: 6e 65 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  ne sqlite3Pcache
1300: 41 73 73 65 72 74 46 6c 61 67 73 28 41 2c 42 2c  AssertFlags(A,B,
1310: 43 29 0a 23 65 6e 64 69 66 0a 0a 2f 2a 20 52 65  C).#endif../* Re
1320: 74 75 72 6e 20 74 72 75 65 20 69 66 20 74 68 65  turn true if the
1330: 20 6e 75 6d 62 65 72 20 6f 66 20 64 69 72 74 79   number of dirty
1340: 20 70 61 67 65 73 20 69 73 20 30 20 6f 72 20 31   pages is 0 or 1
1350: 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50   */.int sqlite3P
1360: 63 61 63 68 65 5a 65 72 6f 4f 72 4f 6e 65 44 69  cacheZeroOrOneDi
1370: 72 74 79 50 61 67 65 73 28 50 43 61 63 68 65 2a  rtyPages(PCache*
1380: 29 3b 0a 0a 2f 2a 20 44 69 73 63 61 72 64 20 74  );../* Discard t
1390: 68 65 20 63 6f 6e 74 65 6e 74 73 20 6f 66 20 74  he contents of t
13a0: 68 65 20 63 61 63 68 65 20 2a 2f 0a 69 6e 74 20  he cache */.int 
13b0: 73 71 6c 69 74 65 33 50 63 61 63 68 65 43 6c 65  sqlite3PcacheCle
13c0: 61 72 28 50 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a  ar(PCache*);../*
13d0: 20 52 65 74 75 72 6e 20 74 68 65 20 74 6f 74 61   Return the tota
13e0: 6c 20 6e 75 6d 62 65 72 20 6f 66 20 6f 75 74 73  l number of outs
13f0: 74 61 6e 64 69 6e 67 20 70 61 67 65 20 72 65 66  tanding page ref
1400: 65 72 65 6e 63 65 73 20 2a 2f 0a 69 6e 74 20 73  erences */.int s
1410: 71 6c 69 74 65 33 50 63 61 63 68 65 52 65 66 43  qlite3PcacheRefC
1420: 6f 75 6e 74 28 50 43 61 63 68 65 2a 29 3b 0a 0a  ount(PCache*);..
1430: 2f 2a 20 49 6e 63 72 65 6d 65 6e 74 20 74 68 65  /* Increment the
1440: 20 72 65 66 65 72 65 6e 63 65 20 63 6f 75 6e 74   reference count
1450: 20 6f 66 20 61 6e 20 65 78 69 73 74 69 6e 67 20   of an existing 
1460: 70 61 67 65 20 2a 2f 0a 76 6f 69 64 20 73 71 6c  page */.void sql
1470: 69 74 65 33 50 63 61 63 68 65 52 65 66 28 50 67  ite3PcacheRef(Pg
1480: 48 64 72 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69  Hdr*);..int sqli
1490: 74 65 33 50 63 61 63 68 65 50 61 67 65 52 65 66  te3PcachePageRef
14a0: 63 6f 75 6e 74 28 50 67 48 64 72 2a 29 3b 0a 0a  count(PgHdr*);..
14b0: 2f 2a 20 52 65 74 75 72 6e 20 74 68 65 20 74 6f  /* Return the to
14c0: 74 61 6c 20 6e 75 6d 62 65 72 20 6f 66 20 70 61  tal number of pa
14d0: 67 65 73 20 73 74 6f 72 65 64 20 69 6e 20 74 68  ges stored in th
14e0: 65 20 63 61 63 68 65 20 2a 2f 0a 69 6e 74 20 73  e cache */.int s
14f0: 71 6c 69 74 65 33 50 63 61 63 68 65 50 61 67 65  qlite3PcachePage
1500: 63 6f 75 6e 74 28 50 43 61 63 68 65 2a 29 3b 0a  count(PCache*);.
1510: 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 43  .#ifdef SQLITE_C
1520: 48 45 43 4b 5f 50 41 47 45 53 0a 2f 2a 20 49 74  HECK_PAGES./* It
1530: 65 72 61 74 65 20 74 68 72 6f 75 67 68 20 61 6c  erate through al
1540: 6c 20 70 61 67 65 73 20 63 75 72 72 65 6e 74 6c  l pages currentl
1550: 79 20 73 74 6f 72 65 64 20 69 6e 20 74 68 65 20  y stored in the 
1560: 63 61 63 68 65 2e 20 54 68 69 73 20 69 6e 74 65  cache. This inte
1570: 72 66 61 63 65 0a 2a 2a 20 69 73 20 6f 6e 6c 79  rface.** is only
1580: 20 61 76 61 69 6c 61 62 6c 65 20 69 66 20 53 51   available if SQ
1590: 4c 49 54 45 5f 43 48 45 43 4b 5f 50 41 47 45 53  LITE_CHECK_PAGES
15a0: 20 69 73 20 64 65 66 69 6e 65 64 20 77 68 65 6e   is defined when
15b0: 20 74 68 65 20 6c 69 62 72 61 72 79 20 69 73 20   the library is 
15c0: 0a 2a 2a 20 62 75 69 6c 74 2e 0a 2a 2f 0a 76 6f  .** built..*/.vo
15d0: 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  id sqlite3Pcache
15e0: 49 74 65 72 61 74 65 28 50 43 61 63 68 65 20 2a  Iterate(PCache *
15f0: 70 43 61 63 68 65 2c 20 76 6f 69 64 20 28 2a 78  pCache, void (*x
1600: 49 74 65 72 29 28 50 67 48 64 72 20 2a 29 29 3b  Iter)(PgHdr *));
1610: 0a 23 65 6e 64 69 66 0a 0a 2f 2a 20 53 65 74 20  .#endif../* Set 
1620: 61 6e 64 20 67 65 74 20 74 68 65 20 73 75 67 67  and get the sugg
1630: 65 73 74 65 64 20 63 61 63 68 65 2d 73 69 7a 65  ested cache-size
1640: 20 66 6f 72 20 74 68 65 20 73 70 65 63 69 66 69   for the specifi
1650: 65 64 20 70 61 67 65 72 2d 63 61 63 68 65 2e 0a  ed pager-cache..
1660: 2a 2a 0a 2a 2a 20 49 66 20 6e 6f 20 67 6c 6f 62  **.** If no glob
1670: 61 6c 20 6d 61 78 69 6d 75 6d 20 69 73 20 63 6f  al maximum is co
1680: 6e 66 69 67 75 72 65 64 2c 20 74 68 65 6e 20 74  nfigured, then t
1690: 68 65 20 73 79 73 74 65 6d 20 61 74 74 65 6d 70  he system attemp
16a0: 74 73 20 74 6f 20 6c 69 6d 69 74 0a 2a 2a 20 74  ts to limit.** t
16b0: 68 65 20 74 6f 74 61 6c 20 6e 75 6d 62 65 72 20  he total number 
16c0: 6f 66 20 70 61 67 65 73 20 63 61 63 68 65 64 20  of pages cached 
16d0: 62 79 20 70 75 72 67 65 61 62 6c 65 20 70 61 67  by purgeable pag
16e0: 65 72 2d 63 61 63 68 65 73 20 74 6f 20 74 68 65  er-caches to the
16f0: 20 73 75 6d 0a 2a 2a 20 6f 66 20 74 68 65 20 73   sum.** of the s
1700: 75 67 67 65 73 74 65 64 20 63 61 63 68 65 2d 73  uggested cache-s
1710: 69 7a 65 73 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  izes..*/.int sql
1720: 69 74 65 33 50 63 61 63 68 65 47 65 74 43 61 63  ite3PcacheGetCac
1730: 68 65 73 69 7a 65 28 50 43 61 63 68 65 20 2a 29  hesize(PCache *)
1740: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  ;.void sqlite3Pc
1750: 61 63 68 65 53 65 74 43 61 63 68 65 73 69 7a 65  acheSetCachesize
1760: 28 50 43 61 63 68 65 20 2a 2c 20 69 6e 74 29 3b  (PCache *, int);
1770: 0a 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f  ..#ifdef SQLITE_
1780: 45 4e 41 42 4c 45 5f 4d 45 4d 4f 52 59 5f 4d 41  ENABLE_MEMORY_MA
1790: 4e 41 47 45 4d 45 4e 54 0a 2f 2a 20 54 72 79 20  NAGEMENT./* Try 
17a0: 74 6f 20 72 65 74 75 72 6e 20 6d 65 6d 6f 72 79  to return memory
17b0: 20 75 73 65 64 20 62 79 20 74 68 65 20 70 63 61   used by the pca
17c0: 63 68 65 20 6d 6f 64 75 6c 65 20 74 6f 20 74 68  che module to th
17d0: 65 20 6d 61 69 6e 20 6d 65 6d 6f 72 79 20 68 65  e main memory he
17e0: 61 70 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  ap */.int sqlite
17f0: 33 50 63 61 63 68 65 52 65 6c 65 61 73 65 4d 65  3PcacheReleaseMe
1800: 6d 6f 72 79 28 69 6e 74 29 3b 0a 23 65 6e 64 69  mory(int);.#endi
1810: 66 0a 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45  f..#ifdef SQLITE
1820: 5f 54 45 53 54 0a 76 6f 69 64 20 73 71 6c 69 74  _TEST.void sqlit
1830: 65 33 50 63 61 63 68 65 53 74 61 74 73 28 69 6e  e3PcacheStats(in
1840: 74 2a 2c 69 6e 74 2a 2c 69 6e 74 2a 2c 69 6e 74  t*,int*,int*,int
1850: 2a 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 65 6e 64  *);.#endif..#end
1860: 69 66 20 2f 2a 20 5f 50 43 41 43 48 45 5f 48 5f  if /* _PCACHE_H_
1870: 20 2a 2f 0a                                       */.