/ Hex Artifact Content
Login

Artifact cd8fd6545d6a936bae05026136324ec8e620c7f8:


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 2a 0a 2a  ws systems..**.*
0250: 2a 20 54 68 69 73 20 68 65 61 64 65 72 20 66 69  * This header fi
0260: 6c 65 20 69 73 20 23 69 6e 63 6c 75 64 65 2d 65  le is #include-e
0270: 64 20 62 79 20 73 71 6c 69 74 65 49 6e 74 2e 68  d by sqliteInt.h
0280: 20 61 6e 64 20 74 68 75 73 20 65 6e 64 73 20 75   and thus ends u
0290: 70 0a 2a 2a 20 62 65 69 6e 67 20 69 6e 63 6c 75  p.** being inclu
02a0: 64 65 64 20 62 79 20 65 76 65 72 79 20 73 6f 75  ded by every sou
02b0: 72 63 65 20 66 69 6c 65 2e 0a 2a 2f 0a 23 69 66  rce file..*/.#if
02c0: 6e 64 65 66 20 5f 53 51 4c 49 54 45 5f 4f 53 5f  ndef _SQLITE_OS_
02d0: 48 5f 0a 23 64 65 66 69 6e 65 20 5f 53 51 4c 49  H_.#define _SQLI
02e0: 54 45 5f 4f 53 5f 48 5f 0a 0a 2f 2a 0a 2a 2a 20  TE_OS_H_../*.** 
02f0: 46 69 67 75 72 65 20 6f 75 74 20 69 66 20 77 65  Figure out if we
0300: 20 61 72 65 20 64 65 61 6c 69 6e 67 20 77 69 74   are dealing wit
0310: 68 20 55 6e 69 78 2c 20 57 69 6e 64 6f 77 73 2c  h Unix, Windows,
0320: 20 6f 72 20 73 6f 6d 65 20 6f 74 68 65 72 0a 2a   or some other.*
0330: 2a 20 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74  * operating syst
0340: 65 6d 2e 20 20 41 66 74 65 72 20 74 68 65 20 66  em.  After the f
0350: 6f 6c 6c 6f 77 69 6e 67 20 62 6c 6f 63 6b 20 6f  ollowing block o
0360: 66 20 70 72 65 70 72 6f 63 65 73 73 20 6d 61 63  f preprocess mac
0370: 72 6f 73 2c 0a 2a 2a 20 61 6c 6c 20 6f 66 20 53  ros,.** all of S
0380: 51 4c 49 54 45 5f 4f 53 5f 55 4e 49 58 2c 20 53  QLITE_OS_UNIX, S
0390: 51 4c 49 54 45 5f 4f 53 5f 57 49 4e 2c 20 61 6e  QLITE_OS_WIN, an
03a0: 64 20 53 51 4c 49 54 45 5f 4f 53 5f 4f 54 48 45  d SQLITE_OS_OTHE
03b0: 52 20 0a 2a 2a 20 77 69 6c 6c 20 64 65 66 69 6e  R .** will defin
03c0: 65 64 20 74 6f 20 65 69 74 68 65 72 20 31 20 6f  ed to either 1 o
03d0: 72 20 30 2e 20 20 4f 6e 65 20 6f 66 20 74 68 65  r 0.  One of the
03e0: 20 66 6f 75 72 20 77 69 6c 6c 20 62 65 20 31 2e   four will be 1.
03f0: 20 20 54 68 65 20 6f 74 68 65 72 20 0a 2a 2a 20    The other .** 
0400: 74 68 72 65 65 20 77 69 6c 6c 20 62 65 20 30 2e  three will be 0.
0410: 0a 2a 2f 0a 23 69 66 20 64 65 66 69 6e 65 64 28  .*/.#if defined(
0420: 53 51 4c 49 54 45 5f 4f 53 5f 4f 54 48 45 52 29  SQLITE_OS_OTHER)
0430: 0a 23 20 69 66 20 53 51 4c 49 54 45 5f 4f 53 5f  .# if SQLITE_OS_
0440: 4f 54 48 45 52 3d 3d 31 0a 23 20 20 20 75 6e 64  OTHER==1.#   und
0450: 65 66 20 53 51 4c 49 54 45 5f 4f 53 5f 55 4e 49  ef SQLITE_OS_UNI
0460: 58 0a 23 20 20 20 64 65 66 69 6e 65 20 53 51 4c  X.#   define SQL
0470: 49 54 45 5f 4f 53 5f 55 4e 49 58 20 30 0a 23 20  ITE_OS_UNIX 0.# 
0480: 20 20 75 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f    undef SQLITE_O
0490: 53 5f 57 49 4e 0a 23 20 20 20 64 65 66 69 6e 65  S_WIN.#   define
04a0: 20 53 51 4c 49 54 45 5f 4f 53 5f 57 49 4e 20 30   SQLITE_OS_WIN 0
04b0: 0a 23 20 65 6c 73 65 0a 23 20 20 20 75 6e 64 65  .# else.#   unde
04c0: 66 20 53 51 4c 49 54 45 5f 4f 53 5f 4f 54 48 45  f SQLITE_OS_OTHE
04d0: 52 0a 23 20 65 6e 64 69 66 0a 23 65 6e 64 69 66  R.# endif.#endif
04e0: 0a 23 69 66 20 21 64 65 66 69 6e 65 64 28 53 51  .#if !defined(SQ
04f0: 4c 49 54 45 5f 4f 53 5f 55 4e 49 58 29 20 26 26  LITE_OS_UNIX) &&
0500: 20 21 64 65 66 69 6e 65 64 28 53 51 4c 49 54 45   !defined(SQLITE
0510: 5f 4f 53 5f 4f 54 48 45 52 29 0a 23 20 64 65 66  _OS_OTHER).# def
0520: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 53 5f 4f 54  ine SQLITE_OS_OT
0530: 48 45 52 20 30 0a 23 20 69 66 6e 64 65 66 20 53  HER 0.# ifndef S
0540: 51 4c 49 54 45 5f 4f 53 5f 57 49 4e 0a 23 20 20  QLITE_OS_WIN.#  
0550: 20 69 66 20 64 65 66 69 6e 65 64 28 5f 57 49 4e   if defined(_WIN
0560: 33 32 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 57  32) || defined(W
0570: 49 4e 33 32 29 20 7c 7c 20 64 65 66 69 6e 65 64  IN32) || defined
0580: 28 5f 5f 43 59 47 57 49 4e 5f 5f 29 20 7c 7c 20  (__CYGWIN__) || 
0590: 64 65 66 69 6e 65 64 28 5f 5f 4d 49 4e 47 57 33  defined(__MINGW3
05a0: 32 5f 5f 29 20 7c 7c 20 64 65 66 69 6e 65 64 28  2__) || defined(
05b0: 5f 5f 42 4f 52 4c 41 4e 44 43 5f 5f 29 0a 23 20  __BORLANDC__).# 
05c0: 20 20 20 20 64 65 66 69 6e 65 20 53 51 4c 49 54      define SQLIT
05d0: 45 5f 4f 53 5f 57 49 4e 20 31 0a 23 20 20 20 20  E_OS_WIN 1.#    
05e0: 20 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f   define SQLITE_O
05f0: 53 5f 55 4e 49 58 20 30 0a 23 20 20 20 65 6c 73  S_UNIX 0.#   els
0600: 65 0a 23 20 20 20 20 20 64 65 66 69 6e 65 20 53  e.#     define S
0610: 51 4c 49 54 45 5f 4f 53 5f 57 49 4e 20 30 0a 23  QLITE_OS_WIN 0.#
0620: 20 20 20 20 20 64 65 66 69 6e 65 20 53 51 4c 49       define SQLI
0630: 54 45 5f 4f 53 5f 55 4e 49 58 20 31 0a 23 20 20  TE_OS_UNIX 1.#  
0640: 65 6e 64 69 66 0a 23 20 65 6c 73 65 0a 23 20 20  endif.# else.#  
0650: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 53  define SQLITE_OS
0660: 5f 55 4e 49 58 20 30 0a 23 20 65 6e 64 69 66 0a  _UNIX 0.# endif.
0670: 23 65 6c 73 65 0a 23 20 69 66 6e 64 65 66 20 53  #else.# ifndef S
0680: 51 4c 49 54 45 5f 4f 53 5f 57 49 4e 0a 23 20 20  QLITE_OS_WIN.#  
0690: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 53  define SQLITE_OS
06a0: 5f 57 49 4e 20 30 0a 23 20 65 6e 64 69 66 0a 23  _WIN 0.# endif.#
06b0: 65 6e 64 69 66 0a 0a 2f 2a 20 49 66 20 74 68 65  endif../* If the
06c0: 20 53 45 54 5f 46 55 4c 4c 53 59 4e 43 20 6d 61   SET_FULLSYNC ma
06d0: 63 72 6f 20 69 73 20 6e 6f 74 20 64 65 66 69 6e  cro is not defin
06e0: 65 64 20 61 62 6f 76 65 2c 20 74 68 65 6e 20 6d  ed above, then m
06f0: 61 6b 65 20 69 74 0a 2a 2a 20 61 20 6e 6f 2d 6f  ake it.** a no-o
0700: 70 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 53 45 54  p.*/.#ifndef SET
0710: 5f 46 55 4c 4c 53 59 4e 43 0a 23 20 64 65 66 69  _FULLSYNC.# defi
0720: 6e 65 20 53 45 54 5f 46 55 4c 4c 53 59 4e 43 28  ne SET_FULLSYNC(
0730: 78 2c 79 29 0a 23 65 6e 64 69 66 0a 0a 2f 2a 0a  x,y).#endif../*.
0740: 2a 2a 20 54 68 65 20 64 65 66 61 75 6c 74 20 73  ** The default s
0750: 69 7a 65 20 6f 66 20 61 20 64 69 73 6b 20 73 65  ize of a disk se
0760: 63 74 6f 72 0a 2a 2f 0a 23 69 66 6e 64 65 66 20  ctor.*/.#ifndef 
0770: 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 53  SQLITE_DEFAULT_S
0780: 45 43 54 4f 52 5f 53 49 5a 45 0a 23 20 64 65 66  ECTOR_SIZE.# def
0790: 69 6e 65 20 53 51 4c 49 54 45 5f 44 45 46 41 55  ine SQLITE_DEFAU
07a0: 4c 54 5f 53 45 43 54 4f 52 5f 53 49 5a 45 20 34  LT_SECTOR_SIZE 4
07b0: 30 39 36 0a 23 65 6e 64 69 66 0a 0a 2f 2a 0a 2a  096.#endif../*.*
07c0: 2a 20 54 65 6d 70 6f 72 61 72 79 20 66 69 6c 65  * Temporary file
07d0: 73 20 61 72 65 20 6e 61 6d 65 64 20 73 74 61 72  s are named star
07e0: 74 69 6e 67 20 77 69 74 68 20 74 68 69 73 20 70  ting with this p
07f0: 72 65 66 69 78 20 66 6f 6c 6c 6f 77 65 64 20 62  refix followed b
0800: 79 20 31 36 20 72 61 6e 64 6f 6d 0a 2a 2a 20 61  y 16 random.** a
0810: 6c 70 68 61 6e 75 6d 65 72 69 63 20 63 68 61 72  lphanumeric char
0820: 61 63 74 65 72 73 2c 20 61 6e 64 20 6e 6f 20 66  acters, and no f
0830: 69 6c 65 20 65 78 74 65 6e 73 69 6f 6e 2e 20 54  ile extension. T
0840: 68 65 79 20 61 72 65 20 73 74 6f 72 65 64 20 69  hey are stored i
0850: 6e 20 74 68 65 0a 2a 2a 20 4f 53 27 73 20 73 74  n the.** OS's st
0860: 61 6e 64 61 72 64 20 74 65 6d 70 6f 72 61 72 79  andard temporary
0870: 20 66 69 6c 65 20 64 69 72 65 63 74 6f 72 79 2c   file directory,
0880: 20 61 6e 64 20 61 72 65 20 64 65 6c 65 74 65 64   and are deleted
0890: 20 70 72 69 6f 72 20 74 6f 20 65 78 69 74 2e 0a   prior to exit..
08a0: 2a 2a 20 49 66 20 73 71 6c 69 74 65 20 69 73 20  ** If sqlite is 
08b0: 62 65 69 6e 67 20 65 6d 62 65 64 64 65 64 20 69  being embedded i
08c0: 6e 20 61 6e 6f 74 68 65 72 20 70 72 6f 67 72 61  n another progra
08d0: 6d 2c 20 79 6f 75 20 6d 61 79 20 77 69 73 68 20  m, you may wish 
08e0: 74 6f 20 63 68 61 6e 67 65 20 74 68 65 0a 2a 2a  to change the.**
08f0: 20 70 72 65 66 69 78 20 74 6f 20 72 65 66 6c 65   prefix to refle
0900: 63 74 20 79 6f 75 72 20 70 72 6f 67 72 61 6d 27  ct your program'
0910: 73 20 6e 61 6d 65 2c 20 73 6f 20 74 68 61 74 20  s name, so that 
0920: 69 66 20 79 6f 75 72 20 70 72 6f 67 72 61 6d 20  if your program 
0930: 65 78 69 74 73 0a 2a 2a 20 70 72 65 6d 61 74 75  exits.** prematu
0940: 72 65 6c 79 2c 20 6f 6c 64 20 74 65 6d 70 6f 72  rely, old tempor
0950: 61 72 79 20 66 69 6c 65 73 20 63 61 6e 20 62 65  ary files can be
0960: 20 65 61 73 69 6c 79 20 69 64 65 6e 74 69 66 69   easily identifi
0970: 65 64 2e 20 54 68 69 73 20 63 61 6e 20 62 65 20  ed. This can be 
0980: 64 6f 6e 65 0a 2a 2a 20 75 73 69 6e 67 20 2d 44  done.** using -D
0990: 53 51 4c 49 54 45 5f 54 45 4d 50 5f 46 49 4c 45  SQLITE_TEMP_FILE
09a0: 5f 50 52 45 46 49 58 3d 6d 79 70 72 65 66 69 78  _PREFIX=myprefix
09b0: 5f 20 6f 6e 20 74 68 65 20 63 6f 6d 70 69 6c 65  _ on the compile
09c0: 72 20 63 6f 6d 6d 61 6e 64 20 6c 69 6e 65 2e 0a  r command line..
09d0: 2a 2a 0a 2a 2a 20 32 30 30 36 2d 31 30 2d 33 31  **.** 2006-10-31
09e0: 3a 20 20 54 68 65 20 64 65 66 61 75 6c 74 20 70  :  The default p
09f0: 72 65 66 69 78 20 75 73 65 64 20 74 6f 20 62 65  refix used to be
0a00: 20 22 73 71 6c 69 74 65 5f 22 2e 20 20 42 75 74   "sqlite_".  But
0a10: 20 74 68 65 6e 0a 2a 2a 20 4d 63 61 66 65 65 20   then.** Mcafee 
0a20: 73 74 61 72 74 65 64 20 75 73 69 6e 67 20 53 51  started using SQ
0a30: 4c 69 74 65 20 69 6e 20 74 68 65 69 72 20 61 6e  Lite in their an
0a40: 74 69 2d 76 69 72 75 73 20 70 72 6f 64 75 63 74  ti-virus product
0a50: 20 61 6e 64 20 69 74 0a 2a 2a 20 73 74 61 72 74   and it.** start
0a60: 65 64 20 70 75 74 74 69 6e 67 20 66 69 6c 65 73  ed putting files
0a70: 20 77 69 74 68 20 74 68 65 20 22 73 71 6c 69 74   with the "sqlit
0a80: 65 22 20 6e 61 6d 65 20 69 6e 20 74 68 65 20 63  e" name in the c
0a90: 3a 2f 74 65 6d 70 20 66 6f 6c 64 65 72 2e 0a 2a  :/temp folder..*
0aa0: 2a 20 54 68 69 73 20 61 6e 6e 6f 79 65 64 20 6d  * This annoyed m
0ab0: 61 6e 79 20 77 69 6e 64 6f 77 73 20 75 73 65 72  any windows user
0ac0: 73 2e 20 20 54 68 6f 73 65 20 75 73 65 72 73 20  s.  Those users 
0ad0: 77 6f 75 6c 64 20 74 68 65 6e 20 64 6f 20 61 20  would then do a 
0ae0: 0a 2a 2a 20 47 6f 6f 67 6c 65 20 73 65 61 72 63  .** Google searc
0af0: 68 20 66 6f 72 20 22 73 71 6c 69 74 65 22 2c 20  h for "sqlite", 
0b00: 66 69 6e 64 20 74 68 65 20 74 65 6c 65 70 68 6f  find the telepho
0b10: 6e 65 20 6e 75 6d 62 65 72 73 20 6f 66 20 74 68  ne numbers of th
0b20: 65 0a 2a 2a 20 64 65 76 65 6c 6f 70 65 72 73 20  e.** developers 
0b30: 61 6e 64 20 63 61 6c 6c 20 74 6f 20 77 61 6b 65  and call to wake
0b40: 20 74 68 65 6d 20 75 70 20 61 74 20 6e 69 67 68   them up at nigh
0b50: 74 20 61 6e 64 20 63 6f 6d 70 6c 61 69 6e 2e 0a  t and complain..
0b60: 2a 2a 20 46 6f 72 20 74 68 69 73 20 72 65 61 73  ** For this reas
0b70: 6f 6e 2c 20 74 68 65 20 64 65 66 61 75 6c 74 20  on, the default 
0b80: 6e 61 6d 65 20 70 72 65 66 69 78 20 69 73 20 63  name prefix is c
0b90: 68 61 6e 67 65 64 20 74 6f 20 62 65 20 22 73 71  hanged to be "sq
0ba0: 6c 69 74 65 22 20 0a 2a 2a 20 73 70 65 6c 6c 65  lite" .** spelle
0bb0: 64 20 62 61 63 6b 77 61 72 64 73 2e 20 20 53 6f  d backwards.  So
0bc0: 20 74 68 65 20 74 65 6d 70 20 66 69 6c 65 73 20   the temp files 
0bd0: 61 72 65 20 73 74 69 6c 6c 20 69 64 65 6e 74 69  are still identi
0be0: 66 69 65 64 2c 20 62 75 74 0a 2a 2a 20 61 6e 79  fied, but.** any
0bf0: 62 6f 64 79 20 73 6d 61 72 74 20 65 6e 6f 75 67  body smart enoug
0c00: 68 20 74 6f 20 66 69 67 75 72 65 20 6f 75 74 20  h to figure out 
0c10: 74 68 65 20 63 6f 64 65 20 69 73 20 61 6c 73 6f  the code is also
0c20: 20 6c 69 6b 65 6c 79 20 73 6d 61 72 74 0a 2a 2a   likely smart.**
0c30: 20 65 6e 6f 75 67 68 20 74 6f 20 6b 6e 6f 77 20   enough to know 
0c40: 74 68 61 74 20 63 61 6c 6c 69 6e 67 20 74 68 65  that calling the
0c50: 20 64 65 76 65 6c 6f 70 65 72 20 77 69 6c 6c 20   developer will 
0c60: 6e 6f 74 20 68 65 6c 70 20 67 65 74 20 72 69 64  not help get rid
0c70: 0a 2a 2a 20 6f 66 20 74 68 65 20 66 69 6c 65 2e  .** of the file.
0c80: 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 53 51 4c 49  .*/.#ifndef SQLI
0c90: 54 45 5f 54 45 4d 50 5f 46 49 4c 45 5f 50 52 45  TE_TEMP_FILE_PRE
0ca0: 46 49 58 0a 23 20 64 65 66 69 6e 65 20 53 51 4c  FIX.# define SQL
0cb0: 49 54 45 5f 54 45 4d 50 5f 46 49 4c 45 5f 50 52  ITE_TEMP_FILE_PR
0cc0: 45 46 49 58 20 22 65 74 69 6c 71 73 5f 22 0a 23  EFIX "etilqs_".#
0cd0: 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 54 68 65  endif../*.** The
0ce0: 20 66 6f 6c 6c 6f 77 69 6e 67 20 76 61 6c 75 65   following value
0cf0: 73 20 6d 61 79 20 62 65 20 70 61 73 73 65 64 20  s may be passed 
0d00: 61 73 20 74 68 65 20 73 65 63 6f 6e 64 20 61 72  as the second ar
0d10: 67 75 6d 65 6e 74 20 74 6f 0a 2a 2a 20 73 71 6c  gument to.** sql
0d20: 69 74 65 33 4f 73 4c 6f 63 6b 28 29 2e 20 54 68  ite3OsLock(). Th
0d30: 65 20 76 61 72 69 6f 75 73 20 6c 6f 63 6b 73 20  e various locks 
0d40: 65 78 68 69 62 69 74 20 74 68 65 20 66 6f 6c 6c  exhibit the foll
0d50: 6f 77 69 6e 67 20 73 65 6d 61 6e 74 69 63 73 3a  owing semantics:
0d60: 0a 2a 2a 0a 2a 2a 20 53 48 41 52 45 44 3a 20 20  .**.** SHARED:  
0d70: 20 20 41 6e 79 20 6e 75 6d 62 65 72 20 6f 66 20    Any number of 
0d80: 70 72 6f 63 65 73 73 65 73 20 6d 61 79 20 68 6f  processes may ho
0d90: 6c 64 20 61 20 53 48 41 52 45 44 20 6c 6f 63 6b  ld a SHARED lock
0da0: 20 73 69 6d 75 6c 74 61 6e 65 6f 75 73 6c 79 2e   simultaneously.
0db0: 0a 2a 2a 20 52 45 53 45 52 56 45 44 3a 20 20 41  .** RESERVED:  A
0dc0: 20 73 69 6e 67 6c 65 20 70 72 6f 63 65 73 73 20   single process 
0dd0: 6d 61 79 20 68 6f 6c 64 20 61 20 52 45 53 45 52  may hold a RESER
0de0: 56 45 44 20 6c 6f 63 6b 20 6f 6e 20 61 20 66 69  VED lock on a fi
0df0: 6c 65 20 61 74 0a 2a 2a 20 20 20 20 20 20 20 20  le at.**        
0e00: 20 20 20 20 61 6e 79 20 74 69 6d 65 2e 20 4f 74      any time. Ot
0e10: 68 65 72 20 70 72 6f 63 65 73 73 65 73 20 6d 61  her processes ma
0e20: 79 20 68 6f 6c 64 20 61 6e 64 20 6f 62 74 61 69  y hold and obtai
0e30: 6e 20 6e 65 77 20 53 48 41 52 45 44 20 6c 6f 63  n new SHARED loc
0e40: 6b 73 2e 0a 2a 2a 20 50 45 4e 44 49 4e 47 3a 20  ks..** PENDING: 
0e50: 20 20 41 20 73 69 6e 67 6c 65 20 70 72 6f 63 65    A single proce
0e60: 73 73 20 6d 61 79 20 68 6f 6c 64 20 61 20 50 45  ss may hold a PE
0e70: 4e 44 49 4e 47 20 6c 6f 63 6b 20 6f 6e 20 61 20  NDING lock on a 
0e80: 66 69 6c 65 20 61 74 0a 2a 2a 20 20 20 20 20 20  file at.**      
0e90: 20 20 20 20 20 20 61 6e 79 20 6f 6e 65 20 74 69        any one ti
0ea0: 6d 65 2e 20 45 78 69 73 74 69 6e 67 20 53 48 41  me. Existing SHA
0eb0: 52 45 44 20 6c 6f 63 6b 73 20 6d 61 79 20 70 65  RED locks may pe
0ec0: 72 73 69 73 74 2c 20 62 75 74 20 6e 6f 20 6e 65  rsist, but no ne
0ed0: 77 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 20 20  w.**            
0ee0: 53 48 41 52 45 44 20 6c 6f 63 6b 73 20 6d 61 79  SHARED locks may
0ef0: 20 62 65 20 6f 62 74 61 69 6e 65 64 20 62 79 20   be obtained by 
0f00: 6f 74 68 65 72 20 70 72 6f 63 65 73 73 65 73 2e  other processes.
0f10: 0a 2a 2a 20 45 58 43 4c 55 53 49 56 45 3a 20 41  .** EXCLUSIVE: A
0f20: 6e 20 45 58 43 4c 55 53 49 56 45 20 6c 6f 63 6b  n EXCLUSIVE lock
0f30: 20 70 72 65 63 6c 75 64 65 73 20 61 6c 6c 20 6f   precludes all o
0f40: 74 68 65 72 20 6c 6f 63 6b 73 2e 0a 2a 2a 0a 2a  ther locks..**.*
0f50: 2a 20 50 45 4e 44 49 4e 47 5f 4c 4f 43 4b 20 6d  * PENDING_LOCK m
0f60: 61 79 20 6e 6f 74 20 62 65 20 70 61 73 73 65 64  ay not be passed
0f70: 20 64 69 72 65 63 74 6c 79 20 74 6f 20 73 71 6c   directly to sql
0f80: 69 74 65 33 4f 73 4c 6f 63 6b 28 29 2e 20 49 6e  ite3OsLock(). In
0f90: 73 74 65 61 64 2c 20 61 0a 2a 2a 20 70 72 6f 63  stead, a.** proc
0fa0: 65 73 73 20 74 68 61 74 20 72 65 71 75 65 73 74  ess that request
0fb0: 73 20 61 6e 20 45 58 43 4c 55 53 49 56 45 20 6c  s an EXCLUSIVE l
0fc0: 6f 63 6b 20 6d 61 79 20 61 63 74 75 61 6c 6c 79  ock may actually
0fd0: 20 6f 62 74 61 69 6e 20 61 20 50 45 4e 44 49 4e   obtain a PENDIN
0fe0: 47 0a 2a 2a 20 6c 6f 63 6b 2e 20 54 68 69 73 20  G.** lock. This 
0ff0: 63 61 6e 20 62 65 20 75 70 67 72 61 64 65 64 20  can be upgraded 
1000: 74 6f 20 61 6e 20 45 58 43 4c 55 53 49 56 45 20  to an EXCLUSIVE 
1010: 6c 6f 63 6b 20 62 79 20 61 20 73 75 62 73 65 71  lock by a subseq
1020: 75 65 6e 74 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20  uent call to.** 
1030: 73 71 6c 69 74 65 33 4f 73 4c 6f 63 6b 28 29 2e  sqlite3OsLock().
1040: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 4e 4f 5f 4c  .*/.#define NO_L
1050: 4f 43 4b 20 20 20 20 20 20 20 20 20 30 0a 23 64  OCK         0.#d
1060: 65 66 69 6e 65 20 53 48 41 52 45 44 5f 4c 4f 43  efine SHARED_LOC
1070: 4b 20 20 20 20 20 31 0a 23 64 65 66 69 6e 65 20  K     1.#define 
1080: 52 45 53 45 52 56 45 44 5f 4c 4f 43 4b 20 20 20  RESERVED_LOCK   
1090: 32 0a 23 64 65 66 69 6e 65 20 50 45 4e 44 49 4e  2.#define PENDIN
10a0: 47 5f 4c 4f 43 4b 20 20 20 20 33 0a 23 64 65 66  G_LOCK    3.#def
10b0: 69 6e 65 20 45 58 43 4c 55 53 49 56 45 5f 4c 4f  ine EXCLUSIVE_LO
10c0: 43 4b 20 20 34 0a 0a 2f 2a 0a 2a 2a 20 46 69 6c  CK  4../*.** Fil
10d0: 65 20 4c 6f 63 6b 69 6e 67 20 4e 6f 74 65 73 3a  e Locking Notes:
10e0: 20 20 28 4d 6f 73 74 6c 79 20 61 62 6f 75 74 20    (Mostly about 
10f0: 77 69 6e 64 6f 77 73 20 62 75 74 20 61 6c 73 6f  windows but also
1100: 20 73 6f 6d 65 20 69 6e 66 6f 20 66 6f 72 20 55   some info for U
1110: 6e 69 78 29 0a 2a 2a 0a 2a 2a 20 57 65 20 63 61  nix).**.** We ca
1120: 6e 6e 6f 74 20 75 73 65 20 4c 6f 63 6b 46 69 6c  nnot use LockFil
1130: 65 45 78 28 29 20 6f 72 20 55 6e 6c 6f 63 6b 46  eEx() or UnlockF
1140: 69 6c 65 45 78 28 29 20 6f 6e 20 57 69 6e 39 35  ileEx() on Win95
1150: 2f 39 38 2f 4d 45 20 62 65 63 61 75 73 65 0a 2a  /98/ME because.*
1160: 2a 20 74 68 6f 73 65 20 66 75 6e 63 74 69 6f 6e  * those function
1170: 73 20 61 72 65 20 6e 6f 74 20 61 76 61 69 6c 61  s are not availa
1180: 62 6c 65 2e 20 20 53 6f 20 77 65 20 75 73 65 20  ble.  So we use 
1190: 6f 6e 6c 79 20 4c 6f 63 6b 46 69 6c 65 28 29 20  only LockFile() 
11a0: 61 6e 64 0a 2a 2a 20 55 6e 6c 6f 63 6b 46 69 6c  and.** UnlockFil
11b0: 65 28 29 2e 0a 2a 2a 0a 2a 2a 20 4c 6f 63 6b 46  e()..**.** LockF
11c0: 69 6c 65 28 29 20 70 72 65 76 65 6e 74 73 20 6e  ile() prevents n
11d0: 6f 74 20 6a 75 73 74 20 77 72 69 74 69 6e 67 20  ot just writing 
11e0: 62 75 74 20 61 6c 73 6f 20 72 65 61 64 69 6e 67  but also reading
11f0: 20 62 79 20 6f 74 68 65 72 20 70 72 6f 63 65 73   by other proces
1200: 73 65 73 2e 0a 2a 2a 20 41 20 53 48 41 52 45 44  ses..** A SHARED
1210: 5f 4c 4f 43 4b 20 69 73 20 6f 62 74 61 69 6e 65  _LOCK is obtaine
1220: 64 20 62 79 20 6c 6f 63 6b 69 6e 67 20 61 20 73  d by locking a s
1230: 69 6e 67 6c 65 20 72 61 6e 64 6f 6d 6c 79 2d 63  ingle randomly-c
1240: 68 6f 73 65 6e 20 0a 2a 2a 20 62 79 74 65 20 6f  hosen .** byte o
1250: 75 74 20 6f 66 20 61 20 73 70 65 63 69 66 69 63  ut of a specific
1260: 20 72 61 6e 67 65 20 6f 66 20 62 79 74 65 73 2e   range of bytes.
1270: 20 54 68 65 20 6c 6f 63 6b 20 62 79 74 65 20 69   The lock byte i
1280: 73 20 6f 62 74 61 69 6e 65 64 20 61 74 20 0a 2a  s obtained at .*
1290: 2a 20 72 61 6e 64 6f 6d 20 73 6f 20 74 77 6f 20  * random so two 
12a0: 73 65 70 61 72 61 74 65 20 72 65 61 64 65 72 73  separate readers
12b0: 20 63 61 6e 20 70 72 6f 62 61 62 6c 79 20 61 63   can probably ac
12c0: 63 65 73 73 20 74 68 65 20 66 69 6c 65 20 61 74  cess the file at
12d0: 20 74 68 65 20 0a 2a 2a 20 73 61 6d 65 20 74 69   the .** same ti
12e0: 6d 65 2c 20 75 6e 6c 65 73 73 20 74 68 65 79 20  me, unless they 
12f0: 61 72 65 20 75 6e 6c 75 63 6b 79 20 61 6e 64 20  are unlucky and 
1300: 63 68 6f 6f 73 65 20 74 68 65 20 73 61 6d 65 20  choose the same 
1310: 6c 6f 63 6b 20 62 79 74 65 2e 0a 2a 2a 20 41 6e  lock byte..** An
1320: 20 45 58 43 4c 55 53 49 56 45 5f 4c 4f 43 4b 20   EXCLUSIVE_LOCK 
1330: 69 73 20 6f 62 74 61 69 6e 65 64 20 62 79 20 6c  is obtained by l
1340: 6f 63 6b 69 6e 67 20 61 6c 6c 20 62 79 74 65 73  ocking all bytes
1350: 20 69 6e 20 74 68 65 20 72 61 6e 67 65 2e 0a 2a   in the range..*
1360: 2a 20 54 68 65 72 65 20 63 61 6e 20 6f 6e 6c 79  * There can only
1370: 20 62 65 20 6f 6e 65 20 77 72 69 74 65 72 2e 20   be one writer. 
1380: 20 41 20 52 45 53 45 52 56 45 44 5f 4c 4f 43 4b   A RESERVED_LOCK
1390: 20 69 73 20 6f 62 74 61 69 6e 65 64 20 62 79 20   is obtained by 
13a0: 6c 6f 63 6b 69 6e 67 0a 2a 2a 20 61 20 73 69 6e  locking.** a sin
13b0: 67 6c 65 20 62 79 74 65 20 6f 66 20 74 68 65 20  gle byte of the 
13c0: 66 69 6c 65 20 74 68 61 74 20 69 73 20 64 65 73  file that is des
13d0: 69 67 6e 61 74 65 64 20 61 73 20 74 68 65 20 72  ignated as the r
13e0: 65 73 65 72 76 65 64 20 6c 6f 63 6b 20 62 79 74  eserved lock byt
13f0: 65 2e 0a 2a 2a 20 41 20 50 45 4e 44 49 4e 47 5f  e..** A PENDING_
1400: 4c 4f 43 4b 20 69 73 20 6f 62 74 61 69 6e 65 64  LOCK is obtained
1410: 20 62 79 20 6c 6f 63 6b 69 6e 67 20 61 20 64 65   by locking a de
1420: 73 69 67 6e 61 74 65 64 20 62 79 74 65 20 64 69  signated byte di
1430: 66 66 65 72 65 6e 74 20 66 72 6f 6d 0a 2a 2a 20  fferent from.** 
1440: 74 68 65 20 52 45 53 45 52 56 45 44 5f 4c 4f 43  the RESERVED_LOC
1450: 4b 20 62 79 74 65 2e 0a 2a 2a 0a 2a 2a 20 4f 6e  K byte..**.** On
1460: 20 57 69 6e 4e 54 2f 32 4b 2f 58 50 20 73 79 73   WinNT/2K/XP sys
1470: 74 65 6d 73 2c 20 4c 6f 63 6b 46 69 6c 65 45 78  tems, LockFileEx
1480: 28 29 20 61 6e 64 20 55 6e 6c 6f 63 6b 46 69 6c  () and UnlockFil
1490: 65 45 78 28 29 20 61 72 65 20 61 76 61 69 6c 61  eEx() are availa
14a0: 62 6c 65 2c 0a 2a 2a 20 77 68 69 63 68 20 6d 65  ble,.** which me
14b0: 61 6e 73 20 77 65 20 63 61 6e 20 75 73 65 20 72  ans we can use r
14c0: 65 61 64 65 72 2f 77 72 69 74 65 72 20 6c 6f 63  eader/writer loc
14d0: 6b 73 2e 20 20 57 68 65 6e 20 72 65 61 64 65 72  ks.  When reader
14e0: 2f 77 72 69 74 65 72 20 6c 6f 63 6b 73 0a 2a 2a  /writer locks.**
14f0: 20 61 72 65 20 75 73 65 64 2c 20 74 68 65 20 6c   are used, the l
1500: 6f 63 6b 20 69 73 20 70 6c 61 63 65 64 20 6f 6e  ock is placed on
1510: 20 74 68 65 20 73 61 6d 65 20 72 61 6e 67 65 20   the same range 
1520: 6f 66 20 62 79 74 65 73 20 74 68 61 74 20 69 73  of bytes that is
1530: 20 75 73 65 64 0a 2a 2a 20 66 6f 72 20 70 72 6f   used.** for pro
1540: 62 61 62 69 6c 69 73 74 69 63 20 6c 6f 63 6b 69  babilistic locki
1550: 6e 67 20 69 6e 20 57 69 6e 39 35 2f 39 38 2f 4d  ng in Win95/98/M
1560: 45 2e 20 20 48 65 6e 63 65 2c 20 74 68 65 20 6c  E.  Hence, the l
1570: 6f 63 6b 69 6e 67 20 73 63 68 65 6d 65 0a 2a 2a  ocking scheme.**
1580: 20 77 69 6c 6c 20 73 75 70 70 6f 72 74 20 74 77   will support tw
1590: 6f 20 6f 72 20 6d 6f 72 65 20 57 69 6e 39 35 20  o or more Win95 
15a0: 72 65 61 64 65 72 73 20 6f 72 20 74 77 6f 20 6f  readers or two o
15b0: 72 20 6d 6f 72 65 20 57 69 6e 4e 54 20 72 65 61  r more WinNT rea
15c0: 64 65 72 73 2e 0a 2a 2a 20 42 75 74 20 61 20 73  ders..** But a s
15d0: 69 6e 67 6c 65 20 57 69 6e 39 35 20 72 65 61 64  ingle Win95 read
15e0: 65 72 20 77 69 6c 6c 20 6c 6f 63 6b 20 6f 75 74  er will lock out
15f0: 20 61 6c 6c 20 57 69 6e 4e 54 20 72 65 61 64 65   all WinNT reade
1600: 72 73 20 61 6e 64 20 61 20 73 69 6e 67 6c 65 0a  rs and a single.
1610: 2a 2a 20 57 69 6e 4e 54 20 72 65 61 64 65 72 20  ** WinNT reader 
1620: 77 69 6c 6c 20 6c 6f 63 6b 20 6f 75 74 20 61 6c  will lock out al
1630: 6c 20 6f 74 68 65 72 20 57 69 6e 39 35 20 72 65  l other Win95 re
1640: 61 64 65 72 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  aders..**.** The
1650: 20 66 6f 6c 6c 6f 77 69 6e 67 20 23 64 65 66 69   following #defi
1660: 6e 65 73 20 73 70 65 63 69 66 79 20 74 68 65 20  nes specify the 
1670: 72 61 6e 67 65 20 6f 66 20 62 79 74 65 73 20 75  range of bytes u
1680: 73 65 64 20 66 6f 72 20 6c 6f 63 6b 69 6e 67 2e  sed for locking.
1690: 0a 2a 2a 20 53 48 41 52 45 44 5f 53 49 5a 45 20  .** SHARED_SIZE 
16a0: 69 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  is the number of
16b0: 20 62 79 74 65 73 20 61 76 61 69 6c 61 62 6c 65   bytes available
16c0: 20 69 6e 20 74 68 65 20 70 6f 6f 6c 20 66 72 6f   in the pool fro
16d0: 6d 20 77 68 69 63 68 0a 2a 2a 20 61 20 72 61 6e  m which.** a ran
16e0: 64 6f 6d 20 62 79 74 65 20 69 73 20 73 65 6c 65  dom byte is sele
16f0: 63 74 65 64 20 66 6f 72 20 61 20 73 68 61 72 65  cted for a share
1700: 64 20 6c 6f 63 6b 2e 20 20 54 68 65 20 70 6f 6f  d lock.  The poo
1710: 6c 20 6f 66 20 62 79 74 65 73 20 66 6f 72 0a 2a  l of bytes for.*
1720: 2a 20 73 68 61 72 65 64 20 6c 6f 63 6b 73 20 62  * shared locks b
1730: 65 67 69 6e 73 20 61 74 20 53 48 41 52 45 44 5f  egins at SHARED_
1740: 46 49 52 53 54 2e 20 0a 2a 2a 0a 2a 2a 20 54 68  FIRST. .**.** Th
1750: 65 20 73 61 6d 65 20 6c 6f 63 6b 69 6e 67 20 73  e same locking s
1760: 74 72 61 74 65 67 79 20 61 6e 64 0a 2a 2a 20 62  trategy and.** b
1770: 79 74 65 20 72 61 6e 67 65 73 20 61 72 65 20 75  yte ranges are u
1780: 73 65 64 20 66 6f 72 20 55 6e 69 78 2e 20 20 54  sed for Unix.  T
1790: 68 69 73 20 6c 65 61 76 65 73 20 6f 70 65 6e 20  his leaves open 
17a0: 74 68 65 20 70 6f 73 73 69 62 6c 69 74 79 20 6f  the possiblity o
17b0: 66 20 68 61 76 69 6e 67 0a 2a 2a 20 63 6c 69 65  f having.** clie
17c0: 6e 74 73 20 6f 6e 20 77 69 6e 39 35 2c 20 77 69  nts on win95, wi
17d0: 6e 4e 54 2c 20 61 6e 64 20 75 6e 69 78 20 61 6c  nNT, and unix al
17e0: 6c 20 74 61 6c 6b 69 6e 67 20 74 6f 20 74 68 65  l talking to the
17f0: 20 73 61 6d 65 20 73 68 61 72 65 64 20 66 69 6c   same shared fil
1800: 65 0a 2a 2a 20 61 6e 64 20 61 6c 6c 20 6c 6f 63  e.** and all loc
1810: 6b 69 6e 67 20 63 6f 72 72 65 63 74 6c 79 2e 20  king correctly. 
1820: 20 54 6f 20 64 6f 20 73 6f 20 77 6f 75 6c 64 20   To do so would 
1830: 72 65 71 75 69 72 65 20 74 68 61 74 20 73 61 6d  require that sam
1840: 62 61 20 28 6f 72 20 77 68 61 74 65 76 65 72 0a  ba (or whatever.
1850: 2a 2a 20 74 6f 6f 6c 20 69 73 20 62 65 69 6e 67  ** tool is being
1860: 20 75 73 65 64 20 66 6f 72 20 66 69 6c 65 20 73   used for file s
1870: 68 61 72 69 6e 67 29 20 69 6d 70 6c 65 6d 65 6e  haring) implemen
1880: 74 73 20 6c 6f 63 6b 73 20 63 6f 72 72 65 63 74  ts locks correct
1890: 6c 79 20 62 65 74 77 65 65 6e 0a 2a 2a 20 77 69  ly between.** wi
18a0: 6e 64 6f 77 73 20 61 6e 64 20 75 6e 69 78 2e 20  ndows and unix. 
18b0: 20 49 27 6d 20 67 75 65 73 73 69 6e 67 20 74 68   I'm guessing th
18c0: 61 74 20 69 73 6e 27 74 20 6c 69 6b 65 6c 79 20  at isn't likely 
18d0: 74 6f 20 68 61 70 70 65 6e 2c 20 62 75 74 20 62  to happen, but b
18e0: 79 0a 2a 2a 20 75 73 69 6e 67 20 74 68 65 20 73  y.** using the s
18f0: 61 6d 65 20 6c 6f 63 6b 69 6e 67 20 72 61 6e 67  ame locking rang
1900: 65 20 77 65 20 61 72 65 20 61 74 20 6c 65 61 73  e we are at leas
1910: 74 20 6f 70 65 6e 20 74 6f 20 74 68 65 20 70 6f  t open to the po
1920: 73 73 69 62 69 6c 69 74 79 2e 0a 2a 2a 0a 2a 2a  ssibility..**.**
1930: 20 4c 6f 63 6b 69 6e 67 20 69 6e 20 77 69 6e 64   Locking in wind
1940: 6f 77 73 20 69 73 20 6d 61 6e 64 69 74 6f 72 79  ows is manditory
1950: 2e 20 20 46 6f 72 20 74 68 69 73 20 72 65 61 73  .  For this reas
1960: 6f 6e 2c 20 77 65 20 63 61 6e 6e 6f 74 20 73 74  on, we cannot st
1970: 6f 72 65 0a 2a 2a 20 61 63 74 75 61 6c 20 64 61  ore.** actual da
1980: 74 61 20 69 6e 20 74 68 65 20 62 79 74 65 73 20  ta in the bytes 
1990: 75 73 65 64 20 66 6f 72 20 6c 6f 63 6b 69 6e 67  used for locking
19a0: 2e 20 20 54 68 65 20 70 61 67 65 72 20 6e 65 76  .  The pager nev
19b0: 65 72 20 61 6c 6c 6f 63 61 74 65 73 0a 2a 2a 20  er allocates.** 
19c0: 74 68 65 20 70 61 67 65 73 20 69 6e 76 6f 6c 76  the pages involv
19d0: 65 64 20 69 6e 20 6c 6f 63 6b 69 6e 67 20 74 68  ed in locking th
19e0: 65 72 65 66 6f 72 65 2e 20 20 53 48 41 52 45 44  erefore.  SHARED
19f0: 5f 53 49 5a 45 20 69 73 20 73 65 6c 65 63 74 65  _SIZE is selecte
1a00: 64 20 73 6f 0a 2a 2a 20 74 68 61 74 20 61 6c 6c  d so.** that all
1a10: 20 6c 6f 63 6b 73 20 77 69 6c 6c 20 66 69 74 20   locks will fit 
1a20: 6f 6e 20 61 20 73 69 6e 67 6c 65 20 70 61 67 65  on a single page
1a30: 20 65 76 65 6e 20 61 74 20 74 68 65 20 6d 69 6e   even at the min
1a40: 69 6d 75 6d 20 70 61 67 65 20 73 69 7a 65 2e 0a  imum page size..
1a50: 2a 2a 20 50 45 4e 44 49 4e 47 5f 42 59 54 45 20  ** PENDING_BYTE 
1a60: 64 65 66 69 6e 65 73 20 74 68 65 20 62 65 67 69  defines the begi
1a70: 6e 6e 69 6e 67 20 6f 66 20 74 68 65 20 6c 6f 63  nning of the loc
1a80: 6b 73 2e 20 20 42 79 20 64 65 66 61 75 6c 74 20  ks.  By default 
1a90: 50 45 4e 44 49 4e 47 5f 42 59 54 45 0a 2a 2a 20  PENDING_BYTE.** 
1aa0: 69 73 20 73 65 74 20 68 69 67 68 20 73 6f 20 74  is set high so t
1ab0: 68 61 74 20 77 65 20 64 6f 6e 27 74 20 68 61 76  hat we don't hav
1ac0: 65 20 74 6f 20 61 6c 6c 6f 63 61 74 65 20 61 6e  e to allocate an
1ad0: 20 75 6e 75 73 65 64 20 70 61 67 65 20 65 78 63   unused page exc
1ae0: 65 70 74 0a 2a 2a 20 66 6f 72 20 76 65 72 79 20  ept.** for very 
1af0: 6c 61 72 67 65 20 64 61 74 61 62 61 73 65 73 2e  large databases.
1b00: 20 20 42 75 74 20 6f 6e 65 20 73 68 6f 75 6c 64    But one should
1b10: 20 74 65 73 74 20 74 68 65 20 70 61 67 65 20 73   test the page s
1b20: 6b 69 70 70 69 6e 67 20 6c 6f 67 69 63 20 0a 2a  kipping logic .*
1b30: 2a 20 62 79 20 73 65 74 74 69 6e 67 20 50 45 4e  * by setting PEN
1b40: 44 49 4e 47 5f 42 59 54 45 20 6c 6f 77 20 61 6e  DING_BYTE low an
1b50: 64 20 72 75 6e 6e 69 6e 67 20 74 68 65 20 65 6e  d running the en
1b60: 74 69 72 65 20 72 65 67 72 65 73 73 69 6f 6e 20  tire regression 
1b70: 73 75 69 74 65 2e 0a 2a 2a 0a 2a 2a 20 43 68 61  suite..**.** Cha
1b80: 6e 67 69 6e 67 20 74 68 65 20 76 61 6c 75 65 20  nging the value 
1b90: 6f 66 20 50 45 4e 44 49 4e 47 5f 42 59 54 45 20  of PENDING_BYTE 
1ba0: 72 65 73 75 6c 74 73 20 69 6e 20 61 20 73 75 62  results in a sub
1bb0: 74 6c 79 20 69 6e 63 6f 6d 70 61 74 69 62 6c 65  tly incompatible
1bc0: 0a 2a 2a 20 66 69 6c 65 20 66 6f 72 6d 61 74 2e  .** file format.
1bd0: 20 20 44 65 70 65 6e 64 69 6e 67 20 6f 6e 20 68    Depending on h
1be0: 6f 77 20 69 74 20 69 73 20 63 68 61 6e 67 65 64  ow it is changed
1bf0: 2c 20 79 6f 75 20 6d 69 67 68 74 20 6e 6f 74 20  , you might not 
1c00: 6e 6f 74 69 63 65 0a 2a 2a 20 74 68 65 20 69 6e  notice.** the in
1c10: 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 20 72 69  compatibility ri
1c20: 67 68 74 20 61 77 61 79 2c 20 65 76 65 6e 20 72  ght away, even r
1c30: 75 6e 6e 69 6e 67 20 61 20 66 75 6c 6c 20 72 65  unning a full re
1c40: 67 72 65 73 73 69 6f 6e 20 74 65 73 74 2e 0a 2a  gression test..*
1c50: 2a 20 54 68 65 20 64 65 66 61 75 6c 74 20 6c 6f  * The default lo
1c60: 63 61 74 69 6f 6e 20 6f 66 20 50 45 4e 44 49 4e  cation of PENDIN
1c70: 47 5f 42 59 54 45 20 69 73 20 74 68 65 20 66 69  G_BYTE is the fi
1c80: 72 73 74 20 62 79 74 65 20 70 61 73 74 20 74 68  rst byte past th
1c90: 65 0a 2a 2a 20 31 47 42 20 62 6f 75 6e 64 61 72  e.** 1GB boundar
1ca0: 79 2e 0a 2a 2a 0a 2a 2f 0a 23 69 66 64 65 66 20  y..**.*/.#ifdef 
1cb0: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 57 53 44 0a  SQLITE_OMIT_WSD.
1cc0: 23 20 64 65 66 69 6e 65 20 50 45 4e 44 49 4e 47  # define PENDING
1cd0: 5f 42 59 54 45 20 20 20 20 20 28 30 78 34 30 30  _BYTE     (0x400
1ce0: 30 30 30 30 30 29 0a 23 65 6c 73 65 0a 23 20 64  00000).#else.# d
1cf0: 65 66 69 6e 65 20 50 45 4e 44 49 4e 47 5f 42 59  efine PENDING_BY
1d00: 54 45 20 20 20 20 20 20 73 71 6c 69 74 65 33 50  TE      sqlite3P
1d10: 65 6e 64 69 6e 67 42 79 74 65 0a 23 65 6e 64 69  endingByte.#endi
1d20: 66 0a 23 64 65 66 69 6e 65 20 52 45 53 45 52 56  f.#define RESERV
1d30: 45 44 5f 42 59 54 45 20 20 20 20 20 28 50 45 4e  ED_BYTE     (PEN
1d40: 44 49 4e 47 5f 42 59 54 45 2b 31 29 0a 23 64 65  DING_BYTE+1).#de
1d50: 66 69 6e 65 20 53 48 41 52 45 44 5f 46 49 52 53  fine SHARED_FIRS
1d60: 54 20 20 20 20 20 20 28 50 45 4e 44 49 4e 47 5f  T      (PENDING_
1d70: 42 59 54 45 2b 32 29 0a 23 64 65 66 69 6e 65 20  BYTE+2).#define 
1d80: 53 48 41 52 45 44 5f 53 49 5a 45 20 20 20 20 20  SHARED_SIZE     
1d90: 20 20 35 31 30 0a 0a 2f 2a 0a 2a 2a 20 57 72 61    510../*.** Wra
1da0: 70 70 65 72 20 61 72 6f 75 6e 64 20 4f 53 20 73  pper around OS s
1db0: 70 65 63 69 66 69 63 20 73 71 6c 69 74 65 33 5f  pecific sqlite3_
1dc0: 6f 73 5f 69 6e 69 74 28 29 20 66 75 6e 63 74 69  os_init() functi
1dd0: 6f 6e 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  on..*/.int sqlit
1de0: 65 33 4f 73 49 6e 69 74 28 76 6f 69 64 29 3b 0a  e3OsInit(void);.
1df0: 0a 2f 2a 20 0a 2a 2a 20 46 75 6e 63 74 69 6f 6e  ./* .** Function
1e00: 73 20 66 6f 72 20 61 63 63 65 73 73 69 6e 67 20  s for accessing 
1e10: 73 71 6c 69 74 65 33 5f 66 69 6c 65 20 6d 65 74  sqlite3_file met
1e20: 68 6f 64 73 20 0a 2a 2f 0a 69 6e 74 20 73 71 6c  hods .*/.int sql
1e30: 69 74 65 33 4f 73 43 6c 6f 73 65 28 73 71 6c 69  ite3OsClose(sqli
1e40: 74 65 33 5f 66 69 6c 65 2a 29 3b 0a 69 6e 74 20  te3_file*);.int 
1e50: 73 71 6c 69 74 65 33 4f 73 52 65 61 64 28 73 71  sqlite3OsRead(sq
1e60: 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 76 6f 69  lite3_file*, voi
1e70: 64 2a 2c 20 69 6e 74 20 61 6d 74 2c 20 69 36 34  d*, int amt, i64
1e80: 20 6f 66 66 73 65 74 29 3b 0a 69 6e 74 20 73 71   offset);.int sq
1e90: 6c 69 74 65 33 4f 73 57 72 69 74 65 28 73 71 6c  lite3OsWrite(sql
1ea0: 69 74 65 33 5f 66 69 6c 65 2a 2c 20 63 6f 6e 73  ite3_file*, cons
1eb0: 74 20 76 6f 69 64 2a 2c 20 69 6e 74 20 61 6d 74  t void*, int amt
1ec0: 2c 20 69 36 34 20 6f 66 66 73 65 74 29 3b 0a 69  , i64 offset);.i
1ed0: 6e 74 20 73 71 6c 69 74 65 33 4f 73 54 72 75 6e  nt sqlite3OsTrun
1ee0: 63 61 74 65 28 73 71 6c 69 74 65 33 5f 66 69 6c  cate(sqlite3_fil
1ef0: 65 2a 2c 20 69 36 34 20 73 69 7a 65 29 3b 0a 69  e*, i64 size);.i
1f00: 6e 74 20 73 71 6c 69 74 65 33 4f 73 53 79 6e 63  nt sqlite3OsSync
1f10: 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20  (sqlite3_file*, 
1f20: 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  int);.int sqlite
1f30: 33 4f 73 46 69 6c 65 53 69 7a 65 28 73 71 6c 69  3OsFileSize(sqli
1f40: 74 65 33 5f 66 69 6c 65 2a 2c 20 69 36 34 20 2a  te3_file*, i64 *
1f50: 70 53 69 7a 65 29 3b 0a 69 6e 74 20 73 71 6c 69  pSize);.int sqli
1f60: 74 65 33 4f 73 4c 6f 63 6b 28 73 71 6c 69 74 65  te3OsLock(sqlite
1f70: 33 5f 66 69 6c 65 2a 2c 20 69 6e 74 29 3b 0a 69  3_file*, int);.i
1f80: 6e 74 20 73 71 6c 69 74 65 33 4f 73 55 6e 6c 6f  nt sqlite3OsUnlo
1f90: 63 6b 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a  ck(sqlite3_file*
1fa0: 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69  , int);.int sqli
1fb0: 74 65 33 4f 73 43 68 65 63 6b 52 65 73 65 72 76  te3OsCheckReserv
1fc0: 65 64 4c 6f 63 6b 28 73 71 6c 69 74 65 33 5f 66  edLock(sqlite3_f
1fd0: 69 6c 65 20 2a 69 64 2c 20 69 6e 74 20 2a 70 52  ile *id, int *pR
1fe0: 65 73 4f 75 74 29 3b 0a 69 6e 74 20 73 71 6c 69  esOut);.int sqli
1ff0: 74 65 33 4f 73 46 69 6c 65 43 6f 6e 74 72 6f 6c  te3OsFileControl
2000: 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 69  (sqlite3_file*,i
2010: 6e 74 2c 76 6f 69 64 2a 29 3b 0a 76 6f 69 64 20  nt,void*);.void 
2020: 73 71 6c 69 74 65 33 4f 73 46 69 6c 65 43 6f 6e  sqlite3OsFileCon
2030: 74 72 6f 6c 48 69 6e 74 28 73 71 6c 69 74 65 33  trolHint(sqlite3
2040: 5f 66 69 6c 65 2a 2c 69 6e 74 2c 76 6f 69 64 2a  _file*,int,void*
2050: 29 3b 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  );.#define SQLIT
2060: 45 5f 46 43 4e 54 4c 5f 44 42 5f 55 4e 43 48 41  E_FCNTL_DB_UNCHA
2070: 4e 47 45 44 20 30 78 63 61 30 39 33 66 61 30 0a  NGED 0xca093fa0.
2080: 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 53 65 63  int sqlite3OsSec
2090: 74 6f 72 53 69 7a 65 28 73 71 6c 69 74 65 33 5f  torSize(sqlite3_
20a0: 66 69 6c 65 20 2a 69 64 29 3b 0a 69 6e 74 20 73  file *id);.int s
20b0: 71 6c 69 74 65 33 4f 73 44 65 76 69 63 65 43 68  qlite3OsDeviceCh
20c0: 61 72 61 63 74 65 72 69 73 74 69 63 73 28 73 71  aracteristics(sq
20d0: 6c 69 74 65 33 5f 66 69 6c 65 20 2a 69 64 29 3b  lite3_file *id);
20e0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 53 68  .int sqlite3OsSh
20f0: 6d 4d 61 70 28 73 71 6c 69 74 65 33 5f 66 69 6c  mMap(sqlite3_fil
2100: 65 20 2a 2c 69 6e 74 2c 69 6e 74 2c 69 6e 74 2c  e *,int,int,int,
2110: 76 6f 69 64 20 76 6f 6c 61 74 69 6c 65 20 2a 2a  void volatile **
2120: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f 73  );.int sqlite3Os
2130: 53 68 6d 4c 6f 63 6b 28 73 71 6c 69 74 65 33 5f  ShmLock(sqlite3_
2140: 66 69 6c 65 20 2a 69 64 2c 20 69 6e 74 2c 20 69  file *id, int, i
2150: 6e 74 2c 20 69 6e 74 29 3b 0a 76 6f 69 64 20 73  nt, int);.void s
2160: 71 6c 69 74 65 33 4f 73 53 68 6d 42 61 72 72 69  qlite3OsShmBarri
2170: 65 72 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 20  er(sqlite3_file 
2180: 2a 69 64 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  *id);.int sqlite
2190: 33 4f 73 53 68 6d 55 6e 6d 61 70 28 73 71 6c 69  3OsShmUnmap(sqli
21a0: 74 65 33 5f 66 69 6c 65 20 2a 69 64 2c 20 69 6e  te3_file *id, in
21b0: 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f  t);.int sqlite3O
21c0: 73 46 65 74 63 68 28 73 71 6c 69 74 65 33 5f 66  sFetch(sqlite3_f
21d0: 69 6c 65 20 2a 69 64 2c 20 69 36 34 2c 20 69 6e  ile *id, i64, in
21e0: 74 2c 20 76 6f 69 64 20 2a 2a 29 3b 0a 69 6e 74  t, void **);.int
21f0: 20 73 71 6c 69 74 65 33 4f 73 55 6e 66 65 74 63   sqlite3OsUnfetc
2200: 68 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 20 2a  h(sqlite3_file *
2210: 2c 20 69 36 34 2c 20 76 6f 69 64 20 2a 29 3b 0a  , i64, void *);.
2220: 0a 0a 2f 2a 20 0a 2a 2a 20 46 75 6e 63 74 69 6f  ../* .** Functio
2230: 6e 73 20 66 6f 72 20 61 63 63 65 73 73 69 6e 67  ns for accessing
2240: 20 73 71 6c 69 74 65 33 5f 76 66 73 20 6d 65 74   sqlite3_vfs met
2250: 68 6f 64 73 20 0a 2a 2f 0a 69 6e 74 20 73 71 6c  hods .*/.int sql
2260: 69 74 65 33 4f 73 4f 70 65 6e 28 73 71 6c 69 74  ite3OsOpen(sqlit
2270: 65 33 5f 76 66 73 20 2a 2c 20 63 6f 6e 73 74 20  e3_vfs *, const 
2280: 63 68 61 72 20 2a 2c 20 73 71 6c 69 74 65 33 5f  char *, sqlite3_
2290: 66 69 6c 65 2a 2c 20 69 6e 74 2c 20 69 6e 74 20  file*, int, int 
22a0: 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f  *);.int sqlite3O
22b0: 73 44 65 6c 65 74 65 28 73 71 6c 69 74 65 33 5f  sDelete(sqlite3_
22c0: 76 66 73 20 2a 2c 20 63 6f 6e 73 74 20 63 68 61  vfs *, const cha
22d0: 72 20 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73  r *, int);.int s
22e0: 71 6c 69 74 65 33 4f 73 41 63 63 65 73 73 28 73  qlite3OsAccess(s
22f0: 71 6c 69 74 65 33 5f 76 66 73 20 2a 2c 20 63 6f  qlite3_vfs *, co
2300: 6e 73 74 20 63 68 61 72 20 2a 2c 20 69 6e 74 2c  nst char *, int,
2310: 20 69 6e 74 20 2a 70 52 65 73 4f 75 74 29 3b 0a   int *pResOut);.
2320: 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 46 75 6c  int sqlite3OsFul
2330: 6c 50 61 74 68 6e 61 6d 65 28 73 71 6c 69 74 65  lPathname(sqlite
2340: 33 5f 76 66 73 20 2a 2c 20 63 6f 6e 73 74 20 63  3_vfs *, const c
2350: 68 61 72 20 2a 2c 20 69 6e 74 2c 20 63 68 61 72  har *, int, char
2360: 20 2a 29 3b 0a 23 69 66 6e 64 65 66 20 53 51 4c   *);.#ifndef SQL
2370: 49 54 45 5f 4f 4d 49 54 5f 4c 4f 41 44 5f 45 58  ITE_OMIT_LOAD_EX
2380: 54 45 4e 53 49 4f 4e 0a 76 6f 69 64 20 2a 73 71  TENSION.void *sq
2390: 6c 69 74 65 33 4f 73 44 6c 4f 70 65 6e 28 73 71  lite3OsDlOpen(sq
23a0: 6c 69 74 65 33 5f 76 66 73 20 2a 2c 20 63 6f 6e  lite3_vfs *, con
23b0: 73 74 20 63 68 61 72 20 2a 29 3b 0a 76 6f 69 64  st char *);.void
23c0: 20 73 71 6c 69 74 65 33 4f 73 44 6c 45 72 72 6f   sqlite3OsDlErro
23d0: 72 28 73 71 6c 69 74 65 33 5f 76 66 73 20 2a 2c  r(sqlite3_vfs *,
23e0: 20 69 6e 74 2c 20 63 68 61 72 20 2a 29 3b 0a 76   int, char *);.v
23f0: 6f 69 64 20 28 2a 73 71 6c 69 74 65 33 4f 73 44  oid (*sqlite3OsD
2400: 6c 53 79 6d 28 73 71 6c 69 74 65 33 5f 76 66 73  lSym(sqlite3_vfs
2410: 20 2a 2c 20 76 6f 69 64 20 2a 2c 20 63 6f 6e 73   *, void *, cons
2420: 74 20 63 68 61 72 20 2a 29 29 28 76 6f 69 64 29  t char *))(void)
2430: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 4f 73  ;.void sqlite3Os
2440: 44 6c 43 6c 6f 73 65 28 73 71 6c 69 74 65 33 5f  DlClose(sqlite3_
2450: 76 66 73 20 2a 2c 20 76 6f 69 64 20 2a 29 3b 0a  vfs *, void *);.
2460: 23 65 6e 64 69 66 20 2f 2a 20 53 51 4c 49 54 45  #endif /* SQLITE
2470: 5f 4f 4d 49 54 5f 4c 4f 41 44 5f 45 58 54 45 4e  _OMIT_LOAD_EXTEN
2480: 53 49 4f 4e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69  SION */.int sqli
2490: 74 65 33 4f 73 52 61 6e 64 6f 6d 6e 65 73 73 28  te3OsRandomness(
24a0: 73 71 6c 69 74 65 33 5f 76 66 73 20 2a 2c 20 69  sqlite3_vfs *, i
24b0: 6e 74 2c 20 63 68 61 72 20 2a 29 3b 0a 69 6e 74  nt, char *);.int
24c0: 20 73 71 6c 69 74 65 33 4f 73 53 6c 65 65 70 28   sqlite3OsSleep(
24d0: 73 71 6c 69 74 65 33 5f 76 66 73 20 2a 2c 20 69  sqlite3_vfs *, i
24e0: 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  nt);.int sqlite3
24f0: 4f 73 43 75 72 72 65 6e 74 54 69 6d 65 49 6e 74  OsCurrentTimeInt
2500: 36 34 28 73 71 6c 69 74 65 33 5f 76 66 73 20 2a  64(sqlite3_vfs *
2510: 2c 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 2a  , sqlite3_int64*
2520: 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 6f 6e 76 65 6e  );../*.** Conven
2530: 69 65 6e 63 65 20 66 75 6e 63 74 69 6f 6e 73 20  ience functions 
2540: 66 6f 72 20 6f 70 65 6e 69 6e 67 20 61 6e 64 20  for opening and 
2550: 63 6c 6f 73 69 6e 67 20 66 69 6c 65 73 20 75 73  closing files us
2560: 69 6e 67 20 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  ing .** sqlite3_
2570: 6d 61 6c 6c 6f 63 28 29 20 74 6f 20 6f 62 74 61  malloc() to obta
2580: 69 6e 20 73 70 61 63 65 20 66 6f 72 20 74 68 65  in space for the
2590: 20 66 69 6c 65 2d 68 61 6e 64 6c 65 20 73 74 72   file-handle str
25a0: 75 63 74 75 72 65 2e 0a 2a 2f 0a 69 6e 74 20 73  ucture..*/.int s
25b0: 71 6c 69 74 65 33 4f 73 4f 70 65 6e 4d 61 6c 6c  qlite3OsOpenMall
25c0: 6f 63 28 73 71 6c 69 74 65 33 5f 76 66 73 20 2a  oc(sqlite3_vfs *
25d0: 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 2c 20  , const char *, 
25e0: 73 71 6c 69 74 65 33 5f 66 69 6c 65 20 2a 2a 2c  sqlite3_file **,
25f0: 20 69 6e 74 2c 69 6e 74 2a 29 3b 0a 69 6e 74 20   int,int*);.int 
2600: 73 71 6c 69 74 65 33 4f 73 43 6c 6f 73 65 46 72  sqlite3OsCloseFr
2610: 65 65 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 20  ee(sqlite3_file 
2620: 2a 29 3b 0a 0a 23 65 6e 64 69 66 20 2f 2a 20 5f  *);..#endif /* _
2630: 53 51 4c 49 54 45 5f 4f 53 5f 48 5f 20 2a 2f 0a  SQLITE_OS_H_ */.