xref: /sqlite-3.40.0/src/test_syscall.c (revision 7617e4a8)
1213ca0a8Sdan /*
2213ca0a8Sdan ** 2011 March 28
3213ca0a8Sdan **
4213ca0a8Sdan ** The author disclaims copyright to this source code.  In place of
5213ca0a8Sdan ** a legal notice, here is a blessing:
6213ca0a8Sdan **
7213ca0a8Sdan **    May you do good and not evil.
8213ca0a8Sdan **    May you find forgiveness for yourself and forgive others.
9213ca0a8Sdan **    May you share freely, never taking more than you give.
10213ca0a8Sdan **
11213ca0a8Sdan *************************************************************************
12213ca0a8Sdan **
13213ca0a8Sdan ** The code in this file implements a Tcl interface used to test error
14213ca0a8Sdan ** handling in the os_unix.c module. Wrapper functions that support fault
15213ca0a8Sdan ** injection are registered as the low-level OS functions using the
16213ca0a8Sdan ** xSetSystemCall() method of the VFS. The Tcl interface is as follows:
17213ca0a8Sdan **
18213ca0a8Sdan **
19213ca0a8Sdan **   test_syscall install LIST
20213ca0a8Sdan **     Install wrapper functions for all system calls in argument LIST.
21213ca0a8Sdan **     LIST must be a list consisting of zero or more of the following
22213ca0a8Sdan **     literal values:
23213ca0a8Sdan **
24213ca0a8Sdan **         open        close      access   getcwd   stat      fstat
25213ca0a8Sdan **         ftruncate   fcntl      read     pread    pread64   write
26893c0ffcSdan **         pwrite      pwrite64   fchmod   fallocate mmap
27213ca0a8Sdan **
28213ca0a8Sdan **   test_syscall uninstall
29213ca0a8Sdan **     Uninstall all wrapper functions.
30213ca0a8Sdan **
31213ca0a8Sdan **   test_syscall fault ?COUNT PERSIST?
32213ca0a8Sdan **     If [test_syscall fault] is invoked without the two arguments, fault
33213ca0a8Sdan **     injection is disabled. Otherwise, fault injection is configured to
34213ca0a8Sdan **     cause a failure on the COUNT'th next call to a system call with a
35213ca0a8Sdan **     wrapper function installed. A COUNT value of 1 means fail the next
36213ca0a8Sdan **     system call.
37213ca0a8Sdan **
38213ca0a8Sdan **     Argument PERSIST is interpreted as a boolean. If true, the all
39213ca0a8Sdan **     system calls following the initial failure also fail. Otherwise, only
40213ca0a8Sdan **     the single transient failure is injected.
41213ca0a8Sdan **
42213ca0a8Sdan **   test_syscall errno CALL ERRNO
43213ca0a8Sdan **     Set the value that the global "errno" is set to following a fault
44213ca0a8Sdan **     in call CALL. Argument CALL must be one of the system call names
45213ca0a8Sdan **     listed above (under [test_syscall install]). ERRNO is a symbolic
46213ca0a8Sdan **     name (i.e. "EACCES"). Not all errno codes are supported. Add extra
47213ca0a8Sdan **     to the aErrno table in function test_syscall_errno() below as
48213ca0a8Sdan **     required.
490fd7d860Sdan **
500fd7d860Sdan **   test_syscall reset ?SYSTEM-CALL?
510fd7d860Sdan **     With no argument, this is an alias for the [uninstall] command. However,
520fd7d860Sdan **     this command uses a VFS call of the form:
530fd7d860Sdan **
540fd7d860Sdan **       xSetSystemCall(pVfs, 0, 0);
550fd7d860Sdan **
560fd7d860Sdan **     To restore the default system calls. The [uninstall] command restores
570fd7d860Sdan **     each system call individually by calling (i.e.):
580fd7d860Sdan **
590fd7d860Sdan **       xSetSystemCall(pVfs, "open", 0);
600fd7d860Sdan **
610fd7d860Sdan **     With an argument, this command attempts to reset the system call named
620fd7d860Sdan **     by the parameter using the same method as [uninstall].
630fd7d860Sdan **
640fd7d860Sdan **   test_syscall exists SYSTEM-CALL
650fd7d860Sdan **     Return true if the named system call exists. Or false otherwise.
660fd7d860Sdan **
670fd7d860Sdan **   test_syscall list
680fd7d860Sdan **     Return a list of all system calls. The list is constructed using
690fd7d860Sdan **     the xNextSystemCall() VFS method.
70bc76063cSdan **
71bc76063cSdan **   test_syscall pagesize PGSZ
72bc76063cSdan **     If PGSZ is a power of two greater than 256, install a wrapper around
73bc76063cSdan **     OS function getpagesize() that reports the system page size as PGSZ.
74bc76063cSdan **     Or, if PGSZ is less than zero, remove any wrapper already installed.
75213ca0a8Sdan */
76213ca0a8Sdan 
775b15b75aSdan #include "sqliteInt.h"
78213ca0a8Sdan #include "sqlite3.h"
7952b1dbb5Smistachkin #if defined(INCLUDE_SQLITE_TCL_H)
8052b1dbb5Smistachkin #  include "sqlite_tcl.h"
8152b1dbb5Smistachkin #else
82213ca0a8Sdan #  include "tcl.h"
8352b1dbb5Smistachkin #endif
84213ca0a8Sdan #include <stdlib.h>
85213ca0a8Sdan #include <string.h>
86213ca0a8Sdan #include <assert.h>
87213ca0a8Sdan 
883a2d29f8Sshaneh #if SQLITE_OS_UNIX
89213ca0a8Sdan 
90e84d8d32Smistachkin /* From main.c */
91e84d8d32Smistachkin extern const char *sqlite3ErrName(int);
920fd7d860Sdan 
93893c0ffcSdan #include <sys/mman.h>
94213ca0a8Sdan #include <sys/types.h>
95213ca0a8Sdan #include <errno.h>
96213ca0a8Sdan 
97213ca0a8Sdan static struct TestSyscallGlobal {
98213ca0a8Sdan   int bPersist;                   /* 1 for persistent errors, 0 for transient */
99213ca0a8Sdan   int nCount;                     /* Fail after this many more calls */
100213ca0a8Sdan   int nFail;                      /* Number of failures that have occurred */
101bc76063cSdan   int pgsz;
102bc76063cSdan   sqlite3_syscall_ptr orig_getpagesize;
103bc76063cSdan } gSyscall = { 0, 0, 0, 0, 0 };
104213ca0a8Sdan 
105213ca0a8Sdan static int ts_open(const char *, int, int);
106213ca0a8Sdan static int ts_close(int fd);
107213ca0a8Sdan static int ts_access(const char *zPath, int mode);
108213ca0a8Sdan static char *ts_getcwd(char *zPath, size_t nPath);
109213ca0a8Sdan static int ts_stat(const char *zPath, struct stat *p);
110213ca0a8Sdan static int ts_fstat(int fd, struct stat *p);
111213ca0a8Sdan static int ts_ftruncate(int fd, off_t n);
112213ca0a8Sdan static int ts_fcntl(int fd, int cmd, ... );
113213ca0a8Sdan static int ts_read(int fd, void *aBuf, size_t nBuf);
114213ca0a8Sdan static int ts_pread(int fd, void *aBuf, size_t nBuf, off_t off);
115f9986d90Sdrh /* Note:  pread64() and pwrite64() actually use off64_t as the type on their
116f9986d90Sdrh ** last parameter.  But that datatype is not defined on many systems
117f9986d90Sdrh ** (ex: Mac, OpenBSD).  So substitute a likely equivalent: sqlite3_uint64 */
118f9986d90Sdrh static int ts_pread64(int fd, void *aBuf, size_t nBuf, sqlite3_uint64 off);
119213ca0a8Sdan static int ts_write(int fd, const void *aBuf, size_t nBuf);
120213ca0a8Sdan static int ts_pwrite(int fd, const void *aBuf, size_t nBuf, off_t off);
121f9986d90Sdrh static int ts_pwrite64(int fd, const void *aBuf, size_t nBuf, sqlite3_uint64 off);
122213ca0a8Sdan static int ts_fchmod(int fd, mode_t mode);
123213ca0a8Sdan static int ts_fallocate(int fd, off_t off, off_t len);
124893c0ffcSdan static void *ts_mmap(void *, size_t, int, int, int, off_t);
1254ff7bc45Sdan static void *ts_mremap(void*, size_t, size_t, int, ...);
126213ca0a8Sdan 
127213ca0a8Sdan struct TestSyscallArray {
128213ca0a8Sdan   const char *zName;
129213ca0a8Sdan   sqlite3_syscall_ptr xTest;
130213ca0a8Sdan   sqlite3_syscall_ptr xOrig;
131213ca0a8Sdan   int default_errno;              /* Default value for errno following errors */
132213ca0a8Sdan   int custom_errno;               /* Current value for errno if error */
133213ca0a8Sdan } aSyscall[] = {
134213ca0a8Sdan   /*  0 */ { "open",      (sqlite3_syscall_ptr)ts_open,      0, EACCES, 0 },
135213ca0a8Sdan   /*  1 */ { "close",     (sqlite3_syscall_ptr)ts_close,     0, 0, 0 },
136213ca0a8Sdan   /*  2 */ { "access",    (sqlite3_syscall_ptr)ts_access,    0, 0, 0 },
137213ca0a8Sdan   /*  3 */ { "getcwd",    (sqlite3_syscall_ptr)ts_getcwd,    0, 0, 0 },
138213ca0a8Sdan   /*  4 */ { "stat",      (sqlite3_syscall_ptr)ts_stat,      0, 0, 0 },
139213ca0a8Sdan   /*  5 */ { "fstat",     (sqlite3_syscall_ptr)ts_fstat,     0, 0, 0 },
14060939d0aSdan   /*  6 */ { "ftruncate", (sqlite3_syscall_ptr)ts_ftruncate, 0, EIO, 0 },
141661d71afSdan   /*  7 */ { "fcntl",     (sqlite3_syscall_ptr)ts_fcntl,     0, EACCES, 0 },
142213ca0a8Sdan   /*  8 */ { "read",      (sqlite3_syscall_ptr)ts_read,      0, 0, 0 },
143213ca0a8Sdan   /*  9 */ { "pread",     (sqlite3_syscall_ptr)ts_pread,     0, 0, 0 },
144213ca0a8Sdan   /* 10 */ { "pread64",   (sqlite3_syscall_ptr)ts_pread64,   0, 0, 0 },
145213ca0a8Sdan   /* 11 */ { "write",     (sqlite3_syscall_ptr)ts_write,     0, 0, 0 },
146213ca0a8Sdan   /* 12 */ { "pwrite",    (sqlite3_syscall_ptr)ts_pwrite,    0, 0, 0 },
147213ca0a8Sdan   /* 13 */ { "pwrite64",  (sqlite3_syscall_ptr)ts_pwrite64,  0, 0, 0 },
148213ca0a8Sdan   /* 14 */ { "fchmod",    (sqlite3_syscall_ptr)ts_fchmod,    0, 0, 0 },
149213ca0a8Sdan   /* 15 */ { "fallocate", (sqlite3_syscall_ptr)ts_fallocate, 0, 0, 0 },
150893c0ffcSdan   /* 16 */ { "mmap",      (sqlite3_syscall_ptr)ts_mmap,      0, 0, 0 },
1514ff7bc45Sdan   /* 17 */ { "mremap",    (sqlite3_syscall_ptr)ts_mremap,    0, 0, 0 },
152213ca0a8Sdan            { 0, 0, 0, 0, 0 }
153213ca0a8Sdan };
154213ca0a8Sdan 
155213ca0a8Sdan #define orig_open      ((int(*)(const char *, int, int))aSyscall[0].xOrig)
156213ca0a8Sdan #define orig_close     ((int(*)(int))aSyscall[1].xOrig)
157213ca0a8Sdan #define orig_access    ((int(*)(const char*,int))aSyscall[2].xOrig)
158213ca0a8Sdan #define orig_getcwd    ((char*(*)(char*,size_t))aSyscall[3].xOrig)
159213ca0a8Sdan #define orig_stat      ((int(*)(const char*,struct stat*))aSyscall[4].xOrig)
160213ca0a8Sdan #define orig_fstat     ((int(*)(int,struct stat*))aSyscall[5].xOrig)
161213ca0a8Sdan #define orig_ftruncate ((int(*)(int,off_t))aSyscall[6].xOrig)
162213ca0a8Sdan #define orig_fcntl     ((int(*)(int,int,...))aSyscall[7].xOrig)
163213ca0a8Sdan #define orig_read      ((ssize_t(*)(int,void*,size_t))aSyscall[8].xOrig)
164213ca0a8Sdan #define orig_pread     ((ssize_t(*)(int,void*,size_t,off_t))aSyscall[9].xOrig)
165f9986d90Sdrh #define orig_pread64   ((ssize_t(*)(int,void*,size_t,sqlite3_uint64))aSyscall[10].xOrig)
166213ca0a8Sdan #define orig_write     ((ssize_t(*)(int,const void*,size_t))aSyscall[11].xOrig)
167213ca0a8Sdan #define orig_pwrite    ((ssize_t(*)(int,const void*,size_t,off_t))\
168213ca0a8Sdan                        aSyscall[12].xOrig)
169f9986d90Sdrh #define orig_pwrite64  ((ssize_t(*)(int,const void*,size_t,sqlite3_uint64))\
170213ca0a8Sdan                        aSyscall[13].xOrig)
171213ca0a8Sdan #define orig_fchmod    ((int(*)(int,mode_t))aSyscall[14].xOrig)
172213ca0a8Sdan #define orig_fallocate ((int(*)(int,off_t,off_t))aSyscall[15].xOrig)
173893c0ffcSdan #define orig_mmap      ((void*(*)(void*,size_t,int,int,int,off_t))aSyscall[16].xOrig)
1744ff7bc45Sdan #define orig_mremap    ((void*(*)(void*,size_t,size_t,int,...))aSyscall[17].xOrig)
175213ca0a8Sdan 
176213ca0a8Sdan /*
177213ca0a8Sdan ** This function is called exactly once from within each invocation of a
178213ca0a8Sdan ** system call wrapper in this file. It returns 1 if the function should
179213ca0a8Sdan ** fail, or 0 if it should succeed.
180213ca0a8Sdan */
tsIsFail(void)181213ca0a8Sdan static int tsIsFail(void){
182213ca0a8Sdan   gSyscall.nCount--;
183213ca0a8Sdan   if( gSyscall.nCount==0 || (gSyscall.nFail && gSyscall.bPersist) ){
184213ca0a8Sdan     gSyscall.nFail++;
185213ca0a8Sdan     return 1;
186213ca0a8Sdan   }
187213ca0a8Sdan   return 0;
188213ca0a8Sdan }
189213ca0a8Sdan 
190213ca0a8Sdan /*
191213ca0a8Sdan ** Return the current error-number value for function zFunc. zFunc must be
192213ca0a8Sdan ** the name of a system call in the aSyscall[] table.
193213ca0a8Sdan **
194213ca0a8Sdan ** Usually, the current error-number is the value that errno should be set
195213ca0a8Sdan ** to if the named system call fails. The exception is "fallocate". See
196213ca0a8Sdan ** comments above the implementation of ts_fallocate() for details.
197213ca0a8Sdan */
tsErrno(const char * zFunc)198213ca0a8Sdan static int tsErrno(const char *zFunc){
199213ca0a8Sdan   int i;
200213ca0a8Sdan   int nFunc = strlen(zFunc);
201213ca0a8Sdan   for(i=0; aSyscall[i].zName; i++){
202213ca0a8Sdan     if( strlen(aSyscall[i].zName)!=nFunc ) continue;
203213ca0a8Sdan     if( memcmp(aSyscall[i].zName, zFunc, nFunc) ) continue;
204213ca0a8Sdan     return aSyscall[i].custom_errno;
205213ca0a8Sdan   }
206213ca0a8Sdan 
207213ca0a8Sdan   assert(0);
208213ca0a8Sdan   return 0;
209213ca0a8Sdan }
210213ca0a8Sdan 
211213ca0a8Sdan /*
212213ca0a8Sdan ** A wrapper around tsIsFail(). If tsIsFail() returns non-zero, set the
213213ca0a8Sdan ** value of errno before returning.
214213ca0a8Sdan */
tsIsFailErrno(const char * zFunc)215213ca0a8Sdan static int tsIsFailErrno(const char *zFunc){
216213ca0a8Sdan   if( tsIsFail() ){
217213ca0a8Sdan     errno = tsErrno(zFunc);
218213ca0a8Sdan     return 1;
219213ca0a8Sdan   }
220213ca0a8Sdan   return 0;
221213ca0a8Sdan }
222213ca0a8Sdan 
223213ca0a8Sdan /*
224213ca0a8Sdan ** A wrapper around open().
225213ca0a8Sdan */
ts_open(const char * zFile,int flags,int mode)226213ca0a8Sdan static int ts_open(const char *zFile, int flags, int mode){
227213ca0a8Sdan   if( tsIsFailErrno("open") ){
228213ca0a8Sdan     return -1;
229213ca0a8Sdan   }
230213ca0a8Sdan   return orig_open(zFile, flags, mode);
231213ca0a8Sdan }
232213ca0a8Sdan 
233213ca0a8Sdan /*
234213ca0a8Sdan ** A wrapper around close().
235213ca0a8Sdan */
ts_close(int fd)236213ca0a8Sdan static int ts_close(int fd){
237213ca0a8Sdan   if( tsIsFail() ){
238f1874954Sdan     /* Even if simulating an error, close the original file-descriptor.
239f1874954Sdan     ** This is to stop the test process from running out of file-descriptors
240f1874954Sdan     ** when running a long test. If a call to close() appears to fail, SQLite
241f1874954Sdan     ** never attempts to use the file-descriptor afterwards (or even to close
242f1874954Sdan     ** it a second time).  */
243f1874954Sdan     orig_close(fd);
244213ca0a8Sdan     return -1;
245213ca0a8Sdan   }
246213ca0a8Sdan   return orig_close(fd);
247213ca0a8Sdan }
248213ca0a8Sdan 
249213ca0a8Sdan /*
250213ca0a8Sdan ** A wrapper around access().
251213ca0a8Sdan */
ts_access(const char * zPath,int mode)252213ca0a8Sdan static int ts_access(const char *zPath, int mode){
253213ca0a8Sdan   if( tsIsFail() ){
254213ca0a8Sdan     return -1;
255213ca0a8Sdan   }
256213ca0a8Sdan   return orig_access(zPath, mode);
257213ca0a8Sdan }
258213ca0a8Sdan 
259213ca0a8Sdan /*
260213ca0a8Sdan ** A wrapper around getcwd().
261213ca0a8Sdan */
ts_getcwd(char * zPath,size_t nPath)262213ca0a8Sdan static char *ts_getcwd(char *zPath, size_t nPath){
263213ca0a8Sdan   if( tsIsFail() ){
264213ca0a8Sdan     return NULL;
265213ca0a8Sdan   }
266213ca0a8Sdan   return orig_getcwd(zPath, nPath);
267213ca0a8Sdan }
268213ca0a8Sdan 
269213ca0a8Sdan /*
270213ca0a8Sdan ** A wrapper around stat().
271213ca0a8Sdan */
ts_stat(const char * zPath,struct stat * p)272213ca0a8Sdan static int ts_stat(const char *zPath, struct stat *p){
273213ca0a8Sdan   if( tsIsFail() ){
274213ca0a8Sdan     return -1;
275213ca0a8Sdan   }
276213ca0a8Sdan   return orig_stat(zPath, p);
277213ca0a8Sdan }
278213ca0a8Sdan 
279213ca0a8Sdan /*
280213ca0a8Sdan ** A wrapper around fstat().
281213ca0a8Sdan */
ts_fstat(int fd,struct stat * p)282213ca0a8Sdan static int ts_fstat(int fd, struct stat *p){
2835ef47bf0Sdan   if( tsIsFailErrno("fstat") ){
284213ca0a8Sdan     return -1;
285213ca0a8Sdan   }
286213ca0a8Sdan   return orig_fstat(fd, p);
287213ca0a8Sdan }
288213ca0a8Sdan 
289213ca0a8Sdan /*
290213ca0a8Sdan ** A wrapper around ftruncate().
291213ca0a8Sdan */
ts_ftruncate(int fd,off_t n)292213ca0a8Sdan static int ts_ftruncate(int fd, off_t n){
29360939d0aSdan   if( tsIsFailErrno("ftruncate") ){
294213ca0a8Sdan     return -1;
295213ca0a8Sdan   }
296213ca0a8Sdan   return orig_ftruncate(fd, n);
297213ca0a8Sdan }
298213ca0a8Sdan 
299213ca0a8Sdan /*
300213ca0a8Sdan ** A wrapper around fcntl().
301213ca0a8Sdan */
ts_fcntl(int fd,int cmd,...)302213ca0a8Sdan static int ts_fcntl(int fd, int cmd, ... ){
303213ca0a8Sdan   va_list ap;
304213ca0a8Sdan   void *pArg;
305661d71afSdan   if( tsIsFailErrno("fcntl") ){
306213ca0a8Sdan     return -1;
307213ca0a8Sdan   }
308213ca0a8Sdan   va_start(ap, cmd);
309213ca0a8Sdan   pArg = va_arg(ap, void *);
310213ca0a8Sdan   return orig_fcntl(fd, cmd, pArg);
311213ca0a8Sdan }
312213ca0a8Sdan 
313213ca0a8Sdan /*
314213ca0a8Sdan ** A wrapper around read().
315213ca0a8Sdan */
ts_read(int fd,void * aBuf,size_t nBuf)316213ca0a8Sdan static int ts_read(int fd, void *aBuf, size_t nBuf){
317661d71afSdan   if( tsIsFailErrno("read") ){
318213ca0a8Sdan     return -1;
319213ca0a8Sdan   }
320213ca0a8Sdan   return orig_read(fd, aBuf, nBuf);
321213ca0a8Sdan }
322213ca0a8Sdan 
323213ca0a8Sdan /*
324213ca0a8Sdan ** A wrapper around pread().
325213ca0a8Sdan */
ts_pread(int fd,void * aBuf,size_t nBuf,off_t off)326213ca0a8Sdan static int ts_pread(int fd, void *aBuf, size_t nBuf, off_t off){
327661d71afSdan   if( tsIsFailErrno("pread") ){
328213ca0a8Sdan     return -1;
329213ca0a8Sdan   }
330213ca0a8Sdan   return orig_pread(fd, aBuf, nBuf, off);
331213ca0a8Sdan }
332213ca0a8Sdan 
333213ca0a8Sdan /*
334213ca0a8Sdan ** A wrapper around pread64().
335213ca0a8Sdan */
ts_pread64(int fd,void * aBuf,size_t nBuf,sqlite3_uint64 off)336f9986d90Sdrh static int ts_pread64(int fd, void *aBuf, size_t nBuf, sqlite3_uint64 off){
337661d71afSdan   if( tsIsFailErrno("pread64") ){
338213ca0a8Sdan     return -1;
339213ca0a8Sdan   }
340213ca0a8Sdan   return orig_pread64(fd, aBuf, nBuf, off);
341213ca0a8Sdan }
342213ca0a8Sdan 
343213ca0a8Sdan /*
344213ca0a8Sdan ** A wrapper around write().
345213ca0a8Sdan */
ts_write(int fd,const void * aBuf,size_t nBuf)346213ca0a8Sdan static int ts_write(int fd, const void *aBuf, size_t nBuf){
347661d71afSdan   if( tsIsFailErrno("write") ){
348bd1e50c9Sdrh     if( tsErrno("write")==EINTR ) orig_write(fd, aBuf, nBuf/2);
349213ca0a8Sdan     return -1;
350213ca0a8Sdan   }
351213ca0a8Sdan   return orig_write(fd, aBuf, nBuf);
352213ca0a8Sdan }
353213ca0a8Sdan 
354213ca0a8Sdan /*
355213ca0a8Sdan ** A wrapper around pwrite().
356213ca0a8Sdan */
ts_pwrite(int fd,const void * aBuf,size_t nBuf,off_t off)357213ca0a8Sdan static int ts_pwrite(int fd, const void *aBuf, size_t nBuf, off_t off){
358661d71afSdan   if( tsIsFailErrno("pwrite") ){
359213ca0a8Sdan     return -1;
360213ca0a8Sdan   }
361213ca0a8Sdan   return orig_pwrite(fd, aBuf, nBuf, off);
362213ca0a8Sdan }
363213ca0a8Sdan 
364213ca0a8Sdan /*
365213ca0a8Sdan ** A wrapper around pwrite64().
366213ca0a8Sdan */
ts_pwrite64(int fd,const void * aBuf,size_t nBuf,sqlite3_uint64 off)367f9986d90Sdrh static int ts_pwrite64(int fd, const void *aBuf, size_t nBuf, sqlite3_uint64 off){
368661d71afSdan   if( tsIsFailErrno("pwrite64") ){
369213ca0a8Sdan     return -1;
370213ca0a8Sdan   }
371213ca0a8Sdan   return orig_pwrite64(fd, aBuf, nBuf, off);
372213ca0a8Sdan }
373213ca0a8Sdan 
374213ca0a8Sdan /*
375213ca0a8Sdan ** A wrapper around fchmod().
376213ca0a8Sdan */
ts_fchmod(int fd,mode_t mode)377213ca0a8Sdan static int ts_fchmod(int fd, mode_t mode){
378213ca0a8Sdan   if( tsIsFail() ){
379213ca0a8Sdan     return -1;
380213ca0a8Sdan   }
381213ca0a8Sdan   return orig_fchmod(fd, mode);
382213ca0a8Sdan }
383213ca0a8Sdan 
384213ca0a8Sdan /*
385213ca0a8Sdan ** A wrapper around fallocate().
386213ca0a8Sdan **
387213ca0a8Sdan ** SQLite assumes that the fallocate() function is compatible with
388213ca0a8Sdan ** posix_fallocate(). According to the Linux man page (2009-09-30):
389213ca0a8Sdan **
390213ca0a8Sdan **   posix_fallocate() returns  zero on success, or an error number on
391213ca0a8Sdan **   failure. Note that errno is not set.
392213ca0a8Sdan */
ts_fallocate(int fd,off_t off,off_t len)393213ca0a8Sdan static int ts_fallocate(int fd, off_t off, off_t len){
394213ca0a8Sdan   if( tsIsFail() ){
395213ca0a8Sdan     return tsErrno("fallocate");
396213ca0a8Sdan   }
397213ca0a8Sdan   return orig_fallocate(fd, off, len);
398213ca0a8Sdan }
399213ca0a8Sdan 
ts_mmap(void * pAddr,size_t nByte,int prot,int flags,int fd,off_t iOff)400893c0ffcSdan static void *ts_mmap(
401893c0ffcSdan   void *pAddr,
402893c0ffcSdan   size_t nByte,
403893c0ffcSdan   int prot,
404893c0ffcSdan   int flags,
405893c0ffcSdan   int fd,
406893c0ffcSdan   off_t iOff
407893c0ffcSdan ){
408893c0ffcSdan   if( tsIsFailErrno("mmap") ){
409893c0ffcSdan     return MAP_FAILED;
410893c0ffcSdan   }
411893c0ffcSdan   return orig_mmap(pAddr, nByte, prot, flags, fd, iOff);
412893c0ffcSdan }
413893c0ffcSdan 
ts_mremap(void * a,size_t b,size_t c,int d,...)4144ff7bc45Sdan static void *ts_mremap(void *a, size_t b, size_t c, int d, ...){
4154ff7bc45Sdan   va_list ap;
4164ff7bc45Sdan   void *pArg;
4174ff7bc45Sdan   if( tsIsFailErrno("mremap") ){
4184ff7bc45Sdan     return MAP_FAILED;
4194ff7bc45Sdan   }
4204ff7bc45Sdan   va_start(ap, d);
4214ff7bc45Sdan   pArg = va_arg(ap, void *);
4224ff7bc45Sdan   return orig_mremap(a, b, c, d, pArg);
4234ff7bc45Sdan }
4244ff7bc45Sdan 
test_syscall_install(void * clientData,Tcl_Interp * interp,int objc,Tcl_Obj * CONST objv[])425*7617e4a8Smistachkin static int SQLITE_TCLAPI test_syscall_install(
426213ca0a8Sdan   void * clientData,
427213ca0a8Sdan   Tcl_Interp *interp,
428213ca0a8Sdan   int objc,
429213ca0a8Sdan   Tcl_Obj *CONST objv[]
430213ca0a8Sdan ){
431213ca0a8Sdan   sqlite3_vfs *pVfs;
432213ca0a8Sdan   int nElem;
433213ca0a8Sdan   int i;
434213ca0a8Sdan   Tcl_Obj **apElem;
435213ca0a8Sdan 
436213ca0a8Sdan   if( objc!=3 ){
437213ca0a8Sdan     Tcl_WrongNumArgs(interp, 2, objv, "SYSCALL-LIST");
438213ca0a8Sdan     return TCL_ERROR;
439213ca0a8Sdan   }
440213ca0a8Sdan   if( Tcl_ListObjGetElements(interp, objv[2], &nElem, &apElem) ){
441213ca0a8Sdan     return TCL_ERROR;
442213ca0a8Sdan   }
443213ca0a8Sdan   pVfs = sqlite3_vfs_find(0);
444213ca0a8Sdan 
445213ca0a8Sdan   for(i=0; i<nElem; i++){
446213ca0a8Sdan     int iCall;
447213ca0a8Sdan     int rc = Tcl_GetIndexFromObjStruct(interp,
448213ca0a8Sdan         apElem[i], aSyscall, sizeof(aSyscall[0]), "system-call", 0, &iCall
449213ca0a8Sdan     );
450213ca0a8Sdan     if( rc ) return rc;
451213ca0a8Sdan     if( aSyscall[iCall].xOrig==0 ){
452213ca0a8Sdan       aSyscall[iCall].xOrig = pVfs->xGetSystemCall(pVfs, aSyscall[iCall].zName);
453213ca0a8Sdan       pVfs->xSetSystemCall(pVfs, aSyscall[iCall].zName, aSyscall[iCall].xTest);
454213ca0a8Sdan     }
455213ca0a8Sdan     aSyscall[iCall].custom_errno = aSyscall[iCall].default_errno;
456213ca0a8Sdan   }
457213ca0a8Sdan 
458213ca0a8Sdan   return TCL_OK;
459213ca0a8Sdan }
460213ca0a8Sdan 
test_syscall_uninstall(void * clientData,Tcl_Interp * interp,int objc,Tcl_Obj * CONST objv[])461*7617e4a8Smistachkin static int SQLITE_TCLAPI test_syscall_uninstall(
462213ca0a8Sdan   void * clientData,
463213ca0a8Sdan   Tcl_Interp *interp,
464213ca0a8Sdan   int objc,
465213ca0a8Sdan   Tcl_Obj *CONST objv[]
466213ca0a8Sdan ){
467213ca0a8Sdan   sqlite3_vfs *pVfs;
468213ca0a8Sdan   int i;
469213ca0a8Sdan 
470213ca0a8Sdan   if( objc!=2 ){
471213ca0a8Sdan     Tcl_WrongNumArgs(interp, 2, objv, "");
472213ca0a8Sdan     return TCL_ERROR;
473213ca0a8Sdan   }
474213ca0a8Sdan 
475213ca0a8Sdan   pVfs = sqlite3_vfs_find(0);
476213ca0a8Sdan   for(i=0; aSyscall[i].zName; i++){
477213ca0a8Sdan     if( aSyscall[i].xOrig ){
4780fd7d860Sdan       pVfs->xSetSystemCall(pVfs, aSyscall[i].zName, 0);
479213ca0a8Sdan       aSyscall[i].xOrig = 0;
480213ca0a8Sdan     }
481213ca0a8Sdan   }
482213ca0a8Sdan   return TCL_OK;
483213ca0a8Sdan }
484213ca0a8Sdan 
test_syscall_reset(void * clientData,Tcl_Interp * interp,int objc,Tcl_Obj * CONST objv[])485*7617e4a8Smistachkin static int SQLITE_TCLAPI test_syscall_reset(
4860fd7d860Sdan   void * clientData,
4870fd7d860Sdan   Tcl_Interp *interp,
4880fd7d860Sdan   int objc,
4890fd7d860Sdan   Tcl_Obj *CONST objv[]
4900fd7d860Sdan ){
4910fd7d860Sdan   sqlite3_vfs *pVfs;
4920fd7d860Sdan   int i;
4930fd7d860Sdan   int rc;
4940fd7d860Sdan 
4950fd7d860Sdan   if( objc!=2 && objc!=3 ){
4960fd7d860Sdan     Tcl_WrongNumArgs(interp, 2, objv, "");
4970fd7d860Sdan     return TCL_ERROR;
4980fd7d860Sdan   }
4990fd7d860Sdan 
5000fd7d860Sdan   pVfs = sqlite3_vfs_find(0);
5010fd7d860Sdan   if( objc==2 ){
5020fd7d860Sdan     rc = pVfs->xSetSystemCall(pVfs, 0, 0);
5030fd7d860Sdan     for(i=0; aSyscall[i].zName; i++) aSyscall[i].xOrig = 0;
5040fd7d860Sdan   }else{
5050fd7d860Sdan     int nFunc;
5060fd7d860Sdan     char *zFunc = Tcl_GetStringFromObj(objv[2], &nFunc);
5070fd7d860Sdan     rc = pVfs->xSetSystemCall(pVfs, Tcl_GetString(objv[2]), 0);
5080fd7d860Sdan     for(i=0; rc==SQLITE_OK && aSyscall[i].zName; i++){
5090fd7d860Sdan       if( strlen(aSyscall[i].zName)!=nFunc ) continue;
5100fd7d860Sdan       if( memcmp(aSyscall[i].zName, zFunc, nFunc) ) continue;
5110fd7d860Sdan       aSyscall[i].xOrig = 0;
5120fd7d860Sdan     }
5130fd7d860Sdan   }
5140fd7d860Sdan   if( rc!=SQLITE_OK ){
515e84d8d32Smistachkin     Tcl_SetObjResult(interp, Tcl_NewStringObj(sqlite3ErrName(rc), -1));
5160fd7d860Sdan     return TCL_ERROR;
5170fd7d860Sdan   }
5180fd7d860Sdan 
5190fd7d860Sdan   Tcl_ResetResult(interp);
5200fd7d860Sdan   return TCL_OK;
5210fd7d860Sdan }
5220fd7d860Sdan 
test_syscall_exists(void * clientData,Tcl_Interp * interp,int objc,Tcl_Obj * CONST objv[])523*7617e4a8Smistachkin static int SQLITE_TCLAPI test_syscall_exists(
5240fd7d860Sdan   void * clientData,
5250fd7d860Sdan   Tcl_Interp *interp,
5260fd7d860Sdan   int objc,
5270fd7d860Sdan   Tcl_Obj *CONST objv[]
5280fd7d860Sdan ){
5290fd7d860Sdan   sqlite3_vfs *pVfs;
5300fd7d860Sdan   sqlite3_syscall_ptr x;
5310fd7d860Sdan 
5320fd7d860Sdan   if( objc!=3 ){
5330fd7d860Sdan     Tcl_WrongNumArgs(interp, 2, objv, "");
5340fd7d860Sdan     return TCL_ERROR;
5350fd7d860Sdan   }
5360fd7d860Sdan 
5370fd7d860Sdan   pVfs = sqlite3_vfs_find(0);
5380fd7d860Sdan   x = pVfs->xGetSystemCall(pVfs, Tcl_GetString(objv[2]));
5390fd7d860Sdan 
5400fd7d860Sdan   Tcl_SetObjResult(interp, Tcl_NewBooleanObj(x!=0));
5410fd7d860Sdan   return TCL_OK;
5420fd7d860Sdan }
5430fd7d860Sdan 
test_syscall_fault(void * clientData,Tcl_Interp * interp,int objc,Tcl_Obj * CONST objv[])544*7617e4a8Smistachkin static int SQLITE_TCLAPI test_syscall_fault(
545213ca0a8Sdan   void * clientData,
546213ca0a8Sdan   Tcl_Interp *interp,
547213ca0a8Sdan   int objc,
548213ca0a8Sdan   Tcl_Obj *CONST objv[]
549213ca0a8Sdan ){
550213ca0a8Sdan   int nCount = 0;
551213ca0a8Sdan   int bPersist = 0;
552213ca0a8Sdan 
553213ca0a8Sdan   if( objc!=2 && objc!=4 ){
554213ca0a8Sdan     Tcl_WrongNumArgs(interp, 2, objv, "?COUNT PERSIST?");
555213ca0a8Sdan     return TCL_ERROR;
556213ca0a8Sdan   }
557213ca0a8Sdan 
558213ca0a8Sdan   if( objc==4 ){
559213ca0a8Sdan     if( Tcl_GetIntFromObj(interp, objv[2], &nCount)
560213ca0a8Sdan      || Tcl_GetBooleanFromObj(interp, objv[3], &bPersist)
561213ca0a8Sdan     ){
562213ca0a8Sdan       return TCL_ERROR;
563213ca0a8Sdan     }
564213ca0a8Sdan   }
565213ca0a8Sdan 
566213ca0a8Sdan   Tcl_SetObjResult(interp, Tcl_NewIntObj(gSyscall.nFail));
567213ca0a8Sdan   gSyscall.nCount = nCount;
568213ca0a8Sdan   gSyscall.bPersist = bPersist;
569213ca0a8Sdan   gSyscall.nFail = 0;
570213ca0a8Sdan   return TCL_OK;
571213ca0a8Sdan }
572213ca0a8Sdan 
test_syscall_errno(void * clientData,Tcl_Interp * interp,int objc,Tcl_Obj * CONST objv[])573*7617e4a8Smistachkin static int SQLITE_TCLAPI test_syscall_errno(
574213ca0a8Sdan   void * clientData,
575213ca0a8Sdan   Tcl_Interp *interp,
576213ca0a8Sdan   int objc,
577213ca0a8Sdan   Tcl_Obj *CONST objv[]
578213ca0a8Sdan ){
579213ca0a8Sdan   int iCall;
580213ca0a8Sdan   int iErrno;
581213ca0a8Sdan   int rc;
582213ca0a8Sdan 
583213ca0a8Sdan   struct Errno {
584213ca0a8Sdan     const char *z;
585213ca0a8Sdan     int i;
586213ca0a8Sdan   } aErrno[] = {
587213ca0a8Sdan     { "EACCES",    EACCES },
58860939d0aSdan     { "EINTR",     EINTR },
58960939d0aSdan     { "EIO",       EIO },
5905ef47bf0Sdan     { "EOVERFLOW", EOVERFLOW },
5915ef47bf0Sdan     { "ENOMEM",    ENOMEM },
592661d71afSdan     { "EAGAIN",    EAGAIN },
593661d71afSdan     { "ETIMEDOUT", ETIMEDOUT },
594661d71afSdan     { "EBUSY",     EBUSY },
595661d71afSdan     { "EPERM",     EPERM },
596661d71afSdan     { "EDEADLK",   EDEADLK },
597661d71afSdan     { "ENOLCK",    ENOLCK },
598213ca0a8Sdan     { 0, 0 }
599213ca0a8Sdan   };
600213ca0a8Sdan 
601213ca0a8Sdan   if( objc!=4 ){
602213ca0a8Sdan     Tcl_WrongNumArgs(interp, 2, objv, "SYSCALL ERRNO");
603213ca0a8Sdan     return TCL_ERROR;
604213ca0a8Sdan   }
605213ca0a8Sdan 
606213ca0a8Sdan   rc = Tcl_GetIndexFromObjStruct(interp,
607213ca0a8Sdan       objv[2], aSyscall, sizeof(aSyscall[0]), "system-call", 0, &iCall
608213ca0a8Sdan   );
609213ca0a8Sdan   if( rc!=TCL_OK ) return rc;
610213ca0a8Sdan   rc = Tcl_GetIndexFromObjStruct(interp,
611213ca0a8Sdan       objv[3], aErrno, sizeof(aErrno[0]), "errno", 0, &iErrno
612213ca0a8Sdan   );
613213ca0a8Sdan   if( rc!=TCL_OK ) return rc;
614213ca0a8Sdan 
615213ca0a8Sdan   aSyscall[iCall].custom_errno = aErrno[iErrno].i;
616213ca0a8Sdan   return TCL_OK;
617213ca0a8Sdan }
618213ca0a8Sdan 
test_syscall_list(void * clientData,Tcl_Interp * interp,int objc,Tcl_Obj * CONST objv[])619*7617e4a8Smistachkin static int SQLITE_TCLAPI test_syscall_list(
6200fd7d860Sdan   void * clientData,
6210fd7d860Sdan   Tcl_Interp *interp,
6220fd7d860Sdan   int objc,
6230fd7d860Sdan   Tcl_Obj *CONST objv[]
6240fd7d860Sdan ){
6250fd7d860Sdan   const char *zSys;
6260fd7d860Sdan   sqlite3_vfs *pVfs;
6270fd7d860Sdan   Tcl_Obj *pList;
6280fd7d860Sdan 
6290fd7d860Sdan   if( objc!=2 ){
6300fd7d860Sdan     Tcl_WrongNumArgs(interp, 2, objv, "");
6310fd7d860Sdan     return TCL_ERROR;
6320fd7d860Sdan   }
6330fd7d860Sdan 
6340fd7d860Sdan   pVfs = sqlite3_vfs_find(0);
6350fd7d860Sdan   pList = Tcl_NewObj();
6360fd7d860Sdan   Tcl_IncrRefCount(pList);
6370fd7d860Sdan   for(zSys = pVfs->xNextSystemCall(pVfs, 0);
6380fd7d860Sdan       zSys!=0;
6390fd7d860Sdan       zSys = pVfs->xNextSystemCall(pVfs, zSys)
6400fd7d860Sdan   ){
6410fd7d860Sdan     Tcl_ListObjAppendElement(interp, pList, Tcl_NewStringObj(zSys, -1));
6420fd7d860Sdan   }
6430fd7d860Sdan 
6440fd7d860Sdan   Tcl_SetObjResult(interp, pList);
6450fd7d860Sdan   Tcl_DecrRefCount(pList);
6460fd7d860Sdan   return TCL_OK;
6470fd7d860Sdan }
6480fd7d860Sdan 
test_syscall_defaultvfs(void * clientData,Tcl_Interp * interp,int objc,Tcl_Obj * CONST objv[])649*7617e4a8Smistachkin static int SQLITE_TCLAPI test_syscall_defaultvfs(
65051438a79Sdan   void * clientData,
65151438a79Sdan   Tcl_Interp *interp,
65251438a79Sdan   int objc,
65351438a79Sdan   Tcl_Obj *CONST objv[]
65451438a79Sdan ){
65551438a79Sdan   sqlite3_vfs *pVfs;
65651438a79Sdan 
65751438a79Sdan   if( objc!=2 ){
65851438a79Sdan     Tcl_WrongNumArgs(interp, 2, objv, "");
65951438a79Sdan     return TCL_ERROR;
66051438a79Sdan   }
66151438a79Sdan 
66251438a79Sdan   pVfs = sqlite3_vfs_find(0);
66351438a79Sdan   Tcl_SetObjResult(interp, Tcl_NewStringObj(pVfs->zName, -1));
66451438a79Sdan   return TCL_OK;
66551438a79Sdan }
66651438a79Sdan 
ts_getpagesize(void)667bc76063cSdan static int ts_getpagesize(void){
668bc76063cSdan   return gSyscall.pgsz;
669bc76063cSdan }
670bc76063cSdan 
test_syscall_pagesize(void * clientData,Tcl_Interp * interp,int objc,Tcl_Obj * CONST objv[])671*7617e4a8Smistachkin static int SQLITE_TCLAPI test_syscall_pagesize(
672bc76063cSdan   void * clientData,
673bc76063cSdan   Tcl_Interp *interp,
674bc76063cSdan   int objc,
675bc76063cSdan   Tcl_Obj *CONST objv[]
676bc76063cSdan ){
677bc76063cSdan   sqlite3_vfs *pVfs = sqlite3_vfs_find(0);
678bc76063cSdan   int pgsz;
679bc76063cSdan   if( objc!=3 ){
680bc76063cSdan     Tcl_WrongNumArgs(interp, 2, objv, "PGSZ");
681bc76063cSdan     return TCL_ERROR;
682bc76063cSdan   }
683bc76063cSdan   if( Tcl_GetIntFromObj(interp, objv[2], &pgsz) ){
684bc76063cSdan     return TCL_ERROR;
685bc76063cSdan   }
686bc76063cSdan 
687bc76063cSdan   if( pgsz<0 ){
688bc76063cSdan     if( gSyscall.orig_getpagesize ){
689bc76063cSdan       pVfs->xSetSystemCall(pVfs, "getpagesize", gSyscall.orig_getpagesize);
690bc76063cSdan     }
691bc76063cSdan   }else{
692bc76063cSdan     if( pgsz<512 || (pgsz & (pgsz-1)) ){
693bc76063cSdan       Tcl_AppendResult(interp, "pgsz out of range", 0);
694bc76063cSdan       return TCL_ERROR;
695bc76063cSdan     }
696bc76063cSdan     gSyscall.orig_getpagesize = pVfs->xGetSystemCall(pVfs, "getpagesize");
697bc76063cSdan     gSyscall.pgsz = pgsz;
698bc76063cSdan     pVfs->xSetSystemCall(
699bc76063cSdan         pVfs, "getpagesize", (sqlite3_syscall_ptr)ts_getpagesize
700bc76063cSdan     );
701bc76063cSdan   }
702bc76063cSdan 
703bc76063cSdan   return TCL_OK;
704bc76063cSdan }
705bc76063cSdan 
test_syscall(void * clientData,Tcl_Interp * interp,int objc,Tcl_Obj * CONST objv[])706*7617e4a8Smistachkin static int SQLITE_TCLAPI test_syscall(
707213ca0a8Sdan   void * clientData,
708213ca0a8Sdan   Tcl_Interp *interp,
709213ca0a8Sdan   int objc,
710213ca0a8Sdan   Tcl_Obj *CONST objv[]
711213ca0a8Sdan ){
712213ca0a8Sdan   struct SyscallCmd {
713213ca0a8Sdan     const char *zName;
714213ca0a8Sdan     Tcl_ObjCmdProc *xCmd;
715213ca0a8Sdan   } aCmd[] = {
716213ca0a8Sdan     { "fault",      test_syscall_fault },
717213ca0a8Sdan     { "install",    test_syscall_install },
718213ca0a8Sdan     { "uninstall",  test_syscall_uninstall },
7190fd7d860Sdan     { "reset",      test_syscall_reset },
720213ca0a8Sdan     { "errno",      test_syscall_errno },
7210fd7d860Sdan     { "exists",     test_syscall_exists },
7220fd7d860Sdan     { "list",       test_syscall_list },
72351438a79Sdan     { "defaultvfs", test_syscall_defaultvfs },
724bc76063cSdan     { "pagesize",   test_syscall_pagesize },
725213ca0a8Sdan     { 0, 0 }
726213ca0a8Sdan   };
727213ca0a8Sdan   int iCmd;
728213ca0a8Sdan   int rc;
72905accd22Sdan   sqlite3_vfs *pVfs = sqlite3_vfs_find(0);
730213ca0a8Sdan 
731213ca0a8Sdan   if( objc<2 ){
732213ca0a8Sdan     Tcl_WrongNumArgs(interp, 1, objv, "SUB-COMMAND ...");
733213ca0a8Sdan     return TCL_ERROR;
734213ca0a8Sdan   }
73505accd22Sdan   if( pVfs->iVersion<3 || pVfs->xSetSystemCall==0 ){
73605accd22Sdan     Tcl_AppendResult(interp, "VFS does not support xSetSystemCall", 0);
73705accd22Sdan     rc = TCL_ERROR;
73805accd22Sdan   }else{
739213ca0a8Sdan     rc = Tcl_GetIndexFromObjStruct(interp,
740213ca0a8Sdan         objv[1], aCmd, sizeof(aCmd[0]), "sub-command", 0, &iCmd
741213ca0a8Sdan     );
74205accd22Sdan   }
743213ca0a8Sdan   if( rc!=TCL_OK ) return rc;
744213ca0a8Sdan   return aCmd[iCmd].xCmd(clientData, interp, objc, objv);
745213ca0a8Sdan }
746213ca0a8Sdan 
SqlitetestSyscall_Init(Tcl_Interp * interp)747213ca0a8Sdan int SqlitetestSyscall_Init(Tcl_Interp *interp){
748213ca0a8Sdan   struct SyscallCmd {
749213ca0a8Sdan     const char *zName;
750213ca0a8Sdan     Tcl_ObjCmdProc *xCmd;
751213ca0a8Sdan   } aCmd[] = {
752213ca0a8Sdan     { "test_syscall",     test_syscall},
753213ca0a8Sdan   };
754213ca0a8Sdan   int i;
755213ca0a8Sdan 
756213ca0a8Sdan   for(i=0; i<sizeof(aCmd)/sizeof(aCmd[0]); i++){
757213ca0a8Sdan     Tcl_CreateObjCommand(interp, aCmd[i].zName, aCmd[i].xCmd, 0, 0);
758213ca0a8Sdan   }
759213ca0a8Sdan   return TCL_OK;
760213ca0a8Sdan }
761213ca0a8Sdan #else
SqlitetestSyscall_Init(Tcl_Interp * interp)762213ca0a8Sdan int SqlitetestSyscall_Init(Tcl_Interp *interp){
763213ca0a8Sdan   return TCL_OK;
764213ca0a8Sdan }
765213ca0a8Sdan #endif
766