/ Hex Artifact Content
Login

Artifact 33b40350df1b6c278e019dee37f87e1bac276223:


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 73 6f 72 74 65 64   of dirty sorted
0370: 20 62 79 20 70 67 6e 6f 20 2a 2f 0a 20 20 50 61   by pgno */.  Pa
0380: 67 65 72 20 2a 70 50 61 67 65 72 3b 20 20 20 20  ger *pPager;    
0390: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
03a0: 54 68 65 20 70 61 67 65 72 20 74 68 69 73 20 70  The pager this p
03b0: 61 67 65 20 69 73 20 70 61 72 74 20 6f 66 20 2a  age is part of *
03c0: 2f 0a 20 20 50 67 6e 6f 20 70 67 6e 6f 3b 20 20  /.  Pgno pgno;  
03d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
03e0: 20 20 20 2f 2a 20 50 61 67 65 20 6e 75 6d 62 65     /* Page numbe
03f0: 72 20 66 6f 72 20 74 68 69 73 20 70 61 67 65 20  r for this page 
0400: 2a 2f 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45  */.#ifdef SQLITE
0410: 5f 43 48 45 43 4b 5f 50 41 47 45 53 0a 20 20 75  _CHECK_PAGES.  u
0420: 33 32 20 70 61 67 65 48 61 73 68 3b 20 20 20 20  32 pageHash;    
0430: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a                /*
0440: 20 48 61 73 68 20 6f 66 20 70 61 67 65 20 63 6f   Hash of page co
0450: 6e 74 65 6e 74 20 2a 2f 0a 23 65 6e 64 69 66 0a  ntent */.#endif.
0460: 20 20 75 31 36 20 66 6c 61 67 73 3b 20 20 20 20    u16 flags;    
0470: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0480: 20 2f 2a 20 50 47 48 44 52 20 66 6c 61 67 73 20   /* PGHDR flags 
0490: 64 65 66 69 6e 65 64 20 62 65 6c 6f 77 20 2a 2f  defined below */
04a0: 0a 0a 20 20 2f 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 2a 2a 2a 2a 2a 2a 2a 2a 2a 0a 20 20 2a 2a  ***********.  **
04f0: 20 45 6c 65 6d 65 6e 74 73 20 61 62 6f 76 65 20   Elements above 
0500: 61 72 65 20 70 75 62 6c 69 63 2e 20 20 41 6c 6c  are public.  All
0510: 20 74 68 61 74 20 66 6f 6c 6c 6f 77 73 20 69 73   that follows is
0520: 20 70 72 69 76 61 74 65 20 74 6f 20 70 63 61 63   private to pcac
0530: 68 65 2e 63 0a 20 20 2a 2a 20 61 6e 64 20 73 68  he.c.  ** and sh
0540: 6f 75 6c 64 20 6e 6f 74 20 62 65 20 61 63 63 65  ould not be acce
0550: 73 73 65 64 20 62 79 20 6f 74 68 65 72 20 6d 6f  ssed by other mo
0560: 64 75 6c 65 73 2e 0a 20 20 2a 2f 0a 20 20 69 31  dules..  */.  i1
0570: 36 20 6e 52 65 66 3b 20 20 20 20 20 20 20 20 20  6 nRef;         
0580: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
0590: 4e 75 6d 62 65 72 20 6f 66 20 75 73 65 72 73 20  Number of users 
05a0: 6f 66 20 74 68 69 73 20 70 61 67 65 20 2a 2f 0a  of this page */.
05b0: 20 20 50 43 61 63 68 65 20 2a 70 43 61 63 68 65    PCache *pCache
05c0: 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ;               
05d0: 20 2f 2a 20 43 61 63 68 65 20 74 68 61 74 20 6f   /* Cache that o
05e0: 77 6e 73 20 74 68 69 73 20 70 61 67 65 20 2a 2f  wns this page */
05f0: 0a 0a 20 20 50 67 48 64 72 20 2a 70 44 69 72 74  ..  PgHdr *pDirt
0600: 79 4e 65 78 74 3b 20 20 20 20 20 20 20 20 20 20  yNext;          
0610: 20 20 20 2f 2a 20 4e 65 78 74 20 65 6c 65 6d 65     /* Next eleme
0620: 6e 74 20 69 6e 20 6c 69 73 74 20 6f 66 20 64 69  nt in list of di
0630: 72 74 79 20 70 61 67 65 73 20 2a 2f 0a 20 20 50  rty pages */.  P
0640: 67 48 64 72 20 2a 70 44 69 72 74 79 50 72 65 76  gHdr *pDirtyPrev
0650: 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a  ;             /*
0660: 20 50 72 65 76 69 6f 75 73 20 65 6c 65 6d 65 6e   Previous elemen
0670: 74 20 69 6e 20 6c 69 73 74 20 6f 66 20 64 69 72  t in list of dir
0680: 74 79 20 70 61 67 65 73 20 2a 2f 0a 7d 3b 0a 0a  ty pages */.};..
0690: 2f 2a 20 42 69 74 20 76 61 6c 75 65 73 20 66 6f  /* Bit values fo
06a0: 72 20 50 67 48 64 72 2e 66 6c 61 67 73 20 2a 2f  r PgHdr.flags */
06b0: 0a 23 64 65 66 69 6e 65 20 50 47 48 44 52 5f 43  .#define PGHDR_C
06c0: 4c 45 41 4e 20 20 20 20 20 20 20 20 20 20 20 30  LEAN           0
06d0: 78 30 30 31 20 20 2f 2a 20 50 61 67 65 20 6e 6f  x001  /* Page no
06e0: 74 20 6f 6e 20 74 68 65 20 50 43 61 63 68 65 2e  t on the PCache.
06f0: 70 44 69 72 74 79 20 6c 69 73 74 20 2a 2f 0a 23  pDirty list */.#
0700: 64 65 66 69 6e 65 20 50 47 48 44 52 5f 44 49 52  define PGHDR_DIR
0710: 54 59 20 20 20 20 20 20 20 20 20 20 20 30 78 30  TY           0x0
0720: 30 32 20 20 2f 2a 20 50 61 67 65 20 69 73 20 6f  02  /* Page is o
0730: 6e 20 74 68 65 20 50 43 61 63 68 65 2e 70 44 69  n the PCache.pDi
0740: 72 74 79 20 6c 69 73 74 20 2a 2f 0a 23 64 65 66  rty list */.#def
0750: 69 6e 65 20 50 47 48 44 52 5f 57 52 49 54 45 41  ine PGHDR_WRITEA
0760: 42 4c 45 20 20 20 20 20 20 20 30 78 30 30 34 20  BLE       0x004 
0770: 20 2f 2a 20 4a 6f 75 72 6e 61 6c 65 64 20 61 6e   /* Journaled an
0780: 64 20 72 65 61 64 79 20 74 6f 20 6d 6f 64 69 66  d ready to modif
0790: 79 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 47 48  y */.#define PGH
07a0: 44 52 5f 4e 45 45 44 5f 53 59 4e 43 20 20 20 20  DR_NEED_SYNC    
07b0: 20 20 20 30 78 30 30 38 20 20 2f 2a 20 46 73 79     0x008  /* Fsy
07c0: 6e 63 20 74 68 65 20 72 6f 6c 6c 62 61 63 6b 20  nc the rollback 
07d0: 6a 6f 75 72 6e 61 6c 20 62 65 66 6f 72 65 0a 20  journal before. 
07e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
07f0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0800: 20 20 20 20 2a 2a 20 77 72 69 74 69 6e 67 20 74      ** writing t
0810: 68 69 73 20 70 61 67 65 20 74 6f 20 74 68 65 20  his page to the 
0820: 64 61 74 61 62 61 73 65 20 2a 2f 0a 23 64 65 66  database */.#def
0830: 69 6e 65 20 50 47 48 44 52 5f 4e 45 45 44 5f 52  ine PGHDR_NEED_R
0840: 45 41 44 20 20 20 20 20 20 20 30 78 30 31 30 20  EAD       0x010 
0850: 20 2f 2a 20 43 6f 6e 74 65 6e 74 20 69 73 20 75   /* Content is u
0860: 6e 72 65 61 64 20 2a 2f 0a 23 64 65 66 69 6e 65  nread */.#define
0870: 20 50 47 48 44 52 5f 44 4f 4e 54 5f 57 52 49 54   PGHDR_DONT_WRIT
0880: 45 20 20 20 20 20 20 30 78 30 32 30 20 20 2f 2a  E      0x020  /*
0890: 20 44 6f 20 6e 6f 74 20 77 72 69 74 65 20 63 6f   Do not write co
08a0: 6e 74 65 6e 74 20 74 6f 20 64 69 73 6b 20 2a 2f  ntent to disk */
08b0: 0a 23 64 65 66 69 6e 65 20 50 47 48 44 52 5f 4d  .#define PGHDR_M
08c0: 4d 41 50 20 20 20 20 20 20 20 20 20 20 20 20 30  MAP            0
08d0: 78 30 34 30 20 20 2f 2a 20 54 68 69 73 20 69 73  x040  /* This is
08e0: 20 61 6e 20 6d 6d 61 70 20 70 61 67 65 20 6f 62   an mmap page ob
08f0: 6a 65 63 74 20 2a 2f 0a 0a 23 64 65 66 69 6e 65  ject */..#define
0900: 20 50 47 48 44 52 5f 57 41 4c 5f 41 50 50 45 4e   PGHDR_WAL_APPEN
0910: 44 20 20 20 20 20 20 30 78 30 38 30 20 20 2f 2a  D      0x080  /*
0920: 20 41 70 70 65 6e 64 65 64 20 74 6f 20 77 61 6c   Appended to wal
0930: 20 66 69 6c 65 20 2a 2f 0a 0a 2f 2a 20 49 6e 69   file */../* Ini
0940: 74 69 61 6c 69 7a 65 20 61 6e 64 20 73 68 75 74  tialize and shut
0950: 64 6f 77 6e 20 74 68 65 20 70 61 67 65 20 63 61  down the page ca
0960: 63 68 65 20 73 75 62 73 79 73 74 65 6d 20 2a 2f  che subsystem */
0970: 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63  .int sqlite3Pcac
0980: 68 65 49 6e 69 74 69 61 6c 69 7a 65 28 76 6f 69  heInitialize(voi
0990: 64 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  d);.void sqlite3
09a0: 50 63 61 63 68 65 53 68 75 74 64 6f 77 6e 28 76  PcacheShutdown(v
09b0: 6f 69 64 29 3b 0a 0a 2f 2a 20 50 61 67 65 20 63  oid);../* Page c
09c0: 61 63 68 65 20 62 75 66 66 65 72 20 6d 61 6e 61  ache buffer mana
09d0: 67 65 6d 65 6e 74 3a 0a 2a 2a 20 54 68 65 73 65  gement:.** These
09e0: 20 72 6f 75 74 69 6e 65 73 20 69 6d 70 6c 65 6d   routines implem
09f0: 65 6e 74 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ent SQLITE_CONFI
0a00: 47 5f 50 41 47 45 43 41 43 48 45 2e 0a 2a 2f 0a  G_PAGECACHE..*/.
0a10: 76 6f 69 64 20 73 71 6c 69 74 65 33 50 43 61 63  void sqlite3PCac
0a20: 68 65 42 75 66 66 65 72 53 65 74 75 70 28 76 6f  heBufferSetup(vo
0a30: 69 64 20 2a 2c 20 69 6e 74 20 73 7a 2c 20 69 6e  id *, int sz, in
0a40: 74 20 6e 29 3b 0a 0a 2f 2a 20 43 72 65 61 74 65  t n);../* Create
0a50: 20 61 20 6e 65 77 20 70 61 67 65 72 20 63 61 63   a new pager cac
0a60: 68 65 2e 0a 2a 2a 20 55 6e 64 65 72 20 6d 65 6d  he..** Under mem
0a70: 6f 72 79 20 73 74 72 65 73 73 2c 20 69 6e 76 6f  ory stress, invo
0a80: 6b 65 20 78 53 74 72 65 73 73 20 74 6f 20 74 72  ke xStress to tr
0a90: 79 20 74 6f 20 6d 61 6b 65 20 70 61 67 65 73 20  y to make pages 
0aa0: 63 6c 65 61 6e 2e 0a 2a 2a 20 4f 6e 6c 79 20 63  clean..** Only c
0ab0: 6c 65 61 6e 20 61 6e 64 20 75 6e 70 69 6e 6e 65  lean and unpinne
0ac0: 64 20 70 61 67 65 73 20 63 61 6e 20 62 65 20 72  d pages can be r
0ad0: 65 63 6c 61 69 6d 65 64 2e 0a 2a 2f 0a 69 6e 74  eclaimed..*/.int
0ae0: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 4f 70   sqlite3PcacheOp
0af0: 65 6e 28 0a 20 20 69 6e 74 20 73 7a 50 61 67 65  en(.  int szPage
0b00: 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ,               
0b10: 20 20 20 20 20 2f 2a 20 53 69 7a 65 20 6f 66 20       /* Size of 
0b20: 65 76 65 72 79 20 70 61 67 65 20 2a 2f 0a 20 20  every page */.  
0b30: 69 6e 74 20 73 7a 45 78 74 72 61 2c 20 20 20 20  int szExtra,    
0b40: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
0b50: 2a 20 45 78 74 72 61 20 73 70 61 63 65 20 61 73  * Extra space as
0b60: 73 6f 63 69 61 74 65 64 20 77 69 74 68 20 65 61  sociated with ea
0b70: 63 68 20 70 61 67 65 20 2a 2f 0a 20 20 69 6e 74  ch page */.  int
0b80: 20 62 50 75 72 67 65 61 62 6c 65 2c 20 20 20 20   bPurgeable,    
0b90: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 54              /* T
0ba0: 72 75 65 20 69 66 20 70 61 67 65 73 20 61 72 65  rue if pages are
0bb0: 20 6f 6e 20 62 61 63 6b 69 6e 67 20 73 74 6f 72   on backing stor
0bc0: 65 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 53 74  e */.  int (*xSt
0bd0: 72 65 73 73 29 28 76 6f 69 64 2a 2c 20 50 67 48  ress)(void*, PgH
0be0: 64 72 2a 29 2c 20 2f 2a 20 43 61 6c 6c 20 74 6f  dr*), /* Call to
0bf0: 20 74 72 79 20 74 6f 20 6d 61 6b 65 20 70 61 67   try to make pag
0c00: 65 73 20 63 6c 65 61 6e 20 2a 2f 0a 20 20 76 6f  es clean */.  vo
0c10: 69 64 20 2a 70 53 74 72 65 73 73 2c 20 20 20 20  id *pStress,    
0c20: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
0c30: 41 72 67 75 6d 65 6e 74 20 74 6f 20 78 53 74 72  Argument to xStr
0c40: 65 73 73 20 2a 2f 0a 20 20 50 43 61 63 68 65 20  ess */.  PCache 
0c50: 2a 70 54 6f 49 6e 69 74 20 20 20 20 20 20 20 20  *pToInit        
0c60: 20 20 20 20 20 20 20 20 2f 2a 20 50 72 65 61 6c          /* Preal
0c70: 6c 6f 63 61 74 65 64 20 73 70 61 63 65 20 66 6f  located space fo
0c80: 72 20 74 68 65 20 50 43 61 63 68 65 20 2a 2f 0a  r the PCache */.
0c90: 29 3b 0a 0a 2f 2a 20 4d 6f 64 69 66 79 20 74 68  );../* Modify th
0ca0: 65 20 70 61 67 65 2d 73 69 7a 65 20 61 66 74 65  e page-size afte
0cb0: 72 20 74 68 65 20 63 61 63 68 65 20 68 61 73 20  r the cache has 
0cc0: 62 65 65 6e 20 63 72 65 61 74 65 64 2e 20 2a 2f  been created. */
0cd0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63  .int sqlite3Pcac
0ce0: 68 65 53 65 74 50 61 67 65 53 69 7a 65 28 50 43  heSetPageSize(PC
0cf0: 61 63 68 65 20 2a 2c 20 69 6e 74 29 3b 0a 0a 2f  ache *, int);../
0d00: 2a 20 52 65 74 75 72 6e 20 74 68 65 20 73 69 7a  * Return the siz
0d10: 65 20 69 6e 20 62 79 74 65 73 20 6f 66 20 61 20  e in bytes of a 
0d20: 50 43 61 63 68 65 20 6f 62 6a 65 63 74 2e 20 20  PCache object.  
0d30: 55 73 65 64 20 74 6f 20 70 72 65 61 6c 6c 6f 63  Used to prealloc
0d40: 61 74 65 0a 2a 2a 20 73 74 6f 72 61 67 65 20 73  ate.** storage s
0d50: 70 61 63 65 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  pace..*/.int sql
0d60: 69 74 65 33 50 63 61 63 68 65 53 69 7a 65 28 76  ite3PcacheSize(v
0d70: 6f 69 64 29 3b 0a 0a 2f 2a 20 4f 6e 65 20 72 65  oid);../* One re
0d80: 6c 65 61 73 65 20 70 65 72 20 73 75 63 63 65 73  lease per succes
0d90: 73 66 75 6c 20 66 65 74 63 68 2e 20 20 50 61 67  sful fetch.  Pag
0da0: 65 20 69 73 20 70 69 6e 6e 65 64 20 75 6e 74 69  e is pinned unti
0db0: 6c 20 72 65 6c 65 61 73 65 64 2e 0a 2a 2a 20 52  l released..** R
0dc0: 65 66 65 72 65 6e 63 65 20 63 6f 75 6e 74 65 64  eference counted
0dd0: 2e 20 0a 2a 2f 0a 73 71 6c 69 74 65 33 5f 70 63  . .*/.sqlite3_pc
0de0: 61 63 68 65 5f 70 61 67 65 20 2a 73 71 6c 69 74  ache_page *sqlit
0df0: 65 33 50 63 61 63 68 65 46 65 74 63 68 28 50 43  e3PcacheFetch(PC
0e00: 61 63 68 65 2a 2c 20 50 67 6e 6f 2c 20 69 6e 74  ache*, Pgno, int
0e10: 20 63 72 65 61 74 65 46 6c 61 67 29 3b 0a 69 6e   createFlag);.in
0e20: 74 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 46  t sqlite3PcacheF
0e30: 65 74 63 68 53 74 72 65 73 73 28 50 43 61 63 68  etchStress(PCach
0e40: 65 2a 2c 20 50 67 6e 6f 2c 20 73 71 6c 69 74 65  e*, Pgno, sqlite
0e50: 33 5f 70 63 61 63 68 65 5f 70 61 67 65 2a 2a 29  3_pcache_page**)
0e60: 3b 0a 50 67 48 64 72 20 2a 73 71 6c 69 74 65 33  ;.PgHdr *sqlite3
0e70: 50 63 61 63 68 65 46 65 74 63 68 46 69 6e 69 73  PcacheFetchFinis
0e80: 68 28 50 43 61 63 68 65 2a 2c 20 50 67 6e 6f 2c  h(PCache*, Pgno,
0e90: 20 73 71 6c 69 74 65 33 5f 70 63 61 63 68 65 5f   sqlite3_pcache_
0ea0: 70 61 67 65 20 2a 70 50 61 67 65 29 3b 0a 76 6f  page *pPage);.vo
0eb0: 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  id sqlite3Pcache
0ec0: 52 65 6c 65 61 73 65 28 50 67 48 64 72 2a 29 3b  Release(PgHdr*);
0ed0: 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  ..void sqlite3Pc
0ee0: 61 63 68 65 44 72 6f 70 28 50 67 48 64 72 2a 29  acheDrop(PgHdr*)
0ef0: 3b 20 20 20 20 20 20 20 20 20 2f 2a 20 52 65 6d  ;         /* Rem
0f00: 6f 76 65 20 70 61 67 65 20 66 72 6f 6d 20 63 61  ove page from ca
0f10: 63 68 65 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69  che */.void sqli
0f20: 74 65 33 50 63 61 63 68 65 4d 61 6b 65 44 69 72  te3PcacheMakeDir
0f30: 74 79 28 50 67 48 64 72 2a 29 3b 20 20 20 20 2f  ty(PgHdr*);    /
0f40: 2a 20 4d 61 6b 65 20 73 75 72 65 20 70 61 67 65  * Make sure page
0f50: 20 69 73 20 6d 61 72 6b 65 64 20 64 69 72 74 79   is marked dirty
0f60: 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33   */.void sqlite3
0f70: 50 63 61 63 68 65 4d 61 6b 65 43 6c 65 61 6e 28  PcacheMakeClean(
0f80: 50 67 48 64 72 2a 29 3b 20 20 20 20 2f 2a 20 4d  PgHdr*);    /* M
0f90: 61 72 6b 20 61 20 73 69 6e 67 6c 65 20 70 61 67  ark a single pag
0fa0: 65 20 61 73 20 63 6c 65 61 6e 20 2a 2f 0a 76 6f  e as clean */.vo
0fb0: 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  id sqlite3Pcache
0fc0: 43 6c 65 61 6e 41 6c 6c 28 50 43 61 63 68 65 2a  CleanAll(PCache*
0fd0: 29 3b 20 20 20 20 2f 2a 20 4d 61 72 6b 20 61 6c  );    /* Mark al
0fe0: 6c 20 64 69 72 74 79 20 6c 69 73 74 20 70 61 67  l dirty list pag
0ff0: 65 73 20 61 73 20 63 6c 65 61 6e 20 2a 2f 0a 76  es as clean */.v
1000: 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68  oid sqlite3Pcach
1010: 65 43 6c 65 61 72 57 72 69 74 61 62 6c 65 28 50  eClearWritable(P
1020: 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a 20 43 68 61  Cache*);../* Cha
1030: 6e 67 65 20 61 20 70 61 67 65 20 6e 75 6d 62 65  nge a page numbe
1040: 72 2e 20 20 55 73 65 64 20 62 79 20 69 6e 63 72  r.  Used by incr
1050: 2d 76 61 63 75 75 6d 2e 20 2a 2f 0a 76 6f 69 64  -vacuum. */.void
1060: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 4d 6f   sqlite3PcacheMo
1070: 76 65 28 50 67 48 64 72 2a 2c 20 50 67 6e 6f 29  ve(PgHdr*, Pgno)
1080: 3b 0a 0a 2f 2a 20 52 65 6d 6f 76 65 20 61 6c 6c  ;../* Remove all
1090: 20 70 61 67 65 73 20 77 69 74 68 20 70 67 6e 6f   pages with pgno
10a0: 3e 78 2e 20 20 52 65 73 65 74 20 74 68 65 20 63  >x.  Reset the c
10b0: 61 63 68 65 20 69 66 20 78 3d 3d 30 20 2a 2f 0a  ache if x==0 */.
10c0: 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63  void sqlite3Pcac
10d0: 68 65 54 72 75 6e 63 61 74 65 28 50 43 61 63 68  heTruncate(PCach
10e0: 65 2a 2c 20 50 67 6e 6f 20 78 29 3b 0a 0a 2f 2a  e*, Pgno x);../*
10f0: 20 47 65 74 20 61 20 6c 69 73 74 20 6f 66 20 61   Get a list of a
1100: 6c 6c 20 64 69 72 74 79 20 70 61 67 65 73 20 69  ll dirty pages i
1110: 6e 20 74 68 65 20 63 61 63 68 65 2c 20 73 6f 72  n the cache, sor
1120: 74 65 64 20 62 79 20 70 61 67 65 20 6e 75 6d 62  ted by page numb
1130: 65 72 20 2a 2f 0a 50 67 48 64 72 20 2a 73 71 6c  er */.PgHdr *sql
1140: 69 74 65 33 50 63 61 63 68 65 44 69 72 74 79 4c  ite3PcacheDirtyL
1150: 69 73 74 28 50 43 61 63 68 65 2a 29 3b 0a 0a 2f  ist(PCache*);../
1160: 2a 20 52 65 73 65 74 20 61 6e 64 20 63 6c 6f 73  * Reset and clos
1170: 65 20 74 68 65 20 63 61 63 68 65 20 6f 62 6a 65  e the cache obje
1180: 63 74 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74  ct */.void sqlit
1190: 65 33 50 63 61 63 68 65 43 6c 6f 73 65 28 50 43  e3PcacheClose(PC
11a0: 61 63 68 65 2a 29 3b 0a 0a 2f 2a 20 43 6c 65 61  ache*);../* Clea
11b0: 72 20 66 6c 61 67 73 20 66 72 6f 6d 20 70 61 67  r flags from pag
11c0: 65 73 20 6f 66 20 74 68 65 20 70 61 67 65 20 63  es of the page c
11d0: 61 63 68 65 20 2a 2f 0a 76 6f 69 64 20 73 71 6c  ache */.void sql
11e0: 69 74 65 33 50 63 61 63 68 65 43 6c 65 61 72 53  ite3PcacheClearS
11f0: 79 6e 63 46 6c 61 67 73 28 50 43 61 63 68 65 20  yncFlags(PCache 
1200: 2a 29 3b 0a 0a 2f 2a 20 44 69 73 63 61 72 64 20  *);../* Discard 
1210: 74 68 65 20 63 6f 6e 74 65 6e 74 73 20 6f 66 20  the contents of 
1220: 74 68 65 20 63 61 63 68 65 20 2a 2f 0a 76 6f 69  the cache */.voi
1230: 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 43  d sqlite3PcacheC
1240: 6c 65 61 72 28 50 43 61 63 68 65 2a 29 3b 0a 0a  lear(PCache*);..
1250: 2f 2a 20 52 65 74 75 72 6e 20 74 68 65 20 74 6f  /* Return the to
1260: 74 61 6c 20 6e 75 6d 62 65 72 20 6f 66 20 6f 75  tal number of ou
1270: 74 73 74 61 6e 64 69 6e 67 20 70 61 67 65 20 72  tstanding page r
1280: 65 66 65 72 65 6e 63 65 73 20 2a 2f 0a 69 6e 74  eferences */.int
1290: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 52 65   sqlite3PcacheRe
12a0: 66 43 6f 75 6e 74 28 50 43 61 63 68 65 2a 29 3b  fCount(PCache*);
12b0: 0a 0a 2f 2a 20 49 6e 63 72 65 6d 65 6e 74 20 74  ../* Increment t
12c0: 68 65 20 72 65 66 65 72 65 6e 63 65 20 63 6f 75  he reference cou
12d0: 6e 74 20 6f 66 20 61 6e 20 65 78 69 73 74 69 6e  nt of an existin
12e0: 67 20 70 61 67 65 20 2a 2f 0a 76 6f 69 64 20 73  g page */.void s
12f0: 71 6c 69 74 65 33 50 63 61 63 68 65 52 65 66 28  qlite3PcacheRef(
1300: 50 67 48 64 72 2a 29 3b 0a 0a 69 6e 74 20 73 71  PgHdr*);..int sq
1310: 6c 69 74 65 33 50 63 61 63 68 65 50 61 67 65 52  lite3PcachePageR
1320: 65 66 63 6f 75 6e 74 28 50 67 48 64 72 2a 29 3b  efcount(PgHdr*);
1330: 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74 68 65 20  ../* Return the 
1340: 74 6f 74 61 6c 20 6e 75 6d 62 65 72 20 6f 66 20  total number of 
1350: 70 61 67 65 73 20 73 74 6f 72 65 64 20 69 6e 20  pages stored in 
1360: 74 68 65 20 63 61 63 68 65 20 2a 2f 0a 69 6e 74  the cache */.int
1370: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 50 61   sqlite3PcachePa
1380: 67 65 63 6f 75 6e 74 28 50 43 61 63 68 65 2a 29  gecount(PCache*)
1390: 3b 0a 0a 23 69 66 20 64 65 66 69 6e 65 64 28 53  ;..#if defined(S
13a0: 51 4c 49 54 45 5f 43 48 45 43 4b 5f 50 41 47 45  QLITE_CHECK_PAGE
13b0: 53 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 53 51  S) || defined(SQ
13c0: 4c 49 54 45 5f 44 45 42 55 47 29 0a 2f 2a 20 49  LITE_DEBUG)./* I
13d0: 74 65 72 61 74 65 20 74 68 72 6f 75 67 68 20 61  terate through a
13e0: 6c 6c 20 64 69 72 74 79 20 70 61 67 65 73 20 63  ll dirty pages c
13f0: 75 72 72 65 6e 74 6c 79 20 73 74 6f 72 65 64 20  urrently stored 
1400: 69 6e 20 74 68 65 20 63 61 63 68 65 2e 20 54 68  in the cache. Th
1410: 69 73 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20  is.** interface 
1420: 69 73 20 6f 6e 6c 79 20 61 76 61 69 6c 61 62 6c  is only availabl
1430: 65 20 69 66 20 53 51 4c 49 54 45 5f 43 48 45 43  e if SQLITE_CHEC
1440: 4b 5f 50 41 47 45 53 20 69 73 20 64 65 66 69 6e  K_PAGES is defin
1450: 65 64 20 77 68 65 6e 20 74 68 65 20 0a 2a 2a 20  ed when the .** 
1460: 6c 69 62 72 61 72 79 20 69 73 20 62 75 69 6c 74  library is built
1470: 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65  ..*/.void sqlite
1480: 33 50 63 61 63 68 65 49 74 65 72 61 74 65 44 69  3PcacheIterateDi
1490: 72 74 79 28 50 43 61 63 68 65 20 2a 70 43 61 63  rty(PCache *pCac
14a0: 68 65 2c 20 76 6f 69 64 20 28 2a 78 49 74 65 72  he, void (*xIter
14b0: 29 28 50 67 48 64 72 20 2a 29 29 3b 0a 23 65 6e  )(PgHdr *));.#en
14c0: 64 69 66 0a 0a 2f 2a 20 53 65 74 20 61 6e 64 20  dif../* Set and 
14d0: 67 65 74 20 74 68 65 20 73 75 67 67 65 73 74 65  get the suggeste
14e0: 64 20 63 61 63 68 65 2d 73 69 7a 65 20 66 6f 72  d cache-size for
14f0: 20 74 68 65 20 73 70 65 63 69 66 69 65 64 20 70   the specified p
1500: 61 67 65 72 2d 63 61 63 68 65 2e 0a 2a 2a 0a 2a  ager-cache..**.*
1510: 2a 20 49 66 20 6e 6f 20 67 6c 6f 62 61 6c 20 6d  * If no global m
1520: 61 78 69 6d 75 6d 20 69 73 20 63 6f 6e 66 69 67  aximum is config
1530: 75 72 65 64 2c 20 74 68 65 6e 20 74 68 65 20 73  ured, then the s
1540: 79 73 74 65 6d 20 61 74 74 65 6d 70 74 73 20 74  ystem attempts t
1550: 6f 20 6c 69 6d 69 74 0a 2a 2a 20 74 68 65 20 74  o limit.** the t
1560: 6f 74 61 6c 20 6e 75 6d 62 65 72 20 6f 66 20 70  otal number of p
1570: 61 67 65 73 20 63 61 63 68 65 64 20 62 79 20 70  ages cached by p
1580: 75 72 67 65 61 62 6c 65 20 70 61 67 65 72 2d 63  urgeable pager-c
1590: 61 63 68 65 73 20 74 6f 20 74 68 65 20 73 75 6d  aches to the sum
15a0: 0a 2a 2a 20 6f 66 20 74 68 65 20 73 75 67 67 65  .** of the sugge
15b0: 73 74 65 64 20 63 61 63 68 65 2d 73 69 7a 65 73  sted cache-sizes
15c0: 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65  ..*/.void sqlite
15d0: 33 50 63 61 63 68 65 53 65 74 43 61 63 68 65 73  3PcacheSetCaches
15e0: 69 7a 65 28 50 43 61 63 68 65 20 2a 2c 20 69 6e  ize(PCache *, in
15f0: 74 29 3b 0a 23 69 66 64 65 66 20 53 51 4c 49 54  t);.#ifdef SQLIT
1600: 45 5f 54 45 53 54 0a 69 6e 74 20 73 71 6c 69 74  E_TEST.int sqlit
1610: 65 33 50 63 61 63 68 65 47 65 74 43 61 63 68 65  e3PcacheGetCache
1620: 73 69 7a 65 28 50 43 61 63 68 65 20 2a 29 3b 0a  size(PCache *);.
1630: 23 65 6e 64 69 66 0a 0a 2f 2a 20 53 65 74 20 6f  #endif../* Set o
1640: 72 20 67 65 74 20 74 68 65 20 73 75 67 67 65 73  r get the sugges
1650: 74 65 64 20 73 70 69 6c 6c 2d 73 69 7a 65 20 66  ted spill-size f
1660: 6f 72 20 74 68 65 20 73 70 65 63 69 66 69 65 64  or the specified
1670: 20 70 61 67 65 72 2d 63 61 63 68 65 2e 0a 2a 2a   pager-cache..**
1680: 0a 2a 2a 20 54 68 65 20 73 70 69 6c 6c 2d 73 69  .** The spill-si
1690: 7a 65 20 69 73 20 74 68 65 20 6d 69 6e 69 6d 75  ze is the minimu
16a0: 6d 20 6e 75 6d 62 65 72 20 6f 66 20 70 61 67 65  m number of page
16b0: 73 20 69 6e 20 63 61 63 68 65 20 62 65 66 6f 72  s in cache befor
16c0: 65 20 74 68 65 20 63 61 63 68 65 0a 2a 2a 20 77  e the cache.** w
16d0: 69 6c 6c 20 61 74 74 65 6d 70 74 20 74 6f 20 73  ill attempt to s
16e0: 70 69 6c 6c 20 64 69 72 74 79 20 70 61 67 65 73  pill dirty pages
16f0: 20 62 79 20 63 61 6c 6c 69 6e 67 20 78 53 74 72   by calling xStr
1700: 65 73 73 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  ess..*/.int sqli
1710: 74 65 33 50 63 61 63 68 65 53 65 74 53 70 69 6c  te3PcacheSetSpil
1720: 6c 73 69 7a 65 28 50 43 61 63 68 65 20 2a 2c 20  lsize(PCache *, 
1730: 69 6e 74 29 3b 0a 0a 2f 2a 20 46 72 65 65 20 75  int);../* Free u
1740: 70 20 61 73 20 6d 75 63 68 20 6d 65 6d 6f 72 79  p as much memory
1750: 20 61 73 20 70 6f 73 73 69 62 6c 65 20 66 72 6f   as possible fro
1760: 6d 20 74 68 65 20 70 61 67 65 20 63 61 63 68 65  m the page cache
1770: 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33   */.void sqlite3
1780: 50 63 61 63 68 65 53 68 72 69 6e 6b 28 50 43 61  PcacheShrink(PCa
1790: 63 68 65 2a 29 3b 0a 0a 23 69 66 64 65 66 20 53  che*);..#ifdef S
17a0: 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d  QLITE_ENABLE_MEM
17b0: 4f 52 59 5f 4d 41 4e 41 47 45 4d 45 4e 54 0a 2f  ORY_MANAGEMENT./
17c0: 2a 20 54 72 79 20 74 6f 20 72 65 74 75 72 6e 20  * Try to return 
17d0: 6d 65 6d 6f 72 79 20 75 73 65 64 20 62 79 20 74  memory used by t
17e0: 68 65 20 70 63 61 63 68 65 20 6d 6f 64 75 6c 65  he pcache module
17f0: 20 74 6f 20 74 68 65 20 6d 61 69 6e 20 6d 65 6d   to the main mem
1800: 6f 72 79 20 68 65 61 70 20 2a 2f 0a 69 6e 74 20  ory heap */.int 
1810: 73 71 6c 69 74 65 33 50 63 61 63 68 65 52 65 6c  sqlite3PcacheRel
1820: 65 61 73 65 4d 65 6d 6f 72 79 28 69 6e 74 29 3b  easeMemory(int);
1830: 0a 23 65 6e 64 69 66 0a 0a 23 69 66 64 65 66 20  .#endif..#ifdef 
1840: 53 51 4c 49 54 45 5f 54 45 53 54 0a 76 6f 69 64  SQLITE_TEST.void
1850: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 53 74   sqlite3PcacheSt
1860: 61 74 73 28 69 6e 74 2a 2c 69 6e 74 2a 2c 69 6e  ats(int*,int*,in
1870: 74 2a 2c 69 6e 74 2a 29 3b 0a 23 65 6e 64 69 66  t*,int*);.#endif
1880: 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 43  ..void sqlite3PC
1890: 61 63 68 65 53 65 74 44 65 66 61 75 6c 74 28 76  acheSetDefault(v
18a0: 6f 69 64 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e  oid);../* Return
18b0: 20 74 68 65 20 68 65 61 64 65 72 20 73 69 7a 65   the header size
18c0: 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 48   */.int sqlite3H
18d0: 65 61 64 65 72 53 69 7a 65 50 63 61 63 68 65 28  eaderSizePcache(
18e0: 76 6f 69 64 29 3b 0a 69 6e 74 20 73 71 6c 69 74  void);.int sqlit
18f0: 65 33 48 65 61 64 65 72 53 69 7a 65 50 63 61 63  e3HeaderSizePcac
1900: 68 65 31 28 76 6f 69 64 29 3b 0a 0a 2f 2a 20 4e  he1(void);../* N
1910: 75 6d 62 65 72 20 6f 66 20 64 69 72 74 79 20 70  umber of dirty p
1920: 61 67 65 73 20 61 73 20 61 20 70 65 72 63 65 6e  ages as a percen
1930: 74 61 67 65 20 6f 66 20 74 68 65 20 63 6f 6e 66  tage of the conf
1940: 69 67 75 72 65 64 20 63 61 63 68 65 20 73 69 7a  igured cache siz
1950: 65 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  e */.int sqlite3
1960: 50 43 61 63 68 65 50 65 72 63 65 6e 74 44 69 72  PCachePercentDir
1970: 74 79 28 50 43 61 63 68 65 2a 29 3b 0a 0a 23 65  ty(PCache*);..#e
1980: 6e 64 69 66 20 2f 2a 20 5f 50 43 41 43 48 45 5f  ndif /* _PCACHE_
1990: 48 5f 20 2a 2f 0a                                H_ */.