/ Hex Artifact Content
Login

Artifact 6d627d8629a204c474cf13aa098654658378a81f:


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 2f 2a 0a 2a  LITE_OS_H_../*.*
0280: 2a 20 41 20 68 61 6e 64 6c 65 20 66 6f 72 20 61  * A handle for a
0290: 6e 20 6f 70 65 6e 20 66 69 6c 65 20 69 73 20 73  n open file is s
02a0: 74 6f 72 65 64 20 69 6e 20 61 6e 20 4f 73 46 69  tored in an OsFi
02b0: 6c 65 20 6f 62 6a 65 63 74 2e 0a 2a 2f 0a 23 69  le object..*/.#i
02c0: 66 20 4f 53 5f 55 4e 49 58 0a 20 20 74 79 70 65  f OS_UNIX.  type
02d0: 64 65 66 20 69 6e 74 20 4f 73 46 69 6c 65 3b 0a  def int OsFile;.
02e0: 23 20 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  # define SQLITE_
02f0: 54 45 4d 50 4e 41 4d 45 5f 53 49 5a 45 20 32 30  TEMPNAME_SIZE 20
0300: 30 0a 23 20 69 66 20 64 65 66 69 6e 65 64 28 48  0.# if defined(H
0310: 41 56 45 5f 55 53 4c 45 45 50 29 20 26 26 20 48  AVE_USLEEP) && H
0320: 41 56 45 5f 55 53 4c 45 45 50 0a 23 20 20 64 65  AVE_USLEEP.#  de
0330: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4d 49 4e 5f  fine SQLITE_MIN_
0340: 53 4c 45 45 50 5f 4d 53 20 31 0a 23 20 65 6c 73  SLEEP_MS 1.# els
0350: 65 0a 23 20 20 64 65 66 69 6e 65 20 53 51 4c 49  e.#  define SQLI
0360: 54 45 5f 4d 49 4e 5f 53 4c 45 45 50 5f 4d 53 20  TE_MIN_SLEEP_MS 
0370: 31 30 30 30 0a 23 20 65 6e 64 69 66 0a 23 65 6e  1000.# endif.#en
0380: 64 69 66 0a 0a 23 69 66 20 4f 53 5f 57 49 4e 0a  dif..#if OS_WIN.
0390: 20 20 74 79 70 65 64 65 66 20 48 41 4e 44 4c 45    typedef HANDLE
03a0: 20 4f 73 46 69 6c 65 3b 0a 23 20 64 65 66 69 6e   OsFile;.# defin
03b0: 65 20 53 51 4c 49 54 45 5f 54 45 4d 50 4e 41 4d  e SQLITE_TEMPNAM
03c0: 45 5f 53 49 5a 45 20 28 4d 41 58 5f 50 41 54 48  E_SIZE (MAX_PATH
03d0: 2b 35 30 29 0a 23 20 64 65 69 66 6e 65 20 53 51  +50).# deifne SQ
03e0: 4c 49 54 45 5f 4d 49 4e 5f 53 4c 45 45 50 5f 4d  LITE_MIN_SLEEP_M
03f0: 53 20 31 0a 23 65 6e 64 69 66 0a 0a 69 6e 74 20  S 1.#endif..int 
0400: 73 71 6c 69 74 65 4f 73 44 65 6c 65 74 65 28 63  sqliteOsDelete(c
0410: 6f 6e 73 74 20 63 68 61 72 2a 29 3b 0a 69 6e 74  onst char*);.int
0420: 20 73 71 6c 69 74 65 4f 73 46 69 6c 65 45 78 69   sqliteOsFileExi
0430: 73 74 73 28 63 6f 6e 73 74 20 63 68 61 72 2a 29  sts(const char*)
0440: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73 4f 70  ;.int sqliteOsOp
0450: 65 6e 52 65 61 64 57 72 69 74 65 28 63 6f 6e 73  enReadWrite(cons
0460: 74 20 63 68 61 72 2a 2c 20 4f 73 46 69 6c 65 2a  t char*, OsFile*
0470: 2c 20 69 6e 74 2a 29 3b 0a 69 6e 74 20 73 71 6c  , int*);.int sql
0480: 69 74 65 4f 73 4f 70 65 6e 45 78 63 6c 75 73 69  iteOsOpenExclusi
0490: 76 65 28 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20  ve(const char*, 
04a0: 4f 73 46 69 6c 65 2a 29 3b 0a 69 6e 74 20 73 71  OsFile*);.int sq
04b0: 6c 69 74 65 4f 73 4f 70 65 6e 52 65 61 64 4f 6e  liteOsOpenReadOn
04c0: 6c 79 28 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20  ly(const char*, 
04d0: 4f 73 46 69 6c 65 2a 29 3b 0a 69 6e 74 20 73 71  OsFile*);.int sq
04e0: 6c 69 74 65 4f 73 54 65 6d 70 46 69 6c 65 4e 61  liteOsTempFileNa
04f0: 6d 65 28 63 68 61 72 2a 29 3b 0a 69 6e 74 20 73  me(char*);.int s
0500: 71 6c 69 74 65 4f 73 43 6c 6f 73 65 28 4f 73 46  qliteOsClose(OsF
0510: 69 6c 65 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ile);.int sqlite
0520: 4f 73 52 65 61 64 28 4f 73 46 69 6c 65 2c 20 76  OsRead(OsFile, v
0530: 6f 69 64 2a 2c 20 69 6e 74 20 61 6d 74 29 3b 0a  oid*, int amt);.
0540: 69 6e 74 20 73 71 6c 69 74 65 4f 73 57 72 69 74  int sqliteOsWrit
0550: 65 28 4f 73 46 69 6c 65 2c 20 63 6f 6e 73 74 20  e(OsFile, const 
0560: 76 6f 69 64 2a 2c 20 69 6e 74 20 61 6d 74 29 3b  void*, int amt);
0570: 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73 53 65 65  .int sqliteOsSee
0580: 6b 28 4f 73 46 69 6c 65 2c 20 69 6e 74 20 6f 66  k(OsFile, int of
0590: 66 73 65 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74  fset);.int sqlit
05a0: 65 4f 73 53 79 6e 63 28 4f 73 46 69 6c 65 29 3b  eOsSync(OsFile);
05b0: 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73 54 72 75  .int sqliteOsTru
05c0: 6e 63 61 74 65 28 4f 73 46 69 6c 65 2c 20 69 6e  ncate(OsFile, in
05d0: 74 20 73 69 7a 65 29 3b 0a 69 6e 74 20 73 71 6c  t size);.int sql
05e0: 69 74 65 4f 73 46 69 6c 65 53 69 7a 65 28 4f 73  iteOsFileSize(Os
05f0: 46 69 6c 65 2c 20 69 6e 74 20 2a 70 53 69 7a 65  File, int *pSize
0600: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73 4c  );.int sqliteOsL
0610: 6f 63 6b 28 4f 73 46 69 6c 65 2c 20 69 6e 74 20  ock(OsFile, int 
0620: 77 72 6c 6f 63 6b 29 3b 0a 69 6e 74 20 73 71 6c  wrlock);.int sql
0630: 69 74 65 4f 73 55 6e 6c 6f 63 6b 28 4f 73 46 69  iteOsUnlock(OsFi
0640: 6c 65 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f  le);.int sqliteO
0650: 73 52 61 6e 64 6f 6d 53 65 65 64 28 63 68 61 72  sRandomSeed(char
0660: 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 4f 73  *);.int sqliteOs
0670: 53 6c 65 65 70 28 69 6e 74 20 6d 73 29 3b 0a 0a  Sleep(int ms);..
0680: 0a 0a 23 65 6e 64 69 66 20 2f 2a 20 5f 53 51 4c  ..#endif /* _SQL
0690: 49 54 45 5f 4f 53 5f 48 5f 20 2a 2f 0a           ITE_OS_H_ */.