blob: f78cb7ec8571e10ce989bbf26e4a8d35d8d70a4b [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.
danielk1977822a5162008-05-16 04:51:54 +000014**
aswift5b1a2562008-08-22 00:22:35 +000015** $Id: os_unix.c,v 1.196 2008/08/22 00:22:35 aswift Exp $
drhbbd42a62004-05-22 17:41:58 +000016*/
drhbbd42a62004-05-22 17:41:58 +000017#include "sqliteInt.h"
danielk197729bafea2008-06-26 10:41:19 +000018#if SQLITE_OS_UNIX /* This file is used on unix only */
drh66560ad2006-01-06 14:32:19 +000019
danielk1977e339d652008-06-28 11:23:00 +000020/*
21** If SQLITE_ENABLE_LOCKING_STYLE is defined, then several different
22** locking implementations are provided:
23**
24** * POSIX locking (the default),
25** * No locking,
26** * Dot-file locking,
27** * flock() locking,
28** * AFP locking (OSX only).
29*/
drhbfe66312006-10-03 17:40:40 +000030/* #define SQLITE_ENABLE_LOCKING_STYLE 0 */
31
drh9cbe6352005-11-29 03:13:21 +000032/*
33** These #defines should enable >2GB file support on Posix if the
34** underlying operating system supports it. If the OS lacks
drhf1a221e2006-01-15 17:27:17 +000035** large file support, these should be no-ops.
drh9cbe6352005-11-29 03:13:21 +000036**
37** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
38** on the compiler command line. This is necessary if you are compiling
39** on a recent machine (ex: RedHat 7.2) but you want your code to work
40** on an older machine (ex: RedHat 6.0). If you compile on RedHat 7.2
41** without this option, LFS is enable. But LFS does not exist in the kernel
42** in RedHat 6.0, so the code won't work. Hence, for maximum binary
43** portability you should omit LFS.
drh9cbe6352005-11-29 03:13:21 +000044*/
45#ifndef SQLITE_DISABLE_LFS
46# define _LARGE_FILE 1
47# ifndef _FILE_OFFSET_BITS
48# define _FILE_OFFSET_BITS 64
49# endif
50# define _LARGEFILE_SOURCE 1
51#endif
drhbbd42a62004-05-22 17:41:58 +000052
drh9cbe6352005-11-29 03:13:21 +000053/*
54** standard include files.
55*/
56#include <sys/types.h>
57#include <sys/stat.h>
58#include <fcntl.h>
59#include <unistd.h>
drhbbd42a62004-05-22 17:41:58 +000060#include <time.h>
drh19e2d372005-08-29 23:00:03 +000061#include <sys/time.h>
drhbbd42a62004-05-22 17:41:58 +000062#include <errno.h>
danielk1977e339d652008-06-28 11:23:00 +000063
drhbfe66312006-10-03 17:40:40 +000064#ifdef SQLITE_ENABLE_LOCKING_STYLE
65#include <sys/ioctl.h>
66#include <sys/param.h>
67#include <sys/mount.h>
68#endif /* SQLITE_ENABLE_LOCKING_STYLE */
drh9cbe6352005-11-29 03:13:21 +000069
70/*
drhf1a221e2006-01-15 17:27:17 +000071** If we are to be thread-safe, include the pthreads header and define
72** the SQLITE_UNIX_THREADS macro.
drh9cbe6352005-11-29 03:13:21 +000073*/
drhd677b3d2007-08-20 22:48:41 +000074#if SQLITE_THREADSAFE
drh9cbe6352005-11-29 03:13:21 +000075# include <pthread.h>
76# define SQLITE_UNIX_THREADS 1
77#endif
78
79/*
80** Default permissions when creating a new file
81*/
82#ifndef SQLITE_DEFAULT_FILE_PERMISSIONS
83# define SQLITE_DEFAULT_FILE_PERMISSIONS 0644
84#endif
85
danielk1977b4b47412007-08-17 15:53:36 +000086/*
87** Maximum supported path-length.
88*/
89#define MAX_PATHNAME 512
drh9cbe6352005-11-29 03:13:21 +000090
91
92/*
danielk1977ad94b582007-08-20 06:44:22 +000093** The unixFile structure is subclass of sqlite3_file specific for the unix
drh054889e2005-11-30 03:20:31 +000094** protability layer.
drh9cbe6352005-11-29 03:13:21 +000095*/
drh054889e2005-11-30 03:20:31 +000096typedef struct unixFile unixFile;
97struct unixFile {
danielk197762079062007-08-15 17:08:46 +000098 sqlite3_io_methods const *pMethod; /* Always the first entry */
danielk1977967a4a12007-08-20 14:23:44 +000099#ifdef SQLITE_TEST
100 /* In test mode, increase the size of this structure a bit so that
101 ** it is larger than the struct CrashFile defined in test6.c.
102 */
103 char aPadding[32];
104#endif
drh9cbe6352005-11-29 03:13:21 +0000105 struct openCnt *pOpen; /* Info about all open fd's on this inode */
106 struct lockInfo *pLock; /* Info about locks on this inode */
drhbfe66312006-10-03 17:40:40 +0000107#ifdef SQLITE_ENABLE_LOCKING_STYLE
108 void *lockingContext; /* Locking style specific state */
danielk1977e339d652008-06-28 11:23:00 +0000109#endif
drh9cbe6352005-11-29 03:13:21 +0000110 int h; /* The file descriptor */
111 unsigned char locktype; /* The type of lock held on this fd */
drh9cbe6352005-11-29 03:13:21 +0000112 int dirfd; /* File descriptor for the directory */
drhd677b3d2007-08-20 22:48:41 +0000113#if SQLITE_THREADSAFE
danielk1977ad94b582007-08-20 06:44:22 +0000114 pthread_t tid; /* The thread that "owns" this unixFile */
drh9cbe6352005-11-29 03:13:21 +0000115#endif
aswift5b1a2562008-08-22 00:22:35 +0000116 int lastErrno; /* The unix errno from the last I/O error */
drh9cbe6352005-11-29 03:13:21 +0000117};
118
drh0ccebe72005-06-07 22:22:50 +0000119/*
drh198bf392006-01-06 21:52:49 +0000120** Include code that is common to all os_*.c files
121*/
122#include "os_common.h"
123
124/*
drh0ccebe72005-06-07 22:22:50 +0000125** Define various macros that are missing from some systems.
126*/
drhbbd42a62004-05-22 17:41:58 +0000127#ifndef O_LARGEFILE
128# define O_LARGEFILE 0
129#endif
130#ifdef SQLITE_DISABLE_LFS
131# undef O_LARGEFILE
132# define O_LARGEFILE 0
133#endif
134#ifndef O_NOFOLLOW
135# define O_NOFOLLOW 0
136#endif
137#ifndef O_BINARY
138# define O_BINARY 0
139#endif
140
141/*
142** The DJGPP compiler environment looks mostly like Unix, but it
143** lacks the fcntl() system call. So redefine fcntl() to be something
144** that always succeeds. This means that locking does not occur under
drh85b623f2007-12-13 21:54:09 +0000145** DJGPP. But it is DOS - what did you expect?
drhbbd42a62004-05-22 17:41:58 +0000146*/
147#ifdef __DJGPP__
148# define fcntl(A,B,C) 0
149#endif
150
151/*
drh2b4b5962005-06-15 17:47:55 +0000152** The threadid macro resolves to the thread-id or to 0. Used for
153** testing and debugging only.
154*/
drhd677b3d2007-08-20 22:48:41 +0000155#if SQLITE_THREADSAFE
drh2b4b5962005-06-15 17:47:55 +0000156#define threadid pthread_self()
157#else
158#define threadid 0
159#endif
160
161/*
danielk1977ad94b582007-08-20 06:44:22 +0000162** Set or check the unixFile.tid field. This field is set when an unixFile
163** is first opened. All subsequent uses of the unixFile verify that the
164** same thread is operating on the unixFile. Some operating systems do
drh2b4b5962005-06-15 17:47:55 +0000165** not allow locks to be overridden by other threads and that restriction
166** means that sqlite3* database handles cannot be moved from one thread
167** to another. This logic makes sure a user does not try to do that
168** by mistake.
drhf1a221e2006-01-15 17:27:17 +0000169**
danielk1977ad94b582007-08-20 06:44:22 +0000170** Version 3.3.1 (2006-01-15): unixFile can be moved from one thread to
drhf1a221e2006-01-15 17:27:17 +0000171** another as long as we are running on a system that supports threads
172** overriding each others locks (which now the most common behavior)
danielk1977ad94b582007-08-20 06:44:22 +0000173** or if no locks are held. But the unixFile.pLock field needs to be
drhf1a221e2006-01-15 17:27:17 +0000174** recomputed because its key includes the thread-id. See the
175** transferOwnership() function below for additional information
drh2b4b5962005-06-15 17:47:55 +0000176*/
drhd677b3d2007-08-20 22:48:41 +0000177#if SQLITE_THREADSAFE
drh9cbe6352005-11-29 03:13:21 +0000178# define SET_THREADID(X) (X)->tid = pthread_self()
drh029b44b2006-01-15 00:13:15 +0000179# define CHECK_THREADID(X) (threadsOverrideEachOthersLocks==0 && \
180 !pthread_equal((X)->tid, pthread_self()))
drh2b4b5962005-06-15 17:47:55 +0000181#else
182# define SET_THREADID(X)
183# define CHECK_THREADID(X) 0
danielk197713adf8a2004-06-03 16:08:41 +0000184#endif
185
drhbbd42a62004-05-22 17:41:58 +0000186/*
187** Here is the dirt on POSIX advisory locks: ANSI STD 1003.1 (1996)
188** section 6.5.2.2 lines 483 through 490 specify that when a process
189** sets or clears a lock, that operation overrides any prior locks set
190** by the same process. It does not explicitly say so, but this implies
191** that it overrides locks set by the same process using a different
192** file descriptor. Consider this test case:
drhbbd42a62004-05-22 17:41:58 +0000193** int fd2 = open("./file2", O_RDWR|O_CREAT, 0644);
194**
195** Suppose ./file1 and ./file2 are really the same file (because
196** one is a hard or symbolic link to the other) then if you set
197** an exclusive lock on fd1, then try to get an exclusive lock
198** on fd2, it works. I would have expected the second lock to
199** fail since there was already a lock on the file due to fd1.
200** But not so. Since both locks came from the same process, the
201** second overrides the first, even though they were on different
202** file descriptors opened on different file names.
203**
204** Bummer. If you ask me, this is broken. Badly broken. It means
205** that we cannot use POSIX locks to synchronize file access among
206** competing threads of the same process. POSIX locks will work fine
207** to synchronize access for threads in separate processes, but not
208** threads within the same process.
209**
210** To work around the problem, SQLite has to manage file locks internally
211** on its own. Whenever a new database is opened, we have to find the
212** specific inode of the database file (the inode is determined by the
213** st_dev and st_ino fields of the stat structure that fstat() fills in)
214** and check for locks already existing on that inode. When locks are
215** created or removed, we have to look at our own internal record of the
216** locks to see if another thread has previously set a lock on that same
217** inode.
218**
danielk1977ad94b582007-08-20 06:44:22 +0000219** The sqlite3_file structure for POSIX is no longer just an integer file
drhbbd42a62004-05-22 17:41:58 +0000220** descriptor. It is now a structure that holds the integer file
221** descriptor and a pointer to a structure that describes the internal
222** locks on the corresponding inode. There is one locking structure
danielk1977ad94b582007-08-20 06:44:22 +0000223** per inode, so if the same inode is opened twice, both unixFile structures
drhbbd42a62004-05-22 17:41:58 +0000224** point to the same locking structure. The locking structure keeps
225** a reference count (so we will know when to delete it) and a "cnt"
226** field that tells us its internal lock status. cnt==0 means the
227** file is unlocked. cnt==-1 means the file has an exclusive lock.
228** cnt>0 means there are cnt shared locks on the file.
229**
230** Any attempt to lock or unlock a file first checks the locking
231** structure. The fcntl() system call is only invoked to set a
232** POSIX lock if the internal lock structure transitions between
233** a locked and an unlocked state.
234**
235** 2004-Jan-11:
236** More recent discoveries about POSIX advisory locks. (The more
237** I discover, the more I realize the a POSIX advisory locks are
238** an abomination.)
239**
240** If you close a file descriptor that points to a file that has locks,
241** all locks on that file that are owned by the current process are
danielk1977ad94b582007-08-20 06:44:22 +0000242** released. To work around this problem, each unixFile structure contains
drhbbd42a62004-05-22 17:41:58 +0000243** a pointer to an openCnt structure. There is one openCnt structure
danielk1977ad94b582007-08-20 06:44:22 +0000244** per open inode, which means that multiple unixFile can point to a single
245** openCnt. When an attempt is made to close an unixFile, if there are
246** other unixFile open on the same inode that are holding locks, the call
drhbbd42a62004-05-22 17:41:58 +0000247** to close() the file descriptor is deferred until all of the locks clear.
248** The openCnt structure keeps a list of file descriptors that need to
249** be closed and that list is walked (and cleared) when the last lock
250** clears.
251**
252** First, under Linux threads, because each thread has a separate
253** process ID, lock operations in one thread do not override locks
254** to the same file in other threads. Linux threads behave like
255** separate processes in this respect. But, if you close a file
256** descriptor in linux threads, all locks are cleared, even locks
257** on other threads and even though the other threads have different
258** process IDs. Linux threads is inconsistent in this respect.
259** (I'm beginning to think that linux threads is an abomination too.)
260** The consequence of this all is that the hash table for the lockInfo
261** structure has to include the process id as part of its key because
262** locks in different threads are treated as distinct. But the
263** openCnt structure should not include the process id in its
264** key because close() clears lock on all threads, not just the current
265** thread. Were it not for this goofiness in linux threads, we could
266** combine the lockInfo and openCnt structures into a single structure.
drh5fdae772004-06-29 03:29:00 +0000267**
268** 2004-Jun-28:
269** On some versions of linux, threads can override each others locks.
270** On others not. Sometimes you can change the behavior on the same
271** system by setting the LD_ASSUME_KERNEL environment variable. The
272** POSIX standard is silent as to which behavior is correct, as far
273** as I can tell, so other versions of unix might show the same
274** inconsistency. There is no little doubt in my mind that posix
275** advisory locks and linux threads are profoundly broken.
276**
277** To work around the inconsistencies, we have to test at runtime
278** whether or not threads can override each others locks. This test
279** is run once, the first time any lock is attempted. A static
280** variable is set to record the results of this test for future
281** use.
drhbbd42a62004-05-22 17:41:58 +0000282*/
283
284/*
285** An instance of the following structure serves as the key used
drh5fdae772004-06-29 03:29:00 +0000286** to locate a particular lockInfo structure given its inode.
287**
288** If threads cannot override each others locks, then we set the
289** lockKey.tid field to the thread ID. If threads can override
drhf1a221e2006-01-15 17:27:17 +0000290** each others locks then tid is always set to zero. tid is omitted
291** if we compile without threading support.
drhbbd42a62004-05-22 17:41:58 +0000292*/
293struct lockKey {
drh5fdae772004-06-29 03:29:00 +0000294 dev_t dev; /* Device number */
295 ino_t ino; /* Inode number */
drhd677b3d2007-08-20 22:48:41 +0000296#if SQLITE_THREADSAFE
drhd9cb6ac2005-10-20 07:28:17 +0000297 pthread_t tid; /* Thread ID or zero if threads can override each other */
drh5fdae772004-06-29 03:29:00 +0000298#endif
drhbbd42a62004-05-22 17:41:58 +0000299};
300
301/*
302** An instance of the following structure is allocated for each open
303** inode on each thread with a different process ID. (Threads have
304** different process IDs on linux, but not on most other unixes.)
305**
danielk1977ad94b582007-08-20 06:44:22 +0000306** A single inode can have multiple file descriptors, so each unixFile
drhbbd42a62004-05-22 17:41:58 +0000307** structure contains a pointer to an instance of this object and this
danielk1977ad94b582007-08-20 06:44:22 +0000308** object keeps a count of the number of unixFile pointing to it.
drhbbd42a62004-05-22 17:41:58 +0000309*/
310struct lockInfo {
311 struct lockKey key; /* The lookup key */
drh2ac3ee92004-06-07 16:27:46 +0000312 int cnt; /* Number of SHARED locks held */
danielk19779a1d0ab2004-06-01 14:09:28 +0000313 int locktype; /* One of SHARED_LOCK, RESERVED_LOCK etc. */
drhbbd42a62004-05-22 17:41:58 +0000314 int nRef; /* Number of pointers to this structure */
drhda0e7682008-07-30 15:27:54 +0000315 struct lockInfo *pNext, *pPrev; /* List of all lockInfo objects */
drhbbd42a62004-05-22 17:41:58 +0000316};
317
318/*
319** An instance of the following structure serves as the key used
320** to locate a particular openCnt structure given its inode. This
drh5fdae772004-06-29 03:29:00 +0000321** is the same as the lockKey except that the thread ID is omitted.
drhbbd42a62004-05-22 17:41:58 +0000322*/
323struct openKey {
324 dev_t dev; /* Device number */
325 ino_t ino; /* Inode number */
326};
327
328/*
329** An instance of the following structure is allocated for each open
330** inode. This structure keeps track of the number of locks on that
331** inode. If a close is attempted against an inode that is holding
332** locks, the close is deferred until all locks clear by adding the
333** file descriptor to be closed to the pending list.
334*/
335struct openCnt {
336 struct openKey key; /* The lookup key */
337 int nRef; /* Number of pointers to this structure */
338 int nLock; /* Number of outstanding locks */
339 int nPending; /* Number of pending close() operations */
340 int *aPending; /* Malloced space holding fd's awaiting a close() */
drhda0e7682008-07-30 15:27:54 +0000341 struct openCnt *pNext, *pPrev; /* List of all openCnt objects */
drhbbd42a62004-05-22 17:41:58 +0000342};
343
drhda0e7682008-07-30 15:27:54 +0000344/*
345** List of all lockInfo and openCnt objects. This used to be a hash
346** table. But the number of objects is rarely more than a dozen and
347** never exceeds a few thousand. And lookup is not on a critical
348** path oo a simple linked list will suffice.
drhbbd42a62004-05-22 17:41:58 +0000349*/
drhda0e7682008-07-30 15:27:54 +0000350static struct lockInfo *lockList = 0;
351static struct openCnt *openList = 0;
drh5fdae772004-06-29 03:29:00 +0000352
drhbfe66312006-10-03 17:40:40 +0000353/*
354** The locking styles are associated with the different file locking
355** capabilities supported by different file systems.
356**
357** POSIX locking style fully supports shared and exclusive byte-range locks
danielk1977e339d652008-06-28 11:23:00 +0000358** AFP locking only supports exclusive byte-range locks
drhbfe66312006-10-03 17:40:40 +0000359** FLOCK only supports a single file-global exclusive lock
360** DOTLOCK isn't a true locking style, it refers to the use of a special
361** file named the same as the database file with a '.lock' extension, this
362** can be used on file systems that do not offer any reliable file locking
363** NO locking means that no locking will be attempted, this is only used for
364** read-only file systems currently
365** UNSUPPORTED means that no locking will be attempted, this is only used for
366** file systems that are known to be unsupported
367*/
danielk1977e339d652008-06-28 11:23:00 +0000368#define LOCKING_STYLE_POSIX 1
drhda0e7682008-07-30 15:27:54 +0000369#define LOCKING_STYLE_NONE 2
danielk1977e339d652008-06-28 11:23:00 +0000370#define LOCKING_STYLE_DOTFILE 3
drhda0e7682008-07-30 15:27:54 +0000371#define LOCKING_STYLE_FLOCK 4
danielk1977e339d652008-06-28 11:23:00 +0000372#define LOCKING_STYLE_AFP 5
drhbfe66312006-10-03 17:40:40 +0000373
danielk1977ad94b582007-08-20 06:44:22 +0000374/*
aswift5b1a2562008-08-22 00:22:35 +0000375** Only set the lastErrno if the error code is a real error and not
376** a normal expected return code of SQLITE_BUSY or SQLITE_OK
377*/
378#define IS_LOCK_ERROR(x) ((x != SQLITE_OK) && (x != SQLITE_BUSY))
379
380/*
danielk1977ad94b582007-08-20 06:44:22 +0000381** Helper functions to obtain and relinquish the global mutex.
382*/
danielk1977b4b47412007-08-17 15:53:36 +0000383static void enterMutex(){
danielk197759f8c082008-06-18 17:09:10 +0000384 sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
danielk1977b4b47412007-08-17 15:53:36 +0000385}
386static void leaveMutex(){
danielk197759f8c082008-06-18 17:09:10 +0000387 sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
danielk1977b4b47412007-08-17 15:53:36 +0000388}
389
drhd677b3d2007-08-20 22:48:41 +0000390#if SQLITE_THREADSAFE
drh5fdae772004-06-29 03:29:00 +0000391/*
392** This variable records whether or not threads can override each others
393** locks.
394**
395** 0: No. Threads cannot override each others locks.
396** 1: Yes. Threads can override each others locks.
397** -1: We don't know yet.
drhf1a221e2006-01-15 17:27:17 +0000398**
drh5062d3a2006-01-31 23:03:35 +0000399** On some systems, we know at compile-time if threads can override each
400** others locks. On those systems, the SQLITE_THREAD_OVERRIDE_LOCK macro
401** will be set appropriately. On other systems, we have to check at
402** runtime. On these latter systems, SQLTIE_THREAD_OVERRIDE_LOCK is
403** undefined.
404**
drhf1a221e2006-01-15 17:27:17 +0000405** This variable normally has file scope only. But during testing, we make
406** it a global so that the test code can change its value in order to verify
407** that the right stuff happens in either case.
drh5fdae772004-06-29 03:29:00 +0000408*/
drh5062d3a2006-01-31 23:03:35 +0000409#ifndef SQLITE_THREAD_OVERRIDE_LOCK
410# define SQLITE_THREAD_OVERRIDE_LOCK -1
411#endif
drh029b44b2006-01-15 00:13:15 +0000412#ifdef SQLITE_TEST
drh5062d3a2006-01-31 23:03:35 +0000413int threadsOverrideEachOthersLocks = SQLITE_THREAD_OVERRIDE_LOCK;
drh029b44b2006-01-15 00:13:15 +0000414#else
drh5062d3a2006-01-31 23:03:35 +0000415static int threadsOverrideEachOthersLocks = SQLITE_THREAD_OVERRIDE_LOCK;
drh029b44b2006-01-15 00:13:15 +0000416#endif
drh5fdae772004-06-29 03:29:00 +0000417
418/*
419** This structure holds information passed into individual test
420** threads by the testThreadLockingBehavior() routine.
421*/
422struct threadTestData {
423 int fd; /* File to be locked */
424 struct flock lock; /* The locking operation */
425 int result; /* Result of the locking operation */
426};
427
drh2b4b5962005-06-15 17:47:55 +0000428#ifdef SQLITE_LOCK_TRACE
429/*
430** Print out information about all locking operations.
431**
432** This routine is used for troubleshooting locks on multithreaded
433** platforms. Enable by compiling with the -DSQLITE_LOCK_TRACE
434** command-line option on the compiler. This code is normally
drhf1a221e2006-01-15 17:27:17 +0000435** turned off.
drh2b4b5962005-06-15 17:47:55 +0000436*/
437static int lockTrace(int fd, int op, struct flock *p){
438 char *zOpName, *zType;
439 int s;
440 int savedErrno;
441 if( op==F_GETLK ){
442 zOpName = "GETLK";
443 }else if( op==F_SETLK ){
444 zOpName = "SETLK";
445 }else{
446 s = fcntl(fd, op, p);
447 sqlite3DebugPrintf("fcntl unknown %d %d %d\n", fd, op, s);
448 return s;
449 }
450 if( p->l_type==F_RDLCK ){
451 zType = "RDLCK";
452 }else if( p->l_type==F_WRLCK ){
453 zType = "WRLCK";
454 }else if( p->l_type==F_UNLCK ){
455 zType = "UNLCK";
456 }else{
457 assert( 0 );
458 }
459 assert( p->l_whence==SEEK_SET );
460 s = fcntl(fd, op, p);
461 savedErrno = errno;
462 sqlite3DebugPrintf("fcntl %d %d %s %s %d %d %d %d\n",
463 threadid, fd, zOpName, zType, (int)p->l_start, (int)p->l_len,
464 (int)p->l_pid, s);
drhe2396a12007-03-29 20:19:58 +0000465 if( s==(-1) && op==F_SETLK && (p->l_type==F_RDLCK || p->l_type==F_WRLCK) ){
drh2b4b5962005-06-15 17:47:55 +0000466 struct flock l2;
467 l2 = *p;
468 fcntl(fd, F_GETLK, &l2);
469 if( l2.l_type==F_RDLCK ){
470 zType = "RDLCK";
471 }else if( l2.l_type==F_WRLCK ){
472 zType = "WRLCK";
473 }else if( l2.l_type==F_UNLCK ){
474 zType = "UNLCK";
475 }else{
476 assert( 0 );
477 }
478 sqlite3DebugPrintf("fcntl-failure-reason: %s %d %d %d\n",
479 zType, (int)l2.l_start, (int)l2.l_len, (int)l2.l_pid);
480 }
481 errno = savedErrno;
482 return s;
483}
484#define fcntl lockTrace
485#endif /* SQLITE_LOCK_TRACE */
486
drh5fdae772004-06-29 03:29:00 +0000487/*
488** The testThreadLockingBehavior() routine launches two separate
489** threads on this routine. This routine attempts to lock a file
490** descriptor then returns. The success or failure of that attempt
491** allows the testThreadLockingBehavior() procedure to determine
492** whether or not threads can override each others locks.
493*/
494static void *threadLockingTest(void *pArg){
495 struct threadTestData *pData = (struct threadTestData*)pArg;
496 pData->result = fcntl(pData->fd, F_SETLK, &pData->lock);
497 return pArg;
498}
499
500/*
501** This procedure attempts to determine whether or not threads
502** can override each others locks then sets the
503** threadsOverrideEachOthersLocks variable appropriately.
504*/
danielk19774d5238f2006-01-27 06:32:00 +0000505static void testThreadLockingBehavior(int fd_orig){
drh5fdae772004-06-29 03:29:00 +0000506 int fd;
507 struct threadTestData d[2];
508 pthread_t t[2];
509
510 fd = dup(fd_orig);
511 if( fd<0 ) return;
512 memset(d, 0, sizeof(d));
513 d[0].fd = fd;
514 d[0].lock.l_type = F_RDLCK;
515 d[0].lock.l_len = 1;
516 d[0].lock.l_start = 0;
517 d[0].lock.l_whence = SEEK_SET;
518 d[1] = d[0];
519 d[1].lock.l_type = F_WRLCK;
520 pthread_create(&t[0], 0, threadLockingTest, &d[0]);
521 pthread_create(&t[1], 0, threadLockingTest, &d[1]);
522 pthread_join(t[0], 0);
523 pthread_join(t[1], 0);
524 close(fd);
525 threadsOverrideEachOthersLocks = d[0].result==0 && d[1].result==0;
526}
drhd677b3d2007-08-20 22:48:41 +0000527#endif /* SQLITE_THREADSAFE */
drh5fdae772004-06-29 03:29:00 +0000528
drhbbd42a62004-05-22 17:41:58 +0000529/*
530** Release a lockInfo structure previously allocated by findLockInfo().
531*/
532static void releaseLockInfo(struct lockInfo *pLock){
danielk1977e339d652008-06-28 11:23:00 +0000533 if( pLock ){
534 pLock->nRef--;
535 if( pLock->nRef==0 ){
drhda0e7682008-07-30 15:27:54 +0000536 if( pLock->pPrev ){
537 assert( pLock->pPrev->pNext==pLock );
538 pLock->pPrev->pNext = pLock->pNext;
539 }else{
540 assert( lockList==pLock );
541 lockList = pLock->pNext;
542 }
543 if( pLock->pNext ){
544 assert( pLock->pNext->pPrev==pLock );
545 pLock->pNext->pPrev = pLock->pPrev;
546 }
danielk1977e339d652008-06-28 11:23:00 +0000547 sqlite3_free(pLock);
548 }
drhbbd42a62004-05-22 17:41:58 +0000549 }
550}
551
552/*
553** Release a openCnt structure previously allocated by findLockInfo().
554*/
555static void releaseOpenCnt(struct openCnt *pOpen){
danielk1977e339d652008-06-28 11:23:00 +0000556 if( pOpen ){
557 pOpen->nRef--;
558 if( pOpen->nRef==0 ){
drhda0e7682008-07-30 15:27:54 +0000559 if( pOpen->pPrev ){
560 assert( pOpen->pPrev->pNext==pOpen );
561 pOpen->pPrev->pNext = pOpen->pNext;
562 }else{
563 assert( openList==pOpen );
564 openList = pOpen->pNext;
565 }
566 if( pOpen->pNext ){
567 assert( pOpen->pNext->pPrev==pOpen );
568 pOpen->pNext->pPrev = pOpen->pPrev;
569 }
570 sqlite3_free(pOpen->aPending);
danielk1977e339d652008-06-28 11:23:00 +0000571 sqlite3_free(pOpen);
572 }
drhbbd42a62004-05-22 17:41:58 +0000573 }
574}
575
drh93a960a2008-07-10 00:32:42 +0000576#ifdef SQLITE_ENABLE_LOCKING_STYLE
drhbfe66312006-10-03 17:40:40 +0000577/*
578** Tests a byte-range locking query to see if byte range locks are
579** supported, if not we fall back to dotlockLockingStyle.
580*/
danielk1977e339d652008-06-28 11:23:00 +0000581static int testLockingStyle(int fd){
drhbfe66312006-10-03 17:40:40 +0000582 struct flock lockInfo;
danielk1977e339d652008-06-28 11:23:00 +0000583
584 /* Test byte-range lock using fcntl(). If the call succeeds,
585 ** assume that the file-system supports POSIX style locks.
586 */
drhbfe66312006-10-03 17:40:40 +0000587 lockInfo.l_len = 1;
588 lockInfo.l_start = 0;
589 lockInfo.l_whence = SEEK_SET;
590 lockInfo.l_type = F_RDLCK;
danielk1977ad94b582007-08-20 06:44:22 +0000591 if( fcntl(fd, F_GETLK, &lockInfo)!=-1 ) {
danielk1977e339d652008-06-28 11:23:00 +0000592 return LOCKING_STYLE_POSIX;
593 }
drhbfe66312006-10-03 17:40:40 +0000594
danielk1977e339d652008-06-28 11:23:00 +0000595 /* Testing for flock() can give false positives. So if if the above
596 ** test fails, then we fall back to using dot-file style locking.
drhbfe66312006-10-03 17:40:40 +0000597 */
danielk1977e339d652008-06-28 11:23:00 +0000598 return LOCKING_STYLE_DOTFILE;
drhbfe66312006-10-03 17:40:40 +0000599}
drh93a960a2008-07-10 00:32:42 +0000600#endif
drhbfe66312006-10-03 17:40:40 +0000601
602/*
danielk1977e339d652008-06-28 11:23:00 +0000603** If SQLITE_ENABLE_LOCKING_STYLE is defined, this function Examines the
604** f_fstypename entry in the statfs structure as returned by stat() for
605** the file system hosting the database file and selects the appropriate
606** locking style based on its value. These values and assignments are
607** based on Darwin/OSX behavior and have not been thoroughly tested on
drhbfe66312006-10-03 17:40:40 +0000608** other systems.
danielk1977e339d652008-06-28 11:23:00 +0000609**
610** If SQLITE_ENABLE_LOCKING_STYLE is not defined, this function always
611** returns LOCKING_STYLE_POSIX.
drhbfe66312006-10-03 17:40:40 +0000612*/
danielk1977e339d652008-06-28 11:23:00 +0000613static int detectLockingStyle(
614 sqlite3_vfs *pVfs,
danielk1977ad94b582007-08-20 06:44:22 +0000615 const char *filePath,
616 int fd
617){
danielk1977e339d652008-06-28 11:23:00 +0000618#ifdef SQLITE_ENABLE_LOCKING_STYLE
619 struct Mapping {
620 const char *zFilesystem;
621 int eLockingStyle;
622 } aMap[] = {
623 { "hfs", LOCKING_STYLE_POSIX },
624 { "ufs", LOCKING_STYLE_POSIX },
625 { "afpfs", LOCKING_STYLE_AFP },
aswift5b1a2562008-08-22 00:22:35 +0000626#ifdef SQLITE_ENABLE_AFP_LOCKING_SMB
627 { "smbfs", LOCKING_STYLE_AFP },
628#else
danielk1977e339d652008-06-28 11:23:00 +0000629 { "smbfs", LOCKING_STYLE_FLOCK },
aswift5b1a2562008-08-22 00:22:35 +0000630#endif
danielk1977e339d652008-06-28 11:23:00 +0000631 { "msdos", LOCKING_STYLE_DOTFILE },
632 { "webdav", LOCKING_STYLE_NONE },
633 { 0, 0 }
634 };
635 int i;
drhbfe66312006-10-03 17:40:40 +0000636 struct statfs fsInfo;
637
danielk1977e339d652008-06-28 11:23:00 +0000638 if( !filePath ){
639 return LOCKING_STYLE_NONE;
drh339eb0b2008-03-07 15:34:11 +0000640 }
danielk1977e339d652008-06-28 11:23:00 +0000641 if( pVfs->pAppData ){
642 return (int)pVfs->pAppData;
drh339eb0b2008-03-07 15:34:11 +0000643 }
drhbfe66312006-10-03 17:40:40 +0000644
danielk1977e339d652008-06-28 11:23:00 +0000645 if( statfs(filePath, &fsInfo) != -1 ){
646 if( fsInfo.f_flags & MNT_RDONLY ){
647 return LOCKING_STYLE_NONE;
648 }
649 for(i=0; aMap[i].zFilesystem; i++){
650 if( strcmp(fsInfo.f_fstypename, aMap[i].zFilesystem)==0 ){
651 return aMap[i].eLockingStyle;
652 }
653 }
654 }
655
656 /* Default case. Handles, amongst others, "nfs". */
657 return testLockingStyle(fd);
658#endif
659 return LOCKING_STYLE_POSIX;
660}
drhbfe66312006-10-03 17:40:40 +0000661
drhbbd42a62004-05-22 17:41:58 +0000662/*
663** Given a file descriptor, locate lockInfo and openCnt structures that
drh029b44b2006-01-15 00:13:15 +0000664** describes that file descriptor. Create new ones if necessary. The
665** return values might be uninitialized if an error occurs.
drhbbd42a62004-05-22 17:41:58 +0000666**
drh65594042008-05-05 16:56:34 +0000667** Return an appropriate error code.
drhbbd42a62004-05-22 17:41:58 +0000668*/
drh38f82712004-06-18 17:10:16 +0000669static int findLockInfo(
drhbbd42a62004-05-22 17:41:58 +0000670 int fd, /* The file descriptor used in the key */
671 struct lockInfo **ppLock, /* Return the lockInfo structure here */
drh5fdae772004-06-29 03:29:00 +0000672 struct openCnt **ppOpen /* Return the openCnt structure here */
drhbbd42a62004-05-22 17:41:58 +0000673){
674 int rc;
675 struct lockKey key1;
676 struct openKey key2;
677 struct stat statbuf;
678 struct lockInfo *pLock;
679 struct openCnt *pOpen;
680 rc = fstat(fd, &statbuf);
drh65594042008-05-05 16:56:34 +0000681 if( rc!=0 ){
682#ifdef EOVERFLOW
683 if( errno==EOVERFLOW ) return SQLITE_NOLFS;
684#endif
685 return SQLITE_IOERR;
686 }
danielk1977441b09a2006-01-05 13:48:29 +0000687
drh54626242008-07-30 17:28:04 +0000688 /* On OS X on an msdos filesystem, the inode number is reported
689 ** incorrectly for zero-size files. See ticket #3260. To work
690 ** around this problem (we consider it a bug in OS X, not SQLite)
691 ** we always increase the file size to 1 by writing a single byte
692 ** prior to accessing the inode number. The one byte written is
693 ** an ASCII 'S' character which also happens to be the first byte
694 ** in the header of every SQLite database. In this way, if there
695 ** is a race condition such that another thread has already populated
696 ** the first page of the database, no damage is done.
697 */
698 if( statbuf.st_size==0 ){
699 write(fd, "S", 1);
700 rc = fstat(fd, &statbuf);
701 if( rc!=0 ){
702 return SQLITE_IOERR;
703 }
704 }
705
drhbbd42a62004-05-22 17:41:58 +0000706 memset(&key1, 0, sizeof(key1));
707 key1.dev = statbuf.st_dev;
708 key1.ino = statbuf.st_ino;
drhd677b3d2007-08-20 22:48:41 +0000709#if SQLITE_THREADSAFE
drh5fdae772004-06-29 03:29:00 +0000710 if( threadsOverrideEachOthersLocks<0 ){
711 testThreadLockingBehavior(fd);
712 }
713 key1.tid = threadsOverrideEachOthersLocks ? 0 : pthread_self();
714#endif
drhbbd42a62004-05-22 17:41:58 +0000715 memset(&key2, 0, sizeof(key2));
716 key2.dev = statbuf.st_dev;
717 key2.ino = statbuf.st_ino;
drhda0e7682008-07-30 15:27:54 +0000718 pLock = lockList;
719 while( pLock && memcmp(&key1, &pLock->key, sizeof(key1)) ){
720 pLock = pLock->pNext;
721 }
drhbbd42a62004-05-22 17:41:58 +0000722 if( pLock==0 ){
drh17435752007-08-16 04:30:38 +0000723 pLock = sqlite3_malloc( sizeof(*pLock) );
danielk1977441b09a2006-01-05 13:48:29 +0000724 if( pLock==0 ){
drh65594042008-05-05 16:56:34 +0000725 rc = SQLITE_NOMEM;
danielk1977441b09a2006-01-05 13:48:29 +0000726 goto exit_findlockinfo;
727 }
drhbbd42a62004-05-22 17:41:58 +0000728 pLock->key = key1;
729 pLock->nRef = 1;
730 pLock->cnt = 0;
danielk19779a1d0ab2004-06-01 14:09:28 +0000731 pLock->locktype = 0;
drhda0e7682008-07-30 15:27:54 +0000732 pLock->pNext = lockList;
733 pLock->pPrev = 0;
734 if( lockList ) lockList->pPrev = pLock;
735 lockList = pLock;
drhbbd42a62004-05-22 17:41:58 +0000736 }else{
737 pLock->nRef++;
738 }
739 *ppLock = pLock;
drh029b44b2006-01-15 00:13:15 +0000740 if( ppOpen!=0 ){
drhda0e7682008-07-30 15:27:54 +0000741 pOpen = openList;
742 while( pOpen && memcmp(&key2, &pOpen->key, sizeof(key2)) ){
743 pOpen = pOpen->pNext;
744 }
drhbbd42a62004-05-22 17:41:58 +0000745 if( pOpen==0 ){
drh17435752007-08-16 04:30:38 +0000746 pOpen = sqlite3_malloc( sizeof(*pOpen) );
drh029b44b2006-01-15 00:13:15 +0000747 if( pOpen==0 ){
748 releaseLockInfo(pLock);
drh65594042008-05-05 16:56:34 +0000749 rc = SQLITE_NOMEM;
drh029b44b2006-01-15 00:13:15 +0000750 goto exit_findlockinfo;
751 }
752 pOpen->key = key2;
753 pOpen->nRef = 1;
754 pOpen->nLock = 0;
755 pOpen->nPending = 0;
756 pOpen->aPending = 0;
drhda0e7682008-07-30 15:27:54 +0000757 pOpen->pNext = openList;
758 pOpen->pPrev = 0;
759 if( openList ) openList->pPrev = pOpen;
760 openList = pOpen;
drh029b44b2006-01-15 00:13:15 +0000761 }else{
762 pOpen->nRef++;
drhbbd42a62004-05-22 17:41:58 +0000763 }
drh029b44b2006-01-15 00:13:15 +0000764 *ppOpen = pOpen;
drhbbd42a62004-05-22 17:41:58 +0000765 }
danielk1977441b09a2006-01-05 13:48:29 +0000766
767exit_findlockinfo:
danielk1977441b09a2006-01-05 13:48:29 +0000768 return rc;
drhbbd42a62004-05-22 17:41:58 +0000769}
770
drh64b1bea2006-01-15 02:30:57 +0000771#ifdef SQLITE_DEBUG
772/*
773** Helper function for printing out trace information from debugging
774** binaries. This returns the string represetation of the supplied
775** integer lock-type.
776*/
777static const char *locktypeName(int locktype){
778 switch( locktype ){
779 case NO_LOCK: return "NONE";
780 case SHARED_LOCK: return "SHARED";
781 case RESERVED_LOCK: return "RESERVED";
782 case PENDING_LOCK: return "PENDING";
783 case EXCLUSIVE_LOCK: return "EXCLUSIVE";
784 }
785 return "ERROR";
786}
787#endif
788
drhbbd42a62004-05-22 17:41:58 +0000789/*
drh029b44b2006-01-15 00:13:15 +0000790** If we are currently in a different thread than the thread that the
791** unixFile argument belongs to, then transfer ownership of the unixFile
792** over to the current thread.
793**
794** A unixFile is only owned by a thread on systems where one thread is
795** unable to override locks created by a different thread. RedHat9 is
796** an example of such a system.
797**
798** Ownership transfer is only allowed if the unixFile is currently unlocked.
799** If the unixFile is locked and an ownership is wrong, then return
drhf1a221e2006-01-15 17:27:17 +0000800** SQLITE_MISUSE. SQLITE_OK is returned if everything works.
drh029b44b2006-01-15 00:13:15 +0000801*/
drhd677b3d2007-08-20 22:48:41 +0000802#if SQLITE_THREADSAFE
drh029b44b2006-01-15 00:13:15 +0000803static int transferOwnership(unixFile *pFile){
drh64b1bea2006-01-15 02:30:57 +0000804 int rc;
drh029b44b2006-01-15 00:13:15 +0000805 pthread_t hSelf;
806 if( threadsOverrideEachOthersLocks ){
807 /* Ownership transfers not needed on this system */
808 return SQLITE_OK;
809 }
810 hSelf = pthread_self();
811 if( pthread_equal(pFile->tid, hSelf) ){
812 /* We are still in the same thread */
drh4f0c5872007-03-26 22:05:01 +0000813 OSTRACE1("No-transfer, same thread\n");
drh029b44b2006-01-15 00:13:15 +0000814 return SQLITE_OK;
815 }
816 if( pFile->locktype!=NO_LOCK ){
817 /* We cannot change ownership while we are holding a lock! */
818 return SQLITE_MISUSE;
819 }
drh4f0c5872007-03-26 22:05:01 +0000820 OSTRACE4("Transfer ownership of %d from %d to %d\n",
821 pFile->h, pFile->tid, hSelf);
drh029b44b2006-01-15 00:13:15 +0000822 pFile->tid = hSelf;
drhbfe66312006-10-03 17:40:40 +0000823 if (pFile->pLock != NULL) {
824 releaseLockInfo(pFile->pLock);
825 rc = findLockInfo(pFile->h, &pFile->pLock, 0);
drh4f0c5872007-03-26 22:05:01 +0000826 OSTRACE5("LOCK %d is now %s(%s,%d)\n", pFile->h,
drhbfe66312006-10-03 17:40:40 +0000827 locktypeName(pFile->locktype),
828 locktypeName(pFile->pLock->locktype), pFile->pLock->cnt);
829 return rc;
830 } else {
831 return SQLITE_OK;
832 }
drh029b44b2006-01-15 00:13:15 +0000833}
834#else
drhf1a221e2006-01-15 17:27:17 +0000835 /* On single-threaded builds, ownership transfer is a no-op */
drh029b44b2006-01-15 00:13:15 +0000836# define transferOwnership(X) SQLITE_OK
837#endif
838
839/*
danielk19772a6bdf62007-08-20 16:07:00 +0000840** Seek to the offset passed as the second argument, then read cnt
841** bytes into pBuf. Return the number of bytes actually read.
drh9e0ebbf2007-10-23 15:59:18 +0000842**
843** NB: If you define USE_PREAD or USE_PREAD64, then it might also
844** be necessary to define _XOPEN_SOURCE to be 500. This varies from
845** one system to another. Since SQLite does not define USE_PREAD
846** any any form by default, we will not attempt to define _XOPEN_SOURCE.
847** See tickets #2741 and #2681.
drhb912b282006-03-23 22:42:20 +0000848*/
danielk197762079062007-08-15 17:08:46 +0000849static int seekAndRead(unixFile *id, sqlite3_int64 offset, void *pBuf, int cnt){
drhb912b282006-03-23 22:42:20 +0000850 int got;
drh8ebf6702007-02-06 11:11:08 +0000851 i64 newOffset;
drh15d00c42007-02-27 02:01:14 +0000852 TIMER_START;
drh8350a212007-03-22 15:22:06 +0000853#if defined(USE_PREAD)
danielk197762079062007-08-15 17:08:46 +0000854 got = pread(id->h, pBuf, cnt, offset);
drhbb5f18d2007-04-06 18:23:17 +0000855 SimulateIOError( got = -1 );
drh8350a212007-03-22 15:22:06 +0000856#elif defined(USE_PREAD64)
danielk197762079062007-08-15 17:08:46 +0000857 got = pread64(id->h, pBuf, cnt, offset);
drhbb5f18d2007-04-06 18:23:17 +0000858 SimulateIOError( got = -1 );
drhb912b282006-03-23 22:42:20 +0000859#else
danielk197762079062007-08-15 17:08:46 +0000860 newOffset = lseek(id->h, offset, SEEK_SET);
drhbb5f18d2007-04-06 18:23:17 +0000861 SimulateIOError( newOffset-- );
danielk197762079062007-08-15 17:08:46 +0000862 if( newOffset!=offset ){
drh8ebf6702007-02-06 11:11:08 +0000863 return -1;
864 }
drhb912b282006-03-23 22:42:20 +0000865 got = read(id->h, pBuf, cnt);
866#endif
drh15d00c42007-02-27 02:01:14 +0000867 TIMER_END;
shane9bcbdad2008-05-29 20:22:37 +0000868 OSTRACE5("READ %-3d %5d %7lld %llu\n", id->h, got, offset, TIMER_ELAPSED);
drhb912b282006-03-23 22:42:20 +0000869 return got;
870}
871
872/*
drhbbd42a62004-05-22 17:41:58 +0000873** Read data from a file into a buffer. Return SQLITE_OK if all
874** bytes were read successfully and SQLITE_IOERR if anything goes
875** wrong.
876*/
danielk197762079062007-08-15 17:08:46 +0000877static int unixRead(
878 sqlite3_file *id,
879 void *pBuf,
880 int amt,
881 sqlite3_int64 offset
882){
drhbbd42a62004-05-22 17:41:58 +0000883 int got;
drh9cbe6352005-11-29 03:13:21 +0000884 assert( id );
danielk197762079062007-08-15 17:08:46 +0000885 got = seekAndRead((unixFile*)id, offset, pBuf, amt);
drhbbd42a62004-05-22 17:41:58 +0000886 if( got==amt ){
887 return SQLITE_OK;
drh4ac285a2006-09-15 07:28:50 +0000888 }else if( got<0 ){
889 return SQLITE_IOERR_READ;
drhbbd42a62004-05-22 17:41:58 +0000890 }else{
drhbafda092007-01-03 23:36:22 +0000891 memset(&((char*)pBuf)[got], 0, amt-got);
drh4ac285a2006-09-15 07:28:50 +0000892 return SQLITE_IOERR_SHORT_READ;
drhbbd42a62004-05-22 17:41:58 +0000893 }
894}
895
896/*
drhb912b282006-03-23 22:42:20 +0000897** Seek to the offset in id->offset then read cnt bytes into pBuf.
898** Return the number of bytes actually read. Update the offset.
899*/
danielk197762079062007-08-15 17:08:46 +0000900static int seekAndWrite(unixFile *id, i64 offset, const void *pBuf, int cnt){
drhb912b282006-03-23 22:42:20 +0000901 int got;
drh8ebf6702007-02-06 11:11:08 +0000902 i64 newOffset;
drh15d00c42007-02-27 02:01:14 +0000903 TIMER_START;
drh8350a212007-03-22 15:22:06 +0000904#if defined(USE_PREAD)
danielk197762079062007-08-15 17:08:46 +0000905 got = pwrite(id->h, pBuf, cnt, offset);
drh8350a212007-03-22 15:22:06 +0000906#elif defined(USE_PREAD64)
danielk197762079062007-08-15 17:08:46 +0000907 got = pwrite64(id->h, pBuf, cnt, offset);
drhb912b282006-03-23 22:42:20 +0000908#else
danielk197762079062007-08-15 17:08:46 +0000909 newOffset = lseek(id->h, offset, SEEK_SET);
910 if( newOffset!=offset ){
drh8ebf6702007-02-06 11:11:08 +0000911 return -1;
912 }
drhb912b282006-03-23 22:42:20 +0000913 got = write(id->h, pBuf, cnt);
914#endif
drh15d00c42007-02-27 02:01:14 +0000915 TIMER_END;
shane9bcbdad2008-05-29 20:22:37 +0000916 OSTRACE5("WRITE %-3d %5d %7lld %llu\n", id->h, got, offset, TIMER_ELAPSED);
drhb912b282006-03-23 22:42:20 +0000917 return got;
918}
919
920
921/*
drhbbd42a62004-05-22 17:41:58 +0000922** Write data from a buffer into a file. Return SQLITE_OK on success
923** or some other error code on failure.
924*/
danielk197762079062007-08-15 17:08:46 +0000925static int unixWrite(
926 sqlite3_file *id,
927 const void *pBuf,
928 int amt,
929 sqlite3_int64 offset
930){
drhbbd42a62004-05-22 17:41:58 +0000931 int wrote = 0;
drh9cbe6352005-11-29 03:13:21 +0000932 assert( id );
drh4c7f9412005-02-03 00:29:47 +0000933 assert( amt>0 );
danielk197762079062007-08-15 17:08:46 +0000934 while( amt>0 && (wrote = seekAndWrite((unixFile*)id, offset, pBuf, amt))>0 ){
drhbbd42a62004-05-22 17:41:58 +0000935 amt -= wrote;
danielk197762079062007-08-15 17:08:46 +0000936 offset += wrote;
drhbbd42a62004-05-22 17:41:58 +0000937 pBuf = &((char*)pBuf)[wrote];
938 }
drh59685932006-09-14 13:47:11 +0000939 SimulateIOError(( wrote=(-1), amt=1 ));
940 SimulateDiskfullError(( wrote=0, amt=1 ));
drhbbd42a62004-05-22 17:41:58 +0000941 if( amt>0 ){
drh59685932006-09-14 13:47:11 +0000942 if( wrote<0 ){
drh4ac285a2006-09-15 07:28:50 +0000943 return SQLITE_IOERR_WRITE;
drh59685932006-09-14 13:47:11 +0000944 }else{
945 return SQLITE_FULL;
946 }
drhbbd42a62004-05-22 17:41:58 +0000947 }
948 return SQLITE_OK;
949}
950
drhb851b2c2005-03-10 14:11:12 +0000951#ifdef SQLITE_TEST
952/*
953** Count the number of fullsyncs and normal syncs. This is used to test
954** that syncs and fullsyncs are occuring at the right times.
955*/
956int sqlite3_sync_count = 0;
957int sqlite3_fullsync_count = 0;
958#endif
959
drhf2f23912005-10-05 10:29:36 +0000960/*
961** Use the fdatasync() API only if the HAVE_FDATASYNC macro is defined.
962** Otherwise use fsync() in its place.
963*/
964#ifndef HAVE_FDATASYNC
965# define fdatasync fsync
966#endif
967
drhac530b12006-02-11 01:25:50 +0000968/*
969** Define HAVE_FULLFSYNC to 0 or 1 depending on whether or not
970** the F_FULLFSYNC macro is defined. F_FULLFSYNC is currently
971** only available on Mac OS X. But that could change.
972*/
973#ifdef F_FULLFSYNC
974# define HAVE_FULLFSYNC 1
975#else
976# define HAVE_FULLFSYNC 0
977#endif
978
drhb851b2c2005-03-10 14:11:12 +0000979
drhbbd42a62004-05-22 17:41:58 +0000980/*
drhdd809b02004-07-17 21:44:57 +0000981** The fsync() system call does not work as advertised on many
982** unix systems. The following procedure is an attempt to make
983** it work better.
drh1398ad32005-01-19 23:24:50 +0000984**
985** The SQLITE_NO_SYNC macro disables all fsync()s. This is useful
986** for testing when we want to run through the test suite quickly.
987** You are strongly advised *not* to deploy with SQLITE_NO_SYNC
988** enabled, however, since with SQLITE_NO_SYNC enabled, an OS crash
989** or power failure will likely corrupt the database file.
drhdd809b02004-07-17 21:44:57 +0000990*/
drheb796a72005-09-08 12:38:41 +0000991static int full_fsync(int fd, int fullSync, int dataOnly){
drhdd809b02004-07-17 21:44:57 +0000992 int rc;
drhb851b2c2005-03-10 14:11:12 +0000993
994 /* Record the number of times that we do a normal fsync() and
995 ** FULLSYNC. This is used during testing to verify that this procedure
996 ** gets called with the correct arguments.
997 */
998#ifdef SQLITE_TEST
999 if( fullSync ) sqlite3_fullsync_count++;
1000 sqlite3_sync_count++;
1001#endif
1002
1003 /* If we compiled with the SQLITE_NO_SYNC flag, then syncing is a
1004 ** no-op
1005 */
1006#ifdef SQLITE_NO_SYNC
1007 rc = SQLITE_OK;
1008#else
1009
drhac530b12006-02-11 01:25:50 +00001010#if HAVE_FULLFSYNC
drhb851b2c2005-03-10 14:11:12 +00001011 if( fullSync ){
drhf30cc942005-03-11 17:52:34 +00001012 rc = fcntl(fd, F_FULLFSYNC, 0);
aswiftae0943b2007-01-31 23:37:07 +00001013 }else{
1014 rc = 1;
1015 }
1016 /* If the FULLFSYNC failed, fall back to attempting an fsync().
1017 * It shouldn't be possible for fullfsync to fail on the local
1018 * file system (on OSX), so failure indicates that FULLFSYNC
1019 * isn't supported for this file system. So, attempt an fsync
1020 * and (for now) ignore the overhead of a superfluous fcntl call.
1021 * It'd be better to detect fullfsync support once and avoid
1022 * the fcntl call every time sync is called.
1023 */
1024 if( rc ) rc = fsync(fd);
1025
1026#else
drheb796a72005-09-08 12:38:41 +00001027 if( dataOnly ){
1028 rc = fdatasync(fd);
drhf2f23912005-10-05 10:29:36 +00001029 }else{
drheb796a72005-09-08 12:38:41 +00001030 rc = fsync(fd);
1031 }
aswiftae0943b2007-01-31 23:37:07 +00001032#endif /* HAVE_FULLFSYNC */
drhb851b2c2005-03-10 14:11:12 +00001033#endif /* defined(SQLITE_NO_SYNC) */
1034
drhdd809b02004-07-17 21:44:57 +00001035 return rc;
1036}
1037
1038/*
drhbbd42a62004-05-22 17:41:58 +00001039** Make sure all writes to a particular file are committed to disk.
1040**
drheb796a72005-09-08 12:38:41 +00001041** If dataOnly==0 then both the file itself and its metadata (file
1042** size, access time, etc) are synced. If dataOnly!=0 then only the
1043** file data is synced.
1044**
drhbbd42a62004-05-22 17:41:58 +00001045** Under Unix, also make sure that the directory entry for the file
1046** has been created by fsync-ing the directory that contains the file.
1047** If we do not do this and we encounter a power failure, the directory
1048** entry for the journal might not exist after we reboot. The next
1049** SQLite to access the file will not know that the journal exists (because
1050** the directory entry for the journal was never created) and the transaction
1051** will not roll back - possibly leading to database corruption.
1052*/
danielk197790949c22007-08-17 16:50:38 +00001053static int unixSync(sqlite3_file *id, int flags){
drh59685932006-09-14 13:47:11 +00001054 int rc;
drh054889e2005-11-30 03:20:31 +00001055 unixFile *pFile = (unixFile*)id;
danielk197790949c22007-08-17 16:50:38 +00001056
danielk1977f036aef2007-08-20 05:36:51 +00001057 int isDataOnly = (flags&SQLITE_SYNC_DATAONLY);
1058 int isFullsync = (flags&0x0F)==SQLITE_SYNC_FULL;
1059
danielk1977c16d4632007-08-30 14:49:58 +00001060 /* Check that one of SQLITE_SYNC_NORMAL or FULL was passed */
danielk1977f036aef2007-08-20 05:36:51 +00001061 assert((flags&0x0F)==SQLITE_SYNC_NORMAL
1062 || (flags&0x0F)==SQLITE_SYNC_FULL
danielk1977f036aef2007-08-20 05:36:51 +00001063 );
danielk197790949c22007-08-17 16:50:38 +00001064
drh054889e2005-11-30 03:20:31 +00001065 assert( pFile );
drh4f0c5872007-03-26 22:05:01 +00001066 OSTRACE2("SYNC %-3d\n", pFile->h);
danielk197790949c22007-08-17 16:50:38 +00001067 rc = full_fsync(pFile->h, isFullsync, isDataOnly);
drh59685932006-09-14 13:47:11 +00001068 SimulateIOError( rc=1 );
1069 if( rc ){
drh4ac285a2006-09-15 07:28:50 +00001070 return SQLITE_IOERR_FSYNC;
drhbbd42a62004-05-22 17:41:58 +00001071 }
drh054889e2005-11-30 03:20:31 +00001072 if( pFile->dirfd>=0 ){
drh4f0c5872007-03-26 22:05:01 +00001073 OSTRACE4("DIRSYNC %-3d (have_fullfsync=%d fullsync=%d)\n", pFile->dirfd,
danielk197790949c22007-08-17 16:50:38 +00001074 HAVE_FULLFSYNC, isFullsync);
danielk1977d7c03f72005-11-25 10:38:22 +00001075#ifndef SQLITE_DISABLE_DIRSYNC
drhac530b12006-02-11 01:25:50 +00001076 /* The directory sync is only attempted if full_fsync is
1077 ** turned off or unavailable. If a full_fsync occurred above,
1078 ** then the directory sync is superfluous.
1079 */
danielk197790949c22007-08-17 16:50:38 +00001080 if( (!HAVE_FULLFSYNC || !isFullsync) && full_fsync(pFile->dirfd,0,0) ){
drhac530b12006-02-11 01:25:50 +00001081 /*
1082 ** We have received multiple reports of fsync() returning
drh86631a52006-02-09 23:05:51 +00001083 ** errors when applied to directories on certain file systems.
1084 ** A failed directory sync is not a big deal. So it seems
1085 ** better to ignore the error. Ticket #1657
1086 */
1087 /* return SQLITE_IOERR; */
danielk19770964b232005-11-25 08:47:57 +00001088 }
danielk1977d7c03f72005-11-25 10:38:22 +00001089#endif
drh054889e2005-11-30 03:20:31 +00001090 close(pFile->dirfd); /* Only need to sync once, so close the directory */
1091 pFile->dirfd = -1; /* when we are done. */
drha2854222004-06-17 19:04:17 +00001092 }
drha2854222004-06-17 19:04:17 +00001093 return SQLITE_OK;
drhbbd42a62004-05-22 17:41:58 +00001094}
1095
1096/*
1097** Truncate an open file to a specified size
1098*/
danielk197762079062007-08-15 17:08:46 +00001099static int unixTruncate(sqlite3_file *id, i64 nByte){
drh59685932006-09-14 13:47:11 +00001100 int rc;
drh9cbe6352005-11-29 03:13:21 +00001101 assert( id );
drh93aed5a2008-01-16 17:46:38 +00001102 SimulateIOError( return SQLITE_IOERR_TRUNCATE );
drh63fff5f2007-06-19 10:50:38 +00001103 rc = ftruncate(((unixFile*)id)->h, (off_t)nByte);
drh59685932006-09-14 13:47:11 +00001104 if( rc ){
drh4ac285a2006-09-15 07:28:50 +00001105 return SQLITE_IOERR_TRUNCATE;
drh59685932006-09-14 13:47:11 +00001106 }else{
1107 return SQLITE_OK;
1108 }
drhbbd42a62004-05-22 17:41:58 +00001109}
1110
1111/*
1112** Determine the current size of a file in bytes
1113*/
danielk197762079062007-08-15 17:08:46 +00001114static int unixFileSize(sqlite3_file *id, i64 *pSize){
drh59685932006-09-14 13:47:11 +00001115 int rc;
drhbbd42a62004-05-22 17:41:58 +00001116 struct stat buf;
drh9cbe6352005-11-29 03:13:21 +00001117 assert( id );
drh59685932006-09-14 13:47:11 +00001118 rc = fstat(((unixFile*)id)->h, &buf);
1119 SimulateIOError( rc=1 );
1120 if( rc!=0 ){
drh4ac285a2006-09-15 07:28:50 +00001121 return SQLITE_IOERR_FSTAT;
drhbbd42a62004-05-22 17:41:58 +00001122 }
1123 *pSize = buf.st_size;
drh54626242008-07-30 17:28:04 +00001124
1125 /* When opening a zero-size database, the findLockInfo() procedure
1126 ** writes a single byte into that file in order to work around a bug
1127 ** in the OS-X msdos filesystem. In order to avoid problems with upper
1128 ** layers, we need to report this file size as zero even though it is
1129 ** really 1. Ticket #3260.
1130 */
1131 if( *pSize==1 ) *pSize = 0;
1132
1133
drhbbd42a62004-05-22 17:41:58 +00001134 return SQLITE_OK;
1135}
1136
danielk19779a1d0ab2004-06-01 14:09:28 +00001137/*
aswift5b1a2562008-08-22 00:22:35 +00001138** This routine translates a standard POSIX errno code into something
1139** useful to the clients of the sqlite3 functions. Specifically, it is
1140** intended to translate a variety of "try again" errors into SQLITE_BUSY
1141** and a variety of "please close the file descriptor NOW" errors into
1142** SQLITE_IOERR
1143**
1144** Errors during initialization of locks, or file system support for locks,
1145** should handle ENOLCK, ENOTSUP, EOPNOTSUPP separately.
1146*/
1147static int sqliteErrorFromPosixError(int posixError, int sqliteIOErr) {
1148 switch (posixError) {
1149 case 0:
1150 return SQLITE_OK;
1151
1152 case EAGAIN:
1153 case ETIMEDOUT:
1154 case EBUSY:
1155 case EINTR:
1156 case ENOLCK:
1157 /* random NFS retry error, unless during file system support
1158 * introspection, in which it actually means what it says */
1159 return SQLITE_BUSY;
1160
1161 case EACCES:
1162 /* EACCES is like EAGAIN during locking operations, but not any other time*/
1163 if( (sqliteIOErr == SQLITE_IOERR_LOCK) ||
1164 (sqliteIOErr == SQLITE_IOERR_UNLOCK) ||
1165 (sqliteIOErr == SQLITE_IOERR_RDLOCK) ||
1166 (sqliteIOErr == SQLITE_IOERR_CHECKRESERVEDLOCK) ){
1167 return SQLITE_BUSY;
1168 }
1169 /* else fall through */
1170 case EPERM:
1171 return SQLITE_PERM;
1172
1173 case EDEADLK:
1174 return SQLITE_IOERR_BLOCKED;
1175
1176 case EOPNOTSUPP:
1177 /* something went terribly awry, unless during file system support
1178 * introspection, in which it actually means what it says */
1179 case ENOTSUP:
1180 /* invalid fd, unless during file system support introspection, in which
1181 * it actually means what it says */
1182 case EIO:
1183 case EBADF:
1184 case EINVAL:
1185 case ENOTCONN:
1186 case ENODEV:
1187 case ENXIO:
1188 case ENOENT:
1189 case ESTALE:
1190 case ENOSYS:
1191 /* these should force the client to close the file and reconnect */
1192
1193 default:
1194 return sqliteIOErr;
1195 }
1196}
1197
1198/*
danielk197713adf8a2004-06-03 16:08:41 +00001199** This routine checks if there is a RESERVED lock held on the specified
aswift5b1a2562008-08-22 00:22:35 +00001200** file by this or any other process. If such a lock is held, set *pResOut
1201** to a non-zero value otherwise *pResOut is set to zero. The return value
1202** is set to SQLITE_OK unless an I/O error occurs during lock checking.
danielk197713adf8a2004-06-03 16:08:41 +00001203*/
danielk1977861f7452008-06-05 11:39:11 +00001204static int unixCheckReservedLock(sqlite3_file *id, int *pResOut){
aswift5b1a2562008-08-22 00:22:35 +00001205 int rc = SQLITE_OK;
1206 int reserved = 0;
drh054889e2005-11-30 03:20:31 +00001207 unixFile *pFile = (unixFile*)id;
danielk197713adf8a2004-06-03 16:08:41 +00001208
danielk1977861f7452008-06-05 11:39:11 +00001209 SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
1210
drh054889e2005-11-30 03:20:31 +00001211 assert( pFile );
danielk1977b4b47412007-08-17 15:53:36 +00001212 enterMutex(); /* Because pFile->pLock is shared across threads */
danielk197713adf8a2004-06-03 16:08:41 +00001213
1214 /* Check if a thread in this process holds such a lock */
drh054889e2005-11-30 03:20:31 +00001215 if( pFile->pLock->locktype>SHARED_LOCK ){
aswift5b1a2562008-08-22 00:22:35 +00001216 reserved = 1;
danielk197713adf8a2004-06-03 16:08:41 +00001217 }
1218
drh2ac3ee92004-06-07 16:27:46 +00001219 /* Otherwise see if some other process holds it.
danielk197713adf8a2004-06-03 16:08:41 +00001220 */
aswift5b1a2562008-08-22 00:22:35 +00001221 if( !reserved ){
danielk197713adf8a2004-06-03 16:08:41 +00001222 struct flock lock;
1223 lock.l_whence = SEEK_SET;
drh2ac3ee92004-06-07 16:27:46 +00001224 lock.l_start = RESERVED_BYTE;
1225 lock.l_len = 1;
1226 lock.l_type = F_WRLCK;
aswift5b1a2562008-08-22 00:22:35 +00001227 if (-1 == fcntl(pFile->h, F_GETLK, &lock)) {
1228 int tErrno = errno;
1229 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_CHECKRESERVEDLOCK);
1230 pFile->lastErrno = tErrno;
1231 } else if( lock.l_type!=F_UNLCK ){
1232 reserved = 1;
danielk197713adf8a2004-06-03 16:08:41 +00001233 }
1234 }
1235
danielk1977b4b47412007-08-17 15:53:36 +00001236 leaveMutex();
aswift5b1a2562008-08-22 00:22:35 +00001237 OSTRACE4("TEST WR-LOCK %d %d %d\n", pFile->h, rc, reserved);
danielk197713adf8a2004-06-03 16:08:41 +00001238
aswift5b1a2562008-08-22 00:22:35 +00001239 *pResOut = reserved;
1240 return rc;
danielk197713adf8a2004-06-03 16:08:41 +00001241}
1242
1243/*
danielk19779a1d0ab2004-06-01 14:09:28 +00001244** Lock the file with the lock specified by parameter locktype - one
1245** of the following:
1246**
drh2ac3ee92004-06-07 16:27:46 +00001247** (1) SHARED_LOCK
1248** (2) RESERVED_LOCK
1249** (3) PENDING_LOCK
1250** (4) EXCLUSIVE_LOCK
1251**
drhb3e04342004-06-08 00:47:47 +00001252** Sometimes when requesting one lock state, additional lock states
1253** are inserted in between. The locking might fail on one of the later
1254** transitions leaving the lock state different from what it started but
1255** still short of its goal. The following chart shows the allowed
1256** transitions and the inserted intermediate states:
1257**
1258** UNLOCKED -> SHARED
1259** SHARED -> RESERVED
1260** SHARED -> (PENDING) -> EXCLUSIVE
1261** RESERVED -> (PENDING) -> EXCLUSIVE
1262** PENDING -> EXCLUSIVE
drh2ac3ee92004-06-07 16:27:46 +00001263**
drha6abd042004-06-09 17:37:22 +00001264** This routine will only increase a lock. Use the sqlite3OsUnlock()
1265** routine to lower a locking level.
danielk19779a1d0ab2004-06-01 14:09:28 +00001266*/
danielk197762079062007-08-15 17:08:46 +00001267static int unixLock(sqlite3_file *id, int locktype){
danielk1977f42f25c2004-06-25 07:21:28 +00001268 /* The following describes the implementation of the various locks and
1269 ** lock transitions in terms of the POSIX advisory shared and exclusive
1270 ** lock primitives (called read-locks and write-locks below, to avoid
1271 ** confusion with SQLite lock names). The algorithms are complicated
1272 ** slightly in order to be compatible with windows systems simultaneously
1273 ** accessing the same database file, in case that is ever required.
1274 **
1275 ** Symbols defined in os.h indentify the 'pending byte' and the 'reserved
1276 ** byte', each single bytes at well known offsets, and the 'shared byte
1277 ** range', a range of 510 bytes at a well known offset.
1278 **
1279 ** To obtain a SHARED lock, a read-lock is obtained on the 'pending
1280 ** byte'. If this is successful, a random byte from the 'shared byte
1281 ** range' is read-locked and the lock on the 'pending byte' released.
1282 **
danielk197790ba3bd2004-06-25 08:32:25 +00001283 ** A process may only obtain a RESERVED lock after it has a SHARED lock.
1284 ** A RESERVED lock is implemented by grabbing a write-lock on the
1285 ** 'reserved byte'.
danielk1977f42f25c2004-06-25 07:21:28 +00001286 **
1287 ** A process may only obtain a PENDING lock after it has obtained a
danielk197790ba3bd2004-06-25 08:32:25 +00001288 ** SHARED lock. A PENDING lock is implemented by obtaining a write-lock
1289 ** on the 'pending byte'. This ensures that no new SHARED locks can be
1290 ** obtained, but existing SHARED locks are allowed to persist. A process
1291 ** does not have to obtain a RESERVED lock on the way to a PENDING lock.
1292 ** This property is used by the algorithm for rolling back a journal file
1293 ** after a crash.
danielk1977f42f25c2004-06-25 07:21:28 +00001294 **
danielk197790ba3bd2004-06-25 08:32:25 +00001295 ** An EXCLUSIVE lock, obtained after a PENDING lock is held, is
1296 ** implemented by obtaining a write-lock on the entire 'shared byte
1297 ** range'. Since all other locks require a read-lock on one of the bytes
1298 ** within this range, this ensures that no other locks are held on the
1299 ** database.
danielk1977f42f25c2004-06-25 07:21:28 +00001300 **
1301 ** The reason a single byte cannot be used instead of the 'shared byte
1302 ** range' is that some versions of windows do not support read-locks. By
1303 ** locking a random byte from a range, concurrent SHARED locks may exist
1304 ** even if the locking primitive used is always a write-lock.
1305 */
danielk19779a1d0ab2004-06-01 14:09:28 +00001306 int rc = SQLITE_OK;
drh054889e2005-11-30 03:20:31 +00001307 unixFile *pFile = (unixFile*)id;
1308 struct lockInfo *pLock = pFile->pLock;
danielk19779a1d0ab2004-06-01 14:09:28 +00001309 struct flock lock;
1310 int s;
1311
drh054889e2005-11-30 03:20:31 +00001312 assert( pFile );
drh4f0c5872007-03-26 22:05:01 +00001313 OSTRACE7("LOCK %d %s was %s(%s,%d) pid=%d\n", pFile->h,
drh054889e2005-11-30 03:20:31 +00001314 locktypeName(locktype), locktypeName(pFile->locktype),
1315 locktypeName(pLock->locktype), pLock->cnt , getpid());
danielk19779a1d0ab2004-06-01 14:09:28 +00001316
1317 /* If there is already a lock of this type or more restrictive on the
danielk1977ad94b582007-08-20 06:44:22 +00001318 ** unixFile, do nothing. Don't use the end_lock: exit path, as
danielk1977b4b47412007-08-17 15:53:36 +00001319 ** enterMutex() hasn't been called yet.
danielk19779a1d0ab2004-06-01 14:09:28 +00001320 */
drh054889e2005-11-30 03:20:31 +00001321 if( pFile->locktype>=locktype ){
drh4f0c5872007-03-26 22:05:01 +00001322 OSTRACE3("LOCK %d %s ok (already held)\n", pFile->h,
drh054889e2005-11-30 03:20:31 +00001323 locktypeName(locktype));
danielk19779a1d0ab2004-06-01 14:09:28 +00001324 return SQLITE_OK;
1325 }
1326
drhb3e04342004-06-08 00:47:47 +00001327 /* Make sure the locking sequence is correct
drh2ac3ee92004-06-07 16:27:46 +00001328 */
drh054889e2005-11-30 03:20:31 +00001329 assert( pFile->locktype!=NO_LOCK || locktype==SHARED_LOCK );
drhb3e04342004-06-08 00:47:47 +00001330 assert( locktype!=PENDING_LOCK );
drh054889e2005-11-30 03:20:31 +00001331 assert( locktype!=RESERVED_LOCK || pFile->locktype==SHARED_LOCK );
drh2ac3ee92004-06-07 16:27:46 +00001332
drh054889e2005-11-30 03:20:31 +00001333 /* This mutex is needed because pFile->pLock is shared across threads
drhb3e04342004-06-08 00:47:47 +00001334 */
danielk1977b4b47412007-08-17 15:53:36 +00001335 enterMutex();
danielk19779a1d0ab2004-06-01 14:09:28 +00001336
drh029b44b2006-01-15 00:13:15 +00001337 /* Make sure the current thread owns the pFile.
1338 */
1339 rc = transferOwnership(pFile);
1340 if( rc!=SQLITE_OK ){
danielk1977b4b47412007-08-17 15:53:36 +00001341 leaveMutex();
drh029b44b2006-01-15 00:13:15 +00001342 return rc;
1343 }
drh64b1bea2006-01-15 02:30:57 +00001344 pLock = pFile->pLock;
drh029b44b2006-01-15 00:13:15 +00001345
danielk1977ad94b582007-08-20 06:44:22 +00001346 /* If some thread using this PID has a lock via a different unixFile*
danielk19779a1d0ab2004-06-01 14:09:28 +00001347 ** handle that precludes the requested lock, return BUSY.
1348 */
drh054889e2005-11-30 03:20:31 +00001349 if( (pFile->locktype!=pLock->locktype &&
drh2ac3ee92004-06-07 16:27:46 +00001350 (pLock->locktype>=PENDING_LOCK || locktype>SHARED_LOCK))
danielk19779a1d0ab2004-06-01 14:09:28 +00001351 ){
1352 rc = SQLITE_BUSY;
1353 goto end_lock;
1354 }
1355
1356 /* If a SHARED lock is requested, and some thread using this PID already
1357 ** has a SHARED or RESERVED lock, then increment reference counts and
1358 ** return SQLITE_OK.
1359 */
1360 if( locktype==SHARED_LOCK &&
1361 (pLock->locktype==SHARED_LOCK || pLock->locktype==RESERVED_LOCK) ){
1362 assert( locktype==SHARED_LOCK );
drh054889e2005-11-30 03:20:31 +00001363 assert( pFile->locktype==0 );
danielk1977ecb2a962004-06-02 06:30:16 +00001364 assert( pLock->cnt>0 );
drh054889e2005-11-30 03:20:31 +00001365 pFile->locktype = SHARED_LOCK;
danielk19779a1d0ab2004-06-01 14:09:28 +00001366 pLock->cnt++;
drh054889e2005-11-30 03:20:31 +00001367 pFile->pOpen->nLock++;
danielk19779a1d0ab2004-06-01 14:09:28 +00001368 goto end_lock;
1369 }
1370
danielk197713adf8a2004-06-03 16:08:41 +00001371 lock.l_len = 1L;
drh2b4b5962005-06-15 17:47:55 +00001372
danielk19779a1d0ab2004-06-01 14:09:28 +00001373 lock.l_whence = SEEK_SET;
1374
drh3cde3bb2004-06-12 02:17:14 +00001375 /* A PENDING lock is needed before acquiring a SHARED lock and before
1376 ** acquiring an EXCLUSIVE lock. For the SHARED lock, the PENDING will
1377 ** be released.
danielk19779a1d0ab2004-06-01 14:09:28 +00001378 */
drh3cde3bb2004-06-12 02:17:14 +00001379 if( locktype==SHARED_LOCK
drh054889e2005-11-30 03:20:31 +00001380 || (locktype==EXCLUSIVE_LOCK && pFile->locktype<PENDING_LOCK)
drh3cde3bb2004-06-12 02:17:14 +00001381 ){
danielk1977489468c2004-06-28 08:25:47 +00001382 lock.l_type = (locktype==SHARED_LOCK?F_RDLCK:F_WRLCK);
drh2ac3ee92004-06-07 16:27:46 +00001383 lock.l_start = PENDING_BYTE;
drh054889e2005-11-30 03:20:31 +00001384 s = fcntl(pFile->h, F_SETLK, &lock);
drhe2396a12007-03-29 20:19:58 +00001385 if( s==(-1) ){
aswift5b1a2562008-08-22 00:22:35 +00001386 int tErrno = errno;
1387 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
1388 if( IS_LOCK_ERROR(rc) ){
1389 pFile->lastErrno = tErrno;
1390 }
danielk19779a1d0ab2004-06-01 14:09:28 +00001391 goto end_lock;
1392 }
drh3cde3bb2004-06-12 02:17:14 +00001393 }
1394
1395
1396 /* If control gets to this point, then actually go ahead and make
1397 ** operating system calls for the specified lock.
1398 */
1399 if( locktype==SHARED_LOCK ){
aswift5b1a2562008-08-22 00:22:35 +00001400 int tErrno = 0;
drh3cde3bb2004-06-12 02:17:14 +00001401 assert( pLock->cnt==0 );
1402 assert( pLock->locktype==0 );
danielk19779a1d0ab2004-06-01 14:09:28 +00001403
drh2ac3ee92004-06-07 16:27:46 +00001404 /* Now get the read-lock */
1405 lock.l_start = SHARED_FIRST;
1406 lock.l_len = SHARED_SIZE;
aswift5b1a2562008-08-22 00:22:35 +00001407 if( (s = fcntl(pFile->h, F_SETLK, &lock))==(-1) ){
1408 tErrno = errno;
1409 }
drh2ac3ee92004-06-07 16:27:46 +00001410 /* Drop the temporary PENDING lock */
1411 lock.l_start = PENDING_BYTE;
1412 lock.l_len = 1L;
danielk19779a1d0ab2004-06-01 14:09:28 +00001413 lock.l_type = F_UNLCK;
drh054889e2005-11-30 03:20:31 +00001414 if( fcntl(pFile->h, F_SETLK, &lock)!=0 ){
aswift5b1a2562008-08-22 00:22:35 +00001415 if( s != -1 ){
1416 /* This could happen with a network mount */
1417 tErrno = errno;
1418 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_UNLOCK);
1419 if( IS_LOCK_ERROR(rc) ){
1420 pFile->lastErrno = tErrno;
1421 }
1422 goto end_lock;
1423 }
drh2b4b5962005-06-15 17:47:55 +00001424 }
drhe2396a12007-03-29 20:19:58 +00001425 if( s==(-1) ){
aswift5b1a2562008-08-22 00:22:35 +00001426 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
1427 if( IS_LOCK_ERROR(rc) ){
1428 pFile->lastErrno = tErrno;
1429 }
drhbbd42a62004-05-22 17:41:58 +00001430 }else{
drh054889e2005-11-30 03:20:31 +00001431 pFile->locktype = SHARED_LOCK;
1432 pFile->pOpen->nLock++;
danielk19779a1d0ab2004-06-01 14:09:28 +00001433 pLock->cnt = 1;
drhbbd42a62004-05-22 17:41:58 +00001434 }
drh3cde3bb2004-06-12 02:17:14 +00001435 }else if( locktype==EXCLUSIVE_LOCK && pLock->cnt>1 ){
1436 /* We are trying for an exclusive lock but another thread in this
1437 ** same process is still holding a shared lock. */
1438 rc = SQLITE_BUSY;
drhbbd42a62004-05-22 17:41:58 +00001439 }else{
drh3cde3bb2004-06-12 02:17:14 +00001440 /* The request was for a RESERVED or EXCLUSIVE lock. It is
danielk19779a1d0ab2004-06-01 14:09:28 +00001441 ** assumed that there is a SHARED or greater lock on the file
1442 ** already.
1443 */
drh054889e2005-11-30 03:20:31 +00001444 assert( 0!=pFile->locktype );
danielk19779a1d0ab2004-06-01 14:09:28 +00001445 lock.l_type = F_WRLCK;
1446 switch( locktype ){
1447 case RESERVED_LOCK:
drh2ac3ee92004-06-07 16:27:46 +00001448 lock.l_start = RESERVED_BYTE;
danielk19779a1d0ab2004-06-01 14:09:28 +00001449 break;
danielk19779a1d0ab2004-06-01 14:09:28 +00001450 case EXCLUSIVE_LOCK:
drh2ac3ee92004-06-07 16:27:46 +00001451 lock.l_start = SHARED_FIRST;
1452 lock.l_len = SHARED_SIZE;
danielk19779a1d0ab2004-06-01 14:09:28 +00001453 break;
1454 default:
1455 assert(0);
1456 }
drh054889e2005-11-30 03:20:31 +00001457 s = fcntl(pFile->h, F_SETLK, &lock);
drhe2396a12007-03-29 20:19:58 +00001458 if( s==(-1) ){
aswift5b1a2562008-08-22 00:22:35 +00001459 int tErrno = errno;
1460 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
1461 if( IS_LOCK_ERROR(rc) ){
1462 pFile->lastErrno = tErrno;
1463 }
danielk19779a1d0ab2004-06-01 14:09:28 +00001464 }
drhbbd42a62004-05-22 17:41:58 +00001465 }
danielk19779a1d0ab2004-06-01 14:09:28 +00001466
danielk1977ecb2a962004-06-02 06:30:16 +00001467 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001468 pFile->locktype = locktype;
danielk1977ecb2a962004-06-02 06:30:16 +00001469 pLock->locktype = locktype;
drh3cde3bb2004-06-12 02:17:14 +00001470 }else if( locktype==EXCLUSIVE_LOCK ){
drh054889e2005-11-30 03:20:31 +00001471 pFile->locktype = PENDING_LOCK;
drh3cde3bb2004-06-12 02:17:14 +00001472 pLock->locktype = PENDING_LOCK;
danielk1977ecb2a962004-06-02 06:30:16 +00001473 }
danielk19779a1d0ab2004-06-01 14:09:28 +00001474
1475end_lock:
danielk1977b4b47412007-08-17 15:53:36 +00001476 leaveMutex();
drh4f0c5872007-03-26 22:05:01 +00001477 OSTRACE4("LOCK %d %s %s\n", pFile->h, locktypeName(locktype),
danielk19772b444852004-06-29 07:45:33 +00001478 rc==SQLITE_OK ? "ok" : "failed");
drhbbd42a62004-05-22 17:41:58 +00001479 return rc;
1480}
1481
1482/*
drh054889e2005-11-30 03:20:31 +00001483** Lower the locking level on file descriptor pFile to locktype. locktype
drha6abd042004-06-09 17:37:22 +00001484** must be either NO_LOCK or SHARED_LOCK.
1485**
1486** If the locking level of the file descriptor is already at or below
1487** the requested locking level, this routine is a no-op.
drhbbd42a62004-05-22 17:41:58 +00001488*/
danielk197762079062007-08-15 17:08:46 +00001489static int unixUnlock(sqlite3_file *id, int locktype){
drha6abd042004-06-09 17:37:22 +00001490 struct lockInfo *pLock;
1491 struct flock lock;
drh9c105bb2004-10-02 20:38:28 +00001492 int rc = SQLITE_OK;
drh054889e2005-11-30 03:20:31 +00001493 unixFile *pFile = (unixFile*)id;
drh1aa5af12008-03-07 19:51:14 +00001494 int h;
drha6abd042004-06-09 17:37:22 +00001495
drh054889e2005-11-30 03:20:31 +00001496 assert( pFile );
drh4f0c5872007-03-26 22:05:01 +00001497 OSTRACE7("UNLOCK %d %d was %d(%d,%d) pid=%d\n", pFile->h, locktype,
drh054889e2005-11-30 03:20:31 +00001498 pFile->locktype, pFile->pLock->locktype, pFile->pLock->cnt, getpid());
drha6abd042004-06-09 17:37:22 +00001499
1500 assert( locktype<=SHARED_LOCK );
drh054889e2005-11-30 03:20:31 +00001501 if( pFile->locktype<=locktype ){
drha6abd042004-06-09 17:37:22 +00001502 return SQLITE_OK;
1503 }
drhf1a221e2006-01-15 17:27:17 +00001504 if( CHECK_THREADID(pFile) ){
1505 return SQLITE_MISUSE;
1506 }
danielk1977b4b47412007-08-17 15:53:36 +00001507 enterMutex();
drh1aa5af12008-03-07 19:51:14 +00001508 h = pFile->h;
drh054889e2005-11-30 03:20:31 +00001509 pLock = pFile->pLock;
drha6abd042004-06-09 17:37:22 +00001510 assert( pLock->cnt!=0 );
drh054889e2005-11-30 03:20:31 +00001511 if( pFile->locktype>SHARED_LOCK ){
1512 assert( pLock->locktype==pFile->locktype );
drh1aa5af12008-03-07 19:51:14 +00001513 SimulateIOErrorBenign(1);
1514 SimulateIOError( h=(-1) )
1515 SimulateIOErrorBenign(0);
drh9c105bb2004-10-02 20:38:28 +00001516 if( locktype==SHARED_LOCK ){
1517 lock.l_type = F_RDLCK;
1518 lock.l_whence = SEEK_SET;
1519 lock.l_start = SHARED_FIRST;
1520 lock.l_len = SHARED_SIZE;
drh1aa5af12008-03-07 19:51:14 +00001521 if( fcntl(h, F_SETLK, &lock)==(-1) ){
aswift5b1a2562008-08-22 00:22:35 +00001522 int tErrno = errno;
1523 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_RDLOCK);
1524 if( IS_LOCK_ERROR(rc) ){
1525 pFile->lastErrno = tErrno;
1526 }
1527 goto end_unlock;
drh9c105bb2004-10-02 20:38:28 +00001528 }
1529 }
drhbbd42a62004-05-22 17:41:58 +00001530 lock.l_type = F_UNLCK;
1531 lock.l_whence = SEEK_SET;
drha6abd042004-06-09 17:37:22 +00001532 lock.l_start = PENDING_BYTE;
1533 lock.l_len = 2L; assert( PENDING_BYTE+1==RESERVED_BYTE );
drh1aa5af12008-03-07 19:51:14 +00001534 if( fcntl(h, F_SETLK, &lock)!=(-1) ){
drh2b4b5962005-06-15 17:47:55 +00001535 pLock->locktype = SHARED_LOCK;
1536 }else{
aswift5b1a2562008-08-22 00:22:35 +00001537 int tErrno = errno;
1538 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_UNLOCK);
1539 if( IS_LOCK_ERROR(rc) ){
1540 pFile->lastErrno = tErrno;
1541 }
1542 goto end_unlock;
drh2b4b5962005-06-15 17:47:55 +00001543 }
drhbbd42a62004-05-22 17:41:58 +00001544 }
drha6abd042004-06-09 17:37:22 +00001545 if( locktype==NO_LOCK ){
1546 struct openCnt *pOpen;
danielk1977ecb2a962004-06-02 06:30:16 +00001547
drha6abd042004-06-09 17:37:22 +00001548 /* Decrement the shared lock counter. Release the lock using an
1549 ** OS call only when all threads in this same process have released
1550 ** the lock.
1551 */
1552 pLock->cnt--;
1553 if( pLock->cnt==0 ){
1554 lock.l_type = F_UNLCK;
1555 lock.l_whence = SEEK_SET;
1556 lock.l_start = lock.l_len = 0L;
drh1aa5af12008-03-07 19:51:14 +00001557 SimulateIOErrorBenign(1);
1558 SimulateIOError( h=(-1) )
1559 SimulateIOErrorBenign(0);
1560 if( fcntl(h, F_SETLK, &lock)!=(-1) ){
drh2b4b5962005-06-15 17:47:55 +00001561 pLock->locktype = NO_LOCK;
1562 }else{
aswift5b1a2562008-08-22 00:22:35 +00001563 int tErrno = errno;
1564 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_UNLOCK);
1565 if( IS_LOCK_ERROR(rc) ){
1566 pFile->lastErrno = tErrno;
1567 }
drh1aa5af12008-03-07 19:51:14 +00001568 pLock->cnt = 1;
aswift5b1a2562008-08-22 00:22:35 +00001569 goto end_unlock;
drh2b4b5962005-06-15 17:47:55 +00001570 }
drha6abd042004-06-09 17:37:22 +00001571 }
1572
drhbbd42a62004-05-22 17:41:58 +00001573 /* Decrement the count of locks against this same file. When the
1574 ** count reaches zero, close any other file descriptors whose close
1575 ** was deferred because of outstanding locks.
1576 */
drh1aa5af12008-03-07 19:51:14 +00001577 if( rc==SQLITE_OK ){
1578 pOpen = pFile->pOpen;
1579 pOpen->nLock--;
1580 assert( pOpen->nLock>=0 );
1581 if( pOpen->nLock==0 && pOpen->nPending>0 ){
1582 int i;
1583 for(i=0; i<pOpen->nPending; i++){
1584 close(pOpen->aPending[i]);
1585 }
drhda0e7682008-07-30 15:27:54 +00001586 sqlite3_free(pOpen->aPending);
drh1aa5af12008-03-07 19:51:14 +00001587 pOpen->nPending = 0;
1588 pOpen->aPending = 0;
drhbbd42a62004-05-22 17:41:58 +00001589 }
drhbbd42a62004-05-22 17:41:58 +00001590 }
1591 }
aswift5b1a2562008-08-22 00:22:35 +00001592
1593end_unlock:
danielk1977b4b47412007-08-17 15:53:36 +00001594 leaveMutex();
drh1aa5af12008-03-07 19:51:14 +00001595 if( rc==SQLITE_OK ) pFile->locktype = locktype;
drh9c105bb2004-10-02 20:38:28 +00001596 return rc;
drhbbd42a62004-05-22 17:41:58 +00001597}
1598
1599/*
danielk1977e339d652008-06-28 11:23:00 +00001600** This function performs the parts of the "close file" operation
1601** common to all locking schemes. It closes the directory and file
1602** handles, if they are valid, and sets all fields of the unixFile
1603** structure to 0.
1604*/
1605static int closeUnixFile(sqlite3_file *id){
1606 unixFile *pFile = (unixFile*)id;
1607 if( pFile ){
1608 if( pFile->dirfd>=0 ){
1609 close(pFile->dirfd);
1610 }
1611 if( pFile->h>=0 ){
1612 close(pFile->h);
1613 }
1614 OSTRACE2("CLOSE %-3d\n", pFile->h);
1615 OpenCounter(-1);
1616 memset(pFile, 0, sizeof(unixFile));
1617 }
1618 return SQLITE_OK;
1619}
1620
1621/*
danielk1977e3026632004-06-22 11:29:02 +00001622** Close a file.
1623*/
danielk197762079062007-08-15 17:08:46 +00001624static int unixClose(sqlite3_file *id){
danielk1977e339d652008-06-28 11:23:00 +00001625 if( id ){
1626 unixFile *pFile = (unixFile *)id;
1627 unixUnlock(id, NO_LOCK);
1628 enterMutex();
danielk19776cb427f2008-06-30 10:16:04 +00001629 if( pFile->pOpen && pFile->pOpen->nLock ){
danielk1977e339d652008-06-28 11:23:00 +00001630 /* If there are outstanding locks, do not actually close the file just
1631 ** yet because that would clear those locks. Instead, add the file
1632 ** descriptor to pOpen->aPending. It will be automatically closed when
1633 ** the last lock is cleared.
1634 */
1635 int *aNew;
1636 struct openCnt *pOpen = pFile->pOpen;
drhda0e7682008-07-30 15:27:54 +00001637 aNew = sqlite3_realloc(pOpen->aPending, (pOpen->nPending+1)*sizeof(int) );
danielk1977e339d652008-06-28 11:23:00 +00001638 if( aNew==0 ){
1639 /* If a malloc fails, just leak the file descriptor */
1640 }else{
1641 pOpen->aPending = aNew;
1642 pOpen->aPending[pOpen->nPending] = pFile->h;
1643 pOpen->nPending++;
1644 pFile->h = -1;
1645 }
danielk1977e3026632004-06-22 11:29:02 +00001646 }
danielk1977e339d652008-06-28 11:23:00 +00001647 releaseLockInfo(pFile->pLock);
1648 releaseOpenCnt(pFile->pOpen);
1649 closeUnixFile(id);
1650 leaveMutex();
danielk1977e3026632004-06-22 11:29:02 +00001651 }
drh02afc862006-01-20 18:10:57 +00001652 return SQLITE_OK;
danielk1977e3026632004-06-22 11:29:02 +00001653}
1654
drhbfe66312006-10-03 17:40:40 +00001655
1656#ifdef SQLITE_ENABLE_LOCKING_STYLE
1657#pragma mark AFP Support
1658
1659/*
1660 ** The afpLockingContext structure contains all afp lock specific state
1661 */
1662typedef struct afpLockingContext afpLockingContext;
1663struct afpLockingContext {
drh1aa5af12008-03-07 19:51:14 +00001664 unsigned long long sharedLockByte;
drh308aa322008-03-07 20:14:38 +00001665 const char *filePath;
drhbfe66312006-10-03 17:40:40 +00001666};
1667
1668struct ByteRangeLockPB2
1669{
1670 unsigned long long offset; /* offset to first byte to lock */
1671 unsigned long long length; /* nbr of bytes to lock */
1672 unsigned long long retRangeStart; /* nbr of 1st byte locked if successful */
1673 unsigned char unLockFlag; /* 1 = unlock, 0 = lock */
1674 unsigned char startEndFlag; /* 1=rel to end of fork, 0=rel to start */
1675 int fd; /* file desc to assoc this lock with */
1676};
1677
drhfd131da2007-08-07 17:13:03 +00001678#define afpfsByteRangeLock2FSCTL _IOWR('z', 23, struct ByteRangeLockPB2)
drhbfe66312006-10-03 17:40:40 +00001679
danielk1977ad94b582007-08-20 06:44:22 +00001680/*
aswift5b1a2562008-08-22 00:22:35 +00001681 ** Return SQLITE_OK on success, SQLITE_BUSY on failure.
1682 */
danielk1977ad94b582007-08-20 06:44:22 +00001683static int _AFPFSSetLock(
1684 const char *path,
aswift5b1a2562008-08-22 00:22:35 +00001685 unixFile *pFile,
danielk1977ad94b582007-08-20 06:44:22 +00001686 unsigned long long offset,
1687 unsigned long long length,
1688 int setLockFlag
1689){
drhfd131da2007-08-07 17:13:03 +00001690 struct ByteRangeLockPB2 pb;
drhbfe66312006-10-03 17:40:40 +00001691 int err;
1692
1693 pb.unLockFlag = setLockFlag ? 0 : 1;
1694 pb.startEndFlag = 0;
1695 pb.offset = offset;
1696 pb.length = length;
aswift5b1a2562008-08-22 00:22:35 +00001697 pb.fd = pFile->h;
drh4f0c5872007-03-26 22:05:01 +00001698 OSTRACE5("AFPLOCK setting lock %s for %d in range %llx:%llx\n",
aswift5b1a2562008-08-22 00:22:35 +00001699 (setLockFlag?"ON":"OFF"), pFile->h, offset, length);
drhbfe66312006-10-03 17:40:40 +00001700 err = fsctl(path, afpfsByteRangeLock2FSCTL, &pb, 0);
1701 if ( err==-1 ) {
aswift5b1a2562008-08-22 00:22:35 +00001702 int rc;
1703 int tErrno = errno;
1704 OSTRACE4("AFPLOCK failed to fsctl() '%s' %d %s\n", path, tErrno, strerror(tErrno));
1705 rc = sqliteErrorFromPosixError(tErrno, setLockFlag ? SQLITE_IOERR_LOCK : SQLITE_IOERR_UNLOCK); /* error */
1706 if( IS_LOCK_ERROR(rc) ){
1707 pFile->lastErrno = tErrno;
1708 }
1709 return rc;
drhbfe66312006-10-03 17:40:40 +00001710 } else {
aswift5b1a2562008-08-22 00:22:35 +00001711 return SQLITE_OK;
drhbfe66312006-10-03 17:40:40 +00001712 }
1713}
1714
aswift5b1a2562008-08-22 00:22:35 +00001715/* AFP-style reserved lock checking following the behavior of
1716** unixCheckReservedLock, see the unixCheckReservedLock function comments */
danielk1977e339d652008-06-28 11:23:00 +00001717static int afpCheckReservedLock(sqlite3_file *id, int *pResOut){
aswift5b1a2562008-08-22 00:22:35 +00001718 int rc = SQLITE_OK;
1719 int reserved = 0;
drhbfe66312006-10-03 17:40:40 +00001720 unixFile *pFile = (unixFile*)id;
1721
aswift5b1a2562008-08-22 00:22:35 +00001722 SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
1723
1724 assert( pFile );
drhbfe66312006-10-03 17:40:40 +00001725 afpLockingContext *context = (afpLockingContext *) pFile->lockingContext;
1726
1727 /* Check if a thread in this process holds such a lock */
1728 if( pFile->locktype>SHARED_LOCK ){
aswift5b1a2562008-08-22 00:22:35 +00001729 reserved = 1;
drhbfe66312006-10-03 17:40:40 +00001730 }
1731
1732 /* Otherwise see if some other process holds it.
1733 */
aswift5b1a2562008-08-22 00:22:35 +00001734 if( !reserved ){
1735 /* lock the RESERVED byte */
1736 int lrc = _AFPFSSetLock(context->filePath, pFile, RESERVED_BYTE, 1,1);
1737 if( SQLITE_OK==lrc ){
drhbfe66312006-10-03 17:40:40 +00001738 /* if we succeeded in taking the reserved lock, unlock it to restore
1739 ** the original state */
aswift5b1a2562008-08-22 00:22:35 +00001740 lrc = _AFPFSSetLock(context->filePath, pFile, RESERVED_BYTE, 1, 0);
1741 } else {
1742 /* if we failed to get the lock then someone else must have it */
1743 reserved = 1;
1744 }
1745 if( IS_LOCK_ERROR(lrc) ){
1746 rc=lrc;
drhbfe66312006-10-03 17:40:40 +00001747 }
1748 }
drhbfe66312006-10-03 17:40:40 +00001749
aswift5b1a2562008-08-22 00:22:35 +00001750 OSTRACE4("TEST WR-LOCK %d %d %d\n", pFile->h, rc, reserved);
1751
1752 *pResOut = reserved;
1753 return rc;
drhbfe66312006-10-03 17:40:40 +00001754}
1755
1756/* AFP-style locking following the behavior of unixLock, see the unixLock
1757** function comments for details of lock management. */
danielk1977e339d652008-06-28 11:23:00 +00001758static int afpLock(sqlite3_file *id, int locktype){
drhbfe66312006-10-03 17:40:40 +00001759 int rc = SQLITE_OK;
1760 unixFile *pFile = (unixFile*)id;
1761 afpLockingContext *context = (afpLockingContext *) pFile->lockingContext;
drhbfe66312006-10-03 17:40:40 +00001762
1763 assert( pFile );
drh4f0c5872007-03-26 22:05:01 +00001764 OSTRACE5("LOCK %d %s was %s pid=%d\n", pFile->h,
drh339eb0b2008-03-07 15:34:11 +00001765 locktypeName(locktype), locktypeName(pFile->locktype), getpid());
1766
drhbfe66312006-10-03 17:40:40 +00001767 /* If there is already a lock of this type or more restrictive on the
drh339eb0b2008-03-07 15:34:11 +00001768 ** unixFile, do nothing. Don't use the afp_end_lock: exit path, as
1769 ** enterMutex() hasn't been called yet.
1770 */
drhbfe66312006-10-03 17:40:40 +00001771 if( pFile->locktype>=locktype ){
drh4f0c5872007-03-26 22:05:01 +00001772 OSTRACE3("LOCK %d %s ok (already held)\n", pFile->h,
drhbfe66312006-10-03 17:40:40 +00001773 locktypeName(locktype));
1774 return SQLITE_OK;
1775 }
1776
1777 /* Make sure the locking sequence is correct
drh339eb0b2008-03-07 15:34:11 +00001778 */
drhbfe66312006-10-03 17:40:40 +00001779 assert( pFile->locktype!=NO_LOCK || locktype==SHARED_LOCK );
1780 assert( locktype!=PENDING_LOCK );
1781 assert( locktype!=RESERVED_LOCK || pFile->locktype==SHARED_LOCK );
1782
1783 /* This mutex is needed because pFile->pLock is shared across threads
drh339eb0b2008-03-07 15:34:11 +00001784 */
danielk1977b4b47412007-08-17 15:53:36 +00001785 enterMutex();
drhbfe66312006-10-03 17:40:40 +00001786
1787 /* Make sure the current thread owns the pFile.
drh339eb0b2008-03-07 15:34:11 +00001788 */
drhbfe66312006-10-03 17:40:40 +00001789 rc = transferOwnership(pFile);
1790 if( rc!=SQLITE_OK ){
danielk1977b4b47412007-08-17 15:53:36 +00001791 leaveMutex();
drhbfe66312006-10-03 17:40:40 +00001792 return rc;
1793 }
1794
1795 /* A PENDING lock is needed before acquiring a SHARED lock and before
drh339eb0b2008-03-07 15:34:11 +00001796 ** acquiring an EXCLUSIVE lock. For the SHARED lock, the PENDING will
1797 ** be released.
1798 */
drhbfe66312006-10-03 17:40:40 +00001799 if( locktype==SHARED_LOCK
1800 || (locktype==EXCLUSIVE_LOCK && pFile->locktype<PENDING_LOCK)
drh339eb0b2008-03-07 15:34:11 +00001801 ){
1802 int failed;
aswift5b1a2562008-08-22 00:22:35 +00001803 failed = _AFPFSSetLock(context->filePath, pFile, PENDING_BYTE, 1, 1);
drhbfe66312006-10-03 17:40:40 +00001804 if (failed) {
aswift5b1a2562008-08-22 00:22:35 +00001805 rc = failed;
drhbfe66312006-10-03 17:40:40 +00001806 goto afp_end_lock;
1807 }
1808 }
1809
1810 /* If control gets to this point, then actually go ahead and make
drh339eb0b2008-03-07 15:34:11 +00001811 ** operating system calls for the specified lock.
1812 */
drhbfe66312006-10-03 17:40:40 +00001813 if( locktype==SHARED_LOCK ){
aswift5b1a2562008-08-22 00:22:35 +00001814 int lk, lrc1, lrc2, lrc1Errno;
drhbfe66312006-10-03 17:40:40 +00001815
aswift5b1a2562008-08-22 00:22:35 +00001816 /* Now get the read-lock SHARED_LOCK */
drhbfe66312006-10-03 17:40:40 +00001817 /* note that the quality of the randomness doesn't matter that much */
1818 lk = random();
1819 context->sharedLockByte = (lk & 0x7fffffff)%(SHARED_SIZE - 1);
aswift5b1a2562008-08-22 00:22:35 +00001820 lrc1 = _AFPFSSetLock(context->filePath, pFile,
1821 SHARED_FIRST+context->sharedLockByte, 1, 1);
1822 if( IS_LOCK_ERROR(lrc1) ){
1823 lrc1Errno = pFile->lastErrno;
drhbfe66312006-10-03 17:40:40 +00001824 }
aswift5b1a2562008-08-22 00:22:35 +00001825 /* Drop the temporary PENDING lock */
1826 lrc2 = _AFPFSSetLock(context->filePath, pFile, PENDING_BYTE, 1, 0);
drhbfe66312006-10-03 17:40:40 +00001827
aswift5b1a2562008-08-22 00:22:35 +00001828 if( IS_LOCK_ERROR(lrc1) ) {
1829 pFile->lastErrno = lrc1Errno;
1830 rc = lrc1;
1831 goto afp_end_lock;
1832 } else if( IS_LOCK_ERROR(lrc2) ){
1833 rc = lrc2;
1834 goto afp_end_lock;
1835 } else if( lrc1 != SQLITE_OK ) {
1836 rc = lrc1;
drhbfe66312006-10-03 17:40:40 +00001837 } else {
1838 pFile->locktype = SHARED_LOCK;
1839 }
1840 }else{
1841 /* The request was for a RESERVED or EXCLUSIVE lock. It is
1842 ** assumed that there is a SHARED or greater lock on the file
1843 ** already.
1844 */
1845 int failed = 0;
1846 assert( 0!=pFile->locktype );
1847 if (locktype >= RESERVED_LOCK && pFile->locktype < RESERVED_LOCK) {
1848 /* Acquire a RESERVED lock */
aswift5b1a2562008-08-22 00:22:35 +00001849 failed = _AFPFSSetLock(context->filePath, pFile, RESERVED_BYTE, 1,1);
drhbfe66312006-10-03 17:40:40 +00001850 }
1851 if (!failed && locktype == EXCLUSIVE_LOCK) {
1852 /* Acquire an EXCLUSIVE lock */
1853
1854 /* Remove the shared lock before trying the range. we'll need to
danielk1977e339d652008-06-28 11:23:00 +00001855 ** reestablish the shared lock if we can't get the afpUnlock
drhbfe66312006-10-03 17:40:40 +00001856 */
aswift5b1a2562008-08-22 00:22:35 +00001857 if (!(failed = _AFPFSSetLock(context->filePath, pFile, SHARED_FIRST +
1858 context->sharedLockByte, 1, 0))) {
drhbfe66312006-10-03 17:40:40 +00001859 /* now attemmpt to get the exclusive lock range */
aswift5b1a2562008-08-22 00:22:35 +00001860 failed = _AFPFSSetLock(context->filePath, pFile, SHARED_FIRST,
drhbfe66312006-10-03 17:40:40 +00001861 SHARED_SIZE, 1);
aswift5b1a2562008-08-22 00:22:35 +00001862 if (failed && (failed = _AFPFSSetLock(context->filePath, pFile,
1863 SHARED_FIRST + context->sharedLockByte, 1, 1))) {
1864 rc = failed;
drhbfe66312006-10-03 17:40:40 +00001865 }
1866 } else {
aswift5b1a2562008-08-22 00:22:35 +00001867 rc = failed;
drhbfe66312006-10-03 17:40:40 +00001868 }
1869 }
aswift5b1a2562008-08-22 00:22:35 +00001870 if( failed ){
1871 rc = failed;
drhbfe66312006-10-03 17:40:40 +00001872 }
1873 }
1874
1875 if( rc==SQLITE_OK ){
1876 pFile->locktype = locktype;
1877 }else if( locktype==EXCLUSIVE_LOCK ){
1878 pFile->locktype = PENDING_LOCK;
1879 }
1880
1881afp_end_lock:
drh339eb0b2008-03-07 15:34:11 +00001882 leaveMutex();
drh4f0c5872007-03-26 22:05:01 +00001883 OSTRACE4("LOCK %d %s %s\n", pFile->h, locktypeName(locktype),
drhbfe66312006-10-03 17:40:40 +00001884 rc==SQLITE_OK ? "ok" : "failed");
1885 return rc;
1886}
1887
1888/*
drh339eb0b2008-03-07 15:34:11 +00001889** Lower the locking level on file descriptor pFile to locktype. locktype
1890** must be either NO_LOCK or SHARED_LOCK.
1891**
1892** If the locking level of the file descriptor is already at or below
1893** the requested locking level, this routine is a no-op.
1894*/
danielk1977e339d652008-06-28 11:23:00 +00001895static int afpUnlock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00001896 int rc = SQLITE_OK;
1897 unixFile *pFile = (unixFile*)id;
1898 afpLockingContext *context = (afpLockingContext *) pFile->lockingContext;
1899
1900 assert( pFile );
drh4f0c5872007-03-26 22:05:01 +00001901 OSTRACE5("UNLOCK %d %d was %d pid=%d\n", pFile->h, locktype,
drhbfe66312006-10-03 17:40:40 +00001902 pFile->locktype, getpid());
aswift5b1a2562008-08-22 00:22:35 +00001903
drhbfe66312006-10-03 17:40:40 +00001904 assert( locktype<=SHARED_LOCK );
1905 if( pFile->locktype<=locktype ){
1906 return SQLITE_OK;
1907 }
1908 if( CHECK_THREADID(pFile) ){
1909 return SQLITE_MISUSE;
1910 }
danielk1977b4b47412007-08-17 15:53:36 +00001911 enterMutex();
aswift5b1a2562008-08-22 00:22:35 +00001912 int failed = SQLITE_OK;
drhbfe66312006-10-03 17:40:40 +00001913 if( pFile->locktype>SHARED_LOCK ){
1914 if( locktype==SHARED_LOCK ){
drhbfe66312006-10-03 17:40:40 +00001915
1916 /* unlock the exclusive range - then re-establish the shared lock */
1917 if (pFile->locktype==EXCLUSIVE_LOCK) {
aswift5b1a2562008-08-22 00:22:35 +00001918 failed = _AFPFSSetLock(context->filePath, pFile, SHARED_FIRST,
drhbfe66312006-10-03 17:40:40 +00001919 SHARED_SIZE, 0);
1920 if (!failed) {
1921 /* successfully removed the exclusive lock */
aswift5b1a2562008-08-22 00:22:35 +00001922 if ((failed = _AFPFSSetLock(context->filePath, pFile, SHARED_FIRST+
1923 context->sharedLockByte, 1, 1))) {
drhbfe66312006-10-03 17:40:40 +00001924 /* failed to re-establish our shared lock */
aswift5b1a2562008-08-22 00:22:35 +00001925 rc = failed;
drhbfe66312006-10-03 17:40:40 +00001926 }
1927 } else {
aswift5b1a2562008-08-22 00:22:35 +00001928 rc = failed;
drhbfe66312006-10-03 17:40:40 +00001929 }
1930 }
1931 }
1932 if (rc == SQLITE_OK && pFile->locktype>=PENDING_LOCK) {
aswift5b1a2562008-08-22 00:22:35 +00001933 if ((failed = _AFPFSSetLock(context->filePath, pFile,
1934 PENDING_BYTE, 1, 0))){
drhbfe66312006-10-03 17:40:40 +00001935 /* failed to release the pending lock */
aswift5b1a2562008-08-22 00:22:35 +00001936 rc = failed;
drhbfe66312006-10-03 17:40:40 +00001937 }
1938 }
1939 if (rc == SQLITE_OK && pFile->locktype>=RESERVED_LOCK) {
aswift5b1a2562008-08-22 00:22:35 +00001940 if ((failed = _AFPFSSetLock(context->filePath, pFile,
1941 RESERVED_BYTE, 1, 0))) {
drhbfe66312006-10-03 17:40:40 +00001942 /* failed to release the reserved lock */
aswift5b1a2562008-08-22 00:22:35 +00001943 rc = failed;
drhbfe66312006-10-03 17:40:40 +00001944 }
1945 }
1946 }
1947 if( locktype==NO_LOCK ){
aswift5b1a2562008-08-22 00:22:35 +00001948 int failed = _AFPFSSetLock(context->filePath, pFile,
drhbfe66312006-10-03 17:40:40 +00001949 SHARED_FIRST + context->sharedLockByte, 1, 0);
1950 if (failed) {
aswift5b1a2562008-08-22 00:22:35 +00001951 rc = failed;
drhbfe66312006-10-03 17:40:40 +00001952 }
1953 }
1954 if (rc == SQLITE_OK)
1955 pFile->locktype = locktype;
danielk1977b4b47412007-08-17 15:53:36 +00001956 leaveMutex();
drhbfe66312006-10-03 17:40:40 +00001957 return rc;
1958}
1959
1960/*
drh339eb0b2008-03-07 15:34:11 +00001961** Close a file & cleanup AFP specific locking context
1962*/
danielk1977e339d652008-06-28 11:23:00 +00001963static int afpClose(sqlite3_file *id) {
1964 if( id ){
1965 unixFile *pFile = (unixFile*)id;
1966 afpUnlock(id, NO_LOCK);
1967 sqlite3_free(pFile->lockingContext);
1968 }
1969 return closeUnixFile(id);
drhbfe66312006-10-03 17:40:40 +00001970}
1971
1972
1973#pragma mark flock() style locking
1974
1975/*
drh339eb0b2008-03-07 15:34:11 +00001976** The flockLockingContext is not used
1977*/
drhbfe66312006-10-03 17:40:40 +00001978typedef void flockLockingContext;
1979
aswift5b1a2562008-08-22 00:22:35 +00001980/* flock-style reserved lock checking following the behavior of
1981 ** unixCheckReservedLock, see the unixCheckReservedLock function comments */
danielk1977e339d652008-06-28 11:23:00 +00001982static int flockCheckReservedLock(sqlite3_file *id, int *pResOut){
aswift5b1a2562008-08-22 00:22:35 +00001983 int rc = SQLITE_OK;
1984 int reserved = 0;
drhbfe66312006-10-03 17:40:40 +00001985 unixFile *pFile = (unixFile*)id;
1986
aswift5b1a2562008-08-22 00:22:35 +00001987 SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
1988
1989 assert( pFile );
1990
1991 /* Check if a thread in this process holds such a lock */
1992 if( pFile->locktype>SHARED_LOCK ){
1993 reserved = 1;
1994 }
1995
1996 /* Otherwise see if some other process holds it. */
1997 if( !reserved ){
drh3b62b2f2007-06-08 18:27:03 +00001998 /* attempt to get the lock */
aswift5b1a2562008-08-22 00:22:35 +00001999 int lrc = flock(pFile->h, LOCK_EX | LOCK_NB);
2000 if( !lrc ){
drh3b62b2f2007-06-08 18:27:03 +00002001 /* got the lock, unlock it */
aswift5b1a2562008-08-22 00:22:35 +00002002 lrc = flock(pFile->h, LOCK_UN);
2003 if ( lrc ) {
2004 int tErrno = errno;
2005 /* unlock failed with an error */
2006 lrc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_UNLOCK);
2007 if( IS_LOCK_ERROR(lrc) ){
2008 pFile->lastErrno = tErrno;
2009 rc = lrc;
2010 }
2011 }
2012 } else {
2013 int tErrno = errno;
2014 reserved = 1;
2015 /* someone else might have it reserved */
2016 lrc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
2017 if( IS_LOCK_ERROR(lrc) ){
2018 pFile->lastErrno = tErrno;
2019 rc = lrc;
2020 }
drhbfe66312006-10-03 17:40:40 +00002021 }
drhbfe66312006-10-03 17:40:40 +00002022 }
aswift5b1a2562008-08-22 00:22:35 +00002023 OSTRACE4("TEST WR-LOCK %d %d %d\n", pFile->h, rc, reserved);
danielk1977861f7452008-06-05 11:39:11 +00002024
aswift5b1a2562008-08-22 00:22:35 +00002025 *pResOut = reserved;
2026 return rc;
drhbfe66312006-10-03 17:40:40 +00002027}
2028
danielk1977e339d652008-06-28 11:23:00 +00002029static int flockLock(sqlite3_file *id, int locktype) {
aswift5b1a2562008-08-22 00:22:35 +00002030 int rc = SQLITE_OK;
2031 int lrc;
drhbfe66312006-10-03 17:40:40 +00002032 unixFile *pFile = (unixFile*)id;
aswift5b1a2562008-08-22 00:22:35 +00002033
2034 assert( pFile );
2035
drh3b62b2f2007-06-08 18:27:03 +00002036 /* if we already have a lock, it is exclusive.
2037 ** Just adjust level and punt on outta here. */
drhbfe66312006-10-03 17:40:40 +00002038 if (pFile->locktype > NO_LOCK) {
2039 pFile->locktype = locktype;
2040 return SQLITE_OK;
2041 }
2042
drh3b62b2f2007-06-08 18:27:03 +00002043 /* grab an exclusive lock */
aswift5b1a2562008-08-22 00:22:35 +00002044
2045 if (flock(pFile->h, LOCK_EX | LOCK_NB)) {
2046 int tErrno = errno;
drh3b62b2f2007-06-08 18:27:03 +00002047 /* didn't get, must be busy */
aswift5b1a2562008-08-22 00:22:35 +00002048 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
2049 if( IS_LOCK_ERROR(rc) ){
2050 pFile->lastErrno = tErrno;
2051 }
drhbfe66312006-10-03 17:40:40 +00002052 } else {
drh3b62b2f2007-06-08 18:27:03 +00002053 /* got it, set the type and return ok */
drhbfe66312006-10-03 17:40:40 +00002054 pFile->locktype = locktype;
drhbfe66312006-10-03 17:40:40 +00002055 }
aswift5b1a2562008-08-22 00:22:35 +00002056 OSTRACE4("LOCK %d %s %s\n", pFile->h, locktypeName(locktype),
2057 rc==SQLITE_OK ? "ok" : "failed");
2058 return rc;
drhbfe66312006-10-03 17:40:40 +00002059}
2060
danielk1977e339d652008-06-28 11:23:00 +00002061static int flockUnlock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00002062 unixFile *pFile = (unixFile*)id;
2063
aswift5b1a2562008-08-22 00:22:35 +00002064 assert( pFile );
2065 OSTRACE5("UNLOCK %d %d was %d pid=%d\n", pFile->h, locktype,
2066 pFile->locktype, getpid());
drhbfe66312006-10-03 17:40:40 +00002067 assert( locktype<=SHARED_LOCK );
2068
drh3b62b2f2007-06-08 18:27:03 +00002069 /* no-op if possible */
drhbfe66312006-10-03 17:40:40 +00002070 if( pFile->locktype==locktype ){
2071 return SQLITE_OK;
2072 }
2073
drh3b62b2f2007-06-08 18:27:03 +00002074 /* shared can just be set because we always have an exclusive */
drhbfe66312006-10-03 17:40:40 +00002075 if (locktype==SHARED_LOCK) {
2076 pFile->locktype = locktype;
2077 return SQLITE_OK;
2078 }
2079
drh3b62b2f2007-06-08 18:27:03 +00002080 /* no, really, unlock. */
drhbfe66312006-10-03 17:40:40 +00002081 int rc = flock(pFile->h, LOCK_UN);
aswift5b1a2562008-08-22 00:22:35 +00002082 if (rc) {
2083 int r, tErrno = errno;
2084 r = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_UNLOCK);
2085 if( IS_LOCK_ERROR(r) ){
2086 pFile->lastErrno = tErrno;
2087 }
2088 return r;
2089 } else {
drhbfe66312006-10-03 17:40:40 +00002090 pFile->locktype = NO_LOCK;
2091 return SQLITE_OK;
2092 }
2093}
2094
2095/*
drh339eb0b2008-03-07 15:34:11 +00002096** Close a file.
2097*/
danielk1977e339d652008-06-28 11:23:00 +00002098static int flockClose(sqlite3_file *id) {
2099 if( id ){
2100 flockUnlock(id, NO_LOCK);
2101 }
2102 return closeUnixFile(id);
drhbfe66312006-10-03 17:40:40 +00002103}
2104
2105#pragma mark Old-School .lock file based locking
2106
aswift5b1a2562008-08-22 00:22:35 +00002107/* Dotlock-style reserved lock checking following the behavior of
2108** unixCheckReservedLock, see the unixCheckReservedLock function comments */
danielk1977e339d652008-06-28 11:23:00 +00002109static int dotlockCheckReservedLock(sqlite3_file *id, int *pResOut) {
aswift5b1a2562008-08-22 00:22:35 +00002110 int rc = SQLITE_OK;
2111 int reserved = 0;
drhbfe66312006-10-03 17:40:40 +00002112 unixFile *pFile = (unixFile*)id;
drh339eb0b2008-03-07 15:34:11 +00002113
aswift5b1a2562008-08-22 00:22:35 +00002114 SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
2115
2116 assert( pFile );
2117
2118 /* Check if a thread in this process holds such a lock */
2119 if( pFile->locktype>SHARED_LOCK ){
2120 reserved = 1;
2121 }
2122
2123 /* Otherwise see if some other process holds it. */
2124 if( !reserved ){
2125 char *zLockFile = (char *)pFile->lockingContext;
drhbfe66312006-10-03 17:40:40 +00002126 struct stat statBuf;
aswift5b1a2562008-08-22 00:22:35 +00002127
2128 if( lstat(zLockFile, &statBuf)==0 ){
2129 /* file exists, someone else has the lock */
2130 reserved = 1;
2131 }else{
drh3b62b2f2007-06-08 18:27:03 +00002132 /* file does not exist, we could have it if we want it */
aswift5b1a2562008-08-22 00:22:35 +00002133 int tErrno = errno;
2134 if( ENOENT != tErrno ){
2135 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_CHECKRESERVEDLOCK);
2136 pFile->lastErrno = tErrno;
2137 }
drh339eb0b2008-03-07 15:34:11 +00002138 }
drhbfe66312006-10-03 17:40:40 +00002139 }
aswift5b1a2562008-08-22 00:22:35 +00002140 OSTRACE4("TEST WR-LOCK %d %d %d\n", pFile->h, rc, reserved);
danielk1977861f7452008-06-05 11:39:11 +00002141
aswift5b1a2562008-08-22 00:22:35 +00002142 *pResOut = reserved;
2143 return rc;
drhbfe66312006-10-03 17:40:40 +00002144}
2145
danielk1977e339d652008-06-28 11:23:00 +00002146static int dotlockLock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00002147 unixFile *pFile = (unixFile*)id;
drh339eb0b2008-03-07 15:34:11 +00002148 int fd;
danielk1977e339d652008-06-28 11:23:00 +00002149 char *zLockFile = (char *)pFile->lockingContext;
aswift5b1a2562008-08-22 00:22:35 +00002150 int rc=SQLITE_OK;
drh339eb0b2008-03-07 15:34:11 +00002151
drh3b62b2f2007-06-08 18:27:03 +00002152 /* if we already have a lock, it is exclusive.
2153 ** Just adjust level and punt on outta here. */
drhbfe66312006-10-03 17:40:40 +00002154 if (pFile->locktype > NO_LOCK) {
2155 pFile->locktype = locktype;
2156
2157 /* Always update the timestamp on the old file */
danielk1977e339d652008-06-28 11:23:00 +00002158 utimes(zLockFile, NULL);
aswift5b1a2562008-08-22 00:22:35 +00002159 rc = SQLITE_OK;
2160 goto dotlock_end_lock;
drhbfe66312006-10-03 17:40:40 +00002161 }
2162
drh3b62b2f2007-06-08 18:27:03 +00002163 /* check to see if lock file already exists */
drhbfe66312006-10-03 17:40:40 +00002164 struct stat statBuf;
danielk1977e339d652008-06-28 11:23:00 +00002165 if (lstat(zLockFile,&statBuf) == 0){
aswift5b1a2562008-08-22 00:22:35 +00002166 rc = SQLITE_BUSY; /* it does, busy */
2167 goto dotlock_end_lock;
drhbfe66312006-10-03 17:40:40 +00002168 }
2169
drh3b62b2f2007-06-08 18:27:03 +00002170 /* grab an exclusive lock */
danielk1977e339d652008-06-28 11:23:00 +00002171 fd = open(zLockFile,O_RDONLY|O_CREAT|O_EXCL,0600);
drh339eb0b2008-03-07 15:34:11 +00002172 if( fd<0 ){
drh3b62b2f2007-06-08 18:27:03 +00002173 /* failed to open/create the file, someone else may have stolen the lock */
aswift5b1a2562008-08-22 00:22:35 +00002174 int tErrno = errno;
2175 if( EEXIST == tErrno ){
2176 rc = SQLITE_BUSY;
2177 } else {
2178 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
2179 if( IS_LOCK_ERROR(rc) ){
2180 pFile->lastErrno = tErrno;
2181 }
2182 }
2183 goto dotlock_end_lock;
2184 }
drhbfe66312006-10-03 17:40:40 +00002185 close(fd);
2186
drh3b62b2f2007-06-08 18:27:03 +00002187 /* got it, set the type and return ok */
drhbfe66312006-10-03 17:40:40 +00002188 pFile->locktype = locktype;
aswift5b1a2562008-08-22 00:22:35 +00002189
2190 dotlock_end_lock:
2191 return rc;
drhbfe66312006-10-03 17:40:40 +00002192}
2193
danielk1977e339d652008-06-28 11:23:00 +00002194static int dotlockUnlock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00002195 unixFile *pFile = (unixFile*)id;
danielk1977e339d652008-06-28 11:23:00 +00002196 char *zLockFile = (char *)pFile->lockingContext;
drh339eb0b2008-03-07 15:34:11 +00002197
aswift5b1a2562008-08-22 00:22:35 +00002198 assert( pFile );
2199 OSTRACE5("UNLOCK %d %d was %d pid=%d\n", pFile->h, locktype,
2200 pFile->locktype, getpid());
drhbfe66312006-10-03 17:40:40 +00002201 assert( locktype<=SHARED_LOCK );
2202
drh3b62b2f2007-06-08 18:27:03 +00002203 /* no-op if possible */
drhbfe66312006-10-03 17:40:40 +00002204 if( pFile->locktype==locktype ){
2205 return SQLITE_OK;
2206 }
2207
drh3b62b2f2007-06-08 18:27:03 +00002208 /* shared can just be set because we always have an exclusive */
drhbfe66312006-10-03 17:40:40 +00002209 if (locktype==SHARED_LOCK) {
2210 pFile->locktype = locktype;
2211 return SQLITE_OK;
2212 }
2213
drh3b62b2f2007-06-08 18:27:03 +00002214 /* no, really, unlock. */
aswift5b1a2562008-08-22 00:22:35 +00002215 if (unlink(zLockFile) ) {
2216 int rc, tErrno = errno;
2217 if( ENOENT != tErrno ){
2218 rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_UNLOCK);
2219 }
2220 if( IS_LOCK_ERROR(rc) ){
2221 pFile->lastErrno = tErrno;
2222 }
2223 return rc;
2224 }
drhbfe66312006-10-03 17:40:40 +00002225 pFile->locktype = NO_LOCK;
2226 return SQLITE_OK;
2227}
2228
2229/*
2230 ** Close a file.
2231 */
danielk1977e339d652008-06-28 11:23:00 +00002232static int dotlockClose(sqlite3_file *id) {
2233 if( id ){
2234 unixFile *pFile = (unixFile*)id;
2235 dotlockUnlock(id, NO_LOCK);
2236 sqlite3_free(pFile->lockingContext);
2237 }
2238 return closeUnixFile(id);
drhbfe66312006-10-03 17:40:40 +00002239}
2240
2241
drhda0e7682008-07-30 15:27:54 +00002242#endif /* SQLITE_ENABLE_LOCKING_STYLE */
drhbfe66312006-10-03 17:40:40 +00002243
2244/*
drh339eb0b2008-03-07 15:34:11 +00002245** The nolockLockingContext is void
2246*/
drhbfe66312006-10-03 17:40:40 +00002247typedef void nolockLockingContext;
2248
danielk1977e339d652008-06-28 11:23:00 +00002249static int nolockCheckReservedLock(sqlite3_file *id, int *pResOut) {
danielk1977861f7452008-06-05 11:39:11 +00002250 *pResOut = 0;
2251 return SQLITE_OK;
drhbfe66312006-10-03 17:40:40 +00002252}
2253
danielk1977e339d652008-06-28 11:23:00 +00002254static int nolockLock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00002255 return SQLITE_OK;
2256}
2257
danielk1977e339d652008-06-28 11:23:00 +00002258static int nolockUnlock(sqlite3_file *id, int locktype) {
drhbfe66312006-10-03 17:40:40 +00002259 return SQLITE_OK;
2260}
2261
2262/*
drh339eb0b2008-03-07 15:34:11 +00002263** Close a file.
2264*/
danielk1977e339d652008-06-28 11:23:00 +00002265static int nolockClose(sqlite3_file *id) {
2266 return closeUnixFile(id);
drhbfe66312006-10-03 17:40:40 +00002267}
2268
danielk1977ad94b582007-08-20 06:44:22 +00002269
danielk1977e3026632004-06-22 11:29:02 +00002270/*
drh9e33c2c2007-08-31 18:34:59 +00002271** Information and control of an open file handle.
drh18839212005-11-26 03:43:23 +00002272*/
drhcc6bb3e2007-08-31 16:11:35 +00002273static int unixFileControl(sqlite3_file *id, int op, void *pArg){
drh9e33c2c2007-08-31 18:34:59 +00002274 switch( op ){
2275 case SQLITE_FCNTL_LOCKSTATE: {
2276 *(int*)pArg = ((unixFile*)id)->locktype;
2277 return SQLITE_OK;
2278 }
2279 }
drhcc6bb3e2007-08-31 16:11:35 +00002280 return SQLITE_ERROR;
drh9cbe6352005-11-29 03:13:21 +00002281}
2282
2283/*
danielk1977a3d4c882007-03-23 10:08:38 +00002284** Return the sector size in bytes of the underlying block device for
2285** the specified file. This is almost always 512 bytes, but may be
2286** larger for some devices.
2287**
2288** SQLite code assumes this function cannot fail. It also assumes that
2289** if two files are created in the same file-system directory (i.e.
drh85b623f2007-12-13 21:54:09 +00002290** a database and its journal file) that the sector size will be the
danielk1977a3d4c882007-03-23 10:08:38 +00002291** same for both.
2292*/
danielk197762079062007-08-15 17:08:46 +00002293static int unixSectorSize(sqlite3_file *id){
drh3ceeb752007-03-29 18:19:52 +00002294 return SQLITE_DEFAULT_SECTOR_SIZE;
danielk1977a3d4c882007-03-23 10:08:38 +00002295}
2296
danielk197790949c22007-08-17 16:50:38 +00002297/*
2298** Return the device characteristics for the file. This is always 0.
2299*/
danielk197762079062007-08-15 17:08:46 +00002300static int unixDeviceCharacteristics(sqlite3_file *id){
2301 return 0;
2302}
2303
danielk1977a3d4c882007-03-23 10:08:38 +00002304/*
danielk1977e339d652008-06-28 11:23:00 +00002305** Initialize the contents of the unixFile structure pointed to by pId.
2306**
danielk1977ad94b582007-08-20 06:44:22 +00002307** When locking extensions are enabled, the filepath and locking style
2308** are needed to determine the unixFile pMethod to use for locking operations.
2309** The locking-style specific lockingContext data structure is created
2310** and assigned here also.
2311*/
2312static int fillInUnixFile(
danielk1977e339d652008-06-28 11:23:00 +00002313 sqlite3_vfs *pVfs, /* Pointer to vfs object */
drhbfe66312006-10-03 17:40:40 +00002314 int h, /* Open file descriptor of file being opened */
danielk1977ad94b582007-08-20 06:44:22 +00002315 int dirfd, /* Directory file descriptor */
drh218c5082008-03-07 00:27:10 +00002316 sqlite3_file *pId, /* Write to the unixFile structure here */
drhda0e7682008-07-30 15:27:54 +00002317 const char *zFilename, /* Name of the file being opened */
2318 int noLock /* Omit locking if true */
drhbfe66312006-10-03 17:40:40 +00002319){
drhda0e7682008-07-30 15:27:54 +00002320 int eLockingStyle;
2321 unixFile *pNew = (unixFile *)pId;
2322 int rc = SQLITE_OK;
2323
danielk1977e339d652008-06-28 11:23:00 +00002324 /* Macro to define the static contents of an sqlite3_io_methods
2325 ** structure for a unix backend file. Different locking methods
2326 ** require different functions for the xClose, xLock, xUnlock and
2327 ** xCheckReservedLock methods.
2328 */
2329 #define IOMETHODS(xClose, xLock, xUnlock, xCheckReservedLock) { \
2330 1, /* iVersion */ \
2331 xClose, /* xClose */ \
2332 unixRead, /* xRead */ \
2333 unixWrite, /* xWrite */ \
2334 unixTruncate, /* xTruncate */ \
2335 unixSync, /* xSync */ \
2336 unixFileSize, /* xFileSize */ \
2337 xLock, /* xLock */ \
2338 xUnlock, /* xUnlock */ \
2339 xCheckReservedLock, /* xCheckReservedLock */ \
2340 unixFileControl, /* xFileControl */ \
2341 unixSectorSize, /* xSectorSize */ \
2342 unixDeviceCharacteristics /* xDeviceCapabilities */ \
2343 }
2344 static sqlite3_io_methods aIoMethod[] = {
2345 IOMETHODS(unixClose, unixLock, unixUnlock, unixCheckReservedLock)
danielk1977e339d652008-06-28 11:23:00 +00002346 ,IOMETHODS(nolockClose, nolockLock, nolockUnlock, nolockCheckReservedLock)
drhda0e7682008-07-30 15:27:54 +00002347#ifdef SQLITE_ENABLE_LOCKING_STYLE
2348 ,IOMETHODS(dotlockClose, dotlockLock, dotlockUnlock,dotlockCheckReservedLock)
2349 ,IOMETHODS(flockClose, flockLock, flockUnlock, flockCheckReservedLock)
danielk1977e339d652008-06-28 11:23:00 +00002350 ,IOMETHODS(afpClose, afpLock, afpUnlock, afpCheckReservedLock)
drh218c5082008-03-07 00:27:10 +00002351#endif
danielk1977e339d652008-06-28 11:23:00 +00002352 };
drhda0e7682008-07-30 15:27:54 +00002353 /* The order of the IOMETHODS macros above is important. It must be the
2354 ** same order as the LOCKING_STYLE numbers
2355 */
2356 assert(LOCKING_STYLE_POSIX==1);
2357 assert(LOCKING_STYLE_NONE==2);
2358 assert(LOCKING_STYLE_DOTFILE==3);
2359 assert(LOCKING_STYLE_FLOCK==4);
2360 assert(LOCKING_STYLE_AFP==5);
drh218c5082008-03-07 00:27:10 +00002361
danielk197717b90b52008-06-06 11:11:25 +00002362 assert( pNew->pLock==NULL );
2363 assert( pNew->pOpen==NULL );
drh218c5082008-03-07 00:27:10 +00002364
2365 OSTRACE3("OPEN %-3d %s\n", h, zFilename);
danielk1977ad94b582007-08-20 06:44:22 +00002366 pNew->h = h;
drh218c5082008-03-07 00:27:10 +00002367 pNew->dirfd = dirfd;
danielk1977ad94b582007-08-20 06:44:22 +00002368 SET_THREADID(pNew);
drh339eb0b2008-03-07 15:34:11 +00002369
drhda0e7682008-07-30 15:27:54 +00002370 if( noLock ){
2371 eLockingStyle = LOCKING_STYLE_NONE;
2372 }else{
2373 eLockingStyle = detectLockingStyle(pVfs, zFilename, h);
2374 }
danielk1977e339d652008-06-28 11:23:00 +00002375
2376 switch( eLockingStyle ){
2377
2378 case LOCKING_STYLE_POSIX: {
2379 enterMutex();
2380 rc = findLockInfo(h, &pNew->pLock, &pNew->pOpen);
2381 leaveMutex();
drh218c5082008-03-07 00:27:10 +00002382 break;
drhbfe66312006-10-03 17:40:40 +00002383 }
danielk1977e339d652008-06-28 11:23:00 +00002384
2385#ifdef SQLITE_ENABLE_LOCKING_STYLE
2386 case LOCKING_STYLE_AFP: {
2387 /* AFP locking uses the file path so it needs to be included in
2388 ** the afpLockingContext.
2389 */
2390 afpLockingContext *pCtx;
2391 pNew->lockingContext = pCtx = sqlite3_malloc( sizeof(*pCtx) );
2392 if( pCtx==0 ){
2393 rc = SQLITE_NOMEM;
2394 }else{
2395 /* NB: zFilename exists and remains valid until the file is closed
2396 ** according to requirement F11141. So we do not need to make a
2397 ** copy of the filename. */
2398 pCtx->filePath = zFilename;
2399 srandomdev();
2400 }
drh218c5082008-03-07 00:27:10 +00002401 break;
danielk1977e339d652008-06-28 11:23:00 +00002402 }
2403
2404 case LOCKING_STYLE_DOTFILE: {
2405 /* Dotfile locking uses the file path so it needs to be included in
2406 ** the dotlockLockingContext
2407 */
2408 char *zLockFile;
drh218c5082008-03-07 00:27:10 +00002409 int nFilename;
danielk1977e339d652008-06-28 11:23:00 +00002410 nFilename = strlen(zFilename) + 6;
2411 zLockFile = (char *)sqlite3_malloc(nFilename);
2412 if( zLockFile==0 ){
2413 rc = SQLITE_NOMEM;
2414 }else{
2415 sqlite3_snprintf(nFilename, zLockFile, "%s.lock", zFilename);
drh339eb0b2008-03-07 15:34:11 +00002416 }
danielk1977e339d652008-06-28 11:23:00 +00002417 pNew->lockingContext = zLockFile;
drh218c5082008-03-07 00:27:10 +00002418 break;
2419 }
danielk1977e339d652008-06-28 11:23:00 +00002420
2421 case LOCKING_STYLE_FLOCK:
2422 case LOCKING_STYLE_NONE:
drh218c5082008-03-07 00:27:10 +00002423 break;
drhe78669b2007-06-29 12:04:26 +00002424#endif
danielk1977e339d652008-06-28 11:23:00 +00002425 }
aswift5b1a2562008-08-22 00:22:35 +00002426
2427 pNew->lastErrno = 0;
danielk1977e339d652008-06-28 11:23:00 +00002428 if( rc!=SQLITE_OK ){
danielk19777c055b92007-10-30 17:28:51 +00002429 if( dirfd>=0 ) close(dirfd);
drhbfe66312006-10-03 17:40:40 +00002430 close(h);
danielk1977e339d652008-06-28 11:23:00 +00002431 }else{
danielk19776cb427f2008-06-30 10:16:04 +00002432 pNew->pMethod = &aIoMethod[eLockingStyle-1];
danielk1977e339d652008-06-28 11:23:00 +00002433 OpenCounter(+1);
drhbfe66312006-10-03 17:40:40 +00002434 }
danielk1977e339d652008-06-28 11:23:00 +00002435 return rc;
drh054889e2005-11-30 03:20:31 +00002436}
drh9c06c952005-11-26 00:25:00 +00002437
danielk1977ad94b582007-08-20 06:44:22 +00002438/*
2439** Open a file descriptor to the directory containing file zFilename.
2440** If successful, *pFd is set to the opened file descriptor and
2441** SQLITE_OK is returned. If an error occurs, either SQLITE_NOMEM
2442** or SQLITE_CANTOPEN is returned and *pFd is set to an undefined
2443** value.
2444**
2445** If SQLITE_OK is returned, the caller is responsible for closing
2446** the file descriptor *pFd using close().
2447*/
danielk1977fee2d252007-08-18 10:59:19 +00002448static int openDirectory(const char *zFilename, int *pFd){
danielk1977fee2d252007-08-18 10:59:19 +00002449 int ii;
drh777b17a2007-09-20 10:02:54 +00002450 int fd = -1;
drhf3a65f72007-08-22 20:18:21 +00002451 char zDirname[MAX_PATHNAME+1];
danielk1977fee2d252007-08-18 10:59:19 +00002452
drh153c62c2007-08-24 03:51:33 +00002453 sqlite3_snprintf(MAX_PATHNAME, zDirname, "%s", zFilename);
danielk1977fee2d252007-08-18 10:59:19 +00002454 for(ii=strlen(zDirname); ii>=0 && zDirname[ii]!='/'; ii--);
2455 if( ii>0 ){
2456 zDirname[ii] = '\0';
2457 fd = open(zDirname, O_RDONLY|O_BINARY, 0);
drh777b17a2007-09-20 10:02:54 +00002458 if( fd>=0 ){
danielk1977fee2d252007-08-18 10:59:19 +00002459#ifdef FD_CLOEXEC
2460 fcntl(fd, F_SETFD, fcntl(fd, F_GETFD, 0) | FD_CLOEXEC);
2461#endif
2462 OSTRACE3("OPENDIR %-3d %s\n", fd, zDirname);
2463 }
2464 }
danielk1977fee2d252007-08-18 10:59:19 +00002465 *pFd = fd;
drh777b17a2007-09-20 10:02:54 +00002466 return (fd>=0?SQLITE_OK:SQLITE_CANTOPEN);
danielk1977fee2d252007-08-18 10:59:19 +00002467}
2468
danielk1977b4b47412007-08-17 15:53:36 +00002469/*
danielk197717b90b52008-06-06 11:11:25 +00002470** Create a temporary file name in zBuf. zBuf must be allocated
2471** by the calling process and must be big enough to hold at least
2472** pVfs->mxPathname bytes.
2473*/
2474static int getTempname(int nBuf, char *zBuf){
2475 static const char *azDirs[] = {
2476 0,
2477 "/var/tmp",
2478 "/usr/tmp",
2479 "/tmp",
2480 ".",
2481 };
2482 static const unsigned char zChars[] =
2483 "abcdefghijklmnopqrstuvwxyz"
2484 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
2485 "0123456789";
2486 int i, j;
2487 struct stat buf;
2488 const char *zDir = ".";
2489
2490 /* It's odd to simulate an io-error here, but really this is just
2491 ** using the io-error infrastructure to test that SQLite handles this
2492 ** function failing.
2493 */
2494 SimulateIOError( return SQLITE_IOERR );
2495
2496 azDirs[0] = sqlite3_temp_directory;
2497 for(i=0; i<sizeof(azDirs)/sizeof(azDirs[0]); i++){
2498 if( azDirs[i]==0 ) continue;
2499 if( stat(azDirs[i], &buf) ) continue;
2500 if( !S_ISDIR(buf.st_mode) ) continue;
2501 if( access(azDirs[i], 07) ) continue;
2502 zDir = azDirs[i];
2503 break;
2504 }
2505
2506 /* Check that the output buffer is large enough for the temporary file
2507 ** name. If it is not, return SQLITE_ERROR.
2508 */
2509 if( (strlen(zDir) + strlen(SQLITE_TEMP_FILE_PREFIX) + 17) >= nBuf ){
2510 return SQLITE_ERROR;
2511 }
2512
2513 do{
2514 sqlite3_snprintf(nBuf-17, zBuf, "%s/"SQLITE_TEMP_FILE_PREFIX, zDir);
2515 j = strlen(zBuf);
2516 sqlite3_randomness(15, &zBuf[j]);
2517 for(i=0; i<15; i++, j++){
2518 zBuf[j] = (char)zChars[ ((unsigned char)zBuf[j])%(sizeof(zChars)-1) ];
2519 }
2520 zBuf[j] = 0;
2521 }while( access(zBuf,0)==0 );
2522 return SQLITE_OK;
2523}
2524
2525
2526/*
danielk1977ad94b582007-08-20 06:44:22 +00002527** Open the file zPath.
2528**
danielk1977b4b47412007-08-17 15:53:36 +00002529** Previously, the SQLite OS layer used three functions in place of this
2530** one:
2531**
2532** sqlite3OsOpenReadWrite();
2533** sqlite3OsOpenReadOnly();
2534** sqlite3OsOpenExclusive();
2535**
2536** These calls correspond to the following combinations of flags:
2537**
2538** ReadWrite() -> (READWRITE | CREATE)
2539** ReadOnly() -> (READONLY)
2540** OpenExclusive() -> (READWRITE | CREATE | EXCLUSIVE)
2541**
2542** The old OpenExclusive() accepted a boolean argument - "delFlag". If
2543** true, the file was configured to be automatically deleted when the
2544** file handle closed. To achieve the same effect using this new
2545** interface, add the DELETEONCLOSE flag to those specified above for
2546** OpenExclusive().
2547*/
2548static int unixOpen(
drh153c62c2007-08-24 03:51:33 +00002549 sqlite3_vfs *pVfs,
danielk1977b4b47412007-08-17 15:53:36 +00002550 const char *zPath,
2551 sqlite3_file *pFile,
2552 int flags,
2553 int *pOutFlags
2554){
danielk1977fee2d252007-08-18 10:59:19 +00002555 int fd = 0; /* File descriptor returned by open() */
2556 int dirfd = -1; /* Directory file descriptor */
2557 int oflags = 0; /* Flags to pass to open() */
2558 int eType = flags&0xFFFFFF00; /* Type of file to open */
drhda0e7682008-07-30 15:27:54 +00002559 int noLock; /* True to omit locking primitives */
danielk1977b4b47412007-08-17 15:53:36 +00002560
2561 int isExclusive = (flags & SQLITE_OPEN_EXCLUSIVE);
2562 int isDelete = (flags & SQLITE_OPEN_DELETEONCLOSE);
2563 int isCreate = (flags & SQLITE_OPEN_CREATE);
2564 int isReadonly = (flags & SQLITE_OPEN_READONLY);
2565 int isReadWrite = (flags & SQLITE_OPEN_READWRITE);
2566
danielk1977fee2d252007-08-18 10:59:19 +00002567 /* If creating a master or main-file journal, this function will open
2568 ** a file-descriptor on the directory too. The first time unixSync()
2569 ** is called the directory file descriptor will be fsync()ed and close()d.
2570 */
2571 int isOpenDirectory = (isCreate &&
2572 (eType==SQLITE_OPEN_MASTER_JOURNAL || eType==SQLITE_OPEN_MAIN_JOURNAL)
2573 );
2574
danielk197717b90b52008-06-06 11:11:25 +00002575 /* If argument zPath is a NULL pointer, this function is required to open
2576 ** a temporary file. Use this buffer to store the file name in.
2577 */
2578 char zTmpname[MAX_PATHNAME+1];
2579 const char *zName = zPath;
2580
danielk1977fee2d252007-08-18 10:59:19 +00002581 /* Check the following statements are true:
2582 **
2583 ** (a) Exactly one of the READWRITE and READONLY flags must be set, and
2584 ** (b) if CREATE is set, then READWRITE must also be set, and
2585 ** (c) if EXCLUSIVE is set, then CREATE must also be set.
drh33f4e022007-09-03 15:19:34 +00002586 ** (d) if DELETEONCLOSE is set, then CREATE must also be set.
danielk1977fee2d252007-08-18 10:59:19 +00002587 */
danielk1977b4b47412007-08-17 15:53:36 +00002588 assert((isReadonly==0 || isReadWrite==0) && (isReadWrite || isReadonly));
danielk1977b4b47412007-08-17 15:53:36 +00002589 assert(isCreate==0 || isReadWrite);
danielk1977b4b47412007-08-17 15:53:36 +00002590 assert(isExclusive==0 || isCreate);
drh33f4e022007-09-03 15:19:34 +00002591 assert(isDelete==0 || isCreate);
2592
drh33f4e022007-09-03 15:19:34 +00002593 /* The main DB, main journal, and master journal are never automatically
2594 ** deleted
2595 */
2596 assert( eType!=SQLITE_OPEN_MAIN_DB || !isDelete );
2597 assert( eType!=SQLITE_OPEN_MAIN_JOURNAL || !isDelete );
2598 assert( eType!=SQLITE_OPEN_MASTER_JOURNAL || !isDelete );
danielk1977b4b47412007-08-17 15:53:36 +00002599
danielk1977fee2d252007-08-18 10:59:19 +00002600 /* Assert that the upper layer has set one of the "file-type" flags. */
2601 assert( eType==SQLITE_OPEN_MAIN_DB || eType==SQLITE_OPEN_TEMP_DB
2602 || eType==SQLITE_OPEN_MAIN_JOURNAL || eType==SQLITE_OPEN_TEMP_JOURNAL
2603 || eType==SQLITE_OPEN_SUBJOURNAL || eType==SQLITE_OPEN_MASTER_JOURNAL
drh33f4e022007-09-03 15:19:34 +00002604 || eType==SQLITE_OPEN_TRANSIENT_DB
danielk1977fee2d252007-08-18 10:59:19 +00002605 );
2606
danielk1977e339d652008-06-28 11:23:00 +00002607 memset(pFile, 0, sizeof(unixFile));
2608
danielk197717b90b52008-06-06 11:11:25 +00002609 if( !zName ){
2610 int rc;
2611 assert(isDelete && !isOpenDirectory);
2612 rc = getTempname(MAX_PATHNAME+1, zTmpname);
2613 if( rc!=SQLITE_OK ){
2614 return rc;
2615 }
2616 zName = zTmpname;
2617 }
2618
danielk1977b4b47412007-08-17 15:53:36 +00002619 if( isReadonly ) oflags |= O_RDONLY;
2620 if( isReadWrite ) oflags |= O_RDWR;
2621 if( isCreate ) oflags |= O_CREAT;
2622 if( isExclusive ) oflags |= (O_EXCL|O_NOFOLLOW);
2623 oflags |= (O_LARGEFILE|O_BINARY);
2624
danielk197717b90b52008-06-06 11:11:25 +00002625 fd = open(zName, oflags, isDelete?0600:SQLITE_DEFAULT_FILE_PERMISSIONS);
danielk19772f2d8c72007-08-30 16:13:33 +00002626 if( fd<0 && errno!=EISDIR && isReadWrite && !isExclusive ){
danielk1977b4b47412007-08-17 15:53:36 +00002627 /* Failed to open the file for read/write access. Try read-only. */
2628 flags &= ~(SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE);
2629 flags |= SQLITE_OPEN_READONLY;
drh153c62c2007-08-24 03:51:33 +00002630 return unixOpen(pVfs, zPath, pFile, flags, pOutFlags);
danielk1977b4b47412007-08-17 15:53:36 +00002631 }
2632 if( fd<0 ){
2633 return SQLITE_CANTOPEN;
2634 }
2635 if( isDelete ){
danielk197717b90b52008-06-06 11:11:25 +00002636 unlink(zName);
danielk1977b4b47412007-08-17 15:53:36 +00002637 }
2638 if( pOutFlags ){
2639 *pOutFlags = flags;
2640 }
2641
2642 assert(fd!=0);
danielk1977fee2d252007-08-18 10:59:19 +00002643 if( isOpenDirectory ){
2644 int rc = openDirectory(zPath, &dirfd);
2645 if( rc!=SQLITE_OK ){
2646 close(fd);
2647 return rc;
2648 }
2649 }
danielk1977e339d652008-06-28 11:23:00 +00002650
2651#ifdef FD_CLOEXEC
2652 fcntl(fd, F_SETFD, fcntl(fd, F_GETFD, 0) | FD_CLOEXEC);
2653#endif
2654
drhda0e7682008-07-30 15:27:54 +00002655 noLock = eType!=SQLITE_OPEN_MAIN_DB;
2656 return fillInUnixFile(pVfs, fd, dirfd, pFile, zPath, noLock);
danielk1977b4b47412007-08-17 15:53:36 +00002657}
2658
2659/*
danielk1977fee2d252007-08-18 10:59:19 +00002660** Delete the file at zPath. If the dirSync argument is true, fsync()
2661** the directory after deleting the file.
danielk1977b4b47412007-08-17 15:53:36 +00002662*/
drh153c62c2007-08-24 03:51:33 +00002663static int unixDelete(sqlite3_vfs *pVfs, const char *zPath, int dirSync){
danielk1977fee2d252007-08-18 10:59:19 +00002664 int rc = SQLITE_OK;
danielk1977b4b47412007-08-17 15:53:36 +00002665 SimulateIOError(return SQLITE_IOERR_DELETE);
2666 unlink(zPath);
danielk1977fee2d252007-08-18 10:59:19 +00002667 if( dirSync ){
2668 int fd;
2669 rc = openDirectory(zPath, &fd);
2670 if( rc==SQLITE_OK ){
2671 if( fsync(fd) ){
2672 rc = SQLITE_IOERR_DIR_FSYNC;
2673 }
2674 close(fd);
2675 }
2676 }
2677 return rc;
danielk1977b4b47412007-08-17 15:53:36 +00002678}
2679
danielk197790949c22007-08-17 16:50:38 +00002680/*
2681** Test the existance of or access permissions of file zPath. The
2682** test performed depends on the value of flags:
2683**
2684** SQLITE_ACCESS_EXISTS: Return 1 if the file exists
2685** SQLITE_ACCESS_READWRITE: Return 1 if the file is read and writable.
2686** SQLITE_ACCESS_READONLY: Return 1 if the file is readable.
2687**
2688** Otherwise return 0.
2689*/
danielk1977861f7452008-06-05 11:39:11 +00002690static int unixAccess(
2691 sqlite3_vfs *pVfs,
2692 const char *zPath,
2693 int flags,
2694 int *pResOut
2695){
rse25c0d1a2007-09-20 08:38:14 +00002696 int amode = 0;
danielk1977861f7452008-06-05 11:39:11 +00002697 SimulateIOError( return SQLITE_IOERR_ACCESS; );
danielk1977b4b47412007-08-17 15:53:36 +00002698 switch( flags ){
2699 case SQLITE_ACCESS_EXISTS:
2700 amode = F_OK;
2701 break;
2702 case SQLITE_ACCESS_READWRITE:
2703 amode = W_OK|R_OK;
2704 break;
drh50d3f902007-08-27 21:10:36 +00002705 case SQLITE_ACCESS_READ:
danielk1977b4b47412007-08-17 15:53:36 +00002706 amode = R_OK;
2707 break;
2708
2709 default:
2710 assert(!"Invalid flags argument");
2711 }
danielk1977861f7452008-06-05 11:39:11 +00002712 *pResOut = (access(zPath, amode)==0);
2713 return SQLITE_OK;
danielk1977b4b47412007-08-17 15:53:36 +00002714}
2715
danielk1977b4b47412007-08-17 15:53:36 +00002716
2717/*
2718** Turn a relative pathname into a full pathname. The relative path
2719** is stored as a nul-terminated string in the buffer pointed to by
2720** zPath.
2721**
2722** zOut points to a buffer of at least sqlite3_vfs.mxPathname bytes
2723** (in this case, MAX_PATHNAME bytes). The full-path is written to
2724** this buffer before returning.
2725*/
danielk1977adfb9b02007-09-17 07:02:56 +00002726static int unixFullPathname(
2727 sqlite3_vfs *pVfs, /* Pointer to vfs object */
2728 const char *zPath, /* Possibly relative input path */
2729 int nOut, /* Size of output buffer in bytes */
2730 char *zOut /* Output buffer */
2731){
danielk1977843e65f2007-09-01 16:16:15 +00002732
2733 /* It's odd to simulate an io-error here, but really this is just
2734 ** using the io-error infrastructure to test that SQLite handles this
2735 ** function failing. This function could fail if, for example, the
2736 ** current working directly has been unlinked.
2737 */
2738 SimulateIOError( return SQLITE_ERROR );
2739
drh153c62c2007-08-24 03:51:33 +00002740 assert( pVfs->mxPathname==MAX_PATHNAME );
drh3c7f2dc2007-12-06 13:26:20 +00002741 zOut[nOut-1] = '\0';
danielk1977b4b47412007-08-17 15:53:36 +00002742 if( zPath[0]=='/' ){
drh3c7f2dc2007-12-06 13:26:20 +00002743 sqlite3_snprintf(nOut, zOut, "%s", zPath);
danielk1977b4b47412007-08-17 15:53:36 +00002744 }else{
2745 int nCwd;
drh3c7f2dc2007-12-06 13:26:20 +00002746 if( getcwd(zOut, nOut-1)==0 ){
drh70c01452007-09-03 17:42:17 +00002747 return SQLITE_CANTOPEN;
danielk1977b4b47412007-08-17 15:53:36 +00002748 }
2749 nCwd = strlen(zOut);
drh3c7f2dc2007-12-06 13:26:20 +00002750 sqlite3_snprintf(nOut-nCwd, &zOut[nCwd], "/%s", zPath);
danielk1977b4b47412007-08-17 15:53:36 +00002751 }
2752 return SQLITE_OK;
2753
2754#if 0
2755 /*
2756 ** Remove "/./" path elements and convert "/A/./" path elements
2757 ** to just "/".
2758 */
2759 if( zFull ){
2760 int i, j;
2761 for(i=j=0; zFull[i]; i++){
2762 if( zFull[i]=='/' ){
2763 if( zFull[i+1]=='/' ) continue;
2764 if( zFull[i+1]=='.' && zFull[i+2]=='/' ){
2765 i += 1;
2766 continue;
2767 }
2768 if( zFull[i+1]=='.' && zFull[i+2]=='.' && zFull[i+3]=='/' ){
2769 while( j>0 && zFull[j-1]!='/' ){ j--; }
2770 i += 3;
2771 continue;
2772 }
2773 }
2774 zFull[j++] = zFull[i];
2775 }
2776 zFull[j] = 0;
2777 }
2778#endif
2779}
2780
drh0ccebe72005-06-07 22:22:50 +00002781
drh761df872006-12-21 01:29:22 +00002782#ifndef SQLITE_OMIT_LOAD_EXTENSION
2783/*
2784** Interfaces for opening a shared library, finding entry points
2785** within the shared library, and closing the shared library.
2786*/
2787#include <dlfcn.h>
drh153c62c2007-08-24 03:51:33 +00002788static void *unixDlOpen(sqlite3_vfs *pVfs, const char *zFilename){
drh761df872006-12-21 01:29:22 +00002789 return dlopen(zFilename, RTLD_NOW | RTLD_GLOBAL);
2790}
danielk197795c8a542007-09-01 06:51:27 +00002791
2792/*
2793** SQLite calls this function immediately after a call to unixDlSym() or
2794** unixDlOpen() fails (returns a null pointer). If a more detailed error
2795** message is available, it is written to zBufOut. If no error message
2796** is available, zBufOut is left unmodified and SQLite uses a default
2797** error message.
2798*/
drh153c62c2007-08-24 03:51:33 +00002799static void unixDlError(sqlite3_vfs *pVfs, int nBuf, char *zBufOut){
danielk1977b4b47412007-08-17 15:53:36 +00002800 char *zErr;
2801 enterMutex();
2802 zErr = dlerror();
2803 if( zErr ){
drh153c62c2007-08-24 03:51:33 +00002804 sqlite3_snprintf(nBuf, zBufOut, "%s", zErr);
danielk1977b4b47412007-08-17 15:53:36 +00002805 }
2806 leaveMutex();
2807}
drh46c99e02007-08-27 23:26:59 +00002808static void *unixDlSym(sqlite3_vfs *pVfs, void *pHandle, const char *zSymbol){
drh761df872006-12-21 01:29:22 +00002809 return dlsym(pHandle, zSymbol);
2810}
drh46c99e02007-08-27 23:26:59 +00002811static void unixDlClose(sqlite3_vfs *pVfs, void *pHandle){
danielk1977b4b47412007-08-17 15:53:36 +00002812 dlclose(pHandle);
drh761df872006-12-21 01:29:22 +00002813}
danielk1977b4b47412007-08-17 15:53:36 +00002814#else /* if SQLITE_OMIT_LOAD_EXTENSION is defined: */
2815 #define unixDlOpen 0
2816 #define unixDlError 0
2817 #define unixDlSym 0
2818 #define unixDlClose 0
2819#endif
2820
2821/*
danielk197790949c22007-08-17 16:50:38 +00002822** Write nBuf bytes of random data to the supplied buffer zBuf.
drhbbd42a62004-05-22 17:41:58 +00002823*/
drh153c62c2007-08-24 03:51:33 +00002824static int unixRandomness(sqlite3_vfs *pVfs, int nBuf, char *zBuf){
danielk197790949c22007-08-17 16:50:38 +00002825
2826 assert(nBuf>=(sizeof(time_t)+sizeof(int)));
2827
drhbbd42a62004-05-22 17:41:58 +00002828 /* We have to initialize zBuf to prevent valgrind from reporting
2829 ** errors. The reports issued by valgrind are incorrect - we would
2830 ** prefer that the randomness be increased by making use of the
2831 ** uninitialized space in zBuf - but valgrind errors tend to worry
2832 ** some users. Rather than argue, it seems easier just to initialize
2833 ** the whole array and silence valgrind, even if that means less randomness
2834 ** in the random seed.
2835 **
2836 ** When testing, initializing zBuf[] to zero is all we do. That means
drhf1a221e2006-01-15 17:27:17 +00002837 ** that we always use the same random number sequence. This makes the
drhbbd42a62004-05-22 17:41:58 +00002838 ** tests repeatable.
2839 */
danielk1977b4b47412007-08-17 15:53:36 +00002840 memset(zBuf, 0, nBuf);
drhbbd42a62004-05-22 17:41:58 +00002841#if !defined(SQLITE_TEST)
2842 {
drh842b8642005-01-21 17:53:17 +00002843 int pid, fd;
2844 fd = open("/dev/urandom", O_RDONLY);
2845 if( fd<0 ){
drh07397232006-01-06 14:46:46 +00002846 time_t t;
2847 time(&t);
danielk197790949c22007-08-17 16:50:38 +00002848 memcpy(zBuf, &t, sizeof(t));
2849 pid = getpid();
2850 memcpy(&zBuf[sizeof(t)], &pid, sizeof(pid));
drh842b8642005-01-21 17:53:17 +00002851 }else{
danielk1977b4b47412007-08-17 15:53:36 +00002852 read(fd, zBuf, nBuf);
drh842b8642005-01-21 17:53:17 +00002853 close(fd);
2854 }
drhbbd42a62004-05-22 17:41:58 +00002855 }
2856#endif
2857 return SQLITE_OK;
2858}
2859
danielk1977b4b47412007-08-17 15:53:36 +00002860
drhbbd42a62004-05-22 17:41:58 +00002861/*
2862** Sleep for a little while. Return the amount of time slept.
danielk1977b4b47412007-08-17 15:53:36 +00002863** The argument is the number of microseconds we want to sleep.
drh4a50aac2007-08-23 02:47:53 +00002864** The return value is the number of microseconds of sleep actually
2865** requested from the underlying operating system, a number which
2866** might be greater than or equal to the argument, but not less
2867** than the argument.
drhbbd42a62004-05-22 17:41:58 +00002868*/
drh153c62c2007-08-24 03:51:33 +00002869static int unixSleep(sqlite3_vfs *pVfs, int microseconds){
drhbbd42a62004-05-22 17:41:58 +00002870#if defined(HAVE_USLEEP) && HAVE_USLEEP
danielk1977b4b47412007-08-17 15:53:36 +00002871 usleep(microseconds);
2872 return microseconds;
drhbbd42a62004-05-22 17:41:58 +00002873#else
danielk1977b4b47412007-08-17 15:53:36 +00002874 int seconds = (microseconds+999999)/1000000;
2875 sleep(seconds);
drh4a50aac2007-08-23 02:47:53 +00002876 return seconds*1000000;
drha3fad6f2006-01-18 14:06:37 +00002877#endif
drh88f474a2006-01-02 20:00:12 +00002878}
2879
2880/*
drhbbd42a62004-05-22 17:41:58 +00002881** The following variable, if set to a non-zero value, becomes the result
drh66560ad2006-01-06 14:32:19 +00002882** returned from sqlite3OsCurrentTime(). This is used for testing.
drhbbd42a62004-05-22 17:41:58 +00002883*/
2884#ifdef SQLITE_TEST
2885int sqlite3_current_time = 0;
2886#endif
2887
2888/*
2889** Find the current time (in Universal Coordinated Time). Write the
2890** current time and date as a Julian Day number into *prNow and
2891** return 0. Return 1 if the time and date cannot be found.
2892*/
drh153c62c2007-08-24 03:51:33 +00002893static int unixCurrentTime(sqlite3_vfs *pVfs, double *prNow){
drh19e2d372005-08-29 23:00:03 +00002894#ifdef NO_GETTOD
drhbbd42a62004-05-22 17:41:58 +00002895 time_t t;
2896 time(&t);
2897 *prNow = t/86400.0 + 2440587.5;
drh19e2d372005-08-29 23:00:03 +00002898#else
2899 struct timeval sNow;
drhbdcc2762007-04-02 18:06:57 +00002900 gettimeofday(&sNow, 0);
drh19e2d372005-08-29 23:00:03 +00002901 *prNow = 2440587.5 + sNow.tv_sec/86400.0 + sNow.tv_usec/86400000000.0;
2902#endif
drhbbd42a62004-05-22 17:41:58 +00002903#ifdef SQLITE_TEST
2904 if( sqlite3_current_time ){
2905 *prNow = sqlite3_current_time/86400.0 + 2440587.5;
2906 }
2907#endif
2908 return 0;
2909}
danielk1977b4b47412007-08-17 15:53:36 +00002910
danielk1977bcb97fe2008-06-06 15:49:29 +00002911static int unixGetLastError(sqlite3_vfs *pVfs, int nBuf, char *zBuf){
2912 return 0;
2913}
2914
drh153c62c2007-08-24 03:51:33 +00002915/*
danielk1977e339d652008-06-28 11:23:00 +00002916** Initialize the operating system interface.
drh153c62c2007-08-24 03:51:33 +00002917*/
danielk1977c0fa4c52008-06-25 17:19:00 +00002918int sqlite3_os_init(void){
danielk1977e339d652008-06-28 11:23:00 +00002919 /* Macro to define the static contents of an sqlite3_vfs structure for
2920 ** the unix backend. The two parameters are the values to use for
2921 ** the sqlite3_vfs.zName and sqlite3_vfs.pAppData fields, respectively.
2922 **
2923 */
2924 #define UNIXVFS(zVfsName, pVfsAppData) { \
2925 1, /* iVersion */ \
2926 sizeof(unixFile), /* szOsFile */ \
2927 MAX_PATHNAME, /* mxPathname */ \
2928 0, /* pNext */ \
2929 zVfsName, /* zName */ \
2930 (void *)pVfsAppData, /* pAppData */ \
2931 unixOpen, /* xOpen */ \
2932 unixDelete, /* xDelete */ \
2933 unixAccess, /* xAccess */ \
2934 unixFullPathname, /* xFullPathname */ \
2935 unixDlOpen, /* xDlOpen */ \
2936 unixDlError, /* xDlError */ \
2937 unixDlSym, /* xDlSym */ \
2938 unixDlClose, /* xDlClose */ \
2939 unixRandomness, /* xRandomness */ \
2940 unixSleep, /* xSleep */ \
2941 unixCurrentTime, /* xCurrentTime */ \
2942 unixGetLastError /* xGetLastError */ \
2943 }
2944
2945 static sqlite3_vfs unixVfs = UNIXVFS("unix", 0);
2946#ifdef SQLITE_ENABLE_LOCKING_STYLE
2947#if 0
2948 int i;
2949 static sqlite3_vfs aVfs[] = {
2950 UNIXVFS("unix-posix", LOCKING_STYLE_POSIX),
2951 UNIXVFS("unix-afp", LOCKING_STYLE_AFP),
2952 UNIXVFS("unix-flock", LOCKING_STYLE_FLOCK),
2953 UNIXVFS("unix-dotfile", LOCKING_STYLE_DOTFILE),
2954 UNIXVFS("unix-none", LOCKING_STYLE_NONE)
drh153c62c2007-08-24 03:51:33 +00002955 };
danielk1977e339d652008-06-28 11:23:00 +00002956 for(i=0; i<(sizeof(aVfs)/sizeof(sqlite3_vfs)); i++){
2957 sqlite3_vfs_register(&aVfs[i], 0);
2958 }
2959#endif
2960#endif
danielk1977c0fa4c52008-06-25 17:19:00 +00002961 sqlite3_vfs_register(&unixVfs, 1);
2962 return SQLITE_OK;
drh153c62c2007-08-24 03:51:33 +00002963}
danielk1977e339d652008-06-28 11:23:00 +00002964
2965/*
2966** Shutdown the operating system interface. This is a no-op for unix.
2967*/
danielk1977c0fa4c52008-06-25 17:19:00 +00002968int sqlite3_os_end(void){
2969 return SQLITE_OK;
2970}
drhdce8bdb2007-08-16 13:01:44 +00002971
danielk197729bafea2008-06-26 10:41:19 +00002972#endif /* SQLITE_OS_UNIX */