/ Hex Artifact Content
Login

Artifact 5436d03f2d0501d04f3ed50a75819e190495b635:


0000: 2f 2a 0a 2a 2a 20 32 30 31 31 20 4d 61 72 63 68  /*.** 2011 March
0010: 20 31 38 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61 75   18.**.** The au
0020: 74 68 6f 72 20 64 69 73 63 6c 61 69 6d 73 20 63  thor disclaims c
0030: 6f 70 79 72 69 67 68 74 20 74 6f 20 74 68 69 73  opyright to this
0040: 20 73 6f 75 72 63 65 20 63 6f 64 65 2e 20 20 49   source code.  I
0050: 6e 20 70 6c 61 63 65 20 6f 66 0a 2a 2a 20 61 20  n place of.** a 
0060: 6c 65 67 61 6c 20 6e 6f 74 69 63 65 2c 20 68 65  legal notice, he
0070: 72 65 20 69 73 20 61 20 62 6c 65 73 73 69 6e 67  re is a blessing
0080: 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d 61 79 20 79  :.**.**    May y
0090: 6f 75 20 64 6f 20 67 6f 6f 64 20 61 6e 64 20 6e  ou do good and n
00a0: 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20 20 20 20 4d  ot evil..**    M
00b0: 61 79 20 79 6f 75 20 66 69 6e 64 20 66 6f 72 67  ay you find forg
00c0: 69 76 65 6e 65 73 73 20 66 6f 72 20 79 6f 75 72  iveness for your
00d0: 73 65 6c 66 20 61 6e 64 20 66 6f 72 67 69 76 65  self and forgive
00e0: 20 6f 74 68 65 72 73 2e 0a 2a 2a 20 20 20 20 4d   others..**    M
00f0: 61 79 20 79 6f 75 20 73 68 61 72 65 20 66 72 65  ay you share fre
0100: 65 6c 79 2c 20 6e 65 76 65 72 20 74 61 6b 69 6e  ely, never takin
0110: 67 20 6d 6f 72 65 20 74 68 61 6e 20 79 6f 75 20  g more than you 
0120: 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a 2a 2a 2a 2a  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 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 66 69  **.**.** This fi
0180: 6c 65 20 63 6f 6e 74 61 69 6e 73 20 61 20 56 46  le contains a VF
0190: 53 20 22 73 68 69 6d 22 20 2d 20 61 20 6c 61 79  S "shim" - a lay
01a0: 65 72 20 74 68 61 74 20 73 69 74 73 20 69 6e 20  er that sits in 
01b0: 62 65 74 77 65 65 6e 20 74 68 65 0a 2a 2a 20 70  between the.** p
01c0: 61 67 65 72 20 61 6e 64 20 74 68 65 20 72 65 61  ager and the rea
01d0: 6c 20 56 46 53 2e 0a 2a 2a 0a 2a 2a 20 54 68 69  l VFS..**.** Thi
01e0: 73 20 70 61 72 74 69 63 75 6c 61 72 20 73 68 69  s particular shi
01f0: 6d 20 65 6e 66 6f 72 63 65 73 20 61 20 6d 75 6c  m enforces a mul
0200: 74 69 70 6c 65 78 20 73 79 73 74 65 6d 20 6f 6e  tiplex system on
0210: 20 44 42 20 66 69 6c 65 73 2e 20 20 0a 2a 2a 20   DB files.  .** 
0220: 54 68 69 73 20 73 68 69 6d 20 73 68 61 72 64 73  This shim shards
0230: 2f 70 61 72 74 69 74 69 6f 6e 73 20 61 20 73 69  /partitions a si
0240: 6e 67 6c 65 20 44 42 20 66 69 6c 65 20 69 6e 74  ngle DB file int
0250: 6f 20 73 6d 61 6c 6c 65 72 20 0a 2a 2a 20 22 63  o smaller .** "c
0260: 68 75 6e 6b 73 22 20 73 75 63 68 20 74 68 61 74  hunks" such that
0270: 20 74 68 65 20 74 6f 74 61 6c 20 44 42 20 66 69   the total DB fi
0280: 6c 65 20 73 69 7a 65 20 6d 61 79 20 65 78 63 65  le size may exce
0290: 65 64 20 74 68 65 20 6d 61 78 69 6d 75 6d 0a 2a  ed the maximum.*
02a0: 2a 20 66 69 6c 65 20 73 69 7a 65 20 6f 66 20 74  * file size of t
02b0: 68 65 20 75 6e 64 65 72 6c 79 69 6e 67 20 66 69  he underlying fi
02c0: 6c 65 20 73 79 73 74 65 6d 2e 0a 2a 2a 0a 2a 2f  le system..**.*/
02d0: 0a 0a 23 69 66 6e 64 65 66 20 53 51 4c 49 54 45  ..#ifndef SQLITE
02e0: 5f 54 45 53 54 5f 4d 55 4c 54 49 50 4c 45 58 5f  _TEST_MULTIPLEX_
02f0: 48 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  H.#define SQLITE
0300: 5f 54 45 53 54 5f 4d 55 4c 54 49 50 4c 45 58 5f  _TEST_MULTIPLEX_
0310: 48 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 3a 20 46  H../*.** CAPI: F
0320: 69 6c 65 2d 63 6f 6e 74 72 6f 6c 20 4f 70 65 72  ile-control Oper
0330: 61 74 69 6f 6e 73 20 53 75 70 70 6f 72 74 65 64  ations Supported
0340: 20 62 79 20 4d 75 6c 74 69 70 6c 65 78 20 56 46   by Multiplex VF
0350: 53 0a 2a 2a 0a 2a 2a 20 56 61 6c 75 65 73 20 69  S.**.** Values i
0360: 6e 74 65 72 70 72 65 74 65 64 20 62 79 20 74 68  nterpreted by th
0370: 65 20 78 46 69 6c 65 43 6f 6e 74 72 6f 6c 20 6d  e xFileControl m
0380: 65 74 68 6f 64 20 6f 66 20 61 20 4d 75 6c 74 69  ethod of a Multi
0390: 70 6c 65 78 20 56 46 53 20 64 62 20 66 69 6c 65  plex VFS db file
03a0: 2d 68 61 6e 64 6c 65 2e 0a 2a 2a 0a 2a 2a 20 4d  -handle..**.** M
03b0: 55 4c 54 49 50 4c 45 58 5f 43 54 52 4c 5f 45 4e  ULTIPLEX_CTRL_EN
03c0: 41 42 4c 45 3a 0a 2a 2a 20 20 20 54 68 69 73 20  ABLE:.**   This 
03d0: 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 69 73 20  file control is 
03e0: 75 73 65 64 20 74 6f 20 65 6e 61 62 6c 65 20 6f  used to enable o
03f0: 72 20 64 69 73 61 62 6c 65 20 74 68 65 20 6d 75  r disable the mu
0400: 6c 74 69 70 6c 65 78 0a 2a 2a 20 20 20 73 68 69  ltiplex.**   shi
0410: 6d 2e 0a 2a 2a 0a 2a 2a 20 4d 55 4c 54 49 50 4c  m..**.** MULTIPL
0420: 45 58 5f 43 54 52 4c 5f 53 45 54 5f 43 48 55 4e  EX_CTRL_SET_CHUN
0430: 4b 5f 53 49 5a 45 3a 0a 2a 2a 20 20 20 54 68 69  K_SIZE:.**   Thi
0440: 73 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 69  s file control i
0450: 73 20 75 73 65 64 20 74 6f 20 73 65 74 20 74 68  s used to set th
0460: 65 20 6d 61 78 69 6d 75 6d 20 61 6c 6c 6f 77 65  e maximum allowe
0470: 64 20 63 68 75 6e 6b 20 0a 2a 2a 20 20 20 73 69  d chunk .**   si
0480: 7a 65 20 66 6f 72 20 61 20 6d 75 6c 74 69 70 6c  ze for a multipl
0490: 65 78 20 66 69 6c 65 20 73 65 74 2e 20 20 54 68  ex file set.  Th
04a0: 65 20 63 68 75 6e 6b 20 73 69 7a 65 20 73 68 6f  e chunk size sho
04b0: 75 6c 64 20 62 65 20 0a 2a 2a 20 20 20 61 20 6d  uld be .**   a m
04c0: 75 6c 74 69 70 6c 65 20 6f 66 20 53 51 4c 49 54  ultiple of SQLIT
04d0: 45 5f 4d 41 58 5f 50 41 47 45 5f 53 49 5a 45 2c  E_MAX_PAGE_SIZE,
04e0: 20 61 6e 64 20 77 69 6c 6c 20 62 65 20 72 6f 75   and will be rou
04f0: 6e 64 65 64 20 75 70 0a 2a 2a 20 20 20 69 66 20  nded up.**   if 
0500: 6e 6f 74 2e 0a 2a 2a 0a 2a 2a 20 4d 55 4c 54 49  not..**.** MULTI
0510: 50 4c 45 58 5f 43 54 52 4c 5f 53 45 54 5f 4d 41  PLEX_CTRL_SET_MA
0520: 58 5f 43 48 55 4e 4b 53 3a 0a 2a 2a 20 20 20 54  X_CHUNKS:.**   T
0530: 68 69 73 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c  his file control
0540: 20 69 73 20 75 73 65 64 20 74 6f 20 73 65 74 20   is used to set 
0550: 74 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75 6d 62  the maximum numb
0560: 65 72 20 6f 66 20 63 68 75 6e 6b 73 0a 2a 2a 20  er of chunks.** 
0570: 20 20 61 6c 6c 6f 77 65 64 20 74 6f 20 62 65 20    allowed to be 
0580: 75 73 65 64 20 66 6f 72 20 61 20 6d 75 74 6c 69  used for a mutli
0590: 70 6c 65 78 20 66 69 6c 65 20 73 65 74 2e 0a 2a  plex file set..*
05a0: 2f 0a 23 64 65 66 69 6e 65 20 4d 55 4c 54 49 50  /.#define MULTIP
05b0: 4c 45 58 5f 43 54 52 4c 5f 45 4e 41 42 4c 45 20  LEX_CTRL_ENABLE 
05c0: 20 20 20 20 20 20 20 20 20 32 31 34 30 31 34 0a           214014.
05d0: 23 64 65 66 69 6e 65 20 4d 55 4c 54 49 50 4c 45  #define MULTIPLE
05e0: 58 5f 43 54 52 4c 5f 53 45 54 5f 43 48 55 4e 4b  X_CTRL_SET_CHUNK
05f0: 5f 53 49 5a 45 20 20 32 31 34 30 31 35 0a 23 64  _SIZE  214015.#d
0600: 65 66 69 6e 65 20 4d 55 4c 54 49 50 4c 45 58 5f  efine MULTIPLEX_
0610: 43 54 52 4c 5f 53 45 54 5f 4d 41 58 5f 43 48 55  CTRL_SET_MAX_CHU
0620: 4e 4b 53 20 20 32 31 34 30 31 36 0a 0a 23 69 66  NKS  214016..#if
0630: 64 65 66 20 5f 5f 63 70 6c 75 73 70 6c 75 73 0a  def __cplusplus.
0640: 65 78 74 65 72 6e 20 22 43 22 20 7b 0a 23 65 6e  extern "C" {.#en
0650: 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 3a  dif../*.** CAPI:
0660: 20 49 6e 69 74 69 61 6c 69 7a 65 20 74 68 65 20   Initialize the 
0670: 6d 75 6c 74 69 70 6c 65 78 20 56 46 53 20 73 68  multiplex VFS sh
0680: 69 6d 20 2d 20 73 71 6c 69 74 65 33 5f 6d 75 6c  im - sqlite3_mul
0690: 74 69 70 6c 65 78 5f 69 6e 69 74 69 61 6c 69 7a  tiplex_initializ
06a0: 65 28 29 0a 2a 2a 0a 2a 2a 20 55 73 65 20 74 68  e().**.** Use th
06b0: 65 20 56 46 53 20 6e 61 6d 65 64 20 7a 4f 72 69  e VFS named zOri
06c0: 67 56 66 73 4e 61 6d 65 20 61 73 20 74 68 65 20  gVfsName as the 
06d0: 56 46 53 20 74 68 61 74 20 64 6f 65 73 20 74 68  VFS that does th
06e0: 65 20 61 63 74 75 61 6c 20 77 6f 72 6b 2e 20 20  e actual work.  
06f0: 0a 2a 2a 20 55 73 65 20 74 68 65 20 64 65 66 61  .** Use the defa
0700: 75 6c 74 20 69 66 20 7a 4f 72 69 67 56 66 73 4e  ult if zOrigVfsN
0710: 61 6d 65 3d 3d 4e 55 4c 4c 2e 20 20 0a 2a 2a 0a  ame==NULL.  .**.
0720: 2a 2a 20 54 68 65 20 6d 75 6c 74 69 70 6c 65 78  ** The multiplex
0730: 20 56 46 53 20 73 68 69 6d 20 69 73 20 6e 61 6d   VFS shim is nam
0740: 65 64 20 22 6d 75 6c 74 69 70 6c 65 78 22 2e 20  ed "multiplex". 
0750: 20 49 74 20 77 69 6c 6c 20 62 65 63 6f 6d 65 20   It will become 
0760: 74 68 65 20 64 65 66 61 75 6c 74 0a 2a 2a 20 56  the default.** V
0770: 46 53 20 69 66 20 6d 61 6b 65 44 65 66 61 75 6c  FS if makeDefaul
0780: 74 20 69 73 20 6e 6f 6e 2d 7a 65 72 6f 2e 0a 2a  t is non-zero..*
0790: 2a 0a 2a 2a 20 41 6e 20 61 75 74 6f 2d 65 78 74  *.** An auto-ext
07a0: 65 6e 73 69 6f 6e 20 69 73 20 72 65 67 69 73 74  ension is regist
07b0: 65 72 65 64 20 77 68 69 63 68 20 77 69 6c 6c 20  ered which will 
07c0: 6d 61 6b 65 20 74 68 65 20 66 75 6e 63 74 69 6f  make the functio
07d0: 6e 20 0a 2a 2a 20 6d 75 6c 74 69 70 6c 65 78 5f  n .** multiplex_
07e0: 63 6f 6e 74 72 6f 6c 28 29 20 61 76 61 69 6c 61  control() availa
07f0: 62 6c 65 20 74 6f 20 64 61 74 61 62 61 73 65 20  ble to database 
0800: 63 6f 6e 6e 65 63 74 69 6f 6e 73 2e 20 20 54 68  connections.  Th
0810: 69 73 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 67  is.** function g
0820: 69 76 65 73 20 61 63 63 65 73 73 20 74 6f 20 74  ives access to t
0830: 68 65 20 78 46 69 6c 65 43 6f 6e 74 72 6f 6c 20  he xFileControl 
0840: 69 6e 74 65 72 66 61 63 65 20 6f 66 20 74 68 65  interface of the
0850: 20 0a 2a 2a 20 6d 75 6c 74 69 70 6c 65 78 20 56   .** multiplex V
0860: 46 53 20 73 68 69 6d 2e 0a 2a 2a 0a 2a 2a 20 53  FS shim..**.** S
0870: 45 4c 45 43 54 20 6d 75 6c 74 69 70 6c 65 78 5f  ELECT multiplex_
0880: 63 6f 6e 74 72 6f 6c 28 3c 6f 70 3e 2c 3c 76 61  control(<op>,<va
0890: 6c 3e 29 3b 0a 2a 2a 20 0a 2a 2a 20 20 20 3c 6f  l>);.** .**   <o
08a0: 70 3e 3d 31 20 4d 55 4c 54 49 50 4c 45 58 5f 43  p>=1 MULTIPLEX_C
08b0: 54 52 4c 5f 45 4e 41 42 4c 45 0a 2a 2a 20 20 20  TRL_ENABLE.**   
08c0: 3c 76 61 6c 3e 3d 30 20 64 69 73 61 62 6c 65 0a  <val>=0 disable.
08d0: 2a 2a 20 20 20 3c 76 61 6c 3e 3d 31 20 65 6e 61  **   <val>=1 ena
08e0: 62 6c 65 0a 2a 2a 20 0a 2a 2a 20 20 20 3c 6f 70  ble.** .**   <op
08f0: 3e 3d 32 20 4d 55 4c 54 49 50 4c 45 58 5f 43 54  >=2 MULTIPLEX_CT
0900: 52 4c 5f 53 45 54 5f 43 48 55 4e 4b 5f 53 49 5a  RL_SET_CHUNK_SIZ
0910: 45 0a 2a 2a 20 20 20 3c 76 61 6c 3e 20 69 6e 74  E.**   <val> int
0920: 2c 20 63 68 75 6e 6b 20 73 69 7a 65 0a 2a 2a 20  , chunk size.** 
0930: 0a 2a 2a 20 20 20 3c 6f 70 3e 3d 33 20 4d 55 4c  .**   <op>=3 MUL
0940: 54 49 50 4c 45 58 5f 43 54 52 4c 5f 53 45 54 5f  TIPLEX_CTRL_SET_
0950: 4d 41 58 5f 43 48 55 4e 4b 53 0a 2a 2a 20 20 20  MAX_CHUNKS.**   
0960: 3c 76 61 6c 3e 20 69 6e 74 2c 20 6d 61 78 20 63  <val> int, max c
0970: 68 75 6e 6b 73 0a 2a 2a 0a 2a 2a 20 54 48 49 53  hunks.**.** THIS
0980: 20 52 4f 55 54 49 4e 45 20 49 53 20 4e 4f 54 20   ROUTINE IS NOT 
0990: 54 48 52 45 41 44 53 41 46 45 2e 20 20 43 61 6c  THREADSAFE.  Cal
09a0: 6c 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 65  l this routine e
09b0: 78 61 63 74 6c 79 20 6f 6e 63 65 0a 2a 2a 20 64  xactly once.** d
09c0: 75 72 69 6e 67 20 73 74 61 72 74 2d 75 70 2e 0a  uring start-up..
09d0: 2a 2f 0a 65 78 74 65 72 6e 20 69 6e 74 20 73 71  */.extern int sq
09e0: 6c 69 74 65 33 5f 6d 75 6c 74 69 70 6c 65 78 5f  lite3_multiplex_
09f0: 69 6e 69 74 69 61 6c 69 7a 65 28 63 6f 6e 73 74  initialize(const
0a00: 20 63 68 61 72 20 2a 7a 4f 72 69 67 56 66 73 4e   char *zOrigVfsN
0a10: 61 6d 65 2c 20 69 6e 74 20 6d 61 6b 65 44 65 66  ame, int makeDef
0a20: 61 75 6c 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  ault);../*.** CA
0a30: 50 49 3a 20 53 68 75 74 64 6f 77 6e 20 74 68 65  PI: Shutdown the
0a40: 20 6d 75 6c 74 69 70 6c 65 78 20 73 79 73 74 65   multiplex syste
0a50: 6d 20 2d 20 73 71 6c 69 74 65 33 5f 6d 75 6c 74  m - sqlite3_mult
0a60: 69 70 6c 65 78 5f 73 68 75 74 64 6f 77 6e 28 29  iplex_shutdown()
0a70: 0a 2a 2a 0a 2a 2a 20 41 6c 6c 20 53 51 4c 69 74  .**.** All SQLit
0a80: 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  e database conne
0a90: 63 74 69 6f 6e 73 20 6d 75 73 74 20 62 65 20 63  ctions must be c
0aa0: 6c 6f 73 65 64 20 62 65 66 6f 72 65 20 63 61 6c  losed before cal
0ab0: 6c 69 6e 67 20 74 68 69 73 0a 2a 2a 20 72 6f 75  ling this.** rou
0ac0: 74 69 6e 65 2e 0a 2a 2a 0a 2a 2a 20 54 48 49 53  tine..**.** THIS
0ad0: 20 52 4f 55 54 49 4e 45 20 49 53 20 4e 4f 54 20   ROUTINE IS NOT 
0ae0: 54 48 52 45 41 44 53 41 46 45 2e 20 20 43 61 6c  THREADSAFE.  Cal
0af0: 6c 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 65  l this routine e
0b00: 78 61 63 74 6c 79 20 6f 6e 63 65 20 77 68 69 6c  xactly once whil
0b10: 65 0a 2a 2a 20 73 68 75 74 74 69 6e 67 20 64 6f  e.** shutting do
0b20: 77 6e 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 66  wn in order to f
0b30: 72 65 65 20 61 6c 6c 20 72 65 6d 61 69 6e 69 6e  ree all remainin
0b40: 67 20 6d 75 6c 74 69 70 6c 65 78 20 67 72 6f 75  g multiplex grou
0b50: 70 73 2e 0a 2a 2f 0a 65 78 74 65 72 6e 20 69 6e  ps..*/.extern in
0b60: 74 20 73 71 6c 69 74 65 33 5f 6d 75 6c 74 69 70  t sqlite3_multip
0b70: 6c 65 78 5f 73 68 75 74 64 6f 77 6e 28 69 6e 74  lex_shutdown(int
0b80: 20 65 46 6f 72 63 65 29 3b 0a 0a 23 69 66 64 65   eForce);..#ifde
0b90: 66 20 5f 5f 63 70 6c 75 73 70 6c 75 73 0a 7d 20  f __cplusplus.} 
0ba0: 20 2f 2a 20 45 6e 64 20 6f 66 20 74 68 65 20 27   /* End of the '
0bb0: 65 78 74 65 72 6e 20 22 43 22 27 20 62 6c 6f 63  extern "C"' bloc
0bc0: 6b 20 2a 2f 0a 23 65 6e 64 69 66 0a 0a 23 65 6e  k */.#endif..#en
0bd0: 64 69 66 20 2f 2a 20 53 51 4c 49 54 45 5f 54 45  dif /* SQLITE_TE
0be0: 53 54 5f 4d 55 4c 54 49 50 4c 45 58 5f 48 20 2a  ST_MULTIPLEX_H *
0bf0: 2f 0a                                            /.