/ Hex Artifact Content
Login

Artifact 4650e98aadd27abfe1698ff58edf6893c58d4881:


0000: 2f 2a 0a 2a 2a 20 32 30 30 35 20 4e 6f 76 65 6d  /*.** 2005 Novem
0010: 62 65 72 20 32 39 0a 2a 2a 0a 2a 2a 20 54 68 65  ber 29.**.** The
0020: 20 61 75 74 68 6f 72 20 64 69 73 63 6c 61 69 6d   author disclaim
0030: 73 20 63 6f 70 79 72 69 67 68 74 20 74 6f 20 74  s copyright to t
0040: 68 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65 2e  his source code.
0050: 20 20 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a 2a    In place of.**
0060: 20 61 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65 2c   a legal notice,
0070: 20 68 65 72 65 20 69 73 20 61 20 62 6c 65 73 73   here is a bless
0080: 69 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d 61  ing:.**.**    Ma
0090: 79 20 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61 6e  y you do good an
00a0: 64 20 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20 20  d not evil..**  
00b0: 20 20 4d 61 79 20 79 6f 75 20 66 69 6e 64 20 66    May you find f
00c0: 6f 72 67 69 76 65 6e 65 73 73 20 66 6f 72 20 79  orgiveness for y
00d0: 6f 75 72 73 65 6c 66 20 61 6e 64 20 66 6f 72 67  ourself and forg
00e0: 69 76 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20 20  ive others..**  
00f0: 20 20 4d 61 79 20 79 6f 75 20 73 68 61 72 65 20    May you share 
0100: 66 72 65 65 6c 79 2c 20 6e 65 76 65 72 20 74 61  freely, never ta
0110: 6b 69 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20 79  king more than y
0120: 6f 75 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a 2a  ou 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 0a 2a 2a 0a 2a 2a  **********.**.**
0180: 20 54 68 69 73 20 66 69 6c 65 20 63 6f 6e 74 61   This file conta
0190: 69 6e 73 20 4f 53 20 69 6e 74 65 72 66 61 63 65  ins OS interface
01a0: 20 63 6f 64 65 20 74 68 61 74 20 69 73 20 63 6f   code that is co
01b0: 6d 6d 6f 6e 20 74 6f 20 61 6c 6c 0a 2a 2a 20 61  mmon to all.** a
01c0: 72 63 68 69 74 65 63 74 75 72 65 73 2e 0a 2a 2f  rchitectures..*/
01d0: 0a 23 64 65 66 69 6e 65 20 5f 53 51 4c 49 54 45  .#define _SQLITE
01e0: 5f 4f 53 5f 43 5f 20 31 0a 23 69 6e 63 6c 75 64  _OS_C_ 1.#includ
01f0: 65 20 22 73 71 6c 69 74 65 49 6e 74 2e 68 22 0a  e "sqliteInt.h".
0200: 23 69 6e 63 6c 75 64 65 20 22 6f 73 2e 68 22 0a  #include "os.h".
0210: 23 75 6e 64 65 66 20 5f 53 51 4c 49 54 45 5f 4f  #undef _SQLITE_O
0220: 53 5f 43 5f 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20  S_C_../*.** The 
0230: 66 6f 6c 6c 6f 77 69 6e 67 20 72 6f 75 74 69 6e  following routin
0240: 65 73 20 61 72 65 20 63 6f 6e 76 65 6e 69 65 6e  es are convenien
0250: 63 65 20 77 72 61 70 70 65 72 73 20 61 72 6f 75  ce wrappers arou
0260: 6e 64 20 6d 65 74 68 6f 64 73 0a 2a 2a 20 6f 66  nd methods.** of
0270: 20 74 68 65 20 4f 73 46 69 6c 65 20 6f 62 6a 65   the OsFile obje
0280: 63 74 2e 20 20 54 68 69 73 20 69 73 20 6d 6f 73  ct.  This is mos
0290: 74 6c 79 20 6a 75 73 74 20 73 79 6e 74 61 63 74  tly just syntact
02a0: 69 63 20 73 75 67 61 72 2e 20 20 41 6c 6c 0a 2a  ic sugar.  All.*
02b0: 2a 20 6f 66 20 74 68 69 73 20 77 6f 75 6c 64 20  * of this would 
02c0: 62 65 20 63 6f 6d 70 6c 65 74 65 6c 79 20 61 75  be completely au
02d0: 74 6f 6d 61 74 69 63 20 69 66 20 53 51 4c 69 74  tomatic if SQLit
02e0: 65 20 77 65 72 65 20 63 6f 64 65 64 20 75 73 69  e were coded usi
02f0: 6e 67 0a 2a 2a 20 43 2b 2b 20 69 6e 73 74 65 61  ng.** C++ instea
0300: 64 20 6f 66 20 70 6c 61 69 6e 20 6f 6c 64 20 43  d of plain old C
0310: 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
0320: 4f 73 43 6c 6f 73 65 28 4f 73 46 69 6c 65 20 2a  OsClose(OsFile *
0330: 2a 70 49 64 29 7b 0a 20 20 4f 73 46 69 6c 65 20  *pId){.  OsFile 
0340: 2a 69 64 3b 0a 20 20 69 66 28 20 70 49 64 21 3d  *id;.  if( pId!=
0350: 30 20 26 26 20 28 69 64 20 3d 20 2a 70 49 64 29  0 && (id = *pId)
0360: 21 3d 30 20 29 7b 0a 20 20 20 20 72 65 74 75 72  !=0 ){.    retur
0370: 6e 20 69 64 2d 3e 70 4d 65 74 68 6f 64 2d 3e 78  n id->pMethod->x
0380: 43 6c 6f 73 65 28 70 49 64 29 3b 0a 20 20 7d 65  Close(pId);.  }e
0390: 6c 73 65 7b 0a 20 20 20 20 72 65 74 75 72 6e 20  lse{.    return 
03a0: 53 51 4c 49 54 45 5f 4f 4b 3b 0a 20 20 7d 0a 7d  SQLITE_OK;.  }.}
03b0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 4f 70  .int sqlite3OsOp
03c0: 65 6e 44 69 72 65 63 74 6f 72 79 28 4f 73 46 69  enDirectory(OsFi
03d0: 6c 65 20 2a 69 64 2c 20 63 6f 6e 73 74 20 63 68  le *id, const ch
03e0: 61 72 20 2a 7a 4e 61 6d 65 29 7b 0a 20 20 72 65  ar *zName){.  re
03f0: 74 75 72 6e 20 69 64 2d 3e 70 4d 65 74 68 6f 64  turn id->pMethod
0400: 2d 3e 78 4f 70 65 6e 44 69 72 65 63 74 6f 72 79  ->xOpenDirectory
0410: 28 69 64 2c 20 7a 4e 61 6d 65 29 3b 0a 7d 0a 69  (id, zName);.}.i
0420: 6e 74 20 73 71 6c 69 74 65 33 4f 73 52 65 61 64  nt sqlite3OsRead
0430: 28 4f 73 46 69 6c 65 20 2a 69 64 2c 20 76 6f 69  (OsFile *id, voi
0440: 64 20 2a 70 42 75 66 2c 20 69 6e 74 20 61 6d 74  d *pBuf, int amt
0450: 29 7b 0a 20 20 72 65 74 75 72 6e 20 69 64 2d 3e  ){.  return id->
0460: 70 4d 65 74 68 6f 64 2d 3e 78 52 65 61 64 28 69  pMethod->xRead(i
0470: 64 2c 20 70 42 75 66 2c 20 61 6d 74 29 3b 0a 7d  d, pBuf, amt);.}
0480: 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 57 72  .int sqlite3OsWr
0490: 69 74 65 28 4f 73 46 69 6c 65 20 2a 69 64 2c 20  ite(OsFile *id, 
04a0: 63 6f 6e 73 74 20 76 6f 69 64 20 2a 70 42 75 66  const void *pBuf
04b0: 2c 20 69 6e 74 20 61 6d 74 29 7b 0a 20 20 72 65  , int amt){.  re
04c0: 74 75 72 6e 20 69 64 2d 3e 70 4d 65 74 68 6f 64  turn id->pMethod
04d0: 2d 3e 78 57 72 69 74 65 28 69 64 2c 20 70 42 75  ->xWrite(id, pBu
04e0: 66 2c 20 61 6d 74 29 3b 0a 7d 0a 69 6e 74 20 73  f, amt);.}.int s
04f0: 71 6c 69 74 65 33 4f 73 53 65 65 6b 28 4f 73 46  qlite3OsSeek(OsF
0500: 69 6c 65 20 2a 69 64 2c 20 69 36 34 20 6f 66 66  ile *id, i64 off
0510: 73 65 74 29 7b 0a 20 20 72 65 74 75 72 6e 20 69  set){.  return i
0520: 64 2d 3e 70 4d 65 74 68 6f 64 2d 3e 78 53 65 65  d->pMethod->xSee
0530: 6b 28 69 64 2c 20 6f 66 66 73 65 74 29 3b 0a 7d  k(id, offset);.}
0540: 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 54 72  .int sqlite3OsTr
0550: 75 6e 63 61 74 65 28 4f 73 46 69 6c 65 20 2a 69  uncate(OsFile *i
0560: 64 2c 20 69 36 34 20 73 69 7a 65 29 7b 0a 20 20  d, i64 size){.  
0570: 72 65 74 75 72 6e 20 69 64 2d 3e 70 4d 65 74 68  return id->pMeth
0580: 6f 64 2d 3e 78 54 72 75 6e 63 61 74 65 28 69 64  od->xTruncate(id
0590: 2c 20 73 69 7a 65 29 3b 0a 7d 0a 69 6e 74 20 73  , size);.}.int s
05a0: 71 6c 69 74 65 33 4f 73 53 79 6e 63 28 4f 73 46  qlite3OsSync(OsF
05b0: 69 6c 65 20 2a 69 64 2c 20 69 6e 74 20 66 75 6c  ile *id, int ful
05c0: 6c 73 79 6e 63 29 7b 0a 20 20 72 65 74 75 72 6e  lsync){.  return
05d0: 20 69 64 2d 3e 70 4d 65 74 68 6f 64 2d 3e 78 53   id->pMethod->xS
05e0: 79 6e 63 28 69 64 2c 20 66 75 6c 6c 73 79 6e 63  ync(id, fullsync
05f0: 29 3b 0a 7d 0a 76 6f 69 64 20 73 71 6c 69 74 65  );.}.void sqlite
0600: 33 4f 73 53 65 74 46 75 6c 6c 53 79 6e 63 28 4f  3OsSetFullSync(O
0610: 73 46 69 6c 65 20 2a 69 64 2c 20 69 6e 74 20 76  sFile *id, int v
0620: 61 6c 75 65 29 7b 0a 20 20 69 64 2d 3e 70 4d 65  alue){.  id->pMe
0630: 74 68 6f 64 2d 3e 78 53 65 74 46 75 6c 6c 53 79  thod->xSetFullSy
0640: 6e 63 28 69 64 2c 20 76 61 6c 75 65 29 3b 0a 7d  nc(id, value);.}
0650: 0a 23 69 66 20 64 65 66 69 6e 65 64 28 53 51 4c  .#if defined(SQL
0660: 49 54 45 5f 54 45 53 54 29 20 7c 7c 20 64 65 66  ITE_TEST) || def
0670: 69 6e 65 64 28 53 51 4c 49 54 45 5f 44 45 42 55  ined(SQLITE_DEBU
0680: 47 29 0a 2f 2a 20 54 68 69 73 20 6d 65 74 68 6f  G)./* This metho
0690: 64 20 69 73 20 63 75 72 72 65 6e 74 6c 79 20 6f  d is currently o
06a0: 6e 6c 79 20 75 73 65 64 20 77 68 69 6c 65 20 69  nly used while i
06b0: 6e 74 65 72 61 63 74 69 76 65 6c 79 20 64 65 62  nteractively deb
06c0: 75 67 67 69 6e 67 20 74 68 65 20 0a 2a 2a 20 70  ugging the .** p
06d0: 61 67 65 72 2e 20 4d 6f 72 65 20 73 70 65 63 69  ager. More speci
06e0: 66 69 63 6c 79 2c 20 69 74 20 63 61 6e 20 6f 6e  ficly, it can on
06f0: 6c 79 20 62 65 20 75 73 65 64 20 77 68 65 6e 20  ly be used when 
0700: 73 71 6c 69 74 65 33 44 65 62 75 67 50 72 69 6e  sqlite3DebugPrin
0710: 74 66 28 29 20 69 73 0a 2a 2a 20 69 6e 63 6c 75  tf() is.** inclu
0720: 64 65 64 20 69 6e 20 74 68 65 20 62 75 69 6c 64  ded in the build
0730: 2e 20 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  . */.int sqlite3
0740: 4f 73 46 69 6c 65 48 61 6e 64 6c 65 28 4f 73 46  OsFileHandle(OsF
0750: 69 6c 65 20 2a 69 64 29 7b 0a 20 20 72 65 74 75  ile *id){.  retu
0760: 72 6e 20 69 64 2d 3e 70 4d 65 74 68 6f 64 2d 3e  rn id->pMethod->
0770: 78 46 69 6c 65 48 61 6e 64 6c 65 28 69 64 29 3b  xFileHandle(id);
0780: 0a 7d 0a 23 65 6e 64 69 66 0a 69 6e 74 20 73 71  .}.#endif.int sq
0790: 6c 69 74 65 33 4f 73 46 69 6c 65 53 69 7a 65 28  lite3OsFileSize(
07a0: 4f 73 46 69 6c 65 20 2a 69 64 2c 20 69 36 34 20  OsFile *id, i64 
07b0: 2a 70 53 69 7a 65 29 7b 0a 20 20 72 65 74 75 72  *pSize){.  retur
07c0: 6e 20 69 64 2d 3e 70 4d 65 74 68 6f 64 2d 3e 78  n id->pMethod->x
07d0: 46 69 6c 65 53 69 7a 65 28 69 64 2c 20 70 53 69  FileSize(id, pSi
07e0: 7a 65 29 3b 0a 7d 0a 69 6e 74 20 73 71 6c 69 74  ze);.}.int sqlit
07f0: 65 33 4f 73 4c 6f 63 6b 28 4f 73 46 69 6c 65 20  e3OsLock(OsFile 
0800: 2a 69 64 2c 20 69 6e 74 20 6c 6f 63 6b 54 79 70  *id, int lockTyp
0810: 65 29 7b 0a 20 20 72 65 74 75 72 6e 20 69 64 2d  e){.  return id-
0820: 3e 70 4d 65 74 68 6f 64 2d 3e 78 4c 6f 63 6b 28  >pMethod->xLock(
0830: 69 64 2c 20 6c 6f 63 6b 54 79 70 65 29 3b 0a 7d  id, lockType);.}
0840: 0a 69 6e 74 20 73 71 6c 69 74 65 33 4f 73 55 6e  .int sqlite3OsUn
0850: 6c 6f 63 6b 28 4f 73 46 69 6c 65 20 2a 69 64 2c  lock(OsFile *id,
0860: 20 69 6e 74 20 6c 6f 63 6b 54 79 70 65 29 7b 0a   int lockType){.
0870: 20 20 72 65 74 75 72 6e 20 69 64 2d 3e 70 4d 65    return id->pMe
0880: 74 68 6f 64 2d 3e 78 55 6e 6c 6f 63 6b 28 69 64  thod->xUnlock(id
0890: 2c 20 6c 6f 63 6b 54 79 70 65 29 3b 0a 7d 0a 69  , lockType);.}.i
08a0: 6e 74 20 73 71 6c 69 74 65 33 4f 73 4c 6f 63 6b  nt sqlite3OsLock
08b0: 53 74 61 74 65 28 4f 73 46 69 6c 65 20 2a 69 64  State(OsFile *id
08c0: 29 7b 0a 20 20 72 65 74 75 72 6e 20 69 64 2d 3e  ){.  return id->
08d0: 70 4d 65 74 68 6f 64 2d 3e 78 4c 6f 63 6b 53 74  pMethod->xLockSt
08e0: 61 74 65 28 69 64 29 3b 0a 7d 0a 69 6e 74 20 73  ate(id);.}.int s
08f0: 71 6c 69 74 65 33 4f 73 43 68 65 63 6b 52 65 73  qlite3OsCheckRes
0900: 65 72 76 65 64 4c 6f 63 6b 28 4f 73 46 69 6c 65  ervedLock(OsFile
0910: 20 2a 69 64 29 7b 0a 20 20 72 65 74 75 72 6e 20   *id){.  return 
0920: 69 64 2d 3e 70 4d 65 74 68 6f 64 2d 3e 78 43 68  id->pMethod->xCh
0930: 65 63 6b 52 65 73 65 72 76 65 64 4c 6f 63 6b 28  eckReservedLock(
0940: 69 64 29 3b 0a 7d 0a 69 6e 74 20 73 71 6c 69 74  id);.}.int sqlit
0950: 65 33 4f 73 53 65 63 74 6f 72 53 69 7a 65 28 4f  e3OsSectorSize(O
0960: 73 46 69 6c 65 20 2a 69 64 29 7b 0a 20 20 69 6e  sFile *id){.  in
0970: 74 20 28 2a 78 53 65 63 74 6f 72 53 69 7a 65 29  t (*xSectorSize)
0980: 28 4f 73 46 69 6c 65 2a 29 20 3d 20 69 64 2d 3e  (OsFile*) = id->
0990: 70 4d 65 74 68 6f 64 2d 3e 78 53 65 63 74 6f 72  pMethod->xSector
09a0: 53 69 7a 65 3b 0a 20 20 72 65 74 75 72 6e 20 78  Size;.  return x
09b0: 53 65 63 74 6f 72 53 69 7a 65 20 3f 20 78 53 65  SectorSize ? xSe
09c0: 63 74 6f 72 53 69 7a 65 28 69 64 29 20 3a 20 53  ctorSize(id) : S
09d0: 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 53 45  QLITE_DEFAULT_SE
09e0: 43 54 4f 52 5f 53 49 5a 45 3b 0a 7d 0a 0a 23 69  CTOR_SIZE;.}..#i
09f0: 66 64 65 66 20 53 51 4c 49 54 45 5f 45 4e 41 42  fdef SQLITE_ENAB
0a00: 4c 45 5f 52 45 44 45 46 5f 49 4f 0a 2f 2a 0a 2a  LE_REDEF_IO./*.*
0a10: 2a 20 41 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20  * A function to 
0a20: 72 65 74 75 72 6e 20 61 20 70 6f 69 6e 74 65 72  return a pointer
0a30: 20 74 6f 20 74 68 65 20 76 69 72 74 75 61 6c 20   to the virtual 
0a40: 66 75 6e 63 74 69 6f 6e 20 74 61 62 6c 65 2e 0a  function table..
0a50: 2a 2a 20 54 68 69 73 20 72 6f 75 74 69 6e 65 20  ** This routine 
0a60: 72 65 61 6c 6c 79 20 64 6f 65 73 20 6e 6f 74 20  really does not 
0a70: 61 63 63 6f 6d 70 6c 69 73 68 20 76 65 72 79 20  accomplish very 
0a80: 6d 75 63 68 20 73 69 6e 63 65 20 74 68 65 0a 2a  much since the.*
0a90: 2a 20 76 69 72 74 75 61 6c 20 66 75 6e 63 74 69  * virtual functi
0aa0: 6f 6e 20 74 61 62 6c 65 20 69 73 20 61 20 67 6c  on table is a gl
0ab0: 6f 62 61 6c 20 76 61 72 69 61 62 6c 65 20 61 6e  obal variable an
0ac0: 64 20 61 6e 79 62 6f 64 79 20 77 68 6f 0a 2a 2a  d anybody who.**
0ad0: 20 63 61 6e 20 63 61 6c 6c 20 74 68 69 73 20 66   can call this f
0ae0: 75 6e 63 74 69 6f 6e 20 63 61 6e 20 6a 75 73 74  unction can just
0af0: 20 61 73 20 65 61 73 69 6c 79 20 61 63 63 65 73   as easily acces
0b00: 73 20 74 68 65 20 76 61 72 69 61 62 6c 65 0a 2a  s the variable.*
0b10: 2a 20 66 6f 72 20 74 68 65 6d 73 65 6c 76 65 73  * for themselves
0b20: 2e 20 20 4e 65 76 65 72 74 68 65 6c 65 73 73 2c  .  Nevertheless,
0b30: 20 77 65 20 69 6e 63 6c 75 64 65 20 74 68 69 73   we include this
0b40: 20 72 6f 75 74 69 6e 65 20 66 6f 72 0a 2a 2a 20   routine for.** 
0b50: 62 61 63 6b 77 61 72 64 73 20 63 6f 6d 70 61 74  backwards compat
0b60: 69 62 69 6c 69 74 79 20 77 69 74 68 20 61 6e 20  ibility with an 
0b70: 65 61 72 6c 69 65 72 20 72 65 64 65 66 69 6e 61  earlier redefina
0b80: 62 6c 65 20 49 2f 4f 0a 2a 2a 20 69 6e 74 65 72  ble I/O.** inter
0b90: 66 61 63 65 20 64 65 73 69 67 6e 2e 0a 2a 2f 0a  face design..*/.
0ba0: 73 74 72 75 63 74 20 73 71 6c 69 74 65 33 4f 73  struct sqlite3Os
0bb0: 56 74 62 6c 20 2a 73 71 6c 69 74 65 33 5f 6f 73  Vtbl *sqlite3_os
0bc0: 5f 73 77 69 74 63 68 28 76 6f 69 64 29 7b 0a 20  _switch(void){. 
0bd0: 20 72 65 74 75 72 6e 20 26 73 71 6c 69 74 65 33   return &sqlite3
0be0: 4f 73 3b 0a 7d 0a 23 65 6e 64 69 66 0a           Os;.}.#endif.