sl@0: /*
sl@0: ** 2008 Jan 22
sl@0: **
sl@0: ** The author disclaims copyright to this source code.  In place of
sl@0: ** a legal notice, here is a blessing:
sl@0: **
sl@0: **    May you do good and not evil.
sl@0: **    May you find forgiveness for yourself and forgive others.
sl@0: **    May you share freely, never taking more than you give.
sl@0: **
sl@0: ******************************************************************************
sl@0: **
sl@0: ** This file contains code that modified the OS layer in order to simulate
sl@0: ** different device types (by overriding the return values of the 
sl@0: ** xDeviceCharacteristics() and xSectorSize() methods).
sl@0: **
sl@0: ** $Id: test_devsym.c,v 1.8 2008/09/12 10:22:40 danielk1977 Exp $
sl@0: */
sl@0: #if SQLITE_TEST          /* This file is used for testing only */
sl@0: 
sl@0: #include "sqlite3.h"
sl@0: #include "sqliteInt.h"
sl@0: 
sl@0: /*
sl@0: ** Maximum pathname length supported by the devsym backend.
sl@0: */
sl@0: #define DEVSYM_MAX_PATHNAME 512
sl@0: 
sl@0: /*
sl@0: ** Name used to identify this VFS.
sl@0: */
sl@0: #define DEVSYM_VFS_NAME "devsym"
sl@0: 
sl@0: typedef struct devsym_file devsym_file;
sl@0: struct devsym_file {
sl@0:   sqlite3_file base;
sl@0:   sqlite3_file *pReal;
sl@0: };
sl@0: 
sl@0: /*
sl@0: ** Method declarations for devsym_file.
sl@0: */
sl@0: static int devsymClose(sqlite3_file*);
sl@0: static int devsymRead(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
sl@0: static int devsymWrite(sqlite3_file*,const void*,int iAmt, sqlite3_int64 iOfst);
sl@0: static int devsymTruncate(sqlite3_file*, sqlite3_int64 size);
sl@0: static int devsymSync(sqlite3_file*, int flags);
sl@0: static int devsymFileSize(sqlite3_file*, sqlite3_int64 *pSize);
sl@0: static int devsymLock(sqlite3_file*, int);
sl@0: static int devsymUnlock(sqlite3_file*, int);
sl@0: static int devsymCheckReservedLock(sqlite3_file*, int *);
sl@0: static int devsymFileControl(sqlite3_file*, int op, void *pArg);
sl@0: static int devsymSectorSize(sqlite3_file*);
sl@0: static int devsymDeviceCharacteristics(sqlite3_file*);
sl@0: 
sl@0: /*
sl@0: ** Method declarations for devsym_vfs.
sl@0: */
sl@0: static int devsymOpen(sqlite3_vfs*, const char *, sqlite3_file*, int , int *);
sl@0: static int devsymDelete(sqlite3_vfs*, const char *zName, int syncDir);
sl@0: static int devsymAccess(sqlite3_vfs*, const char *zName, int flags, int *);
sl@0: static int devsymFullPathname(sqlite3_vfs*, const char *zName, int, char *zOut);
sl@0: #ifndef SQLITE_OMIT_LOAD_EXTENSION
sl@0: static void *devsymDlOpen(sqlite3_vfs*, const char *zFilename);
sl@0: static void devsymDlError(sqlite3_vfs*, int nByte, char *zErrMsg);
sl@0: static void *devsymDlSym(sqlite3_vfs*,void*, const char *zSymbol);
sl@0: static void devsymDlClose(sqlite3_vfs*, void*);
sl@0: #endif /* SQLITE_OMIT_LOAD_EXTENSION */
sl@0: static int devsymRandomness(sqlite3_vfs*, int nByte, char *zOut);
sl@0: static int devsymSleep(sqlite3_vfs*, int microseconds);
sl@0: static int devsymCurrentTime(sqlite3_vfs*, double*);
sl@0: 
sl@0: static sqlite3_vfs devsym_vfs = {
sl@0:   1,                     /* iVersion */
sl@0:   sizeof(devsym_file),      /* szOsFile */
sl@0:   DEVSYM_MAX_PATHNAME,      /* mxPathname */
sl@0:   0,                     /* pNext */
sl@0:   DEVSYM_VFS_NAME,          /* zName */
sl@0:   0,                     /* pAppData */
sl@0:   devsymOpen,               /* xOpen */
sl@0:   devsymDelete,             /* xDelete */
sl@0:   devsymAccess,             /* xAccess */
sl@0:   devsymFullPathname,       /* xFullPathname */
sl@0: #ifndef SQLITE_OMIT_LOAD_EXTENSION
sl@0:   devsymDlOpen,             /* xDlOpen */
sl@0:   devsymDlError,            /* xDlError */
sl@0:   devsymDlSym,              /* xDlSym */
sl@0:   devsymDlClose,            /* xDlClose */
sl@0: #else
sl@0:   0,                        /* xDlOpen */
sl@0:   0,                        /* xDlError */
sl@0:   0,                        /* xDlSym */
sl@0:   0,                        /* xDlClose */
sl@0: #endif /* SQLITE_OMIT_LOAD_EXTENSION */
sl@0:   devsymRandomness,         /* xRandomness */
sl@0:   devsymSleep,              /* xSleep */
sl@0:   devsymCurrentTime         /* xCurrentTime */
sl@0: };
sl@0: 
sl@0: static sqlite3_io_methods devsym_io_methods = {
sl@0:   1,                            /* iVersion */
sl@0:   devsymClose,                      /* xClose */
sl@0:   devsymRead,                       /* xRead */
sl@0:   devsymWrite,                      /* xWrite */
sl@0:   devsymTruncate,                   /* xTruncate */
sl@0:   devsymSync,                       /* xSync */
sl@0:   devsymFileSize,                   /* xFileSize */
sl@0:   devsymLock,                       /* xLock */
sl@0:   devsymUnlock,                     /* xUnlock */
sl@0:   devsymCheckReservedLock,          /* xCheckReservedLock */
sl@0:   devsymFileControl,                /* xFileControl */
sl@0:   devsymSectorSize,                 /* xSectorSize */
sl@0:   devsymDeviceCharacteristics       /* xDeviceCharacteristics */
sl@0: };
sl@0: 
sl@0: struct DevsymGlobal {
sl@0:   sqlite3_vfs *pVfs;
sl@0:   int iDeviceChar;
sl@0:   int iSectorSize;
sl@0: };
sl@0: struct DevsymGlobal g = {0, 0, 512};
sl@0: 
sl@0: /*
sl@0: ** Close an devsym-file.
sl@0: */
sl@0: static int devsymClose(sqlite3_file *pFile){
sl@0:   devsym_file *p = (devsym_file *)pFile;
sl@0:   return sqlite3OsClose(p->pReal);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Read data from an devsym-file.
sl@0: */
sl@0: static int devsymRead(
sl@0:   sqlite3_file *pFile, 
sl@0:   void *zBuf, 
sl@0:   int iAmt, 
sl@0:   sqlite_int64 iOfst
sl@0: ){
sl@0:   devsym_file *p = (devsym_file *)pFile;
sl@0:   return sqlite3OsRead(p->pReal, zBuf, iAmt, iOfst);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Write data to an devsym-file.
sl@0: */
sl@0: static int devsymWrite(
sl@0:   sqlite3_file *pFile, 
sl@0:   const void *zBuf, 
sl@0:   int iAmt, 
sl@0:   sqlite_int64 iOfst
sl@0: ){
sl@0:   devsym_file *p = (devsym_file *)pFile;
sl@0:   return sqlite3OsWrite(p->pReal, zBuf, iAmt, iOfst);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Truncate an devsym-file.
sl@0: */
sl@0: static int devsymTruncate(sqlite3_file *pFile, sqlite_int64 size){
sl@0:   devsym_file *p = (devsym_file *)pFile;
sl@0:   return sqlite3OsTruncate(p->pReal, size);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Sync an devsym-file.
sl@0: */
sl@0: static int devsymSync(sqlite3_file *pFile, int flags){
sl@0:   devsym_file *p = (devsym_file *)pFile;
sl@0:   return sqlite3OsSync(p->pReal, flags);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Return the current file-size of an devsym-file.
sl@0: */
sl@0: static int devsymFileSize(sqlite3_file *pFile, sqlite_int64 *pSize){
sl@0:   devsym_file *p = (devsym_file *)pFile;
sl@0:   return sqlite3OsFileSize(p->pReal, pSize);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Lock an devsym-file.
sl@0: */
sl@0: static int devsymLock(sqlite3_file *pFile, int eLock){
sl@0:   devsym_file *p = (devsym_file *)pFile;
sl@0:   return sqlite3OsLock(p->pReal, eLock);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Unlock an devsym-file.
sl@0: */
sl@0: static int devsymUnlock(sqlite3_file *pFile, int eLock){
sl@0:   devsym_file *p = (devsym_file *)pFile;
sl@0:   return sqlite3OsUnlock(p->pReal, eLock);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Check if another file-handle holds a RESERVED lock on an devsym-file.
sl@0: */
sl@0: static int devsymCheckReservedLock(sqlite3_file *pFile, int *pResOut){
sl@0:   devsym_file *p = (devsym_file *)pFile;
sl@0:   return sqlite3OsCheckReservedLock(p->pReal, pResOut);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** File control method. For custom operations on an devsym-file.
sl@0: */
sl@0: static int devsymFileControl(sqlite3_file *pFile, int op, void *pArg){
sl@0:   devsym_file *p = (devsym_file *)pFile;
sl@0:   return sqlite3OsFileControl(p->pReal, op, pArg);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Return the sector-size in bytes for an devsym-file.
sl@0: */
sl@0: static int devsymSectorSize(sqlite3_file *pFile){
sl@0:   return g.iSectorSize;
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Return the device characteristic flags supported by an devsym-file.
sl@0: */
sl@0: static int devsymDeviceCharacteristics(sqlite3_file *pFile){
sl@0:   return g.iDeviceChar;
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Open an devsym file handle.
sl@0: */
sl@0: static int devsymOpen(
sl@0:   sqlite3_vfs *pVfs,
sl@0:   const char *zName,
sl@0:   sqlite3_file *pFile,
sl@0:   int flags,
sl@0:   int *pOutFlags
sl@0: ){
sl@0:   int rc;
sl@0:   devsym_file *p = (devsym_file *)pFile;
sl@0:   p->pReal = (sqlite3_file *)&p[1];
sl@0:   rc = sqlite3OsOpen(g.pVfs, zName, p->pReal, flags, pOutFlags);
sl@0:   if( p->pReal->pMethods ){
sl@0:     pFile->pMethods = &devsym_io_methods;
sl@0:   }
sl@0:   return rc;
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Delete the file located at zPath. If the dirSync argument is true,
sl@0: ** ensure the file-system modifications are synced to disk before
sl@0: ** returning.
sl@0: */
sl@0: static int devsymDelete(sqlite3_vfs *pVfs, const char *zPath, int dirSync){
sl@0:   return sqlite3OsDelete(g.pVfs, zPath, dirSync);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Test for access permissions. Return true if the requested permission
sl@0: ** is available, or false otherwise.
sl@0: */
sl@0: static int devsymAccess(
sl@0:   sqlite3_vfs *pVfs, 
sl@0:   const char *zPath, 
sl@0:   int flags, 
sl@0:   int *pResOut
sl@0: ){
sl@0:   return sqlite3OsAccess(g.pVfs, zPath, flags, pResOut);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Populate buffer zOut with the full canonical pathname corresponding
sl@0: ** to the pathname in zPath. zOut is guaranteed to point to a buffer
sl@0: ** of at least (DEVSYM_MAX_PATHNAME+1) bytes.
sl@0: */
sl@0: static int devsymFullPathname(
sl@0:   sqlite3_vfs *pVfs, 
sl@0:   const char *zPath, 
sl@0:   int nOut, 
sl@0:   char *zOut
sl@0: ){
sl@0:   return sqlite3OsFullPathname(g.pVfs, zPath, nOut, zOut);
sl@0: }
sl@0: 
sl@0: #ifndef SQLITE_OMIT_LOAD_EXTENSION
sl@0: /*
sl@0: ** Open the dynamic library located at zPath and return a handle.
sl@0: */
sl@0: static void *devsymDlOpen(sqlite3_vfs *pVfs, const char *zPath){
sl@0:   return sqlite3OsDlOpen(g.pVfs, zPath);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Populate the buffer zErrMsg (size nByte bytes) with a human readable
sl@0: ** utf-8 string describing the most recent error encountered associated 
sl@0: ** with dynamic libraries.
sl@0: */
sl@0: static void devsymDlError(sqlite3_vfs *pVfs, int nByte, char *zErrMsg){
sl@0:   sqlite3OsDlError(g.pVfs, nByte, zErrMsg);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Return a pointer to the symbol zSymbol in the dynamic library pHandle.
sl@0: */
sl@0: static void *devsymDlSym(sqlite3_vfs *pVfs, void *pHandle, const char *zSymbol){
sl@0:   return sqlite3OsDlSym(g.pVfs, pHandle, zSymbol);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Close the dynamic library handle pHandle.
sl@0: */
sl@0: static void devsymDlClose(sqlite3_vfs *pVfs, void *pHandle){
sl@0:   sqlite3OsDlClose(g.pVfs, pHandle);
sl@0: }
sl@0: #endif /* SQLITE_OMIT_LOAD_EXTENSION */
sl@0: 
sl@0: /*
sl@0: ** Populate the buffer pointed to by zBufOut with nByte bytes of 
sl@0: ** random data.
sl@0: */
sl@0: static int devsymRandomness(sqlite3_vfs *pVfs, int nByte, char *zBufOut){
sl@0:   return sqlite3OsRandomness(g.pVfs, nByte, zBufOut);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Sleep for nMicro microseconds. Return the number of microseconds 
sl@0: ** actually slept.
sl@0: */
sl@0: static int devsymSleep(sqlite3_vfs *pVfs, int nMicro){
sl@0:   return sqlite3OsSleep(g.pVfs, nMicro);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** Return the current time as a Julian Day number in *pTimeOut.
sl@0: */
sl@0: static int devsymCurrentTime(sqlite3_vfs *pVfs, double *pTimeOut){
sl@0:   return sqlite3OsCurrentTime(g.pVfs, pTimeOut);
sl@0: }
sl@0: 
sl@0: /*
sl@0: ** This procedure registers the devsym vfs with SQLite. If the argument is
sl@0: ** true, the devsym vfs becomes the new default vfs. It is the only publicly
sl@0: ** available function in this file.
sl@0: */
sl@0: void devsym_register(int iDeviceChar, int iSectorSize){
sl@0:   if( g.pVfs==0 ){
sl@0:     g.pVfs = sqlite3_vfs_find(0);
sl@0:     devsym_vfs.szOsFile += g.pVfs->szOsFile;
sl@0:     sqlite3_vfs_register(&devsym_vfs, 0);
sl@0:   }
sl@0:   if( iDeviceChar>=0 ){
sl@0:     g.iDeviceChar = iDeviceChar;
sl@0:   }
sl@0:   if( iSectorSize>=0 ){
sl@0:     g.iSectorSize = iSectorSize;
sl@0:   }
sl@0: }
sl@0: 
sl@0: #endif