os.h
上传用户:sunhongbo
上传日期:2022-01-25
资源大小:3010k
文件大小:11k
源码类别:

数据库系统

开发平台:

C/C++

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