blob: 30e2cbb26fa96b4e5bf8c3495d70e5e32bcdb95e [file] [log] [blame]
drhbbd42a62004-05-22 17:41:58 +00001/*
2** 2004 May 22
3**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
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.
10**
11******************************************************************************
12**
13** This file contains code that is specific to Unix systems.
14*/
drhbbd42a62004-05-22 17:41:58 +000015#include "sqliteInt.h"
drheb206252004-10-01 02:00:31 +000016#if OS_UNIX /* This file is used on unix only */
drh66560ad2006-01-06 14:32:19 +000017
drhbfe66312006-10-03 17:40:40 +000018/* #define SQLITE_ENABLE_LOCKING_STYLE 0 */
19
drh9cbe6352005-11-29 03:13:21 +000020/*
21** These #defines should enable >2GB file support on Posix if the
22** underlying operating system supports it. If the OS lacks
drhf1a221e2006-01-15 17:27:17 +000023** large file support, these should be no-ops.
drh9cbe6352005-11-29 03:13:21 +000024**
25** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
26** on the compiler command line. This is necessary if you are compiling
27** on a recent machine (ex: RedHat 7.2) but you want your code to work
28** on an older machine (ex: RedHat 6.0). If you compile on RedHat 7.2
29** without this option, LFS is enable. But LFS does not exist in the kernel
30** in RedHat 6.0, so the code won't work. Hence, for maximum binary
31** portability you should omit LFS.
drh9cbe6352005-11-29 03:13:21 +000032*/
33#ifndef SQLITE_DISABLE_LFS
34# define _LARGE_FILE 1
35# ifndef _FILE_OFFSET_BITS
36# define _FILE_OFFSET_BITS 64
37# endif
38# define _LARGEFILE_SOURCE 1
39#endif
drhbbd42a62004-05-22 17:41:58 +000040
drh9cbe6352005-11-29 03:13:21 +000041/*
42** standard include files.
43*/
44#include <sys/types.h>
45#include <sys/stat.h>
46#include <fcntl.h>
47#include <unistd.h>
drhbbd42a62004-05-22 17:41:58 +000048#include <time.h>
drh19e2d372005-08-29 23:00:03 +000049#include <sys/time.h>
drhbbd42a62004-05-22 17:41:58 +000050#include <errno.h>
drhbfe66312006-10-03 17:40:40 +000051#ifdef SQLITE_ENABLE_LOCKING_STYLE
52#include <sys/ioctl.h>
53#include <sys/param.h>
54#include <sys/mount.h>
55#endif /* SQLITE_ENABLE_LOCKING_STYLE */
drh9cbe6352005-11-29 03:13:21 +000056
57/*
drhf1a221e2006-01-15 17:27:17 +000058** If we are to be thread-safe, include the pthreads header and define
59** the SQLITE_UNIX_THREADS macro.
drh9cbe6352005-11-29 03:13:21 +000060*/
drhd677b3d2007-08-20 22:48:41 +000061#if SQLITE_THREADSAFE
drh9cbe6352005-11-29 03:13:21 +000062# include <pthread.h>
63# define SQLITE_UNIX_THREADS 1
64#endif
65
66/*
67** Default permissions when creating a new file
68*/
69#ifndef SQLITE_DEFAULT_FILE_PERMISSIONS
70# define SQLITE_DEFAULT_FILE_PERMISSIONS 0644
71#endif
72
danielk1977b4b47412007-08-17 15:53:36 +000073/*
74** Maximum supported path-length.
75*/
76#define MAX_PATHNAME 512
drh9cbe6352005-11-29 03:13:21 +000077
78
79/*
danielk1977ad94b582007-08-20 06:44:22 +000080** The unixFile structure is subclass of sqlite3_file specific for the unix
drh054889e2005-11-30 03:20:31 +000081** protability layer.
drh9cbe6352005-11-29 03:13:21 +000082*/
drh054889e2005-11-30 03:20:31 +000083typedef struct unixFile unixFile;
84struct unixFile {
danielk197762079062007-08-15 17:08:46 +000085 sqlite3_io_methods const *pMethod; /* Always the first entry */
danielk1977967a4a12007-08-20 14:23:44 +000086#ifdef SQLITE_TEST
87 /* In test mode, increase the size of this structure a bit so that
88 ** it is larger than the struct CrashFile defined in test6.c.
89 */
90 char aPadding[32];
91#endif
drh9cbe6352005-11-29 03:13:21 +000092 struct openCnt *pOpen; /* Info about all open fd's on this inode */
93 struct lockInfo *pLock; /* Info about locks on this inode */
drhbfe66312006-10-03 17:40:40 +000094#ifdef SQLITE_ENABLE_LOCKING_STYLE
95 void *lockingContext; /* Locking style specific state */
96#endif /* SQLITE_ENABLE_LOCKING_STYLE */
drh9cbe6352005-11-29 03:13:21 +000097 int h; /* The file descriptor */
98 unsigned char locktype; /* The type of lock held on this fd */
drh9cbe6352005-11-29 03:13:21 +000099 int dirfd; /* File descriptor for the directory */
drhd677b3d2007-08-20 22:48:41 +0000100#if SQLITE_THREADSAFE
danielk1977ad94b582007-08-20 06:44:22 +0000101 pthread_t tid; /* The thread that "owns" this unixFile */
drh9cbe6352005-11-29 03:13:21 +0000102#endif
103};
104
drh0ccebe72005-06-07 22:22:50 +0000105/*
drh198bf392006-01-06 21:52:49 +0000106** Include code that is common to all os_*.c files
107*/
108#include "os_common.h"
109
110/*
drh0ccebe72005-06-07 22:22:50 +0000111** Define various macros that are missing from some systems.
112*/
drhbbd42a62004-05-22 17:41:58 +0000113#ifndef O_LARGEFILE
114# define O_LARGEFILE 0
115#endif
116#ifdef SQLITE_DISABLE_LFS
117# undef O_LARGEFILE
118# define O_LARGEFILE 0
119#endif
120#ifndef O_NOFOLLOW
121# define O_NOFOLLOW 0
122#endif
123#ifndef O_BINARY
124# define O_BINARY 0
125#endif
126
127/*
128** The DJGPP compiler environment looks mostly like Unix, but it
129** lacks the fcntl() system call. So redefine fcntl() to be something
130** that always succeeds. This means that locking does not occur under
danielk197726c5d792005-11-25 09:01:23 +0000131** DJGPP. But it's DOS - what did you expect?
drhbbd42a62004-05-22 17:41:58 +0000132*/
133#ifdef __DJGPP__
134# define fcntl(A,B,C) 0
135#endif
136
137/*
drh2b4b5962005-06-15 17:47:55 +0000138** The threadid macro resolves to the thread-id or to 0. Used for
139** testing and debugging only.
140*/
drhd677b3d2007-08-20 22:48:41 +0000141#if SQLITE_THREADSAFE
drh2b4b5962005-06-15 17:47:55 +0000142#define threadid pthread_self()
143#else
144#define threadid 0
145#endif
146
147/*
danielk1977ad94b582007-08-20 06:44:22 +0000148** Set or check the unixFile.tid field. This field is set when an unixFile
149** is first opened. All subsequent uses of the unixFile verify that the
150** same thread is operating on the unixFile. Some operating systems do
drh2b4b5962005-06-15 17:47:55 +0000151** not allow locks to be overridden by other threads and that restriction
152** means that sqlite3* database handles cannot be moved from one thread
153** to another. This logic makes sure a user does not try to do that
154** by mistake.
drhf1a221e2006-01-15 17:27:17 +0000155**
danielk1977ad94b582007-08-20 06:44:22 +0000156** Version 3.3.1 (2006-01-15): unixFile can be moved from one thread to
drhf1a221e2006-01-15 17:27:17 +0000157** another as long as we are running on a system that supports threads
158** overriding each others locks (which now the most common behavior)
danielk1977ad94b582007-08-20 06:44:22 +0000159** or if no locks are held. But the unixFile.pLock field needs to be
drhf1a221e2006-01-15 17:27:17 +0000160** recomputed because its key includes the thread-id. See the
161** transferOwnership() function below for additional information
drh2b4b5962005-06-15 17:47:55 +0000162*/
drhd677b3d2007-08-20 22:48:41 +0000163#if SQLITE_THREADSAFE
drh9cbe6352005-11-29 03:13:21 +0000164# define SET_THREADID(X) (X)->tid = pthread_self()
drh029b44b2006-01-15 00:13:15 +0000165# define CHECK_THREADID(X) (threadsOverrideEachOthersLocks==0 && \
166 !pthread_equal((X)->tid, pthread_self()))
drh2b4b5962005-06-15 17:47:55 +0000167#else
168# define SET_THREADID(X)
169# define CHECK_THREADID(X) 0
danielk197713adf8a2004-06-03 16:08:41 +0000170#endif
171
drhbbd42a62004-05-22 17:41:58 +0000172/*
173** Here is the dirt on POSIX advisory locks: ANSI STD 1003.1 (1996)
174** section 6.5.2.2 lines 483 through 490 specify that when a process
175** sets or clears a lock, that operation overrides any prior locks set
176** by the same process. It does not explicitly say so, but this implies
177** that it overrides locks set by the same process using a different
178** file descriptor. Consider this test case:
179**
180** int fd1 = open("./file1", O_RDWR|O_CREAT, 0644);
181** int fd2 = open("./file2", O_RDWR|O_CREAT, 0644);
182**
183** Suppose ./file1 and ./file2 are really the same file (because
184** one is a hard or symbolic link to the other) then if you set
185** an exclusive lock on fd1, then try to get an exclusive lock
186** on fd2, it works. I would have expected the second lock to
187** fail since there was already a lock on the file due to fd1.
188** But not so. Since both locks came from the same process, the
189** second overrides the first, even though they were on different
190** file descriptors opened on different file names.
191**
192** Bummer. If you ask me, this is broken. Badly broken. It means
193** that we cannot use POSIX locks to synchronize file access among
194** competing threads of the same process. POSIX locks will work fine
195** to synchronize access for threads in separate processes, but not
196** threads within the same process.
197**
198** To work around the problem, SQLite has to manage file locks internally
199** on its own. Whenever a new database is opened, we have to find the
200** specific inode of the database file (the inode is determined by the
201** st_dev and st_ino fields of the stat structure that fstat() fills in)
202** and check for locks already existing on that inode. When locks are
203** created or removed, we have to look at our own internal record of the
204** locks to see if another thread has previously set a lock on that same
205** inode.
206**
danielk1977ad94b582007-08-20 06:44:22 +0000207** The sqlite3_file structure for POSIX is no longer just an integer file
drhbbd42a62004-05-22 17:41:58 +0000208** descriptor. It is now a structure that holds the integer file
209** descriptor and a pointer to a structure that describes the internal
210** locks on the corresponding inode. There is one locking structure
danielk1977ad94b582007-08-20 06:44:22 +0000211** per inode, so if the same inode is opened twice, both unixFile structures
drhbbd42a62004-05-22 17:41:58 +0000212** point to the same locking structure. The locking structure keeps
213** a reference count (so we will know when to delete it) and a "cnt"
214** field that tells us its internal lock status. cnt==0 means the
215** file is unlocked. cnt==-1 means the file has an exclusive lock.
216** cnt>0 means there are cnt shared locks on the file.
217**
218** Any attempt to lock or unlock a file first checks the locking
219** structure. The fcntl() system call is only invoked to set a
220** POSIX lock if the internal lock structure transitions between
221** a locked and an unlocked state.
222**
223** 2004-Jan-11:
224** More recent discoveries about POSIX advisory locks. (The more
225** I discover, the more I realize the a POSIX advisory locks are
226** an abomination.)
227**
228** If you close a file descriptor that points to a file that has locks,
229** all locks on that file that are owned by the current process are
danielk1977ad94b582007-08-20 06:44:22 +0000230** released. To work around this problem, each unixFile structure contains
drhbbd42a62004-05-22 17:41:58 +0000231** a pointer to an openCnt structure. There is one openCnt structure
danielk1977ad94b582007-08-20 06:44:22 +0000232** per open inode, which means that multiple unixFile can point to a single
233** openCnt. When an attempt is made to close an unixFile, if there are
234** other unixFile open on the same inode that are holding locks, the call
drhbbd42a62004-05-22 17:41:58 +0000235** to close() the file descriptor is deferred until all of the locks clear.
236** The openCnt structure keeps a list of file descriptors that need to
237** be closed and that list is walked (and cleared) when the last lock
238** clears.
239**
240** First, under Linux threads, because each thread has a separate
241** process ID, lock operations in one thread do not override locks
242** to the same file in other threads. Linux threads behave like
243** separate processes in this respect. But, if you close a file
244** descriptor in linux threads, all locks are cleared, even locks
245** on other threads and even though the other threads have different
246** process IDs. Linux threads is inconsistent in this respect.
247** (I'm beginning to think that linux threads is an abomination too.)
248** The consequence of this all is that the hash table for the lockInfo
249** structure has to include the process id as part of its key because
250** locks in different threads are treated as distinct. But the
251** openCnt structure should not include the process id in its
252** key because close() clears lock on all threads, not just the current
253** thread. Were it not for this goofiness in linux threads, we could
254** combine the lockInfo and openCnt structures into a single structure.
drh5fdae772004-06-29 03:29:00 +0000255**
256** 2004-Jun-28:
257** On some versions of linux, threads can override each others locks.
258** On others not. Sometimes you can change the behavior on the same
259** system by setting the LD_ASSUME_KERNEL environment variable. The
260** POSIX standard is silent as to which behavior is correct, as far
261** as I can tell, so other versions of unix might show the same
262** inconsistency. There is no little doubt in my mind that posix
263** advisory locks and linux threads are profoundly broken.
264**
265** To work around the inconsistencies, we have to test at runtime
266** whether or not threads can override each others locks. This test
267** is run once, the first time any lock is attempted. A static
268** variable is set to record the results of this test for future
269** use.
drhbbd42a62004-05-22 17:41:58 +0000270*/
271
272/*
273** An instance of the following structure serves as the key used
drh5fdae772004-06-29 03:29:00 +0000274** to locate a particular lockInfo structure given its inode.
275**
276** If threads cannot override each others locks, then we set the
277** lockKey.tid field to the thread ID. If threads can override
drhf1a221e2006-01-15 17:27:17 +0000278** each others locks then tid is always set to zero. tid is omitted
279** if we compile without threading support.
drhbbd42a62004-05-22 17:41:58 +0000280*/
281struct lockKey {
drh5fdae772004-06-29 03:29:00 +0000282 dev_t dev; /* Device number */
283 ino_t ino; /* Inode number */
drhd677b3d2007-08-20 22:48:41 +0000284#if SQLITE_THREADSAFE
drhd9cb6ac2005-10-20 07:28:17 +0000285 pthread_t tid; /* Thread ID or zero if threads can override each other */
drh5fdae772004-06-29 03:29:00 +0000286#endif
drhbbd42a62004-05-22 17:41:58 +0000287};
288
289/*
290** An instance of the following structure is allocated for each open
291** inode on each thread with a different process ID. (Threads have
292** different process IDs on linux, but not on most other unixes.)
293**
danielk1977ad94b582007-08-20 06:44:22 +0000294** A single inode can have multiple file descriptors, so each unixFile
drhbbd42a62004-05-22 17:41:58 +0000295** structure contains a pointer to an instance of this object and this
danielk1977ad94b582007-08-20 06:44:22 +0000296** object keeps a count of the number of unixFile pointing to it.
drhbbd42a62004-05-22 17:41:58 +0000297*/
298struct lockInfo {
299 struct lockKey key; /* The lookup key */
drh2ac3ee92004-06-07 16:27:46 +0000300 int cnt; /* Number of SHARED locks held */
danielk19779a1d0ab2004-06-01 14:09:28 +0000301 int locktype; /* One of SHARED_LOCK, RESERVED_LOCK etc. */
drhbbd42a62004-05-22 17:41:58 +0000302 int nRef; /* Number of pointers to this structure */
303};
304
305/*
306** An instance of the following structure serves as the key used
307** to locate a particular openCnt structure given its inode. This
drh5fdae772004-06-29 03:29:00 +0000308** is the same as the lockKey except that the thread ID is omitted.
drhbbd42a62004-05-22 17:41:58 +0000309*/
310struct openKey {
311 dev_t dev; /* Device number */
312 ino_t ino; /* Inode number */
313};
314
315/*
316** An instance of the following structure is allocated for each open
317** inode. This structure keeps track of the number of locks on that
318** inode. If a close is attempted against an inode that is holding
319** locks, the close is deferred until all locks clear by adding the
320** file descriptor to be closed to the pending list.
321*/
322struct openCnt {
323 struct openKey key; /* The lookup key */
324 int nRef; /* Number of pointers to this structure */
325 int nLock; /* Number of outstanding locks */
326 int nPending; /* Number of pending close() operations */
327 int *aPending; /* Malloced space holding fd's awaiting a close() */
328};
329
330/*
drhf1a221e2006-01-15 17:27:17 +0000331** These hash tables map inodes and file descriptors (really, lockKey and
332** openKey structures) into lockInfo and openCnt structures. Access to
333** these hash tables must be protected by a mutex.
drhbbd42a62004-05-22 17:41:58 +0000334*/
drh17435752007-08-16 04:30:38 +0000335static Hash lockHash = {SQLITE_HASH_BINARY, 0, 0, 0, 0, 0};
336static Hash openHash = {SQLITE_HASH_BINARY, 0, 0, 0, 0, 0};
drh5fdae772004-06-29 03:29:00 +0000337
drhbfe66312006-10-03 17:40:40 +0000338#ifdef SQLITE_ENABLE_LOCKING_STYLE
339/*
340** The locking styles are associated with the different file locking
341** capabilities supported by different file systems.
342**
343** POSIX locking style fully supports shared and exclusive byte-range locks
344** ADP locking only supports exclusive byte-range locks
345** FLOCK only supports a single file-global exclusive lock
346** DOTLOCK isn't a true locking style, it refers to the use of a special
347** file named the same as the database file with a '.lock' extension, this
348** can be used on file systems that do not offer any reliable file locking
349** NO locking means that no locking will be attempted, this is only used for
350** read-only file systems currently
351** UNSUPPORTED means that no locking will be attempted, this is only used for
352** file systems that are known to be unsupported
353*/
354typedef enum {
drhfd131da2007-08-07 17:13:03 +0000355 posixLockingStyle = 0, /* standard posix-advisory locks */
356 afpLockingStyle, /* use afp locks */
357 flockLockingStyle, /* use flock() */
358 dotlockLockingStyle, /* use <file>.lock files */
359 noLockingStyle, /* useful for read-only file system */
360 unsupportedLockingStyle /* indicates unsupported file system */
drhbfe66312006-10-03 17:40:40 +0000361} sqlite3LockingStyle;
362#endif /* SQLITE_ENABLE_LOCKING_STYLE */
363
danielk1977ad94b582007-08-20 06:44:22 +0000364/*
365** Helper functions to obtain and relinquish the global mutex.
366*/
danielk1977b4b47412007-08-17 15:53:36 +0000367static void enterMutex(){
drh51fc3472007-08-21 13:51:23 +0000368 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MASTER));
danielk1977b4b47412007-08-17 15:53:36 +0000369}
370static void leaveMutex(){
drh51fc3472007-08-21 13:51:23 +0000371 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MASTER));
danielk1977b4b47412007-08-17 15:53:36 +0000372}
373
drhd677b3d2007-08-20 22:48:41 +0000374#if SQLITE_THREADSAFE
drh5fdae772004-06-29 03:29:00 +0000375/*
376** This variable records whether or not threads can override each others
377** locks.
378**
379** 0: No. Threads cannot override each others locks.
380** 1: Yes. Threads can override each others locks.
381** -1: We don't know yet.
drhf1a221e2006-01-15 17:27:17 +0000382**
drh5062d3a2006-01-31 23:03:35 +0000383** On some systems, we know at compile-time if threads can override each
384** others locks. On those systems, the SQLITE_THREAD_OVERRIDE_LOCK macro
385** will be set appropriately. On other systems, we have to check at
386** runtime. On these latter systems, SQLTIE_THREAD_OVERRIDE_LOCK is
387** undefined.
388**
drhf1a221e2006-01-15 17:27:17 +0000389** This variable normally has file scope only. But during testing, we make
390** it a global so that the test code can change its value in order to verify
391** that the right stuff happens in either case.
drh5fdae772004-06-29 03:29:00 +0000392*/
drh5062d3a2006-01-31 23:03:35 +0000393#ifndef SQLITE_THREAD_OVERRIDE_LOCK
394# define SQLITE_THREAD_OVERRIDE_LOCK -1
395#endif
drh029b44b2006-01-15 00:13:15 +0000396#ifdef SQLITE_TEST
drh5062d3a2006-01-31 23:03:35 +0000397int threadsOverrideEachOthersLocks = SQLITE_THREAD_OVERRIDE_LOCK;
drh029b44b2006-01-15 00:13:15 +0000398#else
drh5062d3a2006-01-31 23:03:35 +0000399static int threadsOverrideEachOthersLocks = SQLITE_THREAD_OVERRIDE_LOCK;
drh029b44b2006-01-15 00:13:15 +0000400#endif
drh5fdae772004-06-29 03:29:00 +0000401
402/*
403** This structure holds information passed into individual test
404** threads by the testThreadLockingBehavior() routine.
405*/
406struct threadTestData {
407 int fd; /* File to be locked */
408 struct flock lock; /* The locking operation */
409 int result; /* Result of the locking operation */
410};
411
drh2b4b5962005-06-15 17:47:55 +0000412#ifdef SQLITE_LOCK_TRACE
413/*
414** Print out information about all locking operations.
415**
416** This routine is used for troubleshooting locks on multithreaded
417** platforms. Enable by compiling with the -DSQLITE_LOCK_TRACE
418** command-line option on the compiler. This code is normally
drhf1a221e2006-01-15 17:27:17 +0000419** turned off.
drh2b4b5962005-06-15 17:47:55 +0000420*/
421static int lockTrace(int fd, int op, struct flock *p){
422 char *zOpName, *zType;
423 int s;
424 int savedErrno;
425 if( op==F_GETLK ){
426 zOpName = "GETLK";
427 }else if( op==F_SETLK ){
428 zOpName = "SETLK";
429 }else{
430 s = fcntl(fd, op, p);
431 sqlite3DebugPrintf("fcntl unknown %d %d %d\n", fd, op, s);
432 return s;
433 }
434 if( p->l_type==F_RDLCK ){
435 zType = "RDLCK";
436 }else if( p->l_type==F_WRLCK ){
437 zType = "WRLCK";
438 }else if( p->l_type==F_UNLCK ){
439 zType = "UNLCK";
440 }else{
441 assert( 0 );
442 }
443 assert( p->l_whence==SEEK_SET );
444 s = fcntl(fd, op, p);
445 savedErrno = errno;
446 sqlite3DebugPrintf("fcntl %d %d %s %s %d %d %d %d\n",
447 threadid, fd, zOpName, zType, (int)p->l_start, (int)p->l_len,
448 (int)p->l_pid, s);
drhe2396a12007-03-29 20:19:58 +0000449 if( s==(-1) && op==F_SETLK && (p->l_type==F_RDLCK || p->l_type==F_WRLCK) ){
drh2b4b5962005-06-15 17:47:55 +0000450 struct flock l2;
451 l2 = *p;
452 fcntl(fd, F_GETLK, &l2);
453 if( l2.l_type==F_RDLCK ){
454 zType = "RDLCK";
455 }else if( l2.l_type==F_WRLCK ){
456 zType = "WRLCK";
457 }else if( l2.l_type==F_UNLCK ){
458 zType = "UNLCK";
459 }else{
460 assert( 0 );
461 }
462 sqlite3DebugPrintf("fcntl-failure-reason: %s %d %d %d\n",
463 zType, (int)l2.l_start, (int)l2.l_len, (int)l2.l_pid);
464 }
465 errno = savedErrno;
466 return s;
467}
468#define fcntl lockTrace
469#endif /* SQLITE_LOCK_TRACE */
470
drh5fdae772004-06-29 03:29:00 +0000471/*
472** The testThreadLockingBehavior() routine launches two separate
473** threads on this routine. This routine attempts to lock a file
474** descriptor then returns. The success or failure of that attempt
475** allows the testThreadLockingBehavior() procedure to determine
476** whether or not threads can override each others locks.
477*/
478static void *threadLockingTest(void *pArg){
479 struct threadTestData *pData = (struct threadTestData*)pArg;
480 pData->result = fcntl(pData->fd, F_SETLK, &pData->lock);
481 return pArg;
482}
483
484/*
485** This procedure attempts to determine whether or not threads
486** can override each others locks then sets the
487** threadsOverrideEachOthersLocks variable appropriately.
488*/
danielk19774d5238f2006-01-27 06:32:00 +0000489static void testThreadLockingBehavior(int fd_orig){
drh5fdae772004-06-29 03:29:00 +0000490 int fd;
491 struct threadTestData d[2];
492 pthread_t t[2];
493
494 fd = dup(fd_orig);
495 if( fd<0 ) return;
496 memset(d, 0, sizeof(d));
497 d[0].fd = fd;
498 d[0].lock.l_type = F_RDLCK;
499 d[0].lock.l_len = 1;
500 d[0].lock.l_start = 0;
501 d[0].lock.l_whence = SEEK_SET;
502 d[1] = d[0];
503 d[1].lock.l_type = F_WRLCK;
504 pthread_create(&t[0], 0, threadLockingTest, &d[0]);
505 pthread_create(&t[1], 0, threadLockingTest, &d[1]);
506 pthread_join(t[0], 0);
507 pthread_join(t[1], 0);
508 close(fd);
509 threadsOverrideEachOthersLocks = d[0].result==0 && d[1].result==0;
510}
drhd677b3d2007-08-20 22:48:41 +0000511#endif /* SQLITE_THREADSAFE */
drh5fdae772004-06-29 03:29:00 +0000512
drhbbd42a62004-05-22 17:41:58 +0000513/*
514** Release a lockInfo structure previously allocated by findLockInfo().
515*/
516static void releaseLockInfo(struct lockInfo *pLock){
drhbfe66312006-10-03 17:40:40 +0000517 if (pLock == NULL)
518 return;
drhbbd42a62004-05-22 17:41:58 +0000519 pLock->nRef--;
520 if( pLock->nRef==0 ){
521 sqlite3HashInsert(&lockHash, &pLock->key, sizeof(pLock->key), 0);
drh17435752007-08-16 04:30:38 +0000522 sqlite3_free(pLock);
drhbbd42a62004-05-22 17:41:58 +0000523 }
524}
525
526/*
527** Release a openCnt structure previously allocated by findLockInfo().
528*/
529static void releaseOpenCnt(struct openCnt *pOpen){
drhbfe66312006-10-03 17:40:40 +0000530 if (pOpen == NULL)
531 return;
drhbbd42a62004-05-22 17:41:58 +0000532 pOpen->nRef--;
533 if( pOpen->nRef==0 ){
534 sqlite3HashInsert(&openHash, &pOpen->key, sizeof(pOpen->key), 0);
drh64b1bea2006-01-15 02:30:57 +0000535 free(pOpen->aPending);
drh17435752007-08-16 04:30:38 +0000536 sqlite3_free(pOpen);
drhbbd42a62004-05-22 17:41:58 +0000537 }
538}
539
drhbfe66312006-10-03 17:40:40 +0000540#ifdef SQLITE_ENABLE_LOCKING_STYLE
541/*
542** Tests a byte-range locking query to see if byte range locks are
543** supported, if not we fall back to dotlockLockingStyle.
544*/
danielk1977ad94b582007-08-20 06:44:22 +0000545static sqlite3LockingStyle sqlite3TestLockingStyle(
546 const char *filePath,
547 int fd
548){
drhbfe66312006-10-03 17:40:40 +0000549 /* test byte-range lock using fcntl */
550 struct flock lockInfo;
551
552 lockInfo.l_len = 1;
553 lockInfo.l_start = 0;
554 lockInfo.l_whence = SEEK_SET;
555 lockInfo.l_type = F_RDLCK;
556
danielk1977ad94b582007-08-20 06:44:22 +0000557 if( fcntl(fd, F_GETLK, &lockInfo)!=-1 ) {
drhbfe66312006-10-03 17:40:40 +0000558 return posixLockingStyle;
559 }
560
561 /* testing for flock can give false positives. So if if the above test
562 ** fails, then we fall back to using dot-lock style locking.
563 */
564 return dotlockLockingStyle;
565}
566
567/*
568** Examines the f_fstypename entry in the statfs structure as returned by
569** stat() for the file system hosting the database file, assigns the
570** appropriate locking style based on it's value. These values and
571** assignments are based on Darwin/OSX behavior and have not been tested on
572** other systems.
573*/
danielk1977ad94b582007-08-20 06:44:22 +0000574static sqlite3LockingStyle sqlite3DetectLockingStyle(
575 const char *filePath,
576 int fd
577){
drhbfe66312006-10-03 17:40:40 +0000578
579#ifdef SQLITE_FIXED_LOCKING_STYLE
580 return (sqlite3LockingStyle)SQLITE_FIXED_LOCKING_STYLE;
581#else
582 struct statfs fsInfo;
583
584 if (statfs(filePath, &fsInfo) == -1)
585 return sqlite3TestLockingStyle(filePath, fd);
586
587 if (fsInfo.f_flags & MNT_RDONLY)
588 return noLockingStyle;
589
590 if( (!strcmp(fsInfo.f_fstypename, "hfs")) ||
591 (!strcmp(fsInfo.f_fstypename, "ufs")) )
drhfd131da2007-08-07 17:13:03 +0000592 return posixLockingStyle;
drhbfe66312006-10-03 17:40:40 +0000593
594 if(!strcmp(fsInfo.f_fstypename, "afpfs"))
595 return afpLockingStyle;
596
597 if(!strcmp(fsInfo.f_fstypename, "nfs"))
598 return sqlite3TestLockingStyle(filePath, fd);
599
600 if(!strcmp(fsInfo.f_fstypename, "smbfs"))
601 return flockLockingStyle;
602
603 if(!strcmp(fsInfo.f_fstypename, "msdos"))
604 return dotlockLockingStyle;
605
606 if(!strcmp(fsInfo.f_fstypename, "webdav"))
607 return unsupportedLockingStyle;
608
609 return sqlite3TestLockingStyle(filePath, fd);
drh3b62b2f2007-06-08 18:27:03 +0000610#endif /* SQLITE_FIXED_LOCKING_STYLE */
drhbfe66312006-10-03 17:40:40 +0000611}
612
613#endif /* SQLITE_ENABLE_LOCKING_STYLE */
614
drhbbd42a62004-05-22 17:41:58 +0000615/*
616** Given a file descriptor, locate lockInfo and openCnt structures that
drh029b44b2006-01-15 00:13:15 +0000617** describes that file descriptor. Create new ones if necessary. The
618** return values might be uninitialized if an error occurs.
drhbbd42a62004-05-22 17:41:58 +0000619**
620** Return the number of errors.
621*/
drh38f82712004-06-18 17:10:16 +0000622static int findLockInfo(
drhbbd42a62004-05-22 17:41:58 +0000623 int fd, /* The file descriptor used in the key */
624 struct lockInfo **ppLock, /* Return the lockInfo structure here */
drh5fdae772004-06-29 03:29:00 +0000625 struct openCnt **ppOpen /* Return the openCnt structure here */
drhbbd42a62004-05-22 17:41:58 +0000626){
627 int rc;
628 struct lockKey key1;
629 struct openKey key2;
630 struct stat statbuf;
631 struct lockInfo *pLock;
632 struct openCnt *pOpen;
633 rc = fstat(fd, &statbuf);
634 if( rc!=0 ) return 1;
danielk1977441b09a2006-01-05 13:48:29 +0000635
drhbbd42a62004-05-22 17:41:58 +0000636 memset(&key1, 0, sizeof(key1));
637 key1.dev = statbuf.st_dev;
638 key1.ino = statbuf.st_ino;
drhd677b3d2007-08-20 22:48:41 +0000639#if SQLITE_THREADSAFE
drh5fdae772004-06-29 03:29:00 +0000640 if( threadsOverrideEachOthersLocks<0 ){
641 testThreadLockingBehavior(fd);
642 }
643 key1.tid = threadsOverrideEachOthersLocks ? 0 : pthread_self();
644#endif
drhbbd42a62004-05-22 17:41:58 +0000645 memset(&key2, 0, sizeof(key2));
646 key2.dev = statbuf.st_dev;
647 key2.ino = statbuf.st_ino;
648 pLock = (struct lockInfo*)sqlite3HashFind(&lockHash, &key1, sizeof(key1));
649 if( pLock==0 ){
650 struct lockInfo *pOld;
drh17435752007-08-16 04:30:38 +0000651 pLock = sqlite3_malloc( sizeof(*pLock) );
danielk1977441b09a2006-01-05 13:48:29 +0000652 if( pLock==0 ){
653 rc = 1;
654 goto exit_findlockinfo;
655 }
drhbbd42a62004-05-22 17:41:58 +0000656 pLock->key = key1;
657 pLock->nRef = 1;
658 pLock->cnt = 0;
danielk19779a1d0ab2004-06-01 14:09:28 +0000659 pLock->locktype = 0;
drhbbd42a62004-05-22 17:41:58 +0000660 pOld = sqlite3HashInsert(&lockHash, &pLock->key, sizeof(key1), pLock);
661 if( pOld!=0 ){
662 assert( pOld==pLock );
drh17435752007-08-16 04:30:38 +0000663 sqlite3_free(pLock);
danielk1977441b09a2006-01-05 13:48:29 +0000664 rc = 1;
665 goto exit_findlockinfo;
drhbbd42a62004-05-22 17:41:58 +0000666 }
667 }else{
668 pLock->nRef++;
669 }
670 *ppLock = pLock;
drh029b44b2006-01-15 00:13:15 +0000671 if( ppOpen!=0 ){
672 pOpen = (struct openCnt*)sqlite3HashFind(&openHash, &key2, sizeof(key2));
drhbbd42a62004-05-22 17:41:58 +0000673 if( pOpen==0 ){
drh029b44b2006-01-15 00:13:15 +0000674 struct openCnt *pOld;
drh17435752007-08-16 04:30:38 +0000675 pOpen = sqlite3_malloc( sizeof(*pOpen) );
drh029b44b2006-01-15 00:13:15 +0000676 if( pOpen==0 ){
677 releaseLockInfo(pLock);
678 rc = 1;
679 goto exit_findlockinfo;
680 }
681 pOpen->key = key2;
682 pOpen->nRef = 1;
683 pOpen->nLock = 0;
684 pOpen->nPending = 0;
685 pOpen->aPending = 0;
686 pOld = sqlite3HashInsert(&openHash, &pOpen->key, sizeof(key2), pOpen);
687 if( pOld!=0 ){
688 assert( pOld==pOpen );
drh17435752007-08-16 04:30:38 +0000689 sqlite3_free(pOpen);
drh029b44b2006-01-15 00:13:15 +0000690 releaseLockInfo(pLock);
691 rc = 1;
692 goto exit_findlockinfo;
693 }
694 }else{
695 pOpen->nRef++;
drhbbd42a62004-05-22 17:41:58 +0000696 }
drh029b44b2006-01-15 00:13:15 +0000697 *ppOpen = pOpen;
drhbbd42a62004-05-22 17:41:58 +0000698 }
danielk1977441b09a2006-01-05 13:48:29 +0000699
700exit_findlockinfo:
danielk1977441b09a2006-01-05 13:48:29 +0000701 return rc;
drhbbd42a62004-05-22 17:41:58 +0000702}
703
drh64b1bea2006-01-15 02:30:57 +0000704#ifdef SQLITE_DEBUG
705/*
706** Helper function for printing out trace information from debugging
707** binaries. This returns the string represetation of the supplied
708** integer lock-type.
709*/
710static const char *locktypeName(int locktype){
711 switch( locktype ){
712 case NO_LOCK: return "NONE";
713 case SHARED_LOCK: return "SHARED";
714 case RESERVED_LOCK: return "RESERVED";
715 case PENDING_LOCK: return "PENDING";
716 case EXCLUSIVE_LOCK: return "EXCLUSIVE";
717 }
718 return "ERROR";
719}
720#endif
721
drhbbd42a62004-05-22 17:41:58 +0000722/*
drh029b44b2006-01-15 00:13:15 +0000723** If we are currently in a different thread than the thread that the
724** unixFile argument belongs to, then transfer ownership of the unixFile
725** over to the current thread.
726**
727** A unixFile is only owned by a thread on systems where one thread is
728** unable to override locks created by a different thread. RedHat9 is
729** an example of such a system.
730**
731** Ownership transfer is only allowed if the unixFile is currently unlocked.
732** If the unixFile is locked and an ownership is wrong, then return
drhf1a221e2006-01-15 17:27:17 +0000733** SQLITE_MISUSE. SQLITE_OK is returned if everything works.
drh029b44b2006-01-15 00:13:15 +0000734*/
drhd677b3d2007-08-20 22:48:41 +0000735#if SQLITE_THREADSAFE
drh029b44b2006-01-15 00:13:15 +0000736static int transferOwnership(unixFile *pFile){
drh64b1bea2006-01-15 02:30:57 +0000737 int rc;
drh029b44b2006-01-15 00:13:15 +0000738 pthread_t hSelf;
739 if( threadsOverrideEachOthersLocks ){
740 /* Ownership transfers not needed on this system */
741 return SQLITE_OK;
742 }
743 hSelf = pthread_self();
744 if( pthread_equal(pFile->tid, hSelf) ){
745 /* We are still in the same thread */
drh4f0c5872007-03-26 22:05:01 +0000746 OSTRACE1("No-transfer, same thread\n");
drh029b44b2006-01-15 00:13:15 +0000747 return SQLITE_OK;
748 }
749 if( pFile->locktype!=NO_LOCK ){
750 /* We cannot change ownership while we are holding a lock! */
751 return SQLITE_MISUSE;
752 }
drh4f0c5872007-03-26 22:05:01 +0000753 OSTRACE4("Transfer ownership of %d from %d to %d\n",
754 pFile->h, pFile->tid, hSelf);
drh029b44b2006-01-15 00:13:15 +0000755 pFile->tid = hSelf;
drhbfe66312006-10-03 17:40:40 +0000756 if (pFile->pLock != NULL) {
757 releaseLockInfo(pFile->pLock);
758 rc = findLockInfo(pFile->h, &pFile->pLock, 0);
drh4f0c5872007-03-26 22:05:01 +0000759 OSTRACE5("LOCK %d is now %s(%s,%d)\n", pFile->h,
drhbfe66312006-10-03 17:40:40 +0000760 locktypeName(pFile->locktype),
761 locktypeName(pFile->pLock->locktype), pFile->pLock->cnt);
762 return rc;
763 } else {
764 return SQLITE_OK;
765 }
drh029b44b2006-01-15 00:13:15 +0000766}
767#else
drhf1a221e2006-01-15 17:27:17 +0000768 /* On single-threaded builds, ownership transfer is a no-op */
drh029b44b2006-01-15 00:13:15 +0000769# define transferOwnership(X) SQLITE_OK
770#endif
771
772/*
danielk19772a6bdf62007-08-20 16:07:00 +0000773** Seek to the offset passed as the second argument, then read cnt
774** bytes into pBuf. Return the number of bytes actually read.
drhb912b282006-03-23 22:42:20 +0000775*/
danielk197762079062007-08-15 17:08:46 +0000776static int seekAndRead(unixFile *id, sqlite3_int64 offset, void *pBuf, int cnt){
drhb912b282006-03-23 22:42:20 +0000777 int got;
drh8ebf6702007-02-06 11:11:08 +0000778 i64 newOffset;
drh15d00c42007-02-27 02:01:14 +0000779 TIMER_START;
drh8350a212007-03-22 15:22:06 +0000780#if defined(USE_PREAD)
danielk197762079062007-08-15 17:08:46 +0000781 got = pread(id->h, pBuf, cnt, offset);
drhbb5f18d2007-04-06 18:23:17 +0000782 SimulateIOError( got = -1 );
drh8350a212007-03-22 15:22:06 +0000783#elif defined(USE_PREAD64)
danielk197762079062007-08-15 17:08:46 +0000784 got = pread64(id->h, pBuf, cnt, offset);
drhbb5f18d2007-04-06 18:23:17 +0000785 SimulateIOError( got = -1 );
drhb912b282006-03-23 22:42:20 +0000786#else
danielk197762079062007-08-15 17:08:46 +0000787 newOffset = lseek(id->h, offset, SEEK_SET);
drhbb5f18d2007-04-06 18:23:17 +0000788 SimulateIOError( newOffset-- );
danielk197762079062007-08-15 17:08:46 +0000789 if( newOffset!=offset ){
drh8ebf6702007-02-06 11:11:08 +0000790 return -1;
791 }
drhb912b282006-03-23 22:42:20 +0000792 got = read(id->h, pBuf, cnt);
793#endif
drh15d00c42007-02-27 02:01:14 +0000794 TIMER_END;
danielk1977967a4a12007-08-20 14:23:44 +0000795 OSTRACE5("READ %-3d %5d %7lld %d\n", id->h, got, offset, TIMER_ELAPSED);
drhb912b282006-03-23 22:42:20 +0000796 return got;
797}
798
799/*
drhbbd42a62004-05-22 17:41:58 +0000800** Read data from a file into a buffer. Return SQLITE_OK if all
801** bytes were read successfully and SQLITE_IOERR if anything goes
802** wrong.
803*/
danielk197762079062007-08-15 17:08:46 +0000804static int unixRead(
805 sqlite3_file *id,
806 void *pBuf,
807 int amt,
808 sqlite3_int64 offset
809){
drhbbd42a62004-05-22 17:41:58 +0000810 int got;
drh9cbe6352005-11-29 03:13:21 +0000811 assert( id );
danielk197762079062007-08-15 17:08:46 +0000812 got = seekAndRead((unixFile*)id, offset, pBuf, amt);
drhbbd42a62004-05-22 17:41:58 +0000813 if( got==amt ){
814 return SQLITE_OK;
drh4ac285a2006-09-15 07:28:50 +0000815 }else if( got<0 ){
816 return SQLITE_IOERR_READ;
drhbbd42a62004-05-22 17:41:58 +0000817 }else{
drhbafda092007-01-03 23:36:22 +0000818 memset(&((char*)pBuf)[got], 0, amt-got);
drh4ac285a2006-09-15 07:28:50 +0000819 return SQLITE_IOERR_SHORT_READ;
drhbbd42a62004-05-22 17:41:58 +0000820 }
821}
822
823/*
drhb912b282006-03-23 22:42:20 +0000824** Seek to the offset in id->offset then read cnt bytes into pBuf.
825** Return the number of bytes actually read. Update the offset.
826*/
danielk197762079062007-08-15 17:08:46 +0000827static int seekAndWrite(unixFile *id, i64 offset, const void *pBuf, int cnt){
drhb912b282006-03-23 22:42:20 +0000828 int got;
drh8ebf6702007-02-06 11:11:08 +0000829 i64 newOffset;
drh15d00c42007-02-27 02:01:14 +0000830 TIMER_START;
drh8350a212007-03-22 15:22:06 +0000831#if defined(USE_PREAD)
danielk197762079062007-08-15 17:08:46 +0000832 got = pwrite(id->h, pBuf, cnt, offset);
drh8350a212007-03-22 15:22:06 +0000833#elif defined(USE_PREAD64)
danielk197762079062007-08-15 17:08:46 +0000834 got = pwrite64(id->h, pBuf, cnt, offset);
drhb912b282006-03-23 22:42:20 +0000835#else
danielk197762079062007-08-15 17:08:46 +0000836 newOffset = lseek(id->h, offset, SEEK_SET);
837 if( newOffset!=offset ){
drh8ebf6702007-02-06 11:11:08 +0000838 return -1;
839 }
drhb912b282006-03-23 22:42:20 +0000840 got = write(id->h, pBuf, cnt);
841#endif
drh15d00c42007-02-27 02:01:14 +0000842 TIMER_END;
danielk197762079062007-08-15 17:08:46 +0000843 OSTRACE5("WRITE %-3d %5d %7lld %d\n", id->h, got, offset, TIMER_ELAPSED);
drhb912b282006-03-23 22:42:20 +0000844 return got;
845}
846
847
848/*
drhbbd42a62004-05-22 17:41:58 +0000849** Write data from a buffer into a file. Return SQLITE_OK on success
850** or some other error code on failure.
851*/
danielk197762079062007-08-15 17:08:46 +0000852static int unixWrite(
853 sqlite3_file *id,
854 const void *pBuf,
855 int amt,
856 sqlite3_int64 offset
857){
drhbbd42a62004-05-22 17:41:58 +0000858 int wrote = 0;
drh9cbe6352005-11-29 03:13:21 +0000859 assert( id );
drh4c7f9412005-02-03 00:29:47 +0000860 assert( amt>0 );
danielk197762079062007-08-15 17:08:46 +0000861 while( amt>0 && (wrote = seekAndWrite((unixFile*)id, offset, pBuf, amt))>0 ){
drhbbd42a62004-05-22 17:41:58 +0000862 amt -= wrote;
danielk197762079062007-08-15 17:08:46 +0000863 offset += wrote;
drhbbd42a62004-05-22 17:41:58 +0000864 pBuf = &((char*)pBuf)[wrote];
865 }
drh59685932006-09-14 13:47:11 +0000866 SimulateIOError(( wrote=(-1), amt=1 ));
867 SimulateDiskfullError(( wrote=0, amt=1 ));
drhbbd42a62004-05-22 17:41:58 +0000868 if( amt>0 ){
drh59685932006-09-14 13:47:11 +0000869 if( wrote<0 ){
drh4ac285a2006-09-15 07:28:50 +0000870 return SQLITE_IOERR_WRITE;
drh59685932006-09-14 13:47:11 +0000871 }else{
872 return SQLITE_FULL;
873 }
drhbbd42a62004-05-22 17:41:58 +0000874 }
875 return SQLITE_OK;
876}
877
drhb851b2c2005-03-10 14:11:12 +0000878#ifdef SQLITE_TEST
879/*
880** Count the number of fullsyncs and normal syncs. This is used to test
881** that syncs and fullsyncs are occuring at the right times.
882*/
883int sqlite3_sync_count = 0;
884int sqlite3_fullsync_count = 0;
885#endif
886
drhf2f23912005-10-05 10:29:36 +0000887/*
888** Use the fdatasync() API only if the HAVE_FDATASYNC macro is defined.
889** Otherwise use fsync() in its place.
890*/
891#ifndef HAVE_FDATASYNC
892# define fdatasync fsync
893#endif
894
drhac530b12006-02-11 01:25:50 +0000895/*
896** Define HAVE_FULLFSYNC to 0 or 1 depending on whether or not
897** the F_FULLFSYNC macro is defined. F_FULLFSYNC is currently
898** only available on Mac OS X. But that could change.
899*/
900#ifdef F_FULLFSYNC
901# define HAVE_FULLFSYNC 1
902#else
903# define HAVE_FULLFSYNC 0
904#endif
905
drhb851b2c2005-03-10 14:11:12 +0000906
drhbbd42a62004-05-22 17:41:58 +0000907/*
drhdd809b02004-07-17 21:44:57 +0000908** The fsync() system call does not work as advertised on many
909** unix systems. The following procedure is an attempt to make
910** it work better.
drh1398ad32005-01-19 23:24:50 +0000911**
912** The SQLITE_NO_SYNC macro disables all fsync()s. This is useful
913** for testing when we want to run through the test suite quickly.
914** You are strongly advised *not* to deploy with SQLITE_NO_SYNC
915** enabled, however, since with SQLITE_NO_SYNC enabled, an OS crash
916** or power failure will likely corrupt the database file.
drhdd809b02004-07-17 21:44:57 +0000917*/
drheb796a72005-09-08 12:38:41 +0000918static int full_fsync(int fd, int fullSync, int dataOnly){
drhdd809b02004-07-17 21:44:57 +0000919 int rc;
drhb851b2c2005-03-10 14:11:12 +0000920
921 /* Record the number of times that we do a normal fsync() and
922 ** FULLSYNC. This is used during testing to verify that this procedure
923 ** gets called with the correct arguments.
924 */
925#ifdef SQLITE_TEST
926 if( fullSync ) sqlite3_fullsync_count++;
927 sqlite3_sync_count++;
928#endif
929
930 /* If we compiled with the SQLITE_NO_SYNC flag, then syncing is a
931 ** no-op
932 */
933#ifdef SQLITE_NO_SYNC
934 rc = SQLITE_OK;
935#else
936
drhac530b12006-02-11 01:25:50 +0000937#if HAVE_FULLFSYNC
drhb851b2c2005-03-10 14:11:12 +0000938 if( fullSync ){
drhf30cc942005-03-11 17:52:34 +0000939 rc = fcntl(fd, F_FULLFSYNC, 0);
aswiftae0943b2007-01-31 23:37:07 +0000940 }else{
941 rc = 1;
942 }
943 /* If the FULLFSYNC failed, fall back to attempting an fsync().
944 * It shouldn't be possible for fullfsync to fail on the local
945 * file system (on OSX), so failure indicates that FULLFSYNC
946 * isn't supported for this file system. So, attempt an fsync
947 * and (for now) ignore the overhead of a superfluous fcntl call.
948 * It'd be better to detect fullfsync support once and avoid
949 * the fcntl call every time sync is called.
950 */
951 if( rc ) rc = fsync(fd);
952
953#else
drheb796a72005-09-08 12:38:41 +0000954 if( dataOnly ){
955 rc = fdatasync(fd);
drhf2f23912005-10-05 10:29:36 +0000956 }else{
drheb796a72005-09-08 12:38:41 +0000957 rc = fsync(fd);
958 }
aswiftae0943b2007-01-31 23:37:07 +0000959#endif /* HAVE_FULLFSYNC */
drhb851b2c2005-03-10 14:11:12 +0000960#endif /* defined(SQLITE_NO_SYNC) */
961
drhdd809b02004-07-17 21:44:57 +0000962 return rc;
963}
964
965/*
drhbbd42a62004-05-22 17:41:58 +0000966** Make sure all writes to a particular file are committed to disk.
967**
drheb796a72005-09-08 12:38:41 +0000968** If dataOnly==0 then both the file itself and its metadata (file
969** size, access time, etc) are synced. If dataOnly!=0 then only the
970** file data is synced.
971**
drhbbd42a62004-05-22 17:41:58 +0000972** Under Unix, also make sure that the directory entry for the file
973** has been created by fsync-ing the directory that contains the file.
974** If we do not do this and we encounter a power failure, the directory
975** entry for the journal might not exist after we reboot. The next
976** SQLite to access the file will not know that the journal exists (because
977** the directory entry for the journal was never created) and the transaction
978** will not roll back - possibly leading to database corruption.
979*/
danielk197790949c22007-08-17 16:50:38 +0000980static int unixSync(sqlite3_file *id, int flags){
drh59685932006-09-14 13:47:11 +0000981 int rc;
drh054889e2005-11-30 03:20:31 +0000982 unixFile *pFile = (unixFile*)id;
danielk197790949c22007-08-17 16:50:38 +0000983
danielk1977f036aef2007-08-20 05:36:51 +0000984 int isDataOnly = (flags&SQLITE_SYNC_DATAONLY);
985 int isFullsync = (flags&0x0F)==SQLITE_SYNC_FULL;
986
danielk1977c16d4632007-08-30 14:49:58 +0000987 /* Check that one of SQLITE_SYNC_NORMAL or FULL was passed */
danielk1977f036aef2007-08-20 05:36:51 +0000988 assert((flags&0x0F)==SQLITE_SYNC_NORMAL
989 || (flags&0x0F)==SQLITE_SYNC_FULL
danielk1977f036aef2007-08-20 05:36:51 +0000990 );
danielk197790949c22007-08-17 16:50:38 +0000991
drh054889e2005-11-30 03:20:31 +0000992 assert( pFile );
drh4f0c5872007-03-26 22:05:01 +0000993 OSTRACE2("SYNC %-3d\n", pFile->h);
danielk197790949c22007-08-17 16:50:38 +0000994 rc = full_fsync(pFile->h, isFullsync, isDataOnly);
drh59685932006-09-14 13:47:11 +0000995 SimulateIOError( rc=1 );
996 if( rc ){
drh4ac285a2006-09-15 07:28:50 +0000997 return SQLITE_IOERR_FSYNC;
drhbbd42a62004-05-22 17:41:58 +0000998 }
drh054889e2005-11-30 03:20:31 +0000999 if( pFile->dirfd>=0 ){
drh4f0c5872007-03-26 22:05:01 +00001000 OSTRACE4("DIRSYNC %-3d (have_fullfsync=%d fullsync=%d)\n", pFile->dirfd,
danielk197790949c22007-08-17 16:50:38 +00001001 HAVE_FULLFSYNC, isFullsync);
danielk1977d7c03f72005-11-25 10:38:22 +00001002#ifndef SQLITE_DISABLE_DIRSYNC
drhac530b12006-02-11 01:25:50 +00001003 /* The directory sync is only attempted if full_fsync is
1004 ** turned off or unavailable. If a full_fsync occurred above,
1005 ** then the directory sync is superfluous.
1006 */
danielk197790949c22007-08-17 16:50:38 +00001007 if( (!HAVE_FULLFSYNC || !isFullsync) && full_fsync(pFile->dirfd,0,0) ){
drhac530b12006-02-11 01:25:50 +00001008 /*
1009 ** We have received multiple reports of fsync() returning
drh86631a52006-02-09 23:05:51 +00001010 ** errors when applied to directories on certain file systems.
1011 ** A failed directory sync is not a big deal. So it seems
1012 ** better to ignore the error. Ticket #1657
1013 */
1014 /* return SQLITE_IOERR; */
danielk19770964b232005-11-25 08:47:57 +00001015 }
danielk1977d7c03f72005-11-25 10:38:22 +00001016#endif
drh054889e2005-11-30 03:20:31 +00001017 close(pFile->dirfd); /* Only need to sync once, so close the directory */
1018 pFile->dirfd = -1; /* when we are done. */
drha2854222004-06-17 19:04:17 +00001019 }
drha2854222004-06-17 19:04:17 +00001020 return SQLITE_OK;
drhbbd42a62004-05-22 17:41:58 +00001021}
1022
1023/*
1024** Truncate an open file to a specified size
1025*/
danielk197762079062007-08-15 17:08:46 +00001026static int unixTruncate(sqlite3_file *id, i64 nByte){
drh59685932006-09-14 13:47:11 +00001027 int rc;
drh9cbe6352005-11-29 03:13:21 +00001028 assert( id );
drh63fff5f2007-06-19 10:50:38 +00001029 rc = ftruncate(((unixFile*)id)->h, (off_t)nByte);
drh59685932006-09-14 13:47:11 +00001030 SimulateIOError( rc=1 );
1031 if( rc ){
drh4ac285a2006-09-15 07:28:50 +00001032 return SQLITE_IOERR_TRUNCATE;
drh59685932006-09-14 13:47:11 +00001033 }else{
1034 return SQLITE_OK;
1035 }
drhbbd42a62004-05-22 17:41:58 +00001036}
1037
1038/*
1039** Determine the current size of a file in bytes
1040*/
danielk197762079062007-08-15 17:08:46 +00001041static int unixFileSize(sqlite3_file *id, i64 *pSize){
drh59685932006-09-14 13:47:11 +00001042 int rc;
drhbbd42a62004-05-22 17:41:58 +00001043 struct stat buf;
drh9cbe6352005-11-29 03:13:21 +00001044 assert( id );
drh59685932006-09-14 13:47:11 +00001045 rc = fstat(((unixFile*)id)->h, &buf);
1046 SimulateIOError( rc=1 );
1047 if( rc!=0 ){
drh4ac285a2006-09-15 07:28:50 +00001048 return SQLITE_IOERR_FSTAT;
drhbbd42a62004-05-22 17:41:58 +00001049 }
1050 *pSize = buf.st_size;
1051 return SQLITE_OK;
1052}
1053
danielk19779a1d0ab2004-06-01 14:09:28 +00001054/*
danielk197713adf8a2004-06-03 16:08:41 +00001055** This routine checks if there is a RESERVED lock held on the specified
1056** file by this or any other process. If such a lock is held, return
drh2ac3ee92004-06-07 16:27:46 +00001057** non-zero. If the file is unlocked or holds only SHARED locks, then
1058** return zero.
danielk197713adf8a2004-06-03 16:08:41 +00001059*/
danielk197762079062007-08-15 17:08:46 +00001060static int unixCheckReservedLock(sqlite3_file *id){
danielk197713adf8a2004-06-03 16:08:41 +00001061 int r = 0;
drh054889e2005-11-30 03:20:31 +00001062 unixFile *pFile = (unixFile*)id;
danielk197713adf8a2004-06-03 16:08:41 +00001063
drh054889e2005-11-30 03:20:31 +00001064 assert( pFile );
danielk1977b4b47412007-08-17 15:53:36 +00001065 enterMutex(); /* Because pFile->pLock is shared across threads */
danielk197713adf8a2004-06-03 16:08:41 +00001066
1067 /* Check if a thread in this process holds such a lock */
drh054889e2005-11-30 03:20:31 +00001068 if( pFile->pLock->locktype>SHARED_LOCK ){
danielk197713adf8a2004-06-03 16:08:41 +00001069 r = 1;
1070 }
1071
drh2ac3ee92004-06-07 16:27:46 +00001072 /* Otherwise see if some other process holds it.
danielk197713adf8a2004-06-03 16:08:41 +00001073 */
1074 if( !r ){
1075 struct flock lock;
1076 lock.l_whence = SEEK_SET;
drh2ac3ee92004-06-07 16:27:46 +00001077 lock.l_start = RESERVED_BYTE;
1078 lock.l_len = 1;
1079 lock.l_type = F_WRLCK;
drh054889e2005-11-30 03:20:31 +00001080 fcntl(pFile->h, F_GETLK, &lock);
danielk197713adf8a2004-06-03 16:08:41 +00001081 if( lock.l_type!=F_UNLCK ){
1082 r = 1;
1083 }
1084 }
1085
danielk1977b4b47412007-08-17 15:53:36 +00001086 leaveMutex();
drh4f0c5872007-03-26 22:05:01 +00001087 OSTRACE3("TEST WR-LOCK %d %d\n", pFile->h, r);
danielk197713adf8a2004-06-03 16:08:41 +00001088
1089 return r;
1090}
1091
1092/*
danielk19779a1d0ab2004-06-01 14:09:28 +00001093** Lock the file with the lock specified by parameter locktype - one
1094** of the following:
1095**
drh2ac3ee92004-06-07 16:27:46 +00001096** (1) SHARED_LOCK
1097** (2) RESERVED_LOCK
1098** (3) PENDING_LOCK
1099** (4) EXCLUSIVE_LOCK
1100**
drhb3e04342004-06-08 00:47:47 +00001101** Sometimes when requesting one lock state, additional lock states
1102** are inserted in between. The locking might fail on one of the later
1103** transitions leaving the lock state different from what it started but
1104** still short of its goal. The following chart shows the allowed
1105** transitions and the inserted intermediate states:
1106**
1107** UNLOCKED -> SHARED
1108** SHARED -> RESERVED
1109** SHARED -> (PENDING) -> EXCLUSIVE
1110** RESERVED -> (PENDING) -> EXCLUSIVE
1111** PENDING -> EXCLUSIVE
drh2ac3ee92004-06-07 16:27:46 +00001112**
drha6abd042004-06-09 17:37:22 +00001113** This routine will only increase a lock. Use the sqlite3OsUnlock()
1114** routine to lower a locking level.
danielk19779a1d0ab2004-06-01 14:09:28 +00001115*/
danielk197762079062007-08-15 17:08:46 +00001116static int unixLock(sqlite3_file *id, int locktype){
danielk1977f42f25c2004-06-25 07:21:28 +00001117 /* The following describes the implementation of the various locks and
1118 ** lock transitions in terms of the POSIX advisory shared and exclusive
1119 ** lock primitives (called read-locks and write-locks below, to avoid
1120 ** confusion with SQLite lock names). The algorithms are complicated
1121 ** slightly in order to be compatible with windows systems simultaneously
1122 ** accessing the same database file, in case that is ever required.
1123 **
1124 ** Symbols defined in os.h indentify the 'pending byte' and the 'reserved
1125 ** byte', each single bytes at well known offsets, and the 'shared byte
1126 ** range', a range of 510 bytes at a well known offset.
1127 **
1128 ** To obtain a SHARED lock, a read-lock is obtained on the 'pending
1129 ** byte'. If this is successful, a random byte from the 'shared byte
1130 ** range' is read-locked and the lock on the 'pending byte' released.
1131 **
danielk197790ba3bd2004-06-25 08:32:25 +00001132 ** A process may only obtain a RESERVED lock after it has a SHARED lock.
1133 ** A RESERVED lock is implemented by grabbing a write-lock on the
1134 ** 'reserved byte'.
danielk1977f42f25c2004-06-25 07:21:28 +00001135 **
1136 ** A process may only obtain a PENDING lock after it has obtained a
danielk197790ba3bd2004-06-25 08:32:25 +00001137 ** SHARED lock. A PENDING lock is implemented by obtaining a write-lock
1138 ** on the 'pending byte'. This ensures that no new SHARED locks can be
1139 ** obtained, but existing SHARED locks are allowed to persist. A process
1140 ** does not have to obtain a RESERVED lock on the way to a PENDING lock.
1141 ** This property is used by the algorithm for rolling back a journal file
1142 ** after a crash.
danielk1977f42f25c2004-06-25 07:21:28 +00001143 **
danielk197790ba3bd2004-06-25 08:32:25 +00001144 ** An EXCLUSIVE lock, obtained after a PENDING lock is held, is
1145 ** implemented by obtaining a write-lock on the entire 'shared byte
1146 ** range'. Since all other locks require a read-lock on one of the bytes
1147 ** within this range, this ensures that no other locks are held on the
1148 ** database.
danielk1977f42f25c2004-06-25 07:21:28 +00001149 **
1150 ** The reason a single byte cannot be used instead of the 'shared byte
1151 ** range' is that some versions of windows do not support read-locks. By
1152 ** locking a random byte from a range, concurrent SHARED locks may exist
1153 ** even if the locking primitive used is always a write-lock.
1154 */
danielk19779a1d0ab2004-06-01 14:09:28 +00001155 int rc = SQLITE_OK;
drh054889e2005-11-30 03:20:31 +00001156 unixFile *pFile = (unixFile*)id;
1157 struct lockInfo *pLock = pFile->pLock;
danielk19779a1d0ab2004-06-01 14:09:28 +00001158 struct flock lock;
1159 int s;
1160
drh054889e2005-11-30 03:20:31 +00001161 assert( pFile );
drh4f0c5872007-03-26 22:05:01 +00001162 OSTRACE7("LOCK %d %s was %s(%s,%d) pid=%d\n", pFile->h,
drh054889e2005-11-30 03:20:31 +00001163 locktypeName(locktype), locktypeName(pFile->locktype),
1164 locktypeName(pLock->locktype), pLock->cnt , getpid());
danielk19779a1d0ab2004-06-01 14:09:28 +00001165
1166 /* If there is already a lock of this type or more restrictive on the
danielk1977ad94b582007-08-20 06:44:22 +00001167 ** unixFile, do nothing. Don't use the end_lock: exit path, as
danielk1977b4b47412007-08-17 15:53:36 +00001168 ** enterMutex() hasn't been called yet.
danielk19779a1d0ab2004-06-01 14:09:28 +00001169 */
drh054889e2005-11-30 03:20:31 +00001170 if( pFile->locktype>=locktype ){
drh4f0c5872007-03-26 22:05:01 +00001171 OSTRACE3("LOCK %d %s ok (already held)\n", pFile->h,
drh054889e2005-11-30 03:20:31 +00001172 locktypeName(locktype));
danielk19779a1d0ab2004-06-01 14:09:28 +00001173 return SQLITE_OK;
1174 }
1175
drhb3e04342004-06-08 00:47:47 +00001176 /* Make sure the locking sequence is correct
drh2ac3ee92004-06-07 16:27:46 +00001177 */
drh054889e2005-11-30 03:20:31 +00001178 assert( pFile->locktype!=NO_LOCK || locktype==SHARED_LOCK );
drhb3e04342004-06-08 00:47:47 +00001179 assert( locktype!=PENDING_LOCK );
drh054889e2005-11-30 03:20:31 +00001180 assert( locktype!=RESERVED_LOCK || pFile->locktype==SHARED_LOCK );
drh2ac3ee92004-06-07 16:27:46 +00001181
drh054889e2005-11-30 03:20:31 +00001182 /* This mutex is needed because pFile->pLock is shared across threads
drhb3e04342004-06-08 00:47:47 +00001183 */
danielk1977b4b47412007-08-17 15:53:36 +00001184 enterMutex();
danielk19779a1d0ab2004-06-01 14:09:28 +00001185
drh029b44b2006-01-15 00:13:15 +00001186 /* Make sure the current thread owns the pFile.
1187 */
1188 rc = transferOwnership(pFile);
1189 if( rc!=SQLITE_OK ){
danielk1977b4b47412007-08-17 15:53:36 +00001190 leaveMutex();
drh029b44b2006-01-15 00:13:15 +00001191 return rc;
1192 }
drh64b1bea2006-01-15 02:30:57 +00001193 pLock = pFile->pLock;
drh029b44b2006-01-15 00:13:15 +00001194
danielk1977ad94b582007-08-20 06:44:22 +00001195 /* If some thread using this PID has a lock via a different unixFile*
danielk19779a1d0ab2004-06-01 14:09:28 +00001196 ** handle that precludes the requested lock, return BUSY.
1197 */
drh054889e2005-11-30 03:20:31 +00001198 if( (pFile->locktype!=pLock->locktype &&
drh2ac3ee92004-06-07 16:27:46 +00001199 (pLock->locktype>=PENDING_LOCK || locktype>SHARED_LOCK))
danielk19779a1d0ab2004-06-01 14:09:28 +00001200 ){
1201 rc = SQLITE_BUSY;
1202 goto end_lock;
1203 }
1204
1205 /* If a SHARED lock is requested, and some thread using this PID already
1206 ** has a SHARED or RESERVED lock, then increment reference counts and
1207 ** return SQLITE_OK.
1208 */
1209 if( locktype==SHARED_LOCK &&
1210 (pLock->locktype==SHARED_LOCK || pLock->locktype==RESERVED_LOCK) ){
1211 assert( locktype==SHARED_LOCK );
drh054889e2005-11-30 03:20:31 +00001212 assert( pFile->locktype==0 );
danielk1977ecb2a962004-06-02 06:30:16 +00001213 assert( pLock->cnt>0 );
drh054889e2005-11-30 03:20:31 +00001214 pFile->locktype = SHARED_LOCK;
danielk19779a1d0ab2004-06-01 14:09:28 +00001215 pLock->cnt++;
drh054889e2005-11-30 03:20:31 +00001216 pFile->pOpen->nLock++;
danielk19779a1d0ab2004-06-01 14:09:28 +00001217 goto end_lock;
1218 }
1219
danielk197713adf8a2004-06-03 16:08:41 +00001220 lock.l_len = 1L;
drh2b4b5962005-06-15 17:47:55 +00001221
danielk19779a1d0ab2004-06-01 14:09:28 +00001222 lock.l_whence = SEEK_SET;
1223
drh3cde3bb2004-06-12 02:17:14 +00001224 /* A PENDING lock is needed before acquiring a SHARED lock and before
1225 ** acquiring an EXCLUSIVE lock. For the SHARED lock, the PENDING will
1226 ** be released.
danielk19779a1d0ab2004-06-01 14:09:28 +00001227 */
drh3cde3bb2004-06-12 02:17:14 +00001228 if( locktype==SHARED_LOCK
drh054889e2005-11-30 03:20:31 +00001229 || (locktype==EXCLUSIVE_LOCK && pFile->locktype<PENDING_LOCK)
drh3cde3bb2004-06-12 02:17:14 +00001230 ){
danielk1977489468c2004-06-28 08:25:47 +00001231 lock.l_type = (locktype==SHARED_LOCK?F_RDLCK:F_WRLCK);
drh2ac3ee92004-06-07 16:27:46 +00001232 lock.l_start = PENDING_BYTE;
drh054889e2005-11-30 03:20:31 +00001233 s = fcntl(pFile->h, F_SETLK, &lock);
drhe2396a12007-03-29 20:19:58 +00001234 if( s==(-1) ){
danielk19779a1d0ab2004-06-01 14:09:28 +00001235 rc = (errno==EINVAL) ? SQLITE_NOLFS : SQLITE_BUSY;
1236 goto end_lock;
1237 }
drh3cde3bb2004-06-12 02:17:14 +00001238 }
1239
1240
1241 /* If control gets to this point, then actually go ahead and make
1242 ** operating system calls for the specified lock.
1243 */
1244 if( locktype==SHARED_LOCK ){
1245 assert( pLock->cnt==0 );
1246 assert( pLock->locktype==0 );
danielk19779a1d0ab2004-06-01 14:09:28 +00001247
drh2ac3ee92004-06-07 16:27:46 +00001248 /* Now get the read-lock */
1249 lock.l_start = SHARED_FIRST;
1250 lock.l_len = SHARED_SIZE;
drh054889e2005-11-30 03:20:31 +00001251 s = fcntl(pFile->h, F_SETLK, &lock);
drh2ac3ee92004-06-07 16:27:46 +00001252
1253 /* Drop the temporary PENDING lock */
1254 lock.l_start = PENDING_BYTE;
1255 lock.l_len = 1L;
danielk19779a1d0ab2004-06-01 14:09:28 +00001256 lock.l_type = F_UNLCK;
drh054889e2005-11-30 03:20:31 +00001257 if( fcntl(pFile->h, F_SETLK, &lock)!=0 ){
drh4ac285a2006-09-15 07:28:50 +00001258 rc = SQLITE_IOERR_UNLOCK; /* This should never happen */
drh2b4b5962005-06-15 17:47:55 +00001259 goto end_lock;
1260 }
drhe2396a12007-03-29 20:19:58 +00001261 if( s==(-1) ){
drhbbd42a62004-05-22 17:41:58 +00001262 rc = (errno==EINVAL) ? SQLITE_NOLFS : SQLITE_BUSY;
1263 }else{
drh054889e2005-11-30 03:20:31 +00001264 pFile->locktype = SHARED_LOCK;
1265 pFile->pOpen->nLock++;
danielk19779a1d0ab2004-06-01 14:09:28 +00001266 pLock->cnt = 1;
drhbbd42a62004-05-22 17:41:58 +00001267 }
drh3cde3bb2004-06-12 02:17:14 +00001268 }else if( locktype==EXCLUSIVE_LOCK && pLock->cnt>1 ){
1269 /* We are trying for an exclusive lock but another thread in this
1270 ** same process is still holding a shared lock. */
1271 rc = SQLITE_BUSY;
drhbbd42a62004-05-22 17:41:58 +00001272 }else{
drh3cde3bb2004-06-12 02:17:14 +00001273 /* The request was for a RESERVED or EXCLUSIVE lock. It is
danielk19779a1d0ab2004-06-01 14:09:28 +00001274 ** assumed that there is a SHARED or greater lock on the file
1275 ** already.
1276 */
drh054889e2005-11-30 03:20:31 +00001277 assert( 0!=pFile->locktype );
danielk19779a1d0ab2004-06-01 14:09:28 +00001278 lock.l_type = F_WRLCK;
1279 switch( locktype ){
1280 case RESERVED_LOCK:
drh2ac3ee92004-06-07 16:27:46 +00001281 lock.l_start = RESERVED_BYTE;
danielk19779a1d0ab2004-06-01 14:09:28 +00001282 break;
danielk19779a1d0ab2004-06-01 14:09:28 +00001283 case EXCLUSIVE_LOCK:
drh2ac3ee92004-06-07 16:27:46 +00001284 lock.l_start = SHARED_FIRST;
1285 lock.l_len = SHARED_SIZE;
danielk19779a1d0ab2004-06-01 14:09:28 +00001286 break;
1287 default:
1288 assert(0);
1289 }
drh054889e2005-11-30 03:20:31 +00001290 s = fcntl(pFile->h, F_SETLK, &lock);
drhe2396a12007-03-29 20:19:58 +00001291 if( s==(-1) ){
danielk19779a1d0ab2004-06-01 14:09:28 +00001292 rc = (errno==EINVAL) ? SQLITE_NOLFS : SQLITE_BUSY;
1293 }
drhbbd42a62004-05-22 17:41:58 +00001294 }
danielk19779a1d0ab2004-06-01 14:09:28 +00001295
danielk1977ecb2a962004-06-02 06:30:16 +00001296 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001297 pFile->locktype = locktype;
danielk1977ecb2a962004-06-02 06:30:16 +00001298 pLock->locktype = locktype;
drh3cde3bb2004-06-12 02:17:14 +00001299 }else if( locktype==EXCLUSIVE_LOCK ){
drh054889e2005-11-30 03:20:31 +00001300 pFile->locktype = PENDING_LOCK;
drh3cde3bb2004-06-12 02:17:14 +00001301 pLock->locktype = PENDING_LOCK;
danielk1977ecb2a962004-06-02 06:30:16 +00001302 }
danielk19779a1d0ab2004-06-01 14:09:28 +00001303
1304end_lock:
danielk1977b4b47412007-08-17 15:53:36 +00001305 leaveMutex();
drh4f0c5872007-03-26 22:05:01 +00001306 OSTRACE4("LOCK %d %s %s\n", pFile->h, locktypeName(locktype),
danielk19772b444852004-06-29 07:45:33 +00001307 rc==SQLITE_OK ? "ok" : "failed");
drhbbd42a62004-05-22 17:41:58 +00001308 return rc;
1309}
1310
1311/*
drh054889e2005-11-30 03:20:31 +00001312** Lower the locking level on file descriptor pFile to locktype. locktype
drha6abd042004-06-09 17:37:22 +00001313** must be either NO_LOCK or SHARED_LOCK.
1314**
1315** If the locking level of the file descriptor is already at or below
1316** the requested locking level, this routine is a no-op.
drhbbd42a62004-05-22 17:41:58 +00001317*/
danielk197762079062007-08-15 17:08:46 +00001318static int unixUnlock(sqlite3_file *id, int locktype){
drha6abd042004-06-09 17:37:22 +00001319 struct lockInfo *pLock;
1320 struct flock lock;
drh9c105bb2004-10-02 20:38:28 +00001321 int rc = SQLITE_OK;
drh054889e2005-11-30 03:20:31 +00001322 unixFile *pFile = (unixFile*)id;
drha6abd042004-06-09 17:37:22 +00001323
drh054889e2005-11-30 03:20:31 +00001324 assert( pFile );
drh4f0c5872007-03-26 22:05:01 +00001325 OSTRACE7("UNLOCK %d %d was %d(%d,%d) pid=%d\n", pFile->h, locktype,
drh054889e2005-11-30 03:20:31 +00001326 pFile->locktype, pFile->pLock->locktype, pFile->pLock->cnt, getpid());
drha6abd042004-06-09 17:37:22 +00001327
1328 assert( locktype<=SHARED_LOCK );
drh054889e2005-11-30 03:20:31 +00001329 if( pFile->locktype<=locktype ){
drha6abd042004-06-09 17:37:22 +00001330 return SQLITE_OK;
1331 }
drhf1a221e2006-01-15 17:27:17 +00001332 if( CHECK_THREADID(pFile) ){
1333 return SQLITE_MISUSE;
1334 }
danielk1977b4b47412007-08-17 15:53:36 +00001335 enterMutex();
drh054889e2005-11-30 03:20:31 +00001336 pLock = pFile->pLock;
drha6abd042004-06-09 17:37:22 +00001337 assert( pLock->cnt!=0 );
drh054889e2005-11-30 03:20:31 +00001338 if( pFile->locktype>SHARED_LOCK ){
1339 assert( pLock->locktype==pFile->locktype );
drh9c105bb2004-10-02 20:38:28 +00001340 if( locktype==SHARED_LOCK ){
1341 lock.l_type = F_RDLCK;
1342 lock.l_whence = SEEK_SET;
1343 lock.l_start = SHARED_FIRST;
1344 lock.l_len = SHARED_SIZE;
drhe2396a12007-03-29 20:19:58 +00001345 if( fcntl(pFile->h, F_SETLK, &lock)==(-1) ){
drh9c105bb2004-10-02 20:38:28 +00001346 /* This should never happen */
drh4ac285a2006-09-15 07:28:50 +00001347 rc = SQLITE_IOERR_RDLOCK;
drh9c105bb2004-10-02 20:38:28 +00001348 }
1349 }
drhbbd42a62004-05-22 17:41:58 +00001350 lock.l_type = F_UNLCK;
1351 lock.l_whence = SEEK_SET;
drha6abd042004-06-09 17:37:22 +00001352 lock.l_start = PENDING_BYTE;
1353 lock.l_len = 2L; assert( PENDING_BYTE+1==RESERVED_BYTE );
drhe2396a12007-03-29 20:19:58 +00001354 if( fcntl(pFile->h, F_SETLK, &lock)!=(-1) ){
drh2b4b5962005-06-15 17:47:55 +00001355 pLock->locktype = SHARED_LOCK;
1356 }else{
drh4ac285a2006-09-15 07:28:50 +00001357 rc = SQLITE_IOERR_UNLOCK; /* This should never happen */
drh2b4b5962005-06-15 17:47:55 +00001358 }
drhbbd42a62004-05-22 17:41:58 +00001359 }
drha6abd042004-06-09 17:37:22 +00001360 if( locktype==NO_LOCK ){
1361 struct openCnt *pOpen;
danielk1977ecb2a962004-06-02 06:30:16 +00001362
drha6abd042004-06-09 17:37:22 +00001363 /* Decrement the shared lock counter. Release the lock using an
1364 ** OS call only when all threads in this same process have released
1365 ** the lock.
1366 */
1367 pLock->cnt--;
1368 if( pLock->cnt==0 ){
1369 lock.l_type = F_UNLCK;
1370 lock.l_whence = SEEK_SET;
1371 lock.l_start = lock.l_len = 0L;
drhe2396a12007-03-29 20:19:58 +00001372 if( fcntl(pFile->h, F_SETLK, &lock)!=(-1) ){
drh2b4b5962005-06-15 17:47:55 +00001373 pLock->locktype = NO_LOCK;
1374 }else{
drh4ac285a2006-09-15 07:28:50 +00001375 rc = SQLITE_IOERR_UNLOCK; /* This should never happen */
drh2b4b5962005-06-15 17:47:55 +00001376 }
drha6abd042004-06-09 17:37:22 +00001377 }
1378
drhbbd42a62004-05-22 17:41:58 +00001379 /* Decrement the count of locks against this same file. When the
1380 ** count reaches zero, close any other file descriptors whose close
1381 ** was deferred because of outstanding locks.
1382 */
drh054889e2005-11-30 03:20:31 +00001383 pOpen = pFile->pOpen;
drhbbd42a62004-05-22 17:41:58 +00001384 pOpen->nLock--;
1385 assert( pOpen->nLock>=0 );
1386 if( pOpen->nLock==0 && pOpen->nPending>0 ){
1387 int i;
1388 for(i=0; i<pOpen->nPending; i++){
1389 close(pOpen->aPending[i]);
1390 }
drh64b1bea2006-01-15 02:30:57 +00001391 free(pOpen->aPending);
drhbbd42a62004-05-22 17:41:58 +00001392 pOpen->nPending = 0;
1393 pOpen->aPending = 0;
1394 }
1395 }
danielk1977b4b47412007-08-17 15:53:36 +00001396 leaveMutex();
drh054889e2005-11-30 03:20:31 +00001397 pFile->locktype = locktype;
drh9c105bb2004-10-02 20:38:28 +00001398 return rc;
drhbbd42a62004-05-22 17:41:58 +00001399}
1400
1401/*
danielk1977e3026632004-06-22 11:29:02 +00001402** Close a file.
1403*/
danielk197762079062007-08-15 17:08:46 +00001404static int unixClose(sqlite3_file *id){
1405 unixFile *pFile = (unixFile *)id;
1406 if( !pFile ) return SQLITE_OK;
1407 unixUnlock(id, NO_LOCK);
1408 if( pFile->dirfd>=0 ) close(pFile->dirfd);
1409 pFile->dirfd = -1;
danielk1977b4b47412007-08-17 15:53:36 +00001410 enterMutex();
danielk1977441b09a2006-01-05 13:48:29 +00001411
danielk197762079062007-08-15 17:08:46 +00001412 if( pFile->pOpen->nLock ){
danielk1977e3026632004-06-22 11:29:02 +00001413 /* If there are outstanding locks, do not actually close the file just
1414 ** yet because that would clear those locks. Instead, add the file
1415 ** descriptor to pOpen->aPending. It will be automatically closed when
1416 ** the last lock is cleared.
1417 */
1418 int *aNew;
danielk197762079062007-08-15 17:08:46 +00001419 struct openCnt *pOpen = pFile->pOpen;
drh64b1bea2006-01-15 02:30:57 +00001420 aNew = realloc( pOpen->aPending, (pOpen->nPending+1)*sizeof(int) );
danielk1977e3026632004-06-22 11:29:02 +00001421 if( aNew==0 ){
1422 /* If a malloc fails, just leak the file descriptor */
1423 }else{
1424 pOpen->aPending = aNew;
danielk197762079062007-08-15 17:08:46 +00001425 pOpen->aPending[pOpen->nPending] = pFile->h;
drhad81e872005-08-21 21:45:01 +00001426 pOpen->nPending++;
danielk1977e3026632004-06-22 11:29:02 +00001427 }
1428 }else{
1429 /* There are no outstanding locks so we can close the file immediately */
danielk197762079062007-08-15 17:08:46 +00001430 close(pFile->h);
danielk1977e3026632004-06-22 11:29:02 +00001431 }
danielk197762079062007-08-15 17:08:46 +00001432 releaseLockInfo(pFile->pLock);
1433 releaseOpenCnt(pFile->pOpen);
danielk1977441b09a2006-01-05 13:48:29 +00001434
danielk1977b4b47412007-08-17 15:53:36 +00001435 leaveMutex();
danielk197762079062007-08-15 17:08:46 +00001436 OSTRACE2("CLOSE %-3d\n", pFile->h);
danielk1977e3026632004-06-22 11:29:02 +00001437 OpenCounter(-1);
danielk1977b4b47412007-08-17 15:53:36 +00001438 memset(pFile, 0, sizeof(unixFile));
drh02afc862006-01-20 18:10:57 +00001439 return SQLITE_OK;
danielk1977e3026632004-06-22 11:29:02 +00001440}
1441
drhbfe66312006-10-03 17:40:40 +00001442
1443#ifdef SQLITE_ENABLE_LOCKING_STYLE
1444#pragma mark AFP Support
1445
1446/*
1447 ** The afpLockingContext structure contains all afp lock specific state
1448 */
1449typedef struct afpLockingContext afpLockingContext;
1450struct afpLockingContext {
1451 unsigned long long sharedLockByte;
1452 char *filePath;
1453};
1454
1455struct ByteRangeLockPB2
1456{
1457 unsigned long long offset; /* offset to first byte to lock */
1458 unsigned long long length; /* nbr of bytes to lock */
1459 unsigned long long retRangeStart; /* nbr of 1st byte locked if successful */
1460 unsigned char unLockFlag; /* 1 = unlock, 0 = lock */
1461 unsigned char startEndFlag; /* 1=rel to end of fork, 0=rel to start */
1462 int fd; /* file desc to assoc this lock with */
1463};
1464
drhfd131da2007-08-07 17:13:03 +00001465#define afpfsByteRangeLock2FSCTL _IOWR('z', 23, struct ByteRangeLockPB2)
drhbfe66312006-10-03 17:40:40 +00001466
danielk1977ad94b582007-08-20 06:44:22 +00001467/*
1468** Return 0 on success, 1 on failure. To match the behavior of the
1469** normal posix file locking (used in unixLock for example), we should
1470** provide 'richer' return codes - specifically to differentiate between
1471** 'file busy' and 'file system error' results.
1472*/
1473static int _AFPFSSetLock(
1474 const char *path,
1475 int fd,
1476 unsigned long long offset,
1477 unsigned long long length,
1478 int setLockFlag
1479){
drhfd131da2007-08-07 17:13:03 +00001480 struct ByteRangeLockPB2 pb;
drhbfe66312006-10-03 17:40:40 +00001481 int err;
1482
1483 pb.unLockFlag = setLockFlag ? 0 : 1;
1484 pb.startEndFlag = 0;
1485 pb.offset = offset;
1486 pb.length = length;
1487 pb.fd = fd;
drh4f0c5872007-03-26 22:05:01 +00001488 OSTRACE5("AFPLOCK setting lock %s for %d in range %llx:%llx\n",
drhbfe66312006-10-03 17:40:40 +00001489 (setLockFlag?"ON":"OFF"), fd, offset, length);
1490 err = fsctl(path, afpfsByteRangeLock2FSCTL, &pb, 0);
1491 if ( err==-1 ) {
drh4f0c5872007-03-26 22:05:01 +00001492 OSTRACE4("AFPLOCK failed to fsctl() '%s' %d %s\n", path, errno,
drhbfe66312006-10-03 17:40:40 +00001493 strerror(errno));
drh3b62b2f2007-06-08 18:27:03 +00001494 return 1; /* error */
drhbfe66312006-10-03 17:40:40 +00001495 } else {
1496 return 0;
1497 }
1498}
1499
1500/*
1501 ** This routine checks if there is a RESERVED lock held on the specified
1502 ** file by this or any other process. If such a lock is held, return
1503 ** non-zero. If the file is unlocked or holds only SHARED locks, then
1504 ** return zero.
1505 */
danielk1977ad94b582007-08-20 06:44:22 +00001506static int afpUnixCheckReservedLock(sqlite3_file *id){
drhbfe66312006-10-03 17:40:40 +00001507 int r = 0;
1508 unixFile *pFile = (unixFile*)id;
1509
1510 assert( pFile );
1511 afpLockingContext *context = (afpLockingContext *) pFile->lockingContext;
1512
1513 /* Check if a thread in this process holds such a lock */
1514 if( pFile->locktype>SHARED_LOCK ){
1515 r = 1;
1516 }
1517
1518 /* Otherwise see if some other process holds it.
1519 */
1520 if ( !r ) {
drh3b62b2f2007-06-08 18:27:03 +00001521 /* lock the byte */
drhbfe66312006-10-03 17:40:40 +00001522 int failed = _AFPFSSetLock(context->filePath, pFile->h, RESERVED_BYTE, 1,1);
1523 if (failed) {
1524 /* if we failed to get the lock then someone else must have it */
1525 r = 1;
1526 } else {
1527 /* if we succeeded in taking the reserved lock, unlock it to restore
1528 ** the original state */
1529 _AFPFSSetLock(context->filePath, pFile->h, RESERVED_BYTE, 1, 0);
1530 }
1531 }
drh4f0c5872007-03-26 22:05:01 +00001532 OSTRACE3("TEST WR-LOCK %d %d\n", pFile->h, r);
drhbfe66312006-10-03 17:40:40 +00001533
1534 return r;
1535}
1536
1537/* AFP-style locking following the behavior of unixLock, see the unixLock
1538** function comments for details of lock management. */
danielk1977ad94b582007-08-20 06:44:22 +00001539static int afpUnixLock(sqlite3_file *id, int locktype)
drhbfe66312006-10-03 17:40:40 +00001540{
1541 int rc = SQLITE_OK;
1542 unixFile *pFile = (unixFile*)id;
1543 afpLockingContext *context = (afpLockingContext *) pFile->lockingContext;
1544 int gotPendingLock = 0;
1545
1546 assert( pFile );
drh4f0c5872007-03-26 22:05:01 +00001547 OSTRACE5("LOCK %d %s was %s pid=%d\n", pFile->h,
drhbfe66312006-10-03 17:40:40 +00001548 locktypeName(locktype), locktypeName(pFile->locktype), getpid());
1549 /* If there is already a lock of this type or more restrictive on the
danielk1977ad94b582007-08-20 06:44:22 +00001550 ** unixFile, do nothing. Don't use the afp_end_lock: exit path, as
danielk1977b4b47412007-08-17 15:53:36 +00001551 ** enterMutex() hasn't been called yet.
drhbfe66312006-10-03 17:40:40 +00001552 */
1553 if( pFile->locktype>=locktype ){
drh4f0c5872007-03-26 22:05:01 +00001554 OSTRACE3("LOCK %d %s ok (already held)\n", pFile->h,
drhbfe66312006-10-03 17:40:40 +00001555 locktypeName(locktype));
1556 return SQLITE_OK;
1557 }
1558
1559 /* Make sure the locking sequence is correct
1560 */
1561 assert( pFile->locktype!=NO_LOCK || locktype==SHARED_LOCK );
1562 assert( locktype!=PENDING_LOCK );
1563 assert( locktype!=RESERVED_LOCK || pFile->locktype==SHARED_LOCK );
1564
1565 /* This mutex is needed because pFile->pLock is shared across threads
1566 */
danielk1977b4b47412007-08-17 15:53:36 +00001567 enterMutex();
drhbfe66312006-10-03 17:40:40 +00001568
1569 /* Make sure the current thread owns the pFile.
1570 */
1571 rc = transferOwnership(pFile);
1572 if( rc!=SQLITE_OK ){
danielk1977b4b47412007-08-17 15:53:36 +00001573 leaveMutex();
drhbfe66312006-10-03 17:40:40 +00001574 return rc;
1575 }
1576
1577 /* A PENDING lock is needed before acquiring a SHARED lock and before
1578 ** acquiring an EXCLUSIVE lock. For the SHARED lock, the PENDING will
1579 ** be released.
1580 */
1581 if( locktype==SHARED_LOCK
1582 || (locktype==EXCLUSIVE_LOCK && pFile->locktype<PENDING_LOCK)
1583 ){
1584 int failed = _AFPFSSetLock(context->filePath, pFile->h,
1585 PENDING_BYTE, 1, 1);
1586 if (failed) {
1587 rc = SQLITE_BUSY;
1588 goto afp_end_lock;
1589 }
1590 }
1591
1592 /* If control gets to this point, then actually go ahead and make
1593 ** operating system calls for the specified lock.
1594 */
1595 if( locktype==SHARED_LOCK ){
1596 int lk, failed;
1597 int tries = 0;
1598
1599 /* Now get the read-lock */
1600 /* note that the quality of the randomness doesn't matter that much */
1601 lk = random();
1602 context->sharedLockByte = (lk & 0x7fffffff)%(SHARED_SIZE - 1);
1603 failed = _AFPFSSetLock(context->filePath, pFile->h,
1604 SHARED_FIRST+context->sharedLockByte, 1, 1);
1605
1606 /* Drop the temporary PENDING lock */
1607 if (_AFPFSSetLock(context->filePath, pFile->h, PENDING_BYTE, 1, 0)) {
1608 rc = SQLITE_IOERR_UNLOCK; /* This should never happen */
1609 goto afp_end_lock;
1610 }
1611
1612 if( failed ){
1613 rc = SQLITE_BUSY;
1614 } else {
1615 pFile->locktype = SHARED_LOCK;
1616 }
1617 }else{
1618 /* The request was for a RESERVED or EXCLUSIVE lock. It is
1619 ** assumed that there is a SHARED or greater lock on the file
1620 ** already.
1621 */
1622 int failed = 0;
1623 assert( 0!=pFile->locktype );
1624 if (locktype >= RESERVED_LOCK && pFile->locktype < RESERVED_LOCK) {
1625 /* Acquire a RESERVED lock */
1626 failed = _AFPFSSetLock(context->filePath, pFile->h, RESERVED_BYTE, 1,1);
1627 }
1628 if (!failed && locktype == EXCLUSIVE_LOCK) {
1629 /* Acquire an EXCLUSIVE lock */
1630
1631 /* Remove the shared lock before trying the range. we'll need to
1632 ** reestablish the shared lock if we can't get the afpUnixUnlock
1633 */
1634 if (!_AFPFSSetLock(context->filePath, pFile->h, SHARED_FIRST +
1635 context->sharedLockByte, 1, 0)) {
1636 /* now attemmpt to get the exclusive lock range */
1637 failed = _AFPFSSetLock(context->filePath, pFile->h, SHARED_FIRST,
1638 SHARED_SIZE, 1);
1639 if (failed && _AFPFSSetLock(context->filePath, pFile->h, SHARED_FIRST +
1640 context->sharedLockByte, 1, 1)) {
1641 rc = SQLITE_IOERR_RDLOCK; /* this should never happen */
1642 }
1643 } else {
1644 /* */
1645 rc = SQLITE_IOERR_UNLOCK; /* this should never happen */
1646 }
1647 }
1648 if( failed && rc == SQLITE_OK){
1649 rc = SQLITE_BUSY;
1650 }
1651 }
1652
1653 if( rc==SQLITE_OK ){
1654 pFile->locktype = locktype;
1655 }else if( locktype==EXCLUSIVE_LOCK ){
1656 pFile->locktype = PENDING_LOCK;
1657 }
1658
1659afp_end_lock:
danielk1977b4b47412007-08-17 15:53:36 +00001660 leaveMutex();
drh4f0c5872007-03-26 22:05:01 +00001661 OSTRACE4("LOCK %d %s %s\n", pFile->h, locktypeName(locktype),
drhbfe66312006-10-03 17:40:40 +00001662 rc==SQLITE_OK ? "ok" : "failed");
1663 return rc;
1664}
1665
1666/*
1667 ** Lower the locking level on file descriptor pFile to locktype. locktype
1668 ** must be either NO_LOCK or SHARED_LOCK.
1669 **
1670 ** If the locking level of the file descriptor is already at or below
1671 ** the requested locking level, this routine is a no-op.
1672 */
danielk1977ad94b582007-08-20 06:44:22 +00001673static int afpUnixUnlock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00001674 struct flock lock;
1675 int rc = SQLITE_OK;
1676 unixFile *pFile = (unixFile*)id;
1677 afpLockingContext *context = (afpLockingContext *) pFile->lockingContext;
1678
1679 assert( pFile );
drh4f0c5872007-03-26 22:05:01 +00001680 OSTRACE5("UNLOCK %d %d was %d pid=%d\n", pFile->h, locktype,
drhbfe66312006-10-03 17:40:40 +00001681 pFile->locktype, getpid());
1682
1683 assert( locktype<=SHARED_LOCK );
1684 if( pFile->locktype<=locktype ){
1685 return SQLITE_OK;
1686 }
1687 if( CHECK_THREADID(pFile) ){
1688 return SQLITE_MISUSE;
1689 }
danielk1977b4b47412007-08-17 15:53:36 +00001690 enterMutex();
drhbfe66312006-10-03 17:40:40 +00001691 if( pFile->locktype>SHARED_LOCK ){
1692 if( locktype==SHARED_LOCK ){
1693 int failed = 0;
1694
1695 /* unlock the exclusive range - then re-establish the shared lock */
1696 if (pFile->locktype==EXCLUSIVE_LOCK) {
1697 failed = _AFPFSSetLock(context->filePath, pFile->h, SHARED_FIRST,
1698 SHARED_SIZE, 0);
1699 if (!failed) {
1700 /* successfully removed the exclusive lock */
1701 if (_AFPFSSetLock(context->filePath, pFile->h, SHARED_FIRST+
1702 context->sharedLockByte, 1, 1)) {
1703 /* failed to re-establish our shared lock */
1704 rc = SQLITE_IOERR_RDLOCK; /* This should never happen */
1705 }
1706 } else {
1707 /* This should never happen - failed to unlock the exclusive range */
1708 rc = SQLITE_IOERR_UNLOCK;
1709 }
1710 }
1711 }
1712 if (rc == SQLITE_OK && pFile->locktype>=PENDING_LOCK) {
1713 if (_AFPFSSetLock(context->filePath, pFile->h, PENDING_BYTE, 1, 0)){
1714 /* failed to release the pending lock */
1715 rc = SQLITE_IOERR_UNLOCK; /* This should never happen */
1716 }
1717 }
1718 if (rc == SQLITE_OK && pFile->locktype>=RESERVED_LOCK) {
1719 if (_AFPFSSetLock(context->filePath, pFile->h, RESERVED_BYTE, 1, 0)) {
1720 /* failed to release the reserved lock */
1721 rc = SQLITE_IOERR_UNLOCK; /* This should never happen */
1722 }
1723 }
1724 }
1725 if( locktype==NO_LOCK ){
1726 int failed = _AFPFSSetLock(context->filePath, pFile->h,
1727 SHARED_FIRST + context->sharedLockByte, 1, 0);
1728 if (failed) {
1729 rc = SQLITE_IOERR_UNLOCK; /* This should never happen */
1730 }
1731 }
1732 if (rc == SQLITE_OK)
1733 pFile->locktype = locktype;
danielk1977b4b47412007-08-17 15:53:36 +00001734 leaveMutex();
drhbfe66312006-10-03 17:40:40 +00001735 return rc;
1736}
1737
1738/*
1739 ** Close a file & cleanup AFP specific locking context
1740 */
danielk1977ad94b582007-08-20 06:44:22 +00001741static int afpUnixClose(sqlite3_file *id) {
1742 unixFile *pFile = (unixFile*)pId;
1743
1744 if( !pFile ) return SQLITE_OK;
drhbfe66312006-10-03 17:40:40 +00001745 afpUnixUnlock(*pId, NO_LOCK);
1746 /* free the AFP locking structure */
danielk1977ad94b582007-08-20 06:44:22 +00001747 if (pFile->lockingContext != NULL) {
1748 if (((afpLockingContext *)pFile->lockingContext)->filePath != NULL)
1749 sqlite3_free(((afpLockingContext*)pFile->lockingContext)->filePath);
1750 sqlite3_free(pFile->lockingContext);
drhbfe66312006-10-03 17:40:40 +00001751 }
danielk1977ad94b582007-08-20 06:44:22 +00001752
1753 if( pFile->dirfd>=0 ) close(pFile->dirfd);
1754 pFile->dirfd = -1;
1755 close(pFile->h);
danielk1977ad94b582007-08-20 06:44:22 +00001756 OSTRACE2("CLOSE %-3d\n", pFile->h);
drhbfe66312006-10-03 17:40:40 +00001757 OpenCounter(-1);
drhbfe66312006-10-03 17:40:40 +00001758 return SQLITE_OK;
1759}
1760
1761
1762#pragma mark flock() style locking
1763
1764/*
1765 ** The flockLockingContext is not used
1766 */
1767typedef void flockLockingContext;
1768
danielk1977ad94b582007-08-20 06:44:22 +00001769static int flockUnixCheckReservedLock(sqlite3_file *id) {
drhbfe66312006-10-03 17:40:40 +00001770 unixFile *pFile = (unixFile*)id;
1771
1772 if (pFile->locktype == RESERVED_LOCK) {
drh3b62b2f2007-06-08 18:27:03 +00001773 return 1; /* already have a reserved lock */
drhbfe66312006-10-03 17:40:40 +00001774 } else {
drh3b62b2f2007-06-08 18:27:03 +00001775 /* attempt to get the lock */
drhbfe66312006-10-03 17:40:40 +00001776 int rc = flock(pFile->h, LOCK_EX | LOCK_NB);
1777 if (!rc) {
drh3b62b2f2007-06-08 18:27:03 +00001778 /* got the lock, unlock it */
drhbfe66312006-10-03 17:40:40 +00001779 flock(pFile->h, LOCK_UN);
drh3b62b2f2007-06-08 18:27:03 +00001780 return 0; /* no one has it reserved */
drhbfe66312006-10-03 17:40:40 +00001781 }
drh3b62b2f2007-06-08 18:27:03 +00001782 return 1; /* someone else might have it reserved */
drhbfe66312006-10-03 17:40:40 +00001783 }
1784}
1785
danielk1977ad94b582007-08-20 06:44:22 +00001786static int flockUnixLock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00001787 unixFile *pFile = (unixFile*)id;
1788
drh3b62b2f2007-06-08 18:27:03 +00001789 /* if we already have a lock, it is exclusive.
1790 ** Just adjust level and punt on outta here. */
drhbfe66312006-10-03 17:40:40 +00001791 if (pFile->locktype > NO_LOCK) {
1792 pFile->locktype = locktype;
1793 return SQLITE_OK;
1794 }
1795
drh3b62b2f2007-06-08 18:27:03 +00001796 /* grab an exclusive lock */
drhbfe66312006-10-03 17:40:40 +00001797 int rc = flock(pFile->h, LOCK_EX | LOCK_NB);
1798 if (rc) {
drh3b62b2f2007-06-08 18:27:03 +00001799 /* didn't get, must be busy */
drhbfe66312006-10-03 17:40:40 +00001800 return SQLITE_BUSY;
1801 } else {
drh3b62b2f2007-06-08 18:27:03 +00001802 /* got it, set the type and return ok */
drhbfe66312006-10-03 17:40:40 +00001803 pFile->locktype = locktype;
1804 return SQLITE_OK;
1805 }
1806}
1807
danielk1977ad94b582007-08-20 06:44:22 +00001808static int flockUnixUnlock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00001809 unixFile *pFile = (unixFile*)id;
1810
1811 assert( locktype<=SHARED_LOCK );
1812
drh3b62b2f2007-06-08 18:27:03 +00001813 /* no-op if possible */
drhbfe66312006-10-03 17:40:40 +00001814 if( pFile->locktype==locktype ){
1815 return SQLITE_OK;
1816 }
1817
drh3b62b2f2007-06-08 18:27:03 +00001818 /* shared can just be set because we always have an exclusive */
drhbfe66312006-10-03 17:40:40 +00001819 if (locktype==SHARED_LOCK) {
1820 pFile->locktype = locktype;
1821 return SQLITE_OK;
1822 }
1823
drh3b62b2f2007-06-08 18:27:03 +00001824 /* no, really, unlock. */
drhbfe66312006-10-03 17:40:40 +00001825 int rc = flock(pFile->h, LOCK_UN);
1826 if (rc)
1827 return SQLITE_IOERR_UNLOCK;
1828 else {
1829 pFile->locktype = NO_LOCK;
1830 return SQLITE_OK;
1831 }
1832}
1833
1834/*
1835 ** Close a file.
1836 */
danielk1977ad94b582007-08-20 06:44:22 +00001837static int flockUnixClose(sqlite3_file *pId) {
1838 unixFile *pFile = (unixFile*)*pId;
drhbfe66312006-10-03 17:40:40 +00001839
danielk1977ad94b582007-08-20 06:44:22 +00001840 if( !pFile ) return SQLITE_OK;
drhbfe66312006-10-03 17:40:40 +00001841 flockUnixUnlock(*pId, NO_LOCK);
1842
danielk1977ad94b582007-08-20 06:44:22 +00001843 if( pFile->dirfd>=0 ) close(pFile->dirfd);
1844 pFile->dirfd = -1;
danielk1977b4b47412007-08-17 15:53:36 +00001845 enterMutex();
drhbfe66312006-10-03 17:40:40 +00001846
danielk1977ad94b582007-08-20 06:44:22 +00001847 close(pFile->h);
danielk1977b4b47412007-08-17 15:53:36 +00001848 leaveMutex();
danielk1977ad94b582007-08-20 06:44:22 +00001849 OSTRACE2("CLOSE %-3d\n", pFile->h);
drhbfe66312006-10-03 17:40:40 +00001850 OpenCounter(-1);
drhbfe66312006-10-03 17:40:40 +00001851 return SQLITE_OK;
1852}
1853
1854#pragma mark Old-School .lock file based locking
1855
1856/*
1857 ** The dotlockLockingContext structure contains all dotlock (.lock) lock
1858 ** specific state
1859 */
1860typedef struct dotlockLockingContext dotlockLockingContext;
1861struct dotlockLockingContext {
1862 char *lockPath;
1863};
1864
1865
danielk1977ad94b582007-08-20 06:44:22 +00001866static int dotlockUnixCheckReservedLock(sqlite3_file *id) {
drhbfe66312006-10-03 17:40:40 +00001867 unixFile *pFile = (unixFile*)id;
1868 dotlockLockingContext *context =
1869 (dotlockLockingContext *) pFile->lockingContext;
1870
1871 if (pFile->locktype == RESERVED_LOCK) {
drh3b62b2f2007-06-08 18:27:03 +00001872 return 1; /* already have a reserved lock */
drhbfe66312006-10-03 17:40:40 +00001873 } else {
1874 struct stat statBuf;
1875 if (lstat(context->lockPath,&statBuf) == 0)
drh3b62b2f2007-06-08 18:27:03 +00001876 /* file exists, someone else has the lock */
drhbfe66312006-10-03 17:40:40 +00001877 return 1;
1878 else
drh3b62b2f2007-06-08 18:27:03 +00001879 /* file does not exist, we could have it if we want it */
drhbfe66312006-10-03 17:40:40 +00001880 return 0;
1881 }
1882}
1883
danielk1977ad94b582007-08-20 06:44:22 +00001884static int dotlockUnixLock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00001885 unixFile *pFile = (unixFile*)id;
1886 dotlockLockingContext *context =
1887 (dotlockLockingContext *) pFile->lockingContext;
1888
drh3b62b2f2007-06-08 18:27:03 +00001889 /* if we already have a lock, it is exclusive.
1890 ** Just adjust level and punt on outta here. */
drhbfe66312006-10-03 17:40:40 +00001891 if (pFile->locktype > NO_LOCK) {
1892 pFile->locktype = locktype;
1893
1894 /* Always update the timestamp on the old file */
1895 utimes(context->lockPath,NULL);
1896 return SQLITE_OK;
1897 }
1898
drh3b62b2f2007-06-08 18:27:03 +00001899 /* check to see if lock file already exists */
drhbfe66312006-10-03 17:40:40 +00001900 struct stat statBuf;
1901 if (lstat(context->lockPath,&statBuf) == 0){
drh3b62b2f2007-06-08 18:27:03 +00001902 return SQLITE_BUSY; /* it does, busy */
drhbfe66312006-10-03 17:40:40 +00001903 }
1904
drh3b62b2f2007-06-08 18:27:03 +00001905 /* grab an exclusive lock */
drhbfe66312006-10-03 17:40:40 +00001906 int fd = open(context->lockPath,O_RDONLY|O_CREAT|O_EXCL,0600);
1907 if (fd < 0) {
drh3b62b2f2007-06-08 18:27:03 +00001908 /* failed to open/create the file, someone else may have stolen the lock */
drhbfe66312006-10-03 17:40:40 +00001909 return SQLITE_BUSY;
1910 }
1911 close(fd);
1912
drh3b62b2f2007-06-08 18:27:03 +00001913 /* got it, set the type and return ok */
drhbfe66312006-10-03 17:40:40 +00001914 pFile->locktype = locktype;
1915 return SQLITE_OK;
1916}
1917
danielk1977ad94b582007-08-20 06:44:22 +00001918static int dotlockUnixUnlock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00001919 unixFile *pFile = (unixFile*)id;
1920 dotlockLockingContext *context =
1921 (dotlockLockingContext *) pFile->lockingContext;
1922
1923 assert( locktype<=SHARED_LOCK );
1924
drh3b62b2f2007-06-08 18:27:03 +00001925 /* no-op if possible */
drhbfe66312006-10-03 17:40:40 +00001926 if( pFile->locktype==locktype ){
1927 return SQLITE_OK;
1928 }
1929
drh3b62b2f2007-06-08 18:27:03 +00001930 /* shared can just be set because we always have an exclusive */
drhbfe66312006-10-03 17:40:40 +00001931 if (locktype==SHARED_LOCK) {
1932 pFile->locktype = locktype;
1933 return SQLITE_OK;
1934 }
1935
drh3b62b2f2007-06-08 18:27:03 +00001936 /* no, really, unlock. */
drhbfe66312006-10-03 17:40:40 +00001937 unlink(context->lockPath);
1938 pFile->locktype = NO_LOCK;
1939 return SQLITE_OK;
1940}
1941
1942/*
1943 ** Close a file.
1944 */
danielk1977ad94b582007-08-20 06:44:22 +00001945static int dotlockUnixClose(sqlite3_file *id) {
1946 unixFile *pFile = (unixFile*)id;
drhbfe66312006-10-03 17:40:40 +00001947
danielk1977ad94b582007-08-20 06:44:22 +00001948 if( !pFile ) return SQLITE_OK;
drhbfe66312006-10-03 17:40:40 +00001949 dotlockUnixUnlock(*pId, NO_LOCK);
1950 /* free the dotlock locking structure */
danielk1977ad94b582007-08-20 06:44:22 +00001951 if (pFile->lockingContext != NULL) {
1952 if (((dotlockLockingContext *)pFile->lockingContext)->lockPath != NULL)
drh17435752007-08-16 04:30:38 +00001953 sqlite3_free( ( (dotlockLockingContext *)
danielk1977ad94b582007-08-20 06:44:22 +00001954 pFile->lockingContext)->lockPath);
1955 sqlite3_free(pFile->lockingContext);
drhbfe66312006-10-03 17:40:40 +00001956 }
1957
danielk1977ad94b582007-08-20 06:44:22 +00001958 if( pFile->dirfd>=0 ) close(pFile->dirfd);
1959 pFile->dirfd = -1;
danielk1977b4b47412007-08-17 15:53:36 +00001960 enterMutex();
drhbfe66312006-10-03 17:40:40 +00001961
danielk1977ad94b582007-08-20 06:44:22 +00001962 close(pFile->h);
drhbfe66312006-10-03 17:40:40 +00001963
danielk1977b4b47412007-08-17 15:53:36 +00001964 leaveMutex();
danielk1977ad94b582007-08-20 06:44:22 +00001965 OSTRACE2("CLOSE %-3d\n", pFile->h);
drhbfe66312006-10-03 17:40:40 +00001966 OpenCounter(-1);
drhbfe66312006-10-03 17:40:40 +00001967 return SQLITE_OK;
1968}
1969
1970
1971#pragma mark No locking
1972
1973/*
1974 ** The nolockLockingContext is void
1975 */
1976typedef void nolockLockingContext;
1977
danielk1977ad94b582007-08-20 06:44:22 +00001978static int nolockUnixCheckReservedLock(sqlite3_file *id) {
drhbfe66312006-10-03 17:40:40 +00001979 return 0;
1980}
1981
danielk1977ad94b582007-08-20 06:44:22 +00001982static int nolockUnixLock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00001983 return SQLITE_OK;
1984}
1985
danielk1977ad94b582007-08-20 06:44:22 +00001986static int nolockUnixUnlock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00001987 return SQLITE_OK;
1988}
1989
1990/*
1991 ** Close a file.
1992 */
danielk1977ad94b582007-08-20 06:44:22 +00001993static int nolockUnixClose(sqlite3_file *id) {
1994 unixFile *pFile = (unixFile*)id;
drhbfe66312006-10-03 17:40:40 +00001995
danielk1977ad94b582007-08-20 06:44:22 +00001996 if( !pFile ) return SQLITE_OK;
1997 if( pFile->dirfd>=0 ) close(pFile->dirfd);
1998 pFile->dirfd = -1;
danielk1977b4b47412007-08-17 15:53:36 +00001999 enterMutex();
drhbfe66312006-10-03 17:40:40 +00002000
danielk1977ad94b582007-08-20 06:44:22 +00002001 close(pFile->h);
drhbfe66312006-10-03 17:40:40 +00002002
danielk1977b4b47412007-08-17 15:53:36 +00002003 leaveMutex();
danielk1977ad94b582007-08-20 06:44:22 +00002004 OSTRACE2("CLOSE %-3d\n", pFile->h);
drhbfe66312006-10-03 17:40:40 +00002005 OpenCounter(-1);
drhbfe66312006-10-03 17:40:40 +00002006 return SQLITE_OK;
2007}
2008
2009#endif /* SQLITE_ENABLE_LOCKING_STYLE */
2010
danielk1977ad94b582007-08-20 06:44:22 +00002011
danielk1977e3026632004-06-22 11:29:02 +00002012/*
drh9e33c2c2007-08-31 18:34:59 +00002013** Information and control of an open file handle.
drh18839212005-11-26 03:43:23 +00002014*/
drhcc6bb3e2007-08-31 16:11:35 +00002015static int unixFileControl(sqlite3_file *id, int op, void *pArg){
drh9e33c2c2007-08-31 18:34:59 +00002016 switch( op ){
2017 case SQLITE_FCNTL_LOCKSTATE: {
2018 *(int*)pArg = ((unixFile*)id)->locktype;
2019 return SQLITE_OK;
2020 }
2021 }
drhcc6bb3e2007-08-31 16:11:35 +00002022 return SQLITE_ERROR;
drh9cbe6352005-11-29 03:13:21 +00002023}
2024
2025/*
danielk1977a3d4c882007-03-23 10:08:38 +00002026** Return the sector size in bytes of the underlying block device for
2027** the specified file. This is almost always 512 bytes, but may be
2028** larger for some devices.
2029**
2030** SQLite code assumes this function cannot fail. It also assumes that
2031** if two files are created in the same file-system directory (i.e.
2032** a database and it's journal file) that the sector size will be the
2033** same for both.
2034*/
danielk197762079062007-08-15 17:08:46 +00002035static int unixSectorSize(sqlite3_file *id){
drh3ceeb752007-03-29 18:19:52 +00002036 return SQLITE_DEFAULT_SECTOR_SIZE;
danielk1977a3d4c882007-03-23 10:08:38 +00002037}
2038
danielk197790949c22007-08-17 16:50:38 +00002039/*
2040** Return the device characteristics for the file. This is always 0.
2041*/
danielk197762079062007-08-15 17:08:46 +00002042static int unixDeviceCharacteristics(sqlite3_file *id){
2043 return 0;
2044}
2045
danielk1977a3d4c882007-03-23 10:08:38 +00002046/*
danielk1977ad94b582007-08-20 06:44:22 +00002047** This vector defines all the methods that can operate on an sqlite3_file
drh054889e2005-11-30 03:20:31 +00002048** for unix.
drh9c06c952005-11-26 00:25:00 +00002049*/
danielk197762079062007-08-15 17:08:46 +00002050static const sqlite3_io_methods sqlite3UnixIoMethod = {
2051 1, /* iVersion */
drh9c06c952005-11-26 00:25:00 +00002052 unixClose,
2053 unixRead,
2054 unixWrite,
drh9c06c952005-11-26 00:25:00 +00002055 unixTruncate,
drh054889e2005-11-30 03:20:31 +00002056 unixSync,
drh054889e2005-11-30 03:20:31 +00002057 unixFileSize,
2058 unixLock,
2059 unixUnlock,
drh054889e2005-11-30 03:20:31 +00002060 unixCheckReservedLock,
drhcc6bb3e2007-08-31 16:11:35 +00002061 unixFileControl,
danielk1977a3d4c882007-03-23 10:08:38 +00002062 unixSectorSize,
danielk197762079062007-08-15 17:08:46 +00002063 unixDeviceCharacteristics
drh9c06c952005-11-26 00:25:00 +00002064};
2065
drhbfe66312006-10-03 17:40:40 +00002066#ifdef SQLITE_ENABLE_LOCKING_STYLE
drh054889e2005-11-30 03:20:31 +00002067/*
danielk1977ad94b582007-08-20 06:44:22 +00002068** This vector defines all the methods that can operate on an sqlite3_file
2069** for unix with AFP style file locking.
2070*/
2071static const sqlite3_io_methods sqlite3AFPLockingUnixIoMethod = {
2072 1, /* iVersion */
2073 unixClose,
drhbfe66312006-10-03 17:40:40 +00002074 unixRead,
2075 unixWrite,
drhbfe66312006-10-03 17:40:40 +00002076 unixTruncate,
2077 unixSync,
danielk1977ad94b582007-08-20 06:44:22 +00002078 unixFileSize,
2079 afpUnixLock,
2080 afpUnixUnlock,
2081 afpUnixCheckReservedLock,
drhcc6bb3e2007-08-31 16:11:35 +00002082 unixFileControl,
danielk1977ad94b582007-08-20 06:44:22 +00002083 unixSectorSize,
2084 unixDeviceCharacteristics
2085};
2086
2087/*
2088** This vector defines all the methods that can operate on an sqlite3_file
2089** for unix with flock() style file locking.
2090*/
2091static const sqlite3_io_methods sqlite3FlockLockingUnixIoMethod = {
2092 1, /* iVersion */
2093 flockUnixClose,
2094 unixRead,
2095 unixWrite,
2096 unixTruncate,
2097 unixSync,
2098 unixFileSize,
2099 flockUnixLock,
2100 flockUnixUnlock,
2101 flockUnixCheckReservedLock,
drhcc6bb3e2007-08-31 16:11:35 +00002102 unixFileControl,
danielk1977ad94b582007-08-20 06:44:22 +00002103 unixSectorSize,
2104 unixDeviceCharacteristics
2105};
2106
2107/*
2108** This vector defines all the methods that can operate on an sqlite3_file
2109** for unix with dotlock style file locking.
2110*/
2111static const sqlite3_io_methods sqlite3DotlockLockingUnixIoMethod = {
2112 1, /* iVersion */
2113 dotlockUnixClose,
2114 unixRead,
2115 unixWrite,
2116 unixTruncate,
2117 unixSync,
2118 unixFileSize,
2119 dotlockUnixLock,
2120 dotlockUnixUnlock,
2121 dotlockUnixCheckReservedLock,
drhcc6bb3e2007-08-31 16:11:35 +00002122 unixFileControl,
danielk1977ad94b582007-08-20 06:44:22 +00002123 unixSectorSize,
2124 unixDeviceCharacteristics
2125};
2126
2127/*
2128** This vector defines all the methods that can operate on an sqlite3_file
2129** for unix with dotlock style file locking.
2130*/
2131static const sqlite3_io_methods sqlite3NolockLockingUnixIoMethod = {
2132 1, /* iVersion */
2133 nolockUnixClose,
2134 unixRead,
2135 unixWrite,
2136 unixTruncate,
2137 unixSync,
drhbfe66312006-10-03 17:40:40 +00002138 unixFileSize,
2139 nolockUnixLock,
2140 nolockUnixUnlock,
drhbfe66312006-10-03 17:40:40 +00002141 nolockUnixCheckReservedLock,
drhcc6bb3e2007-08-31 16:11:35 +00002142 unixFileControl,
danielk1977a3d4c882007-03-23 10:08:38 +00002143 unixSectorSize,
danielk1977ad94b582007-08-20 06:44:22 +00002144 unixDeviceCharacteristics
drhbfe66312006-10-03 17:40:40 +00002145};
2146
2147#endif /* SQLITE_ENABLE_LOCKING_STYLE */
2148
2149/*
2150** Allocate memory for a new unixFile and initialize that unixFile.
2151** Write a pointer to the new unixFile into *pId.
2152** If we run out of memory, close the file and return an error.
drh054889e2005-11-30 03:20:31 +00002153*/
drhbfe66312006-10-03 17:40:40 +00002154#ifdef SQLITE_ENABLE_LOCKING_STYLE
2155/*
danielk1977ad94b582007-08-20 06:44:22 +00002156** When locking extensions are enabled, the filepath and locking style
2157** are needed to determine the unixFile pMethod to use for locking operations.
2158** The locking-style specific lockingContext data structure is created
2159** and assigned here also.
2160*/
2161static int fillInUnixFile(
drhbfe66312006-10-03 17:40:40 +00002162 int h, /* Open file descriptor of file being opened */
danielk1977ad94b582007-08-20 06:44:22 +00002163 int dirfd, /* Directory file descriptor */
2164 sqlite3_file *pId, /* Write completed initialization here */
drhbfe66312006-10-03 17:40:40 +00002165 const char *zFilename, /* Name of the file being opened */
drhbfe66312006-10-03 17:40:40 +00002166){
aswift108bc322006-10-11 17:19:46 +00002167 sqlite3LockingStyle lockingStyle;
danielk1977ad94b582007-08-20 06:44:22 +00002168 unixFile *pNew = (unixFile *)pId;
drhbfe66312006-10-03 17:40:40 +00002169 int rc;
2170
danielk1977ad94b582007-08-20 06:44:22 +00002171 memset(pNew, 0, sizeof(unixFile));
aswift448aa6f2006-11-11 01:31:58 +00002172 lockingStyle = sqlite3DetectLockingStyle(zFilename, h);
drhbfe66312006-10-03 17:40:40 +00002173 if ( lockingStyle == posixLockingStyle ) {
danielk1977b4b47412007-08-17 15:53:36 +00002174 enterMutex();
danielk1977ad94b582007-08-20 06:44:22 +00002175 rc = findLockInfo(h, &pNew->pLock, &pNew->pOpen);
danielk1977b4b47412007-08-17 15:53:36 +00002176 leaveMutex();
drhbfe66312006-10-03 17:40:40 +00002177 if( rc ){
2178 close(h);
2179 unlink(zFilename);
2180 return SQLITE_NOMEM;
2181 }
2182 } else {
drh3b62b2f2007-06-08 18:27:03 +00002183 /* pLock and pOpen are only used for posix advisory locking */
danielk1977ad94b582007-08-20 06:44:22 +00002184 pNew->pLock = NULL;
2185 pNew->pOpen = NULL;
drhbfe66312006-10-03 17:40:40 +00002186 }
danielk1977ad94b582007-08-20 06:44:22 +00002187 pNew->dirfd = -1;
2188 pNew->h = h;
2189 SET_THREADID(pNew);
drh17435752007-08-16 04:30:38 +00002190 pNew = sqlite3_malloc( sizeof(unixFile) );
drh054889e2005-11-30 03:20:31 +00002191 if( pNew==0 ){
drhbfe66312006-10-03 17:40:40 +00002192 close(h);
danielk1977b4b47412007-08-17 15:53:36 +00002193 enterMutex();
danielk1977ad94b582007-08-20 06:44:22 +00002194 releaseLockInfo(pNew->pLock);
2195 releaseOpenCnt(pNew->pOpen);
danielk1977b4b47412007-08-17 15:53:36 +00002196 leaveMutex();
drh054889e2005-11-30 03:20:31 +00002197 return SQLITE_NOMEM;
2198 }else{
aswift108bc322006-10-11 17:19:46 +00002199 switch(lockingStyle) {
drh5bb3eb92007-05-04 13:15:55 +00002200 case afpLockingStyle: {
drhbfe66312006-10-03 17:40:40 +00002201 /* afp locking uses the file path so it needs to be included in
2202 ** the afpLockingContext */
drh5bb3eb92007-05-04 13:15:55 +00002203 int nFilename;
drhbfe66312006-10-03 17:40:40 +00002204 pNew->pMethod = &sqlite3AFPLockingUnixIoMethod;
2205 pNew->lockingContext =
drh17435752007-08-16 04:30:38 +00002206 sqlite3_malloc(sizeof(afpLockingContext));
drh5bb3eb92007-05-04 13:15:55 +00002207 nFilename = strlen(zFilename)+1;
drhbfe66312006-10-03 17:40:40 +00002208 ((afpLockingContext *)pNew->lockingContext)->filePath =
drh17435752007-08-16 04:30:38 +00002209 sqlite3_malloc(nFilename);
drh5bb3eb92007-05-04 13:15:55 +00002210 memcpy(((afpLockingContext *)pNew->lockingContext)->filePath,
2211 zFilename, nFilename);
drhbfe66312006-10-03 17:40:40 +00002212 srandomdev();
2213 break;
drh5bb3eb92007-05-04 13:15:55 +00002214 }
drhbfe66312006-10-03 17:40:40 +00002215 case flockLockingStyle:
2216 /* flock locking doesn't need additional lockingContext information */
2217 pNew->pMethod = &sqlite3FlockLockingUnixIoMethod;
2218 break;
drh5bb3eb92007-05-04 13:15:55 +00002219 case dotlockLockingStyle: {
drhbfe66312006-10-03 17:40:40 +00002220 /* dotlock locking uses the file path so it needs to be included in
2221 ** the dotlockLockingContext */
drh5bb3eb92007-05-04 13:15:55 +00002222 int nFilename;
drhbfe66312006-10-03 17:40:40 +00002223 pNew->pMethod = &sqlite3DotlockLockingUnixIoMethod;
drh17435752007-08-16 04:30:38 +00002224 pNew->lockingContext = sqlite3_malloc(
drhbfe66312006-10-03 17:40:40 +00002225 sizeof(dotlockLockingContext));
drh5bb3eb92007-05-04 13:15:55 +00002226 nFilename = strlen(zFilename) + 6;
drhbfe66312006-10-03 17:40:40 +00002227 ((dotlockLockingContext *)pNew->lockingContext)->lockPath =
drh17435752007-08-16 04:30:38 +00002228 sqlite3_malloc( nFilename );
drh5bb3eb92007-05-04 13:15:55 +00002229 sqlite3_snprintf(nFilename,
2230 ((dotlockLockingContext *)pNew->lockingContext)->lockPath,
drhbfe66312006-10-03 17:40:40 +00002231 "%s.lock", zFilename);
2232 break;
drh5bb3eb92007-05-04 13:15:55 +00002233 }
drhbfe66312006-10-03 17:40:40 +00002234 case posixLockingStyle:
2235 /* posix locking doesn't need additional lockingContext information */
2236 pNew->pMethod = &sqlite3UnixIoMethod;
2237 break;
2238 case noLockingStyle:
2239 case unsupportedLockingStyle:
2240 default:
2241 pNew->pMethod = &sqlite3NolockLockingUnixIoMethod;
2242 }
drhbfe66312006-10-03 17:40:40 +00002243 OpenCounter(+1);
2244 return SQLITE_OK;
2245 }
2246}
2247#else /* SQLITE_ENABLE_LOCKING_STYLE */
danielk1977b4b47412007-08-17 15:53:36 +00002248static int fillInUnixFile(
drhbfe66312006-10-03 17:40:40 +00002249 int h, /* Open file descriptor on file being opened */
danielk1977fee2d252007-08-18 10:59:19 +00002250 int dirfd,
danielk1977b4b47412007-08-17 15:53:36 +00002251 sqlite3_file *pId, /* Write to the unixFile structure here */
2252 const char *zFilename /* Name of the file being opened */
drhbfe66312006-10-03 17:40:40 +00002253){
danielk1977b4b47412007-08-17 15:53:36 +00002254 unixFile *pNew = (unixFile *)pId;
drhbfe66312006-10-03 17:40:40 +00002255 int rc;
2256
drhe78669b2007-06-29 12:04:26 +00002257#ifdef FD_CLOEXEC
2258 fcntl(h, F_SETFD, fcntl(h, F_GETFD, 0) | FD_CLOEXEC);
2259#endif
danielk1977b4b47412007-08-17 15:53:36 +00002260
2261 enterMutex();
2262 rc = findLockInfo(h, &pNew->pLock, &pNew->pOpen);
2263 leaveMutex();
drhbfe66312006-10-03 17:40:40 +00002264 if( rc ){
2265 close(h);
2266 return SQLITE_NOMEM;
2267 }
danielk1977b4b47412007-08-17 15:53:36 +00002268
drh4f0c5872007-03-26 22:05:01 +00002269 OSTRACE3("OPEN %-3d %s\n", h, zFilename);
danielk1977b4b47412007-08-17 15:53:36 +00002270 pNew->dirfd = -1;
2271 pNew->h = h;
danielk1977fee2d252007-08-18 10:59:19 +00002272 pNew->dirfd = dirfd;
danielk1977b4b47412007-08-17 15:53:36 +00002273 SET_THREADID(pNew);
2274
2275 pNew->pMethod = &sqlite3UnixIoMethod;
2276 OpenCounter(+1);
2277 return SQLITE_OK;
drh054889e2005-11-30 03:20:31 +00002278}
drhbfe66312006-10-03 17:40:40 +00002279#endif /* SQLITE_ENABLE_LOCKING_STYLE */
drh9c06c952005-11-26 00:25:00 +00002280
danielk1977ad94b582007-08-20 06:44:22 +00002281/*
2282** Open a file descriptor to the directory containing file zFilename.
2283** If successful, *pFd is set to the opened file descriptor and
2284** SQLITE_OK is returned. If an error occurs, either SQLITE_NOMEM
2285** or SQLITE_CANTOPEN is returned and *pFd is set to an undefined
2286** value.
2287**
2288** If SQLITE_OK is returned, the caller is responsible for closing
2289** the file descriptor *pFd using close().
2290*/
danielk1977fee2d252007-08-18 10:59:19 +00002291static int openDirectory(const char *zFilename, int *pFd){
danielk1977fee2d252007-08-18 10:59:19 +00002292 int ii;
2293 int fd;
drhf3a65f72007-08-22 20:18:21 +00002294 char zDirname[MAX_PATHNAME+1];
danielk1977fee2d252007-08-18 10:59:19 +00002295
drh153c62c2007-08-24 03:51:33 +00002296 sqlite3_snprintf(MAX_PATHNAME, zDirname, "%s", zFilename);
danielk1977fee2d252007-08-18 10:59:19 +00002297 for(ii=strlen(zDirname); ii>=0 && zDirname[ii]!='/'; ii--);
2298 if( ii>0 ){
2299 zDirname[ii] = '\0';
2300 fd = open(zDirname, O_RDONLY|O_BINARY, 0);
2301 if( fd>0 ){
2302#ifdef FD_CLOEXEC
2303 fcntl(fd, F_SETFD, fcntl(fd, F_GETFD, 0) | FD_CLOEXEC);
2304#endif
2305 OSTRACE3("OPENDIR %-3d %s\n", fd, zDirname);
2306 }
2307 }
danielk1977fee2d252007-08-18 10:59:19 +00002308 *pFd = fd;
2309 return (fd>0?SQLITE_OK:SQLITE_CANTOPEN);
2310}
2311
danielk1977b4b47412007-08-17 15:53:36 +00002312/*
danielk1977ad94b582007-08-20 06:44:22 +00002313** Open the file zPath.
2314**
danielk1977b4b47412007-08-17 15:53:36 +00002315** Previously, the SQLite OS layer used three functions in place of this
2316** one:
2317**
2318** sqlite3OsOpenReadWrite();
2319** sqlite3OsOpenReadOnly();
2320** sqlite3OsOpenExclusive();
2321**
2322** These calls correspond to the following combinations of flags:
2323**
2324** ReadWrite() -> (READWRITE | CREATE)
2325** ReadOnly() -> (READONLY)
2326** OpenExclusive() -> (READWRITE | CREATE | EXCLUSIVE)
2327**
2328** The old OpenExclusive() accepted a boolean argument - "delFlag". If
2329** true, the file was configured to be automatically deleted when the
2330** file handle closed. To achieve the same effect using this new
2331** interface, add the DELETEONCLOSE flag to those specified above for
2332** OpenExclusive().
2333*/
2334static int unixOpen(
drh153c62c2007-08-24 03:51:33 +00002335 sqlite3_vfs *pVfs,
danielk1977b4b47412007-08-17 15:53:36 +00002336 const char *zPath,
2337 sqlite3_file *pFile,
2338 int flags,
2339 int *pOutFlags
2340){
danielk1977fee2d252007-08-18 10:59:19 +00002341 int fd = 0; /* File descriptor returned by open() */
2342 int dirfd = -1; /* Directory file descriptor */
2343 int oflags = 0; /* Flags to pass to open() */
2344 int eType = flags&0xFFFFFF00; /* Type of file to open */
danielk1977b4b47412007-08-17 15:53:36 +00002345
2346 int isExclusive = (flags & SQLITE_OPEN_EXCLUSIVE);
2347 int isDelete = (flags & SQLITE_OPEN_DELETEONCLOSE);
2348 int isCreate = (flags & SQLITE_OPEN_CREATE);
2349 int isReadonly = (flags & SQLITE_OPEN_READONLY);
2350 int isReadWrite = (flags & SQLITE_OPEN_READWRITE);
2351
danielk1977fee2d252007-08-18 10:59:19 +00002352 /* If creating a master or main-file journal, this function will open
2353 ** a file-descriptor on the directory too. The first time unixSync()
2354 ** is called the directory file descriptor will be fsync()ed and close()d.
2355 */
2356 int isOpenDirectory = (isCreate &&
2357 (eType==SQLITE_OPEN_MASTER_JOURNAL || eType==SQLITE_OPEN_MAIN_JOURNAL)
2358 );
2359
2360 /* Check the following statements are true:
2361 **
2362 ** (a) Exactly one of the READWRITE and READONLY flags must be set, and
2363 ** (b) if CREATE is set, then READWRITE must also be set, and
2364 ** (c) if EXCLUSIVE is set, then CREATE must also be set.
drh33f4e022007-09-03 15:19:34 +00002365 ** (d) if DELETEONCLOSE is set, then CREATE must also be set.
danielk1977fee2d252007-08-18 10:59:19 +00002366 */
danielk1977b4b47412007-08-17 15:53:36 +00002367 assert((isReadonly==0 || isReadWrite==0) && (isReadWrite || isReadonly));
danielk1977b4b47412007-08-17 15:53:36 +00002368 assert(isCreate==0 || isReadWrite);
danielk1977b4b47412007-08-17 15:53:36 +00002369 assert(isExclusive==0 || isCreate);
drh33f4e022007-09-03 15:19:34 +00002370 assert(isDelete==0 || isCreate);
2371
2372
2373 /* The main DB, main journal, and master journal are never automatically
2374 ** deleted
2375 */
2376 assert( eType!=SQLITE_OPEN_MAIN_DB || !isDelete );
2377 assert( eType!=SQLITE_OPEN_MAIN_JOURNAL || !isDelete );
2378 assert( eType!=SQLITE_OPEN_MASTER_JOURNAL || !isDelete );
danielk1977b4b47412007-08-17 15:53:36 +00002379
danielk1977fee2d252007-08-18 10:59:19 +00002380 /* Assert that the upper layer has set one of the "file-type" flags. */
2381 assert( eType==SQLITE_OPEN_MAIN_DB || eType==SQLITE_OPEN_TEMP_DB
2382 || eType==SQLITE_OPEN_MAIN_JOURNAL || eType==SQLITE_OPEN_TEMP_JOURNAL
2383 || eType==SQLITE_OPEN_SUBJOURNAL || eType==SQLITE_OPEN_MASTER_JOURNAL
drh33f4e022007-09-03 15:19:34 +00002384 || eType==SQLITE_OPEN_TRANSIENT_DB
danielk1977fee2d252007-08-18 10:59:19 +00002385 );
2386
danielk1977b4b47412007-08-17 15:53:36 +00002387 if( isReadonly ) oflags |= O_RDONLY;
2388 if( isReadWrite ) oflags |= O_RDWR;
2389 if( isCreate ) oflags |= O_CREAT;
2390 if( isExclusive ) oflags |= (O_EXCL|O_NOFOLLOW);
2391 oflags |= (O_LARGEFILE|O_BINARY);
2392
2393 memset(pFile, 0, sizeof(unixFile));
2394 fd = open(zPath, oflags, isDelete?0600:SQLITE_DEFAULT_FILE_PERMISSIONS);
danielk19772f2d8c72007-08-30 16:13:33 +00002395 if( fd<0 && errno!=EISDIR && isReadWrite && !isExclusive ){
danielk1977b4b47412007-08-17 15:53:36 +00002396 /* Failed to open the file for read/write access. Try read-only. */
2397 flags &= ~(SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE);
2398 flags |= SQLITE_OPEN_READONLY;
drh153c62c2007-08-24 03:51:33 +00002399 return unixOpen(pVfs, zPath, pFile, flags, pOutFlags);
danielk1977b4b47412007-08-17 15:53:36 +00002400 }
2401 if( fd<0 ){
2402 return SQLITE_CANTOPEN;
2403 }
2404 if( isDelete ){
2405 unlink(zPath);
2406 }
2407 if( pOutFlags ){
2408 *pOutFlags = flags;
2409 }
2410
2411 assert(fd!=0);
danielk1977fee2d252007-08-18 10:59:19 +00002412 if( isOpenDirectory ){
2413 int rc = openDirectory(zPath, &dirfd);
2414 if( rc!=SQLITE_OK ){
2415 close(fd);
2416 return rc;
2417 }
2418 }
2419 return fillInUnixFile(fd, dirfd, pFile, zPath);
danielk1977b4b47412007-08-17 15:53:36 +00002420}
2421
2422/*
danielk1977fee2d252007-08-18 10:59:19 +00002423** Delete the file at zPath. If the dirSync argument is true, fsync()
2424** the directory after deleting the file.
danielk1977b4b47412007-08-17 15:53:36 +00002425*/
drh153c62c2007-08-24 03:51:33 +00002426static int unixDelete(sqlite3_vfs *pVfs, const char *zPath, int dirSync){
danielk1977fee2d252007-08-18 10:59:19 +00002427 int rc = SQLITE_OK;
danielk1977b4b47412007-08-17 15:53:36 +00002428 SimulateIOError(return SQLITE_IOERR_DELETE);
2429 unlink(zPath);
danielk1977fee2d252007-08-18 10:59:19 +00002430 if( dirSync ){
2431 int fd;
2432 rc = openDirectory(zPath, &fd);
2433 if( rc==SQLITE_OK ){
2434 if( fsync(fd) ){
2435 rc = SQLITE_IOERR_DIR_FSYNC;
2436 }
2437 close(fd);
2438 }
2439 }
2440 return rc;
danielk1977b4b47412007-08-17 15:53:36 +00002441}
2442
danielk197790949c22007-08-17 16:50:38 +00002443/*
2444** Test the existance of or access permissions of file zPath. The
2445** test performed depends on the value of flags:
2446**
2447** SQLITE_ACCESS_EXISTS: Return 1 if the file exists
2448** SQLITE_ACCESS_READWRITE: Return 1 if the file is read and writable.
2449** SQLITE_ACCESS_READONLY: Return 1 if the file is readable.
2450**
2451** Otherwise return 0.
2452*/
drh153c62c2007-08-24 03:51:33 +00002453static int unixAccess(sqlite3_vfs *pVfs, const char *zPath, int flags){
danielk1977b4b47412007-08-17 15:53:36 +00002454 int amode;
2455 switch( flags ){
2456 case SQLITE_ACCESS_EXISTS:
2457 amode = F_OK;
2458 break;
2459 case SQLITE_ACCESS_READWRITE:
2460 amode = W_OK|R_OK;
2461 break;
drh50d3f902007-08-27 21:10:36 +00002462 case SQLITE_ACCESS_READ:
danielk1977b4b47412007-08-17 15:53:36 +00002463 amode = R_OK;
2464 break;
2465
2466 default:
2467 assert(!"Invalid flags argument");
2468 }
2469 return (access(zPath, amode)==0);
2470}
2471
2472/*
drh153c62c2007-08-24 03:51:33 +00002473** Create a temporary file name in zBuf. zBuf must be allocated
2474** by the calling process and must be big enough to hold at least
2475** pVfs->mxPathname bytes.
danielk1977b4b47412007-08-17 15:53:36 +00002476*/
danielk197776ee37f2007-09-17 06:06:39 +00002477static int unixGetTempname(sqlite3_vfs *pVfs, char *zBuf){
danielk1977b4b47412007-08-17 15:53:36 +00002478 static const char *azDirs[] = {
2479 0,
2480 "/var/tmp",
2481 "/usr/tmp",
2482 "/tmp",
2483 ".",
2484 };
2485 static const unsigned char zChars[] =
2486 "abcdefghijklmnopqrstuvwxyz"
2487 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
2488 "0123456789";
2489 int i, j;
2490 struct stat buf;
2491 const char *zDir = ".";
danielk1977843e65f2007-09-01 16:16:15 +00002492
2493 /* It's odd to simulate an io-error here, but really this is just
2494 ** using the io-error infrastructure to test that SQLite handles this
2495 ** function failing.
2496 */
2497 SimulateIOError( return SQLITE_ERROR );
2498
danielk1977b4b47412007-08-17 15:53:36 +00002499 azDirs[0] = sqlite3_temp_directory;
2500 for(i=0; i<sizeof(azDirs)/sizeof(azDirs[0]); i++){
2501 if( azDirs[i]==0 ) continue;
2502 if( stat(azDirs[i], &buf) ) continue;
2503 if( !S_ISDIR(buf.st_mode) ) continue;
2504 if( access(azDirs[i], 07) ) continue;
2505 zDir = azDirs[i];
2506 break;
2507 }
2508 do{
drh153c62c2007-08-24 03:51:33 +00002509 assert( pVfs->mxPathname==MAX_PATHNAME );
2510 sqlite3_snprintf(MAX_PATHNAME-17, zBuf, "%s/"SQLITE_TEMP_FILE_PREFIX, zDir);
danielk1977b4b47412007-08-17 15:53:36 +00002511 j = strlen(zBuf);
2512 sqlite3Randomness(15, &zBuf[j]);
2513 for(i=0; i<15; i++, j++){
2514 zBuf[j] = (char)zChars[ ((unsigned char)zBuf[j])%(sizeof(zChars)-1) ];
2515 }
2516 zBuf[j] = 0;
2517 }while( access(zBuf,0)==0 );
2518 return SQLITE_OK;
2519}
2520
2521
2522/*
2523** Turn a relative pathname into a full pathname. The relative path
2524** is stored as a nul-terminated string in the buffer pointed to by
2525** zPath.
2526**
2527** zOut points to a buffer of at least sqlite3_vfs.mxPathname bytes
2528** (in this case, MAX_PATHNAME bytes). The full-path is written to
2529** this buffer before returning.
2530*/
drh153c62c2007-08-24 03:51:33 +00002531static int unixFullPathname(sqlite3_vfs *pVfs, const char *zPath, char *zOut){
danielk1977843e65f2007-09-01 16:16:15 +00002532
2533 /* It's odd to simulate an io-error here, but really this is just
2534 ** using the io-error infrastructure to test that SQLite handles this
2535 ** function failing. This function could fail if, for example, the
2536 ** current working directly has been unlinked.
2537 */
2538 SimulateIOError( return SQLITE_ERROR );
2539
drh153c62c2007-08-24 03:51:33 +00002540 assert( pVfs->mxPathname==MAX_PATHNAME );
danielk1977b4b47412007-08-17 15:53:36 +00002541 zOut[MAX_PATHNAME-1] = '\0';
2542 if( zPath[0]=='/' ){
drh153c62c2007-08-24 03:51:33 +00002543 sqlite3_snprintf(MAX_PATHNAME, zOut, "%s", zPath);
danielk1977b4b47412007-08-17 15:53:36 +00002544 }else{
2545 int nCwd;
2546 if( getcwd(zOut, MAX_PATHNAME-1)==0 ){
drh70c01452007-09-03 17:42:17 +00002547 return SQLITE_CANTOPEN;
danielk1977b4b47412007-08-17 15:53:36 +00002548 }
2549 nCwd = strlen(zOut);
drh153c62c2007-08-24 03:51:33 +00002550 sqlite3_snprintf(MAX_PATHNAME-nCwd, &zOut[nCwd], "/%s", zPath);
danielk1977b4b47412007-08-17 15:53:36 +00002551 }
2552 return SQLITE_OK;
2553
2554#if 0
2555 /*
2556 ** Remove "/./" path elements and convert "/A/./" path elements
2557 ** to just "/".
2558 */
2559 if( zFull ){
2560 int i, j;
2561 for(i=j=0; zFull[i]; i++){
2562 if( zFull[i]=='/' ){
2563 if( zFull[i+1]=='/' ) continue;
2564 if( zFull[i+1]=='.' && zFull[i+2]=='/' ){
2565 i += 1;
2566 continue;
2567 }
2568 if( zFull[i+1]=='.' && zFull[i+2]=='.' && zFull[i+3]=='/' ){
2569 while( j>0 && zFull[j-1]!='/' ){ j--; }
2570 i += 3;
2571 continue;
2572 }
2573 }
2574 zFull[j++] = zFull[i];
2575 }
2576 zFull[j] = 0;
2577 }
2578#endif
2579}
2580
drh0ccebe72005-06-07 22:22:50 +00002581
drh761df872006-12-21 01:29:22 +00002582#ifndef SQLITE_OMIT_LOAD_EXTENSION
2583/*
2584** Interfaces for opening a shared library, finding entry points
2585** within the shared library, and closing the shared library.
2586*/
2587#include <dlfcn.h>
drh153c62c2007-08-24 03:51:33 +00002588static void *unixDlOpen(sqlite3_vfs *pVfs, const char *zFilename){
drh761df872006-12-21 01:29:22 +00002589 return dlopen(zFilename, RTLD_NOW | RTLD_GLOBAL);
2590}
danielk197795c8a542007-09-01 06:51:27 +00002591
2592/*
2593** SQLite calls this function immediately after a call to unixDlSym() or
2594** unixDlOpen() fails (returns a null pointer). If a more detailed error
2595** message is available, it is written to zBufOut. If no error message
2596** is available, zBufOut is left unmodified and SQLite uses a default
2597** error message.
2598*/
drh153c62c2007-08-24 03:51:33 +00002599static void unixDlError(sqlite3_vfs *pVfs, int nBuf, char *zBufOut){
danielk1977b4b47412007-08-17 15:53:36 +00002600 char *zErr;
2601 enterMutex();
2602 zErr = dlerror();
2603 if( zErr ){
drh153c62c2007-08-24 03:51:33 +00002604 sqlite3_snprintf(nBuf, zBufOut, "%s", zErr);
danielk1977b4b47412007-08-17 15:53:36 +00002605 }
2606 leaveMutex();
2607}
drh46c99e02007-08-27 23:26:59 +00002608static void *unixDlSym(sqlite3_vfs *pVfs, void *pHandle, const char *zSymbol){
drh761df872006-12-21 01:29:22 +00002609 return dlsym(pHandle, zSymbol);
2610}
drh46c99e02007-08-27 23:26:59 +00002611static void unixDlClose(sqlite3_vfs *pVfs, void *pHandle){
danielk1977b4b47412007-08-17 15:53:36 +00002612 dlclose(pHandle);
drh761df872006-12-21 01:29:22 +00002613}
danielk1977b4b47412007-08-17 15:53:36 +00002614#else /* if SQLITE_OMIT_LOAD_EXTENSION is defined: */
2615 #define unixDlOpen 0
2616 #define unixDlError 0
2617 #define unixDlSym 0
2618 #define unixDlClose 0
2619#endif
2620
2621/*
danielk197790949c22007-08-17 16:50:38 +00002622** Write nBuf bytes of random data to the supplied buffer zBuf.
drhbbd42a62004-05-22 17:41:58 +00002623*/
drh153c62c2007-08-24 03:51:33 +00002624static int unixRandomness(sqlite3_vfs *pVfs, int nBuf, char *zBuf){
danielk197790949c22007-08-17 16:50:38 +00002625
2626 assert(nBuf>=(sizeof(time_t)+sizeof(int)));
2627
drhbbd42a62004-05-22 17:41:58 +00002628 /* We have to initialize zBuf to prevent valgrind from reporting
2629 ** errors. The reports issued by valgrind are incorrect - we would
2630 ** prefer that the randomness be increased by making use of the
2631 ** uninitialized space in zBuf - but valgrind errors tend to worry
2632 ** some users. Rather than argue, it seems easier just to initialize
2633 ** the whole array and silence valgrind, even if that means less randomness
2634 ** in the random seed.
2635 **
2636 ** When testing, initializing zBuf[] to zero is all we do. That means
drhf1a221e2006-01-15 17:27:17 +00002637 ** that we always use the same random number sequence. This makes the
drhbbd42a62004-05-22 17:41:58 +00002638 ** tests repeatable.
2639 */
danielk1977b4b47412007-08-17 15:53:36 +00002640 memset(zBuf, 0, nBuf);
drhbbd42a62004-05-22 17:41:58 +00002641#if !defined(SQLITE_TEST)
2642 {
drh842b8642005-01-21 17:53:17 +00002643 int pid, fd;
2644 fd = open("/dev/urandom", O_RDONLY);
2645 if( fd<0 ){
drh07397232006-01-06 14:46:46 +00002646 time_t t;
2647 time(&t);
danielk197790949c22007-08-17 16:50:38 +00002648 memcpy(zBuf, &t, sizeof(t));
2649 pid = getpid();
2650 memcpy(&zBuf[sizeof(t)], &pid, sizeof(pid));
drh842b8642005-01-21 17:53:17 +00002651 }else{
danielk1977b4b47412007-08-17 15:53:36 +00002652 read(fd, zBuf, nBuf);
drh842b8642005-01-21 17:53:17 +00002653 close(fd);
2654 }
drhbbd42a62004-05-22 17:41:58 +00002655 }
2656#endif
2657 return SQLITE_OK;
2658}
2659
danielk1977b4b47412007-08-17 15:53:36 +00002660
drhbbd42a62004-05-22 17:41:58 +00002661/*
2662** Sleep for a little while. Return the amount of time slept.
danielk1977b4b47412007-08-17 15:53:36 +00002663** The argument is the number of microseconds we want to sleep.
drh4a50aac2007-08-23 02:47:53 +00002664** The return value is the number of microseconds of sleep actually
2665** requested from the underlying operating system, a number which
2666** might be greater than or equal to the argument, but not less
2667** than the argument.
drhbbd42a62004-05-22 17:41:58 +00002668*/
drh153c62c2007-08-24 03:51:33 +00002669static int unixSleep(sqlite3_vfs *pVfs, int microseconds){
drhbbd42a62004-05-22 17:41:58 +00002670#if defined(HAVE_USLEEP) && HAVE_USLEEP
danielk1977b4b47412007-08-17 15:53:36 +00002671 usleep(microseconds);
2672 return microseconds;
drhbbd42a62004-05-22 17:41:58 +00002673#else
danielk1977b4b47412007-08-17 15:53:36 +00002674 int seconds = (microseconds+999999)/1000000;
2675 sleep(seconds);
drh4a50aac2007-08-23 02:47:53 +00002676 return seconds*1000000;
drha3fad6f2006-01-18 14:06:37 +00002677#endif
drh88f474a2006-01-02 20:00:12 +00002678}
2679
2680/*
drhbbd42a62004-05-22 17:41:58 +00002681** The following variable, if set to a non-zero value, becomes the result
drh66560ad2006-01-06 14:32:19 +00002682** returned from sqlite3OsCurrentTime(). This is used for testing.
drhbbd42a62004-05-22 17:41:58 +00002683*/
2684#ifdef SQLITE_TEST
2685int sqlite3_current_time = 0;
2686#endif
2687
2688/*
2689** Find the current time (in Universal Coordinated Time). Write the
2690** current time and date as a Julian Day number into *prNow and
2691** return 0. Return 1 if the time and date cannot be found.
2692*/
drh153c62c2007-08-24 03:51:33 +00002693static int unixCurrentTime(sqlite3_vfs *pVfs, double *prNow){
drh19e2d372005-08-29 23:00:03 +00002694#ifdef NO_GETTOD
drhbbd42a62004-05-22 17:41:58 +00002695 time_t t;
2696 time(&t);
2697 *prNow = t/86400.0 + 2440587.5;
drh19e2d372005-08-29 23:00:03 +00002698#else
2699 struct timeval sNow;
drhbdcc2762007-04-02 18:06:57 +00002700 gettimeofday(&sNow, 0);
drh19e2d372005-08-29 23:00:03 +00002701 *prNow = 2440587.5 + sNow.tv_sec/86400.0 + sNow.tv_usec/86400000000.0;
2702#endif
drhbbd42a62004-05-22 17:41:58 +00002703#ifdef SQLITE_TEST
2704 if( sqlite3_current_time ){
2705 *prNow = sqlite3_current_time/86400.0 + 2440587.5;
2706 }
2707#endif
2708 return 0;
2709}
danielk1977b4b47412007-08-17 15:53:36 +00002710
drh153c62c2007-08-24 03:51:33 +00002711/*
2712** Return a pointer to the sqlite3DefaultVfs structure. We use
2713** a function rather than give the structure global scope because
2714** some compilers (MSVC) do not allow forward declarations of
2715** initialized structures.
2716*/
2717sqlite3_vfs *sqlite3OsDefaultVfs(void){
2718 static sqlite3_vfs unixVfs = {
2719 1, /* iVersion */
2720 sizeof(unixFile), /* szOsFile */
2721 MAX_PATHNAME, /* mxPathname */
drh153c62c2007-08-24 03:51:33 +00002722 0, /* pNext */
2723 "unix", /* zName */
2724 0, /* pAppData */
2725
2726 unixOpen, /* xOpen */
2727 unixDelete, /* xDelete */
2728 unixAccess, /* xAccess */
danielk197776ee37f2007-09-17 06:06:39 +00002729 unixGetTempname, /* xGetTempName */
drh153c62c2007-08-24 03:51:33 +00002730 unixFullPathname, /* xFullPathname */
2731 unixDlOpen, /* xDlOpen */
2732 unixDlError, /* xDlError */
2733 unixDlSym, /* xDlSym */
2734 unixDlClose, /* xDlClose */
2735 unixRandomness, /* xRandomness */
2736 unixSleep, /* xSleep */
2737 unixCurrentTime /* xCurrentTime */
2738 };
2739
2740 return &unixVfs;
2741}
drhdce8bdb2007-08-16 13:01:44 +00002742
drhbbd42a62004-05-22 17:41:58 +00002743#endif /* OS_UNIX */