/ Hex Artifact Content
Login

Artifact 110a8c4d356e0aa464ca8730375608a9a0b61ae1:


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 5f 54 45 53 54 5f  ..#ifndef _TEST_
02e0: 4d 55 4c 54 49 50 4c 45 58 5f 48 0a 23 64 65 66  MULTIPLEX_H.#def
02f0: 69 6e 65 20 5f 54 45 53 54 5f 4d 55 4c 54 49 50  ine _TEST_MULTIP
0300: 4c 45 58 5f 48 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  LEX_H../*.** CAP
0310: 49 3a 20 46 69 6c 65 2d 63 6f 6e 74 72 6f 6c 20  I: File-control 
0320: 4f 70 65 72 61 74 69 6f 6e 73 20 53 75 70 70 6f  Operations Suppo
0330: 72 74 65 64 20 62 79 20 4d 75 6c 74 69 70 6c 65  rted by Multiple
0340: 78 20 56 46 53 0a 2a 2a 0a 2a 2a 20 56 61 6c 75  x VFS.**.** Valu
0350: 65 73 20 69 6e 74 65 72 70 72 65 74 65 64 20 62  es interpreted b
0360: 79 20 74 68 65 20 78 46 69 6c 65 43 6f 6e 74 72  y the xFileContr
0370: 6f 6c 20 6d 65 74 68 6f 64 20 6f 66 20 61 20 4d  ol method of a M
0380: 75 6c 74 69 70 6c 65 78 20 56 46 53 20 64 62 20  ultiplex VFS db 
0390: 66 69 6c 65 2d 68 61 6e 64 6c 65 2e 0a 2a 2a 0a  file-handle..**.
03a0: 2a 2a 20 4d 55 4c 54 49 50 4c 45 58 5f 43 54 52  ** MULTIPLEX_CTR
03b0: 4c 5f 45 4e 41 42 4c 45 3a 0a 2a 2a 20 20 20 54  L_ENABLE:.**   T
03c0: 68 69 73 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c  his file control
03d0: 20 69 73 20 75 73 65 64 20 74 6f 20 65 6e 61 62   is used to enab
03e0: 6c 65 20 6f 72 20 64 69 73 61 62 6c 65 20 74 68  le or disable th
03f0: 65 20 6d 75 6c 74 69 70 6c 65 78 0a 2a 2a 20 20  e multiplex.**  
0400: 20 73 68 69 6d 2e 0a 2a 2a 0a 2a 2a 20 4d 55 4c   shim..**.** MUL
0410: 54 49 50 4c 45 58 5f 43 54 52 4c 5f 53 45 54 5f  TIPLEX_CTRL_SET_
0420: 43 48 55 4e 4b 5f 53 49 5a 45 3a 0a 2a 2a 20 20  CHUNK_SIZE:.**  
0430: 20 54 68 69 73 20 66 69 6c 65 20 63 6f 6e 74 72   This file contr
0440: 6f 6c 20 69 73 20 75 73 65 64 20 74 6f 20 73 65  ol is used to se
0450: 74 20 74 68 65 20 6d 61 78 69 6d 75 6d 20 61 6c  t the maximum al
0460: 6c 6f 77 65 64 20 63 68 75 6e 6b 20 0a 2a 2a 20  lowed chunk .** 
0470: 20 20 73 69 7a 65 20 66 6f 72 20 61 20 6d 75 6c    size for a mul
0480: 74 69 70 6c 65 78 20 66 69 6c 65 20 73 65 74 2e  tiplex file set.
0490: 20 20 54 68 65 20 63 68 75 6e 6b 20 73 69 7a 65    The chunk size
04a0: 20 73 68 6f 75 6c 64 20 62 65 20 0a 2a 2a 20 20   should be .**  
04b0: 20 61 20 6d 75 6c 74 69 70 6c 65 20 6f 66 20 53   a multiple of S
04c0: 51 4c 49 54 45 5f 4d 41 58 5f 50 41 47 45 5f 53  QLITE_MAX_PAGE_S
04d0: 49 5a 45 2c 20 61 6e 64 20 77 69 6c 6c 20 62 65  IZE, and will be
04e0: 20 72 6f 75 6e 64 65 64 20 75 70 0a 2a 2a 20 20   rounded up.**  
04f0: 20 69 66 20 6e 6f 74 2e 0a 2a 2a 0a 2a 2a 20 4d   if not..**.** M
0500: 55 4c 54 49 50 4c 45 58 5f 43 54 52 4c 5f 53 45  ULTIPLEX_CTRL_SE
0510: 54 5f 4d 41 58 5f 43 48 55 4e 4b 53 3a 0a 2a 2a  T_MAX_CHUNKS:.**
0520: 20 20 20 54 68 69 73 20 66 69 6c 65 20 63 6f 6e     This file con
0530: 74 72 6f 6c 20 69 73 20 75 73 65 64 20 74 6f 20  trol is used to 
0540: 73 65 74 20 74 68 65 20 6d 61 78 69 6d 75 6d 20  set the maximum 
0550: 6e 75 6d 62 65 72 20 6f 66 20 63 68 75 6e 6b 73  number of chunks
0560: 0a 2a 2a 20 20 20 61 6c 6c 6f 77 65 64 20 74 6f  .**   allowed to
0570: 20 62 65 20 75 73 65 64 20 66 6f 72 20 61 20 6d   be used for a m
0580: 75 74 6c 69 70 6c 65 78 20 66 69 6c 65 20 73 65  utliplex file se
0590: 74 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 4d 55  t..*/.#define MU
05a0: 4c 54 49 50 4c 45 58 5f 43 54 52 4c 5f 45 4e 41  LTIPLEX_CTRL_ENA
05b0: 42 4c 45 20 20 20 20 20 20 20 20 20 20 32 31 34  BLE          214
05c0: 30 31 34 0a 23 64 65 66 69 6e 65 20 4d 55 4c 54  014.#define MULT
05d0: 49 50 4c 45 58 5f 43 54 52 4c 5f 53 45 54 5f 43  IPLEX_CTRL_SET_C
05e0: 48 55 4e 4b 5f 53 49 5a 45 20 20 32 31 34 30 31  HUNK_SIZE  21401
05f0: 35 0a 23 64 65 66 69 6e 65 20 4d 55 4c 54 49 50  5.#define MULTIP
0600: 4c 45 58 5f 43 54 52 4c 5f 53 45 54 5f 4d 41 58  LEX_CTRL_SET_MAX
0610: 5f 43 48 55 4e 4b 53 20 20 32 31 34 30 31 36 0a  _CHUNKS  214016.
0620: 0a 23 69 66 64 65 66 20 5f 5f 63 70 6c 75 73 70  .#ifdef __cplusp
0630: 6c 75 73 0a 65 78 74 65 72 6e 20 22 43 22 20 7b  lus.extern "C" {
0640: 0a 23 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 43  .#endif../*.** C
0650: 41 50 49 3a 20 49 6e 69 74 69 61 6c 69 7a 65 20  API: Initialize 
0660: 74 68 65 20 6d 75 6c 74 69 70 6c 65 78 20 56 46  the multiplex VF
0670: 53 20 73 68 69 6d 20 2d 20 73 71 6c 69 74 65 33  S shim - sqlite3
0680: 5f 6d 75 6c 74 69 70 6c 65 78 5f 69 6e 69 74 69  _multiplex_initi
0690: 61 6c 69 7a 65 28 29 0a 2a 2a 0a 2a 2a 20 55 73  alize().**.** Us
06a0: 65 20 74 68 65 20 56 46 53 20 6e 61 6d 65 64 20  e the VFS named 
06b0: 7a 4f 72 69 67 56 66 73 4e 61 6d 65 20 61 73 20  zOrigVfsName as 
06c0: 74 68 65 20 56 46 53 20 74 68 61 74 20 64 6f 65  the VFS that doe
06d0: 73 20 74 68 65 20 61 63 74 75 61 6c 20 77 6f 72  s the actual wor
06e0: 6b 2e 20 20 0a 2a 2a 20 55 73 65 20 74 68 65 20  k.  .** Use the 
06f0: 64 65 66 61 75 6c 74 20 69 66 20 7a 4f 72 69 67  default if zOrig
0700: 56 66 73 4e 61 6d 65 3d 3d 4e 55 4c 4c 2e 20 20  VfsName==NULL.  
0710: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 6d 75 6c 74 69  .**.** The multi
0720: 70 6c 65 78 20 56 46 53 20 73 68 69 6d 20 69 73  plex VFS shim is
0730: 20 6e 61 6d 65 64 20 22 6d 75 6c 74 69 70 6c 65   named "multiple
0740: 78 22 2e 20 20 49 74 20 77 69 6c 6c 20 62 65 63  x".  It will bec
0750: 6f 6d 65 20 74 68 65 20 64 65 66 61 75 6c 74 0a  ome the default.
0760: 2a 2a 20 56 46 53 20 69 66 20 6d 61 6b 65 44 65  ** VFS if makeDe
0770: 66 61 75 6c 74 20 69 73 20 6e 6f 6e 2d 7a 65 72  fault is non-zer
0780: 6f 2e 0a 2a 2a 0a 2a 2a 20 41 6e 20 61 75 74 6f  o..**.** An auto
0790: 2d 65 78 74 65 6e 73 69 6f 6e 20 69 73 20 72 65  -extension is re
07a0: 67 69 73 74 65 72 65 64 20 77 68 69 63 68 20 77  gistered which w
07b0: 69 6c 6c 20 6d 61 6b 65 20 74 68 65 20 66 75 6e  ill make the fun
07c0: 63 74 69 6f 6e 20 0a 2a 2a 20 6d 75 6c 74 69 70  ction .** multip
07d0: 6c 65 78 5f 63 6f 6e 74 72 6f 6c 28 29 20 61 76  lex_control() av
07e0: 61 69 6c 61 62 6c 65 20 74 6f 20 64 61 74 61 62  ailable to datab
07f0: 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 2e  ase connections.
0800: 20 20 54 68 69 73 0a 2a 2a 20 66 75 6e 63 74 69    This.** functi
0810: 6f 6e 20 67 69 76 65 73 20 61 63 63 65 73 73 20  on gives access 
0820: 74 6f 20 74 68 65 20 78 46 69 6c 65 43 6f 6e 74  to the xFileCont
0830: 72 6f 6c 20 69 6e 74 65 72 66 61 63 65 20 6f 66  rol interface of
0840: 20 74 68 65 20 0a 2a 2a 20 6d 75 6c 74 69 70 6c   the .** multipl
0850: 65 78 20 56 46 53 20 73 68 69 6d 2e 0a 2a 2a 0a  ex VFS shim..**.
0860: 2a 2a 20 53 45 4c 45 43 54 20 6d 75 6c 74 69 70  ** SELECT multip
0870: 6c 65 78 5f 63 6f 6e 74 72 6f 6c 28 3c 6f 70 3e  lex_control(<op>
0880: 2c 3c 76 61 6c 3e 29 3b 0a 2a 2a 20 0a 2a 2a 20  ,<val>);.** .** 
0890: 20 20 3c 6f 70 3e 3d 31 20 4d 55 4c 54 49 50 4c    <op>=1 MULTIPL
08a0: 45 58 5f 43 54 52 4c 5f 45 4e 41 42 4c 45 0a 2a  EX_CTRL_ENABLE.*
08b0: 2a 20 20 20 3c 76 61 6c 3e 3d 30 20 64 69 73 61  *   <val>=0 disa
08c0: 62 6c 65 0a 2a 2a 20 20 20 3c 76 61 6c 3e 3d 31  ble.**   <val>=1
08d0: 20 65 6e 61 62 6c 65 0a 2a 2a 20 0a 2a 2a 20 20   enable.** .**  
08e0: 20 3c 6f 70 3e 3d 32 20 4d 55 4c 54 49 50 4c 45   <op>=2 MULTIPLE
08f0: 58 5f 43 54 52 4c 5f 53 45 54 5f 43 48 55 4e 4b  X_CTRL_SET_CHUNK
0900: 5f 53 49 5a 45 0a 2a 2a 20 20 20 3c 76 61 6c 3e  _SIZE.**   <val>
0910: 20 69 6e 74 2c 20 63 68 75 6e 6b 20 73 69 7a 65   int, chunk size
0920: 0a 2a 2a 20 0a 2a 2a 20 20 20 3c 6f 70 3e 3d 33  .** .**   <op>=3
0930: 20 4d 55 4c 54 49 50 4c 45 58 5f 43 54 52 4c 5f   MULTIPLEX_CTRL_
0940: 53 45 54 5f 4d 41 58 5f 43 48 55 4e 4b 53 0a 2a  SET_MAX_CHUNKS.*
0950: 2a 20 20 20 3c 76 61 6c 3e 20 69 6e 74 2c 20 6d  *   <val> int, m
0960: 61 78 20 63 68 75 6e 6b 73 0a 2a 2a 0a 2a 2a 20  ax chunks.**.** 
0970: 54 48 49 53 20 52 4f 55 54 49 4e 45 20 49 53 20  THIS ROUTINE IS 
0980: 4e 4f 54 20 54 48 52 45 41 44 53 41 46 45 2e 20  NOT THREADSAFE. 
0990: 20 43 61 6c 6c 20 74 68 69 73 20 72 6f 75 74 69   Call this routi
09a0: 6e 65 20 65 78 61 63 74 6c 79 20 6f 6e 63 65 0a  ne exactly once.
09b0: 2a 2a 20 64 75 72 69 6e 67 20 73 74 61 72 74 2d  ** during start-
09c0: 75 70 2e 0a 2a 2f 0a 65 78 74 65 72 6e 20 69 6e  up..*/.extern in
09d0: 74 20 73 71 6c 69 74 65 33 5f 6d 75 6c 74 69 70  t sqlite3_multip
09e0: 6c 65 78 5f 69 6e 69 74 69 61 6c 69 7a 65 28 63  lex_initialize(c
09f0: 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4f 72 69 67  onst char *zOrig
0a00: 56 66 73 4e 61 6d 65 2c 20 69 6e 74 20 6d 61 6b  VfsName, int mak
0a10: 65 44 65 66 61 75 6c 74 29 3b 0a 0a 2f 2a 0a 2a  eDefault);../*.*
0a20: 2a 20 43 41 50 49 3a 20 53 68 75 74 64 6f 77 6e  * CAPI: Shutdown
0a30: 20 74 68 65 20 6d 75 6c 74 69 70 6c 65 78 20 73   the multiplex s
0a40: 79 73 74 65 6d 20 2d 20 73 71 6c 69 74 65 33 5f  ystem - sqlite3_
0a50: 6d 75 6c 74 69 70 6c 65 78 5f 73 68 75 74 64 6f  multiplex_shutdo
0a60: 77 6e 28 29 0a 2a 2a 0a 2a 2a 20 41 6c 6c 20 53  wn().**.** All S
0a70: 51 4c 69 74 65 20 64 61 74 61 62 61 73 65 20 63  QLite database c
0a80: 6f 6e 6e 65 63 74 69 6f 6e 73 20 6d 75 73 74 20  onnections must 
0a90: 62 65 20 63 6c 6f 73 65 64 20 62 65 66 6f 72 65  be closed before
0aa0: 20 63 61 6c 6c 69 6e 67 20 74 68 69 73 0a 2a 2a   calling this.**
0ab0: 20 72 6f 75 74 69 6e 65 2e 0a 2a 2a 0a 2a 2a 20   routine..**.** 
0ac0: 54 48 49 53 20 52 4f 55 54 49 4e 45 20 49 53 20  THIS ROUTINE IS 
0ad0: 4e 4f 54 20 54 48 52 45 41 44 53 41 46 45 2e 20  NOT THREADSAFE. 
0ae0: 20 43 61 6c 6c 20 74 68 69 73 20 72 6f 75 74 69   Call this routi
0af0: 6e 65 20 65 78 61 63 74 6c 79 20 6f 6e 63 65 20  ne exactly once 
0b00: 77 68 69 6c 65 0a 2a 2a 20 73 68 75 74 74 69 6e  while.** shuttin
0b10: 67 20 64 6f 77 6e 20 69 6e 20 6f 72 64 65 72 20  g down in order 
0b20: 74 6f 20 66 72 65 65 20 61 6c 6c 20 72 65 6d 61  to free all rema
0b30: 69 6e 69 6e 67 20 6d 75 6c 74 69 70 6c 65 78 20  ining multiplex 
0b40: 67 72 6f 75 70 73 2e 0a 2a 2f 0a 65 78 74 65 72  groups..*/.exter
0b50: 6e 20 69 6e 74 20 73 71 6c 69 74 65 33 5f 6d 75  n int sqlite3_mu
0b60: 6c 74 69 70 6c 65 78 5f 73 68 75 74 64 6f 77 6e  ltiplex_shutdown
0b70: 28 76 6f 69 64 29 3b 0a 0a 23 69 66 64 65 66 20  (void);..#ifdef 
0b80: 5f 5f 63 70 6c 75 73 70 6c 75 73 0a 7d 20 20 2f  __cplusplus.}  /
0b90: 2a 20 45 6e 64 20 6f 66 20 74 68 65 20 27 65 78  * End of the 'ex
0ba0: 74 65 72 6e 20 22 43 22 27 20 62 6c 6f 63 6b 20  tern "C"' block 
0bb0: 2a 2f 0a 23 65 6e 64 69 66 0a 0a 23 65 6e 64 69  */.#endif..#endi
0bc0: 66 20 2f 2a 20 5f 54 45 53 54 5f 4d 55 4c 54 49  f /* _TEST_MULTI
0bd0: 50 4c 45 58 5f 48 20 2a 2f 0a                    PLEX_H */.