4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
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.
11 ******************************************************************************
13 ** This file contains code that modified the OS layer in order to simulate
14 ** the effect on the database file of an OS crash or power failure. This
15 ** is used to test the ability of SQLite to recover from those situations.
17 #if SQLITE_TEST /* This file is used for testing only */
18 #include "sqliteInt.h"
19 #if defined(INCLUDE_SQLITE_TCL_H)
20 # include "sqlite_tcl.h"
25 #ifndef SQLITE_OMIT_DISKIO /* This file is a no-op if disk I/O is disabled */
27 /* #define TRACE_CRASHTEST */
29 typedef struct CrashFile CrashFile
;
30 typedef struct CrashGlobal CrashGlobal
;
31 typedef struct WriteBuffer WriteBuffer
;
36 ** This layer is implemented as a wrapper around the "real"
37 ** sqlite3_file object for the host system. Each time data is
38 ** written to the file object, instead of being written to the
39 ** underlying file, the write operation is stored in an in-memory
40 ** structure (type WriteBuffer). This structure is placed at the
41 ** end of a global ordered list (the write-list).
43 ** When data is read from a file object, the requested region is
44 ** first retrieved from the real file. The write-list is then
45 ** traversed and data copied from any overlapping WriteBuffer
46 ** structures to the output buffer. i.e. a read() operation following
47 ** one or more write() operations works as expected, even if no
48 ** data has actually been written out to the real file.
50 ** When a fsync() operation is performed, an operating system crash
51 ** may be simulated, in which case exit(-1) is called (the call to
52 ** xSync() never returns). Whether or not a crash is simulated,
53 ** the data associated with a subset of the WriteBuffer structures
54 ** stored in the write-list is written to the real underlying files
55 ** and the entries removed from the write-list. If a crash is simulated,
56 ** a subset of the buffers may be corrupted before the data is written.
58 ** The exact subset of the write-list written and/or corrupted is
59 ** determined by the simulated device characteristics and sector-size.
63 ** Normal mode is used when the simulated device has none of the
64 ** SQLITE_IOCAP_XXX flags set.
66 ** In normal mode, if the fsync() is not a simulated crash, the
67 ** write-list is traversed from beginning to end. Each WriteBuffer
68 ** structure associated with the file handle used to call xSync()
69 ** is written to the real file and removed from the write-list.
71 ** If a crash is simulated, one of the following takes place for
72 ** each WriteBuffer in the write-list, regardless of which
73 ** file-handle it is associated with:
75 ** 1. The buffer is correctly written to the file, just as if
76 ** a crash were not being simulated.
78 ** 2. Nothing is done.
80 ** 3. Garbage data is written to all sectors of the file that
81 ** overlap the region specified by the WriteBuffer. Or garbage
82 ** data is written to some contiguous section within the
83 ** overlapped sectors.
85 ** Device Characteristic flag handling:
87 ** If the IOCAP_ATOMIC flag is set, then option (3) above is
90 ** If the IOCAP_ATOMIC512 flag is set, and the WriteBuffer represents
91 ** an aligned write() of an integer number of 512 byte regions, then
92 ** option (3) above is never selected. Instead, each 512 byte region
93 ** is either correctly written or left completely untouched. Similar
94 ** logic governs the behavior if any of the other ATOMICXXX flags
97 ** If either the IOCAP_SAFEAPPEND or IOCAP_SEQUENTIAL flags are set
98 ** and a crash is being simulated, then an entry of the write-list is
99 ** selected at random. Everything in the list after the selected entry
100 ** is discarded before processing begins.
102 ** If IOCAP_SEQUENTIAL is set and a crash is being simulated, option
103 ** (1) is selected for all write-list entries except the last. If a
104 ** crash is not being simulated, then all entries in the write-list
105 ** that occur before at least one write() on the file-handle specified
106 ** as part of the xSync() are written to their associated real files.
108 ** If IOCAP_SAFEAPPEND is set and the first byte written by the write()
109 ** operation is one byte past the current end of the file, then option
110 ** (1) is always selected.
114 ** Each write operation in the write-list is represented by an instance
115 ** of the following structure.
117 ** If zBuf is 0, then this structure represents a call to xTruncate(),
118 ** not xWrite(). In that case, iOffset is the size that the file is
122 i64 iOffset
; /* Byte offset of the start of this write() */
123 int nBuf
; /* Number of bytes written */
124 u8
*zBuf
; /* Pointer to copy of written data */
125 CrashFile
*pFile
; /* File this write() applies to */
127 WriteBuffer
*pNext
; /* Next in CrashGlobal.pWriteList */
131 const sqlite3_io_methods
*pMethod
; /* Must be first */
132 sqlite3_file
*pRealFile
; /* Underlying "real" file handle */
134 int flags
; /* Flags the file was opened with */
136 /* Cache of the entire file. This is used to speed up OsRead() and
137 ** OsFileSize() calls. Although both could be done by traversing the
138 ** write-list, in practice this is impractically slow.
140 u8
*zData
; /* Buffer containing file contents */
141 int nData
; /* Size of buffer allocated at zData */
142 i64 iSize
; /* Size of file in bytes */
146 WriteBuffer
*pWriteList
; /* Head of write-list */
147 WriteBuffer
*pWriteListEnd
; /* End of write-list */
149 int iSectorSize
; /* Value of simulated sector size */
150 int iDeviceCharacteristics
; /* Value of simulated device characteristics */
152 int iCrash
; /* Crash on the iCrash'th call to xSync() */
153 char zCrashFile
[500]; /* Crash during an xSync() on this file */
156 static CrashGlobal g
= {0, 0, SQLITE_DEFAULT_SECTOR_SIZE
, 0, 0};
159 ** Set this global variable to 1 to enable crash testing.
161 static int sqlite3CrashTestEnable
= 0;
163 static void *crash_malloc(int nByte
){
164 return (void *)Tcl_AttemptAlloc((size_t)nByte
);
166 static void crash_free(void *p
){
169 static void *crash_realloc(void *p
, int n
){
170 return (void *)Tcl_AttemptRealloc(p
, (size_t)n
);
174 ** Wrapper around the sqlite3OsWrite() function that avoids writing to the
175 ** 512 byte block begining at offset PENDING_BYTE.
177 static int writeDbFile(CrashFile
*p
, u8
*z
, i64 iAmt
, i64 iOff
){
180 if( (iAmt
-iSkip
)>0 ){
181 rc
= sqlite3OsWrite(p
->pRealFile
, &z
[iSkip
], (int)(iAmt
-iSkip
), iOff
+iSkip
);
187 ** Flush the write-list as if xSync() had been called on file handle
188 ** pFile. If isCrash is true, simulate a crash.
190 static int writeListSync(CrashFile
*pFile
, int isCrash
){
192 int iDc
= g
.iDeviceCharacteristics
;
197 /* If this is not a crash simulation, set pFinal to point to the
198 ** last element of the write-list that is associated with file handle
201 ** If this is a crash simulation, set pFinal to an arbitrarily selected
202 ** element of the write-list.
204 WriteBuffer
*pFinal
= 0;
206 for(pWrite
=g
.pWriteList
; pWrite
; pWrite
=pWrite
->pNext
){
207 if( pWrite
->pFile
==pFile
){
211 }else if( iDc
&(SQLITE_IOCAP_SEQUENTIAL
|SQLITE_IOCAP_SAFE_APPEND
) ){
214 for(pWrite
=g
.pWriteList
; pWrite
; pWrite
=pWrite
->pNext
) nWrite
++;
215 sqlite3_randomness(sizeof(int), &iFinal
);
216 iFinal
= ((iFinal
<0)?-1*iFinal
:iFinal
)%nWrite
;
217 for(pWrite
=g
.pWriteList
; iFinal
>0; pWrite
=pWrite
->pNext
) iFinal
--;
221 #ifdef TRACE_CRASHTEST
223 printf("Sync %s (is %s crash)\n", pFile
->zName
, (isCrash
?"a":"not a"));
227 ppPtr
= &g
.pWriteList
;
228 for(pWrite
=*ppPtr
; rc
==SQLITE_OK
&& pWrite
; pWrite
=*ppPtr
){
229 sqlite3_file
*pRealFile
= pWrite
->pFile
->pRealFile
;
231 /* (eAction==1) -> write block out normally,
232 ** (eAction==2) -> do nothing,
233 ** (eAction==3) -> trash sectors.
238 if( (pWrite
->pFile
==pFile
|| iDc
&SQLITE_IOCAP_SEQUENTIAL
) ){
243 sqlite3_randomness(1, &random
);
245 /* Do not select option 3 (sector trashing) if the IOCAP_ATOMIC flag
246 ** is set or this is an OsTruncate(), not an Oswrite().
248 if( (iDc
&SQLITE_IOCAP_ATOMIC
) || (pWrite
->zBuf
==0) ){
252 /* If IOCAP_SEQUENTIAL is set and this is not the final entry
253 ** in the truncated write-list, always select option 1 (write
256 if( (iDc
&SQLITE_IOCAP_SEQUENTIAL
&& pWrite
!=pFinal
) ){
260 /* If IOCAP_SAFE_APPEND is set and this OsWrite() operation is
261 ** an append (first byte of the written region is 1 byte past the
262 ** current EOF), always select option 1 (write out correctly).
264 if( iDc
&SQLITE_IOCAP_SAFE_APPEND
&& pWrite
->zBuf
){
266 sqlite3OsFileSize(pRealFile
, &iSize
);
267 if( iSize
==pWrite
->iOffset
){
272 if( (random
&0x06)==0x06 ){
275 eAction
= ((random
&0x01)?2:1);
280 case 1: { /* Write out correctly */
283 pWrite
->pFile
, pWrite
->zBuf
, pWrite
->nBuf
, pWrite
->iOffset
286 rc
= sqlite3OsTruncate(pRealFile
, pWrite
->iOffset
);
288 *ppPtr
= pWrite
->pNext
;
289 #ifdef TRACE_CRASHTEST
291 printf("Writing %d bytes @ %d (%s)\n",
292 pWrite
->nBuf
, (int)pWrite
->iOffset
, pWrite
->pFile
->zName
299 case 2: { /* Do nothing */
300 ppPtr
= &pWrite
->pNext
;
301 #ifdef TRACE_CRASHTEST
303 printf("Omiting %d bytes @ %d (%s)\n",
304 pWrite
->nBuf
, (int)pWrite
->iOffset
, pWrite
->pFile
->zName
310 case 3: { /* Trash sectors */
312 int iFirst
= (int)(pWrite
->iOffset
/g
.iSectorSize
);
313 int iLast
= (int)((pWrite
->iOffset
+pWrite
->nBuf
-1)/g
.iSectorSize
);
315 assert(pWrite
->zBuf
);
317 #ifdef TRACE_CRASHTEST
318 printf("Trashing %d sectors (%d bytes) @ %lld (sector %d) (%s)\n",
319 1+iLast
-iFirst
, (1+iLast
-iFirst
)*g
.iSectorSize
,
320 pWrite
->iOffset
, iFirst
, pWrite
->pFile
->zName
324 zGarbage
= crash_malloc(g
.iSectorSize
);
327 for(i
=iFirst
; rc
==SQLITE_OK
&& i
<=iLast
; i
++){
328 sqlite3_randomness(g
.iSectorSize
, zGarbage
);
330 pWrite
->pFile
, zGarbage
, g
.iSectorSize
, i
*g
.iSectorSize
333 crash_free(zGarbage
);
338 ppPtr
= &pWrite
->pNext
;
343 assert(!"Cannot happen");
346 if( pWrite
==pFinal
) break;
349 if( rc
==SQLITE_OK
&& isCrash
){
353 for(pWrite
=g
.pWriteList
; pWrite
&& pWrite
->pNext
; pWrite
=pWrite
->pNext
);
354 g
.pWriteListEnd
= pWrite
;
360 ** Add an entry to the end of the write-list.
362 static int writeListAppend(
364 sqlite3_int64 iOffset
,
370 assert((zBuf
&& nBuf
) || (!nBuf
&& !zBuf
));
372 pNew
= (WriteBuffer
*)crash_malloc(sizeof(WriteBuffer
) + nBuf
);
374 fprintf(stderr
, "out of memory in the crash simulator\n");
376 memset(pNew
, 0, sizeof(WriteBuffer
)+nBuf
);
377 pNew
->iOffset
= iOffset
;
379 pNew
->pFile
= (CrashFile
*)pFile
;
381 pNew
->zBuf
= (u8
*)&pNew
[1];
382 memcpy(pNew
->zBuf
, zBuf
, nBuf
);
386 assert(g
.pWriteListEnd
);
387 g
.pWriteListEnd
->pNext
= pNew
;
391 g
.pWriteListEnd
= pNew
;
397 ** Close a crash-file.
399 static int cfClose(sqlite3_file
*pFile
){
400 CrashFile
*pCrash
= (CrashFile
*)pFile
;
401 writeListSync(pCrash
, 0);
402 sqlite3OsClose(pCrash
->pRealFile
);
407 ** Read data from a crash-file.
415 CrashFile
*pCrash
= (CrashFile
*)pFile
;
416 int nCopy
= (int)MIN((i64
)iAmt
, (pCrash
->iSize
- iOfst
));
419 memcpy(zBuf
, &pCrash
->zData
[iOfst
], nCopy
);
422 /* Check the file-size to see if this is a short-read */
424 return SQLITE_IOERR_SHORT_READ
;
431 ** Write data to a crash-file.
439 CrashFile
*pCrash
= (CrashFile
*)pFile
;
440 if( iAmt
+iOfst
>pCrash
->iSize
){
441 pCrash
->iSize
= (int)(iAmt
+iOfst
);
443 while( pCrash
->iSize
>pCrash
->nData
){
445 int nNew
= (pCrash
->nData
*2) + 4096;
446 zNew
= crash_realloc(pCrash
->zData
, nNew
);
450 memset(&zNew
[pCrash
->nData
], 0, nNew
-pCrash
->nData
);
451 pCrash
->nData
= nNew
;
452 pCrash
->zData
= zNew
;
454 memcpy(&pCrash
->zData
[iOfst
], zBuf
, iAmt
);
455 return writeListAppend(pFile
, iOfst
, zBuf
, iAmt
);
459 ** Truncate a crash-file.
461 static int cfTruncate(sqlite3_file
*pFile
, sqlite_int64 size
){
462 CrashFile
*pCrash
= (CrashFile
*)pFile
;
464 if( pCrash
->iSize
>size
){
465 pCrash
->iSize
= (int)size
;
467 return writeListAppend(pFile
, size
, 0, 0);
471 ** Sync a crash-file.
473 static int cfSync(sqlite3_file
*pFile
, int flags
){
474 CrashFile
*pCrash
= (CrashFile
*)pFile
;
477 const char *zName
= pCrash
->zName
;
478 const char *zCrashFile
= g
.zCrashFile
;
479 int nName
= (int)strlen(zName
);
480 int nCrashFile
= (int)strlen(zCrashFile
);
482 if( nCrashFile
>0 && zCrashFile
[nCrashFile
-1]=='*' ){
484 if( nName
>nCrashFile
) nName
= nCrashFile
;
487 #ifdef TRACE_CRASHTEST
488 printf("cfSync(): nName = %d, nCrashFile = %d, zName = %s, zCrashFile = %s\n",
489 nName
, nCrashFile
, zName
, zCrashFile
);
492 if( nName
==nCrashFile
&& 0==memcmp(zName
, zCrashFile
, nName
) ){
493 #ifdef TRACE_CRASHTEST
494 printf("cfSync(): name matched, g.iCrash = %d\n", g
.iCrash
);
496 if( (--g
.iCrash
)==0 ) isCrash
= 1;
499 return writeListSync(pCrash
, isCrash
);
503 ** Return the current file-size of the crash-file.
505 static int cfFileSize(sqlite3_file
*pFile
, sqlite_int64
*pSize
){
506 CrashFile
*pCrash
= (CrashFile
*)pFile
;
507 *pSize
= (i64
)pCrash
->iSize
;
512 ** Calls related to file-locks are passed on to the real file handle.
514 static int cfLock(sqlite3_file
*pFile
, int eLock
){
515 return sqlite3OsLock(((CrashFile
*)pFile
)->pRealFile
, eLock
);
517 static int cfUnlock(sqlite3_file
*pFile
, int eLock
){
518 return sqlite3OsUnlock(((CrashFile
*)pFile
)->pRealFile
, eLock
);
520 static int cfCheckReservedLock(sqlite3_file
*pFile
, int *pResOut
){
521 return sqlite3OsCheckReservedLock(((CrashFile
*)pFile
)->pRealFile
, pResOut
);
523 static int cfFileControl(sqlite3_file
*pFile
, int op
, void *pArg
){
524 if( op
==SQLITE_FCNTL_SIZE_HINT
){
525 CrashFile
*pCrash
= (CrashFile
*)pFile
;
526 i64 nByte
= *(i64
*)pArg
;
527 if( nByte
>pCrash
->iSize
){
528 if( SQLITE_OK
==writeListAppend(pFile
, nByte
, 0, 0) ){
529 pCrash
->iSize
= (int)nByte
;
534 return sqlite3OsFileControl(((CrashFile
*)pFile
)->pRealFile
, op
, pArg
);
538 ** The xSectorSize() and xDeviceCharacteristics() functions return
539 ** the global values configured by the [sqlite_crashparams] tcl
542 static int cfSectorSize(sqlite3_file
*pFile
){
543 return g
.iSectorSize
;
545 static int cfDeviceCharacteristics(sqlite3_file
*pFile
){
546 return g
.iDeviceCharacteristics
;
550 ** Pass-throughs for WAL support.
552 static int cfShmLock(sqlite3_file
*pFile
, int ofst
, int n
, int flags
){
553 return sqlite3OsShmLock(((CrashFile
*)pFile
)->pRealFile
, ofst
, n
, flags
);
555 static void cfShmBarrier(sqlite3_file
*pFile
){
556 sqlite3OsShmBarrier(((CrashFile
*)pFile
)->pRealFile
);
558 static int cfShmUnmap(sqlite3_file
*pFile
, int delFlag
){
559 return sqlite3OsShmUnmap(((CrashFile
*)pFile
)->pRealFile
, delFlag
);
562 sqlite3_file
*pFile
, /* Handle open on database file */
563 int iRegion
, /* Region to retrieve */
564 int sz
, /* Size of regions */
565 int w
, /* True to extend file if necessary */
566 void volatile **pp
/* OUT: Mapped memory */
568 return sqlite3OsShmMap(((CrashFile
*)pFile
)->pRealFile
, iRegion
, sz
, w
, pp
);
571 static const sqlite3_io_methods CrashFileVtab
= {
573 cfClose
, /* xClose */
575 cfWrite
, /* xWrite */
576 cfTruncate
, /* xTruncate */
578 cfFileSize
, /* xFileSize */
580 cfUnlock
, /* xUnlock */
581 cfCheckReservedLock
, /* xCheckReservedLock */
582 cfFileControl
, /* xFileControl */
583 cfSectorSize
, /* xSectorSize */
584 cfDeviceCharacteristics
, /* xDeviceCharacteristics */
585 cfShmMap
, /* xShmMap */
586 cfShmLock
, /* xShmLock */
587 cfShmBarrier
, /* xShmBarrier */
588 cfShmUnmap
/* xShmUnmap */
592 ** Application data for the crash VFS
594 struct crashAppData
{
595 sqlite3_vfs
*pOrig
; /* Wrapped vfs structure */
599 ** Open a crash-file file handle.
601 ** The caller will have allocated pVfs->szOsFile bytes of space
602 ** at pFile. This file uses this space for the CrashFile structure
603 ** and allocates space for the "real" file structure using
604 ** sqlite3_malloc(). The assumption here is (pVfs->szOsFile) is
605 ** equal or greater than sizeof(CrashFile).
614 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
616 CrashFile
*pWrapper
= (CrashFile
*)pFile
;
617 sqlite3_file
*pReal
= (sqlite3_file
*)&pWrapper
[1];
619 memset(pWrapper
, 0, sizeof(CrashFile
));
620 rc
= sqlite3OsOpen(pVfs
, zName
, pReal
, flags
, pOutFlags
);
624 pWrapper
->pMethod
= &CrashFileVtab
;
625 pWrapper
->zName
= (char *)zName
;
626 pWrapper
->pRealFile
= pReal
;
627 rc
= sqlite3OsFileSize(pReal
, &iSize
);
628 pWrapper
->iSize
= (int)iSize
;
629 pWrapper
->flags
= flags
;
632 pWrapper
->nData
= (int)(4096 + pWrapper
->iSize
);
633 pWrapper
->zData
= crash_malloc(pWrapper
->nData
);
634 if( pWrapper
->zData
){
635 /* os_unix.c contains an assert() that fails if the caller attempts
636 ** to read data from the 512-byte locking region of a file opened
637 ** with the SQLITE_OPEN_MAIN_DB flag. This region of a database file
638 ** never contains valid data anyhow. So avoid doing such a read here.
640 ** UPDATE: It also contains an assert() verifying that each call
641 ** to the xRead() method reads less than 128KB of data.
645 memset(pWrapper
->zData
, 0, pWrapper
->nData
);
646 for(iOff
=0; iOff
<pWrapper
->iSize
; iOff
+= 512){
647 int nRead
= (int)(pWrapper
->iSize
- iOff
);
648 if( nRead
>512 ) nRead
= 512;
649 rc
= sqlite3OsRead(pReal
, &pWrapper
->zData
[iOff
], nRead
, iOff
);
655 if( rc
!=SQLITE_OK
&& pWrapper
->pMethod
){
656 sqlite3OsClose(pFile
);
661 static int cfDelete(sqlite3_vfs
*pCfVfs
, const char *zPath
, int dirSync
){
662 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
663 return pVfs
->xDelete(pVfs
, zPath
, dirSync
);
671 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
672 return pVfs
->xAccess(pVfs
, zPath
, flags
, pResOut
);
674 static int cfFullPathname(
680 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
681 return pVfs
->xFullPathname(pVfs
, zPath
, nPathOut
, zPathOut
);
683 static void *cfDlOpen(sqlite3_vfs
*pCfVfs
, const char *zPath
){
684 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
685 return pVfs
->xDlOpen(pVfs
, zPath
);
687 static void cfDlError(sqlite3_vfs
*pCfVfs
, int nByte
, char *zErrMsg
){
688 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
689 pVfs
->xDlError(pVfs
, nByte
, zErrMsg
);
691 static void (*cfDlSym(sqlite3_vfs
*pCfVfs
, void *pH
, const char *zSym
))(void){
692 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
693 return pVfs
->xDlSym(pVfs
, pH
, zSym
);
695 static void cfDlClose(sqlite3_vfs
*pCfVfs
, void *pHandle
){
696 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
697 pVfs
->xDlClose(pVfs
, pHandle
);
699 static int cfRandomness(sqlite3_vfs
*pCfVfs
, int nByte
, char *zBufOut
){
700 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
701 return pVfs
->xRandomness(pVfs
, nByte
, zBufOut
);
703 static int cfSleep(sqlite3_vfs
*pCfVfs
, int nMicro
){
704 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
705 return pVfs
->xSleep(pVfs
, nMicro
);
707 static int cfCurrentTime(sqlite3_vfs
*pCfVfs
, double *pTimeOut
){
708 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
709 return pVfs
->xCurrentTime(pVfs
, pTimeOut
);
711 static int cfGetLastError(sqlite3_vfs
*pCfVfs
, int n
, char *z
){
712 sqlite3_vfs
*pVfs
= (sqlite3_vfs
*)pCfVfs
->pAppData
;
713 return pVfs
->xGetLastError(pVfs
, n
, z
);
716 static int processDevSymArgs(
719 Tcl_Obj
*CONST objv
[],
727 { "atomic", SQLITE_IOCAP_ATOMIC
},
728 { "atomic512", SQLITE_IOCAP_ATOMIC512
},
729 { "atomic1k", SQLITE_IOCAP_ATOMIC1K
},
730 { "atomic2k", SQLITE_IOCAP_ATOMIC2K
},
731 { "atomic4k", SQLITE_IOCAP_ATOMIC4K
},
732 { "atomic8k", SQLITE_IOCAP_ATOMIC8K
},
733 { "atomic16k", SQLITE_IOCAP_ATOMIC16K
},
734 { "atomic32k", SQLITE_IOCAP_ATOMIC32K
},
735 { "atomic64k", SQLITE_IOCAP_ATOMIC64K
},
736 { "sequential", SQLITE_IOCAP_SEQUENTIAL
},
737 { "safe_append", SQLITE_IOCAP_SAFE_APPEND
},
738 { "powersafe_overwrite", SQLITE_IOCAP_POWERSAFE_OVERWRITE
},
745 int setSectorsize
= 0;
746 int setDeviceChar
= 0;
748 for(i
=0; i
<objc
; i
+=2){
750 char *zOpt
= Tcl_GetStringFromObj(objv
[i
], &nOpt
);
752 if( (nOpt
>11 || nOpt
<2 || strncmp("-sectorsize", zOpt
, nOpt
))
753 && (nOpt
>16 || nOpt
<2 || strncmp("-characteristics", zOpt
, nOpt
))
755 Tcl_AppendResult(interp
,
756 "Bad option: \"", zOpt
,
757 "\" - must be \"-characteristics\" or \"-sectorsize\"", 0
762 Tcl_AppendResult(interp
, "Option requires an argument: \"", zOpt
, "\"",0);
767 if( Tcl_GetIntFromObj(interp
, objv
[i
+1], &iSectorSize
) ){
775 if( Tcl_ListObjGetElements(interp
, objv
[i
+1], &nObj
, &apObj
) ){
778 for(j
=0; j
<nObj
; j
++){
781 Tcl_Obj
*pFlag
= Tcl_DuplicateObj(apObj
[j
]);
782 Tcl_IncrRefCount(pFlag
);
783 Tcl_UtfToLower(Tcl_GetString(pFlag
));
785 rc
= Tcl_GetIndexFromObjStruct(
786 interp
, pFlag
, aFlag
, sizeof(aFlag
[0]), "no such flag", 0, &iChoice
788 Tcl_DecrRefCount(pFlag
);
793 iDc
|= aFlag
[iChoice
].iValue
;
803 *piSectorSize
= iSectorSize
;
810 ** tclcmd: sqlite3_crash_now
812 ** Simulate a crash immediately. This function does not return
813 ** (writeListSync() calls exit(-1)).
815 static int SQLITE_TCLAPI
crashNowCmd(
819 Tcl_Obj
*CONST objv
[]
822 Tcl_WrongNumArgs(interp
, 1, objv
, "");
831 ** tclcmd: sqlite_crash_enable ENABLE ?DEFAULT?
833 ** Parameter ENABLE must be a boolean value. If true, then the "crash"
834 ** vfs is added to the system. If false, it is removed.
836 static int SQLITE_TCLAPI
crashEnableCmd(
840 Tcl_Obj
*CONST objv
[]
844 static sqlite3_vfs crashVfs
= {
853 cfDelete
, /* xDelete */
854 cfAccess
, /* xAccess */
855 cfFullPathname
, /* xFullPathname */
856 cfDlOpen
, /* xDlOpen */
857 cfDlError
, /* xDlError */
858 cfDlSym
, /* xDlSym */
859 cfDlClose
, /* xDlClose */
860 cfRandomness
, /* xRandomness */
861 cfSleep
, /* xSleep */
862 cfCurrentTime
, /* xCurrentTime */
863 cfGetLastError
, /* xGetLastError */
864 0, /* xCurrentTimeInt64 */
867 if( objc
!=2 && objc
!=3 ){
868 Tcl_WrongNumArgs(interp
, 1, objv
, "ENABLE ?DEFAULT?");
872 if( Tcl_GetBooleanFromObj(interp
, objv
[1], &isEnable
) ){
875 if( objc
==3 && Tcl_GetBooleanFromObj(interp
, objv
[2], &isDefault
) ){
879 if( (isEnable
&& crashVfs
.pAppData
) || (!isEnable
&& !crashVfs
.pAppData
) ){
883 if( crashVfs
.pAppData
==0 ){
884 sqlite3_vfs
*pOriginalVfs
= sqlite3_vfs_find(0);
885 crashVfs
.mxPathname
= pOriginalVfs
->mxPathname
;
886 crashVfs
.pAppData
= (void *)pOriginalVfs
;
887 crashVfs
.szOsFile
= sizeof(CrashFile
) + pOriginalVfs
->szOsFile
;
888 sqlite3_vfs_register(&crashVfs
, isDefault
);
890 crashVfs
.pAppData
= 0;
891 sqlite3_vfs_unregister(&crashVfs
);
898 ** tclcmd: sqlite_crashparams ?OPTIONS? DELAY CRASHFILE
900 ** This procedure implements a TCL command that enables crash testing
901 ** in testfixture. Once enabled, crash testing cannot be disabled.
903 ** Available options are "-characteristics" and "-sectorsize". Both require
904 ** an argument. For -sectorsize, this is the simulated sector size in
905 ** bytes. For -characteristics, the argument must be a list of io-capability
906 ** flags to simulate. Valid flags are "atomic", "atomic512", "atomic1K",
907 ** "atomic2K", "atomic4K", "atomic8K", "atomic16K", "atomic32K",
908 ** "atomic64K", "sequential" and "safe_append".
912 ** sqlite_crashparams -sect 1024 -char {atomic sequential} ./test.db 1
915 static int SQLITE_TCLAPI
crashParamsObjCmd(
919 Tcl_Obj
*CONST objv
[]
922 const char *zCrashFile
;
923 int nCrashFile
, iDc
, iSectorSize
;
929 Tcl_WrongNumArgs(interp
, 1, objv
, "?OPTIONS? DELAY CRASHFILE");
933 zCrashFile
= Tcl_GetStringFromObj(objv
[objc
-1], &nCrashFile
);
934 if( nCrashFile
>=sizeof(g
.zCrashFile
) ){
935 Tcl_AppendResult(interp
, "Filename is too long: \"", zCrashFile
, "\"", 0);
938 if( Tcl_GetIntFromObj(interp
, objv
[objc
-2], &iDelay
) ){
942 if( processDevSymArgs(interp
, objc
-3, &objv
[1], &iDc
, &iSectorSize
) ){
947 g
.iDeviceCharacteristics
= iDc
;
949 if( iSectorSize
>=0 ){
950 g
.iSectorSize
= iSectorSize
;
954 memcpy(g
.zCrashFile
, zCrashFile
, nCrashFile
+1);
955 sqlite3CrashTestEnable
= 1;
962 static int SQLITE_TCLAPI
devSymObjCmd(
966 Tcl_Obj
*CONST objv
[]
968 void devsym_register(int iDeviceChar
, int iSectorSize
);
971 int iSectorSize
= -1;
973 if( processDevSymArgs(interp
, objc
-1, &objv
[1], &iDc
, &iSectorSize
) ){
976 devsym_register(iDc
, iSectorSize
);
983 ** tclcmd: unregister_devsim
985 static int SQLITE_TCLAPI
dsUnregisterObjCmd(
989 Tcl_Obj
*CONST objv
[]
991 void devsym_unregister(void);
994 Tcl_WrongNumArgs(interp
, 1, objv
, "");
1003 ** tclcmd: register_jt_vfs ?-default? PARENT-VFS
1005 static int SQLITE_TCLAPI
jtObjCmd(
1009 Tcl_Obj
*CONST objv
[]
1011 int jt_register(char *, int);
1014 if( objc
!=2 && objc
!=3 ){
1015 Tcl_WrongNumArgs(interp
, 1, objv
, "?-default? PARENT-VFS");
1018 zParent
= Tcl_GetString(objv
[1]);
1020 if( strcmp(zParent
, "-default") ){
1021 Tcl_AppendResult(interp
,
1022 "bad option \"", zParent
, "\": must be -default", 0
1026 zParent
= Tcl_GetString(objv
[2]);
1032 if( jt_register(zParent
, objc
==3) ){
1033 Tcl_AppendResult(interp
, "Error in jt_register", 0);
1041 ** tclcmd: unregister_jt_vfs
1043 static int SQLITE_TCLAPI
jtUnregisterObjCmd(
1047 Tcl_Obj
*CONST objv
[]
1049 void jt_unregister(void);
1052 Tcl_WrongNumArgs(interp
, 1, objv
, "");
1060 #endif /* SQLITE_OMIT_DISKIO */
1063 ** This procedure registers the TCL procedures defined in this file.
1065 int Sqlitetest6_Init(Tcl_Interp
*interp
){
1066 #ifndef SQLITE_OMIT_DISKIO
1067 Tcl_CreateObjCommand(interp
, "sqlite3_crash_enable", crashEnableCmd
, 0, 0);
1068 Tcl_CreateObjCommand(interp
, "sqlite3_crashparams", crashParamsObjCmd
, 0, 0);
1069 Tcl_CreateObjCommand(interp
, "sqlite3_crash_now", crashNowCmd
, 0, 0);
1070 Tcl_CreateObjCommand(interp
, "sqlite3_simulate_device", devSymObjCmd
, 0, 0);
1071 Tcl_CreateObjCommand(interp
, "unregister_devsim", dsUnregisterObjCmd
, 0, 0);
1072 Tcl_CreateObjCommand(interp
, "register_jt_vfs", jtObjCmd
, 0, 0);
1073 Tcl_CreateObjCommand(interp
, "unregister_jt_vfs", jtUnregisterObjCmd
, 0, 0);
1078 #endif /* SQLITE_TEST */