/ Hex Artifact Content
Login

Artifact 4a361fccfbc4e7609b3e1557f604f94c1e96ad10:


0000: 2f 2a 0a 2a 2a 20 32 30 30 31 20 53 65 70 74 65  /*.** 2001 Septe
0010: 6d 62 65 72 20 31 36 0a 2a 2a 0a 2a 2a 20 54 68  mber 16.**.** Th
0020: 65 20 61 75 74 68 6f 72 20 64 69 73 63 6c 61 69  e author disclai
0030: 6d 73 20 63 6f 70 79 72 69 67 68 74 20 74 6f 20  ms copyright to 
0040: 74 68 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65  this source code
0050: 2e 20 20 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a  .  In place of.*
0060: 2a 20 61 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65  * a legal notice
0070: 2c 20 68 65 72 65 20 69 73 20 61 20 62 6c 65 73  , here is a bles
0080: 73 69 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d  sing:.**.**    M
0090: 61 79 20 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61  ay you do good a
00a0: 6e 64 20 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20  nd not evil..** 
00b0: 20 20 20 4d 61 79 20 79 6f 75 20 66 69 6e 64 20     May you find 
00c0: 66 6f 72 67 69 76 65 6e 65 73 73 20 66 6f 72 20  forgiveness for 
00d0: 79 6f 75 72 73 65 6c 66 20 61 6e 64 20 66 6f 72  yourself and for
00e0: 67 69 76 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20  give others..** 
00f0: 20 20 20 4d 61 79 20 79 6f 75 20 73 68 61 72 65     May you share
0100: 20 66 72 65 65 6c 79 2c 20 6e 65 76 65 72 20 74   freely, never t
0110: 61 6b 69 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20  aking more than 
0120: 79 6f 75 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a  you give..**.***
0130: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0140: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0150: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0160: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0170: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 0a 2a 2a 0a 2a  ***********.**.*
0180: 2a 20 54 68 69 73 20 68 65 61 64 65 72 20 66 69  * This header fi
0190: 6c 65 20 28 74 6f 67 65 74 68 65 72 20 77 69 74  le (together wit
01a0: 68 20 69 73 20 63 6f 6d 70 61 6e 69 6f 6e 20 43  h is companion C
01b0: 20 73 6f 75 72 63 65 2d 63 6f 64 65 20 66 69 6c   source-code fil
01c0: 65 0a 2a 2a 20 22 6f 73 2e 63 22 29 20 61 74 74  e.** "os.c") att
01d0: 65 6d 70 74 20 74 6f 20 61 62 73 74 72 61 63 74  empt to abstract
01e0: 20 74 68 65 20 75 6e 64 65 72 6c 79 69 6e 67 20   the underlying 
01f0: 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74 65 6d  operating system
0200: 20 73 6f 20 74 68 61 74 0a 2a 2a 20 74 68 65 20   so that.** the 
0210: 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 20 77  SQLite library w
0220: 69 6c 6c 20 77 6f 72 6b 20 6f 6e 20 62 6f 74 68  ill work on both
0230: 20 50 4f 53 49 58 20 61 6e 64 20 77 69 6e 64 6f   POSIX and windo
0240: 77 73 20 73 79 73 74 65 6d 73 2e 0a 2a 2f 0a 23  ws systems..*/.#
0250: 69 66 6e 64 65 66 20 5f 53 51 4c 49 54 45 5f 4f  ifndef _SQLITE_O
0260: 53 5f 48 5f 0a 23 64 65 66 69 6e 65 20 5f 53 51  S_H_.#define _SQ
0270: 4c 49 54 45 5f 4f 53 5f 48 5f 0a 0a 23 69 66 6e  LITE_OS_H_..#ifn
0280: 64 65 66 20 4f 53 5f 55 4e 49 58 0a 23 20 69 66  def OS_UNIX.# if
0290: 6e 64 65 66 20 4f 53 5f 57 49 4e 0a 23 20 20 69  ndef OS_WIN.#  i
02a0: 66 20 64 65 66 69 6e 65 64 28 5f 57 49 4e 33 32  f defined(_WIN32
02b0: 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 57 49 4e  ) || defined(WIN
02c0: 33 32 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 5f  32) || defined(_
02d0: 5f 43 59 47 57 49 4e 5f 5f 29 20 7c 7c 20 64 65  _CYGWIN__) || de
02e0: 66 69 6e 65 64 28 5f 5f 4d 49 4e 47 57 33 32 5f  fined(__MINGW32_
02f0: 5f 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 5f 5f  _) || defined(__
0300: 42 4f 52 4c 41 4e 44 43 5f 5f 29 0a 23 20 20 20  BORLANDC__).#   
0310: 20 64 65 66 69 6e 65 20 4f 53 5f 57 49 4e 20 31   define OS_WIN 1
0320: 0a 23 20 20 20 20 64 65 66 69 6e 65 20 4f 53 5f  .#    define OS_
0330: 55 4e 49 58 20 30 0a 23 20 20 65 6c 73 65 0a 23  UNIX 0.#  else.#
0340: 20 20 20 20 64 65 66 69 6e 65 20 4f 53 5f 57 49      define OS_WI
0350: 4e 20 30 0a 23 20 20 20 20 64 65 66 69 6e 65 20  N 0.#    define 
0360: 4f 53 5f 55 4e 49 58 20 31 0a 23 20 20 65 6e 64  OS_UNIX 1.#  end
0370: 69 66 0a 23 20 65 6c 73 65 0a 23 20 20 64 65 66  if.# else.#  def
0380: 69 6e 65 20 4f 53 5f 55 4e 49 58 20 30 0a 23 20  ine OS_UNIX 0.# 
0390: 65 6e 64 69 66 0a 23 65 6e 64 69 66 0a 23 69 66  endif.#endif.#if
03a0: 6e 64 65 66 20 4f 53 5f 57 49 4e 0a 23 20 64 65  ndef OS_WIN.# de
03b0: 66 69 6e 65 20 4f 53 5f 57 49 4e 20 30 0a 23 65  fine OS_WIN 0.#e
03c0: 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 41 20 68 61  ndif../*.** A ha
03d0: 6e 64 6c 65 20 66 6f 72 20 61 6e 20 6f 70 65 6e  ndle for an open
03e0: 20 66 69 6c 65 20 69 73 20 73 74 6f 72 65 64 20   file is stored 
03f0: 69 6e 20 61 6e 20 4f 73 46 69 6c 65 20 6f 62 6a  in an OsFile obj
0400: 65 63 74 2e 0a 2a 2f 0a 23 69 66 20 4f 53 5f 55  ect..*/.#if OS_U
0410: 4e 49 58 0a 20 20 74 79 70 65 64 65 66 20 73 74  NIX.  typedef st
0420: 72 75 63 74 20 4f 73 46 69 6c 65 20 4f 73 46 69  ruct OsFile OsFi
0430: 6c 65 3b 0a 20 20 73 74 72 75 63 74 20 4f 73 46  le;.  struct OsF
0440: 69 6c 65 20 7b 0a 20 20 20 20 73 74 72 75 63 74  ile {.    struct
0450: 20 6c 6f 63 6b 49 6e 66 6f 20 2a 70 4c 6f 63 6b   lockInfo *pLock
0460: 3b 20 20 2f 2a 20 49 6e 66 6f 72 6d 61 74 69 6f  ;  /* Informatio
0470: 6e 20 61 62 6f 75 74 20 6c 6f 63 6b 73 20 6f 6e  n about locks on
0480: 20 74 68 69 73 20 69 6e 6f 64 65 20 2a 2f 0a 20   this inode */. 
0490: 20 20 20 69 6e 74 20 66 64 3b 20 20 20 20 20 20     int fd;      
04a0: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 54              /* T
04b0: 68 65 20 66 69 6c 65 20 64 65 73 63 72 69 70 74  he file descript
04c0: 6f 72 20 2a 2f 0a 20 20 20 20 69 6e 74 20 6c 6f  or */.    int lo
04d0: 63 6b 65 64 3b 20 20 20 20 20 20 20 20 20 20 20  cked;           
04e0: 20 20 20 2f 2a 20 54 72 75 65 20 69 66 20 74 68     /* True if th
04f0: 69 73 20 75 73 65 72 20 68 6f 6c 64 73 20 74 68  is user holds th
0500: 65 20 6c 6f 63 6b 20 2a 2f 0a 20 20 7d 3b 0a 23  e lock */.  };.#
0510: 20 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 54   define SQLITE_T
0520: 45 4d 50 4e 41 4d 45 5f 53 49 5a 45 20 32 30 30  EMPNAME_SIZE 200
0530: 0a 23 20 69 66 20 64 65 66 69 6e 65 64 28 48 41  .# if defined(HA
0540: 56 45 5f 55 53 4c 45 45 50 29 20 26 26 20 48 41  VE_USLEEP) && HA
0550: 56 45 5f 55 53 4c 45 45 50 0a 23 20 20 64 65 66  VE_USLEEP.#  def
0560: 69 6e 65 20 53 51 4c 49 54 45 5f 4d 49 4e 5f 53  ine SQLITE_MIN_S
0570: 4c 45 45 50 5f 4d 53 20 31 0a 23 20 65 6c 73 65  LEEP_MS 1.# else
0580: 0a 23 20 20 64 65 66 69 6e 65 20 53 51 4c 49 54  .#  define SQLIT
0590: 45 5f 4d 49 4e 5f 53 4c 45 45 50 5f 4d 53 20 31  E_MIN_SLEEP_MS 1
05a0: 30 30 30 0a 23 20 65 6e 64 69 66 0a 23 65 6e 64  000.# endif.#end
05b0: 69 66 0a 0a 23 69 66 20 4f 53 5f 57 49 4e 0a 23  if..#if OS_WIN.#
05c0: 69 6e 63 6c 75 64 65 20 3c 77 69 6e 64 6f 77 73  include <windows
05d0: 2e 68 3e 0a 23 69 6e 63 6c 75 64 65 20 3c 77 69  .h>.#include <wi
05e0: 6e 62 61 73 65 2e 68 3e 0a 20 20 74 79 70 65 64  nbase.h>.  typed
05f0: 65 66 20 73 74 72 75 63 74 20 4f 73 46 69 6c 65  ef struct OsFile
0600: 20 4f 73 46 69 6c 65 3b 0a 20 20 73 74 72 75 63   OsFile;.  struc
0610: 74 20 4f 73 46 69 6c 65 20 7b 0a 20 20 20 20 48  t OsFile {.    H
0620: 41 4e 44 4c 45 20 68 3b 0a 20 20 20 20 69 6e 74  ANDLE h;.    int
0630: 20 6c 6f 63 6b 65 64 3b 0a 20 20 7d 3b 0a 23 20   locked;.  };.# 
0640: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 54 45  define SQLITE_TE
0650: 4d 50 4e 41 4d 45 5f 53 49 5a 45 20 28 4d 41 58  MPNAME_SIZE (MAX
0660: 5f 50 41 54 48 2b 35 30 29 0a 23 20 64 65 66 69  _PATH+50).# defi
0670: 6e 65 20 53 51 4c 49 54 45 5f 4d 49 4e 5f 53 4c  ne SQLITE_MIN_SL
0680: 45 45 50 5f 4d 53 20 31 0a 23 65 6e 64 69 66 0a  EEP_MS 1.#endif.
0690: 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73 44 65 6c  .int sqliteOsDel
06a0: 65 74 65 28 63 6f 6e 73 74 20 63 68 61 72 2a 29  ete(const char*)
06b0: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73 46 69  ;.int sqliteOsFi
06c0: 6c 65 45 78 69 73 74 73 28 63 6f 6e 73 74 20 63  leExists(const c
06d0: 68 61 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  har*);.int sqlit
06e0: 65 4f 73 4f 70 65 6e 52 65 61 64 57 72 69 74 65  eOsOpenReadWrite
06f0: 28 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 4f 73  (const char*, Os
0700: 46 69 6c 65 2a 2c 20 69 6e 74 2a 29 3b 0a 69 6e  File*, int*);.in
0710: 74 20 73 71 6c 69 74 65 4f 73 4f 70 65 6e 45 78  t sqliteOsOpenEx
0720: 63 6c 75 73 69 76 65 28 63 6f 6e 73 74 20 63 68  clusive(const ch
0730: 61 72 2a 2c 20 4f 73 46 69 6c 65 2a 2c 20 69 6e  ar*, OsFile*, in
0740: 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73  t);.int sqliteOs
0750: 4f 70 65 6e 52 65 61 64 4f 6e 6c 79 28 63 6f 6e  OpenReadOnly(con
0760: 73 74 20 63 68 61 72 2a 2c 20 4f 73 46 69 6c 65  st char*, OsFile
0770: 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73  *);.int sqliteOs
0780: 54 65 6d 70 46 69 6c 65 4e 61 6d 65 28 63 68 61  TempFileName(cha
0790: 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f  r*);.int sqliteO
07a0: 73 43 6c 6f 73 65 28 4f 73 46 69 6c 65 2a 29 3b  sClose(OsFile*);
07b0: 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73 52 65 61  .int sqliteOsRea
07c0: 64 28 4f 73 46 69 6c 65 2a 2c 20 76 6f 69 64 2a  d(OsFile*, void*
07d0: 2c 20 69 6e 74 20 61 6d 74 29 3b 0a 69 6e 74 20  , int amt);.int 
07e0: 73 71 6c 69 74 65 4f 73 57 72 69 74 65 28 4f 73  sqliteOsWrite(Os
07f0: 46 69 6c 65 2a 2c 20 63 6f 6e 73 74 20 76 6f 69  File*, const voi
0800: 64 2a 2c 20 69 6e 74 20 61 6d 74 29 3b 0a 69 6e  d*, int amt);.in
0810: 74 20 73 71 6c 69 74 65 4f 73 53 65 65 6b 28 4f  t sqliteOsSeek(O
0820: 73 46 69 6c 65 2a 2c 20 69 6e 74 20 6f 66 66 73  sFile*, int offs
0830: 65 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f  et);.int sqliteO
0840: 73 53 79 6e 63 28 4f 73 46 69 6c 65 2a 29 3b 0a  sSync(OsFile*);.
0850: 69 6e 74 20 73 71 6c 69 74 65 4f 73 54 72 75 6e  int sqliteOsTrun
0860: 63 61 74 65 28 4f 73 46 69 6c 65 2a 2c 20 69 6e  cate(OsFile*, in
0870: 74 20 73 69 7a 65 29 3b 0a 69 6e 74 20 73 71 6c  t size);.int sql
0880: 69 74 65 4f 73 46 69 6c 65 53 69 7a 65 28 4f 73  iteOsFileSize(Os
0890: 46 69 6c 65 2a 2c 20 69 6e 74 20 2a 70 53 69 7a  File*, int *pSiz
08a0: 65 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73  e);.int sqliteOs
08b0: 52 65 61 64 4c 6f 63 6b 28 4f 73 46 69 6c 65 2a  ReadLock(OsFile*
08c0: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73 57  );.int sqliteOsW
08d0: 72 69 74 65 4c 6f 63 6b 28 4f 73 46 69 6c 65 2a  riteLock(OsFile*
08e0: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73 55  );.int sqliteOsU
08f0: 6e 6c 6f 63 6b 28 4f 73 46 69 6c 65 2a 29 3b 0a  nlock(OsFile*);.
0900: 69 6e 74 20 73 71 6c 69 74 65 4f 73 52 61 6e 64  int sqliteOsRand
0910: 6f 6d 53 65 65 64 28 63 68 61 72 2a 29 3b 0a 69  omSeed(char*);.i
0920: 6e 74 20 73 71 6c 69 74 65 4f 73 53 6c 65 65 70  nt sqliteOsSleep
0930: 28 69 6e 74 20 6d 73 29 3b 0a 76 6f 69 64 20 73  (int ms);.void s
0940: 71 6c 69 74 65 4f 73 45 6e 74 65 72 4d 75 74 65  qliteOsEnterMute
0950: 78 28 76 6f 69 64 29 3b 0a 76 6f 69 64 20 73 71  x(void);.void sq
0960: 6c 69 74 65 4f 73 4c 65 61 76 65 4d 75 74 65 78  liteOsLeaveMutex
0970: 28 76 6f 69 64 29 3b 0a 0a 0a 0a 23 65 6e 64 69  (void);....#endi
0980: 66 20 2f 2a 20 5f 53 51 4c 49 54 45 5f 4f 53 5f  f /* _SQLITE_OS_
0990: 48 5f 20 2a 2f 0a                                H_ */.