core: Remove ABI effects of LOW_MEMORY.
[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 #ifdef HAVE_BKTR
244 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
245         int line_num, const char *func, const char *lock_name, void *lock_addr, struct ast_bt *bt);
246 #else
247 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
248         int line_num, const char *func, const char *lock_name, void *lock_addr);
249 #endif /* HAVE_BKTR */
250
251 /*!
252  * \brief Mark the last lock as acquired
253  */
254 void ast_mark_lock_acquired(void *lock_addr);
255
256 /*!
257  * \brief Mark the last lock as failed (trylock)
258  */
259 void ast_mark_lock_failed(void *lock_addr);
260
261 /*!
262  * \brief remove lock info for the current thread
263  *
264  * this gets called by ast_mutex_unlock so that information on the lock can
265  * be removed from the current thread's lock info struct.
266  */
267 #ifdef HAVE_BKTR
268 void ast_remove_lock_info(void *lock_addr, struct ast_bt *bt);
269 #else
270 void ast_remove_lock_info(void *lock_addr);
271 #endif /* HAVE_BKTR */
272 void ast_suspend_lock_info(void *lock_addr);
273 void ast_restore_lock_info(void *lock_addr);
274
275 /*!
276  * \brief log info for the current lock with ast_log().
277  *
278  * this function would be mostly for debug. If you come across a lock
279  * that is unexpectedly but momentarily locked, and you wonder who
280  * are fighting with for the lock, this routine could be called, IF
281  * you have the thread debugging stuff turned on.
282  * \param this_lock_addr lock address to return lock information
283  * \since 1.6.1
284  */
285 void ast_log_show_lock(void *this_lock_addr);
286
287 /*!
288  * \brief Generate a lock dump equivalent to "core show locks".
289  *
290  * The lock dump generated is generally too large to be output by a
291  * single ast_verbose/log/debug/etc. call. Only ast_cli() handles it
292  * properly without changing BUFSIZ in logger.c.
293  *
294  * Note: This must be ast_free()d when you're done with it.
295  *
296  * \retval An ast_str containing the lock dump
297  * \retval NULL on error
298  * \since 12
299  */
300 struct ast_str *ast_dump_locks(void);
301
302 /*!
303  * \brief retrieve lock info for the specified mutex
304  *
305  * this gets called during deadlock avoidance, so that the information may
306  * be preserved as to what location originally acquired the lock.
307  */
308 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);
309
310 /*!
311  * \brief Unlock a lock briefly
312  *
313  * used during deadlock avoidance, to preserve the original location where
314  * a lock was originally acquired.
315  */
316 #define AO2_DEADLOCK_AVOIDANCE(obj) \
317         do { \
318                 char __filename[80], __func[80], __mutex_name[80]; \
319                 int __lineno; \
320                 int __res = ast_find_lock_info(ao2_object_get_lockaddr(obj), __filename, sizeof(__filename), &__lineno, __func, sizeof(__func), __mutex_name, sizeof(__mutex_name)); \
321                 int __res2 = ao2_unlock(obj); \
322                 usleep(1); \
323                 if (__res < 0) { /* Could happen if the ao2 object does not have a mutex. */ \
324                         if (__res2) { \
325                                 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)); \
326                         } else { \
327                                 ao2_lock(obj); \
328                         } \
329                 } else { \
330                         if (__res2) { \
331                                 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); \
332                         } else { \
333                                 __ao2_lock(obj, AO2_LOCK_REQ_MUTEX, __filename, __func, __lineno, __mutex_name); \
334                         } \
335                 } \
336         } while (0)
337
338 #define CHANNEL_DEADLOCK_AVOIDANCE(chan) \
339         do { \
340                 char __filename[80], __func[80], __mutex_name[80]; \
341                 int __lineno; \
342                 int __res = ast_find_lock_info(ao2_object_get_lockaddr(chan), __filename, sizeof(__filename), &__lineno, __func, sizeof(__func), __mutex_name, sizeof(__mutex_name)); \
343                 int __res2 = ast_channel_unlock(chan); \
344                 usleep(1); \
345                 if (__res < 0) { /* Shouldn't ever happen, but just in case... */ \
346                         if (__res2) { \
347                                 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)); \
348                         } else { \
349                                 ast_channel_lock(chan); \
350                         } \
351                 } else { \
352                         if (__res2) { \
353                                 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); \
354                         } else { \
355                                 __ao2_lock(chan, AO2_LOCK_REQ_MUTEX, __filename, __func, __lineno, __mutex_name); \
356                         } \
357                 } \
358         } while (0)
359
360 #define DEADLOCK_AVOIDANCE(lock) \
361         do { \
362                 char __filename[80], __func[80], __mutex_name[80]; \
363                 int __lineno; \
364                 int __res = ast_find_lock_info(lock, __filename, sizeof(__filename), &__lineno, __func, sizeof(__func), __mutex_name, sizeof(__mutex_name)); \
365                 int __res2 = ast_mutex_unlock(lock); \
366                 usleep(1); \
367                 if (__res < 0) { /* Shouldn't ever happen, but just in case... */ \
368                         if (__res2 == 0) { \
369                                 ast_mutex_lock(lock); \
370                         } else { \
371                                 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)); \
372                         } \
373                 } else { \
374                         if (__res2 == 0) { \
375                                 __ast_pthread_mutex_lock(__filename, __lineno, __func, __mutex_name, lock); \
376                         } else { \
377                                 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); \
378                         } \
379                 } \
380         } while (0)
381
382 /*!
383  * \brief Deadlock avoidance unlock
384  *
385  * In certain deadlock avoidance scenarios, there is more than one lock to be
386  * unlocked and relocked.  Therefore, this pair of macros is provided for that
387  * purpose.  Note that every DLA_UNLOCK _MUST_ be paired with a matching
388  * DLA_LOCK.  The intent of this pair of macros is to be used around another
389  * set of deadlock avoidance code, mainly CHANNEL_DEADLOCK_AVOIDANCE, as the
390  * locking order specifies that we may safely lock a channel, followed by its
391  * pvt, with no worries about a deadlock.  In any other scenario, this macro
392  * may not be safe to use.
393  */
394 #define DLA_UNLOCK(lock) \
395         do { \
396                 char __filename[80], __func[80], __mutex_name[80]; \
397                 int __lineno; \
398                 int __res = ast_find_lock_info(lock, __filename, sizeof(__filename), &__lineno, __func, sizeof(__func), __mutex_name, sizeof(__mutex_name)); \
399                 int __res2 = ast_mutex_unlock(lock);
400
401 /*!
402  * \brief Deadlock avoidance lock
403  *
404  * In certain deadlock avoidance scenarios, there is more than one lock to be
405  * unlocked and relocked.  Therefore, this pair of macros is provided for that
406  * purpose.  Note that every DLA_UNLOCK _MUST_ be paired with a matching
407  * DLA_LOCK.  The intent of this pair of macros is to be used around another
408  * set of deadlock avoidance code, mainly CHANNEL_DEADLOCK_AVOIDANCE, as the
409  * locking order specifies that we may safely lock a channel, followed by its
410  * pvt, with no worries about a deadlock.  In any other scenario, this macro
411  * may not be safe to use.
412  */
413 #define DLA_LOCK(lock) \
414                 if (__res < 0) { /* Shouldn't ever happen, but just in case... */ \
415                         if (__res2) { \
416                                 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)); \
417                         } else { \
418                                 ast_mutex_lock(lock); \
419                         } \
420                 } else { \
421                         if (__res2) { \
422                                 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); \
423                         } else { \
424                                 __ast_pthread_mutex_lock(__filename, __lineno, __func, __mutex_name, lock); \
425                         } \
426                 } \
427         } while (0)
428
429 static inline void ast_reentrancy_lock(struct ast_lock_track *lt)
430 {
431         int res;
432         if ((res = pthread_mutex_lock(&lt->reentr_mutex))) {
433                 fprintf(stderr, "ast_reentrancy_lock failed: '%s' (%d)\n", strerror(res), res);
434 #if defined(DO_CRASH) || defined(THREAD_CRASH)
435                 abort();
436 #endif
437         }
438 }
439
440 static inline void ast_reentrancy_unlock(struct ast_lock_track *lt)
441 {
442         int res;
443         if ((res = pthread_mutex_unlock(&lt->reentr_mutex))) {
444                 fprintf(stderr, "ast_reentrancy_unlock failed: '%s' (%d)\n", strerror(res), res);
445 #if defined(DO_CRASH) || defined(THREAD_CRASH)
446                 abort();
447 #endif
448         }
449 }
450
451 #else /* !DEBUG_THREADS */
452
453 #define AO2_DEADLOCK_AVOIDANCE(obj) \
454         ao2_unlock(obj); \
455         usleep(1); \
456         ao2_lock(obj);
457
458 #define CHANNEL_DEADLOCK_AVOIDANCE(chan) \
459         ast_channel_unlock(chan); \
460         usleep(1); \
461         ast_channel_lock(chan);
462
463 #define DEADLOCK_AVOIDANCE(lock) \
464         do { \
465                 int __res; \
466                 if (!(__res = ast_mutex_unlock(lock))) { \
467                         usleep(1); \
468                         ast_mutex_lock(lock); \
469                 } else { \
470                         ast_log(LOG_WARNING, "Failed to unlock mutex '%s' (%s).  I will NOT try to relock. {{{ THIS IS A BUG. }}}\n", #lock, strerror(__res)); \
471                 } \
472         } while (0)
473
474 #define DLA_UNLOCK(lock) ast_mutex_unlock(lock)
475
476 #define DLA_LOCK(lock) ast_mutex_lock(lock)
477
478 #endif /* !DEBUG_THREADS */
479
480 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
481 /*
482  * If AST_MUTEX_INIT_W_CONSTRUCTORS is defined, use file scope constructors
483  * and destructors to create/destroy global mutexes.
484  */
485 #define __AST_MUTEX_DEFINE(scope, mutex, init_val, track)       \
486         scope ast_mutex_t mutex = init_val;                     \
487 static void  __attribute__((constructor)) init_##mutex(void)    \
488 {                                                               \
489         if (track)                                              \
490                 ast_mutex_init(&mutex);                         \
491         else                                                    \
492                 ast_mutex_init_notracking(&mutex);              \
493 }                                                               \
494                                                                 \
495 static void  __attribute__((destructor)) fini_##mutex(void)     \
496 {                                                               \
497         ast_mutex_destroy(&mutex);                              \
498 }
499 #else /* !AST_MUTEX_INIT_W_CONSTRUCTORS */
500 /* By default, use static initialization of mutexes. */
501 #define __AST_MUTEX_DEFINE(scope, mutex, init_val, track) scope ast_mutex_t mutex = init_val
502 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
503
504 #define AST_MUTEX_DEFINE_STATIC(mutex) __AST_MUTEX_DEFINE(static, mutex, AST_MUTEX_INIT_VALUE, 1)
505 #define AST_MUTEX_DEFINE_STATIC_NOTRACKING(mutex) __AST_MUTEX_DEFINE(static, mutex, AST_MUTEX_INIT_VALUE_NOTRACKING, 0)
506
507
508 /* Statically declared read/write locks */
509 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
510 #define __AST_RWLOCK_DEFINE(scope, rwlock, init_val, track) \
511         scope ast_rwlock_t rwlock = init_val; \
512 static void  __attribute__((constructor)) init_##rwlock(void) \
513 { \
514         if (track) \
515                 ast_rwlock_init(&rwlock); \
516         else \
517                 ast_rwlock_init_notracking(&rwlock); \
518 } \
519 static void  __attribute__((destructor)) fini_##rwlock(void) \
520 { \
521         ast_rwlock_destroy(&rwlock); \
522 }
523 #else
524 #define __AST_RWLOCK_DEFINE(scope, rwlock, init_val, track) scope ast_rwlock_t rwlock = init_val
525 #endif
526
527 #define AST_RWLOCK_DEFINE_STATIC(rwlock) __AST_RWLOCK_DEFINE(static, rwlock, AST_RWLOCK_INIT_VALUE, 1)
528 #define AST_RWLOCK_DEFINE_STATIC_NOTRACKING(rwlock) __AST_RWLOCK_DEFINE(static, rwlock, AST_RWLOCK_INIT_VALUE_NOTRACKING, 0)
529
530 /*!
531  * \brief Scoped Locks
532  *
533  * Scoped locks provide a way to use RAII locks. In other words,
534  * declaration of a scoped lock will automatically define and lock
535  * the lock. When the lock goes out of scope, it will automatically
536  * be unlocked.
537  *
538  * \code
539  * int some_function(struct ast_channel *chan)
540  * {
541  *     SCOPED_LOCK(lock, chan, ast_channel_lock, ast_channel_unlock);
542  *
543  *     if (!strcmp(ast_channel_name(chan, "foo")) {
544  *         return 0;
545  *     }
546  *
547  *     return -1;
548  * }
549  * \endcode
550  *
551  * In the above example, neither return path requires explicit unlocking
552  * of the channel.
553  *
554  * \note
555  * Care should be taken when using SCOPED_LOCKS in conjunction with ao2 objects.
556  * ao2 objects should be unlocked before they are unreffed. Since SCOPED_LOCK runs
557  * once the variable goes out of scope, this can easily lead to situations where the
558  * variable gets unlocked after it is unreffed.
559  *
560  * \param varname The unique name to give to the scoped lock. You are not likely to reference
561  * this outside of the SCOPED_LOCK invocation.
562  * \param lock The variable to lock. This can be anything that can be passed to a locking
563  * or unlocking function.
564  * \param lockfunc The function to call to lock the lock
565  * \param unlockfunc The function to call to unlock the lock
566  */
567 #define SCOPED_LOCK(varname, lock, lockfunc, unlockfunc) \
568         RAII_VAR(typeof((lock)), varname, ({lockfunc((lock)); (lock); }), unlockfunc)
569
570 /*!
571  * \brief scoped lock specialization for mutexes
572  */
573 #define SCOPED_MUTEX(varname, lock) SCOPED_LOCK(varname, (lock), ast_mutex_lock, ast_mutex_unlock)
574
575 /*!
576  * \brief scoped lock specialization for read locks
577  */
578 #define SCOPED_RDLOCK(varname, lock) SCOPED_LOCK(varname, (lock), ast_rwlock_rdlock, ast_rwlock_unlock)
579
580 /*!
581  * \brief scoped lock specialization for write locks
582  */
583 #define SCOPED_WRLOCK(varname, lock) SCOPED_LOCK(varname, (lock), ast_rwlock_wrlock, ast_rwlock_unlock)
584
585 /*!
586  * \brief scoped lock specialization for ao2 mutexes.
587  */
588 #define SCOPED_AO2LOCK(varname, obj) SCOPED_LOCK(varname, (obj), ao2_lock, ao2_unlock)
589
590 /*!
591  * \brief scoped lock specialization for ao2 read locks.
592  */
593 #define SCOPED_AO2RDLOCK(varname, obj) SCOPED_LOCK(varname, (obj), ao2_rdlock, ao2_unlock)
594
595 /*!
596  * \brief scoped lock specialization for ao2 write locks.
597  */
598 #define SCOPED_AO2WRLOCK(varname, obj) SCOPED_LOCK(varname, (obj), ao2_wrlock, ao2_unlock)
599
600 /*!
601  * \brief scoped lock specialization for channels.
602  */
603 #define SCOPED_CHANNELLOCK(varname, chan) SCOPED_LOCK(varname, (chan), ast_channel_lock, ast_channel_unlock)
604
605 #ifndef __CYGWIN__      /* temporary disabled for cygwin */
606 #define pthread_mutex_t         use_ast_mutex_t_instead_of_pthread_mutex_t
607 #define pthread_cond_t          use_ast_cond_t_instead_of_pthread_cond_t
608 #endif
609 #define pthread_mutex_lock      use_ast_mutex_lock_instead_of_pthread_mutex_lock
610 #define pthread_mutex_unlock    use_ast_mutex_unlock_instead_of_pthread_mutex_unlock
611 #define pthread_mutex_trylock   use_ast_mutex_trylock_instead_of_pthread_mutex_trylock
612 #define pthread_mutex_init      use_ast_mutex_init_instead_of_pthread_mutex_init
613 #define pthread_mutex_destroy   use_ast_mutex_destroy_instead_of_pthread_mutex_destroy
614 #define pthread_cond_init       use_ast_cond_init_instead_of_pthread_cond_init
615 #define pthread_cond_destroy    use_ast_cond_destroy_instead_of_pthread_cond_destroy
616 #define pthread_cond_signal     use_ast_cond_signal_instead_of_pthread_cond_signal
617 #define pthread_cond_broadcast  use_ast_cond_broadcast_instead_of_pthread_cond_broadcast
618 #define pthread_cond_wait       use_ast_cond_wait_instead_of_pthread_cond_wait
619 #define pthread_cond_timedwait  use_ast_cond_timedwait_instead_of_pthread_cond_timedwait
620
621 #define AST_MUTEX_INITIALIZER __use_AST_MUTEX_DEFINE_STATIC_rather_than_AST_MUTEX_INITIALIZER__
622
623 #define gethostbyname __gethostbyname__is__not__reentrant__use__ast_gethostbyname__instead__
624
625 #ifndef __linux__
626 #define pthread_create __use_ast_pthread_create_instead__
627 #endif
628
629 /*
630  * Support for atomic instructions.
631  * For platforms that have it, use the native cpu instruction to
632  * implement them. For other platforms, resort to a 'slow' version
633  * (defined in utils.c) that protects the atomic instruction with
634  * a single lock.
635  * The slow versions is always available, for testing purposes,
636  * as ast_atomic_fetchadd_int_slow()
637  */
638
639 int ast_atomic_fetchadd_int_slow(volatile int *p, int v);
640
641 #include "asterisk/inline_api.h"
642
643 #if defined(HAVE_OSX_ATOMICS)
644 #include "libkern/OSAtomic.h"
645 #endif
646
647 /*! \brief Atomically add v to *p and return * the previous value of *p.
648  * This can be used to handle reference counts, and the return value
649  * can be used to generate unique identifiers.
650  */
651
652 #if defined(HAVE_GCC_ATOMICS)
653 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
654 {
655         return __sync_fetch_and_add(p, v);
656 })
657 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 4)
658 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
659 {
660         return OSAtomicAdd32(v, (int32_t *) p) - v;
661 })
662 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 8)
663 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
664 {
665         return OSAtomicAdd64(v, (int64_t *) p) - v;
666 })
667 #elif defined (__i386__) || defined(__x86_64__)
668 #ifdef sun
669 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
670 {
671         __asm __volatile (
672         "       lock;  xaddl   %0, %1 ;        "
673         : "+r" (v),                     /* 0 (result) */
674           "=m" (*p)                     /* 1 */
675         : "m" (*p));                    /* 2 */
676         return (v);
677 })
678 #else /* ifndef sun */
679 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
680 {
681         __asm __volatile (
682         "       lock   xaddl   %0, %1 ;        "
683         : "+r" (v),                     /* 0 (result) */
684           "=m" (*p)                     /* 1 */
685         : "m" (*p));                    /* 2 */
686         return (v);
687 })
688 #endif
689 #else   /* low performance version in utils.c */
690 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
691 {
692         return ast_atomic_fetchadd_int_slow(p, v);
693 })
694 #endif
695
696 /*! \brief decrement *p by 1 and return true if the variable has reached 0.
697  * Useful e.g. to check if a refcount has reached 0.
698  */
699 #if defined(HAVE_GCC_ATOMICS)
700 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
701 {
702         return __sync_sub_and_fetch(p, 1) == 0;
703 })
704 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 4)
705 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
706 {
707         return OSAtomicAdd32( -1, (int32_t *) p) == 0;
708 })
709 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 8)
710 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
711 {
712         return OSAtomicAdd64( -1, (int64_t *) p) == 0;
713 })
714 #else
715 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
716 {
717         int a = ast_atomic_fetchadd_int(p, -1);
718         return a == 1; /* true if the value is 0 now (so it was 1 previously) */
719 })
720 #endif
721
722 #endif /* _ASTERISK_LOCK_H */