/ Hex Artifact Content
Login

Artifact e52ffa1dfc6a6077e8b1823d2c2b7dfcbcf85594:


0000: 2f 2a 0a 2a 2a 20 32 30 30 37 20 41 75 67 75 73  /*.** 2007 Augus
0010: 74 20 32 38 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61  t 28.**.** The a
0020: 75 74 68 6f 72 20 64 69 73 63 6c 61 69 6d 73 20  uthor disclaims 
0030: 63 6f 70 79 72 69 67 68 74 20 74 6f 20 74 68 69  copyright to thi
0040: 73 20 73 6f 75 72 63 65 20 63 6f 64 65 2e 20 20  s source code.  
0050: 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a 2a 20 61  In place of.** a
0060: 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65 2c 20 68   legal notice, h
0070: 65 72 65 20 69 73 20 61 20 62 6c 65 73 73 69 6e  ere is a blessin
0080: 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d 61 79 20  g:.**.**    May 
0090: 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61 6e 64 20  you do good and 
00a0: 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20 20 20 20  not evil..**    
00b0: 4d 61 79 20 79 6f 75 20 66 69 6e 64 20 66 6f 72  May you find for
00c0: 67 69 76 65 6e 65 73 73 20 66 6f 72 20 79 6f 75  giveness for you
00d0: 72 73 65 6c 66 20 61 6e 64 20 66 6f 72 67 69 76  rself and forgiv
00e0: 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20 20 20 20  e others..**    
00f0: 4d 61 79 20 79 6f 75 20 73 68 61 72 65 20 66 72  May you share fr
0100: 65 65 6c 79 2c 20 6e 65 76 65 72 20 74 61 6b 69  eely, never taki
0110: 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20 79 6f 75  ng more than you
0120: 20 67 69 76 65 2e 0a 2a 2a 0a 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 2a 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 66  ***.**.** This f
0180: 69 6c 65 20 63 6f 6e 74 61 69 6e 73 20 74 68 65  ile contains the
0190: 20 63 6f 6d 6d 6f 6e 20 68 65 61 64 65 72 20 66   common header f
01a0: 6f 72 20 61 6c 6c 20 6d 75 74 65 78 20 69 6d 70  or all mutex imp
01b0: 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 2e 0a 2a 2a  lementations..**
01c0: 20 54 68 65 20 73 71 6c 69 74 65 49 6e 74 2e 68   The sqliteInt.h
01d0: 20 68 65 61 64 65 72 20 23 69 6e 63 6c 75 64 65   header #include
01e0: 73 20 74 68 69 73 20 66 69 6c 65 20 73 6f 20 74  s this file so t
01f0: 68 61 74 20 69 74 20 69 73 20 61 76 61 69 6c 61  hat it is availa
0200: 62 6c 65 0a 2a 2a 20 74 6f 20 61 6c 6c 20 73 6f  ble.** to all so
0210: 75 72 63 65 20 66 69 6c 65 73 2e 20 20 57 65 20  urce files.  We 
0220: 62 72 65 61 6b 20 69 74 20 6f 75 74 20 69 6e 20  break it out in 
0230: 61 6e 20 65 66 66 6f 72 74 20 74 6f 20 6b 65 65  an effort to kee
0240: 70 20 74 68 65 20 63 6f 64 65 0a 2a 2a 20 62 65  p the code.** be
0250: 74 74 65 72 20 6f 72 67 61 6e 69 7a 65 64 2e 0a  tter organized..
0260: 2a 2a 0a 2a 2a 20 4e 4f 54 45 3a 20 20 73 6f 75  **.** NOTE:  sou
0270: 72 63 65 20 66 69 6c 65 73 20 73 68 6f 75 6c 64  rce files should
0280: 20 2a 6e 6f 74 2a 20 23 69 6e 63 6c 75 64 65 20   *not* #include 
0290: 74 68 69 73 20 68 65 61 64 65 72 20 66 69 6c 65  this header file
02a0: 20 64 69 72 65 63 74 6c 79 2e 0a 2a 2a 20 53 6f   directly..** So
02b0: 75 72 63 65 20 66 69 6c 65 73 20 73 68 6f 75 6c  urce files shoul
02c0: 64 20 23 69 6e 63 6c 75 64 65 20 74 68 65 20 73  d #include the s
02d0: 71 6c 69 74 65 49 6e 74 2e 68 20 66 69 6c 65 20  qliteInt.h file 
02e0: 61 6e 64 20 6c 65 74 20 74 68 61 74 20 66 69 6c  and let that fil
02f0: 65 0a 2a 2a 20 69 6e 63 6c 75 64 65 20 74 68 69  e.** include thi
0300: 73 20 6f 6e 65 20 69 6e 64 69 72 65 63 74 6c 79  s one indirectly
0310: 2e 0a 2a 2a 0a 2a 2a 20 24 49 64 3a 20 6d 75 74  ..**.** $Id: mut
0320: 65 78 2e 68 2c 76 20 31 2e 38 20 32 30 30 38 2f  ex.h,v 1.8 2008/
0330: 30 36 2f 32 36 20 31 30 3a 34 31 3a 31 39 20 64  06/26 10:41:19 d
0340: 61 6e 69 65 6c 6b 31 39 37 37 20 45 78 70 20 24  anielk1977 Exp $
0350: 0a 2a 2f 0a 0a 0a 23 69 66 64 65 66 20 53 51 4c  .*/...#ifdef SQL
0360: 49 54 45 5f 4d 55 54 45 58 5f 41 50 50 44 45 46  ITE_MUTEX_APPDEF
0370: 0a 2f 2a 0a 2a 2a 20 49 66 20 53 51 4c 49 54 45  ./*.** If SQLITE
0380: 5f 4d 55 54 45 58 5f 41 50 50 44 45 46 20 69 73  _MUTEX_APPDEF is
0390: 20 64 65 66 69 6e 65 64 2c 20 74 68 65 6e 20 74   defined, then t
03a0: 68 69 73 20 77 68 6f 6c 65 20 6d 6f 64 75 6c 65  his whole module
03b0: 20 69 73 0a 2a 2a 20 6f 6d 69 74 74 65 64 20 61   is.** omitted a
03c0: 6e 64 20 65 71 75 69 76 61 6c 65 6e 74 20 66 75  nd equivalent fu
03d0: 6e 63 74 69 6f 6e 61 6c 69 74 79 20 6d 75 73 74  nctionality must
03e0: 20 62 65 20 70 72 6f 76 69 64 65 64 20 62 79 20   be provided by 
03f0: 74 68 65 0a 2a 2a 20 61 70 70 6c 69 63 61 74 69  the.** applicati
0400: 6f 6e 20 74 68 61 74 20 6c 69 6e 6b 73 20 61 67  on that links ag
0410: 61 69 6e 73 74 20 74 68 65 20 53 51 4c 69 74 65  ainst the SQLite
0420: 20 6c 69 62 72 61 72 79 2e 0a 2a 2f 0a 23 65 6c   library..*/.#el
0430: 73 65 0a 2f 2a 0a 2a 2a 20 46 69 67 75 72 65 20  se./*.** Figure 
0440: 6f 75 74 20 77 68 61 74 20 76 65 72 73 69 6f 6e  out what version
0450: 20 6f 66 20 74 68 65 20 63 6f 64 65 20 74 6f 20   of the code to 
0460: 75 73 65 2e 20 20 54 68 65 20 63 68 6f 69 63 65  use.  The choice
0470: 73 20 61 72 65 0a 2a 2a 0a 2a 2a 20 20 20 53 51  s are.**.**   SQ
0480: 4c 49 54 45 5f 4d 55 54 45 58 5f 4e 4f 4f 50 20  LITE_MUTEX_NOOP 
0490: 20 20 20 20 20 20 20 20 46 6f 72 20 73 69 6e 67          For sing
04a0: 6c 65 2d 74 68 72 65 61 64 65 64 20 61 70 70 6c  le-threaded appl
04b0: 69 63 61 74 69 6f 6e 73 20 74 68 61 74 0a 2a 2a  ications that.**
04c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
04d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 64 6f 20               do 
04e0: 6e 6f 74 20 64 65 73 69 72 65 20 65 72 72 6f 72  not desire error
04f0: 20 63 68 65 63 6b 69 6e 67 2e 0a 2a 2a 0a 2a 2a   checking..**.**
0500: 20 20 20 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f     SQLITE_MUTEX_
0510: 4e 4f 4f 50 5f 44 45 42 55 47 20 20 20 46 6f 72  NOOP_DEBUG   For
0520: 20 73 69 6e 67 6c 65 2d 74 68 72 65 61 64 65 64   single-threaded
0530: 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 77 69   applications wi
0540: 74 68 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 20  th.**           
0550: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0560: 20 20 65 72 72 6f 72 20 63 68 65 63 6b 69 6e 67    error checking
0570: 20 74 6f 20 68 65 6c 70 20 76 65 72 69 66 79 20   to help verify 
0580: 74 68 61 74 20 6d 75 74 65 78 65 73 0a 2a 2a 20  that mutexes.** 
0590: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
05a0: 20 20 20 20 20 20 20 20 20 20 20 20 61 72 65 20              are 
05b0: 62 65 69 6e 67 20 75 73 65 64 20 63 6f 72 72 65  being used corre
05c0: 63 74 6c 79 20 65 76 65 6e 20 74 68 6f 75 67 68  ctly even though
05d0: 20 74 68 65 79 0a 2a 2a 20 20 20 20 20 20 20 20   they.**        
05e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
05f0: 20 20 20 20 20 61 72 65 20 6e 6f 74 20 6e 65 65       are not nee
0600: 64 65 64 2e 20 20 55 73 65 64 20 77 68 65 6e 20  ded.  Used when 
0610: 53 51 4c 49 54 45 5f 44 45 42 55 47 20 69 73 0a  SQLITE_DEBUG is.
0620: 2a 2a 20 20 20 20 20 20 20 20 20 20 20 20 20 20  **              
0630: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 64                 d
0640: 65 66 69 6e 65 64 20 6f 6e 20 73 69 6e 67 6c 65  efined on single
0650: 2d 74 68 72 65 61 64 65 64 20 62 75 69 6c 64 73  -threaded builds
0660: 2e 0a 2a 2a 0a 2a 2a 20 20 20 53 51 4c 49 54 45  ..**.**   SQLITE
0670: 5f 4d 55 54 45 58 5f 50 54 48 52 45 41 44 53 20  _MUTEX_PTHREADS 
0680: 20 20 20 20 46 6f 72 20 6d 75 6c 74 69 2d 74 68      For multi-th
0690: 72 65 61 64 65 64 20 61 70 70 6c 69 63 61 74 69  readed applicati
06a0: 6f 6e 73 20 6f 6e 20 55 6e 69 78 2e 0a 2a 2a 0a  ons on Unix..**.
06b0: 2a 2a 20 20 20 53 51 4c 49 54 45 5f 4d 55 54 45  **   SQLITE_MUTE
06c0: 58 5f 57 33 32 20 20 20 20 20 20 20 20 20 20 46  X_W32          F
06d0: 6f 72 20 6d 75 6c 74 69 2d 74 68 72 65 61 64 65  or multi-threade
06e0: 64 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 6f  d applications o
06f0: 6e 20 57 69 6e 33 32 2e 0a 2a 2a 0a 2a 2a 20 20  n Win32..**.**  
0700: 20 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f 4f 53   SQLITE_MUTEX_OS
0710: 32 20 20 20 20 20 20 20 20 20 20 46 6f 72 20 6d  2          For m
0720: 75 6c 74 69 2d 74 68 72 65 61 64 65 64 20 61 70  ulti-threaded ap
0730: 70 6c 69 63 61 74 69 6f 6e 73 20 6f 6e 20 4f 53  plications on OS
0740: 2f 32 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53  /2..*/.#define S
0750: 51 4c 49 54 45 5f 4d 55 54 45 58 5f 4e 4f 4f 50  QLITE_MUTEX_NOOP
0760: 20 31 20 20 20 2f 2a 20 54 68 65 20 64 65 66 61   1   /* The defa
0770: 75 6c 74 20 2a 2f 0a 23 69 66 20 64 65 66 69 6e  ult */.#if defin
0780: 65 64 28 53 51 4c 49 54 45 5f 44 45 42 55 47 29  ed(SQLITE_DEBUG)
0790: 20 26 26 20 21 53 51 4c 49 54 45 5f 54 48 52 45   && !SQLITE_THRE
07a0: 41 44 53 41 46 45 0a 23 20 75 6e 64 65 66 20 53  ADSAFE.# undef S
07b0: 51 4c 49 54 45 5f 4d 55 54 45 58 5f 4e 4f 4f 50  QLITE_MUTEX_NOOP
07c0: 0a 23 20 64 65 66 69 6e 65 20 53 51 4c 49 54 45  .# define SQLITE
07d0: 5f 4d 55 54 45 58 5f 4e 4f 4f 50 5f 44 45 42 55  _MUTEX_NOOP_DEBU
07e0: 47 0a 23 65 6e 64 69 66 0a 23 69 66 20 64 65 66  G.#endif.#if def
07f0: 69 6e 65 64 28 53 51 4c 49 54 45 5f 4d 55 54 45  ined(SQLITE_MUTE
0800: 58 5f 4e 4f 4f 50 29 20 26 26 20 53 51 4c 49 54  X_NOOP) && SQLIT
0810: 45 5f 54 48 52 45 41 44 53 41 46 45 20 26 26 20  E_THREADSAFE && 
0820: 53 51 4c 49 54 45 5f 4f 53 5f 55 4e 49 58 0a 23  SQLITE_OS_UNIX.#
0830: 20 75 6e 64 65 66 20 53 51 4c 49 54 45 5f 4d 55   undef SQLITE_MU
0840: 54 45 58 5f 4e 4f 4f 50 0a 23 20 64 65 66 69 6e  TEX_NOOP.# defin
0850: 65 20 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f 50  e SQLITE_MUTEX_P
0860: 54 48 52 45 41 44 53 0a 23 65 6e 64 69 66 0a 23  THREADS.#endif.#
0870: 69 66 20 64 65 66 69 6e 65 64 28 53 51 4c 49 54  if defined(SQLIT
0880: 45 5f 4d 55 54 45 58 5f 4e 4f 4f 50 29 20 26 26  E_MUTEX_NOOP) &&
0890: 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41   SQLITE_THREADSA
08a0: 46 45 20 26 26 20 53 51 4c 49 54 45 5f 4f 53 5f  FE && SQLITE_OS_
08b0: 57 49 4e 0a 23 20 75 6e 64 65 66 20 53 51 4c 49  WIN.# undef SQLI
08c0: 54 45 5f 4d 55 54 45 58 5f 4e 4f 4f 50 0a 23 20  TE_MUTEX_NOOP.# 
08d0: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4d 55  define SQLITE_MU
08e0: 54 45 58 5f 57 33 32 0a 23 65 6e 64 69 66 0a 23  TEX_W32.#endif.#
08f0: 69 66 20 64 65 66 69 6e 65 64 28 53 51 4c 49 54  if defined(SQLIT
0900: 45 5f 4d 55 54 45 58 5f 4e 4f 4f 50 29 20 26 26  E_MUTEX_NOOP) &&
0910: 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41   SQLITE_THREADSA
0920: 46 45 20 26 26 20 53 51 4c 49 54 45 5f 4f 53 5f  FE && SQLITE_OS_
0930: 4f 53 32 0a 23 20 75 6e 64 65 66 20 53 51 4c 49  OS2.# undef SQLI
0940: 54 45 5f 4d 55 54 45 58 5f 4e 4f 4f 50 0a 23 20  TE_MUTEX_NOOP.# 
0950: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4d 55  define SQLITE_MU
0960: 54 45 58 5f 4f 53 32 0a 23 65 6e 64 69 66 0a 0a  TEX_OS2.#endif..
0970: 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 4d 55  #ifdef SQLITE_MU
0980: 54 45 58 5f 4e 4f 4f 50 0a 2f 2a 0a 2a 2a 20 49  TEX_NOOP./*.** I
0990: 66 20 74 68 69 73 20 69 73 20 61 20 6e 6f 2d 6f  f this is a no-o
09a0: 70 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  p implementation
09b0: 2c 20 69 6d 70 6c 65 6d 65 6e 74 20 65 76 65 72  , implement ever
09c0: 79 74 68 69 6e 67 20 61 73 20 6d 61 63 72 6f 73  ything as macros
09d0: 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 73 71 6c  ..*/.#define sql
09e0: 69 74 65 33 5f 6d 75 74 65 78 5f 61 6c 6c 6f 63  ite3_mutex_alloc
09f0: 28 58 29 20 20 20 20 28 28 73 71 6c 69 74 65 33  (X)    ((sqlite3
0a00: 5f 6d 75 74 65 78 2a 29 38 29 0a 23 64 65 66 69  _mutex*)8).#defi
0a10: 6e 65 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 78  ne sqlite3_mutex
0a20: 5f 66 72 65 65 28 58 29 0a 23 64 65 66 69 6e 65  _free(X).#define
0a30: 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 5f 65   sqlite3_mutex_e
0a40: 6e 74 65 72 28 58 29 0a 23 64 65 66 69 6e 65 20  nter(X).#define 
0a50: 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 5f 74 72  sqlite3_mutex_tr
0a60: 79 28 58 29 20 20 20 20 20 20 53 51 4c 49 54 45  y(X)      SQLITE
0a70: 5f 4f 4b 0a 23 64 65 66 69 6e 65 20 73 71 6c 69  _OK.#define sqli
0a80: 74 65 33 5f 6d 75 74 65 78 5f 6c 65 61 76 65 28  te3_mutex_leave(
0a90: 58 29 0a 23 64 65 66 69 6e 65 20 73 71 6c 69 74  X).#define sqlit
0aa0: 65 33 5f 6d 75 74 65 78 5f 68 65 6c 64 28 58 29  e3_mutex_held(X)
0ab0: 20 20 20 20 20 31 0a 23 64 65 66 69 6e 65 20 73       1.#define s
0ac0: 71 6c 69 74 65 33 5f 6d 75 74 65 78 5f 6e 6f 74  qlite3_mutex_not
0ad0: 68 65 6c 64 28 58 29 20 20 31 0a 23 64 65 66 69  held(X)  1.#defi
0ae0: 6e 65 20 73 71 6c 69 74 65 33 4d 75 74 65 78 41  ne sqlite3MutexA
0af0: 6c 6c 6f 63 28 58 29 20 20 20 20 20 20 28 28 73  lloc(X)      ((s
0b00: 71 6c 69 74 65 33 5f 6d 75 74 65 78 2a 29 38 29  qlite3_mutex*)8)
0b10: 0a 23 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33  .#define sqlite3
0b20: 4d 75 74 65 78 49 6e 69 74 28 29 20 20 20 20 20  MutexInit()     
0b30: 20 20 20 53 51 4c 49 54 45 5f 4f 4b 0a 23 64 65     SQLITE_OK.#de
0b40: 66 69 6e 65 20 73 71 6c 69 74 65 33 4d 75 74 65  fine sqlite3Mute
0b50: 78 45 6e 64 28 29 0a 23 65 6e 64 69 66 0a 0a 23  xEnd().#endif..#
0b60: 65 6e 64 69 66 20 2f 2a 20 53 51 4c 49 54 45 5f  endif /* SQLITE_
0b70: 4d 55 54 45 58 5f 41 50 50 44 45 46 20 2a 2f 0a  MUTEX_APPDEF */.