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