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 ** The code in this file implements a Tcl interface used to test error
14 ** handling in the os_unix.c module. Wrapper functions that support fault
15 ** injection are registered as the low-level OS functions using the
16 ** xSetSystemCall() method of the VFS. The Tcl interface is as follows:
19 ** test_syscall install LIST
20 ** Install wrapper functions for all system calls in argument LIST.
21 ** LIST must be a list consisting of zero or more of the following
24 ** open close access getcwd stat fstat
25 ** ftruncate fcntl read pread pread64 write
26 ** pwrite pwrite64 fchmod fallocate mmap
28 ** test_syscall uninstall
29 ** Uninstall all wrapper functions.
31 ** test_syscall fault ?COUNT PERSIST?
32 ** If [test_syscall fault] is invoked without the two arguments, fault
33 ** injection is disabled. Otherwise, fault injection is configured to
34 ** cause a failure on the COUNT'th next call to a system call with a
35 ** wrapper function installed. A COUNT value of 1 means fail the next
38 ** Argument PERSIST is interpreted as a boolean. If true, the all
39 ** system calls following the initial failure also fail. Otherwise, only
40 ** the single transient failure is injected.
42 ** test_syscall errno CALL ERRNO
43 ** Set the value that the global "errno" is set to following a fault
44 ** in call CALL. Argument CALL must be one of the system call names
45 ** listed above (under [test_syscall install]). ERRNO is a symbolic
46 ** name (i.e. "EACCES"). Not all errno codes are supported. Add extra
47 ** to the aErrno table in function test_syscall_errno() below as
50 ** test_syscall reset ?SYSTEM-CALL?
51 ** With no argument, this is an alias for the [uninstall] command. However,
52 ** this command uses a VFS call of the form:
54 ** xSetSystemCall(pVfs, 0, 0);
56 ** To restore the default system calls. The [uninstall] command restores
57 ** each system call individually by calling (i.e.):
59 ** xSetSystemCall(pVfs, "open", 0);
61 ** With an argument, this command attempts to reset the system call named
62 ** by the parameter using the same method as [uninstall].
64 ** test_syscall exists SYSTEM-CALL
65 ** Return true if the named system call exists. Or false otherwise.
68 ** Return a list of all system calls. The list is constructed using
69 ** the xNextSystemCall() VFS method.
71 ** test_syscall pagesize PGSZ
72 ** If PGSZ is a power of two greater than 256, install a wrapper around
73 ** OS function getpagesize() that reports the system page size as PGSZ.
74 ** Or, if PGSZ is less than zero, remove any wrapper already installed.
77 #include "sqliteInt.h"
87 extern const char *sqlite3ErrName(int);
90 #include <sys/types.h>
93 static struct TestSyscallGlobal
{
94 int bPersist
; /* 1 for persistent errors, 0 for transient */
95 int nCount
; /* Fail after this many more calls */
96 int nFail
; /* Number of failures that have occurred */
98 sqlite3_syscall_ptr orig_getpagesize
;
99 } gSyscall
= { 0, 0, 0, 0, 0 };
101 static int ts_open(const char *, int, int);
102 static int ts_close(int fd
);
103 static int ts_access(const char *zPath
, int mode
);
104 static char *ts_getcwd(char *zPath
, size_t nPath
);
105 static int ts_stat(const char *zPath
, struct stat
*p
);
106 static int ts_fstat(int fd
, struct stat
*p
);
107 static int ts_ftruncate(int fd
, off_t n
);
108 static int ts_fcntl(int fd
, int cmd
, ... );
109 static int ts_read(int fd
, void *aBuf
, size_t nBuf
);
110 static int ts_pread(int fd
, void *aBuf
, size_t nBuf
, off_t off
);
111 static int ts_pread64(int fd
, void *aBuf
, size_t nBuf
, off_t off
);
112 static int ts_write(int fd
, const void *aBuf
, size_t nBuf
);
113 static int ts_pwrite(int fd
, const void *aBuf
, size_t nBuf
, off_t off
);
114 static int ts_pwrite64(int fd
, const void *aBuf
, size_t nBuf
, off_t off
);
115 static int ts_fchmod(int fd
, mode_t mode
);
116 static int ts_fallocate(int fd
, off_t off
, off_t len
);
117 static void *ts_mmap(void *, size_t, int, int, int, off_t
);
118 static void *ts_mremap(void*, size_t, size_t, int, ...);
120 struct TestSyscallArray
{
122 sqlite3_syscall_ptr xTest
;
123 sqlite3_syscall_ptr xOrig
;
124 int default_errno
; /* Default value for errno following errors */
125 int custom_errno
; /* Current value for errno if error */
127 /* 0 */ { "open", (sqlite3_syscall_ptr
)ts_open
, 0, EACCES
, 0 },
128 /* 1 */ { "close", (sqlite3_syscall_ptr
)ts_close
, 0, 0, 0 },
129 /* 2 */ { "access", (sqlite3_syscall_ptr
)ts_access
, 0, 0, 0 },
130 /* 3 */ { "getcwd", (sqlite3_syscall_ptr
)ts_getcwd
, 0, 0, 0 },
131 /* 4 */ { "stat", (sqlite3_syscall_ptr
)ts_stat
, 0, 0, 0 },
132 /* 5 */ { "fstat", (sqlite3_syscall_ptr
)ts_fstat
, 0, 0, 0 },
133 /* 6 */ { "ftruncate", (sqlite3_syscall_ptr
)ts_ftruncate
, 0, EIO
, 0 },
134 /* 7 */ { "fcntl", (sqlite3_syscall_ptr
)ts_fcntl
, 0, EACCES
, 0 },
135 /* 8 */ { "read", (sqlite3_syscall_ptr
)ts_read
, 0, 0, 0 },
136 /* 9 */ { "pread", (sqlite3_syscall_ptr
)ts_pread
, 0, 0, 0 },
137 /* 10 */ { "pread64", (sqlite3_syscall_ptr
)ts_pread64
, 0, 0, 0 },
138 /* 11 */ { "write", (sqlite3_syscall_ptr
)ts_write
, 0, 0, 0 },
139 /* 12 */ { "pwrite", (sqlite3_syscall_ptr
)ts_pwrite
, 0, 0, 0 },
140 /* 13 */ { "pwrite64", (sqlite3_syscall_ptr
)ts_pwrite64
, 0, 0, 0 },
141 /* 14 */ { "fchmod", (sqlite3_syscall_ptr
)ts_fchmod
, 0, 0, 0 },
142 /* 15 */ { "fallocate", (sqlite3_syscall_ptr
)ts_fallocate
, 0, 0, 0 },
143 /* 16 */ { "mmap", (sqlite3_syscall_ptr
)ts_mmap
, 0, 0, 0 },
144 /* 17 */ { "mremap", (sqlite3_syscall_ptr
)ts_mremap
, 0, 0, 0 },
148 #define orig_open ((int(*)(const char *, int, int))aSyscall[0].xOrig)
149 #define orig_close ((int(*)(int))aSyscall[1].xOrig)
150 #define orig_access ((int(*)(const char*,int))aSyscall[2].xOrig)
151 #define orig_getcwd ((char*(*)(char*,size_t))aSyscall[3].xOrig)
152 #define orig_stat ((int(*)(const char*,struct stat*))aSyscall[4].xOrig)
153 #define orig_fstat ((int(*)(int,struct stat*))aSyscall[5].xOrig)
154 #define orig_ftruncate ((int(*)(int,off_t))aSyscall[6].xOrig)
155 #define orig_fcntl ((int(*)(int,int,...))aSyscall[7].xOrig)
156 #define orig_read ((ssize_t(*)(int,void*,size_t))aSyscall[8].xOrig)
157 #define orig_pread ((ssize_t(*)(int,void*,size_t,off_t))aSyscall[9].xOrig)
158 #define orig_pread64 ((ssize_t(*)(int,void*,size_t,off_t))aSyscall[10].xOrig)
159 #define orig_write ((ssize_t(*)(int,const void*,size_t))aSyscall[11].xOrig)
160 #define orig_pwrite ((ssize_t(*)(int,const void*,size_t,off_t))\
162 #define orig_pwrite64 ((ssize_t(*)(int,const void*,size_t,off_t))\
164 #define orig_fchmod ((int(*)(int,mode_t))aSyscall[14].xOrig)
165 #define orig_fallocate ((int(*)(int,off_t,off_t))aSyscall[15].xOrig)
166 #define orig_mmap ((void*(*)(void*,size_t,int,int,int,off_t))aSyscall[16].xOrig)
167 #define orig_mremap ((void*(*)(void*,size_t,size_t,int,...))aSyscall[17].xOrig)
170 ** This function is called exactly once from within each invocation of a
171 ** system call wrapper in this file. It returns 1 if the function should
172 ** fail, or 0 if it should succeed.
174 static int tsIsFail(void){
176 if( gSyscall
.nCount
==0 || (gSyscall
.nFail
&& gSyscall
.bPersist
) ){
184 ** Return the current error-number value for function zFunc. zFunc must be
185 ** the name of a system call in the aSyscall[] table.
187 ** Usually, the current error-number is the value that errno should be set
188 ** to if the named system call fails. The exception is "fallocate". See
189 ** comments above the implementation of ts_fallocate() for details.
191 static int tsErrno(const char *zFunc
){
193 int nFunc
= strlen(zFunc
);
194 for(i
=0; aSyscall
[i
].zName
; i
++){
195 if( strlen(aSyscall
[i
].zName
)!=nFunc
) continue;
196 if( memcmp(aSyscall
[i
].zName
, zFunc
, nFunc
) ) continue;
197 return aSyscall
[i
].custom_errno
;
205 ** A wrapper around tsIsFail(). If tsIsFail() returns non-zero, set the
206 ** value of errno before returning.
208 static int tsIsFailErrno(const char *zFunc
){
210 errno
= tsErrno(zFunc
);
217 ** A wrapper around open().
219 static int ts_open(const char *zFile
, int flags
, int mode
){
220 if( tsIsFailErrno("open") ){
223 return orig_open(zFile
, flags
, mode
);
227 ** A wrapper around close().
229 static int ts_close(int fd
){
231 /* Even if simulating an error, close the original file-descriptor.
232 ** This is to stop the test process from running out of file-descriptors
233 ** when running a long test. If a call to close() appears to fail, SQLite
234 ** never attempts to use the file-descriptor afterwards (or even to close
235 ** it a second time). */
239 return orig_close(fd
);
243 ** A wrapper around access().
245 static int ts_access(const char *zPath
, int mode
){
249 return orig_access(zPath
, mode
);
253 ** A wrapper around getcwd().
255 static char *ts_getcwd(char *zPath
, size_t nPath
){
259 return orig_getcwd(zPath
, nPath
);
263 ** A wrapper around stat().
265 static int ts_stat(const char *zPath
, struct stat
*p
){
269 return orig_stat(zPath
, p
);
273 ** A wrapper around fstat().
275 static int ts_fstat(int fd
, struct stat
*p
){
276 if( tsIsFailErrno("fstat") ){
279 return orig_fstat(fd
, p
);
283 ** A wrapper around ftruncate().
285 static int ts_ftruncate(int fd
, off_t n
){
286 if( tsIsFailErrno("ftruncate") ){
289 return orig_ftruncate(fd
, n
);
293 ** A wrapper around fcntl().
295 static int ts_fcntl(int fd
, int cmd
, ... ){
298 if( tsIsFailErrno("fcntl") ){
302 pArg
= va_arg(ap
, void *);
303 return orig_fcntl(fd
, cmd
, pArg
);
307 ** A wrapper around read().
309 static int ts_read(int fd
, void *aBuf
, size_t nBuf
){
310 if( tsIsFailErrno("read") ){
313 return orig_read(fd
, aBuf
, nBuf
);
317 ** A wrapper around pread().
319 static int ts_pread(int fd
, void *aBuf
, size_t nBuf
, off_t off
){
320 if( tsIsFailErrno("pread") ){
323 return orig_pread(fd
, aBuf
, nBuf
, off
);
327 ** A wrapper around pread64().
329 static int ts_pread64(int fd
, void *aBuf
, size_t nBuf
, off_t off
){
330 if( tsIsFailErrno("pread64") ){
333 return orig_pread64(fd
, aBuf
, nBuf
, off
);
337 ** A wrapper around write().
339 static int ts_write(int fd
, const void *aBuf
, size_t nBuf
){
340 if( tsIsFailErrno("write") ){
341 if( tsErrno("write")==EINTR
) orig_write(fd
, aBuf
, nBuf
/2);
344 return orig_write(fd
, aBuf
, nBuf
);
348 ** A wrapper around pwrite().
350 static int ts_pwrite(int fd
, const void *aBuf
, size_t nBuf
, off_t off
){
351 if( tsIsFailErrno("pwrite") ){
354 return orig_pwrite(fd
, aBuf
, nBuf
, off
);
358 ** A wrapper around pwrite64().
360 static int ts_pwrite64(int fd
, const void *aBuf
, size_t nBuf
, off_t off
){
361 if( tsIsFailErrno("pwrite64") ){
364 return orig_pwrite64(fd
, aBuf
, nBuf
, off
);
368 ** A wrapper around fchmod().
370 static int ts_fchmod(int fd
, mode_t mode
){
374 return orig_fchmod(fd
, mode
);
378 ** A wrapper around fallocate().
380 ** SQLite assumes that the fallocate() function is compatible with
381 ** posix_fallocate(). According to the Linux man page (2009-09-30):
383 ** posix_fallocate() returns zero on success, or an error number on
384 ** failure. Note that errno is not set.
386 static int ts_fallocate(int fd
, off_t off
, off_t len
){
388 return tsErrno("fallocate");
390 return orig_fallocate(fd
, off
, len
);
393 static void *ts_mmap(
401 if( tsIsFailErrno("mmap") ){
404 return orig_mmap(pAddr
, nByte
, prot
, flags
, fd
, iOff
);
407 static void *ts_mremap(void *a
, size_t b
, size_t c
, int d
, ...){
410 if( tsIsFailErrno("mremap") ){
414 pArg
= va_arg(ap
, void *);
415 return orig_mremap(a
, b
, c
, d
, pArg
);
418 static int test_syscall_install(
422 Tcl_Obj
*CONST objv
[]
430 Tcl_WrongNumArgs(interp
, 2, objv
, "SYSCALL-LIST");
433 if( Tcl_ListObjGetElements(interp
, objv
[2], &nElem
, &apElem
) ){
436 pVfs
= sqlite3_vfs_find(0);
438 for(i
=0; i
<nElem
; i
++){
440 int rc
= Tcl_GetIndexFromObjStruct(interp
,
441 apElem
[i
], aSyscall
, sizeof(aSyscall
[0]), "system-call", 0, &iCall
444 if( aSyscall
[iCall
].xOrig
==0 ){
445 aSyscall
[iCall
].xOrig
= pVfs
->xGetSystemCall(pVfs
, aSyscall
[iCall
].zName
);
446 pVfs
->xSetSystemCall(pVfs
, aSyscall
[iCall
].zName
, aSyscall
[iCall
].xTest
);
448 aSyscall
[iCall
].custom_errno
= aSyscall
[iCall
].default_errno
;
454 static int test_syscall_uninstall(
458 Tcl_Obj
*CONST objv
[]
464 Tcl_WrongNumArgs(interp
, 2, objv
, "");
468 pVfs
= sqlite3_vfs_find(0);
469 for(i
=0; aSyscall
[i
].zName
; i
++){
470 if( aSyscall
[i
].xOrig
){
471 pVfs
->xSetSystemCall(pVfs
, aSyscall
[i
].zName
, 0);
472 aSyscall
[i
].xOrig
= 0;
478 static int test_syscall_reset(
482 Tcl_Obj
*CONST objv
[]
488 if( objc
!=2 && objc
!=3 ){
489 Tcl_WrongNumArgs(interp
, 2, objv
, "");
493 pVfs
= sqlite3_vfs_find(0);
495 rc
= pVfs
->xSetSystemCall(pVfs
, 0, 0);
496 for(i
=0; aSyscall
[i
].zName
; i
++) aSyscall
[i
].xOrig
= 0;
499 char *zFunc
= Tcl_GetStringFromObj(objv
[2], &nFunc
);
500 rc
= pVfs
->xSetSystemCall(pVfs
, Tcl_GetString(objv
[2]), 0);
501 for(i
=0; rc
==SQLITE_OK
&& aSyscall
[i
].zName
; i
++){
502 if( strlen(aSyscall
[i
].zName
)!=nFunc
) continue;
503 if( memcmp(aSyscall
[i
].zName
, zFunc
, nFunc
) ) continue;
504 aSyscall
[i
].xOrig
= 0;
508 Tcl_SetObjResult(interp
, Tcl_NewStringObj(sqlite3ErrName(rc
), -1));
512 Tcl_ResetResult(interp
);
516 static int test_syscall_exists(
520 Tcl_Obj
*CONST objv
[]
523 sqlite3_syscall_ptr x
;
526 Tcl_WrongNumArgs(interp
, 2, objv
, "");
530 pVfs
= sqlite3_vfs_find(0);
531 x
= pVfs
->xGetSystemCall(pVfs
, Tcl_GetString(objv
[2]));
533 Tcl_SetObjResult(interp
, Tcl_NewBooleanObj(x
!=0));
537 static int test_syscall_fault(
541 Tcl_Obj
*CONST objv
[]
546 if( objc
!=2 && objc
!=4 ){
547 Tcl_WrongNumArgs(interp
, 2, objv
, "?COUNT PERSIST?");
552 if( Tcl_GetIntFromObj(interp
, objv
[2], &nCount
)
553 || Tcl_GetBooleanFromObj(interp
, objv
[3], &bPersist
)
559 Tcl_SetObjResult(interp
, Tcl_NewIntObj(gSyscall
.nFail
));
560 gSyscall
.nCount
= nCount
;
561 gSyscall
.bPersist
= bPersist
;
566 static int test_syscall_errno(
570 Tcl_Obj
*CONST objv
[]
580 { "EACCES", EACCES
},
583 { "EOVERFLOW", EOVERFLOW
},
584 { "ENOMEM", ENOMEM
},
585 { "EAGAIN", EAGAIN
},
586 { "ETIMEDOUT", ETIMEDOUT
},
589 { "EDEADLK", EDEADLK
},
590 { "ENOLCK", ENOLCK
},
595 Tcl_WrongNumArgs(interp
, 2, objv
, "SYSCALL ERRNO");
599 rc
= Tcl_GetIndexFromObjStruct(interp
,
600 objv
[2], aSyscall
, sizeof(aSyscall
[0]), "system-call", 0, &iCall
602 if( rc
!=TCL_OK
) return rc
;
603 rc
= Tcl_GetIndexFromObjStruct(interp
,
604 objv
[3], aErrno
, sizeof(aErrno
[0]), "errno", 0, &iErrno
606 if( rc
!=TCL_OK
) return rc
;
608 aSyscall
[iCall
].custom_errno
= aErrno
[iErrno
].i
;
612 static int test_syscall_list(
616 Tcl_Obj
*CONST objv
[]
623 Tcl_WrongNumArgs(interp
, 2, objv
, "");
627 pVfs
= sqlite3_vfs_find(0);
628 pList
= Tcl_NewObj();
629 Tcl_IncrRefCount(pList
);
630 for(zSys
= pVfs
->xNextSystemCall(pVfs
, 0);
632 zSys
= pVfs
->xNextSystemCall(pVfs
, zSys
)
634 Tcl_ListObjAppendElement(interp
, pList
, Tcl_NewStringObj(zSys
, -1));
637 Tcl_SetObjResult(interp
, pList
);
638 Tcl_DecrRefCount(pList
);
642 static int test_syscall_defaultvfs(
646 Tcl_Obj
*CONST objv
[]
651 Tcl_WrongNumArgs(interp
, 2, objv
, "");
655 pVfs
= sqlite3_vfs_find(0);
656 Tcl_SetObjResult(interp
, Tcl_NewStringObj(pVfs
->zName
, -1));
660 static int ts_getpagesize(void){
661 return gSyscall
.pgsz
;
664 static int test_syscall_pagesize(
668 Tcl_Obj
*CONST objv
[]
670 sqlite3_vfs
*pVfs
= sqlite3_vfs_find(0);
673 Tcl_WrongNumArgs(interp
, 2, objv
, "PGSZ");
676 if( Tcl_GetIntFromObj(interp
, objv
[2], &pgsz
) ){
681 if( gSyscall
.orig_getpagesize
){
682 pVfs
->xSetSystemCall(pVfs
, "getpagesize", gSyscall
.orig_getpagesize
);
685 if( pgsz
<512 || (pgsz
& (pgsz
-1)) ){
686 Tcl_AppendResult(interp
, "pgsz out of range", 0);
689 gSyscall
.orig_getpagesize
= pVfs
->xGetSystemCall(pVfs
, "getpagesize");
690 gSyscall
.pgsz
= pgsz
;
691 pVfs
->xSetSystemCall(
692 pVfs
, "getpagesize", (sqlite3_syscall_ptr
)ts_getpagesize
699 static int test_syscall(
703 Tcl_Obj
*CONST objv
[]
707 Tcl_ObjCmdProc
*xCmd
;
709 { "fault", test_syscall_fault
},
710 { "install", test_syscall_install
},
711 { "uninstall", test_syscall_uninstall
},
712 { "reset", test_syscall_reset
},
713 { "errno", test_syscall_errno
},
714 { "exists", test_syscall_exists
},
715 { "list", test_syscall_list
},
716 { "defaultvfs", test_syscall_defaultvfs
},
717 { "pagesize", test_syscall_pagesize
},
724 Tcl_WrongNumArgs(interp
, 1, objv
, "SUB-COMMAND ...");
727 rc
= Tcl_GetIndexFromObjStruct(interp
,
728 objv
[1], aCmd
, sizeof(aCmd
[0]), "sub-command", 0, &iCmd
730 if( rc
!=TCL_OK
) return rc
;
731 return aCmd
[iCmd
].xCmd(clientData
, interp
, objc
, objv
);
734 int SqlitetestSyscall_Init(Tcl_Interp
*interp
){
737 Tcl_ObjCmdProc
*xCmd
;
739 { "test_syscall", test_syscall
},
743 for(i
=0; i
<sizeof(aCmd
)/sizeof(aCmd
[0]); i
++){
744 Tcl_CreateObjCommand(interp
, aCmd
[i
].zName
, aCmd
[i
].xCmd
, 0, 0);
749 int SqlitetestSyscall_Init(Tcl_Interp
*interp
){