1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sql/SQLite/os.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,275 @@
1.4 +/*
1.5 +** 2001 September 16
1.6 +**
1.7 +** The author disclaims copyright to this source code. In place of
1.8 +** a legal notice, here is a blessing:
1.9 +**
1.10 +** May you do good and not evil.
1.11 +** May you find forgiveness for yourself and forgive others.
1.12 +** May you share freely, never taking more than you give.
1.13 +**
1.14 +******************************************************************************
1.15 +**
1.16 +** This header file (together with is companion C source-code file
1.17 +** "os.c") attempt to abstract the underlying operating system so that
1.18 +** the SQLite library will work on both POSIX and windows systems.
1.19 +**
1.20 +** This header file is #include-ed by sqliteInt.h and thus ends up
1.21 +** being included by every source file.
1.22 +**
1.23 +** $Id: os.h,v 1.105 2008/06/26 10:41:19 danielk1977 Exp $
1.24 +*/
1.25 +#ifndef _SQLITE_OS_H_
1.26 +#define _SQLITE_OS_H_
1.27 +
1.28 +/*
1.29 +** Figure out if we are dealing with Unix, Windows, or some other
1.30 +** operating system. After the following block of preprocess macros,
1.31 +** all of SQLITE_OS_UNIX, SQLITE_OS_WIN, SQLITE_OS_OS2, and SQLITE_OS_OTHER
1.32 +** will defined to either 1 or 0. One of the four will be 1. The other
1.33 +** three will be 0.
1.34 +*/
1.35 +#if defined(SQLITE_OS_OTHER)
1.36 +# if SQLITE_OS_OTHER==1
1.37 +# undef SQLITE_OS_UNIX
1.38 +# define SQLITE_OS_UNIX 0
1.39 +# undef SQLITE_OS_WIN
1.40 +# define SQLITE_OS_WIN 0
1.41 +# undef SQLITE_OS_OS2
1.42 +# define SQLITE_OS_OS2 0
1.43 +# else
1.44 +# undef SQLITE_OS_OTHER
1.45 +# endif
1.46 +#endif
1.47 +#if !defined(SQLITE_OS_UNIX) && !defined(SQLITE_OS_OTHER)
1.48 +# define SQLITE_OS_OTHER 0
1.49 +# ifndef SQLITE_OS_WIN
1.50 +# if defined(_WIN32) || defined(WIN32) || defined(__CYGWIN__) || defined(__MINGW32__) || defined(__BORLANDC__)
1.51 +# define SQLITE_OS_WIN 1
1.52 +# define SQLITE_OS_UNIX 0
1.53 +# define SQLITE_OS_OS2 0
1.54 +# elif defined(__EMX__) || defined(_OS2) || defined(OS2) || defined(_OS2_) || defined(__OS2__)
1.55 +# define SQLITE_OS_WIN 0
1.56 +# define SQLITE_OS_UNIX 0
1.57 +# define SQLITE_OS_OS2 1
1.58 +# else
1.59 +# define SQLITE_OS_WIN 0
1.60 +# define SQLITE_OS_UNIX 1
1.61 +# define SQLITE_OS_OS2 0
1.62 +# endif
1.63 +# else
1.64 +# define SQLITE_OS_UNIX 0
1.65 +# define SQLITE_OS_OS2 0
1.66 +# endif
1.67 +#else
1.68 +# ifndef SQLITE_OS_WIN
1.69 +# define SQLITE_OS_WIN 0
1.70 +# endif
1.71 +#endif
1.72 +
1.73 +/*
1.74 +** Determine if we are dealing with WindowsCE - which has a much
1.75 +** reduced API.
1.76 +*/
1.77 +#if defined(_WIN32_WCE)
1.78 +# define SQLITE_OS_WINCE 1
1.79 +#else
1.80 +# define SQLITE_OS_WINCE 0
1.81 +#endif
1.82 +
1.83 +
1.84 +/*
1.85 +** Define the maximum size of a temporary filename
1.86 +*/
1.87 +#if SQLITE_OS_WIN
1.88 +# include <windows.h>
1.89 +# define SQLITE_TEMPNAME_SIZE (MAX_PATH+50)
1.90 +#elif SQLITE_OS_OS2
1.91 +# if (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ >= 3) && defined(OS2_HIGH_MEMORY)
1.92 +# include <os2safe.h> /* has to be included before os2.h for linking to work */
1.93 +# endif
1.94 +# define INCL_DOSDATETIME
1.95 +# define INCL_DOSFILEMGR
1.96 +# define INCL_DOSERRORS
1.97 +# define INCL_DOSMISC
1.98 +# define INCL_DOSPROCESS
1.99 +# define INCL_DOSMODULEMGR
1.100 +# define INCL_DOSSEMAPHORES
1.101 +# include <os2.h>
1.102 +# include <uconv.h>
1.103 +# define SQLITE_TEMPNAME_SIZE (CCHMAXPATHCOMP)
1.104 +#else
1.105 +# define SQLITE_TEMPNAME_SIZE 200
1.106 +#endif
1.107 +
1.108 +/* If the SET_FULLSYNC macro is not defined above, then make it
1.109 +** a no-op
1.110 +*/
1.111 +#ifndef SET_FULLSYNC
1.112 +# define SET_FULLSYNC(x,y)
1.113 +#endif
1.114 +
1.115 +/*
1.116 +** The default size of a disk sector
1.117 +*/
1.118 +#ifndef SQLITE_DEFAULT_SECTOR_SIZE
1.119 +# define SQLITE_DEFAULT_SECTOR_SIZE 512
1.120 +#endif
1.121 +
1.122 +/*
1.123 +** Temporary files are named starting with this prefix followed by 16 random
1.124 +** alphanumeric characters, and no file extension. They are stored in the
1.125 +** OS's standard temporary file directory, and are deleted prior to exit.
1.126 +** If sqlite is being embedded in another program, you may wish to change the
1.127 +** prefix to reflect your program's name, so that if your program exits
1.128 +** prematurely, old temporary files can be easily identified. This can be done
1.129 +** using -DSQLITE_TEMP_FILE_PREFIX=myprefix_ on the compiler command line.
1.130 +**
1.131 +** 2006-10-31: The default prefix used to be "sqlite_". But then
1.132 +** Mcafee started using SQLite in their anti-virus product and it
1.133 +** started putting files with the "sqlite" name in the c:/temp folder.
1.134 +** This annoyed many windows users. Those users would then do a
1.135 +** Google search for "sqlite", find the telephone numbers of the
1.136 +** developers and call to wake them up at night and complain.
1.137 +** For this reason, the default name prefix is changed to be "sqlite"
1.138 +** spelled backwards. So the temp files are still identified, but
1.139 +** anybody smart enough to figure out the code is also likely smart
1.140 +** enough to know that calling the developer will not help get rid
1.141 +** of the file.
1.142 +*/
1.143 +#ifndef SQLITE_TEMP_FILE_PREFIX
1.144 +# define SQLITE_TEMP_FILE_PREFIX "etilqs_"
1.145 +#endif
1.146 +
1.147 +/*
1.148 +** The following values may be passed as the second argument to
1.149 +** sqlite3OsLock(). The various locks exhibit the following semantics:
1.150 +**
1.151 +** SHARED: Any number of processes may hold a SHARED lock simultaneously.
1.152 +** RESERVED: A single process may hold a RESERVED lock on a file at
1.153 +** any time. Other processes may hold and obtain new SHARED locks.
1.154 +** PENDING: A single process may hold a PENDING lock on a file at
1.155 +** any one time. Existing SHARED locks may persist, but no new
1.156 +** SHARED locks may be obtained by other processes.
1.157 +** EXCLUSIVE: An EXCLUSIVE lock precludes all other locks.
1.158 +**
1.159 +** PENDING_LOCK may not be passed directly to sqlite3OsLock(). Instead, a
1.160 +** process that requests an EXCLUSIVE lock may actually obtain a PENDING
1.161 +** lock. This can be upgraded to an EXCLUSIVE lock by a subsequent call to
1.162 +** sqlite3OsLock().
1.163 +*/
1.164 +#define NO_LOCK 0
1.165 +#define SHARED_LOCK 1
1.166 +#define RESERVED_LOCK 2
1.167 +#define PENDING_LOCK 3
1.168 +#define EXCLUSIVE_LOCK 4
1.169 +
1.170 +/*
1.171 +** File Locking Notes: (Mostly about windows but also some info for Unix)
1.172 +**
1.173 +** We cannot use LockFileEx() or UnlockFileEx() on Win95/98/ME because
1.174 +** those functions are not available. So we use only LockFile() and
1.175 +** UnlockFile().
1.176 +**
1.177 +** LockFile() prevents not just writing but also reading by other processes.
1.178 +** A SHARED_LOCK is obtained by locking a single randomly-chosen
1.179 +** byte out of a specific range of bytes. The lock byte is obtained at
1.180 +** random so two separate readers can probably access the file at the
1.181 +** same time, unless they are unlucky and choose the same lock byte.
1.182 +** An EXCLUSIVE_LOCK is obtained by locking all bytes in the range.
1.183 +** There can only be one writer. A RESERVED_LOCK is obtained by locking
1.184 +** a single byte of the file that is designated as the reserved lock byte.
1.185 +** A PENDING_LOCK is obtained by locking a designated byte different from
1.186 +** the RESERVED_LOCK byte.
1.187 +**
1.188 +** On WinNT/2K/XP systems, LockFileEx() and UnlockFileEx() are available,
1.189 +** which means we can use reader/writer locks. When reader/writer locks
1.190 +** are used, the lock is placed on the same range of bytes that is used
1.191 +** for probabilistic locking in Win95/98/ME. Hence, the locking scheme
1.192 +** will support two or more Win95 readers or two or more WinNT readers.
1.193 +** But a single Win95 reader will lock out all WinNT readers and a single
1.194 +** WinNT reader will lock out all other Win95 readers.
1.195 +**
1.196 +** The following #defines specify the range of bytes used for locking.
1.197 +** SHARED_SIZE is the number of bytes available in the pool from which
1.198 +** a random byte is selected for a shared lock. The pool of bytes for
1.199 +** shared locks begins at SHARED_FIRST.
1.200 +**
1.201 +** These #defines are available in sqlite_aux.h so that adaptors for
1.202 +** connecting SQLite to other operating systems can use the same byte
1.203 +** ranges for locking. In particular, the same locking strategy and
1.204 +** byte ranges are used for Unix. This leaves open the possiblity of having
1.205 +** clients on win95, winNT, and unix all talking to the same shared file
1.206 +** and all locking correctly. To do so would require that samba (or whatever
1.207 +** tool is being used for file sharing) implements locks correctly between
1.208 +** windows and unix. I'm guessing that isn't likely to happen, but by
1.209 +** using the same locking range we are at least open to the possibility.
1.210 +**
1.211 +** Locking in windows is manditory. For this reason, we cannot store
1.212 +** actual data in the bytes used for locking. The pager never allocates
1.213 +** the pages involved in locking therefore. SHARED_SIZE is selected so
1.214 +** that all locks will fit on a single page even at the minimum page size.
1.215 +** PENDING_BYTE defines the beginning of the locks. By default PENDING_BYTE
1.216 +** is set high so that we don't have to allocate an unused page except
1.217 +** for very large databases. But one should test the page skipping logic
1.218 +** by setting PENDING_BYTE low and running the entire regression suite.
1.219 +**
1.220 +** Changing the value of PENDING_BYTE results in a subtly incompatible
1.221 +** file format. Depending on how it is changed, you might not notice
1.222 +** the incompatibility right away, even running a full regression test.
1.223 +** The default location of PENDING_BYTE is the first byte past the
1.224 +** 1GB boundary.
1.225 +**
1.226 +*/
1.227 +#ifndef SQLITE_TEST
1.228 +#define PENDING_BYTE 0x40000000 /* First byte past the 1GB boundary */
1.229 +#else
1.230 +extern unsigned int sqlite3_pending_byte;
1.231 +#define PENDING_BYTE sqlite3_pending_byte
1.232 +#endif
1.233 +
1.234 +#define RESERVED_BYTE (PENDING_BYTE+1)
1.235 +#define SHARED_FIRST (PENDING_BYTE+2)
1.236 +#define SHARED_SIZE 510
1.237 +
1.238 +/*
1.239 +** Functions for accessing sqlite3_file methods
1.240 +*/
1.241 +int sqlite3OsClose(sqlite3_file*);
1.242 +int sqlite3OsRead(sqlite3_file*, void*, int amt, i64 offset);
1.243 +int sqlite3OsWrite(sqlite3_file*, const void*, int amt, i64 offset);
1.244 +int sqlite3OsTruncate(sqlite3_file*, i64 size);
1.245 +int sqlite3OsSync(sqlite3_file*, int);
1.246 +int sqlite3OsFileSize(sqlite3_file*, i64 *pSize);
1.247 +int sqlite3OsLock(sqlite3_file*, int);
1.248 +int sqlite3OsUnlock(sqlite3_file*, int);
1.249 +int sqlite3OsCheckReservedLock(sqlite3_file *id, int *pResOut);
1.250 +int sqlite3OsFileControl(sqlite3_file*,int,void*);
1.251 +int sqlite3OsSectorSize(sqlite3_file *id);
1.252 +int sqlite3OsDeviceCharacteristics(sqlite3_file *id);
1.253 +
1.254 +/*
1.255 +** Functions for accessing sqlite3_vfs methods
1.256 +*/
1.257 +int sqlite3OsOpen(sqlite3_vfs *, const char *, sqlite3_file*, int, int *);
1.258 +int sqlite3OsDelete(sqlite3_vfs *, const char *, int);
1.259 +int sqlite3OsAccess(sqlite3_vfs *, const char *, int, int *pResOut);
1.260 +int sqlite3OsFullPathname(sqlite3_vfs *, const char *, int, char *);
1.261 +#ifndef SQLITE_OMIT_LOAD_EXTENSION
1.262 +void *sqlite3OsDlOpen(sqlite3_vfs *, const char *);
1.263 +void sqlite3OsDlError(sqlite3_vfs *, int, char *);
1.264 +void *sqlite3OsDlSym(sqlite3_vfs *, void *, const char *);
1.265 +void sqlite3OsDlClose(sqlite3_vfs *, void *);
1.266 +#endif /* SQLITE_OMIT_LOAD_EXTENSION */
1.267 +int sqlite3OsRandomness(sqlite3_vfs *, int, char *);
1.268 +int sqlite3OsSleep(sqlite3_vfs *, int);
1.269 +int sqlite3OsCurrentTime(sqlite3_vfs *, double*);
1.270 +
1.271 +/*
1.272 +** Convenience functions for opening and closing files using
1.273 +** sqlite3_malloc() to obtain space for the file-handle structure.
1.274 +*/
1.275 +int sqlite3OsOpenMalloc(sqlite3_vfs *, const char *, sqlite3_file **, int,int*);
1.276 +int sqlite3OsCloseFree(sqlite3_file *);
1.277 +
1.278 +#endif /* _SQLITE_OS_H_ */