1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sqlite3api/TEST/SRC/test6.c Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,881 @@
1.4 +/*
1.5 +** 2004 May 22
1.6 +**
1.7 +** The author disclaims copyright to this source code. In place of
1.8 +** a legal notice, here is a blessing:
1.9 +**
1.10 +** May you do good and not evil.
1.11 +** May you find forgiveness for yourself and forgive others.
1.12 +** May you share freely, never taking more than you give.
1.13 +**
1.14 +******************************************************************************
1.15 +**
1.16 +** This file contains code that modified the OS layer in order to simulate
1.17 +** the effect on the database file of an OS crash or power failure. This
1.18 +** is used to test the ability of SQLite to recover from those situations.
1.19 +**
1.20 +** $Id: test6.c,v 1.39 2008/06/06 11:11:26 danielk1977 Exp $
1.21 +*/
1.22 +#if SQLITE_TEST /* This file is used for testing only */
1.23 +#include "sqliteInt.h"
1.24 +#include "tcl.h"
1.25 +
1.26 +#ifndef SQLITE_OMIT_DISKIO /* This file is a no-op if disk I/O is disabled */
1.27 +
1.28 +/* #define TRACE_CRASHTEST */
1.29 +
1.30 +typedef struct CrashFile CrashFile;
1.31 +typedef struct CrashGlobal CrashGlobal;
1.32 +typedef struct WriteBuffer WriteBuffer;
1.33 +
1.34 +/*
1.35 +** Method:
1.36 +**
1.37 +** This layer is implemented as a wrapper around the "real"
1.38 +** sqlite3_file object for the host system. Each time data is
1.39 +** written to the file object, instead of being written to the
1.40 +** underlying file, the write operation is stored in an in-memory
1.41 +** structure (type WriteBuffer). This structure is placed at the
1.42 +** end of a global ordered list (the write-list).
1.43 +**
1.44 +** When data is read from a file object, the requested region is
1.45 +** first retrieved from the real file. The write-list is then
1.46 +** traversed and data copied from any overlapping WriteBuffer
1.47 +** structures to the output buffer. i.e. a read() operation following
1.48 +** one or more write() operations works as expected, even if no
1.49 +** data has actually been written out to the real file.
1.50 +**
1.51 +** When a fsync() operation is performed, an operating system crash
1.52 +** may be simulated, in which case exit(-1) is called (the call to
1.53 +** xSync() never returns). Whether or not a crash is simulated,
1.54 +** the data associated with a subset of the WriteBuffer structures
1.55 +** stored in the write-list is written to the real underlying files
1.56 +** and the entries removed from the write-list. If a crash is simulated,
1.57 +** a subset of the buffers may be corrupted before the data is written.
1.58 +**
1.59 +** The exact subset of the write-list written and/or corrupted is
1.60 +** determined by the simulated device characteristics and sector-size.
1.61 +**
1.62 +** "Normal" mode:
1.63 +**
1.64 +** Normal mode is used when the simulated device has none of the
1.65 +** SQLITE_IOCAP_XXX flags set.
1.66 +**
1.67 +** In normal mode, if the fsync() is not a simulated crash, the
1.68 +** write-list is traversed from beginning to end. Each WriteBuffer
1.69 +** structure associated with the file handle used to call xSync()
1.70 +** is written to the real file and removed from the write-list.
1.71 +**
1.72 +** If a crash is simulated, one of the following takes place for
1.73 +** each WriteBuffer in the write-list, regardless of which
1.74 +** file-handle it is associated with:
1.75 +**
1.76 +** 1. The buffer is correctly written to the file, just as if
1.77 +** a crash were not being simulated.
1.78 +**
1.79 +** 2. Nothing is done.
1.80 +**
1.81 +** 3. Garbage data is written to all sectors of the file that
1.82 +** overlap the region specified by the WriteBuffer. Or garbage
1.83 +** data is written to some contiguous section within the
1.84 +** overlapped sectors.
1.85 +**
1.86 +** Device Characteristic flag handling:
1.87 +**
1.88 +** If the IOCAP_ATOMIC flag is set, then option (3) above is
1.89 +** never selected.
1.90 +**
1.91 +** If the IOCAP_ATOMIC512 flag is set, and the WriteBuffer represents
1.92 +** an aligned write() of an integer number of 512 byte regions, then
1.93 +** option (3) above is never selected. Instead, each 512 byte region
1.94 +** is either correctly written or left completely untouched. Similar
1.95 +** logic governs the behaviour if any of the other ATOMICXXX flags
1.96 +** is set.
1.97 +**
1.98 +** If either the IOCAP_SAFEAPPEND or IOCAP_SEQUENTIAL flags are set
1.99 +** and a crash is being simulated, then an entry of the write-list is
1.100 +** selected at random. Everything in the list after the selected entry
1.101 +** is discarded before processing begins.
1.102 +**
1.103 +** If IOCAP_SEQUENTIAL is set and a crash is being simulated, option
1.104 +** (1) is selected for all write-list entries except the last. If a
1.105 +** crash is not being simulated, then all entries in the write-list
1.106 +** that occur before at least one write() on the file-handle specified
1.107 +** as part of the xSync() are written to their associated real files.
1.108 +**
1.109 +** If IOCAP_SAFEAPPEND is set and the first byte written by the write()
1.110 +** operation is one byte past the current end of the file, then option
1.111 +** (1) is always selected.
1.112 +*/
1.113 +
1.114 +/*
1.115 +** Each write operation in the write-list is represented by an instance
1.116 +** of the following structure.
1.117 +**
1.118 +** If zBuf is 0, then this structure represents a call to xTruncate(),
1.119 +** not xWrite(). In that case, iOffset is the size that the file is
1.120 +** truncated to.
1.121 +*/
1.122 +struct WriteBuffer {
1.123 + i64 iOffset; /* Byte offset of the start of this write() */
1.124 + int nBuf; /* Number of bytes written */
1.125 + u8 *zBuf; /* Pointer to copy of written data */
1.126 + CrashFile *pFile; /* File this write() applies to */
1.127 +
1.128 + WriteBuffer *pNext; /* Next in CrashGlobal.pWriteList */
1.129 +};
1.130 +
1.131 +struct CrashFile {
1.132 + const sqlite3_io_methods *pMethod; /* Must be first */
1.133 + sqlite3_file *pRealFile; /* Underlying "real" file handle */
1.134 + char *zName;
1.135 +
1.136 + /* Cache of the entire file. This is used to speed up OsRead() and
1.137 + ** OsFileSize() calls. Although both could be done by traversing the
1.138 + ** write-list, in practice this is impractically slow.
1.139 + */
1.140 + int iSize; /* Size of file in bytes */
1.141 + int nData; /* Size of buffer allocated at zData */
1.142 + u8 *zData; /* Buffer containing file contents */
1.143 +};
1.144 +
1.145 +struct CrashGlobal {
1.146 + WriteBuffer *pWriteList; /* Head of write-list */
1.147 + WriteBuffer *pWriteListEnd; /* End of write-list */
1.148 +
1.149 + int iSectorSize; /* Value of simulated sector size */
1.150 + int iDeviceCharacteristics; /* Value of simulated device characteristics */
1.151 +
1.152 + int iCrash; /* Crash on the iCrash'th call to xSync() */
1.153 + char zCrashFile[500]; /* Crash during an xSync() on this file */
1.154 +};
1.155 +
1.156 +static CrashGlobal g = {0, 0, SQLITE_DEFAULT_SECTOR_SIZE, 0, 0};
1.157 +
1.158 +/*
1.159 +** Set this global variable to 1 to enable crash testing.
1.160 +*/
1.161 +static int sqlite3CrashTestEnable = 0;
1.162 +
1.163 +static void *crash_malloc(int nByte){
1.164 + return (void *)Tcl_Alloc((size_t)nByte);
1.165 +}
1.166 +static void crash_free(void *p){
1.167 + Tcl_Free(p);
1.168 +}
1.169 +static void *crash_realloc(void *p, int n){
1.170 + return (void *)Tcl_Realloc(p, (size_t)n);
1.171 +}
1.172 +
1.173 +/*
1.174 +** Flush the write-list as if xSync() had been called on file handle
1.175 +** pFile. If isCrash is true, simulate a crash.
1.176 +*/
1.177 +static int writeListSync(CrashFile *pFile, int isCrash){
1.178 + int rc = SQLITE_OK;
1.179 + int iDc = g.iDeviceCharacteristics;
1.180 +
1.181 + WriteBuffer *pWrite;
1.182 + WriteBuffer **ppPtr;
1.183 +
1.184 + /* If this is not a crash simulation, set pFinal to point to the
1.185 + ** last element of the write-list that is associated with file handle
1.186 + ** pFile.
1.187 + **
1.188 + ** If this is a crash simulation, set pFinal to an arbitrarily selected
1.189 + ** element of the write-list.
1.190 + */
1.191 + WriteBuffer *pFinal = 0;
1.192 + if( !isCrash ){
1.193 + for(pWrite=g.pWriteList; pWrite; pWrite=pWrite->pNext){
1.194 + if( pWrite->pFile==pFile ){
1.195 + pFinal = pWrite;
1.196 + }
1.197 + }
1.198 + }else if( iDc&(SQLITE_IOCAP_SEQUENTIAL|SQLITE_IOCAP_SAFE_APPEND) ){
1.199 + int nWrite = 0;
1.200 + int iFinal;
1.201 + for(pWrite=g.pWriteList; pWrite; pWrite=pWrite->pNext) nWrite++;
1.202 + sqlite3_randomness(sizeof(int), &iFinal);
1.203 + iFinal = ((iFinal<0)?-1*iFinal:iFinal)%nWrite;
1.204 + for(pWrite=g.pWriteList; iFinal>0; pWrite=pWrite->pNext) iFinal--;
1.205 + pFinal = pWrite;
1.206 + }
1.207 +
1.208 +#ifdef TRACE_CRASHTEST
1.209 + printf("Sync %s (is %s crash)\n", pFile->zName, (isCrash?"a":"not a"));
1.210 +#endif
1.211 +
1.212 + ppPtr = &g.pWriteList;
1.213 + for(pWrite=*ppPtr; rc==SQLITE_OK && pWrite; pWrite=*ppPtr){
1.214 + sqlite3_file *pRealFile = pWrite->pFile->pRealFile;
1.215 +
1.216 + /* (eAction==1) -> write block out normally,
1.217 + ** (eAction==2) -> do nothing,
1.218 + ** (eAction==3) -> trash sectors.
1.219 + */
1.220 + int eAction = 0;
1.221 + if( !isCrash ){
1.222 + eAction = 2;
1.223 + if( (pWrite->pFile==pFile || iDc&SQLITE_IOCAP_SEQUENTIAL) ){
1.224 + eAction = 1;
1.225 + }
1.226 + }else{
1.227 + char random;
1.228 + sqlite3_randomness(1, &random);
1.229 +
1.230 + /* Do not select option 3 (sector trashing) if the IOCAP_ATOMIC flag
1.231 + ** is set or this is an OsTruncate(), not an Oswrite().
1.232 + */
1.233 + if( (iDc&SQLITE_IOCAP_ATOMIC) || (pWrite->zBuf==0) ){
1.234 + random &= 0x01;
1.235 + }
1.236 +
1.237 + /* If IOCAP_SEQUENTIAL is set and this is not the final entry
1.238 + ** in the truncated write-list, always select option 1 (write
1.239 + ** out correctly).
1.240 + */
1.241 + if( (iDc&SQLITE_IOCAP_SEQUENTIAL && pWrite!=pFinal) ){
1.242 + random = 0;
1.243 + }
1.244 +
1.245 + /* If IOCAP_SAFE_APPEND is set and this OsWrite() operation is
1.246 + ** an append (first byte of the written region is 1 byte past the
1.247 + ** current EOF), always select option 1 (write out correctly).
1.248 + */
1.249 + if( iDc&SQLITE_IOCAP_SAFE_APPEND && pWrite->zBuf ){
1.250 + i64 iSize;
1.251 + sqlite3OsFileSize(pRealFile, &iSize);
1.252 + if( iSize==pWrite->iOffset ){
1.253 + random = 0;
1.254 + }
1.255 + }
1.256 +
1.257 + if( (random&0x06)==0x06 ){
1.258 + eAction = 3;
1.259 + }else{
1.260 + eAction = ((random&0x01)?2:1);
1.261 + }
1.262 + }
1.263 +
1.264 + switch( eAction ){
1.265 + case 1: { /* Write out correctly */
1.266 + if( pWrite->zBuf ){
1.267 + rc = sqlite3OsWrite(
1.268 + pRealFile, pWrite->zBuf, pWrite->nBuf, pWrite->iOffset
1.269 + );
1.270 + }else{
1.271 + rc = sqlite3OsTruncate(pRealFile, pWrite->iOffset);
1.272 + }
1.273 + *ppPtr = pWrite->pNext;
1.274 +#ifdef TRACE_CRASHTEST
1.275 + if( isCrash ){
1.276 + printf("Writing %d bytes @ %d (%s)\n",
1.277 + pWrite->nBuf, (int)pWrite->iOffset, pWrite->pFile->zName
1.278 + );
1.279 + }
1.280 +#endif
1.281 + crash_free(pWrite);
1.282 + break;
1.283 + }
1.284 + case 2: { /* Do nothing */
1.285 + ppPtr = &pWrite->pNext;
1.286 +#ifdef TRACE_CRASHTEST
1.287 + if( isCrash ){
1.288 + printf("Omiting %d bytes @ %d (%s)\n",
1.289 + pWrite->nBuf, (int)pWrite->iOffset, pWrite->pFile->zName
1.290 + );
1.291 + }
1.292 +#endif
1.293 + break;
1.294 + }
1.295 + case 3: { /* Trash sectors */
1.296 + u8 *zGarbage;
1.297 + int iFirst = (pWrite->iOffset/g.iSectorSize);
1.298 + int iLast = (pWrite->iOffset+pWrite->nBuf-1)/g.iSectorSize;
1.299 +
1.300 + assert(pWrite->zBuf);
1.301 +
1.302 +#ifdef TRACE_CRASHTEST
1.303 + printf("Trashing %d sectors @ sector %d (%s)\n",
1.304 + 1+iLast-iFirst, iFirst, pWrite->pFile->zName
1.305 + );
1.306 +#endif
1.307 +
1.308 + zGarbage = crash_malloc(g.iSectorSize);
1.309 + if( zGarbage ){
1.310 + sqlite3_int64 i;
1.311 + for(i=iFirst; rc==SQLITE_OK && i<=iLast; i++){
1.312 + sqlite3_randomness(g.iSectorSize, zGarbage);
1.313 + rc = sqlite3OsWrite(
1.314 + pRealFile, zGarbage, g.iSectorSize, i*g.iSectorSize
1.315 + );
1.316 + }
1.317 + crash_free(zGarbage);
1.318 + }else{
1.319 + rc = SQLITE_NOMEM;
1.320 + }
1.321 +
1.322 + ppPtr = &pWrite->pNext;
1.323 + break;
1.324 + }
1.325 +
1.326 + default:
1.327 + assert(0); /* Cannot happen */
1.328 + }
1.329 +
1.330 + if( pWrite==pFinal ) break;
1.331 + }
1.332 +
1.333 + if( rc==SQLITE_OK && isCrash ){
1.334 + exit(-1);
1.335 + }
1.336 +
1.337 + for(pWrite=g.pWriteList; pWrite && pWrite->pNext; pWrite=pWrite->pNext);
1.338 + g.pWriteListEnd = pWrite;
1.339 +
1.340 + return rc;
1.341 +}
1.342 +
1.343 +/*
1.344 +** Add an entry to the end of the write-list.
1.345 +*/
1.346 +static int writeListAppend(
1.347 + sqlite3_file *pFile,
1.348 + sqlite3_int64 iOffset,
1.349 + const u8 *zBuf,
1.350 + int nBuf
1.351 +){
1.352 + WriteBuffer *pNew;
1.353 +
1.354 + assert((zBuf && nBuf) || (!nBuf && !zBuf));
1.355 +
1.356 + pNew = (WriteBuffer *)crash_malloc(sizeof(WriteBuffer) + nBuf);
1.357 + if( pNew==0 ){
1.358 + fprintf(stderr, "out of memory in the crash simulator\n");
1.359 + }
1.360 + memset(pNew, 0, sizeof(WriteBuffer)+nBuf);
1.361 + pNew->iOffset = iOffset;
1.362 + pNew->nBuf = nBuf;
1.363 + pNew->pFile = (CrashFile *)pFile;
1.364 + if( zBuf ){
1.365 + pNew->zBuf = (u8 *)&pNew[1];
1.366 + memcpy(pNew->zBuf, zBuf, nBuf);
1.367 + }
1.368 +
1.369 + if( g.pWriteList ){
1.370 + assert(g.pWriteListEnd);
1.371 + g.pWriteListEnd->pNext = pNew;
1.372 + }else{
1.373 + g.pWriteList = pNew;
1.374 + }
1.375 + g.pWriteListEnd = pNew;
1.376 +
1.377 + return SQLITE_OK;
1.378 +}
1.379 +
1.380 +/*
1.381 +** Close a crash-file.
1.382 +*/
1.383 +static int cfClose(sqlite3_file *pFile){
1.384 + CrashFile *pCrash = (CrashFile *)pFile;
1.385 + writeListSync(pCrash, 0);
1.386 + sqlite3OsClose(pCrash->pRealFile);
1.387 + return SQLITE_OK;
1.388 +}
1.389 +
1.390 +/*
1.391 +** Read data from a crash-file.
1.392 +*/
1.393 +static int cfRead(
1.394 + sqlite3_file *pFile,
1.395 + void *zBuf,
1.396 + int iAmt,
1.397 + sqlite_int64 iOfst
1.398 +){
1.399 + CrashFile *pCrash = (CrashFile *)pFile;
1.400 +
1.401 + /* Check the file-size to see if this is a short-read */
1.402 + if( pCrash->iSize<(iOfst+iAmt) ){
1.403 + return SQLITE_IOERR_SHORT_READ;
1.404 + }
1.405 +
1.406 + memcpy(zBuf, &pCrash->zData[iOfst], iAmt);
1.407 + return SQLITE_OK;
1.408 +}
1.409 +
1.410 +/*
1.411 +** Write data to a crash-file.
1.412 +*/
1.413 +static int cfWrite(
1.414 + sqlite3_file *pFile,
1.415 + const void *zBuf,
1.416 + int iAmt,
1.417 + sqlite_int64 iOfst
1.418 +){
1.419 + CrashFile *pCrash = (CrashFile *)pFile;
1.420 + if( iAmt+iOfst>pCrash->iSize ){
1.421 + pCrash->iSize = iAmt+iOfst;
1.422 + }
1.423 + while( pCrash->iSize>pCrash->nData ){
1.424 + u8 *zNew;
1.425 + int nNew = (pCrash->nData*2) + 4096;
1.426 + zNew = crash_realloc(pCrash->zData, nNew);
1.427 + if( !zNew ){
1.428 + return SQLITE_NOMEM;
1.429 + }
1.430 + memset(&zNew[pCrash->nData], 0, nNew-pCrash->nData);
1.431 + pCrash->nData = nNew;
1.432 + pCrash->zData = zNew;
1.433 + }
1.434 + memcpy(&pCrash->zData[iOfst], zBuf, iAmt);
1.435 + return writeListAppend(pFile, iOfst, zBuf, iAmt);
1.436 +}
1.437 +
1.438 +/*
1.439 +** Truncate a crash-file.
1.440 +*/
1.441 +static int cfTruncate(sqlite3_file *pFile, sqlite_int64 size){
1.442 + CrashFile *pCrash = (CrashFile *)pFile;
1.443 + assert(size>=0);
1.444 + if( pCrash->iSize>size ){
1.445 + pCrash->iSize = size;
1.446 + }
1.447 + return writeListAppend(pFile, size, 0, 0);
1.448 +}
1.449 +
1.450 +/*
1.451 +** Sync a crash-file.
1.452 +*/
1.453 +static int cfSync(sqlite3_file *pFile, int flags){
1.454 + CrashFile *pCrash = (CrashFile *)pFile;
1.455 + int isCrash = 0;
1.456 +
1.457 + const char *zName = pCrash->zName;
1.458 + const char *zCrashFile = g.zCrashFile;
1.459 + int nName = strlen(zName);
1.460 + int nCrashFile = strlen(zCrashFile);
1.461 +
1.462 + if( nCrashFile>0 && zCrashFile[nCrashFile-1]=='*' ){
1.463 + nCrashFile--;
1.464 + if( nName>nCrashFile ) nName = nCrashFile;
1.465 + }
1.466 +
1.467 + if( nName==nCrashFile && 0==memcmp(zName, zCrashFile, nName) ){
1.468 + if( (--g.iCrash)==0 ) isCrash = 1;
1.469 + }
1.470 +
1.471 + return writeListSync(pCrash, isCrash);
1.472 +}
1.473 +
1.474 +/*
1.475 +** Return the current file-size of the crash-file.
1.476 +*/
1.477 +static int cfFileSize(sqlite3_file *pFile, sqlite_int64 *pSize){
1.478 + CrashFile *pCrash = (CrashFile *)pFile;
1.479 + *pSize = (i64)pCrash->iSize;
1.480 + return SQLITE_OK;
1.481 +}
1.482 +
1.483 +/*
1.484 +** Calls related to file-locks are passed on to the real file handle.
1.485 +*/
1.486 +static int cfLock(sqlite3_file *pFile, int eLock){
1.487 + return sqlite3OsLock(((CrashFile *)pFile)->pRealFile, eLock);
1.488 +}
1.489 +static int cfUnlock(sqlite3_file *pFile, int eLock){
1.490 + return sqlite3OsUnlock(((CrashFile *)pFile)->pRealFile, eLock);
1.491 +}
1.492 +static int cfCheckReservedLock(sqlite3_file *pFile, int *pResOut){
1.493 + return sqlite3OsCheckReservedLock(((CrashFile *)pFile)->pRealFile, pResOut);
1.494 +}
1.495 +static int cfFileControl(sqlite3_file *pFile, int op, void *pArg){
1.496 + return sqlite3OsFileControl(((CrashFile *)pFile)->pRealFile, op, pArg);
1.497 +}
1.498 +
1.499 +/*
1.500 +** The xSectorSize() and xDeviceCharacteristics() functions return
1.501 +** the global values configured by the [sqlite_crashparams] tcl
1.502 +* interface.
1.503 +*/
1.504 +static int cfSectorSize(sqlite3_file *pFile){
1.505 + return g.iSectorSize;
1.506 +}
1.507 +static int cfDeviceCharacteristics(sqlite3_file *pFile){
1.508 + return g.iDeviceCharacteristics;
1.509 +}
1.510 +
1.511 +static const sqlite3_io_methods CrashFileVtab = {
1.512 + 1, /* iVersion */
1.513 + cfClose, /* xClose */
1.514 + cfRead, /* xRead */
1.515 + cfWrite, /* xWrite */
1.516 + cfTruncate, /* xTruncate */
1.517 + cfSync, /* xSync */
1.518 + cfFileSize, /* xFileSize */
1.519 + cfLock, /* xLock */
1.520 + cfUnlock, /* xUnlock */
1.521 + cfCheckReservedLock, /* xCheckReservedLock */
1.522 + cfFileControl, /* xFileControl */
1.523 + cfSectorSize, /* xSectorSize */
1.524 + cfDeviceCharacteristics /* xDeviceCharacteristics */
1.525 +};
1.526 +
1.527 +/*
1.528 +** Application data for the crash VFS
1.529 +*/
1.530 +struct crashAppData {
1.531 + sqlite3_vfs *pOrig; /* Wrapped vfs structure */
1.532 +};
1.533 +
1.534 +/*
1.535 +** Open a crash-file file handle.
1.536 +**
1.537 +** The caller will have allocated pVfs->szOsFile bytes of space
1.538 +** at pFile. This file uses this space for the CrashFile structure
1.539 +** and allocates space for the "real" file structure using
1.540 +** sqlite3_malloc(). The assumption here is (pVfs->szOsFile) is
1.541 +** equal or greater than sizeof(CrashFile).
1.542 +*/
1.543 +static int cfOpen(
1.544 + sqlite3_vfs *pCfVfs,
1.545 + const char *zName,
1.546 + sqlite3_file *pFile,
1.547 + int flags,
1.548 + int *pOutFlags
1.549 +){
1.550 + sqlite3_vfs *pVfs = (sqlite3_vfs *)pCfVfs->pAppData;
1.551 + int rc;
1.552 + CrashFile *pWrapper = (CrashFile *)pFile;
1.553 + sqlite3_file *pReal = (sqlite3_file*)&pWrapper[1];
1.554 +
1.555 + memset(pWrapper, 0, sizeof(CrashFile));
1.556 + rc = sqlite3OsOpen(pVfs, zName, pReal, flags, pOutFlags);
1.557 +
1.558 + if( rc==SQLITE_OK ){
1.559 + i64 iSize;
1.560 + pWrapper->pMethod = &CrashFileVtab;
1.561 + pWrapper->zName = (char *)zName;
1.562 + pWrapper->pRealFile = pReal;
1.563 + rc = sqlite3OsFileSize(pReal, &iSize);
1.564 + pWrapper->iSize = (int)iSize;
1.565 + }
1.566 + if( rc==SQLITE_OK ){
1.567 + pWrapper->nData = (4096 + pWrapper->iSize);
1.568 + pWrapper->zData = crash_malloc(pWrapper->nData);
1.569 + if( pWrapper->zData ){
1.570 + memset(pWrapper->zData, 0, pWrapper->nData);
1.571 + rc = sqlite3OsRead(pReal, pWrapper->zData, pWrapper->iSize, 0);
1.572 + }else{
1.573 + rc = SQLITE_NOMEM;
1.574 + }
1.575 + }
1.576 + if( rc!=SQLITE_OK && pWrapper->pMethod ){
1.577 + sqlite3OsClose(pFile);
1.578 + }
1.579 + return rc;
1.580 +}
1.581 +
1.582 +static int cfDelete(sqlite3_vfs *pCfVfs, const char *zPath, int dirSync){
1.583 + sqlite3_vfs *pVfs = (sqlite3_vfs *)pCfVfs->pAppData;
1.584 + return pVfs->xDelete(pVfs, zPath, dirSync);
1.585 +}
1.586 +static int cfAccess(
1.587 + sqlite3_vfs *pCfVfs,
1.588 + const char *zPath,
1.589 + int flags,
1.590 + int *pResOut
1.591 +){
1.592 + sqlite3_vfs *pVfs = (sqlite3_vfs *)pCfVfs->pAppData;
1.593 + return pVfs->xAccess(pVfs, zPath, flags, pResOut);
1.594 +}
1.595 +static int cfFullPathname(
1.596 + sqlite3_vfs *pCfVfs,
1.597 + const char *zPath,
1.598 + int nPathOut,
1.599 + char *zPathOut
1.600 +){
1.601 + sqlite3_vfs *pVfs = (sqlite3_vfs *)pCfVfs->pAppData;
1.602 + return pVfs->xFullPathname(pVfs, zPath, nPathOut, zPathOut);
1.603 +}
1.604 +static void *cfDlOpen(sqlite3_vfs *pCfVfs, const char *zPath){
1.605 + sqlite3_vfs *pVfs = (sqlite3_vfs *)pCfVfs->pAppData;
1.606 + return pVfs->xDlOpen(pVfs, zPath);
1.607 +}
1.608 +static void cfDlError(sqlite3_vfs *pCfVfs, int nByte, char *zErrMsg){
1.609 + sqlite3_vfs *pVfs = (sqlite3_vfs *)pCfVfs->pAppData;
1.610 + pVfs->xDlError(pVfs, nByte, zErrMsg);
1.611 +}
1.612 +static void *cfDlSym(sqlite3_vfs *pCfVfs, void *pHandle, const char *zSymbol){
1.613 + sqlite3_vfs *pVfs = (sqlite3_vfs *)pCfVfs->pAppData;
1.614 + return pVfs->xDlSym(pVfs, pHandle, zSymbol);
1.615 +}
1.616 +static void cfDlClose(sqlite3_vfs *pCfVfs, void *pHandle){
1.617 + sqlite3_vfs *pVfs = (sqlite3_vfs *)pCfVfs->pAppData;
1.618 + pVfs->xDlClose(pVfs, pHandle);
1.619 +}
1.620 +static int cfRandomness(sqlite3_vfs *pCfVfs, int nByte, char *zBufOut){
1.621 + sqlite3_vfs *pVfs = (sqlite3_vfs *)pCfVfs->pAppData;
1.622 + return pVfs->xRandomness(pVfs, nByte, zBufOut);
1.623 +}
1.624 +static int cfSleep(sqlite3_vfs *pCfVfs, int nMicro){
1.625 + sqlite3_vfs *pVfs = (sqlite3_vfs *)pCfVfs->pAppData;
1.626 + return pVfs->xSleep(pVfs, nMicro);
1.627 +}
1.628 +static int cfCurrentTime(sqlite3_vfs *pCfVfs, double *pTimeOut){
1.629 + sqlite3_vfs *pVfs = (sqlite3_vfs *)pCfVfs->pAppData;
1.630 + return pVfs->xCurrentTime(pVfs, pTimeOut);
1.631 +}
1.632 +
1.633 +static int processDevSymArgs(
1.634 + Tcl_Interp *interp,
1.635 + int objc,
1.636 + Tcl_Obj *CONST objv[],
1.637 + int *piDeviceChar,
1.638 + int *piSectorSize
1.639 +){
1.640 + struct DeviceFlag {
1.641 + char *zName;
1.642 + int iValue;
1.643 + } aFlag[] = {
1.644 + { "atomic", SQLITE_IOCAP_ATOMIC },
1.645 + { "atomic512", SQLITE_IOCAP_ATOMIC512 },
1.646 + { "atomic1k", SQLITE_IOCAP_ATOMIC1K },
1.647 + { "atomic2k", SQLITE_IOCAP_ATOMIC2K },
1.648 + { "atomic4k", SQLITE_IOCAP_ATOMIC4K },
1.649 + { "atomic8k", SQLITE_IOCAP_ATOMIC8K },
1.650 + { "atomic16k", SQLITE_IOCAP_ATOMIC16K },
1.651 + { "atomic32k", SQLITE_IOCAP_ATOMIC32K },
1.652 + { "atomic64k", SQLITE_IOCAP_ATOMIC64K },
1.653 + { "sequential", SQLITE_IOCAP_SEQUENTIAL },
1.654 + { "safe_append", SQLITE_IOCAP_SAFE_APPEND },
1.655 + { 0, 0 }
1.656 + };
1.657 +
1.658 + int i;
1.659 + int iDc = 0;
1.660 + int iSectorSize = 0;
1.661 + int setSectorsize = 0;
1.662 + int setDeviceChar = 0;
1.663 +
1.664 + for(i=0; i<objc; i+=2){
1.665 + int nOpt;
1.666 + char *zOpt = Tcl_GetStringFromObj(objv[i], &nOpt);
1.667 +
1.668 + if( (nOpt>11 || nOpt<2 || strncmp("-sectorsize", zOpt, nOpt))
1.669 + && (nOpt>16 || nOpt<2 || strncmp("-characteristics", zOpt, nOpt))
1.670 + ){
1.671 + Tcl_AppendResult(interp,
1.672 + "Bad option: \"", zOpt,
1.673 + "\" - must be \"-characteristics\" or \"-sectorsize\"", 0
1.674 + );
1.675 + return TCL_ERROR;
1.676 + }
1.677 + if( i==objc-1 ){
1.678 + Tcl_AppendResult(interp, "Option requires an argument: \"", zOpt, "\"",0);
1.679 + return TCL_ERROR;
1.680 + }
1.681 +
1.682 + if( zOpt[1]=='s' ){
1.683 + if( Tcl_GetIntFromObj(interp, objv[i+1], &iSectorSize) ){
1.684 + return TCL_ERROR;
1.685 + }
1.686 + setSectorsize = 1;
1.687 + }else{
1.688 + int j;
1.689 + Tcl_Obj **apObj;
1.690 + int nObj;
1.691 + if( Tcl_ListObjGetElements(interp, objv[i+1], &nObj, &apObj) ){
1.692 + return TCL_ERROR;
1.693 + }
1.694 + for(j=0; j<nObj; j++){
1.695 + int rc;
1.696 + int iChoice;
1.697 + Tcl_Obj *pFlag = Tcl_DuplicateObj(apObj[j]);
1.698 + Tcl_IncrRefCount(pFlag);
1.699 + Tcl_UtfToLower(Tcl_GetString(pFlag));
1.700 +
1.701 + rc = Tcl_GetIndexFromObjStruct(
1.702 + interp, pFlag, aFlag, sizeof(aFlag[0]), "no such flag", 0, &iChoice
1.703 + );
1.704 + Tcl_DecrRefCount(pFlag);
1.705 + if( rc ){
1.706 + return TCL_ERROR;
1.707 + }
1.708 +
1.709 + iDc |= aFlag[iChoice].iValue;
1.710 + }
1.711 + setDeviceChar = 1;
1.712 + }
1.713 + }
1.714 +
1.715 + if( setDeviceChar ){
1.716 + *piDeviceChar = iDc;
1.717 + }
1.718 + if( setSectorsize ){
1.719 + *piSectorSize = iSectorSize;
1.720 + }
1.721 +
1.722 + return TCL_OK;
1.723 +}
1.724 +
1.725 +/*
1.726 +** tclcmd: sqlite_crash_enable ENABLE
1.727 +**
1.728 +** Parameter ENABLE must be a boolean value. If true, then the "crash"
1.729 +** vfs is added to the system. If false, it is removed.
1.730 +*/
1.731 +static int crashEnableCmd(
1.732 + void * clientData,
1.733 + Tcl_Interp *interp,
1.734 + int objc,
1.735 + Tcl_Obj *CONST objv[]
1.736 +){
1.737 + int isEnable;
1.738 + static sqlite3_vfs crashVfs = {
1.739 + 1, /* iVersion */
1.740 + 0, /* szOsFile */
1.741 + 0, /* mxPathname */
1.742 + 0, /* pNext */
1.743 + "crash", /* zName */
1.744 + 0, /* pAppData */
1.745 +
1.746 + cfOpen, /* xOpen */
1.747 + cfDelete, /* xDelete */
1.748 + cfAccess, /* xAccess */
1.749 + cfFullPathname, /* xFullPathname */
1.750 + cfDlOpen, /* xDlOpen */
1.751 + cfDlError, /* xDlError */
1.752 + cfDlSym, /* xDlSym */
1.753 + cfDlClose, /* xDlClose */
1.754 + cfRandomness, /* xRandomness */
1.755 + cfSleep, /* xSleep */
1.756 + cfCurrentTime /* xCurrentTime */
1.757 + };
1.758 +
1.759 + if( objc!=2 ){
1.760 + Tcl_WrongNumArgs(interp, 1, objv, "ENABLE");
1.761 + return TCL_ERROR;
1.762 + }
1.763 +
1.764 + if( Tcl_GetBooleanFromObj(interp, objv[1], &isEnable) ){
1.765 + return TCL_ERROR;
1.766 + }
1.767 +
1.768 + if( (isEnable && crashVfs.pAppData) || (!isEnable && !crashVfs.pAppData) ){
1.769 + return TCL_OK;
1.770 + }
1.771 +
1.772 + if( crashVfs.pAppData==0 ){
1.773 + sqlite3_vfs *pOriginalVfs = sqlite3_vfs_find(0);
1.774 + crashVfs.mxPathname = pOriginalVfs->mxPathname;
1.775 + crashVfs.pAppData = (void *)pOriginalVfs;
1.776 + crashVfs.szOsFile = sizeof(CrashFile) + pOriginalVfs->szOsFile;
1.777 + sqlite3_vfs_register(&crashVfs, 0);
1.778 + }else{
1.779 + crashVfs.pAppData = 0;
1.780 + sqlite3_vfs_unregister(&crashVfs);
1.781 + }
1.782 +
1.783 + return TCL_OK;
1.784 +}
1.785 +
1.786 +/*
1.787 +** tclcmd: sqlite_crashparams ?OPTIONS? DELAY CRASHFILE
1.788 +**
1.789 +** This procedure implements a TCL command that enables crash testing
1.790 +** in testfixture. Once enabled, crash testing cannot be disabled.
1.791 +**
1.792 +** Available options are "-characteristics" and "-sectorsize". Both require
1.793 +** an argument. For -sectorsize, this is the simulated sector size in
1.794 +** bytes. For -characteristics, the argument must be a list of io-capability
1.795 +** flags to simulate. Valid flags are "atomic", "atomic512", "atomic1K",
1.796 +** "atomic2K", "atomic4K", "atomic8K", "atomic16K", "atomic32K",
1.797 +** "atomic64K", "sequential" and "safe_append".
1.798 +**
1.799 +** Example:
1.800 +**
1.801 +** sqlite_crashparams -sect 1024 -char {atomic sequential} ./test.db 1
1.802 +**
1.803 +*/
1.804 +static int crashParamsObjCmd(
1.805 + void * clientData,
1.806 + Tcl_Interp *interp,
1.807 + int objc,
1.808 + Tcl_Obj *CONST objv[]
1.809 +){
1.810 + int iDelay;
1.811 + const char *zCrashFile;
1.812 + int nCrashFile, iDc, iSectorSize;
1.813 +
1.814 + iDc = -1;
1.815 + iSectorSize = -1;
1.816 +
1.817 + if( objc<3 ){
1.818 + Tcl_WrongNumArgs(interp, 1, objv, "?OPTIONS? DELAY CRASHFILE");
1.819 + goto error;
1.820 + }
1.821 +
1.822 + zCrashFile = Tcl_GetStringFromObj(objv[objc-1], &nCrashFile);
1.823 + if( nCrashFile>=sizeof(g.zCrashFile) ){
1.824 + Tcl_AppendResult(interp, "Filename is too long: \"", zCrashFile, "\"", 0);
1.825 + goto error;
1.826 + }
1.827 + if( Tcl_GetIntFromObj(interp, objv[objc-2], &iDelay) ){
1.828 + goto error;
1.829 + }
1.830 +
1.831 + if( processDevSymArgs(interp, objc-3, &objv[1], &iDc, &iSectorSize) ){
1.832 + return TCL_ERROR;
1.833 + }
1.834 +
1.835 + if( iDc>=0 ){
1.836 + g.iDeviceCharacteristics = iDc;
1.837 + }
1.838 + if( iSectorSize>=0 ){
1.839 + g.iSectorSize = iSectorSize;
1.840 + }
1.841 +
1.842 + g.iCrash = iDelay;
1.843 + memcpy(g.zCrashFile, zCrashFile, nCrashFile+1);
1.844 + sqlite3CrashTestEnable = 1;
1.845 + return TCL_OK;
1.846 +
1.847 +error:
1.848 + return TCL_ERROR;
1.849 +}
1.850 +
1.851 +static int devSymObjCmd(
1.852 + void * clientData,
1.853 + Tcl_Interp *interp,
1.854 + int objc,
1.855 + Tcl_Obj *CONST objv[]
1.856 +){
1.857 + void devsym_register(int iDeviceChar, int iSectorSize);
1.858 +
1.859 + int iDc = -1;
1.860 + int iSectorSize = -1;
1.861 +
1.862 + if( processDevSymArgs(interp, objc-1, &objv[1], &iDc, &iSectorSize) ){
1.863 + return TCL_ERROR;
1.864 + }
1.865 + devsym_register(iDc, iSectorSize);
1.866 +
1.867 + return TCL_OK;
1.868 +}
1.869 +
1.870 +#endif /* SQLITE_OMIT_DISKIO */
1.871 +
1.872 +/*
1.873 +** This procedure registers the TCL procedures defined in this file.
1.874 +*/
1.875 +int Sqlitetest6_Init(Tcl_Interp *interp){
1.876 +#ifndef SQLITE_OMIT_DISKIO
1.877 + Tcl_CreateObjCommand(interp, "sqlite3_crash_enable", crashEnableCmd, 0, 0);
1.878 + Tcl_CreateObjCommand(interp, "sqlite3_crashparams", crashParamsObjCmd, 0, 0);
1.879 + Tcl_CreateObjCommand(interp, "sqlite3_simulate_device", devSymObjCmd, 0, 0);
1.880 +#endif
1.881 + return TCL_OK;
1.882 +}
1.883 +
1.884 +#endif /* SQLITE_TEST */