/ Hex Artifact Content
Login

Artifact 2cedcd8407eb23017d92790b112186886e179490:


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 44 4f 4e 54 5f 57  ine PGHDR_DONT_W
0840: 52 49 54 45 20 20 20 20 20 20 30 78 30 31 30 20  RITE      0x010 
0850: 20 2f 2a 20 44 6f 20 6e 6f 74 20 77 72 69 74 65   /* Do not write
0860: 20 63 6f 6e 74 65 6e 74 20 74 6f 20 64 69 73 6b   content to disk
0870: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 47 48 44   */.#define PGHD
0880: 52 5f 4d 4d 41 50 20 20 20 20 20 20 20 20 20 20  R_MMAP          
0890: 20 20 30 78 30 32 30 20 20 2f 2a 20 54 68 69 73    0x020  /* This
08a0: 20 69 73 20 61 6e 20 6d 6d 61 70 20 70 61 67 65   is an mmap page
08b0: 20 6f 62 6a 65 63 74 20 2a 2f 0a 0a 23 64 65 66   object */..#def
08c0: 69 6e 65 20 50 47 48 44 52 5f 57 41 4c 5f 41 50  ine PGHDR_WAL_AP
08d0: 50 45 4e 44 20 20 20 20 20 20 30 78 30 34 30 20  PEND      0x040 
08e0: 20 2f 2a 20 41 70 70 65 6e 64 65 64 20 74 6f 20   /* Appended to 
08f0: 77 61 6c 20 66 69 6c 65 20 2a 2f 0a 0a 2f 2a 20  wal file */../* 
0900: 49 6e 69 74 69 61 6c 69 7a 65 20 61 6e 64 20 73  Initialize and s
0910: 68 75 74 64 6f 77 6e 20 74 68 65 20 70 61 67 65  hutdown the page
0920: 20 63 61 63 68 65 20 73 75 62 73 79 73 74 65 6d   cache subsystem
0930: 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50   */.int sqlite3P
0940: 63 61 63 68 65 49 6e 69 74 69 61 6c 69 7a 65 28  cacheInitialize(
0950: 76 6f 69 64 29 3b 0a 76 6f 69 64 20 73 71 6c 69  void);.void sqli
0960: 74 65 33 50 63 61 63 68 65 53 68 75 74 64 6f 77  te3PcacheShutdow
0970: 6e 28 76 6f 69 64 29 3b 0a 0a 2f 2a 20 50 61 67  n(void);../* Pag
0980: 65 20 63 61 63 68 65 20 62 75 66 66 65 72 20 6d  e cache buffer m
0990: 61 6e 61 67 65 6d 65 6e 74 3a 0a 2a 2a 20 54 68  anagement:.** Th
09a0: 65 73 65 20 72 6f 75 74 69 6e 65 73 20 69 6d 70  ese routines imp
09b0: 6c 65 6d 65 6e 74 20 53 51 4c 49 54 45 5f 43 4f  lement SQLITE_CO
09c0: 4e 46 49 47 5f 50 41 47 45 43 41 43 48 45 2e 0a  NFIG_PAGECACHE..
09d0: 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50  */.void sqlite3P
09e0: 43 61 63 68 65 42 75 66 66 65 72 53 65 74 75 70  CacheBufferSetup
09f0: 28 76 6f 69 64 20 2a 2c 20 69 6e 74 20 73 7a 2c  (void *, int sz,
0a00: 20 69 6e 74 20 6e 29 3b 0a 0a 2f 2a 20 43 72 65   int n);../* Cre
0a10: 61 74 65 20 61 20 6e 65 77 20 70 61 67 65 72 20  ate a new pager 
0a20: 63 61 63 68 65 2e 0a 2a 2a 20 55 6e 64 65 72 20  cache..** Under 
0a30: 6d 65 6d 6f 72 79 20 73 74 72 65 73 73 2c 20 69  memory stress, i
0a40: 6e 76 6f 6b 65 20 78 53 74 72 65 73 73 20 74 6f  nvoke xStress to
0a50: 20 74 72 79 20 74 6f 20 6d 61 6b 65 20 70 61 67   try to make pag
0a60: 65 73 20 63 6c 65 61 6e 2e 0a 2a 2a 20 4f 6e 6c  es clean..** Onl
0a70: 79 20 63 6c 65 61 6e 20 61 6e 64 20 75 6e 70 69  y clean and unpi
0a80: 6e 6e 65 64 20 70 61 67 65 73 20 63 61 6e 20 62  nned pages can b
0a90: 65 20 72 65 63 6c 61 69 6d 65 64 2e 0a 2a 2f 0a  e reclaimed..*/.
0aa0: 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63 68  int sqlite3Pcach
0ab0: 65 4f 70 65 6e 28 0a 20 20 69 6e 74 20 73 7a 50  eOpen(.  int szP
0ac0: 61 67 65 2c 20 20 20 20 20 20 20 20 20 20 20 20  age,            
0ad0: 20 20 20 20 20 20 20 20 2f 2a 20 53 69 7a 65 20          /* Size 
0ae0: 6f 66 20 65 76 65 72 79 20 70 61 67 65 20 2a 2f  of every page */
0af0: 0a 20 20 69 6e 74 20 73 7a 45 78 74 72 61 2c 20  .  int szExtra, 
0b00: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0b10: 20 20 2f 2a 20 45 78 74 72 61 20 73 70 61 63 65    /* Extra space
0b20: 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 68   associated with
0b30: 20 65 61 63 68 20 70 61 67 65 20 2a 2f 0a 20 20   each page */.  
0b40: 69 6e 74 20 62 50 75 72 67 65 61 62 6c 65 2c 20  int bPurgeable, 
0b50: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
0b60: 2a 20 54 72 75 65 20 69 66 20 70 61 67 65 73 20  * True if pages 
0b70: 61 72 65 20 6f 6e 20 62 61 63 6b 69 6e 67 20 73  are on backing s
0b80: 74 6f 72 65 20 2a 2f 0a 20 20 69 6e 74 20 28 2a  tore */.  int (*
0b90: 78 53 74 72 65 73 73 29 28 76 6f 69 64 2a 2c 20  xStress)(void*, 
0ba0: 50 67 48 64 72 2a 29 2c 20 2f 2a 20 43 61 6c 6c  PgHdr*), /* Call
0bb0: 20 74 6f 20 74 72 79 20 74 6f 20 6d 61 6b 65 20   to try to make 
0bc0: 70 61 67 65 73 20 63 6c 65 61 6e 20 2a 2f 0a 20  pages clean */. 
0bd0: 20 76 6f 69 64 20 2a 70 53 74 72 65 73 73 2c 20   void *pStress, 
0be0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0bf0: 2f 2a 20 41 72 67 75 6d 65 6e 74 20 74 6f 20 78  /* Argument to x
0c00: 53 74 72 65 73 73 20 2a 2f 0a 20 20 50 43 61 63  Stress */.  PCac
0c10: 68 65 20 2a 70 54 6f 49 6e 69 74 20 20 20 20 20  he *pToInit     
0c20: 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 50 72             /* Pr
0c30: 65 61 6c 6c 6f 63 61 74 65 64 20 73 70 61 63 65  eallocated space
0c40: 20 66 6f 72 20 74 68 65 20 50 43 61 63 68 65 20   for the PCache 
0c50: 2a 2f 0a 29 3b 0a 0a 2f 2a 20 4d 6f 64 69 66 79  */.);../* Modify
0c60: 20 74 68 65 20 70 61 67 65 2d 73 69 7a 65 20 61   the page-size a
0c70: 66 74 65 72 20 74 68 65 20 63 61 63 68 65 20 68  fter the cache h
0c80: 61 73 20 62 65 65 6e 20 63 72 65 61 74 65 64 2e  as been created.
0c90: 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50   */.int sqlite3P
0ca0: 63 61 63 68 65 53 65 74 50 61 67 65 53 69 7a 65  cacheSetPageSize
0cb0: 28 50 43 61 63 68 65 20 2a 2c 20 69 6e 74 29 3b  (PCache *, int);
0cc0: 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74 68 65 20  ../* Return the 
0cd0: 73 69 7a 65 20 69 6e 20 62 79 74 65 73 20 6f 66  size in bytes of
0ce0: 20 61 20 50 43 61 63 68 65 20 6f 62 6a 65 63 74   a PCache object
0cf0: 2e 20 20 55 73 65 64 20 74 6f 20 70 72 65 61 6c  .  Used to preal
0d00: 6c 6f 63 61 74 65 0a 2a 2a 20 73 74 6f 72 61 67  locate.** storag
0d10: 65 20 73 70 61 63 65 2e 0a 2a 2f 0a 69 6e 74 20  e space..*/.int 
0d20: 73 71 6c 69 74 65 33 50 63 61 63 68 65 53 69 7a  sqlite3PcacheSiz
0d30: 65 28 76 6f 69 64 29 3b 0a 0a 2f 2a 20 4f 6e 65  e(void);../* One
0d40: 20 72 65 6c 65 61 73 65 20 70 65 72 20 73 75 63   release per suc
0d50: 63 65 73 73 66 75 6c 20 66 65 74 63 68 2e 20 20  cessful fetch.  
0d60: 50 61 67 65 20 69 73 20 70 69 6e 6e 65 64 20 75  Page is pinned u
0d70: 6e 74 69 6c 20 72 65 6c 65 61 73 65 64 2e 0a 2a  ntil released..*
0d80: 2a 20 52 65 66 65 72 65 6e 63 65 20 63 6f 75 6e  * Reference coun
0d90: 74 65 64 2e 20 0a 2a 2f 0a 73 71 6c 69 74 65 33  ted. .*/.sqlite3
0da0: 5f 70 63 61 63 68 65 5f 70 61 67 65 20 2a 73 71  _pcache_page *sq
0db0: 6c 69 74 65 33 50 63 61 63 68 65 46 65 74 63 68  lite3PcacheFetch
0dc0: 28 50 43 61 63 68 65 2a 2c 20 50 67 6e 6f 2c 20  (PCache*, Pgno, 
0dd0: 69 6e 74 20 63 72 65 61 74 65 46 6c 61 67 29 3b  int createFlag);
0de0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63  .int sqlite3Pcac
0df0: 68 65 46 65 74 63 68 53 74 72 65 73 73 28 50 43  heFetchStress(PC
0e00: 61 63 68 65 2a 2c 20 50 67 6e 6f 2c 20 73 71 6c  ache*, Pgno, sql
0e10: 69 74 65 33 5f 70 63 61 63 68 65 5f 70 61 67 65  ite3_pcache_page
0e20: 2a 2a 29 3b 0a 50 67 48 64 72 20 2a 73 71 6c 69  **);.PgHdr *sqli
0e30: 74 65 33 50 63 61 63 68 65 46 65 74 63 68 46 69  te3PcacheFetchFi
0e40: 6e 69 73 68 28 50 43 61 63 68 65 2a 2c 20 50 67  nish(PCache*, Pg
0e50: 6e 6f 2c 20 73 71 6c 69 74 65 33 5f 70 63 61 63  no, sqlite3_pcac
0e60: 68 65 5f 70 61 67 65 20 2a 70 50 61 67 65 29 3b  he_page *pPage);
0e70: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61  .void sqlite3Pca
0e80: 63 68 65 52 65 6c 65 61 73 65 28 50 67 48 64 72  cheRelease(PgHdr
0e90: 2a 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65  *);..void sqlite
0ea0: 33 50 63 61 63 68 65 44 72 6f 70 28 50 67 48 64  3PcacheDrop(PgHd
0eb0: 72 2a 29 3b 20 20 20 20 20 20 20 20 20 2f 2a 20  r*);         /* 
0ec0: 52 65 6d 6f 76 65 20 70 61 67 65 20 66 72 6f 6d  Remove page from
0ed0: 20 63 61 63 68 65 20 2a 2f 0a 76 6f 69 64 20 73   cache */.void s
0ee0: 71 6c 69 74 65 33 50 63 61 63 68 65 4d 61 6b 65  qlite3PcacheMake
0ef0: 44 69 72 74 79 28 50 67 48 64 72 2a 29 3b 20 20  Dirty(PgHdr*);  
0f00: 20 20 2f 2a 20 4d 61 6b 65 20 73 75 72 65 20 70    /* Make sure p
0f10: 61 67 65 20 69 73 20 6d 61 72 6b 65 64 20 64 69  age is marked di
0f20: 72 74 79 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69  rty */.void sqli
0f30: 74 65 33 50 63 61 63 68 65 4d 61 6b 65 43 6c 65  te3PcacheMakeCle
0f40: 61 6e 28 50 67 48 64 72 2a 29 3b 20 20 20 20 2f  an(PgHdr*);    /
0f50: 2a 20 4d 61 72 6b 20 61 20 73 69 6e 67 6c 65 20  * Mark a single 
0f60: 70 61 67 65 20 61 73 20 63 6c 65 61 6e 20 2a 2f  page as clean */
0f70: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61  .void sqlite3Pca
0f80: 63 68 65 43 6c 65 61 6e 41 6c 6c 28 50 43 61 63  cheCleanAll(PCac
0f90: 68 65 2a 29 3b 20 20 20 20 2f 2a 20 4d 61 72 6b  he*);    /* Mark
0fa0: 20 61 6c 6c 20 64 69 72 74 79 20 6c 69 73 74 20   all dirty list 
0fb0: 70 61 67 65 73 20 61 73 20 63 6c 65 61 6e 20 2a  pages as clean *
0fc0: 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63  /.void sqlite3Pc
0fd0: 61 63 68 65 43 6c 65 61 72 57 72 69 74 61 62 6c  acheClearWritabl
0fe0: 65 28 50 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a 20  e(PCache*);../* 
0ff0: 43 68 61 6e 67 65 20 61 20 70 61 67 65 20 6e 75  Change a page nu
1000: 6d 62 65 72 2e 20 20 55 73 65 64 20 62 79 20 69  mber.  Used by i
1010: 6e 63 72 2d 76 61 63 75 75 6d 2e 20 2a 2f 0a 76  ncr-vacuum. */.v
1020: 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68  oid sqlite3Pcach
1030: 65 4d 6f 76 65 28 50 67 48 64 72 2a 2c 20 50 67  eMove(PgHdr*, Pg
1040: 6e 6f 29 3b 0a 0a 2f 2a 20 52 65 6d 6f 76 65 20  no);../* Remove 
1050: 61 6c 6c 20 70 61 67 65 73 20 77 69 74 68 20 70  all pages with p
1060: 67 6e 6f 3e 78 2e 20 20 52 65 73 65 74 20 74 68  gno>x.  Reset th
1070: 65 20 63 61 63 68 65 20 69 66 20 78 3d 3d 30 20  e cache if x==0 
1080: 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50  */.void sqlite3P
1090: 63 61 63 68 65 54 72 75 6e 63 61 74 65 28 50 43  cacheTruncate(PC
10a0: 61 63 68 65 2a 2c 20 50 67 6e 6f 20 78 29 3b 0a  ache*, Pgno x);.
10b0: 0a 2f 2a 20 47 65 74 20 61 20 6c 69 73 74 20 6f  ./* Get a list o
10c0: 66 20 61 6c 6c 20 64 69 72 74 79 20 70 61 67 65  f all dirty page
10d0: 73 20 69 6e 20 74 68 65 20 63 61 63 68 65 2c 20  s in the cache, 
10e0: 73 6f 72 74 65 64 20 62 79 20 70 61 67 65 20 6e  sorted by page n
10f0: 75 6d 62 65 72 20 2a 2f 0a 50 67 48 64 72 20 2a  umber */.PgHdr *
1100: 73 71 6c 69 74 65 33 50 63 61 63 68 65 44 69 72  sqlite3PcacheDir
1110: 74 79 4c 69 73 74 28 50 43 61 63 68 65 2a 29 3b  tyList(PCache*);
1120: 0a 0a 2f 2a 20 52 65 73 65 74 20 61 6e 64 20 63  ../* Reset and c
1130: 6c 6f 73 65 20 74 68 65 20 63 61 63 68 65 20 6f  lose the cache o
1140: 62 6a 65 63 74 20 2a 2f 0a 76 6f 69 64 20 73 71  bject */.void sq
1150: 6c 69 74 65 33 50 63 61 63 68 65 43 6c 6f 73 65  lite3PcacheClose
1160: 28 50 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a 20 43  (PCache*);../* C
1170: 6c 65 61 72 20 66 6c 61 67 73 20 66 72 6f 6d 20  lear flags from 
1180: 70 61 67 65 73 20 6f 66 20 74 68 65 20 70 61 67  pages of the pag
1190: 65 20 63 61 63 68 65 20 2a 2f 0a 76 6f 69 64 20  e cache */.void 
11a0: 73 71 6c 69 74 65 33 50 63 61 63 68 65 43 6c 65  sqlite3PcacheCle
11b0: 61 72 53 79 6e 63 46 6c 61 67 73 28 50 43 61 63  arSyncFlags(PCac
11c0: 68 65 20 2a 29 3b 0a 0a 2f 2a 20 44 69 73 63 61  he *);../* Disca
11d0: 72 64 20 74 68 65 20 63 6f 6e 74 65 6e 74 73 20  rd the contents 
11e0: 6f 66 20 74 68 65 20 63 61 63 68 65 20 2a 2f 0a  of the cache */.
11f0: 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63  void sqlite3Pcac
1200: 68 65 43 6c 65 61 72 28 50 43 61 63 68 65 2a 29  heClear(PCache*)
1210: 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74 68 65  ;../* Return the
1220: 20 74 6f 74 61 6c 20 6e 75 6d 62 65 72 20 6f 66   total number of
1230: 20 6f 75 74 73 74 61 6e 64 69 6e 67 20 70 61 67   outstanding pag
1240: 65 20 72 65 66 65 72 65 6e 63 65 73 20 2a 2f 0a  e references */.
1250: 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63 68  int sqlite3Pcach
1260: 65 52 65 66 43 6f 75 6e 74 28 50 43 61 63 68 65  eRefCount(PCache
1270: 2a 29 3b 0a 0a 2f 2a 20 49 6e 63 72 65 6d 65 6e  *);../* Incremen
1280: 74 20 74 68 65 20 72 65 66 65 72 65 6e 63 65 20  t the reference 
1290: 63 6f 75 6e 74 20 6f 66 20 61 6e 20 65 78 69 73  count of an exis
12a0: 74 69 6e 67 20 70 61 67 65 20 2a 2f 0a 76 6f 69  ting page */.voi
12b0: 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 52  d sqlite3PcacheR
12c0: 65 66 28 50 67 48 64 72 2a 29 3b 0a 0a 69 6e 74  ef(PgHdr*);..int
12d0: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 50 61   sqlite3PcachePa
12e0: 67 65 52 65 66 63 6f 75 6e 74 28 50 67 48 64 72  geRefcount(PgHdr
12f0: 2a 29 3b 0a 0a 2f 2a 20 52 65 74 75 72 6e 20 74  *);../* Return t
1300: 68 65 20 74 6f 74 61 6c 20 6e 75 6d 62 65 72 20  he total number 
1310: 6f 66 20 70 61 67 65 73 20 73 74 6f 72 65 64 20  of pages stored 
1320: 69 6e 20 74 68 65 20 63 61 63 68 65 20 2a 2f 0a  in the cache */.
1330: 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63 68  int sqlite3Pcach
1340: 65 50 61 67 65 63 6f 75 6e 74 28 50 43 61 63 68  ePagecount(PCach
1350: 65 2a 29 3b 0a 0a 23 69 66 20 64 65 66 69 6e 65  e*);..#if define
1360: 64 28 53 51 4c 49 54 45 5f 43 48 45 43 4b 5f 50  d(SQLITE_CHECK_P
1370: 41 47 45 53 29 20 7c 7c 20 64 65 66 69 6e 65 64  AGES) || defined
1380: 28 53 51 4c 49 54 45 5f 44 45 42 55 47 29 0a 2f  (SQLITE_DEBUG)./
1390: 2a 20 49 74 65 72 61 74 65 20 74 68 72 6f 75 67  * Iterate throug
13a0: 68 20 61 6c 6c 20 64 69 72 74 79 20 70 61 67 65  h all dirty page
13b0: 73 20 63 75 72 72 65 6e 74 6c 79 20 73 74 6f 72  s currently stor
13c0: 65 64 20 69 6e 20 74 68 65 20 63 61 63 68 65 2e  ed in the cache.
13d0: 20 54 68 69 73 0a 2a 2a 20 69 6e 74 65 72 66 61   This.** interfa
13e0: 63 65 20 69 73 20 6f 6e 6c 79 20 61 76 61 69 6c  ce is only avail
13f0: 61 62 6c 65 20 69 66 20 53 51 4c 49 54 45 5f 43  able if SQLITE_C
1400: 48 45 43 4b 5f 50 41 47 45 53 20 69 73 20 64 65  HECK_PAGES is de
1410: 66 69 6e 65 64 20 77 68 65 6e 20 74 68 65 20 0a  fined when the .
1420: 2a 2a 20 6c 69 62 72 61 72 79 20 69 73 20 62 75  ** library is bu
1430: 69 6c 74 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c  ilt..*/.void sql
1440: 69 74 65 33 50 63 61 63 68 65 49 74 65 72 61 74  ite3PcacheIterat
1450: 65 44 69 72 74 79 28 50 43 61 63 68 65 20 2a 70  eDirty(PCache *p
1460: 43 61 63 68 65 2c 20 76 6f 69 64 20 28 2a 78 49  Cache, void (*xI
1470: 74 65 72 29 28 50 67 48 64 72 20 2a 29 29 3b 0a  ter)(PgHdr *));.
1480: 23 65 6e 64 69 66 0a 0a 23 69 66 20 64 65 66 69  #endif..#if defi
1490: 6e 65 64 28 53 51 4c 49 54 45 5f 44 45 42 55 47  ned(SQLITE_DEBUG
14a0: 29 0a 2f 2a 20 43 68 65 63 6b 20 69 6e 76 61 72  )./* Check invar
14b0: 69 61 6e 74 73 20 6f 6e 20 61 20 50 67 48 64 72  iants on a PgHdr
14c0: 20 6f 62 6a 65 63 74 20 2a 2f 0a 69 6e 74 20 73   object */.int s
14d0: 71 6c 69 74 65 33 50 63 61 63 68 65 50 61 67 65  qlite3PcachePage
14e0: 53 61 6e 69 74 79 28 50 67 48 64 72 2a 29 3b 0a  Sanity(PgHdr*);.
14f0: 23 65 6e 64 69 66 0a 0a 2f 2a 20 53 65 74 20 61  #endif../* Set a
1500: 6e 64 20 67 65 74 20 74 68 65 20 73 75 67 67 65  nd get the sugge
1510: 73 74 65 64 20 63 61 63 68 65 2d 73 69 7a 65 20  sted cache-size 
1520: 66 6f 72 20 74 68 65 20 73 70 65 63 69 66 69 65  for the specifie
1530: 64 20 70 61 67 65 72 2d 63 61 63 68 65 2e 0a 2a  d pager-cache..*
1540: 2a 0a 2a 2a 20 49 66 20 6e 6f 20 67 6c 6f 62 61  *.** If no globa
1550: 6c 20 6d 61 78 69 6d 75 6d 20 69 73 20 63 6f 6e  l maximum is con
1560: 66 69 67 75 72 65 64 2c 20 74 68 65 6e 20 74 68  figured, then th
1570: 65 20 73 79 73 74 65 6d 20 61 74 74 65 6d 70 74  e system attempt
1580: 73 20 74 6f 20 6c 69 6d 69 74 0a 2a 2a 20 74 68  s to limit.** th
1590: 65 20 74 6f 74 61 6c 20 6e 75 6d 62 65 72 20 6f  e total number o
15a0: 66 20 70 61 67 65 73 20 63 61 63 68 65 64 20 62  f pages cached b
15b0: 79 20 70 75 72 67 65 61 62 6c 65 20 70 61 67 65  y purgeable page
15c0: 72 2d 63 61 63 68 65 73 20 74 6f 20 74 68 65 20  r-caches to the 
15d0: 73 75 6d 0a 2a 2a 20 6f 66 20 74 68 65 20 73 75  sum.** of the su
15e0: 67 67 65 73 74 65 64 20 63 61 63 68 65 2d 73 69  ggested cache-si
15f0: 7a 65 73 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c  zes..*/.void sql
1600: 69 74 65 33 50 63 61 63 68 65 53 65 74 43 61 63  ite3PcacheSetCac
1610: 68 65 73 69 7a 65 28 50 43 61 63 68 65 20 2a 2c  hesize(PCache *,
1620: 20 69 6e 74 29 3b 0a 23 69 66 64 65 66 20 53 51   int);.#ifdef SQ
1630: 4c 49 54 45 5f 54 45 53 54 0a 69 6e 74 20 73 71  LITE_TEST.int sq
1640: 6c 69 74 65 33 50 63 61 63 68 65 47 65 74 43 61  lite3PcacheGetCa
1650: 63 68 65 73 69 7a 65 28 50 43 61 63 68 65 20 2a  chesize(PCache *
1660: 29 3b 0a 23 65 6e 64 69 66 0a 0a 2f 2a 20 53 65  );.#endif../* Se
1670: 74 20 6f 72 20 67 65 74 20 74 68 65 20 73 75 67  t or get the sug
1680: 67 65 73 74 65 64 20 73 70 69 6c 6c 2d 73 69 7a  gested spill-siz
1690: 65 20 66 6f 72 20 74 68 65 20 73 70 65 63 69 66  e for the specif
16a0: 69 65 64 20 70 61 67 65 72 2d 63 61 63 68 65 2e  ied pager-cache.
16b0: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 70 69 6c 6c  .**.** The spill
16c0: 2d 73 69 7a 65 20 69 73 20 74 68 65 20 6d 69 6e  -size is the min
16d0: 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66 20 70  imum number of p
16e0: 61 67 65 73 20 69 6e 20 63 61 63 68 65 20 62 65  ages in cache be
16f0: 66 6f 72 65 20 74 68 65 20 63 61 63 68 65 0a 2a  fore the cache.*
1700: 2a 20 77 69 6c 6c 20 61 74 74 65 6d 70 74 20 74  * will attempt t
1710: 6f 20 73 70 69 6c 6c 20 64 69 72 74 79 20 70 61  o spill dirty pa
1720: 67 65 73 20 62 79 20 63 61 6c 6c 69 6e 67 20 78  ges by calling x
1730: 53 74 72 65 73 73 2e 0a 2a 2f 0a 69 6e 74 20 73  Stress..*/.int s
1740: 71 6c 69 74 65 33 50 63 61 63 68 65 53 65 74 53  qlite3PcacheSetS
1750: 70 69 6c 6c 73 69 7a 65 28 50 43 61 63 68 65 20  pillsize(PCache 
1760: 2a 2c 20 69 6e 74 29 3b 0a 0a 2f 2a 20 46 72 65  *, int);../* Fre
1770: 65 20 75 70 20 61 73 20 6d 75 63 68 20 6d 65 6d  e up as much mem
1780: 6f 72 79 20 61 73 20 70 6f 73 73 69 62 6c 65 20  ory as possible 
1790: 66 72 6f 6d 20 74 68 65 20 70 61 67 65 20 63 61  from the page ca
17a0: 63 68 65 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69  che */.void sqli
17b0: 74 65 33 50 63 61 63 68 65 53 68 72 69 6e 6b 28  te3PcacheShrink(
17c0: 50 43 61 63 68 65 2a 29 3b 0a 0a 23 69 66 64 65  PCache*);..#ifde
17d0: 66 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f  f SQLITE_ENABLE_
17e0: 4d 45 4d 4f 52 59 5f 4d 41 4e 41 47 45 4d 45 4e  MEMORY_MANAGEMEN
17f0: 54 0a 2f 2a 20 54 72 79 20 74 6f 20 72 65 74 75  T./* Try to retu
1800: 72 6e 20 6d 65 6d 6f 72 79 20 75 73 65 64 20 62  rn memory used b
1810: 79 20 74 68 65 20 70 63 61 63 68 65 20 6d 6f 64  y the pcache mod
1820: 75 6c 65 20 74 6f 20 74 68 65 20 6d 61 69 6e 20  ule to the main 
1830: 6d 65 6d 6f 72 79 20 68 65 61 70 20 2a 2f 0a 69  memory heap */.i
1840: 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  nt sqlite3Pcache
1850: 52 65 6c 65 61 73 65 4d 65 6d 6f 72 79 28 69 6e  ReleaseMemory(in
1860: 74 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 69 66 64  t);.#endif..#ifd
1870: 65 66 20 53 51 4c 49 54 45 5f 54 45 53 54 0a 76  ef SQLITE_TEST.v
1880: 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68  oid sqlite3Pcach
1890: 65 53 74 61 74 73 28 69 6e 74 2a 2c 69 6e 74 2a  eStats(int*,int*
18a0: 2c 69 6e 74 2a 2c 69 6e 74 2a 29 3b 0a 23 65 6e  ,int*,int*);.#en
18b0: 64 69 66 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65  dif..void sqlite
18c0: 33 50 43 61 63 68 65 53 65 74 44 65 66 61 75 6c  3PCacheSetDefaul
18d0: 74 28 76 6f 69 64 29 3b 0a 0a 2f 2a 20 52 65 74  t(void);../* Ret
18e0: 75 72 6e 20 74 68 65 20 68 65 61 64 65 72 20 73  urn the header s
18f0: 69 7a 65 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  ize */.int sqlit
1900: 65 33 48 65 61 64 65 72 53 69 7a 65 50 63 61 63  e3HeaderSizePcac
1910: 68 65 28 76 6f 69 64 29 3b 0a 69 6e 74 20 73 71  he(void);.int sq
1920: 6c 69 74 65 33 48 65 61 64 65 72 53 69 7a 65 50  lite3HeaderSizeP
1930: 63 61 63 68 65 31 28 76 6f 69 64 29 3b 0a 0a 2f  cache1(void);../
1940: 2a 20 4e 75 6d 62 65 72 20 6f 66 20 64 69 72 74  * Number of dirt
1950: 79 20 70 61 67 65 73 20 61 73 20 61 20 70 65 72  y pages as a per
1960: 63 65 6e 74 61 67 65 20 6f 66 20 74 68 65 20 63  centage of the c
1970: 6f 6e 66 69 67 75 72 65 64 20 63 61 63 68 65 20  onfigured cache 
1980: 73 69 7a 65 20 2a 2f 0a 69 6e 74 20 73 71 6c 69  size */.int sqli
1990: 74 65 33 50 43 61 63 68 65 50 65 72 63 65 6e 74  te3PCachePercent
19a0: 44 69 72 74 79 28 50 43 61 63 68 65 2a 29 3b 0a  Dirty(PCache*);.
19b0: 0a 23 65 6e 64 69 66 20 2f 2a 20 5f 50 43 41 43  .#endif /* _PCAC
19c0: 48 45 5f 48 5f 20 2a 2f 0a                       HE_H_ */.