1 /* 2 ** 2001 September 16 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 header file (together with is companion C source-code file 14 ** "os.c") attempt to abstract the underlying operating system so that 15 ** the SQLite library will work on both POSIX and windows systems. 16 ** 17 ** This header file is #include-ed by sqliteInt.h and thus ends up 18 ** being included by every source file. 19 */ 20 #ifndef _SQLITE_OS_H_ 21 #define _SQLITE_OS_H_ 22 23 /* 24 ** Figure out if we are dealing with Unix, Windows, or some other 25 ** operating system. After the following block of preprocess macros, 26 ** all of SQLITE_OS_UNIX, SQLITE_OS_WIN, SQLITE_OS_OS2, and SQLITE_OS_OTHER 27 ** will defined to either 1 or 0. One of the four will be 1. The other 28 ** three will be 0. 29 */ 30 #if defined(SQLITE_OS_OTHER) 31 # if SQLITE_OS_OTHER==1 32 # undef SQLITE_OS_UNIX 33 # define SQLITE_OS_UNIX 0 34 # undef SQLITE_OS_WIN 35 # define SQLITE_OS_WIN 0 36 # undef SQLITE_OS_OS2 37 # define SQLITE_OS_OS2 0 38 # else 39 # undef SQLITE_OS_OTHER 40 # endif 41 #endif 42 #if !defined(SQLITE_OS_UNIX) && !defined(SQLITE_OS_OTHER) 43 # define SQLITE_OS_OTHER 0 44 # ifndef SQLITE_OS_WIN 45 # if defined(_WIN32) || defined(WIN32) || defined(__CYGWIN__) || defined(__MINGW32__) || defined(__BORLANDC__) 46 # define SQLITE_OS_WIN 1 47 # define SQLITE_OS_UNIX 0 48 # define SQLITE_OS_OS2 0 49 # elif defined(__EMX__) || defined(_OS2) || defined(OS2) || defined(_OS2_) || defined(__OS2__) 50 # define SQLITE_OS_WIN 0 51 # define SQLITE_OS_UNIX 0 52 # define SQLITE_OS_OS2 1 53 # else 54 # define SQLITE_OS_WIN 0 55 # define SQLITE_OS_UNIX 1 56 # define SQLITE_OS_OS2 0 57 # endif 58 # else 59 # define SQLITE_OS_UNIX 0 60 # define SQLITE_OS_OS2 0 61 # endif 62 #else 63 # ifndef SQLITE_OS_WIN 64 # define SQLITE_OS_WIN 0 65 # endif 66 #endif 67 68 /* 69 ** Define the maximum size of a temporary filename 70 */ 71 #if SQLITE_OS_WIN 72 # include <windows.h> 73 # define SQLITE_TEMPNAME_SIZE (MAX_PATH+50) 74 #elif SQLITE_OS_OS2 75 # if (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ >= 3) && defined(OS2_HIGH_MEMORY) 76 # include <os2safe.h> /* has to be included before os2.h for linking to work */ 77 # endif 78 # define INCL_DOSDATETIME 79 # define INCL_DOSFILEMGR 80 # define INCL_DOSERRORS 81 # define INCL_DOSMISC 82 # define INCL_DOSPROCESS 83 # define INCL_DOSMODULEMGR 84 # define INCL_DOSSEMAPHORES 85 # include <os2.h> 86 # include <uconv.h> 87 # define SQLITE_TEMPNAME_SIZE (CCHMAXPATHCOMP) 88 #else 89 # define SQLITE_TEMPNAME_SIZE 200 90 #endif 91 92 /* 93 ** Determine if we are dealing with Windows NT. 94 ** 95 ** We ought to be able to determine if we are compiling for win98 or winNT 96 ** using the _WIN32_WINNT macro as follows: 97 ** 98 ** #if defined(_WIN32_WINNT) 99 ** # define SQLITE_OS_WINNT 1 100 ** #else 101 ** # define SQLITE_OS_WINNT 0 102 ** #endif 103 ** 104 ** However, vs2005 does not set _WIN32_WINNT by default, as it ought to, 105 ** so the above test does not work. We'll just assume that everything is 106 ** winNT unless the programmer explicitly says otherwise by setting 107 ** SQLITE_OS_WINNT to 0. 108 */ 109 #if SQLITE_OS_WIN && !defined(SQLITE_OS_WINNT) 110 # define SQLITE_OS_WINNT 1 111 #endif 112 113 /* 114 ** Determine if we are dealing with WindowsCE - which has a much 115 ** reduced API. 116 */ 117 #if defined(_WIN32_WCE) 118 # define SQLITE_OS_WINCE 1 119 #else 120 # define SQLITE_OS_WINCE 0 121 #endif 122 123 /* If the SET_FULLSYNC macro is not defined above, then make it 124 ** a no-op 125 */ 126 #ifndef SET_FULLSYNC 127 # define SET_FULLSYNC(x,y) 128 #endif 129 130 /* 131 ** The default size of a disk sector 132 */ 133 #ifndef SQLITE_DEFAULT_SECTOR_SIZE 134 # define SQLITE_DEFAULT_SECTOR_SIZE 4096 135 #endif 136 137 /* 138 ** Temporary files are named starting with this prefix followed by 16 random 139 ** alphanumeric characters, and no file extension. They are stored in the 140 ** OS's standard temporary file directory, and are deleted prior to exit. 141 ** If sqlite is being embedded in another program, you may wish to change the 142 ** prefix to reflect your program's name, so that if your program exits 143 ** prematurely, old temporary files can be easily identified. This can be done 144 ** using -DSQLITE_TEMP_FILE_PREFIX=myprefix_ on the compiler command line. 145 ** 146 ** 2006-10-31: The default prefix used to be "sqlite_". But then 147 ** Mcafee started using SQLite in their anti-virus product and it 148 ** started putting files with the "sqlite" name in the c:/temp folder. 149 ** This annoyed many windows users. Those users would then do a 150 ** Google search for "sqlite", find the telephone numbers of the 151 ** developers and call to wake them up at night and complain. 152 ** For this reason, the default name prefix is changed to be "sqlite" 153 ** spelled backwards. So the temp files are still identified, but 154 ** anybody smart enough to figure out the code is also likely smart 155 ** enough to know that calling the developer will not help get rid 156 ** of the file. 157 */ 158 #ifndef SQLITE_TEMP_FILE_PREFIX 159 # define SQLITE_TEMP_FILE_PREFIX "etilqs_" 160 #endif 161 162 /* 163 ** The following values may be passed as the second argument to 164 ** sqlite3OsLock(). The various locks exhibit the following semantics: 165 ** 166 ** SHARED: Any number of processes may hold a SHARED lock simultaneously. 167 ** RESERVED: A single process may hold a RESERVED lock on a file at 168 ** any time. Other processes may hold and obtain new SHARED locks. 169 ** PENDING: A single process may hold a PENDING lock on a file at 170 ** any one time. Existing SHARED locks may persist, but no new 171 ** SHARED locks may be obtained by other processes. 172 ** EXCLUSIVE: An EXCLUSIVE lock precludes all other locks. 173 ** 174 ** PENDING_LOCK may not be passed directly to sqlite3OsLock(). Instead, a 175 ** process that requests an EXCLUSIVE lock may actually obtain a PENDING 176 ** lock. This can be upgraded to an EXCLUSIVE lock by a subsequent call to 177 ** sqlite3OsLock(). 178 */ 179 #define NO_LOCK 0 180 #define SHARED_LOCK 1 181 #define RESERVED_LOCK 2 182 #define PENDING_LOCK 3 183 #define EXCLUSIVE_LOCK 4 184 185 /* 186 ** File Locking Notes: (Mostly about windows but also some info for Unix) 187 ** 188 ** We cannot use LockFileEx() or UnlockFileEx() on Win95/98/ME because 189 ** those functions are not available. So we use only LockFile() and 190 ** UnlockFile(). 191 ** 192 ** LockFile() prevents not just writing but also reading by other processes. 193 ** A SHARED_LOCK is obtained by locking a single randomly-chosen 194 ** byte out of a specific range of bytes. The lock byte is obtained at 195 ** random so two separate readers can probably access the file at the 196 ** same time, unless they are unlucky and choose the same lock byte. 197 ** An EXCLUSIVE_LOCK is obtained by locking all bytes in the range. 198 ** There can only be one writer. A RESERVED_LOCK is obtained by locking 199 ** a single byte of the file that is designated as the reserved lock byte. 200 ** A PENDING_LOCK is obtained by locking a designated byte different from 201 ** the RESERVED_LOCK byte. 202 ** 203 ** On WinNT/2K/XP systems, LockFileEx() and UnlockFileEx() are available, 204 ** which means we can use reader/writer locks. When reader/writer locks 205 ** are used, the lock is placed on the same range of bytes that is used 206 ** for probabilistic locking in Win95/98/ME. Hence, the locking scheme 207 ** will support two or more Win95 readers or two or more WinNT readers. 208 ** But a single Win95 reader will lock out all WinNT readers and a single 209 ** WinNT reader will lock out all other Win95 readers. 210 ** 211 ** The following #defines specify the range of bytes used for locking. 212 ** SHARED_SIZE is the number of bytes available in the pool from which 213 ** a random byte is selected for a shared lock. The pool of bytes for 214 ** shared locks begins at SHARED_FIRST. 215 ** 216 ** The same locking strategy and 217 ** byte ranges are used for Unix. This leaves open the possiblity of having 218 ** clients on win95, winNT, and unix all talking to the same shared file 219 ** and all locking correctly. To do so would require that samba (or whatever 220 ** tool is being used for file sharing) implements locks correctly between 221 ** windows and unix. I'm guessing that isn't likely to happen, but by 222 ** using the same locking range we are at least open to the possibility. 223 ** 224 ** Locking in windows is manditory. For this reason, we cannot store 225 ** actual data in the bytes used for locking. The pager never allocates 226 ** the pages involved in locking therefore. SHARED_SIZE is selected so 227 ** that all locks will fit on a single page even at the minimum page size. 228 ** PENDING_BYTE defines the beginning of the locks. By default PENDING_BYTE 229 ** is set high so that we don't have to allocate an unused page except 230 ** for very large databases. But one should test the page skipping logic 231 ** by setting PENDING_BYTE low and running the entire regression suite. 232 ** 233 ** Changing the value of PENDING_BYTE results in a subtly incompatible 234 ** file format. Depending on how it is changed, you might not notice 235 ** the incompatibility right away, even running a full regression test. 236 ** The default location of PENDING_BYTE is the first byte past the 237 ** 1GB boundary. 238 ** 239 */ 240 #ifdef SQLITE_OMIT_WSD 241 # define PENDING_BYTE (0x40000000) 242 #else 243 # define PENDING_BYTE sqlite3PendingByte 244 #endif 245 #define RESERVED_BYTE (PENDING_BYTE+1) 246 #define SHARED_FIRST (PENDING_BYTE+2) 247 #define SHARED_SIZE 510 248 249 /* 250 ** Wrapper around OS specific sqlite3_os_init() function. 251 */ 252 int sqlite3OsInit(void); 253 254 /* 255 ** Functions for accessing sqlite3_file methods 256 */ 257 int sqlite3OsClose(sqlite3_file*); 258 int sqlite3OsRead(sqlite3_file*, void*, int amt, i64 offset); 259 int sqlite3OsWrite(sqlite3_file*, const void*, int amt, i64 offset); 260 int sqlite3OsTruncate(sqlite3_file*, i64 size); 261 int sqlite3OsSync(sqlite3_file*, int); 262 int sqlite3OsFileSize(sqlite3_file*, i64 *pSize); 263 int sqlite3OsLock(sqlite3_file*, int); 264 int sqlite3OsUnlock(sqlite3_file*, int); 265 int sqlite3OsCheckReservedLock(sqlite3_file *id, int *pResOut); 266 int sqlite3OsFileControl(sqlite3_file*,int,void*); 267 void sqlite3OsFileControlHint(sqlite3_file*,int,void*); 268 #define SQLITE_FCNTL_DB_UNCHANGED 0xca093fa0 269 int sqlite3OsSectorSize(sqlite3_file *id); 270 int sqlite3OsDeviceCharacteristics(sqlite3_file *id); 271 int sqlite3OsShmMap(sqlite3_file *,int,int,int,void volatile **); 272 int sqlite3OsShmLock(sqlite3_file *id, int, int, int); 273 void sqlite3OsShmBarrier(sqlite3_file *id); 274 int sqlite3OsShmUnmap(sqlite3_file *id, int); 275 276 277 /* 278 ** Functions for accessing sqlite3_vfs methods 279 */ 280 int sqlite3OsOpen(sqlite3_vfs *, const char *, sqlite3_file*, int, int *); 281 int sqlite3OsDelete(sqlite3_vfs *, const char *, int); 282 int sqlite3OsAccess(sqlite3_vfs *, const char *, int, int *pResOut); 283 int sqlite3OsFullPathname(sqlite3_vfs *, const char *, int, char *); 284 #ifndef SQLITE_OMIT_LOAD_EXTENSION 285 void *sqlite3OsDlOpen(sqlite3_vfs *, const char *); 286 void sqlite3OsDlError(sqlite3_vfs *, int, char *); 287 void (*sqlite3OsDlSym(sqlite3_vfs *, void *, const char *))(void); 288 void sqlite3OsDlClose(sqlite3_vfs *, void *); 289 #endif /* SQLITE_OMIT_LOAD_EXTENSION */ 290 int sqlite3OsRandomness(sqlite3_vfs *, int, char *); 291 int sqlite3OsSleep(sqlite3_vfs *, int); 292 int sqlite3OsCurrentTimeInt64(sqlite3_vfs *, sqlite3_int64*); 293 294 /* 295 ** Convenience functions for opening and closing files using 296 ** sqlite3_malloc() to obtain space for the file-handle structure. 297 */ 298 int sqlite3OsOpenMalloc(sqlite3_vfs *, const char *, sqlite3_file **, int,int*); 299 int sqlite3OsCloseFree(sqlite3_file *); 300 301 #endif /* _SQLITE_OS_H_ */ 302