Artifact 779d588e3b7756ec3ecf7d78cde1d84aba414f85:
- File src/mutex.h — part of check-in [e62aab5e92] at 2014-09-06 16:39:46 on branch trunk — Fix typos in comments. No code changes. (user: peter.d.reid size: 2353) [more...]
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 2f 0a 0a 0a 2f 2a 0a 2a 2a 20 46 69 67 ..*/.../*.** Fig 0320: 75 72 65 20 6f 75 74 20 77 68 61 74 20 76 65 72 ure out what ver 0330: 73 69 6f 6e 20 6f 66 20 74 68 65 20 63 6f 64 65 sion of the code 0340: 20 74 6f 20 75 73 65 2e 20 20 54 68 65 20 63 68 to use. The ch 0350: 6f 69 63 65 73 20 61 72 65 0a 2a 2a 0a 2a 2a 20 oices are.**.** 0360: 20 20 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f 4f SQLITE_MUTEX_O 0370: 4d 49 54 20 20 20 20 20 20 20 20 20 4e 6f 20 6d MIT No m 0380: 75 74 65 78 20 6c 6f 67 69 63 2e 20 20 4e 6f 74 utex logic. Not 0390: 20 65 76 65 6e 20 73 74 75 62 73 2e 20 20 54 68 even stubs. Th 03a0: 65 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 20 20 e.** 03b0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 03c0: 20 6d 75 74 65 78 65 73 20 69 6d 70 6c 65 6d 65 mutexes impleme 03d0: 6e 74 61 74 69 6f 6e 20 63 61 6e 6e 6f 74 20 62 ntation cannot b 03e0: 65 20 6f 76 65 72 72 69 64 64 65 6e 0a 2a 2a 20 e overridden.** 03f0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 0400: 20 20 20 20 20 20 20 20 20 20 20 20 61 74 20 73 at s 0410: 74 61 72 74 2d 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a tart-time..**.** 0420: 20 20 20 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f SQLITE_MUTEX_ 0430: 4e 4f 4f 50 20 20 20 20 20 20 20 20 20 46 6f 72 NOOP For 0440: 20 73 69 6e 67 6c 65 2d 74 68 72 65 61 64 65 64 single-threaded 0450: 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 2e 20 20 applications. 0460: 4e 6f 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 20 No.** 0470: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 0480: 20 20 6d 75 74 75 61 6c 20 65 78 63 6c 75 73 69 mutual exclusi 0490: 6f 6e 20 69 73 20 70 72 6f 76 69 64 65 64 2e 20 on is provided. 04a0: 20 42 75 74 20 74 68 69 73 0a 2a 2a 20 20 20 20 But this.** 04b0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 04c0: 20 20 20 20 20 20 20 20 20 69 6d 70 6c 65 6d 65 impleme 04d0: 6e 74 61 74 69 6f 6e 20 63 61 6e 20 62 65 20 6f ntation can be o 04e0: 76 65 72 72 69 64 64 65 6e 20 61 74 0a 2a 2a 20 verridden at.** 04f0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 0500: 20 20 20 20 20 20 20 20 20 20 20 20 73 74 61 72 star 0510: 74 2d 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a 20 20 20 t-time..**.** 0520: 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f 50 54 48 SQLITE_MUTEX_PTH 0530: 52 45 41 44 53 20 20 20 20 20 46 6f 72 20 6d 75 READS For mu 0540: 6c 74 69 2d 74 68 72 65 61 64 65 64 20 61 70 70 lti-threaded app 0550: 6c 69 63 61 74 69 6f 6e 73 20 6f 6e 20 55 6e 69 lications on Uni 0560: 78 2e 0a 2a 2a 0a 2a 2a 20 20 20 53 51 4c 49 54 x..**.** SQLIT 0570: 45 5f 4d 55 54 45 58 5f 57 33 32 20 20 20 20 20 E_MUTEX_W32 0580: 20 20 20 20 20 46 6f 72 20 6d 75 6c 74 69 2d 74 For multi-t 0590: 68 72 65 61 64 65 64 20 61 70 70 6c 69 63 61 74 hreaded applicat 05a0: 69 6f 6e 73 20 6f 6e 20 57 69 6e 33 32 2e 0a 2a ions on Win32..* 05b0: 2f 0a 23 69 66 20 21 53 51 4c 49 54 45 5f 54 48 /.#if !SQLITE_TH 05c0: 52 45 41 44 53 41 46 45 0a 23 20 64 65 66 69 6e READSAFE.# defin 05d0: 65 20 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f 4f e SQLITE_MUTEX_O 05e0: 4d 49 54 0a 23 65 6e 64 69 66 0a 23 69 66 20 53 MIT.#endif.#if S 05f0: 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 QLITE_THREADSAFE 0600: 20 26 26 20 21 64 65 66 69 6e 65 64 28 53 51 4c && !defined(SQL 0610: 49 54 45 5f 4d 55 54 45 58 5f 4e 4f 4f 50 29 0a ITE_MUTEX_NOOP). 0620: 23 20 20 69 66 20 53 51 4c 49 54 45 5f 4f 53 5f # if SQLITE_OS_ 0630: 55 4e 49 58 0a 23 20 20 20 20 64 65 66 69 6e 65 UNIX.# define 0640: 20 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f 50 54 SQLITE_MUTEX_PT 0650: 48 52 45 41 44 53 0a 23 20 20 65 6c 69 66 20 53 HREADS.# elif S 0660: 51 4c 49 54 45 5f 4f 53 5f 57 49 4e 0a 23 20 20 QLITE_OS_WIN.# 0670: 20 20 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f define SQLITE_ 0680: 4d 55 54 45 58 5f 57 33 32 0a 23 20 20 65 6c 73 MUTEX_W32.# els 0690: 65 0a 23 20 20 20 20 64 65 66 69 6e 65 20 53 51 e.# define SQ 06a0: 4c 49 54 45 5f 4d 55 54 45 58 5f 4e 4f 4f 50 0a LITE_MUTEX_NOOP. 06b0: 23 20 20 65 6e 64 69 66 0a 23 65 6e 64 69 66 0a # endif.#endif. 06c0: 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 4d .#ifdef SQLITE_M 06d0: 55 54 45 58 5f 4f 4d 49 54 0a 2f 2a 0a 2a 2a 20 UTEX_OMIT./*.** 06e0: 49 66 20 74 68 69 73 20 69 73 20 61 20 6e 6f 2d If this is a no- 06f0: 6f 70 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f op implementatio 0700: 6e 2c 20 69 6d 70 6c 65 6d 65 6e 74 20 65 76 65 n, implement eve 0710: 72 79 74 68 69 6e 67 20 61 73 20 6d 61 63 72 6f rything as macro 0720: 73 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 73 71 s..*/.#define sq 0730: 6c 69 74 65 33 5f 6d 75 74 65 78 5f 61 6c 6c 6f lite3_mutex_allo 0740: 63 28 58 29 20 20 20 20 28 28 73 71 6c 69 74 65 c(X) ((sqlite 0750: 33 5f 6d 75 74 65 78 2a 29 38 29 0a 23 64 65 66 3_mutex*)8).#def 0760: 69 6e 65 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 ine sqlite3_mute 0770: 78 5f 66 72 65 65 28 58 29 0a 23 64 65 66 69 6e x_free(X).#defin 0780: 65 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 5f e sqlite3_mutex_ 0790: 65 6e 74 65 72 28 58 29 20 20 20 20 0a 23 64 65 enter(X) .#de 07a0: 66 69 6e 65 20 73 71 6c 69 74 65 33 5f 6d 75 74 fine sqlite3_mut 07b0: 65 78 5f 74 72 79 28 58 29 20 20 20 20 20 20 53 ex_try(X) S 07c0: 51 4c 49 54 45 5f 4f 4b 0a 23 64 65 66 69 6e 65 QLITE_OK.#define 07d0: 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 5f 6c sqlite3_mutex_l 07e0: 65 61 76 65 28 58 29 20 20 20 20 0a 23 64 65 66 eave(X) .#def 07f0: 69 6e 65 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 ine sqlite3_mute 0800: 78 5f 68 65 6c 64 28 58 29 20 20 20 20 20 28 28 x_held(X) (( 0810: 76 6f 69 64 29 28 58 29 2c 31 29 0a 23 64 65 66 void)(X),1).#def 0820: 69 6e 65 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 ine sqlite3_mute 0830: 78 5f 6e 6f 74 68 65 6c 64 28 58 29 20 20 28 28 x_notheld(X) (( 0840: 76 6f 69 64 29 28 58 29 2c 31 29 0a 23 64 65 66 void)(X),1).#def 0850: 69 6e 65 20 73 71 6c 69 74 65 33 4d 75 74 65 78 ine sqlite3Mutex 0860: 41 6c 6c 6f 63 28 58 29 20 20 20 20 20 20 28 28 Alloc(X) (( 0870: 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 2a 29 38 sqlite3_mutex*)8 0880: 29 0a 23 64 65 66 69 6e 65 20 73 71 6c 69 74 65 ).#define sqlite 0890: 33 4d 75 74 65 78 49 6e 69 74 28 29 20 20 20 20 3MutexInit() 08a0: 20 20 20 20 53 51 4c 49 54 45 5f 4f 4b 0a 23 64 SQLITE_OK.#d 08b0: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 4d 75 74 efine sqlite3Mut 08c0: 65 78 45 6e 64 28 29 0a 23 64 65 66 69 6e 65 20 exEnd().#define 08d0: 4d 55 54 45 58 5f 4c 4f 47 49 43 28 58 29 0a 23 MUTEX_LOGIC(X).# 08e0: 65 6c 73 65 0a 23 64 65 66 69 6e 65 20 4d 55 54 else.#define MUT 08f0: 45 58 5f 4c 4f 47 49 43 28 58 29 20 20 20 20 20 EX_LOGIC(X) 0900: 20 20 20 20 20 20 20 58 0a 23 65 6e 64 69 66 20 X.#endif 0910: 2f 2a 20 64 65 66 69 6e 65 64 28 53 51 4c 49 54 /* defined(SQLIT 0920: 45 5f 4d 55 54 45 58 5f 4f 4d 49 54 29 20 2a 2f E_MUTEX_OMIT) */ 0930: 0a .