/ Hex Artifact Content
Login
SQLite training in Houston TX on 2019-11-05 (details)
Part of the 2019 Tcl Conference

Artifact 91ff889115ecd01f436d3611f7f5ea4dc12d92f1:


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: 41 74 74 65 6d 70 74 20 74 6f 20 61 75 74 6f 6d  Attempt to autom
0300: 61 74 69 63 61 6c 6c 79 20 64 65 74 65 63 74 20  atically detect 
0310: 74 68 65 20 6f 70 65 72 61 74 69 6e 67 20 73 79  the operating sy
0320: 73 74 65 6d 20 61 6e 64 20 73 65 74 75 70 20 74  stem and setup t
0330: 68 65 0a 2a 2a 20 6e 65 63 65 73 73 61 72 79 20  he.** necessary 
0340: 70 72 65 2d 70 72 6f 63 65 73 73 6f 72 20 6d 61  pre-processor ma
0350: 63 72 6f 73 20 66 6f 72 20 69 74 2e 0a 2a 2f 0a  cros for it..*/.
0360: 23 69 6e 63 6c 75 64 65 20 22 6f 73 5f 73 65 74  #include "os_set
0370: 75 70 2e 68 22 0a 0a 2f 2a 20 49 66 20 74 68 65  up.h"../* If the
0380: 20 53 45 54 5f 46 55 4c 4c 53 59 4e 43 20 6d 61   SET_FULLSYNC ma
0390: 63 72 6f 20 69 73 20 6e 6f 74 20 64 65 66 69 6e  cro is not defin
03a0: 65 64 20 61 62 6f 76 65 2c 20 74 68 65 6e 20 6d  ed above, then m
03b0: 61 6b 65 20 69 74 0a 2a 2a 20 61 20 6e 6f 2d 6f  ake it.** a no-o
03c0: 70 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 53 45 54  p.*/.#ifndef SET
03d0: 5f 46 55 4c 4c 53 59 4e 43 0a 23 20 64 65 66 69  _FULLSYNC.# defi
03e0: 6e 65 20 53 45 54 5f 46 55 4c 4c 53 59 4e 43 28  ne SET_FULLSYNC(
03f0: 78 2c 79 29 0a 23 65 6e 64 69 66 0a 0a 2f 2a 0a  x,y).#endif../*.
0400: 2a 2a 20 54 68 65 20 64 65 66 61 75 6c 74 20 73  ** The default s
0410: 69 7a 65 20 6f 66 20 61 20 64 69 73 6b 20 73 65  ize of a disk se
0420: 63 74 6f 72 0a 2a 2f 0a 23 69 66 6e 64 65 66 20  ctor.*/.#ifndef 
0430: 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 53  SQLITE_DEFAULT_S
0440: 45 43 54 4f 52 5f 53 49 5a 45 0a 23 20 64 65 66  ECTOR_SIZE.# def
0450: 69 6e 65 20 53 51 4c 49 54 45 5f 44 45 46 41 55  ine SQLITE_DEFAU
0460: 4c 54 5f 53 45 43 54 4f 52 5f 53 49 5a 45 20 34  LT_SECTOR_SIZE 4
0470: 30 39 36 0a 23 65 6e 64 69 66 0a 0a 2f 2a 0a 2a  096.#endif../*.*
0480: 2a 20 54 65 6d 70 6f 72 61 72 79 20 66 69 6c 65  * Temporary file
0490: 73 20 61 72 65 20 6e 61 6d 65 64 20 73 74 61 72  s are named star
04a0: 74 69 6e 67 20 77 69 74 68 20 74 68 69 73 20 70  ting with this p
04b0: 72 65 66 69 78 20 66 6f 6c 6c 6f 77 65 64 20 62  refix followed b
04c0: 79 20 31 36 20 72 61 6e 64 6f 6d 0a 2a 2a 20 61  y 16 random.** a
04d0: 6c 70 68 61 6e 75 6d 65 72 69 63 20 63 68 61 72  lphanumeric char
04e0: 61 63 74 65 72 73 2c 20 61 6e 64 20 6e 6f 20 66  acters, and no f
04f0: 69 6c 65 20 65 78 74 65 6e 73 69 6f 6e 2e 20 54  ile extension. T
0500: 68 65 79 20 61 72 65 20 73 74 6f 72 65 64 20 69  hey are stored i
0510: 6e 20 74 68 65 0a 2a 2a 20 4f 53 27 73 20 73 74  n the.** OS's st
0520: 61 6e 64 61 72 64 20 74 65 6d 70 6f 72 61 72 79  andard temporary
0530: 20 66 69 6c 65 20 64 69 72 65 63 74 6f 72 79 2c   file directory,
0540: 20 61 6e 64 20 61 72 65 20 64 65 6c 65 74 65 64   and are deleted
0550: 20 70 72 69 6f 72 20 74 6f 20 65 78 69 74 2e 0a   prior to exit..
0560: 2a 2a 20 49 66 20 73 71 6c 69 74 65 20 69 73 20  ** If sqlite is 
0570: 62 65 69 6e 67 20 65 6d 62 65 64 64 65 64 20 69  being embedded i
0580: 6e 20 61 6e 6f 74 68 65 72 20 70 72 6f 67 72 61  n another progra
0590: 6d 2c 20 79 6f 75 20 6d 61 79 20 77 69 73 68 20  m, you may wish 
05a0: 74 6f 20 63 68 61 6e 67 65 20 74 68 65 0a 2a 2a  to change the.**
05b0: 20 70 72 65 66 69 78 20 74 6f 20 72 65 66 6c 65   prefix to refle
05c0: 63 74 20 79 6f 75 72 20 70 72 6f 67 72 61 6d 27  ct your program'
05d0: 73 20 6e 61 6d 65 2c 20 73 6f 20 74 68 61 74 20  s name, so that 
05e0: 69 66 20 79 6f 75 72 20 70 72 6f 67 72 61 6d 20  if your program 
05f0: 65 78 69 74 73 0a 2a 2a 20 70 72 65 6d 61 74 75  exits.** prematu
0600: 72 65 6c 79 2c 20 6f 6c 64 20 74 65 6d 70 6f 72  rely, old tempor
0610: 61 72 79 20 66 69 6c 65 73 20 63 61 6e 20 62 65  ary files can be
0620: 20 65 61 73 69 6c 79 20 69 64 65 6e 74 69 66 69   easily identifi
0630: 65 64 2e 20 54 68 69 73 20 63 61 6e 20 62 65 20  ed. This can be 
0640: 64 6f 6e 65 0a 2a 2a 20 75 73 69 6e 67 20 2d 44  done.** using -D
0650: 53 51 4c 49 54 45 5f 54 45 4d 50 5f 46 49 4c 45  SQLITE_TEMP_FILE
0660: 5f 50 52 45 46 49 58 3d 6d 79 70 72 65 66 69 78  _PREFIX=myprefix
0670: 5f 20 6f 6e 20 74 68 65 20 63 6f 6d 70 69 6c 65  _ on the compile
0680: 72 20 63 6f 6d 6d 61 6e 64 20 6c 69 6e 65 2e 0a  r command line..
0690: 2a 2a 0a 2a 2a 20 32 30 30 36 2d 31 30 2d 33 31  **.** 2006-10-31
06a0: 3a 20 20 54 68 65 20 64 65 66 61 75 6c 74 20 70  :  The default p
06b0: 72 65 66 69 78 20 75 73 65 64 20 74 6f 20 62 65  refix used to be
06c0: 20 22 73 71 6c 69 74 65 5f 22 2e 20 20 42 75 74   "sqlite_".  But
06d0: 20 74 68 65 6e 0a 2a 2a 20 4d 63 61 66 65 65 20   then.** Mcafee 
06e0: 73 74 61 72 74 65 64 20 75 73 69 6e 67 20 53 51  started using SQ
06f0: 4c 69 74 65 20 69 6e 20 74 68 65 69 72 20 61 6e  Lite in their an
0700: 74 69 2d 76 69 72 75 73 20 70 72 6f 64 75 63 74  ti-virus product
0710: 20 61 6e 64 20 69 74 0a 2a 2a 20 73 74 61 72 74   and it.** start
0720: 65 64 20 70 75 74 74 69 6e 67 20 66 69 6c 65 73  ed putting files
0730: 20 77 69 74 68 20 74 68 65 20 22 73 71 6c 69 74   with the "sqlit
0740: 65 22 20 6e 61 6d 65 20 69 6e 20 74 68 65 20 63  e" name in the c
0750: 3a 2f 74 65 6d 70 20 66 6f 6c 64 65 72 2e 0a 2a  :/temp folder..*
0760: 2a 20 54 68 69 73 20 61 6e 6e 6f 79 65 64 20 6d  * This annoyed m
0770: 61 6e 79 20 77 69 6e 64 6f 77 73 20 75 73 65 72  any windows user
0780: 73 2e 20 20 54 68 6f 73 65 20 75 73 65 72 73 20  s.  Those users 
0790: 77 6f 75 6c 64 20 74 68 65 6e 20 64 6f 20 61 20  would then do a 
07a0: 0a 2a 2a 20 47 6f 6f 67 6c 65 20 73 65 61 72 63  .** Google searc
07b0: 68 20 66 6f 72 20 22 73 71 6c 69 74 65 22 2c 20  h for "sqlite", 
07c0: 66 69 6e 64 20 74 68 65 20 74 65 6c 65 70 68 6f  find the telepho
07d0: 6e 65 20 6e 75 6d 62 65 72 73 20 6f 66 20 74 68  ne numbers of th
07e0: 65 0a 2a 2a 20 64 65 76 65 6c 6f 70 65 72 73 20  e.** developers 
07f0: 61 6e 64 20 63 61 6c 6c 20 74 6f 20 77 61 6b 65  and call to wake
0800: 20 74 68 65 6d 20 75 70 20 61 74 20 6e 69 67 68   them up at nigh
0810: 74 20 61 6e 64 20 63 6f 6d 70 6c 61 69 6e 2e 0a  t and complain..
0820: 2a 2a 20 46 6f 72 20 74 68 69 73 20 72 65 61 73  ** For this reas
0830: 6f 6e 2c 20 74 68 65 20 64 65 66 61 75 6c 74 20  on, the default 
0840: 6e 61 6d 65 20 70 72 65 66 69 78 20 69 73 20 63  name prefix is c
0850: 68 61 6e 67 65 64 20 74 6f 20 62 65 20 22 73 71  hanged to be "sq
0860: 6c 69 74 65 22 20 0a 2a 2a 20 73 70 65 6c 6c 65  lite" .** spelle
0870: 64 20 62 61 63 6b 77 61 72 64 73 2e 20 20 53 6f  d backwards.  So
0880: 20 74 68 65 20 74 65 6d 70 20 66 69 6c 65 73 20   the temp files 
0890: 61 72 65 20 73 74 69 6c 6c 20 69 64 65 6e 74 69  are still identi
08a0: 66 69 65 64 2c 20 62 75 74 0a 2a 2a 20 61 6e 79  fied, but.** any
08b0: 62 6f 64 79 20 73 6d 61 72 74 20 65 6e 6f 75 67  body smart enoug
08c0: 68 20 74 6f 20 66 69 67 75 72 65 20 6f 75 74 20  h to figure out 
08d0: 74 68 65 20 63 6f 64 65 20 69 73 20 61 6c 73 6f  the code is also
08e0: 20 6c 69 6b 65 6c 79 20 73 6d 61 72 74 0a 2a 2a   likely smart.**
08f0: 20 65 6e 6f 75 67 68 20 74 6f 20 6b 6e 6f 77 20   enough to know 
0900: 74 68 61 74 20 63 61 6c 6c 69 6e 67 20 74 68 65  that calling the
0910: 20 64 65 76 65 6c 6f 70 65 72 20 77 69 6c 6c 20   developer will 
0920: 6e 6f 74 20 68 65 6c 70 20 67 65 74 20 72 69 64  not help get rid
0930: 0a 2a 2a 20 6f 66 20 74 68 65 20 66 69 6c 65 2e  .** of the file.
0940: 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 53 51 4c 49  .*/.#ifndef SQLI
0950: 54 45 5f 54 45 4d 50 5f 46 49 4c 45 5f 50 52 45  TE_TEMP_FILE_PRE
0960: 46 49 58 0a 23 20 64 65 66 69 6e 65 20 53 51 4c  FIX.# define SQL
0970: 49 54 45 5f 54 45 4d 50 5f 46 49 4c 45 5f 50 52  ITE_TEMP_FILE_PR
0980: 45 46 49 58 20 22 65 74 69 6c 71 73 5f 22 0a 23  EFIX "etilqs_".#
0990: 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 54 68 65  endif../*.** The
09a0: 20 66 6f 6c 6c 6f 77 69 6e 67 20 76 61 6c 75 65   following value
09b0: 73 20 6d 61 79 20 62 65 20 70 61 73 73 65 64 20  s may be passed 
09c0: 61 73 20 74 68 65 20 73 65 63 6f 6e 64 20 61 72  as the second ar
09d0: 67 75 6d 65 6e 74 20 74 6f 0a 2a 2a 20 73 71 6c  gument to.** sql
09e0: 69 74 65 33 4f 73 4c 6f 63 6b 28 29 2e 20 54 68  ite3OsLock(). Th
09f0: 65 20 76 61 72 69 6f 75 73 20 6c 6f 63 6b 73 20  e various locks 
0a00: 65 78 68 69 62 69 74 20 74 68 65 20 66 6f 6c 6c  exhibit the foll
0a10: 6f 77 69 6e 67 20 73 65 6d 61 6e 74 69 63 73 3a  owing semantics:
0a20: 0a 2a 2a 0a 2a 2a 20 53 48 41 52 45 44 3a 20 20  .**.** SHARED:  
0a30: 20 20 41 6e 79 20 6e 75 6d 62 65 72 20 6f 66 20    Any number of 
0a40: 70 72 6f 63 65 73 73 65 73 20 6d 61 79 20 68 6f  processes may ho
0a50: 6c 64 20 61 20 53 48 41 52 45 44 20 6c 6f 63 6b  ld a SHARED lock
0a60: 20 73 69 6d 75 6c 74 61 6e 65 6f 75 73 6c 79 2e   simultaneously.
0a70: 0a 2a 2a 20 52 45 53 45 52 56 45 44 3a 20 20 41  .** RESERVED:  A
0a80: 20 73 69 6e 67 6c 65 20 70 72 6f 63 65 73 73 20   single process 
0a90: 6d 61 79 20 68 6f 6c 64 20 61 20 52 45 53 45 52  may hold a RESER
0aa0: 56 45 44 20 6c 6f 63 6b 20 6f 6e 20 61 20 66 69  VED lock on a fi
0ab0: 6c 65 20 61 74 0a 2a 2a 20 20 20 20 20 20 20 20  le at.**        
0ac0: 20 20 20 20 61 6e 79 20 74 69 6d 65 2e 20 4f 74      any time. Ot
0ad0: 68 65 72 20 70 72 6f 63 65 73 73 65 73 20 6d 61  her processes ma
0ae0: 79 20 68 6f 6c 64 20 61 6e 64 20 6f 62 74 61 69  y hold and obtai
0af0: 6e 20 6e 65 77 20 53 48 41 52 45 44 20 6c 6f 63  n new SHARED loc
0b00: 6b 73 2e 0a 2a 2a 20 50 45 4e 44 49 4e 47 3a 20  ks..** PENDING: 
0b10: 20 20 41 20 73 69 6e 67 6c 65 20 70 72 6f 63 65    A single proce
0b20: 73 73 20 6d 61 79 20 68 6f 6c 64 20 61 20 50 45  ss may hold a PE
0b30: 4e 44 49 4e 47 20 6c 6f 63 6b 20 6f 6e 20 61 20  NDING lock on a 
0b40: 66 69 6c 65 20 61 74 0a 2a 2a 20 20 20 20 20 20  file at.**      
0b50: 20 20 20 20 20 20 61 6e 79 20 6f 6e 65 20 74 69        any one ti
0b60: 6d 65 2e 20 45 78 69 73 74 69 6e 67 20 53 48 41  me. Existing SHA
0b70: 52 45 44 20 6c 6f 63 6b 73 20 6d 61 79 20 70 65  RED locks may pe
0b80: 72 73 69 73 74 2c 20 62 75 74 20 6e 6f 20 6e 65  rsist, but no ne
0b90: 77 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 20 20  w.**            
0ba0: 53 48 41 52 45 44 20 6c 6f 63 6b 73 20 6d 61 79  SHARED locks may
0bb0: 20 62 65 20 6f 62 74 61 69 6e 65 64 20 62 79 20   be obtained by 
0bc0: 6f 74 68 65 72 20 70 72 6f 63 65 73 73 65 73 2e  other processes.
0bd0: 0a 2a 2a 20 45 58 43 4c 55 53 49 56 45 3a 20 41  .** EXCLUSIVE: A
0be0: 6e 20 45 58 43 4c 55 53 49 56 45 20 6c 6f 63 6b  n EXCLUSIVE lock
0bf0: 20 70 72 65 63 6c 75 64 65 73 20 61 6c 6c 20 6f   precludes all o
0c00: 74 68 65 72 20 6c 6f 63 6b 73 2e 0a 2a 2a 0a 2a  ther locks..**.*
0c10: 2a 20 50 45 4e 44 49 4e 47 5f 4c 4f 43 4b 20 6d  * PENDING_LOCK m
0c20: 61 79 20 6e 6f 74 20 62 65 20 70 61 73 73 65 64  ay not be passed
0c30: 20 64 69 72 65 63 74 6c 79 20 74 6f 20 73 71 6c   directly to sql
0c40: 69 74 65 33 4f 73 4c 6f 63 6b 28 29 2e 20 49 6e  ite3OsLock(). In
0c50: 73 74 65 61 64 2c 20 61 0a 2a 2a 20 70 72 6f 63  stead, a.** proc
0c60: 65 73 73 20 74 68 61 74 20 72 65 71 75 65 73 74  ess that request
0c70: 73 20 61 6e 20 45 58 43 4c 55 53 49 56 45 20 6c  s an EXCLUSIVE l
0c80: 6f 63 6b 20 6d 61 79 20 61 63 74 75 61 6c 6c 79  ock may actually
0c90: 20 6f 62 74 61 69 6e 20 61 20 50 45 4e 44 49 4e   obtain a PENDIN
0ca0: 47 0a 2a 2a 20 6c 6f 63 6b 2e 20 54 68 69 73 20  G.** lock. This 
0cb0: 63 61 6e 20 62 65 20 75 70 67 72 61 64 65 64 20  can be upgraded 
0cc0: 74 6f 20 61 6e 20 45 58 43 4c 55 53 49 56 45 20  to an EXCLUSIVE 
0cd0: 6c 6f 63 6b 20 62 79 20 61 20 73 75 62 73 65 71  lock by a subseq
0ce0: 75 65 6e 74 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20  uent call to.** 
0cf0: 73 71 6c 69 74 65 33 4f 73 4c 6f 63 6b 28 29 2e  sqlite3OsLock().
0d00: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 4e 4f 5f 4c  .*/.#define NO_L
0d10: 4f 43 4b 20 20 20 20 20 20 20 20 20 30 0a 23 64  OCK         0.#d
0d20: 65 66 69 6e 65 20 53 48 41 52 45 44 5f 4c 4f 43  efine SHARED_LOC
0d30: 4b 20 20 20 20 20 31 0a 23 64 65 66 69 6e 65 20  K     1.#define 
0d40: 52 45 53 45 52 56 45 44 5f 4c 4f 43 4b 20 20 20  RESERVED_LOCK   
0d50: 32 0a 23 64 65 66 69 6e 65 20 50 45 4e 44 49 4e  2.#define PENDIN
0d60: 47 5f 4c 4f 43 4b 20 20 20 20 33 0a 23 64 65 66  G_LOCK    3.#def
0d70: 69 6e 65 20 45 58 43 4c 55 53 49 56 45 5f 4c 4f  ine EXCLUSIVE_LO
0d80: 43 4b 20 20 34 0a 0a 2f 2a 0a 2a 2a 20 46 69 6c  CK  4../*.** Fil
0d90: 65 20 4c 6f 63 6b 69 6e 67 20 4e 6f 74 65 73 3a  e Locking Notes:
0da0: 20 20 28 4d 6f 73 74 6c 79 20 61 62 6f 75 74 20    (Mostly about 
0db0: 77 69 6e 64 6f 77 73 20 62 75 74 20 61 6c 73 6f  windows but also
0dc0: 20 73 6f 6d 65 20 69 6e 66 6f 20 66 6f 72 20 55   some info for U
0dd0: 6e 69 78 29 0a 2a 2a 0a 2a 2a 20 57 65 20 63 61  nix).**.** We ca
0de0: 6e 6e 6f 74 20 75 73 65 20 4c 6f 63 6b 46 69 6c  nnot use LockFil
0df0: 65 45 78 28 29 20 6f 72 20 55 6e 6c 6f 63 6b 46  eEx() or UnlockF
0e00: 69 6c 65 45 78 28 29 20 6f 6e 20 57 69 6e 39 35  ileEx() on Win95
0e10: 2f 39 38 2f 4d 45 20 62 65 63 61 75 73 65 0a 2a  /98/ME because.*
0e20: 2a 20 74 68 6f 73 65 20 66 75 6e 63 74 69 6f 6e  * those function
0e30: 73 20 61 72 65 20 6e 6f 74 20 61 76 61 69 6c 61  s are not availa
0e40: 62 6c 65 2e 20 20 53 6f 20 77 65 20 75 73 65 20  ble.  So we use 
0e50: 6f 6e 6c 79 20 4c 6f 63 6b 46 69 6c 65 28 29 20  only LockFile() 
0e60: 61 6e 64 0a 2a 2a 20 55 6e 6c 6f 63 6b 46 69 6c  and.** UnlockFil
0e70: 65 28 29 2e 0a 2a 2a 0a 2a 2a 20 4c 6f 63 6b 46  e()..**.** LockF
0e80: 69 6c 65 28 29 20 70 72 65 76 65 6e 74 73 20 6e  ile() prevents n
0e90: 6f 74 20 6a 75 73 74 20 77 72 69 74 69 6e 67 20  ot just writing 
0ea0: 62 75 74 20 61 6c 73 6f 20 72 65 61 64 69 6e 67  but also reading
0eb0: 20 62 79 20 6f 74 68 65 72 20 70 72 6f 63 65 73   by other proces
0ec0: 73 65 73 2e 0a 2a 2a 20 41 20 53 48 41 52 45 44  ses..** A SHARED
0ed0: 5f 4c 4f 43 4b 20 69 73 20 6f 62 74 61 69 6e 65  _LOCK is obtaine
0ee0: 64 20 62 79 20 6c 6f 63 6b 69 6e 67 20 61 20 73  d by locking a s
0ef0: 69 6e 67 6c 65 20 72 61 6e 64 6f 6d 6c 79 2d 63  ingle randomly-c
0f00: 68 6f 73 65 6e 20 0a 2a 2a 20 62 79 74 65 20 6f  hosen .** byte o
0f10: 75 74 20 6f 66 20 61 20 73 70 65 63 69 66 69 63  ut of a specific
0f20: 20 72 61 6e 67 65 20 6f 66 20 62 79 74 65 73 2e   range of bytes.
0f30: 20 54 68 65 20 6c 6f 63 6b 20 62 79 74 65 20 69   The lock byte i
0f40: 73 20 6f 62 74 61 69 6e 65 64 20 61 74 20 0a 2a  s obtained at .*
0f50: 2a 20 72 61 6e 64 6f 6d 20 73 6f 20 74 77 6f 20  * random so two 
0f60: 73 65 70 61 72 61 74 65 20 72 65 61 64 65 72 73  separate readers
0f70: 20 63 61 6e 20 70 72 6f 62 61 62 6c 79 20 61 63   can probably ac
0f80: 63 65 73 73 20 74 68 65 20 66 69 6c 65 20 61 74  cess the file at
0f90: 20 74 68 65 20 0a 2a 2a 20 73 61 6d 65 20 74 69   the .** same ti
0fa0: 6d 65 2c 20 75 6e 6c 65 73 73 20 74 68 65 79 20  me, unless they 
0fb0: 61 72 65 20 75 6e 6c 75 63 6b 79 20 61 6e 64 20  are unlucky and 
0fc0: 63 68 6f 6f 73 65 20 74 68 65 20 73 61 6d 65 20  choose the same 
0fd0: 6c 6f 63 6b 20 62 79 74 65 2e 0a 2a 2a 20 41 6e  lock byte..** An
0fe0: 20 45 58 43 4c 55 53 49 56 45 5f 4c 4f 43 4b 20   EXCLUSIVE_LOCK 
0ff0: 69 73 20 6f 62 74 61 69 6e 65 64 20 62 79 20 6c  is obtained by l
1000: 6f 63 6b 69 6e 67 20 61 6c 6c 20 62 79 74 65 73  ocking all bytes
1010: 20 69 6e 20 74 68 65 20 72 61 6e 67 65 2e 0a 2a   in the range..*
1020: 2a 20 54 68 65 72 65 20 63 61 6e 20 6f 6e 6c 79  * There can only
1030: 20 62 65 20 6f 6e 65 20 77 72 69 74 65 72 2e 20   be one writer. 
1040: 20 41 20 52 45 53 45 52 56 45 44 5f 4c 4f 43 4b   A RESERVED_LOCK
1050: 20 69 73 20 6f 62 74 61 69 6e 65 64 20 62 79 20   is obtained by 
1060: 6c 6f 63 6b 69 6e 67 0a 2a 2a 20 61 20 73 69 6e  locking.** a sin
1070: 67 6c 65 20 62 79 74 65 20 6f 66 20 74 68 65 20  gle byte of the 
1080: 66 69 6c 65 20 74 68 61 74 20 69 73 20 64 65 73  file that is des
1090: 69 67 6e 61 74 65 64 20 61 73 20 74 68 65 20 72  ignated as the r
10a0: 65 73 65 72 76 65 64 20 6c 6f 63 6b 20 62 79 74  eserved lock byt
10b0: 65 2e 0a 2a 2a 20 41 20 50 45 4e 44 49 4e 47 5f  e..** A PENDING_
10c0: 4c 4f 43 4b 20 69 73 20 6f 62 74 61 69 6e 65 64  LOCK is obtained
10d0: 20 62 79 20 6c 6f 63 6b 69 6e 67 20 61 20 64 65   by locking a de
10e0: 73 69 67 6e 61 74 65 64 20 62 79 74 65 20 64 69  signated byte di
10f0: 66 66 65 72 65 6e 74 20 66 72 6f 6d 0a 2a 2a 20  fferent from.** 
1100: 74 68 65 20 52 45 53 45 52 56 45 44 5f 4c 4f 43  the RESERVED_LOC
1110: 4b 20 62 79 74 65 2e 0a 2a 2a 0a 2a 2a 20 4f 6e  K byte..**.** On
1120: 20 57 69 6e 4e 54 2f 32 4b 2f 58 50 20 73 79 73   WinNT/2K/XP sys
1130: 74 65 6d 73 2c 20 4c 6f 63 6b 46 69 6c 65 45 78  tems, LockFileEx
1140: 28 29 20 61 6e 64 20 55 6e 6c 6f 63 6b 46 69 6c  () and UnlockFil
1150: 65 45 78 28 29 20 61 72 65 20 61 76 61 69 6c 61  eEx() are availa
1160: 62 6c 65 2c 0a 2a 2a 20 77 68 69 63 68 20 6d 65  ble,.** which me
1170: 61 6e 73 20 77 65 20 63 61 6e 20 75 73 65 20 72  ans we can use r
1180: 65 61 64 65 72 2f 77 72 69 74 65 72 20 6c 6f 63  eader/writer loc
1190: 6b 73 2e 20 20 57 68 65 6e 20 72 65 61 64 65 72  ks.  When reader
11a0: 2f 77 72 69 74 65 72 20 6c 6f 63 6b 73 0a 2a 2a  /writer locks.**
11b0: 20 61 72 65 20 75 73 65 64 2c 20 74 68 65 20 6c   are used, the l
11c0: 6f 63 6b 20 69 73 20 70 6c 61 63 65 64 20 6f 6e  ock is placed on
11d0: 20 74 68 65 20 73 61 6d 65 20 72 61 6e 67 65 20   the same range 
11e0: 6f 66 20 62 79 74 65 73 20 74 68 61 74 20 69 73  of bytes that is
11f0: 20 75 73 65 64 0a 2a 2a 20 66 6f 72 20 70 72 6f   used.** for pro
1200: 62 61 62 69 6c 69 73 74 69 63 20 6c 6f 63 6b 69  babilistic locki
1210: 6e 67 20 69 6e 20 57 69 6e 39 35 2f 39 38 2f 4d  ng in Win95/98/M
1220: 45 2e 20 20 48 65 6e 63 65 2c 20 74 68 65 20 6c  E.  Hence, the l
1230: 6f 63 6b 69 6e 67 20 73 63 68 65 6d 65 0a 2a 2a  ocking scheme.**
1240: 20 77 69 6c 6c 20 73 75 70 70 6f 72 74 20 74 77   will support tw
1250: 6f 20 6f 72 20 6d 6f 72 65 20 57 69 6e 39 35 20  o or more Win95 
1260: 72 65 61 64 65 72 73 20 6f 72 20 74 77 6f 20 6f  readers or two o
1270: 72 20 6d 6f 72 65 20 57 69 6e 4e 54 20 72 65 61  r more WinNT rea
1280: 64 65 72 73 2e 0a 2a 2a 20 42 75 74 20 61 20 73  ders..** But a s
1290: 69 6e 67 6c 65 20 57 69 6e 39 35 20 72 65 61 64  ingle Win95 read
12a0: 65 72 20 77 69 6c 6c 20 6c 6f 63 6b 20 6f 75 74  er will lock out
12b0: 20 61 6c 6c 20 57 69 6e 4e 54 20 72 65 61 64 65   all WinNT reade
12c0: 72 73 20 61 6e 64 20 61 20 73 69 6e 67 6c 65 0a  rs and a single.
12d0: 2a 2a 20 57 69 6e 4e 54 20 72 65 61 64 65 72 20  ** WinNT reader 
12e0: 77 69 6c 6c 20 6c 6f 63 6b 20 6f 75 74 20 61 6c  will lock out al
12f0: 6c 20 6f 74 68 65 72 20 57 69 6e 39 35 20 72 65  l other Win95 re
1300: 61 64 65 72 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  aders..**.** The
1310: 20 66 6f 6c 6c 6f 77 69 6e 67 20 23 64 65 66 69   following #defi
1320: 6e 65 73 20 73 70 65 63 69 66 79 20 74 68 65 20  nes specify the 
1330: 72 61 6e 67 65 20 6f 66 20 62 79 74 65 73 20 75  range of bytes u
1340: 73 65 64 20 66 6f 72 20 6c 6f 63 6b 69 6e 67 2e  sed for locking.
1350: 0a 2a 2a 20 53 48 41 52 45 44 5f 53 49 5a 45 20  .** SHARED_SIZE 
1360: 69 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  is the number of
1370: 20 62 79 74 65 73 20 61 76 61 69 6c 61 62 6c 65   bytes available
1380: 20 69 6e 20 74 68 65 20 70 6f 6f 6c 20 66 72 6f   in the pool fro
1390: 6d 20 77 68 69 63 68 0a 2a 2a 20 61 20 72 61 6e  m which.** a ran
13a0: 64 6f 6d 20 62 79 74 65 20 69 73 20 73 65 6c 65  dom byte is sele
13b0: 63 74 65 64 20 66 6f 72 20 61 20 73 68 61 72 65  cted for a share
13c0: 64 20 6c 6f 63 6b 2e 20 20 54 68 65 20 70 6f 6f  d lock.  The poo
13d0: 6c 20 6f 66 20 62 79 74 65 73 20 66 6f 72 0a 2a  l of bytes for.*
13e0: 2a 20 73 68 61 72 65 64 20 6c 6f 63 6b 73 20 62  * shared locks b
13f0: 65 67 69 6e 73 20 61 74 20 53 48 41 52 45 44 5f  egins at SHARED_
1400: 46 49 52 53 54 2e 20 0a 2a 2a 0a 2a 2a 20 54 68  FIRST. .**.** Th
1410: 65 20 73 61 6d 65 20 6c 6f 63 6b 69 6e 67 20 73  e same locking s
1420: 74 72 61 74 65 67 79 20 61 6e 64 0a 2a 2a 20 62  trategy and.** b
1430: 79 74 65 20 72 61 6e 67 65 73 20 61 72 65 20 75  yte ranges are u
1440: 73 65 64 20 66 6f 72 20 55 6e 69 78 2e 20 20 54  sed for Unix.  T
1450: 68 69 73 20 6c 65 61 76 65 73 20 6f 70 65 6e 20  his leaves open 
1460: 74 68 65 20 70 6f 73 73 69 62 69 6c 69 74 79 20  the possibility 
1470: 6f 66 20 68 61 76 69 6e 67 0a 2a 2a 20 63 6c 69  of having.** cli
1480: 65 6e 74 73 20 6f 6e 20 77 69 6e 39 35 2c 20 77  ents on win95, w
1490: 69 6e 4e 54 2c 20 61 6e 64 20 75 6e 69 78 20 61  inNT, and unix a
14a0: 6c 6c 20 74 61 6c 6b 69 6e 67 20 74 6f 20 74 68  ll talking to th
14b0: 65 20 73 61 6d 65 20 73 68 61 72 65 64 20 66 69  e same shared fi
14c0: 6c 65 0a 2a 2a 20 61 6e 64 20 61 6c 6c 20 6c 6f  le.** and all lo
14d0: 63 6b 69 6e 67 20 63 6f 72 72 65 63 74 6c 79 2e  cking correctly.
14e0: 20 20 54 6f 20 64 6f 20 73 6f 20 77 6f 75 6c 64    To do so would
14f0: 20 72 65 71 75 69 72 65 20 74 68 61 74 20 73 61   require that sa
1500: 6d 62 61 20 28 6f 72 20 77 68 61 74 65 76 65 72  mba (or whatever
1510: 0a 2a 2a 20 74 6f 6f 6c 20 69 73 20 62 65 69 6e  .** tool is bein
1520: 67 20 75 73 65 64 20 66 6f 72 20 66 69 6c 65 20  g used for file 
1530: 73 68 61 72 69 6e 67 29 20 69 6d 70 6c 65 6d 65  sharing) impleme
1540: 6e 74 73 20 6c 6f 63 6b 73 20 63 6f 72 72 65 63  nts locks correc
1550: 74 6c 79 20 62 65 74 77 65 65 6e 0a 2a 2a 20 77  tly between.** w
1560: 69 6e 64 6f 77 73 20 61 6e 64 20 75 6e 69 78 2e  indows and unix.
1570: 20 20 49 27 6d 20 67 75 65 73 73 69 6e 67 20 74    I'm guessing t
1580: 68 61 74 20 69 73 6e 27 74 20 6c 69 6b 65 6c 79  hat isn't likely
1590: 20 74 6f 20 68 61 70 70 65 6e 2c 20 62 75 74 20   to happen, but 
15a0: 62 79 0a 2a 2a 20 75 73 69 6e 67 20 74 68 65 20  by.** using the 
15b0: 73 61 6d 65 20 6c 6f 63 6b 69 6e 67 20 72 61 6e  same locking ran
15c0: 67 65 20 77 65 20 61 72 65 20 61 74 20 6c 65 61  ge we are at lea
15d0: 73 74 20 6f 70 65 6e 20 74 6f 20 74 68 65 20 70  st open to the p
15e0: 6f 73 73 69 62 69 6c 69 74 79 2e 0a 2a 2a 0a 2a  ossibility..**.*
15f0: 2a 20 4c 6f 63 6b 69 6e 67 20 69 6e 20 77 69 6e  * Locking in win
1600: 64 6f 77 73 20 69 73 20 6d 61 6e 64 69 74 6f 72  dows is manditor
1610: 79 2e 20 20 46 6f 72 20 74 68 69 73 20 72 65 61  y.  For this rea
1620: 73 6f 6e 2c 20 77 65 20 63 61 6e 6e 6f 74 20 73  son, we cannot s
1630: 74 6f 72 65 0a 2a 2a 20 61 63 74 75 61 6c 20 64  tore.** actual d
1640: 61 74 61 20 69 6e 20 74 68 65 20 62 79 74 65 73  ata in the bytes
1650: 20 75 73 65 64 20 66 6f 72 20 6c 6f 63 6b 69 6e   used for lockin
1660: 67 2e 20 20 54 68 65 20 70 61 67 65 72 20 6e 65  g.  The pager ne
1670: 76 65 72 20 61 6c 6c 6f 63 61 74 65 73 0a 2a 2a  ver allocates.**
1680: 20 74 68 65 20 70 61 67 65 73 20 69 6e 76 6f 6c   the pages invol
1690: 76 65 64 20 69 6e 20 6c 6f 63 6b 69 6e 67 20 74  ved in locking t
16a0: 68 65 72 65 66 6f 72 65 2e 20 20 53 48 41 52 45  herefore.  SHARE
16b0: 44 5f 53 49 5a 45 20 69 73 20 73 65 6c 65 63 74  D_SIZE is select
16c0: 65 64 20 73 6f 0a 2a 2a 20 74 68 61 74 20 61 6c  ed so.** that al
16d0: 6c 20 6c 6f 63 6b 73 20 77 69 6c 6c 20 66 69 74  l locks will fit
16e0: 20 6f 6e 20 61 20 73 69 6e 67 6c 65 20 70 61 67   on a single pag
16f0: 65 20 65 76 65 6e 20 61 74 20 74 68 65 20 6d 69  e even at the mi
1700: 6e 69 6d 75 6d 20 70 61 67 65 20 73 69 7a 65 2e  nimum page size.
1710: 0a 2a 2a 20 50 45 4e 44 49 4e 47 5f 42 59 54 45  .** PENDING_BYTE
1720: 20 64 65 66 69 6e 65 73 20 74 68 65 20 62 65 67   defines the beg
1730: 69 6e 6e 69 6e 67 20 6f 66 20 74 68 65 20 6c 6f  inning of the lo
1740: 63 6b 73 2e 20 20 42 79 20 64 65 66 61 75 6c 74  cks.  By default
1750: 20 50 45 4e 44 49 4e 47 5f 42 59 54 45 0a 2a 2a   PENDING_BYTE.**
1760: 20 69 73 20 73 65 74 20 68 69 67 68 20 73 6f 20   is set high so 
1770: 74 68 61 74 20 77 65 20 64 6f 6e 27 74 20 68 61  that we don't ha
1780: 76 65 20 74 6f 20 61 6c 6c 6f 63 61 74 65 20 61  ve to allocate a
1790: 6e 20 75 6e 75 73 65 64 20 70 61 67 65 20 65 78  n unused page ex
17a0: 63 65 70 74 0a 2a 2a 20 66 6f 72 20 76 65 72 79  cept.** for very
17b0: 20 6c 61 72 67 65 20 64 61 74 61 62 61 73 65 73   large databases
17c0: 2e 20 20 42 75 74 20 6f 6e 65 20 73 68 6f 75 6c  .  But one shoul
17d0: 64 20 74 65 73 74 20 74 68 65 20 70 61 67 65 20  d test the page 
17e0: 73 6b 69 70 70 69 6e 67 20 6c 6f 67 69 63 20 0a  skipping logic .
17f0: 2a 2a 20 62 79 20 73 65 74 74 69 6e 67 20 50 45  ** by setting PE
1800: 4e 44 49 4e 47 5f 42 59 54 45 20 6c 6f 77 20 61  NDING_BYTE low a
1810: 6e 64 20 72 75 6e 6e 69 6e 67 20 74 68 65 20 65  nd running the e
1820: 6e 74 69 72 65 20 72 65 67 72 65 73 73 69 6f 6e  ntire regression
1830: 20 73 75 69 74 65 2e 0a 2a 2a 0a 2a 2a 20 43 68   suite..**.** Ch
1840: 61 6e 67 69 6e 67 20 74 68 65 20 76 61 6c 75 65  anging the value
1850: 20 6f 66 20 50 45 4e 44 49 4e 47 5f 42 59 54 45   of PENDING_BYTE
1860: 20 72 65 73 75 6c 74 73 20 69 6e 20 61 20 73 75   results in a su
1870: 62 74 6c 79 20 69 6e 63 6f 6d 70 61 74 69 62 6c  btly incompatibl
1880: 65 0a 2a 2a 20 66 69 6c 65 20 66 6f 72 6d 61 74  e.** file format
1890: 2e 20 20 44 65 70 65 6e 64 69 6e 67 20 6f 6e 20  .  Depending on 
18a0: 68 6f 77 20 69 74 20 69 73 20 63 68 61 6e 67 65  how it is change
18b0: 64 2c 20 79 6f 75 20 6d 69 67 68 74 20 6e 6f 74  d, you might not
18c0: 20 6e 6f 74 69 63 65 0a 2a 2a 20 74 68 65 20 69   notice.** the i
18d0: 6e 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 20 72  ncompatibility r
18e0: 69 67 68 74 20 61 77 61 79 2c 20 65 76 65 6e 20  ight away, even 
18f0: 72 75 6e 6e 69 6e 67 20 61 20 66 75 6c 6c 20 72  running a full r
1900: 65 67 72 65 73 73 69 6f 6e 20 74 65 73 74 2e 0a  egression test..
1910: 2a 2a 20 54 68 65 20 64 65 66 61 75 6c 74 20 6c  ** The default l
1920: 6f 63 61 74 69 6f 6e 20 6f 66 20 50 45 4e 44 49  ocation of PENDI
1930: 4e 47 5f 42 59 54 45 20 69 73 20 74 68 65 20 66  NG_BYTE is the f
1940: 69 72 73 74 20 62 79 74 65 20 70 61 73 74 20 74  irst byte past t
1950: 68 65 0a 2a 2a 20 31 47 42 20 62 6f 75 6e 64 61  he.** 1GB bounda
1960: 72 79 2e 0a 2a 2a 0a 2a 2f 0a 23 69 66 64 65 66  ry..**.*/.#ifdef
1970: 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 57 53 44   SQLITE_OMIT_WSD
1980: 0a 23 20 64 65 66 69 6e 65 20 50 45 4e 44 49 4e  .# define PENDIN
1990: 47 5f 42 59 54 45 20 20 20 20 20 28 30 78 34 30  G_BYTE     (0x40
19a0: 30 30 30 30 30 30 29 0a 23 65 6c 73 65 0a 23 20  000000).#else.# 
19b0: 64 65 66 69 6e 65 20 50 45 4e 44 49 4e 47 5f 42  define PENDING_B
19c0: 59 54 45 20 20 20 20 20 20 73 71 6c 69 74 65 33  YTE      sqlite3
19d0: 50 65 6e 64 69 6e 67 42 79 74 65 0a 23 65 6e 64  PendingByte.#end
19e0: 69 66 0a 23 64 65 66 69 6e 65 20 52 45 53 45 52  if.#define RESER
19f0: 56 45 44 5f 42 59 54 45 20 20 20 20 20 28 50 45  VED_BYTE     (PE
1a00: 4e 44 49 4e 47 5f 42 59 54 45 2b 31 29 0a 23 64  NDING_BYTE+1).#d
1a10: 65 66 69 6e 65 20 53 48 41 52 45 44 5f 46 49 52  efine SHARED_FIR
1a20: 53 54 20 20 20 20 20 20 28 50 45 4e 44 49 4e 47  ST      (PENDING
1a30: 5f 42 59 54 45 2b 32 29 0a 23 64 65 66 69 6e 65  _BYTE+2).#define
1a40: 20 53 48 41 52 45 44 5f 53 49 5a 45 20 20 20 20   SHARED_SIZE    
1a50: 20 20 20 35 31 30 0a 0a 2f 2a 0a 2a 2a 20 57 72     510../*.** Wr
1a60: 61 70 70 65 72 20 61 72 6f 75 6e 64 20 4f 53 20  apper around OS 
1a70: 73 70 65 63 69 66 69 63 20 73 71 6c 69 74 65 33  specific sqlite3
1a80: 5f 6f 73 5f 69 6e 69 74 28 29 20 66 75 6e 63 74  _os_init() funct
1a90: 69 6f 6e 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  ion..*/.int sqli
1aa0: 74 65 33 4f 73 49 6e 69 74 28 76 6f 69 64 29 3b  te3OsInit(void);
1ab0: 0a 0a 2f 2a 20 0a 2a 2a 20 46 75 6e 63 74 69 6f  ../* .** Functio
1ac0: 6e 73 20 66 6f 72 20 61 63 63 65 73 73 69 6e 67  ns for accessing
1ad0: 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 20 6d 65   sqlite3_file me
1ae0: 74 68 6f 64 73 20 0a 2a 2f 0a 69 6e 74 20 73 71  thods .*/.int sq
1af0: 6c 69 74 65 33 4f 73 43 6c 6f 73 65 28 73 71 6c  lite3OsClose(sql
1b00: 69 74 65 33 5f 66 69 6c 65 2a 29 3b 0a 69 6e 74  ite3_file*);.int
1b10: 20 73 71 6c 69 74 65 33 4f 73 52 65 61 64 28 73   sqlite3OsRead(s
1b20: 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 76 6f  qlite3_file*, vo
1b30: 69 64 2a 2c 20 69 6e 74 20 61 6d 74 2c 20 69 36  id*, int amt, i6
1b40: 34 20 6f 66 66 73 65 74 29 3b 0a 69 6e 74 20 73  4 offset);.int s
1b50: 71 6c 69 74 65 33 4f 73 57 72 69 74 65 28 73 71  qlite3OsWrite(sq
1b60: 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 63 6f 6e  lite3_file*, con
1b70: 73 74 20 76 6f 69 64 2a 2c 20 69 6e 74 20 61 6d  st void*, int am
1b80: 74 2c 20 69 36 34 20 6f 66 66 73 65 74 29 3b 0a  t, i64 offset);.
1b90: 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 54 72 75  int sqlite3OsTru
1ba0: 6e 63 61 74 65 28 73 71 6c 69 74 65 33 5f 66 69  ncate(sqlite3_fi
1bb0: 6c 65 2a 2c 20 69 36 34 20 73 69 7a 65 29 3b 0a  le*, i64 size);.
1bc0: 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 53 79 6e  int sqlite3OsSyn
1bd0: 63 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c  c(sqlite3_file*,
1be0: 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74   int);.int sqlit
1bf0: 65 33 4f 73 46 69 6c 65 53 69 7a 65 28 73 71 6c  e3OsFileSize(sql
1c00: 69 74 65 33 5f 66 69 6c 65 2a 2c 20 69 36 34 20  ite3_file*, i64 
1c10: 2a 70 53 69 7a 65 29 3b 0a 69 6e 74 20 73 71 6c  *pSize);.int sql
1c20: 69 74 65 33 4f 73 4c 6f 63 6b 28 73 71 6c 69 74  ite3OsLock(sqlit
1c30: 65 33 5f 66 69 6c 65 2a 2c 20 69 6e 74 29 3b 0a  e3_file*, int);.
1c40: 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 55 6e 6c  int sqlite3OsUnl
1c50: 6f 63 6b 28 73 71 6c 69 74 65 33 5f 66 69 6c 65  ock(sqlite3_file
1c60: 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c  *, int);.int sql
1c70: 69 74 65 33 4f 73 43 68 65 63 6b 52 65 73 65 72  ite3OsCheckReser
1c80: 76 65 64 4c 6f 63 6b 28 73 71 6c 69 74 65 33 5f  vedLock(sqlite3_
1c90: 66 69 6c 65 20 2a 69 64 2c 20 69 6e 74 20 2a 70  file *id, int *p
1ca0: 52 65 73 4f 75 74 29 3b 0a 69 6e 74 20 73 71 6c  ResOut);.int sql
1cb0: 69 74 65 33 4f 73 46 69 6c 65 43 6f 6e 74 72 6f  ite3OsFileContro
1cc0: 6c 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c  l(sqlite3_file*,
1cd0: 69 6e 74 2c 76 6f 69 64 2a 29 3b 0a 76 6f 69 64  int,void*);.void
1ce0: 20 73 71 6c 69 74 65 33 4f 73 46 69 6c 65 43 6f   sqlite3OsFileCo
1cf0: 6e 74 72 6f 6c 48 69 6e 74 28 73 71 6c 69 74 65  ntrolHint(sqlite
1d00: 33 5f 66 69 6c 65 2a 2c 69 6e 74 2c 76 6f 69 64  3_file*,int,void
1d10: 2a 29 3b 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  *);.#define SQLI
1d20: 54 45 5f 46 43 4e 54 4c 5f 44 42 5f 55 4e 43 48  TE_FCNTL_DB_UNCH
1d30: 41 4e 47 45 44 20 30 78 63 61 30 39 33 66 61 30  ANGED 0xca093fa0
1d40: 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 53 65  .int sqlite3OsSe
1d50: 63 74 6f 72 53 69 7a 65 28 73 71 6c 69 74 65 33  ctorSize(sqlite3
1d60: 5f 66 69 6c 65 20 2a 69 64 29 3b 0a 69 6e 74 20  _file *id);.int 
1d70: 73 71 6c 69 74 65 33 4f 73 44 65 76 69 63 65 43  sqlite3OsDeviceC
1d80: 68 61 72 61 63 74 65 72 69 73 74 69 63 73 28 73  haracteristics(s
1d90: 71 6c 69 74 65 33 5f 66 69 6c 65 20 2a 69 64 29  qlite3_file *id)
1da0: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 53  ;.int sqlite3OsS
1db0: 68 6d 4d 61 70 28 73 71 6c 69 74 65 33 5f 66 69  hmMap(sqlite3_fi
1dc0: 6c 65 20 2a 2c 69 6e 74 2c 69 6e 74 2c 69 6e 74  le *,int,int,int
1dd0: 2c 76 6f 69 64 20 76 6f 6c 61 74 69 6c 65 20 2a  ,void volatile *
1de0: 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f  *);.int sqlite3O
1df0: 73 53 68 6d 4c 6f 63 6b 28 73 71 6c 69 74 65 33  sShmLock(sqlite3
1e00: 5f 66 69 6c 65 20 2a 69 64 2c 20 69 6e 74 2c 20  _file *id, int, 
1e10: 69 6e 74 2c 20 69 6e 74 29 3b 0a 76 6f 69 64 20  int, int);.void 
1e20: 73 71 6c 69 74 65 33 4f 73 53 68 6d 42 61 72 72  sqlite3OsShmBarr
1e30: 69 65 72 28 73 71 6c 69 74 65 33 5f 66 69 6c 65  ier(sqlite3_file
1e40: 20 2a 69 64 29 3b 0a 69 6e 74 20 73 71 6c 69 74   *id);.int sqlit
1e50: 65 33 4f 73 53 68 6d 55 6e 6d 61 70 28 73 71 6c  e3OsShmUnmap(sql
1e60: 69 74 65 33 5f 66 69 6c 65 20 2a 69 64 2c 20 69  ite3_file *id, i
1e70: 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  nt);.int sqlite3
1e80: 4f 73 46 65 74 63 68 28 73 71 6c 69 74 65 33 5f  OsFetch(sqlite3_
1e90: 66 69 6c 65 20 2a 69 64 2c 20 69 36 34 2c 20 69  file *id, i64, i
1ea0: 6e 74 2c 20 76 6f 69 64 20 2a 2a 29 3b 0a 69 6e  nt, void **);.in
1eb0: 74 20 73 71 6c 69 74 65 33 4f 73 55 6e 66 65 74  t sqlite3OsUnfet
1ec0: 63 68 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 20  ch(sqlite3_file 
1ed0: 2a 2c 20 69 36 34 2c 20 76 6f 69 64 20 2a 29 3b  *, i64, void *);
1ee0: 0a 0a 0a 2f 2a 20 0a 2a 2a 20 46 75 6e 63 74 69  .../* .** Functi
1ef0: 6f 6e 73 20 66 6f 72 20 61 63 63 65 73 73 69 6e  ons for accessin
1f00: 67 20 73 71 6c 69 74 65 33 5f 76 66 73 20 6d 65  g sqlite3_vfs me
1f10: 74 68 6f 64 73 20 0a 2a 2f 0a 69 6e 74 20 73 71  thods .*/.int sq
1f20: 6c 69 74 65 33 4f 73 4f 70 65 6e 28 73 71 6c 69  lite3OsOpen(sqli
1f30: 74 65 33 5f 76 66 73 20 2a 2c 20 63 6f 6e 73 74  te3_vfs *, const
1f40: 20 63 68 61 72 20 2a 2c 20 73 71 6c 69 74 65 33   char *, sqlite3
1f50: 5f 66 69 6c 65 2a 2c 20 69 6e 74 2c 20 69 6e 74  _file*, int, int
1f60: 20 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33   *);.int sqlite3
1f70: 4f 73 44 65 6c 65 74 65 28 73 71 6c 69 74 65 33  OsDelete(sqlite3
1f80: 5f 76 66 73 20 2a 2c 20 63 6f 6e 73 74 20 63 68  _vfs *, const ch
1f90: 61 72 20 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20  ar *, int);.int 
1fa0: 73 71 6c 69 74 65 33 4f 73 41 63 63 65 73 73 28  sqlite3OsAccess(
1fb0: 73 71 6c 69 74 65 33 5f 76 66 73 20 2a 2c 20 63  sqlite3_vfs *, c
1fc0: 6f 6e 73 74 20 63 68 61 72 20 2a 2c 20 69 6e 74  onst char *, int
1fd0: 2c 20 69 6e 74 20 2a 70 52 65 73 4f 75 74 29 3b  , int *pResOut);
1fe0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 46 75  .int sqlite3OsFu
1ff0: 6c 6c 50 61 74 68 6e 61 6d 65 28 73 71 6c 69 74  llPathname(sqlit
2000: 65 33 5f 76 66 73 20 2a 2c 20 63 6f 6e 73 74 20  e3_vfs *, const 
2010: 63 68 61 72 20 2a 2c 20 69 6e 74 2c 20 63 68 61  char *, int, cha
2020: 72 20 2a 29 3b 0a 23 69 66 6e 64 65 66 20 53 51  r *);.#ifndef SQ
2030: 4c 49 54 45 5f 4f 4d 49 54 5f 4c 4f 41 44 5f 45  LITE_OMIT_LOAD_E
2040: 58 54 45 4e 53 49 4f 4e 0a 76 6f 69 64 20 2a 73  XTENSION.void *s
2050: 71 6c 69 74 65 33 4f 73 44 6c 4f 70 65 6e 28 73  qlite3OsDlOpen(s
2060: 71 6c 69 74 65 33 5f 76 66 73 20 2a 2c 20 63 6f  qlite3_vfs *, co
2070: 6e 73 74 20 63 68 61 72 20 2a 29 3b 0a 76 6f 69  nst char *);.voi
2080: 64 20 73 71 6c 69 74 65 33 4f 73 44 6c 45 72 72  d sqlite3OsDlErr
2090: 6f 72 28 73 71 6c 69 74 65 33 5f 76 66 73 20 2a  or(sqlite3_vfs *
20a0: 2c 20 69 6e 74 2c 20 63 68 61 72 20 2a 29 3b 0a  , int, char *);.
20b0: 76 6f 69 64 20 28 2a 73 71 6c 69 74 65 33 4f 73  void (*sqlite3Os
20c0: 44 6c 53 79 6d 28 73 71 6c 69 74 65 33 5f 76 66  DlSym(sqlite3_vf
20d0: 73 20 2a 2c 20 76 6f 69 64 20 2a 2c 20 63 6f 6e  s *, void *, con
20e0: 73 74 20 63 68 61 72 20 2a 29 29 28 76 6f 69 64  st char *))(void
20f0: 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 4f  );.void sqlite3O
2100: 73 44 6c 43 6c 6f 73 65 28 73 71 6c 69 74 65 33  sDlClose(sqlite3
2110: 5f 76 66 73 20 2a 2c 20 76 6f 69 64 20 2a 29 3b  _vfs *, void *);
2120: 0a 23 65 6e 64 69 66 20 2f 2a 20 53 51 4c 49 54  .#endif /* SQLIT
2130: 45 5f 4f 4d 49 54 5f 4c 4f 41 44 5f 45 58 54 45  E_OMIT_LOAD_EXTE
2140: 4e 53 49 4f 4e 20 2a 2f 0a 69 6e 74 20 73 71 6c  NSION */.int sql
2150: 69 74 65 33 4f 73 52 61 6e 64 6f 6d 6e 65 73 73  ite3OsRandomness
2160: 28 73 71 6c 69 74 65 33 5f 76 66 73 20 2a 2c 20  (sqlite3_vfs *, 
2170: 69 6e 74 2c 20 63 68 61 72 20 2a 29 3b 0a 69 6e  int, char *);.in
2180: 74 20 73 71 6c 69 74 65 33 4f 73 53 6c 65 65 70  t sqlite3OsSleep
2190: 28 73 71 6c 69 74 65 33 5f 76 66 73 20 2a 2c 20  (sqlite3_vfs *, 
21a0: 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  int);.int sqlite
21b0: 33 4f 73 47 65 74 4c 61 73 74 45 72 72 6f 72 28  3OsGetLastError(
21c0: 73 71 6c 69 74 65 33 5f 76 66 73 2a 29 3b 0a 69  sqlite3_vfs*);.i
21d0: 6e 74 20 73 71 6c 69 74 65 33 4f 73 43 75 72 72  nt sqlite3OsCurr
21e0: 65 6e 74 54 69 6d 65 49 6e 74 36 34 28 73 71 6c  entTimeInt64(sql
21f0: 69 74 65 33 5f 76 66 73 20 2a 2c 20 73 71 6c 69  ite3_vfs *, sqli
2200: 74 65 33 5f 69 6e 74 36 34 2a 29 3b 0a 0a 2f 2a  te3_int64*);../*
2210: 0a 2a 2a 20 43 6f 6e 76 65 6e 69 65 6e 63 65 20  .** Convenience 
2220: 66 75 6e 63 74 69 6f 6e 73 20 66 6f 72 20 6f 70  functions for op
2230: 65 6e 69 6e 67 20 61 6e 64 20 63 6c 6f 73 69 6e  ening and closin
2240: 67 20 66 69 6c 65 73 20 75 73 69 6e 67 20 0a 2a  g files using .*
2250: 2a 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63  * sqlite3_malloc
2260: 28 29 20 74 6f 20 6f 62 74 61 69 6e 20 73 70 61  () to obtain spa
2270: 63 65 20 66 6f 72 20 74 68 65 20 66 69 6c 65 2d  ce for the file-
2280: 68 61 6e 64 6c 65 20 73 74 72 75 63 74 75 72 65  handle structure
2290: 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
22a0: 4f 73 4f 70 65 6e 4d 61 6c 6c 6f 63 28 73 71 6c  OsOpenMalloc(sql
22b0: 69 74 65 33 5f 76 66 73 20 2a 2c 20 63 6f 6e 73  ite3_vfs *, cons
22c0: 74 20 63 68 61 72 20 2a 2c 20 73 71 6c 69 74 65  t char *, sqlite
22d0: 33 5f 66 69 6c 65 20 2a 2a 2c 20 69 6e 74 2c 69  3_file **, int,i
22e0: 6e 74 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  nt*);.int sqlite
22f0: 33 4f 73 43 6c 6f 73 65 46 72 65 65 28 73 71 6c  3OsCloseFree(sql
2300: 69 74 65 33 5f 66 69 6c 65 20 2a 29 3b 0a 0a 23  ite3_file *);..#
2310: 65 6e 64 69 66 20 2f 2a 20 5f 53 51 4c 49 54 45  endif /* _SQLITE
2320: 5f 4f 53 5f 48 5f 20 2a 2f 0a                    _OS_H_ */.