/ Hex Artifact Content
Login

Artifact 32ddef38560ce0128d7e7b3eb063f5c6eff889a3:


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 39 20 32 30 30 38 2f  ex.h,v 1.9 2008/
0330: 31 30 2f 30 37 20 31 35 3a 32 35 3a 34 38 20 64  10/07 15:25:48 d
0340: 72 68 20 45 78 70 20 24 0a 2a 2f 0a 0a 0a 2f 2a  rh Exp $.*/.../*
0350: 0a 2a 2a 20 46 69 67 75 72 65 20 6f 75 74 20 77  .** Figure out w
0360: 68 61 74 20 76 65 72 73 69 6f 6e 20 6f 66 20 74  hat version of t
0370: 68 65 20 63 6f 64 65 20 74 6f 20 75 73 65 2e 20  he code to use. 
0380: 20 54 68 65 20 63 68 6f 69 63 65 73 20 61 72 65   The choices are
0390: 0a 2a 2a 0a 2a 2a 20 20 20 53 51 4c 49 54 45 5f  .**.**   SQLITE_
03a0: 4d 55 54 45 58 5f 4f 4d 49 54 20 20 20 20 20 20  MUTEX_OMIT      
03b0: 20 20 20 4e 6f 20 6d 75 74 65 78 20 6c 6f 67 69     No mutex logi
03c0: 63 2e 20 20 4e 6f 74 20 65 76 65 6e 20 73 74 75  c.  Not even stu
03d0: 62 73 2e 20 20 54 68 65 0a 2a 2a 20 20 20 20 20  bs.  The.**     
03e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
03f0: 20 20 20 20 20 20 20 20 6d 75 74 65 78 65 73 20          mutexes 
0400: 69 6d 70 6c 65 6d 65 6e 74 69 6f 6e 20 63 61 6e  implemention can
0410: 6e 6f 74 20 62 65 20 6f 76 65 72 72 69 64 64 65  not be overridde
0420: 6e 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 20 20  n.**            
0430: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0440: 20 61 74 20 73 74 61 72 74 2d 74 69 6d 65 2e 0a   at start-time..
0450: 2a 2a 0a 2a 2a 20 20 20 53 51 4c 49 54 45 5f 4d  **.**   SQLITE_M
0460: 55 54 45 58 5f 4e 4f 4f 50 20 20 20 20 20 20 20  UTEX_NOOP       
0470: 20 20 46 6f 72 20 73 69 6e 67 6c 65 2d 74 68 72    For single-thr
0480: 65 61 64 65 64 20 61 70 70 6c 69 63 61 74 69 6f  eaded applicatio
0490: 6e 73 2e 20 20 4e 6f 0a 2a 2a 20 20 20 20 20 20  ns.  No.**      
04a0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
04b0: 20 20 20 20 20 20 20 6d 75 74 75 61 6c 20 65 78         mutual ex
04c0: 63 6c 75 73 69 6f 6e 20 69 73 20 70 72 6f 76 69  clusion is provi
04d0: 64 65 64 2e 20 20 42 75 74 20 74 68 69 73 0a 2a  ded.  But this.*
04e0: 2a 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  *               
04f0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 69 6d                im
0500: 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 63 61 6e  plementation can
0510: 20 62 65 20 6f 76 65 72 72 69 64 64 65 6e 20 61   be overridden a
0520: 74 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 20 20  t.**            
0530: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0540: 20 73 74 61 72 74 2d 74 69 6d 65 2e 0a 2a 2a 0a   start-time..**.
0550: 2a 2a 20 20 20 53 51 4c 49 54 45 5f 4d 55 54 45  **   SQLITE_MUTE
0560: 58 5f 50 54 48 52 45 41 44 53 20 20 20 20 20 46  X_PTHREADS     F
0570: 6f 72 20 6d 75 6c 74 69 2d 74 68 72 65 61 64 65  or multi-threade
0580: 64 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 6f  d applications o
0590: 6e 20 55 6e 69 78 2e 0a 2a 2a 0a 2a 2a 20 20 20  n Unix..**.**   
05a0: 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f 57 33 32  SQLITE_MUTEX_W32
05b0: 20 20 20 20 20 20 20 20 20 20 46 6f 72 20 6d 75            For mu
05c0: 6c 74 69 2d 74 68 72 65 61 64 65 64 20 61 70 70  lti-threaded app
05d0: 6c 69 63 61 74 69 6f 6e 73 20 6f 6e 20 57 69 6e  lications on Win
05e0: 33 32 2e 0a 2a 2a 0a 2a 2a 20 20 20 53 51 4c 49  32..**.**   SQLI
05f0: 54 45 5f 4d 55 54 45 58 5f 4f 53 32 20 20 20 20  TE_MUTEX_OS2    
0600: 20 20 20 20 20 20 46 6f 72 20 6d 75 6c 74 69 2d        For multi-
0610: 74 68 72 65 61 64 65 64 20 61 70 70 6c 69 63 61  threaded applica
0620: 74 69 6f 6e 73 20 6f 6e 20 4f 53 2f 32 2e 0a 2a  tions on OS/2..*
0630: 2f 0a 23 69 66 20 21 53 51 4c 49 54 45 5f 54 48  /.#if !SQLITE_TH
0640: 52 45 41 44 53 41 46 45 0a 23 20 64 65 66 69 6e  READSAFE.# defin
0650: 65 20 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f 4f  e SQLITE_MUTEX_O
0660: 4d 49 54 0a 23 65 6e 64 69 66 0a 23 69 66 20 53  MIT.#endif.#if S
0670: 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45  QLITE_THREADSAFE
0680: 20 26 26 20 21 64 65 66 69 6e 65 64 28 53 51 4c   && !defined(SQL
0690: 49 54 45 5f 4d 55 54 45 58 5f 4e 4f 4f 50 29 0a  ITE_MUTEX_NOOP).
06a0: 23 20 20 69 66 20 53 51 4c 49 54 45 5f 4f 53 5f  #  if SQLITE_OS_
06b0: 55 4e 49 58 0a 23 20 20 20 20 64 65 66 69 6e 65  UNIX.#    define
06c0: 20 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f 50 54   SQLITE_MUTEX_PT
06d0: 48 52 45 41 44 53 0a 23 20 20 65 6c 69 66 20 53  HREADS.#  elif S
06e0: 51 4c 49 54 45 5f 4f 53 5f 57 49 4e 0a 23 20 20  QLITE_OS_WIN.#  
06f0: 20 20 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f    define SQLITE_
0700: 4d 55 54 45 58 5f 57 33 32 0a 23 20 20 65 6c 69  MUTEX_W32.#  eli
0710: 66 20 53 51 4c 49 54 45 5f 4f 53 5f 4f 53 32 0a  f SQLITE_OS_OS2.
0720: 23 20 20 20 20 64 65 66 69 6e 65 20 53 51 4c 49  #    define SQLI
0730: 54 45 5f 4d 55 54 45 58 5f 4f 53 32 0a 23 20 20  TE_MUTEX_OS2.#  
0740: 65 6c 73 65 0a 23 20 20 20 20 64 65 66 69 6e 65  else.#    define
0750: 20 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f 4e 4f   SQLITE_MUTEX_NO
0760: 4f 50 0a 23 20 20 65 6e 64 69 66 0a 23 65 6e 64  OP.#  endif.#end
0770: 69 66 0a 0a 23 69 66 64 65 66 20 53 51 4c 49 54  if..#ifdef SQLIT
0780: 45 5f 4d 55 54 45 58 5f 4f 4d 49 54 0a 2f 2a 0a  E_MUTEX_OMIT./*.
0790: 2a 2a 20 49 66 20 74 68 69 73 20 69 73 20 61 20  ** If this is a 
07a0: 6e 6f 2d 6f 70 20 69 6d 70 6c 65 6d 65 6e 74 61  no-op implementa
07b0: 74 69 6f 6e 2c 20 69 6d 70 6c 65 6d 65 6e 74 20  tion, implement 
07c0: 65 76 65 72 79 74 68 69 6e 67 20 61 73 20 6d 61  everything as ma
07d0: 63 72 6f 73 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65  cros..*/.#define
07e0: 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 5f 61   sqlite3_mutex_a
07f0: 6c 6c 6f 63 28 58 29 20 20 20 20 28 28 73 71 6c  lloc(X)    ((sql
0800: 69 74 65 33 5f 6d 75 74 65 78 2a 29 38 29 0a 23  ite3_mutex*)8).#
0810: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 5f 6d  define sqlite3_m
0820: 75 74 65 78 5f 66 72 65 65 28 58 29 0a 23 64 65  utex_free(X).#de
0830: 66 69 6e 65 20 73 71 6c 69 74 65 33 5f 6d 75 74  fine sqlite3_mut
0840: 65 78 5f 65 6e 74 65 72 28 58 29 0a 23 64 65 66  ex_enter(X).#def
0850: 69 6e 65 20 73 71 6c 69 74 65 33 5f 6d 75 74 65  ine sqlite3_mute
0860: 78 5f 74 72 79 28 58 29 20 20 20 20 20 20 53 51  x_try(X)      SQ
0870: 4c 49 54 45 5f 4f 4b 0a 23 64 65 66 69 6e 65 20  LITE_OK.#define 
0880: 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 5f 6c 65  sqlite3_mutex_le
0890: 61 76 65 28 58 29 0a 23 64 65 66 69 6e 65 20 73  ave(X).#define s
08a0: 71 6c 69 74 65 33 5f 6d 75 74 65 78 5f 68 65 6c  qlite3_mutex_hel
08b0: 64 28 58 29 20 20 20 20 20 31 0a 23 64 65 66 69  d(X)     1.#defi
08c0: 6e 65 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 78  ne sqlite3_mutex
08d0: 5f 6e 6f 74 68 65 6c 64 28 58 29 20 20 31 0a 23  _notheld(X)  1.#
08e0: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 4d 75  define sqlite3Mu
08f0: 74 65 78 41 6c 6c 6f 63 28 58 29 20 20 20 20 20  texAlloc(X)     
0900: 20 28 28 73 71 6c 69 74 65 33 5f 6d 75 74 65 78   ((sqlite3_mutex
0910: 2a 29 38 29 0a 23 64 65 66 69 6e 65 20 73 71 6c  *)8).#define sql
0920: 69 74 65 33 4d 75 74 65 78 49 6e 69 74 28 29 20  ite3MutexInit() 
0930: 20 20 20 20 20 20 20 53 51 4c 49 54 45 5f 4f 4b         SQLITE_OK
0940: 0a 23 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33  .#define sqlite3
0950: 4d 75 74 65 78 45 6e 64 28 29 0a 23 65 6e 64 69  MutexEnd().#endi
0960: 66 20 2f 2a 20 64 65 66 69 6e 65 64 28 53 51 4c  f /* defined(SQL
0970: 49 54 45 5f 4d 55 54 45 58 5f 4f 4d 49 54 29 20  ITE_MUTEX_OMIT) 
0980: 2a 2f 0a                                         */.