/ Hex Artifact Content
Login

Artifact 1457e4e7ef08f6964399d5c039afdece25071d54:


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 34 20 32 30 30 38 2f 30 38 2f 32  ,v 1.4 2008/08/2
01f0: 32 20 31 36 3a 32 32 3a 31 37 20 64 61 6e 69 65  2 16:22:17 danie
0200: 6c 6b 31 39 37 37 20 45 78 70 20 24 0a 2a 2f 0a  lk1977 Exp $.*/.
0210: 0a 23 69 66 6e 64 65 66 20 5f 50 43 41 43 48 45  .#ifndef _PCACHE
0220: 5f 48 5f 0a 0a 74 79 70 65 64 65 66 20 73 74 72  _H_..typedef str
0230: 75 63 74 20 50 67 48 64 72 20 50 67 48 64 72 3b  uct PgHdr PgHdr;
0240: 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
0250: 50 43 61 63 68 65 20 50 43 61 63 68 65 3b 0a 0a  PCache PCache;..
0260: 2f 2a 0a 2a 2a 20 45 76 65 72 79 20 70 61 67 65  /*.** Every page
0270: 20 69 6e 20 74 68 65 20 63 61 63 68 65 20 69 73   in the cache is
0280: 20 63 6f 6e 74 72 6f 6c 6c 65 64 20 62 79 20 61   controlled by a
0290: 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 20 74 68  n instance of th
02a0: 65 20 66 6f 6c 6c 6f 77 69 6e 67 0a 2a 2a 20 73  e following.** s
02b0: 74 72 75 63 74 75 72 65 2e 0a 2a 2f 0a 73 74 72  tructure..*/.str
02c0: 75 63 74 20 50 67 48 64 72 20 7b 0a 20 20 75 33  uct PgHdr {.  u3
02d0: 32 20 66 6c 61 67 73 3b 20 20 20 20 20 20 20 20  2 flags;        
02e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
02f0: 50 47 48 44 52 20 66 6c 61 67 73 20 64 65 66 69  PGHDR flags defi
0300: 6e 65 64 20 62 65 6c 6f 77 20 2a 2f 0a 20 20 76  ned below */.  v
0310: 6f 69 64 20 2a 70 44 61 74 61 3b 20 20 20 20 20  oid *pData;     
0320: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a                /*
0330: 20 43 6f 6e 74 65 6e 74 20 6f 66 20 74 68 69 73   Content of this
0340: 20 70 61 67 65 20 2a 2f 0a 20 20 76 6f 69 64 20   page */.  void 
0350: 2a 70 45 78 74 72 61 3b 20 20 20 20 20 20 20 20  *pExtra;        
0360: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 45 78 74            /* Ext
0370: 72 61 20 63 6f 6e 74 65 6e 74 20 2a 2f 0a 20 20  ra content */.  
0380: 50 67 48 64 72 20 2a 70 44 69 72 74 79 3b 20 20  PgHdr *pDirty;  
0390: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
03a0: 2a 20 54 72 61 6e 73 69 65 6e 74 20 6c 69 73 74  * Transient list
03b0: 20 6f 66 20 64 69 72 74 79 20 70 61 67 65 73 20   of dirty pages 
03c0: 2a 2f 0a 20 20 50 67 6e 6f 20 70 67 6e 6f 3b 20  */.  Pgno pgno; 
03d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
03e0: 20 20 20 20 2f 2a 20 50 61 67 65 20 6e 75 6d 62      /* Page numb
03f0: 65 72 20 66 6f 72 20 74 68 69 73 20 70 61 67 65  er for this page
0400: 20 2a 2f 0a 20 20 50 61 67 65 72 20 2a 70 50 61   */.  Pager *pPa
0410: 67 65 72 3b 0a 23 69 66 64 65 66 20 53 51 4c 49  ger;.#ifdef SQLI
0420: 54 45 5f 43 48 45 43 4b 5f 50 41 47 45 53 0a 20  TE_CHECK_PAGES. 
0430: 20 75 33 32 20 70 61 67 65 48 61 73 68 3b 0a 23   u32 pageHash;.#
0440: 65 6e 64 69 66 0a 20 20 2f 2a 2a 2a 20 50 75 62  endif.  /*** Pub
0450: 6c 69 63 20 64 61 74 61 20 69 73 20 61 62 6f 76  lic data is abov
0460: 65 2e 20 41 6c 6c 20 74 68 61 74 20 66 6f 6c 6c  e. All that foll
0470: 6f 77 73 20 69 73 20 70 72 69 76 61 74 65 20 74  ows is private t
0480: 6f 20 70 63 61 63 68 65 2e 63 20 2a 2a 2a 2f 0a  o pcache.c ***/.
0490: 20 20 50 43 61 63 68 65 20 2a 70 43 61 63 68 65    PCache *pCache
04a0: 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ;               
04b0: 20 2f 2a 20 43 61 63 68 65 20 74 68 61 74 20 6f   /* Cache that o
04c0: 77 6e 73 20 74 68 69 73 20 70 61 67 65 20 2a 2f  wns this page */
04d0: 0a 20 20 50 67 48 64 72 20 2a 70 4e 65 78 74 48  .  PgHdr *pNextH
04e0: 61 73 68 2c 20 2a 70 50 72 65 76 48 61 73 68 3b  ash, *pPrevHash;
04f0: 20 20 2f 2a 20 48 61 73 68 20 63 6f 6c 6c 69 73    /* Hash collis
0500: 69 6f 6e 20 63 68 61 69 6e 20 66 6f 72 20 50 67  ion chain for Pg
0510: 48 64 72 2e 70 67 6e 6f 20 2a 2f 0a 20 20 50 67  Hdr.pgno */.  Pg
0520: 48 64 72 20 2a 70 4e 65 78 74 2c 20 2a 70 50 72  Hdr *pNext, *pPr
0530: 65 76 3b 20 20 20 20 20 20 20 20 20 20 2f 2a 20  ev;          /* 
0540: 4c 69 73 74 20 6f 66 20 63 6c 65 61 6e 20 6f 72  List of clean or
0550: 20 64 69 72 74 79 20 70 61 67 65 73 20 2a 2f 0a   dirty pages */.
0560: 20 20 50 67 48 64 72 20 2a 70 4e 65 78 74 4c 72    PgHdr *pNextLr
0570: 75 2c 20 2a 70 50 72 65 76 4c 72 75 3b 20 20 20  u, *pPrevLru;   
0580: 20 2f 2a 20 50 61 72 74 20 6f 66 20 67 6c 6f 62   /* Part of glob
0590: 61 6c 20 4c 52 55 20 6c 69 73 74 20 2a 2f 0a 20  al LRU list */. 
05a0: 20 69 6e 74 20 6e 52 65 66 3b 20 20 20 20 20 20   int nRef;      
05b0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
05c0: 2f 2a 20 4e 75 6d 62 65 72 20 6f 66 20 75 73 65  /* Number of use
05d0: 72 73 20 6f 66 20 74 68 69 73 20 70 61 67 65 20  rs of this page 
05e0: 2a 2f 0a 20 20 76 6f 69 64 20 2a 61 70 53 61 76  */.  void *apSav
05f0: 65 5b 32 5d 3b 20 20 20 20 20 20 20 20 20 20 20  e[2];           
0600: 20 20 20 20 2f 2a 20 4a 6f 75 72 6e 61 6c 20 65      /* Journal e
0610: 6e 74 72 69 65 73 20 66 6f 72 20 69 6e 2d 6d 65  ntries for in-me
0620: 6d 6f 72 79 20 64 61 74 61 62 61 73 65 73 20 2a  mory databases *
0630: 2f 0a 7d 3b 0a 0a 2f 2a 20 42 69 74 20 76 61 6c  /.};../* Bit val
0640: 75 65 73 20 66 6f 72 20 50 67 48 64 72 2e 66 6c  ues for PgHdr.fl
0650: 61 67 73 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50  ags */.#define P
0660: 47 48 44 52 5f 49 4e 5f 4a 4f 55 52 4e 41 4c 20  GHDR_IN_JOURNAL 
0670: 20 20 20 20 20 20 20 30 78 30 30 31 20 20 2f 2a         0x001  /*
0680: 20 50 61 67 65 20 69 73 20 69 6e 20 72 6f 6c 6c   Page is in roll
0690: 62 61 63 6b 20 6a 6f 75 72 6e 61 6c 20 2a 2f 0a  back journal */.
06a0: 23 64 65 66 69 6e 65 20 50 47 48 44 52 5f 49 4e  #define PGHDR_IN
06b0: 5f 53 54 4d 54 4a 52 4e 4c 20 20 20 20 20 20 20  _STMTJRNL       
06c0: 30 78 30 30 32 20 20 2f 2a 20 50 61 67 65 20 69  0x002  /* Page i
06d0: 73 20 69 6e 20 74 68 65 20 73 74 61 74 65 6d 65  s in the stateme
06e0: 6e 74 20 6a 6f 75 72 6e 61 6c 20 2a 2f 0a 23 64  nt journal */.#d
06f0: 65 66 69 6e 65 20 50 47 48 44 52 5f 44 49 52 54  efine PGHDR_DIRT
0700: 59 20 20 20 20 20 20 20 20 20 20 20 20 20 30 78  Y             0x
0710: 30 30 34 20 20 2f 2a 20 50 61 67 65 20 68 61 73  004  /* Page has
0720: 20 63 68 61 6e 67 65 64 20 2a 2f 0a 23 64 65 66   changed */.#def
0730: 69 6e 65 20 50 47 48 44 52 5f 4e 45 45 44 5f 53  ine PGHDR_NEED_S
0740: 59 4e 43 20 20 20 20 20 20 20 20 20 30 78 30 30  YNC         0x00
0750: 38 20 20 2f 2a 20 50 65 65 64 20 74 6f 20 66 73  8  /* Peed to fs
0760: 79 6e 63 20 74 68 69 73 20 70 61 67 65 20 2a 2f  ync this page */
0770: 0a 23 64 65 66 69 6e 65 20 50 47 48 44 52 5f 41  .#define PGHDR_A
0780: 4c 57 41 59 53 5f 52 4f 4c 4c 42 41 43 4b 20 20  LWAYS_ROLLBACK  
0790: 20 30 78 30 31 30 20 20 2f 2a 20 46 6f 72 63 65   0x010  /* Force
07a0: 20 77 72 69 74 69 6e 67 20 74 6f 20 6a 6f 75 72   writing to jour
07b0: 6e 61 6c 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50  nal */.#define P
07c0: 47 48 44 52 5f 4e 45 45 44 5f 52 45 41 44 20 20  GHDR_NEED_READ  
07d0: 20 20 20 20 20 20 20 30 78 30 32 30 20 20 2f 2a         0x020  /*
07e0: 20 43 6f 6e 74 65 6e 74 20 69 73 20 75 6e 72 65   Content is unre
07f0: 61 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 50 47  ad */.#define PG
0800: 48 44 52 5f 49 53 5f 49 4e 49 54 20 20 20 20 20  HDR_IS_INIT     
0810: 20 20 20 20 20 20 30 78 30 34 30 20 20 2f 2a 20        0x040  /* 
0820: 70 44 61 74 61 20 69 73 20 69 6e 69 74 69 61 6c  pData is initial
0830: 69 7a 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20  ized */.#define 
0840: 50 47 48 44 52 5f 52 45 55 53 45 5f 55 4e 4c 49  PGHDR_REUSE_UNLI
0850: 4b 45 4c 59 20 20 20 20 30 78 30 38 30 20 20 2f  KELY    0x080  /
0860: 2a 20 48 69 6e 74 3a 20 52 65 75 73 65 20 69 73  * Hint: Reuse is
0870: 20 75 6e 6c 69 6b 65 6c 79 20 2a 2f 0a 0a 0a 2f   unlikely */.../
0880: 2a 20 49 6e 69 74 69 61 6c 69 7a 65 20 61 6e 64  * Initialize and
0890: 20 73 68 75 74 64 6f 77 6e 20 74 68 65 20 70 61   shutdown the pa
08a0: 67 65 20 63 61 63 68 65 20 73 75 62 73 79 73 74  ge cache subsyst
08b0: 65 6d 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  em */.int sqlite
08c0: 33 50 63 61 63 68 65 49 6e 69 74 69 61 6c 69 7a  3PcacheInitializ
08d0: 65 28 76 6f 69 64 29 3b 0a 76 6f 69 64 20 73 71  e(void);.void sq
08e0: 6c 69 74 65 33 50 63 61 63 68 65 53 68 75 74 64  lite3PcacheShutd
08f0: 6f 77 6e 28 76 6f 69 64 29 3b 0a 0a 2f 2a 20 50  own(void);../* P
0900: 61 67 65 20 63 61 63 68 65 20 62 75 66 66 65 72  age cache buffer
0910: 20 6d 61 6e 61 67 65 6d 65 6e 74 3a 0a 2a 2a 20   management:.** 
0920: 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 69  These routines i
0930: 6d 70 6c 65 6d 65 6e 74 20 53 51 4c 49 54 45 5f  mplement SQLITE_
0940: 43 4f 4e 46 49 47 5f 50 41 47 45 43 41 43 48 45  CONFIG_PAGECACHE
0950: 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65  ..*/.void sqlite
0960: 33 50 43 61 63 68 65 42 75 66 66 65 72 53 65 74  3PCacheBufferSet
0970: 75 70 28 76 6f 69 64 20 2a 2c 20 69 6e 74 20 73  up(void *, int s
0980: 7a 2c 20 69 6e 74 20 6e 29 3b 0a 76 6f 69 64 20  z, int n);.void 
0990: 2a 73 71 6c 69 74 65 33 50 43 61 63 68 65 4d 61  *sqlite3PCacheMa
09a0: 6c 6c 6f 63 28 69 6e 74 20 73 7a 29 3b 0a 76 6f  lloc(int sz);.vo
09b0: 69 64 20 73 71 6c 69 74 65 33 50 43 61 63 68 65  id sqlite3PCache
09c0: 46 72 65 65 28 76 6f 69 64 2a 29 3b 0a 0a 2f 2a  Free(void*);../*
09d0: 20 43 72 65 61 74 65 20 61 20 6e 65 77 20 70 61   Create a new pa
09e0: 67 65 72 20 63 61 63 68 65 2e 0a 2a 2a 20 55 6e  ger cache..** Un
09f0: 64 65 72 20 6d 65 6d 6f 72 79 20 73 74 72 65 73  der memory stres
0a00: 73 2c 20 69 6e 76 6f 6b 65 20 78 53 74 72 65 73  s, invoke xStres
0a10: 73 20 74 6f 20 74 72 79 20 74 6f 20 6d 61 6b 65  s to try to make
0a20: 20 70 61 67 65 73 20 63 6c 65 61 6e 2e 0a 2a 2a   pages clean..**
0a30: 20 4f 6e 6c 79 20 63 6c 65 61 6e 20 61 6e 64 20   Only clean and 
0a40: 75 6e 70 69 6e 6e 65 64 20 70 61 67 65 73 20 63  unpinned pages c
0a50: 61 6e 20 62 65 20 72 65 63 6c 61 69 6d 65 64 2e  an be reclaimed.
0a60: 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  .*/.void sqlite3
0a70: 50 63 61 63 68 65 4f 70 65 6e 28 0a 20 20 69 6e  PcacheOpen(.  in
0a80: 74 20 73 7a 50 61 67 65 2c 20 20 20 20 20 20 20  t szPage,       
0a90: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
0aa0: 53 69 7a 65 20 6f 66 20 65 76 65 72 79 20 70 61  Size of every pa
0ab0: 67 65 20 2a 2f 0a 20 20 69 6e 74 20 73 7a 45 78  ge */.  int szEx
0ac0: 74 72 61 2c 20 20 20 20 20 20 20 20 20 20 20 20  tra,            
0ad0: 20 20 20 20 20 20 20 2f 2a 20 45 78 74 72 61 20         /* Extra 
0ae0: 73 70 61 63 65 20 61 73 73 6f 63 69 61 74 65 64  space associated
0af0: 20 77 69 74 68 20 65 61 63 68 20 70 61 67 65 20   with each page 
0b00: 2a 2f 0a 20 20 69 6e 74 20 62 50 75 72 67 65 61  */.  int bPurgea
0b10: 62 6c 65 2c 20 20 20 20 20 20 20 20 20 20 20 20  ble,            
0b20: 20 20 20 20 2f 2a 20 54 72 75 65 20 69 66 20 70      /* True if p
0b30: 61 67 65 73 20 61 72 65 20 6f 6e 20 62 61 63 6b  ages are on back
0b40: 69 6e 67 20 73 74 6f 72 65 20 2a 2f 0a 20 20 76  ing store */.  v
0b50: 6f 69 64 20 28 2a 78 44 65 73 74 72 6f 79 29 28  oid (*xDestroy)(
0b60: 50 67 48 64 72 20 2a 29 2c 20 20 20 20 20 2f 2a  PgHdr *),     /*
0b70: 20 43 61 6c 6c 65 64 20 74 6f 20 64 65 73 74 72   Called to destr
0b80: 6f 79 20 61 20 70 61 67 65 20 2a 2f 0a 20 20 69  oy a page */.  i
0b90: 6e 74 20 28 2a 78 53 74 72 65 73 73 29 28 76 6f  nt (*xStress)(vo
0ba0: 69 64 2a 2c 20 50 67 48 64 72 2a 29 2c 20 2f 2a  id*, PgHdr*), /*
0bb0: 20 43 61 6c 6c 20 74 6f 20 74 72 79 20 74 6f 20   Call to try to 
0bc0: 6d 61 6b 65 20 70 61 67 65 73 20 63 6c 65 61 6e  make pages clean
0bd0: 20 2a 2f 0a 20 20 76 6f 69 64 20 2a 70 53 74 72   */.  void *pStr
0be0: 65 73 73 2c 20 20 20 20 20 20 20 20 20 20 20 20  ess,            
0bf0: 20 20 20 20 20 2f 2a 20 41 72 67 75 6d 65 6e 74       /* Argument
0c00: 20 74 6f 20 78 53 74 72 65 73 73 20 2a 2f 0a 20   to xStress */. 
0c10: 20 50 43 61 63 68 65 20 2a 70 54 6f 49 6e 69 74   PCache *pToInit
0c20: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0c30: 2f 2a 20 50 72 65 61 6c 6c 6f 63 61 74 65 64 20  /* Preallocated 
0c40: 73 70 61 63 65 20 66 6f 72 20 74 68 65 20 50 43  space for the PC
0c50: 61 63 68 65 20 2a 2f 0a 29 3b 0a 0a 2f 2a 20 4d  ache */.);../* M
0c60: 6f 64 69 66 79 20 74 68 65 20 70 61 67 65 2d 73  odify the page-s
0c70: 69 7a 65 20 61 66 74 65 72 20 74 68 65 20 63 61  ize after the ca
0c80: 63 68 65 20 68 61 73 20 62 65 65 6e 20 63 72 65  che has been cre
0c90: 61 74 65 64 2e 20 2a 2f 0a 76 6f 69 64 20 73 71  ated. */.void sq
0ca0: 6c 69 74 65 33 50 63 61 63 68 65 53 65 74 50 61  lite3PcacheSetPa
0cb0: 67 65 53 69 7a 65 28 50 43 61 63 68 65 20 2a 2c  geSize(PCache *,
0cc0: 20 69 6e 74 29 3b 0a 0a 2f 2a 20 52 65 74 75 72   int);../* Retur
0cd0: 6e 20 74 68 65 20 73 69 7a 65 20 69 6e 20 62 79  n the size in by
0ce0: 74 65 73 20 6f 66 20 61 20 50 43 61 63 68 65 20  tes of a PCache 
0cf0: 6f 62 6a 65 63 74 2e 20 20 55 73 65 64 20 74 6f  object.  Used to
0d00: 20 70 72 65 61 6c 6c 6f 63 61 74 65 0a 2a 2a 20   preallocate.** 
0d10: 73 74 6f 72 61 67 65 20 73 70 61 63 65 2e 0a 2a  storage space..*
0d20: 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61  /.int sqlite3Pca
0d30: 63 68 65 53 69 7a 65 28 76 6f 69 64 29 3b 0a 0a  cheSize(void);..
0d40: 2f 2a 20 4f 6e 65 20 72 65 6c 65 61 73 65 20 70  /* One release p
0d50: 65 72 20 73 75 63 63 65 73 73 66 75 6c 20 66 65  er successful fe
0d60: 74 63 68 2e 20 20 50 61 67 65 20 69 73 20 70 69  tch.  Page is pi
0d70: 6e 6e 65 64 20 75 6e 74 69 6c 20 72 65 6c 65 61  nned until relea
0d80: 73 65 64 2e 0a 2a 2a 20 52 65 66 65 72 65 6e 63  sed..** Referenc
0d90: 65 20 63 6f 75 6e 74 65 64 2e 20 0a 2a 2f 0a 69  e counted. .*/.i
0da0: 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  nt sqlite3Pcache
0db0: 46 65 74 63 68 28 50 43 61 63 68 65 2a 2c 20 50  Fetch(PCache*, P
0dc0: 67 6e 6f 2c 20 69 6e 74 20 63 72 65 61 74 65 46  gno, int createF
0dd0: 6c 61 67 2c 20 50 67 48 64 72 2a 2a 29 3b 0a 76  lag, PgHdr**);.v
0de0: 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68  oid sqlite3Pcach
0df0: 65 52 65 6c 65 61 73 65 28 50 67 48 64 72 2a 29  eRelease(PgHdr*)
0e00: 3b 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50  ;..void sqlite3P
0e10: 63 61 63 68 65 44 72 6f 70 28 50 67 48 64 72 2a  cacheDrop(PgHdr*
0e20: 29 3b 20 20 20 20 20 20 20 20 20 2f 2a 20 52 65  );         /* Re
0e30: 6d 6f 76 65 20 70 61 67 65 20 66 72 6f 6d 20 63  move page from c
0e40: 61 63 68 65 20 2a 2f 0a 76 6f 69 64 20 73 71 6c  ache */.void sql
0e50: 69 74 65 33 50 63 61 63 68 65 4d 61 6b 65 44 69  ite3PcacheMakeDi
0e60: 72 74 79 28 50 67 48 64 72 2a 29 3b 20 20 20 20  rty(PgHdr*);    
0e70: 2f 2a 20 4d 61 6b 65 20 73 75 72 65 20 70 61 67  /* Make sure pag
0e80: 65 20 69 73 20 6d 61 72 6b 65 64 20 64 69 72 74  e is marked dirt
0e90: 79 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65  y */.void sqlite
0ea0: 33 50 63 61 63 68 65 4d 61 6b 65 43 6c 65 61 6e  3PcacheMakeClean
0eb0: 28 50 67 48 64 72 2a 29 3b 20 20 20 20 2f 2a 20  (PgHdr*);    /* 
0ec0: 4d 61 72 6b 20 61 20 73 69 6e 67 6c 65 20 70 61  Mark a single pa
0ed0: 67 65 20 61 73 20 63 6c 65 61 6e 20 2a 2f 0a 76  ge as clean */.v
0ee0: 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68  oid sqlite3Pcach
0ef0: 65 43 6c 65 61 6e 41 6c 6c 28 50 43 61 63 68 65  eCleanAll(PCache
0f00: 2a 29 3b 20 20 20 20 2f 2a 20 4d 61 72 6b 20 61  *);    /* Mark a
0f10: 6c 6c 20 64 69 72 74 79 20 6c 69 73 74 20 70 61  ll dirty list pa
0f20: 67 65 73 20 61 73 20 63 6c 65 61 6e 20 2a 2f 0a  ges as clean */.
0f30: 0a 2f 2a 20 43 68 61 6e 67 65 20 61 20 70 61 67  ./* Change a pag
0f40: 65 20 6e 75 6d 62 65 72 2e 20 20 55 73 65 64 20  e number.  Used 
0f50: 62 79 20 69 6e 63 72 2d 76 61 63 75 75 6d 2e 20  by incr-vacuum. 
0f60: 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 50  */.void sqlite3P
0f70: 63 61 63 68 65 4d 6f 76 65 28 50 67 48 64 72 2a  cacheMove(PgHdr*
0f80: 2c 20 50 67 6e 6f 29 3b 0a 0a 2f 2a 20 53 65 74  , Pgno);../* Set
0f90: 20 61 20 67 6c 6f 62 61 6c 20 6d 61 78 69 6d 75   a global maximu
0fa0: 6d 20 70 61 67 65 20 63 6f 75 6e 74 20 66 6f 72  m page count for
0fb0: 20 61 6c 6c 20 70 61 67 65 20 63 61 63 68 65 73   all page caches
0fc0: 2e 20 0a 2a 2a 20 49 66 20 74 68 65 20 73 75 6d  . .** If the sum
0fd0: 20 6f 66 20 69 6e 64 69 76 69 64 75 61 6c 20 63   of individual c
0fe0: 61 63 68 65 20 6d 61 78 65 73 20 65 78 63 65 65  ache maxes excee
0ff0: 64 20 74 68 65 20 67 6c 6f 62 61 6c 20 6d 61 78  d the global max
1000: 2c 20 74 68 65 0a 2a 2a 20 69 6e 64 69 76 69 64  , the.** individ
1010: 75 61 6c 73 20 61 72 65 20 73 63 61 6c 65 64 20  uals are scaled 
1020: 64 6f 77 6e 20 70 72 6f 70 6f 72 74 69 6f 6e 61  down proportiona
1030: 6c 6c 79 2e 20 0a 2a 2f 0a 76 6f 69 64 20 73 71  lly. .*/.void sq
1040: 6c 69 74 65 33 50 63 61 63 68 65 47 6c 6f 62 61  lite3PcacheGloba
1050: 6c 4d 61 78 28 69 6e 74 20 4e 29 3b 0a 0a 2f 2a  lMax(int N);../*
1060: 20 52 65 6d 6f 76 65 20 61 6c 6c 20 70 61 67 65   Remove all page
1070: 73 20 77 69 74 68 20 70 67 6e 6f 3e 78 2e 20 20  s with pgno>x.  
1080: 52 65 73 65 74 20 74 68 65 20 63 61 63 68 65 20  Reset the cache 
1090: 69 66 20 78 3d 3d 30 20 2a 2f 0a 76 6f 69 64 20  if x==0 */.void 
10a0: 73 71 6c 69 74 65 33 50 63 61 63 68 65 54 72 75  sqlite3PcacheTru
10b0: 6e 63 61 74 65 28 50 43 61 63 68 65 2a 2c 20 50  ncate(PCache*, P
10c0: 67 6e 6f 20 78 29 3b 0a 0a 2f 2a 20 52 6f 75 74  gno x);../* Rout
10d0: 69 6e 65 73 20 75 73 65 64 20 74 6f 20 69 6d 70  ines used to imp
10e0: 6c 65 6d 65 6e 74 20 74 72 61 6e 73 61 63 74 69  lement transacti
10f0: 6f 6e 73 20 6f 6e 20 6d 65 6d 6f 72 79 2d 6f 6e  ons on memory-on
1100: 6c 79 20 64 61 74 61 62 61 73 65 73 2e 20 2a 2f  ly databases. */
1110: 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61 63  .int sqlite3Pcac
1120: 68 65 50 72 65 73 65 72 76 65 28 50 67 48 64 72  hePreserve(PgHdr
1130: 2a 2c 20 69 6e 74 29 3b 20 20 20 20 2f 2a 20 50  *, int);    /* P
1140: 72 65 73 65 72 76 65 20 63 75 72 72 65 6e 74 20  reserve current 
1150: 70 61 67 65 20 63 6f 6e 74 65 6e 74 20 2a 2f 0a  page content */.
1160: 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63  void sqlite3Pcac
1170: 68 65 43 6f 6d 6d 69 74 28 50 43 61 63 68 65 2a  heCommit(PCache*
1180: 2c 20 69 6e 74 29 3b 20 20 20 20 2f 2a 20 44 72  , int);    /* Dr
1190: 6f 70 20 70 72 65 73 65 72 76 65 64 20 63 6f 70  op preserved cop
11a0: 79 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65  y */.void sqlite
11b0: 33 50 63 61 63 68 65 52 6f 6c 6c 62 61 63 6b 28  3PcacheRollback(
11c0: 50 43 61 63 68 65 2a 2c 20 69 6e 74 29 3b 20 20  PCache*, int);  
11d0: 2f 2a 20 52 6f 6c 6c 62 61 63 6b 20 74 6f 20 70  /* Rollback to p
11e0: 72 65 73 65 72 76 65 64 20 63 6f 70 79 20 2a 2f  reserved copy */
11f0: 0a 0a 2f 2a 20 47 65 74 20 61 20 6c 69 73 74 20  ../* Get a list 
1200: 6f 66 20 61 6c 6c 20 64 69 72 74 79 20 70 61 67  of all dirty pag
1210: 65 73 20 69 6e 20 74 68 65 20 63 61 63 68 65 2c  es in the cache,
1220: 20 73 6f 72 74 65 64 20 62 79 20 70 61 67 65 20   sorted by page 
1230: 6e 75 6d 62 65 72 20 2a 2f 0a 50 67 48 64 72 20  number */.PgHdr 
1240: 2a 73 71 6c 69 74 65 33 50 63 61 63 68 65 44 69  *sqlite3PcacheDi
1250: 72 74 79 4c 69 73 74 28 50 43 61 63 68 65 2a 29  rtyList(PCache*)
1260: 3b 0a 0a 2f 2a 20 52 65 73 65 74 20 61 6e 64 20  ;../* Reset and 
1270: 63 6c 6f 73 65 20 74 68 65 20 63 61 63 68 65 20  close the cache 
1280: 6f 62 6a 65 63 74 20 2a 2f 0a 76 6f 69 64 20 73  object */.void s
1290: 71 6c 69 74 65 33 50 63 61 63 68 65 43 6c 6f 73  qlite3PcacheClos
12a0: 65 28 50 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a 20  e(PCache*);../* 
12b0: 53 65 74 20 66 6c 61 67 73 20 6f 6e 20 61 6c 6c  Set flags on all
12c0: 20 70 61 67 65 73 20 69 6e 20 74 68 65 20 70 61   pages in the pa
12d0: 67 65 20 63 61 63 68 65 20 2a 2f 0a 76 6f 69 64  ge cache */.void
12e0: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 53 65   sqlite3PcacheSe
12f0: 74 46 6c 61 67 73 28 50 43 61 63 68 65 2a 2c 20  tFlags(PCache*, 
1300: 69 6e 74 20 61 6e 64 4d 61 73 6b 2c 20 69 6e 74  int andMask, int
1310: 20 6f 72 4d 61 73 6b 29 3b 0a 0a 2f 2a 20 41 73   orMask);../* As
1320: 73 65 72 74 20 66 6c 61 67 73 20 73 65 74 74 69  sert flags setti
1330: 6e 67 73 20 6f 6e 20 61 6c 6c 20 70 61 67 65 73  ngs on all pages
1340: 2e 20 20 44 65 62 75 67 67 69 6e 67 20 6f 6e 6c  .  Debugging onl
1350: 79 20 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65  y */.void sqlite
1360: 33 50 63 61 63 68 65 41 73 73 65 72 74 46 6c 61  3PcacheAssertFla
1370: 67 73 28 50 43 61 63 68 65 2a 2c 20 69 6e 74 20  gs(PCache*, int 
1380: 74 72 75 65 4d 61 73 6b 2c 20 69 6e 74 20 66 61  trueMask, int fa
1390: 6c 73 65 4d 61 73 6b 29 3b 0a 0a 2f 2a 20 52 65  lseMask);../* Re
13a0: 74 75 72 6e 20 74 72 75 65 20 69 66 20 74 68 65  turn true if the
13b0: 20 6e 75 6d 62 65 72 20 6f 66 20 64 69 72 74 79   number of dirty
13c0: 20 70 61 67 65 73 20 69 73 20 30 20 6f 72 20 31   pages is 0 or 1
13d0: 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50   */.int sqlite3P
13e0: 63 61 63 68 65 5a 65 72 6f 4f 72 4f 6e 65 44 69  cacheZeroOrOneDi
13f0: 72 74 79 50 61 67 65 73 28 50 43 61 63 68 65 2a  rtyPages(PCache*
1400: 29 3b 0a 0a 2f 2a 20 44 69 73 63 61 72 64 20 74  );../* Discard t
1410: 68 65 20 63 6f 6e 74 65 6e 74 73 20 6f 66 20 74  he contents of t
1420: 68 65 20 63 61 63 68 65 20 2a 2f 0a 69 6e 74 20  he cache */.int 
1430: 73 71 6c 69 74 65 33 50 63 61 63 68 65 43 6c 65  sqlite3PcacheCle
1440: 61 72 28 50 43 61 63 68 65 2a 29 3b 0a 0a 2f 2a  ar(PCache*);../*
1450: 20 52 65 74 75 72 6e 20 74 68 65 20 74 6f 74 61   Return the tota
1460: 6c 20 6e 75 6d 62 65 72 20 6f 66 20 6f 75 74 73  l number of outs
1470: 74 61 6e 64 69 6e 67 20 70 61 67 65 20 72 65 66  tanding page ref
1480: 65 72 65 6e 63 65 73 20 2a 2f 0a 69 6e 74 20 73  erences */.int s
1490: 71 6c 69 74 65 33 50 63 61 63 68 65 52 65 66 43  qlite3PcacheRefC
14a0: 6f 75 6e 74 28 50 43 61 63 68 65 2a 29 3b 0a 0a  ount(PCache*);..
14b0: 2f 2a 20 49 6e 63 72 65 6d 65 6e 74 20 74 68 65  /* Increment the
14c0: 20 72 65 66 65 72 65 6e 63 65 20 63 6f 75 6e 74   reference count
14d0: 20 6f 66 20 61 6e 20 65 78 69 73 74 69 6e 67 20   of an existing 
14e0: 70 61 67 65 20 2a 2f 0a 76 6f 69 64 20 73 71 6c  page */.void sql
14f0: 69 74 65 33 50 63 61 63 68 65 52 65 66 28 50 67  ite3PcacheRef(Pg
1500: 48 64 72 2a 29 3b 0a 0a 2f 2a 20 52 65 74 75 72  Hdr*);../* Retur
1510: 6e 20 74 68 65 20 74 6f 74 61 6c 20 6e 75 6d 62  n the total numb
1520: 65 72 20 6f 66 20 70 61 67 65 73 20 73 74 6f 72  er of pages stor
1530: 65 64 20 69 6e 20 74 68 65 20 63 61 63 68 65 20  ed in the cache 
1540: 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63  */.int sqlite3Pc
1550: 61 63 68 65 50 61 67 65 63 6f 75 6e 74 28 50 43  achePagecount(PC
1560: 61 63 68 65 2a 29 3b 0a 0a 2f 2a 20 49 74 65 72  ache*);../* Iter
1570: 61 74 65 20 74 68 72 6f 75 67 68 20 61 6c 6c 20  ate through all 
1580: 70 61 67 65 73 20 63 75 72 72 65 6e 74 6c 79 20  pages currently 
1590: 73 74 6f 72 65 64 20 69 6e 20 74 68 65 20 63 61  stored in the ca
15a0: 63 68 65 2e 20 54 68 69 73 20 69 6e 74 65 72 66  che. This interf
15b0: 61 63 65 0a 2a 2a 20 69 73 20 6f 6e 6c 79 20 61  ace.** is only a
15c0: 76 61 69 6c 61 62 6c 65 20 69 66 20 53 51 4c 49  vailable if SQLI
15d0: 54 45 5f 43 48 45 43 4b 5f 50 41 47 45 53 20 69  TE_CHECK_PAGES i
15e0: 73 20 64 65 66 69 6e 65 64 20 77 68 65 6e 20 74  s defined when t
15f0: 68 65 20 6c 69 62 72 61 72 79 20 69 73 20 0a 2a  he library is .*
1600: 2a 20 62 75 69 6c 74 2e 0a 2a 2f 0a 76 6f 69 64  * built..*/.void
1610: 20 73 71 6c 69 74 65 33 50 63 61 63 68 65 49 74   sqlite3PcacheIt
1620: 65 72 61 74 65 28 50 43 61 63 68 65 20 2a 70 43  erate(PCache *pC
1630: 61 63 68 65 2c 20 76 6f 69 64 20 28 2a 78 49 74  ache, void (*xIt
1640: 65 72 29 28 50 67 48 64 72 20 2a 29 29 3b 0a 0a  er)(PgHdr *));..
1650: 2f 2a 20 53 65 74 20 61 6e 64 20 67 65 74 20 74  /* Set and get t
1660: 68 65 20 73 75 67 67 65 73 74 65 64 20 63 61 63  he suggested cac
1670: 68 65 2d 73 69 7a 65 20 66 6f 72 20 74 68 65 20  he-size for the 
1680: 73 70 65 63 69 66 69 65 64 20 70 61 67 65 72 2d  specified pager-
1690: 63 61 63 68 65 2e 20 49 66 0a 2a 2a 20 61 20 67  cache. If.** a g
16a0: 6c 6f 62 61 6c 20 6d 61 78 69 6d 75 6d 20 6f 6e  lobal maximum on
16b0: 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 70   the number of p
16c0: 61 67 65 73 20 63 61 63 68 65 64 20 62 79 20 74  ages cached by t
16d0: 68 65 20 73 79 73 74 65 6d 20 69 73 20 0a 2a 2a  he system is .**
16e0: 20 63 6f 6e 66 69 67 75 72 65 64 20 76 69 61 20   configured via 
16f0: 74 68 65 20 73 71 6c 69 74 65 33 50 63 61 63 68  the sqlite3Pcach
1700: 65 47 6c 6f 62 61 6c 4d 61 78 28 29 20 41 50 49  eGlobalMax() API
1710: 2c 20 74 68 65 6e 20 74 68 65 20 73 75 67 67 65  , then the sugge
1720: 73 74 65 64 0a 2a 2a 20 63 61 63 68 65 2d 73 69  sted.** cache-si
1730: 7a 65 73 20 61 72 65 20 6e 6f 74 20 75 73 65 64  zes are not used
1740: 20 61 74 20 61 6c 6c 2e 0a 2a 2a 0a 2a 2a 20 49   at all..**.** I
1750: 66 20 6e 6f 20 67 6c 6f 62 61 6c 20 6d 61 78 69  f no global maxi
1760: 6d 75 6d 20 69 73 20 63 6f 6e 66 69 67 75 72 65  mum is configure
1770: 64 2c 20 74 68 65 6e 20 74 68 65 20 73 79 73 74  d, then the syst
1780: 65 6d 20 61 74 74 65 6d 70 74 73 20 74 6f 20 6c  em attempts to l
1790: 69 6d 69 74 0a 2a 2a 20 74 68 65 20 74 6f 74 61  imit.** the tota
17a0: 6c 20 6e 75 6d 62 65 72 20 6f 66 20 70 61 67 65  l number of page
17b0: 73 20 63 61 63 68 65 64 20 62 79 20 70 75 72 67  s cached by purg
17c0: 65 61 62 6c 65 20 70 61 67 65 72 2d 63 61 63 68  eable pager-cach
17d0: 65 73 20 74 6f 20 74 68 65 20 73 75 6d 0a 2a 2a  es to the sum.**
17e0: 20 6f 66 20 74 68 65 20 73 75 67 67 65 73 74 65   of the suggeste
17f0: 64 20 63 61 63 68 65 2d 73 69 7a 65 73 2e 0a 2a  d cache-sizes..*
1800: 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 50 63 61  /.int sqlite3Pca
1810: 63 68 65 47 65 74 43 61 63 68 65 73 69 7a 65 28  cheGetCachesize(
1820: 50 43 61 63 68 65 20 2a 29 3b 0a 76 6f 69 64 20  PCache *);.void 
1830: 73 71 6c 69 74 65 33 50 63 61 63 68 65 53 65 74  sqlite3PcacheSet
1840: 43 61 63 68 65 73 69 7a 65 28 50 43 61 63 68 65  Cachesize(PCache
1850: 20 2a 2c 20 69 6e 74 29 3b 0a 0a 2f 2a 20 4c 6f   *, int);../* Lo
1860: 63 6b 20 61 6e 64 20 75 6e 6c 6f 63 6b 20 61 20  ck and unlock a 
1870: 70 61 67 65 72 2d 63 61 63 68 65 20 6f 62 6a 65  pager-cache obje
1880: 63 74 2e 20 54 68 65 20 50 63 61 63 68 65 4c 6f  ct. The PcacheLo
1890: 63 6b 28 29 20 66 75 6e 63 74 69 6f 6e 20 6d 61  ck() function ma
18a0: 79 20 0a 2a 2a 20 62 6c 6f 63 6b 20 69 66 20 74  y .** block if t
18b0: 68 65 20 6c 6f 63 6b 20 69 73 20 74 65 6d 70 6f  he lock is tempo
18c0: 72 61 72 69 6c 79 20 61 76 61 69 6c 61 62 6c 65  rarily available
18d0: 2e 20 57 68 69 6c 65 20 61 20 70 61 67 65 72 2d  . While a pager-
18e0: 63 61 63 68 65 20 69 73 20 6c 6f 63 6b 65 64 2c  cache is locked,
18f0: 0a 2a 2a 20 74 68 65 20 73 79 73 74 65 6d 20 67  .** the system g
1900: 75 61 72 61 6e 74 65 65 73 20 74 68 61 74 20 61  uarantees that a
1910: 6e 79 20 63 6f 6e 66 69 67 75 72 65 64 20 78 53  ny configured xS
1920: 74 72 65 73 73 28 29 20 63 61 6c 6c 62 61 63 6b  tress() callback
1930: 20 77 69 6c 6c 20 6e 6f 74 0a 2a 2a 20 62 65 20   will not.** be 
1940: 69 6e 76 6f 6b 65 64 20 62 79 20 61 6e 79 20 74  invoked by any t
1950: 68 72 65 61 64 20 6f 74 68 65 72 20 74 68 61 6e  hread other than
1960: 20 74 68 65 20 6f 6e 65 20 68 6f 6c 64 69 6e 67   the one holding
1970: 20 74 68 65 20 6c 6f 63 6b 2e 0a 2a 2f 0a 76 6f   the lock..*/.vo
1980: 69 64 20 73 71 6c 69 74 65 33 50 63 61 63 68 65  id sqlite3Pcache
1990: 4c 6f 63 6b 28 50 43 61 63 68 65 20 2a 29 3b 0a  Lock(PCache *);.
19a0: 76 6f 69 64 20 73 71 6c 69 74 65 33 50 63 61 63  void sqlite3Pcac
19b0: 68 65 55 6e 6c 6f 63 6b 28 50 43 61 63 68 65 20  heUnlock(PCache 
19c0: 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33  *);..int sqlite3
19d0: 50 63 61 63 68 65 52 65 6c 65 61 73 65 4d 65 6d  PcacheReleaseMem
19e0: 6f 72 79 28 69 6e 74 29 3b 0a 0a 23 65 6e 64 69  ory(int);..#endi
19f0: 66 20 2f 2a 20 5f 50 43 41 43 48 45 5f 48 5f 20  f /* _PCACHE_H_ 
1a00: 2a 2f 0a                                         */.