1 /* 2 ** 2008 November 05 3 ** 4 ** The author disclaims copyright to this source code. In place of 5 ** a legal notice, here is a blessing: 6 ** 7 ** May you do good and not evil. 8 ** May you find forgiveness for yourself and forgive others. 9 ** May you share freely, never taking more than you give. 10 ** 11 ************************************************************************* 12 ** 13 ** This file implements the default page cache implementation (the 14 ** sqlite3_pcache interface). It also contains part of the implementation 15 ** of the SQLITE_CONFIG_PAGECACHE and sqlite3_release_memory() features. 16 ** If the default page cache implementation is overridden, then neither of 17 ** these two features are available. 18 ** 19 ** A Page cache line looks like this: 20 ** 21 ** ------------------------------------------------------------- 22 ** | database page content | PgHdr1 | MemPage | PgHdr | 23 ** ------------------------------------------------------------- 24 ** 25 ** The database page content is up front (so that buffer overreads tend to 26 ** flow harmlessly into the PgHdr1, MemPage, and PgHdr extensions). MemPage 27 ** is the extension added by the btree.c module containing information such 28 ** as the database page number and how that database page is used. PgHdr 29 ** is added by the pcache.c layer and contains information used to keep track 30 ** of which pages are "dirty". PgHdr1 is an extension added by this 31 ** module (pcache1.c). The PgHdr1 header is a subclass of sqlite3_pcache_page. 32 ** PgHdr1 contains information needed to look up a page by its page number. 33 ** The superclass sqlite3_pcache_page.pBuf points to the start of the 34 ** database page content and sqlite3_pcache_page.pExtra points to PgHdr. 35 ** 36 ** The size of the extension (MemPage+PgHdr+PgHdr1) can be determined at 37 ** runtime using sqlite3_config(SQLITE_CONFIG_PCACHE_HDRSZ, &size). The 38 ** sizes of the extensions sum to 272 bytes on x64 for 3.8.10, but this 39 ** size can vary according to architecture, compile-time options, and 40 ** SQLite library version number. 41 ** 42 ** If SQLITE_PCACHE_SEPARATE_HEADER is defined, then the extension is obtained 43 ** using a separate memory allocation from the database page content. This 44 ** seeks to overcome the "clownshoe" problem (also called "internal 45 ** fragmentation" in academic literature) of allocating a few bytes more 46 ** than a power of two with the memory allocator rounding up to the next 47 ** power of two, and leaving the rounded-up space unused. 48 ** 49 ** This module tracks pointers to PgHdr1 objects. Only pcache.c communicates 50 ** with this module. Information is passed back and forth as PgHdr1 pointers. 51 ** 52 ** The pcache.c and pager.c modules deal pointers to PgHdr objects. 53 ** The btree.c module deals with pointers to MemPage objects. 54 ** 55 ** SOURCE OF PAGE CACHE MEMORY: 56 ** 57 ** Memory for a page might come from any of three sources: 58 ** 59 ** (1) The general-purpose memory allocator - sqlite3Malloc() 60 ** (2) Global page-cache memory provided using sqlite3_config() with 61 ** SQLITE_CONFIG_PAGECACHE. 62 ** (3) PCache-local bulk allocation. 63 ** 64 ** The third case is a chunk of heap memory (defaulting to 100 pages worth) 65 ** that is allocated when the page cache is created. The size of the local 66 ** bulk allocation can be adjusted using 67 ** 68 ** sqlite3_config(SQLITE_CONFIG_PAGECACHE, (void*)0, 0, N). 69 ** 70 ** If N is positive, then N pages worth of memory are allocated using a single 71 ** sqlite3Malloc() call and that memory is used for the first N pages allocated. 72 ** Or if N is negative, then -1024*N bytes of memory are allocated and used 73 ** for as many pages as can be accomodated. 74 ** 75 ** Only one of (2) or (3) can be used. Once the memory available to (2) or 76 ** (3) is exhausted, subsequent allocations fail over to the general-purpose 77 ** memory allocator (1). 78 ** 79 ** Earlier versions of SQLite used only methods (1) and (2). But experiments 80 ** show that method (3) with N==100 provides about a 5% performance boost for 81 ** common workloads. 82 */ 83 #include "sqliteInt.h" 84 85 typedef struct PCache1 PCache1; 86 typedef struct PgHdr1 PgHdr1; 87 typedef struct PgFreeslot PgFreeslot; 88 typedef struct PGroup PGroup; 89 90 /* 91 ** Each cache entry is represented by an instance of the following 92 ** structure. Unless SQLITE_PCACHE_SEPARATE_HEADER is defined, a buffer of 93 ** PgHdr1.pCache->szPage bytes is allocated directly before this structure 94 ** in memory. 95 ** 96 ** Note: Variables isBulkLocal and isAnchor were once type "u8". That works, 97 ** but causes a 2-byte gap in the structure for most architectures (since 98 ** pointers must be either 4 or 8-byte aligned). As this structure is located 99 ** in memory directly after the associated page data, if the database is 100 ** corrupt, code at the b-tree layer may overread the page buffer and 101 ** read part of this structure before the corruption is detected. This 102 ** can cause a valgrind error if the unitialized gap is accessed. Using u16 103 ** ensures there is no such gap, and therefore no bytes of unitialized memory 104 ** in the structure. 105 */ 106 struct PgHdr1 { 107 sqlite3_pcache_page page; /* Base class. Must be first. pBuf & pExtra */ 108 unsigned int iKey; /* Key value (page number) */ 109 u16 isBulkLocal; /* This page from bulk local storage */ 110 u16 isAnchor; /* This is the PGroup.lru element */ 111 PgHdr1 *pNext; /* Next in hash table chain */ 112 PCache1 *pCache; /* Cache that currently owns this page */ 113 PgHdr1 *pLruNext; /* Next in LRU list of unpinned pages */ 114 PgHdr1 *pLruPrev; /* Previous in LRU list of unpinned pages */ 115 /* NB: pLruPrev is only valid if pLruNext!=0 */ 116 }; 117 118 /* 119 ** A page is pinned if it is not on the LRU list. To be "pinned" means 120 ** that the page is in active use and must not be deallocated. 121 */ 122 #define PAGE_IS_PINNED(p) ((p)->pLruNext==0) 123 #define PAGE_IS_UNPINNED(p) ((p)->pLruNext!=0) 124 125 /* Each page cache (or PCache) belongs to a PGroup. A PGroup is a set 126 ** of one or more PCaches that are able to recycle each other's unpinned 127 ** pages when they are under memory pressure. A PGroup is an instance of 128 ** the following object. 129 ** 130 ** This page cache implementation works in one of two modes: 131 ** 132 ** (1) Every PCache is the sole member of its own PGroup. There is 133 ** one PGroup per PCache. 134 ** 135 ** (2) There is a single global PGroup that all PCaches are a member 136 ** of. 137 ** 138 ** Mode 1 uses more memory (since PCache instances are not able to rob 139 ** unused pages from other PCaches) but it also operates without a mutex, 140 ** and is therefore often faster. Mode 2 requires a mutex in order to be 141 ** threadsafe, but recycles pages more efficiently. 142 ** 143 ** For mode (1), PGroup.mutex is NULL. For mode (2) there is only a single 144 ** PGroup which is the pcache1.grp global variable and its mutex is 145 ** SQLITE_MUTEX_STATIC_LRU. 146 */ 147 struct PGroup { 148 sqlite3_mutex *mutex; /* MUTEX_STATIC_LRU or NULL */ 149 unsigned int nMaxPage; /* Sum of nMax for purgeable caches */ 150 unsigned int nMinPage; /* Sum of nMin for purgeable caches */ 151 unsigned int mxPinned; /* nMaxpage + 10 - nMinPage */ 152 unsigned int nPurgeable; /* Number of purgeable pages allocated */ 153 PgHdr1 lru; /* The beginning and end of the LRU list */ 154 }; 155 156 /* Each page cache is an instance of the following object. Every 157 ** open database file (including each in-memory database and each 158 ** temporary or transient database) has a single page cache which 159 ** is an instance of this object. 160 ** 161 ** Pointers to structures of this type are cast and returned as 162 ** opaque sqlite3_pcache* handles. 163 */ 164 struct PCache1 { 165 /* Cache configuration parameters. Page size (szPage) and the purgeable 166 ** flag (bPurgeable) and the pnPurgeable pointer are all set when the 167 ** cache is created and are never changed thereafter. nMax may be 168 ** modified at any time by a call to the pcache1Cachesize() method. 169 ** The PGroup mutex must be held when accessing nMax. 170 */ 171 PGroup *pGroup; /* PGroup this cache belongs to */ 172 unsigned int *pnPurgeable; /* Pointer to pGroup->nPurgeable */ 173 int szPage; /* Size of database content section */ 174 int szExtra; /* sizeof(MemPage)+sizeof(PgHdr) */ 175 int szAlloc; /* Total size of one pcache line */ 176 int bPurgeable; /* True if cache is purgeable */ 177 unsigned int nMin; /* Minimum number of pages reserved */ 178 unsigned int nMax; /* Configured "cache_size" value */ 179 unsigned int n90pct; /* nMax*9/10 */ 180 unsigned int iMaxKey; /* Largest key seen since xTruncate() */ 181 unsigned int nPurgeableDummy; /* pnPurgeable points here when not used*/ 182 183 /* Hash table of all pages. The following variables may only be accessed 184 ** when the accessor is holding the PGroup mutex. 185 */ 186 unsigned int nRecyclable; /* Number of pages in the LRU list */ 187 unsigned int nPage; /* Total number of pages in apHash */ 188 unsigned int nHash; /* Number of slots in apHash[] */ 189 PgHdr1 **apHash; /* Hash table for fast lookup by key */ 190 PgHdr1 *pFree; /* List of unused pcache-local pages */ 191 void *pBulk; /* Bulk memory used by pcache-local */ 192 }; 193 194 /* 195 ** Free slots in the allocator used to divide up the global page cache 196 ** buffer provided using the SQLITE_CONFIG_PAGECACHE mechanism. 197 */ 198 struct PgFreeslot { 199 PgFreeslot *pNext; /* Next free slot */ 200 }; 201 202 /* 203 ** Global data used by this cache. 204 */ 205 static SQLITE_WSD struct PCacheGlobal { 206 PGroup grp; /* The global PGroup for mode (2) */ 207 208 /* Variables related to SQLITE_CONFIG_PAGECACHE settings. The 209 ** szSlot, nSlot, pStart, pEnd, nReserve, and isInit values are all 210 ** fixed at sqlite3_initialize() time and do not require mutex protection. 211 ** The nFreeSlot and pFree values do require mutex protection. 212 */ 213 int isInit; /* True if initialized */ 214 int separateCache; /* Use a new PGroup for each PCache */ 215 int nInitPage; /* Initial bulk allocation size */ 216 int szSlot; /* Size of each free slot */ 217 int nSlot; /* The number of pcache slots */ 218 int nReserve; /* Try to keep nFreeSlot above this */ 219 void *pStart, *pEnd; /* Bounds of global page cache memory */ 220 /* Above requires no mutex. Use mutex below for variable that follow. */ 221 sqlite3_mutex *mutex; /* Mutex for accessing the following: */ 222 PgFreeslot *pFree; /* Free page blocks */ 223 int nFreeSlot; /* Number of unused pcache slots */ 224 /* The following value requires a mutex to change. We skip the mutex on 225 ** reading because (1) most platforms read a 32-bit integer atomically and 226 ** (2) even if an incorrect value is read, no great harm is done since this 227 ** is really just an optimization. */ 228 int bUnderPressure; /* True if low on PAGECACHE memory */ 229 } pcache1_g; 230 231 /* 232 ** All code in this file should access the global structure above via the 233 ** alias "pcache1". This ensures that the WSD emulation is used when 234 ** compiling for systems that do not support real WSD. 235 */ 236 #define pcache1 (GLOBAL(struct PCacheGlobal, pcache1_g)) 237 238 /* 239 ** Macros to enter and leave the PCache LRU mutex. 240 */ 241 #if !defined(SQLITE_ENABLE_MEMORY_MANAGEMENT) || SQLITE_THREADSAFE==0 242 # define pcache1EnterMutex(X) assert((X)->mutex==0) 243 # define pcache1LeaveMutex(X) assert((X)->mutex==0) 244 # define PCACHE1_MIGHT_USE_GROUP_MUTEX 0 245 #else 246 # define pcache1EnterMutex(X) sqlite3_mutex_enter((X)->mutex) 247 # define pcache1LeaveMutex(X) sqlite3_mutex_leave((X)->mutex) 248 # define PCACHE1_MIGHT_USE_GROUP_MUTEX 1 249 #endif 250 251 /******************************************************************************/ 252 /******** Page Allocation/SQLITE_CONFIG_PCACHE Related Functions **************/ 253 254 255 /* 256 ** This function is called during initialization if a static buffer is 257 ** supplied to use for the page-cache by passing the SQLITE_CONFIG_PAGECACHE 258 ** verb to sqlite3_config(). Parameter pBuf points to an allocation large 259 ** enough to contain 'n' buffers of 'sz' bytes each. 260 ** 261 ** This routine is called from sqlite3_initialize() and so it is guaranteed 262 ** to be serialized already. There is no need for further mutexing. 263 */ 264 void sqlite3PCacheBufferSetup(void *pBuf, int sz, int n){ 265 if( pcache1.isInit ){ 266 PgFreeslot *p; 267 if( pBuf==0 ) sz = n = 0; 268 if( n==0 ) sz = 0; 269 sz = ROUNDDOWN8(sz); 270 pcache1.szSlot = sz; 271 pcache1.nSlot = pcache1.nFreeSlot = n; 272 pcache1.nReserve = n>90 ? 10 : (n/10 + 1); 273 pcache1.pStart = pBuf; 274 pcache1.pFree = 0; 275 pcache1.bUnderPressure = 0; 276 while( n-- ){ 277 p = (PgFreeslot*)pBuf; 278 p->pNext = pcache1.pFree; 279 pcache1.pFree = p; 280 pBuf = (void*)&((char*)pBuf)[sz]; 281 } 282 pcache1.pEnd = pBuf; 283 } 284 } 285 286 /* 287 ** Try to initialize the pCache->pFree and pCache->pBulk fields. Return 288 ** true if pCache->pFree ends up containing one or more free pages. 289 */ 290 static int pcache1InitBulk(PCache1 *pCache){ 291 i64 szBulk; 292 char *zBulk; 293 if( pcache1.nInitPage==0 ) return 0; 294 /* Do not bother with a bulk allocation if the cache size very small */ 295 if( pCache->nMax<3 ) return 0; 296 sqlite3BeginBenignMalloc(); 297 if( pcache1.nInitPage>0 ){ 298 szBulk = pCache->szAlloc * (i64)pcache1.nInitPage; 299 }else{ 300 szBulk = -1024 * (i64)pcache1.nInitPage; 301 } 302 if( szBulk > pCache->szAlloc*(i64)pCache->nMax ){ 303 szBulk = pCache->szAlloc*(i64)pCache->nMax; 304 } 305 zBulk = pCache->pBulk = sqlite3Malloc( szBulk ); 306 sqlite3EndBenignMalloc(); 307 if( zBulk ){ 308 int nBulk = sqlite3MallocSize(zBulk)/pCache->szAlloc; 309 do{ 310 PgHdr1 *pX = (PgHdr1*)&zBulk[pCache->szPage]; 311 pX->page.pBuf = zBulk; 312 pX->page.pExtra = &pX[1]; 313 pX->isBulkLocal = 1; 314 pX->isAnchor = 0; 315 pX->pNext = pCache->pFree; 316 pX->pLruPrev = 0; /* Initializing this saves a valgrind error */ 317 pCache->pFree = pX; 318 zBulk += pCache->szAlloc; 319 }while( --nBulk ); 320 } 321 return pCache->pFree!=0; 322 } 323 324 /* 325 ** Malloc function used within this file to allocate space from the buffer 326 ** configured using sqlite3_config(SQLITE_CONFIG_PAGECACHE) option. If no 327 ** such buffer exists or there is no space left in it, this function falls 328 ** back to sqlite3Malloc(). 329 ** 330 ** Multiple threads can run this routine at the same time. Global variables 331 ** in pcache1 need to be protected via mutex. 332 */ 333 static void *pcache1Alloc(int nByte){ 334 void *p = 0; 335 assert( sqlite3_mutex_notheld(pcache1.grp.mutex) ); 336 if( nByte<=pcache1.szSlot ){ 337 sqlite3_mutex_enter(pcache1.mutex); 338 p = (PgHdr1 *)pcache1.pFree; 339 if( p ){ 340 pcache1.pFree = pcache1.pFree->pNext; 341 pcache1.nFreeSlot--; 342 pcache1.bUnderPressure = pcache1.nFreeSlot<pcache1.nReserve; 343 assert( pcache1.nFreeSlot>=0 ); 344 sqlite3StatusHighwater(SQLITE_STATUS_PAGECACHE_SIZE, nByte); 345 sqlite3StatusUp(SQLITE_STATUS_PAGECACHE_USED, 1); 346 } 347 sqlite3_mutex_leave(pcache1.mutex); 348 } 349 if( p==0 ){ 350 /* Memory is not available in the SQLITE_CONFIG_PAGECACHE pool. Get 351 ** it from sqlite3Malloc instead. 352 */ 353 p = sqlite3Malloc(nByte); 354 #ifndef SQLITE_DISABLE_PAGECACHE_OVERFLOW_STATS 355 if( p ){ 356 int sz = sqlite3MallocSize(p); 357 sqlite3_mutex_enter(pcache1.mutex); 358 sqlite3StatusHighwater(SQLITE_STATUS_PAGECACHE_SIZE, nByte); 359 sqlite3StatusUp(SQLITE_STATUS_PAGECACHE_OVERFLOW, sz); 360 sqlite3_mutex_leave(pcache1.mutex); 361 } 362 #endif 363 sqlite3MemdebugSetType(p, MEMTYPE_PCACHE); 364 } 365 return p; 366 } 367 368 /* 369 ** Free an allocated buffer obtained from pcache1Alloc(). 370 */ 371 static void pcache1Free(void *p){ 372 if( p==0 ) return; 373 if( SQLITE_WITHIN(p, pcache1.pStart, pcache1.pEnd) ){ 374 PgFreeslot *pSlot; 375 sqlite3_mutex_enter(pcache1.mutex); 376 sqlite3StatusDown(SQLITE_STATUS_PAGECACHE_USED, 1); 377 pSlot = (PgFreeslot*)p; 378 pSlot->pNext = pcache1.pFree; 379 pcache1.pFree = pSlot; 380 pcache1.nFreeSlot++; 381 pcache1.bUnderPressure = pcache1.nFreeSlot<pcache1.nReserve; 382 assert( pcache1.nFreeSlot<=pcache1.nSlot ); 383 sqlite3_mutex_leave(pcache1.mutex); 384 }else{ 385 assert( sqlite3MemdebugHasType(p, MEMTYPE_PCACHE) ); 386 sqlite3MemdebugSetType(p, MEMTYPE_HEAP); 387 #ifndef SQLITE_DISABLE_PAGECACHE_OVERFLOW_STATS 388 { 389 int nFreed = 0; 390 nFreed = sqlite3MallocSize(p); 391 sqlite3_mutex_enter(pcache1.mutex); 392 sqlite3StatusDown(SQLITE_STATUS_PAGECACHE_OVERFLOW, nFreed); 393 sqlite3_mutex_leave(pcache1.mutex); 394 } 395 #endif 396 sqlite3_free(p); 397 } 398 } 399 400 #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT 401 /* 402 ** Return the size of a pcache allocation 403 */ 404 static int pcache1MemSize(void *p){ 405 if( p>=pcache1.pStart && p<pcache1.pEnd ){ 406 return pcache1.szSlot; 407 }else{ 408 int iSize; 409 assert( sqlite3MemdebugHasType(p, MEMTYPE_PCACHE) ); 410 sqlite3MemdebugSetType(p, MEMTYPE_HEAP); 411 iSize = sqlite3MallocSize(p); 412 sqlite3MemdebugSetType(p, MEMTYPE_PCACHE); 413 return iSize; 414 } 415 } 416 #endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */ 417 418 /* 419 ** Allocate a new page object initially associated with cache pCache. 420 */ 421 static PgHdr1 *pcache1AllocPage(PCache1 *pCache, int benignMalloc){ 422 PgHdr1 *p = 0; 423 void *pPg; 424 425 assert( sqlite3_mutex_held(pCache->pGroup->mutex) ); 426 if( pCache->pFree || (pCache->nPage==0 && pcache1InitBulk(pCache)) ){ 427 assert( pCache->pFree!=0 ); 428 p = pCache->pFree; 429 pCache->pFree = p->pNext; 430 p->pNext = 0; 431 }else{ 432 #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT 433 /* The group mutex must be released before pcache1Alloc() is called. This 434 ** is because it might call sqlite3_release_memory(), which assumes that 435 ** this mutex is not held. */ 436 assert( pcache1.separateCache==0 ); 437 assert( pCache->pGroup==&pcache1.grp ); 438 pcache1LeaveMutex(pCache->pGroup); 439 #endif 440 if( benignMalloc ){ sqlite3BeginBenignMalloc(); } 441 #ifdef SQLITE_PCACHE_SEPARATE_HEADER 442 pPg = pcache1Alloc(pCache->szPage); 443 p = sqlite3Malloc(sizeof(PgHdr1) + pCache->szExtra); 444 if( !pPg || !p ){ 445 pcache1Free(pPg); 446 sqlite3_free(p); 447 pPg = 0; 448 } 449 #else 450 pPg = pcache1Alloc(pCache->szAlloc); 451 p = (PgHdr1 *)&((u8 *)pPg)[pCache->szPage]; 452 #endif 453 if( benignMalloc ){ sqlite3EndBenignMalloc(); } 454 #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT 455 pcache1EnterMutex(pCache->pGroup); 456 #endif 457 if( pPg==0 ) return 0; 458 p->page.pBuf = pPg; 459 p->page.pExtra = &p[1]; 460 p->isBulkLocal = 0; 461 p->isAnchor = 0; 462 } 463 (*pCache->pnPurgeable)++; 464 return p; 465 } 466 467 /* 468 ** Free a page object allocated by pcache1AllocPage(). 469 */ 470 static void pcache1FreePage(PgHdr1 *p){ 471 PCache1 *pCache; 472 assert( p!=0 ); 473 pCache = p->pCache; 474 assert( sqlite3_mutex_held(p->pCache->pGroup->mutex) ); 475 if( p->isBulkLocal ){ 476 p->pNext = pCache->pFree; 477 pCache->pFree = p; 478 }else{ 479 pcache1Free(p->page.pBuf); 480 #ifdef SQLITE_PCACHE_SEPARATE_HEADER 481 sqlite3_free(p); 482 #endif 483 } 484 (*pCache->pnPurgeable)--; 485 } 486 487 /* 488 ** Malloc function used by SQLite to obtain space from the buffer configured 489 ** using sqlite3_config(SQLITE_CONFIG_PAGECACHE) option. If no such buffer 490 ** exists, this function falls back to sqlite3Malloc(). 491 */ 492 void *sqlite3PageMalloc(int sz){ 493 assert( sz<=65536+8 ); /* These allocations are never very large */ 494 return pcache1Alloc(sz); 495 } 496 497 /* 498 ** Free an allocated buffer obtained from sqlite3PageMalloc(). 499 */ 500 void sqlite3PageFree(void *p){ 501 pcache1Free(p); 502 } 503 504 505 /* 506 ** Return true if it desirable to avoid allocating a new page cache 507 ** entry. 508 ** 509 ** If memory was allocated specifically to the page cache using 510 ** SQLITE_CONFIG_PAGECACHE but that memory has all been used, then 511 ** it is desirable to avoid allocating a new page cache entry because 512 ** presumably SQLITE_CONFIG_PAGECACHE was suppose to be sufficient 513 ** for all page cache needs and we should not need to spill the 514 ** allocation onto the heap. 515 ** 516 ** Or, the heap is used for all page cache memory but the heap is 517 ** under memory pressure, then again it is desirable to avoid 518 ** allocating a new page cache entry in order to avoid stressing 519 ** the heap even further. 520 */ 521 static int pcache1UnderMemoryPressure(PCache1 *pCache){ 522 if( pcache1.nSlot && (pCache->szPage+pCache->szExtra)<=pcache1.szSlot ){ 523 return pcache1.bUnderPressure; 524 }else{ 525 return sqlite3HeapNearlyFull(); 526 } 527 } 528 529 /******************************************************************************/ 530 /******** General Implementation Functions ************************************/ 531 532 /* 533 ** This function is used to resize the hash table used by the cache passed 534 ** as the first argument. 535 ** 536 ** The PCache mutex must be held when this function is called. 537 */ 538 static void pcache1ResizeHash(PCache1 *p){ 539 PgHdr1 **apNew; 540 unsigned int nNew; 541 unsigned int i; 542 543 assert( sqlite3_mutex_held(p->pGroup->mutex) ); 544 545 nNew = p->nHash*2; 546 if( nNew<256 ){ 547 nNew = 256; 548 } 549 550 pcache1LeaveMutex(p->pGroup); 551 if( p->nHash ){ sqlite3BeginBenignMalloc(); } 552 apNew = (PgHdr1 **)sqlite3MallocZero(sizeof(PgHdr1 *)*nNew); 553 if( p->nHash ){ sqlite3EndBenignMalloc(); } 554 pcache1EnterMutex(p->pGroup); 555 if( apNew ){ 556 for(i=0; i<p->nHash; i++){ 557 PgHdr1 *pPage; 558 PgHdr1 *pNext = p->apHash[i]; 559 while( (pPage = pNext)!=0 ){ 560 unsigned int h = pPage->iKey % nNew; 561 pNext = pPage->pNext; 562 pPage->pNext = apNew[h]; 563 apNew[h] = pPage; 564 } 565 } 566 sqlite3_free(p->apHash); 567 p->apHash = apNew; 568 p->nHash = nNew; 569 } 570 } 571 572 /* 573 ** This function is used internally to remove the page pPage from the 574 ** PGroup LRU list, if is part of it. If pPage is not part of the PGroup 575 ** LRU list, then this function is a no-op. 576 ** 577 ** The PGroup mutex must be held when this function is called. 578 */ 579 static PgHdr1 *pcache1PinPage(PgHdr1 *pPage){ 580 assert( pPage!=0 ); 581 assert( PAGE_IS_UNPINNED(pPage) ); 582 assert( pPage->pLruNext ); 583 assert( pPage->pLruPrev ); 584 assert( sqlite3_mutex_held(pPage->pCache->pGroup->mutex) ); 585 pPage->pLruPrev->pLruNext = pPage->pLruNext; 586 pPage->pLruNext->pLruPrev = pPage->pLruPrev; 587 pPage->pLruNext = 0; 588 /* pPage->pLruPrev = 0; 589 ** No need to clear pLruPrev as it is never accessed if pLruNext is 0 */ 590 assert( pPage->isAnchor==0 ); 591 assert( pPage->pCache->pGroup->lru.isAnchor==1 ); 592 pPage->pCache->nRecyclable--; 593 return pPage; 594 } 595 596 597 /* 598 ** Remove the page supplied as an argument from the hash table 599 ** (PCache1.apHash structure) that it is currently stored in. 600 ** Also free the page if freePage is true. 601 ** 602 ** The PGroup mutex must be held when this function is called. 603 */ 604 static void pcache1RemoveFromHash(PgHdr1 *pPage, int freeFlag){ 605 unsigned int h; 606 PCache1 *pCache = pPage->pCache; 607 PgHdr1 **pp; 608 609 assert( sqlite3_mutex_held(pCache->pGroup->mutex) ); 610 h = pPage->iKey % pCache->nHash; 611 for(pp=&pCache->apHash[h]; (*pp)!=pPage; pp=&(*pp)->pNext); 612 *pp = (*pp)->pNext; 613 614 pCache->nPage--; 615 if( freeFlag ) pcache1FreePage(pPage); 616 } 617 618 /* 619 ** If there are currently more than nMaxPage pages allocated, try 620 ** to recycle pages to reduce the number allocated to nMaxPage. 621 */ 622 static void pcache1EnforceMaxPage(PCache1 *pCache){ 623 PGroup *pGroup = pCache->pGroup; 624 PgHdr1 *p; 625 assert( sqlite3_mutex_held(pGroup->mutex) ); 626 while( pGroup->nPurgeable>pGroup->nMaxPage 627 && (p=pGroup->lru.pLruPrev)->isAnchor==0 628 ){ 629 assert( p->pCache->pGroup==pGroup ); 630 assert( PAGE_IS_UNPINNED(p) ); 631 pcache1PinPage(p); 632 pcache1RemoveFromHash(p, 1); 633 } 634 if( pCache->nPage==0 && pCache->pBulk ){ 635 sqlite3_free(pCache->pBulk); 636 pCache->pBulk = pCache->pFree = 0; 637 } 638 } 639 640 /* 641 ** Discard all pages from cache pCache with a page number (key value) 642 ** greater than or equal to iLimit. Any pinned pages that meet this 643 ** criteria are unpinned before they are discarded. 644 ** 645 ** The PCache mutex must be held when this function is called. 646 */ 647 static void pcache1TruncateUnsafe( 648 PCache1 *pCache, /* The cache to truncate */ 649 unsigned int iLimit /* Drop pages with this pgno or larger */ 650 ){ 651 TESTONLY( int nPage = 0; ) /* To assert pCache->nPage is correct */ 652 unsigned int h, iStop; 653 assert( sqlite3_mutex_held(pCache->pGroup->mutex) ); 654 assert( pCache->iMaxKey >= iLimit ); 655 assert( pCache->nHash > 0 ); 656 if( pCache->iMaxKey - iLimit < pCache->nHash ){ 657 /* If we are just shaving the last few pages off the end of the 658 ** cache, then there is no point in scanning the entire hash table. 659 ** Only scan those hash slots that might contain pages that need to 660 ** be removed. */ 661 h = iLimit % pCache->nHash; 662 iStop = pCache->iMaxKey % pCache->nHash; 663 TESTONLY( nPage = -10; ) /* Disable the pCache->nPage validity check */ 664 }else{ 665 /* This is the general case where many pages are being removed. 666 ** It is necessary to scan the entire hash table */ 667 h = pCache->nHash/2; 668 iStop = h - 1; 669 } 670 for(;;){ 671 PgHdr1 **pp; 672 PgHdr1 *pPage; 673 assert( h<pCache->nHash ); 674 pp = &pCache->apHash[h]; 675 while( (pPage = *pp)!=0 ){ 676 if( pPage->iKey>=iLimit ){ 677 pCache->nPage--; 678 *pp = pPage->pNext; 679 if( PAGE_IS_UNPINNED(pPage) ) pcache1PinPage(pPage); 680 pcache1FreePage(pPage); 681 }else{ 682 pp = &pPage->pNext; 683 TESTONLY( if( nPage>=0 ) nPage++; ) 684 } 685 } 686 if( h==iStop ) break; 687 h = (h+1) % pCache->nHash; 688 } 689 assert( nPage<0 || pCache->nPage==(unsigned)nPage ); 690 } 691 692 /******************************************************************************/ 693 /******** sqlite3_pcache Methods **********************************************/ 694 695 /* 696 ** Implementation of the sqlite3_pcache.xInit method. 697 */ 698 static int pcache1Init(void *NotUsed){ 699 UNUSED_PARAMETER(NotUsed); 700 assert( pcache1.isInit==0 ); 701 memset(&pcache1, 0, sizeof(pcache1)); 702 703 704 /* 705 ** The pcache1.separateCache variable is true if each PCache has its own 706 ** private PGroup (mode-1). pcache1.separateCache is false if the single 707 ** PGroup in pcache1.grp is used for all page caches (mode-2). 708 ** 709 ** * Always use a unified cache (mode-2) if ENABLE_MEMORY_MANAGEMENT 710 ** 711 ** * Use a unified cache in single-threaded applications that have 712 ** configured a start-time buffer for use as page-cache memory using 713 ** sqlite3_config(SQLITE_CONFIG_PAGECACHE, pBuf, sz, N) with non-NULL 714 ** pBuf argument. 715 ** 716 ** * Otherwise use separate caches (mode-1) 717 */ 718 #if defined(SQLITE_ENABLE_MEMORY_MANAGEMENT) 719 pcache1.separateCache = 0; 720 #elif SQLITE_THREADSAFE 721 pcache1.separateCache = sqlite3GlobalConfig.pPage==0 722 || sqlite3GlobalConfig.bCoreMutex>0; 723 #else 724 pcache1.separateCache = sqlite3GlobalConfig.pPage==0; 725 #endif 726 727 #if SQLITE_THREADSAFE 728 if( sqlite3GlobalConfig.bCoreMutex ){ 729 pcache1.grp.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_LRU); 730 pcache1.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_PMEM); 731 } 732 #endif 733 if( pcache1.separateCache 734 && sqlite3GlobalConfig.nPage!=0 735 && sqlite3GlobalConfig.pPage==0 736 ){ 737 pcache1.nInitPage = sqlite3GlobalConfig.nPage; 738 }else{ 739 pcache1.nInitPage = 0; 740 } 741 pcache1.grp.mxPinned = 10; 742 pcache1.isInit = 1; 743 return SQLITE_OK; 744 } 745 746 /* 747 ** Implementation of the sqlite3_pcache.xShutdown method. 748 ** Note that the static mutex allocated in xInit does 749 ** not need to be freed. 750 */ 751 static void pcache1Shutdown(void *NotUsed){ 752 UNUSED_PARAMETER(NotUsed); 753 assert( pcache1.isInit!=0 ); 754 memset(&pcache1, 0, sizeof(pcache1)); 755 } 756 757 /* forward declaration */ 758 static void pcache1Destroy(sqlite3_pcache *p); 759 760 /* 761 ** Implementation of the sqlite3_pcache.xCreate method. 762 ** 763 ** Allocate a new cache. 764 */ 765 static sqlite3_pcache *pcache1Create(int szPage, int szExtra, int bPurgeable){ 766 PCache1 *pCache; /* The newly created page cache */ 767 PGroup *pGroup; /* The group the new page cache will belong to */ 768 int sz; /* Bytes of memory required to allocate the new cache */ 769 770 assert( (szPage & (szPage-1))==0 && szPage>=512 && szPage<=65536 ); 771 assert( szExtra < 300 ); 772 773 sz = sizeof(PCache1) + sizeof(PGroup)*pcache1.separateCache; 774 pCache = (PCache1 *)sqlite3MallocZero(sz); 775 if( pCache ){ 776 if( pcache1.separateCache ){ 777 pGroup = (PGroup*)&pCache[1]; 778 pGroup->mxPinned = 10; 779 }else{ 780 pGroup = &pcache1.grp; 781 } 782 pcache1EnterMutex(pGroup); 783 if( pGroup->lru.isAnchor==0 ){ 784 pGroup->lru.isAnchor = 1; 785 pGroup->lru.pLruPrev = pGroup->lru.pLruNext = &pGroup->lru; 786 } 787 pCache->pGroup = pGroup; 788 pCache->szPage = szPage; 789 pCache->szExtra = szExtra; 790 pCache->szAlloc = szPage + szExtra + ROUND8(sizeof(PgHdr1)); 791 pCache->bPurgeable = (bPurgeable ? 1 : 0); 792 pcache1ResizeHash(pCache); 793 if( bPurgeable ){ 794 pCache->nMin = 10; 795 pGroup->nMinPage += pCache->nMin; 796 pGroup->mxPinned = pGroup->nMaxPage + 10 - pGroup->nMinPage; 797 pCache->pnPurgeable = &pGroup->nPurgeable; 798 }else{ 799 pCache->pnPurgeable = &pCache->nPurgeableDummy; 800 } 801 pcache1LeaveMutex(pGroup); 802 if( pCache->nHash==0 ){ 803 pcache1Destroy((sqlite3_pcache*)pCache); 804 pCache = 0; 805 } 806 } 807 return (sqlite3_pcache *)pCache; 808 } 809 810 /* 811 ** Implementation of the sqlite3_pcache.xCachesize method. 812 ** 813 ** Configure the cache_size limit for a cache. 814 */ 815 static void pcache1Cachesize(sqlite3_pcache *p, int nMax){ 816 PCache1 *pCache = (PCache1 *)p; 817 if( pCache->bPurgeable ){ 818 PGroup *pGroup = pCache->pGroup; 819 pcache1EnterMutex(pGroup); 820 pGroup->nMaxPage += (nMax - pCache->nMax); 821 pGroup->mxPinned = pGroup->nMaxPage + 10 - pGroup->nMinPage; 822 pCache->nMax = nMax; 823 pCache->n90pct = pCache->nMax*9/10; 824 pcache1EnforceMaxPage(pCache); 825 pcache1LeaveMutex(pGroup); 826 } 827 } 828 829 /* 830 ** Implementation of the sqlite3_pcache.xShrink method. 831 ** 832 ** Free up as much memory as possible. 833 */ 834 static void pcache1Shrink(sqlite3_pcache *p){ 835 PCache1 *pCache = (PCache1*)p; 836 if( pCache->bPurgeable ){ 837 PGroup *pGroup = pCache->pGroup; 838 int savedMaxPage; 839 pcache1EnterMutex(pGroup); 840 savedMaxPage = pGroup->nMaxPage; 841 pGroup->nMaxPage = 0; 842 pcache1EnforceMaxPage(pCache); 843 pGroup->nMaxPage = savedMaxPage; 844 pcache1LeaveMutex(pGroup); 845 } 846 } 847 848 /* 849 ** Implementation of the sqlite3_pcache.xPagecount method. 850 */ 851 static int pcache1Pagecount(sqlite3_pcache *p){ 852 int n; 853 PCache1 *pCache = (PCache1*)p; 854 pcache1EnterMutex(pCache->pGroup); 855 n = pCache->nPage; 856 pcache1LeaveMutex(pCache->pGroup); 857 return n; 858 } 859 860 861 /* 862 ** Implement steps 3, 4, and 5 of the pcache1Fetch() algorithm described 863 ** in the header of the pcache1Fetch() procedure. 864 ** 865 ** This steps are broken out into a separate procedure because they are 866 ** usually not needed, and by avoiding the stack initialization required 867 ** for these steps, the main pcache1Fetch() procedure can run faster. 868 */ 869 static SQLITE_NOINLINE PgHdr1 *pcache1FetchStage2( 870 PCache1 *pCache, 871 unsigned int iKey, 872 int createFlag 873 ){ 874 unsigned int nPinned; 875 PGroup *pGroup = pCache->pGroup; 876 PgHdr1 *pPage = 0; 877 878 /* Step 3: Abort if createFlag is 1 but the cache is nearly full */ 879 assert( pCache->nPage >= pCache->nRecyclable ); 880 nPinned = pCache->nPage - pCache->nRecyclable; 881 assert( pGroup->mxPinned == pGroup->nMaxPage + 10 - pGroup->nMinPage ); 882 assert( pCache->n90pct == pCache->nMax*9/10 ); 883 if( createFlag==1 && ( 884 nPinned>=pGroup->mxPinned 885 || nPinned>=pCache->n90pct 886 || (pcache1UnderMemoryPressure(pCache) && pCache->nRecyclable<nPinned) 887 )){ 888 return 0; 889 } 890 891 if( pCache->nPage>=pCache->nHash ) pcache1ResizeHash(pCache); 892 assert( pCache->nHash>0 && pCache->apHash ); 893 894 /* Step 4. Try to recycle a page. */ 895 if( pCache->bPurgeable 896 && !pGroup->lru.pLruPrev->isAnchor 897 && ((pCache->nPage+1>=pCache->nMax) || pcache1UnderMemoryPressure(pCache)) 898 ){ 899 PCache1 *pOther; 900 pPage = pGroup->lru.pLruPrev; 901 assert( PAGE_IS_UNPINNED(pPage) ); 902 pcache1RemoveFromHash(pPage, 0); 903 pcache1PinPage(pPage); 904 pOther = pPage->pCache; 905 if( pOther->szAlloc != pCache->szAlloc ){ 906 pcache1FreePage(pPage); 907 pPage = 0; 908 }else{ 909 pGroup->nPurgeable -= (pOther->bPurgeable - pCache->bPurgeable); 910 } 911 } 912 913 /* Step 5. If a usable page buffer has still not been found, 914 ** attempt to allocate a new one. 915 */ 916 if( !pPage ){ 917 pPage = pcache1AllocPage(pCache, createFlag==1); 918 } 919 920 if( pPage ){ 921 unsigned int h = iKey % pCache->nHash; 922 pCache->nPage++; 923 pPage->iKey = iKey; 924 pPage->pNext = pCache->apHash[h]; 925 pPage->pCache = pCache; 926 pPage->pLruNext = 0; 927 /* pPage->pLruPrev = 0; 928 ** No need to clear pLruPrev since it is not accessed when pLruNext==0 */ 929 *(void **)pPage->page.pExtra = 0; 930 pCache->apHash[h] = pPage; 931 if( iKey>pCache->iMaxKey ){ 932 pCache->iMaxKey = iKey; 933 } 934 } 935 return pPage; 936 } 937 938 /* 939 ** Implementation of the sqlite3_pcache.xFetch method. 940 ** 941 ** Fetch a page by key value. 942 ** 943 ** Whether or not a new page may be allocated by this function depends on 944 ** the value of the createFlag argument. 0 means do not allocate a new 945 ** page. 1 means allocate a new page if space is easily available. 2 946 ** means to try really hard to allocate a new page. 947 ** 948 ** For a non-purgeable cache (a cache used as the storage for an in-memory 949 ** database) there is really no difference between createFlag 1 and 2. So 950 ** the calling function (pcache.c) will never have a createFlag of 1 on 951 ** a non-purgeable cache. 952 ** 953 ** There are three different approaches to obtaining space for a page, 954 ** depending on the value of parameter createFlag (which may be 0, 1 or 2). 955 ** 956 ** 1. Regardless of the value of createFlag, the cache is searched for a 957 ** copy of the requested page. If one is found, it is returned. 958 ** 959 ** 2. If createFlag==0 and the page is not already in the cache, NULL is 960 ** returned. 961 ** 962 ** 3. If createFlag is 1, and the page is not already in the cache, then 963 ** return NULL (do not allocate a new page) if any of the following 964 ** conditions are true: 965 ** 966 ** (a) the number of pages pinned by the cache is greater than 967 ** PCache1.nMax, or 968 ** 969 ** (b) the number of pages pinned by the cache is greater than 970 ** the sum of nMax for all purgeable caches, less the sum of 971 ** nMin for all other purgeable caches, or 972 ** 973 ** 4. If none of the first three conditions apply and the cache is marked 974 ** as purgeable, and if one of the following is true: 975 ** 976 ** (a) The number of pages allocated for the cache is already 977 ** PCache1.nMax, or 978 ** 979 ** (b) The number of pages allocated for all purgeable caches is 980 ** already equal to or greater than the sum of nMax for all 981 ** purgeable caches, 982 ** 983 ** (c) The system is under memory pressure and wants to avoid 984 ** unnecessary pages cache entry allocations 985 ** 986 ** then attempt to recycle a page from the LRU list. If it is the right 987 ** size, return the recycled buffer. Otherwise, free the buffer and 988 ** proceed to step 5. 989 ** 990 ** 5. Otherwise, allocate and return a new page buffer. 991 ** 992 ** There are two versions of this routine. pcache1FetchWithMutex() is 993 ** the general case. pcache1FetchNoMutex() is a faster implementation for 994 ** the common case where pGroup->mutex is NULL. The pcache1Fetch() wrapper 995 ** invokes the appropriate routine. 996 */ 997 static PgHdr1 *pcache1FetchNoMutex( 998 sqlite3_pcache *p, 999 unsigned int iKey, 1000 int createFlag 1001 ){ 1002 PCache1 *pCache = (PCache1 *)p; 1003 PgHdr1 *pPage = 0; 1004 1005 /* Step 1: Search the hash table for an existing entry. */ 1006 pPage = pCache->apHash[iKey % pCache->nHash]; 1007 while( pPage && pPage->iKey!=iKey ){ pPage = pPage->pNext; } 1008 1009 /* Step 2: If the page was found in the hash table, then return it. 1010 ** If the page was not in the hash table and createFlag is 0, abort. 1011 ** Otherwise (page not in hash and createFlag!=0) continue with 1012 ** subsequent steps to try to create the page. */ 1013 if( pPage ){ 1014 if( PAGE_IS_UNPINNED(pPage) ){ 1015 return pcache1PinPage(pPage); 1016 }else{ 1017 return pPage; 1018 } 1019 }else if( createFlag ){ 1020 /* Steps 3, 4, and 5 implemented by this subroutine */ 1021 return pcache1FetchStage2(pCache, iKey, createFlag); 1022 }else{ 1023 return 0; 1024 } 1025 } 1026 #if PCACHE1_MIGHT_USE_GROUP_MUTEX 1027 static PgHdr1 *pcache1FetchWithMutex( 1028 sqlite3_pcache *p, 1029 unsigned int iKey, 1030 int createFlag 1031 ){ 1032 PCache1 *pCache = (PCache1 *)p; 1033 PgHdr1 *pPage; 1034 1035 pcache1EnterMutex(pCache->pGroup); 1036 pPage = pcache1FetchNoMutex(p, iKey, createFlag); 1037 assert( pPage==0 || pCache->iMaxKey>=iKey ); 1038 pcache1LeaveMutex(pCache->pGroup); 1039 return pPage; 1040 } 1041 #endif 1042 static sqlite3_pcache_page *pcache1Fetch( 1043 sqlite3_pcache *p, 1044 unsigned int iKey, 1045 int createFlag 1046 ){ 1047 #if PCACHE1_MIGHT_USE_GROUP_MUTEX || defined(SQLITE_DEBUG) 1048 PCache1 *pCache = (PCache1 *)p; 1049 #endif 1050 1051 assert( offsetof(PgHdr1,page)==0 ); 1052 assert( pCache->bPurgeable || createFlag!=1 ); 1053 assert( pCache->bPurgeable || pCache->nMin==0 ); 1054 assert( pCache->bPurgeable==0 || pCache->nMin==10 ); 1055 assert( pCache->nMin==0 || pCache->bPurgeable ); 1056 assert( pCache->nHash>0 ); 1057 #if PCACHE1_MIGHT_USE_GROUP_MUTEX 1058 if( pCache->pGroup->mutex ){ 1059 return (sqlite3_pcache_page*)pcache1FetchWithMutex(p, iKey, createFlag); 1060 }else 1061 #endif 1062 { 1063 return (sqlite3_pcache_page*)pcache1FetchNoMutex(p, iKey, createFlag); 1064 } 1065 } 1066 1067 1068 /* 1069 ** Implementation of the sqlite3_pcache.xUnpin method. 1070 ** 1071 ** Mark a page as unpinned (eligible for asynchronous recycling). 1072 */ 1073 static void pcache1Unpin( 1074 sqlite3_pcache *p, 1075 sqlite3_pcache_page *pPg, 1076 int reuseUnlikely 1077 ){ 1078 PCache1 *pCache = (PCache1 *)p; 1079 PgHdr1 *pPage = (PgHdr1 *)pPg; 1080 PGroup *pGroup = pCache->pGroup; 1081 1082 assert( pPage->pCache==pCache ); 1083 pcache1EnterMutex(pGroup); 1084 1085 /* It is an error to call this function if the page is already 1086 ** part of the PGroup LRU list. 1087 */ 1088 assert( pPage->pLruNext==0 ); 1089 assert( PAGE_IS_PINNED(pPage) ); 1090 1091 if( reuseUnlikely || pGroup->nPurgeable>pGroup->nMaxPage ){ 1092 pcache1RemoveFromHash(pPage, 1); 1093 }else{ 1094 /* Add the page to the PGroup LRU list. */ 1095 PgHdr1 **ppFirst = &pGroup->lru.pLruNext; 1096 pPage->pLruPrev = &pGroup->lru; 1097 (pPage->pLruNext = *ppFirst)->pLruPrev = pPage; 1098 *ppFirst = pPage; 1099 pCache->nRecyclable++; 1100 } 1101 1102 pcache1LeaveMutex(pCache->pGroup); 1103 } 1104 1105 /* 1106 ** Implementation of the sqlite3_pcache.xRekey method. 1107 */ 1108 static void pcache1Rekey( 1109 sqlite3_pcache *p, 1110 sqlite3_pcache_page *pPg, 1111 unsigned int iOld, 1112 unsigned int iNew 1113 ){ 1114 PCache1 *pCache = (PCache1 *)p; 1115 PgHdr1 *pPage = (PgHdr1 *)pPg; 1116 PgHdr1 **pp; 1117 unsigned int h; 1118 assert( pPage->iKey==iOld ); 1119 assert( pPage->pCache==pCache ); 1120 1121 pcache1EnterMutex(pCache->pGroup); 1122 1123 h = iOld%pCache->nHash; 1124 pp = &pCache->apHash[h]; 1125 while( (*pp)!=pPage ){ 1126 pp = &(*pp)->pNext; 1127 } 1128 *pp = pPage->pNext; 1129 1130 h = iNew%pCache->nHash; 1131 pPage->iKey = iNew; 1132 pPage->pNext = pCache->apHash[h]; 1133 pCache->apHash[h] = pPage; 1134 if( iNew>pCache->iMaxKey ){ 1135 pCache->iMaxKey = iNew; 1136 } 1137 1138 pcache1LeaveMutex(pCache->pGroup); 1139 } 1140 1141 /* 1142 ** Implementation of the sqlite3_pcache.xTruncate method. 1143 ** 1144 ** Discard all unpinned pages in the cache with a page number equal to 1145 ** or greater than parameter iLimit. Any pinned pages with a page number 1146 ** equal to or greater than iLimit are implicitly unpinned. 1147 */ 1148 static void pcache1Truncate(sqlite3_pcache *p, unsigned int iLimit){ 1149 PCache1 *pCache = (PCache1 *)p; 1150 pcache1EnterMutex(pCache->pGroup); 1151 if( iLimit<=pCache->iMaxKey ){ 1152 pcache1TruncateUnsafe(pCache, iLimit); 1153 pCache->iMaxKey = iLimit-1; 1154 } 1155 pcache1LeaveMutex(pCache->pGroup); 1156 } 1157 1158 /* 1159 ** Implementation of the sqlite3_pcache.xDestroy method. 1160 ** 1161 ** Destroy a cache allocated using pcache1Create(). 1162 */ 1163 static void pcache1Destroy(sqlite3_pcache *p){ 1164 PCache1 *pCache = (PCache1 *)p; 1165 PGroup *pGroup = pCache->pGroup; 1166 assert( pCache->bPurgeable || (pCache->nMax==0 && pCache->nMin==0) ); 1167 pcache1EnterMutex(pGroup); 1168 if( pCache->nPage ) pcache1TruncateUnsafe(pCache, 0); 1169 assert( pGroup->nMaxPage >= pCache->nMax ); 1170 pGroup->nMaxPage -= pCache->nMax; 1171 assert( pGroup->nMinPage >= pCache->nMin ); 1172 pGroup->nMinPage -= pCache->nMin; 1173 pGroup->mxPinned = pGroup->nMaxPage + 10 - pGroup->nMinPage; 1174 pcache1EnforceMaxPage(pCache); 1175 pcache1LeaveMutex(pGroup); 1176 sqlite3_free(pCache->pBulk); 1177 sqlite3_free(pCache->apHash); 1178 sqlite3_free(pCache); 1179 } 1180 1181 /* 1182 ** This function is called during initialization (sqlite3_initialize()) to 1183 ** install the default pluggable cache module, assuming the user has not 1184 ** already provided an alternative. 1185 */ 1186 void sqlite3PCacheSetDefault(void){ 1187 static const sqlite3_pcache_methods2 defaultMethods = { 1188 1, /* iVersion */ 1189 0, /* pArg */ 1190 pcache1Init, /* xInit */ 1191 pcache1Shutdown, /* xShutdown */ 1192 pcache1Create, /* xCreate */ 1193 pcache1Cachesize, /* xCachesize */ 1194 pcache1Pagecount, /* xPagecount */ 1195 pcache1Fetch, /* xFetch */ 1196 pcache1Unpin, /* xUnpin */ 1197 pcache1Rekey, /* xRekey */ 1198 pcache1Truncate, /* xTruncate */ 1199 pcache1Destroy, /* xDestroy */ 1200 pcache1Shrink /* xShrink */ 1201 }; 1202 sqlite3_config(SQLITE_CONFIG_PCACHE2, &defaultMethods); 1203 } 1204 1205 /* 1206 ** Return the size of the header on each page of this PCACHE implementation. 1207 */ 1208 int sqlite3HeaderSizePcache1(void){ return ROUND8(sizeof(PgHdr1)); } 1209 1210 /* 1211 ** Return the global mutex used by this PCACHE implementation. The 1212 ** sqlite3_status() routine needs access to this mutex. 1213 */ 1214 sqlite3_mutex *sqlite3Pcache1Mutex(void){ 1215 return pcache1.mutex; 1216 } 1217 1218 #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT 1219 /* 1220 ** This function is called to free superfluous dynamically allocated memory 1221 ** held by the pager system. Memory in use by any SQLite pager allocated 1222 ** by the current thread may be sqlite3_free()ed. 1223 ** 1224 ** nReq is the number of bytes of memory required. Once this much has 1225 ** been released, the function returns. The return value is the total number 1226 ** of bytes of memory released. 1227 */ 1228 int sqlite3PcacheReleaseMemory(int nReq){ 1229 int nFree = 0; 1230 assert( sqlite3_mutex_notheld(pcache1.grp.mutex) ); 1231 assert( sqlite3_mutex_notheld(pcache1.mutex) ); 1232 if( sqlite3GlobalConfig.pPage==0 ){ 1233 PgHdr1 *p; 1234 pcache1EnterMutex(&pcache1.grp); 1235 while( (nReq<0 || nFree<nReq) 1236 && (p=pcache1.grp.lru.pLruPrev)!=0 1237 && p->isAnchor==0 1238 ){ 1239 nFree += pcache1MemSize(p->page.pBuf); 1240 #ifdef SQLITE_PCACHE_SEPARATE_HEADER 1241 nFree += sqlite3MemSize(p); 1242 #endif 1243 assert( PAGE_IS_UNPINNED(p) ); 1244 pcache1PinPage(p); 1245 pcache1RemoveFromHash(p, 1); 1246 } 1247 pcache1LeaveMutex(&pcache1.grp); 1248 } 1249 return nFree; 1250 } 1251 #endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */ 1252 1253 #ifdef SQLITE_TEST 1254 /* 1255 ** This function is used by test procedures to inspect the internal state 1256 ** of the global cache. 1257 */ 1258 void sqlite3PcacheStats( 1259 int *pnCurrent, /* OUT: Total number of pages cached */ 1260 int *pnMax, /* OUT: Global maximum cache size */ 1261 int *pnMin, /* OUT: Sum of PCache1.nMin for purgeable caches */ 1262 int *pnRecyclable /* OUT: Total number of pages available for recycling */ 1263 ){ 1264 PgHdr1 *p; 1265 int nRecyclable = 0; 1266 for(p=pcache1.grp.lru.pLruNext; p && !p->isAnchor; p=p->pLruNext){ 1267 assert( PAGE_IS_UNPINNED(p) ); 1268 nRecyclable++; 1269 } 1270 *pnCurrent = pcache1.grp.nPurgeable; 1271 *pnMax = (int)pcache1.grp.nMaxPage; 1272 *pnMin = (int)pcache1.grp.nMinPage; 1273 *pnRecyclable = nRecyclable; 1274 } 1275 #endif 1276