Fixed up \example marker in lock.h Doxygen comment.
[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/logger.h"
63 #include "asterisk/compiler.h"
64
65 #define AST_PTHREADT_NULL (pthread_t) -1
66 #define AST_PTHREADT_STOP (pthread_t) -2
67
68 #if (defined(SOLARIS) || defined(BSD))
69 #define AST_MUTEX_INIT_W_CONSTRUCTORS
70 #endif /* SOLARIS || BSD */
71
72 /* Asterisk REQUIRES recursive (not error checking) mutexes
73    and will not run without them. */
74 #if defined(HAVE_PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP) && defined(HAVE_PTHREAD_MUTEX_RECURSIVE_NP)
75 #define PTHREAD_MUTEX_INIT_VALUE        PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
76 #define AST_MUTEX_KIND                  PTHREAD_MUTEX_RECURSIVE_NP
77 #else
78 #define PTHREAD_MUTEX_INIT_VALUE        PTHREAD_MUTEX_INITIALIZER
79 #define AST_MUTEX_KIND                  PTHREAD_MUTEX_RECURSIVE
80 #endif /* PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP */
81
82 #ifdef HAVE_PTHREAD_RWLOCK_INITIALIZER
83 #define __AST_RWLOCK_INIT_VALUE         PTHREAD_RWLOCK_INITIALIZER
84 #else  /* HAVE_PTHREAD_RWLOCK_INITIALIZER */
85 #define __AST_RWLOCK_INIT_VALUE         {0}
86 #endif /* HAVE_PTHREAD_RWLOCK_INITIALIZER */
87
88 #ifdef HAVE_BKTR
89 #define AST_LOCK_TRACK_INIT_VALUE { { NULL }, { 0 }, 0, { NULL }, { 0 }, {{{ 0 }}}, PTHREAD_MUTEX_INIT_VALUE }
90 #else
91 #define AST_LOCK_TRACK_INIT_VALUE { { NULL }, { 0 }, 0, { NULL }, { 0 }, PTHREAD_MUTEX_INIT_VALUE }
92 #endif
93
94 #define AST_MUTEX_INIT_VALUE { PTHREAD_MUTEX_INIT_VALUE, NULL, 1 }
95 #define AST_MUTEX_INIT_VALUE_NOTRACKING { PTHREAD_MUTEX_INIT_VALUE, NULL, 0 }
96
97 #define AST_RWLOCK_INIT_VALUE { __AST_RWLOCK_INIT_VALUE, NULL, 1 }
98 #define AST_RWLOCK_INIT_VALUE_NOTRACKING { __AST_RWLOCK_INIT_VALUE, NULL, 0 }
99
100 #define AST_MAX_REENTRANCY 10
101
102 struct ast_channel;
103
104 struct ast_lock_track {
105         const char *file[AST_MAX_REENTRANCY];
106         int lineno[AST_MAX_REENTRANCY];
107         int reentrancy;
108         const char *func[AST_MAX_REENTRANCY];
109         pthread_t thread[AST_MAX_REENTRANCY];
110 #ifdef HAVE_BKTR
111         struct ast_bt backtrace[AST_MAX_REENTRANCY];
112 #endif
113         pthread_mutex_t reentr_mutex;
114 };
115
116 /*! \brief Structure for mutex and tracking information.
117  *
118  * We have tracking information in this structure regardless of DEBUG_THREADS being enabled.
119  * The information will just be ignored in the core if a module does not request it..
120  */
121 struct ast_mutex_info {
122         pthread_mutex_t mutex;
123         /*! Track which thread holds this mutex */
124         struct ast_lock_track *track;
125         unsigned int tracking:1;
126 };
127
128 /*! \brief Structure for rwlock and tracking information.
129  *
130  * We have tracking information in this structure regardless of DEBUG_THREADS being enabled.
131  * The information will just be ignored in the core if a module does not request it..
132  */
133 struct ast_rwlock_info {
134         pthread_rwlock_t lock;
135         /*! Track which thread holds this lock */
136         struct ast_lock_track *track;
137         unsigned int tracking:1;
138 };
139
140 typedef struct ast_mutex_info ast_mutex_t;
141
142 typedef struct ast_rwlock_info ast_rwlock_t;
143
144 typedef pthread_cond_t ast_cond_t;
145
146 int __ast_pthread_mutex_init(int tracking, const char *filename, int lineno, const char *func, const char *mutex_name, ast_mutex_t *t);
147 int __ast_pthread_mutex_destroy(const char *filename, int lineno, const char *func, const char *mutex_name, ast_mutex_t *t);
148 int __ast_pthread_mutex_lock(const char *filename, int lineno, const char *func, const char* mutex_name, ast_mutex_t *t);
149 int __ast_pthread_mutex_trylock(const char *filename, int lineno, const char *func, const char* mutex_name, ast_mutex_t *t);
150 int __ast_pthread_mutex_unlock(const char *filename, int lineno, const char *func, const char *mutex_name, ast_mutex_t *t);
151
152 #define ast_mutex_init(pmutex)            __ast_pthread_mutex_init(1, __FILE__, __LINE__, __PRETTY_FUNCTION__, #pmutex, pmutex)
153 #define ast_mutex_init_notracking(pmutex) __ast_pthread_mutex_init(0, __FILE__, __LINE__, __PRETTY_FUNCTION__, #pmutex, pmutex)
154 #define ast_mutex_destroy(a)              __ast_pthread_mutex_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
155 #define ast_mutex_lock(a)                 __ast_pthread_mutex_lock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
156 #define ast_mutex_unlock(a)               __ast_pthread_mutex_unlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
157 #define ast_mutex_trylock(a)              __ast_pthread_mutex_trylock(__FILE__, __LINE__, __PRETTY_FUNCTION__, #a, a)
158
159
160 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);
161 int __ast_cond_signal(const char *filename, int lineno, const char *func, const char *cond_name, ast_cond_t *cond);
162 int __ast_cond_broadcast(const char *filename, int lineno, const char *func, const char *cond_name, ast_cond_t *cond);
163 int __ast_cond_destroy(const char *filename, int lineno, const char *func, const char *cond_name, ast_cond_t *cond);
164 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);
165 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);
166
167 #define ast_cond_init(cond, attr)             __ast_cond_init(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond, attr)
168 #define ast_cond_destroy(cond)                __ast_cond_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
169 #define ast_cond_signal(cond)                 __ast_cond_signal(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
170 #define ast_cond_broadcast(cond)              __ast_cond_broadcast(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, cond)
171 #define ast_cond_wait(cond, mutex)            __ast_cond_wait(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #mutex, cond, mutex)
172 #define ast_cond_timedwait(cond, mutex, time) __ast_cond_timedwait(__FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #mutex, cond, mutex, time)
173
174
175 int __ast_rwlock_init(int tracking, const char *filename, int lineno, const char *func, const char *rwlock_name, ast_rwlock_t *t);
176 int __ast_rwlock_destroy(const char *filename, int lineno, const char *func, const char *rwlock_name, ast_rwlock_t *t);
177 int __ast_rwlock_unlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name);
178 int __ast_rwlock_rdlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name);
179 int __ast_rwlock_wrlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name);
180 int __ast_rwlock_timedrdlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name, const struct timespec *abs_timeout);
181 int __ast_rwlock_timedwrlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name, const struct timespec *abs_timeout);
182 int __ast_rwlock_tryrdlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name);
183 int __ast_rwlock_trywrlock(const char *filename, int lineno, const char *func, ast_rwlock_t *t, const char *name);
184
185 /*!
186  * \brief wrapper for rwlock with tracking enabled
187  * \return 0 on success, non zero for error
188  * \since 1.6.1
189  */
190 #define ast_rwlock_init(rwlock)            __ast_rwlock_init(1, __FILE__, __LINE__, __PRETTY_FUNCTION__, #rwlock, rwlock)
191
192 /*!
193  * \brief wrapper for ast_rwlock_init with tracking disabled
194  * \return 0 on success, non zero for error
195  * \since 1.6.1
196  */
197 #define ast_rwlock_init_notracking(rwlock) __ast_rwlock_init(0, __FILE__, __LINE__, __PRETTY_FUNCTION__, #rwlock, rwlock)
198
199 #define ast_rwlock_destroy(rwlock)         __ast_rwlock_destroy(__FILE__, __LINE__, __PRETTY_FUNCTION__, #rwlock, rwlock)
200 #define ast_rwlock_unlock(a)               __ast_rwlock_unlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a)
201 #define ast_rwlock_rdlock(a)               __ast_rwlock_rdlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a)
202 #define ast_rwlock_wrlock(a)               __ast_rwlock_wrlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a)
203 #define ast_rwlock_tryrdlock(a)            __ast_rwlock_tryrdlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a)
204 #define ast_rwlock_trywrlock(a)            __ast_rwlock_trywrlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a)
205 #define ast_rwlock_timedrdlock(a, b)       __ast_rwlock_timedrdlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a, b)
206 #define ast_rwlock_timedwrlock(a, b)       __ast_rwlock_timedwrlock(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, #a, b)
207
208 #define ROFFSET ((lt->reentrancy > 0) ? (lt->reentrancy-1) : 0)
209
210 #ifdef DEBUG_THREADS
211
212 #define __ast_mutex_logger(...)  do { if (canlog) ast_log(LOG_ERROR, __VA_ARGS__); else fprintf(stderr, __VA_ARGS__); } while (0)
213
214 #ifdef THREAD_CRASH
215 #define DO_THREAD_CRASH do { *((int *)(0)) = 1; } while(0)
216 #else
217 #define DO_THREAD_CRASH do { } while (0)
218 #endif
219
220 #include <errno.h>
221
222 enum ast_lock_type {
223         AST_MUTEX,
224         AST_RDLOCK,
225         AST_WRLOCK,
226 };
227
228 /*!
229  * \brief Store lock info for the current thread
230  *
231  * This function gets called in ast_mutex_lock() and ast_mutex_trylock() so
232  * that information about this lock can be stored in this thread's
233  * lock info struct.  The lock is marked as pending as the thread is waiting
234  * on the lock.  ast_mark_lock_acquired() will mark it as held by this thread.
235  */
236 #if !defined(LOW_MEMORY)
237 #ifdef HAVE_BKTR
238 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
239         int line_num, const char *func, const char *lock_name, void *lock_addr, struct ast_bt *bt);
240 #else
241 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
242         int line_num, const char *func, const char *lock_name, void *lock_addr);
243 #endif /* HAVE_BKTR */
244
245 #else
246
247 #ifdef HAVE_BKTR
248 #define ast_store_lock_info(I,DONT,CARE,ABOUT,THE,PARAMETERS,BUD)
249 #else
250 #define ast_store_lock_info(I,DONT,CARE,ABOUT,THE,PARAMETERS)
251 #endif /* HAVE_BKTR */
252 #endif /* !defined(LOW_MEMORY) */
253
254 /*!
255  * \brief Mark the last lock as acquired
256  */
257 #if !defined(LOW_MEMORY)
258 void ast_mark_lock_acquired(void *lock_addr);
259 #else
260 #define ast_mark_lock_acquired(ignore)
261 #endif
262
263 /*!
264  * \brief Mark the last lock as failed (trylock)
265  */
266 #if !defined(LOW_MEMORY)
267 void ast_mark_lock_failed(void *lock_addr);
268 #else
269 #define ast_mark_lock_failed(ignore)
270 #endif
271
272 /*!
273  * \brief remove lock info for the current thread
274  *
275  * this gets called by ast_mutex_unlock so that information on the lock can
276  * be removed from the current thread's lock info struct.
277  */
278 #if !defined(LOW_MEMORY)
279 #ifdef HAVE_BKTR
280 void ast_remove_lock_info(void *lock_addr, struct ast_bt *bt);
281 #else
282 void ast_remove_lock_info(void *lock_addr);
283 #endif /* HAVE_BKTR */
284 #else
285 #ifdef HAVE_BKTR
286 #define ast_remove_lock_info(ignore,me)
287 #else
288 #define ast_remove_lock_info(ignore)
289 #endif /* HAVE_BKTR */
290 #endif /* !defined(LOW_MEMORY) */
291
292 #ifdef HAVE_BKTR
293 static inline void __dump_backtrace(struct ast_bt *bt, int canlog)
294 {
295         char **strings;
296
297         ssize_t i;
298
299         strings = backtrace_symbols(bt->addresses, bt->num_frames);
300
301         for (i = 0; i < bt->num_frames; i++)
302                 __ast_mutex_logger("%s\n", strings[i]);
303
304         free(strings);
305 }
306 #endif
307
308 /*!
309  * \brief log info for the current lock with ast_log().
310  *
311  * this function would be mostly for debug. If you come across a lock
312  * that is unexpectedly but momentarily locked, and you wonder who
313  * are fighting with for the lock, this routine could be called, IF
314  * you have the thread debugging stuff turned on.
315  * \param this_lock_addr lock address to return lock information
316  * \since 1.6.1
317  */
318 void log_show_lock(void *this_lock_addr);
319
320 /*!
321  * \brief retrieve lock info for the specified mutex
322  *
323  * this gets called during deadlock avoidance, so that the information may
324  * be preserved as to what location originally acquired the lock.
325  */
326 #if !defined(LOW_MEMORY)
327 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);
328 #else
329 #define ast_find_lock_info(a,b,c,d,e,f,g,h) -1
330 #endif
331
332 /*!
333  * \brief Unlock a lock briefly
334  *
335  * used during deadlock avoidance, to preserve the original location where
336  * a lock was originally acquired.
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 static inline void ast_reentrancy_init(struct ast_lock_track **plt)
452 {
453         int i;
454         pthread_mutexattr_t reentr_attr;
455         struct ast_lock_track *lt = *plt;
456
457         if (!lt) {
458                 lt = *plt = (struct ast_lock_track *) calloc(1, sizeof(*lt));
459         }
460
461         for (i = 0; i < AST_MAX_REENTRANCY; i++) {
462                 lt->file[i] = NULL;
463                 lt->lineno[i] = 0;
464                 lt->func[i] = NULL;
465                 lt->thread[i] = 0;
466 #ifdef HAVE_BKTR
467                 memset(&lt->backtrace[i], 0, sizeof(lt->backtrace[i]));
468 #endif
469         }
470
471         lt->reentrancy = 0;
472
473         pthread_mutexattr_init(&reentr_attr);
474         pthread_mutexattr_settype(&reentr_attr, AST_MUTEX_KIND);
475         pthread_mutex_init(&lt->reentr_mutex, &reentr_attr);
476         pthread_mutexattr_destroy(&reentr_attr);
477 }
478
479 static inline void delete_reentrancy_cs(struct ast_lock_track **plt)
480 {
481         struct ast_lock_track *lt;
482         if (*plt) {
483                 lt = *plt;
484                 pthread_mutex_destroy(&lt->reentr_mutex);
485                 free(lt);
486                 *plt = NULL;
487         }
488 }
489
490 #else /* !DEBUG_THREADS */
491
492 #define CHANNEL_DEADLOCK_AVOIDANCE(chan) \
493         ast_channel_unlock(chan); \
494         usleep(1); \
495         ast_channel_lock(chan);
496
497 #define DEADLOCK_AVOIDANCE(lock) \
498         do { \
499                 int __res; \
500                 if (!(__res = ast_mutex_unlock(lock))) { \
501                         usleep(1); \
502                         ast_mutex_lock(lock); \
503                 } else { \
504                         ast_log(LOG_WARNING, "Failed to unlock mutex '%s' (%s).  I will NOT try to relock. {{{ THIS IS A BUG. }}}\n", #lock, strerror(__res)); \
505                 } \
506         } while (0)
507
508 #define DLA_UNLOCK(lock) ast_mutex_unlock(lock)
509
510 #define DLA_LOCK(lock) ast_mutex_lock(lock)
511
512 #endif /* !DEBUG_THREADS */
513
514 #if defined(AST_MUTEX_INIT_W_CONSTRUCTORS)
515 /*
516  * If AST_MUTEX_INIT_W_CONSTRUCTORS is defined, use file scope constructors
517  * and destructors to create/destroy global mutexes.
518  */
519 #define __AST_MUTEX_DEFINE(scope, mutex, init_val, track)       \
520         scope ast_mutex_t mutex = init_val;                     \
521 static void  __attribute__((constructor)) init_##mutex(void)    \
522 {                                                               \
523         if (track)                                              \
524                 ast_mutex_init(&mutex);                         \
525         else                                                    \
526                 ast_mutex_init_notracking(&mutex);              \
527 }                                                               \
528                                                                 \
529 static void  __attribute__((destructor)) fini_##mutex(void)     \
530 {                                                               \
531         ast_mutex_destroy(&mutex);                              \
532 }
533 #else /* !AST_MUTEX_INIT_W_CONSTRUCTORS */
534 /* By default, use static initialization of mutexes. */
535 #define __AST_MUTEX_DEFINE(scope, mutex, init_val, track) scope ast_mutex_t mutex = init_val
536 #endif /* AST_MUTEX_INIT_W_CONSTRUCTORS */
537
538 #define AST_MUTEX_DEFINE_STATIC(mutex) __AST_MUTEX_DEFINE(static, mutex, AST_MUTEX_INIT_VALUE, 1)
539 #define AST_MUTEX_DEFINE_STATIC_NOTRACKING(mutex) __AST_MUTEX_DEFINE(static, mutex, AST_MUTEX_INIT_VALUE_NOTRACKING, 0)
540
541
542 /* Statically declared read/write locks */
543 #ifdef AST_MUTEX_INIT_W_CONSTRUCTORS
544 #define __AST_RWLOCK_DEFINE(scope, rwlock, init_val, track) \
545         scope ast_rwlock_t rwlock = init_val; \
546 static void  __attribute__((constructor)) init_##rwlock(void) \
547 { \
548         if (track) \
549                 ast_rwlock_init(&rwlock); \
550         else \
551                 ast_rwlock_init_notracking(&rwlock); \
552 } \
553 static void  __attribute__((destructor)) fini_##rwlock(void) \
554 { \
555         ast_rwlock_destroy(&rwlock); \
556 }
557 #else
558 #define __AST_RWLOCK_DEFINE(scope, rwlock, init_val, track) scope ast_rwlock_t rwlock = init_val
559 #endif
560
561 #define AST_RWLOCK_DEFINE_STATIC(rwlock) __AST_RWLOCK_DEFINE(static, rwlock, AST_RWLOCK_INIT_VALUE, 1)
562 #define AST_RWLOCK_DEFINE_STATIC_NOTRACKING(rwlock) __AST_RWLOCK_DEFINE(static, rwlock, AST_RWLOCK_INIT_VALUE_NOTRACKING, 0)
563
564 /*!
565  * \brief Scoped Locks
566  *
567  * Scoped locks provide a way to use RAII locks. In other words,
568  * declaration of a scoped lock will automatically define and lock
569  * the lock. When the lock goes out of scope, it will automatically
570  * be unlocked.
571  *
572  * \code
573  * int some_function(struct ast_channel *chan)
574  * {
575  *     SCOPED_LOCK(lock, chan, ast_channel_lock, ast_channel_unlock);
576  *
577  *     if (!strcmp(ast_channel_name(chan, "foo")) {
578  *         return 0;
579  *     }
580  *
581  *     return -1;
582  * }
583  * \endcode
584  *
585  * In the above example, neither return path requires explicit unlocking
586  * of the channel.
587  *
588  * \note
589  * Care should be taken when using SCOPED_LOCKS in conjunction with ao2 objects.
590  * ao2 objects should be unlocked before they are unreffed. Since SCOPED_LOCK runs
591  * once the variable goes out of scope, this can easily lead to situations where the
592  * variable gets unlocked after it is unreffed.
593  *
594  * \param varname The unique name to give to the scoped lock. You are not likely to reference
595  * this outside of the SCOPED_LOCK invocation.
596  * \param lock The variable to lock. This can be anything that can be passed to a locking
597  * or unlocking function.
598  * \param lockfunc The function to call to lock the lock
599  * \param unlockfunc The function to call to unlock the lock
600  */
601 #define SCOPED_LOCK(varname, lock, lockfunc, unlockfunc) \
602         auto void _dtor_ ## varname (typeof((lock)) * v); \
603         auto void _dtor_ ## varname (typeof((lock)) * v) { unlockfunc(*v); } \
604         typeof((lock)) varname __attribute__((cleanup(_dtor_ ## varname))) = lock; lockfunc((lock))
605
606 /*!
607  * \brief scoped lock specialization for mutexes
608  */
609 #define SCOPED_MUTEX(varname, lock) SCOPED_LOCK(varname, (lock), ast_mutex_lock, ast_mutex_unlock)
610
611 /*!
612  * \brief scoped lock specialization for read locks
613  */
614 #define SCOPED_RDLOCK(varname, lock) SCOPED_LOCK(varname, (lock), ast_rwlock_rdlock, ast_rwlock_unlock)
615
616 /*!
617  * \brief scoped lock specialization for write locks
618  */
619 #define SCOPED_WRLOCK(varname, lock) SCOPED_LOCK(varname, (lock), ast_rwlock_wrlock, ast_rwlock_unlock)
620
621 /*!
622  * \brief scoped lock specialization for ao2 mutexes.
623  */
624 #define SCOPED_AO2LOCK(varname, obj) SCOPED_LOCK(varname, (obj), ao2_lock, ao2_unlock)
625
626 /*!
627  * \brief scoped lock specialization for ao2 read locks.
628  */
629 #define SCOPED_AO2RDLOCK(varname, obj) SCOPED_LOCK(varname, (obj), ao2_rdlock, ao2_unlock)
630
631 /*!
632  * \brief scoped lock specialization for ao2 write locks.
633  */
634 #define SCOPED_AO2WRLOCK(varname, obj) SCOPED_LOCK(varname, (obj), ao2_wrlock, ao2_unlock)
635
636 /*!
637  * \brief scoped lock specialization for channels.
638  */
639 #define SCOPED_CHANNELLOCK(varname, chan) SCOPED_LOCK(varname, (chan), ast_channel_lock, ast_channel_unlock)
640
641 #ifndef __CYGWIN__      /* temporary disabled for cygwin */
642 #define pthread_mutex_t         use_ast_mutex_t_instead_of_pthread_mutex_t
643 #define pthread_cond_t          use_ast_cond_t_instead_of_pthread_cond_t
644 #endif
645 #define pthread_mutex_lock      use_ast_mutex_lock_instead_of_pthread_mutex_lock
646 #define pthread_mutex_unlock    use_ast_mutex_unlock_instead_of_pthread_mutex_unlock
647 #define pthread_mutex_trylock   use_ast_mutex_trylock_instead_of_pthread_mutex_trylock
648 #define pthread_mutex_init      use_ast_mutex_init_instead_of_pthread_mutex_init
649 #define pthread_mutex_destroy   use_ast_mutex_destroy_instead_of_pthread_mutex_destroy
650 #define pthread_cond_init       use_ast_cond_init_instead_of_pthread_cond_init
651 #define pthread_cond_destroy    use_ast_cond_destroy_instead_of_pthread_cond_destroy
652 #define pthread_cond_signal     use_ast_cond_signal_instead_of_pthread_cond_signal
653 #define pthread_cond_broadcast  use_ast_cond_broadcast_instead_of_pthread_cond_broadcast
654 #define pthread_cond_wait       use_ast_cond_wait_instead_of_pthread_cond_wait
655 #define pthread_cond_timedwait  use_ast_cond_timedwait_instead_of_pthread_cond_timedwait
656
657 #define AST_MUTEX_INITIALIZER __use_AST_MUTEX_DEFINE_STATIC_rather_than_AST_MUTEX_INITIALIZER__
658
659 #define gethostbyname __gethostbyname__is__not__reentrant__use__ast_gethostbyname__instead__
660
661 #ifndef __linux__
662 #define pthread_create __use_ast_pthread_create_instead__
663 #endif
664
665 /*
666  * Support for atomic instructions.
667  * For platforms that have it, use the native cpu instruction to
668  * implement them. For other platforms, resort to a 'slow' version
669  * (defined in utils.c) that protects the atomic instruction with
670  * a single lock.
671  * The slow versions is always available, for testing purposes,
672  * as ast_atomic_fetchadd_int_slow()
673  */
674
675 int ast_atomic_fetchadd_int_slow(volatile int *p, int v);
676
677 #include "asterisk/inline_api.h"
678
679 #if defined(HAVE_OSX_ATOMICS)
680 #include "libkern/OSAtomic.h"
681 #endif
682
683 /*! \brief Atomically add v to *p and return * the previous value of *p.
684  * This can be used to handle reference counts, and the return value
685  * can be used to generate unique identifiers.
686  */
687
688 #if defined(HAVE_GCC_ATOMICS)
689 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
690 {
691         return __sync_fetch_and_add(p, v);
692 })
693 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 4)
694 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
695 {
696         return OSAtomicAdd32(v, (int32_t *) p) - v;
697 })
698 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 8)
699 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
700 {
701         return OSAtomicAdd64(v, (int64_t *) p) - v;
702 #elif defined (__i386__) || defined(__x86_64__)
703 #ifdef sun
704 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
705 {
706         __asm __volatile (
707         "       lock;  xaddl   %0, %1 ;        "
708         : "+r" (v),                     /* 0 (result) */
709           "=m" (*p)                     /* 1 */
710         : "m" (*p));                    /* 2 */
711         return (v);
712 })
713 #else /* ifndef sun */
714 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
715 {
716         __asm __volatile (
717         "       lock   xaddl   %0, %1 ;        "
718         : "+r" (v),                     /* 0 (result) */
719           "=m" (*p)                     /* 1 */
720         : "m" (*p));                    /* 2 */
721         return (v);
722 })
723 #endif
724 #else   /* low performance version in utils.c */
725 AST_INLINE_API(int ast_atomic_fetchadd_int(volatile int *p, int v),
726 {
727         return ast_atomic_fetchadd_int_slow(p, v);
728 })
729 #endif
730
731 /*! \brief decrement *p by 1 and return true if the variable has reached 0.
732  * Useful e.g. to check if a refcount has reached 0.
733  */
734 #if defined(HAVE_GCC_ATOMICS)
735 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
736 {
737         return __sync_sub_and_fetch(p, 1) == 0;
738 })
739 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 4)
740 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
741 {
742         return OSAtomicAdd32( -1, (int32_t *) p) == 0;
743 })
744 #elif defined(HAVE_OSX_ATOMICS) && (SIZEOF_INT == 8)
745 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
746 {
747         return OSAtomicAdd64( -1, (int64_t *) p) == 0;
748 #else
749 AST_INLINE_API(int ast_atomic_dec_and_test(volatile int *p),
750 {
751         int a = ast_atomic_fetchadd_int(p, -1);
752         return a == 1; /* true if the value is 0 now (so it was 1 previously) */
753 })
754 #endif
755
756 #endif /* _ASTERISK_LOCK_H */