/ Hex Artifact Content
Login

Artifact 4172cf1dfb84ce13fe5f1073accbc320b4b25ad2:


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 46 69 67 75 72 65 20 6f 75 74 20 69 66 20  * Figure out if 
0290: 77 65 20 61 72 65 20 64 65 61 6c 69 6e 67 20 77  we are dealing w
02a0: 69 74 68 20 55 6e 69 78 2c 20 57 69 6e 64 6f 77  ith Unix, Window
02b0: 73 20 6f 72 20 4d 61 63 4f 53 2e 0a 2a 2a 0a 2a  s or MacOS..**.*
02c0: 2a 20 4e 2e 42 2e 20 4d 61 63 4f 53 20 6d 65 61  * N.B. MacOS mea
02d0: 6e 73 20 4d 61 63 20 43 6c 61 73 73 69 63 20 28  ns Mac Classic (
02e0: 6f 72 20 43 61 72 62 6f 6e 29 2e 20 54 72 65 61  or Carbon). Trea
02f0: 74 20 44 61 72 77 69 6e 20 28 4f 53 20 58 29 20  t Darwin (OS X) 
0300: 61 73 20 55 6e 69 78 2e 0a 2a 2a 20 20 20 20 20  as Unix..**     
0310: 20 54 68 65 20 4d 61 63 4f 53 20 62 75 69 6c 64   The MacOS build
0320: 20 69 73 20 64 65 73 69 67 6e 65 64 20 74 6f 20   is designed to 
0330: 75 73 65 20 43 6f 64 65 57 61 72 72 69 6f 72 20  use CodeWarrior 
0340: 28 74 65 73 74 65 64 20 77 69 74 68 20 76 38 29  (tested with v8)
0350: 0a 2a 2f 0a 23 69 66 20 21 64 65 66 69 6e 65 64  .*/.#if !defined
0360: 28 4f 53 5f 55 4e 49 58 29 20 26 26 20 21 64 65  (OS_UNIX) && !de
0370: 66 69 6e 65 64 28 4f 53 5f 41 4c 54 29 0a 23 20  fined(OS_ALT).# 
0380: 64 65 66 69 6e 65 20 4f 53 5f 4f 54 48 45 52 20  define OS_OTHER 
0390: 30 0a 23 20 69 66 6e 64 65 66 20 4f 53 5f 57 49  0.# ifndef OS_WI
03a0: 4e 0a 23 20 20 20 69 66 20 64 65 66 69 6e 65 64  N.#   if defined
03b0: 28 5f 57 49 4e 33 32 29 20 7c 7c 20 64 65 66 69  (_WIN32) || defi
03c0: 6e 65 64 28 57 49 4e 33 32 29 20 7c 7c 20 64 65  ned(WIN32) || de
03d0: 66 69 6e 65 64 28 5f 5f 43 59 47 57 49 4e 5f 5f  fined(__CYGWIN__
03e0: 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 5f 5f 4d  ) || defined(__M
03f0: 49 4e 47 57 33 32 5f 5f 29 20 7c 7c 20 64 65 66  INGW32__) || def
0400: 69 6e 65 64 28 5f 5f 42 4f 52 4c 41 4e 44 43 5f  ined(__BORLANDC_
0410: 5f 29 0a 23 20 20 20 20 20 64 65 66 69 6e 65 20  _).#     define 
0420: 4f 53 5f 57 49 4e 20 31 0a 23 20 20 20 20 20 64  OS_WIN 1.#     d
0430: 65 66 69 6e 65 20 4f 53 5f 55 4e 49 58 20 30 0a  efine OS_UNIX 0.
0440: 23 20 20 20 65 6c 73 65 0a 23 20 20 20 20 20 64  #   else.#     d
0450: 65 66 69 6e 65 20 4f 53 5f 57 49 4e 20 30 0a 23  efine OS_WIN 0.#
0460: 20 20 20 20 20 64 65 66 69 6e 65 20 4f 53 5f 55       define OS_U
0470: 4e 49 58 20 31 0a 23 20 20 65 6e 64 69 66 0a 23  NIX 1.#  endif.#
0480: 20 65 6c 73 65 0a 23 20 20 64 65 66 69 6e 65 20   else.#  define 
0490: 4f 53 5f 55 4e 49 58 20 30 0a 23 20 65 6e 64 69  OS_UNIX 0.# endi
04a0: 66 0a 23 65 6c 73 65 0a 23 20 69 66 6e 64 65 66  f.#else.# ifndef
04b0: 20 4f 53 5f 57 49 4e 0a 23 20 20 64 65 66 69 6e   OS_WIN.#  defin
04c0: 65 20 4f 53 5f 57 49 4e 20 30 0a 23 20 65 6e 64  e OS_WIN 0.# end
04d0: 69 66 0a 23 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a  if.#endif../*.**
04e0: 20 54 68 65 20 4f 73 46 69 6c 65 20 6f 62 6a 65   The OsFile obje
04f0: 63 74 20 64 65 73 63 72 69 62 65 73 20 61 6e 20  ct describes an 
0500: 6f 70 65 6e 20 64 69 73 6b 20 66 69 6c 65 20 69  open disk file i
0510: 6e 20 61 6e 20 4f 53 2d 64 65 70 65 6e 64 65 6e  n an OS-dependen
0520: 74 20 77 61 79 2e 0a 2a 2f 0a 74 79 70 65 64 65  t way..*/.typede
0530: 66 20 73 74 72 75 63 74 20 4f 73 46 69 6c 65 20  f struct OsFile 
0540: 4f 73 46 69 6c 65 3b 0a 0a 2f 2a 0a 2a 2a 20 44  OsFile;../*.** D
0550: 65 66 69 6e 65 20 74 68 65 20 6d 61 78 69 6d 75  efine the maximu
0560: 6d 20 73 69 7a 65 20 6f 66 20 61 20 74 65 6d 70  m size of a temp
0570: 6f 72 61 72 79 20 66 69 6c 65 6e 61 6d 65 0a 2a  orary filename.*
0580: 2f 0a 23 69 66 20 4f 53 5f 57 49 4e 0a 23 20 69  /.#if OS_WIN.# i
0590: 6e 63 6c 75 64 65 20 3c 77 69 6e 64 6f 77 73 2e  nclude <windows.
05a0: 68 3e 0a 23 20 64 65 66 69 6e 65 20 53 51 4c 49  h>.# define SQLI
05b0: 54 45 5f 54 45 4d 50 4e 41 4d 45 5f 53 49 5a 45  TE_TEMPNAME_SIZE
05c0: 20 28 4d 41 58 5f 50 41 54 48 2b 35 30 29 0a 23   (MAX_PATH+50).#
05d0: 65 6c 73 65 0a 23 20 64 65 66 69 6e 65 20 53 51  else.# define SQ
05e0: 4c 49 54 45 5f 54 45 4d 50 4e 41 4d 45 5f 53 49  LITE_TEMPNAME_SI
05f0: 5a 45 20 32 30 30 0a 23 65 6e 64 69 66 0a 0a 2f  ZE 200.#endif../
0600: 2a 20 49 66 20 74 68 65 20 53 45 54 5f 46 55 4c  * If the SET_FUL
0610: 4c 53 59 4e 43 20 6d 61 63 72 6f 20 69 73 20 6e  LSYNC macro is n
0620: 6f 74 20 64 65 66 69 6e 65 64 20 61 62 6f 76 65  ot defined above
0630: 2c 20 74 68 65 6e 20 6d 61 6b 65 20 69 74 0a 2a  , then make it.*
0640: 2a 20 61 20 6e 6f 2d 6f 70 0a 2a 2f 0a 23 69 66  * a no-op.*/.#if
0650: 6e 64 65 66 20 53 45 54 5f 46 55 4c 4c 53 59 4e  ndef SET_FULLSYN
0660: 43 0a 23 20 64 65 66 69 6e 65 20 53 45 54 5f 46  C.# define SET_F
0670: 55 4c 4c 53 59 4e 43 28 78 2c 79 29 0a 23 65 6e  ULLSYNC(x,y).#en
0680: 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 54 65 6d 70 6f  dif../*.** Tempo
0690: 72 61 72 79 20 66 69 6c 65 73 20 61 72 65 20 6e  rary files are n
06a0: 61 6d 65 64 20 73 74 61 72 74 69 6e 67 20 77 69  amed starting wi
06b0: 74 68 20 74 68 69 73 20 70 72 65 66 69 78 20 66  th this prefix f
06c0: 6f 6c 6c 6f 77 65 64 20 62 79 20 31 36 20 72 61  ollowed by 16 ra
06d0: 6e 64 6f 6d 0a 2a 2a 20 61 6c 70 68 61 6e 75 6d  ndom.** alphanum
06e0: 65 72 69 63 20 63 68 61 72 61 63 74 65 72 73 2c  eric characters,
06f0: 20 61 6e 64 20 6e 6f 20 66 69 6c 65 20 65 78 74   and no file ext
0700: 65 6e 73 69 6f 6e 2e 20 54 68 65 79 20 61 72 65  ension. They are
0710: 20 73 74 6f 72 65 64 20 69 6e 20 74 68 65 0a 2a   stored in the.*
0720: 2a 20 4f 53 27 73 20 73 74 61 6e 64 61 72 64 20  * OS's standard 
0730: 74 65 6d 70 6f 72 61 72 79 20 66 69 6c 65 20 64  temporary file d
0740: 69 72 65 63 74 6f 72 79 2c 20 61 6e 64 20 61 72  irectory, and ar
0750: 65 20 64 65 6c 65 74 65 64 20 70 72 69 6f 72 20  e deleted prior 
0760: 74 6f 20 65 78 69 74 2e 0a 2a 2a 20 49 66 20 73  to exit..** If s
0770: 71 6c 69 74 65 20 69 73 20 62 65 69 6e 67 20 65  qlite is being e
0780: 6d 62 65 64 64 65 64 20 69 6e 20 61 6e 6f 74 68  mbedded in anoth
0790: 65 72 20 70 72 6f 67 72 61 6d 2c 20 79 6f 75 20  er program, you 
07a0: 6d 61 79 20 77 69 73 68 20 74 6f 20 63 68 61 6e  may wish to chan
07b0: 67 65 20 74 68 65 0a 2a 2a 20 70 72 65 66 69 78  ge the.** prefix
07c0: 20 74 6f 20 72 65 66 6c 65 63 74 20 79 6f 75 72   to reflect your
07d0: 20 70 72 6f 67 72 61 6d 27 73 20 6e 61 6d 65 2c   program's name,
07e0: 20 73 6f 20 74 68 61 74 20 69 66 20 79 6f 75 72   so that if your
07f0: 20 70 72 6f 67 72 61 6d 20 65 78 69 74 73 0a 2a   program exits.*
0800: 2a 20 70 72 65 6d 61 74 75 72 65 6c 79 2c 20 6f  * prematurely, o
0810: 6c 64 20 74 65 6d 70 6f 72 61 72 79 20 66 69 6c  ld temporary fil
0820: 65 73 20 63 61 6e 20 62 65 20 65 61 73 69 6c 79  es can be easily
0830: 20 69 64 65 6e 74 69 66 69 65 64 2e 20 54 68 69   identified. Thi
0840: 73 20 63 61 6e 20 62 65 20 64 6f 6e 65 0a 2a 2a  s can be done.**
0850: 20 75 73 69 6e 67 20 2d 44 54 45 4d 50 5f 46 49   using -DTEMP_FI
0860: 4c 45 5f 50 52 45 46 49 58 3d 6d 79 70 72 65 66  LE_PREFIX=mypref
0870: 69 78 5f 20 6f 6e 20 74 68 65 20 63 6f 6d 70 69  ix_ on the compi
0880: 6c 65 72 20 63 6f 6d 6d 61 6e 64 20 6c 69 6e 65  ler command line
0890: 2e 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 54 45 4d  ..*/.#ifndef TEM
08a0: 50 5f 46 49 4c 45 5f 50 52 45 46 49 58 0a 23 20  P_FILE_PREFIX.# 
08b0: 64 65 66 69 6e 65 20 54 45 4d 50 5f 46 49 4c 45  define TEMP_FILE
08c0: 5f 50 52 45 46 49 58 20 22 73 71 6c 69 74 65 5f  _PREFIX "sqlite_
08d0: 22 0a 23 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20  ".#endif../*.** 
08e0: 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 76 61  The following va
08f0: 6c 75 65 73 20 6d 61 79 20 62 65 20 70 61 73 73  lues may be pass
0900: 65 64 20 61 73 20 74 68 65 20 73 65 63 6f 6e 64  ed as the second
0910: 20 61 72 67 75 6d 65 6e 74 20 74 6f 0a 2a 2a 20   argument to.** 
0920: 73 71 6c 69 74 65 33 4f 73 4c 6f 63 6b 28 29 2e  sqlite3OsLock().
0930: 20 54 68 65 20 76 61 72 69 6f 75 73 20 6c 6f 63   The various loc
0940: 6b 73 20 65 78 68 69 62 69 74 20 74 68 65 20 66  ks exhibit the f
0950: 6f 6c 6c 6f 77 69 6e 67 20 73 65 6d 61 6e 74 69  ollowing semanti
0960: 63 73 3a 0a 2a 2a 0a 2a 2a 20 53 48 41 52 45 44  cs:.**.** SHARED
0970: 3a 20 20 20 20 41 6e 79 20 6e 75 6d 62 65 72 20  :    Any number 
0980: 6f 66 20 70 72 6f 63 65 73 73 65 73 20 6d 61 79  of processes may
0990: 20 68 6f 6c 64 20 61 20 53 48 41 52 45 44 20 6c   hold a SHARED l
09a0: 6f 63 6b 20 73 69 6d 75 6c 74 61 6e 65 6f 75 73  ock simultaneous
09b0: 6c 79 2e 0a 2a 2a 20 52 45 53 45 52 56 45 44 3a  ly..** RESERVED:
09c0: 20 20 41 20 73 69 6e 67 6c 65 20 70 72 6f 63 65    A single proce
09d0: 73 73 20 6d 61 79 20 68 6f 6c 64 20 61 20 52 45  ss may hold a RE
09e0: 53 45 52 56 45 44 20 6c 6f 63 6b 20 6f 6e 20 61  SERVED lock on a
09f0: 20 66 69 6c 65 20 61 74 0a 2a 2a 20 20 20 20 20   file at.**     
0a00: 20 20 20 20 20 20 20 61 6e 79 20 74 69 6d 65 2e         any time.
0a10: 20 4f 74 68 65 72 20 70 72 6f 63 65 73 73 65 73   Other processes
0a20: 20 6d 61 79 20 68 6f 6c 64 20 61 6e 64 20 6f 62   may hold and ob
0a30: 74 61 69 6e 20 6e 65 77 20 53 48 41 52 45 44 20  tain new SHARED 
0a40: 6c 6f 63 6b 73 2e 0a 2a 2a 20 50 45 4e 44 49 4e  locks..** PENDIN
0a50: 47 3a 20 20 20 41 20 73 69 6e 67 6c 65 20 70 72  G:   A single pr
0a60: 6f 63 65 73 73 20 6d 61 79 20 68 6f 6c 64 20 61  ocess may hold a
0a70: 20 50 45 4e 44 49 4e 47 20 6c 6f 63 6b 20 6f 6e   PENDING lock on
0a80: 20 61 20 66 69 6c 65 20 61 74 0a 2a 2a 20 20 20   a file at.**   
0a90: 20 20 20 20 20 20 20 20 20 61 6e 79 20 6f 6e 65           any one
0aa0: 20 74 69 6d 65 2e 20 45 78 69 73 74 69 6e 67 20   time. Existing 
0ab0: 53 48 41 52 45 44 20 6c 6f 63 6b 73 20 6d 61 79  SHARED locks may
0ac0: 20 70 65 72 73 69 73 74 2c 20 62 75 74 20 6e 6f   persist, but no
0ad0: 20 6e 65 77 0a 2a 2a 20 20 20 20 20 20 20 20 20   new.**         
0ae0: 20 20 20 53 48 41 52 45 44 20 6c 6f 63 6b 73 20     SHARED locks 
0af0: 6d 61 79 20 62 65 20 6f 62 74 61 69 6e 65 64 20  may be obtained 
0b00: 62 79 20 6f 74 68 65 72 20 70 72 6f 63 65 73 73  by other process
0b10: 65 73 2e 0a 2a 2a 20 45 58 43 4c 55 53 49 56 45  es..** EXCLUSIVE
0b20: 3a 20 41 6e 20 45 58 43 4c 55 53 49 56 45 20 6c  : An EXCLUSIVE l
0b30: 6f 63 6b 20 70 72 65 63 6c 75 64 65 73 20 61 6c  ock precludes al
0b40: 6c 20 6f 74 68 65 72 20 6c 6f 63 6b 73 2e 0a 2a  l other locks..*
0b50: 2a 0a 2a 2a 20 50 45 4e 44 49 4e 47 5f 4c 4f 43  *.** PENDING_LOC
0b60: 4b 20 6d 61 79 20 6e 6f 74 20 62 65 20 70 61 73  K may not be pas
0b70: 73 65 64 20 64 69 72 65 63 74 6c 79 20 74 6f 20  sed directly to 
0b80: 73 71 6c 69 74 65 33 4f 73 4c 6f 63 6b 28 29 2e  sqlite3OsLock().
0b90: 20 49 6e 73 74 65 61 64 2c 20 61 0a 2a 2a 20 70   Instead, a.** p
0ba0: 72 6f 63 65 73 73 20 74 68 61 74 20 72 65 71 75  rocess that requ
0bb0: 65 73 74 73 20 61 6e 20 45 58 43 4c 55 53 49 56  ests an EXCLUSIV
0bc0: 45 20 6c 6f 63 6b 20 6d 61 79 20 61 63 74 75 61  E lock may actua
0bd0: 6c 6c 79 20 6f 62 74 61 69 6e 20 61 20 50 45 4e  lly obtain a PEN
0be0: 44 49 4e 47 0a 2a 2a 20 6c 6f 63 6b 2e 20 54 68  DING.** lock. Th
0bf0: 69 73 20 63 61 6e 20 62 65 20 75 70 67 72 61 64  is can be upgrad
0c00: 65 64 20 74 6f 20 61 6e 20 45 58 43 4c 55 53 49  ed to an EXCLUSI
0c10: 56 45 20 6c 6f 63 6b 20 62 79 20 61 20 73 75 62  VE lock by a sub
0c20: 73 65 71 75 65 6e 74 20 63 61 6c 6c 20 74 6f 0a  sequent call to.
0c30: 2a 2a 20 73 71 6c 69 74 65 33 4f 73 4c 6f 63 6b  ** sqlite3OsLock
0c40: 28 29 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 4e  ()..*/.#define N
0c50: 4f 5f 4c 4f 43 4b 20 20 20 20 20 20 20 20 20 30  O_LOCK         0
0c60: 0a 23 64 65 66 69 6e 65 20 53 48 41 52 45 44 5f  .#define SHARED_
0c70: 4c 4f 43 4b 20 20 20 20 20 31 0a 23 64 65 66 69  LOCK     1.#defi
0c80: 6e 65 20 52 45 53 45 52 56 45 44 5f 4c 4f 43 4b  ne RESERVED_LOCK
0c90: 20 20 20 32 0a 23 64 65 66 69 6e 65 20 50 45 4e     2.#define PEN
0ca0: 44 49 4e 47 5f 4c 4f 43 4b 20 20 20 20 33 0a 23  DING_LOCK    3.#
0cb0: 64 65 66 69 6e 65 20 45 58 43 4c 55 53 49 56 45  define EXCLUSIVE
0cc0: 5f 4c 4f 43 4b 20 20 34 0a 0a 2f 2a 0a 2a 2a 20  _LOCK  4../*.** 
0cd0: 46 69 6c 65 20 4c 6f 63 6b 69 6e 67 20 4e 6f 74  File Locking Not
0ce0: 65 73 3a 20 20 28 4d 6f 73 74 6c 79 20 61 62 6f  es:  (Mostly abo
0cf0: 75 74 20 77 69 6e 64 6f 77 73 20 62 75 74 20 61  ut windows but a
0d00: 6c 73 6f 20 73 6f 6d 65 20 69 6e 66 6f 20 66 6f  lso some info fo
0d10: 72 20 55 6e 69 78 29 0a 2a 2a 0a 2a 2a 20 57 65  r Unix).**.** We
0d20: 20 63 61 6e 6e 6f 74 20 75 73 65 20 4c 6f 63 6b   cannot use Lock
0d30: 46 69 6c 65 45 78 28 29 20 6f 72 20 55 6e 6c 6f  FileEx() or Unlo
0d40: 63 6b 46 69 6c 65 45 78 28 29 20 6f 6e 20 57 69  ckFileEx() on Wi
0d50: 6e 39 35 2f 39 38 2f 4d 45 20 62 65 63 61 75 73  n95/98/ME becaus
0d60: 65 0a 2a 2a 20 74 68 6f 73 65 20 66 75 6e 63 74  e.** those funct
0d70: 69 6f 6e 73 20 61 72 65 20 6e 6f 74 20 61 76 61  ions are not ava
0d80: 69 6c 61 62 6c 65 2e 20 20 53 6f 20 77 65 20 75  ilable.  So we u
0d90: 73 65 20 6f 6e 6c 79 20 4c 6f 63 6b 46 69 6c 65  se only LockFile
0da0: 28 29 20 61 6e 64 0a 2a 2a 20 55 6e 6c 6f 63 6b  () and.** Unlock
0db0: 46 69 6c 65 28 29 2e 0a 2a 2a 0a 2a 2a 20 4c 6f  File()..**.** Lo
0dc0: 63 6b 46 69 6c 65 28 29 20 70 72 65 76 65 6e 74  ckFile() prevent
0dd0: 73 20 6e 6f 74 20 6a 75 73 74 20 77 72 69 74 69  s not just writi
0de0: 6e 67 20 62 75 74 20 61 6c 73 6f 20 72 65 61 64  ng but also read
0df0: 69 6e 67 20 62 79 20 6f 74 68 65 72 20 70 72 6f  ing by other pro
0e00: 63 65 73 73 65 73 2e 0a 2a 2a 20 41 20 53 48 41  cesses..** A SHA
0e10: 52 45 44 5f 4c 4f 43 4b 20 69 73 20 6f 62 74 61  RED_LOCK is obta
0e20: 69 6e 65 64 20 62 79 20 6c 6f 63 6b 69 6e 67 20  ined by locking 
0e30: 61 20 73 69 6e 67 6c 65 20 72 61 6e 64 6f 6d 6c  a single randoml
0e40: 79 2d 63 68 6f 73 65 6e 20 0a 2a 2a 20 62 79 74  y-chosen .** byt
0e50: 65 20 6f 75 74 20 6f 66 20 61 20 73 70 65 63 69  e out of a speci
0e60: 66 69 63 20 72 61 6e 67 65 20 6f 66 20 62 79 74  fic range of byt
0e70: 65 73 2e 20 54 68 65 20 6c 6f 63 6b 20 62 79 74  es. The lock byt
0e80: 65 20 69 73 20 6f 62 74 61 69 6e 65 64 20 61 74  e is obtained at
0e90: 20 0a 2a 2a 20 72 61 6e 64 6f 6d 20 73 6f 20 74   .** random so t
0ea0: 77 6f 20 73 65 70 61 72 61 74 65 20 72 65 61 64  wo separate read
0eb0: 65 72 73 20 63 61 6e 20 70 72 6f 62 61 62 6c 79  ers can probably
0ec0: 20 61 63 63 65 73 73 20 74 68 65 20 66 69 6c 65   access the file
0ed0: 20 61 74 20 74 68 65 20 0a 2a 2a 20 73 61 6d 65   at the .** same
0ee0: 20 74 69 6d 65 2c 20 75 6e 6c 65 73 73 20 74 68   time, unless th
0ef0: 65 79 20 61 72 65 20 75 6e 6c 75 63 6b 79 20 61  ey are unlucky a
0f00: 6e 64 20 63 68 6f 6f 73 65 20 74 68 65 20 73 61  nd choose the sa
0f10: 6d 65 20 6c 6f 63 6b 20 62 79 74 65 2e 0a 2a 2a  me lock byte..**
0f20: 20 41 6e 20 45 58 43 4c 55 53 49 56 45 5f 4c 4f   An EXCLUSIVE_LO
0f30: 43 4b 20 69 73 20 6f 62 74 61 69 6e 65 64 20 62  CK is obtained b
0f40: 79 20 6c 6f 63 6b 69 6e 67 20 61 6c 6c 20 62 79  y locking all by
0f50: 74 65 73 20 69 6e 20 74 68 65 20 72 61 6e 67 65  tes in the range
0f60: 2e 0a 2a 2a 20 54 68 65 72 65 20 63 61 6e 20 6f  ..** There can o
0f70: 6e 6c 79 20 62 65 20 6f 6e 65 20 77 72 69 74 65  nly be one write
0f80: 72 2e 20 20 41 20 52 45 53 45 52 56 45 44 5f 4c  r.  A RESERVED_L
0f90: 4f 43 4b 20 69 73 20 6f 62 74 61 69 6e 65 64 20  OCK is obtained 
0fa0: 62 79 20 6c 6f 63 6b 69 6e 67 0a 2a 2a 20 61 20  by locking.** a 
0fb0: 73 69 6e 67 6c 65 20 62 79 74 65 20 6f 66 20 74  single byte of t
0fc0: 68 65 20 66 69 6c 65 20 74 68 61 74 20 69 73 20  he file that is 
0fd0: 64 65 73 69 67 6e 61 74 65 64 20 61 73 20 74 68  designated as th
0fe0: 65 20 72 65 73 65 72 76 65 64 20 6c 6f 63 6b 20  e reserved lock 
0ff0: 62 79 74 65 2e 0a 2a 2a 20 41 20 50 45 4e 44 49  byte..** A PENDI
1000: 4e 47 5f 4c 4f 43 4b 20 69 73 20 6f 62 74 61 69  NG_LOCK is obtai
1010: 6e 65 64 20 62 79 20 6c 6f 63 6b 69 6e 67 20 61  ned by locking a
1020: 20 64 65 73 69 67 6e 61 74 65 64 20 62 79 74 65   designated byte
1030: 20 64 69 66 66 65 72 65 6e 74 20 66 72 6f 6d 0a   different from.
1040: 2a 2a 20 74 68 65 20 52 45 53 45 52 56 45 44 5f  ** the RESERVED_
1050: 4c 4f 43 4b 20 62 79 74 65 2e 0a 2a 2a 0a 2a 2a  LOCK byte..**.**
1060: 20 4f 6e 20 57 69 6e 4e 54 2f 32 4b 2f 58 50 20   On WinNT/2K/XP 
1070: 73 79 73 74 65 6d 73 2c 20 4c 6f 63 6b 46 69 6c  systems, LockFil
1080: 65 45 78 28 29 20 61 6e 64 20 55 6e 6c 6f 63 6b  eEx() and Unlock
1090: 46 69 6c 65 45 78 28 29 20 61 72 65 20 61 76 61  FileEx() are ava
10a0: 69 6c 61 62 6c 65 2c 0a 2a 2a 20 77 68 69 63 68  ilable,.** which
10b0: 20 6d 65 61 6e 73 20 77 65 20 63 61 6e 20 75 73   means we can us
10c0: 65 20 72 65 61 64 65 72 2f 77 72 69 74 65 72 20  e reader/writer 
10d0: 6c 6f 63 6b 73 2e 20 20 57 68 65 6e 20 72 65 61  locks.  When rea
10e0: 64 65 72 2f 77 72 69 74 65 72 20 6c 6f 63 6b 73  der/writer locks
10f0: 0a 2a 2a 20 61 72 65 20 75 73 65 64 2c 20 74 68  .** are used, th
1100: 65 20 6c 6f 63 6b 20 69 73 20 70 6c 61 63 65 64  e lock is placed
1110: 20 6f 6e 20 74 68 65 20 73 61 6d 65 20 72 61 6e   on the same ran
1120: 67 65 20 6f 66 20 62 79 74 65 73 20 74 68 61 74  ge of bytes that
1130: 20 69 73 20 75 73 65 64 0a 2a 2a 20 66 6f 72 20   is used.** for 
1140: 70 72 6f 62 61 62 69 6c 69 73 74 69 63 20 6c 6f  probabilistic lo
1150: 63 6b 69 6e 67 20 69 6e 20 57 69 6e 39 35 2f 39  cking in Win95/9
1160: 38 2f 4d 45 2e 20 20 48 65 6e 63 65 2c 20 74 68  8/ME.  Hence, th
1170: 65 20 6c 6f 63 6b 69 6e 67 20 73 63 68 65 6d 65  e locking scheme
1180: 0a 2a 2a 20 77 69 6c 6c 20 73 75 70 70 6f 72 74  .** will support
1190: 20 74 77 6f 20 6f 72 20 6d 6f 72 65 20 57 69 6e   two or more Win
11a0: 39 35 20 72 65 61 64 65 72 73 20 6f 72 20 74 77  95 readers or tw
11b0: 6f 20 6f 72 20 6d 6f 72 65 20 57 69 6e 4e 54 20  o or more WinNT 
11c0: 72 65 61 64 65 72 73 2e 0a 2a 2a 20 42 75 74 20  readers..** But 
11d0: 61 20 73 69 6e 67 6c 65 20 57 69 6e 39 35 20 72  a single Win95 r
11e0: 65 61 64 65 72 20 77 69 6c 6c 20 6c 6f 63 6b 20  eader will lock 
11f0: 6f 75 74 20 61 6c 6c 20 57 69 6e 4e 54 20 72 65  out all WinNT re
1200: 61 64 65 72 73 20 61 6e 64 20 61 20 73 69 6e 67  aders and a sing
1210: 6c 65 0a 2a 2a 20 57 69 6e 4e 54 20 72 65 61 64  le.** WinNT read
1220: 65 72 20 77 69 6c 6c 20 6c 6f 63 6b 20 6f 75 74  er will lock out
1230: 20 61 6c 6c 20 6f 74 68 65 72 20 57 69 6e 39 35   all other Win95
1240: 20 72 65 61 64 65 72 73 2e 0a 2a 2a 0a 2a 2a 20   readers..**.** 
1250: 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 23 64  The following #d
1260: 65 66 69 6e 65 73 20 73 70 65 63 69 66 79 20 74  efines specify t
1270: 68 65 20 72 61 6e 67 65 20 6f 66 20 62 79 74 65  he range of byte
1280: 73 20 75 73 65 64 20 66 6f 72 20 6c 6f 63 6b 69  s used for locki
1290: 6e 67 2e 0a 2a 2a 20 53 48 41 52 45 44 5f 53 49  ng..** SHARED_SI
12a0: 5a 45 20 69 73 20 74 68 65 20 6e 75 6d 62 65 72  ZE is the number
12b0: 20 6f 66 20 62 79 74 65 73 20 61 76 61 69 6c 61   of bytes availa
12c0: 62 6c 65 20 69 6e 20 74 68 65 20 70 6f 6f 6c 20  ble in the pool 
12d0: 66 72 6f 6d 20 77 68 69 63 68 0a 2a 2a 20 61 20  from which.** a 
12e0: 72 61 6e 64 6f 6d 20 62 79 74 65 20 69 73 20 73  random byte is s
12f0: 65 6c 65 63 74 65 64 20 66 6f 72 20 61 20 73 68  elected for a sh
1300: 61 72 65 64 20 6c 6f 63 6b 2e 20 20 54 68 65 20  ared lock.  The 
1310: 70 6f 6f 6c 20 6f 66 20 62 79 74 65 73 20 66 6f  pool of bytes fo
1320: 72 0a 2a 2a 20 73 68 61 72 65 64 20 6c 6f 63 6b  r.** shared lock
1330: 73 20 62 65 67 69 6e 73 20 61 74 20 53 48 41 52  s begins at SHAR
1340: 45 44 5f 46 49 52 53 54 2e 20 0a 2a 2a 0a 2a 2a  ED_FIRST. .**.**
1350: 20 54 68 65 73 65 20 23 64 65 66 69 6e 65 73 20   These #defines 
1360: 61 72 65 20 61 76 61 69 6c 61 62 6c 65 20 69 6e  are available in
1370: 20 6f 73 2e 68 20 73 6f 20 74 68 61 74 20 55 6e   os.h so that Un
1380: 69 78 20 63 61 6e 20 75 73 65 20 74 68 65 20 73  ix can use the s
1390: 61 6d 65 0a 2a 2a 20 62 79 74 65 20 72 61 6e 67  ame.** byte rang
13a0: 65 73 20 66 6f 72 20 6c 6f 63 6b 69 6e 67 2e 20  es for locking. 
13b0: 20 54 68 69 73 20 6c 65 61 76 65 73 20 6f 70 65   This leaves ope
13c0: 6e 20 74 68 65 20 70 6f 73 73 69 62 6c 69 74 79  n the possiblity
13d0: 20 6f 66 20 68 61 76 69 6e 67 0a 2a 2a 20 63 6c   of having.** cl
13e0: 69 65 6e 74 73 20 6f 6e 20 77 69 6e 39 35 2c 20  ients on win95, 
13f0: 77 69 6e 4e 54 2c 20 61 6e 64 20 75 6e 69 78 20  winNT, and unix 
1400: 61 6c 6c 20 74 61 6c 6b 69 6e 67 20 74 6f 20 74  all talking to t
1410: 68 65 20 73 61 6d 65 20 73 68 61 72 65 64 20 66  he same shared f
1420: 69 6c 65 0a 2a 2a 20 61 6e 64 20 61 6c 6c 20 6c  ile.** and all l
1430: 6f 63 6b 69 6e 67 20 63 6f 72 72 65 63 74 6c 79  ocking correctly
1440: 2e 20 20 54 6f 20 64 6f 20 73 6f 20 77 6f 75 6c  .  To do so woul
1450: 64 20 72 65 71 75 69 72 65 20 74 68 61 74 20 73  d require that s
1460: 61 6d 62 61 20 28 6f 72 20 77 68 61 74 65 76 65  amba (or whateve
1470: 72 0a 2a 2a 20 74 6f 6f 6c 20 69 73 20 62 65 69  r.** tool is bei
1480: 6e 67 20 75 73 65 64 20 66 6f 72 20 66 69 6c 65  ng used for file
1490: 20 73 68 61 72 69 6e 67 29 20 69 6d 70 6c 65 6d   sharing) implem
14a0: 65 6e 74 73 20 6c 6f 63 6b 73 20 63 6f 72 72 65  ents locks corre
14b0: 63 74 6c 79 20 62 65 74 77 65 65 6e 0a 2a 2a 20  ctly between.** 
14c0: 77 69 6e 64 6f 77 73 20 61 6e 64 20 75 6e 69 78  windows and unix
14d0: 2e 20 20 49 27 6d 20 67 75 65 73 73 69 6e 67 20  .  I'm guessing 
14e0: 74 68 61 74 20 69 73 6e 27 74 20 6c 69 6b 65 6c  that isn't likel
14f0: 79 20 74 6f 20 68 61 70 70 65 6e 2c 20 62 75 74  y to happen, but
1500: 20 62 79 0a 2a 2a 20 75 73 69 6e 67 20 74 68 65   by.** using the
1510: 20 73 61 6d 65 20 6c 6f 63 6b 69 6e 67 20 72 61   same locking ra
1520: 6e 67 65 20 77 65 20 61 72 65 20 61 74 20 6c 65  nge we are at le
1530: 61 73 74 20 6f 70 65 6e 20 74 6f 20 74 68 65 20  ast open to the 
1540: 70 6f 73 73 69 62 69 6c 69 74 79 2e 0a 2a 2a 0a  possibility..**.
1550: 2a 2a 20 4c 6f 63 6b 69 6e 67 20 69 6e 20 77 69  ** Locking in wi
1560: 6e 64 6f 77 73 20 69 73 20 6d 61 6e 64 69 74 6f  ndows is mandito
1570: 72 79 2e 20 20 46 6f 72 20 74 68 69 73 20 72 65  ry.  For this re
1580: 61 73 6f 6e 2c 20 77 65 20 63 61 6e 6e 6f 74 20  ason, we cannot 
1590: 73 74 6f 72 65 0a 2a 2a 20 61 63 74 75 61 6c 20  store.** actual 
15a0: 64 61 74 61 20 69 6e 20 74 68 65 20 62 79 74 65  data in the byte
15b0: 73 20 75 73 65 64 20 66 6f 72 20 6c 6f 63 6b 69  s used for locki
15c0: 6e 67 2e 20 20 54 68 65 20 70 61 67 65 72 20 6e  ng.  The pager n
15d0: 65 76 65 72 20 61 6c 6c 6f 63 61 74 65 73 0a 2a  ever allocates.*
15e0: 2a 20 74 68 65 20 70 61 67 65 73 20 69 6e 76 6f  * the pages invo
15f0: 6c 76 65 64 20 69 6e 20 6c 6f 63 6b 69 6e 67 20  lved in locking 
1600: 74 68 65 72 65 66 6f 72 65 2e 20 20 53 48 41 52  therefore.  SHAR
1610: 45 44 5f 53 49 5a 45 20 69 73 20 73 65 6c 65 63  ED_SIZE is selec
1620: 74 65 64 20 73 6f 0a 2a 2a 20 74 68 61 74 20 61  ted so.** that a
1630: 6c 6c 20 6c 6f 63 6b 73 20 77 69 6c 6c 20 66 69  ll locks will fi
1640: 74 20 6f 6e 20 61 20 73 69 6e 67 6c 65 20 70 61  t on a single pa
1650: 67 65 20 65 76 65 6e 20 61 74 20 74 68 65 20 6d  ge even at the m
1660: 69 6e 69 6d 75 6d 20 70 61 67 65 20 73 69 7a 65  inimum page size
1670: 2e 0a 2a 2a 20 50 45 4e 44 49 4e 47 5f 42 59 54  ..** PENDING_BYT
1680: 45 20 64 65 66 69 6e 65 73 20 74 68 65 20 62 65  E defines the be
1690: 67 69 6e 6e 69 6e 67 20 6f 66 20 74 68 65 20 6c  ginning of the l
16a0: 6f 63 6b 73 2e 20 20 42 79 20 64 65 66 61 75 6c  ocks.  By defaul
16b0: 74 20 50 45 4e 44 49 4e 47 5f 42 59 54 45 0a 2a  t PENDING_BYTE.*
16c0: 2a 20 69 73 20 73 65 74 20 68 69 67 68 20 73 6f  * is set high so
16d0: 20 74 68 61 74 20 77 65 20 64 6f 6e 27 74 20 68   that we don't h
16e0: 61 76 65 20 74 6f 20 61 6c 6c 6f 63 61 74 65 20  ave to allocate 
16f0: 61 6e 20 75 6e 75 73 65 64 20 70 61 67 65 20 65  an unused page e
1700: 78 63 65 70 74 0a 2a 2a 20 66 6f 72 20 76 65 72  xcept.** for ver
1710: 79 20 6c 61 72 67 65 20 64 61 74 61 62 61 73 65  y large database
1720: 73 2e 20 20 42 75 74 20 6f 6e 65 20 73 68 6f 75  s.  But one shou
1730: 6c 64 20 74 65 73 74 20 74 68 65 20 70 61 67 65  ld test the page
1740: 20 73 6b 69 70 70 69 6e 67 20 6c 6f 67 69 63 20   skipping logic 
1750: 0a 2a 2a 20 62 79 20 73 65 74 74 69 6e 67 20 50  .** by setting P
1760: 45 4e 44 49 4e 47 5f 42 59 54 45 20 6c 6f 77 20  ENDING_BYTE low 
1770: 61 6e 64 20 72 75 6e 6e 69 6e 67 20 74 68 65 20  and running the 
1780: 65 6e 74 69 72 65 20 72 65 67 72 65 73 73 69 6f  entire regressio
1790: 6e 20 73 75 69 74 65 2e 0a 2a 2a 0a 2a 2a 20 43  n suite..**.** C
17a0: 68 61 6e 67 69 6e 67 20 74 68 65 20 76 61 6c 75  hanging the valu
17b0: 65 20 6f 66 20 50 45 4e 44 49 4e 47 5f 42 59 54  e of PENDING_BYT
17c0: 45 20 72 65 73 75 6c 74 73 20 69 6e 20 61 20 73  E results in a s
17d0: 75 62 74 6c 79 20 69 6e 63 6f 6d 70 61 74 69 62  ubtly incompatib
17e0: 6c 65 0a 2a 2a 20 66 69 6c 65 20 66 6f 72 6d 61  le.** file forma
17f0: 74 2e 20 20 44 65 70 65 6e 64 69 6e 67 20 6f 6e  t.  Depending on
1800: 20 68 6f 77 20 69 74 20 69 73 20 63 68 61 6e 67   how it is chang
1810: 65 64 2c 20 79 6f 75 20 6d 69 67 68 74 20 6e 6f  ed, you might no
1820: 74 20 6e 6f 74 69 63 65 0a 2a 2a 20 74 68 65 20  t notice.** the 
1830: 69 6e 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 20  incompatibility 
1840: 72 69 67 68 74 20 61 77 61 79 2c 20 65 76 65 6e  right away, even
1850: 20 72 75 6e 6e 69 6e 67 20 61 20 66 75 6c 6c 20   running a full 
1860: 72 65 67 72 65 73 73 69 6f 6e 20 74 65 73 74 2e  regression test.
1870: 0a 2a 2a 20 54 68 65 20 64 65 66 61 75 6c 74 20  .** The default 
1880: 6c 6f 63 61 74 69 6f 6e 20 6f 66 20 50 45 4e 44  location of PEND
1890: 49 4e 47 5f 42 59 54 45 20 69 73 20 74 68 65 20  ING_BYTE is the 
18a0: 66 69 72 73 74 20 62 79 74 65 20 70 61 73 74 20  first byte past 
18b0: 74 68 65 0a 2a 2a 20 31 47 42 20 62 6f 75 6e 64  the.** 1GB bound
18c0: 61 72 79 2e 0a 2a 2a 0a 2a 2f 0a 23 69 66 6e 64  ary..**.*/.#ifnd
18d0: 65 66 20 53 51 4c 49 54 45 5f 54 45 53 54 0a 23  ef SQLITE_TEST.#
18e0: 64 65 66 69 6e 65 20 50 45 4e 44 49 4e 47 5f 42  define PENDING_B
18f0: 59 54 45 20 20 20 20 20 20 30 78 34 30 30 30 30  YTE      0x40000
1900: 30 30 30 20 20 2f 2a 20 46 69 72 73 74 20 62 79  000  /* First by
1910: 74 65 20 70 61 73 74 20 74 68 65 20 31 47 42 20  te past the 1GB 
1920: 62 6f 75 6e 64 61 72 79 20 2a 2f 0a 23 65 6c 73  boundary */.#els
1930: 65 0a 65 78 74 65 72 6e 20 75 6e 73 69 67 6e 65  e.extern unsigne
1940: 64 20 69 6e 74 20 73 71 6c 69 74 65 33 5f 70 65  d int sqlite3_pe
1950: 6e 64 69 6e 67 5f 62 79 74 65 3b 0a 23 64 65 66  nding_byte;.#def
1960: 69 6e 65 20 50 45 4e 44 49 4e 47 5f 42 59 54 45  ine PENDING_BYTE
1970: 20 73 71 6c 69 74 65 33 5f 70 65 6e 64 69 6e 67   sqlite3_pending
1980: 5f 62 79 74 65 0a 23 65 6e 64 69 66 0a 0a 23 64  _byte.#endif..#d
1990: 65 66 69 6e 65 20 52 45 53 45 52 56 45 44 5f 42  efine RESERVED_B
19a0: 59 54 45 20 20 20 20 20 28 50 45 4e 44 49 4e 47  YTE     (PENDING
19b0: 5f 42 59 54 45 2b 31 29 0a 23 64 65 66 69 6e 65  _BYTE+1).#define
19c0: 20 53 48 41 52 45 44 5f 46 49 52 53 54 20 20 20   SHARED_FIRST   
19d0: 20 20 20 28 50 45 4e 44 49 4e 47 5f 42 59 54 45     (PENDING_BYTE
19e0: 2b 32 29 0a 23 64 65 66 69 6e 65 20 53 48 41 52  +2).#define SHAR
19f0: 45 44 5f 53 49 5a 45 20 20 20 20 20 20 20 35 31  ED_SIZE       51
1a00: 30 0a 0a 2f 2a 0a 2a 2a 20 41 20 73 69 6e 67 6c  0../*.** A singl
1a10: 65 20 67 6c 6f 62 61 6c 20 69 6e 73 74 61 6e 63  e global instanc
1a20: 65 20 6f 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69  e of the followi
1a30: 6e 67 20 73 74 72 75 63 74 75 72 65 20 68 6f 6c  ng structure hol
1a40: 64 73 20 70 6f 69 6e 74 65 72 73 20 74 6f 20 74  ds pointers to t
1a50: 68 65 0a 2a 2a 20 76 61 72 69 6f 75 73 20 64 69  he.** various di
1a60: 73 6b 20 49 2f 4f 20 72 6f 75 74 69 6e 65 73 2e  sk I/O routines.
1a70: 0a 2a 2f 0a 65 78 74 65 72 6e 20 73 74 72 75 63  .*/.extern struc
1a80: 74 20 73 71 6c 69 74 65 33 49 6f 56 74 62 6c 20  t sqlite3IoVtbl 
1a90: 7b 0a 20 20 69 6e 74 20 28 2a 78 44 65 6c 65 74  {.  int (*xDelet
1aa0: 65 29 28 63 6f 6e 73 74 20 63 68 61 72 2a 29 3b  e)(const char*);
1ab0: 0a 20 20 69 6e 74 20 28 2a 78 46 69 6c 65 45 78  .  int (*xFileEx
1ac0: 69 73 74 73 29 28 63 6f 6e 73 74 20 63 68 61 72  ists)(const char
1ad0: 2a 29 3b 0a 20 20 69 6e 74 20 28 2a 78 4f 70 65  *);.  int (*xOpe
1ae0: 6e 52 65 61 64 57 72 69 74 65 29 28 63 6f 6e 73  nReadWrite)(cons
1af0: 74 20 63 68 61 72 2a 2c 20 4f 73 46 69 6c 65 2a  t char*, OsFile*
1b00: 2a 2c 20 69 6e 74 2a 29 3b 0a 20 20 69 6e 74 20  *, int*);.  int 
1b10: 28 2a 78 4f 70 65 6e 45 78 63 6c 75 73 69 76 65  (*xOpenExclusive
1b20: 29 28 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 4f  )(const char*, O
1b30: 73 46 69 6c 65 2a 2a 2c 20 69 6e 74 29 3b 0a 20  sFile**, int);. 
1b40: 20 69 6e 74 20 28 2a 78 4f 70 65 6e 52 65 61 64   int (*xOpenRead
1b50: 4f 6e 6c 79 29 28 63 6f 6e 73 74 20 63 68 61 72  Only)(const char
1b60: 2a 2c 20 4f 73 46 69 6c 65 2a 2a 29 3b 0a 20 20  *, OsFile**);.  
1b70: 69 6e 74 20 28 2a 78 4f 70 65 6e 44 69 72 65 63  int (*xOpenDirec
1b80: 74 6f 72 79 29 28 63 6f 6e 73 74 20 63 68 61 72  tory)(const char
1b90: 2a 2c 20 4f 73 46 69 6c 65 2a 29 3b 0a 20 20 69  *, OsFile*);.  i
1ba0: 6e 74 20 28 2a 78 53 79 6e 63 44 69 72 65 63 74  nt (*xSyncDirect
1bb0: 6f 72 79 29 28 63 6f 6e 73 74 20 63 68 61 72 2a  ory)(const char*
1bc0: 29 3b 0a 20 20 69 6e 74 20 28 2a 78 54 65 6d 70  );.  int (*xTemp
1bd0: 46 69 6c 65 4e 61 6d 65 29 28 63 68 61 72 2a 29  FileName)(char*)
1be0: 3b 0a 20 20 69 6e 74 20 28 2a 78 49 73 44 69 72  ;.  int (*xIsDir
1bf0: 57 72 69 74 61 62 6c 65 29 28 63 68 61 72 2a 29  Writable)(char*)
1c00: 3b 0a 20 20 69 6e 74 20 28 2a 78 43 6c 6f 73 65  ;.  int (*xClose
1c10: 29 28 4f 73 46 69 6c 65 2a 2a 29 3b 0a 20 20 69  )(OsFile**);.  i
1c20: 6e 74 20 28 2a 78 52 65 61 64 29 28 4f 73 46 69  nt (*xRead)(OsFi
1c30: 6c 65 2a 2c 20 76 6f 69 64 2a 2c 20 69 6e 74 20  le*, void*, int 
1c40: 61 6d 74 29 3b 0a 20 20 69 6e 74 20 28 2a 78 57  amt);.  int (*xW
1c50: 72 69 74 65 29 28 4f 73 46 69 6c 65 2a 2c 20 63  rite)(OsFile*, c
1c60: 6f 6e 73 74 20 76 6f 69 64 2a 2c 20 69 6e 74 20  onst void*, int 
1c70: 61 6d 74 29 3b 0a 20 20 69 6e 74 20 28 2a 78 53  amt);.  int (*xS
1c80: 65 65 6b 29 28 4f 73 46 69 6c 65 2a 2c 20 69 36  eek)(OsFile*, i6
1c90: 34 20 6f 66 66 73 65 74 29 3b 0a 20 20 69 6e 74  4 offset);.  int
1ca0: 20 28 2a 78 53 79 6e 63 29 28 4f 73 46 69 6c 65   (*xSync)(OsFile
1cb0: 2a 2c 20 69 6e 74 29 3b 0a 20 20 69 6e 74 20 28  *, int);.  int (
1cc0: 2a 78 54 72 75 6e 63 61 74 65 29 28 4f 73 46 69  *xTruncate)(OsFi
1cd0: 6c 65 2a 2c 20 69 36 34 20 73 69 7a 65 29 3b 0a  le*, i64 size);.
1ce0: 20 20 69 6e 74 20 28 2a 78 46 69 6c 65 53 69 7a    int (*xFileSiz
1cf0: 65 29 28 4f 73 46 69 6c 65 2a 2c 20 69 36 34 20  e)(OsFile*, i64 
1d00: 2a 70 53 69 7a 65 29 3b 0a 20 20 63 68 61 72 20  *pSize);.  char 
1d10: 2a 28 2a 78 46 75 6c 6c 50 61 74 68 6e 61 6d 65  *(*xFullPathname
1d20: 29 28 63 6f 6e 73 74 20 63 68 61 72 2a 29 3b 0a  )(const char*);.
1d30: 20 20 69 6e 74 20 28 2a 78 4c 6f 63 6b 29 28 4f    int (*xLock)(O
1d40: 73 46 69 6c 65 2a 2c 20 69 6e 74 29 3b 0a 20 20  sFile*, int);.  
1d50: 69 6e 74 20 28 2a 78 55 6e 6c 6f 63 6b 29 28 4f  int (*xUnlock)(O
1d60: 73 46 69 6c 65 2a 2c 20 69 6e 74 29 3b 0a 20 20  sFile*, int);.  
1d70: 69 6e 74 20 28 2a 78 43 68 65 63 6b 52 65 73 65  int (*xCheckRese
1d80: 72 76 65 64 4c 6f 63 6b 29 28 4f 73 46 69 6c 65  rvedLock)(OsFile
1d90: 20 2a 69 64 29 3b 0a 20 20 76 6f 69 64 20 28 2a   *id);.  void (*
1da0: 78 53 65 74 46 75 6c 6c 53 79 6e 63 29 28 4f 73  xSetFullSync)(Os
1db0: 46 69 6c 65 20 2a 69 64 2c 20 69 6e 74 20 73 65  File *id, int se
1dc0: 74 74 69 6e 67 29 3b 0a 20 20 69 6e 74 20 28 2a  tting);.  int (*
1dd0: 78 46 69 6c 65 48 61 6e 64 6c 65 29 28 4f 73 46  xFileHandle)(OsF
1de0: 69 6c 65 20 2a 69 64 29 3b 0a 20 20 69 6e 74 20  ile *id);.  int 
1df0: 28 2a 78 4c 6f 63 6b 53 74 61 74 65 29 28 4f 73  (*xLockState)(Os
1e00: 46 69 6c 65 20 2a 69 64 29 3b 0a 7d 20 73 71 6c  File *id);.} sql
1e10: 69 74 65 33 49 6f 3b 0a 0a 2f 2a 20 54 68 65 20  ite3Io;../* The 
1e20: 69 6e 74 65 72 66 61 63 65 20 66 6f 72 20 66 69  interface for fi
1e30: 6c 65 20 49 2f 4f 20 69 73 20 61 62 6f 76 65 2e  le I/O is above.
1e40: 20 20 4f 74 68 65 72 20 6d 69 73 63 65 6c 6c 61    Other miscella
1e50: 6e 65 6f 75 73 20 66 75 6e 63 74 69 6f 6e 73 0a  neous functions.
1e60: 2a 2a 20 61 72 65 20 62 65 6c 6f 77 20 2a 2f 0a  ** are below */.
1e70: 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 52 61  .int sqlite3OsRa
1e80: 6e 64 6f 6d 53 65 65 64 28 63 68 61 72 2a 29 3b  ndomSeed(char*);
1e90: 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 53 6c  .int sqlite3OsSl
1ea0: 65 65 70 28 69 6e 74 20 6d 73 29 3b 0a 69 6e 74  eep(int ms);.int
1eb0: 20 73 71 6c 69 74 65 33 4f 73 43 75 72 72 65 6e   sqlite3OsCurren
1ec0: 74 54 69 6d 65 28 64 6f 75 62 6c 65 2a 29 3b 0a  tTime(double*);.
1ed0: 76 6f 69 64 20 73 71 6c 69 74 65 33 4f 73 45 6e  void sqlite3OsEn
1ee0: 74 65 72 4d 75 74 65 78 28 76 6f 69 64 29 3b 0a  terMutex(void);.
1ef0: 76 6f 69 64 20 73 71 6c 69 74 65 33 4f 73 4c 65  void sqlite3OsLe
1f00: 61 76 65 4d 75 74 65 78 28 76 6f 69 64 29 3b 0a  aveMutex(void);.
1f10: 0a 0a 23 65 6e 64 69 66 20 2f 2a 20 5f 53 51 4c  ..#endif /* _SQL
1f20: 49 54 45 5f 4f 53 5f 48 5f 20 2a 2f 0a           ITE_OS_H_ */.