]> git.ipfire.org Git - thirdparty/sqlite.git/commitdiff
Add an optional codec to the pager layer. (CVS 1214)
authordrh <drh@noemail.net>
Mon, 9 Feb 2004 01:20:36 +0000 (01:20 +0000)
committerdrh <drh@noemail.net>
Mon, 9 Feb 2004 01:20:36 +0000 (01:20 +0000)
FossilOrigin-Name: 2f0c122cfb84dea58d112324a0bdd8b85552a9fa

manifest
manifest.uuid
src/pager.c
src/pager.h

index 2f9dbc89c8b9b1c462b4ac2ab2cf1d6a0121c611..93abd3fa04bdc17c260833d69a979c47d83999d9 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Version\s2.8.12\s(CVS\s1213)
-D 2004-02-08T18:10:50
+C Add\san\soptional\scodec\sto\sthe\spager\slayer.\s(CVS\s1214)
+D 2004-02-09T01:20:37
 F Makefile.in cfd75c46b335881999333a9e4b982fa8491f200b
 F Makefile.linux-gcc b86a99c493a5bfb402d1d9178dcdc4bd4b32f906
 F README f1de682fbbd94899d50aca13d387d1b3fd3be2dd
@@ -40,8 +40,8 @@ F src/main.c 808ea1bda0798f4a714479aee8289d65f04cf29b
 F src/md5.c fe4f9c9c6f71dfc26af8da63e4d04489b1430565
 F src/os.c 681ec36217bc7c795d55d9a63ff79a8614ddee8c
 F src/os.h 8d02b622153d2df442da1ec37cdd6b1bd9804a25
-F src/pager.c 7258db4fb61fa2df7a1c961f16d23a6fc0055833
-F src/pager.h 5da62c83443f26b1792cfd72c96c422f91aadd31
+F src/pager.c 71d17c231d1bec68190be088a9652d31294ec30f
+F src/pager.h 767867c835ebc29bb8929c50e6036ae8e79d534a
 F src/parse.y 7a121554c0c0c0150a77ab05417b01fa44813ac4
 F src/pragma.c 89d62c31c6f0a43376fe8d20549b87a6d30c467a
 F src/printf.c 84e4ea4ba49cbbf930e95e82295127ad5843ae1f
@@ -183,7 +183,7 @@ F www/sqlite.tcl 3c83b08cf9f18aa2d69453ff441a36c40e431604
 F www/tclsqlite.tcl b9271d44dcf147a93c98f8ecf28c927307abd6da
 F www/vdbe.tcl 9b9095d4495f37697fd1935d10e14c6015e80aa1
 F www/whentouse.tcl a8335bce47cc2fddb07f19052cb0cb4d9129a8e4
-P 93ccd1b1d63b5b914b84b0463f2267bcfaadafa3
-R 7f0b69bb3003a648f1aaf93ee37865e5
+P 1736d415d776aa1cbdd33d987d21365ebf260f11
+R 429365f2137a58eb3bc313df232c3720
 U drh
-Z 3655582f22f2c5822a44942230c47f99
+Z a349ad5865c2d07827b7d95bf499b627
index 0b65345640051ecdd247a9f5de7176198f47fee1..6383a3520afa7559e7a9e6672843c2dc666ace09 100644 (file)
@@ -1 +1 @@
-1736d415d776aa1cbdd33d987d21365ebf260f11
\ No newline at end of file
+2f0c122cfb84dea58d112324a0bdd8b85552a9fa
\ No newline at end of file
index e504386dceaaf8a49a0649bd29b14ff8bd9dae29..d1776303d15126e728bc9f2dc32b0bba5f5d4963 100644 (file)
@@ -18,7 +18,7 @@
 ** file simultaneously, or one process from reading the database while
 ** another is writing.
 **
-** @(#) $Id: pager.c,v 1.95 2004/02/08 18:07:35 drh Exp $
+** @(#) $Id: pager.c,v 1.96 2004/02/09 01:20:37 drh Exp $
 */
 #include "os.h"         /* Must be first to enable large file support */
 #include "sqliteInt.h"
@@ -44,6 +44,19 @@ static Pager *mainPager = 0;
 #define TRACE3(X,Y,Z)
 #endif
 
+/*
+** Number of extra bytes of data allocated at the end of each page and
+** stored on disk but not used by the higher level btree layer.
+*/
+#ifndef SQLITE_PAGE_RESERVE
+#define SQLITE_PAGE_RESERVE 0
+#endif
+
+/*
+** The total number of bytes stored on disk for each page.
+*/
+#define SQLITE_BLOCK_SIZE (SQLITE_PAGE_SIZE+SQLITE_PAGE_RESERVE)
+
 
 /*
 ** The page cache as a whole is always in one of the following
@@ -113,7 +126,7 @@ struct PgHdr {
   u8 needSync;                   /* Sync journal before writing this page */
   u8 alwaysRollback;             /* Disable dont_rollback() for this page */
   PgHdr *pDirty;                 /* Dirty pages sorted by PgHdr.pgno */
-  /* SQLITE_PAGE_SIZE bytes of page data follow this header */
+  /* SQLITE_BLOCK_SIZE bytes of page data follow this header */
   /* Pager.nExtra bytes of local data follow the page data */
 };
 
@@ -123,7 +136,7 @@ struct PgHdr {
 */
 #define PGHDR_TO_DATA(P)  ((void*)(&(P)[1]))
 #define DATA_TO_PGHDR(D)  (&((PgHdr*)(D))[-1])
-#define PGHDR_TO_EXTRA(P) ((void*)&((char*)(&(P)[1]))[SQLITE_PAGE_SIZE])
+#define PGHDR_TO_EXTRA(P) ((void*)&((char*)(&(P)[1]))[SQLITE_BLOCK_SIZE])
 
 /*
 ** How big to make the hash table used for locating in-memory pages
@@ -158,6 +171,8 @@ struct Pager {
   int nRef;                   /* Number of in-memory pages with PgHdr.nRef>0 */
   int mxPage;                 /* Maximum number of pages to hold in cache */
   int nHit, nMiss, nOvfl;     /* Cache hits, missing, and LRU overflows */
+  void (*xCodec)(void*,void*,int); /* Routine for en/decoding on-disk data */
+  void *pCodecArg;            /* First argument to xCodec() */
   u8 journalOpen;             /* True if journal file descriptors is valid */
   u8 journalStarted;          /* True if header of journal is synced */
   u8 useJournal;              /* Use a rollback journal on this file */
@@ -201,8 +216,8 @@ struct Pager {
 */
 typedef struct PageRecord PageRecord;
 struct PageRecord {
-  Pgno pgno;                     /* The page number */
-  char aData[SQLITE_PAGE_SIZE];  /* Original data for page pgno */
+  Pgno pgno;                      /* The page number */
+  char aData[SQLITE_BLOCK_SIZE];  /* Original data for page pgno */
 };
 
 /*
@@ -225,7 +240,7 @@ struct PageRecord {
 **
 ** The sanity checking information for the 3rd journal format consists
 ** of a 32-bit checksum on each page of data.  The checksum covers both
-** the page number and the SQLITE_PAGE_SIZE bytes of data for the page.
+** the page number and the SQLITE_BLOCK_SIZE bytes of data for the page.
 ** This cksum is initialized to a 32-bit random value that appears in the
 ** journal file right after the header.  The random initializer is important,
 ** because garbage data that appears at the end of a journal is likely
@@ -270,7 +285,7 @@ int journal_format = 3;
 #define JOURNAL_HDR_SZ(X) \
    (sizeof(aJournalMagic1) + sizeof(Pgno) + ((X)>=3)*2*sizeof(u32))
 #define JOURNAL_PG_SZ(X) \
-   (SQLITE_PAGE_SIZE + sizeof(Pgno) + ((X)>=3)*sizeof(u32))
+   (SQLITE_BLOCK_SIZE + sizeof(Pgno) + ((X)>=3)*sizeof(u32))
 
 /*
 ** Enable reference count tracking here:
@@ -548,18 +563,21 @@ static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int format){
   */
   pPg = pager_lookup(pPager, pgRec.pgno);
   TRACE2("PLAYBACK %d\n", pgRec.pgno);
-  sqliteOsSeek(&pPager->fd, (pgRec.pgno-1)*(off_t)SQLITE_PAGE_SIZE);
-  rc = sqliteOsWrite(&pPager->fd, pgRec.aData, SQLITE_PAGE_SIZE);
+  sqliteOsSeek(&pPager->fd, (pgRec.pgno-1)*(off_t)SQLITE_BLOCK_SIZE);
+  rc = sqliteOsWrite(&pPager->fd, pgRec.aData, SQLITE_BLOCK_SIZE);
   if( pPg ){
     /* No page should ever be rolled back that is in use, except for page
     ** 1 which is held in use in order to keep the lock on the database
     ** active.
     */
     assert( pPg->nRef==0 || pPg->pgno==1 );
-    memcpy(PGHDR_TO_DATA(pPg), pgRec.aData, SQLITE_PAGE_SIZE);
+    memcpy(PGHDR_TO_DATA(pPg), pgRec.aData, SQLITE_BLOCK_SIZE);
     memset(PGHDR_TO_EXTRA(pPg), 0, pPager->nExtra);
     pPg->dirty = 0;
     pPg->needSync = 0;
+    if( pPager->xCodec ){
+      pPager->xCodec(pPager->pCodecArg, PGHDR_TO_DATA(pPg), 0);
+    }
   }
   return rc;
 }
@@ -583,7 +601,7 @@ static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int format){
 **       database to during a rollback.
 **    *  Zero or more pages instances, each as follows:
 **        +  4 byte page number.
-**        +  SQLITE_PAGE_SIZE bytes of data.
+**        +  SQLITE_BLOCK_SIZE bytes of data.
 **        +  4 byte checksum (format 3 only)
 **
 ** When we speak of the journal header, we mean the first 4 bullets above.
@@ -689,7 +707,7 @@ static int pager_playback(Pager *pPager, int useJournalSize){
     goto end_playback;
   }
   assert( pPager->origDbSize==0 || pPager->origDbSize==mxPg );
-  rc = sqliteOsTruncate(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)mxPg);
+  rc = sqliteOsTruncate(&pPager->fd, SQLITE_BLOCK_SIZE*(off_t)mxPg);
   if( rc!=SQLITE_OK ){
     goto end_playback;
   }
@@ -714,17 +732,20 @@ static int pager_playback(Pager *pPager, int useJournalSize){
   if( rc==SQLITE_OK ){
     PgHdr *pPg;
     for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
-      char zBuf[SQLITE_PAGE_SIZE];
+      char zBuf[SQLITE_BLOCK_SIZE];
       if( !pPg->dirty ) continue;
       if( (int)pPg->pgno <= pPager->origDbSize ){
-        sqliteOsSeek(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)(pPg->pgno-1));
-        rc = sqliteOsRead(&pPager->fd, zBuf, SQLITE_PAGE_SIZE);
+        sqliteOsSeek(&pPager->fd, SQLITE_BLOCK_SIZE*(off_t)(pPg->pgno-1));
+        rc = sqliteOsRead(&pPager->fd, zBuf, SQLITE_BLOCK_SIZE);
         if( rc ) break;
+        if( pPager->xCodec ){
+          pPager->xCodec(pPager->pCodecArg, zBuf, 0);
+        }
       }else{
-        memset(zBuf, 0, SQLITE_PAGE_SIZE);
+        memset(zBuf, 0, SQLITE_BLOCK_SIZE);
       }
-      if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), SQLITE_PAGE_SIZE) ){
-        memcpy(PGHDR_TO_DATA(pPg), zBuf, SQLITE_PAGE_SIZE);
+      if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), SQLITE_BLOCK_SIZE) ){
+        memcpy(PGHDR_TO_DATA(pPg), zBuf, SQLITE_BLOCK_SIZE);
         memset(PGHDR_TO_EXTRA(pPg), 0, pPager->nExtra);
       }
       pPg->needSync = 0;
@@ -765,7 +786,7 @@ static int pager_ckpt_playback(Pager *pPager){
 
   /* Truncate the database back to its original size.
   */
-  rc = sqliteOsTruncate(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)pPager->ckptSize);
+  rc = sqliteOsTruncate(&pPager->fd, SQLITE_BLOCK_SIZE*(off_t)pPager->ckptSize);
   pPager->dbSize = pPager->ckptSize;
 
   /* Figure out how many records are in the checkpoint journal.
@@ -1003,7 +1024,7 @@ int sqlitepager_pagecount(Pager *pPager){
     pPager->errMask |= PAGER_ERR_DISK;
     return 0;
   }
-  n /= SQLITE_PAGE_SIZE;
+  n /= SQLITE_BLOCK_SIZE;
   if( pPager->state!=SQLITE_UNLOCK ){
     pPager->dbSize = n;
   }
@@ -1031,7 +1052,7 @@ int sqlitepager_truncate(Pager *pPager, Pgno nPage){
     return SQLITE_OK;
   }
   syncJournal(pPager);
-  rc = sqliteOsTruncate(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)nPage);
+  rc = sqliteOsTruncate(&pPager->fd, SQLITE_BLOCK_SIZE*(off_t)nPage);
   if( rc==SQLITE_OK ){
     pPager->dbSize = nPage;
   }
@@ -1238,8 +1259,14 @@ static int pager_write_pagelist(PgHdr *pList){
   pPager = pList->pPager;
   while( pList ){
     assert( pList->dirty );
-    sqliteOsSeek(&pPager->fd, (pList->pgno-1)*(off_t)SQLITE_PAGE_SIZE);
-    rc = sqliteOsWrite(&pPager->fd, PGHDR_TO_DATA(pList), SQLITE_PAGE_SIZE);
+    sqliteOsSeek(&pPager->fd, (pList->pgno-1)*(off_t)SQLITE_BLOCK_SIZE);
+    if( pPager->xCodec ){
+      pPager->xCodec(pPager->pCodecArg, PGHDR_TO_DATA(pList), 1);
+    }
+    rc = sqliteOsWrite(&pPager->fd, PGHDR_TO_DATA(pList), SQLITE_BLOCK_SIZE);
+    if( pPager->xCodec ){
+      pPager->xCodec(pPager->pCodecArg, PGHDR_TO_DATA(pList), 0);
+    }
     if( rc ) return rc;
     pList->dirty = 0;
     pList = pList->pDirty;
@@ -1363,7 +1390,7 @@ int sqlitepager_get(Pager *pPager, Pgno pgno, void **ppPage){
     pPager->nMiss++;
     if( pPager->nPage<pPager->mxPage || pPager->pFirst==0 ){
       /* Create a new page */
-      pPg = sqliteMallocRaw( sizeof(*pPg) + SQLITE_PAGE_SIZE 
+      pPg = sqliteMallocRaw( sizeof(*pPg) + SQLITE_BLOCK_SIZE 
                               + sizeof(u32) + pPager->nExtra );
       if( pPg==0 ){
         pager_unwritelock(pPager);
@@ -1495,20 +1522,22 @@ int sqlitepager_get(Pager *pPager, Pgno pgno, void **ppPage){
       return rc;
     }
     if( pPager->dbSize<(int)pgno ){
-      memset(PGHDR_TO_DATA(pPg), 0, SQLITE_PAGE_SIZE);
+      memset(PGHDR_TO_DATA(pPg), 0, SQLITE_BLOCK_SIZE);
     }else{
       int rc;
-      sqliteOsSeek(&pPager->fd, (pgno-1)*(off_t)SQLITE_PAGE_SIZE);
-      rc = sqliteOsRead(&pPager->fd, PGHDR_TO_DATA(pPg), SQLITE_PAGE_SIZE);
+      sqliteOsSeek(&pPager->fd, (pgno-1)*(off_t)SQLITE_BLOCK_SIZE);
+      rc = sqliteOsRead(&pPager->fd, PGHDR_TO_DATA(pPg), SQLITE_BLOCK_SIZE);
       if( rc!=SQLITE_OK ){
         off_t fileSize;
         if( sqliteOsFileSize(&pPager->fd,&fileSize)!=SQLITE_OK
-               || fileSize>=pgno*SQLITE_PAGE_SIZE ){
+               || fileSize>=pgno*SQLITE_BLOCK_SIZE ){
           sqlitepager_unref(PGHDR_TO_DATA(pPg));
           return rc;
         }else{
-          memset(PGHDR_TO_DATA(pPg), 0, SQLITE_PAGE_SIZE);
+          memset(PGHDR_TO_DATA(pPg), 0, SQLITE_BLOCK_SIZE);
         }
+      }else if( pPager->xCodec ){
+        pPager->xCodec(pPager->pCodecArg, PGHDR_TO_DATA(pPg), 0);
       }
     }
   }else{
@@ -1787,7 +1816,13 @@ int sqlitepager_write(void *pData){
         szPg = SQLITE_PAGE_SIZE+4;
       }
       store32bits(pPg->pgno, pPg, -4);
+      if( pPager->xCodec ){
+        pPager->xCodec(pPager->pCodecArg, pData, 1);
+      }
       rc = sqliteOsWrite(&pPager->jfd, &((char*)pData)[-4], szPg);
+      if( pPager->xCodec ){
+        pPager->xCodec(pPager->pCodecArg, pData, 0);
+      }
       if( journal_format>=JOURNAL_FORMAT_3 ){
         *(u32*)PGHDR_TO_EXTRA(pPg) = saved;
       }
@@ -1823,7 +1858,7 @@ int sqlitepager_write(void *pData){
   if( pPager->ckptInUse && !pPg->inCkpt && (int)pPg->pgno<=pPager->ckptSize ){
     assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
     store32bits(pPg->pgno, pPg, -4);
-    rc = sqliteOsWrite(&pPager->cpfd, &((char*)pData)[-4], SQLITE_PAGE_SIZE+4);
+    rc = sqliteOsWrite(&pPager->cpfd, &((char*)pData)[-4], SQLITE_BLOCK_SIZE+4);
     if( rc!=SQLITE_OK ){
       sqlitepager_rollback(pPager);
       pPager->errMask |= PAGER_ERR_FULL;
@@ -1865,7 +1900,7 @@ int sqlitepager_overwrite(Pager *pPager, Pgno pgno, void *pData){
   if( rc==SQLITE_OK ){
     rc = sqlitepager_write(pPage);
     if( rc==SQLITE_OK ){
-      memcpy(pPage, pData, SQLITE_PAGE_SIZE);
+      memcpy(pPage, pData, SQLITE_BLOCK_SIZE);
     }
     sqlitepager_unref(pPage);
   }
@@ -2165,6 +2200,18 @@ const char *sqlitepager_filename(Pager *pPager){
   return pPager->zFilename;
 }
 
+/*
+** Set the codec for this pager
+*/
+void sqlitepager_set_codec(
+  Pager *pPager,
+  void (*xCodec)(void*,void*,int),
+  void *pCodecArg
+){
+  pPager->xCodec = xCodec;
+  pPager->pCodecArg = pCodecArg;
+}
+
 #ifdef SQLITE_TEST
 /*
 ** Print a listing of all referenced pages and their ref count.
index e3a97d9bda1026d2021ab1610313e50674c27c99..d3757f846a9e4c7a6d2f6bdbc0d086525f83a0eb 100644 (file)
@@ -13,7 +13,7 @@
 ** subsystem.  The page cache subsystem reads and writes a file a page
 ** at a time and provides a journal for rollback.
 **
-** @(#) $Id: pager.h,v 1.23 2003/04/25 13:22:53 drh Exp $
+** @(#) $Id: pager.h,v 1.24 2004/02/09 01:20:37 drh Exp $
 */
 
 /*
@@ -24,7 +24,9 @@
 ** experiments show that a page size of 1024 gives the best speed.
 ** (The speed differences are minimal.)
 */
+#ifndef SQLITE_PAGE_SIZE
 #define SQLITE_PAGE_SIZE 1024
+#endif
 
 /*
 ** Maximum number of pages in one database.  (This is a limitation of
@@ -75,6 +77,7 @@ int *sqlitepager_stats(Pager*);
 void sqlitepager_set_safety_level(Pager*,int);
 const char *sqlitepager_filename(Pager*);
 int sqlitepager_rename(Pager*, const char *zNewName);
+void sqlitepager_set_codec(Pager*,void(*)(void*,void*,int),void*);
 
 #ifdef SQLITE_TEST
 void sqlitepager_refdump(Pager*);