652ca136eaece13ab89776455638ea824f0ca917
[asterisk/asterisk.git] / include / asterisk / lock.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2010, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Asterisk locking-related definitions:
21  * - ast_mutex_t, ast_rwlock_t and related functions;
22  * - atomic arithmetic instructions;
23  * - wrappers for channel locking.
24  *
25  * - See \ref LockDef
26  */
27
28 /*! \page LockDef Asterisk thread locking models
29  *
30  * This file provides different implementation of the functions,
31  * depending on the platform, the use of DEBUG_THREADS, and the way
32  * module-level mutexes are initialized.
33  *
34  *  - \b static: the mutex is assigned the value AST_MUTEX_INIT_VALUE
35  *        this is done at compile time, and is the way used on Linux.
36  *        This method is not applicable to all platforms e.g. when the
37  *        initialization needs that some code is run.
38  *
39  *  - \b through constructors: for each mutex, a constructor function is
40  *        defined, which then runs when the program (or the module)
41  *        starts. The problem with this approach is that there is a
42  *        lot of code duplication (a new block of code is created for
43  *        each mutex). Also, it does not prevent a user from declaring
44  *        a global mutex without going through the wrapper macros,
45  *        so sane programming practices are still required.
46  */
47
48 #ifndef _ASTERISK_LOCK_H
49 #define _ASTERISK_LOCK_H
50
51 #include <pthread.h>
52 #include <time.h>
53 #include <sys/param.h>
54 #ifdef HAVE_BKTR
55 #include <execinfo.h>
56 #endif
57
58 #ifndef HAVE_PTHREAD_RWLOCK_TIMEDWRLOCK
59 #include "asterisk/time.h"
60 #endif
61
62 #include "asterisk/backtrace.h"
63 #include "asterisk/logger.h"
64 #include "asterisk/compiler.h"
65
66 #define AST_PTHREADT_NULL (pthread_t) -1
67 #define AST_PTHREADT_STOP (pthread_t) -2
68
69 #if (defined(SOLARIS) || defined(BSD))
70 #define AST_MUTEX_INIT_W_CONSTRUCTORS
71 #endif /* SOLARIS || BSD */
72
73 /* Asterisk REQUIRES recursive (not error checking) mutexes
74    and will not run without them. */
75 #if defined(HAVE_PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP) && defined(HAVE_PTHREAD_MUTEX_RECURSIVE_NP)
76 #define PTHREAD_MUTEX_INIT_VALUE        PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
77 #define AST_MUTEX_KIND                  PTHREAD_MUTEX_RECURSIVE_NP
78 #else
79 #define PTHREAD_MUTEX_INIT_VALUE        PTHREAD_MUTEX_INITIALIZER
80 #define AST_MUTEX_KIND                  PTHREAD_MUTEX_RECURSIVE
81 #endif /* PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP */
82
83 #ifdef HAVE_PTHREAD_RWLOCK_INITIALIZER
84 #define __AST_RWLOCK_INIT_VALUE         PTHREAD_RWLOCK_INITIALIZER
85 #else  /* HAVE_PTHREAD_RWLOCK_INITIALIZER */
86 #define __AST_RWLOCK_INIT_VALUE         {0}
87 #endif /* HAVE_PTHREAD_RWLOCK_INITIALIZER */
88
89 #ifdef HAVE_BKTR
90 #define AST_LOCK_TRACK_INIT_VALUE { { NULL }, { 0 }, 0, { NULL }, { 0 }, {{{ 0 }}}, PTHREAD_MUTEX_INIT_VALUE }
91 #else
92 #define AST_LOCK_TRACK_INIT_VALUE { { NULL }, { 0 }, 0, { NULL }, { 0 }, PTHREAD_MUTEX_INIT_VALUE }
93 #endif
94
95 #define AST_MUTEX_INIT_VALUE { PTHREAD_MUTEX_INIT_VALUE, NULL, 1 }
96 #define AST_MUTEX_INIT_VALUE_NOTRACKING { PTHREAD_MUTEX_INIT_VALUE, NULL, 0 }
97
98 #define AST_RWLOCK_INIT_VALUE { __AST_RWLOCK_INIT_VALUE, NULL, 1 }
99 #define AST_RWLOCK_INIT_VALUE_NOTRACKING { __AST_RWLOCK_INIT_VALUE, NULL, 0 }
100
101 #define AST_MAX_REENTRANCY 10
102
103 struct ast_channel;
104
105 /*!
106  * \brief Lock tracking information.
107  *
108  * \note Any changes to this struct MUST be reflected in the
109  * lock.c:restore_lock_tracking() function.
110  */
111 struct ast_lock_track {
112         const char *file[AST_MAX_REENTRANCY];
113         int lineno[AST_MAX_REENTRANCY];
114         int reentrancy;
115         const char *func[AST_MAX_REENTRANCY];
116         pthread_t thread_id[AST_MAX_REENTRANCY];
117 #ifdef HAVE_BKTR
118         struct ast_bt backtrace[AST_MAX_REENTRANCY];
119 #endif
120         pthread_mutex_t reentr_mutex;
121 };
122
123 /*! \brief Structure for mutex and tracking information.
124  *
125  * We have tracking information in this structure regardless of DEBUG_THREADS being enabled.
126  * The information will just be ignored in the core if a module does not request it..
127  */
128 struct ast_mutex_info {
129         pthread_mutex_t mutex;
130         /*! Track which thread holds this mutex */
131         struct ast_lock_track *track;
132         unsigned int tracking:1;
133 };
134
135 /*! \brief Structure for rwlock and tracking information.
136  *
137  * We have tracking information in this structure regardless of DEBUG_THREADS being enabled.
138  * The information will just be ignored in the core if a module does not request it..
139  */
140 struct ast_rwlock_info {
141         pthread_rwlock_t lock;
142         /*! Track which thread holds this lock */
143         struct ast_lock_track *track;
144         unsigned int tracking:1;
145 };
146
147 typedef struct ast_mutex_info ast_mutex_t;
148
149 typedef struct ast_rwlock_info ast_rwlock_t;
150
151 typedef pthread_cond_t ast_cond_t;
152
153 int __ast_pthread_mutex_init(int tracking, const char *filename, int lineno, const char *func, const char *mutex_name, ast_mutex_t *t);
154 int __ast_pthread_mutex_destroy(const char *filename, int lineno, const char *func, const char *mutex_name, ast_mutex_t *t);
155 int __ast_pthread_mutex_lock(const char *filename, int lineno, const char *func, const char* mutex_name, ast_mutex_t *t);
156 int __ast_pthread_mutex_trylock(const char *filename, int lineno, const char *func, const char* mutex_name, ast_mutex_t *t);
157 int __ast_pthread_mutex_unlock(const char *filename, int lineno, const char *func, const char *mutex_name, ast_mutex_t *t);
158
159 #define ast_mutex_init(pmutex)            __ast_pthread_mutex_init(1, __FILE__, __LINE__, __PRETTY_FUNCTION__, #pmutex, pmutex)
160 #define ast_mutex_init_notracking(pmutex) __ast_pthread_mutex_init(0, __FILE__, __LINE__, __PRETTY_FUNCTION__, #pmutex, pmutex)
161 #define ast_mutex_destroy(a)              __ast_pthread_mutex_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
162 #define ast_mutex_lock(a)                 __ast_pthread_mutex_lock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
163 #define ast_mutex_unlock(a)               __ast_pthread_mutex_unlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
164 #define ast_mutex_trylock(a)              __ast_pthread_mutex_trylock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
165
166
167 int __ast_cond_init(const char *filename, int lineno, const char *func, const char *cond_name, ast_cond_t *cond, pthread_condattr_t *cond_attr);
168 int __ast_cond_signal(const char *filename, int lineno, const char *func, const char *cond_name, ast_cond_t *cond);
169 int __ast_cond_broadcast(const char *filename, int lineno, const char *func, const char *cond_name, ast_cond_t *cond);
170 int __ast_cond_destroy(const char *filename, int lineno, const char *func, const char *cond_name, ast_cond_t *cond);
171 int __ast_cond_wait(const char *filename, int lineno, const char *func, const char *cond_name, const char *mutex_name, ast_cond_t *cond, ast_mutex_t *t);
172 int __ast_cond_timedwait(const char *filename, int lineno, const char *func, const char *cond_name, const char *mutex_name, ast_cond_t *cond, ast_mutex_t *t, const struct timespec *abstime);
173
174 #define ast_cond_init(cond, attr)             __ast_cond_init(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond, attr)
175 #define ast_cond_destroy(cond)                __ast_cond_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
176 #define ast_cond_signal(cond)                 __ast_cond_signal(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
177 #define ast_cond_broadcast(cond)              __ast_cond_broadcast(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
178 #define ast_cond_wait(cond, mutex)            __ast_cond_wait(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #mutex, cond, mutex)
179 #define ast_cond_timedwait(cond, mutex, time) __ast_cond_timedwait(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #mutex, cond, mutex, time)
180
181
182 int __ast_rwlock_init(int tracking, const char *filename, int lineno, const char *func, const char *rwlock_name, ast_rwlock_t *t);
183 int __ast_rwlock_destroy(const char *filename, int lineno, const char *func, const char *rwlock_name, ast_rwlock_t *t);
184 int __ast_rwlock_unlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name);
185 int __ast_rwlock_rdlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name);
186 int __ast_rwlock_wrlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name);
187 int __ast_rwlock_timedrdlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name, const struct timespec *abs_timeout);
188 int __ast_rwlock_timedwrlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name, const struct timespec *abs_timeout);
189 int __ast_rwlock_tryrdlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name);
190 int __ast_rwlock_trywrlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name);
191
192 /*!
193  * \brief wrapper for rwlock with tracking enabled
194  * \return 0 on success, non zero for error
195  * \since 1.6.1
196  */
197 #define ast_rwlock_init(rwlock)            __ast_rwlock_init(1, __FILE__, __LINE__, __PRETTY_FUNCTION__, #rwlock, rwlock)
198
199 /*!
200  * \brief wrapper for ast_rwlock_init with tracking disabled
201  * \return 0 on success, non zero for error
202  * \since 1.6.1
203  */
204 #define ast_rwlock_init_notracking(rwlock) __ast_rwlock_init(0, __FILE__, __LINE__, __PRETTY_FUNCTION__, #rwlock, rwlock)
205
206 #define ast_rwlock_destroy(rwlock)         __ast_rwlock_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #rwlock, rwlock)
207 #define ast_rwlock_unlock(a)               __ast_rwlock_unlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a)
208 #define ast_rwlock_rdlock(a)               __ast_rwlock_rdlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a)
209 #define ast_rwlock_wrlock(a)               __ast_rwlock_wrlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a)
210 #define ast_rwlock_tryrdlock(a)            __ast_rwlock_tryrdlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a)
211 #define ast_rwlock_trywrlock(a)            __ast_rwlock_trywrlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a)
212 #define ast_rwlock_timedrdlock(a, b)       __ast_rwlock_timedrdlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a, b)
213 #define ast_rwlock_timedwrlock(a, b)       __ast_rwlock_timedwrlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a, b)
214
215 #define ROFFSET ((lt->reentrancy > 0) ? (lt->reentrancy-1) : 0)
216
217 #ifdef DEBUG_THREADS
218
219 #define __ast_mutex_logger(...)  do { if (canlog) ast_log(LOG_ERROR, __VA_ARGS__); else fprintf(stderr, __VA_ARGS__); } while (0)
220
221 #ifdef THREAD_CRASH
222 #define DO_THREAD_CRASH do { *((int *)(0)) = 1; } while(0)
223 #else
224 #define DO_THREAD_CRASH do { } while (0)
225 #endif
226
227 #include <errno.h>
228
229 enum ast_lock_type {
230         AST_MUTEX,
231         AST_RDLOCK,
232         AST_WRLOCK,
233 };
234
235 /*!
236  * \brief Store lock info for the current thread
237  *
238  * This function gets called in ast_mutex_lock() and ast_mutex_trylock() so
239  * that information about this lock can be stored in this thread's
240  * lock info struct.  The lock is marked as pending as the thread is waiting
241  * on the lock.  ast_mark_lock_acquired() will mark it as held by this thread.
242  */
243 #if !defined(LOW_MEMORY)
244 #ifdef HAVE_BKTR
245 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
246         int line_num, const char *func, const char *lock_name, void *lock_addr, struct ast_bt *bt);
247 #else
248 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
249         int line_num, const char *func, const char *lock_name, void *lock_addr);
250 #endif /* HAVE_BKTR */
251
252 #else
253
254 #ifdef HAVE_BKTR
255 #define ast_store_lock_info(I,DONT,CARE,ABOUT,THE,PARAMETERS,BUD)
256 #else
257 #define ast_store_lock_info(I,DONT,CARE,ABOUT,THE,PARAMETERS)
258 #endif /* HAVE_BKTR */
259 #endif /* !defined(LOW_MEMORY) */
260
261 /*!
262  * \brief Mark the last lock as acquired
263  */
264 #if !defined(LOW_MEMORY)
265 void ast_mark_lock_acquired(void *lock_addr);
266 #else
267 #define ast_mark_lock_acquired(ignore)
268 #endif
269
270 /*!
271  * \brief Mark the last lock as failed (trylock)
272  */
273 #if !defined(LOW_MEMORY)
274 void ast_mark_lock_failed(void *lock_addr);
275 #else
276 #define ast_mark_lock_failed(ignore)
277 #endif
278
279 /*!
280  * \brief remove lock info for the current thread
281  *
282  * this gets called by ast_mutex_unlock so that information on the lock can
283  * be removed from the current thread's lock info struct.
284  */
285 #if !defined(LOW_MEMORY)
286 #ifdef HAVE_BKTR
287 void ast_remove_lock_info(void *lock_addr, struct ast_bt *bt);
288 #else
289 void ast_remove_lock_info(void *lock_addr);
290 #endif /* HAVE_BKTR */
291 void ast_suspend_lock_info(void *lock_addr);
292 void ast_restore_lock_info(void *lock_addr);
293 #else
294 #ifdef HAVE_BKTR
295 #define ast_remove_lock_info(ignore,me)
296 #else
297 #define ast_remove_lock_info(ignore)
298 #endif /* HAVE_BKTR */
299 #define ast_suspend_lock_info(ignore);
300 #define ast_restore_lock_info(ignore);
301 #endif /* !defined(LOW_MEMORY) */
302
303 /*!
304  * \brief log info for the current lock with ast_log().
305  *
306  * this function would be mostly for debug. If you come across a lock
307  * that is unexpectedly but momentarily locked, and you wonder who
308  * are fighting with for the lock, this routine could be called, IF
309  * you have the thread debugging stuff turned on.
310  * \param this_lock_addr lock address to return lock information
311  * \since 1.6.1
312  */
313 void ast_log_show_lock(void *this_lock_addr);
314
315 /*!
316  * \brief Generate a lock dump equivalent to "core show locks".
317  *
318  * The lock dump generated is generally too large to be output by a
319  * single ast_verbose/log/debug/etc. call. Only ast_cli() handles it
320  * properly without changing BUFSIZ in logger.c.
321  *
322  * Note: This must be ast_free()d when you're done with it.
323  *
324  * \retval An ast_str containing the lock dump
325  * \retval NULL on error
326  * \since 12
327  */
328 struct ast_str *ast_dump_locks(void);
329
330 /*!
331  * \brief retrieve lock info for the specified mutex
332  *
333  * this gets called during deadlock avoidance, so that the information may
334  * be preserved as to what location originally acquired the lock.
335  */
336 #if !defined(LOW_MEMORY)
337 int ast_find_lock_info(void *lock_addr, char *filename, size_t filename_size, int *lineno, char *func, size_t func_size, char *mutex_name, size_t mutex_name_size);
338 #else
339 #define ast_find_lock_info(a,b,c,d,e,f,g,h) -1
340 #endif
341
342 /*!
343  * \brief Unlock a lock briefly
344  *
345  * used during deadlock avoidance, to preserve the original location where
346  * a lock was originally acquired.
347  */
348 #define AO2_DEADLOCK_AVOIDANCE(obj) \
349         do { \
350                 char __filename[80], __func[80], __mutex_name[80]; \
351                 int __lineno; \
352                 int __res = ast_find_lock_info(ao2_object_get_lockaddr(obj), __filename, sizeof(__filename), &__lineno, __func, sizeof(__func), __mutex_name, sizeof(__mutex_name)); \
353                 int __res2 = ao2_unlock(obj); \
354                 usleep(1); \
355                 if (__res < 0) { /* Could happen if the ao2 object does not have a mutex. */ \
356                         if (__res2) { \
357                                 ast_log(LOG_WARNING, "Could not unlock ao2 object '%s': %s and no lock info found!  I will NOT try to relock.\n", #obj, strerror(__res2)); \
358                         } else { \
359                                 ao2_lock(obj); \
360                         } \
361                 } else { \
362                         if (__res2) { \
363                                 ast_log(LOG_WARNING, "Could not unlock ao2 object '%s': %s.  {{{Originally locked at %s line %d: (%s) '%s'}}}  I will NOT try to relock.\n", #obj, strerror(__res2), __filename, __lineno, __func, __mutex_name); \
364                         } else { \
365                                 __ao2_lock(obj, AO2_LOCK_REQ_MUTEX, __filename, __func, __lineno, __mutex_name); \
366                         } \
367                 } \
368         } while (0)
369
370 #define CHANNEL_DEADLOCK_AVOIDANCE(chan) \
371         do { \
372                 char __filename[80], __func[80], __mutex_name[80]; \
373                 int __lineno; \
374                 int __res = ast_find_lock_info(ao2_object_get_lockaddr(chan), __filename, sizeof(__filename), &__lineno, __func, sizeof(__func), __mutex_name, sizeof(__mutex_name)); \
375                 int __res2 = ast_channel_unlock(chan); \
376                 usleep(1); \
377                 if (__res < 0) { /* Shouldn't ever happen, but just in case... */ \
378                         if (__res2) { \
379                                 ast_log(LOG_WARNING, "Could not unlock channel '%s': %s and no lock info found!  I will NOT try to relock.\n", #chan, strerror(__res2)); \
380                         } else { \
381                                 ast_channel_lock(chan); \
382                         } \
383                 } else { \
384                         if (__res2) { \
385                                 ast_log(LOG_WARNING, "Could not unlock channel '%s': %s.  {{{Originally locked at %s line %d: (%s) '%s'}}}  I will NOT try to relock.\n", #chan, strerror(__res2), __filename, __lineno, __func, __mutex_name); \
386                         } else { \
387                                 __ao2_lock(chan, AO2_LOCK_REQ_MUTEX, __filename, __func, __lineno, __mutex_name); \
388                         } \
389                 } \
390         } while (0)
391
392 #define DEADLOCK_AVOIDANCE(lock) \
393         do { \
394                 char __filename[80], __func[80], __mutex_name[80]; \
395                 int __lineno; \
396                 int __res = ast_find_lock_info(lock, __filename, sizeof(__filename), &__lineno, __func, sizeof(__func), __mutex_name, sizeof(__mutex_name)); \
397                 int __res2 = ast_mutex_unlock(lock); \
398                 usleep(1); \
399                 if (__res < 0) { /* Shouldn't ever happen, but just in case... */ \
400                         if (__res2 == 0) { \
401                                 ast_mutex_lock(lock); \
402                         } else { \
403                                 ast_log(LOG_WARNING, "Could not unlock mutex '%s': %s and no lock info found!  I will NOT try to relock.\n", #lock, strerror(__res2)); \
404                         } \
405                 } else { \
406                         if (__res2 == 0) { \
407                                 __ast_pthread_mutex_lock(__filename, __lineno, __func, __mutex_name, lock); \
408                         } else { \
409                                 ast_log(LOG_WARNING, "Could not unlock mutex '%s': %s.  {{{Originally locked at %s line %d: (%s) '%s'}}}  I will NOT try to relock.\n", #lock, strerror(__res2), __filename, __lineno, __func, __mutex_name); \
410                         } \
411                 } \
412         } while (0)
413
414 /*!
415  * \brief Deadlock avoidance unlock
416  *
417  * In certain deadlock avoidance scenarios, there is more than one lock to be
418  * unlocked and relocked.  Therefore, this pair of macros is provided for that
419  * purpose.  Note that every DLA_UNLOCK _MUST_ be paired with a matching
420  * DLA_LOCK.  The intent of this pair of macros is to be used around another
421  * set of deadlock avoidance code, mainly CHANNEL_DEADLOCK_AVOIDANCE, as the
422  * locking order specifies that we may safely lock a channel, followed by its
423  * pvt, with no worries about a deadlock.  In any other scenario, this macro
424  * may not be safe to use.
425  */
426 #define DLA_UNLOCK(lock) \
427         do { \
428                 char __filename[80], __func[80], __mutex_name[80]; \
429                 int __lineno; \
430                 int __res = ast_find_lock_info(lock, __filename, sizeof(__filename), &__lineno, __func, sizeof(__func), __mutex_name, sizeof(__mutex_name)); \
431                 int __res2 = ast_mutex_unlock(lock);
432
433 /*!
434  * \brief Deadlock avoidance lock
435  *
436  * In certain deadlock avoidance scenarios, there is more than one lock to be
437  * unlocked and relocked.  Therefore, this pair of macros is provided for that
438  * purpose.  Note that every DLA_UNLOCK _MUST_ be paired with a matching
439  * DLA_LOCK.  The intent of this pair of macros is to be used around another
440  * set of deadlock avoidance code, mainly CHANNEL_DEADLOCK_AVOIDANCE, as the
441  * locking order specifies that we may safely lock a channel, followed by its
442  * pvt, with no worries about a deadlock.  In any other scenario, this macro
443  * may not be safe to use.
444  */
445 #define DLA_LOCK(lock) \
446                 if (__res < 0) { /* Shouldn't ever happen, but just in case... */ \
447                         if (__res2) { \
448                                 ast_log(LOG_WARNING, "Could not unlock mutex '%s': %s and no lock info found!  I will NOT try to relock.\n", #lock, strerror(__res2)); \
449                         } else { \
450                                 ast_mutex_lock(lock); \
451                         } \
452                 } else { \
453                         if (__res2) { \
454                                 ast_log(LOG_WARNING, "Could not unlock mutex '%s': %s.  {{{Originally locked at %s line %d: (%s) '%s'}}}  I will NOT try to relock.\n", #lock, strerror(__res2), __filename, __lineno, __func, __mutex_name); \
455                         } else { \
456                                 __ast_pthread_mutex_lock(__filename, __lineno, __func, __mutex_name, lock); \
457                         } \
458                 } \
459         } while (0)
460
461 static inline void ast_reentrancy_lock(struct ast_lock_track *lt)
462 {
463         int res;
464         if ((res = pthread_mutex_lock(&lt->reentr_mutex))) {
465                 fprintf(stderr, "ast_reentrancy_lock failed: '%s' (%d)\n", strerror(res), res);
466 #if defined(DO_CRASH) || defined(THREAD_CRASH)
467                 abort();
468 #endif
469         }
470 }
471
472 static inline void ast_reentrancy_unlock(struct ast_lock_track *lt)
473 {
474         int res;
475         if ((res = pthread_mutex_unlock(&lt->reentr_mutex))) {
476                 fprintf(stderr, "ast_reentrancy_unlock failed: '%s' (%d)\n", strerror(res), res);
477 #if defined(DO_CRASH) || defined(THREAD_CRASH)
478                 abort();
479 #endif
480         }
481 }
482
483 #else /* !DEBUG_THREADS */
484
485 #define AO2_DEADLOCK_AVOIDANCE(obj) \
486         ao2_unlock(obj); \
487         usleep(1); \
488         ao2_lock(obj);
489
490 #define CHANNEL_DEADLOCK_AVOIDANCE(chan) \
491         ast_channel_unlock(chan); \
492         usleep(1); \
493         ast_channel_lock(chan);
494
495 #define DEADLOCK_AVOIDANCE(lock) \
496         do { \
497                 int __res; \
498                 if (!(__res = ast_mutex_unlock(lock))) { \
499                         usleep(1); \
500                         ast_mutex_lock(lock); \
501                 } else { \
502                         ast_log(LOG_WARNING, "Failed to unlock mutex '%s' (%s).  I will NOT try to relock. {{{ THIS IS A BUG. }}}\n", #lock, strerror(__res)); \
503                 } \
504         } while (0)
505
506 #define DLA_UNLOCK(lock) ast_mutex_unlock(lock)
507
508 #define DLA_LOCK(lock) ast_mutex_lock(lock)
509
510 #endif /* !DEBUG_THREADS */
511
512 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
513 /*
514  * If AST_MUTEX_INIT_W_CONSTRUCTORS is defined, use file scope constructors
515  * and destructors to create/destroy global mutexes.
516  */
517 #define __AST_MUTEX_DEFINE(scope, mutex, init_val, track)       \
518         scope ast_mutex_t mutex = init_val;                     \
519 static void  __attribute__((constructor)) init_##mutex(void)    \
520 {                                                               \
521         if (track)                                              \
522                 ast_mutex_init(&mutex);                         \
523         else                                                    \
524                 ast_mutex_init_notracking(&mutex);              \
525 }                                                               \
526                                                                 \
527 static void  __attribute__((destructor)) fini_##mutex(void)     \
528 {                                                               \
529         ast_mutex_destroy(&mutex);                              \
530 }
531 #else /* !AST_MUTEX_INIT_W_CONSTRUCTORS */
532 /* By default, use static initialization of mutexes. */
533 #define __AST_MUTEX_DEFINE(scope, mutex, init_val, track) scope ast_mutex_t mutex = init_val
534 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
535
536 #define AST_MUTEX_DEFINE_STATIC(mutex) __AST_MUTEX_DEFINE(static, mutex, AST_MUTEX_INIT_VALUE, 1)
537 #define AST_MUTEX_DEFINE_STATIC_NOTRACKING(mutex) __AST_MUTEX_DEFINE(static, mutex, AST_MUTEX_INIT_VALUE_NOTRACKING, 0)
538
539
540 /* Statically declared read/write locks */
541 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
542 #define __AST_RWLOCK_DEFINE(scope, rwlock, init_val, track) \
543         scope ast_rwlock_t rwlock = init_val; \
544 static void  __attribute__((constructor)) init_##rwlock(void) \
545 { \
546         if (track) \
547                 ast_rwlock_init(&rwlock); \
548         else \
549                 ast_rwlock_init_notracking(&rwlock); \
550 } \
551 static void  __attribute__((destructor)) fini_##rwlock(void) \
552 { \
553         ast_rwlock_destroy(&rwlock); \
554 }
555 #else
556 #define __AST_RWLOCK_DEFINE(scope, rwlock, init_val, track) scope ast_rwlock_t rwlock = init_val
557 #endif
558
559 #define AST_RWLOCK_DEFINE_STATIC(rwlock) __AST_RWLOCK_DEFINE(static, rwlock, AST_RWLOCK_INIT_VALUE, 1)
560 #define AST_RWLOCK_DEFINE_STATIC_NOTRACKING(rwlock) __AST_RWLOCK_DEFINE(static, rwlock, AST_RWLOCK_INIT_VALUE_NOTRACKING, 0)
561
562 /*!
563  * \brief Scoped Locks
564  *
565  * Scoped locks provide a way to use RAII locks. In other words,
566  * declaration of a scoped lock will automatically define and lock
567  * the lock. When the lock goes out of scope, it will automatically
568  * be unlocked.
569  *
570  * \code
571  * int some_function(struct ast_channel *chan)
572  * {
573  *     SCOPED_LOCK(lock, chan, ast_channel_lock, ast_channel_unlock);
574  *
575  *     if (!strcmp(ast_channel_name(chan, "foo")) {
576  *         return 0;
577  *     }
578  *
579  *     return -1;
580  * }
581  * \endcode
582  *
583  * In the above example, neither return path requires explicit unlocking
584  * of the channel.
585  *
586  * \note
587  * Care should be taken when using SCOPED_LOCKS in conjunction with ao2 objects.
588  * ao2 objects should be unlocked before they are unreffed. Since SCOPED_LOCK runs
589  * once the variable goes out of scope, this can easily lead to situations where the
590  * variable gets unlocked after it is unreffed.
591  *
592  * \param varname The unique name to give to the scoped lock. You are not likely to reference
593  * this outside of the SCOPED_LOCK invocation.
594  * \param lock The variable to lock. This can be anything that can be passed to a locking
595  * or unlocking function.
596  * \param lockfunc The function to call to lock the lock
597  * \param unlockfunc The function to call to unlock the lock
598  */
599 #define SCOPED_LOCK(varname, lock, lockfunc, unlockfunc) \
600         RAII_VAR(typeof((lock)), varname, ({lockfunc((lock)); (lock); }), unlockfunc)
601
602 /*!
603  * \brief scoped lock specialization for mutexes
604  */
605 #define SCOPED_MUTEX(varname, lock) SCOPED_LOCK(varname, (lock), ast_mutex_lock, ast_mutex_unlock)
606
607 /*!
608  * \brief scoped lock specialization for read locks
609  */
610 #define SCOPED_RDLOCK(varname, lock) SCOPED_LOCK(varname, (lock), ast_rwlock_rdlock, ast_rwlock_unlock)
611
612 /*!
613  * \brief scoped lock specialization for write locks
614  */
615 #define SCOPED_WRLOCK(varname, lock) SCOPED_LOCK(varname, (lock), ast_rwlock_wrlock, ast_rwlock_unlock)
616
617 /*!
618  * \brief scoped lock specialization for ao2 mutexes.
619  */
620 #define SCOPED_AO2LOCK(varname, obj) SCOPED_LOCK(varname, (obj), ao2_lock, ao2_unlock)
621
622 /*!
623  * \brief scoped lock specialization for ao2 read locks.
624  */
625 #define SCOPED_AO2RDLOCK(varname, obj) SCOPED_LOCK(varname, (obj), ao2_rdlock, ao2_unlock)
626
627 /*!
628  * \brief scoped lock specialization for ao2 write locks.
629  */
630 #define SCOPED_AO2WRLOCK(varname, obj) SCOPED_LOCK(varname, (obj), ao2_wrlock, ao2_unlock)
631
632 /*!
633  * \brief scoped lock specialization for channels.
634  */
635 #define SCOPED_CHANNELLOCK(varname, chan) SCOPED_LOCK(varname, (chan), ast_channel_lock, ast_channel_unlock)
636
637 #ifndef __CYGWIN__      /* temporary disabled for cygwin */
638 #define pthread_mutex_t         use_ast_mutex_t_instead_of_pthread_mutex_t
639 #define pthread_cond_t          use_ast_cond_t_instead_of_pthread_cond_t
640 #endif
641 #define pthread_mutex_lock      use_ast_mutex_lock_instead_of_pthread_mutex_lock
642 #define pthread_mutex_unlock    use_ast_mutex_unlock_instead_of_pthread_mutex_unlock
643 #define pthread_mutex_trylock   use_ast_mutex_trylock_instead_of_pthread_mutex_trylock
644 #define pthread_mutex_init      use_ast_mutex_init_instead_of_pthread_mutex_init
645 #define pthread_mutex_destroy   use_ast_mutex_destroy_instead_of_pthread_mutex_destroy
646 #define pthread_cond_init       use_ast_cond_init_instead_of_pthread_cond_init
647 #define pthread_cond_destroy    use_ast_cond_destroy_instead_of_pthread_cond_destroy
648 #define pthread_cond_signal     use_ast_cond_signal_instead_of_pthread_cond_signal
649 #define pthread_cond_broadcast  use_ast_cond_broadcast_instead_of_pthread_cond_broadcast
650 #define pthread_cond_wait       use_ast_cond_wait_instead_of_pthread_cond_wait
651 #define pthread_cond_timedwait  use_ast_cond_timedwait_instead_of_pthread_cond_timedwait
652
653 #define AST_MUTEX_INITIALIZER __use_AST_MUTEX_DEFINE_STATIC_rather_than_AST_MUTEX_INITIALIZER__
654
655 #define gethostbyname __gethostbyname__is__not__reentrant__use__ast_gethostbyname__instead__
656
657 #ifndef __linux__
658 #define pthread_create __use_ast_pthread_create_instead__
659 #endif
660
661 /*
662  * Support for atomic instructions.
663  * For platforms that have it, use the native cpu instruction to
664  * implement them. For other platforms, resort to a 'slow' version
665  * (defined in utils.c) that protects the atomic instruction with
666  * a single lock.
667  * The slow versions is always available, for testing purposes,
668  * as ast_atomic_fetchadd_int_slow()
669  */
670
671 int ast_atomic_fetchadd_int_slow(volatile int *p, int v);
672
673 #include "asterisk/inline_api.h"
674
675 #if defined(HAVE_OSX_ATOMICS)
676 #include "libkern/OSAtomic.h"
677 #endif
678
679 /*! \brief Atomically add v to *p and return * the previous value of *p.
680  * This can be used to handle reference counts, and the return value
681  * can be used to generate unique identifiers.
682  */
683
684 #if defined(HAVE_GCC_ATOMICS)
685 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
686 {
687         return __sync_fetch_and_add(p, v);
688 })
689 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 4)
690 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
691 {
692         return OSAtomicAdd32(v, (int32_t *) p) - v;
693 })
694 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 8)
695 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
696 {
697         return OSAtomicAdd64(v, (int64_t *) p) - v;
698 })
699 #elif defined (__i386__) || defined(__x86_64__)
700 #ifdef sun
701 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
702 {
703         __asm __volatile (
704         "       lock;  xaddl   %0, %1 ;        "
705         : "+r" (v),                     /* 0 (result) */
706           "=m" (*p)                     /* 1 */
707         : "m" (*p));                    /* 2 */
708         return (v);
709 })
710 #else /* ifndef sun */
711 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
712 {
713         __asm __volatile (
714         "       lock   xaddl   %0, %1 ;        "
715         : "+r" (v),                     /* 0 (result) */
716           "=m" (*p)                     /* 1 */
717         : "m" (*p));                    /* 2 */
718         return (v);
719 })
720 #endif
721 #else   /* low performance version in utils.c */
722 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
723 {
724         return ast_atomic_fetchadd_int_slow(p, v);
725 })
726 #endif
727
728 /*! \brief decrement *p by 1 and return true if the variable has reached 0.
729  * Useful e.g. to check if a refcount has reached 0.
730  */
731 #if defined(HAVE_GCC_ATOMICS)
732 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
733 {
734         return __sync_sub_and_fetch(p, 1) == 0;
735 })
736 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 4)
737 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
738 {
739         return OSAtomicAdd32( -1, (int32_t *) p) == 0;
740 })
741 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 8)
742 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
743 {
744         return OSAtomicAdd64( -1, (int64_t *) p) == 0;
745 })
746 #else
747 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
748 {
749         int a = ast_atomic_fetchadd_int(p, -1);
750         return a == 1; /* true if the value is 0 now (so it was 1 previously) */
751 })
752 #endif
753
754 #endif /* _ASTERISK_LOCK_H */